Files
file	object.h
	Constants and Structures Associated with the Object Handler.

file	objectdata.h
	Object Handler Data Structures.

file	objectimpl.h
	Inlined Routines in the Object Handler.

file	objectallocate.c
	Allocate Object.

file	objectallocatenone.c

file	objectallocatestatic.c

file	objectapimaximumclass.c
	Object API Maximum Class.

file	objectclose.c
	Close Object.

file	objectfree.c
	Free Object.

file	objectfreestatic.c

file	objectgetinfo.c
	Get Object Information.

file	objectgetlocal.c
	Object Get Local.

file	objectgetnoprotection.c
	Get Object without Dispatching Protection.

file	objectinitializeinformation.c
	Initialize Object Information.

Classes
union	Objects_Name

struct	Objects_Control

struct	Objects_Information
	The information structure used to manage each API class of objects. More...

Macros
#define	OBJECTS_INDEX_START_BIT 0U

#define	OBJECTS_NODE_START_BIT 16U

#define	OBJECTS_API_START_BIT 24U

#define	OBJECTS_CLASS_START_BIT 27U

#define	OBJECTS_INDEX_MASK (Objects_Id)0x0000ffffU

#define	OBJECTS_NODE_MASK (Objects_Id)0x00ff0000U

#define	OBJECTS_API_MASK (Objects_Id)0x07000000U

#define	OBJECTS_CLASS_MASK (Objects_Id)0xf8000000U

#define	OBJECTS_INDEX_VALID_BITS (Objects_Id)0x0000ffffU

#define	OBJECTS_NODE_VALID_BITS (Objects_Id)0x000000ffU

#define	OBJECTS_API_VALID_BITS (Objects_Id)0x00000007U

#define	OBJECTS_CLASS_VALID_BITS (Objects_Id)0x0000001fU

#define	OBJECTS_UNLIMITED_OBJECTS 0x80000000U

#define	OBJECTS_ID_INITIAL_INDEX (0)

#define	OBJECTS_ID_FINAL_INDEX (0xffffU)

#define	OBJECTS_APIS_LAST OBJECTS_POSIX_API

#define	OBJECTS_ID_NONE 0

#define	OBJECTS_ID_OF_SELF ((Objects_Id) 0)

#define	OBJECTS_SEARCH_ALL_NODES 0

#define	OBJECTS_SEARCH_OTHER_NODES 0x7FFFFFFE

#define	OBJECTS_SEARCH_LOCAL_NODE 0x7FFFFFFF

#define	OBJECTS_WHO_AM_I 0

#define	OBJECTS_ID_INITIAL(_api, _class, _node) _Objects_Build_id( (_api), (_class), (_node), OBJECTS_ID_INITIAL_INDEX )

#define	OBJECTS_ID_FINAL ((Objects_Id)~0)

#define	_Objects_Build_name(_C1, _C2, _C3, _C4)

#define	_Objects_Build_id(the_api, the_class, node, index)
	Builds an object ID from its components. More...

#define	_Objects_Is_unlimited(maximum) ( ( ( maximum ) & OBJECTS_UNLIMITED_OBJECTS ) != 0 )

#define	_Objects_Maximum_per_allocation(maximum) ((Objects_Maximum) ((maximum) & ~OBJECTS_UNLIMITED_OBJECTS))

#define	_Objects_Local_node ((uint16_t) 1)
	The local MPCI node number.

#define	OBJECTS_NO_STRING_NAME 0
	Constant for the object information string name length to indicate that this object class has no string names.

#define	OBJECTS_INFORMATION_MP(name, extract)

#define	OBJECTS_INFORMATION_DEFINE_ZERO(name, api, cls, nl)
	Statically initializes an objects information. More...

#define	OBJECTS_INFORMATION_DEFINE(name, api, cls, type, max, nl, ex)
	Statically initializes an objects information. More...

#define	OBJECTS_INTERNAL_CLASSES_LAST OBJECTS_INTERNAL_THREADS

#define	OBJECTS_RTEMS_CLASSES_LAST OBJECTS_RTEMS_BARRIERS

#define	OBJECTS_POSIX_CLASSES_LAST OBJECTS_POSIX_SHMS

#define	_Objects_Maximum_nodes 1

#define	OBJECTS_INDEX_MINIMUM 1U

#define	OBJECTS_NAME_ERRORS_FIRST OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL

#define	OBJECTS_NAME_ERRORS_LAST OBJECTS_INVALID_NODE

Typedefs
typedef uint32_t	Objects_Id

typedef uint16_t	Objects_Maximum

typedef struct Objects_Information	Objects_Information

typedef bool(*	Objects_Name_comparators) (void , void , uint16_t)

Enumerations
enum	Objects_APIs { OBJECTS_NO_API = 0, OBJECTS_INTERNAL_API = 1, OBJECTS_CLASSIC_API = 2, OBJECTS_POSIX_API = 3, OBJECTS_FAKE_OBJECTS_API = 7 }

enum	Objects_Internal_API { OBJECTS_INTERNAL_NO_CLASS = 0, OBJECTS_INTERNAL_THREADS = 1 }

enum	Objects_Classic_API { OBJECTS_CLASSIC_NO_CLASS = 0, OBJECTS_RTEMS_TASKS = 1, OBJECTS_RTEMS_TIMERS, OBJECTS_RTEMS_SEMAPHORES, OBJECTS_RTEMS_MESSAGE_QUEUES, OBJECTS_RTEMS_PARTITIONS, OBJECTS_RTEMS_REGIONS, OBJECTS_RTEMS_PORTS, OBJECTS_RTEMS_PERIODS, OBJECTS_RTEMS_EXTENSIONS, OBJECTS_RTEMS_BARRIERS }

enum	Objects_POSIX_API { OBJECTS_POSIX_NO_CLASS = 0, OBJECTS_POSIX_THREADS = 1, OBJECTS_POSIX_KEYS, OBJECTS_POSIX_MESSAGE_QUEUES, OBJECTS_POSIX_SEMAPHORES, OBJECTS_POSIX_TIMERS, OBJECTS_POSIX_SHMS }

enum	Objects_Fake_objects_API { OBJECTS_FAKE_OBJECTS_NO_CLASS = 0, OBJECTS_FAKE_OBJECTS_SCHEDULERS = 1 }

enum	Objects_Name_or_id_lookup_errors { OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL, OBJECTS_INVALID_NAME, OBJECTS_INVALID_ADDRESS, OBJECTS_INVALID_ID, OBJECTS_INVALID_NODE }

enum	Objects_Get_by_name_error { OBJECTS_GET_BY_NAME_INVALID_NAME, OBJECTS_GET_BY_NAME_NAME_TOO_LONG, OBJECTS_GET_BY_NAME_NO_OBJECT }

Functions
static __inline__ Objects_APIs	_Objects_Get_API (Objects_Id id)
	Returns the API portion of the ID. More...

