Skip to content

[flang][driver] Introduce FCC_OVERRIDE_OPTIONS. #140556

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion clang/include/clang/Driver/Driver.h
Original file line number Diff line number Diff line change
Expand Up @@ -879,7 +879,7 @@ llvm::Error expandResponseFiles(SmallVectorImpl<const char *> &Args,
/// See applyOneOverrideOption.
void applyOverrideOptions(SmallVectorImpl<const char *> &Args,
const char *OverrideOpts,
llvm::StringSet<> &SavedStrings,
llvm::StringSet<> &SavedStrings, StringRef EnvVar,
raw_ostream *OS = nullptr);

} // end namespace driver
Expand Down
9 changes: 5 additions & 4 deletions clang/lib/Driver/Driver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -7199,9 +7199,10 @@ static const char *GetStableCStr(llvm::StringSet<> &SavedStrings, StringRef S) {
///
/// '#': Silence information about the changes to the command line arguments.
///
/// '^': Add FOO as a new argument at the beginning of the command line.
/// '^FOO': Add FOO as a new argument at the beginning of the command line
/// right after the name of the compiler executable.
///
/// '+': Add FOO as a new argument at the end of the command line.
/// '+FOO': Add FOO as a new argument at the end of the command line.
///
/// 's/XXX/YYY/': Substitute the regular expression XXX with YYY in the command
/// line.
Expand Down Expand Up @@ -7289,7 +7290,7 @@ static void applyOneOverrideOption(raw_ostream &OS,
void driver::applyOverrideOptions(SmallVectorImpl<const char *> &Args,
const char *OverrideStr,
llvm::StringSet<> &SavedStrings,
raw_ostream *OS) {
StringRef EnvVar, raw_ostream *OS) {
if (!OS)
OS = &llvm::nulls();

Expand All @@ -7298,7 +7299,7 @@ void driver::applyOverrideOptions(SmallVectorImpl<const char *> &Args,
OS = &llvm::nulls();
}

*OS << "### CCC_OVERRIDE_OPTIONS: " << OverrideStr << "\n";
*OS << "### " << EnvVar << ": " << OverrideStr << "\n";

// This does not need to be efficient.

Expand Down
2 changes: 1 addition & 1 deletion clang/tools/driver/driver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ int clang_main(int Argc, char **Argv, const llvm::ToolContext &ToolContext) {
if (const char *OverrideStr = ::getenv("CCC_OVERRIDE_OPTIONS")) {
// FIXME: Driver shouldn't take extra initial argument.
driver::applyOverrideOptions(Args, OverrideStr, SavedStrings,
&llvm::errs());
"CCC_OVERRIDE_OPTIONS", &llvm::errs());
}

std::string Path = GetExecutablePath(ToolContext.Path, CanonicalPrefixes);
Expand Down
28 changes: 28 additions & 0 deletions flang/docs/FlangDriver.md
Original file line number Diff line number Diff line change
Expand Up @@ -614,3 +614,31 @@ nvfortran defines `-fast` as
- `-Mcache_align`: there is no equivalent flag in Flang or Clang.
- `-Mflushz`: flush-to-zero mode - when `-ffast-math` is specified, Flang will
link to `crtfastmath.o` to ensure denormal numbers are flushed to zero.


## FCC_OVERRIDE_OPTIONS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I noticed that clang/docs doesn't have the documentation. Perhaps we should document clang/docs/UsersManual.rst as well and reference it from FlangDriver.md?

("Each edit should be one of the following forms:" list should probably reference the clang doc)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will add clang documentation in a separate PR. The FCC_OVERRIDE_OPTIONS one can then probably just refer to it.


The environment variable `FCC_OVERRIDE_OPTIONS` can be used to edit flang's
command line arguments. The value of this variable is a space-separated list of
edits to perform. The edits are applied in the order in which they appear in
`FCC_OVERRIDE_OPTIONS`. Each edit should be one of the following form:

- `#`: Silence information about the changes to the command line arguments.

- `^FOO`: Add `FOO` as a new argument at the beginning of the command line right
after the name of the compiler executable.

- `+FOO`: Add `FOO` as a new argument at the end of the command line.

- `s/XXX/YYY/`: Substitute the regular expression `XXX` with `YYY` in the
command line.

- `xOPTION`: Removes all instances of the literal argument `OPTION`.

- `XOPTION`: Removes all instances of the literal argument `OPTION`, and the
following argument.

- `Ox`: Removes all flags matching `O` or `O[sz0-9]` and adds `Ox` at the end
of the command line.

This environment variable does not affect the options added by the config files.
1 change: 1 addition & 0 deletions flang/test/Driver/Inputs/config-7.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
-Werror
17 changes: 17 additions & 0 deletions flang/test/Driver/fcc_override.f90
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
! RUN: env FCC_OVERRIDE_OPTIONS="#+-Os +-Oz +-O +-O3 +-Oignore +a +b +c xb Xa Omagic ^-### " %flang --target=x86_64-unknown-linux-gnu %s -O2 b -O3 2>&1 | FileCheck %s
! RUN: env FCC_OVERRIDE_OPTIONS="x-Werror +-g" %flang --target=x86_64-unknown-linux-gnu -Werror %s -c -### 2>&1 | FileCheck %s -check-prefix=RM-WERROR
! RUN: env FCC_OVERRIDE_OPTIONS="x-Werror" %flang --config=%S/Inputs/config-7.cfg -### %s -c 2>&1 | FileCheck %s -check-prefix=CONF

! CHECK: "-fc1"
! CHECK-NOT: "-Oignore"
! CHECK: "-Omagic"
! CHECK-NOT: "-Oignore"

! RM-WERROR: ### FCC_OVERRIDE_OPTIONS: x-Werror +-g
! RM-WERROR-NEXT: ### Deleting argument -Werror
! RM-WERROR-NEXT: ### Adding argument -g at end
! RM-WERROR-NOT: "-Werror"

! Test that FCC_OVERRIDE_OPTIONS does not affect the options from config files.
! CONF: ### FCC_OVERRIDE_OPTIONS: x-Werror
! CONF: "-Werror"
7 changes: 7 additions & 0 deletions flang/tools/flang-driver/driver.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,13 @@ int main(int argc, const char **argv) {
}
}

llvm::StringSet<> savedStrings;
// Handle FCC_OVERRIDE_OPTIONS, used for editing a command line behind the
// scenes.
if (const char *overrideStr = ::getenv("FCC_OVERRIDE_OPTIONS"))
clang::driver::applyOverrideOptions(args, overrideStr, savedStrings,
"FCC_OVERRIDE_OPTIONS", &llvm::errs());

// Not in the frontend mode - continue in the compiler driver mode.

// Create DiagnosticsEngine for the compiler driver
Expand Down