From 6175735da4811401116b1e86405b4be5bd9d39ae Mon Sep 17 00:00:00 2001 From: Chris Lattner Date: Fri, 27 Feb 2004 06:28:34 +0000 Subject: [PATCH] Initial checkin of document, contributed by Reid Spencer. git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@11901 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/ObjectFiles.html | 292 +++++++++++++++++++++++++++++++++++++++ docs/UsingLibraries.html | 292 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 584 insertions(+) create mode 100644 docs/ObjectFiles.html create mode 100644 docs/UsingLibraries.html diff --git a/docs/ObjectFiles.html b/docs/ObjectFiles.html new file mode 100644 index 00000000000..d6ce8fa4ccc --- /dev/null +++ b/docs/ObjectFiles.html @@ -0,0 +1,292 @@ + + + + Object Files: Understanding The Result Of LLVM Compilation + + + +
Object Files: Understanding The Result Of LLVM Compilation
+
+
    +
  1. Abstract
    2. +
  2. Introduction
    3. +
  3. File Contents
    4. +
  4. Linkage Rules Of Thumb +
      +
    1. Always Link vmcore.o, support.a +
    2. Placeholder +
    +
    5. +
+
+

Written by Reid Spencer

+

+
+
+ +
Abstract
+
+

This document describes the contents of the many objects files and libraries +that are produced by compiling LLVM. To make use of LLVM this information is +needed in order to understand what files should be linked into your program. +

+
+ +
Introduction
+
+

If you're writing a compiler, virtual machine, or any other utility for + LLVM, you'll need to figure out which of the many .a (archive) and .o + (object) files you will need to link with to be successful. An + understanding of the contents of these files and their inter-relationships + will be useful in coming up with an optimal specification for the objects + and libraries to link with. +

+

The purpose of this document is to hopefully reduce some of the trial and + error that the author experienced in using LLVM. +

+
+ +
File Contents
+
+

The table below provides a summary of the basic contents of each file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary Of LLVM Library And Object Files +

Library

Description

libipo.a + An archive of all inter-procedural optimizations. +
libscalaropts.a + An archive of all scalar optimizations. +
libtransforms.a + An archive of all code transformations. +
libtarget.a + An archive containing target (machine) specific code. +
libanalysis.a + An archive containing analysis code. +
libdatastructure.a + An archive containing optimizations for data structures. +
libinstrument.aNo idea.
libregalloc.aRegister Allocation code.
libipa.aInter-procedural ??
libtransformutils.a + Utiltities for transformations? +
libsupport.aGeneral support utilities

Object File

Description

support.oGeneral support utilities
asmparser.oAssembler Parser
bcreader.oByte Code Reader
bcwriter.oByte Code Writer
sched.oScheduler? For What?
selectiondag.oSelection Directed Acyclic Graph?
transformutils.oUtilities for code transformations
ipa.oInter-Procedural Analysis Optimizations
select.oSelect Statement?
cwriter.o"C" Code Writer
profpaths.oProfile Paths?
regalloc.oRegister Allocation
instrument.oInstrumentation? Of What?
datastructure.oData Structure Analysis
codegen.oNative code generation
livevar.oLive Variable Analysis
vmcore.oVirtual Machine Core
lli-interpreter.oInterpreter for LLVM ByteCode
lli-jit.o + Just-In-Time Compiler For LLVM ByteCode +
executionengine.oEngine for LLI
debugger.oSource Level Debugging Support
analysis.oGeneral Framework For Analysis?
sparc.oSun SPARC Processor Specific
target.oTarget Machine Support?
transforms.oCode Transformations
x86.oIntel x86 Processor Specific
powerpc.oPowerPC Processor Specific
scalaropts.oOptimizations For Scalars
ipo.oInter-Procedural Optimization
trace.oSupport For Tracing/Debugging?
profile_rt.oRuntime Library For Profiler
sample.oSample Program ?
stkr_compiler.oStacker Language Compiler Library
stkr_runtime.oStacker Language Runtime Library
+
+

+ +
Linkage Rules Of Thumb
+
+

This section contains various "rules of thumb" about what files you + should link into your programs.

+
+ +
Always Link vmcore.o support.a +
+
+

