fs/ocfs2/inode.h

0001 /* SPDX-License-Identifier: GPL-2.0-or-later */
0002 /*
0003  * inode.h
0004  *
0005  * Function prototypes
0006  *
0007  * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
0008  */
0009
0010 #ifndef OCFS2_INODE_H
0011 #define OCFS2_INODE_H
0012
0013 #include "extent_map.h"
0014
0015 /* OCFS2 Inode Private Data */
0016 struct ocfs2_inode_info
0017 {
0018     u64         ip_blkno;
0019
0020     struct ocfs2_lock_res       ip_rw_lockres;
0021     struct ocfs2_lock_res       ip_inode_lockres;
0022     struct ocfs2_lock_res       ip_open_lockres;
0023
0024     /* protects allocation changes on this inode. */
0025     struct rw_semaphore     ip_alloc_sem;
0026
0027     /* protects extended attribute changes on this inode */
0028     struct rw_semaphore     ip_xattr_sem;
0029
0030     /* These fields are protected by ip_lock */
0031     spinlock_t          ip_lock;
0032     u32             ip_open_count;
0033     struct list_head        ip_io_markers;
0034     u32             ip_clusters;
0035
0036     u16             ip_dyn_features;
0037     struct mutex            ip_io_mutex;
0038     u32             ip_flags; /* see below */
0039     u32             ip_attr; /* inode attributes */
0040
0041     /* Record unwritten extents during direct io. */
0042     struct list_head        ip_unwritten_list;
0043
0044     /* protected by recovery_lock. */
0045     struct inode            *ip_next_orphan;
0046
0047     struct ocfs2_caching_info   ip_metadata_cache;
0048     struct ocfs2_extent_map     ip_extent_map;
0049     struct inode            vfs_inode;
0050     struct jbd2_inode       ip_jinode;
0051
0052     u32             ip_dir_start_lookup;
0053
0054     /* Only valid if the inode is the dir. */
0055     u32             ip_last_used_slot;
0056     u64             ip_last_used_group;
0057     u32             ip_dir_lock_gen;
0058
0059     struct ocfs2_alloc_reservation  ip_la_data_resv;
0060
0061     /*
0062      * Transactions that contain inode's metadata needed to complete
0063      * fsync and fdatasync, respectively.
0064      */
0065     tid_t i_sync_tid;
0066     tid_t i_datasync_tid;
0067
0068     struct dquot *i_dquot[MAXQUOTAS];
0069 };
0070
0071 /*
0072  * Flags for the ip_flags field
0073  */
0074 /* System file inodes  */
0075 #define OCFS2_INODE_SYSTEM_FILE     0x00000001
0076 #define OCFS2_INODE_JOURNAL     0x00000002
0077 #define OCFS2_INODE_BITMAP      0x00000004
0078 /* This inode has been wiped from disk */
0079 #define OCFS2_INODE_DELETED     0x00000008
0080 /* Has the inode been orphaned on another node?
0081  *
0082  * This hints to ocfs2_drop_inode that it should clear i_nlink before
0083  * continuing.
0084  *
0085  * We *only* set this on unlink vote from another node. If the inode
0086  * was locally orphaned, then we're sure of the state and don't need
0087  * to twiddle i_nlink later - it's either zero or not depending on
0088  * whether our unlink succeeded. Otherwise we got this from a node
0089  * whose intention was to orphan the inode, however he may have
0090  * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
0091  * rely on ocfs2_delete_inode to sort things out under the proper
0092  * cluster locks.
0093  */
0094 #define OCFS2_INODE_MAYBE_ORPHANED  0x00000010
0095 /* Does someone have the file open O_DIRECT */
0096 #define OCFS2_INODE_OPEN_DIRECT     0x00000020
0097 /* Tell the inode wipe code it's not in orphan dir */
0098 #define OCFS2_INODE_SKIP_ORPHAN_DIR     0x00000040
0099 /* Entry in orphan dir with 'dio-' prefix */
0100 #define OCFS2_INODE_DIO_ORPHAN_ENTRY    0x00000080
0101
0102 static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
0103 {
0104     return container_of(inode, struct ocfs2_inode_info, vfs_inode);
0105 }
0106
0107 #define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
0108 #define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
0109
0110 extern const struct address_space_operations ocfs2_aops;
0111 extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
0112
0113 static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
0114 {
0115     return &OCFS2_I(inode)->ip_metadata_cache;
0116 }
0117
0118 void ocfs2_evict_inode(struct inode *inode);
0119 int ocfs2_drop_inode(struct inode *inode);
0120
0121 /* Flags for ocfs2_iget() */
0122 #define OCFS2_FI_FLAG_SYSFILE       0x1
0123 #define OCFS2_FI_FLAG_ORPHAN_RECOVERY   0x2
0124 #define OCFS2_FI_FLAG_FILECHECK_CHK 0x4
0125 #define OCFS2_FI_FLAG_FILECHECK_FIX 0x8
0126
0127 struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
0128 struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
0129              int sysfile_type);
0130 int ocfs2_inode_revalidate(struct dentry *dentry);
0131 void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
0132               int create_ino);
0133 void ocfs2_sync_blockdev(struct super_block *sb);
0134 void ocfs2_refresh_inode(struct inode *inode,
0135              struct ocfs2_dinode *fe);
0136 int ocfs2_mark_inode_dirty(handle_t *handle,
0137                struct inode *inode,
0138                struct buffer_head *bh);
0139
0140 void ocfs2_set_inode_flags(struct inode *inode);
0141 void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
0142
0143 static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
0144 {
0145     int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
0146
0147     return (blkcnt_t)OCFS2_I(inode)->ip_clusters << c_to_s_bits;
0148 }
0149
0150 /* Validate that a bh contains a valid inode */
0151 int ocfs2_validate_inode_block(struct super_block *sb,
0152                    struct buffer_head *bh);
0153 /*
0154  * Read an inode block into *bh.  If *bh is NULL, a bh will be allocated.
0155  * This is a cached read.  The inode will be validated with
0156  * ocfs2_validate_inode_block().
0157  */
0158 int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
0159 /* The same, but can be passed OCFS2_BH_* flags */
0160 int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
0161                 int flags);
0162
0163 static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
0164 {
0165     return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
0166 }
0167
0168 /* Does this inode have the reflink flag set? */
0169 static inline bool ocfs2_is_refcount_inode(struct inode *inode)
0170 {
0171     return (OCFS2_I(inode)->ip_dyn_features & OCFS2_HAS_REFCOUNT_FL);
0172 }
0173
0174 #endif /* OCFS2_INODE_H */