Merge pull request #37423 from nkcsgexi/78021402

driver: emit a warning when user specified flags to disable the new driver

Author: nkcsgexi

include/swift/AST/DiagnosticsDriver.def

@@ -175,5 +175,8 @@ WARNING(warn_drv_darwin_sdk_invalid_settings, none,
 
 WARNING(warning_unsupported_driver_option,none,
         "option '%0' is ony supported in swift-driver", (StringRef))
+
+WARNING(old_driver_deprecated,none,
+        "legacy driver is now deprecated; consider avoiding specifying `%0`", (StringRef))
 #define UNDEFINE_DIAGNOSTIC_MACROS
 #include "DefineDiagnosticMacros.h"

test/lit.cfg

@@ -672,6 +672,7 @@ if not 'swift_driver' in lit_config.params:
 if swift_test_subset != 'only_early_swiftdriver' and\
    os.environ.get('SWIFT_FORCE_TEST_NEW_DRIVER') is None:
     config.environment['SWIFT_USE_OLD_DRIVER'] = '1'
+    config.environment['SWIFT_AVOID_WARNING_USING_OLD_DRIVER'] = '1'
 
 # Enable benchmark testing when the binary is found (has fully qualified path).
 if config.benchmark_o != 'Benchmark_O':

tools/driver/driver.cpp

@@ -134,19 +134,28 @@ static bool shouldRunAsSubcommand(StringRef ExecName,
   return true;
 }
 
-static bool shouldDisallowNewDriver(StringRef ExecName,
+static bool shouldDisallowNewDriver(DiagnosticEngine &diags,
+                                    StringRef ExecName,
                                     const ArrayRef<const char *> argv) {
   // We are not invoking the driver, so don't forward.
   if (ExecName != "swift" && ExecName != "swiftc") {
     return true;
   }
+  StringRef disableArg = "-disallow-use-new-driver";
+  StringRef disableEnv = "SWIFT_USE_OLD_DRIVER";
+  auto shouldWarn = !llvm::sys::Process::
+    GetEnv("SWIFT_AVOID_WARNING_USING_OLD_DRIVER").hasValue();
   // If user specified using the old driver, don't forward.
-  if (llvm::find_if(argv, [](const char* arg) {
-    return StringRef(arg) == "-disallow-use-new-driver";
+  if (llvm::find_if(argv, [&](const char* arg) {
+    return StringRef(arg) == disableArg;
   }) != argv.end()) {
+    if (shouldWarn)
+      diags.diagnose(SourceLoc(), diag::old_driver_deprecated, disableArg);
     return true;
   }
-  if (llvm::sys::Process::GetEnv("SWIFT_USE_OLD_DRIVER").hasValue()) {
+  if (llvm::sys::Process::GetEnv(disableEnv).hasValue()) {
+    if (shouldWarn)
+      diags.diagnose(SourceLoc(), diag::old_driver_deprecated, disableEnv);
     return true;
   }
   return false;
@@ -208,7 +217,7 @@ static int run_driver(StringRef ExecName,
 
   // Forwarding calls to the swift driver if the C++ driver is invoked as `swift`
   // or `swiftc`, and an environment variable SWIFT_USE_NEW_DRIVER is defined.
-  if (!shouldDisallowNewDriver(ExecName, argv)) {
+  if (!shouldDisallowNewDriver(Diags, ExecName, argv)) {
     SmallString<256> NewDriverPath(llvm::sys::path::parent_path(Path));
     if (appendSwiftDriverName(NewDriverPath) &&
         llvm::sys::fs::exists(NewDriverPath)) {