2 * filefrag.c -- report if a particular file is fragmented
4 * Copyright 2003 by Theodore Ts'o.
7 * This file may be redistributed under the terms of the GNU Public
19 fputs("This program is only supported on Linux!\n", stderr);
23 #ifndef _LARGEFILE_SOURCE
24 #define _LARGEFILE_SOURCE
26 #ifndef _LARGEFILE64_SOURCE
27 #define _LARGEFILE64_SOURCE
44 #include <sys/types.h>
47 #include <sys/ioctl.h>
48 #ifdef HAVE_LINUX_FD_H
51 #include <ext2fs/ext2fs.h>
52 #include <ext2fs/ext2_types.h>
53 #include <ext2fs/fiemap.h>
56 unsigned int blocksize; /* Use specified blocksize (default 1kB) */
57 int sync_file = 0; /* fsync file before getting the mapping */
58 int precache_file = 0; /* precache the file before getting the mapping */
59 int xattr_map = 0; /* get xattr mapping */
60 int force_bmap; /* force use of FIBMAP instead of FIEMAP */
61 int force_extent; /* print output in extent format always */
62 int use_extent_cache; /* Use extent cache */
63 int logical_width = 8;
64 int physical_width = 10;
65 const char *ext_fmt = "%4d: %*llu..%*llu: %*llu..%*llu: %6llu: %s\n";
66 const char *hex_fmt = "%4d: %*llx..%*llx: %*llx..%*llx: %6llx: %s\n";
68 #define FILEFRAG_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_XATTR)
70 #define FIBMAP _IO(0x00, 1) /* bmap access */
71 #define FIGETBSZ _IO(0x00, 2) /* get the block size used for bmap */
73 #define LUSTRE_SUPER_MAGIC 0x0BD00BD0
75 #define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
76 #define EXT3_IOC_GETFLAGS _IOR('f', 1, long)
78 static int ulong_log2(unsigned long arg)
90 static int ulong_log10(unsigned long long arg)
102 static unsigned int div_ceil(unsigned int a, unsigned int b)
106 return ((a - 1) / b) + 1;
109 static int get_bmap(int fd, unsigned long block, unsigned long *phy_blk)
115 ret = ioctl(fd, FIBMAP, &b); /* FIBMAP takes pointer to integer */
123 static void print_extent_header(void)
125 printf(" ext: %*s %*s length: %*s flags:\n",
126 logical_width * 2 + 3,
128 physical_width * 2 + 3, "physical_offset:",
133 static void print_flag(__u32 *flags, __u32 mask, char *buf, const char *name)
135 if ((*flags & mask) == 0)
142 static void print_extent_info(struct fiemap_extent *fm_extent, int cur_ex,
143 unsigned long long expected, int blk_shift,
144 ext2fs_struct_stat *st)
146 unsigned long long physical_blk;
147 unsigned long long logical_blk;
148 unsigned long long ext_len;
149 unsigned long long ext_blks;
150 unsigned long long ext_blks_phys;
151 __u32 fe_flags, mask;
152 char flags[256] = "";
154 /* For inline data all offsets should be in bytes, not blocks */
155 if (fm_extent->fe_flags & FIEMAP_EXTENT_DATA_INLINE)
158 ext_len = fm_extent->fe_length >> blk_shift;
159 ext_blks = (fm_extent->fe_length - 1) >> blk_shift;
160 logical_blk = fm_extent->fe_logical >> blk_shift;
161 if (fm_extent->fe_flags & FIEMAP_EXTENT_UNKNOWN) {
164 physical_blk = fm_extent->fe_physical >> blk_shift;
167 fe_flags = fm_extent->fe_flags;
169 !(fe_flags & FIEMAP_EXTENT_UNKNOWN) &&
170 !(fe_flags & EXT4_FIEMAP_EXTENT_HOLE))
171 sprintf(flags, ext_fmt == hex_fmt ? "%*llx: " : "%*llu: ",
172 physical_width, expected >> blk_shift);
174 sprintf(flags, "%.*s ", physical_width, " ");
176 print_flag(&fe_flags, FIEMAP_EXTENT_LAST, flags, "last,");
177 print_flag(&fe_flags, FIEMAP_EXTENT_UNKNOWN, flags, "unknown_loc,");
178 print_flag(&fe_flags, FIEMAP_EXTENT_DELALLOC, flags, "delalloc,");
179 print_flag(&fe_flags, FIEMAP_EXTENT_ENCODED, flags, "encoded,");
180 print_flag(&fe_flags, FIEMAP_EXTENT_DATA_ENCRYPTED, flags,"encrypted,");
181 print_flag(&fe_flags, FIEMAP_EXTENT_NOT_ALIGNED, flags, "not_aligned,");
182 print_flag(&fe_flags, FIEMAP_EXTENT_DATA_INLINE, flags, "inline,");
183 print_flag(&fe_flags, FIEMAP_EXTENT_DATA_TAIL, flags, "tail_packed,");
184 print_flag(&fe_flags, FIEMAP_EXTENT_UNWRITTEN, flags, "unwritten,");
185 print_flag(&fe_flags, FIEMAP_EXTENT_MERGED, flags, "merged,");
186 print_flag(&fe_flags, FIEMAP_EXTENT_SHARED, flags, "shared,");
187 print_flag(&fe_flags, EXT4_FIEMAP_EXTENT_HOLE, flags, "hole,");
188 /* print any unknown flags as hex values */
189 for (mask = 1; fe_flags != 0 && mask != 0; mask <<= 1) {
190 char hex[sizeof(mask) * 2 + 4]; /* 2 chars/byte + 0x, + NUL */
192 if ((fe_flags & mask) == 0)
194 sprintf(hex, "%#04x,", mask);
195 print_flag(&fe_flags, mask, flags, hex);
198 if (fm_extent->fe_logical + fm_extent->fe_length >=
199 (unsigned long long) st->st_size)
200 strcat(flags, "eof,");
202 /* Remove trailing comma, if any */
203 if (flags[0] != '\0')
204 flags[strnlen(flags, sizeof(flags)) - 1] = '\0';
206 if ((fm_extent->fe_flags & FIEMAP_EXTENT_UNKNOWN) ||
207 (fm_extent->fe_flags & EXT4_FIEMAP_EXTENT_HOLE)) {
211 ext_blks_phys = ext_blks;
213 printf(ext_fmt, cur_ex, logical_width, logical_blk,
214 logical_width, logical_blk + ext_blks,
215 physical_width, physical_blk,
216 physical_width, physical_blk + ext_blks_phys,
220 static int filefrag_fiemap(int fd, int blk_shift, int *num_extents,
221 ext2fs_struct_stat *st)
223 __u64 buf[2048]; /* __u64 for proper field alignment */
224 struct fiemap *fiemap = (struct fiemap *)buf;
225 struct fiemap_extent *fm_ext = &fiemap->fm_extents[0];
226 struct fiemap_extent fm_last;
227 int count = (sizeof(buf) - sizeof(*fiemap)) /
228 sizeof(struct fiemap_extent);
229 unsigned long long expected = 0;
230 unsigned long long expected_dense = 0;
231 unsigned long flags = 0;
233 unsigned long cmd = FS_IOC_FIEMAP;
234 int fiemap_header_printed = 0;
235 int tot_extents = 0, n = 0;
239 memset(fiemap, 0, sizeof(struct fiemap));
240 memset(&fm_last, 0, sizeof(fm_last));
243 flags |= FIEMAP_FLAG_SYNC;
246 flags |= FIEMAP_FLAG_CACHE;
249 flags |= FIEMAP_FLAG_XATTR;
251 if (use_extent_cache)
252 cmd = EXT4_IOC_GET_ES_CACHE;
255 fiemap->fm_length = ~0ULL;
256 fiemap->fm_flags = flags;
257 fiemap->fm_extent_count = count;
258 rc = ioctl(fd, cmd, (unsigned long) fiemap);
260 static int fiemap_incompat_printed;
263 if (rc == -EBADR && !fiemap_incompat_printed) {
264 fprintf(stderr, "FIEMAP failed with unknown "
267 fiemap_incompat_printed = 1;
272 /* If 0 extents are returned, then more ioctls are not needed */
273 if (fiemap->fm_mapped_extents == 0)
276 if (verbose && !fiemap_header_printed) {
277 print_extent_header();
278 fiemap_header_printed = 1;
281 for (i = 0; i < fiemap->fm_mapped_extents; i++) {
282 expected_dense = fm_last.fe_physical +
284 expected = fm_last.fe_physical +
285 fm_ext[i].fe_logical - fm_last.fe_logical;
286 if (fm_ext[i].fe_logical != 0 &&
287 fm_ext[i].fe_physical != expected &&
288 fm_ext[i].fe_physical != expected_dense) {
296 print_extent_info(&fm_ext[i], n, expected,
298 if (fm_ext[i].fe_flags & FIEMAP_EXTENT_LAST)
304 fiemap->fm_start = (fm_ext[i - 1].fe_logical +
305 fm_ext[i - 1].fe_length);
308 *num_extents = tot_extents;
313 #define EXT2_DIRECT 12
315 static int filefrag_fibmap(int fd, int blk_shift, int *num_extents,
316 ext2fs_struct_stat *st,
317 unsigned long numblocks, int is_ext2)
319 struct fiemap_extent fm_ext, fm_last;
320 unsigned long i, last_block;
321 unsigned long long logical, expected = 0;
322 /* Blocks per indirect block */
323 const long bpib = st->st_blksize / 4;
326 memset(&fm_ext, 0, sizeof(fm_ext));
327 memset(&fm_last, 0, sizeof(fm_last));
329 fm_ext.fe_flags = FIEMAP_EXTENT_MERGED;
332 if (sync_file && fsync(fd) != 0)
335 for (i = 0, logical = 0, *num_extents = 0, count = last_block = 0;
337 i++, logical += st->st_blksize) {
338 unsigned long block = 0;
341 if (is_ext2 && last_block) {
342 if (((i - EXT2_DIRECT) % bpib) == 0)
344 if (((i - EXT2_DIRECT - bpib) % (bpib * bpib)) == 0)
346 if (((i - EXT2_DIRECT - bpib - bpib * bpib) %
347 (((unsigned long long)bpib) * bpib * bpib)) == 0)
350 rc = get_bmap(fd, i, &block);
356 if (*num_extents == 0 || block != last_block + 1 ||
357 fm_ext.fe_logical + fm_ext.fe_length != logical) {
359 * This is the start of a new extent; figure out where
360 * we expected it to be and report the extent.
362 if (*num_extents != 0 && fm_last.fe_length) {
363 expected = fm_last.fe_physical +
364 (fm_ext.fe_logical - fm_last.fe_logical);
365 if (expected == fm_ext.fe_physical)
368 if (force_extent && *num_extents == 0)
369 print_extent_header();
370 if (force_extent && *num_extents != 0) {
371 print_extent_info(&fm_ext, *num_extents - 1,
372 expected, blk_shift, st);
374 if (verbose && expected != 0) {
375 printf("Discontinuity: Block %llu is at %llu "
377 fm_ext.fe_logical / st->st_blksize,
378 fm_ext.fe_physical / st->st_blksize,
379 expected / st->st_blksize);
381 /* create the new extent */
384 fm_ext.fe_physical = block * st->st_blksize;
385 fm_ext.fe_logical = logical;
386 fm_ext.fe_length = 0;
388 fm_ext.fe_length += st->st_blksize;
391 if (force_extent && *num_extents != 0) {
392 if (fm_last.fe_length) {
393 expected = fm_last.fe_physical +
394 (fm_ext.fe_logical - fm_last.fe_logical);
395 if (expected == fm_ext.fe_physical)
398 print_extent_info(&fm_ext, *num_extents - 1, expected,
405 static int frag_report(const char *filename)
407 static struct statfs fsinfo;
408 static unsigned int blksize;
409 ext2fs_struct_stat st;
412 unsigned long long numblocks;
413 int data_blocks_per_cyl = 1;
414 int num_extents = 1, expected = ~0;
416 static dev_t last_device;
420 #if defined(HAVE_OPEN64) && !defined(__OSX_AVAILABLE_BUT_DEPRECATED)
421 fd = open64(filename, O_RDONLY);
423 fd = open(filename, O_RDONLY);
431 #if defined(HAVE_FSTAT64) && !defined(__OSX_AVAILABLE_BUT_DEPRECATED)
432 if (fstat64(fd, &st) < 0) {
434 if (fstat(fd, &st) < 0) {
441 if (last_device != st.st_dev) {
442 if (fstatfs(fd, &fsinfo) < 0) {
447 if (ioctl(fd, FIGETBSZ, &blksize) < 0)
448 blksize = fsinfo.f_bsize;
450 printf("Filesystem type is: %lx\n",
451 (unsigned long)fsinfo.f_type);
453 st.st_blksize = blksize;
454 if (fsinfo.f_type == 0xef51 || fsinfo.f_type == 0xef52 ||
455 fsinfo.f_type == 0xef53) {
458 if (ioctl(fd, EXT3_IOC_GETFLAGS, &flags) == 0 &&
459 !(flags & EXT4_EXTENTS_FL))
464 long cylgroups = div_ceil(fsinfo.f_blocks, blksize * 8);
466 if (verbose && last_device != st.st_dev)
467 printf("Filesystem cylinder groups approximately %ld\n",
470 data_blocks_per_cyl = blksize * 8 -
471 (fsinfo.f_files / 8 / cylgroups) - 3;
473 last_device = st.st_dev;
475 width = ulong_log10(fsinfo.f_blocks);
476 if (width > physical_width)
477 physical_width = width;
479 numblocks = (st.st_size + blksize - 1) / blksize;
481 blk_shift = ulong_log2(blocksize);
483 blk_shift = ulong_log2(blksize);
485 if (use_extent_cache)
488 width = ulong_log10(numblocks);
489 if (width > logical_width)
490 logical_width = width;
494 printf("File size of %s is %llu (%llu block%s of %d bytes)",
495 filename, (unsigned long long)st.st_size,
496 numblocks * blksize >> blk_shift,
497 numblocks == 1 ? "" : "s", 1 << blk_shift);
498 if (use_extent_cache &&
499 ioctl(fd, EXT4_IOC_GETSTATE, &state) == 0 &&
500 (state & EXT4_STATE_FLAG_EXT_PRECACHED))
501 fputs(" -- pre-cached", stdout);
506 rc = filefrag_fiemap(fd, blk_shift, &num_extents, &st);
509 (use_extent_cache || precache_file || xattr_map)) {
511 fprintf(stderr, "%s: %s: %s\n ",
514 "EXT4_IOC_GET_ES_CACHE" :
515 "FS_IOC_FIEMAP", strerror(-rc));
520 if (force_bmap || rc < 0) { /* FIEMAP failed, try FIBMAP instead */
521 expected = filefrag_fibmap(fd, blk_shift, &num_extents,
522 &st, numblocks, is_ext2);
524 if (expected == -EINVAL || expected == -ENOTTY) {
525 fprintf(stderr, "%s: FIBMAP unsupported\n",
527 } else if (expected == -EPERM) {
529 "%s: FIBMAP requires root privileges\n",
532 fprintf(stderr, "%s: FIBMAP error: %s",
533 filename, strerror(expected));
540 expected = expected / data_blocks_per_cyl + 1;
543 if (num_extents == 1)
544 printf("%s: 1 extent found", filename);
546 printf("%s: %d extents found", filename, num_extents);
547 /* count, and thus expected, only set for indirect FIBMAP'd files */
548 if (is_ext2 && expected && expected < num_extents)
549 printf(", perfection would be %d extent%s\n", expected,
550 (expected > 1) ? "s" : "");
559 static void usage(const char *progname)
561 fprintf(stderr, "Usage: %s [-b{blocksize}[KMG]] [-BeEksvxX] file ...\n",
566 int main(int argc, char**argv)
571 while ((c = getopt(argc, argv, "Bb::eEkPsvxX")) != EOF) {
581 val = strtoul(optarg, &end, 0);
583 #if __GNUC_PREREQ (7, 0)
584 #pragma GCC diagnostic push
585 #pragma GCC diagnostic ignored "-Wimplicit-fallthrough"
603 #if __GNUC_PREREQ (7, 0)
604 #pragma GCC diagnostic pop
607 /* Specifying too large a blocksize will just
608 * shift all extents down to zero length. Even
609 * 1GB is questionable, but caveat emptor. */
610 if (val > 1024 * 1024 * 1024) {
612 "%s: blocksize %lu over 1GB\n",
617 } else { /* Allow -b without argument for compat. Remove
618 * this eventually so "-b {blocksize}" works */
619 fprintf(stderr, "%s: -b needs a blocksize "
620 "option, assuming 1024-byte blocks.\n",
660 for (cpp = argv + optind; *cpp != NULL; cpp++) {
661 int rc2 = frag_report(*cpp);
663 if (rc2 < 0 && rc == 0)