#include "types.h"

Include dependency graph for sysmacros.h:

Macros
#define	NO_ACF_TYPE 0

#define	FF_A320_ACF_TYPE 1

#define	DIRSEP '/'

#define	DIRSEP_S "/" /* DIRSEP as a string */

#define	MAX_PATH 512

#define	DEPRECATED_ATTR

#define	PRINTF_ATTR(x)

#define	PRINTF_ATTR2(x, y)

#define	SENTINEL_ATTR

#define	HOT_ATTR

#define	PURE_ATTR

#define	ALWAYS_INLINE_ATTR

#define	COND_LIKELY(x) x

#define	COND_UNLIKELY(x) x

#define	ALIGN_ATTR(x)

#define	PRINTF_FORMAT(f) f

#define	BSWAP16(x)

#define	BSWAP32(x)

#define	BSWAP64(x)

#define	BE64(x) (x)

#define	BE32(x) (x)

#define	BE16(x) (x)

#define	DESTROY(x) do { free(x); (x) = NULL; } while (0)

#define	DESTROY_OP(var, zero_val, destroy_op)

#define	PATHSEP "/"

#define	MIN_ELEV -2000.0

#define	MAX_ELEV 30000.0

#define	MIN_ALT -2000.0

#define	MAX_ALT 100000.0

#define	MAX_SPD 1000.0

#define	MIN_ARC_RADIUS 0.1

#define	MAX_ARC_RADIUS 100.0

#define	TYPE_ASSERT(x, type)

#define	NOT_TYPE_ASSERT(x, type)

#define	CTASSERT(x)

#define	MIN(x, y) ((x) < (y) ? (x) : (y))

#define	MAX(x, y) ((x) > (y) ? (x) : (y))

#define	AVG(x, y) (((x) + (y)) / 2.0)

#define	FILTER_IN_TYPE(x) __typeof__(x)

#define	FILTER_IN(old_val, new_val, d_t, lag)

#define	FILTER_IN_NAN(old_val, new_val, d_t, lag)

#define	FILTER_IN_LIN(old_val, tgt, d_t, step)

#define	SCANF_STR_AUTOLEN_IMPL(_str_) #_str_

#define	SCANF_STR_AUTOLEN(_str_) SCANF_STR_AUTOLEN_IMPL(_str_)

#define	REQ_PTR(x) *x

#define	REQ_ARR(x) x[n]

#define	ENUM_BIT_WIDTH_CHECK(enum_type, num_bits, ...)
	Compile-time macro for checking whether an enum can be represented in a fixed number of bits.

Macro Definition Documentation

◆ ALIGN_ATTR

#define ALIGN_ATTR ( x )

Definition at line 93 of file sysmacros.h.

◆ ALWAYS_INLINE_ATTR

#define ALWAYS_INLINE_ATTR

Definition at line 85 of file sysmacros.h.

◆ AVG

#define AVG	(	x,
		y
	)	(((x) + (y)) / 2.0)

Definition at line 228 of file sysmacros.h.

◆ BE16

#define BE16 ( x ) (x)

Definition at line 132 of file sysmacros.h.

◆ BE32

#define BE32 ( x ) (x)

Definition at line 131 of file sysmacros.h.

◆ BE64

#define BE64 ( x ) (x)

Definition at line 130 of file sysmacros.h.

◆ BSWAP16

#define BSWAP16 ( x )

Value:

((((x) & 0xff00u) >> 8) | \

(((x) & 0x00ffu) << 8))

Definition at line 109 of file sysmacros.h.

◆ BSWAP32

#define BSWAP32 ( x )

Value:

    ((((x) & 0xff000000u) >> 24) | \
    (((x) & 0x00ff0000u) >> 8) | \
    (((x) & 0x0000ff00u) << 8) | \
    (((x) & 0x000000ffu) << 24))

Definition at line 112 of file sysmacros.h.

◆ BSWAP64

#define BSWAP64 ( x )

Value:

    ((((x) & 0x00000000000000ffllu) >> 56) | \
    (((x) & 0x000000000000ff00llu) << 40) | \
    (((x) & 0x0000000000ff0000llu) << 24) | \
    (((x) & 0x00000000ff000000llu) << 8) | \
    (((x) & 0x000000ff00000000llu) >> 8) | \
    (((x) & 0x0000ff0000000000llu) >> 24) | \
    (((x) & 0x00ff000000000000llu) >> 40) | \
    (((x) & 0xff00000000000000llu) << 56))