static __inline__ uint32_t	_Objects_Get_class (Objects_Id id)
	Returns the class portion of the ID. More...

static __inline__ uint32_t	_Objects_Get_node (Objects_Id id)
	Returns the node portion of the ID. More...

static __inline__ Objects_Maximum	_Objects_Get_index (Objects_Id id)
	Returns the index portion of the ID. More...

Objects_Control *	_Objects_Allocate_none (Objects_Information *information)
	Always return NULL. More...

Objects_Control *	_Objects_Allocate_static (Objects_Information *information)
	Return an inactive object or NULL. More...

Objects_Control *	_Objects_Allocate_unlimited (Objects_Information *information)
	Return an inactive object or NULL. More...

void	_Objects_Free_static (Objects_Information information, Objects_Control the_object)
	Free the object. More...

void	_Objects_Free_unlimited (Objects_Information information, Objects_Control the_object)
	Free the object. More...

Objects_Maximum	_Objects_Extend_information (Objects_Information *information)
	Extends an object class information record. More...

void	_Objects_Free_objects_block (Objects_Information *information, Objects_Maximum block)
	Free the objects block with the specified index. More...

void	_Objects_Shrink_information (Objects_Information *information)
	Shrinks an object class information record. More...

void	_Objects_Initialize_information (Objects_Information *information)
	Initializes the specified objects information. More...

unsigned int	_Objects_API_maximum_class (uint32_t api)
	Returns highest numeric value of a valid API for the specified API. More...

Objects_Control *	_Objects_Allocate (Objects_Information *information)
	Allocates an object. More...

Objects_Name_or_id_lookup_errors	_Objects_Name_to_id_u32 (uint32_t name, uint32_t node, Objects_Id id, const Objects_Information information)
	Searches an object of the specified class with the specified name on the specified set of nodes. More...

Objects_Control *	_Objects_Get_by_name (const Objects_Information information, const char name, size_t name_length_p, Objects_Get_by_name_error error)
	Gets an object control block identified by its name. More...

Objects_Name_or_id_lookup_errors	_Objects_Id_to_name (Objects_Id id, Objects_Name *name)
	Returns the name associated with object id. More...

Objects_Control *	_Objects_Get (Objects_Id id, ISR_lock_Context lock_context, const Objects_Information information)
	Maps the specified object identifier to the associated local object control block. More...

Objects_Control *	_Objects_Get_no_protection (Objects_Id id, const Objects_Information *information)
	Maps object ids to object control blocks. More...

Objects_Control *	_Objects_Get_next (Objects_Id id, const Objects_Information information, Objects_Id next_id_p)
	Gets the next open object after the specified object identifier. More...

Objects_Information *	_Objects_Get_information (Objects_APIs the_api, uint16_t the_class)
	Gets object information. More...

Objects_Information *	_Objects_Get_information_id (Objects_Id id)
	Gets information of an object from an ID. More...

static __inline__ bool	_Objects_Has_string_name (const Objects_Information *information)
	Returns if the object has a string name. More...

char *	_Objects_Get_name_as_string (Objects_Id id, size_t length, char *name)
	Gets object name in the form of a C string. More...

size_t	_Objects_Name_to_string (Objects_Name name, bool is_string, char *buffer, size_t buffer_size)
	Converts the specified object name to a text representation. More...

bool	_Objects_Set_name (const Objects_Information information, Objects_Control the_object, const char *name)
	Sets objects name. More...

static __inline__ void	_Objects_Namespace_remove_u32 (const Objects_Information information, Objects_Control the_object)
	Removes object with a 32-bit integer name from its namespace. More...

void	_Objects_Namespace_remove_string (const Objects_Information information, Objects_Control the_object)
	Removes object with a string name from its namespace. More...

void	_Objects_Close (const Objects_Information information, Objects_Control the_object)
	Closes object. More...

Objects_Maximum	_Objects_Active_count (const Objects_Information *information)
	Returns the count of active objects. More...

static __inline__ Objects_Maximum	_Objects_Extend_size (const Objects_Information *information)
	Returns the object's objects per block. More...

static __inline__ bool	_Objects_Is_api_valid (uint32_t the_api)
	Checks if the api is valid. More...

static __inline__ bool	_Objects_Is_local_node (uint32_t node)
	Checks if the node is of the local object. More...

static __inline__ bool	_Objects_Is_local_id (Objects_Id id RTEMS_UNUSED)
	Checks if the id is of a local object. More...

static __inline__ bool	_Objects_Are_ids_equal (Objects_Id left, Objects_Id right)
	Checks if two object IDs are equal. More...

static __inline__ Objects_Id	_Objects_Get_minimum_id (Objects_Id id)
	Returns the identifier with the minimum index for the specified identifier. More...

static __inline__ Objects_Maximum	_Objects_Get_maximum_index (const Objects_Information *information)
	Returns the maximum index of the specified object class. More...

static __inline__ Objects_Control *	_Objects_Get_inactive (Objects_Information *information)
	Get an inactive object or NULL. More...

static __inline__ Objects_Maximum	_Objects_Is_auto_extend (const Objects_Information *information)
	Checks if the automatic object extension (unlimited objects) is enabled. More...

static __inline__ void	_Objects_Set_local_object (const Objects_Information information, uint32_t index, Objects_Control the_object)
	Sets the pointer to the local_table object referenced by the index. More...

static __inline__ void	_Objects_Invalidate_Id (const Objects_Information information, Objects_Control the_object)
	Invalidates an object Id. More...

static __inline__ void	_Objects_Open (Objects_Information information, Objects_Control the_object, Objects_Name name)
	Places the_object control pointer and object name in the Local Pointer and Local Name Tables, respectively. More...

static __inline__ void	_Objects_Open_u32 (const Objects_Information information, Objects_Control the_object, uint32_t name)
	Places the_object control pointer and object name in the Local Pointer and Local Name Tables, respectively. More...

static __inline__ void	_Objects_Open_string (const Objects_Information information, Objects_Control the_object, const char *name)
	Places the_object control pointer and object name in the Local Pointer and Local Name Tables, respectively. More...

static __inline__ void	_Objects_Allocator_lock (void)
	Locks the object allocator mutex. More...

static __inline__ void	_Objects_Allocator_unlock (void)
	Unlocks the object allocator mutex. More...

static __inline__ bool	_Objects_Allocator_is_owner (void)
	Checks if the allocator is the owner of the object allocator mutex. More...

static __inline__ Objects_Control *	_Objects_Allocate_unprotected (Objects_Information *information)
	Allocates an object without locking the allocator mutex. More...

static __inline__ void	_Objects_Free (Objects_Information information, Objects_Control the_object)
	Frees an object. More...

static __inline__ void	_Objects_Activate_unlimited (Objects_Information information, Objects_Control the_object)
	Activate the object. More...

