visual-studio - 为什么 MSBuild 将 .tlog 文件生成到 CMakeFiles/CompilerIdC 中，我该如何让它停止？

Question

我有一个 CMake 项目，我的一个构建是在 Visual Studio 上使用 MSBuild 在 TeamCity 构建服务器上进行的。

我看到的是在运行 git clean -f -d -x 时经常失败(这是 TeamCity 在初始化构建时自己执行的一个步骤，作为源检查的一部分)。它失败的原因是因为 .tlog 文件正在生成到我的 CMake 构建文件夹中——进入 CMake 的内部 CompilerIdC 项目，CMake 使用它来识别本地 C 编译器。

什么是 .tlog 文件，是什么触发了它们的创建？我还没有找到这方面的文档。

我不明白为什么它们在 CMake 的运行和构建已经完成后 出现。我特别不明白为什么在所有 CompilerIdC 的源文件和项目文件都被删除后超过十五分钟才创建它们。

详情

文件正在生成到 ${CMAKE_BUILD_DIR}/CMakeFiles/3.5.2/CompilerIdC/Debug/CompilerIdC.tlog 中。它们都是 link-VCTIP.(read|write|delete).*.tlog 的形式。

这是在 git clean 上失败并在 08:41 停止(当前截至 09:30)的构建的文件夹状态:

-rw-r--r-- 1 CI 197121  570 Jun 28 08:57 link-VCTIP.delete.1.tlog
-rw-r--r-- 1 CI 197121 1422 Jun 28 08:57 link-VCTIP.delete.26.tlog
-rw-r--r-- 1 CI 197121 7062 Jun 28 08:57 link-VCTIP.read.1.tlog
-rw-r--r-- 1 CI 197121  402 Jun 28 08:50 link-VCTIP.read.103.tlog
-rw-r--r-- 1 CI 197121  402 Jun 28 08:55 link-VCTIP.read.120.tlog
-rw-r--r-- 1 CI 197121  418 Jun 28 08:57 link-VCTIP.read.26.tlog
-rw-r--r-- 1 CI 197121  286 Jun 28 08:57 link-VCTIP.read.27.tlog
-rw-r--r-- 1 CI 197121  286 Jun 28 08:57 link-VCTIP.read.28.tlog
-rw-r--r-- 1 CI 197121  286 Jun 28 08:57 link-VCTIP.read.29.tlog
-rw-r--r-- 1 CI 197121  402 Jun 28 08:45 link-VCTIP.read.87.tlog
-rw-r--r-- 1 CI 197121  600 Jun 28 08:57 link-VCTIP.write.1.tlog
-rw-r--r-- 1 CI 197121  286 Jun 28 08:57 link-VCTIP.write.26.tlog

构建日志如下所示:

[08:39:58][VCS Root: MyVCS] [D:\TeamCity\buildAgent\work\58a2d5637a76fb3e]: "C:\Program Files\Git\bin\git.exe" clean -f -d -x
[08:41:26][VCS Root: MyVCS] warning: failed to remove build/Windows-x64-Release/: Directory not empty
[08:41:27]
[Updating sources] Failed to perform checkout on agent: '"C:\Program Files\Git\bin\git.exe" clean -f -d -x' command failed.
stdout: Removing Artifacts/x64/
<snip>
Removing build/Windows-x64-Release/CMakeFiles
<snip>
stderr: warning: failed to remove build/Windows-x64-Release/: Directory not empty

版本信息

我使用的工具是:

• MSBuild 14.0
• CMake 3.5.2
• TeamCity 专业版 9.1.7

Answer 1

什么是.tlog文件？

它们由 MSBuild 的文件跟踪器输出，它包装了 Visual C++ 构建可执行文件(例如 cl.exe 和 link.exe)以跟踪它写入的文件和读自。它将这些文件路径记录在中间目录的 .tlog 文件中，并依赖于这些文件路径来定义应如何构建增量构建。

(来源:Inside the Microsoft Build Engine: Using MSBuild and Team Foundation Build，作者 Sayed Hashimi 和 William Bartholomew。)

是什么触发了他们的创作？

对 MSBuild 的任何使用都可以触发 .tlog 文件的创建或更新。

为什么这些文件出现这么晚？

写入.tlog 文件的进程之一是vctip.exe。 2018 年 3 月，Microsoft 工程师 Ian Bearman(VC++ 遥测所有者)explained :

This small application is a background process that runs during the build and allows the VC++ tools to communicate with the VS Telemetry Service (also known as VS Experience Improvement Program). The application stays running after a build in case another build is started immediately to help speed up compilation.

I understand that the current timeout (approaching something like 15 minutes) is way too long.

所以，答案是:即使在构建结束后，后台进程仍然存在，在这种情况下，即使在删除所有相关文件后，它也会继续尝试将遥测文件写入其目录。

我该如何解决？

Bearman 建议 two solutions :

1. 升级 Visual Studio。

   Upcoming releases of Visual Studio (starting with VS 2017 15.7, now in preview) will shorten the time this stays running down to 15 seconds after the last build. Hopeful this will resolve any issues you have with this program staying running.

(我没有尝试升级，所以我无法确认这是否解决了问题。我还感兴趣地注意到 an earlier bug report 非常相同的问题，用 a promise in March 2018 回答了最近的更新已经修复了问题。)

1. 手动终止 vctip.exe。

In the meantime, to workaround this problem feel free to manually kill vctip.exe at any time. You can use the Windows command taskkill /IM vctip.exe to stop it immediately. This is always safe to do without fear of data-loss or corruption.

在我自己的 TeamCity 特定案例中，这很容易作为附加构建步骤添加到您的构建配置中，在 MSBuild 完成后——运行脚本:

taskkill /IM vctip.exe /f >nul 2>&1

请注意，此解决方案确实对您的构建系统做出了某些假设，例如它没有同时运行多个构建。并确保将其记录下来，因为稍后弄清楚它的来源将是一件令人头疼的事情......