simulator: separate from unit tests and move to its own folder

Simulator was placed in `test/unit-test` folder for ease of implementation. The mocks
and the build instructions were already there.

However, in ideal structure, simulator must be in its own directory since it is
not actually a unit test. This commit opens a new directory named `simulator` under
`test`, where the simulator implementation, necessary mocks and its own
`CMakeLists.txt` configuration is implemented.

To build only the simulator itself, now one can do `make simulator` directly. To
build and also run the simulator `make run-simulator` is sufficient.

The target executable still resides in `build-build/bin` folder, but its name is now
changed to `simulator`.

Signed-off-by: asi345 <inanata15@gmail.com>

Author: asi345

CMakeLists.txt

@@ -377,6 +377,7 @@ if(CMAKE_CROSSCOMPILING)
 else()
   include(CTest)
   add_subdirectory(test/unit-test)
+  add_subdirectory(test/simulator)
   if(COVERAGE)
     find_program(GCOVR gcovr)
     if(NOT GCOVR STREQUAL "GCOVR-NOTFOUND")

Makefile

@@ -85,6 +85,10 @@ docs: | build
 	$(MAKE) -C build doc
 rust-docs: | build
 	$(MAKE) -C build rust-docs
+simulator: | build-build
+	$(MAKE) -C build-build simulator
+run-simulator: | simulator
+	./build-build/bin/simulator
 unit-test: | build-build
 	$(MAKE) -C build-build
 # Must compile C tests before running them

test/simulator/CMakeLists.txt

