Add dataflowAPI/src/liveness.C

dyninst · Apr 3, 2024 · 9eda5ee · 9eda5ee
1 parent 82ff982
commit 9eda5ee
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 21 deletions.
diff --git a/dataflowAPI/src/liveness.C b/dataflowAPI/src/liveness.C
@@ -53,8 +53,6 @@ using namespace Dyninst;
 using namespace Dyninst::ParseAPI;
 using namespace Dyninst::InstructionAPI;
 
-// Code for register liveness detection
-
 LivenessAnalyzer::LivenessAnalyzer(int w): errorno((ErrorType)-1) {
     width = w;
     abi = ABI::getABI(width);
@@ -185,8 +183,6 @@ void LivenessAnalyzer::summarizeBlockLivenessInfo(Function* func, Block *block,
    return;
 }
 
-/* This is used to do fixed point iteration until 
-   the in and out don't change anymore */
 bool LivenessAnalyzer::updateBlockLivenessInfo(Block* block, bitArray &allRegsDefined) 
 {
   bool change = false;
@@ -219,8 +215,6 @@ bool LivenessAnalyzer::updateBlockLivenessInfo(Block* block, bitArray &allRegsDe
   return change;
 }
 
-// Calculate basic block summaries of liveness information
-
 void LivenessAnalyzer::analyze(Function *func) {
     if (liveFuncCalculated.find(func) != liveFuncCalculated.end()) return;
     liveness_printf("Caculate basic block level liveness information for function %s (%lx)\n", func->name().c_str(), func->addr());

diff --git a/docs/dataflowAPI/developer/API.rst b/docs/dataflowAPI/developer/API.rst
@@ -11,6 +11,7 @@ Documentation for the internal classes of the DataflowAPI toolkit.
 
   debug_dataflow.h
   ExpressionConversionVisitor.h
+  liveness.h
   RegisterMap.h
   RoseInsnFactory.h
   stackanalysis.h

diff --git a/docs/dataflowAPI/developer/liveness.h.rst b/docs/dataflowAPI/developer/liveness.h.rst
@@ -0,0 +1,32 @@
+.. _`sec-dev:liveness.h`:
+
+liveness.h
+##########
+
+.. cpp:namespace:: dev
+
+
+.. cpp:class:: LivenessAnalyzer
+
+  .. cpp:member:: private std::map<ParseAPI::Block*, livenessData> blockLiveInfo
+  .. cpp:member:: private std::map<ParseAPI::Function*, bool> liveFuncCalculated
+  .. cpp:member:: private std::map<ParseAPI::Function*, bitArray> funcRegsDefined
+  .. cpp:member:: private InstructionCache cachedLivenessInfo
+  .. cpp:function:: private const bitArray& getLivenessIn(ParseAPI::Block *block)
+  .. cpp:function:: private const bitArray& getLivenessOut(ParseAPI::Block *block, bitArray &allRegsDefined)
+  .. cpp:function:: private void processEdgeLiveness(ParseAPI::Edge* e, livenessData& data, ParseAPI::Block* block, const bitArray& allRegsDefined)
+  .. cpp:function:: private void summarizeBlockLivenessInfo(ParseAPI::Function* func, ParseAPI::Block *block, bitArray &allRegsDefined)
+  .. cpp:function:: private bool updateBlockLivenessInfo(ParseAPI::Block *block, bitArray &allRegsDefined)
+
+      This is used to do fixed point iteration until the in and out don't change anymore.
+
+  .. cpp:function:: private ReadWriteInfo calcRWSets(Instruction curInsn, ParseAPI::Block *blk, Address a)
+  .. cpp:function:: private void* getPtrToInstruction(ParseAPI::Block *block, Address addr) const
+  .. cpp:function:: private bool isExitBlock(ParseAPI::Block *block)
+  .. cpp:function:: private bool isMMX(MachRegister machReg)
+  .. cpp:function:: private MachRegister changeIfMMX(MachRegister machReg)
+  .. cpp:member:: private int width
+  .. cpp:member:: private ABI* abi
+
+  .. cpp:member:: private ErrorType errorno
+
diff --git a/docs/dataflowAPI/public/liveness.h.rst b/docs/dataflowAPI/public/liveness.h.rst
@@ -18,28 +18,20 @@ liveness.h
 
      Creates an analyzer with an assumed address width ``w``.
 
-  .. cpp:enum:: Type
-
-    .. cpp:enumerator:: Before
-
-       Analyze liveness for registers before the current location.
-
-    .. cpp:enumerator:: After
-
-       Analyze liveness for registers after the current location.
-
-  .. cpp:function:: void analyze(ParseAPI::Function *func)
+  .. cpp:function:: void analyze(Dyninst::ParseAPI::Function *func)
 
      Calculate basic block summaries of liveness information for all basic blocks in ``func``.
 
-  .. cpp:function:: bool query(ParseAPI::Location loc, Type type, const MachRegister &machReg, bool& live)
+  .. cpp:function:: template <class OutputIterator> bool query(Dyninst::ParseAPI::Location loc, Type type, OutputIterator outIter)
+
+  .. cpp:function:: bool query(Dyninst::ParseAPI::Location loc, Type type, const Dyninst::MachRegister &machReg, bool& live)
 
      Calculates liveness for the register ``machReg`` at ``loc`` in the direction ``type`` and stores
      the result in ``live``.
 
      Returns ``false`` if no result could be found.
 
-  .. cpp:function:: bool query(ParseAPI::Location loc, Type type, bitArray &bitarray)
+  .. cpp:function:: bool query(Dyninst::ParseAPI::Location loc, Type type, bitArray &bitarray)
 
      Calculates liveness for all registers represented by ``bitarray`` starting at ``loc`` in the direction ``type``.
 
@@ -50,18 +42,37 @@ liveness.h
 
      Returns ``false`` if ``loc`` is not valid.
 
-  .. cpp:function:: void clean(ParseAPI::Function *func)
+  .. cpp:function:: ErrorType getLastError()
+
+  .. cpp:function:: void clean(Dyninst::ParseAPI::Function *func)
 
      Resets cached liveness information associated with ``func``.
 
   .. cpp:function:: void clean()
 
      Resets all cached liveness information.
 
-  .. cpp:function:: int getIndex(MachRegister machReg)
+  .. cpp:function:: int getIndex(Dyninst::MachRegister machReg)
 
      Returns the cache index of the register ``machReg``.
 
   .. cpp:function:: Dyninst::ABI* getABI()
 
      Returns the :cpp:class:`Dyninst::ABI` associated with the current platform.
+
+
+.. cpp:enum:: LivenessAnalyzer::Type
+
+  .. cpp:enumerator:: Before
+
+     Analyze liveness for registers before the current location.
+
+  .. cpp:enumerator:: After
+
+     Analyze liveness for registers after the current location.
+
+
+.. cpp:enum:: LivenessAnalyzer::ErrorType
+
+  .. cpp:enumerator:: Invalid_Location
+