xprt.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396
  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/ktime.h>
  14. #include <linux/sunrpc/sched.h>
  15. #include <linux/sunrpc/xdr.h>
  16. #include <linux/sunrpc/msg_prot.h>
  17. #ifdef __KERNEL__
  18. #define RPC_MIN_SLOT_TABLE (2U)
  19. #define RPC_DEF_SLOT_TABLE (16U)
  20. #define RPC_MAX_SLOT_TABLE (128U)
  21. /*
  22. * This describes a timeout strategy
  23. */
  24. struct rpc_timeout {
  25. unsigned long to_initval, /* initial timeout */
  26. to_maxval, /* max timeout */
  27. to_increment; /* if !exponential */
  28. unsigned int to_retries; /* max # of retries */
  29. unsigned char to_exponential;
  30. };
  31. enum rpc_display_format_t {
  32. RPC_DISPLAY_ADDR = 0,
  33. RPC_DISPLAY_PORT,
  34. RPC_DISPLAY_PROTO,
  35. RPC_DISPLAY_HEX_ADDR,
  36. RPC_DISPLAY_HEX_PORT,
  37. RPC_DISPLAY_NETID,
  38. RPC_DISPLAY_MAX,
  39. };
  40. struct rpc_task;
  41. struct rpc_xprt;
  42. struct seq_file;
  43. /*
  44. * This describes a complete RPC request
  45. */
  46. struct rpc_rqst {
  47. /*
  48. * This is the user-visible part
  49. */
  50. struct rpc_xprt * rq_xprt; /* RPC client */
  51. struct xdr_buf rq_snd_buf; /* send buffer */
  52. struct xdr_buf rq_rcv_buf; /* recv buffer */
  53. /*
  54. * This is the private part
  55. */
  56. struct rpc_task * rq_task; /* RPC task data */
  57. struct rpc_cred * rq_cred; /* Bound cred */
  58. __be32 rq_xid; /* request XID */
  59. int rq_cong; /* has incremented xprt->cong */
  60. u32 rq_seqno; /* gss seq no. used on req. */
  61. int rq_enc_pages_num;
  62. struct page **rq_enc_pages; /* scratch pages for use by
  63. gss privacy code */
  64. void (*rq_release_snd_buf)(struct rpc_rqst *); /* release rq_enc_pages */
  65. struct list_head rq_list;
  66. __u32 * rq_buffer; /* XDR encode buffer */
  67. size_t rq_callsize,
  68. rq_rcvsize;
  69. size_t rq_xmit_bytes_sent; /* total bytes sent */
  70. size_t rq_reply_bytes_recvd; /* total reply bytes */
  71. /* received */
  72. struct xdr_buf rq_private_buf; /* The receive buffer
  73. * used in the softirq.
  74. */
  75. unsigned long rq_majortimeo; /* major timeout alarm */
  76. unsigned long rq_timeout; /* Current timeout value */
  77. ktime_t rq_rtt; /* round-trip time */
  78. unsigned int rq_retries; /* # of retries */
  79. unsigned int rq_connect_cookie;
  80. /* A cookie used to track the
  81. state of the transport
  82. connection */
  83. /*
  84. * Partial send handling
  85. */
  86. u32 rq_bytes_sent; /* Bytes we have sent */
  87. ktime_t rq_xtime; /* transmit time stamp */
  88. int rq_ntrans;
  89. #if defined(CONFIG_NFS_V4_1)
  90. struct list_head rq_bc_list; /* Callback service list */
  91. unsigned long rq_bc_pa_state; /* Backchannel prealloc state */
  92. struct list_head rq_bc_pa_list; /* Backchannel prealloc list */
  93. #endif /* CONFIG_NFS_V4_1 */
  94. };
  95. #define rq_svec rq_snd_buf.head
  96. #define rq_slen rq_snd_buf.len
  97. struct rpc_xprt_ops {
  98. void (*set_buffer_size)(struct rpc_xprt *xprt, size_t sndsize, size_t rcvsize);
  99. int (*reserve_xprt)(struct rpc_task *task);
  100. void (*release_xprt)(struct rpc_xprt *xprt, struct rpc_task *task);
  101. void (*rpcbind)(struct rpc_task *task);
  102. void (*set_port)(struct rpc_xprt *xprt, unsigned short port);
  103. void (*connect)(struct rpc_task *task);
  104. void * (*buf_alloc)(struct rpc_task *task, size_t size);
  105. void (*buf_free)(void *buffer);
  106. int (*send_request)(struct rpc_task *task);
  107. void (*set_retrans_timeout)(struct rpc_task *task);
  108. void (*timer)(struct rpc_task *task);
  109. void (*release_request)(struct rpc_task *task);
  110. void (*close)(struct rpc_xprt *xprt);
  111. void (*destroy)(struct rpc_xprt *xprt);
  112. void (*print_stats)(struct rpc_xprt *xprt, struct seq_file *seq);
  113. };
  114. /*
  115. * RPC transport identifiers
  116. *
  117. * To preserve compatibility with the historical use of raw IP protocol
  118. * id's for transport selection, UDP and TCP identifiers are specified
  119. * with the previous values. No such restriction exists for new transports,
  120. * except that they may not collide with these values (17 and 6,
  121. * respectively).
  122. */
  123. #define XPRT_TRANSPORT_BC (1 << 31)
  124. enum xprt_transports {
  125. XPRT_TRANSPORT_UDP = IPPROTO_UDP,
  126. XPRT_TRANSPORT_TCP = IPPROTO_TCP,
  127. XPRT_TRANSPORT_BC_TCP = IPPROTO_TCP | XPRT_TRANSPORT_BC,
  128. XPRT_TRANSPORT_RDMA = 256
  129. };
  130. struct rpc_xprt {
  131. atomic_t count; /* Reference count */
  132. struct rpc_xprt_ops * ops; /* transport methods */
  133. const struct rpc_timeout *timeout; /* timeout parms */
  134. struct sockaddr_storage addr; /* server address */
  135. size_t addrlen; /* size of server address */
  136. int prot; /* IP protocol */
  137. unsigned long cong; /* current congestion */
  138. unsigned long cwnd; /* congestion window */
  139. size_t max_payload; /* largest RPC payload size,
  140. in bytes */
  141. unsigned int tsh_size; /* size of transport specific
  142. header */
  143. struct rpc_wait_queue binding; /* requests waiting on rpcbind */
  144. struct rpc_wait_queue sending; /* requests waiting to send */
  145. struct rpc_wait_queue resend; /* requests waiting to resend */
  146. struct rpc_wait_queue pending; /* requests in flight */
  147. struct rpc_wait_queue backlog; /* waiting for slot */
  148. struct list_head free; /* free slots */
  149. struct rpc_rqst * slot; /* slot table storage */
  150. unsigned int max_reqs; /* total slots */
  151. unsigned long state; /* transport state */
  152. unsigned char shutdown : 1, /* being shut down */
  153. resvport : 1; /* use a reserved port */
  154. unsigned int bind_index; /* bind function index */
  155. /*
  156. * Connection of transports
  157. */
  158. unsigned long bind_timeout,
  159. reestablish_timeout;
  160. unsigned int connect_cookie; /* A cookie that gets bumped
  161. every time the transport
  162. is reconnected */
  163. /*
  164. * Disconnection of idle transports
  165. */
  166. struct work_struct task_cleanup;
  167. struct timer_list timer;
  168. unsigned long last_used,
  169. idle_timeout;
  170. /*
  171. * Send stuff
  172. */
  173. spinlock_t transport_lock; /* lock transport info */
  174. spinlock_t reserve_lock; /* lock slot table */
  175. u32 xid; /* Next XID value to use */
  176. struct rpc_task * snd_task; /* Task blocked in send */
  177. struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
  178. #if defined(CONFIG_NFS_V4_1)
  179. struct svc_serv *bc_serv; /* The RPC service which will */
  180. /* process the callback */
  181. unsigned int bc_alloc_count; /* Total number of preallocs */
  182. spinlock_t bc_pa_lock; /* Protects the preallocated
  183. * items */
  184. struct list_head bc_pa_list; /* List of preallocated
  185. * backchannel rpc_rqst's */
  186. #endif /* CONFIG_NFS_V4_1 */
  187. struct list_head recv;
  188. struct {
  189. unsigned long bind_count, /* total number of binds */
  190. connect_count, /* total number of connects */
  191. connect_start, /* connect start timestamp */
  192. connect_time, /* jiffies waiting for connect */
  193. sends, /* how many complete requests */
  194. recvs, /* how many complete requests */
  195. bad_xids; /* lookup_rqst didn't find XID */
  196. unsigned long long req_u, /* average requests on the wire */
  197. bklog_u; /* backlog queue utilization */
  198. } stat;
  199. struct net *xprt_net;
  200. const char *address_strings[RPC_DISPLAY_MAX];
  201. };
  202. #if defined(CONFIG_NFS_V4_1)
  203. /*
  204. * Backchannel flags
  205. */
  206. #define RPC_BC_PA_IN_USE 0x0001 /* Preallocated backchannel */
  207. /* buffer in use */
  208. #endif /* CONFIG_NFS_V4_1 */
  209. #if defined(CONFIG_NFS_V4_1)
  210. static inline int bc_prealloc(struct rpc_rqst *req)
  211. {
  212. return test_bit(RPC_BC_PA_IN_USE, &req->rq_bc_pa_state);
  213. }
  214. #else
  215. static inline int bc_prealloc(struct rpc_rqst *req)
  216. {
  217. return 0;
  218. }
  219. #endif /* CONFIG_NFS_V4_1 */
  220. struct xprt_create {
  221. int ident; /* XPRT_TRANSPORT identifier */
  222. struct net * net;
  223. struct sockaddr * srcaddr; /* optional local address */
  224. struct sockaddr * dstaddr; /* remote peer address */
  225. size_t addrlen;
  226. struct svc_xprt *bc_xprt; /* NFSv4.1 backchannel */
  227. };
  228. struct xprt_class {
  229. struct list_head list;
  230. int ident; /* XPRT_TRANSPORT identifier */
  231. struct rpc_xprt * (*setup)(struct xprt_create *);
  232. struct module *owner;
  233. char name[32];
  234. };
  235. /*
  236. * Generic internal transport functions
  237. */
  238. struct rpc_xprt *xprt_create_transport(struct xprt_create *args);
  239. void xprt_connect(struct rpc_task *task);
  240. void xprt_reserve(struct rpc_task *task);
  241. int xprt_reserve_xprt(struct rpc_task *task);
  242. int xprt_reserve_xprt_cong(struct rpc_task *task);
  243. int xprt_prepare_transmit(struct rpc_task *task);
  244. void xprt_transmit(struct rpc_task *task);
  245. void xprt_end_transmit(struct rpc_task *task);
  246. int xprt_adjust_timeout(struct rpc_rqst *req);
  247. void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task);
  248. void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task);
  249. void xprt_release(struct rpc_task *task);
  250. struct rpc_xprt * xprt_get(struct rpc_xprt *xprt);
  251. void xprt_put(struct rpc_xprt *xprt);
  252. struct rpc_xprt * xprt_alloc(struct net *net, int size, int max_req);
  253. void xprt_free(struct rpc_xprt *);
  254. static inline __be32 *xprt_skip_transport_header(struct rpc_xprt *xprt, __be32 *p)
  255. {
  256. return p + xprt->tsh_size;
  257. }
  258. /*
  259. * Transport switch helper functions
  260. */
  261. int xprt_register_transport(struct xprt_class *type);
  262. int xprt_unregister_transport(struct xprt_class *type);
  263. int xprt_load_transport(const char *);
  264. void xprt_set_retrans_timeout_def(struct rpc_task *task);
  265. void xprt_set_retrans_timeout_rtt(struct rpc_task *task);
  266. void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status);
  267. void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action);
  268. void xprt_write_space(struct rpc_xprt *xprt);
  269. void xprt_adjust_cwnd(struct rpc_task *task, int result);
  270. struct rpc_rqst * xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid);
  271. void xprt_complete_rqst(struct rpc_task *task, int copied);
  272. void xprt_release_rqst_cong(struct rpc_task *task);
  273. void xprt_disconnect_done(struct rpc_xprt *xprt);
  274. void xprt_force_disconnect(struct rpc_xprt *xprt);
  275. void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie);
  276. /*
  277. * Reserved bit positions in xprt->state
  278. */
  279. #define XPRT_LOCKED (0)
  280. #define XPRT_CONNECTED (1)
  281. #define XPRT_CONNECTING (2)
  282. #define XPRT_CLOSE_WAIT (3)
  283. #define XPRT_BOUND (4)
  284. #define XPRT_BINDING (5)
  285. #define XPRT_CLOSING (6)
  286. #define XPRT_CONNECTION_ABORT (7)
  287. #define XPRT_CONNECTION_CLOSE (8)
  288. #define XPRT_INITIALIZED (9)
  289. static inline void xprt_set_connected(struct rpc_xprt *xprt)
  290. {
  291. set_bit(XPRT_CONNECTED, &xprt->state);
  292. }
  293. static inline void xprt_clear_connected(struct rpc_xprt *xprt)
  294. {
  295. clear_bit(XPRT_CONNECTED, &xprt->state);
  296. }
  297. static inline int xprt_connected(struct rpc_xprt *xprt)
  298. {
  299. return test_bit(XPRT_CONNECTED, &xprt->state);
  300. }
  301. static inline int xprt_test_and_set_connected(struct rpc_xprt *xprt)
  302. {
  303. return test_and_set_bit(XPRT_CONNECTED, &xprt->state);
  304. }
  305. static inline int xprt_test_and_clear_connected(struct rpc_xprt *xprt)
  306. {
  307. return test_and_clear_bit(XPRT_CONNECTED, &xprt->state);
  308. }
  309. static inline void xprt_clear_connecting(struct rpc_xprt *xprt)
  310. {
  311. smp_mb__before_clear_bit();
  312. clear_bit(XPRT_CONNECTING, &xprt->state);
  313. smp_mb__after_clear_bit();
  314. }
  315. static inline int xprt_connecting(struct rpc_xprt *xprt)
  316. {
  317. return test_bit(XPRT_CONNECTING, &xprt->state);
  318. }
  319. static inline int xprt_test_and_set_connecting(struct rpc_xprt *xprt)
  320. {
  321. return test_and_set_bit(XPRT_CONNECTING, &xprt->state);
  322. }
  323. static inline void xprt_set_bound(struct rpc_xprt *xprt)
  324. {
  325. test_and_set_bit(XPRT_BOUND, &xprt->state);
  326. }
  327. static inline int xprt_bound(struct rpc_xprt *xprt)
  328. {
  329. return test_bit(XPRT_BOUND, &xprt->state);
  330. }
  331. static inline void xprt_clear_bound(struct rpc_xprt *xprt)
  332. {
  333. clear_bit(XPRT_BOUND, &xprt->state);
  334. }
  335. static inline void xprt_clear_binding(struct rpc_xprt *xprt)
  336. {
  337. smp_mb__before_clear_bit();
  338. clear_bit(XPRT_BINDING, &xprt->state);
  339. smp_mb__after_clear_bit();
  340. }
  341. static inline int xprt_test_and_set_binding(struct rpc_xprt *xprt)
  342. {
  343. return test_and_set_bit(XPRT_BINDING, &xprt->state);
  344. }
  345. #endif /* __KERNEL__*/
  346. #endif /* _LINUX_SUNRPC_XPRT_H */