Implement support to produce code cache after execute, closes #85

Author: pinepain

src/php_v8_script_compiler.cc

@@ -268,6 +268,39 @@ static PHP_METHOD(ScriptCompiler, compileFunctionInContext)
     php_v8_get_or_create_value(return_value, local_function, php_v8_context->php_v8_isolate);
 }
 
+static PHP_METHOD(ScriptCompiler, createCodeCache)
+{
+    zval rv;
+
+    zval *php_v8_unbound_script_zv;
+    zval *php_v8_source_string_zv;
+
+    if (zend_parse_parameters(ZEND_NUM_ARGS(), "oo", &php_v8_unbound_script_zv, &php_v8_source_string_zv) == FAILURE) {
+        return;
+    }
+
+    php_v8_init();
+
+    PHP_V8_FETCH_UNBOUND_SCRIPT_WITH_CHECK(php_v8_unbound_script_zv, php_v8_unbound_script);
+    PHP_V8_VALUE_FETCH_WITH_CHECK(php_v8_source_string_zv, php_v8_source_string);
+
+    PHP_V8_DATA_ISOLATES_CHECK(php_v8_unbound_script, php_v8_source_string);
+
+    PHP_V8_ENTER_STORED_ISOLATE(php_v8_unbound_script);
+
+    v8::Local<v8::UnboundScript> local_unbound_script = php_v8_unbound_script_get_local(php_v8_unbound_script);
+    v8::Local<v8::String> local_source_string = php_v8_value_get_local_as<v8::String>(php_v8_source_string);
+
+    v8::ScriptCompiler::CachedData* cached_data = v8::ScriptCompiler::CreateCodeCache(local_unbound_script, local_source_string);
+
+    if (!cached_data) {
+        PHP_V8_THROW_VALUE_EXCEPTION("Failed to create code cache");
+        return;
+    }
+
+    php_v8_create_cached_data(return_value, cached_data);
+}
+
 
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_getCachedDataVersionTag, ZEND_RETURN_VALUE, 0, IS_DOUBLE, 0)
 ZEND_END_ARG_INFO()
@@ -291,12 +324,18 @@ PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_compileFunctionInContext,
                 ZEND_ARG_TYPE_INFO(0, context_extensions, IS_ARRAY, 0)
 ZEND_END_ARG_INFO()
 
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(arginfo_createCodeCache, ZEND_RETURN_VALUE, 2, V8\\ScriptCompiler\\CachedData, 0)
+                ZEND_ARG_OBJ_INFO(0, unbound_script, V8\\UnboundScript, 0)
+                ZEND_ARG_OBJ_INFO(0, source_string, V8\\StringValue, 0)
+ZEND_END_ARG_INFO()
+
 
 static const zend_function_entry php_v8_script_compiler_methods[] = {
     PHP_V8_ME(ScriptCompiler, getCachedDataVersionTag,  ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
     PHP_V8_ME(ScriptCompiler, compileUnboundScript,     ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
     PHP_V8_ME(ScriptCompiler, compile,                  ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
     PHP_V8_ME(ScriptCompiler, compileFunctionInContext, ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
+    PHP_V8_ME(ScriptCompiler, createCodeCache,          ZEND_ACC_PUBLIC | ZEND_ACC_STATIC)
 
     PHP_FE_END
 };

stubs/src/ScriptCompiler.php

@@ -16,6 +16,7 @@
 namespace V8;
 
 
+use V8\ScriptCompiler\CachedData;
 use V8\ScriptCompiler\Source;
 
 
@@ -64,13 +65,8 @@ public static function getCachedDataVersionTag(): float
      * Cached data as part of the source object can be optionally produced to be
      * consumed later to speed up compilation of identical source scripts.
      *
-     * Note that when producing cached data, the source must point to NULL for
-     * cached data. When consuming cached data, the cached data must have been
-     * produced by the same version of V8.
-     *
-     * \param source Script source code.
-     * \return Compiled script object (context independent; for running it must be
-     *   bound to a context).
+     * Note that when producing cached data, the source must have no cached data set.
+     * When consuming cached data, the cached data must have been produced by the same version of V8.
      *
      * @param Context $context
      * @param Source  $source
@@ -85,14 +81,6 @@ public static function compileUnboundScript(Context $context, Source $source, in
     /**
      * Compiles the specified script (bound to current context).
      *
-     * \param source Script source code.
-     * \param pre_data Pre-parsing data, as obtained by ScriptData::PreCompile()
-     *   using pre_data speeds compilation if it's done multiple times.
-     *   Owned by caller, no references are kept when this function returns.
-     * \return Compiled script object, bound to the context that was active
-     *   when this function was called. When run it will always use this
-     *   context.
-     *
      * @param Context $context
      * @param Source  $source
      * @param int     $options
@@ -110,8 +98,7 @@ public static function compile(Context $context, Source $source, int $options =
      *   return function(args) { ... }
      * }
      *
-     * It is possible to specify multiple context extensions (obj in the above
-     * example).
+     * It is possible to specify multiple context extensions (obj in the above example).
      *
      * @param Context       $context
      * @param Source        $source
@@ -123,4 +110,16 @@ public static function compile(Context $context, Source $source, int $options =
     public static function compileFunctionInContext(Context $context, Source $source, array $arguments = [], array $context_extensions = []): FunctionObject
     {
     }
+
+    /**
+     * Creates and returns code cache for the specified unbound_script.
+     *
+     * @param UnboundScript $unbound_script
+     * @param StringValue   $source_string
+     *
+     * @return CachedData
+     */
+    public static function createCodeCache(UnboundScript $unbound_script, StringValue $source_string): CachedData
+    {
+    }
 }

stubs/src/UnboundScript.php

@@ -8,10 +8,22 @@
  */
 class UnboundScript
 {
+    /**
+     * @var Isolate
+     */
+    private $isolate;
+
     private function __construct()
     {
     }
 
+    /**
+     * @return Isolate
+     */
+    public function getIsolate(): Isolate
+    {
+    }
+
     /**
      * Binds the script to the currently entered context.
      *

tests/001-verify_extension_entities.phpt

@@ -415,6 +415,7 @@ class V8\ScriptCompiler
     public static function compileUnboundScript(V8\Context $context, V8\ScriptCompiler\Source $source, int $options): V8\UnboundScript
     public static function compile(V8\Context $context, V8\ScriptCompiler\Source $source, int $options): V8\Script
     public static function compileFunctionInContext(V8\Context $context, V8\ScriptCompiler\Source $source, array $arguments, array $context_extensions): V8\FunctionObject
+    public static function createCodeCache(V8\UnboundScript $unbound_script, V8\StringValue $source_string): V8\ScriptCompiler\CachedData
 
 class V8\ExceptionManager
     public static function createRangeError(V8\Context $context, V8\StringValue $message): V8\ObjectValue

tests/ScriptCompiler_createCodeCache.phpt

@@ -0,0 +1,100 @@
+--TEST--
+V8\ScriptCompiler::createCodeCache()
+--SKIPIF--
+<?php if (!extension_loaded("v8")) print "skip"; ?>
+--FILE--
+<?php
+
+/** @var \Phpv8Testsuite $helper */
+$helper = require '.testsuite.php';
+
+require '.v8-helpers.php';
+$v8_helper = new PhpV8Helpers($helper);
+
+
+$isolate = new V8\Isolate();
+$context = new V8\Context($isolate);
+
+
+$source_string = new V8\StringValue($isolate, "function f() { return 'abc'; }; f() + 'def'");
+$source        = new \V8\ScriptCompiler\Source($source_string);
+$unbound       = V8\ScriptCompiler::compileUnboundScript($context, $source);
+
+$source_string_other = new V8\StringValue($isolate, "other; bad-'");
+
+
+$cache_data = V8\ScriptCompiler::createCodeCache($unbound, $source_string);
+
+$helper->header('Testing with the source string is the same as used for original');
+
+$helper->assert("Cache data created", null !== $cache_data);
+$helper->assert("Cache data is not empty", strlen($cache_data->getData()) > 1);
+$helper->assert("Cache data is not rejected", !$cache_data->isRejected());
+$helper->line();
+
+{
+    $helper->header('Test consuming code cache');
+
+    $source = new \V8\ScriptCompiler\Source($source_string, null, $cache_data);
+    $helper->assert('Source cache data is set', $source->getCachedData() != null);
+    $test_unbound = V8\ScriptCompiler::compileUnboundScript($context, $source, V8\ScriptCompiler::OPTION_CONSUME_CODE_CACHE);
+    $helper->assert('Source cache data is still set', $source->getCachedData() != null);
+    $helper->assert('Source cache data is not rejected', $source->getCachedData()->isRejected() === false);
+
+    $helper->pretty_dump('Script result', $test_unbound->bindToContext($context)->run($context)->toString($context)->value());
+}
+
+
+$helper->space();
+
+$helper->header('Testing with the source string different from original');
+
+$cache_data = V8\ScriptCompiler::createCodeCache($unbound, $source_string_other);
+
+$helper->assert("Cache data created", null !== $cache_data);
+$helper->assert("Cache data is not empty", strlen($cache_data->getData()) > 1);
+$helper->assert("Cache data is not rejected", !$cache_data->isRejected());
+$helper->line();
+
+{
+    $helper->header('Test consuming code cache');
+
+    $source = new \V8\ScriptCompiler\Source($source_string, null, $cache_data);
+    $helper->assert('Source cache data is set', $source->getCachedData() != null);
+    $test_unbound = V8\ScriptCompiler::compileUnboundScript($context, $source, V8\ScriptCompiler::OPTION_CONSUME_CODE_CACHE);
+    $helper->assert('Source cache data is still set', $source->getCachedData() != null);
+    $helper->assert('Source cache data is not rejected', $source->getCachedData()->isRejected() === false);
+
+    $helper->pretty_dump('Script result', $test_unbound->bindToContext($context)->run($context)->toString($context)->value());
+}
+
+
+
+?>
+--EXPECT--
+Testing with the source string is the same as used for original:
+----------------------------------------------------------------
+Cache data created: ok
+Cache data is not empty: ok
+Cache data is not rejected: ok
+
+Test consuming code cache:
+--------------------------
+Source cache data is set: ok
+Source cache data is still set: ok
+Source cache data is not rejected: ok
+Script result: string(6) "abcdef"
+
+
+Testing with the source string different from original:
+-------------------------------------------------------
+Cache data created: ok
+Cache data is not empty: ok
+Cache data is not rejected: ok
+
+Test consuming code cache:
+--------------------------
+Source cache data is set: ok
+Source cache data is still set: ok
+Source cache data is not rejected: ok
+Script result: string(6) "abcdef"