1d29fbcdbSNishad Kamdar /* SPDX-License-Identifier: GPL-2.0 */ 20a8165d7SJaegeuk Kim /* 3af48b85bSJaegeuk Kim * fs/f2fs/xattr.h 4af48b85bSJaegeuk Kim * 5af48b85bSJaegeuk Kim * Copyright (c) 2012 Samsung Electronics Co., Ltd. 6af48b85bSJaegeuk Kim * http://www.samsung.com/ 7af48b85bSJaegeuk Kim * 8af48b85bSJaegeuk Kim * Portions of this code from linux/fs/ext2/xattr.h 9af48b85bSJaegeuk Kim * 10af48b85bSJaegeuk Kim * On-disk format of extended attributes for the ext2 filesystem. 11af48b85bSJaegeuk Kim * 12af48b85bSJaegeuk Kim * (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org> 13af48b85bSJaegeuk Kim */ 14af48b85bSJaegeuk Kim #ifndef __F2FS_XATTR_H__ 15af48b85bSJaegeuk Kim #define __F2FS_XATTR_H__ 16af48b85bSJaegeuk Kim 17af48b85bSJaegeuk Kim #include <linux/init.h> 18af48b85bSJaegeuk Kim #include <linux/xattr.h> 19af48b85bSJaegeuk Kim 20af48b85bSJaegeuk Kim /* Magic value in attribute blocks */ 21af48b85bSJaegeuk Kim #define F2FS_XATTR_MAGIC 0xF2F52011 22af48b85bSJaegeuk Kim 23af48b85bSJaegeuk Kim /* Maximum number of references to one attribute block */ 24af48b85bSJaegeuk Kim #define F2FS_XATTR_REFCOUNT_MAX 1024 25af48b85bSJaegeuk Kim 26af48b85bSJaegeuk Kim /* Name indexes */ 2798e9cb57SAndreas Gruenbacher #define F2FS_SYSTEM_ADVISE_NAME "system.advise" 28af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_USER 1 29af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_POSIX_ACL_ACCESS 2 30af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT 3 31af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_TRUSTED 4 32af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_LUSTRE 5 33af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_SECURITY 6 34af48b85bSJaegeuk Kim #define F2FS_XATTR_INDEX_ADVISE 7 35b93531ddSJaegeuk Kim /* Should be same as EXT4_XATTR_INDEX_ENCRYPTION */ 36b93531ddSJaegeuk Kim #define F2FS_XATTR_INDEX_ENCRYPTION 9 3795ae251fSEric Biggers #define F2FS_XATTR_INDEX_VERITY 11 38b93531ddSJaegeuk Kim 39b93531ddSJaegeuk Kim #define F2FS_XATTR_NAME_ENCRYPTION_CONTEXT "c" 4095ae251fSEric Biggers #define F2FS_XATTR_NAME_VERITY "v" 41af48b85bSJaegeuk Kim 42af48b85bSJaegeuk Kim struct f2fs_xattr_header { 43af48b85bSJaegeuk Kim __le32 h_magic; /* magic number for identification */ 44af48b85bSJaegeuk Kim __le32 h_refcount; /* reference count */ 45af48b85bSJaegeuk Kim __u32 h_reserved[4]; /* zero right now */ 46af48b85bSJaegeuk Kim }; 47af48b85bSJaegeuk Kim 48af48b85bSJaegeuk Kim struct f2fs_xattr_entry { 49af48b85bSJaegeuk Kim __u8 e_name_index; 50af48b85bSJaegeuk Kim __u8 e_name_len; 51af48b85bSJaegeuk Kim __le16 e_value_size; /* size of attribute value */ 5250b1203dSGustavo A. R. Silva char e_name[]; /* attribute name */ 53af48b85bSJaegeuk Kim }; 54af48b85bSJaegeuk Kim 55af48b85bSJaegeuk Kim #define XATTR_HDR(ptr) ((struct f2fs_xattr_header *)(ptr)) 56af48b85bSJaegeuk Kim #define XATTR_ENTRY(ptr) ((struct f2fs_xattr_entry *)(ptr)) 57af48b85bSJaegeuk Kim #define XATTR_FIRST_ENTRY(ptr) (XATTR_ENTRY(XATTR_HDR(ptr) + 1)) 58af48b85bSJaegeuk Kim #define XATTR_ROUND (3) 59af48b85bSJaegeuk Kim 6068afcf2dSTomohiro Kusumi #define XATTR_ALIGN(size) (((size) + XATTR_ROUND) & ~XATTR_ROUND) 61af48b85bSJaegeuk Kim 62af48b85bSJaegeuk Kim #define ENTRY_SIZE(entry) (XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + \ 6368afcf2dSTomohiro Kusumi (entry)->e_name_len + le16_to_cpu((entry)->e_value_size))) 64af48b85bSJaegeuk Kim 65af48b85bSJaegeuk Kim #define XATTR_NEXT_ENTRY(entry) ((struct f2fs_xattr_entry *)((char *)(entry) +\ 66af48b85bSJaegeuk Kim ENTRY_SIZE(entry))) 67af48b85bSJaegeuk Kim 68af48b85bSJaegeuk Kim #define IS_XATTR_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0) 69af48b85bSJaegeuk Kim 70af48b85bSJaegeuk Kim #define list_for_each_xattr(entry, addr) \ 71af48b85bSJaegeuk Kim for (entry = XATTR_FIRST_ENTRY(addr);\ 72af48b85bSJaegeuk Kim !IS_XATTR_LAST_ENTRY(entry);\ 73af48b85bSJaegeuk Kim entry = XATTR_NEXT_ENTRY(entry)) 7422588f87SChao Yu #define VALID_XATTR_BLOCK_SIZE (PAGE_SIZE - sizeof(struct node_footer)) 7522588f87SChao Yu #define XATTR_PADDING_SIZE (sizeof(__u32)) 76ba3b583cSChao Yu #define XATTR_SIZE(i) ((F2FS_I(i)->i_xattr_nid ? \ 77ba3b583cSChao Yu VALID_XATTR_BLOCK_SIZE : 0) + \ 782777e654SRandall Huang (inline_xattr_size(i))) 79ba38c27eSChao Yu #define MIN_OFFSET(i) XATTR_ALIGN(inline_xattr_size(i) + \ 80ba38c27eSChao Yu VALID_XATTR_BLOCK_SIZE) 81af48b85bSJaegeuk Kim 8265985d93SJaegeuk Kim #define MAX_VALUE_LEN(i) (MIN_OFFSET(i) - \ 8365985d93SJaegeuk Kim sizeof(struct f2fs_xattr_header) - \ 84af48b85bSJaegeuk Kim sizeof(struct f2fs_xattr_entry)) 85af48b85bSJaegeuk Kim 86dde38c03SSheng Yong #define MIN_INLINE_XATTR_SIZE (sizeof(struct f2fs_xattr_header) / sizeof(__le32)) 87dd6c89b5SChao Yu #define MAX_INLINE_XATTR_SIZE \ 88dd6c89b5SChao Yu (DEF_ADDRS_PER_INODE - \ 89dd6c89b5SChao Yu F2FS_TOTAL_EXTRA_ATTR_SIZE / sizeof(__le32) - \ 90dd6c89b5SChao Yu DEF_INLINE_RESERVED_SIZE - \ 91dd6c89b5SChao Yu MIN_INLINE_DENTRY_SIZE / sizeof(__le32)) 92dd6c89b5SChao Yu 930a8165d7SJaegeuk Kim /* 94af48b85bSJaegeuk Kim * On-disk structure of f2fs_xattr 9565985d93SJaegeuk Kim * We use inline xattrs space + 1 block for xattr. 96af48b85bSJaegeuk Kim * 97af48b85bSJaegeuk Kim * +--------------------+ 98af48b85bSJaegeuk Kim * | f2fs_xattr_header | 99af48b85bSJaegeuk Kim * | | 100af48b85bSJaegeuk Kim * +--------------------+ 101af48b85bSJaegeuk Kim * | f2fs_xattr_entry | 102af48b85bSJaegeuk Kim * | .e_name_index = 1 | 103af48b85bSJaegeuk Kim * | .e_name_len = 3 | 104af48b85bSJaegeuk Kim * | .e_value_size = 14 | 105af48b85bSJaegeuk Kim * | .e_name = "foo" | 106af48b85bSJaegeuk Kim * | "value_of_xattr" |<- value_offs = e_name + e_name_len 107af48b85bSJaegeuk Kim * +--------------------+ 108af48b85bSJaegeuk Kim * | f2fs_xattr_entry | 109af48b85bSJaegeuk Kim * | .e_name_index = 4 | 110af48b85bSJaegeuk Kim * | .e_name = "bar" | 111af48b85bSJaegeuk Kim * +--------------------+ 112af48b85bSJaegeuk Kim * | | 113af48b85bSJaegeuk Kim * | Free | 114af48b85bSJaegeuk Kim * | | 115af48b85bSJaegeuk Kim * +--------------------+<- MIN_OFFSET 116af48b85bSJaegeuk Kim * | node_footer | 117af48b85bSJaegeuk Kim * | (nid, ino, offset) | 118af48b85bSJaegeuk Kim * +--------------------+ 119af48b85bSJaegeuk Kim * 120af48b85bSJaegeuk Kim **/ 121af48b85bSJaegeuk Kim 122af48b85bSJaegeuk Kim #ifdef CONFIG_F2FS_FS_XATTR 123af48b85bSJaegeuk Kim extern const struct xattr_handler f2fs_xattr_user_handler; 124af48b85bSJaegeuk Kim extern const struct xattr_handler f2fs_xattr_trusted_handler; 125af48b85bSJaegeuk Kim extern const struct xattr_handler f2fs_xattr_advise_handler; 1268ae8f162SJaegeuk Kim extern const struct xattr_handler f2fs_xattr_security_handler; 127af48b85bSJaegeuk Kim 128*a1c0752cSWedson Almeida Filho extern const struct xattr_handler * const f2fs_xattr_handlers[]; 129af48b85bSJaegeuk Kim 1308ae8f162SJaegeuk Kim extern int f2fs_setxattr(struct inode *, int, const char *, 131c02745efSJaegeuk Kim const void *, size_t, struct page *, int); 132bce8d112SJaegeuk Kim extern int f2fs_getxattr(struct inode *, int, const char *, void *, 133bce8d112SJaegeuk Kim size_t, struct page *); 1348ae8f162SJaegeuk Kim extern ssize_t f2fs_listxattr(struct dentry *, char *, size_t); 135a999150fSChao Yu extern int f2fs_init_xattr_caches(struct f2fs_sb_info *); 136a999150fSChao Yu extern void f2fs_destroy_xattr_caches(struct f2fs_sb_info *); 137af48b85bSJaegeuk Kim #else 138af48b85bSJaegeuk Kim 139af48b85bSJaegeuk Kim #define f2fs_xattr_handlers NULL 140195f4065SChengguang Xu #define f2fs_listxattr NULL 141e1123268SJaegeuk Kim static inline int f2fs_setxattr(struct inode *inode, int index, 142fff4c55dSArnd Bergmann const char *name, const void *value, size_t size, 143fff4c55dSArnd Bergmann struct page *page, int flags) 144af48b85bSJaegeuk Kim { 145af48b85bSJaegeuk Kim return -EOPNOTSUPP; 146af48b85bSJaegeuk Kim } 147e1123268SJaegeuk Kim static inline int f2fs_getxattr(struct inode *inode, int index, 148bce8d112SJaegeuk Kim const char *name, void *buffer, 149bce8d112SJaegeuk Kim size_t buffer_size, struct page *dpage) 150af48b85bSJaegeuk Kim { 151af48b85bSJaegeuk Kim return -EOPNOTSUPP; 152af48b85bSJaegeuk Kim } 153db251553SYueHaibing static inline int f2fs_init_xattr_caches(struct f2fs_sb_info *sbi) { return 0; } 154db251553SYueHaibing static inline void f2fs_destroy_xattr_caches(struct f2fs_sb_info *sbi) { } 155af48b85bSJaegeuk Kim #endif 156af48b85bSJaegeuk Kim 1578ae8f162SJaegeuk Kim #ifdef CONFIG_F2FS_FS_SECURITY 1588ae8f162SJaegeuk Kim extern int f2fs_init_security(struct inode *, struct inode *, 1598ae8f162SJaegeuk Kim const struct qstr *, struct page *); 1608ae8f162SJaegeuk Kim #else 1618ae8f162SJaegeuk Kim static inline int f2fs_init_security(struct inode *inode, struct inode *dir, 1628ae8f162SJaegeuk Kim const struct qstr *qstr, struct page *ipage) 1638ae8f162SJaegeuk Kim { 1648ae8f162SJaegeuk Kim return 0; 1658ae8f162SJaegeuk Kim } 1668ae8f162SJaegeuk Kim #endif 167af48b85bSJaegeuk Kim #endif /* __F2FS_XATTR_H__ */ 168