RTEMS  5.0.0
Files | Functions | Variables
Object Handler Multiprocessing Support

Files

file  objectmp.c
 Objects MP Support.
 

Functions

void _Objects_MP_Handler_initialization (void)
 Intializes the inactive global object chain based on the maximum number of global objects configured. More...
 
void _Objects_MP_Handler_early_initialization (void)
 Intializes the global object node number used in the ID field of all objects. More...
 
void _Objects_MP_Open (Objects_Information *information, Objects_MP_Control *the_global_object, uint32_t the_name, Objects_Id the_id)
 Place the specified global object in the specified information table. More...
 
bool _Objects_MP_Allocate_and_open (Objects_Information *information, uint32_t the_name, Objects_Id the_id, bool is_fatal_error)
 Allocates a global object control block and places it in the specified information table. More...
 
void _Objects_MP_Close (Objects_Information *information, Objects_Id the_id)
 Removes a global object from the specified information table. More...
 
Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search (Objects_Information *information, Objects_Name the_name, uint32_t nodes_to_search, Objects_Id *the_id)
 Look for the object with the_name in the global object tables indicated by information. More...
 
bool _Objects_MP_Is_remote (Objects_Id id, const Objects_Information *information)
 Returns true, if the object identifier is in the global object identifier cache of the specified object information, otherwise false. More...
 
Objects_MP_Control * _Objects_MP_Allocate_global_object (void)
 
void _Objects_MP_Free_global_object (Objects_MP_Control *the_object)
 
RTEMS_INLINE_ROUTINE bool _Objects_MP_Is_null_global_object (Objects_MP_Control *the_object)
 

Variables

uint32_t _Objects_MP_Maximum_global_objects
 

Detailed Description

This handler encapsulates functionality which is used to manage objects which have been declared to be globally visible. This handler knows objects from all of the nodes in the system.

Function Documentation

◆ _Objects_MP_Allocate_and_open()

bool _Objects_MP_Allocate_and_open ( Objects_Information information,
uint32_t  the_name,
Objects_Id  the_id,
bool  is_fatal_error 
)

Allocates a global object control block and places it in the specified information table.

This routine allocates a global object control block and places it in the specified information table. If the allocation fails, then is_fatal_error determines the error processing actions taken.

Parameters
[in]informationpoints to the object information table for this object class.
[in]the_nameis the name of the object being opened.
[in]the_idis the Id of the object being opened.
[in]is_fatal_erroris true if not being able to allocate the object is considered a fatal error.
Todo:
This method only works for object types with 4 byte object names. It does not support variable length object names.

◆ _Objects_MP_Allocate_global_object()

Objects_MP_Control* _Objects_MP_Allocate_global_object ( void  )

This function allocates a Global Object control block.

◆ _Objects_MP_Close()

void _Objects_MP_Close ( Objects_Information information,
Objects_Id  the_id 
)

Removes a global object from the specified information table.

This routine removes a global object from the specified information table and deallocates the global object control block.

◆ _Objects_MP_Free_global_object()

void _Objects_MP_Free_global_object ( Objects_MP_Control *  the_object)

This routine deallocates a Global Object control block.

◆ _Objects_MP_Global_name_search()

Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search ( Objects_Information information,
Objects_Name  the_name,
uint32_t  nodes_to_search,
Objects_Id the_id 
)

Look for the object with the_name in the global object tables indicated by information.

This routine looks for the object with the_name in the global object tables indicated by information. It returns the ID of the object with that name if one is found.

Parameters
[in]informationpoints to the object information table for this object class.
[in]the_nameis the name of the object being searched for.
[in]nodes_to_searchindicates the set of nodes to search.
[in]the_idwill contain the Id of the object if found.
Return values
Thismethod returns one of the Objects_Name_or_id_lookup_errors. If successful, the_id will contain the Id of the object.

◆ _Objects_MP_Handler_early_initialization()

void _Objects_MP_Handler_early_initialization ( void  )

Intializes the global object node number used in the ID field of all objects.

This routine intializes the global object node number used in the ID field of all objects.

◆ _Objects_MP_Handler_initialization()

void _Objects_MP_Handler_initialization ( void  )

Intializes the inactive global object chain based on the maximum number of global objects configured.

This routine intializes the inactive global object chain based on the maximum number of global objects configured.

◆ _Objects_MP_Is_null_global_object()

RTEMS_INLINE_ROUTINE bool _Objects_MP_Is_null_global_object ( Objects_MP_Control *  the_object)

This function returns whether the global object is NULL or not.

◆ _Objects_MP_Is_remote()

bool _Objects_MP_Is_remote ( Objects_Id  id,
const Objects_Information information 
)

Returns true, if the object identifier is in the global object identifier cache of the specified object information, otherwise false.

Parameters
idThe object identifier.
informationThe object information.
Return values
trueA remote objects with this object identifier exits in the global object identifier cache of the specified information.
falseOtherwise.

◆ _Objects_MP_Open()

void _Objects_MP_Open ( Objects_Information information,
Objects_MP_Control *  the_global_object,
uint32_t  the_name,
Objects_Id  the_id 
)

Place the specified global object in the specified information table.

This routine place the specified global object in the specified information table.

Parameters
[in]informationpoints to the object information table for this object class.
[in]the_global_objectpoints to the object being opened.
[in]the_nameis the name of the object being opened.
[in]the_idis the Id of the object being opened.
Todo:
This method only works for object types with 4 byte object names. It does not support variable length object names.

Variable Documentation

◆ _Objects_MP_Maximum_global_objects

uint32_t _Objects_MP_Maximum_global_objects

This is the maximum number of global objects configured.