analyze.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-3.0-only
 
#pragma once
 
#include <ctu_config.h>
 
#include "core/compiler.h"
 
 
 
// work around gcc bug where attributes are reported as available in C11 mode
// but are not actually available.
#if CT_HAS_ATTRIBUTE(nodiscard) && CT_CPLUSPLUS && !defined(__GNUC__)
#   define CT_NODISCARD [[nodiscard]]
#endif
 
#if defined(_PREFAST_)
#   include <sal.h>
#   ifndef CT_NODISCARD
#      define CT_NODISCARD _Check_return_
#   endif
 
#   define RET_DOMAIN(cmp, it) _Ret_range_(cmp, it)
#   define RET_NOTNULL _Ret_notnull_
#   define RET_INSPECT _Must_inspect_result_
 
#   define IN_NOTNULL _In_
#   define IN_STRING _In_z_
#   define IN_DOMAIN(cmp, it) _In_range_(cmp, it)
 
#   define OUT_NOTNULL _Out_
 
#   define INOUT_NOTNULL _Inout_
 
#   define STA_PRESENT 1
 
    // other annotations
#   define STA_DECL _Use_decl_annotations_
 
    // return value annotations
#   define STA_RET_NEVER _Analysis_noreturn_
#   define STA_RET_RANGE(lo, hi) _Ret_range_(lo, hi)
#   define STA_RET_NOTNULL _Ret_notnull_
#   define STA_RET_STRING _Ret_z_
 
    // success/failure annotations
#   define STA_SUCCESS(expr) _Success_(expr)
#   define STA_SUCCESS_TYPE(expr) _Return_type_success_(expr)
#   define STA_LAST_ERROR _Post_equals_last_error_
 
    // struct annotations
#   define STA_FIELD_SIZE(of) _Field_size_(of)
#   define STA_FIELD_STRING _Field_z_
#   define STA_FIELD_RANGE(lo, hi) _Field_range_(lo, hi)
 
    // array parameter annotations
#   define STA_UPDATES(size) _Inout_updates_(size)
#   define STA_READS(size) _In_reads_(size)
#   define STA_WRITES(size) _Out_writes_(size)
 
    // string parameter annotations
#   define STA_UPDATES_CSTRING(size) _Inout_updates_z_(size)
#   define STA_READS_CSTRING(size) _In_reads_z_(size)
#   define STA_WRITES_CSTRING(size) _Out_writes_z_(size)
 
    // format string parameter annotations
#   define STA_FORMAT_STRING _Printf_format_string_
 
    // out parameter annotations
#   define STA_OUT_OPT _Out_opt_
#   define STA_OUT_CSTRING _Out_z_
#   define STA_OUT_RANGE(lo, hi) _Out_range_(lo, hi)
#   define STA_OUT_INVALID _Post_ptr_invalid_
 
    // in parameter annotations
#   define STA_IN_RANGE(lo, hi) _In_range_(lo, hi)
 
    // inout parameter annotations
#   define STA_INOUT _Inout_
#   define STA_INOUT_OPT _Inout_opt_
#   define STA_INOUT_CSTRING _Inout_z_
#else
#   define RET_DOMAIN(cmp, it)
#   define RET_NOTNULL
#   define RET_INSPECT
 
#   define IN_NOTNULL
#   define IN_STRING
#   define IN_DOMAIN(cmp, it)
 
#   define OUT_NOTNULL
 
#   define INOUT_NOTNULL
 
    // other annotations
#   define STA_DECL
 
    // return value annotations
#   define STA_RET_NEVER
#   define STA_RET_RANGE(lo, hi)
#   define STA_RET_NOTNULL
#   define STA_RET_STRING
 
    // success/failure annotations
#   define STA_SUCCESS(expr)
#   define STA_SUCCESS_TYPE(expr)
#   define STA_LAST_ERROR
 
    // struct annotations
#   define STA_FIELD_SIZE(of)
#   define STA_FIELD_STRING
#   define STA_FIELD_RANGE(lo, hi)
 
    // array parameter annotations
#   define STA_UPDATES(size)
#   define STA_READS(size)
#   define STA_WRITES(size)
 
    // string parameter annotations
#   define STA_UPDATES_CSTRING(size)
#   define STA_READS_CSTRING(size)
#   define STA_WRITES_CSTRING(size)
 
    // format string parameter annotations
#   define STA_FORMAT_STRING
 
    // out parameter annotations
#   define STA_OUT_OPT
#   define STA_OUT_CSTRING
#   define STA_OUT_RANGE(lo, hi)
#   define STA_OUT_INVALID
 
    // in parameter annotations
#   define STA_IN_RANGE(lo, hi)
 
    // inout parameter annotations
#   define STA_INOUT
#   define STA_INOUT_OPT
#   define STA_INOUT_CSTRING
#endif
 
#define CT_NORETURN STA_RET_NEVER CT_NORETURN_IMPL
 
#define STA_RELEASE IN_NOTNULL STA_OUT_INVALID
 
 
#if __clang_major__ >= 3
#   define STA_PRINTF(a, b) __attribute__((__format__(__printf__, a, b)))
#elif __GNUC__ >= 4
#   define STA_PRINTF(a, b) __attribute__((format(printf, a, b)))
#else
#  define STA_PRINTF(a, b)
#endif
 
#if __GNUC__ >= 11
#   define CT_GNU_ATTRIB(...) __attribute__((__VA_ARGS__))
#   define CT_CLANG_ATTRIB(...)
#   define CT_ATTRIB(...) __attribute__((__VA_ARGS__))
#elif __clang_major__ >= 10
#   define CT_GNU_ATTRIB(...)
#   define CT_CLANG_ATTRIB(...) __attribute__((__VA_ARGS__))
#   define CT_ATTRIB(...) __attribute__((__VA_ARGS__))
#else
#   define CT_ATTRIB(...)
#   define CT_GNU_ATTRIB(...)
#   define CT_CLANG_ATTRIB(...)
#endif
 
#if defined(_MSC_VER)
#   define CT_DECLSPEC(...) __declspec(__VA_ARGS__)
#else
#   define CT_DECLSPEC(...)
#endif
 
#ifndef IN_NOTNULL
#   define IN_NOTNULL CT_CLANG_ATTRIB(nonnull)
#endif
 
 
#ifndef CT_NODISCARD
#   define CT_NODISCARD CT_ATTRIB(warn_unused_result)
#endif
 
 
// TODO: this is a bit of a hack to make tests work properly
// both gcc and clang will optimize away calls to pure/const functions
// if they can statically prove that the function will cause an assertion.
// In our test suite we test assertion cases so we need to have a way to disable
// this optimization. This may technically be UB.
#if CT_DISABLE_FN_PURITY
#   define CT_NOALIAS
#   define CT_CONSTFN
#   define CT_PUREFN
#else
#   define CT_NOALIAS CT_DECLSPEC(noalias)
#   define CT_CONSTFN CT_ATTRIB(const)
#   define CT_PUREFN CT_ATTRIB(pure)
#endif
 
 
// clang doesnt support passing a deallocate function to attribute((malloc))
#if defined(__clang__)
#   define CT_ALLOC(...) __attribute__((malloc))
#elif defined(__GNUC__)
#   define CT_ALLOC(...) __attribute__((malloc(__VA_ARGS__)))
#elif defined(_MSC_VER)
#   define CT_ALLOC(...) __declspec(restrict) __declspec(allocator)
#else
#   define CT_ALLOC(...)
#endif
 
#define CT_ALLOC_SIZE(...) CT_ATTRIB(alloc_size(__VA_ARGS__))
 
#if CT_CPLUSPLUS
#   if defined(_MSC_VER)
#      define CT_RESTRICT __restrict
#   elif defined(__clang__)
#      define CT_RESTRICT __restrict
#   elif defined(__GNUC__)
#      define CT_RESTRICT __restrict__
#   else
#      define CT_RESTRICT
#   endif
#else
#   define CT_RESTRICT restrict
#endif
 
 
#define CT_HOTFN CT_ATTRIB(hot)
#define CT_COLDFN CT_ATTRIB(cold)
 
#ifndef RET_NOTNULL
#   define RET_NOTNULL CT_ATTRIB(returns_nonnull)
#endif
 
#if !defined(STA_FIELD_SIZE) && CT_HAS_ATTRIBUTE(counted_by)
#   define STA_FIELD_SIZE(of) __attribute__((counted_by(of)))
#endif
 
#ifndef CT_NODISCARD
#   define CT_NODISCARD
#endif
 
#ifdef WITH_DOXYGEN
#   define CT_NODISCARD 0
#   define RET_NOTNULL 0
#   define IN_NOTNULL 0
#endif