Lwext4

Files
file	ext4_xattr.h
	Extended Attribute manipulation.

Classes
struct	ext4_xattr_header
struct	ext4_xattr_ibody_header
struct	ext4_xattr_entry
struct	ext4_xattr_item
struct	ext4_xattr_ref

Macros
#define	EXT4_XATTR_MAGIC   0xEA020000
#define	EXT4_XATTR_REFCOUNT_MAX   1024
#define	EXT4_XATTR_INDEX_USER   1
#define	EXT4_XATTR_INDEX_POSIX_ACL_ACCESS   2
#define	EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT   3
#define	EXT4_XATTR_INDEX_TRUSTED   4
#define	EXT4_XATTR_INDEX_LUSTRE   5
#define	EXT4_XATTR_INDEX_SECURITY   6
#define	EXT4_XATTR_INDEX_SYSTEM   7
#define	EXT4_XATTR_INDEX_RICHACL   8
#define	EXT4_XATTR_INDEX_ENCRYPTION   9
#define	EXT4_GOOD_OLD_INODE_SIZE   EXT2_GOOD_OLD_INODE_SIZE
#define	EXT4_XATTR_PAD_BITS   2
#define	EXT4_XATTR_PAD   (1<<EXT4_XATTR_PAD_BITS)
#define	EXT4_XATTR_ROUND   (EXT4_XATTR_PAD-1)
#define	EXT4_XATTR_LEN(name_len)
#define	EXT4_XATTR_NEXT(entry)
#define	EXT4_XATTR_SIZE(size)    (((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)
#define	EXT4_XATTR_NAME(entry)    ((char *)((entry) + 1))
#define	EXT4_XATTR_IHDR(raw_inode)
#define	EXT4_XATTR_IFIRST(hdr)    ((struct ext4_xattr_entry *)((hdr)+1))
#define	EXT4_XATTR_BHDR(block)    ((struct ext4_xattr_header *)((block)->b_data))
#define	EXT4_XATTR_ENTRY(ptr)    ((struct ext4_xattr_entry *)(ptr))
#define	EXT4_XATTR_BFIRST(block)    EXT4_XATTR_ENTRY(EXT4_XATTR_BHDR(block)+1)
#define	EXT4_XATTR_IS_LAST_ENTRY(entry)    (*(__le32 *)(entry) == 0)
#define	EXT4_ZERO_XATTR_VALUE   ((void *)-1)
#define	EXT4_XATTR_ITERATE_CONT   0
#define	EXT4_XATTR_ITERATE_STOP   1
#define	EXT4_XATTR_ITERATE_PAUSE   2

Functions
int	ext4_fs_get_xattr_ref (PEXT2_IRP_CONTEXT IrpContext, PEXT2_VCB fs, PEXT2_MCB inode_ref, struct ext4_xattr_ref *ref)
int	ext4_fs_put_xattr_ref (struct ext4_xattr_ref *ref)
int	ext4_fs_set_xattr (struct ext4_xattr_ref *ref, __u8 name_index, const char *name, size_t name_len, const void *data, size_t data_size, BOOL replace)
int	ext4_fs_set_xattr_ordered (struct ext4_xattr_ref *ref, __u8 name_index, const char *name, size_t name_len, const void *data, size_t data_size)
int	ext4_fs_remove_xattr (struct ext4_xattr_ref *ref, __u8 name_index, const char *name, size_t name_len)
int	ext4_fs_get_xattr (struct ext4_xattr_ref *ref, __u8 name_index, const char *name, size_t name_len, void *buf, size_t buf_size, size_t *data_size)
void	ext4_fs_xattr_iterate (struct ext4_xattr_ref *ref, int(*iter)(struct ext4_xattr_ref *ref, struct ext4_xattr_item *item, BOOL is_last))
void	ext4_fs_xattr_iterate_reset (struct ext4_xattr_ref *ref)
const char *	ext4_extract_xattr_name (const char *full_name, size_t full_name_len, __u8 *name_index, size_t *name_len, BOOL *found)
const char *	ext4_get_xattr_name_prefix (__u8 name_index, size_t *ret_prefix_len)
void	ext4_xattr_purge_items (struct ext4_xattr_ref *xattr_ref)

Detailed Description

Macro Definition Documentation

EXT4_GOOD_OLD_INODE_SIZE

#define EXT4_GOOD_OLD_INODE_SIZE   EXT2_GOOD_OLD_INODE_SIZE

Definition at line 89 of file ext4_xattr.h.

EXT4_XATTR_BFIRST

#define EXT4_XATTR_BFIRST

