objectdata.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.org/license/LICENSE.
 */

#ifndef _RTEMS_SCORE_OBJECTDATA_H
#define _RTEMS_SCORE_OBJECTDATA_H

#include <rtems/score/object.h>
#include <rtems/score/chainimpl.h>
#include <rtems/score/rbtree.h>

#ifdef __cplusplus
extern "C" {
#endif

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

typedef enum {
  OBJECTS_INTERNAL_NO_CLASS = 0,

  /* Must be one, see __Thread_Get_objects_information() */
  OBJECTS_INTERNAL_THREADS = 1
} Objects_Internal_API;

typedef enum {
  OBJECTS_CLASSIC_NO_CLASS = 0,

  /* Must be one, see __Thread_Get_objects_information() */
  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
} Objects_Classic_API;

typedef enum {
  OBJECTS_POSIX_NO_CLASS = 0,

  /* Must be one, see __Thread_Get_objects_information() */
  OBJECTS_POSIX_THREADS = 1,

  OBJECTS_POSIX_KEYS,
  OBJECTS_POSIX_MESSAGE_QUEUES,
  OBJECTS_POSIX_SEMAPHORES,
  OBJECTS_POSIX_TIMERS,
  OBJECTS_POSIX_SHMS
} Objects_POSIX_API;

#define OBJECTS_NO_STRING_NAME 0

#if defined( RTEMS_MULTIPROCESSING )
struct _Thread_Control;

typedef struct {
  union {
    Chain_Node Inactive;

    struct {
      RBTree_Node Id_lookup;

      RBTree_Node Name_lookup;
    } Active;
  } Nodes;

  Objects_Id id;

  uint32_t name;
} Objects_MP_Control;

extern Objects_MP_Control _Objects_MP_Controls[];

typedef void ( *Objects_Thread_queue_Extract_callout )(
  struct _Thread_Control *,
  Objects_Id
);
#endif

typedef struct Objects_Information Objects_Information;

struct Objects_Information {
  Objects_Id maximum_id;

  Objects_Control **local_table;

  Objects_Control *( *allocate )( Objects_Information * );

  void ( *deallocate )( Objects_Information *, Objects_Control * );

  Objects_Maximum inactive;

  Objects_Maximum objects_per_block;

  uint16_t object_size;

  uint16_t name_length;

  Chain_Control Inactive;

  Objects_Maximum *inactive_per_block;

  Objects_Control **object_blocks;

  Objects_Control *initial_objects;

#if defined(RTEMS_MULTIPROCESSING)

  Objects_Thread_queue_Extract_callout extract;

  RBTree_Control Global_by_id;

  RBTree_Control Global_by_name;
#endif
};

Objects_Control *_Objects_Allocate_none( Objects_Information *information );

Objects_Control *_Objects_Allocate_static( Objects_Information *information );

Objects_Control *_Objects_Allocate_unlimited( Objects_Information *information );

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

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

#if defined(RTEMS_MULTIPROCESSING)
#define OBJECTS_INFORMATION_MP( name, extract ) \
  , \
  extract, \
  RBTREE_INITIALIZER_EMPTY( name.Global_by_id ), \
  RBTREE_INITIALIZER_EMPTY( name.Global_by_name )
#else
#define OBJECTS_INFORMATION_MP( name, extract )
#endif

#define OBJECTS_INFORMATION_DEFINE_ZERO( name, api, cls, nl ) \
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 ) \
}

#define OBJECTS_INFORMATION_DEFINE( name, api, cls, type, max, nl, ex ) \
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 ) \
}

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */