2018-10-10 09:53:07 +00:00
|
|
|
#pragma once
|
|
|
|
|
2019-05-28 09:53:16 +00:00
|
|
|
#include <AK/Badge.h>
|
2018-10-10 09:53:07 +00:00
|
|
|
#include <AK/ByteBuffer.h>
|
2018-11-12 00:28:46 +00:00
|
|
|
#include <AK/CircularQueue.h>
|
2019-06-21 16:58:45 +00:00
|
|
|
#include <AK/RefCounted.h>
|
2019-05-28 09:53:16 +00:00
|
|
|
#include <Kernel/FileSystem/FIFO.h>
|
|
|
|
#include <Kernel/FileSystem/Inode.h>
|
|
|
|
#include <Kernel/FileSystem/InodeMetadata.h>
|
|
|
|
#include <Kernel/FileSystem/VirtualFileSystem.h>
|
2019-04-06 18:29:48 +00:00
|
|
|
#include <Kernel/Net/Socket.h>
|
2019-07-09 12:54:26 +00:00
|
|
|
#include <Kernel/VM/VirtualAddress.h>
|
2018-10-10 09:53:07 +00:00
|
|
|
|
2019-04-28 13:02:55 +00:00
|
|
|
class File;
|
2018-10-30 21:03:02 +00:00
|
|
|
class TTY;
|
2019-01-15 05:30:19 +00:00
|
|
|
class MasterPTY;
|
2019-01-14 13:21:51 +00:00
|
|
|
class Process;
|
2019-02-16 08:57:42 +00:00
|
|
|
class Region;
|
|
|
|
class CharacterDevice;
|
2019-04-28 20:31:31 +00:00
|
|
|
class SharedMemory;
|
2019-02-14 14:40:04 +00:00
|
|
|
|
2019-06-21 13:29:31 +00:00
|
|
|
class FileDescription : public RefCounted<FileDescription> {
|
2018-10-10 09:53:07 +00:00
|
|
|
public:
|
2019-06-21 16:37:47 +00:00
|
|
|
static NonnullRefPtr<FileDescription> create(RefPtr<Custody>&&);
|
|
|
|
static NonnullRefPtr<FileDescription> create(RefPtr<File>&&, SocketRole = SocketRole::None);
|
2019-06-07 07:36:51 +00:00
|
|
|
~FileDescription();
|
2018-10-10 09:53:07 +00:00
|
|
|
|
2019-06-21 16:37:47 +00:00
|
|
|
NonnullRefPtr<FileDescription> clone();
|
2018-11-02 19:41:58 +00:00
|
|
|
|
2018-11-01 13:00:28 +00:00
|
|
|
int close();
|
|
|
|
|
2019-01-23 05:53:01 +00:00
|
|
|
off_t seek(off_t, int whence);
|
2019-07-03 19:17:35 +00:00
|
|
|
ssize_t read(u8*, ssize_t);
|
|
|
|
ssize_t write(const u8* data, ssize_t);
|
2019-03-01 23:11:08 +00:00
|
|
|
KResult fstat(stat&);
|
2018-10-14 19:19:27 +00:00
|
|
|
|
2019-03-01 09:39:19 +00:00
|
|
|
KResult fchmod(mode_t);
|
|
|
|
|
2019-04-29 11:58:40 +00:00
|
|
|
bool can_read();
|
|
|
|
bool can_write();
|
2018-10-25 11:07:59 +00:00
|
|
|
|
2019-07-03 19:17:35 +00:00
|
|
|
ssize_t get_dir_entries(u8* buffer, ssize_t);
|
2018-10-24 10:43:52 +00:00
|
|
|
|
2019-04-29 11:58:40 +00:00
|
|
|
ByteBuffer read_entire_file();
|
2018-10-10 09:53:07 +00:00
|
|
|
|
2019-06-01 16:56:56 +00:00
|
|
|
String absolute_path() const;
|
2018-10-24 12:28:22 +00:00
|
|
|
|
2018-12-02 23:39:25 +00:00
|
|
|
bool is_directory() const;
|
2018-10-26 12:24:11 +00:00
|
|
|
|
2019-05-30 11:39:17 +00:00
|
|
|
File& file() { return *m_file; }
|
|
|
|
const File& file() const { return *m_file; }
|
2019-02-16 08:57:42 +00:00
|
|
|
|
2019-04-28 13:02:55 +00:00
|
|
|
bool is_device() const;
|
2018-11-16 12:11:21 +00:00
|
|
|
|
2018-12-02 23:39:25 +00:00
|
|
|
bool is_tty() const;
|
2018-10-30 21:03:02 +00:00
|
|
|
const TTY* tty() const;
|
2018-11-02 12:14:25 +00:00
|
|
|
TTY* tty();
|
2019-01-15 05:30:19 +00:00
|
|
|
|
|
|
|
bool is_master_pty() const;
|
|
|
|
const MasterPTY* master_pty() const;
|
|
|
|
MasterPTY* master_pty();
|
2018-10-30 21:03:02 +00:00
|
|
|
|
2019-01-16 11:57:07 +00:00
|
|
|
InodeMetadata metadata() const;
|
|
|
|
Inode* inode() { return m_inode.ptr(); }
|
|
|
|
const Inode* inode() const { return m_inode.ptr(); }
|
2018-10-27 14:43:03 +00:00
|
|
|
|
2019-05-30 16:58:59 +00:00
|
|
|
Custody* custody() { return m_custody.ptr(); }
|
|
|
|
const Custody* custody() const { return m_custody.ptr(); }
|
|
|
|
|
2019-06-07 10:56:50 +00:00
|
|
|
KResultOr<Region*> mmap(Process&, VirtualAddress, size_t offset, size_t, int prot);
|
2018-10-26 12:24:11 +00:00
|
|
|
|
2018-12-02 23:39:25 +00:00
|
|
|
bool is_blocking() const { return m_is_blocking; }
|
|
|
|
void set_blocking(bool b) { m_is_blocking = b; }
|
2019-05-25 23:18:04 +00:00
|
|
|
bool should_append() const { return m_should_append; }
|
|
|
|
void set_should_append(bool s) { m_should_append = s; }
|
2018-11-11 14:36:40 +00:00
|
|
|
|
2019-07-03 19:17:35 +00:00
|
|
|
u32 file_flags() const { return m_file_flags; }
|
|
|
|
void set_file_flags(u32);
|
2018-11-12 00:28:46 +00:00
|
|
|
|
2019-05-03 18:42:43 +00:00
|
|
|
bool is_socket() const;
|
|
|
|
Socket* socket();
|
|
|
|
const Socket* socket() const;
|
2019-02-14 13:17:38 +00:00
|
|
|
|
2019-04-29 02:55:54 +00:00
|
|
|
bool is_fifo() const;
|
|
|
|
FIFO* fifo();
|
2018-11-12 00:28:46 +00:00
|
|
|
FIFO::Direction fifo_direction() { return m_fifo_direction; }
|
2019-04-29 02:55:54 +00:00
|
|
|
void set_fifo_direction(Badge<FIFO>, FIFO::Direction direction) { m_fifo_direction = direction; }
|
2018-10-18 08:27:07 +00:00
|
|
|
|
2019-04-28 20:31:31 +00:00
|
|
|
bool is_shared_memory() const;
|
|
|
|
SharedMemory* shared_memory();
|
|
|
|
const SharedMemory* shared_memory() const;
|
2019-04-08 23:10:00 +00:00
|
|
|
|
2018-12-02 23:39:25 +00:00
|
|
|
ByteBuffer& generator_cache() { return m_generator_cache; }
|
2018-10-26 22:14:24 +00:00
|
|
|
|
2019-06-21 16:37:47 +00:00
|
|
|
void set_original_inode(Badge<VFS>, NonnullRefPtr<Inode>&& inode) { m_inode = move(inode); }
|
2019-01-31 04:05:57 +00:00
|
|
|
|
2019-03-20 01:38:36 +00:00
|
|
|
SocketRole socket_role() const { return m_socket_role; }
|
2019-02-17 10:00:35 +00:00
|
|
|
void set_socket_role(SocketRole);
|
2019-02-14 16:18:35 +00:00
|
|
|
|
2019-04-08 23:10:00 +00:00
|
|
|
KResult truncate(off_t);
|
|
|
|
|
2019-05-30 11:39:17 +00:00
|
|
|
off_t offset() const { return m_current_offset; }
|
|
|
|
|
2019-06-01 18:31:36 +00:00
|
|
|
KResult chown(uid_t, gid_t);
|
|
|
|
|
2018-10-10 09:53:07 +00:00
|
|
|
private:
|
2018-11-15 13:43:10 +00:00
|
|
|
friend class VFS;
|
2019-06-21 16:37:47 +00:00
|
|
|
FileDescription(RefPtr<File>&&, SocketRole = SocketRole::None);
|
2019-06-07 07:36:51 +00:00
|
|
|
FileDescription(FIFO&, FIFO::Direction);
|
2018-10-10 09:53:07 +00:00
|
|
|
|
2019-06-21 16:37:47 +00:00
|
|
|
RefPtr<Custody> m_custody;
|
|
|
|
RefPtr<Inode> m_inode;
|
|
|
|
RefPtr<File> m_file;
|
2018-10-14 19:19:27 +00:00
|
|
|
|
2019-01-23 05:53:01 +00:00
|
|
|
off_t m_current_offset { 0 };
|
2018-10-18 08:27:07 +00:00
|
|
|
|
2018-12-02 23:39:25 +00:00
|
|
|
ByteBuffer m_generator_cache;
|
2018-10-26 22:14:24 +00:00
|
|
|
|
2019-07-03 19:17:35 +00:00
|
|
|
u32 m_file_flags { 0 };
|
2018-11-12 00:28:46 +00:00
|
|
|
|
2019-05-18 02:14:22 +00:00
|
|
|
bool m_is_blocking { true };
|
2019-05-25 23:18:04 +00:00
|
|
|
bool m_should_append { false };
|
2019-02-14 14:40:04 +00:00
|
|
|
SocketRole m_socket_role { SocketRole::None };
|
2019-05-18 02:14:22 +00:00
|
|
|
FIFO::Direction m_fifo_direction { FIFO::Direction::Neither };
|
2018-10-10 09:53:07 +00:00
|
|
|
};
|