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>
54 #include "../version.h"
57 unsigned int blocksize; /* Use specified blocksize (default 1kB) */
58 int sync_file = 0; /* fsync file before getting the mapping */
59 int precache_file = 0; /* precache the file before getting the mapping */
60 int xattr_map = 0; /* get xattr mapping */
61 int force_bmap; /* force use of FIBMAP instead of FIEMAP */
62 int force_extent; /* print output in extent format always */
63 int use_extent_cache; /* Use extent cache */
64 int device_offset; /* extents report device-relative offsets */
65 int logical_width = 8;
66 int physical_width = 10;
67 const char *ext_fmt = "%4d: %*llu..%*llu: %*llu..%*llu: %6llu: %s\n";
68 const char *hex_fmt = "%4d: %*llx..%*llx: %*llx..%*llx: %6llx: %s\n";
70 #define FILEFRAG_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_XATTR |\
71 FIEMAP_FLAG_DEVICE_ORDER)
73 #define FIBMAP _IO(0x00, 1) /* bmap access */
74 #define FIGETBSZ _IO(0x00, 2) /* get the block size used for bmap */
76 #define LUSTRE_SUPER_MAGIC 0x0BD00BD0
78 #define EXT4_EXTENTS_FL 0x00080000 /* Inode uses extents */
79 #define EXT3_IOC_GETFLAGS _IOR('f', 1, long)
81 static int ulong_log2(unsigned long arg)
93 static int ulong_log10(unsigned long long arg)
105 static unsigned int div_ceil(unsigned int a, unsigned int b)
109 return ((a - 1) / b) + 1;
112 static int get_bmap(int fd, unsigned long block, unsigned long *phy_blk)
118 ret = ioctl(fd, FIBMAP, &b); /* FIBMAP takes pointer to integer */
126 static void print_extent_header(void)
128 printf(" ext: %*s %*s length: %*s flags:\n",
129 logical_width * 2 + 3,
130 device_offset ? "device_logical:" : "logical_offset:",
131 physical_width * 2 + 3, "physical_offset:",
132 device_offset ? 5 : physical_width + 1,
133 device_offset ? " dev:" : "expected:");
136 static void print_flag(__u32 *flags, __u32 mask, char *buf, const char *name)
138 char hex[sizeof(mask) * 2 + 4]; /* 2 chars/byte + 0x, + NUL */
140 if ((*flags & mask) == 0)
144 sprintf(hex, "%#04x,", mask);
151 static void print_flags(__u32 fe_flags, char *flags, int len, int print_unknown)
155 print_flag(&fe_flags, FIEMAP_EXTENT_LAST, flags, "last,");
156 print_flag(&fe_flags, FIEMAP_EXTENT_UNKNOWN, flags, "unknown_loc,");
157 print_flag(&fe_flags, FIEMAP_EXTENT_DELALLOC, flags, "delalloc,");
158 print_flag(&fe_flags, FIEMAP_EXTENT_ENCODED, flags, "encoded,");
159 print_flag(&fe_flags, FIEMAP_EXTENT_DATA_ENCRYPTED, flags,"encrypted,");
160 print_flag(&fe_flags, FIEMAP_EXTENT_NOT_ALIGNED, flags, "not_aligned,");
161 print_flag(&fe_flags, FIEMAP_EXTENT_DATA_INLINE, flags, "inline,");
162 print_flag(&fe_flags, FIEMAP_EXTENT_DATA_TAIL, flags, "tail_packed,");
163 print_flag(&fe_flags, FIEMAP_EXTENT_UNWRITTEN, flags, "unwritten,");
164 print_flag(&fe_flags, FIEMAP_EXTENT_MERGED, flags, "merged,");
165 print_flag(&fe_flags, FIEMAP_EXTENT_SHARED, flags, "shared,");
166 print_flag(&fe_flags, EXT4_FIEMAP_EXTENT_HOLE, flags, "hole,");
168 print_flag(&fe_flags, FIEMAP_EXTENT_NET, flags, "net,");
173 /* print any unknown flags as hex values */
174 for (mask = 1; fe_flags != 0 && mask != 0; mask <<= 1)
175 print_flag(&fe_flags, mask, flags, NULL);
177 /* Remove trailing comma, if any */
179 flags[strnlen(flags, len) - 1] = '\0';
183 static void print_extent_info(struct fiemap_extent *fm_extent, int cur_ex,
184 unsigned long long expected, int blk_shift,
185 ext2fs_struct_stat *st)
187 unsigned long long physical_blk;
188 unsigned long long logical_blk;
189 unsigned long long ext_len;
190 unsigned long long ext_blks;
191 unsigned long long ext_blks_phys;
192 char flags[256] = "";
194 /* For inline data all offsets should be in bytes, not blocks */
195 if (fm_extent->fe_flags & FIEMAP_EXTENT_DATA_INLINE)
198 ext_len = fm_extent->fe_length >> blk_shift;
199 ext_blks = (fm_extent->fe_length - 1) >> blk_shift;
200 logical_blk = fm_extent->fe_logical >> blk_shift;
201 if (fm_extent->fe_flags & FIEMAP_EXTENT_UNKNOWN) {
204 physical_blk = fm_extent->fe_physical >> blk_shift;
208 sprintf(flags, "%04x: ", fm_extent->fe_device & 0xffff);
210 !(fm_extent->fe_flags & FIEMAP_EXTENT_UNKNOWN) &&
211 !(fm_extent->fe_flags & EXT4_FIEMAP_EXTENT_HOLE))
212 sprintf(flags, ext_fmt == hex_fmt ? "%*llx: " : "%*llu: ",
213 physical_width, expected >> blk_shift);
215 print_flags(fm_extent->fe_flags, flags, sizeof(flags), 1);
217 if (fm_extent->fe_logical + fm_extent->fe_length >=
218 (unsigned long long)st->st_size)
219 strcat(flags, flags[0] ? ",eof" : "eof");
221 if ((fm_extent->fe_flags & FIEMAP_EXTENT_UNKNOWN) ||
222 (fm_extent->fe_flags & EXT4_FIEMAP_EXTENT_HOLE)) {
226 ext_blks_phys = ext_blks;
228 printf(ext_fmt, cur_ex, logical_width, logical_blk,
229 logical_width, logical_blk + ext_blks,
230 physical_width, physical_blk,
231 physical_width, physical_blk + ext_blks_phys,
235 static int filefrag_fiemap(int fd, int blk_shift, int *num_extents,
236 ext2fs_struct_stat *st)
238 __u64 buf[2048]; /* __u64 for proper field alignment */
239 struct fiemap *fiemap = (struct fiemap *)buf;
240 struct fiemap_extent *fm_ext = &fiemap->fm_extents[0];
241 struct fiemap_extent fm_last;
242 int count = (sizeof(buf) - sizeof(*fiemap)) /
243 sizeof(struct fiemap_extent);
244 unsigned long long expected = 0;
245 unsigned long long expected_dense = 0;
246 unsigned long flags = 0;
248 unsigned long cmd = FS_IOC_FIEMAP;
249 int fiemap_header_printed = 0;
250 int tot_extents = 0, n = 0;
251 int previous_device = -1;
255 memset(fiemap, 0, sizeof(struct fiemap));
256 memset(&fm_last, 0, sizeof(fm_last));
259 flags |= FIEMAP_FLAG_SYNC;
262 flags |= FIEMAP_FLAG_CACHE;
265 flags |= FIEMAP_FLAG_XATTR;
267 if (use_extent_cache)
268 cmd = EXT4_IOC_GET_ES_CACHE;
271 flags |= FIEMAP_FLAG_DEVICE_ORDER;
272 memset(fm_ext, 0, sizeof(struct fiemap_extent));
275 retry_wo_device_order:
277 fiemap->fm_length = ~0ULL;
278 fiemap->fm_flags = flags;
279 fiemap->fm_extent_count = count;
280 rc = ioctl(fd, cmd, (unsigned long) fiemap);
282 static int fiemap_incompat_printed;
285 if (rc == -EBADR && !fiemap_incompat_printed) {
286 fprintf(stderr, "FIEMAP failed with unknown "
289 fiemap_incompat_printed = 1;
290 } else if (rc == EBADR && (fiemap->fm_flags &
291 FIEMAP_FLAG_DEVICE_ORDER)) {
292 flags &= ~FIEMAP_FLAG_DEVICE_ORDER;
293 goto retry_wo_device_order;
298 /* If 0 extents are returned, then more ioctls are not needed */
299 if (fiemap->fm_mapped_extents == 0)
302 if (verbose && !fiemap_header_printed) {
303 print_extent_header();
304 fiemap_header_printed = 1;
307 for (i = 0; i < fiemap->fm_mapped_extents; i++) {
308 expected_dense = fm_last.fe_physical +
310 expected = fm_last.fe_physical +
311 fm_ext[i].fe_logical - fm_last.fe_logical;
312 if ((fm_ext[i].fe_logical != 0 &&
313 fm_ext[i].fe_physical != expected &&
314 fm_ext[i].fe_physical != expected_dense) ||
315 ((fm_ext[i].fe_device & 0xffff) != previous_device)) {
323 print_extent_info(&fm_ext[i], n, expected,
325 if (fm_ext[i].fe_flags & FIEMAP_EXTENT_LAST)
329 previous_device = fm_ext[i].fe_device & 0xffff;
332 /* For DEVICE_ORDER mappings, if EXTENT_LAST not yet found then
333 * fm_start needs to be the same as it was for earlier ioctl.
334 * The first extent is used to pass the end offset and device
335 * of the last FIEMAP call. Otherwise, we ask for extents
336 * starting from where the last mapping ended. */
337 if (flags & FIEMAP_FLAG_DEVICE_ORDER) {
338 fm_ext[0].fe_logical = fm_ext[i - 1].fe_logical +
339 fm_ext[i - 1].fe_length;
340 fm_ext[0].fe_device = fm_ext[i - 1].fe_device;
341 fiemap->fm_start = 0;
343 fiemap->fm_start = fm_ext[i - 1].fe_logical +
344 fm_ext[i - 1].fe_length;
348 *num_extents = tot_extents;
353 #define EXT2_DIRECT 12
355 static int filefrag_fibmap(int fd, int blk_shift, int *num_extents,
356 ext2fs_struct_stat *st,
357 unsigned long numblocks, int is_ext2)
359 struct fiemap_extent fm_ext, fm_last;
360 unsigned long i, last_block;
361 unsigned long long logical, expected = 0;
362 /* Blocks per indirect block */
363 const long bpib = st->st_blksize / 4;
366 memset(&fm_ext, 0, sizeof(fm_ext));
367 memset(&fm_last, 0, sizeof(fm_last));
369 fm_ext.fe_device = st->st_dev;
370 fm_ext.fe_flags = FIEMAP_EXTENT_MERGED;
373 if (sync_file && fsync(fd) != 0)
376 for (i = 0, logical = 0, *num_extents = 0, count = last_block = 0;
378 i++, logical += st->st_blksize) {
379 unsigned long block = 0;
382 if (is_ext2 && last_block) {
383 if (((i - EXT2_DIRECT) % bpib) == 0)
385 if (((i - EXT2_DIRECT - bpib) % (bpib * bpib)) == 0)
387 if (((i - EXT2_DIRECT - bpib - bpib * bpib) %
388 (((unsigned long long)bpib) * bpib * bpib)) == 0)
391 rc = get_bmap(fd, i, &block);
397 if (*num_extents == 0 || block != last_block + 1 ||
398 fm_ext.fe_logical + fm_ext.fe_length != logical) {
400 * This is the start of a new extent; figure out where
401 * we expected it to be and report the extent.
403 if (*num_extents != 0 && fm_last.fe_length) {
404 expected = fm_last.fe_physical +
405 (fm_ext.fe_logical - fm_last.fe_logical);
406 if (expected == fm_ext.fe_physical)
409 if (force_extent && *num_extents == 0)
410 print_extent_header();
411 if (force_extent && *num_extents != 0) {
412 print_extent_info(&fm_ext, *num_extents - 1,
413 expected, blk_shift, st);
415 if (verbose && expected != 0) {
416 printf("Discontinuity: Block %llu is at %llu "
418 (unsigned long long) (fm_ext.fe_logical / st->st_blksize),
419 (unsigned long long) (fm_ext.fe_physical / st->st_blksize),
420 (unsigned long long) (expected / st->st_blksize));
422 /* create the new extent */
425 fm_ext.fe_physical = block * st->st_blksize;
426 fm_ext.fe_logical = logical;
427 fm_ext.fe_length = 0;
429 fm_ext.fe_length += st->st_blksize;
432 if (force_extent && *num_extents != 0) {
433 if (fm_last.fe_length) {
434 expected = fm_last.fe_physical +
435 (fm_ext.fe_logical - fm_last.fe_logical);
436 if (expected == fm_ext.fe_physical)
439 print_extent_info(&fm_ext, *num_extents - 1, expected,
446 static int frag_report(const char *filename)
448 static struct statfs fsinfo;
449 static unsigned int blksize;
450 ext2fs_struct_stat st;
453 unsigned long long numblocks;
454 int data_blocks_per_cyl = 1;
455 int num_extents = 1, expected = ~0;
457 static dev_t last_device;
461 #if defined(HAVE_OPEN64) && !defined(__OSX_AVAILABLE_BUT_DEPRECATED)
462 fd = open64(filename, O_RDONLY);
464 fd = open(filename, O_RDONLY);
472 #if defined(HAVE_FSTAT64) && !defined(__OSX_AVAILABLE_BUT_DEPRECATED)
473 if (fstat64(fd, &st) < 0) {
475 if (fstat(fd, &st) < 0) {
482 if ((last_device != st.st_dev) || !st.st_dev) {
483 if (fstatfs(fd, &fsinfo) < 0) {
488 if ((ioctl(fd, FIGETBSZ, &blksize) < 0) || !blksize)
489 blksize = fsinfo.f_bsize;
491 printf("Filesystem type is: %lx\n",
492 (unsigned long)fsinfo.f_type);
494 st.st_blksize = blksize;
495 if (fsinfo.f_type == 0xef51 || fsinfo.f_type == 0xef52 ||
496 fsinfo.f_type == 0xef53) {
499 if (ioctl(fd, EXT3_IOC_GETFLAGS, &flags) == 0 &&
500 !(flags & EXT4_EXTENTS_FL))
504 /* Check if filesystem is Lustre. Always print in extent format
505 * with 1kB blocks, using the device-relative logical offsets. */
506 if (fsinfo.f_type == LUSTRE_SUPER_MAGIC) {
508 blocksize = blocksize ?: 1024;
512 long cylgroups = div_ceil(fsinfo.f_blocks, blksize * 8);
514 if (verbose && last_device != st.st_dev)
515 printf("Filesystem cylinder groups approximately %ld\n",
518 data_blocks_per_cyl = blksize * 8 -
519 (fsinfo.f_files / 8 / cylgroups) - 3;
521 last_device = st.st_dev;
523 width = ulong_log10(fsinfo.f_blocks);
524 if (width > physical_width)
525 physical_width = width;
527 numblocks = (st.st_size + blksize - 1) / blksize;
529 blk_shift = ulong_log2(blocksize);
531 blk_shift = ulong_log2(blksize);
533 if (use_extent_cache)
536 width = ulong_log10(numblocks);
537 if (width > logical_width)
538 logical_width = width;
542 printf("File size of %s is %llu (%llu block%s of %d bytes)",
543 filename, (unsigned long long) st.st_size,
544 (unsigned long long) (numblocks * blksize >> blk_shift),
545 numblocks == 1 ? "" : "s", 1 << blk_shift);
546 if (use_extent_cache &&
547 ioctl(fd, EXT4_IOC_GETSTATE, &state) == 0 &&
548 (state & EXT4_STATE_FLAG_EXT_PRECACHED))
549 fputs(" -- pre-cached", stdout);
554 rc = filefrag_fiemap(fd, blk_shift, &num_extents, &st);
557 (use_extent_cache || precache_file || xattr_map)) {
559 fprintf(stderr, "%s: %s: %s\n ",
562 "EXT4_IOC_GET_ES_CACHE" :
563 "FS_IOC_FIEMAP", strerror(-rc));
568 if (force_bmap || rc < 0) { /* FIEMAP failed, try FIBMAP instead */
569 expected = filefrag_fibmap(fd, blk_shift, &num_extents,
570 &st, numblocks, is_ext2);
572 if (expected == -EINVAL || expected == -ENOTTY) {
573 fprintf(stderr, "%s: FIBMAP%s unsupported\n",
574 filename, force_bmap ? "" : "/FIEMAP");
575 } else if (expected == -EPERM) {
577 "%s: FIBMAP requires root privileges\n",
580 fprintf(stderr, "%s: FIBMAP error: %s",
581 filename, strerror(expected));
588 expected = expected / data_blocks_per_cyl + 1;
591 if (num_extents == 1)
592 printf("%s: 1 extent found", filename);
594 printf("%s: %d extents found", filename, num_extents);
595 /* count, and thus expected, only set for indirect FIBMAP'd files */
596 if (is_ext2 && expected && expected < num_extents)
597 printf(", perfection would be %d extent%s\n", expected,
598 (expected > 1) ? "s" : "");
607 static void usage(const char *progname)
609 fprintf(stderr, "Usage: %s [-b{blocksize}[KMG]] [-BeEksvxX] file ...\n",
614 int main(int argc, char**argv)
620 while ((c = getopt(argc, argv, "Bb::eEkPlsvxXV")) != EOF) {
631 val = strtoul(optarg, &end, 0);
633 #if __GNUC_PREREQ (7, 0)
634 #pragma GCC diagnostic push
635 #pragma GCC diagnostic ignored "-Wimplicit-fallthrough"
653 #if __GNUC_PREREQ (7, 0)
654 #pragma GCC diagnostic pop
657 /* Specifying too large a blocksize will just
658 * shift all extents down to zero length. Even
659 * 1GB is questionable, but caveat emptor. */
660 if (val > 1024 * 1024 * 1024) {
662 "%s: blocksize %lu over 1GB\n",
667 } else { /* Allow -b without argument for compat. Remove
668 * this eventually so "-b {blocksize}" works */
669 fprintf(stderr, "%s: -b needs a blocksize "
670 "option, assuming 1024-byte blocks.\n",
713 /* Print version number and exit */
714 printf("filefrag %s (%s)\n", E2FSPROGS_VERSION, E2FSPROGS_DATE);
715 if (version + verbose > 1) {
716 char flags[256] = "";
718 print_flags(0xffffffff, flags, sizeof(flags), 0);
719 printf("supported: %s\n", flags);
727 for (cpp = argv + optind; *cpp != NULL; cpp++) {
728 int rc2 = frag_report(*cpp);
730 if (rc2 < 0 && rc == 0)