basedefs.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */

 
/*
 * Copyright (C) 2014 Pavel Pisa
 * Copyright (C) 2011, 2013 On-Line Applications Research Corporation (OAR)
 * Copyright (C) 2009, 2023 embedded brains GmbH & Co. KG
 *
 * 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.
 */
 
/*
 * This file is part of the RTEMS quality process and was automatically
 * generated.  If you find something that needs to be fixed or
 * worded better please post a report or patch to an RTEMS mailing list
 * or raise a bug report:
 *
 * https://www.rtems.org/bugs.html
 *
 * For information on updating and regenerating please refer to the How-To
 * section in the Software Requirements Engineering chapter of the
 * RTEMS Software Engineering manual.  The manual is provided as a part of
 * a release.  For development sources please refer to the online
 * documentation at:
 *
 * https://docs.rtems.org
 */
 
/* Generated from spec:/rtems/basedefs/if/header */
 
#ifndef _RTEMS_SCORE_BASEDEFS_H
#define _RTEMS_SCORE_BASEDEFS_H
 
#include <rtems/score/cpuopts.h>
 
#if !defined(ASM)
  #include <stdbool.h>
  #include <stddef.h>
  #include <stdint.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Generated from spec:/if/group */

 
/* Generated from spec:/rtems/basedefs/if/group */

 
/* Generated from spec:/rtems/basedefs/if/alias */

#if defined(__GNUC__)
  #define RTEMS_ALIAS( _target ) __attribute__(( __alias__( #_target ) ))
#else
  #define RTEMS_ALIAS( _target )
#endif
 
/* Generated from spec:/rtems/basedefs/if/align-down */

#define RTEMS_ALIGN_DOWN( _value, _alignment ) \
  ( ( _value ) & ~( ( _alignment ) - 1 ) )
 
/* Generated from spec:/rtems/basedefs/if/align-up */

#define RTEMS_ALIGN_UP( _value, _alignment ) \
  ( ( ( _value ) + ( _alignment ) - 1 ) & ~( ( _alignment ) - 1 ) )
 
/* Generated from spec:/rtems/basedefs/if/aligned */

#if defined(__GNUC__)
  #define RTEMS_ALIGNED( _alignment ) __attribute__(( __aligned__( _alignment ) ))
#else
  #define RTEMS_ALIGNED( _alignment )
#endif
 
/* Generated from spec:/rtems/basedefs/if/alignof */

#if defined( __cplusplus ) && __cplusplus >= 201103L
  #define RTEMS_ALIGNOF( _type_name ) alignof( _type_name )
#elif defined( __STDC_VERSION__ ) && __STDC_VERSION__ >= 201112L
  #define RTEMS_ALIGNOF( _type_name ) _Alignof( _type_name )
#else
  #define RTEMS_ALIGNOF( _type_name ) sizeof( _type_name )
#endif
 
/* Generated from spec:/rtems/basedefs/if/alloc-align */

#if defined(__GNUC__)
  #define RTEMS_ALLOC_ALIGN( _index ) __attribute__(( __alloc_align__( _index ) ))
#else
  #define RTEMS_ALLOC_ALIGN( _index )
#endif
 
/* Generated from spec:/rtems/basedefs/if/alloc-size */

#if defined(__GNUC__)
  #define RTEMS_ALLOC_SIZE( _index ) __attribute__(( __alloc_size__( _index ) ))
#else
  #define RTEMS_ALLOC_SIZE( _index )
#endif
 
/* Generated from spec:/rtems/basedefs/if/alloc-size-2 */

#if defined(__GNUC__)
  #define RTEMS_ALLOC_SIZE_2( _count_index, _size_index ) \
    __attribute__(( __alloc_size__( _count_index, _size_index ) ))
#else
  #define RTEMS_ALLOC_SIZE_2( _count_index, _size_index )
#endif
 
/* Generated from spec:/rtems/basedefs/if/array-size */

#define RTEMS_ARRAY_SIZE( _array ) \
  ( sizeof( _array ) / sizeof( ( _array )[ 0 ] ) )
 
/* Generated from spec:/rtems/basedefs/if/compiler-memory-barrier */

#if defined(__GNUC__)
  #define RTEMS_COMPILER_MEMORY_BARRIER() __asm__ volatile( "" ::: "memory" )
#else
  #define RTEMS_COMPILER_MEMORY_BARRIER() do { } while ( 0 )
#endif
 
/* Generated from spec:/rtems/basedefs/if/concat */

#define RTEMS_CONCAT( _x, _y ) _x##_y
 
/* Generated from spec:/rtems/basedefs/if/const */

#if defined(__GNUC__)
  #define RTEMS_CONST __attribute__(( __const__ ))
