// Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the // "Software"), to deal in the Software without restriction, including // without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit // persons to whom the Software is furnished to do so, subject to the // following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. #ifndef SRC_ENV_H_ #define SRC_ENV_H_ #include "ares.h" #include "tree.h" #include "util.h" #include "uv.h" #include "v8.h" #include "queue.h" #include // Caveat emptor: we're going slightly crazy with macros here but the end // hopefully justifies the means. We have a lot of per-context properties // and adding and maintaining their getters and setters by hand would be // a nightmare so let's make the preprocessor generate them for us. // // Make sure that any macros defined here are undefined again at the bottom // of context-inl.h. The exceptions are NODE_CONTEXT_EMBEDDER_DATA_INDEX // and NODE_ISOLATE_SLOT, they may have been defined externally. namespace node { // Pick an index that's hopefully out of the way when we're embedded inside // another application. Performance-wise or memory-wise it doesn't matter: // Context::SetAlignedPointerInEmbedderData() is backed by a FixedArray, // worst case we pay a one-time penalty for resizing the array. #ifndef NODE_CONTEXT_EMBEDDER_DATA_INDEX #define NODE_CONTEXT_EMBEDDER_DATA_INDEX 32 #endif // The slot 0 and 1 had already been taken by "gin" and "blink" in Chrome, // and the size of isolate's slots is 4 by default, so using 3 should // hopefully make node work independently when embedded into other // application. #ifndef NODE_ISOLATE_SLOT #define NODE_ISOLATE_SLOT 3 #endif // Strings are per-isolate primitives but Environment proxies them // for the sake of convenience. #define PER_ISOLATE_STRING_PROPERTIES(V) \ V(address_string, "address") \ V(args_string, "args") \ V(argv_string, "argv") \ V(async_queue_string, "_asyncQueue") \ V(async, "async") \ V(atime_string, "atime") \ V(birthtime_string, "birthtime") \ V(blksize_string, "blksize") \ V(blocks_string, "blocks") \ V(buffer_string, "buffer") \ V(bytes_string, "bytes") \ V(bytes_parsed_string, "bytesParsed") \ V(byte_length_string, "byteLength") \ V(callback_string, "callback") \ V(change_string, "change") \ V(close_string, "close") \ V(code_string, "code") \ V(compare_string, "compare") \ V(ctime_string, "ctime") \ V(cwd_string, "cwd") \ V(debug_port_string, "debugPort") \ V(debug_string, "debug") \ V(detached_string, "detached") \ V(dev_string, "dev") \ V(disposed_string, "_disposed") \ V(domain_string, "domain") \ V(exchange_string, "exchange") \ V(idle_string, "idle") \ V(irq_string, "irq") \ V(enter_string, "enter") \ V(env_pairs_string, "envPairs") \ V(env_string, "env") \ V(errno_string, "errno") \ V(error_string, "error") \ V(events_string, "_events") \ V(exec_argv_string, "execArgv") \ V(exec_path_string, "execPath") \ V(exiting_string, "_exiting") \ V(exit_code_string, "exitCode") \ V(exit_string, "exit") \ V(expire_string, "expire") \ V(exponent_string, "exponent") \ V(exports_string, "exports") \ V(ext_key_usage_string, "ext_key_usage") \ V(family_string, "family") \ V(fatal_exception_string, "_fatalException") \ V(fd_string, "fd") \ V(file_string, "file") \ V(fingerprint_string, "fingerprint") \ V(flags_string, "flags") \ V(fsevent_string, "FSEvent") \ V(gid_string, "gid") \ V(handle_string, "handle") \ V(headers_string, "headers") \ V(heap_size_limit_string, "heap_size_limit") \ V(heap_total_string, "heapTotal") \ V(heap_used_string, "heapUsed") \ V(hostmaster_string, "hostmaster") \ V(ignore_string, "ignore") \ V(immediate_callback_string, "_immediateCallback") \ V(infoaccess_string, "infoAccess") \ V(inherit_string, "inherit") \ V(ino_string, "ino") \ V(input_string, "input") \ V(internal_string, "internal") \ V(ipv4_string, "IPv4") \ V(ipv6_lc_string, "ipv6") \ V(ipv6_string, "IPv6") \ V(issuer_string, "issuer") \ V(issuercert_string, "issuerCertificate") \ V(kill_signal_string, "killSignal") \ V(mac_string, "mac") \ V(mark_sweep_compact_string, "mark-sweep-compact") \ V(max_buffer_string, "maxBuffer") \ V(message_string, "message") \ V(method_string, "method") \ V(minttl_string, "minttl") \ V(mode_string, "mode") \ V(model_string, "model") \ V(modulus_string, "modulus") \ V(mtime_string, "mtime") \ V(name_string, "name") \ V(need_imm_cb_string, "_needImmediateCallback") \ V(netmask_string, "netmask") \ V(nice_string, "nice") \ V(nlink_string, "nlink") \ V(nsname_string, "nsname") \ V(ocsp_request_string, "OCSPRequest") \ V(offset_string, "offset") \ V(onchange_string, "onchange") \ V(onclienthello_string, "onclienthello") \ V(oncomplete_string, "oncomplete") \ V(onconnection_string, "onconnection") \ V(ondone_string, "ondone") \ V(onerror_string, "onerror") \ V(onexit_string, "onexit") \ V(onhandshakedone_string, "onhandshakedone") \ V(onhandshakestart_string, "onhandshakestart") \ V(onmessage_string, "onmessage") \ V(onnewsession_string, "onnewsession") \ V(onnewsessiondone_string, "onnewsessiondone") \ V(onocspresponse_string, "onocspresponse") \ V(onread_string, "onread") \ V(onselect_string, "onselect") \ V(onsignal_string, "onsignal") \ V(onstop_string, "onstop") \ V(output_string, "output") \ V(order_string, "order") \ V(owner_string, "owner") \ V(parse_error_string, "Parse Error") \ V(path_string, "path") \ V(pbkdf2_error_string, "PBKDF2 Error") \ V(pid_string, "pid") \ V(pipe_string, "pipe") \ V(port_string, "port") \ V(preference_string, "preference") \ V(priority_string, "priority") \ V(processed_string, "processed") \ V(prototype_string, "prototype") \ V(raw_string, "raw") \ V(rdev_string, "rdev") \ V(readable_string, "readable") \ V(received_shutdown_string, "receivedShutdown") \ V(refresh_string, "refresh") \ V(regexp_string, "regexp") \ V(rename_string, "rename") \ V(replacement_string, "replacement") \ V(retry_string, "retry") \ V(rss_string, "rss") \ V(serial_string, "serial") \ V(scavenge_string, "scavenge") \ V(scopeid_string, "scopeid") \ V(sent_shutdown_string, "sentShutdown") \ V(serial_number_string, "serialNumber") \ V(service_string, "service") \ V(servername_string, "servername") \ V(session_id_string, "sessionId") \ V(should_keep_alive_string, "shouldKeepAlive") \ V(signal_string, "signal") \ V(size_string, "size") \ V(smalloc_p_string, "_smalloc_p") \ V(sni_context_err_string, "Invalid SNI context") \ V(sni_context_string, "sni_context") \ V(speed_string, "speed") \ V(stack_string, "stack") \ V(status_code_string, "statusCode") \ V(status_message_string, "statusMessage") \ V(status_string, "status") \ V(stdio_string, "stdio") \ V(subject_string, "subject") \ V(subjectaltname_string, "subjectaltname") \ V(sys_string, "sys") \ V(syscall_string, "syscall") \ V(tick_callback_string, "_tickCallback") \ V(tick_domain_cb_string, "_tickDomainCallback") \ V(timeout_string, "timeout") \ V(times_string, "times") \ V(timestamp_string, "timestamp") \ V(title_string, "title") \ V(tls_npn_string, "tls_npn") \ V(tls_ocsp_string, "tls_ocsp") \ V(tls_sni_string, "tls_sni") \ V(tls_string, "tls") \ V(tls_ticket_string, "tlsTicket") \ V(total_heap_size_executable_string, "total_heap_size_executable") \ V(total_heap_size_string, "total_heap_size") \ V(total_physical_size_string, "total_physical_size") \ V(type_string, "type") \ V(uid_string, "uid") \ V(unknown_string, "") \ V(upgrade_string, "upgrade") \ V(url_string, "url") \ V(used_heap_size_string, "used_heap_size") \ V(user_string, "user") \ V(uv_string, "uv") \ V(valid_from_string, "valid_from") \ V(valid_to_string, "valid_to") \ V(verify_error_string, "verifyError") \ V(version_major_string, "versionMajor") \ V(version_minor_string, "versionMinor") \ V(version_string, "version") \ V(weight_string, "weight") \ V(windows_verbatim_arguments_string, "windowsVerbatimArguments") \ V(wrap_string, "wrap") \ V(writable_string, "writable") \ V(write_queue_size_string, "writeQueueSize") \ V(x_forwarded_string, "x-forwarded-for") \ V(zero_return_string, "ZERO_RETURN") \ #define ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) \ V(async_listener_run_function, v8::Function) \ V(async_listener_load_function, v8::Function) \ V(async_listener_unload_function, v8::Function) \ V(binding_cache_object, v8::Object) \ V(buffer_constructor_function, v8::Function) \ V(context, v8::Context) \ V(domain_array, v8::Array) \ V(fs_stats_constructor_function, v8::Function) \ V(gc_info_callback_function, v8::Function) \ V(module_load_list_array, v8::Array) \ V(pipe_constructor_template, v8::FunctionTemplate) \ V(process_object, v8::Object) \ V(script_context_constructor_template, v8::FunctionTemplate) \ V(script_data_constructor_function, v8::Function) \ V(secure_context_constructor_template, v8::FunctionTemplate) \ V(tcp_constructor_template, v8::FunctionTemplate) \ V(tick_callback_function, v8::Function) \ V(tls_wrap_constructor_function, v8::Function) \ V(tty_constructor_template, v8::FunctionTemplate) \ V(udp_constructor_function, v8::Function) \ class Environment; // TODO(bnoordhuis) Rename struct, the ares_ prefix implies it's part // of the c-ares API while the _t suffix implies it's a typedef. struct ares_task_t { Environment* env; ares_socket_t sock; uv_poll_t poll_watcher; RB_ENTRY(ares_task_t) node; }; RB_HEAD(ares_task_list, ares_task_t); class Environment { public: class AsyncListener { public: inline uint32_t* fields(); inline int fields_count() const; inline bool has_listener() const; inline uint32_t watched_providers() const; private: friend class Environment; // So we can call the constructor. inline AsyncListener(); enum Fields { kHasListener, kWatchedProviders, kFieldsCount }; uint32_t fields_[kFieldsCount]; DISALLOW_COPY_AND_ASSIGN(AsyncListener); }; class DomainFlag { public: inline uint32_t* fields(); inline int fields_count() const; inline uint32_t count() const; private: friend class Environment; // So we can call the constructor. inline DomainFlag(); enum Fields { kCount, kFieldsCount }; uint32_t fields_[kFieldsCount]; DISALLOW_COPY_AND_ASSIGN(DomainFlag); }; class TickInfo { public: inline uint32_t* fields(); inline int fields_count() const; inline bool in_tick() const; inline bool last_threw() const; inline uint32_t index() const; inline uint32_t length() const; inline void set_in_tick(bool value); inline void set_index(uint32_t value); inline void set_last_threw(bool value); private: friend class Environment; // So we can call the constructor. inline TickInfo(); enum Fields { kIndex, kLength, kFieldsCount }; uint32_t fields_[kFieldsCount]; bool in_tick_; bool last_threw_; DISALLOW_COPY_AND_ASSIGN(TickInfo); }; static inline Environment* GetCurrent(v8::Isolate* isolate); static inline Environment* GetCurrent(v8::Local context); // See CreateEnvironment() in src/node.cc. static inline Environment* New(v8::Local context); inline void Dispose(); // Defined in src/node_profiler.cc. void StartGarbageCollectionTracking(v8::Local callback); void StopGarbageCollectionTracking(); void AssignToContext(v8::Local context); inline v8::Isolate* isolate() const; inline uv_loop_t* event_loop() const; inline bool has_async_listener() const; inline bool in_domain() const; inline uint32_t watched_providers() const; static inline Environment* from_immediate_check_handle(uv_check_t* handle); inline uv_check_t* immediate_check_handle(); inline uv_idle_t* immediate_idle_handle(); static inline Environment* from_idle_prepare_handle(uv_prepare_t* handle); inline uv_prepare_t* idle_prepare_handle(); static inline Environment* from_idle_check_handle(uv_check_t* handle); inline uv_check_t* idle_check_handle(); inline AsyncListener* async_listener(); inline DomainFlag* domain_flag(); inline TickInfo* tick_info(); static inline Environment* from_cares_timer_handle(uv_timer_t* handle); inline uv_timer_t* cares_timer_handle(); inline ares_channel cares_channel(); inline ares_channel* cares_channel_ptr(); inline ares_task_list* cares_task_list(); inline bool using_smalloc_alloc_cb() const; inline void set_using_smalloc_alloc_cb(bool value); inline bool using_domains() const; inline void set_using_domains(bool value); inline bool printed_error() const; inline void set_printed_error(bool value); inline void ThrowError(const char* errmsg); inline void ThrowTypeError(const char* errmsg); inline void ThrowRangeError(const char* errmsg); inline void ThrowErrnoException(int errorno, const char* syscall = NULL, const char* message = NULL, const char* path = NULL); inline void ThrowUVException(int errorno, const char* syscall = NULL, const char* message = NULL, const char* path = NULL); // Convenience methods for contextify inline static void ThrowError(v8::Isolate* isolate, const char* errmsg); inline static void ThrowTypeError(v8::Isolate* isolate, const char* errmsg); inline static void ThrowRangeError(v8::Isolate* isolate, const char* errmsg); // Strings are shared across shared contexts. The getters simply proxy to // the per-isolate primitive. #define V(PropertyName, StringValue) \ inline v8::Local PropertyName() const; PER_ISOLATE_STRING_PROPERTIES(V) #undef V #define V(PropertyName, TypeName) \ inline v8::Local PropertyName() const; \ inline void set_ ## PropertyName(v8::Local value); ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) #undef V private: static const int kIsolateSlot = NODE_ISOLATE_SLOT; class GCInfo; class IsolateData; inline explicit Environment(v8::Local context); inline ~Environment(); inline IsolateData* isolate_data() const; void AfterGarbageCollectionCallback(const GCInfo* before, const GCInfo* after); enum ContextEmbedderDataIndex { kContextEmbedderDataIndex = NODE_CONTEXT_EMBEDDER_DATA_INDEX }; v8::Isolate* const isolate_; IsolateData* const isolate_data_; uv_check_t immediate_check_handle_; uv_idle_t immediate_idle_handle_; uv_prepare_t idle_prepare_handle_; uv_check_t idle_check_handle_; AsyncListener async_listener_count_; DomainFlag domain_flag_; TickInfo tick_info_; uv_timer_t cares_timer_handle_; ares_channel cares_channel_; ares_task_list cares_task_list_; bool using_smalloc_alloc_cb_; bool using_domains_; QUEUE gc_tracker_queue_; bool printed_error_; #define V(PropertyName, TypeName) \ v8::Persistent PropertyName ## _; ENVIRONMENT_STRONG_PERSISTENT_PROPERTIES(V) #undef V class GCInfo { public: inline GCInfo(); inline GCInfo(v8::Isolate* isolate, v8::GCType type, v8::GCCallbackFlags flags, uint64_t timestamp); inline v8::GCType type() const; inline v8::GCCallbackFlags flags() const; // TODO(bnoordhuis) Const-ify once https://codereview.chromium.org/63693005 // lands and makes it way into a stable release. inline v8::HeapStatistics* stats() const; inline uint64_t timestamp() const; private: v8::GCType type_; v8::GCCallbackFlags flags_; v8::HeapStatistics stats_; uint64_t timestamp_; }; // Per-thread, reference-counted singleton. class IsolateData { public: static inline IsolateData* GetOrCreate(v8::Isolate* isolate); inline void Put(); inline uv_loop_t* event_loop() const; // Defined in src/node_profiler.cc. void StartGarbageCollectionTracking(Environment* env); void StopGarbageCollectionTracking(Environment* env); #define V(PropertyName, StringValue) \ inline v8::Local PropertyName() const; PER_ISOLATE_STRING_PROPERTIES(V) #undef V private: inline static IsolateData* Get(v8::Isolate* isolate); inline explicit IsolateData(v8::Isolate* isolate); inline v8::Isolate* isolate() const; // Defined in src/node_profiler.cc. static void BeforeGarbageCollection(v8::Isolate* isolate, v8::GCType type, v8::GCCallbackFlags flags); static void AfterGarbageCollection(v8::Isolate* isolate, v8::GCType type, v8::GCCallbackFlags flags); void BeforeGarbageCollection(v8::GCType type, v8::GCCallbackFlags flags); void AfterGarbageCollection(v8::GCType type, v8::GCCallbackFlags flags); uv_loop_t* const event_loop_; v8::Isolate* const isolate_; #define V(PropertyName, StringValue) \ v8::Eternal PropertyName ## _; PER_ISOLATE_STRING_PROPERTIES(V) #undef V unsigned int ref_count_; QUEUE gc_tracker_queue_; GCInfo gc_info_before_; GCInfo gc_info_after_; DISALLOW_COPY_AND_ASSIGN(IsolateData); }; DISALLOW_COPY_AND_ASSIGN(Environment); }; } // namespace node #endif // SRC_ENV_H_