diff options
Diffstat (limited to 'cpukit/score/include/rtems/score/objectmp.h')
-rw-r--r-- | cpukit/score/include/rtems/score/objectmp.h | 75 |
1 files changed, 64 insertions, 11 deletions
diff --git a/cpukit/score/include/rtems/score/objectmp.h b/cpukit/score/include/rtems/score/objectmp.h index 7f9e25b707..6275304012 100644 --- a/cpukit/score/include/rtems/score/objectmp.h +++ b/cpukit/score/include/rtems/score/objectmp.h @@ -6,7 +6,7 @@ */ /* - * COPYRIGHT (c) 1989-2004. + * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be @@ -22,7 +22,9 @@ /** * @defgroup ScoreObjectMP Object Handler Multiprocessing Support * - * This group contains functionality which XXX + * 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. */ /**@{*/ @@ -30,20 +32,29 @@ extern "C" { #endif -/* +/** * This defines the Global Object Control Block used to manage - * objects resident on other nodes. + * objects resident on other nodes. It is derived from Object. */ typedef struct { + /** This is an object control structure. */ Objects_Control Object; - uint32_t name; /* XXX broken but works */ - /* XXX If any API is MP with variable length names .. BOOM!!!! */ + /** This is the name of the object. Using an unsigned thirty two + * bit value is broken but works. If any API is MP with variable + * length names .. BOOM!!!! + */ + uint32_t name; } Objects_MP_Control; /** @brief Objects MP Handler initialization * * This routine intializes the inactive global object chain * based on the maximum number of global objects configured. + * + * @param[in] node is this node's number. + * @param[in] maximum_nodes is the maximum number of nodes in the system. + * @param[in] maximum_global_objects is the maximum number of concurrently + * created global objects. */ void _Objects_MP_Handler_initialization ( uint32_t node, @@ -55,12 +66,20 @@ void _Objects_MP_Handler_initialization ( * * This routine place the specified global object in the * specified information table. + * + * @param[in] information points to the object information table for this + * object class. + * @param[in] the_global_object points to the object being opened. + * @param[in] the_name is the name of the object being opened. + * @param[in] the_id is 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. */ - void _Objects_MP_Open ( Objects_Information *information, Objects_MP_Control *the_global_object, - uint32_t the_name, /* XXX -- wrong for variable */ + uint32_t the_name, Objects_Id the_id ); @@ -70,10 +89,20 @@ void _Objects_MP_Open ( * and places it in the specified information table. If the * allocation fails, then is_fatal_error determines the * error processing actions taken. + * + * @param[in] information points to the object information table for this + * object class. + * @param[in] the_name is the name of the object being opened. + * @param[in] the_id is the Id of the object being opened. + * @param[in] is_fatal_error is 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. */ boolean _Objects_MP_Allocate_and_open ( Objects_Information *information, - uint32_t the_name, /* XXX -- wrong for variable length */ + uint32_t the_name, Objects_Id the_id, boolean is_fatal_error ); @@ -93,6 +122,16 @@ void _Objects_MP_Close ( * 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. + * + * @param[in] information points to the object information table for this + * object class. + * @param[in] the_name is the name of the object being searched for. + * @param[in] nodes_to_search indicates the set of nodes to search. + * @param[in] the_id will contain the Id of the object if found. + * + * @return This method returns one of the + * @ref Objects_Name_or_id_lookup_errors. If successful, @a the_id + * will contain the Id of the object. */ Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search ( Objects_Information *information, @@ -108,6 +147,16 @@ Objects_Name_or_id_lookup_errors _Objects_MP_Global_name_search ( * is found, then location is set to objects_remote, otherwise * location is set to objects_error. In both cases, the_object * is undefined. + * + * @param[in] information points to the object information table for this + * object class. + * @param[in] the_id is the Id of the object being opened. + * @param[in] location will contain the location of the object. + * @param[in] the_object will contain a pointer to the object. + * + * @return This method fills in @a location to indicate successful location + * of the object or error. On success, @a the_object will be + * filled in. */ void _Objects_MP_Is_remote ( Objects_Information *information, @@ -116,11 +165,15 @@ void _Objects_MP_Is_remote ( Objects_Control **the_object ); -/* +/** + * This is the maximum number of global objects configured. + */ +SCORE_EXTERN uint32_t _Objects_MP_Maximum_global_objects; + +/** * The following chain header is used to manage the set of * inactive global object control blocks. */ -SCORE_EXTERN uint32_t _Objects_MP_Maximum_global_objects; SCORE_EXTERN Chain_Control _Objects_MP_Inactive_global_objects; #ifndef __RTEMS_APPLICATION__ |