Definition at line 117 of file sysmacros.h.

◆ COND_LIKELY

#define COND_LIKELY ( x ) x

Definition at line 87 of file sysmacros.h.

◆ COND_UNLIKELY

#define COND_UNLIKELY ( x ) x

Definition at line 88 of file sysmacros.h.

◆ CTASSERT

#define CTASSERT ( x )

Definition at line 191 of file sysmacros.h.

◆ DEPRECATED_ATTR

#define DEPRECATED_ATTR

Definition at line 79 of file sysmacros.h.

◆ DESTROY

#define DESTROY ( x ) do { free(x); (x) = NULL; } while (0)

Definition at line 139 of file sysmacros.h.

◆ DESTROY_OP

#define DESTROY_OP	(	var,
		zero_val,
		destroy_op
	)

Value:

    do { \
        if ((var) != (zero_val)) { \
            destroy_op; \
            (var) = (zero_val); \
        } \
    } while (0)

Definition at line 140 of file sysmacros.h.

◆ DIRSEP

#define DIRSEP '/'

Definition at line 49 of file sysmacros.h.

◆ DIRSEP_S

#define DIRSEP_S "/" /* DIRSEP as a string */

Definition at line 50 of file sysmacros.h.

◆ ENUM_BIT_WIDTH_CHECK

#define ENUM_BIT_WIDTH_CHECK	(	enum_type,
		num_bits,
		...
	)

Value:

    do { \
        enum_type __enum_check_value__ = 0; \
        CTASSERT(num_bits > 0); \
        enum { __enum_check_max_value__ = (1 << (num_bits)) - 1 }; \
        switch (__enum_check_value__) { \
            __VA_ARGS__ \
        } \
    } while (0)

Compile-time macro for checking whether an enum can be represented in a fixed number of bits.

This macro lets you perform a simple compile-time check to validate that all variants of an enum fit into a fixed bit space representation. This way you can validate that no variant accidentally exceeds the amount of bit space allocated in a bit field.

This macro is used in conjunction with the ENUM_BIT_WIDTH_CHECK_VARIANT macro as follows:

enum foo {
    foo_a,
    foo_b,
    foo_c,
    foo_d,
};
uint8_t encode_enum_foo(enum foo bar) {
     // check to make sure all of enum foo fits into 2 bits
     ENUM_BIT_WIDTH_CHECK(enum foo, 2,
         ENUM_BIT_WIDTH_CHECK_VARIANT(foo_a);
         ENUM_BIT_WIDTH_CHECK_VARIANT(foo_b);
         ENUM_BIT_WIDTH_CHECK_VARIANT(foo_c);
         ENUM_BIT_WIDTH_CHECK_VARIANT(foo_d);
     );
}

This macro performs no runtime computation and thus is complete inert from a runtime standpoint. All checking is performed at compile time. While you must manually list all enum variants in the macro to perform all checks, your compiler should warn you about unhandled variants, in case you forgot some, or added some variants later.

Definition at line 415 of file sysmacros.h.

◆ FF_A320_ACF_TYPE

#define FF_A320_ACF_TYPE 1

Definition at line 43 of file sysmacros.h.

◆ FILTER_IN

#define FILTER_IN	(	old_val,
		new_val,
		d_t,
		lag
	)

Value:

    do { \
        FILTER_IN_TYPE(old_val) o = (old_val); \
        FILTER_IN_TYPE(new_val) n = (new_val); \
        ASSERT(!isnan(o)); \
        (old_val) += (n - o) * ((d_t) / (lag)); \
        /* Prevent an overshoot */ \
        if ((o < n && (old_val) > n) || \
            (o > n && (old_val) < n)) \
            (old_val) = n; \
    } while (0)

Definition at line 244 of file sysmacros.h.

◆ FILTER_IN_LIN

#define FILTER_IN_LIN	(	old_val,
		tgt,
		d_t,
		step
	)

