Loading...
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
27struct cld_net;
28
29struct nfsd_net {
30 struct cld_net *cld_net;
31
32 struct cache_detail *svc_expkey_cache;
33 struct cache_detail *svc_export_cache;
34
35 struct cache_detail *idtoname_cache;
36 struct cache_detail *nametoid_cache;
37};
38
39extern int nfsd_net_id;
40#endif /* __NFSD_NETNS_H__ */
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/nfs4.h>
15#include <linux/percpu_counter.h>
16#include <linux/percpu-refcount.h>
17#include <linux/siphash.h>
18#include <linux/sunrpc/stats.h>
19
20/* Hash tables for nfs4_clientid state */
21#define CLIENT_HASH_BITS 4
22#define CLIENT_HASH_SIZE (1 << CLIENT_HASH_BITS)
23#define CLIENT_HASH_MASK (CLIENT_HASH_SIZE - 1)
24
25#define SESSION_HASH_SIZE 512
26
27struct cld_net;
28struct nfsd4_client_tracking_ops;
29
30enum {
31 /* cache misses due only to checksum comparison failures */
32 NFSD_STATS_PAYLOAD_MISSES,
33 /* amount of memory (in bytes) currently consumed by the DRC */
34 NFSD_STATS_DRC_MEM_USAGE,
35 NFSD_STATS_RC_HITS, /* repcache hits */
36 NFSD_STATS_RC_MISSES, /* repcache misses */
37 NFSD_STATS_RC_NOCACHE, /* uncached reqs */
38 NFSD_STATS_FH_STALE, /* FH stale error */
39 NFSD_STATS_IO_READ, /* bytes returned to read requests */
40 NFSD_STATS_IO_WRITE, /* bytes passed in write requests */
41#ifdef CONFIG_NFSD_V4
42 NFSD_STATS_FIRST_NFS4_OP, /* count of individual nfsv4 operations */
43 NFSD_STATS_LAST_NFS4_OP = NFSD_STATS_FIRST_NFS4_OP + LAST_NFS4_OP,
44#define NFSD_STATS_NFS4_OP(op) (NFSD_STATS_FIRST_NFS4_OP + (op))
45 NFSD_STATS_WDELEG_GETATTR, /* count of getattr conflict with wdeleg */
46#endif
47 NFSD_STATS_COUNTERS_NUM
48};
49
50/*
51 * Represents a nfsd "container". With respect to nfsv4 state tracking, the
52 * fields of interest are the *_id_hashtbls and the *_name_tree. These track
53 * the nfs4_client objects by either short or long form clientid.
54 *
55 * Each nfsd_net runs a nfs4_laundromat workqueue job when necessary to clean
56 * up expired clients and delegations within the container.
57 */
58struct nfsd_net {
59 struct cld_net *cld_net;
60
61 struct cache_detail *svc_expkey_cache;
62 struct cache_detail *svc_export_cache;
63
64 struct cache_detail *idtoname_cache;
65 struct cache_detail *nametoid_cache;
66
67 struct lock_manager nfsd4_manager;
68 bool grace_ended;
69 time64_t boot_time;
70
71 struct dentry *nfsd_client_dir;
72
73 /*
74 * reclaim_str_hashtbl[] holds known client info from previous reset/reboot
75 * used in reboot/reset lease grace period processing
76 *
77 * conf_id_hashtbl[], and conf_name_tree hold confirmed
78 * setclientid_confirmed info.
79 *
80 * unconf_str_hastbl[] and unconf_name_tree hold unconfirmed
81 * setclientid info.
82 */
83 struct list_head *reclaim_str_hashtbl;
84 int reclaim_str_hashtbl_size;
85 struct list_head *conf_id_hashtbl;
86 struct rb_root conf_name_tree;
87 struct list_head *unconf_id_hashtbl;
88 struct rb_root unconf_name_tree;
89 struct list_head *sessionid_hashtbl;
90 /*
91 * client_lru holds client queue ordered by nfs4_client.cl_time
92 * for lease renewal.
93 *
94 * close_lru holds (open) stateowner queue ordered by nfs4_stateowner.so_time
95 * for last close replay.
96 *
97 * All of the above fields are protected by the client_mutex.
98 */
99 struct list_head client_lru;
100 struct list_head close_lru;
101 struct list_head del_recall_lru;
102
103 /* protected by blocked_locks_lock */
104 struct list_head blocked_locks_lru;
105
106 struct delayed_work laundromat_work;
107
108 /* client_lock protects the client lru list and session hash table */
109 spinlock_t client_lock;
110
111 /* protects blocked_locks_lru */
112 spinlock_t blocked_locks_lock;
113
114 struct file *rec_file;
115 bool in_grace;
116 const struct nfsd4_client_tracking_ops *client_tracking_ops;
117
118 time64_t nfsd4_lease;
119 time64_t nfsd4_grace;
120 bool somebody_reclaimed;
121
122 bool track_reclaim_completes;
123 atomic_t nr_reclaim_complete;
124
125 bool nfsd_net_up;
126 bool lockd_up;
127
128 seqlock_t writeverf_lock;
129 unsigned char writeverf[8];
130
131 /*
132 * Max number of connections this nfsd container will allow. Defaults
133 * to '0' which is means that it bases this on the number of threads.
134 */
135 unsigned int max_connections;
136
137 u32 clientid_base;
138 u32 clientid_counter;
139 u32 clverifier_counter;
140
141 struct svc_info nfsd_info;
142#define nfsd_serv nfsd_info.serv
143 struct percpu_ref nfsd_serv_ref;
144 struct completion nfsd_serv_confirm_done;
145 struct completion nfsd_serv_free_done;
146
147 /*
148 * clientid and stateid data for construction of net unique COPY
149 * stateids.
150 */
151 u32 s2s_cp_cl_id;
152 struct idr s2s_cp_stateids;
153 spinlock_t s2s_cp_lock;
154 atomic_t pending_async_copies;
155
156 /*
157 * Version information
158 */
159 bool nfsd_versions[NFSD_MAXVERS + 1];
160 bool nfsd4_minorversions[NFSD_SUPPORTED_MINOR_VERSION + 1];
161
162 /*
163 * Duplicate reply cache
164 */
165 struct nfsd_drc_bucket *drc_hashtbl;
166
167 /* max number of entries allowed in the cache */
168 unsigned int max_drc_entries;
169
170 /* number of significant bits in the hash value */
171 unsigned int maskbits;
172 unsigned int drc_hashsize;
173
174 /*
175 * Stats and other tracking of on the duplicate reply cache.
176 * The longest_chain* fields are modified with only the per-bucket
177 * cache lock, which isn't really safe and should be fixed if we want
178 * these statistics to be completely accurate.
179 */
180
181 /* total number of entries */
182 atomic_t num_drc_entries;
183
184 /* Per-netns stats counters */
185 struct percpu_counter counter[NFSD_STATS_COUNTERS_NUM];
186
187 /* sunrpc svc stats */
188 struct svc_stat nfsd_svcstats;
189
190 /* longest hash chain seen */
191 unsigned int longest_chain;
192
193 /* size of cache when we saw the longest hash chain */
194 unsigned int longest_chain_cachesize;
195
196 struct shrinker *nfsd_reply_cache_shrinker;
197
198 /* tracking server-to-server copy mounts */
199 spinlock_t nfsd_ssc_lock;
200 struct list_head nfsd_ssc_mount_list;
201 wait_queue_head_t nfsd_ssc_waitq;
202
203 /* utsname taken from the process that starts the server */
204 char nfsd_name[UNX_MAXNODENAME+1];
205
206 struct nfsd_fcache_disposal *fcache_disposal;
207
208 siphash_key_t siphash_key;
209
210 atomic_t nfs4_client_count;
211 int nfs4_max_clients;
212
213 atomic_t nfsd_courtesy_clients;
214 struct shrinker *nfsd_client_shrinker;
215 struct work_struct nfsd_shrinker_work;
216
217 /* last time an admin-revoke happened for NFSv4.0 */
218 time64_t nfs40_last_revoke;
219
220#if IS_ENABLED(CONFIG_NFS_LOCALIO)
221 /* Local clients to be invalidated when net is shut down */
222 struct list_head local_clients;
223#endif
224};
225
226/* Simple check to find out if a given net was properly initialized */
227#define nfsd_netns_ready(nn) ((nn)->sessionid_hashtbl)
228
229extern bool nfsd_support_version(int vers);
230extern unsigned int nfsd_net_id;
231
232bool nfsd_serv_try_get(struct net *net);
233void nfsd_serv_put(struct net *net);
234
235void nfsd_copy_write_verifier(__be32 verf[2], struct nfsd_net *nn);
236void nfsd_reset_write_verifier(struct nfsd_net *nn);
237#endif /* __NFSD_NETNS_H__ */