nac3/nac3artiq/src/lib.rs

1213 lines
48 KiB
Rust
Raw Normal View History

2024-06-12 15:13:09 +08:00
#![deny(
future_incompatible,
let_underscore,
nonstandard_style,
rust_2024_compatibility,
clippy::all
)]
#![warn(clippy::pedantic)]
#![allow(
2024-06-12 15:13:09 +08:00
unsafe_op_in_unsafe_fn,
clippy::cast_possible_truncation,
clippy::cast_sign_loss,
clippy::enum_glob_use,
clippy::similar_names,
clippy::too_many_lines,
clippy::wildcard_imports
)]
use std::{
collections::{HashMap, HashSet},
fs,
io::Write,
process::Command,
rc::Rc,
sync::Arc,
2021-09-23 19:30:03 +08:00
};
2021-09-30 22:30:54 +08:00
use itertools::Itertools;
2021-10-10 16:26:01 +08:00
use parking_lot::{Mutex, RwLock};
use pyo3::{
create_exception, exceptions,
prelude::*,
types::{PyBytes, PyDict, PySet},
};
use tempfile::{self, TempDir};
2020-12-19 16:23:12 +08:00
2021-09-23 19:30:03 +08:00
use nac3core::{
codegen::{
concrete_type::ConcreteTypeStore, gen_func_impl, irrt::load_irrt, CodeGenLLVMOptions,
CodeGenTargetMachineOptions, CodeGenTask, CodeGenerator, WithCall, WorkerRegistry,
},
inkwell::{
context::Context,
memory_buffer::MemoryBuffer,
module::{FlagBehavior, Linkage, Module},
passes::PassBuilderOptions,
support::is_multithreaded,
targets::*,
OptimizationLevel,
},
nac3parser::{
ast::{Constant, ExprKind, Located, Stmt, StmtKind, StrRef},
parser::parse_program,
},
2021-09-23 19:30:03 +08:00
symbol_resolver::SymbolResolver,
2022-02-12 21:17:37 +08:00
toplevel::{
builtins::get_exn_constructor,
composer::{BuiltinFuncCreator, BuiltinFuncSpec, ComposerConfig, TopLevelComposer},
2022-02-12 21:17:37 +08:00
DefinitionId, GenCall, TopLevelDef,
},
typecheck::{
type_inferencer::PrimitiveStore,
typedef::{into_var_map, FunSignature, FuncArg, Type, TypeEnum, Unifier, VarMap},
},
2021-09-30 22:30:54 +08:00
};
use nac3ld::Linker;
2024-10-18 14:16:42 +08:00
use codegen::{
attributes_writeback, gen_core_log, gen_rtio_log, rpc_codegen_callback, ArtiqCodeGenerator,
};
use symbol_resolver::{DeferredEvaluationStore, InnerResolver, PythonHelper, Resolver};
use timeline::TimeFns;
2020-12-19 15:29:39 +08:00
mod codegen;
2021-09-23 19:30:03 +08:00
mod symbol_resolver;
2021-10-10 16:26:01 +08:00
mod timeline;
2020-12-19 15:29:39 +08:00
#[derive(PartialEq, Clone, Copy)]
2021-09-29 15:33:12 +08:00
enum Isa {
Host,
RiscV32G,
RiscV32IMA,
2021-09-30 22:30:54 +08:00
CortexA9,
2021-09-29 15:33:12 +08:00
}
impl Isa {
/// Returns the number of bits in `size_t` for the [`Isa`].
2024-02-20 18:07:55 +08:00
fn get_size_type(self) -> u32 {
if self == Isa::Host {
64u32
} else {
32u32
}
}
}
#[derive(Clone)]
pub struct PrimitivePythonId {
int: u64,
int32: u64,
int64: u64,
2022-03-05 03:45:09 +08:00
uint32: u64,
uint64: u64,
float: u64,
float64: u64,
bool: u64,
2024-06-18 14:14:12 +08:00
np_bool_: u64,
string: u64,
2024-06-18 14:14:12 +08:00
np_str_: u64,
list: u64,
ndarray: u64,
tuple: u64,
typevar: u64,
const_generic_marker: u64,
none: u64,
2022-02-12 21:17:37 +08:00
exception: u64,
generic_alias: (u64, u64),
virtual_id: u64,
option: u64,
}
type TopLevelComponent = (Stmt, String, PyObject);
2021-10-02 18:28:44 +08:00
// TopLevelComposer is unsendable as it holds the unification table, which is
// unsendable due to Rc. Arc would cause a performance hit.
2021-09-30 22:30:54 +08:00
#[pyclass(unsendable, name = "NAC3")]
2020-12-19 15:29:39 +08:00
struct Nac3 {
2021-09-29 15:33:12 +08:00
isa: Isa,
2021-11-01 00:03:15 +08:00
time_fns: &'static (dyn TimeFns + Sync),
2021-09-23 19:30:03 +08:00
primitive: PrimitiveStore,
builtins: Vec<BuiltinFuncSpec>,
2021-09-30 22:30:54 +08:00
pyid_to_def: Arc<RwLock<HashMap<u64, DefinitionId>>>,
primitive_ids: PrimitivePythonId,
working_directory: TempDir,
top_levels: Vec<TopLevelComponent>,
2022-02-12 21:17:37 +08:00
string_store: Arc<RwLock<HashMap<String, i32>>>,
exception_ids: Arc<RwLock<HashMap<usize, usize>>>,
deferred_eval_store: DeferredEvaluationStore,
/// LLVM-related options for code generation.
llvm_options: CodeGenLLVMOptions,
2021-09-30 22:30:54 +08:00
}
create_exception!(nac3artiq, CompileError, exceptions::PyException);
2021-09-30 22:30:54 +08:00
impl Nac3 {
2021-11-20 21:15:15 +08:00
fn register_module(
&mut self,
2023-12-11 15:04:35 +08:00
module: &PyObject,
2021-11-20 21:15:15 +08:00
registered_class_ids: &HashSet<u64>,
) -> PyResult<()> {
let (module_name, source_file) = Python::with_gil(|py| -> PyResult<(String, String)> {
let module: &PyAny = module.extract(py)?;
2022-02-21 18:27:46 +08:00
Ok((module.getattr("__name__")?.extract()?, module.getattr("__file__")?.extract()?))
})?;
2021-09-30 22:30:54 +08:00
2021-12-28 01:28:55 +08:00
let source = fs::read_to_string(&source_file).map_err(|e| {
2023-12-11 15:04:35 +08:00
exceptions::PyIOError::new_err(format!("failed to read input file: {e}"))
2021-09-30 22:30:54 +08:00
})?;
2023-10-26 13:52:40 +08:00
let parser_result = parse_program(&source, source_file.into())
2023-12-11 15:04:35 +08:00
.map_err(|e| exceptions::PySyntaxError::new_err(format!("parse error: {e}")))?;
2021-11-20 21:15:15 +08:00
2023-12-11 15:04:35 +08:00
for mut stmt in parser_result {
2021-09-30 22:30:54 +08:00
let include = match stmt.node {
2024-06-12 14:45:03 +08:00
StmtKind::ClassDef { ref decorator_list, ref mut body, ref mut bases, .. } => {
let nac3_class = decorator_list.iter().any(|decorator| {
2023-10-26 13:52:40 +08:00
if let ExprKind::Name { id, .. } = decorator.node {
id.to_string() == "nac3"
2021-09-30 22:30:54 +08:00
} else {
false
}
});
if !nac3_class {
continue;
}
// Drop unregistered (i.e. host-only) base classes.
bases.retain(|base| {
Python::with_gil(|py| -> PyResult<bool> {
let id_fn = PyModule::import(py, "builtins")?.getattr("id")?;
match &base.node {
2023-10-26 13:52:40 +08:00
ExprKind::Name { id, .. } => {
2022-02-12 21:17:37 +08:00
if *id == "Exception".into() {
Ok(true)
} else {
2024-06-12 14:45:03 +08:00
let base_obj =
module.getattr(py, id.to_string().as_str())?;
2022-02-12 21:17:37 +08:00
let base_id = id_fn.call1((base_obj,))?.extract()?;
Ok(registered_class_ids.contains(&base_id))
}
2021-11-20 21:15:15 +08:00
}
_ => Ok(true),
}
2021-11-20 21:15:15 +08:00
})
.unwrap()
});
2021-09-30 22:30:54 +08:00
body.retain(|stmt| {
2023-10-26 13:52:40 +08:00
if let StmtKind::FunctionDef { ref decorator_list, .. } = stmt.node {
2021-09-30 22:30:54 +08:00
decorator_list.iter().any(|decorator| {
if let Some(id) = decorator_id_string(decorator) {
id == "kernel" || id == "portable" || id == "rpc"
2021-09-30 22:30:54 +08:00
} else {
false
}
})
} else {
true
}
});
true
2021-09-30 22:30:54 +08:00
}
2023-10-26 13:52:40 +08:00
StmtKind::FunctionDef { ref decorator_list, .. } => {
2022-02-21 18:27:46 +08:00
decorator_list.iter().any(|decorator| {
if let Some(id) = decorator_id_string(decorator) {
id == "extern" || id == "kernel" || id == "portable" || id == "rpc"
2022-02-21 18:27:46 +08:00
} else {
false
}
})
}
2021-09-30 22:30:54 +08:00
_ => false,
};
if include {
2022-02-21 18:27:46 +08:00
self.top_levels.push((stmt, module_name.clone(), module.clone()));
2021-09-30 22:30:54 +08:00
}
}
Ok(())
}
fn report_modinit(
arg_names: &[String],
method_name: &str,
2023-12-11 15:04:35 +08:00
resolver: &Arc<dyn SymbolResolver + Send + Sync>,
top_level_defs: &[Arc<RwLock<TopLevelDef>>],
unifier: &mut Unifier,
primitives: &PrimitiveStore,
) -> Option<String> {
let base_ty =
match resolver.get_symbol_type(unifier, top_level_defs, primitives, "base".into()) {
Ok(ty) => ty,
2023-12-11 15:04:35 +08:00
Err(e) => return Some(format!("type error inside object launching kernel: {e}")),
};
2022-02-12 21:17:37 +08:00
let fun_ty = if method_name.is_empty() {
base_ty
} else if let TypeEnum::TObj { fields, .. } = &*unifier.get_ty(base_ty) {
match fields.get(&(*method_name).into()) {
Some(t) => t.0,
2022-02-21 18:27:46 +08:00
None => {
return Some(format!(
2023-12-11 15:04:35 +08:00
"object launching kernel does not have method `{method_name}`"
2022-02-21 18:27:46 +08:00
))
}
}
} else {
2022-02-21 18:27:46 +08:00
return Some("cannot launch kernel by calling a non-callable".into());
};
2022-02-12 21:17:37 +08:00
if let TypeEnum::TFunc(FunSignature { args, .. }) = &*unifier.get_ty(fun_ty) {
if arg_names.len() > args.len() {
return Some(format!(
"launching kernel function with too many arguments (expect {}, found {})",
args.len(),
arg_names.len(),
2022-02-21 18:27:46 +08:00
));
}
for (i, FuncArg { ty, default_value, name, .. }) in args.iter().enumerate() {
let in_name = match arg_names.get(i) {
Some(n) => n,
2022-02-21 18:27:46 +08:00
None if default_value.is_none() => {
return Some(format!(
2023-12-11 15:04:35 +08:00
"argument `{name}` not provided when launching kernel function"
2022-02-21 18:27:46 +08:00
))
}
_ => break,
};
let in_ty = match resolver.get_symbol_type(
unifier,
top_level_defs,
primitives,
2022-02-21 18:27:46 +08:00
in_name.clone().into(),
) {
Ok(t) => t,
2022-02-21 18:27:46 +08:00
Err(e) => {
return Some(format!(
2023-12-11 15:04:35 +08:00
"type error ({e}) at parameter #{i} when calling kernel function"
2022-02-21 18:27:46 +08:00
))
}
};
if let Err(e) = unifier.unify(in_ty, *ty) {
return Some(format!(
2023-12-06 11:49:02 +08:00
"type error ({}) at parameter #{i} when calling kernel function",
e.to_display(unifier),
));
}
}
} else {
2022-02-21 18:27:46 +08:00
return Some("cannot launch kernel by calling a non-callable".into());
}
None
}
/// Returns a [`Vec`] of builtins that needs to be initialized during method compilation time.
fn get_lateinit_builtins() -> Vec<Box<BuiltinFuncCreator>> {
vec![
Box::new(|primitives, unifier| {
let arg_ty = unifier.get_fresh_var(Some("T".into()), None);
(
"core_log".into(),
FunSignature {
args: vec![FuncArg {
name: "arg".into(),
ty: arg_ty.ty,
default_value: None,
is_vararg: false,
}],
ret: primitives.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)
}))),
)
}),
Box::new(|primitives, unifier| {
let arg_ty = unifier.get_fresh_var(Some("T".into()), None);
(
"rtio_log".into(),
FunSignature {
args: vec![
FuncArg {
name: "channel".into(),
ty: primitives.str,
default_value: None,
is_vararg: false,
},
FuncArg {
name: "arg".into(),
ty: arg_ty.ty,
default_value: None,
is_vararg: false,
},
],
ret: primitives.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)
}))),
)
}),
]
}
fn compile_method<T>(
&self,
2021-10-10 16:26:01 +08:00
obj: &PyAny,
2021-11-06 14:14:53 +08:00
method_name: &str,
2021-10-10 16:26:01 +08:00
args: Vec<&PyAny>,
2022-02-12 21:17:37 +08:00
embedding_map: &PyAny,
2021-10-10 16:26:01 +08:00
py: Python,
link_fn: &dyn Fn(&Module) -> PyResult<T>,
) -> PyResult<T> {
let size_t = self.isa.get_size_type();
2022-03-16 23:42:08 +08:00
let (mut composer, mut builtins_def, mut builtins_ty) = TopLevelComposer::new(
2022-02-21 18:27:46 +08:00
self.builtins.clone(),
Self::get_lateinit_builtins(),
2022-02-21 18:27:46 +08:00
ComposerConfig { kernel_ann: Some("Kernel"), kernel_invariant_ann: "KernelInvariant" },
size_t,
2022-02-21 18:27:46 +08:00
);
let builtins = PyModule::import(py, "builtins")?;
let typings = PyModule::import(py, "typing")?;
let id_fn = builtins.getattr("id")?;
let issubclass = builtins.getattr("issubclass")?;
let exn_class = builtins.getattr("Exception")?;
2022-02-12 21:17:37 +08:00
let store_obj = embedding_map.getattr("store_object").unwrap().to_object(py);
let store_str = embedding_map.getattr("store_str").unwrap().to_object(py);
2022-02-21 18:27:46 +08:00
let store_fun = embedding_map.getattr("store_function").unwrap().to_object(py);
let host_attributes = embedding_map.getattr("attributes_writeback").unwrap().to_object(py);
let global_value_ids: Arc<RwLock<HashMap<_, _>>> = Arc::new(RwLock::new(HashMap::new()));
let helper = PythonHelper {
id_fn: builtins.getattr("id").unwrap().to_object(py),
len_fn: builtins.getattr("len").unwrap().to_object(py),
type_fn: builtins.getattr("type").unwrap().to_object(py),
origin_ty_fn: typings.getattr("get_origin").unwrap().to_object(py),
args_ty_fn: typings.getattr("get_args").unwrap().to_object(py),
store_obj: store_obj.clone(),
2022-02-21 18:27:46 +08:00
store_str,
};
let pyid_to_type = Arc::new(RwLock::new(HashMap::<u64, Type>::new()));
2022-03-16 23:42:08 +08:00
let exception_names = [
"ZeroDivisionError",
"IndexError",
2022-03-16 23:42:08 +08:00
"ValueError",
2022-03-17 15:03:22 +08:00
"RuntimeError",
"AssertionError",
"KeyError",
"NotImplementedError",
"OverflowError",
"IOError",
"UnwrapNoneError",
2022-03-16 23:42:08 +08:00
];
add_exceptions(&mut composer, &mut builtins_def, &mut builtins_ty, &exception_names);
let mut module_to_resolver_cache: HashMap<u64, _> = HashMap::new();
2022-02-12 21:17:37 +08:00
let mut rpc_ids = vec![];
2023-12-11 15:04:35 +08:00
for (stmt, path, module) in &self.top_levels {
let py_module: &PyAny = module.extract(py)?;
let module_id: u64 = id_fn.call1((py_module,))?.extract()?;
let helper = helper.clone();
let class_obj;
if let StmtKind::ClassDef { name, .. } = &stmt.node {
2023-09-01 16:56:32 +08:00
let class = py_module.getattr(name.to_string().as_str()).unwrap();
2024-06-12 14:45:03 +08:00
if issubclass.call1((class, exn_class)).unwrap().extract().unwrap()
&& class.getattr("artiq_builtin").is_err()
{
class_obj = Some(class);
} else {
class_obj = None;
}
} else {
class_obj = None;
}
2022-02-21 18:27:46 +08:00
let (name_to_pyid, resolver) =
module_to_resolver_cache.get(&module_id).cloned().unwrap_or_else(|| {
let mut name_to_pyid: HashMap<StrRef, u64> = HashMap::new();
let members: &PyDict =
2023-09-01 16:56:32 +08:00
py_module.getattr("__dict__").unwrap().downcast().unwrap();
2023-12-11 15:04:35 +08:00
for (key, val) in members {
let key: &str = key.extract().unwrap();
let val = id_fn.call1((val,)).unwrap().extract().unwrap();
name_to_pyid.insert(key.into(), val);
}
let resolver = Arc::new(Resolver(Arc::new(InnerResolver {
2022-03-16 23:42:08 +08:00
id_to_type: builtins_ty.clone().into(),
id_to_def: builtins_def.clone().into(),
pyid_to_def: self.pyid_to_def.clone(),
pyid_to_type: pyid_to_type.clone(),
primitive_ids: self.primitive_ids.clone(),
global_value_ids: global_value_ids.clone(),
name_to_pyid: name_to_pyid.clone(),
module: module.clone(),
2023-12-11 15:04:35 +08:00
id_to_pyval: RwLock::default(),
id_to_primitive: RwLock::default(),
field_to_val: RwLock::default(),
helper,
2022-02-12 21:17:37 +08:00
string_store: self.string_store.clone(),
exception_ids: self.exception_ids.clone(),
deferred_eval_store: self.deferred_eval_store.clone(),
})))
as Arc<dyn SymbolResolver + Send + Sync>;
let name_to_pyid = Rc::new(name_to_pyid);
module_to_resolver_cache
.insert(module_id, (name_to_pyid.clone(), resolver.clone()));
(name_to_pyid, resolver)
});
let (name, def_id, ty) = composer
2023-12-08 17:43:32 +08:00
.register_top_level(stmt.clone(), Some(resolver.clone()), path, false)
2022-02-12 21:17:37 +08:00
.map_err(|e| {
2024-06-12 14:45:03 +08:00
CompileError::new_err(format!("compilation failed\n----------\n{e}"))
2022-02-12 21:17:37 +08:00
})?;
if let Some(class_obj) = class_obj {
2024-06-12 14:45:03 +08:00
self.exception_ids
.write()
.insert(def_id.0, store_obj.call1(py, (class_obj,))?.extract(py)?);
}
2022-02-12 21:17:37 +08:00
match &stmt.node {
StmtKind::FunctionDef { decorator_list, .. } => {
if decorator_list
.iter()
.any(|decorator| decorator_id_string(decorator) == Some("rpc".to_string()))
{
store_fun
.call1(
py,
(
def_id.0.into_py(py),
module.getattr(py, name.to_string().as_str()).unwrap(),
),
)
.unwrap();
let is_async = decorator_list.iter().any(|decorator| {
decorator_get_flags(decorator)
.iter()
.any(|constant| *constant == Constant::Str("async".into()))
});
rpc_ids.push((None, def_id, is_async));
2022-02-12 21:17:37 +08:00
}
}
StmtKind::ClassDef { name, body, .. } => {
let class_name = name.to_string();
2023-09-01 16:56:32 +08:00
let class_obj = module.getattr(py, class_name.as_str()).unwrap();
2023-12-11 15:04:35 +08:00
for stmt in body {
2022-02-12 21:17:37 +08:00
if let StmtKind::FunctionDef { name, decorator_list, .. } = &stmt.node {
if decorator_list.iter().any(|decorator| {
decorator_id_string(decorator) == Some("rpc".to_string())
}) {
let is_async = decorator_list.iter().any(|decorator| {
decorator_get_flags(decorator)
.iter()
.any(|constant| *constant == Constant::Str("async".into()))
});
if name == &"__init__".into() {
return Err(CompileError::new_err(format!(
"compilation failed\n----------\nThe constructor of class {} should not be decorated with rpc decorator (at {})",
class_name, stmt.location
)));
}
rpc_ids.push((Some((class_obj.clone(), *name)), def_id, is_async));
2022-02-12 21:17:37 +08:00
}
}
}
}
_ => (),
2022-02-12 21:17:37 +08:00
}
let id = *name_to_pyid.get(&name).unwrap();
self.pyid_to_def.write().insert(id, def_id);
{
let mut pyid_to_ty = pyid_to_type.write();
if let Some(ty) = ty {
pyid_to_ty.insert(id, ty);
}
}
}
2021-10-10 16:26:01 +08:00
let id_fun = PyModule::import(py, "builtins")?.getattr("id")?;
let mut name_to_pyid: HashMap<StrRef, u64> = HashMap::new();
let module = PyModule::new(py, "tmp")?;
module.add("base", obj)?;
name_to_pyid.insert("base".into(), id_fun.call1((obj,))?.extract()?);
let mut arg_names = vec![];
for (i, arg) in args.into_iter().enumerate() {
2023-12-11 15:04:35 +08:00
let name = format!("tmp{i}");
2021-10-10 16:26:01 +08:00
module.add(&name, arg)?;
name_to_pyid.insert(name.clone().into(), id_fun.call1((arg,))?.extract()?);
arg_names.push(name);
}
let synthesized = if method_name.is_empty() {
format!("def __modinit__():\n base({})", arg_names.join(", "))
} else {
2022-02-21 18:27:46 +08:00
format!("def __modinit__():\n base.{}({})", method_name, arg_names.join(", "))
2021-10-10 16:26:01 +08:00
};
2022-02-21 18:27:46 +08:00
let mut synthesized =
parse_program(&synthesized, "<nac3_synthesized_modinit>".to_string().into()).unwrap();
let inner_resolver = Arc::new(InnerResolver {
2022-03-16 23:42:08 +08:00
id_to_type: builtins_ty.clone().into(),
id_to_def: builtins_def.clone().into(),
2021-10-10 16:26:01 +08:00
pyid_to_def: self.pyid_to_def.clone(),
pyid_to_type: pyid_to_type.clone(),
2021-10-10 16:26:01 +08:00
primitive_ids: self.primitive_ids.clone(),
global_value_ids: global_value_ids.clone(),
2023-12-11 15:04:35 +08:00
id_to_pyval: RwLock::default(),
id_to_primitive: RwLock::default(),
field_to_val: RwLock::default(),
2021-10-10 16:26:01 +08:00
name_to_pyid,
module: module.to_object(py),
2021-11-20 21:15:15 +08:00
helper,
2022-02-12 21:17:37 +08:00
string_store: self.string_store.clone(),
exception_ids: self.exception_ids.clone(),
deferred_eval_store: self.deferred_eval_store.clone(),
});
2024-06-12 14:45:03 +08:00
let resolver =
Arc::new(Resolver(inner_resolver.clone())) as Arc<dyn SymbolResolver + Send + Sync>;
let (_, def_id, _) = composer
2023-12-11 15:04:35 +08:00
.register_top_level(synthesized.pop().unwrap(), Some(resolver.clone()), "", false)
2021-10-10 16:26:01 +08:00
.unwrap();
// Process IRRT
2024-09-06 11:32:08 +08:00
let context = Context::create();
let irrt = load_irrt(&context, resolver.as_ref());
let fun_signature =
FunSignature { args: vec![], ret: self.primitive.none, vars: VarMap::new() };
let mut store = ConcreteTypeStore::new();
let mut cache = HashMap::new();
2024-06-12 14:45:03 +08:00
let signature = store.from_signature(
&mut composer.unifier,
&self.primitive,
&fun_signature,
&mut cache,
);
let signature = store.add_cty(signature);
if let Err(e) = composer.start_analysis(true) {
// report error of __modinit__ separately
return if e.iter().any(|err| err.contains("<nac3_synthesized_modinit>")) {
let msg = Self::report_modinit(
&arg_names,
method_name,
2023-12-11 15:04:35 +08:00
&resolver,
&composer.extract_def_list(),
&mut composer.unifier,
2022-02-21 18:27:46 +08:00
&self.primitive,
);
Err(CompileError::new_err(format!(
"compilation failed\n----------\n{}",
msg.unwrap_or(e.iter().sorted().join("\n----------\n"))
)))
2023-12-11 15:04:35 +08:00
} else {
2024-06-12 14:45:03 +08:00
Err(CompileError::new_err(format!(
"compilation failed\n----------\n{}",
e.iter().sorted().join("\n----------\n"),
)))
};
}
let top_level = Arc::new(composer.make_top_level_context());
2022-02-12 21:17:37 +08:00
{
let defs = top_level.definitions.read();
for (class_data, id, is_async) in &rpc_ids {
2022-02-12 21:17:37 +08:00
let mut def = defs[id.0].write();
match &mut *def {
2022-02-21 18:27:46 +08:00
TopLevelDef::Function { codegen_callback, .. } => {
*codegen_callback = Some(rpc_codegen_callback(*is_async));
2022-02-12 21:17:37 +08:00
}
TopLevelDef::Class { methods, .. } => {
let (class_def, method_name) = class_data.as_ref().unwrap();
2023-12-11 15:04:35 +08:00
for (name, _, id) in &*methods {
2022-02-12 21:17:37 +08:00
if name != method_name {
continue;
}
2022-02-21 18:27:46 +08:00
if let TopLevelDef::Function { codegen_callback, .. } =
&mut *defs[id.0].write()
2022-02-12 21:17:37 +08:00
{
*codegen_callback = Some(rpc_codegen_callback(*is_async));
2022-02-12 21:17:37 +08:00
store_fun
.call1(
py,
(
id.0.into_py(py),
2024-06-12 14:45:03 +08:00
class_def
.getattr(py, name.to_string().as_str())
.unwrap(),
2022-02-12 21:17:37 +08:00
),
)
.unwrap();
}
}
}
2024-10-03 14:21:11 +08:00
TopLevelDef::Variable { .. } => {
return Err(CompileError::new_err(String::from(
"Unsupported @rpc annotation on global variable",
)))
}
2022-02-12 21:17:37 +08:00
}
}
}
2021-09-23 19:30:03 +08:00
let instance = {
let defs = top_level.definitions.read();
2021-10-10 16:26:01 +08:00
let mut definition = defs[def_id.0].write();
let TopLevelDef::Function { instance_to_stmt, instance_to_symbol, .. } =
2024-06-12 14:45:03 +08:00
&mut *definition
else {
2021-09-23 19:30:03 +08:00
unreachable!()
};
instance_to_symbol.insert(String::new(), "__modinit__".into());
instance_to_stmt[""].clone()
2021-09-23 19:30:03 +08:00
};
2021-10-10 16:26:01 +08:00
2021-09-23 19:30:03 +08:00
let task = CodeGenTask {
2023-12-11 15:04:35 +08:00
subst: Vec::default(),
symbol_name: "__modinit__".to_string(),
2023-12-11 15:04:35 +08:00
body: Arc::new(Vec::default()),
signature,
resolver,
store,
unifier_index: instance.unifier_id,
calls: instance.calls,
id: 0,
};
2021-12-04 17:52:03 +08:00
2023-12-11 15:04:35 +08:00
let membuffers: Arc<Mutex<Vec<Vec<u8>>>> = Arc::default();
2021-12-04 17:52:03 +08:00
let membuffer = membuffers.clone();
2021-09-23 19:30:03 +08:00
let f = Arc::new(WithCall::new(Box::new(move |module| {
2021-12-04 17:52:03 +08:00
let buffer = module.write_bitcode_to_memory();
let buffer = buffer.as_slice().into();
membuffer.lock().push(buffer);
2021-09-23 19:30:03 +08:00
})));
2024-09-06 11:32:08 +08:00
let size_t = context
.ptr_sized_int_type(&self.get_llvm_target_machine().get_target_data(), None)
.get_bit_width();
let num_threads = if is_multithreaded() { 4 } else { 1 };
let thread_names: Vec<String> = (0..num_threads).map(|_| "main".to_string()).collect();
let threads: Vec<_> = thread_names
.iter()
2022-02-21 18:27:46 +08:00
.map(|s| Box::new(ArtiqCodeGenerator::new(s.to_string(), size_t, self.time_fns)))
.collect();
let membuffer = membuffers.clone();
let mut has_return = false;
py.allow_threads(|| {
2024-06-12 14:45:03 +08:00
let (registry, handles) =
WorkerRegistry::create_workers(threads, top_level.clone(), &self.llvm_options, &f);
let mut generator = ArtiqCodeGenerator::new("main".to_string(), size_t, self.time_fns);
2024-09-06 11:32:08 +08:00
let context = Context::create();
let module = context.create_module("main");
let target_machine = self.llvm_options.create_target_machine().unwrap();
module.set_data_layout(&target_machine.get_target_data().get_data_layout());
module.set_triple(&target_machine.get_triple());
module.add_basic_value_flag(
"Debug Info Version",
FlagBehavior::Warning,
context.i32_type().const_int(3, false),
);
module.add_basic_value_flag(
"Dwarf Version",
FlagBehavior::Warning,
context.i32_type().const_int(4, false),
);
let builder = context.create_builder();
2024-06-12 14:45:03 +08:00
let (_, module, _) = gen_func_impl(
&context,
&mut generator,
&registry,
builder,
module,
task,
2024-06-12 14:45:03 +08:00
|generator, ctx| {
assert_eq!(instance.body.len(), 1, "toplevel module should have 1 statement");
let StmtKind::Expr { value: ref expr, .. } = instance.body[0].node else {
unreachable!("toplevel statement must be an expression")
};
let ExprKind::Call { .. } = expr.node else {
unreachable!("toplevel expression must be a function call")
};
let return_obj =
generator.gen_expr(ctx, &expr)?.map(|value| (expr.custom.unwrap(), value));
has_return = return_obj.is_some();
registry.wait_tasks_complete(handles);
attributes_writeback(
ctx,
generator,
inner_resolver.as_ref(),
&host_attributes,
return_obj,
)
2024-06-12 14:45:03 +08:00
},
)
.unwrap();
let buffer = module.write_bitcode_to_memory();
let buffer = buffer.as_slice().into();
membuffer.lock().push(buffer);
});
2021-09-23 21:30:13 +08:00
embedding_map.setattr("expects_return", has_return).unwrap();
// Link all modules into `main`.
let buffers = membuffers.lock();
2021-12-04 17:52:03 +08:00
let main = context
.create_module_from_ir(MemoryBuffer::create_from_memory_range(&buffers[0], "main"))
.unwrap();
for buffer in buffers.iter().skip(1) {
let other = context
.create_module_from_ir(MemoryBuffer::create_from_memory_range(buffer, "main"))
.unwrap();
2024-06-12 14:45:03 +08:00
main.link_in_module(other).map_err(|err| CompileError::new_err(err.to_string()))?;
2021-12-04 17:52:03 +08:00
}
main.link_in_module(irrt).map_err(|err| CompileError::new_err(err.to_string()))?;
2021-12-04 17:52:03 +08:00
let mut function_iter = main.get_first_function();
while let Some(func) = function_iter {
if func.count_basic_blocks() > 0 && func.get_name().to_str().unwrap() != "__modinit__" {
2023-10-26 13:52:40 +08:00
func.set_linkage(Linkage::Private);
2021-12-04 17:52:03 +08:00
}
function_iter = func.get_next_function();
}
// Demote all global variables that will not be referenced in the kernel to private
2024-06-12 14:45:03 +08:00
let preserved_symbols: Vec<&'static [u8]> = vec![b"typeinfo", b"now"];
let mut global_option = main.get_first_global();
while let Some(global) = global_option {
if !preserved_symbols.contains(&(global.get_name().to_bytes())) {
global.set_linkage(Linkage::Private);
}
global_option = global.get_next_global();
}
2024-06-12 14:45:03 +08:00
let target_machine = self
.llvm_options
.target
2023-09-11 13:14:35 +08:00
.create_target_machine(self.llvm_options.opt_level)
.expect("couldn't create target machine");
let pass_options = PassBuilderOptions::create();
pass_options.set_merge_functions(true);
let passes = format!("default<O{}>", self.llvm_options.opt_level as u32);
let result = main.run_passes(passes.as_str(), &target_machine, pass_options);
2023-09-11 13:14:35 +08:00
if let Err(err) = result {
panic!("Failed to run optimization for module `main`: {}", err.to_string());
}
2021-12-04 17:52:03 +08:00
link_fn(&main)
}
2023-12-11 15:04:35 +08:00
/// Returns the [`TargetTriple`] used for compiling to [isa].
fn get_llvm_target_triple(isa: Isa) -> TargetTriple {
match isa {
Isa::Host => TargetMachine::get_default_triple(),
Isa::RiscV32G | Isa::RiscV32IMA => TargetTriple::create("riscv32-unknown-linux"),
Isa::CortexA9 => TargetTriple::create("armv7-unknown-linux-gnueabihf"),
}
}
2023-12-11 15:04:35 +08:00
/// Returns the [`String`] representing the target CPU used for compiling to [isa].
fn get_llvm_target_cpu(isa: Isa) -> String {
match isa {
Isa::Host => TargetMachine::get_host_cpu_name().to_string(),
Isa::RiscV32G | Isa::RiscV32IMA => "generic-rv32".to_string(),
Isa::CortexA9 => "cortex-a9".to_string(),
}
}
2023-12-11 15:04:35 +08:00
/// Returns the [`String`] representing the target features used for compiling to [isa].
fn get_llvm_target_features(isa: Isa) -> String {
match isa {
Isa::Host => TargetMachine::get_host_cpu_features().to_string(),
Isa::RiscV32G => "+a,+m,+f,+d".to_string(),
Isa::RiscV32IMA => "+a,+m".to_string(),
Isa::CortexA9 => "+dsp,+fp16,+neon,+vfp3,+long-calls".to_string(),
}
}
2023-12-11 15:04:35 +08:00
/// Returns an instance of [`CodeGenTargetMachineOptions`] representing the target machine
/// options used for compiling to [isa].
fn get_llvm_target_options(isa: Isa) -> CodeGenTargetMachineOptions {
CodeGenTargetMachineOptions {
triple: Nac3::get_llvm_target_triple(isa).as_str().to_string_lossy().into_owned(),
cpu: Nac3::get_llvm_target_cpu(isa),
features: Nac3::get_llvm_target_features(isa),
reloc_mode: RelocMode::PIC,
..CodeGenTargetMachineOptions::from_host()
}
}
2023-12-11 15:04:35 +08:00
/// Returns an instance of [`TargetMachine`] used in compiling and linking of a program to the
/// target [isa].
fn get_llvm_target_machine(&self) -> TargetMachine {
Nac3::get_llvm_target_options(self.isa)
.create_target_machine(self.llvm_options.opt_level)
.expect("couldn't create target machine")
}
}
/// Retrieves the Name.id from a decorator, supports decorators with arguments.
fn decorator_id_string(decorator: &Located<ExprKind>) -> Option<String> {
if let ExprKind::Name { id, .. } = decorator.node {
// Bare decorator
return Some(id.to_string());
} else if let ExprKind::Call { func, .. } = &decorator.node {
// Decorators that are calls (e.g. "@rpc()") have Call for the node,
// need to extract the id from within.
if let ExprKind::Name { id, .. } = func.node {
return Some(id.to_string());
}
}
None
}
/// Retrieves flags from a decorator, if any.
fn decorator_get_flags(decorator: &Located<ExprKind>) -> Vec<Constant> {
let mut flags = vec![];
if let ExprKind::Call { keywords, .. } = &decorator.node {
for keyword in keywords {
if keyword.node.arg != Some("flags".into()) {
continue;
}
if let ExprKind::Set { elts } = &keyword.node.value.node {
for elt in elts {
if let ExprKind::Constant { value, .. } = &elt.node {
flags.push(value.clone());
}
}
}
}
}
flags
}
2024-06-12 14:45:03 +08:00
fn link_with_lld(elf_filename: String, obj_filename: String) -> PyResult<()> {
let linker_args = vec![
"-shared".to_string(),
"--eh-frame-hdr".to_string(),
"-x".to_string(),
"-o".to_string(),
elf_filename,
obj_filename,
];
#[cfg(not(windows))]
let lld_command = "ld.lld";
#[cfg(windows)]
let lld_command = "ld.lld.exe";
if let Ok(linker_status) = Command::new(lld_command).args(linker_args).status() {
if !linker_status.success() {
return Err(CompileError::new_err("failed to start linker"));
}
} else {
2024-06-12 14:45:03 +08:00
return Err(CompileError::new_err("linker returned non-zero status code"));
}
Ok(())
}
fn add_exceptions(
composer: &mut TopLevelComposer,
builtin_def: &mut HashMap<StrRef, DefinitionId>,
builtin_ty: &mut HashMap<StrRef, Type>,
2024-06-12 14:45:03 +08:00
error_names: &[&str],
) -> Vec<Type> {
let mut types = Vec::new();
// note: this is only for builtin exceptions, i.e. the exception name is "0:{exn}"
for name in error_names {
let def_id = composer.definition_ast_list.len();
let (exception_fn, exception_class, exception_cons, exception_type) = get_exn_constructor(
name,
// class id
def_id,
// constructor id
def_id + 1,
&mut composer.unifier,
2024-06-12 14:45:03 +08:00
&composer.primitives_ty,
);
composer.definition_ast_list.push((Arc::new(RwLock::new(exception_class)), None));
composer.definition_ast_list.push((Arc::new(RwLock::new(exception_fn)), None));
builtin_ty.insert((*name).into(), exception_cons);
builtin_def.insert((*name).into(), DefinitionId(def_id));
types.push(exception_type);
}
types
}
#[pymethods]
impl Nac3 {
#[new]
fn new(isa: &str, artiq_builtins: &PyDict, py: Python) -> PyResult<Self> {
let isa = match isa {
"host" => Isa::Host,
"rv32g" => Isa::RiscV32G,
"rv32ima" => Isa::RiscV32IMA,
"cortexa9" => Isa::CortexA9,
_ => return Err(exceptions::PyValueError::new_err("invalid ISA")),
};
let time_fns: &(dyn TimeFns + Sync) = match isa {
Isa::RiscV32G => &timeline::NOW_PINNING_TIME_FNS_64,
Isa::RiscV32IMA => &timeline::NOW_PINNING_TIME_FNS,
2023-12-11 15:04:35 +08:00
Isa::CortexA9 | Isa::Host => &timeline::EXTERN_TIME_FNS,
};
let (primitive, _) = TopLevelComposer::make_primitives(isa.get_size_type());
let builtins = vec![
(
"now_mu".into(),
FunSignature { args: vec![], ret: primitive.int64, vars: VarMap::new() },
Arc::new(GenCall::new(Box::new(move |ctx, _, _, _, _| {
Ok(Some(time_fns.emit_now_mu(ctx)))
}))),
),
(
"at_mu".into(),
FunSignature {
args: vec![FuncArg {
name: "t".into(),
ty: primitive.int64,
default_value: None,
is_vararg: false,
}],
ret: primitive.none,
vars: VarMap::new(),
},
Arc::new(GenCall::new(Box::new(move |ctx, _, fun, args, generator| {
let arg_ty = fun.0.args[0].ty;
2024-06-12 14:45:03 +08:00
let arg =
args[0].1.clone().to_basic_value_enum(ctx, generator, arg_ty).unwrap();
time_fns.emit_at_mu(ctx, arg);
Ok(None)
}))),
),
(
"delay_mu".into(),
FunSignature {
args: vec![FuncArg {
name: "dt".into(),
ty: primitive.int64,
default_value: None,
is_vararg: false,
}],
ret: primitive.none,
vars: VarMap::new(),
},
Arc::new(GenCall::new(Box::new(move |ctx, _, fun, args, generator| {
let arg_ty = fun.0.args[0].ty;
2024-06-12 14:45:03 +08:00
let arg =
args[0].1.clone().to_basic_value_enum(ctx, generator, arg_ty).unwrap();
time_fns.emit_delay_mu(ctx, arg);
Ok(None)
}))),
),
];
let builtins_mod = PyModule::import(py, "builtins").unwrap();
let id_fn = builtins_mod.getattr("id").unwrap();
let numpy_mod = PyModule::import(py, "numpy").unwrap();
let typing_mod = PyModule::import(py, "typing").unwrap();
let types_mod = PyModule::import(py, "types").unwrap();
let get_id = |x: &PyAny| id_fn.call1((x,)).and_then(PyAny::extract).unwrap();
2024-06-12 14:45:03 +08:00
let get_attr_id = |obj: &PyModule, attr| {
id_fn.call1((obj.getattr(attr).unwrap(),)).unwrap().extract().unwrap()
};
let primitive_ids = PrimitivePythonId {
virtual_id: get_id(artiq_builtins.get_item("virtual").ok().flatten().unwrap()),
generic_alias: (
get_attr_id(typing_mod, "_GenericAlias"),
get_attr_id(types_mod, "GenericAlias"),
),
none: get_id(artiq_builtins.get_item("none").ok().flatten().unwrap()),
typevar: get_attr_id(typing_mod, "TypeVar"),
2024-06-12 14:45:03 +08:00
const_generic_marker: get_id(
artiq_builtins.get_item("_ConstGenericMarker").ok().flatten().unwrap(),
),
int: get_attr_id(builtins_mod, "int"),
int32: get_attr_id(numpy_mod, "int32"),
int64: get_attr_id(numpy_mod, "int64"),
uint32: get_attr_id(numpy_mod, "uint32"),
uint64: get_attr_id(numpy_mod, "uint64"),
bool: get_attr_id(builtins_mod, "bool"),
2024-06-18 14:14:12 +08:00
np_bool_: get_attr_id(numpy_mod, "bool_"),
string: get_attr_id(builtins_mod, "str"),
2024-06-18 14:14:12 +08:00
np_str_: get_attr_id(numpy_mod, "str_"),
float: get_attr_id(builtins_mod, "float"),
float64: get_attr_id(numpy_mod, "float64"),
list: get_attr_id(builtins_mod, "list"),
ndarray: get_attr_id(numpy_mod, "ndarray"),
tuple: get_attr_id(builtins_mod, "tuple"),
exception: get_attr_id(builtins_mod, "Exception"),
option: get_id(artiq_builtins.get_item("Option").ok().flatten().unwrap()),
};
let working_directory = tempfile::Builder::new().prefix("nac3-").tempdir().unwrap();
fs::write(working_directory.path().join("kernel.ld"), include_bytes!("kernel.ld")).unwrap();
Ok(Nac3 {
isa,
time_fns,
primitive,
builtins,
primitive_ids,
2023-12-11 15:04:35 +08:00
top_levels: Vec::default(),
pyid_to_def: Arc::default(),
working_directory,
2023-12-11 15:04:35 +08:00
string_store: Arc::default(),
exception_ids: Arc::default(),
deferred_eval_store: DeferredEvaluationStore::new(),
llvm_options: CodeGenLLVMOptions {
opt_level: OptimizationLevel::Default,
target: Nac3::get_llvm_target_options(isa),
2024-06-12 14:45:03 +08:00
},
})
}
fn analyze(&mut self, functions: &PySet, classes: &PySet) -> PyResult<()> {
let (modules, class_ids) =
Python::with_gil(|py| -> PyResult<(HashMap<u64, PyObject>, HashSet<u64>)> {
let mut modules: HashMap<u64, PyObject> = HashMap::new();
let mut class_ids: HashSet<u64> = HashSet::new();
let id_fn = PyModule::import(py, "builtins")?.getattr("id")?;
let getmodule_fn = PyModule::import(py, "inspect")?.getattr("getmodule")?;
2023-12-11 15:04:35 +08:00
for function in functions {
let module = getmodule_fn.call1((function,))?.extract()?;
modules.insert(id_fn.call1((&module,))?.extract()?, module);
}
2023-12-11 15:04:35 +08:00
for class in classes {
let module = getmodule_fn.call1((class,))?.extract()?;
modules.insert(id_fn.call1((&module,))?.extract()?, module);
class_ids.insert(id_fn.call1((class,))?.extract()?);
}
Ok((modules, class_ids))
})?;
for module in modules.into_values() {
2023-12-11 15:04:35 +08:00
self.register_module(&module, &class_ids)?;
}
Ok(())
}
fn compile_method_to_file(
&mut self,
obj: &PyAny,
method_name: &str,
args: Vec<&PyAny>,
filename: &str,
embedding_map: &PyAny,
py: Python,
) -> PyResult<()> {
let target_machine = self.get_llvm_target_machine();
2024-06-12 14:45:03 +08:00
if self.isa == Isa::Host {
let link_fn = |module: &Module| {
let working_directory = self.working_directory.path().to_owned();
target_machine
.write_to_file(module, FileType::Object, &working_directory.join("module.o"))
.expect("couldn't write module to file");
link_with_lld(
filename.to_string(),
2024-06-12 14:45:03 +08:00
working_directory.join("module.o").to_string_lossy().to_string(),
)?;
Ok(())
};
self.compile_method(obj, method_name, args, embedding_map, py, &link_fn)
2021-09-23 21:30:13 +08:00
} else {
let link_fn = |module: &Module| {
let object_mem = target_machine
.write_to_memory_buffer(module, FileType::Object)
.expect("couldn't write module to object file buffer");
if let Ok(dyn_lib) = Linker::ld(object_mem.as_slice()) {
if let Ok(mut file) = fs::File::create(filename) {
file.write_all(&dyn_lib).expect("couldn't write linked library to file");
Ok(())
} else {
Err(CompileError::new_err("failed to create file"))
}
} else {
Err(CompileError::new_err("linker failed to process object file"))
}
};
2021-09-23 21:30:13 +08:00
self.compile_method(obj, method_name, args, embedding_map, py, &link_fn)
}
2020-12-19 15:29:39 +08:00
}
2021-11-06 14:14:53 +08:00
fn compile_method_to_mem(
&mut self,
obj: &PyAny,
method_name: &str,
args: Vec<&PyAny>,
2022-02-12 21:17:37 +08:00
embedding_map: &PyAny,
2021-11-06 14:14:53 +08:00
py: Python,
) -> PyResult<PyObject> {
let target_machine = self.get_llvm_target_machine();
2024-06-12 14:45:03 +08:00
if self.isa == Isa::Host {
let link_fn = |module: &Module| {
let working_directory = self.working_directory.path().to_owned();
target_machine
2023-12-06 11:49:02 +08:00
.write_to_file(module, FileType::Object, &working_directory.join("module.o"))
.expect("couldn't write module to file");
let filename_path = self.working_directory.path().join("module.elf");
let filename = filename_path.to_str().unwrap();
link_with_lld(
filename.to_string(),
2024-06-12 14:45:03 +08:00
working_directory.join("module.o").to_string_lossy().to_string(),
)?;
Ok(PyBytes::new(py, &fs::read(filename).unwrap()).into())
};
self.compile_method(obj, method_name, args, embedding_map, py, &link_fn)
} else {
let link_fn = |module: &Module| {
let object_mem = target_machine
2023-12-06 11:49:02 +08:00
.write_to_memory_buffer(module, FileType::Object)
.expect("couldn't write module to object file buffer");
if let Ok(dyn_lib) = Linker::ld(object_mem.as_slice()) {
Ok(PyBytes::new(py, &dyn_lib).into())
} else {
Err(CompileError::new_err("linker failed to process object file"))
}
};
self.compile_method(obj, method_name, args, embedding_map, py, &link_fn)
}
2021-11-06 14:14:53 +08:00
}
2020-12-18 10:09:35 +08:00
}
2021-12-26 21:11:14 +08:00
#[cfg(feature = "init-llvm-profile")]
extern "C" {
fn __llvm_profile_initialize();
}
2020-12-18 10:09:35 +08:00
#[pymodule]
fn nac3artiq(py: Python, m: &PyModule) -> PyResult<()> {
2021-12-26 21:11:14 +08:00
#[cfg(feature = "init-llvm-profile")]
unsafe {
__llvm_profile_initialize();
}
2020-12-19 16:23:12 +08:00
Target::initialize_all(&InitializationConfig::default());
m.add("CompileError", py.get_type::<CompileError>())?;
2020-12-19 15:29:39 +08:00
m.add_class::<Nac3>()?;
2020-12-18 10:09:35 +08:00
Ok(())
}