(

block

)

EXT4_XATTR_ENTRY(EXT4_XATTR_BHDR(block)+1)

Definition at line 117 of file ext4_xattr.h.

EXT4_XATTR_BHDR

#define EXT4_XATTR_BHDR

(

block

)

((struct ext4_xattr_header *)((block)->b_data))

Definition at line 113 of file ext4_xattr.h.

EXT4_XATTR_ENTRY

#define EXT4_XATTR_ENTRY

(

ptr

)

((struct ext4_xattr_entry *)(ptr))

Definition at line 115 of file ext4_xattr.h.

EXT4_XATTR_IFIRST

#define EXT4_XATTR_IFIRST

(

hdr

)

((struct ext4_xattr_entry *)((hdr)+1))

Definition at line 110 of file ext4_xattr.h.

EXT4_XATTR_IHDR

#define EXT4_XATTR_IHDR

(

raw_inode

)

Value:

    ((struct ext4_xattr_ibody_header *) \
        ((char *)raw_inode + \
        EXT4_GOOD_OLD_INODE_SIZE + \
        (raw_inode)->i_extra_isize))

Definition at line 105 of file ext4_xattr.h.

EXT4_XATTR_INDEX_ENCRYPTION

#define EXT4_XATTR_INDEX_ENCRYPTION   9

Definition at line 60 of file ext4_xattr.h.

EXT4_XATTR_INDEX_LUSTRE

#define EXT4_XATTR_INDEX_LUSTRE   5

Definition at line 56 of file ext4_xattr.h.

EXT4_XATTR_INDEX_POSIX_ACL_ACCESS

#define EXT4_XATTR_INDEX_POSIX_ACL_ACCESS   2

Definition at line 53 of file ext4_xattr.h.

EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT

#define EXT4_XATTR_INDEX_POSIX_ACL_DEFAULT   3

Definition at line 54 of file ext4_xattr.h.

EXT4_XATTR_INDEX_RICHACL

#define EXT4_XATTR_INDEX_RICHACL   8

Definition at line 59 of file ext4_xattr.h.

EXT4_XATTR_INDEX_SECURITY

#define EXT4_XATTR_INDEX_SECURITY   6

Definition at line 57 of file ext4_xattr.h.

EXT4_XATTR_INDEX_SYSTEM

#define EXT4_XATTR_INDEX_SYSTEM   7

Definition at line 58 of file ext4_xattr.h.

EXT4_XATTR_INDEX_TRUSTED

#define EXT4_XATTR_INDEX_TRUSTED   4

Definition at line 55 of file ext4_xattr.h.

EXT4_XATTR_INDEX_USER

#define EXT4_XATTR_INDEX_USER   1

Definition at line 52 of file ext4_xattr.h.

EXT4_XATTR_IS_LAST_ENTRY

#define EXT4_XATTR_IS_LAST_ENTRY

(

entry

)

(*(__le32 *)(entry) == 0)

Definition at line 119 of file ext4_xattr.h.

EXT4_XATTR_ITERATE_CONT

#define EXT4_XATTR_ITERATE_CONT   0

Definition at line 162 of file ext4_xattr.h.

EXT4_XATTR_ITERATE_PAUSE

#define EXT4_XATTR_ITERATE_PAUSE   2

Definition at line 164 of file ext4_xattr.h.

EXT4_XATTR_ITERATE_STOP

#define EXT4_XATTR_ITERATE_STOP   1

Definition at line 163 of file ext4_xattr.h.

EXT4_XATTR_LEN

#define EXT4_XATTR_LEN

(

name_len

)

Value:

    (((name_len) + EXT4_XATTR_ROUND + \
    sizeof(struct ext4_xattr_entry)) & ~EXT4_XATTR_ROUND)

Definition at line 94 of file ext4_xattr.h.

EXT4_XATTR_MAGIC

#define EXT4_XATTR_MAGIC   0xEA020000

Definition at line 46 of file ext4_xattr.h.

EXT4_XATTR_NAME

#define EXT4_XATTR_NAME

(

entry

)

((char *)((entry) + 1))

Definition at line 102 of file ext4_xattr.h.

EXT4_XATTR_NEXT

#define EXT4_XATTR_NEXT

(

entry

)

Value:

    ((struct ext4_xattr_entry *)( \
     (char *)(entry) + EXT4_XATTR_LEN((entry)->e_name_len)))

Definition at line 97 of file ext4_xattr.h.

EXT4_XATTR_PAD

#define EXT4_XATTR_PAD   (1<<EXT4_XATTR_PAD_BITS)

