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