[llvm-commits] CVS: reopt/lib/README

[Brian Gaeke]

Changes in directory reopt/lib:

README updated: 1.6 -> 1.7

---
Log message:

Merge in PublicMappingInfoFunctions.txt.
Update description of ScratchMemory.
Misc. updates.


---
Diffs of the changes:  (+19 -3)

Index: reopt/lib/README
diff -u reopt/lib/README:1.6 reopt/lib/README:1.7
--- reopt/lib/README:1.6	Mon Jan  5 12:50:48 2004
+++ reopt/lib/README	Fri Apr  9 13:21:51 2004
@@ -25,11 +25,27 @@
  - Functions to query the mapping between LLVM Instructions and MachineInstrs
    which can be generated by opt and output as part of the SPARC
    assembly by LLC. 
+ - Here is a list of the exported functions and the users of each function:
+   - unsigned getLLVMFunctionPositionInfo (Function *F) 
+     - Used by LightWtProfiling/UnpackTraceFunction only
+   - std::vector<unsigned> getLLVMInstrPositionInfo (Instruction *LI)
+     - Used by Trigger/TriggerAuxiliary and BinInterface/LLVMTrace 
+   - std::pair<uint64_t, uint64_t> getBasicBlockInfo(BasicBlock *BB)
+     - Used by BinInterface/LLVMTrace, LightWtProfiling/SLI,
+       LightWtProfiling/UnpackTraceFunction, Trigger/Trigger, and
+       Trigger/TriggerAuxillary
+   - bool getReverseBBMap(uint64_t addr, Module *M, BasicBlock* &bb)
+     - Used by LightWtProfiling/SLI, and LightWtProfiling/SecondTrigger
+   - bool isInlinable (Function *F) 
+     - Used by LightWtProfiling/SLI, and LightWtProfiling/SecondTrigger
+   - Function *getRevFunction(Module *M, uint64_t addr)
+     - Used by LightWtProfiling/SLI, and LightWtProfiling/SecondTrigger
 
 LightWtProfiling
- - Anand's redesigned reoptimizer. Uses first-level and second-level
+ - Anand's redesigned tracing framework. Uses first-level and second-level
    instrumentation.
  - This used to be in LightWtProfiling/Trigger.
+ - Also contains Brian's trace optimizer.
  - Portability notes:
    SecondTrigger
    - Depends on libcpc.h from Solaris - port to use PAPI.
@@ -44,8 +60,8 @@
  - Used by: Trigger, LightWtProfiling, Inst/lib, BinInterface
 
 ScratchMemory
- - Contains two files with functions that have large blocks of for
-   loops. These for loops are overwritten by code which is written into
+ - Contains two functions containing nothing but empty text-segment space.
+   These functions are overwritten by code which is written into
    the trace cache.
  - Used by: LightWtProfiling, TraceCache/MemoryManager.cpp