Fix all crashing tests for emscripten build (#523)

Co-authored-by: mcbarton <[email protected]>

Author: anutosh491

include/clang/Interpreter/CppInterOp.h

@@ -127,13 +127,15 @@ namespace Cpp {
       : m_Kind(K), m_DestructorCall(C), m_FD(Dtor) {}
 
     /// Checks if the passed arguments are valid for the given function.
-    bool AreArgumentsValid(void* result, ArgList args, void* self) const;
+    CPPINTEROP_API bool AreArgumentsValid(void* result, ArgList args,
+                                          void* self) const;
 
     /// This function is used for debugging, it reports when the function was
     /// called.
-    void ReportInvokeStart(void* result, ArgList args, void* self) const;
-    void ReportInvokeStart(void* object, unsigned long nary,
-                           int withFree) const;
+    CPPINTEROP_API void ReportInvokeStart(void* result, ArgList args,
+                                          void* self) const;
+    CPPINTEROP_API void ReportInvokeStart(void* object, unsigned long nary,
+                                          int withFree) const;
     void ReportInvokeEnd() const;
   public:
     Kind getKind() const { return m_Kind; }

lib/Interpreter/exports.ld

@@ -37,3 +37,12 @@
 -Wl,--export=_ZNK5clang7TagType7getDeclEv
 -Wl,--export=_ZNK5clang7VarDecl28isThisDeclarationADefinitionERNS_10ASTContextE
 -Wl,--export=_ZTVN4llvm18raw_string_ostreamE
+-Wl,--export=_ZN4llvm13StringMapImpl11RehashTableEj
+-Wl,--export=_ZN4llvm13StringMapImpl15LookupBucketForENS_9StringRefEj
+-Wl,--export=_ZN4llvm13StringMapImpl4hashENS_9StringRefE
+-Wl,--export=_ZNK5clang10ASTContext14getComplexTypeENS_8QualTypeE
+-Wl,--export=_ZNK5clang10ASTContext19getTypeDeclTypeSlowEPKNS_8TypeDeclE
+-Wl,--export=_ZNK5clang10RecordDecl19isInjectedClassNameEv
+-Wl,--export=_ZNK5clang11DeclContext6lookupENS_15DeclarationNameE
+-Wl,--export=_ZNK5clang17ClassTemplateDecl18getSpecializationsEv
+-Wl,--export=_ZNK5clang4Sema15getStdNamespaceEv

unittests/CppInterOp/CMakeLists.txt

@@ -25,16 +25,33 @@ add_cppinterop_unittest(CppInterOpTests
 )
 
 if(EMSCRIPTEN)
-  # Explaination of compile and link flags
-  # To dynamically link to a shared library for Emscripten builds you must use the MAIN_MODULE flag (see both https://github.com/emscripten-core/emscripten/issues/23543#issuecomment-2625334414
-  # and https://emscripten.org/docs/compiling/Dynamic-Linking.html)
-  # Without WASM_BIGINT flag then you get fatal errors when trying to run compiled Javascript about trying to convert between BigInt and non BigInt types
-  # EXPORTED_RUNTIME_METHODS='[\"FS\",\"PATH\",\"LDSO\",\"loadDynamicLibrary\",\"ERRNO_CODES\"]' and --preload-file ${SYSROOT_PATH}/include@/include are not allow the Javascript that is 
-  # compiled to have access to the standard library headers (approach taken from xeus-cpp)
-  # Without ALLOW_MEMORY_GROWTH=1 tests will fail with aborted(OOM). Approach to fix taken from answers to
-  # https://stackoverflow.com/questions/67222200/runtimeerror-abortoom-build-with-s-assertions-1-for-more-info
-  set_target_properties(CppInterOpTests PROPERTIES
-    LINK_FLAGS "-s MAIN_MODULE=1 -s WASM_BIGINT -s EXPORTED_RUNTIME_METHODS='[\"FS\",\"PATH\",\"LDSO\",\"loadDynamicLibrary\",\"ERRNO_CODES\"]' --preload-file ${SYSROOT_PATH}/include@/include -s ALLOW_MEMORY_GROWTH=1"
+  # Explanation of Emscripten-specific link flags for CppInterOpTests:
+  #
+  # MAIN_MODULE=1:
+  # Enables building CppInterOpTests.js as the main WebAssembly module, allowing dynamic linking of side modules.
+  #
+  # WASM_BIGINT:
+  # Ensures support for 64-bit integer types by enabling JavaScript BigInt integration in WASM.
+  #
+  # ALLOW_MEMORY_GROWTH=1:
+  # Allows the WebAssembly memory to grow dynamically at runtime to accommodate increasing memory needs.
+  # Would lead to an abortOnCannotGrowMemory error if memory cannot be grown while running the tests.
+  #
+  # STACK_SIZE=32mb: Allocates 32MB of stack space to handle deep recursion or large stack-allocated objects safely.
+  # INITIAL_MEMORY=128mb: Sets the initial linear memory size to 128MB to reduce the likelihood of early memory expansion and improve performance.
+  # The STACK_SIZE and INITIAL_MEMORY values are chosen based on what has been put to use for running xeus-cpp-lite.
+  # Check https://github.com/jupyter-xeus/xeus/blob/main/cmake/WasmBuildOptions.cmake#L35-L36 for more details.
+  # Not setting these flags would lead to a memory access out of bounds error while running the tests.
+  #
+  # --preload-file ${SYSROOT_PATH}/include@/include:
+  # Preloads the system include directory into the Emscripten virtual filesystem to make headers accessible at runtime.
+  target_link_options(CppInterOpTests
+    PUBLIC "SHELL: -s MAIN_MODULE=1"
+    PUBLIC "SHELL: -s WASM_BIGINT"
+    PUBLIC "SHELL: -s ALLOW_MEMORY_GROWTH=1"
+    PUBLIC "SHELL: -s STACK_SIZE=32mb"
+    PUBLIC "SHELL: -s INITIAL_MEMORY=128mb"
+    PUBLIC "SHELL: --preload-file ${SYSROOT_PATH}/include@/include"
   )
 endif()
 
@@ -69,16 +86,14 @@ target_link_libraries(DynamicLibraryManagerTests
 )
 
 if(EMSCRIPTEN)
-  # Explaination of compile and link flags
-  # To dynamically link to a shared library for Emscripten builds you must use the MAIN_MODULE flag (see both https://github.com/emscripten-core/emscripten/issues/23543#issuecomment-2625334414
-  # and https://emscripten.org/docs/compiling/Dynamic-Linking.html)
-  # Without WASM_BIGINT flag then you get fatal errors when trying to run compiled Javascript about trying to convert between BigInt and non BigInt types
-  # EXPORTED_RUNTIME_METHODS='[\"FS\",\"PATH\",\"LDSO\",\"loadDynamicLibrary\",\"ERRNO_CODES\"]' and --preload-file ${SYSROOT_PATH}/include@/include are not allow the Javascript that is 
-  # compiled to have access to the standard library headers (approach taken from xeus-cpp)
-  # Without ALLOW_MEMORY_GROWTH=1 tests will fail with aborted(OOM). Approach to fix taken from answers to
-  # https://stackoverflow.com/questions/67222200/runtimeerror-abortoom-build-with-s-assertions-1-for-more-info
-  set_target_properties(DynamicLibraryManagerTests PROPERTIES
-    LINK_FLAGS "-s MAIN_MODULE=1 -s WASM_BIGINT -s EXPORTED_RUNTIME_METHODS='[\"FS\",\"PATH\",\"LDSO\",\"loadDynamicLibrary\",\"ERRNO_CODES\"]' --preload-file ${SYSROOT_PATH}/include@/include -s ALLOW_MEMORY_GROWTH=1"
+  # Check explanation of Emscripten-specific link flags for CppInterOpTests above for DynamicLibraryManagerTests as well.
+  target_link_options(DynamicLibraryManagerTests
+    PUBLIC "SHELL: -s MAIN_MODULE=1"
+    PUBLIC "SHELL: -s WASM_BIGINT"
+    PUBLIC "SHELL: -s ALLOW_MEMORY_GROWTH=1"
+    PUBLIC "SHELL: -s STACK_SIZE=32mb"
+    PUBLIC "SHELL: -s INITIAL_MEMORY=128mb"
+    PUBLIC "SHELL: --preload-file ${SYSROOT_PATH}/include@/include"
   )
 endif()
 

unittests/CppInterOp/FunctionReflectionTest.cpp

@@ -547,9 +547,6 @@ TEST(FunctionReflectionTest, ExistsFunctionTemplate) {
 }
 
 TEST(FunctionReflectionTest, InstantiateTemplateFunctionFromString) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";
   Cpp::CreateInterpreter();
@@ -1053,7 +1050,7 @@ TEST(FunctionReflectionTest, IsStaticMethod) {
 
 TEST(FunctionReflectionTest, GetFunctionAddress) {
 #ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
+  GTEST_SKIP() << "Test fails for Emscipten builds";
 #endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";
@@ -1100,7 +1097,7 @@ TEST(FunctionReflectionTest, IsVirtualMethod) {
 
 TEST(FunctionReflectionTest, JitCallAdvanced) {
 #ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
+  GTEST_SKIP() << "Test fails for Emscipten builds";
 #endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";
@@ -1127,7 +1124,7 @@ TEST(FunctionReflectionTest, JitCallAdvanced) {
 
 TEST(FunctionReflectionTest, GetFunctionCallWrapper) {
 #ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
+  GTEST_SKIP() << "Test fails for Emscipten builds";
 #endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";

unittests/CppInterOp/ScopeReflectionTest.cpp

@@ -161,9 +161,6 @@ TEST(ScopeReflectionTest, SizeOf) {
 
 
 TEST(ScopeReflectionTest, IsBuiltin) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   // static std::set<std::string> g_builtins =
   // {"bool", "char", "signed char", "unsigned char", "wchar_t", "short", "unsigned short",
   //  "int", "unsigned int", "long", "unsigned long", "long long", "unsigned long long",
@@ -494,9 +491,6 @@ TEST(ScopeReflectionTest, GetScopefromCompleteName) {
 }
 
 TEST(ScopeReflectionTest, GetNamed) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   std::string code = R"(namespace N1 {
                         namespace N2 {
                           class C {
@@ -882,9 +876,6 @@ template<typename T> T TrivialFnTemplate() { return T(); }
 }
 
 TEST(ScopeReflectionTest, InstantiateTemplateFunctionFromString) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";
   Cpp::CreateInterpreter();
@@ -1025,9 +1016,6 @@ TEST(ScopeReflectionTest, GetClassTemplateInstantiationArgs) {
 
 
 TEST(ScopeReflectionTest, IncludeVector) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   if (llvm::sys::RunningOnValgrind())
       GTEST_SKIP() << "XFAIL due to Valgrind report";
   std::string code = R"(

unittests/CppInterOp/TypeReflectionTest.cpp

@@ -546,9 +546,6 @@ TEST(TypeReflectionTest, IsPODType) {
 }
 
 TEST(TypeReflectionTest, IsSmartPtrType) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";
   Cpp::CreateInterpreter();

unittests/CppInterOp/VariableReflectionTest.cpp

@@ -264,7 +264,7 @@ CODE
 
 TEST(VariableReflectionTest, GetVariableOffset) {
 #ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
+  GTEST_SKIP() << "Test fails for Emscipten builds";
 #endif
   std::vector<Decl *> Decls;
 #define Stringify(s) Stringifyx(s)
@@ -331,9 +331,6 @@ TEST(VariableReflectionTest, GetVariableOffset) {
 CODE
 
 TEST(VariableReflectionTest, VariableOffsetsWithInheritance) {
-#ifdef EMSCRIPTEN
-  GTEST_SKIP() << "Test crashes gtest on Emscipten";
-#endif
   if (llvm::sys::RunningOnValgrind())
     GTEST_SKIP() << "XFAIL due to Valgrind report";