1// Copyright 2011 the V8 project authors. All rights reserved.
2// Redistribution and use in source and binary forms, with or without
3// modification, are permitted provided that the following conditions are
4// met:
5//
6//     * Redistributions of source code must retain the above copyright
7//       notice, this list of conditions and the following disclaimer.
8//     * Redistributions in binary form must reproduce the above
9//       copyright notice, this list of conditions and the following
10//       disclaimer in the documentation and/or other materials provided
11//       with the distribution.
12//     * Neither the name of Google Inc. nor the names of its
13//       contributors may be used to endorse or promote products derived
14//       from this software without specific prior written permission.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
17// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
20// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
28//
29// Top include for all V8 .cc files.
30//
31
32#ifndef V8_V8_H_
33#define V8_V8_H_
34
35#if defined(GOOGLE3)
36// Google3 special flag handling.
37#if defined(DEBUG) && defined(NDEBUG)
38// V8 only uses DEBUG and whenever it is set we are building a debug
39// version of V8. We do not use NDEBUG and simply undef it here for
40// consistency.
41#undef NDEBUG
42#endif
43#endif  // defined(GOOGLE3)
44
45// V8 only uses DEBUG, but included external files
46// may use NDEBUG - make sure they are consistent.
47#if defined(DEBUG) && defined(NDEBUG)
48#error both DEBUG and NDEBUG are set
49#endif
50
51// Basic includes
52#include "../include/v8.h"
53#include "v8globals.h"
54#include "v8checks.h"
55#include "allocation.h"
56#include "v8utils.h"
57#include "flags.h"
58
59// Objects & heap
60#include "objects-inl.h"
61#include "spaces-inl.h"
62#include "heap-inl.h"
63#include "incremental-marking-inl.h"
64#include "mark-compact-inl.h"
65#include "log-inl.h"
66#include "cpu-profiler-inl.h"
67#include "handles-inl.h"
68
69namespace v8 {
70namespace internal {
71
72class Deserializer;
73
74class V8 : public AllStatic {
75 public:
76  // Global actions.
77
78  // If Initialize is called with des == NULL, the initial state is
79  // created from scratch. If a non-null Deserializer is given, the
80  // initial state is created by reading the deserialized data into an
81  // empty heap.
82  static bool Initialize(Deserializer* des);
83  static void TearDown();
84  static bool IsRunning() { return is_running_; }
85  static bool UseCrankshaft() { return use_crankshaft_; }
86  // To be dead you have to have lived
87  // TODO(isolates): move IsDead to Isolate.
88  static bool IsDead() { return has_fatal_error_ || has_been_disposed_; }
89  static void SetFatalError();
90
91  // Report process out of memory. Implementation found in api.cc.
92  static void FatalProcessOutOfMemory(const char* location,
93                                      bool take_snapshot = false);
94
95  // Allows an entropy source to be provided for use in random number
96  // generation.
97  static void SetEntropySource(EntropySource source);
98  // Support for return-address rewriting profilers.
99  static void SetReturnAddressLocationResolver(
100      ReturnAddressLocationResolver resolver);
101  // Random number generation support. Not cryptographically safe.
102  static uint32_t Random(Context* context);
103  // We use random numbers internally in memory allocation and in the
104  // compilers for security. In order to prevent information leaks we
105  // use a separate random state for internal random number
106  // generation.
107  static uint32_t RandomPrivate(Isolate* isolate);
108  static Object* FillHeapNumberWithRandom(Object* heap_number,
109                                          Context* context);
110
111  // Idle notification directly from the API.
112  static bool IdleNotification(int hint);
113
114  static void AddCallCompletedCallback(CallCompletedCallback callback);
115  static void RemoveCallCompletedCallback(CallCompletedCallback callback);
116  static void FireCallCompletedCallback(Isolate* isolate);
117
118 private:
119  static void InitializeOncePerProcessImpl();
120  static void InitializeOncePerProcess();
121
122  // True if engine is currently running
123  static bool is_running_;
124  // True if V8 has ever been run
125  static bool has_been_set_up_;
126  // True if error has been signaled for current engine
127  // (reset to false if engine is restarted)
128  static bool has_fatal_error_;
129  // True if engine has been shut down
130  // (reset if engine is restarted)
131  static bool has_been_disposed_;
132  // True if we are using the crankshaft optimizing compiler.
133  static bool use_crankshaft_;
134  // List of callbacks when a Call completes.
135  static List<CallCompletedCallback>* call_completed_callbacks_;
136};
137
138
139// JavaScript defines two kinds of 'nil'.
140enum NilValue { kNullValue, kUndefinedValue };
141
142
143// JavaScript defines two kinds of equality.
144enum EqualityKind { kStrictEquality, kNonStrictEquality };
145
146
147} }  // namespace v8::internal
148
149namespace i = v8::internal;
150
151#endif  // V8_V8_H_
152