Allow to run tests with the address sanitizer

Co-authored-by: Dmitrii Dolgov <9erthalion6@gmail.com>

Author: JoukoVirtanen

Cargo.toml

@@ -31,3 +31,7 @@ pest_derive = "2.8.1"
 llvm-sys = "201.0.1"
 docopt = "1.1.1"
 signal-hook = "0.3.18"
+
+[features]
+default = []
+nightly = []

Containerfile

@@ -1,10 +1,8 @@
 FROM registry.fedoraproject.org/fedora:43 as builder
 
+ARG RUST_VERSION=stable
+
 RUN dnf install -y \
-    rust \
-    cargo \
-    clippy \
-    rustfmt \
     # for stub \
     nasm \
     # for script jit \
@@ -15,7 +13,19 @@ RUN dnf install -y \
     # for bpf \
     clang \
     kernel-devel \
-    libbpf-devel
+    libbpf-devel && \
+    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | \
+        sh -s -- -y --default-toolchain $RUST_VERSION --profile minimal
+
+# $HOME is not evaluated here, any better way of getting the toolchain
+# directory?
+ENV PATH="${PATH}:/root/.cargo/bin"
+
+RUN rustup component add rustfmt clippy
+
+RUN if [ "${RUST_VERSION}" == "nightly" ]; then \
+    rustup component add rust-src --toolchain nightly; \
+    fi
 
 ADD ./ /berserker/
 
@@ -32,7 +42,12 @@ RUN cargo build -r
 # Test will require stub binary to be available
 ENV PATH="${PATH}:/berserker:/berserker/target/release"
 
-RUN cargo test
+RUN if [ "${RUST_VERSION}" == "nightly" ]; then \
+        TARGET=$(rustc --version --verbose | grep host | cut -d" " -f2) && \
+        RUSTFLAGS="-Z sanitizer=address" cargo +nightly test -Z build-std --target "$TARGET"; \
+    else \
+        cargo test; \
+    fi
 
 FROM registry.fedoraproject.org/fedora:43
 

Makefile

@@ -7,6 +7,7 @@ endif
 .PHONY: all
 all:
 	docker build -t berserker -f Containerfile .
+	docker build -t berserker -f Containerfile --build-arg=RUST_VERSION=nightly .
 	docker build -t berserker-test -f Containerfile.test .
 	docker run --privileged berserker-test
 

src/lib.rs

@@ -1,3 +1,5 @@
+#![cfg_attr(feature = "nightly", feature(sanitize))]
+
 use core_affinity::CoreId;
 use serde::{Deserialize, Deserializer};
 use std::{collections::HashMap, fmt::Display, net::Ipv4Addr, str::FromStr};
@@ -28,7 +30,8 @@ pub struct WorkloadConfig {
     /// Custom workload configuration.
     pub workload: Workload,
 
-    /// For how long to run the worker. Default value is zero, meaning no limit.
+    /// For how long to run the worker. Default value is zero, meaning no
+    /// limit.
     #[serde(default = "default_duration")]
     pub duration: u64,
 }
