aboutsummaryrefslogtreecommitdiffstats
path: root/prototypes/connections/program.h
blob: 078a3824411a63a908dba8c735e3a78a65c85f56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
#ifndef PURE_PROGRAM_H
#define PURE_PROGRAM_H
#include "flow.h"
#include <stdint.h>

#define PURE_PROGRAM_LIMIT 16384u
#define PURE_DYNAMIC_LIMIT 8u
typedef struct {
    size_t offset, length;
    bool to_end;
} PureRegion;

typedef struct { size_t value; bool from_u32le; } PureIndex;
typedef struct {
    PureRegion source;
    size_t source_step; /* 0: source region; otherwise a preceding step + 1. */
    PureIndex offset, length;
} PureRangeStep;

/* Prepared connections, not an instruction stream. All view definitions are
 * checked at preparation; their root-length requirements survive elimination.
 * Input views are evaluated before the write effect. A read still opens and
 * validates the object even if its response has no body. */
typedef struct {
    PureRegion read, write, reply;
    size_t read_required, input_required;
    size_t view_definitions, range_definitions;
    size_t write_step, reply_step, input_steps;
    PureRangeStep steps[PURE_DYNAMIC_LIMIT];
    bool reply_input;
    bool splice;
    uint32_t splice_limit; /* Final stored bytes; checked under the writer lock. */
    PureIndex splice_offset, splice_remove;
} PureProgram;

#if SIZE_MAX == UINT64_MAX
_Static_assert(sizeof(PureProgram) == 680, "prepared document definition grew");
#endif

bool pure_program_parse(const char *source, size_t length, PureProgram *out,
                        char *error, size_t error_size);
bool pure_program_load(const char *path, PureProgram *out, char *error, size_t error_size);
bool pure_region_span(PureRegion region, PureSpan source, PureSpan *out);
/* Validates all input views, including unused dynamic views, before any effect.
 * Returns borrowed selections; their lifetime remains that of source. */
bool pure_program_input(const PureProgram *, PureSpan source, PureSpan *write, PureSpan *reply);
/* Byte positions in the stored value. Bounds against the current version are
 * checked by the conditional storage effect under the writer lock. */
bool pure_program_splice(const PureProgram *, PureSpan source, size_t *offset, size_t *remove);
#endif