- Generated by
1.9.8
|
ProtoCore v1.0.16
Deterministic, zero-heap network stack for embedded targets
|
The primitive types every other file is written in, and the one place <stdint.h> and <stddef.h> appear. More...
#include <assert.h>#include <stddef.h>#include <stdint.h>Go to the source code of this file.
Macros | |
| #define | PROTO_TRUE ((proto_bool)1) |
| the true value, spelled so a caller never writes a bare 1 | |
| #define | PROTO_FALSE ((proto_bool)0) |
| the false value | |
| #define | PROTO_ATOMIC_LOAD(p) atomic_load_explicit((p), memory_order_acquire) |
Cross-thread access to a ProtoCore field declared _Atomic: a slot state, a run flag. | |
| #define | PROTO_ATOMIC_STORE(p, v) atomic_store_explicit((p), (v), memory_order_release) |
release store of v | |
| #define | PROTOCORE_BEGIN_DECLS |
| Give a header's declarations C linkage, so their symbol names carry no parameter types. | |
| #define | PROTOCORE_END_DECLS |
| #define | PROTO_ENUM_PACKED |
| Give an enum the narrowest type its values fit in. Carried by every enum in this library. | |
Typedefs | |
| typedef _Bool | proto_bool |
| The truth value. | |
| typedef enum PROTO_ENUM_PACKED | proto_enum_probe |
| The natural register width, as a type. | |
Fixed-width integers | |
The exact-width names, aliased once. A port that lacks one of these replaces it here. | |
| typedef uint8_t | proto_u8 |
| typedef uint16_t | proto_u16 |
| typedef uint32_t | proto_u32 |
| typedef uint64_t | proto_u64 |
| typedef int8_t | proto_i8 |
| typedef int16_t | proto_i16 |
| typedef int32_t | proto_i32 |
| typedef int64_t | proto_i64 |
Enumerations | |
| enum | PROTO_ENUM_PACKED { PROTO_ENUM_PROBE_MIN = 0 , PROTO_ENUM_PROBE_MAX = 255 } |
| The natural register width, as a type. More... | |
The primitive types every other file is written in, and the one place <stdint.h> and <stddef.h> appear.
A library that targets xtensa, riscv, arm and c2000 cannot spend a type it has not established. uint8_t is optional in C11 - a conforming implementation omits it when it has no 8-bit type, which is exactly the c2000 case, where a byte is 16 bits wide. Naming the widths once here makes that one file to port and one place to look.
Widths are stated, never inherited. size_t is the type this file exists to replace at an offset or a length. Its width is whatever the target's pointer happens to be, so the same expression is 32-bit index math on a device and 64-bit on the host that tests it - different emitted code from the same source, which is the one thing this library does not accept. ::proto_idx is a stated width the build can override, so the arithmetic has the same shape everywhere.
Narrow values are carried in the register width. On every ISA in the target list an operation narrower than the register costs an extra mask or sign-extend to keep the unused half honest, so the cheapest 16-bit index on a 32-bit part is a 32-bit one truncated at the boundary, exactly as a 32-bit index on a 64-bit host is. ::proto_word is that register width.
Definition in file types.h.
| #define PROTO_TRUE ((proto_bool)1) |
| #define PROTO_FALSE ((proto_bool)0) |
| #define PROTO_ATOMIC_LOAD | ( | p | ) | atomic_load_explicit((p), memory_order_acquire) |
Cross-thread access to a ProtoCore field declared _Atomic: a slot state, a run flag.
Every read is an acquire load and every write a release store, so the ordering is stated at each access rather than left to the default. MMgr keeps its ring atomics inside memoria_anularis and exposes none, so the fields ProtoCore owns itself are reached through these two.
atomic_load_explicit and atomic_store_explicit are <stdatomic.h>, which a file using these includes itself: this header also reaches C++ sketches, where that header is not C11's.
| #define PROTO_ATOMIC_STORE | ( | p, | |
| v | |||
| ) | atomic_store_explicit((p), (v), memory_order_release) |
| #define PROTOCORE_BEGIN_DECLS |
Give a header's declarations C linkage, so their symbol names carry no parameter types.
Wraps the declarations between them in extern "C" under a C++ compiler, and expands to nothing under a C one. The sketches, ESP-IDF app code and Unity suites that call this library are C++; src/ is C.
| #define PROTO_ENUM_PACKED |
Give an enum the narrowest type its values fit in. Carried by every enum in this library.
C11 leaves an enum's underlying type to the implementation, and the target list does not agree: xtensa, riscv32 and the host give an int, while arm-none-eabi defaults to the narrow form. An enum declared inside a struct is BSS, so without this the same connection slot is one size on an ESP32 and another on a Cortex-M, and the footprint stops being a single number that can be computed before flashing. C23 spells the same thing enum E : proto_u8; until every compiler in the list is C23, the attribute is what states it.
TI's compiler takes --small_enum on the command line and has no attribute for it, so this expands to nothing there and the assert below fails rather than the width being wrong quietly.
| typedef _Bool proto_bool |
The truth value.
Each language's own boolean, so this needs no header and cannot collide with a vendor bool macro - which several SDKs in the target list define, and which is why <stdbool.h> is not included here. Both spellings are one byte and both normalize any nonzero to 1, so a value crossing between the library and a caller compares the same on either side.
The C++ arm is not conversion scaffolding: this type reaches the public surface through protocore.h, and the sketches that surface is written for are compiled as C++.
| typedef enum PROTO_ENUM_PACKED proto_enum_probe |
The natural register width, as a type.
What an index or a count is carried in while it is being worked on. Narrower arithmetic is not cheaper on these parts: it costs the mask that keeps the unused half correct.
Every offset, length and capacity in this library. Never size_t.
Stated at PROTO_INDEX_BITS so an offset is the same width in the device build and in the host test that proves it. 32 bits addresses far more than any pool this library reserves; a target whose every buffer is under 64 KB can set 16 and pay one narrower register per index.
| enum PROTO_ENUM_PACKED |
The natural register width, as a type.
What an index or a count is carried in while it is being worked on. Narrower arithmetic is not cheaper on these parts: it costs the mask that keeps the unused half correct.
Every offset, length and capacity in this library. Never size_t.
Stated at PROTO_INDEX_BITS so an offset is the same width in the device build and in the host test that proves it. 32 bits addresses far more than any pool this library reserves; a target whose every buffer is under 64 KB can set 16 and pay one narrower register per index.
| Enumerator | |
|---|---|
| PROTO_ENUM_PROBE_MIN | |
| PROTO_ENUM_PROBE_MAX | |
1.9.8