-
Notifications
You must be signed in to change notification settings - Fork 70
/
jsruntime.rs
2503 lines (2246 loc) · 84.2 KB
/
jsruntime.rs
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
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
use super::bindings;
use super::bindings::create_exports_for_ops_virtual_module;
use super::bindings::watch_promise;
use super::exception_state::ExceptionState;
use super::jsrealm::JsRealmInner;
use super::op_driver::OpDriver;
use super::setup;
use super::snapshot;
use super::stats::RuntimeActivityStatsFactory;
use super::v8_static_strings::*;
use super::SnapshotStoreDataStore;
use super::SnapshottedData;
use crate::ascii_str;
use crate::ascii_str_include;
use crate::error::exception_to_err_result;
use crate::error::AnyError;
use crate::error::GetErrorClassFn;
use crate::error::JsError;
use crate::extension_set;
use crate::extension_set::LoadedSources;
use crate::extensions::GlobalObjectMiddlewareFn;
use crate::extensions::GlobalTemplateMiddlewareFn;
use crate::include_js_files;
use crate::inspector::JsRuntimeInspector;
use crate::module_specifier::ModuleSpecifier;
use crate::modules::default_import_meta_resolve_cb;
use crate::modules::CustomModuleEvaluationCb;
use crate::modules::EvalContextCodeCacheReadyCb;
use crate::modules::EvalContextGetCodeCacheCb;
use crate::modules::ExtModuleLoader;
use crate::modules::ImportMetaResolveCallback;
use crate::modules::IntoModuleCodeString;
use crate::modules::IntoModuleName;
use crate::modules::ModuleId;
use crate::modules::ModuleLoader;
use crate::modules::ModuleMap;
use crate::modules::ModuleName;
use crate::modules::RequestedModuleType;
use crate::modules::ValidateImportAttributesCb;
use crate::ops_metrics::dispatch_metrics_async;
use crate::ops_metrics::OpMetricsFactoryFn;
use crate::runtime::ContextState;
use crate::runtime::JsRealm;
use crate::runtime::OpDriverImpl;
use crate::source_map::SourceMapData;
use crate::source_map::SourceMapGetter;
use crate::source_map::SourceMapper;
use crate::stats::RuntimeActivityType;
use crate::Extension;
use crate::ExtensionFileSource;
use crate::ExtensionFileSourceCode;
use crate::FastStaticString;
use crate::FastString;
use crate::FeatureChecker;
use crate::ModuleCodeString;
use crate::NoopModuleLoader;
use crate::OpMetadata;
use crate::OpMetricsEvent;
use crate::OpState;
use anyhow::anyhow;
use anyhow::bail;
use anyhow::Context as _;
use anyhow::Error;
use futures::future::poll_fn;
use futures::task::AtomicWaker;
use futures::Future;
use futures::FutureExt;
use smallvec::SmallVec;
use std::any::Any;
use std::cell::Cell;
use std::cell::RefCell;
use std::collections::HashMap;
use std::collections::VecDeque;
use std::ffi::c_void;
use std::mem::ManuallyDrop;
use std::ops::Deref;
use std::ops::DerefMut;
use std::pin::Pin;
use std::rc::Rc;
use std::sync::Arc;
use std::sync::Mutex;
use std::task::Context;
use std::task::Poll;
use std::task::Waker;
use v8::Isolate;
pub type WaitForInspectorDisconnectCallback = Box<dyn Fn()>;
const STATE_DATA_OFFSET: u32 = 0;
pub type ExtensionTranspiler =
dyn Fn(
ModuleName,
ModuleCodeString,
) -> Result<(ModuleCodeString, Option<SourceMapData>), AnyError>;
/// Objects that need to live as long as the isolate
#[derive(Default)]
pub(crate) struct IsolateAllocations {
pub(crate) external_refs: Option<Box<v8::ExternalReferences>>,
pub(crate) externalized_sources: Box<[v8::OneByteConst]>,
pub(crate) original_sources: Box<[FastString]>,
pub(crate) near_heap_limit_callback_data:
Option<(Box<RefCell<dyn Any>>, v8::NearHeapLimitCallback)>,
}
/// ManuallyDrop<Rc<...>> is clone, but it returns a ManuallyDrop<Rc<...>> which is a massive
/// memory-leak footgun.
pub(crate) struct ManuallyDropRc<T>(ManuallyDrop<Rc<T>>);
impl<T> ManuallyDropRc<T> {
#[allow(unused)]
pub fn clone(&self) -> Rc<T> {
self.0.deref().clone()
}
}
impl<T> Deref for ManuallyDropRc<T> {
type Target = Rc<T>;
fn deref(&self) -> &Self::Target {
self.0.deref()
}
}
impl<T> DerefMut for ManuallyDropRc<T> {
fn deref_mut(&mut self) -> &mut Self::Target {
self.0.deref_mut()
}
}
/// This struct contains the [`JsRuntimeState`] and [`v8::OwnedIsolate`] that are required
/// to do an orderly shutdown of V8. We keep these in a separate struct to allow us to control
/// the destruction more closely, as snapshots require the isolate to be destroyed by the
/// snapshot process, not the destructor.
///
/// The way rusty_v8 works w/snapshots is that the [`v8::OwnedIsolate`] gets consumed by a
/// [`v8::snapshot::SnapshotCreator`] that is stored in its annex. It's a bit awkward, because this
/// means we cannot let it drop (because we don't have it after a snapshot). On top of that, we have
/// to consume it in the snapshot creator because otherwise it panics.
///
/// This inner struct allows us to let the outer JsRuntime drop normally without a Drop impl, while we
/// control dropping more closely here using ManuallyDrop.
pub(crate) struct InnerIsolateState {
will_snapshot: bool,
extension_count: usize,
op_count: usize,
source_count: usize,
addl_refs_count: usize,
main_realm: ManuallyDrop<JsRealm>,
pub(crate) state: ManuallyDropRc<JsRuntimeState>,
v8_isolate: ManuallyDrop<v8::OwnedIsolate>,
cpp_heap: ManuallyDrop<v8::UniqueRef<v8::cppgc::Heap>>,
}
impl InnerIsolateState {
/// Clean out the opstate and take the inspector to prevent the inspector from getting destroyed
/// after we've torn down the contexts. If the inspector is not correctly torn down, random crashes
/// happen in tests (and possibly for users using the inspector).
pub fn prepare_for_cleanup(&mut self) {
// Explicitly shut down the op driver here, just in case there are other references to it
// that prevent it from dropping after we invalidate the state.
self.main_realm.0.context_state.pending_ops.shutdown();
let inspector = self.state.inspector.take();
self.state.op_state.borrow_mut().clear();
if let Some(inspector) = inspector {
assert_eq!(
Rc::strong_count(&inspector),
1,
"The inspector must be dropped before the runtime"
);
}
}
pub fn cleanup(&mut self) {
self.prepare_for_cleanup();
let state_ptr = self.v8_isolate.get_data(STATE_DATA_OFFSET);
// SAFETY: We are sure that it's a valid pointer for whole lifetime of
// the runtime.
_ = unsafe { Rc::from_raw(state_ptr as *const JsRuntimeState) };
unsafe {
ManuallyDrop::take(&mut self.main_realm).0.destroy();
}
debug_assert_eq!(Rc::strong_count(&self.state), 1);
}
pub fn prepare_for_snapshot(mut self) -> v8::OwnedIsolate {
self.cleanup();
// SAFETY: We're copying out of self and then immediately forgetting self
let (state, _cpp_heap, isolate) = unsafe {
(
ManuallyDrop::take(&mut self.state.0),
ManuallyDrop::take(&mut self.cpp_heap),
ManuallyDrop::take(&mut self.v8_isolate),
)
};
std::mem::forget(self);
drop(state);
isolate
}
}
impl Drop for InnerIsolateState {
fn drop(&mut self) {
self.cleanup();
// SAFETY: We gotta drop these
unsafe {
ManuallyDrop::drop(&mut self.state.0);
if self.will_snapshot {
// Create the snapshot and just drop it.
#[allow(clippy::print_stderr)]
{
eprintln!("WARNING: v8::OwnedIsolate for snapshot was leaked");
}
} else {
ManuallyDrop::drop(&mut self.cpp_heap);
ManuallyDrop::drop(&mut self.v8_isolate);
}
}
}
}
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub(crate) enum InitMode {
/// We have no snapshot -- this is a pristine context.
New,
/// We are using a snapshot, thus certain initialization steps are skipped.
FromSnapshot {
// Can we skip the work of op registration?
skip_op_registration: bool,
},
}
impl InitMode {
fn from_options(options: &RuntimeOptions) -> Self {
match options.startup_snapshot {
None => Self::New,
Some(_) => Self::FromSnapshot {
skip_op_registration: options.skip_op_registration,
},
}
}
#[inline]
pub fn needs_ops_bindings(&self) -> bool {
!matches!(
self,
InitMode::FromSnapshot {
skip_op_registration: true
}
)
}
}
#[derive(Default)]
struct PromiseFuture {
resolved: Cell<Option<Result<v8::Global<v8::Value>, Error>>>,
waker: Cell<Option<Waker>>,
}
#[derive(Clone, Default)]
struct RcPromiseFuture(Rc<PromiseFuture>);
impl RcPromiseFuture {
pub fn new(res: Result<v8::Global<v8::Value>, Error>) -> Self {
Self(Rc::new(PromiseFuture {
resolved: Some(res).into(),
..Default::default()
}))
}
}
impl Future for RcPromiseFuture {
type Output = Result<v8::Global<v8::Value>, Error>;
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let this = self.get_mut();
if let Some(resolved) = this.0.resolved.take() {
Poll::Ready(resolved)
} else {
this.0.waker.set(Some(cx.waker().clone()));
Poll::Pending
}
}
}
static VIRTUAL_OPS_MODULE_NAME: FastStaticString = ascii_str!("ext:core/ops");
pub(crate) struct InternalSourceFile {
pub specifier: FastStaticString,
pub source: FastStaticString,
}
macro_rules! internal_source_file {
($str_:literal) => {{
InternalSourceFile {
specifier: ascii_str!(concat!("ext:core/", $str_)),
source: ascii_str_include!(concat!("../", $str_)),
}
}};
}
/// These files are executed just after a new context is created. They provided
/// the necessary infrastructure to bind ops.
pub(crate) static CONTEXT_SETUP_SOURCES: [InternalSourceFile; 2] = [
internal_source_file!("00_primordials.js"),
internal_source_file!("00_infra.js"),
];
/// These files are executed when we start setting up extensions. They rely
/// on ops being already fully set up.
pub(crate) static BUILTIN_SOURCES: [InternalSourceFile; 2] = [
internal_source_file!("01_core.js"),
internal_source_file!("02_error.js"),
];
/// Executed after `BUILTIN_SOURCES` are executed. Provides a thin ES module
/// that exports `core`, `internals` and `primordials` objects.
pub(crate) static BUILTIN_ES_MODULES: [ExtensionFileSource; 1] =
include_js_files!(core "mod.js",);
/// We have `ext:core/ops` and `ext:core/mod.js` that are always provided.
#[cfg(test)]
pub(crate) const NO_OF_BUILTIN_MODULES: usize = 2;
/// A single execution context of JavaScript. Corresponds roughly to the "Web
/// Worker" concept in the DOM.
///
/// The JsRuntime future completes when there is an error or when all
/// pending ops have completed.
///
/// Use [`JsRuntimeForSnapshot`] to be able to create a snapshot.
///
/// Note: since V8 11.6, all runtimes must have a common parent thread that
/// initalized the V8 platform. This can be done by calling
/// [`JsRuntime::init_platform`] explicitly, or it will be done automatically on
/// the calling thread when the first runtime is created.
pub struct JsRuntime {
pub(crate) inner: InnerIsolateState,
pub(crate) allocations: IsolateAllocations,
// Contains paths of source files that were executed in
// [`JsRuntime::init_extension_js`]. This field is populated only if a
// snapshot is being created.
files_loaded_from_fs_during_snapshot: Vec<&'static str>,
// Marks if this is considered the top-level runtime. Used only by inspector.
is_main_runtime: bool,
}
/// The runtime type used for snapshot creation.
pub struct JsRuntimeForSnapshot(JsRuntime);
impl Deref for JsRuntimeForSnapshot {
type Target = JsRuntime;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl DerefMut for JsRuntimeForSnapshot {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.0
}
}
pub struct CrossIsolateStore<T>(Arc<Mutex<CrossIsolateStoreInner<T>>>);
struct CrossIsolateStoreInner<T> {
map: HashMap<u32, T>,
last_id: u32,
}
impl<T> CrossIsolateStore<T> {
pub(crate) fn insert(&self, value: T) -> u32 {
let mut store = self.0.lock().unwrap();
let last_id = store.last_id;
store.map.insert(last_id, value);
store.last_id += 1;
last_id
}
pub(crate) fn take(&self, id: u32) -> Option<T> {
let mut store = self.0.lock().unwrap();
store.map.remove(&id)
}
}
impl<T> Default for CrossIsolateStore<T> {
fn default() -> Self {
CrossIsolateStore(Arc::new(Mutex::new(CrossIsolateStoreInner {
map: Default::default(),
last_id: 0,
})))
}
}
impl<T> Clone for CrossIsolateStore<T> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
pub type SharedArrayBufferStore =
CrossIsolateStore<v8::SharedRef<v8::BackingStore>>;
pub type CompiledWasmModuleStore = CrossIsolateStore<v8::CompiledWasmModule>;
/// Internal state for JsRuntime which is stored in one of v8::Isolate's
/// embedder slots.
pub struct JsRuntimeState {
pub(crate) source_mapper: RefCell<SourceMapper<Rc<dyn SourceMapGetter>>>,
pub(crate) op_state: Rc<RefCell<OpState>>,
pub(crate) shared_array_buffer_store: Option<SharedArrayBufferStore>,
pub(crate) compiled_wasm_module_store: Option<CompiledWasmModuleStore>,
wait_for_inspector_disconnect_callback:
Option<WaitForInspectorDisconnectCallback>,
pub(crate) validate_import_attributes_cb: Option<ValidateImportAttributesCb>,
pub(crate) custom_module_evaluation_cb: Option<CustomModuleEvaluationCb>,
pub(crate) eval_context_get_code_cache_cb: Option<EvalContextGetCodeCacheCb>,
pub(crate) eval_context_code_cache_ready_cb:
Option<EvalContextCodeCacheReadyCb>,
waker: Arc<AtomicWaker>,
/// Accessed through [`JsRuntimeState::with_inspector`].
inspector: RefCell<Option<Rc<RefCell<JsRuntimeInspector>>>>,
has_inspector: Cell<bool>,
}
#[derive(Default)]
pub struct RuntimeOptions {
/// Source map reference for errors.
pub source_map_getter: Option<Rc<dyn SourceMapGetter>>,
/// Allows to map error type to a string "class" used to represent
/// error in JavaScript.
pub get_error_class_fn: Option<GetErrorClassFn>,
/// Implementation of `ModuleLoader` which will be
/// called when V8 requests to load ES modules in the main realm.
///
/// If not provided runtime will error if code being
/// executed tries to load modules.
pub module_loader: Option<Rc<dyn ModuleLoader>>,
/// If specified, transpiles extensions before loading.
pub extension_transpiler: Option<Rc<ExtensionTranspiler>>,
/// Provide a function that may optionally provide a metrics collector
/// for a given op.
pub op_metrics_factory_fn: Option<OpMetricsFactoryFn>,
/// JsRuntime extensions, not to be confused with ES modules.
/// Only ops registered by extensions will be initialized. If you need
/// to execute JS code from extensions, pass source files in `js` or `esm`
/// option on `ExtensionBuilder`.
///
/// If you are creating a runtime from a snapshot take care not to include
/// JavaScript sources in the extensions.
pub extensions: Vec<Extension>,
/// V8 snapshot that should be loaded on startup.
///
/// For testing, use `runtime.snapshot()` and then [`Box::leak`] to acquire
// a static slice.
pub startup_snapshot: Option<&'static [u8]>,
/// Should op registration be skipped?
pub skip_op_registration: bool,
/// Isolate creation parameters.
pub create_params: Option<v8::CreateParams>,
/// V8 platform instance to use. Used when Deno initializes V8
/// (which it only does once), otherwise it's silently dropped.
pub v8_platform: Option<v8::SharedRef<v8::Platform>>,
/// The store to use for transferring SharedArrayBuffers between isolates.
/// If multiple isolates should have the possibility of sharing
/// SharedArrayBuffers, they should use the same [SharedArrayBufferStore]. If
/// no [SharedArrayBufferStore] is specified, SharedArrayBuffer can not be
/// serialized.
pub shared_array_buffer_store: Option<SharedArrayBufferStore>,
/// The store to use for transferring `WebAssembly.Module` objects between
/// isolates.
/// If multiple isolates should have the possibility of sharing
/// `WebAssembly.Module` objects, they should use the same
/// [CompiledWasmModuleStore]. If no [CompiledWasmModuleStore] is specified,
/// `WebAssembly.Module` objects cannot be serialized.
pub compiled_wasm_module_store: Option<CompiledWasmModuleStore>,
/// Start inspector instance to allow debuggers to connect.
pub inspector: bool,
/// Describe if this is the main runtime instance, used by debuggers in some
/// situation - like disconnecting when program finishes running.
pub is_main: bool,
#[cfg(any(test, feature = "unsafe_runtime_options"))]
/// Should this isolate expose the v8 natives (eg: %OptimizeFunctionOnNextCall) and
/// GC control functions (`gc()`)? WARNING: This should not be used for production code as
/// this may expose the runtime to security vulnerabilities.
pub unsafe_expose_natives_and_gc: bool,
/// An optional instance of `FeatureChecker`. If one is not provided, the
/// default instance will be created that has no features enabled.
pub feature_checker: Option<Arc<FeatureChecker>>,
/// A callback that can be used to validate import attributes received at
/// the import site. If no callback is provided, all attributes are allowed.
///
/// Embedders might use this callback to eg. validate value of "type"
/// attribute, not allowing other types than "JSON".
///
/// To signal validation failure, users should throw an V8 exception inside
/// the callback.
pub validate_import_attributes_cb: Option<ValidateImportAttributesCb>,
/// A callback that can be used to customize behavior of
/// `import.meta.resolve()` API. If no callback is provided, a default one
/// is used. The default callback returns value of
/// `RuntimeOptions::module_loader::resolve()` call.
pub import_meta_resolve_callback: Option<ImportMetaResolveCallback>,
/// A callback that is called when the event loop has no more work to do,
/// but there are active, non-blocking inspector session (eg. Chrome
/// DevTools inspector is connected). The embedder can use this callback
/// to eg. print a message notifying user about program finished running.
/// This callback can be called multiple times, eg. after the program finishes
/// more work can be scheduled from the DevTools.
pub wait_for_inspector_disconnect_callback:
Option<WaitForInspectorDisconnectCallback>,
/// A callback that allows to evaluate a custom type of a module - eg.
/// embedders might implement loading WASM or test modules.
pub custom_module_evaluation_cb: Option<CustomModuleEvaluationCb>,
/// Callbacks to retrieve and store code cache for scripts evaluated
/// through evalContext.
pub eval_context_code_cache_cbs:
Option<(EvalContextGetCodeCacheCb, EvalContextCodeCacheReadyCb)>,
}
impl RuntimeOptions {
#[cfg(any(test, feature = "unsafe_runtime_options"))]
fn unsafe_expose_natives_and_gc(&self) -> bool {
self.unsafe_expose_natives_and_gc
}
#[cfg(not(any(test, feature = "unsafe_runtime_options")))]
fn unsafe_expose_natives_and_gc(&self) -> bool {
false
}
}
#[derive(Copy, Clone, Debug)]
pub struct PollEventLoopOptions {
pub wait_for_inspector: bool,
pub pump_v8_message_loop: bool,
}
impl Default for PollEventLoopOptions {
fn default() -> Self {
Self {
wait_for_inspector: false,
pump_v8_message_loop: true,
}
}
}
#[derive(Default)]
pub struct CreateRealmOptions {
/// Implementation of `ModuleLoader` which will be
/// called when V8 requests to load ES modules in the realm.
///
/// If not provided, there will be an error if code being
/// executed tries to load modules from the realm.
pub module_loader: Option<Rc<dyn ModuleLoader>>,
}
impl JsRuntime {
/// Explicitly initalizes the V8 platform using the passed platform. This
/// should only be called once per process. Further calls will be silently
/// ignored.
#[cfg(not(any(test, feature = "unsafe_runtime_options")))]
pub fn init_platform(v8_platform: Option<v8::SharedRef<v8::Platform>>) {
setup::init_v8(v8_platform, cfg!(test), false);
}
/// Explicitly initalizes the V8 platform using the passed platform. This
/// should only be called once per process. Further calls will be silently
/// ignored.
///
/// The `expose_natives` flag is used to expose the v8 natives
/// (eg: %OptimizeFunctionOnNextCall) and GC control functions (`gc()`).
/// WARNING: This should not be used for production code as
/// this may expose the runtime to security vulnerabilities.
#[cfg(any(test, feature = "unsafe_runtime_options"))]
pub fn init_platform(
v8_platform: Option<v8::SharedRef<v8::Platform>>,
expose_natives: bool,
) {
setup::init_v8(v8_platform, cfg!(test), expose_natives);
}
/// Only constructor, configuration is done through `options`.
/// Panics if the runtime cannot be initialized.
pub fn new(options: RuntimeOptions) -> JsRuntime {
match Self::try_new(options) {
Ok(runtime) => runtime,
Err(err) => {
panic!("Failed to initialize a JsRuntime: {:?}", err);
}
}
}
/// Only constructor, configuration is done through `options`.
/// Returns an error if the runtime cannot be initialized.
pub fn try_new(mut options: RuntimeOptions) -> Result<JsRuntime, Error> {
setup::init_v8(
options.v8_platform.take(),
cfg!(test),
options.unsafe_expose_natives_and_gc(),
);
JsRuntime::new_inner(options, false)
}
pub(crate) fn state_from(isolate: &v8::Isolate) -> Rc<JsRuntimeState> {
let state_ptr = isolate.get_data(STATE_DATA_OFFSET);
let state_rc =
// SAFETY: We are sure that it's a valid pointer for whole lifetime of
// the runtime.
unsafe { Rc::from_raw(state_ptr as *const JsRuntimeState) };
let state = state_rc.clone();
std::mem::forget(state_rc);
state
}
/// Returns the `OpState` associated with the passed `Isolate`.
pub fn op_state_from(isolate: &v8::Isolate) -> Rc<RefCell<OpState>> {
let state = Self::state_from(isolate);
state.op_state.clone()
}
pub(crate) fn has_more_work(scope: &mut v8::HandleScope) -> bool {
EventLoopPendingState::new_from_scope(scope).is_pending()
}
/// Returns the `OpMetadata` associated with the op `name`.
/// Note this is linear with respect to the number of ops registered.
pub fn op_metadata(&self, name: &str) -> Option<OpMetadata> {
let state = &self.inner.main_realm.0.context_state;
state.op_ctxs.iter().find_map(|ctx| {
if ctx.decl.name == name {
Some(ctx.decl.metadata)
} else {
None
}
})
}
fn new_inner(
mut options: RuntimeOptions,
will_snapshot: bool,
) -> Result<JsRuntime, Error> {
let init_mode = InitMode::from_options(&options);
let mut extensions = std::mem::take(&mut options.extensions);
let mut isolate_allocations = IsolateAllocations::default();
// First let's create an `OpState` and contribute to it from extensions...
let mut op_state = OpState::new(options.feature_checker.take());
extension_set::setup_op_state(&mut op_state, &mut extensions);
// Load the sources and source maps
let mut files_loaded = Vec::with_capacity(128);
let mut source_mapper: SourceMapper<Rc<dyn SourceMapGetter>> =
SourceMapper::new(options.source_map_getter);
let mut sources = extension_set::into_sources(
options.extension_transpiler.as_deref(),
&extensions,
&mut source_mapper,
|source| {
mark_as_loaded_from_fs_during_snapshot(&mut files_loaded, &source.code)
},
)?;
// ...now let's set up ` JsRuntimeState`, we'll need to set some fields
// later, after `JsRuntime` is all set up...
let waker = op_state.waker.clone();
let op_state = Rc::new(RefCell::new(op_state));
let (eval_context_get_code_cache_cb, eval_context_set_code_cache_cb) =
options
.eval_context_code_cache_cbs
.map(|cbs| (Some(cbs.0), Some(cbs.1)))
.unwrap_or_default();
let state_rc = Rc::new(JsRuntimeState {
source_mapper: RefCell::new(source_mapper),
shared_array_buffer_store: options.shared_array_buffer_store,
compiled_wasm_module_store: options.compiled_wasm_module_store,
wait_for_inspector_disconnect_callback: options
.wait_for_inspector_disconnect_callback,
op_state: op_state.clone(),
validate_import_attributes_cb: options.validate_import_attributes_cb,
custom_module_evaluation_cb: options.custom_module_evaluation_cb,
eval_context_get_code_cache_cb,
eval_context_code_cache_ready_cb: eval_context_set_code_cache_cb,
waker,
// Some fields are initialized later after isolate is created
inspector: None.into(),
has_inspector: false.into(),
});
// ...now we're moving on to ops; set them up, create `OpCtx` for each op
// and get ready to actually create V8 isolate...
let op_decls =
extension_set::init_ops(crate::ops_builtin::BUILTIN_OPS, &mut extensions);
let op_driver = Rc::new(OpDriverImpl::default());
let op_metrics_factory_fn = options.op_metrics_factory_fn.take();
let get_error_class_fn = options.get_error_class_fn.unwrap_or(&|_| "Error");
let mut op_ctxs = extension_set::create_op_ctxs(
op_decls,
op_metrics_factory_fn,
op_driver.clone(),
op_state.clone(),
state_rc.clone(),
get_error_class_fn,
);
// ...ops are now almost fully set up; let's create a V8 isolate...
let (
global_template_middleware,
global_object_middlewares,
additional_references,
) = extension_set::get_middlewares_and_external_refs(&mut extensions);
// Capture the extension, op and source counts
let extension_count = extensions.len();
let op_count = op_ctxs.len();
let source_count = sources.len();
let addl_refs_count = additional_references.len();
let (maybe_startup_snapshot, mut sidecar_data) = options
.startup_snapshot
.take()
.map(snapshot::deconstruct)
.unzip();
let ops_in_snapshot = sidecar_data
.as_ref()
.map(|d| d.snapshot_data.op_count)
.unwrap_or_default();
let sources_in_snapshot = sidecar_data
.as_ref()
.map(|d| d.snapshot_data.source_count)
.unwrap_or_default();
let snapshot_sources: Vec<&[u8]> = sidecar_data
.as_mut()
.map(|s| std::mem::take(&mut s.snapshot_data.external_strings))
.unwrap_or_default();
(
isolate_allocations.externalized_sources,
isolate_allocations.original_sources,
) = bindings::externalize_sources(&mut sources, snapshot_sources);
isolate_allocations.external_refs =
Some(Box::new(bindings::create_external_references(
&op_ctxs,
&additional_references,
&isolate_allocations.externalized_sources,
ops_in_snapshot,
sources_in_snapshot,
)));
let external_refs: &v8::ExternalReferences =
isolate_allocations.external_refs.as_ref().unwrap().as_ref();
// SAFETY: We attach external_refs to IsolateAllocations which will live as long as the isolate
let external_refs_static = unsafe { std::mem::transmute(external_refs) };
let has_snapshot = maybe_startup_snapshot.is_some();
let mut isolate = setup::create_isolate(
will_snapshot,
options.create_params.take(),
maybe_startup_snapshot,
external_refs_static,
);
let cpp_heap = setup::init_cppgc(&mut isolate);
// ...isolate is fully set up, we can forward its pointer to the ops to finish
// their' setup...
for op_ctx in op_ctxs.iter_mut() {
op_ctx.isolate = isolate.as_mut() as *mut Isolate;
}
// TODO(Bartlomieju): this can be simplified
let isolate_ptr = setup::create_isolate_ptr();
// SAFETY: this is first use of `isolate_ptr` so we are sure we're
// not overwriting an existing pointer.
isolate = unsafe {
isolate_ptr.write(isolate);
isolate_ptr.read()
};
op_state.borrow_mut().put(isolate_ptr);
// ...once ops and isolate are set up, we can create a `ContextState`...
let context_state = Rc::new(ContextState::new(
op_driver.clone(),
isolate_ptr,
options.get_error_class_fn.unwrap_or(&|_| "Error"),
op_ctxs,
op_state.borrow().external_ops_tracker.clone(),
));
// TODO(bartlomieju): factor out
// Add the task spawners to the OpState
let spawner = context_state
.task_spawner_factory
.clone()
.new_same_thread_spawner();
op_state.borrow_mut().put(spawner);
let spawner = context_state
.task_spawner_factory
.clone()
.new_cross_thread_spawner();
op_state.borrow_mut().put(spawner);
// ...and with `ContextState` available we can set up V8 context...
let mut snapshotted_data = None;
let main_context = {
let scope = &mut v8::HandleScope::new(&mut isolate);
let context = create_context(
scope,
&global_template_middleware,
&global_object_middlewares,
has_snapshot,
);
// Get module map data from the snapshot
if let Some(raw_data) = sidecar_data {
snapshotted_data = Some(snapshot::load_snapshotted_data_from_snapshot(
scope, context, raw_data,
));
}
v8::Global::new(scope, context)
};
let mut context_scope: v8::HandleScope =
v8::HandleScope::with_context(&mut isolate, &main_context);
let scope = &mut context_scope;
let context = v8::Local::new(scope, &main_context);
// ...followed by creation of `Deno.core` namespace, as well as internal
// infrastructure to provide JavaScript bindings for ops...
if init_mode == InitMode::New {
bindings::initialize_deno_core_namespace(scope, context, init_mode);
bindings::initialize_primordials_and_infra(scope)?;
}
// If we're creating a new runtime or there are new ops to register
// set up JavaScript bindings for them.
if init_mode.needs_ops_bindings() {
bindings::initialize_deno_core_ops_bindings(
scope,
context,
&context_state.op_ctxs,
);
}
// SAFETY: Initialize the context state slot.
unsafe {
context.set_aligned_pointer_in_embedder_data(
super::jsrealm::CONTEXT_STATE_SLOT_INDEX,
Rc::into_raw(context_state.clone()) as *mut c_void,
);
}
let inspector = if options.inspector {
Some(JsRuntimeInspector::new(scope, context, options.is_main))
} else {
None
};
// ...now that JavaScript bindings to ops are available we can deserialize
// modules stored in the snapshot (because they depend on the ops and external
// references must match properly) and recreate a module map...
let loader = options
.module_loader
.unwrap_or_else(|| Rc::new(NoopModuleLoader));
let import_meta_resolve_cb = options
.import_meta_resolve_callback
.unwrap_or_else(|| Box::new(default_import_meta_resolve_cb));
let exception_state = context_state.exception_state.clone();
let module_map = Rc::new(ModuleMap::new(
loader,
exception_state.clone(),
import_meta_resolve_cb,
));
if let Some((snapshotted_data, mut data_store)) = snapshotted_data {
*exception_state.js_handled_promise_rejection_cb.borrow_mut() =
snapshotted_data
.js_handled_promise_rejection_cb
.map(|cb| data_store.get(scope, cb));
module_map.update_with_snapshotted_data(
scope,
&mut data_store,
snapshotted_data.module_map_data,
);
let mut mapper = state_rc.source_mapper.borrow_mut();
for (key, map) in snapshotted_data.ext_source_maps {
mapper.ext_source_maps.insert(key, map.into());
}
}
// SAFETY: Set the module map slot in the context
unsafe {
context.set_aligned_pointer_in_embedder_data(
super::jsrealm::MODULE_MAP_SLOT_INDEX,
Rc::into_raw(module_map.clone()) as *mut c_void,
);
}
// ...we are ready to create a "realm" for the context...
let main_realm = {
let main_realm =
JsRealmInner::new(context_state, main_context, module_map.clone());
// TODO(bartlomieju): why is this done in here? Maybe we can hoist it out?
state_rc.has_inspector.set(inspector.is_some());
*state_rc.inspector.borrow_mut() = inspector;
main_realm
};
let main_realm = JsRealm::new(main_realm);
scope.set_data(
STATE_DATA_OFFSET,
Rc::into_raw(state_rc.clone()) as *mut c_void,
);
drop(context_scope);
// ...which allows us to create the `JsRuntime` instance...
let mut js_runtime = JsRuntime {
inner: InnerIsolateState {
will_snapshot,
extension_count,
op_count,
source_count,
addl_refs_count,
main_realm: ManuallyDrop::new(main_realm),
state: ManuallyDropRc(ManuallyDrop::new(state_rc)),
v8_isolate: ManuallyDrop::new(isolate),
cpp_heap: ManuallyDrop::new(cpp_heap),
},
allocations: isolate_allocations,
files_loaded_from_fs_during_snapshot: vec![],
is_main_runtime: options.is_main,
};
// ...we're almost done with the setup, all that's left is to execute
// internal JS and then execute code provided by extensions...
{
let realm = JsRealm::clone(&js_runtime.inner.main_realm);
let context_global = realm.context();
let module_map = realm.0.module_map();
// TODO(bartlomieju): this is somewhat duplicated in `bindings::initialize_context`,
// but for migration period we need to have ops available in both `Deno.core.ops`
// as well as have them available in "virtual ops module"
// if !matches!(
// self.init_mode,
// InitMode::FromSnapshot {
// skip_op_registration: true
// }
// ) {
if init_mode == InitMode::New {
js_runtime
.execute_virtual_ops_module(context_global, module_map.clone());
}
if init_mode == InitMode::New {
js_runtime.execute_builtin_sources(
&realm,
&module_map,
&mut files_loaded,
)?;
}
js_runtime.store_js_callbacks(&realm, will_snapshot);
js_runtime.init_extension_js(&realm, &module_map, sources)?;
}
if will_snapshot {
js_runtime.files_loaded_from_fs_during_snapshot = files_loaded;
}