Add common/MachSyscall.C

dyninst · Apr 3, 2024 · 69acddb · 69acddb
1 parent b5b66ad
commit 69acddb
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 10 deletions.
diff --git a/common/h/MachSyscall.h b/common/h/MachSyscall.h
@@ -42,26 +42,19 @@ class COMMON_EXPORT MachSyscall
 {
     public: 
         typedef unsigned long SyscallIDPlatform;
-        typedef unsigned long SyscallIDIndependent; // e.g., Dyninst::Syscall::dyn_getpid
+        typedef unsigned long SyscallIDIndependent;
         typedef const char * SyscallName;
 
-        // Factory methods
-        // Allows ProcControlAPI to construct a MachSyscall for an event
         friend MachSyscall ProcControlAPI::makeFromEvent(const ProcControlAPI::EventSyscall *);
 
-        // Allows users to construct a MachSyscall
         friend MachSyscall ProcControlAPI::makeFromID(boost::shared_ptr<ProcControlAPI::Process>, SyscallIDIndependent);
 
         static MachSyscall makeFromPlatform(Platform, SyscallIDIndependent);     
 
-        // Accessors
-        // Returns the platform-specific number for this system call
         SyscallIDPlatform num() const;
 
-        // Returns the name for this system call (e.g., "getpid")
         SyscallName name() const;
 
-        // Strict equality-based matching on Platforms and IDs
         bool operator==(const MachSyscall &) const;
 
     private:

diff --git a/common/src/MachSyscall.C b/common/src/MachSyscall.C
@@ -108,7 +108,6 @@ MachSyscall::SyscallIDPlatform SyscallInformation::findIDPlatform(Platform plat,
 /* This file is auto-generated from syscalls/generateSyscallInformation.py */
 #include "SyscallInformation.C"
 
-/* Lookup the system call string name based on platform-specific ID */
 MachSyscall::SyscallName MachSyscall::nameLookup(Platform plat, SyscallIDPlatform id)
 {
     return SyscallInformation::getInstance()->findName(plat, id);

diff --git a/docs/common/developer/API.rst b/docs/common/developer/API.rst
@@ -40,6 +40,7 @@ Classes and features shared among many parts of Dyninst.
    linuxKludges.h
    lprintf.h
    lru_cache.h
+   MachSyscall.h
    MappedFile.h
    NodeIterator.h
    ntHeaders.h

diff --git a/docs/common/developer/MachSyscall.h.rst b/docs/common/developer/MachSyscall.h.rst
@@ -0,0 +1,13 @@
+.. _`sec-dev:MachSyscall.h`:
+
+MachSyscall.h
+#############
+
+.. cpp:namespace:: Dyninst::dev
+
+.. cpp:class:: MachSyscall
+
+  .. cpp:function:: private static SyscallName nameLookup(Platform plat, SyscallIDPlatform id)
+
+    Lookup the system call string name based on platform-specific ID
+
diff --git a/docs/common/public/MachSyscall.h.rst b/docs/common/public/MachSyscall.h.rst
@@ -24,6 +24,12 @@ MachSyscall.h
 
   .. cpp:function:: SyscallIDPlatform num() const
 
-    The platform-specific number for this system call
+    Returns the platform-specific number for this system call
 
   .. cpp:function:: SyscallName name() const
+
+    Returns the name for this system call (e.g., "getpid")
+
+  .. cpp:function:: bool operator==(const MachSyscall &) const
+
+    Strict equality-based matching on Platforms and IDs