README.md 2.08 KB
Newer Older
Akash Kothari's avatar
Akash Kothari committed
1
# hpvm-config -- Print HPVM compilation options
Akash Kothari's avatar
Akash Kothari committed
2
3
4
5
6
7
8
9
10
11

### Synopsis
hpvm-config option [components…]

### Description
hpvm-config print the compiler flags, linker flags and object libraries needed to link against HPVM.
In addtion to printing flags printed by [llvm-config](http://llvm.org/docs/CommandGuide/llvm-config.html), hpvm-config also prints HPVM version and compiler
flags required to compile HPVM programs.

### Options
Akash Kothari's avatar
Akash Kothari committed
12
–version: Print the version number of HPVM.
Akash Kothari's avatar
Akash Kothari committed
13

Akash Kothari's avatar
Akash Kothari committed
14
-help: Print a summary of llvm-config arguments.
Akash Kothari's avatar
Akash Kothari committed
15

Akash Kothari's avatar
Akash Kothari committed
16
–prefix: Print the installation prefix for LLVM.
Akash Kothari's avatar
Akash Kothari committed
17

Akash Kothari's avatar
Akash Kothari committed
18
–src-root: Print the source root from which LLVM was built.
Akash Kothari's avatar
Akash Kothari committed
19

Akash Kothari's avatar
Akash Kothari committed
20
–obj-root: Print the object root used to build HPVM.
Akash Kothari's avatar
Akash Kothari committed
21

Akash Kothari's avatar
Akash Kothari committed
22
–bindir: Print the installation directory for LLVM binaries.
Akash Kothari's avatar
Akash Kothari committed
23

Akash Kothari's avatar
Akash Kothari committed
24
–includedir: Print the installation directory for LLVM headers.
Akash Kothari's avatar
Akash Kothari committed
25

Akash Kothari's avatar
Akash Kothari committed
26
–libdir: Print the installation directory for LLVM libraries.
Akash Kothari's avatar
Akash Kothari committed
27

Akash Kothari's avatar
Akash Kothari committed
28
–cxxflags: Print the C++ compiler flags needed to use LLVM headers.
Akash Kothari's avatar
Akash Kothari committed
29

Akash Kothari's avatar
Akash Kothari committed
30
–ldflags: Print the flags needed to link against LLVM libraries.
Akash Kothari's avatar
Akash Kothari committed
31

Akash Kothari's avatar
Akash Kothari committed
32
–libs: Print all the libraries needed to link against the specified LLVM components, including any dependencies.
Akash Kothari's avatar
Akash Kothari committed
33

Akash Kothari's avatar
Akash Kothari committed
34
–libnames: Similar to –libs, but prints the bare filenames of the libraries without -l or pathnames. Useful for linking against a not-yet-installed copy of LLVM.
Akash Kothari's avatar
Akash Kothari committed
35

Akash Kothari's avatar
Akash Kothari committed
36
–libfiles: Similar to –libs, but print the full path to each library file. This is useful when creating makefile dependencies, to ensure that a tool is relinked if any library it uses changes.
Akash Kothari's avatar
Akash Kothari committed
37

Akash Kothari's avatar
Akash Kothari committed
38
–components: Print all valid component names.
Akash Kothari's avatar
Akash Kothari committed
39

Akash Kothari's avatar
Akash Kothari committed
40
–targets-built: Print the component names for all targets supported by this copy of LLVM.
Akash Kothari's avatar
Akash Kothari committed
41

Akash Kothari's avatar
Akash Kothari committed
42
43
44
45
46
47
48
49
50
–build-mode: Print the build mode used when LLVM was built (e.g. Debug or Release)

-genHPVM: Generate HPVM textual IR from LLVM IR.

-dfg2llvm-cpu: Generate code for CPU and host.

-dfg2llvm-opencl: Generate kernel code for GPU target in OpenCL.

-clearDFG: Clear dataflow graph for HPVM and extraneous HPVM-specific instructions from IR.
Akash Kothari's avatar
Akash Kothari committed
51
52
53
54
55
56
57
    
### Exit Status
If hpvm-config succeeds, it will exit with 0. Otherwise, if an error occurs, it will exit with a non-zero value.