convenience helpers: vfs_get_super() and sget_fc()
[muen/linux.git] / include / linux / fs_context.h
1 /* Filesystem superblock creation and reconfiguration context.
2  *
3  * Copyright (C) 2018 Red Hat, Inc. All Rights Reserved.
4  * Written by David Howells (dhowells@redhat.com)
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public Licence
8  * as published by the Free Software Foundation; either version
9  * 2 of the Licence, or (at your option) any later version.
10  */
11
12 #ifndef _LINUX_FS_CONTEXT_H
13 #define _LINUX_FS_CONTEXT_H
14
15 #include <linux/kernel.h>
16 #include <linux/errno.h>
17 #include <linux/security.h>
18
19 struct cred;
20 struct dentry;
21 struct file_operations;
22 struct file_system_type;
23 struct mnt_namespace;
24 struct net;
25 struct pid_namespace;
26 struct super_block;
27 struct user_namespace;
28 struct vfsmount;
29 struct path;
30
31 enum fs_context_purpose {
32         FS_CONTEXT_FOR_MOUNT,           /* New superblock for explicit mount */
33         FS_CONTEXT_FOR_SUBMOUNT,        /* New superblock for automatic submount */
34         FS_CONTEXT_FOR_RECONFIGURE,     /* Superblock reconfiguration (remount) */
35 };
36
37 /*
38  * Type of parameter value.
39  */
40 enum fs_value_type {
41         fs_value_is_undefined,
42         fs_value_is_flag,               /* Value not given a value */
43         fs_value_is_string,             /* Value is a string */
44         fs_value_is_blob,               /* Value is a binary blob */
45         fs_value_is_filename,           /* Value is a filename* + dirfd */
46         fs_value_is_filename_empty,     /* Value is a filename* + dirfd + AT_EMPTY_PATH */
47         fs_value_is_file,               /* Value is a file* */
48 };
49
50 /*
51  * Configuration parameter.
52  */
53 struct fs_parameter {
54         const char              *key;           /* Parameter name */
55         enum fs_value_type      type:8;         /* The type of value here */
56         union {
57                 char            *string;
58                 void            *blob;
59                 struct filename *name;
60                 struct file     *file;
61         };
62         size_t  size;
63         int     dirfd;
64 };
65
66 /*
67  * Filesystem context for holding the parameters used in the creation or
68  * reconfiguration of a superblock.
69  *
70  * Superblock creation fills in ->root whereas reconfiguration begins with this
71  * already set.
72  *
73  * See Documentation/filesystems/mounting.txt
74  */
75 struct fs_context {
76         const struct fs_context_operations *ops;
77         struct file_system_type *fs_type;
78         void                    *fs_private;    /* The filesystem's context */
79         struct dentry           *root;          /* The root and superblock */
80         struct user_namespace   *user_ns;       /* The user namespace for this mount */
81         struct net              *net_ns;        /* The network namespace for this mount */
82         const struct cred       *cred;          /* The mounter's credentials */
83         const char              *source;        /* The source name (eg. dev path) */
84         const char              *subtype;       /* The subtype to set on the superblock */
85         void                    *security;      /* Linux S&M options */
86         void                    *s_fs_info;     /* Proposed s_fs_info */
87         unsigned int            sb_flags;       /* Proposed superblock flags (SB_*) */
88         unsigned int            sb_flags_mask;  /* Superblock flags that were changed */
89         unsigned int            lsm_flags;      /* Information flags from the fs to the LSM */
90         enum fs_context_purpose purpose:8;
91         bool                    need_free:1;    /* Need to call ops->free() */
92         bool                    global:1;       /* Goes into &init_user_ns */
93 };
94
95 struct fs_context_operations {
96         void (*free)(struct fs_context *fc);
97         int (*parse_param)(struct fs_context *fc, struct fs_parameter *param);
98         int (*parse_monolithic)(struct fs_context *fc, void *data);
99         int (*get_tree)(struct fs_context *fc);
100         int (*reconfigure)(struct fs_context *fc);
101 };
102
103 /*
104  * fs_context manipulation functions.
105  */
106 extern struct fs_context *fs_context_for_mount(struct file_system_type *fs_type,
107                                                 unsigned int sb_flags);
108 extern struct fs_context *fs_context_for_reconfigure(struct dentry *dentry,
109                                                 unsigned int sb_flags,
110                                                 unsigned int sb_flags_mask);
111 extern struct fs_context *fs_context_for_submount(struct file_system_type *fs_type,
112                                                 struct dentry *reference);
113
114 extern int vfs_parse_fs_param(struct fs_context *fc, struct fs_parameter *param);
115 extern int vfs_parse_fs_string(struct fs_context *fc, const char *key,
116                                const char *value, size_t v_size);
117 extern int generic_parse_monolithic(struct fs_context *fc, void *data);
118 extern int vfs_get_tree(struct fs_context *fc);
119 extern void put_fs_context(struct fs_context *fc);
120
121 /*
122  * sget() wrapper to be called from the ->get_tree() op.
123  */
124 enum vfs_get_super_keying {
125         vfs_get_single_super,   /* Only one such superblock may exist */
126         vfs_get_keyed_super,    /* Superblocks with different s_fs_info keys may exist */
127         vfs_get_independent_super, /* Multiple independent superblocks may exist */
128 };
129 extern int vfs_get_super(struct fs_context *fc,
130                          enum vfs_get_super_keying keying,
131                          int (*fill_super)(struct super_block *sb,
132                                            struct fs_context *fc));
133
134 #define logfc(FC, FMT, ...) pr_notice(FMT, ## __VA_ARGS__)
135
136 /**
137  * infof - Store supplementary informational message
138  * @fc: The context in which to log the informational message
139  * @fmt: The format string
140  *
141  * Store the supplementary informational message for the process if the process
142  * has enabled the facility.
143  */
144 #define infof(fc, fmt, ...) ({ logfc(fc, fmt, ## __VA_ARGS__); })
145
146 /**
147  * warnf - Store supplementary warning message
148  * @fc: The context in which to log the error message
149  * @fmt: The format string
150  *
151  * Store the supplementary warning message for the process if the process has
152  * enabled the facility.
153  */
154 #define warnf(fc, fmt, ...) ({ logfc(fc, fmt, ## __VA_ARGS__); })
155
156 /**
157  * errorf - Store supplementary error message
158  * @fc: The context in which to log the error message
159  * @fmt: The format string
160  *
161  * Store the supplementary error message for the process if the process has
162  * enabled the facility.
163  */
164 #define errorf(fc, fmt, ...) ({ logfc(fc, fmt, ## __VA_ARGS__); })
165
166 /**
167  * invalf - Store supplementary invalid argument error message
168  * @fc: The context in which to log the error message
169  * @fmt: The format string
170  *
171  * Store the supplementary error message for the process if the process has
172  * enabled the facility and return -EINVAL.
173  */
174 #define invalf(fc, fmt, ...) ({ errorf(fc, fmt, ## __VA_ARGS__); -EINVAL; })
175
176 #endif /* _LINUX_FS_CONTEXT_H */