#include <RamFs.h>

Inheritance diagram for RamDir:

Collaboration diagram for RamDir:

Public Member Functions
	RamDir (const String &name, size_t inode, class Filesystem pFs, File pParent)

XattrStatus	getExtendedAttribute (const StringView &name, void *buffer, size_t capacity, size_t &required) override

XattrStatus	listExtendedAttributes (void *buffer, size_t capacity, size_t &required) override

XattrStatus	setExtendedAttribute (const StringView &name, const void *value, size_t length, unsigned flags) override

XattrStatus	removeExtendedAttribute (const StringView &name) override

virtual void	cacheDirectoryContents () override

virtual bool	addEntry (String filename, File *pFile)

virtual bool	removeEntry (const String &filename, File *pFile)

bool	removeFromParent (RamDir *parent, const String &filename)

Public Member Functions inherited from Directory
	Directory ()

	Directory (const String &name, Time::Timestamp accessedTime, Time::Timestamp modifiedTime, Time::Timestamp creationTime, uintptr_t inode, class Filesystem pFs, size_t size, File pParent)

virtual	~Directory ()

virtual bool	isDirectory ()

File *	getChild (size_t n)

bool	isDetached () const

size_t	getNumChildren ()

ReadStatus	enumerate (uint64_t &cookie, DirectoryEntryEmitter emitter, void *context)

ReadStatus	isEmpty (bool &empty)

virtual bool	isCachePopulated () const

File *	lookup (const HashedStringView &s) const

MUST_USE_RESULT bool	lookupRetained (const HashedStringView &s, ChildLease &child) const

MUST_USE_RESULT LookupStatus	lookupChild (const HashedStringView &s, ChildLease &child) const

MUST_USE_RESULT LookupStatus	lookupChildAt (uint64_t cookie, const HashedStringView &name, ChildLease &child) const

void	remove (const HashedStringView &s)

Directory *	getReparsePoint () const
	Get the reparse point attached to this directory. Reparse points allow locations on the filesystem to redirect lookups to a separate directory. While the reparse point is active, the target directory is used for lookups instead of this one. The returned pointer is borrowed; atomic publication does not pin the target directory's lifetime.

void	setReparsePoint (Directory *pTarget)

AddStatus	addEphemeralFile (File *pFile)
	Add an ephemeral file to the directory.

void	removeEphemeralFiles ()

bool	empty ()

void	emptyCache ()

Public Member Functions inherited from File
	File ()

	File (const String &name, Time::Timestamp accessedTime, Time::Timestamp modifiedTime, Time::Timestamp creationTime, uintptr_t inode, class Filesystem pFs, size_t size, File pParent)

virtual	~File ()

virtual uint64_t	read (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true) final

size_t	readCached (uint64_t location, size_t size, uintptr_t buffer, bool(*prepare)(uintptr_t, size_t)=nullptr)

virtual uint64_t	write (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true) final

uint64_t	append (uint64_t size, uintptr_t buffer, uint64_t &location, bool bCanBlock=true)

WriteGuard	lockWrites ()

virtual physical_uintptr_t	getPhysicalPage (size_t offset)

virtual bool	isDirectPhysicalMapping () const

size_t	physicalMappingFlags () const

virtual void	returnPhysicalPage (size_t offset)

virtual bool	tryBeginMappingRelease ()

void	endMappingRelease ()

bool	syncAndReturnPhysicalPage (size_t offset, bool async)

virtual bool	sync ()

bool	syncRange (size_t offset, size_t length)

virtual bool	sync (size_t offset, bool async)

virtual bool	syncPages (const uint64_t *offsets, size_t count)

Time::Timestamp	getCreationTime ()

void	setCreationTime (Time::Timestamp t)

Time::Timestamp	getAccessedTime ()

void	setAccessedTime (Time::Timestamp t)

Time::Timestamp	getModifiedTime ()

void	setModifiedTime (Time::Timestamp t)

void	setTimes (Time::Timestamp accessed, Time::Timestamp modified, bool changeAccessed, bool changeModified)

virtual Attributes	getAttributes () const

virtual bool	prepareSharedMapping (size_t offset, size_t length)

String	getName () const

void	getName (String &s) const

virtual void	getFullPath (String &result, bool bWithMount=true)

virtual String	getFullPath (bool bWithMount=true)

virtual void	truncate ()

bool	resize (size_t size)

