architecture.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2020 Otto-von-Guericke-Universität Magdeburg
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdint.h>
#include <inttypes.h>
#include <limits.h>
 
#include "architecture_arch.h" /* IWYU pragma: export */
 
#ifdef __cplusplus
extern "C" {
#endif

#ifndef ARCHITECTURE_BREAKPOINT
/* If no breakpoint instruction is defined, busy wait for debugger
 * to attach and break to ease backtrace
 */
#define ARCHITECTURE_BREAKPOINT(value)  do {} while (1)
#endif
 
/* Provide doxygen doc centrally, instead of in every architecture_arch.h */
#ifdef DOXYGEN
#define ARCHITECTURE_WORD_BITS      <NUM>
#define ARCHITECTURE_WORD_BYTES     <ARCHITECTURE_WORD_BITS / 8>
typedef uint<NUM>_t uword_t;
typedef int<NUM>_t  sword_t;
#define SWORD_MAX   <2^(ARCHITECTURE_WORD_BITS - 1) - 1>
#define SWORD_MIN   <-2^(ARCHITECTURE_WORD_BITS - 1)>
#define UWORD_MAX   <2^ARCHITECTURE_WORD_BITS - 1>
 
/* end of ifdef DOXYGEN */
#elif (ARCHITECTURE_WORD_BITS == 8)
#  define ARCHITECTURE_WORD_BYTES   (1U)
typedef uint8_t     uword_t;
typedef int8_t      sword_t;
#  define SWORD_MAX (INT8_MAX)
#  define SWORD_MIN (INT8_MIN)
#  define UWORD_MAX (UINT8_MAX)
#  define PRIdWORD  PRId8
#  define PRIuWORD  PRIu8
#  define PRIiWORD  PRIu8
#  define PRIxWORD  PRIx8
#  define PRIoWORD  PRIo8
#elif (ARCHITECTURE_WORD_BITS == 16)
#  define ARCHITECTURE_WORD_BYTES   (2U)
typedef uint16_t    uword_t;
typedef int16_t     sword_t;
#  define SWORD_MAX (INT16_MAX)
#  define SWORD_MIN (INT16_MIN)
#  define UWORD_MAX (UINT16_MAX)
#  define PRIdWORD  PRId16
#  define PRIuWORD  PRIu16
#  define PRIiWORD  PRIu16
#  define PRIxWORD  PRIx16
#  define PRIoWORD  PRIo16
#elif (ARCHITECTURE_WORD_BITS == 32)
#  define ARCHITECTURE_WORD_BYTES   (4U)
typedef uint32_t    uword_t;
typedef int32_t     sword_t;
#  define SWORD_MAX (INT32_MAX)
#  define SWORD_MIN (INT32_MIN)
#  define UWORD_MAX (UINT32_MAX)
#  define PRIdWORD  PRId32
#  define PRIuWORD  PRIu32
#  define PRIiWORD  PRIu32
#  define PRIxWORD  PRIx32
#  define PRIoWORD  PRIo32
#elif (ARCHITECTURE_WORD_BITS == 64)
#  define ARCHITECTURE_WORD_BYTES   (8U)
typedef uint64_t    uword_t;
typedef int64_t     sword_t;
#  define SWORD_MAX (INT64_MAX)
#  define SWORD_MIN (INT64_MIN)
#  define UWORD_MAX (UINT64_MAX)
#  define PRIdWORD  PRId64
#  define PRIuWORD  PRIu64
#  define PRIiWORD  PRIu64
#  define PRIxWORD  PRIx64
#  define PRIoWORD  PRIo64
#else
#  error "Unsupported word size (check ARCHITECTURE_WORD_BITS in architecture_arch.h)"
#endif

#define UWORD_MIN   (0U)
 
#if !defined(ARCHITECTURE_LARGE_TXT_PTR) || DOXYGEN
typedef uintptr_t   uinttxtptr_t;

#define PRIxTXTPTR PRIxPTR
#endif
 
#if DOXYGEN
#define PRI_SIZE_T_MODIFIER /* implementation defined */
#elif (UINT_MAX == SIZE_MAX)
#define PRI_SIZE_T_MODIFIER ""
#elif (ULONG_MAX == SIZE_MAX)
#define PRI_SIZE_T_MODIFIER "l"
#else
#error Unsupported size_t length
#endif

#define PRIdSIZE PRI_SIZE_T_MODIFIER "d"
#define PRIiSIZE PRI_SIZE_T_MODIFIER "i"
#define PRIoSIZE PRI_SIZE_T_MODIFIER "o"
#define PRIuSIZE PRI_SIZE_T_MODIFIER "u"
#define PRIxSIZE PRI_SIZE_T_MODIFIER "x"
#define PRIXSIZE PRI_SIZE_T_MODIFIER "X"

#define WORD_ALIGNED __attribute__((aligned(ARCHITECTURE_WORD_BYTES)))

#define HAS_ALIGNMENT_OF(addr, alignment) (((uintptr_t)(addr) & ((alignment) - 1)) == 0)

#define IS_WORD_ALIGNED(addr) HAS_ALIGNMENT_OF(addr, ARCHITECTURE_WORD_BYTES)
 
#ifdef __cplusplus
}
#endif