fs/nfs/nfs4session.h

   1 /*
   2  * fs/nfs/nfs4session.h
   3  *
   4  * Copyright (c) 2012 Trond Myklebust <Trond.Myklebust@netapp.com>
   5  *
   6  */
   7 #ifndef __LINUX_FS_NFS_NFS4SESSION_H
   8 #define __LINUX_FS_NFS_NFS4SESSION_H
   9
  10 /* maximum number of slots to use */
  11 #define NFS4_DEF_SLOT_TABLE_SIZE (16U)
  12 #define NFS4_MAX_SLOT_TABLE (256U)
  13 #define NFS4_NO_SLOT ((u32)-1)
  14
  15 #if IS_ENABLED(CONFIG_NFS_V4)
  16
  17 /* Sessions slot seqid */
  18 struct nfs4_slot {
  19         struct nfs4_slot_table  *table;
  20         struct nfs4_slot        *next;
  21         unsigned long           generation;
  22         unsigned long           renewal_time;
  23         u32                     slot_nr;
  24         u32                     seq_nr;
  25 };
  26
  27 /* Sessions */
  28 #define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
  29 struct nfs4_slot_table {
  30         struct nfs4_session *session;           /* Parent session */
  31         struct nfs4_slot *slots;                /* seqid per slot */
  32         unsigned long   used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
  33         spinlock_t      slot_tbl_lock;
  34         struct rpc_wait_queue   slot_tbl_waitq; /* allocators may wait here */
  35         u32             max_slots;              /* # slots in table */
  36         u32             max_slotid;             /* Max allowed slotid value */
  37         u32             highest_used_slotid;    /* sent to server on each SEQ.
  38                                                  * op for dynamic resizing */
  39         u32             target_highest_slotid;  /* Server max_slot target */
  40         u32             server_highest_slotid;  /* Server highest slotid */
  41         unsigned long   generation;             /* Generation counter for
  42                                                    target_highest_slotid */
  43         struct completion complete;
  44 };
  45
  46 /*
  47  * Session related parameters
  48  */
  49 struct nfs4_session {
  50         struct nfs4_sessionid           sess_id;
  51         u32                             flags;
  52         unsigned long                   session_state;
  53         u32                             hash_alg;
  54         u32                             ssv_len;
  55
  56         /* The fore and back channel */
  57         struct nfs4_channel_attrs       fc_attrs;
  58         struct nfs4_slot_table          fc_slot_table;
  59         struct nfs4_channel_attrs       bc_attrs;
  60         struct nfs4_slot_table          bc_slot_table;
  61         struct nfs_client               *clp;
  62         /* Create session arguments */
  63         unsigned int                    fc_target_max_rqst_sz;
  64         unsigned int                    fc_target_max_resp_sz;
  65 };
  66
  67 enum nfs4_session_state {
  68         NFS4_SESSION_INITING,
  69         NFS4_SESSION_DRAINING,
  70 };
  71
  72 #if defined(CONFIG_NFS_V4_1)
  73 extern struct nfs4_slot *nfs4_alloc_slot(struct nfs4_slot_table *tbl);
  74 extern void nfs4_free_slot(struct nfs4_slot_table *tbl, struct nfs4_slot *slot);
  75
  76 extern void nfs41_set_target_slotid(struct nfs4_slot_table *tbl,
  77                 u32 target_highest_slotid);
  78 extern void nfs41_update_target_slotid(struct nfs4_slot_table *tbl,
  79                 struct nfs4_slot *slot,
  80                 struct nfs4_sequence_res *res);
  81
  82 extern int nfs4_setup_session_slot_tables(struct nfs4_session *ses);
  83
  84 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
  85 extern void nfs4_destroy_session(struct nfs4_session *session);
  86 extern int nfs4_init_session(struct nfs_server *server);
  87 extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
  88
  89 extern void nfs4_session_drain_complete(struct nfs4_session *session,
  90                 struct nfs4_slot_table *tbl);
  91
  92 static inline bool nfs4_session_draining(struct nfs4_session *session)
  93 {
  94         return !!test_bit(NFS4_SESSION_DRAINING, &session->session_state);
  95 }
  96
  97 /*
  98  * Determine if sessions are in use.
  99  */
 100 static inline int nfs4_has_session(const struct nfs_client *clp)
 101 {
 102         if (clp->cl_session)
 103                 return 1;
 104         return 0;
 105 }
 106
 107 static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
 108 {
 109         if (nfs4_has_session(clp))
 110                 return (clp->cl_session->flags & SESSION4_PERSIST);
 111         return 0;
 112 }
 113
 114 #else /* defined(CONFIG_NFS_V4_1) */
 115
 116 static inline int nfs4_init_session(struct nfs_server *server)
 117 {
 118         return 0;
 119 }
 120
 121 /*
 122  * Determine if sessions are in use.
 123  */
 124 static inline int nfs4_has_session(const struct nfs_client *clp)
 125 {
 126         return 0;
 127 }
 128
 129 static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
 130 {
 131         return 0;
 132 }
 133
 134 #endif /* defined(CONFIG_NFS_V4_1) */
 135 #endif /* IS_ENABLED(CONFIG_NFS_V4) */
 136 #endif /* __LINUX_FS_NFS_NFS4SESSION_H */