1 // SPDX-License-Identifier: GPL-2.0
3 * NFS exporting and validation.
5 * We maintain a list of clients, each of which has a list of
6 * exports. To export an fs to a given client, you first have
7 * to create the client entry with NFSCTL_ADDCLIENT, which
8 * creates a client control block and adds it to the hash
9 * table. Then, you call NFSCTL_EXPORT for each fs.
12 * Copyright (C) 1995, 1996 Olaf Kirch, <okir@monad.swb.de>
15 #include <linux/slab.h>
16 #include <linux/namei.h>
17 #include <linux/module.h>
18 #include <linux/exportfs.h>
19 #include <linux/sunrpc/svc_xprt.h>
25 #include "filecache.h"
28 #define NFSDDBG_FACILITY NFSDDBG_EXPORT
32 * One maps client+vfsmnt+dentry to export options - the export map
33 * The other maps client+filehandle-fragment to export options. - the expkey map
35 * The export options are actually stored in the first map, and the
36 * second map contains a reference to the entry in the first map.
39 #define EXPKEY_HASHBITS 8
40 #define EXPKEY_HASHMAX (1 << EXPKEY_HASHBITS)
41 #define EXPKEY_HASHMASK (EXPKEY_HASHMAX -1)
43 static void expkey_put(struct kref *ref)
45 struct svc_expkey *key = container_of(ref, struct svc_expkey, h.ref);
47 if (test_bit(CACHE_VALID, &key->h.flags) &&
48 !test_bit(CACHE_NEGATIVE, &key->h.flags))
49 path_put(&key->ek_path);
50 auth_domain_put(key->ek_client);
51 kfree_rcu(key, ek_rcu);
54 static int expkey_upcall(struct cache_detail *cd, struct cache_head *h)
56 return sunrpc_cache_pipe_upcall(cd, h);
59 static void expkey_request(struct cache_detail *cd,
61 char **bpp, int *blen)
63 /* client fsidtype \xfsid */
64 struct svc_expkey *ek = container_of(h, struct svc_expkey, h);
67 qword_add(bpp, blen, ek->ek_client->name);
68 snprintf(type, 5, "%d", ek->ek_fsidtype);
69 qword_add(bpp, blen, type);
70 qword_addhex(bpp, blen, (char*)ek->ek_fsid, key_len(ek->ek_fsidtype));
74 static struct svc_expkey *svc_expkey_update(struct cache_detail *cd, struct svc_expkey *new,
75 struct svc_expkey *old);
76 static struct svc_expkey *svc_expkey_lookup(struct cache_detail *cd, struct svc_expkey *);
78 static int expkey_parse(struct cache_detail *cd, char *mesg, int mlen)
80 /* client fsidtype fsid expiry [path] */
83 struct auth_domain *dom = NULL;
87 struct svc_expkey key;
88 struct svc_expkey *ek = NULL;
90 if (mesg[mlen - 1] != '\n')
94 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
100 if ((len=qword_get(&mesg, buf, PAGE_SIZE)) <= 0)
104 dom = auth_domain_find(buf);
107 dprintk("found domain %s\n", buf);
110 if ((len=qword_get(&mesg, buf, PAGE_SIZE)) <= 0)
112 fsidtype = simple_strtoul(buf, &ep, 10);
115 dprintk("found fsidtype %d\n", fsidtype);
116 if (key_len(fsidtype)==0) /* invalid type */
118 if ((len=qword_get(&mesg, buf, PAGE_SIZE)) <= 0)
120 dprintk("found fsid length %d\n", len);
121 if (len != key_len(fsidtype))
124 /* OK, we seem to have a valid key */
126 key.h.expiry_time = get_expiry(&mesg);
127 if (key.h.expiry_time == 0)
131 key.ek_fsidtype = fsidtype;
132 memcpy(key.ek_fsid, buf, len);
134 ek = svc_expkey_lookup(cd, &key);
139 /* now we want a pathname, or empty meaning NEGATIVE */
141 len = qword_get(&mesg, buf, PAGE_SIZE);
144 dprintk("Path seems to be <%s>\n", buf);
147 set_bit(CACHE_NEGATIVE, &key.h.flags);
148 ek = svc_expkey_update(cd, &key, ek);
150 trace_nfsd_expkey_update(ek, NULL);
154 err = kern_path(buf, 0, &key.ek_path);
158 dprintk("Found the path %s\n", buf);
160 ek = svc_expkey_update(cd, &key, ek);
162 trace_nfsd_expkey_update(ek, buf);
165 path_put(&key.ek_path);
170 cache_put(&ek->h, cd);
172 auth_domain_put(dom);
177 static int expkey_show(struct seq_file *m,
178 struct cache_detail *cd,
179 struct cache_head *h)
181 struct svc_expkey *ek ;
185 seq_puts(m, "#domain fsidtype fsid [path]\n");
188 ek = container_of(h, struct svc_expkey, h);
189 seq_printf(m, "%s %d 0x", ek->ek_client->name,
191 for (i=0; i < key_len(ek->ek_fsidtype)/4; i++)
192 seq_printf(m, "%08x", ek->ek_fsid[i]);
193 if (test_bit(CACHE_VALID, &h->flags) &&
194 !test_bit(CACHE_NEGATIVE, &h->flags)) {
196 seq_path(m, &ek->ek_path, "\\ \t\n");
202 static inline int expkey_match (struct cache_head *a, struct cache_head *b)
204 struct svc_expkey *orig = container_of(a, struct svc_expkey, h);
205 struct svc_expkey *new = container_of(b, struct svc_expkey, h);
207 if (orig->ek_fsidtype != new->ek_fsidtype ||
208 orig->ek_client != new->ek_client ||
209 memcmp(orig->ek_fsid, new->ek_fsid, key_len(orig->ek_fsidtype)) != 0)
214 static inline void expkey_init(struct cache_head *cnew,
215 struct cache_head *citem)
217 struct svc_expkey *new = container_of(cnew, struct svc_expkey, h);
218 struct svc_expkey *item = container_of(citem, struct svc_expkey, h);
220 kref_get(&item->ek_client->ref);
221 new->ek_client = item->ek_client;
222 new->ek_fsidtype = item->ek_fsidtype;
224 memcpy(new->ek_fsid, item->ek_fsid, sizeof(new->ek_fsid));
227 static inline void expkey_update(struct cache_head *cnew,
228 struct cache_head *citem)
230 struct svc_expkey *new = container_of(cnew, struct svc_expkey, h);
231 struct svc_expkey *item = container_of(citem, struct svc_expkey, h);
233 new->ek_path = item->ek_path;
234 path_get(&item->ek_path);
237 static struct cache_head *expkey_alloc(void)
239 struct svc_expkey *i = kmalloc(sizeof(*i), GFP_KERNEL);
246 static void expkey_flush(void)
249 * Take the nfsd_mutex here to ensure that the file cache is not
250 * destroyed while we're in the middle of flushing.
252 mutex_lock(&nfsd_mutex);
253 nfsd_file_cache_purge(current->nsproxy->net_ns);
254 mutex_unlock(&nfsd_mutex);
257 static const struct cache_detail svc_expkey_cache_template = {
258 .owner = THIS_MODULE,
259 .hash_size = EXPKEY_HASHMAX,
261 .cache_put = expkey_put,
262 .cache_upcall = expkey_upcall,
263 .cache_request = expkey_request,
264 .cache_parse = expkey_parse,
265 .cache_show = expkey_show,
266 .match = expkey_match,
268 .update = expkey_update,
269 .alloc = expkey_alloc,
270 .flush = expkey_flush,
274 svc_expkey_hash(struct svc_expkey *item)
276 int hash = item->ek_fsidtype;
277 char * cp = (char*)item->ek_fsid;
278 int len = key_len(item->ek_fsidtype);
280 hash ^= hash_mem(cp, len, EXPKEY_HASHBITS);
281 hash ^= hash_ptr(item->ek_client, EXPKEY_HASHBITS);
282 hash &= EXPKEY_HASHMASK;
286 static struct svc_expkey *
287 svc_expkey_lookup(struct cache_detail *cd, struct svc_expkey *item)
289 struct cache_head *ch;
290 int hash = svc_expkey_hash(item);
292 ch = sunrpc_cache_lookup_rcu(cd, &item->h, hash);
294 return container_of(ch, struct svc_expkey, h);
299 static struct svc_expkey *
300 svc_expkey_update(struct cache_detail *cd, struct svc_expkey *new,
301 struct svc_expkey *old)
303 struct cache_head *ch;
304 int hash = svc_expkey_hash(new);
306 ch = sunrpc_cache_update(cd, &new->h, &old->h, hash);
308 return container_of(ch, struct svc_expkey, h);
314 #define EXPORT_HASHBITS 8
315 #define EXPORT_HASHMAX (1<< EXPORT_HASHBITS)
317 static void nfsd4_fslocs_free(struct nfsd4_fs_locations *fsloc)
319 struct nfsd4_fs_location *locations = fsloc->locations;
325 for (i = 0; i < fsloc->locations_count; i++) {
326 kfree(locations[i].path);
327 kfree(locations[i].hosts);
331 fsloc->locations = NULL;
334 static int export_stats_init(struct export_stats *stats)
336 stats->start_time = ktime_get_seconds();
337 return nfsd_percpu_counters_init(stats->counter, EXP_STATS_COUNTERS_NUM);
340 static void export_stats_reset(struct export_stats *stats)
342 nfsd_percpu_counters_reset(stats->counter, EXP_STATS_COUNTERS_NUM);
345 static void export_stats_destroy(struct export_stats *stats)
347 nfsd_percpu_counters_destroy(stats->counter, EXP_STATS_COUNTERS_NUM);
350 static void svc_export_put(struct kref *ref)
352 struct svc_export *exp = container_of(ref, struct svc_export, h.ref);
353 path_put(&exp->ex_path);
354 auth_domain_put(exp->ex_client);
355 nfsd4_fslocs_free(&exp->ex_fslocs);
356 export_stats_destroy(&exp->ex_stats);
358 kfree_rcu(exp, ex_rcu);
361 static int svc_export_upcall(struct cache_detail *cd, struct cache_head *h)
363 return sunrpc_cache_pipe_upcall(cd, h);
366 static void svc_export_request(struct cache_detail *cd,
367 struct cache_head *h,
368 char **bpp, int *blen)
371 struct svc_export *exp = container_of(h, struct svc_export, h);
374 qword_add(bpp, blen, exp->ex_client->name);
375 pth = d_path(&exp->ex_path, *bpp, *blen);
377 /* is this correct? */
381 qword_add(bpp, blen, pth);
385 static struct svc_export *svc_export_update(struct svc_export *new,
386 struct svc_export *old);
387 static struct svc_export *svc_export_lookup(struct svc_export *);
389 static int check_export(struct inode *inode, int *flags, unsigned char *uuid)
393 * We currently export only dirs, regular files, and (for v4
394 * pseudoroot) symlinks.
396 if (!S_ISDIR(inode->i_mode) &&
397 !S_ISLNK(inode->i_mode) &&
398 !S_ISREG(inode->i_mode))
402 * Mountd should never pass down a writeable V4ROOT export, but,
405 if (*flags & NFSEXP_V4ROOT)
406 *flags |= NFSEXP_READONLY;
408 /* There are two requirements on a filesystem to be exportable.
409 * 1: We must be able to identify the filesystem from a number.
410 * either a device number (so FS_REQUIRES_DEV needed)
411 * or an FSID number (so NFSEXP_FSID or ->uuid is needed).
412 * 2: We must be able to find an inode from a filehandle.
413 * This means that s_export_op must be set.
415 if (!(inode->i_sb->s_type->fs_flags & FS_REQUIRES_DEV) &&
416 !(*flags & NFSEXP_FSID) &&
418 dprintk("exp_export: export of non-dev fs without fsid\n");
422 if (!inode->i_sb->s_export_op ||
423 !inode->i_sb->s_export_op->fh_to_dentry) {
424 dprintk("exp_export: export of invalid fs type.\n");
428 if (inode->i_sb->s_export_op->flags & EXPORT_OP_NOSUBTREECHK &&
429 !(*flags & NFSEXP_NOSUBTREECHECK)) {
430 dprintk("%s: %s does not support subtree checking!\n",
431 __func__, inode->i_sb->s_type->name);
438 #ifdef CONFIG_NFSD_V4
441 fsloc_parse(char **mesg, char *buf, struct nfsd4_fs_locations *fsloc)
444 int migrated, i, err;
446 /* more than one fsloc */
447 if (fsloc->locations)
451 err = get_uint(mesg, &fsloc->locations_count);
454 if (fsloc->locations_count > MAX_FS_LOCATIONS)
456 if (fsloc->locations_count == 0)
459 fsloc->locations = kcalloc(fsloc->locations_count,
460 sizeof(struct nfsd4_fs_location),
462 if (!fsloc->locations)
464 for (i=0; i < fsloc->locations_count; i++) {
465 /* colon separated host list */
467 len = qword_get(mesg, buf, PAGE_SIZE);
471 fsloc->locations[i].hosts = kstrdup(buf, GFP_KERNEL);
472 if (!fsloc->locations[i].hosts)
475 /* slash separated path component list */
476 len = qword_get(mesg, buf, PAGE_SIZE);
480 fsloc->locations[i].path = kstrdup(buf, GFP_KERNEL);
481 if (!fsloc->locations[i].path)
485 err = get_int(mesg, &migrated);
489 if (migrated < 0 || migrated > 1)
491 fsloc->migrated = migrated;
494 nfsd4_fslocs_free(fsloc);
498 static int secinfo_parse(char **mesg, char *buf, struct svc_export *exp)
500 struct exp_flavor_info *f;
504 /* more than one secinfo */
505 if (exp->ex_nflavors)
508 err = get_uint(mesg, &listsize);
511 if (listsize > MAX_SECINFO_LIST)
514 for (f = exp->ex_flavors; f < exp->ex_flavors + listsize; f++) {
515 err = get_uint(mesg, &f->pseudoflavor);
519 * XXX: It would be nice to also check whether this
520 * pseudoflavor is supported, so we can discover the
521 * problem at export time instead of when a client fails
524 err = get_uint(mesg, &f->flags);
527 /* Only some flags are allowed to differ between flavors: */
528 if (~NFSEXP_SECINFO_FLAGS & (f->flags ^ exp->ex_flags))
531 exp->ex_nflavors = listsize;
535 #else /* CONFIG_NFSD_V4 */
537 fsloc_parse(char **mesg, char *buf, struct nfsd4_fs_locations *fsloc){return 0;}
539 secinfo_parse(char **mesg, char *buf, struct svc_export *exp) { return 0; }
543 nfsd_uuid_parse(char **mesg, char *buf, unsigned char **puuid)
547 /* more than one uuid */
551 /* expect a 16 byte uuid encoded as \xXXXX... */
552 len = qword_get(mesg, buf, PAGE_SIZE);
553 if (len != EX_UUID_LEN)
556 *puuid = kmemdup(buf, EX_UUID_LEN, GFP_KERNEL);
563 static int svc_export_parse(struct cache_detail *cd, char *mesg, int mlen)
565 /* client path expiry [flags anonuid anongid fsid] */
569 struct auth_domain *dom = NULL;
570 struct svc_export exp = {}, *expp;
573 if (mesg[mlen-1] != '\n')
577 buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
583 len = qword_get(&mesg, buf, PAGE_SIZE);
588 dom = auth_domain_find(buf);
594 if ((len = qword_get(&mesg, buf, PAGE_SIZE)) <= 0)
597 err = kern_path(buf, 0, &exp.ex_path);
603 exp.ex_devid_map = NULL;
607 exp.h.expiry_time = get_expiry(&mesg);
608 if (exp.h.expiry_time == 0)
612 err = get_int(&mesg, &an_int);
613 if (err == -ENOENT) {
615 set_bit(CACHE_NEGATIVE, &exp.h.flags);
617 if (err || an_int < 0)
619 exp.ex_flags= an_int;
622 err = get_int(&mesg, &an_int);
625 exp.ex_anon_uid= make_kuid(current_user_ns(), an_int);
628 err = get_int(&mesg, &an_int);
631 exp.ex_anon_gid= make_kgid(current_user_ns(), an_int);
634 err = get_int(&mesg, &an_int);
637 exp.ex_fsid = an_int;
639 while ((len = qword_get(&mesg, buf, PAGE_SIZE)) > 0) {
640 if (strcmp(buf, "fsloc") == 0)
641 err = fsloc_parse(&mesg, buf, &exp.ex_fslocs);
642 else if (strcmp(buf, "uuid") == 0)
643 err = nfsd_uuid_parse(&mesg, buf, &exp.ex_uuid);
644 else if (strcmp(buf, "secinfo") == 0)
645 err = secinfo_parse(&mesg, buf, &exp);
647 /* quietly ignore unknown words and anything
648 * following. Newer user-space can try to set
649 * new values, then see what the result was.
656 err = check_export(d_inode(exp.ex_path.dentry), &exp.ex_flags,
661 * No point caching this if it would immediately expire.
662 * Also, this protects exportfs's dummy export from the
663 * anon_uid/anon_gid checks:
665 if (exp.h.expiry_time < seconds_since_boot())
668 * For some reason exportfs has been passing down an
669 * invalid (-1) uid & gid on the "dummy" export which it
670 * uses to test export support. To make sure exportfs
671 * sees errors from check_export we therefore need to
672 * delay these checks till after check_export:
675 if (!uid_valid(exp.ex_anon_uid))
677 if (!gid_valid(exp.ex_anon_gid))
681 nfsd4_setup_layout_type(&exp);
684 expp = svc_export_lookup(&exp);
689 expp = svc_export_update(&exp, expp);
691 trace_nfsd_export_update(expp);
697 nfsd4_fslocs_free(&exp.ex_fslocs);
700 path_put(&exp.ex_path);
702 auth_domain_put(dom);
708 static void exp_flags(struct seq_file *m, int flag, int fsid,
709 kuid_t anonu, kgid_t anong, struct nfsd4_fs_locations *fslocs);
710 static void show_secinfo(struct seq_file *m, struct svc_export *exp);
712 static int is_export_stats_file(struct seq_file *m)
715 * The export_stats file uses the same ops as the exports file.
716 * We use the file's name to determine the reported info per export.
717 * There is no rename in nsfdfs, so d_name.name is stable.
719 return !strcmp(m->file->f_path.dentry->d_name.name, "export_stats");
722 static int svc_export_show(struct seq_file *m,
723 struct cache_detail *cd,
724 struct cache_head *h)
726 struct svc_export *exp;
727 bool export_stats = is_export_stats_file(m);
731 seq_puts(m, "#path domain start-time\n#\tstats\n");
733 seq_puts(m, "#path domain(flags)\n");
736 exp = container_of(h, struct svc_export, h);
737 seq_path(m, &exp->ex_path, " \t\n\\");
739 seq_escape(m, exp->ex_client->name, " \t\n\\");
741 seq_printf(m, "\t%lld\n", exp->ex_stats.start_time);
742 seq_printf(m, "\tfh_stale: %lld\n",
743 percpu_counter_sum_positive(&exp->ex_stats.counter[EXP_STATS_FH_STALE]));
744 seq_printf(m, "\tio_read: %lld\n",
745 percpu_counter_sum_positive(&exp->ex_stats.counter[EXP_STATS_IO_READ]));
746 seq_printf(m, "\tio_write: %lld\n",
747 percpu_counter_sum_positive(&exp->ex_stats.counter[EXP_STATS_IO_WRITE]));
752 if (test_bit(CACHE_VALID, &h->flags) &&
753 !test_bit(CACHE_NEGATIVE, &h->flags)) {
754 exp_flags(m, exp->ex_flags, exp->ex_fsid,
755 exp->ex_anon_uid, exp->ex_anon_gid, &exp->ex_fslocs);
758 seq_puts(m, ",uuid=");
759 for (i = 0; i < EX_UUID_LEN; i++) {
762 seq_printf(m, "%02x", exp->ex_uuid[i]);
765 show_secinfo(m, exp);
770 static int svc_export_match(struct cache_head *a, struct cache_head *b)
772 struct svc_export *orig = container_of(a, struct svc_export, h);
773 struct svc_export *new = container_of(b, struct svc_export, h);
774 return orig->ex_client == new->ex_client &&
775 path_equal(&orig->ex_path, &new->ex_path);
778 static void svc_export_init(struct cache_head *cnew, struct cache_head *citem)
780 struct svc_export *new = container_of(cnew, struct svc_export, h);
781 struct svc_export *item = container_of(citem, struct svc_export, h);
783 kref_get(&item->ex_client->ref);
784 new->ex_client = item->ex_client;
785 new->ex_path = item->ex_path;
786 path_get(&item->ex_path);
787 new->ex_fslocs.locations = NULL;
788 new->ex_fslocs.locations_count = 0;
789 new->ex_fslocs.migrated = 0;
790 new->ex_layout_types = 0;
793 export_stats_reset(&new->ex_stats);
796 static void export_update(struct cache_head *cnew, struct cache_head *citem)
798 struct svc_export *new = container_of(cnew, struct svc_export, h);
799 struct svc_export *item = container_of(citem, struct svc_export, h);
802 new->ex_flags = item->ex_flags;
803 new->ex_anon_uid = item->ex_anon_uid;
804 new->ex_anon_gid = item->ex_anon_gid;
805 new->ex_fsid = item->ex_fsid;
806 new->ex_devid_map = item->ex_devid_map;
807 item->ex_devid_map = NULL;
808 new->ex_uuid = item->ex_uuid;
809 item->ex_uuid = NULL;
810 new->ex_fslocs.locations = item->ex_fslocs.locations;
811 item->ex_fslocs.locations = NULL;
812 new->ex_fslocs.locations_count = item->ex_fslocs.locations_count;
813 item->ex_fslocs.locations_count = 0;
814 new->ex_fslocs.migrated = item->ex_fslocs.migrated;
815 item->ex_fslocs.migrated = 0;
816 new->ex_layout_types = item->ex_layout_types;
817 new->ex_nflavors = item->ex_nflavors;
818 for (i = 0; i < MAX_SECINFO_LIST; i++) {
819 new->ex_flavors[i] = item->ex_flavors[i];
823 static struct cache_head *svc_export_alloc(void)
825 struct svc_export *i = kmalloc(sizeof(*i), GFP_KERNEL);
829 if (export_stats_init(&i->ex_stats)) {
837 static const struct cache_detail svc_export_cache_template = {
838 .owner = THIS_MODULE,
839 .hash_size = EXPORT_HASHMAX,
840 .name = "nfsd.export",
841 .cache_put = svc_export_put,
842 .cache_upcall = svc_export_upcall,
843 .cache_request = svc_export_request,
844 .cache_parse = svc_export_parse,
845 .cache_show = svc_export_show,
846 .match = svc_export_match,
847 .init = svc_export_init,
848 .update = export_update,
849 .alloc = svc_export_alloc,
853 svc_export_hash(struct svc_export *exp)
857 hash = hash_ptr(exp->ex_client, EXPORT_HASHBITS);
858 hash ^= hash_ptr(exp->ex_path.dentry, EXPORT_HASHBITS);
859 hash ^= hash_ptr(exp->ex_path.mnt, EXPORT_HASHBITS);
863 static struct svc_export *
864 svc_export_lookup(struct svc_export *exp)
866 struct cache_head *ch;
867 int hash = svc_export_hash(exp);
869 ch = sunrpc_cache_lookup_rcu(exp->cd, &exp->h, hash);
871 return container_of(ch, struct svc_export, h);
876 static struct svc_export *
877 svc_export_update(struct svc_export *new, struct svc_export *old)
879 struct cache_head *ch;
880 int hash = svc_export_hash(old);
882 ch = sunrpc_cache_update(old->cd, &new->h, &old->h, hash);
884 return container_of(ch, struct svc_export, h);
890 static struct svc_expkey *
891 exp_find_key(struct cache_detail *cd, struct auth_domain *clp, int fsid_type,
892 u32 *fsidv, struct cache_req *reqp)
894 struct svc_expkey key, *ek;
898 return ERR_PTR(-ENOENT);
901 key.ek_fsidtype = fsid_type;
902 memcpy(key.ek_fsid, fsidv, key_len(fsid_type));
904 ek = svc_expkey_lookup(cd, &key);
906 return ERR_PTR(-ENOMEM);
907 err = cache_check(cd, &ek->h, reqp);
909 trace_nfsd_exp_find_key(&key, err);
915 static struct svc_export *
916 exp_get_by_name(struct cache_detail *cd, struct auth_domain *clp,
917 const struct path *path, struct cache_req *reqp)
919 struct svc_export *exp, key;
923 return ERR_PTR(-ENOENT);
929 exp = svc_export_lookup(&key);
931 return ERR_PTR(-ENOMEM);
932 err = cache_check(cd, &exp->h, reqp);
934 trace_nfsd_exp_get_by_name(&key, err);
941 * Find the export entry for a given dentry.
943 static struct svc_export *
944 exp_parent(struct cache_detail *cd, struct auth_domain *clp, struct path *path)
946 struct dentry *saved = dget(path->dentry);
947 struct svc_export *exp = exp_get_by_name(cd, clp, path, NULL);
949 while (PTR_ERR(exp) == -ENOENT && !IS_ROOT(path->dentry)) {
950 struct dentry *parent = dget_parent(path->dentry);
952 path->dentry = parent;
953 exp = exp_get_by_name(cd, clp, path, NULL);
956 path->dentry = saved;
963 * Obtain the root fh on behalf of a client.
964 * This could be done in user space, but I feel that it adds some safety
965 * since its harder to fool a kernel module than a user space program.
968 exp_rootfh(struct net *net, struct auth_domain *clp, char *name,
969 struct knfsd_fh *f, int maxsize)
971 struct svc_export *exp;
976 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
977 struct cache_detail *cd = nn->svc_export_cache;
980 /* NB: we probably ought to check that it's NUL-terminated */
981 if (kern_path(name, 0, &path)) {
982 printk("nfsd: exp_rootfh path not found %s", name);
985 inode = d_inode(path.dentry);
987 dprintk("nfsd: exp_rootfh(%s [%p] %s:%s/%ld)\n",
988 name, path.dentry, clp->name,
989 inode->i_sb->s_id, inode->i_ino);
990 exp = exp_parent(cd, clp, &path);
997 * fh must be initialized before calling fh_compose
999 fh_init(&fh, maxsize);
1000 if (fh_compose(&fh, exp, path.dentry, NULL))
1004 memcpy(f, &fh.fh_handle, sizeof(struct knfsd_fh));
1012 static struct svc_export *exp_find(struct cache_detail *cd,
1013 struct auth_domain *clp, int fsid_type,
1014 u32 *fsidv, struct cache_req *reqp)
1016 struct svc_export *exp;
1017 struct nfsd_net *nn = net_generic(cd->net, nfsd_net_id);
1018 struct svc_expkey *ek = exp_find_key(nn->svc_expkey_cache, clp, fsid_type, fsidv, reqp);
1020 return ERR_CAST(ek);
1022 exp = exp_get_by_name(cd, clp, &ek->ek_path, reqp);
1023 cache_put(&ek->h, nn->svc_expkey_cache);
1026 return ERR_CAST(exp);
1030 __be32 check_nfsd_access(struct svc_export *exp, struct svc_rqst *rqstp)
1032 struct exp_flavor_info *f;
1033 struct exp_flavor_info *end = exp->ex_flavors + exp->ex_nflavors;
1035 /* legacy gss-only clients are always OK: */
1036 if (exp->ex_client == rqstp->rq_gssclient)
1038 /* ip-address based client; check sec= export option: */
1039 for (f = exp->ex_flavors; f < end; f++) {
1040 if (f->pseudoflavor == rqstp->rq_cred.cr_flavor)
1043 /* defaults in absence of sec= options: */
1044 if (exp->ex_nflavors == 0) {
1045 if (rqstp->rq_cred.cr_flavor == RPC_AUTH_NULL ||
1046 rqstp->rq_cred.cr_flavor == RPC_AUTH_UNIX)
1050 /* If the compound op contains a spo_must_allowed op,
1051 * it will be sent with integrity/protection which
1052 * will have to be expressly allowed on mounts that
1056 if (nfsd4_spo_must_allow(rqstp))
1059 return rqstp->rq_vers < 4 ? nfserr_acces : nfserr_wrongsec;
1063 * Uses rq_client and rq_gssclient to find an export; uses rq_client (an
1064 * auth_unix client) if it's available and has secinfo information;
1065 * otherwise, will try to use rq_gssclient.
1067 * Called from functions that handle requests; functions that do work on
1068 * behalf of mountd are passed a single client name to use, and should
1069 * use exp_get_by_name() or exp_find().
1072 rqst_exp_get_by_name(struct svc_rqst *rqstp, struct path *path)
1074 struct svc_export *gssexp, *exp = ERR_PTR(-ENOENT);
1075 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
1076 struct cache_detail *cd = nn->svc_export_cache;
1078 if (rqstp->rq_client == NULL)
1081 /* First try the auth_unix client: */
1082 exp = exp_get_by_name(cd, rqstp->rq_client, path, &rqstp->rq_chandle);
1083 if (PTR_ERR(exp) == -ENOENT)
1087 /* If it has secinfo, assume there are no gss/... clients */
1088 if (exp->ex_nflavors > 0)
1091 /* Otherwise, try falling back on gss client */
1092 if (rqstp->rq_gssclient == NULL)
1094 gssexp = exp_get_by_name(cd, rqstp->rq_gssclient, path, &rqstp->rq_chandle);
1095 if (PTR_ERR(gssexp) == -ENOENT)
1103 rqst_exp_find(struct svc_rqst *rqstp, int fsid_type, u32 *fsidv)
1105 struct svc_export *gssexp, *exp = ERR_PTR(-ENOENT);
1106 struct nfsd_net *nn = net_generic(SVC_NET(rqstp), nfsd_net_id);
1107 struct cache_detail *cd = nn->svc_export_cache;
1109 if (rqstp->rq_client == NULL)
1112 /* First try the auth_unix client: */
1113 exp = exp_find(cd, rqstp->rq_client, fsid_type,
1114 fsidv, &rqstp->rq_chandle);
1115 if (PTR_ERR(exp) == -ENOENT)
1119 /* If it has secinfo, assume there are no gss/... clients */
1120 if (exp->ex_nflavors > 0)
1123 /* Otherwise, try falling back on gss client */
1124 if (rqstp->rq_gssclient == NULL)
1126 gssexp = exp_find(cd, rqstp->rq_gssclient, fsid_type, fsidv,
1127 &rqstp->rq_chandle);
1128 if (PTR_ERR(gssexp) == -ENOENT)
1136 rqst_exp_parent(struct svc_rqst *rqstp, struct path *path)
1138 struct dentry *saved = dget(path->dentry);
1139 struct svc_export *exp = rqst_exp_get_by_name(rqstp, path);
1141 while (PTR_ERR(exp) == -ENOENT && !IS_ROOT(path->dentry)) {
1142 struct dentry *parent = dget_parent(path->dentry);
1144 path->dentry = parent;
1145 exp = rqst_exp_get_by_name(rqstp, path);
1148 path->dentry = saved;
1152 struct svc_export *rqst_find_fsidzero_export(struct svc_rqst *rqstp)
1156 mk_fsid(FSID_NUM, fsidv, 0, 0, 0, NULL);
1158 return rqst_exp_find(rqstp, FSID_NUM, fsidv);
1162 * Called when we need the filehandle for the root of the pseudofs,
1163 * for a given NFSv4 client. The root is defined to be the
1164 * export point with fsid==0
1167 exp_pseudoroot(struct svc_rqst *rqstp, struct svc_fh *fhp)
1169 struct svc_export *exp;
1172 exp = rqst_find_fsidzero_export(rqstp);
1174 return nfserrno(PTR_ERR(exp));
1175 rv = fh_compose(fhp, exp, exp->ex_path.dentry, NULL);
1180 static struct flags {
1184 { NFSEXP_READONLY, {"ro", "rw"}},
1185 { NFSEXP_INSECURE_PORT, {"insecure", ""}},
1186 { NFSEXP_ROOTSQUASH, {"root_squash", "no_root_squash"}},
1187 { NFSEXP_ALLSQUASH, {"all_squash", ""}},
1188 { NFSEXP_ASYNC, {"async", "sync"}},
1189 { NFSEXP_GATHERED_WRITES, {"wdelay", "no_wdelay"}},
1190 { NFSEXP_NOREADDIRPLUS, {"nordirplus", ""}},
1191 { NFSEXP_NOHIDE, {"nohide", ""}},
1192 { NFSEXP_CROSSMOUNT, {"crossmnt", ""}},
1193 { NFSEXP_NOSUBTREECHECK, {"no_subtree_check", ""}},
1194 { NFSEXP_NOAUTHNLM, {"insecure_locks", ""}},
1195 { NFSEXP_V4ROOT, {"v4root", ""}},
1196 { NFSEXP_PNFS, {"pnfs", ""}},
1197 { NFSEXP_SECURITY_LABEL, {"security_label", ""}},
1201 static void show_expflags(struct seq_file *m, int flags, int mask)
1204 int state, first = 0;
1206 for (flg = expflags; flg->flag; flg++) {
1207 if (flg->flag & ~mask)
1209 state = (flg->flag & flags) ? 0 : 1;
1210 if (*flg->name[state])
1211 seq_printf(m, "%s%s", first++?",":"", flg->name[state]);
1215 static void show_secinfo_flags(struct seq_file *m, int flags)
1218 show_expflags(m, flags, NFSEXP_SECINFO_FLAGS);
1221 static bool secinfo_flags_equal(int f, int g)
1223 f &= NFSEXP_SECINFO_FLAGS;
1224 g &= NFSEXP_SECINFO_FLAGS;
1228 static int show_secinfo_run(struct seq_file *m, struct exp_flavor_info **fp, struct exp_flavor_info *end)
1232 flags = (*fp)->flags;
1233 seq_printf(m, ",sec=%d", (*fp)->pseudoflavor);
1235 while (*fp != end && secinfo_flags_equal(flags, (*fp)->flags)) {
1236 seq_printf(m, ":%d", (*fp)->pseudoflavor);
1242 static void show_secinfo(struct seq_file *m, struct svc_export *exp)
1244 struct exp_flavor_info *f;
1245 struct exp_flavor_info *end = exp->ex_flavors + exp->ex_nflavors;
1248 if (exp->ex_nflavors == 0)
1250 f = exp->ex_flavors;
1251 flags = show_secinfo_run(m, &f, end);
1252 if (!secinfo_flags_equal(flags, exp->ex_flags))
1253 show_secinfo_flags(m, flags);
1255 flags = show_secinfo_run(m, &f, end);
1256 show_secinfo_flags(m, flags);
1260 static void exp_flags(struct seq_file *m, int flag, int fsid,
1261 kuid_t anonu, kgid_t anong, struct nfsd4_fs_locations *fsloc)
1263 struct user_namespace *userns = m->file->f_cred->user_ns;
1265 show_expflags(m, flag, NFSEXP_ALLFLAGS);
1266 if (flag & NFSEXP_FSID)
1267 seq_printf(m, ",fsid=%d", fsid);
1268 if (!uid_eq(anonu, make_kuid(userns, (uid_t)-2)) &&
1269 !uid_eq(anonu, make_kuid(userns, 0x10000-2)))
1270 seq_printf(m, ",anonuid=%u", from_kuid_munged(userns, anonu));
1271 if (!gid_eq(anong, make_kgid(userns, (gid_t)-2)) &&
1272 !gid_eq(anong, make_kgid(userns, 0x10000-2)))
1273 seq_printf(m, ",anongid=%u", from_kgid_munged(userns, anong));
1274 if (fsloc && fsloc->locations_count > 0) {
1275 char *loctype = (fsloc->migrated) ? "refer" : "replicas";
1278 seq_printf(m, ",%s=", loctype);
1279 seq_escape(m, fsloc->locations[0].path, ",;@ \t\n\\");
1281 seq_escape(m, fsloc->locations[0].hosts, ",;@ \t\n\\");
1282 for (i = 1; i < fsloc->locations_count; i++) {
1284 seq_escape(m, fsloc->locations[i].path, ",;@ \t\n\\");
1286 seq_escape(m, fsloc->locations[i].hosts, ",;@ \t\n\\");
1291 static int e_show(struct seq_file *m, void *p)
1293 struct cache_head *cp = p;
1294 struct svc_export *exp = container_of(cp, struct svc_export, h);
1295 struct cache_detail *cd = m->private;
1296 bool export_stats = is_export_stats_file(m);
1298 if (p == SEQ_START_TOKEN) {
1299 seq_puts(m, "# Version 1.1\n");
1301 seq_puts(m, "# Path Client Start-time\n#\tStats\n");
1303 seq_puts(m, "# Path Client(Flags) # IPs\n");
1308 if (cache_check(cd, &exp->h, NULL))
1311 return svc_export_show(m, cd, cp);
1314 const struct seq_operations nfs_exports_op = {
1315 .start = cache_seq_start_rcu,
1316 .next = cache_seq_next_rcu,
1317 .stop = cache_seq_stop_rcu,
1322 * Initialize the exports module.
1325 nfsd_export_init(struct net *net)
1328 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1330 dprintk("nfsd: initializing export module (net: %x).\n", net->ns.inum);
1332 nn->svc_export_cache = cache_create_net(&svc_export_cache_template, net);
1333 if (IS_ERR(nn->svc_export_cache))
1334 return PTR_ERR(nn->svc_export_cache);
1335 rv = cache_register_net(nn->svc_export_cache, net);
1337 goto destroy_export_cache;
1339 nn->svc_expkey_cache = cache_create_net(&svc_expkey_cache_template, net);
1340 if (IS_ERR(nn->svc_expkey_cache)) {
1341 rv = PTR_ERR(nn->svc_expkey_cache);
1342 goto unregister_export_cache;
1344 rv = cache_register_net(nn->svc_expkey_cache, net);
1346 goto destroy_expkey_cache;
1349 destroy_expkey_cache:
1350 cache_destroy_net(nn->svc_expkey_cache, net);
1351 unregister_export_cache:
1352 cache_unregister_net(nn->svc_export_cache, net);
1353 destroy_export_cache:
1354 cache_destroy_net(nn->svc_export_cache, net);
1359 * Flush exports table - called when last nfsd thread is killed
1362 nfsd_export_flush(struct net *net)
1364 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1366 cache_purge(nn->svc_expkey_cache);
1367 cache_purge(nn->svc_export_cache);
1371 * Shutdown the exports module.
1374 nfsd_export_shutdown(struct net *net)
1376 struct nfsd_net *nn = net_generic(net, nfsd_net_id);
1378 dprintk("nfsd: shutting down export module (net: %x).\n", net->ns.inum);
1380 cache_unregister_net(nn->svc_expkey_cache, net);
1381 cache_unregister_net(nn->svc_export_cache, net);
1382 cache_destroy_net(nn->svc_expkey_cache, net);
1383 cache_destroy_net(nn->svc_export_cache, net);
1384 svcauth_unix_purge(net);
1386 dprintk("nfsd: export shutdown complete (net: %x).\n", net->ns.inum);