rtems/score/object.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 1989-2011.
 *  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.
 */

#ifndef _RTEMS_SCORE_OBJECT_H
#define _RTEMS_SCORE_OBJECT_H

#include <rtems/score/chain.h>
#include <rtems/score/isr.h>

#if defined(RTEMS_POSIX_API)

  #define RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES
#endif

#ifdef __cplusplus
extern "C" {
#endif

typedef union {
  #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)

    const char *name_p;
  #endif

  uint32_t    name_u32;
} Objects_Name;

typedef bool    (*Objects_Name_comparators)(
  void       * /* name_1 */,
  void       * /* name_2 */,
  uint16_t     /* length */
);

#if defined(RTEMS_USE_16_BIT_OBJECT)

typedef uint16_t   Objects_Id;

typedef uint8_t    Objects_Maximum;

#define OBJECTS_INDEX_START_BIT  0U
#define OBJECTS_API_START_BIT    8U
#define OBJECTS_CLASS_START_BIT 11U

#define OBJECTS_INDEX_MASK      (Objects_Id)0x00ffU
#define OBJECTS_API_MASK        (Objects_Id)0x0700U
#define OBJECTS_CLASS_MASK      (Objects_Id)0xF800U

#define OBJECTS_INDEX_VALID_BITS  (Objects_Id)0x00ffU
#define OBJECTS_API_VALID_BITS    (Objects_Id)0x0007U
/* OBJECTS_NODE_VALID_BITS should not be used with 16 bit Ids */
#define OBJECTS_CLASS_VALID_BITS  (Objects_Id)0x001fU

#define OBJECTS_UNLIMITED_OBJECTS 0x8000U

#define OBJECTS_ID_INITIAL_INDEX  (0)
#define OBJECTS_ID_FINAL_INDEX    (0xff)

#else

typedef uint32_t   Objects_Id;

typedef uint16_t   Objects_Maximum;

#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)
#endif

typedef enum {
  OBJECTS_NO_API       = 0,
  OBJECTS_INTERNAL_API = 1,
  OBJECTS_CLASSIC_API  = 2,
  OBJECTS_POSIX_API    = 3
} Objects_APIs;

#define OBJECTS_APIS_LAST OBJECTS_POSIX_API

typedef enum {
  OBJECTS_INTERNAL_NO_CLASS =  0,
  OBJECTS_INTERNAL_THREADS  =  1,
  OBJECTS_INTERNAL_MUTEXES  =  2
} Objects_Internal_API;

#define OBJECTS_INTERNAL_CLASSES_LAST OBJECTS_INTERNAL_MUTEXES

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_RTEMS_BARRIERS       = 10
} Objects_Classic_API;

#define OBJECTS_RTEMS_CLASSES_LAST OBJECTS_RTEMS_BARRIERS

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_TIMERS              = 9,
  OBJECTS_POSIX_BARRIERS            = 10,
  OBJECTS_POSIX_SPINLOCKS           = 11,
  OBJECTS_POSIX_RWLOCKS             = 12
} Objects_POSIX_API;

#define OBJECTS_POSIX_CLASSES_LAST OBJECTS_POSIX_RWLOCKS

typedef enum {
#if defined(RTEMS_MULTIPROCESSING)
  OBJECTS_REMOTE = 2,         /* object is remote */
#endif
  OBJECTS_LOCAL  = 0,         /* object is local */
  OBJECTS_ERROR  = 1          /* id was invalid */
} Objects_Locations;

typedef void ( *Objects_Thread_queue_Extract_callout )( void * );

typedef struct {
  Chain_Node     Node;
  Objects_Id     id;
  Objects_Name   name;
} Objects_Control;

typedef struct {
  Objects_APIs      the_api;
  uint16_t          the_class;
  Objects_Id        minimum_id;
  Objects_Id        maximum_id;
  Objects_Maximum   maximum;
  bool              auto_extend;
  Objects_Maximum   allocation_size;
  size_t            size;
  Objects_Control **local_table;
  Chain_Control     Inactive;
  Objects_Maximum   inactive;
  uint32_t         *inactive_per_block;
  void            **object_blocks;
  #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)

    bool              is_string;
  #endif

  uint16_t          name_length;
  Objects_Thread_queue_Extract_callout extract;
  #if defined(RTEMS_MULTIPROCESSING)

    Chain_Control    *global_table;
  #endif
}   Objects_Information;

#if defined(RTEMS_MULTIPROCESSING)
SCORE_EXTERN uint16_t       _Objects_Local_node;
#else
#define _Objects_Local_node ((uint16_t)1)
#endif

#if defined(RTEMS_MULTIPROCESSING)
SCORE_EXTERN uint16_t    _Objects_Maximum_nodes;
#else
#define _Objects_Maximum_nodes 1
#endif

SCORE_EXTERN Objects_Information
    **_Objects_Information_table[OBJECTS_APIS_LAST + 1];

#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)

void _Objects_Extend_information(
  Objects_Information *information
);

void _Objects_Shrink_information(
  Objects_Information *information
);

void _Objects_Initialize_information (
  Objects_Information *information,
  Objects_APIs         the_api,
  uint16_t             the_class,
  uint32_t             maximum,
  uint16_t             size,
  bool                 is_string,
  uint32_t             maximum_name_length
#if defined(RTEMS_MULTIPROCESSING)
  ,
  bool                 supports_global,
  Objects_Thread_queue_Extract_callout extract
#endif
);

unsigned int _Objects_API_maximum_class(
  uint32_t api
);

Objects_Control *_Objects_Allocate(
  Objects_Information *information
);

void _Objects_Free(
  Objects_Information *information,
  Objects_Control     *the_object
);

#define  _Objects_Build_name( _C1, _C2, _C3, _C4 ) \
  ( (uint32_t)(_C1) << 24 | \
    (uint32_t)(_C2) << 16 | \
    (uint32_t)(_C3) << 8 | \
    (uint32_t)(_C4) )

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

#define OBJECTS_NAME_ERRORS_FIRST OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL

#define OBJECTS_NAME_ERRORS_LAST  OBJECTS_INVALID_NODE

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

#if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)

Objects_Name_or_id_lookup_errors _Objects_Name_to_id_string(
  Objects_Information *information,
  const char          *name,
  Objects_Id          *id
);
#endif

Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
  Objects_Id      id,
  Objects_Name   *name
);

Objects_Control *_Objects_Get (
  Objects_Information *information,
  Objects_Id           id,
  Objects_Locations   *location
);

Objects_Control *_Objects_Get_isr_disable(
  Objects_Information *information,
  Objects_Id           id,
  Objects_Locations   *location,
  ISR_Level           *level
);

Objects_Control *_Objects_Get_no_protection(
  Objects_Information *information,
  Objects_Id           id,
  Objects_Locations   *location
);

Objects_Control *_Objects_Get_next(
    Objects_Information *information,
    Objects_Id           id,
    Objects_Locations   *location_p,
    Objects_Id          *next_id_p
);

Objects_Information *_Objects_Get_information(
  Objects_APIs   the_api,
  uint16_t       the_class
);

Objects_Information *_Objects_Get_information_id(
  Objects_Id  id
);

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

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

void _Objects_Namespace_remove(
  Objects_Information  *information,
  Objects_Control      *the_object
);

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

Objects_Maximum _Objects_Active_count(
  const Objects_Information *information
);

/*
 *  Pieces of object.inl are promoted out to the user
 */

#include <rtems/score/object.inl>
#if defined(RTEMS_MULTIPROCESSING)
#include <rtems/score/objectmp.h>
#endif

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */