xref: /openbmc/linux/fs/xfs/libxfs/xfs_ialloc.h (revision 06701297)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2000,2005 Silicon Graphics, Inc.
4  * All Rights Reserved.
5  */
6 #ifndef __XFS_IALLOC_H__
7 #define	__XFS_IALLOC_H__
8 
9 struct xfs_buf;
10 struct xfs_dinode;
11 struct xfs_imap;
12 struct xfs_mount;
13 struct xfs_trans;
14 struct xfs_btree_cur;
15 
16 /* Move inodes in clusters of this size */
17 #define	XFS_INODE_BIG_CLUSTER_SIZE	8192
18 
19 struct xfs_icluster {
20 	bool		deleted;	/* record is deleted */
21 	xfs_ino_t	first_ino;	/* first inode number */
22 	uint64_t	alloc;		/* inode phys. allocation bitmap for
23 					 * sparse chunks */
24 };
25 
26 /*
27  * Make an inode pointer out of the buffer/offset.
28  */
29 static inline struct xfs_dinode *
30 xfs_make_iptr(struct xfs_mount *mp, struct xfs_buf *b, int o)
31 {
32 	return xfs_buf_offset(b, o << (mp)->m_sb.sb_inodelog);
33 }
34 
35 /*
36  * Allocate an inode on disk.
37  * Mode is used to tell whether the new inode will need space, and whether
38  * it is a directory.
39  *
40  * There are two phases to inode allocation: selecting an AG and ensuring
41  * that it contains free inodes, followed by allocating one of the free
42  * inodes. xfs_dialloc_select_ag() does the former and returns a locked AGI
43  * to the caller, ensuring that followup call to xfs_dialloc_ag() will
44  * have free inodes to allocate from. xfs_dialloc_ag() will return the inode
45  * number of the free inode we allocated.
46  */
47 int					/* error */
48 xfs_dialloc_select_ag(
49 	struct xfs_trans **tpp,		/* double pointer of transaction */
50 	xfs_ino_t	parent,		/* parent inode (directory) */
51 	umode_t		mode,		/* mode bits for new inode */
52 	struct xfs_buf	**IO_agbp);
53 
54 int
55 xfs_dialloc_ag(
56 	struct xfs_trans	*tp,
57 	struct xfs_buf		*agbp,
58 	xfs_ino_t		parent,
59 	xfs_ino_t		*inop);
60 
61 /*
62  * Free disk inode.  Carefully avoids touching the incore inode, all
63  * manipulations incore are the caller's responsibility.
64  * The on-disk inode is not changed by this operation, only the
65  * btree (free inode mask) is changed.
66  */
67 int					/* error */
68 xfs_difree(
69 	struct xfs_trans *tp,		/* transaction pointer */
70 	xfs_ino_t	inode,		/* inode to be freed */
71 	struct xfs_icluster *ifree);	/* cluster info if deleted */
72 
73 /*
74  * Return the location of the inode in imap, for mapping it into a buffer.
75  */
76 int
77 xfs_imap(
78 	struct xfs_mount *mp,		/* file system mount structure */
79 	struct xfs_trans *tp,		/* transaction pointer */
80 	xfs_ino_t	ino,		/* inode to locate */
81 	struct xfs_imap	*imap,		/* location map structure */
82 	uint		flags);		/* flags for inode btree lookup */
83 
84 /*
85  * Log specified fields for the ag hdr (inode section)
86  */
87 void
88 xfs_ialloc_log_agi(
89 	struct xfs_trans *tp,		/* transaction pointer */
90 	struct xfs_buf	*bp,		/* allocation group header buffer */
91 	int		fields);	/* bitmask of fields to log */
92 
93 /*
94  * Read in the allocation group header (inode allocation section)
95  */
96 int					/* error */
97 xfs_ialloc_read_agi(
98 	struct xfs_mount *mp,		/* file system mount structure */
99 	struct xfs_trans *tp,		/* transaction pointer */
100 	xfs_agnumber_t	agno,		/* allocation group number */
101 	struct xfs_buf	**bpp);		/* allocation group hdr buf */
102 
103 /*
104  * Read in the allocation group header to initialise the per-ag data
105  * in the mount structure
106  */
107 int
108 xfs_ialloc_pagi_init(
109 	struct xfs_mount *mp,		/* file system mount structure */
110 	struct xfs_trans *tp,		/* transaction pointer */
111         xfs_agnumber_t  agno);		/* allocation group number */
112 
113 /*
114  * Lookup a record by ino in the btree given by cur.
115  */
116 int xfs_inobt_lookup(struct xfs_btree_cur *cur, xfs_agino_t ino,
117 		xfs_lookup_t dir, int *stat);
118 
119 /*
120  * Get the data from the pointed-to record.
121  */
122 int xfs_inobt_get_rec(struct xfs_btree_cur *cur,
123 		xfs_inobt_rec_incore_t *rec, int *stat);
124 
125 /*
126  * Inode chunk initialisation routine
127  */
128 int xfs_ialloc_inode_init(struct xfs_mount *mp, struct xfs_trans *tp,
129 			  struct list_head *buffer_list, int icount,
130 			  xfs_agnumber_t agno, xfs_agblock_t agbno,
131 			  xfs_agblock_t length, unsigned int gen);
132 
133 int xfs_read_agi(struct xfs_mount *mp, struct xfs_trans *tp,
134 		xfs_agnumber_t agno, struct xfs_buf **bpp);
135 
136 union xfs_btree_rec;
137 void xfs_inobt_btrec_to_irec(struct xfs_mount *mp, union xfs_btree_rec *rec,
138 		struct xfs_inobt_rec_incore *irec);
139 int xfs_ialloc_has_inodes_at_extent(struct xfs_btree_cur *cur,
140 		xfs_agblock_t bno, xfs_extlen_t len, bool *exists);
141 int xfs_ialloc_has_inode_record(struct xfs_btree_cur *cur, xfs_agino_t low,
142 		xfs_agino_t high, bool *exists);
143 int xfs_ialloc_count_inodes(struct xfs_btree_cur *cur, xfs_agino_t *count,
144 		xfs_agino_t *freecount);
145 int xfs_inobt_insert_rec(struct xfs_btree_cur *cur, uint16_t holemask,
146 		uint8_t count, int32_t freecount, xfs_inofree_t free,
147 		int *stat);
148 
149 int xfs_ialloc_cluster_alignment(struct xfs_mount *mp);
150 void xfs_ialloc_setup_geometry(struct xfs_mount *mp);
151 xfs_ino_t xfs_ialloc_calc_rootino(struct xfs_mount *mp, int sunit);
152 
153 #endif	/* __XFS_IALLOC_H__ */
154