rtl-indirect-ptr.h

Go to the documentation of this file.

/*
 *  COPYRIGHT (c) 2012, 2018 Chris Johns <chrisj@rtems.org>
 *
 *  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.
 */
#if !defined (_RTEMS_RTL_INDIRECT_PTR_H_)
#define _RTEMS_RTL_INDIRECT_PTR_H_

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#include <rtems/chain.h>

struct rtems_rtl_ptr {
  rtems_chain_node node;     
  void*            pointer;  
};

typedef struct rtems_rtl_ptr rtems_rtl_ptr;

struct rtems_rtl_sptr {
  rtems_rtl_ptr  ptr;      
  size_t         size;     
};

typedef struct rtems_rtl_sptr rtems_rtl_sptr;

struct rtems_rtl_ptr_chain {
  rtems_chain_node node;  
  rtems_rtl_ptr    ptr;   
};

typedef struct rtems_rtl_ptr_chain rtems_rtl_ptr_chain;

struct rtems_rtl_sptr_chain {
  rtems_chain_node node; 
  rtems_rtl_sptr   ptr;  
};

typedef struct rtems_rtl_sptr_chain rtems_rtl_sptr_chain;

static inline void* rtems_rtl_ptr_get (rtems_rtl_ptr* handle)
{
  return handle->pointer;
}

static inline void rtems_rtl_ptr_set (rtems_rtl_ptr* handle, void* pointer)
{
  handle->pointer = pointer;
}

static inline void rtems_rtl_ptr_init (rtems_rtl_ptr* handle)
{
  rtems_chain_set_off_chain (&handle->node);
  handle->pointer = NULL;
}

static inline bool rtems_rtl_ptr_null (rtems_rtl_ptr* handle)
{
  return handle->pointer == NULL;
}

static inline void rtems_rtl_ptr_move (rtems_rtl_ptr* dst, rtems_rtl_ptr* src)
{
  /*
   * We do not know which chain the src handle resides on so insert the dst
   * handle after the src handle then extract the src handle.
   */
  rtems_chain_insert_unprotected (&src->node, &dst->node);
  rtems_chain_extract_unprotected (&src->node);
  dst->pointer = src->pointer;
  rtems_rtl_ptr_init (src);
}

#define rtems_rtl_ptr_type_get(_h, _t) ((_t*) rtems_rtl_ptr_get (_h))

static inline void* rtems_rtl_sptr_get (rtems_rtl_sptr* handle)
{
  return rtems_rtl_ptr_get (&handle->ptr);
}

static inline void rtems_rtl_sptr_set (rtems_rtl_sptr* handle, void* pointer)
{
  rtems_rtl_ptr_set (&handle->ptr, pointer);
}

static inline void rtems_rtl_sptr_init (rtems_rtl_sptr* handle)
{
  rtems_rtl_ptr_init (&handle->ptr);
  handle->size = 0;
}

static inline bool rtems_rtl_sptr_null (rtems_rtl_sptr* handle)
{
  return rtems_rtl_ptr_null (&handle->ptr);
}

static inline void rtems_rtl_sptr_move (rtems_rtl_sptr* dst, rtems_rtl_sptr* src)
{
  rtems_rtl_ptr_move (&dst->ptr, &src->ptr);
  dst->size = src->size;
  src->size = 0;
}

static inline size_t rtems_rtl_sptr_get_size (rtems_rtl_sptr* handle)
{
  return handle->size;
}

static inline void rtems_rtl_sptr_set_size (rtems_rtl_sptr* handle, size_t size)
{
  handle->size = size;
}

#define rtems_rtl_sptr_type_get(_h, _t) ((_t*) rtems_rtl_sptr_get (_h))

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif