[swift-inspect] minor cleanup

Author: andrurogerz

tools/swift-inspect/Sources/AndroidCLib/heap.c

@@ -111,4 +111,4 @@ bool heap_iterate_metadata_process(
   }
 
   return true;
-}
+}

tools/swift-inspect/Sources/SwiftInspectLinux/SystemHeaders/ptrace.h

@@ -18,7 +18,7 @@
 #include <linux/ptrace.h>
 
 static inline
-int ptrace_wrapper(int op, pid_t pid, void *addr, void *data) {
+int ptrace_retry(int op, pid_t pid, void *addr, void *data) {
   int retries = 3;
   int result;
   do {
@@ -29,35 +29,35 @@ int ptrace_wrapper(int op, pid_t pid, void *addr, void *data) {
 
 static inline
 int ptrace_attach(pid_t pid) {
-  return ptrace_wrapper(PTRACE_ATTACH, pid, 0, 0);
+  return ptrace_retry(PTRACE_ATTACH, pid, 0, 0);
 }
 
 static inline
 int ptrace_detach(pid_t pid) {
-  return ptrace_wrapper(PTRACE_DETACH, pid, 0, 0);
+  return ptrace_retry(PTRACE_DETACH, pid, 0, 0);
 }
 
 static inline
 int ptrace_continue(pid_t pid) {
-  return ptrace_wrapper(PTRACE_CONT, pid, 0, 0);
+  return ptrace_retry(PTRACE_CONT, pid, 0, 0);
 }
 
 static inline
 int ptrace_getsiginfo(pid_t pid, siginfo_t *siginfo) {
-  return ptrace_wrapper(PTRACE_GETSIGINFO, pid, 0, siginfo);
+  return ptrace_retry(PTRACE_GETSIGINFO, pid, 0, siginfo);
 }
 
 static inline
 int ptrace_pokedata(pid_t pid, unsigned long addr, unsigned long value) {
-  return ptrace_wrapper(PTRACE_POKEDATA, pid, (void*)(uintptr_t)addr, (void*)(uintptr_t)value);
+  return ptrace_retry(PTRACE_POKEDATA, pid, (void*)(uintptr_t)addr, (void*)(uintptr_t)value);
 }
 
 static inline
 int ptrace_getregset(pid_t pid, int type, struct iovec *regs) {
-  return ptrace_wrapper(PTRACE_GETREGSET, pid, (void*)(uintptr_t)type, regs);
+  return ptrace_retry(PTRACE_GETREGSET, pid, (void*)(uintptr_t)type, regs);
 }
 
 static inline
 int ptrace_setregset(pid_t pid, int type, struct iovec *regs) {
-  return ptrace_wrapper(PTRACE_SETREGSET, pid, (void*)(uintptr_t)type, regs);
+  return ptrace_retry(PTRACE_SETREGSET, pid, (void*)(uintptr_t)type, regs);
 }

tools/swift-inspect/Sources/SwiftInspectLinux/SystemHeaders/wait.h

@@ -13,18 +13,22 @@
 #include <stdbool.h>
 #include <sys/wait.h>
 
-static inline bool wIfStopped(int status) {
+static inline
+bool wIfStopped(int status) {
   return WIFSTOPPED(status) != 0;
 }
 
-static inline bool wIfExited(int status) {
+static inline
+bool wIfExited(int status) {
   return WIFEXITED(status) != 0;
 }
 
-static inline bool wIfSignaled(int status) {
+static inline
+bool wIfSignaled(int status) {
   return WIFSIGNALED(status) != 0;
 }
 
-static inline int wStopSig(int status) {
+static inline
+int wStopSig(int status) {
   return WSTOPSIG(status);
 }

tools/swift-inspect/Sources/swift-inspect/AndroidRemoteProcess.swift

@@ -50,6 +50,8 @@ internal final class AndroidRemoteProcess: LinuxRemoteProcess {
   }
 
   override internal func iterateHeap(_ body: (swift_addr_t, UInt64) -> Void) {
+    var regionCount = 0
+    var allocCount = 0
     for entry in self.memoryMap.entries {
       // Limiting malloc_iterate calls to only memory regions that are known
       // to contain heap allocations is not strictly necessary but it does
@@ -61,14 +63,27 @@ internal final class AndroidRemoteProcess: LinuxRemoteProcess {
       do {
         allocations = try self.iterateHeapRegion(
           startAddr: entry.startAddr, endAddr: entry.endAddr)
+        regionCount += 1
       } catch {
         print("failed iterating remote heap: \(error)")
         return
       }
 
+      allocCount += allocations.count
+
       // process all of the collected allocations
       for alloc in allocations { body(alloc.base, alloc.len) }
     }
+
+    if allocCount == 0 {
+      // This condition most likely indicates the MemoryMap.Entry.isHeapRegion
+      // filtering is needs to be modified to support a new heap region naming
+      // convention in a newer Android version.
+      print("WARNING: no heap regions found")
+      print("swift-inspect may need to be updated for a newer Android version")
+    } else if allocCount == 0 {
+      print("WARNING: no heap items enumerated")
+    }
   }
 
   // Linux and Android have no supported method to enumerate allocations in the
@@ -103,7 +118,6 @@ internal final class AndroidRemoteProcess: LinuxRemoteProcess {
 
     // Allocate a page-sized buffer in the remote process that malloc_iterate
     // will populaate with metadata describing each heap entry it enumerates.
-    //let dataLen = 32
     let dataLen = sysconf(Int32(_SC_PAGESIZE))
     var mmapArgs = [0, UInt64(dataLen), UInt64(PROT_READ | PROT_WRITE), UInt64(MAP_ANON | MAP_PRIVATE)]
     let remoteDataAddr: UInt64 = try self.ptrace.callRemoteFunction(at: mmapAddr, with: mmapArgs)