From a35c8513cc6881e564463bcfd1af1057112d52ad Mon Sep 17 00:00:00 2001
From: baldurk <baldurk@baldurk.org>
Date: Sun, 2 Sep 2018 13:17:45 +0100
Subject: [PATCH] Implement hooking support on apple

* This assumes it will be used in concert with dyld interposing so it doesn't
  actually do any hooking apart from intercepting dlopen/dlsym to substitute any
  dynamic access to hooked functions. Otherwise it just fulfills the contract by
  calling callbacks and populating original function pointers
---
 renderdoc/os/posix/apple/apple_hook.cpp | 143 ++++++++++++++++++++----
 1 file changed, 119 insertions(+), 24 deletions(-)

diff --git a/renderdoc/os/posix/apple/apple_hook.cpp b/renderdoc/os/posix/apple/apple_hook.cpp
index 33ed8314d..5d91854aa 100644
--- a/renderdoc/os/posix/apple/apple_hook.cpp
+++ b/renderdoc/os/posix/apple/apple_hook.cpp
@@ -22,34 +22,72 @@
  * THE SOFTWARE.
  ******************************************************************************/
 
-#include "hooks/hooks.h"
-
 #include <dlfcn.h>
 #include <stddef.h>
+#include <algorithm>
+#include <map>
+#include <set>
+#include <string>
+#include "common/threading.h"
+#include "hooks/hooks.h"
+#include "strings/string_utils.h"
+
+Threading::CriticalSection libLock;
+
+static std::map<std::string, std::vector<FunctionLoadCallback>> libraryCallbacks;
+static std::set<std::string> libraryHooks;
+static std::vector<FunctionHook> functionHooks;
+static std::set<void *> libraryHandles;
+
+void *interposed_dlopen(const char *filename, int flag)
+{
+  void *handle = dlopen(filename, flag);
+
+  std::string baseFilename = filename ? basename(std::string(filename)) : "";
+
+  {
+    SCOPED_LOCK(libLock);
+
+    // we don't redirect to ourselves, but we do remember this handle so we can intercept any
+    // subsequent dlsym calls.
+    if(libraryHooks.find(baseFilename) != libraryHooks.end())
+      libraryHandles.insert(handle);
+  }
+
+  return handle;
+}
+
+void *interposed_dlsym(void *handle, const char *name)
+{
+  {
+    SCOPED_LOCK(libLock);
+    if(libraryHandles.find(handle) != libraryHandles.end())
+    {
+      for(FunctionHook &hook : functionHooks)
+        if(hook.function == name)
+          return hook.hook;
+    }
+  }
+
+  return dlsym(handle, name);
+}
+
+struct interposer
+{
+  const void *replacment;
+  const void *replacee;
+};
+
+__attribute__((used)) static interposer dlfuncs[] __attribute__((section("__DATA,__interpose"))) = {
+    {(const void *)(unsigned long)&interposed_dlsym, (const void *)(unsigned long)&dlsym},
+    {(const void *)(unsigned long)&interposed_dlopen, (const void *)(unsigned long)&dlopen},
+};
 
 void LibraryHooks::BeginHookRegistration()
 {
   // nothing to do
 }
 
-void LibraryHooks::RegisterFunctionHook(const char *libraryName, const FunctionHook &hook)
-{
-}
-
-void LibraryHooks::RegisterLibraryHook(char const *, FunctionLoadCallback cb)
-{
-  if(cb)
-    RDCERR("Hooking on apple not complete - function load callback not implemented");
-}
-
-void LibraryHooks::IgnoreLibrary(const char *libraryName)
-{
-}
-
-void LibraryHooks::EndHookRegistration()
-{
-}
-
 bool LibraryHooks::Detect(const char *identifier)
 {
   return dlsym(RTLD_DEFAULT, identifier) != NULL;
@@ -60,6 +98,67 @@ void LibraryHooks::RemoveHooks()
   RDCERR("Removing hooks is not possible on this platform");
 }
 
+void LibraryHooks::EndHookRegistration()
+{
+  // process libraries with callbacks by loading them if necessary (though we should be linked to
+  // them for the dyld interposing)
+  for(auto it = libraryCallbacks.begin(); it != libraryCallbacks.end(); ++it)
+  {
+    std::string libName = it->first;
+    void *handle = dlopen(libName.c_str(), RTLD_NOW | RTLD_GLOBAL);
+
+    if(handle)
+    {
+      for(FunctionLoadCallback cb : it->second)
+        if(cb)
+          cb(handle);
+
+      // don't call callbacks again if the library is dlopen'd again
+      it->second.clear();
+    }
+  }
+
+  // get the original pointers for all hooks now. All of the ones we will be able to get should now
+  // be available in the default namespace straight away
+  for(FunctionHook &hook : functionHooks)
+  {
+    if(hook.orig && *hook.orig == NULL)
+    {
+      *hook.orig = dlsym(RTLD_NEXT, hook.function.c_str());
+      RDCASSERT(*hook.orig != hook.hook, hook.function);
+    }
+  }
+}
+
+void LibraryHooks::Refresh()
+{
+  // don't need to refresh on mac
+}
+
+void LibraryHooks::RegisterFunctionHook(const char *libraryName, const FunctionHook &hook)
+{
+  // we don't use the library name
+  (void)libraryName;
+
+  SCOPED_LOCK(libLock);
+  functionHooks.push_back(hook);
+}
+
+void LibraryHooks::RegisterLibraryHook(char const *name, FunctionLoadCallback cb)
+{
+  SCOPED_LOCK(libLock);
+
+  // we match by basename for library hooks
+  libraryHooks.insert(basename(std::string(name)));
+
+  if(cb)
+    libraryCallbacks[name].push_back(cb);
+}
+
+void LibraryHooks::IgnoreLibrary(const char *libraryName)
+{
+}
+
 // android only hooking functions, not used on apple
 ScopedSuppressHooking::ScopedSuppressHooking()
 {
@@ -67,8 +166,4 @@ ScopedSuppressHooking::ScopedSuppressHooking()
 
 ScopedSuppressHooking::~ScopedSuppressHooking()
 {
-}
-
-void LibraryHooks::Refresh()
-{
 }
\ No newline at end of file