#else
  #define RTEMS_CONST
#endif
 
/* Generated from spec:/rtems/basedefs/if/container-of */

#define RTEMS_CONTAINER_OF( _m, _type, _member_name ) \
  ( (_type *) ( (uintptr_t) ( _m ) - offsetof( _type, _member_name ) ) )
 
/* Generated from spec:/rtems/basedefs/if/declare-global-symbol */

#define RTEMS_DECLARE_GLOBAL_SYMBOL( _name ) extern char _name[]
 
/* Generated from spec:/rtems/basedefs/if/deprecated */

#if defined(__GNUC__)
  #define RTEMS_DEPRECATED __attribute__(( __deprecated__ ))
#else
  #define RTEMS_DEPRECATED
#endif
 
/* Generated from spec:/rtems/basedefs/if/compiler-deprecated-attribute */

#define RTEMS_COMPILER_DEPRECATED_ATTRIBUTE RTEMS_DEPRECATED
 
/* Generated from spec:/rtems/basedefs/if/expand */

#define RTEMS_EXPAND( _token ) _token
 
/* Generated from spec:/rtems/basedefs/if/function-name */

#if defined(__cplusplus) && defined(__GNUC__)
  #define RTEMS_FUNCTION_NAME __PRETTY_FUNCTION__
#else
  #define RTEMS_FUNCTION_NAME __func__
#endif
 
/* Generated from spec:/rtems/basedefs/if/no-return */

#if defined( __cplusplus ) && __cplusplus >= 201103L
  #define RTEMS_NO_RETURN [[noreturn]]
#elif defined( __STDC_VERSION__ ) && __STDC_VERSION__ >= 201112L
  #define RTEMS_NO_RETURN _Noreturn
#elif defined(__GNUC__)
  #define RTEMS_NO_RETURN __attribute__(( __noreturn__ ))
#else
  #define RTEMS_NO_RETURN
#endif
 
/* Generated from spec:/rtems/basedefs/if/compiler-no-return-attribute */

#define RTEMS_COMPILER_NO_RETURN_ATTRIBUTE RTEMS_NO_RETURN
 
/* Generated from spec:/rtems/basedefs/if/section */

#if defined(__GNUC__)
  #define RTEMS_SECTION( _section ) __attribute__(( __section__( _section ) ))
#else
  #define RTEMS_SECTION( _section )
#endif
 
/* Generated from spec:/rtems/basedefs/if/string */

#define RTEMS_STRING( ... ) #__VA_ARGS__
 
/* Generated from spec:/rtems/basedefs/if/typeof-refx */

#if defined(__GNUC__)
  #define RTEMS_TYPEOF_REFX( _level, _target ) \
    __typeof__( _level( union { int _z; __typeof__( _target ) _x; } ){ 0 }._x )
#else
  #define RTEMS_TYPEOF_REFX( _level, _target )
#endif
 
/* Generated from spec:/rtems/basedefs/if/xconcat */

#define RTEMS_XCONCAT( _x, _y ) RTEMS_CONCAT( _x, _y )
 
#if !defined(ASM) && defined(RTEMS_DEBUG)
  /* Generated from spec:/score/basedefs/if/debug-unreachable */

  RTEMS_NO_RETURN void _Debug_Unreachable(
    const char *file,
    int         line,
    const char *func
  );
#endif
 
#if !defined(ASM)
  /* Generated from spec:/score/basedefs/if/dequalify-types-not-compatible */

  #if defined(__GNUC__)
    __attribute__((__error__("RTEMS_DEQUALIFY() types differ not only by volatile and const"))) void *
    RTEMS_DEQUALIFY_types_not_compatible( void );
  #else
    void *RTEMS_DEQUALIFY_types_not_compatible( void );
  #endif
#endif
 
/* Generated from spec:/rtems/basedefs/if/dequalify-depthx */

#if defined(__cplusplus)
  #define RTEMS_DEQUALIFY_DEPTHX( _ptr_level, _type, _var ) \
    ( const_cast<_type>( _var ) )
#elif defined(__GNUC__)
  #define RTEMS_DEQUALIFY_DEPTHX( _ptr_level, _type, _var ) \
    __builtin_choose_expr( \
      __builtin_types_compatible_p( \
        RTEMS_TYPEOF_REFX( _ptr_level, _var ), \
        RTEMS_TYPEOF_REFX( _ptr_level, _type ) \
      ) || \
      __builtin_types_compatible_p( \
        _type, \
        void * \
      ), \
      (_type) ( _var ), \
      RTEMS_DEQUALIFY_types_not_compatible() \
    )
