blob: ad0dd6425811259f0e645d8920b8d383f326a872 [file] [log] [blame]
//===--- ThreadsafeFS.h ------------------------------------------*- C++-*-===//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#include "Path.h"
#include "llvm/ADT/IntrusiveRefCntPtr.h"
#include "llvm/ADT/None.h"
#include "llvm/ADT/Optional.h"
#include "llvm/Support/VirtualFileSystem.h"
#include <memory>
namespace clang {
namespace clangd {
/// Wrapper for vfs::FileSystem for use in multithreaded programs like clangd.
/// As FileSystem is not threadsafe, concurrent threads must each obtain one.
/// Implementations may choose to depend on Context::current() e.g. to implement
/// snapshot semantics. clangd will not create vfs::FileSystems for use in
/// different contexts, so either ThreadsafeFS::view or the returned FS may
/// contain this logic.
class ThreadsafeFS {
virtual ~ThreadsafeFS() = default;
/// Obtain a vfs::FileSystem with an arbitrary initial working directory.
view(llvm::NoneType CWD) const {
return viewImpl();
/// Obtain a vfs::FileSystem with a specified working directory.
/// If the working directory can't be set (e.g. doesn't exist), logs and
/// returns the FS anyway.
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> view(PathRef CWD) const;
/// Overridden by implementations to provide a vfs::FileSystem.
/// This is distinct from view(NoneType) to avoid GCC's -Woverloaded-virtual.
virtual llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> viewImpl() const = 0;
class RealThreadsafeFS : public ThreadsafeFS {
llvm::IntrusiveRefCntPtr<llvm::vfs::FileSystem> viewImpl() const override;
} // namespace clangd
} // namespace clang