nfs4session.h 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * fs/nfs/nfs4session.h
  4. *
  5. * Copyright (c) 2012 Trond Myklebust <Trond.Myklebust@netapp.com>
  6. *
  7. */
  8. #ifndef __LINUX_FS_NFS_NFS4SESSION_H
  9. #define __LINUX_FS_NFS_NFS4SESSION_H
  10. /* maximum number of slots to use */
  11. #define NFS4_DEF_SLOT_TABLE_SIZE (64U)
  12. #define NFS4_DEF_CB_SLOT_TABLE_SIZE (16U)
  13. #define NFS4_MAX_SLOT_TABLE (1024U)
  14. #define NFS4_NO_SLOT ((u32)-1)
  15. #if IS_ENABLED(CONFIG_NFS_V4)
  16. /* Sessions slot seqid */
  17. struct nfs4_slot {
  18. struct nfs4_slot_table *table;
  19. struct nfs4_slot *next;
  20. unsigned long generation;
  21. u32 slot_nr;
  22. u32 seq_nr;
  23. u32 seq_nr_last_acked;
  24. u32 seq_nr_highest_sent;
  25. unsigned int privileged : 1,
  26. seq_done : 1;
  27. };
  28. /* Sessions */
  29. enum nfs4_slot_tbl_state {
  30. NFS4_SLOT_TBL_DRAINING,
  31. };
  32. #define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
  33. struct nfs4_slot_table {
  34. struct nfs4_session *session; /* Parent session */
  35. struct nfs4_slot *slots; /* seqid per slot */
  36. unsigned long used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
  37. spinlock_t slot_tbl_lock;
  38. struct rpc_wait_queue slot_tbl_waitq; /* allocators may wait here */
  39. wait_queue_head_t slot_waitq; /* Completion wait on slot */
  40. u32 max_slots; /* # slots in table */
  41. u32 max_slotid; /* Max allowed slotid value */
  42. u32 highest_used_slotid; /* sent to server on each SEQ.
  43. * op for dynamic resizing */
  44. u32 target_highest_slotid; /* Server max_slot target */
  45. u32 server_highest_slotid; /* Server highest slotid */
  46. s32 d_target_highest_slotid; /* Derivative */
  47. s32 d2_target_highest_slotid; /* 2nd derivative */
  48. unsigned long generation; /* Generation counter for
  49. target_highest_slotid */
  50. struct completion complete;
  51. unsigned long slot_tbl_state;
  52. };
  53. /*
  54. * Session related parameters
  55. */
  56. struct nfs4_session {
  57. struct nfs4_sessionid sess_id;
  58. u32 flags;
  59. unsigned long session_state;
  60. u32 hash_alg;
  61. u32 ssv_len;
  62. /* The fore and back channel */
  63. struct nfs4_channel_attrs fc_attrs;
  64. struct nfs4_slot_table fc_slot_table;
  65. struct nfs4_channel_attrs bc_attrs;
  66. struct nfs4_slot_table bc_slot_table;
  67. struct nfs_client *clp;
  68. };
  69. enum nfs4_session_state {
  70. NFS4_SESSION_INITING,
  71. NFS4_SESSION_ESTABLISHED,
  72. };
  73. extern int nfs4_setup_slot_table(struct nfs4_slot_table *tbl,
  74. unsigned int max_reqs, const char *queue);
  75. extern void nfs4_shutdown_slot_table(struct nfs4_slot_table *tbl);
  76. extern struct nfs4_slot *nfs4_alloc_slot(struct nfs4_slot_table *tbl);
  77. extern struct nfs4_slot *nfs4_lookup_slot(struct nfs4_slot_table *tbl, u32 slotid);
  78. extern int nfs4_slot_wait_on_seqid(struct nfs4_slot_table *tbl,
  79. u32 slotid, u32 seq_nr,
  80. unsigned long timeout);
  81. extern bool nfs4_try_to_lock_slot(struct nfs4_slot_table *tbl, struct nfs4_slot *slot);
  82. extern void nfs4_free_slot(struct nfs4_slot_table *tbl, struct nfs4_slot *slot);
  83. extern void nfs4_slot_tbl_drain_complete(struct nfs4_slot_table *tbl);
  84. bool nfs41_wake_and_assign_slot(struct nfs4_slot_table *tbl,
  85. struct nfs4_slot *slot);
  86. void nfs41_wake_slot_table(struct nfs4_slot_table *tbl);
  87. static inline bool nfs4_slot_tbl_draining(struct nfs4_slot_table *tbl)
  88. {
  89. return !!test_bit(NFS4_SLOT_TBL_DRAINING, &tbl->slot_tbl_state);
  90. }
  91. static inline bool nfs4_test_locked_slot(const struct nfs4_slot_table *tbl,
  92. u32 slotid)
  93. {
  94. return !!test_bit(slotid, tbl->used_slots);
  95. }
  96. static inline struct nfs4_session *nfs4_get_session(const struct nfs_client *clp)
  97. {
  98. return clp->cl_session;
  99. }
  100. #if defined(CONFIG_NFS_V4_1)
  101. extern void nfs41_set_target_slotid(struct nfs4_slot_table *tbl,
  102. u32 target_highest_slotid);
  103. extern void nfs41_update_target_slotid(struct nfs4_slot_table *tbl,
  104. struct nfs4_slot *slot,
  105. struct nfs4_sequence_res *res);
  106. extern int nfs4_setup_session_slot_tables(struct nfs4_session *ses);
  107. extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
  108. extern void nfs4_destroy_session(struct nfs4_session *session);
  109. extern int nfs4_init_session(struct nfs_client *clp);
  110. extern int nfs4_init_ds_session(struct nfs_client *, unsigned long);
  111. /*
  112. * Determine if sessions are in use.
  113. */
  114. static inline int nfs4_has_session(const struct nfs_client *clp)
  115. {
  116. if (clp->cl_session)
  117. return 1;
  118. return 0;
  119. }
  120. static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
  121. {
  122. if (nfs4_has_session(clp))
  123. return (clp->cl_session->flags & SESSION4_PERSIST);
  124. return 0;
  125. }
  126. static inline void nfs4_copy_sessionid(struct nfs4_sessionid *dst,
  127. const struct nfs4_sessionid *src)
  128. {
  129. memcpy(dst->data, src->data, NFS4_MAX_SESSIONID_LEN);
  130. }
  131. #ifdef CONFIG_CRC32
  132. /*
  133. * nfs_session_id_hash - calculate the crc32 hash for the session id
  134. * @session - pointer to session
  135. */
  136. #define nfs_session_id_hash(sess_id) \
  137. (~crc32_le(0xFFFFFFFF, &(sess_id)->data[0], sizeof((sess_id)->data)))
  138. #else
  139. #define nfs_session_id_hash(session) (0)
  140. #endif
  141. #else /* defined(CONFIG_NFS_V4_1) */
  142. static inline int nfs4_init_session(struct nfs_client *clp)
  143. {
  144. return 0;
  145. }
  146. /*
  147. * Determine if sessions are in use.
  148. */
  149. static inline int nfs4_has_session(const struct nfs_client *clp)
  150. {
  151. return 0;
  152. }
  153. static inline int nfs4_has_persistent_session(const struct nfs_client *clp)
  154. {
  155. return 0;
  156. }
  157. #define nfs_session_id_hash(session) (0)
  158. #endif /* defined(CONFIG_NFS_V4_1) */
  159. #endif /* IS_ENABLED(CONFIG_NFS_V4) */
  160. #endif /* __LINUX_FS_NFS_NFS4SESSION_H */