xref: /kernel/linux/linux-6.6/fs/nfsd/netns.h (revision 62306a36)
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * per net namespace data structures for nfsd
4 *
5 * Copyright (C) 2012, Jeff Layton <jlayton@redhat.com>
6 */
7
8#ifndef __NFSD_NETNS_H__
9#define __NFSD_NETNS_H__
10
11#include <net/net_namespace.h>
12#include <net/netns/generic.h>
13#include <linux/filelock.h>
14#include <linux/percpu_counter.h>
15#include <linux/siphash.h>
16
17/* Hash tables for nfs4_clientid state */
18#define CLIENT_HASH_BITS                 4
19#define CLIENT_HASH_SIZE                (1 << CLIENT_HASH_BITS)
20#define CLIENT_HASH_MASK                (CLIENT_HASH_SIZE - 1)
21
22#define SESSION_HASH_SIZE	512
23
24struct cld_net;
25struct nfsd4_client_tracking_ops;
26
27enum {
28	/* cache misses due only to checksum comparison failures */
29	NFSD_NET_PAYLOAD_MISSES,
30	/* amount of memory (in bytes) currently consumed by the DRC */
31	NFSD_NET_DRC_MEM_USAGE,
32	NFSD_NET_COUNTERS_NUM
33};
34
35/*
36 * Represents a nfsd "container". With respect to nfsv4 state tracking, the
37 * fields of interest are the *_id_hashtbls and the *_name_tree. These track
38 * the nfs4_client objects by either short or long form clientid.
39 *
40 * Each nfsd_net runs a nfs4_laundromat workqueue job when necessary to clean
41 * up expired clients and delegations within the container.
42 */
43struct nfsd_net {
44	struct cld_net *cld_net;
45
46	struct cache_detail *svc_expkey_cache;
47	struct cache_detail *svc_export_cache;
48
49	struct cache_detail *idtoname_cache;
50	struct cache_detail *nametoid_cache;
51
52	struct lock_manager nfsd4_manager;
53	bool grace_ended;
54	time64_t boot_time;
55
56	struct dentry *nfsd_client_dir;
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	time64_t nfsd4_lease;
104	time64_t nfsd4_grace;
105	bool somebody_reclaimed;
106
107	bool track_reclaim_completes;
108	atomic_t nr_reclaim_complete;
109
110	bool nfsd_net_up;
111	bool lockd_up;
112
113	seqlock_t writeverf_lock;
114	unsigned char writeverf[8];
115
116	/*
117	 * Max number of connections this nfsd container will allow. Defaults
118	 * to '0' which is means that it bases this on the number of threads.
119	 */
120	unsigned int max_connections;
121
122	u32 clientid_base;
123	u32 clientid_counter;
124	u32 clverifier_counter;
125
126	struct svc_serv *nfsd_serv;
127	/* When a listening socket is added to nfsd, keep_active is set
128	 * and this justifies a reference on nfsd_serv.  This stops
129	 * nfsd_serv from being freed.  When the number of threads is
130	 * set, keep_active is cleared and the reference is dropped.  So
131	 * when the last thread exits, the service will be destroyed.
132	 */
133	int keep_active;
134
135	/*
136	 * clientid and stateid data for construction of net unique COPY
137	 * stateids.
138	 */
139	u32		s2s_cp_cl_id;
140	struct idr	s2s_cp_stateids;
141	spinlock_t	s2s_cp_lock;
142
143	/*
144	 * Version information
145	 */
146	bool *nfsd_versions;
147	bool *nfsd4_minorversions;
148
149	/*
150	 * Duplicate reply cache
151	 */
152	struct nfsd_drc_bucket   *drc_hashtbl;
153
154	/* max number of entries allowed in the cache */
155	unsigned int             max_drc_entries;
156
157	/* number of significant bits in the hash value */
158	unsigned int             maskbits;
159	unsigned int             drc_hashsize;
160
161	/*
162	 * Stats and other tracking of on the duplicate reply cache.
163	 * The longest_chain* fields are modified with only the per-bucket
164	 * cache lock, which isn't really safe and should be fixed if we want
165	 * these statistics to be completely accurate.
166	 */
167
168	/* total number of entries */
169	atomic_t                 num_drc_entries;
170
171	/* Per-netns stats counters */
172	struct percpu_counter    counter[NFSD_NET_COUNTERS_NUM];
173
174	/* longest hash chain seen */
175	unsigned int             longest_chain;
176
177	/* size of cache when we saw the longest hash chain */
178	unsigned int             longest_chain_cachesize;
179
180	struct shrinker		nfsd_reply_cache_shrinker;
181
182	/* tracking server-to-server copy mounts */
183	spinlock_t              nfsd_ssc_lock;
184	struct list_head        nfsd_ssc_mount_list;
185	wait_queue_head_t       nfsd_ssc_waitq;
186
187	/* utsname taken from the process that starts the server */
188	char			nfsd_name[UNX_MAXNODENAME+1];
189
190	struct nfsd_fcache_disposal *fcache_disposal;
191
192	siphash_key_t		siphash_key;
193
194	atomic_t		nfs4_client_count;
195	int			nfs4_max_clients;
196
197	atomic_t		nfsd_courtesy_clients;
198	struct shrinker		nfsd_client_shrinker;
199	struct work_struct	nfsd_shrinker_work;
200};
201
202/* Simple check to find out if a given net was properly initialized */
203#define nfsd_netns_ready(nn) ((nn)->sessionid_hashtbl)
204
205extern void nfsd_netns_free_versions(struct nfsd_net *nn);
206
207extern unsigned int nfsd_net_id;
208
209void nfsd_copy_write_verifier(__be32 verf[2], struct nfsd_net *nn);
210void nfsd_reset_write_verifier(struct nfsd_net *nn);
211#endif /* __NFSD_NETNS_H__ */
212