File Explorer

1// Copyright 2014 the V8 project authors. All rights reserved.2// Use of this source code is governed by a BSD-style license that can be3// found in the LICENSE file.4 5#ifndef V8_LIBPLATFORM_LIBPLATFORM_H_6#define V8_LIBPLATFORM_LIBPLATFORM_H_7 8#include <memory>9 10#include "libplatform/libplatform-export.h"11#include "libplatform/v8-tracing.h"12#include "v8-platform.h"  // NOLINT(build/include_directory)13#include "v8config.h"     // NOLINT(build/include_directory)14 15namespace v8 {16namespace platform {17 18enum class IdleTaskSupport { kDisabled, kEnabled };19enum class InProcessStackDumping { kDisabled, kEnabled };20 21enum class MessageLoopBehavior : bool {22  kDoNotWait = false,23  kWaitForWork = true24};25 26enum class PriorityMode : bool { kDontApply, kApply };27 28/**29 * Returns a new instance of the default v8::Platform implementation.30 *31 * The caller will take ownership of the returned pointer. |thread_pool_size|32 * is the number of worker threads to allocate for background jobs. If a value33 * of zero is passed, a suitable default based on the current number of34 * processors online will be chosen.35 * If |idle_task_support| is enabled then the platform will accept idle36 * tasks (IdleTasksEnabled will return true) and will rely on the embedder37 * calling v8::platform::RunIdleTasks to process the idle tasks.38 * If |tracing_controller| is nullptr, the default platform will create a39 * v8::platform::TracingController instance and use it.40 * If |priority_mode| is PriorityMode::kApply, the default platform will use41 * multiple task queues executed by threads different system-level priorities42 * (where available) to schedule tasks.43 */44V8_PLATFORM_EXPORT std::unique_ptr<v8::Platform> NewDefaultPlatform(45    int thread_pool_size = 0,46    IdleTaskSupport idle_task_support = IdleTaskSupport::kDisabled,47    InProcessStackDumping in_process_stack_dumping =48        InProcessStackDumping::kDisabled,49    std::unique_ptr<v8::TracingController> tracing_controller = {},50    PriorityMode priority_mode = PriorityMode::kDontApply);51 52/**53 * The same as NewDefaultPlatform but disables the worker thread pool.54 * It must be used with the --single-threaded V8 flag.55 */56V8_PLATFORM_EXPORT std::unique_ptr<v8::Platform>57NewSingleThreadedDefaultPlatform(58    IdleTaskSupport idle_task_support = IdleTaskSupport::kDisabled,59    InProcessStackDumping in_process_stack_dumping =60        InProcessStackDumping::kDisabled,61    std::unique_ptr<v8::TracingController> tracing_controller = {});62 63/**64 * Returns a new instance of the default v8::JobHandle implementation.65 *66 * The job will be executed by spawning up to |num_worker_threads| many worker67 * threads on the provided |platform| with the given |priority|.68 */69V8_PLATFORM_EXPORT std::unique_ptr<v8::JobHandle> NewDefaultJobHandle(70    v8::Platform* platform, v8::TaskPriority priority,71    std::unique_ptr<v8::JobTask> job_task, size_t num_worker_threads);72 73/**74 * Pumps the message loop for the given isolate.75 *76 * The caller has to make sure that this is called from the right thread.77 * Returns true if a task was executed, and false otherwise. If the call to78 * PumpMessageLoop is nested within another call to PumpMessageLoop, only79 * nestable tasks may run. Otherwise, any task may run. Unless requested through80 * the |behavior| parameter, this call does not block if no task is pending. The81 * |platform| has to be created using |NewDefaultPlatform|.82 */83V8_PLATFORM_EXPORT bool PumpMessageLoop(84    v8::Platform* platform, v8::Isolate* isolate,85    MessageLoopBehavior behavior = MessageLoopBehavior::kDoNotWait);86 87/**88 * Runs pending idle tasks for at most |idle_time_in_seconds| seconds.89 *90 * The caller has to make sure that this is called from the right thread.91 * This call does not block if no task is pending. The |platform| has to be92 * created using |NewDefaultPlatform|.93 */94V8_PLATFORM_EXPORT void RunIdleTasks(v8::Platform* platform,95                                     v8::Isolate* isolate,96                                     double idle_time_in_seconds);97 98/**99 * Notifies the given platform about the Isolate getting deleted soon. Has to be100 * called for all Isolates which are deleted - unless we're shutting down the101 * platform.102 *103 * The |platform| has to be created using |NewDefaultPlatform|.104 *105 */106V8_PLATFORM_EXPORT void NotifyIsolateShutdown(v8::Platform* platform,107                                              Isolate* isolate);108 109}  // namespace platform110}  // namespace v8111 112#endif  // V8_LIBPLATFORM_LIBPLATFORM_H_113