1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
//! Utils to compile script to bytecode and run script from bytecode
use crate::jsutils::JsError;
use crate::jsutils::Script;
use crate::quickjsrealmadapter::QuickJsRealmAdapter;
use crate::quickjsruntimeadapter::make_cstring;
use crate::quickjsvalueadapter::QuickJsValueAdapter;
use libquickjs_sys as q;
use std::os::raw::c_void;
/// compile a script, will result in a JSValueRef with tag JS_TAG_FUNCTION_BYTECODE or JS_TAG_MODULE.
/// It can be executed with run_compiled_function().
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::jsutils::Script;
/// use quickjs_runtime::quickjs_utils::primitives;
/// use quickjs_runtime::quickjs_utils::compile::{compile, run_compiled_function};
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// unsafe {
/// let q_ctx = q_js_rt.get_main_realm();
/// let func_res = compile(q_ctx.context, Script::new("test_func.es", "let a = 7; let b = 5; a * b;"));
/// let func = func_res.ok().expect("func compile failed");
/// let run_res = run_compiled_function(q_ctx.context, &func);
/// let res = run_res.ok().expect("run_compiled_function failed");
/// let i_res = primitives::to_i32(&res);
/// let i = i_res.ok().expect("could not convert to i32");
/// assert_eq!(i, 7*5);
/// }
/// });
/// ```
/// # Safety
/// When passing a context pointer please make sure the corresponding QuickJsContext is still valid
pub unsafe fn compile(
context: *mut q::JSContext,
script: Script,
) -> Result<QuickJsValueAdapter, JsError> {
let filename_c = make_cstring(script.get_path())?;
let code_str = script.get_runnable_code();
let code_c = make_cstring(code_str)?;
log::debug!("q_js_rt.compile file {}", script.get_path());
let value_raw = q::JS_Eval(
context,
code_c.as_ptr(),
code_str.len() as _,
filename_c.as_ptr(),
q::JS_EVAL_FLAG_COMPILE_ONLY as i32,
);
log::trace!("after compile, checking error");
// check for error
let ret = QuickJsValueAdapter::new(
context,
value_raw,
false,
true,
format!("eval result of {}", script.get_path()).as_str(),
);
if ret.is_exception() {
let ex_opt = QuickJsRealmAdapter::get_exception(context);
if let Some(ex) = ex_opt {
Err(ex)
} else {
Err(JsError::new_str(
"compile failed and could not get exception",
))
}
} else {
Ok(ret)
}
}
/// run a compiled function, see compile for an example
/// # Safety
/// When passing a context pointer please make sure the corresponding QuickJsContext is still valid
pub unsafe fn run_compiled_function(
context: *mut q::JSContext,
compiled_func: &QuickJsValueAdapter,
) -> Result<QuickJsValueAdapter, JsError> {
assert!(compiled_func.is_compiled_function());
let val = q::JS_EvalFunction(context, compiled_func.clone_value_incr_rc());
let val_ref =
QuickJsValueAdapter::new(context, val, false, true, "run_compiled_function result");
if val_ref.is_exception() {
let ex_opt = QuickJsRealmAdapter::get_exception(context);
if let Some(ex) = ex_opt {
Err(ex)
} else {
Err(JsError::new_str(
"run_compiled_function failed and could not get exception",
))
}
} else {
Ok(val_ref)
}
}
/// write a function to bytecode
/// # Example
/// ```rust
/// use quickjs_runtime::builder::QuickJsRuntimeBuilder;
/// use quickjs_runtime::jsutils::Script;
/// use quickjs_runtime::quickjs_utils::primitives;
/// use quickjs_runtime::quickjs_utils::compile::{compile, run_compiled_function, to_bytecode, from_bytecode};
/// let rt = QuickJsRuntimeBuilder::new().build();
/// rt.exe_rt_task_in_event_loop(|q_js_rt| {
/// unsafe {
/// let q_ctx = q_js_rt.get_main_realm();
/// let func_res = compile(q_ctx.context, Script::new("test_func.es", "let a = 7; let b = 5; a * b;"));
/// let func = func_res.ok().expect("func compile failed");
/// let bytecode: Vec<u8> = to_bytecode(q_ctx.context, &func);
/// drop(func);
/// assert!(!bytecode.is_empty());
/// let func2_res = from_bytecode(q_ctx.context, &bytecode);
/// let func2 = func2_res.ok().expect("could not read bytecode");
/// let run_res = run_compiled_function(q_ctx.context, &func2);
/// let res = run_res.ok().expect("run_compiled_function failed");
/// let i_res = primitives::to_i32(&res);
/// let i = i_res.ok().expect("could not convert to i32");
/// assert_eq!(i, 7*5);
/// }
/// });
/// ```
/// # Safety
/// When passing a context pointer please make sure the corresponding QuickJsContext is still valid
pub unsafe fn to_bytecode(
context: *mut q::JSContext,
compiled_func: &QuickJsValueAdapter,
) -> Vec<u8> {
assert!(compiled_func.is_compiled_function() || compiled_func.is_module());
let mut len = 0;
let slice_u8 = q::JS_WriteObject(
context,
&mut len,
*compiled_func.borrow_value(),
q::JS_WRITE_OBJ_BYTECODE as i32,
);
let slice = std::slice::from_raw_parts(slice_u8, len as _);
// it's a shame to copy the vec here but the alternative is to create a wrapping struct which free's the ptr on drop
let ret = slice.to_vec();
q::js_free(context, slice_u8 as *mut c_void);
ret
}
/// read a compiled function from bytecode, see to_bytecode for an example
/// # Safety
/// When passing a context pointer please make sure the corresponding QuickJsContext is still valid
pub unsafe fn from_bytecode(
context: *mut q::JSContext,
bytecode: &[u8],
) -> Result<QuickJsValueAdapter, JsError> {
assert!(!bytecode.is_empty());
{
let len = bytecode.len();
let buf = bytecode.as_ptr();
let raw = q::JS_ReadObject(context, buf, len as _, q::JS_READ_OBJ_BYTECODE as i32);
let func_ref = QuickJsValueAdapter::new(context, raw, false, true, "from_bytecode result");
if func_ref.is_exception() {
let ex_opt = QuickJsRealmAdapter::get_exception(context);
if let Some(ex) = ex_opt {
Err(ex)
} else {
Err(JsError::new_str(
"from_bytecode failed and could not get exception",
))
}
} else {
Ok(func_ref)
}
}
}
#[cfg(test)]
pub mod tests {
use crate::builder::QuickJsRuntimeBuilder;
use crate::facades::tests::init_test_rt;
use crate::jsutils::modules::CompiledModuleLoader;
use crate::jsutils::Script;
use crate::quickjs_utils::compile::{
compile, from_bytecode, run_compiled_function, to_bytecode,
};
use crate::quickjs_utils::modules::compile_module;
use crate::quickjs_utils::primitives;
use crate::quickjsrealmadapter::QuickJsRealmAdapter;
use crate::values::JsValueFacade;
//use backtrace::Backtrace;
use futures::executor::block_on;
use std::panic;
use std::sync::Arc;
#[test]
fn test_compile() {
let rt = init_test_rt();
rt.exe_rt_task_in_event_loop(|q_js_rt| {
let q_ctx = q_js_rt.get_main_realm();
let func_res = unsafe {
compile(
q_ctx.context,
Script::new(
"test_func.es",
"let a_tb3 = 7; let b_tb3 = 5; a_tb3 * b_tb3;",
),
)
};
let func = func_res.expect("func compile failed");
let bytecode: Vec<u8> = unsafe { to_bytecode(q_ctx.context, &func) };
drop(func);
assert!(!bytecode.is_empty());
let func2_res = unsafe { from_bytecode(q_ctx.context, &bytecode) };
let func2 = func2_res.expect("could not read bytecode");
let run_res = unsafe { run_compiled_function(q_ctx.context, &func2) };
match run_res {
Ok(res) => {
let i_res = primitives::to_i32(&res);
let i = i_res.expect("could not convert to i32");
assert_eq!(i, 7 * 5);
}
Err(e) => {
panic!("run failed1: {}", e);
}
}
});
}
#[test]
fn test_bytecode() {
let rt = init_test_rt();
rt.exe_rt_task_in_event_loop(|q_js_rt| unsafe {
let q_ctx = q_js_rt.get_main_realm();
let func_res = compile(
q_ctx.context,
Script::new(
"test_func.es",
"let a_tb4 = 7; let b_tb4 = 5; a_tb4 * b_tb4;",
),
);
let func = func_res.expect("func compile failed");
let bytecode: Vec<u8> = to_bytecode(q_ctx.context, &func);
drop(func);
assert!(!bytecode.is_empty());
let func2_res = from_bytecode(q_ctx.context, &bytecode);
let func2 = func2_res.expect("could not read bytecode");
let run_res = run_compiled_function(q_ctx.context, &func2);
match run_res {
Ok(res) => {
let i_res = primitives::to_i32(&res);
let i = i_res.expect("could not convert to i32");
assert_eq!(i, 7 * 5);
}
Err(e) => {
panic!("run failed: {}", e);
}
}
});
}
#[test]
fn test_bytecode_bad_compile() {
let rt = QuickJsRuntimeBuilder::new().build();
rt.exe_rt_task_in_event_loop(|q_js_rt| {
let q_ctx = q_js_rt.get_main_realm();
let func_res = unsafe {
compile(
q_ctx.context,
Script::new(
"test_func_fail.es",
"{the changes of me compil1ng a're slim to 0-0}",
),
)
};
func_res.expect_err("func compiled unexpectedly");
})
}
#[test]
fn test_bytecode_bad_run() {
let rt = QuickJsRuntimeBuilder::new().build();
rt.exe_rt_task_in_event_loop(|q_js_rt| unsafe {
let q_ctx = q_js_rt.get_main_realm();
let func_res = compile(
q_ctx.context,
Script::new("test_func_runfail.es", "let abcdef = 1;"),
);
let func = func_res.expect("func compile failed");
assert_eq!(1, func.get_ref_count());
let bytecode: Vec<u8> = to_bytecode(q_ctx.context, &func);
assert_eq!(1, func.get_ref_count());
drop(func);
assert!(!bytecode.is_empty());
let func2_res = from_bytecode(q_ctx.context, &bytecode);
let func2 = func2_res.expect("could not read bytecode");
//should fail the second time you run this because abcdef is already defined
assert_eq!(1, func2.get_ref_count());
let run_res1 =
run_compiled_function(q_ctx.context, &func2).expect("run 1 failed unexpectedly");
drop(run_res1);
assert_eq!(1, func2.get_ref_count());
let _run_res2 = run_compiled_function(q_ctx.context, &func2)
.expect_err("run 2 succeeded unexpectedly");
assert_eq!(1, func2.get_ref_count());
});
}
lazy_static! {
static ref COMPILED_BYTES: Arc<Vec<u8>> = init_bytes();
}
fn init_bytes() -> Arc<Vec<u8>> {
// in order to init our bytes fgor our module we lazy init a rt
let rt = QuickJsRuntimeBuilder::new().build();
rt.loop_realm_sync(None, |_rt, realm| unsafe {
let script = Script::new(
"test_module.js",
"export function someFunction(a, b){return a*b;};",
);
let module = compile_module(realm.context, script).expect("compile failed");
Arc::new(to_bytecode(realm.context, &module))
})
}
struct Cml {}
impl CompiledModuleLoader for Cml {
fn normalize_path(
&self,
_q_ctx: &QuickJsRealmAdapter,
_ref_path: &str,
path: &str,
) -> Option<String> {
Some(path.to_string())
}
fn load_module(&self, _q_ctx: &QuickJsRealmAdapter, _absolute_path: &str) -> Arc<Vec<u8>> {
COMPILED_BYTES.clone()
}
}
#[test]
fn test_bytecode_module() {
/*panic::set_hook(Box::new(|panic_info| {
let backtrace = Backtrace::new();
println!("thread panic occurred: {panic_info}\nbacktrace: {backtrace:?}");
log::error!(
"thread panic occurred: {}\nbacktrace: {:?}",
panic_info,
backtrace
);
}));*/
//simple_logging::log_to_file("quickjs_runtime.log", LevelFilter::max())
// .expect("could not init logger");
let rt = QuickJsRuntimeBuilder::new()
.compiled_module_loader(Cml {})
.build();
let test_script = Script::new(
"test_bytecode_module.js",
"import('testcompiledmodule').then((mod) => {return mod.someFunction(3, 5);})",
);
let res_fut = rt.eval(None, test_script);
let res_prom = block_on(res_fut).expect("script failed");
if let JsValueFacade::JsPromise { cached_promise } = res_prom {
let prom_res_fut = cached_promise.get_promise_result();
let prom_res = block_on(prom_res_fut)
.expect("prom failed")
.expect("prom was rejected");
assert!(prom_res.is_i32());
assert_eq!(prom_res.get_i32(), 15);
} else {
panic!("did not get a prom");
}
}
}