src/v8/src/d8.h

   1 // Copyright 2012 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_D8_H_
   6 #define V8_D8_H_
   7
   8 #ifndef V8_SHARED
   9 #include "src/allocation.h"
  10 #include "src/hashmap.h"
  11 #include "src/smart-pointers.h"
  12 #include "src/v8.h"
  13 #else
  14 #include "include/v8.h"
  15 #endif  // !V8_SHARED
  16
  17 namespace v8 {
  18
  19
  20 #ifndef V8_SHARED
  21 // A single counter in a counter collection.
  22 class Counter {
  23  public:
  24   static const int kMaxNameSize = 64;
  25   int32_t* Bind(const char* name, bool histogram);
  26   int32_t* ptr() { return &count_; }
  27   int32_t count() { return count_; }
  28   int32_t sample_total() { return sample_total_; }
  29   bool is_histogram() { return is_histogram_; }
  30   void AddSample(int32_t sample);
  31  private:
  32   int32_t count_;
  33   int32_t sample_total_;
  34   bool is_histogram_;
  35   uint8_t name_[kMaxNameSize];
  36 };
  37
  38
  39 // A set of counters and associated information.  An instance of this
  40 // class is stored directly in the memory-mapped counters file if
  41 // the --map-counters options is used
  42 class CounterCollection {
  43  public:
  44   CounterCollection();
  45   Counter* GetNextCounter();
  46  private:
  47   static const unsigned kMaxCounters = 512;
  48   uint32_t magic_number_;
  49   uint32_t max_counters_;
  50   uint32_t max_name_size_;
  51   uint32_t counters_in_use_;
  52   Counter counters_[kMaxCounters];
  53 };
  54
  55
  56 class CounterMap {
  57  public:
  58   CounterMap(): hash_map_(Match) { }
  59   Counter* Lookup(const char* name) {
  60     i::HashMap::Entry* answer = hash_map_.Lookup(
  61         const_cast<char*>(name),
  62         Hash(name),
  63         false);
  64     if (!answer) return NULL;
  65     return reinterpret_cast<Counter*>(answer->value);
  66   }
  67   void Set(const char* name, Counter* value) {
  68     i::HashMap::Entry* answer = hash_map_.Lookup(
  69         const_cast<char*>(name),
  70         Hash(name),
  71         true);
  72     DCHECK(answer != NULL);
  73     answer->value = value;
  74   }
  75   class Iterator {
  76    public:
  77     explicit Iterator(CounterMap* map)
  78         : map_(&map->hash_map_), entry_(map_->Start()) { }
  79     void Next() { entry_ = map_->Next(entry_); }
  80     bool More() { return entry_ != NULL; }
  81     const char* CurrentKey() { return static_cast<const char*>(entry_->key); }
  82     Counter* CurrentValue() { return static_cast<Counter*>(entry_->value); }
  83    private:
  84     i::HashMap* map_;
  85     i::HashMap::Entry* entry_;
  86   };
  87
  88  private:
  89   static int Hash(const char* name);
  90   static bool Match(void* key1, void* key2);
  91   i::HashMap hash_map_;
  92 };
  93 #endif  // !V8_SHARED
  94
  95
  96 class LineEditor {
  97  public:
  98   enum Type { DUMB = 0, READLINE = 1 };
  99   LineEditor(Type type, const char* name);
 100   virtual ~LineEditor() { }
 101
 102   virtual Handle<String> Prompt(const char* prompt) = 0;
 103   virtual bool Open(Isolate* isolate) { return true; }
 104   virtual bool Close() { return true; }
 105   virtual void AddHistory(const char* str) { }
 106
 107   const char* name() { return name_; }
 108   static LineEditor* Get() { return current_; }
 109  private:
 110   Type type_;
 111   const char* name_;
 112   static LineEditor* current_;
 113 };
 114
 115
 116 class SourceGroup {
 117  public:
 118   SourceGroup() :
 119 #ifndef V8_SHARED
 120       next_semaphore_(0),
 121       done_semaphore_(0),
 122       thread_(NULL),
 123 #endif  // !V8_SHARED
 124       argv_(NULL),
 125       begin_offset_(0),
 126       end_offset_(0) {}
 127
 128   ~SourceGroup();
 129
 130   void Begin(char** argv, int offset) {
 131     argv_ = const_cast<const char**>(argv);
 132     begin_offset_ = offset;
 133   }
 134
 135   void End(int offset) { end_offset_ = offset; }
 136
 137   void Execute(Isolate* isolate);
 138
 139 #ifndef V8_SHARED
 140   void StartExecuteInThread();
 141   void WaitForThread();
 142
 143  private:
 144   class IsolateThread : public base::Thread {
 145    public:
 146     explicit IsolateThread(SourceGroup* group)
 147         : base::Thread(GetThreadOptions()), group_(group) {}
 148
 149     virtual void Run() {
 150       group_->ExecuteInThread();
 151     }
 152
 153    private:
 154     SourceGroup* group_;
 155   };
 156
 157   static base::Thread::Options GetThreadOptions();
 158   void ExecuteInThread();
 159
 160   base::Semaphore next_semaphore_;
 161   base::Semaphore done_semaphore_;
 162   base::Thread* thread_;
 163 #endif  // !V8_SHARED
 164
 165   void ExitShell(int exit_code);
 166   Handle<String> ReadFile(Isolate* isolate, const char* name);
 167
 168   const char** argv_;
 169   int begin_offset_;
 170   int end_offset_;
 171 };
 172
 173
 174 class BinaryResource : public v8::String::ExternalAsciiStringResource {
 175  public:
 176   BinaryResource(const char* string, int length)
 177       : data_(string),
 178         length_(length) { }
 179
 180   ~BinaryResource() {
 181     delete[] data_;
 182     data_ = NULL;
 183     length_ = 0;
 184   }
 185
 186   virtual const char* data() const { return data_; }
 187   virtual size_t length() const { return length_; }
 188
 189  private:
 190   const char* data_;
 191   size_t length_;
 192 };
 193
 194
 195 class ShellOptions {
 196  public:
 197   ShellOptions()
 198       : script_executed(false),
 199         last_run(true),
 200         send_idle_notification(false),
 201         invoke_weak_callbacks(false),
 202         stress_opt(false),
 203         stress_deopt(false),
 204         interactive_shell(false),
 205         test_shell(false),
 206         dump_heap_constants(false),
 207         expected_to_throw(false),
 208         mock_arraybuffer_allocator(false),
 209         num_isolates(1),
 210         compile_options(v8::ScriptCompiler::kNoCompileOptions),
 211         isolate_sources(NULL),
 212         icu_data_file(NULL),
 213         natives_blob(NULL),
 214         snapshot_blob(NULL) {}
 215
 216   ~ShellOptions() {
 217     delete[] isolate_sources;
 218   }
 219
 220   bool use_interactive_shell() {
 221     return (interactive_shell || !script_executed) && !test_shell;
 222   }
 223
 224   bool script_executed;
 225   bool last_run;
 226   bool send_idle_notification;
 227   bool invoke_weak_callbacks;
 228   bool stress_opt;
 229   bool stress_deopt;
 230   bool interactive_shell;
 231   bool test_shell;
 232   bool dump_heap_constants;
 233   bool expected_to_throw;
 234   bool mock_arraybuffer_allocator;
 235   int num_isolates;
 236   v8::ScriptCompiler::CompileOptions compile_options;
 237   SourceGroup* isolate_sources;
 238   const char* icu_data_file;
 239   const char* natives_blob;
 240   const char* snapshot_blob;
 241 };
 242
 243 #ifdef V8_SHARED
 244 class Shell {
 245 #else
 246 class Shell : public i::AllStatic {
 247 #endif  // V8_SHARED
 248
 249  public:
 250   static Local<UnboundScript> CompileString(
 251       Isolate* isolate, Local<String> source, Local<Value> name,
 252       v8::ScriptCompiler::CompileOptions compile_options);
 253   static bool ExecuteString(Isolate* isolate,
 254                             Handle<String> source,
 255                             Handle<Value> name,
 256                             bool print_result,
 257                             bool report_exceptions);
 258   static const char* ToCString(const v8::String::Utf8Value& value);
 259   static void ReportException(Isolate* isolate, TryCatch* try_catch);
 260   static Handle<String> ReadFile(Isolate* isolate, const char* name);
 261   static Local<Context> CreateEvaluationContext(Isolate* isolate);
 262   static int RunMain(Isolate* isolate, int argc, char* argv[]);
 263   static int Main(int argc, char* argv[]);
 264   static void Exit(int exit_code);
 265   static void OnExit();
 266
 267 #ifndef V8_SHARED
 268   static Handle<Array> GetCompletions(Isolate* isolate,
 269                                       Handle<String> text,
 270                                       Handle<String> full);
 271   static int* LookupCounter(const char* name);
 272   static void* CreateHistogram(const char* name,
 273                                int min,
 274                                int max,
 275                                size_t buckets);
 276   static void AddHistogramSample(void* histogram, int sample);
 277   static void MapCounters(v8::Isolate* isolate, const char* name);
 278
 279   static Local<Object> DebugMessageDetails(Isolate* isolate,
 280                                            Handle<String> message);
 281   static Local<Value> DebugCommandToJSONRequest(Isolate* isolate,
 282                                                 Handle<String> command);
 283
 284   static void PerformanceNow(const v8::FunctionCallbackInfo<v8::Value>& args);
 285 #endif  // !V8_SHARED
 286
 287   static void RealmCurrent(const v8::FunctionCallbackInfo<v8::Value>& args);
 288   static void RealmOwner(const v8::FunctionCallbackInfo<v8::Value>& args);
 289   static void RealmGlobal(const v8::FunctionCallbackInfo<v8::Value>& args);
 290   static void RealmCreate(const v8::FunctionCallbackInfo<v8::Value>& args);
 291   static void RealmDispose(const v8::FunctionCallbackInfo<v8::Value>& args);
 292   static void RealmSwitch(const v8::FunctionCallbackInfo<v8::Value>& args);
 293   static void RealmEval(const v8::FunctionCallbackInfo<v8::Value>& args);
 294   static void RealmSharedGet(Local<String> property,
 295                              const  PropertyCallbackInfo<Value>& info);
 296   static void RealmSharedSet(Local<String> property,
 297                              Local<Value> value,
 298                              const  PropertyCallbackInfo<void>& info);
 299
 300   static void Print(const v8::FunctionCallbackInfo<v8::Value>& args);
 301   static void Write(const v8::FunctionCallbackInfo<v8::Value>& args);
 302   static void Quit(const v8::FunctionCallbackInfo<v8::Value>& args);
 303   static void Version(const v8::FunctionCallbackInfo<v8::Value>& args);
 304   static void Read(const v8::FunctionCallbackInfo<v8::Value>& args);
 305   static void ReadBuffer(const v8::FunctionCallbackInfo<v8::Value>& args);
 306   static Handle<String> ReadFromStdin(Isolate* isolate);
 307   static void ReadLine(const v8::FunctionCallbackInfo<v8::Value>& args) {
 308     args.GetReturnValue().Set(ReadFromStdin(args.GetIsolate()));
 309   }
 310   static void Load(const v8::FunctionCallbackInfo<v8::Value>& args);
 311   static void ArrayBuffer(const v8::FunctionCallbackInfo<v8::Value>& args);
 312   static void Int8Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 313   static void Uint8Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 314   static void Int16Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 315   static void Uint16Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 316   static void Int32Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 317   static void Uint32Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 318   static void Float32Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 319   static void Float64Array(const v8::FunctionCallbackInfo<v8::Value>& args);
 320   static void Uint8ClampedArray(
 321       const v8::FunctionCallbackInfo<v8::Value>& args);
 322   static void ArrayBufferSlice(const v8::FunctionCallbackInfo<v8::Value>& args);
 323   static void ArraySubArray(const v8::FunctionCallbackInfo<v8::Value>& args);
 324   static void ArraySet(const v8::FunctionCallbackInfo<v8::Value>& args);
 325   // The OS object on the global object contains methods for performing
 326   // operating system calls:
 327   //
 328   // os.system("program_name", ["arg1", "arg2", ...], timeout1, timeout2) will
 329   // run the command, passing the arguments to the program.  The standard output
 330   // of the program will be picked up and returned as a multiline string.  If
 331   // timeout1 is present then it should be a number.  -1 indicates no timeout
 332   // and a positive number is used as a timeout in milliseconds that limits the
 333   // time spent waiting between receiving output characters from the program.
 334   // timeout2, if present, should be a number indicating the limit in
 335   // milliseconds on the total running time of the program.  Exceptions are
 336   // thrown on timeouts or other errors or if the exit status of the program
 337   // indicates an error.
 338   //
 339   // os.chdir(dir) changes directory to the given directory.  Throws an
 340   // exception/ on error.
 341   //
 342   // os.setenv(variable, value) sets an environment variable.  Repeated calls to
 343   // this method leak memory due to the API of setenv in the standard C library.
 344   //
 345   // os.umask(alue) calls the umask system call and returns the old umask.
 346   //
 347   // os.mkdirp(name, mask) creates a directory.  The mask (if present) is anded
 348   // with the current umask.  Intermediate directories are created if necessary.
 349   // An exception is not thrown if the directory already exists.  Analogous to
 350   // the "mkdir -p" command.
 351   static void OSObject(const v8::FunctionCallbackInfo<v8::Value>& args);
 352   static void System(const v8::FunctionCallbackInfo<v8::Value>& args);
 353   static void ChangeDirectory(const v8::FunctionCallbackInfo<v8::Value>& args);
 354   static void SetEnvironment(const v8::FunctionCallbackInfo<v8::Value>& args);
 355   static void UnsetEnvironment(const v8::FunctionCallbackInfo<v8::Value>& args);
 356   static void SetUMask(const v8::FunctionCallbackInfo<v8::Value>& args);
 357   static void MakeDirectory(const v8::FunctionCallbackInfo<v8::Value>& args);
 358   static void RemoveDirectory(const v8::FunctionCallbackInfo<v8::Value>& args);
 359
 360   static void AddOSMethods(v8::Isolate* isolate,
 361                            Handle<ObjectTemplate> os_template);
 362
 363   static const char* kPrompt;
 364   static ShellOptions options;
 365
 366  private:
 367   static Persistent<Context> evaluation_context_;
 368 #ifndef V8_SHARED
 369   static Persistent<Context> utility_context_;
 370   static CounterMap* counter_map_;
 371   // We statically allocate a set of local counters to be used if we
 372   // don't want to store the stats in a memory-mapped file
 373   static CounterCollection local_counters_;
 374   static CounterCollection* counters_;
 375   static base::OS::MemoryMappedFile* counters_file_;
 376   static base::Mutex context_mutex_;
 377   static const base::TimeTicks kInitialTicks;
 378
 379   static Counter* GetCounter(const char* name, bool is_histogram);
 380   static void InstallUtilityScript(Isolate* isolate);
 381 #endif  // !V8_SHARED
 382   static void Initialize(Isolate* isolate);
 383   static void InitializeDebugger(Isolate* isolate);
 384   static void RunShell(Isolate* isolate);
 385   static bool SetOptions(int argc, char* argv[]);
 386   static Handle<ObjectTemplate> CreateGlobalTemplate(Isolate* isolate);
 387   static Handle<FunctionTemplate> CreateArrayBufferTemplate(FunctionCallback);
 388   static Handle<FunctionTemplate> CreateArrayTemplate(FunctionCallback);
 389   static Handle<Value> CreateExternalArrayBuffer(Isolate* isolate,
 390                                                  Handle<Object> buffer,
 391                                                  int32_t size);
 392   static Handle<Object> CreateExternalArray(Isolate* isolate,
 393                                             Handle<Object> array,
 394                                             Handle<Object> buffer,
 395                                             ExternalArrayType type,
 396                                             int32_t length,
 397                                             int32_t byteLength,
 398                                             int32_t byteOffset,
 399                                             int32_t element_size);
 400   static void CreateExternalArray(
 401       const v8::FunctionCallbackInfo<v8::Value>& args,
 402       ExternalArrayType type,
 403       int32_t element_size);
 404   static void ExternalArrayWeakCallback(Isolate* isolate,
 405                                         Persistent<Object>* object,
 406                                         uint8_t* data);
 407 };
 408
 409
 410 }  // namespace v8
 411
 412
 413 #endif  // V8_D8_H_