architecture.h

Go to the documentation of this file.

/*
 * Copyright (C) 2020 Otto-von-Guericke-Universität Magdeburg
 *
 * This file is subject to the terms and conditions of the GNU Lesser General
 * Public License v2.1. See the file LICENSE in the top level directory for more
 * details.
 */
 
#ifndef ARCHITECTURE_H
#define ARCHITECTURE_H
 
#include <stdint.h>
#include <inttypes.h>
 
#include "architecture_arch.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Provide doxygen doc centrally, instead of in every architecture_arch.h */
#ifdef DOXYGEN
#define ARCHITECTURE_WORD_BITS      <NUM>
#define ARCHITECTURE_WORD_BYTES     <NUM>
typedef uint<num>_t uword_t;
typedef int<num>_t  sword_t;
#elif (ARCHITECTURE_WORD_BITS == 8)
#define ARCHITECTURE_WORD_BYTES     (1U)
typedef uint8_t     uword_t;
typedef int8_t      sword_t;
#elif (ARCHITECTURE_WORD_BITS == 16)
#define ARCHITECTURE_WORD_BYTES     (2U)
typedef uint16_t    uword_t;
typedef int16_t     sword_t;
#elif (ARCHITECTURE_WORD_BITS == 32)
#define ARCHITECTURE_WORD_BYTES     (4U)
typedef uint32_t    uword_t;
typedef int32_t     sword_t;
#else
#error  "Unsupported word size (check ARCHITECTURE_WORD_BITS in architecture_arch.h)"
#endif
 
#if !defined(ARCHITECTURE_LARGE_TXT_PTR) || DOXYGEN
typedef uintptr_t   uinttxtptr_t;
 
#define PRIxTXTPTR PRIxPTR
#endif
 
#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)
 
#define UWORD_MIN                   0
 
#define UWORD_MAX                   ((1ULL << ARCHITECTURE_WORD_BITS) - 1)
 
#define SWORD_MIN                   (-(1LL << (ARCHITECTURE_WORD_BITS - 1)))
 
#define SWORD_MAX                   ((1LL << (ARCHITECTURE_WORD_BITS - 1)) - 1)
 
#ifdef __cplusplus
}
#endif
 
#endif /* ARCHITECTURE_H */