[jit] Introduce Opcache\Jit attribute to replace @jit

Instead of @jit in the docblock you can now use the <<Opcache\Jit>>
attribute. In addition this attribute allows you to disable the JIT
for a specific function as well with <<Opcache\Jit(false)>>.

Another behavior change is that the Opcache\Jit attribute has precedence
over any other trigger as well. This means you can allow to force JIT
in profiling triggers or disable JIT for a function regardless of trigger.

Author: beberlei

ext/opcache/jit/zend_jit.c

@@ -23,6 +23,7 @@
 #include "Zend/zend_exceptions.h"
 #include "Zend/zend_constants.h"
 #include "zend_smart_str.h"
+#include "Zend/zend_attributes.h"
 #include "jit/zend_jit.h"
 
 #ifdef HAVE_JIT
@@ -3233,21 +3234,38 @@ static int zend_jit_setup_hot_counters(zend_op_array *op_array)
 	return SUCCESS;
 }
 
+static int zend_disable_jit(const zend_op_array *op_array)
+{
+	zend_attribute *jit = zend_get_attribute_str(op_array->attributes, "opcache\\jit", sizeof("opcache\\jit")-1, 0);
+
+	if (jit == NULL || jit->argc == 0) {
+		return 0;
+	}
+
+	if (Z_TYPE(jit->argv[0]) == IS_FALSE) {
+		return 1;
+	}
+
+	return 0;
+}
+
 static int zend_needs_manual_jit(const zend_op_array *op_array)
 {
-	if (op_array->doc_comment) {
-		const char *s = ZSTR_VAL(op_array->doc_comment);
-		const char *p = strstr(s, "@jit");
+	zend_attribute *jit = zend_get_attribute_str(op_array->attributes, "opcache\\jit", sizeof("opcache\\jit")-1, 0);
 
-		if (p) {
-			size_t l = ZSTR_LEN(op_array->doc_comment);
+	if (jit == NULL) {
+		return 0;
+	}
 
-			if ((p == s + 3 || *(p-1) <= ' ') &&
-			    (p + 6 == s + l || *(p+4) <= ' ')) {
-				return 1;
-			}
+	if (jit->argc == 0) {
+		return 1;
+	} else if (jit->argc == 1) {
+		// todo: evaluate "trueish"?
+		if (Z_TYPE(jit->argv[0]) == IS_TRUE) {
+			return 1;
 		}
 	}
+
 	return 0;
 }
 
@@ -3259,6 +3277,14 @@ ZEND_EXT_API int zend_jit_op_array(zend_op_array *op_array, zend_script *script)
 		return FAILURE;
 	}
 
+	if (zend_disable_jit(op_array) == 1) {
+		return SUCCESS;
+	}
+
+	if (zend_needs_manual_jit(op_array) == 1) {
+		return zend_real_jit_func(op_array, script, NULL);
+	}
+
 	if (zend_jit_trigger == ZEND_JIT_ON_FIRST_EXEC) {
 		zend_op *opline = op_array->opcodes;
 
@@ -3294,12 +3320,6 @@ ZEND_EXT_API int zend_jit_op_array(zend_op_array *op_array, zend_script *script)
 		return zend_jit_setup_hot_trace_counters(op_array);
 	} else if (zend_jit_trigger == ZEND_JIT_ON_SCRIPT_LOAD) {
 		return zend_real_jit_func(op_array, script, NULL);
-	} else if (zend_jit_trigger == ZEND_JIT_ON_DOC_COMMENT) {
-		if (zend_needs_manual_jit(op_array)) {
-			return zend_real_jit_func(op_array, script, NULL);
-		} else {
-			return SUCCESS;
-		}
 	} else {
 		ZEND_ASSERT(0);
 	}
@@ -3335,10 +3355,9 @@ ZEND_EXT_API int zend_jit_script(zend_script *script)
 				goto jit_failure;
 			}
 		}
-	} else if (zend_jit_trigger == ZEND_JIT_ON_SCRIPT_LOAD ||
-	           zend_jit_trigger == ZEND_JIT_ON_DOC_COMMENT) {
+	} else if (zend_jit_trigger == ZEND_JIT_ON_SCRIPT_LOAD || zend_jit_trigger == ZEND_JIT_ON_ATTRIBUTE) {
 
-		if (zend_jit_trigger == ZEND_JIT_ON_DOC_COMMENT) {
+		if (zend_jit_trigger == ZEND_JIT_ON_ATTRIBUTE) {
 			int do_jit = 0;
 			for (i = 0; i < call_graph.op_arrays_count; i++) {
 				if (zend_needs_manual_jit(call_graph.op_arrays[i])) {
@@ -3350,6 +3369,7 @@ ZEND_EXT_API int zend_jit_script(zend_script *script)
 				goto jit_failure;
 			}
 		}
+
 		for (i = 0; i < call_graph.op_arrays_count; i++) {
 			info = ZEND_FUNC_INFO(call_graph.op_arrays[i]);
 			if (info) {
@@ -3371,10 +3391,12 @@ ZEND_EXT_API int zend_jit_script(zend_script *script)
 		}
 
 		for (i = 0; i < call_graph.op_arrays_count; i++) {
-			if (zend_jit_trigger == ZEND_JIT_ON_DOC_COMMENT &&
-			    !zend_needs_manual_jit(call_graph.op_arrays[i])) {
+			if (zend_jit_trigger == ZEND_JIT_ON_SCRIPT_LOAD && zend_disable_jit(call_graph.op_arrays[i])) {
+				continue;
+			} else if (zend_jit_trigger == ZEND_JIT_ON_ATTRIBUTE && !zend_needs_manual_jit(call_graph.op_arrays[i])) {
 				continue;
 			}
+
 			info = ZEND_FUNC_INFO(call_graph.op_arrays[i]);
 			if (info) {
 				if (zend_jit_op_array_analyze2(call_graph.op_arrays[i], script, &info->ssa) != SUCCESS) {
@@ -3386,10 +3408,12 @@ ZEND_EXT_API int zend_jit_script(zend_script *script)
 
 		if (ZCG(accel_directives).jit_debug & ZEND_JIT_DEBUG_SSA) {
 			for (i = 0; i < call_graph.op_arrays_count; i++) {
-				if (zend_jit_trigger == ZEND_JIT_ON_DOC_COMMENT &&
-				    !zend_needs_manual_jit(call_graph.op_arrays[i])) {
+				if (zend_jit_trigger == ZEND_JIT_ON_SCRIPT_LOAD && zend_disable_jit(call_graph.op_arrays[i])) {
+					continue;
+				} else if (zend_jit_trigger == ZEND_JIT_ON_ATTRIBUTE && !zend_needs_manual_jit(call_graph.op_arrays[i])) {
 					continue;
 				}
+
 				info = ZEND_FUNC_INFO(call_graph.op_arrays[i]);
 				if (info) {
 					zend_dump_op_array(call_graph.op_arrays[i], ZEND_DUMP_HIDE_UNREACHABLE|ZEND_DUMP_RC_INFERENCE|ZEND_DUMP_SSA, "JIT", &info->ssa);
@@ -3398,10 +3422,12 @@ ZEND_EXT_API int zend_jit_script(zend_script *script)
 		}
 
 		for (i = 0; i < call_graph.op_arrays_count; i++) {
-			if (zend_jit_trigger == ZEND_JIT_ON_DOC_COMMENT &&
-			    !zend_needs_manual_jit(call_graph.op_arrays[i])) {
+			if (zend_jit_trigger == ZEND_JIT_ON_SCRIPT_LOAD && zend_disable_jit(call_graph.op_arrays[i])) {
+				continue;
+			} else if (zend_jit_trigger == ZEND_JIT_ON_ATTRIBUTE && !zend_needs_manual_jit(call_graph.op_arrays[i])) {
 				continue;
 			}
+
 			info = ZEND_FUNC_INFO(call_graph.op_arrays[i]);
 			if (info) {
 				if (zend_jit(call_graph.op_arrays[i], &info->ssa, NULL) != SUCCESS) {
@@ -3577,7 +3603,6 @@ static void zend_jit_globals_ctor(zend_jit_globals *jit_globals)
 ZEND_EXT_API int zend_jit_startup(zend_long jit, void *buf, size_t size, zend_bool reattached)
 {
 	int ret;
-
 #ifdef ZTS
 	zend_jit_globals_id = ts_allocate_id(&zend_jit_globals_id, sizeof(zend_jit_globals), (ts_allocate_ctor) zend_jit_globals_ctor, NULL);
 #else

ext/opcache/jit/zend_jit.h

@@ -32,7 +32,7 @@
 #define ZEND_JIT_ON_FIRST_EXEC     1
 #define ZEND_JIT_ON_PROF_REQUEST   2     /* compile the most frequently caled on first request functions */
 #define ZEND_JIT_ON_HOT_COUNTERS   3     /* compile functions after N calls or loop iterations */
-#define ZEND_JIT_ON_DOC_COMMENT    4     /* compile functions with "@jit" tag in doc-comments */
+#define ZEND_JIT_ON_ATTRIBUTE      4     /* compile functions with "Opcache\Jit" attribute */
 #define ZEND_JIT_ON_HOT_TRACE      5     /* trace functions after N calls or loop iterations */
 
 #define ZEND_JIT_TRIGGER(n)        (((n) / 10) % 10)
@@ -129,4 +129,6 @@ struct _zend_lifetime_interval {
 	zend_lifetime_interval *list_next;
 };
 
+zend_class_entry *zend_ce_opcache_jit_attribute;
+
 #endif /* HAVE_JIT_H */

ext/opcache/tests/jit/attribute_001.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Opcache\Jit Attribute
+--INI--
+opcache.enable=1
+opcache.enable_cli=1
+opcache.file_update_protection=0
+opcache.jit_buffer_size=64
+opcache.jit=1245
+opcache.jit_debug=257
+--SKIPIF--
+<?php require_once('skipif.inc'); ?>
+--FILE--
+<?php
+
+<<Opcache\Jit(true)>>
+function test() {
+    return 1234;
+}
+function test2() {
+}
+
+test2();
+test();
+?>
+--EXPECTF--
+JIT$test: ; (%s)%A

ext/opcache/tests/jit/attribute_002.phpt

@@ -0,0 +1,32 @@
+--TEST--
+Opcache\Jit Attribute disables function
+--INI--
+opcache.enable=1
+opcache.enable_cli=1
+opcache.file_update_protection=0
+opcache.jit_buffer_size=64
+opcache.jit=1205
+opcache.jit_debug=257
+--SKIPIF--
+<?php require_once('skipif.inc'); ?>
+--FILE--
+<?php
+
+<<Opcache\Jit(false)>>
+function test() {
+    return 1234;
+}
+function test2() {
+}
+
+test();
+test2();
+?>
+--EXPECTF--
+JIT$%s: ; (%s)
+	sub $0x10, %s
+	add $0x10, %s
+	mov $ZEND_RETURN_SPEC_CONST_LABEL, %s
+	jmp *%s
+
+JIT$test2: ; (%s)%A

ext/opcache/tests/jit/attribute_003.phpt

@@ -0,0 +1,13 @@
+--TEST--
+Opcache\Jit on wrong declaration
+--SKIPIF--
+<?php require_once('skipif.inc'); ?>
+--FILE--
+<?php
+
+class Foo {
+    <<\Opcache\Jit>>
+    public $foo;
+}
+--EXPECTF--
+Fatal error: <<Opcache\Jit>> attribute can only be declared on methods or functions in %s

ext/opcache/tests/jit/attribute_004.phpt

@@ -0,0 +1,12 @@
+--TEST--
+Opcache\Jit too many arguments
+--SKIPIF--
+<?php require_once('skipif.inc'); ?>
+--FILE--
+<?php
+
+<<\Opcache\Jit(false, true)>>
+function test() {
+}
+--EXPECTF--
+Fatal error: <<Opcache\Jit>> requires zero or one argument, 2 arguments given in %s

ext/opcache/tests/jit/attribute_005.phpt

@@ -0,0 +1,12 @@
+--TEST--
+Opcache\Jit not boolean
+--SKIPIF--
+<?php require_once('skipif.inc'); ?>
+--FILE--
+<?php
+
+<<\Opcache\Jit("true")>>
+function test() {
+}
+--EXPECTF--
+Fatal error: <<Opcache\Jit>> first argument $enabled must be a boolean in %s

ext/opcache/zend_accelerator_module.c

@@ -31,6 +31,7 @@
 #include "zend_virtual_cwd.h"
 #include "ext/standard/info.h"
 #include "ext/standard/php_filestat.h"
+#include "Zend/zend_attributes.h"
 #include "opcache_arginfo.h"
 
 #if HAVE_JIT
@@ -360,12 +361,35 @@ static ZEND_NAMED_FUNCTION(accel_is_readable)
 	}
 }
 
+void zend_jit_validate_opcache_attribute(zend_attribute *jit, int target)
+{
+	if (target != ZEND_ATTRIBUTE_TARGET_METHOD && target != ZEND_ATTRIBUTE_TARGET_FUNCTION) {
+		zend_error(E_COMPILE_ERROR, "<<Opcache\\Jit>> attribute can only be declared on methods or functions");
+	}
+
+	if (jit->argc > 1) {
+		zend_error(E_COMPILE_ERROR, "<<Opcache\\Jit>> requires zero or one argument, %d arguments given", jit->argc);
+	}
+
+	if (jit->argc == 1 && Z_TYPE(jit->argv[0]) != IS_TRUE && Z_TYPE(jit->argv[0]) != IS_FALSE) {
+		zend_error(E_COMPILE_ERROR, "<<Opcache\\Jit>> first argument $enabled must be a boolean");
+	}
+}
+
 static ZEND_MINIT_FUNCTION(zend_accelerator)
 {
 	(void)type; /* keep the compiler happy */
+	zend_class_entry ce;
 
 	REGISTER_INI_ENTRIES();
 
+	INIT_NS_CLASS_ENTRY(ce, "Opcache", "Jit", NULL);
+	zend_ce_opcache_jit_attribute = zend_register_internal_class(&ce);
+	zend_ce_opcache_jit_attribute->ce_flags |= ZEND_ACC_FINAL;
+
+	zend_compiler_attribute_register(zend_ce_opcache_jit_attribute, &zend_jit_validate_opcache_attribute);
+
+
 	return SUCCESS;
 }