Replacing the usage of the polyglot library in favor of jit-executor.

This patch updates the code to use the new jit-executor library
dependency for JavaScript support.

Additionally, the sources to build the jit-executor library have
been updated to match the project used for the MySQL Middleware
Clients.

Change-Id: Ic29b5cd478b801fa57417dff4ea7abaaa5e671c7

Author: rennox

CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0,
@@ -755,31 +755,30 @@ if(HAVE_PYTHON)
   ENDIF()
 endif()
 
-IF (BUNDLED_POLYGLOT_DIR)
-  FIND_LIBRARY(POLYGLOT_LIBRARY
+IF (JIT_EXECUTOR_LIB)
+  FIND_LIBRARY(JIT_EXECUTOR_LIBRARY
     NAMES
-      polyglot
-      libpolyglot
+      jitexecutor
     HINTS
-      "${BUNDLED_POLYGLOT_DIR}"
+      "${JIT_EXECUTOR_LIB}"
     NO_DEFAULT_PATH)
 
   IF(APPLE)
     # reset the ID to something predictible
-    get_filename_component(POLYGLOT_LIBRARY_NAME "${POLYGLOT_LIBRARY}" NAME)
-    EXECUTE_PROCESS(COMMAND install_name_tool -id "${POLYGLOT_LIBRARY_NAME}" "${POLYGLOT_LIBRARY}" RESULT_VARIABLE COMMAND_RESULT)
+    get_filename_component(JIT_EXECUTOR_LIBRARY_NAME "${JIT_EXECUTOR_LIBRARY}" NAME)
+    EXECUTE_PROCESS(COMMAND install_name_tool -id "${JIT_EXECUTOR_LIBRARY_NAME}" "${JIT_EXECUTOR_LIBRARY}" RESULT_VARIABLE COMMAND_RESULT)
 
     IF(NOT "${COMMAND_RESULT}" STREQUAL "0")
-      MESSAGE(FATAL_ERROR "Failed to execute: install_name_tool -id ${POLYGLOT_LIBRARY_NAME} ${POLYGLOT_LIBRARY}")
+      MESSAGE(FATAL_ERROR "Failed to execute: install_name_tool -id ${JIT_EXECUTOR_LIBRARY_NAME} ${JIT_EXECUTOR_LIBRARY}")
     ENDIF()
   ENDIF()
 
-  INCLUDE_DIRECTORIES(SYSTEM "${BUNDLED_POLYGLOT_DIR}")
-  MESSAGE(STATUS "Polyglot Library: ${POLYGLOT_LIBRARY}")  
+  INCLUDE_DIRECTORIES(SYSTEM "${JIT_EXECUTOR_LIB}")
+  MESSAGE(STATUS "Jit Executor library: ${JIT_EXECUTOR_LIBRARY}")
   SET(HAVE_JS 1)
-  SET(HAVE_POLYGLOT 1)
+  SET(HAVE_JIT_EXECUTOR 1)
   ADD_DEFINITIONS(-DHAVE_JS)
-  ADD_DEFINITIONS(-DHAVE_POLYGLOT)
+  ADD_DEFINITIONS(-DHAVE_JIT_EXECUTOR)
 ENDIF()
 
 

INSTALL

@@ -95,7 +95,7 @@ ext/polyglot/README.txt
 
 To support JavaScript on the MySQL Shell add the following flag to the CMake call:
 
--DBUNDLED_POLYGLOT_DIR=<Path>
+-DJIT_EXECUTOR_LIB=<Path>
 
 Where Path is the path to the folder containing the native Polyglot API library
 and headers

cmake/exeutils.cmake

@@ -1,4 +1,4 @@
-# Copyright (c) 2019, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2019, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0,
@@ -89,10 +89,10 @@ function(add_shell_executable)
                 "${ANTLR4_LIB_FILENAME}" "@loader_path/../${INSTALL_LIBDIR}/${ANTLR4_LIB_FILENAME}"
                 $<TARGET_FILE:${ARGV0}>)
     endif()
-    if(BUNDLED_POLYGLOT_DIR)
+    if(JIT_EXECUTOR_LIB)
       add_custom_command(TARGET "${ARGV0}" POST_BUILD
         COMMAND install_name_tool -change
-                "${POLYGLOT_LIBRARY_NAME}" "@loader_path/../${INSTALL_LIBDIR}/${POLYGLOT_LIBRARY_NAME}"
+                "${JIT_EXECUTOR_LIBRARY_NAME}" "@loader_path/../${INSTALL_LIBDIR}/${JIT_EXECUTOR_LIBRARY_NAME}"
                 $<TARGET_FILE:${ARGV0}>
       )
     endif()

