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 "libplatform/libplatform-export.h"
9#include "libplatform/v8-tracing.h"
10#include "v8-platform.h"  // NOLINT(build/include)
11
12namespace v8 {
13namespace platform {
14
15/**
16 * Returns a new instance of the default v8::Platform implementation.
17 *
18 * The caller will take ownership of the returned pointer. |thread_pool_size|
19 * is the number of worker threads to allocate for background jobs. If a value
20 * of zero is passed, a suitable default based on the current number of
21 * processors online will be chosen.
22 */
23V8_PLATFORM_EXPORT v8::Platform* CreateDefaultPlatform(
24    int thread_pool_size = 0);
25
26/**
27 * Pumps the message loop for the given isolate.
28 *
29 * The caller has to make sure that this is called from the right thread.
30 * Returns true if a task was executed, and false otherwise. This call does
31 * not block if no task is pending. The |platform| has to be created using
32 * |CreateDefaultPlatform|.
33 */
34V8_PLATFORM_EXPORT bool PumpMessageLoop(v8::Platform* platform,
35                                        v8::Isolate* isolate);
36
37/**
38 * Runs pending idle tasks for at most |idle_time_in_seconds| seconds.
39 *
40 * The caller has to make sure that this is called from the right thread.
41 * This call does not block if no task is pending. The |platform| has to be
42 * created using |CreateDefaultPlatform|.
43 */
44V8_PLATFORM_EXPORT void RunIdleTasks(v8::Platform* platform,
45                                     v8::Isolate* isolate,
46                                     double idle_time_in_seconds);
47
48/**
49 * Attempts to set the tracing controller for the given platform.
50 *
51 * The |platform| has to be created using |CreateDefaultPlatform|.
52 */
53V8_PLATFORM_EXPORT void SetTracingController(
54    v8::Platform* platform,
55    v8::platform::tracing::TracingController* tracing_controller);
56
57}  // namespace platform
58}  // namespace v8
59
60#endif  // V8_LIBPLATFORM_LIBPLATFORM_H_
61