#else
  #define RTEMS_DEQUALIFY_DEPTHX( _ptr_level, _type, _var ) \
    ( (_type) (uintptr_t) (const volatile void *)( _var ) )
#endif
 
/* Generated from spec:/rtems/basedefs/if/deconst */

#define RTEMS_DECONST( _type, _var ) RTEMS_DEQUALIFY_DEPTHX( *, _type, _var )
 
/* Generated from spec:/rtems/basedefs/if/dequalify */

#define RTEMS_DEQUALIFY( _type, _var ) RTEMS_DEQUALIFY_DEPTHX( *, _type, _var )
 
/* Generated from spec:/rtems/basedefs/if/devolatile */

#define RTEMS_DEVOLATILE( _type, _var ) RTEMS_DEQUALIFY_DEPTHX( *, _type, _var )
 
#if !defined(FALSE)
  /* Generated from spec:/rtems/basedefs/if/false */

  #define FALSE 0
#endif
 
/* Generated from spec:/rtems/basedefs/if/have-member-same-type */

#if defined(__GNUC__)
  #define RTEMS_HAVE_MEMBER_SAME_TYPE( _t_lhs, _m_lhs, _t_rhs, _m_rhs ) \
    __builtin_types_compatible_p( \
      __typeof__( ( (_t_lhs *) 0 )->_m_lhs ), \
      __typeof__( ( (_t_rhs *) 0 )->_m_rhs ) \
    )
#else
  #define RTEMS_HAVE_MEMBER_SAME_TYPE( _t_lhs, _m_lhs, _t_rhs, _m_rhs ) true
#endif
 
/* Generated from spec:/rtems/basedefs/if/inline-routine */

#if defined(__GNUC__)
  #define RTEMS_INLINE_ROUTINE static __inline__
#else
  #define RTEMS_INLINE_ROUTINE static inline
#endif
 
/* Generated from spec:/rtems/basedefs/if/malloclike */

#if defined(__GNUC__)
  #define RTEMS_MALLOCLIKE __attribute__(( __malloc__ ))
#else
  #define RTEMS_MALLOCLIKE
#endif
 
/* Generated from spec:/rtems/basedefs/if/no-inline */

#if defined(__GNUC__)
  #define RTEMS_NO_INLINE __attribute__(( __noinline__ ))
#else
  #define RTEMS_NO_INLINE
#endif
 
/* Generated from spec:/rtems/basedefs/if/noinit */

#define RTEMS_NOINIT RTEMS_SECTION( ".noinit" )
 
/* Generated from spec:/rtems/basedefs/if/obfuscate-variable */

#if defined(__GNUC__)
  #define RTEMS_OBFUSCATE_VARIABLE( _var ) __asm__( "" : "+r" ( _var ) )
#else
  #define RTEMS_OBFUSCATE_VARIABLE( _var ) (void) ( _var )
#endif
 
/* Generated from spec:/rtems/basedefs/if/packed */

#if defined(__GNUC__)
  #define RTEMS_PACKED __attribute__(( __packed__ ))
#else
  #define RTEMS_PACKED
#endif
 
/* Generated from spec:/rtems/basedefs/if/compiler-packed-attribute */

#define RTEMS_COMPILER_PACKED_ATTRIBUTE RTEMS_PACKED
 
/* Generated from spec:/rtems/basedefs/if/predict-false */

#if defined(__GNUC__)
  #define RTEMS_PREDICT_FALSE( _exp ) __builtin_expect( ( _exp ), 0 )
#else
  #define RTEMS_PREDICT_FALSE( _exp ) ( _exp )
#endif
 
/* Generated from spec:/rtems/basedefs/if/predict-true */

#if defined(__GNUC__)
  #define RTEMS_PREDICT_TRUE( _exp ) __builtin_expect( ( _exp ), 1 )
#else
  #define RTEMS_PREDICT_TRUE( _exp ) ( _exp )
#endif
 
/* Generated from spec:/rtems/basedefs/if/printflike */

#if defined(__GNUC__)
  #define RTEMS_PRINTFLIKE( _format_pos, _ap_pos ) \
    __attribute__(( __format__( __printf__, _format_pos, _ap_pos ) ))
#else
  #define RTEMS_PRINTFLIKE( _format_pos, _ap_pos )
#endif
 
/* Generated from spec:/rtems/basedefs/if/pure */

#if defined(__GNUC__)
  #define RTEMS_PURE __attribute__(( __pure__ ))
#else
  #define RTEMS_PURE
#endif
 
/* Generated from spec:/rtems/basedefs/if/compiler-pure-attribute */

#define RTEMS_COMPILER_PURE_ATTRIBUTE RTEMS_PURE
 
/* Generated from spec:/rtems/basedefs/if/return-address */

