xfs_bmap.h

  1/* SPDX-License-Identifier: GPL-2.0 */
  2/*
  3 * Copyright (c) 2000-2006 Silicon Graphics, Inc.
  4 * All Rights Reserved.
  5 */
  6#ifndef __XFS_BMAP_H__
  7#define	__XFS_BMAP_H__
  8
  9struct getbmap;
 10struct xfs_bmbt_irec;
 11struct xfs_ifork;
 12struct xfs_inode;
 13struct xfs_mount;
 14struct xfs_trans;
 15struct xfs_alloc_arg;
 16
 17/*
 18 * Argument structure for xfs_bmap_alloc.
 19 */
 20struct xfs_bmalloca {
 21	struct xfs_trans	*tp;	/* transaction pointer */
 22	struct xfs_inode	*ip;	/* incore inode pointer */
 23	struct xfs_bmbt_irec	prev;	/* extent before the new one */
 24	struct xfs_bmbt_irec	got;	/* extent after, or delayed */
 25
 26	xfs_fileoff_t		offset;	/* offset in file filling in */
 27	xfs_extlen_t		length;	/* i/o length asked/allocated */
 28	xfs_fsblock_t		blkno;	/* starting block of new extent */
 29
 30	struct xfs_btree_cur	*cur;	/* btree cursor */
 31	struct xfs_iext_cursor	icur;	/* incore extent cursor */
 32	int			nallocs;/* number of extents alloc'd */
 33	int			logflags;/* flags for transaction logging */
 34
 35	xfs_extlen_t		total;	/* total blocks needed for xaction */
 36	xfs_extlen_t		minlen;	/* minimum allocation size (blocks) */
 37	xfs_extlen_t		minleft; /* amount must be left after alloc */
 38	bool			eof;	/* set if allocating past last extent */
 39	bool			wasdel;	/* replacing a delayed allocation */
 40	bool			aeof;	/* allocated space at eof */
 41	bool			conv;	/* overwriting unwritten extents */
 42	int			datatype;/* data type being allocated */
 43	uint32_t		flags;
 44};
 45
 46#define	XFS_BMAP_MAX_NMAP	4
 47
 48/*
 49 * Flags for xfs_bmapi_*
 50 */
 51#define XFS_BMAPI_ENTIRE	(1u << 0) /* return entire extent untrimmed */
 52#define XFS_BMAPI_METADATA	(1u << 1) /* mapping metadata not user data */
 53#define XFS_BMAPI_ATTRFORK	(1u << 2) /* use attribute fork not data */
 54#define XFS_BMAPI_PREALLOC	(1u << 3) /* preallocating unwritten space */
 55#define XFS_BMAPI_CONTIG	(1u << 4) /* must allocate only one extent */
 56/*
 57 * unwritten extent conversion - this needs write cache flushing and no additional
 58 * allocation alignments. When specified with XFS_BMAPI_PREALLOC it converts
 59 * from written to unwritten, otherwise convert from unwritten to written.
 60 */
 61#define XFS_BMAPI_CONVERT	(1u << 5)
 62
 63/*
 64 * allocate zeroed extents - this requires all newly allocated user data extents
 65 * to be initialised to zero. It will be ignored if XFS_BMAPI_METADATA is set.
 66 * Use in conjunction with XFS_BMAPI_CONVERT to convert unwritten extents found
 67 * during the allocation range to zeroed written extents.
 68 */
 69#define XFS_BMAPI_ZERO		(1u << 6)
 70
 71/*
 72 * Map the inode offset to the block given in ap->firstblock.  Primarily
 73 * used for reflink.  The range must be in a hole, and this flag cannot be
 74 * turned on with PREALLOC or CONVERT, and cannot be used on the attr fork.
 75 *
 76 * For bunmapi, this flag unmaps the range without adjusting quota, reducing
 77 * refcount, or freeing the blocks.
 78 */
 79#define XFS_BMAPI_REMAP		(1u << 7)
 80
 81/* Map something in the CoW fork. */
 82#define XFS_BMAPI_COWFORK	(1u << 8)
 83
 84/* Skip online discard of freed extents */
 85#define XFS_BMAPI_NODISCARD	(1u << 9)
 86
 87/* Do not update the rmap btree.  Used for reconstructing bmbt from rmapbt. */
 88#define XFS_BMAPI_NORMAP	(1u << 10)
 89
 90/* Try to align allocations to the extent size hint */
 91#define XFS_BMAPI_EXTSZALIGN	(1u << 11)
 92
 93#define XFS_BMAPI_FLAGS \
 94	{ XFS_BMAPI_ENTIRE,	"ENTIRE" }, \
 95	{ XFS_BMAPI_METADATA,	"METADATA" }, \
 96	{ XFS_BMAPI_ATTRFORK,	"ATTRFORK" }, \
 97	{ XFS_BMAPI_PREALLOC,	"PREALLOC" }, \
 98	{ XFS_BMAPI_CONTIG,	"CONTIG" }, \
 99	{ XFS_BMAPI_CONVERT,	"CONVERT" }, \
