v8  8.4.371(node14.15.0)
V8 is Google's open source JavaScript engine
libplatform.h
Go to the documentation of this file.
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 be
3 // 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 
15 namespace v8 {
16 namespace platform {
17 
20 
21 enum class MessageLoopBehavior : bool {
22  kDoNotWait = false,
23  kWaitForWork = true
24 };
25 
26 /**
27  * Returns a new instance of the default v8::Platform implementation.
28  *
29  * The caller will take ownership of the returned pointer. |thread_pool_size|
30  * is the number of worker threads to allocate for background jobs. If a value
31  * of zero is passed, a suitable default based on the current number of
32  * processors online will be chosen.
33  * If |idle_task_support| is enabled then the platform will accept idle
34  * tasks (IdleTasksEnabled will return true) and will rely on the embedder
35  * calling v8::platform::RunIdleTasks to process the idle tasks.
36  * If |tracing_controller| is nullptr, the default platform will create a
37  * v8::platform::TracingController instance and use it.
38  */
40  int thread_pool_size = 0,
41  IdleTaskSupport idle_task_support = IdleTaskSupport::kDisabled,
42  InProcessStackDumping in_process_stack_dumping =
44  std::unique_ptr<v8::TracingController> tracing_controller = {});
45 
46 /**
47  * Pumps the message loop for the given isolate.
48  *
49  * The caller has to make sure that this is called from the right thread.
50  * Returns true if a task was executed, and false otherwise. If the call to
51  * PumpMessageLoop is nested within another call to PumpMessageLoop, only
52  * nestable tasks may run. Otherwise, any task may run. Unless requested through
53  * the |behavior| parameter, this call does not block if no task is pending. The
54  * |platform| has to be created using |NewDefaultPlatform|.
55  */
57  v8::Platform* platform, v8::Isolate* isolate,
59 
60 /**
61  * Runs pending idle tasks for at most |idle_time_in_seconds| seconds.
62  *
63  * The caller has to make sure that this is called from the right thread.
64  * This call does not block if no task is pending. The |platform| has to be
65  * created using |NewDefaultPlatform|.
66  */
68  v8::Isolate* isolate,
69  double idle_time_in_seconds);
70 
71 /**
72  * Attempts to set the tracing controller for the given platform.
73  *
74  * The |platform| has to be created using |NewDefaultPlatform|.
75  *
76  */
77 V8_DEPRECATE_SOON("Access the DefaultPlatform directly")
79  v8::Platform* platform,
80  v8::platform::tracing::TracingController* tracing_controller);
81 
82 } // namespace platform
83 } // namespace v8
84 
85 #endif // V8_LIBPLATFORM_LIBPLATFORM_H_
V8_DEPRECATE_SOON
#define V8_DEPRECATE_SOON(message)
Definition: v8config.h:404
v8::platform::MessageLoopBehavior
MessageLoopBehavior
Definition: libplatform.h:21
v8::platform::InProcessStackDumping::kDisabled
@ kDisabled
v8::platform::InProcessStackDumping::kEnabled
@ kEnabled
v8::platform::MessageLoopBehavior::kDoNotWait
@ kDoNotWait
v8::platform::IdleTaskSupport
IdleTaskSupport
Definition: libplatform.h:18
v8::platform
Definition: libplatform.h:16
v8::platform::PumpMessageLoop
V8_PLATFORM_EXPORT bool PumpMessageLoop(v8::Platform *platform, v8::Isolate *isolate, MessageLoopBehavior behavior=MessageLoopBehavior::kDoNotWait)
v8::TracingController
Definition: v8-platform.h:235
v8::Isolate
Definition: v8.h:8129
v8::platform::SetTracingController
V8_PLATFORM_EXPORT void SetTracingController(v8::Platform *platform, v8::platform::tracing::TracingController *tracing_controller)
v8
Definition: libplatform.h:15
v8::platform::tracing
Definition: v8-tracing.h:31
v8::platform::RunIdleTasks
V8_PLATFORM_EXPORT void RunIdleTasks(v8::Platform *platform, v8::Isolate *isolate, double idle_time_in_seconds)
v8::Platform
Definition: v8-platform.h:386
V8_PLATFORM_EXPORT
#define V8_PLATFORM_EXPORT
Definition: libplatform-export.h:24
v8::platform::IdleTaskSupport::kEnabled
@ kEnabled
v8::platform::tracing::TracingController
Definition: v8-tracing.h:234
v8::platform::IdleTaskSupport::kDisabled
@ kDisabled
v8::platform::InProcessStackDumping
InProcessStackDumping
Definition: libplatform.h:19
v8::platform::MessageLoopBehavior::kWaitForWork
@ kWaitForWork
v8::platform::NewDefaultPlatform
V8_PLATFORM_EXPORT std::unique_ptr< v8::Platform > NewDefaultPlatform(int thread_pool_size=0, IdleTaskSupport idle_task_support=IdleTaskSupport::kDisabled, InProcessStackDumping in_process_stack_dumping=InProcessStackDumping::kDisabled, std::unique_ptr< v8::TracingController > tracing_controller={})