From b405a3469004b66dcd46240a4c4f4d43bbe04173 Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 17:00:47 +0100 Subject: [PATCH 01/14] Allow to create snapshots and re-use them --- README.md | 13 ++++++++-- v8js_class.cc | 68 ++++++++++++++++++++++++++++++++++++++++++++------- v8js_class.h | 3 +++ 3 files changed, 73 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 18ce894..71d20b1 100644 --- a/README.md +++ b/README.md @@ -62,13 +62,14 @@ class V8Js /* Methods */ /** - * Initializes and starts V8 engine and Returns new V8Js object with it's own V8 context. + * Initializes and starts V8 engine and returns new V8Js object with it's own V8 context. * @param string $object_name * @param array $variables * @param array $extensions * @param bool $report_uncaught_exceptions + * @param string $snapshot_blob */ - public function __construct($object_name = "PHP", array $variables = NULL, array $extensions = NULL, $report_uncaught_exceptions = TRUE) + public function __construct($object_name = "PHP", array $variables = [], array $extensions = [], $report_uncaught_exceptions = TRUE, $snapshot_blob = NULL) {} /** @@ -174,6 +175,14 @@ class V8Js */ public static function getExtensions() {} + + /** + * Creates a custom V8 heap snapshot with the provided JavaScript source embedded. + * @param string $embed_source + * @return string|false + */ + public static function createSnapshot($embed_source) + {} } final class V8JsScriptException extends Exception diff --git a/v8js_class.cc b/v8js_class.cc index a472209..47e645d 100644 --- a/v8js_class.cc +++ b/v8js_class.cc @@ -207,6 +207,10 @@ static void v8js_free_storage(void *object TSRMLS_DC) /* {{{ */ c->modules_stack.~vector(); c->modules_base.~vector(); + if (c->snapshot_blob.data) { + efree((void*)c->snapshot_blob.data); + } + efree(object); } /* }}} */ @@ -327,12 +331,12 @@ static void v8js_fatal_error_handler(const char *location, const char *message) ((key_len == sizeof(mname)) && \ !strncasecmp(key, mname, key_len - 1)) -/* {{{ proto void V8Js::__construct([string object_name [, array variables [, array extensions [, bool report_uncaught_exceptions]]]) +/* {{{ proto void V8Js::__construct([string object_name [, array variables [, array extensions [, bool report_uncaught_exceptions [, string snapshot_blob]]]]]) __construct for V8Js */ static PHP_METHOD(V8Js, __construct) { - char *object_name = NULL, *class_name = NULL; - int object_name_len = 0, free = 0; + char *object_name = NULL, *class_name = NULL, *snapshot_blob = NULL; + int object_name_len = 0, free = 0, snapshot_blob_len = 0; zend_uint class_name_len = 0; zend_bool report_uncaught = 1; zval *vars_arr = NULL, *exts_arr = NULL; @@ -346,7 +350,7 @@ static PHP_METHOD(V8Js, __construct) return; } - if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|saab", &object_name, &object_name_len, &vars_arr, &exts_arr, &report_uncaught) == FAILURE) { + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|saabs", &object_name, &object_name_len, &vars_arr, &exts_arr, &report_uncaught, &snapshot_blob, &snapshot_blob_len) == FAILURE) { return; } @@ -360,9 +364,17 @@ static PHP_METHOD(V8Js, __construct) #if PHP_V8_API_VERSION >= 4004044 static ArrayBufferAllocator array_buffer_allocator; - static v8::Isolate::CreateParams create_params; - create_params.array_buffer_allocator = &array_buffer_allocator; - c->isolate = v8::Isolate::New(create_params); + new (&c->create_params) v8::Isolate::CreateParams(); + c->create_params.array_buffer_allocator = &array_buffer_allocator; + + new (&c->snapshot_blob) v8::StartupData(); + if (snapshot_blob && snapshot_blob_len) { + c->snapshot_blob.data = snapshot_blob; + c->snapshot_blob.raw_size = snapshot_blob_len; + c->create_params.snapshot_blob = &c->snapshot_blob; + } + + c->isolate = v8::Isolate::New(c->create_params); #else c->isolate = v8::Isolate::New(); #endif @@ -991,6 +1003,10 @@ static int v8js_register_extension(char *name, uint name_len, char *source, uint } /* }}} */ + + +/* ## Static methods ## */ + /* {{{ proto bool V8Js::registerExtension(string ext_name, string script [, array deps [, bool auto_enable]]) */ static PHP_METHOD(V8Js, registerExtension) @@ -1015,8 +1031,6 @@ static PHP_METHOD(V8Js, registerExtension) } /* }}} */ -/* ## Static methods ## */ - /* {{{ proto array V8Js::getExtensions() */ static PHP_METHOD(V8Js, getExtensions) @@ -1063,6 +1077,37 @@ static PHP_METHOD(V8Js, getExtensions) } /* }}} */ +/* {{{ proto string|bool V8Js::createSnapshot(string embed_source) + */ +static PHP_METHOD(V8Js, createSnapshot) +{ + char *script; + int script_len; + + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &script, &script_len) == FAILURE) { + return; + } + + if (!script_len) { + php_error_docref(NULL TSRMLS_CC, E_WARNING, "Script cannot be empty"); + RETURN_FALSE; + } + + /* Initialize V8, if not already done. */ + v8js_v8_init(TSRMLS_C); + + v8::StartupData snapshot_blob = v8::V8::CreateSnapshotDataBlob(script); + + if (!snapshot_blob.data) { + php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed to create V8 heap snapshot. Check $embed_source for errors."); + RETURN_FALSE; + } + + RETVAL_STRINGL(snapshot_blob.data, snapshot_blob.raw_size, 1); + delete[] snapshot_blob.data; +} +/* }}} */ + /* {{{ arginfo */ ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_construct, 0, 0, 0) ZEND_ARG_INFO(0, object_name) @@ -1126,6 +1171,10 @@ ZEND_END_ARG_INFO() ZEND_BEGIN_ARG_INFO(arginfo_v8js_getextensions, 0) ZEND_END_ARG_INFO() +ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_createsnapshot, 0, 0, 1) + ZEND_ARG_INFO(0, script) +ZEND_END_ARG_INFO() + ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_settimelimit, 0, 0, 1) ZEND_ARG_INFO(0, time_limit) ZEND_END_ARG_INFO() @@ -1149,6 +1198,7 @@ const zend_function_entry v8js_methods[] = { /* {{{ */ PHP_ME(V8Js, setModuleLoader, arginfo_v8js_setmoduleloader, ZEND_ACC_PUBLIC) PHP_ME(V8Js, registerExtension, arginfo_v8js_registerextension, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) PHP_ME(V8Js, getExtensions, arginfo_v8js_getextensions, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) + PHP_ME(V8Js, createSnapshot, arginfo_v8js_createsnapshot, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) PHP_ME(V8Js, setTimeLimit, arginfo_v8js_settimelimit, ZEND_ACC_PUBLIC) PHP_ME(V8Js, setMemoryLimit, arginfo_v8js_setmemorylimit, ZEND_ACC_PUBLIC) {NULL, NULL, NULL} diff --git a/v8js_class.h b/v8js_class.h index ab7b7aa..1c29b70 100644 --- a/v8js_class.h +++ b/v8js_class.h @@ -67,6 +67,9 @@ struct v8js_ctx { std::vector accessor_list; std::vector script_objects; char *tz; + + v8::Isolate::CreateParams create_params; + v8::StartupData snapshot_blob; #ifdef ZTS void ***zts_ctx; #endif From 39062b4248d2d11d2b24fa53f2b058e35d3fbe9e Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 17:48:44 +0100 Subject: [PATCH 02/14] Test for snapshot support in V8 Looks like we have to test for internal functions unfortunately since the public V8 snapshot API is available no matter whether the library really supports it or not. --- config.m4 | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ v8js_v8.cc | 7 +++++++ 2 files changed, 55 insertions(+) diff --git a/config.m4 b/config.m4 index 1e3c488..a192f5d 100644 --- a/config.m4 +++ b/config.m4 @@ -130,6 +130,54 @@ int main () AC_MSG_ERROR([could not determine libv8 version]) fi + AC_MSG_CHECKING([for v8::internal::ReadNatives]) + AC_TRY_LINK([ + namespace v8 { + namespace internal { + void ReadNatives(); + } + }], [v8::internal::ReadNatives();], [ + AC_MSG_RESULT([found (using snapshots)]) + AC_DEFINE([PHP_V8_USE_EXTERNAL_STARTUP_DATA], [1], [Whether V8 requires (and can be provided with custom versions of) external startup data]) + + SEARCH_PATH="$V8_DIR/lib" + + AC_MSG_CHECKING([for natives_blob.bin]) + SEARCH_FOR="natives_blob.bin" + + for i in $SEARCH_PATH ; do + if test -r $i/$SEARCH_FOR; then + AC_MSG_RESULT([found ($i/$SEARCH_FOR)]) + AC_DEFINE_UNQUOTED([PHP_V8_NATIVES_BLOB_PATH], "$i/$SEARCH_FOR", [Full path to natives_blob.bin file]) + native_blob_found=1 + fi + done + + if test -z "$native_blob_found"; then + AC_MSG_RESULT([not found]) + AC_MSG_ERROR([Please provide V8 native blob as needed]) + fi + + AC_MSG_CHECKING([for snapshot_blob.bin]) + SEARCH_FOR="snapshot_blob.bin" + + for i in $SEARCH_PATH ; do + if test -r $i/$SEARCH_FOR; then + AC_MSG_RESULT([found ($i/$SEARCH_FOR)]) + AC_DEFINE_UNQUOTED([PHP_V8_SNAPSHOT_BLOB_PATH], "$i/$SEARCH_FOR", [Full path to snapshot_blob.bin file]) + snapshot_blob_found=1 + fi + done + + if test -z "$snapshot_blob_found"; then + AC_MSG_RESULT([not found]) + AC_MSG_ERROR([Please provide V8 snapshot blob as needed]) + fi + + ], [ + AC_MSG_RESULT([not found (snapshots disabled)]) + ]) + AC_LANG_RESTORE LIBS=$old_LIBS LDFLAGS=$old_LDFLAGS diff --git a/v8js_v8.cc b/v8js_v8.cc index 8b52063..0b1b4b3 100644 --- a/v8js_v8.cc +++ b/v8js_v8.cc @@ -54,6 +54,13 @@ void v8js_v8_init(TSRMLS_D) /* {{{ */ } #endif +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA + v8::V8::InitializeExternalStartupData( + PHP_V8_NATIVES_BLOB_PATH, + PHP_V8_SNAPSHOT_BLOB_PATH + ); +#endif + #if !defined(_WIN32) && PHP_V8_API_VERSION >= 3029036 v8js_process_globals.v8_platform = v8::platform::CreateDefaultPlatform(); v8::V8::InitializePlatform(v8js_process_globals.v8_platform); From 2c8ef2aa661fa8002ea4c825f180718b1d2804c5 Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 17:54:00 +0100 Subject: [PATCH 03/14] conditionally compile in snapshot functionality --- v8js_class.cc | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/v8js_class.cc b/v8js_class.cc index 47e645d..64f8c4a 100644 --- a/v8js_class.cc +++ b/v8js_class.cc @@ -207,9 +207,11 @@ static void v8js_free_storage(void *object TSRMLS_DC) /* {{{ */ c->modules_stack.~vector(); c->modules_base.~vector(); +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA if (c->snapshot_blob.data) { efree((void*)c->snapshot_blob.data); } +#endif efree(object); } @@ -368,14 +370,16 @@ static PHP_METHOD(V8Js, __construct) c->create_params.array_buffer_allocator = &array_buffer_allocator; new (&c->snapshot_blob) v8::StartupData(); +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA if (snapshot_blob && snapshot_blob_len) { c->snapshot_blob.data = snapshot_blob; c->snapshot_blob.raw_size = snapshot_blob_len; c->create_params.snapshot_blob = &c->snapshot_blob; } +#endif /* PHP_V8_USE_EXTERNAL_STARTUP_DATA */ c->isolate = v8::Isolate::New(c->create_params); -#else +#else /* PHP_V8_API_VERSION < 4004044 */ c->isolate = v8::Isolate::New(); #endif @@ -1077,6 +1081,7 @@ static PHP_METHOD(V8Js, getExtensions) } /* }}} */ +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA /* {{{ proto string|bool V8Js::createSnapshot(string embed_source) */ static PHP_METHOD(V8Js, createSnapshot) @@ -1107,6 +1112,8 @@ static PHP_METHOD(V8Js, createSnapshot) delete[] snapshot_blob.data; } /* }}} */ +#endif /* PHP_V8_USE_EXTERNAL_STARTUP_DATA */ + /* {{{ arginfo */ ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_construct, 0, 0, 0) @@ -1171,9 +1178,11 @@ ZEND_END_ARG_INFO() ZEND_BEGIN_ARG_INFO(arginfo_v8js_getextensions, 0) ZEND_END_ARG_INFO() +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_createsnapshot, 0, 0, 1) ZEND_ARG_INFO(0, script) ZEND_END_ARG_INFO() +#endif ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_settimelimit, 0, 0, 1) ZEND_ARG_INFO(0, time_limit) @@ -1196,11 +1205,13 @@ const zend_function_entry v8js_methods[] = { /* {{{ */ PHP_ME(V8Js, clearPendingException, arginfo_v8js_clearpendingexception, ZEND_ACC_PUBLIC) PHP_ME(V8Js, setModuleNormaliser, arginfo_v8js_setmodulenormaliser, ZEND_ACC_PUBLIC) PHP_ME(V8Js, setModuleLoader, arginfo_v8js_setmoduleloader, ZEND_ACC_PUBLIC) - PHP_ME(V8Js, registerExtension, arginfo_v8js_registerextension, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) - PHP_ME(V8Js, getExtensions, arginfo_v8js_getextensions, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) - PHP_ME(V8Js, createSnapshot, arginfo_v8js_createsnapshot, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) PHP_ME(V8Js, setTimeLimit, arginfo_v8js_settimelimit, ZEND_ACC_PUBLIC) PHP_ME(V8Js, setMemoryLimit, arginfo_v8js_setmemorylimit, ZEND_ACC_PUBLIC) + PHP_ME(V8Js, registerExtension, arginfo_v8js_registerextension, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) + PHP_ME(V8Js, getExtensions, arginfo_v8js_getextensions, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA + PHP_ME(V8Js, createSnapshot, arginfo_v8js_createsnapshot, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) +#endif {NULL, NULL, NULL} }; /* }}} */ From 52ebdc28ed84d46d7d2d892b831a8d16b58cc991 Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 19:52:46 +0100 Subject: [PATCH 04/14] Simply v8::Isolate::New to test if snapshot blob needed The test on internal symbols seems too fragile, e.g. with V8 version 4.5.90 it is false positive. --- config.m4 | 146 ++++++++++++++++++++++++++++++++++-------------------- 1 file changed, 92 insertions(+), 54 deletions(-) diff --git a/config.m4 b/config.m4 index a192f5d..b35090a 100644 --- a/config.m4 +++ b/config.m4 @@ -130,59 +130,6 @@ int main () AC_MSG_ERROR([could not determine libv8 version]) fi - AC_MSG_CHECKING([for v8::internal::ReadNatives]) - AC_TRY_LINK([ - namespace v8 { - namespace internal { - void ReadNatives(); - } - }], [v8::internal::ReadNatives();], [ - AC_MSG_RESULT([found (using snapshots)]) - AC_DEFINE([PHP_V8_USE_EXTERNAL_STARTUP_DATA], [1], [Whether V8 requires (and can be provided with custom versions of) external startup data]) - - SEARCH_PATH="$V8_DIR/lib" - - AC_MSG_CHECKING([for natives_blob.bin]) - SEARCH_FOR="natives_blob.bin" - - for i in $SEARCH_PATH ; do - if test -r $i/$SEARCH_FOR; then - AC_MSG_RESULT([found ($i/$SEARCH_FOR)]) - AC_DEFINE_UNQUOTED([PHP_V8_NATIVES_BLOB_PATH], "$i/$SEARCH_FOR", [Full path to natives_blob.bin file]) - native_blob_found=1 - fi - done - - if test -z "$native_blob_found"; then - AC_MSG_RESULT([not found]) - AC_MSG_ERROR([Please provide V8 native blob as needed]) - fi - - AC_MSG_CHECKING([for snapshot_blob.bin]) - SEARCH_FOR="snapshot_blob.bin" - - for i in $SEARCH_PATH ; do - if test -r $i/$SEARCH_FOR; then - AC_MSG_RESULT([found ($i/$SEARCH_FOR)]) - AC_DEFINE_UNQUOTED([PHP_V8_SNAPSHOT_BLOB_PATH], "$i/$SEARCH_FOR", [Full path to snapshot_blob.bin file]) - snapshot_blob_found=1 - fi - done - - if test -z "$snapshot_blob_found"; then - AC_MSG_RESULT([not found]) - AC_MSG_ERROR([Please provide V8 snapshot blob as needed]) - fi - - ], [ - AC_MSG_RESULT([not found (snapshots disabled)]) - ]) - - AC_LANG_RESTORE - LIBS=$old_LIBS - LDFLAGS=$old_LDFLAGS - CPPFLAGS=$old_CPPFLAGS - if test "$V8_API_VERSION" -ge 3029036 ; then dnl building for v8 3.29.36 or later, which requires us to dnl initialize and provide a platform; hence we need to @@ -217,10 +164,101 @@ int main () AC_MSG_ERROR([Please provide $static_link_extra_file next to the libv8.so, see README.md for details]) fi - LDFLAGS="$LDFLAGS $static_link_dir/$static_link_extra_file" + LDFLAGS_libplatform="$static_link_dir/$static_link_extra_file" done + + # modify flags for (possibly) succeeding V8 startup check + CPPFLAGS="$CPPFLAGS -I$V8_DIR" + LIBS="$LIBS $LDFLAGS_libplatform" fi + if test "$V8_API_VERSION" -ge 4004010 ; then + dnl building for v8 4.4.10 or later, which requires us to + dnl provide startup data, if V8 wasn't compiled with snapshot=off. + AC_MSG_CHECKING([whether V8 requires startup data]) + AC_TRY_RUN([ + #include + #include + #include + #include + +#if PHP_V8_API_VERSION >= 4004010 +class ArrayBufferAllocator : public v8::ArrayBuffer::Allocator { +public: + virtual void* Allocate(size_t length) { + void* data = AllocateUninitialized(length); + return data == NULL ? data : memset(data, 0, length); + } + virtual void* AllocateUninitialized(size_t length) { return malloc(length); } + virtual void Free(void* data, size_t) { free(data); } +}; +#endif + + int main () + { + v8::Platform *v8_platform = v8::platform::CreateDefaultPlatform(); + v8::V8::InitializePlatform(v8_platform); + v8::V8::Initialize(); + +#if PHP_V8_API_VERSION >= 4004044 + static ArrayBufferAllocator array_buffer_allocator; + v8::Isolate::CreateParams create_params; + create_params.array_buffer_allocator = &array_buffer_allocator; + + v8::Isolate::New(create_params); +#else /* PHP_V8_API_VERSION < 4004044 */ + v8::Isolate::New(); +#endif + return 0; + } + ], [ + AC_MSG_RESULT([no]) + ], [ + AC_MSG_RESULT([yes]) + AC_DEFINE([PHP_V8_USE_EXTERNAL_STARTUP_DATA], [1], [Whether V8 requires (and can be provided with custom versions of) external startup data]) + + SEARCH_PATH="$V8_DIR/lib" + + AC_MSG_CHECKING([for natives_blob.bin]) + SEARCH_FOR="natives_blob.bin" + + for i in $SEARCH_PATH ; do + if test -r $i/$SEARCH_FOR; then + AC_MSG_RESULT([found ($i/$SEARCH_FOR)]) + AC_DEFINE_UNQUOTED([PHP_V8_NATIVES_BLOB_PATH], "$i/$SEARCH_FOR", [Full path to natives_blob.bin file]) + native_blob_found=1 + fi + done + + if test -z "$native_blob_found"; then + AC_MSG_RESULT([not found]) + AC_MSG_ERROR([Please provide V8 native blob as needed]) + fi + + AC_MSG_CHECKING([for snapshot_blob.bin]) + SEARCH_FOR="snapshot_blob.bin" + + for i in $SEARCH_PATH ; do + if test -r $i/$SEARCH_FOR; then + AC_MSG_RESULT([found ($i/$SEARCH_FOR)]) + AC_DEFINE_UNQUOTED([PHP_V8_SNAPSHOT_BLOB_PATH], "$i/$SEARCH_FOR", [Full path to snapshot_blob.bin file]) + snapshot_blob_found=1 + fi + done + + if test -z "$snapshot_blob_found"; then + AC_MSG_RESULT([not found]) + AC_MSG_ERROR([Please provide V8 snapshot blob as needed]) + fi + ]) + fi + + AC_LANG_RESTORE + LIBS=$old_LIBS + LDFLAGS="$old_LDFLAGS $LDFLAGS_libplatform" + CPPFLAGS=$old_CPPFLAGS + + PHP_NEW_EXTENSION(v8js, [ \ v8js_array_access.cc \ v8js.cc \ From 40f0f5e89f110d8550b76638a67576b88db21387 Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 20:17:20 +0100 Subject: [PATCH 05/14] Provide startup data loader for V8 < 4.6.76 --- v8js_v8.cc | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/v8js_v8.cc b/v8js_v8.cc index 0b1b4b3..8091429 100644 --- a/v8js_v8.cc +++ b/v8js_v8.cc @@ -2,7 +2,7 @@ +----------------------------------------------------------------------+ | PHP Version 5 | +----------------------------------------------------------------------+ - | Copyright (c) 1997-2015 The PHP Group | + | Copyright (c) 1997-2016 The PHP Group | +----------------------------------------------------------------------+ | http://www.opensource.org/licenses/mit-license.php MIT License | +----------------------------------------------------------------------+ @@ -34,6 +34,43 @@ extern "C" { #include "v8js_timer.h" #include "v8js_exceptions.h" +#if defined(PHP_V8_USE_EXTERNAL_STARTUP_DATA) && PHP_V8_API_VERSION < 4006076 +/* Old V8 version, requires startup data but has no + * (internal/API) means to let it be loaded. */ +static v8::StartupData natives_; +static v8::StartupData snapshot_; + +static void v8js_v8_load_startup_data(const char* blob_file, + v8::StartupData* startup_data, + void (*setter_fn)(v8::StartupData*)) { + startup_data->data = NULL; + startup_data->raw_size = 0; + + if (!blob_file) { + return; + } + + FILE* file = fopen(blob_file, "rb"); + if (!file) { + return; + } + + fseek(file, 0, SEEK_END); + startup_data->raw_size = static_cast(ftell(file)); + rewind(file); + + startup_data->data = new char[startup_data->raw_size]; + int read_size = static_cast(fread(const_cast(startup_data->data), + 1, startup_data->raw_size, file)); + fclose(file); + + if (startup_data->raw_size == read_size) { + (*setter_fn)(startup_data); + } +} +#endif + + void v8js_v8_init(TSRMLS_D) /* {{{ */ { /* Run only once; thread-local test first */ @@ -55,10 +92,16 @@ void v8js_v8_init(TSRMLS_D) /* {{{ */ #endif #ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA + /* V8 doesn't work without startup data, load it. */ +#if PHP_V8_API_VERSION >= 4006076 v8::V8::InitializeExternalStartupData( PHP_V8_NATIVES_BLOB_PATH, PHP_V8_SNAPSHOT_BLOB_PATH ); +#else + v8js_v8_load_startup_data(PHP_V8_NATIVES_BLOB_PATH, &natives_, v8::V8::SetNativesDataBlob); + v8js_v8_load_startup_data(PHP_V8_SNAPSHOT_BLOB_PATH, &snapshot_, v8::V8::SetSnapshotDataBlob); +#endif #endif #if !defined(_WIN32) && PHP_V8_API_VERSION >= 3029036 From 93d3f9591f8803254c766bda402c9b2602f6313b Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 20:17:56 +0100 Subject: [PATCH 06/14] Add CreateParams fields in v8js_ctx only if needed --- v8js_class.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/v8js_class.h b/v8js_class.h index 1c29b70..35db5e9 100644 --- a/v8js_class.h +++ b/v8js_class.h @@ -2,12 +2,13 @@ +----------------------------------------------------------------------+ | PHP Version 5 | +----------------------------------------------------------------------+ - | Copyright (c) 1997-2013 The PHP Group | + | Copyright (c) 1997-2016 The PHP Group | +----------------------------------------------------------------------+ | http://www.opensource.org/licenses/mit-license.php MIT License | +----------------------------------------------------------------------+ | Author: Jani Taskinen | | Author: Patrick Reilly | + | Author: Stefan Siegl | +----------------------------------------------------------------------+ */ @@ -68,8 +69,13 @@ struct v8js_ctx { std::vector script_objects; char *tz; +#if PHP_V8_API_VERSION >= 4004044 v8::Isolate::CreateParams create_params; +#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA v8::StartupData snapshot_blob; +#endif +#endif + #ifdef ZTS void ***zts_ctx; #endif From a1cdd7537b49c771289f88872aaa49ad8b8f4d8c Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sun, 28 Feb 2016 20:29:53 +0100 Subject: [PATCH 07/14] Fix conditional compilation for snapshot=off --- v8js_class.cc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/v8js_class.cc b/v8js_class.cc index 64f8c4a..c72d456 100644 --- a/v8js_class.cc +++ b/v8js_class.cc @@ -207,7 +207,7 @@ static void v8js_free_storage(void *object TSRMLS_DC) /* {{{ */ c->modules_stack.~vector(); c->modules_base.~vector(); -#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA +#if defined(PHP_V8_USE_EXTERNAL_STARTUP_DATA) && PHP_V8_API_VERSION >= 4004044 if (c->snapshot_blob.data) { efree((void*)c->snapshot_blob.data); } @@ -369,8 +369,8 @@ static PHP_METHOD(V8Js, __construct) new (&c->create_params) v8::Isolate::CreateParams(); c->create_params.array_buffer_allocator = &array_buffer_allocator; - new (&c->snapshot_blob) v8::StartupData(); #ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA + new (&c->snapshot_blob) v8::StartupData(); if (snapshot_blob && snapshot_blob_len) { c->snapshot_blob.data = snapshot_blob; c->snapshot_blob.raw_size = snapshot_blob_len; From 4df6e80be9707f073187480eca27822116b20c7e Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 14:12:19 +0100 Subject: [PATCH 08/14] Add testcase on V8Js::createSnapshot --- tests/create_snapshot_basic.phpt | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 tests/create_snapshot_basic.phpt diff --git a/tests/create_snapshot_basic.phpt b/tests/create_snapshot_basic.phpt new file mode 100644 index 0000000..731426d --- /dev/null +++ b/tests/create_snapshot_basic.phpt @@ -0,0 +1,32 @@ +--TEST-- +Test V8Js::createSnapshot() : Basic snapshot creation & re-use +--SKIPIF-- + +--FILE-- + 0) { + var_dump("snapshot successfully created"); +} + +$v8 = new V8Js('PHP', array(), array(), true, $snap); +$v8->executeString('var_dump(doublify(23));'); +?> +===EOF=== +--EXPECT-- +string(29) "snapshot successfully created" +int(46) +===EOF=== From d0e78019aaca8134c5f98557c826c254edd5386a Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 14:22:48 +0100 Subject: [PATCH 09/14] Allow snapshot creation & use with V8 > 4.3.7 This does *not* seem to depend on whether V8 itself was compiled with support for snapshots or not. Therefore use PHP_V8_USE_EXTERNAL_STARTUP_DATA only to mark whether we need to provide external snapshot data to V8. --- v8js_class.cc | 20 +++++++++++--------- v8js_class.h | 4 +--- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/v8js_class.cc b/v8js_class.cc index c72d456..810d414 100644 --- a/v8js_class.cc +++ b/v8js_class.cc @@ -207,7 +207,7 @@ static void v8js_free_storage(void *object TSRMLS_DC) /* {{{ */ c->modules_stack.~vector(); c->modules_base.~vector(); -#if defined(PHP_V8_USE_EXTERNAL_STARTUP_DATA) && PHP_V8_API_VERSION >= 4004044 +#if PHP_V8_API_VERSION >= 4003007 if (c->snapshot_blob.data) { efree((void*)c->snapshot_blob.data); } @@ -364,22 +364,23 @@ static PHP_METHOD(V8Js, __construct) c->pending_exception = NULL; c->in_execution = 0; +#if PHP_V8_API_VERSION >= 4003007 + new (&c->create_params) v8::Isolate::CreateParams(); + #if PHP_V8_API_VERSION >= 4004044 static ArrayBufferAllocator array_buffer_allocator; - new (&c->create_params) v8::Isolate::CreateParams(); c->create_params.array_buffer_allocator = &array_buffer_allocator; +#endif -#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA new (&c->snapshot_blob) v8::StartupData(); if (snapshot_blob && snapshot_blob_len) { c->snapshot_blob.data = snapshot_blob; c->snapshot_blob.raw_size = snapshot_blob_len; c->create_params.snapshot_blob = &c->snapshot_blob; } -#endif /* PHP_V8_USE_EXTERNAL_STARTUP_DATA */ c->isolate = v8::Isolate::New(c->create_params); -#else /* PHP_V8_API_VERSION < 4004044 */ +#else /* PHP_V8_API_VERSION < 4003007 */ c->isolate = v8::Isolate::New(); #endif @@ -1081,7 +1082,7 @@ static PHP_METHOD(V8Js, getExtensions) } /* }}} */ -#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA +#if PHP_V8_API_VERSION >= 4003007 /* {{{ proto string|bool V8Js::createSnapshot(string embed_source) */ static PHP_METHOD(V8Js, createSnapshot) @@ -1112,7 +1113,7 @@ static PHP_METHOD(V8Js, createSnapshot) delete[] snapshot_blob.data; } /* }}} */ -#endif /* PHP_V8_USE_EXTERNAL_STARTUP_DATA */ +#endif /* PHP_V8_API_VERSION >= 4003007 */ /* {{{ arginfo */ @@ -1178,7 +1179,7 @@ ZEND_END_ARG_INFO() ZEND_BEGIN_ARG_INFO(arginfo_v8js_getextensions, 0) ZEND_END_ARG_INFO() -#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA +#if PHP_V8_API_VERSION >= 4003007 ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_createsnapshot, 0, 0, 1) ZEND_ARG_INFO(0, script) ZEND_END_ARG_INFO() @@ -1209,7 +1210,8 @@ const zend_function_entry v8js_methods[] = { /* {{{ */ PHP_ME(V8Js, setMemoryLimit, arginfo_v8js_setmemorylimit, ZEND_ACC_PUBLIC) PHP_ME(V8Js, registerExtension, arginfo_v8js_registerextension, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) PHP_ME(V8Js, getExtensions, arginfo_v8js_getextensions, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) -#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA + +#if PHP_V8_API_VERSION >= 4003007 PHP_ME(V8Js, createSnapshot, arginfo_v8js_createsnapshot, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) #endif {NULL, NULL, NULL} diff --git a/v8js_class.h b/v8js_class.h index 35db5e9..d0fd967 100644 --- a/v8js_class.h +++ b/v8js_class.h @@ -69,12 +69,10 @@ struct v8js_ctx { std::vector script_objects; char *tz; -#if PHP_V8_API_VERSION >= 4004044 +#if PHP_V8_API_VERSION >= 4003007 v8::Isolate::CreateParams create_params; -#ifdef PHP_V8_USE_EXTERNAL_STARTUP_DATA v8::StartupData snapshot_blob; #endif -#endif #ifdef ZTS void ***zts_ctx; From 8e3e0c91b5b447360d07367656984827e79b0010 Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 14:24:08 +0100 Subject: [PATCH 10/14] Add ZEND_ARG_INFO for V8Js::__construct 5th arg: snapshot_blob --- v8js_class.cc | 1 + 1 file changed, 1 insertion(+) diff --git a/v8js_class.cc b/v8js_class.cc index 810d414..39f830e 100644 --- a/v8js_class.cc +++ b/v8js_class.cc @@ -1122,6 +1122,7 @@ ZEND_BEGIN_ARG_INFO_EX(arginfo_v8js_construct, 0, 0, 0) ZEND_ARG_INFO(0, variables) ZEND_ARG_INFO(0, extensions) ZEND_ARG_INFO(0, report_uncaught_exceptions) + ZEND_ARG_INFO(0, snapshot_blob) ZEND_END_ARG_INFO() ZEND_BEGIN_ARG_INFO(arginfo_v8js_sleep, 0) From 606eb5a60fa08c21d3504d5d321f8ce83ce118cb Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 14:27:46 +0100 Subject: [PATCH 11/14] Mention limitted snapshot availibility in README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 71d20b1..c4a54b6 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,7 @@ class V8Js /** * Initializes and starts V8 engine and returns new V8Js object with it's own V8 context. + * Snapshots are supported by V8 4.3.7 and higher. * @param string $object_name * @param array $variables * @param array $extensions @@ -178,6 +179,8 @@ class V8Js /** * Creates a custom V8 heap snapshot with the provided JavaScript source embedded. + * Snapshots are supported by V8 4.3.7 and higher. For older versions of V8 this + * extension doesn't provide this method. * @param string $embed_source * @return string|false */ From 930b450d992be5061d5e4466393b87993930d69a Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 16:54:06 +0100 Subject: [PATCH 12/14] refcount on snapshot_blob zval --- v8js_class.cc | 26 +++++++++++++++++--------- v8js_class.h | 1 + 2 files changed, 18 insertions(+), 9 deletions(-) diff --git a/v8js_class.cc b/v8js_class.cc index 39f830e..f10725f 100644 --- a/v8js_class.cc +++ b/v8js_class.cc @@ -208,8 +208,8 @@ static void v8js_free_storage(void *object TSRMLS_DC) /* {{{ */ c->modules_base.~vector(); #if PHP_V8_API_VERSION >= 4003007 - if (c->snapshot_blob.data) { - efree((void*)c->snapshot_blob.data); + if (c->zval_snapshot_blob) { + zval_ptr_dtor(&c->zval_snapshot_blob); } #endif @@ -337,13 +337,14 @@ static void v8js_fatal_error_handler(const char *location, const char *message) __construct for V8Js */ static PHP_METHOD(V8Js, __construct) { - char *object_name = NULL, *class_name = NULL, *snapshot_blob = NULL; - int object_name_len = 0, free = 0, snapshot_blob_len = 0; + char *object_name = NULL, *class_name = NULL; + int object_name_len = 0, free = 0; zend_uint class_name_len = 0; zend_bool report_uncaught = 1; zval *vars_arr = NULL, *exts_arr = NULL; const char **exts = NULL; int exts_count = 0; + zval *snapshot_blob = NULL; v8js_ctx *c = (v8js_ctx *) zend_object_store_get_object(getThis() TSRMLS_CC); @@ -352,7 +353,7 @@ static PHP_METHOD(V8Js, __construct) return; } - if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|saabs", &object_name, &object_name_len, &vars_arr, &exts_arr, &report_uncaught, &snapshot_blob, &snapshot_blob_len) == FAILURE) { + if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|saabz", &object_name, &object_name_len, &vars_arr, &exts_arr, &report_uncaught, &snapshot_blob) == FAILURE){ return; } @@ -373,10 +374,17 @@ static PHP_METHOD(V8Js, __construct) #endif new (&c->snapshot_blob) v8::StartupData(); - if (snapshot_blob && snapshot_blob_len) { - c->snapshot_blob.data = snapshot_blob; - c->snapshot_blob.raw_size = snapshot_blob_len; - c->create_params.snapshot_blob = &c->snapshot_blob; + if (snapshot_blob) { + if (Z_TYPE_P(snapshot_blob) == IS_STRING) { + c->zval_snapshot_blob = snapshot_blob; + Z_ADDREF_P(c->zval_snapshot_blob); + + c->snapshot_blob.data = Z_STRVAL_P(snapshot_blob); + c->snapshot_blob.raw_size = Z_STRLEN_P(snapshot_blob); + c->create_params.snapshot_blob = &c->snapshot_blob; + } else { + php_error_docref(NULL TSRMLS_CC, E_WARNING, "Argument snapshot_blob expected to be of string type"); + } } c->isolate = v8::Isolate::New(c->create_params); diff --git a/v8js_class.h b/v8js_class.h index d0fd967..0e91243 100644 --- a/v8js_class.h +++ b/v8js_class.h @@ -71,6 +71,7 @@ struct v8js_ctx { #if PHP_V8_API_VERSION >= 4003007 v8::Isolate::CreateParams create_params; + zval *zval_snapshot_blob; v8::StartupData snapshot_blob; #endif From de0b8e2aa809ff92bff4685bc479cf4b8721d774 Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 16:58:55 +0100 Subject: [PATCH 13/14] Check V8_DIR/share/v8 for snapshot images as well --- config.m4 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config.m4 b/config.m4 index b35090a..f721165 100644 --- a/config.m4 +++ b/config.m4 @@ -217,7 +217,7 @@ public: AC_MSG_RESULT([yes]) AC_DEFINE([PHP_V8_USE_EXTERNAL_STARTUP_DATA], [1], [Whether V8 requires (and can be provided with custom versions of) external startup data]) - SEARCH_PATH="$V8_DIR/lib" + SEARCH_PATH="$V8_DIR/lib $V8_DIR/share/v8" AC_MSG_CHECKING([for natives_blob.bin]) SEARCH_FOR="natives_blob.bin" From f49d3b79cab57e5d87c6e332863cb4cb872bb5ac Mon Sep 17 00:00:00 2001 From: Stefan Siegl Date: Sat, 5 Mar 2016 17:09:34 +0100 Subject: [PATCH 14/14] Update README.Linux.md for snapshot usage --- README.Linux.md | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/README.Linux.md b/README.Linux.md index e85c261..9f9afc9 100644 --- a/README.Linux.md +++ b/README.Linux.md @@ -10,7 +10,23 @@ years ago, since Node.js requires such an old version. This means that you usually need to compile v8 on your own before you can start to compile & install v8js itself. -Compile latest v8 +Snapshots +--------- + +V8 has (optional) support for so-called snapshots which speed up startup +performance drastically. Hence they are generally recommended for use. + +There are two flavours of snapshots: internal & external. + +Internal snapshots are built right into the V8 library (libv8.so file), +so there's no need to handle them specially. + +Besides there are external snapshots (which are enabled unless configured +otherwise). If V8 is compiled with these, then V8Js needs to provide two +"binary blobs" to V8, named `natives_blob.bin` and `snapshot_blob.bin`. +In that case copy those two files to `/usr/share/v8/...`. + +Compile latest V8 ----------------- ``` @@ -25,11 +41,15 @@ fetch v8 cd v8 # (optional) If you'd like to build a certain version: -git checkout 3.32.6 +git checkout 4.9.385.28 gclient sync -# Build (disable snapshots for V8 > 4.4.9.1) -make native library=shared snapshot=off -j8 +# use libicu of operating system +export GYP_DEFINES="use_system_icu=1" + +# Build (with internal snapshots) +export GYPFLAGS="-Dv8_use_external_startup_data=0" +make native library=shared snapshot=on -j8 # Install to /usr sudo mkdir -p /usr/lib /usr/include @@ -40,16 +60,9 @@ echo -e "create /usr/lib/libv8_libplatform.a\naddlib out/native/obj.target/tools Then add `extension=v8js.so` to your php.ini file. If you have a separate configuration for CLI, add it there also. -* If the V8 library is newer than 4.4.9.1 you need to pass `snapshot=off` to - `make`, otherwise the V8 library will not be usable - (see V8 [Issue 4192](https://code.google.com/p/v8/issues/detail?id=4192)) * If you don't want to overwrite the system copy of v8, replace `/usr` in the above commands with some other path like `/opt/v8` and then add `--with-v8js=/opt/v8` to the php-v8js `./configure` command below. -* If you do that with a v8 library of 4.2 branch or newer, then you need - to fix the RUNPATH header in the v8js.so library so the libicui18n.so - is found. By default it is set to `$ORIGIN/lib.target/`, however the files - lie side by side. Use `chrpath -r '$ORIGIN' libv8.so` to fix. `libv8_libplatform.a` should not be copied directly since it's a thin archive, i.e. it contains only pointers to the build objects, which @@ -62,7 +75,7 @@ Compile php-v8js itself ``` cd /tmp -git clone https://github.com/preillyme/v8js.git +git clone https://github.com/phpv8/v8js.git cd v8js phpize ./configure