common init

dyninst · Dec 27, 2023 · ab63ee8 · ab63ee8
1 parent 7bded95
commit ab63ee8
Show file tree

Hide file tree

Showing 59 changed files with 1,020 additions and 0 deletions.
diff --git a/docs/common/developer/API.rst b/docs/common/developer/API.rst
@@ -0,0 +1,57 @@
+.. _`sec:common-dev-api`:
+
+common
+######
+
+Classes and features shared among many parts of Dyninst.
+
+.. toctree::
+   :caption: Developer API
+   :name: common-dev-api
+   :hidden:
+   :maxdepth: 1
+
+   addrRange.h
+   addrtranslate.h
+   addrtranslate-sysv.h
+   Annotatable.h
+   arch-aarch64.h
+   arch.h
+   arch-power.h
+   arch-x86.h
+   compiler_annotations.h
+   compiler_diagnostics.h
+   concurrent.h
+   debug_common.h
+   dthread.h
+   dyn_register.h
+   dyn_syscalls.h
+   dyntypes.h
+   freebsdHeaders.h
+   freebsdKludges.h
+   headers.h
+   ia32_locations.h
+   IBSTree-fast.h
+   IBSTree.h
+   IntervalTree.h
+   linuxHeaders.h
+   linuxKludges.h
+   lprintf.h
+   lru_cache.h
+   machineType.h
+   MappedFile.h
+   NodeIterator.h
+   ntHeaders.h
+   parseauxv.h
+   pathName.h
+   pool_allocators.h
+   sha1.h
+   singleton_object_pool.h
+   stats.h
+   symbolDemangle.h
+   symbolDemangleWithCache.h
+   Timer.h
+   unaligned_memory_access.h
+   util.h
+   vgannotations.h
+   vm_maps.h
diff --git a/docs/common/developer/Annotatable.h.rst b/docs/common/developer/Annotatable.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:Annotatable.h`:
+
+Annotatable.h
+#############
+
diff --git a/docs/common/developer/IBSTree-fast.h.rst b/docs/common/developer/IBSTree-fast.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:IBSTree-fast.h`:
+
+IBSTree-fast.h
+##############
+
diff --git a/docs/common/developer/IBSTree.h.rst b/docs/common/developer/IBSTree.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:IBSTree.h`:
+
+IBSTree.h
+#########
+
diff --git a/docs/common/developer/IntervalTree.h.rst b/docs/common/developer/IntervalTree.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:IntervalTree.h`:
+
+IntervalTree.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/MappedFile.h.rst b/docs/common/developer/MappedFile.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:MappedFile.h`:
+
+MappedFile.h
+############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/NodeIterator.h.rst b/docs/common/developer/NodeIterator.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:NodeIterator.h`:
+
+NodeIterator.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/Timer.h.rst b/docs/common/developer/Timer.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:Timer.h`:
+
+Timer.h
+#######
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/addrRange.h.rst b/docs/common/developer/addrRange.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:addrRange.h`:
+
+addrRange.h
+###########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/addrtranslate-sysv.h.rst b/docs/common/developer/addrtranslate-sysv.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:addrtranslate-sysv.h`:
+
+addrtranslate-sysv.h
+####################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/addrtranslate.h.rst b/docs/common/developer/addrtranslate.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:addrtranslate.h`:
+
+addrtranslate.h
+###############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/arch-aarch64.h.rst b/docs/common/developer/arch-aarch64.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:arch-aarch64.h`:
+
+arch-aarch64.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/arch-power.h.rst b/docs/common/developer/arch-power.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:arch-power.h`:
+
+arch-power.h
+############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/arch-x86.h.rst b/docs/common/developer/arch-x86.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:arch-x86.h`:
+
+arch-x86.h
+##########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/arch.h.rst b/docs/common/developer/arch.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:arch.h`:
+
+arch.h
+######
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/compiler_annotations.h.rst b/docs/common/developer/compiler_annotations.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:compiler_annotations.h`:
+
+compiler_annotations.h
+######################
+
diff --git a/docs/common/developer/compiler_diagnostics.h.rst b/docs/common/developer/compiler_diagnostics.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:compiler_diagnostics.h`:
+
+compiler_diagnostics.h
+######################
+
diff --git a/docs/common/developer/concurrent.h.rst b/docs/common/developer/concurrent.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:concurrent.h`:
+
+concurrent.h
+############
+
diff --git a/docs/common/developer/debug_common.h.rst b/docs/common/developer/debug_common.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:debug_common.h`:
+
+debug_common.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/dthread.h.rst b/docs/common/developer/dthread.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:dthread.h`:
+
+dthread.h
+#########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/dyn_register.h.rst b/docs/common/developer/dyn_register.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:dyn_register.h`:
+
+dyn_register.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/dyn_syscalls.h.rst b/docs/common/developer/dyn_syscalls.h.rst
@@ -0,0 +1,5 @@
+.. _`sec:dyn_syscalls.h`:
+
+dyn_syscalls.h
+##############
+
diff --git a/docs/common/developer/dyntypes.h.rst b/docs/common/developer/dyntypes.h.rst
@@ -0,0 +1,43 @@
+.. _`sec:dyntypes.h`:
+
+dyntypes.h
+##########
+
+.. cpp:namespace:: Dyninst
+
+.. cpp:type:: \
+  template <typename Key, \
+        typename Value, \
+        typename Hash = std::hash<Key>, \
+        typename Comp = std::equal_to<Key>, \
+        typename Alloc = std::allocator<std::pair<const Key, Value>>> \
+  dyn_hash_map = std::unordered_map<Key, Value, Hash, Comp, Alloc>
+
+.. cpp:type:: \
+  template <typename Key, \
+        typename Hash = std::hash<Key>, \
+        typename Comp = std::equal_to<Key>, \
+        typename Alloc = std::allocator<Key>> \
+  dyn_hash_set = std::unordered_set<Key, Hash, Comp, Alloc>
+
+Various values used throughout the codebase. These can have different underlying types on non-Unix platforms.
+
+.. c:macro:: NULL_PID
+.. c:macro:: NULL_LWP
+.. c:macro:: NULL_THR_ID
+.. c:macro:: DYNINST_SINGLETHREADED
+.. cpp:type:: unsigned long Address
+.. cpp:type:: unsigned long Offset
+.. cpp:type:: int PID
+.. cpp:type:: int PROC_HANDLE
+.. cpp:type:: int LWP
+.. cpp:type:: long THR_ID
+
+.. cpp:function:: int ThrIDToTid(Dyninst::THR_ID id)
+
+.. cpp:enum:: OSType
+
+  .. cpp:enumerator:: OSType::OSNone
+  .. cpp:enumerator:: OSType::Linux
+  .. cpp:enumerator:: OSType::FreeBSD
+  .. cpp:enumerator:: OSType::Windows
diff --git a/docs/common/developer/freebsdHeaders.h.rst b/docs/common/developer/freebsdHeaders.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:freebsdHeaders.h`:
+
+freebsdHeaders.h
+################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/freebsdKludges.h.rst b/docs/common/developer/freebsdKludges.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:freebsdKludges.h`:
+
+freebsdKludges.h
+################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/headers.h.rst b/docs/common/developer/headers.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:headers.h`:
+
+headers.h
+#########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/ia32_locations.h.rst b/docs/common/developer/ia32_locations.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:ia32_locations.h`:
+
+ia32_locations.h
+################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/linuxHeaders.h.rst b/docs/common/developer/linuxHeaders.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:linuxHeaders.h`:
+
+linuxHeaders.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/linuxKludges.h.rst b/docs/common/developer/linuxKludges.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:linuxKludges.h`:
+
+linuxKludges.h
+##############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/lprintf.h.rst b/docs/common/developer/lprintf.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:lprintf.h`:
+
+lprintf.h
+#########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/lru_cache.h.rst b/docs/common/developer/lru_cache.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:lru_cache.h`:
+
+lru_cache.h
+###########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/machineType.h.rst b/docs/common/developer/machineType.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:machineType.h`:
+
+machineType.h
+#############
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/ntHeaders.h.rst b/docs/common/developer/ntHeaders.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:ntHeaders.h`:
+
+ntHeaders.h
+###########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/parseauxv.h.rst b/docs/common/developer/parseauxv.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:parseauxv.h`:
+
+parseauxv.h
+###########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/pathName.h.rst b/docs/common/developer/pathName.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:pathName.h`:
+
+pathName.h
+##########
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/pool_allocators.h.rst b/docs/common/developer/pool_allocators.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:pool_allocators.h`:
+
+pool_allocators.h
+#################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/sha1.h.rst b/docs/common/developer/sha1.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:sha1.h`:
+
+sha1.h
+######
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/singleton_object_pool.h.rst b/docs/common/developer/singleton_object_pool.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:singleton_object_pool.h`:
+
+singleton_object_pool.h
+#######################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/stats.h.rst b/docs/common/developer/stats.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:stats.h`:
+
+stats.h
+#######
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/symbolDemangle.h.rst b/docs/common/developer/symbolDemangle.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:symbolDemangle.h`:
+
+symbolDemangle.h
+################
+
+.. cpp:namespace:: Dyninst
+
diff --git a/docs/common/developer/symbolDemangleWithCache.h.rst b/docs/common/developer/symbolDemangleWithCache.h.rst
@@ -0,0 +1,7 @@
+.. _`sec:symbolDemangleWithCache.h`:
+
+symbolDemangleWithCache.h
+#########################
+
+.. cpp:namespace:: Dyninst
+