fix missing ___clear_cache when targetting iOS

[MrCyjaneK]

Without the patch I get the following issue

Undefined symbols for architecture arm64:
  "___clear_cache", referenced from:
      void randomx::JitCompilerA64::generateSuperscalarHash<8ul>(randomx::SuperscalarProgram (&) [8ul], std::__1::vector<unsigned long long, std::__1::allocator<unsigned long long>>&) in librandomx.a[27](jit_compiler_a64.cpp.o)
      randomx::JitCompilerA64::JitCompilerA64() in librandomx.a[27](jit_compiler_a64.cpp.o)
      randomx::JitCompilerA64::generateProgram(randomx::Program&, randomx::ProgramConfiguration&) in librandomx.a[27](jit_compiler_a64.cpp.o)
      randomx::JitCompilerA64::generateProgramLight(randomx::Program&, randomx::ProgramConfiguration&, unsigned int) in librandomx.a[27](jit_compiler_a64.cpp.o)
ld: symbol(s) not found for architecture arm64
clang: error: linker command failed with exit code 1 (use -v to see invocation)

I've found the very same fix used in xmrig/xmrig@10d2920

I didn't check the fix on iOS yet, but the library linked properly, so I guess it is good.

[SChernykh]

This is not a fix, you just removed (using #ifdef) the code that breaks the build. You still need to clear the code cache on arm64 CPUs. If you read the discussion in xmrig/xmrig#1246 and check the code in https://github.com/xmrig/xmrig/blob/master/src/crypto/common/VirtualMemory_unix.cpp#L206 you'll see there are more things needed to be done here to fix it.

I'm not sure this fix is even needed because all recent clang versions have __GNUC__ and __builtin___clear_cache defined and automatially translate it to the sys_icache_invalidate call.

[MrCyjaneK]

This is not a fix, you just removed (using #ifdef) the code that breaks the build. You still need to clear the code cache on arm64 CPUs. If you read the discussion in xmrig/xmrig#1246 and check the code in https://github.com/xmrig/xmrig/blob/master/src/crypto/common/VirtualMemory_unix.cpp#L206 you'll see there are more things needed to be done here to fix it.

Sorry! I've missed that part of the discussion, is fix like this more suitable or should I leave __GNUC__ check in place?

#ifdef HAVE_BUILTIN_CLEAR_CACHE
__builtin___clear_cache(reinterpret_cast<char*>(code), reinterpret_cast<char*>(code + CodeSize));
#else
sys_icache_invalidate(code, code + CodeSize);
#endif

I'm not sure this fix is even needed because all recent clang versions have GNUC and __builtin___clear_cache defined and automatially translate it to the sys_icache_invalidate call.

I'm currently building with the toolchain that ships with latest Xcode on macos, so at least on my machine it didn't work.

[SChernykh]

The C++ code has __builtin___clear_cache but the linker complains about ___clear_cache so the clang compiler does know about this function and replaces it with the call to __clear_cache, the problem is that the code is not linked against the correct library (libgcc probably). IMHO even the XMRig's solution is not a proper one, it just works around the problem which is somewhere in the CMake build step. Can you try iains/gcc-darwin-arm64#33 (comment) and other suggestions there?

[MrCyjaneK]

I've seen these solutions (and tried some), and they target macos instead of ios, and according to (a rather old) issue https://gitlab.haskell.org/ghc/ghc/-/issues/8561 ___clear_cache is a thing on MacOS but not iOS, people there also mention that JIT is not really a possible option on non-jailbroken iOS device, which also makes RandomX unusable, at least for the vast majority of iOS users.

luajit case mentioned in that issue also seems to treat iOS as a special thing when it comes to clearning cache https://repo.or.cz/luajit-2.0.git/blob/HEAD:/src/lj_mcode.c#l51

#if LJ_TARGET_X86ORX64
  UNUSED(start); UNUSED(end);
#elif LJ_TARGET_WINDOWS
  FlushInstructionCache(GetCurrentProcess(), start, (char *)end-(char *)start);
#elif LJ_TARGET_IOS
  sys_icache_invalidate(start, (char *)end-(char *)start);
#elif LJ_TARGET_PPC
  lj_vm_cachesync(start, end);
#elif defined(__GNUC__) || defined(__clang__)
  __clear_cache(start, end);
#else
#error "Missing builtin to flush instruction cache"
#endif

[MrCyjaneK]

Do not merge, aarch64-linux-android was broken in this port, I'll take look at it in a bit.

[MrCyjaneK]

Do not merge, aarch64-linux-android was broken in this port, I'll take look at it in a bit.

Resolved. Testing on iOS is still pending - but it should work without issues, it doesn't break windows, linux and macos builds.

[tevador]

Related issue: #153