fs/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
  14 /* Hash tables for nfs4_clientid state */
  15 #define CLIENT_HASH_BITS                 4
  16 #define CLIENT_HASH_SIZE                (1 << CLIENT_HASH_BITS)
  17 #define CLIENT_HASH_MASK                (CLIENT_HASH_SIZE - 1)
  18
  19 #define SESSION_HASH_SIZE       512
  20
  21 struct cld_net;
  22 struct nfsd4_client_tracking_ops;
  23
  24 /*
  25  * Represents a nfsd "container". With respect to nfsv4 state tracking, the
  26  * fields of interest are the *_id_hashtbls and the *_name_tree. These track
  27  * the nfs4_client objects by either short or long form clientid.
  28  *
  29  * Each nfsd_net runs a nfs4_laundromat workqueue job when necessary to clean
  30  * up expired clients and delegations within the container.
  31  */
  32 struct nfsd_net {
  33         struct cld_net *cld_net;
  34
  35         struct cache_detail *svc_expkey_cache;
  36         struct cache_detail *svc_export_cache;
  37
  38         struct cache_detail *idtoname_cache;
  39         struct cache_detail *nametoid_cache;
  40
  41         struct lock_manager nfsd4_manager;
  42         bool grace_ended;
  43         time_t boot_time;
  44
  45         /*
  46          * reclaim_str_hashtbl[] holds known client info from previous reset/reboot
  47          * used in reboot/reset lease grace period processing
  48          *
  49          * conf_id_hashtbl[], and conf_name_tree hold confirmed
  50          * setclientid_confirmed info.
  51          *
  52          * unconf_str_hastbl[] and unconf_name_tree hold unconfirmed
  53          * setclientid info.
  54          */
  55         struct list_head *reclaim_str_hashtbl;
  56         int reclaim_str_hashtbl_size;
  57         struct list_head *conf_id_hashtbl;
  58         struct rb_root conf_name_tree;
  59         struct list_head *unconf_id_hashtbl;
  60         struct rb_root unconf_name_tree;
  61         struct list_head *sessionid_hashtbl;
  62         /*
  63          * client_lru holds client queue ordered by nfs4_client.cl_time
  64          * for lease renewal.
  65          *
  66          * close_lru holds (open) stateowner queue ordered by nfs4_stateowner.so_time
  67          * for last close replay.
  68          *
  69          * All of the above fields are protected by the client_mutex.
  70          */
  71         struct list_head client_lru;
  72         struct list_head close_lru;
  73         struct list_head del_recall_lru;
  74
  75         /* protected by blocked_locks_lock */
  76         struct list_head blocked_locks_lru;
  77
  78         struct delayed_work laundromat_work;
  79
  80         /* client_lock protects the client lru list and session hash table */
  81         spinlock_t client_lock;
  82
  83         /* protects blocked_locks_lru */
  84         spinlock_t blocked_locks_lock;
  85
  86         struct file *rec_file;
  87         bool in_grace;
  88         const struct nfsd4_client_tracking_ops *client_tracking_ops;
  89
  90         time_t nfsd4_lease;
  91         time_t nfsd4_grace;
  92         bool somebody_reclaimed;
  93
  94         bool track_reclaim_completes;
  95         atomic_t nr_reclaim_complete;
  96
  97         bool nfsd_net_up;
  98         bool lockd_up;
  99
 100         /* Time of server startup */
 101         struct timespec64 nfssvc_boot;
 102
 103         /*
 104          * Max number of connections this nfsd container will allow. Defaults
 105          * to '0' which is means that it bases this on the number of threads.
 106          */
 107         unsigned int max_connections;
 108
 109         u32 clientid_counter;
 110         u32 clverifier_counter;
 111
 112         struct svc_serv *nfsd_serv;
 113
 114         wait_queue_head_t ntf_wq;
 115         atomic_t ntf_refcnt;
 116
 117         /*
 118          * clientid and stateid data for construction of net unique COPY
 119          * stateids.
 120          */
 121         u32             s2s_cp_cl_id;
 122         struct idr      s2s_cp_stateids;
 123         spinlock_t      s2s_cp_lock;
 124
 125         /*
 126          * Version information
 127          */
 128         bool *nfsd_versions;
 129         bool *nfsd4_minorversions;
 130 };
 131
 132 /* Simple check to find out if a given net was properly initialized */
 133 #define nfsd_netns_ready(nn) ((nn)->sessionid_hashtbl)
 134
 135 extern void nfsd_netns_free_versions(struct nfsd_net *nn);
 136
 137 extern unsigned int nfsd_net_id;
 138 #endif /* __NFSD_NETNS_H__ */