macOS support

.github/workflows/ci.yml

@@ -79,3 +79,41 @@ jobs:
       - name: Test
         working-directory: ${{runner.workspace}}/build
         run: ctest -V -C ${{matrix.build_type}} --timeout 60
+  macos:
+    strategy:
+      matrix:
+        os:
+          - { name: "macOS Big Sur 11", distro: macos-11 }
+          - { name: "macOS Monterey 12", distro: macos-12 }
+        build_type: [Debug, Release]
+        toolchain: ["gcc-macos-x86_64"]
+
+    name: "${{matrix.os.name}} ${{matrix.build_type}} ${{matrix.toolchain}}"
+    runs-on: ${{matrix.os.distro}}
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+
+      - name: Create build environment
+        working-directory: ${{runner.workspace}}
+        run: mkdir build
+
+      - name: Initialize CMake
+        env:
+          CC: /usr/bin/gcc
+          CXX: /usr/bin/g++
+        working-directory: ${{runner.workspace}}/build
+        run: cmake --debug-output $GITHUB_WORKSPACE -DCMAKE_BUILD_TYPE=${{matrix.build_type}} -DCMAKE_TOOLCHAIN_FILE=toolchains/${{matrix.toolchain}}.cmake
+
+      - name: Build
+        shell: bash
+        working-directory: ${{runner.workspace}}/build
+        run: make
+
+      - name: Test
+        working-directory: ${{runner.workspace}}/build
+        shell: bash
+        run: ctest -V -C ${{matrix.build_type}}
+

CMakeLists.txt

@@ -1,5 +1,6 @@
 cmake_minimum_required(VERSION 3.10)
-project(gluasteal LANGUAGES CXX VERSION 2.0)
+
+project(gluasteal LANGUAGES CXX VERSION 2.1)
 
 enable_testing()
 

README.md

@@ -2,7 +2,7 @@
 
 [![CI Badge](https://github.com/lewisclark/glua-steal/workflows/CI/badge.svg)](https://github.com/lewisclark/glua-steal/actions?query=workflow%3Aci)
 ![Downloads Badge](https://img.shields.io/github/downloads/lewisclark/glua-steal/total)
-![Version Badge](https://img.shields.io/badge/version-2.0-green)
+![Version Badge](https://img.shields.io/badge/version-2.1-green)
 ![License Badge](https://img.shields.io/github/license/lewisclark/glua-steal)
 ![Issues Badge](https://img.shields.io/github/issues/lewisclark/glua-steal)
 
@@ -13,7 +13,14 @@ gluasteal is a better, cross-platform replacement for various Lua dumpers and lo
 ![Windows usage](https://i.imgur.com/j38AKQ7.png)
 ![Linux usage](https://i.imgur.com/N7reRXS.png)
 
-Supports Windows & Linux (32-bit & 64-bit). Has not yet been tested on macOS.
+Supported operating systems and architectures:
+- Windows 32-bit
+- Windows 64-bit
+- Linux 32-bit
+- Linux 64-bit
+- macOS 64-bit
+
+Please submit an issue if glua-steal is not working on your system.
 
 ---
 
@@ -24,8 +31,6 @@ Supports Windows & Linux (32-bit & 64-bit). Has not yet been tested on macOS.
 * Lua Blocker - Block Lua scripts of your choosing
 * Concurrent IO - The Lua dumper does IO in its own thread to eliminate bottleneck and ensure maximum in-game performance
 * Robust protections against servers serving malicious file paths
-* Supports the 32-bit and 64-bit versions of the game
-* Supports Windows and Linux
 * Easily [configurable](#configuration)
 
 ---
@@ -61,7 +66,17 @@ Logs and Lua files will be written to the gluasteal folder, in your home directo
 
 #### macOS
 
-Using DYLD\_INSERT\_LIBRARIES (see LD\_PRELOAD above)
+Using LLDB.
+
+```bash
+pid=1234
+lib_path="/full/path/to/libgluasteal.dylib"
+
+sudo lldb --attach-pid $pid --batch \
+    -o "p (void*)dlopen(\"$lib_path\", 1)" \
+    -o detach \
+    -o quit
+```
 
 ---
 
@@ -155,11 +170,23 @@ git clone https://github.com/lewisclark/glua-steal
 cd glua-steal
 git submodule update --init --recursive
 mkdir build && cd build
-choose the 32bit or 64bit toolchain below (toolchains are in toolchains/ folder)
+choose the gcc-32bit or gcc-64bit toolchain below (toolchains are in toolchains/ folder)
 cmake .. -DCMAKE_TOOLCHAIN_FILE=../toolchains/gcc-<32bit/64bit>.cmake
 make
 ```
 
+##### macOS
+```
+git clone https://github.com/lewisclark/glua-steal
+cd glua-steal
+git submodule update --init --recursive
+mkdir build && cd build
+cmake .. -DCMAKE_TOOLCHAIN_FILE=../toolchains/gcc-macos-x86_64.cmake
+make
+```
+
+If needed, the library can be built in i386 (32-bit) using either the `gcc-macos-i386` or `gcc-macos-fat` toolchain. The 32-bit build of glua-steal has not been built or tested because Xcode [dropped support](../../commit/b54eb95f1412f36d0609ebc59a0af23608d6ea75) for building 32-bit applications.
+
 ---
 
 ### License

src/library/library.cpp

@@ -34,7 +34,7 @@ static const std::map<std::string, std::string> extension_mapping = {
 #endif
 };
 
-#if (defined(OS_LINUX) || defined(OS_MAC))
+#if (defined(OS_LINUX))
 	struct library_entry {
 		const char* name;
 		void* lib;
@@ -57,7 +57,7 @@ glt::lib::Library::Library(const std::string& pathname) :
 
 	std::string pathnamext(pathname + GetExtension(pathname));
 
-#if (defined(OS_LINUX) || defined(OS_MAC))
+#if (defined(OS_LINUX))
 	library_entry entry;
 	entry.name = pathnamext.c_str();
 	entry.lib = nullptr;
@@ -84,6 +84,35 @@ glt::lib::Library::Library(const std::string& pathname) :
 		}
 
 	} while (Module32Next(module_snap, &module_entry));
+#elif (defined(OS_MAC))
+	// https://developer.apple.com/library/archive/documentation/System/Conceptual/ManPages_iPhoneOS/man3/dyld.3.html
+
+	// FIXME: It isn't thread safe to iterate using this count - find an alternative
+	uint32_t num_images = _dyld_image_count();
+
+	const auto& logger = glt::GetLogger();
+	logger->debug("{} images to enumerate", num_images);
+
+	for (uint32_t i = 0; i < num_images; ++i) {
+		const char* c_name = _dyld_get_image_name(i);
+
+		if (!c_name)
+			continue;
+
+		std::string name = c_name;
+
+		logger->debug("image \"{}\"", name);
+
+		if (name.find(pathnamext) != std::string::npos) {
+			auto p = dlopen(c_name, RTLD_NOLOAD | RTLD_NOW);
+
+			logger->debug("found image \"{}\" at {:x}", name, (uintptr_t)p);
+
+			m_handle = reinterpret_cast<std::uintptr_t*>(p);
+
+			break;
+		}
+	}
 #endif
 
 	if (!m_handle) {

src/library/library.hpp

@@ -24,13 +24,17 @@ along with this program.  If not, see <https://www.gnu.org/licenses/>. */
 #include <map>
 
 #include "os.hpp"
+#include "logger.hpp"
 
-#if (defined(OS_LINUX) || defined(OS_MAC))
+#if (defined(OS_LINUX))
 #include <dlfcn.h>
 #include <link.h>
 #elif (defined(OS_WINDOWS))
 #include <windows.h>
 #include <tlhelp32.h>
+#elif (defined(OS_MAC))
+#include <dlfcn.h>
+#include <mach-o/dyld.h>
 #endif
 
 namespace glt::lib {

toolchains/gcc-macos-fat.cmake

@@ -0,0 +1,4 @@
+set(CMAKE_CXX_FLAGS "-Wall -Wextra -pedantic -Wno-unused-variable")
+set(CMAKE_C_FLAGS "-Wall -Wextra -pedantic -Wno-unused-variable")
+
+set(CMAKE_OSX_ARCHITECTURES "i386;x86_64" CACHE STRING "" FORCE)

toolchains/gcc-macos-i386.cmake

@@ -0,0 +1,4 @@
+set(CMAKE_CXX_FLAGS "-Wall -Wextra -pedantic -Wno-unused-variable")
+set(CMAKE_C_FLAGS "-Wall -Wextra -pedantic -Wno-unused-variable")
+
+set(CMAKE_OSX_ARCHITECTURES "i386" CACHE STRING "" FORCE)

toolchains/gcc-macos-x86_64.cmake

@@ -0,0 +1,4 @@
+set(CMAKE_CXX_FLAGS "-Wall -Wextra -pedantic -Wno-unused-variable")
+set(CMAKE_C_FLAGS "-Wall -Wextra -pedantic -Wno-unused-variable")
+
+set(CMAKE_OSX_ARCHITECTURES "x86_64" CACHE STRING "" FORCE)