xprt.h 12 KB

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