jcs.org
Serenity Operating System
1/*
2 * Copyright (c) 2018-2022, Andreas Kling <kling@serenityos.org>
3 *
4 * SPDX-License-Identifier: BSD-2-Clause
5 */
6
7#pragma once
8
9#include <AK/AtomicRefCounted.h>
10#include <AK/Badge.h>
11#include <AK/RefPtr.h>
12#include <Kernel/FileSystem/Custody.h>
13#include <Kernel/FileSystem/FIFO.h>
14#include <Kernel/FileSystem/Inode.h>
15#include <Kernel/FileSystem/InodeMetadata.h>
16#include <Kernel/Forward.h>
17#include <Kernel/KBuffer.h>
18#include <Kernel/VirtualAddress.h>
19
20namespace Kernel {
21
22class OpenFileDescriptionData {
23public:
24 virtual ~OpenFileDescriptionData() = default;
25};
26
27class OpenFileDescription final : public AtomicRefCounted<OpenFileDescription> {
28public:
29 static ErrorOr<NonnullRefPtr<OpenFileDescription>> try_create(Custody&);
30 static ErrorOr<NonnullRefPtr<OpenFileDescription>> try_create(File&);
31 ~OpenFileDescription();
32
33 Thread::FileBlocker::BlockFlags should_unblock(Thread::FileBlocker::BlockFlags) const;
34
35 bool is_readable() const;
36 void set_readable(bool);
37
38 bool is_writable() const;
39 void set_writable(bool);
40
41 void set_rw_mode(int options);
42
43 ErrorOr<void> close();
44
45 ErrorOr<off_t> seek(off_t, int whence);
46 ErrorOr<size_t> read(UserOrKernelBuffer&, size_t);
47 ErrorOr<size_t> write(UserOrKernelBuffer const& data, size_t);
48 ErrorOr<struct stat> stat();
49
50 // NOTE: These ignore the current offset of this file description.
51 ErrorOr<size_t> read(UserOrKernelBuffer&, u64 offset, size_t);
52 ErrorOr<size_t> write(u64 offset, UserOrKernelBuffer const&, size_t);
53
54 ErrorOr<void> chmod(Credentials const& credentials, mode_t);
55
56 bool can_read() const;
57 bool can_write() const;
58
59 ErrorOr<size_t> get_dir_entries(UserOrKernelBuffer& buffer, size_t);
60
61 ErrorOr<NonnullOwnPtr<KBuffer>> read_entire_file();
62
63 ErrorOr<NonnullOwnPtr<KString>> original_absolute_path() const;
64 ErrorOr<NonnullOwnPtr<KString>> pseudo_path() const;
65
66 bool is_direct() const;
67
68 bool is_directory() const;
69
70 File& file() { return *m_file; }
71 File const& file() const { return *m_file; }
72
73 bool is_device() const;
74 Device const* device() const;
75 Device* device();
76
77 bool is_tty() const;
78 const TTY* tty() const;
79 TTY* tty();
80
81 bool is_inode_watcher() const;
82 InodeWatcher const* inode_watcher() const;
83 InodeWatcher* inode_watcher();
84
85 bool is_master_pty() const;
86 MasterPTY const* master_pty() const;
87 MasterPTY* master_pty();
88
89 InodeMetadata metadata() const;
90 Inode* inode() { return m_inode.ptr(); }
91 Inode const* inode() const { return m_inode.ptr(); }
92
93 RefPtr<Custody> custody();
94 RefPtr<Custody const> custody() const;
95
96 ErrorOr<NonnullLockRefPtr<Memory::VMObject>> vmobject_for_mmap(Process&, Memory::VirtualRange const&, u64& offset, bool shared);
97
98 bool is_blocking() const;
99 void set_blocking(bool b);
100
101 bool should_append() const;
102
103 u32 file_flags() const;
104 void set_file_flags(u32);
105
106 bool is_socket() const;
107 Socket* socket();
108 Socket const* socket() const;
109
110 bool is_fifo() const;
111 FIFO* fifo();
112 FIFO::Direction fifo_direction() const;
113 void set_fifo_direction(Badge<FIFO>, FIFO::Direction direction);
114
115 OwnPtr<OpenFileDescriptionData>& data();
116
117 void set_original_inode(Badge<VirtualFileSystem>, NonnullRefPtr<Inode> inode) { m_inode = move(inode); }
118 void set_original_custody(Badge<VirtualFileSystem>, Custody& custody);
119
120 ErrorOr<void> truncate(u64);
121 ErrorOr<void> sync();
122
123 off_t offset() const;
124
125 ErrorOr<void> chown(Credentials const& credentials, UserID, GroupID);
126
127 FileBlockerSet& blocker_set();
128
129 ErrorOr<void> apply_flock(Process const&, Userspace<flock const*>, ShouldBlock);
130 ErrorOr<void> get_flock(Userspace<flock*>) const;
131
132private:
133 friend class VirtualFileSystem;
134 explicit OpenFileDescription(File&);
135
136 ErrorOr<void> attach();
137
138 void evaluate_block_conditions()
139 {
140 blocker_set().unblock_all_blockers_whose_conditions_are_met();
141 }
142
143 RefPtr<Inode> m_inode;
144 NonnullRefPtr<File> m_file;
145
146 struct State {
147 OwnPtr<OpenFileDescriptionData> data;
148 RefPtr<Custody> custody;
149 off_t current_offset { 0 };
150 u32 file_flags { 0 };
151 bool readable : 1 { false };
152 bool writable : 1 { false };
153 bool is_blocking : 1 { true };
154 bool is_directory : 1 { false };
155 bool should_append : 1 { false };
156 bool direct : 1 { false };
157 FIFO::Direction fifo_direction : 2 { FIFO::Direction::Neither };
158 };
159
160 SpinlockProtected<State, LockRank::None> m_state {};
161};
162}