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/Triple.h"
24 #include "llvm/ADT/Twine.h"
25 #include "llvm/Config/config.h"
26 #include "llvm/Config/llvm-config.h"
27 #include "llvm/Support/FileSystem.h"
28 #include "llvm/Support/Path.h"
29 #include "llvm/Support/raw_ostream.h"
33 #include <unordered_set>
37 // Include the build time variables we can report to the user. This is generated
38 // at build time from the BuildVariables.inc.in file by the build system.
39 #include "BuildVariables.inc"
41 // Include the component table. This creates an array of struct
42 // AvailableComponent entries, which record the component name, library name,
43 // and required components for all of the available libraries.
45 // Not all components define a library, we also use "library groups" as a way to
46 // create entries for pseudo groups like x86 or all-targets.
47 #include "LibraryDependencies.inc"
49 /// \brief Traverse a single component adding to the topological ordering in
50 /// \arg RequiredLibs.
52 /// \param Name - The component to traverse.
53 /// \param ComponentMap - A prebuilt map of component names to descriptors.
54 /// \param VisitedComponents [in] [out] - The set of already visited components.
55 /// \param RequiredLibs [out] - The ordered list of required
57 /// \param GetComponentNames - Get the component names instead of the
59 static void VisitComponent(StringRef Name,
60 const StringMap<AvailableComponent*> &ComponentMap,
61 std::set<AvailableComponent*> &VisitedComponents,
62 std::vector<StringRef> &RequiredLibs,
63 bool IncludeNonInstalled, bool GetComponentNames,
64 const std::string *ActiveLibDir, bool *HasMissing) {
65 // Lookup the component.
66 AvailableComponent *AC = ComponentMap.lookup(Name);
67 assert(AC && "Invalid component name!");
69 // Add to the visited table.
70 if (!VisitedComponents.insert(AC).second) {
71 // We are done if the component has already been visited.
75 // Only include non-installed components if requested.
76 if (!AC->IsInstalled && !IncludeNonInstalled)
79 // Otherwise, visit all the dependencies.
80 for (unsigned i = 0; AC->RequiredLibraries[i]; ++i) {
81 VisitComponent(AC->RequiredLibraries[i], ComponentMap, VisitedComponents,
82 RequiredLibs, IncludeNonInstalled, GetComponentNames,
83 ActiveLibDir, HasMissing);
86 if (GetComponentNames) {
87 RequiredLibs.push_back(Name);
91 // Add to the required library list.
93 if (!IncludeNonInstalled && HasMissing && !*HasMissing && ActiveLibDir) {
94 *HasMissing = !sys::fs::exists(*ActiveLibDir + "/" + AC->Library);
96 RequiredLibs.push_back(AC->Library);
100 /// \brief Compute the list of required libraries for a given list of
101 /// components, in an order suitable for passing to a linker (that is, libraries
102 /// appear prior to their dependencies).
104 /// \param Components - The names of the components to find libraries for.
105 /// \param RequiredLibs [out] - On return, the ordered list of libraries that
106 /// are required to link the given components.
107 /// \param IncludeNonInstalled - Whether non-installed components should be
109 /// \param GetComponentNames - True if one would prefer the component names.
110 static void ComputeLibsForComponents(const std::vector<StringRef> &Components,
111 std::vector<StringRef> &RequiredLibs,
112 bool IncludeNonInstalled, bool GetComponentNames,
113 const std::string *ActiveLibDir,
115 std::set<AvailableComponent*> VisitedComponents;
117 // Build a map of component names to information.
118 StringMap<AvailableComponent*> ComponentMap;
119 for (unsigned i = 0; i != array_lengthof(AvailableComponents); ++i) {
120 AvailableComponent *AC = &AvailableComponents[i];
121 ComponentMap[AC->Name] = AC;
124 // Visit the components.
125 for (unsigned i = 0, e = Components.size(); i != e; ++i) {
126 // Users are allowed to provide mixed case component names.
127 std::string ComponentLower = Components[i].lower();
129 // Validate that the user supplied a valid component name.
130 if (!ComponentMap.count(ComponentLower)) {
131 llvm::errs() << "llvm-config: unknown component name: " << Components[i]
136 VisitComponent(ComponentLower, ComponentMap, VisitedComponents,
137 RequiredLibs, IncludeNonInstalled, GetComponentNames,
138 ActiveLibDir, HasMissing);
141 // The list is now ordered with leafs first, we want the libraries to printed
142 // in the reverse order of dependency.
143 std::reverse(RequiredLibs.begin(), RequiredLibs.end());
148 static void usage() {
150 usage: llvm-config <OPTION>... [<COMPONENT>...]\n\
152 Get various configuration information needed to compile programs which use\n\
153 LLVM. Typically called from 'configure' scripts. Examples:\n\
154 llvm-config --cxxflags\n\
155 llvm-config --ldflags\n\
156 llvm-config --libs engine bcreader scalaropts\n\
159 --version Print LLVM version.\n\
160 --prefix Print the installation prefix.\n\
161 --src-root Print the source root LLVM was built from.\n\
162 --obj-root Print the object root used to build LLVM.\n\
163 --bindir Directory containing LLVM executables.\n\
164 --includedir Directory containing LLVM headers.\n\
165 --libdir Directory containing LLVM libraries.\n\
166 --cppflags C preprocessor flags for files that include LLVM headers.\n\
167 --cflags C compiler flags for files that include LLVM headers.\n\
168 --cxxflags C++ compiler flags for files that include LLVM headers.\n\
169 --ldflags Print Linker flags.\n\
170 --system-libs System Libraries needed to link against LLVM components.\n\
171 --libs Libraries needed to link against LLVM components.\n\
172 --libnames Bare library names for in-tree builds.\n\
173 --libfiles Fully qualified library filenames for makefile depends.\n\
174 --components List of all possible components.\n\
175 --targets-built List of all targets currently built.\n\
176 --host-target Target triple used to configure LLVM.\n\
177 --build-mode Print build mode of LLVM tree (e.g. Debug or Release).\n\
178 --assertion-mode Print assertion mode of LLVM tree (ON or OFF).\n\
179 --build-system Print the build system used to build LLVM (autoconf or cmake).\n\
180 --has-rtti Print whether or not LLVM was built with rtti (YES or NO).\n\
181 --shared-mode Print how the provided components can be collectively linked (`shared` or `static`).\n\
182 Typical components:\n\
183 all All LLVM libraries (default).\n\
184 engine Either a native JIT or a bitcode interpreter.\n";
188 /// \brief Compute the path to the main executable.
189 std::string GetExecutablePath(const char *Argv0) {
190 // This just needs to be some symbol in the binary; C++ doesn't
191 // allow taking the address of ::main however.
192 void *P = (void*) (intptr_t) GetExecutablePath;
193 return llvm::sys::fs::getMainExecutable(Argv0, P);
196 /// \brief Expand the semi-colon delimited LLVM_DYLIB_COMPONENTS into
197 /// the full list of components.
198 std::vector<StringRef> GetAllDyLibComponents(const bool IsInDevelopmentTree,
199 const bool GetComponentNames) {
200 std::vector<StringRef> DyLibComponents;
202 StringRef DyLibComponentsStr(LLVM_DYLIB_COMPONENTS);
205 const size_t NextOffset = DyLibComponentsStr.find(';', Offset);
206 DyLibComponents.push_back(DyLibComponentsStr.substr(Offset, NextOffset));
207 if (NextOffset == std::string::npos) {
210 Offset = NextOffset + 1;
213 assert(DyLibComponents.size() > 0);
216 std::vector<StringRef> Components;
217 ComputeLibsForComponents(DyLibComponents, Components,
218 /*IncludeNonInstalled=*/IsInDevelopmentTree,
219 GetComponentNames, nullptr, nullptr);
221 return std::move(Components);
224 int main(int argc, char **argv) {
225 std::vector<StringRef> Components;
226 bool PrintLibs = false, PrintLibNames = false, PrintLibFiles = false;
227 bool PrintSystemLibs = false, PrintSharedMode = false;
228 bool HasAnyOption = false;
230 // llvm-config is designed to support being run both from a development tree
231 // and from an installed path. We try and auto-detect which case we are in so
232 // that we can report the correct information when run from a development
234 bool IsInDevelopmentTree;
235 enum { MakefileStyle, CMakeStyle, CMakeBuildModeStyle } DevelopmentTreeLayout;
236 llvm::SmallString<256> CurrentPath(GetExecutablePath(argv[0]));
237 std::string CurrentExecPrefix;
238 std::string ActiveObjRoot;
240 // If CMAKE_CFG_INTDIR is given, honor it as build mode.
241 char const *build_mode = LLVM_BUILDMODE;
242 #if defined(CMAKE_CFG_INTDIR)
243 if (!(CMAKE_CFG_INTDIR[0] == '.' && CMAKE_CFG_INTDIR[1] == '\0'))
244 build_mode = CMAKE_CFG_INTDIR;
247 // Create an absolute path, and pop up one directory (we expect to be inside a
249 sys::fs::make_absolute(CurrentPath);
250 CurrentExecPrefix = sys::path::parent_path(
251 sys::path::parent_path(CurrentPath)).str();
253 // Check to see if we are inside a development tree by comparing to possible
254 // locations (prefix style or CMake style).
255 if (sys::fs::equivalent(CurrentExecPrefix,
256 Twine(LLVM_OBJ_ROOT) + "/" + build_mode)) {
257 IsInDevelopmentTree = true;
258 DevelopmentTreeLayout = MakefileStyle;
260 // If we are in a development tree, then check if we are in a BuildTools
261 // directory. This indicates we are built for the build triple, but we
262 // always want to provide information for the host triple.
263 if (sys::path::filename(LLVM_OBJ_ROOT) == "BuildTools") {
264 ActiveObjRoot = sys::path::parent_path(LLVM_OBJ_ROOT);
266 ActiveObjRoot = LLVM_OBJ_ROOT;
268 } else if (sys::fs::equivalent(CurrentExecPrefix, LLVM_OBJ_ROOT)) {
269 IsInDevelopmentTree = true;
270 DevelopmentTreeLayout = CMakeStyle;
271 ActiveObjRoot = LLVM_OBJ_ROOT;
272 } else if (sys::fs::equivalent(CurrentExecPrefix,
273 Twine(LLVM_OBJ_ROOT) + "/bin")) {
274 IsInDevelopmentTree = true;
275 DevelopmentTreeLayout = CMakeBuildModeStyle;
276 ActiveObjRoot = LLVM_OBJ_ROOT;
278 IsInDevelopmentTree = false;
279 DevelopmentTreeLayout = MakefileStyle; // Initialized to avoid warnings.
282 // Compute various directory locations based on the derived location
284 std::string ActivePrefix, ActiveBinDir, ActiveIncludeDir, ActiveLibDir;
285 std::string ActiveIncludeOption;
286 if (IsInDevelopmentTree) {
287 ActiveIncludeDir = std::string(LLVM_SRC_ROOT) + "/include";
288 ActivePrefix = CurrentExecPrefix;
290 // CMake organizes the products differently than a normal prefix style
292 switch (DevelopmentTreeLayout) {
294 ActivePrefix = ActiveObjRoot;
295 ActiveBinDir = ActiveObjRoot + "/" + build_mode + "/bin";
297 ActiveObjRoot + "/" + build_mode + "/lib" + LLVM_LIBDIR_SUFFIX;
300 ActiveBinDir = ActiveObjRoot + "/bin";
301 ActiveLibDir = ActiveObjRoot + "/lib" + LLVM_LIBDIR_SUFFIX;
303 case CMakeBuildModeStyle:
304 ActivePrefix = ActiveObjRoot;
305 ActiveBinDir = ActiveObjRoot + "/bin/" + build_mode;
307 ActiveObjRoot + "/lib" + LLVM_LIBDIR_SUFFIX + "/" + build_mode;
311 // We need to include files from both the source and object trees.
312 ActiveIncludeOption = ("-I" + ActiveIncludeDir + " " +
313 "-I" + ActiveObjRoot + "/include");
315 ActivePrefix = CurrentExecPrefix;
316 ActiveIncludeDir = ActivePrefix + "/include";
317 ActiveBinDir = ActivePrefix + "/bin";
318 ActiveLibDir = ActivePrefix + "/lib" + LLVM_LIBDIR_SUFFIX;
319 ActiveIncludeOption = "-I" + ActiveIncludeDir;
322 /// We only use `shared library` mode in cases where the static library form
323 /// of the components provided are not available; note however that this is
324 /// skipped if we're run from within the build dir. However, once installed,
325 /// we still need to provide correct output when the static archives are
326 /// removed or, as in the case of CMake's `BUILD_SHARED_LIBS`, never present
327 /// in the first place. This can't be done at configure/build time.
329 StringRef SharedExt, SharedVersionedExt, SharedDir, SharedPrefix, StaticExt,
330 StaticPrefix, StaticDir = "lib";
331 const Triple HostTriple(Triple::normalize(LLVM_DEFAULT_TARGET_TRIPLE));
332 if (HostTriple.isOSWindows()) {
334 SharedVersionedExt = PACKAGE_VERSION ".dll";
336 SharedDir = ActiveBinDir;
337 StaticDir = ActiveLibDir;
338 StaticPrefix = SharedPrefix = "";
339 } else if (HostTriple.isOSDarwin()) {
341 SharedVersionedExt = PACKAGE_VERSION ".dylib";
343 StaticDir = SharedDir = ActiveLibDir;
344 StaticPrefix = SharedPrefix = "lib";
346 // default to the unix values:
348 SharedVersionedExt = PACKAGE_VERSION ".so";
350 StaticDir = SharedDir = ActiveLibDir;
351 StaticPrefix = SharedPrefix = "lib";
354 const bool BuiltDyLib = (std::strcmp(LLVM_ENABLE_DYLIB, "ON") == 0);
356 enum { CMake, AutoConf } ConfigTool;
357 if (std::strcmp(LLVM_BUILD_SYSTEM, "cmake") == 0) {
360 ConfigTool = AutoConf;
363 /// CMake style shared libs, ie each component is in a shared library.
364 const bool BuiltSharedLibs =
365 (ConfigTool == CMake && std::strcmp(LLVM_ENABLE_SHARED, "ON") == 0);
367 bool DyLibExists = false;
368 const std::string DyLibName =
369 (SharedPrefix + "LLVM-" + SharedVersionedExt).str();
372 DyLibExists = sys::fs::exists(SharedDir + "/" + DyLibName);
375 /// Get the component's library name without the lib prefix and the
376 /// extension. Returns true if Lib is in a recognized format.
377 auto GetComponentLibraryNameSlice = [&](const StringRef &Lib,
379 if (Lib.startswith("lib")) {
381 if (Lib.endswith(StaticExt)) {
382 FromEnd = StaticExt.size() + 1;
383 } else if (Lib.endswith(SharedExt)) {
384 FromEnd = SharedExt.size() + 1;
390 Out = Lib.slice(3, Lib.size() - FromEnd);
397 /// Maps Unixizms to the host platform.
398 auto GetComponentLibraryFileName = [&](const StringRef &Lib,
399 const bool ForceShared) {
400 std::string LibFileName = Lib;
402 if (GetComponentLibraryNameSlice(Lib, LibName)) {
403 if (BuiltSharedLibs || ForceShared) {
404 LibFileName = (SharedPrefix + LibName + "." + SharedExt).str();
407 LibFileName = (StaticPrefix + LibName + "." + StaticExt).str();
413 /// Get the full path for a possibly shared component library.
414 auto GetComponentLibraryPath = [&](const StringRef &Name,
415 const bool ForceShared) {
416 auto LibFileName = GetComponentLibraryFileName(Name, ForceShared);
417 if (BuiltSharedLibs || ForceShared) {
418 return (SharedDir + "/" + LibFileName).str();
420 return (StaticDir + "/" + LibFileName).str();
424 raw_ostream &OS = outs();
425 for (int i = 1; i != argc; ++i) {
426 StringRef Arg = argv[i];
428 if (Arg.startswith("-")) {
430 if (Arg == "--version") {
431 OS << PACKAGE_VERSION << '\n';
432 } else if (Arg == "--prefix") {
433 OS << ActivePrefix << '\n';
434 } else if (Arg == "--bindir") {
435 OS << ActiveBinDir << '\n';
436 } else if (Arg == "--includedir") {
437 OS << ActiveIncludeDir << '\n';
438 } else if (Arg == "--libdir") {
439 OS << ActiveLibDir << '\n';
440 } else if (Arg == "--cppflags") {
441 OS << ActiveIncludeOption << ' ' << LLVM_CPPFLAGS << '\n';
442 } else if (Arg == "--cflags") {
443 OS << ActiveIncludeOption << ' ' << LLVM_CFLAGS << '\n';
444 } else if (Arg == "--cxxflags") {
445 OS << ActiveIncludeOption << ' ' << LLVM_CXXFLAGS << '\n';
446 } else if (Arg == "--ldflags") {
447 OS << "-L" << ActiveLibDir << ' ' << LLVM_LDFLAGS << '\n';
448 } else if (Arg == "--system-libs") {
449 PrintSystemLibs = true;
450 } else if (Arg == "--libs") {
452 } else if (Arg == "--libnames") {
453 PrintLibNames = true;
454 } else if (Arg == "--libfiles") {
455 PrintLibFiles = true;
456 } else if (Arg == "--components") {
457 /// If there are missing static archives and a dylib was
458 /// built, print LLVM_DYLIB_COMPONENTS instead of everything
460 std::vector<StringRef> Components;
461 for (unsigned j = 0; j != array_lengthof(AvailableComponents); ++j) {
462 // Only include non-installed components when in a development tree.
463 if (!AvailableComponents[j].IsInstalled && !IsInDevelopmentTree)
466 Components.push_back(AvailableComponents[j].Name);
467 if (AvailableComponents[j].Library && !IsInDevelopmentTree) {
469 !sys::fs::exists(GetComponentLibraryPath(
470 AvailableComponents[j].Library, false))) {
471 Components = GetAllDyLibComponents(IsInDevelopmentTree, true);
472 std::sort(Components.begin(), Components.end());
478 for (unsigned I = 0; I < Components.size(); ++I) {
486 } else if (Arg == "--targets-built") {
487 OS << LLVM_TARGETS_BUILT << '\n';
488 } else if (Arg == "--host-target") {
489 OS << Triple::normalize(LLVM_DEFAULT_TARGET_TRIPLE) << '\n';
490 } else if (Arg == "--build-mode") {
491 OS << build_mode << '\n';
492 } else if (Arg == "--assertion-mode") {
498 } else if (Arg == "--build-system") {
499 OS << LLVM_BUILD_SYSTEM << '\n';
500 } else if (Arg == "--has-rtti") {
501 OS << LLVM_HAS_RTTI << '\n';
502 } else if (Arg == "--shared-mode") {
503 PrintSharedMode = true;
504 } else if (Arg == "--obj-root") {
505 OS << ActivePrefix << '\n';
506 } else if (Arg == "--src-root") {
507 OS << LLVM_SRC_ROOT << '\n';
512 Components.push_back(Arg);
519 if (PrintLibs || PrintLibNames || PrintLibFiles || PrintSystemLibs ||
522 if (PrintSharedMode && BuiltSharedLibs) {
527 // If no components were specified, default to "all".
528 if (Components.empty())
529 Components.push_back("all");
531 // Construct the list of all the required libraries.
532 std::vector<StringRef> RequiredLibs;
533 bool HasMissing = false;
534 ComputeLibsForComponents(Components, RequiredLibs,
535 /*IncludeNonInstalled=*/IsInDevelopmentTree, false,
536 &ActiveLibDir, &HasMissing);
538 if (PrintSharedMode) {
539 std::unordered_set<std::string> FullDyLibComponents;
540 std::vector<StringRef> DyLibComponents =
541 GetAllDyLibComponents(IsInDevelopmentTree, false);
543 for (auto &Component : DyLibComponents) {
544 FullDyLibComponents.insert(Component);
546 DyLibComponents.clear();
548 for (auto &Lib : RequiredLibs) {
549 if (!FullDyLibComponents.count(Lib)) {
554 FullDyLibComponents.clear();
556 if (HasMissing && DyLibExists) {
565 if (PrintLibs || PrintLibNames || PrintLibFiles) {
567 auto PrintForLib = [&](const StringRef &Lib, const bool ForceShared) {
569 OS << GetComponentLibraryFileName(Lib, ForceShared);
570 } else if (PrintLibFiles) {
571 OS << GetComponentLibraryPath(Lib, ForceShared);
572 } else if (PrintLibs) {
573 // If this is a typical library name, include it using -l.
575 if (Lib.startswith("lib")) {
576 if (GetComponentLibraryNameSlice(Lib, LibName)) {
577 OS << "-l" << LibName;
579 OS << "-l:" << GetComponentLibraryFileName(Lib, ForceShared);
582 // Otherwise, print the full path.
583 OS << GetComponentLibraryPath(Lib, ForceShared);
588 if (HasMissing && DyLibExists) {
589 PrintForLib(DyLibName, true);
591 for (unsigned i = 0, e = RequiredLibs.size(); i != e; ++i) {
592 StringRef Lib = RequiredLibs[i];
596 PrintForLib(Lib, false);
602 // Print SYSTEM_LIBS after --libs.
603 // FIXME: Each LLVM component may have its dependent system libs.
605 OS << LLVM_SYSTEM_LIBS << '\n';
606 } else if (!Components.empty()) {
607 errs() << "llvm-config: error: components given, but unused\n\n";