virtual size_t	getSize ()

void	setSize (size_t sz)

virtual bool	isSymlink ()

virtual bool	isBlockDevice () const

virtual uint64_t	deviceNumber () const

virtual bool	isPipe () const

virtual bool	isFifo () const

virtual bool	isSocket () const

virtual bool	isSeekable () const

bool	supportsRegularFileOperations ()

virtual bool	isCharacterDevice () const

virtual bool	isConsole () const

virtual uint64_t	maximumFileSize () const

virtual bool	allowMapping (bool shared, bool writeRequested, bool &mayWrite)

bool	acquireMappingUse (bool executable, bool sharedWrite)

void	releaseMappingUse (bool executable, bool sharedWrite)

uintptr_t	getInode () const

virtual void	setInode (uintptr_t inode)

virtual uintptr_t	futexIdentity ()

Filesystem *	getFilesystem () const

void	setFilesystem (Filesystem *pFs)

virtual void	fileAttributeChanged ()

void	publishEvent (FileEventMask mask, const StringView &name=StringView(), bool targetIsDirectory=false)

virtual FileHandleStatus	subscribeInodeEvents (FileEventMask mask, const SharedPointer< FileEventObserver > &observer, FileEventSubscription &subscription)

virtual void	finishInodeRetirement ()

virtual void	increaseRefCount (bool bIsWriter)

virtual void	decreaseRefCount (bool bIsWriter)

virtual bool	retainVfsReference ()

virtual void	releaseVfsReference ()

virtual bool	isStableVfsRoot () const

void	setPermissions (uint32_t perms)

uint32_t	getPermissions () const

bool	setOwnership (size_t uid, size_t gid, bool changeUid, bool changeGid)

void	setUid (size_t uid)

size_t	getUid () const

void	setGid (size_t gid)

size_t	getGid () const

File *	getParent () const

void	getNamespace (ParentLease &parent, String &name) const

virtual int	select (bool bWriting=false, int timeout=0)

virtual ReadyMask	queryReady (bool reading, bool writing)

virtual bool	supportsReadinessNotifications () const

void	monitor (Thread pThread, Event pEvent)

void	cullMonitorTargets (Thread *pThread)

void	cullMonitorTargets (Event *pEvent)

virtual bool	supports (const size_t command) const

virtual int	command (const size_t command, void *buffer)

virtual size_t	getBlockSize () const

void	markPageExternallyWritable (size_t offset)

size_t	populateRange (size_t offset, size_t length)

void	enableDirect ()

void	disableDirect ()

virtual void	preallocate (size_t expectedSize, bool zero=true)

bool	allocateRange (size_t offset, size_t length, bool keepSize=false)

virtual File *	open ()

virtual File *	openForDescriptor (RetainedFile &owner)

Public Member Functions inherited from ReadinessSource
MUST_USE_RESULT bool	subscribeReadiness (ReadyMask interest, const SharedPointer< ReadinessObserver > &observer, ReadinessSubscription &subscription)

virtual ReadinessGenerations	readinessGenerations ()

Public Member Functions inherited from FileEventSource
MUST_USE_RESULT bool	subscribeFileEvents (FileEventMask interest, const SharedPointer< FileEventObserver > &observer, FileEventSubscription &subscription)

Private Member Functions
	RamDir (const RamDir &)

RamDir &	operator= (const RamDir &)

Private Attributes
Mutex	m_DirectoryLock

MemoryExtendedAttributes	m_ExtendedAttributes

Additional Inherited Members
Public Types inherited from Directory
enum class	LookupStatus { Found , NotFound , IoError , Retry }

enum class	ReadStatus { Complete , Stopped , IoError }

enum class	AddStatus { Added , Exists , IoError , Detached }

enum class	EntryType : uint8_t { Unknown , Regular , Directory , Symlink , Fifo , Socket , CharacterDevice , BlockDevice }

using	DirectoryEntryEmitter = bool()(void , const DirectoryEntryView &)

Public Types inherited from File
enum	AttributeMask : uint32_t { AccessTime = 1U << 0 , ModifyTime = 1U << 1 , ChangeTime = 1U << 2 , Owner = 1U << 3 , Group = 1U << 4 , Permissions = 1U << 5 }

Static Public Member Functions inherited from Directory
static Directory *	fromFile (File *pF)

Static Public Attributes inherited from File
static constexpr size_t	MaxReadPages = 32

