Abstract filesystem class. More...

#include <FileSystemServer.h>

Inheritance diagram for FileSystemServer:

Public Member Functions
	FileSystemServer (Directory root, const char path)
	Constructor function. More...

virtual	~FileSystemServer ()
	Destructor function. More...

const char *	getMountPath () const
	Get mount path. More...

u32	getNextInode ()
	Get next unused inode. More...

FileSystem::Result	mount ()
	Mount the FileSystem. More...

FileSystem::Result	registerFile (File file, const char path)
	Register a new File. More...

FileSystem::Result	registerDirectory (Directory dir, const char path)
	Register a new Directory. More...

FileSystem::Result	unregisterFile (const char *path)
	Remove a File from the FileSystemServer. More...

virtual File *	createFile (const FileSystem::FileType type)
	Create a new file. More...

void	pathHandler (FileSystemMessage *msg)
	Process an incoming filesystem request using a path. More...

void	mountHandler (FileSystemMessage *msg)
	Process a filesystem mount request message. More...

void	getFileSystemsHandler (FileSystemMessage *msg)
	Read the file system mounts table. More...

virtual bool	retryRequests ()
	Retry any pending requests. More...

Public Member Functions inherited from ChannelServer< FileSystemServer, FileSystemMessage >
	ChannelServer (FileSystemServer *inst)
	Constructor function. More...

virtual	~ChannelServer ()
	Destructor function. More...

int	run ()
	Enters an infinite loop, serving incoming requests. More...

void	setTimeout (const uint msec)
	Set a sleep timeout. More...

Protected Member Functions
FileSystem::Result	processRequest (FileSystemRequest &req)
	Process a FileSystemRequest. More...

FileSystem::Result	inodeHandler (FileSystemRequest &req)
	Handle a request for a File specified by its inode. More...

FileSystem::Result	waitFileHandler (FileSystemRequest &req)
	Handle a WaitFile request. More...

void	sendResponse (FileSystemMessage *msg) const
	Send response for a FileSystemMessage. More...

bool	redirectRequest (const char path, FileSystemMessage msg)
	Try to forward the given FileSystemMessage to a mount file system. More...

void	setRoot (Directory *newRoot)
	Change the filesystem root directory. More...

Directory *	getParentDirectory (const char *path)
	Retrieve parent Directory for a file. More...

FileCache *	lookupFile (const FileSystemPath &path)
	Retrieve a File from storage. More...

FileCache *	findFileCache (const char *path) const
	Search the cache for an entry. More...

FileCache *	findFileCache (const String &path) const
	Search the cache for an entry. More...

FileCache *	findFileCache (const FileSystemPath &path) const
	Search the cache for an entry. More...

FileCache *	insertFileCache (File file, const char pathFormat)
	Inserts a file into the in-memory filesystem tree. More...

void	removeFileFromCache (FileCache cache, File file)
	Remove a File from the cache. More...

void	clearFileCache (FileCache *cache=ZERO)
	Cleans up the entire file cache (except opened file caches and root). More...

Protected Member Functions inherited from ChannelServer< FileSystemServer, FileSystemMessage >
void	addIPCHandler (const Size slot, IPCHandlerFunction h, const bool sendReply=true)
	Register a new IPC message action handler. More...

void	addIRQHandler (const Size slot, IRQHandlerFunction h)
	Register a new IRQ message vector handler. More...

virtual void	timeout ()
	Called when sleep timeout is reached. More...

virtual void	onProcessTerminated (const ProcessID pid)
	Called whenever another Process is terminated. More...

void	retryAllRequests ()
	Keep retrying requests until all served. More...

Protected Attributes
const ProcessID	m_pid
	Process identifier. More...

FileCache *	m_root
	Root entry of the filesystem tree. More...

HashTable< u32, File * >	m_inodeMap
	Contains a mapping of inode number to file of all cached files. More...

const char *	m_mountPath
	Mount point path. More...

FileSystemMount *	m_mounts
	Table with mounted file systems (only used by the root file system). More...

List< FileSystemRequest * > *	m_requests
	Contains ongoing requests. More...

Protected Attributes inherited from ChannelServer< FileSystemServer, FileSystemMessage >
FileSystemServer *	m_instance
	Server object instance. More...

ChannelClient *	m_client
	Client for sending replies. More...

ChannelRegistry &	m_registry
	Contains registered channels. More...

MemoryChannel	m_kernelEvent
	Kernel event channel. More...

Index< MessageHandler< IPCHandlerFunction >, MaximumHandlerCount >	m_ipcHandlers
	IPC handler functions. More...

Index< MessageHandler< IRQHandlerFunction >, MaximumHandlerCount >	m_irqHandlers
	IRQ handler functions. More...

ProcessID	m_self
	ProcessID of ourselves. More...

Timer::Info	m_time
	System timer value. More...

Timer::Info	m_expiry
	System timer expiration value. More...

Static Private Attributes
static const Size	MaximumFileSystemMounts = 32
	Maximum number of supported file system mount entries. More...

