1 //===-- llvm-config.cpp - LLVM project configuration utility --------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This tool encapsulates information about an LLVM project configuration for
11 // use by other project's build environments (to determine installed path,
12 // available features, required libraries, etc.).
14 // Note that although this tool *may* be used by some parts of LLVM's build
15 // itself (i.e., the Makefiles use it to compute required libraries when linking
16 // tools), this tool is primarily designed to support external projects.
18 //===----------------------------------------------------------------------===//
20 #include "llvm/ADT/STLExtras.h"
21 #include "llvm/ADT/StringMap.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/ADT/Twine.h"
24 #include "llvm/Config/config.h"
25 #include "llvm/Config/llvm-config.h"
26 #include "llvm/Support/FileSystem.h"
27 #include "llvm/Support/Path.h"
28 #include "llvm/Support/raw_ostream.h"
35 // Include the build time variables we can report to the user. This is generated
36 // at build time from the BuildVariables.inc.in file by the build system.
37 #include "BuildVariables.inc"
39 // Include the component table. This creates an array of struct
40 // AvailableComponent entries, which record the component name, library name,
41 // and required components for all of the available libraries.
43 // Not all components define a library, we also use "library groups" as a way to
44 // create entries for pseudo groups like x86 or all-targets.
45 #include "LibraryDependencies.inc"
47 /// \brief Traverse a single component adding to the topological ordering in
48 /// \arg RequiredLibs.
50 /// \param Name - The component to traverse.
51 /// \param ComponentMap - A prebuilt map of component names to descriptors.
52 /// \param VisitedComponents [in] [out] - The set of already visited components.
53 /// \param RequiredLibs [out] - The ordered list of required libraries.
54 static void VisitComponent(StringRef Name,
55 const StringMap<AvailableComponent*> &ComponentMap,
56 std::set<AvailableComponent*> &VisitedComponents,
57 std::vector<StringRef> &RequiredLibs,
58 bool IncludeNonInstalled) {
59 // Lookup the component.
60 AvailableComponent *AC = ComponentMap.lookup(Name);
61 assert(AC && "Invalid component name!");
63 // Add to the visited table.
64 if (!VisitedComponents.insert(AC).second) {
65 // We are done if the component has already been visited.
69 // Only include non-installed components if requested.
70 if (!AC->IsInstalled && !IncludeNonInstalled)
73 // Otherwise, visit all the dependencies.
74 for (unsigned i = 0; AC->RequiredLibraries[i]; ++i) {
75 VisitComponent(AC->RequiredLibraries[i], ComponentMap, VisitedComponents,
76 RequiredLibs, IncludeNonInstalled);
79 // Add to the required library list.
81 RequiredLibs.push_back(AC->Library);
84 /// \brief Compute the list of required libraries for a given list of
85 /// components, in an order suitable for passing to a linker (that is, libraries
86 /// appear prior to their dependencies).
88 /// \param Components - The names of the components to find libraries for.
89 /// \param RequiredLibs [out] - On return, the ordered list of libraries that
90 /// are required to link the given components.
91 /// \param IncludeNonInstalled - Whether non-installed components should be
93 void ComputeLibsForComponents(const std::vector<StringRef> &Components,
94 std::vector<StringRef> &RequiredLibs,
95 bool IncludeNonInstalled) {
96 std::set<AvailableComponent*> VisitedComponents;
98 // Build a map of component names to information.
99 StringMap<AvailableComponent*> ComponentMap;
100 for (unsigned i = 0; i != array_lengthof(AvailableComponents); ++i) {
101 AvailableComponent *AC = &AvailableComponents[i];
102 ComponentMap[AC->Name] = AC;
105 // Visit the components.
106 for (unsigned i = 0, e = Components.size(); i != e; ++i) {
107 // Users are allowed to provide mixed case component names.
108 std::string ComponentLower = Components[i].lower();
110 // Validate that the user supplied a valid component name.
111 if (!ComponentMap.count(ComponentLower)) {
112 llvm::errs() << "llvm-config: unknown component name: " << Components[i]
117 VisitComponent(ComponentLower, ComponentMap, VisitedComponents,
118 RequiredLibs, IncludeNonInstalled);
121 // The list is now ordered with leafs first, we want the libraries to printed
122 // in the reverse order of dependency.
123 std::reverse(RequiredLibs.begin(), RequiredLibs.end());
130 usage: llvm-config <OPTION>... [<COMPONENT>...]\n\
132 Get various configuration information needed to compile programs which use\n\
133 LLVM. Typically called from 'configure' scripts. Examples:\n\
134 llvm-config --cxxflags\n\
135 llvm-config --ldflags\n\
136 llvm-config --libs engine bcreader scalaropts\n\
139 --version Print LLVM version.\n\
140 --prefix Print the installation prefix.\n\
141 --src-root Print the source root LLVM was built from.\n\
142 --obj-root Print the object root used to build LLVM.\n\
143 --bindir Directory containing LLVM executables.\n\
144 --includedir Directory containing LLVM headers.\n\
145 --libdir Directory containing LLVM libraries.\n\
146 --cppflags C preprocessor flags for files that include LLVM headers.\n\
147 --cflags C compiler flags for files that include LLVM headers.\n\
148 --cxxflags C++ compiler flags for files that include LLVM headers.\n\
149 --ldflags Print Linker flags.\n\
150 --libs Libraries needed to link against LLVM components.\n\
151 --libnames Bare library names for in-tree builds.\n\
152 --libfiles Fully qualified library filenames for makefile depends.\n\
153 --components List of all possible components.\n\
154 --targets-built List of all targets currently built.\n\
155 --host-target Target triple used to configure LLVM.\n\
156 --build-mode Print build mode of LLVM tree (e.g. Debug or Release).\n\
157 --assertion-mode Print assertion mode of LLVM tree (ON or OFF).\n\
158 Typical components:\n\
159 all All LLVM libraries (default).\n\
160 engine Either a native JIT or a bitcode interpreter.\n";
164 /// \brief Compute the path to the main executable.
165 std::string GetExecutablePath(const char *Argv0) {
166 // This just needs to be some symbol in the binary; C++ doesn't
167 // allow taking the address of ::main however.
168 void *P = (void*) (intptr_t) GetExecutablePath;
169 return llvm::sys::fs::getMainExecutable(Argv0, P);
172 int main(int argc, char **argv) {
173 std::vector<StringRef> Components;
174 bool PrintLibs = false, PrintLibNames = false, PrintLibFiles = false;
175 bool HasAnyOption = false;
177 // llvm-config is designed to support being run both from a development tree
178 // and from an installed path. We try and auto-detect which case we are in so
179 // that we can report the correct information when run from a development
181 bool IsInDevelopmentTree;
182 enum { MakefileStyle, CMakeStyle, CMakeBuildModeStyle } DevelopmentTreeLayout;
183 llvm::SmallString<256> CurrentPath(GetExecutablePath(argv[0]));
184 std::string CurrentExecPrefix;
185 std::string ActiveObjRoot;
187 // Create an absolute path, and pop up one directory (we expect to be inside a
189 sys::fs::make_absolute(CurrentPath);
190 CurrentExecPrefix = sys::path::parent_path(
191 sys::path::parent_path(CurrentPath)).str();
193 // Check to see if we are inside a development tree by comparing to possible
194 // locations (prefix style or CMake style).
195 if (sys::fs::equivalent(CurrentExecPrefix,
196 Twine(LLVM_OBJ_ROOT) + "/" + LLVM_BUILDMODE)) {
197 IsInDevelopmentTree = true;
198 DevelopmentTreeLayout = MakefileStyle;
200 // If we are in a development tree, then check if we are in a BuildTools
201 // directory. This indicates we are built for the build triple, but we
202 // always want to provide information for the host triple.
203 if (sys::path::filename(LLVM_OBJ_ROOT) == "BuildTools") {
204 ActiveObjRoot = sys::path::parent_path(LLVM_OBJ_ROOT);
206 ActiveObjRoot = LLVM_OBJ_ROOT;
208 } else if (sys::fs::equivalent(CurrentExecPrefix, LLVM_OBJ_ROOT)) {
209 IsInDevelopmentTree = true;
210 DevelopmentTreeLayout = CMakeStyle;
211 ActiveObjRoot = LLVM_OBJ_ROOT;
212 } else if (sys::fs::equivalent(CurrentExecPrefix,
213 Twine(LLVM_OBJ_ROOT) + "/bin")) {
214 IsInDevelopmentTree = true;
215 DevelopmentTreeLayout = CMakeBuildModeStyle;
216 ActiveObjRoot = LLVM_OBJ_ROOT;
218 IsInDevelopmentTree = false;
219 DevelopmentTreeLayout = MakefileStyle; // Initialized to avoid warnings.
222 // Compute various directory locations based on the derived location
224 std::string ActivePrefix, ActiveBinDir, ActiveIncludeDir, ActiveLibDir;
225 std::string ActiveIncludeOption;
226 if (IsInDevelopmentTree) {
227 ActiveIncludeDir = std::string(LLVM_SRC_ROOT) + "/include";
228 ActivePrefix = CurrentExecPrefix;
230 // CMake organizes the products differently than a normal prefix style
232 switch (DevelopmentTreeLayout) {
234 ActiveBinDir = ActiveObjRoot + "/" + LLVM_BUILDMODE + "/bin";
235 ActiveLibDir = ActiveObjRoot + "/" + LLVM_BUILDMODE + "/lib";
238 ActiveBinDir = ActiveObjRoot + "/bin";
239 ActiveLibDir = ActiveObjRoot + "/lib";
241 case CMakeBuildModeStyle:
242 ActiveBinDir = ActiveObjRoot + "/bin/" + LLVM_BUILDMODE;
243 ActiveLibDir = ActiveObjRoot + "/lib/" + LLVM_BUILDMODE;
247 // We need to include files from both the source and object trees.
248 ActiveIncludeOption = ("-I" + ActiveIncludeDir + " " +
249 "-I" + ActiveObjRoot + "/include");
251 ActivePrefix = CurrentExecPrefix;
252 ActiveIncludeDir = ActivePrefix + "/include";
253 ActiveBinDir = ActivePrefix + "/bin";
254 ActiveLibDir = ActivePrefix + "/lib";
255 ActiveIncludeOption = "-I" + ActiveIncludeDir;
258 raw_ostream &OS = outs();
259 for (int i = 1; i != argc; ++i) {
260 StringRef Arg = argv[i];
262 if (Arg.startswith("-")) {
264 if (Arg == "--version") {
265 OS << PACKAGE_VERSION << '\n';
266 } else if (Arg == "--prefix") {
267 OS << ActivePrefix << '\n';
268 } else if (Arg == "--bindir") {
269 OS << ActiveBinDir << '\n';
270 } else if (Arg == "--includedir") {
271 OS << ActiveIncludeDir << '\n';
272 } else if (Arg == "--libdir") {
273 OS << ActiveLibDir << '\n';
274 } else if (Arg == "--cppflags") {
275 OS << ActiveIncludeOption << ' ' << LLVM_CPPFLAGS << '\n';
276 } else if (Arg == "--cflags") {
277 OS << ActiveIncludeOption << ' ' << LLVM_CFLAGS << '\n';
278 } else if (Arg == "--cxxflags") {
279 OS << ActiveIncludeOption << ' ' << LLVM_CXXFLAGS << '\n';
280 } else if (Arg == "--ldflags") {
281 OS << "-L" << ActiveLibDir << ' ' << LLVM_LDFLAGS
282 << ' ' << LLVM_SYSTEM_LIBS << '\n';
283 } else if (Arg == "--libs") {
285 } else if (Arg == "--libnames") {
286 PrintLibNames = true;
287 } else if (Arg == "--libfiles") {
288 PrintLibFiles = true;
289 } else if (Arg == "--components") {
290 for (unsigned j = 0; j != array_lengthof(AvailableComponents); ++j) {
291 // Only include non-installed components when in a development tree.
292 if (!AvailableComponents[j].IsInstalled && !IsInDevelopmentTree)
296 OS << AvailableComponents[j].Name;
299 } else if (Arg == "--targets-built") {
300 OS << LLVM_TARGETS_BUILT << '\n';
301 } else if (Arg == "--host-target") {
302 OS << LLVM_DEFAULT_TARGET_TRIPLE << '\n';
303 } else if (Arg == "--build-mode") {
304 char const *build_mode = LLVM_BUILDMODE;
305 #if defined(CMAKE_CFG_INTDIR)
306 if (!(CMAKE_CFG_INTDIR[0] == '.' && CMAKE_CFG_INTDIR[1] == '\0'))
307 build_mode = CMAKE_CFG_INTDIR;
309 OS << build_mode << '\n';
310 } else if (Arg == "--assertion-mode") {
316 } else if (Arg == "--obj-root") {
317 OS << LLVM_OBJ_ROOT << '\n';
318 } else if (Arg == "--src-root") {
319 OS << LLVM_SRC_ROOT << '\n';
324 Components.push_back(Arg);
331 if (PrintLibs || PrintLibNames || PrintLibFiles) {
332 // If no components were specified, default to "all".
333 if (Components.empty())
334 Components.push_back("all");
336 // Construct the list of all the required libraries.
337 std::vector<StringRef> RequiredLibs;
338 ComputeLibsForComponents(Components, RequiredLibs,
339 /*IncludeNonInstalled=*/IsInDevelopmentTree);
341 for (unsigned i = 0, e = RequiredLibs.size(); i != e; ++i) {
342 StringRef Lib = RequiredLibs[i];
348 } else if (PrintLibFiles) {
349 OS << ActiveLibDir << '/' << Lib;
350 } else if (PrintLibs) {
351 // If this is a typical library name, include it using -l.
352 if (Lib.startswith("lib") && Lib.endswith(".a")) {
353 OS << "-l" << Lib.slice(3, Lib.size()-2);
357 // Otherwise, print the full path.
358 OS << ActiveLibDir << '/' << Lib;
362 } else if (!Components.empty()) {
363 errs() << "llvm-config: error: components given, but unused\n\n";