mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
9429136112
This change causes the cache to be layered with a local "cache" that wraps the global cache, which will serve as the source of truth. The local cache persists only for the duration of a given scanning action, and has a store of references to dependencies resolved as a part of the current scanning action only, while the global cache is the one that persists across scanning actions (e.g. in `DependencyScanningTool`) and stores actual module dependency info values. Only the local cache can answer dependency lookup queries, checking current scanning action results first, before falling back to querying the global cache, with queries disambiguated by the current scannning action's search paths, ensuring we never resolve a dependency lookup query with a module info that could not be found in the current action's search paths. This change is required because search-path disambiguation can lead to false-negatives: for example, the Clang dependency scanner may find modules relative to the compiler's path that are not on the compiler's direct search paths. While such false-negative query responses should be functionally safe, we rely on the current scanning action's results being always-present-in-the-cache for the scanner's functionality. This layering ensures that the cache use-sites remain unchanged and that we get both: preserved global state which can be queried disambiguated with the search path details, and an always-consistent local (current action) cache state.
95 lines
3.5 KiB
C++
95 lines
3.5 KiB
C++
//===--- ScanDependencies.h -- Scans the dependencies of a module ------===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See https://swift.org/LICENSE.txt for license information
|
|
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_DEPENDENCY_SCANDEPENDENCIES_H
|
|
#define SWIFT_DEPENDENCY_SCANDEPENDENCIES_H
|
|
|
|
#include "swift-c/DependencyScan/DependencyScan.h"
|
|
#include "llvm/ADT/StringRef.h"
|
|
#include "llvm/ADT/StringSet.h"
|
|
#include "llvm/Support/Error.h"
|
|
|
|
namespace llvm {
|
|
class StringSaver;
|
|
}
|
|
|
|
namespace swift {
|
|
|
|
class CompilerInvocation;
|
|
class CompilerInstance;
|
|
class ModuleDependenciesCache;
|
|
class GlobalModuleDependenciesCache;
|
|
|
|
namespace dependencies {
|
|
|
|
//using CompilerArgInstanceCacheMap =
|
|
// llvm::StringMap<std::pair<std::unique_ptr<CompilerInstance>,
|
|
// std::unique_ptr<ModuleDependenciesCache>>>;
|
|
|
|
using CompilerArgInstanceCacheMap =
|
|
llvm::StringMap<std::tuple<std::unique_ptr<CompilerInstance>,
|
|
std::unique_ptr<GlobalModuleDependenciesCache>,
|
|
std::unique_ptr<ModuleDependenciesCache>>>;
|
|
|
|
struct BatchScanInput {
|
|
llvm::StringRef moduleName;
|
|
llvm::StringRef arguments;
|
|
llvm::StringRef outputPath;
|
|
bool isSwift;
|
|
};
|
|
|
|
// MARK: FrontendTool dependency scanner entry points
|
|
/// Scans the dependencies of the main module of \c instance and writes out
|
|
/// the resulting JSON according to the instance's output parameters.
|
|
bool scanDependencies(CompilerInstance &instance);
|
|
|
|
/// Identify all imports in the translation unit's module.
|
|
bool prescanDependencies(CompilerInstance &instance);
|
|
|
|
/// Batch scan the dependencies for modules specified in \c batchInputFile.
|
|
bool batchScanDependencies(CompilerInstance &instance,
|
|
llvm::StringRef batchInputFile);
|
|
|
|
/// Batch prescan the imports of modules specified in \c batchInputFile.
|
|
bool batchPrescanDependencies(CompilerInstance &instance,
|
|
llvm::StringRef batchInputFile);
|
|
|
|
// MARK: Dependency scanning execution
|
|
/// Scans the dependencies of the main module of \c instance.
|
|
llvm::ErrorOr<swiftscan_dependency_graph_t>
|
|
performModuleScan(CompilerInstance &instance,
|
|
ModuleDependenciesCache &cache);
|
|
|
|
/// Scans the main module of \c instance for all direct module imports
|
|
llvm::ErrorOr<swiftscan_import_set_t>
|
|
performModulePrescan(CompilerInstance &instance);
|
|
|
|
/// Batch scan the dependencies for modules specified in \c batchInputFile.
|
|
std::vector<llvm::ErrorOr<swiftscan_dependency_graph_t>>
|
|
performBatchModuleScan(CompilerInstance &invocationInstance,
|
|
ModuleDependenciesCache &invocationCache,
|
|
CompilerArgInstanceCacheMap *versionedPCMInstanceCache,
|
|
llvm::StringSaver &saver,
|
|
const std::vector<BatchScanInput> &BatchInput);
|
|
|
|
/// Batch prescan the imports of modules specified in \c batchInputFile.
|
|
std::vector<llvm::ErrorOr<swiftscan_import_set_t>>
|
|
performBatchModulePrescan(CompilerInstance &invocationInstance,
|
|
ModuleDependenciesCache &cache,
|
|
llvm::StringSaver &saver,
|
|
const std::vector<BatchScanInput> &BatchInput);
|
|
|
|
} // end namespace dependencies
|
|
} // end namespace swift
|
|
|
|
#endif
|