Bug Summary

File:build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/clang-tools-extra/clangd/ClangdServer.cpp
Warning:line 82, column 5
Potential leak of memory pointed to by field '_M_head_impl'

Annotated Source Code

Press '?' to see keyboard shortcuts

clang -cc1 -cc1 -triple x86_64-pc-linux-gnu -analyze -disable-free -clear-ast-before-backend -disable-llvm-verifier -discard-value-names -main-file-name ClangdServer.cpp -analyzer-checker=core -analyzer-checker=apiModeling -analyzer-checker=unix -analyzer-checker=deadcode -analyzer-checker=cplusplus -analyzer-checker=security.insecureAPI.UncheckedReturn -analyzer-checker=security.insecureAPI.getpw -analyzer-checker=security.insecureAPI.gets -analyzer-checker=security.insecureAPI.mktemp -analyzer-checker=security.insecureAPI.mkstemp -analyzer-checker=security.insecureAPI.vfork -analyzer-checker=nullability.NullPassedToNonnull -analyzer-checker=nullability.NullReturnedFromNonnull -analyzer-output plist -w -setup-static-analyzer -analyzer-config-compatibility-mode=true -mrelocation-model pic -pic-level 2 -mframe-pointer=none -relaxed-aliasing -fmath-errno -ffp-contract=on -fno-rounding-math -mconstructor-aliases -funwind-tables=2 -target-cpu x86-64 -tune-cpu generic -debugger-tuning=gdb -ffunction-sections -fdata-sections -fcoverage-compilation-dir=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm/tools/clang/stage2-bins -resource-dir /usr/lib/llvm-16/lib/clang/16.0.0 -D _DEBUG -D _GNU_SOURCE -D __STDC_CONSTANT_MACROS -D __STDC_FORMAT_MACROS -D __STDC_LIMIT_MACROS -I tools/clang/tools/extra/clangd -I /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/clang-tools-extra/clangd -I tools/clang/tools/extra/clangd/../clang-tidy -I /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/clang/include -I tools/clang/include -I include -I /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/llvm/include -I /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/clang-tools-extra/pseudo/lib/../include -D _FORTIFY_SOURCE=2 -D NDEBUG -U NDEBUG -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/x86_64-linux-gnu/c++/10 -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/backward -internal-isystem /usr/lib/llvm-16/lib/clang/16.0.0/include -internal-isystem /usr/local/include -internal-isystem /usr/lib/gcc/x86_64-linux-gnu/10/../../../../x86_64-linux-gnu/include -internal-externc-isystem /usr/include/x86_64-linux-gnu -internal-externc-isystem /include -internal-externc-isystem /usr/include -fmacro-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fmacro-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/= -fcoverage-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fcoverage-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/= -O2 -Wno-unused-command-line-argument -Wno-unused-parameter -Wwrite-strings -Wno-missing-field-initializers -Wno-long-long -Wno-maybe-uninitialized -Wno-class-memaccess -Wno-redundant-move -Wno-pessimizing-move -Wno-noexcept-type -Wno-comment -Wno-misleading-indentation -std=c++17 -fdeprecated-macro -fdebug-compilation-dir=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm/tools/clang/stage2-bins -fdebug-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/build-llvm/tools/clang/stage2-bins=build-llvm/tools/clang/stage2-bins -fdebug-prefix-map=/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/= -ferror-limit 19 -fvisibility-inlines-hidden -stack-protector 2 -fgnuc-version=4.2.1 -fcolor-diagnostics -vectorize-loops -vectorize-slp -analyzer-output=html -analyzer-config stable-report-filename=true -faddrsig -D__GCC_HAVE_DWARF2_CFI_ASM=1 -o /tmp/scan-build-2022-10-03-140002-15933-1 -x c++ /build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/clang-tools-extra/clangd/ClangdServer.cpp

/build/llvm-toolchain-snapshot-16~++20221003111214+1fa2019828ca/clang-tools-extra/clangd/ClangdServer.cpp

