深刻研究Clang(九) Clang代碼閱讀之打log讀流程2

繼續上一篇，一樣的hello.c，一樣的執行過程，只不過繼續添加了一些log信息，並且對代碼進行了更近一步的挖掘。先看輸入和輸出的log信息（前半部分）：

shining@shining-VirtualBox:~/llvm-3.9.0/build/bin$ ./clang hello.c -o hello
clang/tools/driver/driver.cpp/main()_begin/shining_add
clang/lib/Driver/Driver.cpp/BuildCompilation()_begin/shining_add
clang/lib/Driver/ToolChains.cpp/Linux()_begin/shining_add
clang/lib/Driver/Tools.cpp/Clang::ConstructJob()_beforeCC1/shining_add
clang/lib/Driver/Driver.cpp/ExecuteCompilation()_begin/shining_add
clang/lib/Driver/Compilation.cpp/ExecuteJobs()_begin/shining_add
clang/lib/Driver/Compilation.cpp/ExecuteCommand()_begin/shining_add
clang/lib/Driver/Job.cpp/Execute()_begin/shining_add
llvm/lib/Support/Program.cpp/ExecuteAndWait()_begin/shining_add
llvm/lib/Support/Unix/Program.inc/Execute()_begin/shining_add
llvm/lib/Support/Unix/Program.inc/Execute()_begin/shining_add333
llvm/lib/Support/Unix/Program.inc/Execute()_begin/shining_add444
clang/tools/driver/driver.cpp/main()_begin/shining_add
clang/tools/driver/driver.cpp/ExecuteCC1Tool()/shining_add
clang/tools/driver/cc1_main.cpp/cc1_main()/shining_add

-----------------------------------------------------------------------------------------------------

這個時候，程序已經經過了對命令行輸入的第一次初步執行，執行了clang/tools/driver/driver.cpp中的main()函數，而且添加了不少命令行的具體參數，而且新建線程開始第二次執行clang/tools/driver/driver.cpp中的main()函數。在第二次執行main()函數的時候，選擇了和第一次執行徹底不一樣的路徑，這是由於第一遍執行main()函數的調用過程當中，已經爲命令行添加了-cc1的參數選項。因此，第二次執行main()函數的時候，會選擇執行main()函數的調用ExecuteCC1Tool()的分支，具體代碼以下：

  if (FirstArg != argv.end() && StringRef(*FirstArg).startswith("-cc1")) {
    // If -cc1 came from a response file, remove the EOL sentinels.
    if (MarkEOLs) {
      auto newEnd = std::remove(argv.begin(), argv.end(), nullptr);
      argv.resize(newEnd - argv.begin());
    }
    return ExecuteCC1Tool(argv, argv[1] + 4);
  }

-------------------------------------------------------------------------------------------------------

如今再回頭對這個過程當中的代碼進行分析，第一次執行clang/tools/driver/driver.cpp中的main()函數的時候，下面的代碼是核心部分：

  std::unique_ptr<Compilation> C(TheDriver.BuildCompilation(argv));
  int Res = 0;
  SmallVector<std::pair<int, const Command *>, 4> FailingCommands;
  if (C.get())
    Res = TheDriver.ExecuteCompilation(*C, FailingCommands);

主要是TheDriver的BuildCompilation和ExecuteCompilation的兩個函數的執行，並且這兩個是一個順序的過程，先build再execute。其中，TheDriver是Driver類的一個具體對象，而Driver類的具體實現是在clang/lib/Driver/Driver.cpp中。也就是說，其實clang的代碼裏面，有兩個driver相關目錄，並各自包含一些文件，以driver直接命名的cpp文件舉例：tools/driver/driver.cpp和lib/Driver/Driver.cpp，前者是驅動編譯器的驅動，然後者是Driver類的具體實現。這兩個具體文件的差異，基本上也表明了兩個目錄的主要用途。

------------------------------------------------------------------------------------------------------

Driver類的BuildCompilation方法，經過調用關係，最終調用了clang/lib/Driver/Tools.cpp裏的Clang::ConstructJob()函數，這個函數很重要的一個動做就是爲了命令行的參數列表添加了「-cc1」參數，這個動做爲第二次執行clang/tools/driver/driver.cpp中的main()函數的路徑起了決定性的做用。

  // Invoke ourselves in -cc1 mode.
  //
  // FIXME: Implement custom jobs for internal actions.
  CmdArgs.push_back("-cc1");

------------------------------------------------------------------------------------------------------

Driver類的ExecuteCompilation方法，經過調用關係，最終調用Compilation類的幾個方法，而且在clang/lib/Driver/Job.cpp/Command::Execute()函數的內部，開始調用llvm部分的support代碼llvm/lib/Support/Program.cpp中的llvm::sys::ExecuteAndWait()。

//===----------------------------------------------------------------------===//
//=== WARNING: Implementation here must contain only TRULY operating system
//===          independent code.
//===----------------------------------------------------------------------===//
static bool Execute(ProcessInfo &PI, StringRef Program, const char **args,
                    const char **env, const StringRef **Redirects,
                    unsigned memoryLimit, std::string *ErrMsg);

int sys::ExecuteAndWait(StringRef Program, const char **args, const char **envp,
                        const StringRef **redirects, unsigned secondsToWait,
                        unsigned memoryLimit, std::string *ErrMsg,
                        bool *ExecutionFailed) {
  ProcessInfo PI;
  if (Execute(PI, Program, args, envp, redirects, memoryLimit, ErrMsg)) {
    if (ExecutionFailed)
      *ExecutionFailed = false;
    ProcessInfo Result = Wait(
        PI, secondsToWait, /*WaitUntilTerminates=*/secondsToWait == 0, ErrMsg);
    return Result.ReturnCode;
  }

  if (ExecutionFailed)
    *ExecutionFailed = true;

  return -1;
}

llvm::sys::ExecuteAndWait()調用了Execute()函數，而Execute()函數則會根據不一樣的操做系統有不一樣的實現。我使用的環境是Ubuntu16.10，因此Execute()函數的具體實現就在llvm/lib/Support/Unix/Program.inc中。相應的此處也有一個llvm/lib/Support/Windows/目錄，存放Windows操做系統所對應的相關代碼實現。在llvm/lib/Support/Unix/Program.inc中Execute()函數的具體實現過程當中有

#ifdef HAVE_POSIX_SPAWN

......

#endif

這樣的宏開關，這個宏開關在個人本地環境是可用的，因此具體執行了其中的

    int Err = posix_spawn(&PID, Program.str().c_str(), FileActions,
                          /*attrp*/nullptr, const_cast<char **>(args),
                          const_cast<char **>(envp));

根據Execute()函數中的相關注釋：

  // If this OS has posix_spawn and there is no memory limit being implied, use
  // posix_spawn.  It is more efficient than fork/exec.

能夠看出，這個實現方式是要比fork/exec的執行效率要高，因此在個人環境下，代碼走的就是這個路徑，而沒有執行下面的

#endif
  // Create a child process.
  int child = fork();
  switch (child) {

這部分代碼。posix_spawn或者fork就是爲了創建新的線程，從而從新執行clang/tools/driver/driver.cpp中的main()函數，因此纔有了第二次執行clang/tools/driver/driver.cpp中的main()函數的出發點。

------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

代碼和修改後的代碼，我也見了一個代碼庫，地址： https://github.com/shining1984/clang_code_comment