ose_abi.h

Go to the documentation of this file.

/*
  Copyright (c) 2026 John MacCallum Permission is hereby granted,
  free of charge, to any person obtaining a copy of this software
  and associated documentation files (the "Software"), to deal in
  the Software without restriction, including without limitation the
  rights to use, copy, modify, merge, publish, distribute,
  sublicense, and/or sell copies of the Software, and to permit
  persons to whom the Software is furnished to do so, subject to the
  following conditions:
 
  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  DEALINGS IN THE SOFTWARE.
*/

 
#ifndef OSE_ABI_H
#define OSE_ABI_H
 
#include <stdint.h>
#include "ose.h"
#include "ose_context.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#define OSE_ABI_FIELDS(F)                                               \
    F(cache_size,      OSE_CONTEXT_CACHE_SIZE)                          \
    F(cache_items,     OSE_CONTEXT_NUM_CACHE_ITEMS)                     \
    F(cache_ttstrlen,  OSE_CONTEXT_CACHE_TYPETAG_STRLEN)                \
    F(cache_offset,    OSE_CONTEXT_CACHE_OFFSET)                        \
    F(bundle_offset,   OSE_CONTEXT_BUNDLE_OFFSET)                       \
    F(alignment,       OSE_CONTEXT_ALIGNMENT)                           \
    F(ptr_size,        (int32_t)sizeof(intptr_t))                       \
    F(types,           OSE_ABI_TYPEMASK)                                \
    F(wrapped_bundle,  OSE_ABI_WRAP_BUNDLE_PTR)                         \
    F(debug,           OSE_ABI_DEBUG)
 
/* The build configuration, which is an ABI difference and was not being
   checked. OSE_CONF_DEBUG implies OSE_WRAP_BUNDLE_PTR, and that changes
   ose_bundle from `char *` to a struct holding one -- so every function
   taking a bundle changes signature. A debug module loaded cleanly into
   a release host and answered (3, 4) /o/add correctly, which is the worst
   possible outcome: on arm64 a one-pointer struct happens to be passed like
   a pointer, so the mismatch shows up later, somewhere else, as what looks
   like a library bug. Asserts are live in such a module too, and they abort
   the host.
 
   Kept as two fields rather than one so the message names which. */
#ifdef OSE_WRAP_BUNDLE_PTR
#define OSE_ABI_WRAP_BUNDLE_PTR 1
#else
#define OSE_ABI_WRAP_BUNDLE_PTR 0
#endif
 
#ifdef OSE_DEBUG
#define OSE_ABI_DEBUG 1
#else
#define OSE_ABI_DEBUG 0
#endif
 
/* Which optional types this build provides. A module that believes
   OSETT_DOUBLE exists sizes payloads differently from a host that does not
   provide it, so the sets have to match. */
#define OSE_ABI_TYPE(name, bit) OSE_ABI_TYPE_##name(bit)
 
#define OSE_ABI_TYPEMASK                                                \
    ((int32_t)(0                                                        \
               OSE_ABI_TYPE(SYMBOL,     0)                              \
               OSE_ABI_TYPE(DOUBLE,     1)                              \
               OSE_ABI_TYPE(INT8,       2)                              \
               OSE_ABI_TYPE(UINT8,      3)                              \
               OSE_ABI_TYPE(INT16,      4)                              \
               OSE_ABI_TYPE(UINT16,     5)                              \
               OSE_ABI_TYPE(UINT32,     6)                              \
               OSE_ABI_TYPE(INT64,      7)                              \
               OSE_ABI_TYPE(UINT64,     8)                              \
               OSE_ABI_TYPE(TIMETAG,    9)                              \
               OSE_ABI_TYPE(TRUE,      10)                              \
               OSE_ABI_TYPE(FALSE,     11)                              \
               OSE_ABI_TYPE(NIL,       12)                              \
               OSE_ABI_TYPE(INFINITUM, 13)))
 
#ifdef OSE_PROVIDE_TYPE_SYMBOL
#define OSE_ABI_TYPE_SYMBOL(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_SYMBOL(b)
#endif
#ifdef OSE_PROVIDE_TYPE_DOUBLE
#define OSE_ABI_TYPE_DOUBLE(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_DOUBLE(b)
#endif
#ifdef OSE_PROVIDE_TYPE_INT8
#define OSE_ABI_TYPE_INT8(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_INT8(b)
#endif
#ifdef OSE_PROVIDE_TYPE_UINT8
#define OSE_ABI_TYPE_UINT8(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_UINT8(b)
#endif
#ifdef OSE_PROVIDE_TYPE_INT16
#define OSE_ABI_TYPE_INT16(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_INT16(b)
#endif
#ifdef OSE_PROVIDE_TYPE_UINT16
#define OSE_ABI_TYPE_UINT16(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_UINT16(b)
#endif
#ifdef OSE_PROVIDE_TYPE_UINT32
#define OSE_ABI_TYPE_UINT32(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_UINT32(b)
#endif
#ifdef OSE_PROVIDE_TYPE_INT64
#define OSE_ABI_TYPE_INT64(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_INT64(b)
#endif
#ifdef OSE_PROVIDE_TYPE_UINT64
#define OSE_ABI_TYPE_UINT64(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_UINT64(b)
#endif
#ifdef OSE_PROVIDE_TYPE_TIMETAG
#define OSE_ABI_TYPE_TIMETAG(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_TIMETAG(b)
#endif
#ifdef OSE_PROVIDE_TYPE_TRUE
#define OSE_ABI_TYPE_TRUE(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_TRUE(b)
#endif
#ifdef OSE_PROVIDE_TYPE_FALSE
#define OSE_ABI_TYPE_FALSE(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_FALSE(b)
#endif
#ifdef OSE_PROVIDE_TYPE_NIL
#define OSE_ABI_TYPE_NIL(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_NIL(b)
#endif
#ifdef OSE_PROVIDE_TYPE_INFINITUM
#define OSE_ABI_TYPE_INFINITUM(b) | (1 << (b))
#else
#define OSE_ABI_TYPE_INFINITUM(b)
#endif

struct ose_abi
{
#define OSE_ABI_FIELD_DECL(name, value) int32_t name;
    OSE_ABI_FIELDS(OSE_ABI_FIELD_DECL)
#undef OSE_ABI_FIELD_DECL
};

#define OSE_ABI_FIELD_VALUE(name, value) (value),
#define OSE_ABI_INIT { OSE_ABI_FIELDS(OSE_ABI_FIELD_VALUE) }

#define OSE_ABI_SYMBOL_NAME "ose_abi_expected"

#define OSE_ABI_DECLARE \
    const struct ose_abi ose_abi_expected = OSE_ABI_INIT

void ose_abi_thisBuild(struct ose_abi *a);

int32_t ose_abi_compatible(const struct ose_abi *host,
                           const struct ose_abi *mod,
                           char *buf,
                           int32_t buflen);
 
#ifdef __cplusplus
}
#endif
 
#endif