Add macOS support (#259)

* Initial macOS commit * Starting updates to process functions * Initial work on CPU monitoring * Cleanup ifdef * Add thread and file count as well as initial brew formula * Update build to add make brew target * fix: copy procdump.rb to bin * Updates * Integration tests * reduce initial size of memory map * cross compilation fixes * Use zip * Cleanup * Add Mac build * Remove formula * Remove dep on stress-ng * Add diag * Add diag * Add diag * Add diag --------- Co-authored-by: Mario Hewardt <marioh@Marios-MacBook-Pro-2.local>
microsoft · Nov 11, 2024 · 88d8dd3 · 88d8dd3
1 parent 1b1edc0
commit 88d8dd3
Show file tree

Hide file tree

Showing 28 changed files with 838 additions and 275 deletions.
diff --git a/BUILD.md b/BUILD.md
@@ -27,7 +27,7 @@ make
 ### Ubuntu
 ```
 sudo apt update
-sudo apt -y install gcc cmake make clang clang-12 gdb zlib-devel libelf-dev build-essential libbpf-dev linux-tools-common linux-tools-$(uname -r)
+sudo apt -y install gcc cmake make clang clang-12 gdb zlib1g-dev libelf-dev build-essential libbpf-dev linux-tools-common linux-tools-$(uname -r)
 ```
 
 ### Rocky Linux

diff --git a/CMakeLists.txt b/CMakeLists.txt
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -66,4 +66,20 @@ stages:
         inputs:
           PathtoPublish: '$(Build.ArtifactStagingDirectory)/logs/procdumpprofiler.log'
           ArtifactName: 'procdumpprofiler.log'
-          publishLocation: 'Container'
+          publishLocation: 'Container'
+
+    - job: "ProcDump_Build_Mac_Run_Unit_Tests"
+      pool:
+        vmImage: "macOS-latest"
+      steps:
+
+      - script: |
+          sw_vers
+        displayName: 'Diagnostics'
+
+      - template: templates/build.yaml
+
+      - script: |
+          cd procdump_build/tests/integration
+          sudo ./run.sh
+        displayName: 'Run unit tests'
diff --git a/include/CoreDumpWriter.h b/include/CoreDumpWriter.h
@@ -19,7 +19,10 @@
 #include <sys/socket.h>
 #include <sys/un.h>
 #include <stdint.h>
+#ifdef __linux__
 #include <linux/limits.h>
+#elif __APPLE_
+#endif
 
 #define DATE_LENGTH 26
 #define MAX_LINES 15

diff --git a/include/GenHelpers.h b/include/GenHelpers.h
@@ -10,7 +10,12 @@
 #ifndef GENHELPERS_H
 #define GENHELPERS_H
 
+#ifdef __linux__
 #include <linux/version.h>
+#elif __APPLE_
+#endif
+
+#include <pthread.h>
 #include <unistd.h>
 #include <string.h>
 #include <stdbool.h>
@@ -96,7 +101,9 @@ static inline void cancel_pthread(unsigned long* val)
 {
     if(*val!=-1)
     {
+        #ifdef __linux__
         pthread_cancel(*val);
+        #endif
     }
 }
 

diff --git a/include/Handle.h b/include/Handle.h
@@ -47,7 +47,7 @@ enum EHandleType {
 struct Handle {
     union {
         struct Event event;
-        sem_t semaphore;
+        sem_t* semaphore;
     };
     enum EHandleType type;
 };

diff --git a/include/ProcDumpConfiguration.h b/include/ProcDumpConfiguration.h
@@ -11,7 +11,9 @@
 #define PROCDUMPCONFIGURATION_H
 
 #include <stdbool.h>
+#ifdef __linux__
 #include <sys/sysinfo.h>
+#endif
 #include <zconf.h>
 #include <stdio.h>
 #include <stdlib.h>
@@ -32,8 +34,10 @@
 #include <fcntl.h>
 #include <signal.h>
 
+#ifdef __linux__
 #include "Restrack.h"
 #include "procdump_ebpf_common.h"
+#endif
 
 #include <unordered_map>
 
@@ -75,7 +79,9 @@ struct ProcDumpConfiguration
     bool bProcessGroup;         // -pgid
 
     char *ProcessName;
+#ifdef __linux__    
     struct sysinfo SystemInfo;
+#endif
 
     // Runtime Values
     int NumberOfDumpsCollecting; // Number of dumps we're collecting
@@ -131,8 +137,10 @@ struct ProcDumpConfiguration
     // Keeps track of the memory allocations when -restrack is specified.
     // Access must be protected by memAllocMapMutex.
     //
+#ifdef __linux__
     std::unordered_map<uintptr_t, ResourceInformation*> memAllocMap;
     pthread_mutex_t memAllocMapMutex;
+#endif
 
     // multithreading
     // set max number of concurrent dumps on init (default to 1)

diff --git a/include/Process.h b/include/Process.h
@@ -10,7 +10,10 @@
 #ifndef PROCFSLIB_PROCESS_H
 #define PROCFSLIB_PROCESS_H
 
+#ifdef __linux__
 #include <linux/version.h>
+#endif
+
 #include <unistd.h>
 #include <string.h>
 #include <stdbool.h>
@@ -291,5 +294,7 @@ bool LookupProcessByName(const char* procName);
 pid_t LookupProcessPidByName(const char* name);
 int GetMaximumPID();
 int FilterForPid(const struct dirent *entry);
+int GetCpuUsage(pid_t pid);
+int GetRunningPids(pid_t** pids);
 
 #endif // PROCFSLIB_PROCESS_H
diff --git a/makePackages.sh b/makePackages.sh
@@ -39,6 +39,7 @@ PACKAGE_TYPE=$6
 
 DEB_PACKAGE_NAME="${PACKAGE_NAME}_${PACKAGE_VER}_amd64"
 RPM_PACKAGE_NAME="${PACKAGE_NAME}-${PACKAGE_VER}-${PACKAGE_REL}"
+BREW_PACKAGE_NAME="${PACKAGE_NAME}-mac-${PACKAGE_VER}"
 
 if [ "$PACKAGE_TYPE" = "deb" ]; then
     DPKGDEB=`which dpkg-deb`
@@ -97,4 +98,9 @@ if [ "$PACKAGE_TYPE" = "rpm" ]; then
     fi
 fi
 
-exit $RET
+if [ "$PACKAGE_TYPE" = "brew" ]; then
+
+    # create brew package
+    zip $PROJECT_BINARY_DIR/${BREW_PACKAGE_NAME}.zip procdump procdump.1.gz
+fi
+exit $RET
diff --git a/procdump.1 b/procdump.1
@@ -50,4 +50,4 @@ Options:
    -pgid   Process ID specified refers to a process group ID.
 
 .SH DESCRIPTION
-procdump is a Linux reimagining of the class ProcDump tool from the Sysinternals suite of tools for Windows. Procdump provides a convenient way for Linux developers to create core dumps of their application based on performance triggers.
+ProcDump provides a convenient way for Linux and Mac developers to create core dumps of their application based on performance triggers. ProcDump is part of Sysinternals.
diff --git a/procdump_mac.1 b/procdump_mac.1
@@ -0,0 +1,34 @@
+.\" Manpage for procdump.
+.TH man 8 "2/5/2024" "1.0" "procdump manpage"
+.SH NAME
+procdump \- generate coredumps based off performance triggers.
+.SH SYNOPSIS
+procdump [-n Count]
+         [-s Seconds]
+         [-c|-cl CPU_Usage]
+         [-m|-ml Commit_Usage1[,Commit_Usage2...]]
+         [-tc Thread_Threshold]
+         [-fc FileDescriptor_Threshold]
+         [-pf Polling_Frequency]
+         [-o]
+         [-log syslog|stdout]
+         {
+           {{[-w] Process_Name} [Dump_File | Dump_Folder]}
+         }
+
+Options:
+   -n      Number of dumps to write before exiting.
+   -s      Consecutive seconds before dump is written (default is 10).
+   -c      CPU threshold above which to create a dump of the process.
+   -cl     CPU threshold below which to create a dump of the process.
+   -m      Memory commit threshold(s) (MB) above which to create dumps.
+   -ml     Memory commit threshold(s) (MB) below which to create dumps.
+   -tc     Thread count threshold above which to create a dump of the process.
+   -fc     File descriptor count threshold above which to create a dump of the process.
+   -pf     Polling frequency.
+   -o      Overwrite existing dump file.
+   -log    Writes extended ProcDump tracing to the specified output stream (syslog or stdout).
+   -w      Wait for the specified process to launch if it's not running.
+
+.SH DESCRIPTION
+ProcDump provides a convenient way for Linux and Mac developers to create core dumps of their application based on performance triggers. ProcDump is part of Sysinternals.
diff --git a/src/CoreDumpWriter.cpp b/src/CoreDumpWriter.cpp
@@ -161,7 +161,9 @@ char* WriteCoreDump(struct CoreDumpWriter *self)
         case WAIT_OBJECT_0+1: // We got a dump slot!
             {
                 char* socketName = NULL;
+#ifdef __linux__                
                 IsCoreClrProcess(self->Config->ProcessId, &socketName);
+#endif                
                 unsigned int currentCoreDumpFilter = -1;
                 if(self->Config->CoreDumpMask != -1)
                 {
@@ -171,7 +173,7 @@ char* WriteCoreDump(struct CoreDumpWriter *self)
                 if ((dumpFileName = WriteCoreDumpInternal(self, socketName)) != NULL)
                 {
                     // We're done here, unlock (increment) the sem
-                    if(sem_post(&self->Config->semAvailableDumpSlots.semaphore) == -1)
+                    if(sem_post(self->Config->semAvailableDumpSlots.semaphore) == -1)
                     {
                         Log(error, INTERNAL_ERROR);
                         Trace("WriteCoreDump: failed sem_post.");
@@ -234,14 +236,6 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
 
     gcorePrefixName = GetCoreDumpPrefixName(self->Config->ProcessId, name, self->Config->CoreDumpPath, self->Config->CoreDumpName, self->Type);
 
-    // assemble the command
-    if(snprintf(command, BUFFER_LENGTH, "gcore -o %s %d 2>&1", gcorePrefixName, pid) < 0)
-    {
-        Log(error, INTERNAL_ERROR);
-        Trace("WriteCoreDumpInternal: failed sprintf gcore command");
-        exit(-1);
-    }
-
     // assemble filename
     if(snprintf(coreDumpFileName, PATH_MAX, "%s.%d", gcorePrefixName, pid) < 0)
     {
@@ -257,6 +251,14 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
         return NULL;
     }
 
+    // assemble the command
+    if(snprintf(command, BUFFER_LENGTH, "gcore -o %s %d 2>&1", coreDumpFileName, pid) < 0)
+    {
+        Log(error, INTERNAL_ERROR);
+        Trace("WriteCoreDumpInternal: failed sprintf gcore command");
+        exit(-1);
+    }
+
     // check if we're allowed to write into the target directory
     if(access(self->Config->CoreDumpPath, W_OK) < 0)
     {
@@ -268,6 +270,7 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
 
     if(socketName!=NULL)
     {
+#ifdef __linux__
         // If we have a socket name, we're dumping a .NET process....
         if(GenerateCoreClrDump(socketName, coreDumpFileName)==false)
         {
@@ -280,6 +283,7 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
 
             self->Config->NumberOfDumpsCollected++; // safe to increment in crit section
         }
+#endif        
     }
     else
     {
@@ -330,12 +334,23 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
 
         // close pipe reading from gcore
         self->Config->gcorePid = NO_PID;                // reset gcore pid so that signal handler knows we aren't dumping
-        int pcloseStatus = pclose(commandPipe);
+        int pcloseStatus = 0;
+#ifdef __linux__        
+        pcloseStatus = pclose(commandPipe);
+#endif
 
         bool gcoreFailedMsg = false;    // in case error sneaks through the message output
 
         // check if gcore was able to generate the dump
-        if(gcoreStatus != 0 || pcloseStatus != 0 || (gcoreFailedMsg = (strstr(outputBuffer[i-1], "gcore: failed") != NULL)))
+        if(outputBuffer[i-1] != NULL)
+        {
+            if(strstr(outputBuffer[i-1], "gcore: failed") != NULL)
+            {
+                gcoreFailedMsg = true;
+            }
+        }
+
+        if(gcoreStatus != 0 || pcloseStatus != 0 || (gcoreFailedMsg == true))
         {
             Log(error, "An error occurred while generating the core dump:");
             if (gcoreStatus != 0)
@@ -358,7 +373,6 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
         {
             // On WSL2 there is a delay between the core dump being written to disk and able to succesfully access it in the below check
             sleep(1);
-
             // validate that core dump file was generated
             if(access(coreDumpFileName, F_OK) != -1)
             {
@@ -395,7 +409,7 @@ char* WriteCoreDumpInternal(struct CoreDumpWriter *self, char* socketName)
 
 
     free(name);
-
+    
     return strdup(coreDumpFileName);
 }
 
diff --git a/src/Events.cpp b/src/Events.cpp
@@ -78,7 +78,7 @@ void InitNamedEvent(struct Event *Event, bool IsManualReset, bool InitialState,
     Event->nWaiters = 0;
 
     if (Name == NULL) {
-        sprintf(Event->Name, "Unnamed Event %d", ++unamedEventId);
+        snprintf(Event->Name, sizeof(Event->Name), "Unnamed Event %d", ++unamedEventId);
     } else if (strlen(Name) >= MAX_EVENT_NAME) {
         strncpy(Event->Name, Name, MAX_EVENT_NAME);
         Event->Name[MAX_EVENT_NAME - 1] = '\0'; // null terminate

diff --git a/src/GenHelpers.cpp b/src/GenHelpers.cpp
@@ -7,7 +7,9 @@
 //
 //--------------------------------------------------------------------
 #include "Includes.h"
+#ifdef __linux__
 #include <syscall.h>
+#endif
 
 //--------------------------------------------------------------------
 //
@@ -499,7 +501,7 @@ char* GetSocketPath(char* prefix, pid_t pid, pid_t targetPid)
                 return NULL;
             }
 
-            sprintf(t, "/tmp/%s%d-%d", prefix, pid, targetPid);
+            snprintf(t, len+1, "/tmp/%s%d-%d", prefix, pid, targetPid);
         }
         else
         {
@@ -510,7 +512,7 @@ char* GetSocketPath(char* prefix, pid_t pid, pid_t targetPid)
                 return NULL;
             }
 
-            sprintf(t, "/tmp/%s%d", prefix, pid);
+            snprintf(t, len+1, "/tmp/%s%d", prefix, pid);
         }
     }
     else
@@ -524,7 +526,7 @@ char* GetSocketPath(char* prefix, pid_t pid, pid_t targetPid)
                 return NULL;
             }
 
-            sprintf(t, "%s/%s%d-%d", prefixTmpFolder, prefix, pid, targetPid);
+            snprintf(t, len+1, "%s/%s%d-%d", prefixTmpFolder, prefix, pid, targetPid);
         }
         else
         {
@@ -535,7 +537,7 @@ char* GetSocketPath(char* prefix, pid_t pid, pid_t targetPid)
                 return NULL;
             }
 
-            sprintf(t, "%s/%s%d", prefixTmpFolder, prefix, pid);
+            snprintf(t, len+1, "%s/%s%d", prefixTmpFolder, prefix, pid);
         }
     }