Use capstone explicitly, drop oprofile (GH 10876) (#10918)

* ext/opcache/config.m4: new --with-opcache-capstone flag.

Until now, libcapstone has been detected "automagically" and used for
JIT disassembly whenever it is available on the system used to compile
PHP. This can have some unintended consequences, however: many users
have capstone installed for some other purpose, and are surprised to
find that PHP breaks when capstone is later uninstalled.

To address this, we have introduced a new --with-opcache-capstone flag
that is disabled by default, and that makes the user's preference
explicit. It is ignored unless the JIT is enabled.

* ext/opcache: drop support for the oprofile JIT profiler.

Recently we have replaced the "automagic" detection of capstone at
build time with a --with-opcache-capstone flag. The detection of
oprofile causes similar problems and would likely have the same
solution; however, it was suggested that we might remove oprofile
altogether. So, this commit removes it:

  * Remove the detection bits from ext/opcache/config.m4.
  * Drop HAVE_OPROFILE ifdef blocks.
  * Delete ext/opcache/jit/zend_jit_oprofile.c.
  * Undefine the ZEND_JIT_DEBUG_OPROFILE constant.

Author: orlitzky

ext/opcache/config.m4

@@ -18,6 +18,12 @@ PHP_ARG_ENABLE([opcache-jit],
   [yes],
   [no])
 
+PHP_ARG_WITH([opcache-capstone],,
+  [AS_HELP_STRING([--with-opcache-capstone],
+    [support opcache JIT disassembly through capstone])],
+  [no],
+  [no])
+
 if test "$PHP_OPCACHE" != "no"; then
 
   dnl Always build as shared extension
@@ -68,41 +74,18 @@ if test "$PHP_OPCACHE" != "no"; then
       DASM_FLAGS="$DASM_FLAGS -D ZTS=1"
     fi
 
-    PKG_CHECK_MODULES([CAPSTONE], [capstone >= 3.0.0],
-        [have_capstone="yes"], [have_capstone="no"])
-    if test "$have_capstone" = "yes"; then
-        AC_DEFINE(HAVE_CAPSTONE, 1, [ ])
+    AS_IF([test x"$with_opcache_capstone" = "xyes"],[
+      PKG_CHECK_MODULES([CAPSTONE],[capstone >= 3.0.0],[
+        AC_DEFINE([HAVE_CAPSTONE], [1], [Capstone is available])
         PHP_EVAL_LIBLINE($CAPSTONE_LIBS, OPCACHE_SHARED_LIBADD)
         PHP_EVAL_INCLINE($CAPSTONE_CFLAGS)
-    fi
-
-    PHP_SUBST(DASM_FLAGS)
-    PHP_SUBST(DASM_ARCH)
-
-    AC_MSG_CHECKING(for opagent in default path)
-    for i in /usr/local /usr; do
-      if test -r $i/include/opagent.h; then
-        OPAGENT_DIR=$i
-        AC_MSG_RESULT(found in $i)
-        break
-      fi
-    done
-    if test -z "$OPAGENT_DIR"; then
-      AC_MSG_RESULT(not found)
-    else
-      PHP_CHECK_LIBRARY(opagent, op_write_native_code,
-      [
-        AC_DEFINE(HAVE_OPROFILE,1,[ ])
-        PHP_ADD_INCLUDE($OPAGENT_DIR/include)
-        PHP_ADD_LIBRARY_WITH_PATH(opagent, $OPAGENT_DIR/$PHP_LIBDIR/oprofile, OPCACHE_SHARED_LIBADD)
-        PHP_SUBST(OPCACHE_SHARED_LIBADD)
-      ],[
-        AC_MSG_RESULT(not found)
       ],[
-        -L$OPAGENT_DIR/$PHP_LIBDIR/oprofile
+        AC_MSG_ERROR([capstone >= 3.0 required but not found])
       ])
-    fi
+    ])
 
+    PHP_SUBST(DASM_FLAGS)
+    PHP_SUBST(DASM_ARCH)
   fi
 
   AC_CHECK_FUNCS([mprotect memfd_create])

ext/opcache/jit/Makefile.frag

@@ -11,7 +11,6 @@ $(builddir)/jit/zend_jit.lo: \
 	$(srcdir)/jit/zend_jit_disasm.c \
 	$(srcdir)/jit/zend_jit_gdb.c \
 	$(srcdir)/jit/zend_jit_perf_dump.c \
-	$(srcdir)/jit/zend_jit_oprofile.c \
 	$(srcdir)/jit/zend_jit_vtune.c \
 	$(srcdir)/jit/zend_jit_trace.c \
 	$(srcdir)/jit/zend_elf.c

ext/opcache/jit/Makefile.frag.w32

@@ -12,6 +12,5 @@ $(BUILD_DIR)\ext\opcache\jit\zend_jit.obj: \
 	ext/opcache/jit/zend_jit_disasm.c \
 	ext/opcache/jit/zend_jit_gdb.c \
 	ext/opcache/jit/zend_jit_perf_dump.c \
-	ext/opcache/jit/zend_jit_oprofile.c \
 	ext/opcache/jit/zend_jit_trace.c \
 	ext/opcache/jit/zend_jit_vtune.c

ext/opcache/jit/zend_jit.c

@@ -720,9 +720,6 @@ static int zend_jit_add_veneer(dasm_State *Dst, void *buffer, uint32_t ins, int
 # include "jit/zend_jit_gdb.h"
 # include "jit/zend_jit_perf_dump.c"
 #endif
-#ifdef HAVE_OPROFILE
-# include "jit/zend_jit_oprofile.c"
-#endif
 
 #include "Zend/zend_cpuinfo.h"
 
@@ -898,7 +895,7 @@ static void *dasm_link_and_encode(dasm_State             **dasm_state,
 	size_t size;
 	int ret;
 	void *entry;
-#if defined(HAVE_DISASM) || defined(HAVE_GDB) || defined(HAVE_OPROFILE) || defined(HAVE_PERFTOOLS) || defined(HAVE_VTUNE)
+#if defined(HAVE_DISASM) || defined(HAVE_GDB) || defined(HAVE_PERFTOOLS) || defined(HAVE_VTUNE)
 	zend_string *str = NULL;
 #endif
 
@@ -1009,9 +1006,9 @@ static void *dasm_link_and_encode(dasm_State             **dasm_state,
 		}
 	}
 
-#if defined(HAVE_DISASM) || defined(HAVE_GDB) || defined(HAVE_OPROFILE) || defined(HAVE_PERFTOOLS) || defined(HAVE_VTUNE)
+#if defined(HAVE_DISASM) || defined(HAVE_GDB) || defined(HAVE_PERFTOOLS) || defined(HAVE_VTUNE)
 	if (!name) {
-		if (JIT_G(debug) & (ZEND_JIT_DEBUG_ASM|ZEND_JIT_DEBUG_GDB|ZEND_JIT_DEBUG_OPROFILE|ZEND_JIT_DEBUG_PERF|ZEND_JIT_DEBUG_VTUNE|ZEND_JIT_DEBUG_PERF_DUMP)) {
+		if (JIT_G(debug) & (ZEND_JIT_DEBUG_ASM|ZEND_JIT_DEBUG_GDB|ZEND_JIT_DEBUG_PERF|ZEND_JIT_DEBUG_VTUNE|ZEND_JIT_DEBUG_PERF_DUMP)) {
 			str = zend_jit_func_name(op_array);
 			if (str) {
 				name = ZSTR_VAL(str);
@@ -1059,14 +1056,6 @@ static void *dasm_link_and_encode(dasm_State             **dasm_state,
 	}
 #endif
 
-#ifdef HAVE_OPROFILE
-	if (JIT_G(debug) & ZEND_JIT_DEBUG_OPROFILE) {
-		zend_jit_oprofile_register(
-			name,
-			entry,
-			size);
-	}
-#endif
 
 #ifdef HAVE_PERFTOOLS
 	if (JIT_G(debug) & (ZEND_JIT_DEBUG_PERF|ZEND_JIT_DEBUG_PERF_DUMP)) {
@@ -1096,7 +1085,7 @@ static void *dasm_link_and_encode(dasm_State             **dasm_state,
 	}
 #endif
 
-#if defined(HAVE_DISASM) || defined(HAVE_GDB) || defined(HAVE_OPROFILE) || defined(HAVE_PERFTOOLS) || defined(HAVE_VTUNE)
+#if defined(HAVE_DISASM) || defined(HAVE_GDB) || defined(HAVE_PERFTOOLS) || defined(HAVE_VTUNE)
 	if (str) {
 		zend_string_release(str);
 	}
@@ -4912,14 +4901,6 @@ ZEND_EXT_API int zend_jit_startup(void *buf, size_t size, bool reattached)
 	zend_jit_gdb_init();
 #endif
 
-#ifdef HAVE_OPROFILE
-	if (JIT_G(debug) & ZEND_JIT_DEBUG_OPROFILE) {
-		if (!zend_jit_oprofile_startup()) {
-			// TODO: error reporting and cleanup ???
-			return FAILURE;
-		}
-	}
-#endif
 #ifdef HAVE_PTHREAD_JIT_WRITE_PROTECT_NP
 	zend_write_protect = pthread_jit_write_protect_supported_np();
 #endif
@@ -5034,12 +5015,6 @@ ZEND_EXT_API void zend_jit_shutdown(void)
 		fprintf(stderr, "\nJIT memory usage: %td\n", (ptrdiff_t)((char*)*dasm_ptr - (char*)dasm_buf));
 	}
 
-#ifdef HAVE_OPROFILE
-	if (JIT_G(debug) & ZEND_JIT_DEBUG_OPROFILE) {
-		zend_jit_oprofile_shutdown();
-	}
-#endif
-
 #ifdef HAVE_GDB
 	if (JIT_G(debug) & ZEND_JIT_DEBUG_GDB) {
 		zend_jit_gdb_unregister();

ext/opcache/jit/zend_jit.h

@@ -58,7 +58,6 @@
 
 #define ZEND_JIT_DEBUG_PERF      (1<<4)
 #define ZEND_JIT_DEBUG_PERF_DUMP (1<<5)
-#define ZEND_JIT_DEBUG_OPROFILE  (1<<6)
 #define ZEND_JIT_DEBUG_VTUNE     (1<<7)
 
 #define ZEND_JIT_DEBUG_GDB       (1<<8)