~aleteoryx/muditaos

ref: 2de71a003692ec1207cd4f0258379f82500f378f muditaos/module-vfs/include/user/purefs/fs/filesystem_operations.hpp -rw-r--r-- 4.8 KiB
2de71a00 — Maciej-Mudita [MOS-74] Fix wrong tethering popup order 3 years ago 
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

// Copyright (c) 2017-2021, Mudita Sp. z.o.o. All rights reserved.
// For licensing, see https://github.com/mudita/MuditaOS/LICENSE.md

#pragma once
#include <string>
#include <list>
#include <tuple>
#include <memory>

struct statvfs;
struct stat;

namespace purefs::blkdev
{
    namespace internal
    {
        class disk_handle;
    }
    class disk_manager;
} // namespace purefs::blkdev

namespace purefs::fs
{
    namespace internal
    {
        class file_handle;
        class directory_handle;
        class mount_point;
    }; // namespace internal

    /** Filesystem specific driver base class */
    class filesystem_operations : public std::enable_shared_from_this<filesystem_operations>
    {
      public:
        using fsfile                                         = std::shared_ptr<internal::file_handle>;
        using fsdir                                          = std::shared_ptr<internal::directory_handle>;
        using fsmount                                        = std::shared_ptr<internal::mount_point>;
        filesystem_operations()                              = default;
        filesystem_operations(const filesystem_operations &) = delete;
        virtual ~filesystem_operations()                     = default;
        auto operator=(const filesystem_operations &) = delete;
        /** Allocate mount point class specify to the VFS
         * @return Allocated mount point structure
         */
        virtual auto mount_prealloc(std::shared_ptr<blkdev::internal::disk_handle> diskh,
                                    std::string_view path,
                                    unsigned flags) -> fsmount            = 0;
        virtual auto mount(fsmount mnt, const void *data) noexcept -> int = 0;
        virtual auto umount(fsmount mnt) noexcept -> int                  = 0;
        virtual auto stat_vfs(fsmount mnt, std::string_view path, struct statvfs &stat) const noexcept -> int;

        /** Standard file access API */
        virtual auto open(fsmount mnt, std::string_view path, int flags, int mode) noexcept -> fsfile = 0;
        virtual auto close(fsfile zfile) noexcept -> int                                              = 0;
        virtual auto write(fsfile zfile, const char *ptr, size_t len) noexcept -> ssize_t             = 0;
        virtual auto read(fsfile zfile, char *ptr, size_t len) noexcept -> ssize_t                    = 0;
        virtual auto seek(fsfile zfile, off_t pos, int dir) noexcept -> off_t;
        virtual auto fstat(fsfile zfile, struct stat &st) noexcept -> int;
        virtual auto stat(fsmount mnt, std::string_view file, struct stat &st) noexcept -> int;
        virtual auto link(fsmount mnt, std::string_view existing, std::string_view newlink) noexcept -> int;
        virtual auto symlink(fsmount mnt, std::string_view existing, std::string_view newlink) noexcept -> int;
        virtual auto unlink(fsmount mnt, std::string_view name) noexcept -> int;
        virtual auto rmdir(fsmount mnt, std::string_view name) noexcept -> int;
        virtual auto rename(fsmount mnt, std::string_view oldname, std::string_view newname) noexcept -> int;
        virtual auto mkdir(fsmount mnt, std::string_view path, int mode) noexcept -> int;

        /** Directory support API */
        virtual auto diropen(fsmount mnt, std::string_view path) noexcept -> fsdir;
        virtual auto dirreset(fsdir dirstate) noexcept -> int;
        virtual auto dirnext(fsdir dirstate, std::string &filename, struct stat &filestat) -> int;
        virtual auto dirclose(fsdir dirstate) noexcept -> int;

        /** Other fops API */
        virtual auto ftruncate(fsfile zfile, off_t len) noexcept -> int;
        virtual auto fsync(fsfile zfile) noexcept -> int;
        virtual auto ioctl(fsmount mnt, std::string_view path, int cmd, void *arg) noexcept -> int;
        virtual auto utimens(fsmount mnt, std::string_view path, std::array<timespec, 2> &tv) noexcept -> int;
        virtual auto flock(fsfile zfile, int cmd) noexcept -> int;
        virtual auto isatty(fsfile zfile) noexcept -> int = 0;

        virtual auto chmod(fsmount mnt, std::string_view path, mode_t mode) noexcept -> int;
        virtual auto fchmod(fsfile zfile, mode_t mode) noexcept -> int;

        /** Internal use */
        auto mount_count() const noexcept
        {
            return m_mount_count;
        }
        auto finalize_registration(std::weak_ptr<blkdev::disk_manager> diskmgr)
        {
            m_diskmm = diskmgr;
            return filesystem_register_completed();
        }

      protected:
        auto disk_mngr() const noexcept
        {
            return m_diskmm.lock();
        }
        virtual auto filesystem_register_completed() const noexcept -> int
        {
            return 0;
        }

      private:
        std::size_t m_mount_count{};
        std::weak_ptr<blkdev::disk_manager> m_diskmm;
    };
} // namespace purefs::fs