xref: /openbmc/linux/fs/ext4/balloc.c (revision 21278aea)
1 /*
2  *  linux/fs/ext4/balloc.c
3  *
4  * Copyright (C) 1992, 1993, 1994, 1995
5  * Remy Card (card@masi.ibp.fr)
6  * Laboratoire MASI - Institut Blaise Pascal
7  * Universite Pierre et Marie Curie (Paris VI)
8  *
9  *  Enhanced block allocation by Stephen Tweedie (sct@redhat.com), 1993
10  *  Big-endian to little-endian byte-swapping/bitmaps by
11  *        David S. Miller (davem@caip.rutgers.edu), 1995
12  */
13 
14 #include <linux/time.h>
15 #include <linux/capability.h>
16 #include <linux/fs.h>
17 #include <linux/jbd2.h>
18 #include <linux/quotaops.h>
19 #include <linux/buffer_head.h>
20 #include "ext4.h"
21 #include "ext4_jbd2.h"
22 #include "mballoc.h"
23 
24 #include <trace/events/ext4.h>
25 
26 static unsigned ext4_num_base_meta_clusters(struct super_block *sb,
27 					    ext4_group_t block_group);
28 /*
29  * balloc.c contains the blocks allocation and deallocation routines
30  */
31 
32 /*
33  * Calculate block group number for a given block number
34  */
35 ext4_group_t ext4_get_group_number(struct super_block *sb,
36 				   ext4_fsblk_t block)
37 {
38 	ext4_group_t group;
39 
40 	if (test_opt2(sb, STD_GROUP_SIZE))
41 		group = (block -
42 			 le32_to_cpu(EXT4_SB(sb)->s_es->s_first_data_block)) >>
43 			(EXT4_BLOCK_SIZE_BITS(sb) + EXT4_CLUSTER_BITS(sb) + 3);
44 	else
45 		ext4_get_group_no_and_offset(sb, block, &group, NULL);
46 	return group;
47 }
48 
49 /*
50  * Calculate the block group number and offset into the block/cluster
51  * allocation bitmap, given a block number
52  */
53 void ext4_get_group_no_and_offset(struct super_block *sb, ext4_fsblk_t blocknr,
54 		ext4_group_t *blockgrpp, ext4_grpblk_t *offsetp)
55 {
56 	struct ext4_super_block *es = EXT4_SB(sb)->s_es;
57 	ext4_grpblk_t offset;
58 
59 	blocknr = blocknr - le32_to_cpu(es->s_first_data_block);
60 	offset = do_div(blocknr, EXT4_BLOCKS_PER_GROUP(sb)) >>
61 		EXT4_SB(sb)->s_cluster_bits;
62 	if (offsetp)
63 		*offsetp = offset;
64 	if (blockgrpp)
65 		*blockgrpp = blocknr;
66 
67 }
68 
69 /*
70  * Check whether the 'block' lives within the 'block_group'. Returns 1 if so
71  * and 0 otherwise.
72  */
73 static inline int ext4_block_in_group(struct super_block *sb,
74 				      ext4_fsblk_t block,
75 				      ext4_group_t block_group)
76 {
77 	ext4_group_t actual_group;
78 
79 	actual_group = ext4_get_group_number(sb, block);
80 	return (actual_group == block_group) ? 1 : 0;
81 }
82 
83 /* Return the number of clusters used for file system metadata; this
84  * represents the overhead needed by the file system.
85  */
86 static unsigned ext4_num_overhead_clusters(struct super_block *sb,
87 					   ext4_group_t block_group,
88 					   struct ext4_group_desc *gdp)
89 {
90 	unsigned num_clusters;
91 	int block_cluster = -1, inode_cluster = -1, itbl_cluster = -1, i, c;
92 	ext4_fsblk_t start = ext4_group_first_block_no(sb, block_group);
93 	ext4_fsblk_t itbl_blk;
94 	struct ext4_sb_info *sbi = EXT4_SB(sb);
95 
96 	/* This is the number of clusters used by the superblock,
97 	 * block group descriptors, and reserved block group
98 	 * descriptor blocks */
99 	num_clusters = ext4_num_base_meta_clusters(sb, block_group);
100 
101 	/*
102 	 * For the allocation bitmaps and inode table, we first need
103 	 * to check to see if the block is in the block group.  If it
104 	 * is, then check to see if the cluster is already accounted
105 	 * for in the clusters used for the base metadata cluster, or
106 	 * if we can increment the base metadata cluster to include
107 	 * that block.  Otherwise, we will have to track the cluster
108 	 * used for the allocation bitmap or inode table explicitly.
109 	 * Normally all of these blocks are contiguous, so the special
110 	 * case handling shouldn't be necessary except for *very*
111 	 * unusual file system layouts.
112 	 */
113 	if (ext4_block_in_group(sb, ext4_block_bitmap(sb, gdp), block_group)) {
114 		block_cluster = EXT4_B2C(sbi,
115 					 ext4_block_bitmap(sb, gdp) - start);
116 		if (block_cluster < num_clusters)
117 			block_cluster = -1;
118 		else if (block_cluster == num_clusters) {
119 			num_clusters++;
120 			block_cluster = -1;
121 		}
122 	}
123 
124 	if (ext4_block_in_group(sb, ext4_inode_bitmap(sb, gdp), block_group)) {
125 		inode_cluster = EXT4_B2C(sbi,
126 					 ext4_inode_bitmap(sb, gdp) - start);
127 		if (inode_cluster < num_clusters)
128 			inode_cluster = -1;
129 		else if (inode_cluster == num_clusters) {
130 			num_clusters++;
131 			inode_cluster = -1;
132 		}
133 	}
134 
135 	itbl_blk = ext4_inode_table(sb, gdp);
136 	for (i = 0; i < sbi->s_itb_per_group; i++) {
137 		if (ext4_block_in_group(sb, itbl_blk + i, block_group)) {
138 			c = EXT4_B2C(sbi, itbl_blk + i - start);
139 			if ((c < num_clusters) || (c == inode_cluster) ||
140 			    (c == block_cluster) || (c == itbl_cluster))
141 				continue;
142 			if (c == num_clusters) {
143 				num_clusters++;
144 				continue;
145 			}
146 			num_clusters++;
147 			itbl_cluster = c;
148 		}
149 	}
150 
151 	if (block_cluster != -1)
152 		num_clusters++;
153 	if (inode_cluster != -1)
154 		num_clusters++;
155 
156 	return num_clusters;
157 }
158 
159 static unsigned int num_clusters_in_group(struct super_block *sb,
160 					  ext4_group_t block_group)
161 {
162 	unsigned int blocks;
163 
164 	if (block_group == ext4_get_groups_count(sb) - 1) {
165 		/*
166 		 * Even though mke2fs always initializes the first and
167 		 * last group, just in case some other tool was used,
168 		 * we need to make sure we calculate the right free
169 		 * blocks.
170 		 */
171 		blocks = ext4_blocks_count(EXT4_SB(sb)->s_es) -
172 			ext4_group_first_block_no(sb, block_group);
173 	} else
174 		blocks = EXT4_BLOCKS_PER_GROUP(sb);
175 	return EXT4_NUM_B2C(EXT4_SB(sb), blocks);
176 }
177 
178 /* Initializes an uninitialized block bitmap */
179 static void ext4_init_block_bitmap(struct super_block *sb,
180 				   struct buffer_head *bh,
181 				   ext4_group_t block_group,
182 				   struct ext4_group_desc *gdp)
183 {
184 	unsigned int bit, bit_max;
185 	struct ext4_sb_info *sbi = EXT4_SB(sb);
186 	ext4_fsblk_t start, tmp;
187 	int flex_bg = 0;
188 	struct ext4_group_info *grp;
189 
190 	J_ASSERT_BH(bh, buffer_locked(bh));
191 
192 	/* If checksum is bad mark all blocks used to prevent allocation
193 	 * essentially implementing a per-group read-only flag. */
194 	if (!ext4_group_desc_csum_verify(sb, block_group, gdp)) {
195 		ext4_error(sb, "Checksum bad for group %u", block_group);
196 		grp = ext4_get_group_info(sb, block_group);
197 		set_bit(EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT, &grp->bb_state);
198 		set_bit(EXT4_GROUP_INFO_IBITMAP_CORRUPT_BIT, &grp->bb_state);
199 		return;
200 	}
201 	memset(bh->b_data, 0, sb->s_blocksize);
202 
203 	bit_max = ext4_num_base_meta_clusters(sb, block_group);
204 	for (bit = 0; bit < bit_max; bit++)
205 		ext4_set_bit(bit, bh->b_data);
206 
207 	start = ext4_group_first_block_no(sb, block_group);
208 
209 	if (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_FLEX_BG))
210 		flex_bg = 1;
211 
212 	/* Set bits for block and inode bitmaps, and inode table */
213 	tmp = ext4_block_bitmap(sb, gdp);
214 	if (!flex_bg || ext4_block_in_group(sb, tmp, block_group))
215 		ext4_set_bit(EXT4_B2C(sbi, tmp - start), bh->b_data);
216 
217 	tmp = ext4_inode_bitmap(sb, gdp);
218 	if (!flex_bg || ext4_block_in_group(sb, tmp, block_group))
219 		ext4_set_bit(EXT4_B2C(sbi, tmp - start), bh->b_data);
220 
221 	tmp = ext4_inode_table(sb, gdp);
222 	for (; tmp < ext4_inode_table(sb, gdp) +
223 		     sbi->s_itb_per_group; tmp++) {
224 		if (!flex_bg || ext4_block_in_group(sb, tmp, block_group))
225 			ext4_set_bit(EXT4_B2C(sbi, tmp - start), bh->b_data);
226 	}
227 
228 	/*
229 	 * Also if the number of blocks within the group is less than
230 	 * the blocksize * 8 ( which is the size of bitmap ), set rest
231 	 * of the block bitmap to 1
232 	 */
233 	ext4_mark_bitmap_end(num_clusters_in_group(sb, block_group),
234 			     sb->s_blocksize * 8, bh->b_data);
235 	ext4_block_bitmap_csum_set(sb, block_group, gdp, bh);
236 	ext4_group_desc_csum_set(sb, block_group, gdp);
237 }
238 
239 /* Return the number of free blocks in a block group.  It is used when
240  * the block bitmap is uninitialized, so we can't just count the bits
241  * in the bitmap. */
242 unsigned ext4_free_clusters_after_init(struct super_block *sb,
243 				       ext4_group_t block_group,
244 				       struct ext4_group_desc *gdp)
245 {
246 	return num_clusters_in_group(sb, block_group) -
247 		ext4_num_overhead_clusters(sb, block_group, gdp);
248 }
249 
250 /*
251  * The free blocks are managed by bitmaps.  A file system contains several
252  * blocks groups.  Each group contains 1 bitmap block for blocks, 1 bitmap
253  * block for inodes, N blocks for the inode table and data blocks.
254  *
255  * The file system contains group descriptors which are located after the
256  * super block.  Each descriptor contains the number of the bitmap block and
257  * the free blocks count in the block.  The descriptors are loaded in memory
258  * when a file system is mounted (see ext4_fill_super).
259  */
260 
261 /**
262  * ext4_get_group_desc() -- load group descriptor from disk
263  * @sb:			super block
264  * @block_group:	given block group
265  * @bh:			pointer to the buffer head to store the block
266  *			group descriptor
267  */
268 struct ext4_group_desc * ext4_get_group_desc(struct super_block *sb,
269 					     ext4_group_t block_group,
270 					     struct buffer_head **bh)
271 {
272 	unsigned int group_desc;
273 	unsigned int offset;
274 	ext4_group_t ngroups = ext4_get_groups_count(sb);
275 	struct ext4_group_desc *desc;
276 	struct ext4_sb_info *sbi = EXT4_SB(sb);
277 
278 	if (block_group >= ngroups) {
279 		ext4_error(sb, "block_group >= groups_count - block_group = %u,"
280 			   " groups_count = %u", block_group, ngroups);
281 
282 		return NULL;
283 	}
284 
285 	group_desc = block_group >> EXT4_DESC_PER_BLOCK_BITS(sb);
286 	offset = block_group & (EXT4_DESC_PER_BLOCK(sb) - 1);
287 	if (!sbi->s_group_desc[group_desc]) {
288 		ext4_error(sb, "Group descriptor not loaded - "
289 			   "block_group = %u, group_desc = %u, desc = %u",
290 			   block_group, group_desc, offset);
291 		return NULL;
292 	}
293 
294 	desc = (struct ext4_group_desc *)(
295 		(__u8 *)sbi->s_group_desc[group_desc]->b_data +
296 		offset * EXT4_DESC_SIZE(sb));
297 	if (bh)
298 		*bh = sbi->s_group_desc[group_desc];
299 	return desc;
300 }
301 
302 /*
303  * Return the block number which was discovered to be invalid, or 0 if
304  * the block bitmap is valid.
305  */
306 static ext4_fsblk_t ext4_valid_block_bitmap(struct super_block *sb,
307 					    struct ext4_group_desc *desc,
308 					    ext4_group_t block_group,
309 					    struct buffer_head *bh)
310 {
311 	struct ext4_sb_info *sbi = EXT4_SB(sb);
312 	ext4_grpblk_t offset;
313 	ext4_grpblk_t next_zero_bit;
314 	ext4_fsblk_t blk;
315 	ext4_fsblk_t group_first_block;
316 
317 	if (EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_FLEX_BG)) {
318 		/* with FLEX_BG, the inode/block bitmaps and itable
319 		 * blocks may not be in the group at all
320 		 * so the bitmap validation will be skipped for those groups
321 		 * or it has to also read the block group where the bitmaps
322 		 * are located to verify they are set.
323 		 */
324 		return 0;
325 	}
326 	group_first_block = ext4_group_first_block_no(sb, block_group);
327 
328 	/* check whether block bitmap block number is set */
329 	blk = ext4_block_bitmap(sb, desc);
330 	offset = blk - group_first_block;
331 	if (!ext4_test_bit(EXT4_B2C(sbi, offset), bh->b_data))
332 		/* bad block bitmap */
333 		return blk;
334 
335 	/* check whether the inode bitmap block number is set */
336 	blk = ext4_inode_bitmap(sb, desc);
337 	offset = blk - group_first_block;
338 	if (!ext4_test_bit(EXT4_B2C(sbi, offset), bh->b_data))
339 		/* bad block bitmap */
340 		return blk;
341 
342 	/* check whether the inode table block number is set */
343 	blk = ext4_inode_table(sb, desc);
344 	offset = blk - group_first_block;
345 	next_zero_bit = ext4_find_next_zero_bit(bh->b_data,
346 			EXT4_B2C(sbi, offset + EXT4_SB(sb)->s_itb_per_group),
347 			EXT4_B2C(sbi, offset));
348 	if (next_zero_bit <
349 	    EXT4_B2C(sbi, offset + EXT4_SB(sb)->s_itb_per_group))
350 		/* bad bitmap for inode tables */
351 		return blk;
352 	return 0;
353 }
354 
355 static void ext4_validate_block_bitmap(struct super_block *sb,
356 				       struct ext4_group_desc *desc,
357 				       ext4_group_t block_group,
358 				       struct buffer_head *bh)
359 {
360 	ext4_fsblk_t	blk;
361 	struct ext4_group_info *grp = ext4_get_group_info(sb, block_group);
362 
363 	if (buffer_verified(bh))
364 		return;
365 
366 	ext4_lock_group(sb, block_group);
367 	blk = ext4_valid_block_bitmap(sb, desc, block_group, bh);
368 	if (unlikely(blk != 0)) {
369 		ext4_unlock_group(sb, block_group);
370 		ext4_error(sb, "bg %u: block %llu: invalid block bitmap",
371 			   block_group, blk);
372 		set_bit(EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT, &grp->bb_state);
373 		return;
374 	}
375 	if (unlikely(!ext4_block_bitmap_csum_verify(sb, block_group,
376 			desc, bh))) {
377 		ext4_unlock_group(sb, block_group);
378 		ext4_error(sb, "bg %u: bad block bitmap checksum", block_group);
379 		set_bit(EXT4_GROUP_INFO_BBITMAP_CORRUPT_BIT, &grp->bb_state);
380 		return;
381 	}
382 	set_buffer_verified(bh);
383 	ext4_unlock_group(sb, block_group);
384 }
385 
386 /**
387  * ext4_read_block_bitmap_nowait()
388  * @sb:			super block
389  * @block_group:	given block group
390  *
391  * Read the bitmap for a given block_group,and validate the
392  * bits for block/inode/inode tables are set in the bitmaps
393  *
394  * Return buffer_head on success or NULL in case of failure.
395  */
396 struct buffer_head *
397 ext4_read_block_bitmap_nowait(struct super_block *sb, ext4_group_t block_group)
398 {
399 	struct ext4_group_desc *desc;
400 	struct buffer_head *bh;
401 	ext4_fsblk_t bitmap_blk;
402 
403 	desc = ext4_get_group_desc(sb, block_group, NULL);
404 	if (!desc)
405 		return NULL;
406 	bitmap_blk = ext4_block_bitmap(sb, desc);
407 	bh = sb_getblk(sb, bitmap_blk);
408 	if (unlikely(!bh)) {
409 		ext4_error(sb, "Cannot get buffer for block bitmap - "
410 			   "block_group = %u, block_bitmap = %llu",
411 			   block_group, bitmap_blk);
412 		return NULL;
413 	}
414 
415 	if (bitmap_uptodate(bh))
416 		goto verify;
417 
418 	lock_buffer(bh);
419 	if (bitmap_uptodate(bh)) {
420 		unlock_buffer(bh);
421 		goto verify;
422 	}
423 	ext4_lock_group(sb, block_group);
424 	if (desc->bg_flags & cpu_to_le16(EXT4_BG_BLOCK_UNINIT)) {
425 		ext4_init_block_bitmap(sb, bh, block_group, desc);
426 		set_bitmap_uptodate(bh);
427 		set_buffer_uptodate(bh);
428 		ext4_unlock_group(sb, block_group);
429 		unlock_buffer(bh);
430 		return bh;
431 	}
432 	ext4_unlock_group(sb, block_group);
433 	if (buffer_uptodate(bh)) {
434 		/*
435 		 * if not uninit if bh is uptodate,
436 		 * bitmap is also uptodate
437 		 */
438 		set_bitmap_uptodate(bh);
439 		unlock_buffer(bh);
440 		goto verify;
441 	}
442 	/*
443 	 * submit the buffer_head for reading
444 	 */
445 	set_buffer_new(bh);
446 	trace_ext4_read_block_bitmap_load(sb, block_group);
447 	bh->b_end_io = ext4_end_bitmap_read;
448 	get_bh(bh);
449 	submit_bh(READ | REQ_META | REQ_PRIO, bh);
450 	return bh;
451 verify:
452 	ext4_validate_block_bitmap(sb, desc, block_group, bh);
453 	if (buffer_verified(bh))
454 		return bh;
455 	put_bh(bh);
456 	return NULL;
457 }
458 
459 /* Returns 0 on success, 1 on error */
460 int ext4_wait_block_bitmap(struct super_block *sb, ext4_group_t block_group,
461 			   struct buffer_head *bh)
462 {
463 	struct ext4_group_desc *desc;
464 
465 	if (!buffer_new(bh))
466 		return 0;
467 	desc = ext4_get_group_desc(sb, block_group, NULL);
468 	if (!desc)
469 		return 1;
470 	wait_on_buffer(bh);
471 	if (!buffer_uptodate(bh)) {
472 		ext4_error(sb, "Cannot read block bitmap - "
473 			   "block_group = %u, block_bitmap = %llu",
474 			   block_group, (unsigned long long) bh->b_blocknr);
475 		return 1;
476 	}
477 	clear_buffer_new(bh);
478 	/* Panic or remount fs read-only if block bitmap is invalid */
479 	ext4_validate_block_bitmap(sb, desc, block_group, bh);
480 	/* ...but check for error just in case errors=continue. */
481 	return !buffer_verified(bh);
482 }
483 
484 struct buffer_head *
485 ext4_read_block_bitmap(struct super_block *sb, ext4_group_t block_group)
486 {
487 	struct buffer_head *bh;
488 
489 	bh = ext4_read_block_bitmap_nowait(sb, block_group);
490 	if (!bh)
491 		return NULL;
492 	if (ext4_wait_block_bitmap(sb, block_group, bh)) {
493 		put_bh(bh);
494 		return NULL;
495 	}
496 	return bh;
497 }
498 
499 /**
500  * ext4_has_free_clusters()
501  * @sbi:	in-core super block structure.
502  * @nclusters:	number of needed blocks
503  * @flags:	flags from ext4_mb_new_blocks()
504  *
505  * Check if filesystem has nclusters free & available for allocation.
506  * On success return 1, return 0 on failure.
507  */
508 static int ext4_has_free_clusters(struct ext4_sb_info *sbi,
509 				  s64 nclusters, unsigned int flags)
510 {
511 	s64 free_clusters, dirty_clusters, rsv, resv_clusters;
512 	struct percpu_counter *fcc = &sbi->s_freeclusters_counter;
513 	struct percpu_counter *dcc = &sbi->s_dirtyclusters_counter;
514 
515 	free_clusters  = percpu_counter_read_positive(fcc);
516 	dirty_clusters = percpu_counter_read_positive(dcc);
517 	resv_clusters = atomic64_read(&sbi->s_resv_clusters);
518 
519 	/*
520 	 * r_blocks_count should always be multiple of the cluster ratio so
521 	 * we are safe to do a plane bit shift only.
522 	 */
523 	rsv = (ext4_r_blocks_count(sbi->s_es) >> sbi->s_cluster_bits) +
524 	      resv_clusters;
525 
526 	if (free_clusters - (nclusters + rsv + dirty_clusters) <
527 					EXT4_FREECLUSTERS_WATERMARK) {
528 		free_clusters  = percpu_counter_sum_positive(fcc);
529 		dirty_clusters = percpu_counter_sum_positive(dcc);
530 	}
531 	/* Check whether we have space after accounting for current
532 	 * dirty clusters & root reserved clusters.
533 	 */
534 	if (free_clusters >= (rsv + nclusters + dirty_clusters))
535 		return 1;
536 
537 	/* Hm, nope.  Are (enough) root reserved clusters available? */
538 	if (uid_eq(sbi->s_resuid, current_fsuid()) ||
539 	    (!gid_eq(sbi->s_resgid, GLOBAL_ROOT_GID) && in_group_p(sbi->s_resgid)) ||
540 	    capable(CAP_SYS_RESOURCE) ||
541 	    (flags & EXT4_MB_USE_ROOT_BLOCKS)) {
542 
543 		if (free_clusters >= (nclusters + dirty_clusters +
544 				      resv_clusters))
545 			return 1;
546 	}
547 	/* No free blocks. Let's see if we can dip into reserved pool */
548 	if (flags & EXT4_MB_USE_RESERVED) {
549 		if (free_clusters >= (nclusters + dirty_clusters))
550 			return 1;
551 	}
552 
553 	return 0;
554 }
555 
556 int ext4_claim_free_clusters(struct ext4_sb_info *sbi,
557 			     s64 nclusters, unsigned int flags)
558 {
559 	if (ext4_has_free_clusters(sbi, nclusters, flags)) {
560 		percpu_counter_add(&sbi->s_dirtyclusters_counter, nclusters);
561 		return 0;
562 	} else
563 		return -ENOSPC;
564 }
565 
566 /**
567  * ext4_should_retry_alloc()
568  * @sb:			super block
569  * @retries		number of attemps has been made
570  *
571  * ext4_should_retry_alloc() is called when ENOSPC is returned, and if
572  * it is profitable to retry the operation, this function will wait
573  * for the current or committing transaction to complete, and then
574  * return TRUE.
575  *
576  * if the total number of retries exceed three times, return FALSE.
577  */
578 int ext4_should_retry_alloc(struct super_block *sb, int *retries)
579 {
580 	if (!ext4_has_free_clusters(EXT4_SB(sb), 1, 0) ||
581 	    (*retries)++ > 3 ||
582 	    !EXT4_SB(sb)->s_journal)
583 		return 0;
584 
585 	jbd_debug(1, "%s: retrying operation after ENOSPC\n", sb->s_id);
586 
587 	return jbd2_journal_force_commit_nested(EXT4_SB(sb)->s_journal);
588 }
589 
590 /*
591  * ext4_new_meta_blocks() -- allocate block for meta data (indexing) blocks
592  *
593  * @handle:             handle to this transaction
594  * @inode:              file inode
595  * @goal:               given target block(filesystem wide)
596  * @count:		pointer to total number of clusters needed
597  * @errp:               error code
598  *
599  * Return 1st allocated block number on success, *count stores total account
600  * error stores in errp pointer
601  */
602 ext4_fsblk_t ext4_new_meta_blocks(handle_t *handle, struct inode *inode,
603 				  ext4_fsblk_t goal, unsigned int flags,
604 				  unsigned long *count, int *errp)
605 {
606 	struct ext4_allocation_request ar;
607 	ext4_fsblk_t ret;
608 
609 	memset(&ar, 0, sizeof(ar));
610 	/* Fill with neighbour allocated blocks */
611 	ar.inode = inode;
612 	ar.goal = goal;
613 	ar.len = count ? *count : 1;
614 	ar.flags = flags;
615 
616 	ret = ext4_mb_new_blocks(handle, &ar, errp);
617 	if (count)
618 		*count = ar.len;
619 	/*
620 	 * Account for the allocated meta blocks.  We will never
621 	 * fail EDQUOT for metdata, but we do account for it.
622 	 */
623 	if (!(*errp) &&
624 	    ext4_test_inode_state(inode, EXT4_STATE_DELALLOC_RESERVED)) {
625 		spin_lock(&EXT4_I(inode)->i_block_reservation_lock);
626 		EXT4_I(inode)->i_allocated_meta_blocks += ar.len;
627 		spin_unlock(&EXT4_I(inode)->i_block_reservation_lock);
628 		dquot_alloc_block_nofail(inode,
629 				EXT4_C2B(EXT4_SB(inode->i_sb), ar.len));
630 	}
631 	return ret;
632 }
633 
634 /**
635  * ext4_count_free_clusters() -- count filesystem free clusters
636  * @sb:		superblock
637  *
638  * Adds up the number of free clusters from each block group.
639  */
640 ext4_fsblk_t ext4_count_free_clusters(struct super_block *sb)
641 {
642 	ext4_fsblk_t desc_count;
643 	struct ext4_group_desc *gdp;
644 	ext4_group_t i;
645 	ext4_group_t ngroups = ext4_get_groups_count(sb);
646 	struct ext4_group_info *grp;
647 #ifdef EXT4FS_DEBUG
648 	struct ext4_super_block *es;
649 	ext4_fsblk_t bitmap_count;
650 	unsigned int x;
651 	struct buffer_head *bitmap_bh = NULL;
652 
653 	es = EXT4_SB(sb)->s_es;
654 	desc_count = 0;
655 	bitmap_count = 0;
656 	gdp = NULL;
657 
658 	for (i = 0; i < ngroups; i++) {
659 		gdp = ext4_get_group_desc(sb, i, NULL);
660 		if (!gdp)
661 			continue;
662 		grp = NULL;
663 		if (EXT4_SB(sb)->s_group_info)
664 			grp = ext4_get_group_info(sb, i);
665 		if (!grp || !EXT4_MB_GRP_BBITMAP_CORRUPT(grp))
666 			desc_count += ext4_free_group_clusters(sb, gdp);
667 		brelse(bitmap_bh);
668 		bitmap_bh = ext4_read_block_bitmap(sb, i);
669 		if (bitmap_bh == NULL)
670 			continue;
671 
672 		x = ext4_count_free(bitmap_bh->b_data,
673 				    EXT4_CLUSTERS_PER_GROUP(sb) / 8);
674 		printk(KERN_DEBUG "group %u: stored = %d, counted = %u\n",
675 			i, ext4_free_group_clusters(sb, gdp), x);
676 		bitmap_count += x;
677 	}
678 	brelse(bitmap_bh);
679 	printk(KERN_DEBUG "ext4_count_free_clusters: stored = %llu"
680 	       ", computed = %llu, %llu\n",
681 	       EXT4_NUM_B2C(EXT4_SB(sb), ext4_free_blocks_count(es)),
682 	       desc_count, bitmap_count);
683 	return bitmap_count;
684 #else
685 	desc_count = 0;
686 	for (i = 0; i < ngroups; i++) {
687 		gdp = ext4_get_group_desc(sb, i, NULL);
688 		if (!gdp)
689 			continue;
690 		grp = NULL;
691 		if (EXT4_SB(sb)->s_group_info)
692 			grp = ext4_get_group_info(sb, i);
693 		if (!grp || !EXT4_MB_GRP_BBITMAP_CORRUPT(grp))
694 			desc_count += ext4_free_group_clusters(sb, gdp);
695 	}
696 
697 	return desc_count;
698 #endif
699 }
700 
701 static inline int test_root(ext4_group_t a, int b)
702 {
703 	while (1) {
704 		if (a < b)
705 			return 0;
706 		if (a == b)
707 			return 1;
708 		if ((a % b) != 0)
709 			return 0;
710 		a = a / b;
711 	}
712 }
713 
714 /**
715  *	ext4_bg_has_super - number of blocks used by the superblock in group
716  *	@sb: superblock for filesystem
717  *	@group: group number to check
718  *
719  *	Return the number of blocks used by the superblock (primary or backup)
720  *	in this group.  Currently this will be only 0 or 1.
721  */
722 int ext4_bg_has_super(struct super_block *sb, ext4_group_t group)
723 {
724 	struct ext4_super_block *es = EXT4_SB(sb)->s_es;
725 
726 	if (group == 0)
727 		return 1;
728 	if (EXT4_HAS_COMPAT_FEATURE(sb, EXT4_FEATURE_COMPAT_SPARSE_SUPER2)) {
729 		if (group == le32_to_cpu(es->s_backup_bgs[0]) ||
730 		    group == le32_to_cpu(es->s_backup_bgs[1]))
731 			return 1;
732 		return 0;
733 	}
734 	if ((group <= 1) || !EXT4_HAS_RO_COMPAT_FEATURE(sb,
735 					EXT4_FEATURE_RO_COMPAT_SPARSE_SUPER))
736 		return 1;
737 	if (!(group & 1))
738 		return 0;
739 	if (test_root(group, 3) || (test_root(group, 5)) ||
740 	    test_root(group, 7))
741 		return 1;
742 
743 	return 0;
744 }
745 
746 static unsigned long ext4_bg_num_gdb_meta(struct super_block *sb,
747 					ext4_group_t group)
748 {
749 	unsigned long metagroup = group / EXT4_DESC_PER_BLOCK(sb);
750 	ext4_group_t first = metagroup * EXT4_DESC_PER_BLOCK(sb);
751 	ext4_group_t last = first + EXT4_DESC_PER_BLOCK(sb) - 1;
752 
753 	if (group == first || group == first + 1 || group == last)
754 		return 1;
755 	return 0;
756 }
757 
758 static unsigned long ext4_bg_num_gdb_nometa(struct super_block *sb,
759 					ext4_group_t group)
760 {
761 	if (!ext4_bg_has_super(sb, group))
762 		return 0;
763 
764 	if (EXT4_HAS_INCOMPAT_FEATURE(sb,EXT4_FEATURE_INCOMPAT_META_BG))
765 		return le32_to_cpu(EXT4_SB(sb)->s_es->s_first_meta_bg);
766 	else
767 		return EXT4_SB(sb)->s_gdb_count;
768 }
769 
770 /**
771  *	ext4_bg_num_gdb - number of blocks used by the group table in group
772  *	@sb: superblock for filesystem
773  *	@group: group number to check
774  *
775  *	Return the number of blocks used by the group descriptor table
776  *	(primary or backup) in this group.  In the future there may be a
777  *	different number of descriptor blocks in each group.
778  */
779 unsigned long ext4_bg_num_gdb(struct super_block *sb, ext4_group_t group)
780 {
781 	unsigned long first_meta_bg =
782 			le32_to_cpu(EXT4_SB(sb)->s_es->s_first_meta_bg);
783 	unsigned long metagroup = group / EXT4_DESC_PER_BLOCK(sb);
784 
785 	if (!EXT4_HAS_INCOMPAT_FEATURE(sb,EXT4_FEATURE_INCOMPAT_META_BG) ||
786 			metagroup < first_meta_bg)
787 		return ext4_bg_num_gdb_nometa(sb, group);
788 
789 	return ext4_bg_num_gdb_meta(sb,group);
790 
791 }
792 
793 /*
794  * This function returns the number of file system metadata clusters at
795  * the beginning of a block group, including the reserved gdt blocks.
796  */
797 static unsigned ext4_num_base_meta_clusters(struct super_block *sb,
798 				     ext4_group_t block_group)
799 {
800 	struct ext4_sb_info *sbi = EXT4_SB(sb);
801 	unsigned num;
802 
803 	/* Check for superblock and gdt backups in this group */
804 	num = ext4_bg_has_super(sb, block_group);
805 
806 	if (!EXT4_HAS_INCOMPAT_FEATURE(sb, EXT4_FEATURE_INCOMPAT_META_BG) ||
807 	    block_group < le32_to_cpu(sbi->s_es->s_first_meta_bg) *
808 			  sbi->s_desc_per_block) {
809 		if (num) {
810 			num += ext4_bg_num_gdb(sb, block_group);
811 			num += le16_to_cpu(sbi->s_es->s_reserved_gdt_blocks);
812 		}
813 	} else { /* For META_BG_BLOCK_GROUPS */
814 		num += ext4_bg_num_gdb(sb, block_group);
815 	}
816 	return EXT4_NUM_B2C(sbi, num);
817 }
818 /**
819  *	ext4_inode_to_goal_block - return a hint for block allocation
820  *	@inode: inode for block allocation
821  *
822  *	Return the ideal location to start allocating blocks for a
823  *	newly created inode.
824  */
825 ext4_fsblk_t ext4_inode_to_goal_block(struct inode *inode)
826 {
827 	struct ext4_inode_info *ei = EXT4_I(inode);
828 	ext4_group_t block_group;
829 	ext4_grpblk_t colour;
830 	int flex_size = ext4_flex_bg_size(EXT4_SB(inode->i_sb));
831 	ext4_fsblk_t bg_start;
832 	ext4_fsblk_t last_block;
833 
834 	block_group = ei->i_block_group;
835 	if (flex_size >= EXT4_FLEX_SIZE_DIR_ALLOC_SCHEME) {
836 		/*
837 		 * If there are at least EXT4_FLEX_SIZE_DIR_ALLOC_SCHEME
838 		 * block groups per flexgroup, reserve the first block
839 		 * group for directories and special files.  Regular
840 		 * files will start at the second block group.  This
841 		 * tends to speed up directory access and improves
842 		 * fsck times.
843 		 */
844 		block_group &= ~(flex_size-1);
845 		if (S_ISREG(inode->i_mode))
846 			block_group++;
847 	}
848 	bg_start = ext4_group_first_block_no(inode->i_sb, block_group);
849 	last_block = ext4_blocks_count(EXT4_SB(inode->i_sb)->s_es) - 1;
850 
851 	/*
852 	 * If we are doing delayed allocation, we don't need take
853 	 * colour into account.
854 	 */
855 	if (test_opt(inode->i_sb, DELALLOC))
856 		return bg_start;
857 
858 	if (bg_start + EXT4_BLOCKS_PER_GROUP(inode->i_sb) <= last_block)
859 		colour = (current->pid % 16) *
860 			(EXT4_BLOCKS_PER_GROUP(inode->i_sb) / 16);
861 	else
862 		colour = (current->pid % 16) * ((last_block - bg_start) / 16);
863 	return bg_start + colour;
864 }
865 
866