ext/polyglot/README.txt

@@ -1,20 +1,19 @@
-This project builds a native version of the GraalVM Polyglot Native API Library
-with some enhancements required for the proper integration of GraalVM as a
-JavaScript runtime on the MySQL Middleware Clients.
+This project builds the JIT Executor library based on the GraalVM Polyglot
+Native API Library with some enhancements required for the proper integration of
+GraalVM as a JavaScript runtime on the MySQL Middleware Clients.
 
 The library is assembled by taking the official code for the GraalVM Polyglot
 Native API Library sources and exporting additional functionality through the
 use of a patch file contained in the polyglot-nativeapi/patches directory.
 
 For details about how to update this library to meet additional requirements on
-the MySQL Middleware clients, refer to the README.txt file at the
-polyglot-nativeapi folder.
+the MySQL Middleware clients, refer to polyglot-nativeapi folder.
 
 BUILD REQUIREMENTS
 ------------------
 
-To build the native version of the GraalVM Polyglot Native API created with
-this project the following requirements should be met:
+To build the JIT Executor library created with this project the following
+requirements should be met:
 
 - GraalVM 23.0.1 Installed and in PATH (to execute the native-image command)
 - The GraalVM 23.0.1 source code.
@@ -36,10 +35,9 @@ This command will execute the following steps:
 - 1) Copy the GraalVM Polyglot API sources from GRAALJDK_ROOT to this project.
 - 2) Apply the patches in the polyglot-nativeapi/patches folder to the copied
      sources.
-- 3) Build the native library for the GraalVM Polyglot Native API
+- 3) Build the JIT Executor library
 
-The native library for the GraalVM Polyglot Native API library will be built at
-the following path:
+The JIT Executor library library will be built at the following path:
 
 polyglot-nativeapi-native-library/target
 

ext/polyglot/polyglot-nativeapi-native-library/pom.xml

@@ -13,22 +13,9 @@
     <groupId>org.graalvm.polyglot.library</groupId>
     <artifactId>polyglot-nativeapi-native-library</artifactId>
     <version>1.0-SNAPSHOT</version>
-    <packaging>pom</packaging>
-
-    <properties>
-        <maven.compiler.target>22</maven.compiler.target>
-        <maven.compiler.source>22</maven.compiler.source>
-        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    </properties>
 
     <dependencies>
 
-        <dependency>
-            <groupId>org.graalvm.polyglot</groupId>
-            <artifactId>polyglot</artifactId>
-            <version>${graalvm.version}</version>
-        </dependency>
-
         <dependency>
             <groupId>org.graalvm.polyglot.library</groupId>
             <artifactId>polyglot-nativeapi</artifactId>
@@ -65,7 +52,7 @@
                         </configuration>
                     </execution>
                     <execution>
-                        <id>build-polyglot-library</id>
+                        <id>build-jit-executor-library</id>
                         <phase>package</phase>
                         <goals>
                             <goal>exec</goal>
@@ -77,7 +64,7 @@
                             <commandlineArgs>
                                 -p %classpath
                                 -H:+ReportExceptionStackTraces
-                                -o ${project.build.directory}${file.separator}libpolyglot
+                                -o ${project.build.directory}${file.separator}libjitexecutor
                                 --no-fallback
                                 --shared
                                 -H:+UnlockExperimentalVMOptions
@@ -96,6 +83,7 @@
                                 -J-Xmx20g
                                 --initialize-at-run-time=org.graalvm.polyglot.nativeapi.PolyglotNativeAPI$NativeDataHolder
                                 --verbose
+                                -march=compatibility
                             </commandlineArgs>
                         </configuration>
                     </execution>

ext/polyglot/polyglot-nativeapi/patches/enhancements.patch

@@ -1,5 +1,5 @@
 diff --git a/src/main/java/org/graalvm/polyglot/nativeapi/PolyglotNativeAPI.java b/src/main/java/org/graalvm/polyglot/nativeapi/PolyglotNativeAPI.java