Protected Types inherited from Directory
typedef LazyEvaluate< File, DirectoryEntryMetadata, evaluateEntry, destroyEntry >	DirectoryEntry

Protected Member Functions inherited from Directory
virtual LookupStatus	resolveChild (const StringView &name, File *&child)

virtual bool	cacheResolvedChildren () const

virtual LookupStatus	resolveChildAt (uint64_t cookie, const StringView &name, File *&child)

virtual ReadStatus	readDirectory (uint64_t &cookie, DirectoryEntryEmitter emitter, void *context)

virtual const DirectoryEntryCache &	getCache ()

void	markCachePopulated ()

bool	addDirectoryEntry (const String &name, File *pTarget)

bool	addDirectoryEntry (const String &name, DirectoryEntryMetadata &&meta)

bool	reserveDirectoryEntry (const HashedStringView &name, NameReservation &reservation)

bool	addCachedDirectoryEntry (NameReservation &reservation, File *pTarget)

void	invalidateDirectoryEntry (const HashedStringView &name)

bool	removeDirectoryEntry (const HashedStringView &name, File *expected)

Mutex &	namespaceMutationLock ()

void	markDetached ()

void	preallocateDirectoryEntries (size_t count)

virtual File *	convertToFile (const DirectoryEntryMetadata &meta)

Protected Member Functions inherited from File
bool	tryAcquireFilesystemOperation (OperationBarrier::Lease &operation) const

virtual void	updateAttributes (const Attributes &attributes, uint32_t mask)

virtual bool	changeOwnership (size_t uid, size_t gid, bool changeUid, bool changeGid)

virtual bool	allowPhysicalPage () const

virtual bool	prepareWrite (uint64_t location, uint64_t size)

virtual bool	allowResize (size_t oldSize, size_t newSize)

virtual bool	prepareShrink (const ShrinkContext &context, UniquePointer< PreparedShrink > &prepared)

virtual bool	resizeFile (size_t size)

virtual bool	allocateFileRange (size_t offset, size_t length)

virtual Mutex &	writeSerializationLock ()

virtual Mutex &	dataMutationLock ()

virtual size_t &	physicalPageLoans ()

bool	clearDataCache ()

virtual uint64_t	readBytewise (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true)

virtual uint64_t	writeBytewise (uint64_t location, uint64_t size, uintptr_t buffer, bool bCanBlock=true)

virtual uintptr_t	readBlock (uint64_t location)

virtual bool	readPage (uint64_t location, uintptr_t destination)

virtual bool	readPages (ReadPage *pages, size_t count)

virtual void	writeBlock (uint64_t location, uintptr_t addr)

virtual void	writeBlocks (uint64_t location, uintptr_t addr, size_t length)

virtual void	extend (size_t newSize)

virtual void	extend (size_t newSize, uint64_t location, uint64_t size)

virtual void	publishInodeEvent (const FileEvent &event)

void	dataChanged ()

void	getFilesystemLabel (HugeStaticString &s)

void	enableFillCacheWriteback ()

void	shutdownFillCacheWriteback ()

bool	syncFillCache (size_t offset, bool async, bool &present)

virtual bool	useFillCache () const

virtual MUST_USE_RESULT bool	pinBlock (uint64_t location)

virtual MUST_USE_RESULT uintptr_t	acquireCachedBlock (uint64_t location, bool retryChanged)

virtual void	unpinBlock (uint64_t location)

void	evict (uint64_t location)

void	setPermissionsOnly (uint32_t perms)

void	setUidOnly (size_t uid)

void	setGidOnly (size_t gid)

void	retainDetachedParent ()

void	moveNamespace (const String &name, File *parent)

bool	snapshotNamespace (ParentLease &parent, String &name, FileEventMask interest) const

virtual CacheState &	cacheState ()

void	setPhysicalMappingFlags (size_t flags)

Protected Member Functions inherited from ReadinessSource
void	notifyReadiness (ReadyMask mask)

void	closeReadiness (ReadyMask mask=ReadyInvalid\|ReadyHangup)

Protected Member Functions inherited from FileEventSource
bool	hasFileEventObservers (FileEventMask mask) const

void	notifyFileEvent (const FileEvent &event)

void	notifyFinalFileEvent (const FileEvent &event)

void	beginFinalFileEvent (const FileEvent &event)

void	drainFileEvents ()

void	closeFileEvents ()

