/** * @file  rtems/score/object.h */ /* *  This include file contains all the constants and structures associated *  with the Object Handler.  This Handler provides mechanisms which *  can be used to initialize and manipulate all objects which have *  ids. * *  COPYRIGHT (c) 1989-2006. *  On-Line Applications Research Corporation (OAR). * *  The license and distribution terms for this file may be *  found in the file LICENSE in this distribution or at *  http://www.rtems.com/license/LICENSE. * *  $Id: object.h,v 1.45 2006/01/16 15:13:58 joel Exp $ */#ifndef _RTEMS_SCORE_OBJECT_H#define _RTEMS_SCORE_OBJECT_H#ifdef __cplusplusextern "C" {#endif#include <rtems/score/chain.h>#include <rtems/score/isr.h>/** *  The following type defines the control block used to manage *  object names. */typedef void * Objects_Name;/** *  Space for object names is allocated in multiples of this. * *  NOTE:  Must be a power of 2.  Matches the name manipulation routines. */#define OBJECTS_NAME_ALIGNMENT     sizeof( uint32_t )/** *  Functions which compare names are prototyped like this. */typedef boolean (*Objects_Name_comparators)(  void       * /* name_1 */,  void       * /* name_2 */,  uint16_t     /* length */);#if defined(RTEMS_USE_16_BIT_OBJECT)/** *  The following type defines the control block used to manage *  object IDs.  The format is as follows (0=LSB): * *     Bits  0 ..  7    = index  (up to 254 objects of a type) *     Bits  8 .. 10    = API    (up to 7 API classes) *     Bits 11 .. 15    = class  (up to 31 object types per API) */typedef uint16_t   Objects_Id;/** * This type is used to store the maximum number of allowed objects * of each type. */typedef uint8_t    Objects_Maximum;#define OBJECTS_INDEX_START_BIT  0#define OBJECTS_API_START_BIT    8#define OBJECTS_CLASS_START_BIT 11#define OBJECTS_INDEX_MASK      (Objects_Id)0x00ff#define OBJECTS_API_MASK        (Objects_Id)0x0700#define OBJECTS_CLASS_MASK      (Objects_Id)0xF800#define OBJECTS_INDEX_VALID_BITS  (Objects_Id)0x00ff#define OBJECTS_API_VALID_BITS    (Objects_Id)0x0007/* OBJECTS_NODE_VALID_BITS should not be used with 16 bit Ids */#define OBJECTS_CLASS_VALID_BITS  (Objects_Id)0x001f#define OBJECTS_UNLIMITED_OBJECTS 0x8000#define OBJECTS_ID_INITIAL_INDEX  (0)#define OBJECTS_ID_FINAL_INDEX    (0xff)#else/** *  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) */typedef uint32_t   Objects_Id;/** * This type is used to store the maximum number of allowed objects * of each type. */typedef uint16_t   Objects_Maximum;/** *  This is the bit position of the starting bit of the index portion of *  the object Id. */#define OBJECTS_INDEX_START_BIT  0/** *  This is the bit position of the starting bit of the node portion of *  the object Id. */#define OBJECTS_NODE_START_BIT  16/** *  This is the bit position of the starting bit of the API portion of *  the object Id. */#define OBJECTS_API_START_BIT   24/** *  This is the bit position of the starting bit of the class portion of *  the object Id. */#define OBJECTS_CLASS_START_BIT 27/** *  This mask is used to extract the index portion of an object Id. */#define OBJECTS_INDEX_MASK      (Objects_Id)0x0000ffff/** *  This mask is used to extract the node portion of an object Id. */#define OBJECTS_NODE_MASK       (Objects_Id)0x00ff0000/** *  This mask is used to extract the API portion of an object Id. */#define OBJECTS_API_MASK        (Objects_Id)0x07000000/** *  This mask is used to extract the class portion of an object Id. */#define OBJECTS_CLASS_MASK      (Objects_Id)0xf8000000/** *  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. */#define OBJECTS_INDEX_VALID_BITS  (Objects_Id)0x0000ffff/** *  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. */#define OBJECTS_NODE_VALID_BITS   (Objects_Id)0x000000ff/** *  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. */#define OBJECTS_API_VALID_BITS    (Objects_Id)0x00000007/** *  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. */#define OBJECTS_CLASS_VALID_BITS  (Objects_Id)0x0000001f/** *  Mask to enable unlimited objects.  This is used in the configuration *  table when specifying the number of configured objects. */#define OBJECTS_UNLIMITED_OBJECTS 0x80000000/** *  This is the lowest value for the index portion of an object Id. */#define OBJECTS_ID_INITIAL_INDEX  (0)/** *  This is the highest value for the index portion of an object Id. */#define OBJECTS_ID_FINAL_INDEX    (0xff)#endif/** *  This enumerated type is used in the class field of the object ID. */typedef enum {  OBJECTS_NO_API       = 0,  OBJECTS_INTERNAL_API = 1,  OBJECTS_CLASSIC_API  = 2,  OBJECTS_POSIX_API    = 3,  OBJECTS_ITRON_API    = 4} Objects_APIs;/** This macro is used to generically specify the last API index. */#define OBJECTS_APIS_LAST OBJECTS_ITRON_API/** *  This enumerated type is used in the class field of the object ID *  for RTEMS internal object classes. */typedef enum {  OBJECTS_INTERNAL_NO_CLASS =  0,  OBJECTS_INTERNAL_THREADS  =  1,  OBJECTS_INTERNAL_MUTEXES  =  2} Objects_Internal_API;/** This macro is used to generically specify the last API index. */#define OBJECTS_INTERNAL_CLASSES_LAST OBJECTS_INTERNAL_MUTEXES/** *  This enumerated type is used in the class field of the object ID *  for the RTEMS Classic API. */typedef enum {  OBJECTS_CLASSIC_NO_CLASS     = 0,  OBJECTS_RTEMS_TASKS          = 1,  OBJECTS_RTEMS_TIMERS         = 2,  OBJECTS_RTEMS_SEMAPHORES     = 3,  OBJECTS_RTEMS_MESSAGE_QUEUES = 4,  OBJECTS_RTEMS_PARTITIONS     = 5,  OBJECTS_RTEMS_REGIONS        = 6,  OBJECTS_RTEMS_PORTS          = 7,  OBJECTS_RTEMS_PERIODS        = 8,  OBJECTS_RTEMS_EXTENSIONS     = 9} Objects_Classic_API;/** This macro is used to generically specify the last API index. */#define OBJECTS_RTEMS_CLASSES_LAST OBJECTS_RTEMS_EXTENSIONS/** *  This enumerated type is used in the class field of the object ID *  for the POSIX API. */typedef enum {  OBJECTS_POSIX_NO_CLASS            = 0,  OBJECTS_POSIX_THREADS             = 1,  OBJECTS_POSIX_KEYS                = 2,  OBJECTS_POSIX_INTERRUPTS          = 3,  OBJECTS_POSIX_MESSAGE_QUEUE_FDS   = 4,  OBJECTS_POSIX_MESSAGE_QUEUES      = 5,  OBJECTS_POSIX_MUTEXES             = 6,  OBJECTS_POSIX_SEMAPHORES          = 7,  OBJECTS_POSIX_CONDITION_VARIABLES = 8} Objects_POSIX_API;/** This macro is used to generically specify the last API index. */#define OBJECTS_POSIX_CLASSES_LAST OBJECTS_POSIX_CONDITION_VARIABLES/** *  This enumerated type is used in the class field of the object ID *  for the ITRON API. */typedef enum {  OBJECTS_ITRON_NO_CLASS              = 0,  OBJECTS_ITRON_TASKS                 = 1,  OBJECTS_ITRON_EVENTFLAGS            = 2,  OBJECTS_ITRON_MAILBOXES             = 3,  OBJECTS_ITRON_MESSAGE_BUFFERS       = 4,  OBJECTS_ITRON_PORTS                 = 5,  OBJECTS_ITRON_SEMAPHORES            = 6,  OBJECTS_ITRON_VARIABLE_MEMORY_POOLS = 7,  OBJECTS_ITRON_FIXED_MEMORY_POOLS    = 8} Objects_ITRON_API;/** This macro is used to generically specify the last API index. */#define OBJECTS_ITRON_CLASSES_LAST OBJECTS_ITRON_FIXED_MEMORY_POOLS/** *  This enumerated type lists the locations which may be returned *  by _Objects_Get.  These codes indicate the success of locating *  an object with the specified ID. */typedef enum {  OBJECTS_LOCAL  = 0,         /* object is local */  OBJECTS_REMOTE = 1,         /* object is remote */  OBJECTS_ERROR  = 2          /* id was invalid */} Objects_Locations;/** *  The following type defines the callout used when a local task *  is extracted from a remote thread queue (i.e. it's proxy must *  extracted from the remote queue). */typedef void ( *Objects_Thread_queue_Extract_callout )( void * );/** *  The following defines the Object Control Block used to manage *  each object local to this node. */typedef struct {  /** This is the chain node portion of an object. */  Chain_Node     Node;  /** This is the object's ID. */  Objects_Id     id;  /** This is the object's name. */  Objects_Name   name;} Objects_Control;/** *  The following defines the structure for the information used to *  manage each class of objects. */typedef struct {  /** This field indicates the API of this object class. */  Objects_APIs      the_api;  /** This is the class of this object set. */  uint16_t          the_class;  /** This is the minimum valid id of this object class. */  Objects_Id        minimum_id;  /** This is the maximum valid id of this object class. */  Objects_Id        maximum_id;  /** This is the maximum number of objects in this class. */  Objects_Maximum   maximum;  /** This is the TRUE if unlimited objects in this class. */  boolean           auto_extend;  /** This is the number of objects in a block. */  uint32_t          allocation_size;  /** This is the size in bytes of each object instance. */  uint32_t          size;  /** This points to the table of local objects. */  Objects_Control **local_table;  /** This points to the table of local object names. */  Objects_Name     *name_table;  /** This is the chain of inactive control blocks. */  Chain_Control     Inactive;  /** This is the number of objects on the Inactive list. */  Objects_Maximum   inactive;  /** This is the number of inactive objects per block. */  uint32_t         *inactive_per_block;  /** This is a table to the chain of inactive object memory blocks. */  void            **object_blocks;  /** This is the TRUE if names are strings. */  boolean           is_string;  /** This is the maximum length of names. */  uint16_t          name_length;  /** This is this object class' method called when extracting a thread. */  Objects_Thread_queue_Extract_callout extract;#if defined(RTEMS_MULTIPROCESSING)  /** This is this object class' pointer to the global name table */  Chain_Control    *global_table;#endif}   Objects_Information;/** *  The following is referenced to the node number of the local node. */#if defined(RTEMS_MULTIPROCESSING)SCORE_EXTERN uint16_t    _Objects_Local_node;#else#define _Objects_Local_node    1#endif/** *  The following is referenced to the number of nodes in the system. */#if defined(RTEMS_MULTIPROCESSING)SCORE_EXTERN uint16_t    _Objects_Maximum_nodes;#else#define _Objects_Maximum_nodes 1#endif/** *  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. */SCORE_EXTERN Objects_Information    **_Objects_Information_table[OBJECTS_APIS_LAST + 1];/** *  The following defines the constant which may be used *  with _Objects_Get to manipulate the calling task. */#define OBJECTS_ID_OF_SELF ((Objects_Id) 0)/** *  The following constant is used to specify that a name to ID search *  should search through 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 except the current node. */#define OBJECTS_SEARCH_OTHER_NODES 0x7FFFFFFE/** *  The following constant is used to specify that a name to ID search *  should search only on this node. */#define OBJECTS_SEARCH_LOCAL_NODE  0x7FFFFFFF/** *  The following constant is used to specify that a name to ID search *  is being asked for the ID of the currently executing task.