xref: /openbmc/linux/fs/xfs/libxfs/xfs_shared.h (revision 9a29ad52)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
4  * Copyright (c) 2013 Red Hat, Inc.
5  * All Rights Reserved.
6  */
7 #ifndef __XFS_SHARED_H__
8 #define __XFS_SHARED_H__
9 
10 /*
11  * Definitions shared between kernel and userspace that don't fit into any other
12  * header file that is shared with userspace.
13  */
14 struct xfs_ifork;
15 struct xfs_buf;
16 struct xfs_buf_ops;
17 struct xfs_mount;
18 struct xfs_trans;
19 struct xfs_inode;
20 
21 /*
22  * Buffer verifier operations are widely used, including userspace tools
23  */
24 extern const struct xfs_buf_ops xfs_agf_buf_ops;
25 extern const struct xfs_buf_ops xfs_agi_buf_ops;
26 extern const struct xfs_buf_ops xfs_agf_buf_ops;
27 extern const struct xfs_buf_ops xfs_agfl_buf_ops;
28 extern const struct xfs_buf_ops xfs_allocbt_buf_ops;
29 extern const struct xfs_buf_ops xfs_rmapbt_buf_ops;
30 extern const struct xfs_buf_ops xfs_refcountbt_buf_ops;
31 extern const struct xfs_buf_ops xfs_attr3_leaf_buf_ops;
32 extern const struct xfs_buf_ops xfs_attr3_rmt_buf_ops;
33 extern const struct xfs_buf_ops xfs_bmbt_buf_ops;
34 extern const struct xfs_buf_ops xfs_da3_node_buf_ops;
35 extern const struct xfs_buf_ops xfs_dquot_buf_ops;
36 extern const struct xfs_buf_ops xfs_symlink_buf_ops;
37 extern const struct xfs_buf_ops xfs_agi_buf_ops;
38 extern const struct xfs_buf_ops xfs_inobt_buf_ops;
39 extern const struct xfs_buf_ops xfs_inode_buf_ops;
40 extern const struct xfs_buf_ops xfs_inode_buf_ra_ops;
41 extern const struct xfs_buf_ops xfs_dquot_buf_ops;
42 extern const struct xfs_buf_ops xfs_dquot_buf_ra_ops;
43 extern const struct xfs_buf_ops xfs_sb_buf_ops;
44 extern const struct xfs_buf_ops xfs_sb_quiet_buf_ops;
45 extern const struct xfs_buf_ops xfs_symlink_buf_ops;
46 extern const struct xfs_buf_ops xfs_rtbuf_ops;
47 
48 /* log size calculation functions */
49 int	xfs_log_calc_unit_res(struct xfs_mount *mp, int unit_bytes);
50 int	xfs_log_calc_minimum_size(struct xfs_mount *);
51 
52 struct xfs_trans_res;
53 void	xfs_log_get_max_trans_res(struct xfs_mount *mp,
54 				  struct xfs_trans_res *max_resp);
55 
56 /*
57  * Values for t_flags.
58  */
59 #define	XFS_TRANS_DIRTY		0x01	/* something needs to be logged */
60 #define	XFS_TRANS_SB_DIRTY	0x02	/* superblock is modified */
61 #define	XFS_TRANS_PERM_LOG_RES	0x04	/* xact took a permanent log res */
62 #define	XFS_TRANS_SYNC		0x08	/* make commit synchronous */
63 #define XFS_TRANS_DQ_DIRTY	0x10	/* at least one dquot in trx dirty */
64 #define XFS_TRANS_RESERVE	0x20    /* OK to use reserved data blocks */
65 #define XFS_TRANS_NO_WRITECOUNT 0x40	/* do not elevate SB writecount */
66 #define XFS_TRANS_NOFS		0x80	/* pass KM_NOFS to kmem_alloc */
67 
68 /*
69  * Field values for xfs_trans_mod_sb.
70  */
71 #define	XFS_TRANS_SB_ICOUNT		0x00000001
72 #define	XFS_TRANS_SB_IFREE		0x00000002
73 #define	XFS_TRANS_SB_FDBLOCKS		0x00000004
74 #define	XFS_TRANS_SB_RES_FDBLOCKS	0x00000008
75 #define	XFS_TRANS_SB_FREXTENTS		0x00000010
76 #define	XFS_TRANS_SB_RES_FREXTENTS	0x00000020
77 #define	XFS_TRANS_SB_DBLOCKS		0x00000040
78 #define	XFS_TRANS_SB_AGCOUNT		0x00000080
79 #define	XFS_TRANS_SB_IMAXPCT		0x00000100
80 #define	XFS_TRANS_SB_REXTSIZE		0x00000200
81 #define	XFS_TRANS_SB_RBMBLOCKS		0x00000400
82 #define	XFS_TRANS_SB_RBLOCKS		0x00000800
83 #define	XFS_TRANS_SB_REXTENTS		0x00001000
84 #define	XFS_TRANS_SB_REXTSLOG		0x00002000
85 
86 /*
87  * Here we centralize the specification of XFS meta-data buffer reference count
88  * values.  This determines how hard the buffer cache tries to hold onto the
89  * buffer.
90  */
91 #define	XFS_AGF_REF		4
92 #define	XFS_AGI_REF		4
93 #define	XFS_AGFL_REF		3
94 #define	XFS_INO_BTREE_REF	3
95 #define	XFS_ALLOC_BTREE_REF	2
96 #define	XFS_BMAP_BTREE_REF	2
97 #define	XFS_RMAP_BTREE_REF	2
98 #define	XFS_DIR_BTREE_REF	2
99 #define	XFS_INO_REF		2
100 #define	XFS_ATTR_BTREE_REF	1
101 #define	XFS_DQUOT_REF		1
102 #define	XFS_REFC_BTREE_REF	1
103 #define	XFS_SSB_REF		0
104 
105 /*
106  * Flags for xfs_trans_ichgtime().
107  */
108 #define	XFS_ICHGTIME_MOD	0x1	/* data fork modification timestamp */
109 #define	XFS_ICHGTIME_CHG	0x2	/* inode field change timestamp */
110 #define	XFS_ICHGTIME_CREATE	0x4	/* inode create timestamp */
111 
112 
113 /*
114  * Symlink decoding/encoding functions
115  */
116 int xfs_symlink_blocks(struct xfs_mount *mp, int pathlen);
117 int xfs_symlink_hdr_set(struct xfs_mount *mp, xfs_ino_t ino, uint32_t offset,
118 			uint32_t size, struct xfs_buf *bp);
119 bool xfs_symlink_hdr_ok(xfs_ino_t ino, uint32_t offset,
120 			uint32_t size, struct xfs_buf *bp);
121 void xfs_symlink_local_to_remote(struct xfs_trans *tp, struct xfs_buf *bp,
122 				 struct xfs_inode *ip, struct xfs_ifork *ifp);
123 xfs_failaddr_t xfs_symlink_shortform_verify(struct xfs_inode *ip);
124 
125 #endif /* __XFS_SHARED_H__ */
126