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);
46 (void) ext2fs_xattrs_close(&handle);
50 static errcode_t ext2fs_inline_data_ea_get(struct ext2_inline_data *data)
52 struct ext2_xattr_handle *handle;
58 retval = ext2fs_xattrs_open(data->fs, data->ino, &handle);
62 retval = ext2fs_xattrs_read(handle);
66 retval = ext2fs_xattr_get(handle, "system.data",
67 (void **)&data->ea_data, &data->ea_size);
68 if (retval == EXT2_ET_EA_KEY_NOT_FOUND) {
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;
83 char empty[1] = { '\0' };
89 return ext2fs_inline_data_ea_set(&data);
92 errcode_t ext2fs_inline_data_size(ext2_filsys fs, ext2_ino_t ino, size_t *size)
94 struct ext2_inode inode;
95 struct ext2_inline_data data;
98 retval = ext2fs_read_inode(fs, ino, &inode);
102 if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
103 return EXT2_ET_NO_INLINE_DATA;
107 retval = ext2fs_inline_data_ea_get(&data);
111 *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
112 return ext2fs_free_mem(&data.ea_data);
115 int ext2fs_inline_data_dir_iterate(ext2_filsys fs, ext2_ino_t ino,
118 struct dir_context *ctx;
119 struct ext2_inode inode;
120 struct ext2_dir_entry dirent;
121 struct ext2_inline_data data;
122 int ret = BLOCK_ABORT;
123 e2_blkcnt_t blockcnt = 0;
125 unsigned int old_buflen;
128 ctx = (struct dir_context *)priv_data;
130 old_buflen = ctx->buflen;
131 old_flags = ctx->flags;
132 ctx->flags |= DIRENT_FLAG_INCLUDE_INLINE_DATA;
134 ctx->errcode = ext2fs_read_inode(fs, ino, &inode);
138 if (!(inode.i_flags & EXT4_INLINE_DATA_FL)) {
139 ctx->errcode = EXT2_ET_NO_INLINE_DATA;
143 if (!LINUX_S_ISDIR(inode.i_mode)) {
144 ctx->errcode = EXT2_ET_NO_DIRECTORY;
149 /* we first check '.' and '..' dir */
152 ext2fs_set_rec_len(fs, EXT2_DIR_REC_LEN(2), &dirent);
153 dirent.name[0] = '.';
154 dirent.name[1] = '\0';
155 ctx->buf = (char *)&dirent;
156 ext2fs_get_rec_len(fs, &dirent, &ctx->buflen);
157 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
158 if (ret & BLOCK_ABORT)
161 dirent.inode = ext2fs_le32_to_cpu(inode.i_block[0]);
163 ext2fs_set_rec_len(fs, EXT2_DIR_REC_LEN(3), &dirent);
164 dirent.name[0] = '.';
165 dirent.name[1] = '.';
166 dirent.name[2] = '\0';
167 ctx->buf = (char *)&dirent;
168 ext2fs_get_rec_len(fs, &dirent, &ctx->buflen);
169 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
170 if (ret & BLOCK_INLINE_DATA_CHANGED) {
173 inode.i_block[0] = ext2fs_cpu_to_le32(dirent.inode);
174 err = ext2fs_write_inode(fs, ino, &inode);
177 ret &= ~BLOCK_INLINE_DATA_CHANGED;
179 if (ret & BLOCK_ABORT)
182 ctx->buf = (char *)inode.i_block + EXT4_INLINE_DATA_DOTDOT_SIZE;
183 ctx->buflen = EXT4_MIN_INLINE_DATA_SIZE - EXT4_INLINE_DATA_DOTDOT_SIZE;
184 #ifdef WORDS_BIGENDIAN
185 ctx->errcode = ext2fs_dirent_swab_in2(fs, ctx->buf, ctx->buflen, 0);
191 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
192 if (ret & BLOCK_INLINE_DATA_CHANGED) {
193 #ifdef WORDS_BIGENDIAN
194 ctx->errcode = ext2fs_dirent_swab_out2(fs, ctx->buf,
201 ctx->errcode = ext2fs_write_inode(fs, ino, &inode);
204 ret &= ~BLOCK_INLINE_DATA_CHANGED;
206 if (ret & BLOCK_ABORT)
211 ctx->errcode = ext2fs_inline_data_ea_get(&data);
216 if (data.ea_size <= 0)
219 ctx->buf = data.ea_data;
220 ctx->buflen = data.ea_size;
221 #ifdef WORDS_BIGENDIAN
222 ctx->errcode = ext2fs_dirent_swab_in2(fs, ctx->buf, ctx->buflen, 0);
229 ret |= ext2fs_process_dir_block(fs, 0, blockcnt++, 0, 0, priv_data);
230 if (ret & BLOCK_INLINE_DATA_CHANGED) {
231 #ifdef WORDS_BIGENDIAN
232 ctx->errcode = ext2fs_dirent_swab_out2(fs, ctx->buf,
239 ctx->errcode = ext2fs_inline_data_ea_set(&data);
245 ext2fs_free_mem(&data.ea_data);
248 ctx->buflen = old_buflen;
249 ctx->flags = old_flags;
250 ret &= ~(BLOCK_ABORT | BLOCK_INLINE_DATA_CHANGED);
254 errcode_t ext2fs_inline_data_ea_remove(ext2_filsys fs, ext2_ino_t ino)
256 struct ext2_xattr_handle *handle;
259 retval = ext2fs_xattrs_open(fs, ino, &handle);
263 retval = ext2fs_xattrs_read(handle);
267 retval = ext2fs_xattr_remove(handle, "system.data");
269 (void) ext2fs_xattrs_close(&handle);
273 static errcode_t ext2fs_inline_data_convert_dir(ext2_filsys fs, ext2_ino_t ino,
274 char *bbuf, char *ibuf, int size)
276 struct ext2_dir_entry *dir, *dir2;
277 struct ext2_dir_entry_tail *t;
280 unsigned int rec_len;
284 if (ext2fs_has_feature_metadata_csum(fs->super))
285 csum_size = sizeof(struct ext2_dir_entry_tail);
287 /* Create '.' and '..' */
288 if (ext2fs_has_feature_filetype(fs->super))
289 filetype = EXT2_FT_DIR;
292 * Set up entry for '.'
294 dir = (struct ext2_dir_entry *) bbuf;
296 ext2fs_dirent_set_name_len(dir, 1);
297 ext2fs_dirent_set_file_type(dir, filetype);
299 rec_len = (fs->blocksize - csum_size) - EXT2_DIR_REC_LEN(1);
300 dir->rec_len = EXT2_DIR_REC_LEN(1);
303 * Set up entry for '..'
305 dir = (struct ext2_dir_entry *) (bbuf + dir->rec_len);
306 dir->rec_len = EXT2_DIR_REC_LEN(2);
307 dir->inode = ext2fs_le32_to_cpu(((__u32 *)ibuf)[0]);
308 ext2fs_dirent_set_name_len(dir, 2);
309 ext2fs_dirent_set_file_type(dir, filetype);
314 * Adjust the last rec_len
316 offset = EXT2_DIR_REC_LEN(1) + EXT2_DIR_REC_LEN(2);
317 dir = (struct ext2_dir_entry *) (bbuf + offset);
318 memcpy(bbuf + offset, ibuf + EXT4_INLINE_DATA_DOTDOT_SIZE,
319 size - EXT4_INLINE_DATA_DOTDOT_SIZE);
320 size += EXT2_DIR_REC_LEN(1) + EXT2_DIR_REC_LEN(2) -
321 EXT4_INLINE_DATA_DOTDOT_SIZE;
325 retval = ext2fs_get_rec_len(fs, dir, &rec_len);
329 dir = (struct ext2_dir_entry *) (bbuf + offset);
330 } while (offset < size);
331 rec_len += fs->blocksize - csum_size - offset;
332 retval = ext2fs_set_rec_len(fs, rec_len, dir2);
337 t = EXT2_DIRENT_TAIL(bbuf, fs->blocksize);
338 ext2fs_initialize_dirent_tail(fs, t);
346 ext2fs_inline_data_dir_expand(ext2_filsys fs, ext2_ino_t ino,
347 struct ext2_inode *inode, char *buf, size_t size)
353 retval = ext2fs_get_memzero(fs->blocksize, &blk_buf);
357 #ifdef WORDS_BIGENDIAN
358 retval = ext2fs_dirent_swab_in2(fs, buf + EXT4_INLINE_DATA_DOTDOT_SIZE,
364 /* Adjust the rec_len */
365 retval = ext2fs_inline_data_convert_dir(fs, ino, blk_buf, buf, size);
368 /* Allocate a new block */
369 retval = ext2fs_new_block2(fs, 0, 0, &blk);
372 retval = ext2fs_write_dir_block4(fs, blk, blk_buf, 0, ino);
377 if (ext2fs_has_feature_extents(fs->super))
378 inode->i_flags |= EXT4_EXTENTS_FL;
379 inode->i_flags &= ~EXT4_INLINE_DATA_FL;
380 retval = ext2fs_iblk_add_blocks(fs, inode, 1);
383 inode->i_size = fs->blocksize;
384 retval = ext2fs_bmap2(fs, ino, inode, 0, BMAP_SET, 0, 0, &blk);
387 retval = ext2fs_write_inode(fs, ino, inode);
390 ext2fs_block_alloc_stats(fs, blk, +1);
393 ext2fs_free_mem(&blk_buf);
398 ext2fs_inline_data_file_expand(ext2_filsys fs, ext2_ino_t ino,
399 struct ext2_inode *inode, char *buf, size_t size)
405 memset(inode->i_block, 0, sizeof(inode->i_block));
406 if (ext2fs_has_feature_extents(fs->super)) {
407 ext2_extent_handle_t handle;
409 inode->i_flags &= ~EXT4_EXTENTS_FL;
410 retval = ext2fs_extent_open2(fs, ino, inode, &handle);
413 ext2fs_extent_free(handle);
415 inode->i_flags &= ~EXT4_INLINE_DATA_FL;
417 retval = ext2fs_write_inode(fs, ino, inode);
421 /* Write out the block buffer */
422 retval = ext2fs_file_open(fs, ino, EXT2_FILE_WRITE, &e2_file);
425 retval = ext2fs_file_write(e2_file, buf, size, 0);
426 ext2fs_file_close(e2_file);
430 errcode_t ext2fs_inline_data_expand(ext2_filsys fs, ext2_ino_t ino)
432 struct ext2_inode inode;
433 struct ext2_inline_data data;
436 char *inline_buf = 0;
438 EXT2_CHECK_MAGIC(fs, EXT2_ET_MAGIC_EXT2FS_FILSYS);
440 retval = ext2fs_read_inode(fs, ino, &inode);
444 if (!(inode.i_flags & EXT4_INLINE_DATA_FL))
445 return EXT2_ET_NO_INLINE_DATA;
449 retval = ext2fs_inline_data_ea_get(&data);
452 inline_size = data.ea_size + EXT4_MIN_INLINE_DATA_SIZE;
453 retval = ext2fs_get_mem(inline_size, &inline_buf);
457 memcpy(inline_buf, (void *)inode.i_block, EXT4_MIN_INLINE_DATA_SIZE);
458 if (data.ea_size > 0) {
459 memcpy(inline_buf + EXT4_MIN_INLINE_DATA_SIZE,
460 data.ea_data, data.ea_size);
463 memset((void *)inode.i_block, 0, EXT4_MIN_INLINE_DATA_SIZE);
465 * NOTE: We must do this write -> ea_remove -> read cycle here because
466 * removing the inline data EA can free the EA block, which is a change
467 * that our stack copy of the inode will never see. If that happens,
468 * we can end up with the EA block and lblk 0 pointing to the same
469 * pblk, which is bad news.
471 retval = ext2fs_write_inode(fs, ino, &inode);
474 retval = ext2fs_inline_data_ea_remove(fs, ino);
477 retval = ext2fs_read_inode(fs, ino, &inode);
481 if (LINUX_S_ISDIR(inode.i_mode)) {
482 retval = ext2fs_inline_data_dir_expand(fs, ino, &inode,
483 inline_buf, inline_size);
485 retval = ext2fs_inline_data_file_expand(fs, ino, &inode,
486 inline_buf, inline_size);
491 ext2fs_free_mem(&inline_buf);
492 ext2fs_free_mem(&data.ea_data);
497 * When caller uses this function to retrieve the inline data, it must
498 * allocate a buffer which has the size of inline data. The size of
499 * inline data can be know by ext2fs_inline_data_get_size().
501 errcode_t ext2fs_inline_data_get(ext2_filsys fs, ext2_ino_t ino,
502 struct ext2_inode *inode,
503 void *buf, size_t *size)
505 struct ext2_inode inode_buf;
506 struct ext2_inline_data data;
510 retval = ext2fs_read_inode(fs, ino, &inode_buf);
518 retval = ext2fs_inline_data_ea_get(&data);
522 memcpy(buf, (void *)inode->i_block, EXT4_MIN_INLINE_DATA_SIZE);
523 if (data.ea_size > 0)
524 memcpy((char *) buf + EXT4_MIN_INLINE_DATA_SIZE,
525 data.ea_data, data.ea_size);
528 *size = EXT4_MIN_INLINE_DATA_SIZE + data.ea_size;
529 ext2fs_free_mem(&data.ea_data);
533 errcode_t ext2fs_inline_data_set(ext2_filsys fs, ext2_ino_t ino,
534 struct ext2_inode *inode,
535 void *buf, size_t size)
537 struct ext2_inode inode_buf;
538 struct ext2_inline_data data = {
543 size_t free_ea_size, existing_size, free_inode_size;
546 retval = ext2fs_read_inode(fs, ino, &inode_buf);
552 if (size <= EXT4_MIN_INLINE_DATA_SIZE) {
553 memcpy((void *)inode->i_block, buf, size);
555 retval = ext2fs_xattr_inode_max_size(fs, ino, &free_ea_size);
559 retval = ext2fs_inline_data_size(fs, ino, &existing_size);
563 if (existing_size < EXT4_MIN_INLINE_DATA_SIZE) {
564 free_inode_size = EXT4_MIN_INLINE_DATA_SIZE -
570 if (size != existing_size &&
571 size > existing_size + free_ea_size + free_inode_size)
572 return EXT2_ET_INLINE_DATA_NO_SPACE;
574 memcpy((void *)inode->i_block, buf, EXT4_MIN_INLINE_DATA_SIZE);
575 if (size > EXT4_MIN_INLINE_DATA_SIZE)
576 data.ea_size = size - EXT4_MIN_INLINE_DATA_SIZE;
577 data.ea_data = (char *) buf + EXT4_MIN_INLINE_DATA_SIZE;
579 retval = ext2fs_write_inode(fs, ino, inode);
582 return ext2fs_inline_data_ea_set(&data);
589 * The length of buffer is set to 64 because in inode's i_block member it only
590 * can save 60 bytes. Thus this value can let the data being saved in extra
593 #define BUFF_SIZE (64)
595 static errcode_t file_test(ext2_filsys fs)
597 struct ext2_inode inode;
601 char *buf = 0, *cmpbuf = 0;
603 /* create a new file */
604 retval = ext2fs_new_inode(fs, 2, 010755, 0, &newfile);
606 com_err("file_test", retval, "while allocating a new inode");
610 memset(&inode, 0, sizeof(inode));
611 inode.i_flags |= EXT4_INLINE_DATA_FL;
612 inode.i_size = EXT4_MIN_INLINE_DATA_SIZE;
613 inode.i_mode = LINUX_S_IFREG;
614 retval = ext2fs_write_new_inode(fs, newfile, &inode);
616 com_err("file_test", retval, "while writing a new inode");
620 retval = ext2fs_inline_data_init(fs, newfile);
622 com_err("file_test", retval, "while init 'system.data'");
626 retval = ext2fs_inline_data_size(fs, newfile, &size);
628 com_err("file_test", retval, "while getting size");
632 if (size != EXT4_MIN_INLINE_DATA_SIZE) {
634 "tst_inline_data: size of inline data is wrong\n");
638 ext2fs_get_mem(BUFF_SIZE, &buf);
639 memset(buf, 'a', BUFF_SIZE);
640 retval = ext2fs_inline_data_set(fs, newfile, 0, buf, BUFF_SIZE);
642 com_err("file_test", retval,
643 "while setting inline data %s", buf);
647 ext2fs_get_mem(BUFF_SIZE, &cmpbuf);
648 retval = ext2fs_inline_data_get(fs, newfile, 0, cmpbuf, &size);
650 com_err("file_test", retval, "while getting inline data");
654 if (size != BUFF_SIZE) {
656 "tst_inline_data: size %lu != buflen %u\n",
662 if (memcmp(buf, cmpbuf, BUFF_SIZE)) {
663 fprintf(stderr, "tst_inline_data: buf != cmpbuf\n");
668 retval = ext2fs_punch(fs, newfile, 0, 0, 0, ~0ULL);
670 com_err("file_test", retval, "while truncating inode");
674 /* reload inode and check isize */
675 ext2fs_read_inode(fs, newfile, &inode);
676 if (inode.i_size != 0) {
677 fprintf(stderr, "tst_inline_data: i_size should be 0\n");
683 ext2fs_free_mem(&cmpbuf);
685 ext2fs_free_mem(&buf);
689 static errcode_t dir_test(ext2_filsys fs)
691 const char *dot_name = ".";
692 const char *stub_name = "stub";
693 const char *parent_name = "test";
694 ext2_ino_t parent, dir, tmp;
699 retval = ext2fs_mkdir(fs, 11, 11, stub_name);
701 com_err("dir_test", retval, "while creating %s dir", stub_name);
705 retval = ext2fs_mkdir(fs, 11, 0, parent_name);
707 com_err("dir_test", retval,
708 "while creating %s dir", parent_name);
712 retval = ext2fs_lookup(fs, 11, parent_name, strlen(parent_name),
715 com_err("dir_test", retval,
716 "while looking up %s dir", parent_name);
720 retval = ext2fs_lookup(fs, parent, dot_name, strlen(dot_name),
723 com_err("dir_test", retval,
724 "while looking up %s dir", parent_name);
729 fprintf(stderr, "tst_inline_data: parent (%u) != tmp (%u)\n",
734 for (i = 0, dir = 13; i < 4; i++, dir++) {
736 snprintf(dirname, sizeof(dirname), "%d", i);
737 retval = ext2fs_mkdir(fs, parent, 0, dirname);
739 com_err("dir_test", retval,
740 "while creating %s dir", dirname);
744 retval = ext2fs_lookup(fs, parent, dirname, strlen(dirname),
747 com_err("dir_test", retval,
748 "while looking up %s dir", parent_name);
754 "tst_inline_data: dir (%u) != tmp (%u)\n",
760 snprintf(dirname, sizeof(dirname), "%d", i);
761 retval = ext2fs_mkdir(fs, parent, 0, dirname);
762 if (retval && retval != EXT2_ET_DIR_NO_SPACE) {
763 com_err("dir_test", retval, "while creating %s dir", dirname);
767 retval = ext2fs_expand_dir(fs, parent);
769 com_err("dir_test", retval, "while expanding %s dir", parent_name);
776 int main(int argc, char *argv[])
779 struct ext2_super_block param;
783 initialize_ext2_error_table();
785 memset(¶m, 0, sizeof(param));
786 ext2fs_blocks_count_set(¶m, 32768);
787 param.s_inodes_count = 100;
789 param.s_feature_incompat |= EXT4_FEATURE_INCOMPAT_INLINE_DATA;
790 param.s_rev_level = EXT2_DYNAMIC_REV;
791 param.s_inode_size = 256;
793 retval = ext2fs_initialize("test fs", EXT2_FLAG_64BITS, ¶m,
794 test_io_manager, &fs);
796 com_err("setup", retval,
797 "while initializing filesystem");
801 retval = ext2fs_allocate_tables(fs);
803 com_err("setup", retval,
804 "while allocating tables for test filesystem");
808 /* initialize inode cache */
810 ext2_ino_t first_ino = EXT2_FIRST_INO(fs->super);
813 /* we just want to init inode cache. So ignore error */
814 ext2fs_create_inode_cache(fs, 16);
817 "tst_inline_data: init inode cache failed\n");
821 /* setup inode cache */
822 for (i = 0; i < fs->icache->cache_size; i++)
823 fs->icache->cache[i].ino = first_ino++;
828 fprintf(stderr, "tst_inline_data(FILE): FAILED\n");
831 printf("tst_inline_data(FILE): OK\n");
834 fprintf(stderr, "tst_inline_data(DIR): FAILED\n");
837 printf("tst_inline_data(DIR): OK\n");