objectimpl.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_OBJECTIMPL_H
#define _RTEMS_SCORE_OBJECTIMPL_H
 
#include <rtems/score/objectdata.h>
#include <rtems/score/apimutex.h>
#include <rtems/score/assert.h>
#include <rtems/score/isrlock.h>
#include <rtems/score/status.h>
#include <rtems/score/sysstate.h>
#include <rtems/score/threaddispatch.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef bool    (*Objects_Name_comparators)(
  void       * /* name_1 */,
  void       * /* name_2 */,
  uint16_t     /* length */
);
 
#define OBJECTS_INTERNAL_CLASSES_LAST OBJECTS_INTERNAL_THREADS
 
#define OBJECTS_RTEMS_CLASSES_LAST OBJECTS_RTEMS_BARRIERS
 
#define OBJECTS_POSIX_CLASSES_LAST OBJECTS_POSIX_SHMS
 
/*
 * For fake objects, which have an object identifier, but no objects
 * information block.
 */
typedef enum {
  OBJECTS_FAKE_OBJECTS_NO_CLASS   = 0,
  OBJECTS_FAKE_OBJECTS_SCHEDULERS = 1
} Objects_Fake_objects_API;
 
#if defined(RTEMS_MULTIPROCESSING)
extern uint16_t _Objects_Maximum_nodes;
#else
#define _Objects_Maximum_nodes 1
#endif
 
#define OBJECTS_INDEX_MINIMUM 1U
 
extern Objects_Information ** const
_Objects_Information_table[ OBJECTS_APIS_LAST + 1 ];
 
Objects_Maximum _Objects_Extend_information(
  Objects_Information *information
);
 
void _Objects_Free_objects_block(
  Objects_Information *information,
  Objects_Maximum      block
);
 
void _Objects_Shrink_information(
  Objects_Information *information
);
 
void _Objects_Initialize_information( Objects_Information *information );
 
unsigned int _Objects_API_maximum_class(
  uint32_t api
);
 
Objects_Control *_Objects_Allocate( Objects_Information *information );
 
Status_Control _Objects_Name_to_id_u32(
  uint32_t                   name,
  uint32_t                   node,
  Objects_Id                *id,
  const Objects_Information *information
);
 
typedef enum {
  OBJECTS_GET_BY_NAME_INVALID_NAME,
  OBJECTS_GET_BY_NAME_NAME_TOO_LONG,
  OBJECTS_GET_BY_NAME_NO_OBJECT
} Objects_Get_by_name_error;
 
Objects_Control *_Objects_Get_by_name(
  const Objects_Information *information,
  const char                *name,
  size_t                    *name_length_p,
  Objects_Get_by_name_error *error
);
 
Status_Control _Objects_Id_to_name (
  Objects_Id      id,
  Objects_Name   *name
);
 
Objects_Control *_Objects_Get(
  Objects_Id                 id,
  ISR_lock_Context          *lock_context,
  const Objects_Information *information
);
 
Objects_Control *_Objects_Get_no_protection(
  Objects_Id                 id,
  const Objects_Information *information
);
 
Objects_Control *_Objects_Get_next(
  Objects_Id                 id,
  const Objects_Information *information,
  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
);
 
static inline bool _Objects_Has_string_name(
  const Objects_Information *information
)
{
  return information->name_length > 0;
}
 
char *_Objects_Get_name_as_string(
  Objects_Id   id,
  size_t       length,
  char        *name
);
 
size_t _Objects_Name_to_string(
  Objects_Name  name,
  bool          is_string,
  char         *buffer,
  size_t        buffer_size
);
 
Status_Control _Objects_Set_name(
  const Objects_Information *information,
  Objects_Control           *the_object,
  const char                *name
);
 
static inline void _Objects_Namespace_remove_u32(
  const Objects_Information *information,
  Objects_Control           *the_object
)
{
  (void) information;
 
  _Assert( !_Objects_Has_string_name( information ) );
  the_object->name.name_u32 = 0;
}
 
void _Objects_Namespace_remove_string(
  const Objects_Information *information,
  Objects_Control           *the_object
);
 
void _Objects_Close(
  const Objects_Information *information,
  Objects_Control           *the_object
);
 
Objects_Maximum _Objects_Active_count(
  const Objects_Information *information
);
 
static inline Objects_Maximum _Objects_Extend_size(
  const Objects_Information *information
)
{
  return information->objects_per_block;
}
 
static inline bool _Objects_Is_api_valid(
  uint32_t   the_api
)
{
  return ( 1 <= the_api && the_api <= OBJECTS_APIS_LAST );
}
 
static inline bool _Objects_Is_local_node(
  uint32_t   node
)
{
  return ( node == _Objects_Local_node );
}
 
static inline bool _Objects_Is_local_id(
#if defined(RTEMS_MULTIPROCESSING)
  Objects_Id id
#else
  Objects_Id id RTEMS_UNUSED
#endif
)
{
#if defined(RTEMS_MULTIPROCESSING)
  return _Objects_Is_local_node( _Objects_Get_node(id) );
#else
  return true;
#endif
}
 
static inline bool _Objects_Are_ids_equal(
  Objects_Id left,
  Objects_Id right
)
{
  return ( left == right );
}
 
