]> git.ipfire.org Git - thirdparty/e2fsprogs.git/commitdiff
libext2fs: handle inline data in read/write function
authorZheng Liu <wenqing.lz@taobao.com>
Mon, 3 Mar 2014 05:35:51 +0000 (00:35 -0500)
committerTheodore Ts'o <tytso@mit.edu>
Tue, 4 Mar 2014 13:46:14 +0000 (08:46 -0500)
Currently ext2fs_file_read/write are used to copy data from/to a file.
But they manipulate data by blocksize.  For supporting inline data, we
handle it in two new fucntions called ext2fs_file_read/write_inline_data.

In read path the implementation is straightforward.  But in write path
things get more complicated because if the size of data is greater than
the maximum size of inline data we will expand this file.  So now we
will check this in ext2fs_inline_data_set.  If this inode doesn't have
enough space, it will return EXT2_ET_INLINE_DATA_NO_SPACE error.  Then
the caller will check this error and tries to expand the file.

The following commands in debugfs can handle inline_data feature after
applying this patch:
- dump
- cat
- rdump
- write

Signed-off-by: Theodore Ts'o <tytso@mit.edu>
Signed-off-by: Zheng Liu <wenqing.lz@taobao.com>
Signed-off-by: Theodore Ts'o <tytso@mit.edu>
debugfs/debugfs.c
lib/ext2fs/ext2_err.et.in
lib/ext2fs/ext2fs.h
lib/ext2fs/ext2fsP.h
lib/ext2fs/ext_attr.c
lib/ext2fs/fileio.c
lib/ext2fs/inline_data.c

index d1ecf2ed1f415167044dde83eaeeb7fbd7f58a9a..4377b16ef129daf5937a4c0a7a17d50e8414a2bb 100644 (file)
@@ -1687,7 +1687,6 @@ fail:
        return retval;
 }
 