static __inline__ Objects_Control *	_Objects_Allocate_with_extend (Objects_Information information, void(extend)(Objects_Information *))
	Allocate an object and extend the objects information on demand. More...

Variables
Objects_Information **const	_Objects_Information_table [OBJECTS_APIS_LAST+1]

Detailed Description

Macro Definition Documentation

◆ _Objects_Build_id

#define _Objects_Build_id	(	the_api,
		the_class,
		node,
		index
	)

Value:

( (Objects_Id) ( (Objects_Id) the_api   << OBJECTS_API_START_BIT )   | \
                 ( (Objects_Id) the_class << OBJECTS_CLASS_START_BIT ) | \
                 ( (Objects_Id) node      << OBJECTS_NODE_START_BIT )  | \
                 ( (Objects_Id) index     << OBJECTS_INDEX_START_BIT ) )

Builds an object ID from its components.

Parameters

the_api	The object API.
the_class	The object API class.
node	The object node.
index	The object index.

Returns: Returns the object ID constructed from the arguments.

Definition at line 317 of file object.h.

◆ _Objects_Build_name

#define _Objects_Build_name	(	_C1,
		_C2,
		_C3,
		_C4
	)

Value:

( (uint32_t)(_C1) << 24 | \
    (uint32_t)(_C2) << 16 | \
    (uint32_t)(_C3) << 8 | \
    (uint32_t)(_C4) )

This macro is used to build a thirty-two bit style name from four characters. The most significant byte will be the character _C1.

Parameters

[in]	_C1	is the first character of the name
[in]	_C2	is the second character of the name
[in]	_C3	is the third character of the name
[in]	_C4	is the fourth character of the name

Definition at line 242 of file object.h.

◆ _Objects_Is_unlimited

#define _Objects_Is_unlimited ( maximum ) ( ( ( maximum ) & OBJECTS_UNLIMITED_OBJECTS ) != 0 )

Returns if the object maximum specifies unlimited objects.

Parameters

[in] maximum The object maximum specification.

Return values

true	Unlimited objects are available.
false	The object count is fixed.

Definition at line 331 of file object.h.

◆ _Objects_Maximum_nodes

#define _Objects_Maximum_nodes 1

The following is referenced to the number of nodes in the system.

Definition at line 74 of file objectimpl.h.

◆ OBJECTS_API_MASK

#define OBJECTS_API_MASK (Objects_Id)0x07000000U

This mask is used to extract the API portion of an object Id.

Definition at line 124 of file object.h.

◆ OBJECTS_API_START_BIT

#define OBJECTS_API_START_BIT 24U

This is the bit position of the starting bit of the API portion of the object Id.

Definition at line 103 of file object.h.

◆ OBJECTS_API_VALID_BITS

#define OBJECTS_API_VALID_BITS (Objects_Id)0x00000007U

This mask represents the bits that is used to ensure no extra bits are set after shifting to extract the API portion of an object Id.

Definition at line 147 of file object.h.

◆ OBJECTS_APIS_LAST

#define OBJECTS_APIS_LAST OBJECTS_POSIX_API

This macro is used to generically specify the last API index.

Definition at line 183 of file object.h.

◆ OBJECTS_CLASS_MASK

#define OBJECTS_CLASS_MASK (Objects_Id)0xf8000000U

This mask is used to extract the class portion of an object Id.

Definition at line 129 of file object.h.

◆ OBJECTS_CLASS_START_BIT

#define OBJECTS_CLASS_START_BIT 27U

This is the bit position of the starting bit of the class portion of the object Id.

Definition at line 109 of file object.h.

◆ OBJECTS_CLASS_VALID_BITS

#define OBJECTS_CLASS_VALID_BITS (Objects_Id)0x0000001fU

This mask represents the bits that is used to ensure no extra bits are set after shifting to extract the class portion of an object Id.

Definition at line 153 of file object.h.

◆ OBJECTS_ID_FINAL

#define OBJECTS_ID_FINAL ((Objects_Id)~0)

This macro specifies the highest object ID value

Definition at line 230 of file object.h.

◆ OBJECTS_ID_FINAL_INDEX

#define OBJECTS_ID_FINAL_INDEX (0xffffU)

This is the highest value for the index portion of an object Id.

Definition at line 169 of file object.h.

◆ OBJECTS_ID_INITIAL

#define OBJECTS_ID_INITIAL	(	_api,
		_class,
		_node
	)	_Objects_Build_id( (_api), (_class), (_node), OBJECTS_ID_INITIAL_INDEX )

This macros calculates the lowest ID for the specified api, class, and node.

Definition at line 224 of file object.h.

◆ OBJECTS_ID_INITIAL_INDEX

#define OBJECTS_ID_INITIAL_INDEX (0)

This is the lowest value for the index portion of an object Id.

Definition at line 164 of file object.h.

◆ OBJECTS_ID_NONE

#define OBJECTS_ID_NONE 0

No object can have this ID.

Definition at line 188 of file object.h.

◆ OBJECTS_ID_OF_SELF

#define OBJECTS_ID_OF_SELF ((Objects_Id) 0)

The following defines the constant which may be used to manipulate the calling task.

Definition at line 194 of file object.h.

◆ OBJECTS_INDEX_MASK

#define OBJECTS_INDEX_MASK (Objects_Id)0x0000ffffU

This mask is used to extract the index portion of an object Id.

Definition at line 114 of file object.h.

◆ OBJECTS_INDEX_MINIMUM

#define OBJECTS_INDEX_MINIMUM 1U

This is the minimum object ID index associated with an object.

Definition at line 80 of file objectimpl.h.

◆ OBJECTS_INDEX_START_BIT

#define OBJECTS_INDEX_START_BIT 0U

This is the bit position of the starting bit of the index portion of the object Id.

Definition at line 92 of file object.h.

◆ OBJECTS_INDEX_VALID_BITS

#define OBJECTS_INDEX_VALID_BITS (Objects_Id)0x0000ffffU

This mask represents the bits that is used to ensure no extra bits are set after shifting to extract the index portion of an object Id.

Definition at line 135 of file object.h.

◆ OBJECTS_INFORMATION_DEFINE

#define OBJECTS_INFORMATION_DEFINE	(	name,
		api,
		cls,
		type,
		max,
		nl,
		ex
	)

Value:

