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 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 u32 clientid_base; 132 u32 clientid_counter; 133 u32 clverifier_counter; 134 135 struct svc_info nfsd_info; 136 #define nfsd_serv nfsd_info.serv 137 138 struct percpu_ref nfsd_net_ref; 139 struct completion nfsd_net_confirm_done; 140 struct completion nfsd_net_free_done; 141 142 /* 143 * clientid and stateid data for construction of net unique COPY 144 * stateids. 145 */ 146 u32 s2s_cp_cl_id; 147 struct idr s2s_cp_stateids; 148 spinlock_t s2s_cp_lock; 149 atomic_t pending_async_copies; 150 151 /* 152 * Version information 153 */ 154 bool nfsd_versions[NFSD_MAXVERS + 1]; 155 bool nfsd4_minorversions[NFSD_SUPPORTED_MINOR_VERSION + 1]; 156 157 /* 158 * Duplicate reply cache 159 */ 160 struct nfsd_drc_bucket *drc_hashtbl; 161 162 /* max number of entries allowed in the cache */ 163 unsigned int max_drc_entries; 164 165 /* number of significant bits in the hash value */ 166 unsigned int maskbits; 167 unsigned int drc_hashsize; 168 169 /* 170 * Stats and other tracking of on the duplicate reply cache. 171 * The longest_chain* fields are modified with only the per-bucket 172 * cache lock, which isn't really safe and should be fixed if we want 173 * these statistics to be completely accurate. 174 */ 175 176 /* total number of entries */ 177 atomic_t num_drc_entries; 178 179 /* Per-netns stats counters */ 180 struct percpu_counter counter[NFSD_STATS_COUNTERS_NUM]; 181 182 /* sunrpc svc stats */ 183 struct svc_stat nfsd_svcstats; 184 185 /* longest hash chain seen */ 186 unsigned int longest_chain; 187 188 /* size of cache when we saw the longest hash chain */ 189 unsigned int longest_chain_cachesize; 190 191 struct shrinker *nfsd_reply_cache_shrinker; 192 193 /* tracking server-to-server copy mounts */ 194 spinlock_t nfsd_ssc_lock; 195 struct list_head nfsd_ssc_mount_list; 196 wait_queue_head_t nfsd_ssc_waitq; 197 198 /* utsname taken from the process that starts the server */ 199 char nfsd_name[UNX_MAXNODENAME+1]; 200 201 struct nfsd_fcache_disposal *fcache_disposal; 202 203 siphash_key_t siphash_key; 204 205 atomic_t nfs4_client_count; 206 int nfs4_max_clients; 207 208 atomic_t nfsd_courtesy_clients; 209 struct shrinker *nfsd_client_shrinker; 210 struct work_struct nfsd_shrinker_work; 211 212 /* last time an admin-revoke happened for NFSv4.0 */ 213 time64_t nfs40_last_revoke; 214 215 #if IS_ENABLED(CONFIG_NFS_LOCALIO) 216 /* Local clients to be invalidated when net is shut down */ 217 spinlock_t local_clients_lock; 218 struct list_head local_clients; 219 #endif 220 }; 221 222 /* Simple check to find out if a given net was properly initialized */ 223 #define nfsd_netns_ready(nn) ((nn)->sessionid_hashtbl) 224 225 extern bool nfsd_support_version(int vers); 226 extern unsigned int nfsd_net_id; 227 228 bool nfsd_net_try_get(struct net *net); 229 void nfsd_net_put(struct net *net); 230 231 void nfsd_copy_write_verifier(__be32 verf[2], struct nfsd_net *nn); 232 void nfsd_reset_write_verifier(struct nfsd_net *nn); 233 #endif /* __NFSD_NETNS_H__ */ 234