From efc8b50f946427fb1492ba3f35eece654eef25cb Mon Sep 17 00:00:00 2001 From: Marcelo Politzer <251334+mpolitzer@users.noreply.github.com> Date: Wed, 11 Oct 2023 04:09:53 -0300 Subject: [PATCH] feat: add libdriver mock: components can be compiled natively: 1. make mock tests ioctl: require the cartesi headers and a riscv compiler: 1. Build or download a compatible kernel and `.deb` headers 2. Setup a cross compilation debian environment by running the setup[1] script. 3. `make ioctl CROSS_COMPILE=riscv64-linux-gnu-` [1] setup.sh ``` apt update && \ DEBIAN_FRONTEND="noninteractive" apt-get install --no-install-recommends --allow-downgrades -y \ bc \ bison \ build-essential \ flex \ genext2fs \ rsync \ gcc-riscv64-linux-gnu \ libc6-dev-riscv64-cross \ ./linux-libc-dev-riscv64-cross-6.5.9-ctsi-1-v0.0.0.deb ``` --- Dockerfile | 4 + Makefile | 6 +- linux/htif/Makefile | 5 +- linux/libdriver/Makefile | 103 + linux/libdriver/README.md | 16 + linux/libdriver/base/abi.c | 237 ++ linux/libdriver/base/abi.h | 394 +++ linux/libdriver/base/buf.c | 50 + linux/libdriver/base/buf.h | 72 + linux/libdriver/base/keccak.c | 121 + linux/libdriver/base/keccak.h | 131 + linux/libdriver/base/merkle-zero-table.h | 71 + linux/libdriver/base/merkle.c | 61 + linux/libdriver/base/merkle.h | 56 + linux/libdriver/base/rollup-driver-api.h | 114 + linux/libdriver/base/rollup.c | 95 + linux/libdriver/base/rollup.h | 100 + linux/libdriver/base/yield-driver-api.h | 45 + linux/libdriver/doc/Doxyfile | 2777 +++++++++++++++++++++ linux/libdriver/doc/DoxygenLayout.xml | 239 ++ linux/libdriver/examples/abi.c | 84 + linux/libdriver/examples/abi_decode_000.c | 25 + linux/libdriver/examples/abi_decode_001.c | 28 + linux/libdriver/examples/abi_encode_000.c | 15 + linux/libdriver/examples/abi_encode_001.c | 16 + linux/libdriver/examples/abi_encode_002.c | 23 + linux/libdriver/examples/abi_get.c | 19 + linux/libdriver/examples/abi_multi.c | 93 + linux/libdriver/examples/rollup-driver.c | 45 + linux/libdriver/examples/rollup.c | 52 + linux/libdriver/examples/yield-driver.c | 23 + linux/libdriver/ioctl/rollup-driver.c | 97 + linux/libdriver/ioctl/rollup-driver.h | 15 + linux/libdriver/ioctl/yield-driver.c | 34 + linux/libdriver/ioctl/yield-driver.h | 7 + linux/libdriver/mock/rollup-driver.c | 137 + linux/libdriver/mock/rollup-driver.h | 16 + linux/libdriver/mock/yield-driver.c | 22 + linux/libdriver/mock/yield-driver.h | 9 + linux/libdriver/tests/abi.c | 303 +++ linux/libdriver/tests/keccak.c | 44 + linux/libdriver/tests/merkle.c | 30 + linux/libdriver/tools/funsel.c | 19 + linux/libdriver/tools/merkle-zero-table.c | 38 + 44 files changed, 5886 insertions(+), 5 deletions(-) create mode 100644 linux/libdriver/Makefile create mode 100644 linux/libdriver/README.md create mode 100644 linux/libdriver/base/abi.c create mode 100644 linux/libdriver/base/abi.h create mode 100644 linux/libdriver/base/buf.c create mode 100644 linux/libdriver/base/buf.h create mode 100644 linux/libdriver/base/keccak.c create mode 100644 linux/libdriver/base/keccak.h create mode 100644 linux/libdriver/base/merkle-zero-table.h create mode 100644 linux/libdriver/base/merkle.c create mode 100644 linux/libdriver/base/merkle.h create mode 100644 linux/libdriver/base/rollup-driver-api.h create mode 100644 linux/libdriver/base/rollup.c create mode 100644 linux/libdriver/base/rollup.h create mode 100644 linux/libdriver/base/yield-driver-api.h create mode 100644 linux/libdriver/doc/Doxyfile create mode 100644 linux/libdriver/doc/DoxygenLayout.xml create mode 100644 linux/libdriver/examples/abi.c create mode 100644 linux/libdriver/examples/abi_decode_000.c create mode 100644 linux/libdriver/examples/abi_decode_001.c create mode 100644 linux/libdriver/examples/abi_encode_000.c create mode 100644 linux/libdriver/examples/abi_encode_001.c create mode 100644 linux/libdriver/examples/abi_encode_002.c create mode 100644 linux/libdriver/examples/abi_get.c create mode 100644 linux/libdriver/examples/abi_multi.c create mode 100644 linux/libdriver/examples/rollup-driver.c create mode 100644 linux/libdriver/examples/rollup.c create mode 100644 linux/libdriver/examples/yield-driver.c create mode 100644 linux/libdriver/ioctl/rollup-driver.c create mode 100644 linux/libdriver/ioctl/rollup-driver.h create mode 100644 linux/libdriver/ioctl/yield-driver.c create mode 100644 linux/libdriver/ioctl/yield-driver.h create mode 100644 linux/libdriver/mock/rollup-driver.c create mode 100644 linux/libdriver/mock/rollup-driver.h create mode 100644 linux/libdriver/mock/yield-driver.c create mode 100644 linux/libdriver/mock/yield-driver.h create mode 100644 linux/libdriver/tests/abi.c create mode 100644 linux/libdriver/tests/keccak.c create mode 100644 linux/libdriver/tests/merkle.c create mode 100644 linux/libdriver/tools/funsel.c create mode 100644 linux/libdriver/tools/merkle-zero-table.c diff --git a/Dockerfile b/Dockerfile index 0f833da3..5dfa513d 100644 --- a/Dockerfile +++ b/Dockerfile @@ -60,6 +60,10 @@ RUN cd ${BUILD_BASE}twuewand/rndaddentropy/ && \ # copy tools COPY linux/ ${BUILD_BASE}tools/linux/ +# build C/C++ libs +# ------------------------------------------------------------------------------ +RUN make -C ${BUILD_BASE}tools/linux/libdriver/ CROSS_COMPILE="" + # build C/C++ tools # ------------------------------------------------------------------------------ RUN make -C ${BUILD_BASE}tools/linux/xhalt/ CROSS_COMPILE="" xhalt.toolchain diff --git a/Makefile b/Makefile index 61465640..0c5aec0b 100644 --- a/Makefile +++ b/Makefile @@ -25,9 +25,9 @@ MACHINE_EMULATOR_TOOLS_TAR_GZ := machine-emulator-tools-$(MACHINE_EMULATOR_TOOL MACHINE_EMULATOR_TOOLS_DEB := machine-emulator-tools-$(MACHINE_EMULATOR_TOOLS_VERSION).deb MACHINE_EMULATOR_TOOLS_IMAGE := cartesi/machine-emulator-tools:$(MACHINE_EMULATOR_TOOLS_VERSION) -LINUX_SOURCES_VERSION ?= 5.15.63-ctsi-2 -LINUX_SOURCES_FILEPATH := dep/linux-$(LINUX_SOURCES_VERSION).tar.gz -LINUX_SOURCES_URLPATH := https://github.com/cartesi/linux/archive/refs/tags/v$(LINUX_SOURCES_VERSION).tar.gz +LINUX_SOURCES_VERSION ?= rollup-rework +LINUX_SOURCES_FILEPATH := dep/$(LINUX_SOURCES_VERSION).tar.gz +LINUX_SOURCES_URLPATH := https://github.com/cartesi/linux/archive/refs/heads/feature/$(LINUX_SOURCES_VERSION).tar.gz RNDADDENTROPY_VERSION ?= 3.0.0 RNDADDENTROPY_FILEPATH := dep/twuewand-$(RNDADDENTROPY_VERSION).tar.gz diff --git a/linux/htif/Makefile b/linux/htif/Makefile index 44ba8a82..a72ad55f 100644 --- a/linux/htif/Makefile +++ b/linux/htif/Makefile @@ -27,7 +27,8 @@ RVCXX = $(CROSS_COMPILE)g++ RVCOPY = $(CROSS_COMPILE)objcopy RVDUMP = $(CROSS_COMPILE)objdump STRIP = $(CROSS_COMPILE)strip -RISCV_CFLAGS :=-march=$(RISCV_ARCH) -mabi=$(RISCV_ABI) +CFLAGS := -O2 -Wall -pedantic -march=$(RISCV_ARCH) -mabi=$(RISCV_ABI) -I../libdriver/ioctl +LDLIBS := -L../libdriver -ldriver CONTAINER_MAKE := /usr/bin/make CONTAINER_BASE := /opt/cartesi/tools @@ -42,7 +43,7 @@ extra.ext2: yield $(MAKE) toolchain-exec CONTAINER_COMMAND="$(CONTAINER_MAKE) $@.toolchain" yield.toolchain: - $(RVCC) -O2 -o yield yield.c + $(RVCC) $(CFLAGS) -o yield yield.c $(LDLIBS) $(STRIP) yield extra.ext2.toolchain: diff --git a/linux/libdriver/Makefile b/linux/libdriver/Makefile new file mode 100644 index 00000000..06935614 --- /dev/null +++ b/linux/libdriver/Makefile @@ -0,0 +1,103 @@ +CC := $(CROSS_COMPILE)gcc +AR := $(CROSS_COMPILE)ar +CFLAGS := -O2 -g -Wall -pedantic + +#all: mock tests +#mock: libmock.a $(mock_BINS) +#ioctl: libioctl.a $(ioctl_BINS) +#tests: tests/abi tests/keccak tests/merkle +#tools: tools/merkle-zero-table tools/funsel + +help: + @echo "Cleaning targets:" + @echo " clean - remove the binaries and objects." + @echo " mock - build a reference mock library and examples for running in host mode." + @echo " ioctl - build the actual ioctl library and examples." + @echo " tools - build additional utilities for development." + @echo " with CROSS_COMPILE=" + +mock: libmock.a mock/yield mock/rollup-driver mock/rollup +ioctl: libioctl.a ioctl/yield ioctl/rollup-driver ioctl/rollup +tests: tests/abi tests/keccak tests/merkle + tests/abi + tests/keccak + tests/merkle + +base_SRC := \ + base/buf.c \ + base/abi.c \ + base/keccak.c \ + base/merkle.c \ + base/rollup.c + +libmock_SRC := \ + mock/rollup-driver.c \ + mock/yield-driver.c \ + $(base_SRC) + +libioctl_SRC := \ + ioctl/rollup-driver.c \ + ioctl/yield-driver.c \ + $(base_SRC) + +libmock_OBJDIR := build/libmock/ +libioctl_OBJDIR := build/libioctl/ + +libmock_OBJ := $(patsubst %.c,$(libmock_OBJDIR)%.o,$(libmock_SRC)) +libioctl_OBJ := $(patsubst %.c,$(libioctl_OBJDIR)%.o,$(libioctl_SRC)) + +OBJ := $(libmock_OBJ) $(libioctl_OBJ) + +$(libmock_OBJ): $(libmock_OBJDIR)%.o: %.c + @mkdir -p $(@D) + $(CC) $(CFLAGS) -Imock -MT $@ -MMD -MP -MF $(@:.o=.d) -c -o $@ $< + +$(libioctl_OBJ): $(libioctl_OBJDIR)%.o: %.c + @mkdir -p $(@D) + $(CC) $(CFLAGS) -Iioctl -MT $@ -MMD -MP -MF $(@:.o=.d) -c -o $@ $< + +libmock.a: $(libmock_OBJ) + $(AR) rcs $@ $^ + +libioctl.a: $(libioctl_OBJ) + $(AR) rcs $@ $^ + +ioctl/yield-driver: examples/yield-driver.c libioctl.a + $(CC) $(CFLAGS) -Iioctl -o $@ $^ +ioctl/merkle: examples/merkle.c libmock.a + $(CC) $(CFLAGS) -Iioctl -o $@ $^ +ioctl/rollup-driver: examples/rollup-driver.c libioctl.a + $(CC) $(CFLAGS) -Iioctl -o $@ $^ + +mock/yield-driver: examples/yield-driver.c libmock.a + $(CC) $(CFLAGS) -Imock -o $@ $^ +mock/rollup-driver: examples/rollup-driver.c libmock.a + $(CC) $(CFLAGS) -Imock -o $@ $^ +mock/rollup: examples/rollup.c libmock.a + $(CC) $(CFLAGS) -Imock -o $@ $^ + +tests/abi: tests/abi.c libmock.a + $(CC) $(CFLAGS) -Imock -o $@ $^ +tests/keccak: tests/keccak.c libmock.a + $(CC) $(CFLAGS) -Imock -o $@ $^ +tests/merkle: tests/merkle.c libmock.a + $(CC) $(CFLAGS) -Imock -o $@ $^ + +tools/merkle-zero-table: tools/merkle-zero-table.c base/keccak.o + $(CC) $(CFLAGS) -Imock -o $@ $^ +tools/funsel: tools/funsel.c base/keccak.o + $(CC) $(CFLAGS) -Imock -o $@ $^ + +doc: doc/theme + doxygen doc/Doxyfile +doc/theme: + git clone --depth=1 --branch=v2.2.1 \ + git@github.com:jothepro/doxygen-awesome-css.git $@ +clean: + rm -f libmock.a $(mock_BINS) libioctl.a $(ioctl_BINS) $(OBJ) $(OBJ:%.o=%.d) + rm -rf doc/html +distclean: + rm -rf doc/theme +.PHONY: doc + +-include $(OBJ:%.o=%.d) diff --git a/linux/libdriver/README.md b/linux/libdriver/README.md new file mode 100644 index 00000000..e1c5ea82 --- /dev/null +++ b/linux/libdriver/README.md @@ -0,0 +1,16 @@ +Utility functions for rollup interaction. + +- @ref libevm\_rollup +- @ref libevm\_abi +- @ref libevm\_buf +- @ref libevm\_keccak +- @ref libevm\_merkle + +Thin wrappers to the cartesi kernel drivers + +- @ref rollup\_driver +- @ref yield\_driver + +# Getting Started + +Download the static library from [cartesi tools](https://github.com/cartesi/machine-emulator-tools/). diff --git a/linux/libdriver/base/abi.c b/linux/libdriver/base/abi.c new file mode 100644 index 00000000..38ea5887 --- /dev/null +++ b/linux/libdriver/base/abi.c @@ -0,0 +1,237 @@ +#include +#include +#include "abi.h" + +uintptr_t align(uintptr_t p, size_t a) +{ + return (p + (a-1)) & ~(a-1); +} + +uint32_t evm_abi_funsel(uint8_t a, uint8_t b, uint8_t c, uint8_t d) +{ + return EVM_ABI_FUNSEL(a, b, c, d); +} + +int evm_abi_put_funsel(evm_buf_t *me, uint32_t funsel) +{ + int rc; + evm_buf_t x[1]; + if ((rc = evm_buf_split(me, sizeof(funsel), x, me))) + return rc; + memcpy(x->p, &funsel, sizeof(funsel)); + return 0; +} + +int evm_abi_enc_uint_nr(size_t n, const uint8_t data[n], uint8_t out[EVM_WORD_LEN]) +{ + if (n > EVM_WORD_LEN) return EDOM; + + for (int i=0; i EVM_WORD_LEN) return EDOM; + + for (int i=0; i EVM_WORD_LEN) return EDOM; + + for (int i=0; i EVM_WORD_LEN) return EDOM; + + for (int i=0; i EVM_WORD_LEN) + return -EDOM; + if (evm_buf_split(me, EVM_WORD_LEN, &x, me)) + return -ENOBUFS; + + evm_abi_enc_uint(n, data, x.p); + return 0; +} + +int evm_abi_put_bool(evm_buf_t *me, bool value) +{ + uint8_t boolean = !!value; + return evm_abi_put_uint(me, sizeof(boolean), &boolean); +} + +int evm_abi_put_address(evm_buf_t *me, const uint8_t data[20]) +{ + evm_buf_t x; + + if (evm_buf_split(me, EVM_WORD_LEN, &x, me)) + return -ENOBUFS; + + evm_abi_enc_uint_nn(EVM_ADDRESS_LEN, data, x.p); + return 0; +} + +int evm_abi_put_bytes_s(evm_buf_t *me, evm_buf_t *offset) +{ + return evm_buf_split(me, EVM_WORD_LEN, offset, me); +} + +int evm_abi_res_bytes_d(evm_buf_t *me, evm_buf_t *of, size_t n, evm_buf_t *out, const void *start) +{ + int rc; + evm_buf_t tmp[1], sz[1]; + size_t n32 = align(n, EVM_WORD_LEN); + + if ((rc = evm_buf_split(me, EVM_WORD_LEN, sz, tmp))) + return rc; + if ((rc = evm_buf_split(tmp, n32, out, tmp))) + return rc; + + size_t offset = sz->p - (uint8_t *)start; + if ((rc = evm_abi_enc_uint(sizeof(offset), &offset, of->p))) + return rc; + if ((rc = evm_abi_enc_uint(sizeof(n), &n, sz->p))) + return rc; + + *me = *tmp; // commit + memset(out->p + n, 0, n32 - n); + return 0; +} + +int evm_abi_put_bytes_d(evm_buf_t *me, evm_buf_t *offset, size_t n, const void *data, const void *start) +{ + int rc; + evm_buf_t res[1]; + + if ((rc = evm_abi_res_bytes_d(me, offset, n, res, start))) + return rc; + + memcpy(res->p, data, n); + return 0; +} + +uint32_t evm_abi_peek_funsel(evm_buf_t *me) +{ + if (evm_buf_length(me) < 4) + return 0; + return EVM_ABI_FUNSEL(me->p[0], me->p[1], me->p[2], me->p[3]); +} + +int evm_abi_check_funsel(evm_buf_t *me, uint32_t expected) +{ + if (evm_buf_length(me) < 4) + return ENOBUFS; + + if (evm_abi_peek_funsel(me) != expected) + return EBADMSG; + + me->p += 4; + return 0; +} + +int evm_abi_get_uint(evm_buf_t *me, size_t n, void *data) +{ + evm_buf_t x[1]; + + if (n > EVM_WORD_LEN) + return -EDOM; + int rc = evm_buf_split(me, EVM_WORD_LEN, x, me); + if (rc) + return rc; + return evm_abi_dec_uint(x->p, n, data); +} + +int evm_abi_get_bool(evm_buf_t *me, bool *value) +{ + uint8_t boolean = 0; + int rc = evm_abi_put_uint(me, sizeof(boolean), &boolean); + if (rc) + return rc; + *value = boolean; + return 0; +} + +int evm_abi_get_address(evm_buf_t *me, uint8_t address[EVM_ADDRESS_LEN]) +{ + evm_buf_t x[1]; + + int rc = evm_buf_split(me, EVM_WORD_LEN, x, me); + if (rc) + return rc; + return evm_abi_dec_uint_nn(x->p, EVM_ADDRESS_LEN, address); +} + +int evm_abi_get_bytes_s(evm_buf_t *me, evm_buf_t of[1]) +{ + return evm_buf_split(me, EVM_WORD_LEN, of, me); +} + +int evm_abi_peek_bytes_d(const evm_buf_t *start, evm_buf_t of[1], evm_buf_t *bytes) +{ + int rc; + uint64_t offset, size; + if ((rc = evm_abi_get_uint(of, sizeof(offset), &offset))) + return rc; + + /* from the beginning, after funsel */ + evm_buf_t it[1] = {{start->p + offset, start->q}}; + if ((rc = evm_abi_get_uint(it, sizeof(size), &size))) + return rc; + return evm_buf_split(it, size, bytes, it); +} + +int evm_abi_get_bytes_d(const evm_buf_t *me, evm_buf_t of[1], size_t *n, void **data) +{ + evm_buf_t bytes[1]; + int rc = evm_abi_peek_bytes_d(me, of, bytes); + if (rc) + return rc; + *n = evm_buf_length(bytes); + *data = bytes->p; + return 0; +} diff --git a/linux/libdriver/base/abi.h b/linux/libdriver/base/abi.h new file mode 100644 index 00000000..c8991ae8 --- /dev/null +++ b/linux/libdriver/base/abi.h @@ -0,0 +1,394 @@ +/** @file + * @defgroup libevm_abi abi + * + * This is a C library to encode and decode Ethereum Virtual Machine (EVM) + * calldata. This format is used to interacts with contracts in the Ethereum + * ecosystem. + * + * We will cover the basic concepts required to use the API we provide, but for + * a complete reference consult the solidity specification, it can be found + * here: https://docs.soliditylang.org/en/latest/abi-spec.html + * + * ## Function Selector {#funsel} + * + * 4 bytes that identify the function name and parameter types. This is used to + * distinguish between different formats. To compute it, take the four first + * bytes of the `keccak` digest of the solidity function declaration. It should + * respect a canonical format and such as having no the variable names, check + * docs for details. For reference, for a hypotetical "FunctionName" function, + * it should look something like this: + * `keccak("FunctionName(type1,type2,...,typeN)");` + * + * ## Data Sections {#sections} + * + * After the function selector, we can start encoding the function parameters. + * One by one, left to right in two sections. `Static` for fixed sized values. + * Think ints, bools, addresses, offsets, etc. Then `Dynamic` for variable + * sized data such as the contents of @b bytes. Values that need a dynamic + * section will also have an entry in the static section. + * + * ### Static Section {#static-section} + * + * [uint](@ref evm_abi_put_uint), [bool](@ref evm_abi_put_bool) and + * [address](@ref evm_abi_put_address) values are encoded directly in the + * static section. In addition to those, @b bytes gets an entry in both + * sections. The static part is done with [this](@ref evm_abi_put_bytes_s) call. + * + * ### Dynamic Section {#dynamic-section} + * + * The Dynamic section encodes the contents of variable sized types. Every entry + * in this section requires a corresponding entry in the static section as well. + * + * So types with variable size are encoded in both sections. + * + * - `static` section gets some kind of reference / offset to the dynamic section. + * - `dynamic` section gets the actual contents + * + * In more concrete terms, the @b bytes type is encoded first with a call to @ref + * evm_abi_put_bytes_s for its `static` section part and then with a call to + * @ref evm_abi_put_bytes_d for its `dynamic` section part. + * + * ## Encoder + * + * Lets look at some code starting with a simple case. A function that encodes + * the function selector and a signle @b address value into the buffer: + * + * @includelineno "examples/abi_encode_000.c" + * + * We need both sections for encoding @b bytes. static and dynamic. + * + * @includelineno "examples/abi_encode_001.c" + * + * We do entreis in order when we have multiple values in the dynamic section. + * + * @includelineno "examples/abi_encode_002.c" + * + * ## Decoder + * + * Lets look at code that decodes the examples above. We'll _check_ instead of + * _put_ for funsel. And _get_ instead _put_ for most of everything else. + * + * @includelineno "examples/abi_decode_000.c" + * + * Retrieving @b bytes is a bit different since the API doesn't do dynamic + * memory allocation. @b data points inside the @p rd buffer itself, into its + * dynamic section. This makes the API very lightweight and fast but requires + * care in its usage. If @p rd gets free'd or reused while there is still a + * reference to @p data, we'll get memory corruption. If in doublt create a + * copy of @p data and use it instead. + * + * @includelineno "examples/abi_decode_001.c" + * + * ## Complete + * + * Lets look at some code on how to tie everything together. We'll build a @b + * echo of sorts that decodes the contents of @p rd and re-encodes it into @p + * wr. First we'll take two of the previous encode/decode examples as a + * starting point. We'll add the suffix 000 and 001 to disambiguate them. We'll + * use the @ref evm_abi_peek_funsel in our new @p decode function to decide + * which of the two message types we got and how to handle it. + * + * @includelineno "examples/abi_multi.c" + * + * @ingroup libevm + * @{ */ +#ifndef EVM_ABI_H +#define EVM_ABI_H +#include +#include"buf.h" + +enum { + EVM_WORD_LEN = 32, /**< length of a evm word in bytes */ + EVM_ADDRESS_LEN = 20, /**< length of a evm address in bytes */ +}; + + +/** Compile time equivalent to @ref evm_abi_funsel + * @note don't port. use @ref evm_abi_funsel instead */ +#if __BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__ +#define EVM_ABI_FUNSEL(A, B, C, D) \ + ( ((uint32_t)(D) << 000) \ + | ((uint32_t)(C) << 010) \ + | ((uint32_t)(B) << 020) \ + | ((uint32_t)(A) << 030)) +#else +#define EVM_ABI_FUNSEL(A, B, C, D) \ + ( ((uint32_t)(A) << 000) \ + | ((uint32_t)(B) << 010) \ + | ((uint32_t)(C) << 020) \ + | ((uint32_t)(D) << 030)) +#endif + +// put section --------------------------------------------------------------- + +/** Create a function selector from an array of bytes + * @param [in] funsel function selector bytes + * @return + * - function selector converted to big endian (as expected by EVM) */ +uint32_t +evm_abi_funsel(uint8_t a, uint8_t b, uint8_t c, uint8_t d); + +/** Encode a function selector into the buffer @p me + * + * @param [in,out] me a initialized buffer working as iterator + * @param [in] funsel function selector + * + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * + * @note A function selector can be compute it with: @ref evm_keccak_funsel. + * It is always represented in big endian. */ +int +evm_abi_put_funsel(evm_buf_t *me, uint32_t funsel); + +/** Encode a unsigned integer of up to 32bytes of data into the buffer + * + * @param [in,out] me a initialized buffer working as iterator + * @param [in] n size of @p data in bytes + * @param [in] data poiter to a integer + * + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * - EDOM requested @p n is too large + * + * @code + * ... + * evm_buf_t it = ...; + * uint64_t x = UINT64_C(0xdeadbeef); + * evm_abi_put_uint(&it, sizeof x, &x); + * ... + * @endcode + * @note This function takes care of endianess conversions */ +int +evm_abi_put_uint(evm_buf_t *me, size_t n, const void *data); + +/** Encode a bool into the buffer + * + * @param [in,out] me a initialized buffer working as iterator + * @param [in] value boolean value + * + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * + * @code + * ... + * evm_buf_t it = ...; + * evm_abi_put_bool(&it, true); + * ... + * @endcode + * @note This function takes care of endianess conversions */ +int +evm_abi_put_bool(evm_buf_t *me, bool value); + +/** Encode @p address (exacly @ref EVM_ADDRESS_LEN bytes) into the buffer + * + * @param [in,out] me initialized buffer + * @param [in] address exactly @ref EVM_ADDRESS_LEN bytes + * + * @return + * - 0 success + * - ENOBUFS no space left in @p me */ +int +evm_abi_put_address(evm_buf_t *me, const uint8_t address[EVM_ADDRESS_LEN]); + +/** Encode the static part of @b bytes into the message, + * used in conjunction with @ref evm_abi_put_bytes_d + * + * @param [in,out] me initialized buffer + * @param [out] offset initialize for @ref evm_abi_put_bytes_d + * @return + * - 0 success + * - ENOBUFS no space left in @p me */ +int +evm_abi_put_bytes_s(evm_buf_t *me, evm_buf_t *offset); + +/** Encode the dynamic part of @b bytes into the message, + * used in conjunction with @ref evm_abi_put_bytes_d + * + * @param [in,out] me initialized buffer + * @param [in] offset initialized from @ref evm_abi_put_bytes_h + * @param [in] n size of @b data + * @param [in] data array of bytes + * @param [in] start starting point for offset calculation (first byte after funsel) + * @return + * - 0 success + * - ENOBUFS no space left in @p me */ +int +evm_abi_put_bytes_d(evm_buf_t *me, evm_buf_t *offset + ,size_t n, const void *data, const void *start); + +/** Reserve @b n bytes of data from the buffer into @b res to be filled by the + * caller + * + * @param [in,out] me initialized buffer + * @param [in] n amount of bytes to reserve + * @param [out] res slice of bytes extracted from @p me + * @param [in] start starting point for offset calculation (first byte after funsel) + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * + * @note @p me must outlive @p res. + * Create a duplicate otherwise */ +int +evm_abi_res_bytes_d(evm_buf_t *me, evm_buf_t *of, size_t n, evm_buf_t *out, const void *start); + +// get section --------------------------------------------------------------- + +/** Read the funsel without consuming it from the buffer @p me + * + * @param [in] me initialized buffer + * @return + * - The function selector + * + * @code + * ... + * if (evm_buf_length(it) < 4) + * return EXIT_FAILURE; + * switch (evm_abi_peek_funsel(it) { + * case EVM_ABI_FUNSEL(...): // known type, try to parse it + * case EVM_ABI_FUNSEL(...): // known type, try to parse it + * default: + * return EXIT_FAILURE; + * } + * @endcode + * + * @note user must ensure there are at least 4 bytes in the buffer. + * This function will fail and return 0 if that is not the case. */ +uint32_t +evm_abi_peek_funsel(evm_buf_t *me); + +/** Consume funsel from the buffer @p me and ensure it matches @p expected_funsel + * + * @param [in,out] me initialized buffer + * @param [in] expected expected function selector + * + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * - EBADMSG in case of a missmatch */ +int +evm_abi_check_funsel(evm_buf_t *me, uint32_t expected); + +/** Decode a unsigned integer of up to 32bytes from the buffer + * + * @param [in,out] me initialized buffer + * @param [in] n size of @p data in bytes + * @param [out] data pointer to a integer + * + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * - EDOM value won't fit into @p n bytes. */ +int +evm_abi_get_uint(evm_buf_t *me, size_t n, void *data); + +/** Consume and decode @b address from the buffer + * + * @param [in,out] me initialized buffer + * @param [out] address exactly 20 bytes + * + * @return + * - 0 success + * - ENOBUFS requested size @b n is not available */ +int +evm_abi_get_address(evm_buf_t *me, uint8_t address[EVM_ADDRESS_LEN]); + +/** Consume and decode the offset @p of + * + * @param [in,out] me initialized buffer + * @param [out] of offset to @p bytes data, for use in conjunction with @ref evm_abi_get_bytes_d + * @return + * - 0 success + * - ENOBUFS no space left in @p me */ +int +evm_abi_get_bytes_s(evm_buf_t *me, evm_buf_t of[1]); + +/** Decode @b bytes from the buffer by taking a pointer to its contents. + * + * @param [in] start initialized buffer (from the start after funsel) + * @param [out] of offset to @p bytes data + * @param [out] n amount of data available in @b bytes + * @param [out] bytes memory range with contents + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * @note @p of can be initialized by calling @ref evm_abi_get_bytes_s */ +int +evm_abi_get_bytes_d(const evm_buf_t *start, evm_buf_t of[1], size_t *n, void **bytes); + +/** Decode @b bytes from the buffer by taking a pointer to its contents. + * + * @param [in] start initialized buffer (from the start after funsel) + * @param [out] of offset to @p bytes data + * @param [out] n amount of data available in @b bytes + * @param [out] bytes memory range with contents + * @return + * - 0 success + * - ENOBUFS no space left in @p me + * @note @p of can be initialized by calling @ref evm_abi_get_bytes_s */ +int +evm_abi_peek_bytes_d(const evm_buf_t *start, evm_buf_t of[1], evm_buf_t *bytes); + +// raw enc/dec section -------------------------------------------------------- + +/** Encode @p n bytes of @p data into @p out (up to 32). + * + * @param [in] n size of @p data in bytes + * @param [in] data integer value to encode into @p out + * @param [out] out encoded result + * @return + * - 0 success + * - EDOM @p n is too large. */ +int evm_abi_enc_uint(size_t n, const void *data, uint8_t out[EVM_WORD_LEN]); + +/** Encode @p n bytes of @p data into @p out (up to 32) in reverse order. + * + * @param [in] n size of @p data in bytes + * @param [in] data integer value to encode into @p out + * @param [out] out encoded result + * @return + * - 0 success + * - EDOM @p n is too large. + * @note use @ref evm_abi_enc_uint instead */ +int evm_abi_enc_uint_nr(size_t n, const uint8_t data[n], uint8_t out[EVM_WORD_LEN]); + +/** Encode @p n bytes of @p data into @p out (up to 32) in normal order. + * + * @param [in] n size of @p data in bytes + * @param [in] data integer value to encode into @p out + * @param [out] out encoded result + * @return + * - 0 success + * - EDOM @p n is too large. + * @note use @ref evm_abi_enc_uint instead */ +int evm_abi_enc_uint_nn(size_t n, const uint8_t data[n], uint8_t out[EVM_WORD_LEN]); + +/** Decode @p n bytes of @p data into @p out (up to 32). + * + * @param [in] data integer value to decode into @p out + * @param [in] n size of @p data in bytes + * @param [out] out decoded output */ +int evm_abi_dec_uint(const uint8_t data[EVM_WORD_LEN], size_t n, uint8_t out[n]); + +/** Decode @p n bytes of @p data into @p out (up to 32) in reverse order. + * + * @param [in] data integer value to decode into @p out + * @param [in] n size of @p data in bytes + * @param [out] out decoded output + * @note if in doubt, use @ref evm_abi_dec_uint */ +int evm_abi_dec_uint_nr(const uint8_t data[EVM_WORD_LEN], size_t n, uint8_t out[n]); + +/** Decode @p n bytes of @p data into @p out (up to 32) in normal order. + * + * @param [in] data integer value to decode into @p out + * @param [in] n size of @p data in bytes + * @param [out] out decoded output + * @note if in doubt, use @ref evm_abi_dec_uint */ +int evm_abi_dec_uint_nn(const uint8_t data[EVM_WORD_LEN], size_t n, uint8_t out[n]); + +#endif /* EVM_ABI_H */ +/** @} */ diff --git a/linux/libdriver/base/buf.c b/linux/libdriver/base/buf.c new file mode 100644 index 00000000..050d241c --- /dev/null +++ b/linux/libdriver/base/buf.c @@ -0,0 +1,50 @@ +#include +#include +#include +#include +#include"buf.h" + +void evm_buf_init(evm_buf_t *me, size_t n, void *data) +{ + assert(me); + me->p = (uint8_t *)data; + me->q = (uint8_t *)data + n; +} +int evm_buf_split(const evm_buf_t *me, size_t n, evm_buf_t *lhs, evm_buf_t *rhs) +{ + assert(me); + lhs->p = me->p; + lhs->q = rhs->p = me->p + n; + rhs->q = me->q; + + return lhs->q > me->q? -ENOBUFS : 0; +} + +size_t evm_buf_length(const evm_buf_t *me) +{ + assert(me); + return me->q - me->p; +} + +static void xxd(const uint8_t *p, const uint8_t *q, int mask) +{ + if (q < p) return; + + for (size_t i=0u, n = q - p; i < n; ++i) { + bool is_line_start = (i & mask) == 0; + bool is_line_end = (i & mask) == mask || (i+1 == n); + char separator = is_line_end? '\n' : ' '; + + if (is_line_start) printf("%p %4zu: ", (void *)(p + i), i); + printf("%02x%c", p[i], separator); + } +} +void evm_buf_xxd(void *p, void *q, int l) +{ + assert(p); + assert(q); + assert(p <= q); + assert((l & (l-1)) == 0 && "l is required to be a power of 2"); + + xxd(p, q, l-1); +} diff --git a/linux/libdriver/base/buf.h b/linux/libdriver/base/buf.h new file mode 100644 index 00000000..4f525d57 --- /dev/null +++ b/linux/libdriver/base/buf.h @@ -0,0 +1,72 @@ +/** @file + * @defgroup libevm_buf buf + * slice of contiguous memory + * + * @ingroup libevm + * @{ */ +#ifndef EVM_BUF_H +#define EVM_BUF_H +#include +#include + +/** A slice of contiguous memory from @b p to @b q. + * Size can be taken with: `q - p`. */ +typedef struct { + uint8_t *p; /**< start of memory region */ + uint8_t *q; /**< end of memory region */ +} evm_buf_t; + +/** Declare a evm_buf_t with stack backed memory. + * @param [in] N - size in bytes + * @note don't port */ +#define EVM_BUF_DECL(S, N) evm_buf_t S[1] = {{ \ + .p = (uint8_t [N]){0}, \ + .q = (S)->p + N, \ + }} + +/** Declare a evm_buf_t with parameters backed memory. + * @param [in] N - size in bytes + * @note don't port */ +#define EVM_BUF_DECL3(S, N, P) evm_buf_t S[1] = {{ \ + .p = P, \ + .q = (S)->p + N, \ + }} + +/** Initialize @p me buffer backed by @p data, @p n bytes in size + * + * @param [out] me a uninitialized instance + * @param [in] n size in bytes of @b data + * @param [in] data the backing memory to be used. + * + * @note @p data memory must outlive @p me. + * user must copy the contents otherwise */ +void evm_buf_init(evm_buf_t *me, size_t n, void *data); + +/** Split a buffer in two, @b lhs with @b n bytes and @b rhs with the rest + * + * @param [in,out] me initialized buffer + * @param [in] n bytes in @b lhs + * @param [out] lhs left hand side + * @param [out] rhs right hand side + * + * @return + * - 0 success + * - negative value on error. -ENOBUFS when len(lhs) < n. */ +int evm_buf_split(const evm_buf_t *me, size_t n, evm_buf_t *lhs, evm_buf_t *rhs); + +/** Length in bytes of @p me + * + * @param [in] me initialized buffer + * @return + * - size in bytes */ +size_t evm_buf_length(const evm_buf_t *me); + +/** Print the contents of @b me buffer to stdout + * + * @param [in] p start of memory region + * @param [in] q end of memory region + * @param [in] l bytes per line (must be a power of 2). */ +void evm_buf_xxd(void *p, void *q, int l); + +#endif /* EVM_BUF_H */ +/** @} */ diff --git a/linux/libdriver/base/keccak.c b/linux/libdriver/base/keccak.c new file mode 100644 index 00000000..acc82830 --- /dev/null +++ b/linux/libdriver/base/keccak.c @@ -0,0 +1,121 @@ +#include +#include"abi.h" +#include"keccak.h" + +#define ROTL64(x, y) \ + (((x) << (y)) | ((x) >> (64 - (y)))) + +static void +keccakf(uint64_t st[25]) +{ + const uint64_t keccakf_rndc[24] = { + 0x0000000000000001, 0x0000000000008082, 0x800000000000808a, + 0x8000000080008000, 0x000000000000808b, 0x0000000080000001, + 0x8000000080008081, 0x8000000000008009, 0x000000000000008a, + 0x0000000000000088, 0x0000000080008009, 0x000000008000000a, + 0x000000008000808b, 0x800000000000008b, 0x8000000000008089, + 0x8000000000008003, 0x8000000000008002, 0x8000000000000080, + 0x000000000000800a, 0x800000008000000a, 0x8000000080008081, + 0x8000000000008080, 0x0000000080000001, 0x8000000080008008 + }; + const int keccakf_rotc[24] = { + 1, 3, 6, 10, 15, 21, 28, 36, 45, 55, 2, 14, + 27, 41, 56, 8, 25, 43, 62, 18, 39, 61, 20, 44, + }; + const int keccakf_piln[24] = { + 10, 7, 11, 17, 18, 3, 5, 16, 8, 21, 24, 4, + 15, 23, 19, 13, 12, 2, 20, 14, 22, 9, 6, 1, + }; + + +#if __BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__ + for (int i = 0; i < 25; i++) { + st[i] = __builtin_bswap64((uint64_t *)(st[i])); + } +#endif + + for (int r = 0; r < 24; r++) { + uint64_t t, bc[5]; + + // Theta + for (int i = 0; i < 5; i++) + bc[i] = st[i] ^ st[i + 5] ^ st[i + 10] ^ st[i + 15] ^ st[i + 20]; + + for (int i = 0; i < 5; i++) { + t = bc[(i + 4) % 5] ^ ROTL64(bc[(i + 1) % 5], 1); + for (int j = 0; j < 25; j += 5) + st[j + i] ^= t; + } + + // Rho Pi + t = st[1]; + for (int i = 0; i < 24; i++) { + int j = keccakf_piln[i]; + bc[0] = st[j]; + st[j] = ROTL64(t, keccakf_rotc[i]); + t = bc[0]; + } + + // Chi + for (int j = 0; j < 25; j += 5) { + for (int i = 0; i < 5; i++) + bc[i] = st[j + i]; + for (int i = 0; i < 5; i++) + st[j + i] ^= (~bc[(i + 1) % 5]) & bc[(i + 2) % 5]; + } + + // Iota + st[0] ^= keccakf_rndc[r]; + } + +#if __BYTE_ORDER__ != __ORDER_LITTLE_ENDIAN__ + for (int i = 0; i < 25; i++) { + st[i] = __builtin_bswap64(*(uint64_t *)(&st[i])); + } +#endif +} + +void evm_keccak_init(evm_keccak_t *c) +{ + *c = (evm_keccak_t)EVM_KECCAK_INIT(c); +} + +void evm_keccak_update(evm_keccak_t *c, size_t n, const void *data) +{ + int j = c->pt; + for (size_t i = 0; i < n; i++) { + c->st.b[j++] ^= ((const uint8_t *) data)[i]; + if (j >= c->rsiz) { + keccakf(c->st.q); + j = 0; + } + } + c->pt = j; +} + +void evm_keccak_final(evm_keccak_t *c, void *md) +{ + c->st.b[c->pt] ^= 0x01; + c->st.b[c->rsiz - 1] ^= 0x80; + keccakf(c->st.q); + + for (int i = 0; i < EVM_KECCAK_MDLEN; i++) { + ((uint8_t *) md)[i] = c->st.b[i]; + } +} + +uint8_t *evm_keccak_data(size_t n, const void *data, uint8_t md[EVM_KECCAK_MDLEN]) +{ + EVM_KECCAK_DECL(c); + evm_keccak_update(c, n, data); + evm_keccak_final(c, md); + return md; +} + +uint32_t evm_keccak_funsel(const char *decl) +{ + uint8_t md[32]; + evm_keccak_data(strlen(decl), decl, md); + return EVM_ABI_FUNSEL(md[0], md[1], md[2], md[3]); +} + diff --git a/linux/libdriver/base/keccak.h b/linux/libdriver/base/keccak.h new file mode 100644 index 00000000..6dda7f8e --- /dev/null +++ b/linux/libdriver/base/keccak.h @@ -0,0 +1,131 @@ +/** @file + * @defgroup libevm_keccak keccak + * Keccak 256 digest + * + * Data can be inserted in pieces: + * @code + * ... + * uint8_t h[EVM_KECCAK_MDLEN]; + * evm_keccak_t st[1]; + * + * evm_keccak_init(st); + * evm_keccak_update(st, 1, "h"); + * evm_keccak_update(st, 1, "e"); + * evm_keccak_update(st, 1, "l"); + * evm_keccak_update(st, 1, "l"); + * evm_keccak_update(st, 1, "o"); + * evm_keccak_final(st, h); + * ... + * @endcode + * + * all at once: + * @code + * ... + * const char data[] = "hello"; + * uint8_t h[EVM_KECCAK_MDLEN]; + * evm_keccak_data(h, sizeof(data)-1, data); + * ... + * @endcode + * + * or with a specialized call to generate @ref funsel data: + * @code + * ... + * uint32_t funsel = evm_keccak_funsel("FunctionCall(address,bytes)"); + * ... + * @endcode + * + * Code based on https://github.com/mjosaarinen/tiny_sha3 with the sha3 to + * keccak change as indicated by this comment: + * https://github.com/mjosaarinen/tiny_sha3#updated-07-aug-15 + * + * @ingroup libevm + * @{ */ +#ifndef EVM_KECCAK_H +#define EVM_KECCAK_H +#include +#include + +/** Opaque Keccak state, used to do hash computations, initialize with: + * - @ref evm_keccak_init + * - @ref EVM_KECCAK_INIT + * - @ref EVM_KECCAK_DECL */ +typedef struct { + union { + uint8_t b[200]; + uint64_t q[25]; + } st; + int pt, rsiz; +} evm_keccak_t; + +/** Bytes in the hash digest */ +#define EVM_KECCAK_MDLEN 32 + +/** Initialize a keccak state + * @note don't port. use @ref evm_keccak_init */ +#define EVM_KECCAK_INIT(STATE) { \ + .st.q = { \ + 0, 0, 0, 0, 0, \ + 0, 0, 0, 0, 0, \ + 0, 0, 0, 0, 0, \ + 0, 0, 0, 0, 0, \ + 0, 0, 0, 0, 0, \ + }, \ + .pt = 0, \ + .rsiz = 200 - 2 * EVM_KECCAK_MDLEN, \ +} + +/** Declare and initialize a keccak state + * @note don't port. use @ref evm_keccak_init */ +#define EVM_KECCAK_DECL(NAME) evm_keccak_t NAME[1] = {EVM_KECCAK_INIT(NAME)} + +/** Initialize a @ref evm_keccak_t hasher state. + * + * @param [out] state uninitialized @ref evm_keccak_t */ +void evm_keccak_init(evm_keccak_t *state); + +/** Hash @b n bytes of @b data + * + * @param [in,out] state initialize the hasher state + * @param [in] n bytes in @b data to process + * @param [in] data data to hash */ +void evm_keccak_update(evm_keccak_t *state, size_t n, const void *data); + +/** Finalize the hash calculation from @b state and store it in @b md + * + * @param [in] state initialize the hasher state (with all data already added to it) + * @param [out] md 32bytes to store the computed hash */ +void evm_keccak_final(evm_keccak_t *state, void *md); + +/** Hash all @b n bytes of @b data at once + * + * @param [in] n - bytes in @b data to process + * @param [in] data - data to hash + * @param [out] md - 32bytes to store the computed hash + * @return pointer to @b md + * + * Equivalent to: + * @code + * evm_keccak_t st = EVM_KECCAK_INIT(&st); + * evm_keccak_update(&st, n, data); + * evm_keccak_final(&st, md); + * return md; + * @endcode */ +uint8_t *evm_keccak_data(size_t n, const void *data + ,uint8_t md[EVM_KECCAK_MDLEN]); + +/** Compute the function selector from the solidity declaration @p decl + * + * @param [in] decl solidity call declaration, without variable names + * @param [out] funsel function selector as described by @ref funsel + * @return A @p funsel value as if defined by @ref EVM_ABI_FUNSEL + * + * Example usage: + * @code + * ... + * uint32_t funsel = evm_keccak_funsel("FunctionCall(address,bytes)"); + * ... + * @endcode + */ +uint32_t evm_keccak_funsel(const char *decl); +#endif /* EVM_KECCAK_H */ +/** $@} */ diff --git a/linux/libdriver/base/merkle-zero-table.h b/linux/libdriver/base/merkle-zero-table.h new file mode 100644 index 00000000..1df5e7e8 --- /dev/null +++ b/linux/libdriver/base/merkle-zero-table.h @@ -0,0 +1,71 @@ +#ifndef EVM_MERKLE_ZERO_TABLE_H +#define EVM_MERKLE_ZERO_TABLE_H + +static const uint8_t evm_merkle_zero_table[][EVM_KECCAK_MDLEN] = { + {0x29,0x0d,0xec,0xd9,0x54,0x8b,0x62,0xa8,0xd6,0x03,0x45,0xa9,0x88,0x38,0x6f,0xc8,0x4b,0xa6,0xbc,0x95,0x48,0x40,0x08,0xf6,0x36,0x2f,0x93,0x16,0x0e,0xf3,0xe5,0x63}, + {0x63,0x3d,0xc4,0xd7,0xda,0x72,0x56,0x66,0x0a,0x89,0x2f,0x8f,0x16,0x04,0xa4,0x4b,0x54,0x32,0x64,0x9c,0xc8,0xec,0x5c,0xb3,0xce,0xd4,0xc4,0xe6,0xac,0x94,0xdd,0x1d}, + {0x89,0x07,0x40,0xa8,0xeb,0x06,0xce,0x9b,0xe4,0x22,0xcb,0x8d,0xa5,0xcd,0xaf,0xc2,0xb5,0x8c,0x0a,0x5e,0x24,0x03,0x6c,0x57,0x8d,0xe2,0xa4,0x33,0xc8,0x28,0xff,0x7d}, + {0x3b,0x8e,0xc0,0x9e,0x02,0x6f,0xdc,0x30,0x53,0x65,0xdf,0xc9,0x4e,0x18,0x9a,0x81,0xb3,0x8c,0x75,0x97,0xb3,0xd9,0x41,0xc2,0x79,0xf0,0x42,0xe8,0x20,0x6e,0x0b,0xd8}, + {0xec,0xd5,0x0e,0xee,0x38,0xe3,0x86,0xbd,0x62,0xbe,0x9b,0xed,0xb9,0x90,0x70,0x69,0x51,0xb6,0x5f,0xe0,0x53,0xbd,0x9d,0x8a,0x52,0x1a,0xf7,0x53,0xd1,0x39,0xe2,0xda}, + {0xde,0xff,0xf6,0xd3,0x30,0xbb,0x54,0x03,0xf6,0x3b,0x14,0xf3,0x3b,0x57,0x82,0x74,0x16,0x0d,0xe3,0xa5,0x0d,0xf4,0xef,0xec,0xf0,0xe0,0xdb,0x73,0xbc,0xdd,0x3d,0xa5}, + {0x61,0x7b,0xdd,0x11,0xf7,0xc0,0xa1,0x1f,0x49,0xdb,0x22,0xf6,0x29,0x38,0x7a,0x12,0xda,0x75,0x96,0xf9,0xd1,0x70,0x4d,0x74,0x65,0x17,0x7c,0x63,0xd8,0x8e,0xc7,0xd7}, + {0x29,0x2c,0x23,0xa9,0xaa,0x1d,0x8b,0xea,0x7e,0x24,0x35,0xe5,0x55,0xa4,0xa6,0x0e,0x37,0x9a,0x5a,0x35,0xf3,0xf4,0x52,0xba,0xe6,0x01,0x21,0x07,0x3f,0xb6,0xee,0xad}, + {0xe1,0xce,0xa9,0x2e,0xd9,0x9a,0xcd,0xcb,0x04,0x5a,0x67,0x26,0xb2,0xf8,0x71,0x07,0xe8,0xa6,0x16,0x20,0xa2,0x32,0xcf,0x4d,0x7d,0x5b,0x57,0x66,0xb3,0x95,0x2e,0x10}, + {0x7a,0xd6,0x6c,0x0a,0x68,0xc7,0x2c,0xb8,0x9e,0x4f,0xb4,0x30,0x38,0x41,0x96,0x6e,0x40,0x62,0xa7,0x6a,0xb9,0x74,0x51,0xe3,0xb9,0xfb,0x52,0x6a,0x5c,0xeb,0x7f,0x82}, + {0xe0,0x26,0xcc,0x5a,0x4a,0xed,0x3c,0x22,0xa5,0x8c,0xbd,0x3d,0x2a,0xc7,0x54,0xc9,0x35,0x2c,0x54,0x36,0xf6,0x38,0x04,0x2d,0xca,0x99,0x03,0x4e,0x83,0x63,0x65,0x16}, + {0x3d,0x04,0xcf,0xfd,0x8b,0x46,0xa8,0x74,0xed,0xf5,0xcf,0xae,0x63,0x07,0x7d,0xe8,0x5f,0x84,0x9a,0x66,0x04,0x26,0x69,0x7b,0x06,0xa8,0x29,0xc7,0x0d,0xd1,0x40,0x9c}, + {0xad,0x67,0x6a,0xa3,0x37,0xa4,0x85,0xe4,0x72,0x8a,0x0b,0x24,0x0d,0x92,0xb3,0xef,0x7b,0x3c,0x37,0x2d,0x06,0xd1,0x89,0x32,0x2b,0xfd,0x5f,0x61,0xf1,0xe7,0x20,0x3e}, + {0xa2,0xfc,0xa4,0xa4,0x96,0x58,0xf9,0xfa,0xb7,0xaa,0x63,0x28,0x9c,0x91,0xb7,0xc7,0xb6,0xc8,0x32,0xa6,0xd0,0xe6,0x93,0x34,0xff,0x5b,0x0a,0x34,0x83,0xd0,0x9d,0xab}, + {0x4e,0xbf,0xd9,0xcd,0x7b,0xca,0x25,0x05,0xf7,0xbe,0xf5,0x9c,0xc1,0xc1,0x2e,0xcc,0x70,0x8f,0xff,0x26,0xae,0x4a,0xf1,0x9a,0xbe,0x85,0x2a,0xfe,0x9e,0x20,0xc8,0x62}, + {0x2d,0xef,0x10,0xd1,0x3d,0xd1,0x69,0xf5,0x50,0xf5,0x78,0xbd,0xa3,0x43,0xd9,0x71,0x7a,0x13,0x85,0x62,0xe0,0x09,0x3b,0x38,0x0a,0x11,0x20,0x78,0x9d,0x53,0xcf,0x10}, + {0x77,0x6a,0x31,0xdb,0x34,0xa1,0xa0,0xa7,0xca,0xaf,0x86,0x2c,0xff,0xdf,0xff,0x17,0x89,0x29,0x7f,0xfa,0xdc,0x38,0x0b,0xd3,0xd3,0x92,0x81,0xd3,0x40,0xab,0xd3,0xad}, + {0xe2,0xe7,0x61,0x0b,0x87,0xa5,0xfd,0xf3,0xa7,0x2e,0xbe,0x27,0x12,0x87,0xd9,0x23,0xab,0x99,0x0e,0xef,0xac,0x64,0xb6,0xe5,0x9d,0x79,0xf8,0xb7,0xe0,0x8c,0x46,0xe3}, + {0x50,0x43,0x64,0xa5,0xc6,0x85,0x8b,0xf9,0x8f,0xff,0x71,0x4a,0xb5,0xbe,0x9d,0xe1,0x9e,0xd3,0x1a,0x97,0x68,0x60,0xef,0xbd,0x0e,0x77,0x2a,0x2e,0xfe,0x23,0xe2,0xe0}, + {0x4f,0x05,0xf4,0xac,0xb8,0x3f,0x5b,0x65,0x16,0x8d,0x9f,0xef,0x89,0xd5,0x6d,0x4d,0x77,0xb8,0x94,0x40,0x15,0xe6,0xb1,0xee,0xd8,0x1b,0x02,0x38,0xe2,0xd0,0xdb,0xa3}, + {0x44,0xa6,0xd9,0x74,0xc7,0x5b,0x07,0x42,0x3e,0x1d,0x6d,0x33,0xf4,0x81,0x91,0x6f,0xdd,0x45,0x83,0x0a,0xea,0x11,0xb6,0x34,0x7e,0x70,0x0c,0xd8,0xb9,0xf0,0x76,0x7c}, + {0xed,0xf2,0x60,0x29,0x1f,0x73,0x4d,0xda,0xc3,0x96,0xa9,0x56,0x12,0x7d,0xde,0x4c,0x34,0xc0,0xcf,0xb8,0xd8,0x05,0x2f,0x88,0xac,0x13,0x96,0x58,0xcc,0xf2,0xd5,0x07}, + {0x60,0x75,0xc6,0x57,0xa1,0x05,0x35,0x1e,0x7f,0x0f,0xce,0x53,0xbc,0x32,0x01,0x13,0x32,0x4a,0x52,0x2e,0x8f,0xd5,0x2d,0xc8,0x78,0xc7,0x62,0x55,0x1e,0x01,0xa4,0x6e}, + {0x6c,0xa6,0xa3,0xf7,0x63,0xa9,0x39,0x5f,0x7d,0xa1,0x60,0x14,0x72,0x5c,0xa7,0xee,0x17,0xe4,0x81,0x5c,0x0f,0xf8,0x11,0x9b,0xf3,0x3f,0x27,0x3d,0xee,0x11,0x83,0x3b}, + {0x1c,0x25,0xef,0x10,0xff,0xeb,0x3c,0x7d,0x08,0xaa,0x70,0x7d,0x17,0x28,0x6e,0x0b,0x0d,0x3c,0xbc,0xb5,0x0f,0x1b,0xd3,0xb6,0x52,0x3b,0x63,0xba,0x3b,0x52,0xdd,0x0f}, + {0xff,0xfc,0x43,0xbd,0x08,0x27,0x3c,0xcf,0x13,0x5f,0xd3,0xca,0xcb,0xee,0xf0,0x55,0x41,0x8e,0x09,0xeb,0x72,0x8d,0x72,0x7c,0x4d,0x5d,0x5c,0x55,0x6c,0xde,0xa7,0xe3}, + {0xc5,0xab,0x81,0x11,0x45,0x6b,0x1f,0x28,0xf3,0xc7,0xa0,0xa6,0x04,0xb4,0x55,0x3c,0xe9,0x05,0xcb,0x01,0x9c,0x46,0x3e,0xe1,0x59,0x13,0x7a,0xf8,0x3c,0x35,0x0b,0x22}, + {0x0f,0xf2,0x73,0xfc,0xbf,0x4a,0xe0,0xf2,0xbd,0x88,0xd6,0xcf,0x31,0x9f,0xf4,0x00,0x4f,0x8d,0x7d,0xca,0x70,0xd4,0xce,0xd4,0xe7,0x4d,0x2c,0x74,0x13,0x97,0x39,0xe6}, + {0x7f,0xa0,0x6b,0xa1,0x12,0x41,0xdd,0xd5,0xef,0xdc,0x65,0xd4,0xe3,0x9c,0x9f,0x69,0x91,0xb7,0x4f,0xd4,0xb8,0x1b,0x62,0x23,0x08,0x08,0x21,0x6c,0x87,0x6f,0x82,0x7c}, + {0x7e,0x27,0x5a,0xdf,0x31,0x3a,0x99,0x6c,0x7e,0x29,0x50,0xca,0xc6,0x7c,0xab,0xa0,0x2a,0x5f,0xf9,0x25,0xeb,0xf9,0x90,0x6b,0x58,0x94,0x9f,0x3e,0x77,0xae,0xc5,0xb9}, + {0x8f,0x61,0x62,0xfa,0x30,0x8d,0x2b,0x3a,0x15,0xdc,0x33,0xcf,0xfa,0xc8,0x5f,0x13,0xab,0x34,0x91,0x73,0x12,0x16,0x45,0xae,0xdf,0x00,0xf4,0x71,0x66,0x31,0x08,0xbe}, + {0x78,0xcc,0xaa,0xab,0x73,0x37,0x35,0x52,0xf2,0x07,0xa6,0x35,0x99,0xde,0x54,0xd7,0xd8,0xd0,0xc1,0x80,0x5f,0x86,0xce,0x7d,0xa1,0x58,0x18,0xd0,0x9f,0x4c,0xff,0x62}, + {0xcf,0x27,0x7f,0xb8,0x0a,0x82,0x47,0x84,0x60,0xe8,0x98,0x85,0x70,0xb7,0x18,0xf1,0xe0,0x83,0xce,0xb7,0x6f,0x7e,0x27,0x1a,0x1a,0x14,0x97,0xe5,0x97,0x5f,0x53,0xae}, + {0x4b,0xf6,0xff,0xa2,0xbc,0x13,0x12,0x04,0x51,0x32,0x89,0x73,0x85,0x67,0xa6,0x8f,0xa9,0xf4,0x82,0x7d,0xac,0x7f,0xd3,0xb3,0xd1,0xf2,0xe9,0x47,0x77,0xd5,0x7f,0x36}, + {0xb4,0x9d,0x61,0xe8,0xc2,0xc8,0x94,0xe1,0x24,0x86,0x17,0x6a,0xb8,0xf4,0xd7,0x06,0x9d,0x66,0x92,0xfa,0x64,0x95,0x54,0x15,0x67,0x87,0x2e,0x7e,0xcb,0xdd,0xb7,0x26}, + {0x20,0x2b,0x10,0x14,0x73,0x9f,0x29,0xb1,0xd9,0x05,0xd6,0x30,0xdd,0xeb,0x85,0x60,0xa3,0x2b,0xf2,0x3e,0x66,0x6c,0x8a,0x15,0x23,0xa4,0xa6,0x00,0x22,0x7f,0xef,0x7c}, + {0x9e,0x1d,0x1c,0xe5,0xcd,0xca,0x9c,0xdf,0x40,0xfa,0x57,0x86,0x54,0x8b,0x58,0xeb,0x19,0xdd,0xfd,0x32,0x39,0x5b,0x45,0x82,0x98,0x39,0x19,0x09,0x9d,0xbd,0x15,0x31}, + {0x13,0x78,0x4d,0x01,0xe2,0xfa,0xe9,0x04,0xde,0x62,0xc6,0xfb,0xf9,0x77,0x69,0x79,0xca,0x7a,0x27,0x77,0xae,0x26,0x32,0xee,0x27,0x8d,0x19,0xac,0xa3,0x0f,0x89,0x0e}, + {0x68,0xc4,0x77,0xf8,0x3a,0x13,0xa0,0x00,0xad,0x2b,0x5b,0x3e,0x50,0x37,0x5b,0x7c,0x3a,0xe7,0x82,0xd9,0x87,0xba,0x4b,0x5a,0x65,0x37,0x6b,0xbb,0x97,0x46,0x9f,0xb3}, + {0x71,0xe3,0x78,0x64,0xed,0xf0,0x87,0x40,0xd5,0x92,0x36,0x2c,0xd2,0x4d,0x0d,0xb0,0x67,0xbf,0x14,0xcd,0x3b,0x97,0xbd,0x2a,0x68,0xe7,0x82,0xad,0xff,0xb4,0x36,0x55}, + {0x88,0xd0,0xcc,0x35,0xe8,0xab,0xe7,0xd6,0x52,0x45,0x69,0xbe,0x8a,0xa1,0xa4,0x8b,0xb2,0x33,0x62,0x32,0x6f,0xdf,0xef,0xe9,0x61,0x34,0x8b,0xc9,0x60,0x91,0xc9,0x4c}, + {0x85,0x45,0xf2,0xc1,0xaf,0xda,0xce,0x5d,0x87,0xf0,0x6c,0xe1,0xd4,0x4b,0xc0,0xa2,0x69,0x1a,0xea,0x44,0x14,0xd0,0xad,0x64,0x0b,0xe0,0xd9,0x87,0x9c,0x83,0x74,0xd9}, + {0x23,0x60,0xc4,0x48,0x0d,0x69,0x87,0x9e,0xad,0xd7,0xae,0x50,0x84,0x09,0xf2,0xf0,0xba,0x83,0xa2,0xb0,0xfe,0x0d,0xa5,0x7b,0x40,0x00,0x8c,0x06,0x4d,0x2c,0x39,0x7d}, + {0x31,0x76,0x3a,0x8e,0x1d,0xed,0xb1,0x5a,0xd0,0xc8,0xb8,0x8d,0x43,0x7f,0xef,0x83,0x5a,0xeb,0x95,0x82,0x92,0x64,0x48,0x10,0x66,0x3d,0xc1,0x75,0x65,0x50,0xf2,0x2b}, + {0xfa,0x4c,0x9b,0x11,0x72,0xab,0x5a,0xfe,0xbd,0x15,0x95,0x73,0xe1,0x9e,0x25,0x16,0x99,0x75,0x24,0x2e,0x10,0xa2,0xed,0x38,0xdf,0xc8,0x05,0x23,0x2f,0xb5,0x0a,0x64}, + {0x35,0x28,0x59,0x4d,0x65,0xe9,0x52,0x52,0x33,0xb3,0x95,0x87,0x17,0x4b,0xcf,0x0b,0xba,0x56,0x2d,0x95,0xb5,0x0b,0x42,0x99,0x14,0xc7,0xe0,0xe8,0xa9,0xae,0x58,0xf9}, + {0x17,0x65,0x92,0x27,0x97,0xba,0x72,0x1e,0x89,0x37,0xc7,0x47,0x0a,0x26,0xd5,0xc2,0xf1,0x41,0xf3,0xd4,0x10,0x64,0x47,0xda,0xb1,0x71,0xfc,0xed,0x7d,0x65,0x2a,0x69}, + {0xf0,0x57,0x3e,0x66,0x0b,0xa0,0x1c,0xff,0x27,0x2a,0x1c,0x6f,0x79,0x27,0xd7,0x3c,0x94,0xc8,0x5d,0x38,0x0a,0x84,0x39,0x98,0x67,0x62,0x6d,0x64,0x29,0xd4,0x8b,0xae}, + {0x31,0x68,0x2c,0x19,0xf7,0x15,0xcd,0x31,0x7d,0xa1,0xa5,0x53,0xce,0x38,0x4d,0xe6,0x90,0x2f,0xe2,0x60,0x32,0xfe,0xcc,0x7d,0xe0,0x3e,0x40,0x50,0x2a,0xf0,0x5d,0xce}, + {0xd5,0x0c,0x60,0x62,0xbf,0xcd,0x7b,0xbd,0x0d,0xbd,0x68,0xd1,0xdd,0xee,0xae,0x09,0x54,0x85,0x72,0x0a,0x1c,0xe3,0x34,0xe9,0xe5,0xe5,0x15,0x30,0x66,0xf4,0x22,0x60}, + {0xe0,0xbc,0xfb,0xd0,0x3f,0xa4,0xa6,0x19,0xa5,0xbc,0x3c,0xae,0x15,0x40,0x4f,0x39,0xb4,0xb7,0xbf,0x5d,0xdd,0x51,0x61,0xea,0x64,0x2d,0x13,0xd2,0x3b,0xae,0xf5,0x45}, + {0xac,0xb9,0x8b,0x6f,0xb1,0xa5,0xfd,0xae,0x0a,0x57,0x18,0xd0,0xb8,0x12,0xe1,0xde,0x14,0x12,0xe4,0x4d,0x87,0x51,0x46,0xac,0xc1,0xa7,0xf7,0xc3,0x91,0x6c,0x00,0x3a}, + {0xbb,0x1f,0xf2,0x91,0xeb,0x2e,0x61,0x4a,0x66,0x1d,0x67,0x30,0xb5,0x02,0xba,0xe2,0xbd,0xe1,0x12,0x95,0x8c,0xee,0x69,0x84,0x78,0x84,0x5a,0x1b,0xb3,0x78,0x8a,0x6b}, + {0x9a,0x91,0xf4,0xc1,0x95,0x45,0xd6,0xcd,0x97,0x20,0xd4,0x73,0x65,0x91,0xfe,0x70,0xed,0xcf,0x3e,0x33,0xcb,0x2e,0x56,0xf2,0x1f,0xdc,0x12,0x44,0xf3,0xd2,0xef,0x6d}, + {0xbd,0xf8,0x2c,0x7d,0x25,0x2d,0x69,0xc6,0x4b,0xd6,0xfa,0x8e,0xe6,0x6a,0xd9,0xd3,0x02,0x41,0x01,0x69,0x81,0xe4,0x58,0x0e,0x3c,0x2e,0xdc,0x48,0x04,0xb7,0x52,0x36}, + {0x63,0xbc,0x3b,0x9e,0x83,0x40,0xab,0x48,0xa6,0x68,0x28,0xd7,0xd9,0xd7,0xd5,0xbe,0x2f,0x5f,0x28,0x06,0x65,0x19,0x6d,0x25,0xa3,0x9c,0x4d,0x01,0x34,0x5c,0xb9,0x5e}, + {0xa9,0x62,0xe4,0xbd,0x7d,0x1f,0x31,0x6f,0x84,0x57,0x84,0xe1,0x15,0xff,0x10,0x35,0x30,0xd8,0x5f,0x9d,0xfa,0xcd,0x63,0x8a,0xd4,0x5f,0xbe,0x93,0x8b,0xa8,0x5c,0x40}, + {0xb3,0xf1,0x00,0xa0,0xf5,0x06,0xf6,0xa6,0xc8,0x6c,0x10,0xf1,0x07,0xab,0x48,0x11,0xdd,0xc7,0x6f,0x72,0x51,0x6f,0xcd,0xfa,0x8a,0x0c,0x9b,0xd7,0x1f,0xf9,0x12,0xab}, + {0xe7,0xe8,0xdb,0xc3,0x89,0x85,0x15,0x97,0x0c,0xa6,0xfc,0xe1,0x90,0x39,0xca,0x22,0xae,0x26,0x38,0xe4,0x4b,0x24,0x64,0x1f,0xd6,0x10,0x48,0xb9,0x4d,0xc2,0xbe,0x25}, + {0x31,0xd0,0xf6,0x6a,0xb4,0x30,0x19,0x85,0x67,0x80,0xcb,0x24,0x6c,0xfd,0x37,0xb0,0xc1,0x90,0xd1,0x71,0x11,0xd5,0xc0,0x16,0xf1,0x9b,0xa7,0x15,0xee,0x62,0x2d,0xc5}, + {0xac,0xd2,0xf3,0xdf,0xd4,0x3e,0x9a,0x01,0xbc,0x64,0xa9,0xc4,0xac,0x8a,0xc8,0xa2,0xb2,0x9f,0x32,0x74,0x13,0x1a,0x12,0x01,0x0b,0x42,0xb8,0xc8,0x30,0xe8,0x79,0xbf}, + {0xa2,0x31,0x36,0x1a,0xd3,0x38,0x9f,0xe6,0xf2,0xb6,0x2a,0x46,0xcf,0x67,0x7d,0x6c,0x5f,0x7b,0x79,0x96,0x4c,0x30,0xa2,0xc3,0x4a,0xa4,0xfc,0x33,0x92,0xf5,0x01,0xc9}, + {0x14,0x0a,0xb4,0x9c,0xc3,0xbb,0x44,0xe3,0x42,0x65,0x5a,0x52,0x11,0x85,0x93,0x3b,0x22,0x30,0xec,0x27,0x4f,0xf5,0x30,0x4b,0x2c,0xea,0xd9,0x87,0x3a,0x82,0x28,0x63}, + {0x10,0xc7,0x10,0xf9,0x20,0x5b,0x30,0xe8,0xa7,0x16,0x3e,0xdb,0xfc,0xd8,0x5e,0x8f,0xba,0xf2,0xf3,0xfe,0x44,0x2f,0x2e,0xe4,0xaf,0x58,0x0e,0x28,0xb2,0xdf,0x11,0x80}, + {0x6f,0x35,0x41,0x9d,0x1d,0xa1,0x26,0x0b,0xc0,0xf3,0x3d,0x52,0xe8,0xf6,0xd7,0x3f,0xc5,0xd6,0x72,0xc0,0xdc,0xa1,0x3b,0xb9,0x60,0xb4,0xae,0x1a,0xde,0xc1,0x79,0x37}, +}; +#endif /* EVM_MERKLE_ZERO_TABLE_H */ diff --git a/linux/libdriver/base/merkle.c b/linux/libdriver/base/merkle.c new file mode 100644 index 00000000..dd14782f --- /dev/null +++ b/linux/libdriver/base/merkle.c @@ -0,0 +1,61 @@ +#include +#include +#include +#include"merkle.h" +#include"merkle-zero-table.h" + +static void hash2 + (const uint8_t lhs[EVM_KECCAK_MDLEN] + ,const uint8_t rhs[EVM_KECCAK_MDLEN] + ,uint8_t out[EVM_KECCAK_MDLEN]) +{ + EVM_KECCAK_DECL(c); + evm_keccak_update(c, EVM_KECCAK_MDLEN, lhs); + evm_keccak_update(c, EVM_KECCAK_MDLEN, rhs); + evm_keccak_final(c, out); +} + +void evm_merkle_init(evm_merkle_t *me) +{ + me->n = 0; + me->zero = evm_merkle_zero_table; + memcpy(me->sib, me->zero, sizeof(me->sib)); +} + +void evm_merkle_fini(evm_merkle_t *me) +{ + // noop +} + +int evm_merkle_put(evm_merkle_t *me, uint8_t hash[EVM_KECCAK_MDLEN]) +{ + if (me->n == UINT64_MAX) + return ENOBUFS; + + int n = ffsll(++me->n)-1u; + for (int i=0; isib[i], hash, hash); + memcpy(me->sib[n], hash, EVM_KECCAK_MDLEN); + return 0; +} + +void evm_merkle_get(evm_merkle_t *me, uint8_t root[EVM_KECCAK_MDLEN]) +{ + unsigned n = (ffsll(me->n)-1u) & (EVM_MERKLE_MAX-1u); + memcpy(root, me->sib[n], EVM_KECCAK_MDLEN); + + for (int i=n; in & (UINT64_C(1) << i); + if (set) hash2(me->sib[i], root, root); + else hash2(root, me->zero[i], root); + } +} + +int evm_merkle_put_data(evm_merkle_t *me, size_t n, void *data) +{ + uint8_t hash[EVM_KECCAK_MDLEN]; + EVM_KECCAK_DECL(c); + evm_keccak_update(c, n, data); + evm_keccak_final(c, hash); + return evm_merkle_put(me, hash); +} diff --git a/linux/libdriver/base/merkle.h b/linux/libdriver/base/merkle.h new file mode 100644 index 00000000..523d29f4 --- /dev/null +++ b/linux/libdriver/base/merkle.h @@ -0,0 +1,56 @@ +/** @file + * @defgroup libevm_merkle merkle + * merkle tree of keccak256 hashes + * + * @ingroup libevm + * @{ */ +#ifndef EVM_MERKLE_H +#define EVM_MERKLE_H +#include"keccak.h" + +#define EVM_MERKLE_MAX 64 + +/** Opaque Merkle tree state, used to do hash computations, initialize with: + * - @ref evm_merkle_init */ +typedef struct { + uint64_t n; + const uint8_t (*zero)[EVM_KECCAK_MDLEN]; + uint8_t sib[EVM_MERKLE_MAX][EVM_KECCAK_MDLEN]; +} evm_merkle_t; + +/** Initialize a @ref evm_merkle_t tree state. + * + * @param [in] me uninitialized state */ +void evm_merkle_init(evm_merkle_t *me); + +/** Finalize a @ref evm_merkle_t tree state. + * + * @param [in] me initialized state + * + * @note use of @p me after this call is undefined behavior. */ +void evm_merkle_fini(evm_merkle_t *me); + +/** Append a leaf node + * + * @param [in,out] me initialized state + * @param [in] hash value of the new leaf + * @return + * - 0 success + * - -ENOBUFS indicates the tree is full */ +int evm_merkle_put(evm_merkle_t *me, uint8_t hash[EVM_KECCAK_MDLEN]); + +/** Compute the keccak-256 hash of @p data and append it as a leaf node + * + * @param [in,out] me initialized state + * @return + * - 0 success + * - -ENOBUFS indicates that the tree is full */ +int evm_merkle_put_data(evm_merkle_t *me, size_t n, void *data); + +/** Retrieve the root hash of the merkle tree + * + * @param [in] me initialized state + * @param [out] root root hash of the merkle tree */ +void evm_merkle_get(evm_merkle_t *me, uint8_t root[EVM_KECCAK_MDLEN]); + +#endif /* EVM_MERKLE_H */ diff --git a/linux/libdriver/base/rollup-driver-api.h b/linux/libdriver/base/rollup-driver-api.h new file mode 100644 index 00000000..6aa0bec9 --- /dev/null +++ b/linux/libdriver/base/rollup-driver-api.h @@ -0,0 +1,114 @@ +/** @file + * @defgroup rollup_driver rollup_driver + * Abstraction of the Cartesi rollup driver API + * + * Lets look at some code: + * + * @include examples/rollup-driver.c + * + * @ingroup driver + * @{ */ +#ifndef ROLLUP_API_H +#define ROLLUP_API_H +#include +#include +#include + +enum { + ROLLUP_DRIVER_ADVANCE_STATE = 0, /**< @ref rollup_driver_accept_and_wait_next_input advance state */ + ROLLUP_DRIVER_INSPECT_STATE = 1, /**< @ref rollup_driver_accept_and_wait_next_input inspect state */ +}; + +/** contents of @ref rollup_driver_t are implementation specific. + * Define it in @p */ +typedef struct rollup_driver rollup_driver_t; + +/** Open the rollup device and initialize the driver + * + * @param [in] me A uninitialized @ref rollup_driver_t state + * @returns + * - 0 on success + * - negative value on error. Any of -ENOBUFS, or errno values from `open` and `ioctl`. */ +int rollup_driver_init(struct rollup_driver *me); + +/** Release the driver resources and close the rollup device + * + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @returns + * - 0 on success + * - Any of `close` errno values to indicate an error + * - negative value on error. errno values from `close`. + * @note usage of @p me after this call is a BUG and will cause undefined behaviour */ +int rollup_driver_fini(struct rollup_driver *me); + +/** Create a output, with the first @p n bytes of @ref rollup_driver_t.tx + * + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @param [in] n size in bytes of the output, contents from @p tx buffer. + * @return + * - 0 on success + * - negative value on error. -ENOBUFS, or errno values from `ioctl` */ +int rollup_driver_write_output(struct rollup_driver *me, uint64_t n); + +/** Create a report, with the first @p n bytes of @ref rollup_driver_t.tx + * + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @param [in] n size in bytes of the output, contents from @p tx buffer. + * @return + * - 0 on success + * - negative value on error. -ENOBUFS, or errno values from `ioctl` */ +int rollup_driver_write_report(struct rollup_driver *me, uint64_t n); + +/** Create a exception, with the first @p n bytes of @ref rollup_driver_t.tx + * + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @param [in] verifiable @p true if this output should be verifiable + * @param [in] n size in bytes of the message, contents from @p tx buffer. + * @return + * - 0 on success + * - negative value on error. -ENOBUFS, or errno values from `ioctl` */ +int rollup_driver_write_exception(struct rollup_driver *me, uint64_t n); + +/** Accept this input, wait for the next one. + * + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @param [in] accept @p true if this input was processed successfuly + * @param [out] n size in bytes of the current input. + * @return + * - ROLLUP_ADVANCE_STATE On advancing state + * - ROLLUP_INSPECT_STATE On inspecting state + * - negative value on error. + * + * @note This call expects the tx buffer to have the merkle root hash of the + * outputs. It as part of its interface. */ +int rollup_driver_accept_and_wait_next_input(struct rollup_driver *me, size_t *n); + +/** Revert state back to how it was the last time @ref + * rollup_driver_accept_and_wait_next_input got called and reject this input + * + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @return + * - 0 on success + * - negative value on error. errno values from `ioctl` */ +int rollup_driver_revert(struct rollup_driver *me); + +/** Retrieve the writable memory region @p tx + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @param [out] max size of the region in bytes. + * + * @return + * - pointer to the buffer. + * @note memory is valid until @ref rollup_driver_fini is called. */ +void *rollup_driver_get_tx(struct rollup_driver *me, size_t *max); + +/** Retrieve the writable memory region @p rx + * @param [in] me A sucessfuly initialized state by @ref rollup_driver_init + * @param [out] max size of the region in bytes. + * + * @return + * - pointer to the buffer. + * @note memory is valid until @ref rollup_driver_fini is called. */ +void *rollup_driver_get_rx(struct rollup_driver *me, size_t *max); + +#endif /* ROLLUP_API_H */ +/** @} */ diff --git a/linux/libdriver/base/rollup.c b/linux/libdriver/base/rollup.c new file mode 100644 index 00000000..bf271de8 --- /dev/null +++ b/linux/libdriver/base/rollup.c @@ -0,0 +1,95 @@ +#include +#include "rollup.h" + +// Voucher(address,bytes) +#define VOUCHER EVM_ABI_FUNSEL(0xef, 0x61, 0x5e, 0x2f) + +// Notice(bytes) +#define NOTICE EVM_ABI_FUNSEL(0xc2, 0x58, 0xd6, 0xe5) + +// EvmInput(address,uint256,uint256,uint256,bytes) +#define EVM_INPUT EVM_ABI_FUNSEL(0x1e, 0xcc, 0x35, 0xc3) + +int evm_rollup_init(evm_rollup_t *me) +{ + int rc = 0; + if ((rc = rollup_driver_init(me->rollup_driver))) + return rc; + + uint64_t rxmax, txmax; + void *rx = rollup_driver_get_rx(me->rollup_driver, &rxmax); + void *tx = rollup_driver_get_tx(me->rollup_driver, &txmax); + + evm_buf_init(me->tx, txmax, tx); + evm_buf_init(me->rx, rxmax, rx); + evm_merkle_init(me->merkle); + return 0; +} + +void evm_rollup_fini(evm_rollup_t *me) +{ + rollup_driver_fini(me->rollup_driver); + evm_merkle_fini(me->merkle); +} + +int evm_rollup_emit_voucher(evm_rollup_t *me, uint8_t address[20], size_t n, const void *data) +{ + evm_buf_t wr[1] = {*me->tx}, + of[1]; + + if (evm_abi_put_funsel(wr, VOUCHER) + || evm_abi_put_address(wr, address) + || evm_abi_put_bytes_s(wr, of) + || evm_abi_put_bytes_d(wr, of, n, data, me->tx->p + 4)) + return -ENOBUFS; + + size_t m = wr->p - me->tx->p; + evm_merkle_put_data(me->merkle, m, me->tx->p); + return rollup_driver_write_output(me->rollup_driver, m); +} + +int evm_rollup_emit_notice(evm_rollup_t *me, size_t n, const void *data) +{ + evm_buf_t wr[1] = {*me->tx}, + of[1]; + + if (evm_abi_put_funsel(wr, NOTICE) + || evm_abi_put_bytes_s(wr, of) + || evm_abi_put_bytes_d(wr, of, n, data, me->tx->p + 4)) + return -ENOBUFS; + + size_t m = wr->p - me->tx->p; + evm_merkle_put_data(me->merkle, m, me->tx->p); + return rollup_driver_write_output(me->rollup_driver, m); +} + +int evm_rollup_read_advance_state(evm_rollup_t *me, evm_rollup_input_t *input) +{ + int rc = 0; + evm_buf_t rd[1] = {*me->rx}, + st[1] = {{me->rx->p + 4, me->rx->q}}, // EVM offsets are from after funsel + of[1]; + + if (evm_abi_check_funsel(rd, EVM_INPUT) + || (rc = evm_abi_get_address(rd, input->sender)) + || (rc = evm_abi_get_uint(rd, sizeof(input->blockNumber), &input->blockNumber)) + || (rc = evm_abi_get_uint(rd, sizeof(input->blockTimestamp), &input->blockTimestamp)) + || (rc = evm_abi_get_uint(rd, sizeof(input->index), &input->index)) + || (rc = evm_abi_get_bytes_s(rd, of)) + || (rc = evm_abi_get_bytes_d(st, of, &input->n, &input->data))) + return rc; + return 0; +} + +int evm_rollup_finish(evm_rollup_t *me, evm_rollup_finish_t *finish) +{ + if (!finish->accept_previous_request) { + rollup_driver_revert(me->rollup_driver); + /* revert should not return! */ + return -EBADE; + } + + evm_merkle_get(me->merkle, me->tx->p); // send the merkle outputs_root_hash + return finish->next_request_type = rollup_driver_accept_and_wait_next_input + (me->rollup_driver, &finish->next_request_payload_length); +} diff --git a/linux/libdriver/base/rollup.h b/linux/libdriver/base/rollup.h new file mode 100644 index 00000000..6ff5b35c --- /dev/null +++ b/linux/libdriver/base/rollup.h @@ -0,0 +1,100 @@ +/** @file + * @defgroup libevm_rollup rollup + * Rollup abstraction layer + * + * Takes care of @ref rollup_driver interactions. + * + * @ingroup libevm + * @{ */ +#ifndef EVM_ROLLUP_H +#define EVM_ROLLUP_H +#include"rollup-driver.h" +#include"buf.h" +#include"abi.h" +#include"merkle.h" + +/** Opaque rollup state, initialize with: + * - @ref evm_rollup_init */ +typedef struct { + struct rollup_driver rollup_driver[1]; + evm_buf_t tx[1], + rx[1]; + evm_merkle_t merkle[1]; +} evm_rollup_t; + +typedef struct { + uint8_t sender[EVM_ADDRESS_LEN]; + uint64_t blockNumber; + uint64_t blockTimestamp; + uint64_t index; + size_t n; + void *data; +} evm_rollup_input_t; + +typedef struct { + bool accept_previous_request; + int next_request_type; + size_t next_request_payload_length; +} evm_rollup_finish_t; + +/** Initialize a @ref evm_rollup_t state. + * + * @param [in] me uninitialized state + * @return + * - 0 success */ +int +evm_rollup_init(evm_rollup_t *me); + +/** Finalize a @ref evm_rollup_t statate previously initialized with @ref + * evm_rollup_init + * + * @param [in] me initialized state + * + * @note use of @p me after this call is undefined behavior. */ +void +evm_rollup_fini(evm_rollup_t *me); + +/** Emit a voucher + * + * @param [in,out] me initialized evm_rollup_t instance + * @param [in] address destination + * @param [in] n sizeof @p data in bytes + * @param [in] data message contents + * @return + * - 0 success + * - -ENOBUFS no space left in @p me */ +int +evm_rollup_emit_voucher(evm_rollup_t *me + ,uint8_t address[20] + ,size_t n + ,const void *data); + +/** Emit a Notice + * + * @param [in,out] me initialized evm_rollup_t instance + * @param [in] n sizeof @p data in bytes + * @param [in] data message contents + * @return + * - 0 success + * - -ENOBUFS no space left in @p me */ +int +evm_rollup_emit_notice(evm_rollup_t *me + ,size_t n + ,const void *data); + +/** read input + * + * @return + * - 0 success + * - -ENOBUFS no space left in @p me + * - -EDOM at least one of the integers is too large to 64bits */ +int +evm_rollup_read_advance_state(evm_rollup_t *me, evm_rollup_input_t *input); + +/** + * + */ +int +evm_rollup_finish(evm_rollup_t *me, evm_rollup_finish_t *finish); + +#endif /* EVM_ROLLUP_H */ diff --git a/linux/libdriver/base/yield-driver-api.h b/linux/libdriver/base/yield-driver-api.h new file mode 100644 index 00000000..e776766f --- /dev/null +++ b/linux/libdriver/base/yield-driver-api.h @@ -0,0 +1,45 @@ +/** @file + * @defgroup yield_driver yield_driver + * Abstraction of the Cartesi yield driver IOCTL API + * + * Lets look at some code: + * + * @include examples/yield-driver.c + * + * @ingroup driver + * @{ */ +#ifndef YIELD_DRIVER_API_H +#define YIELD_DRIVER_API_H +#include + +/** contents of @ref rollup_driver_t are implementation specific. + * Define it in @p */ +typedef struct yield_driver yield_driver_t; + +/** Open the rollup device and initialize the driver + * + * @param [in] me A uninitialized @ref rollup_driver_t state + * @returns + * - 0 on success + * - negative value on error. errno values from `open`. */ +int yield_driver_init(struct yield_driver *me); + +/** Close the rollup device and un-initialize the driver + * + * @param [in] me A uninitialized @ref rollup_driver_t state + * @returns + * - 0 on success + * - negative value on error. errno values from `close`. + * + * @note usage of @p me after this call is a BUG and will cause undefined behaviour */ +int yield_driver_fini(struct yield_driver *me); + +/** Report the application progress to the emulator. + * + * @param [in] me A sucessfuly initialized state by @ref yield_driver_init + * @returns + * - 0 on success + * - negative value on error. errno values from `ioctl`. */ +int yield_driver_progress(struct yield_driver *me, uint32_t progress); + +#endif /* YIELD_DRIVER_API_H */ diff --git a/linux/libdriver/doc/Doxyfile b/linux/libdriver/doc/Doxyfile new file mode 100644 index 00000000..316f0d4c --- /dev/null +++ b/linux/libdriver/doc/Doxyfile @@ -0,0 +1,2777 @@ +# Doxyfile 1.9.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). +# +# Note: +# +# Use doxygen to compare the used configuration file with the template +# configuration file: +# doxygen -x [configFile] +# Use doxygen to compare the used configuration file with the template +# configuration file without replacing the environment variables or CMake type +# replacement variables: +# doxygen -x_noenv [configFile] + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "driver" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096 +# sub-directories (in 2 levels) under the output directory of each output format +# and will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. Adapt CREATE_SUBDIRS_LEVEL to +# control the number of sub-directories. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# Controls the number of sub-directories that will be created when +# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every +# level increment doubles the number of directories, resulting in 4096 +# directories at level 8 which is the default and also the maximum value. The +# sub-directories are organized in 2 levels, the first level always has a fixed +# number of 16 directories. +# Minimum value: 0, maximum value: 8, default value: 8. +# This tag requires that the tag CREATE_SUBDIRS is set to YES. + +CREATE_SUBDIRS_LEVEL = 8 + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Bulgarian, +# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English +# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek, +# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with +# English messages), Korean, Korean-en (Korean with English messages), Latvian, +# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, +# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, +# Swedish, Turkish, Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = YES + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = NO + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = YES + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:^^" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". Note that you cannot put \n's in the value part of an alias +# to insert newlines (in the resulting output). You can put ^^ in the value part +# of an alias to insert a newline as if a physical newline was in the original +# file. When you need a literal { or } or , in the value part of an alias you +# have to escape them by means of a backslash (\), this can lead to conflicts +# with the commands \{ and \} for these it is advised to use the version @{ and +# @} or use a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice, +# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which effectively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = YES + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# will also hide undocumented C++ concepts if enabled. This option has no effect +# if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# Possible values are: SYSTEM, NO and YES. +# The default value is: SYSTEM. + +CASE_SENSE_NAMES = SYSTEM + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_HEADERFILE tag is set to YES then the documentation for a class +# will show which file needs to be included to use the class. +# The default value is: YES. + +SHOW_HEADERFILE = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. See also section "Changing the +# layout of pages" for information. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = doc/DoxygenLayout.xml + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as documenting some parameters in +# a documented function twice, or documenting parameters that don't exist or +# using markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete +# function parameter documentation. If set to NO, doxygen will accept that some +# parameters have no documentation without warning. +# The default value is: YES. + +WARN_IF_INCOMPLETE_DOC = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong parameter +# documentation, but not about the absence of documentation. If EXTRACT_ALL is +# set to YES then this flag will automatically be disabled. See also +# WARN_IF_INCOMPLETE_DOC +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about +# undocumented enumeration values. If set to NO, doxygen will accept +# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: NO. + +WARN_IF_UNDOC_ENUM_VAL = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# See also: WARN_LINE_FORMAT +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# In the $text part of the WARN_FORMAT command it is possible that a reference +# to a more specific place is given. To make it easier to jump to this place +# (outside of doxygen) the user can define a custom "cut" / "paste" string. +# Example: +# WARN_LINE_FORMAT = "'vi $file +$line'" +# See also: WARN_FORMAT +# The default value is: at line $line of file $file. + +WARN_LINE_FORMAT = "at line $line of file $file" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). In case the file specified cannot be opened for writing the +# warning and error messages are written to standard error. When as file - is +# specified the warning and error messages are written to standard output +# (stdout). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = README.md base mock + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# See also: INPUT_FILE_ENCODING +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify +# character encoding on a per file pattern basis. Doxygen will compare the file +# name with each pattern and apply the encoding instead of the default +# INPUT_ENCODING) if there is a match. The character encodings are a list of the +# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding +# "INPUT_ENCODING" for further information on supported encodings. + +INPUT_FILE_ENCODING = + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.l, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, +# *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C +# comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.java \ + *.ii \ + *.ixx \ + *.ipp \ + *.i++ \ + *.inl \ + *.idl \ + *.ddl \ + *.odl \ + *.h \ + *.hh \ + *.hxx \ + *.hpp \ + *.h++ \ + *.l \ + *.cs \ + *.d \ + *.php \ + *.php4 \ + *.php5 \ + *.phtml \ + *.inc \ + *.m \ + *.markdown \ + *.md \ + *.mm \ + *.dox \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f18 \ + *.f \ + *.for \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf \ + *.ice + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# ANamespace::AClass, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = examples + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that doxygen will use the data processed and written to standard output +# for further processing, therefore nothing else, like debug statements or used +# commands (so in case of a Windows batch file always use @echo OFF), should be +# written to standard output. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = README.md + +# The Fortran standard specifies that for fixed formatted Fortran code all +# characters from position 72 are to be considered as comment. A common +# extension is to allow longer lines before the automatic comment starts. The +# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can +# be processed before the automatic comment starts. +# Minimum value: 7, maximum value: 10000, default value: 72. + +FORTRAN_COMMENT_AFTER = 72 + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS +# tag is set to YES then doxygen will add the directory of each input to the +# include path. +# The default value is: YES. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = YES + +# The IGNORE_PREFIX tag can be used to specify a prefix (or a list of prefixes) +# that should be ignored while generating the index headers. The IGNORE_PREFIX +# tag works for classes, function and member names. The entity will be placed in +# the alphabetical list under the first letter of the entity name that remains +# after removing the prefix. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# Note: Since the styling of scrollbars can currently not be overruled in +# Webkit/Chromium, the styling will be left out of the default doxygen.css if +# one or more extra stylesheets have been specified. So if scrollbar +# customization is desired it has to be added explicitly. For an example see the +# documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = doc/theme/doxygen-awesome.css \ + doc/theme/doxygen-awesome-sidebar-only.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE tag can be used to specify if the generated HTML output +# should be rendered with a dark or light theme. +# Possible values are: LIGHT always generate light mode output, DARK always +# generate dark mode output, AUTO_LIGHT automatically set the mode according to +# the user preference, use light mode if no preference is set (the default), +# AUTO_DARK automatically set the mode according to the user preference, use +# dark mode if no preference is set and TOGGLE allow to user to switch between +# light and dark mode via a button. +# The default value is: AUTO_LIGHT. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE = AUTO_DARK + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a color-wheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use gray-scales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag determines the URL of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDURL = + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# on Windows. In the beginning of 2021 Microsoft took the original page, with +# a.o. the download links, offline the HTML help workshop was already many years +# in maintenance mode). You can download the HTML help workshop from the web +# archives at Installation executable (see: +# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo +# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe). +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine tune the look of the index (see "Fine-tuning the output"). As an +# example, the default style sheet generated by doxygen has an example that +# shows how to put an image at the root of the tree instead of the PROJECT_NAME. +# Since the tree basically has the same information as the tab index, you could +# consider setting DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the +# FULL_SIDEBAR option determines if the side bar is limited to only the treeview +# area (value NO) or if it should extend to the full height of the window (value +# YES). Setting this to YES gives a layout similar to +# https://docs.readthedocs.io with more room for contents, but less room for the +# project logo, title, and description. If either GENERATE_TREEVIEW or +# DISABLE_INDEX is set to NO, this option has no effect. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FULL_SIDEBAR = NO + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email +# addresses. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +OBFUSCATE_EMAILS = YES + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# With MATHJAX_VERSION it is possible to specify the MathJax version to be used. +# Note that the different versions of MathJax have different requirements with +# regards to the different settings, so it is possible that also other MathJax +# settings have to be changed when switching between the different MathJax +# versions. +# Possible values are: MathJax_2 and MathJax_3. +# The default value is: MathJax_2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_VERSION = MathJax_2 + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. For more details about the output format see MathJax +# version 2 (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3 +# (see: +# http://docs.mathjax.org/en/latest/web/components/output.html). +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility. This is the name for Mathjax version 2, for MathJax version 3 +# this will be translated into chtml), NativeMML (i.e. MathML. Only supported +# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This +# is the name for Mathjax version 3, for MathJax version 2 this will be +# translated into HTML-CSS) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. The default value is: +# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2 +# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3 +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# for MathJax version 2 (see +# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions): +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# For example for MathJax version 3 (see +# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html): +# MATHJAX_EXTENSIONS = ams +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /