| // Copyright 2021 The Fuchsia Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef SRC_STORAGE_F2FS_F2FS_INTERNAL_H_ |
| #define SRC_STORAGE_F2FS_F2FS_INTERNAL_H_ |
| |
| namespace f2fs { |
| |
| class VnodeF2fs; |
| |
| // For checkpoint manager |
| enum class MetaBitmap { kNatBitmap, kSitBitmap }; |
| |
| // for the list of orphan inodes |
| struct OrphanInodeEntry { |
| list_node_t list; // list head |
| nid_t ino = 0; // inode number |
| }; |
| |
| // for the list of directory inodes |
| struct DirInodeEntry { |
| list_node_t list; // list head |
| VnodeF2fs *vnode = nullptr; // vfs inode pointer |
| }; |
| |
| inline int NatsInCursum(SummaryBlock *sum) { return LeToCpu(sum->n_nats); } |
| inline int SitsInCursum(SummaryBlock *sum) { return LeToCpu(sum->n_sits); } |
| |
| inline RawNatEntry NatInJournal(SummaryBlock *sum, int i) { return sum->nat_j.entries[i].ne; } |
| inline void SetNatInJournal(SummaryBlock *sum, int i, RawNatEntry raw_ne) { |
| sum->nat_j.entries[i].ne = raw_ne; |
| } |
| inline nid_t NidInJournal(SummaryBlock *sum, int i) { return sum->nat_j.entries[i].nid; } |
| inline void SetNidInJournal(SummaryBlock *sum, int i, nid_t nid) { |
| sum->nat_j.entries[i].nid = nid; |
| } |
| |
| inline SitEntry &SitInJournal(SummaryBlock *sum, int i) { return sum->sit_j.entries[i].se; } |
| inline uint32_t SegnoInJournal(SummaryBlock *sum, int i) { return sum->sit_j.entries[i].segno; } |
| inline void SetSegnoInJournal(SummaryBlock *sum, int i, uint32_t segno) { |
| sum->sit_j.entries[i].segno = segno; |
| } |
| |
| int UpdateNatsInCursum(SummaryBlock *rs, int i); |
| |
| // For INODE and NODE manager |
| constexpr int kXattrNodeOffset = -1; |
| // store xattrs to one node block per |
| // file keeping -1 as its node offset to |
| // distinguish from index node blocks. |
| constexpr int kLinkMax = 32000; // maximum link count per file |
| |
| // CountType for monitoring |
| // |
| // f2fs monitors the number of several block types such as on-writeback, |
| // dirty dentry blocks, dirty node blocks, and dirty meta blocks. |
| enum class CountType { |
| kWriteback = 0, |
| kDirtyDents, |
| kDirtyNodes, |
| kDirtyMeta, |
| kDirtyData, |
| kMmapedData, |
| kNrCountType, |
| }; |
| |
| // The locking order between these classes is |
| // LockType::FileOp -> LockType::kNodeOp |
| enum class LockType { |
| kFileOp, // for file op |
| kNodeOp, // for node op |
| kNrLockType, |
| }; |
| |
| // The below are the page types. |
| // The available types are: |
| // kData User data pages. It operates as async mode. |
| // kNode Node pages. It operates as async mode. |
| // kMeta FS metadata pages such as SIT, NAT, CP. |
| // kNrPageType The number of page types. |
| // kMetaFlush Make sure the previous pages are written |
| // with waiting the bio's completion |
| // ... Only can be used with META. |
| enum class PageType { |
| kData = 0, |
| kNode, |
| kMeta, |
| kNrPageType, |
| kMetaFlush, |
| }; |
| |
| class SuperblockInfo { |
| public: |
| // Not copyable or moveable |
| SuperblockInfo(const SuperblockInfo &) = delete; |
| SuperblockInfo &operator=(const SuperblockInfo &) = delete; |
| SuperblockInfo(SuperblockInfo &&) = delete; |
| SuperblockInfo &operator=(SuperblockInfo &&) = delete; |
| |
| SuperblockInfo() : nr_pages_{} {} |
| |
| Superblock &GetRawSuperblock() { return *raw_superblock_; } |
| void SetRawSuperblock(std::shared_ptr<Superblock> &raw_sb) { raw_superblock_ = raw_sb; } |
| void SetRawSuperblock(Superblock *raw_sb_ptr) { raw_superblock_.reset(raw_sb_ptr); } |
| |
| bool IsDirty() const { return is_dirty_; } |
| void SetDirty() { is_dirty_ = true; } |
| void ClearDirty() { is_dirty_ = false; } |
| |
| void SetCpFlags(CpFlag flag) __TA_EXCLUDES(mutex_) { |
| std::lock_guard lock(mutex_); |
| SetCpFlagsUnsafe(flag); |
| } |
| |
| void SetCpFlagsUnsafe(CpFlag flag) __TA_REQUIRES(mutex_) { |
| uint32_t flags = LeToCpu(GetCheckpoint().ckpt_flags); |
| flags |= static_cast<uint32_t>(flag); |
| GetCheckpoint().ckpt_flags = CpuToLe(flags); |
| } |
| |
| void ClearCpFlags(CpFlag flag) __TA_EXCLUDES(mutex_) { |
| std::lock_guard lock(mutex_); |
| ClearCpFlagsUnsafe(flag); |
| } |
| |
| void ClearCpFlagsUnsafe(CpFlag flag) __TA_REQUIRES(mutex_) { |
| uint32_t flags = LeToCpu(GetCheckpoint().ckpt_flags); |
| flags &= (~static_cast<uint32_t>(flag)); |
| GetCheckpoint().ckpt_flags = CpuToLe(flags); |
| } |
| |
| bool TestCpFlags(CpFlag flag) __TA_EXCLUDES(mutex_) { |
| fs::SharedLock lock(mutex_); |
| uint32_t flags = LeToCpu(GetCheckpoint().ckpt_flags); |
| return flags & static_cast<uint32_t>(flag); |
| } |
| |
| Checkpoint &GetCheckpoint() { return checkpoint_block_.checkpoint_; } |
| const std::vector<FsBlock> &GetCheckpointTrailer() const { return checkpoint_trailer_; } |
| void SetCheckpointTrailer(std::vector<FsBlock> checkpoint_trailer) { |
| checkpoint_trailer_ = std::move(checkpoint_trailer); |
| } |
| |
| std::mutex &GetCheckpointMutex() { return checkpoint_mutex_; } |
| |
| fs::SharedMutex &GetFsLock(LockType type) { return fs_lock_[static_cast<int>(type)]; } |
| |
| void mutex_lock_op(LockType t) __TA_ACQUIRE(&fs_lock_[static_cast<int>(t)]) { |
| fs_lock_[static_cast<int>(t)].lock(); |
| } |
| |
| void mutex_unlock_op(LockType t) __TA_RELEASE(&fs_lock_[static_cast<int>(t)]) { |
| fs_lock_[static_cast<int>(t)].unlock(); |
| } |
| |
| bool IsOnRecovery() const { return on_recovery_; } |
| |
| void SetOnRecovery() { on_recovery_ = true; } |
| |
| void ClearOnRecovery() { on_recovery_ = false; } |
| |
| list_node_t &GetOrphanInodeList() { return orphan_inode_list_; } |
| |
| std::mutex &GetOrphanInodeMutex() { return orphan_inode_mutex_; } |
| |
| uint64_t GetOrphanCount() const { return n_orphans_; } |
| |
| void IncNrOrphans(); |
| void DecNrOrphans(); |
| void ResetNrOrphans() { n_orphans_ = 0; } |
| |
| block_t GetLogSectorsPerBlock() const { return log_sectors_per_block_; } |
| |
| void SetLogSectorsPerBlock(block_t log_sectors_per_block) { |
| log_sectors_per_block_ = log_sectors_per_block; |
| } |
| |
| block_t GetLogBlocksize() const { return log_blocksize_; } |
| |
| void SetLogBlocksize(block_t log_blocksize) { log_blocksize_ = log_blocksize; } |
| |
| block_t GetBlocksize() const { return blocksize_; } |
| |
| void SetBlocksize(block_t blocksize) { blocksize_ = blocksize; } |
| |
| uint32_t GetRootIno() const { return root_ino_num_; } |
| void SetRootIno(uint32_t root_ino) { root_ino_num_ = root_ino; } |
| uint32_t GetNodeIno() const { return node_ino_num_; } |
| void SetNodeIno(uint32_t node_ino) { node_ino_num_ = node_ino; } |
| uint32_t GetMetaIno() const { return meta_ino_num_; } |
| void SetMetaIno(uint32_t meta_ino) { meta_ino_num_ = meta_ino; } |
| |
| block_t GetLogBlocksPerSeg() const { return log_blocks_per_seg_; } |
| |
| void SetLogBlocksPerSeg(block_t log_blocks_per_seg) { log_blocks_per_seg_ = log_blocks_per_seg; } |
| |
| block_t GetBlocksPerSeg() const { return blocks_per_seg_; } |
| |
| void SetBlocksPerSeg(block_t blocks_per_seg) { blocks_per_seg_ = blocks_per_seg; } |
| |
| block_t GetSegsPerSec() const { return segs_per_sec_; } |
| |
| void SetSegsPerSec(block_t segs_per_sec) { segs_per_sec_ = segs_per_sec; } |
| |
| block_t GetSecsPerZone() const { return secs_per_zone_; } |
| |
| void SetSecsPerZone(block_t secs_per_zone) { secs_per_zone_ = secs_per_zone; } |
| |
| block_t GetTotalSections() const { return total_sections_; } |
| |
| void SetTotalSections(block_t total_sections) { total_sections_ = total_sections; } |
| |
| nid_t GetTotalNodeCount() const { return total_node_count_; } |
| |
| void SetTotalNodeCount(nid_t total_node_count) { total_node_count_ = total_node_count; } |
| |
| nid_t GetTotalValidNodeCount() const { return total_valid_node_count_; } |
| |
| void SetTotalValidNodeCount(nid_t total_valid_node_count) { |
| total_valid_node_count_ = total_valid_node_count; |
| } |
| |
| nid_t GetTotalValidInodeCount() const { return total_valid_inode_count_; } |
| |
| void SetTotalValidInodeCount(nid_t total_valid_inode_count) { |
| total_valid_inode_count_ = total_valid_inode_count; |
| } |
| |
| int GetActiveLogs() const { return active_logs_; } |
| |
| void SetActiveLogs(int active_logs) { active_logs_ = active_logs; } |
| |
| block_t GetUserBlockCount() const { return user_block_count_; } |
| |
| void SetUserBlockCount(block_t user_block_count) { user_block_count_ = user_block_count; } |
| |
| block_t GetTotalValidBlockCount() const { return total_valid_block_count_; } |
| |
| void SetTotalValidBlockCount(block_t total_valid_block_count) { |
| total_valid_block_count_ = total_valid_block_count; |
| } |
| |
| block_t GetAllocValidBlockCount() const { return alloc_valid_block_count_; } |
| |
| void SetAllocValidBlockCount(block_t alloc_valid_block_count) { |
| alloc_valid_block_count_ = alloc_valid_block_count; |
| } |
| |
| block_t GetLastValidBlockCount() const { return last_valid_block_count_; } |
| |
| void SetLastValidBlockCount(block_t last_valid_block_count) { |
| last_valid_block_count_ = last_valid_block_count; |
| } |
| |
| uint32_t GetNextGeneration() const { return s_next_generation_; } |
| |
| void IncNextGeneration() { ++s_next_generation_; } |
| |
| atomic_t &GetNrPages(int type) { return nr_pages_[type]; } |
| |
| void ClearOpt(uint64_t option) { mount_opt_ &= ~option; } |
| void SetOpt(uint64_t option) { mount_opt_ |= option; } |
| bool TestOpt(uint64_t option) { return ((mount_opt_ & option) != 0); } |
| |
| void IncSegmentCount(int type) { ++segment_count_[type]; } |
| uint64_t GetSegmentCount(int type) const { return segment_count_[type]; } |
| |
| void IncBlockCount(int type) { ++block_count_[type]; } |
| |
| uint32_t GetLastVictim(int mode) const { return last_victim_[mode]; } |
| |
| void SetLastVictim(int mode, uint32_t last_victim) { last_victim_[mode] = last_victim; } |
| |
| const std::vector<std::string> &GetExtensionList() const { return extension_list_; } |
| void SetExtensionList(std::vector<std::string> list) { extension_list_ = std::move(list); } |
| |
| std::mutex &GetStatLock() { return stat_lock_; } |
| |
| void IncreasePageCount(CountType count_type) { |
| // Use release-acquire ordering with nr_pages_. |
| atomic_fetch_add_explicit(&nr_pages_[static_cast<int>(count_type)], 1, |
| std::memory_order_release); |
| SetDirty(); |
| } |
| |
| void DecreasePageCount(CountType count_type) { |
| // Use release-acquire ordering with nr_pages_. |
| atomic_fetch_sub_explicit(&nr_pages_[static_cast<int>(count_type)], 1, |
| std::memory_order_release); |
| } |
| |
| int GetPageCount(CountType count_type) const { |
| // Use release-acquire ordering with nr_pages_. |
| return atomic_load_explicit(&nr_pages_[static_cast<int>(count_type)], |
| std::memory_order_acquire); |
| } |
| |
| void IncreaseDirtyDir() { ++n_dirty_dirs; } |
| void DecreaseDirtyDir() { --n_dirty_dirs; } |
| |
| uint32_t BitmapSize(MetaBitmap flag) { |
| if (flag == MetaBitmap::kNatBitmap) { |
| return LeToCpu(checkpoint_block_.checkpoint_.nat_ver_bitmap_bytesize); |
| } else { // MetaBitmap::kSitBitmap |
| return LeToCpu(checkpoint_block_.checkpoint_.sit_ver_bitmap_bytesize); |
| } |
| } |
| |
| void *BitmapPtr(MetaBitmap flag) { |
| if (raw_superblock_->cp_payload > 0) { |
| if (flag == MetaBitmap::kNatBitmap) { |
| return &checkpoint_block_.checkpoint_.sit_nat_version_bitmap; |
| } |
| return checkpoint_trailer_.data(); |
| } |
| int offset = (flag == MetaBitmap::kNatBitmap) |
| ? checkpoint_block_.checkpoint_.sit_ver_bitmap_bytesize |
| : 0; |
| return &checkpoint_block_.checkpoint_.sit_nat_version_bitmap + offset; |
| } |
| |
| block_t StartCpAddr() { |
| block_t start_addr; |
| uint64_t ckpt_version = LeToCpu(checkpoint_block_.checkpoint_.checkpoint_ver); |
| |
| start_addr = LeToCpu(raw_superblock_->cp_blkaddr); |
| |
| // odd numbered checkpoint should at cp segment 0 |
| // and even segent must be at cp segment 1 |
| if (!(ckpt_version & 1)) { |
| start_addr += blocks_per_seg_; |
| } |
| |
| return start_addr; |
| } |
| |
| block_t StartSumAddr() { return LeToCpu(checkpoint_block_.checkpoint_.cp_pack_start_sum); } |
| |
| private: |
| std::shared_ptr<Superblock> raw_superblock_; // raw super block pointer |
| bool is_dirty_ = false; // dirty flag for checkpoint |
| |
| union CheckpointBlock { |
| Checkpoint checkpoint_; |
| FsBlock fsblock_; |
| CheckpointBlock() {} |
| } checkpoint_block_; |
| |
| std::vector<FsBlock> checkpoint_trailer_; |
| |
| fs::SharedMutex mutex_; // for checkpoint data |
| std::mutex checkpoint_mutex_; // for checkpoint procedure |
| fs::SharedMutex fs_lock_[static_cast<int>(LockType::kNrLockType)]; // for blocking FS operations |
| |
| #if 0 // porting needed |
| // std::mutex writepages; // mutex for writepages() |
| #endif |
| bool on_recovery_ = false; // recovery is doing or not |
| |
| // for orphan inode management |
| list_node_t orphan_inode_list_; // orphan inode list |
| std::mutex orphan_inode_mutex_; // for orphan inode list |
| uint64_t n_orphans_ = 0; // # of orphan inodes |
| |
| uint64_t n_dirty_dirs = 0; // # of dir inodes |
| block_t log_sectors_per_block_ = 0; // log2 sectors per block |
| block_t log_blocksize_ = 0; // log2 block size |
| block_t blocksize_ = 0; // block size |
| nid_t root_ino_num_ = 0; // root inode numbe |
| nid_t node_ino_num_ = 0; // node inode numbe |
| nid_t meta_ino_num_ = 0; // meta inode numbe |
| block_t log_blocks_per_seg_ = 0; // log2 blocks per segment |
| block_t blocks_per_seg_ = 0; // blocks per segment |
| block_t segs_per_sec_ = 0; // segments per section |
| block_t secs_per_zone_ = 0; // sections per zone |
| block_t total_sections_ = 0; // total section count |
| nid_t total_node_count_ = 0; // total node block count |
| nid_t total_valid_node_count_ = 0; // valid node block count |
| nid_t total_valid_inode_count_ = 0; // valid inode count |
| int active_logs_ = 0; // # of active logs |
| |
| block_t user_block_count_ = 0; // # of user blocks |
| block_t total_valid_block_count_ = 0; // # of valid blocks |
| block_t alloc_valid_block_count_ = 0; // # of allocated blocks |
| block_t last_valid_block_count_ = 0; // for recovery |
| uint32_t s_next_generation_ = 0; // for NFS support |
| atomic_t nr_pages_[static_cast<int>(CountType::kNrCountType)] = { |
| 0}; // # of pages, see count_type |
| uint64_t mount_opt_ = 0; // set with kMountOptxxxx bits according to F2fs::mount_options_ |
| |
| #if 0 // porting needed |
| // fs::SharedMutex gc_mutex; // mutex for GC |
| // struct F2fsGc_kthread *gc_thread = nullptr; // GC thread |
| // for stat information. |
| // one is for the LFS mode, and the other is for the SSR mode. |
| // struct f2fs_stat_info *stat_info = nullptr; // FS status information |
| // int total_hit_ext = 0, read_hit_ext = 0; // extent cache hit ratio |
| // int bg_gc = 0; // background gc calls |
| #endif |
| uint64_t segment_count_[2] = {0}; // # of allocated segments |
| uint64_t block_count_[2] = {0}; // # of allocated blocks |
| uint32_t last_victim_[2] = {0}; // last victim segment # |
| |
| std::vector<std::string> extension_list_; |
| |
| std::mutex stat_lock_; // lock for stat operations |
| }; |
| |
| constexpr uint32_t kDefaultAllocatedBlocks = 1; |
| |
| inline bool RawIsInode(Node &node) { return node.footer.nid == node.footer.ino; } |
| |
| inline bool IsInode(Page &page) { |
| Node *p = page.GetAddress<Node>(); |
| return RawIsInode(*p); |
| } |
| |
| inline uint32_t *BlkaddrInNode(Node &node) { |
| if (RawIsInode(node)) { |
| if (node.i.i_inline & kExtraAttr) { |
| return node.i.i_addr + (node.i.i_extra_isize / sizeof(uint32_t)); |
| } |
| return node.i.i_addr; |
| } |
| return node.dn.addr; |
| } |
| |
| inline block_t DatablockAddr(NodePage *node_page, uint64_t offset) { |
| Node *raw_node; |
| uint32_t *addr_array; |
| raw_node = node_page->GetAddress<Node>(); |
| addr_array = BlkaddrInNode(*raw_node); |
| return LeToCpu(addr_array[offset]); |
| } |
| |
| inline int TestValidBitmap(uint64_t nr, const uint8_t *addr) { |
| int mask; |
| |
| addr += (nr >> 3); |
| mask = 1 << (7 - (nr & 0x07)); |
| return mask & *addr; |
| } |
| |
| inline int SetValidBitmap(uint64_t nr, uint8_t *addr) { |
| int mask; |
| int ret; |
| |
| addr += (nr >> 3); |
| mask = 1 << (7 - (nr & 0x07)); |
| ret = mask & *addr; |
| *addr |= mask; |
| return ret; |
| } |
| |
| inline int ClearValidBitmap(uint64_t nr, uint8_t *addr) { |
| int mask; |
| int ret; |
| |
| addr += (nr >> 3); |
| mask = 1 << (7 - (nr & 0x07)); |
| ret = mask & *addr; |
| *addr &= ~mask; |
| return ret; |
| } |
| |
| // InodeInfo->flags keeping only in memory |
| enum class InodeInfoFlag { |
| kInit = 0, // indicate inode is being initialized |
| kActive, // indicate open_count > 0 |
| kDirty, // indicate dirty vnode |
| kNewInode, // indicate newly allocated vnode |
| kNeedCp, // need to do checkpoint during fsync |
| kIncLink, // need to increment i_nlink |
| kAclMode, // indicate acl mode |
| kNoAlloc, // should not allocate any blocks |
| kUpdateDir, // should update inode block for consistency |
| kInlineXattr, // used for inline xattr |
| kInlineData, // used for inline data |
| kInlineDentry, // used for inline dentry |
| kDataExist, // indicate data exists |
| kBad, // should drop this inode without purging |
| }; |
| |
| #if 0 // porting needed |
| [[maybe_unused]] static inline void SetAclInode(InodeInfo *fi, umode_t mode) { |
| fi->i_acl_mode = mode; |
| SetInodeFlag(fi, InodeInfoFlag::kAclMode); |
| } |
| |
| [[maybe_unused]] static inline int CondClearInodeFlag(InodeInfo *fi, InodeInfoFlag flag) { |
| if (IsInodeFlagSet(fi, InodeInfoFlag::kAclMode)) { |
| ClearInodeFlag(fi, InodeInfoFlag::kAclMode); |
| return 1; |
| } |
| return 0; |
| } |
| #endif |
| |
| } // namespace f2fs |
| |
| #endif // SRC_STORAGE_F2FS_F2FS_INTERNAL_H_ |