No matter what you do with LLVM, you'll always need to link with vmcore.o + and support.a.

+
+ +
Placeholder
+
+

Need more rules of thumb here.

+
+ +
+
+
Reid Spencer
+The LLVM Compiler Infrastructure +
Last modified: $Date$
+ + + diff --git a/docs/UsingLibraries.html b/docs/UsingLibraries.html new file mode 100644 index 00000000000..d6ce8fa4ccc --- /dev/null +++ b/docs/UsingLibraries.html @@ -0,0 +1,292 @@ + + + + Object Files: Understanding The Result Of LLVM Compilation + + + +
Object Files: Understanding The Result Of LLVM Compilation
+
+
    +
  1. Abstract
    2. +
  2. Introduction
    3. +
  3. File Contents
    4. +
  4. Linkage Rules Of Thumb +
      +
    1. Always Link vmcore.o, support.a +
    2. Placeholder +
    +
    5. +
+
+

Written by Reid Spencer

+

+
+
+ +
Abstract
+
+

This document describes the contents of the many objects files and libraries +that are produced by compiling LLVM. To make use of LLVM this information is +needed in order to understand what files should be linked into your program. +

+
+ +
Introduction
+
+

If you're writing a compiler, virtual machine, or any other utility for + LLVM, you'll need to figure out which of the many .a (archive) and .o + (object) files you will need to link with to be successful. An + understanding of the contents of these files and their inter-relationships + will be useful in coming up with an optimal specification for the objects + and libraries to link with. +

+

The purpose of this document is to hopefully reduce some of the trial and + error that the author experienced in using LLVM. +

+
+ +
File Contents
+
+

The table below provides a summary of the basic contents of each file.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Summary Of LLVM Library And Object Files +

Library

Description

libipo.a + An archive of all inter-procedural optimizations. +
libscalaropts.a + An archive of all scalar optimizations. +
libtransforms.a + An archive of all code transformations. +
libtarget.a + An archive containing target (machine) specific code. +
libanalysis.a + An archive containing analysis code. +
libdatastructure.a + An archive containing optimizations for data structures. +
libinstrument.aNo idea.
libregalloc.aRegister Allocation code.
libipa.aInter-procedural ??
libtransformutils.a + Utiltities for transformations? +
libsupport.aGeneral support utilities

Object File

Description

support.oGeneral support utilities
asmparser.oAssembler Parser
bcreader.oByte Code Reader
bcwriter.oByte Code Writer
sched.oScheduler? For What?
selectiondag.oSelection Directed Acyclic Graph?
transformutils.oUtilities for code transformations
ipa.oInter-Procedural Analysis Optimizations
select.oSelect Statement?
cwriter.o"C" Code Writer
profpaths.oProfile Paths?
regalloc.oRegister Allocation
instrument.oInstrumentation? Of What?
datastructure.oData Structure Analysis
codegen.oNative code generation
livevar.oLive Variable Analysis
vmcore.oVirtual Machine Core
lli-interpreter.oInterpreter for LLVM ByteCode
lli-jit.o + Just-In-Time Compiler For LLVM ByteCode +
executionengine.oEngine for LLI
debugger.oSource Level Debugging Support
analysis.oGeneral Framework For Analysis?
sparc.oSun SPARC Processor Specific
target.oTarget Machine Support?
transforms.oCode Transformations
x86.oIntel x86 Processor Specific
powerpc.oPowerPC Processor Specific
scalaropts.oOptimizations For Scalars
ipo.oInter-Procedural Optimization
trace.oSupport For Tracing/Debugging?
profile_rt.oRuntime Library For Profiler
sample.oSample Program ?
stkr_compiler.oStacker Language Compiler Library
stkr_runtime.oStacker Language Runtime Library
+
+

+ +
Linkage Rules Of Thumb
+
+

This section contains various "rules of thumb" about what files you + should link into your programs.

+
+ +
Always Link vmcore.o support.a +
+
+

No matter what you do with LLVM, you'll always need to link with vmcore.o + and support.a.

+
+ +
Placeholder
+
+

Need more rules of thumb here.

+
+ +
+
+
Reid Spencer
+The LLVM Compiler Infrastructure +
Last modified: $Date$
+ + + -- 2.34.1