Definition at line 92 of file ext4_xattr.h.

EXT4_XATTR_PAD_BITS

#define EXT4_XATTR_PAD_BITS   2

Definition at line 91 of file ext4_xattr.h.

EXT4_XATTR_REFCOUNT_MAX

#define EXT4_XATTR_REFCOUNT_MAX   1024

Definition at line 49 of file ext4_xattr.h.

EXT4_XATTR_ROUND

#define EXT4_XATTR_ROUND   (EXT4_XATTR_PAD-1)

Definition at line 93 of file ext4_xattr.h.

EXT4_XATTR_SIZE

#define EXT4_XATTR_SIZE

(

size

)

(((size) + EXT4_XATTR_ROUND) & ~EXT4_XATTR_ROUND)

Definition at line 100 of file ext4_xattr.h.

EXT4_ZERO_XATTR_VALUE

#define EXT4_ZERO_XATTR_VALUE   ((void *)-1)

Definition at line 122 of file ext4_xattr.h.

Function Documentation

ext4_extract_xattr_name()

const char * ext4_extract_xattr_name	(	const char *	full_name,
		size_t	full_name_len,
		__u8 *	name_index,
		size_t *	name_len,
		BOOL *	found
	)

Definition at line 1234 of file ext4_xattr.c.

{
    int i;
    ASSERT(name_index);
    ASSERT(found);
 
    *found = FALSE;
 
    if (!full_name_len) {
        if (name_len)
            *name_len = 0;
 
        return NULL;
    }
 
    for (i = 0; prefix_tbl[i].prefix; i++) {
        size_t prefix_len = strlen(prefix_tbl[i].prefix);
        if (full_name_len >= prefix_len &&
            !memcmp(full_name, prefix_tbl[i].prefix, prefix_len)) {
            BOOL require_name =
                prefix_tbl[i].prefix[prefix_len - 1] == '.';
            *name_index = prefix_tbl[i].name_index;
            if (name_len)
                *name_len = full_name_len - prefix_len;
 
            if (!(full_name_len - prefix_len) && require_name)
                return NULL;
 
            *found = TRUE;
            if (require_name)
                return full_name + prefix_len;
 
            return NULL;
        }
    }
    if (name_len)
        *name_len = 0;
 
    return NULL;
}

ext4_fs_get_xattr()

int ext4_fs_get_xattr	(	struct ext4_xattr_ref *	ref,
		__u8	name_index,
		const char *	name,
		size_t	name_len,
		void *	buf,
		size_t	buf_size,
		size_t *	data_size
	)

Definition at line 1078 of file ext4_xattr.c.

{
    int ret = 0;
    size_t item_size = 0;
    struct ext4_xattr_item *item =
        ext4_xattr_lookup_item(ref, name_index, name, name_len);
 
    if (!item) {
        ret = -ENODATA;
        goto Finish;
    }
    item_size = item->data_size;
    if (buf_size > item_size)
        buf_size = item_size;
 
    if (buf)
        memcpy(buf, item->data, buf_size);
 
Finish:
    if (data_size)
        *data_size = item_size;
 
    return ret;
}

Referenced by Ext2QueryEa().

ext4_fs_get_xattr_ref()

int ext4_fs_get_xattr_ref	(	PEXT2_IRP_CONTEXT	IrpContext,
		PEXT2_VCB	fs,
		PEXT2_MCB	inode_ref,
		struct ext4_xattr_ref *	ref
	)

Definition at line 1105 of file ext4_xattr.c.

{
    int rc;
    ext4_fsblk_t xattr_block;
    xattr_block = inode_ref->Inode.i_file_acl;
    memset(&ref->root, 0, sizeof(struct rb_root));
    ref->ea_size = 0;
    ref->iter_from = NULL;
    if (xattr_block) {
        ref->block_bh = extents_bread(&fs->sb, xattr_block);
        if (!ref->block_bh)
            return -EIO;
 
        ref->block_loaded = TRUE;
    } else
        ref->block_loaded = FALSE;
 
    ref->inode_ref = inode_ref;
    ref->fs = fs;
    INIT_LIST_HEAD(&ref->ordered_list);
 
    ref->OnDiskInode = Ext2AllocateInode(fs);
    if (!ref->OnDiskInode) {
        if (xattr_block) {
            extents_brelse(ref->block_bh);
            ref->block_bh = NULL;
        }
        return -ENOMEM;
    }
    if (!Ext2LoadInodeXattr(fs, &inode_ref->Inode, ref->OnDiskInode)) {
        if (xattr_block) {
            extents_brelse(ref->block_bh);
            ref->block_bh = NULL;
        }
 
        Ext2DestroyInode(fs, ref->OnDiskInode);
        return -EIO;
    }
    ref->IsOnDiskInodeDirty = FALSE;
 
    if (ext4_xattr_inode_space(ref) <
       sizeof(struct ext4_xattr_ibody_header) +
       sizeof(__u32))
        ref->inode_size_rem = 0;
    else {
        ref->inode_size_rem =
            ext4_xattr_inode_space(ref) -
            sizeof(struct ext4_xattr_ibody_header);
    }
 
    ref->block_size_rem =
        ext4_xattr_block_space(ref) -
        sizeof(struct ext4_xattr_header) -
        sizeof(__u32);
 
    rc = ext4_xattr_fetch(ref);
    if (rc != 0) {
        ext4_xattr_purge_items(ref);
        if (xattr_block) {
            extents_brelse(ref->block_bh);
            ref->block_bh = NULL;
        }
 
        Ext2DestroyInode(fs, ref->OnDiskInode);
        return rc;
    }
    ref->IrpContext = IrpContext;
    return 0;
}

Referenced by Ext2OverwriteEa(), Ext2QueryEa(), Ext2QueryFileInformation(), and Ext2SetEa().

ext4_fs_put_xattr_ref()

int ext4_fs_put_xattr_ref

(

struct ext4_xattr_ref *

ref

)

Definition at line 1176 of file ext4_xattr.c.

{
    int ret;
    sector_t orig_file_acl = ref->inode_ref->Inode.i_file_acl;
    ret = ext4_xattr_write_to_disk(ref);
    if (ref->IsOnDiskInodeDirty) {
        ASSERT(ref->fs->InodeSize > EXT4_GOOD_OLD_INODE_SIZE);
 
        /* As we may do block allocation in ext4_xattr_write_to_disk */
        if (ret)
            ref->inode_ref->Inode.i_file_acl = orig_file_acl;
 
        if (!ret) {
            ret = Ext2SaveInode(ref->IrpContext, ref->fs, &ref->inode_ref->Inode)
                ? 0 : -EIO;
            if (!ret) {
                ret = Ext2SaveInodeXattr(ref->IrpContext,
                        ref->fs,
                        &ref->inode_ref->Inode,
                        ref->OnDiskInode)
                    ? 0 : -EIO;
            }
        }
        ref->IsOnDiskInodeDirty = FALSE;
    }
    if (ref->block_loaded) {
        if (!ret)
            extents_brelse(ref->block_bh);
        else
            extents_bforget(ref->block_bh);
 
        ref->block_bh = NULL;
        ref->block_loaded = FALSE;
    }
    ext4_xattr_purge_items(ref);
    Ext2DestroyInode(ref->fs, ref->OnDiskInode);
    ref->OnDiskInode = NULL;
    ref->inode_ref = NULL;
    ref->fs = NULL;
    return ret;
}

Referenced by Ext2OverwriteEa(), Ext2QueryEa(), Ext2QueryFileInformation(), and Ext2SetEa().

ext4_fs_remove_xattr()

int ext4_fs_remove_xattr	(	struct ext4_xattr_ref *	ref,
		__u8	name_index,
		const char *	name,
		size_t	name_len
	)

Definition at line 1072 of file ext4_xattr.c.

{
    return ext4_xattr_remove_item(ref, name_index, name, name_len);
}

ext4_fs_set_xattr()

int ext4_fs_set_xattr	(	struct ext4_xattr_ref *	ref,
		__u8	name_index,
		const char *	name,
		size_t	name_len,
		const void *	data,
		size_t	data_size,
		BOOL	replace
	)

Definition at line 1024 of file ext4_xattr.c.

{
    int ret = 0;
    struct ext4_xattr_item *item =
        ext4_xattr_lookup_item(ref, name_index, name, name_len);
    if (replace) {
        if (!item) {
            ret = -ENODATA;
            goto Finish;
        }
        if (item->data_size != data_size)
            ret = ext4_xattr_resize_item(ref, item, data_size);
 
        if (ret != 0) {
            goto Finish;
        }
        memcpy(item->data, data, data_size);
    } else {
        if (item) {
            ret = -EEXIST;
            goto Finish;
        }
        item = ext4_xattr_insert_item(ref, name_index, name, name_len,
                          data, data_size, &ret);
    }
Finish:
    return ret;
}

Referenced by Ext2OverwriteEa().

ext4_fs_set_xattr_ordered()

