xref: /linux/fs/nfsd/netns.h (revision a3a4a816b4b194c45d0217e8b9e08b2639802cda)
1 /*
2  * per net namespace data structures for nfsd
3  *
4  * Copyright (C) 2012, Jeff Layton <jlayton@redhat.com>
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the Free
8  * Software Foundation; either version 2 of the License, or (at your option)
9  * any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program; if not, write to the Free Software Foundation, Inc., 51
18  * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  */
20 
21 #ifndef __NFSD_NETNS_H__
22 #define __NFSD_NETNS_H__
23 
24 #include <net/net_namespace.h>
25 #include <net/netns/generic.h>
26 
27 /* Hash tables for nfs4_clientid state */
28 #define CLIENT_HASH_BITS                 4
29 #define CLIENT_HASH_SIZE                (1 << CLIENT_HASH_BITS)
30 #define CLIENT_HASH_MASK                (CLIENT_HASH_SIZE - 1)
31 
32 #define SESSION_HASH_SIZE	512
33 
34 struct cld_net;
35 struct nfsd4_client_tracking_ops;
36 
37 /*
38  * Represents a nfsd "container". With respect to nfsv4 state tracking, the
39  * fields of interest are the *_id_hashtbls and the *_name_tree. These track
40  * the nfs4_client objects by either short or long form clientid.
41  *
42  * Each nfsd_net runs a nfs4_laundromat workqueue job when necessary to clean
43  * up expired clients and delegations within the container.
44  */
45 struct nfsd_net {
46 	struct cld_net *cld_net;
47 
48 	struct cache_detail *svc_expkey_cache;
49 	struct cache_detail *svc_export_cache;
50 
51 	struct cache_detail *idtoname_cache;
52 	struct cache_detail *nametoid_cache;
53 
54 	struct lock_manager nfsd4_manager;
55 	bool grace_ended;
56 	time_t boot_time;
57 
58 	/*
59 	 * reclaim_str_hashtbl[] holds known client info from previous reset/reboot
60 	 * used in reboot/reset lease grace period processing
61 	 *
62 	 * conf_id_hashtbl[], and conf_name_tree hold confirmed
63 	 * setclientid_confirmed info.
64 	 *
65 	 * unconf_str_hastbl[] and unconf_name_tree hold unconfirmed
66 	 * setclientid info.
67 	 */
68 	struct list_head *reclaim_str_hashtbl;
69 	int reclaim_str_hashtbl_size;
70 	struct list_head *conf_id_hashtbl;
71 	struct rb_root conf_name_tree;
72 	struct list_head *unconf_id_hashtbl;
73 	struct rb_root unconf_name_tree;
74 	struct list_head *sessionid_hashtbl;
75 	/*
76 	 * client_lru holds client queue ordered by nfs4_client.cl_time
77 	 * for lease renewal.
78 	 *
79 	 * close_lru holds (open) stateowner queue ordered by nfs4_stateowner.so_time
80 	 * for last close replay.
81 	 *
82 	 * All of the above fields are protected by the client_mutex.
83 	 */
84 	struct list_head client_lru;
85 	struct list_head close_lru;
86 	struct list_head del_recall_lru;
87 
88 	/* protected by blocked_locks_lock */
89 	struct list_head blocked_locks_lru;
90 
91 	struct delayed_work laundromat_work;
92 
93 	/* client_lock protects the client lru list and session hash table */
94 	spinlock_t client_lock;
95 
96 	/* protects blocked_locks_lru */
97 	spinlock_t blocked_locks_lock;
98 
99 	struct file *rec_file;
100 	bool in_grace;
101 	const struct nfsd4_client_tracking_ops *client_tracking_ops;
102 
103 	time_t nfsd4_lease;
104 	time_t nfsd4_grace;
105 
106 	bool nfsd_net_up;
107 	bool lockd_up;
108 
109 	/* Time of server startup */
110 	struct timeval nfssvc_boot;
111 
112 	/*
113 	 * Max number of connections this nfsd container will allow. Defaults
114 	 * to '0' which is means that it bases this on the number of threads.
115 	 */
116 	unsigned int max_connections;
117 
118 	u32 clientid_counter;
119 	u32 clverifier_counter;
120 
121 	struct svc_serv *nfsd_serv;
122 };
123 
124 /* Simple check to find out if a given net was properly initialized */
125 #define nfsd_netns_ready(nn) ((nn)->sessionid_hashtbl)
126 
127 extern unsigned int nfsd_net_id;
128 #endif /* __NFSD_NETNS_H__ */
129