Value:

    do { \
        double o = (old_val); \
        double t = (tgt); \
        double s; \
        if (isnan(o)) \
            o = t; \
        if (o < t) \
            s = (d_t) * (step); \
        else \
            s = (d_t) * (-(step)); \
        if ((o <= t && o + s > t) || (o >= t && o + s < t)) \
            (old_val) = t; \
        else \
            (old_val) += s; \
    } while (0)

Definition at line 277 of file sysmacros.h.

◆ FILTER_IN_NAN

#define FILTER_IN_NAN	(	old_val,
		new_val,
		d_t,
		lag
	)

Value:

    do { \
        FILTER_IN_TYPE(old_val) o = (old_val); \
        FILTER_IN_TYPE(new_val) n = (new_val); \
        if (isnan(n)) \
            (old_val) = NAN; \
        else if (isnan(o)) \
            (old_val) = (new_val); \
        else \
            FILTER_IN(old_val, new_val, d_t, lag); \
    } while (0)

Definition at line 261 of file sysmacros.h.

◆ FILTER_IN_TYPE

#define FILTER_IN_TYPE ( x ) __typeof__(x)

Definition at line 233 of file sysmacros.h.

◆ HOT_ATTR

#define HOT_ATTR

Definition at line 83 of file sysmacros.h.

◆ MAX

#define MAX	(	x,
		y
	)	((x) > (y) ? (x) : (y))

Definition at line 225 of file sysmacros.h.

◆ MAX_ALT

#define MAX_ALT 100000.0

Definition at line 160 of file sysmacros.h.

◆ MAX_ARC_RADIUS

#define MAX_ARC_RADIUS 100.0

Definition at line 167 of file sysmacros.h.

◆ MAX_ELEV

#define MAX_ELEV 30000.0

Definition at line 156 of file sysmacros.h.

◆ MAX_PATH

#define MAX_PATH 512

Definition at line 52 of file sysmacros.h.

◆ MAX_SPD

#define MAX_SPD 1000.0

Definition at line 163 of file sysmacros.h.

◆ MIN

#define MIN	(	x,
		y
	)	((x) < (y) ? (x) : (y))

Definition at line 222 of file sysmacros.h.

◆ MIN_ALT

#define MIN_ALT -2000.0

Definition at line 159 of file sysmacros.h.

◆ MIN_ARC_RADIUS

#define MIN_ARC_RADIUS 0.1

Definition at line 166 of file sysmacros.h.

◆ MIN_ELEV

#define MIN_ELEV -2000.0

Definition at line 155 of file sysmacros.h.

◆ NO_ACF_TYPE

#define NO_ACF_TYPE 0

Definition at line 42 of file sysmacros.h.

◆ NOT_TYPE_ASSERT

#define NOT_TYPE_ASSERT	(	x,
		type
	)

Definition at line 183 of file sysmacros.h.

◆ PATHSEP

#define PATHSEP "/"

Definition at line 151 of file sysmacros.h.

◆ PRINTF_ATTR

#define PRINTF_ATTR ( x )

Definition at line 80 of file sysmacros.h.

◆ PRINTF_ATTR2

#define PRINTF_ATTR2	(	x,
		y
	)

Definition at line 81 of file sysmacros.h.

◆ PRINTF_FORMAT

#define PRINTF_FORMAT ( f ) f

Definition at line 105 of file sysmacros.h.

◆ PURE_ATTR

#define PURE_ATTR

Definition at line 84 of file sysmacros.h.

◆ REQ_ARR

#define REQ_ARR ( x ) x[n]

Same as REQ_PTR(), except allows specifying a number of elements in a fixed-size array. This will allow you to treat the pointer as an array while letting the compiler perform static bounds checking where possible. If the caller passes a fixed-size array, the compiler will also perform bounds checking on the calling side.

The way to use this macro is as follows:

int foo(object_t REQ_ARR(arg, 5));

REQ_ARR

#define REQ_ARR(x)

Definition sysmacros.h:375

This declares a pointer argument named arg to be a non-NULL'able reference to an array of at least 5 elements. When compiling for C11 or higher, this expands into:

int foo(object_t arg[static 5]);

Please note that this doesn't imply any kind of runtime bounds checks. If you use a runtime variable to perform array indexing, this is still not guaranteed to catch out-of-bounds array access bugs.

