// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license. use crate::compilers::TargetLib; use crate::global_state::GlobalState; use crate::global_timer::GlobalTimer; use crate::import_map::ImportMap; use crate::metrics::Metrics; use crate::op_error::OpError; use crate::ops::JsonOp; use crate::ops::MinimalOp; use crate::permissions::DenoPermissions; use crate::web_worker::WebWorkerHandle; use deno_core::Buf; use deno_core::ErrBox; use deno_core::ModuleLoader; use deno_core::ModuleSpecifier; use deno_core::Op; use deno_core::ZeroCopyBuf; use futures::future::FutureExt; use rand::rngs::StdRng; use rand::SeedableRng; use serde_json::Value; use std::cell::RefCell; use std::collections::HashMap; use std::ops::Deref; use std::path::Path; use std::pin::Pin; use std::rc::Rc; use std::str; use std::thread::JoinHandle; use std::time::Instant; #[derive(Copy, Clone, Eq, PartialEq)] pub enum DebugType { /// Can be debugged, will wait for debugger when --inspect-brk given. Main, /// Can be debugged, never waits for debugger. Dependent, /// No inspector instance is created. Internal, } #[derive(Clone)] pub struct State(Rc>); impl Deref for State { type Target = Rc>; fn deref(&self) -> &Self::Target { &self.0 } } #[cfg_attr(feature = "cargo-clippy", allow(stutter))] pub struct StateInner { pub global_state: GlobalState, pub permissions: DenoPermissions, pub main_module: ModuleSpecifier, /// When flags contains a `.import_map_path` option, the content of the /// import map file will be resolved and set. pub import_map: Option, pub metrics: Metrics, pub global_timer: GlobalTimer, pub workers: HashMap, WebWorkerHandle)>, pub next_worker_id: u32, pub start_time: Instant, pub seeded_rng: Option, pub target_lib: TargetLib, pub debug_type: DebugType, } impl State { pub fn stateful_json_op( &self, dispatcher: D, ) -> impl Fn(&mut deno_core::CoreIsolate, &[u8], Option) -> Op where D: Fn(&State, Value, Option) -> Result, { use crate::ops::json_op; self.core_op(json_op(self.stateful_op(dispatcher))) } pub fn stateful_json_op2( &self, dispatcher: D, ) -> impl Fn(&mut deno_core::CoreIsolate, &[u8], Option) -> Op where D: Fn( &mut deno_core::CoreIsolate, &State, Value, Option, ) -> Result, { use crate::ops::json_op; self.core_op(json_op(self.stateful_op2(dispatcher))) } /// Wrap core `OpDispatcher` to collect metrics. // TODO(ry) this should be private. Is called by stateful_json_op or // stateful_minimal_op pub fn core_op( &self, dispatcher: D, ) -> impl Fn(&mut deno_core::CoreIsolate, &[u8], Option) -> Op where D: Fn(&mut deno_core::CoreIsolate, &[u8], Option) -> Op, { let state = self.clone(); move |isolate: &mut deno_core::CoreIsolate, control: &[u8], zero_copy: Option| -> Op { let bytes_sent_control = control.len() as u64; let bytes_sent_zero_copy = zero_copy.as_ref().map(|b| b.len()).unwrap_or(0) as u64; let op = dispatcher(isolate, control, zero_copy); match op { Op::Sync(buf) => { let mut state_ = state.borrow_mut(); state_.metrics.op_sync( bytes_sent_control, bytes_sent_zero_copy, buf.len() as u64, ); Op::Sync(buf) } Op::Async(fut) => { let mut state_ = state.borrow_mut(); state_ .metrics .op_dispatched_async(bytes_sent_control, bytes_sent_zero_copy); let state = state.clone(); let result_fut = fut.map(move |buf: Buf| { let mut state_ = state.borrow_mut(); state_.metrics.op_completed_async(buf.len() as u64); buf }); Op::Async(result_fut.boxed_local()) } Op::AsyncUnref(fut) => { let mut state_ = state.borrow_mut(); state_.metrics.op_dispatched_async_unref( bytes_sent_control, bytes_sent_zero_copy, ); let state = state.clone(); let result_fut = fut.map(move |buf: Buf| { let mut state_ = state.borrow_mut(); state_.metrics.op_completed_async_unref(buf.len() as u64); buf }); Op::AsyncUnref(result_fut.boxed_local()) } } } } pub fn stateful_minimal_op2( &self, dispatcher: D, ) -> impl Fn(&mut deno_core::CoreIsolate, &[u8], Option) -> Op where D: Fn( &mut deno_core::CoreIsolate, &State, bool, i32, Option, ) -> MinimalOp, { let state = self.clone(); self.core_op(crate::ops::minimal_op( move |isolate: &mut deno_core::CoreIsolate, is_sync: bool, rid: i32, zero_copy: Option| -> MinimalOp { dispatcher(isolate, &state, is_sync, rid, zero_copy) }, )) } /// This is a special function that provides `state` argument to dispatcher. /// /// NOTE: This only works with JSON dispatcher. /// This is a band-aid for transition to `CoreIsolate.register_op` API as most of our /// ops require `state` argument. pub fn stateful_op( &self, dispatcher: D, ) -> impl Fn( &mut deno_core::CoreIsolate, Value, Option, ) -> Result where D: Fn(&State, Value, Option) -> Result, { let state = self.clone(); move |_isolate: &mut deno_core::CoreIsolate, args: Value, zero_copy: Option| -> Result { dispatcher(&state, args, zero_copy) } } pub fn stateful_op2( &self, dispatcher: D, ) -> impl Fn( &mut deno_core::CoreIsolate, Value, Option, ) -> Result where D: Fn( &mut deno_core::CoreIsolate, &State, Value, Option, ) -> Result, { let state = self.clone(); move |isolate: &mut deno_core::CoreIsolate, args: Value, zero_copy: Option| -> Result { dispatcher(isolate, &state, args, zero_copy) } } /// Quits the process if the --unstable flag was not provided. /// /// This is intentionally a non-recoverable check so that people cannot probe /// for unstable APIs from stable programs. pub fn check_unstable(&self, api_name: &str) { // TODO(ry) Maybe use IsolateHandle::terminate_execution here to provide a // stack trace in JS. let s = self.0.borrow(); if !s.global_state.flags.unstable { exit_unstable(api_name); } } } fn exit_unstable(api_name: &str) { eprintln!( "Unstable API '{}'. The --unstable flag must be provided.", api_name ); std::process::exit(70); } impl ModuleLoader for State { fn resolve( &self, specifier: &str, referrer: &str, is_main: bool, ) -> Result { if !is_main { if let Some(import_map) = &self.borrow().import_map { let result = import_map.resolve(specifier, referrer)?; if let Some(r) = result { return Ok(r); } } } let module_specifier = ModuleSpecifier::resolve_import(specifier, referrer)?; Ok(module_specifier) } /// Given an absolute url, load its source code. fn load( &self, module_specifier: &ModuleSpecifier, maybe_referrer: Option, is_dyn_import: bool, ) -> Pin> { let module_specifier = module_specifier.clone(); if is_dyn_import { if let Err(e) = self.check_dyn_import(&module_specifier) { return async move { Err(e.into()) }.boxed_local(); } } let mut state = self.borrow_mut(); // TODO(bartlomieju): incrementing resolve_count here has no sense... state.metrics.resolve_count += 1; let module_url_specified = module_specifier.to_string(); let global_state = state.global_state.clone(); let target_lib = state.target_lib.clone(); let fut = async move { let compiled_module = global_state .fetch_compiled_module(module_specifier, maybe_referrer, target_lib) .await?; Ok(deno_core::ModuleSource { // Real module name, might be different from initial specifier // due to redirections. code: compiled_module.code, module_url_specified, module_url_found: compiled_module.name, }) }; fut.boxed_local() } } impl State { /// If `shared_permission` is None then permissions from globa state are used. pub fn new( global_state: GlobalState, shared_permissions: Option, main_module: ModuleSpecifier, debug_type: DebugType, ) -> Result { let import_map: Option = match global_state.flags.import_map_path.as_ref() { None => None, Some(file_path) => { if !global_state.flags.unstable { exit_unstable("--importmap") } Some(ImportMap::load(file_path)?) } }; let seeded_rng = match global_state.flags.seed { Some(seed) => Some(StdRng::seed_from_u64(seed)), None => None, }; let permissions = if let Some(perm) = shared_permissions { perm } else { global_state.permissions.clone() }; let state = Rc::new(RefCell::new(StateInner { global_state, main_module, permissions, import_map, metrics: Metrics::default(), global_timer: GlobalTimer::new(), workers: HashMap::new(), next_worker_id: 0, start_time: Instant::now(), seeded_rng, target_lib: TargetLib::Main, debug_type, })); Ok(Self(state)) } /// If `shared_permission` is None then permissions from globa state are used. pub fn new_for_worker( global_state: GlobalState, shared_permissions: Option, main_module: ModuleSpecifier, ) -> Result { let seeded_rng = match global_state.flags.seed { Some(seed) => Some(StdRng::seed_from_u64(seed)), None => None, }; let permissions = if let Some(perm) = shared_permissions { perm } else { global_state.permissions.clone() }; let state = Rc::new(RefCell::new(StateInner { global_state, main_module, permissions, import_map: None, metrics: Metrics::default(), global_timer: GlobalTimer::new(), workers: HashMap::new(), next_worker_id: 0, start_time: Instant::now(), seeded_rng, target_lib: TargetLib::Worker, debug_type: DebugType::Dependent, })); Ok(Self(state)) } #[inline] pub fn check_read(&self, path: &Path) -> Result<(), OpError> { self.borrow().permissions.check_read(path) } #[inline] pub fn check_write(&self, path: &Path) -> Result<(), OpError> { self.borrow().permissions.check_write(path) } #[inline] pub fn check_env(&self) -> Result<(), OpError> { self.borrow().permissions.check_env() } #[inline] pub fn check_net(&self, hostname: &str, port: u16) -> Result<(), OpError> { self.borrow().permissions.check_net(hostname, port) } #[inline] pub fn check_net_url(&self, url: &url::Url) -> Result<(), OpError> { self.borrow().permissions.check_net_url(url) } #[inline] pub fn check_run(&self) -> Result<(), OpError> { self.borrow().permissions.check_run() } #[inline] pub fn check_plugin(&self, filename: &Path) -> Result<(), OpError> { self.borrow().permissions.check_plugin(filename) } pub fn check_dyn_import( &self, module_specifier: &ModuleSpecifier, ) -> Result<(), OpError> { let u = module_specifier.as_url(); match u.scheme() { "http" | "https" => { self.check_net_url(u)?; Ok(()) } "file" => { let path = u .to_file_path() .unwrap() .into_os_string() .into_string() .unwrap(); self.check_read(Path::new(&path))?; Ok(()) } _ => unreachable!(), } } #[cfg(test)] pub fn mock(main_module: &str) -> State { let module_specifier = ModuleSpecifier::resolve_url_or_path(main_module) .expect("Invalid entry module"); State::new( GlobalState::mock(vec!["deno".to_string()]), None, module_specifier, DebugType::Main, ) .unwrap() } }