WIP

nac3artiq/src/codegen.rs

@@ -14,6 +14,7 @@ use nac3parser::ast::{Expr, ExprKind, Located, Stmt, StmtKind, StrRef};
 
 use inkwell::{
     context::Context, module::Linkage, types::IntType, values::BasicValueEnum, AddressSpace,
+    IntPredicate,
 };
 
 use pyo3::{
@@ -23,10 +24,18 @@ use pyo3::{
 
 use crate::{symbol_resolver::InnerResolver, timeline::TimeFns};
 
+use itertools::Itertools;
+use nac3core::codegen::classes::{ListValue, NDArrayValue, RangeValue, UntypedArrayLikeAccessor};
+use nac3core::codegen::expr::destructure_range;
+use nac3core::codegen::get_fprintf_format_constant;
+use nac3core::codegen::irrt::call_ndarray_calc_size;
+use nac3core::codegen::stmt::{gen_for_callback_incrementing, gen_if_callback};
+use std::iter::once;
 use std::{
     collections::hash_map::DefaultHasher,
     collections::HashMap,
     hash::{Hash, Hasher},
+    mem,
     sync::Arc,
 };
 
@@ -724,3 +733,400 @@ pub fn rpc_codegen_callback() -> Arc<GenCall> {
         rpc_codegen_callback_fn(ctx, obj, fun, args, generator)
     })))
 }
