sepavloff updated this revision to Diff 78167.
sepavloff added a comment.
Limit the patch by named configuration files only
Follow advice of @mgorny and removed all features from the patch except
named config files. These are files specified explicitly by option
`--config` or encoded in executable name, such as `armv7l-clang`. This
kind of configuration files did not cause objections except that "this
functionality is already available with `@file`". In contrast to `@file`
configuration files have advantages:
- they is searched in well-known places rather than in current directory,
- they may contain comments,
- they may include other files by `@file` and these files are resolved relative
to the including file.
- they may be encoded in executable name; such encoding is already used by
clang to specify targets.
Also added section about config files to the user manual.
https://reviews.llvm.org/D24933
Files:
docs/UsersManual.rst
include/clang/Driver/Driver.h
lib/Driver/Driver.cpp
test/Driver/Inputs/config-1.cfg
test/Driver/Inputs/config-2.cfg
test/Driver/config-file.c
tools/driver/driver.cpp
Index: tools/driver/driver.cpp
===================================================================
--- tools/driver/driver.cpp
+++ tools/driver/driver.cpp
@@ -305,6 +305,34 @@
return 1;
}
+// Directories searched for configuration specified by option '--config'.
+static const char * const SearchDirs[] = { "~/.llvm" };
+
+/// Deduce configuration name if it is encoded in the executable name.
+///
+/// \param ConfigFile [out] Is assigned configuration file path.
+/// \param ProgramName [in] clang executable path.
+/// \return True if configuration file was found.
+///
+/// If clang executable is named e.g. 'armv7l-clang' the function tries to
+/// find config file 'armv7l.cfg'. If it is found, its path is put into
+/// ConfigFile and the function returns true.
+///
+static bool findConfigFileFromProgramName(
+ llvm::SmallVectorImpl<char> &ConfigFile, StringRef ProgramName) {
+ ConfigFile.clear();
+ StringRef PName = llvm::sys::path::stem(ProgramName);
+ size_t Pos = PName.find("-clang");
+ if (Pos != StringRef::npos) {
+ ConfigFile.append(PName.begin(), PName.begin() + Pos);
+ const StringRef Ext(".cfg");
+ ConfigFile.append(Ext.begin(), Ext.end());
+ StringRef CName(ConfigFile.begin(), ConfigFile.size());
+ return llvm::cl::searchForFile(ConfigFile, SearchDirs, ProgramName, CName);
+ }
+ return false;
+}
+
int main(int argc_, const char **argv_) {
llvm::sys::PrintStackTraceOnErrorSignal(argv_[0]);
llvm::PrettyStackTraceProgram X(argc_, argv_);
@@ -330,6 +358,31 @@
llvm::BumpPtrAllocator A;
llvm::StringSaver Saver(A);
+ // Try reading options from configuration file.
+ llvm::SmallString<128> ConfigFile;
+ llvm::cl::SearchResult SRes;
+
+ // First try config file specified in command line. It has higher priority
+ // than any other way to specify configuration.
+ SRes = llvm::cl::findConfigFileFromArgs(ConfigFile, argv, SearchDirs, true);
+ if (llvm::cl::checkConfigFileSearchResult(SRes, ConfigFile, SearchDirs,
+ ProgName))
+ return 1;
+
+ // If config file is not specified explicitly, try to determine configuration
+ // implicitly. First try to deduce configuration from executable name. For
+ // instance, a file 'armv7l-clang' applies config file 'armv7l.cfg'. Second,
+ // try to find file 'clang.cfg'.
+ if (SRes == llvm::cl::SearchResult::NotSpecified) {
+ if (findConfigFileFromProgramName(ConfigFile, ProgName))
+ SRes = llvm::cl::SearchResult::Successful;
+ }
+
+ if (SRes == llvm::cl::SearchResult::Successful) {
+ unsigned NumOpts;
+ llvm::cl::readConfigFile(ConfigFile, Saver, argv, NumOpts);
+ }
+
// Parse response files using the GNU syntax, unless we're in CL mode. There
// are two ways to put clang in CL compatibility mode: argv[0] is either
// clang-cl or cl, or --driver-mode=cl is on the command line. The normal
@@ -446,6 +499,8 @@
ProcessWarningOptions(Diags, *DiagOpts, /*ReportDiags=*/false);
Driver TheDriver(Path, llvm::sys::getDefaultTargetTriple(), Diags);
+ if (!ConfigFile.empty())
+ TheDriver.setConfigFile(ConfigFile.str());
SetInstallDir(argv, TheDriver, CanonicalPrefixes);
insertTargetAndModeArgs(TargetAndMode.first, TargetAndMode.second, argv,
Index: test/Driver/config-file.c
===================================================================
--- /dev/null
+++ test/Driver/config-file.c
@@ -0,0 +1,22 @@
+// RUN: %clang --config %S/Inputs/config-1.cfg -c %s -### 2>&1 | FileCheck %s -check-prefix CHECK-HHH
+// CHECK-HHH: Target: x86_64-apple-darwin
+// CHECK-HHH: Configuration file: {{.*}}/Inputs/config-1.cfg
+// CHECK-HHH: -Werror
+// CHECK-HHH: -std=c99
+
+// RUN: not %clang --config %S/Inputs/inexistent.cfg -c %s -### 2>&1 | FileCheck %s -check-prefix CHECK-INEX
+// CHECK-INEX: Configuration file {{.*}}/Inputs/inexistent.cfg' specified by option '--config' cannot be found
+
+// RUN: not %clang --config inexistent.cfg -c %s -### 2>&1 | FileCheck %s -check-prefix CHECK-INEX-NOSEARCH
+// CHECK-INEX-NOSEARCH: Configuration {{.*}}inexistent.cfg' specified by option '--config' cannot be found in directories:
+// CHECK-INEX-NOSEARCH: ~/.llvm
+// CHECK-INEX-NOSEARCH: /etc/llvm
+
+// RUN: %clang --config %S/Inputs/config-2.cfg -### 2>&1 | FileCheck %s -check-prefix CHECK-HHH-NOFILE
+// CHECK-HHH-NOFILE: Target: x86_64-unknown-linux
+// CHECK-HHH-NOFILE: Configuration file: {{.*}}/Inputs/config-2.cfg
+
+// RUN: %clang --config %S/Inputs/config-1.cfg -c %s -v 2>&1 | FileCheck %s -check-prefix CHECK-V
+// CHECK-V: Target: x86_64-apple-darwin
+// CHECK-V: Configuration file: {{.*}}/Inputs/config-1.cfg
+// CHECK-V: -triple{{.*}}x86_64-apple-
Index: test/Driver/Inputs/config-2.cfg
===================================================================
--- /dev/null
+++ test/Driver/Inputs/config-2.cfg
@@ -0,0 +1,2 @@
+# target
+-target x86_64-unknown-linux-gnu
Index: test/Driver/Inputs/config-1.cfg
===================================================================
--- /dev/null
+++ test/Driver/Inputs/config-1.cfg
@@ -0,0 +1,7 @@
+
+
+# Empty lines and line started with # are ignored
+-Werror -std=\
+c99
+ # Target
+ -target x86_64-apple-darwin
\ No newline at end of file
Index: lib/Driver/Driver.cpp
===================================================================
--- lib/Driver/Driver.cpp
+++ lib/Driver/Driver.cpp
@@ -967,6 +967,10 @@
// Print out the install directory.
OS << "InstalledDir: " << InstalledDir << '\n';
+
+ // If configuration file was used, print its path.
+ if (!ConfigFile.empty())
+ OS << "Configuration file: " << ConfigFile << '\n';
}
/// PrintDiagnosticCategories - Implement the --print-diagnostic-categories
Index: include/clang/Driver/Driver.h
===================================================================
--- include/clang/Driver/Driver.h
+++ include/clang/Driver/Driver.h
@@ -207,6 +207,9 @@
/// Name to use when invoking gcc/g++.
std::string CCCGenericGCCName;
+ /// Name of configuration file if used.
+ std::string ConfigFile;
+
/// Whether to check that input files exist when constructing compilation
/// jobs.
unsigned CheckInputsExist : 1;
@@ -258,6 +261,9 @@
/// Name to use when invoking gcc/g++.
const std::string &getCCCGenericGCCName() const { return CCCGenericGCCName; }
+ const std::string &getConfigFile() const { return ConfigFile; }
+ void setConfigFile(StringRef x) { ConfigFile = x; }
+
const llvm::opt::OptTable &getOpts() const { return *Opts; }
const DiagnosticsEngine &getDiags() const { return Diags; }
Index: docs/UsersManual.rst
===================================================================
--- docs/UsersManual.rst
+++ docs/UsersManual.rst
@@ -644,6 +644,55 @@
option tells Clang to put double-quotes around the entire filename, which
is the convention used by NMake and Jom.
+Configuration files
+-------------------
+
+Configuration files group command line options and allow to specify all of
+them just by referencing the configuration file. They may be used, for
+instance to collect options required to tune compilation for particular
+target, such as -L, -I, -l, --sysroot, codegen options etc.
+
+Command line option `--config` can be used to specify configuration file in
+a clang invocation. For instance:
+
+::
+
+ clang --config /home/user/cfgs/testing.txt
+ clang --config debug
+ clang --config debug.cfg
+
+If the provided argument contains a directory separator, it is considered as
+a file path, options are read from that file. Otherwise the argument is appended
+extension `cfg` if it is not specified yet, and the obtained file name is searched
+for in the directories: `~/.llvm` and the directory where clang executable resides.
+The first found file is used. It is an error if the required file cannot be found.
+
+Another way to specify configuration file is to encode it in executable name. For
+instance, if clang executable is named `armv7l-clang` (it may be a symbolic link
+to `clang`), then clang will search file `armv7l.cfg` in the same directories, as
+if it was specified by `--config` option.
+
+The configuration file consists of command line options specified on one or several
+lines. Lines composed of whitespace characters only are ignored as well as lines in
+which the first non-blank character is `#`. Long options may be split between several
+lines by trailing backslash. Here is an example of config file:
+
+::
+
+ # Several options on line
+ -c --target=x86_64-unknown-linux-gnu
+
+ # Long option split between lines
+ -I/usr/lib/gcc/x86_64-linux-gnu/5.4.0/../../../../\
+ include/c++/5.4.0
+
+ # other config files may be included
+ @linux.options
+
+Files included by directives `@file` in configuration files are resolved relative to
+the including file. For instance if a config file `~/.llvm/target.cfg` contains
+directive `os/linux.opts`, the file `linux.opts` is searched for in the directory
+`~/.llvm/os`.
Language and Target-Independent Features
========================================
_______________________________________________
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