#if defined(__GNUC__)
  #define RTEMS_RETURN_ADDRESS() __builtin_return_address( 0 )
#else
  #define RTEMS_RETURN_ADDRESS() NULL
#endif
 
/* Generated from spec:/rtems/basedefs/if/static-analysis */

#if defined(__COVERITY__)
  #define RTEMS_STATIC_ANALYSIS
#endif
 
/* Generated from spec:/rtems/basedefs/if/static-assert */

#if defined( __cplusplus ) && __cplusplus >= 201103L
  #define RTEMS_STATIC_ASSERT( _cond, _msg ) static_assert( _cond, # _msg )
#elif defined( __STDC_VERSION__ ) && __STDC_VERSION__ >= 201112L
  #define RTEMS_STATIC_ASSERT( _cond, _msg ) _Static_assert( _cond, # _msg )
#else
  #define RTEMS_STATIC_ASSERT( _cond, _msg ) \
    struct rtems_static_assert_ ## _msg \
      { int rtems_static_assert_ ## _msg : ( _cond ) ? 1 : -1; }
#endif
 
/* Generated from spec:/rtems/basedefs/if/symbol-name */

#if defined(__USER_LABEL_PREFIX__)
  #define RTEMS_SYMBOL_NAME( _name ) RTEMS_XCONCAT( __USER_LABEL_PREFIX__, _name )
#else
  #define RTEMS_SYMBOL_NAME( _name ) RTEMS_EXPAND( _name )
#endif
 
#if !defined(TRUE)
  /* Generated from spec:/rtems/basedefs/if/true */

  #define TRUE 1
#endif
 
/* Generated from spec:/rtems/basedefs/if/unreachable */

#if defined(RTEMS_DEBUG)
  #define RTEMS_UNREACHABLE() \
    _Debug_Unreachable( __FILE__, __LINE__, RTEMS_FUNCTION_NAME )
#elif defined(__GNUC__)
  #define RTEMS_UNREACHABLE() __builtin_unreachable()
#else
  #define RTEMS_UNREACHABLE() do { } while ( 0 )
#endif
 
/* Generated from spec:/rtems/basedefs/if/unused */

#if defined(__GNUC__)
  #define RTEMS_UNUSED __attribute__(( __unused__ ))
#else
  #define RTEMS_UNUSED
#endif
 
/* Generated from spec:/rtems/basedefs/if/compiler-unused-attribute */

#define RTEMS_COMPILER_UNUSED_ATTRIBUTE RTEMS_UNUSED
 
/* Generated from spec:/rtems/basedefs/if/used */

#if defined(__GNUC__)
  #define RTEMS_USED __attribute__(( __used__ ))
#else
  #define RTEMS_USED
#endif
 
/* Generated from spec:/rtems/basedefs/if/warn-unused-result */

#if defined(__GNUC__)
  #define RTEMS_WARN_UNUSED_RESULT __attribute__(( __warn_unused_result__ ))
#else
  #define RTEMS_WARN_UNUSED_RESULT
#endif
 
/* Generated from spec:/rtems/basedefs/if/weak */

#if defined(__GNUC__)
  #define RTEMS_WEAK __attribute__(( __weak__ ))
#else
  #define RTEMS_WEAK
#endif
 
/* Generated from spec:/rtems/basedefs/if/weak-alias */

#if defined(__GNUC__)
  #define RTEMS_WEAK_ALIAS( _target ) \
    __attribute__(( __weak__, __alias__( #_target ) ))
#else
  #define RTEMS_WEAK_ALIAS( _target )
#endif
 
/* Generated from spec:/rtems/basedefs/if/xstring */

#define RTEMS_XSTRING( ... ) RTEMS_STRING( __VA_ARGS__ )
 
/* Generated from spec:/rtems/basedefs/if/define-global-symbol */

#if defined(__GNUC__)
  #define RTEMS_DEFINE_GLOBAL_SYMBOL( _name, _value ) \
    __asm__( \
      "\t.globl " RTEMS_XSTRING( RTEMS_SYMBOL_NAME( _name ) ) \
      "\n\t.set " RTEMS_XSTRING( RTEMS_SYMBOL_NAME( _name ) ) \
      ", " RTEMS_STRING( _value ) "\n" \
    )
#else
  #define RTEMS_DEFINE_GLOBAL_SYMBOL( _name, _value )
#endif
 
/* Generated from spec:/rtems/basedefs/if/zero-length-array */

#if __STDC_VERSION__ >= 199409L
  #define RTEMS_ZERO_LENGTH_ARRAY
#else
  #define RTEMS_ZERO_LENGTH_ARRAY 0
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif /* _RTEMS_SCORE_BASEDEFS_H */