blob: 58571cc59b79717e7d626bd65f59ef64fb4194d3 [file] [log] [blame]
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +00001//===-- llvm-config.cpp - LLVM project configuration utility --------------===//
2//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
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.).
13//
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.
17//
18//===----------------------------------------------------------------------===//
19
20#include "llvm/ADT/STLExtras.h"
21#include "llvm/ADT/StringMap.h"
22#include "llvm/ADT/StringRef.h"
Saleem Abdulrasool37511ec2014-03-29 01:08:53 +000023#include "llvm/ADT/Triple.h"
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +000024#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"
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +000029#include "llvm/Support/raw_ostream.h"
30#include <cstdlib>
31#include <set>
Andrew Wilkins1611ec42016-01-12 07:23:58 +000032#include <unordered_set>
Andrew Wilkinsdfd60882016-01-20 04:03:09 +000033#include <vector>
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +000034
35using namespace llvm;
36
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"
40
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.
44//
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"
48
Andrew Wilkinsdfd60882016-01-20 04:03:09 +000049// LinkMode determines what libraries and flags are returned by llvm-config.
50enum LinkMode {
51 // LinkModeAuto will link with the default link mode for the installation,
52 // which is dependent on the value of LLVM_LINK_LLVM_DYLIB, and fall back
53 // to the alternative if the required libraries are not available.
54 LinkModeAuto = 0,
55
56 // LinkModeShared will link with the dynamic component libraries if they
57 // exist, and return an error otherwise.
58 LinkModeShared = 1,
59
60 // LinkModeStatic will link with the static component libraries if they
61 // exist, and return an error otherwise.
62 LinkModeStatic = 2,
63};
64
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +000065/// \brief Traverse a single component adding to the topological ordering in
66/// \arg RequiredLibs.
67///
68/// \param Name - The component to traverse.
69/// \param ComponentMap - A prebuilt map of component names to descriptors.
70/// \param VisitedComponents [in] [out] - The set of already visited components.
Richard Diamond72303a22015-11-09 23:15:38 +000071/// \param RequiredLibs [out] - The ordered list of required
72/// libraries.
73/// \param GetComponentNames - Get the component names instead of the
74/// library name.
Andrew Wilkinsdfd60882016-01-20 04:03:09 +000075static void VisitComponent(const std::string &Name,
76 const StringMap<AvailableComponent *> &ComponentMap,
77 std::set<AvailableComponent *> &VisitedComponents,
Richard Diamonda62513c2015-11-25 22:49:48 +000078 std::vector<std::string> &RequiredLibs,
Richard Diamond72303a22015-11-09 23:15:38 +000079 bool IncludeNonInstalled, bool GetComponentNames,
Andrew Wilkinsdfd60882016-01-20 04:03:09 +000080 const std::function<std::string(const StringRef &)>
81 *GetComponentLibraryPath,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +000082 std::vector<std::string> *Missing,
83 const std::string &DirSep) {
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +000084 // Lookup the component.
85 AvailableComponent *AC = ComponentMap.lookup(Name);
Mehdi Amini907313a2016-02-12 18:43:10 +000086 if (!AC) {
87 errs() << "Can't find component: '" << Name << "' in the map. Available components are: ";
88 for (const auto &Component : ComponentMap) {
89 errs() << "'" << Component.first() << "' ";
90 }
91 errs() << "\n";
92 report_fatal_error("abort");
93 }
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +000094 assert(AC && "Invalid component name!");
95
96 // Add to the visited table.
97 if (!VisitedComponents.insert(AC).second) {
98 // We are done if the component has already been visited.
99 return;
100 }
101
Daniel Dunbarc364d682012-05-15 18:44:17 +0000102 // Only include non-installed components if requested.
103 if (!AC->IsInstalled && !IncludeNonInstalled)
104 return;
105
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000106 // Otherwise, visit all the dependencies.
107 for (unsigned i = 0; AC->RequiredLibraries[i]; ++i) {
108 VisitComponent(AC->RequiredLibraries[i], ComponentMap, VisitedComponents,
Richard Diamond72303a22015-11-09 23:15:38 +0000109 RequiredLibs, IncludeNonInstalled, GetComponentNames,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000110 GetComponentLibraryPath, Missing, DirSep);
Richard Diamond72303a22015-11-09 23:15:38 +0000111 }
112
113 if (GetComponentNames) {
114 RequiredLibs.push_back(Name);
115 return;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000116 }
117
118 // Add to the required library list.
Richard Diamond72303a22015-11-09 23:15:38 +0000119 if (AC->Library) {
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000120 if (Missing && GetComponentLibraryPath) {
121 std::string path = (*GetComponentLibraryPath)(AC->Library);
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000122 if (DirSep == "\\") {
123 std::replace(path.begin(), path.end(), '/', '\\');
124 }
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000125 if (!sys::fs::exists(path))
126 Missing->push_back(path);
Richard Diamond72303a22015-11-09 23:15:38 +0000127 }
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000128 RequiredLibs.push_back(AC->Library);
Richard Diamond72303a22015-11-09 23:15:38 +0000129 }
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000130}
131
132/// \brief Compute the list of required libraries for a given list of
133/// components, in an order suitable for passing to a linker (that is, libraries
134/// appear prior to their dependencies).
135///
136/// \param Components - The names of the components to find libraries for.
Daniel Dunbarc364d682012-05-15 18:44:17 +0000137/// \param IncludeNonInstalled - Whether non-installed components should be
138/// reported.
Richard Diamond72303a22015-11-09 23:15:38 +0000139/// \param GetComponentNames - True if one would prefer the component names.
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000140static std::vector<std::string> ComputeLibsForComponents(
141 const std::vector<StringRef> &Components, bool IncludeNonInstalled,
142 bool GetComponentNames, const std::function<std::string(const StringRef &)>
143 *GetComponentLibraryPath,
144 std::vector<std::string> *Missing, const std::string &DirSep) {
Richard Diamonda62513c2015-11-25 22:49:48 +0000145 std::vector<std::string> RequiredLibs;
David Blaikieb7504172015-11-09 23:51:45 +0000146 std::set<AvailableComponent *> VisitedComponents;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000147
148 // Build a map of component names to information.
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000149 StringMap<AvailableComponent *> ComponentMap;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000150 for (unsigned i = 0; i != array_lengthof(AvailableComponents); ++i) {
151 AvailableComponent *AC = &AvailableComponents[i];
152 ComponentMap[AC->Name] = AC;
153 }
154
155 // Visit the components.
156 for (unsigned i = 0, e = Components.size(); i != e; ++i) {
157 // Users are allowed to provide mixed case component names.
158 std::string ComponentLower = Components[i].lower();
159
160 // Validate that the user supplied a valid component name.
161 if (!ComponentMap.count(ComponentLower)) {
162 llvm::errs() << "llvm-config: unknown component name: " << Components[i]
163 << "\n";
164 exit(1);
165 }
166
167 VisitComponent(ComponentLower, ComponentMap, VisitedComponents,
Richard Diamond72303a22015-11-09 23:15:38 +0000168 RequiredLibs, IncludeNonInstalled, GetComponentNames,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000169 GetComponentLibraryPath, Missing, DirSep);
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000170 }
171
172 // The list is now ordered with leafs first, we want the libraries to printed
173 // in the reverse order of dependency.
174 std::reverse(RequiredLibs.begin(), RequiredLibs.end());
David Blaikieb7504172015-11-09 23:51:45 +0000175
176 return RequiredLibs;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000177}
178
179/* *** */
180
Benjamin Kramerf044d3f2015-03-09 16:23:46 +0000181static void usage() {
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000182 errs() << "\
183usage: llvm-config <OPTION>... [<COMPONENT>...]\n\
184\n\
185Get various configuration information needed to compile programs which use\n\
186LLVM. Typically called from 'configure' scripts. Examples:\n\
187 llvm-config --cxxflags\n\
188 llvm-config --ldflags\n\
189 llvm-config --libs engine bcreader scalaropts\n\
190\n\
191Options:\n\
192 --version Print LLVM version.\n\
193 --prefix Print the installation prefix.\n\
194 --src-root Print the source root LLVM was built from.\n\
195 --obj-root Print the object root used to build LLVM.\n\
196 --bindir Directory containing LLVM executables.\n\
197 --includedir Directory containing LLVM headers.\n\
198 --libdir Directory containing LLVM libraries.\n\
Michal Gorny1099e012017-01-06 08:23:33 +0000199 --cmakedir Directory containing LLVM cmake modules.\n\
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000200 --cppflags C preprocessor flags for files that include LLVM headers.\n\
201 --cflags C compiler flags for files that include LLVM headers.\n\
202 --cxxflags C++ compiler flags for files that include LLVM headers.\n\
203 --ldflags Print Linker flags.\n\
NAKAMURA Takumi800eb082013-12-25 02:24:32 +0000204 --system-libs System Libraries needed to link against LLVM components.\n\
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000205 --libs Libraries needed to link against LLVM components.\n\
206 --libnames Bare library names for in-tree builds.\n\
207 --libfiles Fully qualified library filenames for makefile depends.\n\
208 --components List of all possible components.\n\
209 --targets-built List of all targets currently built.\n\
210 --host-target Target triple used to configure LLVM.\n\
211 --build-mode Print build mode of LLVM tree (e.g. Debug or Release).\n\
NAKAMURA Takumi303f0f52013-12-03 23:22:25 +0000212 --assertion-mode Print assertion mode of LLVM tree (ON or OFF).\n\
Filipe Cabecinhasa7e63b12016-03-08 11:49:24 +0000213 --build-system Print the build system used to build LLVM (always cmake).\n\
Tom Stellard18bf6262015-11-04 20:57:43 +0000214 --has-rtti Print whether or not LLVM was built with rtti (YES or NO).\n\
Quentin Colombet447f8522016-03-08 00:02:50 +0000215 --has-global-isel Print whether or not LLVM was built with global-isel support (YES or NO).\n\
Richard Diamond72303a22015-11-09 23:15:38 +0000216 --shared-mode Print how the provided components can be collectively linked (`shared` or `static`).\n\
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000217 --link-shared Link the components as shared libraries.\n\
218 --link-static Link the component libraries statically.\n\
Chris Bieneman7f6611c2016-12-13 22:17:59 +0000219 --ignore-libllvm Ignore libLLVM and link component libraries instead.\n\
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000220Typical components:\n\
221 all All LLVM libraries (default).\n\
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000222 engine Either a native JIT or a bitcode interpreter.\n";
223 exit(1);
224}
225
226/// \brief Compute the path to the main executable.
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000227std::string GetExecutablePath(const char *Argv0) {
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000228 // This just needs to be some symbol in the binary; C++ doesn't
229 // allow taking the address of ::main however.
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000230 void *P = (void *)(intptr_t)GetExecutablePath;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000231 return llvm::sys::fs::getMainExecutable(Argv0, P);
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000232}
233
Richard Diamond72303a22015-11-09 23:15:38 +0000234/// \brief Expand the semi-colon delimited LLVM_DYLIB_COMPONENTS into
235/// the full list of components.
Richard Diamonda62513c2015-11-25 22:49:48 +0000236std::vector<std::string> GetAllDyLibComponents(const bool IsInDevelopmentTree,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000237 const bool GetComponentNames,
238 const std::string &DirSep) {
Richard Diamond72303a22015-11-09 23:15:38 +0000239 std::vector<StringRef> DyLibComponents;
Richard Diamond72303a22015-11-09 23:15:38 +0000240
David Blaikieb7504172015-11-09 23:51:45 +0000241 StringRef DyLibComponentsStr(LLVM_DYLIB_COMPONENTS);
242 size_t Offset = 0;
243 while (true) {
244 const size_t NextOffset = DyLibComponentsStr.find(';', Offset);
245 DyLibComponents.push_back(DyLibComponentsStr.substr(Offset, NextOffset));
246 if (NextOffset == std::string::npos) {
247 break;
248 }
249 Offset = NextOffset + 1;
Richard Diamond72303a22015-11-09 23:15:38 +0000250 }
251
David Blaikieb7504172015-11-09 23:51:45 +0000252 assert(!DyLibComponents.empty());
Richard Diamond72303a22015-11-09 23:15:38 +0000253
David Blaikieb7504172015-11-09 23:51:45 +0000254 return ComputeLibsForComponents(DyLibComponents,
255 /*IncludeNonInstalled=*/IsInDevelopmentTree,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000256 GetComponentNames, nullptr, nullptr, DirSep);
Richard Diamond72303a22015-11-09 23:15:38 +0000257}
258
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000259int main(int argc, char **argv) {
260 std::vector<StringRef> Components;
261 bool PrintLibs = false, PrintLibNames = false, PrintLibFiles = false;
Richard Diamond72303a22015-11-09 23:15:38 +0000262 bool PrintSystemLibs = false, PrintSharedMode = false;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000263 bool HasAnyOption = false;
264
265 // llvm-config is designed to support being run both from a development tree
266 // and from an installed path. We try and auto-detect which case we are in so
267 // that we can report the correct information when run from a development
268 // tree.
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000269 bool IsInDevelopmentTree;
Filipe Cabecinhasa7e63b12016-03-08 11:49:24 +0000270 enum { CMakeStyle, CMakeBuildModeStyle } DevelopmentTreeLayout;
Rafael Espindolae03dfd92013-06-26 05:01:35 +0000271 llvm::SmallString<256> CurrentPath(GetExecutablePath(argv[0]));
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000272 std::string CurrentExecPrefix;
273 std::string ActiveObjRoot;
274
NAKAMURA Takumi7b789b32013-12-17 05:48:37 +0000275 // If CMAKE_CFG_INTDIR is given, honor it as build mode.
276 char const *build_mode = LLVM_BUILDMODE;
277#if defined(CMAKE_CFG_INTDIR)
278 if (!(CMAKE_CFG_INTDIR[0] == '.' && CMAKE_CFG_INTDIR[1] == '\0'))
279 build_mode = CMAKE_CFG_INTDIR;
280#endif
281
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000282 // Create an absolute path, and pop up one directory (we expect to be inside a
283 // bin dir).
284 sys::fs::make_absolute(CurrentPath);
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000285 CurrentExecPrefix =
286 sys::path::parent_path(sys::path::parent_path(CurrentPath)).str();
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000287
288 // Check to see if we are inside a development tree by comparing to possible
Daniel Dunbarf1ab4022012-05-15 22:07:18 +0000289 // locations (prefix style or CMake style).
Filipe Cabecinhasa7e63b12016-03-08 11:49:24 +0000290 if (sys::fs::equivalent(CurrentExecPrefix, LLVM_OBJ_ROOT)) {
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000291 IsInDevelopmentTree = true;
292 DevelopmentTreeLayout = CMakeStyle;
293 ActiveObjRoot = LLVM_OBJ_ROOT;
Daniel Dunbarf1ab4022012-05-15 22:07:18 +0000294 } else if (sys::fs::equivalent(CurrentExecPrefix,
295 Twine(LLVM_OBJ_ROOT) + "/bin")) {
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000296 IsInDevelopmentTree = true;
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000297 DevelopmentTreeLayout = CMakeBuildModeStyle;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000298 ActiveObjRoot = LLVM_OBJ_ROOT;
299 } else {
300 IsInDevelopmentTree = false;
Filipe Cabecinhasa7e63b12016-03-08 11:49:24 +0000301 DevelopmentTreeLayout = CMakeStyle; // Initialized to avoid warnings.
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000302 }
303
304 // Compute various directory locations based on the derived location
305 // information.
Michal Gorny1099e012017-01-06 08:23:33 +0000306 std::string ActivePrefix, ActiveBinDir, ActiveIncludeDir, ActiveLibDir,
307 ActiveCMakeDir;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000308 std::string ActiveIncludeOption;
309 if (IsInDevelopmentTree) {
310 ActiveIncludeDir = std::string(LLVM_SRC_ROOT) + "/include";
311 ActivePrefix = CurrentExecPrefix;
312
313 // CMake organizes the products differently than a normal prefix style
314 // layout.
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000315 switch (DevelopmentTreeLayout) {
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000316 case CMakeStyle:
317 ActiveBinDir = ActiveObjRoot + "/bin";
Chandler Carruth7d587762014-12-29 11:16:25 +0000318 ActiveLibDir = ActiveObjRoot + "/lib" + LLVM_LIBDIR_SUFFIX;
Michal Gorny1099e012017-01-06 08:23:33 +0000319 ActiveCMakeDir = ActiveLibDir + "/cmake/llvm";
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000320 break;
321 case CMakeBuildModeStyle:
NAKAMURA Takumi429a2222013-12-19 16:02:23 +0000322 ActivePrefix = ActiveObjRoot;
NAKAMURA Takumi7b789b32013-12-17 05:48:37 +0000323 ActiveBinDir = ActiveObjRoot + "/bin/" + build_mode;
Chandler Carruth7d587762014-12-29 11:16:25 +0000324 ActiveLibDir =
325 ActiveObjRoot + "/lib" + LLVM_LIBDIR_SUFFIX + "/" + build_mode;
Michal Gorny1099e012017-01-06 08:23:33 +0000326 ActiveCMakeDir = ActiveLibDir + "/cmake/llvm";
Peter Collingbourne76e1c8c2012-01-26 01:31:38 +0000327 break;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000328 }
329
330 // We need to include files from both the source and object trees.
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000331 ActiveIncludeOption =
332 ("-I" + ActiveIncludeDir + " " + "-I" + ActiveObjRoot + "/include");
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000333 } else {
334 ActivePrefix = CurrentExecPrefix;
335 ActiveIncludeDir = ActivePrefix + "/include";
336 ActiveBinDir = ActivePrefix + "/bin";
Chandler Carruth7d587762014-12-29 11:16:25 +0000337 ActiveLibDir = ActivePrefix + "/lib" + LLVM_LIBDIR_SUFFIX;
Michal Gorny1099e012017-01-06 08:23:33 +0000338 ActiveCMakeDir = ActiveLibDir + "/cmake/llvm";
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000339 ActiveIncludeOption = "-I" + ActiveIncludeDir;
340 }
341
Richard Diamond72303a22015-11-09 23:15:38 +0000342 /// We only use `shared library` mode in cases where the static library form
343 /// of the components provided are not available; note however that this is
344 /// skipped if we're run from within the build dir. However, once installed,
345 /// we still need to provide correct output when the static archives are
346 /// removed or, as in the case of CMake's `BUILD_SHARED_LIBS`, never present
347 /// in the first place. This can't be done at configure/build time.
348
349 StringRef SharedExt, SharedVersionedExt, SharedDir, SharedPrefix, StaticExt,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000350 StaticPrefix, StaticDir = "lib", DirSep = "/";
NAKAMURA Takumi0882a5d2016-02-10 01:12:55 +0000351 const Triple HostTriple(Triple::normalize(LLVM_HOST_TRIPLE));
Richard Diamond72303a22015-11-09 23:15:38 +0000352 if (HostTriple.isOSWindows()) {
353 SharedExt = "dll";
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000354 SharedVersionedExt = LLVM_DYLIB_VERSION ".dll";
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000355 if (HostTriple.isOSCygMing()) {
356 StaticExt = "a";
NAKAMURA Takumi1621f812016-02-10 03:09:13 +0000357 StaticPrefix = "lib";
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000358 } else {
359 StaticExt = "lib";
360 DirSep = "\\";
361 std::replace(ActiveObjRoot.begin(), ActiveObjRoot.end(), '/', '\\');
362 std::replace(ActivePrefix.begin(), ActivePrefix.end(), '/', '\\');
363 std::replace(ActiveBinDir.begin(), ActiveBinDir.end(), '/', '\\');
364 std::replace(ActiveLibDir.begin(), ActiveLibDir.end(), '/', '\\');
Michal Gorny1099e012017-01-06 08:23:33 +0000365 std::replace(ActiveCMakeDir.begin(), ActiveCMakeDir.end(), '/', '\\');
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000366 std::replace(ActiveIncludeOption.begin(), ActiveIncludeOption.end(), '/',
367 '\\');
368 }
Richard Diamond72303a22015-11-09 23:15:38 +0000369 SharedDir = ActiveBinDir;
370 StaticDir = ActiveLibDir;
Richard Diamond72303a22015-11-09 23:15:38 +0000371 } else if (HostTriple.isOSDarwin()) {
372 SharedExt = "dylib";
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000373 SharedVersionedExt = LLVM_DYLIB_VERSION ".dylib";
Richard Diamond72303a22015-11-09 23:15:38 +0000374 StaticExt = "a";
375 StaticDir = SharedDir = ActiveLibDir;
376 StaticPrefix = SharedPrefix = "lib";
377 } else {
378 // default to the unix values:
379 SharedExt = "so";
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000380 SharedVersionedExt = LLVM_DYLIB_VERSION ".so";
Richard Diamond72303a22015-11-09 23:15:38 +0000381 StaticExt = "a";
382 StaticDir = SharedDir = ActiveLibDir;
383 StaticPrefix = SharedPrefix = "lib";
384 }
385
386 const bool BuiltDyLib = (std::strcmp(LLVM_ENABLE_DYLIB, "ON") == 0);
387
Richard Diamond72303a22015-11-09 23:15:38 +0000388 /// CMake style shared libs, ie each component is in a shared library.
Filipe Cabecinhasa7e63b12016-03-08 11:49:24 +0000389 const bool BuiltSharedLibs = std::strcmp(LLVM_ENABLE_SHARED, "ON") == 0;
Richard Diamond72303a22015-11-09 23:15:38 +0000390
391 bool DyLibExists = false;
392 const std::string DyLibName =
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000393 (SharedPrefix + "LLVM-" + SharedVersionedExt).str();
394
395 // If LLVM_LINK_DYLIB is ON, the single shared library will be returned
396 // for "--libs", etc, if they exist. This behaviour can be overridden with
397 // --link-static or --link-shared.
398 bool LinkDyLib = (std::strcmp(LLVM_LINK_DYLIB, "ON") == 0);
Richard Diamond72303a22015-11-09 23:15:38 +0000399
400 if (BuiltDyLib) {
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000401 std::string path((SharedDir + DirSep + DyLibName).str());
402 if (DirSep == "\\") {
403 std::replace(path.begin(), path.end(), '/', '\\');
404 }
405 DyLibExists = sys::fs::exists(path);
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000406 if (!DyLibExists) {
407 // The shared library does not exist: don't error unless the user
408 // explicitly passes --link-shared.
409 LinkDyLib = false;
410 }
Richard Diamond72303a22015-11-09 23:15:38 +0000411 }
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000412 LinkMode LinkMode =
413 (LinkDyLib || BuiltSharedLibs) ? LinkModeShared : LinkModeAuto;
Richard Diamond72303a22015-11-09 23:15:38 +0000414
415 /// Get the component's library name without the lib prefix and the
416 /// extension. Returns true if Lib is in a recognized format.
417 auto GetComponentLibraryNameSlice = [&](const StringRef &Lib,
418 StringRef &Out) {
419 if (Lib.startswith("lib")) {
420 unsigned FromEnd;
421 if (Lib.endswith(StaticExt)) {
422 FromEnd = StaticExt.size() + 1;
423 } else if (Lib.endswith(SharedExt)) {
424 FromEnd = SharedExt.size() + 1;
425 } else {
426 FromEnd = 0;
427 }
428
429 if (FromEnd != 0) {
430 Out = Lib.slice(3, Lib.size() - FromEnd);
431 return true;
432 }
433 }
434
435 return false;
436 };
437 /// Maps Unixizms to the host platform.
438 auto GetComponentLibraryFileName = [&](const StringRef &Lib,
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000439 const bool Shared) {
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000440 std::string LibFileName;
441 if (Shared) {
Dan Liew197d2f02016-12-12 23:07:22 +0000442 if (Lib == DyLibName) {
443 // Treat the DyLibName specially. It is not a component library and
444 // already has the necessary prefix and suffix (e.g. `.so`) added so
445 // just return it unmodified.
446 assert(Lib.endswith(SharedExt) && "DyLib is missing suffix");
447 LibFileName = Lib;
448 } else {
449 LibFileName = (SharedPrefix + Lib + "." + SharedExt).str();
450 }
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000451 } else {
452 // default to static
453 LibFileName = (StaticPrefix + Lib + "." + StaticExt).str();
Richard Diamond72303a22015-11-09 23:15:38 +0000454 }
455
456 return LibFileName;
457 };
458 /// Get the full path for a possibly shared component library.
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000459 auto GetComponentLibraryPath = [&](const StringRef &Name, const bool Shared) {
460 auto LibFileName = GetComponentLibraryFileName(Name, Shared);
461 if (Shared) {
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000462 return (SharedDir + DirSep + LibFileName).str();
Richard Diamond72303a22015-11-09 23:15:38 +0000463 } else {
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000464 return (StaticDir + DirSep + LibFileName).str();
Richard Diamond72303a22015-11-09 23:15:38 +0000465 }
466 };
467
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000468 raw_ostream &OS = outs();
469 for (int i = 1; i != argc; ++i) {
470 StringRef Arg = argv[i];
471
472 if (Arg.startswith("-")) {
473 HasAnyOption = true;
474 if (Arg == "--version") {
475 OS << PACKAGE_VERSION << '\n';
476 } else if (Arg == "--prefix") {
477 OS << ActivePrefix << '\n';
478 } else if (Arg == "--bindir") {
479 OS << ActiveBinDir << '\n';
480 } else if (Arg == "--includedir") {
481 OS << ActiveIncludeDir << '\n';
482 } else if (Arg == "--libdir") {
483 OS << ActiveLibDir << '\n';
Michal Gorny1099e012017-01-06 08:23:33 +0000484 } else if (Arg == "--cmakedir") {
485 OS << ActiveCMakeDir << '\n';
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000486 } else if (Arg == "--cppflags") {
487 OS << ActiveIncludeOption << ' ' << LLVM_CPPFLAGS << '\n';
488 } else if (Arg == "--cflags") {
489 OS << ActiveIncludeOption << ' ' << LLVM_CFLAGS << '\n';
490 } else if (Arg == "--cxxflags") {
491 OS << ActiveIncludeOption << ' ' << LLVM_CXXFLAGS << '\n';
492 } else if (Arg == "--ldflags") {
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000493 OS << ((HostTriple.isWindowsMSVCEnvironment()) ? "-LIBPATH:" : "-L")
494 << ActiveLibDir << ' ' << LLVM_LDFLAGS << '\n';
NAKAMURA Takumif8c58c82013-12-19 08:46:36 +0000495 } else if (Arg == "--system-libs") {
496 PrintSystemLibs = true;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000497 } else if (Arg == "--libs") {
498 PrintLibs = true;
499 } else if (Arg == "--libnames") {
500 PrintLibNames = true;
501 } else if (Arg == "--libfiles") {
502 PrintLibFiles = true;
503 } else if (Arg == "--components") {
Richard Diamond72303a22015-11-09 23:15:38 +0000504 /// If there are missing static archives and a dylib was
505 /// built, print LLVM_DYLIB_COMPONENTS instead of everything
506 /// in the manifest.
Richard Diamonda62513c2015-11-25 22:49:48 +0000507 std::vector<std::string> Components;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000508 for (unsigned j = 0; j != array_lengthof(AvailableComponents); ++j) {
Daniel Dunbarc364d682012-05-15 18:44:17 +0000509 // Only include non-installed components when in a development tree.
510 if (!AvailableComponents[j].IsInstalled && !IsInDevelopmentTree)
511 continue;
512
Richard Diamond72303a22015-11-09 23:15:38 +0000513 Components.push_back(AvailableComponents[j].Name);
514 if (AvailableComponents[j].Library && !IsInDevelopmentTree) {
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000515 std::string path(
516 GetComponentLibraryPath(AvailableComponents[j].Library, false));
517 if (DirSep == "\\") {
518 std::replace(path.begin(), path.end(), '/', '\\');
519 }
520 if (DyLibExists && !sys::fs::exists(path)) {
521 Components =
522 GetAllDyLibComponents(IsInDevelopmentTree, true, DirSep);
Richard Diamond72303a22015-11-09 23:15:38 +0000523 std::sort(Components.begin(), Components.end());
524 break;
525 }
526 }
527 }
528
529 for (unsigned I = 0; I < Components.size(); ++I) {
530 if (I) {
531 OS << ' ';
532 }
533
534 OS << Components[I];
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000535 }
536 OS << '\n';
537 } else if (Arg == "--targets-built") {
Daniel Dunbar30a89762011-12-16 00:04:43 +0000538 OS << LLVM_TARGETS_BUILT << '\n';
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000539 } else if (Arg == "--host-target") {
Saleem Abdulrasool37511ec2014-03-29 01:08:53 +0000540 OS << Triple::normalize(LLVM_DEFAULT_TARGET_TRIPLE) << '\n';
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000541 } else if (Arg == "--build-mode") {
NAKAMURA Takumi1b16e272013-12-03 14:35:17 +0000542 OS << build_mode << '\n';
NAKAMURA Takumi303f0f52013-12-03 23:22:25 +0000543 } else if (Arg == "--assertion-mode") {
544#if defined(NDEBUG)
545 OS << "OFF\n";
546#else
547 OS << "ON\n";
548#endif
Tom Stellard5268c172015-09-09 16:39:30 +0000549 } else if (Arg == "--build-system") {
550 OS << LLVM_BUILD_SYSTEM << '\n';
Tom Stellard18bf6262015-11-04 20:57:43 +0000551 } else if (Arg == "--has-rtti") {
552 OS << LLVM_HAS_RTTI << '\n';
Quentin Colombet447f8522016-03-08 00:02:50 +0000553 } else if (Arg == "--has-global-isel") {
554 OS << LLVM_HAS_GLOBAL_ISEL << '\n';
Richard Diamond72303a22015-11-09 23:15:38 +0000555 } else if (Arg == "--shared-mode") {
556 PrintSharedMode = true;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000557 } else if (Arg == "--obj-root") {
NAKAMURA Takumi93a14622013-12-19 16:02:28 +0000558 OS << ActivePrefix << '\n';
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000559 } else if (Arg == "--src-root") {
560 OS << LLVM_SRC_ROOT << '\n';
Derek Schuff7ff587a2016-12-13 23:01:53 +0000561 } else if (Arg == "--ignore-libllvm") {
562 LinkDyLib = false;
563 LinkMode = BuiltSharedLibs ? LinkModeShared : LinkModeAuto;
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000564 } else if (Arg == "--link-shared") {
565 LinkMode = LinkModeShared;
566 } else if (Arg == "--link-static") {
567 LinkMode = LinkModeStatic;
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000568 } else {
569 usage();
570 }
571 } else {
572 Components.push_back(Arg);
573 }
574 }
575
576 if (!HasAnyOption)
577 usage();
578
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000579 if (LinkMode == LinkModeShared && !DyLibExists && !BuiltSharedLibs) {
580 errs() << "llvm-config: error: " << DyLibName << " is missing\n";
581 return 1;
582 }
583
Richard Diamond72303a22015-11-09 23:15:38 +0000584 if (PrintLibs || PrintLibNames || PrintLibFiles || PrintSystemLibs ||
585 PrintSharedMode) {
586
587 if (PrintSharedMode && BuiltSharedLibs) {
588 OS << "shared\n";
589 return 0;
590 }
591
Daniel Dunbarfbc6a892011-12-12 18:22:04 +0000592 // If no components were specified, default to "all".
593 if (Components.empty())
594 Components.push_back("all");
595
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000596 // Construct the list of all the required libraries.
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000597 std::function<std::string(const StringRef &)>
598 GetComponentLibraryPathFunction = [&](const StringRef &Name) {
599 return GetComponentLibraryPath(Name, LinkMode == LinkModeShared);
600 };
601 std::vector<std::string> MissingLibs;
602 std::vector<std::string> RequiredLibs = ComputeLibsForComponents(
603 Components,
604 /*IncludeNonInstalled=*/IsInDevelopmentTree, false,
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000605 &GetComponentLibraryPathFunction, &MissingLibs, DirSep);
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000606 if (!MissingLibs.empty()) {
607 switch (LinkMode) {
608 case LinkModeShared:
Chris Bienemanda1c84c2016-12-13 23:08:52 +0000609 if (LinkDyLib && !BuiltSharedLibs)
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000610 break;
611 // Using component shared libraries.
612 for (auto &Lib : MissingLibs)
613 errs() << "llvm-config: error: missing: " << Lib << "\n";
614 return 1;
615 case LinkModeAuto:
616 if (DyLibExists) {
617 LinkMode = LinkModeShared;
618 break;
619 }
620 errs()
621 << "llvm-config: error: component libraries and shared library\n\n";
Justin Bognercd1d5aa2016-08-17 20:30:52 +0000622 LLVM_FALLTHROUGH;
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000623 case LinkModeStatic:
624 for (auto &Lib : MissingLibs)
625 errs() << "llvm-config: error: missing: " << Lib << "\n";
626 return 1;
627 }
628 } else if (LinkMode == LinkModeAuto) {
629 LinkMode = LinkModeStatic;
630 }
Richard Diamond72303a22015-11-09 23:15:38 +0000631
632 if (PrintSharedMode) {
633 std::unordered_set<std::string> FullDyLibComponents;
Richard Diamonda62513c2015-11-25 22:49:48 +0000634 std::vector<std::string> DyLibComponents =
Ehsan Akhgari155ca8f2016-02-09 19:41:14 +0000635 GetAllDyLibComponents(IsInDevelopmentTree, false, DirSep);
Richard Diamond72303a22015-11-09 23:15:38 +0000636
637 for (auto &Component : DyLibComponents) {
638 FullDyLibComponents.insert(Component);
639 }
640 DyLibComponents.clear();
641
642 for (auto &Lib : RequiredLibs) {
643 if (!FullDyLibComponents.count(Lib)) {
644 OS << "static\n";
645 return 0;
646 }
647 }
648 FullDyLibComponents.clear();
649
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000650 if (LinkMode == LinkModeShared) {
Richard Diamond72303a22015-11-09 23:15:38 +0000651 OS << "shared\n";
652 return 0;
653 } else {
654 OS << "static\n";
655 return 0;
656 }
657 }
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000658
Richard Osborne49ae1172014-03-03 15:06:14 +0000659 if (PrintLibs || PrintLibNames || PrintLibFiles) {
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000660
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000661 auto PrintForLib = [&](const StringRef &Lib) {
662 const bool Shared = LinkMode == LinkModeShared;
Richard Osborne49ae1172014-03-03 15:06:14 +0000663 if (PrintLibNames) {
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000664 OS << GetComponentLibraryFileName(Lib, Shared);
Richard Osborne49ae1172014-03-03 15:06:14 +0000665 } else if (PrintLibFiles) {
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000666 OS << GetComponentLibraryPath(Lib, Shared);
Richard Osborne49ae1172014-03-03 15:06:14 +0000667 } else if (PrintLibs) {
Reid Klecknerecb40902016-03-14 21:39:58 +0000668 // On Windows, output full path to library without parameters.
669 // Elsewhere, if this is a typical library name, include it using -l.
670 if (HostTriple.isWindowsMSVCEnvironment()) {
671 OS << GetComponentLibraryPath(Lib, Shared);
672 } else {
673 StringRef LibName;
Richard Diamond72303a22015-11-09 23:15:38 +0000674 if (GetComponentLibraryNameSlice(Lib, LibName)) {
Reid Klecknerecb40902016-03-14 21:39:58 +0000675 // Extract library name (remove prefix and suffix).
Richard Diamond72303a22015-11-09 23:15:38 +0000676 OS << "-l" << LibName;
677 } else {
Reid Klecknerecb40902016-03-14 21:39:58 +0000678 // Lib is already a library name without prefix and suffix.
679 OS << "-l" << Lib;
Richard Diamond72303a22015-11-09 23:15:38 +0000680 }
Richard Osborne49ae1172014-03-03 15:06:14 +0000681 }
Richard Diamond72303a22015-11-09 23:15:38 +0000682 }
683 };
Richard Osborne49ae1172014-03-03 15:06:14 +0000684
Chris Bienemanda1c84c2016-12-13 23:08:52 +0000685 if (LinkMode == LinkModeShared && LinkDyLib) {
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000686 PrintForLib(DyLibName);
Richard Diamond72303a22015-11-09 23:15:38 +0000687 } else {
688 for (unsigned i = 0, e = RequiredLibs.size(); i != e; ++i) {
Richard Diamonda62513c2015-11-25 22:49:48 +0000689 auto Lib = RequiredLibs[i];
Richard Diamond72303a22015-11-09 23:15:38 +0000690 if (i)
691 OS << ' ';
692
Andrew Wilkinsdfd60882016-01-20 04:03:09 +0000693 PrintForLib(Lib);
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000694 }
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000695 }
Richard Osborne49ae1172014-03-03 15:06:14 +0000696 OS << '\n';
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000697 }
NAKAMURA Takumif8c58c82013-12-19 08:46:36 +0000698
699 // Print SYSTEM_LIBS after --libs.
700 // FIXME: Each LLVM component may have its dependent system libs.
701 if (PrintSystemLibs)
702 OS << LLVM_SYSTEM_LIBS << '\n';
Daniel Dunbarab0ad4e2011-12-01 20:18:09 +0000703 } else if (!Components.empty()) {
704 errs() << "llvm-config: error: components given, but unused\n\n";
705 usage();
706 }
707
708 return 0;
709}