Clang如何处理MSVC的编译参数

LLVM里面的Clang已经可以替换MSVC的cl.exe（MSVC的编译过程的组织程序-driver），作为Visual Studio的独立工具链，能生成PDB文件支持在Visual Studio里面的源代码调试。为了支持替换cl.exe，clang构建会生成可执行文件clang-cl.exe，接收cl.exe的大部分参数而在内部转换成LLVM的参数形式。

虽然看起来是生成了一个单独的clang-cl.exe，它实际上就是clang.exe的一个副本，如果程序名是clang.exe，还可以在命令行传递"--driver-mode=cl"参数启用cl.exe的参数解析模式。所以clang-cl.exe和clang.exe是一样的，都接受"--target=i686-pc-windows", 但是为什么clang-cl.exe却不能解析"-triple i686-pc-windows"而clang.exe却可以呢？

程序本身通过检查自身的文件名（argv[0]）来检测是不是要运行在兼容MSVC cl.exe的模式，如果文件名是"clang-cl.exe"，则把对应的DriverMode放到main函数开始处的变量TargetAndMode里面（ToolChain::getTargetAndModeFromProgramName）。下面的代码显示了对应关系，可以看到把文件名clang.exe改成cl.exe也会有一样的效果。

// llvm_root\tools\clang\tools\driver\driver.cpp
const DriverSuffix *FindDriverSuffix(StringRef ProgName, size_t &Pos) {
  // A list of known driver suffixes. Suffixes are compared against the
  // program name in order. If there is a match, the frontend type is updated as
  // necessary by applying the ModeFlag.
  static const DriverSuffix DriverSuffixes[] = {
      {"clang", nullptr},
      {"clang++", "--driver-mode=g++"},
      {"clang-c++", "--driver-mode=g++"},
      {"clang-cc", nullptr},
      {"clang-cpp", "--driver-mode=cpp"},
      {"clang-g++", "--driver-mode=g++"},
      {"clang-gcc", nullptr},
      {"clang-cl", "--driver-mode=cl"},
      {"cc", nullptr},
      {"cpp", "--driver-mode=cpp"},
      {"cl", "--driver-mode=cl"},
      {"++", "--driver-mode=g++"},
  };

在上面从程序名解析出target和mode后，main函数里面紧接着的代码检查了返回的mode和命令行参数，只要以一个满足则进入ClangCLMode。不过这里解析出来的ClangCLMode只用来处理命令行参数的分隔和cl.exe特有的环境变量，包括"CL"和"_CL_"。

// llvm_root\tools\clang\tools\driver\driver.cpp
  auto TargetAndMode = ToolChain::getTargetAndModeFromProgramName(argv[0]);

  bool ClangCLMode = false;
  if (StringRef(TargetAndMode.DriverMode).equals("--driver-mode=cl") ||
      std::find_if(argv.begin(), argv.end(), [](const char *F) {
        return F && strcmp(F, "--driver-mode=cl") == 0;
      }) != argv.end()) {
    ClangCLMode = true;
  }

再从main函数进入Driver类的对象TheDriver的BuildCompilation方法后，会调用 ParseDriverMode方法，里面会根据程序名重新获得driver mode（ToolChain::getTargetAndModeFromProgramName），然后把driver mode字符串传给下面的setDriverModeFromOption方法。这个方法根据传入的driver mode选项设置成员变量Mode.

// llvm_root\tools\clang\lib\driver\driver.cpp
void Driver::setDriverModeFromOption(StringRef Opt) {
  const std::string OptName =
      getOpts().getOption(options::OPT_driver_mode).getPrefixedName();
  if (!Opt.startswith(OptName))
    return;
  StringRef Value = Opt.drop_front(OptName.size());

  const unsigned M = llvm::StringSwitch<unsigned>(Value)
                         .Case("gcc", GCCMode)
                         .Case("g++", GXXMode)
                         .Case("cpp", CPPMode)
                         .Case("cl", CLMode)
                         .Default(~0U);

  if (M != ~0U)
    Mode = static_cast<DriverMode>(M);

上面的Driver类的对象已经知道当前Mode，比如CLMode，下面会组织整个编译过程，包括调用编译器(clang.exe -cc1)和链接器(MSVC的link或者lld-link)。

BuildCompilation紧接着会调用ParseArgStrings。ParseArgStrings调用下面的getIncludeExcludeOptionFlagMask，根据Driver的当前Mode得到include mask和exclude mask两个掩码，用于后面（在调用链ParseArgString->ParseArg->ParseOneArg的最后的方法ParseOneArg里面）决定是否接受命令行参数。比如在CLMode下就只会接受ClOption和CoreOption。

// llvm_root\tools\clang\lib\driver\driver.cpp
std::pair<unsigned, unsigned> Driver::getIncludeExcludeOptionFlagMasks() const {
  unsigned IncludedFlagsBitmask = 0;
  unsigned ExcludedFlagsBitmask = options::NoDriverOption;

  if (Mode == CLMode) {
    // Include CL and Core options.
    IncludedFlagsBitmask |= options::CLOption;
    IncludedFlagsBitmask |= options::CoreOption;
  } else {
    ExcludedFlagsBitmask |= options::CLOption;
  }

  return std::make_pair(IncludedFlagsBitmask, ExcludedFlagsBitmask);
}

那么CLOption和CoreOption都有哪些具体参数呢？Clang的所有命令行参数选项都定义在llvm_root\tools\clang\include\clang\driver\Options.td里面，由tablegen转成C/C++头文件而被代码引用。下面是从里面截取的target的定义，看到"--target="选项是同时属于DriverOption和CoreOption，而CoreOption在CLMode和非CLMode下均能使用。

def target : Joined<["--"], "target=">, Flags<[DriverOption, CoreOption]>,
  HelpText<"Generate code for the given target">;

以下是"-target"的定义，没有定义Flags，所以在CLMode下也就不能解析，这也就解释了最开始"clang-cl.exe"不接受"-triple i686-pc-windows"参数。

def target_legacy_spelling : Separate<["-"], "target">, Alias<target>;