1//===--- ClangdServer.cpp - Main clangd server code --------------*- C++-*-===//
2//
3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6//
7//===-------------------------------------------------------------------===//
8
9#include "ClangdServer.h"
10#include "CodeComplete.h"
11#include "Config.h"
12#include "Diagnostics.h"
13#include "DumpAST.h"
14#include "FindSymbols.h"
15#include "Format.h"
16#include "HeaderSourceSwitch.h"
17#include "InlayHints.h"
18#include "ParsedAST.h"
19#include "Preamble.h"
20#include "Protocol.h"
21#include "SemanticHighlighting.h"
22#include "SemanticSelection.h"
23#include "SourceCode.h"
24#include "TUScheduler.h"
25#include "XRefs.h"
26#include "index/CanonicalIncludes.h"
27#include "index/FileIndex.h"
28#include "index/Merge.h"
29#include "index/StdLib.h"
30#include "refactor/Rename.h"
31#include "refactor/Tweak.h"
32#include "support/Cancellation.h"
33#include "support/Logger.h"
34#include "support/MemoryTree.h"
35#include "support/ThreadsafeFS.h"
36#include "support/Trace.h"
37#include "clang/Format/Format.h"
38#include "clang/Lex/Preprocessor.h"
39#include "clang/Tooling/CompilationDatabase.h"
40#include "clang/Tooling/Core/Replacement.h"
41#include "llvm/ADT/ArrayRef.h"
42#include "llvm/ADT/Optional.h"
43#include "llvm/ADT/STLExtras.h"
44#include "llvm/ADT/StringRef.h"
45#include "llvm/Support/Error.h"
46#include "llvm/Support/Path.h"
47#include "llvm/Support/raw_ostream.h"
48#include <algorithm>
49#include <chrono>
50#include <future>
51#include <memory>
52#include <mutex>
53#include <string>
54#include <type_traits>
55
56namespace clang {
57namespace clangd {
58namespace {
59
60// Update the FileIndex with new ASTs and plumb the diagnostics responses.
61struct UpdateIndexCallbacks : public ParsingCallbacks {
62 UpdateIndexCallbacks(FileIndex *FIndex,
63 ClangdServer::Callbacks *ServerCallbacks,
64 const ThreadsafeFS &TFS, AsyncTaskRunner *Tasks)
65 : FIndex(FIndex), ServerCallbacks(ServerCallbacks), TFS(TFS),
66 Tasks(Tasks) {}
67
68 void onPreambleAST(PathRef Path, llvm::StringRef Version,
69 const CompilerInvocation &CI, ASTContext &Ctx,
70 Preprocessor &PP,
71 const CanonicalIncludes &CanonIncludes) override {
72 // If this preamble uses a standard library we haven't seen yet, index it.
73 if (FIndex)
1
Assuming field 'FIndex' is non-null
2
Taking true branch
74 if (auto Loc = Stdlib.add(*CI.getLangOpts(), PP.getHeaderSearchInfo()))
3
Assuming the condition is true
4
Taking true branch
75 indexStdlib(CI, std::move(*Loc));
5
Calling 'UpdateIndexCallbacks::indexStdlib'
76
77 if (FIndex)
78 FIndex->updatePreamble(Path, Version, Ctx, PP, CanonIncludes);
79 }
80
81 void indexStdlib(const CompilerInvocation &CI, StdLibLocation Loc) {
82 auto Task = [this, LO(*CI.getLangOpts()), Loc(std::move(Loc)),
9
Potential leak of memory pointed to by field '_M_head_impl'
83 CI(std::make_unique<CompilerInvocation>(CI))]() mutable {
6
Calling 'make_unique<clang::CompilerInvocation, const clang::CompilerInvocation &>'
8
Returned allocated memory
84 IndexFileIn IF;
85 IF.Symbols = indexStandardLibrary(std::move(CI), Loc, TFS);
86 if (Stdlib.isBest(LO))
87 FIndex->updatePreamble(std::move(IF));
88 };
89 if (Tasks)
90 // This doesn't have a semaphore to enforce -j, but it's rare.
91 Tasks->runAsync("IndexStdlib", std::move(Task));
92 else
93 Task();
94 }
95
96 void onMainAST(PathRef Path, ParsedAST &AST, PublishFn Publish) override {
97 if (FIndex)
98 FIndex->updateMain(Path, AST);
99
100 assert(AST.getDiagnostics() &&(static_cast <bool> (AST.getDiagnostics() && "We issue callback only with fresh preambles"
) ? void (0) : __assert_fail ("AST.getDiagnostics() && \"We issue callback only with fresh preambles\""
, "clang-tools-extra/clangd/ClangdServer.cpp", 101, __extension__
__PRETTY_FUNCTION__))
101 "We issue callback only with fresh preambles")(static_cast <bool> (AST.getDiagnostics() && "We issue callback only with fresh preambles"
) ? void (0) : __assert_fail ("AST.getDiagnostics() && \"We issue callback only with fresh preambles\""
, "clang-tools-extra/clangd/ClangdServer.cpp", 101, __extension__
__PRETTY_FUNCTION__))
;
102 std::vector<Diag> Diagnostics = *AST.getDiagnostics();
103 if (ServerCallbacks)
104 Publish([&]() {
105 ServerCallbacks->onDiagnosticsReady(Path, AST.version(),
106 std::move(Diagnostics));
107 });
108 }
109
110 void onFailedAST(PathRef Path, llvm::StringRef Version,
111 std::vector<Diag> Diags, PublishFn Publish) override {
112 if (ServerCallbacks)
113 Publish(
114 [&]() { ServerCallbacks->onDiagnosticsReady(Path, Version, Diags); });
115 }
116
117 void onFileUpdated(PathRef File, const TUStatus &Status) override {
118 if (ServerCallbacks)
119 ServerCallbacks->onFileUpdated(File, Status);
120 }
121
122 void onPreamblePublished(PathRef File) override {
123 if (ServerCallbacks)
124 ServerCallbacks->onSemanticsMaybeChanged(File);
125 }
126
127private:
128 FileIndex *FIndex;
129 ClangdServer::Callbacks *ServerCallbacks;
130 const ThreadsafeFS &TFS;
131 StdLibSet Stdlib;
132 AsyncTaskRunner *Tasks;
133};
134
135class DraftStoreFS : public ThreadsafeFS {
136public:
137 DraftStoreFS(const ThreadsafeFS &Base, const DraftStore &Drafts)
138 : Base(Base), DirtyFiles(Drafts) {}
139
140private:
141 llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> viewImpl() const override {
142 auto OFS = llvm::makeIntrusiveRefCnt<llvm::vfs::OverlayFileSystem>(
143 Base.view(llvm::None));
144 OFS->pushOverlay(DirtyFiles.asVFS());
145 return OFS;
146 }
147
148 const ThreadsafeFS &Base;
149 const DraftStore &DirtyFiles;
150};
151
152} // namespace
153
154ClangdServer::Options ClangdServer::optsForTest() {
155 ClangdServer::Options Opts;
156 Opts.UpdateDebounce = DebouncePolicy::fixed(/*zero*/ {});
157 Opts.StorePreamblesInMemory = true;
158 Opts.AsyncThreadsCount = 4; // Consistent!
159 return Opts;
160}
161
162ClangdServer::Options::operator TUScheduler::Options() const {
163 TUScheduler::Options Opts;
164 Opts.AsyncThreadsCount = AsyncThreadsCount;
165 Opts.RetentionPolicy = RetentionPolicy;
166 Opts.StorePreamblesInMemory = StorePreamblesInMemory;
167 Opts.UpdateDebounce = UpdateDebounce;
168 Opts.ContextProvider = ContextProvider;
169 Opts.PreambleThrottler = PreambleThrottler;
170 return Opts;
171}
172
173ClangdServer::ClangdServer(const GlobalCompilationDatabase &CDB,
174 const ThreadsafeFS &TFS, const Options &Opts,
175 Callbacks *Callbacks)
176 : FeatureModules(Opts.FeatureModules), CDB(CDB), TFS(TFS),
177 DynamicIdx(Opts.BuildDynamicSymbolIndex ? new FileIndex() : nullptr),
178 ClangTidyProvider(Opts.ClangTidyProvider),
179 UseDirtyHeaders(Opts.UseDirtyHeaders),
180 LineFoldingOnly(Opts.LineFoldingOnly),
181 PreambleParseForwardingFunctions(Opts.PreambleParseForwardingFunctions),
182 WorkspaceRoot(Opts.WorkspaceRoot),
183 Transient(Opts.ImplicitCancellation ? TUScheduler::InvalidateOnUpdate
184 : TUScheduler::NoInvalidation),
185 DirtyFS(std::make_unique<DraftStoreFS>(TFS, DraftMgr)) {
186 if (Opts.AsyncThreadsCount != 0)
187 IndexTasks.emplace();
188 // Pass a callback into `WorkScheduler` to extract symbols from a newly
189 // parsed file and rebuild the file index synchronously each time an AST
190 // is parsed.
191 WorkScheduler.emplace(CDB, TUScheduler::Options(Opts),
192 std::make_unique<UpdateIndexCallbacks>(
193 DynamicIdx.get(), Callbacks, TFS,
194 IndexTasks ? IndexTasks.getPointer() : nullptr));
195 // Adds an index to the stack, at higher priority than existing indexes.
196 auto AddIndex = [&](SymbolIndex *Idx) {
197 if (this->Index != nullptr) {
198 MergedIdx.push_back(std::make_unique<MergedIndex>(Idx, this->Index));
199 this->Index = MergedIdx.back().get();
200 } else {
201 this->Index = Idx;
202 }
203 };
204 if (Opts.StaticIndex)
205 AddIndex(Opts.StaticIndex);
206 if (Opts.BackgroundIndex) {
207 BackgroundIndex::Options BGOpts;
208 BGOpts.ThreadPoolSize = std::max(Opts.AsyncThreadsCount, 1u);
209 BGOpts.OnProgress = [Callbacks](BackgroundQueue::Stats S) {
210 if (Callbacks)
211 Callbacks->onBackgroundIndexProgress(S);
212 };
213 BGOpts.ContextProvider = Opts.ContextProvider;
214 BackgroundIdx = std::make_unique<BackgroundIndex>(
215 TFS, CDB,
216 BackgroundIndexStorage::createDiskBackedStorageFactory(
217 [&CDB](llvm::StringRef File) { return CDB.getProjectInfo(File); }),
218 std::move(BGOpts));
219 AddIndex(BackgroundIdx.get());
220 }
221 if (DynamicIdx)
222 AddIndex(DynamicIdx.get());
223
224 if (Opts.FeatureModules) {
225 FeatureModule::Facilities F{
226 *this->WorkScheduler,
227 this->Index,
228 this->TFS,
229 };
230 for (auto &Mod : *Opts.FeatureModules)
231 Mod.initialize(F);
232 }
233}
234
235ClangdServer::~ClangdServer() {
236 // Destroying TUScheduler first shuts down request threads that might
237 // otherwise access members concurrently.
238 // (Nobody can be using TUScheduler because we're on the main thread).
239 WorkScheduler.reset();
240 // Now requests have stopped, we can shut down feature modules.
241 if (FeatureModules) {
242 for (auto &Mod : *FeatureModules)
243 Mod.stop();
244 for (auto &Mod : *FeatureModules)
245 Mod.blockUntilIdle(Deadline::infinity());
246 }
247}
248
249void ClangdServer::addDocument(PathRef File, llvm::StringRef Contents,
250 llvm::StringRef Version,
251 WantDiagnostics WantDiags, bool ForceRebuild) {
252 std::string ActualVersion = DraftMgr.addDraft(File, Version, Contents);
253 ParseOptions Opts;
254 Opts.PreambleParseForwardingFunctions = PreambleParseForwardingFunctions;
255
256 // Compile command is set asynchronously during update, as it can be slow.
257 ParseInputs Inputs;
258 Inputs.TFS = &getHeaderFS();
259 Inputs.Contents = std::string(Contents);
260 Inputs.Version = std::move(ActualVersion);
261 Inputs.ForceRebuild = ForceRebuild;
262 Inputs.Opts = std::move(Opts);
263 Inputs.Index = Index;
264 Inputs.ClangTidyProvider = ClangTidyProvider;
265 Inputs.FeatureModules = FeatureModules;
266 bool NewFile = WorkScheduler->update(File, Inputs, WantDiags);
267 // If we loaded Foo.h, we want to make sure Foo.cpp is indexed.
268 if (NewFile && BackgroundIdx)
269 BackgroundIdx->boostRelated(File);
270}
271
272void ClangdServer::reparseOpenFilesIfNeeded(
273 llvm::function_ref<bool(llvm::StringRef File)> Filter) {
274 // Reparse only opened files that were modified.
275 for (const Path &FilePath : DraftMgr.getActiveFiles())
276 if (Filter(FilePath))
277 if (auto Draft = DraftMgr.getDraft(FilePath)) // else disappeared in race?
278 addDocument(FilePath, *Draft->Contents, Draft->Version,
279 WantDiagnostics::Auto);
280}
281
282std::shared_ptr<const std::string> ClangdServer::getDraft(PathRef File) const {
283 auto Draft = DraftMgr.getDraft(File);
284 if (!Draft)
285 return nullptr;
286 return std::move(Draft->Contents);
287}
288
289std::function<Context(PathRef)>
290ClangdServer::createConfiguredContextProvider(const config::Provider *Provider,
291 Callbacks *Publish) {
292 if (!Provider)
293 return [](llvm::StringRef) { return Context::current().clone(); };
294
295 struct Impl {
296 const config::Provider *Provider;
297 ClangdServer::Callbacks *Publish;
298 std::mutex PublishMu;
299
300 Impl(const config::Provider *Provider, ClangdServer::Callbacks *Publish)
301 : Provider(Provider), Publish(Publish) {}
302
303 Context operator()(llvm::StringRef File) {
304 config::Params Params;
305 // Don't reread config files excessively often.
306 // FIXME: when we see a config file change event, use the event timestamp?
307 Params.FreshTime =
308 std::chrono::steady_clock::now() - std::chrono::seconds(5);
309 llvm::SmallString<256> PosixPath;
310 if (!File.empty()) {
311 assert(llvm::sys::path::is_absolute(File))(static_cast <bool> (llvm::sys::path::is_absolute(File)
) ? void (0) : __assert_fail ("llvm::sys::path::is_absolute(File)"
, "clang-tools-extra/clangd/ClangdServer.cpp", 311, __extension__
__PRETTY_FUNCTION__))
;
312 llvm::sys::path::native(File, PosixPath, llvm::sys::path::Style::posix);
313 Params.Path = PosixPath.str();
314 }
315
316 llvm::StringMap<std::vector<Diag>> ReportableDiagnostics;
317 Config C = Provider->getConfig(Params, [&](const llvm::SMDiagnostic &D) {
318 // Create the map entry even for note diagnostics we don't report.
319 // This means that when the file is parsed with no warnings, we
320 // publish an empty set of diagnostics, clearing any the client has.
321 handleDiagnostic(D, !Publish || D.getFilename().empty()
322 ? nullptr
323 : &ReportableDiagnostics[D.getFilename()]);
324 });
325 // Blindly publish diagnostics for the (unopened) parsed config files.
326 // We must avoid reporting diagnostics for *the same file* concurrently.
327 // Source diags are published elsewhere, but those are different files.
328 if (!ReportableDiagnostics.empty()) {
329 std::lock_guard<std::mutex> Lock(PublishMu);
330 for (auto &Entry : ReportableDiagnostics)
331 Publish->onDiagnosticsReady(Entry.first(), /*Version=*/"",
332 std::move(Entry.second));
333 }
334 return Context::current().derive(Config::Key, std::move(C));
335 }
336
337 void handleDiagnostic(const llvm::SMDiagnostic &D,
338 std::vector<Diag> *ClientDiagnostics) {
339 switch (D.getKind()) {
340 case llvm::SourceMgr::DK_Error:
341 elog("config error at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(),
342 D.getColumnNo(), D.getMessage());
343 break;
344 case llvm::SourceMgr::DK_Warning:
345 log("config warning at {0}:{1}:{2}: {3}", D.getFilename(),
346 D.getLineNo(), D.getColumnNo(), D.getMessage());
347 break;
348 case llvm::SourceMgr::DK_Note:
349 case llvm::SourceMgr::DK_Remark:
350 vlog("config note at {0}:{1}:{2}: {3}", D.getFilename(), D.getLineNo(),
351 D.getColumnNo(), D.getMessage());
352 ClientDiagnostics = nullptr; // Don't emit notes as LSP diagnostics.
353 break;
354 }
355 if (ClientDiagnostics)
356 ClientDiagnostics->push_back(toDiag(D, Diag::ClangdConfig));
357 }
358 };
359
360 // Copyable wrapper.
361 return [I(std::make_shared<Impl>(Provider, Publish))](llvm::StringRef Path) {
362 return (*I)(Path);
363 };
364}
365
366void ClangdServer::removeDocument(PathRef File) {
367 DraftMgr.removeDraft(File);
368 WorkScheduler->remove(File);
369}
370
371void ClangdServer::codeComplete(PathRef File, Position Pos,
372 const clangd::CodeCompleteOptions &Opts,
373 Callback<CodeCompleteResult> CB) {
374 // Copy completion options for passing them to async task handler.
375 auto CodeCompleteOpts = Opts;
376 if (!CodeCompleteOpts.Index) // Respect overridden index.
377 CodeCompleteOpts.Index = Index;
378
379 auto Task = [Pos, CodeCompleteOpts, File = File.str(), CB = std::move(CB),
380 this](llvm::Expected<InputsAndPreamble> IP) mutable {
381 if (!IP)
382 return CB(IP.takeError());
383 if (auto Reason = isCancelled())
384 return CB(llvm::make_error<CancelledError>(Reason));
385
386 llvm::Optional<SpeculativeFuzzyFind> SpecFuzzyFind;
387 if (!IP->Preamble) {
388 // No speculation in Fallback mode, as it's supposed to be much faster
389 // without compiling.
390 vlog("Build for file {0} is not ready. Enter fallback mode.", File);
391 } else if (CodeCompleteOpts.Index) {
392 SpecFuzzyFind.emplace();
393 {
394 std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex);
395 SpecFuzzyFind->CachedReq = CachedCompletionFuzzyFindRequestByFile[File];
396 }
397 }
398 ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()};
399 // FIXME: Add traling new line if there is none at eof, workaround a crash,
400 // see https://github.com/clangd/clangd/issues/332
401 if (!IP->Contents.endswith("\n"))
402 ParseInput.Contents.append("\n");
403 ParseInput.Index = Index;
404
405 CodeCompleteOpts.MainFileSignals = IP->Signals;
406 CodeCompleteOpts.AllScopes = Config::current().Completion.AllScopes;
407 // FIXME(ibiryukov): even if Preamble is non-null, we may want to check
408 // both the old and the new version in case only one of them matches.
409 CodeCompleteResult Result = clangd::codeComplete(
410 File, Pos, IP->Preamble, ParseInput, CodeCompleteOpts,
411 SpecFuzzyFind ? SpecFuzzyFind.getPointer() : nullptr);
412 {
413 clang::clangd::trace::Span Tracer("Completion results callback");
414 CB(std::move(Result));
415 }
416 if (SpecFuzzyFind && SpecFuzzyFind->NewReq) {
417 std::lock_guard<std::mutex> Lock(CachedCompletionFuzzyFindRequestMutex);
418 CachedCompletionFuzzyFindRequestByFile[File] =
419 SpecFuzzyFind->NewReq.value();
420 }
421 // SpecFuzzyFind is only destroyed after speculative fuzzy find finishes.
422 // We don't want `codeComplete` to wait for the async call if it doesn't use
423 // the result (e.g. non-index completion, speculation fails), so that `CB`
424 // is called as soon as results are available.
425 };
426
427 // We use a potentially-stale preamble because latency is critical here.
428 WorkScheduler->runWithPreamble(
429 "CodeComplete", File,
430 (Opts.RunParser == CodeCompleteOptions::AlwaysParse)
431 ? TUScheduler::Stale
432 : TUScheduler::StaleOrAbsent,
433 std::move(Task));
434}
435
436void ClangdServer::signatureHelp(PathRef File, Position Pos,
437 MarkupKind DocumentationFormat,
438 Callback<SignatureHelp> CB) {
439
440 auto Action = [Pos, File = File.str(), CB = std::move(CB),
441 DocumentationFormat,
442 this](llvm::Expected<InputsAndPreamble> IP) mutable {
443 if (!IP)
444 return CB(IP.takeError());
445
446 const auto *PreambleData = IP->Preamble;
447 if (!PreambleData)
448 return CB(error("Failed to parse includes"));
449
450 ParseInputs ParseInput{IP->Command, &getHeaderFS(), IP->Contents.str()};
451 // FIXME: Add traling new line if there is none at eof, workaround a crash,
452 // see https://github.com/clangd/clangd/issues/332
453 if (!IP->Contents.endswith("\n"))
454 ParseInput.Contents.append("\n");
455 ParseInput.Index = Index;
456 CB(clangd::signatureHelp(File, Pos, *PreambleData, ParseInput,
457 DocumentationFormat));
458 };
459
460 // Unlike code completion, we wait for a preamble here.
461 WorkScheduler->runWithPreamble("SignatureHelp", File, TUScheduler::Stale,
462 std::move(Action));
463}
464
465void ClangdServer::formatFile(PathRef File, llvm::Optional<Range> Rng,
466 Callback<tooling::Replacements> CB) {
467 auto Code = getDraft(File);
468 if (!Code)
469 return CB(llvm::make_error<LSPError>("trying to format non-added document",
470 ErrorCode::InvalidParams));
471 tooling::Range RequestedRange;
472 if (Rng) {
473 llvm::Expected<size_t> Begin = positionToOffset(*Code, Rng->start);
474 if (!Begin)
475 return CB(Begin.takeError());
476 llvm::Expected<size_t> End = positionToOffset(*Code, Rng->end);
477 if (!End)
478 return CB(End.takeError());
479 RequestedRange = tooling::Range(*Begin, *End - *Begin);
480 } else {
481 RequestedRange = tooling::Range(0, Code->size());
482 }
483
484 // Call clang-format.
485 auto Action = [File = File.str(), Code = std::move(*Code),
486 Ranges = std::vector<tooling::Range>{RequestedRange},
487 CB = std::move(CB), this]() mutable {
488 format::FormatStyle Style = getFormatStyleForFile(File, Code, TFS);
489 tooling::Replacements IncludeReplaces =
490 format::sortIncludes(Style, Code, Ranges, File);
491 auto Changed = tooling::applyAllReplacements(Code, IncludeReplaces);
492 if (!Changed)
493 return CB(Changed.takeError());
494
495 CB(IncludeReplaces.merge(format::reformat(
496 Style, *Changed,
497 tooling::calculateRangesAfterReplacements(IncludeReplaces, Ranges),
498 File)));
499 };
500 WorkScheduler->runQuick("Format", File, std::move(Action));
501}
502
503void ClangdServer::formatOnType(PathRef File, Position Pos,
504 StringRef TriggerText,
505 Callback<std::vector<TextEdit>> CB) {
506 auto Code = getDraft(File);
507 if (!Code)
508 return CB(llvm::make_error<LSPError>("trying to format non-added document",
509 ErrorCode::InvalidParams));
510 llvm::Expected<size_t> CursorPos = positionToOffset(*Code, Pos);
511 if (!CursorPos)
512 return CB(CursorPos.takeError());
513 auto Action = [File = File.str(), Code = std::move(*Code),
514 TriggerText = TriggerText.str(), CursorPos = *CursorPos,
515 CB = std::move(CB), this]() mutable {
516 auto Style = format::getStyle(format::DefaultFormatStyle, File,
517 format::DefaultFallbackStyle, Code,
518 TFS.view(/*CWD=*/llvm::None).get());
519 if (!Style)
520 return CB(Style.takeError());
521
522 std::vector<TextEdit> Result;
523 for (const tooling::Replacement &R :
524 formatIncremental(Code, CursorPos, TriggerText, *Style))
525 Result.push_back(replacementToEdit(Code, R));
526 return CB(Result);
527 };
528 WorkScheduler->runQuick("FormatOnType", File, std::move(Action));
529}
530
531void ClangdServer::prepareRename(PathRef File, Position Pos,
532 llvm::Optional<std::string> NewName,
533 const RenameOptions &RenameOpts,
534 Callback<RenameResult> CB) {
535 auto Action = [Pos, File = File.str(), CB = std::move(CB),
536 NewName = std::move(NewName),
537 RenameOpts](llvm::Expected<InputsAndAST> InpAST) mutable {
538 if (!InpAST)
539 return CB(InpAST.takeError());
540 // prepareRename is latency-sensitive: we don't query the index, as we
541 // only need main-file references
542 auto Results =
543 clangd::rename({Pos, NewName.value_or("__clangd_rename_placeholder"),
544 InpAST->AST, File, /*FS=*/nullptr,
545 /*Index=*/nullptr, RenameOpts});
546 if (!Results) {
547 // LSP says to return null on failure, but that will result in a generic
548 // failure message. If we send an LSP error response, clients can surface
549 // the message to users (VSCode does).
550 return CB(Results.takeError());
551 }
552 return CB(*Results);
553 };
554 WorkScheduler->runWithAST("PrepareRename", File, std::move(Action));
555}
556
557void ClangdServer::rename(PathRef File, Position Pos, llvm::StringRef NewName,
558 const RenameOptions &Opts,
559 Callback<RenameResult> CB) {
560 auto Action = [File = File.str(), NewName = NewName.str(), Pos, Opts,
561 CB = std::move(CB),
562 this](llvm::Expected<InputsAndAST> InpAST) mutable {
563 // Tracks number of files edited per invocation.
564 static constexpr trace::Metric RenameFiles("rename_files",
565 trace::Metric::Distribution);
566 if (!InpAST)
567 return CB(InpAST.takeError());
568 auto R = clangd::rename({Pos, NewName, InpAST->AST, File,
569 DirtyFS->view(llvm::None), Index, Opts});
570 if (!R)
571 return CB(R.takeError());
572
573 if (Opts.WantFormat) {
574 auto Style = getFormatStyleForFile(File, InpAST->Inputs.Contents,
575 *InpAST->Inputs.TFS);
576 llvm::Error Err = llvm::Error::success();
577 for (auto &E : R->GlobalChanges)
578 Err =
579 llvm::joinErrors(reformatEdit(E.getValue(), Style), std::move(Err));
580
581 if (Err)
582 return CB(std::move(Err));
583 }
584 RenameFiles.record(R->GlobalChanges.size());
585 return CB(*R);
586 };
587 WorkScheduler->runWithAST("Rename", File, std::move(Action));
588}
589
590// May generate several candidate selections, due to SelectionTree ambiguity.
591// vector of pointers because GCC doesn't like non-copyable Selection.
592static llvm::Expected<std::vector<std::unique_ptr<Tweak::Selection>>>
593tweakSelection(const Range &Sel, const InputsAndAST &AST,
594 llvm::vfs::FileSystem *FS) {
595 auto Begin = positionToOffset(AST.Inputs.Contents, Sel.start);
596 if (!Begin)
597 return Begin.takeError();
598 auto End = positionToOffset(AST.Inputs.Contents, Sel.end);
599 if (!End)
600 return End.takeError();
601 std::vector<std::unique_ptr<Tweak::Selection>> Result;
602 SelectionTree::createEach(
603 AST.AST.getASTContext(), AST.AST.getTokens(), *Begin, *End,
604 [&](SelectionTree T) {
605 Result.push_back(std::make_unique<Tweak::Selection>(
606 AST.Inputs.Index, AST.AST, *Begin, *End, std::move(T), FS));
607 return false;
608 });
609 assert(!Result.empty() && "Expected at least one SelectionTree")(static_cast <bool> (!Result.empty() && "Expected at least one SelectionTree"
) ? void (0) : __assert_fail ("!Result.empty() && \"Expected at least one SelectionTree\""
, "clang-tools-extra/clangd/ClangdServer.cpp", 609, __extension__
__PRETTY_FUNCTION__))
;
610 return std::move(Result);
611}
612
613void ClangdServer::enumerateTweaks(
614 PathRef File, Range Sel, llvm::unique_function<bool(const Tweak &)> Filter,
615 Callback<std::vector<TweakRef>> CB) {
616 // Tracks number of times a tweak has been offered.
617 static constexpr trace::Metric TweakAvailable(
618 "tweak_available", trace::Metric::Counter, "tweak_id");
619 auto Action = [Sel, CB = std::move(CB), Filter = std::move(Filter),
620 FeatureModules(this->FeatureModules)](
621 Expected<InputsAndAST> InpAST) mutable {
622 if (!InpAST)
623 return CB(InpAST.takeError());
624 auto Selections = tweakSelection(Sel, *InpAST, /*FS=*/nullptr);
625 if (!Selections)
626 return CB(Selections.takeError());
627 std::vector<TweakRef> Res;
628 // Don't allow a tweak to fire more than once across ambiguous selections.
629 llvm::DenseSet<llvm::StringRef> PreparedTweaks;
630 auto DeduplicatingFilter = [&](const Tweak &T) {
631 return Filter(T) && !PreparedTweaks.count(T.id());
632 };
633 for (const auto &Sel : *Selections) {
634 for (auto &T : prepareTweaks(*Sel, DeduplicatingFilter, FeatureModules)) {
635 Res.push_back({T->id(), T->title(), T->kind()});
636 PreparedTweaks.insert(T->id());
637 TweakAvailable.record(1, T->id());
638 }
639 }
640
641 CB(std::move(Res));
642 };
643
644 WorkScheduler->runWithAST("EnumerateTweaks", File, std::move(Action),
645 Transient);
646}
647
648void ClangdServer::applyTweak(PathRef File, Range Sel, StringRef TweakID,
649 Callback<Tweak::Effect> CB) {
650 // Tracks number of times a tweak has been attempted.
651 static constexpr trace::Metric TweakAttempt(
652 "tweak_attempt", trace::Metric::Counter, "tweak_id");
653 // Tracks number of times a tweak has failed to produce edits.
654 static constexpr trace::Metric TweakFailed(
655 "tweak_failed", trace::Metric::Counter, "tweak_id");
656 TweakAttempt.record(1, TweakID);
657 auto Action = [File = File.str(), Sel, TweakID = TweakID.str(),
658 CB = std::move(CB),
659 this](Expected<InputsAndAST> InpAST) mutable {
660 if (!InpAST)
661 return CB(InpAST.takeError());
662 auto FS = DirtyFS->view(llvm::None);
663 auto Selections = tweakSelection(Sel, *InpAST, FS.get());
664 if (!Selections)
665 return CB(Selections.takeError());
666 llvm::Optional<llvm::Expected<Tweak::Effect>> Effect;
667 // Try each selection, take the first one that prepare()s.
668 // If they all fail, Effect will hold get the last error.
669 for (const auto &Selection : *Selections) {
670 auto T = prepareTweak(TweakID, *Selection, FeatureModules);
671 if (T) {
672 Effect = (*T)->apply(*Selection);
673 break;
674 }
675 Effect = T.takeError();
676 }
677 assert(Effect && "Expected at least one selection")(static_cast <bool> (Effect && "Expected at least one selection"
) ? void (0) : __assert_fail ("Effect && \"Expected at least one selection\""
, "clang-tools-extra/clangd/ClangdServer.cpp", 677, __extension__
__PRETTY_FUNCTION__))
;
678 if (*Effect && (*Effect)->FormatEdits) {
679 // Format tweaks that require it centrally here.
680 for (auto &It : (*Effect)->ApplyEdits) {
681 Edit &E = It.second;
682 format::FormatStyle Style =
683 getFormatStyleForFile(File, E.InitialCode, TFS);
684 if (llvm::Error Err = reformatEdit(E, Style))
685 elog("Failed to format {0}: {1}", It.first(), std::move(Err));
686 }
687 } else {
688 TweakFailed.record(1, TweakID);
689 }
690 return CB(std::move(*Effect));
691 };
692 WorkScheduler->runWithAST("ApplyTweak", File, std::move(Action));
693}
694
695void ClangdServer::locateSymbolAt(PathRef File, Position Pos,
696 Callback<std::vector<LocatedSymbol>> CB) {
697 auto Action = [Pos, CB = std::move(CB),
698 this](llvm::Expected<InputsAndAST> InpAST) mutable {
699 if (!InpAST)
700 return CB(InpAST.takeError());
701 CB(clangd::locateSymbolAt(InpAST->AST, Pos, Index));
702 };
703
704 WorkScheduler->runWithAST("Definitions", File, std::move(Action));
705}
706
707void ClangdServer::switchSourceHeader(
708 PathRef Path, Callback<llvm::Optional<clangd::Path>> CB) {
709 // We want to return the result as fast as possible, strategy is:
710 // 1) use the file-only heuristic, it requires some IO but it is much
711 // faster than building AST, but it only works when .h/.cc files are in
712 // the same directory.
713 // 2) if 1) fails, we use the AST&Index approach, it is slower but supports
714 // different code layout.
715 if (auto CorrespondingFile =
716 getCorrespondingHeaderOrSource(Path, TFS.view(llvm::None)))
717 return CB(std::move(CorrespondingFile));
718 auto Action = [Path = Path.str(), CB = std::move(CB),
719 this](llvm::Expected<InputsAndAST> InpAST) mutable {
720 if (!InpAST)
721 return CB(InpAST.takeError());
722 CB(getCorrespondingHeaderOrSource(Path, InpAST->AST, Index));
723 };
724 WorkScheduler->runWithAST("SwitchHeaderSource", Path, std::move(Action));
725}
726
727void ClangdServer::findDocumentHighlights(
728 PathRef File, Position Pos, Callback<std::vector<DocumentHighlight>> CB) {
729 auto Action =
730 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
731 if (!InpAST)
732 return CB(InpAST.takeError());
733 CB(clangd::findDocumentHighlights(InpAST->AST, Pos));
734 };
735
736 WorkScheduler->runWithAST("Highlights", File, std::move(Action), Transient);
737}
738
739void ClangdServer::findHover(PathRef File, Position Pos,
740 Callback<llvm::Optional<HoverInfo>> CB) {
741 auto Action = [File = File.str(), Pos, CB = std::move(CB),
742 this](llvm::Expected<InputsAndAST> InpAST) mutable {
743 if (!InpAST)
744 return CB(InpAST.takeError());
745 format::FormatStyle Style = getFormatStyleForFile(
746 File, InpAST->Inputs.Contents, *InpAST->Inputs.TFS);
747 CB(clangd::getHover(InpAST->AST, Pos, std::move(Style), Index));
748 };
749
750 WorkScheduler->runWithAST("Hover", File, std::move(Action), Transient);
751}
752
753void ClangdServer::typeHierarchy(PathRef File, Position Pos, int Resolve,
754 TypeHierarchyDirection Direction,
755 Callback<std::vector<TypeHierarchyItem>> CB) {
756 auto Action = [File = File.str(), Pos, Resolve, Direction, CB = std::move(CB),
757 this](Expected<InputsAndAST> InpAST) mutable {
758 if (!InpAST)
759 return CB(InpAST.takeError());
760 CB(clangd::getTypeHierarchy(InpAST->AST, Pos, Resolve, Direction, Index,
761 File));
762 };
763
764 WorkScheduler->runWithAST("TypeHierarchy", File, std::move(Action));
765}
766
767void ClangdServer::superTypes(
768 const TypeHierarchyItem &Item,
769 Callback<llvm::Optional<std::vector<TypeHierarchyItem>>> CB) {
770 WorkScheduler->run("typeHierarchy/superTypes", /*Path=*/"",
771 [=, CB = std::move(CB)]() mutable {
772 CB(clangd::superTypes(Item, Index));
773 });
774}
775
776void ClangdServer::subTypes(const TypeHierarchyItem &Item,
777 Callback<std::vector<TypeHierarchyItem>> CB) {
778 WorkScheduler->run(
779 "typeHierarchy/subTypes", /*Path=*/"",
780 [=, CB = std::move(CB)]() mutable { CB(clangd::subTypes(Item, Index)); });
781}
782
783void ClangdServer::resolveTypeHierarchy(
784 TypeHierarchyItem Item, int Resolve, TypeHierarchyDirection Direction,
785 Callback<llvm::Optional<TypeHierarchyItem>> CB) {
786 WorkScheduler->run(
787 "Resolve Type Hierarchy", "", [=, CB = std::move(CB)]() mutable {
788 clangd::resolveTypeHierarchy(Item, Resolve, Direction, Index);
789 CB(Item);
790 });
791}
792
793void ClangdServer::prepareCallHierarchy(
794 PathRef File, Position Pos, Callback<std::vector<CallHierarchyItem>> CB) {
795 auto Action = [File = File.str(), Pos,
796 CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable {
797 if (!InpAST)
798 return CB(InpAST.takeError());
799 CB(clangd::prepareCallHierarchy(InpAST->AST, Pos, File));
800 };
801 WorkScheduler->runWithAST("CallHierarchy", File, std::move(Action));
802}
803
804void ClangdServer::incomingCalls(
805 const CallHierarchyItem &Item,
806 Callback<std::vector<CallHierarchyIncomingCall>> CB) {
807 WorkScheduler->run("Incoming Calls", "",
808 [CB = std::move(CB), Item, this]() mutable {
809 CB(clangd::incomingCalls(Item, Index));
810 });
811}
812
813void ClangdServer::inlayHints(PathRef File, llvm::Optional<Range> RestrictRange,
814 Callback<std::vector<InlayHint>> CB) {
815 auto Action = [RestrictRange(std::move(RestrictRange)),
816 CB = std::move(CB)](Expected<InputsAndAST> InpAST) mutable {
817 if (!InpAST)
818 return CB(InpAST.takeError());
819 CB(clangd::inlayHints(InpAST->AST, std::move(RestrictRange)));
820 };
821 WorkScheduler->runWithAST("InlayHints", File, std::move(Action), Transient);
822}
823
824void ClangdServer::onFileEvent(const DidChangeWatchedFilesParams &Params) {
825 // FIXME: Do nothing for now. This will be used for indexing and potentially
826 // invalidating other caches.
827}
828
829void ClangdServer::workspaceSymbols(
830 llvm::StringRef Query, int Limit,
831 Callback<std::vector<SymbolInformation>> CB) {
832 WorkScheduler->run(
833 "getWorkspaceSymbols", /*Path=*/"",
834 [Query = Query.str(), Limit, CB = std::move(CB), this]() mutable {
835 CB(clangd::getWorkspaceSymbols(Query, Limit, Index,
836 WorkspaceRoot.value_or("")));
837 });
838}
839
840void ClangdServer::documentSymbols(llvm::StringRef File,
841 Callback<std::vector<DocumentSymbol>> CB) {
842 auto Action =
843 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
844 if (!InpAST)
845 return CB(InpAST.takeError());
846 CB(clangd::getDocumentSymbols(InpAST->AST));
847 };
848 WorkScheduler->runWithAST("DocumentSymbols", File, std::move(Action),
849 Transient);
850}
851
852void ClangdServer::foldingRanges(llvm::StringRef File,
853 Callback<std::vector<FoldingRange>> CB) {
854 auto Code = getDraft(File);
855 if (!Code)
856 return CB(llvm::make_error<LSPError>(
857 "trying to compute folding ranges for non-added document",
858 ErrorCode::InvalidParams));
859 auto Action = [LineFoldingOnly = LineFoldingOnly, CB = std::move(CB),
860 Code = std::move(*Code)]() mutable {
861 CB(clangd::getFoldingRanges(Code, LineFoldingOnly));
862 };
863 // We want to make sure folding ranges are always available for all the open
864 // files, hence prefer runQuick to not wait for operations on other files.
865 WorkScheduler->runQuick("FoldingRanges", File, std::move(Action));
866}
867
868void ClangdServer::findType(llvm::StringRef File, Position Pos,
869 Callback<std::vector<LocatedSymbol>> CB) {
870 auto Action =
871 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
872 if (!InpAST)
873 return CB(InpAST.takeError());
874 CB(clangd::findType(InpAST->AST, Pos));
875 };
876 WorkScheduler->runWithAST("FindType", File, std::move(Action));
877}
878
879void ClangdServer::findImplementations(
880 PathRef File, Position Pos, Callback<std::vector<LocatedSymbol>> CB) {
881 auto Action = [Pos, CB = std::move(CB),
882 this](llvm::Expected<InputsAndAST> InpAST) mutable {
883 if (!InpAST)
884 return CB(InpAST.takeError());
885 CB(clangd::findImplementations(InpAST->AST, Pos, Index));
886 };
887
888 WorkScheduler->runWithAST("Implementations", File, std::move(Action));
889}
890
891void ClangdServer::findReferences(PathRef File, Position Pos, uint32_t Limit,
892 Callback<ReferencesResult> CB) {
893 auto Action = [Pos, Limit, CB = std::move(CB),
894 this](llvm::Expected<InputsAndAST> InpAST) mutable {
895 if (!InpAST)
896 return CB(InpAST.takeError());
897 CB(clangd::findReferences(InpAST->AST, Pos, Limit, Index));
898 };
899
900 WorkScheduler->runWithAST("References", File, std::move(Action));
901}
902
903void ClangdServer::symbolInfo(PathRef File, Position Pos,
904 Callback<std::vector<SymbolDetails>> CB) {
905 auto Action =
906 [Pos, CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
907 if (!InpAST)
908 return CB(InpAST.takeError());
909 CB(clangd::getSymbolInfo(InpAST->AST, Pos));
910 };
911
912 WorkScheduler->runWithAST("SymbolInfo", File, std::move(Action));
913}
914
915void ClangdServer::semanticRanges(PathRef File,
916 const std::vector<Position> &Positions,
917 Callback<std::vector<SelectionRange>> CB) {
918 auto Action = [Positions, CB = std::move(CB)](
919 llvm::Expected<InputsAndAST> InpAST) mutable {
920 if (!InpAST)
921 return CB(InpAST.takeError());
922 std::vector<SelectionRange> Result;
923 for (const auto &Pos : Positions) {
924 if (auto Range = clangd::getSemanticRanges(InpAST->AST, Pos))
925 Result.push_back(std::move(*Range));
926 else
927 return CB(Range.takeError());
928 }
929 CB(std::move(Result));
930 };
931 WorkScheduler->runWithAST("SemanticRanges", File, std::move(Action));
932}
933
934void ClangdServer::documentLinks(PathRef File,
935 Callback<std::vector<DocumentLink>> CB) {
936 auto Action =
937 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
938 if (!InpAST)
939 return CB(InpAST.takeError());
940 CB(clangd::getDocumentLinks(InpAST->AST));
941 };
942 WorkScheduler->runWithAST("DocumentLinks", File, std::move(Action),
943 Transient);
944}
945
946void ClangdServer::semanticHighlights(
947 PathRef File, Callback<std::vector<HighlightingToken>> CB) {
948 auto Action =
949 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
950 if (!InpAST)
951 return CB(InpAST.takeError());
952 CB(clangd::getSemanticHighlightings(InpAST->AST));
953 };
954 WorkScheduler->runWithAST("SemanticHighlights", File, std::move(Action),
955 Transient);
956}
957
958void ClangdServer::getAST(PathRef File, llvm::Optional<Range> R,
959 Callback<llvm::Optional<ASTNode>> CB) {
960 auto Action =
961 [R, CB(std::move(CB))](llvm::Expected<InputsAndAST> Inputs) mutable {
962 if (!Inputs)
963 return CB(Inputs.takeError());
964 if (!R) {
965 // It's safe to pass in the TU, as dumpAST() does not
966 // deserialize the preamble.
967 auto Node = DynTypedNode::create(
968 *Inputs->AST.getASTContext().getTranslationUnitDecl());
969 return CB(dumpAST(Node, Inputs->AST.getTokens(),
970 Inputs->AST.getASTContext()));
971 }
972 unsigned Start, End;
973 if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->start))
974 Start = *Offset;
975 else
976 return CB(Offset.takeError());
977 if (auto Offset = positionToOffset(Inputs->Inputs.Contents, R->end))
978 End = *Offset;
979 else
980 return CB(Offset.takeError());
981 bool Success = SelectionTree::createEach(
982 Inputs->AST.getASTContext(), Inputs->AST.getTokens(), Start, End,
983 [&](SelectionTree T) {
984 if (const SelectionTree::Node *N = T.commonAncestor()) {
985 CB(dumpAST(N->ASTNode, Inputs->AST.getTokens(),
986 Inputs->AST.getASTContext()));
987 return true;
988 }
989 return false;
990 });
991 if (!Success)
992 CB(llvm::None);
993 };
994 WorkScheduler->runWithAST("GetAST", File, std::move(Action));
995}
996
997void ClangdServer::customAction(PathRef File, llvm::StringRef Name,
998 Callback<InputsAndAST> Action) {
999 WorkScheduler->runWithAST(Name, File, std::move(Action));
1000}
1001
1002void ClangdServer::diagnostics(PathRef File, Callback<std::vector<Diag>> CB) {
1003 auto Action =
1004 [CB = std::move(CB)](llvm::Expected<InputsAndAST> InpAST) mutable {
1005 if (!InpAST)
1006 return CB(InpAST.takeError());
1007 if (auto Diags = InpAST->AST.getDiagnostics())
1008 return CB(*Diags);
1009 // FIXME: Use ServerCancelled error once it is settled in LSP-3.17.
1010 return CB(llvm::make_error<LSPError>("server is busy parsing includes",
1011 ErrorCode::InternalError));
1012 };
1013
1014 WorkScheduler->runWithAST("Diagnostics", File, std::move(Action));
1015}
1016
1017llvm::StringMap<TUScheduler::FileStats> ClangdServer::fileStats() const {
1018 return WorkScheduler->fileStats();
1019}
1020
1021[[nodiscard]] bool
1022ClangdServer::blockUntilIdleForTest(llvm::Optional<double> TimeoutSeconds) {
1023 // Order is important here: we don't want to block on A and then B,
1024 // if B might schedule work on A.
1025
1026#if defined(__has_feature)0 && \
1027 (__has_feature(address_sanitizer)0 || __has_feature(hwaddress_sanitizer)0 || \
1028 __has_feature(memory_sanitizer)0 || __has_feature(thread_sanitizer)0)
1029 (*TimeoutSeconds) *= 10;
1030#endif
1031
1032 // Nothing else can schedule work on TUScheduler, because it's not threadsafe
1033 // and we're blocking the main thread.
1034 if (!WorkScheduler->blockUntilIdle(timeoutSeconds(TimeoutSeconds)))
1035 return false;
1036 // TUScheduler is the only thing that starts background indexing work.
1037 if (IndexTasks && !IndexTasks->wait(timeoutSeconds(TimeoutSeconds)))
1038 return false;
1039
1040 // Unfortunately we don't have strict topological order between the rest of
1041 // the components. E.g. CDB broadcast triggers backrgound indexing.
1042 // This queries the CDB which may discover new work if disk has changed.
1043 //
1044 // So try each one a few times in a loop.
1045 // If there are no tricky interactions then all after the first are no-ops.
1046 // Then on the last iteration, verify they're idle without waiting.
1047 //
1048 // There's a small chance they're juggling work and we didn't catch them :-(
1049 for (llvm::Optional<double> Timeout :
1050 {TimeoutSeconds, TimeoutSeconds, llvm::Optional<double>(0)}) {
1051 if (!CDB.blockUntilIdle(timeoutSeconds(Timeout)))
1052 return false;
1053 if (BackgroundIdx && !BackgroundIdx->blockUntilIdleForTest(Timeout))
1054 return false;
1055 if (FeatureModules && llvm::any_of(*FeatureModules, [&](FeatureModule &M) {
1056 return !M.blockUntilIdle(timeoutSeconds(Timeout));
1057 }))
1058 return false;
1059 }
1060
1061 assert(WorkScheduler->blockUntilIdle(Deadline::zero()) &&(static_cast <bool> (WorkScheduler->blockUntilIdle(Deadline
::zero()) && "Something scheduled work while we're blocking the main thread!"
) ? void (0) : __assert_fail ("WorkScheduler->blockUntilIdle(Deadline::zero()) && \"Something scheduled work while we're blocking the main thread!\""
, "clang-tools-extra/clangd/ClangdServer.cpp", 1062, __extension__
__PRETTY_FUNCTION__))
1062 "Something scheduled work while we're blocking the main thread!")(static_cast <bool> (WorkScheduler->blockUntilIdle(Deadline
::zero()) && "Something scheduled work while we're blocking the main thread!"
) ? void (0) : __assert_fail ("WorkScheduler->blockUntilIdle(Deadline::zero()) && \"Something scheduled work while we're blocking the main thread!\""
, "clang-tools-extra/clangd/ClangdServer.cpp", 1062, __extension__
__PRETTY_FUNCTION__))
;
1063 return true;
1064}
1065
1066void ClangdServer::profile(MemoryTree &MT) const {
1067 if (DynamicIdx)
1068 DynamicIdx->profile(MT.child("dynamic_index"));
1069 if (BackgroundIdx)
1070 BackgroundIdx->profile(MT.child("background_index"));
1071 WorkScheduler->profile(MT.child("tuscheduler"));
1072}
1073} // namespace clangd
1074} // namespace clang