-
 void do_write(int argc, char *argv[])
 {
        int             fd;
@@ -1753,8 +1752,11 @@ void do_write(int argc, char *argv[])
                current_fs->now ? current_fs->now : time(0);
        inode.i_links_count = 1;
        inode.i_size = statbuf.st_size;
-       if (current_fs->super->s_feature_incompat &
-           EXT3_FEATURE_INCOMPAT_EXTENTS) {
+       if (EXT2_HAS_INCOMPAT_FEATURE(current_fs->super,
+                                     EXT4_FEATURE_INCOMPAT_INLINE_DATA)) {
+               inode.i_flags |= EXT4_INLINE_DATA_FL;
+       } else if (current_fs->super->s_feature_incompat &
+                  EXT3_FEATURE_INCOMPAT_EXTENTS) {
                int i;
                struct ext3_extent_header *eh;
 
@@ -1771,6 +1773,11 @@ void do_write(int argc, char *argv[])
                close(fd);
                return;
        }
+       if (inode.i_flags & EXT4_INLINE_DATA_FL) {
+               retval = ext2fs_inline_data_init(current_fs, newfile);
+               if (retval)
+                       return;
+       }
        if (LINUX_S_ISREG(inode.i_mode)) {
                if (statbuf.st_blocks < statbuf.st_size / S_BLKSIZE) {
                        make_holes = 1;
index 7638470c34560582f3eed18c410a8ed857350652..007103d7af541e3287f90b2204c005dbb374984d 100644 (file)
@@ -509,4 +509,7 @@ ec  EXT2_ET_NO_INLINE_DATA,
 ec     EXT2_ET_INLINE_DATA_NO_BLOCK,
        "No block for an inode with inline data"
 
+ec     EXT2_ET_INLINE_DATA_NO_SPACE,
+       "No free space in inline data"
+
        end
index 8de918279134819c45256cacd25ee0e322480cfa..34defef621e09667b3ebb107c49a6b5a15b84909 100644 (file)
@@ -1183,6 +1183,8 @@ errcode_t ext2fs_xattrs_close(struct ext2_xattr_handle **handle);
 errcode_t ext2fs_free_ext_attr(ext2_filsys fs, ext2_ino_t ino,
                               struct ext2_inode_large *inode);
 size_t ext2fs_xattrs_count(struct ext2_xattr_handle *handle);
+errcode_t ext2fs_xattr_inode_max_size(ext2_filsys fs, ext2_ino_t ino,
+                                     size_t *size);
 
 /* extent.c */
 extern errcode_t ext2fs_extent_header_verify(void *ptr, int size);
index 8b413071f1d407094aa0c7ef3670632be7816e97..eaa203cbb217b1e3b0393b81e4776f9d03e60f8f 100644 (file)
@@ -96,6 +96,12 @@ extern errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino);
 extern int ext2fs_inline_data_dir_iterate(ext2_filsys fs,
                                          ext2_ino_t ino,
                                          void *priv_data);
+extern errcode_t ext2fs_inline_data_get(ext2_filsys fs, ext2_ino_t ino,
+                                       struct ext2_inode *inode,
+                                       void *buf, size_t *size);
+extern errcode_t ext2fs_inline_data_set(ext2_filsys fs, ext2_ino_t ino,
+                                       struct ext2_inode *inode,
+                                       void *buf, size_t size);
 
 /* Generic numeric progress meter */
 
index e69275e80b0d6ec7770531cf08c93f5346ec9d65..e8dee535695fc4c42bdf3022e3175670dc1aa94e 100644 (file)
@@ -820,6 +820,70 @@ errcode_t ext2fs_xattr_get(struct ext2_xattr_handle *h, const char *key,
        return EXT2_ET_EA_KEY_NOT_FOUND;
 }
 
+errcode_t ext2fs_xattr_inode_max_size(ext2_filsys fs, ext2_ino_t ino,
+                                     size_t *size)
+{
+       struct ext2_ext_attr_header *header;
+       struct ext2_ext_attr_entry *entry;
+       struct ext2_inode_large *inode;
+       __u32 ea_inode_magic;
+       unsigned int storage_size, freesize, minoff;
+       void *start;
+       int i;
+       errcode_t err;
+
+       i = EXT2_INODE_SIZE(fs->super);
+       if (i < sizeof(*inode))
+               i = sizeof(*inode);
+       err = ext2fs_get_memzero(i, &inode);
+       if (err)
+               return err;
+
+       err = ext2fs_read_inode_full(fs, ino, (struct ext2_inode *)inode,
+                                    EXT2_INODE_SIZE(fs->super));
+       if (err)
+               goto out;
+
+       /* Does the inode have size for EA? */
+       if (EXT2_INODE_SIZE(fs->super) <= EXT2_GOOD_OLD_INODE_SIZE +
+                                                 inode->i_extra_isize +
+                                                 sizeof(__u32)) {
+               err = EXT2_ET_INLINE_DATA_NO_SPACE;
+               goto out;
+       }
+
+       minoff = EXT2_INODE_SIZE(fs->super) - sizeof(*inode) - sizeof(__u32);
+       memcpy(&ea_inode_magic, ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
+              inode->i_extra_isize, sizeof(__u32));
+       if (ea_inode_magic == EXT2_EXT_ATTR_MAGIC) {
+               /* has xattrs.  calculate the size */
+               storage_size = EXT2_INODE_SIZE(fs->super) -
+                       EXT2_GOOD_OLD_INODE_SIZE - inode->i_extra_isize -
+                       sizeof(__u32);
+               start= ((char *) inode) + EXT2_GOOD_OLD_INODE_SIZE +
+                       inode->i_extra_isize + sizeof(__u32);
+               entry = start;
+               while (!EXT2_EXT_IS_LAST_ENTRY(entry)) {
+                       if (!entry->e_value_block && entry->e_value_size) {
+                               unsigned int offs = entry->e_value_offs;
+                               if (offs < minoff)
+                                       minoff = offs;
+                       }
+                       entry = EXT2_EXT_ATTR_NEXT(entry);
+               }
+               *size = minoff - ((char *)entry - (char *)start) - sizeof(__u32);
+       } else {
+               /* no xattr.  return a maximum size */
+               *size = EXT2_EXT_ATTR_SIZE(minoff -
+                                          EXT2_EXT_ATTR_LEN(strlen("data")) -
+                                          EXT2_EXT_ATTR_ROUND - sizeof(__u32));
+       }
+
+out:
+       ext2fs_free_mem(&inode);
+       return err;
+}
+
 errcode_t ext2fs_xattr_set(struct ext2_xattr_handle *handle,
                           const char *key,
                           const void *value,
index 5a39c321aa788e080b2dfacc92e54c9aba309f29..14eaed34075e5b8e81e790bc06feaabe07f66c61 100644 (file)
@@ -224,6 +224,38 @@ errcode_t ext2fs_file_close(ext2_file_t file)
 }
 
 
+static errcode_t
+ext2fs_file_read_inline_data(ext2_file_t file, void *buf,
+                            unsigned int wanted, unsigned int *got)
+{
+       ext2_filsys fs;
+       errcode_t retval;
+       unsigned int count = 0;
+       size_t size;
+
+       fs = file->fs;
+       retval = ext2fs_inline_data_get(fs, file->ino, &file->inode,
+                                       file->buf, &size);
+       if (retval)
+               return retval;
+
+       if (file->pos >= size)
+               goto out;
+
+       count = size - file->pos;
+       if (count > wanted)
+               count = wanted;
+       memcpy(buf, file->buf + file->pos, count);
+       file->pos += count;
+       buf += count;
+
+out:
+       if (got)
+               *got = count;
+       return retval;
+}
+
+
 errcode_t ext2fs_file_read(ext2_file_t file, void *buf,
                           unsigned int wanted, unsigned int *got)
 {
@@ -236,6 +268,10 @@ errcode_t ext2fs_file_read(ext2_file_t file, void *buf,
        EXT2_CHECK_MAGIC(file, EXT2_ET_MAGIC_EXT2_FILE);
        fs = file->fs;
 
+       /* If an inode has inline data, things get complicated. */
+       if (file->inode.i_flags & EXT4_INLINE_DATA_FL)
+               return ext2fs_file_read_inline_data(file, buf, wanted, got);
+
        while ((file->pos < EXT2_I_SIZE(&file->inode)) && (wanted > 0)) {
                retval = sync_buffer_position(file);
                if (retval)
@@ -266,6 +302,66 @@ fail:
 }
 
 
+static errcode_t
+ext2fs_file_write_inline_data(ext2_file_t file, const void *buf,
+                             unsigned int nbytes, unsigned int *written)
+{
+       ext2_filsys fs;
+       errcode_t retval;
+       unsigned int count = 0;
+       size_t size;
+
+       fs = file->fs;
+       retval = ext2fs_inline_data_get(fs, file->ino, &file->inode,
+                                       file->buf, &size);
+       if (retval)
+               return retval;
+
+       if (file->pos < size) {
+               count = nbytes - file->pos;
+               memcpy(file->buf + file->pos, buf, count);
+
+               retval = ext2fs_inline_data_set(fs, file->ino, &file->inode,
+                                               file->buf, count);
+               if (retval == EXT2_ET_INLINE_DATA_NO_SPACE)
+                       goto expand;
+               if (retval)
+                       return retval;
+
+               file->pos += count;
+
+               /* Update inode size */
+               if (count != 0 && EXT2_I_SIZE(&file->inode) < file->pos) {
+                       errcode_t       rc;
+
+                       rc = ext2fs_file_set_size2(file, file->pos);
+                       if (retval == 0)
+                               retval = rc;
+               }
+
+               if (written)
+                       *written = count;
+               return 0;
+       }
+
+expand:
+       retval = ext2fs_inline_data_expand(fs, file->ino);
+       if (retval)
+               return retval;
+       /*
+        * reload inode and return no space error
+        *
+        * XXX: file->inode could be copied from the outside
+        * in ext2fs_file_open2().  We have no way to modify
+        * the outside inode.
+        */
+       retval = ext2fs_read_inode(fs, file->ino, &file->inode);
+       if (retval)
+               return retval;
+       return EXT2_ET_INLINE_DATA_NO_SPACE;
+}
+
+
 errcode_t ext2fs_file_write(ext2_file_t file, const void *buf,
                            unsigned int nbytes, unsigned int *written)
 {
@@ -280,6 +376,16 @@ errcode_t ext2fs_file_write(ext2_file_t file, const void *buf,
        if (!(file->flags & EXT2_FILE_WRITE))
                return EXT2_ET_FILE_RO;
 
+       /* If an inode has inline data, things get complicated. */
+       if (file->inode.i_flags & EXT4_INLINE_DATA_FL) {
+               retval = ext2fs_file_write_inline_data(file, buf, nbytes,
+                                                      written);
+               if (retval != EXT2_ET_INLINE_DATA_NO_SPACE)
+                       return retval;
+               /* fall through to read data from the block */
+               retval = 0;
+       }
+
        while (nbytes > 0) {
                retval = sync_buffer_position(file);
                if (retval)
index 424c069bdf706078434fd5737440a650a6b3207a..6134045bba7f32c183008517615df0ca00f1faee 100644 (file)
@@ -340,14 +340,98 @@ err:
        return retval;
 }
 
+static errcode_t
+ext2fs_inline_data_dir_expand(ext2_filsys fs, ext2_ino_t ino,
+                             struct ext2_inode *inode, char *buf, size_t size)
+{
+       errcode_t retval;
+       blk64_t blk;
+       char *blk_buf;
+
+       retval = ext2fs_get_memzero(fs->blocksize, &blk_buf);
+       if (retval)
+               return retval;
+
+#ifdef WORDS_BIGENDIAN
+       retval = ext2fs_dirent_swab_in2(fs, buf, size);
+       if (retval)
+               goto errout;
+#endif
+
+       /* Adjust the rec_len */
+       retval = ext2fs_inline_data_convert_dir(fs, ino, blk_buf, buf, size);
+       /* Allocate a new block */
+       retval = ext2fs_new_block2(fs, 0, 0, &blk);
+       if (retval)
+               goto errout;
+       retval = ext2fs_write_dir_block4(fs, blk, blk_buf, 0, ino);
+       if (retval)
+               goto errout;
+
+       /* Update inode */
+       if (EXT2_HAS_INCOMPAT_FEATURE(fs->super, EXT3_FEATURE_INCOMPAT_EXTENTS))
+               inode->i_flags |= EXT4_EXTENTS_FL;
+       inode->i_flags &= ~EXT4_INLINE_DATA_FL;
+       ext2fs_iblk_set(fs, inode, 1);
+       inode->i_size = fs->blocksize;
+       retval = ext2fs_bmap2(fs, ino, inode, 0, BMAP_SET, 0, 0, &blk);
+       if (retval)
+               goto errout;
+       retval = ext2fs_write_inode(fs, ino, inode);
+       if (retval)
+               goto errout;
+       ext2fs_block_alloc_stats(fs, blk, +1);
+
+errout:
+       ext2fs_free_mem(&blk_buf);
+       return retval;
+}
+
+static errcode_t
+ext2fs_inline_data_file_expand(ext2_filsys fs, ext2_ino_t ino,
+                              struct ext2_inode *inode, char *buf, size_t size)
+{
+       ext2_file_t e2_file;
+       errcode_t retval;
+
+       /* Update inode */
+       if (EXT2_HAS_INCOMPAT_FEATURE(fs->super,
+                                     EXT3_FEATURE_INCOMPAT_EXTENTS)) {
+               int i;
+               struct ext3_extent_header *eh;
+
+               eh = (struct ext3_extent_header *) &inode->i_block[0];
+               eh->eh_depth = 0;
+               eh->eh_entries = 0;
+               eh->eh_magic = EXT3_EXT_MAGIC;
+               i = (sizeof(inode->i_block) - sizeof(*eh)) /
+                       sizeof(struct ext3_extent);
+               eh->eh_max = ext2fs_cpu_to_le16(i);
+               inode->i_flags |= EXT4_EXTENTS_FL;
+       }
+       inode->i_flags &= ~EXT4_INLINE_DATA_FL;
+       ext2fs_iblk_set(fs, inode, 0);
+       inode->i_size = 0;
+       retval = ext2fs_write_inode(fs, ino, inode);
+       if (retval)
+               return retval;
+
+       /* Write out the block buffer */
+       retval = ext2fs_file_open(fs, ino, EXT2_FILE_WRITE, &e2_file);
+       if (retval)
+               return retval;
+       retval = ext2fs_file_write(e2_file, buf, size, 0);
+       ext2fs_file_close(e2_file);
+       return retval;
+}
+
 errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino)
 {
        struct ext2_inode inode;
        struct ext2_inline_data data;
        errcode_t retval;
-       blk64_t blk;
+       size_t inline_size;
        char *inline_buf = 0;
-       char *blk_buf = 0;
 
        EXT2_CHECK_MAGIC(fs, EXT2_ET_MAGIC_EXT2FS_FILSYS);
 
@@ -358,14 +442,13 @@ errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino)
        if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
                return EXT2_ET_NO_INLINE_DATA;
 
-       /* Get inline data first */
        data.fs = fs;
        data.ino = ino;
        retval = ext2fs_inline_data_ea_get(&data);
        if (retval)
                return retval;
-       retval = ext2fs_get_mem(EXT4_MIN_INLINE_DATA_SIZE + data.ea_size,
-                               &inline_buf);
+       inline_size = data.ea_size + EXT4_MIN_INLINE_DATA_SIZE;
+       retval = ext2fs_get_mem(inline_size, &inline_buf);
        if (retval)
                goto errout;
 
@@ -375,56 +458,98 @@ errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino)
                       data.ea_data, data.ea_size);
        }
 
-#ifdef WORDS_BIGENDIAN
-       retval = ext2fs_dirent_swab_in2(fs, inline_buf,
-                       data.ea_size + EXT4_MIN_INLINE_DATA_SIZE);
-       if (retval)
-               goto errout;
-#endif
-
        memset((void *)inode.i_block, 0, EXT4_MIN_INLINE_DATA_SIZE);
        retval = ext2fs_inline_data_ea_remove(fs, ino);
        if (retval)
                goto errout;
 
-       retval = ext2fs_get_mem(fs->blocksize, &blk_buf);
-       if (retval)
-               goto errout;
-
-       /* Adjust the rec_len */
-       retval = ext2fs_inline_data_convert_dir(fs, ino, blk_buf, inline_buf,
-                                               EXT4_MIN_INLINE_DATA_SIZE +
-                                                       data.ea_size);
-       if (retval)
-               goto errout;
-
-       /* Allocate a new block */
-       retval = ext2fs_new_block2(fs, 0, 0, &blk);
-       if (retval)
-               goto errout;
-       retval = ext2fs_write_dir_block4(fs, blk, blk_buf, 0, ino);
-       if (retval)
-               goto errout;
-
-       /* Update inode */
-       if (EXT2_HAS_INCOMPAT_FEATURE(fs->super, EXT3_FEATURE_INCOMPAT_EXTENTS))
-               inode.i_flags |= EXT4_EXTENTS_FL;
-       inode.i_flags &= ~EXT4_INLINE_DATA_FL;
-       ext2fs_iblk_set(fs, &inode, 1);
-       inode.i_size = fs->blocksize;
-       retval = ext2fs_bmap2(fs, ino, &inode, 0, BMAP_SET, 0, 0, &blk);
-       if (retval)
-               goto errout;
-       retval = ext2fs_write_inode(fs, ino, &inode);
-       if (retval)
-               goto errout;
-       ext2fs_block_alloc_stats2(fs, blk, +1);
+       if (LINUX_S_ISDIR(inode.i_mode)) {
+               retval = ext2fs_inline_data_dir_expand(fs, ino, &inode,
+                                               inline_buf, inline_size);
+       } else {
+               retval = ext2fs_inline_data_file_expand(fs, ino, &inode,
+                                               inline_buf, inline_size);
+       }
 
 errout:
-       if (blk_buf)
-               ext2fs_free_mem(&blk_buf);
        if (inline_buf)
                ext2fs_free_mem(&inline_buf);
        ext2fs_free_mem(&data.ea_data);
        return retval;
 }
+
+/*
+ * When caller uses this function to retrieve the inline data, it must
+ * allocate a buffer which has the size of inline data.  The size of
+ * inline data can be know by ext2fs_inline_data_get_size().
+ */
+errcode_t ext2fs_inline_data_get(ext2_filsys fs, ext2_ino_t ino,
+                                struct ext2_inode *inode,
+                                void *buf, size_t *size)
+{
+       struct ext2_inode inode_buf;
+       struct ext2_inline_data data;
+       errcode_t retval;
+
+       if (!inode) {
+               retval = ext2fs_read_inode(fs, ino, &inode_buf);
+               if (retval)
+                       return retval;
+               inode = &inode_buf;
+       }
+
+       data.fs = fs;
+       data.ino = ino;
+       retval = ext2fs_inline_data_ea_get(&data);
+       if (retval)
+               return retval;
+
+       memcpy(buf, (void *)inode->i_block, EXT4_MIN_INLINE_DATA_SIZE);
+       if (data.ea_size > 0)
+               memcpy(buf + EXT4_MIN_INLINE_DATA_SIZE,
+                      data.ea_data, data.ea_size);
+
+       if (size)
+               *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
+       ext2fs_free_mem(&data.ea_data);
+       return 0;
+}
+
+errcode_t ext2fs_inline_data_set(ext2_filsys fs, ext2_ino_t ino,
+                                struct ext2_inode *inode,
+                                void *buf, size_t size)
+{
+       struct ext2_inode inode_buf;
+       struct ext2_inline_data data;
+       errcode_t retval;
+       size_t max_size;
+
+       if (!inode) {
+               retval = ext2fs_read_inode(fs, ino, &inode_buf);
+               if (retval)
+                       return retval;
+               inode = &inode_buf;
+       }
+
+       if (size <= EXT4_MIN_INLINE_DATA_SIZE) {
+               memcpy((void *)inode->i_block, buf, size);
+               return ext2fs_write_inode(fs, ino, inode);
+       }
+
+       retval = ext2fs_xattr_inode_max_size(fs, ino, &max_size);
+       if (retval)
+               return retval;
+
+       if (size - EXT4_MIN_INLINE_DATA_SIZE > max_size)
+               return EXT2_ET_INLINE_DATA_NO_SPACE;
+
+       memcpy((void *)inode->i_block, buf, EXT4_MIN_INLINE_DATA_SIZE);
+       retval = ext2fs_write_inode(fs, ino, inode);
+       if (retval)
+               return retval;
+       data.fs = fs;
+       data.ino = ino;
+       data.ea_size = size - EXT4_MIN_INLINE_DATA_SIZE;
+       data.ea_data = buf + EXT4_MIN_INLINE_DATA_SIZE;
+       return ext2fs_inline_data_ea_set(&data);
+}