common.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * 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 HOLDER 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.
 */

 
#ifndef UCX_COMMON_H
#define UCX_COMMON_H

#define UCX_VERSION_MAJOR   3

#define UCX_VERSION_MINOR   1

#define UCX_VERSION (((UCX_VERSION_MAJOR)<<16)|UCX_VERSION_MINOR)
 
// ---------------------------------------------------------------------------
//       Common includes
// ---------------------------------------------------------------------------
 
#include <stdlib.h>
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include <sys/types.h>
 
// ---------------------------------------------------------------------------
//       Architecture Detection
// ---------------------------------------------------------------------------
 
#ifndef INTPTR_MAX
#error Missing INTPTR_MAX definition
#endif
#if INTPTR_MAX == INT64_MAX
#define CX_WORDSIZE 64
#elif INTPTR_MAX == INT32_MAX
#define CX_WORDSIZE 32
#else
#error Unknown pointer size or missing size macros!
#endif
 
// ---------------------------------------------------------------------------
//       Attribute definitions
// ---------------------------------------------------------------------------
 
#ifndef __GNUC__
#define __attribute__(x)
#endif

#define cx_attr_fallthrough __attribute__((__fallthrough__))

#define cx_attr_nonnull __attribute__((__nonnull__))

#define cx_attr_nonnull_arg(...) __attribute__((__nonnull__(__VA_ARGS__)))

#define cx_attr_returns_nonnull __attribute__((__returns_nonnull__))

#define cx_attr_malloc __attribute__((__malloc__))
 
#if !defined(__clang__) && __GNUC__ >= 11
#define cx_attr_dealloc(freefunc, freefunc_arg) \
    __attribute__((__malloc__(freefunc, freefunc_arg)))
#else
#define cx_attr_dealloc(...)
#endif // __clang__

#define cx_attr_dealloc_ucx cx_attr_dealloc(cxFree, 2)

#define cx_attr_allocsize(...) __attribute__((__alloc_size__(__VA_ARGS__)))
 
 
#ifdef __clang__
#define cx_attr_cstr_arg(idx)
#define cx_attr_access(mode, ...)
#else
#if __GNUC__ < 10
#define cx_attr_access(mode, ...)
#else
#define cx_attr_access(mode, ...) __attribute__((__access__(mode, __VA_ARGS__)))
#endif // __GNUC__ < 10
#if __GNUC__ < 14
#define cx_attr_cstr_arg(idx)
#else
#define cx_attr_cstr_arg(idx) \
    __attribute__((__null_terminated_string_arg__(idx)))
#endif // __GNUC__ < 14
#endif // __clang__
 

#define cx_attr_access_r(...) cx_attr_access(__read_only__, __VA_ARGS__)

#define cx_attr_access_rw(...) cx_attr_access(__read_write__, __VA_ARGS__)

#define cx_attr_access_w(...) cx_attr_access(__write_only__, __VA_ARGS__)

#define cx_attr_unused __attribute__((__unused__))

#define cx_attr_nodiscard __attribute__((__warn_unused_result__))
 
 
// ---------------------------------------------------------------------------
//       MSVC specifics
// ---------------------------------------------------------------------------
 
#ifdef _MSC_VER
// fix missing _Thread_local support
#define _Thread_local __declspec(thread)
#endif // _MSC_VER
 
// ---------------------------------------------------------------------------
//       Exported and inlined functions
// ---------------------------------------------------------------------------
 
#if defined(CX_WINDLL_EXPORT)
#define CX_EXPORT __declspec(dllexport)
#elif defined(CX_WINDLL)
#define CX_EXPORT __declspec(dllimport)
#else
#define CX_EXPORT
#endif // CX_WINDLL / CX_WINDLL_EXPORT
 
#ifdef __GNUC__
#define CX_INLINE __attribute__((always_inline)) static inline
#else
#define CX_INLINE static inline
#endif
#define CX_CPPDECL static inline
 
// ---------------------------------------------------------------------------
//       Useful function pointers
// ---------------------------------------------------------------------------

typedef size_t (*cx_write_func)(const void*, size_t, size_t, void*);

typedef size_t (*cx_read_func)(void*, size_t, size_t, void*);
 
// ---------------------------------------------------------------------------
//       Utility macros
// ---------------------------------------------------------------------------

#define cx_nmemb(arr) (sizeof(arr)/sizeof((arr)[0]))
 
// ---------------------------------------------------------------------------
//       szmul implementation
// ---------------------------------------------------------------------------
 
#if (__GNUC__ >= 5 || defined(__clang__)) && !defined(CX_NO_SZMUL_BUILTIN)
#define CX_SZMUL_BUILTIN
#define cx_szmul(a, b, result) __builtin_mul_overflow(a, b, result)
#else // no GNUC or clang bultin
#define cx_szmul(a, b, result) cx_szmul_impl(a, b, result)

#if __cplusplus
extern "C"
#endif
CX_EXPORT int cx_szmul_impl(size_t a, size_t b, size_t *result);
#endif // cx_szmul
 
#endif // UCX_COMMON_H