Dev/hybrid (#13)

* Implemented middleware app as a hybrid function (mix compute and i/o)

* Switch to using the SDK provided CMake definitions of dlibc dlibcxx

* Prepare for open sourcing

---------

Co-authored-by: Yazhuo Zhang <[email protected]>
Co-authored-by: richardlee <[email protected]>

Author: 3 people

.github/workflows/file_checks.yml

@@ -0,0 +1,18 @@
+name: Format checks
+
+on:
+  push:
+    branches: [ "main" ]
+
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest      
+
+    steps: 
+    - uses: actions/checkout@v4
+
+    - name: C format check
+      run: find functions/ -iname '*.h' -o -iname '*.c' | clang-format --dry-run -Werror --files=/dev/stdin --style=LLVM 

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 ETH Zurich EASL
+
+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.

LICENSES/MIT.txt

@@ -0,0 +1 @@
+../LICENSE

README.md

@@ -0,0 +1,11 @@
+## Overview
+
+This repository contains examples of how to write functions to run on [Dandelion](https://github.com/eth-easl/dandelion)
+
+The different folders contain examples and more information for the supported languages.
+
+Curretly we only have full support for C and C++.
+Examples for how to write functions, setup builds and other details can be found in the `c_functons` folder.
+
+There is also support for functions compiled to Wasm.
+The tooling to compile functions this way is in the `wasm-compiler` folder.

functions/CMakeLists.txt c_functions/CMakeLists.txtfunctions/CMakeLists.txt renamed to c_functions/CMakeLists.txt

@@ -0,0 +1,29 @@
+# Functions
+
+This folder contains a series of functions used for basic functionality tests or as example applications. 
+The functions are split into multiple executables that can be built individually.
+
+All C and C++ functions depend on the [dandelion SDK](https://github.com/eth-easl/dandelion).
+Functions can either only use the lowest level interface `dandelion_runtime` or the `dlibc`/`dlibcxx`.
+The runtime provides basic wrapper to start a function and interact directly with input and output sets and buffers.
+The libc variants also support reading and writing inputs and outputs to a filesystem abstraction, which is further explained in the SDK documentation.
+
+# Building
+
+The build for this repository is set up to allow building functions for all backends and architectures supported by the SDK.
+To set this up use the following commands:
+
+```
+mkdir build
+cd build
+cmake -DPLATFORM=<platform> -DARCHITECTURE=<target arch> -DCMAKE_BUILD_TYPE-<type> .
+```
+
+The platforms supported are `CHERI`, `MMU_FREEBSD`, `MMU_LINUX`, `KVM`, `WASM`, `DEBUG`. \
+We support `x86_64` and `aarch64` architectures. \
+The build type can be either `Debug` or `Release`.
+
+When one of the parameters is not given, it defaults to the `DEBUG` platform, the build system architecture and `Debug` build type.
+
+The CMake in this project is set up to automatically download the latest version of the dandelion SDK when it is initially set up.
+The easiest way to use a different version, is to replace the `dandelion_sdk` folder in the build folder with a symlink to the version to be used.