v8.h revision 257744e915dfc84d6d07a6b2accf8402d9ffc708 
1// Copyright 2006-2008 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// If both are defined in Google3, then we are building an optimized v8 with
39// assertions enabled.
40#undef NDEBUG
41#elif !defined(DEBUG) && !defined(NDEBUG)
42// If neither is defined in Google3, then we are building a debug v8. Mark it
43// as such.
44#define DEBUG
45#endif
46#endif  // defined(GOOGLE3)
47
48// V8 only uses DEBUG, but included external files
49// may use NDEBUG - make sure they are consistent.
50#if defined(DEBUG) && defined(NDEBUG)
51#error both DEBUG and NDEBUG are set
52#endif
53
54// Basic includes
55#include "../include/v8.h"
56#include "v8globals.h"
57#include "v8checks.h"
58#include "allocation.h"
59#include "v8utils.h"
60#include "flags.h"
61
62// Objects & heap
63#include "objects-inl.h"
64#include "spaces-inl.h"
65#include "heap-inl.h"
66#include "log-inl.h"
67#include "cpu-profiler-inl.h"
68#include "handles-inl.h"
69#include "isolate-inl.h"
70
71namespace v8 {
72namespace internal {
73
74class Deserializer;
75
76class V8 : public AllStatic {
77 public:
78  // Global actions.
79
80  // If Initialize is called with des == NULL, the initial state is
81  // created from scratch. If a non-null Deserializer is given, the
82  // initial state is created by reading the deserialized data into an
83  // empty heap.
84  static bool Initialize(Deserializer* des);
85  static void TearDown();
86  static bool IsRunning() { return is_running_; }
87  static bool UseCrankshaft() { return use_crankshaft_; }
88  // To be dead you have to have lived
89  // TODO(isolates): move IsDead to Isolate.
90  static bool IsDead() { return has_fatal_error_ || has_been_disposed_; }
91  static void SetFatalError();
92
93  // Report process out of memory. Implementation found in api.cc.
94  static void FatalProcessOutOfMemory(const char* location,
95                                      bool take_snapshot = false);
96
97  // Random number generation support. Not cryptographically safe.
98  static uint32_t Random(Isolate* isolate);
99  // We use random numbers internally in memory allocation and in the
100  // compilers for security. In order to prevent information leaks we
101  // use a separate random state for internal random number
102  // generation.
103  static uint32_t RandomPrivate(Isolate* isolate);
104  static Object* FillHeapNumberWithRandom(Object* heap_number,
105                                          Isolate* isolate);
106
107  // Idle notification directly from the API.
108  static bool IdleNotification();
109
110 private:
111  static void InitializeOncePerProcess();
112
113  // True if engine is currently running
114  static bool is_running_;
115  // True if V8 has ever been run
116  static bool has_been_setup_;
117  // True if error has been signaled for current engine
118  // (reset to false if engine is restarted)
119  static bool has_fatal_error_;
120  // True if engine has been shut down
121  // (reset if engine is restarted)
122  static bool has_been_disposed_;
123  // True if we are using the crankshaft optimizing compiler.
124  static bool use_crankshaft_;
125};
126
127} }  // namespace v8::internal
128
129namespace i = v8::internal;
130
131#endif  // V8_V8_H_
132