@@ -194,8 +197,8 @@ pub enum Workload {
         /// Maximum number of dynamic connections
         connections_dyn_max: u32,
 
-        // How many connections to make to the same server address and port with
-        // different client ports
+        /// How many connections to make to the same server address and port
+        /// with different client ports
         #[serde(default = "default_conns_per_addr")]
         conns_per_addr: u16,
 
@@ -211,7 +214,8 @@ pub enum Workload {
         /// Whether or not to wait for a connection to be removed before adding
         /// a new one, when the dynamic connection limit is reached.
         /// if true: an old connection will be forcibly removed
-        /// if false: wait for a connection to naturally age-off before adding a new one
+        /// if false: wait for a connection to naturally age-off before adding
+        /// a new one
         preempt: bool,
     },
 

src/main.rs

@@ -204,7 +204,8 @@ fn main() {
                         .required(false),
                 )
                 // Add in settings from the environment (with a prefix of APP)
-                // Eg.. `BERSERKER__WORKLOAD__ARRIVAL_RATE=1` would set the `arrival_rate` key
+                // Eg.. `BERSERKER__WORKLOAD__ARRIVAL_RATE=1` would set the
+                // `arrival_rate` key
                 .add_source(
                     config::Environment::with_prefix("BERSERKER")
                         .try_parsing(true)
@@ -230,7 +231,8 @@ fn main() {
                 let elapsed = duration_timer.elapsed().unwrap().as_secs();
 
                 // Ignore processes without specified duration -- we don't want
-                // neither terminate them, nor count against processes to compare.
+                // neither terminate them, nor count against processes to
+                // compare.
                 let watched_processes = processes
                     .iter()
                     .filter(|(_, duration)| *duration > 0)

src/worker/script.rs

@@ -210,10 +210,13 @@ pub static RUNTIME: LazyLock<HashMap<String, RuntimeFunc>> =
     });
 
 impl ScriptWorker {
-    fn jit_instruction(name: String, arg: Arg, ctx: &BuildContext) {
+    fn jit_instruction(name: &CStr, arg: Arg, ctx: &BuildContext) {
         let mut arg_ptr = Self::get_arg_value(arg, ctx);
 
-        let (func, func_type) = ctx.module_runtime.get(&name).unwrap();
+        let (func, func_type) = ctx
+            .module_runtime
+            .get(name.to_str().expect("Couldn't convert name to string"))
+            .unwrap();
 
         unsafe {
             LLVMBuildCall2(
@@ -222,7 +225,7 @@ impl ScriptWorker {
                 *func,
                 &mut arg_ptr,
                 1,
-                name.as_str().as_ptr() as *const _,
+                name.as_ptr() as *const _,
             );
         }
     }
@@ -320,7 +323,8 @@ impl ScriptWorker {
                     &mut err,
                 ) != 0
                 {
-                    // In case of error, we must avoid using the uninitialized ExecutionEngineRef.
+                    // In case of error, we must avoid using the uninitialized
+                    // ExecutionEngineRef.
                     assert!(!err.is_null());
                     panic!(
                         "Failed to create execution engine: {:?}",
@@ -385,8 +389,8 @@ impl ScriptWorker {
                 function_type,
             );
 
-            // Create a basic block in the function and set our builder to generate
-            // code in it.
+            // Create a basic block in the function and set our builder to
+            // generate code in it.
             let bb = LLVMAppendBasicBlockInContext(
                 context,
                 function,
@@ -425,30 +429,22 @@ impl ScriptWorker {
                 // JIT the instruction and collect it's name
                 let name = match instr.clone() {
                     Instruction::Task { name, args: _ } => {
-                        Self::jit_instruction(String::from("task"), name, &ctx);
+                        Self::jit_instruction(c"task", name, &ctx);
                         "task"
                     }
 
                     Instruction::Open { path } => {
-                        Self::jit_instruction(String::from("open"), path, &ctx);
+                        Self::jit_instruction(c"open", path, &ctx);
                         "open"
                     }
 
                     Instruction::Ping { server } => {
-                        Self::jit_instruction(
-                            String::from("ping"),
-                            server,
-                            &ctx,
-                        );
+                        Self::jit_instruction(c"ping", server, &ctx);
                         "ping"
                     }
 
                     Instruction::Debug { text } => {
-                        Self::jit_instruction(
-                            String::from("debug"),
-                            text,
-                            &ctx,
-                        );
+                        Self::jit_instruction(c"debug", text, &ctx);
                         "debug"
                     }
                 };

src/worker/syscalls/ioctl.rs

@@ -14,8 +14,8 @@ pub struct IoctlCall {
 
 impl IoctlCall {
     pub fn new(_: &ArgsMap) -> Self {
-        // Zero initialize all fields, fd will be initialized in `Syscaller::init`.
-        // All other fields can be overridden as needed
+        // Zero initialize all fields, fd will be initialized in
+        // `Syscaller::init`. All other fields can be overridden as needed
         Default::default()
     }
 }