Another method to use this macro is to pass a dynamic size, such as:

int foo(size_t n, object_t REQ_ARR(arg, n));

This lets the callee accept variable-length arrays, while still letting the caller perform compile-time bounds checks, such that a mismatched size argument and actual static array size can be detected and flagged. Once again, this doesn't provide dynamic bounds checks, so its function is simply to serve as additional type annotations for checks which can be performed at compile time.

Definition at line 375 of file sysmacros.h.

◆ REQ_PTR

#define REQ_PTR ( x ) *x

Marks a pointer argument as a required (i.e. non-NULL'able). This uses C11's [static 1] syntax to declare a pointer, which must point to allocated memory. The way to use this macro is as follows:

int foo(object_t REQ_PTR(arg));

REQ_PTR

#define REQ_PTR(x)

Definition sysmacros.h:334

This declares a pointer argument named arg to be non-NULL'able. When compiling for C11 or higher, this expands into:

int foo(object_t arg[static 1]);

The code in the function can then manipulate this pointer as more-or-less a normal pointer, with the exception that you may not call free() on it, as that violates the guarantee that the pointer always point to allocated memory. The code may, however, freely read and write to the object. There is an additional constraint, in that the compiler now treats this as a pointer to a single object, rather than an indexable array. To declare a non-NULL'able pointer to an array of known size, use the REQ_ARR() macro.

If the caller doesn't support C11 constructs (e.g. it is C++ or Rust), this macro expands to a plain pointer, so this safety aspect is only available for C11 or newer code.

Please also note that this doesn't guarantee that there is no combination of factors possible where this pointer may be NULL even in pure C11 code. If the caller is simply passing through a plain pointer from their own arguments (the caller function just serving as an intermediary), then the ultimate origin of the pointer might still have passed NULL. For this guarantee to hold fully, all code up the stack would need to support C11 constructs and/or provide rubust integrity checks against stray NULLs.

Definition at line 334 of file sysmacros.h.

◆ SCANF_STR_AUTOLEN

#define SCANF_STR_AUTOLEN ( _str_ ) SCANF_STR_AUTOLEN_IMPL(_str_)

Definition at line 295 of file sysmacros.h.

◆ SCANF_STR_AUTOLEN_IMPL

#define SCANF_STR_AUTOLEN_IMPL ( _str_ ) #_str_

Definition at line 294 of file sysmacros.h.

◆ SENTINEL_ATTR

#define SENTINEL_ATTR

Definition at line 82 of file sysmacros.h.

◆ TYPE_ASSERT

#define TYPE_ASSERT	(	x,
		type
	)

Definition at line 182 of file sysmacros.h.

Macros

Macro Definition Documentation

◆ ALIGN_ATTR

◆ ALWAYS_INLINE_ATTR

◆ AVG

◆ BE16

◆ BE32

◆ BE64

◆ BSWAP16

◆ BSWAP32

◆ BSWAP64

◆ COND_LIKELY

◆ COND_UNLIKELY

◆ CTASSERT

◆ DEPRECATED_ATTR

◆ DESTROY

◆ DESTROY_OP

◆ DIRSEP

◆ DIRSEP_S

◆ ENUM_BIT_WIDTH_CHECK

◆ FF_A320_ACF_TYPE

◆ FILTER_IN

◆ FILTER_IN_LIN

◆ FILTER_IN_NAN

◆ FILTER_IN_TYPE

◆ HOT_ATTR

◆ MAX

◆ MAX_ALT

◆ MAX_ARC_RADIUS

◆ MAX_ELEV

◆ MAX_PATH

◆ MAX_SPD

◆ MIN

◆ MIN_ALT

◆ MIN_ARC_RADIUS

◆ MIN_ELEV

◆ NO_ACF_TYPE

◆ NOT_TYPE_ASSERT

◆ PATHSEP

◆ PRINTF_ATTR

◆ PRINTF_ATTR2

◆ PRINTF_FORMAT

◆ PURE_ATTR

◆ REQ_ARR

◆ REQ_PTR

◆ SCANF_STR_AUTOLEN

◆ SCANF_STR_AUTOLEN_IMPL

◆ SENTINEL_ATTR

◆ TYPE_ASSERT