Loading...
1/*
2 * fs/f2fs/xattr.h
3 *
4 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
5 * http://www.samsung.com/
6 *
7 * Portions of this code from linux/fs/ext2/xattr.h
8 *
9 * On-disk format of extended attributes for the ext2 filesystem.
10 *
11 * (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
12 *
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
16 */
17#ifndef __F2FS_XATTR_H__
18#define __F2FS_XATTR_H__
19
20#include <linux/init.h>
21#include <linux/xattr.h>
22
23/* Magic value in attribute blocks */
24#define F2FS_XATTR_MAGIC 0xF2F52011
25
26/* Maximum number of references to one attribute block */
27#define F2FS_XATTR_REFCOUNT_MAX 1024
28
29/* Name indexes */
30#define F2FS_SYSTEM_ADVISE_NAME "system.advise"
31#define F2FS_XATTR_INDEX_USER 1
32#define F2FS_XATTR_INDEX_POSIX_ACL_ACCESS 2
33#define F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT 3
34#define F2FS_XATTR_INDEX_TRUSTED 4
35#define F2FS_XATTR_INDEX_LUSTRE 5
36#define F2FS_XATTR_INDEX_SECURITY 6
37#define F2FS_XATTR_INDEX_ADVISE 7
38/* Should be same as EXT4_XATTR_INDEX_ENCRYPTION */
39#define F2FS_XATTR_INDEX_ENCRYPTION 9
40
41#define F2FS_XATTR_NAME_ENCRYPTION_CONTEXT "c"
42
43struct f2fs_xattr_header {
44 __le32 h_magic; /* magic number for identification */
45 __le32 h_refcount; /* reference count */
46 __u32 h_reserved[4]; /* zero right now */
47};
48
49struct f2fs_xattr_entry {
50 __u8 e_name_index;
51 __u8 e_name_len;
52 __le16 e_value_size; /* size of attribute value */
53 char e_name[0]; /* attribute name */
54};
55
56#define XATTR_HDR(ptr) ((struct f2fs_xattr_header *)(ptr))
57#define XATTR_ENTRY(ptr) ((struct f2fs_xattr_entry *)(ptr))
58#define XATTR_FIRST_ENTRY(ptr) (XATTR_ENTRY(XATTR_HDR(ptr) + 1))
59#define XATTR_ROUND (3)
60
61#define XATTR_ALIGN(size) ((size + XATTR_ROUND) & ~XATTR_ROUND)
62
63#define ENTRY_SIZE(entry) (XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + \
64 entry->e_name_len + le16_to_cpu(entry->e_value_size)))
65
66#define XATTR_NEXT_ENTRY(entry) ((struct f2fs_xattr_entry *)((char *)(entry) +\
67 ENTRY_SIZE(entry)))
68
69#define IS_XATTR_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0)
70
71#define list_for_each_xattr(entry, addr) \
72 for (entry = XATTR_FIRST_ENTRY(addr);\
73 !IS_XATTR_LAST_ENTRY(entry);\
74 entry = XATTR_NEXT_ENTRY(entry))
75
76#define MIN_OFFSET(i) XATTR_ALIGN(inline_xattr_size(i) + PAGE_SIZE - \
77 sizeof(struct node_footer) - sizeof(__u32))
78
79#define MAX_VALUE_LEN(i) (MIN_OFFSET(i) - \
80 sizeof(struct f2fs_xattr_header) - \
81 sizeof(struct f2fs_xattr_entry))
82
83/*
84 * On-disk structure of f2fs_xattr
85 * We use inline xattrs space + 1 block for xattr.
86 *
87 * +--------------------+
88 * | f2fs_xattr_header |
89 * | |
90 * +--------------------+
91 * | f2fs_xattr_entry |
92 * | .e_name_index = 1 |
93 * | .e_name_len = 3 |
94 * | .e_value_size = 14 |
95 * | .e_name = "foo" |
96 * | "value_of_xattr" |<- value_offs = e_name + e_name_len
97 * +--------------------+
98 * | f2fs_xattr_entry |
99 * | .e_name_index = 4 |
100 * | .e_name = "bar" |
101 * +--------------------+
102 * | |
103 * | Free |
104 * | |
105 * +--------------------+<- MIN_OFFSET
106 * | node_footer |
107 * | (nid, ino, offset) |
108 * +--------------------+
109 *
110 **/
111
112#ifdef CONFIG_F2FS_FS_XATTR
113extern const struct xattr_handler f2fs_xattr_user_handler;
114extern const struct xattr_handler f2fs_xattr_trusted_handler;
115extern const struct xattr_handler f2fs_xattr_advise_handler;
116extern const struct xattr_handler f2fs_xattr_security_handler;
117
118extern const struct xattr_handler *f2fs_xattr_handlers[];
119
120extern int f2fs_setxattr(struct inode *, int, const char *,
121 const void *, size_t, struct page *, int);
122extern int f2fs_getxattr(struct inode *, int, const char *, void *,
123 size_t, struct page *);
124extern ssize_t f2fs_listxattr(struct dentry *, char *, size_t);
125#else
126
127#define f2fs_xattr_handlers NULL
128static inline int f2fs_setxattr(struct inode *inode, int index,
129 const char *name, const void *value, size_t size,
130 struct page *page, int flags)
131{
132 return -EOPNOTSUPP;
133}
134static inline int f2fs_getxattr(struct inode *inode, int index,
135 const char *name, void *buffer,
136 size_t buffer_size, struct page *dpage)
137{
138 return -EOPNOTSUPP;
139}
140static inline ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer,
141 size_t buffer_size)
142{
143 return -EOPNOTSUPP;
144}
145#endif
146
147#ifdef CONFIG_F2FS_FS_SECURITY
148extern int f2fs_init_security(struct inode *, struct inode *,
149 const struct qstr *, struct page *);
150#else
151static inline int f2fs_init_security(struct inode *inode, struct inode *dir,
152 const struct qstr *qstr, struct page *ipage)
153{
154 return 0;
155}
156#endif
157#endif /* __F2FS_XATTR_H__ */
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * fs/f2fs/xattr.h
4 *
5 * Copyright (c) 2012 Samsung Electronics Co., Ltd.
6 * http://www.samsung.com/
7 *
8 * Portions of this code from linux/fs/ext2/xattr.h
9 *
10 * On-disk format of extended attributes for the ext2 filesystem.
11 *
12 * (C) 2001 Andreas Gruenbacher, <a.gruenbacher@computer.org>
13 */
14#ifndef __F2FS_XATTR_H__
15#define __F2FS_XATTR_H__
16
17#include <linux/init.h>
18#include <linux/xattr.h>
19
20/* Magic value in attribute blocks */
21#define F2FS_XATTR_MAGIC 0xF2F52011
22
23/* Maximum number of references to one attribute block */
24#define F2FS_XATTR_REFCOUNT_MAX 1024
25
26/* Name indexes */
27#define F2FS_SYSTEM_ADVISE_NAME "system.advise"
28#define F2FS_XATTR_INDEX_USER 1
29#define F2FS_XATTR_INDEX_POSIX_ACL_ACCESS 2
30#define F2FS_XATTR_INDEX_POSIX_ACL_DEFAULT 3
31#define F2FS_XATTR_INDEX_TRUSTED 4
32#define F2FS_XATTR_INDEX_LUSTRE 5
33#define F2FS_XATTR_INDEX_SECURITY 6
34#define F2FS_XATTR_INDEX_ADVISE 7
35/* Should be same as EXT4_XATTR_INDEX_ENCRYPTION */
36#define F2FS_XATTR_INDEX_ENCRYPTION 9
37#define F2FS_XATTR_INDEX_VERITY 11
38
39#define F2FS_XATTR_NAME_ENCRYPTION_CONTEXT "c"
40#define F2FS_XATTR_NAME_VERITY "v"
41
42struct f2fs_xattr_header {
43 __le32 h_magic; /* magic number for identification */
44 __le32 h_refcount; /* reference count */
45 __u32 h_reserved[4]; /* zero right now */
46};
47
48struct f2fs_xattr_entry {
49 __u8 e_name_index;
50 __u8 e_name_len;
51 __le16 e_value_size; /* size of attribute value */
52 char e_name[0]; /* attribute name */
53};
54
55#define XATTR_HDR(ptr) ((struct f2fs_xattr_header *)(ptr))
56#define XATTR_ENTRY(ptr) ((struct f2fs_xattr_entry *)(ptr))
57#define XATTR_FIRST_ENTRY(ptr) (XATTR_ENTRY(XATTR_HDR(ptr) + 1))
58#define XATTR_ROUND (3)
59
60#define XATTR_ALIGN(size) (((size) + XATTR_ROUND) & ~XATTR_ROUND)
61
62#define ENTRY_SIZE(entry) (XATTR_ALIGN(sizeof(struct f2fs_xattr_entry) + \
63 (entry)->e_name_len + le16_to_cpu((entry)->e_value_size)))
64
65#define XATTR_NEXT_ENTRY(entry) ((struct f2fs_xattr_entry *)((char *)(entry) +\
66 ENTRY_SIZE(entry)))
67
68#define IS_XATTR_LAST_ENTRY(entry) (*(__u32 *)(entry) == 0)
69
70#define list_for_each_xattr(entry, addr) \
71 for (entry = XATTR_FIRST_ENTRY(addr);\
72 !IS_XATTR_LAST_ENTRY(entry);\
73 entry = XATTR_NEXT_ENTRY(entry))
74#define VALID_XATTR_BLOCK_SIZE (PAGE_SIZE - sizeof(struct node_footer))
75#define XATTR_PADDING_SIZE (sizeof(__u32))
76#define XATTR_SIZE(x,i) (((x) ? VALID_XATTR_BLOCK_SIZE : 0) + \
77 (inline_xattr_size(i)))
78#define MIN_OFFSET(i) XATTR_ALIGN(inline_xattr_size(i) + \
79 VALID_XATTR_BLOCK_SIZE)
80
81#define MAX_VALUE_LEN(i) (MIN_OFFSET(i) - \
82 sizeof(struct f2fs_xattr_header) - \
83 sizeof(struct f2fs_xattr_entry))
84
85#define MAX_INLINE_XATTR_SIZE \
86 (DEF_ADDRS_PER_INODE - \
87 F2FS_TOTAL_EXTRA_ATTR_SIZE / sizeof(__le32) - \
88 DEF_INLINE_RESERVED_SIZE - \
89 MIN_INLINE_DENTRY_SIZE / sizeof(__le32))
90
91/*
92 * On-disk structure of f2fs_xattr
93 * We use inline xattrs space + 1 block for xattr.
94 *
95 * +--------------------+
96 * | f2fs_xattr_header |
97 * | |
98 * +--------------------+
99 * | f2fs_xattr_entry |
100 * | .e_name_index = 1 |
101 * | .e_name_len = 3 |
102 * | .e_value_size = 14 |
103 * | .e_name = "foo" |
104 * | "value_of_xattr" |<- value_offs = e_name + e_name_len
105 * +--------------------+
106 * | f2fs_xattr_entry |
107 * | .e_name_index = 4 |
108 * | .e_name = "bar" |
109 * +--------------------+
110 * | |
111 * | Free |
112 * | |
113 * +--------------------+<- MIN_OFFSET
114 * | node_footer |
115 * | (nid, ino, offset) |
116 * +--------------------+
117 *
118 **/
119
120#ifdef CONFIG_F2FS_FS_XATTR
121extern const struct xattr_handler f2fs_xattr_user_handler;
122extern const struct xattr_handler f2fs_xattr_trusted_handler;
123extern const struct xattr_handler f2fs_xattr_advise_handler;
124extern const struct xattr_handler f2fs_xattr_security_handler;
125
126extern const struct xattr_handler *f2fs_xattr_handlers[];
127
128extern int f2fs_setxattr(struct inode *, int, const char *,
129 const void *, size_t, struct page *, int);
130extern int f2fs_getxattr(struct inode *, int, const char *, void *,
131 size_t, struct page *);
132extern ssize_t f2fs_listxattr(struct dentry *, char *, size_t);
133#else
134
135#define f2fs_xattr_handlers NULL
136static inline int f2fs_setxattr(struct inode *inode, int index,
137 const char *name, const void *value, size_t size,
138 struct page *page, int flags)
139{
140 return -EOPNOTSUPP;
141}
142static inline int f2fs_getxattr(struct inode *inode, int index,
143 const char *name, void *buffer,
144 size_t buffer_size, struct page *dpage)
145{
146 return -EOPNOTSUPP;
147}
148static inline ssize_t f2fs_listxattr(struct dentry *dentry, char *buffer,
149 size_t buffer_size)
150{
151 return -EOPNOTSUPP;
152}
153#endif
154
155#ifdef CONFIG_F2FS_FS_SECURITY
156extern int f2fs_init_security(struct inode *, struct inode *,
157 const struct qstr *, struct page *);
158#else
159static inline int f2fs_init_security(struct inode *inode, struct inode *dir,
160 const struct qstr *qstr, struct page *ipage)
161{
162 return 0;
163}
164#endif
165#endif /* __F2FS_XATTR_H__ */