Branch data Line data Source code
1 : : /* -*- mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*- */
2 : : // SPDX-License-Identifier: MIT OR LGPL-2.0-or-later
3 : : // SPDX-FileCopyrightText: 2008 litl, LLC
4 : :
5 : : #include <config.h>
6 : :
7 : : #include <signal.h> // for sigaction, SIGUSR1, sa_handler
8 : : #include <stdint.h>
9 : : #include <stdio.h> // for FILE, fclose, size_t
10 : : #include <stdlib.h> // for exit
11 : : #include <string.h> // for memset
12 : :
13 : : #ifdef HAVE_UNISTD_H
14 : : # include <unistd.h> // for getpid
15 : : #endif
16 : :
17 : : #ifdef G_OS_WIN32
18 : : # include <process.h>
19 : : # include <windows.h>
20 : : #endif
21 : :
22 : : #include <new>
23 : : #include <string> // for u16string
24 : : #include <thread> // for get_id
25 : : #include <unordered_map>
26 : : #include <utility> // for move
27 : : #include <vector>
28 : :
29 : : #include <gio/gio.h>
30 : : #include <girepository.h>
31 : : #include <glib-object.h>
32 : : #include <glib.h>
33 : :
34 : : #include <js/AllocPolicy.h> // for SystemAllocPolicy
35 : : #include <js/CallAndConstruct.h> // for Call, JS_CallFunctionValue
36 : : #include <js/CallArgs.h> // for UndefinedHandleValue
37 : : #include <js/CharacterEncoding.h>
38 : : #include <js/CompilationAndEvaluation.h>
39 : : #include <js/CompileOptions.h>
40 : : #include <js/Context.h>
41 : : #include <js/ErrorReport.h>
42 : : #include <js/Exception.h> // for StealPendingExceptionStack
43 : : #include <js/GCAPI.h> // for JS_GC, JS_AddExtraGCRootsTr...
44 : : #include <js/GCHashTable.h> // for WeakCache
45 : : #include <js/GCVector.h> // for RootedVector
46 : : #include <js/GlobalObject.h> // for CurrentGlobalOrNull
47 : : #include <js/HeapAPI.h> // for ExposeObjectToActiveJS
48 : : #include <js/Id.h>
49 : : #include <js/Modules.h>
50 : : #include <js/Promise.h> // for JobQueue::SavedJobQueue
51 : : #include <js/PropertyAndElement.h>
52 : : #include <js/PropertyDescriptor.h> // for JSPROP_PERMANENT, JSPROP_RE...
53 : : #include <js/Realm.h>
54 : : #include <js/RootingAPI.h>
55 : : #include <js/ScriptPrivate.h>
56 : : #include <js/SourceText.h>
57 : : #include <js/TracingAPI.h>
58 : : #include <js/TypeDecls.h>
59 : : #include <js/UniquePtr.h>
60 : : #include <js/Utility.h> // for DeletePolicy via WeakCache
61 : : #include <js/Value.h>
62 : : #include <js/ValueArray.h>
63 : : #include <js/friend/DumpFunctions.h>
64 : : #include <jsapi.h> // for JS_GetFunctionObject, JS_Ge...
65 : : #include <jsfriendapi.h> // for ScriptEnvironmentPreparer
66 : : #include <mozilla/UniquePtr.h> // for UniquePtr::get
67 : :
68 : : #include "gi/closure.h" // for Closure::Ptr, Closure
69 : : #include "gi/function.h"
70 : : #include "gi/object.h"
71 : : #include "gi/private.h"
72 : : #include "gi/repo.h"
73 : : #include "gi/utils-inl.h"
74 : : #include "gjs/atoms.h"
75 : : #include "gjs/byteArray.h"
76 : : #include "gjs/context-private.h"
77 : : #include "gjs/context.h"
78 : : #include "gjs/engine.h"
79 : : #include "gjs/error-types.h"
80 : : #include "gjs/global.h"
81 : : #include "gjs/importer.h"
82 : : #include "gjs/internal.h"
83 : : #include "gjs/jsapi-util.h"
84 : : #include "gjs/mainloop.h"
85 : : #include "gjs/mem.h"
86 : : #include "gjs/module.h"
87 : : #include "gjs/native.h"
88 : : #include "gjs/objectbox.h"
89 : : #include "gjs/profiler-private.h"
90 : : #include "gjs/profiler.h"
91 : : #include "gjs/promise.h"
92 : : #include "gjs/text-encoding.h"
93 : : #include "modules/cairo-module.h"
94 : : #include "modules/console.h"
95 : : #include "modules/print.h"
96 : : #include "modules/system.h"
97 : : #include "util/log.h"
98 : :
99 : : namespace mozilla {
100 : : union Utf8Unit;
101 : : }
102 : :
103 : : static void gjs_context_dispose (GObject *object);
104 : : static void gjs_context_finalize (GObject *object);
105 : : static void gjs_context_constructed (GObject *object);
106 : : static void gjs_context_get_property (GObject *object,
107 : : guint prop_id,
108 : : GValue *value,
109 : : GParamSpec *pspec);
110 : : static void gjs_context_set_property (GObject *object,
111 : : guint prop_id,
112 : : const GValue *value,
113 : : GParamSpec *pspec);
114 : :
115 : 0 : void GjsContextPrivate::EnvironmentPreparer::invoke(JS::HandleObject scope,
116 : : Closure& closure) {
117 : 0 : g_assert(!JS_IsExceptionPending(m_cx));
118 : :
119 : 0 : JSAutoRealm ar(m_cx, scope);
120 [ # # ]: 0 : if (!closure(m_cx))
121 : 0 : gjs_log_exception(m_cx);
122 : 0 : }
123 : :
124 : : struct _GjsContext {
125 : : GObject parent;
126 : : };
127 : :
128 [ + + + - : 23216 : G_DEFINE_TYPE_WITH_PRIVATE(GjsContext, gjs_context, G_TYPE_OBJECT);
+ + ]
129 : :
130 : 2111 : GjsContextPrivate* GjsContextPrivate::from_object(GObject* js_context) {
131 : 2111 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), nullptr);
132 : : return static_cast<GjsContextPrivate*>(
133 : 2111 : gjs_context_get_instance_private(GJS_CONTEXT(js_context)));
134 : : }
135 : :
136 : 6996 : GjsContextPrivate* GjsContextPrivate::from_object(GjsContext* js_context) {
137 : 6996 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), nullptr);
138 : : return static_cast<GjsContextPrivate*>(
139 : 6996 : gjs_context_get_instance_private(js_context));
140 : : }
141 : :
142 : 4887 : GjsContextPrivate* GjsContextPrivate::from_current_context() {
143 : 4887 : return from_object(gjs_context_get_current());
144 : : }
145 : :
146 : : enum {
147 : : PROP_CONTEXT_0,
148 : : PROP_PROGRAM_PATH,
149 : : PROP_SEARCH_PATH,
150 : : PROP_PROGRAM_NAME,
151 : : PROP_PROFILER_ENABLED,
152 : : PROP_PROFILER_SIGUSR2,
153 : : PROP_EXEC_AS_MODULE,
154 : : };
155 : :
156 : : static GMutex contexts_lock;
157 : : static GList *all_contexts = NULL;
158 : :
159 : : static GjsAutoChar dump_heap_output;
160 : : static unsigned dump_heap_idle_id = 0;
161 : :
162 : : #ifdef G_OS_UNIX
163 : : // Currently heap dumping via SIGUSR1 is only supported on UNIX platforms!
164 : : // This can reduce performance. See note in system.cpp on System.dumpHeap().
165 : : static void
166 : 0 : gjs_context_dump_heaps(void)
167 : : {
168 : : static unsigned counter = 0;
169 : :
170 : 0 : gjs_memory_report("signal handler", false);
171 : :
172 : : /* dump to sequential files to allow easier comparisons */
173 : : GjsAutoChar filename = g_strdup_printf("%s.%jd.%u", dump_heap_output.get(),
174 : 0 : intmax_t(getpid()), counter);
175 : 0 : ++counter;
176 : :
177 : 0 : FILE *fp = fopen(filename, "w");
178 [ # # ]: 0 : if (!fp)
179 : 0 : return;
180 : :
181 [ # # # # ]: 0 : for (GList *l = all_contexts; l; l = g_list_next(l)) {
182 : 0 : auto* gjs = static_cast<GjsContextPrivate*>(l->data);
183 : 0 : js::DumpHeap(gjs->context(), fp, js::CollectNurseryBeforeDump);
184 : : }
185 : :
186 : 0 : fclose(fp);
187 [ # # ]: 0 : }
188 : :
189 : 0 : static gboolean dump_heap_idle(void*) {
190 : 0 : dump_heap_idle_id = 0;
191 : :
192 : 0 : gjs_context_dump_heaps();
193 : :
194 : 0 : return false;
195 : : }
196 : :
197 : 0 : static void dump_heap_signal_handler(int signum [[maybe_unused]]) {
198 [ # # ]: 0 : if (dump_heap_idle_id == 0)
199 : 0 : dump_heap_idle_id = g_idle_add_full(G_PRIORITY_HIGH_IDLE,
200 : : dump_heap_idle, nullptr, nullptr);
201 : 0 : }
202 : : #endif
203 : :
204 : : static void
205 : 235 : setup_dump_heap(void)
206 : : {
207 : : static bool dump_heap_initialized = false;
208 [ + + ]: 235 : if (!dump_heap_initialized) {
209 : 96 : dump_heap_initialized = true;
210 : :
211 : : /* install signal handler only if environment variable is set */
212 : 96 : const char *heap_output = g_getenv("GJS_DEBUG_HEAP_OUTPUT");
213 [ - + ]: 96 : if (heap_output) {
214 : : #ifdef G_OS_UNIX
215 : : struct sigaction sa;
216 : :
217 : 0 : dump_heap_output = g_strdup(heap_output);
218 : :
219 : 0 : memset(&sa, 0, sizeof(sa));
220 : 0 : sa.sa_handler = dump_heap_signal_handler;
221 : 0 : sigaction(SIGUSR1, &sa, nullptr);
222 : : #else
223 : : g_message(
224 : : "heap dump is currently only supported on UNIX platforms");
225 : : #endif
226 : : }
227 : : }
228 : 235 : }
229 : :
230 : : static void
231 : 235 : gjs_context_init(GjsContext *js_context)
232 : : {
233 : 235 : gjs_log_init();
234 : 235 : gjs_context_make_current(js_context);
235 : 235 : }
236 : :
237 : : static void
238 : 96 : gjs_context_class_init(GjsContextClass *klass)
239 : : {
240 : 96 : GObjectClass *object_class = G_OBJECT_CLASS (klass);
241 : : GParamSpec *pspec;
242 : :
243 : 96 : gjs_log_init();
244 : :
245 : 96 : object_class->dispose = gjs_context_dispose;
246 : 96 : object_class->finalize = gjs_context_finalize;
247 : :
248 : 96 : object_class->constructed = gjs_context_constructed;
249 : 96 : object_class->get_property = gjs_context_get_property;
250 : 96 : object_class->set_property = gjs_context_set_property;
251 : :
252 : 96 : pspec = g_param_spec_boxed("search-path",
253 : : "Search path",
254 : : "Path where modules to import should reside",
255 : : G_TYPE_STRV,
256 : : (GParamFlags) (G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
257 : :
258 : 96 : g_object_class_install_property(object_class,
259 : : PROP_SEARCH_PATH,
260 : : pspec);
261 : 96 : g_param_spec_unref(pspec);
262 : :
263 : 96 : pspec = g_param_spec_string("program-name",
264 : : "Program Name",
265 : : "The filename of the launched JS program",
266 : : "",
267 : : (GParamFlags) (G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
268 : :
269 : 96 : g_object_class_install_property(object_class,
270 : : PROP_PROGRAM_NAME,
271 : : pspec);
272 : 96 : g_param_spec_unref(pspec);
273 : :
274 : 96 : pspec = g_param_spec_string(
275 : : "program-path", "Executed File Path",
276 : : "The full path of the launched file or NULL if GJS was launched from "
277 : : "the C API or interactive console.",
278 : : nullptr, (GParamFlags)(G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
279 : :
280 : 96 : g_object_class_install_property(object_class, PROP_PROGRAM_PATH, pspec);
281 : 96 : g_param_spec_unref(pspec);
282 : :
283 : : /**
284 : : * GjsContext:profiler-enabled:
285 : : *
286 : : * Set this property to profile any JS code run by this context. By
287 : : * default, the profiler is started and stopped when you call
288 : : * gjs_context_eval().
289 : : *
290 : : * The value of this property is superseded by the GJS_ENABLE_PROFILER
291 : : * environment variable.
292 : : *
293 : : * You may only have one context with the profiler enabled at a time.
294 : : */
295 : 96 : pspec = g_param_spec_boolean("profiler-enabled", "Profiler enabled",
296 : : "Whether to profile JS code run by this context",
297 : : FALSE,
298 : : GParamFlags(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
299 : 96 : g_object_class_install_property(object_class, PROP_PROFILER_ENABLED, pspec);
300 : 96 : g_param_spec_unref(pspec);
301 : :
302 : : /**
303 : : * GjsContext:profiler-sigusr2:
304 : : *
305 : : * Set this property to install a SIGUSR2 signal handler that starts and
306 : : * stops the profiler. This property also implies that
307 : : * #GjsContext:profiler-enabled is set.
308 : : */
309 : 96 : pspec = g_param_spec_boolean("profiler-sigusr2", "Profiler SIGUSR2",
310 : : "Whether to activate the profiler on SIGUSR2",
311 : : FALSE,
312 : : GParamFlags(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
313 : 96 : g_object_class_install_property(object_class, PROP_PROFILER_SIGUSR2, pspec);
314 : 96 : g_param_spec_unref(pspec);
315 : :
316 : 96 : pspec = g_param_spec_boolean(
317 : : "exec-as-module", "Execute as module",
318 : : "Whether to execute the file as a module", FALSE,
319 : : GParamFlags(G_PARAM_WRITABLE | G_PARAM_CONSTRUCT_ONLY));
320 : 96 : g_object_class_install_property(object_class, PROP_EXEC_AS_MODULE, pspec);
321 : 96 : g_param_spec_unref(pspec);
322 : :
323 : : /* For GjsPrivate */
324 [ - + ]: 96 : if (!g_getenv("GJS_USE_UNINSTALLED_FILES")) {
325 : : #ifdef G_OS_WIN32
326 : : extern HMODULE gjs_dll;
327 : : GjsAutoChar basedir =
328 : : g_win32_get_package_installation_directory_of_module(gjs_dll);
329 : : GjsAutoChar priv_typelib_dir = g_build_filename(
330 : : basedir, "lib", "gjs", "girepository-1.0", nullptr);
331 : : #else
332 : : GjsAutoChar priv_typelib_dir =
333 : 0 : g_build_filename(PKGLIBDIR, "girepository-1.0", nullptr);
334 : : #endif
335 : 0 : g_irepository_prepend_search_path(priv_typelib_dir);
336 : 0 : }
337 : 96 : auto& registry = Gjs::NativeModuleDefineFuncs::get();
338 : 96 : registry.add("_promiseNative", gjs_define_native_promise_stuff);
339 : 96 : registry.add("_byteArrayNative", gjs_define_byte_array_stuff);
340 : 96 : registry.add("_encodingNative", gjs_define_text_encoding_stuff);
341 : 96 : registry.add("_gi", gjs_define_private_gi_stuff);
342 : 96 : registry.add("gi", gjs_define_repo);
343 : 96 : registry.add("cairoNative", gjs_js_define_cairo_stuff);
344 : 96 : registry.add("system", gjs_js_define_system_stuff);
345 : 96 : registry.add("console", gjs_define_console_stuff);
346 : 96 : registry.add("_print", gjs_define_print_stuff);
347 : 96 : }
348 : :
349 : 318 : void GjsContextPrivate::trace(JSTracer* trc, void* data) {
350 : 318 : auto* gjs = static_cast<GjsContextPrivate*>(data);
351 : 318 : JS::TraceEdge<JSObject*>(trc, &gjs->m_global, "GJS global object");
352 : 318 : JS::TraceEdge<JSObject*>(trc, &gjs->m_internal_global,
353 : : "GJS internal global object");
354 : 318 : JS::TraceEdge<JSObject*>(trc, &gjs->m_main_loop_hook, "GJS main loop hook");
355 : 318 : gjs->m_atoms->trace(trc);
356 : 318 : gjs->m_job_queue.trace(trc);
357 : 318 : gjs->m_cleanup_tasks.trace(trc);
358 : 318 : gjs->m_object_init_list.trace(trc);
359 : 318 : }
360 : :
361 : 6895 : void GjsContextPrivate::warn_about_unhandled_promise_rejections(void) {
362 [ + + ]: 6896 : for (auto& kv : m_unhandled_rejection_stacks) {
363 : 1 : const char* stack = kv.second.get();
364 [ + - + - ]: 1 : g_warning("Unhandled promise rejection. To suppress this warning, add "
365 : : "an error handler to your promise chain with .catch() or a "
366 : : "try-catch block around your await expression. %s%s",
367 : : stack ? "Stack trace of the failed promise:\n" :
368 : : "Unfortunately there is no stack trace of the failed promise.",
369 : : stack ? stack : "");
370 : : }
371 : 6895 : m_unhandled_rejection_stacks.clear();
372 : 6895 : }
373 : :
374 : : static void
375 : 233 : gjs_context_dispose(GObject *object)
376 : : {
377 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "JS shutdown sequence");
378 : :
379 : 233 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(object);
380 : :
381 : 233 : g_assert(gjs->is_owner_thread() &&
382 : : "Gjs Context disposed from another thread");
383 : :
384 : : /* Profiler must be stopped and freed before context is shut down */
385 : 233 : gjs->free_profiler();
386 : :
387 : : /* Stop accepting entries in the toggle queue before running dispose
388 : : * notifications, which causes all GjsMaybeOwned instances to unroot.
389 : : * We don't want any objects to toggle down after that. */
390 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Shutting down toggle queue");
391 : 233 : gjs_object_clear_toggles();
392 : 233 : gjs_object_shutdown_toggle_queue();
393 : :
394 [ + - ]: 233 : if (gjs->context())
395 : 233 : ObjectInstance::context_dispose_notify(nullptr, object);
396 : :
397 : 233 : gjs_debug(GJS_DEBUG_CONTEXT,
398 : : "Notifying external reference holders of GjsContext dispose");
399 : 233 : G_OBJECT_CLASS(gjs_context_parent_class)->dispose(object);
400 : :
401 : 233 : gjs->dispose();
402 : 233 : }
403 : :
404 : 233 : void GjsContextPrivate::free_profiler(void) {
405 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Stopping profiler");
406 [ + + ]: 233 : if (m_profiler)
407 [ + - ]: 5 : g_clear_pointer(&m_profiler, _gjs_profiler_free);
408 : 233 : }
409 : :
410 : 8940 : void GjsContextPrivate::register_notifier(DestroyNotify notify_func,
411 : : void* data) {
412 : 8940 : m_destroy_notifications.push_back({notify_func, data});
413 : 8940 : }
414 : :
415 : 8758 : void GjsContextPrivate::unregister_notifier(DestroyNotify notify_func,
416 : : void* data) {
417 : 8758 : auto target = std::make_pair(notify_func, data);
418 : 8758 : Gjs::remove_one_from_unsorted_vector(&m_destroy_notifications, target);
419 : 8758 : }
420 : :
421 : 233 : void GjsContextPrivate::dispose(void) {
422 [ + - ]: 233 : if (m_cx) {
423 : 233 : stop_draining_job_queue();
424 : :
425 : 233 : gjs_debug(GJS_DEBUG_CONTEXT,
426 : : "Notifying reference holders of GjsContext dispose");
427 : :
428 [ + + ]: 412 : for (auto const& destroy_notify : m_destroy_notifications)
429 : 179 : destroy_notify.first(m_cx, destroy_notify.second);
430 : :
431 : 233 : gjs_debug(GJS_DEBUG_CONTEXT,
432 : : "Checking unhandled promise rejections");
433 : 233 : warn_about_unhandled_promise_rejections();
434 : :
435 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Releasing cached JS wrappers");
436 : 233 : m_fundamental_table->clear();
437 : 233 : m_gtype_table->clear();
438 : :
439 : : /* Do a full GC here before tearing down, since once we do
440 : : * that we may not have the JS::GetReservedSlot(, 0) to access the
441 : : * context
442 : : */
443 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Final triggered GC");
444 : 233 : JS_GC(m_cx, Gjs::GCReason::GJS_CONTEXT_DISPOSE);
445 : :
446 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Destroying JS context");
447 : 233 : m_destroying.store(true);
448 : :
449 : : /* Now, release all native objects, to avoid recursion between
450 : : * the JS teardown and the C teardown. The JSObject proxies
451 : : * still exist, but point to NULL.
452 : : */
453 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Releasing all native objects");
454 : 233 : ObjectInstance::prepare_shutdown();
455 : 233 : GjsCallbackTrampoline::prepare_shutdown();
456 : :
457 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Disabling auto GC");
458 [ + + ]: 233 : if (m_auto_gc_id > 0) {
459 : 130 : g_source_remove(m_auto_gc_id);
460 : 130 : m_auto_gc_id = 0;
461 : : }
462 : :
463 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Ending trace on global object");
464 : 233 : JS_RemoveExtraGCRootsTracer(m_cx, &GjsContextPrivate::trace, this);
465 : 233 : m_global = nullptr;
466 : 233 : m_internal_global = nullptr;
467 : 233 : m_main_loop_hook = nullptr;
468 : :
469 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "Freeing allocated resources");
470 [ + - ]: 233 : delete m_fundamental_table;
471 [ + - ]: 233 : delete m_gtype_table;
472 [ + - ]: 233 : delete m_atoms;
473 : :
474 : 233 : m_job_queue.clear();
475 : 233 : m_object_init_list.clear();
476 : :
477 : : /* Tear down JS */
478 : 233 : JS_DestroyContext(m_cx);
479 : 233 : m_cx = nullptr;
480 : : // don't use g_clear_pointer() as we want the pointer intact while we
481 : : // destroy the context in case we dump stack
482 : 233 : gjs_debug(GJS_DEBUG_CONTEXT, "JS context destroyed");
483 : : }
484 : 233 : }
485 : :
486 : 233 : GjsContextPrivate::~GjsContextPrivate(void) {
487 [ + + ]: 233 : g_clear_pointer(&m_search_path, g_strfreev);
488 [ + + ]: 233 : g_clear_pointer(&m_program_path, g_free);
489 [ + - ]: 233 : g_clear_pointer(&m_program_name, g_free);
490 : 233 : }
491 : :
492 : : static void
493 : 233 : gjs_context_finalize(GObject *object)
494 : : {
495 [ + - ]: 233 : if (gjs_context_get_current() == (GjsContext*)object)
496 : 233 : gjs_context_make_current(NULL);
497 : :
498 : 233 : g_mutex_lock(&contexts_lock);
499 : 233 : all_contexts = g_list_remove(all_contexts, object);
500 : 233 : g_mutex_unlock(&contexts_lock);
501 : :
502 : 233 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(object);
503 : 233 : gjs->~GjsContextPrivate();
504 : 233 : G_OBJECT_CLASS(gjs_context_parent_class)->finalize(object);
505 : :
506 : 233 : g_mutex_lock(&contexts_lock);
507 [ + - ]: 233 : if (!all_contexts)
508 : 233 : gjs_log_cleanup();
509 : 233 : g_mutex_unlock(&contexts_lock);
510 : 233 : }
511 : :
512 : : static void
513 : 235 : gjs_context_constructed(GObject *object)
514 : : {
515 : 235 : GjsContext *js_context = GJS_CONTEXT(object);
516 : :
517 : 235 : G_OBJECT_CLASS(gjs_context_parent_class)->constructed(object);
518 : :
519 : 235 : GjsContextPrivate* gjs_location = GjsContextPrivate::from_object(object);
520 : 235 : JSContext* cx = gjs_create_js_context(gjs_location);
521 [ - + ]: 235 : if (!cx)
522 : 0 : g_error("Failed to create javascript context");
523 : :
524 : 235 : new (gjs_location) GjsContextPrivate(cx, js_context);
525 : :
526 : 235 : g_mutex_lock(&contexts_lock);
527 : 235 : all_contexts = g_list_prepend(all_contexts, object);
528 : 235 : g_mutex_unlock(&contexts_lock);
529 : :
530 : 235 : setup_dump_heap();
531 : 235 : }
532 : :
533 : 1 : static bool on_context_module_rejected_log_exception(JSContext* cx,
534 : : unsigned argc,
535 : : JS::Value* vp) {
536 : 1 : JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
537 : :
538 : 1 : gjs_debug(GJS_DEBUG_IMPORTER, "Module evaluation promise rejected: %s",
539 : 2 : gjs_debug_callable(&args.callee()).c_str());
540 : :
541 : 1 : JS::HandleValue error = args.get(0);
542 : :
543 : 1 : GjsContextPrivate* gjs_cx = GjsContextPrivate::from_cx(cx);
544 : 1 : gjs_cx->report_unhandled_exception();
545 : :
546 : 1 : gjs_log_exception_full(cx, error, nullptr, G_LOG_LEVEL_CRITICAL);
547 : :
548 : 1 : gjs_cx->main_loop_release();
549 : :
550 : 1 : args.rval().setUndefined();
551 : 1 : return true;
552 : : }
553 : :
554 : 332 : static bool on_context_module_resolved(JSContext* cx, unsigned argc,
555 : : JS::Value* vp) {
556 : 332 : JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
557 : :
558 : 332 : gjs_debug(GJS_DEBUG_IMPORTER, "Module evaluation promise resolved: %s",
559 : 664 : gjs_debug_callable(&args.callee()).c_str());
560 : :
561 : 332 : args.rval().setUndefined();
562 : :
563 : 332 : GjsContextPrivate::from_cx(cx)->main_loop_release();
564 : :
565 : 332 : return true;
566 : : }
567 : :
568 : 336 : static bool add_promise_reactions(JSContext* cx, JS::HandleValue promise,
569 : : JSNative resolve, JSNative reject,
570 : : const std::string& debug_tag) {
571 : 336 : g_assert(promise.isObject() && "got weird value from JS::ModuleEvaluate");
572 : 336 : JS::RootedObject promise_object(cx, &promise.toObject());
573 : :
574 : 336 : std::string resolved_tag = debug_tag + " async resolved";
575 : 336 : std::string rejected_tag = debug_tag + " async rejected";
576 : :
577 : : JS::RootedFunction on_rejected(
578 : : cx,
579 : 336 : js::NewFunctionWithReserved(cx, reject, 1, 0, rejected_tag.c_str()));
580 [ - + ]: 336 : if (!on_rejected)
581 : 0 : return false;
582 : : JS::RootedFunction on_resolved(
583 : : cx,
584 : 336 : js::NewFunctionWithReserved(cx, resolve, 1, 0, resolved_tag.c_str()));
585 [ - + ]: 336 : if (!on_resolved)
586 : 0 : return false;
587 : :
588 : 336 : JS::RootedObject resolved(cx, JS_GetFunctionObject(on_resolved));
589 : 336 : JS::RootedObject rejected(cx, JS_GetFunctionObject(on_rejected));
590 : :
591 : 336 : return JS::AddPromiseReactions(cx, promise_object, resolved, rejected);
592 : 336 : }
593 : :
594 : 235 : static void load_context_module(JSContext* cx, const char* uri,
595 : : const char* debug_identifier) {
596 : 235 : JS::RootedObject loader(cx, gjs_module_load(cx, uri, uri));
597 : :
598 [ - + ]: 235 : if (!loader) {
599 : 0 : gjs_log_exception(cx);
600 : 0 : g_error("Failed to load %s module.", debug_identifier);
601 : : }
602 : :
603 [ - + ]: 235 : if (!JS::ModuleLink(cx, loader)) {
604 : 0 : gjs_log_exception(cx);
605 : 0 : g_error("Failed to instantiate %s module.", debug_identifier);
606 : : }
607 : :
608 : 235 : JS::RootedValue evaluation_promise(cx);
609 [ - + ]: 235 : if (!JS::ModuleEvaluate(cx, loader, &evaluation_promise)) {
610 : 0 : gjs_log_exception(cx);
611 : 0 : g_error("Failed to evaluate %s module.", debug_identifier);
612 : : }
613 : :
614 : 235 : GjsContextPrivate::from_cx(cx)->main_loop_hold();
615 : 235 : bool ok = add_promise_reactions(
616 : : cx, evaluation_promise, on_context_module_resolved,
617 : 235 : [](JSContext* cx, unsigned argc, JS::Value* vp) {
618 : 0 : JS::CallArgs args = JS::CallArgsFromVp(argc, vp);
619 : :
620 : 0 : gjs_debug(GJS_DEBUG_IMPORTER,
621 : : "Module evaluation promise rejected: %s",
622 : 0 : gjs_debug_callable(&args.callee()).c_str());
623 : :
624 : 0 : JS::HandleValue error = args.get(0);
625 : : // Abort because this module is required.
626 : 0 : gjs_log_exception_full(cx, error, nullptr, G_LOG_LEVEL_ERROR);
627 : :
628 : 0 : GjsContextPrivate::from_cx(cx)->main_loop_release();
629 : 0 : return false;
630 : : },
631 : : debug_identifier);
632 : :
633 [ - + ]: 235 : if (!ok) {
634 : 0 : gjs_log_exception(cx);
635 : 0 : g_error("Failed to load %s module.", debug_identifier);
636 : : }
637 : 235 : }
638 : :
639 : 235 : GjsContextPrivate::GjsContextPrivate(JSContext* cx, GjsContext* public_context)
640 : 235 : : m_public_context(public_context),
641 : 235 : m_cx(cx),
642 : 235 : m_owner_thread(std::this_thread::get_id()),
643 : 235 : m_dispatcher(this),
644 : 235 : m_memory_monitor(g_memory_monitor_dup_default()),
645 : 940 : m_environment_preparer(cx) {
646 : 235 : JS_SetGCCallback(
647 : : cx,
648 : 1177 : [](JSContext*, JSGCStatus status, JS::GCReason reason, void* data) {
649 : 942 : static_cast<GjsContextPrivate*>(data)->on_garbage_collection(
650 : : status, reason);
651 : 942 : },
652 : : this);
653 : :
654 : 235 : const char *env_profiler = g_getenv("GJS_ENABLE_PROFILER");
655 [ + + - + ]: 235 : if (env_profiler || m_should_listen_sigusr2)
656 : 1 : m_should_profile = true;
657 : :
658 [ + + ]: 235 : if (m_should_profile) {
659 : 5 : m_profiler = _gjs_profiler_new(public_context);
660 : :
661 [ - + ]: 5 : if (!m_profiler) {
662 : 0 : m_should_profile = false;
663 : : } else {
664 [ - + ]: 5 : if (m_should_listen_sigusr2)
665 : 0 : _gjs_profiler_setup_signals(m_profiler, public_context);
666 : : }
667 : : }
668 : :
669 : 235 : JSRuntime* rt = JS_GetRuntime(m_cx);
670 : 235 : m_fundamental_table = new JS::WeakCache<FundamentalTable>(rt);
671 : 235 : m_gtype_table = new JS::WeakCache<GTypeTable>(rt);
672 : :
673 : 235 : m_atoms = new GjsAtoms();
674 : :
675 [ - + ]: 235 : if (ObjectBox::gtype() == 0)
676 : 0 : g_error("Failed to initialize JSObject GType");
677 : :
678 : : JS::RootedObject internal_global(
679 : 235 : m_cx, gjs_create_global_object(cx, GjsGlobalType::INTERNAL));
680 : :
681 [ - + ]: 235 : if (!internal_global) {
682 : 0 : gjs_log_exception(m_cx);
683 : 0 : g_error("Failed to initialize internal global object");
684 : : }
685 : :
686 : 235 : m_internal_global = internal_global;
687 : 235 : Gjs::AutoInternalRealm ar{this};
688 : 235 : JS_AddExtraGCRootsTracer(m_cx, &GjsContextPrivate::trace, this);
689 : :
690 [ - + ]: 235 : if (!m_atoms->init_atoms(m_cx)) {
691 : 0 : gjs_log_exception(m_cx);
692 : 0 : g_error("Failed to initialize global strings");
693 : : }
694 : :
695 [ - + ]: 235 : if (!gjs_define_global_properties(m_cx, internal_global,
696 : : GjsGlobalType::INTERNAL,
697 : : "GJS internal global", "nullptr")) {
698 : 0 : gjs_log_exception(m_cx);
699 : 0 : g_error("Failed to define properties on internal global object");
700 : : }
701 : :
702 : : JS::RootedObject global(
703 : 235 : m_cx,
704 : 235 : gjs_create_global_object(cx, GjsGlobalType::DEFAULT, internal_global));
705 : :
706 [ - + ]: 235 : if (!global) {
707 : 0 : gjs_log_exception(m_cx);
708 : 0 : g_error("Failed to initialize global object");
709 : : }
710 : :
711 : 235 : m_global = global;
712 : :
713 : : {
714 : 235 : Gjs::AutoMainRealm ar{this};
715 : :
716 : 235 : std::vector<std::string> paths;
717 [ + + ]: 235 : if (m_search_path)
718 : : paths = {m_search_path,
719 : 210 : m_search_path + g_strv_length(m_search_path)};
720 : 235 : JS::RootedObject importer(m_cx, gjs_create_root_importer(m_cx, paths));
721 [ - + ]: 235 : if (!importer) {
722 : 0 : gjs_log_exception(cx);
723 : 0 : g_error("Failed to create root importer");
724 : : }
725 : :
726 : 235 : g_assert(
727 : : gjs_get_global_slot(global, GjsGlobalSlot::IMPORTS).isUndefined() &&
728 : : "Someone else already created root importer");
729 : :
730 : 235 : gjs_set_global_slot(global, GjsGlobalSlot::IMPORTS,
731 : 235 : JS::ObjectValue(*importer));
732 : :
733 [ - + ]: 235 : if (!gjs_define_global_properties(m_cx, global, GjsGlobalType::DEFAULT,
734 : : "GJS", "default")) {
735 : 0 : gjs_log_exception(m_cx);
736 : 0 : g_error("Failed to define properties on global object");
737 : : }
738 : 235 : }
739 : :
740 : 235 : JS::SetModuleResolveHook(rt, gjs_module_resolve);
741 : 235 : JS::SetModuleDynamicImportHook(rt, gjs_dynamic_module_resolve);
742 : 235 : JS::SetModuleMetadataHook(rt, gjs_populate_module_meta);
743 : :
744 [ - + ]: 235 : if (!JS_DefineProperty(m_cx, internal_global, "moduleGlobalThis", global,
745 : : JSPROP_PERMANENT)) {
746 : 0 : gjs_log_exception(m_cx);
747 : 0 : g_error("Failed to define module global in internal global.");
748 : : }
749 : :
750 [ - + ]: 235 : if (!gjs_load_internal_module(cx, "loader")) {
751 : 0 : gjs_log_exception(cx);
752 : 0 : g_error("Failed to load internal module loaders.");
753 : : }
754 : :
755 : : {
756 : 235 : Gjs::AutoMainRealm ar{this};
757 : 235 : load_context_module(
758 : : cx, "resource:///org/gnome/gjs/modules/esm/_bootstrap/default.js",
759 : : "ESM bootstrap");
760 : 235 : }
761 : :
762 : 235 : [[maybe_unused]] bool success = m_main_loop.spin(this);
763 : 235 : g_assert(success && "bootstrap should not call system.exit()");
764 : :
765 : 235 : g_signal_connect_object(
766 : : m_memory_monitor, "low-memory-warning",
767 [ # # ]: 0 : G_CALLBACK(+[](GjsContext* js_cx, GMemoryMonitorWarningLevel level) {
768 : : auto* cx =
769 : : static_cast<JSContext*>(gjs_context_get_native_context(js_cx));
770 : : JS::PrepareForFullGC(cx);
771 : : JS::GCOptions gc_strength = JS::GCOptions::Normal;
772 : : if (level > G_MEMORY_MONITOR_WARNING_LEVEL_LOW)
773 : : gc_strength = JS::GCOptions::Shrink;
774 : : JS::NonIncrementalGC(cx, gc_strength, Gjs::GCReason::LOW_MEMORY);
775 : : }),
776 : 235 : m_public_context, G_CONNECT_SWAPPED);
777 : :
778 : 235 : start_draining_job_queue();
779 : 235 : }
780 : :
781 : 54 : void GjsContextPrivate::set_args(std::vector<std::string>&& args) {
782 : 54 : m_args = args;
783 : 54 : }
784 : :
785 : 57 : JSObject* GjsContextPrivate::build_args_array() {
786 : 57 : return gjs_build_string_array(m_cx, m_args);
787 : : }
788 : :
789 : : static void
790 : 0 : gjs_context_get_property (GObject *object,
791 : : guint prop_id,
792 : : GValue *value,
793 : : GParamSpec *pspec)
794 : : {
795 : 0 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(object);
796 : :
797 [ # # # ]: 0 : switch (prop_id) {
798 : 0 : case PROP_PROGRAM_NAME:
799 : 0 : g_value_set_string(value, gjs->program_name());
800 : 0 : break;
801 : 0 : case PROP_PROGRAM_PATH:
802 : 0 : g_value_set_string(value, gjs->program_path());
803 : 0 : break;
804 : 0 : default:
805 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
806 : 0 : break;
807 : : }
808 : 0 : }
809 : :
810 : : static void
811 : 1410 : gjs_context_set_property (GObject *object,
812 : : guint prop_id,
813 : : const GValue *value,
814 : : GParamSpec *pspec)
815 : : {
816 : 1410 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(object);
817 : :
818 [ + + + + : 1410 : switch (prop_id) {
+ + - ]
819 : 235 : case PROP_SEARCH_PATH:
820 : 235 : gjs->set_search_path(static_cast<char**>(g_value_dup_boxed(value)));
821 : 235 : break;
822 : 235 : case PROP_PROGRAM_NAME:
823 : 235 : gjs->set_program_name(g_value_dup_string(value));
824 : 235 : break;
825 : 235 : case PROP_PROGRAM_PATH:
826 : 235 : gjs->set_program_path(g_value_dup_string(value));
827 : 235 : break;
828 : 235 : case PROP_PROFILER_ENABLED:
829 : 235 : gjs->set_should_profile(g_value_get_boolean(value));
830 : 235 : break;
831 : 235 : case PROP_PROFILER_SIGUSR2:
832 : 235 : gjs->set_should_listen_sigusr2(g_value_get_boolean(value));
833 : 235 : break;
834 : 235 : case PROP_EXEC_AS_MODULE:
835 : 235 : gjs->set_execute_as_module(g_value_get_boolean(value));
836 : 235 : break;
837 : 0 : default:
838 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
839 : 0 : break;
840 : : }
841 : 1410 : }
842 : :
843 : :
844 : : GjsContext*
845 : 114 : gjs_context_new(void)
846 : : {
847 : 114 : return (GjsContext*) g_object_new (GJS_TYPE_CONTEXT, NULL);
848 : : }
849 : :
850 : : GjsContext*
851 : 67 : gjs_context_new_with_search_path(char** search_path)
852 : : {
853 : 67 : return (GjsContext*) g_object_new (GJS_TYPE_CONTEXT,
854 : : "search-path", search_path,
855 : 67 : NULL);
856 : : }
857 : :
858 : 0 : gboolean GjsContextPrivate::trigger_gc_if_needed(void* data) {
859 : 0 : auto* gjs = static_cast<GjsContextPrivate*>(data);
860 : 0 : gjs->m_auto_gc_id = 0;
861 : :
862 [ # # ]: 0 : if (gjs->m_force_gc) {
863 : : gjs_debug_lifecycle(GJS_DEBUG_CONTEXT, "Big Hammer hit");
864 : 0 : JS_GC(gjs->m_cx, Gjs::GCReason::BIG_HAMMER);
865 : : } else {
866 : 0 : gjs_gc_if_needed(gjs->m_cx);
867 : : }
868 : 0 : gjs->m_force_gc = false;
869 : :
870 : 0 : return G_SOURCE_REMOVE;
871 : : }
872 : :
873 : 11863 : void GjsContextPrivate::schedule_gc_internal(bool force_gc) {
874 : 11863 : m_force_gc |= force_gc;
875 : :
876 [ + + ]: 11863 : if (m_auto_gc_id > 0)
877 : 11731 : return;
878 : :
879 : : if (force_gc)
880 : : gjs_debug_lifecycle(GJS_DEBUG_CONTEXT, "Big Hammer scheduled");
881 : :
882 : 132 : m_auto_gc_id = g_timeout_add_seconds_full(G_PRIORITY_LOW, 10,
883 : : trigger_gc_if_needed, this,
884 : : nullptr);
885 : :
886 [ - + ]: 132 : if (force_gc)
887 : 0 : g_source_set_name_by_id(m_auto_gc_id, "[gjs] Garbage Collection (Big Hammer)");
888 : : else
889 : 132 : g_source_set_name_by_id(m_auto_gc_id, "[gjs] Garbage Collection");
890 : : }
891 : :
892 : : /*
893 : : * GjsContextPrivate::schedule_gc_if_needed:
894 : : *
895 : : * Does a minor GC immediately if the JS engine decides one is needed, but also
896 : : * schedules a full GC in the next idle time.
897 : : */
898 : 10443 : void GjsContextPrivate::schedule_gc_if_needed(void) {
899 : : // We call JS_MaybeGC immediately, but defer a check for a full GC cycle
900 : : // to an idle handler.
901 : 10443 : JS_MaybeGC(m_cx);
902 : :
903 : 10443 : schedule_gc_internal(false);
904 : 10443 : }
905 : :
906 : 942 : void GjsContextPrivate::on_garbage_collection(JSGCStatus status, JS::GCReason reason) {
907 [ - + ]: 942 : if (m_profiler)
908 : 0 : _gjs_profiler_set_gc_status(m_profiler, status, reason);
909 : :
910 [ + + - ]: 942 : switch (status) {
911 : 471 : case JSGC_BEGIN:
912 : : gjs_debug_lifecycle(GJS_DEBUG_CONTEXT,
913 : : "Begin garbage collection because of %s",
914 : : gjs_explain_gc_reason(reason));
915 : :
916 : : // We finalize any pending toggle refs before doing any garbage
917 : : // collection, so that we can collect the JS wrapper objects, and in
918 : : // order to minimize the chances of objects having a pending toggle
919 : : // up queued when they are garbage collected.
920 : 471 : gjs_object_clear_toggles();
921 : :
922 : 471 : m_async_closures.clear();
923 : 471 : m_async_closures.shrink_to_fit();
924 : 471 : break;
925 : 471 : case JSGC_END:
926 : 471 : m_destroy_notifications.shrink_to_fit();
927 : : gjs_debug_lifecycle(GJS_DEBUG_CONTEXT, "End garbage collection");
928 : 471 : break;
929 : 0 : default:
930 : : g_assert_not_reached();
931 : : }
932 : 942 : }
933 : :
934 : 30 : void GjsContextPrivate::exit(uint8_t exit_code) {
935 : 30 : g_assert(!m_should_exit);
936 : 30 : m_should_exit = true;
937 : 30 : m_exit_code = exit_code;
938 : 30 : }
939 : :
940 : 1591 : bool GjsContextPrivate::should_exit(uint8_t* exit_code_p) const {
941 [ + + ]: 1591 : if (exit_code_p != NULL)
942 : 343 : *exit_code_p = m_exit_code;
943 : 1591 : return m_should_exit;
944 : : }
945 : :
946 : 2 : void GjsContextPrivate::exit_immediately(uint8_t exit_code) {
947 : 2 : warn_about_unhandled_promise_rejections();
948 : :
949 : 2 : ::exit(exit_code);
950 : : }
951 : :
952 : 2841 : void GjsContextPrivate::start_draining_job_queue(void) { m_dispatcher.start(); }
953 : :
954 : 2839 : void GjsContextPrivate::stop_draining_job_queue(void) {
955 : 2839 : m_draining_job_queue = false;
956 : 2839 : m_dispatcher.stop();
957 : 2839 : }
958 : :
959 : 979 : JSObject* GjsContextPrivate::getIncumbentGlobal(JSContext* cx) {
960 : : // This is equivalent to SpiderMonkey's behavior.
961 : 979 : return JS::CurrentGlobalOrNull(cx);
962 : : }
963 : :
964 : : // See engine.cpp and JS::SetJobQueue().
965 : 973 : bool GjsContextPrivate::enqueuePromiseJob(JSContext* cx [[maybe_unused]],
966 : : JS::HandleObject promise,
967 : : JS::HandleObject job,
968 : : JS::HandleObject allocation_site,
969 : : JS::HandleObject incumbent_global
970 : : [[maybe_unused]]) {
971 : 973 : g_assert(cx == m_cx);
972 : 973 : g_assert(from_cx(cx) == this);
973 : :
974 : 2919 : gjs_debug(GJS_DEBUG_MAINLOOP,
975 : : "Enqueue job %s, promise=%s, allocation site=%s",
976 : 2919 : gjs_debug_object(job).c_str(), gjs_debug_object(promise).c_str(),
977 : 1946 : gjs_debug_object(allocation_site).c_str());
978 : :
979 [ - + ]: 973 : if (!m_job_queue.append(job)) {
980 : 0 : JS_ReportOutOfMemory(m_cx);
981 : 0 : return false;
982 : : }
983 : :
984 : 973 : JS::JobQueueMayNotBeEmpty(m_cx);
985 : 973 : m_dispatcher.start();
986 : 973 : return true;
987 : : }
988 : :
989 : : // Override of JobQueue::runJobs(). Called by js::RunJobs(), and when execution
990 : : // of the job queue was interrupted by the debugger and is resuming.
991 : 6663 : void GjsContextPrivate::runJobs(JSContext* cx) {
992 : 6663 : g_assert(cx == m_cx);
993 : 6663 : g_assert(from_cx(cx) == this);
994 [ + + ]: 6663 : if (!run_jobs_fallible())
995 : 3 : gjs_log_exception(cx);
996 : 6663 : }
997 : :
998 : : /*
999 : : * GjsContext::run_jobs_fallible:
1000 : : *
1001 : : * Drains the queue of promise callbacks that the JS engine has reported
1002 : : * finished, calling each one and logging any exceptions that it throws.
1003 : : *
1004 : : * Adapted from js::RunJobs() in SpiderMonkey's default job queue
1005 : : * implementation.
1006 : : *
1007 : : * Returns: false if one of the jobs threw an uncatchable exception;
1008 : : * otherwise true.
1009 : : */
1010 : 6688 : bool GjsContextPrivate::run_jobs_fallible() {
1011 : 6688 : bool retval = true;
1012 : :
1013 [ + - + + ]: 6688 : if (m_draining_job_queue || m_should_exit)
1014 : 28 : return true;
1015 : :
1016 : 6660 : m_draining_job_queue = true; // Ignore reentrant calls
1017 : :
1018 : 6660 : JS::RootedObject job(m_cx);
1019 : 6660 : JS::HandleValueArray args(JS::HandleValueArray::empty());
1020 : 6660 : JS::RootedValue rval(m_cx);
1021 : :
1022 [ + + ]: 6660 : if (m_job_queue.length() == 0) {
1023 : : // Check FinalizationRegistry cleanup tasks at least once if there are
1024 : : // no microtasks queued. This may enqueue more microtasks, which will be
1025 : : // appended to m_job_queue.
1026 [ - + ]: 6178 : if (!run_finalization_registry_cleanup())
1027 : 0 : retval = false;
1028 : : }
1029 : :
1030 : : /* Execute jobs in a loop until we've reached the end of the queue.
1031 : : * Since executing a job can trigger enqueueing of additional jobs,
1032 : : * it's crucial to recheck the queue length during each iteration. */
1033 [ + + ]: 7630 : for (size_t ix = 0; ix < m_job_queue.length(); ix++) {
1034 : : /* A previous job might have set this flag. e.g., System.exit(). */
1035 [ + + - + : 971 : if (m_should_exit || !m_dispatcher.is_running()) {
+ + ]
1036 : 1 : gjs_debug(GJS_DEBUG_MAINLOOP, "Stopping jobs because of %s",
1037 [ + - ]: 1 : m_should_exit ? "exit" : "main loop cancel");
1038 : 1 : break;
1039 : : }
1040 : :
1041 : 970 : job = m_job_queue[ix];
1042 : :
1043 : : /* It's possible that job draining was interrupted prematurely,
1044 : : * leaving the queue partly processed. In that case, slots for
1045 : : * already-executed entries will contain nullptrs, which we should
1046 : : * just skip. */
1047 [ - + ]: 970 : if (!job)
1048 : 0 : continue;
1049 : :
1050 : 970 : m_job_queue[ix] = nullptr;
1051 : : {
1052 : 970 : JSAutoRealm ar(m_cx, job);
1053 : 970 : gjs_debug(GJS_DEBUG_MAINLOOP, "handling job %zu, %s", ix,
1054 : 1940 : gjs_debug_object(job).c_str());
1055 [ + + ]: 970 : if (!JS::Call(m_cx, JS::UndefinedHandleValue, job, args, &rval)) {
1056 : : /* Uncatchable exception - return false so that
1057 : : * System.exit() works in the interactive shell and when
1058 : : * exiting the interpreter. */
1059 [ + - ]: 3 : if (!JS_IsExceptionPending(m_cx)) {
1060 : : /* System.exit() is an uncatchable exception, but does not
1061 : : * indicate a bug. Log everything else. */
1062 [ - + ]: 3 : if (!should_exit(nullptr))
1063 : 0 : g_critical("Promise callback terminated with uncatchable exception");
1064 : 3 : retval = false;
1065 : 3 : continue;
1066 : : }
1067 : :
1068 : : /* There's nowhere for the exception to go at this point */
1069 : 0 : gjs_log_exception_uncaught(m_cx);
1070 : : }
1071 [ + + ]: 970 : }
1072 : 967 : gjs_debug(GJS_DEBUG_MAINLOOP, "Completed job %zu", ix);
1073 : :
1074 : : // Run FinalizationRegistry cleanup tasks after each job. Cleanup tasks
1075 : : // may enqueue more microtasks, which will be appended to m_job_queue.
1076 [ - + ]: 967 : if (!run_finalization_registry_cleanup())
1077 : 0 : retval = false;
1078 : : }
1079 : :
1080 : 6660 : m_draining_job_queue = false;
1081 : 6660 : m_job_queue.clear();
1082 : 6660 : warn_about_unhandled_promise_rejections();
1083 : 6660 : JS::JobQueueIsEmpty(m_cx);
1084 : 6660 : return retval;
1085 : 6660 : }
1086 : :
1087 : 7145 : bool GjsContextPrivate::run_finalization_registry_cleanup() {
1088 : 7145 : bool retval = true;
1089 : :
1090 : 7145 : JS::Rooted<FunctionVector> tasks{m_cx};
1091 : 7145 : std::swap(tasks.get(), m_cleanup_tasks);
1092 : 7145 : g_assert(m_cleanup_tasks.empty());
1093 : :
1094 : 7145 : JS::RootedFunction task{m_cx};
1095 : 7145 : JS::RootedValue unused_rval{m_cx};
1096 [ + + ]: 7150 : for (JSFunction* func : tasks) {
1097 : 5 : gjs_debug(GJS_DEBUG_MAINLOOP,
1098 : : "Running FinalizationRegistry cleanup callback");
1099 : :
1100 : 5 : task.set(func);
1101 : 5 : JS::ExposeObjectToActiveJS(JS_GetFunctionObject(func));
1102 : :
1103 : 5 : JSAutoRealm ar{m_cx, JS_GetFunctionObject(func)};
1104 [ - + ]: 5 : if (!JS_CallFunction(m_cx, nullptr, task, JS::HandleValueArray::empty(),
1105 : : &unused_rval)) {
1106 : : // Same logic as above
1107 [ # # ]: 0 : if (!JS_IsExceptionPending(m_cx)) {
1108 [ # # ]: 0 : if (!should_exit(nullptr))
1109 : 0 : g_critical(
1110 : : "FinalizationRegistry callback terminated with "
1111 : : "uncatchable exception");
1112 : 0 : retval = false;
1113 : 0 : continue;
1114 : : }
1115 : 0 : gjs_log_exception_uncaught(m_cx);
1116 : : }
1117 : :
1118 : 5 : gjs_debug(GJS_DEBUG_MAINLOOP,
1119 : : "Completed FinalizationRegistry cleanup callback");
1120 [ + - ]: 5 : }
1121 : :
1122 : 14290 : return retval;
1123 : 7145 : }
1124 : :
1125 : : class GjsContextPrivate::SavedQueue : public JS::JobQueue::SavedJobQueue {
1126 : : private:
1127 : : GjsContextPrivate* m_gjs;
1128 : : JS::PersistentRooted<JobQueueStorage> m_queue;
1129 : : bool m_was_draining : 1;
1130 : :
1131 : : public:
1132 : 2606 : explicit SavedQueue(GjsContextPrivate* gjs)
1133 : 5212 : : m_gjs(gjs),
1134 : 2606 : m_queue(gjs->m_cx, std::move(gjs->m_job_queue)),
1135 : 2606 : m_was_draining(gjs->m_draining_job_queue) {
1136 : 2606 : gjs_debug(GJS_DEBUG_CONTEXT, "Pausing job queue");
1137 : 2606 : gjs->stop_draining_job_queue();
1138 : 2606 : }
1139 : :
1140 : 2606 : ~SavedQueue(void) {
1141 : 2606 : gjs_debug(GJS_DEBUG_CONTEXT, "Unpausing job queue");
1142 : 2606 : m_gjs->m_job_queue = std::move(m_queue.get());
1143 : 2606 : m_gjs->m_draining_job_queue = m_was_draining;
1144 : 2606 : m_gjs->start_draining_job_queue();
1145 : 2606 : }
1146 : : };
1147 : :
1148 : 2606 : js::UniquePtr<JS::JobQueue::SavedJobQueue> GjsContextPrivate::saveJobQueue(
1149 : : JSContext* cx) {
1150 : 2606 : g_assert(cx == m_cx);
1151 : 2606 : g_assert(from_cx(cx) == this);
1152 : :
1153 : 2606 : auto saved_queue = js::MakeUnique<SavedQueue>(this);
1154 [ - + ]: 2606 : if (!saved_queue) {
1155 : 0 : JS_ReportOutOfMemory(cx);
1156 : 0 : return nullptr;
1157 : : }
1158 : :
1159 : 2606 : g_assert(m_job_queue.empty());
1160 : 2606 : return saved_queue;
1161 : 2606 : }
1162 : :
1163 : 14 : void GjsContextPrivate::register_unhandled_promise_rejection(
1164 : : uint64_t id, JS::UniqueChars&& stack) {
1165 : 14 : m_unhandled_rejection_stacks[id] = std::move(stack);
1166 : 14 : }
1167 : :
1168 : 13 : void GjsContextPrivate::unregister_unhandled_promise_rejection(uint64_t id) {
1169 : 13 : size_t erased = m_unhandled_rejection_stacks.erase(id);
1170 [ - + ]: 13 : if (erased != 1) {
1171 : 0 : g_critical("Promise %" G_GUINT64_FORMAT
1172 : : " Handler attached to rejected promise that wasn't "
1173 : : "previously marked as unhandled or that we wrongly reported "
1174 : : "as unhandled",
1175 : : id);
1176 : : }
1177 : 13 : }
1178 : :
1179 : 5 : bool GjsContextPrivate::queue_finalization_registry_cleanup(
1180 : : JSFunction* cleanup_task) {
1181 : 5 : return m_cleanup_tasks.append(cleanup_task);
1182 : : }
1183 : :
1184 : 112 : void GjsContextPrivate::async_closure_enqueue_for_gc(Gjs::Closure* trampoline) {
1185 : : // Because we can't free the mmap'd data for a callback
1186 : : // while it's in use, this list keeps track of ones that
1187 : : // will be freed the next time gc happens
1188 : 112 : g_assert(!trampoline->context() || trampoline->context() == m_cx);
1189 : 112 : m_async_closures.emplace_back(trampoline);
1190 : 112 : }
1191 : :
1192 : : /**
1193 : : * gjs_context_maybe_gc:
1194 : : * @context: a #GjsContext
1195 : : *
1196 : : * Similar to the Spidermonkey JS_MaybeGC() call which
1197 : : * heuristically looks at JS runtime memory usage and
1198 : : * may initiate a garbage collection.
1199 : : *
1200 : : * This function always unconditionally invokes JS_MaybeGC(), but
1201 : : * additionally looks at memory usage from the system malloc()
1202 : : * when available, and if the delta has grown since the last run
1203 : : * significantly, also initiates a full JavaScript garbage
1204 : : * collection. The idea is that since GJS is a bridge between
1205 : : * JavaScript and system libraries, and JS objects act as proxies
1206 : : * for these system memory objects, GJS consumers need a way to
1207 : : * hint to the runtime that it may be a good idea to try a
1208 : : * collection.
1209 : : *
1210 : : * A good time to call this function is when your application
1211 : : * transitions to an idle state.
1212 : : */
1213 : : void
1214 : 0 : gjs_context_maybe_gc (GjsContext *context)
1215 : : {
1216 : 0 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(context);
1217 : 0 : gjs_maybe_gc(gjs->context());
1218 : 0 : }
1219 : :
1220 : : /**
1221 : : * gjs_context_gc:
1222 : : * @context: a #GjsContext
1223 : : *
1224 : : * Initiate a full GC; may or may not block until complete. This
1225 : : * function just calls Spidermonkey JS_GC().
1226 : : */
1227 : : void
1228 : 0 : gjs_context_gc (GjsContext *context)
1229 : : {
1230 : 0 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(context);
1231 : 0 : JS_GC(gjs->context(), Gjs::GCReason::GJS_API_CALL);
1232 : 0 : }
1233 : :
1234 : : /**
1235 : : * gjs_context_get_all:
1236 : : *
1237 : : * Returns a newly-allocated list containing all known instances of #GjsContext.
1238 : : * This is useful for operating on the contexts from a process-global situation
1239 : : * such as a debugger.
1240 : : *
1241 : : * Return value: (element-type GjsContext) (transfer full): Known #GjsContext instances
1242 : : */
1243 : : GList*
1244 : 44 : gjs_context_get_all(void)
1245 : : {
1246 : : GList *result;
1247 : : GList *iter;
1248 : 44 : g_mutex_lock (&contexts_lock);
1249 : 44 : result = g_list_copy(all_contexts);
1250 [ + + ]: 88 : for (iter = result; iter; iter = iter->next)
1251 : 44 : g_object_ref((GObject*)iter->data);
1252 : 44 : g_mutex_unlock (&contexts_lock);
1253 : 44 : return result;
1254 : : }
1255 : :
1256 : : /**
1257 : : * gjs_context_get_native_context:
1258 : : *
1259 : : * Returns a pointer to the underlying native context. For SpiderMonkey, this
1260 : : * is a JSContext *
1261 : : */
1262 : : void*
1263 : 1504 : gjs_context_get_native_context (GjsContext *js_context)
1264 : : {
1265 : 1504 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), NULL);
1266 : 1504 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(js_context);
1267 : 1504 : return gjs->context();
1268 : : }
1269 : :
1270 : : bool
1271 : 241 : gjs_context_eval(GjsContext *js_context,
1272 : : const char *script,
1273 : : gssize script_len,
1274 : : const char *filename,
1275 : : int *exit_status_p,
1276 : : GError **error)
1277 : : {
1278 : 241 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), false);
1279 : :
1280 [ + + ]: 241 : size_t real_len = script_len < 0 ? strlen(script) : script_len;
1281 : :
1282 : 241 : GjsAutoUnref<GjsContext> js_context_ref(js_context, GjsAutoTakeOwnership());
1283 : :
1284 : 241 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(js_context);
1285 : 241 : return gjs->eval(script, real_len, filename, exit_status_p, error);
1286 : 240 : }
1287 : :
1288 : 106 : bool gjs_context_eval_module(GjsContext* js_context, const char* identifier,
1289 : : uint8_t* exit_code, GError** error) {
1290 : 106 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), false);
1291 : :
1292 : 106 : GjsAutoUnref<GjsContext> js_context_ref(js_context, GjsAutoTakeOwnership());
1293 : :
1294 : 106 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(js_context);
1295 : 106 : return gjs->eval_module(identifier, exit_code, error);
1296 : 105 : }
1297 : :
1298 : 108 : bool gjs_context_register_module(GjsContext* js_context, const char* identifier,
1299 : : const char* uri, GError** error) {
1300 : 108 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), false);
1301 : :
1302 : 108 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(js_context);
1303 : :
1304 : 108 : return gjs->register_module(identifier, uri, error);
1305 : : }
1306 : :
1307 : 347 : bool GjsContextPrivate::auto_profile_enter() {
1308 : 347 : bool auto_profile = m_should_profile;
1309 [ + + + + : 455 : if (auto_profile &&
+ + ]
1310 [ - + ]: 108 : (_gjs_profiler_is_running(m_profiler) || m_should_listen_sigusr2))
1311 : 100 : auto_profile = false;
1312 : :
1313 : 347 : Gjs::AutoMainRealm ar{this};
1314 : :
1315 [ + + ]: 347 : if (auto_profile)
1316 : 4 : gjs_profiler_start(m_profiler);
1317 : :
1318 : 694 : return auto_profile;
1319 : 347 : }
1320 : :
1321 : 341 : void GjsContextPrivate::auto_profile_exit(bool auto_profile) {
1322 [ + + ]: 341 : if (auto_profile)
1323 : 4 : gjs_profiler_stop(m_profiler);
1324 : 341 : }
1325 : :
1326 : 341 : bool GjsContextPrivate::handle_exit_code(bool no_sync_error_pending,
1327 : : const char* source_type,
1328 : : const char* identifier,
1329 : : uint8_t* exit_code, GError** error) {
1330 : : uint8_t code;
1331 [ + + ]: 341 : if (should_exit(&code)) {
1332 : : /* exit_status_p is public API so can't be changed, but should be
1333 : : * uint8_t, not int */
1334 : 28 : g_set_error(error, GJS_ERROR, GJS_ERROR_SYSTEM_EXIT,
1335 : : "Exit with code %d", code);
1336 : :
1337 : 28 : *exit_code = code;
1338 : 28 : return false; // Don't log anything
1339 : : }
1340 : :
1341 : : // Once the main loop exits an exception could
1342 : : // be pending even if the script returned
1343 : : // true synchronously
1344 [ + + ]: 313 : if (JS_IsExceptionPending(m_cx)) {
1345 : 2 : g_set_error(error, GJS_ERROR, GJS_ERROR_FAILED,
1346 : : "%s %s threw an exception", source_type, identifier);
1347 : 2 : gjs_log_exception_uncaught(m_cx);
1348 : :
1349 : 2 : *exit_code = 1;
1350 : 2 : return false;
1351 : : }
1352 : :
1353 [ + + ]: 311 : if (m_unhandled_exception) {
1354 : 1 : g_set_error(error, GJS_ERROR, GJS_ERROR_FAILED,
1355 : : "%s %s threw an exception", source_type, identifier);
1356 : 1 : *exit_code = 1;
1357 : 1 : return false;
1358 : : }
1359 : :
1360 : : // Assume success if no error was thrown and should exit isn't
1361 : : // set
1362 [ + - ]: 310 : if (no_sync_error_pending) {
1363 : 310 : *exit_code = 0;
1364 : 310 : return true;
1365 : : }
1366 : :
1367 : 0 : g_critical("%s %s terminated with an uncatchable exception", source_type,
1368 : : identifier);
1369 : 0 : g_set_error(error, GJS_ERROR, GJS_ERROR_FAILED,
1370 : : "%s %s terminated with an uncatchable exception", source_type,
1371 : : identifier);
1372 : :
1373 : 0 : gjs_log_exception_uncaught(m_cx);
1374 : : /* No exit code from script, but we don't want to exit(0) */
1375 : 0 : *exit_code = 1;
1376 : 0 : return false;
1377 : : }
1378 : :
1379 : 43 : bool GjsContextPrivate::set_main_loop_hook(JSObject* callable) {
1380 : 43 : g_assert(JS::IsCallable(callable) && "main loop hook must be a callable object");
1381 : :
1382 [ - + ]: 43 : if (!callable) {
1383 : 0 : m_main_loop_hook = nullptr;
1384 : 0 : return true;
1385 : : }
1386 : :
1387 [ - + ]: 43 : if (m_main_loop_hook)
1388 : 0 : return false;
1389 : :
1390 : 43 : m_main_loop_hook = callable;
1391 : 43 : return true;
1392 : : }
1393 : :
1394 : 43 : bool GjsContextPrivate::run_main_loop_hook() {
1395 : 43 : JS::RootedObject hook(m_cx, m_main_loop_hook.get());
1396 : 43 : m_main_loop_hook = nullptr;
1397 : 43 : gjs_debug(GJS_DEBUG_MAINLOOP, "Running and clearing main loop hook");
1398 : 43 : JS::RootedValue ignored_rval(m_cx);
1399 : 86 : return JS::Call(m_cx, JS::NullHandleValue, hook,
1400 : 86 : JS::HandleValueArray::empty(), &ignored_rval);
1401 : 43 : }
1402 : :
1403 : 241 : bool GjsContextPrivate::eval(const char* script, size_t script_len,
1404 : : const char* filename, int* exit_status_p,
1405 : : GError** error) {
1406 : 241 : AutoResetExit reset(this);
1407 : :
1408 : 241 : bool auto_profile = auto_profile_enter();
1409 : :
1410 : 241 : Gjs::AutoMainRealm ar{this};
1411 : :
1412 : 241 : JS::RootedValue retval(m_cx);
1413 : 241 : bool ok = eval_with_scope(nullptr, script, script_len, filename, &retval);
1414 : :
1415 : : // If there are no errors and the mainloop hook is set, call it.
1416 [ + + - + : 240 : if (ok && m_main_loop_hook)
- + ]
1417 : 0 : ok = run_main_loop_hook();
1418 : :
1419 : 240 : bool exiting = false;
1420 : :
1421 : : // Spin the internal loop until the main loop hook is set or no holds
1422 : : // remain.
1423 : : // If the main loop returns false we cannot guarantee the state of our
1424 : : // promise queue (a module promise could be pending) so instead of draining
1425 : : // draining the queue we instead just exit.
1426 [ + + + + : 240 : if (ok && !m_main_loop.spin(this)) {
+ + ]
1427 : 2 : exiting = true;
1428 : : }
1429 : :
1430 : : // If the hook has been set again, enter a loop until an error is
1431 : : // encountered or the main loop is quit.
1432 [ + + + + : 240 : while (ok && !exiting && m_main_loop_hook) {
- + - + ]
1433 : 0 : ok = run_main_loop_hook();
1434 : :
1435 : : // Additional jobs could have been enqueued from the
1436 : : // main loop hook
1437 [ # # # # : 0 : if (ok && !m_main_loop.spin(this)) {
# # ]
1438 : 0 : exiting = true;
1439 : : }
1440 : : }
1441 : :
1442 : : // The promise job queue should be drained even on error, to finish
1443 : : // outstanding async tasks before the context is torn down. Drain after
1444 : : // uncaught exceptions have been reported since draining runs callbacks.
1445 : : // We do not drain if we are exiting.
1446 [ + + + - ]: 240 : if (!ok && !exiting) {
1447 : 25 : JS::AutoSaveExceptionState saved_exc(m_cx);
1448 [ + - - + ]: 25 : ok = run_jobs_fallible() && ok;
1449 : 25 : }
1450 : :
1451 : 240 : auto_profile_exit(auto_profile);
1452 : :
1453 : : uint8_t out_code;
1454 : 240 : ok = handle_exit_code(ok, "Script", filename, &out_code, error);
1455 : :
1456 [ + + ]: 240 : if (exit_status_p) {
1457 [ + + + + : 215 : if (ok && retval.isInt32()) {
+ + ]
1458 : 5 : int code = retval.toInt32();
1459 : 5 : gjs_debug(GJS_DEBUG_CONTEXT,
1460 : : "Script returned integer code %d", code);
1461 : 5 : *exit_status_p = code;
1462 : : } else {
1463 : 210 : *exit_status_p = out_code;
1464 : : }
1465 : : }
1466 : :
1467 : 480 : return ok;
1468 : 240 : }
1469 : :
1470 : 106 : bool GjsContextPrivate::eval_module(const char* identifier,
1471 : : uint8_t* exit_status_p, GError** error) {
1472 : 106 : AutoResetExit reset(this);
1473 : :
1474 : 106 : bool auto_profile = auto_profile_enter();
1475 : :
1476 : 106 : Gjs::AutoMainRealm ar{this};
1477 : :
1478 : 106 : JS::RootedObject registry(m_cx, gjs_get_module_registry(m_global));
1479 : 106 : JS::RootedId key(m_cx, gjs_intern_string_to_id(m_cx, identifier));
1480 : 106 : JS::RootedObject obj(m_cx);
1481 [ + - + + : 106 : if (!gjs_global_registry_get(m_cx, registry, key, &obj) || !obj) {
+ + ]
1482 : 2 : g_set_error(error, GJS_ERROR, GJS_ERROR_FAILED,
1483 : : "Cannot load module with identifier: '%s'", identifier);
1484 : :
1485 [ + + ]: 2 : if (exit_status_p)
1486 : 1 : *exit_status_p = 1;
1487 : 2 : return false;
1488 : : }
1489 : :
1490 [ + + ]: 104 : if (!JS::ModuleLink(m_cx, obj)) {
1491 : 2 : gjs_log_exception(m_cx);
1492 : 2 : g_set_error(error, GJS_ERROR, GJS_ERROR_FAILED,
1493 : : "Failed to resolve imports for module: '%s'", identifier);
1494 : :
1495 [ + + ]: 2 : if (exit_status_p)
1496 : 1 : *exit_status_p = 1;
1497 : 2 : return false;
1498 : : }
1499 : :
1500 : 102 : JS::RootedValue evaluation_promise(m_cx);
1501 : 102 : bool ok = JS::ModuleEvaluate(m_cx, obj, &evaluation_promise);
1502 : :
1503 [ + - ]: 101 : if (ok) {
1504 : 101 : GjsContextPrivate::from_cx(m_cx)->main_loop_hold();
1505 : :
1506 : 202 : ok = add_promise_reactions(
1507 : : m_cx, evaluation_promise, on_context_module_resolved,
1508 : : on_context_module_rejected_log_exception, identifier);
1509 : : }
1510 : :
1511 : 101 : bool exiting = false;
1512 : :
1513 : : do {
1514 : : // If there are no errors and the mainloop hook is set, call it.
1515 [ + - + + : 103 : if (ok && m_main_loop_hook)
+ + ]
1516 : 43 : ok = run_main_loop_hook();
1517 : :
1518 : : // Spin the internal loop until the main loop hook is set or no holds
1519 : : // remain.
1520 : : //
1521 : : // If the main loop returns false we cannot guarantee the state of our
1522 : : // promise queue (a module promise could be pending) so instead of
1523 : : // draining the queue we instead just exit.
1524 : : //
1525 : : // Additional jobs could have been enqueued from the
1526 : : // main loop hook
1527 [ + - + + : 103 : if (ok && !m_main_loop.spin(this)) {
+ + ]
1528 : 3 : exiting = true;
1529 : : }
1530 [ + - + + : 103 : } while (ok && !exiting && m_main_loop_hook);
+ + + + ]
1531 : :
1532 : : // The promise job queue should be drained even on error, to finish
1533 : : // outstanding async tasks before the context is torn down. Drain after
1534 : : // uncaught exceptions have been reported since draining runs callbacks.
1535 : : // We do not drain if we are exiting.
1536 [ - + - - ]: 101 : if (!ok && !exiting) {
1537 : 0 : JS::AutoSaveExceptionState saved_exc(m_cx);
1538 [ # # # # ]: 0 : ok = run_jobs_fallible() && ok;
1539 : 0 : }
1540 : :
1541 : 101 : auto_profile_exit(auto_profile);
1542 : :
1543 : : uint8_t out_code;
1544 : 101 : ok = handle_exit_code(ok, "Module", identifier, &out_code, error);
1545 [ + + ]: 101 : if (exit_status_p)
1546 : 99 : *exit_status_p = out_code;
1547 : :
1548 : 101 : return ok;
1549 : 105 : }
1550 : :
1551 : 108 : bool GjsContextPrivate::register_module(const char* identifier, const char* uri,
1552 : : GError** error) {
1553 : 108 : Gjs::AutoMainRealm ar{this};
1554 : :
1555 [ + + ]: 108 : if (gjs_module_load(m_cx, identifier, uri))
1556 : 107 : return true;
1557 : :
1558 : 1 : const char* msg = "unknown";
1559 : 1 : JS::ExceptionStack exn_stack(m_cx);
1560 : 1 : JS::ErrorReportBuilder builder(m_cx);
1561 [ + - + - : 2 : if (JS::StealPendingExceptionStack(m_cx, &exn_stack) &&
+ - ]
1562 : 1 : builder.init(m_cx, exn_stack,
1563 : : JS::ErrorReportBuilder::WithSideEffects)) {
1564 : 1 : msg = builder.toStringResult().c_str();
1565 : : } else {
1566 : 0 : JS_ClearPendingException(m_cx);
1567 : : }
1568 : :
1569 [ + - ]: 1 : g_set_error(error, GJS_ERROR, GJS_ERROR_FAILED,
1570 : : "Failed to parse module '%s': %s", identifier,
1571 : : msg ? msg : "unknown");
1572 : :
1573 : 1 : return false;
1574 : 108 : }
1575 : :
1576 : : bool
1577 : 55 : gjs_context_eval_file(GjsContext *js_context,
1578 : : const char *filename,
1579 : : int *exit_status_p,
1580 : : GError **error)
1581 : : {
1582 : 55 : GjsAutoChar script;
1583 : : size_t script_len;
1584 : 55 : GjsAutoUnref<GFile> file = g_file_new_for_commandline_arg(filename);
1585 : :
1586 [ + + ]: 55 : if (!g_file_load_contents(file, nullptr, script.out(), &script_len, nullptr,
1587 : : error))
1588 : 1 : return false;
1589 : :
1590 : 54 : return gjs_context_eval(js_context, script, script_len, filename,
1591 : 54 : exit_status_p, error);
1592 : 55 : }
1593 : :
1594 : 100 : bool gjs_context_eval_module_file(GjsContext* js_context, const char* filename,
1595 : : uint8_t* exit_status_p, GError** error) {
1596 : 100 : GjsAutoUnref<GFile> file = g_file_new_for_commandline_arg(filename);
1597 : 100 : GjsAutoChar uri = g_file_get_uri(file);
1598 : :
1599 [ + - + + ]: 200 : return gjs_context_register_module(js_context, uri, uri, error) &&
1600 : 100 : gjs_context_eval_module(js_context, uri, exit_status_p, error);
1601 : 100 : }
1602 : :
1603 : : /*
1604 : : * GjsContextPrivate::eval_with_scope:
1605 : : * @scope_object: an object to use as the global scope, or nullptr
1606 : : * @source: JavaScript program encoded in UTF-8
1607 : : * @source_len: length of @source, or -1 if @source is 0-terminated
1608 : : * @filename: filename to use as the origin of @source
1609 : : * @retval: location for the return value of @source
1610 : : *
1611 : : * Executes @source with a local scope so that nothing from the source code
1612 : : * leaks out into the global scope.
1613 : : * If @scope_object is given, then everything that @source placed in the global
1614 : : * namespace is defined on @scope_object.
1615 : : * Otherwise, the global definitions are just discarded.
1616 : : */
1617 : 244 : bool GjsContextPrivate::eval_with_scope(JS::HandleObject scope_object,
1618 : : const char* source, size_t source_len,
1619 : : const char* filename,
1620 : : JS::MutableHandleValue retval) {
1621 : : /* log and clear exception if it's set (should not be, normally...) */
1622 [ - + ]: 244 : if (JS_IsExceptionPending(m_cx)) {
1623 : 0 : g_warning("eval_with_scope() called with a pending exception");
1624 : 0 : return false;
1625 : : }
1626 : :
1627 : 244 : JS::RootedObject eval_obj(m_cx, scope_object);
1628 [ + + ]: 244 : if (!eval_obj)
1629 : 241 : eval_obj = JS_NewPlainObject(m_cx);
1630 : :
1631 : 244 : JS::SourceText<mozilla::Utf8Unit> buf;
1632 [ - + ]: 244 : if (!buf.init(m_cx, source, source_len, JS::SourceOwnership::Borrowed))
1633 : 0 : return false;
1634 : :
1635 : 244 : JS::RootedObjectVector scope_chain(m_cx);
1636 [ - + ]: 244 : if (!scope_chain.append(eval_obj)) {
1637 : 0 : JS_ReportOutOfMemory(m_cx);
1638 : 0 : return false;
1639 : : }
1640 : :
1641 : 244 : JS::CompileOptions options(m_cx);
1642 : 244 : options.setFileAndLine(filename, 1).setNonSyntacticScope(true);
1643 : :
1644 : 244 : GjsAutoUnref<GFile> file = g_file_new_for_commandline_arg(filename);
1645 : 244 : GjsAutoChar uri = g_file_get_uri(file);
1646 : 244 : JS::RootedObject priv(m_cx, gjs_script_module_build_private(m_cx, uri));
1647 [ - + ]: 244 : if (!priv)
1648 : 0 : return false;
1649 : :
1650 : 244 : JS::RootedScript script(m_cx);
1651 : 244 : script.set(JS::Compile(m_cx, options, buf));
1652 [ + + ]: 244 : if (!script)
1653 : 1 : return false;
1654 : :
1655 : 243 : JS::SetScriptPrivate(script, JS::ObjectValue(*priv));
1656 [ + + ]: 243 : if (!JS_ExecuteScript(m_cx, scope_chain, script, retval))
1657 : 26 : return false;
1658 : :
1659 : 216 : schedule_gc_if_needed();
1660 : :
1661 [ - + ]: 216 : if (JS_IsExceptionPending(m_cx)) {
1662 : 0 : g_warning(
1663 : : "JS::Evaluate() returned true but exception was pending; "
1664 : : "did somebody call gjs_throw() without returning false?");
1665 : 0 : return false;
1666 : : }
1667 : :
1668 : 216 : gjs_debug(GJS_DEBUG_CONTEXT, "Script evaluation succeeded");
1669 : :
1670 : 216 : return true;
1671 : 243 : }
1672 : :
1673 : : /*
1674 : : * GjsContextPrivate::call_function:
1675 : : * @this_obj: Object to use as the 'this' for the function call
1676 : : * @func_val: Callable to call, as a JS value
1677 : : * @args: Arguments to pass to the callable
1678 : : * @rval: Location for the return value
1679 : : *
1680 : : * Use this instead of JS_CallFunctionValue(), because it schedules a GC if
1681 : : * one is needed. It's good practice to check if a GC should be run every time
1682 : : * we return from JS back into C++.
1683 : : */
1684 : 2221 : bool GjsContextPrivate::call_function(JS::HandleObject this_obj,
1685 : : JS::HandleValue func_val,
1686 : : const JS::HandleValueArray& args,
1687 : : JS::MutableHandleValue rval) {
1688 [ + + ]: 2221 : if (!JS_CallFunctionValue(m_cx, this_obj, func_val, args, rval))
1689 : 18 : return false;
1690 : :
1691 : 2203 : schedule_gc_if_needed();
1692 : :
1693 : 2203 : return true;
1694 : : }
1695 : :
1696 : : bool
1697 : 1 : gjs_context_define_string_array(GjsContext *js_context,
1698 : : const char *array_name,
1699 : : gssize array_length,
1700 : : const char **array_values,
1701 : : GError **error)
1702 : : {
1703 : 1 : g_return_val_if_fail(GJS_IS_CONTEXT(js_context), false);
1704 : 1 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(js_context);
1705 : :
1706 : 1 : Gjs::AutoMainRealm ar{gjs};
1707 : :
1708 : 1 : std::vector<std::string> strings;
1709 [ + - ]: 1 : if (array_values) {
1710 [ - + ]: 1 : if (array_length < 0)
1711 : 0 : array_length = g_strv_length(const_cast<char**>(array_values));
1712 : 3 : strings = {array_values, array_values + array_length};
1713 : : }
1714 : :
1715 : : // ARGV is a special case to preserve backwards compatibility.
1716 [ + - ]: 1 : if (strcmp(array_name, "ARGV") == 0) {
1717 : 1 : gjs->set_args(std::move(strings));
1718 : :
1719 : 1 : return true;
1720 : : }
1721 : :
1722 : 0 : JS::RootedObject global_root(gjs->context(), gjs->global());
1723 [ # # ]: 0 : if (!gjs_define_string_array(gjs->context(), global_root, array_name,
1724 : : strings, JSPROP_READONLY | JSPROP_PERMANENT)) {
1725 : 0 : gjs_log_exception(gjs->context());
1726 : 0 : g_set_error(error,
1727 : : GJS_ERROR,
1728 : : GJS_ERROR_FAILED,
1729 : : "gjs_define_string_array() failed");
1730 : 0 : return false;
1731 : : }
1732 : :
1733 : 0 : return true;
1734 : 1 : }
1735 : :
1736 : 53 : void gjs_context_set_argv(GjsContext* js_context, ssize_t array_length,
1737 : : const char** array_values) {
1738 : 53 : g_return_if_fail(GJS_IS_CONTEXT(js_context));
1739 : 53 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(js_context);
1740 : 53 : std::vector<std::string> args(array_values, array_values + array_length);
1741 : 53 : gjs->set_args(std::move(args));
1742 : 53 : }
1743 : :
1744 : : static GjsContext *current_context;
1745 : :
1746 : : GjsContext *
1747 : 6349 : gjs_context_get_current (void)
1748 : : {
1749 : 6349 : return current_context;
1750 : : }
1751 : :
1752 : : void
1753 : 468 : gjs_context_make_current (GjsContext *context)
1754 : : {
1755 : 468 : g_assert (context == NULL || current_context == NULL);
1756 : :
1757 : 468 : current_context = context;
1758 : 468 : }
1759 : :
1760 : : namespace Gjs {
1761 : : /*
1762 : : * Gjs::AutoMainRealm:
1763 : : * @gjs: a #GjsContextPrivate
1764 : : *
1765 : : * Enters the realm of the "main global" for the context, and leaves when the
1766 : : * object is destructed at the end of the scope. The main global is the global
1767 : : * object under which all user JS code is executed. It is used as the root
1768 : : * object for the scope of modules loaded by GJS in this context.
1769 : : *
1770 : : * Only code in a different realm, such as the debugger code or the module
1771 : : * loader code, uses a different global object.
1772 : : */
1773 : 12141 : AutoMainRealm::AutoMainRealm(GjsContextPrivate* gjs)
1774 : 12141 : : JSAutoRealm(gjs->context(), gjs->global()) {}
1775 : :
1776 : 10848 : AutoMainRealm::AutoMainRealm(JSContext* cx)
1777 : 10848 : : AutoMainRealm(static_cast<GjsContextPrivate*>(JS_GetContextPrivate(cx))) {
1778 : 10848 : }
1779 : :
1780 : : /*
1781 : : * Gjs::AutoInternalRealm:
1782 : : * @gjs: a #GjsContextPrivate
1783 : : *
1784 : : * Enters the realm of the "internal global" for the context, and leaves when
1785 : : * the object is destructed at the end of the scope. The internal global is only
1786 : : * used for executing the module loader code, to keep it separate from user
1787 : : * code.
1788 : : */
1789 : 470 : AutoInternalRealm::AutoInternalRealm(GjsContextPrivate* gjs)
1790 : 470 : : JSAutoRealm(gjs->context(), gjs->internal_global()) {}
1791 : :
1792 : 235 : AutoInternalRealm::AutoInternalRealm(JSContext* cx)
1793 : : : AutoInternalRealm(
1794 : 235 : static_cast<GjsContextPrivate*>(JS_GetContextPrivate(cx))) {}
1795 : :
1796 : : } // namespace Gjs
1797 : :
1798 : : /**
1799 : : * gjs_context_get_profiler:
1800 : : * @self: the #GjsContext
1801 : : *
1802 : : * Returns the profiler's internal instance of #GjsProfiler for you to
1803 : : * customize, or %NULL if profiling is not enabled on this #GjsContext.
1804 : : *
1805 : : * Returns: (transfer none) (nullable): a #GjsProfiler
1806 : : */
1807 : : GjsProfiler *
1808 : 4 : gjs_context_get_profiler(GjsContext *self)
1809 : : {
1810 : 4 : return GjsContextPrivate::from_object(self)->profiler();
1811 : : }
1812 : :
1813 : : /**
1814 : : * gjs_get_js_version:
1815 : : *
1816 : : * Returns the underlying version of the JS engine.
1817 : : *
1818 : : * Returns: a string
1819 : : */
1820 : : const char *
1821 : 2 : gjs_get_js_version(void)
1822 : : {
1823 : 2 : return JS_GetImplementationVersion();
1824 : : }
1825 : :
1826 : : /**
1827 : : * gjs_context_run_in_realm:
1828 : : * @self: the #GjsContext
1829 : : * @func: (scope call): function to run
1830 : : * @user_data: (closure func): pointer to pass to @func
1831 : : *
1832 : : * Runs @func immediately, not asynchronously, after entering the JS context's
1833 : : * main realm. After @func completes, leaves the realm again.
1834 : : *
1835 : : * You only need this if you are using JSAPI calls from the SpiderMonkey API
1836 : : * directly.
1837 : : */
1838 : 1 : void gjs_context_run_in_realm(GjsContext* self, GjsContextInRealmFunc func,
1839 : : void* user_data) {
1840 : 1 : g_return_if_fail(GJS_IS_CONTEXT(self));
1841 : 1 : g_return_if_fail(func);
1842 : :
1843 : 1 : GjsContextPrivate* gjs = GjsContextPrivate::from_object(self);
1844 : 1 : Gjs::AutoMainRealm ar{gjs};
1845 : 1 : func(self, user_data);
1846 : 1 : }
|
