objectdata.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  COPYRIGHT (c) 1989-2011.
 *  On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#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_by_id() */
  OBJECTS_INTERNAL_THREADS = 1
} Objects_Internal_API;
 
typedef enum {
  OBJECTS_CLASSIC_NO_CLASS = 0,
 
  /* Must be one, see _Thread_Get_objects_information_by_id() */
  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_by_id() */
  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 RTEMS_SECTION( ".noinit.rtems.content.objects." #name ) \
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 */