a730dda7d5
This PR sets up an `AtomicLineLogger` (added by https://github.com/llvm/llvm-project/pull/205395) to log the sequence of dependency scanning events. The logging is triggered by a new `LogPath` option in `DependencyScanningServiceOptions`. This PR adds an option `-log-path=` to `clang-scan-deps` to trigger the log. We are logging 16 events during dependency scanning. | Event | Logged In | When | |-------|-----------|------| | `starting scanning command: <args>` | `DependencyScanningWorker.cpp` | Start of each TU scan | | `finished scanning command: <args>` | `DependencyScanningWorker.cpp` | End of each TU scan | | `init_compiler_instance_with_context: <args>` | `DependencyScanningTool.cpp` | CompilerInstanceWithContext created for by-name scanning | | `start scan_by_name: <module name>` | `DependencyScanningTool.cpp` | Start of a by-name module query | | `finish scan_by_name: <module name>` | `DependencyScanningTool.cpp` | End of a by-name module query | | `module_compile_thread: parent=<TID> pcm_compile: <pcm path>` | `CompilerInstance::compileModule` | A new thread is created to compile a pcm | | `timestamp_read: <pcm path>` | `InProcessModuleCache::getModuleTimestamp` | Validation timestamp read | | `timestamp_write: <pcm path>` | `InProcessModuleCache::updateModuleTimestamp` | Validation timestamp update | | `pcm_write: <pcm path>` | `InProcessModuleCache::write` | PCM write to disk attempted | | `pcm_read_disk: <pcm path>` | `InProcessModuleCache::read` | PCM read from disk attempted | | `pcm_read_cached: <pcm path>` | `InMemoryModuleCache::lookupPCM` | PCM looked up in in-memory cache | | `pcm_add: <pcm path>` | `InMemoryModuleCache::addPCM` | PCM added to cache (not validated) | | `pcm_add_built: <pcm path>` | `InMemoryModuleCache::addBuiltPCM` | PCM added to cache (final) | | `pcm_finalized: <pcm path>` | `InMemoryModuleCache::finalizePCM` | PCM marked as validated/final | | `pcm_dropped: <pcm path>` | `InMemoryModuleCache::tryToDropPCM` | PCM dropped (validation failed) | | `pcm_not_dropped: <pcm path>` | `InMemoryModuleCache::tryToDropPCM` | PCM not dropped (validation failed, but already final) | In addition to checking the logger's functionality, `clang/test/ClangScanDeps/logging-simple.c` checks against the change committed by https://github.com/llvm/llvm-project/pull/177062. Without https://github.com/llvm/llvm-project/pull/177062, `clang/test/ClangScanDeps/logging-simple.c` fails. This implementation adds a single instance of `AtomicLineLogger` to the `DependencyScanningService`. Most of the plumbing goes into the `ModuleCache` and its derived classes. Assisted-by: claude-opus-4.6 rdar://39907408
63 lines
1.7 KiB
C++
63 lines
1.7 KiB
C++
//===----------------------------------------------------------------------===//
|
|
//
|
|
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
|
|
// See https://llvm.org/LICENSE.txt for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CLANG_DEPENDENCYSCANNING_INPROCESSMODULECACHE_H
|
|
#define LLVM_CLANG_DEPENDENCYSCANNING_INPROCESSMODULECACHE_H
|
|
|
|
#include "clang/Basic/AtomicLineLogger.h"
|
|
#include "clang/Serialization/ModuleCache.h"
|
|
#include "llvm/ADT/StringMap.h"
|
|
|
|
#include <atomic>
|
|
#include <condition_variable>
|
|
#include <memory>
|
|
#include <mutex>
|
|
|
|
namespace llvm {
|
|
class MemoryBuffer;
|
|
} // namespace llvm
|
|
|
|
namespace clang {
|
|
namespace dependencies {
|
|
|
|
struct ModuleCacheEntry {
|
|
std::mutex Mutex;
|
|
std::condition_variable CondVar;
|
|
bool Locked = false;
|
|
unsigned Generation = 0;
|
|
|
|
std::atomic<std::time_t> Timestamp = 0;
|
|
|
|
enum {
|
|
S_Unknown,
|
|
S_Read,
|
|
S_Written,
|
|
} State = S_Unknown;
|
|
/// The buffer we've read from disk, if any.
|
|
std::unique_ptr<llvm::MemoryBuffer> ReadBuffer;
|
|
/// The buffer we've written to module cache, if any.
|
|
std::unique_ptr<llvm::MemoryBuffer> WrittenBuffer;
|
|
/// The modification time of the entry.
|
|
time_t ModTime = 0;
|
|
};
|
|
|
|
struct ModuleCacheEntries {
|
|
std::mutex Mutex;
|
|
llvm::StringMap<std::unique_ptr<ModuleCacheEntry>> Map;
|
|
|
|
/// Flushes all PCMs built in-process to disk.
|
|
void flush();
|
|
};
|
|
|
|
std::shared_ptr<ModuleCache>
|
|
makeInProcessModuleCache(ModuleCacheEntries &Entries, AtomicLineLogger &Logger);
|
|
|
|
} // namespace dependencies
|
|
} // namespace clang
|
|
|
|
#endif // LLVM_CLANG_DEPENDENCYSCANNING_INPROCESSMODULECACHE_H
|