static const Size	MaximumWaitSetCount = 32
	Maximum number of WaitSet entries supported. More...

Additional Inherited Members
Public Types inherited from ChannelServer< FileSystemServer, FileSystemMessage >
enum	Result
	Result codes. More...

Protected Types inherited from ChannelServer< FileSystemServer, FileSystemMessage >
typedef void(FileSystemServer ::*	IPCHandlerFunction) (FileSystemMessage *)
	Member function pointer inside Base, to handle IPC messages. More...

typedef void(FileSystemServer ::*	IRQHandlerFunction) (Size)
	Member function pointer inside Base, to handle interrupts. More...

Detailed Description

Abstract filesystem class.

Definition at line 44 of file FileSystemServer.h.

Constructor & Destructor Documentation

◆ FileSystemServer()

FileSystemServer::FileSystemServer	(	Directory *	root,
		const char *	path
	)

Constructor function.

Parameters

root	Root directory to use
path	Path to which we are mounted.

Definition at line 29 of file FileSystemServer.cpp.

References ChannelServer< FileSystemServer, FileSystemMessage >::addIPCHandler(), FileSystem::CreateFile, FileSystem::DeleteFile, FileSystem::GetFileSystems, getFileSystemsHandler(), FileSystem::MountFileSystem, mountHandler(), pathHandler(), FileSystem::ReadFile, setRoot(), FileSystem::StatFile, FileSystem::WaitFile, FileSystem::WaitFileSystem, and FileSystem::WriteFile.

◆ ~FileSystemServer()

FileSystemServer::~FileSystemServer ( )

virtual

Destructor function.

Definition at line 51 of file FileSystemServer.cpp.

References clearFileCache(), m_requests, and m_root.

Member Function Documentation

◆ clearFileCache()

void FileSystemServer::clearFileCache ( FileCache * cache = ZERO )

protected

Cleans up the entire file cache (except opened file caches and root).

Parameters

cache Input FileCache object. ZERO to clean up all from root.

Definition at line 813 of file FileSystemServer.cpp.

References assert, HashTable< K, V >::count(), FileCache::entries, FileCache::file, File::getInode(), HashIterator< K, V >::hasCurrent(), m_inodeMap, m_root, FileCache::name, FileCache::parent, HashTable< K, V >::remove(), removeFileFromCache(), and ZERO.

Referenced by unregisterFile(), and ~FileSystemServer().

◆ createFile()

File * FileSystemServer::createFile ( const FileSystem::FileType type )

virtual

Create a new file.

Parameters

type	Describes the type of file to create.

Returns: Pointer to a new File on success or ZERO on failure.

Reimplemented in TmpFileSystem.

Definition at line 110 of file FileSystemServer.cpp.

References ZERO.

Referenced by processRequest().

◆ findFileCache() [1/3]

FileCache * FileSystemServer::findFileCache ( const char * path ) const

protected

Search the cache for an entry.

Parameters

path	Full path of the file to find.

Returns: Pointer to FileCache object on success, NULL on failure.

Definition at line 758 of file FileSystemServer.cpp.

Referenced by findFileCache(), getParentDirectory(), insertFileCache(), processRequest(), and unregisterFile().

◆ findFileCache() [2/3]

FileCache * FileSystemServer::findFileCache ( const FileSystemPath & path ) const

protected

Search the cache for an entry.

Parameters

path	Full path of the file to find.

Returns: Pointer to FileCache object on success, NULL on failure.

Definition at line 769 of file FileSystemServer.cpp.

References Associative< K, V >::contains(), FileCache::entries, ListIterator< T >::hasCurrent(), FileSystemPath::length(), String::length(), m_root, FileSystemPath::parent(), FileSystemPath::split(), HashTable< K, V >::value(), and ZERO.

◆ findFileCache() [3/3]

FileCache * FileSystemServer::findFileCache ( const String & path ) const

protected

Search the cache for an entry.

Parameters

path	Full path of the file to find.

Returns: Pointer to FileCache object on success, NULL on failure.

Definition at line 764 of file FileSystemServer.cpp.

References findFileCache().

◆ getFileSystemsHandler()

void FileSystemServer::getFileSystemsHandler ( FileSystemMessage * msg )

Read the file system mounts table.

Parameters

msg	FileSystemMessage pointer

Definition at line 612 of file FileSystemServer.cpp.

References FileSystemMessage::buffer, ERROR, ChannelMessage::from, FileSystem::IOError, m_mounts, MaximumFileSystemMounts, FileSystemMessage::result, FileSystemMessage::size, FileSystem::Success, API::Success, VMCopy(), and API::Write.

Referenced by FileSystemServer().

◆ getMountPath()

const char * FileSystemServer::getMountPath ( ) const

Get mount path.

Returns: Mount path of the filesystem

Definition at line 61 of file FileSystemServer.cpp.

References m_mountPath.

Referenced by UDP::createSocket(), and ICMP::createSocket().

◆ getNextInode()

