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.
17 #include "ext2_ext_attr.h"
22 struct ext2_inline_data {
25 size_t ea_size; /* the size of inline data in ea area */
29 static errcode_t ext2fs_inline_data_ea_set(struct ext2_inline_data *data)
31 struct ext2_xattr_handle *handle;
34 retval = ext2fs_xattrs_open(data->fs, data->ino, &handle);
38 retval = ext2fs_xattrs_read(handle);
42 retval = ext2fs_xattr_set(handle, "system.data",
43 data->ea_data, data->ea_size);
47 retval = ext2fs_xattrs_write(handle);
50 (void) ext2fs_xattrs_close(&handle);
54 static errcode_t ext2fs_inline_data_ea_get(struct ext2_inline_data *data)
56 struct ext2_xattr_handle *handle;
62 retval = ext2fs_xattrs_open(data->fs, data->ino, &handle);
66 retval = ext2fs_xattrs_read(handle);
70 retval = ext2fs_xattr_get(handle, "system.data",
71 (void **)&data->ea_data, &data->ea_size);
76 (void) ext2fs_xattrs_close(&handle);
80 errcode_t ext2fs_inline_data_init(ext2_filsys fs, ext2_ino_t ino)
82 struct ext2_inline_data data;
88 return ext2fs_inline_data_ea_set(&data);
91 errcode_t ext2fs_inline_data_size(ext2_filsys fs, ext2_ino_t ino, size_t *size)
93 struct ext2_inode inode;
94 struct ext2_inline_data data;
97 retval = ext2fs_read_inode(fs, ino, &inode);
101 if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
102 return EXT2_ET_NO_INLINE_DATA;
106 retval = ext2fs_inline_data_ea_get(&data);
110 *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
111 return ext2fs_free_mem(&data.ea_data);
114 int ext2fs_inline_data_dir_iterate(ext2_filsys fs, ext2_ino_t ino,
117 struct dir_context *ctx;
118 struct ext2_inode inode;
119 struct ext2_dir_entry dirent;
120 struct ext2_inline_data data;
121 int ret = BLOCK_ABORT;
122 e2_blkcnt_t blockcnt = 0;
124 ctx = (struct dir_context *)priv_data;
126 ctx->errcode = ext2fs_read_inode(fs, ino, &inode);
130 if (!(inode.i_flags & EXT4_INLINE_DATA_FL)) {
131 ctx->errcode = EXT2_ET_NO_INLINE_DATA;
135 if (!LINUX_S_ISDIR(inode.i_mode)) {
136 ctx->errcode = EXT2_ET_NO_DIRECTORY;
141 /* we first check '.' and '..' dir */
144 ext2fs_set_rec_len(fs, EXT2_DIR_REC_LEN(2), &dirent);
145 dirent.name[0] = '.';
146 dirent.name[1] = '\0';
147 ctx->buf = (char *)&dirent;
148 ext2fs_get_rec_len(fs, &dirent, &ctx->buflen);
149 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
150 if (ret & BLOCK_ABORT)
153 dirent.inode = ext2fs_le32_to_cpu(inode.i_block[0]);
155 ext2fs_set_rec_len(fs, EXT2_DIR_REC_LEN(3), &dirent);
156 dirent.name[0] = '.';
157 dirent.name[1] = '.';
158 dirent.name[2] = '\0';
159 ctx->buf = (char *)&dirent;
160 ext2fs_get_rec_len(fs, &dirent, &ctx->buflen);
161 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
162 if (ret & BLOCK_INLINE_DATA_CHANGED) {
165 inode.i_block[0] = ext2fs_cpu_to_le32(dirent.inode);
166 err = ext2fs_write_inode(fs, ino, &inode);
169 ret &= ~BLOCK_INLINE_DATA_CHANGED;
171 if (ret & BLOCK_ABORT)
174 ctx->buf = (char *)inode.i_block + EXT4_INLINE_DATA_DOTDOT_SIZE;
175 ctx->buflen = EXT4_MIN_INLINE_DATA_SIZE - EXT4_INLINE_DATA_DOTDOT_SIZE;
176 #ifdef WORDS_BIGENDIAN
177 ctx->errcode = ext2fs_dirent_swab_in2(fs, ctx->buf, ctx->buflen, 0);
183 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
184 if (ret & BLOCK_INLINE_DATA_CHANGED) {
185 #ifdef WORDS_BIGENDIAN
186 ctx->errcode = ext2fs_dirent_swab_out2(fs, ctx->buf,
193 ctx->errcode = ext2fs_write_inode(fs, ino, &inode);
196 ret &= ~BLOCK_INLINE_DATA_CHANGED;
198 if (ret & BLOCK_ABORT)
203 ctx->errcode = ext2fs_inline_data_ea_get(&data);
208 if (data.ea_size <= 0)
211 ctx->buf = data.ea_data;
212 ctx->buflen = data.ea_size;
213 #ifdef WORDS_BIGENDIAN
214 ctx.errcode = ext2fs_dirent_swab_in2(fs, ctx->buf, ctx->buflen, 0);
221 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
222 if (ret & BLOCK_INLINE_DATA_CHANGED) {
223 #ifdef WORDS_BIGENDIAN
224 ctx->errcode = ext2fs_dirent_swab_out2(fs, ctx->buf,
231 ctx->errcode = ext2fs_inline_data_ea_set(&data);
237 ext2fs_free_mem(&data.ea_data);
241 ret &= ~(BLOCK_ABORT | BLOCK_INLINE_DATA_CHANGED);
245 errcode_t ext2fs_inline_data_ea_remove(ext2_filsys fs, ext2_ino_t ino)
247 struct ext2_xattr_handle *handle;
250 retval = ext2fs_xattrs_open(fs, ino, &handle);
254 retval = ext2fs_xattrs_read(handle);
258 retval = ext2fs_xattr_remove(handle, "system.data");
262 retval = ext2fs_xattrs_write(handle);
265 (void) ext2fs_xattrs_close(&handle);
269 static errcode_t ext2fs_inline_data_convert_dir(ext2_filsys fs, ext2_ino_t ino,
270 char *bbuf, char *ibuf, int size)
272 struct ext2_dir_entry *dir, *dir2;
273 struct ext2_dir_entry_tail *t;
280 if (EXT2_HAS_RO_COMPAT_FEATURE(fs->super,
281 EXT4_FEATURE_RO_COMPAT_METADATA_CSUM))
282 csum_size = sizeof(struct ext2_dir_entry_tail);
284 /* Create '.' and '..' */
285 if (EXT2_HAS_INCOMPAT_FEATURE(fs->super,
286 EXT2_FEATURE_INCOMPAT_FILETYPE))
287 filetype = EXT2_FT_DIR;
290 * Set up entry for '.'
292 dir = (struct ext2_dir_entry *) bbuf;
294 ext2fs_dirent_set_name_len(dir, 1);
295 ext2fs_dirent_set_file_type(dir, filetype);
297 rec_len = (fs->blocksize - csum_size) - EXT2_DIR_REC_LEN(1);
298 dir->rec_len = EXT2_DIR_REC_LEN(1);
301 * Set up entry for '..'
303 dir = (struct ext2_dir_entry *) (bbuf + dir->rec_len);
304 dir->rec_len = EXT2_DIR_REC_LEN(2);
305 dir->inode = ext2fs_le32_to_cpu(((__u32 *)ibuf)[0]);
306 ext2fs_dirent_set_name_len(dir, 2);
307 ext2fs_dirent_set_file_type(dir, filetype);
312 * Ajust the last rec_len
314 offset = EXT2_DIR_REC_LEN(1) + EXT2_DIR_REC_LEN(2);
315 dir = (struct ext2_dir_entry *) (bbuf + offset);
316 memcpy(bbuf + offset, ibuf + EXT4_INLINE_DATA_DOTDOT_SIZE,
317 size - EXT4_INLINE_DATA_DOTDOT_SIZE);
318 size += EXT2_DIR_REC_LEN(1) + EXT2_DIR_REC_LEN(2) -
319 EXT4_INLINE_DATA_DOTDOT_SIZE;
323 retval = ext2fs_get_rec_len(fs, dir, &rec_len);
327 dir = (struct ext2_dir_entry *) (bbuf + offset);
328 } while (offset < size);
329 rec_len += fs->blocksize - csum_size - offset;
330 retval = ext2fs_set_rec_len(fs, rec_len, dir2);
335 t = EXT2_DIRENT_TAIL(bbuf, fs->blocksize);
336 ext2fs_initialize_dirent_tail(fs, t);
344 ext2fs_inline_data_dir_expand(ext2_filsys fs, ext2_ino_t ino,
345 struct ext2_inode *inode, char *buf, size_t size)
351 retval = ext2fs_get_memzero(fs->blocksize, &blk_buf);
355 #ifdef WORDS_BIGENDIAN
356 retval = ext2fs_dirent_swab_in2(fs, buf, size);
361 /* Adjust the rec_len */
362 retval = ext2fs_inline_data_convert_dir(fs, ino, blk_buf, buf, size);
363 /* Allocate a new block */
364 retval = ext2fs_new_block2(fs, 0, 0, &blk);
367 retval = ext2fs_write_dir_block4(fs, blk, blk_buf, 0, ino);
372 if (EXT2_HAS_INCOMPAT_FEATURE(fs->super, EXT3_FEATURE_INCOMPAT_EXTENTS))
373 inode->i_flags |= EXT4_EXTENTS_FL;
374 inode->i_flags &= ~EXT4_INLINE_DATA_FL;
375 ext2fs_iblk_set(fs, inode, 1);
376 inode->i_size = fs->blocksize;
377 retval = ext2fs_bmap2(fs, ino, inode, 0, BMAP_SET, 0, 0, &blk);
380 retval = ext2fs_write_inode(fs, ino, inode);
383 ext2fs_block_alloc_stats(fs, blk, +1);
386 ext2fs_free_mem(&blk_buf);
391 ext2fs_inline_data_file_expand(ext2_filsys fs, ext2_ino_t ino,
392 struct ext2_inode *inode, char *buf, size_t size)
398 if (EXT2_HAS_INCOMPAT_FEATURE(fs->super,
399 EXT3_FEATURE_INCOMPAT_EXTENTS)) {
401 struct ext3_extent_header *eh;
403 eh = (struct ext3_extent_header *) &inode->i_block[0];
406 eh->eh_magic = EXT3_EXT_MAGIC;
407 i = (sizeof(inode->i_block) - sizeof(*eh)) /
408 sizeof(struct ext3_extent);
409 eh->eh_max = ext2fs_cpu_to_le16(i);
410 inode->i_flags |= EXT4_EXTENTS_FL;
412 inode->i_flags &= ~EXT4_INLINE_DATA_FL;
413 ext2fs_iblk_set(fs, inode, 0);
415 retval = ext2fs_write_inode(fs, ino, inode);
419 /* Write out the block buffer */
420 retval = ext2fs_file_open(fs, ino, EXT2_FILE_WRITE, &e2_file);
423 retval = ext2fs_file_write(e2_file, buf, size, 0);
424 ext2fs_file_close(e2_file);
428 errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino)
430 struct ext2_inode inode;
431 struct ext2_inline_data data;
434 char *inline_buf = 0;
436 EXT2_CHECK_MAGIC(fs, EXT2_ET_MAGIC_EXT2FS_FILSYS);
438 retval = ext2fs_read_inode(fs, ino, &inode);
442 if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
443 return EXT2_ET_NO_INLINE_DATA;
447 retval = ext2fs_inline_data_ea_get(&data);
450 inline_size = data.ea_size + EXT4_MIN_INLINE_DATA_SIZE;
451 retval = ext2fs_get_mem(inline_size, &inline_buf);
455 memcpy(inline_buf, (void *)inode.i_block, EXT4_MIN_INLINE_DATA_SIZE);
456 if (data.ea_size > 0) {
457 memcpy(inline_buf + EXT4_MIN_INLINE_DATA_SIZE,
458 data.ea_data, data.ea_size);
461 memset((void *)inode.i_block, 0, EXT4_MIN_INLINE_DATA_SIZE);
462 retval = ext2fs_inline_data_ea_remove(fs, ino);
466 if (LINUX_S_ISDIR(inode.i_mode)) {
467 retval = ext2fs_inline_data_dir_expand(fs, ino, &inode,
468 inline_buf, inline_size);
470 retval = ext2fs_inline_data_file_expand(fs, ino, &inode,
471 inline_buf, inline_size);
476 ext2fs_free_mem(&inline_buf);
477 ext2fs_free_mem(&data.ea_data);
482 * When caller uses this function to retrieve the inline data, it must
483 * allocate a buffer which has the size of inline data. The size of
484 * inline data can be know by ext2fs_inline_data_get_size().
486 errcode_t ext2fs_inline_data_get(ext2_filsys fs, ext2_ino_t ino,
487 struct ext2_inode *inode,
488 void *buf, size_t *size)
490 struct ext2_inode inode_buf;
491 struct ext2_inline_data data;
495 retval = ext2fs_read_inode(fs, ino, &inode_buf);
503 retval = ext2fs_inline_data_ea_get(&data);
507 memcpy(buf, (void *)inode->i_block, EXT4_MIN_INLINE_DATA_SIZE);
508 if (data.ea_size > 0)
509 memcpy(buf + EXT4_MIN_INLINE_DATA_SIZE,
510 data.ea_data, data.ea_size);
513 *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
514 ext2fs_free_mem(&data.ea_data);
518 errcode_t ext2fs_inline_data_set(ext2_filsys fs, ext2_ino_t ino,
519 struct ext2_inode *inode,
520 void *buf, size_t size)
522 struct ext2_inode inode_buf;
523 struct ext2_inline_data data;
525 size_t free_ea_size, existing_size, free_inode_size;
528 retval = ext2fs_read_inode(fs, ino, &inode_buf);
534 if (size <= EXT4_MIN_INLINE_DATA_SIZE) {
535 memcpy((void *)inode->i_block, buf, size);
536 return ext2fs_write_inode(fs, ino, inode);
539 retval = ext2fs_xattr_inode_max_size(fs, ino, &free_ea_size);
543 retval = ext2fs_inline_data_size(fs, ino, &existing_size);
547 if (existing_size < EXT4_MIN_INLINE_DATA_SIZE)
548 free_inode_size = EXT4_MIN_INLINE_DATA_SIZE - existing_size;
552 if (size > existing_size + free_ea_size + free_inode_size)
553 return EXT2_ET_INLINE_DATA_NO_SPACE;
555 memcpy((void *)inode->i_block, buf, EXT4_MIN_INLINE_DATA_SIZE);
556 retval = ext2fs_write_inode(fs, ino, inode);
561 data.ea_size = size - EXT4_MIN_INLINE_DATA_SIZE;
562 data.ea_data = buf + EXT4_MIN_INLINE_DATA_SIZE;
563 return ext2fs_inline_data_ea_set(&data);
570 * The length of buffer is set to 64 because in inode's i_block member it only
571 * can save 60 bytes. Thus this value can let the data being saved in extra
574 #define BUFF_SIZE (64)
576 static errcode_t file_test(ext2_filsys fs)
578 struct ext2_inode inode;
582 char *buf = 0, *cmpbuf = 0;
585 /* create a new file */
586 retval = ext2fs_new_inode(fs, 2, 010755, 0, &newfile);
588 com_err("file_test", retval, "while allocaing a new inode");
592 memset(&inode, 0, sizeof(inode));
593 inode.i_flags |= EXT4_INLINE_DATA_FL;
594 inode.i_size = EXT4_MIN_INLINE_DATA_SIZE;
595 inode.i_mode = LINUX_S_IFREG;
596 retval = ext2fs_write_new_inode(fs, newfile, &inode);
598 com_err("file_test", retval, "while writting a new inode");
602 retval = ext2fs_inline_data_init(fs, newfile);
604 com_err("file_test", retval, "while init 'system.data'");
608 retval = ext2fs_inline_data_size(fs, newfile, &size);
610 com_err("file_test", retval, "while getting size");
614 if (size != EXT4_MIN_INLINE_DATA_SIZE) {
616 "tst_inline_data: size of inline data is wrong\n");
620 ext2fs_get_mem(BUFF_SIZE, &buf);
621 memset(buf, 'a', BUFF_SIZE);
622 retval = ext2fs_inline_data_set(fs, newfile, 0, buf, BUFF_SIZE);
624 com_err("file_test", retval,
625 "while setting inline data %s", buf);
629 ext2fs_get_mem(BUFF_SIZE, &cmpbuf);
630 retval = ext2fs_inline_data_get(fs, newfile, 0, cmpbuf, &size);
632 com_err("file_test", retval, "while getting inline data");
636 if (size != BUFF_SIZE) {
638 "tst_inline_data: size %lu != buflen %lu\n",
644 if (memcmp(buf, cmpbuf, BUFF_SIZE)) {
645 fprintf(stderr, "tst_inline_data: buf != cmpbuf\n");
650 retval = ext2fs_punch(fs, newfile, 0, 0, 0, ~0ULL);
652 com_err("file_test", retval, "while truncating inode");
656 /* reload inode and check isize */
657 ext2fs_read_inode(fs, newfile, &inode);
658 if (inode.i_size != 0) {
659 fprintf(stderr, "tst_inline_data: i_size should be 0\n");
665 ext2fs_free_mem(&cmpbuf);
667 ext2fs_free_mem(&buf);
671 static errcode_t dir_test(ext2_filsys fs)
673 const char *dot_name = ".";
674 const char *stub_name = "stub";
675 const char *parent_name = "test";
676 ext2_ino_t parent, dir, tmp;
678 char dirname[PATH_MAX];
681 retval = ext2fs_mkdir(fs, 11, 11, stub_name);
683 com_err("dir_test", retval, "while creating %s dir", stub_name);
687 retval = ext2fs_mkdir(fs, 11, 0, parent_name);
689 com_err("dir_test", retval,
690 "while creating %s dir", parent_name);
694 retval = ext2fs_lookup(fs, 11, parent_name, strlen(parent_name),
697 com_err("dir_test", retval,
698 "while looking up %s dir", parent_name);
702 retval = ext2fs_lookup(fs, parent, dot_name, strlen(dot_name),
705 com_err("dir_test", retval,
706 "while looking up %s dir", parent_name);
711 fprintf(stderr, "tst_inline_data: parent (%lu) != tmp (%lu)\n",
716 for (i = 0, dir = 13; i < 4; i++, dir++) {
718 snprintf(dirname, PATH_MAX, "%d", i);
719 retval = ext2fs_mkdir(fs, parent, 0, dirname);
721 com_err("dir_test", retval,
722 "while creating %s dir", dirname);
726 retval = ext2fs_lookup(fs, parent, dirname, strlen(dirname),
729 com_err("dir_test", retval,
730 "while looking up %s dir", parent_name);
735 fprintf(stderr, "tst_inline_data: dir (%lu) != tmp (%lu)\n",
741 snprintf(dirname, PATH_MAX, "%d", i);
742 retval = ext2fs_mkdir(fs, parent, 0, dirname);
743 if (retval && retval != EXT2_ET_DIR_NO_SPACE) {
744 com_err("dir_test", retval, "while creating %s dir", dirname);
748 retval = ext2fs_expand_dir(fs, parent);
750 com_err("dir_test", retval, "while expanding %s dir", parent_name);
757 int main(int argc, char *argv[])
760 struct ext2_super_block param;
765 initialize_ext2_error_table();
767 memset(¶m, 0, sizeof(param));
768 ext2fs_blocks_count_set(¶m, 32768);
769 param.s_inodes_count = 100;
771 param.s_feature_incompat |= EXT4_FEATURE_INCOMPAT_INLINE_DATA;
772 param.s_rev_level = EXT2_DYNAMIC_REV;
773 param.s_inode_size = 256;
775 retval = ext2fs_initialize("test fs", EXT2_FLAG_64BITS, ¶m,
776 test_io_manager, &fs);
778 com_err("setup", retval,
779 "while initializing filesystem");
783 retval = ext2fs_allocate_tables(fs);
785 com_err("setup", retval,
786 "while allocating tables for test filesysmte");
790 /* initialize inode cache */
792 struct ext2_inode inode;
793 ext2_ino_t first_ino = EXT2_FIRST_INO(fs->super);
796 /* we just want to init inode cache. So ignore error */
797 ext2fs_create_inode_cache(fs, 16);
800 "tst_inline_data: init inode cache failed\n");
804 /* setup inode cache */
805 for (i = 0; i < fs->icache->cache_size; i++)
806 fs->icache->cache[i].ino = first_ino++;
811 fprintf(stderr, "tst_inline_data(FILE): FAILED\n");
814 printf("tst_inline_data(FILE): OK\n");
817 fprintf(stderr, "tst_inline_data(DIR): FAILED\n");
820 printf("tst_inline_data(DIR): OK\n");