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 nfsd4_client_tracking_ops; 29 30 enum { 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 */ 58 struct 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 bool grace_end_forced; 70 time64_t boot_time; 71 72 struct dentry *nfsd_client_dir; 73 74 /* 75 * reclaim_str_hashtbl[] holds known client info from previous reset/reboot 76 * used in reboot/reset lease grace period processing 77 * 78 * conf_id_hashtbl[], and conf_name_tree hold confirmed 79 * setclientid_confirmed info. 80 * 81 * unconf_str_hastbl[] and unconf_name_tree hold unconfirmed 82 * setclientid info. 83 */ 84 struct list_head *reclaim_str_hashtbl; 85 int reclaim_str_hashtbl_size; 86 struct list_head *conf_id_hashtbl; 87 struct rb_root conf_name_tree; 88 struct list_head *unconf_id_hashtbl; 89 struct rb_root unconf_name_tree; 90 struct list_head *sessionid_hashtbl; 91 /* 92 * client_lru holds client queue ordered by nfs4_client.cl_time 93 * for lease renewal. 94 * 95 * close_lru holds (open) stateowner queue ordered by nfs4_stateowner.so_time 96 * for last close replay. 97 * 98 * All of the above fields are protected by the client_mutex. 99 */ 100 struct list_head client_lru; 101 struct list_head close_lru; 102 struct list_head del_recall_lru; 103 104 /* protected by blocked_locks_lock */ 105 struct list_head blocked_locks_lru; 106 107 struct delayed_work laundromat_work; 108 109 /* client_lock protects the client lru list and session hash table */ 110 spinlock_t client_lock; 111 112 /* protects blocked_locks_lru */ 113 spinlock_t blocked_locks_lock; 114 115 struct file *rec_file; 116 bool in_grace; 117 const struct nfsd4_client_tracking_ops *client_tracking_ops; 118 119 time64_t nfsd4_lease; 120 time64_t nfsd4_grace; 121 bool somebody_reclaimed; 122 123 bool track_reclaim_completes; 124 atomic_t nr_reclaim_complete; 125 126 bool nfsd_net_up; 127 bool lockd_up; 128 129 seqlock_t writeverf_lock; 130 unsigned char writeverf[8]; 131 132 /* 133 * Minimum number of threads to run per pool. If 0 then the 134 * min == max requested number of threads. 135 */ 136 unsigned int min_threads; 137 138 u32 clientid_base; 139 u32 clientid_counter; 140 u32 clverifier_counter; 141 142 struct svc_info nfsd_info; 143 #define nfsd_serv nfsd_info.serv 144 145 struct percpu_ref nfsd_net_ref; 146 struct completion nfsd_net_confirm_done; 147 struct completion nfsd_net_free_done; 148 149 /* 150 * clientid and stateid data for construction of net unique COPY 151 * stateids. 152 */ 153 u32 s2s_cp_cl_id; 154 struct idr s2s_cp_stateids; 155 spinlock_t s2s_cp_lock; 156 atomic_t pending_async_copies; 157 158 /* 159 * Version information 160 */ 161 bool nfsd_versions[NFSD_MAXVERS + 1]; 162 bool nfsd4_minorversions[NFSD_SUPPORTED_MINOR_VERSION + 1]; 163 164 /* 165 * Duplicate reply cache 166 */ 167 struct nfsd_drc_bucket *drc_hashtbl; 168 169 /* max number of entries allowed in the cache */ 170 unsigned int max_drc_entries; 171 172 /* number of significant bits in the hash value */ 173 unsigned int maskbits; 174 unsigned int drc_hashsize; 175 176 /* 177 * Stats and other tracking of on the duplicate reply cache. 178 * The longest_chain* fields are modified with only the per-bucket 179 * cache lock, which isn't really safe and should be fixed if we want 180 * these statistics to be completely accurate. 181 */ 182 183 /* total number of entries */ 184 atomic_t num_drc_entries; 185 186 /* Per-netns stats counters */ 187 struct percpu_counter counter[NFSD_STATS_COUNTERS_NUM]; 188 189 /* sunrpc svc stats */ 190 struct svc_stat nfsd_svcstats; 191 192 /* longest hash chain seen */ 193 unsigned int longest_chain; 194 195 /* size of cache when we saw the longest hash chain */ 196 unsigned int longest_chain_cachesize; 197 198 struct shrinker *nfsd_reply_cache_shrinker; 199 200 /* tracking server-to-server copy mounts */ 201 spinlock_t nfsd_ssc_lock; 202 struct list_head nfsd_ssc_mount_list; 203 wait_queue_head_t nfsd_ssc_waitq; 204 205 /* utsname taken from the process that starts the server */ 206 char nfsd_name[UNX_MAXNODENAME+1]; 207 208 struct nfsd_fcache_disposal *fcache_disposal; 209 210 siphash_key_t siphash_key; 211 212 atomic_t nfs4_client_count; 213 int nfs4_max_clients; 214 215 atomic_t nfsd_courtesy_clients; 216 struct shrinker *nfsd_client_shrinker; 217 struct work_struct nfsd_shrinker_work; 218 219 /* last time an admin-revoke happened for NFSv4.0 */ 220 time64_t nfs40_last_revoke; 221 222 #if IS_ENABLED(CONFIG_NFS_LOCALIO) 223 /* Local clients to be invalidated when net is shut down */ 224 spinlock_t local_clients_lock; 225 struct list_head local_clients; 226 #endif 227 }; 228 229 /* Simple check to find out if a given net was properly initialized */ 230 #define nfsd_netns_ready(nn) ((nn)->sessionid_hashtbl) 231 232 extern bool nfsd_support_version(int vers); 233 extern unsigned int nfsd_net_id; 234 235 bool nfsd_net_try_get(struct net *net); 236 void nfsd_net_put(struct net *net); 237 238 void nfsd_copy_write_verifier(__be32 verf[2], struct nfsd_net *nn); 239 void nfsd_reset_write_verifier(struct nfsd_net *nn); 240 #endif /* __NFSD_NETNS_H__ */ 241