+
+fn polymorphic_print<'ctx>(
+    ctx: &mut CodeGenContext<'ctx, '_>,
+    generator: &mut dyn CodeGenerator,
+    values: &[(Type, ValueEnum<'ctx>)],
+    separator: &str,
+    suffix: Option<&str>,
+    as_repr: bool,
+    as_rtio: bool,
+) -> Result<(), String> {
+    let printf = |ctx: &mut CodeGenContext<'ctx, '_>,
+                  generator: &mut dyn CodeGenerator,
+                  fmt: String,
+                  args: Vec<BasicValueEnum<'ctx>>| {
+        let fn_name = if as_rtio { "rtio_log" } else { "core_log" };
+        let print_fn = ctx.module.get_function(fn_name).unwrap_or_else(|| {
+            let llvm_pi8 = ctx.ctx.i8_type().ptr_type(AddressSpace::default());
+            let fn_t = if as_rtio {
+                let llvm_void = ctx.ctx.void_type();
+                llvm_void.fn_type(&[llvm_pi8.into()], true)
+            } else {
+                let llvm_i32 = ctx.ctx.i32_type();
+                llvm_i32.fn_type(&[llvm_pi8.into()], true)
+            };
+            ctx.module.add_function(fn_name, fn_t, None)
+        });
+
+        let fmt = ctx.gen_string(generator, fmt);
+
+        ctx.builder
+            .build_call(print_fn, &once(fmt).chain(args).map(|arg| arg.into()).collect_vec(), "")
+            .unwrap();
+    };
+
+    let llvm_i32 = ctx.ctx.i32_type();
+    let llvm_i64 = ctx.ctx.i64_type();
+    let llvm_usize = generator.get_size_type(ctx.ctx);
+
+    let suffix = suffix.unwrap_or_default();
+
+    let mut fmt = String::new();
+    let mut args = Vec::<BasicValueEnum<'ctx>>::new();
+
+    let flush = |ctx: &mut CodeGenContext<'ctx, '_>,
+                 generator: &mut dyn CodeGenerator,
+                 fmt: &mut String,
+                 args: &mut Vec<BasicValueEnum<'ctx>>| {
+        if !fmt.is_empty() {
+            fmt.push('\0');
+            printf(ctx, generator, mem::take(fmt), mem::take(args));
+        }
+    };
+
+    for (ty, value) in values {
+        let ty = *ty;
+        let value = value.clone().to_basic_value_enum(ctx, generator, ty).unwrap();
+
+        if !fmt.is_empty() {
+            fmt.push_str(separator);
+        }
+
+        match &*ctx.unifier.get_ty_immutable(ty) {
+            TypeEnum::TTuple { ty, is_vararg_ctx: false } => {
+                fmt.push('(');
+                flush(ctx, generator, &mut fmt, &mut args);
+
+                let tuple_vals = ty
+                    .iter()
+                    .enumerate()
+                    .map(|(i, ty)| {
+                        (
+                            *ty,
+                            ValueEnum::from(ctx.build_in_bounds_gep_and_load(
+                                value.into_pointer_value(),
+                                &[llvm_i32.const_int(i as u64, false)],
+                                None,
+                            )),
+                        )
+                    })
+                    .collect_vec();
+
+                polymorphic_print(ctx, generator, &tuple_vals, ", ", None, true, as_rtio)?;
+
+                if tuple_vals.len() == 1 {
+                    fmt.push_str(",)");
+                } else {
+                    fmt.push(')');
+                }
+            }
+
+            TypeEnum::TFunc { .. } => todo!(),
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::None.id() => {
+                fmt.push_str("None");
+            }
+
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::Bool.id() => {
+                fmt.push_str("%.*s");
+
+                let true_str = ctx.gen_string(generator, "True");
+                let false_str = ctx.gen_string(generator, "False");
+
+                args.push(
+                    ctx.builder
+                        .build_select(
+                            generator.bool_to_i1(ctx, value.into_int_value()),
+                            true_str,
+                            false_str,
+                            "",
+                        )
+                        .unwrap(),
+                );
+            }
+
+            TypeEnum::TObj { obj_id, .. }
+                if *obj_id == PrimDef::Int32.id()
+                    || *obj_id == PrimDef::Int64.id()
+                    || *obj_id == PrimDef::UInt32.id()
+                    || *obj_id == PrimDef::UInt64.id() =>
+            {
+                let is_unsigned =
+                    *obj_id == PrimDef::UInt32.id() || *obj_id == PrimDef::UInt64.id();
+
+                let llvm_int_t = value.get_type().into_int_type();
+                debug_assert!(matches!(llvm_usize.get_bit_width(), 32 | 64));
+                debug_assert!(matches!(llvm_int_t.get_bit_width(), 32 | 64));
+
+                let fmt_spec = format!(
+                    "%{}",
+                    get_fprintf_format_constant(llvm_usize, llvm_int_t, is_unsigned)
+                );
+
+                fmt.push_str(fmt_spec.as_str());
+                args.push(value);
+            }
+
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::Float.id() => {
+                fmt.push_str("%g");
+                args.push(value);
+            }
+
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::Str.id() => {
+                if as_repr {
+                    fmt.push_str("\"%.*s\"");
+                } else {
+                    fmt.push_str("%.*s");
+                }
+                args.push(value);
+            }
+
+            TypeEnum::TObj { obj_id, params, .. } if *obj_id == PrimDef::List.id() => {
+                let elem_ty = *params.iter().next().unwrap().1;
+
+                fmt.push('[');
+                flush(ctx, generator, &mut fmt, &mut args);
+
+                let val = ListValue::from_ptr_val(value.into_pointer_value(), llvm_usize, None);
+                let len = val.load_size(ctx, None);
+                let last =
+                    ctx.builder.build_int_sub(len, llvm_usize.const_int(1, false), "").unwrap();
+
+                gen_for_callback_incrementing(
+                    generator,
+                    ctx,
+                    None,
+                    llvm_usize.const_zero(),
+                    (len, false),
+                    |generator, ctx, _, i| {
+                        let elem = unsafe { val.data().get_unchecked(ctx, generator, &i, None) };
+
+                        polymorphic_print(
+                            ctx,
+                            generator,
+                            &[(elem_ty, elem.into())],
+                            "",
+                            None,
+                            true,
+                            as_rtio,
+                        )?;
+
+                        gen_if_callback(
+                            generator,
+                            ctx,
+                            |_, ctx| {
+                                Ok(ctx
+                                    .builder
+                                    .build_int_compare(IntPredicate::ULT, i, last, "")
+                                    .unwrap())
+                            },
+                            |generator, ctx| {
+                                printf(ctx, generator, ", \0".into(), Vec::default());
+
+                                Ok(())
+                            },
+                            |_, _| Ok(()),
+                        )?;
+
+                        Ok(())
+                    },
+                    llvm_usize.const_int(1, false),
+                )?;
+
+                fmt.push(']');
+                flush(ctx, generator, &mut fmt, &mut args);
+            }
+
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::NDArray.id() => {
+                let (elem_ty, _) = unpack_ndarray_var_tys(&mut ctx.unifier, ty);
+
+                fmt.push_str("array([");
+                flush(ctx, generator, &mut fmt, &mut args);
+
+                let val = NDArrayValue::from_ptr_val(value.into_pointer_value(), llvm_usize, None);
+                let len = call_ndarray_calc_size(generator, ctx, &val.dim_sizes(), (None, None));
+                let last =
+                    ctx.builder.build_int_sub(len, llvm_usize.const_int(1, false), "").unwrap();
+
+                gen_for_callback_incrementing(
+                    generator,
+                    ctx,
+                    None,
+                    llvm_usize.const_zero(),
+                    (len, false),
+                    |generator, ctx, _, i| {
+                        let elem = unsafe { val.data().get_unchecked(ctx, generator, &i, None) };
+
+                        polymorphic_print(
+                            ctx,
+                            generator,
+                            &[(elem_ty, elem.into())],
+                            "",
+                            None,
+                            true,
+                            as_rtio,
+                        )?;
+
+                        gen_if_callback(
+                            generator,
+                            ctx,
+                            |_, ctx| {
+                                Ok(ctx
+                                    .builder
+                                    .build_int_compare(IntPredicate::ULT, i, last, "")
+                                    .unwrap())
+                            },
+                            |generator, ctx| {
+                                printf(ctx, generator, ", \0".into(), Vec::default());
+
+                                Ok(())
+                            },
+                            |_, _| Ok(()),
+                        )?;
+
+                        Ok(())
+                    },
+                    llvm_usize.const_int(1, false),
+                )?;
+
+                fmt.push_str(")]");
+                flush(ctx, generator, &mut fmt, &mut args);
+            }
+
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::Range.id() => {
+                fmt.push_str("range(");
+                flush(ctx, generator, &mut fmt, &mut args);
+
+                let val = RangeValue::from_ptr_val(value.into_pointer_value(), None);
+
+                let (start, stop, step) = destructure_range(ctx, val);
+
+                polymorphic_print(
+                    ctx,
+                    generator,
+                    &[
+                        (ctx.primitives.int32, start.into()),
+                        (ctx.primitives.int32, stop.into()),
+                        (ctx.primitives.int32, step.into()),
+                    ],
+                    ", ",
+                    None,
+                    false,
+                    as_rtio,
+                )?;
+
+                fmt.push(')');
+            }
+
+            TypeEnum::TObj { obj_id, .. } if *obj_id == PrimDef::Exception.id() => {
+                let fmt_str = format!(
+                    "%{}(%{}, %{1:}, %{1:})",
+                    get_fprintf_format_constant(llvm_usize, llvm_i32, false),
+                    get_fprintf_format_constant(llvm_usize, llvm_i64, false),
+                );
+
+                let exn = value.into_pointer_value();
+                let name = ctx
+                    .build_in_bounds_gep_and_load(
+                        exn,
+                        &[llvm_i32.const_zero(), llvm_i32.const_zero()],
+                        None,
+                    )
+                    .into_int_value();
+                let param0 = ctx
+                    .build_in_bounds_gep_and_load(
+                        exn,
+                        &[llvm_i32.const_zero(), llvm_i32.const_int(6, false)],
+                        None,
+                    )
+                    .into_int_value();
+                let param1 = ctx
+                    .build_in_bounds_gep_and_load(
+                        exn,
+                        &[llvm_i32.const_zero(), llvm_i32.const_int(7, false)],
+                        None,
+                    )
+                    .into_int_value();
+                let param2 = ctx
+                    .build_in_bounds_gep_and_load(
+                        exn,
+                        &[llvm_i32.const_zero(), llvm_i32.const_int(8, false)],
+                        None,
+                    )
+                    .into_int_value();
+
+                fmt.push_str(fmt_str.as_str());
+                args.extend_from_slice(&[name.into(), param0.into(), param1.into(), param2.into()]);
+            }
+
+            _ => unreachable!(
+                "Unsupported object type for polymorphic_print: {}",
+                ctx.unifier.stringify(ty)
+            ),
+        }
+    }
+
+    fmt.push_str(suffix);
+    flush(ctx, generator, &mut fmt, &mut args);
+
+    Ok(())
+}
+
+/// Invokes the `core_log` intrinsic function.
+pub fn call_core_log_impl<'ctx>(
+    ctx: &mut CodeGenContext<'ctx, '_>,
+    generator: &mut dyn CodeGenerator,
+    arg: (Type, BasicValueEnum<'ctx>),
+) -> Result<(), String> {
+    let (arg_ty, arg_val) = arg;
+
+    polymorphic_print(ctx, generator, &[(arg_ty, arg_val.into())], "", None, false, false);
+
+    Ok(())
+}
+
+/// Invokes the `rtio_log` intrinsic function.
+pub fn call_rtio_log_impl<'ctx>(
+    ctx: &mut CodeGenContext<'ctx, '_>,
+    generator: &mut dyn CodeGenerator,
+    arg: (Type, BasicValueEnum<'ctx>),
+) -> Result<(), String> {
+    let (arg_ty, arg_val) = arg;
+
+    polymorphic_print(ctx, generator, &[(arg_ty, arg_val.into())], "", None, false, true);
+
+    Ok(())
+}
+
+pub fn gen_core_log<'ctx>(
+    ctx: &mut CodeGenContext<'ctx, '_>,
+    obj: &Option<(Type, ValueEnum<'ctx>)>,
+    fun: (&FunSignature, DefinitionId),
+    args: &[(Option<StrRef>, ValueEnum<'ctx>)],
+    generator: &mut dyn CodeGenerator,
+) -> Result<(), String> {
+    assert!(obj.is_none());
+    assert_eq!(args.len(), 1);
+
+    let value_ty = fun.0.args[0].ty;
+    let value_arg = args[0].1.clone().to_basic_value_enum(ctx, generator, value_ty)?;
+
+    call_core_log_impl(ctx, generator, (value_ty, value_arg))
+}
+
+pub fn gen_rtio_log<'ctx>(
+    ctx: &mut CodeGenContext<'ctx, '_>,
+    obj: &Option<(Type, ValueEnum<'ctx>)>,
+    fun: (&FunSignature, DefinitionId),
+    args: &[(Option<StrRef>, ValueEnum<'ctx>)],
+    generator: &mut dyn CodeGenerator,
+) -> Result<(), String> {
+    assert!(obj.is_none());
+    assert_eq!(args.len(), 1);
+
+    let value_ty = fun.0.args[0].ty;
+    let value_arg = args[0].1.clone().to_basic_value_enum(ctx, generator, value_ty)?;
+
+    call_rtio_log_impl(ctx, generator, (value_ty, value_arg))
+}

nac3artiq/src/lib.rs

@@ -35,7 +35,7 @@ use inkwell::{
 use itertools::Itertools;
 use nac3core::codegen::{gen_func_impl, CodeGenLLVMOptions, CodeGenTargetMachineOptions};
 use nac3core::toplevel::builtins::get_exn_constructor;
-use nac3core::typecheck::typedef::{TypeEnum, Unifier, VarMap};
+use nac3core::typecheck::typedef::{into_var_map, TypeEnum, Unifier, VarMap};
 use nac3parser::{
     ast::{ExprKind, Stmt, StmtKind, StrRef},
     parser::parse_program,
@@ -62,7 +62,7 @@ use nac3ld::Linker;
 
 use tempfile::{self, TempDir};
 
-use crate::codegen::attributes_writeback;
+use crate::codegen::{attributes_writeback, gen_core_log, gen_rtio_log};
 use crate::{
     codegen::{rpc_codegen_callback, ArtiqCodeGenerator},
     symbol_resolver::{DeferredEvaluationStore, InnerResolver, PythonHelper, Resolver},
@@ -853,7 +853,7 @@ impl Nac3 {
             Isa::RiscV32IMA => &timeline::NOW_PINNING_TIME_FNS,
             Isa::CortexA9 | Isa::Host => &timeline::EXTERN_TIME_FNS,
         };
-        let primitive: PrimitiveStore = TopLevelComposer::make_primitives(isa.get_size_type()).0;
+        let (primitive, mut unifier) = TopLevelComposer::make_primitives(isa.get_size_type());
         let builtins = vec![
             (
                 "now_mu".into(),
@@ -902,6 +902,50 @@ impl Nac3 {
                     Ok(None)
                 }))),
             ),
+            {
+                let arg_ty = unifier.get_dummy_var();
+
+                (
+                    "core_log".into(),
+                    FunSignature {
+                        args: vec![FuncArg {
+                            name: "obj".into(),
+                            ty: arg_ty.ty,
+                            default_value: None,
+                            is_vararg: false,
+                        }],
+                        ret: primitive.none,
+                        vars: into_var_map([arg_ty]),
+                    },
+                    Arc::new(GenCall::new(Box::new(move |ctx, obj, fun, args, generator| {
+                        gen_core_log(ctx, &obj, fun, &args, generator)?;
+
+                        Ok(None)
+                    }))),
+                )
+            },
+            {
+                let arg_ty = unifier.get_dummy_var();
+
+                (
+                    "rtio_log".into(),
+                    FunSignature {
+                        args: vec![FuncArg {
+                            name: "obj".into(),
+                            ty: arg_ty.ty,
+                            default_value: None,
+                            is_vararg: false,
+                        }],
+                        ret: primitive.none,
+                        vars: into_var_map([arg_ty]),
+                    },
+                    Arc::new(GenCall::new(Box::new(move |ctx, obj, fun, args, generator| {
+                        gen_rtio_log(ctx, &obj, fun, &args, generator)?;
+
+                        Ok(None)
+                    }))),
+                )
+            },
         ];
 
         let builtins_mod = PyModule::import(py, "builtins").unwrap();

nac3core/src/codegen/expr.rs

@@ -82,6 +82,20 @@ impl<'ctx, 'a> CodeGenContext<'ctx, 'a> {
         self.builder.build_load(gep, name.unwrap_or_default()).unwrap()
     }
 
+    /// Builds a sequence of `getelementptr inbounds` and `load` instructions which stores the value
+    /// of a struct field into an LLVM value.
+    ///
+    /// Any out-of-bounds accesses to `ptr` will return in a `poison` value.
+    pub fn build_in_bounds_gep_and_load(
+        &mut self,
+        ptr: PointerValue<'ctx>,
+        index: &[IntValue<'ctx>],
+        name: Option<&str>,
+    ) -> BasicValueEnum<'ctx> {
+        let gep = unsafe { self.builder.build_in_bounds_gep(ptr, index, "") }.unwrap();
+        self.builder.build_load(gep, name.unwrap_or_default()).unwrap()
+    }
+
     fn get_subst_key(
         &mut self,
         obj: Option<Type>,

nac3core/src/codegen/mod.rs

@@ -8,6 +8,7 @@ use crate::{
     },
 };
 use crossbeam::channel::{unbounded, Receiver, Sender};
+use inkwell::types::IntType;
 use inkwell::{
     attributes::{Attribute, AttributeLoc},
     basic_block::BasicBlock,
@@ -1094,6 +1095,32 @@ fn gen_in_range_check<'ctx>(
     ctx.builder.build_int_compare(IntPredicate::SLT, lo, hi, "cmp").unwrap()
 }
 
+/// Returns the `fprintf` format constant for the given [`llvm_int_t`][IntType`] on a platform with
+/// [`llvm_usize`] as its native word size.
+///
+/// Note that, similar to format constants in `<inttypes.h>`, these constants need to be prepended
+/// with `%`.
+#[must_use]
+pub fn get_fprintf_format_constant<'ctx>(
+    llvm_usize: IntType<'ctx>,
+    llvm_int_t: IntType<'ctx>,
+    is_unsigned: bool,
+) -> String {
+    debug_assert!(matches!(llvm_usize.get_bit_width(), 32 | 64));
+
+    let conv_spec = if is_unsigned { 'u' } else { 'd' };
+
+    match llvm_int_t.get_bit_width() {
+        32 => conv_spec.to_string(),
+        64 => format!("{}{conv_spec}", if llvm_usize.get_bit_width() == 64 { "l" } else { "ll" }),
+        _ => todo!(
+            "Not yet implemented for i{} on {}-bit platform",
+            llvm_int_t.get_bit_width(),
+            llvm_usize.get_bit_width()
+        ),
+    }
+}
+
 /// Returns the internal name for the `va_count` argument, used to indicate the number of arguments
 /// passed to the variadic function.
 fn get_va_count_arg_name(arg_name: StrRef) -> StrRef {