u32 FileSystemServer::getNextInode ( )

Get next unused inode.

Returns: Inode number

Definition at line 66 of file FileSystemServer.cpp.

References HashTable< K, V >::get(), m_inodeMap, and ZERO.

Referenced by TmpFileSystem::createFile(), UDP::createSocket(), ICMP::createSocket(), DeviceServer::initialize(), UDP::initialize(), ICMP::initialize(), Ethernet::initialize(), IPV4::initialize(), ARP::initialize(), and main().

◆ getParentDirectory()

Directory * FileSystemServer::getParentDirectory ( const char * path )

protected

Retrieve parent Directory for a file.

Parameters

path	Path to the file

Returns: Directory pointer on success or NULL on failure

Definition at line 659 of file FileSystemServer.cpp.

References FileCache::file, findFileCache(), String::length(), m_root, FileSystemPath::parent(), and ZERO.

Referenced by registerDirectory(), and registerFile().

◆ inodeHandler()

FileSystem::Result FileSystemServer::inodeHandler ( FileSystemRequest & req )

protected

Handle a request for a File specified by its inode.

Parameters

req	FileSystemRequest reference

Returns: Result code

Definition at line 246 of file FileSystemServer.cpp.

References FileSystemMessage::action, IOBuffer::bufferedRead(), DEBUG, IOBuffer::flushWrite(), HashTable< K, V >::get(), FileSystemRequest::getBuffer(), IOBuffer::getCount(), FileSystemRequest::getMessage(), FileSystemMessage::inode, m_inodeMap, ChannelServer< FileSystemServer, FileSystemMessage >::m_self, FileSystem::NotFound, FileSystem::NotSupported, FileSystemMessage::offset, File::read(), FileSystem::ReadFile, FileSystemMessage::result, FileSystem::RetryAgain, sendResponse(), FileSystemMessage::size, FileSystem::Success, File::write(), FileSystem::WriteFile, and ZERO.

Referenced by processRequest().

◆ insertFileCache()

FileCache * FileSystemServer::insertFileCache	(	File *	file,
		const char *	pathFormat
	)

protected

Inserts a file into the in-memory filesystem tree.

Parameters

file	File to insert.
pathFormat	Full path to the file to insert.

Returns: Pointer to the newly created FileCache, or NULL on failure.

Definition at line 731 of file FileSystemServer.cpp.

References assert, FileSystemPath::base(), findFileCache(), File::getInode(), HashTable< K, V >::insert(), String::length(), m_inodeMap, m_root, NULL, FileSystemPath::parent(), and ZERO.

Referenced by registerFile(), and setRoot().

◆ lookupFile()

FileCache * FileSystemServer::lookupFile ( const FileSystemPath & path )

protected

Retrieve a File from storage.

This function is responsible for walking the given FileSystemPath, retrieving each uncached File into the FileCache, and returning a pointer to corresponding FileCache of the last entry in the given path.

Parameters

path	A path to lookup from storage.

Returns: Pointer to a FileCache on success, ZERO otherwise.

Definition at line 680 of file FileSystemServer.cpp.

References assert, Associative< K, V >::contains(), FileSystem::DirectoryFile, FileCache::entries, FileCache::file, File::getInode(), File::getType(), ListIterator< T >::hasCurrent(), HashTable< K, V >::insert(), Directory::lookup(), m_inodeMap, m_root, NULL, FileSystemPath::split(), HashTable< K, V >::value(), and ZERO.

Referenced by processRequest().

◆ mount()

FileSystem::Result FileSystemServer::mount ( )

Mount the FileSystem.

This function is responsible for mounting the file system.

Returns: Result code

Definition at line 77 of file FileSystemServer.cpp.

References assert, FileSystem::IOError, m_mountPath, m_mounts, m_pid, MaximumFileSystemMounts, FileSystemClient::mountFileSystem(), NULL, DatastoreClient::registerBuffer(), ROOTFS_PID, MemoryBlock::set(), Datastore::Success, FileSystem::Success, and ZERO.

Referenced by DeviceServer::initialize(), and main().

◆ mountHandler()

void FileSystemServer::mountHandler ( FileSystemMessage * msg )

Process a filesystem mount request message.

Parameters

msg	FileSystemMessage pointer with the requested mount path

Definition at line 561 of file FileSystemServer.cpp.

References FileSystemMessage::buffer, MemoryBlock::copy(), entry, ERROR, ChannelMessage::from, FileSystem::IOError, m_mounts, MaximumFileSystemMounts, FileSystemPath::MaximumLength, NOTICE, FileSystemMount::options, FileSystemMount::procID, API::Read, FileSystemMessage::result, FileSystem::Success, API::Success, VMCopy(), and ZERO.

Referenced by FileSystemServer().

◆ pathHandler()

void FileSystemServer::pathHandler ( FileSystemMessage * msg )

Process an incoming filesystem request using a path.

This message handler is responsible for processing any kind of FileSystemMessages which have an FileSystemAction using the path field, such as OpenFile.

Parameters