src/api.h

   1 // Copyright 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 #ifndef V8_API_H_
  29 #define V8_API_H_
  30
  31 #include "apiutils.h"
  32 #include "factory.h"
  33
  34 #include "../include/v8-testing.h"
  35
  36 namespace v8 {
  37
  38 // Constants used in the implementation of the API.  The most natural thing
  39 // would usually be to place these with the classes that use them, but
  40 // we want to keep them out of v8.h because it is an externally
  41 // visible file.
  42 class Consts {
  43  public:
  44   enum TemplateType {
  45     FUNCTION_TEMPLATE = 0,
  46     OBJECT_TEMPLATE = 1
  47   };
  48 };
  49
  50
  51 // Utilities for working with neander-objects, primitive
  52 // env-independent JSObjects used by the api.
  53 class NeanderObject {
  54  public:
  55   explicit NeanderObject(int size);
  56   inline NeanderObject(v8::internal::Handle<v8::internal::Object> obj);
  57   inline NeanderObject(v8::internal::Object* obj);
  58   inline v8::internal::Object* get(int index);
  59   inline void set(int index, v8::internal::Object* value);
  60   inline v8::internal::Handle<v8::internal::JSObject> value() { return value_; }
  61   int size();
  62  private:
  63   v8::internal::Handle<v8::internal::JSObject> value_;
  64 };
  65
  66
  67 // Utilities for working with neander-arrays, a simple extensible
  68 // array abstraction built on neander-objects.
  69 class NeanderArray {
  70  public:
  71   NeanderArray();
  72   inline NeanderArray(v8::internal::Handle<v8::internal::Object> obj);
  73   inline v8::internal::Handle<v8::internal::JSObject> value() {
  74     return obj_.value();
  75   }
  76
  77   void add(v8::internal::Handle<v8::internal::Object> value);
  78
  79   int length();
  80
  81   v8::internal::Object* get(int index);
  82   // Change the value at an index to undefined value. If the index is
  83   // out of bounds, the request is ignored. Returns the old value.
  84   void set(int index, v8::internal::Object* value);
  85  private:
  86   NeanderObject obj_;
  87 };
  88
  89
  90 NeanderObject::NeanderObject(v8::internal::Handle<v8::internal::Object> obj)
  91     : value_(v8::internal::Handle<v8::internal::JSObject>::cast(obj)) { }
  92
  93
  94 NeanderObject::NeanderObject(v8::internal::Object* obj)
  95     : value_(v8::internal::Handle<v8::internal::JSObject>(
  96         v8::internal::JSObject::cast(obj))) { }
  97
  98
  99 NeanderArray::NeanderArray(v8::internal::Handle<v8::internal::Object> obj)
 100     : obj_(obj) { }
 101
 102
 103 v8::internal::Object* NeanderObject::get(int offset) {
 104   ASSERT(value()->HasFastElements());
 105   return v8::internal::FixedArray::cast(value()->elements())->get(offset);
 106 }
 107
 108
 109 void NeanderObject::set(int offset, v8::internal::Object* value) {
 110   ASSERT(value_->HasFastElements());
 111   v8::internal::FixedArray::cast(value_->elements())->set(offset, value);
 112 }
 113
 114
 115 template <typename T> static inline T ToCData(v8::internal::Object* obj) {
 116   STATIC_ASSERT(sizeof(T) == sizeof(v8::internal::Address));
 117   return reinterpret_cast<T>(
 118       reinterpret_cast<intptr_t>(v8::internal::Proxy::cast(obj)->proxy()));
 119 }
 120
 121
 122 template <typename T>
 123 static inline v8::internal::Handle<v8::internal::Object> FromCData(T obj) {
 124   STATIC_ASSERT(sizeof(T) == sizeof(v8::internal::Address));
 125   return v8::internal::Factory::NewProxy(
 126       reinterpret_cast<v8::internal::Address>(reinterpret_cast<intptr_t>(obj)));
 127 }
 128
 129
 130 class ApiFunction {
 131  public:
 132   explicit ApiFunction(v8::internal::Address addr) : addr_(addr) { }
 133   v8::internal::Address address() { return addr_; }
 134  private:
 135   v8::internal::Address addr_;
 136 };
 137
 138
 139 enum ExtensionTraversalState {
 140   UNVISITED, VISITED, INSTALLED
 141 };
 142
 143
 144 class RegisteredExtension {
 145  public:
 146   explicit RegisteredExtension(Extension* extension);
 147   static void Register(RegisteredExtension* that);
 148   Extension* extension() { return extension_; }
 149   RegisteredExtension* next() { return next_; }
 150   RegisteredExtension* next_auto() { return next_auto_; }
 151   ExtensionTraversalState state() { return state_; }
 152   void set_state(ExtensionTraversalState value) { state_ = value; }
 153   static RegisteredExtension* first_extension() { return first_extension_; }
 154  private:
 155   Extension* extension_;
 156   RegisteredExtension* next_;
 157   RegisteredExtension* next_auto_;
 158   ExtensionTraversalState state_;
 159   static RegisteredExtension* first_extension_;
 160   static RegisteredExtension* first_auto_extension_;
 161 };
 162
 163
 164 class Utils {
 165  public:
 166   static bool ReportApiFailure(const char* location, const char* message);
 167
 168   static Local<FunctionTemplate> ToFunctionTemplate(NeanderObject obj);
 169   static Local<ObjectTemplate> ToObjectTemplate(NeanderObject obj);
 170
 171   static inline Local<Context> ToLocal(
 172       v8::internal::Handle<v8::internal::Context> obj);
 173   static inline Local<Value> ToLocal(
 174       v8::internal::Handle<v8::internal::Object> obj);
 175   static inline Local<Function> ToLocal(
 176       v8::internal::Handle<v8::internal::JSFunction> obj);
 177   static inline Local<String> ToLocal(
 178       v8::internal::Handle<v8::internal::String> obj);
 179   static inline Local<RegExp> ToLocal(
 180       v8::internal::Handle<v8::internal::JSRegExp> obj);
 181   static inline Local<Object> ToLocal(
 182       v8::internal::Handle<v8::internal::JSObject> obj);
 183   static inline Local<Array> ToLocal(
 184       v8::internal::Handle<v8::internal::JSArray> obj);
 185   static inline Local<External> ToLocal(
 186       v8::internal::Handle<v8::internal::Proxy> obj);
 187   static inline Local<Message> MessageToLocal(
 188       v8::internal::Handle<v8::internal::Object> obj);
 189   static inline Local<StackTrace> StackTraceToLocal(
 190       v8::internal::Handle<v8::internal::JSArray> obj);
 191   static inline Local<StackFrame> StackFrameToLocal(
 192       v8::internal::Handle<v8::internal::JSObject> obj);
 193   static inline Local<Number> NumberToLocal(
 194       v8::internal::Handle<v8::internal::Object> obj);
 195   static inline Local<Integer> IntegerToLocal(
 196       v8::internal::Handle<v8::internal::Object> obj);
 197   static inline Local<Uint32> Uint32ToLocal(
 198       v8::internal::Handle<v8::internal::Object> obj);
 199   static inline Local<FunctionTemplate> ToLocal(
 200       v8::internal::Handle<v8::internal::FunctionTemplateInfo> obj);
 201   static inline Local<ObjectTemplate> ToLocal(
 202       v8::internal::Handle<v8::internal::ObjectTemplateInfo> obj);
 203   static inline Local<Signature> ToLocal(
 204       v8::internal::Handle<v8::internal::SignatureInfo> obj);
 205   static inline Local<TypeSwitch> ToLocal(
 206       v8::internal::Handle<v8::internal::TypeSwitchInfo> obj);
 207
 208   static inline v8::internal::Handle<v8::internal::TemplateInfo>
 209       OpenHandle(const Template* that);
 210   static inline v8::internal::Handle<v8::internal::FunctionTemplateInfo>
 211       OpenHandle(const FunctionTemplate* that);
 212   static inline v8::internal::Handle<v8::internal::ObjectTemplateInfo>
 213       OpenHandle(const ObjectTemplate* that);
 214   static inline v8::internal::Handle<v8::internal::Object>
 215       OpenHandle(const Data* data);
 216   static inline v8::internal::Handle<v8::internal::JSRegExp>
 217       OpenHandle(const RegExp* data);
 218   static inline v8::internal::Handle<v8::internal::JSObject>
 219       OpenHandle(const v8::Object* data);
 220   static inline v8::internal::Handle<v8::internal::JSArray>
 221       OpenHandle(const v8::Array* data);
 222   static inline v8::internal::Handle<v8::internal::String>
 223       OpenHandle(const String* data);
 224   static inline v8::internal::Handle<v8::internal::Object>
 225       OpenHandle(const Script* data);
 226   static inline v8::internal::Handle<v8::internal::JSFunction>
 227       OpenHandle(const Function* data);
 228   static inline v8::internal::Handle<v8::internal::JSObject>
 229       OpenHandle(const Message* message);
 230   static inline v8::internal::Handle<v8::internal::JSArray>
 231       OpenHandle(const StackTrace* stack_trace);
 232   static inline v8::internal::Handle<v8::internal::JSObject>
 233       OpenHandle(const StackFrame* stack_frame);
 234   static inline v8::internal::Handle<v8::internal::Context>
 235       OpenHandle(const v8::Context* context);
 236   static inline v8::internal::Handle<v8::internal::SignatureInfo>
 237       OpenHandle(const v8::Signature* sig);
 238   static inline v8::internal::Handle<v8::internal::TypeSwitchInfo>
 239       OpenHandle(const v8::TypeSwitch* that);
 240   static inline v8::internal::Handle<v8::internal::Proxy>
 241       OpenHandle(const v8::External* that);
 242 };
 243
 244
 245 template <class T>
 246 static inline T* ToApi(v8::internal::Handle<v8::internal::Object> obj) {
 247   return reinterpret_cast<T*>(obj.location());
 248 }
 249
 250
 251 template <class T>
 252 v8::internal::Handle<T> v8::internal::Handle<T>::EscapeFrom(
 253     v8::HandleScope* scope) {
 254   v8::internal::Handle<T> handle;
 255   if (!is_null()) {
 256     handle = *this;
 257   }
 258   return Utils::OpenHandle(*scope->Close(Utils::ToLocal(handle)));
 259 }
 260
 261
 262 // Implementations of ToLocal
 263
 264 #define MAKE_TO_LOCAL(Name, From, To)                                       \
 265   Local<v8::To> Utils::Name(v8::internal::Handle<v8::internal::From> obj) { \
 266     ASSERT(obj.is_null() || !obj->IsTheHole());                             \
 267     return Local<To>(reinterpret_cast<To*>(obj.location()));                \
 268   }
 269
 270 MAKE_TO_LOCAL(ToLocal, Context, Context)
 271 MAKE_TO_LOCAL(ToLocal, Object, Value)
 272 MAKE_TO_LOCAL(ToLocal, JSFunction, Function)
 273 MAKE_TO_LOCAL(ToLocal, String, String)
 274 MAKE_TO_LOCAL(ToLocal, JSRegExp, RegExp)
 275 MAKE_TO_LOCAL(ToLocal, JSObject, Object)
 276 MAKE_TO_LOCAL(ToLocal, JSArray, Array)
 277 MAKE_TO_LOCAL(ToLocal, Proxy, External)
 278 MAKE_TO_LOCAL(ToLocal, FunctionTemplateInfo, FunctionTemplate)
 279 MAKE_TO_LOCAL(ToLocal, ObjectTemplateInfo, ObjectTemplate)
 280 MAKE_TO_LOCAL(ToLocal, SignatureInfo, Signature)
 281 MAKE_TO_LOCAL(ToLocal, TypeSwitchInfo, TypeSwitch)
 282 MAKE_TO_LOCAL(MessageToLocal, Object, Message)
 283 MAKE_TO_LOCAL(StackTraceToLocal, JSArray, StackTrace)
 284 MAKE_TO_LOCAL(StackFrameToLocal, JSObject, StackFrame)
 285 MAKE_TO_LOCAL(NumberToLocal, Object, Number)
 286 MAKE_TO_LOCAL(IntegerToLocal, Object, Integer)
 287 MAKE_TO_LOCAL(Uint32ToLocal, Object, Uint32)
 288
 289 #undef MAKE_TO_LOCAL
 290
 291
 292 // Implementations of OpenHandle
 293
 294 #define MAKE_OPEN_HANDLE(From, To) \
 295   v8::internal::Handle<v8::internal::To> Utils::OpenHandle(\
 296     const v8::From* that) { \
 297     return v8::internal::Handle<v8::internal::To>( \
 298         reinterpret_cast<v8::internal::To**>(const_cast<v8::From*>(that))); \
 299   }
 300
 301 MAKE_OPEN_HANDLE(Template, TemplateInfo)
 302 MAKE_OPEN_HANDLE(FunctionTemplate, FunctionTemplateInfo)
 303 MAKE_OPEN_HANDLE(ObjectTemplate, ObjectTemplateInfo)
 304 MAKE_OPEN_HANDLE(Signature, SignatureInfo)
 305 MAKE_OPEN_HANDLE(TypeSwitch, TypeSwitchInfo)
 306 MAKE_OPEN_HANDLE(Data, Object)
 307 MAKE_OPEN_HANDLE(RegExp, JSRegExp)
 308 MAKE_OPEN_HANDLE(Object, JSObject)
 309 MAKE_OPEN_HANDLE(Array, JSArray)
 310 MAKE_OPEN_HANDLE(String, String)
 311 MAKE_OPEN_HANDLE(Script, Object)
 312 MAKE_OPEN_HANDLE(Function, JSFunction)
 313 MAKE_OPEN_HANDLE(Message, JSObject)
 314 MAKE_OPEN_HANDLE(Context, Context)
 315 MAKE_OPEN_HANDLE(External, Proxy)
 316 MAKE_OPEN_HANDLE(StackTrace, JSArray)
 317 MAKE_OPEN_HANDLE(StackFrame, JSObject)
 318
 319 #undef MAKE_OPEN_HANDLE
 320
 321
 322 namespace internal {
 323
 324 // This class is here in order to be able to declare it a friend of
 325 // HandleScope.  Moving these methods to be members of HandleScope would be
 326 // neat in some ways, but it would expose external implementation details in
 327 // our public header file, which is undesirable.
 328 //
 329 // There is a singleton instance of this class to hold the per-thread data.
 330 // For multithreaded V8 programs this data is copied in and out of storage
 331 // so that the currently executing thread always has its own copy of this
 332 // data.
 333 class HandleScopeImplementer {
 334  public:
 335
 336   HandleScopeImplementer()
 337       : blocks_(0),
 338         entered_contexts_(0),
 339         saved_contexts_(0),
 340         spare_(NULL),
 341         ignore_out_of_memory_(false),
 342         call_depth_(0) { }
 343
 344   static HandleScopeImplementer* instance();
 345
 346   // Threading support for handle data.
 347   static int ArchiveSpacePerThread();
 348   static char* RestoreThread(char* from);
 349   static char* ArchiveThread(char* to);
 350   static void FreeThreadResources();
 351
 352   // Garbage collection support.
 353   static void Iterate(v8::internal::ObjectVisitor* v);
 354   static char* Iterate(v8::internal::ObjectVisitor* v, char* data);
 355
 356
 357   inline internal::Object** GetSpareOrNewBlock();
 358   inline void DeleteExtensions(internal::Object** prev_limit);
 359
 360   inline void IncrementCallDepth() {call_depth_++;}
 361   inline void DecrementCallDepth() {call_depth_--;}
 362   inline bool CallDepthIsZero() { return call_depth_ == 0; }
 363
 364   inline void EnterContext(Handle<Object> context);
 365   inline bool LeaveLastContext();
 366
 367   // Returns the last entered context or an empty handle if no
 368   // contexts have been entered.
 369   inline Handle<Object> LastEnteredContext();
 370
 371   inline void SaveContext(Context* context);
 372   inline Context* RestoreContext();
 373   inline bool HasSavedContexts();
 374
 375   inline List<internal::Object**>* blocks() { return &blocks_; }
 376   inline bool ignore_out_of_memory() { return ignore_out_of_memory_; }
 377   inline void set_ignore_out_of_memory(bool value) {
 378     ignore_out_of_memory_ = value;
 379   }
 380
 381  private:
 382   void ResetAfterArchive() {
 383     blocks_.Initialize(0);
 384     entered_contexts_.Initialize(0);
 385     saved_contexts_.Initialize(0);
 386     spare_ = NULL;
 387     ignore_out_of_memory_ = false;
 388     call_depth_ = 0;
 389   }
 390
 391   void Free() {
 392     ASSERT(blocks_.length() == 0);
 393     ASSERT(entered_contexts_.length() == 0);
 394     ASSERT(saved_contexts_.length() == 0);
 395     blocks_.Free();
 396     entered_contexts_.Free();
 397     saved_contexts_.Free();
 398     if (spare_ != NULL) {
 399       DeleteArray(spare_);
 400       spare_ = NULL;
 401     }
 402     ASSERT(call_depth_ == 0);
 403   }
 404
 405   List<internal::Object**> blocks_;
 406   // Used as a stack to keep track of entered contexts.
 407   List<Handle<Object> > entered_contexts_;
 408   // Used as a stack to keep track of saved contexts.
 409   List<Context*> saved_contexts_;
 410   Object** spare_;
 411   bool ignore_out_of_memory_;
 412   int call_depth_;
 413   // This is only used for threading support.
 414   v8::ImplementationUtilities::HandleScopeData handle_scope_data_;
 415
 416   void IterateThis(ObjectVisitor* v);
 417   char* RestoreThreadHelper(char* from);
 418   char* ArchiveThreadHelper(char* to);
 419
 420   DISALLOW_COPY_AND_ASSIGN(HandleScopeImplementer);
 421 };
 422
 423
 424 static const int kHandleBlockSize = v8::internal::KB - 2;  // fit in one page
 425
 426
 427 void HandleScopeImplementer::SaveContext(Context* context) {
 428   saved_contexts_.Add(context);
 429 }
 430
 431
 432 Context* HandleScopeImplementer::RestoreContext() {
 433   return saved_contexts_.RemoveLast();
 434 }
 435
 436
 437 bool HandleScopeImplementer::HasSavedContexts() {
 438   return !saved_contexts_.is_empty();
 439 }
 440
 441
 442 void HandleScopeImplementer::EnterContext(Handle<Object> context) {
 443   entered_contexts_.Add(context);
 444 }
 445
 446
 447 bool HandleScopeImplementer::LeaveLastContext() {
 448   if (entered_contexts_.is_empty()) return false;
 449   entered_contexts_.RemoveLast();
 450   return true;
 451 }
 452
 453
 454 Handle<Object> HandleScopeImplementer::LastEnteredContext() {
 455   if (entered_contexts_.is_empty()) return Handle<Object>::null();
 456   return entered_contexts_.last();
 457 }
 458
 459
 460 // If there's a spare block, use it for growing the current scope.
 461 internal::Object** HandleScopeImplementer::GetSpareOrNewBlock() {
 462   internal::Object** block = (spare_ != NULL) ?
 463       spare_ :
 464       NewArray<internal::Object*>(kHandleBlockSize);
 465   spare_ = NULL;
 466   return block;
 467 }
 468
 469
 470 void HandleScopeImplementer::DeleteExtensions(internal::Object** prev_limit) {
 471   while (!blocks_.is_empty()) {
 472     internal::Object** block_start = blocks_.last();
 473     internal::Object** block_limit = block_start + kHandleBlockSize;
 474 #ifdef DEBUG
 475     // NoHandleAllocation may make the prev_limit to point inside the block.
 476     if (block_start <= prev_limit && prev_limit <= block_limit) break;
 477 #else
 478     if (prev_limit == block_limit) break;
 479 #endif
 480
 481     blocks_.RemoveLast();
 482 #ifdef DEBUG
 483     v8::ImplementationUtilities::ZapHandleRange(block_start, block_limit);
 484 #endif
 485     if (spare_ != NULL) {
 486       DeleteArray(spare_);
 487     }
 488     spare_ = block_start;
 489   }
 490   ASSERT((blocks_.is_empty() && prev_limit == NULL) ||
 491          (!blocks_.is_empty() && prev_limit != NULL));
 492 }
 493
 494
 495 class Testing {
 496  public:
 497   static v8::Testing::StressType stress_type() { return stress_type_; }
 498   static void set_stress_type(v8::Testing::StressType stress_type) {
 499     stress_type_ = stress_type;
 500   }
 501
 502  private:
 503   static v8::Testing::StressType stress_type_;
 504 };
 505
 506 } }  // namespace v8::internal
 507
 508 #endif  // V8_API_H_