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

#ifndef _RTEMS_SCORE_OBJECT_H
#define _RTEMS_SCORE_OBJECT_H

#include <rtems/score/basedefs.h>
#include <rtems/score/cpu.h>
#include <rtems/score/chain.h>

#ifdef __cplusplus
extern "C" {
#endif

#if defined(RTEMS_POSIX_API)

  #define RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES
#endif

typedef union {
  #if defined(RTEMS_SCORE_OBJECT_ENABLE_STRING_NAMES)

    const char *name_p;
  #endif

  uint32_t    name_u32;
} Objects_Name;

#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_FAKE_OBJECTS_API = 7
} Objects_APIs;

#define OBJECTS_APIS_LAST OBJECTS_POSIX_API

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

#if defined( RTEMS_MULTIPROCESSING )

typedef struct {
  Objects_Control Object;
  uint32_t        name;
}   Objects_MP_Control;
#endif

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

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

RTEMS_INLINE_ROUTINE Objects_APIs _Objects_Get_API(
  Objects_Id id
)
{
  return (Objects_APIs) ((id >> OBJECTS_API_START_BIT) & OBJECTS_API_VALID_BITS);
}

RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_class(
  Objects_Id id
)
{
  return (uint32_t)
    ((id >> OBJECTS_CLASS_START_BIT) & OBJECTS_CLASS_VALID_BITS);
}

RTEMS_INLINE_ROUTINE uint32_t _Objects_Get_node(
  Objects_Id id
)
{
  /*
   * If using 16-bit Ids, then there is no node field and it MUST
   * be a single processor system.
   */
  #if defined(RTEMS_USE_16_BIT_OBJECT)
    return 1;
  #else
    return (id >> OBJECTS_NODE_START_BIT) & OBJECTS_NODE_VALID_BITS;
  #endif
}

RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Get_index(
  Objects_Id id
)
{
  return
    (Objects_Maximum)((id >> OBJECTS_INDEX_START_BIT) &
                                          OBJECTS_INDEX_VALID_BITS);
}

RTEMS_INLINE_ROUTINE Objects_Id _Objects_Build_id(
  Objects_APIs     the_api,
  uint16_t         the_class,
  uint8_t          node,
  uint16_t         index
)
{
  return (( (Objects_Id) the_api )   << OBJECTS_API_START_BIT)   |
         (( (Objects_Id) the_class ) << OBJECTS_CLASS_START_BIT) |
         #if !defined(RTEMS_USE_16_BIT_OBJECT)
           (( (Objects_Id) node )    << OBJECTS_NODE_START_BIT)  |
         #endif
         (( (Objects_Id) index )     << OBJECTS_INDEX_START_BIT);
}

RTEMS_INLINE_ROUTINE bool _Objects_Is_unlimited( uint32_t maximum )
{
  return (maximum & OBJECTS_UNLIMITED_OBJECTS) != 0;
}

/*
 * We cannot use an inline function for this since it may be evaluated at
 * compile time.
 */
#define _Objects_Maximum_per_allocation( maximum ) \
  ((Objects_Maximum) ((maximum) & ~OBJECTS_UNLIMITED_OBJECTS))

#ifdef __cplusplus
}
#endif

#endif
/* end of include file */