Clang-cl如何實現處理MSVC的編譯參數

來自專欄 Debugging ChakraCore4 人贊了文章

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 oolsclang oolsdriverdriver.cppconst 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 oolsclang oolsdriverdriver.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 oolsclanglibdriverdriver.cppvoid 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 oolsclanglibdriverdriver.cppstd::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 oolsclangincludeclangdriverOptions.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>;