mirror of
https://github.com/apple/swift.git
synced 2025-12-21 12:14:44 +01:00
0a7929e80f
Split off the notion of "recording" dependencies from the notion of "collecting" dependencies. This corrects an oversight in the previous design where dependency replay and recording were actually not "free" in WMO where we actually never track dependencies. This architecture also lays the groundwork for the removal of the referenced name trackers. The algorithm builds upon the infrastructure for dependency sources and sinks laid down during the cut over to request-based dependency tracking in #30723. The idea of the naive algorithm is this: For a chain of requests A -> B* -> C -> D* -> ... -> L where L is a lookup request and all starred requests are cached, once L writes into the dependency collector, the active stack is walked and at each cache-point the results of dependency collection are associated with the request itself (in this example, B* and D* have all the names L found associated with them). Subsequent evaluations of these cached requests (B* and D* et al) will then *replay* the previous lookup results from L into the active referenced name tracker. One complication is, suppose the evaluation of a cached request involves multiple downstream name lookups. More concretely, suppose we have the following request trace: A* -> B -> L | -> C -> L | -> D -> L | -> ... Then A* must see the union of the results of each L. If this reminds anyone of a union-find, that is no accident! A persistent union-find a la Conchon and Filliatre is probably in order to help bring down peak heap usage...
151 lines
4.7 KiB
C++
151 lines
4.7 KiB
C++
//===--- ParseRequests.h - Parsing Requests ---------------------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2019 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
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file defines parsing requests.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
#ifndef SWIFT_PARSE_REQUESTS_H
|
|
#define SWIFT_PARSE_REQUESTS_H
|
|
|
|
#include "swift/AST/ASTTypeIDs.h"
|
|
#include "swift/AST/EvaluatorDependencies.h"
|
|
#include "swift/AST/SimpleRequest.h"
|
|
|
|
namespace swift {
|
|
|
|
/// Report that a request of the given kind is being evaluated, so it
|
|
/// can be recorded by the stats reporter.
|
|
template<typename Request>
|
|
void reportEvaluatedRequest(UnifiedStatsReporter &stats,
|
|
const Request &request);
|
|
|
|
struct FingerprintAndMembers {
|
|
Optional<std::string> fingerprint = None;
|
|
ArrayRef<Decl *> members = {};
|
|
bool operator==(const FingerprintAndMembers &x) const {
|
|
return fingerprint == x.fingerprint && members == x.members;
|
|
}
|
|
};
|
|
|
|
void simple_display(llvm::raw_ostream &out, const FingerprintAndMembers &value);
|
|
|
|
/// Parse the members of a nominal type declaration or extension.
|
|
/// Return a fingerprint and the members.
|
|
class ParseMembersRequest
|
|
: public SimpleRequest<ParseMembersRequest,
|
|
FingerprintAndMembers(IterableDeclContext *),
|
|
RequestFlags::Cached> {
|
|
public:
|
|
using SimpleRequest::SimpleRequest;
|
|
|
|
private:
|
|
friend SimpleRequest;
|
|
|
|
// Evaluation.
|
|
FingerprintAndMembers evaluate(Evaluator &evaluator,
|
|
IterableDeclContext *idc) const;
|
|
|
|
public:
|
|
// Caching
|
|
bool isCached() const { return true; }
|
|
};
|
|
|
|
/// Parse the body of a function, initializer, or deinitializer.
|
|
class ParseAbstractFunctionBodyRequest :
|
|
public SimpleRequest<ParseAbstractFunctionBodyRequest,
|
|
BraceStmt *(AbstractFunctionDecl *),
|
|
RequestFlags::SeparatelyCached>
|
|
{
|
|
public:
|
|
using SimpleRequest::SimpleRequest;
|
|
|
|
private:
|
|
friend SimpleRequest;
|
|
|
|
// Evaluation.
|
|
BraceStmt *evaluate(Evaluator &evaluator, AbstractFunctionDecl *afd) const;
|
|
|
|
public:
|
|
// Caching
|
|
bool isCached() const { return true; }
|
|
Optional<BraceStmt *> getCachedResult() const;
|
|
void cacheResult(BraceStmt *value) const;
|
|
};
|
|
|
|
/// Parse the top-level decls of a SourceFile.
|
|
class ParseSourceFileRequest
|
|
: public SimpleRequest<
|
|
ParseSourceFileRequest, ArrayRef<Decl *>(SourceFile *),
|
|
RequestFlags::SeparatelyCached | RequestFlags::DependencySource> {
|
|
public:
|
|
using SimpleRequest::SimpleRequest;
|
|
|
|
private:
|
|
friend SimpleRequest;
|
|
|
|
// Evaluation.
|
|
ArrayRef<Decl *> evaluate(Evaluator &evaluator, SourceFile *SF) const;
|
|
|
|
public:
|
|
// Caching.
|
|
bool isCached() const { return true; }
|
|
Optional<ArrayRef<Decl *>> getCachedResult() const;
|
|
void cacheResult(ArrayRef<Decl *> decls) const;
|
|
|
|
public:
|
|
evaluator::DependencySource
|
|
readDependencySource(const evaluator::DependencyRecorder &) const;
|
|
};
|
|
|
|
void simple_display(llvm::raw_ostream &out,
|
|
const CodeCompletionCallbacksFactory *factory);
|
|
|
|
class CodeCompletionSecondPassRequest
|
|
: public SimpleRequest<CodeCompletionSecondPassRequest,
|
|
bool(SourceFile *, CodeCompletionCallbacksFactory *),
|
|
RequestFlags::Uncached|RequestFlags::DependencySource> {
|
|
public:
|
|
using SimpleRequest::SimpleRequest;
|
|
|
|
private:
|
|
friend SimpleRequest;
|
|
|
|
// Evaluation.
|
|
bool evaluate(Evaluator &evaluator, SourceFile *SF,
|
|
CodeCompletionCallbacksFactory *Factory) const;
|
|
|
|
public:
|
|
evaluator::DependencySource
|
|
readDependencySource(const evaluator::DependencyRecorder &) const;
|
|
};
|
|
|
|
/// The zone number for the parser.
|
|
#define SWIFT_TYPEID_ZONE Parse
|
|
#define SWIFT_TYPEID_HEADER "swift/AST/ParseTypeIDZone.def"
|
|
#include "swift/Basic/DefineTypeIDZone.h"
|
|
#undef SWIFT_TYPEID_ZONE
|
|
#undef SWIFT_TYPEID_HEADER
|
|
|
|
// Set up reporting of evaluated requests.
|
|
#define SWIFT_REQUEST(Zone, RequestType, Sig, Caching, LocOptions) \
|
|
template <> \
|
|
inline void reportEvaluatedRequest(UnifiedStatsReporter &stats, \
|
|
const RequestType &request) { \
|
|
++stats.getFrontendCounters().RequestType; \
|
|
}
|
|
#include "swift/AST/ParseTypeIDZone.def"
|
|
#undef SWIFT_REQUEST
|
|
|
|
} // end namespace swift
|
|
|
|
#endif // SWIFT_PARSE_REQUESTS_H
|