TheCloud/thor-os
1
0
Fork 0
mirror of https://github.com/wichtounet/thor-os.git synced 2025-09-13 14:36:37 -04:00
Code Issues Packages Projects Releases Wiki Activity

Documentation of file systems

Browse Source
This commit is contained in:
Baptiste Wicht 2016-10-01 15:06:04 +02:00
parent 25e88f6d25
commit cc4b26ca2e
No known key found for this signature in database
GPG Key ID: C5566B6C7F884532
5 changed files with 267 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
kernel/include/fs/devfs.hpp
View File

@ -42,16 +42,59 @@ public:
devfs_file_system(path mount_point);
~devfs_file_system();
/*!
* \copydoc vfs::file_system::statfs
*/
size_t statfs(vfs::statfs_info& file);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read, size_t ms);
/*!
* \copydoc vfs::file_system::write
*/
size_t write(const path& file_path, const char* buffer, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::clear
*/
size_t clear(const path& file_path, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::truncate
*/
size_t truncate(const path& file_path, size_t size);
/*!
* \copydoc vfs::file_system::get_file
*/
size_t get_file(const path& file_path, vfs::file& file);
/*!
* \copydoc vfs::file_system::ls
*/
size_t ls(const path& file_path, std::vector<vfs::file>& contents);
/*!
* \copydoc vfs::file_system::touch
*/
size_t touch(const path& file_path);
/*!
* \copydoc vfs::file_system::mkdir
*/
size_t mkdir(const path& file_path);
/*!
* \copydoc vfs::file_system::rm
*/
size_t rm(const path& file_path);
};

43
kernel/include/fs/fat32.hpp
View File

@ -36,16 +36,59 @@ public:
void init();
/*!
* \copydoc vfs::file_system::statfs
*/
size_t statfs(vfs::statfs_info& file);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read, size_t ms);
/*!
* \copydoc vfs::file_system::write
*/
size_t write(const path& file_path, const char* buffer, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::clear
*/
size_t clear(const path& file_path, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::truncate
*/
size_t truncate(const path& file_path, size_t size);
/*!
* \copydoc vfs::file_system::get_file
*/
size_t get_file(const path& file_path, vfs::file& file);
/*!
* \copydoc vfs::file_system::ls
*/
size_t ls(const path& file_path, std::vector<vfs::file>& contents);
/*!
* \copydoc vfs::file_system::touch
*/
size_t touch(const path& file_path);
/*!
* \copydoc vfs::file_system::mkdir
*/
size_t mkdir(const path& file_path);
/*!
* \copydoc vfs::file_system::rm
*/
size_t rm(const path& file_path);
private:

43
kernel/include/fs/procfs.hpp
View File

@ -26,16 +26,59 @@ public:
procfs_file_system(path mount_point);
~procfs_file_system();
/*!
* \copydoc vfs::file_system::statfs
*/
size_t statfs(vfs::statfs_info& file);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read, size_t ms);
/*!
* \copydoc vfs::file_system::write
*/
size_t write(const path& file_path, const char* buffer, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::clear
*/
size_t clear(const path& file_path, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::truncate
*/
size_t truncate(const path& file_path, size_t size);
/*!
* \copydoc vfs::file_system::get_file
*/
size_t get_file(const path& file_path, vfs::file& file);
/*!
* \copydoc vfs::file_system::ls
*/
size_t ls(const path& file_path, std::vector<vfs::file>& contents);
/*!
* \copydoc vfs::file_system::touch
*/
size_t touch(const path& file_path);
/*!
* \copydoc vfs::file_system::mkdir
*/
size_t mkdir(const path& file_path);
/*!
* \copydoc vfs::file_system::rm
*/
size_t rm(const path& file_path);
};

50
kernel/include/fs/sysfs.hpp
View File

@ -17,24 +17,66 @@
namespace sysfs {
struct sysfs_file_system : vfs::file_system {
private:
path mount_point;
public:
sysfs_file_system(path mount_point);
~sysfs_file_system();
/*!
* \copydoc vfs::file_system::statfs
*/
size_t statfs(vfs::statfs_info& file);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read);
/*!
* \copydoc vfs::file_system::read
*/
size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read, size_t ms);
/*!
* \copydoc vfs::file_system::write
*/
size_t write(const path& file_path, const char* buffer, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::clear
*/
size_t clear(const path& file_path, size_t count, size_t offset, size_t& written);
/*!
* \copydoc vfs::file_system::truncate
*/
size_t truncate(const path& file_path, size_t size);
/*!
* \copydoc vfs::file_system::get_file
*/
size_t get_file(const path& file_path, vfs::file& file);
/*!
* \copydoc vfs::file_system::ls
*/
size_t ls(const path& file_path, std::vector<vfs::file>& contents);
/*!
* \copydoc vfs::file_system::touch
*/
size_t touch(const path& file_path);
/*!
* \copydoc vfs::file_system::mkdir
*/
size_t mkdir(const path& file_path);
/*!
* \copydoc vfs::file_system::rm
*/
size_t rm(const path& file_path);
private:
path mount_point;
};
using dynamic_fun_t = std::string (*)();

92
kernel/include/vfs/file_system.hpp
View File

@ -18,21 +18,113 @@
namespace vfs {
/*!
* \brief File system interface
*/
struct file_system {
/*!
* \brief Destroy the file system
*/
virtual ~file_system(){};
/*!
* \brief Initialize the file system
*/
virtual void init(){}
/*!
* \brief Query information about the file system itself
* \return 0 on success, an error code otherwise
*/
virtual size_t statfs(vfs::statfs_info& file) = 0;
/*!
* \brief Read a file
* \param file_path The path to the file to read
* \param buffer The buffer into which to read
* \param count The amount of bytes to read
* \param offset The offset at which to start reading
* \param read output reference to indicate the number of bytes read
* \return 0 on success, an error code otherwise
*/
virtual size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read) = 0;
/*!
* \brief Read a file, waiting only the given amount of ime
* \param file_path The path to the file to read
* \param buffer The buffer into which to read
* \param count The amount of bytes to read
* \param offset The offset at which to start reading
* \param read output reference to indicate the number of bytes read
* \param ms The amount of time, in milliseconds, to wait for the read
* \return 0 on success, an error code otherwise
*/
virtual size_t read(const path& file_path, char* buffer, size_t count, size_t offset, size_t& read, size_t ms) = 0;
/*!
* \brief Write to a file
* \param file_path The path to the file to write
* \param buffer The buffer from which to read
* \param count The amount of bytes to write
* \param offset The offset at which to start writing
* \param written output reference to indicate the number of bytes written
* \return 0 on success, an error code otherwise
*/
virtual size_t write(const path& file_path, const char* buffer, size_t count, size_t offset, size_t& written) = 0;
/*!
* \brief Clear a portion of a file (write zeroes)
* \param file_path The path to the file to write
* \param count The amount of bytes to write
* \param offset The offset at which to start writing
* \param written output reference to indicate the number of bytes written
* \return 0 on success, an error code otherwise
*/
virtual size_t clear(const path& file_path, size_t count, size_t offset, size_t& written) = 0;
/*!
* \brief Change the size of a file
* \param file_path The path to the file to modify
* \param size The new size of the file
* \return 0 on success, an error code otherwise
*/
virtual size_t truncate(const path& file_path, size_t size) = 0;
/*!
* \brief Get informations about a file
* \param file_path The path to the file
* \param file The structure to fill with the information
* \return 0 on success, an error code otherwise
*/
virtual size_t get_file(const path& file_path, vfs::file& file) = 0;
/*!
* \brief Return the files inside a directory
* \param file_path The path to the directory
* \param contents The list of child to fill
* \return 0 on success, an error code otherwise
*/
virtual size_t ls(const path& file_path, std::vector<vfs::file>& contents) = 0;
/*!
* \brief Create the given file on the file system
* \param file_path The path to the file to create
* \return 0 on success, an error code otherwise
*/
virtual size_t touch(const path& file_path) = 0;
/*!
* \brief Create the given directory on the file system
* \param file_path The path to the directory to create
* \return 0 on success, an error code otherwise
*/
virtual size_t mkdir(const path& file_path) = 0;
/*!
* \brief Remove the given file from the file system
* \param file_path The path to the file to remove
* \return 0 on success, an error code otherwise
*/
virtual size_t rm(const path& file_path) = 0;
};