LLVM  16.0.0git
Classes | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
llvm::vfs::InMemoryFileSystem Class Reference

An in-memory file system. More...

#include "llvm/Support/VirtualFileSystem.h"

Inheritance diagram for llvm::vfs::InMemoryFileSystem:
Inheritance graph
[legend]
Collaboration diagram for llvm::vfs::InMemoryFileSystem:
Collaboration graph
[legend]

Classes

class  DirIterator
 Adaptor from InMemoryDir::iterator to directory_iterator. More...
 

Public Member Functions

 InMemoryFileSystem (bool UseNormalizedPaths=true)
 
 ~InMemoryFileSystem () override
 
bool addFile (const Twine &Path, time_t ModificationTime, std::unique_ptr< llvm::MemoryBuffer > Buffer, Optional< uint32_t > User=None, Optional< uint32_t > Group=None, Optional< llvm::sys::fs::file_type > Type=None, Optional< llvm::sys::fs::perms > Perms=None)
 Add a file containing a buffer or a directory to the VFS with a path. More...
 
bool addHardLink (const Twine &NewLink, const Twine &Target)
 Add a hard link to a file. More...
 
bool addSymbolicLink (const Twine &NewLink, const Twine &Target, time_t ModificationTime, Optional< uint32_t > User=None, Optional< uint32_t > Group=None, Optional< llvm::sys::fs::perms > Perms=None)
 Add a symbolic link. More...
 
bool addFileNoOwn (const Twine &Path, time_t ModificationTime, const llvm::MemoryBufferRef &Buffer, Optional< uint32_t > User=None, Optional< uint32_t > Group=None, Optional< llvm::sys::fs::file_type > Type=None, Optional< llvm::sys::fs::perms > Perms=None)
 Add a buffer to the VFS with a path. More...
 
std::string toString () const
 
bool useNormalizedPaths () const
 Return true if this file system normalizes . and .. in paths. More...
 
llvm::ErrorOr< Statusstatus (const Twine &Path) override
 Get the status of the entry at Path, if one exists. More...
 
llvm::ErrorOr< std::unique_ptr< File > > openFileForRead (const Twine &Path) override
 Get a File object for the file at Path, if one exists. More...
 
directory_iterator dir_begin (const Twine &Dir, std::error_code &EC) override
 Get a directory_iterator for Dir. More...
 
llvm::ErrorOr< std::string > getCurrentWorkingDirectory () const override
 Get the working directory of this file system. More...
 
