Add macOS support

pablogsal · pablogsal · commit 53d4d57e90c1 · 2024-02-21T20:12:11.000Z
diff --git a/Lib/test/test_external_inspection.py b/Lib/test/test_external_inspection.py
@@ -23,6 +23,7 @@ def _make_test_script(script_dir, script_basename, source):
 
 class TestGetStackTrace(unittest.TestCase):
 
+    @unittest.skipIf(sys.platform != "darwin" and sys.platform != "linux", "Test only runs on Linux and MacOS")
     @unittest.skipIf(sys.platform == "linux" and not PROCESS_VM_READV_SUPPORTED, "Test only runs on Linux with process_vm_readv support")
     def test_stack_trace(self):
         # Spawn a process with some realistic Python code
diff --git a/Modules/_testexternalinspection.c b/Modules/_testexternalinspection.c
@@ -20,7 +20,9 @@
     #include <mach/mach_vm.h>
     #include <mach/machine.h>
     #include <libproc.h>
-#endif 
+    #include <sys/proc.h>
+    #include <sys/sysctl.h>
+#endif
 
 #include <errno.h>
 #include <fcntl.h>
@@ -31,9 +33,7 @@
 #include <string.h>
 #include <sys/mman.h>
 #include <sys/param.h>
-#include <sys/proc.h>
 #include <sys/stat.h>
-#include <sys/sysctl.h>
 #include <sys/types.h>
 #include <unistd.h>
 
@@ -166,6 +166,7 @@ static mach_port_t pid_to_task(pid_t pid) {
   result = task_for_pid(mach_task_self(), pid, &task);
   if (result != KERN_SUCCESS) {
     printf("Call to task_for_pid failed on PID %d: %s", pid, mach_error_string(result));
+    PyErr_SetString(PyExc_PermissionError, "Cannot get task for PID");
     return 0;
   }
   return task;
@@ -189,7 +190,7 @@ static void* get_py_runtime(pid_t pid) {
   void* result_address = NULL;
   while (mach_vm_region(
              proc_ref, &address, &size, VM_REGION_BASIC_INFO_64,
-             (vm_region_info_t)&region_info, // cppcheck-suppress [uninitvar]
+             (vm_region_info_t)&region_info,
              &count, &object_name) == KERN_SUCCESS) {
 
     int path_len = proc_regionfilename(pid, address, map_filename, MAXPATHLEN);
@@ -224,6 +225,55 @@ static void* get_py_runtime(pid_t pid) {
 
 
 #ifdef __linux__
+unsigned long
+find_python_map_start_address(pid_t pid, char* result_filename) {
+    char maps_file_path[64];
+    sprintf(maps_file_path, "/proc/%d/maps", pid);
+
+    FILE* maps_file = fopen(maps_file_path, "r");
+    if (maps_file == NULL) {
+        PyErr_SetFromErrno(PyExc_OSError);
+        return 0;
+    }
+
+    int match_found = 0;
+
+    char line[256];
+    char map_filename[256];
+    unsigned long result_address = 0;
+    while (fgets(line, sizeof(line), maps_file) != NULL) {
+        unsigned long start_address = 0;
+        sscanf(line, "%lx-%*x %*s %*s %*s %*s %s", &start_address, map_filename);
+        char* filename = strrchr(map_filename, '/');
+        if (filename != NULL) {
+            filename++;  // Move past the '/'
+        } else {
+            filename = map_filename;  // No path, use the whole string
+        }
+
+        // Check if the filename starts with "python" or "libpython"
+        if (!match_found && strncmp(filename, "python", 6) == 0) {
+            match_found = 1;
+            result_address = start_address;
+            strcpy(result_filename, map_filename);
+        }
+        if (strncmp(filename, "libpython", 9) == 0) {
+            match_found = 1;
+            result_address = start_address;
+            strcpy(result_filename, map_filename);
+            break;
+        }
+    }
+
+    fclose(maps_file);
+
+    if (!match_found) {
+        map_filename[0] = '\0';
+    }
+
+    return result_address;
+}
+
 void*
 get_py_runtime(pid_t pid) {
 
@@ -279,54 +329,7 @@ get_py_runtime(pid_t pid) {
     return result;
 }
 
-unsigned long
-find_python_map_start_address(pid_t pid, char* result_filename) {
-    char maps_file_path[64];
-    sprintf(maps_file_path, "/proc/%d/maps", pid);
-
-    FILE* maps_file = fopen(maps_file_path, "r");
-    if (maps_file == NULL) {
-        PyErr_SetFromErrno(PyExc_OSError);
-        return 0;
-    }
-
-    int match_found = 0;
-
-    char line[256];
-    char map_filename[256];
-    unsigned long result_address = 0;
-    while (fgets(line, sizeof(line), maps_file) != NULL) {
-        unsigned long start_address = 0;
-        sscanf(line, "%lx-%*x %*s %*s %*s %*s %s", &start_address, map_filename);
-        char* filename = strrchr(map_filename, '/');
-        if (filename != NULL) {
-            filename++;  // Move past the '/'
-        } else {
-            filename = map_filename;  // No path, use the whole string
-        }
 
-        // Check if the filename starts with "python" or "libpython"
-        if (!match_found && strncmp(filename, "python", 6) == 0) {
-            match_found = 1;
-            result_address = start_address;
-            strcpy(result_filename, map_filename);
-        }
-        if (strncmp(filename, "libpython", 9) == 0) {
-            match_found = 1;
-            result_address = start_address;
-            strcpy(result_filename, map_filename);
-            break;
-        }
-    }
-
-    fclose(maps_file);
-
-    if (!match_found) {
-        map_filename[0] = '\0';
-    }
-
-    return result_address;
-}
 #endif
 
 ssize_t
@@ -363,7 +366,7 @@ read_memory(pid_t pid, void* remote_address, ssize_t size, void* local_address)
         return -1;
     }
     total_bytes_read = size;
-#else 
+#else
     return -1;
 #endif
     return total_bytes_read;
@@ -391,8 +394,8 @@ read_string(pid_t pid, _Py_DebugOffsets *debug_offsets, void* address, char* buf
 
 static PyObject*
 get_stack_trace(PyObject* self, PyObject* args) {
-#ifndef HAVE_PROCESS_VM_READV
-    PyErr_SetString(PyExc_RuntimeError, "process_vm_readv not available on this platform");
+#if (!defined(__linux__) && !defined(__APPLE__)) || (defined(__linux__) && !HAVE_PROCESS_VM_READV)
+    PyErr_SetString(PyExc_RuntimeError, "get_strac_trace is not supported on this platform");
     return NULL;
 #endif
     int pid;
@@ -403,7 +406,9 @@ get_stack_trace(PyObject* self, PyObject* args) {
 
     void* runtime_start_address = get_py_runtime(pid);
     if (runtime_start_address == NULL) {
-        PyErr_SetString(PyExc_RuntimeError, "Failed to get .PyRuntime address");
+        if(!PyErr_Occurred()) {
+            PyErr_SetString(PyExc_RuntimeError, "Failed to get .PyRuntime address");
+        }
         return NULL;
     }
 
