Frame tests for loading shared objects for the emscripten build

[anutosh491]

Description

Now that llvm/llvm-project#133037 has been merged, we should be able to test out loading shared libraries for the emscripten build.

Type of change

Please tick all options which are relevant.

• Bug fix
• New feature
• Requires documentation updates

Testing

Please describe the test(s) that you added and ran to verify your changes.

Checklist

• I have read the contribution guide recently

[github-actions]

clang-tidy made some suggestions

[github-actions]

warning: do not use reinterpret_cast [cppcoreguidelines-pro-type-reinterpret-cast]

  RetZeroFn Fn = reinterpret_cast<RetZeroFn>(Addr);
                 ^

[github-actions]

warning: use auto when initializing with a cast to avoid duplicating the type name [modernize-use-auto]

Suggested change

	RetZeroFn Fn = reinterpret_cast<RetZeroFn>(Addr);
	auto Fn = reinterpret_cast<RetZeroFn>(Addr);

[mcbarton]

@anutosh491 Just a couple of questions. Once this PR is ready will we be able to run the DynamicLibraryManagerTest Sanity test? Currently its skipped.

Does this PR have any relation to this PR? #308

[anutosh491]

Explaining the use-case/roadmap here

Symengine a Computer Algebra System with 1.2k stars wants us to host a link in their Readme so that users there can try it as a REPL in the browser. Check this

Steps to achieve this

1. Add a milestone label for [clang-repl] Implement LoadDynamicLibrary for clang-repl wasm use cases llvm/llvm-project#133037 . I have already cherry picked the relevant commit. @vgvassilev should be able to help us out here.

2. Move to llvm 20 (Upgrade CppInterOp to support llvm 20 #491)

3. Take this PR in after any review involved (and probably make a release whenever we are happy)

4. SymEngine used #pragma cling load back in the days to integrate with xeus-cling
   https://github.com/symengine/symengine/blob/master/symengine/symengine_config_cling.h.in#L5C1-L5C20

5. We can add a similar file having something like

#include "clang/Interpreter/CppInterOp.h"
static bool _symengine_loaded = []() {
    Cpp::LoadLibrary(@SYMENGINE_CPPINTEROP_LIBRARY_PATH@);
    return true;
}();

Included when we build using these definitions #if defined(__CLANG_REPL__) && defined(__EMSCRIPTEN__)

Was able to get this working locally !!!

This involves only having symengine in our wasm environment and no explicit linking/loading from our side. Any symengine header included would also load libsymengine.so .

So to provide the link to symengine, we would just ask the maintainers to fork the template library (https://github.com/jupyterlite/xeus-lite-demo) under their symengine org (and probably ask them to name it Symengine/xeus-cpp-symengine-demo or whatever) . Here in the template they would just need to update the environment and add symengine to get the above working.

[anutosh491]

Once this PR is ready will we be able to run the DynamicLibraryManagerTest Sanity test?

Absolutely. This PR fixes that.

EDIT: Actually to be fair not the Sanity test. The sanity test is not catered to the emscripten build.But we shall be able to add a custom test suitable for the emscripten build just like what I added (look at the test I added in the pr)

The sanity test has

std::string BinaryPath = GetExecutablePath(/*Argv0=*/nullptr);
  llvm::StringRef Dir = llvm::sys::path::parent_path(BinaryPath);
  Cpp::AddSearchPath(Dir.str().c_str());

Things like llvm::sys etc would not work for emscripten. Also there is no real concept of search paths in wasm ( we know where the preload the shared lib in the MEMFS so we don't have to search for it )

Does this PR have any relation to this PR? #308

The library autoloader PR is not focusing on loading dynamic libs while building against emscripten (or basically for our wasm use case) as per my knowledge. So the idea might have some relation but the use case is different.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.94%. Comparing base (e1ace51) to head (6b666b2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #548   +/-   ##
=======================================
  Coverage   75.94%   75.94%           
=======================================
  Files           9        9           
  Lines        3646     3646           
=======================================
  Hits         2769     2769           
  Misses        877      877           

Files with missing lines	Coverage Δ
lib/Interpreter/CppInterOpInterpreter.h	80.32% <ø> (ø)

Files with missing lines	Coverage Δ
lib/Interpreter/CppInterOpInterpreter.h	80.32% <ø> (ø)

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.