static Objects_Control * \
name##_Local_table[ _Objects_Maximum_per_allocation( max ) ]; \
static type name##_Objects[ _Objects_Maximum_per_allocation( max ) ]; \
Objects_Information name##_Information = { \
  _Objects_Build_id( api, cls, 1, _Objects_Maximum_per_allocation( max ) ), \
  name##_Local_table, \
  _Objects_Is_unlimited( max ) ? \
    _Objects_Allocate_unlimited : _Objects_Allocate_static, \
  _Objects_Is_unlimited( max ) ? \
    _Objects_Free_unlimited : _Objects_Free_static, \
  0, \
  _Objects_Is_unlimited( max ) ? _Objects_Maximum_per_allocation( max ) : 0, \
  sizeof( type ), \
  nl, \
  CHAIN_INITIALIZER_EMPTY( name##_Information.Inactive ), \
  NULL, \
  NULL, \
  &name##_Objects[ 0 ].Object \
  OBJECTS_INFORMATION_MP( name##_Information, ex ) \
}

Statically initializes an objects information.

The initialized objects information references a table with statically allocated objects as specified by the object maximum parameter. These objects must be registered via a call to _Objects_Information().

Parameters

name	The object class C designator namespace prefix, e.g. _Semaphore.
api	The object API number, e.g. OBJECTS_CLASSIC_API.
cls	The object class number, e.g. OBJECTS_RTEMS_SEMAPHORES.
type	The object class type.
max	The configured object maximum (the OBJECTS_UNLIMITED_OBJECTS flag may be set).
nl	The object name string length, use OBJECTS_NO_STRING_NAME for objects without a string name.
ex	The optional object extraction method. Used only if multiprocessing (RTEMS_MULTIPROCESSING) is enabled.

Definition at line 427 of file objectdata.h.

◆ OBJECTS_INFORMATION_DEFINE_ZERO

#define OBJECTS_INFORMATION_DEFINE_ZERO	(	name,
		api,
		cls,
		nl
	)

Value:

