From 158ae8e31d915cb6fe083d4f6df77ffa70d01f7d Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Tue, 29 Jun 2021 18:21:46 -0500 Subject: [PATCH 001/101] fix typo in pin name #25 --- main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main.cpp b/main.cpp index fae9203..976f3a6 100644 --- a/main.cpp +++ b/main.cpp @@ -80,7 +80,7 @@ static string hex_string(int value, int width=8, bool prefix=true) { std::array, 10> pin_functions{{ {"", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", "", ""}, - {"SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI1 RX", "SPI1 CSn", "SPI1 SCK", "SPI1 TX", "SPI1 RX", "SPI1 CSn", "SPI1 SCK", "PI1 TX", "SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI1 RX", "SPI1 CSn", "SPI1 SCK", "SPI1 TX", "SPI1 RX", "SPI1 CSn"}, + {"SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI1 RX", "SPI1 CSn", "SPI1 SCK", "SPI1 TX", "SPI1 RX", "SPI1 CSn", "SPI1 SCK", "SPI1 TX", "SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI0 RX", "SPI0 CSn", "SPI0 SCK", "SPI0 TX", "SPI1 RX", "SPI1 CSn", "SPI1 SCK", "SPI1 TX", "SPI1 RX", "SPI1 CSn"}, {"UART0 TX", "UART0 RX", "UART0 CTS", "UART0 RTS", "UART1 TX", "UART1 RX", "UART1 CTS", "UART1 RTS", "UART1 TX", "UART1 RX", "UART1 CTS", "UART1 RTS", "UART0 TX", "UART0 RX", "UART0 CTS", "UART0 RTS", "UART0 TX", "UART0 RX", "UART0 CTS", "UART0 RTS", "UART1 TX", "UART1 RX", "UART1 CTS", "UART1 RTS", "UART1 TX", "UART1 RX", "UART1 CTS", "UART1 RTS", "UART0 TX", "UART0 RX"}, {"I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL", "I2C1 SDA", "I2C1 SCL", "I2C0 SDA", "I2C0 SCL"}, {"PWM0 A", "PWM0 B", "PWM1 A", "PWM1 B", "PWM2 A", "PWM2 B", "PWM3 A", "PWM3 B", "PWM4 A", "PWM4 B", "PWM5 A", "PWM5 B", "PWM6 A", "PWM6 B", "PWM7 A", "PWM7 B", "PWM0 A", "PWM0 B", "PWM1 A", "PWM1 B", "PWM2 A", "PWM2 B", "PWM3 A", "PWM3 B", "PWM4 A", "PWM4 B", "PWM5 A", "PWM5 B", "PWM6 A", "PWM6 B"}, From 3b1bcd391b6274b2b08a7a21619e42fd40194ab4 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Tue, 29 Jun 2021 18:39:55 -0500 Subject: [PATCH 002/101] Add version command --- CMakeLists.txt | 8 ++++++++ main.cpp | 29 +++++++++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index 40a1dc1..b0343b5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -30,6 +30,14 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) + set(PICOTOOL_VERSION 1.1.0-develop) + set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") + set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}-${CMAKE_BUILD_TYPE}") + target_compile_definitions(picotool PRIVATE + PICOTOOL_VERSION="${PICOTOOL_VERSION}" + SYSTEM_VERSION="${SYSTEM_VERSION}" + COMPILER_INFO="${COMPILER_INFO}" + ) target_include_directories(picotool PRIVATE ${LIBUSB_INCLUDE_DIR}) target_link_libraries(picotool pico_binary_info boot_uf2_headers boot_picoboot_headers pico_platform_headers picoboot_connection_cxx ${LIBUSB_LIBRARIES}) endif() diff --git a/main.cpp b/main.cpp index 976f3a6..89059c5 100644 --- a/main.cpp +++ b/main.cpp @@ -253,6 +253,10 @@ struct _settings { struct { bool all = false; } save; + + struct { + bool semantic = false; + } version; }; _settings settings; std::shared_ptr selected_cmd; @@ -399,6 +403,30 @@ struct help_command : public cmd { } } help_cmd; +struct version_command : public cmd { + version_command() : cmd("version") {} + void execute(device_map &devices) override { + if (settings.version.semantic) + std::cout << PICOTOOL_VERSION << "\n"; + else + std::cout << "picotool v" << PICOTOOL_VERSION << " (" << SYSTEM_VERSION << ":" << COMPILER_INFO << ")\n"; + } + + device_support get_device_support() override { + return device_support::none; + } + + group get_cli() override { + return group( + option('s', "--semantic").set(settings.version.semantic) % "Output semantic version number only" + ); + } + + string get_doc() const override { + return "Display picotool version"; + } +} version_cmd; + struct reboot_command : public cmd { reboot_command() : cmd("reboot") {} void execute(device_map &devices) override; @@ -423,6 +451,7 @@ vector> commands { std::shared_ptr(new save_command()), std::shared_ptr(new verify_command()), std::shared_ptr(new reboot_command()), + std::shared_ptr(new version_command()), std::shared_ptr(new help_command()), }; From 2cf86cfecb3c6db21be0da826630fbfe6950af15 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Wed, 14 Jul 2021 16:01:47 -0500 Subject: [PATCH 003/101] fix parsing of ELF where the program header does not directly follow the file header --- main.cpp | 3 +++ 1 file changed, 3 insertions(+) diff --git a/main.cpp b/main.cpp index 89059c5..aa7790d 100644 --- a/main.cpp +++ b/main.cpp @@ -1210,6 +1210,9 @@ void build_rmap_elf(FILE *file, range_map& rmap) { } if (eh.ph_num) { vector entries(eh.ph_num); + if (fseek(file, eh.ph_offset, SEEK_SET)) { + return fail_read_error(); + } if (eh.ph_num != fread(&entries[0], sizeof(struct elf32_ph_entry), eh.ph_num, file)) { fail_read_error(); } From ce769705338cb57abc57d1a586983abe3a5e5199 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Thu, 22 Jul 2021 09:21:15 -0500 Subject: [PATCH 004/101] Add install-ability via [100%] Built target picotool Install the project... -- Install configuration: "Debug" -- Installing: /usr/local/bin/picotool --- CMakeLists.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CMakeLists.txt b/CMakeLists.txt index b0343b5..fb72351 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,4 +40,6 @@ else() ) target_include_directories(picotool PRIVATE ${LIBUSB_INCLUDE_DIR}) target_link_libraries(picotool pico_binary_info boot_uf2_headers boot_picoboot_headers pico_platform_headers picoboot_connection_cxx ${LIBUSB_LIBRARIES}) + # allow `make install` + install(TARGETS picotool) endif() From 757f2aee3c2c988b4d0c9c15907e243350381d0a Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Tue, 20 Jul 2021 11:06:00 -0500 Subject: [PATCH 005/101] incorporate slightly modified Win32 usb find helpers --- cmake/FindLIBUSB.cmake | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/cmake/FindLIBUSB.cmake b/cmake/FindLIBUSB.cmake index c8cc62c..26e924c 100644 --- a/cmake/FindLIBUSB.cmake +++ b/cmake/FindLIBUSB.cmake @@ -19,10 +19,12 @@ else (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) pkg_check_modules(PC_LIBUSB libusb-1.0) ENDIF(NOT WIN32) FIND_PATH(LIBUSB_INCLUDE_DIR libusb.h + HINTS $ENV{LIBUSB_ROOT}/include/libusb-1.0 PATHS ${PC_LIBUSB_INCLUDEDIR} ${PC_LIBUSB_INCLUDE_DIRS}) - FIND_LIBRARY(LIBUSB_LIBRARIES NAMES usb-1.0 + FIND_LIBRARY(LIBUSB_LIBRARIES NAMES libusb-1.0 usb-1.0 usb + HINTS $ENV{LIBUSB_ROOT}/VS2019/MS32/static PATHS ${PC_LIBUSB_LIBDIR} ${PC_LIBUSB_LIBRARY_DIRS}) include(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(LIBUSB DEFAULT_MSG LIBUSB_LIBRARIES LIBUSB_INCLUDE_DIR) MARK_AS_ADVANCED(LIBUSB_INCLUDE_DIR LIBUSB_LIBRARIES) -endif (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) \ No newline at end of file +endif (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) From b1568b7845cd99f6684abe0915ff3cf9a933a5b9 Mon Sep 17 00:00:00 2001 From: Graham Sanderson Date: Thu, 21 Oct 2021 11:55:26 -0500 Subject: [PATCH 006/101] Add ability to access device using stdio_usb (#23) * add -n option to load to avoid overwriting existing program * Add -f/-F option to force reset a cooperative RP2040 board that isnt in BOOTSEL mode --- CMakeLists.txt | 8 +- README.md | 52 +-- main.cpp | 486 ++++++++++++++++------ picoboot_connection/picoboot_connection.c | 3 + picoboot_connection/picoboot_connection.h | 2 + 5 files changed, 390 insertions(+), 161 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index fb72351..65ae8b5 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -2,6 +2,10 @@ cmake_minimum_required(VERSION 3.12) project(picotool) +if (NOT CMAKE_BUILD_TYPE) + set(CMAKE_BUILD_TYPE Release) +endif() + if (DEFINED ENV{PICO_SDK_PATH} AND (NOT PICO_SDK_PATH)) set(PICO_SDK_PATH $ENV{PICO_SDK_PATH}) message("Using PICO_SDK_PATH from environment ('${PICO_SDK_PATH}')") @@ -32,13 +36,15 @@ else() add_executable(picotool main.cpp) set(PICOTOOL_VERSION 1.1.0-develop) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") - set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}-${CMAKE_BUILD_TYPE}") + set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE PICOTOOL_VERSION="${PICOTOOL_VERSION}" SYSTEM_VERSION="${SYSTEM_VERSION}" COMPILER_INFO="${COMPILER_INFO}" ) target_include_directories(picotool PRIVATE ${LIBUSB_INCLUDE_DIR}) + # todo, this is a bit of an abstraction failure; but don't want to rev the SDK just for this right now + target_include_directories(picotool PRIVATE ${PICO_SDK_PATH}/src/rp2_common/pico_stdio_usb/include) target_link_libraries(picotool pico_binary_info boot_uf2_headers boot_picoboot_headers pico_platform_headers picoboot_connection_cxx ${LIBUSB_LIBRARIES}) # allow `make install` install(TARGETS picotool) diff --git a/README.md b/README.md index 982cadc..fc35840 100644 --- a/README.md +++ b/README.md @@ -36,25 +36,26 @@ PICOTOOL: Tool for interacting with a RP2040 device in BOOTSEL mode, or with a RP2040 binary SYNOPSYS: - picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] + picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] picotool info [-b] [-p] [-d] [-l] [-a] [-t ] - picotool load [-v] [-r] [-t ] [--bus ] [--address ] - picotool save [-p] [--bus ] [--address ] [-t ] - picotool save -a [--bus ] [--address ] [-t ] - picotool save -r [--bus ] [--address ] [-t ] - picotool verify [--bus ] [--address ] [-t ] [-r ] - picotool reboot [-a] [-u] [--bus ] [--address ] + picotool load [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] + picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] + picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] + picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] + picotool verify [--bus ] [--address ] [-f] [-F] [-t ] [-r ] [-o ] + picotool reboot [-a] [-u] [--bus ] [--address ] [-f] [-F] + picotool version [-s] picotool help [] COMMANDS: - info Display information from the target device(s) or file. - Without any arguments, this will display basic information for all connected RP2040 devices in - BOOTSEL mode - load Load the program / memory range stored in a file onto the device. - save Save the program / memory stored in flash on the device to a file. - verify Check that the device contents match those in the file. - reboot Reboot the device - help Show general help or help for a specific command + info Display information from the target device(s) or file. + Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode + load Load the program / memory range stored in a file onto the device. + save Save the program / memory stored in flash on the device to a file. + verify Check that the device contents match those in the file. + reboot Reboot the device + version Display picotool version + help Show general help or help for a specific command Use "picotool help " for more info ``` @@ -69,15 +70,14 @@ can find (See Binary Info section below). The info command is for reading this i The information can be either read from one or more connected RP2040 devices in BOOTSEL mode, or from a file. This file can be an ELF, a UF2 or a BIN file. -```asciidoc +```text $ picotool help info INFO: Display information from the target device(s) or file. - Without any arguments, this will display basic information for all connected RP2040 devices in USB boot - mode + Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode SYNOPSYS: - picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] + picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] picotool info [-b] [-p] [-d] [-l] [-a] [-t ] OPTIONS: @@ -105,7 +105,6 @@ TARGET SELECTION: -t Specify file type (uf2 | elf | bin) explicitly, ignoring file extension ``` - e.g. ```text @@ -247,11 +246,7 @@ Basic information includes - program features - this is a list built from individual strings in the binary, that can be displayed (e.g. we will have one for UART stdio and one for USB stdio) in the SDK - build attributes - this is a similar list of strings, for things pertaining to the binary itself (e.g. Debug Build) -Note it is my intention that things like MicroPython would include features for parts of the language/libraries they include. - -This might not be as a feature string per se, but could be another aggregating list (features/attributes are well known) -but we can add another piece of binary info to name a list attribute that aggregates strings with a particular tag, so you -could trivially add "MicroPython libraries:" etc to the `picotool` output without changing the tool itself. +The binary information is self-describing/extensible, so programs can include information picotool is not aware of (e.g. MicroPython includes a list of in-built libraries) ### Pins @@ -389,11 +384,6 @@ quotes, newlines etc you may have better luck defining via bi_decl in the code. ## Additional binary information/picotool features -### SDK version - -Should add this; git revision in general is hard since the user may not have the SDK checked out from git, so we'll have to stick -a version number in a header - ### Block devices MicroPython and CircuitPython, eventually the SDK and others may support one or more storage devices in flash. We already @@ -433,7 +423,7 @@ enum { ### USB device descriptors Seems like tagging these might be nice (we just need to store the pointer to it assuming - as is often the case - -the descriptor is just a linear chunk of memory) ... I assume there is a tool out there to prettyify such a thing if picotool dumps the descriptor +the descriptor is just a linear chunk of memory) ... I assume there is a tool out there to prettify such a thing if picotool dumps the descriptor in binary. ### Issues diff --git a/main.cpp b/main.cpp index aa7790d..8212cf5 100644 --- a/main.cpp +++ b/main.cpp @@ -10,7 +10,7 @@ #include "cli.h" #include "clipp/clipp.h" -#include +#include #include #include #include @@ -24,11 +24,18 @@ #include #include #include +#include + #include "boot/uf2.h" #include "picoboot_connection_cxx.h" #include "pico/binary_info.h" +#include "pico/stdio_usb/reset_interface.h" #include "elf.h" +#if defined(__unix__) || defined(__APPLE__) +#include +#endif + // tsk namespace is polluted on windows #ifdef _MSC_VER #undef min @@ -59,7 +66,6 @@ using std::map; typedef map>> device_map; typedef unsigned int uint; -static libusb_context *ctx; auto memory_names = map{ {memory_type::sram, "RAM"}, @@ -140,8 +146,25 @@ struct range { to = other.clamp(to); } + bool intersects(const range& other) const { + return !(other.from >= to || other.to < from); + } + }; +static void __noreturn fail(int code, string msg) { + throw command_failure(code, std::move(msg)); +} + +static void __noreturn fail(int code, const char *format, ...) { + va_list args; + va_start(args, format); + static char error_msg[512]; + vsnprintf(error_msg, sizeof(error_msg), format, args); + va_end(args); + fail(code, string(error_msg)); +} + // ranges should not overlap template struct range_map { struct mapping { @@ -150,19 +173,19 @@ template struct range_map { const uint32_t max_offset; }; - void check_overlap(uint32_t p) { - auto f = m.lower_bound(p); - if (f != m.end()) { - assert(p >= f->first); - assert(p < f->second.first); - } - } - void insert(const range& r, T t) { if (r.to != r.from) { assert(r.to > r.from); - check_overlap(r.from); - check_overlap(r.to); + // check we don't overlap any existing map entries + auto f = m.lower_bound(r.to); // f is first element that starts after or on r.to + if (f != m.begin()) { + f--; + } + if (f != m.end()) { + // due to edge cases above, f is either the entry before + // or after r, so just check for any overlap + fail(ERROR_FORMAT, "Found overlapping memory ranges 0x%08x->0x%08x and 0x%08x->%08x\n", f->first, f->second.first, r.from, r.to); + } m.insert(std::make_pair(r.from, std::make_pair(r.to, t))); } } @@ -213,11 +236,13 @@ using cli::value; struct cmd { explicit cmd(string name) : _name(std::move(name)) {} - enum device_support { none, one, zero_or_more, one_or_more }; + enum device_support { none, one, zero_or_more }; virtual group get_cli() = 0; virtual string get_doc() const = 0; virtual device_support get_device_support() { return one; } - virtual void execute(device_map& devices) = 0; + virtual bool force_requires_pre_reboot() { return true; } + // return true if the command caused a reboot + virtual bool execute(device_map& devices) = 0; const string& name() { return _name; } private: string _name; @@ -235,7 +260,9 @@ struct _settings { bool offset_set = false; bool range_set = false; bool reboot_usb = false; + bool reboot_app_specified = false; bool force = false; + bool force_no_reboot = false; struct { bool show_basic = false; @@ -248,6 +275,8 @@ struct _settings { struct { bool verify = false; bool execute = false; + bool no_overwrite = false; + bool no_overwrite_force = false; } load; struct { @@ -267,6 +296,10 @@ auto device_selection = .if_missing([] { return "missing bus number"; })) % "Filter devices by USB bus number" + (option("--address") & integer("addr").min_value(1).max_value(127).set(settings.address) .if_missing([] { return "missing address"; })) % "Filter devices by USB device address" +#if !defined(_WIN32) + + option('f', "--force").set(settings.force) % "Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode" + + option('F', "--force-no-reboot").set(settings.force_no_reboot) % "Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the RPI-RP2 drive mounted" +#endif ).min(0).doc_non_optional(true); auto file_types = (option ('t', "--type") & value("type").set(settings.file_type)) @@ -282,7 +315,7 @@ auto file_selection = struct info_command : public cmd { info_command() : cmd("info") {} - void execute(device_map& devices) override; + bool execute(device_map& devices) override; device_support get_device_support() override { if (settings.filename.empty()) return zero_or_more; @@ -313,7 +346,7 @@ struct info_command : public cmd { struct verify_command : public cmd { verify_command() : cmd("verify") {} - void execute(device_map &devices) override; + bool execute(device_map &devices) override; group get_cli() override { return ( @@ -336,7 +369,7 @@ struct verify_command : public cmd { struct save_command : public cmd { save_command() : cmd("save") {} - void execute(device_map &devices) override; + bool execute(device_map &devices) override; group get_cli() override { return ( @@ -362,11 +395,13 @@ struct save_command : public cmd { struct load_command : public cmd { load_command() : cmd("load") {} - void execute(device_map &devices) override; + bool execute(device_map &devices) override; group get_cli() override { return ( ( + option('n', "--no-overwrite").set(settings.load.no_overwrite) % "When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence of the program in flash, the command fails" + + option('N', "--no-overwrite-unsafe").set(settings.load.no_overwrite_force) % "When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence of the program in flash, the load continues anyway" + option('v', "--verify").set(settings.load.verify) % "Verify the data was written correctly" + option('x', "--execute").set(settings.load.execute) % "Attempt to execute the downloaded file as a program after the load" ).min(0).doc_non_optional(true) % "Post load actions" + @@ -386,7 +421,7 @@ struct load_command : public cmd { struct help_command : public cmd { help_command() : cmd("help") {} - void execute(device_map &devices) override; + bool execute(device_map &devices) override; device_support get_device_support() override { return device_support::none; @@ -405,11 +440,12 @@ struct help_command : public cmd { struct version_command : public cmd { version_command() : cmd("version") {} - void execute(device_map &devices) override { + bool execute(device_map &devices) override { if (settings.version.semantic) std::cout << PICOTOOL_VERSION << "\n"; else - std::cout << "picotool v" << PICOTOOL_VERSION << " (" << SYSTEM_VERSION << ":" << COMPILER_INFO << ")\n"; + std::cout << "picotool v" << PICOTOOL_VERSION << " (" << SYSTEM_VERSION << ", " << COMPILER_INFO << ")\n"; + return false; } device_support get_device_support() override { @@ -428,18 +464,27 @@ struct version_command : public cmd { } version_cmd; struct reboot_command : public cmd { + bool quiet; reboot_command() : cmd("reboot") {} - void execute(device_map &devices) override; + bool execute(device_map &devices) override; group get_cli() override { return ( - option('a', "--application").clear(settings.reboot_usb) % "Reboot back into the application (this is the default)" + + option('a', "--application").set(settings.reboot_app_specified) % "Reboot back into the application (this is the default)" + option('u', "--usb").set(settings.reboot_usb) % "Reboot back into BOOTSEL mode " +#if defined(_WIN32) + + option('f', "--force").set(settings.force) % "Force a device not in BOOTSEL mode but running compatible code to reboot." +#endif ).min(0).doc_non_optional(true) % "Reboot type" + device_selection % "Selecting the device to reboot"; } + bool force_requires_pre_reboot() override { + // no point in rebooting twice + return false; + } + string get_doc() const override { return "Reboot the device"; } @@ -473,6 +518,13 @@ std::basic_string uppercase(const std::basic_string& s) clipp::formatting_ostream fos(std::cout); +static void sleep_ms(int ms) { +#if defined(__unix__) || defined(__APPLE__) + usleep(ms * 1000); +#else + Sleep(ms); +#endif +} using cli::option; using cli::integer; int parse(const int argc, char **argv) { @@ -609,7 +661,8 @@ int parse(const int argc, char **argv) { args.erase(args.begin()); // remove the cmd itself cli::match(settings, selected_cmd->get_cli(), args); } catch (std::exception &e) { - std::cout << "ERROR: " << e.what() << "\n\n"; + fos.wrap_hard(); + fos << "ERROR: " << e.what() << "\n\n"; usage(); return ERROR_ARGS; } @@ -695,10 +748,6 @@ struct memory_access { } }; -static void __noreturn fail(int code, string msg) { - throw command_failure(code, msg); -} - uint32_t bootrom_func_lookup(memory_access& access, uint16_t tag) { auto magic = access.read_int(BOOTROM_MAGIC_ADDR); magic &= 0xffffff; // ignore bootrom version @@ -891,16 +940,6 @@ static void read_and_check_elf32_header(FILE *in, elf32_header& eh_out) { } } -static char error_msg[512]; - -static void __noreturn fail(int code, const char *format, ...) { - va_list args; - va_start(args, format); - vsnprintf(error_msg, sizeof(error_msg), format, args); - va_end(args); - fail(code, string(error_msg)); -} - static void __noreturn fail_read_error() { fail(ERROR_READ_FAILED, "Failed to read input file"); } @@ -963,6 +1002,12 @@ string read_string(memory_access &access, uint32_t addr) { } struct bi_visitor_base { + void visit(memory_access& access, const binary_info_header& hdr) { + for (const auto &a : hdr.bi_addr) { + visit(access, a); + } + } + void visit(memory_access& access, uint32_t addr) { binary_info_core_t bi; access.read_raw(addr, bi); @@ -1364,9 +1409,7 @@ void info_guts(memory_access &raw_access) { named_feature_groups[std::make_pair(group_tag, group_id)] = std::make_pair(label, flags); }); - for (const auto &a : hdr.bi_addr) { - visitor.visit(access, a); - } + visitor.visit(access, hdr); visitor = bi_visitor{}; visitor.id_and_int([&](int tag, uint32_t id, uint32_t value) { @@ -1412,9 +1455,7 @@ void info_guts(memory_access &raw_access) { } }); - for (const auto &a : hdr.bi_addr) { - visitor.visit(access, a); - } + visitor.visit(access, hdr); if (settings.info.show_basic || settings.info.all) { select_group(program_info); @@ -1521,62 +1562,70 @@ void info_guts(memory_access &raw_access) { } } -string missing_device_string() { - char buf[256]; +string missing_device_string(bool wasRetry) { + char b[256]; + if (wasRetry) { + strcpy(b, "Despite the reboot attempt, no "); + } else { + strcpy(b, "No "); + } + char *buf = b + strlen(b); if (settings.address != -1) { if (settings.bus != -1) { - sprintf(buf, "No accessible RP2040 device in BOOTSEL mode was found at bus %d, address %d.", settings.bus, settings.address); + sprintf(buf, "accessible RP2040 device in BOOTSEL mode was found at bus %d, address %d.", settings.bus, settings.address); } else { - sprintf(buf, "No accessible RP2040 devices in BOOTSEL mode were found with address %d.", settings.address); + sprintf(buf, "accessible RP2040 devices in BOOTSEL mode were found with address %d.", settings.address); } } else { if (settings.bus != -1) { - sprintf(buf, "No accessible RP2040 devices in BOOTSEL mode were found found on bus %d.", settings.bus); + sprintf(buf, "accessible RP2040 devices in BOOTSEL mode were found found on bus %d.", settings.bus); } else { - sprintf(buf, "No accessible RP2040 devices in BOOTSEL mode were found."); + sprintf(buf, "accessible RP2040 devices in BOOTSEL mode were found."); } } - return buf; + return b; } -void help_command::execute(device_map &devices) { +bool help_command::execute(device_map &devices) { assert(false); + return false; } -void info_command::execute(device_map &devices) { +bool info_command::execute(device_map &devices) { + fos.first_column(0); fos.hanging_indent(0); if (!settings.filename.empty()) { auto access = get_file_memory_access(); - std::cout << "File " << settings.filename << ":\n\n"; + fos << "File " << settings.filename << ":\n\n"; info_guts(access); - return; + return false; } int size = devices[dr_vidpid_bootrom_ok].size(); if (size) { if (size > 1) { - std::cout << "Multiple RP2040 devices in BOOTSEL mode found:\n"; + fos << "Multiple RP2040 devices in BOOTSEL mode found:\n"; } for (auto handles : devices[dr_vidpid_bootrom_ok]) { + fos.first_column(0); fos.hanging_indent(0); if (size > 1) { auto s = bus_device_string(handles.first); string dashes; std::generate_n(std::back_inserter(dashes), s.length() + 1, [] { return '-'; }); - std::cout << "\n" << s << ":\n" << dashes << "\n"; + fos << "\n" << s << ":\n" << dashes << "\n"; } picoboot::connection connection(handles.second); picoboot_memory_access access(connection); info_guts(access); } } else { - fail(ERROR_NO_DEVICE, missing_device_string()); + fail(ERROR_NO_DEVICE, missing_device_string(false)); } + return false; } -static picoboot::connection get_single_usb_boot_device(device_map& devices, bool exclusive = true) { - if (devices[dr_vidpid_bootrom_ok].size() != 1) { - fail(ERROR_NOT_POSSIBLE, "Command requires a single RP2040 device to be targeted."); - } +static picoboot::connection get_single_bootsel_device_connection(device_map& devices, bool exclusive = true) { + assert(devices[dr_vidpid_bootrom_ok].size() == 1); libusb_device_handle *rc = devices[dr_vidpid_bootrom_ok][0].second; - if (!rc) fail(ERROR_USB, "Unabled to connect to device"); + if (!rc) fail(ERROR_USB, "Unable to connect to device"); return picoboot::connection(rc, exclusive); } @@ -1606,8 +1655,8 @@ struct progress_bar { int width; }; -void save_command::execute(device_map &devices) { - auto con = get_single_usb_boot_device(devices); +bool save_command::execute(device_map &devices) { + auto con = get_single_bootsel_device_connection(devices); picoboot_memory_access raw_access(con); uint32_t end = 0; @@ -1635,9 +1684,7 @@ void save_command::execute(device_map &devices) { return; if (id == BINARY_INFO_ID_RP_BINARY_END) binary_end = value; }); - for (const auto &a : hdr.bi_addr) { - visitor.visit(access, a); - } + visitor.visit(access, hdr); } if (binary_end == 0) { fail(ERROR_NOT_POSSIBLE, @@ -1722,6 +1769,7 @@ void save_command::execute(device_map &devices) { throw; } } + return false; } vector get_colaesced_ranges(file_memory_access &file_access) { @@ -1744,13 +1792,32 @@ vector get_colaesced_ranges(file_memory_access &file_access) { return ranges; } -void load_command::execute(device_map &devices) { +bool load_command::execute(device_map &devices) { if (settings.offset_set && get_file_type() != filetype::bin) { fail(ERROR_ARGS, "Offset only valid for BIN files"); } auto file_access = get_file_memory_access(); - auto con = get_single_usb_boot_device(devices); + auto con = get_single_bootsel_device_connection(devices); picoboot_memory_access raw_access(con); + range flash_binary_range(FLASH_START, FLASH_END); + bool flash_binary_end_unknown = true; + if (settings.load.no_overwrite_force) settings.load.no_overwrite = true; + if (settings.load.no_overwrite) { + binary_info_header hdr; + if (find_binary_info(raw_access, hdr)) { + auto access = remapped_memory_access(raw_access, hdr.reverse_copy_mapping); + auto visitor = bi_visitor{}; + visitor.id_and_int([&](int tag, uint32_t id, uint32_t value) { + if (tag != BINARY_INFO_TAG_RASPBERRY_PI) + return; + if (id == BINARY_INFO_ID_RP_BINARY_END) { + flash_binary_range.to = value; + flash_binary_end_unknown = false; + } + }); + visitor.visit(access, hdr); + } + } auto ranges = get_colaesced_ranges(file_access); for (auto mem_range : ranges) { enum memory_type t1 = get_memory_type(mem_range.from); @@ -1759,6 +1826,16 @@ void load_command::execute(device_map &devices) { fail(ERROR_FORMAT, "File to load contained an invalid memory range 0x%08x-0x%08x", mem_range.from, mem_range.to); } + if (settings.load.no_overwrite && mem_range.intersects(flash_binary_range)) { + if (flash_binary_end_unknown) { + if (!settings.load.no_overwrite_force) { + fail(ERROR_NOT_POSSIBLE, "-n option specified, but the size/presence of an existing flash binary could not be detected; aborting. Consider using the -N option"); + } + } else { + fail(ERROR_NOT_POSSIBLE, "-n option specified, and the loaded data range clashes with the existing flash binary range %08x->%08x", + flash_binary_range.from, flash_binary_range.to); + } + } } for (auto mem_range : ranges) { enum memory_type type = get_memory_type(mem_range.from); @@ -1833,15 +1910,18 @@ void load_command::execute(device_map &devices) { fail(ERROR_FORMAT, "Cannot execute as file does not contain a valid RP2 executable image"); } con.reboot(flash == get_memory_type(start) ? 0 : start, SRAM_END, 500); + std::cout << "\nThe device was rebooted to start the application.\n"; + return true; } + return false; } -void verify_command::execute(device_map &devices) { +bool verify_command::execute(device_map &devices) { if (settings.offset_set && get_file_type() != filetype::bin) { fail(ERROR_ARGS, "Offset only valid for BIN files"); } auto file_access = get_file_memory_access(); - auto con = get_single_usb_boot_device(devices); + auto con = get_single_bootsel_device_connection(devices); picoboot_memory_access raw_access(con); auto ranges = get_colaesced_ranges(file_access); if (settings.range_set) { @@ -1938,36 +2018,94 @@ void verify_command::execute(device_map &devices) { } } } + return false; } -void reboot_command::execute(device_map &devices) { - // not exclusive, because restoring un-exclusive could fail; also if we're rebooting, we don't much - // care what else is happening. - auto con = get_single_usb_boot_device(devices, false); - if (!settings.reboot_usb) { - con.reboot(0, SRAM_END, 500); - std::cout << "The device was rebooted.\n"; - } else { - picoboot_memory_access raw_access(con); - uint program_base = SRAM_START; - std::vector program = { - 0x20002100, // movs r0, #0; movs r1, #0 - 0x47104a00, // ldr r2, [pc, #0]; bx r2 - bootrom_func_lookup(raw_access, rom_table_code('U','B')) - }; - - raw_access.write_vector(program_base, program); - try { - con.exec(program_base); - } catch (picoboot::connection_error &e) { - if (e.libusb_code == LIBUSB_ERROR_NO_DEVICE) { - // not unreasonable once it reboots - return; - } - throw e; - } - fail(ERROR_NOT_POSSIBLE, "Reboot into USB boot not implemented yet"); +static int reboot_device(libusb_device *device, bool bootsel, uint disable_mask=0) { + // ok, the device isn't in USB boot mode, let's try to reboot via vendor interface + struct libusb_config_descriptor *config; + int ret = libusb_get_active_config_descriptor(device, &config); + if (ret) { + fail(ERROR_USB, "Failed to get descriptor %d\n", ret); } + libusb_device_handle *dev_handle; + ret = libusb_open(device, &dev_handle); + if (ret) { +#if _MSC_VER + fail(ERROR_USB, "Unable to access device to reboot it; Make sure there is a driver installed via Zadig\n", ret); +#else + fail(ERROR_USB, "Unable to access device to reboot it; Use sudo or setup a udev rule\n", ret); +#endif + } + for (int i = 0; i < config->bNumInterfaces; i++) { + if (0xff == config->interface[i].altsetting[0].bInterfaceClass && + RESET_INTERFACE_SUBCLASS == config->interface[i].altsetting[0].bInterfaceSubClass && + RESET_INTERFACE_PROTOCOL == config->interface[i].altsetting[0].bInterfaceProtocol) { + ret = libusb_claim_interface(dev_handle, i); + if (ret) { + fail(ERROR_USB, "Failed to claim interface\n"); + } + if (bootsel) { + ret = libusb_control_transfer(dev_handle, LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE, + RESET_REQUEST_BOOTSEL, disable_mask, i, nullptr, 0, 2000); + } else { + ret = libusb_control_transfer(dev_handle, LIBUSB_REQUEST_TYPE_CLASS | LIBUSB_RECIPIENT_INTERFACE, + RESET_REQUEST_FLASH, 0, i, nullptr, 0, 2000); + } +// if (ret != 0 ) { +// fail(ERROR_UNKNOWN, "Unable to reset the device %d\n", ret); +// } + return 0; +// return ret; + } + } + fail(ERROR_USB, "Unable to locate reset interface on the device"); +} + +bool reboot_command::execute(device_map &devices) { + if (settings.force) { + reboot_device(devices[dr_vidpid_stdio_usb][0].first, settings.reboot_usb); + if (!quiet) { + if (settings.reboot_usb) { + std::cout << "The device was asked to reboot into BOOTSEL mode.\n"; + } else { + std::cout << "The device was asked to reboot into application mode.\n"; + } + } + } else { + // not exclusive, because restoring un-exclusive could fail; also if we're rebooting, we don't much + // care what else is happening. + auto con = get_single_bootsel_device_connection(devices, false); + if (!settings.reboot_usb) { + con.reboot(0, SRAM_END, 500); + } else { + picoboot_memory_access raw_access(con); + uint program_base = SRAM_START; + std::vector program = { + 0x20002100, // movs r0, #0; movs r1, #0 + 0x47104a00, // ldr r2, [pc, #0]; bx r2 + bootrom_func_lookup(raw_access, rom_table_code('U', 'B')) + }; + + raw_access.write_vector(program_base, program); + try { + con.exec(program_base); + } catch (picoboot::connection_error &e) { + // the reset_usb_boot above has a very short delay, so it frequently causes libusb to return + // fairly unpredictable errors... i think it is best to ignore them, because catching a rare + // case where the reboot command fails, is probably less important than potentially confusing + // the user with spurious error messages + } + } + if (!quiet) { + if (settings.reboot_usb) { + std::cout << "The device was rebooted into BOOTSEL mode.\n"; + } else { + std::cout << "The device was rebooted into application mode.\n"; + } + } + } + return true; } #if defined(_WIN32) @@ -1997,6 +2135,8 @@ void cancelled(int) { } int main(int argc, char **argv) { + libusb_context *ctx = nullptr; + int tw=0, th=0; get_terminal_size(tw, th); if (tw) { @@ -2009,6 +2149,9 @@ int main(int argc, char **argv) { return 0; } + // save complicating the grammar + if (settings.force_no_reboot) settings.force = true; + struct libusb_device **devs = nullptr; device_map devices; vector to_close; @@ -2016,58 +2159,143 @@ int main(int argc, char **argv) { try { signal(SIGINT, cancelled); signal(SIGTERM, cancelled); + + if (settings.reboot_usb && settings.reboot_app_specified) { + fail(ERROR_ARGS, "Cannot specify both -u and -a reboot options"); + } + if (selected_cmd->get_device_support() != cmd::none) { if (libusb_init(&ctx)) { fail(ERROR_USB, "Failed to initialise libUSB\n"); } - rc = libusb_get_device_list(ctx, &devs); - if (rc < 0) { - fail(ERROR_USB, "Failed to enumerate USB devices\n"); - } else { - rc = 0; - } - for (libusb_device **dev = devs; *dev; dev++) { - if (settings.bus != -1 && settings.bus != libusb_get_bus_number(*dev)) continue; - if (settings.address != -1 && settings.address != libusb_get_device_address(*dev)) continue; - libusb_device_handle *handle = nullptr; - auto result = picoboot_open_device(*dev, &handle); - if (handle) { - to_close.push_back(handle); - } - if (result != dr_error) { - devices[result].push_back(std::make_pair(*dev, handle)); - } - } } - if (!rc) { - switch (selected_cmd->get_device_support()) { + // we only loop a second time if we want to reboot some devices (which may cause device + for (int tries = 0; !rc && tries < 2; tries++) { + if (ctx) { + if (libusb_get_device_list(ctx, &devs) < 0) { + fail(ERROR_USB, "Failed to enumerate USB devices\n"); + } + for (libusb_device **dev = devs; *dev; dev++) { + if (settings.bus != -1 && settings.bus != libusb_get_bus_number(*dev)) continue; + if (settings.address != -1 && settings.address != libusb_get_device_address(*dev)) continue; + libusb_device_handle *handle = nullptr; + auto result = picoboot_open_device(*dev, &handle); + if (handle) { + to_close.push_back(handle); + } + if (result != dr_error) { + devices[result].push_back(std::make_pair(*dev, handle)); + } + } + } + auto supported = selected_cmd->get_device_support(); + switch (supported) { case cmd::device_support::zero_or_more: if (!settings.filename.empty()) break; // fall thru case cmd::device_support::one: - case cmd::device_support::one_or_more: - if (devices[dr_vidpid_bootrom_ok].empty()) { - std::cout << missing_device_string() << "\n"; + if (devices[dr_vidpid_bootrom_ok].empty() && + (!settings.force || devices[dr_vidpid_stdio_usb].empty())) { bool had_note = false; - auto printer = [&](enum picoboot_device_result r, const string& description) { + fos << missing_device_string(tries>0); + if (tries > 0) { + fos << " It is possible the device is not responding, and will have to be manually entered into BOOTSEL mode.\n"; + had_note = true; // suppress "but:" in this case + } + fos << "\n"; + fos.first_column(0); + fos.hanging_indent(4); + auto printer = [&](enum picoboot_device_result r, const string &description) { if (!had_note && !devices[r].empty()) { - std::cout << "\nbut:\n\n"; + fos << "\nbut:\n\n"; had_note = true; } for (auto d : devices[r]) { - std::cout << bus_device_string(d.first) << description << "\n"; + fos << bus_device_string(d.first) << description << "\n"; } }; - printer(dr_vidpid_bootrom_cant_connect, " appears to be a RP2040 device in BOOTSEL mode, but picotool was unable to connect"); - printer(dr_vidpid_picoprobe, " appears to be a RP2040 PicoProbe device not in BOOTSEL mode."); - printer(dr_vidpid_micropython, " appears to be a RP2040 MicroPython device not in BOOTSEL mode."); + printer(dr_vidpid_bootrom_cant_connect, + " appears to be a RP2040 device in BOOTSEL mode, but picotool was unable to connect"); + printer(dr_vidpid_picoprobe, + " appears to be a RP2040 PicoProbe device not in BOOTSEL mode."); + printer(dr_vidpid_micropython, + " appears to be a RP2040 MicroPython device not in BOOTSEL mode."); + if (selected_cmd->force_requires_pre_reboot()) { +#if defined(_WIN32) + printer(dr_vidpid_stdio_usb, + " appears to be a RP2040 device with a USB serial connection, not in BOOTSEL mode. You can force reboot into BOOTSEL mode via 'picotool reboot -f -u' first."); +#else + printer(dr_vidpid_stdio_usb, + " appears to be a RP2040 device with a USB serial connection, so consider -f (or -F) to force reboot in order to run the command."); +#endif + } else { + // special case message for what is actually just reboot (the only command that doesn't require reboot first) + printer(dr_vidpid_stdio_usb, + " appears to be a RP2040 device with a USB serial connection, so consider -f to force the reboot."); + } rc = ERROR_NO_DEVICE; + } else if (supported == cmd::device_support::one) { + if (devices[dr_vidpid_bootrom_ok].size() > 1 || + (devices[dr_vidpid_bootrom_ok].empty() && devices[dr_vidpid_stdio_usb].size() > 1)) { + fail(ERROR_NOT_POSSIBLE, "Command requires a single RP2040 device to be targeted."); + } + if (!devices[dr_vidpid_bootrom_ok].empty()) { + settings.force = false; // we have a device, so we're not forcing + } + } else if (supported == cmd::device_support::zero_or_more && settings.force && !devices[dr_vidpid_bootrom_ok].empty()) { + // we have usable devices, so lets use them without force + settings.force = false; } + fos.first_column(0); + fos.hanging_indent(0); + break; default: break; } - if (!rc) selected_cmd->execute(devices); + if (!rc) { + if (settings.force && ctx) { // actually ctx should never be null as we are targeting device if force is set, but still + if (devices[dr_vidpid_stdio_usb].size() != 1) { + fail(ERROR_NOT_POSSIBLE, + "Forced command requires a single rebootable RP2040 device to be targeted."); + } + if (selected_cmd->force_requires_pre_reboot()) { + // we reboot into BOOTSEL mode and disable MSC interface (the 1 here) + auto &to_reboot = devices[dr_vidpid_stdio_usb][0].first; + reboot_device(to_reboot, true, 1); + fos << "The device was asked to reboot into BOOTSEL mode so the command can be executed.\n\n"; + for (const auto &handle : to_close) { + libusb_close(handle); + } + libusb_free_device_list(devs, 1); + devs = nullptr; + to_close.clear(); + devices.clear(); + sleep_ms(1200); + + // we now clear settings.force, because we expect the device to have rebooted and be available. + // we also clear any filters, because the device may have moved, so the only way we can find it + // again is to assume it is the only now visible device. + settings.force = false; + settings.address = -1; + settings.bus = -1; + continue; + } + } + if (!selected_cmd->execute(devices) && tries) { + if (settings.force_no_reboot) { + fos << "\nThe device has been left accessible, but without the drive mounted; use 'picotool reboot' to reboot into regular BOOTSEL mode or application mode.\n"; + } else { + // can only really do this with one device + if (devices[dr_vidpid_bootrom_ok].size() == 1) { + reboot_cmd.quiet = true; + reboot_cmd.execute(devices); + fos << "\nThe device was asked to reboot back into application mode.\n"; + } + } + } + break; + } } } catch (command_failure &e) { std::cout << "ERROR: " << e.what() << "\n"; diff --git a/picoboot_connection/picoboot_connection.c b/picoboot_connection/picoboot_connection.c index 198c529..d1f2bee 100644 --- a/picoboot_connection/picoboot_connection.c +++ b/picoboot_connection/picoboot_connection.c @@ -24,6 +24,7 @@ static bool verbose; #define PRODUCT_ID_RP2_USBBOOT 0x0003u #define PRODUCT_ID_PICOPROBE 0x0004u #define PRODUCT_ID_MICROPYTHON 0x0005u +#define PRODUCT_ID_STDIO_USB 0x000au uint32_t crc32_for_byte(uint32_t remainder) { const uint32_t POLYNOMIAL = 0x4C11DB7; @@ -72,6 +73,8 @@ enum picoboot_device_result picoboot_open_device(libusb_device *device, libusb_d return dr_vidpid_micropython; case PRODUCT_ID_PICOPROBE: return dr_vidpid_picoprobe; + case PRODUCT_ID_STDIO_USB: + return dr_vidpid_stdio_usb; case PRODUCT_ID_RP2_USBBOOT: break; default: diff --git a/picoboot_connection/picoboot_connection.h b/picoboot_connection/picoboot_connection.h index 796b57c..ebdabfc 100644 --- a/picoboot_connection/picoboot_connection.h +++ b/picoboot_connection/picoboot_connection.h @@ -9,6 +9,7 @@ // todo we should use fully encapsulate libusb +#include #include #include "boot/picoboot.h" @@ -24,6 +25,7 @@ enum picoboot_device_result { dr_vidpid_picoprobe, dr_vidpid_unknown, dr_error, + dr_vidpid_stdio_usb, }; enum picoboot_device_result picoboot_open_device(libusb_device *device, libusb_device_handle **dev_handle); From a0a0ebeb5f890fdad2282fbd595029777a94d352 Mon Sep 17 00:00:00 2001 From: Graham Sanderson Date: Thu, 21 Oct 2021 14:52:08 -0500 Subject: [PATCH 007/101] fix memory overlap check (#39) (#42) --- main.cpp | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/main.cpp b/main.cpp index 8212cf5..fcd67b6 100644 --- a/main.cpp +++ b/main.cpp @@ -177,14 +177,15 @@ template struct range_map { if (r.to != r.from) { assert(r.to > r.from); // check we don't overlap any existing map entries - auto f = m.lower_bound(r.to); // f is first element that starts after or on r.to - if (f != m.begin()) { - f--; - } - if (f != m.end()) { - // due to edge cases above, f is either the entry before - // or after r, so just check for any overlap - fail(ERROR_FORMAT, "Found overlapping memory ranges 0x%08x->0x%08x and 0x%08x->%08x\n", f->first, f->second.first, r.from, r.to); + + auto f = m.upper_bound(r.from); // first element that starts after r.from + if (f != m.begin()) f--; // back up, to catch element that starts on or before r.from + for(; f != m.end() && f->first < r.to; f++) { // loop till we can't possibly overlap + range r2(f->first, f->second.first); + if (r2.intersects(r)) { + fail(ERROR_FORMAT, "Found overlapping memory ranges 0x%08x->0x%08x and 0x%08x->%08x\n", + r.from, r.to, r2.from, r2.to); + } } m.insert(std::make_pair(r.from, std::make_pair(r.to, t))); } From 0f5c61161bc7994dbc8c6818012ed237b1ee9b4c Mon Sep 17 00:00:00 2001 From: Graham Sanderson Date: Thu, 21 Oct 2021 14:57:27 -0500 Subject: [PATCH 008/101] Add a sudo suggestion when can't connect on linux/macos (#43) * Add a sudo suggestion when can't connect on linux/macos --- main.cpp | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/main.cpp b/main.cpp index fcd67b6..0651b6f 100644 --- a/main.cpp +++ b/main.cpp @@ -2216,8 +2216,13 @@ int main(int argc, char **argv) { fos << bus_device_string(d.first) << description << "\n"; } }; +#if defined(__linux__) || defined(__APPLE__) printer(dr_vidpid_bootrom_cant_connect, - " appears to be a RP2040 device in BOOTSEL mode, but picotool was unable to connect"); + " appears to be a RP2040 device in BOOTSEL mode, but picotool was unable to connect. Maybe try 'sudo' or check your permissions."); +#else + printer(dr_vidpid_bootrom_cant_connect, + " appears to be a RP2040 device in BOOTSEL mode, but picotool was unable to connect. You may need to install a driver. See \"Getting started with Raspberry Pi Pico\" for more information"); +#endif printer(dr_vidpid_picoprobe, " appears to be a RP2040 PicoProbe device not in BOOTSEL mode."); printer(dr_vidpid_micropython, From faeb0ca490178bba5f5b28776e0968ade126ac33 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Thu, 21 Oct 2021 15:07:50 -0500 Subject: [PATCH 009/101] fixup build for SDK1.3.0 and add version check --- CMakeLists.txt | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 65ae8b5..bb2f239 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -17,6 +17,11 @@ get_filename_component(PICO_SDK_PATH "${PICO_SDK_PATH}" REALPATH BASE_DIR "${CMA if (NOT EXISTS ${PICO_SDK_PATH}) message(FATAL_ERROR "Directory '${PICO_SDK_PATH}' not found") endif () +include(${PICO_SDK_PATH}/pico_sdk_version.cmake) + +if (PICO_SDK_VERSION_STRING VERSION_LESS "1.3.0") + message(FATAL_ERROR "Raspberry Pi Pico SDK version 1.3.0 (or later) required. Your version is ${PICO_SDK_VERSION_STRING}") +endif() set(CMAKE_CXX_STANDARD 14) @@ -31,6 +36,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/common/pico_binary_info pico_binary_info) add_subdirectory(${PICO_SDK_PATH}/src/common/boot_uf2 boot_uf2_headers) add_subdirectory(${PICO_SDK_PATH}/src/common/boot_picoboot boot_picoboot_headers) + add_subdirectory(${PICO_SDK_PATH}/src/common/pico_usb_reset_interface pico_usb_reset_interface) add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) @@ -45,7 +51,14 @@ else() target_include_directories(picotool PRIVATE ${LIBUSB_INCLUDE_DIR}) # todo, this is a bit of an abstraction failure; but don't want to rev the SDK just for this right now target_include_directories(picotool PRIVATE ${PICO_SDK_PATH}/src/rp2_common/pico_stdio_usb/include) - target_link_libraries(picotool pico_binary_info boot_uf2_headers boot_picoboot_headers pico_platform_headers picoboot_connection_cxx ${LIBUSB_LIBRARIES}) + target_link_libraries(picotool + pico_binary_info + boot_uf2_headers + boot_picoboot_headers + pico_platform_headers + pico_usb_reset_interface_headers + picoboot_connection_cxx + ${LIBUSB_LIBRARIES}) # allow `make install` install(TARGETS picotool) endif() From 07adb6eb55c08b97d5ca8a1b0ffd2c04329b8296 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Fri, 22 Oct 2021 16:39:59 -0500 Subject: [PATCH 010/101] bug in error case --- main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main.cpp b/main.cpp index 0651b6f..fc3499d 100644 --- a/main.cpp +++ b/main.cpp @@ -210,7 +210,7 @@ template struct range_map { uint32_t next(uint32_t p) { auto f = m.upper_bound(p); if (f == m.end()) { - std::numeric_limits::max(); + return std::numeric_limits::max(); } return f->first; } From c4ea85c2d10f4a54ebc225696a929c4b9f4fbeb6 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Fri, 22 Oct 2021 16:45:49 -0500 Subject: [PATCH 011/101] update documentation to match command output --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fc35840..fa2730e 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ PICOTOOL: SYNOPSYS: picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] picotool info [-b] [-p] [-d] [-l] [-a] [-t ] - picotool load [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] + picotool load [-n] [-N] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] @@ -99,12 +99,23 @@ TARGET SELECTION: Filter devices by USB bus number --address Filter devices by USB device address + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing + the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing + the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but + without the RPI-RP2 drive mounted To target a file The file name -t Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + ``` + +Note the -f arguments vary slightly for Windows vs macOS / Unix platforms. + e.g. ```text @@ -174,9 +185,9 @@ SAVE: Save the program / memory stored in flash on the device to a file. SYNOPSYS: - picotool save [-p] [--bus ] [--address ] [-t ] - picotool save -a [--bus ] [--address ] [-t ] - picotool save -r [--bus ] [--address ] [-t ] + picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] + picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] + picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] OPTIONS: Selection of data to save @@ -185,7 +196,8 @@ OPTIONS: -a, --all Save all of flash memory -r, --range - Save a range of memory; note that the range is expanded to 256 byte boundaries + Save a range of memory. Note that UF2s always store complete 256 byte-aligned blocks of 256 bytes, and the range is + expanded accordingly The lower address bound in hex @@ -195,6 +207,13 @@ OPTIONS: Filter devices by USB bus number --address Filter devices by USB device address + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing + the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing + the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but + without the RPI-RP2 drive mounted File to save to The file name From 3d513e0801c17bf5e865c4c5873cffcaaa7c4b48 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Fri, 22 Oct 2021 17:29:04 -0500 Subject: [PATCH 012/101] update readme and help text --- README.md | 4 ++-- main.cpp | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa2730e..fc8d088 100644 --- a/README.md +++ b/README.md @@ -26,9 +26,9 @@ nmake ``` ## Overview -Picotool is a tool for inspecting RP2040 binaries, and interacting with RP2040 devices when they are in BOOTSEL mode. +`picotool` is a tool for inspecting RP2040 binaries, and interacting with RP2040 devices when they are in BOOTSEL mode. (As of version 1.1 of `picotool` it is also possible to interact with RP2040 devices that are not in BOOTSEL mode, but are using USB stdio support from the Raspberry Pi Pico SDK by using the `-f` argument of `picotool`). -Note for full documentation see https://rptl.io/pico-get-started +Note for additional documentation see https://rptl.io/pico-get-started ```text $ picotool help diff --git a/main.cpp b/main.cpp index fc3499d..0f4c5b1 100644 --- a/main.cpp +++ b/main.cpp @@ -357,7 +357,7 @@ struct verify_command : public cmd { (option('r', "--range").set(settings.range_set) % "Compare a sub range of memory only" & hex("from").set(settings.from) % "The lower address bound in hex" & hex("to").set(settings.to) % "The upper address bound in hex").force_expand_help(true) + - (option('o', "--offset").set(settings.offset_set) % "Specify a load address for a BIN file" & + (option('o', "--offset").set(settings.offset_set) % "Specify the load address when comparing with a BIN file" & hex("offset").set(settings.offset) % "Load offset (memory address; default 0x10000000)").force_expand_help(true) ).min(0).doc_non_optional(true) % "Address options" ); @@ -408,7 +408,7 @@ struct load_command : public cmd { ).min(0).doc_non_optional(true) % "Post load actions" + file_selection % "File to load from" + ( - option('o', "--offset").set(settings.offset_set) % "Specify a load address for a BIN file" & + option('o', "--offset").set(settings.offset_set) % "Specify the load address for a BIN file" & hex("offset").set(settings.offset) % "Load offset (memory address; default 0x10000000)" ).force_expand_help(true) % "BIN file options" + device_selection % "Target device selection" From 3f150db353a0505f43a7b4f91641b237acb21f65 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Mon, 1 Nov 2021 14:34:35 -0500 Subject: [PATCH 013/101] Change version to 1.1.0 --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index bb2f239..b6c591a 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.0-develop) + set(PICOTOOL_VERSION 1.1.0) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE From 6f427e66354aa3092d61a5952fa39a94bc1d5c2f Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Mon, 1 Nov 2021 14:38:14 -0500 Subject: [PATCH 014/101] start 1.1.1 dev --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index b6c591a..6096a7d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.0) + set(PICOTOOL_VERSION 1.1.1-develop) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE From 03f28122cc170535f35e5bf8fa37be024489f5eb Mon Sep 17 00:00:00 2001 From: akhil harihar Date: Thu, 2 Dec 2021 19:58:59 +0530 Subject: [PATCH 015/101] fix README.md incorrect cmake function name --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d193f7c..569e8b2 100644 --- a/README.md +++ b/README.md @@ -399,7 +399,7 @@ You can use ```cmake pico_set_program_name(foo "not foo") # as "foo" would be the default pico_set_program_description(foo "this is a foo") -pico_set_program_version_string(foo "0.00001a") +pico_set_program_version(foo "0.00001a") pico_set_program_url(foo "www.plinth.com/foo") ``` From 27ec1bf0c701e14137b2f6f3ad2cf7fe65331183 Mon Sep 17 00:00:00 2001 From: Rich Lane Date: Sat, 27 Aug 2022 10:01:30 -0700 Subject: [PATCH 016/101] add --update option to picotool load to skip unchanged sectors (#46) Co-authored-by: akhil harihar --- main.cpp | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/main.cpp b/main.cpp index 0f4c5b1..b4e33e3 100644 --- a/main.cpp +++ b/main.cpp @@ -278,6 +278,7 @@ struct _settings { bool execute = false; bool no_overwrite = false; bool no_overwrite_force = false; + bool update = false; } load; struct { @@ -403,6 +404,7 @@ struct load_command : public cmd { ( option('n', "--no-overwrite").set(settings.load.no_overwrite) % "When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence of the program in flash, the command fails" + option('N', "--no-overwrite-unsafe").set(settings.load.no_overwrite_force) % "When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence of the program in flash, the load continues anyway" + + option('u', "--update").set(settings.load.update) % "Skip writing flash sectors that already contain identical data" + option('v', "--verify").set(settings.load.verify) % "Verify the data was written correctly" + option('x', "--execute").set(settings.load.execute) % "Attempt to execute the downloaded file as a program after the load" ).min(0).doc_non_optional(true) % "Post load actions" + @@ -1859,9 +1861,18 @@ bool load_command::execute(device_map &devices) { file_buf.insert(file_buf.begin(), read_range.from - aligned_range.from, 0); file_buf.insert(file_buf.end(), aligned_range.to - read_range.to, 0); assert(file_buf.size() == FLASH_SECTOR_ERASE_SIZE); - con.exit_xip(); - con.flash_erase(aligned_range.from, FLASH_SECTOR_ERASE_SIZE); - raw_access.write_vector(aligned_range.from, file_buf); + + bool skip = false; + if (settings.load.update) { + vector read_device_buf; + raw_access.read_into_vector(aligned_range.from, batch_size, read_device_buf); + skip = file_buf == read_device_buf; + } + if (!skip) { + con.exit_xip(); + con.flash_erase(aligned_range.from, FLASH_SECTOR_ERASE_SIZE); + raw_access.write_vector(aligned_range.from, file_buf); + } base = read_range.to; // about to add batch_size } else { file_access.read_into_vector(base, this_batch, file_buf); From e8eb789f91523f0f22c537171db3a30635d4d9c0 Mon Sep 17 00:00:00 2001 From: David Grayson Date: Wed, 8 Feb 2023 16:29:24 -0700 Subject: [PATCH 017/101] MSYS2 / MinGW support (#61) --- README.md | 14 ++++++++++++++ cmake/FindLIBUSB.cmake | 4 ++-- main.cpp | 6 +++--- 3 files changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 569e8b2..f3d0ab5 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,20 @@ cd build cmake -G "NMake Makefiles" .. nmake ``` + +Windows with MinGW in MSYS2: + +No need to download libusb separately or set LIBUSB_ROOT. + +```console +pacman -S $MINGW_PACKAGE_PREFIX-{toolchain,cmake,libusb} +mkdir build +cd build +MSYS2_ARG_CONV_EXCL=- cmake .. -G"MSYS Makefiles" -DCMAKE_INSTALL_PREFIX=$MINGW_PREFIX +make +make install DESTDIR=/ # optional +``` + ## Overview `picotool` is a tool for inspecting RP2040 binaries, and interacting with RP2040 devices when they are in BOOTSEL mode. (As of version 1.1 of `picotool` it is also possible to interact with RP2040 devices that are not in BOOTSEL mode, but are using USB stdio support from the Raspberry Pi Pico SDK by using the `-f` argument of `picotool`). diff --git a/cmake/FindLIBUSB.cmake b/cmake/FindLIBUSB.cmake index 26e924c..169f594 100644 --- a/cmake/FindLIBUSB.cmake +++ b/cmake/FindLIBUSB.cmake @@ -12,12 +12,12 @@ if (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) # in cache already set(LIBUSB_FOUND TRUE) else (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) - IF (NOT WIN32) + IF (NOT MSVC) # use pkg-config to get the directories and then use these values # in the FIND_PATH() and FIND_LIBRARY() calls find_package(PkgConfig) pkg_check_modules(PC_LIBUSB libusb-1.0) - ENDIF(NOT WIN32) + ENDIF () FIND_PATH(LIBUSB_INCLUDE_DIR libusb.h HINTS $ENV{LIBUSB_ROOT}/include/libusb-1.0 PATHS ${PC_LIBUSB_INCLUDEDIR} ${PC_LIBUSB_INCLUDE_DIRS}) diff --git a/main.cpp b/main.cpp index b4e33e3..31d0c8c 100644 --- a/main.cpp +++ b/main.cpp @@ -4,7 +4,7 @@ * SPDX-License-Identifier: BSD-3-Clause */ -#ifdef _MSC_VER +#ifdef _WIN32 #define _CRT_SECURE_NO_WARNINGS #endif @@ -37,7 +37,7 @@ #endif // tsk namespace is polluted on windows -#ifdef _MSC_VER +#ifdef _WIN32 #undef min #undef max @@ -2043,7 +2043,7 @@ static int reboot_device(libusb_device *device, bool bootsel, uint disable_mask= libusb_device_handle *dev_handle; ret = libusb_open(device, &dev_handle); if (ret) { -#if _MSC_VER +#if _WIN32 fail(ERROR_USB, "Unable to access device to reboot it; Make sure there is a driver installed via Zadig\n", ret); #else fail(ERROR_USB, "Unable to access device to reboot it; Use sudo or setup a udev rule\n", ret); From 07c0b0bd6979fda8dd8c0ea541657229e9fce6b2 Mon Sep 17 00:00:00 2001 From: Jeff Hastings Date: Wed, 8 Feb 2023 18:31:37 -0500 Subject: [PATCH 018/101] add runtime destination for install target (#47) --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 6096a7d..0e1ea1b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -60,5 +60,5 @@ else() picoboot_connection_cxx ${LIBUSB_LIBRARIES}) # allow `make install` - install(TARGETS picotool) + install(TARGETS picotool RUNTIME DESTINATION bin) endif() From 0691b073f0c5da58a572785c077b858d674f0785 Mon Sep 17 00:00:00 2001 From: birdybro Date: Wed, 8 Feb 2023 16:40:25 -0700 Subject: [PATCH 019/101] add missing debian/ubuntu pre-req to readme (#59) cmake was missing for some reason --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f3d0ab5..75ee141 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ You also need to install `libusb-1.0`. Linux/Mac: use your favorite package tool. For example, on Ubuntu: ```console -sudo apt install build-essential pkg-config libusb-1.0-0-dev +sudo apt install build-essential pkg-config libusb-1.0-0-dev cmake ``` Windows: download from here https://libusb.info/ From b58de26f8e2bb2295b508ba9187536564a06c203 Mon Sep 17 00:00:00 2001 From: Graham Sanderson Date: Thu, 9 Feb 2023 10:36:11 -0600 Subject: [PATCH 020/101] Minor Fixes (#67) * Minor Fixes * replace sprintf with snprintf * allow connection to a device which previously had a failed command, by resetting on new connection * very hacky fix/workaround for attempting to read strings near the end of the image * update picotool load help for -u --- README.md | 2 +- cli.h | 3 +- main.cpp | 39 +++++++++++-------- picoboot_connection/picoboot_connection_cxx.h | 7 +++- 4 files changed, 31 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 75ee141..8f4b74b 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,7 @@ PICOTOOL: SYNOPSYS: picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] picotool info [-b] [-p] [-d] [-l] [-a] [-t ] - picotool load [-n] [-N] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] + picotool load [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] diff --git a/cli.h b/cli.h index 5d79ec1..e68ff58 100644 --- a/cli.h +++ b/cli.h @@ -88,7 +88,7 @@ namespace cli { void add(const string& major_group, const string& minor_group, const string& option, const string& description) { auto &v = contents[major_group][minor_group]; - // we don't want to repeated the same option + // we don't want to repeat the same option if (std::find_if(v.begin(), v.end(), [&](const auto &x) { return x.first == option; }) == v.end()) { v.emplace_back(option, description); } @@ -301,6 +301,7 @@ namespace cli { vector synopsys() const override { string s = string("<") + this->_name + ">"; + if (this->_max > 1) s += ".."; return {s}; } diff --git a/main.cpp b/main.cpp index 31d0c8c..9d867c0 100644 --- a/main.cpp +++ b/main.cpp @@ -344,7 +344,7 @@ struct info_command : public cmd { string get_doc() const override { return "Display information from the target device(s) or file.\nWithout any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode"; } -} info_cmd; +}; struct verify_command : public cmd { verify_command() : cmd("verify") {} @@ -367,7 +367,7 @@ struct verify_command : public cmd { string get_doc() const override { return "Check that the device contents match those in the file."; } -} verify_cmd; +}; struct save_command : public cmd { save_command() : cmd("save") {} @@ -393,7 +393,7 @@ struct save_command : public cmd { string get_doc() const override { return "Save the program / memory stored in flash on the device to a file."; } -} save_cmd; +}; struct load_command : public cmd { load_command() : cmd("load") {} @@ -420,7 +420,7 @@ struct load_command : public cmd { string get_doc() const override { return "Load the program / memory range stored in a file onto the device."; } -} load_cmd; +}; struct help_command : public cmd { help_command() : cmd("help") {} @@ -439,7 +439,7 @@ struct help_command : public cmd { string get_doc() const override { return "Show general help or help for a specific command"; } -} help_cmd; +}; struct version_command : public cmd { version_command() : cmd("version") {} @@ -464,7 +464,7 @@ struct version_command : public cmd { string get_doc() const override { return "Display picotool version"; } -} version_cmd; +}; struct reboot_command : public cmd { bool quiet; @@ -993,15 +993,19 @@ bool find_binary_info(memory_access& access, binary_info_header &hdr) { } string read_string(memory_access &access, uint32_t addr) { - const uint max_length = 256; // todo better incremental length handling - auto v = access.read_vector(addr, 256); - uint length; - for (length = 0; length < max_length; length++) { - if (!v[length]) { - break; + // note this implementation is still wrong, it just tries a bit harder to not try to read off the end of the image (which causes + // an assertion failure) + uint max_length; + for(max_length = 8; max_length <= 1024; max_length *=2 ) { + auto v = access.read_vector(addr, max_length); + uint length; + for (length = 0; length < max_length; length++) { + if (!v[length]) { + return string(v.data(), length); + } } } - return string(v.data(), length); + return ""; } struct bi_visitor_base { @@ -1573,17 +1577,18 @@ string missing_device_string(bool wasRetry) { strcpy(b, "No "); } char *buf = b + strlen(b); + int buf_len = b + sizeof(b) - buf; if (settings.address != -1) { if (settings.bus != -1) { - sprintf(buf, "accessible RP2040 device in BOOTSEL mode was found at bus %d, address %d.", settings.bus, settings.address); + snprintf(buf, buf_len, "accessible RP2040 device in BOOTSEL mode was found at bus %d, address %d.", settings.bus, settings.address); } else { - sprintf(buf, "accessible RP2040 devices in BOOTSEL mode were found with address %d.", settings.address); + snprintf(buf, buf_len, "accessible RP2040 devices in BOOTSEL mode were found with address %d.", settings.address); } } else { if (settings.bus != -1) { - sprintf(buf, "accessible RP2040 devices in BOOTSEL mode were found found on bus %d.", settings.bus); + snprintf(buf, buf_len, "accessible RP2040 devices in BOOTSEL mode were found found on bus %d.", settings.bus); } else { - sprintf(buf, "accessible RP2040 devices in BOOTSEL mode were found."); + snprintf(buf, buf_len,"accessible RP2040 devices in BOOTSEL mode were found."); } } return b; diff --git a/picoboot_connection/picoboot_connection_cxx.h b/picoboot_connection/picoboot_connection_cxx.h index 0944e16..1d33557 100644 --- a/picoboot_connection/picoboot_connection_cxx.h +++ b/picoboot_connection/picoboot_connection_cxx.h @@ -28,11 +28,16 @@ namespace picoboot { struct connection { explicit connection(libusb_device_handle *device, bool exclusive = true) : device(device), exclusive(exclusive) { + // do a device reset in case it was left in a bad state + reset(); if (exclusive) exclusive_access(EXCLUSIVE); } ~connection() { if (exclusive) { - picoboot_exclusive_access(device, NOT_EXCLUSIVE); + if (picoboot_exclusive_access(device, NOT_EXCLUSIVE)) { + // failed to restore exclusive access, so just reset + reset(); + } } } void reset(); From 0bce82e933e4fb70b6e0a063e36da309fca4e691 Mon Sep 17 00:00:00 2001 From: mbrunnen Date: Thu, 9 Feb 2023 17:40:39 +0100 Subject: [PATCH 021/101] Add udev rules for picotool (#50) Co-authored-by: Graham Sanderson --- README.md | 43 ++++++++++++++++++++++++++++-------------- udev/99-picotool.rules | 10 ++++++++++ 2 files changed, 39 insertions(+), 14 deletions(-) create mode 100644 udev/99-picotool.rules diff --git a/README.md b/README.md index 8f4b74b..fffa32c 100644 --- a/README.md +++ b/README.md @@ -4,15 +4,39 @@ You need to set PICO_SDK_PATH in the environment, or pass it to cmake. You also need to install `libusb-1.0`. -Linux/Mac: use your favorite package tool. For example, on Ubuntu: +### Linux / macOS + +Use your favorite package tool to install dependencies. For example, on Ubuntu: ```console sudo apt install build-essential pkg-config libusb-1.0-0-dev cmake ``` -Windows: download from here https://libusb.info/ +On Linux you can add udev rules in order to run picotool without sudo: -If you are on Windows, set LIBUSB_ROOT environment variable to the install directory +```console +sudo cp udev/99-picotool.rules /etc/udev/rules.d/ +``` + +### Windows + +##### For Windows without MinGW + +Download libUSB from here https://libusb.info/ + +set LIBUSB_ROOT environment variable to the install directory. +```console +mkdir build +cd build +cmake -G "NMake Makefiles" .. +nmake +``` + +##### For Windows with MinGW in WSL + +Download libUSB from here https://libusb.info/ + +set LIBUSB_ROOT environment variable to the install directory. ```console mkdir build @@ -21,18 +45,9 @@ cmake .. make ``` -for Windows non MinGW/WSL: +##### For Windows with MinGW in MSYS2: -```console -mkdir build -cd build -cmake -G "NMake Makefiles" .. -nmake -``` - -Windows with MinGW in MSYS2: - -No need to download libusb separately or set LIBUSB_ROOT. +No need to download libusb separately or set `LIBUSB_ROOT`. ```console pacman -S $MINGW_PACKAGE_PREFIX-{toolchain,cmake,libusb} diff --git a/udev/99-picotool.rules b/udev/99-picotool.rules new file mode 100644 index 0000000..10bd436 --- /dev/null +++ b/udev/99-picotool.rules @@ -0,0 +1,10 @@ +SUBSYSTEM=="usb", \ + ATTRS{idVendor}=="2e8a", \ + ATTRS{idProduct}=="0003", \ + MODE="660", \ + GROUP="plugdev" +SUBSYSTEM=="usb", \ + ATTRS{idVendor}=="2e8a", \ + ATTRS{idProduct}=="000a", \ + MODE="660", \ + GROUP="plugdev" From ee491cbda7704ea105cfb9cc775cb50978226432 Mon Sep 17 00:00:00 2001 From: Graham Sanderson Date: Fri, 10 Feb 2023 07:45:01 -0600 Subject: [PATCH 022/101] Support non contiguous flash ELF/UF2, fix problem reading strings near end of file (#68) Co-authored-by: Jan Niehusmann --- main.cpp | 112 ++++++++++++++++++++++++++++++++++--------------------- 1 file changed, 70 insertions(+), 42 deletions(-) diff --git a/main.cpp b/main.cpp index 9d867c0..d0c00dc 100644 --- a/main.cpp +++ b/main.cpp @@ -201,7 +201,7 @@ template struct range_map { } f--; assert(p >= f->first); - if (p > f->second.first) { + if (p >= f->second.first) { throw not_mapped_exception(); } return std::make_pair(mapping(p - f->first, f->second.first - f->first), f->second.second); @@ -701,7 +701,11 @@ static inline uint32_t rom_table_code(char c1, char c2) { } struct memory_access { - virtual void read(uint32_t, uint8_t *buffer, uint size) = 0; + virtual void read(uint32_t p, uint8_t *buffer, uint size) { + read(p, buffer, size, false); + } + + virtual void read(uint32_t, uint8_t *buffer, uint size, bool zero_fill) = 0; virtual bool is_device() { return false; } @@ -728,10 +732,10 @@ struct memory_access { } // read a vector of types that have a raw_type_mapping - template vector read_vector(uint32_t addr, uint count) { + template vector read_vector(uint32_t addr, uint count, bool zero_fill = false) { assert(count); vector::access_type> buffer(count); - read(addr, (uint8_t *)buffer.data(), count * sizeof(typename raw_type_mapping::access_type)); + read(addr, (uint8_t *)buffer.data(), count * sizeof(typename raw_type_mapping::access_type), zero_fill); vector v; v.reserve(count); for(const auto &e : buffer) { @@ -740,9 +744,9 @@ struct memory_access { return v; } - template void read_into_vector(uint32_t addr, uint count, vector &v) { + template void read_into_vector(uint32_t addr, uint count, vector &v, bool zero_fill = false) { vector::access_type> buffer(count); - if (count) read(addr, (uint8_t *)buffer.data(), count * sizeof(typename raw_type_mapping::access_type)); + if (count) read(addr, (uint8_t *)buffer.data(), count * sizeof(typename raw_type_mapping::access_type), zero_fill); v.clear(); v.reserve(count); for(const auto &e : buffer) { @@ -786,7 +790,7 @@ struct picoboot_memory_access : public memory_access { return FLASH_START; } - void read(uint32_t address, uint8_t *buffer, uint size) override { + void read(uint32_t address, uint8_t *buffer, uint size, __unused bool zero_fill) override { if (flash == get_memory_type(address)) { connection.exit_xip(); } @@ -854,13 +858,25 @@ struct file_memory_access : public memory_access { return binary_start; } - void read(uint32_t address, uint8_t *buffer, uint32_t size) override { + void read(uint32_t address, uint8_t *buffer, uint32_t size, bool zero_fill) override { while (size) { - auto result = rmap.get(address); - uint this_size = std::min(size, result.first.max_offset - result.first.offset); - assert( this_size); - fseek(file, result.second + result.first.offset, SEEK_SET); - fread(buffer, this_size, 1, file); + uint this_size; + try { + auto result = rmap.get(address); + this_size = std::min(size, result.first.max_offset - result.first.offset); + assert(this_size); + fseek(file, result.second + result.first.offset, SEEK_SET); + fread(buffer, this_size, 1, file); + } catch (not_mapped_exception &e) { + if (zero_fill) { + // address is not in a range, so fill up to next range with zeros + this_size = rmap.next(address) - address; + this_size = std::min(this_size, size); + memset(buffer, 0, this_size); + } else { + throw e; + } + } buffer += this_size; address += this_size; size -= this_size; @@ -883,12 +899,12 @@ private: struct remapped_memory_access : public memory_access { remapped_memory_access(memory_access &wrap, range_map rmap) : wrap(wrap), rmap(rmap) {} - void read(uint32_t address, uint8_t *buffer, uint size) override { + void read(uint32_t address, uint8_t *buffer, uint size, bool zero_fill) override { while (size) { auto result = get_remapped(address); uint this_size = std::min(size, result.first.max_offset - result.first.offset); assert( this_size); - wrap.read(result.second + result.first.offset, buffer, this_size); + wrap.read(result.second + result.first.offset, buffer, this_size, zero_fill); buffer += this_size; address += this_size; size -= this_size; @@ -993,20 +1009,15 @@ bool find_binary_info(memory_access& access, binary_info_header &hdr) { } string read_string(memory_access &access, uint32_t addr) { - // note this implementation is still wrong, it just tries a bit harder to not try to read off the end of the image (which causes - // an assertion failure) - uint max_length; - for(max_length = 8; max_length <= 1024; max_length *=2 ) { - auto v = access.read_vector(addr, max_length); - uint length; - for (length = 0; length < max_length; length++) { - if (!v[length]) { - return string(v.data(), length); - } + const uint max_length = 512; + auto v = access.read_vector(addr, max_length, true); // zero fill + uint length; + for (length = 0; length < max_length; length++) { + if (!v[length]) { + break; } } - return ""; -} + return string(v.data(), length);} struct bi_visitor_base { void visit(memory_access& access, const binary_info_header& hdr) { @@ -1780,7 +1791,7 @@ bool save_command::execute(device_map &devices) { return false; } -vector get_colaesced_ranges(file_memory_access &file_access) { +vector get_coalesced_ranges(file_memory_access &file_access) { auto rmap = file_access.get_rmap(); auto ranges = rmap.ranges(); std::sort(ranges.begin(), ranges.end(), [](const range& a, const range &b) { @@ -1789,7 +1800,14 @@ vector get_colaesced_ranges(file_memory_access &file_access) { // coalesce all the contiguous ranges for(auto i = ranges.begin(); i < ranges.end(); ) { if (i != ranges.end() - 1) { - if (i->to == (i+1)->from) { + uint32_t erase_size; + // we want to coalesce flash sectors together (this ends up creating ranges that may have holes) + if( get_memory_type(i->from) == flash ) { + erase_size = FLASH_SECTOR_ERASE_SIZE; + } else { + erase_size = 1; + } + if (i->to / erase_size == (i+1)->from / erase_size) { i->to = (i+1)->to; i = ranges.erase(i+1) - 1; continue; @@ -1826,7 +1844,7 @@ bool load_command::execute(device_map &devices) { visitor.visit(access, hdr); } } - auto ranges = get_colaesced_ranges(file_access); + auto ranges = get_coalesced_ranges(file_access); for (auto mem_range : ranges) { enum memory_type t1 = get_memory_type(mem_range.from); enum memory_type t2 = get_memory_type(mem_range.to); @@ -1854,14 +1872,15 @@ bool load_command::execute(device_map &devices) { bool ok = true; vector file_buf; vector device_buf; - for (uint32_t base = mem_range.from; base < mem_range.to && ok; ) { + for (uint32_t base = mem_range.from; base < mem_range.to && ok;) { uint32_t this_batch = std::min(mem_range.to - base, batch_size); if (type == flash) { // we have to erase an entire page, so then fill with zeros - range aligned_range(base & ~(FLASH_SECTOR_ERASE_SIZE - 1), (base & ~(FLASH_SECTOR_ERASE_SIZE - 1)) + FLASH_SECTOR_ERASE_SIZE); + range aligned_range(base & ~(FLASH_SECTOR_ERASE_SIZE - 1), + (base & ~(FLASH_SECTOR_ERASE_SIZE - 1)) + FLASH_SECTOR_ERASE_SIZE); range read_range(base, base + this_batch); read_range.intersect(aligned_range); - file_access.read_into_vector(read_range.from, read_range.to - read_range.from, file_buf); + file_access.read_into_vector(read_range.from, read_range.to - read_range.from, file_buf, true); // zero fill to cope with holes // zero padding up to FLASH_SECTOR_ERASE_SIZE file_buf.insert(file_buf.begin(), read_range.from - aligned_range.from, 0); file_buf.insert(file_buf.end(), aligned_range.to - read_range.to, 0); @@ -1869,14 +1888,14 @@ bool load_command::execute(device_map &devices) { bool skip = false; if (settings.load.update) { - vector read_device_buf; - raw_access.read_into_vector(aligned_range.from, batch_size, read_device_buf); - skip = file_buf == read_device_buf; + vector read_device_buf; + raw_access.read_into_vector(aligned_range.from, batch_size, read_device_buf); + skip = file_buf == read_device_buf; } if (!skip) { - con.exit_xip(); - con.flash_erase(aligned_range.from, FLASH_SECTOR_ERASE_SIZE); - raw_access.write_vector(aligned_range.from, file_buf); + con.exit_xip(); + con.flash_erase(aligned_range.from, FLASH_SECTOR_ERASE_SIZE); + raw_access.write_vector(aligned_range.from, file_buf); } base = read_range.to; // about to add batch_size } else { @@ -1887,6 +1906,9 @@ bool load_command::execute(device_map &devices) { bar.progress(base - mem_range.from, mem_range.to - mem_range.from); } } + } + for (auto mem_range : ranges) { + enum memory_type type = get_memory_type(mem_range.from); if (settings.load.verify) { bool ok = true; { @@ -1897,7 +1919,10 @@ bool load_command::execute(device_map &devices) { uint32_t pos = mem_range.from; for (uint32_t base = mem_range.from; base < mem_range.to && ok; base += batch_size) { uint32_t this_batch = std::min(mem_range.to - base, batch_size); - file_access.read_into_vector(base, this_batch, file_buf); + // note we pass zero_fill = true in case the file has holes, but this does + // mean that the verification will fail if those holes are not filed with zeros + // on the device + file_access.read_into_vector(base, this_batch, file_buf, true); raw_access.read_into_vector(base, this_batch, device_buf); assert(file_buf.size() == device_buf.size()); for (uint i = 0; i < this_batch; i++) { @@ -1940,7 +1965,7 @@ bool verify_command::execute(device_map &devices) { auto file_access = get_file_memory_access(); auto con = get_single_bootsel_device_connection(devices); picoboot_memory_access raw_access(con); - auto ranges = get_colaesced_ranges(file_access); + auto ranges = get_coalesced_ranges(file_access); if (settings.range_set) { range filter(settings.from, settings.to); for(auto& range : ranges) { @@ -1966,7 +1991,10 @@ bool verify_command::execute(device_map &devices) { uint32_t batch_size = 1024; for(uint32_t base = mem_range.from; base < mem_range.to && ok; base += batch_size) { uint32_t this_batch = std::min(mem_range.to - base, batch_size); - file_access.read_into_vector(base, this_batch, file_buf); + // note we pass zero_fill = true in case the file has holes, but this does + // mean that the verification will fail if those holes are not filed with zeros + // on the device + file_access.read_into_vector(base, this_batch, file_buf, true); raw_access.read_into_vector(base, this_batch, device_buf); assert(file_buf.size() == device_buf.size()); for(uint i=0;i Date: Fri, 10 Feb 2023 08:49:19 -0600 Subject: [PATCH 023/101] set version 1.1.1 --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 0e1ea1b..f4340e2 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.1-develop) + set(PICOTOOL_VERSION 1.1.1) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE From 8112f577f93e7a1d7df0425b8d2175731f3f1b7f Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Fri, 10 Feb 2023 09:07:08 -0600 Subject: [PATCH 024/101] start 1.1.2-develop --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index f4340e2..caf63ee 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.1) + set(PICOTOOL_VERSION 1.1.2-develop) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE From 82418bbdc10fc22205e81766ffab2ad61f8e2608 Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Sat, 11 Feb 2023 15:49:52 +0000 Subject: [PATCH 025/101] Add `picotool help load` output to README file (#72) --- README.md | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 57 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fffa32c..1962104 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,6 @@ TARGET SELECTION: The file name -t Specify file type (uf2 | elf | bin) explicitly, ignoring file extension - ``` Note the -f arguments vary slightly for Windows vs macOS / Unix platforms. @@ -209,6 +208,63 @@ Build Information build date: Dec 31 2020 ``` +## load + +Load allows you to write data from a file into flash + +```text +$ picotool help load +LOAD: + Load the program / memory range stored in a file onto the device. + +SYNOPSYS: + picotool load [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] + +OPTIONS: + Post load actions + -n, --no-overwrite + When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence + of the program in flash, the command fails + -N, --no-overwrite-unsafe + When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence + of the program in flash, the load continues anyway + -u, --update + Skip writing flash sectors that already contain identical data + -v, --verify + Verify the data was written correctly + -x, --execute + Attempt to execute the downloaded file as a program after the load + File to load from + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + BIN file options + -o, --offset + Specify the load address for a BIN file + + Load offset (memory address; default 0x10000000) + Target device selection + --bus + Filter devices by USB bus number + --address + Filter devices by USB device address + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing + the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing + the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but + without the RPI-RP2 drive mounted +``` + +e.g. + +```text +$ picotool load blink.uf2 +Loading into Flash: [==============================] 100% +``` + ## save Save allows you to save a range of memory or a program or the whole of flash from the device to a BIN file or a UF2 file From 641779adeaf40b206939c1d77561094f0df3140f Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Sat, 11 Feb 2023 15:50:36 +0000 Subject: [PATCH 026/101] Typos (#71) --- main.cpp | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/main.cpp b/main.cpp index d0c00dc..8ae15a9 100644 --- a/main.cpp +++ b/main.cpp @@ -1017,7 +1017,8 @@ string read_string(memory_access &access, uint32_t addr) { break; } } - return string(v.data(), length);} + return string(v.data(), length); +} struct bi_visitor_base { void visit(memory_access& access, const binary_info_header& hdr) { @@ -1567,7 +1568,7 @@ void info_guts(memory_access &raw_access) { } for(const auto& item : info) { fos.first_column(1); - fos << (item.first + ":");; + fos << (item.first + ":"); fos.first_column(1 + tab); fos << (item.second + "\n"); } @@ -1920,7 +1921,7 @@ bool load_command::execute(device_map &devices) { for (uint32_t base = mem_range.from; base < mem_range.to && ok; base += batch_size) { uint32_t this_batch = std::min(mem_range.to - base, batch_size); // note we pass zero_fill = true in case the file has holes, but this does - // mean that the verification will fail if those holes are not filed with zeros + // mean that the verification will fail if those holes are not filled with zeros // on the device file_access.read_into_vector(base, this_batch, file_buf, true); raw_access.read_into_vector(base, this_batch, device_buf); @@ -1992,7 +1993,7 @@ bool verify_command::execute(device_map &devices) { for(uint32_t base = mem_range.from; base < mem_range.to && ok; base += batch_size) { uint32_t this_batch = std::min(mem_range.to - base, batch_size); // note we pass zero_fill = true in case the file has holes, but this does - // mean that the verification will fail if those holes are not filed with zeros + // mean that the verification will fail if those holes are not filled with zeros // on the device file_access.read_into_vector(base, this_batch, file_buf, true); raw_access.read_into_vector(base, this_batch, device_buf); From b7a1d9c1fcc01a4780ec47f3dfe0b2efee75a372 Mon Sep 17 00:00:00 2001 From: dp111 <19616418+dp111@users.noreply.github.com> Date: Wed, 1 Mar 2023 19:12:03 +0000 Subject: [PATCH 027/101] Help text typo SYNOPSYS => SYNOPSIS (#74) --- main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main.cpp b/main.cpp index d0c00dc..1746f9b 100644 --- a/main.cpp +++ b/main.cpp @@ -563,7 +563,7 @@ int parse(const int argc, char **argv) { } } if (!no_synopsis) { - section_header("SYNOPSYS"); + section_header("SYNOPSIS"); for (auto &s : synopsis) { fos.first_column(tab); fos.hanging_indent((int)tool_name.length() + tab); From 0cb44732894134aacac347fa1179cfde82ef268d Mon Sep 17 00:00:00 2001 From: xavier deschuyteneer Date: Sun, 5 Mar 2023 18:52:31 +0100 Subject: [PATCH 028/101] bugfix #75 : picotool load invalid bus parsing (#76) --- main.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/main.cpp b/main.cpp index 1746f9b..157174f 100644 --- a/main.cpp +++ b/main.cpp @@ -294,7 +294,7 @@ std::shared_ptr selected_cmd; auto device_selection = ( - (option("--bus") & integer("bus").min_value(1).max_value(255).set(settings.bus) + (option("--bus") & integer("bus").min_value(0).max_value(255).set(settings.bus) .if_missing([] { return "missing bus number"; })) % "Filter devices by USB bus number" + (option("--address") & integer("addr").min_value(1).max_value(127).set(settings.address) .if_missing([] { return "missing address"; })) % "Filter devices by USB device address" From 9c7cb4357418c17c232b0b9835742afc453f09f5 Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Sun, 5 Mar 2023 23:18:10 +0000 Subject: [PATCH 029/101] Propogate typo-fix from #74 into README.md (#78) --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1962104..e33e4ba 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ $ picotool help PICOTOOL: Tool for interacting with a RP2040 device in BOOTSEL mode, or with a RP2040 binary -SYNOPSYS: +SYNOPSIS: picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] picotool info [-b] [-p] [-d] [-l] [-a] [-t ] picotool load [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] @@ -110,7 +110,7 @@ INFO: Display information from the target device(s) or file. Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode -SYNOPSYS: +SYNOPSIS: picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] picotool info [-b] [-p] [-d] [-l] [-a] [-t ] @@ -217,7 +217,7 @@ $ picotool help load LOAD: Load the program / memory range stored in a file onto the device. -SYNOPSYS: +SYNOPSIS: picotool load [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] OPTIONS: @@ -274,7 +274,7 @@ $ picotool help save SAVE: Save the program / memory stored in flash on the device to a file. -SYNOPSYS: +SYNOPSIS: picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] From f6fe6b7c321a2def8950d2a440335dfba19e2eab Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Tue, 13 Jun 2023 16:30:20 -0500 Subject: [PATCH 030/101] set version 1.1.2 --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index caf63ee..ff3e787 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.2-develop) + set(PICOTOOL_VERSION 1.1.2) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE From 5fa2c200079d5f198fa2134e0412da66200296a6 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Tue, 13 Jun 2023 16:30:45 -0500 Subject: [PATCH 031/101] start 1.1.3 dev --- CMakeLists.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ff3e787..f207ade 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,7 +40,7 @@ else() add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.2) + set(PICOTOOL_VERSION 1.1.3-develop) set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") target_compile_definitions(picotool PRIVATE From e461b2b6f91bdaa3c9d1c9218a1fa40b2fb2efdc Mon Sep 17 00:00:00 2001 From: "Earle F. Philhower, III" Date: Wed, 3 Jan 2024 13:19:36 -0800 Subject: [PATCH 032/101] Fix fread unused_result warning (#92) * Fix fread unused_result warning Check the read of the source binary succeeded, and if not generate an exception and let the user know. Fixes #91 * Use fail() to signal file read error --- main.cpp | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/main.cpp b/main.cpp index 1f38c24..b823117 100644 --- a/main.cpp +++ b/main.cpp @@ -866,7 +866,10 @@ struct file_memory_access : public memory_access { this_size = std::min(size, result.first.max_offset - result.first.offset); assert(this_size); fseek(file, result.second + result.first.offset, SEEK_SET); - fread(buffer, this_size, 1, file); + auto read_bytes = fread(buffer, 1, this_size, file); + if (this_size != read_bytes) { + fail(ERROR_READ_FAILED, "Source file read error"); + } } catch (not_mapped_exception &e) { if (zero_fill) { // address is not in a range, so fill up to next range with zeros From b19b6aa6c76263c2c473eac148c7268102998492 Mon Sep 17 00:00:00 2001 From: armandomontanez Date: Tue, 16 Jul 2024 21:03:28 -0700 Subject: [PATCH 033/101] Add Bazel build (#101) * Add initial Bazel build * Add README for Bazel build * Use external registry for Bazel modules * Fix Bazel build on Windows Removes an unused .bzl file and fixes incompatible copts on Windows. * Prepare for BCR-hosted rules_libusb * Explicitly enable exceptions in Bazel build * Ready for BCR-provided dependencies * Set Bazel versions to 1.1.3-rc1 * Add Windows linking fix * Link to Bazelisk in Bazel getting started instructions * Apply buildifier formatting fixes * Add missing platforms dependency Adds a missing bzlmod dep on `platforms` to fix https://pwbug.dev/258836641 --------- Co-authored-by: Ted Pudlik --- .bazelrc | 1 + .gitignore | 4 ++++ BUILD.bazel | 44 ++++++++++++++++++++++++++++++++++++++++++++ MODULE.bazel | 9 +++++++++ bazel/README.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 107 insertions(+) create mode 100644 .bazelrc create mode 100644 .gitignore create mode 100644 BUILD.bazel create mode 100644 MODULE.bazel create mode 100644 bazel/README.md diff --git a/.bazelrc b/.bazelrc new file mode 100644 index 0000000..4b19b28 --- /dev/null +++ b/.bazelrc @@ -0,0 +1 @@ +common --verbose_failures diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..d6631ca --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +bazel-* + +# Ignore until https://github.com/bazelbuild/bazel/issues/20369 is fixed. +MODULE.bazel.lock diff --git a/BUILD.bazel b/BUILD.bazel new file mode 100644 index 0000000..41595e5 --- /dev/null +++ b/BUILD.bazel @@ -0,0 +1,44 @@ +package(default_visibility = ["//visibility:public"]) + +cc_binary( + name = "picotool", + srcs = [ + "cli.h", + "clipp/clipp.h", + "elf.h", + "main.cpp", + "picoboot_connection/picoboot_connection.c", + "picoboot_connection/picoboot_connection.h", + "picoboot_connection/picoboot_connection_cxx.cpp", + "picoboot_connection/picoboot_connection_cxx.h", + ], + copts = select({ + "@platforms//os:windows": [], + "//conditions:default": [ + "-fexceptions", + "-Wno-delete-non-abstract-non-virtual-dtor", + "-Wno-reorder-ctor", + "-Wno-unused-variable", + ], + }), + # TODO: There's probably a nicer way to do share this with CMake. + defines = [ + 'PICOTOOL_VERSION=\\"1.1.3-rc1\\"', + 'SYSTEM_VERSION=\\"host\\"', + 'COMPILER_INFO=\\"local\\"', + ], + # Windows does not behave nicely with the automagic force_dynamic_linkage_enabled. + dynamic_deps = select({ + "@rules_libusb//:force_dynamic_linkage_enabled": ["@libusb//:libusb_dynamic"], + "//conditions:default": [], + }), + includes = ["picoboot_connection"], + deps = [ + "@libusb", + "@pico-sdk//src/common/boot_picoboot:boot_picoboot", + "@pico-sdk//src/common/boot_uf2:boot_uf2", + "@pico-sdk//src/common/pico_base:platform_defs", + "@pico-sdk//src/common/pico_binary_info:pico_binary_info", + "@pico-sdk//src/rp2_common/pico_stdio_usb:reset_interface_headers", + ], +) diff --git a/MODULE.bazel b/MODULE.bazel new file mode 100644 index 0000000..6adcec6 --- /dev/null +++ b/MODULE.bazel @@ -0,0 +1,9 @@ +module(name = "picotool", version="1.1.3-rc1") + +bazel_dep(name = "rules_libusb", version="0.1.0-rc1") +bazel_dep(name = "pico-sdk", version="1.6.0-rc1") +bazel_dep(name = "platforms", version="0.0.7") + +libusb = use_extension("@rules_libusb//:extensions.bzl", "libusb") +libusb.source_release(min_version = "1.0.22") +use_repo(libusb, "libusb") diff --git a/bazel/README.md b/bazel/README.md new file mode 100644 index 0000000..a1ad0f5 --- /dev/null +++ b/bazel/README.md @@ -0,0 +1,49 @@ +## Prerequisites + +You'll need Bazel (v7.0.0 or higher) or Bazelisk (a self-updating Bazel +launcher) to build the Pico SDK. + +We strongly recommend you set up +[Bazelisk](https://bazel.build/install/bazelisk). + +### Linux + +Use your favorite package tool to install dependencies. For example, on Ubuntu: + +```console +sudo apt install build-essential libudev-dev +``` + +On Linux you can add udev rules in order to run picotool without sudo: + +```console +sudo cp udev/99-picotool.rules /etc/udev/rules.d/ +``` + +### macOS + +To build on macOS, you'll need to ensure Xcode is installed. + +```console +xcode-select --install +``` + +### Windows + +To build on Windows, you must install [Visual Studio for Desktop Development With C++](https://visualstudio.microsoft.com/vs/features/cplusplus/). + +## Building picotool + +From the root of the picotool repository, run Bazel with the following command: + +```console +bazelisk build //:picotool +``` + +## Running picotool + +To run picotool, run the binary built by Bazel: + +```console +./bazel-bin/picotool +``` From 8a9af99ab10b20b1c6afb30cd9384e562a6647f9 Mon Sep 17 00:00:00 2001 From: graham sanderson Date: Thu, 8 Aug 2024 05:55:42 -0500 Subject: [PATCH 034/101] release 2.0.0 - RP2350 and SDK2.0.0 changes --- .gitignore | 1 + BUILD.bazel | 84 +- CMakeLists.txt | 314 +- MODULE.bazel | 25 +- README.md | 827 +- WORKSPACE | 0 bazel/BUILD.bazel | 21 + bazel/binh.py | 71 + bazel/data_locs.cpp | 5 + bazel/defs.bzl | 40 + bazel/jsonh.py | 60 + bazel/mbedtls.BUILD | 18 + bintool/BUILD.bazel | 34 + bintool/CMakeLists.txt | 32 + bintool/bintool.cpp | 906 + bintool/bintool.h | 41 + bintool/mbedtls_wrapper.c | 242 + bintool/mbedtls_wrapper.h | 60 + bintool/metadata.h | 656 + bootrom.end.bin | Bin 0 -> 512 bytes cli.h | 225 +- cmake/FindLIBUSB.cmake | 52 +- cmake/bin.template.h | 5 + cmake/binh.cmake | 28 + cmake/jsonh.cmake | 2 + cmake/picotoolConfig.cmake | 3 + cmake/rp2350.json.template.h | 6 + data_locs.h | 5 + data_locs.template.cpp | 7 + default-pt.json | 36 + elf.h | 60 - elf/BUILD.bazel | 20 + elf/CMakeLists.txt | 6 + elf/addresses.h | 94 + elf/elf.h | 126 + elf/elf_file.cpp | 520 + elf/elf_file.h | 72 + elf/portable_endian.h | 172 + elf2uf2/BUILD.bazel | 20 + elf2uf2/CMakeLists.txt | 6 + elf2uf2/elf2uf2.cpp | 338 + elf2uf2/elf2uf2.h | 28 + errors/BUILD.bazel | 8 + errors/CMakeLists.txt | 3 + errors/errors.cpp | 16 + errors/errors.h | 41 + lib/BUILD.bazel | 6 + lib/CMakeLists.txt | 27 + lib/include/mbedtls_config.h | 4217 +++ lib/nlohmann_json/BUILD.bazel | 7 + lib/nlohmann_json/CMakeLists.txt | 126 + lib/nlohmann_json/LICENSE.MIT | 21 + .../single_include/nlohmann/json.hpp | 24766 ++++++++++++ lib/whereami/BUILD.bazel | 14 + lib/whereami/CMakeLists.txt | 7 + lib/whereami/whereami++.cpp | 101 + lib/whereami/whereami++.h | 66 + lib/whereami/whereami.c | 801 + lib/whereami/whereami.h | 64 + main.cpp | 5976 ++- no_otp.cpp | 23 + otp.cpp | 84 + otp.h | 97 + otp_header_parser/BUILD.bazel | 13 + otp_header_parser/CMakeLists.txt | 18 + otp_header_parser/otp_header_parse.cpp | 389 + otp_header_parser/rp2350.json.h | 31174 ++++++++++++++++ picoboot_connection/BUILD.bazel | 21 + picoboot_connection/CMakeLists.txt | 5 +- picoboot_connection/picoboot_connection.c | 345 +- picoboot_connection/picoboot_connection.h | 86 +- .../picoboot_connection_cxx.cpp | 35 + picoboot_connection/picoboot_connection_cxx.h | 12 +- sample-permissions.json | 26 + sample-wl.json | 25 + udev/99-picotool.rules | 14 + xip_ram_perms.cpp | 39 + xip_ram_perms.h | 12 + xip_ram_perms/BUILD.bazel | 17 + xip_ram_perms/CMakeLists.txt | 42 + xip_ram_perms/pico_sdk_import.cmake | 62 + xip_ram_perms/set_perms.c | 192 + xip_ram_perms/xip_ram_perms.elf | Bin 0 -> 342480 bytes 83 files changed, 73501 insertions(+), 765 deletions(-) create mode 100644 WORKSPACE create mode 100644 bazel/BUILD.bazel create mode 100644 bazel/binh.py create mode 100644 bazel/data_locs.cpp create mode 100644 bazel/defs.bzl create mode 100644 bazel/jsonh.py create mode 100644 bazel/mbedtls.BUILD create mode 100644 bintool/BUILD.bazel create mode 100644 bintool/CMakeLists.txt create mode 100644 bintool/bintool.cpp create mode 100644 bintool/bintool.h create mode 100644 bintool/mbedtls_wrapper.c create mode 100644 bintool/mbedtls_wrapper.h create mode 100644 bintool/metadata.h create mode 100644 bootrom.end.bin create mode 100644 cmake/bin.template.h create mode 100644 cmake/binh.cmake create mode 100644 cmake/jsonh.cmake create mode 100644 cmake/picotoolConfig.cmake create mode 100644 cmake/rp2350.json.template.h create mode 100644 data_locs.h create mode 100644 data_locs.template.cpp create mode 100644 default-pt.json delete mode 100644 elf.h create mode 100644 elf/BUILD.bazel create mode 100644 elf/CMakeLists.txt create mode 100644 elf/addresses.h create mode 100644 elf/elf.h create mode 100644 elf/elf_file.cpp create mode 100644 elf/elf_file.h create mode 100644 elf/portable_endian.h create mode 100644 elf2uf2/BUILD.bazel create mode 100644 elf2uf2/CMakeLists.txt create mode 100644 elf2uf2/elf2uf2.cpp create mode 100644 elf2uf2/elf2uf2.h create mode 100644 errors/BUILD.bazel create mode 100644 errors/CMakeLists.txt create mode 100644 errors/errors.cpp create mode 100644 errors/errors.h create mode 100644 lib/BUILD.bazel create mode 100644 lib/CMakeLists.txt create mode 100644 lib/include/mbedtls_config.h create mode 100644 lib/nlohmann_json/BUILD.bazel create mode 100644 lib/nlohmann_json/CMakeLists.txt create mode 100644 lib/nlohmann_json/LICENSE.MIT create mode 100644 lib/nlohmann_json/single_include/nlohmann/json.hpp create mode 100644 lib/whereami/BUILD.bazel create mode 100644 lib/whereami/CMakeLists.txt create mode 100644 lib/whereami/whereami++.cpp create mode 100644 lib/whereami/whereami++.h create mode 100644 lib/whereami/whereami.c create mode 100644 lib/whereami/whereami.h create mode 100644 no_otp.cpp create mode 100644 otp.cpp create mode 100644 otp.h create mode 100644 otp_header_parser/BUILD.bazel create mode 100644 otp_header_parser/CMakeLists.txt create mode 100644 otp_header_parser/otp_header_parse.cpp create mode 100644 otp_header_parser/rp2350.json.h create mode 100644 picoboot_connection/BUILD.bazel create mode 100644 sample-permissions.json create mode 100644 sample-wl.json create mode 100644 xip_ram_perms.cpp create mode 100644 xip_ram_perms.h create mode 100644 xip_ram_perms/BUILD.bazel create mode 100644 xip_ram_perms/CMakeLists.txt create mode 100644 xip_ram_perms/pico_sdk_import.cmake create mode 100644 xip_ram_perms/set_perms.c create mode 100755 xip_ram_perms/xip_ram_perms.elf diff --git a/.gitignore b/.gitignore index d6631ca..804c311 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ +build/* bazel-* # Ignore until https://github.com/bazelbuild/bazel/issues/20369 is fixed. diff --git a/BUILD.bazel b/BUILD.bazel index 41595e5..2bc5b2a 100644 --- a/BUILD.bazel +++ b/BUILD.bazel @@ -1,44 +1,102 @@ +load("//bazel:defs.bzl", "otp_header_parse", "picotool_binary_data_header") + package(default_visibility = ["//visibility:public"]) +picotool_binary_data_header( + name = "rp2350_rom", + src = "bootrom.end.bin", + out = "rp2350.rom.h", +) + +# TODO: Make it possible to build the prebuilt from source. +picotool_binary_data_header( + name = "xip_ram_perms_elf", + src = "//xip_ram_perms:xip_ram_perms_prebuilt", + out = "xip_ram_perms_elf.h", +) + +cc_library( + name = "xip_ram_perms", + srcs = ["xip_ram_perms.cpp"], + hdrs = [ + "xip_ram_perms.h", + "xip_ram_perms_elf.h", + ], + deps = [ + "//bazel:data_locs", + "//lib/whereami", + ], +) + +filegroup( + name = "data_locs_header", + srcs = ["data_locs.h"], +) + +otp_header_parse( + name = "otp_header", + src = "@pico-sdk//src/rp2350/hardware_regs:otp_data_header", + out = "rp2350.json.h", +) + cc_binary( name = "picotool", srcs = [ "cli.h", "clipp/clipp.h", - "elf.h", "main.cpp", - "picoboot_connection/picoboot_connection.c", - "picoboot_connection/picoboot_connection.h", - "picoboot_connection/picoboot_connection_cxx.cpp", - "picoboot_connection/picoboot_connection_cxx.h", + "otp.cpp", + "otp.h", + "rp2350.json.h", + "rp2350.rom.h", + "xip_ram_perms.cpp", ], copts = select({ - "@platforms//os:windows": [], + "@rules_cc//cc/compiler:msvc-cl": [ + "/std:c++20", + ], "//conditions:default": [ "-fexceptions", "-Wno-delete-non-abstract-non-virtual-dtor", "-Wno-reorder-ctor", "-Wno-unused-variable", + "-Wno-unused-but-set-variable", ], }), - # TODO: There's probably a nicer way to do share this with CMake. defines = [ - 'PICOTOOL_VERSION=\\"1.1.3-rc1\\"', + # TODO: There's probably a nicer way to share the version with CMake. + 'PICOTOOL_VERSION=\\"2.0.0\\"', 'SYSTEM_VERSION=\\"host\\"', 'COMPILER_INFO=\\"local\\"', + "SUPPORT_A0=0", + "SUPPORT_A2=1", + "PICOTOOL_CODE_OTP=0", + # TODO: Make it possible to compile from source. + "USE_PRECOMPILED=1", ], # Windows does not behave nicely with the automagic force_dynamic_linkage_enabled. dynamic_deps = select({ "@rules_libusb//:force_dynamic_linkage_enabled": ["@libusb//:libusb_dynamic"], "//conditions:default": [], }), - includes = ["picoboot_connection"], deps = [ + ":xip_ram_perms", + "//bazel:data_locs", + "//bintool", + "//elf", + "//elf2uf2", + "//errors", + "//lib/nlohmann_json:json", + "//picoboot_connection", "@libusb", - "@pico-sdk//src/common/boot_picoboot:boot_picoboot", - "@pico-sdk//src/common/boot_uf2:boot_uf2", - "@pico-sdk//src/common/pico_base:platform_defs", - "@pico-sdk//src/common/pico_binary_info:pico_binary_info", + "@pico-sdk//src/common/boot_picobin_headers", + "@pico-sdk//src/common/boot_picoboot_headers", + "@pico-sdk//src/common/boot_uf2_headers", + "@pico-sdk//src/common/pico_base_headers", + "@pico-sdk//src/common/pico_binary_info", + "@pico-sdk//src/common/pico_usb_reset_interface_headers", + "@pico-sdk//src/rp2350/hardware_regs:otp_data", + "@pico-sdk//src/rp2_common/pico_bootrom:pico_bootrom_headers", "@pico-sdk//src/rp2_common/pico_stdio_usb:reset_interface_headers", ], ) diff --git a/CMakeLists.txt b/CMakeLists.txt index f207ade..d75982e 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -19,46 +19,288 @@ if (NOT EXISTS ${PICO_SDK_PATH}) endif () include(${PICO_SDK_PATH}/pico_sdk_version.cmake) -if (PICO_SDK_VERSION_STRING VERSION_LESS "1.3.0") - message(FATAL_ERROR "Raspberry Pi Pico SDK version 1.3.0 (or later) required. Your version is ${PICO_SDK_VERSION_STRING}") +if (PICO_SDK_VERSION_STRING VERSION_LESS "2.0.0") + message(FATAL_ERROR "Raspberry Pi Pico SDK version 2.0.0 (or later) required. Your version is ${PICO_SDK_VERSION_STRING}") endif() -set(CMAKE_CXX_STANDARD 14) +# Set PICOTOOL_CODE_OTP to compile OTP definitions in - otherwise, they are included from JSON +if (NOT PICOTOOL_CODE_OTP) + set(PICOTOOL_CODE_OTP 0) +endif() + +# allow installing to flat dir +include(GNUInstallDirs) +if (PICOTOOL_FLAT_INSTALL) + set(INSTALL_CONFIGDIR picotool) + set(INSTALL_DATADIR picotool) + set(INSTALL_BINDIR picotool) +else() + set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake/picotool) + set(INSTALL_DATADIR ${CMAKE_INSTALL_DATADIR}/picotool) + set(INSTALL_BINDIR ${CMAKE_INSTALL_BINDIR}) +endif() + +# todo better install paths for this +set(DATA_LOCS "./" "${CMAKE_INSTALL_PREFIX}/${INSTALL_DATADIR}/") +message(${DATA_LOCS}) +string(REGEX REPLACE ";" "\",\"" DATA_LOCS_VEC "${DATA_LOCS}") +configure_file(data_locs.template.cpp ${CMAKE_CURRENT_BINARY_DIR}/data_locs.cpp) + + +include(ExternalProject) + +if (MSVC) + set(CMAKE_CXX_STANDARD 20) +else() + set(CMAKE_CXX_STANDARD 14) +endif() list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake) -add_subdirectory(picoboot_connection) - -find_package(LIBUSB) -if (NOT LIBUSB_FOUND) - message(FATAL_ERROR "picotool cannot be built because libUSB is not found") -else() - add_subdirectory(${PICO_SDK_PATH}/src/common/pico_binary_info pico_binary_info) - add_subdirectory(${PICO_SDK_PATH}/src/common/boot_uf2 boot_uf2_headers) - add_subdirectory(${PICO_SDK_PATH}/src/common/boot_picoboot boot_picoboot_headers) - add_subdirectory(${PICO_SDK_PATH}/src/common/pico_usb_reset_interface pico_usb_reset_interface) - add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) - - add_executable(picotool main.cpp) - set(PICOTOOL_VERSION 1.1.3-develop) - set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION}") - set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") - target_compile_definitions(picotool PRIVATE - PICOTOOL_VERSION="${PICOTOOL_VERSION}" - SYSTEM_VERSION="${SYSTEM_VERSION}" - COMPILER_INFO="${COMPILER_INFO}" +if (NOT PICOTOOL_NO_LIBUSB) + # compile xip_ram_perms.elf + if (NOT DEFINED USE_PRECOMPILED) + set(USE_PRECOMPILED true) + endif() + ExternalProject_Add(xip_ram_perms + PREFIX xip_ram_perms + SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/xip_ram_perms + BINARY_DIR ${CMAKE_BINARY_DIR}/xip_ram_perms + CMAKE_ARGS + "-DCMAKE_MAKE_PROGRAM:FILEPATH=${CMAKE_MAKE_PROGRAM}" + "-DPICO_SDK_PATH:FILEPATH=${PICO_SDK_PATH}" + "-DUSE_PRECOMPILED:BOOL=${USE_PRECOMPILED}" + BUILD_ALWAYS 1 # todo remove this + INSTALL_COMMAND "" ) - target_include_directories(picotool PRIVATE ${LIBUSB_INCLUDE_DIR}) - # todo, this is a bit of an abstraction failure; but don't want to rev the SDK just for this right now - target_include_directories(picotool PRIVATE ${PICO_SDK_PATH}/src/rp2_common/pico_stdio_usb/include) - target_link_libraries(picotool - pico_binary_info - boot_uf2_headers - boot_picoboot_headers - pico_platform_headers - pico_usb_reset_interface_headers - picoboot_connection_cxx - ${LIBUSB_LIBRARIES}) - # allow `make install` - install(TARGETS picotool RUNTIME DESTINATION bin) + + set(XIP_RAM_PERMS_ELF ${CMAKE_BINARY_DIR}/xip_ram_perms/xip_ram_perms.elf) + add_executable(xip_ram_perms_elf IMPORTED) + add_dependencies(xip_ram_perms_elf xip_ram_perms) + set_property(TARGET xip_ram_perms_elf PROPERTY IMPORTED_LOCATION ${XIP_RAM_PERMS_ELF}) + # copy xip_ram_perms.elf into build directory + add_custom_command(TARGET xip_ram_perms + COMMAND ${CMAKE_COMMAND} -E copy ${XIP_RAM_PERMS_ELF} ${CMAKE_BINARY_DIR}/xip_ram_perms.elf + DEPENDS xip_ram_perms + ) + + # We want to generate headers from WELCOME.HTM etc. + ExternalProject_Add(otp_header_parser + PREFIX otp_header_parser + SOURCE_DIR ${CMAKE_CURRENT_LIST_DIR}/otp_header_parser + BINARY_DIR ${CMAKE_BINARY_DIR}/otp_header_parser + CMAKE_ARGS "-DCODE_OTP=${PICOTOOL_CODE_OTP}" + BUILD_ALWAYS 1 # todo remove this + DOWNLOAD_COMMAND "" + INSTALL_COMMAND "" + ) + + add_executable(otp_header_parse IMPORTED) + # think this is the best way to do this - this should work in MSVC now, and possibly Xcode but that's untested + add_dependencies(otp_header_parse otp_header_parser) + get_property(is_multi_config GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG) + if (is_multi_config) + # use the first config + list(GET CMAKE_CONFIGURATION_TYPES 0 tmp_config) + set_property(TARGET otp_header_parse PROPERTY IMPORTED_LOCATION ${CMAKE_BINARY_DIR}/otp_header_parser/${tmp_config}/otp_header_parse) + else() + set_property(TARGET otp_header_parse PROPERTY IMPORTED_LOCATION ${CMAKE_BINARY_DIR}/otp_header_parser/otp_header_parse) + endif() + + if (PICOTOOL_CODE_OTP) + set(GENERATED_H ${CMAKE_CURRENT_BINARY_DIR}/otp_contents.h) + add_custom_target(generate_otp_header DEPENDS ${GENERATED_H}) + add_custom_command(OUTPUT ${GENERATED_H} + COMMENT "Generating ${GENERATED_H}" + DEPENDS ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include/hardware/regs/otp_data.h + COMMAND otp_header_parse ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include/hardware/regs/otp_data.h ${GENERATED_H} + ) + elseif(MSVC) + set(GENERATED_JSON ${CMAKE_CURRENT_BINARY_DIR}/rp2350_otp_contents.json) + add_custom_target(generate_otp_header DEPENDS ${GENERATED_JSON}) + add_custom_command(OUTPUT ${GENERATED_JSON} + COMMENT "Generating ${GENERATED_JSON}" + DEPENDS ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include/hardware/regs/otp_data.h + COMMAND otp_header_parse ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include/hardware/regs/otp_data.h ${GENERATED_JSON} + ) + # Cannot include json in the binary, as the string is too long, so needs to use pre-generated xxd output + configure_file(${CMAKE_CURRENT_LIST_DIR}/otp_header_parser/rp2350.json.h ${CMAKE_CURRENT_BINARY_DIR}/rp2350.json.h COPYONLY) + else() + set(GENERATED_JSON ${CMAKE_CURRENT_BINARY_DIR}/rp2350_otp_contents.json) + add_custom_target(generate_otp_header DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/rp2350.json.h) + add_custom_command(OUTPUT ${GENERATED_JSON} + COMMENT "Generating ${GENERATED_JSON}" + DEPENDS ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include/hardware/regs/otp_data.h + COMMAND otp_header_parse ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include/hardware/regs/otp_data.h ${GENERATED_JSON} + ) + add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/rp2350.json.h + COMMAND ${CMAKE_COMMAND} + -D GENERATED_JSON=${GENERATED_JSON} + -P ${CMAKE_CURRENT_LIST_DIR}/cmake/jsonh.cmake + DEPENDS ${GENERATED_JSON} + COMMENT "Configuring rp2350.json.h" + VERBATIM) + + endif() +endif() + +add_custom_target(binary_data DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/rp2350.rom.h ${CMAKE_CURRENT_BINARY_DIR}/xip_ram_perms_elf.h) +add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/rp2350.rom.h + COMMAND ${CMAKE_COMMAND} + -D BINARY_FILE=${CMAKE_CURRENT_LIST_DIR}/bootrom.end.bin + -D OUTPUT_NAME=rp2350.rom + -P ${CMAKE_CURRENT_LIST_DIR}/cmake/binh.cmake + COMMENT "Configuring rp2350.rom.h" + VERBATIM) +add_custom_command(OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/xip_ram_perms_elf.h + COMMAND ${CMAKE_COMMAND} + -D BINARY_FILE=${XIP_RAM_PERMS_ELF} + -D OUTPUT_NAME=xip_ram_perms_elf + -P ${CMAKE_CURRENT_LIST_DIR}/cmake/binh.cmake + DEPENDS xip_ram_perms + COMMENT "Configuring xip_ram_perms_elf.h" + VERBATIM) + +add_subdirectory(errors) + +add_subdirectory(picoboot_connection) +add_subdirectory(elf) +add_subdirectory(elf2uf2) + +# To configure mbedtls +# todo make the configuration better +set(MBEDTLS_CONFIG_FILE "mbedtls_config.h") +add_compile_options(-I${CMAKE_SOURCE_DIR}/lib/include) + +add_subdirectory(lib) + +add_subdirectory(bintool) + +if (NOT PICOTOOL_NO_LIBUSB) + find_package(LIBUSB) + set(OTP_EXE otp.cpp) +else() + set(OTP_EXE no_otp.cpp) +endif() + +add_subdirectory(${PICO_SDK_PATH}/src/common/pico_binary_info pico_binary_info) +add_subdirectory(${PICO_SDK_PATH}/src/common/boot_uf2_headers boot_uf2_headers) +add_subdirectory(${PICO_SDK_PATH}/src/common/boot_picoboot_headers boot_picoboot_headers) +add_subdirectory(${PICO_SDK_PATH}/src/common/boot_picobin_headers boot_picobin_headers) +add_subdirectory(${PICO_SDK_PATH}/src/common/pico_usb_reset_interface_headers pico_usb_reset_interface_headers) +add_subdirectory(${PICO_SDK_PATH}/src/host/pico_platform pico_platform) + +add_library(pico_bootrom_headers INTERFACE) +target_include_directories(pico_bootrom_headers INTERFACE ${PICO_SDK_PATH}/src/rp2_common/pico_bootrom/include) +add_library(regs_headers INTERFACE) +target_include_directories(regs_headers INTERFACE ${PICO_SDK_PATH}/src/rp2350/hardware_regs/include) + +# Main picotool executable +add_executable(picotool + data_locs.cpp + ${OTP_EXE} + main.cpp) +if (NOT PICOTOOL_NO_LIBUSB) + target_sources(picotool PRIVATE xip_ram_perms.cpp) + add_dependencies(picotool generate_otp_header xip_ram_perms_elf binary_data) +endif() +set(PROJECT_VERSION 2.0.0) +set(PICOTOOL_VERSION 2.0.0) +set(SYSTEM_VERSION "${CMAKE_SYSTEM_NAME}") +set(COMPILER_INFO "${CMAKE_C_COMPILER_ID}-${CMAKE_C_COMPILER_VERSION}, ${CMAKE_BUILD_TYPE}") +target_compile_definitions(picotool PRIVATE + PICOTOOL_VERSION="${PICOTOOL_VERSION}" + SYSTEM_VERSION="${SYSTEM_VERSION}" + COMPILER_INFO="${COMPILER_INFO}" + SUPPORT_A2=1 + CODE_OTP=${PICOTOOL_CODE_OTP} + ) +# for OTP info +target_include_directories(picotool PRIVATE ${CMAKE_CURRENT_BINARY_DIR}) +# todo, this is a bit of an abstraction failure; but don't want to rev the SDK just for this right now +target_include_directories(picotool PRIVATE ${PICO_SDK_PATH}/src/rp2_common/pico_stdio_usb/include) +target_link_libraries(picotool + pico_binary_info + boot_uf2_headers + boot_picoboot_headers + boot_picobin_headers + pico_bootrom_headers + pico_platform_headers + pico_usb_reset_interface_headers + regs_headers + bintool + elf2uf2 + errors + nlohmann_json + whereami) + +if (NOT TARGET mbedtls) + message("mbedtls not found - no signing/hashing support will be built") + target_compile_definitions(picotool PRIVATE HAS_MBEDTLS=0) +else() + target_compile_definitions(picotool PRIVATE HAS_MBEDTLS=1) +endif() + +if (NOT LIBUSB_FOUND) + message("libUSB is not found - no USB support will be built") + target_compile_definitions(picotool PRIVATE HAS_LIBUSB=0) + target_link_libraries(picotool + picoboot_connection_header) +else() + target_include_directories(picotool PRIVATE ${LIBUSB_INCLUDE_DIR}) + target_compile_definitions(picotool PRIVATE HAS_LIBUSB=1) + target_link_libraries(picotool + picoboot_connection_cxx + ${LIBUSB_LIBRARIES}) +endif() + +# allow `make install` +install(TARGETS picotool + EXPORT picotool-targets + RUNTIME DESTINATION ${INSTALL_BINDIR} +) + +#Export the targets to a script +install(EXPORT picotool-targets + FILE + picotoolTargets.cmake + DESTINATION + ${INSTALL_CONFIGDIR} +) + +#Create a ConfigVersion.cmake file +include(CMakePackageConfigHelpers) +write_basic_package_version_file( + ${CMAKE_CURRENT_BINARY_DIR}/picotoolConfigVersion.cmake + VERSION ${PROJECT_VERSION} + COMPATIBILITY SameMajorVersion + ARCH_INDEPENDENT +) + +configure_package_config_file(${CMAKE_CURRENT_LIST_DIR}/cmake/picotoolConfig.cmake + ${CMAKE_CURRENT_BINARY_DIR}/picotoolConfig.cmake + INSTALL_DESTINATION ${INSTALL_CONFIGDIR} +) + +#Install the config and configversion +install(FILES + ${CMAKE_CURRENT_BINARY_DIR}/picotoolConfig.cmake + ${CMAKE_CURRENT_BINARY_DIR}/picotoolConfigVersion.cmake + DESTINATION ${INSTALL_CONFIGDIR} +) + +if (NOT PICOTOOL_NO_LIBUSB) + if (NOT PICOTOOL_CODE_OTP) + #Install the otp json + install(FILES + ${GENERATED_JSON} + DESTINATION ${INSTALL_DATADIR} + ) + endif() + + #Install xip_ram_perms.elf + install(FILES + ${XIP_RAM_PERMS_ELF} + DESTINATION ${INSTALL_DATADIR} + ) endif() diff --git a/MODULE.bazel b/MODULE.bazel index 6adcec6..2c22158 100644 --- a/MODULE.bazel +++ b/MODULE.bazel @@ -1,9 +1,26 @@ -module(name = "picotool", version="1.1.3-rc1") +module( + name = "picotool", + version = "2.0.0", +) -bazel_dep(name = "rules_libusb", version="0.1.0-rc1") -bazel_dep(name = "pico-sdk", version="1.6.0-rc1") -bazel_dep(name = "platforms", version="0.0.7") +bazel_dep(name = "rules_libusb", version = "0.1.0-rc1") +bazel_dep(name = "pico-sdk", version = "2.0.0") +bazel_dep(name = "rules_cc", version = "0.0.9") +bazel_dep(name = "bazel_skylib", version = "1.6.1") +bazel_dep(name = "rules_python", version = "0.22.1") +bazel_dep(name = "platforms", version = "0.0.9") libusb = use_extension("@rules_libusb//:extensions.bzl", "libusb") libusb.source_release(min_version = "1.0.22") use_repo(libusb, "libusb") + +http_archive = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive") + +# TODO: Upstream a bazel build +http_archive( + name = "mbedtls", + build_file = "//bazel:mbedtls.BUILD", + sha256 = "241c68402cef653e586be3ce28d57da24598eb0df13fcdea9d99bfce58717132", + strip_prefix = "mbedtls-2.28.8", + url = "https://github.com/Mbed-TLS/mbedtls/releases/download/v2.28.8/mbedtls-2.28.8.tar.bz2", +) diff --git a/README.md b/README.md index e33e4ba..29231b9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ ## Building -You need to set PICO_SDK_PATH in the environment, or pass it to cmake. +You need to set PICO_SDK_PATH in the environment, or pass it to cmake with `-DPICO_SDK_PATH=/path/to/pico-sdk`. To use features such as signing or hashing, you will need to make sure the mbedtls submodule in the SDK is checked out - this can be done by running this from your SDK directory. + +```console +git submodule update --init lib/mbedtls +``` You also need to install `libusb-1.0`. @@ -12,6 +16,15 @@ Use your favorite package tool to install dependencies. For example, on Ubuntu: sudo apt install build-essential pkg-config libusb-1.0-0-dev cmake ``` +Then simply build like a normal CMake project: + +```console +mkdir build +cd build +cmake .. +make +``` + On Linux you can add udev rules in order to run picotool without sudo: ```console @@ -58,61 +71,100 @@ make make install DESTDIR=/ # optional ``` +## Usage by the Raspberry Pi Pico SDK + +The Raspberry Pi Pico SDK ([pico-sdk](https://github.com/raspberrypi/pico-sdk)) version 2.0.0 and above, uses `picotool` to do the ELF->UF2 conversion previously handled by the `elf2uf2` tool in the SDK. `picootol` is also used by the SDK for hashing and/or signing binaries. + +Whilst the SDK can download picotool on its own per project, if you have multiple projects or build configurations, it is preferable to install a single copy of `picotool` locally. + +This can be done most simply with `make install`; the SDK will use this installed version by default. + +Alternatively you can install in a custom path via: + +``` +cmake -DCMAKE_INSTALL_PREFIX=$MY_INSTALL_DIR -DPICOTOOL_FLAT_INSTALL=1 .. +``` + +In order for the SDK to find `picotool` in this custom path, you will need to set the `picotool_DIR` variable in your project, either by passing to `-Dpicotool_DIR=$MY_INSTALL_DIR/picotool` to your SDK `cmake` command, or by adding + +```CMake +set(picotool_DIR $MY_INSTALL_DIR/picotool) +``` + +to your CMakeLists.txt file. + ## Overview -`picotool` is a tool for inspecting RP2040 binaries, and interacting with RP2040 devices when they are in BOOTSEL mode. (As of version 1.1 of `picotool` it is also possible to interact with RP2040 devices that are not in BOOTSEL mode, but are using USB stdio support from the Raspberry Pi Pico SDK by using the `-f` argument of `picotool`). +`picotool` is a tool for working with RP2040/RP2350 binaries, and interacting with RP2040/RP2350 devices when they are in BOOTSEL mode. (As of version 1.1 of `picotool` it is also possible to interact with devices that are not in BOOTSEL mode, but are using USB stdio support from the Raspberry Pi Pico SDK by using the `-f` argument of `picotool`). Note for additional documentation see https://rptl.io/pico-get-started -```text +``` $ picotool help PICOTOOL: - Tool for interacting with a RP2040 device in BOOTSEL mode, or with a RP2040 binary +Tool for interacting with RP2040/RP2350 device(s) in BOOTSEL mode, or with an RP2040/RP2350 binary SYNOPSIS: - picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] - picotool info [-b] [-p] [-d] [-l] [-a] [-t ] - picotool load [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] - picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] - picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] - picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] - picotool verify [--bus ] [--address ] [-f] [-F] [-t ] [-r ] [-o ] - picotool reboot [-a] [-u] [--bus ] [--address ] [-f] [-F] - picotool version [-s] + picotool info [-b] [-p] [-d] [--debug] [-l] [-a] [device-selection] + picotool info [-b] [-p] [-d] [--debug] [-l] [-a] [-t ] + picotool config [-s ] [-g ] [device-selection] + picotool config [-s ] [-g ] [-t ] + picotool load [-p] [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [device-selection] + picotool encrypt [--quiet] [--verbose] [--hash] [--sign] [-t ] [-o ] [-t ] [-t ] [] [-t ] + picotool seal [--quiet] [--verbose] [--hash] [--sign] [--clear] [-t ] [-o ] [-t ] [] [-t ] [] [-t ] [--major ] [--minor ] [--rollback [..]] + picotool link [--quiet] [--verbose] [-t ] [-t ] [-t ] [] [-t ] [-p] + picotool save [-p] [device-selection] + picotool save -a [device-selection] + picotool save -r [device-selection] + picotool verify [device-selection] + picotool reboot [-a] [-u] [-g ] [-c ] [device-selection] + picotool otp list|get|set|load|dump|permissions|white-label + picotool partition info|create + picotool uf2 info|convert + picotool version [-s] [] + picotool coprodis [--quiet] [--verbose] [-t ] [-t ] picotool help [] COMMANDS: - info Display information from the target device(s) or file. - Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode - load Load the program / memory range stored in a file onto the device. - save Save the program / memory stored in flash on the device to a file. - verify Check that the device contents match those in the file. - reboot Reboot the device - version Display picotool version - help Show general help or help for a specific command + info Display information from the target device(s) or file. + Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode + config Display or change program configuration settings from the target device(s) or file. + load Load the program / memory range stored in a file onto the device. + encrypt Encrypt the program. + seal Add final metadata to a binary, optionally including a hash and/or signature. + link Link multiple binaries into one block loop. + save Save the program / memory stored in flash on the device to a file. + verify Check that the device contents match those in the file. + reboot Reboot the device + otp Commands related to the RP2350 OTP (One-Time-Programmable) Memory + partition Commands related to RP2350 Partition Tables + uf2 Commands related to UF2 creation and status + version Display picotool version + coprodis Post-process coprocessor instructions in dissassembly files. + help Show general help or help for a specific command Use "picotool help " for more info ``` -Note commands that aren't acting on files require an RP2040 device in BOOTSEL mode to be connected. +Note commands that aren't acting on files require a device in BOOTSEL mode to be connected. ## info -So there is now _Binary Information_ support in the SDK which allows for easily storing compact information that `picotool` +The is _Binary Information_ support in the SDK which allows for easily storing compact information that `picotool` can find (See Binary Info section below). The info command is for reading this information. -The information can be either read from one or more connected RP2040 devices in BOOTSEL mode, or from +The information can be either read from one or more connected devices in BOOTSEL mode, or from a file. This file can be an ELF, a UF2 or a BIN file. -```text +``` $ picotool help info INFO: Display information from the target device(s) or file. Without any arguments, this will display basic information for all connected RP2040 devices in BOOTSEL mode SYNOPSIS: - picotool info [-b] [-p] [-d] [-l] [-a] [--bus ] [--address ] [-f] [-F] - picotool info [-b] [-p] [-d] [-l] [-a] [-t ] + picotool info [-b] [-p] [-d] [--debug] [-l] [-a] [device-selection] + picotool info [-b] [-p] [-d] [--debug] [-l] [-a] [-t ] OPTIONS: Information to display @@ -122,6 +174,8 @@ OPTIONS: Include pin information -d, --device Include device information + --debug + Include device debug information -l, --build Include build attributes -a, --all @@ -133,13 +187,19 @@ TARGET SELECTION: Filter devices by USB bus number --address Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number -f, --force - Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing - the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode -F, --force-no-reboot - Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing - the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but - without the RPI-RP2 drive mounted + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted To target a file The file name @@ -151,14 +211,14 @@ Note the -f arguments vary slightly for Windows vs macOS / Unix platforms. e.g. -```text + $ picotool info Program Information name: hello_world features: stdout to UART ``` -```text + $ picotool info -a Program Information name: hello_world @@ -179,7 +239,7 @@ Device Information ROM version: 2 ``` -```text + $ picotool info -bp Program Information name: hello_world @@ -190,7 +250,7 @@ Fixed Pin Information 21: UART1 RX ``` -```text + $ picotool info -a lcd_1602_i2c.uf2 File lcd_1602_i2c.uf2: @@ -208,9 +268,85 @@ Build Information build date: Dec 31 2020 ``` +## config + +Config allows you to configure the binary info on a device, if it is configurable. Specifically, you can configure `bi_ptr_int32` and `bi_ptr_string`. + +```text +$ picotool help config +CONFIG: + Display or change program configuration settings from the target device(s) or file. + +SYNOPSIS: + picotool config [-s ] [-g ] [device-selection] + picotool config [-s ] [-g ] [-t ] + +OPTIONS: + + Variable name + + New value + -g + Filter by feature group + +TARGET SELECTION: + To target one or more connected RP2040 device(s) in BOOTSEL mode (the default) + --bus + Filter devices by USB bus number + --address + Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted + To target a file + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension +``` + +```text +$ picotool config +n = 5 +name = "Billy" +nonconst_pins: + default_pin = 3 + default_name = "My First Pin" +``` + +```text +$ picotool config -g nonconst_pins +nonconst_pins: + default_pin = 3 + default_name = "My First Pin" +``` + +```text +$ picotool config -s name Jane +name = "Billy" +setting name -> "Jane" + +$ picotool config +n = 5 +name = "Jane" +nonconst_pins: + default_pin = 3 + default_name = "My First Pin" +``` + ## load -Load allows you to write data from a file into flash +`load` allows you to write data from a file onto the device (either writing to flash, or to RAM) ```text $ picotool help load @@ -218,16 +354,27 @@ LOAD: Load the program / memory range stored in a file onto the device. SYNOPSIS: - picotool load [-n] [-N] [-u] [-v] [-x] [-t ] [-o ] [--bus ] [--address ] [-f] [-F] + picotool load [--ignore-partitions] [--family ] [-p ] [-n] [-N] [-u] [-v] [-x] [-t ] [-o + ] [device-selection] OPTIONS: Post load actions + --ignore-partitions + When writing flash data, ignore the partition table and write to absolute space + --family + Specify the family ID of the file to load + + family id to use for load + -p, --partition + Specify the partition to load into + + partition to load into -n, --no-overwrite - When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence - of the program in flash, the command fails + When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence of the + program in flash, the command fails -N, --no-overwrite-unsafe - When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence - of the program in flash, the load continues anyway + When writing flash data, do not overwrite an existing program in flash. If picotool cannot determine the size/presence of the + program in flash, the load continues anyway -u, --update Skip writing flash sectors that already contain identical data -v, --verify @@ -249,13 +396,19 @@ OPTIONS: Filter devices by USB bus number --address Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number -f, --force - Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing - the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode -F, --force-no-reboot - Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing - the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but - without the RPI-RP2 drive mounted + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted ``` e.g. @@ -267,7 +420,7 @@ Loading into Flash: [==============================] 100% ## save -Save allows you to save a range of memory or a program or the whole of flash from the device to a BIN file or a UF2 file +`save` allows you to save a range of RAM, the program in flash, or an explicit range of flash from the device to a BIN file or a UF2 file. ```text $ picotool help save @@ -275,9 +428,9 @@ SAVE: Save the program / memory stored in flash on the device to a file. SYNOPSIS: - picotool save [-p] [--bus ] [--address ] [-f] [-F] [-t ] - picotool save -a [--bus ] [--address ] [-f] [-F] [-t ] - picotool save -r [--bus ] [--address ] [-f] [-F] [-t ] + picotool save [-p] [device-selection] + picotool save -a [device-selection] + picotool save -r [device-selection] OPTIONS: Selection of data to save @@ -286,8 +439,8 @@ OPTIONS: -a, --all Save all of flash memory -r, --range - Save a range of memory. Note that UF2s always store complete 256 byte-aligned blocks of 256 bytes, and the range is - expanded accordingly + Save a range of memory. Note that UF2s always store complete 256 byte-aligned blocks of 256 bytes, and the range is expanded + accordingly The lower address bound in hex @@ -297,13 +450,19 @@ OPTIONS: Filter devices by USB bus number --address Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number -f, --force - Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing - the command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode -F, --force-no-reboot - Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing - the command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but - without the RPI-RP2 drive mounted + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted File to save to The file name @@ -311,7 +470,7 @@ OPTIONS: Specify file type (uf2 | elf | bin) explicitly, ignoring file extension ``` -e.g. +e.g. first looking at what is on the device... ```text $ picotool info @@ -319,11 +478,15 @@ Program Information name: lcd_1602_i2c web site: https://github.com/raspberrypi/pico-examples/tree/HEAD/i2c/lcd_1602_i2c ``` + +... saving it to a file ... ```text $ picotool save spoon.uf2 Saving file: [==============================] 100% Wrote 51200 bytes to spoon.uf2 ``` + +... and looking at the file: ```text $ picotool info spoon.uf2 File spoon.uf2: @@ -332,6 +495,508 @@ name: lcd_1602_i2c web site: https://github.com/raspberrypi/pico-examples/tree/HEAD/i2c/lcd_1602_i2c ``` +## seal + +`seal` allows you to sign and/or hash a binary to run on RP2350. + +By default, it will just sign the binary, but this can be configured with the `--hash` and `--no-sign` arguments. + +Your signing key must be for the _secp256k1_ curve, in PEM format. You can create a .PEM file with: + +```bash +openssl ecparam -name secp256k1 -genkey -out private.pem +``` + +```text +$ picotool help seal +SEAL: + Add final metadata to a binary, optionally including a hash and/or signature. + +SYNOPSIS: + picotool seal [--quiet] [--verbose] [--hash] [--sign] [--clear] [-t ] [-o ] [-t ] [] [-t + ] [] [-t ] [--major ] [--minor ] [--rollback [..]] + +OPTIONS: + --quiet + Don't print any output + --verbose + Print verbose output + --major + Add Major Version + --minor + Add Minor Version + --rollback [..] + Add Rollback Version + Configuration + --hash + Hash the file + --sign + Sign the file + --clear + Clear all of SRAM on load + File to load from + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + BIN file options + -o, --offset + Specify the load address for a BIN file + + Load offset (memory address; default 0x10000000) + File to save to + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + Key file + + The file name + -t + Specify file type (pem) explicitly, ignoring file extension + File to save OTP to (will edit existing file if it exists) + + The file name + -t + Specify file type (json) explicitly, ignoring file extension +``` + +## encrypt + +`encrypt` allows you to encrypt and sign a binary for use on the RP2350. By default, it will sign the encrypted binary, but that can be configured similarly to `picotool sign`. + +The encrypted binary will have the following structure: + +- First metadata block (5 words) +- IV (4 words) +- Encrypted Binary +- Padding to ensure the encrypted length is a multiple of 4 words +- Signature metadata block + +The AES key must be provided as a .bin file of the 256 bit AES key to be used for encryption. + +```text +$ picotool help encrypt +ENCRYPT: + Encrypt the program. + +SYNOPSIS: + picotool encrypt [--quiet] [--verbose] [--hash] [--sign] [-t ] [-o ] [-t ] [-t ] + [] [-t ] + +OPTIONS: + --quiet + Don't print any output + --verbose + Print verbose output + Signing Configuration + --hash + Hash the encrypted file + --sign + Sign the encrypted file + File to load from + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + BIN file options + -o, --offset + Specify the load address for a BIN file + + Load offset (memory address; default 0x10000000) + File to save to + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + AES Key + + The file name + -t + Specify file type (bin) explicitly, ignoring file extension + Signing Key file + + The file name + -t + Specify file type (pem) explicitly, ignoring file extension +``` + +## partition + +The `partition` commands allow you to interact with the partition tables on RP2350 devices, and also create them. + +### info + +```text +$ picotool help partition info +PARTITION INFO: + Print the device's partition table. + +SYNOPSIS: + picotool partition info -m [device-selection] + +OPTIONS: + -m [device-selection] +``` + +```text +$ picotool partition info +un-partitioned_space : S(rw) NSBOOT(rw) NS(rw), uf2 { absolute } +partitions: + 0(A) 00002000->00201000 S(rw) NSBOOT(rw) NS(rw), id=0000000000000000, "A", uf2 { rp2350-arm-s, rp2350-riscv }, arm_boot 1, riscv_boot 1 + 1(B w/ 0) 00201000->00400000 S(rw) NSBOOT(rw) NS(rw), id=0000000000000001, "B", uf2 { rp2350-arm-s, rp2350-riscv }, arm_boot 1, riscv_boot 1 +``` + +```text +$ picotool partition info -m rp2350-arm-s +un-partitioned_space : S(rw) NSBOOT(rw) NS(rw), uf2 { absolute } +partitions: + 0(A) 00002000->00201000 S(rw) NSBOOT(rw) NS(rw), id=0000000000000000, "A", uf2 { rp2350-arm-s, rp2350-riscv }, arm_boot 1, riscv_boot 1 + 1(B w/ 0) 00201000->00400000 S(rw) NSBOOT(rw) NS(rw), id=0000000000000001, "B", uf2 { rp2350-arm-s, rp2350-riscv }, arm_boot 1, riscv_boot 1 +Family id 'rp2350-arm-s' can be downloaded in partition 0: + 00002000->00201000 +``` + +### create + +This command allows you to create partition tables, and additionally embed them into the block loop if ELF files (for example, for bootloaders). +By default, all partition tables are hashed, and you can also sign them. + +```text +$ picotool help partition create +PARTITION CREATE: + Create a partition table from json + +SYNOPSIS: + picotool partition create [--quiet] [--verbose] [-t ] [-t ] [[-o ] [--family ]] + [] [-t ] [[--sign ] [-t ] [--no-hash] [--singleton]] [[--abs-block] []] + +OPTIONS: + --quiet + Don't print any output + --verbose + Print verbose output + partition table JSON + + The file name + -t + Specify file type (json) explicitly, ignoring file extension + output file + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + UF2 output options + -o, --offset + Specify the load address for UF2 file output + + Load offset (memory address; default 0x10000000) + --family + Specify the family if for UF2 file output + + family id for UF2 (default absolute) + embed partition table into bootloader ELF + + The file name + -t + Specify file type (elf) explicitly, ignoring file extension + Partition Table Options + --sign + The file name + -t + Specify file type (pem) explicitly, ignoring file extension + --no-hash + Don't hash the partition table + --singleton + Singleton partition table + Errata RP2350-E9 Fix + --abs-block + Enforce support for an absolute block + + absolute block location (default to 0x10ffff00) +``` + +## uf2 + +The `uf2` commands allow for creation of UF2s, and cam provide information when if a UF2 download has failed. + +### convert + +This command replaces the elf2uf2 functionality that was previously in the Raspberry Pi Pico SDK. It will attempt to auto-detect the family ID, but if this fails you can specify one manually with the `--family` argument. + +```text +picotool help uf2 convert +UF2 CONVERT: + Convert ELF/BIN to UF2. + +SYNOPSIS: + picotool uf2 convert [--quiet] [--verbose] [-t ] [-t ] [-o ] [--family ] + [[--abs-block] []] + +OPTIONS: + --quiet + Don't print any output + --verbose + Print verbose output + File to load from + + The file name + -t + Specify file type (uf2 | elf | bin) explicitly, ignoring file extension + File to save UF2 to + + The file name + -t + Specify file type (uf2) explicitly, ignoring file extension + Packaging Options + -o, --offset + Specify the load address + + Load offset (memory address; default 0x10000000 for BIN file) + UF2 Family options + + family id for UF2 + Errata RP2350-E9 Fix + --abs-block + Add an absolute block + + absolute block location (default to 0x10ffff00) +``` + +### info + +This command reads the information on a device about why a UF2 download has failed. It will only give information if the most recent download has failed. + +```text +$ picotool help uf2 info +UF2 INFO: + Print info about UF2 download. + +SYNOPSIS: + picotool uf2 info [device-selection] + +OPTIONS: + Target device selection + --bus + Filter devices by USB bus number + --address + Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted + +``` + +## otp + +The `otp` commands are for interacting with the RP2350 OTP Memory. They are not available on RP2040 devices, as RP2040 has no OTP. + +Note that the OTP Memory is One-Time-Programmable, which means that once a bit has been changed from 0 to 1, it cannot be changed back. +Therefore, caution should be used when using these commands, as they risk bricking your RP2350 device. For example, if you set SECURE_BOOT_ENABLE but don't set a boot key, and disable the PICOBOOT interface, then your device will be unusable. + +For the `list`, `set`, `get` and `load` commands, you can define your own OTP layout in a JSON file and pass that in with the `-i` argument. These rows will be added to the default rows when parsing. + +```text +$ picotool help otp +OTP: + Commands related to the RP2350 OTP (One-Time-Programmable) Memory + +SYNOPSIS: + picotool otp list [-p] [-n] [-i ] [..] + picotool otp get [-c ] [-r] [-e] [-n] [-i ] [device-selection] [-z] [..] + picotool otp set [-c ] [-r] [-e] [-i ] [-z] [device-selection] + picotool otp load [-r] [-e] [-s ] [-i ] [-t ] [device-selection] + picotool otp dump [-r] [-e] [device-selection] + picotool otp permissions [-t ] [--led ] [--hash] [--sign] [] [-t ] [device-selection] + picotool otp white-label -s [-t ] [device-selection] + +SUB COMMANDS: + list List matching known registers/fields + get Get the value of one or more OTP registers/fields (RP2350 only) + set Set the value of an OTP row/field (RP2350 only) + load Load the row range stored in a file into OTP and verify. Data is 2 bytes/row for ECC, 4 bytes/row for raw. (RP2350 only) + dump Dump entire OTP (RP2350 only) + permissions Set the OTP access permissions (RP2350 only) + white-label Set the white labelling values in OTP (RP2350 only) + +``` + +### set/get + +These commands will set/get specific rows of OTP. By default, they will write/read all redundant rows, but this can be overridden with the `-c` argument + +### load + +This command allows loading of a range of OTP rows onto the device. The source can be a binary file, or a JSON file such as the one output by `picotool sign`. +For example, if you wish to sign a binary and then test secure boot with it, you can run the following set of commands: +```text +$ picotool sign hello_world.elf hello_world.signed.elf private.pem otp.json +$ picotool load hello_world.signed.elf +$ picotool otp load otp.json +$ picotool reboot +``` + +### white-label + +This command allows for OTP white-labelling, which sets the USB configuration used by the device in BOOTSEL mode. +This can be configured from a JSON file, an example of which is in [sample-wl.json](sample-wl.json). + +```text +$ picotool help otp white-label +OTP WHITE-LABEL: + Set the white labelling values in OTP + +SYNOPSIS: + picotool otp white-label -s [-t ] [device-selection] + +OPTIONS: + File with white labelling values + + The file name + -t + Specify file type (json) explicitly, ignoring file extension + Target device selection + --bus + Filter devices by USB bus number + --address + Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted + +``` + +```text +$ picotool otp white-label -s 0x100 ../sample-wl.json +Setting attributes 20e0 +0x2e8b, 0x000e, 0x0215, 0x0c09, 0x1090, 0x200c, 0x2615, 0x20e0, 0x310b, 0x3706, 0x3a04, 0x3c04, 0x3e21, 0x4f15, 0x5a0a, 0x5f0a, 0x007a, 0x00df, 0x6c34, 0xd83c, 0xdf4c, 0x0020, 0x0054, 0x0065, 0x0073, 0x0074, 0x0027, 0x0073, +0x0020, 0x0050, 0x0069, 0x0073, 0x6554, 0x7473, 0x5220, 0x3250, 0x3533, 0x3f30, 0x6f6e, 0x6e74, 0x6365, 0x7365, 0x6173, 0x6972, 0x796c, 0x6e61, 0x6d75, 0x6562, 0x0072, 0x6554, 0x7473, 0x6950, 0x4220, 0x6f6f, 0x0074, 0x6554, +0x7473, 0x6950, 0x794d, 0x6950, 0x3876, 0x3739, 0x7468, 0x7074, 0x3a73, 0x2f2f, 0x7777, 0x2e77, 0x6172, 0x7073, 0x6562, 0x7272, 0x7079, 0x2e69, 0x6f63, 0x2f6d, 0x656e, 0x7377, 0x002f, 0x6f53, 0x656d, 0x4e20, 0x7765, 0x2073, +0x6241, 0x756f, 0x2074, 0x7453, 0x6675, 0x0066, 0x794d, 0x5420, 0x7365, 0x2074, 0x6950, 0x5054, 0x2d49, 0x5052, 0x3332, 0x3035, +$ picotool reboot -u +$ lsusb -v -s 1:102 +Bus 001 Device 102: ID 2e8b:000e zß水🍌 Test's Pis Test RP2350? +Device Descriptor: + bLength 18 + bDescriptorType 1 + bcdUSB 2.10 + bDeviceClass 0 + bDeviceSubClass 0 + bDeviceProtocol 0 + bMaxPacketSize0 64 + idVendor 0x2e8b + idProduct 0x000e + bcdDevice 2.15 + iManufacturer 1 zß水🍌 Test's Pis + iProduct 2 Test RP2350? + iSerial 3 notnecessarilyanumber + bNumConfigurations 1 + Configuration Descriptor: + bLength 9 + bDescriptorType 2 + wTotalLength 0x0037 + bNumInterfaces 2 + bConfigurationValue 1 + iConfiguration 0 + bmAttributes 0xc0 + Self Powered + MaxPower 64mA +... +``` + +### permissions + +This command will run a binary on your device in order to set the OTP permissions, as these are not directly accessible from `picotool` on due to the default permissions settings required to fix errata XXX on RP2350. +Because it runs a binary, the binary needs to be sign it if secure boot is enabled. The binary will print what it is doing over uart, which +can be configured using the UART Configuration arguments. You can define your OTP permissions in a json file, an example of which +is in [sample-permissions.json](sample-permissions.json). + +```text +$ picotool help otp permissions +OTP PERMISSIONS: + Set the OTP access permissions + +SYNOPSIS: + picotool otp permissions [-t ] [--led ] [--hash] [--sign] [] [-t ] [device-selection] + +OPTIONS: + File to load permissions from + + The file name + -t + Specify file type (json) explicitly, ignoring file extension + --led + LED Pin to flash; default 25 + Signing Configuration + --hash + Hash the executable + --sign + Sign the executable + Key file + + The file name + -t + Specify file type (pem) explicitly, ignoring file extension + Target device selection + --bus + Filter devices by USB bus number + --address + Filter devices by USB device address + --vid + Filter by vendor id + --pid + Filter by product id + --ser + Filter by serial number + -f, --force + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be rebooted back to application mode + -F, --force-no-reboot + Force a device not in BOOTSEL mode but running compatible code to reset so the command can be executed. After executing the + command (unless the command itself is a 'reboot') the device will be left connected and accessible to picotool, but without the + RPI-RP2 drive mounted +``` + +```text +$ picotool otp permissions --sign private.pem --tx 46 ../sample-permissions.json +Picking file ./xip_ram_perms.elf +page10 +page10 = 0 +setting page10 -> 4063233 +page11 +page11 = 0 +setting page11 -> 4128781 +page12 +page12 = 0 +setting page12 -> 4128781 +tx_pin = 0 +setting tx_pin -> 46 +Loading into XIP RAM: [==============================] 100% +>>> using flash update boot of 13ffc000 + +The device was rebooted to start the application. +``` + ## Binary Information Binary information is machine locatable and generally machine consumable. I say generally because anyone can @@ -379,9 +1044,19 @@ Fixed Pin Information 21: UART1 RX ``` +### Configuration + +This is very handy if you want to be able to modify parameters in a binary, without having to recompile it. + +```text +$ picotool config -s name Jane +name = "Billy" +setting name -> "Jane" +``` + ### Including Binary information -Binary information is declared in the program by macros (vile warped macros); for the previous example: +Binary information is declared in the program by macros (vile warped macros); for the pins example: ```text $ picotool info --pins sprite_demo.elf @@ -415,10 +1090,23 @@ Equally, the video code contains a few lines like this: bi_decl_if_func_used(bi_pin_mask_with_name(0x1f << (PICO_SCANVIDEO_COLOR_PIN_BASE + PICO_SCANVIDEO_DPI_PIXEL_RSHIFT), "Red 0-4")); ``` +For the configuration example, you put the line + +```c +bi_decl(bi_ptr_string(0x1111, 0x3333, name, "Billy", 128)); +``` + +into your code, which will then create the name variable for you to subsequently print. +The parameters are the tag, the ID, variable name, default value, and maximum string length. + +```c +printf("Name is %s\n", name); +``` + ### Details -Things are designed to waste as little space as possible, but you can turn everything off with preprocessor var `PICO_NO_BINARY_INFO=1`. Additionally -any SDK code that inserts binary info can be separately excluded by its own preprocesor var. +Things are designed to waste as little space as possible, but you can turn everything off with preprocessor variable `PICO_NO_BINARY_INFO=1`. Additionally, +any SDK code that inserts binary info can be separately excluded by its own preprocessor variable. You need ```c @@ -529,11 +1217,18 @@ enum { BINARY_INFO_BLOCK_DEV_FLAG_PT_NONE = 3 << 4, // no partition table }; ``` -### USB device descriptors -Seems like tagging these might be nice (we just need to store the pointer to it assuming - as is often the case - -the descriptor is just a linear chunk of memory) ... I assume there is a tool out there to prettify such a thing if picotool dumps the descriptor -in binary. +### Forced Reboots + +Running commands with `-f/F` requires compatible code to be running on the device. The definition of compatible code for the +purposes of binaries compiled using the [pico-sdk](https://github.com/raspberrypi/pico-sdk) is code that +- Is still running - +If your code has returned then rebooting with `-f/F` will not work - instead you can set the compile definition `PICO_ENTER_USB_BOOT_ON_EXIT` +to reboot and be accessible to picotool once your code has finished execution, for example with +`target_compile_definitions( PRIVATE PICO_ENTER_USB_BOOT_ON_EXIT=1)` +- Uses stdio_usb - +If your binary calls `stdio_init_all()` and you have `pico_enable_stdio_usb( 1)` in your CMakeLists.txt file then you meet +this requirement (see the [hello_usb](https://github.com/raspberrypi/pico-examples/tree/master/hello_world/usb) example) ### Issues diff --git a/WORKSPACE b/WORKSPACE new file mode 100644 index 0000000..e69de29 diff --git a/bazel/BUILD.bazel b/bazel/BUILD.bazel new file mode 100644 index 0000000..9504a73 --- /dev/null +++ b/bazel/BUILD.bazel @@ -0,0 +1,21 @@ +load("@rules_python//python:defs.bzl", "py_binary") + +package(default_visibility = ["//:__subpackages__"]) + +cc_library( + name = "data_locs", + srcs = ["data_locs.cpp"], + hdrs = ["//:data_locs_header"], + visibility = ["//:__subpackages__"], + deps = ["@rules_cc//cc/runfiles"], +) + +py_binary( + name = "binh", + srcs = ["binh.py"], +) + +py_binary( + name = "jsonh", + srcs = ["jsonh.py"], +) diff --git a/bazel/binh.py b/bazel/binh.py new file mode 100644 index 0000000..372e871 --- /dev/null +++ b/bazel/binh.py @@ -0,0 +1,71 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2024 Raspberry Pi (Trading) Ltd. +# +# SPDX-License-Identifier: BSD-3-Clause +"""Generate a header that provides a binary file as an array.""" + +import argparse +from pathlib import Path +import sys + + +_BYTES_PER_LINE = 32 + + +def _parse_args(): + parser = argparse.ArgumentParser( + description=__doc__, + ) + parser.add_argument( + "data", + type=argparse.FileType("rb"), + help="Path to data file to generate a header for", + ) + parser.add_argument( + "-o", + "--output", + type=argparse.FileType("wb"), + default=sys.stdout.buffer, + help="Output file path. Defaults to stdout.", + ) + return parser.parse_args() + + +def generate_header(data, output): + var_name = Path(output.name).stem.replace(".", "_") + include_guard = f"_{var_name.upper()}_H" + prefix_lines = ( + f"#ifndef {include_guard}", + f"#define {include_guard}", + "", + "#include ", + "", + f"const unsigned char {var_name}[] = {{", + ) + output.write("\n".join(prefix_lines).encode()) + + bytes_written = 0 + while True: + b = data.read(1) + if b == b"": + break + if bytes_written % _BYTES_PER_LINE == 0: + output.write("\n ".encode()) + output.write(f"0x{int.from_bytes(b, 'little'):02x}, ".encode()) + bytes_written += 1 + + suffix_lines = ( + "", + "};", + "", + f"const size_t {var_name}_SIZE = {bytes_written};", + "", + f"#endif // {include_guard}", + "", + ) + output.write("\n".join(suffix_lines).encode()) + + +if __name__ == "__main__": + sys.exit(generate_header(**vars(_parse_args()))) diff --git a/bazel/data_locs.cpp b/bazel/data_locs.cpp new file mode 100644 index 0000000..5b17733 --- /dev/null +++ b/bazel/data_locs.cpp @@ -0,0 +1,5 @@ +#include +#include + +// TODO: Finish this. +std::vector data_locs = {}; diff --git a/bazel/defs.bzl b/bazel/defs.bzl new file mode 100644 index 0000000..d4d10b6 --- /dev/null +++ b/bazel/defs.bzl @@ -0,0 +1,40 @@ +load("@bazel_skylib//rules:run_binary.bzl", "run_binary") + +def picotool_binary_data_header(name, src, out, **kwargs): + run_binary( + name = name, + srcs = [src], + outs = [out], + args = [ + "$(location {})".format(src), + "-o=$(location {})".format(out), + ], + tool = "@picotool//bazel:binh", + **kwargs + ) + +def otp_header_parse(name, src, out, **kwargs): + json_path = out + ".json" + run_binary( + name = name + "_json", + srcs = [src], + outs = [json_path], + args = [ + "$(location {})".format(src), + "$(location {})".format(json_path), + ], + tool = "@picotool//otp_header_parser:otp_header_parser", + **kwargs + ) + + run_binary( + name = name, + srcs = [json_path], + outs = [out], + args = [ + "$(location {})".format(json_path), + "-o=$(location {})".format(out), + ], + tool = "@picotool//bazel:jsonh", + **kwargs + ) diff --git a/bazel/jsonh.py b/bazel/jsonh.py new file mode 100644 index 0000000..08752ad --- /dev/null +++ b/bazel/jsonh.py @@ -0,0 +1,60 @@ +#!/usr/bin/env python3 +# +# Copyright (c) 2024 Raspberry Pi (Trading) Ltd. +# +# SPDX-License-Identifier: BSD-3-Clause +"""Generate a header that provides a JSON file as a string.""" + +import argparse +from pathlib import Path +import sys + + +_BYTES_PER_LINE = 32 + + +def _parse_args(): + parser = argparse.ArgumentParser( + description=__doc__, + ) + parser.add_argument( + "data", + type=argparse.FileType("rb"), + help="Path to data file to generate a header for", + ) + parser.add_argument( + "-o", + "--output", + type=argparse.FileType("wb"), + default=sys.stdout.buffer, + help="Output file path. Defaults to stdout.", + ) + return parser.parse_args() + + +def generate_header(data, output): + var_name = Path(output.name).stem.replace(".", "_") + include_guard = f"_{var_name.upper()}_H" + prefix_lines = ( + f"#ifndef {include_guard}", + f"#define {include_guard}", + "", + "#include ", + "", + f'const std::string {var_name} = R"""(', + ) + output.write("\n".join(prefix_lines).encode()) + + output.write(data.read()) + + suffix_lines = ( + ')""";', + "", + f"#endif // {include_guard}", + "", + ) + output.write("\n".join(suffix_lines).encode()) + + +if __name__ == "__main__": + sys.exit(generate_header(**vars(_parse_args()))) diff --git a/bazel/mbedtls.BUILD b/bazel/mbedtls.BUILD new file mode 100644 index 0000000..c3342b1 --- /dev/null +++ b/bazel/mbedtls.BUILD @@ -0,0 +1,18 @@ +package(default_visibility = ["//visibility:public"]) + +cc_library( + name = "mbedtls", + srcs = glob(["library/*.c"]), + hdrs = glob( + include = [ + "include/**/*.h", + "library/*.h", + ], + ), + linkopts = select({ + "@rules_cc//cc/compiler:msvc-cl": ["-DEFAULTLIB:AdvAPI32.Lib"], + "//conditions:default": [], + }), + includes = ["include"], + deps = ["@picotool//lib:mbedtls_config"], +) diff --git a/bintool/BUILD.bazel b/bintool/BUILD.bazel new file mode 100644 index 0000000..82ede3b --- /dev/null +++ b/bintool/BUILD.bazel @@ -0,0 +1,34 @@ +package(default_visibility = ["//visibility:public"]) + +cc_library( + name = "bintool", + srcs = [ + "bintool.cpp", + "mbedtls_wrapper.c", + ], + hdrs = [ + "bintool.h", + "mbedtls_wrapper.h", + "metadata.h", + ], + copts = select({ + "@platforms//os:windows": [], + "//conditions:default": [ + "-Wno-unused-variable", + ], + }), + defines = [ + "HAS_MBEDTLS=1", # Bazel build always has mbedtls. + ], + includes = ["."], + # In the CMake build, there's a workaround where this library is built with + # NO_PICO_PLATFORM, but that define shouldn't propagate to other + # dependencies. + local_defines = ["NO_PICO_PLATFORM=1"], + deps = [ + "//elf", + "//errors", + "@mbedtls", + "@pico-sdk//src/common/boot_picobin_headers", + ], +) diff --git a/bintool/CMakeLists.txt b/bintool/CMakeLists.txt new file mode 100644 index 0000000..4e3edb5 --- /dev/null +++ b/bintool/CMakeLists.txt @@ -0,0 +1,32 @@ +if (NOT TARGET mbedtls) + message("lib/mbedtls submodule needs to be initialized for bintool hashing/signing") + add_library(bintool STATIC + bintool.cpp) + target_compile_definitions(bintool PRIVATE + NO_PICO_PLATFORM=1 + HAS_MBEDTLS=0 + ) + + target_include_directories(bintool PUBLIC ${CMAKE_CURRENT_LIST_DIR}) + + target_link_libraries(bintool PUBLIC + elf + errors + boot_picobin_headers) +else() + add_library(bintool STATIC + bintool.cpp + mbedtls_wrapper.c) + target_compile_definitions(bintool PRIVATE + NO_PICO_PLATFORM=1 + HAS_MBEDTLS=1 + ) + + target_include_directories(bintool PUBLIC ${CMAKE_CURRENT_LIST_DIR}) + + target_link_libraries(bintool PUBLIC + mbedtls + elf + errors + boot_picobin_headers) +endif() diff --git a/bintool/bintool.cpp b/bintool/bintool.cpp new file mode 100644 index 0000000..c5462d2 --- /dev/null +++ b/bintool/bintool.cpp @@ -0,0 +1,906 @@ +#include +#include +#include +#include +#include +#include + +#include + +#include "boot/picobin.h" +#include + +#include "elf_file.h" + +#if HAS_MBEDTLS + #include "mbedtls_wrapper.h" + #include + #include + #include +#endif + +#include "bintool.h" +#include "metadata.h" +#include "errors.h" + +// todo test with a holey binary + +template void dumper(const char *msg, const T& foop) { + DEBUG_LOG("%s ", msg); + for(uint8_t i : foop.bytes) { + DEBUG_LOG("%02x", i); + } + DEBUG_LOG("\n"); +} + +std::vector sorted_segs(elf_file *elf) { + std::vector phys_sorted_segs; + std::transform(elf->segments().begin(), elf->segments().end(), std::back_inserter(phys_sorted_segs), [](const Segment &seg) { + return &seg; + }); + std::sort(phys_sorted_segs.begin(), phys_sorted_segs.end(), [](const Segment *first, const Segment *second) { + return first->physical_address() < second->physical_address(); + }); + return phys_sorted_segs; +} + +#if HAS_MBEDTLS +int read_keys(const std::string &filename, public_t *public_key, private_t *private_key) { + mbedtls_pk_context pk_ctx; + int rc; + + mbedtls_pk_init(&pk_ctx); + rc = mbedtls_pk_parse_keyfile(&pk_ctx, filename.c_str(), NULL); + if (rc != 0) { + char error_string[128]; + mbedtls_strerror(rc, error_string, sizeof(error_string)); + fail(ERROR_FORMAT, "Failed to read key file %s, error %s", filename.c_str(), error_string); + return -1; + } + + const mbedtls_ecp_keypair *keypair = mbedtls_pk_ec(pk_ctx); + if (!keypair) { + fail(ERROR_FORMAT, "Failed to parse key file %s", filename.c_str()); + } + mbedtls_mpi_write_binary(&keypair->d, reinterpret_cast(private_key), 32); + mbedtls_mpi_write_binary(&keypair->Q.X, reinterpret_cast(public_key), 32); + mbedtls_mpi_write_binary(&keypair->Q.Y, reinterpret_cast(public_key) + 32, 32); + return 0; +} +#endif + +#define OTP_KEY_YAML_HEADER \ +"include:\n" \ +" - otp/tc_images/base_chipinfo.yml\n" \ +"data:\n" \ +" - crit1_secure_boot_enable: [crit, 1]\n" \ +" - crit0_riscv_disable: [crit, 1]\n" \ +" - crit0_arm_disable: [crit, 0]\n" \ +" - BOOT_FLAGS0_SECURE_PARTITION_TABLE: [rbit3, 0]\n" \ +" - BOOT_FLAGS0_DISABLE_AUTO_SWITCH_ARCH: [rbit3, 1]\n" \ +" # - boot_temp_chicken_bit_opt_in_faster_sigcheck_rosc_div: [rbit3, 1]\n" \ +" - boot_flags1_key_valid: [rbit3, 0b0001]\n" \ + + +#if HAS_MBEDTLS +void write_otp_key_yaml(const std::string &filename, message_digest_t pub_sha256) { + std::ofstream out(filename, std::ios::out | std::ios::trunc); + out.exceptions(std::fstream::failbit | std::fstream::badbit); + out << std::string(OTP_KEY_YAML_HEADER); + + // Print public key hash again in the format it is expected to appear in OTP + for (int i = 0; i < 16; ++i) { + char row[128]; + snprintf(row, sizeof(row), " - bootkey0_%-2d: [ecc, 0x%02x%02x]\n", i, pub_sha256.bytes[2 * i + 1], pub_sha256.bytes[2 * i]); + out << std::string(row); + } +} +#endif + + +std::unique_ptr find_first_block(elf_file *elf) { + std::unique_ptr first_block; + for(auto x : sorted_segs(elf)) { + if (!x->is_load()) continue; + auto data = elf->content(*x); // x->content(*elf); + // todo handle alignment (not sure if necessary) + if ((x->physical_address() & 3) || (x->physical_size() & 3)) { + fail(ERROR_INCOMPATIBLE, "ELF segments must be word aligned"); + } + std::vector words = lsb_bytes_to_words(data.begin(), data.end()); + auto block_begin = std::find(words.begin(), words.end(), PICOBIN_BLOCK_MARKER_START); + while (block_begin != words.end() && !first_block) { + DEBUG_LOG("Found possible block at %08x + %08x...", (unsigned int)x->physical_address(), (int)(block_begin - words.begin())*4); + block_begin++; + for(auto next_item = block_begin; next_item < words.end(); ) { + unsigned int size = item::decode_size(*next_item); + if ((uint8_t)*next_item == PICOBIN_BLOCK_ITEM_2BS_LAST) { + if (size == next_item - block_begin) { + if (next_item < words.end() && next_item[2] == PICOBIN_BLOCK_MARKER_END) { + DEBUG_LOG(" verified block"); + first_block = block::parse(x->physical_address() + 4*(block_begin - words.begin() - 1), + next_item + 1, block_begin, block_begin + size); + break; + } + } + } else { + next_item += size; + } + } + DEBUG_LOG("\n"); + block_begin = std::find(block_begin, words.end(), PICOBIN_BLOCK_MARKER_START); + } + if (first_block) break; + } + if (!first_block) { + DEBUG_LOG("No block found\n"); + return NULL; + } + return first_block; +} + + +std::unique_ptr find_first_block(std::vector bin, uint32_t storage_addr) { + std::unique_ptr first_block; + + std::vector words = lsb_bytes_to_words(bin.begin(), bin.end()); + auto block_begin = std::find(words.begin(), words.end(), PICOBIN_BLOCK_MARKER_START); + + while (block_begin != words.end() && !first_block) { + DEBUG_LOG("Possible block at %08x + %08x\n", storage_addr, (int)(block_begin - words.begin())*4); + block_begin++; + for(auto next_item = block_begin; next_item < words.end(); ) { + unsigned int size = item::decode_size(*next_item); + if ((uint8_t)*next_item == PICOBIN_BLOCK_ITEM_2BS_LAST) { + if (size == next_item - block_begin) { + if (next_item < words.end() && next_item[2] == PICOBIN_BLOCK_MARKER_END) { + DEBUG_LOG("is a valid block\n"); + first_block = block::parse(storage_addr + 4*(block_begin - words.begin() - 1), + next_item + 1, block_begin, block_begin + size); + break; + } else { + printf("WARNING: Invalid block found at 0x%x - no block end marker\n", + (int)(block_begin - words.begin())*4 + ); + } + } else { + printf("WARNING: Invalid block found at 0x%x - incorrect last item size of %d, expected %d\n", + (int)(block_begin - words.begin())*4, size, (int)(next_item - block_begin) + ); + } + // Invalid block, so find the next one + next_item = words.end(); + } else { + next_item += size; + } + } + block_begin = std::find(block_begin, words.end(), PICOBIN_BLOCK_MARKER_START); + } + if (!first_block) { + DEBUG_LOG("NO BLOCK FOUND\n"); + return nullptr; + } + return first_block; +} + + +void set_next_block(elf_file *elf, std::unique_ptr &first_block, uint32_t highest_address) { + // todo this isn't right, but virtual should be physical for now + auto seg = elf->segment_from_physical_address(first_block->physical_addr); + if (seg == nullptr) { + fail(ERROR_NOT_POSSIBLE, "The ELF file does not contain the next block address %x", first_block->physical_addr); + } + std::vector content = elf->content(*seg); + uint32_t offset = first_block->physical_addr + first_block->next_block_rel_index * 4 - seg->physical_address(); + uint32_t delta = highest_address - first_block->physical_addr; + // todo this assumes a 2 word NEXT_BLOCK_ADDR type for now + content[offset] = delta & 0xff; + content[offset+1] = (delta >> 8) & 0xff; + content[offset+2] = (delta >> 16) & 0xff; + content[offset+3] = (delta >> 24) & 0xff; + DEBUG_LOG("defaulting next_block_addr at %08x to %08x\n", + (int)first_block->physical_addr + first_block->next_block_rel_index * 4, + (int)(highest_address)); + first_block->next_block_rel = delta; + elf->content(*seg, content); +} + + +void set_next_block(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block, uint32_t highest_address) { + // todo this isn't right, but virtual should be physical for now + uint32_t offset = first_block->physical_addr + first_block->next_block_rel_index * 4 - storage_addr; + uint32_t delta = highest_address - first_block->physical_addr; + // todo this assumes a 2 word NEXT_BLOCK_ADDR type for now + bin[offset] = delta & 0xff; + bin[offset+1] = (delta >> 8) & 0xff; + bin[offset+2] = (delta >> 16) & 0xff; + bin[offset+3] = (delta >> 24) & 0xff; + DEBUG_LOG("defaulting next_block_addr at %08x to %08x\n", + (int)first_block->physical_addr + first_block->next_block_rel_index * 4, + (int)(highest_address)); + first_block->next_block_rel = delta; +} + + +block place_new_block(elf_file *elf, std::unique_ptr &first_block) { + uint32_t highest_ram_address = 0; + uint32_t highest_flash_address = 0; + bool no_flash = false; + + for(const auto &seg : elf->segments()) { + // std::cout << &seg << " " << to_string(seg) << std::endl; + const uint32_t paddr = seg.physical_address(); + const uint32_t psize = seg.physical_size(); + if (paddr >= 0x20000000 && paddr < 0x20080000) { + highest_ram_address = std::max(paddr + psize, highest_ram_address); + } else if (paddr >= 0x10000000 && paddr < 0x20000000) { + highest_flash_address = std::max(paddr + psize, highest_flash_address); + } + } + + if (highest_flash_address == 0) { + no_flash = true; + } + uint32_t highest_address = no_flash ? highest_ram_address : highest_flash_address; + + DEBUG_LOG("RAM %08x ", highest_ram_address); + if (no_flash) { + DEBUG_LOG("NO FLASH\n"); + } else { + DEBUG_LOG("FLASH %08x\n", highest_flash_address); + } + + int32_t loop_start_rel = 0; + uint32_t new_block_addr = 0; + if (!first_block->next_block_rel) { + set_next_block(elf, first_block, highest_address); + loop_start_rel = -first_block->next_block_rel; + new_block_addr = first_block->physical_addr + first_block->next_block_rel; + } else { + DEBUG_LOG("There is already a block loop\n"); + uint32_t next_block_addr = first_block->physical_addr + first_block->next_block_rel; + std::unique_ptr new_first_block; + while (true) { + auto segment = elf->segment_from_physical_address(next_block_addr); + if (segment == nullptr) { + fail(ERROR_NOT_POSSIBLE, "The ELF file does not contain the next block address %x", next_block_addr); + } + auto data = elf->content(*segment); + auto offset = next_block_addr - segment->physical_address(); + std::vector words = lsb_bytes_to_words(data.begin() + offset, data.end()); + if (words.front() != PICOBIN_BLOCK_MARKER_START) { + fail(ERROR_UNKNOWN, "Block loop is not valid - no block found at %08x\n", (int)(next_block_addr)); + } + words.erase(words.begin()); + DEBUG_LOG("Checking block at %x\n", next_block_addr); + for(auto next_item = words.begin(); next_item < words.end(); ) { + unsigned int size = item::decode_size(*next_item); + if ((uint8_t)*next_item == PICOBIN_BLOCK_ITEM_2BS_LAST) { + if (size == next_item - words.begin()) { + if (next_item < words.end() && next_item[2] == PICOBIN_BLOCK_MARKER_END) { + DEBUG_LOG("is a valid block\n"); + new_first_block = block::parse(next_block_addr, next_item + 1, words.begin(), words.begin() + size); + break; + } + } + } else { + next_item += size; + } + } + if (new_first_block->physical_addr + new_first_block->next_block_rel == first_block->physical_addr) { + DEBUG_LOG("Found last block in block loop\n"); + break; + } else { + DEBUG_LOG("Continue looping\n"); + next_block_addr = new_first_block->physical_addr + new_first_block->next_block_rel; + new_first_block.reset(); + } + } + set_next_block(elf, new_first_block, highest_address); + new_block_addr = new_first_block->physical_addr + new_first_block->next_block_rel; + loop_start_rel = first_block->physical_addr - new_block_addr; + } + if (highest_address != new_block_addr) { + fail(ERROR_UNKNOWN, "Next block not at highest address %08x %08x\n", (int)highest_address, (int)(new_block_addr)); + } + + // loop back to first block + block new_block(new_block_addr, loop_start_rel); + // copt the existing block + std::copy(first_block->items.begin(), + first_block->items.end(), + std::back_inserter(new_block.items)); + + return new_block; +} + + +std::unique_ptr get_last_block(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block, get_more_bin_cb more_cb) { + uint32_t next_block_addr = first_block->physical_addr + first_block->next_block_rel; + std::unique_ptr new_first_block; + uint32_t read_size = PICOBIN_MAX_BLOCK_SIZE; + while (true) { + auto offset = next_block_addr - storage_addr; + if (offset + read_size > bin.size() && more_cb != nullptr) { + more_cb(bin, offset + read_size); + } + std::vector words = lsb_bytes_to_words(bin.begin() + offset, bin.end()); + if (words.front() != PICOBIN_BLOCK_MARKER_START) { + fail(ERROR_UNKNOWN, "Block loop is not valid - no block found at %08x\n", (int)(next_block_addr)); + } + words.erase(words.begin()); + DEBUG_LOG("Checking block at %x\n", next_block_addr); + DEBUG_LOG("Starts with %x %x %x %x\n", words[0], words[1], words[2], words[3]); + for(auto next_item = words.begin(); next_item < words.end(); ) { + unsigned int size = item::decode_size(*next_item); + if ((uint8_t)*next_item == PICOBIN_BLOCK_ITEM_2BS_LAST) { + if (size == next_item - words.begin()) { + if (next_item < words.end() && next_item[2] == PICOBIN_BLOCK_MARKER_END) { + DEBUG_LOG("is a valid block\n"); + new_first_block = block::parse(next_block_addr, next_item + 1, words.begin(), words.begin() + size); + break; + } + } + } else { + next_item += size; + } + } + if (new_first_block->physical_addr + new_first_block->next_block_rel == first_block->physical_addr) { + DEBUG_LOG("Found last block in block loop\n"); + break; + } else { + DEBUG_LOG("Continue looping\n"); + next_block_addr = new_first_block->physical_addr + new_first_block->next_block_rel; + new_first_block.reset(); + } + } + return new_first_block; +} + + +std::vector> get_all_blocks(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block, get_more_bin_cb more_cb) { + uint32_t next_block_addr = first_block->physical_addr + first_block->next_block_rel; + std::vector> all_blocks; + uint32_t read_size = PICOBIN_MAX_BLOCK_SIZE; + while (true) { + std::unique_ptr new_first_block; + auto offset = next_block_addr - storage_addr; + if (offset + read_size > bin.size() && more_cb != nullptr) { + more_cb(bin, offset + read_size); + } + std::vector words = lsb_bytes_to_words(bin.begin() + offset, bin.end()); + words.erase(words.begin()); + DEBUG_LOG("Checking block at %x\n", next_block_addr); + DEBUG_LOG("Starts with %x %x %x %x\n", words[0], words[1], words[2], words[3]); + for(auto next_item = words.begin(); next_item < words.end(); ) { + unsigned int size = item::decode_size(*next_item); + if ((uint8_t)*next_item == PICOBIN_BLOCK_ITEM_2BS_LAST) { + if (size == next_item - words.begin()) { + if (next_item < words.end() && next_item[2] == PICOBIN_BLOCK_MARKER_END) { + DEBUG_LOG("is a valid block\n"); + new_first_block = block::parse(next_block_addr, next_item + 1, words.begin(), words.begin() + size); + break; + } + } + } else { + next_item += size; + } + } + if (new_first_block->physical_addr + new_first_block->next_block_rel == first_block->physical_addr) { + DEBUG_LOG("Found last block in block loop\n"); + all_blocks.push_back(std::move(new_first_block)); + break; + } else { + DEBUG_LOG("Continue looping\n"); + next_block_addr = new_first_block->physical_addr + new_first_block->next_block_rel; + all_blocks.push_back(std::move(new_first_block)); + } + } + return all_blocks; +} + + +block place_new_block(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block) { + uint32_t highest_ram_address = 0; + uint32_t highest_flash_address = 0; + bool no_flash = false; + + const uint32_t paddr = storage_addr; + const uint32_t psize = bin.size(); + if (paddr >= 0x20000000 && paddr < 0x20080000) { + highest_ram_address = std::max(paddr + psize, highest_ram_address); + } else if (paddr >= 0x10000000 && paddr < 0x20000000) { + highest_flash_address = std::max(paddr + psize, highest_flash_address); + } + + if (highest_flash_address == 0) { + no_flash = true; + } + uint32_t highest_address = no_flash ? highest_ram_address : highest_flash_address; + + if (no_flash) { + DEBUG_LOG("RAM %08x ", highest_ram_address); + DEBUG_LOG("NO FLASH\n"); + } else { + DEBUG_LOG("FLASH %08x\n", highest_flash_address); + } + + int32_t loop_start_rel = 0; + uint32_t new_block_addr = 0; + if (!first_block->next_block_rel) { + set_next_block(bin, storage_addr, first_block, highest_address); + loop_start_rel = -first_block->next_block_rel; + new_block_addr = first_block->physical_addr + first_block->next_block_rel; + } else { + DEBUG_LOG("Ooh, there is already a block loop - lets find it's end\n"); + auto new_first_block = get_last_block(bin, storage_addr, first_block); + set_next_block(bin, storage_addr, new_first_block, highest_address); + new_block_addr = new_first_block->physical_addr + new_first_block->next_block_rel; + loop_start_rel = first_block->physical_addr - new_block_addr; + } + if (highest_address != new_block_addr) { + fail(ERROR_UNKNOWN, "Next block not at highest address %08x %08x\n", (int)highest_address, (int)(new_block_addr)); + } + + // loop back to first block + block new_block(new_block_addr, loop_start_rel); + // copt the existing block + std::copy(first_block->items.begin(), + first_block->items.end(), + std::back_inserter(new_block.items)); + + return new_block; +} + + +#if HAS_MBEDTLS +void hash_andor_sign_block(block *new_block, const public_t public_key, const private_t private_key, bool hash_value, bool sign, std::vector to_hash) { + std::shared_ptr hash_def = std::make_shared(PICOBIN_HASH_SHA256); + new_block->items.push_back(hash_def); + + // hash everything up to an including the hash def (todo really we shuold use the value from the hashdef when + // we're all done) + auto tmp_words = new_block->to_words(); + DEBUG_LOG("hash 0 + %08x\n", (int)(tmp_words.size()-3)*4); + if (new_block->items[0]->type() == PICOBIN_BLOCK_ITEM_1BS_IMAGE_TYPE) { + if (((image_type_item *)new_block->items[0].get())->flags & 0x8000) { + DEBUG_LOG("CLEARING TBYB FLAG\n"); + assert(tmp_words[1] & 0x80000000); + tmp_words[1] &= ~0x80000000; + } + } + auto block_hashed_contents = words_to_lsb_bytes(tmp_words.begin(), tmp_words.end() - 3); // remove stuff at end + std::copy(block_hashed_contents.begin(), block_hashed_contents.end(), std::back_inserter(to_hash)); + + message_digest_t sha256; + sha256_buffer(to_hash.data(), to_hash.size(), &sha256); + dumper("SHA256", sha256); + + if (sign) { + // dumper("PRIVATE KEY", private_key); + dumper("PUBLIC KEY", public_key); + + uint8_t entropy[32]; + std::random_device rand{}; + assert(rand.max() - rand.min() >= 256); + for(auto &e : entropy) { + e = rand(); + } + + signature_t sig; + sign_sha256(entropy, sizeof(entropy), &sha256, &public_key, &private_key, &sig); + dumper("SIG", sig); + + uint32_t err = verify_signature_secp256k1(&sig, &public_key, &sha256); + if (err) { + fail(ERROR_VERIFICATION_FAILED, "Signature verification failed"); + } + + std::shared_ptr signature = std::make_shared(PICOBIN_SIGNATURE_SECP256K1); + signature->public_key_bytes = std::vector(public_key.bytes, public_key.bytes + sizeof(public_key.bytes)); + signature->signature_bytes = std::vector(sig.bytes, sig.bytes + sizeof(sig.bytes)); + new_block->items.push_back(signature); + } + + if (hash_value) { + std::shared_ptr hash = std::make_shared(); + hash->hash_bytes = std::vector(sha256.bytes, sha256.bytes + sizeof(sha256.bytes)); + new_block->items.push_back(hash); + } +} + + +std::vector get_lm_hash_data(elf_file *elf, block *new_block, bool clear_sram = false) { + std::vector to_hash; + std::shared_ptr load_map = new_block->get_item(); + if (load_map == nullptr) { + std::vector entries; + if (clear_sram) { + // todo tidy up this way of hashing the uint32_t + std::vector sram_size_vec = {SRAM_END_RP2350 - SRAM_START}; + entries.push_back({ + 0x0, + SRAM_START, + sram_size_vec[0] + }); + auto sram_size_data = words_to_lsb_bytes(sram_size_vec.begin(), sram_size_vec.end()); + std::copy(sram_size_data.begin(), sram_size_data.end(), std::back_inserter(to_hash)); + DEBUG_LOG("CLEAR %08x + %08x\n", (int)SRAM_START, (int)sram_size_vec[0]); + } + for(const auto &seg : sorted_segs(elf)) { + if (!seg->is_load()) continue; + const auto data = elf->content(*seg); + // std::cout << "virt = " << std::hex << seg->virtual_address() << " + " << std::hex << seg->virtual_size() << ", phys = " << std::hex << seg->physical_address() << " + " << std::hex << seg->physical_size() << std::endl; + if (data.size() != seg->physical_size()) { + fail(ERROR_INCOMPATIBLE, "Elf segment physical size (%x) does not match data size in file (%x)", seg->physical_size(), data.size()); + } + if (seg->physical_size() && seg->physical_address() < new_block->physical_addr) { + std::copy(data.begin(), data.end(), std::back_inserter(to_hash)); + DEBUG_LOG("HASH %08x + %08x\n", (int)seg->physical_address(), (int)seg->physical_size()); + entries.push_back( + { + (uint32_t)seg->physical_address(), + (uint32_t)seg->virtual_address(), + (uint32_t)seg->physical_size() + }); + } + } + + load_map = std::make_shared(false, entries); + new_block->items.push_back(load_map); + } else { + DEBUG_LOG("Already has load map, so hashing that\n"); + // todo hash existing load map + for(const auto &entry : load_map->entries) { + std::vector data; + uint32_t current_storage_address = entry.storage_address; + while (data.size() < entry.size) { + auto seg = elf->segment_from_physical_address(current_storage_address); + if (seg == nullptr) { + fail(ERROR_NOT_POSSIBLE, "The ELF file does not contain the storage address %x", current_storage_address); + } + const auto new_data = elf->content(*seg); + + uint32_t offset = current_storage_address - seg->physical_address(); + + std::copy(new_data.begin()+offset, new_data.end(), std::back_inserter(data)); + current_storage_address += new_data.size(); + } + data.resize(entry.size); + std::copy(data.begin(), data.end(), std::back_inserter(to_hash)); + DEBUG_LOG("HASH %08x + %08x\n", (int)entry.storage_address, (int)data.size()); + } + } + + return to_hash; +} + + +std::vector get_lm_hash_data(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *new_block, bool clear_sram = false) { + std::vector to_hash; + std::shared_ptr load_map = new_block->get_item(); + if (load_map == nullptr) { + to_hash.insert(to_hash.begin(), bin.begin(), bin.end()); + std::vector entries; + if (clear_sram) { + // todo gate this clearing of SRAM + std::vector sram_size_vec = {0x00082000}; + assert(sram_size_vec[0] % 4 == 0); + entries.push_back({ + 0x0, + 0x20000000, + sram_size_vec[0] + }); + auto sram_size_data = words_to_lsb_bytes(sram_size_vec.begin(), sram_size_vec.end()); + to_hash.insert(to_hash.begin(), sram_size_data.begin(), sram_size_data.end()); + } + DEBUG_LOG("HASH %08x + %08x\n", (int)storage_addr, (int)bin.size()); + entries.push_back( + { + (uint32_t)storage_addr, + (uint32_t)runtime_addr, + (uint32_t)bin.size() + }); + + load_map = std::make_shared(false, entries); + new_block->items.push_back(load_map); + } else { + DEBUG_LOG("Already has load map, so hashing that\n"); + // todo hash existing load map + for(const auto &entry : load_map->entries) { + if (entry.storage_address == 0) { + std::copy( + (uint8_t*)&entry.size, + (uint8_t*)&entry.size + sizeof(entry.size), + std::back_inserter(to_hash)); + DEBUG_LOG("HASH CLEAR %08x + %08x\n", (int)entry.storage_address, (int)entry.size); + } else { + uint32_t rel_addr = entry.storage_address - storage_addr; + std::copy( + bin.begin() + rel_addr, + bin.begin() + rel_addr + entry.size, + std::back_inserter(to_hash)); + DEBUG_LOG("HASH %08x + %08x\n", (int)entry.storage_address, (int)entry.size); + } + } + } + + return to_hash; +} + + +int hash_andor_sign(elf_file *elf, block *new_block, const public_t public_key, const private_t private_key, bool hash_value, bool sign, bool clear_sram) { + std::vector to_hash = get_lm_hash_data(elf, new_block, clear_sram); + + hash_andor_sign_block(new_block, public_key, private_key, hash_value, sign, to_hash); + + auto tmp = new_block->to_words(); + std::vector data = words_to_lsb_bytes(tmp.begin(), tmp.end()); + + // If multiple signature segments, need different names + std::string sigx = ".sigx"; + if (elf->get_section(sigx) != NULL) { + sigx += '0'; + } + while (elf->get_section(sigx) != NULL) { + sigx[5] += 1; + if (sigx[5] > '9') fail(ERROR_INCOMPATIBLE, "Only compatible with up to 10 sigx blocks"); // very unlikely anyone has more than 10 sigx blocks - that would be silly + } + elf->append_segment(new_block->physical_addr, new_block->physical_addr, data.size(), sigx); + auto sig_section = elf->get_section(sigx); + assert(sig_section); + assert(sig_section->virtual_address() == new_block->physical_addr); + + if (sig_section->size < data.size()) { + fail(ERROR_UNKNOWN, "Block is too big for elf section\n"); + } + while (data.size() < sig_section->size) { + data.push_back(0); + } + + elf->content(*sig_section, data); + + return 0; +} + + +std::vector hash_andor_sign(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *new_block, const public_t public_key, const private_t private_key, bool hash_value, bool sign, bool clear_sram) { + std::vector to_hash = get_lm_hash_data(bin, storage_addr, runtime_addr, new_block, clear_sram); + + hash_andor_sign_block(new_block, public_key, private_key, hash_value, sign, bin); + + auto tmp = new_block->to_words(); + std::vector data = words_to_lsb_bytes(tmp.begin(), tmp.end()); + + bin.insert(bin.end(), data.begin(), data.end()); + + return bin; +} + + +void verify_block(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *block, verified_t &hash_verified, verified_t &sig_verified) { + std::shared_ptr load_map = block->get_item(); + std::shared_ptr hash_def = block->get_item(); + hash_verified = none; + sig_verified = none; + if (load_map == nullptr || hash_def == nullptr) { + return; + } + std::vector to_hash = get_lm_hash_data(bin, storage_addr, runtime_addr, block, false); + + // auto it = std::find(block->items.begin(), block->items.end(), hash_def); + // assert (it != block->items.end()); + // int index = it - block->items.begin(); + + // hash everything specified in the hash def + auto tmp_words = block->to_words(); + tmp_words.resize(hash_def->block_words_to_hash); + DEBUG_LOG("hash 0 + %08x\n", (int)(tmp_words.size())*4); + if (block->items[0]->type() == PICOBIN_BLOCK_ITEM_1BS_IMAGE_TYPE) { + if (((image_type_item *)block->items[0].get())->flags & 0x8000) { + DEBUG_LOG("CLEARING TBYB FLAG\n"); + assert(tmp_words[1] & 0x80000000); + tmp_words[1] &= ~0x80000000; + } + } + auto block_hashed_contents = words_to_lsb_bytes(tmp_words.begin(), tmp_words.end()); + std::copy(block_hashed_contents.begin(), block_hashed_contents.end(), std::back_inserter(to_hash)); + + message_digest_t sha256; + message_digest_t block_sha256; + sha256_buffer(to_hash.data(), to_hash.size(), &sha256); + dumper("SHA256", sha256); + + std::shared_ptr hash_value = block->get_item(); + if (hash_value != nullptr) { + memcpy(block_sha256.bytes, hash_value->hash_bytes.data(), hash_value->hash_bytes.size()); + if (std::equal(hash_value->hash_bytes.begin(), hash_value->hash_bytes.end(), sha256.bytes)) { + DEBUG_LOG("It's a match!\n"); + hash_verified = passed; + } else { + hash_verified = failed; + } + } + + std::shared_ptr signature = block->get_item(); + if (signature != nullptr) { + public_t public_key = {}; + memcpy(public_key.bytes, signature->public_key_bytes.data(), signature->public_key_bytes.size()); + dumper("PUBLIC KEY", public_key); + + signature_t sig { + .bytes = {}, + .der = {}, + .der_len = 0, + }; + memcpy(sig.bytes, signature->signature_bytes.data(), signature->signature_bytes.size()); + dumper("SIG", sig); + + uint32_t err = verify_signature_secp256k1(&sig, &public_key, &sha256); + if (err) { + sig_verified = failed; + } else { + DEBUG_LOG("It's a match!\n"); + sig_verified = passed; + } + } +} + + +int encrypt(elf_file *elf, block *new_block, const private_t aes_key, const public_t public_key, const private_t private_key, bool hash_value, bool sign) { + + std::vector to_enc = get_lm_hash_data(elf, new_block); + + std::random_device rand{}; + assert(rand.max() - rand.min() >= 256); + + while (to_enc.size() % 16 != 0){ + to_enc.push_back(rand()); // todo maybe better padding? random should be fine though + } + DEBUG_LOG("size %08x\n", (int)to_enc.size()); + + iv_t iv; + for(auto &e : iv.bytes) { + e = rand(); + } + + std::vector iv_data(iv.bytes, iv.bytes + sizeof(iv.bytes)); + + std::vector enc_data; + enc_data.resize(to_enc.size()); + + aes256_buffer(to_enc.data(), to_enc.size(), enc_data.data(), &aes_key, &iv); + + unsigned int i=0; + for(const auto &seg : sorted_segs(elf)) { + if (!seg->is_load()) continue; + std::vector data(enc_data.begin() + i, enc_data.begin() + i + seg->physical_size()); + // std::cout << "virt = " << std::hex << seg->virtual_address() << " + " << std::hex << seg->virtual_size() << ", phys = " << std::hex << seg->physical_address() << " + " << std::hex << seg->physical_size() << std::endl; + if (data.size() != seg->physical_size()) { + fail(ERROR_INCOMPATIBLE, "Elf segment physical size (%x) does not match data size in file (%x)", seg->physical_size(), data.size()); + } + if (seg->physical_size() && seg->physical_address() < new_block->physical_addr) { + DEBUG_LOG("ENCRYPTED %08x + %08x\n", (int)seg->physical_address(), (int)seg->physical_size()); + elf->content(*seg, data); + i += data.size(); + assert(i <= enc_data.size()); + } + } + assert(i <= enc_data.size()); + if (i < enc_data.size()) { + elf->append_segment(new_block->physical_addr, new_block->physical_addr, enc_data.size() - i, ".enc_pad"); + auto pad_section = elf->get_section(".enc_pad"); + assert(pad_section); + assert(pad_section->virtual_address() == new_block->physical_addr); + + if (pad_section->size < enc_data.size() - i) { + fail(ERROR_UNKNOWN, "Block is too big for elf section\n"); + } + + std::vector pad_data(enc_data.begin() + i, enc_data.end()); + + DEBUG_LOG("Adding padding len %d\n", (int)pad_data.size()); + for (auto x : pad_data) DEBUG_LOG("%02x", x); + DEBUG_LOG("\n"); + + elf->content(*pad_section, pad_data); + } + + block link_block(0x20000000, enc_data.size()); + // ignored_item ign(1, {0}); + std::shared_ptr image_def = new_block->get_item(); + link_block.items.push_back(image_def); + + link_block.next_block_rel += (link_block.to_words().size())*4 + iv_data.size(); + + auto tmp = link_block.to_words(); + DEBUG_LOG("Link block\n"); + for (auto x : tmp) DEBUG_LOG("%08x", x); + DEBUG_LOG("\n"); + + std::vector link_data = words_to_lsb_bytes(tmp.begin(), tmp.end()); + + elf->move_all(link_data.size() + iv_data.size()); + + elf->append_segment(link_block.physical_addr, link_block.physical_addr, link_data.size(), ".enc_link"); + auto link_section = elf->get_section(".enc_link"); + assert(link_section); + assert(link_section->virtual_address() == link_block.physical_addr); + if (link_section->size < link_data.size()) { + fail(ERROR_UNKNOWN, "Block is too big for elf section\n"); + } + elf->content(*link_section, link_data); + + elf->append_segment(link_block.physical_addr + link_data.size(), link_block.physical_addr + link_data.size(), iv_data.size(), ".enc_iv"); + auto iv_section = elf->get_section(".enc_iv"); + assert(iv_section); + if (iv_section->size < iv_data.size()) { + fail(ERROR_UNKNOWN, "Block is too big for elf section\n"); + } + elf->content(*iv_section, iv_data); + + new_block->physical_addr = link_block.physical_addr + link_block.next_block_rel; + new_block->next_block_rel = -link_block.next_block_rel; + + std::shared_ptr load_map = new_block->get_item(); + if (load_map != nullptr) { + new_block->items.erase(std::remove(new_block->items.begin(), new_block->items.end(), load_map), new_block->items.end()); + } + + hash_andor_sign(elf, new_block, public_key, private_key, hash_value, sign); + + return 0; +} + + +std::vector encrypt(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *new_block, const private_t aes_key, const public_t public_key, const private_t private_key, bool hash_value, bool sign) { + std::random_device rand{}; + assert(rand.max() - rand.min() >= 256); + + while (bin.size() % 16 != 0){ + bin.push_back(rand()); // todo maybe better padding? random should be fine though + } + DEBUG_LOG("size %08x\n", (int)bin.size()); + + iv_t iv; + for(auto &e : iv.bytes) { + e = rand(); + } + + std::vector iv_data(iv.bytes, iv.bytes + sizeof(iv.bytes)); + + std::vector enc_data; + enc_data.resize(bin.size()); + + aes256_buffer(bin.data(), bin.size(), enc_data.data(), &aes_key, &iv); + std::copy(enc_data.begin(), enc_data.end(), bin.begin()); + + block link_block(0x20000000, enc_data.size()); + // ignored_item ign(1, {0}); + std::shared_ptr image_def = new_block->get_item(); + link_block.items.push_back(image_def); + + link_block.next_block_rel += (link_block.to_words().size())*4 + iv_data.size(); + + auto tmp = link_block.to_words(); + DEBUG_LOG("Link block\n"); + for (auto x : tmp) DEBUG_LOG("%08x", x); + DEBUG_LOG("\n"); + + std::vector link_data = words_to_lsb_bytes(tmp.begin(), tmp.end()); + + bin.insert(bin.begin(), link_data.begin(), link_data.end()); + + bin.insert(bin.begin() + link_data.size(), iv_data.begin(), iv_data.end()); + + new_block->physical_addr = link_block.physical_addr + link_block.next_block_rel; + new_block->next_block_rel = -link_block.next_block_rel; + + std::shared_ptr load_map = new_block->get_item(); + if (load_map != nullptr) { + new_block->items.erase(std::remove(new_block->items.begin(), new_block->items.end(), load_map), new_block->items.end()); + } + + return hash_andor_sign(bin, storage_addr, runtime_addr, new_block, public_key, private_key, hash_value, sign);; +} +#endif diff --git a/bintool/bintool.h b/bintool/bintool.h new file mode 100644 index 0000000..b2c6499 --- /dev/null +++ b/bintool/bintool.h @@ -0,0 +1,41 @@ +#pragma once + +#include + +#if HAS_MBEDTLS + #include "mbedtls_wrapper.h" +#endif +#include "elf_file.h" +#include "metadata.h" + +typedef enum verified_t { + none, + failed, + passed +} verified_t; + +// Common +#if HAS_MBEDTLS + int read_keys(const std::string &filename, public_t *public_key, private_t *private_key); + void hash_andor_sign_block(block *new_block, const public_t public_key, const private_t private_key, bool hash_value, bool sign, std::vector to_hash = {}); +#endif + +// Elfs +std::unique_ptr find_first_block(elf_file *elf); +block place_new_block(elf_file *elf, std::unique_ptr &first_block); +#if HAS_MBEDTLS + int hash_andor_sign(elf_file *elf, block *new_block, const public_t public_key, const private_t private_key, bool hash_value, bool sign, bool clear_sram = false); + int encrypt(elf_file *elf, block *new_block, const private_t aes_key, const public_t public_key, const private_t private_key, bool hash_value, bool sign); +#endif + +// Bins +typedef std::function &bin, uint32_t size)> get_more_bin_cb; +std::unique_ptr find_first_block(std::vector bin, uint32_t storage_addr); +std::unique_ptr get_last_block(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block, get_more_bin_cb more_cb = nullptr); +std::vector> get_all_blocks(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block, get_more_bin_cb more_cb = nullptr); +block place_new_block(std::vector &bin, uint32_t storage_addr, std::unique_ptr &first_block); +#if HAS_MBEDTLS + std::vector hash_andor_sign(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *new_block, const public_t public_key, const private_t private_key, bool hash_value, bool sign, bool clear_sram = false); + std::vector encrypt(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *new_block, const private_t aes_key, const public_t public_key, const private_t private_key, bool hash_value, bool sign); + void verify_block(std::vector bin, uint32_t storage_addr, uint32_t runtime_addr, block *block, verified_t &hash_verified, verified_t &sig_verified); +#endif diff --git a/bintool/mbedtls_wrapper.c b/bintool/mbedtls_wrapper.c new file mode 100644 index 0000000..1d2e115 --- /dev/null +++ b/bintool/mbedtls_wrapper.c @@ -0,0 +1,242 @@ +#include "mbedtls_wrapper.h" +#include +#include +#include + +#if ENABLE_DEBUG_LOG +#define DEBUG_LOG(...) printf(__VA_ARGS__) +static void dump_buf(const char *title, const unsigned char *buf, size_t len) +{ + size_t i; + + DEBUG_LOG("%s", title); + for (i = 0; i < len; i++) { + DEBUG_LOG("%c%c", "0123456789ABCDEF" [buf[i] / 16], + "0123456789ABCDEF" [buf[i] % 16]); + } + DEBUG_LOG("\n"); +} + +static void dump_pubkey(const char *title, mbedtls_ecdsa_context *key) +{ + unsigned char buf[300]; + size_t len; + + if (mbedtls_ecp_point_write_binary(&key->grp, &key->Q, + MBEDTLS_ECP_PF_UNCOMPRESSED, &len, buf, sizeof(buf)) != 0) { + DEBUG_LOG("internal error\n"); + return; + } + + dump_buf(title, buf, len); +} +#else +#define DEBUG_LOG(...) ((void)0) +#define dump_buf(...) ((void)0) +#define dump_pubkey(...) ((void)0) +#endif + +void mb_sha256_buffer(const uint8_t *data, size_t len, message_digest_t *digest_out) { + mbedtls_sha256(data, len, digest_out->bytes, 0); +} + +void mb_aes256_buffer(const uint8_t *data, size_t len, uint8_t *data_out, const private_t *key, iv_t *iv) { + mbedtls_aes_context aes; + + assert(len % 16 == 0); + + mbedtls_aes_setkey_enc(&aes, key->bytes, 256); + uint8_t stream_block[16] = {0}; + size_t nc_off = 0; + mbedtls_aes_crypt_ctr(&aes, len, &nc_off, iv->bytes, stream_block, data, data_out); +} + +void raw_to_der(signature_t *sig) { + // todo make this der - currently ber + unsigned char r[33]; + r[0] = 0; + memcpy(r+1, sig->bytes, 32); + unsigned char s[33]; + s[0] = 0; + memcpy(s+1, sig->bytes + 32, 32); + + int8_t r_len_dec = 0; + if (r[1] & 0x80) { + // Needs padding + r_len_dec = -1; + } else { + for (int i=1; i < 32; i++) { + if (r[i] != 0) { + break; + } + r_len_dec++; + } + } + + int8_t s_len_dec = 0; + if (s[1] & 0x80) { + // Needs padding + s_len_dec = -1; + } else { + for (int i=1; i < 32; i++) { + if (s[i] != 0) { + break; + } + s_len_dec++; + } + } + + // Write it out + sig->der[0] = 0x30; + sig->der[1] = 68 - r_len_dec - s_len_dec; + sig->der[2] = 0x02; + sig->der[3] = 32 - r_len_dec; + uint8_t b2 = sig->der[3]; + memcpy(sig->der + 4, r + 1 + r_len_dec, b2); + sig->der[4 + b2] = 0x02; + sig->der[5 + b2] = 32 - s_len_dec; + uint8_t b3 = sig->der[5 + b2]; + memcpy(sig->der + 6 + b2, s + 1 + s_len_dec, b3); + + + sig->der_len = 6 + b2 + b3; +} + + +void der_to_raw(signature_t *sig) { + assert(sig->der[0] == 0x30); + assert(sig->der[2] == 0x02); + uint8_t b2 = sig->der[3]; + assert(sig->der[4 + b2] == 0x02); + uint8_t b3 = sig->der[5 + b2]; + + assert(sig->der_len == 6u + b2 + b3); + + unsigned char r[32]; + if (b2 == 33) { + memcpy(r, sig->der + 4 + 1, 32); + } else if (b2 == 32) { + memcpy(r, sig->der + 4, 32); + } else { + memset(r, 0, sizeof(r)); + memcpy(r + (32 - b2), sig->der + 4, (32 - b2)); + } + + unsigned char s[32]; + if (b3 == 33) { + memcpy(s, sig->der + 6 + b2 + 1, 32); + } else if (b3 == 32) { + memcpy(s, sig->der + 6 + b2, 32); + } else { + memset(s, 0, sizeof(r)); + memcpy(s + (32 - b3), sig->der + 6 + b2, (32 - b3)); + } + + memset(sig->bytes, 0, sizeof(sig->bytes)); + memcpy(sig->bytes, r, sizeof(r)); + memcpy(sig->bytes + 32, s, sizeof(s)); +} + + +void mb_sign_sha256(const uint8_t *entropy, size_t entropy_size, const message_digest_t *m, const public_t *p, const private_t *d, signature_t *out) { + int ret = 1; + mbedtls_ecdsa_context ctx_sign; + mbedtls_entropy_context entropy_ctx; + mbedtls_ctr_drbg_context ctr_drbg; + + mbedtls_ecdsa_init(&ctx_sign); + mbedtls_ctr_drbg_init(&ctr_drbg); + + memset(out->der, 0, sizeof(out->der)); + + DEBUG_LOG("\n . Seeding the random number generator..."); + fflush(stdout); + + mbedtls_entropy_init(&entropy_ctx); + // mbedtls_entropy_update_manual(&entropy, entropy_in, entropy_size); + if ((ret = mbedtls_ctr_drbg_seed(&ctr_drbg, mbedtls_entropy_func, &entropy_ctx, + (const unsigned char *) entropy, + entropy_size)) != 0) { + DEBUG_LOG(" failed\n ! mbedtls_ctr_drbg_seed returned %d\n", ret); + return; + } + + DEBUG_LOG(" ok\n"); + + DEBUG_LOG(" . Loading key pair..."); + fflush(stdout); + + mbedtls_ecp_group_load(&ctx_sign.grp, MBEDTLS_ECP_DP_SECP256K1); + mbedtls_mpi_read_binary(&ctx_sign.d, (unsigned char*)d, 32); + mbedtls_mpi_read_binary(&ctx_sign.Q.X, (unsigned char*)p, 32); + mbedtls_mpi_read_binary(&ctx_sign.Q.Y, (unsigned char*)p + 32, 32); + // Z must be 1 + mbedtls_mpi_add_int(&ctx_sign.Q.Z, &ctx_sign.Q.Z, 1); + + DEBUG_LOG(" ok (key size: %d bits)\n", (int) ctx_sign.grp.pbits); + + ret = mbedtls_ecp_check_pub_priv(&ctx_sign, &ctx_sign); + DEBUG_LOG("Pub Priv Returned %d\n", ret); + + dump_pubkey(" + Public key: ", &ctx_sign); + + dump_buf(" + Hash: ", m->bytes, sizeof(m->bytes)); + + DEBUG_LOG(" . Signing message hash..."); + fflush(stdout); + + if ((ret = mbedtls_ecdsa_write_signature(&ctx_sign, MBEDTLS_MD_SHA256, + m->bytes, sizeof(m->bytes), + out->der, &out->der_len, + mbedtls_ctr_drbg_random, &ctr_drbg)) != 0) { + DEBUG_LOG(" failed\n ! mbedtls_ecdsa_write_signature returned %d\n", ret); + return; + } + DEBUG_LOG(" ok (signature length = %u)\n", (unsigned int) out->der_len); + + dump_buf(" + DER Signature: ", out->der, out->der_len); + + // Populate raw signature value from der + der_to_raw(out); + + dump_buf(" + Raw Signature: ", (unsigned char*)out, 64); +} + +uint32_t mb_verify_signature_secp256k1( + signature_t signature[1], + const public_t public_key[1], + const message_digest_t digest[1]) { + + int ret = 1; + mbedtls_ecdsa_context ctx_verify; + unsigned char hash[32]; + memcpy(hash, digest, sizeof(hash)); + if (signature->der_len == 0) { + raw_to_der(signature); + } + + mbedtls_ecdsa_init(&ctx_verify); + + mbedtls_ecp_group_load(&ctx_verify.grp, MBEDTLS_ECP_DP_SECP256K1); + mbedtls_mpi_read_binary(&ctx_verify.Q.X, public_key->bytes, 32); + mbedtls_mpi_read_binary(&ctx_verify.Q.Y, public_key->bytes + 32, 32); + // Z must be 1 + mbedtls_mpi_add_int(&ctx_verify.Q.Z, &ctx_verify.Q.Z, 1); + + /* + * Verify signature + */ + DEBUG_LOG(" . Verifying signature..."); + fflush(stdout); + + if ((ret = mbedtls_ecdsa_read_signature(&ctx_verify, + hash, sizeof(hash), + signature->der, signature->der_len)) != 0) { + DEBUG_LOG(" failed\n ! mbedtls_ecdsa_read_signature returned -%x\n", -ret); + return 1; + } + + DEBUG_LOG(" ok\n"); + + return 0; +} diff --git a/bintool/mbedtls_wrapper.h b/bintool/mbedtls_wrapper.h new file mode 100644 index 0000000..c4e2b77 --- /dev/null +++ b/bintool/mbedtls_wrapper.h @@ -0,0 +1,60 @@ +#pragma once +#ifdef __cplusplus +extern "C" { +#endif + +#undef MBEDTLS_ECDSA_DETERMINISTIC + +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#ifdef __cplusplus +#define _Static_assert static_assert +#endif + +typedef struct signature { + /** An array 64 bytes making up 2 256-bit values. */ + uint8_t bytes[64]; + uint8_t der[MBEDTLS_ECDSA_MAX_LEN]; + size_t der_len; +} signature_t; /**< Convenience typedef */ + +typedef struct message_digest { + /** An array 32 bytes making up the 256-bit value. */ + uint8_t bytes[32]; +} message_digest_t; /**< Convenience typedef */ + +typedef struct iv { + /** An array 16 bytes random data. */ + uint8_t bytes[16]; +} iv_t; /**< Convenience typedef */ + +typedef signature_t public_t; +typedef message_digest_t private_t; + +void mb_sha256_buffer(const uint8_t *data, size_t len, message_digest_t *digest_out); +void mb_aes256_buffer(const uint8_t *data, size_t len, uint8_t *data_out, const private_t *key, iv_t *iv); +void mb_sign_sha256(const uint8_t *entropy, size_t entropy_size, const message_digest_t *m, const public_t *p, const private_t *d, signature_t *out); + +uint32_t mb_verify_signature_secp256k1( + signature_t signature[1], + const public_t public_key[1], + const message_digest_t digest[1]); + +#define sha256_buffer mb_sha256_buffer +#define aes256_buffer mb_aes256_buffer +#define sign_sha256 mb_sign_sha256 +#define verify_signature_secp256k1 mb_verify_signature_secp256k1 + +#ifdef __cplusplus +}; +#endif diff --git a/bintool/metadata.h b/bintool/metadata.h new file mode 100644 index 0000000..2a3d6cb --- /dev/null +++ b/bintool/metadata.h @@ -0,0 +1,656 @@ +#pragma once + +#include +#include + +#include "boot/picobin.h" +#include + +#include + +#include "elf_file.h" + +#if ENABLE_DEBUG_LOG +#define DEBUG_LOG(...) printf(__VA_ARGS__) +#else +#define DEBUG_LOG(...) ((void)0) +#endif + +struct item; + +template std::vector lsb_bytes_to_words(InputIterator begin, InputIterator end) { + using InputType = typename std::iterator_traits::value_type; + static_assert(sizeof(InputType) == 1, ""); + std::vector rc; + size_t size = end - begin; + assert(!(size & 3)); + if (size) { + rc.reserve(size / 4); + for(auto it = begin; it < end; ) { + uint32_t word = *it++; + word |= (*it++) << 8; + word |= (*it++) << 16; + word |= (*it++) << 24; + rc.push_back(word); + } + } + return rc; +} + +template std::vector words_to_lsb_bytes(InputIterator begin, InputIterator end) { + static_assert(sizeof(OutputType) == 1, ""); + std::vector rc; + size_t size = end - begin; + if (size) { + rc.reserve(size * 4); + for(auto it = begin; it < end; ) { + uint32_t word = *it++; + rc.push_back(word & 0xff); + rc.push_back((word >> 8) & 0xff); + rc.push_back((word >> 16) & 0xff); + rc.push_back((word >> 24) & 0xff); + } + } + return rc; +} + + +struct item_writer_context { + item_writer_context(uint32_t base_addr) : base_addr(base_addr), word_offset(0) {} + std::map, uint32_t> item_word_offsets; + uint32_t base_addr; + uint32_t word_offset; +}; + +struct item { + explicit item() {}; + virtual ~item() = default; + virtual uint8_t type() const = 0; + + static uint32_t decode_size(uint32_t item_header) { + uint32_t size; + if (item_header & 0x80) { + size = (uint16_t)(item_header >> 8); + } else { + size = (uint8_t)(item_header >> 8); + } + return size; + } + + virtual std::vector to_words(item_writer_context &ctx) const = 0; + virtual uint32_t encode_type_and_size(unsigned int size) const { + assert(size < PICOBIN_MAX_BLOCK_SIZE); + if (size < 256) { + return (size << 8u) | type(); + } else { + // todo byte order + return (size << 8u) | 0x80 | type(); + } + } +}; + + +// always use single byte size +struct single_byte_size_item : public item { + virtual uint32_t encode_type_and_size(unsigned int size) const override { + assert(size < PICOBIN_MAX_BLOCK_SIZE); + assert(size < 128); + assert(!(type() & 128)); + return (size << 8u) | type(); + } +}; + +// always use double byte size +struct double_byte_size_item : public item { + virtual uint32_t encode_type_and_size(unsigned int size) const override { + assert(size < PICOBIN_MAX_BLOCK_SIZE); + assert(type() & 128); + // todo byte order + return (size << 8u) | 0x80 | type(); + } +}; + +struct ignored_item : public double_byte_size_item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_2BS_IGNORED; } + ignored_item() = default; + + explicit ignored_item(uint32_t size, std::vector data) : size(size), data(data) {} + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + uint32_t size = item::decode_size(header); + std::vector data; + for (unsigned int i=1; i < size; i++) { + data.push_back(*it++); + } + return std::make_shared(size, data); + } + + std::vector to_words(item_writer_context& ctx) const override { + std::vector ret; + ret.push_back(encode_type_and_size(size)); + ret.insert(ret.end(), data.begin(), data.end()); + return ret; + } + + uint32_t size; + std::vector data; +}; + +enum image_type_image_type { + type_invalid=PICOBIN_IMAGE_TYPE_IMAGE_TYPE_INVALID, + type_exe=PICOBIN_IMAGE_TYPE_IMAGE_TYPE_EXE, + type_data=PICOBIN_IMAGE_TYPE_IMAGE_TYPE_DATA +}; + +enum image_type_exe_security { + sec_unspecified=PICOBIN_IMAGE_TYPE_EXE_SECURITY_UNSPECIFIED, + sec_ns=PICOBIN_IMAGE_TYPE_EXE_SECURITY_NS, + sec_s=PICOBIN_IMAGE_TYPE_EXE_SECURITY_S +}; + +enum image_type_exe_cpu { + cpu_arm=PICOBIN_IMAGE_TYPE_EXE_CPU_ARM, + cpu_riscv=PICOBIN_IMAGE_TYPE_EXE_CPU_RISCV, + cpu_varmulet=PICOBIN_IMAGE_TYPE_EXE_CPU_VARMULET +}; + +enum image_type_exe_chip { + chip_rp2040=PICOBIN_IMAGE_TYPE_EXE_CHIP_RP2040, + chip_rp2350=PICOBIN_IMAGE_TYPE_EXE_CHIP_RP2350 +}; + +struct image_type_item : public single_byte_size_item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_1BS_IMAGE_TYPE; } + image_type_item() = default; + + explicit image_type_item(uint16_t flags) : flags(flags) {} + template static std::shared_ptr parse(I it, I end, uint32_t header) { + return std::make_shared(header >> 16); + } + + std::vector to_words(item_writer_context& ctx) const override { + return {encode_type_and_size(1) | (flags << 16)}; + } + + image_type_image_type image_type() const { return static_cast((flags & PICOBIN_IMAGE_TYPE_IMAGE_TYPE_BITS) >> PICOBIN_IMAGE_TYPE_IMAGE_TYPE_LSB); } + image_type_exe_security security() const { return static_cast((flags & PICOBIN_IMAGE_TYPE_EXE_SECURITY_BITS) >> PICOBIN_IMAGE_TYPE_EXE_SECURITY_LSB); } + image_type_exe_cpu cpu() const { return static_cast((flags & PICOBIN_IMAGE_TYPE_EXE_CPU_BITS) >> PICOBIN_IMAGE_TYPE_EXE_CPU_LSB); } + image_type_exe_chip chip() const { return static_cast((flags & PICOBIN_IMAGE_TYPE_EXE_CHIP_BITS) >> PICOBIN_IMAGE_TYPE_EXE_CHIP_LSB); } + bool tbyb() const { return flags & PICOBIN_IMAGE_TYPE_EXE_TBYB_BITS; } + + uint16_t flags; +}; + +struct partition_table_item : public single_byte_size_item { + struct partition { + uint8_t permissions = 0; + uint16_t first_sector = 0; + uint16_t last_sector = 0; + uint32_t flags = 0; + uint64_t id; + std::string name; + std::vector extra_families; + + std::vector to_words() const { + std::vector ret = { + ((permissions << PICOBIN_PARTITION_PERMISSIONS_LSB) & PICOBIN_PARTITION_PERMISSIONS_BITS) + | ((first_sector << PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_LSB) & PICOBIN_PARTITION_LOCATION_FIRST_SECTOR_BITS) + | ((last_sector << PICOBIN_PARTITION_LOCATION_LAST_SECTOR_LSB) & PICOBIN_PARTITION_LOCATION_LAST_SECTOR_BITS), + ((permissions << PICOBIN_PARTITION_PERMISSIONS_LSB) & PICOBIN_PARTITION_PERMISSIONS_BITS) + | flags, + }; + if (flags & PICOBIN_PARTITION_FLAGS_HAS_ID_BITS) { + ret.push_back((uint32_t)id); + ret.push_back((uint32_t)(id >> 32)); + } + if (extra_families.size() > 0) { + assert(extra_families.size() == (flags & PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_BITS) >> PICOBIN_PARTITION_FLAGS_ACCEPTS_NUM_EXTRA_FAMILIES_LSB); + ret.insert(ret.end(), extra_families.begin(), extra_families.end()); + } + if (name.size() > 0) { + char size = name.size(); + std::vector name_vec = {size}; + for (char c : name) { + name_vec.push_back(c); + } + while (name_vec.size() % 4 != 0) name_vec.push_back(0); + while (name_vec.size() > 0) { + ret.push_back(*(uint32_t*)name_vec.data()); + name_vec.erase(name_vec.begin(), name_vec.begin() + 4); + } + } + return ret; + } + }; + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_PARTITION_TABLE; } + partition_table_item() = default; + + explicit partition_table_item(uint32_t unpartitioned_flags, bool singleton) : unpartitioned_flags(unpartitioned_flags), singleton(singleton) {} + template static std::shared_ptr parse(I it, I end, uint32_t header) { + return nullptr; + } + + std::vector to_words(item_writer_context& ctx) const override { + std::vector partition_words; + for (auto p : partitions) { + auto words = p.to_words(); + partition_words.insert(partition_words.end(), words.begin(), words.end()); + } + std::vector ret = { + encode_type_and_size(2 + partition_words.size()) | (singleton << 31) | ((uint8_t)partitions.size() << 24), + unpartitioned_flags + }; + ret.insert(ret.end(), partition_words.begin(), partition_words.end()); + return ret; + } + + uint32_t unpartitioned_flags; + bool singleton; + std::vector partitions; +}; + +struct vector_table_item : public single_byte_size_item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_1BS_VECTOR_TABLE; } + vector_table_item() = default; + + explicit vector_table_item(uint32_t addr) : addr(addr) {} + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + if (decode_size(header) != 2) { + printf("Bad block size %d for vector table item\n", decode_size(header)); + assert(false); + } + return std::make_shared(*it++); + } + + std::vector to_words(item_writer_context& ctx) const override { + return {encode_type_and_size(2), addr}; + } + + uint32_t addr; +}; + +struct rolling_window_delta_item : public single_byte_size_item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_1BS_ROLLING_WINDOW_DELTA; } + rolling_window_delta_item() = default; + + explicit rolling_window_delta_item(uint32_t addr) : addr(addr) {} + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + if (decode_size(header) != 2) { + printf("Bad block size %d for rolling window delta item\n", decode_size(header)); + assert(false); + } + return std::make_shared(*it++); + } + + std::vector to_words(item_writer_context& ctx) const override { + return {encode_type_and_size(2), (uint32_t)addr}; + } + + int32_t addr; +}; + +struct entry_point_item : public single_byte_size_item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_1BS_ENTRY_POINT; } + entry_point_item() = default; + + explicit entry_point_item(uint32_t ep, uint32_t sp) : ep(ep), sp(sp) {} + explicit entry_point_item(uint32_t ep, uint32_t sp, uint32_t splim) : ep(ep), sp(sp), splim(splim), splim_set(true) {} + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + uint32_t size = decode_size(header); + uint32_t ep = *it++; + uint32_t sp = *it++; + if (size == 3) { + return std::make_shared(ep, sp); + } else if (size == 4) { + uint32_t splim = *it++; + return std::make_shared(ep, sp, splim); + } else { + printf("Bad block size %d for entry point item\n", size); + assert(false); + return nullptr; + } + } + + std::vector to_words(item_writer_context& ctx) const override { + std::vector ret = {encode_type_and_size(splim_set ? 4 : 3), ep, sp}; + if (splim_set) ret.push_back(splim); + return ret; + } + + uint32_t ep; + uint32_t sp; + uint32_t splim; + bool splim_set = false; +}; + +struct load_map_item : public item { + struct entry { + uint32_t storage_address; + uint32_t runtime_address; + uint32_t size; + }; + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_LOAD_MAP; } + load_map_item() = default; + + explicit load_map_item(bool absolute, std::vector entries) : absolute(absolute), entries(entries) {} + template static std::shared_ptr parse(I& it, I end, uint32_t header, uint32_t current_addr) { + uint8_t num_entries = (header >> 24) & 0x7f; + bool absolute = (header >> 24) & 0x80; + std::vector entries; + for (int i=0; i < num_entries; i++) { + uint32_t storage_address = (uint32_t)*it++; + uint32_t runtime_address = (uint32_t)*it++; + uint32_t size = (uint32_t)*it++; + if (storage_address != 0) { + if (absolute) { + size -= runtime_address; + } else { + storage_address += current_addr; + } + } + entries.push_back({ + storage_address, + runtime_address, + size + }); + } + + return std::make_shared(absolute, entries); + } + + std::vector to_words(item_writer_context& ctx) const override { + assert(entries.size() < 256); + std::vector rc = { + encode_type_and_size(1 + 3 * entries.size()) | (((uint8_t)entries.size())<<24) | (absolute ? 1 << 31 : 0) + }; + for(const auto &entry : entries) { + // todo byte order + if (absolute) { + rc.push_back(entry.storage_address); + rc.push_back(entry.runtime_address); + rc.push_back(entry.runtime_address + entry.size); + } else { + if (entry.storage_address != 0) { + rc.push_back(entry.storage_address - ctx.base_addr - ctx.word_offset * 4); + } else { + rc.push_back(entry.storage_address); + } + rc.push_back(entry.runtime_address); + rc.push_back(entry.size); + } + } + return rc; + } + + bool absolute; + std::vector entries; +}; + +struct version_item : public item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_1BS_VERSION; } + version_item() = default; + explicit version_item(uint16_t major, uint16_t minor) : version_item(major, minor, 0, {}) {} + version_item(uint16_t major, uint16_t minor, uint16_t rollback, std::vector otp_rows) : + rollback(rollback), otp_rows(std::move(otp_rows)) { + // NOTE: A linux sysroot might define `major` and `minor` as macros so we + // can't use regular initialization in the form `major(major)` since we woudn't + // be able to tell if we're calling a macro or not. + this->major = major; + this->minor = minor; + } + + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + // todo validate + uint32_t major_minor = *it++; + uint16_t major = major_minor >> 16; + uint16_t minor = major_minor & 0xffff; + unsigned int otp_row_count = header >> 24; + uint16_t rollback = 0; + std::vector otp_rows; + if (otp_row_count) { + unsigned int pair = *it++; + // todo endian + rollback = (uint16_t) pair; + for(unsigned int i=0;i> ((1^(i&1))*16))); + } + } + return std::make_shared(major, minor, rollback, otp_rows); + } + + std::vector to_words(item_writer_context& ctx) const override { + assert(otp_rows.size() < 256); + unsigned int size = 2 + (!otp_rows.empty() + otp_rows.size() + 1) / 2; + std::vector rc = { + (uint32_t)(encode_type_and_size(size) | (otp_rows.size() << 24)) + }; + uint32_t major_minor = (uint16_t)major << 16 | (uint16_t)minor; + rc.push_back(major_minor); + if (!otp_rows.empty()) { + rc.push_back(rollback); + for(unsigned int i=0;i otp_rows; +}; + +struct hash_def_item : public single_byte_size_item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_1BS_HASH_DEF; } + hash_def_item() = default; + + explicit hash_def_item(uint8_t hash_type) : hash_type(hash_type) {} + explicit hash_def_item(uint8_t hash_type, uint16_t block_words_to_hash) : hash_type(hash_type), block_words_to_hash(block_words_to_hash) {} + + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + uint8_t hash_type = (header & 0xff000000) >> 24; + uint16_t block_words_to_hash = *it++; + return std::make_shared(hash_type, block_words_to_hash); + } + + std::vector to_words(item_writer_context& ctx) const override { + return { + encode_type_and_size(2) | (hash_type << 24), + block_words_to_hash == 0 ? (ctx.word_offset + 2) : block_words_to_hash + }; + } + + uint8_t hash_type; + uint16_t block_words_to_hash = 0; +}; + +struct signature_item : public item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_SIGNATURE; } + signature_item() = default; + + explicit signature_item(uint8_t sig_type) : sig_type(sig_type) {} + explicit signature_item(uint8_t sig_type, std::vector signature_bytes, std::vector public_key_bytes) : sig_type(sig_type), signature_bytes(signature_bytes), public_key_bytes(public_key_bytes) {} + + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + auto sig_block_size = decode_size(header); + uint8_t sig_type = (header & 0xff000000) >> 24; + assert(sig_block_size == 0x21); + + std::vector signature_bytes; + std::vector public_key_bytes; + + { + std::vector words; + for (int i=0; i < 16; i++) { + words.push_back(*it++); + } + auto bytes = words_to_lsb_bytes(words.begin(), words.end()); + std::copy(bytes.begin(), bytes.end(), std::back_inserter(public_key_bytes)); + } + { + std::vector words; + for (int i=0; i < 16; i++) { + words.push_back(*it++); + } + auto bytes = words_to_lsb_bytes(words.begin(), words.end()); + std::copy(bytes.begin(), bytes.end(), std::back_inserter(signature_bytes)); + } + return std::make_shared(sig_type, signature_bytes, public_key_bytes); + } + + std::vector to_words(item_writer_context& ctx) const override { + assert(signature_bytes.size() % 4 == 0); + assert(public_key_bytes.size() % 4 == 0); + std::vector rc = { + encode_type_and_size(1 + public_key_bytes.size()/4 + signature_bytes.size()/4) | (sig_type << 24), + }; + auto words = lsb_bytes_to_words(public_key_bytes.begin(), public_key_bytes.end()); + std::copy(words.begin(), words.end(), std::back_inserter(rc)); + words = lsb_bytes_to_words(signature_bytes.begin(), signature_bytes.end()); + std::copy(words.begin(), words.end(), std::back_inserter(rc)); + return rc; + } + + uint8_t sig_type; + std::vector signature_bytes; + std::vector public_key_bytes; +}; + +struct hash_value_item : public item { + uint8_t type() const override { return PICOBIN_BLOCK_ITEM_HASH_VALUE; } + hash_value_item() = default; + + explicit hash_value_item(std::vector hash_bytes) : hash_bytes(hash_bytes) {} + + template static std::shared_ptr parse(I& it, I end, uint32_t header) { + auto hash_size = decode_size(header) - 1; + std::vector hash_words; + for (unsigned int i=0; i < hash_size; i++) { + hash_words.push_back(*it++); + } + return std::make_shared(words_to_lsb_bytes(hash_words.begin(), hash_words.end())); + } + + std::vector to_words(item_writer_context& ctx) const override { + assert(hash_bytes.size() % 4 == 0); + std::vector rc = { + encode_type_and_size(1 + hash_bytes.size()/4), + }; + auto words = lsb_bytes_to_words(hash_bytes.begin(), hash_bytes.end()); + std::copy(words.begin(), words.end(), std::back_inserter(rc)); + return rc; + } + + std::vector hash_bytes; +}; + + +struct block { + explicit block(uint32_t physical_addr, uint32_t next_block_rel=0, uint32_t next_block_rel_index=0, std::vector> items = {}) + : physical_addr(physical_addr), + next_block_rel(next_block_rel), + next_block_rel_index(next_block_rel_index), + items( std::move(items)) {} + template static std::unique_ptr parse(uint32_t physical_addr, I next_block_rel_loc, I it, I end) { + I block_base = it; + uint32_t current_addr = physical_addr + 4; // for the ffffded3 + std::vector> items; + while (it < end) { + auto item_base = it; + uint32_t header = *it++; + uint32_t size = item::decode_size(header); + std::shared_ptr i; + switch ((uint8_t)header) { + case PICOBIN_BLOCK_ITEM_1BS_IMAGE_TYPE: + i = image_type_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_PARTITION_TABLE: + i = ignored_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_1BS_VECTOR_TABLE: + i = vector_table_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_1BS_ROLLING_WINDOW_DELTA: + i = rolling_window_delta_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_1BS_VERSION: + i = version_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_1BS_ENTRY_POINT: + i = entry_point_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_LOAD_MAP: + i = load_map_item::parse(it, end, header, current_addr); + break; + case PICOBIN_BLOCK_ITEM_1BS_HASH_DEF: + i = hash_def_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_HASH_VALUE: + i = hash_value_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_SIGNATURE: + i = signature_item::parse(it, end, header); + break; + case PICOBIN_BLOCK_ITEM_2BS_IGNORED: + i = ignored_item::parse(it, end, header); + break; + default: + DEBUG_LOG("Ignoring block type: %02x\n", (uint8_t)header); + i = ignored_item::parse(it, end, header); + break; + } + if (i) { + items.push_back(i); + } + current_addr += (size*4); + if (it != item_base + size) { + printf("WARNING: item at %08x had wrong size %x (expected %x)\n", (unsigned int)(physical_addr + (item_base - block_base) * 4), (int)(it - item_base), (int)size); + it = item_base + size; + assert(false); + } + } + uint32_t next_block_rel = *next_block_rel_loc; + uint32_t next_block_rel_index = next_block_rel_loc - block_base + 1; + return std::make_unique(physical_addr, next_block_rel, next_block_rel_index, items); + } + std::vector to_words() { + std::vector words; + words.push_back(PICOBIN_BLOCK_MARKER_START); + item_writer_context ctx(physical_addr); + for(const auto &item : items) { + ctx.word_offset = words.size(); + ctx.item_word_offsets[item] = ctx.word_offset; + const auto item_words = item->to_words(ctx); + std::copy(item_words.begin(), item_words.end(), std::back_inserter(words)); + } + // todo should use a real item struct + + assert(words.size() <= PICOBIN_MAX_BLOCK_SIZE - 3); + // todo byte order + words.push_back(PICOBIN_BLOCK_ITEM_2BS_LAST | (words.size() - 1) << 8); + words.push_back(next_block_rel); + words.push_back(PICOBIN_BLOCK_MARKER_END); + return words; + } + + template std::shared_ptr get_item() { + I tmp = I(); + uint8_t type = tmp.type(); + auto it = std::find_if(items.begin(), items.end(), [type](std::shared_ptr i) { return i->type() == type; }); + if (it != std::end(items)) { + return std::dynamic_pointer_cast(*it); + } else { + return nullptr; + } + } + + uint32_t physical_addr; + uint32_t next_block_rel; + uint32_t next_block_rel_index; + std::vector> items; +}; diff --git a/bootrom.end.bin b/bootrom.end.bin new file mode 100644 index 0000000000000000000000000000000000000000..6c5e725106edc5336caf848e59fbdbb90907013d GIT binary patch literal 512 zcmXZVOK1~e5C`yYAL-Y`u)B?rY->rQ0V5W5>!GdG$43aW_&`gqqK#ezTWoxQ7a>86 ziXvkeewqAkvV4h+YKKg9jDdTOQK5-7W5tgiqJHr{6I1pP6(!-40Ua!?8A+ z7mZhfZ9ROOc6tLip#3-Gy5CiF-RFv3IoChU9F;L!d2JA3^QYif-nxFbb5x#qbSP1H<>6qSvOe{Ym|E#W25)P zT<~7?7UB~Pc2=%25eE9!*noxQ^(BbF6xh~{9xC#HCi!nn(d%5|%6b(QNmrVQ!bvy< zN1V);zTRBXd9>Zcl`%TE_w9=QE`ajP!6j#Yu7?U7priP!vlp|i6O;?TsjcWcopy(); } + settings_holder& operator=(const settings_holder&) = default; void save_into() { settings->save_into(); } @@ -174,6 +175,7 @@ namespace cli { struct matchable { matchable() = default; + virtual ~matchable() = default; explicit matchable(string name) : _name(std::move(name)) {} @@ -203,6 +205,10 @@ namespace cli { return _force_expand_help; } + string collapse_synopsys() const { + return _collapse_synopsys; + } + string doc() const { return _doc; } @@ -226,6 +232,7 @@ namespace cli { int _max = 1; bool _doc_non_optional = false; bool _force_expand_help = false; + string _collapse_synopsys = ""; }; template @@ -274,6 +281,11 @@ namespace cli { return *static_cast(this); } + D &collapse_synopsys(string v) { + _collapse_synopsys = v; + return *static_cast(this); + } + D &max(int v) { _max = v; return *static_cast(this); @@ -394,56 +406,121 @@ namespace cli { }); return *this; } + template value &add_to(T &t) { + // note we cannot capture "this" + on_action([&t](const string& value) { + t.push_back(value); + return ""; + }); + return *this; + } }; struct integer : public value_base { explicit integer(string name) : value_base(std::move(name)) {} + template + static std::string parse_string(std::string value, T& out) { + size_t pos = 0; + long lvalue = std::numeric_limits::max(); + int64_t base = 10; + if (value.find("0x") == 0) { + value = value.substr(2); + base = 16; + } else if (value.find("0b") == 0) { + value = value.substr(2); + base = 2; + } + try { + lvalue = std::stoll(value, &pos, base); + if (pos != value.length()) { + return "Garbage after integer value: " + value.substr(pos); + } + } catch (std::invalid_argument&) { + return value + " is not a valid integer"; + } catch (std::out_of_range&) { + } + if (lvalue != (int64_t)lvalue) { + return value + " is too big"; + } + out = (int64_t)lvalue; + return ""; + } + template integer &set(T &t) { - int min = _min_value; - int max = _max_value; + int64_t min = _min_value; + int64_t max = _max_value; + int64_t invalid_bits = _invalid_bits; + std::string invalid_bits_error = _invalid_bits_error; string nm = "<" + name() + ">"; // note we cannot capture "this" - on_action([&t, min, max, nm](const string& value) { - size_t pos = 0; - long lvalue = std::numeric_limits::max(); - try { - lvalue = std::stol(value, &pos); - if (pos != value.length()) { - return "Garbage after integer value: " + value.substr(pos); - } - } catch (std::invalid_argument&) { - return value + " is not a valid integer"; - } catch (std::out_of_range&) { - } - if (lvalue != (int)lvalue) { - return value + " is too big"; - } - t = (int)lvalue; + on_action([&t, min, max, nm, invalid_bits, invalid_bits_error](const string& value) { + int64_t tmp = 0; + std::string err = parse_string(value, tmp); + t = tmp; + if (!err.empty()) return err; if (t < min) { return nm + " must be >= " + std::to_string(min); } if (t > max) { return nm + " must be <= " + std::to_string(max); } + if (t & invalid_bits) { + return nm + " " + invalid_bits_error; + } return string(""); }); return *this; } - integer& min_value(int v) { + template + integer &add_to(T &t) { + int64_t min = _min_value; + int64_t max = _max_value; + int64_t invalid_bits = _invalid_bits; + std::string invalid_bits_error = _invalid_bits_error; + string nm = "<" + name() + ">"; + // note we cannot capture "this" + on_action([&t, min, max, nm, invalid_bits, invalid_bits_error](const string& value) { + int64_t tmp = 0; + std::string err = parse_string(value, tmp); + if (!err.empty()) return err; + if (tmp < min) { + return nm + " must be >= " + std::to_string(min); + } + if (tmp > max) { + return nm + " must be <= " + std::to_string(max); + } + if (tmp & invalid_bits) { + return nm + " " + invalid_bits_error; + } + t.push_back(tmp); + return string(""); + }); + return *this; + } + + integer& min_value(int64_t v) { _min_value = v; return *this; } - integer& max_value(int v) { + integer& max_value(int64_t v) { _max_value = v; return *this; } - int _min_value = 0; - int _max_value = std::numeric_limits::max(); + integer& invalid_bits(int64_t bits, std::string error) { + _invalid_bits = bits; + _invalid_bits_error = error; + return *this; + } + + int64_t _min_value = 0; + int64_t _max_value = std::numeric_limits::max(); + std::string _invalid_bits_error; + int64_t _invalid_bits = 0; }; struct hex : public value_base { @@ -488,6 +565,46 @@ namespace cli { return *this; } + template + hex &add_to(T &t) { + unsigned int min = _min_value; + unsigned int max = _max_value; + string nm = "<" + name() + ">"; + // note we cannot capture "this" + on_action([&t, min, max, nm](string value) { + auto ovalue = value; + if (value.find("0x") == 0) value = value.substr(2); + size_t pos = 0; + long lvalue = std::numeric_limits::max(); + try { + lvalue = std::stoul(value, &pos, 16); + if (pos != value.length()) { + return "Garbage after hex value: " + value.substr(pos); + } + } catch (std::invalid_argument&) { + return ovalue + " is not a valid hex value"; + } catch (std::out_of_range&) { + } + if (lvalue != (unsigned int)lvalue) { + return value + " is not a valid 32 bit value"; + } + unsigned int tmp = (unsigned int)lvalue; + if (tmp < min) { + std::stringstream ss; + ss << nm << " must be >= 0x" << std::hex << std::to_string(min); + return ss.str(); + } + if (tmp > max) { + std::stringstream ss; + ss << nm << " must be <= 0x" << std::hex << std::to_string(max); + return ss.str(); + } + t.push_back(tmp); + return string(""); + }); + return *this; + } + hex& min_value(unsigned int v) { _min_value = v; return *this; @@ -507,6 +624,7 @@ namespace cli { sequence, set, exclusive, + collapse, }; public: @@ -516,7 +634,7 @@ namespace cli { explicit group(const T &t) : type(set), elements{t.to_ptr()} {} template - group(Matchable m, Matchable ms...) : elements{m, ms}, type(set) {} + group(Matchable m, Matchable ms...) : type(set), elements{m, ms} {} group &set_type(group_type t) { type = t; @@ -542,23 +660,30 @@ namespace cli { case set: case sequence: { std::vector> tmp{{}}; - for (auto &x : elements) { - auto xs = x->synopsys(); - if (xs.size() == 1) { - for (auto &s : tmp) { - s.push_back(decorate(*x, xs[0])); - } - } else { - auto save = tmp; - tmp.clear(); - for (auto &v : save) { - for (auto &s : xs) { - auto nv = v; - nv.push_back(decorate(*x, s)); - tmp.push_back(nv); + if (_collapse_synopsys.empty()) { + for (auto &x : elements) { + auto xs = x->synopsys(); + if (xs.size() == 1) { + for (auto &s : tmp) { + s.push_back(decorate(*x, xs[0])); + } + } else { + auto save = tmp; + tmp.clear(); + for (auto &v : save) { + for (auto &s : xs) { + auto nv = v; + nv.push_back(decorate(*x, s)); + tmp.push_back(nv); + } } } } + } else { + std::vector xs = {"[" + _collapse_synopsys + "]"}; + for (auto &s : tmp) { + s.push_back(xs[0]); + } } for (const auto &v : tmp) { rc.push_back(join(v, " ")); @@ -580,17 +705,17 @@ namespace cli { return rc; } - group operator|(const group &g) { - return matchable_derived::operator|(g); - } - - group operator&(const group &g) { - return matchable_derived::operator&(g); - } - - group operator+(const group &g) { - return matchable_derived::operator+(g); - } +// group operator|(const group &g) { +// return matchable_derived::operator|(g); +// } +// +// group operator&(const group &g) { +// return matchable_derived::operator&(g); +// } +// +// group operator+(const group &g) { +// return matchable_derived::operator+(g); +// } bool no_match_beats_error() const { return _no_match_beats_error; @@ -776,8 +901,8 @@ namespace cli { private: string _major_group; - vector> elements; group_type type; + vector> elements; bool _no_match_beats_error = true; }; @@ -860,7 +985,7 @@ namespace cli { return update_stats(match_type::match, matchable); } - template struct typed_settings : public opaque_settings { + template struct typed_settings final : public opaque_settings { explicit typed_settings(S& settings) : root_settings(settings), settings(settings) { } diff --git a/cmake/FindLIBUSB.cmake b/cmake/FindLIBUSB.cmake index 169f594..ab0d303 100644 --- a/cmake/FindLIBUSB.cmake +++ b/cmake/FindLIBUSB.cmake @@ -8,22 +8,52 @@ # # Redistribution and use is allowed according to the terms of the BSD license. # For details see the accompanying COPYING-CMAKE-SCRIPTS file. + +# Set LIBUSB_ROOT if specified +if (LIBUSB_ROOT) + set(ENV{LIBUSB_ROOT} ${LIBUSB_ROOT}) +endif() + if (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) # in cache already set(LIBUSB_FOUND TRUE) else (LIBUSB_INCLUDE_DIR AND LIBUSB_LIBRARIES) - IF (NOT MSVC) - # use pkg-config to get the directories and then use these values - # in the FIND_PATH() and FIND_LIBRARY() calls - find_package(PkgConfig) + # use pkg-config to get the directories and then use these values + # in the find_path() and find_library() calls. Might fail, pkg-config + # might not be installed, e.g. for Windows systems + find_package(PkgConfig) + + if (PKG_CONFIG_FOUND) pkg_check_modules(PC_LIBUSB libusb-1.0) - ENDIF () - FIND_PATH(LIBUSB_INCLUDE_DIR libusb.h - HINTS $ENV{LIBUSB_ROOT}/include/libusb-1.0 - PATHS ${PC_LIBUSB_INCLUDEDIR} ${PC_LIBUSB_INCLUDE_DIRS}) - FIND_LIBRARY(LIBUSB_LIBRARIES NAMES libusb-1.0 usb-1.0 usb - HINTS $ENV{LIBUSB_ROOT}/VS2019/MS32/static - PATHS ${PC_LIBUSB_LIBDIR} ${PC_LIBUSB_LIBRARY_DIRS}) + else () + # As the pkg-config was not found we are probably building under windows. + # Determine the architecture of the host, to choose right library + if (NOT DEFINED ARCHITECTURE) + if (CMAKE_SIZEOF_VOID_P GREATER 4) + set(ARCHITECTURE 64) + else() + set(ARCHITECTURE 32) + endif() + endif() + + set(PC_LIBUSB_INCLUDEDIR_HINT $ENV{LIBUSB_ROOT}/include) + + if (MINGW OR CYGWIN) + set(PC_LIBUSB_LIBDIR_HINT $ENV{LIBUSB_ROOT}/MinGW${ARCHITECTURE}/static) + elseif(MSVC) + set(PC_LIBUSB_LIBDIR_HINT $ENV{LIBUSB_ROOT}/VS2019/MS${ARCHITECTURE}/static) + endif () + endif () + + find_path(LIBUSB_INCLUDE_DIR libusb.h + HINTS ${PC_LIBUSB_INCLUDEDIR_HINT} + PATHS ${PC_LIBUSB_INCLUDEDIR} ${PC_LIBUSB_INCLUDE_DIRS} + PATH_SUFFIXES libusb-1.0) + + find_library(LIBUSB_LIBRARIES NAMES libusb-1.0 usb-1.0 usb + HINTS ${PC_LIBUSB_LIBDIR_HINT} + PATHS ${PC_LIBUSB_LIBDIR} ${PC_LIBUSB_LIBRARY_DIRS}) + include(FindPackageHandleStandardArgs) FIND_PACKAGE_HANDLE_STANDARD_ARGS(LIBUSB DEFAULT_MSG LIBUSB_LIBRARIES LIBUSB_INCLUDE_DIR) MARK_AS_ADVANCED(LIBUSB_INCLUDE_DIR LIBUSB_LIBRARIES) diff --git a/cmake/bin.template.h b/cmake/bin.template.h new file mode 100644 index 0000000..99d2a90 --- /dev/null +++ b/cmake/bin.template.h @@ -0,0 +1,5 @@ +#include + +const unsigned char @C_NAME@[] = {@FILE_CONTENT@}; + +const size_t @C_NAME@_SIZE = @BIN_LENGTH@; diff --git a/cmake/binh.cmake b/cmake/binh.cmake new file mode 100644 index 0000000..6a80f49 --- /dev/null +++ b/cmake/binh.cmake @@ -0,0 +1,28 @@ +file(READ ${BINARY_FILE} FILE_CONTENT HEX) +string(LENGTH ${FILE_CONTENT} FILE_CONTENT_LENGTH) +math(EXPR BIN_LENGTH "${FILE_CONTENT_LENGTH} / 2") + +math(EXPR offset "0") + +while(FILE_CONTENT_LENGTH GREATER 0) + + if(FILE_CONTENT_LENGTH GREATER 32) + math(EXPR length "32") + else() + math(EXPR length "${FILE_CONTENT_LENGTH}") + endif() + + string(SUBSTRING ${FILE_CONTENT} ${offset} ${length} line) + set(lines "${lines}\n${line}") + + math(EXPR FILE_CONTENT_LENGTH "${FILE_CONTENT_LENGTH} - ${length}") + math(EXPR offset "${offset} + ${length}") +endwhile() + +set(FILE_CONTENT "${lines}") + +# adds '0x' prefix and comma suffix before and after every byte respectively +string(REGEX REPLACE "([0-9a-f][0-9a-f])" "0x\\1, " FILE_CONTENT ${FILE_CONTENT}) +string(MAKE_C_IDENTIFIER "${OUTPUT_NAME}" C_NAME) + +configure_file(${CMAKE_CURRENT_LIST_DIR}/bin.template.h ${CMAKE_CURRENT_BINARY_DIR}/${OUTPUT_NAME}.h @ONLY) diff --git a/cmake/jsonh.cmake b/cmake/jsonh.cmake new file mode 100644 index 0000000..b36ff0c --- /dev/null +++ b/cmake/jsonh.cmake @@ -0,0 +1,2 @@ +file(READ ${GENERATED_JSON} FILE_CONTENT) +configure_file(${CMAKE_CURRENT_LIST_DIR}/rp2350.json.template.h ${CMAKE_CURRENT_BINARY_DIR}/rp2350.json.h @ONLY) diff --git a/cmake/picotoolConfig.cmake b/cmake/picotoolConfig.cmake new file mode 100644 index 0000000..5fe5a37 --- /dev/null +++ b/cmake/picotoolConfig.cmake @@ -0,0 +1,3 @@ +if (NOT TARGET picotool) + include("${CMAKE_CURRENT_LIST_DIR}/picotoolTargets.cmake") +endif() diff --git a/cmake/rp2350.json.template.h b/cmake/rp2350.json.template.h new file mode 100644 index 0000000..e912877 --- /dev/null +++ b/cmake/rp2350.json.template.h @@ -0,0 +1,6 @@ + +#include + +const std::string rp2350_json = R"""( +@FILE_CONTENT@ +)"""; diff --git a/data_locs.h b/data_locs.h new file mode 100644 index 0000000..178d9e3 --- /dev/null +++ b/data_locs.h @@ -0,0 +1,5 @@ +#pragma once +#include +#include + +extern std::vector data_locs; diff --git a/data_locs.template.cpp b/data_locs.template.cpp new file mode 100644 index 0000000..dde4481 --- /dev/null +++ b/data_locs.template.cpp @@ -0,0 +1,7 @@ + +#include +#include + +std::vector data_locs = { + "${DATA_LOCS_VEC}" +}; diff --git a/default-pt.json b/default-pt.json new file mode 100644 index 0000000..b057d7a --- /dev/null +++ b/default-pt.json @@ -0,0 +1,36 @@ +{ + "version": [1, 0], + "unpartitioned": { + "families": ["absolute"], + "permissions": { + "secure": "rw", + "nonsecure": "rw", + "bootloader": "rw" + } + }, + "partitions": [ + { + "name": "A", + "id": 0, + "size": "2044K", + "families": ["rp2350-arm-s", "rp2350-riscv"], + "permissions": { + "secure": "rw", + "nonsecure": "rw", + "bootloader": "rw" + } + }, + { + "name": "B", + "id": 1, + "size": "2044K", + "families": ["rp2350-arm-s", "rp2350-riscv"], + "permissions": { + "secure": "rw", + "nonsecure": "rw", + "bootloader": "rw" + }, + "link": ["a", 0] + } + ] +} \ No newline at end of file diff --git a/elf.h b/elf.h deleted file mode 100644 index 32e3dbb..0000000 --- a/elf.h +++ /dev/null @@ -1,60 +0,0 @@ -/* - * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. - * - * SPDX-License-Identifier: BSD-3-Clause - */ - -#ifndef _ELF_H -#define _ELF_H - -#include - -#define ELF_MAGIC 0x464c457fu - -#define EM_ARM 0x28u - -#define EF_ARM_ABI_FLOAT_HARD 0x00000400u - -#define PT_LOAD 0x00000001u - -#pragma pack(push, 1) -struct elf_header { - uint32_t magic; - uint8_t arch_class; - uint8_t endianness; - uint8_t version; - uint8_t abi; - uint8_t abi_version; - uint8_t _pad[7]; - uint16_t type; - uint16_t machine; - uint32_t version2; -}; - -struct elf32_header { - struct elf_header common; - uint32_t entry; - uint32_t ph_offset; - uint32_t sh_offset; - uint32_t flags; - uint16_t eh_size; - uint16_t ph_entry_size; - uint16_t ph_num; - uint16_t sh_entry_size; - uint16_t sh_num; - uint16_t sh_str_index; -}; - -struct elf32_ph_entry { - uint32_t type; - uint32_t offset; - uint32_t vaddr; - uint32_t paddr; - uint32_t filez; - uint32_t memsz; - uint32_t flags; - uint32_t align; -}; -#pragma pack(pop) - -#endif \ No newline at end of file diff --git a/elf/BUILD.bazel b/elf/BUILD.bazel new file mode 100644 index 0000000..46ed049 --- /dev/null +++ b/elf/BUILD.bazel @@ -0,0 +1,20 @@ +package(default_visibility = ["//visibility:public"]) + +cc_library( + name = "elf", + srcs = ["elf_file.cpp"], + hdrs = [ + "addresses.h", + "elf.h", + "elf_file.h", + "portable_endian.h", + ], + copts = select({ + "@platforms//os:windows": [], + "//conditions:default": [ + "-Wno-unused-function", + ], + }), + includes = ["."], + deps = ["//errors"], +) diff --git a/elf/CMakeLists.txt b/elf/CMakeLists.txt new file mode 100644 index 0000000..f783376 --- /dev/null +++ b/elf/CMakeLists.txt @@ -0,0 +1,6 @@ +add_library(elf STATIC + elf_file.cpp) + +target_include_directories(elf PUBLIC ${CMAKE_CURRENT_LIST_DIR}) + +target_link_libraries(elf PRIVATE errors) diff --git a/elf/addresses.h b/elf/addresses.h new file mode 100644 index 0000000..d8926f0 --- /dev/null +++ b/elf/addresses.h @@ -0,0 +1,94 @@ +#ifndef _ADDRESSES_H +#define _ADDRESSES_H + +#define ROM_START 0x00000000 // same as ROM_BASE in addressmap.h +#define ROM_END_RP2040 0x00004000 +#define ROM_END_RP2350 0x00008000 +// todo amy based on what sort of elf (also this breaks RP2040 builds?) +#define FLASH_START 0x10000000 // same as XIP_MAIN_BASE in addressmap.h +#define FLASH_END_RP2040 0x11000000 // +32 MiB -- remainder has no external devices mapped +#define FLASH_END_RP2350 0x12000000 // +32 MiB -- remainder has no external devices mapped +// todo amy based on what sort of elf +#define XIP_SRAM_START_RP2040 0x15000000 +#define XIP_SRAM_END_RP2040 0x15004000 +#define XIP_SRAM_START_RP2350 0x13ffc000 // same as XIP_SRAM_BASE in addressmap.h +#define XIP_SRAM_END_RP2350 0x14000000 // same as XIP_SRAM_END in addressmap.h + +#define SRAM_START 0x20000000 // same as SRAM_BASE in addressmap.h +#define SRAM_END_RP2040 0x20042000 +#define SRAM_END_RP2350 0x20082000 +// todo amy no more banked alias +#define MAIN_RAM_BANKED_START 0x21000000 +#define MAIN_RAM_BANKED_END 0x21040000 + + +#ifdef __cplusplus + +#include +#include + +#ifdef _WIN32 +#undef IGNORE +#endif + +// Address ranges for RP2040/RP2350 +struct address_range { + enum type { + CONTENTS, // may have contents + NO_CONTENTS, // must be uninitialized + IGNORE // will be ignored + }; + address_range(uint32_t from, uint32_t to, type type) : from(from), to(to), type(type) {} + address_range() : address_range(0, 0, IGNORE) {} + uint32_t from; + uint32_t to; + type type; +}; + +typedef std::vector address_ranges; + + +const address_ranges rp2040_address_ranges_flash { + address_range(FLASH_START, FLASH_END_RP2040, address_range::type::CONTENTS), + address_range(SRAM_START, SRAM_END_RP2040, address_range::type::NO_CONTENTS), + address_range(MAIN_RAM_BANKED_START, MAIN_RAM_BANKED_END, address_range::type::NO_CONTENTS) +}; + +const address_ranges rp2040_address_ranges_ram { + address_range(SRAM_START, SRAM_END_RP2040, address_range::type::CONTENTS), + address_range(XIP_SRAM_START_RP2040, XIP_SRAM_END_RP2040, address_range::type::CONTENTS), + address_range(ROM_START, ROM_END_RP2040, address_range::type::IGNORE) // for now we ignore the bootrom if present +}; + +const address_ranges rp2350_address_ranges_flash { + address_range(FLASH_START, FLASH_END_RP2350, address_range::type::CONTENTS), + address_range(SRAM_START, SRAM_END_RP2350, address_range::type::NO_CONTENTS), + address_range(MAIN_RAM_BANKED_START, MAIN_RAM_BANKED_END, address_range::type::NO_CONTENTS) +}; + +const address_ranges rp2350_address_ranges_ram { + address_range(SRAM_START, SRAM_END_RP2350, address_range::type::CONTENTS), + address_range(XIP_SRAM_START_RP2350, XIP_SRAM_END_RP2350, address_range::type::CONTENTS), + address_range(ROM_START, ROM_END_RP2350, address_range::type::IGNORE) // for now we ignore the bootrom if present +}; + +static bool is_address_valid(const address_ranges& valid_ranges, uint32_t addr) { + for(const auto& range : valid_ranges) { + if (range.from <= addr && range.to > addr) { + return true; + } + } + return false; +} + +static bool is_address_initialized(const address_ranges& valid_ranges, uint32_t addr) { + for(const auto& range : valid_ranges) { + if (range.from <= addr && range.to > addr) { + return address_range::type::CONTENTS == range.type; + } + } + return false; +} + +#endif +#endif diff --git a/elf/elf.h b/elf/elf.h new file mode 100644 index 0000000..ff5d3de --- /dev/null +++ b/elf/elf.h @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +#ifndef _ELF_H +#define _ELF_H + +#include + +#define ELF_MAGIC 0x464c457fu + +#define EM_ARM 0x28u +#define EM_RISCV 0xf3u + +#define EF_ARM_ABI_FLOAT_HARD 0x00000400u + +#define PT_LOAD 0x00000001u + +#define PF_X 0x1u +#define PF_W 0x2u +#define PF_R 0x4u + +#define SHT_NULL 0x00000000u +#define SHT_PROGBITS 0x00000001u +#define SHT_NOBITS 0x00000008u +#define SHF_ALLOC 0x00000002u + +#ifdef __cplusplus +#include +#include +#endif + +#pragma pack(push, 1) +struct elf_header { + uint32_t magic; + uint8_t arch_class; + uint8_t endianness; + uint8_t version; + uint8_t abi; + uint8_t abi_version; + uint8_t _pad[7]; + uint16_t type; + uint16_t machine; + uint32_t version2; +}; + +struct elf32_header { + struct elf_header common; + uint32_t entry; + uint32_t ph_offset; + uint32_t sh_offset; + uint32_t flags; + uint16_t eh_size; + uint16_t ph_entry_size; + uint16_t ph_num; + uint16_t sh_entry_size; + uint16_t sh_num; + uint16_t sh_str_index; +}; + +struct elf32_ph_entry { +#ifdef __cplusplus + uint32_t physical_address(void) const {return paddr;}; + uint32_t physical_size(void) const {return filez;}; + uint32_t virtual_address(void) const {return vaddr;}; + uint32_t virtual_size(void) const {return memsz;}; + bool is_load(void) const {return type == 0x1;}; +#endif + uint32_t type; + uint32_t offset; + uint32_t vaddr; + uint32_t paddr; + uint32_t filez; + uint32_t memsz; + uint32_t flags; + uint32_t align; +}; + +#ifdef __cplusplus +typedef elf32_ph_entry Segment; +inline std::string to_string(const elf32_ph_entry &ph) { + std::stringstream ss; + ss << "segment paddr " << std::hex << ph.paddr << " vaddr " << std::hex << ph.vaddr; + return ss.str(); +} +#endif + +struct elf32_sh_entry { +#ifdef __cplusplus + uint32_t virtual_address(void) const {return addr;}; +#endif + uint32_t name; + uint32_t type; + uint32_t flags; + uint32_t addr; + uint32_t offset; + uint32_t size; + uint32_t link; + uint32_t info; + uint32_t addralign; + uint32_t entsize; +}; + +#ifdef __cplusplus +typedef elf32_sh_entry Section; +inline std::string to_string(const elf32_sh_entry &sh) { + std::stringstream ss; + ss << std::hex << sh.addr; + return ss.str(); +} +#endif + +struct elf32_sym_entry { + uint32_t name; + uint32_t value; + uint32_t size; + uint8_t info; + uint8_t other; + uint16_t shndx; +}; + +#pragma pack(pop) + +#endif \ No newline at end of file diff --git a/elf/elf_file.cpp b/elf/elf_file.cpp new file mode 100644 index 0000000..436e8fe --- /dev/null +++ b/elf/elf_file.cpp @@ -0,0 +1,520 @@ +/* + * Copyright (c) 2024 Raspberry Pi (Trading) Ltd. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "elf.h" +#include "elf_file.h" +#include "errors.h" + +#include "portable_endian.h" + +// tsk namespace is polluted on windows +#ifdef _WIN32 +#undef min +#undef max + +#define _CRT_SECURE_NO_WARNINGS +#endif + +void eh_he(elf32_header &eh) { + // Swap to host endianness + eh.common.magic = le32toh(eh.common.magic); + eh.common.type = le16toh(eh.common.type); + eh.common.machine = le16toh(eh.common.machine); + eh.common.version2 = le32toh(eh.common.version2); + eh.entry = le32toh(eh.entry); + eh.ph_offset = le32toh(eh.ph_offset); + eh.sh_offset = le32toh(eh.sh_offset); + eh.flags = le32toh(eh.flags); + eh.eh_size = le16toh(eh.eh_size); + eh.ph_entry_size = le16toh(eh.ph_entry_size); + eh.ph_num = le16toh(eh.ph_num); + eh.sh_entry_size = le16toh(eh.sh_entry_size); + eh.sh_num = le16toh(eh.sh_num); + eh.sh_str_index = le16toh(eh.sh_str_index); +} +void eh_le(elf32_header &eh) { + // Swap to little endianness + eh.common.magic = htole32(eh.common.magic); + eh.common.type = htole16(eh.common.type); + eh.common.machine = htole16(eh.common.machine); + eh.common.version2 = htole32(eh.common.version2); + eh.entry = htole32(eh.entry); + eh.ph_offset = htole32(eh.ph_offset); + eh.sh_offset = htole32(eh.sh_offset); + eh.flags = htole32(eh.flags); + eh.eh_size = htole16(eh.eh_size); + eh.ph_entry_size = htole16(eh.ph_entry_size); + eh.ph_num = htole16(eh.ph_num); + eh.sh_entry_size = htole16(eh.sh_entry_size); + eh.sh_num = htole16(eh.sh_num); + eh.sh_str_index = htole16(eh.sh_str_index); +} +void ph_he(elf32_ph_entry &ph) { + // Swap to host endianness + ph.type = le32toh(ph.type); + ph.offset = le32toh(ph.offset); + ph.vaddr = le32toh(ph.vaddr); + ph.paddr = le32toh(ph.paddr); + ph.filez = le32toh(ph.filez); + ph.memsz = le32toh(ph.memsz); + ph.flags = le32toh(ph.flags); + ph.align = le32toh(ph.align); +} +void ph_le(elf32_ph_entry &ph) { + // Swap to little endianness + ph.type = htole32(ph.type); + ph.offset = htole32(ph.offset); + ph.vaddr = htole32(ph.vaddr); + ph.paddr = htole32(ph.paddr); + ph.filez = htole32(ph.filez); + ph.memsz = htole32(ph.memsz); + ph.flags = htole32(ph.flags); + ph.align = htole32(ph.align); +} +void sh_he(elf32_sh_entry &sh) { + // Swap to host endianness + sh.name = le32toh(sh.name); + sh.type = le32toh(sh.type); + sh.flags = le32toh(sh.flags); + sh.addr = le32toh(sh.addr); + sh.offset = le32toh(sh.offset); + sh.size = le32toh(sh.size); + sh.link = le32toh(sh.link); + sh.info = le32toh(sh.info); + sh.addralign = le32toh(sh.addralign); + sh.entsize = le32toh(sh.entsize); +} +void sh_le(elf32_sh_entry &sh) { + // Swap to little endianness + sh.name = htole32(sh.name); + sh.type = htole32(sh.type); + sh.flags = htole32(sh.flags); + sh.addr = htole32(sh.addr); + sh.offset = htole32(sh.offset); + sh.size = htole32(sh.size); + sh.link = htole32(sh.link); + sh.info = htole32(sh.info); + sh.addralign = htole32(sh.addralign); + sh.entsize = htole32(sh.entsize); +} +void sym_he(elf32_sym_entry &sym) { + // Swap to host endianness + sym.name = le32toh(sym.name); + sym.value = le32toh(sym.value); + sym.size = le32toh(sym.size); + sym.info = le32toh(sym.info); + sym.other = le32toh(sym.other); + sym.shndx = le32toh(sym.shndx); +} +void sym_le(elf32_sym_entry &sym) { + // Swap to little endianness + sym.name = htole32(sym.name); + sym.value = htole32(sym.value); + sym.size = htole32(sym.size); + sym.info = htole32(sym.info); + sym.other = htole32(sym.other); + sym.shndx = htole32(sym.shndx); +} + +// Checks whether an ELF header is compatible with RP2040 / RP3050 +// Returns zero on success +int rp_check_elf_header(const elf32_header &eh) { + if (eh.common.magic != ELF_MAGIC) { + fail(ERROR_FORMAT, "Not an ELF file"); + } + if (eh.common.version != 1 || eh.common.version2 != 1) { + fail(ERROR_FORMAT, "Unrecognized ELF version"); + } + if (eh.common.arch_class != 1 || eh.common.endianness != 1) { + fail(ERROR_INCOMPATIBLE, "Require 32 bit little-endian ELF"); + } + if (eh.eh_size != sizeof(struct elf32_header)) { + fail(ERROR_FORMAT, "Invalid ELF32 format"); + } + if (eh.common.machine != EM_ARM && eh.common.machine != EM_RISCV) { + fail(ERROR_FORMAT, "Not an Arm or RISC-V executable"); + } + if (eh.common.abi != 0) { + fail(ERROR_INCOMPATIBLE, "Unrecognized ABI"); + } + // todo amy not sure if this should be expected or not - we have HARD float in clang only for now + if (eh.flags & EF_ARM_ABI_FLOAT_HARD) { +// fail(ERROR_INCOMPATIBLE, "HARD-FLOAT not supported"); + } + return 0; +} + +// Determine binary type (flash or ram) +int rp_determine_binary_type(const elf32_header &eh, const std::vector& entries, address_ranges flash_range, address_ranges ram_range, bool *ram_style) { + for(const auto &entry : entries) { + if (entry.type == PT_LOAD && entry.memsz) { + unsigned int mapped_size = std::min(entry.filez, entry.memsz); + if (mapped_size) { + // we back convert the entrypoint from a VADDR to a PADDR to see if it originates in flash, and if + // so call THAT a flash binary. + if (eh.entry >= entry.vaddr && eh.entry < entry.vaddr + mapped_size) { + uint32_t effective_entry = eh.entry + entry.paddr - entry.vaddr; + if (is_address_initialized(ram_range, effective_entry)) { + *ram_style = true; + return 0; + } else if (is_address_initialized(flash_range, effective_entry)) { + *ram_style = false; + return 0; + } + } + } + } + } + fail(ERROR_INCOMPATIBLE, "entry point is not in mapped part of file"); + return ERROR_INCOMPATIBLE; +} + +void elf_file::read_bytes(unsigned offset, unsigned length, void *dest) { + if (offset + length > elf_bytes.size()) { + fail(ERROR_FORMAT, "ELF File Read from 0x%x with size 0x%x exceeds the file size 0x%x", offset, length, elf_bytes.size()); + } + memcpy(dest, &elf_bytes[offset], length); +} + +int elf_file::read_header(void) { + read_bytes(0, sizeof(eh), &eh); + eh_he(eh); // swap to Host for processing + return rp_check_elf_header(eh); +} + +// Flattens the data in the section array the elf_bytes blob +void elf_file::flatten(void) { + elf_bytes.resize(sizeof(eh)); + auto eh_out = eh; + eh_le(eh_out); // swap to LE for writing + memcpy(&elf_bytes[0], &eh_out, sizeof(eh_out)); + + elf_bytes.resize(std::max(eh.ph_offset + sizeof(elf32_ph_entry) * eh.ph_num, elf_bytes.size())); + auto ph_entries_out = ph_entries; + for (auto ph : ph_entries_out) { + ph_le(ph); // swap to LE for writing + } + memcpy(&elf_bytes[eh.ph_offset], &ph_entries_out[0], sizeof(elf32_ph_entry) * eh.ph_num); + + elf_bytes.resize(std::max(eh.sh_offset + sizeof(elf32_sh_entry) * eh.sh_num, elf_bytes.size())); + auto sh_entries_out = sh_entries; + for (auto sh : sh_entries_out) { + sh_le(sh); // swap to LE for writing + } + memcpy(&elf_bytes[eh.sh_offset], &sh_entries_out[0], sizeof(elf32_sh_entry) * eh.sh_num); + + int idx = 0; + for (const auto &sh : sh_entries) { + if (sh.size && sh.type != SHT_NOBITS) { + elf_bytes.resize(std::max(sh.offset + sh.size, (uint32_t)elf_bytes.size())); + memcpy(&elf_bytes[sh.offset], &sh_data[idx][0], sh.size); + } + idx++; + } + if (verbose) printf("Elf file size %zu\n", elf_bytes.size()); +} + +void elf_file::write(std::shared_ptr out) { + flatten(); + out->exceptions(std::iostream::failbit | std::iostream::badbit); + if (verbose) printf("Writing %lu bytes to file\n", elf_bytes.size()); + out->write(reinterpret_cast(&elf_bytes[0]), elf_bytes.size()); +} + +void elf_file::read_sh(void) { + if (verbose) printf("%s sh offset %u #entries %d\n", __func__, eh.sh_offset, eh.sh_num); + if (eh.sh_num) { + sh_entries.resize(eh.sh_num); + read_bytes(eh.sh_offset, sizeof(elf32_sh_entry) * eh.sh_num, &sh_entries[0]); + for (auto sh : sh_entries) { + sh_he(sh); // swap to Host for processing + } + } +} + +// Read the section data from the internal byte array into discrete sections. +// This is used after modifying segments but before inserting new segments +void elf_file::read_sh_data(void) { + int sh_idx = 0; + sh_data.resize(eh.sh_num); + for (const auto &sh: sh_entries) { + if (sh.size && sh.type != SHT_NOBITS) { + sh_data[sh_idx].resize(sh.size); + read_bytes(sh.offset, sh.size, &sh_data[sh_idx][0]); + } + sh_idx++; + } +} + +const std::string elf_file::section_name(uint32_t sh_name) const { + if (!eh.sh_str_index || eh.sh_str_index > eh.sh_num) + return ""; + + if (sh_name > sh_data[eh.sh_str_index].size()) + return ""; + + const char * str =(const char *) &sh_data[eh.sh_str_index][0]; + return &str[sh_name]; +} + +const elf32_sh_entry* elf_file::get_section(const std::string &sh_name) { + for (unsigned int i = 0; i < sh_entries.size(); i++) { + if (section_name(sh_entries[i].name) == sh_name) { + return &sh_entries[i]; + } + } + return NULL; +} + +uint32_t elf_file::get_symbol(const std::string &sym_name) { + auto sym_tab = get_section(".symtab"); + auto str_tab = get_section(".strtab"); + if (!sym_tab || !str_tab) { + return 0; + } + auto data = content(*sym_tab); + auto strings = content(*str_tab); + const char * str =(const char *) strings.data(); + for (unsigned int i=0; i < sym_tab->size / sizeof(elf32_sym_entry); i++) { + elf32_sym_entry sym; + memcpy(&sym, data.data() + i*sizeof(elf32_sym_entry), sizeof(elf32_sym_entry)); + sym_he(sym); // swap to Host for processing + if (&str[sym.name] == sym_name) { + return sym.value; + } + } + return 0; +} + +uint32_t elf_file::append_section_name(const std::string &sh_name_str) { + // Create byte array with new section name + std::vector name_bytes(sh_name_str.begin(), sh_name_str.end()); + name_bytes.push_back(0); + + // Append the byte array to section header table remembering the offset + // of the start of the string for the new section + elf32_sh_entry &shstrtab = sh_entries[eh.sh_str_index]; + std::vector &shstrtab_data = sh_data[eh.sh_str_index]; + sh_entries[eh.sh_str_index].size += name_bytes.size(); + uint32_t sh_name = shstrtab_data.size(); + shstrtab_data.insert(shstrtab_data.end(), name_bytes.begin(), name_bytes.end()); + + // Move offsets for anything stored after the resized section header table + for (auto &sh: sh_entries) { + if (sh.offset > shstrtab.offset) + sh.offset += name_bytes.size(); + } + for (auto &ph: ph_entries) { + if (ph.offset > shstrtab.offset) + ph.offset += name_bytes.size(); + } + return sh_name; +} + +void elf_file::dump(void) const { + for (const auto &ph: ph_entries) { + printf("PH offset %08x vaddr %08x paddr %08x size %08x type %08x\n", + ph.offset, ph.vaddr, ph.paddr, ph.memsz, ph.type); + } + + int sh_idx = 0; + for (const auto &sh: sh_entries) { + printf("SH[%d] %20s addr %08x offset %08x size %08x type %08x\n", + sh_idx, section_name(sh.name).c_str(), sh.addr, sh.offset, sh.size, sh.type); + sh_idx++; + } +} + +void elf_file::move_all(int dist) { + if (verbose) printf("Incrementing all paddr by %d\n", dist); + for (auto &ph: ph_entries) { + ph.paddr += dist; + } +} + +void elf_file::read_ph(void) { + if (verbose) printf("%s ph offset %u #entries %d\n", __func__, eh.ph_offset, eh.ph_num); + if (eh.ph_num) { + ph_entries.resize(eh.ph_num); + read_bytes(eh.ph_offset, sizeof(elf32_ph_entry) * eh.ph_num, &ph_entries[0]); + for (auto ph : ph_entries) { + ph_he(ph); // swap to Host for processing + } + } +} + +int elf_file::read_file(std::shared_ptr file) { + int rc = 0; + try { + elf_bytes = read_binfile(file); + int rc = read_header(); + if (!rc) { + read_ph(); + read_sh(); + } + read_sh_data(); + } + catch (const std::ios_base::failure &e) { + std::cerr << "Failed to read elf file" << std::endl; + rc = -1; + } + return rc; +} + +uint32_t elf_file::lowest_section_offset(void) const { + uint32_t offset = eh.sh_offset; // Section header offset is after the data + for (const auto &sh: sh_entries) { + if (sh.type != SHT_NULL && sh.offset > 0 && sh.offset < offset) { + offset = sh.offset; + } + } + return offset; +} + +uint32_t elf_file::highest_section_offset(void) const { + uint32_t offset = 0; // Section header offset is after the data + for (const auto &sh: sh_entries) { + if (sh.type != SHT_NULL && sh.offset > 0 && sh.offset >= offset) { + offset = sh.offset + sh.size; + } + } + return offset; +} + +std::vector elf_file::content(const elf32_ph_entry &ph) const { + std::vector content; + std::copy(elf_bytes.begin() + ph.offset, elf_bytes.begin() + ph.offset + ph.filez, std::back_inserter(content)); + return content; +} + +std::vector elf_file::content(const elf32_sh_entry &sh) const { + std::vector content; + std::copy(elf_bytes.begin() + sh.offset, elf_bytes.begin() + sh.offset + sh.size, std::back_inserter(content)); + return content; +} + +void elf_file::content(const elf32_ph_entry &ph, const std::vector &content) { + if (!editable) return; + assert(content.size() <= ph.filez); + if (verbose) printf("Update segment content offset %x content size %zx physical size %x\n", ph.offset, content.size(), ph.filez); + memcpy(&elf_bytes[ph.offset], &content[0], std::min(content.size(), (size_t) ph.filez)); + read_sh_data(); // Extract the sections after modifying the content +} + +void elf_file::content(const elf32_sh_entry &sh, const std::vector &content) { + if (!editable) return; + assert(content.size() <= sh.size); + if (verbose) printf("Update section content offset %x content size %zx section size %x\n", sh.offset, content.size(), sh.size); + memcpy(&elf_bytes[sh.offset], &content[0], std::min(content.size(), (size_t) sh.size)); + read_sh_data(); // Extract the sections after modifying the content +} + +const elf32_ph_entry* elf_file::segment_from_physical_address(uint32_t paddr) { + for (int i = 0; i < eh.ph_num; i++) { + if (paddr >= ph_entries[i].paddr && paddr < ph_entries[i].paddr + ph_entries[i].filez) { + if (verbose) printf("segment %d contains physical address %x\n", i, paddr); + return &ph_entries[i]; + } + } + return nullptr; +} + +const elf32_ph_entry* elf_file::segment_from_virtual_address(uint32_t vaddr) { + for (int i = 0; i < eh.ph_num; i++) { + if (vaddr >= ph_entries[i].vaddr && vaddr < ph_entries[i].vaddr + ph_entries[i].memsz) { + if (verbose) printf("segment %d contains virtual address %x\n", i, vaddr); + return &ph_entries[i]; + } + } + return NULL; +} + +// Appends a new segment and section - filled with zeros +// Use content to replace the content +const elf32_ph_entry& elf_file::append_segment(uint32_t vaddr, uint32_t paddr, uint32_t size, const std::string &name) { + elf32_ph_entry ph; + read_sh_data(); // Convert the section data back into discreet chunks + uint32_t sh_name = append_section_name(name); + + ph.type = PT_LOAD; + ph.flags = PF_R; // Readable segment + ph.paddr = paddr; + ph.vaddr = vaddr; + ph.filez = size; + ph.memsz = size; + ph.align = 2; + + if (verbose) { + std::cout << "new segment " << name << + " paddr " << std::hex << paddr << + " vaddr " << std::hex << vaddr << + " size " << std::hex << size << std::endl; + } + ph_entries.push_back(ph); + eh.ph_num++; + + // There's normally space between the end of the program header table and the start of data to + // squeeze in another program header. If not, shuffle everything by 4K; + uint32_t lso = lowest_section_offset(); + if (lso < eh.ph_offset + eh.ph_entry_size * eh.ph_num) { + + // Move the segment offsets + for (auto &ph: ph_entries) { + ph.offset += 0x1000; + } + + // Move section header table and each section offset + eh.sh_offset += 0x1000; + for (auto &sh : sh_entries) { + sh.offset += 0x1000; + } + } + + // Append the new signature section + elf32_sh_entry sh = {}; + sh.name = sh_name; + sh.type = SHT_PROGBITS; + sh.flags = SHF_ALLOC; + sh.addr = ph.vaddr; + sh.size = size; + uint32_t hso = highest_section_offset(); + sh.offset = hso; + + // Add the new segment for the signature and point to offset in file for data + sh_entries.push_back(sh); + sh_data.push_back(std::vector(size)); + ph_entries.back().offset = sh.offset; + + eh.sh_offset = sh.offset + sh.size; + eh.sh_num++; + + if (verbose) printf("%s sig offset %08x num sections %u\n", __func__, sh.offset, eh.sh_num); + flatten(); + return ph_entries.back(); +} + + std::vector elf_file::read_binfile(std::shared_ptr in) { + std::vector data; + in->exceptions(std::iostream::failbit | std::iostream::badbit); + in->seekg(0, in->end); + data.resize(in->tellg()); + in->seekg(0, in->beg); + in->read(reinterpret_cast(&data[0]), data.size()); + return data; +} diff --git a/elf/elf_file.h b/elf/elf_file.h new file mode 100644 index 0000000..03b3364 --- /dev/null +++ b/elf/elf_file.h @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2024 Raspberry Pi (Trading) Ltd. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +#ifndef ELF_FILE_H +#define ELF_FILE_H + +#include +#include +#include +#include +#include +#include +#include +#include +#include "elf.h" + +#include "addresses.h" + +class elf_file { +public: + elf_file(bool verbose = false) : verbose(verbose) {}; + int read_file(std::shared_ptr file); + void write(std::shared_ptr file); + + const elf32_ph_entry& append_segment(uint32_t vaddr, uint32_t paddr, uint32_t size, const std::string §ion_name); + + const elf32_header &header(void) const {return eh;} + const std::vector &segments(void) const {return ph_entries;} + const std::vector §ions(void) const {return sh_entries;} + + std::vector content(const elf32_ph_entry &ph) const; + std::vector content(const elf32_sh_entry &sh) const; + void content(const elf32_ph_entry &ph, const std::vector &content); + void content(const elf32_sh_entry &sh, const std::vector &content); + + uint32_t lowest_section_offset(void) const; + uint32_t highest_section_offset(void) const; + const elf32_sh_entry* get_section(const std::string &sh_name); + uint32_t get_symbol(const std::string &sym_name); + const std::string section_name(uint32_t sh_name) const; + const elf32_ph_entry* segment_from_physical_address(uint32_t paddr); + const elf32_ph_entry* segment_from_virtual_address(uint32_t vaddr); + void dump(void) const; + + void move_all(int dist); + + static std::vector read_binfile(std::shared_ptr file); + + bool editable = true; +private: + int read_header(void); + void read_ph(void); + void read_sh(void); + void read_sh_data(void); + void read_bytes(unsigned offset, unsigned length, void *dest); + uint32_t append_section_name(const std::string &sh_name_str); + void flatten(void); + +private: + elf32_header eh; + std::vector elf_bytes; + std::vector ph_entries; + std::vector sh_entries; + std::vector> sh_data; + bool verbose; +}; +int rp_check_elf_header(const elf32_header &eh); +int rp_determine_binary_type(const elf32_header &eh, const std::vector& entries, address_ranges flash_range, address_ranges ram_range, bool *ram_style); +#endif \ No newline at end of file diff --git a/elf/portable_endian.h b/elf/portable_endian.h new file mode 100644 index 0000000..4286f91 --- /dev/null +++ b/elf/portable_endian.h @@ -0,0 +1,172 @@ +// Sourced from https://gist.github.com/panzi/6856583 + +// "License": Public Domain +// I, Mathias Panzenböck, place this file hereby into the public domain. Use it at your own risk for whatever you like. +// In case there are jurisdictions that don't support putting things in the public domain you can also consider it to +// be "dual licensed" under the BSD, MIT and Apache licenses, if you want to. This code is trivial anyway. Consider it +// an example on how to get the endian conversion functions on different platforms. + +#ifndef PORTABLE_ENDIAN_H__ +#define PORTABLE_ENDIAN_H__ + +#if (defined(_WIN16) || defined(_WIN32) || defined(_WIN64)) && !defined(__WINDOWS__) + +# define __WINDOWS__ + +#endif + +#if defined(__linux__) || defined(__CYGWIN__) + +# include + +#elif defined(__APPLE__) + +# include + +# define htobe16(x) OSSwapHostToBigInt16(x) +# define htole16(x) OSSwapHostToLittleInt16(x) +# define be16toh(x) OSSwapBigToHostInt16(x) +# define le16toh(x) OSSwapLittleToHostInt16(x) + +# define htobe32(x) OSSwapHostToBigInt32(x) +# define htole32(x) OSSwapHostToLittleInt32(x) +# define be32toh(x) OSSwapBigToHostInt32(x) +# define le32toh(x) OSSwapLittleToHostInt32(x) + +# define htobe64(x) OSSwapHostToBigInt64(x) +# define htole64(x) OSSwapHostToLittleInt64(x) +# define be64toh(x) OSSwapBigToHostInt64(x) +# define le64toh(x) OSSwapLittleToHostInt64(x) + +# define __BYTE_ORDER BYTE_ORDER +# define __BIG_ENDIAN BIG_ENDIAN +# define __LITTLE_ENDIAN LITTLE_ENDIAN +# define __PDP_ENDIAN PDP_ENDIAN + +#elif defined(__OpenBSD__) + +# include + +# define __BYTE_ORDER BYTE_ORDER +# define __BIG_ENDIAN BIG_ENDIAN +# define __LITTLE_ENDIAN LITTLE_ENDIAN +# define __PDP_ENDIAN PDP_ENDIAN + +#elif defined(__NetBSD__) || defined(__FreeBSD__) || defined(__DragonFly__) + +# include + +# define be16toh(x) betoh16(x) +# define le16toh(x) letoh16(x) + +# define be32toh(x) betoh32(x) +# define le32toh(x) letoh32(x) + +# define be64toh(x) betoh64(x) +# define le64toh(x) letoh64(x) + +#elif defined(__WINDOWS__) + +# include +# ifdef __GNUC__ +# include +# endif + +# if BYTE_ORDER == LITTLE_ENDIAN + +# define htobe16(x) htons(x) +# define htole16(x) (x) +# define be16toh(x) ntohs(x) +# define le16toh(x) (x) + +# define htobe32(x) htonl(x) +# define htole32(x) (x) +# define be32toh(x) ntohl(x) +# define le32toh(x) (x) + +# define htobe64(x) htonll(x) +# define htole64(x) (x) +# define be64toh(x) ntohll(x) +# define le64toh(x) (x) + +# elif BYTE_ORDER == BIG_ENDIAN + + /* that would be xbox 360 */ +# define htobe16(x) (x) +# define htole16(x) __builtin_bswap16(x) +# define be16toh(x) (x) +# define le16toh(x) __builtin_bswap16(x) + +# define htobe32(x) (x) +# define htole32(x) __builtin_bswap32(x) +# define be32toh(x) (x) +# define le32toh(x) __builtin_bswap32(x) + +# define htobe64(x) (x) +# define htole64(x) __builtin_bswap64(x) +# define be64toh(x) (x) +# define le64toh(x) __builtin_bswap64(x) + +# else + +# error byte order not supported + +# endif + +# define __BYTE_ORDER BYTE_ORDER +# define __BIG_ENDIAN BIG_ENDIAN +# define __LITTLE_ENDIAN LITTLE_ENDIAN +# define __PDP_ENDIAN PDP_ENDIAN + +#elif defined(__QNXNTO__) + +# include + +# define __LITTLE_ENDIAN 1234 +# define __BIG_ENDIAN 4321 +# define __PDP_ENDIAN 3412 + +# if defined(__BIGENDIAN__) + +# define __BYTE_ORDER __BIG_ENDIAN + +# define htobe16(x) (x) +# define htobe32(x) (x) +# define htobe64(x) (x) + +# define htole16(x) ENDIAN_SWAP16(x) +# define htole32(x) ENDIAN_SWAP32(x) +# define htole64(x) ENDIAN_SWAP64(x) + +# elif defined(__LITTLEENDIAN__) + +# define __BYTE_ORDER __LITTLE_ENDIAN + +# define htole16(x) (x) +# define htole32(x) (x) +# define htole64(x) (x) + +# define htobe16(x) ENDIAN_SWAP16(x) +# define htobe32(x) ENDIAN_SWAP32(x) +# define htobe64(x) ENDIAN_SWAP64(x) + +# else + +# error byte order not supported + +# endif + +# define be16toh(x) ENDIAN_BE16(x) +# define be32toh(x) ENDIAN_BE32(x) +# define be64toh(x) ENDIAN_BE64(x) +# define le16toh(x) ENDIAN_LE16(x) +# define le32toh(x) ENDIAN_LE32(x) +# define le64toh(x) ENDIAN_LE64(x) + +#else + +# error platform not supported + +#endif + +#endif \ No newline at end of file diff --git a/elf2uf2/BUILD.bazel b/elf2uf2/BUILD.bazel new file mode 100644 index 0000000..ef3288c --- /dev/null +++ b/elf2uf2/BUILD.bazel @@ -0,0 +1,20 @@ +package(default_visibility = ["//visibility:public"]) + +cc_library( + name = "elf2uf2", + srcs = ["elf2uf2.cpp"], + hdrs = ["elf2uf2.h"], + copts = select({ + "@platforms//os:windows": [], + "//conditions:default": [ + "-Wno-unused-function", + "-Wno-unused-variable", + ], + }), + includes = ["."], + deps = [ + "//elf", + "//errors", + "@pico-sdk//src/common/boot_uf2_headers", + ], +) diff --git a/elf2uf2/CMakeLists.txt b/elf2uf2/CMakeLists.txt new file mode 100644 index 0000000..7ced994 --- /dev/null +++ b/elf2uf2/CMakeLists.txt @@ -0,0 +1,6 @@ +add_library(elf2uf2 STATIC + elf2uf2.cpp) + +target_include_directories(elf2uf2 PUBLIC ${CMAKE_CURRENT_LIST_DIR}) + +target_link_libraries(elf2uf2 PRIVATE boot_uf2_headers elf errors) diff --git a/elf2uf2/elf2uf2.cpp b/elf2uf2/elf2uf2.cpp new file mode 100644 index 0000000..5a0e495 --- /dev/null +++ b/elf2uf2/elf2uf2.cpp @@ -0,0 +1,338 @@ +/* + * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "elf2uf2.h" +#include "errors.h" + +#define FLASH_SECTOR_ERASE_SIZE 4096u + +static bool verbose; + +static void fail_read_error() { + fail(ERROR_READ_FAILED, "Failed to read input file"); +} + +static void fail_write_error() { + fail(ERROR_WRITE_FAILED, "Failed to write output file"); +} + +struct page_fragment { + page_fragment(uint32_t file_offset, uint32_t page_offset, uint32_t bytes) : file_offset(file_offset), page_offset(page_offset), bytes(bytes) {} + uint32_t file_offset; + uint32_t page_offset; + uint32_t bytes; +}; + +int check_address_range(const address_ranges& valid_ranges, uint32_t addr, uint32_t vaddr, uint32_t size, bool uninitialized, address_range &ar) { + for(const auto& range : valid_ranges) { + if (range.from <= addr && range.to >= addr + size) { + if (range.type == address_range::type::NO_CONTENTS && !uninitialized) { + fail(ERROR_INCOMPATIBLE, "ELF contains memory contents for uninitialized memory at %p", addr); + } + ar = range; + if (verbose) { + printf("%s segment %08x->%08x (%08x->%08x)\n", uninitialized ? "Uninitialized" : "Mapped", addr, + addr + size, vaddr, vaddr+size); + } + return 0; + } + } + fail(ERROR_INCOMPATIBLE, "Memory segment %08x->%08x is outside of valid address range for device", addr, addr+size); + return ERROR_INCOMPATIBLE; +} + +int check_elf32_ph_entries(const std::vector& entries, const address_ranges& valid_ranges, std::map>& pages) { + for(const auto & entry : entries) { + if (entry.type == PT_LOAD && entry.memsz) { + address_range ar; + int rc; + unsigned int mapped_size = std::min(entry.filez, entry.memsz); + if (mapped_size) { + rc = check_address_range(valid_ranges, entry.paddr, entry.vaddr, mapped_size, false, ar); + if (rc) return rc; + // we don't download uninitialized, generally it is BSS and should be zero-ed by crt0.S, or it may be COPY areas which are undefined + if (ar.type != address_range::type::CONTENTS) { + if (verbose) printf(" ignored\n"); + continue; + } + unsigned int addr = entry.paddr; + unsigned int remaining = mapped_size; + unsigned int file_offset = entry.offset; + while (remaining) { + unsigned int off = addr & (UF2_PAGE_SIZE - 1); + unsigned int len = std::min(remaining, UF2_PAGE_SIZE - off); + auto &fragments = pages[addr - off]; // list of fragments + // note if filesz is zero, we want zero init which is handled because the + // statement above creates an empty page fragment list + // check overlap with any existing fragments + for (const auto &fragment : fragments) { + if ((off < fragment.page_offset + fragment.bytes) != + ((off + len) <= fragment.page_offset)) { + fail(ERROR_FORMAT, "In memory segments overlap"); + } + } + fragments.push_back( + page_fragment{file_offset,off,len}); + addr += len; + file_offset += len; + remaining -= len; + } + } + if (entry.memsz > entry.filez) { + // we have some uninitialized data too + rc = check_address_range(valid_ranges, entry.paddr + entry.filez, entry.vaddr + entry.filez, entry.memsz - entry.filez, true, + ar); + if (rc) return rc; + } + } + } + return 0; +} + +int realize_page(std::shared_ptr in, const std::vector &fragments, uint8_t *buf, unsigned int buf_len) { + assert(buf_len >= UF2_PAGE_SIZE); + for(auto& frag : fragments) { + assert(frag.page_offset < UF2_PAGE_SIZE && frag.page_offset + frag.bytes <= UF2_PAGE_SIZE); + in->seekg(frag.file_offset, in->beg); + if (in->fail()) { + fail_read_error(); + } + in->read((char*)buf + frag.page_offset, frag.bytes); + if (in->fail()) { + fail_read_error(); + } + } + return 0; +} + +static bool is_address_mapped(const std::map>& pages, uint32_t addr) { + uint32_t page = addr & ~(UF2_PAGE_SIZE - 1); + if (!pages.count(page)) return false; + // todo check actual address within page + return true; +} + +uf2_block gen_abs_block(uint32_t abs_block_loc) { + uf2_block block; + block.magic_start0 = UF2_MAGIC_START0; + block.magic_start1 = UF2_MAGIC_START1; + block.flags = UF2_FLAG_FAMILY_ID_PRESENT; + block.payload_size = UF2_PAGE_SIZE; + block.num_blocks = 2; + block.file_size = ABSOLUTE_FAMILY_ID; + block.magic_end = UF2_MAGIC_END; + block.target_addr = abs_block_loc; + block.block_no = 0; + memset(block.data, 0, sizeof(block.data)); + memset(block.data, 0xef, UF2_PAGE_SIZE); + return block; +} + +bool check_abs_block(uf2_block block) { + return std::all_of(block.data, block.data + UF2_PAGE_SIZE, [](uint8_t i) { return i == 0xef; }) && + block.magic_start0 == UF2_MAGIC_START0 && + block.magic_start1 == UF2_MAGIC_START1 && + block.flags == UF2_FLAG_FAMILY_ID_PRESENT && + block.payload_size == UF2_PAGE_SIZE && + block.num_blocks == 2 && + block.file_size == ABSOLUTE_FAMILY_ID && + block.magic_end == UF2_MAGIC_END && + block.block_no == 0; +} + +int pages2uf2(std::map>& pages, std::shared_ptr in, std::shared_ptr out, uint32_t family_id, uint32_t abs_block_loc=0) { + // RP2350-E9: add absolute block to start, targeting end of flash by default + if (family_id != ABSOLUTE_FAMILY_ID && family_id != RP2040_FAMILY_ID && abs_block_loc) { + uf2_block block = gen_abs_block(abs_block_loc); + out->write((char*)&block, sizeof(uf2_block)); + if (out->fail()) { + fail_write_error(); + } + } + uf2_block block; + unsigned int page_num = 0; + block.magic_start0 = UF2_MAGIC_START0; + block.magic_start1 = UF2_MAGIC_START1; + block.flags = UF2_FLAG_FAMILY_ID_PRESENT; + block.payload_size = UF2_PAGE_SIZE; + block.num_blocks = (uint32_t)pages.size(); + block.file_size = family_id; + block.magic_end = UF2_MAGIC_END; + for(auto& page_entry : pages) { + block.target_addr = page_entry.first; + block.block_no = page_num++; + if (verbose) { + printf("Page %d / %d %08x%s\n", block.block_no, block.num_blocks, block.target_addr, + page_entry.second.empty() ? " (padding)": ""); + } + memset(block.data, 0, sizeof(block.data)); + int rc = realize_page(in, page_entry.second, block.data, sizeof(block.data)); + if (rc) return rc; + out->write((char*)&block, sizeof(uf2_block)); + if (out->fail()) { + fail_write_error(); + } + } + return 0; +} + +int bin2uf2(std::shared_ptr in, std::shared_ptr out, uint32_t address, uint32_t family_id, uint32_t abs_block_loc) { + std::map> pages; + + in->seekg(0, in->end); + if (in->fail()) { + fail_read_error(); + } + int size = in->tellg(); + if (size <= 0) { + fail_read_error(); + } + + unsigned int addr = address; + unsigned int remaining = size; + unsigned int file_offset = 0; + while (remaining) { + unsigned int off = addr & (UF2_PAGE_SIZE - 1); + unsigned int len = std::min(remaining, UF2_PAGE_SIZE - off); + auto &fragments = pages[addr - off]; // list of fragments + // note if filesz is zero, we want zero init which is handled because the + // statement above creates an empty page fragment list + // check overlap with any existing fragments + for (const auto &fragment : fragments) { + if ((off < fragment.page_offset + fragment.bytes) != + ((off + len) <= fragment.page_offset)) { + fail(ERROR_FORMAT, "In memory segments overlap"); + } + } + fragments.push_back( + page_fragment{file_offset,off,len}); + addr += len; + file_offset += len; + remaining -= len; + } + + return pages2uf2(pages, in, out, family_id, abs_block_loc); +} + +int elf2uf2(std::shared_ptr in, std::shared_ptr out, uint32_t family_id, uint32_t package_addr, uint32_t abs_block_loc) { + elf_file elf; + std::map> pages; + + int rc = elf.read_file(in); + bool ram_style = false; + address_ranges valid_ranges = {}; + address_ranges flash_range; address_ranges ram_range; + if (family_id == RP2040_FAMILY_ID) { + flash_range = rp2040_address_ranges_flash; + ram_range = rp2040_address_ranges_ram; + } else { + flash_range = rp2350_address_ranges_flash; + ram_range = rp2350_address_ranges_ram; + } + if (!rc) { + rc = rp_determine_binary_type(elf.header(), elf.segments(), flash_range, ram_range, &ram_style); + if (!rc) { + if (verbose) { + if (ram_style) { + printf("Detected RAM binary\n"); + } else { + printf("Detected FLASH binary\n"); + } + } + valid_ranges = ram_style ? ram_range : flash_range; + rc = check_elf32_ph_entries(elf.segments(), valid_ranges, pages); + } + } + if (rc) return rc; + if (pages.empty()) { + fail(ERROR_INCOMPATIBLE, "The input file has no memory pages"); + } + // No Thumb bit on RISC-V + elf32_header eh = elf.header(); + uint32_t thumb_bit = eh.common.machine == EM_ARM ? 0x1u : 0x0u; + if (ram_style) { + uint32_t expected_ep_main_ram = UINT32_MAX; + uint32_t expected_ep_xip_sram = UINT32_MAX; + for(auto& page_entry : pages) { + if ( ((page_entry.first >= SRAM_START) && (page_entry.first < ram_range[0].to)) && (page_entry.first < expected_ep_main_ram) ) { + expected_ep_main_ram = page_entry.first | thumb_bit; + } else if ( ((page_entry.first >= ram_range[1].from) && (page_entry.first < ram_range[1].to)) && (page_entry.first < expected_ep_xip_sram) ) { + expected_ep_xip_sram = page_entry.first | thumb_bit; + } + } + uint32_t expected_ep = (UINT32_MAX != expected_ep_main_ram) ? expected_ep_main_ram : expected_ep_xip_sram; + if (eh.entry == expected_ep_xip_sram && family_id == RP2040_FAMILY_ID) { + fail(ERROR_INCOMPATIBLE, "RP2040 B0/B1/B2 Boot ROM does not support direct entry into XIP_SRAM\n"); + } else if (eh.entry != expected_ep && family_id == RP2040_FAMILY_ID) { + fail(ERROR_INCOMPATIBLE, "A RP2040 RAM binary should have an entry point at the beginning: %08x (not %08x)\n", expected_ep, eh.entry); + } + static_assert(0 == (SRAM_START & (UF2_PAGE_SIZE - 1)), ""); + // currently don't require this as entry point is now at the start, we don't know where reset vector is + // todo can be re-enabled for RP2350 +#if 0 + uint8_t buf[UF2_PAGE_SIZE]; + rc = realize_page(in, pages[SRAM_START], buf, sizeof(buf)); + if (rc) return rc; + uint32_t sp = ((uint32_t *)buf)[0]; + uint32_t ip = ((uint32_t *)buf)[1]; + if (!is_address_mapped(pages, ip)) { + fail(ERROR_INCOMPATIBLE, "Vector table at %08x is invalid: reset vector %08x is not in mapped memory", + SRAM_START, ip); + } + if (!is_address_valid(valid_ranges, sp - 4)) { + fail(ERROR_INCOMPATIBLE, "Vector table at %08x is invalid: stack pointer %08x is not in RAM", + SRAM_START, sp); + } +#endif + } else { + // Fill in empty dummy uf2 pages to align the binary to flash sectors (except for the last sector which we don't + // need to pad, and choose not to to avoid making all SDK UF2s bigger) + // That workaround is required because the bootrom uses the block number for erase sector calculations: + // https://github.com/raspberrypi/pico-bootrom/blob/c09c7f08550e8a36fc38dc74f8873b9576de99eb/bootrom/virtual_disk.c#L205 + + std::set touched_sectors; + for (auto& page_entry : pages) { + uint32_t sector = page_entry.first / FLASH_SECTOR_ERASE_SIZE; + touched_sectors.insert(sector); + } + + uint32_t last_page = pages.rbegin()->first; + for (uint32_t sector : touched_sectors) { + for (uint32_t page = sector * FLASH_SECTOR_ERASE_SIZE; page < (sector + 1) * FLASH_SECTOR_ERASE_SIZE; page += UF2_PAGE_SIZE) { + if (page < last_page) { + // Create a dummy page, if it does not exist yet. note that all present pages are first + // zeroed before they are filled with any contents, so a dummy page will be all zeros. + auto &dummy = pages[page]; + } + } + } + } + + if (package_addr) { + // Package binary at address + uint32_t base_addr = pages.begin()->first; + int32_t package_delta = package_addr - base_addr; + if (verbose) printf("Base %x\n", base_addr); + + auto copy_pages = pages; + pages.clear(); + for (auto page : copy_pages) { + pages[page.first + package_delta] = page.second; + } + } + + return pages2uf2(pages, in, out, family_id, abs_block_loc); +} diff --git a/elf2uf2/elf2uf2.h b/elf2uf2/elf2uf2.h new file mode 100644 index 0000000..2478373 --- /dev/null +++ b/elf2uf2/elf2uf2.h @@ -0,0 +1,28 @@ +/* + * Copyright (c) 2020 Raspberry Pi (Trading) Ltd. + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +#ifndef _ELF2UF2_H +#define _ELF2UF2_H + + +#include +#include + +#include "boot/uf2.h" + +#include "elf_file.h" + +// we require 256 (as this is the page size supported by the device) +#define LOG2_PAGE_SIZE 8u +#define UF2_PAGE_SIZE (1u << LOG2_PAGE_SIZE) + + +bool check_abs_block(uf2_block block); +int bin2uf2(std::shared_ptr in, std::shared_ptr out, uint32_t address, uint32_t family_id, uint32_t abs_block_loc=0); +int elf2uf2(std::shared_ptr in, std::shared_ptr out, uint32_t family_id, uint32_t package_addr=0, uint32_t abs_block_loc=0); + + +#endif \ No newline at end of file diff --git a/errors/BUILD.bazel b/errors/BUILD.bazel new file mode 100644 index 0000000..c27e447 --- /dev/null +++ b/errors/BUILD.bazel @@ -0,0 +1,8 @@ +package(default_visibility = ["//visibility:public"]) + +cc_library( + name = "errors", + srcs = ["errors.cpp"], + hdrs = ["errors.h"], + includes = ["."], +) diff --git a/errors/CMakeLists.txt b/errors/CMakeLists.txt new file mode 100644 index 0000000..16a5409 --- /dev/null +++ b/errors/CMakeLists.txt @@ -0,0 +1,3 @@ +add_library(errors STATIC errors.cpp) + +target_include_directories(errors PUBLIC ${CMAKE_CURRENT_LIST_DIR}) diff --git a/errors/errors.cpp b/errors/errors.cpp new file mode 100644 index 0000000..3f971b7 --- /dev/null +++ b/errors/errors.cpp @@ -0,0 +1,16 @@ +#include + +#include "errors.h" + +void fail(int code, std::string msg) { + throw command_failure(code, std::move(msg)); +} + +void fail(int code, const char *format, ...) { + va_list args; + va_start(args, format); + static char error_msg[512]; + vsnprintf(error_msg, sizeof(error_msg), format, args); + va_end(args); + fail(code, std::string(error_msg)); +} diff --git a/errors/errors.h b/errors/errors.h new file mode 100644 index 0000000..597df64 --- /dev/null +++ b/errors/errors.h @@ -0,0 +1,41 @@ +#ifndef _ERRORS_H +#define _ERRORS_H + +#ifdef _WIN32 +#undef ERROR_CANCELLED +#endif + +#include + +#define ERROR_ARGS (-1) +#define ERROR_FORMAT (-2) +#define ERROR_INCOMPATIBLE (-3) +#define ERROR_READ_FAILED (-4) +#define ERROR_WRITE_FAILED (-5) +#define ERROR_USB (-6) +#define ERROR_NO_DEVICE (-7) +#define ERROR_NOT_POSSIBLE (-8) +#define ERROR_CONNECTION (-9) +#define ERROR_CANCELLED (-10) +#define ERROR_VERIFICATION_FAILED (-11) +#define ERROR_UNKNOWN (-99) + + +struct command_failure : std::exception { + command_failure(int code, std::string s) : c(code), s(std::move(s)) {} + + const char *what() const noexcept override { + return s.c_str(); + } + + int code() const { return c; } +private: + int c; + std::string s; +}; + + +void fail(int code, std::string msg); +void fail(int code, const char *format, ...); + +#endif \ No newline at end of file diff --git a/lib/BUILD.bazel b/lib/BUILD.bazel new file mode 100644 index 0000000..d52679a --- /dev/null +++ b/lib/BUILD.bazel @@ -0,0 +1,6 @@ +cc_library( + name = "mbedtls_config", + hdrs = ["include/mbedtls_config.h"], + includes = ["include"], + visibility = ["@mbedtls//:__subpackages__"], +) diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt new file mode 100644 index 0000000..b30fcb6 --- /dev/null +++ b/lib/CMakeLists.txt @@ -0,0 +1,27 @@ +# Ensure submodules are initialised - no longer needed as there are no submodules +find_package(Git QUIET) +if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git") + # Update submodules as needed + option(GIT_SUBMODULE "Check submodules during build" OFF) + if(GIT_SUBMODULE) + message(STATUS "Submodule update") + execute_process(COMMAND ${GIT_EXECUTABLE} submodule update --init lib/mbedtls + WORKING_DIRECTORY ${PICO_SDK_PATH} + RESULT_VARIABLE GIT_SUBMOD_RESULT) + if(NOT GIT_SUBMOD_RESULT EQUAL "0") + message("git submodule update --init lib/mbedtls failed with ${GIT_SUBMOD_RESULT}") + endif() + endif() +endif() + + +set(JSON_BuildTests OFF CACHE INTERNAL "") +add_subdirectory(nlohmann_json EXCLUDE_FROM_ALL) + +add_subdirectory(whereami EXCLUDE_FROM_ALL) + +if(EXISTS "${PICO_SDK_PATH}/lib/mbedtls/CMakeLists.txt") + option(ENABLE_PROGRAMS "Build Mbed TLS programs." OFF) + option(ENABLE_TESTING "Build Mbed TLS tests." OFF) + add_subdirectory(${PICO_SDK_PATH}/lib/mbedtls mbedtls EXCLUDE_FROM_ALL) +endif() diff --git a/lib/include/mbedtls_config.h b/lib/include/mbedtls_config.h new file mode 100644 index 0000000..5bdd142 --- /dev/null +++ b/lib/include/mbedtls_config.h @@ -0,0 +1,4217 @@ +/** + * \file config.h + * + * \brief Configuration options (set of defines) + * + * This set of compile-time options may be used to enable + * or disable features selectively, and reduce the global + * memory footprint. + */ +/* + * Copyright The Mbed TLS Contributors + * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later + */ + +#ifndef MBEDTLS_CONFIG_H +#define MBEDTLS_CONFIG_H + +#if defined(_MSC_VER) && !defined(_CRT_SECURE_NO_DEPRECATE) +#define _CRT_SECURE_NO_DEPRECATE 1 +#endif + +/** + * \name SECTION: System support + * + * This section sets system specific settings. + * \{ + */ + +/** + * \def MBEDTLS_HAVE_ASM + * + * The compiler has support for asm(). + * + * Requires support for asm() in compiler. + * + * Used in: + * library/aria.c + * library/timing.c + * include/mbedtls/bn_mul.h + * + * Required by: + * MBEDTLS_AESNI_C (on some platforms) + * MBEDTLS_PADLOCK_C + * + * Comment to disable the use of assembly code. + */ +#define MBEDTLS_HAVE_ASM + +/** + * \def MBEDTLS_NO_UDBL_DIVISION + * + * The platform lacks support for double-width integer division (64-bit + * division on a 32-bit platform, 128-bit division on a 64-bit platform). + * + * Used in: + * include/mbedtls/bignum.h + * library/bignum.c + * + * The bignum code uses double-width division to speed up some operations. + * Double-width division is often implemented in software that needs to + * be linked with the program. The presence of a double-width integer + * type is usually detected automatically through preprocessor macros, + * but the automatic detection cannot know whether the code needs to + * and can be linked with an implementation of division for that type. + * By default division is assumed to be usable if the type is present. + * Uncomment this option to prevent the use of double-width division. + * + * Note that division for the native integer type is always required. + * Furthermore, a 64-bit type is always required even on a 32-bit + * platform, but it need not support multiplication or division. In some + * cases it is also desirable to disable some double-width operations. For + * example, if double-width division is implemented in software, disabling + * it can reduce code size in some embedded targets. + */ +//#define MBEDTLS_NO_UDBL_DIVISION + +/** + * \def MBEDTLS_NO_64BIT_MULTIPLICATION + * + * The platform lacks support for 32x32 -> 64-bit multiplication. + * + * Used in: + * library/poly1305.c + * + * Some parts of the library may use multiplication of two unsigned 32-bit + * operands with a 64-bit result in order to speed up computations. On some + * platforms, this is not available in hardware and has to be implemented in + * software, usually in a library provided by the toolchain. + * + * Sometimes it is not desirable to have to link to that library. This option + * removes the dependency of that library on platforms that lack a hardware + * 64-bit multiplier by embedding a software implementation in Mbed TLS. + * + * Note that depending on the compiler, this may decrease performance compared + * to using the library function provided by the toolchain. + */ +//#define MBEDTLS_NO_64BIT_MULTIPLICATION + +/** + * \def MBEDTLS_HAVE_SSE2 + * + * CPU supports SSE2 instruction set. + * + * Uncomment if the CPU supports SSE2 (IA-32 specific). + */ +//#define MBEDTLS_HAVE_SSE2 + +/** + * \def MBEDTLS_HAVE_TIME + * + * System has time.h and time(). + * The time does not need to be correct, only time differences are used, + * by contrast with MBEDTLS_HAVE_TIME_DATE + * + * Defining MBEDTLS_HAVE_TIME allows you to specify MBEDTLS_PLATFORM_TIME_ALT, + * MBEDTLS_PLATFORM_TIME_MACRO, MBEDTLS_PLATFORM_TIME_TYPE_MACRO and + * MBEDTLS_PLATFORM_STD_TIME. + * + * Comment if your system does not support time functions. + * + * \note If MBEDTLS_TIMING_C is set - to enable the semi-portable timing + * interface - timing.c will include time.h on suitable platforms + * regardless of the setting of MBEDTLS_HAVE_TIME, unless + * MBEDTLS_TIMING_ALT is used. See timing.c for more information. + */ +#define MBEDTLS_HAVE_TIME + +/** + * \def MBEDTLS_HAVE_TIME_DATE + * + * System has time.h, time(), and an implementation for + * mbedtls_platform_gmtime_r() (see below). + * The time needs to be correct (not necessarily very accurate, but at least + * the date should be correct). This is used to verify the validity period of + * X.509 certificates. + * + * Comment if your system does not have a correct clock. + * + * \note mbedtls_platform_gmtime_r() is an abstraction in platform_util.h that + * behaves similarly to the gmtime_r() function from the C standard. Refer to + * the documentation for mbedtls_platform_gmtime_r() for more information. + * + * \note It is possible to configure an implementation for + * mbedtls_platform_gmtime_r() at compile-time by using the macro + * MBEDTLS_PLATFORM_GMTIME_R_ALT. + */ +#define MBEDTLS_HAVE_TIME_DATE + +/** + * \def MBEDTLS_PLATFORM_MEMORY + * + * Enable the memory allocation layer. + * + * By default Mbed TLS uses the system-provided calloc() and free(). + * This allows different allocators (self-implemented or provided) to be + * provided to the platform abstraction layer. + * + * Enabling #MBEDTLS_PLATFORM_MEMORY without the + * MBEDTLS_PLATFORM_{FREE,CALLOC}_MACROs will provide + * "mbedtls_platform_set_calloc_free()" allowing you to set an alternative calloc() and + * free() function pointer at runtime. + * + * Enabling #MBEDTLS_PLATFORM_MEMORY and specifying + * MBEDTLS_PLATFORM_{CALLOC,FREE}_MACROs will allow you to specify the + * alternate function at compile time. + * + * An overview of how the value of mbedtls_calloc is determined: + * + * - if !MBEDTLS_PLATFORM_MEMORY + * - mbedtls_calloc = calloc + * - if MBEDTLS_PLATFORM_MEMORY + * - if (MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO): + * - mbedtls_calloc = MBEDTLS_PLATFORM_CALLOC_MACRO + * - if !(MBEDTLS_PLATFORM_CALLOC_MACRO && MBEDTLS_PLATFORM_FREE_MACRO): + * - Dynamic setup via mbedtls_platform_set_calloc_free is now possible with a default value MBEDTLS_PLATFORM_STD_CALLOC. + * - How is MBEDTLS_PLATFORM_STD_CALLOC handled? + * - if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS: + * - MBEDTLS_PLATFORM_STD_CALLOC is not set to anything; + * - MBEDTLS_PLATFORM_STD_MEM_HDR can be included if present; + * - if !MBEDTLS_PLATFORM_NO_STD_FUNCTIONS: + * - if MBEDTLS_PLATFORM_STD_CALLOC is present: + * - User-defined MBEDTLS_PLATFORM_STD_CALLOC is respected; + * - if !MBEDTLS_PLATFORM_STD_CALLOC: + * - MBEDTLS_PLATFORM_STD_CALLOC = calloc + * + * - At this point the presence of MBEDTLS_PLATFORM_STD_CALLOC is checked. + * - if !MBEDTLS_PLATFORM_STD_CALLOC + * - MBEDTLS_PLATFORM_STD_CALLOC = uninitialized_calloc + * + * - mbedtls_calloc = MBEDTLS_PLATFORM_STD_CALLOC. + * + * Defining MBEDTLS_PLATFORM_CALLOC_MACRO and #MBEDTLS_PLATFORM_STD_CALLOC at the same time is not possible. + * MBEDTLS_PLATFORM_CALLOC_MACRO and MBEDTLS_PLATFORM_FREE_MACRO must both be defined or undefined at the same time. + * #MBEDTLS_PLATFORM_STD_CALLOC and #MBEDTLS_PLATFORM_STD_FREE do not have to be defined at the same time, as, if they are used, + * dynamic setup of these functions is possible. See the tree above to see how are they handled in all cases. + * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer. + * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything. + * + * Requires: MBEDTLS_PLATFORM_C + * + * Enable this layer to allow use of alternative memory allocators. + */ +//#define MBEDTLS_PLATFORM_MEMORY + +/** + * \def MBEDTLS_PLATFORM_NO_STD_FUNCTIONS + * + * Do not assign standard functions in the platform layer (e.g. calloc() to + * MBEDTLS_PLATFORM_STD_CALLOC and printf() to MBEDTLS_PLATFORM_STD_PRINTF) + * + * This makes sure there are no linking errors on platforms that do not support + * these functions. You will HAVE to provide alternatives, either at runtime + * via the platform_set_xxx() functions or at compile time by setting + * the MBEDTLS_PLATFORM_STD_XXX defines, or enabling a + * MBEDTLS_PLATFORM_XXX_MACRO. + * + * Requires: MBEDTLS_PLATFORM_C + * + * Uncomment to prevent default assignment of standard functions in the + * platform layer. + */ +//#define MBEDTLS_PLATFORM_NO_STD_FUNCTIONS + +/** + * \def MBEDTLS_PLATFORM_EXIT_ALT + * + * MBEDTLS_PLATFORM_XXX_ALT: Uncomment a macro to let Mbed TLS support the + * function in the platform abstraction layer. + * + * Example: In case you uncomment MBEDTLS_PLATFORM_PRINTF_ALT, Mbed TLS will + * provide a function "mbedtls_platform_set_printf()" that allows you to set an + * alternative printf function pointer. + * + * All these define require MBEDTLS_PLATFORM_C to be defined! + * + * \note MBEDTLS_PLATFORM_SNPRINTF_ALT is required on Windows; + * it will be enabled automatically by check_config.h + * + * \warning MBEDTLS_PLATFORM_XXX_ALT cannot be defined at the same time as + * MBEDTLS_PLATFORM_XXX_MACRO! + * + * Requires: MBEDTLS_PLATFORM_TIME_ALT requires MBEDTLS_HAVE_TIME + * + * Uncomment a macro to enable alternate implementation of specific base + * platform function + */ +//#define MBEDTLS_PLATFORM_EXIT_ALT +//#define MBEDTLS_PLATFORM_TIME_ALT +//#define MBEDTLS_PLATFORM_FPRINTF_ALT +//#define MBEDTLS_PLATFORM_PRINTF_ALT +//#define MBEDTLS_PLATFORM_SNPRINTF_ALT +//#define MBEDTLS_PLATFORM_VSNPRINTF_ALT +//#define MBEDTLS_PLATFORM_NV_SEED_ALT +//#define MBEDTLS_PLATFORM_SETUP_TEARDOWN_ALT + +/** + * Uncomment the macro to let Mbed TLS use your alternate implementation of + * mbedtls_platform_gmtime_r(). This replaces the default implementation in + * platform_util.c. + * + * gmtime() is not a thread-safe function as defined in the C standard. The + * library will try to use safer implementations of this function, such as + * gmtime_r() when available. However, if Mbed TLS cannot identify the target + * system, the implementation of mbedtls_platform_gmtime_r() will default to + * using the standard gmtime(). In this case, calls from the library to + * gmtime() will be guarded by the global mutex mbedtls_threading_gmtime_mutex + * if MBEDTLS_THREADING_C is enabled. We recommend that calls from outside the + * library are also guarded with this mutex to avoid race conditions. However, + * if the macro MBEDTLS_PLATFORM_GMTIME_R_ALT is defined, Mbed TLS will + * unconditionally use the implementation for mbedtls_platform_gmtime_r() + * supplied at compile time. + */ +//#define MBEDTLS_PLATFORM_GMTIME_R_ALT + +/** + * Uncomment the macro to let Mbed TLS use your alternate implementation of + * mbedtls_platform_zeroize(). This replaces the default implementation in + * platform_util.c. + * + * mbedtls_platform_zeroize() is a widely used function across the library to + * zero a block of memory. The implementation is expected to be secure in the + * sense that it has been written to prevent the compiler from removing calls + * to mbedtls_platform_zeroize() as part of redundant code elimination + * optimizations. However, it is difficult to guarantee that calls to + * mbedtls_platform_zeroize() will not be optimized by the compiler as older + * versions of the C language standards do not provide a secure implementation + * of memset(). Therefore, MBEDTLS_PLATFORM_ZEROIZE_ALT enables users to + * configure their own implementation of mbedtls_platform_zeroize(), for + * example by using directives specific to their compiler, features from newer + * C standards (e.g using memset_s() in C11) or calling a secure memset() from + * their system (e.g explicit_bzero() in BSD). + */ +//#define MBEDTLS_PLATFORM_ZEROIZE_ALT + +/** + * \def MBEDTLS_DEPRECATED_WARNING + * + * Mark deprecated functions and features so that they generate a warning if + * used. Functionality deprecated in one version will usually be removed in the + * next version. You can enable this to help you prepare the transition to a + * new major version by making sure your code is not using this functionality. + * + * This only works with GCC and Clang. With other compilers, you may want to + * use MBEDTLS_DEPRECATED_REMOVED + * + * Uncomment to get warnings on using deprecated functions and features. + */ +//#define MBEDTLS_DEPRECATED_WARNING + +/** + * \def MBEDTLS_DEPRECATED_REMOVED + * + * Remove deprecated functions and features so that they generate an error if + * used. Functionality deprecated in one version will usually be removed in the + * next version. You can enable this to help you prepare the transition to a + * new major version by making sure your code is not using this functionality. + * + * Uncomment to get errors on using deprecated functions and features. + */ +//#define MBEDTLS_DEPRECATED_REMOVED + +/** + * \def MBEDTLS_CHECK_PARAMS + * + * This configuration option controls whether the library validates more of + * the parameters passed to it. + * + * When this flag is not defined, the library only attempts to validate an + * input parameter if: (1) they may come from the outside world (such as the + * network, the filesystem, etc.) or (2) not validating them could result in + * internal memory errors such as overflowing a buffer controlled by the + * library. On the other hand, it doesn't attempt to validate parameters whose + * values are fully controlled by the application (such as pointers). + * + * When this flag is defined, the library additionally attempts to validate + * parameters that are fully controlled by the application, and should always + * be valid if the application code is fully correct and trusted. + * + * For example, when a function accepts as input a pointer to a buffer that may + * contain untrusted data, and its documentation mentions that this pointer + * must not be NULL: + * - The pointer is checked to be non-NULL only if this option is enabled. + * - The content of the buffer is always validated. + * + * When this flag is defined, if a library function receives a parameter that + * is invalid: + * 1. The function will invoke the macro MBEDTLS_PARAM_FAILED(). + * 2. If MBEDTLS_PARAM_FAILED() did not terminate the program, the function + * will immediately return. If the function returns an Mbed TLS error code, + * the error code in this case is MBEDTLS_ERR_xxx_BAD_INPUT_DATA. + * + * When defining this flag, you also need to arrange a definition for + * MBEDTLS_PARAM_FAILED(). You can do this by any of the following methods: + * - By default, the library defines MBEDTLS_PARAM_FAILED() to call a + * function mbedtls_param_failed(), but the library does not define this + * function. If you do not make any other arrangements, you must provide + * the function mbedtls_param_failed() in your application. + * See `platform_util.h` for its prototype. + * - If you enable the macro #MBEDTLS_CHECK_PARAMS_ASSERT, then the + * library defines MBEDTLS_PARAM_FAILED(\c cond) to be `assert(cond)`. + * You can still supply an alternative definition of + * MBEDTLS_PARAM_FAILED(), which may call `assert`. + * - If you define a macro MBEDTLS_PARAM_FAILED() before including `config.h` + * or you uncomment the definition of MBEDTLS_PARAM_FAILED() in `config.h`, + * the library will call the macro that you defined and will not supply + * its own version. Note that if MBEDTLS_PARAM_FAILED() calls `assert`, + * you need to enable #MBEDTLS_CHECK_PARAMS_ASSERT so that library source + * files include ``. + * + * Uncomment to enable validation of application-controlled parameters. + */ +//#define MBEDTLS_CHECK_PARAMS + +/** + * \def MBEDTLS_CHECK_PARAMS_ASSERT + * + * Allow MBEDTLS_PARAM_FAILED() to call `assert`, and make it default to + * `assert`. This macro is only used if #MBEDTLS_CHECK_PARAMS is defined. + * + * If this macro is not defined, then MBEDTLS_PARAM_FAILED() defaults to + * calling a function mbedtls_param_failed(). See the documentation of + * #MBEDTLS_CHECK_PARAMS for details. + * + * Uncomment to allow MBEDTLS_PARAM_FAILED() to call `assert`. + */ +//#define MBEDTLS_CHECK_PARAMS_ASSERT + +/** \} name SECTION: System support */ + +/** + * \name SECTION: Mbed TLS feature support + * + * This section sets support for features that are or are not needed + * within the modules that are enabled. + * \{ + */ + +/** + * \def MBEDTLS_TIMING_ALT + * + * Uncomment to provide your own alternate implementation for mbedtls_timing_hardclock(), + * mbedtls_timing_get_timer(), mbedtls_set_alarm(), mbedtls_set/get_delay() + * + * Only works if you have MBEDTLS_TIMING_C enabled. + * + * You will need to provide a header "timing_alt.h" and an implementation at + * compile time. + */ +//#define MBEDTLS_TIMING_ALT + +/** + * \def MBEDTLS_AES_ALT + * + * MBEDTLS__MODULE_NAME__ALT: Uncomment a macro to let Mbed TLS use your + * alternate core implementation of a symmetric crypto, an arithmetic or hash + * module (e.g. platform specific assembly optimized implementations). Keep + * in mind that the function prototypes should remain the same. + * + * This replaces the whole module. If you only want to replace one of the + * functions, use one of the MBEDTLS__FUNCTION_NAME__ALT flags. + * + * Example: In case you uncomment MBEDTLS_AES_ALT, Mbed TLS will no longer + * provide the "struct mbedtls_aes_context" definition and omit the base + * function declarations and implementations. "aes_alt.h" will be included from + * "aes.h" to include the new function definitions. + * + * Uncomment a macro to enable alternate implementation of the corresponding + * module. + * + * \warning MD2, MD4, MD5, ARC4, DES and SHA-1 are considered weak and their + * use constitutes a security risk. If possible, we recommend + * avoiding dependencies on them, and considering stronger message + * digests and ciphers instead. + * + */ +//#define MBEDTLS_AES_ALT +//#define MBEDTLS_ARC4_ALT +//#define MBEDTLS_ARIA_ALT +//#define MBEDTLS_BLOWFISH_ALT +//#define MBEDTLS_CAMELLIA_ALT +//#define MBEDTLS_CCM_ALT +//#define MBEDTLS_CHACHA20_ALT +//#define MBEDTLS_CHACHAPOLY_ALT +//#define MBEDTLS_CMAC_ALT +//#define MBEDTLS_DES_ALT +//#define MBEDTLS_DHM_ALT +//#define MBEDTLS_ECJPAKE_ALT +//#define MBEDTLS_GCM_ALT +//#define MBEDTLS_NIST_KW_ALT +//#define MBEDTLS_MD2_ALT +//#define MBEDTLS_MD4_ALT +//#define MBEDTLS_MD5_ALT +//#define MBEDTLS_POLY1305_ALT +//#define MBEDTLS_RIPEMD160_ALT +//#define MBEDTLS_RSA_ALT +//#define MBEDTLS_SHA1_ALT +//#define MBEDTLS_SHA256_ALT +//#define MBEDTLS_SHA512_ALT +//#define MBEDTLS_XTEA_ALT + +/* + * When replacing the elliptic curve module, please consider, that it is + * implemented with two .c files: + * - ecp.c + * - ecp_curves.c + * You can replace them very much like all the other MBEDTLS__MODULE_NAME__ALT + * macros as described above. The only difference is that you have to make sure + * that you provide functionality for both .c files. + */ +//#define MBEDTLS_ECP_ALT + +/** + * \def MBEDTLS_MD2_PROCESS_ALT + * + * MBEDTLS__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use you + * alternate core implementation of symmetric crypto or hash function. Keep in + * mind that function prototypes should remain the same. + * + * This replaces only one function. The header file from Mbed TLS is still + * used, in contrast to the MBEDTLS__MODULE_NAME__ALT flags. + * + * Example: In case you uncomment MBEDTLS_SHA256_PROCESS_ALT, Mbed TLS will + * no longer provide the mbedtls_sha1_process() function, but it will still provide + * the other function (using your mbedtls_sha1_process() function) and the definition + * of mbedtls_sha1_context, so your implementation of mbedtls_sha1_process must be compatible + * with this definition. + * + * \note Because of a signature change, the core AES encryption and decryption routines are + * currently named mbedtls_aes_internal_encrypt and mbedtls_aes_internal_decrypt, + * respectively. When setting up alternative implementations, these functions should + * be overridden, but the wrapper functions mbedtls_aes_decrypt and mbedtls_aes_encrypt + * must stay untouched. + * + * \note If you use the AES_xxx_ALT macros, then it is recommended to also set + * MBEDTLS_AES_ROM_TABLES in order to help the linker garbage-collect the AES + * tables. + * + * Uncomment a macro to enable alternate implementation of the corresponding + * function. + * + * \warning MD2, MD4, MD5, DES and SHA-1 are considered weak and their use + * constitutes a security risk. If possible, we recommend avoiding + * dependencies on them, and considering stronger message digests + * and ciphers instead. + * + * \warning If both MBEDTLS_ECDSA_SIGN_ALT and MBEDTLS_ECDSA_DETERMINISTIC are + * enabled, then the deterministic ECDH signature functions pass the + * the static HMAC-DRBG as RNG to mbedtls_ecdsa_sign(). Therefore + * alternative implementations should use the RNG only for generating + * the ephemeral key and nothing else. If this is not possible, then + * MBEDTLS_ECDSA_DETERMINISTIC should be disabled and an alternative + * implementation should be provided for mbedtls_ecdsa_sign_det_ext() + * (and for mbedtls_ecdsa_sign_det() too if backward compatibility is + * desirable). + * + */ +//#define MBEDTLS_MD2_PROCESS_ALT +//#define MBEDTLS_MD4_PROCESS_ALT +//#define MBEDTLS_MD5_PROCESS_ALT +//#define MBEDTLS_RIPEMD160_PROCESS_ALT +//#define MBEDTLS_SHA1_PROCESS_ALT +//#define MBEDTLS_SHA256_PROCESS_ALT +//#define MBEDTLS_SHA512_PROCESS_ALT +//#define MBEDTLS_DES_SETKEY_ALT +//#define MBEDTLS_DES_CRYPT_ECB_ALT +//#define MBEDTLS_DES3_CRYPT_ECB_ALT +//#define MBEDTLS_AES_SETKEY_ENC_ALT +//#define MBEDTLS_AES_SETKEY_DEC_ALT +//#define MBEDTLS_AES_ENCRYPT_ALT +//#define MBEDTLS_AES_DECRYPT_ALT +//#define MBEDTLS_ECDH_GEN_PUBLIC_ALT +//#define MBEDTLS_ECDH_COMPUTE_SHARED_ALT +//#define MBEDTLS_ECDSA_VERIFY_ALT +//#define MBEDTLS_ECDSA_SIGN_ALT +//#define MBEDTLS_ECDSA_GENKEY_ALT + +/** + * \def MBEDTLS_ECP_INTERNAL_ALT + * + * Expose a part of the internal interface of the Elliptic Curve Point module. + * + * MBEDTLS_ECP__FUNCTION_NAME__ALT: Uncomment a macro to let Mbed TLS use your + * alternative core implementation of elliptic curve arithmetic. Keep in mind + * that function prototypes should remain the same. + * + * This partially replaces one function. The header file from Mbed TLS is still + * used, in contrast to the MBEDTLS_ECP_ALT flag. The original implementation + * is still present and it is used for group structures not supported by the + * alternative. + * + * The original implementation can in addition be removed by setting the + * MBEDTLS_ECP_NO_FALLBACK option, in which case any function for which the + * corresponding MBEDTLS_ECP__FUNCTION_NAME__ALT macro is defined will not be + * able to fallback to curves not supported by the alternative implementation. + * + * Any of these options become available by defining MBEDTLS_ECP_INTERNAL_ALT + * and implementing the following functions: + * unsigned char mbedtls_internal_ecp_grp_capable( + * const mbedtls_ecp_group *grp ) + * int mbedtls_internal_ecp_init( const mbedtls_ecp_group *grp ) + * void mbedtls_internal_ecp_free( const mbedtls_ecp_group *grp ) + * The mbedtls_internal_ecp_grp_capable function should return 1 if the + * replacement functions implement arithmetic for the given group and 0 + * otherwise. + * The functions mbedtls_internal_ecp_init and mbedtls_internal_ecp_free are + * called before and after each point operation and provide an opportunity to + * implement optimized set up and tear down instructions. + * + * Example: In case you set MBEDTLS_ECP_INTERNAL_ALT and + * MBEDTLS_ECP_DOUBLE_JAC_ALT, Mbed TLS will still provide the ecp_double_jac() + * function, but will use your mbedtls_internal_ecp_double_jac() if the group + * for the operation is supported by your implementation (i.e. your + * mbedtls_internal_ecp_grp_capable() function returns 1 for this group). If the + * group is not supported by your implementation, then the original Mbed TLS + * implementation of ecp_double_jac() is used instead, unless this fallback + * behaviour is disabled by setting MBEDTLS_ECP_NO_FALLBACK (in which case + * ecp_double_jac() will return MBEDTLS_ERR_ECP_FEATURE_UNAVAILABLE). + * + * The function prototypes and the definition of mbedtls_ecp_group and + * mbedtls_ecp_point will not change based on MBEDTLS_ECP_INTERNAL_ALT, so your + * implementation of mbedtls_internal_ecp__function_name__ must be compatible + * with their definitions. + * + * Uncomment a macro to enable alternate implementation of the corresponding + * function. + */ +/* Required for all the functions in this section */ +//#define MBEDTLS_ECP_INTERNAL_ALT +/* Turn off software fallback for curves not supported in hardware */ +//#define MBEDTLS_ECP_NO_FALLBACK +/* Support for Weierstrass curves with Jacobi representation */ +//#define MBEDTLS_ECP_RANDOMIZE_JAC_ALT +//#define MBEDTLS_ECP_ADD_MIXED_ALT +//#define MBEDTLS_ECP_DOUBLE_JAC_ALT +//#define MBEDTLS_ECP_NORMALIZE_JAC_MANY_ALT +//#define MBEDTLS_ECP_NORMALIZE_JAC_ALT +/* Support for curves with Montgomery arithmetic */ +//#define MBEDTLS_ECP_DOUBLE_ADD_MXZ_ALT +//#define MBEDTLS_ECP_RANDOMIZE_MXZ_ALT +//#define MBEDTLS_ECP_NORMALIZE_MXZ_ALT + +/** + * \def MBEDTLS_TEST_NULL_ENTROPY + * + * Enables testing and use of Mbed TLS without any configured entropy sources. + * This permits use of the library on platforms before an entropy source has + * been integrated (see for example the MBEDTLS_ENTROPY_HARDWARE_ALT or the + * MBEDTLS_ENTROPY_NV_SEED switches). + * + * WARNING! This switch MUST be disabled in production builds, and is suitable + * only for development. + * Enabling the switch negates any security provided by the library. + * + * Requires MBEDTLS_ENTROPY_C, MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES + * + */ +//#define MBEDTLS_TEST_NULL_ENTROPY + +/** + * \def MBEDTLS_ENTROPY_HARDWARE_ALT + * + * Uncomment this macro to let Mbed TLS use your own implementation of a + * hardware entropy collector. + * + * Your function must be called \c mbedtls_hardware_poll(), have the same + * prototype as declared in entropy_poll.h, and accept NULL as first argument. + * + * Uncomment to use your own hardware entropy collector. + */ +//#define MBEDTLS_ENTROPY_HARDWARE_ALT + +/** + * \def MBEDTLS_AES_ROM_TABLES + * + * Use precomputed AES tables stored in ROM. + * + * Uncomment this macro to use precomputed AES tables stored in ROM. + * Comment this macro to generate AES tables in RAM at runtime. + * + * Tradeoff: Using precomputed ROM tables reduces RAM usage by ~8kb + * (or ~2kb if \c MBEDTLS_AES_FEWER_TABLES is used) and reduces the + * initialization time before the first AES operation can be performed. + * It comes at the cost of additional ~8kb ROM use (resp. ~2kb if \c + * MBEDTLS_AES_FEWER_TABLES below is used), and potentially degraded + * performance if ROM access is slower than RAM access. + * + * This option is independent of \c MBEDTLS_AES_FEWER_TABLES. + * + */ +//#define MBEDTLS_AES_ROM_TABLES + +/** + * \def MBEDTLS_AES_FEWER_TABLES + * + * Use less ROM/RAM for AES tables. + * + * Uncommenting this macro omits 75% of the AES tables from + * ROM / RAM (depending on the value of \c MBEDTLS_AES_ROM_TABLES) + * by computing their values on the fly during operations + * (the tables are entry-wise rotations of one another). + * + * Tradeoff: Uncommenting this reduces the RAM / ROM footprint + * by ~6kb but at the cost of more arithmetic operations during + * runtime. Specifically, one has to compare 4 accesses within + * different tables to 4 accesses with additional arithmetic + * operations within the same table. The performance gain/loss + * depends on the system and memory details. + * + * This option is independent of \c MBEDTLS_AES_ROM_TABLES. + * + */ +//#define MBEDTLS_AES_FEWER_TABLES + +/** + * \def MBEDTLS_CAMELLIA_SMALL_MEMORY + * + * Use less ROM for the Camellia implementation (saves about 768 bytes). + * + * Uncomment this macro to use less memory for Camellia. + */ +//#define MBEDTLS_CAMELLIA_SMALL_MEMORY + +/** + * \def MBEDTLS_CHECK_RETURN_WARNING + * + * If this macro is defined, emit a compile-time warning if application code + * calls a function without checking its return value, but the return value + * should generally be checked in portable applications. + * + * This is only supported on platforms where #MBEDTLS_CHECK_RETURN is + * implemented. Otherwise this option has no effect. + * + * Uncomment to get warnings on using fallible functions without checking + * their return value. + * + * \note This feature is a work in progress. + * Warnings will be added to more functions in the future. + * + * \note A few functions are considered critical, and ignoring the return + * value of these functions will trigger a warning even if this + * macro is not defined. To completely disable return value check + * warnings, define #MBEDTLS_CHECK_RETURN with an empty expansion. + */ +//#define MBEDTLS_CHECK_RETURN_WARNING + +/** + * \def MBEDTLS_CIPHER_MODE_CBC + * + * Enable Cipher Block Chaining mode (CBC) for symmetric ciphers. + */ +#define MBEDTLS_CIPHER_MODE_CBC + +/** + * \def MBEDTLS_CIPHER_MODE_CFB + * + * Enable Cipher Feedback mode (CFB) for symmetric ciphers. + */ +#define MBEDTLS_CIPHER_MODE_CFB + +/** + * \def MBEDTLS_CIPHER_MODE_CTR + * + * Enable Counter Block Cipher mode (CTR) for symmetric ciphers. + */ +#define MBEDTLS_CIPHER_MODE_CTR + +/** + * \def MBEDTLS_CIPHER_MODE_OFB + * + * Enable Output Feedback mode (OFB) for symmetric ciphers. + */ +#define MBEDTLS_CIPHER_MODE_OFB + +/** + * \def MBEDTLS_CIPHER_MODE_XTS + * + * Enable Xor-encrypt-xor with ciphertext stealing mode (XTS) for AES. + */ +#define MBEDTLS_CIPHER_MODE_XTS + +/** + * \def MBEDTLS_CIPHER_NULL_CIPHER + * + * Enable NULL cipher. + * Warning: Only do so when you know what you are doing. This allows for + * encryption or channels without any security! + * + * Requires MBEDTLS_ENABLE_WEAK_CIPHERSUITES as well to enable + * the following ciphersuites: + * MBEDTLS_TLS_ECDH_ECDSA_WITH_NULL_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_NULL_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_NULL_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_NULL_SHA + * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_NULL_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_NULL_SHA + * MBEDTLS_TLS_RSA_WITH_NULL_SHA256 + * MBEDTLS_TLS_RSA_WITH_NULL_SHA + * MBEDTLS_TLS_RSA_WITH_NULL_MD5 + * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_NULL_SHA + * MBEDTLS_TLS_PSK_WITH_NULL_SHA384 + * MBEDTLS_TLS_PSK_WITH_NULL_SHA256 + * MBEDTLS_TLS_PSK_WITH_NULL_SHA + * + * Uncomment this macro to enable the NULL cipher and ciphersuites + */ +//#define MBEDTLS_CIPHER_NULL_CIPHER + +/** + * \def MBEDTLS_CIPHER_PADDING_PKCS7 + * + * MBEDTLS_CIPHER_PADDING_XXX: Uncomment or comment macros to add support for + * specific padding modes in the cipher layer with cipher modes that support + * padding (e.g. CBC) + * + * If you disable all padding modes, only full blocks can be used with CBC. + * + * Enable padding modes in the cipher layer. + */ +#define MBEDTLS_CIPHER_PADDING_PKCS7 +#define MBEDTLS_CIPHER_PADDING_ONE_AND_ZEROS +#define MBEDTLS_CIPHER_PADDING_ZEROS_AND_LEN +#define MBEDTLS_CIPHER_PADDING_ZEROS + +/** \def MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + * + * Uncomment this macro to use a 128-bit key in the CTR_DRBG module. + * By default, CTR_DRBG uses a 256-bit key. + */ +//#define MBEDTLS_CTR_DRBG_USE_128_BIT_KEY + +/** + * \def MBEDTLS_ENABLE_WEAK_CIPHERSUITES + * + * Enable weak ciphersuites in SSL / TLS. + * Warning: Only do so when you know what you are doing. This allows for + * channels with virtually no security at all! + * + * This enables the following ciphersuites: + * MBEDTLS_TLS_RSA_WITH_DES_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_DES_CBC_SHA + * + * Uncomment this macro to enable weak ciphersuites + * + * \warning DES is considered a weak cipher and its use constitutes a + * security risk. We recommend considering stronger ciphers instead. + */ +//#define MBEDTLS_ENABLE_WEAK_CIPHERSUITES + +/** + * \def MBEDTLS_REMOVE_ARC4_CIPHERSUITES + * + * Remove RC4 ciphersuites by default in SSL / TLS. + * This flag removes the ciphersuites based on RC4 from the default list as + * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible to + * enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including them + * explicitly. + * + * Uncomment this macro to remove RC4 ciphersuites by default. + */ +#define MBEDTLS_REMOVE_ARC4_CIPHERSUITES + +/** + * \def MBEDTLS_REMOVE_3DES_CIPHERSUITES + * + * Remove 3DES ciphersuites by default in SSL / TLS. + * This flag removes the ciphersuites based on 3DES from the default list as + * returned by mbedtls_ssl_list_ciphersuites(). However, it is still possible + * to enable (some of) them with mbedtls_ssl_conf_ciphersuites() by including + * them explicitly. + * + * A man-in-the-browser attacker can recover authentication tokens sent through + * a TLS connection using a 3DES based cipher suite (see "On the Practical + * (In-)Security of 64-bit Block Ciphers" by Karthikeyan Bhargavan and Gaëtan + * Leurent, see https://sweet32.info/SWEET32_CCS16.pdf). If this attack falls + * in your threat model or you are unsure, then you should keep this option + * enabled to remove 3DES based cipher suites. + * + * Comment this macro to keep 3DES in the default ciphersuite list. + */ +#define MBEDTLS_REMOVE_3DES_CIPHERSUITES + +/** + * Enable the verified implementations of ECDH primitives from Project Everest + * (currently only Curve25519). This feature changes the layout of ECDH + * contexts and therefore is a compatibility break for applications that access + * fields of a mbedtls_ecdh_context structure directly. See also + * MBEDTLS_ECDH_LEGACY_CONTEXT in include/mbedtls/ecdh.h. + * + * The Everest code is provided under the Apache 2.0 license only; therefore enabling this + * option is not compatible with taking the library under the GPL v2.0-or-later license. + */ +//#define MBEDTLS_ECDH_VARIANT_EVEREST_ENABLED + +/** + * \def MBEDTLS_ECP_DP_SECP192R1_ENABLED + * + * MBEDTLS_ECP_XXXX_ENABLED: Enables specific curves within the Elliptic Curve + * module. By default all supported curves are enabled. + * + * Comment macros to disable the curve and functions for it + */ +/* Short Weierstrass curves (supporting ECP, ECDH, ECDSA) */ +#define MBEDTLS_ECP_DP_SECP192R1_ENABLED +#define MBEDTLS_ECP_DP_SECP224R1_ENABLED +#define MBEDTLS_ECP_DP_SECP256R1_ENABLED +#define MBEDTLS_ECP_DP_SECP384R1_ENABLED +#define MBEDTLS_ECP_DP_SECP521R1_ENABLED +#define MBEDTLS_ECP_DP_SECP192K1_ENABLED +#define MBEDTLS_ECP_DP_SECP224K1_ENABLED +#define MBEDTLS_ECP_DP_SECP256K1_ENABLED +#define MBEDTLS_ECP_DP_BP256R1_ENABLED +#define MBEDTLS_ECP_DP_BP384R1_ENABLED +#define MBEDTLS_ECP_DP_BP512R1_ENABLED +/* Montgomery curves (supporting ECP) */ +#define MBEDTLS_ECP_DP_CURVE25519_ENABLED +#define MBEDTLS_ECP_DP_CURVE448_ENABLED + +/** + * \def MBEDTLS_ECP_NIST_OPTIM + * + * Enable specific 'modulo p' routines for each NIST prime. + * Depending on the prime and architecture, makes operations 4 to 8 times + * faster on the corresponding curve. + * + * Comment this macro to disable NIST curves optimisation. + */ +#define MBEDTLS_ECP_NIST_OPTIM + +/** + * \def MBEDTLS_ECP_NO_INTERNAL_RNG + * + * When this option is disabled, mbedtls_ecp_mul() will make use of an + * internal RNG when called with a NULL \c f_rng argument, in order to protect + * against some side-channel attacks. + * + * This protection introduces a dependency of the ECP module on one of the + * DRBG modules. For very constrained implementations that don't require this + * protection (for example, because you're only doing signature verification, + * so not manipulating any secret, or because local/physical side-channel + * attacks are outside your threat model), it might be desirable to get rid of + * that dependency. + * + * \warning Enabling this option makes some uses of ECP vulnerable to some + * side-channel attacks. Only enable it if you know that's not a problem for + * your use case. + * + * Uncomment this macro to disable some counter-measures in ECP. + */ +//#define MBEDTLS_ECP_NO_INTERNAL_RNG + +/** + * \def MBEDTLS_ECP_RESTARTABLE + * + * Enable "non-blocking" ECC operations that can return early and be resumed. + * + * This allows various functions to pause by returning + * #MBEDTLS_ERR_ECP_IN_PROGRESS (or, for functions in the SSL module, + * #MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS) and then be called later again in + * order to further progress and eventually complete their operation. This is + * controlled through mbedtls_ecp_set_max_ops() which limits the maximum + * number of ECC operations a function may perform before pausing; see + * mbedtls_ecp_set_max_ops() for more information. + * + * This is useful in non-threaded environments if you want to avoid blocking + * for too long on ECC (and, hence, X.509 or SSL/TLS) operations. + * + * This option: + * - Adds xxx_restartable() variants of existing operations in the + * following modules, with corresponding restart context types: + * - ECP (for Short Weierstrass curves only): scalar multiplication (mul), + * linear combination (muladd); + * - ECDSA: signature generation & verification; + * - PK: signature generation & verification; + * - X509: certificate chain verification. + * - Adds mbedtls_ecdh_enable_restart() in the ECDH module. + * - Changes the behaviour of TLS 1.2 clients (not servers) when using the + * ECDHE-ECDSA key exchange (not other key exchanges) to make all ECC + * computations restartable: + * - ECDH operations from the key exchange, only for Short Weierstrass + * curves; + * - verification of the server's key exchange signature; + * - verification of the server's certificate chain; + * - generation of the client's signature if client authentication is used, + * with an ECC key/certificate. + * + * \note In the cases above, the usual SSL/TLS functions, such as + * mbedtls_ssl_handshake(), can now return + * MBEDTLS_ERR_SSL_CRYPTO_IN_PROGRESS. + * + * \note This option only works with the default software implementation of + * elliptic curve functionality. It is incompatible with + * MBEDTLS_ECP_ALT, MBEDTLS_ECDH_XXX_ALT, MBEDTLS_ECDSA_XXX_ALT, + * MBEDTLS_ECDH_LEGACY_CONTEXT, and MBEDTLS_USE_PSA_CRYPTO. + * + * Requires: MBEDTLS_ECP_C + * + * Uncomment this macro to enable restartable ECC computations. + */ +//#define MBEDTLS_ECP_RESTARTABLE + +/** + * \def MBEDTLS_ECDH_LEGACY_CONTEXT + * + * Use a backward compatible ECDH context. + * + * Mbed TLS supports two formats for ECDH contexts (#mbedtls_ecdh_context + * defined in `ecdh.h`). For most applications, the choice of format makes + * no difference, since all library functions can work with either format, + * except that the new format is incompatible with MBEDTLS_ECP_RESTARTABLE. + + * The new format used when this option is disabled is smaller + * (56 bytes on a 32-bit platform). In future versions of the library, it + * will support alternative implementations of ECDH operations. + * The new format is incompatible with applications that access + * context fields directly and with restartable ECP operations. + * + * Define this macro if you enable MBEDTLS_ECP_RESTARTABLE or if you + * want to access ECDH context fields directly. Otherwise you should + * comment out this macro definition. + * + * This option has no effect if #MBEDTLS_ECDH_C is not enabled. + * + * \note This configuration option is experimental. Future versions of the + * library may modify the way the ECDH context layout is configured + * and may modify the layout of the new context type. + */ +#define MBEDTLS_ECDH_LEGACY_CONTEXT + +/** + * \def MBEDTLS_ECDSA_DETERMINISTIC + * + * Enable deterministic ECDSA (RFC 6979). + * Standard ECDSA is "fragile" in the sense that lack of entropy when signing + * may result in a compromise of the long-term signing key. This is avoided by + * the deterministic variant. + * + * Requires: MBEDTLS_HMAC_DRBG_C, MBEDTLS_ECDSA_C + * + * Comment this macro to disable deterministic ECDSA. + */ +//#define MBEDTLS_ECDSA_DETERMINISTIC + +/** + * \def MBEDTLS_KEY_EXCHANGE_PSK_ENABLED + * + * Enable the PSK based ciphersuite modes in SSL / TLS. + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA + */ +//#define MBEDTLS_KEY_EXCHANGE_PSK_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED + * + * Enable the DHE-PSK based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_DHM_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA + * + * \warning Using DHE constitutes a security risk as it + * is not possible to validate custom DH parameters. + * If possible, it is recommended users should consider + * preferring other methods of key exchange. + * See dhm.h for more details. + * + */ +//#define MBEDTLS_KEY_EXCHANGE_DHE_PSK_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED + * + * Enable the ECDHE-PSK based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_ECDH_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA + */ +//#define MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED + * + * Enable the RSA-PSK based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, + * MBEDTLS_X509_CRT_PARSE_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA + */ +//#define MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_RSA_ENABLED + * + * Enable the RSA-only based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, + * MBEDTLS_X509_CRT_PARSE_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5 + */ +//#define MBEDTLS_KEY_EXCHANGE_RSA_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED + * + * Enable the DHE-RSA based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_DHM_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, + * MBEDTLS_X509_CRT_PARSE_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA + * + * \warning Using DHE constitutes a security risk as it + * is not possible to validate custom DH parameters. + * If possible, it is recommended users should consider + * preferring other methods of key exchange. + * See dhm.h for more details. + * + */ +//#define MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED + * + * Enable the ECDHE-RSA based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_PKCS1_V15, + * MBEDTLS_X509_CRT_PARSE_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA + */ +//#define MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED + * + * Enable the ECDHE-ECDSA based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C, + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA + */ +//#define MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED + * + * Enable the ECDH-ECDSA based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_ECDH_C, MBEDTLS_ECDSA_C, MBEDTLS_X509_CRT_PARSE_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 + */ +//#define MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED + * + * Enable the ECDH-RSA based ciphersuite modes in SSL / TLS. + * + * Requires: MBEDTLS_ECDH_C, MBEDTLS_RSA_C, MBEDTLS_X509_CRT_PARSE_C + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 + */ +//#define MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED + +/** + * \def MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED + * + * Enable the ECJPAKE based ciphersuite modes in SSL / TLS. + * + * \warning This is currently experimental. EC J-PAKE support is based on the + * Thread v1.0.0 specification; incompatible changes to the specification + * might still happen. For this reason, this is disabled by default. + * + * Requires: MBEDTLS_ECJPAKE_C + * MBEDTLS_SHA256_C + * MBEDTLS_ECP_DP_SECP256R1_ENABLED + * + * This enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECJPAKE_WITH_AES_128_CCM_8 + */ +//#define MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED + +/** + * \def MBEDTLS_PK_PARSE_EC_EXTENDED + * + * Enhance support for reading EC keys using variants of SEC1 not allowed by + * RFC 5915 and RFC 5480. + * + * Currently this means parsing the SpecifiedECDomain choice of EC + * parameters (only known groups are supported, not arbitrary domains, to + * avoid validation issues). + * + * Disable if you only need to support RFC 5915 + 5480 key formats. + */ +#define MBEDTLS_PK_PARSE_EC_EXTENDED + +/** + * \def MBEDTLS_ERROR_STRERROR_DUMMY + * + * Enable a dummy error function to make use of mbedtls_strerror() in + * third party libraries easier when MBEDTLS_ERROR_C is disabled + * (no effect when MBEDTLS_ERROR_C is enabled). + * + * You can safely disable this if MBEDTLS_ERROR_C is enabled, or if you're + * not using mbedtls_strerror() or error_strerror() in your application. + * + * Disable if you run into name conflicts and want to really remove the + * mbedtls_strerror() + */ +#define MBEDTLS_ERROR_STRERROR_DUMMY + +/** + * \def MBEDTLS_GENPRIME + * + * Enable the prime-number generation code. + * + * Requires: MBEDTLS_BIGNUM_C + */ +#define MBEDTLS_GENPRIME + +/** + * \def MBEDTLS_FS_IO + * + * Enable functions that use the filesystem. + */ +#define MBEDTLS_FS_IO + +/** + * \def MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES + * + * Do not add default entropy sources. These are the platform specific, + * mbedtls_timing_hardclock and HAVEGE based poll functions. + * + * This is useful to have more control over the added entropy sources in an + * application. + * + * Uncomment this macro to prevent loading of default entropy functions. + */ +//#define MBEDTLS_NO_DEFAULT_ENTROPY_SOURCES + +/** + * \def MBEDTLS_NO_PLATFORM_ENTROPY + * + * Do not use built-in platform entropy functions. + * This is useful if your platform does not support + * standards like the /dev/urandom or Windows CryptoAPI. + * + * Uncomment this macro to disable the built-in platform entropy functions. + */ +//#define MBEDTLS_NO_PLATFORM_ENTROPY + +/** + * \def MBEDTLS_ENTROPY_FORCE_SHA256 + * + * Force the entropy accumulator to use a SHA-256 accumulator instead of the + * default SHA-512 based one (if both are available). + * + * Requires: MBEDTLS_SHA256_C + * + * On 32-bit systems SHA-256 can be much faster than SHA-512. Use this option + * if you have performance concerns. + * + * This option is only useful if both MBEDTLS_SHA256_C and + * MBEDTLS_SHA512_C are defined. Otherwise the available hash module is used. + */ +//#define MBEDTLS_ENTROPY_FORCE_SHA256 + +/** + * \def MBEDTLS_ENTROPY_NV_SEED + * + * Enable the non-volatile (NV) seed file-based entropy source. + * (Also enables the NV seed read/write functions in the platform layer) + * + * This is crucial (if not required) on systems that do not have a + * cryptographic entropy source (in hardware or kernel) available. + * + * Requires: MBEDTLS_ENTROPY_C, MBEDTLS_PLATFORM_C + * + * \note The read/write functions that are used by the entropy source are + * determined in the platform layer, and can be modified at runtime and/or + * compile-time depending on the flags (MBEDTLS_PLATFORM_NV_SEED_*) used. + * + * \note If you use the default implementation functions that read a seedfile + * with regular fopen(), please make sure you make a seedfile with the + * proper name (defined in MBEDTLS_PLATFORM_STD_NV_SEED_FILE) and at + * least MBEDTLS_ENTROPY_BLOCK_SIZE bytes in size that can be read from + * and written to or you will get an entropy source error! The default + * implementation will only use the first MBEDTLS_ENTROPY_BLOCK_SIZE + * bytes from the file. + * + * \note The entropy collector will write to the seed file before entropy is + * given to an external source, to update it. + */ +//#define MBEDTLS_ENTROPY_NV_SEED + +/* MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER + * + * Enable key identifiers that encode a key owner identifier. + * + * The owner of a key is identified by a value of type ::mbedtls_key_owner_id_t + * which is currently hard-coded to be int32_t. + * + * Note that this option is meant for internal use only and may be removed + * without notice. It is incompatible with MBEDTLS_USE_PSA_CRYPTO. + */ +//#define MBEDTLS_PSA_CRYPTO_KEY_ID_ENCODES_OWNER + +/** + * \def MBEDTLS_MEMORY_DEBUG + * + * Enable debugging of buffer allocator memory issues. Automatically prints + * (to stderr) all (fatal) messages on memory allocation issues. Enables + * function for 'debug output' of allocated memory. + * + * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C + * + * Uncomment this macro to let the buffer allocator print out error messages. + */ +//#define MBEDTLS_MEMORY_DEBUG + +/** + * \def MBEDTLS_MEMORY_BACKTRACE + * + * Include backtrace information with each allocated block. + * + * Requires: MBEDTLS_MEMORY_BUFFER_ALLOC_C + * GLIBC-compatible backtrace() and backtrace_symbols() support + * + * Uncomment this macro to include backtrace information + */ +//#define MBEDTLS_MEMORY_BACKTRACE + +/** + * \def MBEDTLS_PK_RSA_ALT_SUPPORT + * + * Support external private RSA keys (eg from a HSM) in the PK layer. + * + * Comment this macro to disable support for external private RSA keys. + */ +#define MBEDTLS_PK_RSA_ALT_SUPPORT + +/** + * \def MBEDTLS_PKCS1_V15 + * + * Enable support for PKCS#1 v1.5 encoding. + * + * Requires: MBEDTLS_RSA_C + * + * This enables support for PKCS#1 v1.5 operations. + */ +#define MBEDTLS_PKCS1_V15 + +/** + * \def MBEDTLS_PKCS1_V21 + * + * Enable support for PKCS#1 v2.1 encoding. + * + * Requires: MBEDTLS_MD_C, MBEDTLS_RSA_C + * + * This enables support for RSAES-OAEP and RSASSA-PSS operations. + */ +#define MBEDTLS_PKCS1_V21 + +/** \def MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS + * + * Enable support for platform built-in keys. If you enable this feature, + * you must implement the function mbedtls_psa_platform_get_builtin_key(). + * See the documentation of that function for more information. + * + * Built-in keys are typically derived from a hardware unique key or + * stored in a secure element. + * + * Requires: MBEDTLS_PSA_CRYPTO_C. + * + * \warning This interface is experimental and may change or be removed + * without notice. + */ +//#define MBEDTLS_PSA_CRYPTO_BUILTIN_KEYS + +/** \def MBEDTLS_PSA_CRYPTO_CLIENT + * + * Enable support for PSA crypto client. + * + * \note This option allows to include the code necessary for a PSA + * crypto client when the PSA crypto implementation is not included in + * the library (MBEDTLS_PSA_CRYPTO_C disabled). The code included is the + * code to set and get PSA key attributes. + * The development of PSA drivers partially relying on the library to + * fulfill the hardware gaps is another possible usage of this option. + * + * \warning This interface is experimental and may change or be removed + * without notice. + */ +//#define MBEDTLS_PSA_CRYPTO_CLIENT + +/** \def MBEDTLS_PSA_CRYPTO_DRIVERS + * + * Enable support for the experimental PSA crypto driver interface. + * + * Requires: MBEDTLS_PSA_CRYPTO_C + * + * \warning This interface is experimental and may change or be removed + * without notice. + */ +//#define MBEDTLS_PSA_CRYPTO_DRIVERS + +/** \def MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG + * + * Make the PSA Crypto module use an external random generator provided + * by a driver, instead of Mbed TLS's entropy and DRBG modules. + * + * \note This random generator must deliver random numbers with cryptographic + * quality and high performance. It must supply unpredictable numbers + * with a uniform distribution. The implementation of this function + * is responsible for ensuring that the random generator is seeded + * with sufficient entropy. If you have a hardware TRNG which is slow + * or delivers non-uniform output, declare it as an entropy source + * with mbedtls_entropy_add_source() instead of enabling this option. + * + * If you enable this option, you must configure the type + * ::mbedtls_psa_external_random_context_t in psa/crypto_platform.h + * and define a function called mbedtls_psa_external_get_random() + * with the following prototype: + * ``` + * psa_status_t mbedtls_psa_external_get_random( + * mbedtls_psa_external_random_context_t *context, + * uint8_t *output, size_t output_size, size_t *output_length); + * ); + * ``` + * The \c context value is initialized to 0 before the first call. + * The function must fill the \c output buffer with \c output_size bytes + * of random data and set \c *output_length to \c output_size. + * + * Requires: MBEDTLS_PSA_CRYPTO_C + * + * \warning If you enable this option, code that uses the PSA cryptography + * interface will not use any of the entropy sources set up for + * the entropy module, nor the NV seed that MBEDTLS_ENTROPY_NV_SEED + * enables. + * + * \note This option is experimental and may be removed without notice. + */ +//#define MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG + +/** + * \def MBEDTLS_PSA_CRYPTO_SPM + * + * When MBEDTLS_PSA_CRYPTO_SPM is defined, the code is built for SPM (Secure + * Partition Manager) integration which separates the code into two parts: a + * NSPE (Non-Secure Process Environment) and an SPE (Secure Process + * Environment). + * + * Module: library/psa_crypto.c + * Requires: MBEDTLS_PSA_CRYPTO_C + * + */ +//#define MBEDTLS_PSA_CRYPTO_SPM + +/** + * \def MBEDTLS_PSA_INJECT_ENTROPY + * + * Enable support for entropy injection at first boot. This feature is + * required on systems that do not have a built-in entropy source (TRNG). + * This feature is currently not supported on systems that have a built-in + * entropy source. + * + * Requires: MBEDTLS_PSA_CRYPTO_STORAGE_C, MBEDTLS_ENTROPY_NV_SEED + * + */ +//#define MBEDTLS_PSA_INJECT_ENTROPY + +/** + * \def MBEDTLS_RSA_NO_CRT + * + * Do not use the Chinese Remainder Theorem + * for the RSA private operation. + * + * Uncomment this macro to disable the use of CRT in RSA. + * + */ +//#define MBEDTLS_RSA_NO_CRT + +/** + * \def MBEDTLS_SELF_TEST + * + * Enable the checkup functions (*_self_test). + */ +#define MBEDTLS_SELF_TEST + +/** + * \def MBEDTLS_SHA256_SMALLER + * + * Enable an implementation of SHA-256 that has lower ROM footprint but also + * lower performance. + * + * The default implementation is meant to be a reasonable compromise between + * performance and size. This version optimizes more aggressively for size at + * the expense of performance. Eg on Cortex-M4 it reduces the size of + * mbedtls_sha256_process() from ~2KB to ~0.5KB for a performance hit of about + * 30%. + * + * Uncomment to enable the smaller implementation of SHA256. + */ +//#define MBEDTLS_SHA256_SMALLER + +/** + * \def MBEDTLS_SHA512_SMALLER + * + * Enable an implementation of SHA-512 that has lower ROM footprint but also + * lower performance. + * + * Uncomment to enable the smaller implementation of SHA512. + */ +//#define MBEDTLS_SHA512_SMALLER + +/** + * \def MBEDTLS_SHA512_NO_SHA384 + * + * Disable the SHA-384 option of the SHA-512 module. Use this to save some + * code size on devices that don't use SHA-384. + * + * Requires: MBEDTLS_SHA512_C + * + * Uncomment to disable SHA-384 + */ +//#define MBEDTLS_SHA512_NO_SHA384 + +/** + * \def MBEDTLS_SSL_ALL_ALERT_MESSAGES + * + * Enable sending of alert messages in case of encountered errors as per RFC. + * If you choose not to send the alert messages, Mbed TLS can still communicate + * with other servers, only debugging of failures is harder. + * + * The advantage of not sending alert messages, is that no information is given + * about reasons for failures thus preventing adversaries of gaining intel. + * + * Enable sending of all alert messages + */ +//#define MBEDTLS_SSL_ALL_ALERT_MESSAGES + +/** + * \def MBEDTLS_SSL_RECORD_CHECKING + * + * Enable the function mbedtls_ssl_check_record() which can be used to check + * the validity and authenticity of an incoming record, to verify that it has + * not been seen before. These checks are performed without modifying the + * externally visible state of the SSL context. + * + * See mbedtls_ssl_check_record() for more information. + * + * Uncomment to enable support for record checking. + */ +//#define MBEDTLS_SSL_RECORD_CHECKING + +/** + * \def MBEDTLS_SSL_DTLS_CONNECTION_ID + * + * Enable support for the DTLS Connection ID extension + * (version draft-ietf-tls-dtls-connection-id-05, + * https://tools.ietf.org/html/draft-ietf-tls-dtls-connection-id-05) + * which allows to identify DTLS connections across changes + * in the underlying transport. + * + * Setting this option enables the SSL APIs `mbedtls_ssl_set_cid()`, + * `mbedtls_ssl_get_peer_cid()` and `mbedtls_ssl_conf_cid()`. + * See the corresponding documentation for more information. + * + * \warning The Connection ID extension is still in draft state. + * We make no stability promises for the availability + * or the shape of the API controlled by this option. + * + * The maximum lengths of outgoing and incoming CIDs can be configured + * through the options + * - MBEDTLS_SSL_CID_OUT_LEN_MAX + * - MBEDTLS_SSL_CID_IN_LEN_MAX. + * + * Requires: MBEDTLS_SSL_PROTO_DTLS + * + * Uncomment to enable the Connection ID extension. + */ +//#define MBEDTLS_SSL_DTLS_CONNECTION_ID + +/** + * \def MBEDTLS_SSL_ASYNC_PRIVATE + * + * Enable asynchronous external private key operations in SSL. This allows + * you to configure an SSL connection to call an external cryptographic + * module to perform private key operations instead of performing the + * operation inside the library. + * + */ +//#define MBEDTLS_SSL_ASYNC_PRIVATE + +/** + * \def MBEDTLS_SSL_CONTEXT_SERIALIZATION + * + * Enable serialization of the TLS context structures, through use of the + * functions mbedtls_ssl_context_save() and mbedtls_ssl_context_load(). + * + * This pair of functions allows one side of a connection to serialize the + * context associated with the connection, then free or re-use that context + * while the serialized state is persisted elsewhere, and finally deserialize + * that state to a live context for resuming read/write operations on the + * connection. From a protocol perspective, the state of the connection is + * unaffected, in particular this is entirely transparent to the peer. + * + * Note: this is distinct from TLS session resumption, which is part of the + * protocol and fully visible by the peer. TLS session resumption enables + * establishing new connections associated to a saved session with shorter, + * lighter handshakes, while context serialization is a local optimization in + * handling a single, potentially long-lived connection. + * + * Enabling these APIs makes some SSL structures larger, as 64 extra bytes are + * saved after the handshake to allow for more efficient serialization, so if + * you don't need this feature you'll save RAM by disabling it. + * + * Requires: MBEDTLS_GCM_C or MBEDTLS_CCM_C or MBEDTLS_CHACHAPOLY_C + * + * Comment to disable the context serialization APIs. + */ +//#define MBEDTLS_SSL_CONTEXT_SERIALIZATION + +/** + * \def MBEDTLS_SSL_DEBUG_ALL + * + * Enable the debug messages in SSL module for all issues. + * Debug messages have been disabled in some places to prevent timing + * attacks due to (unbalanced) debugging function calls. + * + * If you need all error reporting you should enable this during debugging, + * but remove this for production servers that should log as well. + * + * Uncomment this macro to report all debug messages on errors introducing + * a timing side-channel. + * + */ +//#define MBEDTLS_SSL_DEBUG_ALL + +/** \def MBEDTLS_SSL_ENCRYPT_THEN_MAC + * + * Enable support for Encrypt-then-MAC, RFC 7366. + * + * This allows peers that both support it to use a more robust protection for + * ciphersuites using CBC, providing deep resistance against timing attacks + * on the padding or underlying cipher. + * + * This only affects CBC ciphersuites, and is useless if none is defined. + * + * Requires: MBEDTLS_SSL_PROTO_TLS1 or + * MBEDTLS_SSL_PROTO_TLS1_1 or + * MBEDTLS_SSL_PROTO_TLS1_2 + * + * Comment this macro to disable support for Encrypt-then-MAC + */ +//#define MBEDTLS_SSL_ENCRYPT_THEN_MAC + +/** \def MBEDTLS_SSL_EXTENDED_MASTER_SECRET + * + * Enable support for RFC 7627: Session Hash and Extended Master Secret + * Extension. + * + * This was introduced as "the proper fix" to the Triple Handshake family of + * attacks, but it is recommended to always use it (even if you disable + * renegotiation), since it actually fixes a more fundamental issue in the + * original SSL/TLS design, and has implications beyond Triple Handshake. + * + * Requires: MBEDTLS_SSL_PROTO_TLS1 or + * MBEDTLS_SSL_PROTO_TLS1_1 or + * MBEDTLS_SSL_PROTO_TLS1_2 + * + * Comment this macro to disable support for Extended Master Secret. + */ +//#define MBEDTLS_SSL_EXTENDED_MASTER_SECRET + +/** + * \def MBEDTLS_SSL_FALLBACK_SCSV + * + * Enable support for RFC 7507: Fallback Signaling Cipher Suite Value (SCSV) + * for Preventing Protocol Downgrade Attacks. + * + * For servers, it is recommended to always enable this, unless you support + * only one version of TLS, or know for sure that none of your clients + * implements a fallback strategy. + * + * For clients, you only need this if you're using a fallback strategy, which + * is not recommended in the first place, unless you absolutely need it to + * interoperate with buggy (version-intolerant) servers. + * + * Comment this macro to disable support for FALLBACK_SCSV + */ +//#define MBEDTLS_SSL_FALLBACK_SCSV + +/** + * \def MBEDTLS_SSL_KEEP_PEER_CERTIFICATE + * + * This option controls the availability of the API mbedtls_ssl_get_peer_cert() + * giving access to the peer's certificate after completion of the handshake. + * + * Unless you need mbedtls_ssl_peer_cert() in your application, it is + * recommended to disable this option for reduced RAM usage. + * + * \note If this option is disabled, mbedtls_ssl_get_peer_cert() is still + * defined, but always returns \c NULL. + * + * \note This option has no influence on the protection against the + * triple handshake attack. Even if it is disabled, Mbed TLS will + * still ensure that certificates do not change during renegotiation, + * for example by keeping a hash of the peer's certificate. + * + * Comment this macro to disable storing the peer's certificate + * after the handshake. + */ +//#define MBEDTLS_SSL_KEEP_PEER_CERTIFICATE + +/** + * \def MBEDTLS_SSL_HW_RECORD_ACCEL + * + * Enable hooking functions in SSL module for hardware acceleration of + * individual records. + * + * \deprecated This option is deprecated and will be removed in a future + * version of Mbed TLS. + * + * Uncomment this macro to enable hooking functions. + */ +//#define MBEDTLS_SSL_HW_RECORD_ACCEL + +/** + * \def MBEDTLS_SSL_CBC_RECORD_SPLITTING + * + * Enable 1/n-1 record splitting for CBC mode in SSLv3 and TLS 1.0. + * + * This is a countermeasure to the BEAST attack, which also minimizes the risk + * of interoperability issues compared to sending 0-length records. + * + * Comment this macro to disable 1/n-1 record splitting. + */ +//#define MBEDTLS_SSL_CBC_RECORD_SPLITTING + +/** + * \def MBEDTLS_SSL_RENEGOTIATION + * + * Enable support for TLS renegotiation. + * + * The two main uses of renegotiation are (1) refresh keys on long-lived + * connections and (2) client authentication after the initial handshake. + * If you don't need renegotiation, it's probably better to disable it, since + * it has been associated with security issues in the past and is easy to + * misuse/misunderstand. + * + * Comment this to disable support for renegotiation. + * + * \note Even if this option is disabled, both client and server are aware + * of the Renegotiation Indication Extension (RFC 5746) used to + * prevent the SSL renegotiation attack (see RFC 5746 Sect. 1). + * (See \c mbedtls_ssl_conf_legacy_renegotiation for the + * configuration of this extension). + * + */ +//#define MBEDTLS_SSL_RENEGOTIATION + +/** + * \def MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO + * + * Enable support for receiving and parsing SSLv2 Client Hello messages for the + * SSL Server module (MBEDTLS_SSL_SRV_C). + * + * \deprecated This option is deprecated and will be removed in a future + * version of Mbed TLS. + * + * Uncomment this macro to enable support for SSLv2 Client Hello messages. + */ +//#define MBEDTLS_SSL_SRV_SUPPORT_SSLV2_CLIENT_HELLO + +/** + * \def MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE + * + * Pick the ciphersuite according to the client's preferences rather than ours + * in the SSL Server module (MBEDTLS_SSL_SRV_C). + * + * Uncomment this macro to respect client's ciphersuite order + */ +//#define MBEDTLS_SSL_SRV_RESPECT_CLIENT_PREFERENCE + +/** + * \def MBEDTLS_SSL_MAX_FRAGMENT_LENGTH + * + * Enable support for RFC 6066 max_fragment_length extension in SSL. + * + * Comment this macro to disable support for the max_fragment_length extension + */ +//#define MBEDTLS_SSL_MAX_FRAGMENT_LENGTH + +/** + * \def MBEDTLS_SSL_PROTO_SSL3 + * + * Enable support for SSL 3.0. + * + * Requires: MBEDTLS_MD5_C + * MBEDTLS_SHA1_C + * + * \deprecated This option is deprecated and will be removed in a future + * version of Mbed TLS. + * + * Comment this macro to disable support for SSL 3.0 + */ +//#define MBEDTLS_SSL_PROTO_SSL3 + +/** + * \def MBEDTLS_SSL_PROTO_TLS1 + * + * Enable support for TLS 1.0. + * + * Requires: MBEDTLS_MD5_C + * MBEDTLS_SHA1_C + * + * Comment this macro to disable support for TLS 1.0 + */ +//#define MBEDTLS_SSL_PROTO_TLS1 + +/** + * \def MBEDTLS_SSL_PROTO_TLS1_1 + * + * Enable support for TLS 1.1 (and DTLS 1.0 if DTLS is enabled). + * + * Requires: MBEDTLS_MD5_C + * MBEDTLS_SHA1_C + * + * Comment this macro to disable support for TLS 1.1 / DTLS 1.0 + */ +//#define MBEDTLS_SSL_PROTO_TLS1_1 + +/** + * \def MBEDTLS_SSL_PROTO_TLS1_2 + * + * Enable support for TLS 1.2 (and DTLS 1.2 if DTLS is enabled). + * + * Requires: MBEDTLS_SHA1_C or MBEDTLS_SHA256_C or MBEDTLS_SHA512_C + * (Depends on ciphersuites) + * + * Comment this macro to disable support for TLS 1.2 / DTLS 1.2 + */ +//#define MBEDTLS_SSL_PROTO_TLS1_2 + +/** + * \def MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL + * + * This macro is used to selectively enable experimental parts + * of the code that contribute to the ongoing development of + * the prototype TLS 1.3 and DTLS 1.3 implementation, and provide + * no other purpose. + * + * \warning TLS 1.3 and DTLS 1.3 aren't yet supported in Mbed TLS, + * and no feature exposed through this macro is part of the + * public API. In particular, features under the control + * of this macro are experimental and don't come with any + * stability guarantees. + * + * Uncomment this macro to enable experimental and partial + * functionality specific to TLS 1.3. + */ +//#define MBEDTLS_SSL_PROTO_TLS1_3_EXPERIMENTAL + +/** + * \def MBEDTLS_SSL_PROTO_DTLS + * + * Enable support for DTLS (all available versions). + * + * Enable this and MBEDTLS_SSL_PROTO_TLS1_1 to enable DTLS 1.0, + * and/or this and MBEDTLS_SSL_PROTO_TLS1_2 to enable DTLS 1.2. + * + * Requires: MBEDTLS_SSL_PROTO_TLS1_1 + * or MBEDTLS_SSL_PROTO_TLS1_2 + * + * Comment this macro to disable support for DTLS + */ +//#define MBEDTLS_SSL_PROTO_DTLS + +/** + * \def MBEDTLS_SSL_ALPN + * + * Enable support for RFC 7301 Application Layer Protocol Negotiation. + * + * Comment this macro to disable support for ALPN. + */ +//#define MBEDTLS_SSL_ALPN + +/** + * \def MBEDTLS_SSL_DTLS_ANTI_REPLAY + * + * Enable support for the anti-replay mechanism in DTLS. + * + * Requires: MBEDTLS_SSL_TLS_C + * MBEDTLS_SSL_PROTO_DTLS + * + * \warning Disabling this is often a security risk! + * See mbedtls_ssl_conf_dtls_anti_replay() for details. + * + * Comment this to disable anti-replay in DTLS. + */ +//#define MBEDTLS_SSL_DTLS_ANTI_REPLAY + +/** + * \def MBEDTLS_SSL_DTLS_HELLO_VERIFY + * + * Enable support for HelloVerifyRequest on DTLS servers. + * + * This feature is highly recommended to prevent DTLS servers being used as + * amplifiers in DoS attacks against other hosts. It should always be enabled + * unless you know for sure amplification cannot be a problem in the + * environment in which your server operates. + * + * \warning Disabling this can be a security risk! (see above) + * + * Requires: MBEDTLS_SSL_PROTO_DTLS + * + * Comment this to disable support for HelloVerifyRequest. + */ +//#define MBEDTLS_SSL_DTLS_HELLO_VERIFY + +/** + * \def MBEDTLS_SSL_DTLS_SRTP + * + * Enable support for negotiation of DTLS-SRTP (RFC 5764) + * through the use_srtp extension. + * + * \note This feature provides the minimum functionality required + * to negotiate the use of DTLS-SRTP and to allow the derivation of + * the associated SRTP packet protection key material. + * In particular, the SRTP packet protection itself, as well as the + * demultiplexing of RTP and DTLS packets at the datagram layer + * (see Section 5 of RFC 5764), are not handled by this feature. + * Instead, after successful completion of a handshake negotiating + * the use of DTLS-SRTP, the extended key exporter API + * mbedtls_ssl_conf_export_keys_ext_cb() should be used to implement + * the key exporter described in Section 4.2 of RFC 5764 and RFC 5705 + * (this is implemented in the SSL example programs). + * The resulting key should then be passed to an SRTP stack. + * + * Setting this option enables the runtime API + * mbedtls_ssl_conf_dtls_srtp_protection_profiles() + * through which the supported DTLS-SRTP protection + * profiles can be configured. You must call this API at + * runtime if you wish to negotiate the use of DTLS-SRTP. + * + * Requires: MBEDTLS_SSL_PROTO_DTLS + * + * Uncomment this to enable support for use_srtp extension. + */ +//#define MBEDTLS_SSL_DTLS_SRTP + +/** + * \def MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE + * + * Enable server-side support for clients that reconnect from the same port. + * + * Some clients unexpectedly close the connection and try to reconnect using the + * same source port. This needs special support from the server to handle the + * new connection securely, as described in section 4.2.8 of RFC 6347. This + * flag enables that support. + * + * Requires: MBEDTLS_SSL_DTLS_HELLO_VERIFY + * + * Comment this to disable support for clients reusing the source port. + */ +//#define MBEDTLS_SSL_DTLS_CLIENT_PORT_REUSE + +/** + * \def MBEDTLS_SSL_DTLS_BADMAC_LIMIT + * + * Enable support for a limit of records with bad MAC. + * + * See mbedtls_ssl_conf_dtls_badmac_limit(). + * + * Requires: MBEDTLS_SSL_PROTO_DTLS + */ +//#define MBEDTLS_SSL_DTLS_BADMAC_LIMIT + +/** + * \def MBEDTLS_SSL_SESSION_TICKETS + * + * Enable support for RFC 5077 session tickets in SSL. + * Client-side, provides full support for session tickets (maintenance of a + * session store remains the responsibility of the application, though). + * Server-side, you also need to provide callbacks for writing and parsing + * tickets, including authenticated encryption and key management. Example + * callbacks are provided by MBEDTLS_SSL_TICKET_C. + * + * Comment this macro to disable support for SSL session tickets + */ +//#define MBEDTLS_SSL_SESSION_TICKETS + +/** + * \def MBEDTLS_SSL_EXPORT_KEYS + * + * Enable support for exporting key block and master secret. + * This is required for certain users of TLS, e.g. EAP-TLS. + * + * Comment this macro to disable support for key export + */ +//#define MBEDTLS_SSL_EXPORT_KEYS + +/** + * \def MBEDTLS_SSL_SERVER_NAME_INDICATION + * + * Enable support for RFC 6066 server name indication (SNI) in SSL. + * + * Requires: MBEDTLS_X509_CRT_PARSE_C + * + * Comment this macro to disable support for server name indication in SSL + */ +//#define MBEDTLS_SSL_SERVER_NAME_INDICATION + +/** + * \def MBEDTLS_SSL_TRUNCATED_HMAC + * + * Enable support for RFC 6066 truncated HMAC in SSL. + * + * Comment this macro to disable support for truncated HMAC in SSL + */ +//#define MBEDTLS_SSL_TRUNCATED_HMAC + +/** + * \def MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT + * + * Fallback to old (pre-2.7), non-conforming implementation of the truncated + * HMAC extension which also truncates the HMAC key. Note that this option is + * only meant for a transitory upgrade period and will be removed in a future + * version of the library. + * + * \warning The old implementation is non-compliant and has a security weakness + * (2^80 brute force attack on the HMAC key used for a single, + * uninterrupted connection). This should only be enabled temporarily + * when (1) the use of truncated HMAC is essential in order to save + * bandwidth, and (2) the peer is an Mbed TLS stack that doesn't use + * the fixed implementation yet (pre-2.7). + * + * \deprecated This option is deprecated and will be removed in a + * future version of Mbed TLS. + * + * Uncomment to fallback to old, non-compliant truncated HMAC implementation. + * + * Requires: MBEDTLS_SSL_TRUNCATED_HMAC + */ +//#define MBEDTLS_SSL_TRUNCATED_HMAC_COMPAT + +/** + * \def MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH + * + * When this option is enabled, the SSL buffer will be resized automatically + * based on the negotiated maximum fragment length in each direction. + * + * Requires: MBEDTLS_SSL_MAX_FRAGMENT_LENGTH + */ +//#define MBEDTLS_SSL_VARIABLE_BUFFER_LENGTH + +/** + * Allow SHA-1 in the default TLS configuration for TLS 1.2 handshake + * signature and ciphersuite selection. Without this build-time option, SHA-1 + * support must be activated explicitly through mbedtls_ssl_conf_sig_hashes. + * The use of SHA-1 in TLS <= 1.1 and in HMAC-SHA-1 is always allowed by + * default. At the time of writing, there is no practical attack on the use + * of SHA-1 in handshake signatures, hence this option is turned on by default + * to preserve compatibility with existing peers, but the general + * warning applies nonetheless: + * + * \warning SHA-1 is considered a weak message digest and its use constitutes + * a security risk. If possible, we recommend avoiding dependencies + * on it, and considering stronger message digests instead. + * + */ +//#define MBEDTLS_TLS_DEFAULT_ALLOW_SHA1_IN_KEY_EXCHANGE + +/** + * \def MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN + * + * Enable testing of the constant-flow nature of some sensitive functions with + * clang's MemorySanitizer. This causes some existing tests to also test + * this non-functional property of the code under test. + * + * This setting requires compiling with clang -fsanitize=memory. The test + * suites can then be run normally. + * + * \warning This macro is only used for extended testing; it is not considered + * part of the library's API, so it may change or disappear at any time. + * + * Uncomment to enable testing of the constant-flow nature of selected code. + */ +//#define MBEDTLS_TEST_CONSTANT_FLOW_MEMSAN + +/** + * \def MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND + * + * Enable testing of the constant-flow nature of some sensitive functions with + * valgrind's memcheck tool. This causes some existing tests to also test + * this non-functional property of the code under test. + * + * This setting requires valgrind headers for building, and is only useful for + * testing if the tests suites are run with valgrind's memcheck. This can be + * done for an individual test suite with 'valgrind ./test_suite_xxx', or when + * using CMake, this can be done for all test suites with 'make memcheck'. + * + * \warning This macro is only used for extended testing; it is not considered + * part of the library's API, so it may change or disappear at any time. + * + * Uncomment to enable testing of the constant-flow nature of selected code. + */ +//#define MBEDTLS_TEST_CONSTANT_FLOW_VALGRIND + +/** + * \def MBEDTLS_TEST_HOOKS + * + * Enable features for invasive testing such as introspection functions and + * hooks for fault injection. This enables additional unit tests. + * + * Merely enabling this feature should not change the behavior of the product. + * It only adds new code, and new branching points where the default behavior + * is the same as when this feature is disabled. + * However, this feature increases the attack surface: there is an added + * risk of vulnerabilities, and more gadgets that can make exploits easier. + * Therefore this feature must never be enabled in production. + * + * See `docs/architecture/testing/mbed-crypto-invasive-testing.md` for more + * information. + * + * Uncomment to enable invasive tests. + */ +//#define MBEDTLS_TEST_HOOKS + +/** + * \def MBEDTLS_THREADING_ALT + * + * Provide your own alternate threading implementation. + * + * Requires: MBEDTLS_THREADING_C + * + * Uncomment this to allow your own alternate threading implementation. + */ +//#define MBEDTLS_THREADING_ALT + +/** + * \def MBEDTLS_THREADING_PTHREAD + * + * Enable the pthread wrapper layer for the threading layer. + * + * Requires: MBEDTLS_THREADING_C + * + * Uncomment this to enable pthread mutexes. + */ +//#define MBEDTLS_THREADING_PTHREAD + +/** + * \def MBEDTLS_USE_PSA_CRYPTO + * + * Make the X.509 and TLS library use PSA for cryptographic operations, and + * enable new APIs for using keys handled by PSA Crypto. + * + * \note Development of this option is currently in progress, and parts of Mbed + * TLS's X.509 and TLS modules are not ported to PSA yet. However, these parts + * will still continue to work as usual, so enabling this option should not + * break backwards compatibility. + * + * \note See docs/use-psa-crypto.md for a complete description of what this + * option currently does, and of parts that are not affected by it so far. + * + * \warning This option enables new Mbed TLS APIs which are currently + * considered experimental and may change in incompatible ways at any time. + * That is, the APIs enabled by this option are not covered by the usual + * promises of API stability. + * + * Requires: MBEDTLS_PSA_CRYPTO_C. + * + * Uncomment this to enable internal use of PSA Crypto and new associated APIs. + */ +//#define MBEDTLS_USE_PSA_CRYPTO + +/** + * \def MBEDTLS_PSA_CRYPTO_CONFIG + * + * This setting allows support for cryptographic mechanisms through the PSA + * API to be configured separately from support through the mbedtls API. + * + * When this option is disabled, the PSA API exposes the cryptographic + * mechanisms that can be implemented on top of the `mbedtls_xxx` API + * configured with `MBEDTLS_XXX` symbols. + * + * When this option is enabled, the PSA API exposes the cryptographic + * mechanisms requested by the `PSA_WANT_XXX` symbols defined in + * include/psa/crypto_config.h. The corresponding `MBEDTLS_XXX` settings are + * automatically enabled if required (i.e. if no PSA driver provides the + * mechanism). You may still freely enable additional `MBEDTLS_XXX` symbols + * in config.h. + * + * If the symbol #MBEDTLS_PSA_CRYPTO_CONFIG_FILE is defined, it specifies + * an alternative header to include instead of include/psa/crypto_config.h. + * + * If you enable this option and write your own configuration file, you must + * include mbedtls/config_psa.h in your configuration file. The default + * provided mbedtls/config.h contains the necessary inclusion. + * + * This feature is still experimental and is not ready for production since + * it is not completed. + */ +//#define MBEDTLS_PSA_CRYPTO_CONFIG + +/** + * \def MBEDTLS_VERSION_FEATURES + * + * Allow run-time checking of compile-time enabled features. Thus allowing users + * to check at run-time if the library is for instance compiled with threading + * support via mbedtls_version_check_feature(). + * + * Requires: MBEDTLS_VERSION_C + * + * Comment this to disable run-time checking and save ROM space + */ +#define MBEDTLS_VERSION_FEATURES + +/** + * \def MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3 + * + * If set, the X509 parser will not break-off when parsing an X509 certificate + * and encountering an extension in a v1 or v2 certificate. + * + * Uncomment to prevent an error. + */ +//#define MBEDTLS_X509_ALLOW_EXTENSIONS_NON_V3 + +/** + * \def MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION + * + * If set, the X509 parser will not break-off when parsing an X509 certificate + * and encountering an unknown critical extension. + * + * \warning Depending on your PKI use, enabling this can be a security risk! + * + * Uncomment to prevent an error. + */ +//#define MBEDTLS_X509_ALLOW_UNSUPPORTED_CRITICAL_EXTENSION + +/** + * \def MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK + * + * If set, this enables the X.509 API `mbedtls_x509_crt_verify_with_ca_cb()` + * and the SSL API `mbedtls_ssl_conf_ca_cb()` which allow users to configure + * the set of trusted certificates through a callback instead of a linked + * list. + * + * This is useful for example in environments where a large number of trusted + * certificates is present and storing them in a linked list isn't efficient + * enough, or when the set of trusted certificates changes frequently. + * + * See the documentation of `mbedtls_x509_crt_verify_with_ca_cb()` and + * `mbedtls_ssl_conf_ca_cb()` for more information. + * + * Uncomment to enable trusted certificate callbacks. + */ +//#define MBEDTLS_X509_TRUSTED_CERTIFICATE_CALLBACK + +/** + * \def MBEDTLS_X509_CHECK_KEY_USAGE + * + * Enable verification of the keyUsage extension (CA and leaf certificates). + * + * Disabling this avoids problems with mis-issued and/or misused + * (intermediate) CA and leaf certificates. + * + * \warning Depending on your PKI use, disabling this can be a security risk! + * + * Comment to skip keyUsage checking for both CA and leaf certificates. + */ +//#define MBEDTLS_X509_CHECK_KEY_USAGE + +/** + * \def MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE + * + * Enable verification of the extendedKeyUsage extension (leaf certificates). + * + * Disabling this avoids problems with mis-issued and/or misused certificates. + * + * \warning Depending on your PKI use, disabling this can be a security risk! + * + * Comment to skip extendedKeyUsage checking for certificates. + */ +//#define MBEDTLS_X509_CHECK_EXTENDED_KEY_USAGE + +/** + * \def MBEDTLS_X509_RSASSA_PSS_SUPPORT + * + * Enable parsing and verification of X.509 certificates, CRLs and CSRS + * signed with RSASSA-PSS (aka PKCS#1 v2.1). + * + * Comment this macro to disallow using RSASSA-PSS in certificates. + */ +//#define MBEDTLS_X509_RSASSA_PSS_SUPPORT + +/** + * \def MBEDTLS_ZLIB_SUPPORT + * + * If set, the SSL/TLS module uses ZLIB to support compression and + * decompression of packet data. + * + * \warning TLS-level compression MAY REDUCE SECURITY! See for example the + * CRIME attack. Before enabling this option, you should examine with care if + * CRIME or similar exploits may be applicable to your use case. + * + * \note Currently compression can't be used with DTLS. + * + * \deprecated This feature is deprecated and will be removed + * in the next major revision of the library. + * + * Used in: library/ssl_tls.c + * library/ssl_cli.c + * library/ssl_srv.c + * + * This feature requires zlib library and headers to be present. + * + * Uncomment to enable use of ZLIB + */ +//#define MBEDTLS_ZLIB_SUPPORT +/** \} name SECTION: Mbed TLS feature support */ + +/** + * \name SECTION: Mbed TLS modules + * + * This section enables or disables entire modules in Mbed TLS + * \{ + */ + +/** + * \def MBEDTLS_AESNI_C + * + * Enable AES-NI support on x86-64 or x86-32. + * + * \note AESNI is only supported with certain compilers and target options: + * - Visual Studio 2013: supported. + * - GCC, x86-64, target not explicitly supporting AESNI: + * requires MBEDTLS_HAVE_ASM. + * - GCC, x86-32, target not explicitly supporting AESNI: + * not supported. + * - GCC, x86-64 or x86-32, target supporting AESNI: supported. + * For this assembly-less implementation, you must currently compile + * `library/aesni.c` and `library/aes.c` with machine options to enable + * SSE2 and AESNI instructions: `gcc -msse2 -maes -mpclmul` or + * `clang -maes -mpclmul`. + * - Non-x86 targets: this option is silently ignored. + * - Other compilers: this option is silently ignored. + * + * \note + * Above, "GCC" includes compatible compilers such as Clang. + * The limitations on target support are likely to be relaxed in the future. + * + * Module: library/aesni.c + * Caller: library/aes.c + * + * Requires: MBEDTLS_HAVE_ASM (on some platforms, see note) + * + * This modules adds support for the AES-NI instructions on x86. + */ +#define MBEDTLS_AESNI_C + +/** + * \def MBEDTLS_AES_C + * + * Enable the AES block cipher. + * + * Module: library/aes.c + * Caller: library/cipher.c + * library/pem.c + * library/ctr_drbg.c + * + * This module enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_AES_128_CBC_SHA + * MBEDTLS_TLS_PSK_WITH_AES_256_GCM_SHA384 + * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA384 + * MBEDTLS_TLS_PSK_WITH_AES_256_CBC_SHA + * MBEDTLS_TLS_PSK_WITH_AES_128_GCM_SHA256 + * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA256 + * MBEDTLS_TLS_PSK_WITH_AES_128_CBC_SHA + * + * PEM_PARSE uses AES for decrypting encrypted keys. + */ +#define MBEDTLS_AES_C + +/** + * \def MBEDTLS_ARC4_C + * + * Enable the ARCFOUR stream cipher. + * + * Module: library/arc4.c + * Caller: library/cipher.c + * + * This module enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDH_ECDSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_ECDHE_PSK_WITH_RC4_128_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_RC4_128_SHA + * MBEDTLS_TLS_RSA_WITH_RC4_128_SHA + * MBEDTLS_TLS_RSA_WITH_RC4_128_MD5 + * MBEDTLS_TLS_RSA_PSK_WITH_RC4_128_SHA + * MBEDTLS_TLS_PSK_WITH_RC4_128_SHA + * + * \warning ARC4 is considered a weak cipher and its use constitutes a + * security risk. If possible, we recommend avoiding dependencies on + * it, and considering stronger ciphers instead. + * + */ +#define MBEDTLS_ARC4_C + +/** + * \def MBEDTLS_ASN1_PARSE_C + * + * Enable the generic ASN1 parser. + * + * Module: library/asn1.c + * Caller: library/x509.c + * library/dhm.c + * library/pkcs12.c + * library/pkcs5.c + * library/pkparse.c + */ +#define MBEDTLS_ASN1_PARSE_C + +/** + * \def MBEDTLS_ASN1_WRITE_C + * + * Enable the generic ASN1 writer. + * + * Module: library/asn1write.c + * Caller: library/ecdsa.c + * library/pkwrite.c + * library/x509_create.c + * library/x509write_crt.c + * library/x509write_csr.c + */ +#define MBEDTLS_ASN1_WRITE_C + +/** + * \def MBEDTLS_BASE64_C + * + * Enable the Base64 module. + * + * Module: library/base64.c + * Caller: library/pem.c + * + * This module is required for PEM support (required by X.509). + */ +#define MBEDTLS_BASE64_C + +/** + * \def MBEDTLS_BIGNUM_C + * + * Enable the multi-precision integer library. + * + * Module: library/bignum.c + * Caller: library/dhm.c + * library/ecp.c + * library/ecdsa.c + * library/rsa.c + * library/rsa_internal.c + * library/ssl_tls.c + * + * This module is required for RSA, DHM and ECC (ECDH, ECDSA) support. + */ +#define MBEDTLS_BIGNUM_C + +/** + * \def MBEDTLS_BLOWFISH_C + * + * Enable the Blowfish block cipher. + * + * Module: library/blowfish.c + */ +#define MBEDTLS_BLOWFISH_C + +/** + * \def MBEDTLS_CAMELLIA_C + * + * Enable the Camellia block cipher. + * + * Module: library/camellia.c + * Caller: library/cipher.c + * + * This module enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_256_CBC_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_CAMELLIA_128_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_256_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_CAMELLIA_128_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_CAMELLIA_128_CBC_SHA256 + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_GCM_SHA384 + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_256_CBC_SHA384 + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_GCM_SHA256 + * MBEDTLS_TLS_PSK_WITH_CAMELLIA_128_CBC_SHA256 + */ +#define MBEDTLS_CAMELLIA_C + +/** + * \def MBEDTLS_ARIA_C + * + * Enable the ARIA block cipher. + * + * Module: library/aria.c + * Caller: library/cipher.c + * + * This module enables the following ciphersuites (if other requisites are + * enabled as well): + * + * MBEDTLS_TLS_RSA_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_RSA_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_RSA_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_ECDSA_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDHE_RSA_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_ECDH_RSA_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_PSK_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_PSK_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_CBC_SHA384 + * MBEDTLS_TLS_PSK_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_PSK_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_DHE_PSK_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_128_GCM_SHA256 + * MBEDTLS_TLS_RSA_PSK_WITH_ARIA_256_GCM_SHA384 + * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_128_CBC_SHA256 + * MBEDTLS_TLS_ECDHE_PSK_WITH_ARIA_256_CBC_SHA384 + */ +//#define MBEDTLS_ARIA_C + +/** + * \def MBEDTLS_CCM_C + * + * Enable the Counter with CBC-MAC (CCM) mode for 128-bit block cipher. + * + * Module: library/ccm.c + * + * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C + * + * This module enables the AES-CCM ciphersuites, if other requisites are + * enabled as well. + */ +//#define MBEDTLS_CCM_C + +/** + * \def MBEDTLS_CERTS_C + * + * Enable the test certificates. + * + * Module: library/certs.c + * Caller: + * + * This module is used for testing (ssl_client/server). + */ +//#define MBEDTLS_CERTS_C + +/** + * \def MBEDTLS_CHACHA20_C + * + * Enable the ChaCha20 stream cipher. + * + * Module: library/chacha20.c + */ +//#define MBEDTLS_CHACHA20_C + +/** + * \def MBEDTLS_CHACHAPOLY_C + * + * Enable the ChaCha20-Poly1305 AEAD algorithm. + * + * Module: library/chachapoly.c + * + * This module requires: MBEDTLS_CHACHA20_C, MBEDTLS_POLY1305_C + */ +//#define MBEDTLS_CHACHAPOLY_C + +/** + * \def MBEDTLS_CIPHER_C + * + * Enable the generic cipher layer. + * + * Module: library/cipher.c + * Caller: library/ssl_tls.c + * + * Uncomment to enable generic cipher wrappers. + */ +#define MBEDTLS_CIPHER_C + +/** + * \def MBEDTLS_CMAC_C + * + * Enable the CMAC (Cipher-based Message Authentication Code) mode for block + * ciphers. + * + * \note When #MBEDTLS_CMAC_ALT is active, meaning that the underlying + * implementation of the CMAC algorithm is provided by an alternate + * implementation, that alternate implementation may opt to not support + * AES-192 or 3DES as underlying block ciphers for the CMAC operation. + * + * Module: library/cmac.c + * + * Requires: MBEDTLS_AES_C or MBEDTLS_DES_C + * + */ +//#define MBEDTLS_CMAC_C + +/** + * \def MBEDTLS_CTR_DRBG_C + * + * Enable the CTR_DRBG AES-based random generator. + * The CTR_DRBG generator uses AES-256 by default. + * To use AES-128 instead, enable \c MBEDTLS_CTR_DRBG_USE_128_BIT_KEY above. + * + * \note To achieve a 256-bit security strength with CTR_DRBG, + * you must use AES-256 *and* use sufficient entropy. + * See ctr_drbg.h for more details. + * + * Module: library/ctr_drbg.c + * Caller: + * + * Requires: MBEDTLS_AES_C + * + * This module provides the CTR_DRBG AES random number generator. + */ +#define MBEDTLS_CTR_DRBG_C + +/** + * \def MBEDTLS_DEBUG_C + * + * Enable the debug functions. + * + * Module: library/debug.c + * Caller: library/ssl_cli.c + * library/ssl_srv.c + * library/ssl_tls.c + * + * This module provides debugging functions. + */ +//#define MBEDTLS_DEBUG_C + +/** + * \def MBEDTLS_DES_C + * + * Enable the DES block cipher. + * + * Module: library/des.c + * Caller: library/pem.c + * library/cipher.c + * + * This module enables the following ciphersuites (if other requisites are + * enabled as well): + * MBEDTLS_TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_ECDHE_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_RSA_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA + * MBEDTLS_TLS_PSK_WITH_3DES_EDE_CBC_SHA + * + * PEM_PARSE uses DES/3DES for decrypting encrypted keys. + * + * \warning DES/3DES are considered weak ciphers and their use constitutes a + * security risk. We recommend considering stronger ciphers instead. + */ +//#define MBEDTLS_DES_C + +/** + * \def MBEDTLS_DHM_C + * + * Enable the Diffie-Hellman-Merkle module. + * + * Module: library/dhm.c + * Caller: library/ssl_cli.c + * library/ssl_srv.c + * + * This module is used by the following key exchanges: + * DHE-RSA, DHE-PSK + * + * \warning Using DHE constitutes a security risk as it + * is not possible to validate custom DH parameters. + * If possible, it is recommended users should consider + * preferring other methods of key exchange. + * See dhm.h for more details. + * + */ +//#define MBEDTLS_DHM_C + +/** + * \def MBEDTLS_ECDH_C + * + * Enable the elliptic curve Diffie-Hellman library. + * + * Module: library/ecdh.c + * Caller: library/ssl_cli.c + * library/ssl_srv.c + * + * This module is used by the following key exchanges: + * ECDHE-ECDSA, ECDHE-RSA, DHE-PSK + * + * Requires: MBEDTLS_ECP_C + */ +//#define MBEDTLS_ECDH_C + +/** + * \def MBEDTLS_ECDSA_C + * + * Enable the elliptic curve DSA library. + * + * Module: library/ecdsa.c + * Caller: + * + * This module is used by the following key exchanges: + * ECDHE-ECDSA + * + * Requires: MBEDTLS_ECP_C, MBEDTLS_ASN1_WRITE_C, MBEDTLS_ASN1_PARSE_C, + * and at least one MBEDTLS_ECP_DP_XXX_ENABLED for a + * short Weierstrass curve. + */ +#define MBEDTLS_ECDSA_C + +/** + * \def MBEDTLS_ECJPAKE_C + * + * Enable the elliptic curve J-PAKE library. + * + * \warning This is currently experimental. EC J-PAKE support is based on the + * Thread v1.0.0 specification; incompatible changes to the specification + * might still happen. For this reason, this is disabled by default. + * + * Module: library/ecjpake.c + * Caller: + * + * This module is used by the following key exchanges: + * ECJPAKE + * + * Requires: MBEDTLS_ECP_C, MBEDTLS_MD_C + */ +//#define MBEDTLS_ECJPAKE_C + +/** + * \def MBEDTLS_ECP_C + * + * Enable the elliptic curve over GF(p) library. + * + * Module: library/ecp.c + * Caller: library/ecdh.c + * library/ecdsa.c + * library/ecjpake.c + * + * Requires: MBEDTLS_BIGNUM_C and at least one MBEDTLS_ECP_DP_XXX_ENABLED + */ +#define MBEDTLS_ECP_C + +/** + * \def MBEDTLS_ENTROPY_C + * + * Enable the platform-specific entropy code. + * + * Module: library/entropy.c + * Caller: + * + * Requires: MBEDTLS_SHA512_C or MBEDTLS_SHA256_C + * + * This module provides a generic entropy pool + */ +#define MBEDTLS_ENTROPY_C + +/** + * \def MBEDTLS_ERROR_C + * + * Enable error code to error string conversion. + * + * Module: library/error.c + * Caller: + * + * This module enables mbedtls_strerror(). + */ +#define MBEDTLS_ERROR_C + +/** + * \def MBEDTLS_GCM_C + * + * Enable the Galois/Counter Mode (GCM). + * + * Module: library/gcm.c + * + * Requires: MBEDTLS_AES_C or MBEDTLS_CAMELLIA_C or MBEDTLS_ARIA_C + * + * This module enables the AES-GCM and CAMELLIA-GCM ciphersuites, if other + * requisites are enabled as well. + */ +//#define MBEDTLS_GCM_C + +/** + * \def MBEDTLS_HAVEGE_C + * + * Enable the HAVEGE random generator. + * + * Warning: the HAVEGE random generator is not suitable for virtualized + * environments + * + * Warning: the HAVEGE random generator is dependent on timing and specific + * processor traits. It is therefore not advised to use HAVEGE as + * your applications primary random generator or primary entropy pool + * input. As a secondary input to your entropy pool, it IS able add + * the (limited) extra entropy it provides. + * + * Module: library/havege.c + * Caller: + * + * Requires: MBEDTLS_TIMING_C + * + * Uncomment to enable the HAVEGE random generator. + */ +//#define MBEDTLS_HAVEGE_C + +/** + * \def MBEDTLS_HKDF_C + * + * Enable the HKDF algorithm (RFC 5869). + * + * Module: library/hkdf.c + * Caller: + * + * Requires: MBEDTLS_MD_C + * + * This module adds support for the Hashed Message Authentication Code + * (HMAC)-based key derivation function (HKDF). + */ +#define MBEDTLS_HKDF_C + +/** + * \def MBEDTLS_HMAC_DRBG_C + * + * Enable the HMAC_DRBG random generator. + * + * Module: library/hmac_drbg.c + * Caller: + * + * Requires: MBEDTLS_MD_C + * + * Uncomment to enable the HMAC_DRBG random number generator. + */ +#define MBEDTLS_HMAC_DRBG_C + +/** + * \def MBEDTLS_NIST_KW_C + * + * Enable the Key Wrapping mode for 128-bit block ciphers, + * as defined in NIST SP 800-38F. Only KW and KWP modes + * are supported. At the moment, only AES is approved by NIST. + * + * Module: library/nist_kw.c + * + * Requires: MBEDTLS_AES_C and MBEDTLS_CIPHER_C + */ +//#define MBEDTLS_NIST_KW_C + +/** + * \def MBEDTLS_MD_C + * + * Enable the generic message digest layer. + * + * Module: library/md.c + * Caller: + * + * Uncomment to enable generic message digest wrappers. + */ +#define MBEDTLS_MD_C + +/** + * \def MBEDTLS_MD2_C + * + * Enable the MD2 hash algorithm. + * + * Module: library/md2.c + * Caller: + * + * Uncomment to enable support for (rare) MD2-signed X.509 certs. + * + * \warning MD2 is considered a weak message digest and its use constitutes a + * security risk. If possible, we recommend avoiding dependencies on + * it, and considering stronger message digests instead. + * + */ +//#define MBEDTLS_MD2_C + +/** + * \def MBEDTLS_MD4_C + * + * Enable the MD4 hash algorithm. + * + * Module: library/md4.c + * Caller: + * + * Uncomment to enable support for (rare) MD4-signed X.509 certs. + * + * \warning MD4 is considered a weak message digest and its use constitutes a + * security risk. If possible, we recommend avoiding dependencies on + * it, and considering stronger message digests instead. + * + */ +//#define MBEDTLS_MD4_C + +/** + * \def MBEDTLS_MD5_C + * + * Enable the MD5 hash algorithm. + * + * Module: library/md5.c + * Caller: library/md.c + * library/pem.c + * library/ssl_tls.c + * + * This module is required for SSL/TLS up to version 1.1, and for TLS 1.2 + * depending on the handshake parameters. Further, it is used for checking + * MD5-signed certificates, and for PBKDF1 when decrypting PEM-encoded + * encrypted keys. + * + * \warning MD5 is considered a weak message digest and its use constitutes a + * security risk. If possible, we recommend avoiding dependencies on + * it, and considering stronger message digests instead. + * + */ +#define MBEDTLS_MD5_C + +/** + * \def MBEDTLS_MEMORY_BUFFER_ALLOC_C + * + * Enable the buffer allocator implementation that makes use of a (stack) + * based buffer to 'allocate' dynamic memory. (replaces calloc() and free() + * calls) + * + * Module: library/memory_buffer_alloc.c + * + * Requires: MBEDTLS_PLATFORM_C + * MBEDTLS_PLATFORM_MEMORY (to use it within Mbed TLS) + * + * Enable this module to enable the buffer memory allocator. + */ +//#define MBEDTLS_MEMORY_BUFFER_ALLOC_C + +/** + * \def MBEDTLS_NET_C + * + * Enable the TCP and UDP over IPv6/IPv4 networking routines. + * + * \note This module only works on POSIX/Unix (including Linux, BSD and OS X) + * and Windows. For other platforms, you'll want to disable it, and write your + * own networking callbacks to be passed to \c mbedtls_ssl_set_bio(). + * + * \note See also our Knowledge Base article about porting to a new + * environment: + * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS + * + * Module: library/net_sockets.c + * + * This module provides networking routines. + */ +//#define MBEDTLS_NET_C + +/** + * \def MBEDTLS_OID_C + * + * Enable the OID database. + * + * Module: library/oid.c + * Caller: library/asn1write.c + * library/pkcs5.c + * library/pkparse.c + * library/pkwrite.c + * library/rsa.c + * library/x509.c + * library/x509_create.c + * library/x509_crl.c + * library/x509_crt.c + * library/x509_csr.c + * library/x509write_crt.c + * library/x509write_csr.c + * + * This modules translates between OIDs and internal values. + */ +#define MBEDTLS_OID_C + +/** + * \def MBEDTLS_PADLOCK_C + * + * Enable VIA Padlock support on x86. + * + * Module: library/padlock.c + * Caller: library/aes.c + * + * Requires: MBEDTLS_HAVE_ASM + * + * This modules adds support for the VIA PadLock on x86. + */ +#define MBEDTLS_PADLOCK_C + +/** + * \def MBEDTLS_PEM_PARSE_C + * + * Enable PEM decoding / parsing. + * + * Module: library/pem.c + * Caller: library/dhm.c + * library/pkparse.c + * library/x509_crl.c + * library/x509_crt.c + * library/x509_csr.c + * + * Requires: MBEDTLS_BASE64_C + * + * This modules adds support for decoding / parsing PEM files. + */ +#define MBEDTLS_PEM_PARSE_C + +/** + * \def MBEDTLS_PEM_WRITE_C + * + * Enable PEM encoding / writing. + * + * Module: library/pem.c + * Caller: library/pkwrite.c + * library/x509write_crt.c + * library/x509write_csr.c + * + * Requires: MBEDTLS_BASE64_C + * + * This modules adds support for encoding / writing PEM files. + */ +#define MBEDTLS_PEM_WRITE_C + +/** + * \def MBEDTLS_PK_C + * + * Enable the generic public (asymmetric) key layer. + * + * Module: library/pk.c + * Caller: library/ssl_tls.c + * library/ssl_cli.c + * library/ssl_srv.c + * + * Requires: MBEDTLS_RSA_C or MBEDTLS_ECP_C + * + * Uncomment to enable generic public key wrappers. + */ +#define MBEDTLS_PK_C + +/** + * \def MBEDTLS_PK_PARSE_C + * + * Enable the generic public (asymmetric) key parser. + * + * Module: library/pkparse.c + * Caller: library/x509_crt.c + * library/x509_csr.c + * + * Requires: MBEDTLS_PK_C + * + * Uncomment to enable generic public key parse functions. + */ +#define MBEDTLS_PK_PARSE_C + +/** + * \def MBEDTLS_PK_WRITE_C + * + * Enable the generic public (asymmetric) key writer. + * + * Module: library/pkwrite.c + * Caller: library/x509write.c + * + * Requires: MBEDTLS_PK_C + * + * Uncomment to enable generic public key write functions. + */ +#define MBEDTLS_PK_WRITE_C + +/** + * \def MBEDTLS_PKCS5_C + * + * Enable PKCS#5 functions. + * + * Module: library/pkcs5.c + * + * Requires: MBEDTLS_MD_C + * + * This module adds support for the PKCS#5 functions. + */ +#define MBEDTLS_PKCS5_C + +/** + * \def MBEDTLS_PKCS11_C + * + * Enable wrapper for PKCS#11 smartcard support via the pkcs11-helper library. + * + * \deprecated This option is deprecated and will be removed in a future + * version of Mbed TLS. + * + * Module: library/pkcs11.c + * Caller: library/pk.c + * + * Requires: MBEDTLS_PK_C + * + * This module enables SSL/TLS PKCS #11 smartcard support. + * Requires the presence of the PKCS#11 helper library (libpkcs11-helper) + */ +//#define MBEDTLS_PKCS11_C + +/** + * \def MBEDTLS_PKCS12_C + * + * Enable PKCS#12 PBE functions. + * Adds algorithms for parsing PKCS#8 encrypted private keys + * + * Module: library/pkcs12.c + * Caller: library/pkparse.c + * + * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_CIPHER_C, MBEDTLS_MD_C + * Can use: MBEDTLS_ARC4_C + * + * This module enables PKCS#12 functions. + */ +#define MBEDTLS_PKCS12_C + +/** + * \def MBEDTLS_PLATFORM_C + * + * Enable the platform abstraction layer that allows you to re-assign + * functions like calloc(), free(), snprintf(), printf(), fprintf(), exit(). + * + * Enabling MBEDTLS_PLATFORM_C enables to use of MBEDTLS_PLATFORM_XXX_ALT + * or MBEDTLS_PLATFORM_XXX_MACRO directives, allowing the functions mentioned + * above to be specified at runtime or compile time respectively. + * + * \note This abstraction layer must be enabled on Windows (including MSYS2) + * as other module rely on it for a fixed snprintf implementation. + * + * Module: library/platform.c + * Caller: Most other .c files + * + * This module enables abstraction of common (libc) functions. + */ +#define MBEDTLS_PLATFORM_C + +/** + * \def MBEDTLS_POLY1305_C + * + * Enable the Poly1305 MAC algorithm. + * + * Module: library/poly1305.c + * Caller: library/chachapoly.c + */ +#define MBEDTLS_POLY1305_C + +/** + * \def MBEDTLS_PSA_CRYPTO_C + * + * Enable the Platform Security Architecture cryptography API. + * + * Module: library/psa_crypto.c + * + * Requires: either MBEDTLS_CTR_DRBG_C and MBEDTLS_ENTROPY_C, + * or MBEDTLS_HMAC_DRBG_C and MBEDTLS_ENTROPY_C, + * or MBEDTLS_PSA_CRYPTO_EXTERNAL_RNG. + * + */ +// #define MBEDTLS_PSA_CRYPTO_C + +/** + * \def MBEDTLS_PSA_CRYPTO_SE_C + * + * Enable secure element support in the Platform Security Architecture + * cryptography API. + * + * \warning This feature is not yet suitable for production. It is provided + * for API evaluation and testing purposes only. + * + * Module: library/psa_crypto_se.c + * + * Requires: MBEDTLS_PSA_CRYPTO_C, MBEDTLS_PSA_CRYPTO_STORAGE_C + * + */ +//#define MBEDTLS_PSA_CRYPTO_SE_C + +/** + * \def MBEDTLS_PSA_CRYPTO_STORAGE_C + * + * Enable the Platform Security Architecture persistent key storage. + * + * Module: library/psa_crypto_storage.c + * + * Requires: MBEDTLS_PSA_CRYPTO_C, + * either MBEDTLS_PSA_ITS_FILE_C or a native implementation of + * the PSA ITS interface + */ +//#define MBEDTLS_PSA_CRYPTO_STORAGE_C + +/** + * \def MBEDTLS_PSA_ITS_FILE_C + * + * Enable the emulation of the Platform Security Architecture + * Internal Trusted Storage (PSA ITS) over files. + * + * Module: library/psa_its_file.c + * + * Requires: MBEDTLS_FS_IO + */ +//#define MBEDTLS_PSA_ITS_FILE_C + +/** + * \def MBEDTLS_RIPEMD160_C + * + * Enable the RIPEMD-160 hash algorithm. + * + * Module: library/ripemd160.c + * Caller: library/md.c + * + */ +//#define MBEDTLS_RIPEMD160_C + +/** + * \def MBEDTLS_RSA_C + * + * Enable the RSA public-key cryptosystem. + * + * Module: library/rsa.c + * library/rsa_internal.c + * Caller: library/ssl_cli.c + * library/ssl_srv.c + * library/ssl_tls.c + * library/x509.c + * + * This module is used by the following key exchanges: + * RSA, DHE-RSA, ECDHE-RSA, RSA-PSK + * + * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C + */ +//#define MBEDTLS_RSA_C + +/** + * \def MBEDTLS_SHA1_C + * + * Enable the SHA1 cryptographic hash algorithm. + * + * Module: library/sha1.c + * Caller: library/md.c + * library/ssl_cli.c + * library/ssl_srv.c + * library/ssl_tls.c + * library/x509write_crt.c + * + * This module is required for SSL/TLS up to version 1.1, for TLS 1.2 + * depending on the handshake parameters, and for SHA1-signed certificates. + * + * \warning SHA-1 is considered a weak message digest and its use constitutes + * a security risk. If possible, we recommend avoiding dependencies + * on it, and considering stronger message digests instead. + * + */ +#define MBEDTLS_SHA1_C + +/** + * \def MBEDTLS_SHA256_C + * + * Enable the SHA-224 and SHA-256 cryptographic hash algorithms. + * + * Module: library/sha256.c + * Caller: library/entropy.c + * library/md.c + * library/ssl_cli.c + * library/ssl_srv.c + * library/ssl_tls.c + * + * This module adds support for SHA-224 and SHA-256. + * This module is required for the SSL/TLS 1.2 PRF function. + */ +#define MBEDTLS_SHA256_C + +/** + * \def MBEDTLS_SHA512_C + * + * Enable the SHA-384 and SHA-512 cryptographic hash algorithms. + * + * Module: library/sha512.c + * Caller: library/entropy.c + * library/md.c + * library/ssl_cli.c + * library/ssl_srv.c + * + * This module adds support for SHA-384 and SHA-512. + */ +#define MBEDTLS_SHA512_C + +/** + * \def MBEDTLS_SSL_CACHE_C + * + * Enable simple SSL cache implementation. + * + * Module: library/ssl_cache.c + * Caller: + * + * Requires: MBEDTLS_SSL_CACHE_C + */ +//#define MBEDTLS_SSL_CACHE_C + +/** + * \def MBEDTLS_SSL_COOKIE_C + * + * Enable basic implementation of DTLS cookies for hello verification. + * + * Module: library/ssl_cookie.c + * Caller: + */ +//#define MBEDTLS_SSL_COOKIE_C + +/** + * \def MBEDTLS_SSL_TICKET_C + * + * Enable an implementation of TLS server-side callbacks for session tickets. + * + * Module: library/ssl_ticket.c + * Caller: + * + * Requires: MBEDTLS_CIPHER_C && + * ( MBEDTLS_GCM_C || MBEDTLS_CCM_C || MBEDTLS_CHACHAPOLY_C ) + */ +//#define MBEDTLS_SSL_TICKET_C + +/** + * \def MBEDTLS_SSL_CLI_C + * + * Enable the SSL/TLS client code. + * + * Module: library/ssl_cli.c + * Caller: + * + * Requires: MBEDTLS_SSL_TLS_C + * + * This module is required for SSL/TLS client support. + */ +//#define MBEDTLS_SSL_CLI_C + +/** + * \def MBEDTLS_SSL_SRV_C + * + * Enable the SSL/TLS server code. + * + * Module: library/ssl_srv.c + * Caller: + * + * Requires: MBEDTLS_SSL_TLS_C + * + * This module is required for SSL/TLS server support. + */ +//#define MBEDTLS_SSL_SRV_C + +/** + * \def MBEDTLS_SSL_TLS_C + * + * Enable the generic SSL/TLS code. + * + * Module: library/ssl_tls.c + * Caller: library/ssl_cli.c + * library/ssl_srv.c + * + * Requires: MBEDTLS_CIPHER_C, MBEDTLS_MD_C + * and at least one of the MBEDTLS_SSL_PROTO_XXX defines + * + * This module is required for SSL/TLS. + */ +//#define MBEDTLS_SSL_TLS_C + +/** + * \def MBEDTLS_THREADING_C + * + * Enable the threading abstraction layer. + * By default Mbed TLS assumes it is used in a non-threaded environment or that + * contexts are not shared between threads. If you do intend to use contexts + * between threads, you will need to enable this layer to prevent race + * conditions. See also our Knowledge Base article about threading: + * https://mbed-tls.readthedocs.io/en/latest/kb/development/thread-safety-and-multi-threading + * + * Module: library/threading.c + * + * This allows different threading implementations (self-implemented or + * provided). + * + * You will have to enable either MBEDTLS_THREADING_ALT or + * MBEDTLS_THREADING_PTHREAD. + * + * Enable this layer to allow use of mutexes within Mbed TLS + */ +//#define MBEDTLS_THREADING_C + +/** + * \def MBEDTLS_TIMING_C + * + * Enable the semi-portable timing interface. + * + * \note The provided implementation only works on POSIX/Unix (including Linux, + * BSD and OS X) and Windows. On other platforms, you can either disable that + * module and provide your own implementations of the callbacks needed by + * \c mbedtls_ssl_set_timer_cb() for DTLS, or leave it enabled and provide + * your own implementation of the whole module by setting + * \c MBEDTLS_TIMING_ALT in the current file. + * + * \note The timing module will include time.h on suitable platforms + * regardless of the setting of MBEDTLS_HAVE_TIME, unless + * MBEDTLS_TIMING_ALT is used. See timing.c for more information. + * + * \note See also our Knowledge Base article about porting to a new + * environment: + * https://mbed-tls.readthedocs.io/en/latest/kb/how-to/how-do-i-port-mbed-tls-to-a-new-environment-OS + * + * Module: library/timing.c + * Caller: library/havege.c + * + * This module is used by the HAVEGE random number generator. + */ +#define MBEDTLS_TIMING_C + +/** + * \def MBEDTLS_VERSION_C + * + * Enable run-time version information. + * + * Module: library/version.c + * + * This module provides run-time version information. + */ +#define MBEDTLS_VERSION_C + +/** + * \def MBEDTLS_X509_USE_C + * + * Enable X.509 core for using certificates. + * + * Module: library/x509.c + * Caller: library/x509_crl.c + * library/x509_crt.c + * library/x509_csr.c + * + * Requires: MBEDTLS_ASN1_PARSE_C, MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, + * MBEDTLS_PK_PARSE_C + * + * This module is required for the X.509 parsing modules. + */ +//#define MBEDTLS_X509_USE_C + +/** + * \def MBEDTLS_X509_CRT_PARSE_C + * + * Enable X.509 certificate parsing. + * + * Module: library/x509_crt.c + * Caller: library/ssl_cli.c + * library/ssl_srv.c + * library/ssl_tls.c + * + * Requires: MBEDTLS_X509_USE_C + * + * This module is required for X.509 certificate parsing. + */ +//#define MBEDTLS_X509_CRT_PARSE_C + +/** + * \def MBEDTLS_X509_CRL_PARSE_C + * + * Enable X.509 CRL parsing. + * + * Module: library/x509_crl.c + * Caller: library/x509_crt.c + * + * Requires: MBEDTLS_X509_USE_C + * + * This module is required for X.509 CRL parsing. + */ +//#define MBEDTLS_X509_CRL_PARSE_C + +/** + * \def MBEDTLS_X509_CSR_PARSE_C + * + * Enable X.509 Certificate Signing Request (CSR) parsing. + * + * Module: library/x509_csr.c + * Caller: library/x509_crt_write.c + * + * Requires: MBEDTLS_X509_USE_C + * + * This module is used for reading X.509 certificate request. + */ +//#define MBEDTLS_X509_CSR_PARSE_C + +/** + * \def MBEDTLS_X509_CREATE_C + * + * Enable X.509 core for creating certificates. + * + * Module: library/x509_create.c + * + * Requires: MBEDTLS_BIGNUM_C, MBEDTLS_OID_C, MBEDTLS_PK_WRITE_C + * + * This module is the basis for creating X.509 certificates and CSRs. + */ +//#define MBEDTLS_X509_CREATE_C + +/** + * \def MBEDTLS_X509_CRT_WRITE_C + * + * Enable creating X.509 certificates. + * + * Module: library/x509_crt_write.c + * + * Requires: MBEDTLS_X509_CREATE_C + * + * This module is required for X.509 certificate creation. + */ +//#define MBEDTLS_X509_CRT_WRITE_C + +/** + * \def MBEDTLS_X509_CSR_WRITE_C + * + * Enable creating X.509 Certificate Signing Requests (CSR). + * + * Module: library/x509_csr_write.c + * + * Requires: MBEDTLS_X509_CREATE_C + * + * This module is required for X.509 certificate request writing. + */ +//#define MBEDTLS_X509_CSR_WRITE_C + +/** + * \def MBEDTLS_XTEA_C + * + * Enable the XTEA block cipher. + * + * Module: library/xtea.c + * Caller: + */ +#define MBEDTLS_XTEA_C + +/** \} name SECTION: Mbed TLS modules */ + +/** + * \name SECTION: General configuration options + * + * This section contains Mbed TLS build settings that are not associated + * with a particular module. + * + * \{ + */ + +/** + * \def MBEDTLS_CONFIG_FILE + * + * If defined, this is a header which will be included instead of + * `"mbedtls/config.h"`. + * This header file specifies the compile-time configuration of Mbed TLS. + * Unlike other configuration options, this one must be defined on the + * compiler command line: a definition in `config.h` would have no effect. + * + * This macro is expanded after an \#include directive. This is a popular but + * non-standard feature of the C language, so this feature is only available + * with compilers that perform macro expansion on an \#include line. + * + * The value of this symbol is typically a path in double quotes, either + * absolute or relative to a directory on the include search path. + */ +//#define MBEDTLS_CONFIG_FILE "mbedtls/config.h" + +/** + * \def MBEDTLS_USER_CONFIG_FILE + * + * If defined, this is a header which will be included after + * `"mbedtls/config.h"` or #MBEDTLS_CONFIG_FILE. + * This allows you to modify the default configuration, including the ability + * to undefine options that are enabled by default. + * + * This macro is expanded after an \#include directive. This is a popular but + * non-standard feature of the C language, so this feature is only available + * with compilers that perform macro expansion on an \#include line. + * + * The value of this symbol is typically a path in double quotes, either + * absolute or relative to a directory on the include search path. + */ +//#define MBEDTLS_USER_CONFIG_FILE "/dev/null" + +/** + * \def MBEDTLS_PSA_CRYPTO_CONFIG_FILE + * + * If defined, this is a header which will be included instead of + * `"psa/crypto_config.h"`. + * This header file specifies which cryptographic mechanisms are available + * through the PSA API when #MBEDTLS_PSA_CRYPTO_CONFIG is enabled, and + * is not used when #MBEDTLS_PSA_CRYPTO_CONFIG is disabled. + * + * This macro is expanded after an \#include directive. This is a popular but + * non-standard feature of the C language, so this feature is only available + * with compilers that perform macro expansion on an \#include line. + * + * The value of this symbol is typically a path in double quotes, either + * absolute or relative to a directory on the include search path. + */ +//#define MBEDTLS_PSA_CRYPTO_CONFIG_FILE "psa/crypto_config.h" + +/** + * \def MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE + * + * If defined, this is a header which will be included after + * `"psa/crypto_config.h"` or #MBEDTLS_PSA_CRYPTO_CONFIG_FILE. + * This allows you to modify the default configuration, including the ability + * to undefine options that are enabled by default. + * + * This macro is expanded after an \#include directive. This is a popular but + * non-standard feature of the C language, so this feature is only available + * with compilers that perform macro expansion on an \#include line. + * + * The value of this symbol is typically a path in double quotes, either + * absolute or relative to a directory on the include search path. + */ +//#define MBEDTLS_PSA_CRYPTO_USER_CONFIG_FILE "/dev/null" + +/** \} name SECTION: General configuration options */ + +/** + * \name SECTION: Module configuration options + * + * This section allows for the setting of module specific sizes and + * configuration options. The default values are already present in the + * relevant header files and should suffice for the regular use cases. + * + * Our advice is to enable options and change their values here + * only if you have a good reason and know the consequences. + * \{ + */ +/* The Doxygen documentation here is used when a user comments out a + * setting and runs doxygen themselves. On the other hand, when we typeset + * the full documentation including disabled settings, the documentation + * in specific modules' header files is used if present. When editing this + * file, make sure that each option is documented in exactly one place, + * plus optionally a same-line Doxygen comment here if there is a Doxygen + * comment in the specific module. */ + +/* MPI / BIGNUM options */ +//#define MBEDTLS_MPI_WINDOW_SIZE 2 /**< Maximum window size used. */ +//#define MBEDTLS_MPI_MAX_SIZE 1024 /**< Maximum number of bytes for usable MPIs. */ + +/* CTR_DRBG options */ +//#define MBEDTLS_CTR_DRBG_ENTROPY_LEN 48 /**< Amount of entropy used per seed by default (48 with SHA-512, 32 with SHA-256) */ +//#define MBEDTLS_CTR_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */ +//#define MBEDTLS_CTR_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */ +//#define MBEDTLS_CTR_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */ +//#define MBEDTLS_CTR_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */ + +/* HMAC_DRBG options */ +//#define MBEDTLS_HMAC_DRBG_RESEED_INTERVAL 10000 /**< Interval before reseed is performed by default */ +//#define MBEDTLS_HMAC_DRBG_MAX_INPUT 256 /**< Maximum number of additional input bytes */ +//#define MBEDTLS_HMAC_DRBG_MAX_REQUEST 1024 /**< Maximum number of requested bytes per call */ +//#define MBEDTLS_HMAC_DRBG_MAX_SEED_INPUT 384 /**< Maximum size of (re)seed buffer */ + +/* ECP options */ +//#define MBEDTLS_ECP_MAX_BITS 521 /**< Maximum bit size of groups. Normally determined automatically from the configured curves. */ +//#define MBEDTLS_ECP_WINDOW_SIZE 4 /**< Maximum window size used */ +//#define MBEDTLS_ECP_FIXED_POINT_OPTIM 1 /**< Enable fixed-point speed-up */ + +/* Entropy options */ +//#define MBEDTLS_ENTROPY_MAX_SOURCES 20 /**< Maximum number of sources supported */ +//#define MBEDTLS_ENTROPY_MAX_GATHER 128 /**< Maximum amount requested from entropy sources */ +//#define MBEDTLS_ENTROPY_MIN_HARDWARE 32 /**< Default minimum number of bytes required for the hardware entropy source mbedtls_hardware_poll() before entropy is released */ + +/* Memory buffer allocator options */ +//#define MBEDTLS_MEMORY_ALIGN_MULTIPLE 4 /**< Align on multiples of this value */ + +/* Platform options */ +//#define MBEDTLS_PLATFORM_STD_MEM_HDR /**< Header to include if MBEDTLS_PLATFORM_NO_STD_FUNCTIONS is defined. Don't define if no header is needed. */ + +/** \def MBEDTLS_PLATFORM_STD_CALLOC + * + * Default allocator to use, can be undefined. + * It must initialize the allocated buffer memory to zeroes. + * The size of the buffer is the product of the two parameters. + * The calloc function returns either a null pointer or a pointer to the allocated space. + * If the product is 0, the function may either return NULL or a valid pointer to an array of size 0 which is a valid input to the deallocation function. + * An uninitialized #MBEDTLS_PLATFORM_STD_CALLOC always fails, returning a null pointer. + * See the description of #MBEDTLS_PLATFORM_MEMORY for more details. + * The corresponding deallocation function is #MBEDTLS_PLATFORM_STD_FREE. + */ +//#define MBEDTLS_PLATFORM_STD_CALLOC calloc + +/** \def MBEDTLS_PLATFORM_STD_FREE + * + * Default free to use, can be undefined. + * NULL is a valid parameter, and the function must do nothing. + * A non-null parameter will always be a pointer previously returned by #MBEDTLS_PLATFORM_STD_CALLOC and not yet freed. + * An uninitialized #MBEDTLS_PLATFORM_STD_FREE does not do anything. + * See the description of #MBEDTLS_PLATFORM_MEMORY for more details (same principles as for MBEDTLS_PLATFORM_STD_CALLOC apply). + */ +//#define MBEDTLS_PLATFORM_STD_FREE free +//#define MBEDTLS_PLATFORM_STD_EXIT exit /**< Default exit to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_TIME time /**< Default time to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */ +//#define MBEDTLS_PLATFORM_STD_FPRINTF fprintf /**< Default fprintf to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_PRINTF printf /**< Default printf to use, can be undefined */ +/* Note: your snprintf must correctly zero-terminate the buffer! */ +//#define MBEDTLS_PLATFORM_STD_SNPRINTF snprintf /**< Default snprintf to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_EXIT_SUCCESS 0 /**< Default exit value to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_EXIT_FAILURE 1 /**< Default exit value to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_NV_SEED_READ mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_NV_SEED_WRITE mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */ +//#define MBEDTLS_PLATFORM_STD_NV_SEED_FILE "seedfile" /**< Seed file to read/write with default implementation */ + +/* To use the following function macros, MBEDTLS_PLATFORM_C must be enabled. */ +/* MBEDTLS_PLATFORM_XXX_MACRO and MBEDTLS_PLATFORM_XXX_ALT cannot both be defined */ +//#define MBEDTLS_PLATFORM_CALLOC_MACRO calloc /**< Default allocator macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_CALLOC for requirements. */ +//#define MBEDTLS_PLATFORM_FREE_MACRO free /**< Default free macro to use, can be undefined. See MBEDTLS_PLATFORM_STD_FREE for requirements. */ +//#define MBEDTLS_PLATFORM_EXIT_MACRO exit /**< Default exit macro to use, can be undefined */ +//#define MBEDTLS_PLATFORM_TIME_MACRO time /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */ +//#define MBEDTLS_PLATFORM_TIME_TYPE_MACRO time_t /**< Default time macro to use, can be undefined. MBEDTLS_HAVE_TIME must be enabled */ +//#define MBEDTLS_PLATFORM_FPRINTF_MACRO fprintf /**< Default fprintf macro to use, can be undefined */ +//#define MBEDTLS_PLATFORM_PRINTF_MACRO printf /**< Default printf macro to use, can be undefined */ +/* Note: your snprintf must correctly zero-terminate the buffer! */ +//#define MBEDTLS_PLATFORM_SNPRINTF_MACRO snprintf /**< Default snprintf macro to use, can be undefined */ +//#define MBEDTLS_PLATFORM_VSNPRINTF_MACRO vsnprintf /**< Default vsnprintf macro to use, can be undefined */ +//#define MBEDTLS_PLATFORM_NV_SEED_READ_MACRO mbedtls_platform_std_nv_seed_read /**< Default nv_seed_read function to use, can be undefined */ +//#define MBEDTLS_PLATFORM_NV_SEED_WRITE_MACRO mbedtls_platform_std_nv_seed_write /**< Default nv_seed_write function to use, can be undefined */ + +/** + * \brief This macro is invoked by the library when an invalid parameter + * is detected that is only checked with #MBEDTLS_CHECK_PARAMS + * (see the documentation of that option for context). + * + * When you leave this undefined here, the library provides + * a default definition. If the macro #MBEDTLS_CHECK_PARAMS_ASSERT + * is defined, the default definition is `assert(cond)`, + * otherwise the default definition calls a function + * mbedtls_param_failed(). This function is declared in + * `platform_util.h` for the benefit of the library, but + * you need to define in your application. + * + * When you define this here, this replaces the default + * definition in platform_util.h (which no longer declares the + * function mbedtls_param_failed()) and it is your responsibility + * to make sure this macro expands to something suitable (in + * particular, that all the necessary declarations are visible + * from within the library - you can ensure that by providing + * them in this file next to the macro definition). + * If you define this macro to call `assert`, also define + * #MBEDTLS_CHECK_PARAMS_ASSERT so that library source files + * include ``. + * + * Note that you may define this macro to expand to nothing, in + * which case you don't have to worry about declarations or + * definitions. However, you will then be notified about invalid + * parameters only in non-void functions, and void function will + * just silently return early on invalid parameters, which + * partially negates the benefits of enabling + * #MBEDTLS_CHECK_PARAMS in the first place, so is discouraged. + * + * \param cond The expression that should evaluate to true, but doesn't. + */ +//#define MBEDTLS_PARAM_FAILED( cond ) assert( cond ) + +/** \def MBEDTLS_CHECK_RETURN + * + * This macro is used at the beginning of the declaration of a function + * to indicate that its return value should be checked. It should + * instruct the compiler to emit a warning or an error if the function + * is called without checking its return value. + * + * There is a default implementation for popular compilers in platform_util.h. + * You can override the default implementation by defining your own here. + * + * If the implementation here is empty, this will effectively disable the + * checking of functions' return values. + */ +//#define MBEDTLS_CHECK_RETURN __attribute__((__warn_unused_result__)) + +/** \def MBEDTLS_IGNORE_RETURN + * + * This macro requires one argument, which should be a C function call. + * If that function call would cause a #MBEDTLS_CHECK_RETURN warning, this + * warning is suppressed. + */ +//#define MBEDTLS_IGNORE_RETURN( result ) ((void) !(result)) + +/* PSA options */ +/** + * Use HMAC_DRBG with the specified hash algorithm for HMAC_DRBG for the + * PSA crypto subsystem. + * + * If this option is unset: + * - If CTR_DRBG is available, the PSA subsystem uses it rather than HMAC_DRBG. + * - Otherwise, the PSA subsystem uses HMAC_DRBG with either + * #MBEDTLS_MD_SHA512 or #MBEDTLS_MD_SHA256 based on availability and + * on unspecified heuristics. + */ +//#define MBEDTLS_PSA_HMAC_DRBG_MD_TYPE MBEDTLS_MD_SHA256 + +/** \def MBEDTLS_PSA_KEY_SLOT_COUNT + * Restrict the PSA library to supporting a maximum amount of simultaneously + * loaded keys. A loaded key is a key stored by the PSA Crypto core as a + * volatile key, or a persistent key which is loaded temporarily by the + * library as part of a crypto operation in flight. + * + * If this option is unset, the library will fall back to a default value of + * 32 keys. + */ +//#define MBEDTLS_PSA_KEY_SLOT_COUNT 32 + +/* SSL Cache options */ +//#define MBEDTLS_SSL_CACHE_DEFAULT_TIMEOUT 86400 /**< 1 day */ +//#define MBEDTLS_SSL_CACHE_DEFAULT_MAX_ENTRIES 50 /**< Maximum entries in cache */ + +/* SSL options */ + +/** \def MBEDTLS_SSL_MAX_CONTENT_LEN + * + * Maximum length (in bytes) of incoming and outgoing plaintext fragments. + * + * This determines the size of both the incoming and outgoing TLS I/O buffers + * in such a way that both are capable of holding the specified amount of + * plaintext data, regardless of the protection mechanism used. + * + * To configure incoming and outgoing I/O buffers separately, use + * #MBEDTLS_SSL_IN_CONTENT_LEN and #MBEDTLS_SSL_OUT_CONTENT_LEN, + * which overwrite the value set by this option. + * + * \note When using a value less than the default of 16KB on the client, it is + * recommended to use the Maximum Fragment Length (MFL) extension to + * inform the server about this limitation. On the server, there + * is no supported, standardized way of informing the client about + * restriction on the maximum size of incoming messages, and unless + * the limitation has been communicated by other means, it is recommended + * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN + * while keeping the default value of 16KB for the incoming buffer. + * + * Uncomment to set the maximum plaintext size of both + * incoming and outgoing I/O buffers. + */ +//#define MBEDTLS_SSL_MAX_CONTENT_LEN 16384 + +/** \def MBEDTLS_SSL_IN_CONTENT_LEN + * + * Maximum length (in bytes) of incoming plaintext fragments. + * + * This determines the size of the incoming TLS I/O buffer in such a way + * that it is capable of holding the specified amount of plaintext data, + * regardless of the protection mechanism used. + * + * If this option is undefined, it inherits its value from + * #MBEDTLS_SSL_MAX_CONTENT_LEN. + * + * \note When using a value less than the default of 16KB on the client, it is + * recommended to use the Maximum Fragment Length (MFL) extension to + * inform the server about this limitation. On the server, there + * is no supported, standardized way of informing the client about + * restriction on the maximum size of incoming messages, and unless + * the limitation has been communicated by other means, it is recommended + * to only change the outgoing buffer size #MBEDTLS_SSL_OUT_CONTENT_LEN + * while keeping the default value of 16KB for the incoming buffer. + * + * Uncomment to set the maximum plaintext size of the incoming I/O buffer + * independently of the outgoing I/O buffer. + */ +//#define MBEDTLS_SSL_IN_CONTENT_LEN 16384 + +/** \def MBEDTLS_SSL_CID_IN_LEN_MAX + * + * The maximum length of CIDs used for incoming DTLS messages. + * + */ +//#define MBEDTLS_SSL_CID_IN_LEN_MAX 32 + +/** \def MBEDTLS_SSL_CID_OUT_LEN_MAX + * + * The maximum length of CIDs used for outgoing DTLS messages. + * + */ +//#define MBEDTLS_SSL_CID_OUT_LEN_MAX 32 + +/** \def MBEDTLS_SSL_CID_PADDING_GRANULARITY + * + * This option controls the use of record plaintext padding + * when using the Connection ID extension in DTLS 1.2. + * + * The padding will always be chosen so that the length of the + * padded plaintext is a multiple of the value of this option. + * + * Note: A value of \c 1 means that no padding will be used + * for outgoing records. + * + * Note: On systems lacking division instructions, + * a power of two should be preferred. + * + */ +//#define MBEDTLS_SSL_CID_PADDING_GRANULARITY 16 + +/** \def MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY + * + * This option controls the use of record plaintext padding + * in TLS 1.3. + * + * The padding will always be chosen so that the length of the + * padded plaintext is a multiple of the value of this option. + * + * Note: A value of \c 1 means that no padding will be used + * for outgoing records. + * + * Note: On systems lacking division instructions, + * a power of two should be preferred. + */ +//#define MBEDTLS_SSL_TLS1_3_PADDING_GRANULARITY 1 + +/** \def MBEDTLS_SSL_OUT_CONTENT_LEN + * + * Maximum length (in bytes) of outgoing plaintext fragments. + * + * This determines the size of the outgoing TLS I/O buffer in such a way + * that it is capable of holding the specified amount of plaintext data, + * regardless of the protection mechanism used. + * + * If this option undefined, it inherits its value from + * #MBEDTLS_SSL_MAX_CONTENT_LEN. + * + * It is possible to save RAM by setting a smaller outward buffer, while keeping + * the default inward 16384 byte buffer to conform to the TLS specification. + * + * The minimum required outward buffer size is determined by the handshake + * protocol's usage. Handshaking will fail if the outward buffer is too small. + * The specific size requirement depends on the configured ciphers and any + * certificate data which is sent during the handshake. + * + * Uncomment to set the maximum plaintext size of the outgoing I/O buffer + * independently of the incoming I/O buffer. + */ +//#define MBEDTLS_SSL_OUT_CONTENT_LEN 16384 + +/** \def MBEDTLS_SSL_DTLS_MAX_BUFFERING + * + * Maximum number of heap-allocated bytes for the purpose of + * DTLS handshake message reassembly and future message buffering. + * + * This should be at least 9/8 * MBEDTLS_SSL_IN_CONTENT_LEN + * to account for a reassembled handshake message of maximum size, + * together with its reassembly bitmap. + * + * A value of 2 * MBEDTLS_SSL_IN_CONTENT_LEN (32768 by default) + * should be sufficient for all practical situations as it allows + * to reassembly a large handshake message (such as a certificate) + * while buffering multiple smaller handshake messages. + * + */ +//#define MBEDTLS_SSL_DTLS_MAX_BUFFERING 32768 + +//#define MBEDTLS_SSL_DEFAULT_TICKET_LIFETIME 86400 /**< Lifetime of session tickets (if enabled) */ +//#define MBEDTLS_PSK_MAX_LEN 32 /**< Max size of TLS pre-shared keys, in bytes (default 256 bits) */ +//#define MBEDTLS_SSL_COOKIE_TIMEOUT 60 /**< Default expiration delay of DTLS cookies, in seconds if HAVE_TIME, or in number of cookies issued */ + +/** \def MBEDTLS_TLS_EXT_CID + * + * At the time of writing, the CID extension has not been assigned its + * final value. Set this configuration option to make Mbed TLS use a + * different value. + * + * A future minor revision of Mbed TLS may change the default value of + * this option to match evolving standards and usage. + */ +//#define MBEDTLS_TLS_EXT_CID 254 + +/** + * Complete list of ciphersuites to use, in order of preference. + * + * \warning No dependency checking is done on that field! This option can only + * be used to restrict the set of available ciphersuites. It is your + * responsibility to make sure the needed modules are active. + * + * Use this to save a few hundred bytes of ROM (default ordering of all + * available ciphersuites) and a few to a few hundred bytes of RAM. + * + * The value below is only an example, not the default. + */ +//#define MBEDTLS_SSL_CIPHERSUITES MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,MBEDTLS_TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 + +/* X509 options */ +//#define MBEDTLS_X509_MAX_INTERMEDIATE_CA 8 /**< Maximum number of intermediate CAs in a verification chain. */ +//#define MBEDTLS_X509_MAX_FILE_PATH_LEN 512 /**< Maximum length of a path/filename string in bytes including the null terminator character ('\0'). */ + +/** \} name SECTION: Module configuration options */ + +/* Target and application specific configurations + * + * Allow user to override any previous default. + * + */ +#if defined(MBEDTLS_USER_CONFIG_FILE) +#include MBEDTLS_USER_CONFIG_FILE +#endif + +#if defined(MBEDTLS_PSA_CRYPTO_CONFIG) +#include "mbedtls/config_psa.h" +#endif + +#include "mbedtls/check_config.h" + +#endif /* MBEDTLS_CONFIG_H */ diff --git a/lib/nlohmann_json/BUILD.bazel b/lib/nlohmann_json/BUILD.bazel new file mode 100644 index 0000000..1060277 --- /dev/null +++ b/lib/nlohmann_json/BUILD.bazel @@ -0,0 +1,7 @@ +package(default_visibility = ["//visibility:public"]) + +cc_library( + name = "json", + hdrs = ["single_include/nlohmann/json.hpp"], + includes = ["single_include"], +) diff --git a/lib/nlohmann_json/CMakeLists.txt b/lib/nlohmann_json/CMakeLists.txt new file mode 100644 index 0000000..e537e03 --- /dev/null +++ b/lib/nlohmann_json/CMakeLists.txt @@ -0,0 +1,126 @@ +cmake_minimum_required(VERSION 3.1...3.14) + +## +## PROJECT +## name and version +## +project(nlohmann_json VERSION 3.11.3 LANGUAGES CXX) + +## +## MAIN_PROJECT CHECK +## determine if nlohmann_json is built as a subproject (using add_subdirectory) or if it is the main project +## +set(MAIN_PROJECT OFF) +if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) + set(MAIN_PROJECT ON) +endif() + +## +## INCLUDE +## +## +set(CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake ${CMAKE_MODULE_PATH}) +include(ExternalProject) + +## +## OPTIONS +## + +if (POLICY CMP0077) + # Allow CMake 3.13+ to override options when using FetchContent / add_subdirectory. + cmake_policy(SET CMP0077 NEW) +endif () + +# VERSION_GREATER_EQUAL is not available in CMake 3.1 +if(${MAIN_PROJECT} AND (${CMAKE_VERSION} VERSION_EQUAL 3.13 OR ${CMAKE_VERSION} VERSION_GREATER 3.13)) + set(JSON_BuildTests_INIT ON) +else() + set(JSON_BuildTests_INIT OFF) +endif() +option(JSON_BuildTests "Build the unit tests when BUILD_TESTING is enabled." ${JSON_BuildTests_INIT}) +option(JSON_CI "Enable CI build targets." OFF) +option(JSON_Diagnostics "Use extended diagnostic messages." OFF) +option(JSON_GlobalUDLs "Place use-defined string literals in the global namespace." ON) +option(JSON_ImplicitConversions "Enable implicit conversions." ON) +option(JSON_DisableEnumSerialization "Disable default integer enum serialization." OFF) +option(JSON_LegacyDiscardedValueComparison "Enable legacy discarded value comparison." OFF) +option(JSON_Install "Install CMake targets during install step." ${MAIN_PROJECT}) +option(JSON_MultipleHeaders "Use non-amalgamated version of the library." OFF) +option(JSON_SystemInclude "Include as system headers (skip for clang-tidy)." OFF) + +if (JSON_CI) + include(ci) +endif () + +## +## CONFIGURATION +## +include(GNUInstallDirs) + +set(NLOHMANN_JSON_TARGET_NAME ${PROJECT_NAME}) +set(NLOHMANN_JSON_CONFIG_INSTALL_DIR "${CMAKE_INSTALL_DATADIR}/cmake/${PROJECT_NAME}" CACHE INTERNAL "") +set(NLOHMANN_JSON_INCLUDE_INSTALL_DIR "${CMAKE_INSTALL_INCLUDEDIR}") +set(NLOHMANN_JSON_TARGETS_EXPORT_NAME "${PROJECT_NAME}Targets") +set(NLOHMANN_JSON_CMAKE_CONFIG_TEMPLATE "cmake/config.cmake.in") +set(NLOHMANN_JSON_CMAKE_CONFIG_DIR "${CMAKE_CURRENT_BINARY_DIR}") +set(NLOHMANN_JSON_CMAKE_VERSION_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}ConfigVersion.cmake") +set(NLOHMANN_JSON_CMAKE_PROJECT_CONFIG_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Config.cmake") +set(NLOHMANN_JSON_CMAKE_PROJECT_TARGETS_FILE "${NLOHMANN_JSON_CMAKE_CONFIG_DIR}/${PROJECT_NAME}Targets.cmake") +set(NLOHMANN_JSON_PKGCONFIG_INSTALL_DIR "${CMAKE_INSTALL_DATADIR}/pkgconfig") + +if (JSON_MultipleHeaders) + set(NLOHMANN_JSON_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/include/") + message(STATUS "Using the multi-header code from ${NLOHMANN_JSON_INCLUDE_BUILD_DIR}") +else() + set(NLOHMANN_JSON_INCLUDE_BUILD_DIR "${PROJECT_SOURCE_DIR}/single_include/") + message(STATUS "Using the single-header code from ${NLOHMANN_JSON_INCLUDE_BUILD_DIR}") +endif() + +if (NOT JSON_ImplicitConversions) + message(STATUS "Implicit conversions are disabled") +endif() + +if (JSON_DisableEnumSerialization) + message(STATUS "Enum integer serialization is disabled") +endif() + +if (JSON_LegacyDiscardedValueComparison) + message(STATUS "Legacy discarded value comparison enabled") +endif() + +if (JSON_Diagnostics) + message(STATUS "Diagnostics enabled") +endif() + +if (JSON_SystemInclude) + set(NLOHMANN_JSON_SYSTEM_INCLUDE "SYSTEM") +endif() + +## +## TARGET +## create target and add include path +## +add_library(${NLOHMANN_JSON_TARGET_NAME} INTERFACE) +add_library(${PROJECT_NAME}::${NLOHMANN_JSON_TARGET_NAME} ALIAS ${NLOHMANN_JSON_TARGET_NAME}) +if (${CMAKE_VERSION} VERSION_LESS "3.8.0") + target_compile_features(${NLOHMANN_JSON_TARGET_NAME} INTERFACE cxx_range_for) +else() + target_compile_features(${NLOHMANN_JSON_TARGET_NAME} INTERFACE cxx_std_11) +endif() + +target_compile_definitions( + ${NLOHMANN_JSON_TARGET_NAME} + INTERFACE + $<$>:JSON_USE_GLOBAL_UDLS=0> + $<$>:JSON_USE_IMPLICIT_CONVERSIONS=0> + $<$:JSON_DISABLE_ENUM_SERIALIZATION=1> + $<$:JSON_DIAGNOSTICS=1> + $<$:JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON=1> +) + +target_include_directories( + ${NLOHMANN_JSON_TARGET_NAME} + ${NLOHMANN_JSON_SYSTEM_INCLUDE} INTERFACE + $ + $ +) diff --git a/lib/nlohmann_json/LICENSE.MIT b/lib/nlohmann_json/LICENSE.MIT new file mode 100644 index 0000000..1c1f7a6 --- /dev/null +++ b/lib/nlohmann_json/LICENSE.MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2013-2022 Niels Lohmann + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/lib/nlohmann_json/single_include/nlohmann/json.hpp b/lib/nlohmann_json/single_include/nlohmann/json.hpp new file mode 100644 index 0000000..a858728 --- /dev/null +++ b/lib/nlohmann_json/single_include/nlohmann/json.hpp @@ -0,0 +1,24766 @@ +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + +/****************************************************************************\ + * Note on documentation: The source files contain links to the online * + * documentation of the public API at https://json.nlohmann.me. This URL * + * contains the most recent documentation and should also be applicable to * + * previous versions; documentation for deprecated functions is not * + * removed, but marked deprecated. See "Generate documentation" section in * + * file docs/README.md. * +\****************************************************************************/ + +#ifndef INCLUDE_NLOHMANN_JSON_HPP_ +#define INCLUDE_NLOHMANN_JSON_HPP_ + +#include // all_of, find, for_each +#include // nullptr_t, ptrdiff_t, size_t +#include // hash, less +#include // initializer_list +#ifndef JSON_NO_IO + #include // istream, ostream +#endif // JSON_NO_IO +#include // random_access_iterator_tag +#include // unique_ptr +#include // string, stoi, to_string +#include // declval, forward, move, pair, swap +#include // vector + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +// This file contains all macro definitions affecting or depending on the ABI + +#ifndef JSON_SKIP_LIBRARY_VERSION_CHECK + #if defined(NLOHMANN_JSON_VERSION_MAJOR) && defined(NLOHMANN_JSON_VERSION_MINOR) && defined(NLOHMANN_JSON_VERSION_PATCH) + #if NLOHMANN_JSON_VERSION_MAJOR != 3 || NLOHMANN_JSON_VERSION_MINOR != 11 || NLOHMANN_JSON_VERSION_PATCH != 3 + #warning "Already included a different version of the library!" + #endif + #endif +#endif + +#define NLOHMANN_JSON_VERSION_MAJOR 3 // NOLINT(modernize-macro-to-enum) +#define NLOHMANN_JSON_VERSION_MINOR 11 // NOLINT(modernize-macro-to-enum) +#define NLOHMANN_JSON_VERSION_PATCH 3 // NOLINT(modernize-macro-to-enum) + +#ifndef JSON_DIAGNOSTICS + #define JSON_DIAGNOSTICS 0 +#endif + +#ifndef JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON + #define JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON 0 +#endif + +#if JSON_DIAGNOSTICS + #define NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS _diag +#else + #define NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS +#endif + +#if JSON_USE_LEGACY_DISCARDED_VALUE_COMPARISON + #define NLOHMANN_JSON_ABI_TAG_LEGACY_DISCARDED_VALUE_COMPARISON _ldvcmp +#else + #define NLOHMANN_JSON_ABI_TAG_LEGACY_DISCARDED_VALUE_COMPARISON +#endif + +#ifndef NLOHMANN_JSON_NAMESPACE_NO_VERSION + #define NLOHMANN_JSON_NAMESPACE_NO_VERSION 0 +#endif + +// Construct the namespace ABI tags component +#define NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b) json_abi ## a ## b +#define NLOHMANN_JSON_ABI_TAGS_CONCAT(a, b) \ + NLOHMANN_JSON_ABI_TAGS_CONCAT_EX(a, b) + +#define NLOHMANN_JSON_ABI_TAGS \ + NLOHMANN_JSON_ABI_TAGS_CONCAT( \ + NLOHMANN_JSON_ABI_TAG_DIAGNOSTICS, \ + NLOHMANN_JSON_ABI_TAG_LEGACY_DISCARDED_VALUE_COMPARISON) + +// Construct the namespace version component +#define NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT_EX(major, minor, patch) \ + _v ## major ## _ ## minor ## _ ## patch +#define NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT(major, minor, patch) \ + NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT_EX(major, minor, patch) + +#if NLOHMANN_JSON_NAMESPACE_NO_VERSION +#define NLOHMANN_JSON_NAMESPACE_VERSION +#else +#define NLOHMANN_JSON_NAMESPACE_VERSION \ + NLOHMANN_JSON_NAMESPACE_VERSION_CONCAT(NLOHMANN_JSON_VERSION_MAJOR, \ + NLOHMANN_JSON_VERSION_MINOR, \ + NLOHMANN_JSON_VERSION_PATCH) +#endif + +// Combine namespace components +#define NLOHMANN_JSON_NAMESPACE_CONCAT_EX(a, b) a ## b +#define NLOHMANN_JSON_NAMESPACE_CONCAT(a, b) \ + NLOHMANN_JSON_NAMESPACE_CONCAT_EX(a, b) + +#ifndef NLOHMANN_JSON_NAMESPACE +#define NLOHMANN_JSON_NAMESPACE \ + nlohmann::NLOHMANN_JSON_NAMESPACE_CONCAT( \ + NLOHMANN_JSON_ABI_TAGS, \ + NLOHMANN_JSON_NAMESPACE_VERSION) +#endif + +#ifndef NLOHMANN_JSON_NAMESPACE_BEGIN +#define NLOHMANN_JSON_NAMESPACE_BEGIN \ + namespace nlohmann \ + { \ + inline namespace NLOHMANN_JSON_NAMESPACE_CONCAT( \ + NLOHMANN_JSON_ABI_TAGS, \ + NLOHMANN_JSON_NAMESPACE_VERSION) \ + { +#endif + +#ifndef NLOHMANN_JSON_NAMESPACE_END +#define NLOHMANN_JSON_NAMESPACE_END \ + } /* namespace (inline namespace) NOLINT(readability/namespace) */ \ + } // namespace nlohmann +#endif + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // transform +#include // array +#include // forward_list +#include // inserter, front_inserter, end +#include // map +#include // string +#include // tuple, make_tuple +#include // is_arithmetic, is_same, is_enum, underlying_type, is_convertible +#include // unordered_map +#include // pair, declval +#include // valarray + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // nullptr_t +#include // exception +#if JSON_DIAGNOSTICS + #include // accumulate +#endif +#include // runtime_error +#include // to_string +#include // vector + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // array +#include // size_t +#include // uint8_t +#include // string + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // declval, pair +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +template struct make_void +{ + using type = void; +}; +template using void_t = typename make_void::type; + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +// https://en.cppreference.com/w/cpp/experimental/is_detected +struct nonesuch +{ + nonesuch() = delete; + ~nonesuch() = delete; + nonesuch(nonesuch const&) = delete; + nonesuch(nonesuch const&&) = delete; + void operator=(nonesuch const&) = delete; + void operator=(nonesuch&&) = delete; +}; + +template class Op, + class... Args> +struct detector +{ + using value_t = std::false_type; + using type = Default; +}; + +template class Op, class... Args> +struct detector>, Op, Args...> +{ + using value_t = std::true_type; + using type = Op; +}; + +template class Op, class... Args> +using is_detected = typename detector::value_t; + +template class Op, class... Args> +struct is_detected_lazy : is_detected { }; + +template class Op, class... Args> +using detected_t = typename detector::type; + +template class Op, class... Args> +using detected_or = detector; + +template class Op, class... Args> +using detected_or_t = typename detected_or::type; + +template class Op, class... Args> +using is_detected_exact = std::is_same>; + +template class Op, class... Args> +using is_detected_convertible = + std::is_convertible, To>; + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + +// #include + + +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-FileCopyrightText: 2016-2021 Evan Nemerson +// SPDX-License-Identifier: MIT + +/* Hedley - https://nemequ.github.io/hedley + * Created by Evan Nemerson + */ + +#if !defined(JSON_HEDLEY_VERSION) || (JSON_HEDLEY_VERSION < 15) +#if defined(JSON_HEDLEY_VERSION) + #undef JSON_HEDLEY_VERSION +#endif +#define JSON_HEDLEY_VERSION 15 + +#if defined(JSON_HEDLEY_STRINGIFY_EX) + #undef JSON_HEDLEY_STRINGIFY_EX +#endif +#define JSON_HEDLEY_STRINGIFY_EX(x) #x + +#if defined(JSON_HEDLEY_STRINGIFY) + #undef JSON_HEDLEY_STRINGIFY +#endif +#define JSON_HEDLEY_STRINGIFY(x) JSON_HEDLEY_STRINGIFY_EX(x) + +#if defined(JSON_HEDLEY_CONCAT_EX) + #undef JSON_HEDLEY_CONCAT_EX +#endif +#define JSON_HEDLEY_CONCAT_EX(a,b) a##b + +#if defined(JSON_HEDLEY_CONCAT) + #undef JSON_HEDLEY_CONCAT +#endif +#define JSON_HEDLEY_CONCAT(a,b) JSON_HEDLEY_CONCAT_EX(a,b) + +#if defined(JSON_HEDLEY_CONCAT3_EX) + #undef JSON_HEDLEY_CONCAT3_EX +#endif +#define JSON_HEDLEY_CONCAT3_EX(a,b,c) a##b##c + +#if defined(JSON_HEDLEY_CONCAT3) + #undef JSON_HEDLEY_CONCAT3 +#endif +#define JSON_HEDLEY_CONCAT3(a,b,c) JSON_HEDLEY_CONCAT3_EX(a,b,c) + +#if defined(JSON_HEDLEY_VERSION_ENCODE) + #undef JSON_HEDLEY_VERSION_ENCODE +#endif +#define JSON_HEDLEY_VERSION_ENCODE(major,minor,revision) (((major) * 1000000) + ((minor) * 1000) + (revision)) + +#if defined(JSON_HEDLEY_VERSION_DECODE_MAJOR) + #undef JSON_HEDLEY_VERSION_DECODE_MAJOR +#endif +#define JSON_HEDLEY_VERSION_DECODE_MAJOR(version) ((version) / 1000000) + +#if defined(JSON_HEDLEY_VERSION_DECODE_MINOR) + #undef JSON_HEDLEY_VERSION_DECODE_MINOR +#endif +#define JSON_HEDLEY_VERSION_DECODE_MINOR(version) (((version) % 1000000) / 1000) + +#if defined(JSON_HEDLEY_VERSION_DECODE_REVISION) + #undef JSON_HEDLEY_VERSION_DECODE_REVISION +#endif +#define JSON_HEDLEY_VERSION_DECODE_REVISION(version) ((version) % 1000) + +#if defined(JSON_HEDLEY_GNUC_VERSION) + #undef JSON_HEDLEY_GNUC_VERSION +#endif +#if defined(__GNUC__) && defined(__GNUC_PATCHLEVEL__) + #define JSON_HEDLEY_GNUC_VERSION JSON_HEDLEY_VERSION_ENCODE(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__) +#elif defined(__GNUC__) + #define JSON_HEDLEY_GNUC_VERSION JSON_HEDLEY_VERSION_ENCODE(__GNUC__, __GNUC_MINOR__, 0) +#endif + +#if defined(JSON_HEDLEY_GNUC_VERSION_CHECK) + #undef JSON_HEDLEY_GNUC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_GNUC_VERSION) + #define JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_GNUC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_MSVC_VERSION) + #undef JSON_HEDLEY_MSVC_VERSION +#endif +#if defined(_MSC_FULL_VER) && (_MSC_FULL_VER >= 140000000) && !defined(__ICL) + #define JSON_HEDLEY_MSVC_VERSION JSON_HEDLEY_VERSION_ENCODE(_MSC_FULL_VER / 10000000, (_MSC_FULL_VER % 10000000) / 100000, (_MSC_FULL_VER % 100000) / 100) +#elif defined(_MSC_FULL_VER) && !defined(__ICL) + #define JSON_HEDLEY_MSVC_VERSION JSON_HEDLEY_VERSION_ENCODE(_MSC_FULL_VER / 1000000, (_MSC_FULL_VER % 1000000) / 10000, (_MSC_FULL_VER % 10000) / 10) +#elif defined(_MSC_VER) && !defined(__ICL) + #define JSON_HEDLEY_MSVC_VERSION JSON_HEDLEY_VERSION_ENCODE(_MSC_VER / 100, _MSC_VER % 100, 0) +#endif + +#if defined(JSON_HEDLEY_MSVC_VERSION_CHECK) + #undef JSON_HEDLEY_MSVC_VERSION_CHECK +#endif +#if !defined(JSON_HEDLEY_MSVC_VERSION) + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (0) +#elif defined(_MSC_VER) && (_MSC_VER >= 1400) + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (_MSC_FULL_VER >= ((major * 10000000) + (minor * 100000) + (patch))) +#elif defined(_MSC_VER) && (_MSC_VER >= 1200) + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (_MSC_FULL_VER >= ((major * 1000000) + (minor * 10000) + (patch))) +#else + #define JSON_HEDLEY_MSVC_VERSION_CHECK(major,minor,patch) (_MSC_VER >= ((major * 100) + (minor))) +#endif + +#if defined(JSON_HEDLEY_INTEL_VERSION) + #undef JSON_HEDLEY_INTEL_VERSION +#endif +#if defined(__INTEL_COMPILER) && defined(__INTEL_COMPILER_UPDATE) && !defined(__ICL) + #define JSON_HEDLEY_INTEL_VERSION JSON_HEDLEY_VERSION_ENCODE(__INTEL_COMPILER / 100, __INTEL_COMPILER % 100, __INTEL_COMPILER_UPDATE) +#elif defined(__INTEL_COMPILER) && !defined(__ICL) + #define JSON_HEDLEY_INTEL_VERSION JSON_HEDLEY_VERSION_ENCODE(__INTEL_COMPILER / 100, __INTEL_COMPILER % 100, 0) +#endif + +#if defined(JSON_HEDLEY_INTEL_VERSION_CHECK) + #undef JSON_HEDLEY_INTEL_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_INTEL_VERSION) + #define JSON_HEDLEY_INTEL_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_INTEL_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_INTEL_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_INTEL_CL_VERSION) + #undef JSON_HEDLEY_INTEL_CL_VERSION +#endif +#if defined(__INTEL_COMPILER) && defined(__INTEL_COMPILER_UPDATE) && defined(__ICL) + #define JSON_HEDLEY_INTEL_CL_VERSION JSON_HEDLEY_VERSION_ENCODE(__INTEL_COMPILER, __INTEL_COMPILER_UPDATE, 0) +#endif + +#if defined(JSON_HEDLEY_INTEL_CL_VERSION_CHECK) + #undef JSON_HEDLEY_INTEL_CL_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_INTEL_CL_VERSION) + #define JSON_HEDLEY_INTEL_CL_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_INTEL_CL_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_INTEL_CL_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_PGI_VERSION) + #undef JSON_HEDLEY_PGI_VERSION +#endif +#if defined(__PGI) && defined(__PGIC__) && defined(__PGIC_MINOR__) && defined(__PGIC_PATCHLEVEL__) + #define JSON_HEDLEY_PGI_VERSION JSON_HEDLEY_VERSION_ENCODE(__PGIC__, __PGIC_MINOR__, __PGIC_PATCHLEVEL__) +#endif + +#if defined(JSON_HEDLEY_PGI_VERSION_CHECK) + #undef JSON_HEDLEY_PGI_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_PGI_VERSION) + #define JSON_HEDLEY_PGI_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_PGI_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_PGI_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_SUNPRO_VERSION) + #undef JSON_HEDLEY_SUNPRO_VERSION +#endif +#if defined(__SUNPRO_C) && (__SUNPRO_C > 0x1000) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((((__SUNPRO_C >> 16) & 0xf) * 10) + ((__SUNPRO_C >> 12) & 0xf), (((__SUNPRO_C >> 8) & 0xf) * 10) + ((__SUNPRO_C >> 4) & 0xf), (__SUNPRO_C & 0xf) * 10) +#elif defined(__SUNPRO_C) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((__SUNPRO_C >> 8) & 0xf, (__SUNPRO_C >> 4) & 0xf, (__SUNPRO_C) & 0xf) +#elif defined(__SUNPRO_CC) && (__SUNPRO_CC > 0x1000) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((((__SUNPRO_CC >> 16) & 0xf) * 10) + ((__SUNPRO_CC >> 12) & 0xf), (((__SUNPRO_CC >> 8) & 0xf) * 10) + ((__SUNPRO_CC >> 4) & 0xf), (__SUNPRO_CC & 0xf) * 10) +#elif defined(__SUNPRO_CC) + #define JSON_HEDLEY_SUNPRO_VERSION JSON_HEDLEY_VERSION_ENCODE((__SUNPRO_CC >> 8) & 0xf, (__SUNPRO_CC >> 4) & 0xf, (__SUNPRO_CC) & 0xf) +#endif + +#if defined(JSON_HEDLEY_SUNPRO_VERSION_CHECK) + #undef JSON_HEDLEY_SUNPRO_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_SUNPRO_VERSION) + #define JSON_HEDLEY_SUNPRO_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_SUNPRO_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_SUNPRO_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_EMSCRIPTEN_VERSION) + #undef JSON_HEDLEY_EMSCRIPTEN_VERSION +#endif +#if defined(__EMSCRIPTEN__) + #define JSON_HEDLEY_EMSCRIPTEN_VERSION JSON_HEDLEY_VERSION_ENCODE(__EMSCRIPTEN_major__, __EMSCRIPTEN_minor__, __EMSCRIPTEN_tiny__) +#endif + +#if defined(JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK) + #undef JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_EMSCRIPTEN_VERSION) + #define JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_EMSCRIPTEN_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_EMSCRIPTEN_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_ARM_VERSION) + #undef JSON_HEDLEY_ARM_VERSION +#endif +#if defined(__CC_ARM) && defined(__ARMCOMPILER_VERSION) + #define JSON_HEDLEY_ARM_VERSION JSON_HEDLEY_VERSION_ENCODE(__ARMCOMPILER_VERSION / 1000000, (__ARMCOMPILER_VERSION % 1000000) / 10000, (__ARMCOMPILER_VERSION % 10000) / 100) +#elif defined(__CC_ARM) && defined(__ARMCC_VERSION) + #define JSON_HEDLEY_ARM_VERSION JSON_HEDLEY_VERSION_ENCODE(__ARMCC_VERSION / 1000000, (__ARMCC_VERSION % 1000000) / 10000, (__ARMCC_VERSION % 10000) / 100) +#endif + +#if defined(JSON_HEDLEY_ARM_VERSION_CHECK) + #undef JSON_HEDLEY_ARM_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_ARM_VERSION) + #define JSON_HEDLEY_ARM_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_ARM_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_ARM_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_IBM_VERSION) + #undef JSON_HEDLEY_IBM_VERSION +#endif +#if defined(__ibmxl__) + #define JSON_HEDLEY_IBM_VERSION JSON_HEDLEY_VERSION_ENCODE(__ibmxl_version__, __ibmxl_release__, __ibmxl_modification__) +#elif defined(__xlC__) && defined(__xlC_ver__) + #define JSON_HEDLEY_IBM_VERSION JSON_HEDLEY_VERSION_ENCODE(__xlC__ >> 8, __xlC__ & 0xff, (__xlC_ver__ >> 8) & 0xff) +#elif defined(__xlC__) + #define JSON_HEDLEY_IBM_VERSION JSON_HEDLEY_VERSION_ENCODE(__xlC__ >> 8, __xlC__ & 0xff, 0) +#endif + +#if defined(JSON_HEDLEY_IBM_VERSION_CHECK) + #undef JSON_HEDLEY_IBM_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_IBM_VERSION) + #define JSON_HEDLEY_IBM_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_IBM_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_IBM_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_VERSION) + #undef JSON_HEDLEY_TI_VERSION +#endif +#if \ + defined(__TI_COMPILER_VERSION__) && \ + ( \ + defined(__TMS470__) || defined(__TI_ARM__) || \ + defined(__MSP430__) || \ + defined(__TMS320C2000__) \ + ) +#if (__TI_COMPILER_VERSION__ >= 16000000) + #define JSON_HEDLEY_TI_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif +#endif + +#if defined(JSON_HEDLEY_TI_VERSION_CHECK) + #undef JSON_HEDLEY_TI_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_VERSION) + #define JSON_HEDLEY_TI_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL2000_VERSION) + #undef JSON_HEDLEY_TI_CL2000_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__TMS320C2000__) + #define JSON_HEDLEY_TI_CL2000_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL2000_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL2000_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL2000_VERSION) + #define JSON_HEDLEY_TI_CL2000_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL2000_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL2000_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL430_VERSION) + #undef JSON_HEDLEY_TI_CL430_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__MSP430__) + #define JSON_HEDLEY_TI_CL430_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL430_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL430_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL430_VERSION) + #define JSON_HEDLEY_TI_CL430_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL430_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL430_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_ARMCL_VERSION) + #undef JSON_HEDLEY_TI_ARMCL_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && (defined(__TMS470__) || defined(__TI_ARM__)) + #define JSON_HEDLEY_TI_ARMCL_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_ARMCL_VERSION_CHECK) + #undef JSON_HEDLEY_TI_ARMCL_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_ARMCL_VERSION) + #define JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_ARMCL_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL6X_VERSION) + #undef JSON_HEDLEY_TI_CL6X_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__TMS320C6X__) + #define JSON_HEDLEY_TI_CL6X_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL6X_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL6X_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL6X_VERSION) + #define JSON_HEDLEY_TI_CL6X_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL6X_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL6X_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CL7X_VERSION) + #undef JSON_HEDLEY_TI_CL7X_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__C7000__) + #define JSON_HEDLEY_TI_CL7X_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CL7X_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CL7X_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CL7X_VERSION) + #define JSON_HEDLEY_TI_CL7X_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CL7X_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CL7X_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TI_CLPRU_VERSION) + #undef JSON_HEDLEY_TI_CLPRU_VERSION +#endif +#if defined(__TI_COMPILER_VERSION__) && defined(__PRU__) + #define JSON_HEDLEY_TI_CLPRU_VERSION JSON_HEDLEY_VERSION_ENCODE(__TI_COMPILER_VERSION__ / 1000000, (__TI_COMPILER_VERSION__ % 1000000) / 1000, (__TI_COMPILER_VERSION__ % 1000)) +#endif + +#if defined(JSON_HEDLEY_TI_CLPRU_VERSION_CHECK) + #undef JSON_HEDLEY_TI_CLPRU_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TI_CLPRU_VERSION) + #define JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TI_CLPRU_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_CRAY_VERSION) + #undef JSON_HEDLEY_CRAY_VERSION +#endif +#if defined(_CRAYC) + #if defined(_RELEASE_PATCHLEVEL) + #define JSON_HEDLEY_CRAY_VERSION JSON_HEDLEY_VERSION_ENCODE(_RELEASE_MAJOR, _RELEASE_MINOR, _RELEASE_PATCHLEVEL) + #else + #define JSON_HEDLEY_CRAY_VERSION JSON_HEDLEY_VERSION_ENCODE(_RELEASE_MAJOR, _RELEASE_MINOR, 0) + #endif +#endif + +#if defined(JSON_HEDLEY_CRAY_VERSION_CHECK) + #undef JSON_HEDLEY_CRAY_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_CRAY_VERSION) + #define JSON_HEDLEY_CRAY_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_CRAY_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_CRAY_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_IAR_VERSION) + #undef JSON_HEDLEY_IAR_VERSION +#endif +#if defined(__IAR_SYSTEMS_ICC__) + #if __VER__ > 1000 + #define JSON_HEDLEY_IAR_VERSION JSON_HEDLEY_VERSION_ENCODE((__VER__ / 1000000), ((__VER__ / 1000) % 1000), (__VER__ % 1000)) + #else + #define JSON_HEDLEY_IAR_VERSION JSON_HEDLEY_VERSION_ENCODE(__VER__ / 100, __VER__ % 100, 0) + #endif +#endif + +#if defined(JSON_HEDLEY_IAR_VERSION_CHECK) + #undef JSON_HEDLEY_IAR_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_IAR_VERSION) + #define JSON_HEDLEY_IAR_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_IAR_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_IAR_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_TINYC_VERSION) + #undef JSON_HEDLEY_TINYC_VERSION +#endif +#if defined(__TINYC__) + #define JSON_HEDLEY_TINYC_VERSION JSON_HEDLEY_VERSION_ENCODE(__TINYC__ / 1000, (__TINYC__ / 100) % 10, __TINYC__ % 100) +#endif + +#if defined(JSON_HEDLEY_TINYC_VERSION_CHECK) + #undef JSON_HEDLEY_TINYC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_TINYC_VERSION) + #define JSON_HEDLEY_TINYC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_TINYC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_TINYC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_DMC_VERSION) + #undef JSON_HEDLEY_DMC_VERSION +#endif +#if defined(__DMC__) + #define JSON_HEDLEY_DMC_VERSION JSON_HEDLEY_VERSION_ENCODE(__DMC__ >> 8, (__DMC__ >> 4) & 0xf, __DMC__ & 0xf) +#endif + +#if defined(JSON_HEDLEY_DMC_VERSION_CHECK) + #undef JSON_HEDLEY_DMC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_DMC_VERSION) + #define JSON_HEDLEY_DMC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_DMC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_DMC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_COMPCERT_VERSION) + #undef JSON_HEDLEY_COMPCERT_VERSION +#endif +#if defined(__COMPCERT_VERSION__) + #define JSON_HEDLEY_COMPCERT_VERSION JSON_HEDLEY_VERSION_ENCODE(__COMPCERT_VERSION__ / 10000, (__COMPCERT_VERSION__ / 100) % 100, __COMPCERT_VERSION__ % 100) +#endif + +#if defined(JSON_HEDLEY_COMPCERT_VERSION_CHECK) + #undef JSON_HEDLEY_COMPCERT_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_COMPCERT_VERSION) + #define JSON_HEDLEY_COMPCERT_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_COMPCERT_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_COMPCERT_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_PELLES_VERSION) + #undef JSON_HEDLEY_PELLES_VERSION +#endif +#if defined(__POCC__) + #define JSON_HEDLEY_PELLES_VERSION JSON_HEDLEY_VERSION_ENCODE(__POCC__ / 100, __POCC__ % 100, 0) +#endif + +#if defined(JSON_HEDLEY_PELLES_VERSION_CHECK) + #undef JSON_HEDLEY_PELLES_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_PELLES_VERSION) + #define JSON_HEDLEY_PELLES_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_PELLES_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_PELLES_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_MCST_LCC_VERSION) + #undef JSON_HEDLEY_MCST_LCC_VERSION +#endif +#if defined(__LCC__) && defined(__LCC_MINOR__) + #define JSON_HEDLEY_MCST_LCC_VERSION JSON_HEDLEY_VERSION_ENCODE(__LCC__ / 100, __LCC__ % 100, __LCC_MINOR__) +#endif + +#if defined(JSON_HEDLEY_MCST_LCC_VERSION_CHECK) + #undef JSON_HEDLEY_MCST_LCC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_MCST_LCC_VERSION) + #define JSON_HEDLEY_MCST_LCC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_MCST_LCC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_MCST_LCC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_GCC_VERSION) + #undef JSON_HEDLEY_GCC_VERSION +#endif +#if \ + defined(JSON_HEDLEY_GNUC_VERSION) && \ + !defined(__clang__) && \ + !defined(JSON_HEDLEY_INTEL_VERSION) && \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_ARM_VERSION) && \ + !defined(JSON_HEDLEY_CRAY_VERSION) && \ + !defined(JSON_HEDLEY_TI_VERSION) && \ + !defined(JSON_HEDLEY_TI_ARMCL_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL430_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL2000_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL6X_VERSION) && \ + !defined(JSON_HEDLEY_TI_CL7X_VERSION) && \ + !defined(JSON_HEDLEY_TI_CLPRU_VERSION) && \ + !defined(__COMPCERT__) && \ + !defined(JSON_HEDLEY_MCST_LCC_VERSION) + #define JSON_HEDLEY_GCC_VERSION JSON_HEDLEY_GNUC_VERSION +#endif + +#if defined(JSON_HEDLEY_GCC_VERSION_CHECK) + #undef JSON_HEDLEY_GCC_VERSION_CHECK +#endif +#if defined(JSON_HEDLEY_GCC_VERSION) + #define JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) (JSON_HEDLEY_GCC_VERSION >= JSON_HEDLEY_VERSION_ENCODE(major, minor, patch)) +#else + #define JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) (0) +#endif + +#if defined(JSON_HEDLEY_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_HAS_ATTRIBUTE +#endif +#if \ + defined(__has_attribute) && \ + ( \ + (!defined(JSON_HEDLEY_IAR_VERSION) || JSON_HEDLEY_IAR_VERSION_CHECK(8,5,9)) \ + ) +# define JSON_HEDLEY_HAS_ATTRIBUTE(attribute) __has_attribute(attribute) +#else +# define JSON_HEDLEY_HAS_ATTRIBUTE(attribute) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_GNUC_HAS_ATTRIBUTE +#endif +#if defined(__has_attribute) + #define JSON_HEDLEY_GNUC_HAS_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_HAS_ATTRIBUTE(attribute) +#else + #define JSON_HEDLEY_GNUC_HAS_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_GCC_HAS_ATTRIBUTE +#endif +#if defined(__has_attribute) + #define JSON_HEDLEY_GCC_HAS_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_HAS_ATTRIBUTE(attribute) +#else + #define JSON_HEDLEY_GCC_HAS_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_HAS_CPP_ATTRIBUTE +#endif +#if \ + defined(__has_cpp_attribute) && \ + defined(__cplusplus) && \ + (!defined(JSON_HEDLEY_SUNPRO_VERSION) || JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0)) + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE(attribute) __has_cpp_attribute(attribute) +#else + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE(attribute) (0) +#endif + +#if defined(JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS) + #undef JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS +#endif +#if !defined(__cplusplus) || !defined(__has_cpp_attribute) + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(ns,attribute) (0) +#elif \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_IAR_VERSION) && \ + (!defined(JSON_HEDLEY_SUNPRO_VERSION) || JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0)) && \ + (!defined(JSON_HEDLEY_MSVC_VERSION) || JSON_HEDLEY_MSVC_VERSION_CHECK(19,20,0)) + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(ns,attribute) JSON_HEDLEY_HAS_CPP_ATTRIBUTE(ns::attribute) +#else + #define JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(ns,attribute) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE +#endif +#if defined(__has_cpp_attribute) && defined(__cplusplus) + #define JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) __has_cpp_attribute(attribute) +#else + #define JSON_HEDLEY_GNUC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE +#endif +#if defined(__has_cpp_attribute) && defined(__cplusplus) + #define JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) __has_cpp_attribute(attribute) +#else + #define JSON_HEDLEY_GCC_HAS_CPP_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_BUILTIN) + #undef JSON_HEDLEY_HAS_BUILTIN +#endif +#if defined(__has_builtin) + #define JSON_HEDLEY_HAS_BUILTIN(builtin) __has_builtin(builtin) +#else + #define JSON_HEDLEY_HAS_BUILTIN(builtin) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_BUILTIN) + #undef JSON_HEDLEY_GNUC_HAS_BUILTIN +#endif +#if defined(__has_builtin) + #define JSON_HEDLEY_GNUC_HAS_BUILTIN(builtin,major,minor,patch) __has_builtin(builtin) +#else + #define JSON_HEDLEY_GNUC_HAS_BUILTIN(builtin,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_BUILTIN) + #undef JSON_HEDLEY_GCC_HAS_BUILTIN +#endif +#if defined(__has_builtin) + #define JSON_HEDLEY_GCC_HAS_BUILTIN(builtin,major,minor,patch) __has_builtin(builtin) +#else + #define JSON_HEDLEY_GCC_HAS_BUILTIN(builtin,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_FEATURE) + #undef JSON_HEDLEY_HAS_FEATURE +#endif +#if defined(__has_feature) + #define JSON_HEDLEY_HAS_FEATURE(feature) __has_feature(feature) +#else + #define JSON_HEDLEY_HAS_FEATURE(feature) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_FEATURE) + #undef JSON_HEDLEY_GNUC_HAS_FEATURE +#endif +#if defined(__has_feature) + #define JSON_HEDLEY_GNUC_HAS_FEATURE(feature,major,minor,patch) __has_feature(feature) +#else + #define JSON_HEDLEY_GNUC_HAS_FEATURE(feature,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_FEATURE) + #undef JSON_HEDLEY_GCC_HAS_FEATURE +#endif +#if defined(__has_feature) + #define JSON_HEDLEY_GCC_HAS_FEATURE(feature,major,minor,patch) __has_feature(feature) +#else + #define JSON_HEDLEY_GCC_HAS_FEATURE(feature,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_EXTENSION) + #undef JSON_HEDLEY_HAS_EXTENSION +#endif +#if defined(__has_extension) + #define JSON_HEDLEY_HAS_EXTENSION(extension) __has_extension(extension) +#else + #define JSON_HEDLEY_HAS_EXTENSION(extension) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_EXTENSION) + #undef JSON_HEDLEY_GNUC_HAS_EXTENSION +#endif +#if defined(__has_extension) + #define JSON_HEDLEY_GNUC_HAS_EXTENSION(extension,major,minor,patch) __has_extension(extension) +#else + #define JSON_HEDLEY_GNUC_HAS_EXTENSION(extension,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_EXTENSION) + #undef JSON_HEDLEY_GCC_HAS_EXTENSION +#endif +#if defined(__has_extension) + #define JSON_HEDLEY_GCC_HAS_EXTENSION(extension,major,minor,patch) __has_extension(extension) +#else + #define JSON_HEDLEY_GCC_HAS_EXTENSION(extension,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE +#endif +#if defined(__has_declspec_attribute) + #define JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE(attribute) __has_declspec_attribute(attribute) +#else + #define JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE(attribute) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE +#endif +#if defined(__has_declspec_attribute) + #define JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) __has_declspec_attribute(attribute) +#else + #define JSON_HEDLEY_GNUC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE +#endif +#if defined(__has_declspec_attribute) + #define JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) __has_declspec_attribute(attribute) +#else + #define JSON_HEDLEY_GCC_HAS_DECLSPEC_ATTRIBUTE(attribute,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_HAS_WARNING) + #undef JSON_HEDLEY_HAS_WARNING +#endif +#if defined(__has_warning) + #define JSON_HEDLEY_HAS_WARNING(warning) __has_warning(warning) +#else + #define JSON_HEDLEY_HAS_WARNING(warning) (0) +#endif + +#if defined(JSON_HEDLEY_GNUC_HAS_WARNING) + #undef JSON_HEDLEY_GNUC_HAS_WARNING +#endif +#if defined(__has_warning) + #define JSON_HEDLEY_GNUC_HAS_WARNING(warning,major,minor,patch) __has_warning(warning) +#else + #define JSON_HEDLEY_GNUC_HAS_WARNING(warning,major,minor,patch) JSON_HEDLEY_GNUC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_GCC_HAS_WARNING) + #undef JSON_HEDLEY_GCC_HAS_WARNING +#endif +#if defined(__has_warning) + #define JSON_HEDLEY_GCC_HAS_WARNING(warning,major,minor,patch) __has_warning(warning) +#else + #define JSON_HEDLEY_GCC_HAS_WARNING(warning,major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if \ + (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || \ + defined(__clang__) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(18,4,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,7,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(2,0,1) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(5,0,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,17) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(8,0,0) || \ + (JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) && defined(__C99_PRAGMA_OPERATOR)) + #define JSON_HEDLEY_PRAGMA(value) _Pragma(#value) +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_PRAGMA(value) __pragma(value) +#else + #define JSON_HEDLEY_PRAGMA(value) +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_PUSH) + #undef JSON_HEDLEY_DIAGNOSTIC_PUSH +#endif +#if defined(JSON_HEDLEY_DIAGNOSTIC_POP) + #undef JSON_HEDLEY_DIAGNOSTIC_POP +#endif +#if defined(__clang__) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("clang diagnostic push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("clang diagnostic pop") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("warning(push)") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("warning(pop)") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,6,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("GCC diagnostic push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("GCC diagnostic pop") +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH __pragma(warning(push)) + #define JSON_HEDLEY_DIAGNOSTIC_POP __pragma(warning(pop)) +#elif JSON_HEDLEY_ARM_VERSION_CHECK(5,6,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("pop") +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,4,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("diag_push") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("diag_pop") +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(2,90,0) + #define JSON_HEDLEY_DIAGNOSTIC_PUSH _Pragma("warning(push)") + #define JSON_HEDLEY_DIAGNOSTIC_POP _Pragma("warning(pop)") +#else + #define JSON_HEDLEY_DIAGNOSTIC_PUSH + #define JSON_HEDLEY_DIAGNOSTIC_POP +#endif + +/* JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_ is for + HEDLEY INTERNAL USE ONLY. API subject to change without notice. */ +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_ +#endif +#if defined(__cplusplus) +# if JSON_HEDLEY_HAS_WARNING("-Wc++98-compat") +# if JSON_HEDLEY_HAS_WARNING("-Wc++17-extensions") +# if JSON_HEDLEY_HAS_WARNING("-Wc++1z-extensions") +# define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(xpr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wc++98-compat\"") \ + _Pragma("clang diagnostic ignored \"-Wc++17-extensions\"") \ + _Pragma("clang diagnostic ignored \"-Wc++1z-extensions\"") \ + xpr \ + JSON_HEDLEY_DIAGNOSTIC_POP +# else +# define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(xpr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wc++98-compat\"") \ + _Pragma("clang diagnostic ignored \"-Wc++17-extensions\"") \ + xpr \ + JSON_HEDLEY_DIAGNOSTIC_POP +# endif +# else +# define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(xpr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wc++98-compat\"") \ + xpr \ + JSON_HEDLEY_DIAGNOSTIC_POP +# endif +# endif +#endif +#if !defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(x) x +#endif + +#if defined(JSON_HEDLEY_CONST_CAST) + #undef JSON_HEDLEY_CONST_CAST +#endif +#if defined(__cplusplus) +# define JSON_HEDLEY_CONST_CAST(T, expr) (const_cast(expr)) +#elif \ + JSON_HEDLEY_HAS_WARNING("-Wcast-qual") || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,6,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) +# define JSON_HEDLEY_CONST_CAST(T, expr) (__extension__ ({ \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL \ + ((T) (expr)); \ + JSON_HEDLEY_DIAGNOSTIC_POP \ + })) +#else +# define JSON_HEDLEY_CONST_CAST(T, expr) ((T) (expr)) +#endif + +#if defined(JSON_HEDLEY_REINTERPRET_CAST) + #undef JSON_HEDLEY_REINTERPRET_CAST +#endif +#if defined(__cplusplus) + #define JSON_HEDLEY_REINTERPRET_CAST(T, expr) (reinterpret_cast(expr)) +#else + #define JSON_HEDLEY_REINTERPRET_CAST(T, expr) ((T) (expr)) +#endif + +#if defined(JSON_HEDLEY_STATIC_CAST) + #undef JSON_HEDLEY_STATIC_CAST +#endif +#if defined(__cplusplus) + #define JSON_HEDLEY_STATIC_CAST(T, expr) (static_cast(expr)) +#else + #define JSON_HEDLEY_STATIC_CAST(T, expr) ((T) (expr)) +#endif + +#if defined(JSON_HEDLEY_CPP_CAST) + #undef JSON_HEDLEY_CPP_CAST +#endif +#if defined(__cplusplus) +# if JSON_HEDLEY_HAS_WARNING("-Wold-style-cast") +# define JSON_HEDLEY_CPP_CAST(T, expr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wold-style-cast\"") \ + ((T) (expr)) \ + JSON_HEDLEY_DIAGNOSTIC_POP +# elif JSON_HEDLEY_IAR_VERSION_CHECK(8,3,0) +# define JSON_HEDLEY_CPP_CAST(T, expr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("diag_suppress=Pe137") \ + JSON_HEDLEY_DIAGNOSTIC_POP +# else +# define JSON_HEDLEY_CPP_CAST(T, expr) ((T) (expr)) +# endif +#else +# define JSON_HEDLEY_CPP_CAST(T, expr) (expr) +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wdeprecated-declarations") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("warning(disable:1478 1786)") +#elif JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED __pragma(warning(disable:1478 1786)) +#elif JSON_HEDLEY_PGI_VERSION_CHECK(20,7,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress 1215,1216,1444,1445") +#elif JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress 1215,1444") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,3,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED __pragma(warning(disable:4996)) +#elif JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress 1215,1444") +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress 1291,1718") +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,13,0) && !defined(__cplusplus) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("error_messages(off,E_DEPRECATED_ATT,E_DEPRECATED_ATT_MESS)") +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,13,0) && defined(__cplusplus) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("error_messages(off,symdeprecated,symdeprecated2)") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("diag_suppress=Pe1444,Pe1215") +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(2,90,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED _Pragma("warn(disable:2241)") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_DEPRECATED +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-pragmas") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("clang diagnostic ignored \"-Wunknown-pragmas\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("warning(disable:161)") +#elif JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS __pragma(warning(disable:161)) +#elif JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 1675") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,3,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("GCC diagnostic ignored \"-Wunknown-pragmas\"") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS __pragma(warning(disable:4068)) +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(16,9,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,3,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 163") +#elif JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 163") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress=Pe161") +#elif JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS _Pragma("diag_suppress 161") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-attributes") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("clang diagnostic ignored \"-Wunknown-attributes\"") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(4,6,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("GCC diagnostic ignored \"-Wdeprecated-declarations\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(17,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("warning(disable:1292)") +#elif JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES __pragma(warning(disable:1292)) +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(19,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES __pragma(warning(disable:5030)) +#elif JSON_HEDLEY_PGI_VERSION_CHECK(20,7,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress 1097,1098") +#elif JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress 1097") +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,14,0) && defined(__cplusplus) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("error_messages(off,attrskipunsup)") +#elif \ + JSON_HEDLEY_TI_VERSION_CHECK(18,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,3,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress 1173") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress=Pe1097") +#elif JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES _Pragma("diag_suppress 1097") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_CPP_ATTRIBUTES +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wcast-qual") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL _Pragma("clang diagnostic ignored \"-Wcast-qual\"") +#elif JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL _Pragma("warning(disable:2203 2331)") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(3,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL _Pragma("GCC diagnostic ignored \"-Wcast-qual\"") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_CAST_QUAL +#endif + +#if defined(JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION) + #undef JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunused-function") + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION _Pragma("clang diagnostic ignored \"-Wunused-function\"") +#elif JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION _Pragma("GCC diagnostic ignored \"-Wunused-function\"") +#elif JSON_HEDLEY_MSVC_VERSION_CHECK(1,0,0) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION __pragma(warning(disable:4505)) +#elif JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION _Pragma("diag_suppress 3142") +#else + #define JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNUSED_FUNCTION +#endif + +#if defined(JSON_HEDLEY_DEPRECATED) + #undef JSON_HEDLEY_DEPRECATED +#endif +#if defined(JSON_HEDLEY_DEPRECATED_FOR) + #undef JSON_HEDLEY_DEPRECATED_FOR +#endif +#if \ + JSON_HEDLEY_MSVC_VERSION_CHECK(14,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_DEPRECATED(since) __declspec(deprecated("Since " # since)) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __declspec(deprecated("Since " #since "; use " #replacement)) +#elif \ + (JSON_HEDLEY_HAS_EXTENSION(attribute_deprecated_with_message) && !defined(JSON_HEDLEY_IAR_VERSION)) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,5,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,6,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,13,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(18,1,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(18,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,3,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,3,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_DEPRECATED(since) __attribute__((__deprecated__("Since " #since))) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __attribute__((__deprecated__("Since " #since "; use " #replacement))) +#elif defined(__cplusplus) && (__cplusplus >= 201402L) + #define JSON_HEDLEY_DEPRECATED(since) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[deprecated("Since " #since)]]) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[deprecated("Since " #since "; use " #replacement)]]) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(deprecated) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,10,0) + #define JSON_HEDLEY_DEPRECATED(since) __attribute__((__deprecated__)) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __attribute__((__deprecated__)) +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) || \ + JSON_HEDLEY_PELLES_VERSION_CHECK(6,50,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_DEPRECATED(since) __declspec(deprecated) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) __declspec(deprecated) +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_DEPRECATED(since) _Pragma("deprecated") + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) _Pragma("deprecated") +#else + #define JSON_HEDLEY_DEPRECATED(since) + #define JSON_HEDLEY_DEPRECATED_FOR(since, replacement) +#endif + +#if defined(JSON_HEDLEY_UNAVAILABLE) + #undef JSON_HEDLEY_UNAVAILABLE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(warning) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,3,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_UNAVAILABLE(available_since) __attribute__((__warning__("Not available until " #available_since))) +#else + #define JSON_HEDLEY_UNAVAILABLE(available_since) +#endif + +#if defined(JSON_HEDLEY_WARN_UNUSED_RESULT) + #undef JSON_HEDLEY_WARN_UNUSED_RESULT +#endif +#if defined(JSON_HEDLEY_WARN_UNUSED_RESULT_MSG) + #undef JSON_HEDLEY_WARN_UNUSED_RESULT_MSG +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(warn_unused_result) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0) && defined(__cplusplus)) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_WARN_UNUSED_RESULT __attribute__((__warn_unused_result__)) + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) __attribute__((__warn_unused_result__)) +#elif (JSON_HEDLEY_HAS_CPP_ATTRIBUTE(nodiscard) >= 201907L) + #define JSON_HEDLEY_WARN_UNUSED_RESULT JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard]]) + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard(msg)]]) +#elif JSON_HEDLEY_HAS_CPP_ATTRIBUTE(nodiscard) + #define JSON_HEDLEY_WARN_UNUSED_RESULT JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard]]) + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[nodiscard]]) +#elif defined(_Check_return_) /* SAL */ + #define JSON_HEDLEY_WARN_UNUSED_RESULT _Check_return_ + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) _Check_return_ +#else + #define JSON_HEDLEY_WARN_UNUSED_RESULT + #define JSON_HEDLEY_WARN_UNUSED_RESULT_MSG(msg) +#endif + +#if defined(JSON_HEDLEY_SENTINEL) + #undef JSON_HEDLEY_SENTINEL +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(sentinel) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,4,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_SENTINEL(position) __attribute__((__sentinel__(position))) +#else + #define JSON_HEDLEY_SENTINEL(position) +#endif + +#if defined(JSON_HEDLEY_NO_RETURN) + #undef JSON_HEDLEY_NO_RETURN +#endif +#if JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_NO_RETURN __noreturn +#elif \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_NO_RETURN __attribute__((__noreturn__)) +#elif defined(__STDC_VERSION__) && __STDC_VERSION__ >= 201112L + #define JSON_HEDLEY_NO_RETURN _Noreturn +#elif defined(__cplusplus) && (__cplusplus >= 201103L) + #define JSON_HEDLEY_NO_RETURN JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[noreturn]]) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(noreturn) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,2,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,10,0) + #define JSON_HEDLEY_NO_RETURN __attribute__((__noreturn__)) +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) + #define JSON_HEDLEY_NO_RETURN _Pragma("does_not_return") +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_NO_RETURN __declspec(noreturn) +#elif JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,0,0) && defined(__cplusplus) + #define JSON_HEDLEY_NO_RETURN _Pragma("FUNC_NEVER_RETURNS;") +#elif JSON_HEDLEY_COMPCERT_VERSION_CHECK(3,2,0) + #define JSON_HEDLEY_NO_RETURN __attribute((noreturn)) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(9,0,0) + #define JSON_HEDLEY_NO_RETURN __declspec(noreturn) +#else + #define JSON_HEDLEY_NO_RETURN +#endif + +#if defined(JSON_HEDLEY_NO_ESCAPE) + #undef JSON_HEDLEY_NO_ESCAPE +#endif +#if JSON_HEDLEY_HAS_ATTRIBUTE(noescape) + #define JSON_HEDLEY_NO_ESCAPE __attribute__((__noescape__)) +#else + #define JSON_HEDLEY_NO_ESCAPE +#endif + +#if defined(JSON_HEDLEY_UNREACHABLE) + #undef JSON_HEDLEY_UNREACHABLE +#endif +#if defined(JSON_HEDLEY_UNREACHABLE_RETURN) + #undef JSON_HEDLEY_UNREACHABLE_RETURN +#endif +#if defined(JSON_HEDLEY_ASSUME) + #undef JSON_HEDLEY_ASSUME +#endif +#if \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_ASSUME(expr) __assume(expr) +#elif JSON_HEDLEY_HAS_BUILTIN(__builtin_assume) + #define JSON_HEDLEY_ASSUME(expr) __builtin_assume(expr) +#elif \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(4,0,0) + #if defined(__cplusplus) + #define JSON_HEDLEY_ASSUME(expr) std::_nassert(expr) + #else + #define JSON_HEDLEY_ASSUME(expr) _nassert(expr) + #endif +#endif +#if \ + (JSON_HEDLEY_HAS_BUILTIN(__builtin_unreachable) && (!defined(JSON_HEDLEY_ARM_VERSION))) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,5,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(18,10,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,5) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(10,0,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_UNREACHABLE() __builtin_unreachable() +#elif defined(JSON_HEDLEY_ASSUME) + #define JSON_HEDLEY_UNREACHABLE() JSON_HEDLEY_ASSUME(0) +#endif +#if !defined(JSON_HEDLEY_ASSUME) + #if defined(JSON_HEDLEY_UNREACHABLE) + #define JSON_HEDLEY_ASSUME(expr) JSON_HEDLEY_STATIC_CAST(void, ((expr) ? 1 : (JSON_HEDLEY_UNREACHABLE(), 1))) + #else + #define JSON_HEDLEY_ASSUME(expr) JSON_HEDLEY_STATIC_CAST(void, expr) + #endif +#endif +#if defined(JSON_HEDLEY_UNREACHABLE) + #if \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(4,0,0) + #define JSON_HEDLEY_UNREACHABLE_RETURN(value) return (JSON_HEDLEY_STATIC_CAST(void, JSON_HEDLEY_ASSUME(0)), (value)) + #else + #define JSON_HEDLEY_UNREACHABLE_RETURN(value) JSON_HEDLEY_UNREACHABLE() + #endif +#else + #define JSON_HEDLEY_UNREACHABLE_RETURN(value) return (value) +#endif +#if !defined(JSON_HEDLEY_UNREACHABLE) + #define JSON_HEDLEY_UNREACHABLE() JSON_HEDLEY_ASSUME(0) +#endif + +JSON_HEDLEY_DIAGNOSTIC_PUSH +#if JSON_HEDLEY_HAS_WARNING("-Wpedantic") + #pragma clang diagnostic ignored "-Wpedantic" +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wc++98-compat-pedantic") && defined(__cplusplus) + #pragma clang diagnostic ignored "-Wc++98-compat-pedantic" +#endif +#if JSON_HEDLEY_GCC_HAS_WARNING("-Wvariadic-macros",4,0,0) + #if defined(__clang__) + #pragma clang diagnostic ignored "-Wvariadic-macros" + #elif defined(JSON_HEDLEY_GCC_VERSION) + #pragma GCC diagnostic ignored "-Wvariadic-macros" + #endif +#endif +#if defined(JSON_HEDLEY_NON_NULL) + #undef JSON_HEDLEY_NON_NULL +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(nonnull) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,3,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) + #define JSON_HEDLEY_NON_NULL(...) __attribute__((__nonnull__(__VA_ARGS__))) +#else + #define JSON_HEDLEY_NON_NULL(...) +#endif +JSON_HEDLEY_DIAGNOSTIC_POP + +#if defined(JSON_HEDLEY_PRINTF_FORMAT) + #undef JSON_HEDLEY_PRINTF_FORMAT +#endif +#if defined(__MINGW32__) && JSON_HEDLEY_GCC_HAS_ATTRIBUTE(format,4,4,0) && !defined(__USE_MINGW_ANSI_STDIO) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __attribute__((__format__(ms_printf, string_idx, first_to_check))) +#elif defined(__MINGW32__) && JSON_HEDLEY_GCC_HAS_ATTRIBUTE(format,4,4,0) && defined(__USE_MINGW_ANSI_STDIO) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __attribute__((__format__(gnu_printf, string_idx, first_to_check))) +#elif \ + JSON_HEDLEY_HAS_ATTRIBUTE(format) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,6,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __attribute__((__format__(__printf__, string_idx, first_to_check))) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(6,0,0) + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) __declspec(vaformat(printf,string_idx,first_to_check)) +#else + #define JSON_HEDLEY_PRINTF_FORMAT(string_idx,first_to_check) +#endif + +#if defined(JSON_HEDLEY_CONSTEXPR) + #undef JSON_HEDLEY_CONSTEXPR +#endif +#if defined(__cplusplus) + #if __cplusplus >= 201103L + #define JSON_HEDLEY_CONSTEXPR JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(constexpr) + #endif +#endif +#if !defined(JSON_HEDLEY_CONSTEXPR) + #define JSON_HEDLEY_CONSTEXPR +#endif + +#if defined(JSON_HEDLEY_PREDICT) + #undef JSON_HEDLEY_PREDICT +#endif +#if defined(JSON_HEDLEY_LIKELY) + #undef JSON_HEDLEY_LIKELY +#endif +#if defined(JSON_HEDLEY_UNLIKELY) + #undef JSON_HEDLEY_UNLIKELY +#endif +#if defined(JSON_HEDLEY_UNPREDICTABLE) + #undef JSON_HEDLEY_UNPREDICTABLE +#endif +#if JSON_HEDLEY_HAS_BUILTIN(__builtin_unpredictable) + #define JSON_HEDLEY_UNPREDICTABLE(expr) __builtin_unpredictable((expr)) +#endif +#if \ + (JSON_HEDLEY_HAS_BUILTIN(__builtin_expect_with_probability) && !defined(JSON_HEDLEY_PGI_VERSION)) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(9,0,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) +# define JSON_HEDLEY_PREDICT(expr, value, probability) __builtin_expect_with_probability( (expr), (value), (probability)) +# define JSON_HEDLEY_PREDICT_TRUE(expr, probability) __builtin_expect_with_probability(!!(expr), 1 , (probability)) +# define JSON_HEDLEY_PREDICT_FALSE(expr, probability) __builtin_expect_with_probability(!!(expr), 0 , (probability)) +# define JSON_HEDLEY_LIKELY(expr) __builtin_expect (!!(expr), 1 ) +# define JSON_HEDLEY_UNLIKELY(expr) __builtin_expect (!!(expr), 0 ) +#elif \ + (JSON_HEDLEY_HAS_BUILTIN(__builtin_expect) && !defined(JSON_HEDLEY_INTEL_CL_VERSION)) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,15,0) && defined(__cplusplus)) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,7,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,27) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) +# define JSON_HEDLEY_PREDICT(expr, expected, probability) \ + (((probability) >= 0.9) ? __builtin_expect((expr), (expected)) : (JSON_HEDLEY_STATIC_CAST(void, expected), (expr))) +# define JSON_HEDLEY_PREDICT_TRUE(expr, probability) \ + (__extension__ ({ \ + double hedley_probability_ = (probability); \ + ((hedley_probability_ >= 0.9) ? __builtin_expect(!!(expr), 1) : ((hedley_probability_ <= 0.1) ? __builtin_expect(!!(expr), 0) : !!(expr))); \ + })) +# define JSON_HEDLEY_PREDICT_FALSE(expr, probability) \ + (__extension__ ({ \ + double hedley_probability_ = (probability); \ + ((hedley_probability_ >= 0.9) ? __builtin_expect(!!(expr), 0) : ((hedley_probability_ <= 0.1) ? __builtin_expect(!!(expr), 1) : !!(expr))); \ + })) +# define JSON_HEDLEY_LIKELY(expr) __builtin_expect(!!(expr), 1) +# define JSON_HEDLEY_UNLIKELY(expr) __builtin_expect(!!(expr), 0) +#else +# define JSON_HEDLEY_PREDICT(expr, expected, probability) (JSON_HEDLEY_STATIC_CAST(void, expected), (expr)) +# define JSON_HEDLEY_PREDICT_TRUE(expr, probability) (!!(expr)) +# define JSON_HEDLEY_PREDICT_FALSE(expr, probability) (!!(expr)) +# define JSON_HEDLEY_LIKELY(expr) (!!(expr)) +# define JSON_HEDLEY_UNLIKELY(expr) (!!(expr)) +#endif +#if !defined(JSON_HEDLEY_UNPREDICTABLE) + #define JSON_HEDLEY_UNPREDICTABLE(expr) JSON_HEDLEY_PREDICT(expr, 1, 0.5) +#endif + +#if defined(JSON_HEDLEY_MALLOC) + #undef JSON_HEDLEY_MALLOC +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(malloc) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(12,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_MALLOC __attribute__((__malloc__)) +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) + #define JSON_HEDLEY_MALLOC _Pragma("returns_new_memory") +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(14,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_MALLOC __declspec(restrict) +#else + #define JSON_HEDLEY_MALLOC +#endif + +#if defined(JSON_HEDLEY_PURE) + #undef JSON_HEDLEY_PURE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(pure) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(2,96,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) +# define JSON_HEDLEY_PURE __attribute__((__pure__)) +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) +# define JSON_HEDLEY_PURE _Pragma("does_not_write_global_data") +#elif defined(__cplusplus) && \ + ( \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(2,0,1) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) \ + ) +# define JSON_HEDLEY_PURE _Pragma("FUNC_IS_PURE;") +#else +# define JSON_HEDLEY_PURE +#endif + +#if defined(JSON_HEDLEY_CONST) + #undef JSON_HEDLEY_CONST +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(const) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(2,5,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_CONST __attribute__((__const__)) +#elif \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) + #define JSON_HEDLEY_CONST _Pragma("no_side_effect") +#else + #define JSON_HEDLEY_CONST JSON_HEDLEY_PURE +#endif + +#if defined(JSON_HEDLEY_RESTRICT) + #undef JSON_HEDLEY_RESTRICT +#endif +#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && !defined(__cplusplus) + #define JSON_HEDLEY_RESTRICT restrict +#elif \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_MSVC_VERSION_CHECK(14,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(17,10,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,4) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,14,0) && defined(__cplusplus)) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) || \ + defined(__clang__) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_RESTRICT __restrict +#elif JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,3,0) && !defined(__cplusplus) + #define JSON_HEDLEY_RESTRICT _Restrict +#else + #define JSON_HEDLEY_RESTRICT +#endif + +#if defined(JSON_HEDLEY_INLINE) + #undef JSON_HEDLEY_INLINE +#endif +#if \ + (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)) || \ + (defined(__cplusplus) && (__cplusplus >= 199711L)) + #define JSON_HEDLEY_INLINE inline +#elif \ + defined(JSON_HEDLEY_GCC_VERSION) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(6,2,0) + #define JSON_HEDLEY_INLINE __inline__ +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(12,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,1,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(3,1,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,2,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(8,0,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_INLINE __inline +#else + #define JSON_HEDLEY_INLINE +#endif + +#if defined(JSON_HEDLEY_ALWAYS_INLINE) + #undef JSON_HEDLEY_ALWAYS_INLINE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(always_inline) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,10,0) +# define JSON_HEDLEY_ALWAYS_INLINE __attribute__((__always_inline__)) JSON_HEDLEY_INLINE +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(12,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) +# define JSON_HEDLEY_ALWAYS_INLINE __forceinline +#elif defined(__cplusplus) && \ + ( \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,1,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) \ + ) +# define JSON_HEDLEY_ALWAYS_INLINE _Pragma("FUNC_ALWAYS_INLINE;") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) +# define JSON_HEDLEY_ALWAYS_INLINE _Pragma("inline=forced") +#else +# define JSON_HEDLEY_ALWAYS_INLINE JSON_HEDLEY_INLINE +#endif + +#if defined(JSON_HEDLEY_NEVER_INLINE) + #undef JSON_HEDLEY_NEVER_INLINE +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(noinline) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(10,1,0) || \ + JSON_HEDLEY_TI_VERSION_CHECK(15,12,0) || \ + (JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(4,8,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_ARMCL_VERSION_CHECK(5,2,0) || \ + (JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL2000_VERSION_CHECK(6,4,0) || \ + (JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,0,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(4,3,0) || \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) || \ + JSON_HEDLEY_TI_CL7X_VERSION_CHECK(1,2,0) || \ + JSON_HEDLEY_TI_CLPRU_VERSION_CHECK(2,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) || \ + JSON_HEDLEY_IAR_VERSION_CHECK(8,10,0) + #define JSON_HEDLEY_NEVER_INLINE __attribute__((__noinline__)) +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,10,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_NEVER_INLINE __declspec(noinline) +#elif JSON_HEDLEY_PGI_VERSION_CHECK(10,2,0) + #define JSON_HEDLEY_NEVER_INLINE _Pragma("noinline") +#elif JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,0,0) && defined(__cplusplus) + #define JSON_HEDLEY_NEVER_INLINE _Pragma("FUNC_CANNOT_INLINE;") +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) + #define JSON_HEDLEY_NEVER_INLINE _Pragma("inline=never") +#elif JSON_HEDLEY_COMPCERT_VERSION_CHECK(3,2,0) + #define JSON_HEDLEY_NEVER_INLINE __attribute((noinline)) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(9,0,0) + #define JSON_HEDLEY_NEVER_INLINE __declspec(noinline) +#else + #define JSON_HEDLEY_NEVER_INLINE +#endif + +#if defined(JSON_HEDLEY_PRIVATE) + #undef JSON_HEDLEY_PRIVATE +#endif +#if defined(JSON_HEDLEY_PUBLIC) + #undef JSON_HEDLEY_PUBLIC +#endif +#if defined(JSON_HEDLEY_IMPORT) + #undef JSON_HEDLEY_IMPORT +#endif +#if defined(_WIN32) || defined(__CYGWIN__) +# define JSON_HEDLEY_PRIVATE +# define JSON_HEDLEY_PUBLIC __declspec(dllexport) +# define JSON_HEDLEY_IMPORT __declspec(dllimport) +#else +# if \ + JSON_HEDLEY_HAS_ATTRIBUTE(visibility) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,3,0) || \ + JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,11,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,0) || \ + ( \ + defined(__TI_EABI__) && \ + ( \ + (JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,2,0) && defined(__TI_GNU_ATTRIBUTE_SUPPORT__)) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(7,5,0) \ + ) \ + ) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) +# define JSON_HEDLEY_PRIVATE __attribute__((__visibility__("hidden"))) +# define JSON_HEDLEY_PUBLIC __attribute__((__visibility__("default"))) +# else +# define JSON_HEDLEY_PRIVATE +# define JSON_HEDLEY_PUBLIC +# endif +# define JSON_HEDLEY_IMPORT extern +#endif + +#if defined(JSON_HEDLEY_NO_THROW) + #undef JSON_HEDLEY_NO_THROW +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(nothrow) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,3,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_NO_THROW __attribute__((__nothrow__)) +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(13,1,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) + #define JSON_HEDLEY_NO_THROW __declspec(nothrow) +#else + #define JSON_HEDLEY_NO_THROW +#endif + +#if defined(JSON_HEDLEY_FALL_THROUGH) + #undef JSON_HEDLEY_FALL_THROUGH +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(fallthrough) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(7,0,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_FALL_THROUGH __attribute__((__fallthrough__)) +#elif JSON_HEDLEY_HAS_CPP_ATTRIBUTE_NS(clang,fallthrough) + #define JSON_HEDLEY_FALL_THROUGH JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[clang::fallthrough]]) +#elif JSON_HEDLEY_HAS_CPP_ATTRIBUTE(fallthrough) + #define JSON_HEDLEY_FALL_THROUGH JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_([[fallthrough]]) +#elif defined(__fallthrough) /* SAL */ + #define JSON_HEDLEY_FALL_THROUGH __fallthrough +#else + #define JSON_HEDLEY_FALL_THROUGH +#endif + +#if defined(JSON_HEDLEY_RETURNS_NON_NULL) + #undef JSON_HEDLEY_RETURNS_NON_NULL +#endif +#if \ + JSON_HEDLEY_HAS_ATTRIBUTE(returns_nonnull) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,9,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_RETURNS_NON_NULL __attribute__((__returns_nonnull__)) +#elif defined(_Ret_notnull_) /* SAL */ + #define JSON_HEDLEY_RETURNS_NON_NULL _Ret_notnull_ +#else + #define JSON_HEDLEY_RETURNS_NON_NULL +#endif + +#if defined(JSON_HEDLEY_ARRAY_PARAM) + #undef JSON_HEDLEY_ARRAY_PARAM +#endif +#if \ + defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) && \ + !defined(__STDC_NO_VLA__) && \ + !defined(__cplusplus) && \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_TINYC_VERSION) + #define JSON_HEDLEY_ARRAY_PARAM(name) (name) +#else + #define JSON_HEDLEY_ARRAY_PARAM(name) +#endif + +#if defined(JSON_HEDLEY_IS_CONSTANT) + #undef JSON_HEDLEY_IS_CONSTANT +#endif +#if defined(JSON_HEDLEY_REQUIRE_CONSTEXPR) + #undef JSON_HEDLEY_REQUIRE_CONSTEXPR +#endif +/* JSON_HEDLEY_IS_CONSTEXPR_ is for + HEDLEY INTERNAL USE ONLY. API subject to change without notice. */ +#if defined(JSON_HEDLEY_IS_CONSTEXPR_) + #undef JSON_HEDLEY_IS_CONSTEXPR_ +#endif +#if \ + JSON_HEDLEY_HAS_BUILTIN(__builtin_constant_p) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,19) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(4,1,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,0) || \ + JSON_HEDLEY_TI_CL6X_VERSION_CHECK(6,1,0) || \ + (JSON_HEDLEY_SUNPRO_VERSION_CHECK(5,10,0) && !defined(__cplusplus)) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_MCST_LCC_VERSION_CHECK(1,25,10) + #define JSON_HEDLEY_IS_CONSTANT(expr) __builtin_constant_p(expr) +#endif +#if !defined(__cplusplus) +# if \ + JSON_HEDLEY_HAS_BUILTIN(__builtin_types_compatible_p) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(3,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(13,1,0) || \ + JSON_HEDLEY_CRAY_VERSION_CHECK(8,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,4,0) || \ + JSON_HEDLEY_TINYC_VERSION_CHECK(0,9,24) +#if defined(__INTPTR_TYPE__) + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) __builtin_types_compatible_p(__typeof__((1 ? (void*) ((__INTPTR_TYPE__) ((expr) * 0)) : (int*) 0)), int*) +#else + #include + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) __builtin_types_compatible_p(__typeof__((1 ? (void*) ((intptr_t) ((expr) * 0)) : (int*) 0)), int*) +#endif +# elif \ + ( \ + defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L) && \ + !defined(JSON_HEDLEY_SUNPRO_VERSION) && \ + !defined(JSON_HEDLEY_PGI_VERSION) && \ + !defined(JSON_HEDLEY_IAR_VERSION)) || \ + (JSON_HEDLEY_HAS_EXTENSION(c_generic_selections) && !defined(JSON_HEDLEY_IAR_VERSION)) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,9,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(17,0,0) || \ + JSON_HEDLEY_IBM_VERSION_CHECK(12,1,0) || \ + JSON_HEDLEY_ARM_VERSION_CHECK(5,3,0) +#if defined(__INTPTR_TYPE__) + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) _Generic((1 ? (void*) ((__INTPTR_TYPE__) ((expr) * 0)) : (int*) 0), int*: 1, void*: 0) +#else + #include + #define JSON_HEDLEY_IS_CONSTEXPR_(expr) _Generic((1 ? (void*) ((intptr_t) * 0) : (int*) 0), int*: 1, void*: 0) +#endif +# elif \ + defined(JSON_HEDLEY_GCC_VERSION) || \ + defined(JSON_HEDLEY_INTEL_VERSION) || \ + defined(JSON_HEDLEY_TINYC_VERSION) || \ + defined(JSON_HEDLEY_TI_ARMCL_VERSION) || \ + JSON_HEDLEY_TI_CL430_VERSION_CHECK(18,12,0) || \ + defined(JSON_HEDLEY_TI_CL2000_VERSION) || \ + defined(JSON_HEDLEY_TI_CL6X_VERSION) || \ + defined(JSON_HEDLEY_TI_CL7X_VERSION) || \ + defined(JSON_HEDLEY_TI_CLPRU_VERSION) || \ + defined(__clang__) +# define JSON_HEDLEY_IS_CONSTEXPR_(expr) ( \ + sizeof(void) != \ + sizeof(*( \ + 1 ? \ + ((void*) ((expr) * 0L) ) : \ +((struct { char v[sizeof(void) * 2]; } *) 1) \ + ) \ + ) \ + ) +# endif +#endif +#if defined(JSON_HEDLEY_IS_CONSTEXPR_) + #if !defined(JSON_HEDLEY_IS_CONSTANT) + #define JSON_HEDLEY_IS_CONSTANT(expr) JSON_HEDLEY_IS_CONSTEXPR_(expr) + #endif + #define JSON_HEDLEY_REQUIRE_CONSTEXPR(expr) (JSON_HEDLEY_IS_CONSTEXPR_(expr) ? (expr) : (-1)) +#else + #if !defined(JSON_HEDLEY_IS_CONSTANT) + #define JSON_HEDLEY_IS_CONSTANT(expr) (0) + #endif + #define JSON_HEDLEY_REQUIRE_CONSTEXPR(expr) (expr) +#endif + +#if defined(JSON_HEDLEY_BEGIN_C_DECLS) + #undef JSON_HEDLEY_BEGIN_C_DECLS +#endif +#if defined(JSON_HEDLEY_END_C_DECLS) + #undef JSON_HEDLEY_END_C_DECLS +#endif +#if defined(JSON_HEDLEY_C_DECL) + #undef JSON_HEDLEY_C_DECL +#endif +#if defined(__cplusplus) + #define JSON_HEDLEY_BEGIN_C_DECLS extern "C" { + #define JSON_HEDLEY_END_C_DECLS } + #define JSON_HEDLEY_C_DECL extern "C" +#else + #define JSON_HEDLEY_BEGIN_C_DECLS + #define JSON_HEDLEY_END_C_DECLS + #define JSON_HEDLEY_C_DECL +#endif + +#if defined(JSON_HEDLEY_STATIC_ASSERT) + #undef JSON_HEDLEY_STATIC_ASSERT +#endif +#if \ + !defined(__cplusplus) && ( \ + (defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)) || \ + (JSON_HEDLEY_HAS_FEATURE(c_static_assert) && !defined(JSON_HEDLEY_INTEL_CL_VERSION)) || \ + JSON_HEDLEY_GCC_VERSION_CHECK(6,0,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) || \ + defined(_Static_assert) \ + ) +# define JSON_HEDLEY_STATIC_ASSERT(expr, message) _Static_assert(expr, message) +#elif \ + (defined(__cplusplus) && (__cplusplus >= 201103L)) || \ + JSON_HEDLEY_MSVC_VERSION_CHECK(16,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) +# define JSON_HEDLEY_STATIC_ASSERT(expr, message) JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(static_assert(expr, message)) +#else +# define JSON_HEDLEY_STATIC_ASSERT(expr, message) +#endif + +#if defined(JSON_HEDLEY_NULL) + #undef JSON_HEDLEY_NULL +#endif +#if defined(__cplusplus) + #if __cplusplus >= 201103L + #define JSON_HEDLEY_NULL JSON_HEDLEY_DIAGNOSTIC_DISABLE_CPP98_COMPAT_WRAP_(nullptr) + #elif defined(NULL) + #define JSON_HEDLEY_NULL NULL + #else + #define JSON_HEDLEY_NULL JSON_HEDLEY_STATIC_CAST(void*, 0) + #endif +#elif defined(NULL) + #define JSON_HEDLEY_NULL NULL +#else + #define JSON_HEDLEY_NULL ((void*) 0) +#endif + +#if defined(JSON_HEDLEY_MESSAGE) + #undef JSON_HEDLEY_MESSAGE +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-pragmas") +# define JSON_HEDLEY_MESSAGE(msg) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS \ + JSON_HEDLEY_PRAGMA(message msg) \ + JSON_HEDLEY_DIAGNOSTIC_POP +#elif \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(message msg) +#elif JSON_HEDLEY_CRAY_VERSION_CHECK(5,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(_CRI message msg) +#elif JSON_HEDLEY_IAR_VERSION_CHECK(8,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(message(msg)) +#elif JSON_HEDLEY_PELLES_VERSION_CHECK(2,0,0) +# define JSON_HEDLEY_MESSAGE(msg) JSON_HEDLEY_PRAGMA(message(msg)) +#else +# define JSON_HEDLEY_MESSAGE(msg) +#endif + +#if defined(JSON_HEDLEY_WARNING) + #undef JSON_HEDLEY_WARNING +#endif +#if JSON_HEDLEY_HAS_WARNING("-Wunknown-pragmas") +# define JSON_HEDLEY_WARNING(msg) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + JSON_HEDLEY_DIAGNOSTIC_DISABLE_UNKNOWN_PRAGMAS \ + JSON_HEDLEY_PRAGMA(clang warning msg) \ + JSON_HEDLEY_DIAGNOSTIC_POP +#elif \ + JSON_HEDLEY_GCC_VERSION_CHECK(4,8,0) || \ + JSON_HEDLEY_PGI_VERSION_CHECK(18,4,0) || \ + JSON_HEDLEY_INTEL_VERSION_CHECK(13,0,0) +# define JSON_HEDLEY_WARNING(msg) JSON_HEDLEY_PRAGMA(GCC warning msg) +#elif \ + JSON_HEDLEY_MSVC_VERSION_CHECK(15,0,0) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) +# define JSON_HEDLEY_WARNING(msg) JSON_HEDLEY_PRAGMA(message(msg)) +#else +# define JSON_HEDLEY_WARNING(msg) JSON_HEDLEY_MESSAGE(msg) +#endif + +#if defined(JSON_HEDLEY_REQUIRE) + #undef JSON_HEDLEY_REQUIRE +#endif +#if defined(JSON_HEDLEY_REQUIRE_MSG) + #undef JSON_HEDLEY_REQUIRE_MSG +#endif +#if JSON_HEDLEY_HAS_ATTRIBUTE(diagnose_if) +# if JSON_HEDLEY_HAS_WARNING("-Wgcc-compat") +# define JSON_HEDLEY_REQUIRE(expr) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wgcc-compat\"") \ + __attribute__((diagnose_if(!(expr), #expr, "error"))) \ + JSON_HEDLEY_DIAGNOSTIC_POP +# define JSON_HEDLEY_REQUIRE_MSG(expr,msg) \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("clang diagnostic ignored \"-Wgcc-compat\"") \ + __attribute__((diagnose_if(!(expr), msg, "error"))) \ + JSON_HEDLEY_DIAGNOSTIC_POP +# else +# define JSON_HEDLEY_REQUIRE(expr) __attribute__((diagnose_if(!(expr), #expr, "error"))) +# define JSON_HEDLEY_REQUIRE_MSG(expr,msg) __attribute__((diagnose_if(!(expr), msg, "error"))) +# endif +#else +# define JSON_HEDLEY_REQUIRE(expr) +# define JSON_HEDLEY_REQUIRE_MSG(expr,msg) +#endif + +#if defined(JSON_HEDLEY_FLAGS) + #undef JSON_HEDLEY_FLAGS +#endif +#if JSON_HEDLEY_HAS_ATTRIBUTE(flag_enum) && (!defined(__cplusplus) || JSON_HEDLEY_HAS_WARNING("-Wbitfield-enum-conversion")) + #define JSON_HEDLEY_FLAGS __attribute__((__flag_enum__)) +#else + #define JSON_HEDLEY_FLAGS +#endif + +#if defined(JSON_HEDLEY_FLAGS_CAST) + #undef JSON_HEDLEY_FLAGS_CAST +#endif +#if JSON_HEDLEY_INTEL_VERSION_CHECK(19,0,0) +# define JSON_HEDLEY_FLAGS_CAST(T, expr) (__extension__ ({ \ + JSON_HEDLEY_DIAGNOSTIC_PUSH \ + _Pragma("warning(disable:188)") \ + ((T) (expr)); \ + JSON_HEDLEY_DIAGNOSTIC_POP \ + })) +#else +# define JSON_HEDLEY_FLAGS_CAST(T, expr) JSON_HEDLEY_STATIC_CAST(T, expr) +#endif + +#if defined(JSON_HEDLEY_EMPTY_BASES) + #undef JSON_HEDLEY_EMPTY_BASES +#endif +#if \ + (JSON_HEDLEY_MSVC_VERSION_CHECK(19,0,23918) && !JSON_HEDLEY_MSVC_VERSION_CHECK(20,0,0)) || \ + JSON_HEDLEY_INTEL_CL_VERSION_CHECK(2021,1,0) + #define JSON_HEDLEY_EMPTY_BASES __declspec(empty_bases) +#else + #define JSON_HEDLEY_EMPTY_BASES +#endif + +/* Remaining macros are deprecated. */ + +#if defined(JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK) + #undef JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK +#endif +#if defined(__clang__) + #define JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK(major,minor,patch) (0) +#else + #define JSON_HEDLEY_GCC_NOT_CLANG_VERSION_CHECK(major,minor,patch) JSON_HEDLEY_GCC_VERSION_CHECK(major,minor,patch) +#endif + +#if defined(JSON_HEDLEY_CLANG_HAS_ATTRIBUTE) + #undef JSON_HEDLEY_CLANG_HAS_ATTRIBUTE +#endif +#define JSON_HEDLEY_CLANG_HAS_ATTRIBUTE(attribute) JSON_HEDLEY_HAS_ATTRIBUTE(attribute) + +#if defined(JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE) + #undef JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE +#endif +#define JSON_HEDLEY_CLANG_HAS_CPP_ATTRIBUTE(attribute) JSON_HEDLEY_HAS_CPP_ATTRIBUTE(attribute) + +#if defined(JSON_HEDLEY_CLANG_HAS_BUILTIN) + #undef JSON_HEDLEY_CLANG_HAS_BUILTIN +#endif +#define JSON_HEDLEY_CLANG_HAS_BUILTIN(builtin) JSON_HEDLEY_HAS_BUILTIN(builtin) + +#if defined(JSON_HEDLEY_CLANG_HAS_FEATURE) + #undef JSON_HEDLEY_CLANG_HAS_FEATURE +#endif +#define JSON_HEDLEY_CLANG_HAS_FEATURE(feature) JSON_HEDLEY_HAS_FEATURE(feature) + +#if defined(JSON_HEDLEY_CLANG_HAS_EXTENSION) + #undef JSON_HEDLEY_CLANG_HAS_EXTENSION +#endif +#define JSON_HEDLEY_CLANG_HAS_EXTENSION(extension) JSON_HEDLEY_HAS_EXTENSION(extension) + +#if defined(JSON_HEDLEY_CLANG_HAS_DECLSPEC_DECLSPEC_ATTRIBUTE) + #undef JSON_HEDLEY_CLANG_HAS_DECLSPEC_DECLSPEC_ATTRIBUTE +#endif +#define JSON_HEDLEY_CLANG_HAS_DECLSPEC_ATTRIBUTE(attribute) JSON_HEDLEY_HAS_DECLSPEC_ATTRIBUTE(attribute) + +#if defined(JSON_HEDLEY_CLANG_HAS_WARNING) + #undef JSON_HEDLEY_CLANG_HAS_WARNING +#endif +#define JSON_HEDLEY_CLANG_HAS_WARNING(warning) JSON_HEDLEY_HAS_WARNING(warning) + +#endif /* !defined(JSON_HEDLEY_VERSION) || (JSON_HEDLEY_VERSION < X) */ + + +// This file contains all internal macro definitions (except those affecting ABI) +// You MUST include macro_unscope.hpp at the end of json.hpp to undef all of them + +// #include + + +// exclude unsupported compilers +#if !defined(JSON_SKIP_UNSUPPORTED_COMPILER_CHECK) + #if defined(__clang__) + #if (__clang_major__ * 10000 + __clang_minor__ * 100 + __clang_patchlevel__) < 30400 + #error "unsupported Clang version - see https://github.com/nlohmann/json#supported-compilers" + #endif + #elif defined(__GNUC__) && !(defined(__ICC) || defined(__INTEL_COMPILER)) + #if (__GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__) < 40800 + #error "unsupported GCC version - see https://github.com/nlohmann/json#supported-compilers" + #endif + #endif +#endif + +// C++ language standard detection +// if the user manually specified the used c++ version this is skipped +#if !defined(JSON_HAS_CPP_20) && !defined(JSON_HAS_CPP_17) && !defined(JSON_HAS_CPP_14) && !defined(JSON_HAS_CPP_11) + #if (defined(__cplusplus) && __cplusplus >= 202002L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L) + #define JSON_HAS_CPP_20 + #define JSON_HAS_CPP_17 + #define JSON_HAS_CPP_14 + #elif (defined(__cplusplus) && __cplusplus >= 201703L) || (defined(_HAS_CXX17) && _HAS_CXX17 == 1) // fix for issue #464 + #define JSON_HAS_CPP_17 + #define JSON_HAS_CPP_14 + #elif (defined(__cplusplus) && __cplusplus >= 201402L) || (defined(_HAS_CXX14) && _HAS_CXX14 == 1) + #define JSON_HAS_CPP_14 + #endif + // the cpp 11 flag is always specified because it is the minimal required version + #define JSON_HAS_CPP_11 +#endif + +#ifdef __has_include + #if __has_include() + #include + #endif +#endif + +#if !defined(JSON_HAS_FILESYSTEM) && !defined(JSON_HAS_EXPERIMENTAL_FILESYSTEM) + #ifdef JSON_HAS_CPP_17 + #if defined(__cpp_lib_filesystem) + #define JSON_HAS_FILESYSTEM 1 + #elif defined(__cpp_lib_experimental_filesystem) + #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 1 + #elif !defined(__has_include) + #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 1 + #elif __has_include() + #define JSON_HAS_FILESYSTEM 1 + #elif __has_include() + #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 1 + #endif + + // std::filesystem does not work on MinGW GCC 8: https://sourceforge.net/p/mingw-w64/bugs/737/ + #if defined(__MINGW32__) && defined(__GNUC__) && __GNUC__ == 8 + #undef JSON_HAS_FILESYSTEM + #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #endif + + // no filesystem support before GCC 8: https://en.cppreference.com/w/cpp/compiler_support + #if defined(__GNUC__) && !defined(__clang__) && __GNUC__ < 8 + #undef JSON_HAS_FILESYSTEM + #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #endif + + // no filesystem support before Clang 7: https://en.cppreference.com/w/cpp/compiler_support + #if defined(__clang_major__) && __clang_major__ < 7 + #undef JSON_HAS_FILESYSTEM + #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #endif + + // no filesystem support before MSVC 19.14: https://en.cppreference.com/w/cpp/compiler_support + #if defined(_MSC_VER) && _MSC_VER < 1914 + #undef JSON_HAS_FILESYSTEM + #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #endif + + // no filesystem support before iOS 13 + #if defined(__IPHONE_OS_VERSION_MIN_REQUIRED) && __IPHONE_OS_VERSION_MIN_REQUIRED < 130000 + #undef JSON_HAS_FILESYSTEM + #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #endif + + // no filesystem support before macOS Catalina + #if defined(__MAC_OS_X_VERSION_MIN_REQUIRED) && __MAC_OS_X_VERSION_MIN_REQUIRED < 101500 + #undef JSON_HAS_FILESYSTEM + #undef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #endif + #endif +#endif + +#ifndef JSON_HAS_EXPERIMENTAL_FILESYSTEM + #define JSON_HAS_EXPERIMENTAL_FILESYSTEM 0 +#endif + +#ifndef JSON_HAS_FILESYSTEM + #define JSON_HAS_FILESYSTEM 0 +#endif + +#ifndef JSON_HAS_THREE_WAY_COMPARISON + #if defined(__cpp_impl_three_way_comparison) && __cpp_impl_three_way_comparison >= 201907L \ + && defined(__cpp_lib_three_way_comparison) && __cpp_lib_three_way_comparison >= 201907L + #define JSON_HAS_THREE_WAY_COMPARISON 1 + #else + #define JSON_HAS_THREE_WAY_COMPARISON 0 + #endif +#endif + +#ifndef JSON_HAS_RANGES + // ranges header shipping in GCC 11.1.0 (released 2021-04-27) has syntax error + #if defined(__GLIBCXX__) && __GLIBCXX__ == 20210427 + #define JSON_HAS_RANGES 0 + #elif defined(__cpp_lib_ranges) + #define JSON_HAS_RANGES 1 + #else + #define JSON_HAS_RANGES 0 + #endif +#endif + +#ifndef JSON_HAS_STATIC_RTTI + #if !defined(_HAS_STATIC_RTTI) || _HAS_STATIC_RTTI != 0 + #define JSON_HAS_STATIC_RTTI 1 + #else + #define JSON_HAS_STATIC_RTTI 0 + #endif +#endif + +#ifdef JSON_HAS_CPP_17 + #define JSON_INLINE_VARIABLE inline +#else + #define JSON_INLINE_VARIABLE +#endif + +#if JSON_HEDLEY_HAS_ATTRIBUTE(no_unique_address) + #define JSON_NO_UNIQUE_ADDRESS [[no_unique_address]] +#else + #define JSON_NO_UNIQUE_ADDRESS +#endif + +// disable documentation warnings on clang +#if defined(__clang__) + #pragma clang diagnostic push + #pragma clang diagnostic ignored "-Wdocumentation" + #pragma clang diagnostic ignored "-Wdocumentation-unknown-command" +#endif + +// allow disabling exceptions +#if (defined(__cpp_exceptions) || defined(__EXCEPTIONS) || defined(_CPPUNWIND)) && !defined(JSON_NOEXCEPTION) + #define JSON_THROW(exception) throw exception + #define JSON_TRY try + #define JSON_CATCH(exception) catch(exception) + #define JSON_INTERNAL_CATCH(exception) catch(exception) +#else + #include + #define JSON_THROW(exception) std::abort() + #define JSON_TRY if(true) + #define JSON_CATCH(exception) if(false) + #define JSON_INTERNAL_CATCH(exception) if(false) +#endif + +// override exception macros +#if defined(JSON_THROW_USER) + #undef JSON_THROW + #define JSON_THROW JSON_THROW_USER +#endif +#if defined(JSON_TRY_USER) + #undef JSON_TRY + #define JSON_TRY JSON_TRY_USER +#endif +#if defined(JSON_CATCH_USER) + #undef JSON_CATCH + #define JSON_CATCH JSON_CATCH_USER + #undef JSON_INTERNAL_CATCH + #define JSON_INTERNAL_CATCH JSON_CATCH_USER +#endif +#if defined(JSON_INTERNAL_CATCH_USER) + #undef JSON_INTERNAL_CATCH + #define JSON_INTERNAL_CATCH JSON_INTERNAL_CATCH_USER +#endif + +// allow overriding assert +#if !defined(JSON_ASSERT) + #include // assert + #define JSON_ASSERT(x) assert(x) +#endif + +// allow to access some private functions (needed by the test suite) +#if defined(JSON_TESTS_PRIVATE) + #define JSON_PRIVATE_UNLESS_TESTED public +#else + #define JSON_PRIVATE_UNLESS_TESTED private +#endif + +/*! +@brief macro to briefly define a mapping between an enum and JSON +@def NLOHMANN_JSON_SERIALIZE_ENUM +@since version 3.4.0 +*/ +#define NLOHMANN_JSON_SERIALIZE_ENUM(ENUM_TYPE, ...) \ + template \ + inline void to_json(BasicJsonType& j, const ENUM_TYPE& e) \ + { \ + static_assert(std::is_enum::value, #ENUM_TYPE " must be an enum!"); \ + static const std::pair m[] = __VA_ARGS__; \ + auto it = std::find_if(std::begin(m), std::end(m), \ + [e](const std::pair& ej_pair) -> bool \ + { \ + return ej_pair.first == e; \ + }); \ + j = ((it != std::end(m)) ? it : std::begin(m))->second; \ + } \ + template \ + inline void from_json(const BasicJsonType& j, ENUM_TYPE& e) \ + { \ + static_assert(std::is_enum::value, #ENUM_TYPE " must be an enum!"); \ + static const std::pair m[] = __VA_ARGS__; \ + auto it = std::find_if(std::begin(m), std::end(m), \ + [&j](const std::pair& ej_pair) -> bool \ + { \ + return ej_pair.second == j; \ + }); \ + e = ((it != std::end(m)) ? it : std::begin(m))->first; \ + } + +// Ugly macros to avoid uglier copy-paste when specializing basic_json. They +// may be removed in the future once the class is split. + +#define NLOHMANN_BASIC_JSON_TPL_DECLARATION \ + template class ObjectType, \ + template class ArrayType, \ + class StringType, class BooleanType, class NumberIntegerType, \ + class NumberUnsignedType, class NumberFloatType, \ + template class AllocatorType, \ + template class JSONSerializer, \ + class BinaryType, \ + class CustomBaseClass> + +#define NLOHMANN_BASIC_JSON_TPL \ + basic_json + +// Macros to simplify conversion from/to types + +#define NLOHMANN_JSON_EXPAND( x ) x +#define NLOHMANN_JSON_GET_MACRO(_1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, _25, _26, _27, _28, _29, _30, _31, _32, _33, _34, _35, _36, _37, _38, _39, _40, _41, _42, _43, _44, _45, _46, _47, _48, _49, _50, _51, _52, _53, _54, _55, _56, _57, _58, _59, _60, _61, _62, _63, _64, NAME,...) NAME +#define NLOHMANN_JSON_PASTE(...) NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_GET_MACRO(__VA_ARGS__, \ + NLOHMANN_JSON_PASTE64, \ + NLOHMANN_JSON_PASTE63, \ + NLOHMANN_JSON_PASTE62, \ + NLOHMANN_JSON_PASTE61, \ + NLOHMANN_JSON_PASTE60, \ + NLOHMANN_JSON_PASTE59, \ + NLOHMANN_JSON_PASTE58, \ + NLOHMANN_JSON_PASTE57, \ + NLOHMANN_JSON_PASTE56, \ + NLOHMANN_JSON_PASTE55, \ + NLOHMANN_JSON_PASTE54, \ + NLOHMANN_JSON_PASTE53, \ + NLOHMANN_JSON_PASTE52, \ + NLOHMANN_JSON_PASTE51, \ + NLOHMANN_JSON_PASTE50, \ + NLOHMANN_JSON_PASTE49, \ + NLOHMANN_JSON_PASTE48, \ + NLOHMANN_JSON_PASTE47, \ + NLOHMANN_JSON_PASTE46, \ + NLOHMANN_JSON_PASTE45, \ + NLOHMANN_JSON_PASTE44, \ + NLOHMANN_JSON_PASTE43, \ + NLOHMANN_JSON_PASTE42, \ + NLOHMANN_JSON_PASTE41, \ + NLOHMANN_JSON_PASTE40, \ + NLOHMANN_JSON_PASTE39, \ + NLOHMANN_JSON_PASTE38, \ + NLOHMANN_JSON_PASTE37, \ + NLOHMANN_JSON_PASTE36, \ + NLOHMANN_JSON_PASTE35, \ + NLOHMANN_JSON_PASTE34, \ + NLOHMANN_JSON_PASTE33, \ + NLOHMANN_JSON_PASTE32, \ + NLOHMANN_JSON_PASTE31, \ + NLOHMANN_JSON_PASTE30, \ + NLOHMANN_JSON_PASTE29, \ + NLOHMANN_JSON_PASTE28, \ + NLOHMANN_JSON_PASTE27, \ + NLOHMANN_JSON_PASTE26, \ + NLOHMANN_JSON_PASTE25, \ + NLOHMANN_JSON_PASTE24, \ + NLOHMANN_JSON_PASTE23, \ + NLOHMANN_JSON_PASTE22, \ + NLOHMANN_JSON_PASTE21, \ + NLOHMANN_JSON_PASTE20, \ + NLOHMANN_JSON_PASTE19, \ + NLOHMANN_JSON_PASTE18, \ + NLOHMANN_JSON_PASTE17, \ + NLOHMANN_JSON_PASTE16, \ + NLOHMANN_JSON_PASTE15, \ + NLOHMANN_JSON_PASTE14, \ + NLOHMANN_JSON_PASTE13, \ + NLOHMANN_JSON_PASTE12, \ + NLOHMANN_JSON_PASTE11, \ + NLOHMANN_JSON_PASTE10, \ + NLOHMANN_JSON_PASTE9, \ + NLOHMANN_JSON_PASTE8, \ + NLOHMANN_JSON_PASTE7, \ + NLOHMANN_JSON_PASTE6, \ + NLOHMANN_JSON_PASTE5, \ + NLOHMANN_JSON_PASTE4, \ + NLOHMANN_JSON_PASTE3, \ + NLOHMANN_JSON_PASTE2, \ + NLOHMANN_JSON_PASTE1)(__VA_ARGS__)) +#define NLOHMANN_JSON_PASTE2(func, v1) func(v1) +#define NLOHMANN_JSON_PASTE3(func, v1, v2) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE2(func, v2) +#define NLOHMANN_JSON_PASTE4(func, v1, v2, v3) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE3(func, v2, v3) +#define NLOHMANN_JSON_PASTE5(func, v1, v2, v3, v4) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE4(func, v2, v3, v4) +#define NLOHMANN_JSON_PASTE6(func, v1, v2, v3, v4, v5) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE5(func, v2, v3, v4, v5) +#define NLOHMANN_JSON_PASTE7(func, v1, v2, v3, v4, v5, v6) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE6(func, v2, v3, v4, v5, v6) +#define NLOHMANN_JSON_PASTE8(func, v1, v2, v3, v4, v5, v6, v7) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE7(func, v2, v3, v4, v5, v6, v7) +#define NLOHMANN_JSON_PASTE9(func, v1, v2, v3, v4, v5, v6, v7, v8) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE8(func, v2, v3, v4, v5, v6, v7, v8) +#define NLOHMANN_JSON_PASTE10(func, v1, v2, v3, v4, v5, v6, v7, v8, v9) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE9(func, v2, v3, v4, v5, v6, v7, v8, v9) +#define NLOHMANN_JSON_PASTE11(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE10(func, v2, v3, v4, v5, v6, v7, v8, v9, v10) +#define NLOHMANN_JSON_PASTE12(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE11(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11) +#define NLOHMANN_JSON_PASTE13(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE12(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12) +#define NLOHMANN_JSON_PASTE14(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE13(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13) +#define NLOHMANN_JSON_PASTE15(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE14(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14) +#define NLOHMANN_JSON_PASTE16(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE15(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15) +#define NLOHMANN_JSON_PASTE17(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE16(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16) +#define NLOHMANN_JSON_PASTE18(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE17(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17) +#define NLOHMANN_JSON_PASTE19(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE18(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18) +#define NLOHMANN_JSON_PASTE20(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE19(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19) +#define NLOHMANN_JSON_PASTE21(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE20(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20) +#define NLOHMANN_JSON_PASTE22(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE21(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21) +#define NLOHMANN_JSON_PASTE23(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE22(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22) +#define NLOHMANN_JSON_PASTE24(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE23(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23) +#define NLOHMANN_JSON_PASTE25(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE24(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24) +#define NLOHMANN_JSON_PASTE26(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE25(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25) +#define NLOHMANN_JSON_PASTE27(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE26(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26) +#define NLOHMANN_JSON_PASTE28(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE27(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27) +#define NLOHMANN_JSON_PASTE29(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE28(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28) +#define NLOHMANN_JSON_PASTE30(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE29(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29) +#define NLOHMANN_JSON_PASTE31(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE30(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30) +#define NLOHMANN_JSON_PASTE32(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE31(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31) +#define NLOHMANN_JSON_PASTE33(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE32(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32) +#define NLOHMANN_JSON_PASTE34(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE33(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33) +#define NLOHMANN_JSON_PASTE35(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE34(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34) +#define NLOHMANN_JSON_PASTE36(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE35(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35) +#define NLOHMANN_JSON_PASTE37(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE36(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36) +#define NLOHMANN_JSON_PASTE38(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE37(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37) +#define NLOHMANN_JSON_PASTE39(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE38(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38) +#define NLOHMANN_JSON_PASTE40(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE39(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39) +#define NLOHMANN_JSON_PASTE41(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE40(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40) +#define NLOHMANN_JSON_PASTE42(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE41(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41) +#define NLOHMANN_JSON_PASTE43(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE42(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42) +#define NLOHMANN_JSON_PASTE44(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE43(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43) +#define NLOHMANN_JSON_PASTE45(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE44(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44) +#define NLOHMANN_JSON_PASTE46(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE45(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45) +#define NLOHMANN_JSON_PASTE47(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE46(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46) +#define NLOHMANN_JSON_PASTE48(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE47(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47) +#define NLOHMANN_JSON_PASTE49(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE48(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48) +#define NLOHMANN_JSON_PASTE50(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE49(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49) +#define NLOHMANN_JSON_PASTE51(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE50(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50) +#define NLOHMANN_JSON_PASTE52(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE51(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51) +#define NLOHMANN_JSON_PASTE53(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE52(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52) +#define NLOHMANN_JSON_PASTE54(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE53(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53) +#define NLOHMANN_JSON_PASTE55(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE54(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54) +#define NLOHMANN_JSON_PASTE56(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE55(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55) +#define NLOHMANN_JSON_PASTE57(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE56(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56) +#define NLOHMANN_JSON_PASTE58(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE57(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57) +#define NLOHMANN_JSON_PASTE59(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE58(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58) +#define NLOHMANN_JSON_PASTE60(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE59(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59) +#define NLOHMANN_JSON_PASTE61(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE60(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60) +#define NLOHMANN_JSON_PASTE62(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE61(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61) +#define NLOHMANN_JSON_PASTE63(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE62(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62) +#define NLOHMANN_JSON_PASTE64(func, v1, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62, v63) NLOHMANN_JSON_PASTE2(func, v1) NLOHMANN_JSON_PASTE63(func, v2, v3, v4, v5, v6, v7, v8, v9, v10, v11, v12, v13, v14, v15, v16, v17, v18, v19, v20, v21, v22, v23, v24, v25, v26, v27, v28, v29, v30, v31, v32, v33, v34, v35, v36, v37, v38, v39, v40, v41, v42, v43, v44, v45, v46, v47, v48, v49, v50, v51, v52, v53, v54, v55, v56, v57, v58, v59, v60, v61, v62, v63) + +#define NLOHMANN_JSON_TO(v1) nlohmann_json_j[#v1] = nlohmann_json_t.v1; +#define NLOHMANN_JSON_FROM(v1) nlohmann_json_j.at(#v1).get_to(nlohmann_json_t.v1); +#define NLOHMANN_JSON_FROM_WITH_DEFAULT(v1) nlohmann_json_t.v1 = nlohmann_json_j.value(#v1, nlohmann_json_default_obj.v1); + +/*! +@brief macro +@def NLOHMANN_DEFINE_TYPE_INTRUSIVE +@since version 3.9.0 +*/ +#define NLOHMANN_DEFINE_TYPE_INTRUSIVE(Type, ...) \ + friend void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } \ + friend void from_json(const nlohmann::json& nlohmann_json_j, Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_FROM, __VA_ARGS__)) } + +#define NLOHMANN_DEFINE_TYPE_INTRUSIVE_WITH_DEFAULT(Type, ...) \ + friend void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } \ + friend void from_json(const nlohmann::json& nlohmann_json_j, Type& nlohmann_json_t) { const Type nlohmann_json_default_obj{}; NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_FROM_WITH_DEFAULT, __VA_ARGS__)) } + +#define NLOHMANN_DEFINE_TYPE_INTRUSIVE_ONLY_SERIALIZE(Type, ...) \ + friend void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } + +/*! +@brief macro +@def NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE +@since version 3.9.0 +*/ +#define NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE(Type, ...) \ + inline void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } \ + inline void from_json(const nlohmann::json& nlohmann_json_j, Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_FROM, __VA_ARGS__)) } + +#define NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_ONLY_SERIALIZE(Type, ...) \ + inline void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } + +#define NLOHMANN_DEFINE_TYPE_NON_INTRUSIVE_WITH_DEFAULT(Type, ...) \ + inline void to_json(nlohmann::json& nlohmann_json_j, const Type& nlohmann_json_t) { NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_TO, __VA_ARGS__)) } \ + inline void from_json(const nlohmann::json& nlohmann_json_j, Type& nlohmann_json_t) { const Type nlohmann_json_default_obj{}; NLOHMANN_JSON_EXPAND(NLOHMANN_JSON_PASTE(NLOHMANN_JSON_FROM_WITH_DEFAULT, __VA_ARGS__)) } + +// inspired from https://stackoverflow.com/a/26745591 +// allows to call any std function as if (e.g. with begin): +// using std::begin; begin(x); +// +// it allows using the detected idiom to retrieve the return type +// of such an expression +#define NLOHMANN_CAN_CALL_STD_FUNC_IMPL(std_name) \ + namespace detail { \ + using std::std_name; \ + \ + template \ + using result_of_##std_name = decltype(std_name(std::declval()...)); \ + } \ + \ + namespace detail2 { \ + struct std_name##_tag \ + { \ + }; \ + \ + template \ + std_name##_tag std_name(T&&...); \ + \ + template \ + using result_of_##std_name = decltype(std_name(std::declval()...)); \ + \ + template \ + struct would_call_std_##std_name \ + { \ + static constexpr auto const value = ::nlohmann::detail:: \ + is_detected_exact::value; \ + }; \ + } /* namespace detail2 */ \ + \ + template \ + struct would_call_std_##std_name : detail2::would_call_std_##std_name \ + { \ + } + +#ifndef JSON_USE_IMPLICIT_CONVERSIONS + #define JSON_USE_IMPLICIT_CONVERSIONS 1 +#endif + +#if JSON_USE_IMPLICIT_CONVERSIONS + #define JSON_EXPLICIT +#else + #define JSON_EXPLICIT explicit +#endif + +#ifndef JSON_DISABLE_ENUM_SERIALIZATION + #define JSON_DISABLE_ENUM_SERIALIZATION 0 +#endif + +#ifndef JSON_USE_GLOBAL_UDLS + #define JSON_USE_GLOBAL_UDLS 1 +#endif + +#if JSON_HAS_THREE_WAY_COMPARISON + #include // partial_ordering +#endif + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +/////////////////////////// +// JSON type enumeration // +/////////////////////////// + +/*! +@brief the JSON type enumeration + +This enumeration collects the different JSON types. It is internally used to +distinguish the stored values, and the functions @ref basic_json::is_null(), +@ref basic_json::is_object(), @ref basic_json::is_array(), +@ref basic_json::is_string(), @ref basic_json::is_boolean(), +@ref basic_json::is_number() (with @ref basic_json::is_number_integer(), +@ref basic_json::is_number_unsigned(), and @ref basic_json::is_number_float()), +@ref basic_json::is_discarded(), @ref basic_json::is_primitive(), and +@ref basic_json::is_structured() rely on it. + +@note There are three enumeration entries (number_integer, number_unsigned, and +number_float), because the library distinguishes these three types for numbers: +@ref basic_json::number_unsigned_t is used for unsigned integers, +@ref basic_json::number_integer_t is used for signed integers, and +@ref basic_json::number_float_t is used for floating-point numbers or to +approximate integers which do not fit in the limits of their respective type. + +@sa see @ref basic_json::basic_json(const value_t value_type) -- create a JSON +value with the default value for a given type + +@since version 1.0.0 +*/ +enum class value_t : std::uint8_t +{ + null, ///< null value + object, ///< object (unordered set of name/value pairs) + array, ///< array (ordered collection of values) + string, ///< string value + boolean, ///< boolean value + number_integer, ///< number value (signed integer) + number_unsigned, ///< number value (unsigned integer) + number_float, ///< number value (floating-point) + binary, ///< binary array (ordered collection of bytes) + discarded ///< discarded by the parser callback function +}; + +/*! +@brief comparison operator for JSON types + +Returns an ordering that is similar to Python: +- order: null < boolean < number < object < array < string < binary +- furthermore, each type is not smaller than itself +- discarded values are not comparable +- binary is represented as a b"" string in python and directly comparable to a + string; however, making a binary array directly comparable with a string would + be surprising behavior in a JSON file. + +@since version 1.0.0 +*/ +#if JSON_HAS_THREE_WAY_COMPARISON + inline std::partial_ordering operator<=>(const value_t lhs, const value_t rhs) noexcept // *NOPAD* +#else + inline bool operator<(const value_t lhs, const value_t rhs) noexcept +#endif +{ + static constexpr std::array order = {{ + 0 /* null */, 3 /* object */, 4 /* array */, 5 /* string */, + 1 /* boolean */, 2 /* integer */, 2 /* unsigned */, 2 /* float */, + 6 /* binary */ + } + }; + + const auto l_index = static_cast(lhs); + const auto r_index = static_cast(rhs); +#if JSON_HAS_THREE_WAY_COMPARISON + if (l_index < order.size() && r_index < order.size()) + { + return order[l_index] <=> order[r_index]; // *NOPAD* + } + return std::partial_ordering::unordered; +#else + return l_index < order.size() && r_index < order.size() && order[l_index] < order[r_index]; +#endif +} + +// GCC selects the built-in operator< over an operator rewritten from +// a user-defined spaceship operator +// Clang, MSVC, and ICC select the rewritten candidate +// (see GCC bug https://gcc.gnu.org/bugzilla/show_bug.cgi?id=105200) +#if JSON_HAS_THREE_WAY_COMPARISON && defined(__GNUC__) +inline bool operator<(const value_t lhs, const value_t rhs) noexcept +{ + return std::is_lt(lhs <=> rhs); // *NOPAD* +} +#endif + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +/*! +@brief replace all occurrences of a substring by another string + +@param[in,out] s the string to manipulate; changed so that all + occurrences of @a f are replaced with @a t +@param[in] f the substring to replace with @a t +@param[in] t the string to replace @a f + +@pre The search string @a f must not be empty. **This precondition is +enforced with an assertion.** + +@since version 2.0.0 +*/ +template +inline void replace_substring(StringType& s, const StringType& f, + const StringType& t) +{ + JSON_ASSERT(!f.empty()); + for (auto pos = s.find(f); // find first occurrence of f + pos != StringType::npos; // make sure f was found + s.replace(pos, f.size(), t), // replace with t, and + pos = s.find(f, pos + t.size())) // find next occurrence of f + {} +} + +/*! + * @brief string escaping as described in RFC 6901 (Sect. 4) + * @param[in] s string to escape + * @return escaped string + * + * Note the order of escaping "~" to "~0" and "/" to "~1" is important. + */ +template +inline StringType escape(StringType s) +{ + replace_substring(s, StringType{"~"}, StringType{"~0"}); + replace_substring(s, StringType{"/"}, StringType{"~1"}); + return s; +} + +/*! + * @brief string unescaping as described in RFC 6901 (Sect. 4) + * @param[in] s string to unescape + * @return unescaped string + * + * Note the order of escaping "~1" to "/" and "~0" to "~" is important. + */ +template +static void unescape(StringType& s) +{ + replace_substring(s, StringType{"~1"}, StringType{"/"}); + replace_substring(s, StringType{"~0"}, StringType{"~"}); +} + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // size_t + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +/// struct to capture the start position of the current token +struct position_t +{ + /// the total number of characters read + std::size_t chars_read_total = 0; + /// the number of characters read in the current line + std::size_t chars_read_current_line = 0; + /// the number of lines read + std::size_t lines_read = 0; + + /// conversion to size_t to preserve SAX interface + constexpr operator size_t() const + { + return chars_read_total; + } +}; + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + +// #include + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-FileCopyrightText: 2018 The Abseil Authors +// SPDX-License-Identifier: MIT + + + +#include // array +#include // size_t +#include // conditional, enable_if, false_type, integral_constant, is_constructible, is_integral, is_same, remove_cv, remove_reference, true_type +#include // index_sequence, make_index_sequence, index_sequence_for + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +template +using uncvref_t = typename std::remove_cv::type>::type; + +#ifdef JSON_HAS_CPP_14 + +// the following utilities are natively available in C++14 +using std::enable_if_t; +using std::index_sequence; +using std::make_index_sequence; +using std::index_sequence_for; + +#else + +// alias templates to reduce boilerplate +template +using enable_if_t = typename std::enable_if::type; + +// The following code is taken from https://github.com/abseil/abseil-cpp/blob/10cb35e459f5ecca5b2ff107635da0bfa41011b4/absl/utility/utility.h +// which is part of Google Abseil (https://github.com/abseil/abseil-cpp), licensed under the Apache License 2.0. + +//// START OF CODE FROM GOOGLE ABSEIL + +// integer_sequence +// +// Class template representing a compile-time integer sequence. An instantiation +// of `integer_sequence` has a sequence of integers encoded in its +// type through its template arguments (which is a common need when +// working with C++11 variadic templates). `absl::integer_sequence` is designed +// to be a drop-in replacement for C++14's `std::integer_sequence`. +// +// Example: +// +// template< class T, T... Ints > +// void user_function(integer_sequence); +// +// int main() +// { +// // user_function's `T` will be deduced to `int` and `Ints...` +// // will be deduced to `0, 1, 2, 3, 4`. +// user_function(make_integer_sequence()); +// } +template +struct integer_sequence +{ + using value_type = T; + static constexpr std::size_t size() noexcept + { + return sizeof...(Ints); + } +}; + +// index_sequence +// +// A helper template for an `integer_sequence` of `size_t`, +// `absl::index_sequence` is designed to be a drop-in replacement for C++14's +// `std::index_sequence`. +template +using index_sequence = integer_sequence; + +namespace utility_internal +{ + +template +struct Extend; + +// Note that SeqSize == sizeof...(Ints). It's passed explicitly for efficiency. +template +struct Extend, SeqSize, 0> +{ + using type = integer_sequence < T, Ints..., (Ints + SeqSize)... >; +}; + +template +struct Extend, SeqSize, 1> +{ + using type = integer_sequence < T, Ints..., (Ints + SeqSize)..., 2 * SeqSize >; +}; + +// Recursion helper for 'make_integer_sequence'. +// 'Gen::type' is an alias for 'integer_sequence'. +template +struct Gen +{ + using type = + typename Extend < typename Gen < T, N / 2 >::type, N / 2, N % 2 >::type; +}; + +template +struct Gen +{ + using type = integer_sequence; +}; + +} // namespace utility_internal + +// Compile-time sequences of integers + +// make_integer_sequence +// +// This template alias is equivalent to +// `integer_sequence`, and is designed to be a drop-in +// replacement for C++14's `std::make_integer_sequence`. +template +using make_integer_sequence = typename utility_internal::Gen::type; + +// make_index_sequence +// +// This template alias is equivalent to `index_sequence<0, 1, ..., N-1>`, +// and is designed to be a drop-in replacement for C++14's +// `std::make_index_sequence`. +template +using make_index_sequence = make_integer_sequence; + +// index_sequence_for +// +// Converts a typename pack into an index sequence of the same length, and +// is designed to be a drop-in replacement for C++14's +// `std::index_sequence_for()` +template +using index_sequence_for = make_index_sequence; + +//// END OF CODE FROM GOOGLE ABSEIL + +#endif + +// dispatch utility (taken from ranges-v3) +template struct priority_tag : priority_tag < N - 1 > {}; +template<> struct priority_tag<0> {}; + +// taken from ranges-v3 +template +struct static_const +{ + static JSON_INLINE_VARIABLE constexpr T value{}; +}; + +#ifndef JSON_HAS_CPP_17 + template + constexpr T static_const::value; +#endif + +template +inline constexpr std::array make_array(Args&& ... args) +{ + return std::array {{static_cast(std::forward(args))...}}; +} + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // numeric_limits +#include // false_type, is_constructible, is_integral, is_same, true_type +#include // declval +#include // tuple +#include // char_traits + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +#include // random_access_iterator_tag + +// #include + +// #include + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN +namespace detail +{ + +template +struct iterator_types {}; + +template +struct iterator_types < + It, + void_t> +{ + using difference_type = typename It::difference_type; + using value_type = typename It::value_type; + using pointer = typename It::pointer; + using reference = typename It::reference; + using iterator_category = typename It::iterator_category; +}; + +// This is required as some compilers implement std::iterator_traits in a way that +// doesn't work with SFINAE. See https://github.com/nlohmann/json/issues/1341. +template +struct iterator_traits +{ +}; + +template +struct iterator_traits < T, enable_if_t < !std::is_pointer::value >> + : iterator_types +{ +}; + +template +struct iterator_traits::value>> +{ + using iterator_category = std::random_access_iterator_tag; + using value_type = T; + using difference_type = ptrdiff_t; + using pointer = T*; + using reference = T&; +}; + +} // namespace detail +NLOHMANN_JSON_NAMESPACE_END + +// #include + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN + +NLOHMANN_CAN_CALL_STD_FUNC_IMPL(begin); + +NLOHMANN_JSON_NAMESPACE_END + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + + + +// #include + + +NLOHMANN_JSON_NAMESPACE_BEGIN + +NLOHMANN_CAN_CALL_STD_FUNC_IMPL(end); + +NLOHMANN_JSON_NAMESPACE_END + +// #include + +// #include + +// #include +// __ _____ _____ _____ +// __| | __| | | | JSON for Modern C++ +// | | |__ | | | | | | version 3.11.3 +// |_____|_____|_____|_|___| https://github.com/nlohmann/json +// +// SPDX-FileCopyrightText: 2013-2023 Niels Lohmann +// SPDX-License-Identifier: MIT + +#ifndef INCLUDE_NLOHMANN_JSON_FWD_HPP_ + #define INCLUDE_NLOHMANN_JSON_FWD_HPP_ + + #include // int64_t, uint64_t + #include // map + #include // allocator + #include // string + #include // vector + + // #include + + + /*! + @brief namespace for Niels Lohmann + @see https://github.com/nlohmann + @since version 1.0.0 + */ + NLOHMANN_JSON_NAMESPACE_BEGIN + + /*! + @brief default JSONSerializer template argument + + This serializer ignores the template arguments and uses ADL + ([argument-dependent lookup](https://en.cppreference.com/w/cpp/language/adl)) + for serialization. + */ + template + struct adl_serializer; + + /// a class to store JSON values + /// @sa https://json.nlohmann.me/api/basic_json/ + template class ObjectType = + std::map, + template class ArrayType = std::vector, + class StringType = std::string, class BooleanType = bool, + class NumberIntegerType = std::int64_t, + class NumberUnsignedType = std::uint64_t, + class NumberFloatType = double, + template class AllocatorType = std::allocator, + template class JSONSerializer = + adl_serializer, + class BinaryType = std::vector, // cppcheck-suppress syntaxError + class CustomBaseClass = void> + class basic_json; + + /// @brief JSON Pointer defines a string syntax for identifying a specific value within a JSON document + /// @sa https://json.nlohmann.me/api/json_pointer/ + template + class json_pointer; + + /*! + @brief default specialization + @sa https://json.nlohmann.me/api/json/ + */ + using json = basic_json<>; + + /// @brief a minimal map-like container that preserves insertion order + /// @sa https://json.nlohmann.me/api/ordered_map/ + template + struct ordered_map; + + /// @brief specialization that maintains the insertion order of object keys + /// @sa https://json.nlohmann.me/api/ordered_json/ + using ordered_json = basic_json; + + NLOHMANN_JSON_NAMESPACE_END + +#endif // INCLUDE_NLOHMANN_JSON_FWD_HPP_ + + +NLOHMANN_JSON_NAMESPACE_BEGIN +/*! +@brief detail namespace with internal helper functions + +This namespace collects functions that should not be exposed, +implementations of some @ref basic_json methods, and meta-programming helpers. + +@since version 2.1.0 +*/ +namespace detail +{ + +///////////// +// helpers // +///////////// + +// Note to maintainers: +// +// Every trait in this file expects a non CV-qualified type. +// The only exceptions are in the 'aliases for detected' section +// (i.e. those of the form: decltype(T::member_function(std::declval()))) +// +// In this case, T has to be properly CV-qualified to constraint the function arguments +// (e.g. to_json(BasicJsonType&, const T&)) + +template struct is_basic_json : std::false_type {}; + +NLOHMANN_BASIC_JSON_TPL_DECLARATION +struct is_basic_json : std::true_type {}; + +// used by exceptions create() member functions +// true_type for pointer to possibly cv-qualified basic_json or std::nullptr_t +// false_type otherwise +template +struct is_basic_json_context : + std::integral_constant < bool, + is_basic_json::type>::type>::value + || std::is_same::value > +{}; + +////////////////////// +// json_ref helpers // +////////////////////// + +template +class json_ref; + +template +struct is_json_ref : std::false_type {}; + +template +struct is_json_ref> : std::true_type {}; + +////////////////////////// +// aliases for detected // +////////////////////////// + +template +using mapped_type_t = typename T::mapped_type; + +template +using key_type_t = typename T::key_type; + +template +using value_type_t = typename T::value_type; + +template +using difference_type_t = typename T::difference_type; + +template +using pointer_t = typename T::pointer; + +template +using reference_t = typename T::reference; + +template +using iterator_category_t = typename T::iterator_category; + +template +using to_json_function = decltype(T::to_json(std::declval()...)); + +template +using from_json_function = decltype(T::from_json(std::declval()...)); + +template +using get_template_function = decltype(std::declval().template get()); + +// trait checking if JSONSerializer::from_json(json const&, udt&) exists +template +struct has_from_json : std::false_type {}; + +// trait checking if j.get is valid +// use this trait instead of std::is_constructible or std::is_convertible, +// both rely on, or make use of implicit conversions, and thus fail when T +// has several constructors/operator= (see https://github.com/nlohmann/json/issues/958) +template +struct is_getable +{ + static constexpr bool value = is_detected::value; +}; + +template +struct has_from_json < BasicJsonType, T, enable_if_t < !is_basic_json::value >> +{ + using serializer = typename BasicJsonType::template json_serializer; + + static constexpr bool value = + is_detected_exact::value; +}; + +// This trait checks if JSONSerializer::from_json(json const&) exists +// this overload is used for non-default-constructible user-defined-types +template +struct has_non_default_from_json : std::false_type {}; + +template +struct has_non_default_from_json < BasicJsonType, T, enable_if_t < !is_basic_json::value >> +{ + using serializer = typename BasicJsonType::template json_serializer; + + static constexpr bool value = + is_detected_exact::value; +}; + +// This trait checks if BasicJsonType::json_serializer::to_json exists +// Do not evaluate the trait when T is a basic_json type, to avoid template instantiation infinite recursion. +template +struct has_to_json : std::false_type {}; + +template +struct has_to_json < BasicJsonType, T, enable_if_t < !is_basic_json::value >> +{ + using serializer = typename BasicJsonType::template json_serializer; + + static constexpr bool value = + is_detected_exact::value; +}; + +template +using detect_key_compare = typename T::key_compare; + +template +struct has_key_compare : std::integral_constant::value> {}; + +// obtains the actual object key comparator +template +struct actual_object_comparator +{ + using object_t = typename BasicJsonType::object_t; + using object_comparator_t = typename BasicJsonType::default_object_comparator_t; + using type = typename std::conditional < has_key_compare::value, + typename object_t::key_compare, object_comparator_t>::type; +}; + +template +using actual_object_comparator_t = typename actual_object_comparator::type; + +///////////////// +// char_traits // +///////////////// + +// Primary template of char_traits calls std char_traits +template +struct char_traits : std::char_traits +{}; + +// Explicitly define char traits for unsigned char since it is not standard +template<> +struct char_traits : std::char_traits +{ + using char_type = unsigned char; + using int_type = uint64_t; + + // Redefine to_int_type function + static int_type to_int_type(char_type c) noexcept + { + return static_cast(c); + } + + static char_type to_char_type(int_type i) noexcept + { + return static_cast(i); + } + + static constexpr int_type eof() noexcept + { + return static_cast(EOF); + } +}; + +// Explicitly define char traits for signed char since it is not standard +template<> +struct char_traits : std::char_traits +{ + using char_type = signed char; + using int_type = uint64_t; + + // Redefine to_int_type function + static int_type to_int_type(char_type c) noexcept + { + return static_cast(c); + } + + static char_type to_char_type(int_type i) noexcept + { + return static_cast(i); + } + + static constexpr int_type eof() noexcept + { + return static_cast(EOF); + } +}; + +/////////////////// +// is_ functions // +/////////////////// + +// https://en.cppreference.com/w/cpp/types/conjunction +template struct conjunction : std::true_type { }; +template struct conjunction : B { }; +template +struct conjunction +: std::conditional(B::value), conjunction, B>::type {}; + +// https://en.cppreference.com/w/cpp/types/negation +template struct negation : std::integral_constant < bool, !B::value > { }; + +// Reimplementation of is_constructible and is_default_constructible, due to them being broken for +// std::pair and std::tuple until LWG 2367 fix (see https://cplusplus.github.io/LWG/lwg-defects.html#2367). +// This causes compile errors in e.g. clang 3.5 or gcc 4.9. +template +struct is_default_constructible : std::is_default_constructible {}; + +template +struct is_default_constructible> + : conjunction, is_default_constructible> {}; + +template +struct is_default_constructible> + : conjunction, is_default_constructible> {}; + +template +struct is_default_constructible> + : conjunction...> {}; + +template +struct is_default_constructible> + : conjunction...> {}; + +template +struct is_constructible : std::is_constructible {}; + +template +struct is_constructible> : is_default_constructible> {}; + +template +struct is_constructible> : is_default_constructible> {}; + +template +struct is_constructible> : is_default_constructible> {}; + +template +struct is_constructible> : is_default_constructible> {}; + +template +struct is_iterator_traits : std::false_type {}; + +template +struct is_iterator_traits> +{ + private: + using traits = iterator_traits; + + public: + static constexpr auto value = + is_detected::value && + is_detected::value && + is_detected::value && + is_detected::value && + is_detected::value; +}; + +template +struct is_range +{ + private: + using t_ref = typename std::add_lvalue_reference::type; + + using iterator = detected_t; + using sentinel = detected_t; + + // to be 100% correct, it should use https://en.cppreference.com/w/cpp/iterator/input_or_output_iterator + // and https://en.cppreference.com/w/cpp/iterator/sentinel_for + // but reimplementing these would be too much work, as a lot of other concepts are used underneath + static constexpr auto is_iterator_begin = + is_iterator_traits>::value; + + public: + static constexpr bool value = !std::is_same::value && !std::is_same::value && is_iterator_begin; +}; + +template +using iterator_t = enable_if_t::value, result_of_begin())>>; + +template +using range_value_t = value_type_t>>; + +// The following implementation of is_complete_type is taken from +// https://blogs.msdn.microsoft.com/vcblog/2015/12/02/partial-support-for-expression-sfinae-in-vs-2015-update-1/ +// and is written by Xiang Fan who agreed to using it in this library. + +template +struct is_complete_type : std::false_type {}; + +template +struct is_complete_type : std::true_type {}; + +template +struct is_compatible_object_type_impl : std::false_type {}; + +template +struct is_compatible_object_type_impl < + BasicJsonType, CompatibleObjectType, + enable_if_t < is_detected::value&& + is_detected::value >> +{ + using object_t = typename BasicJsonType::object_t; + + // macOS's is_constructible does not play well with nonesuch... + static constexpr bool value = + is_constructible::value && + is_constructible::value; +}; + +template +struct is_compatible_object_type + : is_compatible_object_type_impl {}; + +template +struct is_constructible_object_type_impl : std::false_type {}; + +template +struct is_constructible_object_type_impl < + BasicJsonType, ConstructibleObjectType, + enable_if_t < is_detected::value&& + is_detected::value >> +{ + using object_t = typename BasicJsonType::object_t; + + static constexpr bool value = + (is_default_constructible::value && + (std::is_move_assignable::value || + std::is_copy_assignable::value) && + (is_constructible::value && + std::is_same < + typename object_t::mapped_type, + typename ConstructibleObjectType::mapped_type >::value)) || + (has_from_json::value || + has_non_default_from_json < + BasicJsonType, + typename ConstructibleObjectType::mapped_type >::value); +}; + +template +struct is_constructible_object_type + : is_constructible_object_type_impl {}; + +template +struct is_compatible_string_type +{ + static constexpr auto value = + is_constructible::value; +}; + +template +struct is_constructible_string_type +{ + // launder type through decltype() to fix compilation failure on ICPC +#ifdef __INTEL_COMPILER + using laundered_type = decltype(std::declval()); +#else + using laundered_type = ConstructibleStringType; +#endif + + static constexpr auto value = + conjunction < + is_constructible, + is_detected_exact>::value; +}; + +template +struct is_compatible_array_type_impl : std::false_type {}; + +template +struct is_compatible_array_type_impl < + BasicJsonType, CompatibleArrayType, + enable_if_t < + is_detected::value&& + is_iterator_traits>>::value&& +// special case for types like std::filesystem::path whose iterator's value_type are themselves +// c.f. https://github.com/nlohmann/json/pull/3073 + !std::is_same>::value >> +{ + static constexpr bool value = + is_constructible>::value; +}; + +template +struct is_compatible_array_type + : is_compatible_array_type_impl {}; + +template +struct is_constructible_array_type_impl : std::false_type {}; + +template +struct is_constructible_array_type_impl < + BasicJsonType, ConstructibleArrayType, + enable_if_t::value >> + : std::true_type {}; + +template +struct is_constructible_array_type_impl < + BasicJsonType, ConstructibleArrayType, + enable_if_t < !std::is_same::value&& + !is_compatible_string_type::value&& + is_default_constructible::value&& +(std::is_move_assignable::value || + std::is_copy_assignable::value)&& +is_detected::value&& +is_iterator_traits>>::value&& +is_detected::value&& +// special case for types like std::filesystem::path whose iterator's value_type are themselves +// c.f. https://github.com/nlohmann/json/pull/3073 +!std::is_same>::value&& + is_complete_type < + detected_t>::value >> +{ + using value_type = range_value_t; + + static constexpr bool value = + std::is_same::value || + has_from_json::value || + has_non_default_from_json < + BasicJsonType, + value_type >::value; +}; + +template +struct is_constructible_array_type + : is_constructible_array_type_impl {}; + +template +struct is_compatible_integer_type_impl : std::false_type {}; + +template +struct is_compatible_integer_type_impl < + RealIntegerType, CompatibleNumberIntegerType, + enable_if_t < std::is_integral::value&& + std::is_integral::value&& + !std::is_same::value >> +{ + // is there an assert somewhere on overflows? + using RealLimits = std::numeric_limits; + using CompatibleLimits = std::numeric_limits; + + static constexpr auto value = + is_constructible::value && + CompatibleLimits::is_integer && + RealLimits::is_signed == CompatibleLimits::is_signed; +}; + +template +struct is_compatible_integer_type + : is_compatible_integer_type_impl {}; + +template +struct is_compatible_type_impl: std::false_type {}; + +template +struct is_compatible_type_impl < + BasicJsonType, CompatibleType, + enable_if_t::value >> +{ + static constexpr bool value = + has_to_json::value; +}; + +template +struct is_compatible_type + : is_compatible_type_impl {}; + +template +struct is_constructible_tuple : std::false_type {}; + +template +struct is_constructible_tuple> : conjunction...> {}; + +template +struct is_json_iterator_of : std::false_type {}; + +template +struct is_json_iterator_of : std::true_type {}; + +template +struct is_json_iterator_of : std::true_type +{}; + +// checks if a given type T is a template specialization of Primary +template