@@ -0,0 +1,191 @@
+# Copyright 2018 Shift Cryptosecurity AG
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+#-----------------------------------------------------------------------------
+# Build bitbox lib to use in tests
+
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wno-unused-parameter -Wno-missing-prototypes -Wno-missing-declarations -Wno-implicit-function-declaration -Wno-bad-function-cast")
+
+set(DBB-FILTERED-SOURCES
+  ${DBB-FIRMWARE-SOURCES}
+  ${DBB-FIRMWARE-UI-SOURCES}
+  ${FIRMWARE-U2F-SOURCES}
+  ${DBB-FIRMWARE-USB-SOURCES}
+  )
+
+set(IGNORE_SOURCES
+    "src/screen.c"
+    "src/memory/nvmctrl.c"
+    "src/memory/smarteeprom.c"
+    "src/memory.mpu.c"
+    )
+#f9b3ceaa91e
+
+# Exclude some files which depends on the hardware.
+foreach(SOURCEFILE ${IGNORE_SOURCES})
+    list(FILTER DBB-FILTERED-SOURCES EXCLUDE REGEX ".*/${SOURCEFILE}$")
+endforeach()
+
+message("FILTERED SOURCES: ${DBB-FILTERED-SOURCES}")
+
+add_library(sd-mock-simulator
+  STATIC
+  framework/mock_diskio.c
+)
+target_include_directories(
+  sd-mock-simulator
+  PUBLIC
+  $<TARGET_PROPERTY:fatfs,INTERFACE_INCLUDE_DIRECTORIES>
+)
+
+
+# We create a CMake "object library" to track all the compiled sources so that
+# they can be reused between a normal library and the manually crafted "merged"
+# library.
+# See https://cmake.org/cmake/help/v3.10/command/add_library.html#object-libraries
+add_library(bitbox_objects-simulator
+  OBJECT
+  ${DBB-FILTERED-SOURCES}
+  ${CTAES-SOURCES}
+  ${ETHEREUM-SOURCES}
+  framework/mock_cipher.c
+  framework/mock_memory.c
+  framework/mock_screen.c
+  framework/mock_smarteeprom.c
+  framework/mock_securechip.c
+)
+
+add_library(bitbox-simulator
+  STATIC
+  $<TARGET_OBJECTS:bitbox_objects-simulator>
+)
+
+# Here we create the "merged" library, which starts with the c-lib created by
+# cargo in the "bitbox02-rust-c" project. That project produces a c-lib without
+# mangled symbols so that it is easier to use from C. We then extend that
+# library with all the object files declared in "bitbox_objects-simulator", all the code
+# we want to be able to call from tests.
+# By linking to "bitbox_merged-simulator" in the rust unit tests we get access to all our
+# code. (That linkage is done by cargo using a "build.rs" script in the
+# bitbox02 rust project.)
+add_custom_command(
+  OUTPUT ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/libbitbox_merged-simulator.a
+  DEPENDS c-unit-tests_rust_c bitbox_objects-simulator $<TARGET_OBJECTS:bitbox_objects-simulator>
+  COMMAND ${CMAKE_COMMAND} -E copy $<TARGET_PROPERTY:c-unit-tests_rust_c,IMPORTED_LOCATION> ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/libbitbox_merged-simulator.a
+  COMMAND ar q ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/libbitbox_merged-simulator.a $<TARGET_OBJECTS:bitbox_objects-simulator>
+  VERBATIM
+  COMMAND_EXPAND_LISTS
+)
+
+add_custom_target(bitbox_merged-simulator DEPENDS ${CMAKE_ARCHIVE_OUTPUT_DIRECTORY}/libbitbox_merged-simulator.a)
+
+target_include_directories(
+  bitbox_objects-simulator
+  SYSTEM PUBLIC
+  ${SYSTEMINCLUDES}
+  ${CMAKE_SOURCE_DIR}/external
+  ${CMAKE_SOURCE_DIR}/external/ctaes
+  ${CMAKE_SOURCE_DIR}/external/fatfs/source
+  $<TARGET_PROPERTY:wallycore,INTERFACE_INCLUDE_DIRECTORIES>
+  $<TARGET_PROPERTY:secp256k1,INTERFACE_INCLUDE_DIRECTORIES>
+  $<TARGET_PROPERTY:fatfs,INTERFACE_INCLUDE_DIRECTORIES>
+)
+target_include_directories(
+  bitbox_objects-simulator
+  PUBLIC
+  ${INCLUDES}
+  ${CMAKE_CURRENT_SOURCE_DIR}/framework/includes
+  ${CMAKE_CURRENT_SOURCE_DIR}
+  ${CMAKE_BINARY_DIR}/src
+)
+
+target_include_directories(
+  bitbox-simulator
+  SYSTEM PUBLIC
+  ${SYSTEMINCLUDES}
+  ${CMAKE_SOURCE_DIR}/external
+  ${CMAKE_SOURCE_DIR}/external/ctaes
+  ${CMAKE_SOURCE_DIR}/external/fatfs/source
+  $<TARGET_PROPERTY:wallycore,INTERFACE_INCLUDE_DIRECTORIES>
+  $<TARGET_PROPERTY:secp256k1,INTERFACE_INCLUDE_DIRECTORIES>
+  $<TARGET_PROPERTY:fatfs,INTERFACE_INCLUDE_DIRECTORIES>
+)
+
+target_include_directories(
+  bitbox-simulator
+  PUBLIC
+  ${INCLUDES}
+  ${CMAKE_CURRENT_SOURCE_DIR}/framework/includes
+  ${CMAKE_CURRENT_SOURCE_DIR}
+  ${CMAKE_BINARY_DIR}/src
+)
+
+add_dependencies(bitbox_objects-simulator
+  rust-cbindgen
+  wallycore
+  secp256k1
+  ctaes
+  fatfs
+  sd-mock-simulator
+)
+target_link_libraries(bitbox-simulator PRIVATE ${LIBBITBOX02_RUST} "-lm")
+
+target_compile_definitions(bitbox_objects-simulator PUBLIC "PRODUCT_BITBOX_MULTI=1" "APP_BTC=1" "APP_LTC=1" "APP_U2F=1" "APP_ETH=1")
+target_compile_definitions(bitbox_objects-simulator PUBLIC TESTING)
+
+# Since wallycore is an external projects we need to specify the dependency
+add_dependencies(bitbox_objects-simulator libwally-core)
+
+target_compile_definitions(bitbox-simulator PUBLIC "PRODUCT_BITBOX_MULTI=1" "APP_BTC=1" "APP_LTC=1" "APP_U2F=1" "APP_ETH=1")
+target_compile_definitions(bitbox-simulator PUBLIC TESTING)
+
+target_link_libraries(bitbox-simulator
+  PUBLIC
+    secp256k1
+  PRIVATE
+    wallycore
+    ctaes
+    fatfs
+    sd-mock-simulator
+)
+
+if(SANITIZE_ADDRESS)
+  target_compile_options(bitbox_objects-simulator PUBLIC "-fsanitize=address")
+  target_compile_options(bitbox-simulator PUBLIC "-fsanitize=address")
+endif()
+if(SANTIZE_UNDEFINED)
+  target_compile_options(bitbox_objects-simulator PUBLIC "-fsanitize=undefined")
+  target_compile_options(bitbox-simulator PUBLIC "-fsanitize=undefined")
+endif()
+if(COVERAGE)
+  target_link_libraries(bitbox-simulator PUBLIC "--coverage")
+  target_compile_options(bitbox_objects-simulator PUBLIC "--coverage")
+  target_compile_options(bitbox-simulator PUBLIC "--coverage")
+endif()
+
+#-----------------------------------------------------------------------------
+# Simulator
+
+add_executable(simulator simulator.c framework/eh_personality.c)
+# asan must be first library in linking order
+target_link_libraries(simulator PRIVATE
+  $<$<BOOL:${SANITIZE_ADDRESS}>:asan>
+  $<$<BOOL:${SANITIZE_UNDEFINED}>:-fsanitize=undefined>
+  -Wl,--start-group
+  c-unit-tests_rust_c
+  bitbox-simulator
+  -Wl,--end-group
+  ""
+)

