Add StartupData::warmUpSnapshotDataBlob(), closes #59

Author: pinepain

src/php_v8_startup_data.cc

@@ -140,6 +140,33 @@ static PHP_METHOD(StartupData, createFromSource) {
     php_v8_startup_data_create(return_value, startup_blob);
 }
 
+static PHP_METHOD(StartupData, warmUpSnapshotDataBlob) {
+    zval *php_cold_data_zv;
+    zend_string *source = NULL;
+
+    if (zend_parse_parameters(ZEND_NUM_ARGS(), "oS", &php_cold_data_zv, &source) == FAILURE) {
+        return;
+    }
+
+    PHP_V8_STARTUP_DATA_FETCH_INTO(php_cold_data_zv, php_v8_cold_data);
+
+    /* we can't try-catch here while we have no isolate yet */
+
+    const char *warmup_source = ZSTR_VAL(source);
+    php_v8_init();
+
+    v8::StartupData *warm_data = new v8::StartupData();
+
+    *warm_data = v8::V8::WarmUpSnapshotDataBlob(*php_v8_cold_data->blob->data(), warmup_source);
+
+    if (warm_data->data == NULL) {
+        PHP_V8_THROW_EXCEPTION("Failed to warm up snapshot");
+        return;
+    }
+
+    php_v8_startup_data_create(return_value, warm_data);
+}
+
 
 PHP_V8_ZEND_BEGIN_ARG_WITH_CONSTRUCTOR_INFO_EX(arginfo___construct, 1)
                 ZEND_ARG_TYPE_INFO(0, blob, IS_STRING, 0)
@@ -155,12 +182,18 @@ PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_createFromSource, ZEND_RET
                 ZEND_ARG_TYPE_INFO(0, source, IS_STRING, 0)
 ZEND_END_ARG_INFO()
 
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_warmUpSnapshotDataBlob, ZEND_RETURN_VALUE, 2, V8\\StartupData, 0)
+                ZEND_ARG_OBJ_INFO(0, cold_startup_data, V8\\StartupData, 0)
+                ZEND_ARG_TYPE_INFO(0, warmup_source, IS_STRING, 0)
+ZEND_END_ARG_INFO()
+
 
 static const zend_function_entry php_v8_startup_data_methods[] = {
-        PHP_V8_ME(StartupData, __construct,      ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
-        PHP_V8_ME(StartupData, getData,          ZEND_ACC_PUBLIC)
-        PHP_V8_ME(StartupData, getRawSize,       ZEND_ACC_PUBLIC)
-        PHP_V8_ME(StartupData, createFromSource, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
+        PHP_V8_ME(StartupData, __construct,            ZEND_ACC_PUBLIC | ZEND_ACC_CTOR)
+        PHP_V8_ME(StartupData, getData,                ZEND_ACC_PUBLIC)
+        PHP_V8_ME(StartupData, getRawSize,             ZEND_ACC_PUBLIC)
+        PHP_V8_ME(StartupData, createFromSource,       ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
+        PHP_V8_ME(StartupData, warmUpSnapshotDataBlob, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
 
         PHP_FE_END
 };

stubs/src/StartupData.php

@@ -46,4 +46,20 @@ public static function createFromSource(string $source): StartupData
 
         return new self($blob);
     }
+
+    /**
+     * Bootstrap an isolate and a context from the cold startup blob, run the
+     * warm-up script to trigger code compilation. The side effects are then
+     * discarded. The resulting startup snapshot will include compiled code.
+     *
+     * The argument startup blob is untouched.
+     *
+     * @param StartupData $cold_startup_data
+     * @param string      $warmup_source
+     *
+     * @return StartupData
+     */
+    public static function warmUpSnapshotDataBlob(StartupData $cold_startup_data, string $warmup_source): StartupData
+    {
+    }
 }

tests/001-verify_extension_entities.phpt

@@ -325,6 +325,7 @@ class V8\StartupData
     public function getData(): string
     public function getRawSize(): int
     public static function createFromSource(string $source): V8\StartupData
+    public static function warmUpSnapshotDataBlob(V8\StartupData $cold_startup_data, string $warmup_source): V8\StartupData
 
 class V8\Isolate
     const MEMORY_PRESSURE_LEVEL_NONE = 0

tests/StartupData_warmUpSnapshotDataBlob.phpt

@@ -0,0 +1,42 @@
+--TEST--
+V8\StartupData::warmUpSnapshotDataBlob
+--SKIPIF--
+<?php if (!extension_loaded("v8")) print "skip"; ?>
+--ENV--
+HOME=/tmp/we-need-home-env-var-set-to-load-valgrindrc
+--FILE--
+<?php
+require '.tracking_dtors.php';
+
+/** @var \Phpv8Testsuite $helper */
+$helper = require '.testsuite.php';
+
+require '.v8-helpers.php';
+$v8_helper = new PhpV8Helpers($helper);
+
+
+
+$source = 'function test_snapshot() { return "hello, world";}';
+$data = V8\StartupData::createFromSource($source);
+
+$isolate = new V8\Isolate($data);
+$context = new \V8\Context($isolate);
+
+$helper->assert('Context should have test function', $v8_helper->CompileTryRun($context, 'test_snapshot()')->value(), 'hello, world');
+
+$wam_source = 'test_snapshot = function () { return "hello, warm world";}';
+
+$warm_data = V8\StartupData::warmUpSnapshotDataBlob($data, $wam_source);
+
+
+$isolate = new V8\Isolate($warm_data);
+$context = new \V8\Context($isolate);
+
+
+$helper->assert('Warm data has no side effects', $res = $v8_helper->CompileTryRun($context, 'test_snapshot()')->value(), 'hello, world');
+
+
+?>
+--EXPECT--
+Context should have test function: ok
+Warm data has no side effects: ok