100	{ XFS_BMAPI_ZERO,	"ZERO" }, \
101	{ XFS_BMAPI_REMAP,	"REMAP" }, \
102	{ XFS_BMAPI_COWFORK,	"COWFORK" }, \
103	{ XFS_BMAPI_NODISCARD,	"NODISCARD" }, \
104	{ XFS_BMAPI_NORMAP,	"NORMAP" },\
105	{ XFS_BMAPI_EXTSZALIGN,	"EXTSZALIGN" }
106
107
108static inline int xfs_bmapi_aflag(int w)
109{
110	return (w == XFS_ATTR_FORK ? XFS_BMAPI_ATTRFORK :
111	       (w == XFS_COW_FORK ? XFS_BMAPI_COWFORK : 0));
112}
113
114static inline int xfs_bmapi_whichfork(uint32_t bmapi_flags)
115{
116	if (bmapi_flags & XFS_BMAPI_COWFORK)
117		return XFS_COW_FORK;
118	else if (bmapi_flags & XFS_BMAPI_ATTRFORK)
119		return XFS_ATTR_FORK;
120	return XFS_DATA_FORK;
121}
122
123void xfs_bmap_alloc_account(struct xfs_bmalloca *ap);
124
125/*
126 * Special values for xfs_bmbt_irec_t br_startblock field.
127 */
128#define	DELAYSTARTBLOCK		((xfs_fsblock_t)-1LL)
129#define	HOLESTARTBLOCK		((xfs_fsblock_t)-2LL)
130
131/*
132 * Flags for xfs_bmap_add_extent*.
133 */
134#define BMAP_LEFT_CONTIG	(1u << 0)
135#define BMAP_RIGHT_CONTIG	(1u << 1)
136#define BMAP_LEFT_FILLING	(1u << 2)
137#define BMAP_RIGHT_FILLING	(1u << 3)
138#define BMAP_LEFT_DELAY		(1u << 4)
139#define BMAP_RIGHT_DELAY	(1u << 5)
140#define BMAP_LEFT_VALID		(1u << 6)
141#define BMAP_RIGHT_VALID	(1u << 7)
142#define BMAP_ATTRFORK		(1u << 8)
143#define BMAP_COWFORK		(1u << 9)
144
145#define XFS_BMAP_EXT_FLAGS \
146	{ BMAP_LEFT_CONTIG,	"LC" }, \
147	{ BMAP_RIGHT_CONTIG,	"RC" }, \
148	{ BMAP_LEFT_FILLING,	"LF" }, \
149	{ BMAP_RIGHT_FILLING,	"RF" }, \
150	{ BMAP_ATTRFORK,	"ATTR" }, \
151	{ BMAP_COWFORK,		"COW" }
152
153/* Return true if the extent is an allocated extent, written or not. */
154static inline bool xfs_bmap_is_real_extent(const struct xfs_bmbt_irec *irec)
155{
156	return irec->br_startblock != HOLESTARTBLOCK &&
157		irec->br_startblock != DELAYSTARTBLOCK &&
158		!isnullstartblock(irec->br_startblock);
159}
160
161/*
162 * Return true if the extent is a real, allocated extent, or false if it is  a
163 * delayed allocation, and unwritten extent or a hole.
164 */
165static inline bool xfs_bmap_is_written_extent(const struct xfs_bmbt_irec *irec)
166{
167	return xfs_bmap_is_real_extent(irec) &&
168	       irec->br_state != XFS_EXT_UNWRITTEN;
169}
170
171/*
172 * Check the mapping for obviously garbage allocations that could trash the
173 * filesystem immediately.
174 */
175#define xfs_valid_startblock(ip, startblock) \
176	((startblock) != 0 || XFS_IS_REALTIME_INODE(ip))
177
178int	xfs_bmap_longest_free_extent(struct xfs_perag *pag,
179		struct xfs_trans *tp, xfs_extlen_t *blen);
180void	xfs_trim_extent(struct xfs_bmbt_irec *irec, xfs_fileoff_t bno,
181		xfs_filblks_t len);
182unsigned int xfs_bmap_compute_attr_offset(struct xfs_mount *mp);
183int	xfs_bmap_add_attrfork(struct xfs_trans *tp, struct xfs_inode *ip,
184		int size, int rsvd);
185void	xfs_bmap_local_to_extents_empty(struct xfs_trans *tp,
186		struct xfs_inode *ip, int whichfork);
187int xfs_bmap_local_to_extents(struct xfs_trans *tp, struct xfs_inode *ip,
188		xfs_extlen_t total, int *logflagsp, int whichfork,
189		void (*init_fn)(struct xfs_trans *tp, struct xfs_buf *bp,
190				struct xfs_inode *ip, struct xfs_ifork *ifp,
191				void *priv),
192		void *priv);
193void	xfs_bmap_compute_maxlevels(struct xfs_mount *mp, int whichfork);
194int	xfs_bmap_first_unused(struct xfs_trans *tp, struct xfs_inode *ip,
195		xfs_extlen_t len, xfs_fileoff_t *unused, int whichfork);
196int	xfs_bmap_last_before(struct xfs_trans *tp, struct xfs_inode *ip,
197		xfs_fileoff_t *last_block, int whichfork);
198int	xfs_bmap_last_offset(struct xfs_inode *ip, xfs_fileoff_t *unused,
199		int whichfork);
200int	xfs_bmapi_read(struct xfs_inode *ip, xfs_fileoff_t bno,
201		xfs_filblks_t len, struct xfs_bmbt_irec *mval,
202		int *nmap, uint32_t flags);
203int	xfs_bmapi_write(struct xfs_trans *tp, struct xfs_inode *ip,
204		xfs_fileoff_t bno, xfs_filblks_t len, uint32_t flags,
205		xfs_extlen_t total, struct xfs_bmbt_irec *mval, int *nmap);
206int	xfs_bunmapi(struct xfs_trans *tp, struct xfs_inode *ip,
207		xfs_fileoff_t bno, xfs_filblks_t len, uint32_t flags,
208		xfs_extnum_t nexts, int *done);
209void	xfs_bmap_del_extent_delay(struct xfs_inode *ip, int whichfork,
210		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
211		struct xfs_bmbt_irec *del, uint32_t bflags);
212void	xfs_bmap_del_extent_cow(struct xfs_inode *ip,
213		struct xfs_iext_cursor *cur, struct xfs_bmbt_irec *got,
214		struct xfs_bmbt_irec *del);
215uint	xfs_default_attroffset(struct xfs_inode *ip);
216int	xfs_bmap_collapse_extents(struct xfs_trans *tp, struct xfs_inode *ip,
217		xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
218		bool *done);
219int	xfs_bmap_can_insert_extents(struct xfs_inode *ip, xfs_fileoff_t off,
220		xfs_fileoff_t shift);
221int	xfs_bmap_insert_extents(struct xfs_trans *tp, struct xfs_inode *ip,
222		xfs_fileoff_t *next_fsb, xfs_fileoff_t offset_shift_fsb,
223		bool *done, xfs_fileoff_t stop_fsb);
224int	xfs_bmap_split_extent(struct xfs_trans *tp, struct xfs_inode *ip,
225		xfs_fileoff_t split_offset);
226int	xfs_bmapi_convert_delalloc(struct xfs_inode *ip, int whichfork,
227		xfs_off_t offset, struct iomap *iomap, unsigned int *seq);
228int	xfs_bmap_add_extent_unwritten_real(struct xfs_trans *tp,
229		struct xfs_inode *ip, int whichfork,
230		struct xfs_iext_cursor *icur, struct xfs_btree_cur **curp,
231		struct xfs_bmbt_irec *new, int *logflagsp);
232xfs_extlen_t xfs_bmapi_minleft(struct xfs_trans *tp, struct xfs_inode *ip,
233		int fork);
234int	xfs_bmap_btalloc_low_space(struct xfs_bmalloca *ap,
235		struct xfs_alloc_arg *args);
236xfs_filblks_t xfs_bmap_worst_indlen(struct xfs_inode *ip, xfs_filblks_t len);
237
238enum xfs_bmap_intent_type {
239	XFS_BMAP_MAP = 1,
240	XFS_BMAP_UNMAP,
241};
242
243#define XFS_BMAP_INTENT_STRINGS \
244	{ XFS_BMAP_MAP,		"map" }, \
245	{ XFS_BMAP_UNMAP,	"unmap" }
246
247struct xfs_bmap_intent {
248	struct list_head			bi_list;
249	enum xfs_bmap_intent_type		bi_type;
250	int					bi_whichfork;
251	struct xfs_inode			*bi_owner;
252	struct xfs_group			*bi_group;
253	struct xfs_bmbt_irec			bi_bmap;
254};
255
256int	xfs_bmap_finish_one(struct xfs_trans *tp, struct xfs_bmap_intent *bi);
257void	xfs_bmap_map_extent(struct xfs_trans *tp, struct xfs_inode *ip,
258		int whichfork, struct xfs_bmbt_irec *imap);
259void	xfs_bmap_unmap_extent(struct xfs_trans *tp, struct xfs_inode *ip,
260		int whichfork, struct xfs_bmbt_irec *imap);
261
262static inline uint32_t xfs_bmap_fork_to_state(int whichfork)
263{
264	switch (whichfork) {
265	case XFS_ATTR_FORK:
266		return BMAP_ATTRFORK;
267	case XFS_COW_FORK:
268		return BMAP_COWFORK;
269	default:
270		return 0;
271	}
272}
273
274xfs_failaddr_t xfs_bmap_validate_extent_raw(struct xfs_mount *mp, bool rtfile,
275		int whichfork, struct xfs_bmbt_irec *irec);
276xfs_failaddr_t xfs_bmap_validate_extent(struct xfs_inode *ip, int whichfork,
277		struct xfs_bmbt_irec *irec);
278int xfs_bmap_complain_bad_rec(struct xfs_inode *ip, int whichfork,
279		xfs_failaddr_t fa, const struct xfs_bmbt_irec *irec);
280
281int	xfs_bmapi_remap(struct xfs_trans *tp, struct xfs_inode *ip,
282		xfs_fileoff_t bno, xfs_filblks_t len, xfs_fsblock_t startblock,
283		uint32_t flags);
284int	xfs_bunmapi_range(struct xfs_trans **tpp, struct xfs_inode *ip,
285		uint32_t flags, xfs_fileoff_t startoff, xfs_fileoff_t endoff);
286
287extern struct kmem_cache	*xfs_bmap_intent_cache;
288
289int __init xfs_bmap_intent_init_cache(void);
290void xfs_bmap_intent_destroy_cache(void);
291
292typedef int (*xfs_bmap_query_range_fn)(
293	struct xfs_btree_cur	*cur,
294	struct xfs_bmbt_irec	*rec,
295	void			*priv);
296
297int xfs_bmap_query_all(struct xfs_btree_cur *cur, xfs_bmap_query_range_fn fn,
298		void *priv);
299
300xfs_extlen_t	xfs_get_extsz_hint(struct xfs_inode *ip);
301xfs_extlen_t	xfs_get_cowextsz_hint(struct xfs_inode *ip);
302
303#endif	/* __XFS_BMAP_H__ */