core/irrt: introduce irrt testing

`cargo test -F test` would compile `nac3core/irrt/irrt_test.cpp`
targetted to the host machine (it gets to use `std`) and run the
test executable.

.clang-format

@@ -0,0 +1,3 @@
+BasedOnStyle: Google
+IndentWidth: 4
+ReflowComments: false

flake.nix

@@ -13,6 +13,7 @@
           ''
           mkdir -p $out/bin
           ln -s ${pkgs.llvmPackages_14.clang-unwrapped}/bin/clang $out/bin/clang-irrt
+          ln -s ${pkgs.llvmPackages_14.clang}/bin/clang $out/bin/clang-irrt-test
           ln -s ${pkgs.llvmPackages_14.llvm.out}/bin/llvm-as $out/bin/llvm-as-irrt
           '';
         nac3artiq = pkgs.python3Packages.toPythonModule (
@@ -23,6 +24,7 @@
             cargoLock = {
               lockFile = ./Cargo.lock;
             };
+            cargoTestFlags = [ "--features" "test" ];
             passthru.cargoLock = cargoLock;
             nativeBuildInputs = [ pkgs.python3 (pkgs.wrapClangMulti pkgs.llvmPackages_14.clang) llvm-tools-irrt pkgs.llvmPackages_14.llvm.out llvm-nac3 ];
             buildInputs = [ pkgs.python3 llvm-nac3 ];

nac3core/Cargo.toml

@@ -1,3 +1,6 @@
+[features]
+test = []
+
 [package]
 name = "nac3core"
 version = "0.1.0"

nac3core/build.rs

@@ -3,20 +3,34 @@ use std::{
     env,
     fs::File,
     io::Write,
-    path::Path,
+    path::{Path, PathBuf},
     process::{Command, Stdio},
 };
 
-fn main() {
-    const FILE: &str = "src/codegen/irrt/irrt.cpp";
+const CMD_IRRT_CLANG: &str = "clang-irrt";
+const CMD_IRRT_CLANG_TEST: &str = "clang-irrt-test";
+const CMD_IRRT_LLVM_AS: &str = "llvm-as-irrt";
+
+fn get_out_dir() -> PathBuf {
+    PathBuf::from(env::var("OUT_DIR").unwrap())
+}
+
+fn get_irrt_dir() -> &'static Path {
+    Path::new("irrt")
+}
+
+/// Compile `irrt.cpp` for use in `src/codegen`
+fn compile_irrt_cpp() {
+    let out_dir = get_out_dir();
+    let irrt_dir = get_irrt_dir();
 
     /*
      * HACK: Sadly, clang doesn't let us emit generic LLVM bitcode.
      * Compiling for WASM32 and filtering the output with regex is the closest we can get.
      */
+    let irrt_cpp_path = irrt_dir.join("irrt.cpp");
     let flags: &[&str] = &[
         "--target=wasm32",
-        FILE,
         "-x",
         "c++",
         "-fno-discard-value-names",
@@ -33,13 +47,16 @@ fn main() {
         "-Wextra",
         "-o",
         "-",
+        "-I",
+        irrt_dir.to_str().unwrap(),
+        irrt_cpp_path.to_str().unwrap(),
     ];
 
-    println!("cargo:rerun-if-changed={FILE}");
-    let out_dir = env::var("OUT_DIR").unwrap();
-    let out_path = Path::new(&out_dir);
+    // Tell Cargo to rerun if any file under `irrt_dir` (recursive) changes
+    println!("cargo:rerun-if-changed={}", irrt_dir.to_str().unwrap());
 
-    let output = Command::new("clang-irrt")
+    // Compile IRRT and capture the LLVM IR output
+    let output = Command::new(CMD_IRRT_CLANG)
         .args(flags)
         .output()
         .map(|o| {
@@ -52,7 +69,17 @@ fn main() {
     let output = std::str::from_utf8(&output.stdout).unwrap().replace("\r\n", "\n");
     let mut filtered_output = String::with_capacity(output.len());
 
-    let regex_filter = Regex::new(r"(?ms:^define.*?\}$)|(?m:^declare.*?$)").unwrap();
+    // Filter out irrelevant IR
+    //
+    // Regex:
+    // - `(?ms:^define.*?\}$)` captures LLVM `define` blocks
+    // - `(?m:^declare.*?$)` captures LLVM `declare` lines
+    // - `(?m:^%.+?=\s*type\s*\{.+?\}$)` captures LLVM `type` declarations
+    // - `(?m:^@.+?=.+$)` captures global constants
+    let regex_filter = Regex::new(
+        r"(?ms:^define.*?\}$)|(?m:^declare.*?$)|(?m:^%.+?=\s*type\s*\{.+?\}$)|(?m:^@.+?=.+$)",
+    )
+    .unwrap();
     for f in regex_filter.captures_iter(&output) {
         assert_eq!(f.len(), 1);
         filtered_output.push_str(&f[0]);
@@ -63,20 +90,71 @@ fn main() {
         .unwrap()
         .replace_all(&filtered_output, "");
 
-    println!("cargo:rerun-if-env-changed=DEBUG_DUMP_IRRT");
-    if env::var("DEBUG_DUMP_IRRT").is_ok() {
-        let mut file = File::create(out_path.join("irrt.ll")).unwrap();
+    // For debugging
+    // Doing `DEBUG_DUMP_IRRT=1 cargo build -p nac3core` dumps the LLVM IR generated
+    const DEBUG_DUMP_IRRT: &str = "DEBUG_DUMP_IRRT";
+    println!("cargo:rerun-if-env-changed={DEBUG_DUMP_IRRT}");
+    if env::var(DEBUG_DUMP_IRRT).is_ok() {
+        let mut file = File::create(out_dir.join("irrt.ll")).unwrap();
         file.write_all(output.as_bytes()).unwrap();
-        let mut file = File::create(out_path.join("irrt-filtered.ll")).unwrap();
+
+        let mut file = File::create(out_dir.join("irrt-filtered.ll")).unwrap();
         file.write_all(filtered_output.as_bytes()).unwrap();
     }
 
-    let mut llvm_as = Command::new("llvm-as-irrt")
+    // Assemble the emitted and filtered IR to .bc
+    // That .bc will be integrated into nac3core's codegen
+    let mut llvm_as = Command::new(CMD_IRRT_LLVM_AS)
         .stdin(Stdio::piped())
         .arg("-o")
-        .arg(out_path.join("irrt.bc"))
+        .arg(out_dir.join("irrt.bc"))
         .spawn()
         .unwrap();
     llvm_as.stdin.as_mut().unwrap().write_all(filtered_output.as_bytes()).unwrap();
     assert!(llvm_as.wait().unwrap().success());
 }
+
+/// Compile `irrt_test.cpp` for testing
+fn compile_irrt_test_cpp() {
+    let out_dir = get_out_dir();
+    let irrt_dir = get_irrt_dir();
+
+    let exe_path = out_dir.join("irrt_test.out"); // Output path of the compiled test executable
+    let irrt_test_cpp_path = irrt_dir.join("irrt_test.cpp");
+    let flags: &[&str] = &[
+        irrt_test_cpp_path.to_str().unwrap(),
+        "-x",
+        "c++",
+        "-I",
+        irrt_dir.to_str().unwrap(),
+        "-g",
+        "-fno-discard-value-names",
+        "-O0",
+        "-Wall",
+        "-Wextra",
+        "-Werror=return-type",
+        "-lm", // for `tgamma()`, `lgamma()`
+        "-o",
+        exe_path.to_str().unwrap(),
+    ];
+
+    Command::new(CMD_IRRT_CLANG_TEST)
+        .args(flags)
+        .output()
+        .map(|o| {
+            assert!(o.status.success(), "{}", std::str::from_utf8(&o.stderr).unwrap());
+            o
+        })
+        .unwrap();
+    println!("cargo:rerun-if-changed={}", irrt_dir.to_str().unwrap());
+}
+
+fn main() {
+    compile_irrt_cpp();
+
+    // https://github.com/rust-lang/cargo/issues/2549
+    // `cargo test -F test` to also build `irrt_test.cpp
+    if cfg!(feature = "test") {
+        compile_irrt_test_cpp();
+    }
+}

nac3core/irrt/irrt.cpp

@@ -0,0 +1,10 @@
+#define IRRT_DEFINE_TYPEDEF_INTS
+#include <irrt_everything.hpp>
+
+/*
+ * All IRRT implementations.
+ *
+ * We don't have pre-compiled objects, so we are writing all implementations in
+ * headers and concatenate them with `#include` into one massive source file that
+ * contains all the IRRT stuff.
+ */

nac3core/irrt/irrt/core.hpp

@@ -1,27 +1,17 @@
-using int8_t = _BitInt(8);
-using uint8_t = unsigned _BitInt(8);
-using int32_t = _BitInt(32);
-using uint32_t = unsigned _BitInt(32);
-using int64_t = _BitInt(64);
-using uint64_t = unsigned _BitInt(64);
+#pragma once
+
+#include <irrt/int_defs.hpp>
+#include <irrt/utils.hpp>
 
 // NDArray indices are always `uint32_t`.
 using NDIndex = uint32_t;
-// The type of an index or a value describing the length of a range/slice is always `int32_t`.
+// The type of an index or a value describing the length of a
+// range/slice is always `int32_t`.
 using SliceIndex = int32_t;
 
 namespace {
-template <typename T>
-const T& max(const T& a, const T& b) {
-    return a > b ? a : b;
-}
-
-template <typename T>
-const T& min(const T& a, const T& b) {
-    return a > b ? b : a;
-}
-
-// adapted from GNU Scientific Library: https://git.savannah.gnu.org/cgit/gsl.git/tree/sys/pow_int.c
+// adapted from GNU Scientific Library:
+// https://git.savannah.gnu.org/cgit/gsl.git/tree/sys/pow_int.c
 // need to make sure `exp >= 0` before calling this function
 template <typename T>
 T __nac3_int_exp_impl(T base, T exp) {
@@ -38,12 +28,8 @@ T __nac3_int_exp_impl(T base, T exp) {
 }
 
 template <typename SizeT>
-SizeT __nac3_ndarray_calc_size_impl(
-    const SizeT* list_data,
-    SizeT list_len,
-    SizeT begin_idx,
-    SizeT end_idx
-) {
+SizeT __nac3_ndarray_calc_size_impl(const SizeT* list_data, SizeT list_len,
+                                    SizeT begin_idx, SizeT end_idx) {
     __builtin_assume(end_idx <= list_len);
 
     SizeT num_elems = 1;
@@ -56,12 +42,8 @@ SizeT __nac3_ndarray_calc_size_impl(
 }
 
 template <typename SizeT>
-void __nac3_ndarray_calc_nd_indices_impl(
-    SizeT index,
-    const SizeT* dims,
-    SizeT num_dims,
-    NDIndex* idxs
-) {
+void __nac3_ndarray_calc_nd_indices_impl(SizeT index, const SizeT* dims,
+                                         SizeT num_dims, NDIndex* idxs) {
     SizeT stride = 1;
     for (SizeT dim = 0; dim < num_dims; dim++) {
         SizeT i = num_dims - dim - 1;
@@ -72,12 +54,9 @@ void __nac3_ndarray_calc_nd_indices_impl(
 }
 
 template <typename SizeT>
-SizeT __nac3_ndarray_flatten_index_impl(
-    const SizeT* dims,
-    SizeT num_dims,
-    const NDIndex* indices,
-    SizeT num_indices
-) {
+SizeT __nac3_ndarray_flatten_index_impl(const SizeT* dims, SizeT num_dims,
+                                        const NDIndex* indices,
+                                        SizeT num_indices) {
     SizeT idx = 0;
     SizeT stride = 1;
     for (SizeT i = 0; i < num_dims; ++i) {
@@ -93,18 +72,17 @@ SizeT __nac3_ndarray_flatten_index_impl(
 }
 
 template <typename SizeT>
-void __nac3_ndarray_calc_broadcast_impl(
-    const SizeT* lhs_dims,
-    SizeT lhs_ndims,
-    const SizeT* rhs_dims,
-    SizeT rhs_ndims,
-    SizeT* out_dims
-) {
+void __nac3_ndarray_calc_broadcast_impl(const SizeT* lhs_dims, SizeT lhs_ndims,
+                                        const SizeT* rhs_dims, SizeT rhs_ndims,
+                                        SizeT* out_dims) {
     SizeT max_ndims = lhs_ndims > rhs_ndims ? lhs_ndims : rhs_ndims;
 
     for (SizeT i = 0; i < max_ndims; ++i) {
-        const SizeT* lhs_dim_sz = i < lhs_ndims ? &lhs_dims[lhs_ndims - i - 1] : nullptr;
-        const SizeT* rhs_dim_sz = i < rhs_ndims ? &rhs_dims[rhs_ndims - i - 1] : nullptr;
+        const SizeT* lhs_dim_sz =
+            i < lhs_ndims ? &lhs_dims[lhs_ndims - i - 1] : nullptr;
+        const SizeT* rhs_dim_sz =
+            i < rhs_ndims ? &rhs_dims[rhs_ndims - i - 1] : nullptr;
+
         SizeT* out_dim = &out_dims[max_ndims - i - 1];
 
         if (lhs_dim_sz == nullptr) {
@@ -124,12 +102,10 @@ void __nac3_ndarray_calc_broadcast_impl(
 }
 
 template <typename SizeT>
-void __nac3_ndarray_calc_broadcast_idx_impl(
-    const SizeT* src_dims,
-    SizeT src_ndims,
-    const NDIndex* in_idx,
-    NDIndex* out_idx
-) {
+void __nac3_ndarray_calc_broadcast_idx_impl(const SizeT* src_dims,
+                                            SizeT src_ndims,
+                                            const NDIndex* in_idx,
+                                            NDIndex* out_idx) {
     for (SizeT i = 0; i < src_ndims; ++i) {
         SizeT src_i = src_ndims - i - 1;
         out_idx[src_i] = src_dims[src_i] == 1 ? 0 : in_idx[src_i];
@@ -138,15 +114,15 @@ void __nac3_ndarray_calc_broadcast_idx_impl(
 }  // namespace
 
 extern "C" {
-#define DEF_nac3_int_exp_(T) \
-    T __nac3_int_exp_##T(T base, T exp) {\
-        return __nac3_int_exp_impl(base, exp);\
+#define DEF_nac3_int_exp_(T)                   \
+    T __nac3_int_exp_##T(T base, T exp) {      \
+        return __nac3_int_exp_impl(base, exp); \
     }
 
-DEF_nac3_int_exp_(int32_t)
-DEF_nac3_int_exp_(int64_t)
-DEF_nac3_int_exp_(uint32_t)
-DEF_nac3_int_exp_(uint64_t)
+DEF_nac3_int_exp_(int32_t);
+DEF_nac3_int_exp_(int64_t);
+DEF_nac3_int_exp_(uint32_t);
+DEF_nac3_int_exp_(uint64_t);
 
 SliceIndex __nac3_slice_index_bound(SliceIndex i, const SliceIndex len) {
     if (i < 0) {
@@ -160,11 +136,8 @@ SliceIndex __nac3_slice_index_bound(SliceIndex i, const SliceIndex len) {
     return i;
 }
 
-SliceIndex __nac3_range_slice_len(
-    const SliceIndex start,
-    const SliceIndex end,
-    const SliceIndex step
-) {
+SliceIndex __nac3_range_slice_len(const SliceIndex start, const SliceIndex end,
+                                  const SliceIndex step) {
     SliceIndex diff = end - start;
     if (diff > 0 && step > 0) {
         return ((diff - 1) / step) + 1;
@@ -180,62 +153,52 @@ SliceIndex __nac3_range_slice_len(
 // - All the index must *not* be out-of-bound or negative,
 // - The end index is *inclusive*,
 // - The length of src and dest slice size should already
-// be checked: if dest.step == 1 then len(src) <= len(dest) else len(src) == len(dest)
+// be checked: if dest.step == 1 then len(src) <= len(dest) else
+// len(src) == len(dest)
 SliceIndex __nac3_list_slice_assign_var_size(
-    SliceIndex dest_start,
-    SliceIndex dest_end,
-    SliceIndex dest_step,
-    uint8_t* dest_arr,
-    SliceIndex dest_arr_len,
-    SliceIndex src_start,
-    SliceIndex src_end,
-    SliceIndex src_step,
-    uint8_t* src_arr,
-    SliceIndex src_arr_len,
-    const SliceIndex size
-) {
-    /* if dest_arr_len == 0, do nothing since we do not support extending list */
+    SliceIndex dest_start, SliceIndex dest_end, SliceIndex dest_step,
+    uint8_t* dest_arr, SliceIndex dest_arr_len, SliceIndex src_start,
+    SliceIndex src_end, SliceIndex src_step, uint8_t* src_arr,
+    SliceIndex src_arr_len, const SliceIndex size) {
+    /* if dest_arr_len == 0, do nothing since we do not support
+     * extending list
+     */
     if (dest_arr_len == 0) return dest_arr_len;
-    /* if both step is 1, memmove directly, handle the dropping of the list, and shrink size */
+    /* if both step is 1, memmove directly, handle the dropping of
+     * the list, and shrink size */
     if (src_step == dest_step && dest_step == 1) {
-        const SliceIndex src_len = (src_end >= src_start) ? (src_end - src_start + 1) : 0;
-        const SliceIndex dest_len = (dest_end >= dest_start) ? (dest_end - dest_start + 1) : 0;
+        const SliceIndex src_len =
+            (src_end >= src_start) ? (src_end - src_start + 1) : 0;
+        const SliceIndex dest_len =
+            (dest_end >= dest_start) ? (dest_end - dest_start + 1) : 0;
         if (src_len > 0) {
-            __builtin_memmove(
-                dest_arr + dest_start * size,
-                src_arr + src_start * size,
-                src_len * size
-            );
+            __builtin_memmove(dest_arr + dest_start * size,
+                              src_arr + src_start * size, src_len * size);
         }
         if (dest_len > 0) {
             /* dropping */
-            __builtin_memmove(
-                dest_arr + (dest_start + src_len) * size,
-                dest_arr + (dest_end + 1) * size,
-                (dest_arr_len - dest_end - 1) * size
-            );
+            __builtin_memmove(dest_arr + (dest_start + src_len) * size,
+                              dest_arr + (dest_end + 1) * size,
+                              (dest_arr_len - dest_end - 1) * size);
         }
         /* shrink size */
         return dest_arr_len - (dest_len - src_len);
     }
     /* if two range overlaps, need alloca */
     uint8_t need_alloca =
-        (dest_arr == src_arr)
-        && !(
-            max(dest_start, dest_end) < min(src_start, src_end)
-            || max(src_start, src_end) < min(dest_start, dest_end)
-        );
+        (dest_arr == src_arr) &&
+        !(max(dest_start, dest_end) < min(src_start, src_end) ||
+          max(src_start, src_end) < min(dest_start, dest_end));
     if (need_alloca) {
-        uint8_t* tmp = reinterpret_cast<uint8_t *>(__builtin_alloca(src_arr_len * size));
+        uint8_t* tmp =
+            reinterpret_cast<uint8_t*>(__builtin_alloca(src_arr_len * size));
         __builtin_memcpy(tmp, src_arr, src_arr_len * size);
         src_arr = tmp;
     }
     SliceIndex src_ind = src_start;
     SliceIndex dest_ind = dest_start;
-    for (;
-        (src_step > 0) ? (src_ind <= src_end) : (src_ind >= src_end);
-        src_ind += src_step, dest_ind += dest_step
-    ) {
+    for (; (src_step > 0) ? (src_ind <= src_end) : (src_ind >= src_end);
+         src_ind += src_step, dest_ind += dest_step) {
         /* for constant optimization */
         if (size == 1) {
             __builtin_memcpy(dest_arr + dest_ind, src_arr + src_ind, 1);
@@ -244,30 +207,26 @@ SliceIndex __nac3_list_slice_assign_var_size(
         } else if (size == 8) {
             __builtin_memcpy(dest_arr + dest_ind * 8, src_arr + src_ind * 8, 8);
         } else {
-            /* memcpy for var size, cannot overlap after previous alloca */
-            __builtin_memcpy(dest_arr + dest_ind * size, src_arr + src_ind * size, size);
+            /* memcpy for var size, cannot overlap after previous
+             * alloca */
+            __builtin_memcpy(dest_arr + dest_ind * size,
+                             src_arr + src_ind * size, size);
         }
     }
     /* only dest_step == 1 can we shrink the dest list. */
     /* size should be ensured prior to calling this function */
     if (dest_step == 1 && dest_end >= dest_start) {
         __builtin_memmove(
-            dest_arr + dest_ind * size,
-            dest_arr + (dest_end + 1) * size,
-            (dest_arr_len - dest_end - 1) * size
-        );
+            dest_arr + dest_ind * size, dest_arr + (dest_end + 1) * size,
+            (dest_arr_len - dest_end - 1) * size + size + size + size);
         return dest_arr_len - (dest_end - dest_ind) - 1;
     }
     return dest_arr_len;
 }
 
-int32_t __nac3_isinf(double x) {
-    return __builtin_isinf(x);
-}
+int32_t __nac3_isinf(double x) { return __builtin_isinf(x); }
 
-int32_t __nac3_isnan(double x) {
-    return __builtin_isnan(x);
-}
+int32_t __nac3_isnan(double x) { return __builtin_isnan(x); }
 
 double tgamma(double arg);
 
@@ -320,95 +279,71 @@ double __nac3_j0(double x) {
     return j0(x);
 }
 
-uint32_t __nac3_ndarray_calc_size(
-    const uint32_t* list_data,
-    uint32_t list_len,
-    uint32_t begin_idx,
-    uint32_t end_idx
-) {
-    return __nac3_ndarray_calc_size_impl(list_data, list_len, begin_idx, end_idx);
+uint32_t __nac3_ndarray_calc_size(const uint32_t* list_data, uint32_t list_len,
+                                  uint32_t begin_idx, uint32_t end_idx) {
+    return __nac3_ndarray_calc_size_impl(list_data, list_len, begin_idx,
+                                         end_idx);
 }
 
-uint64_t __nac3_ndarray_calc_size64(
-    const uint64_t* list_data,
-    uint64_t list_len,
-    uint64_t begin_idx,
-    uint64_t end_idx
-) {
-    return __nac3_ndarray_calc_size_impl(list_data, list_len, begin_idx, end_idx);
+uint64_t __nac3_ndarray_calc_size64(const uint64_t* list_data,
+                                    uint64_t list_len, uint64_t begin_idx,
+                                    uint64_t end_idx) {
+    return __nac3_ndarray_calc_size_impl(list_data, list_len, begin_idx,
+                                         end_idx);
 }
 
-void __nac3_ndarray_calc_nd_indices(
-    uint32_t index,
-    const uint32_t* dims,
-    uint32_t num_dims,
-    NDIndex* idxs
-) {
+void __nac3_ndarray_calc_nd_indices(uint32_t index, const uint32_t* dims,
+                                    uint32_t num_dims, NDIndex* idxs) {
     __nac3_ndarray_calc_nd_indices_impl(index, dims, num_dims, idxs);
 }
 
-void __nac3_ndarray_calc_nd_indices64(
-    uint64_t index,
-    const uint64_t* dims,
-    uint64_t num_dims,
-    NDIndex* idxs
-) {
+void __nac3_ndarray_calc_nd_indices64(uint64_t index, const uint64_t* dims,
+                                      uint64_t num_dims, NDIndex* idxs) {
     __nac3_ndarray_calc_nd_indices_impl(index, dims, num_dims, idxs);
 }
 
-uint32_t __nac3_ndarray_flatten_index(
-    const uint32_t* dims,
-    uint32_t num_dims,
-    const NDIndex* indices,
-    uint32_t num_indices
-) {
-    return __nac3_ndarray_flatten_index_impl(dims, num_dims, indices, num_indices);
+uint32_t __nac3_ndarray_flatten_index(const uint32_t* dims, uint32_t num_dims,
+                                      const NDIndex* indices,
+                                      uint32_t num_indices) {
+    return __nac3_ndarray_flatten_index_impl(dims, num_dims, indices,
+                                             num_indices);
 }
 
-uint64_t __nac3_ndarray_flatten_index64(
-    const uint64_t* dims,
-    uint64_t num_dims,
-    const NDIndex* indices,
-    uint64_t num_indices
-) {
-    return __nac3_ndarray_flatten_index_impl(dims, num_dims, indices, num_indices);
+uint64_t __nac3_ndarray_flatten_index64(const uint64_t* dims, uint64_t num_dims,
+                                        const NDIndex* indices,
+                                        uint64_t num_indices) {
+    return __nac3_ndarray_flatten_index_impl(dims, num_dims, indices,
+                                             num_indices);
 }
 
-void __nac3_ndarray_calc_broadcast(
-    const uint32_t* lhs_dims,
-    uint32_t lhs_ndims,
-    const uint32_t* rhs_dims,
-    uint32_t rhs_ndims,
-    uint32_t* out_dims
-) {
-    return __nac3_ndarray_calc_broadcast_impl(lhs_dims, lhs_ndims, rhs_dims, rhs_ndims, out_dims);
+void __nac3_ndarray_calc_broadcast(const uint32_t* lhs_dims, uint32_t lhs_ndims,
+                                   const uint32_t* rhs_dims, uint32_t rhs_ndims,
+                                   uint32_t* out_dims) {
+    return __nac3_ndarray_calc_broadcast_impl(lhs_dims, lhs_ndims, rhs_dims,
+                                              rhs_ndims, out_dims);
 }
 
-void __nac3_ndarray_calc_broadcast64(
-    const uint64_t* lhs_dims,
-    uint64_t lhs_ndims,
-    const uint64_t* rhs_dims,
-    uint64_t rhs_ndims,
-    uint64_t* out_dims
-) {
-    return __nac3_ndarray_calc_broadcast_impl(lhs_dims, lhs_ndims, rhs_dims, rhs_ndims, out_dims);
+void __nac3_ndarray_calc_broadcast64(const uint64_t* lhs_dims,
+                                     uint64_t lhs_ndims,
+                                     const uint64_t* rhs_dims,
+                                     uint64_t rhs_ndims, uint64_t* out_dims) {
+    return __nac3_ndarray_calc_broadcast_impl(lhs_dims, lhs_ndims, rhs_dims,
+                                              rhs_ndims, out_dims);
 }
 
-void __nac3_ndarray_calc_broadcast_idx(
-    const uint32_t* src_dims,
-    uint32_t src_ndims,
-    const NDIndex* in_idx,
-    NDIndex* out_idx
-) {
-    __nac3_ndarray_calc_broadcast_idx_impl(src_dims, src_ndims, in_idx, out_idx);
+void __nac3_ndarray_calc_broadcast_idx(const uint32_t* src_dims,
+                                       uint32_t src_ndims,
+                                       const NDIndex* in_idx,
+                                       NDIndex* out_idx) {
+    __nac3_ndarray_calc_broadcast_idx_impl(src_dims, src_ndims, in_idx,
+                                           out_idx);
 }
 
-void __nac3_ndarray_calc_broadcast_idx64(
-    const uint64_t* src_dims,
-    uint64_t src_ndims,
-    const NDIndex* in_idx,
-    NDIndex* out_idx
-) {
-    __nac3_ndarray_calc_broadcast_idx_impl(src_dims, src_ndims, in_idx, out_idx);
+void __nac3_ndarray_calc_broadcast_idx64(const uint64_t* src_dims,
+                                         uint64_t src_ndims,
+                                         const NDIndex* in_idx,
+                                         NDIndex* out_idx) {
+    __nac3_ndarray_calc_broadcast_idx_impl(src_dims, src_ndims, in_idx,
+                                           out_idx);
 }
 }  // extern "C"

nac3core/irrt/irrt/int_defs.hpp

@@ -0,0 +1,12 @@
+#pragma once
+
+// This is made toggleable since `irrt_test.cpp` itself would include
+// headers that define these typedefs
+#ifdef IRRT_DEFINE_TYPEDEF_INTS
+using int8_t = _BitInt(8);
+using uint8_t = unsigned _BitInt(8);
+using int32_t = _BitInt(32);
+using uint32_t = unsigned _BitInt(32);
+using int64_t = _BitInt(64);
+using uint64_t = unsigned _BitInt(64);
+#endif

nac3core/irrt/irrt/utils.hpp

@@ -0,0 +1,21 @@
+#pragma once
+
+namespace {
+template <typename T>
+const T& max(const T& a, const T& b) {
+    return a > b ? a : b;
+}
+
+template <typename T>
+const T& min(const T& a, const T& b) {
+    return a > b ? b : a;
+}
+
+template <typename T>
+bool arrays_match(int len, T* as, T* bs) {
+    for (int i = 0; i < len; i++) {
+        if (as[i] != bs[i]) return false;
+    }
+    return true;
+}
+}  // namespace

nac3core/irrt/irrt_everything.hpp

@@ -0,0 +1,5 @@
+#pragma once
+
+#include <irrt/core.hpp>
+#include <irrt/int_defs.hpp>
+#include <irrt/utils.hpp>

nac3core/irrt/irrt_test.cpp

@@ -0,0 +1,12 @@
+// This file will be compiled like a real C++ program,
+// and we do have the luxury to use the standard libraries.
+// That is if the nix flakes do not have issues... especially on msys2...
+#include <cstdint>
+#include <cstdio>
+#include <cstdlib>
+#include <test/test_core.hpp>
+
+int main() {
+    test::core::run();
+    return 0;
+}

nac3core/irrt/test/includes.hpp

@@ -0,0 +1,11 @@
+#pragma once
+
+#include <cstdint>
+#include <cstdio>
+#include <cstdlib>
+#include <irrt_everything.hpp>
+#include <test/util.hpp>
+
+/*
+    Include this header for every test_*.cpp
+*/

nac3core/irrt/test/test_core.hpp

@@ -0,0 +1,16 @@
+#pragma once
+
+#include <test/includes.hpp>
+
+namespace test {
+namespace core {
+void test_int_exp() {
+    BEGIN_TEST();
+
+    assert_values_match(125, __nac3_int_exp_impl<int32_t>(5, 3));
+    assert_values_match(3125, __nac3_int_exp_impl<int32_t>(5, 5));
+}
+
+void run() { test_int_exp(); }
+}  // namespace core
+}  // namespace test

nac3core/irrt/test/util.hpp

@@ -0,0 +1,116 @@
+#pragma once
+
+#include <cstdio>
+#include <cstdlib>
+
+template <class T>
+void print_value(const T& value);
+
+template <>
+void print_value(const int8_t& value) {
+    printf("%d", value);
+}
+
+template <>
+void print_value(const int32_t& value) {
+    printf("%d", value);
+}
+
+template <>
+void print_value(const uint8_t& value) {
+    printf("%u", value);
+}
+
+template <>
+void print_value(const uint32_t& value) {
+    printf("%u", value);
+}
+
+template <>
+void print_value(const float& value) {
+    printf("%f", value);
+}
+
+template <>
+void print_value(const double& value) {
+    printf("%f", value);
+}
+
+void __begin_test(const char* function_name, const char* file, int line) {
+    printf("######### Running %s @ %s:%d\n", function_name, file, line);
+}
+
+#define BEGIN_TEST() __begin_test(__FUNCTION__, __FILE__, __LINE__)
+
+void test_fail() {
+    printf("[!] Test failed. Exiting with status code 1.\n");
+    exit(1);
+}
+
+template <typename T>
+void debug_print_array(int len, const T* as) {
+    printf("[");
+    for (int i = 0; i < len; i++) {
+        if (i != 0) printf(", ");
+        print_value(as[i]);
+    }
+    printf("]");
+}
+
+void print_assertion_passed(const char* file, int line) {
+    printf("[*] Assertion passed on %s:%d\n", file, line);
+}
+
+void print_assertion_failed(const char* file, int line) {
+    printf("[!] Assertion failed on %s:%d\n", file, line);
+}
+
+void __assert_true(const char* file, int line, bool cond) {
+    if (cond) {
+        print_assertion_passed(file, line);
+    } else {
+        print_assertion_failed(file, line);
+        test_fail();
+    }
+}
+
+#define assert_true(cond) __assert_true(__FILE__, __LINE__, cond)
+
+template <typename T>
+void __assert_arrays_match(const char* file, int line, int len,
+                           const T* expected, const T* got) {
+    if (arrays_match(len, expected, got)) {
+        print_assertion_passed(file, line);
+    } else {
+        print_assertion_failed(file, line);
+        printf("Expect = ");
+        debug_print_array(len, expected);
+        printf("\n");
+        printf("   Got = ");
+        debug_print_array(len, got);
+        printf("\n");
+        test_fail();
+    }
+}
+
+#define assert_arrays_match(len, expected, got) \
+    __assert_arrays_match(__FILE__, __LINE__, len, expected, got)
+
+template <typename T>
+void __assert_values_match(const char* file, int line, T expected, T got) {
+    if (expected == got) {
+        print_assertion_passed(file, line);
+    } else {
+        print_assertion_failed(file, line);
+        printf("Expect = ");
+        print_value(expected);
+        printf("\n");
+        printf("   Got = ");
+        print_value(got);
+        printf("\n");
+        test_fail();
+    }
+}
+
+#define assert_values_match(expected, got) \
+    __assert_values_match(__FILE__, __LINE__, expected, got)

nac3core/src/codegen/irrt/mod.rs

@@ -1,5 +1,7 @@
 use crate::typecheck::typedef::Type;
 
+mod test;
+
 use super::{
     classes::{
         ArrayLikeIndexer, ArrayLikeValue, ArraySliceValue, ListValue, NDArrayValue,

nac3core/src/codegen/irrt/test.rs

@@ -0,0 +1,26 @@
+#[cfg(test)]
+mod tests {
+    use std::{path::Path, process::Command};
+
+    #[test]
+    fn run_irrt_test() {
+        assert!(
+            cfg!(feature = "test"),
+            "Please do `cargo test -F test` to compile `irrt_test.out` and run test"
+        );
+
+        let irrt_test_out_path = Path::new(concat!(env!("OUT_DIR"), "/irrt_test.out"));
+        let output = Command::new(irrt_test_out_path.to_str().unwrap()).output().unwrap();
+
+        if !output.status.success() {
+            eprintln!("irrt_test failed with status {}:", output.status);
+            eprintln!("====== stdout ======");
+            eprintln!("{}", String::from_utf8(output.stdout).unwrap());
+            eprintln!("====== stderr ======");
+            eprintln!("{}", String::from_utf8(output.stderr).unwrap());
+            eprintln!("====================");
+
+            panic!("irrt_test failed");
+        }
+    }
+}