-index 1ed21c307..496663aec 100644
+index 1ed21c307..7301ff355 100644
 --- a/src/main/java/org/graalvm/polyglot/nativeapi/PolyglotNativeAPI.java
 +++ b/src/main/java/org/graalvm/polyglot/nativeapi/PolyglotNativeAPI.java
 @@ -28,23 +28,60 @@ import static org.graalvm.polyglot.nativeapi.types.PolyglotNativeAPITypes.Polygl
@@ -189,7 +189,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_context_builder_build", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Builds a <code>context</code> from a <code>context_builder</code>. The same builder can be used to ",
                      "produce multiple <code>poly_context</code> instances.",
-@@ -808,6 +935,138 @@ public final class PolyglotNativeAPI {
+@@ -808,6 +935,160 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -215,6 +215,28 @@ index 1ed21c307..496663aec 100644
 +        return poly_ok;
 +    }
 +
++    @CEntryPoint(name = "poly_create_source", exceptionHandler = ExceptionHandler.class, documentation = {
++        "Creates a Source object.",
++        "",
++        "@param language_id_utf8 0 terminated and UTF-8 encoded language identifier.",
++        "@param name_utf8 0 terminated and UTF-8 encoded name given to the evaluate source code.",
++        "@param source_utf8 0 terminated and UTF-8 encoded source code to be evaluated.",
++        "@param result <code>poly_value</code> that is the Source Builder object.",
++        "@return poly_ok if all works, poly_generic_error if there is a failure.",
++    })
++    public static PolyglotStatus poly_create_source(PolyglotIsolateThread thread, @CConst CCharPointer language_id_utf8, @CConst CCharPointer path_utf8,
++            PolyglotValuePointer result) throws Exception {
++        resetErrorState();
++        nullCheck(language_id_utf8, "language_id_utf8");
++        nullCheck(path_utf8, "path_utf8");
++        String languageName = CTypeConversion.utf8ToJavaString(language_id_utf8);
++        String jPath = CTypeConversion.utf8ToJavaString(path_utf8);
++
++        Source source = Source.newBuilder(languageName, new File(jPath)).build();
++        result.write(createHandle(source));
++        return poly_ok;
++    }
++
 +    @CEntryPoint(name = "poly_create_source_builder", exceptionHandler = ExceptionHandler.class, documentation = {
 +        "Creates a Source object.",
 +        "",
@@ -328,7 +350,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_context_get_engine", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Returns the engine this context belongs to.",
                      "",
-@@ -954,6 +1213,36 @@ public final class PolyglotNativeAPI {
+@@ -954,6 +1235,36 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -365,7 +387,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_value_put_member", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Sets the value of a member with the `identifier_utf8`.",
                      "",
-@@ -975,6 +1264,25 @@ public final class PolyglotNativeAPI {
+@@ -975,6 +1286,25 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -391,7 +413,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_value_has_member", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Returns `true` if such a member exists for the given `identifier_utf8`. If the value has no members ",
                      "then it returns `false`.",
-@@ -1174,86 +1482,1769 @@ public final class PolyglotNativeAPI {
+@@ -1174,86 +1504,1769 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -2212,7 +2234,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_create_array", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Creates a polyglot array from the C array of polyglot values.",
                      "",
-@@ -1396,6 +3387,60 @@ public final class PolyglotNativeAPI {
+@@ -1396,6 +3409,60 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -2273,7 +2295,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_value_is_null", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Returns `true` if this value is `null` like.",
                      "",
-@@ -1668,6 +3713,71 @@ public final class PolyglotNativeAPI {
+@@ -1668,6 +3735,71 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -2345,7 +2367,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_value_to_string_utf8", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Writes a <code>toString</code> representation of a <code>poly_value</code> as a 0 terminated and UTF-8 encoded string.",
                      "",
-@@ -1985,14 +4095,14 @@ public final class PolyglotNativeAPI {
+@@ -1985,14 +4117,14 @@ public final class PolyglotNativeAPI {
                      for (int i = 0; i < arguments.length; i++) {
                          handleArgs[i] = createHandle(arguments[i]);
                      }
@@ -2366,7 +2388,7 @@ index 1ed21c307..496663aec 100644
                  } finally {
                      threadLocals.get().callbackException = null;
                      getHandles().popFramesIncluding(frame);
-@@ -2003,6 +4113,81 @@ public final class PolyglotNativeAPI {
+@@ -2003,6 +4135,81 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -2448,7 +2470,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_get_callback_info", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Retrieves details about the call within a callback (e.g., the arguments from a given callback info).",
                      "",
-@@ -2020,20 +4205,43 @@ public final class PolyglotNativeAPI {
+@@ -2020,20 +4227,43 @@ public final class PolyglotNativeAPI {
          nullCheck(data, "data");
          PolyglotCallbackInfoInternal callbackInfo = fetchHandle(callback_info);
          UnsignedWord numberOfArguments = WordFactory.unsigned(callbackInfo.arguments.length);
@@ -2501,7 +2523,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_throw_exception", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Raises an exception in a C callback.",
                      "",
-@@ -2052,6 +4260,25 @@ public final class PolyglotNativeAPI {
+@@ -2052,6 +4282,25 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -2527,7 +2549,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_delete_reference", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Deletes a poly_reference. After this point, the reference must not be used anymore.",
                      "",
-@@ -2171,6 +4398,26 @@ public final class PolyglotNativeAPI {
+@@ -2171,6 +4420,26 @@ public final class PolyglotNativeAPI {
          return poly_ok;
      }
 
@@ -2554,7 +2576,7 @@ index 1ed21c307..496663aec 100644
      @CEntryPoint(name = "poly_exception_is_internal_error", exceptionHandler = ExceptionHandler.class, documentation = {
                      "Checks if this exception was caused by an internal implementation error.",
                      "",
-@@ -2649,6 +4896,61 @@ public final class PolyglotNativeAPI {
+@@ -2649,6 +4918,61 @@ public final class PolyglotNativeAPI {
          }
      }
 
@@ -2627,5 +2649,5 @@ index a227d9c9e..58a723a15 100644
 -        return createIsolate(params, isolate, thread) == 0 ? Poly.ok() : Poly.generic_failure();
 +        return createIsolate(params, isolate, thread);
      }
-
+ 
      @Uninterruptible(reason = UNINTERRUPTIBLE_REASON)

mysqlshdk/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2017, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2017, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0,
@@ -84,6 +84,6 @@ target_link_libraries(mysqlshdk-static PUBLIC
           ${SSL_LIBRARIES}
           ${ANTLR4_LIBRARIES})
 
-IF(HAVE_POLYGLOT)
-    target_link_libraries(mysqlshdk-static PUBLIC ${POLYGLOT_LIBRARY})
+IF(HAVE_JIT_EXECUTOR)
+    target_link_libraries(mysqlshdk-static PUBLIC ${JIT_EXECUTOR_LIBRARY})
 ENDIF()

mysqlshdk/scripting/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0,
@@ -34,7 +34,7 @@ set(SCRIPTING_SOURCES
     type_info/custom.cc)
 
 
-if (HAVE_POLYGLOT)
+if (HAVE_JIT_EXECUTOR)
     set(SCRIPTING_SOURCES
       ${SCRIPTING_SOURCES}
       polyglot/native_wrappers/polyglot_collectable.cc

mysqlshdk/shellcore/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2024, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2025, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0,
@@ -55,7 +55,7 @@ set(SHELLCORE_SOURCES
   utils_help.cc
   wizard.cc)
 
-if(HAVE_POLYGLOT)
+if(HAVE_JIT_EXECUTOR)
   set(SHELLCORE_SOURCES
         ${SHELLCORE_SOURCES}
         provider_polyglot.cc

mysqlshdk/shellcore/base_shell.cc

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014, 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2014, 2025, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0,
@@ -44,7 +44,7 @@
 #include "mysqlshdk/shellcore/provider_python.h"
 #include "shellcore/shell_python.h"
 #endif
-#ifdef HAVE_POLYGLOT
+#ifdef HAVE_JIT_EXECUTOR
 #include "mysqlshdk/include/shellcore/shell_polyglot.h"
 #include "mysqlshdk/shellcore/provider_polyglot.h"
 #endif

mysqlshdk/shellcore/shell_core.cc

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2014, 2024, Oracle and/or its affiliates.
+ * Copyright (c) 2014, 2025, Oracle and/or its affiliates.
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License, version 2.0,
@@ -32,7 +32,7 @@
 #include <unistd.h>
 #endif
 #include "mysqlshdk/include/shellcore/base_shell.h"
-#ifdef HAVE_POLYGLOT
+#ifdef HAVE_JIT_EXECUTOR
 #include "mysqlshdk/include/shellcore/shell_polyglot.h"
 #include "mysqlshdk/scripting/polyglot/utils/polyglot_utils.h"
 #endif