difftreelog
feat expose and document evaluator settings
in: master
2 files changed
bindings/jsonnet/src/lib.rsdiffbeforeafterboth1use jrsonnet_evaluator::{2 create_error, create_error_result, Error, EvaluationState, ImportResolver, LazyBinding,3 LazyVal, ObjMember, ObjValue, Result, Val,4};5use jrsonnet_parser::Visibility;6use libc::{c_char, c_double, c_int, c_uint};7use std::{8 alloc::Layout,9 any::Any,10 cell::RefCell,11 collections::HashMap,12 ffi::{CStr, CString},13 fs::File,14 io::Read,15 path::PathBuf,16 rc::Rc,17};1819#[no_mangle]20#[cfg(target = "wasm32-wasi")]21pub extern "C" fn _start() {}2223#[no_mangle]24pub extern "C" fn jsonnet_version() -> &'static [u8; 8] {25 b"v0.16.0\0"26}2728#[derive(Default)]29struct NativeImportResolver {30 library_paths: RefCell<Vec<PathBuf>>,31}32impl NativeImportResolver {33 fn add_jpath(&self, path: PathBuf) {34 self.library_paths.borrow_mut().push(path);35 }36}37impl ImportResolver for NativeImportResolver {38 fn resolve_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<PathBuf>> {39 let mut new_path = from.clone();40 new_path.push(path);41 if new_path.exists() {42 Ok(Rc::new(new_path))43 } else {44 for library_path in self.library_paths.borrow().iter() {45 let mut cloned = library_path.clone();46 cloned.push(path);47 if cloned.exists() {48 return Ok(Rc::new(cloned));49 }50 }51 create_error_result(Error::ImportFileNotFound(from.clone(), path.clone()))52 }53 }54 fn load_file_contents(&self, id: &PathBuf) -> Result<Rc<str>> {55 let mut file =56 File::open(id).map_err(|_e| create_error(Error::ResolvedFileNotFound(id.clone())))?;57 let mut out = String::new();58 file.read_to_string(&mut out)59 .map_err(|_e| create_error(Error::ImportBadFileUtf8(id.clone())))?;60 Ok(out.into())61 }62 unsafe fn as_any(&self) -> &dyn Any {63 self64 }65}6667#[no_mangle]68pub extern "C" fn jsonnet_make() -> Box<EvaluationState> {69 let state = EvaluationState::default();70 state.with_stdlib();71 state.set_import_resolver(Box::new(NativeImportResolver::default()));72 Box::new(state)73}7475#[no_mangle]76pub extern "C" fn jsonnet_max_stack(vm: &EvaluationState, v: c_uint) {77 vm.set_max_stack(v as usize);78}7980// jrsonnet currently have no GC, so these functions is no-op81#[no_mangle]82pub extern "C" fn jsonnet_gc_min_objects(_vm: &EvaluationState, _v: c_uint) {}83#[no_mangle]84pub extern "C" fn jsonnet_gc_growth_trigger(_vm: &EvaluationState, _v: c_double) {}8586// TODO87#[no_mangle]88pub extern "C" fn jsonnet_string_output(_vm: &EvaluationState, _v: c_int) {89 todo!()90}9192#[no_mangle]93pub extern "C" fn jsonnet_json_extract_string(_vm: &EvaluationState, v: &Val) -> *mut c_char {94 match v.unwrap_if_lazy().unwrap() {95 Val::Str(s) => CString::new(&*s as &str).unwrap().into_raw(),96 _ => std::ptr::null_mut(),97 }98}99#[no_mangle]100pub extern "C" fn jsonnet_json_extract_number(101 _vm: &EvaluationState,102 v: &Val,103 out: &mut c_double,104) -> c_int {105 match v.unwrap_if_lazy().unwrap() {106 Val::Num(n) => {107 *out = n;108 1109 }110 _ => 0,111 }112}113#[no_mangle]114pub extern "C" fn jsonnet_json_extract_bool(_vm: &EvaluationState, v: &Val) -> c_int {115 match v.unwrap_if_lazy().unwrap() {116 Val::Bool(false) => 0,117 Val::Bool(true) => 1,118 _ => 2,119 }120}121#[no_mangle]122pub extern "C" fn jsonnet_json_extract_null(_vm: &EvaluationState, v: &Val) -> c_int {123 match v.unwrap_if_lazy().unwrap() {124 Val::Null => 1,125 _ => 0,126 }127}128129/// # Safety130///131/// This function is safe, if received v is a pointer to normal C string132#[no_mangle]133pub unsafe extern "C" fn jsonnet_json_make_string(134 _vm: &EvaluationState,135 v: *const c_char,136) -> Box<Val> {137 let cstr = CStr::from_ptr(v);138 let str = cstr.to_str().unwrap();139 Box::new(Val::Str(str.into()))140}141142#[no_mangle]143pub extern "C" fn jsonnet_json_make_number(_vm: &EvaluationState, v: c_double) -> Box<Val> {144 Box::new(Val::Num(v))145}146147#[no_mangle]148pub extern "C" fn jsonnet_json_make_bool(_vm: &EvaluationState, v: c_int) -> Box<Val> {149 assert!(v == 0 || v == 1);150 Box::new(Val::Bool(v == 1))151}152153#[no_mangle]154pub extern "C" fn jsonnet_json_make_null(_vm: &EvaluationState) -> Box<Val> {155 Box::new(Val::Null)156}157158#[no_mangle]159pub extern "C" fn jsonnet_json_make_array(_vm: &EvaluationState) -> Box<Val> {160 Box::new(Val::Arr(Rc::new(Vec::new())))161}162163#[no_mangle]164pub extern "C" fn jsonnet_json_array_append(_vm: &EvaluationState, arr: &mut Val, val: &Val) {165 match arr {166 Val::Arr(old) => {167 // TODO: Mutate array, instead of recreating them168 let mut new = Vec::new();169 new.extend(old.iter().cloned());170 new.push(val.clone());171 *arr = Val::Arr(Rc::new(new));172 }173 _ => panic!("should receive array"),174 }175}176177#[no_mangle]178pub extern "C" fn jsonnet_json_make_object(_vm: &EvaluationState) -> Box<Val> {179 Box::new(Val::Obj(ObjValue::new_empty()))180}181182/// # Safety183///184/// This function is safe if passed name is ok185#[no_mangle]186pub unsafe extern "C" fn jsonnet_json_object_append(187 _vm: &EvaluationState,188 obj: &mut Val,189 name: *const c_char,190 val: &Val,191) {192 match obj {193 Val::Obj(old) => {194 let mut new = HashMap::new();195 new.insert(196 CStr::from_ptr(name).to_str().unwrap().into(),197 ObjMember {198 add: false,199 visibility: Visibility::Normal,200 invoke: LazyBinding::Bound(LazyVal::new_resolved(val.clone())),201 location: None,202 },203 );204 let new_obj = ObjValue::new(Some(old.clone()), Rc::new(new));205 *obj = Val::Obj(new_obj);206 }207 _ => panic!("should receive array"),208 }209}210211/// # Safety212///213/// This function is most definitely broken, but it works somehow, see TODO inside214#[no_mangle]215pub unsafe extern "C" fn jsonnet_realloc(216 _vm: &EvaluationState,217 buf: *mut u8,218 sz: usize,219) -> *mut u8 {220 if buf.is_null() {221 assert!(sz != 0);222 return std::alloc::alloc(Layout::from_size_align(sz, std::mem::align_of::<u8>()).unwrap());223 }224 // TODO: Somehow store size of allocation, because its real size is probally not 16 :D225 // OR (Alternative way of fixing this TODO)226 // TODO: Standard allocator uses malloc, and it doesn't uses allocation size,227 // TODO: so it should work in normal cases. Maybe force allocator for this library?228 let old_layout = Layout::from_size_align(16, std::mem::align_of::<u8>()).unwrap();229 if sz == 0 {230 std::alloc::dealloc(buf, old_layout);231 return std::ptr::null_mut();232 }233 std::alloc::realloc(buf, old_layout, sz)234}235236#[no_mangle]237#[allow(clippy::boxed_local)]238pub extern "C" fn jsonnet_json_destroy(_vm: &EvaluationState, _v: Box<Val>) {}239240#[no_mangle]241pub extern "C" fn jsonnet_import_callback() {242 todo!()243}244#[no_mangle]245pub extern "C" fn jsonnet_native_callback() {246 todo!()247}248#[no_mangle]249pub extern "C" fn jsonnet_ext_var() {250 todo!()251}252#[no_mangle]253pub extern "C" fn jsonnet_ext_code() {254 todo!()255}256#[no_mangle]257pub extern "C" fn jsonnet_tla_var() {258 todo!()259}260#[no_mangle]261pub extern "C" fn jsonnet_tla_code() {262 todo!()263}264#[no_mangle]265pub extern "C" fn jsonnet_max_trace() {266 todo!()267}268269/// # Safety270///271/// This function is safe, if received v is a pointer to normal C string272#[no_mangle]273pub unsafe extern "C" fn jsonnet_jpath_add(vm: &EvaluationState, v: *const c_char) {274 let cstr = CStr::from_ptr(v);275 let path = PathBuf::from(cstr.to_str().unwrap());276 let any_resolver = vm.import_resolver();277 let resolver = any_resolver278 .as_any()279 .downcast_ref::<NativeImportResolver>()280 .unwrap();281 resolver.add_jpath(path);282}283284/// # Safety285///286/// This function is safe, if received v is a pointer to normal C string287#[no_mangle]288pub unsafe extern "C" fn jsonnet_evaluate_file(289 vm: &EvaluationState,290 filename: *const c_char,291 error: &mut c_int,292) -> *const c_char {293 vm.run_in_state(|| {294 use std::fmt::Write;295 let filename = CStr::from_ptr(filename);296 match vm.evaluate_file_to_json(&PathBuf::from(filename.to_str().unwrap())) {297 Ok(v) => {298 *error = 0;299 CString::new(&*v as &str).unwrap().into_raw()300 }301 Err(e) => {302 *error = 1;303 let mut out = String::new();304 writeln!(out, "{:?}", e.0).unwrap();305 for i in (e.1).0.iter() {306 writeln!(out, "{:?}", i.0).unwrap();307 }308 CString::new(&out as &str).unwrap().into_raw()309 }310 }311 })312}313314/// # Safety315///316/// This function is safe, if received v is a pointer to normal C string317#[no_mangle]318pub unsafe extern "C" fn jsonnet_evaluate_snippet(319 vm: &EvaluationState,320 filename: *const c_char,321 snippet: *const c_char,322 error: &mut c_int,323) -> *const c_char {324 vm.run_in_state(|| {325 use std::fmt::Write;326 let filename = CStr::from_ptr(filename);327 let snippet = CStr::from_ptr(snippet);328 match vm.evaluate_snippet_to_json(329 &PathBuf::from(filename.to_str().unwrap()),330 &snippet.to_str().unwrap(),331 ) {332 Ok(v) => {333 *error = 0;334 CString::new(&*v as &str).unwrap().into_raw()335 }336 Err(e) => {337 *error = 1;338 let mut out = String::new();339 writeln!(out, "{:?}", e.0).unwrap();340 for i in (e.1).0.iter() {341 writeln!(out, "{:?} ---- {}", i.0, i.1).unwrap();342 }343 CString::new(&out as &str).unwrap().into_raw()344 }345 }346 })347}348349#[no_mangle]350pub extern "C" fn jsonnet_evaluate_file_multi() {351 todo!()352}353#[no_mangle]354pub extern "C" fn jsonnet_evaluate_snippet_multi() {355 todo!()356}357#[no_mangle]358pub extern "C" fn jsonnet_evaluate_file_stream() {359 todo!()360}361#[no_mangle]362pub extern "C" fn jsonnet_evaluate_snippet_stream() {363 todo!()364}365366#[no_mangle]367#[allow(clippy::boxed_local)]368pub extern "C" fn jsonnet_destroy(_vm: Box<EvaluationState>) {}crates/jrsonnet-evaluator/src/lib.rsdiffbeforeafterboth--- a/crates/jrsonnet-evaluator/src/lib.rs
+++ b/crates/jrsonnet-evaluator/src/lib.rs
@@ -51,18 +51,23 @@
}
}
-struct EvaluationSettings {
- max_stack_frames: usize,
- max_stack_trace_size: usize,
- ext_vars: HashMap<Rc<str>, Val>,
- globals: HashMap<Rc<str>, Val>,
- import_resolver: Box<dyn ImportResolver>,
+pub struct EvaluationSettings {
+ /// Limits recursion by limiting stack frames
+ pub max_stack: usize,
+ /// Limit amount of stack trace items preserved
+ pub max_trace: usize,
+ /// Used for std.extVar
+ pub ext_vars: HashMap<Rc<str>, Val>,
+ /// Global variables are inserted in default context
+ pub globals: HashMap<Rc<str>, Val>,
+ /// Used to resolve file locations/contents
+ pub import_resolver: Box<dyn ImportResolver>,
}
impl Default for EvaluationSettings {
fn default() -> Self {
EvaluationSettings {
- max_stack_frames: 200,
- max_stack_trace_size: 20,
+ max_stack: 200,
+ max_trace: 20,
globals: Default::default(),
ext_vars: Default::default(),
import_resolver: Box::new(DummyImportResolver),
@@ -80,10 +85,16 @@
str_files: HashMap<Rc<PathBuf>, Rc<str>>,
}
-pub struct FileData(Rc<str>, LocExpr, Option<Val>);
+pub struct FileData {
+ source_code: Rc<str>,
+ parsed: LocExpr,
+ evaluated: Option<Val>,
+}
#[derive(Default)]
pub struct EvaluationStateInternals {
+ /// Internal state
data: RefCell<EvaluationData>,
+ /// Settings, safe to change at runtime
settings: RefCell<EvaluationSettings>,
}
@@ -123,71 +134,71 @@
fn data_mut(&self) -> RefMut<EvaluationData> {
self.0.data.borrow_mut()
}
- fn settings(&self) -> Ref<EvaluationSettings> {
+ pub fn settings(&self) -> Ref<EvaluationSettings> {
self.0.settings.borrow()
}
- fn settings_mut(&self) -> RefMut<EvaluationSettings> {
+ pub fn settings_mut(&self) -> RefMut<EvaluationSettings> {
self.0.settings.borrow_mut()
}
- pub fn set_import_resolver(&self, resolver: Box<dyn ImportResolver>) {
- self.settings_mut().import_resolver = resolver;
- }
- pub fn import_resolver(&self) -> Ref<dyn ImportResolver> {
- Ref::map(self.settings(), |s|&*s.import_resolver)
- }
-
- pub fn evaluate_file_to_json(
- &self,
- path: &PathBuf,
- ) -> std::result::Result<Rc<str>, LocError> {
- self.import_file(&PathBuf::new(), &path).and_then(|v|v.into_json(4))
+ pub fn evaluate_file_to_json(&self, path: &PathBuf) -> std::result::Result<Rc<str>, LocError> {
+ self.import_file(&PathBuf::new(), &path)
+ .and_then(|v| v.into_json(4))
}
pub fn evaluate_snippet_to_json(
&self,
path: &PathBuf,
snippet: &str,
) -> std::result::Result<Rc<str>, LocError> {
- self.parse_evaluate_raw_with_source(Rc::new(path.clone()), snippet).and_then(|v|v.into_json(4))
+ self.parse_evaluate_raw(Rc::new(path.clone()), snippet)
+ .and_then(|v| v.into_json(4))
}
- pub fn add_file(
- &self,
- name: Rc<PathBuf>,
- code: Rc<str>,
- ) -> std::result::Result<(), ParseError> {
- self.data_mut().files.insert(
- name.clone(),
- FileData(
- code.clone(),
- parse(
- &code,
- &ParserSettings {
- file_name: name,
- loc_data: true,
- },
- )?,
- None,
- ),
- );
+ /// Parses and adds file to loaded
+ pub fn add_file(&self, path: Rc<PathBuf>, source_code: Rc<str>) -> Result<()> {
+ self.add_parsed_file(
+ path.clone(),
+ source_code.clone(),
+ parse(
+ &source_code,
+ &ParserSettings {
+ file_name: path.clone(),
+ loc_data: true,
+ },
+ )
+ .map_err(|error| {
+ create_error(Error::ImportSyntaxError {
+ error,
+ path,
+ source_code,
+ })
+ })?,
+ )?;
Ok(())
}
+
+ /// Adds file by source code and parsed expr
pub fn add_parsed_file(
&self,
name: Rc<PathBuf>,
- code: Rc<str>,
+ source_code: Rc<str>,
parsed: LocExpr,
- ) -> std::result::Result<(), ()> {
- self.data_mut()
- .files
- .insert(name, FileData(code, parsed, None));
+ ) -> Result<()> {
+ self.data_mut().files.insert(
+ name,
+ FileData {
+ source_code,
+ parsed,
+ evaluated: None,
+ },
+ );
Ok(())
}
pub fn get_source(&self, name: &PathBuf) -> Option<Rc<str>> {
let ro_map = &self.data().files;
- ro_map.get(name).map(|value| value.0.clone())
+ ro_map.get(name).map(|value| value.source_code.clone())
}
pub fn map_source_locations(&self, file: &PathBuf, locs: &[usize]) -> Vec<CodeLocation> {
offset_to_location(&self.get_source(file).unwrap(), locs)
@@ -200,50 +211,54 @@
let value = ro_map
.get(name)
.unwrap_or_else(|| panic!("file not added: {:?}", name));
- if value.2.is_some() {
- return Ok(value.2.clone().unwrap());
+ if value.evaluated.is_some() {
+ return Ok(value.evaluated.clone().unwrap());
}
- value.1.clone()
+ value.parsed.clone()
};
let value = evaluate(self.create_default_context()?, &expr)?;
{
self.0
- .data.borrow_mut()
+ .data
+ .borrow_mut()
.files
.get_mut(name)
.unwrap()
- .2
+ .evaluated
.replace(value.clone());
}
Ok(value)
})
}
+ pub fn resolve_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<PathBuf>> {
+ Ok(self.settings().import_resolver.resolve_file(from, path)?)
+ }
+ pub fn load_file_contents(&self, path: &PathBuf) -> Result<Rc<str>> {
+ Ok(self.settings().import_resolver.load_file_contents(path)?)
+ }
pub(crate) fn import_file(&self, from: &PathBuf, path: &PathBuf) -> Result<Val> {
- let file_path = self.settings().import_resolver.resolve_file(from, path)?;
+ let file_path = self.resolve_file(from, path)?;
{
let files = &self.data().files;
if files.contains_key(&file_path) {
return self.evaluate_file(&file_path);
}
}
- let contents = self.settings().import_resolver.load_file_contents(&file_path)?;
- self.add_file(file_path.clone(), contents).map_err(|e| {
- create_error(Error::ImportSyntaxError(e))
- })?;
+ let contents = self.load_file_contents(&file_path)?;
+ self.add_file(file_path.clone(), contents)?;
self.evaluate_file(&file_path)
}
pub(crate) fn import_file_str(&self, from: &PathBuf, path: &PathBuf) -> Result<Rc<str>> {
- let path = self.settings().import_resolver.resolve_file(from, path)?;
+ let path = self.resolve_file(from, path)?;
if !self.data().str_files.contains_key(&path) {
- let file_str = self.settings().import_resolver.load_file_contents(&path)?;
- self.data_mut()
- .str_files
- .insert(path.clone(), file_str);
+ let file_str = self.load_file_contents(&path)?;
+ self.data_mut().str_files.insert(path.clone(), file_str);
}
Ok(self.data().str_files.get(&path).cloned().unwrap())
}
- pub fn parse_evaluate_raw_with_source(&self, source: Rc<PathBuf>, code: &str) -> Result<Val> {
+ /// Parses and evaluates snippet
+ pub fn parse_evaluate_raw(&self, source: Rc<PathBuf>, code: &str) -> Result<Val> {
let parsed = parse(
&code,
&ParserSettings {
@@ -254,10 +269,7 @@
.unwrap();
self.evaluate_raw(parsed)
}
- pub fn parse_evaluate_raw(&self, code: &str) -> Result<Val> {
- self.parse_evaluate_raw_with_source(Rc::new(PathBuf::from("raw.jsonnet")), code)
- }
-
+ /// Evaluates parsed expression
pub fn evaluate_raw(&self, code: LocExpr) -> Result<Val> {
self.run_in_state(|| evaluate(self.create_default_context()?, &code))
}
@@ -279,6 +291,7 @@
self
}
+ /// Creates context with all passed global variables
pub fn create_default_context(&self) -> Result<Context> {
let globals = &self.settings().globals;
let mut new_bindings: HashMap<Rc<str>, LazyBinding> = HashMap::new();
@@ -301,7 +314,7 @@
{
let mut data = self.data_mut();
let stack_depth = &mut data.stack_depth;
- if *stack_depth > self.settings().max_stack_frames {
+ if *stack_depth > self.settings().max_stack {
// Error creation uses data, so i drop guard here
drop(data);
return Err(self.error(Error::StackOverflow));