1 // SPDX-License-Identifier: MIT
3 * Copyright 2022-2023 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 #ifndef SIDE_ABI_TYPE_VALUE_H
7 #define SIDE_ABI_TYPE_VALUE_H
10 #include <side/macros.h>
11 #include <side/endian.h>
14 * SIDE ABI for type values.
16 * The extensibility scheme for the SIDE ABI for type values is as
19 * * Existing type values are never changed nor extended. Type values
20 * can be added to the ABI by reserving a label within enum
22 * * Each union part of the ABI has an explicit size defined by a
23 * side_padding() member. Each structure and union have a static
24 * assert validating its size.
25 * * Changing the semantic of the existing type value fields is a
26 * breaking ABI change.
28 * Handling of unknown type values by the tracers:
30 * * A tracer may choose to support only a subset of the type values
31 * supported by libside. When encountering an unknown or unsupported
32 * type value, the tracer has the option to either disallow the entire
33 * event or skip over the unknown type, both at event registration and
34 * when receiving the side_call arguments.
37 enum side_type_label_byte_order
{
38 SIDE_TYPE_BYTE_ORDER_LE
= 0,
39 SIDE_TYPE_BYTE_ORDER_BE
= 1,
42 union side_integer_value
{
47 uint64_t side_u128_split
[2];
52 int64_t side_s128_split
[2];
56 side_check_size(union side_integer_value
, 32);
58 union side_bool_value
{
65 side_check_size(union side_bool_value
, 32);
67 union side_float_value
{
69 _Float16 side_float_binary16
;
72 _Float32 side_float_binary32
;
75 _Float64 side_float_binary64
;
78 _Float128 side_float_binary128
;
82 side_check_size(union side_float_value
, 32);
84 struct side_type_raw_string
{
85 side_ptr_t(const void) p
; /* pointer to string */
86 uint8_t unit_size
; /* 1, 2, or 4 bytes */
87 side_enum_t(enum side_type_label_byte_order
, uint8_t) byte_order
;
89 side_check_size(struct side_type_raw_string
, 18);
91 #endif /* SIDE_ABI_TYPE_VALUE_H */