Objects_Information name##_Information = { \
  _Objects_Build_id( api, cls, 1, 0 ), \
  NULL, \
  _Objects_Allocate_none, \
  NULL, \
  0, \
  0, \
  0, \
  nl, \
  CHAIN_INITIALIZER_EMPTY( name##_Information.Inactive ), \
  NULL, \
  NULL, \
  NULL \
  OBJECTS_INFORMATION_MP( name##_Information, NULL ) \
}

Statically initializes an objects information.

The initialized objects information contains no objects.

Parameters

name	The object class C designator namespace prefix, e.g. _Semaphore.
api	The object API number, e.g. OBJECTS_CLASSIC_API.
cls	The object class number, e.g. OBJECTS_RTEMS_SEMAPHORES.
nl	The object name string length, use OBJECTS_NO_STRING_NAME for objects without a string name.

Definition at line 392 of file objectdata.h.

◆ OBJECTS_INTERNAL_CLASSES_LAST

#define OBJECTS_INTERNAL_CLASSES_LAST OBJECTS_INTERNAL_THREADS

This macro is used to generically specify the last API index.

Definition at line 51 of file objectimpl.h.

◆ OBJECTS_NAME_ERRORS_FIRST

#define OBJECTS_NAME_ERRORS_FIRST OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL

This macro defines the first entry in the Objects_Name_or_id_lookup_errors enumerated list.

Definition at line 215 of file objectimpl.h.

◆ OBJECTS_NAME_ERRORS_LAST

#define OBJECTS_NAME_ERRORS_LAST OBJECTS_INVALID_NODE

This macro defines the last entry in the Objects_Name_or_id_lookup_errors enumerated list.

Definition at line 221 of file objectimpl.h.

◆ OBJECTS_NODE_MASK

#define OBJECTS_NODE_MASK (Objects_Id)0x00ff0000U

This mask is used to extract the node portion of an object Id.

Definition at line 119 of file object.h.

◆ OBJECTS_NODE_START_BIT

#define OBJECTS_NODE_START_BIT 16U

This is the bit position of the starting bit of the node portion of the object Id.

Definition at line 97 of file object.h.

◆ OBJECTS_NODE_VALID_BITS

#define OBJECTS_NODE_VALID_BITS (Objects_Id)0x000000ffU

This mask represents the bits that is used to ensure no extra bits are set after shifting to extract the node portion of an object Id.

Definition at line 141 of file object.h.

◆ OBJECTS_POSIX_CLASSES_LAST

#define OBJECTS_POSIX_CLASSES_LAST OBJECTS_POSIX_SHMS

This macro is used to generically specify the last API index.

Definition at line 57 of file objectimpl.h.

◆ OBJECTS_RTEMS_CLASSES_LAST

#define OBJECTS_RTEMS_CLASSES_LAST OBJECTS_RTEMS_BARRIERS

This macro is used to generically specify the last API index.

Definition at line 54 of file objectimpl.h.

◆ OBJECTS_SEARCH_ALL_NODES

#define OBJECTS_SEARCH_ALL_NODES 0

The following constant is used to specify that a name to ID search should search through all nodes.

Definition at line 200 of file object.h.

◆ OBJECTS_SEARCH_LOCAL_NODE

#define OBJECTS_SEARCH_LOCAL_NODE 0x7FFFFFFF

The following constant is used to specify that a name to ID search should search only on this node.

Definition at line 212 of file object.h.

◆ OBJECTS_SEARCH_OTHER_NODES

#define OBJECTS_SEARCH_OTHER_NODES 0x7FFFFFFE

The following constant is used to specify that a name to ID search should search through all nodes except the current node.

Definition at line 206 of file object.h.

◆ OBJECTS_UNLIMITED_OBJECTS

#define OBJECTS_UNLIMITED_OBJECTS 0x80000000U

Mask to enable unlimited objects. This is used in the configuration table when specifying the number of configured objects.

Definition at line 159 of file object.h.

◆ OBJECTS_WHO_AM_I

#define OBJECTS_WHO_AM_I 0

The following constant is used to specify that a name to ID search is being asked for the ID of the currently executing task.

Definition at line 218 of file object.h.

Typedef Documentation

◆ Objects_Id

typedef uint32_t Objects_Id

The following type defines the control block used to manage object IDs. The format is as follows (0=LSB):

Bits 0 .. 15 = index (up to 65535 objects of a type) Bits 16 .. 23 = node (up to 255 nodes) Bits 24 .. 26 = API (up to 7 API classes) Bits 27 .. 31 = class (up to 31 object types per API)

Definition at line 80 of file object.h.

◆ Objects_Maximum

typedef uint16_t Objects_Maximum

This type is used to store the maximum number of allowed objects of each type.

Definition at line 86 of file object.h.

◆ Objects_Name_comparators

typedef bool(* Objects_Name_comparators) (void *, void *, uint16_t)

Functions which compare names are prototyped like this.

Definition at line 44 of file objectimpl.h.

Enumeration Type Documentation

◆ Objects_APIs

enum Objects_APIs

This enumerated type is used in the class field of the object ID.

Definition at line 174 of file object.h.

◆ Objects_Classic_API

enum Objects_Classic_API

This enumerated type is used in the class field of the object ID for the RTEMS Classic API.

Definition at line 63 of file objectdata.h.

◆ Objects_Internal_API

enum Objects_Internal_API

This enumerated type is used in the class field of the object ID for RTEMS internal object classes.

Definition at line 52 of file objectdata.h.

◆ Objects_Name_or_id_lookup_errors

enum Objects_Name_or_id_lookup_errors

This function implements the common portion of the object identification directives. This directive returns the object id associated with name. If more than one object of this class is named name, then the object to which the id belongs is arbitrary. Node indicates the extent of the search for the id of the object named name. If the object class supports global objects, then the search can be limited to a particular node or allowed to encompass all nodes.

Definition at line 203 of file objectimpl.h.

◆ Objects_POSIX_API

enum Objects_POSIX_API

This enumerated type is used in the class field of the object ID for the POSIX API.

Definition at line 84 of file objectdata.h.

Function Documentation

◆ _Objects_Activate_unlimited()

static __inline__ void _Objects_Activate_unlimited	(	Objects_Information *	information,
		Objects_Control *	the_object
	)

static

Activate the object.

This function must be only used in case this objects information supports unlimited objects.

Parameters

information	The object information block.
the_object	The object to activate.

Definition at line 952 of file objectimpl.h.

◆ _Objects_Active_count()

Objects_Maximum _Objects_Active_count ( const Objects_Information * information )

Returns the count of active objects.

Parameters

information The object information table.

Returns: The count of active objects.

Definition at line 23 of file objectactivecount.c.

◆ _Objects_Allocate()

Objects_Control* _Objects_Allocate ( Objects_Information * information )

Allocates an object.

This function locks the object allocator mutex via _Objects_Allocator_lock(). The caller must later unlock the object allocator mutex via _Objects_Allocator_unlock(). The caller must unlock the mutex in any case, even if the allocation failed due to resource shortage.

A typical object allocation code looks like this:

rtems_status_code some_create( rtems_id *id )
{
  rtems_status_code  sc;
  Some_Control      *some;
  // The object allocator mutex protects the executing thread from
  // asynchronous thread restart and deletion.
  some = (Some_Control *) _Objects_Allocate( &_Some_Information );
  if ( some != NULL ) {
    _Some_Initialize( some );
    sc = RTEMS_SUCCESSFUL;
  } else {
    sc = RTEMS_TOO_MANY;
  }
  _Objects_Allocator_unlock();
  return sc;
}

Parameters

[in,out] information The object information block.

Return values

object	The allocated object.
NULL	No object available.

See also: _Objects_Free().

Definition at line 42 of file objectallocate.c.

◆ _Objects_Allocate_none()

Objects_Control* _Objects_Allocate_none ( Objects_Information * information )

Always return NULL.

Parameters

information The objects information.

Return values

NULL Always.

Definition at line 40 of file objectallocatenone.c.

◆ _Objects_Allocate_static()

Objects_Control* _Objects_Allocate_static ( Objects_Information * information )

Return an inactive object or NULL.

Parameters

information The objects information.

Return values

NULL	No inactive object is available.
object	An inactive object.

Definition at line 41 of file objectallocatestatic.c.

◆ _Objects_Allocate_unlimited()

Objects_Control* _Objects_Allocate_unlimited ( Objects_Information * information )

Return an inactive object or NULL.

Try to extend the objects information if necessary.

Parameters

information The objects information.

Return values

NULL	No inactive object is available.
object	An inactive object.

◆ _Objects_Allocate_unprotected()

static __inline__ Objects_Control* _Objects_Allocate_unprotected ( Objects_Information * information )

static

Allocates an object without locking the allocator mutex.

This function can be called in two contexts

the executing thread is the owner of the object allocator mutex, or
in case the system state is not up, e.g. during sequential system initialization.

Parameters

[in,out] information The object information block.

Return values

object	The allocated object.
NULL	No object available.

See also: _Objects_Allocate() and _Objects_Free().

Definition at line 877 of file objectimpl.h.

◆ _Objects_Allocate_with_extend()

static __inline__ Objects_Control* _Objects_Allocate_with_extend	(	Objects_Information *	information,
		void()(Objects_Information )	extend
	)

static

Allocate an object and extend the objects information on demand.

This function must be only used in case this objects information supports unlimited objects.

Parameters

information	The object information block.
extend	The object information extend handler.

Definition at line 982 of file objectimpl.h.

◆ _Objects_Allocator_is_owner()

static __inline__ bool _Objects_Allocator_is_owner ( void )

static

Checks if the allocator is the owner of the object allocator mutex.

Return values

true	The allocator is the owner of the object allocator mutex.
false	The allocato is not the owner of the object allocator mutex.

Definition at line 857 of file objectimpl.h.

◆ _Objects_Allocator_lock()

static __inline__ void _Objects_Allocator_lock ( void )

static

Locks the object allocator mutex.

While holding the allocator mutex the executing thread is protected from asynchronous thread restart and deletion.

The usage of the object allocator mutex with the thread life protection makes it possible to allocate and free objects without thread dispatching disabled. The usage of a unified workspace and unlimited objects may lead to heap fragmentation. Thus the execution time of the _Objects_Allocate() function may increase during system run-time.

See also: _Objects_Allocator_unlock() and _Objects_Allocate().

Definition at line 834 of file objectimpl.h.

◆ _Objects_Allocator_unlock()

static __inline__ void _Objects_Allocator_unlock ( void )

static

Unlocks the object allocator mutex.

In case the mutex is fully unlocked, then this function restores the previous thread life protection state and thus may not return if the executing thread was restarted or deleted in the mean-time.

Definition at line 846 of file objectimpl.h.

◆ _Objects_API_maximum_class()

unsigned int _Objects_API_maximum_class ( uint32_t api )

Returns highest numeric value of a valid API for the specified API.

This function returns the highest numeric value of a valid API for the specified api.

Parameters

api	The API of interest.

Return values

some_value	Positive integer on success.
0	The method failed.

Definition at line 23 of file objectapimaximumclass.c.

◆ _Objects_Are_ids_equal()

static __inline__ bool _Objects_Are_ids_equal	(	Objects_Id	left,
		Objects_Id	right
	)

static

Checks if two object IDs are equal.

Parameters

left	The Id on the left hand side of the comparison.
right	The Id on the right hand side of the comparison.

Return values

true	The specified object IDs are equal.
false	The specified object IDs are not equal.

Definition at line 611 of file objectimpl.h.

◆ _Objects_Close()

void _Objects_Close	(	const Objects_Information *	information,
		Objects_Control *	the_object
	)

Closes object.

This function removes the_object control pointer and object name in the Local Pointer and Local Name Tables.

Parameters

	information	Points to an Object Information Table.
[out]	the_object	A pointer to an object.

Definition at line 23 of file objectclose.c.

◆ _Objects_Extend_information()

Objects_Maximum _Objects_Extend_information ( Objects_Information * information )

Extends an object class information record.

Parameters

information Points to an object class information block.

Return values

0	The extend operation failed.
block	The block index of the new objects block.

◆ _Objects_Extend_size()

static __inline__ Objects_Maximum _Objects_Extend_size ( const Objects_Information * information )

static

Returns the object's objects per block.

Parameters

information The object information table.

Returns: The number of objects per block of information.

Definition at line 537 of file objectimpl.h.

◆ _Objects_Free()

static __inline__ void _Objects_Free	(	Objects_Information *	information,
		Objects_Control *	the_object
	)

static

Frees an object.

Appends the object to the chain of inactive objects.

Parameters

	information	The object information block.
[out]	the_object	The object to free.

See also: _Objects_Allocate().

A typical object deletion code looks like this:

rtems_status_code some_delete( rtems_id id )
{
  Some_Control      *some;
  // The object allocator mutex protects the executing thread from
  // asynchronous thread restart and deletion.
  _Objects_Allocator_lock();
  // Get the object under protection of the object allocator mutex.
  some = (Semaphore_Control *)
    _Objects_Get_no_protection( id, &_Some_Information );
  if ( some == NULL ) {
    _Objects_Allocator_unlock();
    return RTEMS_INVALID_ID;
  }
  // After the object close an object get with this identifier will
  // fail.
  _Objects_Close( &_Some_Information, &some->Object );
  _Some_Delete( some );
  // Thread dispatching is enabled.  The object free is only protected
  // by the object allocator mutex.
  _Objects_Free( &_Some_Information, &some->Object );
  _Objects_Allocator_unlock();
  return RTEMS_SUCCESSFUL;
}

Definition at line 933 of file objectimpl.h.

◆ _Objects_Free_objects_block()

void _Objects_Free_objects_block	(	Objects_Information *	information,
		Objects_Maximum	block
	)

Free the objects block with the specified index.

Parameters

information	The objects information.
block	The block index.

◆ _Objects_Free_static()

void _Objects_Free_static	(	Objects_Information *	information,
		Objects_Control *	the_object
	)

Free the object.

Append the object to the inactive chain of the objects information.

Parameters

information	The objects information.
the_object	The object to free.

Definition at line 41 of file objectfreestatic.c.

◆ _Objects_Free_unlimited()

void _Objects_Free_unlimited	(	Objects_Information *	information,
		Objects_Control *	the_object
	)

Free the object.

Append the object to the inactive chain of the objects information and shrink the objects information if necessary.

Parameters

information	The objects information.
the_object	The object to free.

Definition at line 24 of file objectfree.c.

◆ _Objects_Get()

Objects_Control* _Objects_Get	(	Objects_Id	id,
		ISR_lock_Context *	lock_context,
		const Objects_Information *	information
	)

Maps the specified object identifier to the associated local object control block.

In this function interrupts are disabled during the object lookup. In case an associated object exists, then interrupts remain disabled, otherwise the previous interrupt state is restored.

Parameters

id	The object identifier. This is the first parameter since usual callers get the object identifier as the first parameter themself.
lock_context	The interrupt lock context. This is the second parameter since usual callers get the interrupt lock context as the second parameter themself.
information	The object class information block.

Return values

pointer	The pointer to the associated object control block. Interrupts are now disabled and must be restored using the specified lock context via _ISR_lock_ISR_enable() or _ISR_lock_Release_and_ISR_enable().
NULL	No associated object exists.

Definition at line 28 of file objectgetlocal.c.

◆ _Objects_Get_API()

static __inline__ Objects_APIs _Objects_Get_API ( Objects_Id id )

static

Returns the API portion of the ID.

Parameters

id	The object Id to be processed.

Returns: An object Id constructed from the arguments.

Definition at line 255 of file object.h.

◆ _Objects_Get_by_name()

Objects_Control* _Objects_Get_by_name	(	const Objects_Information *	information,
		const char *	name,
		size_t *	name_length_p,
		Objects_Get_by_name_error *	error
	)

Gets an object control block identified by its name.

The object information must use string names.

Parameters

	information	The object information. Must not be NULL.
	name	The object name.
[out]	name_length_p	Optional parameter to return the name length.
[out]	error	The error indication in case of failure. Must not be NULL.

Return values

pointer	The first object according to object index associated with this name.
NULL	No object exists for this name or invalid parameters.

◆ _Objects_Get_class()

static __inline__ uint32_t _Objects_Get_class ( Objects_Id id )

static

Returns the class portion of the ID.

Parameters

id	The object Id to be processed.

Returns: The class portion of the ID.

Definition at line 269 of file object.h.

◆ _Objects_Get_inactive()

static __inline__ Objects_Control* _Objects_Get_inactive ( Objects_Information * information )

static

Get an inactive object or NULL.

Return values

NULL	No inactive object is available.
object	An inactive object.

Definition at line 655 of file objectimpl.h.

◆ _Objects_Get_index()

static __inline__ Objects_Maximum _Objects_Get_index ( Objects_Id id )

static

Returns the index portion of the ID.

Parameters

id	is the Id to be processed.

Returns: Returns the index portion of the specified object ID.

Definition at line 298 of file object.h.

◆ _Objects_Get_information()

Objects_Information* _Objects_Get_information	(	Objects_APIs	the_api,
		uint16_t	the_class
	)

Gets object information.

This function returns the information structure given an API and Class. This can be done independent of the existence of any objects created by the API.

Parameters

the_api	Indicates the API for the information we want
the_class	Indicates the Class for the information we want

Return values

pointer	Pointer to the Object Information Table for the class of objects which corresponds to this object ID.
NULL	An error occured.

Definition at line 23 of file objectgetinfo.c.

◆ _Objects_Get_information_id()

Objects_Information* _Objects_Get_information_id ( Objects_Id id )

Gets information of an object from an ID.

This function returns the information structure given an id of an object.

Parameters

id	The object ID to get the information from.

Return values

pointer	Pointer to the Object Information Table for the class of objects which corresponds to this object ID.
NULL	An error occured.

Definition at line 24 of file objectgetinfoid.c.

◆ _Objects_Get_maximum_index()

static __inline__ Objects_Maximum _Objects_Get_maximum_index ( const Objects_Information * information )

static

Returns the maximum index of the specified object class.

Parameters

information The object information.

Returns: The maximum index of the specified object class.

Definition at line 642 of file objectimpl.h.

◆ _Objects_Get_minimum_id()

static __inline__ Objects_Id _Objects_Get_minimum_id ( Objects_Id id )

static

Returns the identifier with the minimum index for the specified identifier.

The specified identifier must have valid API, class and node fields.

Parameters

id	The identifier to be processed.

Returns: The corresponding ID with the minimum index.

Definition at line 628 of file objectimpl.h.

◆ _Objects_Get_name_as_string()

char* _Objects_Get_name_as_string	(	Objects_Id	id,
		size_t	length,
		char *	name
	)

Gets object name in the form of a C string.

This method gets the name of an object and returns its name in the form of a C string. It attempts to be careful about overflowing the user's string and about returning unprintable characters.

Parameters

	id	The object to obtain the name of.
	length	Indicates the length of the caller's buffer.
[out]	name	A string which will be filled in.

Return values

Definition at line 87 of file objectgetnameasstring.c.

◆ _Objects_Get_next()

Objects_Control* _Objects_Get_next	(	Objects_Id	id,
		const Objects_Information *	information,
		Objects_Id *	next_id_p
	)

Gets the next open object after the specified object identifier.

Locks the object allocator mutex in case a next object exists.

Parameters

	id	The Id of the object whose name we are locating. This is the first parameter since usual callers get the object identifier as the first parameter themself.
	information	Points to an object class information block.
[in,out]	next_id_p	The Id of the next object we will look at.

Return values

pointer	Pointer to the located object.
NULL	An error occured.

◆ _Objects_Get_no_protection()

Objects_Control* _Objects_Get_no_protection	(	Objects_Id	id,
		const Objects_Information *	information
	)

Maps object ids to object control blocks.

This function maps object ids to object control blocks. If id corresponds to a local object, then it returns the_object control pointer which maps to id and location is set to OBJECTS_LOCAL. If the object class supports global objects and the object id is global and resides on a remote node, then location is set to OBJECTS_REMOTE, and the_object is undefined. Otherwise, location is set to OBJECTS_ERROR and the_object is undefined.

Parameters

id	The Id of the object whose name we are locating. This is the first parameter since usual callers get the object identifier as the first parameter themself.
information	Points to an object class information block.

Return values

pointer	The local object corresponding to the given id.
NULL	The object to the given id was not found locally.

Definition at line 23 of file objectgetnoprotection.c.

◆ _Objects_Get_node()

static __inline__ uint32_t _Objects_Get_node ( Objects_Id id )

static

Returns the node portion of the ID.

Parameters

id	The object Id to be processed.

Returns: Returns the node portion of an object ID.

Definition at line 284 of file object.h.

◆ _Objects_Has_string_name()

static __inline__ bool _Objects_Has_string_name ( const Objects_Information * information )

static

Returns if the object has a string name.

Parameters

information The object information table.

Return values

true	The object has a string name.
false	The object does not have a string name.

Definition at line 411 of file objectimpl.h.

◆ _Objects_Id_to_name()

Objects_Name_or_id_lookup_errors _Objects_Id_to_name	(	Objects_Id	id,
		Objects_Name *	name
	)

Returns the name associated with object id.

This function implements the common portion of the object Id to name directives. This function returns the name associated with object id.

Parameters

	id	is the Id of the object whose name we are locating.
[out]	name	will contain the name of the object, if found.

Return values

OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL	The operation succeeded. name contains the name of the object.
OBJECTS_INVALID_ID	The id is invalid, the operation failed.

Note: This function currently does not support string names.

◆ _Objects_Initialize_information()

void _Objects_Initialize_information ( Objects_Information * information )

Initializes the specified objects information.

The objects information must be statically pre-initialized with the OBJECTS_INFORMATION_DEFINE() macro before this function is called.

Parameters

information The object information to be initialized.

Definition at line 29 of file objectinitializeinformation.c.

◆ _Objects_Invalidate_Id()

static __inline__ void _Objects_Invalidate_Id	(	const Objects_Information *	information,
		Objects_Control *	the_object
	)

static

Invalidates an object Id.

This function sets the pointer to the local_table object referenced by the index to NULL so the object Id is invalid after this call.

Parameters

[in,out]	information	points to an Object Information Table.
	the_object	The local object pointer.

Note: This routine is ONLY to be called in places where the index portion of the Id is known to be good. This is OK since it is normally called from object create/init or delete/destroy operations.

Definition at line 725 of file objectimpl.h.

◆ _Objects_Is_api_valid()

static __inline__ bool _Objects_Is_api_valid ( uint32_t the_api )

static

Checks if the api is valid.

Parameters

the_api is the api portion of an object ID.

Return values

true	The specified api value is valid.
false	The specified api value is not valid.

Definition at line 552 of file objectimpl.h.

◆ _Objects_Is_auto_extend()

static __inline__ Objects_Maximum _Objects_Is_auto_extend ( const Objects_Information * information )

static

Checks if the automatic object extension (unlimited objects) is enabled.

Parameters

information The object information.

Return values

true	The automatic object extension (unlimited objects) is enabled.
false	The automatic object extension (unlimited objects) is not enabled.

Definition at line 671 of file objectimpl.h.

◆ _Objects_Is_local_id()

static __inline__ bool _Objects_Is_local_id ( Objects_Id id RTEMS_UNUSED )

static

Checks if the id is of a local object.

Parameters

id	The object ID.

Return values

true	The specified object Id is local.
false	The specified object Id is not local.

Note: On a single processor configuration, this always returns true.

Definition at line 587 of file objectimpl.h.

◆ _Objects_Is_local_node()

static __inline__ bool _Objects_Is_local_node ( uint32_t node )

static

Checks if the node is of the local object.

Parameters

node	The node number and corresponds to the node number portion of an object ID.

Return values

true	The specified node is the local node.
false	The specified node is not the local node.

Definition at line 570 of file objectimpl.h.

◆ _Objects_Name_to_id_u32()

Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32	(	uint32_t	name,
		uint32_t	node,
		Objects_Id *	id,
		const Objects_Information *	information
	)

Searches an object of the specified class with the specified name on the specified set of nodes.

This method converts an object name to an identifier. It performs a look up using the object information block for this object class.

Parameters

	name	is the name of the object to find.
	node	is the set of nodes to search.
[out]	id	is the pointer to an object identifier variable or NULL. The object identifier will be stored in the referenced variable, if the operation was successful.
	information	is the pointer to an object class information block.

Return values

OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL	The operations was successful.
OBJECTS_INVALID_ADDRESS	The id parameter was NULL.
OBJECTS_INVALID_NAME	No object exists with the specified name on the specified node set.

Definition at line 23 of file objectnametoid.c.

◆ _Objects_Name_to_string()

size_t _Objects_Name_to_string	(	Objects_Name	name,
		bool	is_string,
		char *	buffer,
		size_t	buffer_size
	)

Converts the specified object name to a text representation.

Non-printable characters according to isprint() are converted to '*'.

Parameters

	name	The object name.
	is_string	Indicates if the object name is a string or a four character array (32-bit unsigned integer).
[out]	buffer	The string buffer for the text representation.
	buffer_size	The buffer size in characters.

Returns: The length of the text representation. May be greater than or equal to the buffer size if truncation occurred.

Definition at line 36 of file objectgetnameasstring.c.

◆ _Objects_Namespace_remove_string()

void _Objects_Namespace_remove_string	(	const Objects_Information *	information,
		Objects_Control *	the_object
	)

Removes object with a string name from its namespace.

Parameters

	information	The corresponding object information table.
[out]	the_object	The object the object to operate upon.

Definition at line 25 of file objectnamespaceremove.c.

◆ _Objects_Namespace_remove_u32()

static __inline__ void _Objects_Namespace_remove_u32	(	const Objects_Information *	information,
		Objects_Control *	the_object
	)

static

Removes object with a 32-bit integer name from its namespace.

Parameters

	information	The corresponding object information table.
[out]	the_object	The object to operate upon.

Definition at line 485 of file objectimpl.h.

◆ _Objects_Open()

static __inline__ void _Objects_Open	(	Objects_Information *	information,
		Objects_Control *	the_object,
		Objects_Name	name
	)

static

Places the_object control pointer and object name in the Local Pointer and Local Name Tables, respectively.

This method uses Objects_Name for the object name.

Parameters

[in,out]	information	Points to an Object Information Table.
	the_object	Pointer to an object.
	name	The name of the object to make accessible.

Definition at line 750 of file objectimpl.h.

◆ _Objects_Open_string()

static __inline__ void _Objects_Open_string	(	const Objects_Information *	information,
		Objects_Control *	the_object,
		const char *	name
	)

static

Places the_object control pointer and object name in the Local Pointer and Local Name Tables, respectively.

This method uses a String for the object name.

Parameters

[in,out]	information	Points to an Object Information Table.
	the_object	Pointer to an object.
	name	The name of the object to make accessible.

Definition at line 804 of file objectimpl.h.

◆ _Objects_Open_u32()

static __inline__ void _Objects_Open_u32	(	const Objects_Information *	information,
		Objects_Control *	the_object,
		uint32_t	name
	)

static

Places the_object control pointer and object name in the Local Pointer and Local Name Tables, respectively.

This method uses uint32_t for the object name.

Parameters

[in,out]	information	Points to an Object Information Table.
	the_object	Pointer to an object.
	name	The name of the object to make accessible.

Definition at line 778 of file objectimpl.h.

◆ _Objects_Set_local_object()

static __inline__ void _Objects_Set_local_object	(	const Objects_Information *	information,
		uint32_t	index,
		Objects_Control *	the_object
	)

static

Sets the pointer to the local_table object referenced by the index.

Parameters

[in,out]	information	Points to an Object Information Table.
	index	The index of the object the caller wants to access.
	the_object	The local object pointer.

Note: This routine is ONLY to be called in places where the index portion of the Id is known to be good. This is OK since it is normally called from object create/init or delete/destroy operations.

Definition at line 692 of file objectimpl.h.

◆ _Objects_Set_name()

bool _Objects_Set_name	(	const Objects_Information *	information,
		Objects_Control *	the_object,
		const char *	name
	)

Sets objects name.

This method sets the object name to either a copy of a string or up to the first four characters of the string based upon whether this object class uses strings for names.

Parameters

	information	points to the object information structure
[out]	the_object	is the object to operate upon
	name	is a pointer to the name to use

Return values

true	The operation succeeded.
false	The operation failed.

◆ _Objects_Shrink_information()

void _Objects_Shrink_information ( Objects_Information * information )

Shrinks an object class information record.

This function shrinks an object class information record. The object's name and object space are released. The local_table etc block does not shrink. The InActive list needs to be scanned to find the objects are remove them.

Parameters

information Points to an object class information block.

Variable Documentation

◆ _Objects_Information_table

Objects_Information** const _Objects_Information_table[OBJECTS_APIS_LAST+1]

The following is the list of information blocks per API for each object class. From the ID, we can go to one of these information blocks, and obtain a pointer to the appropriate object control block.

Files

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ _Objects_Build_id

◆ _Objects_Build_name

◆ _Objects_Is_unlimited

◆ _Objects_Maximum_nodes

◆ OBJECTS_API_MASK

◆ OBJECTS_API_START_BIT

◆ OBJECTS_API_VALID_BITS

◆ OBJECTS_APIS_LAST

◆ OBJECTS_CLASS_MASK

◆ OBJECTS_CLASS_START_BIT

◆ OBJECTS_CLASS_VALID_BITS

◆ OBJECTS_ID_FINAL

◆ OBJECTS_ID_FINAL_INDEX

◆ OBJECTS_ID_INITIAL

◆ OBJECTS_ID_INITIAL_INDEX

◆ OBJECTS_ID_NONE

◆ OBJECTS_ID_OF_SELF

◆ OBJECTS_INDEX_MASK

◆ OBJECTS_INDEX_MINIMUM

◆ OBJECTS_INDEX_START_BIT

◆ OBJECTS_INDEX_VALID_BITS

◆ OBJECTS_INFORMATION_DEFINE

◆ OBJECTS_INFORMATION_DEFINE_ZERO

◆ OBJECTS_INTERNAL_CLASSES_LAST

◆ OBJECTS_NAME_ERRORS_FIRST

◆ OBJECTS_NAME_ERRORS_LAST

◆ OBJECTS_NODE_MASK

◆ OBJECTS_NODE_START_BIT

◆ OBJECTS_NODE_VALID_BITS

◆ OBJECTS_POSIX_CLASSES_LAST

◆ OBJECTS_RTEMS_CLASSES_LAST

◆ OBJECTS_SEARCH_ALL_NODES

◆ OBJECTS_SEARCH_LOCAL_NODE

◆ OBJECTS_SEARCH_OTHER_NODES

◆ OBJECTS_UNLIMITED_OBJECTS

◆ OBJECTS_WHO_AM_I

Typedef Documentation

◆ Objects_Id

◆ Objects_Maximum

◆ Objects_Name_comparators

Enumeration Type Documentation

◆ Objects_APIs

◆ Objects_Classic_API

◆ Objects_Internal_API

◆ Objects_Name_or_id_lookup_errors

◆ Objects_POSIX_API

Function Documentation

◆ _Objects_Activate_unlimited()

◆ _Objects_Active_count()

◆ _Objects_Allocate()

◆ _Objects_Allocate_none()

◆ _Objects_Allocate_static()

◆ _Objects_Allocate_unlimited()

◆ _Objects_Allocate_unprotected()

◆ _Objects_Allocate_with_extend()

◆ _Objects_Allocator_is_owner()

◆ _Objects_Allocator_lock()

◆ _Objects_Allocator_unlock()

◆ _Objects_API_maximum_class()

◆ _Objects_Are_ids_equal()

◆ _Objects_Close()

◆ _Objects_Extend_information()

◆ _Objects_Extend_size()

◆ _Objects_Free()

◆ _Objects_Free_objects_block()

◆ _Objects_Free_static()

◆ _Objects_Free_unlimited()

◆ _Objects_Get()

◆ _Objects_Get_API()

◆ _Objects_Get_by_name()

◆ _Objects_Get_class()