int ext4_fs_set_xattr_ordered	(	struct ext4_xattr_ref *	ref,
		__u8	name_index,
		const char *	name,
		size_t	name_len,
		const void *	data,
		size_t	data_size
	)

Definition at line 1055 of file ext4_xattr.c.

{
    int ret = 0;
    struct ext4_xattr_item *item =
        ext4_xattr_lookup_item(ref, name_index, name, name_len);
    if (item) {
        ret = -EEXIST;
        goto Finish;
    }
    item = ext4_xattr_insert_item_ordered(ref, name_index, name, name_len,
        data, data_size, &ret);
Finish:
    return ret;
}

Referenced by Ext2SetEa().

ext4_fs_xattr_iterate()

void ext4_fs_xattr_iterate	(	struct ext4_xattr_ref *	ref,
		int(*)(struct ext4_xattr_ref *ref, struct ext4_xattr_item *item, BOOL is_last)	iter
	)

Definition at line 978 of file ext4_xattr.c.

{
    struct ext4_xattr_item *item;
    if (!ref->iter_from) {
        struct list_head *first_node;
        first_node = ref->ordered_list.next;
        if (first_node && first_node != &ref->ordered_list) {
            ref->iter_from =
                list_entry(first_node,
                         struct ext4_xattr_item,
                         list_node);
        }
    }
 
    item = ref->iter_from;
    while (item) {
        struct list_head *next_node;
        struct ext4_xattr_item *next_item;
        int ret = EXT4_XATTR_ITERATE_CONT;
        next_node = item->list_node.next;
        if (next_node && next_node != &ref->ordered_list)
            next_item = list_entry(next_node, struct ext4_xattr_item,
                         list_node);
        else
            next_item = NULL;
        if (iter)
            ret = iter(ref, item, !next_item);
 
        if (ret != EXT4_XATTR_ITERATE_CONT) {
            if (ret == EXT4_XATTR_ITERATE_STOP)
                ref->iter_from = NULL;
 
            break;
        }
        item = next_item;
    }
}

Referenced by Ext2QueryEa(), and Ext2QueryFileInformation().

ext4_fs_xattr_iterate_reset()

void ext4_fs_xattr_iterate_reset

(

struct ext4_xattr_ref *

ref

)

Definition at line 1019 of file ext4_xattr.c.

{
    ref->iter_from = NULL;
}

ext4_get_xattr_name_prefix()

const char * ext4_get_xattr_name_prefix	(	__u8	name_index,
		size_t *	ret_prefix_len
	)

Definition at line 1277 of file ext4_xattr.c.

{
    int i;
 
    for (i = 0; prefix_tbl[i].prefix; i++) {
        size_t prefix_len = strlen(prefix_tbl[i].prefix);
        if (prefix_tbl[i].name_index == name_index) {
            if (ret_prefix_len)
                *ret_prefix_len = prefix_len;
 
            return prefix_tbl[i].prefix;
        }
    }
    if (ret_prefix_len)
        *ret_prefix_len = 0;
 
    return NULL;
}

ext4_xattr_purge_items()

void ext4_xattr_purge_items

(

struct ext4_xattr_ref *

xattr_ref

)

Definition at line 736 of file ext4_xattr.c.

{
    struct rb_node *first_node;
    struct ext4_xattr_item *item = NULL;
    first_node = rb_first(&xattr_ref->root);
    if (first_node)
        item = container_of(first_node, struct ext4_xattr_item,
                    node);
 
    while (item) {
        struct rb_node *next_node;
        struct ext4_xattr_item *next_item = NULL;
        next_node = rb_next(&item->node);
        if (next_node)
            next_item = container_of(next_node, struct ext4_xattr_item,
                         node);
        else
            next_item = NULL;
 
        ext4_xattr_item_remove(xattr_ref, item);
        ext4_xattr_item_free(item);
 
        item = next_item;
    }
    xattr_ref->ea_size = 0;
    if (ext4_xattr_inode_space(xattr_ref) <
       sizeof(struct ext4_xattr_ibody_header))
        xattr_ref->inode_size_rem = 0;
    else
        xattr_ref->inode_size_rem =
               ext4_xattr_inode_space(xattr_ref) -
               sizeof(struct ext4_xattr_ibody_header);
 
    xattr_ref->block_size_rem =
        ext4_xattr_block_space(xattr_ref) -
        sizeof(struct ext4_xattr_header);
}

Referenced by Ext2OverwriteEa(), Ext2SetEa(), ext4_fs_get_xattr_ref(), and ext4_fs_put_xattr_ref().