Loading...
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * inode.h
4 *
5 * Function prototypes
6 *
7 * Copyright (C) 2002, 2004 Oracle. All rights reserved.
8 */
9
10#ifndef OCFS2_INODE_H
11#define OCFS2_INODE_H
12
13#include "extent_map.h"
14
15/* OCFS2 Inode Private Data */
16struct ocfs2_inode_info
17{
18 u64 ip_blkno;
19
20 struct ocfs2_lock_res ip_rw_lockres;
21 struct ocfs2_lock_res ip_inode_lockres;
22 struct ocfs2_lock_res ip_open_lockres;
23
24 /* protects allocation changes on this inode. */
25 struct rw_semaphore ip_alloc_sem;
26
27 /* protects extended attribute changes on this inode */
28 struct rw_semaphore ip_xattr_sem;
29
30 /* These fields are protected by ip_lock */
31 spinlock_t ip_lock;
32 u32 ip_open_count;
33 struct list_head ip_io_markers;
34 u32 ip_clusters;
35
36 u16 ip_dyn_features;
37 struct mutex ip_io_mutex;
38 u32 ip_flags; /* see below */
39 u32 ip_attr; /* inode attributes */
40
41 /* Record unwritten extents during direct io. */
42 struct list_head ip_unwritten_list;
43
44 /* protected by recovery_lock. */
45 struct inode *ip_next_orphan;
46
47 struct ocfs2_caching_info ip_metadata_cache;
48 struct ocfs2_extent_map ip_extent_map;
49 struct inode vfs_inode;
50 struct jbd2_inode ip_jinode;
51
52 u32 ip_dir_start_lookup;
53
54 /* Only valid if the inode is the dir. */
55 u32 ip_last_used_slot;
56 u64 ip_last_used_group;
57 u32 ip_dir_lock_gen;
58
59 struct ocfs2_alloc_reservation ip_la_data_resv;
60
61 /*
62 * Transactions that contain inode's metadata needed to complete
63 * fsync and fdatasync, respectively.
64 */
65 tid_t i_sync_tid;
66 tid_t i_datasync_tid;
67
68 struct dquot *i_dquot[MAXQUOTAS];
69};
70
71/*
72 * Flags for the ip_flags field
73 */
74/* System file inodes */
75#define OCFS2_INODE_SYSTEM_FILE 0x00000001
76#define OCFS2_INODE_JOURNAL 0x00000002
77#define OCFS2_INODE_BITMAP 0x00000004
78/* This inode has been wiped from disk */
79#define OCFS2_INODE_DELETED 0x00000008
80/* Has the inode been orphaned on another node?
81 *
82 * This hints to ocfs2_drop_inode that it should clear i_nlink before
83 * continuing.
84 *
85 * We *only* set this on unlink vote from another node. If the inode
86 * was locally orphaned, then we're sure of the state and don't need
87 * to twiddle i_nlink later - it's either zero or not depending on
88 * whether our unlink succeeded. Otherwise we got this from a node
89 * whose intention was to orphan the inode, however he may have
90 * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
91 * rely on ocfs2_delete_inode to sort things out under the proper
92 * cluster locks.
93 */
94#define OCFS2_INODE_MAYBE_ORPHANED 0x00000010
95/* Does someone have the file open O_DIRECT */
96#define OCFS2_INODE_OPEN_DIRECT 0x00000020
97/* Tell the inode wipe code it's not in orphan dir */
98#define OCFS2_INODE_SKIP_ORPHAN_DIR 0x00000040
99/* Entry in orphan dir with 'dio-' prefix */
100#define OCFS2_INODE_DIO_ORPHAN_ENTRY 0x00000080
101
102static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
103{
104 return container_of(inode, struct ocfs2_inode_info, vfs_inode);
105}
106
107#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
108#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
109
110extern const struct address_space_operations ocfs2_aops;
111extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
112
113static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
114{
115 return &OCFS2_I(inode)->ip_metadata_cache;
116}
117
118void ocfs2_evict_inode(struct inode *inode);
119int ocfs2_drop_inode(struct inode *inode);
120
121/* Flags for ocfs2_iget() */
122#define OCFS2_FI_FLAG_SYSFILE 0x1
123#define OCFS2_FI_FLAG_ORPHAN_RECOVERY 0x2
124#define OCFS2_FI_FLAG_FILECHECK_CHK 0x4
125#define OCFS2_FI_FLAG_FILECHECK_FIX 0x8
126
127struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
128struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
129 int sysfile_type);
130int ocfs2_inode_revalidate(struct dentry *dentry);
131void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
132 int create_ino);
133void ocfs2_sync_blockdev(struct super_block *sb);
134void ocfs2_refresh_inode(struct inode *inode,
135 struct ocfs2_dinode *fe);
136int ocfs2_mark_inode_dirty(handle_t *handle,
137 struct inode *inode,
138 struct buffer_head *bh);
139
140void ocfs2_set_inode_flags(struct inode *inode);
141void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
142
143static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
144{
145 int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
146
147 return (blkcnt_t)OCFS2_I(inode)->ip_clusters << c_to_s_bits;
148}
149
150/* Validate that a bh contains a valid inode */
151int ocfs2_validate_inode_block(struct super_block *sb,
152 struct buffer_head *bh);
153/*
154 * Read an inode block into *bh. If *bh is NULL, a bh will be allocated.
155 * This is a cached read. The inode will be validated with
156 * ocfs2_validate_inode_block().
157 */
158int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
159/* The same, but can be passed OCFS2_BH_* flags */
160int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
161 int flags);
162
163static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
164{
165 return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
166}
167
168/* Does this inode have the reflink flag set? */
169static inline bool ocfs2_is_refcount_inode(struct inode *inode)
170{
171 return (OCFS2_I(inode)->ip_dyn_features & OCFS2_HAS_REFCOUNT_FL);
172}
173
174#endif /* OCFS2_INODE_H */
1/* -*- mode: c; c-basic-offset: 8; -*-
2 * vim: noexpandtab sw=8 ts=8 sts=0:
3 *
4 * inode.h
5 *
6 * Function prototypes
7 *
8 * Copyright (C) 2002, 2004 Oracle. All rights reserved.
9 *
10 * This program is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public
21 * License along with this program; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 021110-1307, USA.
24 */
25
26#ifndef OCFS2_INODE_H
27#define OCFS2_INODE_H
28
29#include "extent_map.h"
30
31/* OCFS2 Inode Private Data */
32struct ocfs2_inode_info
33{
34 u64 ip_blkno;
35
36 struct ocfs2_lock_res ip_rw_lockres;
37 struct ocfs2_lock_res ip_inode_lockres;
38 struct ocfs2_lock_res ip_open_lockres;
39
40 /* protects allocation changes on this inode. */
41 struct rw_semaphore ip_alloc_sem;
42
43 /* protects extended attribute changes on this inode */
44 struct rw_semaphore ip_xattr_sem;
45
46 /* Number of outstanding AIO's which are not page aligned */
47 struct mutex ip_unaligned_aio;
48
49 /* These fields are protected by ip_lock */
50 spinlock_t ip_lock;
51 u32 ip_open_count;
52 struct list_head ip_io_markers;
53 u32 ip_clusters;
54
55 u16 ip_dyn_features;
56 struct mutex ip_io_mutex;
57 u32 ip_flags; /* see below */
58 u32 ip_attr; /* inode attributes */
59
60 /* protected by recovery_lock. */
61 struct inode *ip_next_orphan;
62
63 struct ocfs2_caching_info ip_metadata_cache;
64 struct ocfs2_extent_map ip_extent_map;
65 struct inode vfs_inode;
66 struct jbd2_inode ip_jinode;
67
68 u32 ip_dir_start_lookup;
69
70 /* Only valid if the inode is the dir. */
71 u32 ip_last_used_slot;
72 u64 ip_last_used_group;
73 u32 ip_dir_lock_gen;
74
75 struct ocfs2_alloc_reservation ip_la_data_resv;
76
77 /*
78 * Transactions that contain inode's metadata needed to complete
79 * fsync and fdatasync, respectively.
80 */
81 tid_t i_sync_tid;
82 tid_t i_datasync_tid;
83};
84
85/*
86 * Flags for the ip_flags field
87 */
88/* System file inodes */
89#define OCFS2_INODE_SYSTEM_FILE 0x00000001
90#define OCFS2_INODE_JOURNAL 0x00000002
91#define OCFS2_INODE_BITMAP 0x00000004
92/* This inode has been wiped from disk */
93#define OCFS2_INODE_DELETED 0x00000008
94/* Has the inode been orphaned on another node?
95 *
96 * This hints to ocfs2_drop_inode that it should clear i_nlink before
97 * continuing.
98 *
99 * We *only* set this on unlink vote from another node. If the inode
100 * was locally orphaned, then we're sure of the state and don't need
101 * to twiddle i_nlink later - it's either zero or not depending on
102 * whether our unlink succeeded. Otherwise we got this from a node
103 * whose intention was to orphan the inode, however he may have
104 * crashed, failed etc, so we let ocfs2_drop_inode zero the value and
105 * rely on ocfs2_delete_inode to sort things out under the proper
106 * cluster locks.
107 */
108#define OCFS2_INODE_MAYBE_ORPHANED 0x00000010
109/* Does someone have the file open O_DIRECT */
110#define OCFS2_INODE_OPEN_DIRECT 0x00000020
111/* Tell the inode wipe code it's not in orphan dir */
112#define OCFS2_INODE_SKIP_ORPHAN_DIR 0x00000040
113
114static inline struct ocfs2_inode_info *OCFS2_I(struct inode *inode)
115{
116 return container_of(inode, struct ocfs2_inode_info, vfs_inode);
117}
118
119#define INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags & OCFS2_INODE_JOURNAL)
120#define SET_INODE_JOURNAL(i) (OCFS2_I(i)->ip_flags |= OCFS2_INODE_JOURNAL)
121
122extern struct kmem_cache *ocfs2_inode_cache;
123
124extern const struct address_space_operations ocfs2_aops;
125extern const struct ocfs2_caching_operations ocfs2_inode_caching_ops;
126
127static inline struct ocfs2_caching_info *INODE_CACHE(struct inode *inode)
128{
129 return &OCFS2_I(inode)->ip_metadata_cache;
130}
131
132void ocfs2_evict_inode(struct inode *inode);
133int ocfs2_drop_inode(struct inode *inode);
134
135/* Flags for ocfs2_iget() */
136#define OCFS2_FI_FLAG_SYSFILE 0x1
137#define OCFS2_FI_FLAG_ORPHAN_RECOVERY 0x2
138struct inode *ocfs2_ilookup(struct super_block *sb, u64 feoff);
139struct inode *ocfs2_iget(struct ocfs2_super *osb, u64 feoff, unsigned flags,
140 int sysfile_type);
141int ocfs2_inode_init_private(struct inode *inode);
142int ocfs2_inode_revalidate(struct dentry *dentry);
143void ocfs2_populate_inode(struct inode *inode, struct ocfs2_dinode *fe,
144 int create_ino);
145void ocfs2_read_inode(struct inode *inode);
146void ocfs2_read_inode2(struct inode *inode, void *opaque);
147ssize_t ocfs2_rw_direct(int rw, struct file *filp, char *buf,
148 size_t size, loff_t *offp);
149void ocfs2_sync_blockdev(struct super_block *sb);
150void ocfs2_refresh_inode(struct inode *inode,
151 struct ocfs2_dinode *fe);
152int ocfs2_mark_inode_dirty(handle_t *handle,
153 struct inode *inode,
154 struct buffer_head *bh);
155struct buffer_head *ocfs2_bread(struct inode *inode,
156 int block, int *err, int reada);
157
158void ocfs2_set_inode_flags(struct inode *inode);
159void ocfs2_get_inode_flags(struct ocfs2_inode_info *oi);
160
161static inline blkcnt_t ocfs2_inode_sector_count(struct inode *inode)
162{
163 int c_to_s_bits = OCFS2_SB(inode->i_sb)->s_clustersize_bits - 9;
164
165 return (blkcnt_t)(OCFS2_I(inode)->ip_clusters << c_to_s_bits);
166}
167
168/* Validate that a bh contains a valid inode */
169int ocfs2_validate_inode_block(struct super_block *sb,
170 struct buffer_head *bh);
171/*
172 * Read an inode block into *bh. If *bh is NULL, a bh will be allocated.
173 * This is a cached read. The inode will be validated with
174 * ocfs2_validate_inode_block().
175 */
176int ocfs2_read_inode_block(struct inode *inode, struct buffer_head **bh);
177/* The same, but can be passed OCFS2_BH_* flags */
178int ocfs2_read_inode_block_full(struct inode *inode, struct buffer_head **bh,
179 int flags);
180
181static inline struct ocfs2_inode_info *cache_info_to_inode(struct ocfs2_caching_info *ci)
182{
183 return container_of(ci, struct ocfs2_inode_info, ip_metadata_cache);
184}
185
186#endif /* OCFS2_INODE_H */