std::error_code getRealPath (const Twine &Path, SmallVectorImpl< char > &Output) const override
 Canonicalizes Path by combining with the current working directory and normalizing the path (e.g. More...
 
std::error_code isLocal (const Twine &Path, bool &Result) override
 Is the file mounted on a local filesystem? More...
 
std::error_code setCurrentWorkingDirectory (const Twine &Path) override
 Set the working directory. More...
 
- Public Member Functions inherited from llvm::vfs::FileSystem
virtual ~FileSystem ()
 
llvm::ErrorOr< std::unique_ptr< llvm::MemoryBuffer > > getBufferForFile (const Twine &Name, int64_t FileSize=-1, bool RequiresNullTerminator=true, bool IsVolatile=false)
 This is a convenience method that opens a file, gets its content and then closes the file. More...
 
bool exists (const Twine &Path)
 Check whether a file exists. Provided for convenience. More...
 
virtual std::error_code makeAbsolute (SmallVectorImpl< char > &Path) const
 Make Path an absolute path. More...
 
void print (raw_ostream &OS, PrintType Type=PrintType::Contents, unsigned IndentLevel=0) const
 
LLVM_DUMP_METHOD void dump () const
 
- Public Member Functions inherited from llvm::ThreadSafeRefCountedBase< FileSystem >
void Retain () const
 
void Release () const
 

Static Public Attributes

static constexpr size_t MaxSymlinkDepth = 16
 Arbitrary max depth to search through symlinks. More...
 

Protected Member Functions

void printImpl (raw_ostream &OS, PrintType Type, unsigned IndentLevel) const override
 
- Protected Member Functions inherited from llvm::vfs::FileSystem
void printIndent (raw_ostream &OS, unsigned IndentLevel) const
 
- Protected Member Functions inherited from llvm::ThreadSafeRefCountedBase< FileSystem >
 ThreadSafeRefCountedBase ()=default
 
 ThreadSafeRefCountedBase (const ThreadSafeRefCountedBase &)
 
ThreadSafeRefCountedBaseoperator= (const ThreadSafeRefCountedBase &)=delete
 
 ~ThreadSafeRefCountedBase ()
 

Additional Inherited Members

- Public Types inherited from llvm::vfs::FileSystem
enum  PrintType { PrintType::Summary, PrintType::Contents, PrintType::RecursiveContents }
 

Detailed Description

An in-memory file system.

Definition at line 502 of file VirtualFileSystem.h.

Constructor & Destructor Documentation

◆ InMemoryFileSystem()

llvm::vfs::InMemoryFileSystem::InMemoryFileSystem ( bool  UseNormalizedPaths = true)
explicit

Definition at line 801 of file VirtualFileSystem.cpp.

◆ ~InMemoryFileSystem()

llvm::vfs::InMemoryFileSystem::~InMemoryFileSystem ( )
overridedefault

Member Function Documentation

◆ addFile()

bool llvm::vfs::InMemoryFileSystem::addFile ( const Twine Path,
time_t  ModificationTime,
std::unique_ptr< llvm::MemoryBuffer Buffer,
Optional< uint32_t User = None,
Optional< uint32_t Group = None,
Optional< llvm::sys::fs::file_type Type = None,
Optional< llvm::sys::fs::perms Perms = None 
)

Add a file containing a buffer or a directory to the VFS with a path.

The VFS owns the buffer. If present, User, Group, Type and Perms apply to the newly-created file or directory.

Returns
true if the file or directory was successfully added, false if the file or directory already exists in the file system with different contents.

Definition at line 892 of file VirtualFileSystem.cpp.

References move, and P.

◆ addFileNoOwn()

bool llvm::vfs::InMemoryFileSystem::addFileNoOwn ( const Twine Path,
time_t  ModificationTime,
const llvm::MemoryBufferRef Buffer,
Optional< uint32_t User = None,
Optional< uint32_t Group = None,
Optional< llvm::sys::fs::file_type Type = None,
Optional< llvm::sys::fs::perms Perms = None 
)

Add a buffer to the VFS with a path.

The VFS does not own the buffer. If present, User, Group, Type and Perms apply to the newly-created file or directory.

Returns
true if the file or directory was successfully added, false if the file or directory already exists in the file system with different contents.

Definition at line 910 of file VirtualFileSystem.cpp.

References llvm::MemoryBuffer::getMemBuffer(), move, and P.

◆ addHardLink()

bool llvm::vfs::InMemoryFileSystem::addHardLink ( const Twine NewLink,
const Twine Target 
)

Add a hard link to a file.

Here hard links are not intended to be fully equivalent to the classical filesystem. Both the hard link and the file share the same buffer and status (and thus have the same UniqueID). Because of this there is no way to distinguish between the link and the file after the link has been added.

The Target path must be an existing file or a hardlink. The NewLink file must not have been added before. The Target path must not be a directory. The NewLink node is added as a hard link which points to the resolved file of Target node.

Returns
true if the above condition is satisfied and hardlink was successfully created, false otherwise.

Definition at line 1004 of file VirtualFileSystem.cpp.

References llvm::None, llvm::vfs::detail::NewInMemoryNodeInfo::Path, and llvm::StringRef::str().

◆ addSymbolicLink()

bool llvm::vfs::InMemoryFileSystem::addSymbolicLink ( const Twine NewLink,
const Twine Target,
time_t  ModificationTime,
Optional< uint32_t User = None,
Optional< uint32_t Group = None,
Optional< llvm::sys::fs::perms Perms = None 
)

Add a symbolic link.

Unlike a HardLink, because Target doesn't need to refer to a file (or refer to anything, as it happens). Also, an in-memory directory for Target isn't automatically created.

Definition at line 1023 of file VirtualFileSystem.cpp.

References llvm::vfs::detail::NewInMemoryNodeInfo::makeStatus(), llvm::sys::fs::symlink_file, and llvm::Twine::toVector().

◆ dir_begin()

directory_iterator llvm::vfs::InMemoryFileSystem::dir_begin ( const Twine Dir,
std::error_code &  EC 
)
overridevirtual

Get a directory_iterator for Dir.

Note
The 'end' iterator is directory_iterator().

Implements llvm::vfs::FileSystem.

Definition at line 1122 of file VirtualFileSystem.cpp.

◆ getCurrentWorkingDirectory()

llvm::ErrorOr<std::string> llvm::vfs::InMemoryFileSystem::getCurrentWorkingDirectory ( ) const
inlineoverridevirtual

Get the working directory of this file system.

Implements llvm::vfs::FileSystem.

Definition at line 592 of file VirtualFileSystem.h.

Referenced by getRealPath().

◆ getRealPath()

std::error_code llvm::vfs::InMemoryFileSystem::getRealPath ( const Twine Path,
SmallVectorImpl< char > &  Output 
) const
overridevirtual

Canonicalizes Path by combining with the current working directory and normalizing the path (e.g.

remove dots). If the current working directory is not set, this returns errc::operation_not_permitted.

This doesn't resolve symlinks as they are not supported in in-memory file system.

Reimplemented from llvm::vfs::FileSystem.

Definition at line 1156 of file VirtualFileSystem.cpp.

References getCurrentWorkingDirectory(), llvm::vfs::FileSystem::makeAbsolute(), llvm::operation_not_permitted, and llvm::sys::path::remove_dots().

◆ isLocal()

std::error_code llvm::vfs::InMemoryFileSystem::isLocal ( const Twine Path,
bool &  Result 
)
overridevirtual

Is the file mounted on a local filesystem?

Reimplemented from llvm::vfs::FileSystem.

Definition at line 1168 of file VirtualFileSystem.cpp.

◆ openFileForRead()

llvm::ErrorOr< std::unique_ptr< File > > llvm::vfs::InMemoryFileSystem::openFileForRead ( const Twine Path)
overridevirtual

Get a File object for the file at Path, if one exists.

Implements llvm::vfs::FileSystem.

Definition at line 1053 of file VirtualFileSystem.cpp.

◆ printImpl()

void llvm::vfs::InMemoryFileSystem::printImpl ( raw_ostream OS,
PrintType  Type,
unsigned  IndentLevel 
) const
overrideprotectedvirtual

Reimplemented from llvm::vfs::FileSystem.

Definition at line 1173 of file VirtualFileSystem.cpp.

References llvm::vfs::FileSystem::printIndent().

◆ setCurrentWorkingDirectory()

std::error_code llvm::vfs::InMemoryFileSystem::setCurrentWorkingDirectory ( const Twine Path)
overridevirtual

Set the working directory.

This will affect all following operations on this file system and may propagate down for nested file systems.

Implements llvm::vfs::FileSystem.

Definition at line 1138 of file VirtualFileSystem.cpp.

References assert(), llvm::vfs::FileSystem::makeAbsolute(), P, llvm::sys::path::remove_dots(), and useNormalizedPaths().

◆ status()

llvm::ErrorOr< Status > llvm::vfs::InMemoryFileSystem::status ( const Twine Path)
overridevirtual

Get the status of the entry at Path, if one exists.

Implements llvm::vfs::FileSystem.

Definition at line 1045 of file VirtualFileSystem.cpp.

◆ toString()

std::string llvm::vfs::InMemoryFileSystem::toString ( ) const

Definition at line 811 of file VirtualFileSystem.cpp.

◆ useNormalizedPaths()

bool llvm::vfs::InMemoryFileSystem::useNormalizedPaths ( ) const
inline

Return true if this file system normalizes . and .. in paths.

Definition at line 585 of file VirtualFileSystem.h.

Referenced by setCurrentWorkingDirectory().

Member Data Documentation

◆ MaxSymlinkDepth

constexpr size_t llvm::vfs::InMemoryFileSystem::MaxSymlinkDepth = 16
staticconstexpr

Arbitrary max depth to search through symlinks.

We can get into problems if a link links to a link that links back to the link, for example.

Definition at line 559 of file VirtualFileSystem.h.


The documentation for this class was generated from the following files: