Add freebsd userland platform

.github/workflows/ci.yml

@@ -259,6 +259,9 @@ jobs:
           # - `litebox_platform_linux_userland` is allowed to have `std` access,
           #   since it is a purely-userland implementation.
           #
+          # - `litebox_platform_freebsd_userland` is allowed to have `std` access,
+          #   since it is a purely-userland implementation.
+          #
           # - `litebox_platform_windows_userland` is allowed to have `std` access,
           #   since it is a purely-userland implementation.
           #
@@ -311,6 +314,7 @@ jobs:
           find . -type f -name 'Cargo.toml' \
             -not -path './Cargo.toml' \
             -not -path './litebox_platform_linux_userland/Cargo.toml' \
+            -not -path './litebox_platform_freebsd_userland/Cargo.toml' \
             -not -path './litebox_platform_windows_userland/Cargo.toml' \
             -not -path './litebox_runner_linux_on_windows_userland/Cargo.toml' \
             -not -path './litebox_platform_lvbs/Cargo.toml' \

Cargo.toml

@@ -4,6 +4,7 @@ members = [
     "litebox", 
     "litebox_common_linux",
     "litebox_common_optee",
+    "litebox_platform_freebsd_userland",
     "litebox_platform_linux_kernel",
     "litebox_platform_linux_userland",
     "litebox_platform_windows_userland",
@@ -28,6 +29,7 @@ default-members = [
     "litebox",
     "litebox_common_linux",
     "litebox_common_optee",
+    "litebox_platform_freebsd_userland",
     "litebox_platform_linux_kernel",
     "litebox_platform_linux_userland",
     "litebox_platform_windows_userland",

dev_tests/src/ratchet.rs

@@ -35,6 +35,7 @@ fn ratchet_globals() -> Result<()> {
         &[
             ("dev_bench/", 1),
             ("litebox/", 9),
+            ("litebox_platform_freebsd_userland/", 7),
             ("litebox_platform_linux_kernel/", 6),
             ("litebox_platform_linux_userland/", 5),
             ("litebox_platform_lvbs/", 23),
@@ -71,6 +72,7 @@ fn ratchet_maybe_uninit() -> Result<()> {
         &[
             ("dev_tests/", 1),
             ("litebox/", 1),
+            ("litebox_platform_freebsd_userland/", 2),
             ("litebox_platform_linux_userland/", 3),
             ("litebox_shim_linux/", 5),
         ],

litebox/src/mm/exception_table.rs

@@ -18,7 +18,7 @@
 
 use crate::utils::TruncateExt as _;
 
-#[cfg(any(target_os = "linux", target_os = "none"))]
+#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "none"))]
 macro_rules! ex_table_section {
     () => {
         // a = allocate, R = retain: don't discard on linking.
@@ -214,7 +214,7 @@ struct ExceptionTableEntry {
 
 /// Returns the exception table, found by linker-defined symbols marking the
 /// start and end of the section.
-#[cfg(any(target_os = "linux", target_os = "none"))]
+#[cfg(any(target_os = "linux", target_os = "freebsd", target_os = "none"))]
 fn exception_table() -> &'static [ExceptionTableEntry] {
     // SAFETY: the linker automatically defines these symbols when the section
     // is non-empty.

litebox_platform_freebsd_userland/Cargo.toml

@@ -0,0 +1,16 @@
+[package]
+name = "litebox_platform_freebsd_userland"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+libc = { version = "0.2.169", default-features = false }
+litebox = { path = "../litebox/", version = "0.1.0" }
+litebox_common_linux = { path = "../litebox_common_linux", version = "0.1.0" }
+thiserror = { version = "2.0.6", default-features = false }
+bitflags = "2.6.0"
+getrandom = "0.3.4"
+zerocopy = { version = "0.8", default-features = false, features = ["derive"] }
+
+[lints]
+workspace = true

litebox_platform_freebsd_userland/README.md

@@ -0,0 +1,3 @@
+# LiteBox Platform: FreeBSD Userland
+
+A [LiteBox platform](../litebox/platform/index.html) for running LiteBox on userland FreeBSD.

litebox_platform_freebsd_userland/scripts/_common.sh

@@ -0,0 +1,50 @@
+#! /bin/sh
+
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+# Script intended to be sourced as a common helper for other scripts.
+
+set -e
+
+SCRIPT_DIR=$( cd "$( dirname "$0" )" && pwd -P )
+
+RED=$(printf '\033[0;31m')
+YELLOW=$(printf '\033[0;33m')
+GREEN=$(printf '\033[0;32m')
+BOLD=$(printf '\033[1m')
+RESET=$(printf '\033[0m')
+
+fatal() {
+    printf "${RED}${BOLD}[!]${RESET} %s\n" "$1" 1>&2
+    exit 1
+}
+
+warn() {
+    printf "${YELLOW}${BOLD}[!]${RESET} %s\n" "$1" 1>&2
+}
+
+info() {
+    printf "${BOLD}[i]${RESET} %s\n" "$1" 1>&2
+}
+info2() {
+    printf "      %s\n" "$1" 1>&2
+}
+
+success() {
+    printf "${GREEN}${BOLD}[+]${RESET} %s\n" "$1" 1>&2
+}
+
+check_for_tools() {
+    missing_tools=0
+    while [ $# -gt 0 ]; do
+        if ! command -v "$1" > /dev/null 2>&1; then
+            warn "Required tool ${BOLD}$1${RESET} not found"
+            missing_tools=1
+        fi
+        shift
+    done
+    if [ "$missing_tools" -ne 0 ]; then
+        fatal "Please install the missing tools and try again"
+    fi
+}

litebox_platform_freebsd_userland/scripts/tun-setup.sh

@@ -0,0 +1,100 @@
+#! /bin/sh
+
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+. "$(dirname "$0")/_common.sh"
+
+# If not root, exit
+if [ "$(id -u)" -ne 0 ]; then
+    fatal "Requires running as root"
+fi
+
+# Parse arguments
+REMOVE_TUN=0
+FORCE_RECREATE=0
+TUN_DEV="tun99"
+TUN_IP="10.0.0.1"
+TUN_REMOTE_IP="10.0.0.2"
+while getopts "hdft:i:r:" opt; do
+    case $opt in
+        h)
+            echo "Usage: $0 [-h] [-d | -f] [-t TUN] [-i IP] [-r REMOTE_IP]" 1>&2
+            echo "  -h  Show this help message" 1>&2
+            echo "  -d  Remove the TUN device" 1>&2
+            echo "  -f  Force re-create the TUN device" 1>&2
+            echo "  -t  TUN device name (default: $TUN_DEV)" 1>&2
+            echo "  -i  TUN local IP address (default: $TUN_IP)" 1>&2
+            echo "  -r  TUN remote (guest) IP address (default: $TUN_REMOTE_IP)" 1>&2
+            exit 0
+            ;;
+        d)
+            REMOVE_TUN=1
+            ;;
+        f)
+            FORCE_RECREATE=1
+            ;;
+        t)
+            TUN_DEV="$OPTARG"
+            ;;
+        i)
+            TUN_IP="$OPTARG"
+            ;;
+        r)
+            TUN_REMOTE_IP="$OPTARG"
+            ;;
+        \?)
+            fatal "Invalid option: -$OPTARG"
+            ;;
+    esac
+done
+if [ $REMOVE_TUN -eq 1 ] && [ $FORCE_RECREATE -eq 1 ]; then
+    fatal "Cannot remove and force re-create at the same time"
+fi
+
+check_for_tools ifconfig
+
+info "Script parameters:"
+info2 "TUN device: ${BOLD}${TUN_DEV}${RESET}"
+if [ $REMOVE_TUN -eq 1 ]; then
+    info2 "Remove TUN device: ${BOLD}yes${RESET}"
+else
+    info2 "TUN local IP: ${BOLD}${TUN_IP}${RESET}"
+    info2 "TUN remote IP: ${BOLD}${TUN_REMOTE_IP}${RESET}"
+fi
+if [ $FORCE_RECREATE -eq 1 ]; then
+    info2 "Force recreate TUN device: ${BOLD}yes${RESET}"
+fi
+
+# Check if the TUN device already exists
+if ifconfig "$TUN_DEV" > /dev/null 2>&1; then
+    info "TUN device already exists"
+    if [ $REMOVE_TUN -eq 1 ] || [ $FORCE_RECREATE -eq 1 ]; then
+        info "Destroying TUN device"
+        ifconfig "$TUN_DEV" destroy
+        success "Removed TUN device"
+        if [ $REMOVE_TUN -eq 1 ]; then
+            exit 0
+        fi
+    else
+        fatal "Use ${BOLD}-d${RESET} to remove the TUN device or ${BOLD}-f${RESET} to force re-create it"
+    fi
+elif [ $REMOVE_TUN -eq 1 ]; then
+    warn "TUN device does not exist"
+    fatal "Nothing to remove"
+fi
+
+info "Creating TUN device"
+ifconfig "$TUN_DEV" create
+
+info "Assigning IP address (point-to-point: $TUN_IP -> $TUN_REMOTE_IP)"
+ifconfig "$TUN_DEV" inet "$TUN_IP" "$TUN_REMOTE_IP" netmask 255.255.255.0
+
+# Allow the current user to open the device node
+CURRENT_USER=$(logname 2>/dev/null || echo "$SUDO_USER")
+if [ -n "$CURRENT_USER" ] && [ -c "/dev/$TUN_DEV" ]; then
+    info "Setting ownership of /dev/$TUN_DEV to $CURRENT_USER"
+    chown "$CURRENT_USER" "/dev/$TUN_DEV"
+fi
+
+success "Created TUN device"