static inline Objects_Id _Objects_Get_minimum_id( Objects_Id id )
{
  id &= ~OBJECTS_INDEX_MASK;
  id += (Objects_Id) OBJECTS_INDEX_MINIMUM << OBJECTS_INDEX_START_BIT;
  return id;
}
 
static inline Objects_Maximum _Objects_Get_maximum_index(
  const Objects_Information *information
)
{
  return _Objects_Get_index( information->maximum_id );
}
 
static inline Objects_Control *_Objects_Get_inactive(
  Objects_Information *information
)
{
  return (Objects_Control *) _Chain_Get_unprotected( &information->Inactive );
}
 
static inline Objects_Maximum _Objects_Is_auto_extend(
  const Objects_Information *information
)
{
  return information->objects_per_block != 0;
}
 
static inline void _Objects_Set_local_object(
  const Objects_Information *information,
  uint32_t                   index,
  Objects_Control           *the_object
)
{
  /*
   *  This routine is ONLY to be called from places in the code
   *  where the Id is known to be good.  Therefore, this should NOT
   *  occur in normal situations.
   */
  _Assert( index >= OBJECTS_INDEX_MINIMUM );
  _Assert( index <= _Objects_Get_maximum_index( information ) );
 
  information->local_table[ index - OBJECTS_INDEX_MINIMUM ] = the_object;
}
 
static inline void _Objects_Invalidate_Id(
  const Objects_Information *information,
  Objects_Control           *the_object
)
{
  _Assert( information != NULL );
  _Assert( the_object != NULL );
 
  _Objects_Set_local_object(
    information,
    _Objects_Get_index( the_object->id ),
    NULL
  );
}
 
static inline Objects_Id _Objects_Open_u32(
  const Objects_Information *information,
  Objects_Control           *the_object,
  uint32_t                   name
)
{
  _Assert( information != NULL );
  _Assert( !_Objects_Has_string_name( information ) );
  _Assert( the_object != NULL );
 
  the_object->name.name_u32 = name;
 
  _Objects_Set_local_object(
    information,
    _Objects_Get_index( the_object->id ),
    the_object
  );
 
  return the_object->id;
}
 
static inline void _Objects_Open_string(
  const Objects_Information *information,
  Objects_Control           *the_object,
  const char                *name
)
{
  _Assert( information != NULL );
  _Assert( _Objects_Has_string_name( information ) );
  _Assert( the_object != NULL );
 
  the_object->name.name_p = name;
 
  _Objects_Set_local_object(
    information,
    _Objects_Get_index( the_object->id ),
    the_object
  );
}
 
static inline void _Objects_Allocator_lock( void )
{
  _RTEMS_Lock_allocator();
}
 
static inline void _Objects_Allocator_unlock( void )
{
  _RTEMS_Unlock_allocator();
}
 
static inline bool _Objects_Allocator_is_owner( void )
{
  return _RTEMS_Allocator_is_owner();
}
 
static inline Objects_Control *_Objects_Allocate_unprotected(
  Objects_Information *information
)
{
  _Assert(
    _Objects_Allocator_is_owner()
      || !_System_state_Is_up( _System_state_Get() )
  );
 
  return ( *information->allocate )( information );
}
 
static inline void _Objects_Free(
  Objects_Information *information,
  Objects_Control     *the_object
)
{
  _Assert( _Objects_Allocator_is_owner() );
  _Assert( information->deallocate != NULL );
  ( *information->deallocate )( information, the_object );
}
 
static inline bool _Objects_Is_in_allocated_block(
  Objects_Maximum index,
  Objects_Maximum objects_per_block
)
{
  return index >= objects_per_block;
}
 
static inline void _Objects_Activate_unlimited(
  Objects_Information *information,
  Objects_Control     *the_object
)
{
  Objects_Maximum objects_per_block;
  Objects_Maximum index;
 
  _Assert( _Objects_Is_auto_extend( information ) );
 
  objects_per_block = information->objects_per_block;
  index = _Objects_Get_index( the_object->id ) - OBJECTS_INDEX_MINIMUM;
 
  if ( _Objects_Is_in_allocated_block( index, objects_per_block ) ) {
    Objects_Maximum block;
 
    block = index / objects_per_block;
 
    information->inactive_per_block[ block ]--;
    information->inactive--;
  }
}
 
static inline Objects_Control *_Objects_Allocate_with_extend(
  Objects_Information   *information,
  void                ( *extend )( Objects_Information * )
)
{
  Objects_Control *the_object;
 
  _Assert( _Objects_Is_auto_extend( information ) );
 
  the_object = _Objects_Get_inactive( information );
 
  if ( the_object == NULL ) {
    ( *extend )( information );
    the_object = _Objects_Get_inactive( information );
  }
 
  if ( the_object != NULL ) {
    _Objects_Activate_unlimited( information, the_object );
  }
 
  return the_object;
}
 
void _Objects_Free_nothing( void *ptr );
 
#ifdef __cplusplus
}
#endif
 
#if defined(RTEMS_MULTIPROCESSING)
#include <rtems/score/objectmp.h>
#endif
 
 
#endif
/* end of include file */