1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * linux/fs/filesystems.c
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (C) 1991, 1992 Linus Torvalds
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * table of configured filesystems
8*4882a593Smuzhiyun */
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <linux/syscalls.h>
11*4882a593Smuzhiyun #include <linux/fs.h>
12*4882a593Smuzhiyun #include <linux/proc_fs.h>
13*4882a593Smuzhiyun #include <linux/seq_file.h>
14*4882a593Smuzhiyun #include <linux/kmod.h>
15*4882a593Smuzhiyun #include <linux/init.h>
16*4882a593Smuzhiyun #include <linux/module.h>
17*4882a593Smuzhiyun #include <linux/slab.h>
18*4882a593Smuzhiyun #include <linux/uaccess.h>
19*4882a593Smuzhiyun #include <linux/fs_parser.h>
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun /*
22*4882a593Smuzhiyun * Handling of filesystem drivers list.
23*4882a593Smuzhiyun * Rules:
24*4882a593Smuzhiyun * Inclusion to/removals from/scanning of list are protected by spinlock.
25*4882a593Smuzhiyun * During the unload module must call unregister_filesystem().
26*4882a593Smuzhiyun * We can access the fields of list element if:
27*4882a593Smuzhiyun * 1) spinlock is held or
28*4882a593Smuzhiyun * 2) we hold the reference to the module.
29*4882a593Smuzhiyun * The latter can be guaranteed by call of try_module_get(); if it
30*4882a593Smuzhiyun * returned 0 we must skip the element, otherwise we got the reference.
31*4882a593Smuzhiyun * Once the reference is obtained we can drop the spinlock.
32*4882a593Smuzhiyun */
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun static struct file_system_type *file_systems;
35*4882a593Smuzhiyun static DEFINE_RWLOCK(file_systems_lock);
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun /* WARNING: This can be used only if we _already_ own a reference */
get_filesystem(struct file_system_type * fs)38*4882a593Smuzhiyun struct file_system_type *get_filesystem(struct file_system_type *fs)
39*4882a593Smuzhiyun {
40*4882a593Smuzhiyun __module_get(fs->owner);
41*4882a593Smuzhiyun return fs;
42*4882a593Smuzhiyun }
43*4882a593Smuzhiyun
put_filesystem(struct file_system_type * fs)44*4882a593Smuzhiyun void put_filesystem(struct file_system_type *fs)
45*4882a593Smuzhiyun {
46*4882a593Smuzhiyun module_put(fs->owner);
47*4882a593Smuzhiyun }
48*4882a593Smuzhiyun
find_filesystem(const char * name,unsigned len)49*4882a593Smuzhiyun static struct file_system_type **find_filesystem(const char *name, unsigned len)
50*4882a593Smuzhiyun {
51*4882a593Smuzhiyun struct file_system_type **p;
52*4882a593Smuzhiyun for (p = &file_systems; *p; p = &(*p)->next)
53*4882a593Smuzhiyun if (strncmp((*p)->name, name, len) == 0 &&
54*4882a593Smuzhiyun !(*p)->name[len])
55*4882a593Smuzhiyun break;
56*4882a593Smuzhiyun return p;
57*4882a593Smuzhiyun }
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun /**
60*4882a593Smuzhiyun * register_filesystem - register a new filesystem
61*4882a593Smuzhiyun * @fs: the file system structure
62*4882a593Smuzhiyun *
63*4882a593Smuzhiyun * Adds the file system passed to the list of file systems the kernel
64*4882a593Smuzhiyun * is aware of for mount and other syscalls. Returns 0 on success,
65*4882a593Smuzhiyun * or a negative errno code on an error.
66*4882a593Smuzhiyun *
67*4882a593Smuzhiyun * The &struct file_system_type that is passed is linked into the kernel
68*4882a593Smuzhiyun * structures and must not be freed until the file system has been
69*4882a593Smuzhiyun * unregistered.
70*4882a593Smuzhiyun */
71*4882a593Smuzhiyun
register_filesystem(struct file_system_type * fs)72*4882a593Smuzhiyun int register_filesystem(struct file_system_type * fs)
73*4882a593Smuzhiyun {
74*4882a593Smuzhiyun int res = 0;
75*4882a593Smuzhiyun struct file_system_type ** p;
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun if (fs->parameters &&
78*4882a593Smuzhiyun !fs_validate_description(fs->name, fs->parameters))
79*4882a593Smuzhiyun return -EINVAL;
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun BUG_ON(strchr(fs->name, '.'));
82*4882a593Smuzhiyun if (fs->next)
83*4882a593Smuzhiyun return -EBUSY;
84*4882a593Smuzhiyun write_lock(&file_systems_lock);
85*4882a593Smuzhiyun p = find_filesystem(fs->name, strlen(fs->name));
86*4882a593Smuzhiyun if (*p)
87*4882a593Smuzhiyun res = -EBUSY;
88*4882a593Smuzhiyun else
89*4882a593Smuzhiyun *p = fs;
90*4882a593Smuzhiyun write_unlock(&file_systems_lock);
91*4882a593Smuzhiyun return res;
92*4882a593Smuzhiyun }
93*4882a593Smuzhiyun
94*4882a593Smuzhiyun EXPORT_SYMBOL(register_filesystem);
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun /**
97*4882a593Smuzhiyun * unregister_filesystem - unregister a file system
98*4882a593Smuzhiyun * @fs: filesystem to unregister
99*4882a593Smuzhiyun *
100*4882a593Smuzhiyun * Remove a file system that was previously successfully registered
101*4882a593Smuzhiyun * with the kernel. An error is returned if the file system is not found.
102*4882a593Smuzhiyun * Zero is returned on a success.
103*4882a593Smuzhiyun *
104*4882a593Smuzhiyun * Once this function has returned the &struct file_system_type structure
105*4882a593Smuzhiyun * may be freed or reused.
106*4882a593Smuzhiyun */
107*4882a593Smuzhiyun
unregister_filesystem(struct file_system_type * fs)108*4882a593Smuzhiyun int unregister_filesystem(struct file_system_type * fs)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun struct file_system_type ** tmp;
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun write_lock(&file_systems_lock);
113*4882a593Smuzhiyun tmp = &file_systems;
114*4882a593Smuzhiyun while (*tmp) {
115*4882a593Smuzhiyun if (fs == *tmp) {
116*4882a593Smuzhiyun *tmp = fs->next;
117*4882a593Smuzhiyun fs->next = NULL;
118*4882a593Smuzhiyun write_unlock(&file_systems_lock);
119*4882a593Smuzhiyun synchronize_rcu();
120*4882a593Smuzhiyun return 0;
121*4882a593Smuzhiyun }
122*4882a593Smuzhiyun tmp = &(*tmp)->next;
123*4882a593Smuzhiyun }
124*4882a593Smuzhiyun write_unlock(&file_systems_lock);
125*4882a593Smuzhiyun
126*4882a593Smuzhiyun return -EINVAL;
127*4882a593Smuzhiyun }
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun EXPORT_SYMBOL(unregister_filesystem);
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun #ifdef CONFIG_SYSFS_SYSCALL
fs_index(const char __user * __name)132*4882a593Smuzhiyun static int fs_index(const char __user * __name)
133*4882a593Smuzhiyun {
134*4882a593Smuzhiyun struct file_system_type * tmp;
135*4882a593Smuzhiyun struct filename *name;
136*4882a593Smuzhiyun int err, index;
137*4882a593Smuzhiyun
138*4882a593Smuzhiyun name = getname(__name);
139*4882a593Smuzhiyun err = PTR_ERR(name);
140*4882a593Smuzhiyun if (IS_ERR(name))
141*4882a593Smuzhiyun return err;
142*4882a593Smuzhiyun
143*4882a593Smuzhiyun err = -EINVAL;
144*4882a593Smuzhiyun read_lock(&file_systems_lock);
145*4882a593Smuzhiyun for (tmp=file_systems, index=0 ; tmp ; tmp=tmp->next, index++) {
146*4882a593Smuzhiyun if (strcmp(tmp->name, name->name) == 0) {
147*4882a593Smuzhiyun err = index;
148*4882a593Smuzhiyun break;
149*4882a593Smuzhiyun }
150*4882a593Smuzhiyun }
151*4882a593Smuzhiyun read_unlock(&file_systems_lock);
152*4882a593Smuzhiyun putname(name);
153*4882a593Smuzhiyun return err;
154*4882a593Smuzhiyun }
155*4882a593Smuzhiyun
fs_name(unsigned int index,char __user * buf)156*4882a593Smuzhiyun static int fs_name(unsigned int index, char __user * buf)
157*4882a593Smuzhiyun {
158*4882a593Smuzhiyun struct file_system_type * tmp;
159*4882a593Smuzhiyun int len, res;
160*4882a593Smuzhiyun
161*4882a593Smuzhiyun read_lock(&file_systems_lock);
162*4882a593Smuzhiyun for (tmp = file_systems; tmp; tmp = tmp->next, index--)
163*4882a593Smuzhiyun if (index <= 0 && try_module_get(tmp->owner))
164*4882a593Smuzhiyun break;
165*4882a593Smuzhiyun read_unlock(&file_systems_lock);
166*4882a593Smuzhiyun if (!tmp)
167*4882a593Smuzhiyun return -EINVAL;
168*4882a593Smuzhiyun
169*4882a593Smuzhiyun /* OK, we got the reference, so we can safely block */
170*4882a593Smuzhiyun len = strlen(tmp->name) + 1;
171*4882a593Smuzhiyun res = copy_to_user(buf, tmp->name, len) ? -EFAULT : 0;
172*4882a593Smuzhiyun put_filesystem(tmp);
173*4882a593Smuzhiyun return res;
174*4882a593Smuzhiyun }
175*4882a593Smuzhiyun
fs_maxindex(void)176*4882a593Smuzhiyun static int fs_maxindex(void)
177*4882a593Smuzhiyun {
178*4882a593Smuzhiyun struct file_system_type * tmp;
179*4882a593Smuzhiyun int index;
180*4882a593Smuzhiyun
181*4882a593Smuzhiyun read_lock(&file_systems_lock);
182*4882a593Smuzhiyun for (tmp = file_systems, index = 0 ; tmp ; tmp = tmp->next, index++)
183*4882a593Smuzhiyun ;
184*4882a593Smuzhiyun read_unlock(&file_systems_lock);
185*4882a593Smuzhiyun return index;
186*4882a593Smuzhiyun }
187*4882a593Smuzhiyun
188*4882a593Smuzhiyun /*
189*4882a593Smuzhiyun * Whee.. Weird sysv syscall.
190*4882a593Smuzhiyun */
SYSCALL_DEFINE3(sysfs,int,option,unsigned long,arg1,unsigned long,arg2)191*4882a593Smuzhiyun SYSCALL_DEFINE3(sysfs, int, option, unsigned long, arg1, unsigned long, arg2)
192*4882a593Smuzhiyun {
193*4882a593Smuzhiyun int retval = -EINVAL;
194*4882a593Smuzhiyun
195*4882a593Smuzhiyun switch (option) {
196*4882a593Smuzhiyun case 1:
197*4882a593Smuzhiyun retval = fs_index((const char __user *) arg1);
198*4882a593Smuzhiyun break;
199*4882a593Smuzhiyun
200*4882a593Smuzhiyun case 2:
201*4882a593Smuzhiyun retval = fs_name(arg1, (char __user *) arg2);
202*4882a593Smuzhiyun break;
203*4882a593Smuzhiyun
204*4882a593Smuzhiyun case 3:
205*4882a593Smuzhiyun retval = fs_maxindex();
206*4882a593Smuzhiyun break;
207*4882a593Smuzhiyun }
208*4882a593Smuzhiyun return retval;
209*4882a593Smuzhiyun }
210*4882a593Smuzhiyun #endif
211*4882a593Smuzhiyun
get_filesystem_list(char * buf)212*4882a593Smuzhiyun int __init get_filesystem_list(char *buf)
213*4882a593Smuzhiyun {
214*4882a593Smuzhiyun int len = 0;
215*4882a593Smuzhiyun struct file_system_type * tmp;
216*4882a593Smuzhiyun
217*4882a593Smuzhiyun read_lock(&file_systems_lock);
218*4882a593Smuzhiyun tmp = file_systems;
219*4882a593Smuzhiyun while (tmp && len < PAGE_SIZE - 80) {
220*4882a593Smuzhiyun len += sprintf(buf+len, "%s\t%s\n",
221*4882a593Smuzhiyun (tmp->fs_flags & FS_REQUIRES_DEV) ? "" : "nodev",
222*4882a593Smuzhiyun tmp->name);
223*4882a593Smuzhiyun tmp = tmp->next;
224*4882a593Smuzhiyun }
225*4882a593Smuzhiyun read_unlock(&file_systems_lock);
226*4882a593Smuzhiyun return len;
227*4882a593Smuzhiyun }
228*4882a593Smuzhiyun
229*4882a593Smuzhiyun #ifdef CONFIG_PROC_FS
filesystems_proc_show(struct seq_file * m,void * v)230*4882a593Smuzhiyun static int filesystems_proc_show(struct seq_file *m, void *v)
231*4882a593Smuzhiyun {
232*4882a593Smuzhiyun struct file_system_type * tmp;
233*4882a593Smuzhiyun
234*4882a593Smuzhiyun read_lock(&file_systems_lock);
235*4882a593Smuzhiyun tmp = file_systems;
236*4882a593Smuzhiyun while (tmp) {
237*4882a593Smuzhiyun seq_printf(m, "%s\t%s\n",
238*4882a593Smuzhiyun (tmp->fs_flags & FS_REQUIRES_DEV) ? "" : "nodev",
239*4882a593Smuzhiyun tmp->name);
240*4882a593Smuzhiyun tmp = tmp->next;
241*4882a593Smuzhiyun }
242*4882a593Smuzhiyun read_unlock(&file_systems_lock);
243*4882a593Smuzhiyun return 0;
244*4882a593Smuzhiyun }
245*4882a593Smuzhiyun
proc_filesystems_init(void)246*4882a593Smuzhiyun static int __init proc_filesystems_init(void)
247*4882a593Smuzhiyun {
248*4882a593Smuzhiyun proc_create_single("filesystems", 0, NULL, filesystems_proc_show);
249*4882a593Smuzhiyun return 0;
250*4882a593Smuzhiyun }
251*4882a593Smuzhiyun module_init(proc_filesystems_init);
252*4882a593Smuzhiyun #endif
253*4882a593Smuzhiyun
__get_fs_type(const char * name,int len)254*4882a593Smuzhiyun static struct file_system_type *__get_fs_type(const char *name, int len)
255*4882a593Smuzhiyun {
256*4882a593Smuzhiyun struct file_system_type *fs;
257*4882a593Smuzhiyun
258*4882a593Smuzhiyun read_lock(&file_systems_lock);
259*4882a593Smuzhiyun fs = *(find_filesystem(name, len));
260*4882a593Smuzhiyun if (fs && !try_module_get(fs->owner))
261*4882a593Smuzhiyun fs = NULL;
262*4882a593Smuzhiyun read_unlock(&file_systems_lock);
263*4882a593Smuzhiyun return fs;
264*4882a593Smuzhiyun }
265*4882a593Smuzhiyun
get_fs_type(const char * name)266*4882a593Smuzhiyun struct file_system_type *get_fs_type(const char *name)
267*4882a593Smuzhiyun {
268*4882a593Smuzhiyun struct file_system_type *fs;
269*4882a593Smuzhiyun const char *dot = strchr(name, '.');
270*4882a593Smuzhiyun int len = dot ? dot - name : strlen(name);
271*4882a593Smuzhiyun
272*4882a593Smuzhiyun fs = __get_fs_type(name, len);
273*4882a593Smuzhiyun if (!fs && (request_module("fs-%.*s", len, name) == 0)) {
274*4882a593Smuzhiyun fs = __get_fs_type(name, len);
275*4882a593Smuzhiyun if (!fs)
276*4882a593Smuzhiyun pr_warn_once("request_module fs-%.*s succeeded, but still no fs?\n",
277*4882a593Smuzhiyun len, name);
278*4882a593Smuzhiyun }
279*4882a593Smuzhiyun
280*4882a593Smuzhiyun if (dot && fs && !(fs->fs_flags & FS_HAS_SUBTYPE)) {
281*4882a593Smuzhiyun put_filesystem(fs);
282*4882a593Smuzhiyun fs = NULL;
283*4882a593Smuzhiyun }
284*4882a593Smuzhiyun return fs;
285*4882a593Smuzhiyun }
286*4882a593Smuzhiyun
287*4882a593Smuzhiyun EXPORT_SYMBOL(get_fs_type);
288