test/simulator/framework/eh_personality.c

@@ -0,0 +1,28 @@
+// Copyright 2022 Shift Crypto AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Needed to link the C unit test executables in /test/unit-test, which link to bitbox_merged.
+// `rust_eh_personality` is provided by Rust when building the firmware or running Rust unit tests
+//
+// See
+// https://doc.rust-lang.org/unstable-book/language-features/lang-items.html#writing-an-executable-without-stdlib.
+//
+// One could get rid of this and also considerably shrink the binary size by compiling core instead
+// of using pre-built binaries. See a proof of concept implementation here:
+// https://github.com/digitalbitbox/bitbox02-firmware/tree/build-std-PoC.  We decided against doing
+// this for now as the feature seems immature and because of the warnings against using it in
+// production:
+// https://github.com/rust-lang/wg-cargo-std-aware/tree/81765f0eb744b9c47840c16f43a32c9f61fd7f0c#mvp-implementation
+void rust_eh_personality(void);
+void rust_eh_personality(void) {}

test/simulator/framework/includes/mock_cipher.h

@@ -0,0 +1,22 @@
+// Copyright 2023 Shift Crypto AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef _MOCK_CIPHER_H_
+#define _MOCK_CIPHER_H_
+
+#include <stdint.h>
+
+void cipher_mock_iv(uint8_t* iv_out);
+
+#endif

test/simulator/framework/includes/mock_memory.h

@@ -0,0 +1,30 @@
+// Copyright 2019 Shift Cryptosecurity AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef _MOCK_MEMORY_H_
+#define _MOCK_MEMORY_H_
+
+#include <stdbool.h>
+#include <stdint.h>
+
+#include <flags.h>
+
+void mock_memory_factoryreset(void);
+bool memory_write_to_address_mock(uint32_t base, uint32_t addr, const uint8_t* chunk);
+bool memory_write_chunk_mock(uint32_t chunk_num, const uint8_t* chunk);
+void memory_read_chunk_mock(uint32_t chunk_num, uint8_t* chunk_out);
+// Size: `FLASH_SHARED_DATA_LEN`.
+void memory_read_shared_bootdata_mock(uint8_t* chunk_out);
+void mock_memory_set_salt_root(const uint8_t* salt_root);
+#endif

test/simulator/framework/includes/mock_qtouch.h

@@ -0,0 +1,34 @@
+// Copyright 2019 Shift Cryptosecurity AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef _QTOUCH_H_
+#define _QTOUCH_H_
+
+#include <stdint.h>
+
+void __wrap_qtouch_process(void);
+
+uint8_t __wrap_qtouch_get_scroller_is_active(uint16_t sensor_node);
+
+uint16_t __wrap_qtouch_get_scroller_position(uint16_t sensor_node);
+
+void qtouch_process(void);
+
+uint8_t qtouch_is_scroller_active(uint16_t sensor_node);
+
+uint16_t qtouch_get_scroller_position(uint16_t sensor_node);
+
+void qtouch_force_calibrate(void);
+
+#endif

test/simulator/framework/includes/mock_screen_stack.h

@@ -0,0 +1,19 @@
+// Copyright 2019 Shift Cryptosecurity AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef _TEST_SCREEN_STACK_H
+#define _TEST_SCREEN_STACK_H
+
+void mock_screen_stack_assert_clean(void);
+#endif

test/simulator/framework/includes/test_random.h

@@ -0,0 +1,25 @@
+// Copyright 2019 Shift Cryptosecurity AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#ifndef _TEST_RANDOM_H
+#define _TEST_RANDOM_H
+
+int __wrap_rand(void);
+int __wrap_wally_sha256(
+    const unsigned char* bytes,
+    size_t bytes_len,
+    unsigned char* bytes_out,
+    size_t len);
+
+#endif

test/simulator/framework/mock_cipher.c

@@ -0,0 +1,22 @@
+// Copyright 2023 Shift Crypto AG
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include <string.h>
+
+#include <mock_cipher.h>
+
+void cipher_mock_iv(uint8_t* iv_out)
+{
+    memset(iv_out, 'a', 32);
+}