Add Isolate::SetRAILMode(), closes #60

Author: pinepain

src/php_v8_enums.cc

@@ -25,6 +25,7 @@ zend_class_entry* php_v8_property_handler_flags_class_entry;
 zend_class_entry *php_v8_property_filter_class_entry;
 zend_class_entry *php_v8_key_collection_mode_class_entry;
 zend_class_entry *php_v8_index_filter_class_entry;
+zend_class_entry *php_v8_rail_mode_class_entry;
 
 
 static const zend_function_entry php_v8_enum_methods[] = {
@@ -126,5 +127,17 @@ PHP_MINIT_FUNCTION (php_v8_enums) {
     zend_declare_class_constant_long(this_ce, ZEND_STRL("SKIP_INDICES"),    static_cast<zend_long>(v8::IndexFilter::kSkipIndices));
     #undef this_ce
 
+    // v8::RAILMode
+    #define this_ce php_v8_index_filter_class_entry
+    INIT_NS_CLASS_ENTRY(ce, PHP_V8_NS, "RAILMode", php_v8_enum_methods);
+    this_ce = zend_register_internal_class(&ce);
+    this_ce->ce_flags |= ZEND_ACC_FINAL;
+
+    zend_declare_class_constant_long(this_ce, ZEND_STRL("PERFORMANCE_RESPONSE"),  static_cast<zend_long>(v8::RAILMode::PERFORMANCE_RESPONSE));
+    zend_declare_class_constant_long(this_ce, ZEND_STRL("PERFORMANCE_ANIMATION"), static_cast<zend_long>(v8::RAILMode::PERFORMANCE_ANIMATION));
+    zend_declare_class_constant_long(this_ce, ZEND_STRL("PERFORMANCE_IDLE"),      static_cast<zend_long>(v8::RAILMode::PERFORMANCE_IDLE));
+    zend_declare_class_constant_long(this_ce, ZEND_STRL("PERFORMANCE_LOAD"),      static_cast<zend_long>(v8::RAILMode::PERFORMANCE_LOAD));
+    #undef this_ce
+
     return SUCCESS;
 }

src/php_v8_enums.h

@@ -31,6 +31,7 @@ extern zend_class_entry* php_v8_property_handler_flags_class_entry;
 extern zend_class_entry* php_v8_property_filter_class_entry;
 extern zend_class_entry* php_v8_key_collection_mode_class_entry;
 extern zend_class_entry* php_v8_index_filter_class_entry;
+extern zend_class_entry *php_v8_rail_mode_class_entry;
 
 
 #define PHP_V8_ACCESS_CONTROL_FLAGS ( 0 \
@@ -77,12 +78,11 @@ extern zend_class_entry* php_v8_index_filter_class_entry;
   | static_cast<long>(v8::KeyCollectionMode::kIncludePrototypes)  \
 )
 
-#define PHP_V8_INDEX_FILTER_FLAGS ( 0                      \
-  | static_cast<long>(v8::IndexFilter::kIncludeIndices)            \
-  | static_cast<long>(v8::IndexFilter::kSkipIndices)  \
+#define PHP_V8_INDEX_FILTER_FLAGS ( 0                   \
+  | static_cast<long>(v8::IndexFilter::kIncludeIndices) \
+  | static_cast<long>(v8::IndexFilter::kSkipIndices)    \
 )
 
-
 PHP_MINIT_FUNCTION (php_v8_enums);
 
 #endif //PHP_V8_ENUMS_H

src/php_v8_isolate.cc

@@ -23,6 +23,7 @@
 #include "php_v8_stack_trace.h"
 #include "php_v8_object.h"
 #include "php_v8_value.h"
+#include "php_v8_enums.h"
 #include "php_v8_a.h"
 #include "php_v8.h"
 
@@ -424,6 +425,21 @@ static PHP_METHOD(Isolate, lowMemoryNotification) {
     isolate->LowMemoryNotification();
 }
 
+static PHP_METHOD(Isolate, setRAILMode) {
+    zend_long rail_mode = -1;
+
+    if (zend_parse_parameters(ZEND_NUM_ARGS(), "l", &rail_mode) == FAILURE) {
+        return;
+    }
+
+    PHP_V8_CHECK_ISOLATE_RAIL_MODE(rail_mode, "Invalid RAIL mode given. See V8\\RAILMode class constants for available values.")
+
+    PHP_V8_ISOLATE_FETCH_WITH_CHECK(getThis(), php_v8_isolate);
+    PHP_V8_ENTER_ISOLATE(php_v8_isolate);
+
+    isolate->SetRAILMode(static_cast<v8::RAILMode>(rail_mode));
+}
+
 static PHP_METHOD(Isolate, terminateExecution) {
     if (zend_parse_parameters_none() == FAILURE) {
         return;
@@ -549,6 +565,10 @@ PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(arginfo_idleNotificationDeadline,
                 ZEND_ARG_INFO(0, deadline_in_seconds)
 ZEND_END_ARG_INFO()
 
+PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_VOID_INFO_EX(arginfo_setRAILMode, 1)
+                ZEND_ARG_TYPE_INFO(0, rail_mode, IS_LONG, 0)
+ZEND_END_ARG_INFO()
+
 PHP_V8_ZEND_BEGIN_ARG_WITH_RETURN_VOID_INFO_EX(arginfo_lowMemoryNotification, 0)
 ZEND_END_ARG_INFO()
 
@@ -588,6 +608,7 @@ static const zend_function_entry php_v8_isolate_methods[] = {
         PHP_V8_ME(Isolate, throwException,             ZEND_ACC_PUBLIC)
         PHP_V8_ME(Isolate, idleNotificationDeadline,   ZEND_ACC_PUBLIC)
         PHP_V8_ME(Isolate, lowMemoryNotification,      ZEND_ACC_PUBLIC)
+        PHP_V8_ME(Isolate, setRAILMode,                ZEND_ACC_PUBLIC)
         PHP_V8_ME(Isolate, terminateExecution,         ZEND_ACC_PUBLIC)
         PHP_V8_ME(Isolate, isExecutionTerminating,     ZEND_ACC_PUBLIC)
         PHP_V8_ME(Isolate, cancelTerminateExecution,   ZEND_ACC_PUBLIC)

src/php_v8_isolate.h

@@ -122,6 +122,13 @@ inline v8::Local<v8::Private> php_v8_isolate_get_key_local(php_v8_isolate_t *php
         return;                                                                     \
     }
 
+#define PHP_V8_CHECK_ISOLATE_RAIL_MODE(mode, message)                  \
+    if (mode < static_cast<zend_long>(v8::RAILMode::PERFORMANCE_RESPONSE)              \
+         || mode > static_cast<zend_long>(v8::RAILMode::PERFORMANCE_LOAD)) {   \
+        PHP_V8_THROW_VALUE_EXCEPTION(message);                                      \
+        return;                                                                     \
+    }
+
 
 struct _php_v8_isolate_t {
     v8::Isolate *isolate;

stubs/src/AccessControl.php

@@ -15,7 +15,7 @@
 
 namespace V8;
 
-class AccessControl
+final class AccessControl
 {
     const DEFAULT_ACCESS = 0; // do not allow cross-context access
     const ALL_CAN_READ   = 1; // all cross-context reads are allowed

stubs/src/ConstructorBehavior.php

@@ -16,7 +16,7 @@
 namespace V8;
 
 
-class ConstructorBehavior
+final class ConstructorBehavior
 {
     const THROW = 0;
     const ALLOW = 1;

stubs/src/IntegrityLevel.php

@@ -18,7 +18,7 @@
 /**
  * Integrity level for objects.
  */
-class IntegrityLevel
+final class IntegrityLevel
 {
     const FROZEN = 0;
     const SEALED = 1;

stubs/src/Isolate.php

@@ -188,6 +188,21 @@ public function lowMemoryNotification()
     {
     }
 
+    /**
+     * Optional notification to tell V8 the current performance requirements
+     * of the embedder based on RAIL.
+     * V8 uses these notifications to guide heuristics.
+     * This is an unfinished experimental feature. Semantics and implementation
+     * may change frequently.
+     *
+     * @param int $rail_mode
+     *
+     * @return void
+     */
+    public function setRAILMode(int $rail_mode)
+    {
+    }
+
     /**
      * Check if V8 is dead and therefore unusable.  This is the case after
      * fatal errors such as out-of-memory situations.

stubs/src/KeyCollectionMode.php

@@ -18,7 +18,7 @@
 /**
  * Keys/Properties filter to limits the range of collected properties
  */
-class KeyCollectionMode
+final class KeyCollectionMode
 {
     const kOwnOnly            = 0; // limits the collected properties to the given Object only. kIncludesPrototypes
     const kIncludesPrototypes = 1; // will include all keys of the objects's prototype chain as well.

stubs/src/PropertyAttribute.php

@@ -16,7 +16,7 @@
 namespace V8;
 
 
-class PropertyAttribute
+final class PropertyAttribute
 {
     const NONE        = 0;
     const READ_ONLY   = 1;

stubs/src/PropertyFilter.php

@@ -18,7 +18,7 @@
 /**
  * Property filter bits. They can be or'ed to build a composite filter.
  */
-class PropertyFilter
+final class PropertyFilter
 {
     const ALL_PROPERTIES    = 0;
     const ONLY_WRITABLE     = 1;

stubs/src/PropertyHandlerFlags.php

@@ -20,7 +20,7 @@
  * Configuration flags for V8\NamedPropertyHandlerConfiguration or
  * V8\IndexedPropertyHandlerConfiguration.
  */
-class PropertyHandlerFlags
+final class PropertyHandlerFlags
 {
     /**
      * None.

stubs/src/RAILMode.php

@@ -0,0 +1,44 @@
+<?php declare(strict_types=1);
+
+/**
+ * This file is part of the pinepain/php-v8 PHP extension.
+ *
+ * Copyright (c) 2015-2017 Bogdan Padalko <[email protected]>
+ *
+ * Licensed under the MIT license: http://opensource.org/licenses/MIT
+ *
+ * For the full copyright and license information, please view the
+ * LICENSE file that was distributed with this source or visit
+ * http://opensource.org/licenses/MIT
+ */
+
+
+namespace V8;
+
+
+/**
+ * Option flags passed to the SetRAILMode function.
+ * See documentation https://developers.google.com/web/tools/chrome-devtools/profile/evaluate-performance/rail
+ */
+final class RAILMode
+{
+    /**
+     * Response performance mode: In this mode very low virtual machine latency is provided.
+     * V8 will try to avoid JavaScript execution interruptions. Throughput may be throttled.
+     */
+    const PERFORMANCE_RESPONSE = 0;
+    /**
+     * Animation performance mode: In this mode low virtual machine latency is provided.
+     * V8 will try to avoid as many JavaScript execution interruptions
+     * as possible. Throughput may be throttled. This is the default mode.
+     */
+    const PERFORMANCE_ANIMATION = 1;
+    /**
+     * Idle performance mode: The embedder is idle. V8 can complete deferred work in this mode.
+     */
+    const PERFORMANCE_IDLE = 2;
+    /**
+     * Load performance mode: In this mode high throughput is provided. V8 may turn off latency optimizations.
+     */
+    const PERFORMANCE_LOAD = 3;
+}

tests/001-verify_extension_entities.phpt

@@ -260,6 +260,12 @@ final class V8\IndexFilter
     const INCLUDE_INDICES = 0
     const SKIP_INDICES = 1
 
+final class V8\RAILMode
+    const PERFORMANCE_RESPONSE = 0
+    const PERFORMANCE_ANIMATION = 1
+    const PERFORMANCE_IDLE = 2
+    const PERFORMANCE_LOAD = 3
+
 class V8\Exceptions\Exception
     extends Exception
     implements Throwable
@@ -345,6 +351,7 @@ class V8\Isolate
     public function throwException(V8\Context $context, V8\Value $value, Throwable $e)
     public function idleNotificationDeadline($deadline_in_seconds): bool
     public function lowMemoryNotification()
+    public function setRAILMode(int $rail_mode)
     public function terminateExecution()
     public function isExecutionTerminating(): bool
     public function cancelTerminateExecution()

tests/Isolate.phpt

@@ -25,9 +25,41 @@ $helper->line();
 $helper->method_export($isolate, 'getHeapStatistics');
 
 $isolate->lowMemoryNotification();
+
+$helper->line();
+
+try {
+    $isolate->memoryPressureNotification(-2);
+} catch (\V8\Exceptions\ValueException $e) {
+    $helper->exception_export($e);
+}
+
 $isolate->memoryPressureNotification(\V8\Isolate::MEMORY_PRESSURE_LEVEL_NONE);
 $isolate->memoryPressureNotification(\V8\Isolate::MEMORY_PRESSURE_LEVEL_MODERATE);
 $isolate->memoryPressureNotification(\V8\Isolate::MEMORY_PRESSURE_LEVEL_CRITICAL);
+try {
+    $isolate->memoryPressureNotification(42);
+} catch (\V8\Exceptions\ValueException $e) {
+    $helper->exception_export($e);
+}
+
+$helper->line();
+
+try {
+    $isolate->setRAILMode(-2);
+} catch (\V8\Exceptions\ValueException $e) {
+    $helper->exception_export($e);
+}
+$isolate->setRAILMode(\V8\RAILMode::PERFORMANCE_RESPONSE);
+$isolate->setRAILMode(\V8\RAILMode::PERFORMANCE_ANIMATION);
+$isolate->setRAILMode(\V8\RAILMode::PERFORMANCE_IDLE);
+$isolate->setRAILMode(\V8\RAILMode::PERFORMANCE_LOAD);
+try {
+    $isolate->setRAILMode(42);
+} catch (\V8\Exceptions\ValueException $e) {
+    $helper->exception_export($e);
+}
+
 
 $isolate = null;
 
@@ -47,7 +79,7 @@ V8\Isolate::MEMORY_PRESSURE_LEVEL_MODERATE = 1
 V8\Isolate::MEMORY_PRESSURE_LEVEL_CRITICAL = 2
 
 V8\Isolate->getHeapStatistics():
-    object(V8\HeapStatistics)#27 (9) {
+    object(V8\HeapStatistics)#28 (9) {
       ["total_heap_size":"V8\HeapStatistics":private]=>
       float(%f)
       ["total_heap_size_executable":"V8\HeapStatistics":private]=>
@@ -67,3 +99,9 @@ V8\Isolate->getHeapStatistics():
       ["does_zap_garbage":"V8\HeapStatistics":private]=>
       bool(false)
     }
+
+V8\Exceptions\ValueException: Invalid memory pressure level given. See V8\Isolate MEMORY_PRESSURE_LEVEL_* class constants for available levels.
+V8\Exceptions\ValueException: Invalid memory pressure level given. See V8\Isolate MEMORY_PRESSURE_LEVEL_* class constants for available levels.
+
+V8\Exceptions\ValueException: Invalid RAIL mode given. See V8\RAILMode class constants for available values.
+V8\Exceptions\ValueException: Invalid RAIL mode given. See V8\RAILMode class constants for available values.