2 * inline_data.c --- data in inode
4 * Copyright (C) 2012 Zheng Liu <wenqing.lz@taobao.com>
7 * This file may be redistributed under the terms of the GNU library
8 * General Public License, version 2.
15 #include <limits.h> /* for PATH_MAX */
18 #include "ext2_ext_attr.h"
23 struct ext2_inline_data {
26 size_t ea_size; /* the size of inline data in ea area */
30 static errcode_t ext2fs_inline_data_ea_set(struct ext2_inline_data *data)
32 struct ext2_xattr_handle *handle;
35 retval = ext2fs_xattrs_open(data->fs, data->ino, &handle);
39 retval = ext2fs_xattrs_read(handle);
43 retval = ext2fs_xattr_set(handle, "system.data",
44 data->ea_data, data->ea_size);
48 retval = ext2fs_xattrs_write(handle);
51 (void) ext2fs_xattrs_close(&handle);
55 static errcode_t ext2fs_inline_data_ea_get(struct ext2_inline_data *data)
57 struct ext2_xattr_handle *handle;
63 retval = ext2fs_xattrs_open(data->fs, data->ino, &handle);
67 retval = ext2fs_xattrs_read(handle);
71 retval = ext2fs_xattr_get(handle, "system.data",
72 (void **)&data->ea_data, &data->ea_size);
73 if (retval == EXT2_ET_EA_KEY_NOT_FOUND) {
81 (void) ext2fs_xattrs_close(&handle);
85 errcode_t ext2fs_inline_data_init(ext2_filsys fs, ext2_ino_t ino)
87 struct ext2_inline_data data;
88 char empty[1] = { '\0' };
94 return ext2fs_inline_data_ea_set(&data);
97 errcode_t ext2fs_inline_data_size(ext2_filsys fs, ext2_ino_t ino, size_t *size)
99 struct ext2_inode inode;
100 struct ext2_inline_data data;
103 retval = ext2fs_read_inode(fs, ino, &inode);
107 if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
108 return EXT2_ET_NO_INLINE_DATA;
112 retval = ext2fs_inline_data_ea_get(&data);
116 *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
117 return ext2fs_free_mem(&data.ea_data);
120 int ext2fs_inline_data_dir_iterate(ext2_filsys fs, ext2_ino_t ino,
123 struct dir_context *ctx;
124 struct ext2_inode inode;
125 struct ext2_dir_entry dirent;
126 struct ext2_inline_data data;
127 int ret = BLOCK_ABORT;
128 e2_blkcnt_t blockcnt = 0;
130 unsigned int old_buflen;
133 ctx = (struct dir_context *)priv_data;
135 old_buflen = ctx->buflen;
136 old_flags = ctx->flags;
137 ctx->flags |= DIRENT_FLAG_INCLUDE_INLINE_DATA;
139 ctx->errcode = ext2fs_read_inode(fs, ino, &inode);
143 if (!(inode.i_flags & EXT4_INLINE_DATA_FL)) {
144 ctx->errcode = EXT2_ET_NO_INLINE_DATA;
148 if (!LINUX_S_ISDIR(inode.i_mode)) {
149 ctx->errcode = EXT2_ET_NO_DIRECTORY;
154 /* we first check '.' and '..' dir */
157 ext2fs_set_rec_len(fs, EXT2_DIR_REC_LEN(2), &dirent);
158 dirent.name[0] = '.';
159 dirent.name[1] = '\0';
160 ctx->buf = (char *)&dirent;
161 ext2fs_get_rec_len(fs, &dirent, &ctx->buflen);
162 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
163 if (ret & BLOCK_ABORT)
166 dirent.inode = ext2fs_le32_to_cpu(inode.i_block[0]);
168 ext2fs_set_rec_len(fs, EXT2_DIR_REC_LEN(3), &dirent);
169 dirent.name[0] = '.';
170 dirent.name[1] = '.';
171 dirent.name[2] = '\0';
172 ctx->buf = (char *)&dirent;
173 ext2fs_get_rec_len(fs, &dirent, &ctx->buflen);
174 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
175 if (ret & BLOCK_INLINE_DATA_CHANGED) {
178 inode.i_block[0] = ext2fs_cpu_to_le32(dirent.inode);
179 err = ext2fs_write_inode(fs, ino, &inode);
182 ret &= ~BLOCK_INLINE_DATA_CHANGED;
184 if (ret & BLOCK_ABORT)
187 ctx->buf = (char *)inode.i_block + EXT4_INLINE_DATA_DOTDOT_SIZE;
188 ctx->buflen = EXT4_MIN_INLINE_DATA_SIZE - EXT4_INLINE_DATA_DOTDOT_SIZE;
189 #ifdef WORDS_BIGENDIAN
190 ctx->errcode = ext2fs_dirent_swab_in2(fs, ctx->buf, ctx->buflen, 0);
196 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
197 if (ret & BLOCK_INLINE_DATA_CHANGED) {
198 #ifdef WORDS_BIGENDIAN
199 ctx->errcode = ext2fs_dirent_swab_out2(fs, ctx->buf,
206 ctx->errcode = ext2fs_write_inode(fs, ino, &inode);
209 ret &= ~BLOCK_INLINE_DATA_CHANGED;
211 if (ret & BLOCK_ABORT)
216 ctx->errcode = ext2fs_inline_data_ea_get(&data);
221 if (data.ea_size <= 0)
224 ctx->buf = data.ea_data;
225 ctx->buflen = data.ea_size;
226 #ifdef WORDS_BIGENDIAN
227 ctx->errcode = ext2fs_dirent_swab_in2(fs, ctx->buf, ctx->buflen, 0);
234 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
235 if (ret & BLOCK_INLINE_DATA_CHANGED) {
236 #ifdef WORDS_BIGENDIAN
237 ctx->errcode = ext2fs_dirent_swab_out2(fs, ctx->buf,
244 ctx->errcode = ext2fs_inline_data_ea_set(&data);
250 ext2fs_free_mem(&data.ea_data);
253 ctx->buflen = old_buflen;
254 ctx->flags = old_flags;
255 ret &= ~(BLOCK_ABORT | BLOCK_INLINE_DATA_CHANGED);
259 errcode_t ext2fs_inline_data_ea_remove(ext2_filsys fs, ext2_ino_t ino)
261 struct ext2_xattr_handle *handle;
264 retval = ext2fs_xattrs_open(fs, ino, &handle);
268 retval = ext2fs_xattrs_read(handle);
272 retval = ext2fs_xattr_remove(handle, "system.data");
276 retval = ext2fs_xattrs_write(handle);
279 (void) ext2fs_xattrs_close(&handle);
283 static errcode_t ext2fs_inline_data_convert_dir(ext2_filsys fs, ext2_ino_t ino,
284 char *bbuf, char *ibuf, int size)
286 struct ext2_dir_entry *dir, *dir2;
287 struct ext2_dir_entry_tail *t;
290 unsigned int rec_len;
294 if (ext2fs_has_feature_metadata_csum(fs->super))
295 csum_size = sizeof(struct ext2_dir_entry_tail);
297 /* Create '.' and '..' */
298 if (ext2fs_has_feature_filetype(fs->super))
299 filetype = EXT2_FT_DIR;
302 * Set up entry for '.'
304 dir = (struct ext2_dir_entry *) bbuf;
306 ext2fs_dirent_set_name_len(dir, 1);
307 ext2fs_dirent_set_file_type(dir, filetype);
309 rec_len = (fs->blocksize - csum_size) - EXT2_DIR_REC_LEN(1);
310 dir->rec_len = EXT2_DIR_REC_LEN(1);
313 * Set up entry for '..'
315 dir = (struct ext2_dir_entry *) (bbuf + dir->rec_len);
316 dir->rec_len = EXT2_DIR_REC_LEN(2);
317 dir->inode = ext2fs_le32_to_cpu(((__u32 *)ibuf)[0]);
318 ext2fs_dirent_set_name_len(dir, 2);
319 ext2fs_dirent_set_file_type(dir, filetype);
324 * Ajust the last rec_len
326 offset = EXT2_DIR_REC_LEN(1) + EXT2_DIR_REC_LEN(2);
327 dir = (struct ext2_dir_entry *) (bbuf + offset);
328 memcpy(bbuf + offset, ibuf + EXT4_INLINE_DATA_DOTDOT_SIZE,
329 size - EXT4_INLINE_DATA_DOTDOT_SIZE);
330 size += EXT2_DIR_REC_LEN(1) + EXT2_DIR_REC_LEN(2) -
331 EXT4_INLINE_DATA_DOTDOT_SIZE;
335 retval = ext2fs_get_rec_len(fs, dir, &rec_len);
339 dir = (struct ext2_dir_entry *) (bbuf + offset);
340 } while (offset < size);
341 rec_len += fs->blocksize - csum_size - offset;
342 retval = ext2fs_set_rec_len(fs, rec_len, dir2);
347 t = EXT2_DIRENT_TAIL(bbuf, fs->blocksize);
348 ext2fs_initialize_dirent_tail(fs, t);
356 ext2fs_inline_data_dir_expand(ext2_filsys fs, ext2_ino_t ino,
357 struct ext2_inode *inode, char *buf, size_t size)
363 retval = ext2fs_get_memzero(fs->blocksize, &blk_buf);
367 #ifdef WORDS_BIGENDIAN
368 retval = ext2fs_dirent_swab_in2(fs, buf + EXT4_INLINE_DATA_DOTDOT_SIZE,
374 /* Adjust the rec_len */
375 retval = ext2fs_inline_data_convert_dir(fs, ino, blk_buf, buf, size);
378 /* Allocate a new block */
379 retval = ext2fs_new_block2(fs, 0, 0, &blk);
382 retval = ext2fs_write_dir_block4(fs, blk, blk_buf, 0, ino);
387 if (ext2fs_has_feature_extents(fs->super))
388 inode->i_flags |= EXT4_EXTENTS_FL;
389 inode->i_flags &= ~EXT4_INLINE_DATA_FL;
390 retval = ext2fs_iblk_add_blocks(fs, inode, 1);
393 inode->i_size = fs->blocksize;
394 retval = ext2fs_bmap2(fs, ino, inode, 0, BMAP_SET, 0, 0, &blk);
397 retval = ext2fs_write_inode(fs, ino, inode);
400 ext2fs_block_alloc_stats(fs, blk, +1);
403 ext2fs_free_mem(&blk_buf);
408 ext2fs_inline_data_file_expand(ext2_filsys fs, ext2_ino_t ino,
409 struct ext2_inode *inode, char *buf, size_t size)
415 memset(inode->i_block, 0, sizeof(inode->i_block));
416 if (ext2fs_has_feature_extents(fs->super)) {
417 ext2_extent_handle_t handle;
419 inode->i_flags &= ~EXT4_EXTENTS_FL;
420 retval = ext2fs_extent_open2(fs, ino, inode, &handle);
423 ext2fs_extent_free(handle);
425 inode->i_flags &= ~EXT4_INLINE_DATA_FL;
427 retval = ext2fs_write_inode(fs, ino, inode);
431 /* Write out the block buffer */
432 retval = ext2fs_file_open(fs, ino, EXT2_FILE_WRITE, &e2_file);
435 retval = ext2fs_file_write(e2_file, buf, size, 0);
436 ext2fs_file_close(e2_file);
440 errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino)
442 struct ext2_inode inode;
443 struct ext2_inline_data data;
446 char *inline_buf = 0;
448 EXT2_CHECK_MAGIC(fs, EXT2_ET_MAGIC_EXT2FS_FILSYS);
450 retval = ext2fs_read_inode(fs, ino, &inode);
454 if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
455 return EXT2_ET_NO_INLINE_DATA;
459 retval = ext2fs_inline_data_ea_get(&data);
462 inline_size = data.ea_size + EXT4_MIN_INLINE_DATA_SIZE;
463 retval = ext2fs_get_mem(inline_size, &inline_buf);
467 memcpy(inline_buf, (void *)inode.i_block, EXT4_MIN_INLINE_DATA_SIZE);
468 if (data.ea_size > 0) {
469 memcpy(inline_buf + EXT4_MIN_INLINE_DATA_SIZE,
470 data.ea_data, data.ea_size);
473 memset((void *)inode.i_block, 0, EXT4_MIN_INLINE_DATA_SIZE);
475 * NOTE: We must do this write -> ea_remove -> read cycle here because
476 * removing the inline data EA can free the EA block, which is a change
477 * that our stack copy of the inode will never see. If that happens,
478 * we can end up with the EA block and lblk 0 pointing to the same
479 * pblk, which is bad news.
481 retval = ext2fs_write_inode(fs, ino, &inode);
484 retval = ext2fs_inline_data_ea_remove(fs, ino);
487 retval = ext2fs_read_inode(fs, ino, &inode);
491 if (LINUX_S_ISDIR(inode.i_mode)) {
492 retval = ext2fs_inline_data_dir_expand(fs, ino, &inode,
493 inline_buf, inline_size);
495 retval = ext2fs_inline_data_file_expand(fs, ino, &inode,
496 inline_buf, inline_size);
501 ext2fs_free_mem(&inline_buf);
502 ext2fs_free_mem(&data.ea_data);
507 * When caller uses this function to retrieve the inline data, it must
508 * allocate a buffer which has the size of inline data. The size of
509 * inline data can be know by ext2fs_inline_data_get_size().
511 errcode_t ext2fs_inline_data_get(ext2_filsys fs, ext2_ino_t ino,
512 struct ext2_inode *inode,
513 void *buf, size_t *size)
515 struct ext2_inode inode_buf;
516 struct ext2_inline_data data;
520 retval = ext2fs_read_inode(fs, ino, &inode_buf);
528 retval = ext2fs_inline_data_ea_get(&data);
532 memcpy(buf, (void *)inode->i_block, EXT4_MIN_INLINE_DATA_SIZE);
533 if (data.ea_size > 0)
534 memcpy((char *) buf + EXT4_MIN_INLINE_DATA_SIZE,
535 data.ea_data, data.ea_size);
538 *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
539 ext2fs_free_mem(&data.ea_data);
543 errcode_t ext2fs_inline_data_set(ext2_filsys fs, ext2_ino_t ino,
544 struct ext2_inode *inode,
545 void *buf, size_t size)
547 struct ext2_inode inode_buf;
548 struct ext2_inline_data data;
550 size_t free_ea_size, existing_size, free_inode_size;
553 retval = ext2fs_read_inode(fs, ino, &inode_buf);
559 if (size <= EXT4_MIN_INLINE_DATA_SIZE) {
560 memcpy((void *)inode->i_block, buf, size);
561 return ext2fs_write_inode(fs, ino, inode);
564 retval = ext2fs_xattr_inode_max_size(fs, ino, &free_ea_size);
568 retval = ext2fs_inline_data_size(fs, ino, &existing_size);
572 if (existing_size < EXT4_MIN_INLINE_DATA_SIZE)
573 free_inode_size = EXT4_MIN_INLINE_DATA_SIZE - existing_size;
577 if (size != existing_size &&
578 size > existing_size + free_ea_size + free_inode_size)
579 return EXT2_ET_INLINE_DATA_NO_SPACE;
581 memcpy((void *)inode->i_block, buf, EXT4_MIN_INLINE_DATA_SIZE);
582 retval = ext2fs_write_inode(fs, ino, inode);
587 if (size > EXT4_MIN_INLINE_DATA_SIZE)
588 data.ea_size = size - EXT4_MIN_INLINE_DATA_SIZE;
591 data.ea_data = (char *) buf + EXT4_MIN_INLINE_DATA_SIZE;
592 return ext2fs_inline_data_ea_set(&data);
599 * The length of buffer is set to 64 because in inode's i_block member it only
600 * can save 60 bytes. Thus this value can let the data being saved in extra
603 #define BUFF_SIZE (64)
605 static errcode_t file_test(ext2_filsys fs)
607 struct ext2_inode inode;
611 char *buf = 0, *cmpbuf = 0;
613 /* create a new file */
614 retval = ext2fs_new_inode(fs, 2, 010755, 0, &newfile);
616 com_err("file_test", retval, "while allocaing a new inode");
620 memset(&inode, 0, sizeof(inode));
621 inode.i_flags |= EXT4_INLINE_DATA_FL;
622 inode.i_size = EXT4_MIN_INLINE_DATA_SIZE;
623 inode.i_mode = LINUX_S_IFREG;
624 retval = ext2fs_write_new_inode(fs, newfile, &inode);
626 com_err("file_test", retval, "while writting a new inode");
630 retval = ext2fs_inline_data_init(fs, newfile);
632 com_err("file_test", retval, "while init 'system.data'");
636 retval = ext2fs_inline_data_size(fs, newfile, &size);
638 com_err("file_test", retval, "while getting size");
642 if (size != EXT4_MIN_INLINE_DATA_SIZE) {
644 "tst_inline_data: size of inline data is wrong\n");
648 ext2fs_get_mem(BUFF_SIZE, &buf);
649 memset(buf, 'a', BUFF_SIZE);
650 retval = ext2fs_inline_data_set(fs, newfile, 0, buf, BUFF_SIZE);
652 com_err("file_test", retval,
653 "while setting inline data %s", buf);
657 ext2fs_get_mem(BUFF_SIZE, &cmpbuf);
658 retval = ext2fs_inline_data_get(fs, newfile, 0, cmpbuf, &size);
660 com_err("file_test", retval, "while getting inline data");
664 if (size != BUFF_SIZE) {
666 "tst_inline_data: size %lu != buflen %u\n",
672 if (memcmp(buf, cmpbuf, BUFF_SIZE)) {
673 fprintf(stderr, "tst_inline_data: buf != cmpbuf\n");
678 retval = ext2fs_punch(fs, newfile, 0, 0, 0, ~0ULL);
680 com_err("file_test", retval, "while truncating inode");
684 /* reload inode and check isize */
685 ext2fs_read_inode(fs, newfile, &inode);
686 if (inode.i_size != 0) {
687 fprintf(stderr, "tst_inline_data: i_size should be 0\n");
693 ext2fs_free_mem(&cmpbuf);
695 ext2fs_free_mem(&buf);
699 static errcode_t dir_test(ext2_filsys fs)
701 const char *dot_name = ".";
702 const char *stub_name = "stub";
703 const char *parent_name = "test";
704 ext2_ino_t parent, dir, tmp;
706 char dirname[PATH_MAX];
709 retval = ext2fs_mkdir(fs, 11, 11, stub_name);
711 com_err("dir_test", retval, "while creating %s dir", stub_name);
715 retval = ext2fs_mkdir(fs, 11, 0, parent_name);
717 com_err("dir_test", retval,
718 "while creating %s dir", parent_name);
722 retval = ext2fs_lookup(fs, 11, parent_name, strlen(parent_name),
725 com_err("dir_test", retval,
726 "while looking up %s dir", parent_name);
730 retval = ext2fs_lookup(fs, parent, dot_name, strlen(dot_name),
733 com_err("dir_test", retval,
734 "while looking up %s dir", parent_name);
739 fprintf(stderr, "tst_inline_data: parent (%u) != tmp (%u)\n",
744 for (i = 0, dir = 13; i < 4; i++, dir++) {
746 snprintf(dirname, sizeof(dirname), "%d", i);
747 retval = ext2fs_mkdir(fs, parent, 0, dirname);
749 com_err("dir_test", retval,
750 "while creating %s dir", dirname);
754 retval = ext2fs_lookup(fs, parent, dirname, strlen(dirname),
757 com_err("dir_test", retval,
758 "while looking up %s dir", parent_name);
764 "tst_inline_data: dir (%u) != tmp (%u)\n",
770 snprintf(dirname, sizeof(dirname), "%d", i);
771 retval = ext2fs_mkdir(fs, parent, 0, dirname);
772 if (retval && retval != EXT2_ET_DIR_NO_SPACE) {
773 com_err("dir_test", retval, "while creating %s dir", dirname);
777 retval = ext2fs_expand_dir(fs, parent);
779 com_err("dir_test", retval, "while expanding %s dir", parent_name);
786 int main(int argc, char *argv[])
789 struct ext2_super_block param;
793 initialize_ext2_error_table();
795 memset(¶m, 0, sizeof(param));
796 ext2fs_blocks_count_set(¶m, 32768);
797 param.s_inodes_count = 100;
799 param.s_feature_incompat |= EXT4_FEATURE_INCOMPAT_INLINE_DATA;
800 param.s_rev_level = EXT2_DYNAMIC_REV;
801 param.s_inode_size = 256;
803 retval = ext2fs_initialize("test fs", EXT2_FLAG_64BITS, ¶m,
804 test_io_manager, &fs);
806 com_err("setup", retval,
807 "while initializing filesystem");
811 retval = ext2fs_allocate_tables(fs);
813 com_err("setup", retval,
814 "while allocating tables for test filesysmte");
818 /* initialize inode cache */
820 ext2_ino_t first_ino = EXT2_FIRST_INO(fs->super);
823 /* we just want to init inode cache. So ignore error */
824 ext2fs_create_inode_cache(fs, 16);
827 "tst_inline_data: init inode cache failed\n");
831 /* setup inode cache */
832 for (i = 0; i < fs->icache->cache_size; i++)
833 fs->icache->cache[i].ino = first_ino++;
838 fprintf(stderr, "tst_inline_data(FILE): FAILED\n");
841 printf("tst_inline_data(FILE): OK\n");
844 fprintf(stderr, "tst_inline_data(DIR): FAILED\n");
847 printf("tst_inline_data(DIR): OK\n");