xref: /openbmc/linux/fs/xfs/libxfs/xfs_shared.h (revision 0da85d1e)
1 /*
2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3  * Copyright (c) 2013 Red Hat, Inc.
4  * All Rights Reserved.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License as
8  * published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope that it would be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write the Free Software Foundation,
17  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18  */
19 #ifndef __XFS_SHARED_H__
20 #define __XFS_SHARED_H__
21 
22 /*
23  * Definitions shared between kernel and userspace that don't fit into any other
24  * header file that is shared with userspace.
25  */
26 struct xfs_ifork;
27 struct xfs_buf;
28 struct xfs_buf_ops;
29 struct xfs_mount;
30 struct xfs_trans;
31 struct xfs_inode;
32 
33 /*
34  * Buffer verifier operations are widely used, including userspace tools
35  */
36 extern const struct xfs_buf_ops xfs_agf_buf_ops;
37 extern const struct xfs_buf_ops xfs_agi_buf_ops;
38 extern const struct xfs_buf_ops xfs_agf_buf_ops;
39 extern const struct xfs_buf_ops xfs_agfl_buf_ops;
40 extern const struct xfs_buf_ops xfs_allocbt_buf_ops;
41 extern const struct xfs_buf_ops xfs_attr3_leaf_buf_ops;
42 extern const struct xfs_buf_ops xfs_attr3_rmt_buf_ops;
43 extern const struct xfs_buf_ops xfs_bmbt_buf_ops;
44 extern const struct xfs_buf_ops xfs_da3_node_buf_ops;
45 extern const struct xfs_buf_ops xfs_dquot_buf_ops;
46 extern const struct xfs_buf_ops xfs_symlink_buf_ops;
47 extern const struct xfs_buf_ops xfs_agi_buf_ops;
48 extern const struct xfs_buf_ops xfs_inobt_buf_ops;
49 extern const struct xfs_buf_ops xfs_inode_buf_ops;
50 extern const struct xfs_buf_ops xfs_inode_buf_ra_ops;
51 extern const struct xfs_buf_ops xfs_dquot_buf_ops;
52 extern const struct xfs_buf_ops xfs_sb_buf_ops;
53 extern const struct xfs_buf_ops xfs_sb_quiet_buf_ops;
54 extern const struct xfs_buf_ops xfs_symlink_buf_ops;
55 
56 /*
57  * Transaction types.  Used to distinguish types of buffers. These never reach
58  * the log.
59  */
60 #define XFS_TRANS_SETATTR_NOT_SIZE	1
61 #define XFS_TRANS_SETATTR_SIZE		2
62 #define XFS_TRANS_INACTIVE		3
63 #define XFS_TRANS_CREATE		4
64 #define XFS_TRANS_CREATE_TRUNC		5
65 #define XFS_TRANS_TRUNCATE_FILE		6
66 #define XFS_TRANS_REMOVE		7
67 #define XFS_TRANS_LINK			8
68 #define XFS_TRANS_RENAME		9
69 #define XFS_TRANS_MKDIR			10
70 #define XFS_TRANS_RMDIR			11
71 #define XFS_TRANS_SYMLINK		12
72 #define XFS_TRANS_SET_DMATTRS		13
73 #define XFS_TRANS_GROWFS		14
74 #define XFS_TRANS_STRAT_WRITE		15
75 #define XFS_TRANS_DIOSTRAT		16
76 /* 17 was XFS_TRANS_WRITE_SYNC */
77 #define	XFS_TRANS_WRITEID		18
78 #define	XFS_TRANS_ADDAFORK		19
79 #define	XFS_TRANS_ATTRINVAL		20
80 #define	XFS_TRANS_ATRUNCATE		21
81 #define	XFS_TRANS_ATTR_SET		22
82 #define	XFS_TRANS_ATTR_RM		23
83 #define	XFS_TRANS_ATTR_FLAG		24
84 #define	XFS_TRANS_CLEAR_AGI_BUCKET	25
85 #define XFS_TRANS_SB_CHANGE		26
86 /*
87  * Dummy entries since we use the transaction type to index into the
88  * trans_type[] in xlog_recover_print_trans_head()
89  */
90 #define XFS_TRANS_DUMMY1		27
91 #define XFS_TRANS_DUMMY2		28
92 #define XFS_TRANS_QM_QUOTAOFF		29
93 #define XFS_TRANS_QM_DQALLOC		30
94 #define XFS_TRANS_QM_SETQLIM		31
95 #define XFS_TRANS_QM_DQCLUSTER		32
96 #define XFS_TRANS_QM_QINOCREATE		33
97 #define XFS_TRANS_QM_QUOTAOFF_END	34
98 #define XFS_TRANS_FSYNC_TS		35
99 #define	XFS_TRANS_GROWFSRT_ALLOC	36
100 #define	XFS_TRANS_GROWFSRT_ZERO		37
101 #define	XFS_TRANS_GROWFSRT_FREE		38
102 #define	XFS_TRANS_SWAPEXT		39
103 #define	XFS_TRANS_CHECKPOINT		40
104 #define	XFS_TRANS_ICREATE		41
105 #define	XFS_TRANS_CREATE_TMPFILE	42
106 #define	XFS_TRANS_TYPE_MAX		43
107 /* new transaction types need to be reflected in xfs_logprint(8) */
108 
109 #define XFS_TRANS_TYPES \
110 	{ XFS_TRANS_SETATTR_NOT_SIZE,	"SETATTR_NOT_SIZE" }, \
111 	{ XFS_TRANS_SETATTR_SIZE,	"SETATTR_SIZE" }, \
112 	{ XFS_TRANS_INACTIVE,		"INACTIVE" }, \
113 	{ XFS_TRANS_CREATE,		"CREATE" }, \
114 	{ XFS_TRANS_CREATE_TRUNC,	"CREATE_TRUNC" }, \
115 	{ XFS_TRANS_TRUNCATE_FILE,	"TRUNCATE_FILE" }, \
116 	{ XFS_TRANS_REMOVE,		"REMOVE" }, \
117 	{ XFS_TRANS_LINK,		"LINK" }, \
118 	{ XFS_TRANS_RENAME,		"RENAME" }, \
119 	{ XFS_TRANS_MKDIR,		"MKDIR" }, \
120 	{ XFS_TRANS_RMDIR,		"RMDIR" }, \
121 	{ XFS_TRANS_SYMLINK,		"SYMLINK" }, \
122 	{ XFS_TRANS_SET_DMATTRS,	"SET_DMATTRS" }, \
123 	{ XFS_TRANS_GROWFS,		"GROWFS" }, \
124 	{ XFS_TRANS_STRAT_WRITE,	"STRAT_WRITE" }, \
125 	{ XFS_TRANS_DIOSTRAT,		"DIOSTRAT" }, \
126 	{ XFS_TRANS_WRITEID,		"WRITEID" }, \
127 	{ XFS_TRANS_ADDAFORK,		"ADDAFORK" }, \
128 	{ XFS_TRANS_ATTRINVAL,		"ATTRINVAL" }, \
129 	{ XFS_TRANS_ATRUNCATE,		"ATRUNCATE" }, \
130 	{ XFS_TRANS_ATTR_SET,		"ATTR_SET" }, \
131 	{ XFS_TRANS_ATTR_RM,		"ATTR_RM" }, \
132 	{ XFS_TRANS_ATTR_FLAG,		"ATTR_FLAG" }, \
133 	{ XFS_TRANS_CLEAR_AGI_BUCKET,	"CLEAR_AGI_BUCKET" }, \
134 	{ XFS_TRANS_SB_CHANGE,		"SBCHANGE" }, \
135 	{ XFS_TRANS_DUMMY1,		"DUMMY1" }, \
136 	{ XFS_TRANS_DUMMY2,		"DUMMY2" }, \
137 	{ XFS_TRANS_QM_QUOTAOFF,	"QM_QUOTAOFF" }, \
138 	{ XFS_TRANS_QM_DQALLOC,		"QM_DQALLOC" }, \
139 	{ XFS_TRANS_QM_SETQLIM,		"QM_SETQLIM" }, \
140 	{ XFS_TRANS_QM_DQCLUSTER,	"QM_DQCLUSTER" }, \
141 	{ XFS_TRANS_QM_QINOCREATE,	"QM_QINOCREATE" }, \
142 	{ XFS_TRANS_QM_QUOTAOFF_END,	"QM_QOFF_END" }, \
143 	{ XFS_TRANS_FSYNC_TS,		"FSYNC_TS" }, \
144 	{ XFS_TRANS_GROWFSRT_ALLOC,	"GROWFSRT_ALLOC" }, \
145 	{ XFS_TRANS_GROWFSRT_ZERO,	"GROWFSRT_ZERO" }, \
146 	{ XFS_TRANS_GROWFSRT_FREE,	"GROWFSRT_FREE" }, \
147 	{ XFS_TRANS_SWAPEXT,		"SWAPEXT" }, \
148 	{ XFS_TRANS_CHECKPOINT,		"CHECKPOINT" }, \
149 	{ XFS_TRANS_ICREATE,		"ICREATE" }, \
150 	{ XFS_TRANS_CREATE_TMPFILE,	"CREATE_TMPFILE" }, \
151 	{ XLOG_UNMOUNT_REC_TYPE,	"UNMOUNT" }
152 
153 /*
154  * This structure is used to track log items associated with
155  * a transaction.  It points to the log item and keeps some
156  * flags to track the state of the log item.  It also tracks
157  * the amount of space needed to log the item it describes
158  * once we get to commit processing (see xfs_trans_commit()).
159  */
160 struct xfs_log_item_desc {
161 	struct xfs_log_item	*lid_item;
162 	struct list_head	lid_trans;
163 	unsigned char		lid_flags;
164 };
165 
166 #define XFS_LID_DIRTY		0x1
167 
168 /* log size calculation functions */
169 int	xfs_log_calc_unit_res(struct xfs_mount *mp, int unit_bytes);
170 int	xfs_log_calc_minimum_size(struct xfs_mount *);
171 
172 
173 /*
174  * Values for t_flags.
175  */
176 #define	XFS_TRANS_DIRTY		0x01	/* something needs to be logged */
177 #define	XFS_TRANS_SB_DIRTY	0x02	/* superblock is modified */
178 #define	XFS_TRANS_PERM_LOG_RES	0x04	/* xact took a permanent log res */
179 #define	XFS_TRANS_SYNC		0x08	/* make commit synchronous */
180 #define XFS_TRANS_DQ_DIRTY	0x10	/* at least one dquot in trx dirty */
181 #define XFS_TRANS_RESERVE	0x20    /* OK to use reserved data blocks */
182 #define XFS_TRANS_FREEZE_PROT	0x40	/* Transaction has elevated writer
183 					   count in superblock */
184 /*
185  * Values for call flags parameter.
186  */
187 #define	XFS_TRANS_RELEASE_LOG_RES	0x4
188 #define	XFS_TRANS_ABORT			0x8
189 
190 /*
191  * Field values for xfs_trans_mod_sb.
192  */
193 #define	XFS_TRANS_SB_ICOUNT		0x00000001
194 #define	XFS_TRANS_SB_IFREE		0x00000002
195 #define	XFS_TRANS_SB_FDBLOCKS		0x00000004
196 #define	XFS_TRANS_SB_RES_FDBLOCKS	0x00000008
197 #define	XFS_TRANS_SB_FREXTENTS		0x00000010
198 #define	XFS_TRANS_SB_RES_FREXTENTS	0x00000020
199 #define	XFS_TRANS_SB_DBLOCKS		0x00000040
200 #define	XFS_TRANS_SB_AGCOUNT		0x00000080
201 #define	XFS_TRANS_SB_IMAXPCT		0x00000100
202 #define	XFS_TRANS_SB_REXTSIZE		0x00000200
203 #define	XFS_TRANS_SB_RBMBLOCKS		0x00000400
204 #define	XFS_TRANS_SB_RBLOCKS		0x00000800
205 #define	XFS_TRANS_SB_REXTENTS		0x00001000
206 #define	XFS_TRANS_SB_REXTSLOG		0x00002000
207 
208 /*
209  * Here we centralize the specification of XFS meta-data buffer reference count
210  * values.  This determines how hard the buffer cache tries to hold onto the
211  * buffer.
212  */
213 #define	XFS_AGF_REF		4
214 #define	XFS_AGI_REF		4
215 #define	XFS_AGFL_REF		3
216 #define	XFS_INO_BTREE_REF	3
217 #define	XFS_ALLOC_BTREE_REF	2
218 #define	XFS_BMAP_BTREE_REF	2
219 #define	XFS_DIR_BTREE_REF	2
220 #define	XFS_INO_REF		2
221 #define	XFS_ATTR_BTREE_REF	1
222 #define	XFS_DQUOT_REF		1
223 
224 /*
225  * Flags for xfs_trans_ichgtime().
226  */
227 #define	XFS_ICHGTIME_MOD	0x1	/* data fork modification timestamp */
228 #define	XFS_ICHGTIME_CHG	0x2	/* inode field change timestamp */
229 #define	XFS_ICHGTIME_CREATE	0x4	/* inode create timestamp */
230 
231 
232 /*
233  * Symlink decoding/encoding functions
234  */
235 int xfs_symlink_blocks(struct xfs_mount *mp, int pathlen);
236 int xfs_symlink_hdr_set(struct xfs_mount *mp, xfs_ino_t ino, uint32_t offset,
237 			uint32_t size, struct xfs_buf *bp);
238 bool xfs_symlink_hdr_ok(xfs_ino_t ino, uint32_t offset,
239 			uint32_t size, struct xfs_buf *bp);
240 void xfs_symlink_local_to_remote(struct xfs_trans *tp, struct xfs_buf *bp,
241 				 struct xfs_inode *ip, struct xfs_ifork *ifp);
242 
243 #endif /* __XFS_SHARED_H__ */
244