tools/llvm-config/llvm-config.cpp

   1 //===-- 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"
  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"
  29 #include <cstdlib>
  30 #include <set>
  31 #include <vector>
  32
  33 using namespace llvm;
  34
  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"
  38
  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.
  42 //
  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"
  46
  47 /// \brief Traverse a single component adding to the topological ordering in
  48 /// \arg RequiredLibs.
  49 ///
  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!");
  62
  63   // Add to the visited table.
  64   if (!VisitedComponents.insert(AC).second) {
  65     // We are done if the component has already been visited.
  66     return;
  67   }
  68
  69   // Only include non-installed components if requested.
  70   if (!AC->IsInstalled && !IncludeNonInstalled)
  71     return;
  72
  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);
  77   }
  78
  79   // Add to the required library list.
  80   if (AC->Library)
  81     RequiredLibs.push_back(AC->Library);
  82 }
  83
  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).
  87 ///
  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
  92 /// reported.
  93 void ComputeLibsForComponents(const std::vector<StringRef> &Components,
  94                               std::vector<StringRef> &RequiredLibs,
  95                               bool IncludeNonInstalled) {
  96   std::set<AvailableComponent*> VisitedComponents;
  97
  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;
 103   }
 104
 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();
 109
 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]
 113                    << "\n";
 114       exit(1);
 115     }
 116
 117     VisitComponent(ComponentLower, ComponentMap, VisitedComponents,
 118                    RequiredLibs, IncludeNonInstalled);
 119   }
 120
 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());
 124 }
 125
 126 /* *** */
 127
 128 void usage() {
 129   errs() << "\
 130 usage: llvm-config <OPTION>... [<COMPONENT>...]\n\
 131 \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\
 137 \n\
 138 Options:\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";
 161   exit(1);
 162 }
 163
 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);
 170 }
 171
 172 int main(int argc, char **argv) {
 173   std::vector<StringRef> Components;
 174   bool PrintLibs = false, PrintLibNames = false, PrintLibFiles = false;
 175   bool HasAnyOption = false;
 176
 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
 180   // tree.
 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;
 186
 187   // If CMAKE_CFG_INTDIR is given, honor it as build mode.
 188   char const *build_mode = LLVM_BUILDMODE;
 189 #if defined(CMAKE_CFG_INTDIR)
 190   if (!(CMAKE_CFG_INTDIR[0] == '.' && CMAKE_CFG_INTDIR[1] == '\0'))
 191     build_mode = CMAKE_CFG_INTDIR;
 192 #endif
 193
 194   // Create an absolute path, and pop up one directory (we expect to be inside a
 195   // bin dir).
 196   sys::fs::make_absolute(CurrentPath);
 197   CurrentExecPrefix = sys::path::parent_path(
 198     sys::path::parent_path(CurrentPath)).str();
 199
 200   // Check to see if we are inside a development tree by comparing to possible
 201   // locations (prefix style or CMake style).
 202   if (sys::fs::equivalent(CurrentExecPrefix,
 203                           Twine(LLVM_OBJ_ROOT) + "/" + LLVM_BUILDMODE)) {
 204     IsInDevelopmentTree = true;
 205     DevelopmentTreeLayout = MakefileStyle;
 206
 207     // If we are in a development tree, then check if we are in a BuildTools
 208     // directory. This indicates we are built for the build triple, but we
 209     // always want to provide information for the host triple.
 210     if (sys::path::filename(LLVM_OBJ_ROOT) == "BuildTools") {
 211       ActiveObjRoot = sys::path::parent_path(LLVM_OBJ_ROOT);
 212     } else {
 213       ActiveObjRoot = LLVM_OBJ_ROOT;
 214     }
 215   } else if (sys::fs::equivalent(CurrentExecPrefix, LLVM_OBJ_ROOT)) {
 216     IsInDevelopmentTree = true;
 217     DevelopmentTreeLayout = CMakeStyle;
 218     ActiveObjRoot = LLVM_OBJ_ROOT;
 219   } else if (sys::fs::equivalent(CurrentExecPrefix,
 220                                  Twine(LLVM_OBJ_ROOT) + "/bin")) {
 221     IsInDevelopmentTree = true;
 222     DevelopmentTreeLayout = CMakeBuildModeStyle;
 223     ActiveObjRoot = LLVM_OBJ_ROOT;
 224   } else {
 225     IsInDevelopmentTree = false;
 226     DevelopmentTreeLayout = MakefileStyle; // Initialized to avoid warnings.
 227   }
 228
 229   // Compute various directory locations based on the derived location
 230   // information.
 231   std::string ActivePrefix, ActiveBinDir, ActiveIncludeDir, ActiveLibDir;
 232   std::string ActiveIncludeOption;
 233   if (IsInDevelopmentTree) {
 234     ActiveIncludeDir = std::string(LLVM_SRC_ROOT) + "/include";
 235     ActivePrefix = CurrentExecPrefix;
 236
 237     // CMake organizes the products differently than a normal prefix style
 238     // layout.
 239     switch (DevelopmentTreeLayout) {
 240     case MakefileStyle:
 241       ActiveBinDir = ActiveObjRoot + "/" + LLVM_BUILDMODE + "/bin";
 242       ActiveLibDir = ActiveObjRoot + "/" + LLVM_BUILDMODE + "/lib";
 243       break;
 244     case CMakeStyle:
 245       ActiveBinDir = ActiveObjRoot + "/bin";
 246       ActiveLibDir = ActiveObjRoot + "/lib";
 247       break;
 248     case CMakeBuildModeStyle:
 249       ActiveBinDir = ActiveObjRoot + "/bin/" + build_mode;
 250       ActiveLibDir = ActiveObjRoot + "/lib/" + build_mode;
 251       break;
 252     }
 253
 254     // We need to include files from both the source and object trees.
 255     ActiveIncludeOption = ("-I" + ActiveIncludeDir + " " +
 256                            "-I" + ActiveObjRoot + "/include");
 257   } else {
 258     ActivePrefix = CurrentExecPrefix;
 259     ActiveIncludeDir = ActivePrefix + "/include";
 260     ActiveBinDir = ActivePrefix + "/bin";
 261     ActiveLibDir = ActivePrefix + "/lib";
 262     ActiveIncludeOption = "-I" + ActiveIncludeDir;
 263   }
 264
 265   raw_ostream &OS = outs();
 266   for (int i = 1; i != argc; ++i) {
 267     StringRef Arg = argv[i];
 268
 269     if (Arg.startswith("-")) {
 270       HasAnyOption = true;
 271       if (Arg == "--version") {
 272         OS << PACKAGE_VERSION << '\n';
 273       } else if (Arg == "--prefix") {
 274         OS << ActivePrefix << '\n';
 275       } else if (Arg == "--bindir") {
 276         OS << ActiveBinDir << '\n';
 277       } else if (Arg == "--includedir") {
 278         OS << ActiveIncludeDir << '\n';
 279       } else if (Arg == "--libdir") {
 280         OS << ActiveLibDir << '\n';
 281       } else if (Arg == "--cppflags") {
 282         OS << ActiveIncludeOption << ' ' << LLVM_CPPFLAGS << '\n';
 283       } else if (Arg == "--cflags") {
 284         OS << ActiveIncludeOption << ' ' << LLVM_CFLAGS << '\n';
 285       } else if (Arg == "--cxxflags") {
 286         OS << ActiveIncludeOption << ' ' << LLVM_CXXFLAGS << '\n';
 287       } else if (Arg == "--ldflags") {
 288         OS << "-L" << ActiveLibDir << ' ' << LLVM_LDFLAGS << '\n';
 289       } else if (Arg == "--libs") {
 290         PrintLibs = true;
 291       } else if (Arg == "--libnames") {
 292         PrintLibNames = true;
 293       } else if (Arg == "--libfiles") {
 294         PrintLibFiles = true;
 295       } else if (Arg == "--components") {
 296         for (unsigned j = 0; j != array_lengthof(AvailableComponents); ++j) {
 297           // Only include non-installed components when in a development tree.
 298           if (!AvailableComponents[j].IsInstalled && !IsInDevelopmentTree)
 299             continue;
 300
 301           OS << ' ';
 302           OS << AvailableComponents[j].Name;
 303         }
 304         OS << '\n';
 305       } else if (Arg == "--targets-built") {
 306         OS << LLVM_TARGETS_BUILT << '\n';
 307       } else if (Arg == "--host-target") {
 308         OS << LLVM_DEFAULT_TARGET_TRIPLE << '\n';
 309       } else if (Arg == "--build-mode") {
 310         OS << build_mode << '\n';
 311       } else if (Arg == "--assertion-mode") {
 312 #if defined(NDEBUG)
 313         OS << "OFF\n";
 314 #else
 315         OS << "ON\n";
 316 #endif
 317       } else if (Arg == "--obj-root") {
 318         OS << LLVM_OBJ_ROOT << '\n';
 319       } else if (Arg == "--src-root") {
 320         OS << LLVM_SRC_ROOT << '\n';
 321       } else {
 322         usage();
 323       }
 324     } else {
 325       Components.push_back(Arg);
 326     }
 327   }
 328
 329   if (!HasAnyOption)
 330     usage();
 331
 332   if (PrintLibs || PrintLibNames || PrintLibFiles) {
 333     // If no components were specified, default to "all".
 334     if (Components.empty())
 335       Components.push_back("all");
 336
 337     // Construct the list of all the required libraries.
 338     std::vector<StringRef> RequiredLibs;
 339     ComputeLibsForComponents(Components, RequiredLibs,
 340                              /*IncludeNonInstalled=*/IsInDevelopmentTree);
 341
 342     for (unsigned i = 0, e = RequiredLibs.size(); i != e; ++i) {
 343       StringRef Lib = RequiredLibs[i];
 344       if (i)
 345         OS << ' ';
 346
 347       if (PrintLibNames) {
 348         OS << Lib;
 349       } else if (PrintLibFiles) {
 350         OS << ActiveLibDir << '/' << Lib;
 351       } else if (PrintLibs) {
 352         // If this is a typical library name, include it using -l.
 353         if (Lib.startswith("lib") && Lib.endswith(".a")) {
 354           OS << "-l" << Lib.slice(3, Lib.size()-2);
 355           continue;
 356         }
 357
 358         // Otherwise, print the full path.
 359         OS << ActiveLibDir << '/' << Lib;
 360       }
 361     }
 362
 363     // Print system libs in the next line.
 364     // Assume LLVMSupport depends on system_libs.
 365     // FIXME: LLVMBuild may take care of dependencies to system_libs.
 366     if (PrintLibs)
 367       OS << '\n' << LLVM_SYSTEM_LIBS;
 368
 369     OS << '\n';
 370   } else if (!Components.empty()) {
 371     errs() << "llvm-config: error: components given, but unused\n\n";
 372     usage();
 373   }
 374
 375   return 0;
 376 }