Commit | Line | Data |
---|---|---|
b4d0d230 | 1 | /* SPDX-License-Identifier: GPL-2.0-or-later */ |
9bc61ab1 DH |
2 | /* Filesystem superblock creation and reconfiguration context. |
3 | * | |
4 | * Copyright (C) 2018 Red Hat, Inc. All Rights Reserved. | |
5 | * Written by David Howells (dhowells@redhat.com) | |
9bc61ab1 DH |
6 | */ |
7 | ||
8 | #ifndef _LINUX_FS_CONTEXT_H | |
9 | #define _LINUX_FS_CONTEXT_H | |
10 | ||
11 | #include <linux/kernel.h> | |
007ec26c | 12 | #include <linux/refcount.h> |
9bc61ab1 DH |
13 | #include <linux/errno.h> |
14 | #include <linux/security.h> | |
24dcb3d9 | 15 | #include <linux/mutex.h> |
9bc61ab1 DH |
16 | |
17 | struct cred; | |
18 | struct dentry; | |
19 | struct file_operations; | |
20 | struct file_system_type; | |
f3a09c92 | 21 | struct mnt_namespace; |
9bc61ab1 | 22 | struct net; |
f3a09c92 AV |
23 | struct pid_namespace; |
24 | struct super_block; | |
9bc61ab1 | 25 | struct user_namespace; |
f3a09c92 AV |
26 | struct vfsmount; |
27 | struct path; | |
9bc61ab1 DH |
28 | |
29 | enum fs_context_purpose { | |
30 | FS_CONTEXT_FOR_MOUNT, /* New superblock for explicit mount */ | |
e1a91586 | 31 | FS_CONTEXT_FOR_SUBMOUNT, /* New superblock for automatic submount */ |
8d0347f6 | 32 | FS_CONTEXT_FOR_RECONFIGURE, /* Superblock reconfiguration (remount) */ |
9bc61ab1 DH |
33 | }; |
34 | ||
24dcb3d9 DH |
35 | /* |
36 | * Userspace usage phase for fsopen/fspick. | |
37 | */ | |
38 | enum fs_context_phase { | |
39 | FS_CONTEXT_CREATE_PARAMS, /* Loading params for sb creation */ | |
40 | FS_CONTEXT_CREATING, /* A superblock is being created */ | |
41 | FS_CONTEXT_AWAITING_MOUNT, /* Superblock created, awaiting fsmount() */ | |
42 | FS_CONTEXT_AWAITING_RECONF, /* Awaiting initialisation for reconfiguration */ | |
43 | FS_CONTEXT_RECONF_PARAMS, /* Loading params for reconfiguration */ | |
44 | FS_CONTEXT_RECONFIGURING, /* Reconfiguring the superblock */ | |
45 | FS_CONTEXT_FAILED, /* Failed to correctly transition a context */ | |
46 | }; | |
47 | ||
31d921c7 DH |
48 | /* |
49 | * Type of parameter value. | |
50 | */ | |
51 | enum fs_value_type { | |
52 | fs_value_is_undefined, | |
53 | fs_value_is_flag, /* Value not given a value */ | |
54 | fs_value_is_string, /* Value is a string */ | |
55 | fs_value_is_blob, /* Value is a binary blob */ | |
56 | fs_value_is_filename, /* Value is a filename* + dirfd */ | |
31d921c7 DH |
57 | fs_value_is_file, /* Value is a file* */ |
58 | }; | |
59 | ||
60 | /* | |
61 | * Configuration parameter. | |
62 | */ | |
63 | struct fs_parameter { | |
64 | const char *key; /* Parameter name */ | |
65 | enum fs_value_type type:8; /* The type of value here */ | |
66 | union { | |
67 | char *string; | |
68 | void *blob; | |
69 | struct filename *name; | |
70 | struct file *file; | |
71 | }; | |
72 | size_t size; | |
73 | int dirfd; | |
74 | }; | |
75 | ||
9bc61ab1 DH |
76 | /* |
77 | * Filesystem context for holding the parameters used in the creation or | |
78 | * reconfiguration of a superblock. | |
79 | * | |
80 | * Superblock creation fills in ->root whereas reconfiguration begins with this | |
81 | * already set. | |
82 | * | |
cb1aaebe | 83 | * See Documentation/filesystems/mount_api.txt |
9bc61ab1 DH |
84 | */ |
85 | struct fs_context { | |
f3a09c92 | 86 | const struct fs_context_operations *ops; |
24dcb3d9 | 87 | struct mutex uapi_mutex; /* Userspace access mutex */ |
9bc61ab1 DH |
88 | struct file_system_type *fs_type; |
89 | void *fs_private; /* The filesystem's context */ | |
fe62c3a4 | 90 | void *sget_key; |
9bc61ab1 DH |
91 | struct dentry *root; /* The root and superblock */ |
92 | struct user_namespace *user_ns; /* The user namespace for this mount */ | |
93 | struct net *net_ns; /* The network namespace for this mount */ | |
94 | const struct cred *cred; /* The mounter's credentials */ | |
007ec26c | 95 | struct fc_log *log; /* Logging buffer */ |
9bc61ab1 | 96 | const char *source; /* The source name (eg. dev path) */ |
9bc61ab1 | 97 | void *security; /* Linux S&M options */ |
cb50b348 | 98 | void *s_fs_info; /* Proposed s_fs_info */ |
9bc61ab1 DH |
99 | unsigned int sb_flags; /* Proposed superblock flags (SB_*) */ |
100 | unsigned int sb_flags_mask; /* Superblock flags that were changed */ | |
c80fa7c8 | 101 | unsigned int s_iflags; /* OR'd with sb->s_iflags */ |
846e5662 | 102 | unsigned int lsm_flags; /* Information flags from the fs to the LSM */ |
9bc61ab1 | 103 | enum fs_context_purpose purpose:8; |
24dcb3d9 | 104 | enum fs_context_phase phase:8; /* The phase the context is in */ |
9bc61ab1 | 105 | bool need_free:1; /* Need to call ops->free() */ |
cb50b348 | 106 | bool global:1; /* Goes into &init_user_ns */ |
9bc61ab1 DH |
107 | }; |
108 | ||
f3a09c92 AV |
109 | struct fs_context_operations { |
110 | void (*free)(struct fs_context *fc); | |
0b52075e | 111 | int (*dup)(struct fs_context *fc, struct fs_context *src_fc); |
3e1aeb00 | 112 | int (*parse_param)(struct fs_context *fc, struct fs_parameter *param); |
f3a09c92 AV |
113 | int (*parse_monolithic)(struct fs_context *fc, void *data); |
114 | int (*get_tree)(struct fs_context *fc); | |
115 | int (*reconfigure)(struct fs_context *fc); | |
116 | }; | |
117 | ||
9bc61ab1 DH |
118 | /* |
119 | * fs_context manipulation functions. | |
120 | */ | |
121 | extern struct fs_context *fs_context_for_mount(struct file_system_type *fs_type, | |
122 | unsigned int sb_flags); | |
8d0347f6 DH |
123 | extern struct fs_context *fs_context_for_reconfigure(struct dentry *dentry, |
124 | unsigned int sb_flags, | |
125 | unsigned int sb_flags_mask); | |
e1a91586 AV |
126 | extern struct fs_context *fs_context_for_submount(struct file_system_type *fs_type, |
127 | struct dentry *reference); | |
9bc61ab1 | 128 | |
0b52075e | 129 | extern struct fs_context *vfs_dup_fs_context(struct fs_context *fc); |
3e1aeb00 DH |
130 | extern int vfs_parse_fs_param(struct fs_context *fc, struct fs_parameter *param); |
131 | extern int vfs_parse_fs_string(struct fs_context *fc, const char *key, | |
132 | const char *value, size_t v_size); | |
133 | extern int generic_parse_monolithic(struct fs_context *fc, void *data); | |
9bc61ab1 DH |
134 | extern int vfs_get_tree(struct fs_context *fc); |
135 | extern void put_fs_context(struct fs_context *fc); | |
136 | ||
cb50b348 | 137 | /* |
533770cc | 138 | * sget() wrappers to be called from the ->get_tree() op. |
cb50b348 AV |
139 | */ |
140 | enum vfs_get_super_keying { | |
141 | vfs_get_single_super, /* Only one such superblock may exist */ | |
43ce4c1f | 142 | vfs_get_single_reconf_super, /* As above, but reconfigure if it exists */ |
cb50b348 AV |
143 | vfs_get_keyed_super, /* Superblocks with different s_fs_info keys may exist */ |
144 | vfs_get_independent_super, /* Multiple independent superblocks may exist */ | |
145 | }; | |
146 | extern int vfs_get_super(struct fs_context *fc, | |
147 | enum vfs_get_super_keying keying, | |
148 | int (*fill_super)(struct super_block *sb, | |
149 | struct fs_context *fc)); | |
533770cc | 150 | |
2ac295d4 AV |
151 | extern int get_tree_nodev(struct fs_context *fc, |
152 | int (*fill_super)(struct super_block *sb, | |
153 | struct fs_context *fc)); | |
c23a0bba AV |
154 | extern int get_tree_single(struct fs_context *fc, |
155 | int (*fill_super)(struct super_block *sb, | |
156 | struct fs_context *fc)); | |
43ce4c1f DH |
157 | extern int get_tree_single_reconf(struct fs_context *fc, |
158 | int (*fill_super)(struct super_block *sb, | |
159 | struct fs_context *fc)); | |
533770cc AV |
160 | extern int get_tree_keyed(struct fs_context *fc, |
161 | int (*fill_super)(struct super_block *sb, | |
162 | struct fs_context *fc), | |
163 | void *key); | |
cb50b348 | 164 | |
fe62c3a4 DH |
165 | extern int get_tree_bdev(struct fs_context *fc, |
166 | int (*fill_super)(struct super_block *sb, | |
167 | struct fs_context *fc)); | |
168 | ||
e7582e16 DH |
169 | extern const struct file_operations fscontext_fops; |
170 | ||
007ec26c DH |
171 | /* |
172 | * Mount error, warning and informational message logging. This structure is | |
173 | * shareable between a mount and a subordinate mount. | |
174 | */ | |
175 | struct fc_log { | |
176 | refcount_t usage; | |
177 | u8 head; /* Insertion index in buffer[] */ | |
178 | u8 tail; /* Removal index in buffer[] */ | |
179 | u8 need_free; /* Mask of kfree'able items in buffer[] */ | |
180 | struct module *owner; /* Owner module for strings that don't then need freeing */ | |
181 | char *buffer[8]; | |
182 | }; | |
183 | ||
e7582e16 DH |
184 | extern __attribute__((format(printf, 2, 3))) |
185 | void logfc(struct fs_context *fc, const char *fmt, ...); | |
c6b82263 DH |
186 | |
187 | /** | |
188 | * infof - Store supplementary informational message | |
189 | * @fc: The context in which to log the informational message | |
190 | * @fmt: The format string | |
191 | * | |
192 | * Store the supplementary informational message for the process if the process | |
193 | * has enabled the facility. | |
194 | */ | |
e7582e16 | 195 | #define infof(fc, fmt, ...) ({ logfc(fc, "i "fmt, ## __VA_ARGS__); }) |
c6b82263 DH |
196 | |
197 | /** | |
198 | * warnf - Store supplementary warning message | |
199 | * @fc: The context in which to log the error message | |
200 | * @fmt: The format string | |
201 | * | |
202 | * Store the supplementary warning message for the process if the process has | |
203 | * enabled the facility. | |
204 | */ | |
e7582e16 | 205 | #define warnf(fc, fmt, ...) ({ logfc(fc, "w "fmt, ## __VA_ARGS__); }) |
c6b82263 DH |
206 | |
207 | /** | |
208 | * errorf - Store supplementary error message | |
209 | * @fc: The context in which to log the error message | |
210 | * @fmt: The format string | |
211 | * | |
212 | * Store the supplementary error message for the process if the process has | |
213 | * enabled the facility. | |
214 | */ | |
e7582e16 | 215 | #define errorf(fc, fmt, ...) ({ logfc(fc, "e "fmt, ## __VA_ARGS__); }) |
c6b82263 DH |
216 | |
217 | /** | |
218 | * invalf - Store supplementary invalid argument error message | |
219 | * @fc: The context in which to log the error message | |
220 | * @fmt: The format string | |
221 | * | |
222 | * Store the supplementary error message for the process if the process has | |
223 | * enabled the facility and return -EINVAL. | |
224 | */ | |
225 | #define invalf(fc, fmt, ...) ({ errorf(fc, fmt, ## __VA_ARGS__); -EINVAL; }) | |
226 | ||
9bc61ab1 | 227 | #endif /* _LINUX_FS_CONTEXT_H */ |