fune/js/public/HelperThreadAPI.h
Sandor Molnar 10438c2029 Backed out 4 changesets (bug 1888429) for causing xpc failures @ tools/profiler/tests/xpcshell/test_enterjit_osr_enabling.js CLOSED TREE
Backed out changeset 4c5efaca4057 (bug 1888429)
Backed out changeset 8b30cb54d5d9 (bug 1888429)
Backed out changeset c82b988fab50 (bug 1888429)
Backed out changeset b64446651983 (bug 1888429)
2024-04-16 06:17:54 +03:00

40 lines
1.3 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/*
* API for supplying an external thread pool to run internal work off the main
* thread.
*/
#ifndef js_HelperThreadAPI_h
#define js_HelperThreadAPI_h
#include <stddef.h> // size_t
#include "jstypes.h" // JS_PUBLIC_API
namespace JS {
// Argument passed to the task callback to indicate whether we're invoking it
// because a new task was added by the JS engine or because we're on a helper
// thread that just finished a task and there are other tasks pending.
enum class DispatchReason { NewTask, FinishedTask };
/**
* Set callback to dispatch a tasks to an external thread pool.
*
* When the task runs it should call JS::RunHelperThreadTask.
*/
using HelperThreadTaskCallback = void (*)(DispatchReason reason);
extern JS_PUBLIC_API void SetHelperThreadTaskCallback(
HelperThreadTaskCallback callback, size_t threadCount, size_t stackSize);
// Function to call from external thread pool to run a helper thread task.
extern JS_PUBLIC_API void RunHelperThreadTask();
} // namespace JS
#endif // js_HelperThreadAPI_h