difftreelog
feat basic primop interface
in: trunk
3 files changed
crates/nix-eval/src/lib.rsdiffbeforeafterboth1use std::borrow::Cow;2use std::cell::RefCell;3use std::ffi::{CStr, CString, c_char, c_int, c_uint, c_void};4use std::ptr::null_mut;5use std::sync::LazyLock;6use std::{collections::HashMap, path::PathBuf};7use std::{fmt, slice};89use anyhow::{Context, anyhow, bail};10use serde::Serialize;11use serde::de::DeserializeOwned;1213pub use anyhow::Result;14use tracing::instrument;1516use self::logging::{ErrorInfoBuilder, nix_logging_cxx};17use self::nix_cxx::set_fetcher_setting;18use self::nix_raw::{19 BindingsBuilder as c_bindings_builder, EvalState as c_eval_state, GC_SUCCESS,20 GC_allow_register_threads, GC_get_stack_base, GC_register_my_thread, GC_stack_base,21 GC_thread_is_registered, GC_unregister_my_thread, ListBuilder as c_list_builder,22 Store as c_store, StorePath as c_store_path, alloc_value, bindings_builder_free,23 bindings_builder_insert, c_context, c_context_create, c_context_free, clear_err, err_code,24 err_info_msg, err_msg, eval_state_build, eval_state_builder_load, eval_state_builder_new,25 eval_state_builder_set_eval_setting, expr_eval_from_string, fetchers_settings,26 fetchers_settings_free, fetchers_settings_new, flake_lock, flake_lock_flags,27 flake_lock_flags_free, flake_lock_flags_new, flake_reference,28 flake_reference_and_fragment_from_string, flake_reference_parse_flags,29 flake_reference_parse_flags_free, flake_reference_parse_flags_new,30 flake_reference_parse_flags_set_base_directory, flake_settings, flake_settings_free,31 flake_settings_new, gc_now as gc_now_raw, get_attr_byname, get_attr_name_byidx, get_attrs_size,32 get_list_byidx, get_list_size, get_string, get_type, has_attr_byname, init_bool, init_int,33 init_string, libexpr_init, libstore_init, libutil_init, list_builder_free, list_builder_insert,34 locked_flake, locked_flake_free, locked_flake_get_output_attrs, make_attrs,35 make_bindings_builder, make_list, make_list_builder, realised_string, realised_string_free,36 realised_string_get_buffer_size, realised_string_get_buffer_start,37 realised_string_get_store_path, realised_string_get_store_path_count, set_err_msg, setting_set,38 state_free, store_open, store_parse_path, store_path_free, store_path_name, string_realise,39 value, value_call, value_decref, value_incref,40};4142// Contains macros helpers43pub mod logging;44#[doc(hidden)]45pub mod macros;46pub mod util;4748#[allow(49 non_upper_case_globals,50 non_camel_case_types,51 non_snake_case,52 dead_code53)]54mod nix_raw {55 include!(concat!(env!("OUT_DIR"), "/bindings.rs"));56}57#[cxx::bridge]58pub mod nix_cxx {59 unsafe extern "C++" {60 type nix_fetchers_settings;61 include!("nix-eval/src/lib.hh");6263 unsafe fn set_fetcher_setting(64 settings: *mut nix_fetchers_settings,65 setting: *const c_char,66 value: *const c_char,67 );68 }69}7071#[derive(Debug, PartialEq, Eq)]72pub enum NixType {73 Thunk,74 Int,75 Float,76 Bool,77 String,78 Path,79 Null,80 Attrs,81 List,82 Function,83 External,84}85impl NixType {86 fn from_int(c: c_uint) -> Self {87 match c {88 0 => Self::Thunk,89 1 => Self::Int,90 2 => Self::Float,91 3 => Self::Bool,92 4 => Self::String,93 5 => Self::Path,94 6 => Self::Null,95 7 => Self::Attrs,96 8 => Self::List,97 9 => Self::Function,98 10 => Self::External,99 _ => unreachable!("unknown nix type: {c}"),100 }101 }102}103104enum FunctorKind {105 Function,106 Functor,107}108109#[derive(Debug)]110#[repr(i32)]111pub enum NixErrorKind {112 Unknown = 1,113 Overflow = 2,114 Key = 3,115 Generic = 4,116}117impl NixErrorKind {118 fn from_int(v: c_int) -> Option<Self> {119 Some(match v {120 0 => return None,121 -1 => Self::Unknown,122 -2 => Self::Overflow,123 -3 => Self::Key,124 -4 => Self::Generic,125 _ => {126 debug_assert!(false, "unexpected nix error kind: {v}");127 Self::Unknown128 }129 })130 }131}132133pub fn gc_now() {134 unsafe { gc_now_raw() };135}136137pub fn gc_register_my_thread() {138 assert_eq!(unsafe { GC_thread_is_registered() }, 0);139140 let mut sb = GC_stack_base {141 mem_base: null_mut(),142 };143 let r = unsafe { GC_get_stack_base(&mut sb) };144 if r as u32 != GC_SUCCESS {145 panic!("failed to get thread stack base");146 }147 unsafe { GC_register_my_thread(&sb) };148}149pub fn gc_unregister_my_thread() {150 assert_eq!(unsafe { GC_thread_is_registered() }, 1);151152 unsafe { GC_unregister_my_thread() };153}154155pub struct ThreadRegisterGuard {}156impl ThreadRegisterGuard {157 #[allow(clippy::new_without_default)]158 pub fn new() -> Self {159 gc_register_my_thread();160 Self {}161 }162}163impl Drop for ThreadRegisterGuard {164 fn drop(&mut self) {165 gc_unregister_my_thread();166 }167}168169pub struct NixContext(*mut c_context);170impl NixContext {171 pub fn set_err(&mut self, err: NixErrorKind, msg: &CStr) {172 unsafe { set_err_msg(self.0, err as c_int, msg.as_ptr()) };173 }174 pub fn new() -> Self {175 let ctx = unsafe { c_context_create() };176 Self(ctx)177 }178 fn error_kind(&self) -> Option<NixErrorKind> {179 let code = unsafe { err_code(self.0) };180 NixErrorKind::from_int(code)181 }182 fn error<'t>(&self) -> Option<(Cow<'t, str>, Option<Box<ErrorInfoBuilder>>)> {183 if let NixErrorKind::Generic = self.error_kind()? {184 let ei = unsafe { logging::nix_logging_cxx::extract_error_info(self.0) };185 let mut err_out = String::new();186 unsafe {187 err_info_msg(188 null_mut(),189 self.0,190 Some(copy_nix_str),191 (&raw mut err_out).cast(),192 )193 };194 return Some((Cow::Owned(err_out), Some(ei)));195 };196197 // TODO: Can throw error (resulting in panic) if unable to retrieve error. Should be able to resolve by passing context as a first argument,198 // but it looks ugly199 let str = unsafe { err_msg(null_mut(), self.0, null_mut()) };200 Some((unsafe { CStr::from_ptr(str) }.to_string_lossy(), None))201 }202 fn clean_err(&mut self) {203 unsafe {204 clear_err(self.0);205 }206 }207208 fn bail_if_error(&self) -> Result<()> {209 if let Some((err, stack)) = self.error() {210 let mut e = Err(anyhow!("{err}"));211 if let Some(stack) = stack {212 for ele in stack.stack_frames {213 e = e.with_context(|| {214 if ele.pos.is_empty() {215 ele.msg216 } else {217 format!("{} at {}", ele.msg, ele.pos)218 }219 })220 }221 }222 return e.context("<nix frames>");223 };224 Ok(())225 }226227 fn run_in_context<T>(&mut self, f: impl FnOnce(*mut c_context) -> T) -> Result<T> {228 self.clean_err();229 let o = f(self.0);230 self.bail_if_error()?;231 self.clean_err();232 Ok(o)233 }234}235236impl Default for NixContext {237 fn default() -> Self {238 Self::new()239 }240}241impl Drop for NixContext {242 fn drop(&mut self) {243 unsafe {244 c_context_free(self.0);245 }246 }247}248struct GlobalState {249 // Store should be valid as long as EvalState is valid250 #[allow(dead_code)]251 store: Store,252 state: EvalState,253}254impl GlobalState {255 fn new() -> Result<Self> {256 let mut ctx = NixContext::new();257 let store = ctx258 .run_in_context(|c| unsafe { store_open(c, c"auto".as_ptr(), null_mut()) })259 .map(Store)?;260261 let builder = ctx.run_in_context(|c| unsafe { eval_state_builder_new(c, store.0) })?;262 ctx.run_in_context(|c| unsafe { eval_state_builder_load(c, builder) })?;263 ctx.run_in_context(|c| unsafe {264 eval_state_builder_set_eval_setting(265 c,266 builder,267 c"lazy-trees".as_ptr(),268 c"true".as_ptr(),269 )270 })?;271 ctx.run_in_context(|c| unsafe {272 eval_state_builder_set_eval_setting(273 c,274 builder,275 c"lazy-locks".as_ptr(),276 c"true".as_ptr(),277 )278 })?;279 let state = ctx280 .run_in_context(|c| unsafe { eval_state_build(c, builder) })281 .map(EvalState)?;282283 Ok(Self { store, state })284 }285}286287struct ThreadState {288 ctx: NixContext,289}290impl ThreadState {291 fn new() -> Result<Self> {292 let ctx = NixContext::new();293294 Ok(Self { ctx })295 }296}297298static GLOBAL_STATE: LazyLock<GlobalState> =299 LazyLock::new(|| GlobalState::new().expect("global state init shouldn't fail"));300301thread_local! {302 static THREAD_STATE: RefCell<ThreadState> = RefCell::new(ThreadState::new().expect("thread state init shouldn't fail"));303}304fn with_default_context<T>(f: impl FnOnce(*mut c_context, *mut c_eval_state) -> T) -> Result<T> {305 let global = &GLOBAL_STATE.state;306 let (ctx, state) = THREAD_STATE.with_borrow_mut(|w| (w.ctx.0, global.0));307 let mut ctx = NixContext(ctx);308 let v = ctx.run_in_context(|c| f(c, state));309 // It is reused for thread310 std::mem::forget(ctx);311 v312}313314pub fn set_setting(s: &CStr, v: &CStr) -> Result<()> {315 with_default_context(|c, _| unsafe { setting_set(c, s.as_ptr(), v.as_ptr()) }).map(|_| ())316}317318pub struct FetchSettings(*mut fetchers_settings);319impl FetchSettings {320 pub fn new() -> Self {321 Self::try_new().expect("allocation should not fail")322 }323 fn try_new() -> Result<Self> {324 with_default_context(|c, _| unsafe { fetchers_settings_new(c) }).map(Self)325 }326 pub fn set(&mut self, setting: &CStr, value: &CStr) {327 unsafe {328 set_fetcher_setting(self.0.cast(), setting.as_ptr(), value.as_ptr());329 };330 }331}332unsafe impl Send for FetchSettings {}333unsafe impl Sync for FetchSettings {}334335impl Default for FetchSettings {336 fn default() -> Self {337 Self::new()338 }339}340341impl Drop for FetchSettings {342 fn drop(&mut self) {343 unsafe { fetchers_settings_free(self.0) };344 }345}346pub struct FlakeSettings(*mut flake_settings);347impl FlakeSettings {348 pub fn new() -> Result<Self> {349 with_default_context(|c, _| unsafe { flake_settings_new(c) }).map(Self)350 }351}352unsafe impl Send for FlakeSettings {}353unsafe impl Sync for FlakeSettings {}354impl Drop for FlakeSettings {355 fn drop(&mut self) {356 unsafe {357 flake_settings_free(self.0);358 }359 }360}361362pub struct FlakeReferenceParseFlags(*mut flake_reference_parse_flags);363impl FlakeReferenceParseFlags {364 pub fn new(settings: &FlakeSettings) -> Result<Self> {365 with_default_context(|c, _| unsafe { flake_reference_parse_flags_new(c, settings.0) })366 .map(Self)367 }368 pub fn set_base_dir(&mut self, dir: &str) -> Result<()> {369 with_default_context(|c, _| {370 unsafe {371 flake_reference_parse_flags_set_base_directory(372 c,373 self.0,374 dir.as_ptr().cast(),375 dir.len(),376 )377 };378 })379 }380}381impl Drop for FlakeReferenceParseFlags {382 fn drop(&mut self) {383 unsafe {384 flake_reference_parse_flags_free(self.0);385 }386 }387}388pub struct FlakeLockFlags(*mut flake_lock_flags);389impl FlakeLockFlags {390 pub fn new(settings: &FlakeSettings) -> Result<Self> {391 let o = with_default_context(|c, _| unsafe { flake_lock_flags_new(c, settings.0) })392 .map(Self)?;393 // with_default_context(|c, _| unsafe { flake_lock_flags_set_mode_virtual(c, o.0) })?;394395 Ok(o)396 }397}398impl Drop for FlakeLockFlags {399 fn drop(&mut self) {400 unsafe {401 flake_lock_flags_free(self.0);402 }403 }404}405406unsafe extern "C" fn copy_nix_str(start: *const c_char, n: c_uint, user_data: *mut c_void) {407 let s = unsafe { slice::from_raw_parts(start.cast::<u8>(), n as usize) };408 let s = std::str::from_utf8(s).expect("c string has invalid utf-8");409 unsafe { *user_data.cast::<String>() = s.to_owned() };410}411412struct Store(*mut c_store);413unsafe impl Send for Store {}414unsafe impl Sync for Store {}415416impl Store {417 fn parse_path(&self, path: &CStr) -> Result<StorePath> {418 with_default_context(|c, _| {419 StorePath(unsafe { store_parse_path(c, self.0, path.as_ptr()) })420 })421 }422}423424struct EvalState(*mut c_eval_state);425unsafe impl Send for EvalState {}426unsafe impl Sync for EvalState {}427428impl Drop for EvalState {429 fn drop(&mut self) {430 unsafe {431 state_free(self.0);432 }433 }434}435436pub struct FlakeReference(*mut flake_reference);437impl FlakeReference {438 #[instrument(name = "new-flake-reference", skip(flake, parse, fetch))]439 pub fn new(440 s: &str,441 flake: &FlakeSettings,442 parse: &FlakeReferenceParseFlags,443 fetch: &FetchSettings,444 ) -> Result<(Self, String)> {445 let mut out = null_mut();446 let mut fragment = String::new();447 // let fetch_settings = fetcher_settings;448 with_default_context(|c, _| unsafe {449 flake_reference_and_fragment_from_string(450 c,451 fetch.0,452 flake.0,453 parse.0,454 s.as_ptr().cast(),455 s.len(),456 &mut out,457 Some(copy_nix_str),458 (&raw mut fragment).cast(),459 )460 })?;461 assert!(!out.is_null());462463 Ok((Self(out), fragment))464 }465 #[instrument(name = "lock-flake", skip(self, fetch, flake, lock))]466 pub fn lock(467 &mut self,468 fetch: &FetchSettings,469 flake: &FlakeSettings,470 lock: &FlakeLockFlags,471 ) -> Result<LockedFlake> {472 with_default_context(|c, es| unsafe { flake_lock(c, fetch.0, flake.0, es, lock.0, self.0) })473 .map(LockedFlake)474 }475}476unsafe impl Send for FlakeReference {}477unsafe impl Sync for FlakeReference {}478479pub struct LockedFlake(*mut locked_flake);480impl LockedFlake {481 pub fn get_attrs(&self, settings: &mut FlakeSettings) -> Result<Value> {482 with_default_context(|c, es| unsafe {483 locked_flake_get_output_attrs(c, settings.0, es, self.0)484 })485 .map(Value)486 }487}488unsafe impl Send for LockedFlake {}489unsafe impl Sync for LockedFlake {}490impl Drop for LockedFlake {491 fn drop(&mut self) {492 unsafe {493 locked_flake_free(self.0);494 };495 }496}497498type FieldName = [u8; 64];499fn init_field_name(v: &str) -> FieldName {500 let mut f = [0; 64];501 assert!(v.len() < 64, "max field name is 63 chars");502 assert!(503 v.bytes().all(|v| v != 0),504 "nul bytes are unsupported in field name"505 );506 f[0..v.len()].copy_from_slice(v.as_bytes());507 f508}509510pub struct RealisedString(*mut realised_string);511impl fmt::Debug for RealisedString {512 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {513 self.as_str().fmt(f)514 }515}516517impl RealisedString {518 pub fn as_str(&self) -> &str {519 let len = unsafe { realised_string_get_buffer_size(self.0) };520 let data: *const u8 = unsafe { realised_string_get_buffer_start(self.0) }.cast();521 let data = unsafe { slice::from_raw_parts(data, len) };522 std::str::from_utf8(data).expect("non-utf8 strings not supported")523 }524 pub fn path_count(&self) -> usize {525 unsafe { realised_string_get_store_path_count(self.0) }526 }527 pub fn path(&self, i: usize) -> String {528 assert!(i < self.path_count());529 let path = unsafe { realised_string_get_store_path(self.0, i) };530 let mut err_out = String::new();531 unsafe { store_path_name(path, Some(copy_nix_str), (&raw mut err_out).cast()) };532 err_out533 }534}535536unsafe impl Send for RealisedString {}537impl Drop for RealisedString {538 fn drop(&mut self) {539 unsafe { realised_string_free(self.0) }540 }541}542543pub struct Value(*mut value);544545unsafe impl Send for Value {}546unsafe impl Sync for Value {}547548pub trait AsFieldName {549 fn as_field_name<T>(&self, v: impl FnOnce(FieldName) -> Result<T>) -> Result<T>;550 fn to_field_name(&self) -> Result<String>;551}552impl AsFieldName for Value {553 fn as_field_name<T>(&self, v: impl FnOnce(FieldName) -> Result<T>) -> Result<T> {554 let f = self.to_string()?;555 v(init_field_name(&f))556 }557 fn to_field_name(&self) -> Result<String> {558 self.to_string()559 }560}561impl<E> AsFieldName for E562where563 E: AsRef<str>,564{565 fn as_field_name<T>(&self, v: impl FnOnce(FieldName) -> Result<T>) -> Result<T> {566 let f = self.as_ref();567 v(init_field_name(f))568 }569 fn to_field_name(&self) -> Result<String> {570 Ok(self.as_ref().to_owned())571 }572}573574struct AttrsBuilder(*mut c_bindings_builder);575impl AttrsBuilder {576 fn new(capacity: usize) -> Self {577 with_default_context(|c, es| unsafe { make_bindings_builder(c, es, capacity) })578 .map(Self)579 .expect("alloc should not fail")580 }581 fn insert(&mut self, k: &impl AsFieldName, v: Value) {582 k.as_field_name(|name| {583 with_default_context(|c, _| unsafe {584 bindings_builder_insert(c, self.0, name.as_ptr().cast(), v.0);585 // bindings_builder_insert doesn't do incref586 })587 })588 .expect("builder insert shouldn't fail");589 }590}591impl Drop for AttrsBuilder {592 fn drop(&mut self) {593 unsafe { bindings_builder_free(self.0) };594 }595}596597struct ListBuilder(*mut c_list_builder, c_uint);598impl ListBuilder {599 fn new(capacity: usize) -> Self {600 with_default_context(|c, es| unsafe { make_list_builder(c, es, capacity) })601 .map(|l| Self(l, 0))602 .expect("alloc should not fail")603 }604}605impl ListBuilder {606 fn push(&mut self, v: Value) {607 with_default_context(|c, _| unsafe {608 list_builder_insert(609 c,610 self.0,611 {612 let v = self.1;613 self.1 += 1;614 v615 },616 v.0,617 )618 })619 .expect("list insert shouldn't fail");620 }621}622impl Drop for ListBuilder {623 fn drop(&mut self) {624 unsafe { list_builder_free(self.0) };625 }626}627628impl Value {629 pub fn new_attrs(v: HashMap<&str, Value>) -> Self {630 let out = Self::new_uninit();631 let mut b = AttrsBuilder::new(v.len());632 for (k, v) in v {633 b.insert(&k, v);634 }635 with_default_context(|c, _| unsafe { make_attrs(c, out.0, b.0) })636 .expect("attrs initialization should not fail");637638 out639 }640 fn new_list<T: Into<Self>>(v: Vec<T>) -> Self {641 let out = Self::new_uninit();642 let mut b = ListBuilder::new(v.len());643 for v in v {644 b.push(v.into());645 }646 with_default_context(|c, _| unsafe { make_list(c, b.0, out.0) })647 .expect("list initialization should not fail");648649 out650 }651 fn new_uninit() -> Self {652 let out = with_default_context(|c, es| unsafe { alloc_value(c, es) })653 .expect("value allocation should not fail");654 Self(out)655 }656 pub fn new_str(v: &str) -> Self {657 let s = CString::new(v).expect("string should not contain NULs");658 let out = Self::new_uninit();659 // String is copied, `s` is free to be dropped660 with_default_context(|c, _| unsafe { init_string(c, out.0, s.as_ptr()) })661 .expect("string initialization should not fail");662 out663 }664 pub fn new_int(i: i64) -> Self {665 let out = Self::new_uninit();666 with_default_context(|c, _| unsafe { init_int(c, out.0, i) })667 .expect("int initialization should not fail");668 out669 }670 pub fn new_bool(v: bool) -> Self {671 let out = Self::new_uninit();672 with_default_context(|c, _| unsafe { init_bool(c, out.0, v) })673 .expect("bool initialization should not fail");674 out675 }676 // TODO: As far as I can see, there is no way to get Thunks from nix public C api, so this function is useless677 // fn force(&mut self, st: &mut EvalState) -> Result<()> {678 // with_default_context(|c, _| unsafe { value_force(c, st.0, self.0) })?;679 // Ok(())680 // }681 pub fn type_of(&self) -> NixType {682 let ty = with_default_context(|c, _| unsafe { get_type(c, self.0) })683 .expect("get_type should not fail");684 NixType::from_int(ty)685 }686 fn builtin_to_string(&self) -> Result<Self> {687 let builtin = Self::eval("builtins.toString")?;688 builtin.call(self.clone())689 }690 pub fn to_string(&self) -> Result<String> {691 let mut str_out = String::new();692 with_default_context(|c, _| unsafe {693 get_string(c, self.0, Some(copy_nix_str), (&raw mut str_out).cast())694 })?;695696 Ok(str_out)697 }698 pub fn to_realised_string(&self) -> Result<RealisedString> {699 with_default_context(|c, es| unsafe { string_realise(c, es, self.0, false) })700 .map(RealisedString)701702 // let store_paths = unsafe { nix_raw::realised_string_get_store_path_count(str) };703 // for i in 0..store_paths {704 // let store_path = unsafe { nix_raw::realised_string_get_store_path(str, i) };705 // nix_raw::store_path_name(store_path, callback, user_data);706 // }707 // dbg!(store_paths);708 // todo!();709 }710711 pub fn has_field(&self, field: &str) -> Result<bool> {712 let f = init_field_name(field);713 with_default_context(|c, es| unsafe { has_attr_byname(c, self.0, es, f.as_ptr().cast()) })714 }715 // pub fn derivation_path(&self) {716 // nix_raw::real717 // }718 pub fn list_fields(&self) -> Result<Vec<String>> {719 if !matches!(self.type_of(), NixType::Attrs) {720 bail!("invalid type: expected attrs");721 }722723 let len = with_default_context(|c, _| unsafe { get_attrs_size(c, self.0) })?;724 let mut out = Vec::with_capacity(len as usize);725726 for i in 0..len {727 let name =728 with_default_context(|c, es| unsafe { get_attr_name_byidx(c, self.0, es, i) })?;729 let c = unsafe { CStr::from_ptr(name) };730 out.push(c.to_str().expect("nix field names are utf-8").to_owned());731 }732 Ok(out)733 }734 pub fn get_elem(&self, v: usize) -> Result<Self> {735 if !matches!(self.type_of(), NixType::List) {736 bail!("invalid type: expected list");737 }738 let len = with_default_context(|c, _| unsafe { get_list_size(c, self.0) })? as usize;739 if v >= len {740 bail!("oob list get: {v} >= {len}");741 }742743 with_default_context(|c, es| unsafe { get_list_byidx(c, self.0, es, v as u32) }).map(Self)744 }745 pub fn attrs_update(self, other: Value /*, ignore_errors: bool*/) -> Result<Self> {746 let attrs_update_fn = Self::eval("a: b: a // b")?;747748 attrs_update_fn749 .call(self)?750 .call(other)751 .context("attrs update")752 }753 pub fn get_field(&self, name: impl AsFieldName) -> Result<Self> {754 if !matches!(self.type_of(), NixType::Attrs) {755 bail!("invalid type: expected attrs");756 }757758 name.as_field_name(|name| {759 with_default_context(|c, es| unsafe {760 get_attr_byname(c, self.0, es, name.as_ptr().cast())761 })762 .map(Self)763 })764 .with_context(|| format!("getting field {:?}", name.to_field_name()))765 }766 pub fn call(&self, v: Value) -> Result<Self> {767 let kind = self768 .functor_kind()769 .ok_or_else(|| anyhow!("can only call function or functor"))?;770771 let function = match kind {772 FunctorKind::Function => self.clone(),773 FunctorKind::Functor => {774 let f = self775 .get_field("__functor")776 .context("getting functor value")?;777 assert_eq!(778 f.type_of(),779 NixType::Function,780 "invalid functor encountered"781 );782 f783 }784 };785786 let out = Value::new_uninit();787 with_default_context(|c, es| unsafe { value_call(c, es, function.0, v.0, out.0) })?;788789 Ok(out)790 }791 pub fn eval(v: &str) -> Result<Self> {792 let s = CString::new(v).expect("expression shouldn't have internal NULs");793 let out = Self::new_uninit();794 with_default_context(|c, es| unsafe {795 expr_eval_from_string(c, es, s.as_ptr(), c"/root".as_ptr(), out.0)796 })?;797 Ok(out)798 }799 pub fn build(&self, output: &str) -> Result<PathBuf> {800 if !self.is_derivation() {801 bail!("expected derivation to build")802 }803 let output_name = self804 .get_field("outputName")805 .context("getting output name field")?806 .to_string()?;807 let v = if output_name != output {808 let out = self.get_field(output).context("getting target output")?;809 if !out.is_derivation() {810 bail!("unknown output: {output}");811 }812 out813 } else {814 self.clone()815 };816 // to_string here blocks until the path is built817 let s = v.builtin_to_string()?;818 let rs = s.to_realised_string()?;819 let drv_path = rs.as_str().to_owned();820 Ok(PathBuf::from(drv_path))821 }822 pub fn as_json<T: DeserializeOwned>(&self) -> Result<T> {823 let to_json = Self::eval("builtins.toJSON")?;824 let s = to_json.call(self.clone())?.to_string()?;825 Ok(serde_json::from_str(&s)?)826 }827 pub fn serialized<T: Serialize>(v: &T) -> Result<Self> {828 Self::eval(&nixlike::serialize(v)?)829 }830831 // Convert to string/evaluate derivations/etc832 // fn to_string_weak(&self) -> Result<String> {833 // // TODO: For now, it works exactly like to_string, see the comment for fn force()834 // self.to_string()835 // }836837 fn is_derivation(&self) -> bool {838 if !matches!(self.type_of(), NixType::Attrs) {839 return false;840 }841 let Some(ty) = self.get_field("type").ok() else {842 return false;843 };844 matches!(ty.to_string().as_deref(), Ok("derivation"))845 }846 fn functor_kind(&self) -> Option<FunctorKind> {847 match self.type_of() {848 NixType::Attrs => self849 .has_field("__functor")850 .expect("has_field shouldn't fail for attrs")851 .then_some(FunctorKind::Functor),852 NixType::Function => Some(FunctorKind::Function),853 _ => None,854 }855 }856 pub fn is_function(&self) -> bool {857 self.functor_kind().is_some()858 }859 pub fn is_null(&self) -> bool {860 matches!(self.type_of(), NixType::Null)861 }862}863864impl From<String> for Value {865 fn from(value: String) -> Self {866 Value::new_str(&value)867 }868}869impl From<bool> for Value {870 fn from(value: bool) -> Self {871 Value::new_bool(value)872 }873}874impl From<&str> for Value {875 fn from(value: &str) -> Self {876 Value::new_str(value)877 }878}879impl<T> From<Vec<T>> for Value880where881 T: Into<Value>,882{883 fn from(value: Vec<T>) -> Self {884 Value::new_list(value)885 }886}887888impl Clone for Value {889 fn clone(&self) -> Self {890 with_default_context(|c, _| unsafe { value_incref(c, self.0) })891 .expect("value incref should not fail");892 Self(self.0)893 }894}895impl Drop for Value {896 fn drop(&mut self) {897 with_default_context(|c, _| unsafe { value_decref(c, self.0) })898 .expect("value drop should not fail");899 }900}901902pub fn init_libraries() {903 unsafe { GC_allow_register_threads() };904905 let mut ctx = NixContext::new();906 ctx.run_in_context(|c| unsafe { libutil_init(c) })907 .expect("util init should not fail");908 ctx.run_in_context(|c| unsafe { libstore_init(c) })909 .expect("store init should not fail");910 ctx.run_in_context(|c| unsafe { libexpr_init(c) })911 .expect("expr init should not fail");912913 nix_logging_cxx::apply_tracing_logger();914}915916struct StorePath(*mut c_store_path);917impl StorePath {}918919impl Drop for StorePath {920 fn drop(&mut self) {921 unsafe { store_path_free(self.0) }922 }923}924925#[test_log::test]926fn test_native() -> Result<()> {927 init_libraries();928929 let mut fetch_settings = FetchSettings::new();930 fetch_settings.set(c"warn-dirty", c"false");931932 let manifest = format!("git+file://{}/../../", env!("CARGO_MANIFEST_DIR"));933 let flake = FlakeSettings::new()?;934 let parse = FlakeReferenceParseFlags::new(&flake)?;935 let (mut r, _) = FlakeReference::new(&manifest, &flake, &parse, &fetch_settings)?;936 let lock = FlakeLockFlags::new(&flake)?;937 let locked = r.lock(&fetch_settings, &flake, &lock)?;938 let attrs = locked.get_attrs(&mut FlakeSettings::new()?)?;939940 let builtins = Value::eval("builtins")?;941 assert_eq!(builtins.type_of(), NixType::Attrs);942943 assert_eq!(attrs.type_of(), NixType::Attrs);944 let test_data = nix_go!(attrs.testData);945946 let test_string: String = nix_go_json!(test_data.testString);947 assert_eq!(test_string, "hello");948949 let s = nix_go!(attrs.packages["x86_64-linux"].fleet.drvPath);950 let s = CString::new(s.to_string()?).expect("path str is cstring");951952 let nix_ctx = NixContext::new();953 let store = GLOBAL_STATE.store.parse_path(s.as_c_str())?;954955 // nix_raw::store_get_fs_closure(1);956957 Ok(())958}959960// pub struct GcAlloc;961// unsafe impl GlobalAlloc for GcAlloc {962// unsafe fn alloc(&self, l: Layout) -> *mut u8 {963// let ptr = unsafe { GC_malloc(l.size()) };964// ptr.cast()965// }966// unsafe fn dealloc(&self, ptr: *mut u8, _: Layout) {967// // unsafe { GC_free(ptr.cast()) };968// }969//970// unsafe fn realloc(&self, ptr: *mut u8, _: Layout, new_size: usize) -> *mut u8 {971// let ptr = unsafe { GC_realloc(ptr.cast(), new_size) };972// ptr.cast()973// }974// }975//976// #[global_allocator]977// static GC: GcAlloc = GcAlloc;1use std::borrow::Cow;2use std::cell::RefCell;3use std::ffi::{CStr, CString, c_char, c_int, c_uint, c_void};4use std::ptr::{null, null_mut};5use std::sync::LazyLock;6use std::{array, fmt, slice};7use std::{collections::HashMap, path::PathBuf};89use anyhow::{Context, anyhow, bail};10use itertools::Itertools;11use serde::Serialize;12use serde::de::DeserializeOwned;1314pub use anyhow::Result;15use tracing::instrument;1617use self::logging::{ErrorInfoBuilder, nix_logging_cxx};18use self::nix_cxx::set_fetcher_setting;19use self::nix_raw::{20 BindingsBuilder as c_bindings_builder, EvalState as c_eval_state, GC_SUCCESS,21 GC_allow_register_threads, GC_get_stack_base, GC_register_my_thread, GC_stack_base,22 GC_thread_is_registered, GC_unregister_my_thread, ListBuilder as c_list_builder, PrimOp,23 PrimOpFun, Store as c_store, StorePath as c_store_path, alloc_primop, alloc_value,24 bindings_builder_free, bindings_builder_insert, c_context, c_context_create, c_context_free,25 clear_err, copy_value, err_code, err_info_msg, err_msg, eval_state_build,26 eval_state_builder_load, eval_state_builder_new, eval_state_builder_set_eval_setting,27 expr_eval_from_string, fetchers_settings, fetchers_settings_free, fetchers_settings_new,28 flake_lock, flake_lock_flags, flake_lock_flags_free, flake_lock_flags_new, flake_reference,29 flake_reference_and_fragment_from_string, flake_reference_parse_flags,30 flake_reference_parse_flags_free, flake_reference_parse_flags_new,31 flake_reference_parse_flags_set_base_directory, flake_settings, flake_settings_free,32 flake_settings_new, gc_now as gc_now_raw, get_attr_byname, get_attr_name_byidx, get_attrs_size,33 get_list_byidx, get_list_size, get_string, get_type, has_attr_byname, init_bool, init_int,34 init_primop, init_string, libexpr_init, libstore_init, libutil_init, list_builder_free,35 list_builder_insert, locked_flake, locked_flake_free, locked_flake_get_output_attrs,36 make_attrs, make_bindings_builder, make_list, make_list_builder, realised_string,37 realised_string_free, realised_string_get_buffer_size, realised_string_get_buffer_start,38 realised_string_get_store_path, realised_string_get_store_path_count, register_primop,39 set_err_msg, setting_set, state_free, store_copy_closure, store_get_fs_closure, store_open,40 store_parse_path, store_path_free, store_path_name, string_realise, value, value_call,41 value_decref, value_incref,42};4344// Contains macros helpers45pub mod logging;46#[doc(hidden)]47pub mod macros;48pub mod util;4950#[allow(51 non_upper_case_globals,52 non_camel_case_types,53 non_snake_case,54 dead_code55)]56mod nix_raw {57 include!(concat!(env!("OUT_DIR"), "/bindings.rs"));58}59#[cxx::bridge]60pub mod nix_cxx {61 unsafe extern "C++" {62 type nix_fetchers_settings;63 include!("nix-eval/src/lib.hh");6465 unsafe fn set_fetcher_setting(66 settings: *mut nix_fetchers_settings,67 setting: *const c_char,68 value: *const c_char,69 );70 }71}7273#[derive(Debug, PartialEq, Eq)]74pub enum NixType {75 Thunk,76 Int,77 Float,78 Bool,79 String,80 Path,81 Null,82 Attrs,83 List,84 Function,85 External,86}87impl NixType {88 fn from_int(c: c_uint) -> Self {89 match c {90 0 => Self::Thunk,91 1 => Self::Int,92 2 => Self::Float,93 3 => Self::Bool,94 4 => Self::String,95 5 => Self::Path,96 6 => Self::Null,97 7 => Self::Attrs,98 8 => Self::List,99 9 => Self::Function,100 10 => Self::External,101 _ => unreachable!("unknown nix type: {c}"),102 }103 }104}105106enum FunctorKind {107 Function,108 Functor,109}110111#[derive(Debug)]112#[repr(i32)]113pub enum NixErrorKind {114 Unknown = 1,115 Overflow = 2,116 Key = 3,117 Generic = 4,118}119impl NixErrorKind {120 fn from_int(v: c_int) -> Option<Self> {121 Some(match v {122 0 => return None,123 -1 => Self::Unknown,124 -2 => Self::Overflow,125 -3 => Self::Key,126 -4 => Self::Generic,127 _ => {128 debug_assert!(false, "unexpected nix error kind: {v}");129 Self::Unknown130 }131 })132 }133}134135pub fn gc_now() {136 unsafe { gc_now_raw() };137}138139pub fn gc_register_my_thread() {140 assert_eq!(unsafe { GC_thread_is_registered() }, 0);141142 let mut sb = GC_stack_base {143 mem_base: null_mut(),144 };145 let r = unsafe { GC_get_stack_base(&mut sb) };146 if r as u32 != GC_SUCCESS {147 panic!("failed to get thread stack base");148 }149 unsafe { GC_register_my_thread(&sb) };150}151pub fn gc_unregister_my_thread() {152 assert_eq!(unsafe { GC_thread_is_registered() }, 1);153154 unsafe { GC_unregister_my_thread() };155}156157pub struct ThreadRegisterGuard {}158impl ThreadRegisterGuard {159 #[allow(clippy::new_without_default)]160 pub fn new() -> Self {161 gc_register_my_thread();162 Self {}163 }164}165impl Drop for ThreadRegisterGuard {166 fn drop(&mut self) {167 gc_unregister_my_thread();168 }169}170171#[repr(transparent)]172pub struct NixContext(*mut c_context);173impl NixContext {174 pub fn set_err(&mut self, err: NixErrorKind, msg: &CStr) {175 unsafe { set_err_msg(self.0, err as c_int, msg.as_ptr()) };176 }177 pub fn new() -> Self {178 let ctx = unsafe { c_context_create() };179 Self(ctx)180 }181 fn error_kind(&self) -> Option<NixErrorKind> {182 let code = unsafe { err_code(self.0) };183 NixErrorKind::from_int(code)184 }185 fn error<'t>(&self) -> Option<(Cow<'t, str>, Option<Box<ErrorInfoBuilder>>)> {186 if let NixErrorKind::Generic = self.error_kind()? {187 let ei = unsafe { logging::nix_logging_cxx::extract_error_info(self.0) };188 let mut err_out = String::new();189 unsafe {190 err_info_msg(191 null_mut(),192 self.0,193 Some(copy_nix_str),194 (&raw mut err_out).cast(),195 )196 };197 return Some((Cow::Owned(err_out), Some(ei)));198 };199200 // TODO: Can throw error (resulting in panic) if unable to retrieve error. Should be able to resolve by passing context as a first argument,201 // but it looks ugly202 let str = unsafe { err_msg(null_mut(), self.0, null_mut()) };203 Some((unsafe { CStr::from_ptr(str) }.to_string_lossy(), None))204 }205 fn clean_err(&mut self) {206 unsafe {207 clear_err(self.0);208 }209 }210211 fn bail_if_error(&self) -> Result<()> {212 if let Some((err, stack)) = self.error() {213 let mut e = Err(anyhow!("{err}"));214 if let Some(stack) = stack {215 for ele in stack.stack_frames {216 e = e.with_context(|| {217 if ele.pos.is_empty() {218 ele.msg219 } else {220 format!("{} at {}", ele.msg, ele.pos)221 }222 })223 }224 }225 return e.context("<nix frames>");226 };227 Ok(())228 }229230 fn run_in_context<T>(&mut self, f: impl FnOnce(*mut c_context) -> T) -> Result<T> {231 self.clean_err();232 let o = f(self.0);233 self.bail_if_error()?;234 self.clean_err();235 Ok(o)236 }237}238239impl Default for NixContext {240 fn default() -> Self {241 Self::new()242 }243}244impl Drop for NixContext {245 fn drop(&mut self) {246 unsafe {247 c_context_free(self.0);248 }249 }250}251struct GlobalState {252 // Store should be valid as long as EvalState is valid253 #[allow(dead_code)]254 store: Store,255 state: EvalState,256}257impl GlobalState {258 fn new() -> Result<Self> {259 let mut ctx = NixContext::new();260 let store = ctx261 .run_in_context(|c| unsafe { store_open(c, c"auto".as_ptr(), null_mut()) })262 .map(Store)?;263264 let builder = ctx.run_in_context(|c| unsafe { eval_state_builder_new(c, store.0) })?;265 ctx.run_in_context(|c| unsafe { eval_state_builder_load(c, builder) })?;266 ctx.run_in_context(|c| unsafe {267 eval_state_builder_set_eval_setting(268 c,269 builder,270 c"lazy-trees".as_ptr(),271 c"true".as_ptr(),272 )273 })?;274 ctx.run_in_context(|c| unsafe {275 eval_state_builder_set_eval_setting(276 c,277 builder,278 c"lazy-locks".as_ptr(),279 c"true".as_ptr(),280 )281 })?;282 let state = ctx283 .run_in_context(|c| unsafe { eval_state_build(c, builder) })284 .map(EvalState)?;285286 Ok(Self { store, state })287 }288}289290struct ThreadState {291 ctx: NixContext,292}293impl ThreadState {294 fn new() -> Result<Self> {295 let ctx = NixContext::new();296297 Ok(Self { ctx })298 }299}300301static GLOBAL_STATE: LazyLock<GlobalState> =302 LazyLock::new(|| GlobalState::new().expect("global state init shouldn't fail"));303304thread_local! {305 static THREAD_STATE: RefCell<ThreadState> = RefCell::new(ThreadState::new().expect("thread state init shouldn't fail"));306}307fn with_default_context<T>(f: impl FnOnce(*mut c_context, *mut c_eval_state) -> T) -> Result<T> {308 let global = &GLOBAL_STATE.state;309 let (ctx, state) = THREAD_STATE.with_borrow_mut(|w| (w.ctx.0, global.0));310 let mut ctx = NixContext(ctx);311 let v = ctx.run_in_context(|c| f(c, state));312 // It is reused for thread313 std::mem::forget(ctx);314 v315}316317pub fn set_setting(s: &CStr, v: &CStr) -> Result<()> {318 with_default_context(|c, _| unsafe { setting_set(c, s.as_ptr(), v.as_ptr()) }).map(|_| ())319}320321pub struct FetchSettings(*mut fetchers_settings);322impl FetchSettings {323 pub fn new() -> Self {324 Self::try_new().expect("allocation should not fail")325 }326 fn try_new() -> Result<Self> {327 with_default_context(|c, _| unsafe { fetchers_settings_new(c) }).map(Self)328 }329 pub fn set(&mut self, setting: &CStr, value: &CStr) {330 unsafe {331 set_fetcher_setting(self.0.cast(), setting.as_ptr(), value.as_ptr());332 };333 }334}335unsafe impl Send for FetchSettings {}336unsafe impl Sync for FetchSettings {}337338impl Default for FetchSettings {339 fn default() -> Self {340 Self::new()341 }342}343344impl Drop for FetchSettings {345 fn drop(&mut self) {346 unsafe { fetchers_settings_free(self.0) };347 }348}349pub struct FlakeSettings(*mut flake_settings);350impl FlakeSettings {351 pub fn new() -> Result<Self> {352 with_default_context(|c, _| unsafe { flake_settings_new(c) }).map(Self)353 }354}355unsafe impl Send for FlakeSettings {}356unsafe impl Sync for FlakeSettings {}357impl Drop for FlakeSettings {358 fn drop(&mut self) {359 unsafe {360 flake_settings_free(self.0);361 }362 }363}364365pub struct FlakeReferenceParseFlags(*mut flake_reference_parse_flags);366impl FlakeReferenceParseFlags {367 pub fn new(settings: &FlakeSettings) -> Result<Self> {368 with_default_context(|c, _| unsafe { flake_reference_parse_flags_new(c, settings.0) })369 .map(Self)370 }371 pub fn set_base_dir(&mut self, dir: &str) -> Result<()> {372 with_default_context(|c, _| {373 unsafe {374 flake_reference_parse_flags_set_base_directory(375 c,376 self.0,377 dir.as_ptr().cast(),378 dir.len(),379 )380 };381 })382 }383}384impl Drop for FlakeReferenceParseFlags {385 fn drop(&mut self) {386 unsafe {387 flake_reference_parse_flags_free(self.0);388 }389 }390}391pub struct FlakeLockFlags(*mut flake_lock_flags);392impl FlakeLockFlags {393 pub fn new(settings: &FlakeSettings) -> Result<Self> {394 let o = with_default_context(|c, _| unsafe { flake_lock_flags_new(c, settings.0) })395 .map(Self)?;396 // with_default_context(|c, _| unsafe { flake_lock_flags_set_mode_virtual(c, o.0) })?;397398 Ok(o)399 }400}401impl Drop for FlakeLockFlags {402 fn drop(&mut self) {403 unsafe {404 flake_lock_flags_free(self.0);405 }406 }407}408409unsafe extern "C" fn copy_nix_str(start: *const c_char, n: c_uint, user_data: *mut c_void) {410 let s = unsafe { slice::from_raw_parts(start.cast::<u8>(), n as usize) };411 let s = std::str::from_utf8(s).expect("c string has invalid utf-8");412 unsafe { *user_data.cast::<String>() = s.to_owned() };413}414415struct Store(*mut c_store);416unsafe impl Send for Store {}417unsafe impl Sync for Store {}418419impl Store {420 fn parse_path(&self, path: &CStr) -> Result<StorePath> {421 with_default_context(|c, _| {422 StorePath(unsafe { store_parse_path(c, self.0, path.as_ptr()) })423 })424 }425}426427struct EvalState(*mut c_eval_state);428unsafe impl Send for EvalState {}429unsafe impl Sync for EvalState {}430431impl Drop for EvalState {432 fn drop(&mut self) {433 unsafe {434 state_free(self.0);435 }436 }437}438439pub struct FlakeReference(*mut flake_reference);440impl FlakeReference {441 #[instrument(name = "new-flake-reference", skip(flake, parse, fetch))]442 pub fn new(443 s: &str,444 flake: &FlakeSettings,445 parse: &FlakeReferenceParseFlags,446 fetch: &FetchSettings,447 ) -> Result<(Self, String)> {448 let mut out = null_mut();449 let mut fragment = String::new();450 // let fetch_settings = fetcher_settings;451 with_default_context(|c, _| unsafe {452 flake_reference_and_fragment_from_string(453 c,454 fetch.0,455 flake.0,456 parse.0,457 s.as_ptr().cast(),458 s.len(),459 &mut out,460 Some(copy_nix_str),461 (&raw mut fragment).cast(),462 )463 })?;464 assert!(!out.is_null());465466 Ok((Self(out), fragment))467 }468 #[instrument(name = "lock-flake", skip(self, fetch, flake, lock))]469 pub fn lock(470 &mut self,471 fetch: &FetchSettings,472 flake: &FlakeSettings,473 lock: &FlakeLockFlags,474 ) -> Result<LockedFlake> {475 with_default_context(|c, es| unsafe { flake_lock(c, fetch.0, flake.0, es, lock.0, self.0) })476 .map(LockedFlake)477 }478}479unsafe impl Send for FlakeReference {}480unsafe impl Sync for FlakeReference {}481482pub struct LockedFlake(*mut locked_flake);483impl LockedFlake {484 pub fn get_attrs(&self, settings: &mut FlakeSettings) -> Result<Value> {485 with_default_context(|c, es| unsafe {486 locked_flake_get_output_attrs(c, settings.0, es, self.0)487 })488 .map(Value)489 }490}491unsafe impl Send for LockedFlake {}492unsafe impl Sync for LockedFlake {}493impl Drop for LockedFlake {494 fn drop(&mut self) {495 unsafe {496 locked_flake_free(self.0);497 };498 }499}500501type FieldName = [u8; 64];502fn init_field_name(v: &str) -> FieldName {503 let mut f = [0; 64];504 assert!(v.len() < 64, "max field name is 63 chars");505 assert!(506 v.bytes().all(|v| v != 0),507 "nul bytes are unsupported in field name"508 );509 f[0..v.len()].copy_from_slice(v.as_bytes());510 f511}512513pub struct RealisedString(*mut realised_string);514impl fmt::Debug for RealisedString {515 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {516 self.as_str().fmt(f)517 }518}519520impl RealisedString {521 pub fn as_str(&self) -> &str {522 let len = unsafe { realised_string_get_buffer_size(self.0) };523 let data: *const u8 = unsafe { realised_string_get_buffer_start(self.0) }.cast();524 let data = unsafe { slice::from_raw_parts(data, len) };525 std::str::from_utf8(data).expect("non-utf8 strings not supported")526 }527 pub fn path_count(&self) -> usize {528 unsafe { realised_string_get_store_path_count(self.0) }529 }530 pub fn path(&self, i: usize) -> String {531 assert!(i < self.path_count());532 let path = unsafe { realised_string_get_store_path(self.0, i) };533 let mut err_out = String::new();534 unsafe { store_path_name(path, Some(copy_nix_str), (&raw mut err_out).cast()) };535 err_out536 }537}538539unsafe impl Send for RealisedString {}540impl Drop for RealisedString {541 fn drop(&mut self) {542 unsafe { realised_string_free(self.0) }543 }544}545546#[repr(transparent)]547pub struct Value(*mut value);548549unsafe impl Send for Value {}550unsafe impl Sync for Value {}551552pub trait AsFieldName {553 fn as_field_name<T>(&self, v: impl FnOnce(FieldName) -> Result<T>) -> Result<T>;554 fn to_field_name(&self) -> Result<String>;555}556impl AsFieldName for Value {557 fn as_field_name<T>(&self, v: impl FnOnce(FieldName) -> Result<T>) -> Result<T> {558 let f = self.to_string()?;559 v(init_field_name(&f))560 }561 fn to_field_name(&self) -> Result<String> {562 self.to_string()563 }564}565impl<E> AsFieldName for E566where567 E: AsRef<str>,568{569 fn as_field_name<T>(&self, v: impl FnOnce(FieldName) -> Result<T>) -> Result<T> {570 let f = self.as_ref();571 v(init_field_name(f))572 }573 fn to_field_name(&self) -> Result<String> {574 Ok(self.as_ref().to_owned())575 }576}577578struct AttrsBuilder(*mut c_bindings_builder);579impl AttrsBuilder {580 fn new(capacity: usize) -> Self {581 with_default_context(|c, es| unsafe { make_bindings_builder(c, es, capacity) })582 .map(Self)583 .expect("alloc should not fail")584 }585 fn insert(&mut self, k: &impl AsFieldName, v: Value) {586 k.as_field_name(|name| {587 with_default_context(|c, _| unsafe {588 bindings_builder_insert(c, self.0, name.as_ptr().cast(), v.0);589 // bindings_builder_insert doesn't do incref590 })591 })592 .expect("builder insert shouldn't fail");593 }594}595impl Drop for AttrsBuilder {596 fn drop(&mut self) {597 unsafe { bindings_builder_free(self.0) };598 }599}600601struct ListBuilder(*mut c_list_builder, c_uint);602impl ListBuilder {603 fn new(capacity: usize) -> Self {604 with_default_context(|c, es| unsafe { make_list_builder(c, es, capacity) })605 .map(|l| Self(l, 0))606 .expect("alloc should not fail")607 }608}609impl ListBuilder {610 fn push(&mut self, v: Value) {611 with_default_context(|c, _| unsafe {612 list_builder_insert(613 c,614 self.0,615 {616 let v = self.1;617 self.1 += 1;618 v619 },620 v.0,621 )622 })623 .expect("list insert shouldn't fail");624 }625}626impl Drop for ListBuilder {627 fn drop(&mut self) {628 unsafe { list_builder_free(self.0) };629 }630}631632impl Value {633 pub fn new_primop(v: NativeFn) -> Self {634 let out = Self::new_uninit();635 with_default_context(|c, _| unsafe { init_primop(c, out.0, v.0) })636 .expect("primop initialization should not fail");637 out638 }639 pub fn new_attrs(v: HashMap<&str, Value>) -> Self {640 let out = Self::new_uninit();641 let mut b = AttrsBuilder::new(v.len());642 for (k, v) in v {643 b.insert(&k, v);644 }645 with_default_context(|c, _| unsafe { make_attrs(c, out.0, b.0) })646 .expect("attrs initialization should not fail");647648 out649 }650 fn new_list<T: Into<Self>>(v: Vec<T>) -> Self {651 let out = Self::new_uninit();652 let mut b = ListBuilder::new(v.len());653 for v in v {654 b.push(v.into());655 }656 with_default_context(|c, _| unsafe { make_list(c, b.0, out.0) })657 .expect("list initialization should not fail");658659 out660 }661 fn new_uninit() -> Self {662 let out = with_default_context(|c, es| unsafe { alloc_value(c, es) })663 .expect("value allocation should not fail");664 Self(out)665 }666 pub fn new_str(v: &str) -> Self {667 let s = CString::new(v).expect("string should not contain NULs");668 let out = Self::new_uninit();669 // String is copied, `s` is free to be dropped670 with_default_context(|c, _| unsafe { init_string(c, out.0, s.as_ptr()) })671 .expect("string initialization should not fail");672 out673 }674 pub fn new_int(i: i64) -> Self {675 let out = Self::new_uninit();676 with_default_context(|c, _| unsafe { init_int(c, out.0, i) })677 .expect("int initialization should not fail");678 out679 }680 pub fn new_bool(v: bool) -> Self {681 let out = Self::new_uninit();682 with_default_context(|c, _| unsafe { init_bool(c, out.0, v) })683 .expect("bool initialization should not fail");684 out685 }686 // TODO: As far as I can see, there is no way to get Thunks from nix public C api, so this function is useless687 // fn force(&mut self, st: &mut EvalState) -> Result<()> {688 // with_default_context(|c, _| unsafe { value_force(c, st.0, self.0) })?;689 // Ok(())690 // }691 pub fn type_of(&self) -> NixType {692 let ty = with_default_context(|c, _| unsafe { get_type(c, self.0) })693 .expect("get_type should not fail");694 NixType::from_int(ty)695 }696 fn builtin_to_string(&self) -> Result<Self> {697 let builtin = Self::eval("builtins.toString")?;698 builtin.call(self.clone())699 }700 pub fn to_string(&self) -> Result<String> {701 let mut str_out = String::new();702 with_default_context(|c, _| unsafe {703 get_string(c, self.0, Some(copy_nix_str), (&raw mut str_out).cast())704 })?;705706 Ok(str_out)707 }708 pub fn to_realised_string(&self) -> Result<RealisedString> {709 with_default_context(|c, es| unsafe { string_realise(c, es, self.0, false) })710 .map(RealisedString)711712 // let store_paths = unsafe { nix_raw::realised_string_get_store_path_count(str) };713 // for i in 0..store_paths {714 // let store_path = unsafe { nix_raw::realised_string_get_store_path(str, i) };715 // nix_raw::store_path_name(store_path, callback, user_data);716 // }717 // dbg!(store_paths);718 // todo!();719 }720721 pub fn has_field(&self, field: &str) -> Result<bool> {722 let f = init_field_name(field);723 with_default_context(|c, es| unsafe { has_attr_byname(c, self.0, es, f.as_ptr().cast()) })724 }725 // pub fn derivation_path(&self) {726 // nix_raw::real727 // }728 pub fn list_fields(&self) -> Result<Vec<String>> {729 if !matches!(self.type_of(), NixType::Attrs) {730 bail!("invalid type: expected attrs");731 }732733 let len = with_default_context(|c, _| unsafe { get_attrs_size(c, self.0) })?;734 let mut out = Vec::with_capacity(len as usize);735736 for i in 0..len {737 let name =738 with_default_context(|c, es| unsafe { get_attr_name_byidx(c, self.0, es, i) })?;739 let c = unsafe { CStr::from_ptr(name) };740 out.push(c.to_str().expect("nix field names are utf-8").to_owned());741 }742 Ok(out)743 }744 pub fn get_elem(&self, v: usize) -> Result<Self> {745 if !matches!(self.type_of(), NixType::List) {746 bail!("invalid type: expected list");747 }748 let len = with_default_context(|c, _| unsafe { get_list_size(c, self.0) })? as usize;749 if v >= len {750 bail!("oob list get: {v} >= {len}");751 }752753 with_default_context(|c, es| unsafe { get_list_byidx(c, self.0, es, v as u32) }).map(Self)754 }755 pub fn attrs_update(self, other: Value /*, ignore_errors: bool*/) -> Result<Self> {756 let attrs_update_fn = Self::eval("a: b: a // b")?;757758 attrs_update_fn759 .call(self)?760 .call(other)761 .context("attrs update")762 }763 pub fn get_field(&self, name: impl AsFieldName) -> Result<Self> {764 if !matches!(self.type_of(), NixType::Attrs) {765 bail!("invalid type: expected attrs");766 }767768 name.as_field_name(|name| {769 with_default_context(|c, es| unsafe {770 get_attr_byname(c, self.0, es, name.as_ptr().cast())771 })772 .map(Self)773 })774 .with_context(|| format!("getting field {:?}", name.to_field_name()))775 }776 pub fn call(&self, v: Value) -> Result<Self> {777 let kind = self778 .functor_kind()779 .ok_or_else(|| anyhow!("can only call function or functor"))?;780781 let function = match kind {782 FunctorKind::Function => self.clone(),783 FunctorKind::Functor => {784 let f = self785 .get_field("__functor")786 .context("getting functor value")?;787 assert_eq!(788 f.type_of(),789 NixType::Function,790 "invalid functor encountered"791 );792 f793 }794 };795796 let out = Value::new_uninit();797 with_default_context(|c, es| unsafe { value_call(c, es, function.0, v.0, out.0) })?;798799 Ok(out)800 }801 pub fn eval(v: &str) -> Result<Self> {802 let s = CString::new(v).expect("expression shouldn't have internal NULs");803 let out = Self::new_uninit();804 with_default_context(|c, es| unsafe {805 expr_eval_from_string(c, es, s.as_ptr(), c"/root".as_ptr(), out.0)806 })?;807 Ok(out)808 }809 pub fn build(&self, output: &str) -> Result<PathBuf> {810 if !self.is_derivation() {811 bail!("expected derivation to build")812 }813 let output_name = self814 .get_field("outputName")815 .context("getting output name field")?816 .to_string()?;817 let v = if output_name != output {818 let out = self.get_field(output).context("getting target output")?;819 if !out.is_derivation() {820 bail!("unknown output: {output}");821 }822 out823 } else {824 self.clone()825 };826 // to_string here blocks until the path is built827 let s = v.builtin_to_string()?;828 let rs = s.to_realised_string()?;829 let drv_path = rs.as_str().to_owned();830 Ok(PathBuf::from(drv_path))831 }832 pub fn as_json<T: DeserializeOwned>(&self) -> Result<T> {833 let to_json = Self::eval("builtins.toJSON")?;834 let s = to_json.call(self.clone())?.to_string()?;835 Ok(serde_json::from_str(&s)?)836 }837 pub fn serialized<T: Serialize>(v: &T) -> Result<Self> {838 Self::eval(&nixlike::serialize(v)?)839 }840841 // Convert to string/evaluate derivations/etc842 // fn to_string_weak(&self) -> Result<String> {843 // // TODO: For now, it works exactly like to_string, see the comment for fn force()844 // self.to_string()845 // }846847 fn is_derivation(&self) -> bool {848 if !matches!(self.type_of(), NixType::Attrs) {849 return false;850 }851 let Some(ty) = self.get_field("type").ok() else {852 return false;853 };854 matches!(ty.to_string().as_deref(), Ok("derivation"))855 }856 fn functor_kind(&self) -> Option<FunctorKind> {857 match self.type_of() {858 NixType::Attrs => self859 .has_field("__functor")860 .expect("has_field shouldn't fail for attrs")861 .then_some(FunctorKind::Functor),862 NixType::Function => Some(FunctorKind::Function),863 _ => None,864 }865 }866 pub fn is_function(&self) -> bool {867 self.functor_kind().is_some()868 }869 pub fn is_null(&self) -> bool {870 matches!(self.type_of(), NixType::Null)871 }872}873874impl From<String> for Value {875 fn from(value: String) -> Self {876 Value::new_str(&value)877 }878}879impl From<bool> for Value {880 fn from(value: bool) -> Self {881 Value::new_bool(value)882 }883}884impl From<&str> for Value {885 fn from(value: &str) -> Self {886 Value::new_str(value)887 }888}889impl<T> From<Vec<T>> for Value890where891 T: Into<Value>,892{893 fn from(value: Vec<T>) -> Self {894 Value::new_list(value)895 }896}897898impl Clone for Value {899 fn clone(&self) -> Self {900 with_default_context(|c, _| unsafe { value_incref(c, self.0) })901 .expect("value incref should not fail");902 Self(self.0)903 }904}905impl Drop for Value {906 fn drop(&mut self) {907 with_default_context(|c, _| unsafe { value_decref(c, self.0) })908 .expect("value drop should not fail");909 }910}911912pub fn init_libraries() {913 unsafe { GC_allow_register_threads() };914915 let mut ctx = NixContext::new();916 ctx.run_in_context(|c| unsafe { libutil_init(c) })917 .expect("util init should not fail");918 ctx.run_in_context(|c| unsafe { libstore_init(c) })919 .expect("store init should not fail");920 ctx.run_in_context(|c| unsafe { libexpr_init(c) })921 .expect("expr init should not fail");922923 nix_logging_cxx::apply_tracing_logger();924}925926unsafe extern "C" fn nix_primop_closure_adapter<const N: usize>(927 user_data: *mut c_void,928 context: *mut c_context,929 state: *mut nix_raw::EvalState,930 args: *mut *mut value,931 ret: *mut value,932) {933 let user_closure: &UserClosure<N> = unsafe { &*user_data.cast_const().cast() };934 let args: [&Value; N] = array::from_fn(|i| {935 let v: &Value = unsafe { &*args.add(i).cast_const().cast() };936 v937 });938 let ctx: &mut NixContext = unsafe { &mut *context.cast() };939940 match user_closure(args) {941 Ok(v) => {942 unsafe { copy_value(context, ret, v.0) };943 }944 Err(e) => {945 ctx.set_err(946 NixErrorKind::Unknown,947 &CString::new(e.to_string()).expect("error should not contain internal nuls"),948 );949 }950 }951}952953type UserClosure<const N: usize> = Box<dyn Fn([&Value; N]) -> Result<Value>>;954955struct NativeFn(*mut PrimOp);956impl NativeFn {957 pub fn new<const N: usize>(958 name: &'static CStr,959 doc: &'static CStr,960 args: [&'static CStr; N],961 f: impl Fn([&Value; N]) -> Result<Value> + 'static,962 ) -> Self {963 // Double-boxing to make it thin pointer, as vtable gets outside of first Box964 let closure: Box<UserClosure<N>> = Box::new(Box::new(f));965 let f: PrimOpFun = Some(nix_primop_closure_adapter::<N>);966 let mut args = args.into_iter().map(|v| v.as_ptr()).collect_vec();967 args.push(null());968 let args = args.as_mut_ptr();969 let primop = with_default_context(|c, _| unsafe {970 alloc_primop(971 c,972 f,973 N as i32,974 name.as_ptr(),975 args,976 doc.as_ptr(),977 Box::into_raw(closure).cast(),978 )979 })980 .expect("primop allocation should not fail");981982 Self(primop)983 }984 pub fn register(self) {985 with_default_context(|c, _| unsafe { register_primop(c, self.0) })986 .expect("primop registration should not fail");987 }988}989990struct StorePath(*mut c_store_path);991impl StorePath {}992993impl Drop for StorePath {994 fn drop(&mut self) {995 unsafe { store_path_free(self.0) }996 }997}998999#[test_log::test]1000fn test_native() -> Result<()> {1001 init_libraries();10021003 let mut fetch_settings = FetchSettings::new();1004 fetch_settings.set(c"warn-dirty", c"false");10051006 let manifest = format!("git+file://{}/../../", env!("CARGO_MANIFEST_DIR"));1007 let flake = FlakeSettings::new()?;1008 let parse = FlakeReferenceParseFlags::new(&flake)?;1009 let (mut r, _) = FlakeReference::new(&manifest, &flake, &parse, &fetch_settings)?;1010 let lock = FlakeLockFlags::new(&flake)?;1011 let locked = r.lock(&fetch_settings, &flake, &lock)?;1012 let attrs = locked.get_attrs(&mut FlakeSettings::new()?)?;10131014 let builtins = Value::eval("builtins")?;1015 assert_eq!(builtins.type_of(), NixType::Attrs);10161017 assert_eq!(attrs.type_of(), NixType::Attrs);1018 let test_data = nix_go!(attrs.testData);10191020 let test_string: String = nix_go_json!(test_data.testString);1021 assert_eq!(test_string, "hello");10221023 let s = nix_go!(attrs.packages["x86_64-linux"].fleet.drvPath);1024 let s = CString::new(s.to_string()?).expect("path str is cstring");10251026 let uppercase_suffix = Value::new_primop(NativeFn::new(1027 c"uppercase_suffix",1028 c"make string uppercase and add suffix",1029 [c"str", c"suffix"],1030 |[str, suffix]: [&Value; 2]| {1031 let str = str.to_string()?;1032 let suffix = suffix.to_string()?;1033 Ok(Value::new_str(&format!("{}{suffix}", str.to_uppercase())))1034 },1035 ));10361037 let test_result: String = nix_go_json!(test_data.testPrimop(uppercase_suffix));1038 assert_eq!(test_result, "PREFIX_BODY_SUFFIX");10391040 let nix_ctx = NixContext::new();1041 let store = GLOBAL_STATE.store.parse_path(s.as_c_str())?;10421043 // nix_raw::store_get_fs_closure(1);10441045 Ok(())1046}10471048// pub struct GcAlloc;1049// unsafe impl GlobalAlloc for GcAlloc {1050// unsafe fn alloc(&self, l: Layout) -> *mut u8 {1051// let ptr = unsafe { GC_malloc(l.size()) };1052// ptr.cast()1053// }1054// unsafe fn dealloc(&self, ptr: *mut u8, _: Layout) {1055// // unsafe { GC_free(ptr.cast()) };1056// }1057//1058// unsafe fn realloc(&self, ptr: *mut u8, _: Layout, new_size: usize) -> *mut u8 {1059// let ptr = unsafe { GC_realloc(ptr.cast(), new_size) };1060// ptr.cast()1061// }1062// }1063//1064// #[global_allocator]1065// static GC: GcAlloc = GcAlloc;flake.lockdiffbeforeafterboth--- a/flake.lock
+++ b/flake.lock
@@ -2,11 +2,10 @@
"nodes": {
"crane": {
"locked": {
- "lastModified": 1762538466,
- "narHash": "sha256-8zrIPl6J+wLm9MH5ksHcW7BUHo7jSNOu0/hA0ohOOaM=",
+ "lastModified": 1763511871,
"owner": "ipetkov",
"repo": "crane",
- "rev": "0cea393fffb39575c46b7a0318386467272182fe",
+ "rev": "099f9014bc8d0cd6e445470ea1df0fd691d5a548",
"type": "github"
},
"original": {
@@ -38,11 +37,10 @@
]
},
"locked": {
- "lastModified": 1762810396,
- "narHash": "sha256-dxFVgQPG+R72dkhXTtqUm7KpxElw3u6E+YlQ2WaDgt8=",
+ "lastModified": 1763759067,
"owner": "hercules-ci",
"repo": "flake-parts",
- "rev": "0bdadb1b265fb4143a75bd1ec7d8c915898a9923",
+ "rev": "2cccadc7357c0ba201788ae99c4dfa90728ef5e0",
"type": "github"
},
"original": {
@@ -51,26 +49,6 @@
"type": "github"
}
},
- "flake-parts_2": {
- "inputs": {
- "nixpkgs-lib": [
- "nix",
- "nixpkgs"
- ]
- },
- "locked": {
- "lastModified": 1748821116,
- "narHash": "sha256-F82+gS044J1APL0n4hH50GYdPRv/5JWm34oCJYmVKdE=",
- "rev": "49f0870db23e8c1ca0b5259734a02cd9e1e371a1",
- "revCount": 377,
- "type": "tarball",
- "url": "https://api.flakehub.com/f/pinned/hercules-ci/flake-parts/0.1.377%2Brev-49f0870db23e8c1ca0b5259734a02cd9e1e371a1/01972f28-554a-73f8-91f4-d488cc502f08/source.tar.gz"
- },
- "original": {
- "type": "tarball",
- "url": "https://flakehub.com/f/hercules-ci/flake-parts/0.1"
- }
- },
"fleet-tf": {
"inputs": {
"flake-parts": [
@@ -85,7 +63,6 @@
},
"locked": {
"lastModified": 1759080490,
- "narHash": "sha256-6eog70ItEoiusftwCp1vjY/7kA1+BDTUuRwg4KmszUs=",
"owner": "CertainLach",
"repo": "fleet-tf",
"rev": "878bd8c23933d628bf750378bbe527b841901c3d",
@@ -123,18 +100,21 @@
},
"nix": {
"inputs": {
- "flake-parts": "flake-parts_2",
+ "flake-parts": [
+ "flake-parts"
+ ],
"git-hooks-nix": "git-hooks-nix",
- "nixpkgs": "nixpkgs",
+ "nixpkgs": [
+ "nixpkgs"
+ ],
"nixpkgs-23-11": "nixpkgs-23-11",
"nixpkgs-regression": "nixpkgs-regression"
},
"locked": {
- "lastModified": 1762216145,
- "narHash": "sha256-ff2SX5zKVsOAvN84AT+81TmWob5B5dxlkMcFexPZHAA=",
+ "lastModified": 1763844027,
"owner": "deltarocks",
"repo": "nix",
- "rev": "dece43d5bae876aa475033d5a5a389b478b1644e",
+ "rev": "6b07ab20f1a65bd4aa54ec1418ff6f179dde64ac",
"type": "github"
},
"original": {
@@ -146,16 +126,17 @@
},
"nixpkgs": {
"locked": {
- "lastModified": 1755922037,
- "narHash": "sha256-wY1+2JPH0ZZC4BQefoZw/k+3+DowFyfOxv17CN/idKs=",
- "rev": "b1b3291469652d5a2edb0becc4ef0246fff97a7c",
- "revCount": 808723,
- "type": "tarball",
- "url": "https://api.flakehub.com/f/pinned/NixOS/nixpkgs/0.2505.808723%2Brev-b1b3291469652d5a2edb0becc4ef0246fff97a7c/0198daf7-011a-7703-95d7-57146e794342/source.tar.gz"
+ "lastModified": 1763844746,
+ "owner": "nixos",
+ "repo": "nixpkgs",
+ "rev": "d20f025296df84f7d97dee7c1a069bea8b17c8f2",
+ "type": "github"
},
"original": {
- "type": "tarball",
- "url": "https://flakehub.com/f/NixOS/nixpkgs/0.2505"
+ "owner": "nixos",
+ "ref": "release-25.05",
+ "repo": "nixpkgs",
+ "type": "github"
}
},
"nixpkgs-23-11": {
@@ -190,29 +171,13 @@
"type": "github"
}
},
- "nixpkgs_2": {
- "locked": {
- "lastModified": 1762881507,
- "narHash": "sha256-P59mF2fC4/ijf5ZoCQA+wcaN6b0OgKKA3BQZpfPqHtY=",
- "owner": "nixos",
- "repo": "nixpkgs",
- "rev": "2bbfb713196ae4cf5428530e8387cadcf95d3e2f",
- "type": "github"
- },
- "original": {
- "owner": "nixos",
- "ref": "release-25.05",
- "repo": "nixpkgs",
- "type": "github"
- }
- },
"root": {
"inputs": {
"crane": "crane",
"flake-parts": "flake-parts",
"fleet-tf": "fleet-tf",
"nix": "nix",
- "nixpkgs": "nixpkgs_2",
+ "nixpkgs": "nixpkgs",
"rust-overlay": "rust-overlay",
"shelly": "shelly",
"treefmt-nix": "treefmt-nix"
@@ -225,11 +190,10 @@
]
},
"locked": {
- "lastModified": 1762828736,
- "narHash": "sha256-RxtFHWZpKwVcWHhx88E2NhWuBbgYVqIoIDynGs5FoJs=",
+ "lastModified": 1763778964,
"owner": "oxalica",
"repo": "rust-overlay",
- "rev": "8d5baa5628f6dbd7ce6beca3c299bae27755204c",
+ "rev": "7f3aa46dfa230ec2a4ca9281186a24771650ccd1",
"type": "github"
},
"original": {
@@ -241,7 +205,6 @@
"shelly": {
"locked": {
"lastModified": 1756323923,
- "narHash": "sha256-sKUaQrgnYVBmG5cGmGoFYXc61g74ufWpPYGPoJia58k=",
"owner": "CertainLach",
"repo": "shelly",
"rev": "b5dd29a500db04f54a9f1c2bf81cdd84df8b0cd7",
@@ -260,11 +223,10 @@
]
},
"locked": {
- "lastModified": 1762410071,
- "narHash": "sha256-aF5fvoZeoXNPxT0bejFUBXeUjXfHLSL7g+mjR/p5TEg=",
+ "lastModified": 1762938485,
"owner": "numtide",
"repo": "treefmt-nix",
- "rev": "97a30861b13c3731a84e09405414398fbf3e109f",
+ "rev": "5b4ee75aeefd1e2d5a1cc43cf6ba65eba75e83e4",
"type": "github"
},
"original": {
flake.nixdiffbeforeafterboth--- a/flake.nix
+++ b/flake.nix
@@ -25,7 +25,11 @@
};
# DeterminateSystem's nix fork is controversial, but I don't mind it,
# and it has lazy-trees support which is useful for fleet.
- nix.url = "github:deltarocks/nix/fleet";
+ nix = {
+ url = "github:deltarocks/nix/fleet";
+ inputs.nixpkgs.follows = "nixpkgs";
+ inputs.flake-parts.follows = "flake-parts";
+ };
};
outputs =
inputs:
@@ -56,6 +60,7 @@
v = "Hello";
};
testString = "hello";
+ testPrimop = op: "PREFIX_" + (op "body" "_SUFFIX");
};
# To be used with https://github.com/NixOS/nix/pull/8892