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

[Brian Gaeke]

Changes in directory reopt/lib:

README updated: 1.7 -> 1.8

---
Log message:

Major update to README, including the new directories which have recently been
added.


---
Diffs of the changes:  (+34 -4)

Index: reopt/lib/README
diff -u reopt/lib/README:1.7 reopt/lib/README:1.8
--- reopt/lib/README:1.7	Fri Apr  9 13:21:51 2004
+++ reopt/lib/README	Thu Jul  8 01:25:19 2004
@@ -2,8 +2,18 @@
 Field guide to Reoptimizer libraries
 ************************************
 
-This directory used to be in the llvm cvs module, at
-llvm/lib/Reoptimizer.
+This is where all of the Reoptimizer libraries live.  As a historical
+note, this directory used to be in the llvm cvs module, at
+llvm/lib/Reoptimizer.  Now it is the lib directory of the reopt cvs
+module.
+
+Warning: Although we've tried to make sure that this project will build
+on all LLVM-supported architectures, many of the libraries in the
+following subdirectories will not link or function correctly on
+non-Sparc architectures.  Also please note that much of this code is
+unmaintained or very lightly maintained, except for the Trace*
+directories, ScratchMemory, LightWtProfiling, and Mapping
+subdirectories.
 
 Inst
  - Joel Stanley's project.
@@ -20,6 +30,7 @@
 
 Trigger
  - Anand's OLD reoptimizer.
+ - Uses the Ball & Larus path profiling implementation (I think?).
 
 Mapping
  - Functions to query the mapping between LLVM Instructions and MachineInstrs
@@ -45,11 +56,13 @@
  - 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.
+ - Also contains the UnpackTraceFunction component of Brian's trace optimizer.
+ - Also contains the ValueAllocState register allocator mapping info extractor.
  - Portability notes:
    SecondTrigger
    - Depends on libcpc.h from Solaris - port to use PAPI.
-   - Unportable pointer size assumptions
+   - Unportable pointer size assumptions (change it to use uintptr_t instead
+     of uint64_t!)
    - Uses SPARC inline assembly.
    FirstTrigger
    - Uses SPARC inline assembly.
@@ -74,3 +87,20 @@
  - Portability notes: Supports SPARC binaries only. Should compile &
    link fine on X86.
 
+TraceIO
+ - Trace reading/writing library.
+ - Requires bcreader, bcwriter libraries.
+ - Test program in tools/dumptrace.
+
+TraceJIT
+ - This is a copy of the target-independent JIT code from
+   llvm/lib/ExecutionEngine/JIT, which has been hacked up by Brian to
+   run passes for the trace optimizer on TraceFunctions (which are
+   output by the TraceToFunction library).
+
+TraceToFunction
+ - Pass written by Brian which turns Trace objects into Functions.
+ - Test program in tools/ttftest.
+
+Last updated $Date: 2004/07/08 06:25:19 $
+