xprt.h 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326
  1. /*
  2. * linux/include/linux/sunrpc/xprt.h
  3. *
  4. * Declarations for the RPC transport interface.
  5. *
  6. * Copyright (C) 1995, 1996 Olaf Kirch <okir@monad.swb.de>
  7. */
  8. #ifndef _LINUX_SUNRPC_XPRT_H
  9. #define _LINUX_SUNRPC_XPRT_H
  10. #include <linux/uio.h>
  11. #include <linux/socket.h>
  12. #include <linux/in.h>
  13. #include <linux/kref.h>
  14. #include <linux/sunrpc/sched.h>
  15. #include <linux/sunrpc/xdr.h>
  16. #include <linux/sunrpc/msg_prot.h>
  17. extern unsigned int xprt_udp_slot_table_entries;
  18. extern unsigned int xprt_tcp_slot_table_entries;
  19. #define RPC_MIN_SLOT_TABLE (2U)
  20. #define RPC_DEF_SLOT_TABLE (16U)
  21. #define RPC_MAX_SLOT_TABLE (128U)
  22. /*
  23. * Parameters for choosing a free port
  24. */
  25. extern unsigned int xprt_min_resvport;
  26. extern unsigned int xprt_max_resvport;
  27. #define RPC_MIN_RESVPORT (1U)
  28. #define RPC_MAX_RESVPORT (65535U)
  29. #define RPC_DEF_MIN_RESVPORT (665U)
  30. #define RPC_DEF_MAX_RESVPORT (1023U)
  31. /*
  32. * This describes a timeout strategy
  33. */
  34. struct rpc_timeout {
  35. unsigned long to_initval, /* initial timeout */
  36. to_maxval, /* max timeout */
  37. to_increment; /* if !exponential */
  38. unsigned int to_retries; /* max # of retries */
  39. unsigned char to_exponential;
  40. };
  41. enum rpc_display_format_t {
  42. RPC_DISPLAY_ADDR = 0,
  43. RPC_DISPLAY_PORT,
  44. RPC_DISPLAY_PROTO,
  45. RPC_DISPLAY_ALL,
  46. RPC_DISPLAY_MAX,
  47. };
  48. struct rpc_task;
  49. struct rpc_xprt;
  50. struct seq_file;
  51. /*
  52. * This describes a complete RPC request
  53. */
  54. struct rpc_rqst {
  55. /*
  56. * This is the user-visible part
  57. */
  58. struct rpc_xprt * rq_xprt; /* RPC client */
  59. struct xdr_buf rq_snd_buf; /* send buffer */
  60. struct xdr_buf rq_rcv_buf; /* recv buffer */
  61. /*
  62. * This is the private part
  63. */
  64. struct rpc_task * rq_task; /* RPC task data */
  65. __be32 rq_xid; /* request XID */
  66. int rq_cong; /* has incremented xprt->cong */
  67. int rq_received; /* receive completed */
  68. u32 rq_seqno; /* gss seq no. used on req. */
  69. int rq_enc_pages_num;
  70. struct page **rq_enc_pages; /* scratch pages for use by
  71. gss privacy code */
  72. void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
  73. struct list_head rq_list;
  74. __u32 * rq_buffer; /* XDR encode buffer */
  75. size_t rq_bufsize;
  76. struct xdr_buf rq_private_buf; /* The receive buffer
  77. * used in the softirq.
  78. */
  79. unsigned long rq_majortimeo; /* major timeout alarm */
  80. unsigned long rq_timeout; /* Current timeout value */
  81. unsigned int rq_retries; /* # of retries */
  82. /*
  83. * Partial send handling
  84. */
  85. u32 rq_bytes_sent; /* Bytes we have sent */
  86. unsigned long rq_xtime; /* when transmitted */
  87. int rq_ntrans;
  88. };
  89. #define rq_svec rq_snd_buf.head
  90. #define rq_slen rq_snd_buf.len
  91. struct rpc_xprt_ops {
  92. void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
  93. int (*reserve_xprt)(struct rpc_task *task);
  94. void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
  95. void (*rpcbind)(struct rpc_task *task);
  96. void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
  97. void (*connect)(struct rpc_task *task);
  98. void * (*buf_alloc)(struct rpc_task *task, size_t size);
  99. void (*buf_free)(struct rpc_task *task);
  100. int (*send_request)(struct rpc_task *task);
  101. void (*set_retrans_timeout)(struct rpc_task *task);
  102. void (*timer)(struct rpc_task *task);
  103. void (*release_request)(struct rpc_task *task);
  104. void (*close)(struct rpc_xprt *xprt);
  105. void (*destroy)(struct rpc_xprt *xprt);
  106. void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
  107. };
  108. struct rpc_xprt {
  109. struct kref kref; /* Reference count */
  110. struct rpc_xprt_ops * ops; /* transport methods */
  111. struct rpc_timeout timeout; /* timeout parms */
  112. struct sockaddr_storage addr; /* server address */
  113. size_t addrlen; /* size of server address */
  114. int prot; /* IP protocol */
  115. unsigned long cong; /* current congestion */
  116. unsigned long cwnd; /* congestion window */
  117. size_t max_payload; /* largest RPC payload size,
  118. in bytes */
  119. unsigned int tsh_size; /* size of transport specific
  120. header */
  121. struct rpc_wait_queue binding; /* requests waiting on rpcbind */
  122. struct rpc_wait_queue sending; /* requests waiting to send */
  123. struct rpc_wait_queue resend; /* requests waiting to resend */
  124. struct rpc_wait_queue pending; /* requests in flight */
  125. struct rpc_wait_queue backlog; /* waiting for slot */
  126. struct list_head free; /* free slots */
  127. struct rpc_rqst * slot; /* slot table storage */
  128. unsigned int max_reqs; /* total slots */
  129. unsigned long state; /* transport state */
  130. unsigned char shutdown : 1, /* being shut down */
  131. resvport : 1; /* use a reserved port */
  132. /*
  133. * Connection of transports
  134. */
  135. unsigned long connect_timeout,
  136. bind_timeout,
  137. reestablish_timeout;
  138. /*
  139. * Disconnection of idle transports
  140. */
  141. struct work_struct task_cleanup;
  142. struct timer_list timer;
  143. unsigned long last_used,
  144. idle_timeout;
  145. /*
  146. * Send stuff
  147. */
  148. spinlock_t transport_lock; /* lock transport info */
  149. spinlock_t reserve_lock; /* lock slot table */
  150. u32 xid; /* Next XID value to use */
  151. struct rpc_task * snd_task; /* Task blocked in send */
  152. struct list_head recv;
  153. struct {
  154. unsigned long bind_count, /* total number of binds */
  155. connect_count, /* total number of connects */
  156. connect_start, /* connect start timestamp */
  157. connect_time, /* jiffies waiting for connect */
  158. sends, /* how many complete requests */
  159. recvs, /* how many complete requests */
  160. bad_xids; /* lookup_rqst didn't find XID */
  161. unsigned long long req_u, /* average requests on the wire */
  162. bklog_u; /* backlog queue utilization */
  163. } stat;
  164. char * address_strings[RPC_DISPLAY_MAX];
  165. };
  166. #ifdef __KERNEL__
  167. /*
  168. * Transport operations used by ULPs
  169. */
  170. void xprt_set_timeout(struct rpc_timeout *to, unsigned int retr, unsigned long incr);
  171. /*
  172. * Generic internal transport functions
  173. */
  174. struct rpc_xprt * xprt_create_transport(int proto, struct sockaddr *addr, size_t size, struct rpc_timeout *toparms);
  175. void xprt_connect(struct rpc_task *task);
  176. void xprt_reserve(struct rpc_task *task);
  177. int xprt_reserve_xprt(struct rpc_task *task);
  178. int xprt_reserve_xprt_cong(struct rpc_task *task);
  179. int xprt_prepare_transmit(struct rpc_task *task);
  180. void xprt_transmit(struct rpc_task *task);
  181. void xprt_end_transmit(struct rpc_task *task);
  182. int xprt_adjust_timeout(struct rpc_rqst *req);
  183. void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
  184. void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
  185. void xprt_release(struct rpc_task *task);
  186. struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
  187. void xprt_put(struct rpc_xprt *xprt);
  188. static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
  189. {
  190. return p + xprt->tsh_size;
  191. }
  192. /*
  193. * Transport switch helper functions
  194. */
  195. void xprt_set_retrans_timeout_def(struct rpc_task *task);
  196. void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
  197. void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
  198. void xprt_wait_for_buffer_space(struct rpc_task *task);
  199. void xprt_write_space(struct rpc_xprt *xprt);
  200. void xprt_update_rtt(struct rpc_task *task);
  201. void xprt_adjust_cwnd(struct rpc_task *task, int result);
  202. struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
  203. void xprt_complete_rqst(struct rpc_task *task, int copied);
  204. void xprt_release_rqst_cong(struct rpc_task *task);
  205. void xprt_disconnect(struct rpc_xprt *xprt);
  206. /*
  207. * Socket transport setup operations
  208. */
  209. struct rpc_xprt * xs_setup_udp(struct sockaddr *addr, size_t addrlen, struct rpc_timeout *to);
  210. struct rpc_xprt * xs_setup_tcp(struct sockaddr *addr, size_t addrlen, struct rpc_timeout *to);
  211. /*
  212. * Reserved bit positions in xprt->state
  213. */
  214. #define XPRT_LOCKED (0)
  215. #define XPRT_CONNECTED (1)
  216. #define XPRT_CONNECTING (2)
  217. #define XPRT_CLOSE_WAIT (3)
  218. #define XPRT_BOUND (4)
  219. #define XPRT_BINDING (5)
  220. static inline void xprt_set_connected(struct rpc_xprt *xprt)
  221. {
  222. set_bit(XPRT_CONNECTED, &xprt->state);
  223. }
  224. static inline void xprt_clear_connected(struct rpc_xprt *xprt)
  225. {
  226. clear_bit(XPRT_CONNECTED, &xprt->state);
  227. }
  228. static inline int xprt_connected(struct rpc_xprt *xprt)
  229. {
  230. return test_bit(XPRT_CONNECTED, &xprt->state);
  231. }
  232. static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
  233. {
  234. return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
  235. }
  236. static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
  237. {
  238. return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
  239. }
  240. static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
  241. {
  242. smp_mb__before_clear_bit();
  243. clear_bit(XPRT_CONNECTING, &xprt->state);
  244. smp_mb__after_clear_bit();
  245. }
  246. static inline int xprt_connecting(struct rpc_xprt *xprt)
  247. {
  248. return test_bit(XPRT_CONNECTING, &xprt->state);
  249. }
  250. static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
  251. {
  252. return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
  253. }
  254. static inline void xprt_set_bound(struct rpc_xprt *xprt)
  255. {
  256. test_and_set_bit(XPRT_BOUND, &xprt->state);
  257. }
  258. static inline int xprt_bound(struct rpc_xprt *xprt)
  259. {
  260. return test_bit(XPRT_BOUND, &xprt->state);
  261. }
  262. static inline void xprt_clear_bound(struct rpc_xprt *xprt)
  263. {
  264. clear_bit(XPRT_BOUND, &xprt->state);
  265. }
  266. static inline void xprt_clear_binding(struct rpc_xprt *xprt)
  267. {
  268. smp_mb__before_clear_bit();
  269. clear_bit(XPRT_BINDING, &xprt->state);
  270. smp_mb__after_clear_bit();
  271. }
  272. static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
  273. {
  274. return test_and_set_bit(XPRT_BINDING, &xprt->state);
  275. }
  276. #endif /* __KERNEL__*/
  277. #endif /* _LINUX_SUNRPC_XPRT_H */