Whamcloud - gitweb
filefrag: Add support to use the FIEMAP ioctl
[tools/e2fsprogs.git] / misc / filefrag.c
index 5d144ff..80ac05c 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * filefrag.c -- report if a particular file is fragmented
- * 
+ *
  * Copyright 2003 by Theodore Ts'o.
  *
  * %Begin-Header%
@@ -12,6 +12,7 @@
 #ifndef __linux__
 #include <stdio.h>
 #include <stdlib.h>
+#include <unistd.h>
 
 int main(void) {
     fputs("This program is only supported on Linux!\n", stderr);
@@ -38,30 +39,214 @@ extern int optind;
 #include <sys/vfs.h>
 #include <sys/ioctl.h>
 #include <linux/fd.h>
+#include <ext2fs/ext2_types.h>
+#include <ext2fs/fiemap.h>
 
 int verbose = 0;
+int no_bs = 0;         /* Don't use the files blocksize, use 1K blocksize */
+int sync_file = 0;     /* fsync file before getting the mapping */
+int xattr_map = 0;     /* get xattr mapping */
+int logical_width = 12;
+int physical_width = 14;
+unsigned long long filesize;
+
+#define FILEFRAG_FIEMAP_FLAGS_COMPAT (FIEMAP_FLAG_SYNC | FIEMAP_FLAG_XATTR)
 
-#define FIBMAP    _IO(0x00,1)  /* bmap access */
-#define FIGETBSZ   _IO(0x00,2) /* get the block size used for bmap */
+#define FIBMAP         _IO(0x00, 1)    /* bmap access */
+#define FIGETBSZ       _IO(0x00, 2)    /* get the block size used for bmap */
+#define FS_IOC_FIEMAP  _IOWR('f', 11, struct fiemap)
 
-#define EXT3_EXTENTS_FL                        0x00080000 /* Inode uses extents */
+#define        EXT4_EXTENTS_FL                 0x00080000 /* Inode uses extents */
 #define        EXT3_IOC_GETFLAGS               _IOR('f', 1, long)
 
-static unsigned long get_bmap(int fd, unsigned long block)
+static int int_log2(int arg)
+{
+       int     l = 0;
+
+       arg >>= 1;
+       while (arg) {
+               l++;
+               arg >>= 1;
+       }
+       return l;
+}
+
+static int int_log10(unsigned long long arg)
+{
+       int     l = 0;
+
+       arg = arg / 10;
+       while (arg) {
+               l++;
+               arg = arg / 10;
+       }
+       return l;
+}
+
+static unsigned int div_ceil(unsigned int a, unsigned int b)
+{
+       if (!a)
+               return 0;
+       return ((a - 1) / b) + 1;
+}
+
+static int get_bmap(int fd, unsigned long block, unsigned long *phy_blk)
 {
        int     ret;
        unsigned int b;
 
+       printf("Calling get_bmap for block %lu\n", block);
+       abort();
        b = block;
-       ret = ioctl(fd, FIBMAP, &b); /* FIBMAP takes a pointer to an integer */
+       ret = ioctl(fd, FIBMAP, &b); /* FIBMAP takes pointer to integer */
        if (ret < 0) {
                if (errno == EPERM) {
-                       fprintf(stderr, "No permission to use FIBMAP ioctl; must have root privileges\n");
+                       fprintf(stderr, "No permission to use FIBMAP ioctl; "
+                               "must have root privileges\n");
                        exit(1);
                }
                perror("FIBMAP");
        }
-       return b;
+       *phy_blk = b;
+
+       return ret;
+}
+
+static void print_extent_info(struct fiemap_extent *fm_extent, int cur_ex,
+                             unsigned long long expected, int blk_shift)
+{
+       __u64 phy_blk;
+       unsigned long long logical_blk;
+       unsigned long ext_len;
+       char flags[256] = "";
+
+       /* For inline data all offsets should be in terms of bytes, not blocks */
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_DATA_INLINE)
+               blk_shift = 0;
+
+       ext_len = fm_extent->fe_length >> blk_shift;
+       logical_blk = fm_extent->fe_logical >> blk_shift;
+       phy_blk = fm_extent->fe_physical >> blk_shift;
+
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_UNKNOWN)
+               strcat(flags, "unknown,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_DELALLOC)
+               strcat(flags, "delalloc,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_DATA_ENCRYPTED)
+               strcat(flags, "encrypted,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_NOT_ALIGNED)
+               strcat(flags, "not_aligned,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_DATA_INLINE)
+               strcat(flags, "inline,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_DATA_TAIL)
+               strcat(flags, "tail_packed,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_UNWRITTEN)
+               strcat(flags, "unwritten,");
+       if (fm_extent->fe_flags & FIEMAP_EXTENT_MERGED)
+               strcat(flags, "merged,");
+
+       if (fm_extent->fe_logical + fm_extent->fe_length >= filesize)
+               strcat(flags, "eof,");
+
+       /* Remove trailing comma, if any */
+       if (flags[0])
+               flags[strlen(flags) - 1] = '\0';
+
+       if (expected)
+               printf("%4d %*llu %*llu %*llu %6lu %s\n",
+                      cur_ex, logical_width, logical_blk,
+                      physical_width, phy_blk, physical_width, expected,
+                      ext_len, flags);
+       else
+               printf("%4d %*llu %*llu %*s %6lu %s\n",
+                      cur_ex, logical_width, logical_blk,
+                      physical_width, phy_blk, physical_width, "",
+                      ext_len, flags);
+}
+
+int filefrag_fiemap(int fd, int blk_shift, int *num_extents)
+{
+       char buf[4096] = "";
+       struct fiemap *fiemap = (struct fiemap *)buf;
+       struct fiemap_extent *fm_ext = &fiemap->fm_extents[0];
+       int count = (sizeof(buf) - sizeof(*fiemap)) /
+                       sizeof(struct fiemap_extent);
+       unsigned long long logical_blk = 0, last_blk = 0;
+       unsigned long flags = 0;
+       static int fiemap_incompat_printed;
+       int tot_extents = 1, n = 0;
+       int last = 0, eof = 0;
+       int i, rc;
+
+       fiemap->fm_length = ~0ULL;
+
+       memset(fiemap, 0, sizeof(struct fiemap));
+
+       if (!verbose)
+               count = 0;
+
+       if (sync_file)
+               flags |= FIEMAP_FLAG_SYNC;
+
+       if (xattr_map)
+               flags |= FIEMAP_FLAG_XATTR;
+
+       if (verbose)
+               printf(" ext %*s %*s %*s length flags\n", logical_width,
+                      "logical", physical_width, "physical",
+                      physical_width, "expected");
+
+       do {
+               fiemap->fm_length = ~0ULL;
+               fiemap->fm_flags = flags;
+               fiemap->fm_extent_count = count;
+               rc = ioctl(fd, FS_IOC_FIEMAP, (unsigned long) fiemap);
+               if (rc == -EBADR) {
+                       if (fiemap_incompat_printed == 0) {
+                               printf("FIEMAP failed with unsupported "
+                                      "flags %x\n", fiemap->fm_flags);
+                               fiemap_incompat_printed = 1;
+                       }
+               }
+               if (rc)
+                       return rc;
+
+               if (!verbose) {
+                       *num_extents = fiemap->fm_mapped_extents;
+                       goto out;
+               }
+
+               /* If 0 extents are returned, then more ioctls are not needed */
+               if (fiemap->fm_mapped_extents == 0)
+                       break;
+
+               for (i = 0; i < fiemap->fm_mapped_extents; i++) {
+                       __u64 phy_blk, phy_start, logical_blk;
+                       unsigned long ext_len;
+
+                       phy_blk = fm_ext[i].fe_physical >> blk_shift;
+                       ext_len = fm_ext[i].fe_length >> blk_shift;
+                       logical_blk = fm_ext[i].fe_logical >> blk_shift;
+
+                       if (logical_blk && phy_blk != last_blk + 1)
+                               tot_extents++;
+                       else
+                               last_blk = 0;
+                       print_extent_info(&fm_ext[i], n, last_blk, blk_shift);
+
+                       last_blk = phy_blk + ext_len - 1;
+                       if (fm_ext[i].fe_flags & FIEMAP_EXTENT_LAST)
+                               last = 1;
+                       n++;
+               }
+
+               fiemap->fm_start += fm_ext[i-1].fe_logical +
+                                                       fm_ext[i-1].fe_length;
+       } while (last == 0);
+
+       *num_extents = tot_extents;
+out:
+       return 0;
 }
 
 #define EXT2_DIRECT    12
@@ -75,13 +260,26 @@ static void frag_report(const char *filename)
        struct stat     fileinfo;
 #endif
        int             bs;
-       long            i, fd;
-       unsigned long   block, last_block = 0, numblocks;
+       long            fd;
+       unsigned long   block, last_block = 0, numblocks, i, count;
        long            bpib;   /* Blocks per indirect block */
        long            cylgroups;
-       int             discont = 0, expected;
+       int             num_extents = 0, expected;
        int             is_ext2 = 0;
+       static int      once = 1;
        unsigned int    flags;
+       unsigned long   first_blk, last_blk;
+       int rc;
+
+#ifdef HAVE_OPEN64
+       fd = open64(filename, O_RDONLY);
+#else
+       fd = open(filename, O_RDONLY);
+#endif
+       if (fd < 0) {
+               perror("open");
+               return;
+       }
 
        if (statfs(filename, &fsinfo) < 0) {
                perror("statfs");
@@ -95,87 +293,85 @@ static void frag_report(const char *filename)
                perror("stat");
                return;
        }
-       if (!S_ISREG(fileinfo.st_mode)) {
-               printf("%s: Not a regular file\n", filename);
-               return;
-       }
-       if ((fsinfo.f_type == 0xef51) || (fsinfo.f_type == 0xef52) || 
-           (fsinfo.f_type == 0xef53))
+       if (ioctl(fd, EXT3_IOC_GETFLAGS, &flags) < 0)
+               flags = 0;
+       if (!(flags & EXT4_EXTENTS_FL) &&
+           ((fsinfo.f_type == 0xef51) || (fsinfo.f_type == 0xef52) ||
+            (fsinfo.f_type == 0xef53)))
                is_ext2++;
-       if (verbose) {
-               printf("Filesystem type is: %x\n", fsinfo.f_type);
-       }
-       cylgroups = (fsinfo.f_blocks + fsinfo.f_bsize*8-1) / fsinfo.f_bsize*8;
-       if (verbose) {
-               printf("Filesystem cylinder groups is approximately %ld\n", 
+       if (verbose && once)
+               printf("Filesystem type is: %lx\n",
+                      (unsigned long) fsinfo.f_type);
+
+       cylgroups = div_ceil(fsinfo.f_blocks, fsinfo.f_bsize*8);
+       if (verbose && is_ext2 && once)
+               printf("Filesystem cylinder groups is approximately %ld\n",
                       cylgroups);
-       }
-#ifdef HAVE_OPEN64
-       fd = open64(filename, O_RDONLY);
-#else
-       fd = open(filename, O_RDONLY);
-#endif
-       if (fd < 0) {
-               perror("open");
-               return;
-       }
+
+       physical_width = int_log10(fsinfo.f_blocks);
+       if (physical_width < 8)
+               physical_width = 8;
+
        if (ioctl(fd, FIGETBSZ, &bs) < 0) { /* FIGETBSZ takes an int */
                perror("FIGETBSZ");
                close(fd);
                return;
        }
-       if (ioctl(fd, EXT3_IOC_GETFLAGS, &flags) < 0)
-               flags = 0;
-       if (flags & EXT3_EXTENTS_FL) {
-               printf("File is stored in extents format\n");
-               is_ext2 = 0;
-       }
-       if (verbose)
-               printf("Blocksize of file %s is %d\n", filename, bs);
+
+       if (no_bs)
+               bs = 1024;
+
        bpib = bs / 4;
        numblocks = (fileinfo.st_size + (bs-1)) / bs;
-       if (verbose) {
-               printf("File size of %s is %lld (%ld blocks)\n", filename, 
-                      (long long) fileinfo.st_size, numblocks);
-               printf("First block: %lu\nLast block: %lu\n",
-                      get_bmap(fd, 0), get_bmap(fd, numblocks - 1));
-       }
-       for (i=0; i < numblocks; i++) {
-               if (is_ext2 && last_block) {
-                       if (((i-EXT2_DIRECT) % bpib) == 0)
-                               last_block++;
-                       if (((i-EXT2_DIRECT-bpib) % (bpib*bpib)) == 0)
-                               last_block++;
-                       if (((i-EXT2_DIRECT-bpib-bpib*bpib) % (bpib*bpib*bpib)) == 0)
-                               last_block++;
-               }
-               block = get_bmap(fd, i);
-               if (block == 0)
-                       continue;
-               if (last_block && (block != last_block +1) ) {
-                       if (verbose)
-                               printf("Discontinuity: Block %ld is at %lu (was %lu)\n",
-                                      i, block, last_block);
-                       discont++;
+       logical_width = int_log10(numblocks);
+       if (logical_width < 7)
+               logical_width = 7;
+       filesize = (long long)fileinfo.st_size;
+       if (verbose)
+               printf("File size of %s is %lld (%ld block%s, blocksize %d)\n",
+                      filename, (long long) fileinfo.st_size, numblocks,
+                      numblocks == 1 ? "" : "s", bs);
+       if (filefrag_fiemap(fd, int_log2(bs), &num_extents) != 0) {
+               for (i = 0; i < numblocks; i++) {
+                       if (is_ext2 && last_block) {
+                               if (((i-EXT2_DIRECT) % bpib) == 0)
+                                       last_block++;
+                               if (((i-EXT2_DIRECT-bpib) % (bpib*bpib)) == 0)
+                                       last_block++;
+                               if (((i-EXT2_DIRECT-bpib-bpib*bpib) %
+                                                       (bpib*bpib*bpib)) == 0)
+                                       last_block++;
+                       }
+                       rc = get_bmap(fd, i, &block);
+                       if (block == 0)
+                               continue;
+                       if (last_block && (block != last_block+1) ) {
+                               if (verbose)
+                                       printf("Discontinuity: Block %ld is at "
+                                              "%lu (was %lu)\n",
+                                              i, block, last_block+1);
+                               num_extents++;
+                       }
+                       last_block = block;
                }
-               last_block = block;
        }
-       if (discont==0)
+       if (num_extents == 1)
                printf("%s: 1 extent found", filename);
        else
-               printf("%s: %d extents found", filename, discont+1);
-       expected = (numblocks/((bs*8)-(fsinfo.f_files/8/cylgroups)-3))+1;
-       if (is_ext2 && expected != discont+1)
+               printf("%s: %d extents found", filename, num_extents);
+       expected = (count/((bs*8)-(fsinfo.f_files/8/cylgroups)-3))+1;
+       if (is_ext2 && expected < num_extents)
                printf(", perfection would be %d extent%s\n", expected,
                        (expected>1) ? "s" : "");
        else
                fputc('\n', stdout);
        close(fd);
+       once = 0;
 }
 
 static void usage(const char *progname)
 {
-       fprintf(stderr, "Usage: %s [-v] file ...\n", progname);
+       fprintf(stderr, "Usage: %s [-bvsx] file ...\n", progname);
        exit(1);
 }
 
@@ -183,23 +379,30 @@ int main(int argc, char**argv)
 {
        char **cpp;
        int c;
+       int ret;
 
-       while ((c = getopt(argc, argv, "v")) != EOF)
+       while ((c = getopt(argc, argv, "bsvx")) != EOF)
                switch (c) {
+               case 'b':
+                       no_bs++;
+                       break;
                case 'v':
                        verbose++;
                        break;
+               case 's':
+                       sync_file++;
+                       break;
+               case 'x':
+                       xattr_map++;
+                       break;
                default:
                        usage(argv[0]);
                        break;
                }
        if (optind == argc)
                usage(argv[0]);
-       for (cpp=argv+optind; *cpp; cpp++) {
-               if (verbose)
-                       printf("Checking %s\n", *cpp);
+       for (cpp=argv+optind; *cpp; cpp++)
                frag_report(*cpp);
-       }
        return 0;
 }
 #endif