OpenFileDescription.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. /*
  2. * Copyright (c) 2018-2020, Andreas Kling <kling@serenityos.org>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/Badge.h>
  8. #include <AK/ByteBuffer.h>
  9. #include <AK/RefCounted.h>
  10. #include <Kernel/FileSystem/FIFO.h>
  11. #include <Kernel/FileSystem/Inode.h>
  12. #include <Kernel/FileSystem/InodeMetadata.h>
  13. #include <Kernel/FileSystem/VirtualFileSystem.h>
  14. #include <Kernel/KBuffer.h>
  15. #include <Kernel/VirtualAddress.h>
  16. namespace Kernel {
  17. class OpenFileDescriptionData {
  18. public:
  19. virtual ~OpenFileDescriptionData() = default;
  20. };
  21. class OpenFileDescription : public RefCounted<OpenFileDescription> {
  22. public:
  23. static ErrorOr<NonnullRefPtr<OpenFileDescription>> try_create(Custody&);
  24. static ErrorOr<NonnullRefPtr<OpenFileDescription>> try_create(File&);
  25. ~OpenFileDescription();
  26. Thread::FileBlocker::BlockFlags should_unblock(Thread::FileBlocker::BlockFlags) const;
  27. bool is_readable() const { return m_readable; }
  28. bool is_writable() const { return m_writable; }
  29. void set_readable(bool b) { m_readable = b; }
  30. void set_writable(bool b) { m_writable = b; }
  31. void set_rw_mode(int options)
  32. {
  33. set_readable((options & O_RDONLY) == O_RDONLY);
  34. set_writable((options & O_WRONLY) == O_WRONLY);
  35. }
  36. ErrorOr<void> close();
  37. ErrorOr<off_t> seek(off_t, int whence);
  38. ErrorOr<size_t> read(UserOrKernelBuffer&, size_t);
  39. ErrorOr<size_t> write(const UserOrKernelBuffer& data, size_t);
  40. ErrorOr<struct stat> stat();
  41. // NOTE: These ignore the current offset of this file description.
  42. ErrorOr<size_t> read(UserOrKernelBuffer&, u64 offset, size_t);
  43. ErrorOr<size_t> write(u64 offset, UserOrKernelBuffer const&, size_t);
  44. ErrorOr<void> chmod(mode_t);
  45. bool can_read() const;
  46. bool can_write() const;
  47. ErrorOr<size_t> get_dir_entries(UserOrKernelBuffer& buffer, size_t);
  48. ErrorOr<NonnullOwnPtr<KBuffer>> read_entire_file();
  49. ErrorOr<NonnullOwnPtr<KString>> original_absolute_path() const;
  50. ErrorOr<NonnullOwnPtr<KString>> pseudo_path() const;
  51. bool is_direct() const { return m_direct; }
  52. bool is_directory() const { return m_is_directory; }
  53. File& file() { return *m_file; }
  54. const File& file() const { return *m_file; }
  55. bool is_device() const;
  56. const Device* device() const;
  57. Device* device();
  58. bool is_tty() const;
  59. const TTY* tty() const;
  60. TTY* tty();
  61. bool is_inode_watcher() const;
  62. const InodeWatcher* inode_watcher() const;
  63. InodeWatcher* inode_watcher();
  64. bool is_master_pty() const;
  65. const MasterPTY* master_pty() const;
  66. MasterPTY* master_pty();
  67. InodeMetadata metadata() const;
  68. Inode* inode() { return m_inode.ptr(); }
  69. const Inode* inode() const { return m_inode.ptr(); }
  70. Custody* custody() { return m_custody.ptr(); }
  71. const Custody* custody() const { return m_custody.ptr(); }
  72. ErrorOr<Memory::Region*> mmap(Process&, Memory::VirtualRange const&, u64 offset, int prot, bool shared);
  73. bool is_blocking() const { return m_is_blocking; }
  74. void set_blocking(bool b) { m_is_blocking = b; }
  75. bool should_append() const { return m_should_append; }
  76. void set_should_append(bool s) { m_should_append = s; }
  77. u32 file_flags() const { return m_file_flags; }
  78. void set_file_flags(u32);
  79. bool is_socket() const;
  80. Socket* socket();
  81. const Socket* socket() const;
  82. bool is_fifo() const;
  83. FIFO* fifo();
  84. FIFO::Direction fifo_direction() const { return m_fifo_direction; }
  85. void set_fifo_direction(Badge<FIFO>, FIFO::Direction direction) { m_fifo_direction = direction; }
  86. OwnPtr<OpenFileDescriptionData>& data() { return m_data; }
  87. void set_original_inode(Badge<VirtualFileSystem>, NonnullRefPtr<Inode>&& inode) { m_inode = move(inode); }
  88. void set_original_custody(Badge<VirtualFileSystem>, Custody& custody);
  89. ErrorOr<void> truncate(u64);
  90. ErrorOr<void> sync();
  91. off_t offset() const { return m_current_offset; }
  92. ErrorOr<void> chown(UserID, GroupID);
  93. FileBlockerSet& blocker_set();
  94. ErrorOr<void> apply_flock(Process const&, Userspace<flock const*>);
  95. ErrorOr<void> get_flock(Userspace<flock*>) const;
  96. private:
  97. friend class VirtualFileSystem;
  98. explicit OpenFileDescription(File&);
  99. ErrorOr<void> attach();
  100. void evaluate_block_conditions()
  101. {
  102. blocker_set().unblock_all_blockers_whose_conditions_are_met();
  103. }
  104. RefPtr<Custody> m_custody;
  105. RefPtr<Inode> m_inode;
  106. NonnullRefPtr<File> m_file;
  107. off_t m_current_offset { 0 };
  108. OwnPtr<OpenFileDescriptionData> m_data;
  109. u32 m_file_flags { 0 };
  110. bool m_readable : 1 { false };
  111. bool m_writable : 1 { false };
  112. bool m_is_blocking : 1 { true };
  113. bool m_is_directory : 1 { false };
  114. bool m_should_append : 1 { false };
  115. bool m_direct : 1 { false };
  116. FIFO::Direction m_fifo_direction { FIFO::Direction::Neither };
  117. Mutex m_lock { "OpenFileDescription" };
  118. };
  119. }