/usr/lib/gcc/x86_64-linux-gnu/10/../../../../include/c++/10/bits/unique_ptr.h

1// unique_ptr implementation -*- C++ -*-
2
3// Copyright (C) 2008-2020 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library. This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 3, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// Under Section 7 of GPL version 3, you are granted additional
17// permissions described in the GCC Runtime Library Exception, version
18// 3.1, as published by the Free Software Foundation.
19
20// You should have received a copy of the GNU General Public License and
21// a copy of the GCC Runtime Library Exception along with this program;
22// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23// <http://www.gnu.org/licenses/>.
24
25/** @file bits/unique_ptr.h
26 * This is an internal header file, included by other library headers.
27 * Do not attempt to use it directly. @headername{memory}
28 */
29
30#ifndef _UNIQUE_PTR_H1
31#define _UNIQUE_PTR_H1 1
32
33#include <bits/c++config.h>
34#include <debug/assertions.h>
35#include <type_traits>
36#include <utility>
37#include <tuple>
38#include <bits/stl_function.h>
39#include <bits/functional_hash.h>
40#if __cplusplus201703L > 201703L
41# include <compare>
42# include <ostream>
43#endif
44
45namespace std _GLIBCXX_VISIBILITY(default)__attribute__ ((__visibility__ ("default")))
46{
47_GLIBCXX_BEGIN_NAMESPACE_VERSION
48
49 /**
50 * @addtogroup pointer_abstractions
51 * @{
52 */
53
54#if _GLIBCXX_USE_DEPRECATED1
55#pragma GCC diagnostic push
56#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
57 template<typename> class auto_ptr;
58#pragma GCC diagnostic pop
59#endif
60
61 /// Primary template of default_delete, used by unique_ptr for single objects
62 template<typename _Tp>
63 struct default_delete
64 {
65 /// Default constructor
66 constexpr default_delete() noexcept = default;
67
68 /** @brief Converting constructor.
69 *
70 * Allows conversion from a deleter for objects of another type, `_Up`,
71 * only if `_Up*` is convertible to `_Tp*`.
72 */
73 template<typename _Up,
74 typename = _Require<is_convertible<_Up*, _Tp*>>>
75 default_delete(const default_delete<_Up>&) noexcept { }
76
77 /// Calls `delete __ptr`
78 void
79 operator()(_Tp* __ptr) const
80 {
81 static_assert(!is_void<_Tp>::value,
82 "can't delete pointer to incomplete type");
83 static_assert(sizeof(_Tp)>0,
84 "can't delete pointer to incomplete type");
85 delete __ptr;
86 }
87 };
88
89 // _GLIBCXX_RESOLVE_LIB_DEFECTS
90 // DR 740 - omit specialization for array objects with a compile time length
91
92 /// Specialization of default_delete for arrays, used by `unique_ptr<T[]>`
93 template<typename _Tp>
94 struct default_delete<_Tp[]>
95 {
96 public:
97 /// Default constructor
98 constexpr default_delete() noexcept = default;
99
100 /** @brief Converting constructor.
101 *
102 * Allows conversion from a deleter for arrays of another type, such as
103 * a const-qualified version of `_Tp`.
104 *
105 * Conversions from types derived from `_Tp` are not allowed because
106 * it is undefined to `delete[]` an array of derived types through a
107 * pointer to the base type.
108 */
109 template<typename _Up,
110 typename = _Require<is_convertible<_Up(*)[], _Tp(*)[]>>>
111 default_delete(const default_delete<_Up[]>&) noexcept { }
112
113 /// Calls `delete[] __ptr`
114 template<typename _Up>
115 typename enable_if<is_convertible<_Up(*)[], _Tp(*)[]>::value>::type
116 operator()(_Up* __ptr) const
117 {
118 static_assert(sizeof(_Tp)>0,
119 "can't delete pointer to incomplete type");
120 delete [] __ptr;
121 }
122 };
123
124 /// @cond undocumented
125
126 // Manages the pointer and deleter of a unique_ptr
127 template <typename _Tp, typename _Dp>
128 class __uniq_ptr_impl
129 {
130 template <typename _Up, typename _Ep, typename = void>
131 struct _Ptr
132 {
133 using type = _Up*;
134 };
135
136 template <typename _Up, typename _Ep>
137 struct
138 _Ptr<_Up, _Ep, __void_t<typename remove_reference<_Ep>::type::pointer>>
139 {
140 using type = typename remove_reference<_Ep>::type::pointer;
141 };
142
143 public:
144 using _DeleterConstraint = enable_if<
145 __and_<__not_<is_pointer<_Dp>>,
146 is_default_constructible<_Dp>>::value>;
147
148 using pointer = typename _Ptr<_Tp, _Dp>::type;
149
150 static_assert( !is_rvalue_reference<_Dp>::value,
151 "unique_ptr's deleter type must be a function object type"
152 " or an lvalue reference type" );
153
154 __uniq_ptr_impl() = default;
155 __uniq_ptr_impl(pointer __p) : _M_t() { _M_ptr() = __p; }
156
157 template<typename _Del>
158 __uniq_ptr_impl(pointer __p, _Del&& __d)
159 : _M_t(__p, std::forward<_Del>(__d)) { }
160
161 __uniq_ptr_impl(__uniq_ptr_impl&& __u) noexcept
162 : _M_t(std::move(__u._M_t))
163 { __u._M_ptr() = nullptr; }
164
165 __uniq_ptr_impl& operator=(__uniq_ptr_impl&& __u) noexcept
166 {
167 reset(__u.release());
168 _M_deleter() = std::forward<_Dp>(__u._M_deleter());
169 return *this;
170 }
171
172 pointer& _M_ptr() { return std::get<0>(_M_t); }
173 pointer _M_ptr() const { return std::get<0>(_M_t); }
174 _Dp& _M_deleter() { return std::get<1>(_M_t); }
175 const _Dp& _M_deleter() const { return std::get<1>(_M_t); }
176
177 void reset(pointer __p) noexcept
178 {
179 const pointer __old_p = _M_ptr();
180 _M_ptr() = __p;
181 if (__old_p)
182 _M_deleter()(__old_p);
183 }
184
185 pointer release() noexcept
186 {
187 pointer __p = _M_ptr();
188 _M_ptr() = nullptr;
189 return __p;
190 }
191
192 void
193 swap(__uniq_ptr_impl& __rhs) noexcept
194 {
195 using std::swap;
196 swap(this->_M_ptr(), __rhs._M_ptr());
197 swap(this->_M_deleter(), __rhs._M_deleter());
198 }
199
200 private:
201 tuple<pointer, _Dp> _M_t;
202 };
203
204 // Defines move construction + assignment as either defaulted or deleted.
205 template <typename _Tp, typename _Dp,
206 bool = is_move_constructible<_Dp>::value,
207 bool = is_move_assignable<_Dp>::value>
208 struct __uniq_ptr_data : __uniq_ptr_impl<_Tp, _Dp>
209 {
210 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
211 __uniq_ptr_data(__uniq_ptr_data&&) = default;
212 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default;
213 };
214
215 template <typename _Tp, typename _Dp>
216 struct __uniq_ptr_data<_Tp, _Dp, true, false> : __uniq_ptr_impl<_Tp, _Dp>
217 {
218 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
219 __uniq_ptr_data(__uniq_ptr_data&&) = default;
220 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete;
221 };
222
223 template <typename _Tp, typename _Dp>
224 struct __uniq_ptr_data<_Tp, _Dp, false, true> : __uniq_ptr_impl<_Tp, _Dp>
225 {
226 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
227 __uniq_ptr_data(__uniq_ptr_data&&) = delete;
228 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = default;
229 };
230
231 template <typename _Tp, typename _Dp>
232 struct __uniq_ptr_data<_Tp, _Dp, false, false> : __uniq_ptr_impl<_Tp, _Dp>
233 {
234 using __uniq_ptr_impl<_Tp, _Dp>::__uniq_ptr_impl;
235 __uniq_ptr_data(__uniq_ptr_data&&) = delete;
236 __uniq_ptr_data& operator=(__uniq_ptr_data&&) = delete;
237 };
238 /// @endcond
239
240 /// 20.7.1.2 unique_ptr for single objects.
241 template <typename _Tp, typename _Dp = default_delete<_Tp>>
242 class unique_ptr
243 {
244 template <typename _Up>
245 using _DeleterConstraint =
246 typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type;
247
248 __uniq_ptr_data<_Tp, _Dp> _M_t;
249
250 public:
251 using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer;
252 using element_type = _Tp;
253 using deleter_type = _Dp;
254
255 private:
256 // helper template for detecting a safe conversion from another
257 // unique_ptr
258 template<typename _Up, typename _Ep>
259 using __safe_conversion_up = __and_<
260 is_convertible<typename unique_ptr<_Up, _Ep>::pointer, pointer>,
261 __not_<is_array<_Up>>
262 >;
263
264 public:
265 // Constructors.
266
267 /// Default constructor, creates a unique_ptr that owns nothing.
268 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
269 constexpr unique_ptr() noexcept
270 : _M_t()
271 { }
272
273 /** Takes ownership of a pointer.
274 *
275 * @param __p A pointer to an object of @c element_type
276 *
277 * The deleter will be value-initialized.
278 */
279 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
280 explicit
281 unique_ptr(pointer __p) noexcept
282 : _M_t(__p)
283 { }
284
285 /** Takes ownership of a pointer.
286 *
287 * @param __p A pointer to an object of @c element_type
288 * @param __d A reference to a deleter.
289 *
290 * The deleter will be initialized with @p __d
291 */
292 template<typename _Del = deleter_type,
293 typename = _Require<is_copy_constructible<_Del>>>
294 unique_ptr(pointer __p, const deleter_type& __d) noexcept
295 : _M_t(__p, __d) { }
296
297 /** Takes ownership of a pointer.
298 *
299 * @param __p A pointer to an object of @c element_type
300 * @param __d An rvalue reference to a (non-reference) deleter.
301 *
302 * The deleter will be initialized with @p std::move(__d)
303 */
304 template<typename _Del = deleter_type,
305 typename = _Require<is_move_constructible<_Del>>>
306 unique_ptr(pointer __p,
307 __enable_if_t<!is_lvalue_reference<_Del>::value,
308 _Del&&> __d) noexcept
309 : _M_t(__p, std::move(__d))
310 { }
311
312 template<typename _Del = deleter_type,
313 typename _DelUnref = typename remove_reference<_Del>::type>
314 unique_ptr(pointer,
315 __enable_if_t<is_lvalue_reference<_Del>::value,
316 _DelUnref&&>) = delete;
317
318 /// Creates a unique_ptr that owns nothing.
319 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
320 constexpr unique_ptr(nullptr_t) noexcept
321 : _M_t()
322 { }
323
324 // Move constructors.
325
326 /// Move constructor.
327 unique_ptr(unique_ptr&&) = default;
328
329 /** @brief Converting constructor from another type
330 *
331 * Requires that the pointer owned by @p __u is convertible to the
332 * type of pointer owned by this object, @p __u does not own an array,
333 * and @p __u has a compatible deleter type.
334 */
335 template<typename _Up, typename _Ep, typename = _Require<
336 __safe_conversion_up<_Up, _Ep>,
337 typename conditional<is_reference<_Dp>::value,
338 is_same<_Ep, _Dp>,
339 is_convertible<_Ep, _Dp>>::type>>
340 unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept
341 : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter()))
342 { }
343
344#if _GLIBCXX_USE_DEPRECATED1
345#pragma GCC diagnostic push
346#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
347 /// Converting constructor from @c auto_ptr
348 template<typename _Up, typename = _Require<
349 is_convertible<_Up*, _Tp*>, is_same<_Dp, default_delete<_Tp>>>>
350 unique_ptr(auto_ptr<_Up>&& __u) noexcept;
351#pragma GCC diagnostic pop
352#endif
353
354 /// Destructor, invokes the deleter if the stored pointer is not null.
355 ~unique_ptr() noexcept
356 {
357 static_assert(__is_invocable<deleter_type&, pointer>::value,
358 "unique_ptr's deleter must be invocable with a pointer");
359 auto& __ptr = _M_t._M_ptr();
360 if (__ptr != nullptr)
361 get_deleter()(std::move(__ptr));
362 __ptr = pointer();
363 }
364
365 // Assignment.
366
367 /** @brief Move assignment operator.
368 *
369 * Invokes the deleter if this object owns a pointer.
370 */
371 unique_ptr& operator=(unique_ptr&&) = default;
372
373 /** @brief Assignment from another type.
374 *
375 * @param __u The object to transfer ownership from, which owns a
376 * convertible pointer to a non-array object.
377 *
378 * Invokes the deleter if this object owns a pointer.
379 */
380 template<typename _Up, typename _Ep>
381 typename enable_if< __and_<
382 __safe_conversion_up<_Up, _Ep>,
383 is_assignable<deleter_type&, _Ep&&>
384 >::value,
385 unique_ptr&>::type
386 operator=(unique_ptr<_Up, _Ep>&& __u) noexcept
387 {
388 reset(__u.release());
389 get_deleter() = std::forward<_Ep>(__u.get_deleter());
390 return *this;
391 }
392
393 /// Reset the %unique_ptr to empty, invoking the deleter if necessary.
394 unique_ptr&
395 operator=(nullptr_t) noexcept
396 {
397 reset();
398 return *this;
399 }
400
401 // Observers.
402
403 /// Dereference the stored pointer.
404 typename add_lvalue_reference<element_type>::type
405 operator*() const
406 {
407 __glibcxx_assert(get() != pointer());
408 return *get();
409 }
410
411 /// Return the stored pointer.
412 pointer
413 operator->() const noexcept
414 {
415 _GLIBCXX_DEBUG_PEDASSERT(get() != pointer());
416 return get();
417 }
418
419 /// Return the stored pointer.
420 pointer
421 get() const noexcept
422 { return _M_t._M_ptr(); }
423
424 /// Return a reference to the stored deleter.
425 deleter_type&
426 get_deleter() noexcept
427 { return _M_t._M_deleter(); }
428
429 /// Return a reference to the stored deleter.
430 const deleter_type&
431 get_deleter() const noexcept
432 { return _M_t._M_deleter(); }
433
434 /// Return @c true if the stored pointer is not null.
435 explicit operator bool() const noexcept
436 { return get() == pointer() ? false : true; }
437
438 // Modifiers.
439
440 /// Release ownership of any stored pointer.
441 pointer
442 release() noexcept
443 { return _M_t.release(); }
444
445 /** @brief Replace the stored pointer.
446 *
447 * @param __p The new pointer to store.
448 *
449 * The deleter will be invoked if a pointer is already owned.
450 */
451 void
452 reset(pointer __p = pointer()) noexcept
453 {
454 static_assert(__is_invocable<deleter_type&, pointer>::value,
455 "unique_ptr's deleter must be invocable with a pointer");
456 _M_t.reset(std::move(__p));
457 }
458
459 /// Exchange the pointer and deleter with another object.
460 void
461 swap(unique_ptr& __u) noexcept
462 {
463 static_assert(__is_swappable<_Dp>::value, "deleter must be swappable");
464 _M_t.swap(__u._M_t);
465 }
466
467 // Disable copy from lvalue.
468 unique_ptr(const unique_ptr&) = delete;
469 unique_ptr& operator=(const unique_ptr&) = delete;
470 };
471
472 /// 20.7.1.3 unique_ptr for array objects with a runtime length
473 // [unique.ptr.runtime]
474 // _GLIBCXX_RESOLVE_LIB_DEFECTS
475 // DR 740 - omit specialization for array objects with a compile time length
476 template<typename _Tp, typename _Dp>
477 class unique_ptr<_Tp[], _Dp>
478 {
479 template <typename _Up>
480 using _DeleterConstraint =
481 typename __uniq_ptr_impl<_Tp, _Up>::_DeleterConstraint::type;
482
483 __uniq_ptr_data<_Tp, _Dp> _M_t;
484
485 template<typename _Up>
486 using __remove_cv = typename remove_cv<_Up>::type;
487
488 // like is_base_of<_Tp, _Up> but false if unqualified types are the same
489 template<typename _Up>
490 using __is_derived_Tp
491 = __and_< is_base_of<_Tp, _Up>,
492 __not_<is_same<__remove_cv<_Tp>, __remove_cv<_Up>>> >;
493
494 public:
495 using pointer = typename __uniq_ptr_impl<_Tp, _Dp>::pointer;
496 using element_type = _Tp;
497 using deleter_type = _Dp;
498
499 // helper template for detecting a safe conversion from another
500 // unique_ptr
501 template<typename _Up, typename _Ep,
502 typename _UPtr = unique_ptr<_Up, _Ep>,
503 typename _UP_pointer = typename _UPtr::pointer,
504 typename _UP_element_type = typename _UPtr::element_type>
505 using __safe_conversion_up = __and_<
506 is_array<_Up>,
507 is_same<pointer, element_type*>,
508 is_same<_UP_pointer, _UP_element_type*>,
509 is_convertible<_UP_element_type(*)[], element_type(*)[]>
510 >;
511
512 // helper template for detecting a safe conversion from a raw pointer
513 template<typename _Up>
514 using __safe_conversion_raw = __and_<
515 __or_<__or_<is_same<_Up, pointer>,
516 is_same<_Up, nullptr_t>>,
517 __and_<is_pointer<_Up>,
518 is_same<pointer, element_type*>,
519 is_convertible<
520 typename remove_pointer<_Up>::type(*)[],
521 element_type(*)[]>
522 >
523 >
524 >;
525
526 // Constructors.
527
528 /// Default constructor, creates a unique_ptr that owns nothing.
529 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
530 constexpr unique_ptr() noexcept
531 : _M_t()
532 { }
533
534 /** Takes ownership of a pointer.
535 *
536 * @param __p A pointer to an array of a type safely convertible
537 * to an array of @c element_type
538 *
539 * The deleter will be value-initialized.
540 */
541 template<typename _Up,
542 typename _Vp = _Dp,
543 typename = _DeleterConstraint<_Vp>,
544 typename = typename enable_if<
545 __safe_conversion_raw<_Up>::value, bool>::type>
546 explicit
547 unique_ptr(_Up __p) noexcept
548 : _M_t(__p)
549 { }
550
551 /** Takes ownership of a pointer.
552 *
553 * @param __p A pointer to an array of a type safely convertible
554 * to an array of @c element_type
555 * @param __d A reference to a deleter.
556 *
557 * The deleter will be initialized with @p __d
558 */
559 template<typename _Up, typename _Del = deleter_type,
560 typename = _Require<__safe_conversion_raw<_Up>,
561 is_copy_constructible<_Del>>>
562 unique_ptr(_Up __p, const deleter_type& __d) noexcept
563 : _M_t(__p, __d) { }
564
565 /** Takes ownership of a pointer.
566 *
567 * @param __p A pointer to an array of a type safely convertible
568 * to an array of @c element_type
569 * @param __d A reference to a deleter.
570 *
571 * The deleter will be initialized with @p std::move(__d)
572 */
573 template<typename _Up, typename _Del = deleter_type,
574 typename = _Require<__safe_conversion_raw<_Up>,
575 is_move_constructible<_Del>>>
576 unique_ptr(_Up __p,
577 __enable_if_t<!is_lvalue_reference<_Del>::value,
578 _Del&&> __d) noexcept
579 : _M_t(std::move(__p), std::move(__d))
580 { }
581
582 template<typename _Up, typename _Del = deleter_type,
583 typename _DelUnref = typename remove_reference<_Del>::type,
584 typename = _Require<__safe_conversion_raw<_Up>>>
585 unique_ptr(_Up,
586 __enable_if_t<is_lvalue_reference<_Del>::value,
587 _DelUnref&&>) = delete;
588
589 /// Move constructor.
590 unique_ptr(unique_ptr&&) = default;
591
592 /// Creates a unique_ptr that owns nothing.
593 template<typename _Del = _Dp, typename = _DeleterConstraint<_Del>>
594 constexpr unique_ptr(nullptr_t) noexcept
595 : _M_t()
596 { }
597
598 template<typename _Up, typename _Ep, typename = _Require<
599 __safe_conversion_up<_Up, _Ep>,
600 typename conditional<is_reference<_Dp>::value,
601 is_same<_Ep, _Dp>,
602 is_convertible<_Ep, _Dp>>::type>>
603 unique_ptr(unique_ptr<_Up, _Ep>&& __u) noexcept
604 : _M_t(__u.release(), std::forward<_Ep>(__u.get_deleter()))
605 { }
606
607 /// Destructor, invokes the deleter if the stored pointer is not null.
608 ~unique_ptr()
609 {
610 auto& __ptr = _M_t._M_ptr();
611 if (__ptr != nullptr)
612 get_deleter()(__ptr);
613 __ptr = pointer();
614 }
615
616 // Assignment.
617
618 /** @brief Move assignment operator.
619 *
620 * Invokes the deleter if this object owns a pointer.
621 */
622 unique_ptr&
623 operator=(unique_ptr&&) = default;
624
625 /** @brief Assignment from another type.
626 *
627 * @param __u The object to transfer ownership from, which owns a
628 * convertible pointer to an array object.
629 *
630 * Invokes the deleter if this object owns a pointer.
631 */
632 template<typename _Up, typename _Ep>
633 typename
634 enable_if<__and_<__safe_conversion_up<_Up, _Ep>,
635 is_assignable<deleter_type&, _Ep&&>
636 >::value,
637 unique_ptr&>::type
638 operator=(unique_ptr<_Up, _Ep>&& __u) noexcept
639 {
640 reset(__u.release());
641 get_deleter() = std::forward<_Ep>(__u.get_deleter());
642 return *this;
643 }
644
645 /// Reset the %unique_ptr to empty, invoking the deleter if necessary.
646 unique_ptr&
647 operator=(nullptr_t) noexcept
648 {
649 reset();
650 return *this;
651 }
652
653 // Observers.
654
655 /// Access an element of owned array.
656 typename std::add_lvalue_reference<element_type>::type
657 operator[](size_t __i) const
658 {
659 __glibcxx_assert(get() != pointer());
660 return get()[__i];
661 }
662
663 /// Return the stored pointer.
664 pointer
665 get() const noexcept
666 { return _M_t._M_ptr(); }
667
668 /// Return a reference to the stored deleter.
669 deleter_type&
670 get_deleter() noexcept
671 { return _M_t._M_deleter(); }
672
673 /// Return a reference to the stored deleter.
674 const deleter_type&
675 get_deleter() const noexcept
676 { return _M_t._M_deleter(); }
677
678 /// Return @c true if the stored pointer is not null.
679 explicit operator bool() const noexcept
680 { return get() == pointer() ? false : true; }
681
682 // Modifiers.
683
684 /// Release ownership of any stored pointer.
685 pointer
686 release() noexcept
687 { return _M_t.release(); }
688
689 /** @brief Replace the stored pointer.
690 *
691 * @param __p The new pointer to store.
692 *
693 * The deleter will be invoked if a pointer is already owned.
694 */
695 template <typename _Up,
696 typename = _Require<
697 __or_<is_same<_Up, pointer>,
698 __and_<is_same<pointer, element_type*>,
699 is_pointer<_Up>,
700 is_convertible<
701 typename remove_pointer<_Up>::type(*)[],
702 element_type(*)[]
703 >
704 >
705 >
706 >>
707 void
708 reset(_Up __p) noexcept
709 { _M_t.reset(std::move(__p)); }
710
711 void reset(nullptr_t = nullptr) noexcept
712 { reset(pointer()); }
713
714 /// Exchange the pointer and deleter with another object.
715 void
716 swap(unique_ptr& __u) noexcept
717 {
718 static_assert(__is_swappable<_Dp>::value, "deleter must be swappable");
719 _M_t.swap(__u._M_t);
720 }
721
722 // Disable copy from lvalue.
723 unique_ptr(const unique_ptr&) = delete;
724 unique_ptr& operator=(const unique_ptr&) = delete;
725 };
726
727 /// @relates unique_ptr @{
728
729 /// Swap overload for unique_ptr
730 template<typename _Tp, typename _Dp>
731 inline
732#if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11
733 // Constrained free swap overload, see p0185r1
734 typename enable_if<__is_swappable<_Dp>::value>::type
735#else
736 void
737#endif
738 swap(unique_ptr<_Tp, _Dp>& __x,
739 unique_ptr<_Tp, _Dp>& __y) noexcept
740 { __x.swap(__y); }
741
742#if __cplusplus201703L > 201402L || !defined(__STRICT_ANSI__1) // c++1z or gnu++11
743 template<typename _Tp, typename _Dp>
744 typename enable_if<!__is_swappable<_Dp>::value>::type
745 swap(unique_ptr<_Tp, _Dp>&,
746 unique_ptr<_Tp, _Dp>&) = delete;
747#endif
748
749 /// Equality operator for unique_ptr objects, compares the owned pointers
750 template<typename _Tp, typename _Dp,
751 typename _Up, typename _Ep>
752 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
753 operator==(const unique_ptr<_Tp, _Dp>& __x,
754 const unique_ptr<_Up, _Ep>& __y)
755 { return __x.get() == __y.get(); }
756
757 /// unique_ptr comparison with nullptr
758 template<typename _Tp, typename _Dp>
759 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
760 operator==(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept
761 { return !__x; }
762
763#ifndef __cpp_lib_three_way_comparison
764 /// unique_ptr comparison with nullptr
765 template<typename _Tp, typename _Dp>
766 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
767 operator==(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept
768 { return !__x; }
769
770 /// Inequality operator for unique_ptr objects, compares the owned pointers
771 template<typename _Tp, typename _Dp,
772 typename _Up, typename _Ep>
773 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
774 operator!=(const unique_ptr<_Tp, _Dp>& __x,
775 const unique_ptr<_Up, _Ep>& __y)
776 { return __x.get() != __y.get(); }
777
778 /// unique_ptr comparison with nullptr
779 template<typename _Tp, typename _Dp>
780 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
781 operator!=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t) noexcept
782 { return (bool)__x; }
783
784 /// unique_ptr comparison with nullptr
785 template<typename _Tp, typename _Dp>
786 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
787 operator!=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x) noexcept
788 { return (bool)__x; }
789#endif // three way comparison
790
791 /// Relational operator for unique_ptr objects, compares the owned pointers
792 template<typename _Tp, typename _Dp,
793 typename _Up, typename _Ep>
794 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
795 operator<(const unique_ptr<_Tp, _Dp>& __x,
796 const unique_ptr<_Up, _Ep>& __y)
797 {
798 typedef typename
799 std::common_type<typename unique_ptr<_Tp, _Dp>::pointer,
800 typename unique_ptr<_Up, _Ep>::pointer>::type _CT;
801 return std::less<_CT>()(__x.get(), __y.get());
802 }
803
804 /// unique_ptr comparison with nullptr
805 template<typename _Tp, typename _Dp>
806 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
807 operator<(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
808 {
809 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(),
810 nullptr);
811 }
812
813 /// unique_ptr comparison with nullptr
814 template<typename _Tp, typename _Dp>
815 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
816 operator<(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
817 {
818 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr,
819 __x.get());
820 }
821
822 /// Relational operator for unique_ptr objects, compares the owned pointers
823 template<typename _Tp, typename _Dp,
824 typename _Up, typename _Ep>
825 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
826 operator<=(const unique_ptr<_Tp, _Dp>& __x,
827 const unique_ptr<_Up, _Ep>& __y)
828 { return !(__y < __x); }
829
830 /// unique_ptr comparison with nullptr
831 template<typename _Tp, typename _Dp>
832 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
833 operator<=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
834 { return !(nullptr < __x); }
835
836 /// unique_ptr comparison with nullptr
837 template<typename _Tp, typename _Dp>
838 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
839 operator<=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
840 { return !(__x < nullptr); }
841
842 /// Relational operator for unique_ptr objects, compares the owned pointers
843 template<typename _Tp, typename _Dp,
844 typename _Up, typename _Ep>
845 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
846 operator>(const unique_ptr<_Tp, _Dp>& __x,
847 const unique_ptr<_Up, _Ep>& __y)
848 { return (__y < __x); }
849
850 /// unique_ptr comparison with nullptr
851 template<typename _Tp, typename _Dp>
852 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
853 operator>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
854 {
855 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(nullptr,
856 __x.get());
857 }
858
859 /// unique_ptr comparison with nullptr
860 template<typename _Tp, typename _Dp>
861 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
862 operator>(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
863 {
864 return std::less<typename unique_ptr<_Tp, _Dp>::pointer>()(__x.get(),
865 nullptr);
866 }
867
868 /// Relational operator for unique_ptr objects, compares the owned pointers
869 template<typename _Tp, typename _Dp,
870 typename _Up, typename _Ep>
871 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
872 operator>=(const unique_ptr<_Tp, _Dp>& __x,
873 const unique_ptr<_Up, _Ep>& __y)
874 { return !(__x < __y); }
875
876 /// unique_ptr comparison with nullptr
877 template<typename _Tp, typename _Dp>
878 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
879 operator>=(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
880 { return !(__x < nullptr); }
881
882 /// unique_ptr comparison with nullptr
883 template<typename _Tp, typename _Dp>
884 _GLIBCXX_NODISCARD[[__nodiscard__]] inline bool
885 operator>=(nullptr_t, const unique_ptr<_Tp, _Dp>& __x)
886 { return !(nullptr < __x); }
887
888#ifdef __cpp_lib_three_way_comparison
889 template<typename _Tp, typename _Dp, typename _Up, typename _Ep>
890 requires three_way_comparable_with<typename unique_ptr<_Tp, _Dp>::pointer,
891 typename unique_ptr<_Up, _Ep>::pointer>
892 inline
893 compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer,
894 typename unique_ptr<_Up, _Ep>::pointer>
895 operator<=>(const unique_ptr<_Tp, _Dp>& __x,
896 const unique_ptr<_Up, _Ep>& __y)
897 { return compare_three_way()(__x.get(), __y.get()); }
898
899 template<typename _Tp, typename _Dp>
900 requires three_way_comparable<typename unique_ptr<_Tp, _Dp>::pointer>
901 inline
902 compare_three_way_result_t<typename unique_ptr<_Tp, _Dp>::pointer>
903 operator<=>(const unique_ptr<_Tp, _Dp>& __x, nullptr_t)
904 {
905 using pointer = typename unique_ptr<_Tp, _Dp>::pointer;
906 return compare_three_way()(__x.get(), static_cast<pointer>(nullptr));
907 }
908#endif
909 // @} relates unique_ptr
910
911 /// @cond undocumented
912 template<typename _Up, typename _Ptr = typename _Up::pointer,
913 bool = __poison_hash<_Ptr>::__enable_hash_call>
914 struct __uniq_ptr_hash
915#if ! _GLIBCXX_INLINE_VERSION0
916 : private __poison_hash<_Ptr>
917#endif
918 {
919 size_t
920 operator()(const _Up& __u) const
921 noexcept(noexcept(std::declval<hash<_Ptr>>()(std::declval<_Ptr>())))
922 { return hash<_Ptr>()(__u.get()); }
923 };
924
925 template<typename _Up, typename _Ptr>
926 struct __uniq_ptr_hash<_Up, _Ptr, false>
927 : private __poison_hash<_Ptr>
928 { };
929 /// @endcond
930
931 /// std::hash specialization for unique_ptr.
932 template<typename _Tp, typename _Dp>
933 struct hash<unique_ptr<_Tp, _Dp>>
934 : public __hash_base<size_t, unique_ptr<_Tp, _Dp>>,
935 public __uniq_ptr_hash<unique_ptr<_Tp, _Dp>>
936 { };
937
938#if __cplusplus201703L >= 201402L
939 /// @relates unique_ptr @{
940#define __cpp_lib_make_unique201304 201304
941
942 /// @cond undocumented
943
944 template<typename _Tp>
945 struct _MakeUniq
946 { typedef unique_ptr<_Tp> __single_object; };
947
948 template<typename _Tp>
949 struct _MakeUniq<_Tp[]>
950 { typedef unique_ptr<_Tp[]> __array; };
951
952 template<typename _Tp, size_t _Bound>
953 struct _MakeUniq<_Tp[_Bound]>
954 { struct __invalid_type { }; };
955
956 /// @endcond
957
958 /// std::make_unique for single objects
959 template<typename _Tp, typename... _Args>
960 inline typename _MakeUniq<_Tp>::__single_object
961 make_unique(_Args&&... __args)
962 { return unique_ptr<_Tp>(new _Tp(std::forward<_Args>(__args)...)); }
7
Memory is allocated
963
964 /// std::make_unique for arrays of unknown bound
965 template<typename _Tp>
966 inline typename _MakeUniq<_Tp>::__array
967 make_unique(size_t __num)
968 { return unique_ptr<_Tp>(new remove_extent_t<_Tp>[__num]()); }
969
970 /// Disable std::make_unique for arrays of known bound
971 template<typename _Tp, typename... _Args>
972 inline typename _MakeUniq<_Tp>::__invalid_type
973 make_unique(_Args&&...) = delete;
974 // @} relates unique_ptr
975#endif // C++14
976
977#if __cplusplus201703L > 201703L && __cpp_concepts
978 // _GLIBCXX_RESOLVE_LIB_DEFECTS
979 // 2948. unique_ptr does not define operator<< for stream output
980 /// Stream output operator for unique_ptr
981 template<typename _CharT, typename _Traits, typename _Tp, typename _Dp>
982 inline basic_ostream<_CharT, _Traits>&
983 operator<<(basic_ostream<_CharT, _Traits>& __os,
984 const unique_ptr<_Tp, _Dp>& __p)
985 requires requires { __os << __p.get(); }
986 {
987 __os << __p.get();
988 return __os;
989 }
990#endif // C++20
991
992 // @} group pointer_abstractions
993
994#if __cplusplus201703L >= 201703L
995 namespace __detail::__variant
996 {
997 template<typename> struct _Never_valueless_alt; // see <variant>
998
999 // Provide the strong exception-safety guarantee when emplacing a
1000 // unique_ptr into a variant.
1001 template<typename _Tp, typename _Del>
1002 struct _Never_valueless_alt<std::unique_ptr<_Tp, _Del>>
1003 : std::true_type
1004 { };
1005 } // namespace __detail::__variant
1006#endif // C++17
1007
1008_GLIBCXX_END_NAMESPACE_VERSION
1009} // namespace
1010
1011#endif /* _UNIQUE_PTR_H */