thor-os/kernel/include/vfs/vfs.hpp

//=======================================================================
// Copyright Baptiste Wicht 2013-2018.
// Distributed under the terms of the MIT License.
// (See accompanying file LICENSE or copy at
//  http://www.opensource.org/licenses/MIT)
//=======================================================================

#ifndef VFS_H
#define VFS_H

#include <expected.hpp>

#include <tlib/stat_info.hpp>
#include <tlib/statfs_info.hpp>

#include "vfs/path.hpp"

namespace vfs {

using fd_t = size_t;

/*!
 * \brief Enumeration for all supported partition types
 */
enum class partition_type {
    FAT32 = 1, ///< FAT32
    SYSFS = 2, ///< Sysfs
    DEVFS = 3, ///< Devfs
    PROCFS = 4, ///< Procfs
    UNKNOWN = 100 ///< Unknown file system
};

/*!
 * \brief Init the virtual file system
 */
void init();

/*!
 * \brief Open the given file with the given flags
 * \param file The path to the file to open
 * \param flags The opening flags
 * \return The file descriptor on success, a negative error code otherwise
 */
std::expected<fd_t> open(const char* file, size_t flags);

/*!
 * \brief Close the given file descriptor
 */
void close(fd_t fd);

/*!
 * \brief Returns information about the file represented by the fd
 * \param fd The file descriptor
 * \param info The info to fill
 * \return a status code
 */
std::expected<void> stat(fd_t fd, vfs::stat_info& info);

/*!
 * \brief Returns information about the file system
 * \param mount_point The mount point
 * \param info The info to fill
 * \return a status code
 */
std::expected<void> statfs(const char* mount_point, vfs::statfs_info& info);

/*!
 * \brief Create a new directory
 * \param file Path to the directory to create
 * \return a status code
 */
std::expected<void> mkdir(const char* file);

/*!
 * \brief Remove a file
 * \param file Path to the file to remove
 * \return a status code
 */
std::expected<void> rm(const char* file);

/*!
 * \brief Read from a file
 * \param fd The file descriptor to the file
 * \param buffer The buffer to write to
 * \param count The number of bytes to read
 * \param offset The index where to start reading the file
 * \return a status code
 */
std::expected<size_t> read(fd_t fd, char* buffer, size_t count, size_t offset = 0);

/*!
 * \brief Read from a file with a timeout
 * \param fd The file descriptor to the file
 * \param buffer The buffer to write to
 * \param count The number of bytes to read
 * \param offset The index where to start reading the file
 * \param ms The maximum time in milliseconds to wait for
 * \return a status code
 */
std::expected<size_t> read(fd_t fd, char* buffer, size_t count, size_t offset, size_t ms);

/*!
 * \brief Write to a file
 * \param fd The file descriptor to the file
 * \param buffer The buffer to read from
 * \param count The number of bytes to write
 * \param offset The index where to start writting the file
 * \return a status code
 */
std::expected<size_t> write(fd_t fd, const char* buffer, size_t count, size_t offset = 0);

/*!
 * \brief Clear parts of a file content
 * \param fd The file descriptor to the file
 * \param count The number of bytes to write
 * \param offset The index where to start writting the file
 * \return a status code
 */
std::expected<size_t> clear(fd_t fd, size_t count, size_t offset = 0);

/*!
 * \brief Truncate the size of a file
 * \param fd The file descriptor
 * \param size The new size
 * \return a status code
 */
std::expected<void> truncate(fd_t fd, size_t size);

/*!
 * \brief List entries in the given directory
 * \param fd The file descriptor
 * \param buffer The buffer to fill with the entries
 * \param size The maximum size of the buffer
 * \return a status code
 */
std::expected<size_t> entries(fd_t fd, char* buffer, size_t size);

/*!
 * \brief List mounted file systems.
 * \param buffer The buffer to fill with the entries
 * \param size The maximum size of the buffer
 * \return a status code
 */
std::expected<size_t> mounts(char* buffer, size_t size);

/*!
 * \brief Mount a new partition
 * \param type The type of partition
 * \param mp_fd Mount point file descriptor
 * \param dev_fd Device file descriptor
 * \return a status code
 */
std::expected<void> mount(partition_type type, fd_t mp_fd, fd_t dev_fd);

/*!
 * \brief Mount a new partition
 *
 * This function is intended for direct mount from the OS code.
 *
 * \param type The type of partition
 * \param mount_point Mount point path
 * \param device Device path
 * \return a status code
 */
std::expected<void> mount(partition_type type, const char* mount_point, const char* device);

/*!
 * \brief Directly read a file into a std::string buffer
 *
 * This is only used directly by the kernel as an easy way to read a complete
 * file. This is not safe to be exposed from user space calls.
 *
 * \param file The file to read
 * \param content The std::string to fill with the file contents
 *
 * \return An error code if something went wrong, 0 otherwise
 */
std::expected<size_t> direct_read(const path& file, std::string& content);

/*!
 * \brief Directly read a file or a device
 *
 * This is meant to be used by file system drivers.
 *
 * \param file Path to the file (or device)
 * \param buffer The output buffer
 * \param count The number of bytes to read
 * \param offset The offset where to start reading
 *
 * \return An error code if something went wrong, 0 otherwise
 */
std::expected<size_t> direct_read(const path& file, char* buffer, size_t count, size_t offset = 0);

/*!
 * \brief Directly write a file or a device
 *
 * This is meant to be used by file system drivers.
 *
 * \param file Path to the file (or device)
 * \param buffer The input buffer
 * \param count The number of bytes to write
 * \param offset The offset where to start writing
 *
 * \return An error code if something went wrong, 0 otherwise
 */
std::expected<size_t> direct_write(const path& file, const char* buffer, size_t count, size_t offset = 0);

} //end of namespace vfs

#endif