Static Protected Member Functions inherited from File
static bool	writeCallback (CacheConstants::CallbackCause cause, uintptr_t loc, uintptr_t page, void *meta)

static bool	fillCacheCallback (CacheConstants::CallbackCause cause, uintptr_t loc, uintptr_t page, void *meta)

Static Protected Member Functions inherited from FileEventSource
static bool	anyFileEventObservers ()

Protected Attributes inherited from File
String	m_Name

Time::Timestamp	m_AccessedTime

Time::Timestamp	m_ModifiedTime

Time::Timestamp	m_CreationTime

uintptr_t	m_Inode

uintptr_t	m_FutexIdentity = 0

class Filesystem *	m_pFilesystem

size_t	m_Size

File *	m_pParent

Mutex	m_MetadataLock

File *	m_pDetachedParent

bool	m_bDetachedParentHandled

size_t	m_nWriters

size_t	m_nReaders

size_t	m_Uid

size_t	m_Gid

uint32_t	m_Permissions

CacheState	m_CacheState

bool	m_bDirect

Mutex	m_WriteLock

Mutex	m_DataMutationLock

size_t	m_PhysicalPageLoans = 0

size_t	m_PhysicalMappingFlags = 0

Mutex	m_Lock

List< MonitorTarget * >	m_MonitorTargets

Detailed Description

Defines a directory in the RamFS

Definition at line 88 of file RamFs.h.

Constructor & Destructor Documentation

◆ RamDir()

RamDir::RamDir	(	const String &	name,
		size_t	inode,
		class Filesystem *	pFs,
		File *	pParent
	)

Definition at line 347 of file RamFs.cc.

◆ ~RamDir()

RamDir::~RamDir ( )

virtual

Definition at line 353 of file RamFs.cc.

Member Function Documentation

◆ addEntry()

bool RamDir::addEntry	(	String	filename,
		File *	pFile
	)

virtual

Definition at line 381 of file RamFs.cc.

◆ cacheDirectoryContents()

virtual void RamDir::cacheDirectoryContents ( )

inlineoverridevirtual

Load the directory's contents into the cache.

Reimplemented from Directory.

Definition at line 104 of file RamFs.h.

◆ getExtendedAttribute()

XattrStatus RamDir::getExtendedAttribute	(	const StringView &	name,
		void *	buffer,
		size_t	capacity,
		size_t &	required
	)

overridevirtual

Kernel buffers only. Capacity zero queries size without touching output; successful mutations update ctime and publish one Attributes event.

Reimplemented from File.

Definition at line 355 of file RamFs.cc.

◆ listExtendedAttributes()

XattrStatus RamDir::listExtendedAttributes	(	void *	buffer,
		size_t	capacity,
		size_t &	required
	)

overridevirtual

Reimplemented from File.

Definition at line 360 of file RamFs.cc.

◆ removeEntry()

bool RamDir::removeEntry	(	const String &	filename,
		File *	pFile
	)

virtual

Definition at line 385 of file RamFs.cc.

◆ removeExtendedAttribute()

XattrStatus RamDir::removeExtendedAttribute ( const StringView & name )

overridevirtual

Reimplemented from File.

Definition at line 373 of file RamFs.cc.

◆ removeFromParent()

bool RamDir::removeFromParent	(	RamDir *	parent,
		const String &	filename
	)

Definition at line 395 of file RamFs.cc.

◆ setExtendedAttribute()

XattrStatus RamDir::setExtendedAttribute	(	const StringView &	name,
		const void *	value,
		size_t	length,
		unsigned	flags
	)

overridevirtual

Reimplemented from File.

Definition at line 364 of file RamFs.cc.

Member Data Documentation

◆ m_DirectoryLock

Mutex RamDir::m_DirectoryLock

private

Definition at line 113 of file RamFs.h.

◆ m_ExtendedAttributes

MemoryExtendedAttributes RamDir::m_ExtendedAttributes

private

Definition at line 114 of file RamFs.h.

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RamDir()

◆ ~RamDir()

Member Function Documentation

◆ addEntry()

◆ cacheDirectoryContents()

◆ getExtendedAttribute()

◆ listExtendedAttributes()

◆ removeEntry()

◆ removeExtendedAttribute()

◆ removeFromParent()

◆ setExtendedAttribute()

Member Data Documentation

◆ m_DirectoryLock

◆ m_ExtendedAttributes