initial

.clang-format

@@ -0,0 +1,3 @@
+---
+BasedOnStyle: LLVM
+Standard: Cpp11

.dockerignore

@@ -0,0 +1,8 @@
+*
+
+!docker/bashrc
+!docker/bootstrap/pkgs.nix
+!docker/entrypoint.sh
+!docker/nix.conf
+!flake.lock
+!flake.nix

.github/workflows/tests.yml

@@ -0,0 +1,49 @@
+---
+name: tests
+on: push
+
+env:
+  DOCKER_CONTAINER_REGISTRY_TOKEN: ${{ secrets.DOCKER_CONTAINER_REGISTRY_TOKEN }}
+
+jobs:
+  build-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DeterminateSystems/nix-installer-action@main
+      - uses: DeterminateSystems/magic-nix-cache-action@main
+
+      - name: Run flake check
+        run: nix flake check
+
+      - name: Create results dir
+        run: mkdir -p ./result ./test/results
+
+      - name: Build tests
+        run: ./test/build-tests --result-dir ./result
+
+  #     - name: Upload results dir
+  #       uses: actions/upload-artifact@v4
+  #       with:
+  #         name: build-results
+  #         path: ./result
+
+  # # The reason this is split out into a separate test is because it needs to use a different container image
+  # run-tests:
+  #   runs-on: ubuntu-latest
+  #   needs: [build-tests]
+  #   container: ghcr.io/siftech/lmcas-test:test
+  #   steps:
+  #     - uses: actions/checkout@v4
+
+  #     - name: Download results dir
+  #       uses: actions/download-artifact@v4
+  #       with:
+  #         name: build-results
+  #         path: ./result
+
+  #     - name: Lol
+  #       run: pwd && ls -l && ls -l result
+
+      - name: Run tests
+        run: ./ci/github-actions-run-tests.sh

.gitignore

@@ -0,0 +1,16 @@
+.ccls-cache/
+.direnv/
+.gdb_history
+
+__pycache__/
+result
+result-doc
+result-debug
+/result-*
+target/
+/build
+/*.bc
+tmp
+doc.tar.gz
+
+.cache

.gitlab/merge_request_templates/default.md

@@ -0,0 +1,8 @@
+## What did you change?
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+
+## TODOs before merge
+
+- [ ] Update documentation
+- [ ] Update changelog (doc/src/references/changelog.md)

LICENSES/Apache-2.0.txt

@@ -0,0 +1,73 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+     (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+     (b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+     (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+     (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+     You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+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.

README.md

@@ -0,0 +1,89 @@
+# LMCAS
+
+[_TOC_]
+
+## Development shell
+
+The [Nix](https://nixos.org/) package manager is used to acquire dependencies and orchestrate builds.
+To avoid the need to install it, a Docker image is provided.
+This image is based on `ghcr.io/siftech/nix-base-image`.
+
+If you haven't pulled images from the GitHub container registry before, see [these instructions](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
+Otherwise, a normal `docker pull ghcr.io/siftech/nix-base-image` is sufficient.
+
+Running `./tools/host/lmcas-dev-shell` will start the dev shell.
+
+## Test suite
+
+Our test suite may be run from `code/` on your host machine with
+
+```
+./test/lmcas-run-tests
+```
+
+This script will trigger both the debloating and test scripts to run in sequence.
+Once the lmcas-run-tests script begins, it launches a dev shell where targets are first debloated if the current set up is not cached in the nix store.
+Additional tests like the linter and unit tests will also run during this stage.
+After the debloating process, we then launch a docker container for every target and every test under that target (exccept the tabacco cps and uwisc targets where all tests are run in the same container).
+
+Some target tests require `IPv6` support for Docker, which is not enabled by default.
+This can be enabled locally by following the [Enable IPv6 support](https://docs.docker.com/config/daemon/ipv6/) guide.
+
+### Testing options
+
+Specific targets may be excluded from a test run with the flag `--no-target` followed by a comma separated list of targets.
+The legal names for targets can be found in `flake.nix` in the targets attrset.
+
+```
+./test/lmcas-run-tests --no-target dropbear,mongoose
+```
+
+Similarly, specific tests run in the dev shell during the first testing stage may also be turned off.
+
+```
+./test/lmcas-run-tests --no-test lint,check-bind
+```
+
+### Adding new targets
+
+New targets can be added under `test/tabacco-targets`.
+Create a new directory there for the target. This should include:
+
+1. A patch which manually places the neck into the source (this may change once neck miner has been fully integrated)
+2. `default.nix` to build and install the target. This should also include two passthrus:
+    - `passthru.bin-paths` to specify the path to the binary or binaries you intend to debloat
+    - `passhtru.specs` to specify all the tabacco specifications that will be used during testing
+3. All tabacco specs you intend to debloat with.
+These specs are given as nix attrsets but later converted to json during the debloating stage of the tests.
+4. A directory for each test you would like to run in a separate docker container.
+This must contain a script `test.sh`, but this script can be used to dispatch e.g. `pytest` or as the test itself.
+5. Any extra configuration files you might need.
+
+5.5. You will also need to add it to the `targets` attrset in `flake.nix`.
+
+The directories `curl`, `dropbear`, `mongoose`, etc. in `test/tabacco-targets` are all good examples of this and their directory structure should be closely followed.
+You may reference their contents for how to set up your own tests.
+
+You can add targets for debloating before writing more elaborate test scripts for them, but you will still need to implement steps 1-3 and 5.5 above for your new target.
+
+The file `test/Dockerfile` sets up the docker image that all target test scripts are run in. If your test requires additional dependencies (that do not need to be built from source), you can add them here.
+
+### Adding other tests
+
+Non-target specific tests are also run during the debloating stage.
+This includes the linter and unit tests.
+New unit tests should be written as `.nix` files and placed in `unit-tests/`.
+This directory might be restructured as additional unit tests are added.
+
+You can include your unit tests by adding them to flake.nix in the attrset under the function `checksForTests`.
+
+## Developing the passes
+
+Run e.g. `nix develop .#instrumentation-pass` in the root directory of the project to get into the correct environment, then `cd` into the `instrumentation-pass` directory.
+
+The first time you do this (or if a `build` directory does not exist), run `cmake -B build -GNinja -DCMAKE_BUILD_TYPE=RelWithDebInfo` to generate build scripts in `build`.
+
+This is also necessary for the language server plugin for your editor to pick up the locations of libraries.
+
+To build the pass (e.g. for a test compile), run `ninja -C build`.
+In general, however, passes should be built through the Nix infrastructure to ensure a clean build and to replicate the conditions used to prepare release builds.

REUSE.toml

@@ -0,0 +1,6 @@
+version = 1
+
+[[annotations]]
+path = "test/**/*.json"
+SPDX-FileCopyrightText = "2022-2024 Smart Information Flow Technologies"
+SPDX-License-Identifier = "Apache-2.0 OR MIT"

annotation-pass/.gitignore

@@ -0,0 +1,6 @@
+# SPDX-FileCopyrightText: 2022-2024 Smart Information Flow Technologies
+#
+# SPDX-License-Identifier: Apache-2.0 AND MIT
+
+build
+*.bc

annotation-pass/CMakeLists.txt

@@ -0,0 +1,37 @@
+# SPDX-FileCopyrightText: 2022-2024 Smart Information Flow Technologies
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+cmake_minimum_required(VERSION 3.5)
+project(LmcasAnnotationPass LANGUAGES CXX)
+enable_testing()
+
+# Enable exporting of compile_commands.json, which can help clangd find headers
+# in the Nix store that it wouldn't normally be able to find. Just run this once
+# and link this wherever development is happening and then further invocations
+# to ninja should automatically update it.
+set(CMAKE_EXPORT_COMPILE_COMMANDS ON CACHE INTERNAL "")
+if(CMAKE_EXPORT_COMPILE_COMMANDS)
+  set(CMAKE_CXX_STANDARD_INCLUDE_DIRECTORIES
+    ${CMAKE_CXX_IMPLICIT_INCLUDE_DIRECTORIES})
+endif()
+
+find_package(LLVM REQUIRED CONFIG)
+add_definitions(${LLVM_DEFINITIONS})
+include_directories(${LLVM_INCLUDE_DIRS})
+link_directories(${LLVM_LIBRARY_DIRS})
+
+find_package(spdlog REQUIRED)
+
+set (CMAKE_CXX_STANDARD 17)
+include_directories(include)
+
+add_library(LmcasAnnotationPass MODULE
+  src/Pass.cpp
+)
+
+target_link_libraries(LmcasAnnotationPass PRIVATE spdlog::spdlog_header_only)
+target_compile_features(LmcasAnnotationPass PRIVATE cxx_range_for cxx_auto_type)
+set_target_properties(LmcasAnnotationPass PROPERTIES COMPILE_FLAGS "-fno-rtti")
+
+install(TARGETS LmcasAnnotationPass DESTINATION lib)

annotation-pass/default.nix

@@ -0,0 +1,16 @@
+# SPDX-FileCopyrightText: 2022-2024 Smart Information Flow Technologies
+#
+# SPDX-License-Identifier: Apache-2.0 OR MIT
+
+{ llvmPkgs, cmake, ninja, spdlog, nix-gitignore, }:
+
+llvmPkgs.stdenv.mkDerivation {
+  name = "annotation-pass";
+
+  src = nix-gitignore.gitignoreSource [ ../.gitignore ./.gitignore ] ./.;
+
+  nativeBuildInputs = [ cmake ninja ];
+  buildInputs = [ llvmPkgs.llvm spdlog ];
+  cmakeBuildType = "RelWithDebInfo";
+  dontStrip = true;
+}