xprt.c 31 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160
  1. /*
  2. * linux/net/sunrpc/xprt.c
  3. *
  4. * This is a generic RPC call interface supporting congestion avoidance,
  5. * and asynchronous calls.
  6. *
  7. * The interface works like this:
  8. *
  9. * - When a process places a call, it allocates a request slot if
  10. * one is available. Otherwise, it sleeps on the backlog queue
  11. * (xprt_reserve).
  12. * - Next, the caller puts together the RPC message, stuffs it into
  13. * the request struct, and calls xprt_transmit().
  14. * - xprt_transmit sends the message and installs the caller on the
  15. * transport's wait list. At the same time, if a reply is expected,
  16. * it installs a timer that is run after the packet's timeout has
  17. * expired.
  18. * - When a packet arrives, the data_ready handler walks the list of
  19. * pending requests for that transport. If a matching XID is found, the
  20. * caller is woken up, and the timer removed.
  21. * - When no reply arrives within the timeout interval, the timer is
  22. * fired by the kernel and runs xprt_timer(). It either adjusts the
  23. * timeout values (minor timeout) or wakes up the caller with a status
  24. * of -ETIMEDOUT.
  25. * - When the caller receives a notification from RPC that a reply arrived,
  26. * it should release the RPC slot, and process the reply.
  27. * If the call timed out, it may choose to retry the operation by
  28. * adjusting the initial timeout value, and simply calling rpc_call
  29. * again.
  30. *
  31. * Support for async RPC is done through a set of RPC-specific scheduling
  32. * primitives that `transparently' work for processes as well as async
  33. * tasks that rely on callbacks.
  34. *
  35. * Copyright (C) 1995-1997, Olaf Kirch <okir@monad.swb.de>
  36. *
  37. * Transport switch API copyright (C) 2005, Chuck Lever <cel@netapp.com>
  38. */
  39. #include <linux/module.h>
  40. #include <linux/types.h>
  41. #include <linux/interrupt.h>
  42. #include <linux/workqueue.h>
  43. #include <linux/net.h>
  44. #include <linux/ktime.h>
  45. #include <linux/sunrpc/clnt.h>
  46. #include <linux/sunrpc/metrics.h>
  47. #include <linux/sunrpc/bc_xprt.h>
  48. #include "sunrpc.h"
  49. /*
  50. * Local variables
  51. */
  52. #ifdef RPC_DEBUG
  53. # define RPCDBG_FACILITY RPCDBG_XPRT
  54. #endif
  55. /*
  56. * Local functions
  57. */
  58. static void xprt_request_init(struct rpc_task *, struct rpc_xprt *);
  59. static void xprt_connect_status(struct rpc_task *task);
  60. static int __xprt_get_cong(struct rpc_xprt *, struct rpc_task *);
  61. static DEFINE_SPINLOCK(xprt_list_lock);
  62. static LIST_HEAD(xprt_list);
  63. /*
  64. * The transport code maintains an estimate on the maximum number of out-
  65. * standing RPC requests, using a smoothed version of the congestion
  66. * avoidance implemented in 44BSD. This is basically the Van Jacobson
  67. * congestion algorithm: If a retransmit occurs, the congestion window is
  68. * halved; otherwise, it is incremented by 1/cwnd when
  69. *
  70. * - a reply is received and
  71. * - a full number of requests are outstanding and
  72. * - the congestion window hasn't been updated recently.
  73. */
  74. #define RPC_CWNDSHIFT (8U)
  75. #define RPC_CWNDSCALE (1U << RPC_CWNDSHIFT)
  76. #define RPC_INITCWND RPC_CWNDSCALE
  77. #define RPC_MAXCWND(xprt) ((xprt)->max_reqs << RPC_CWNDSHIFT)
  78. #define RPCXPRT_CONGESTED(xprt) ((xprt)->cong >= (xprt)->cwnd)
  79. /**
  80. * xprt_register_transport - register a transport implementation
  81. * @transport: transport to register
  82. *
  83. * If a transport implementation is loaded as a kernel module, it can
  84. * call this interface to make itself known to the RPC client.
  85. *
  86. * Returns:
  87. * 0: transport successfully registered
  88. * -EEXIST: transport already registered
  89. * -EINVAL: transport module being unloaded
  90. */
  91. int xprt_register_transport(struct xprt_class *transport)
  92. {
  93. struct xprt_class *t;
  94. int result;
  95. result = -EEXIST;
  96. spin_lock(&xprt_list_lock);
  97. list_for_each_entry(t, &xprt_list, list) {
  98. /* don't register the same transport class twice */
  99. if (t->ident == transport->ident)
  100. goto out;
  101. }
  102. list_add_tail(&transport->list, &xprt_list);
  103. printk(KERN_INFO "RPC: Registered %s transport module.\n",
  104. transport->name);
  105. result = 0;
  106. out:
  107. spin_unlock(&xprt_list_lock);
  108. return result;
  109. }
  110. EXPORT_SYMBOL_GPL(xprt_register_transport);
  111. /**
  112. * xprt_unregister_transport - unregister a transport implementation
  113. * @transport: transport to unregister
  114. *
  115. * Returns:
  116. * 0: transport successfully unregistered
  117. * -ENOENT: transport never registered
  118. */
  119. int xprt_unregister_transport(struct xprt_class *transport)
  120. {
  121. struct xprt_class *t;
  122. int result;
  123. result = 0;
  124. spin_lock(&xprt_list_lock);
  125. list_for_each_entry(t, &xprt_list, list) {
  126. if (t == transport) {
  127. printk(KERN_INFO
  128. "RPC: Unregistered %s transport module.\n",
  129. transport->name);
  130. list_del_init(&transport->list);
  131. goto out;
  132. }
  133. }
  134. result = -ENOENT;
  135. out:
  136. spin_unlock(&xprt_list_lock);
  137. return result;
  138. }
  139. EXPORT_SYMBOL_GPL(xprt_unregister_transport);
  140. /**
  141. * xprt_load_transport - load a transport implementation
  142. * @transport_name: transport to load
  143. *
  144. * Returns:
  145. * 0: transport successfully loaded
  146. * -ENOENT: transport module not available
  147. */
  148. int xprt_load_transport(const char *transport_name)
  149. {
  150. struct xprt_class *t;
  151. int result;
  152. result = 0;
  153. spin_lock(&xprt_list_lock);
  154. list_for_each_entry(t, &xprt_list, list) {
  155. if (strcmp(t->name, transport_name) == 0) {
  156. spin_unlock(&xprt_list_lock);
  157. goto out;
  158. }
  159. }
  160. spin_unlock(&xprt_list_lock);
  161. result = request_module("xprt%s", transport_name);
  162. out:
  163. return result;
  164. }
  165. EXPORT_SYMBOL_GPL(xprt_load_transport);
  166. /**
  167. * xprt_reserve_xprt - serialize write access to transports
  168. * @task: task that is requesting access to the transport
  169. *
  170. * This prevents mixing the payload of separate requests, and prevents
  171. * transport connects from colliding with writes. No congestion control
  172. * is provided.
  173. */
  174. int xprt_reserve_xprt(struct rpc_task *task)
  175. {
  176. struct rpc_rqst *req = task->tk_rqstp;
  177. struct rpc_xprt *xprt = req->rq_xprt;
  178. if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
  179. if (task == xprt->snd_task)
  180. return 1;
  181. if (task == NULL)
  182. return 0;
  183. goto out_sleep;
  184. }
  185. xprt->snd_task = task;
  186. if (req) {
  187. req->rq_bytes_sent = 0;
  188. req->rq_ntrans++;
  189. }
  190. return 1;
  191. out_sleep:
  192. dprintk("RPC: %5u failed to lock transport %p\n",
  193. task->tk_pid, xprt);
  194. task->tk_timeout = 0;
  195. task->tk_status = -EAGAIN;
  196. if (req && req->rq_ntrans)
  197. rpc_sleep_on(&xprt->resend, task, NULL);
  198. else
  199. rpc_sleep_on(&xprt->sending, task, NULL);
  200. return 0;
  201. }
  202. EXPORT_SYMBOL_GPL(xprt_reserve_xprt);
  203. static void xprt_clear_locked(struct rpc_xprt *xprt)
  204. {
  205. xprt->snd_task = NULL;
  206. if (!test_bit(XPRT_CLOSE_WAIT, &xprt->state) || xprt->shutdown) {
  207. smp_mb__before_clear_bit();
  208. clear_bit(XPRT_LOCKED, &xprt->state);
  209. smp_mb__after_clear_bit();
  210. } else
  211. queue_work(rpciod_workqueue, &xprt->task_cleanup);
  212. }
  213. /*
  214. * xprt_reserve_xprt_cong - serialize write access to transports
  215. * @task: task that is requesting access to the transport
  216. *
  217. * Same as xprt_reserve_xprt, but Van Jacobson congestion control is
  218. * integrated into the decision of whether a request is allowed to be
  219. * woken up and given access to the transport.
  220. */
  221. int xprt_reserve_xprt_cong(struct rpc_task *task)
  222. {
  223. struct rpc_xprt *xprt = task->tk_xprt;
  224. struct rpc_rqst *req = task->tk_rqstp;
  225. if (test_and_set_bit(XPRT_LOCKED, &xprt->state)) {
  226. if (task == xprt->snd_task)
  227. return 1;
  228. goto out_sleep;
  229. }
  230. if (__xprt_get_cong(xprt, task)) {
  231. xprt->snd_task = task;
  232. if (req) {
  233. req->rq_bytes_sent = 0;
  234. req->rq_ntrans++;
  235. }
  236. return 1;
  237. }
  238. xprt_clear_locked(xprt);
  239. out_sleep:
  240. dprintk("RPC: %5u failed to lock transport %p\n", task->tk_pid, xprt);
  241. task->tk_timeout = 0;
  242. task->tk_status = -EAGAIN;
  243. if (req && req->rq_ntrans)
  244. rpc_sleep_on(&xprt->resend, task, NULL);
  245. else
  246. rpc_sleep_on(&xprt->sending, task, NULL);
  247. return 0;
  248. }
  249. EXPORT_SYMBOL_GPL(xprt_reserve_xprt_cong);
  250. static inline int xprt_lock_write(struct rpc_xprt *xprt, struct rpc_task *task)
  251. {
  252. int retval;
  253. spin_lock_bh(&xprt->transport_lock);
  254. retval = xprt->ops->reserve_xprt(task);
  255. spin_unlock_bh(&xprt->transport_lock);
  256. return retval;
  257. }
  258. static void __xprt_lock_write_next(struct rpc_xprt *xprt)
  259. {
  260. struct rpc_task *task;
  261. struct rpc_rqst *req;
  262. if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
  263. return;
  264. task = rpc_wake_up_next(&xprt->resend);
  265. if (!task) {
  266. task = rpc_wake_up_next(&xprt->sending);
  267. if (!task)
  268. goto out_unlock;
  269. }
  270. req = task->tk_rqstp;
  271. xprt->snd_task = task;
  272. if (req) {
  273. req->rq_bytes_sent = 0;
  274. req->rq_ntrans++;
  275. }
  276. return;
  277. out_unlock:
  278. xprt_clear_locked(xprt);
  279. }
  280. static void __xprt_lock_write_next_cong(struct rpc_xprt *xprt)
  281. {
  282. struct rpc_task *task;
  283. if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
  284. return;
  285. if (RPCXPRT_CONGESTED(xprt))
  286. goto out_unlock;
  287. task = rpc_wake_up_next(&xprt->resend);
  288. if (!task) {
  289. task = rpc_wake_up_next(&xprt->sending);
  290. if (!task)
  291. goto out_unlock;
  292. }
  293. if (__xprt_get_cong(xprt, task)) {
  294. struct rpc_rqst *req = task->tk_rqstp;
  295. xprt->snd_task = task;
  296. if (req) {
  297. req->rq_bytes_sent = 0;
  298. req->rq_ntrans++;
  299. }
  300. return;
  301. }
  302. out_unlock:
  303. xprt_clear_locked(xprt);
  304. }
  305. /**
  306. * xprt_release_xprt - allow other requests to use a transport
  307. * @xprt: transport with other tasks potentially waiting
  308. * @task: task that is releasing access to the transport
  309. *
  310. * Note that "task" can be NULL. No congestion control is provided.
  311. */
  312. void xprt_release_xprt(struct rpc_xprt *xprt, struct rpc_task *task)
  313. {
  314. if (xprt->snd_task == task) {
  315. xprt_clear_locked(xprt);
  316. __xprt_lock_write_next(xprt);
  317. }
  318. }
  319. EXPORT_SYMBOL_GPL(xprt_release_xprt);
  320. /**
  321. * xprt_release_xprt_cong - allow other requests to use a transport
  322. * @xprt: transport with other tasks potentially waiting
  323. * @task: task that is releasing access to the transport
  324. *
  325. * Note that "task" can be NULL. Another task is awoken to use the
  326. * transport if the transport's congestion window allows it.
  327. */
  328. void xprt_release_xprt_cong(struct rpc_xprt *xprt, struct rpc_task *task)
  329. {
  330. if (xprt->snd_task == task) {
  331. xprt_clear_locked(xprt);
  332. __xprt_lock_write_next_cong(xprt);
  333. }
  334. }
  335. EXPORT_SYMBOL_GPL(xprt_release_xprt_cong);
  336. static inline void xprt_release_write(struct rpc_xprt *xprt, struct rpc_task *task)
  337. {
  338. spin_lock_bh(&xprt->transport_lock);
  339. xprt->ops->release_xprt(xprt, task);
  340. spin_unlock_bh(&xprt->transport_lock);
  341. }
  342. /*
  343. * Van Jacobson congestion avoidance. Check if the congestion window
  344. * overflowed. Put the task to sleep if this is the case.
  345. */
  346. static int
  347. __xprt_get_cong(struct rpc_xprt *xprt, struct rpc_task *task)
  348. {
  349. struct rpc_rqst *req = task->tk_rqstp;
  350. if (req->rq_cong)
  351. return 1;
  352. dprintk("RPC: %5u xprt_cwnd_limited cong = %lu cwnd = %lu\n",
  353. task->tk_pid, xprt->cong, xprt->cwnd);
  354. if (RPCXPRT_CONGESTED(xprt))
  355. return 0;
  356. req->rq_cong = 1;
  357. xprt->cong += RPC_CWNDSCALE;
  358. return 1;
  359. }
  360. /*
  361. * Adjust the congestion window, and wake up the next task
  362. * that has been sleeping due to congestion
  363. */
  364. static void
  365. __xprt_put_cong(struct rpc_xprt *xprt, struct rpc_rqst *req)
  366. {
  367. if (!req->rq_cong)
  368. return;
  369. req->rq_cong = 0;
  370. xprt->cong -= RPC_CWNDSCALE;
  371. __xprt_lock_write_next_cong(xprt);
  372. }
  373. /**
  374. * xprt_release_rqst_cong - housekeeping when request is complete
  375. * @task: RPC request that recently completed
  376. *
  377. * Useful for transports that require congestion control.
  378. */
  379. void xprt_release_rqst_cong(struct rpc_task *task)
  380. {
  381. __xprt_put_cong(task->tk_xprt, task->tk_rqstp);
  382. }
  383. EXPORT_SYMBOL_GPL(xprt_release_rqst_cong);
  384. /**
  385. * xprt_adjust_cwnd - adjust transport congestion window
  386. * @task: recently completed RPC request used to adjust window
  387. * @result: result code of completed RPC request
  388. *
  389. * We use a time-smoothed congestion estimator to avoid heavy oscillation.
  390. */
  391. void xprt_adjust_cwnd(struct rpc_task *task, int result)
  392. {
  393. struct rpc_rqst *req = task->tk_rqstp;
  394. struct rpc_xprt *xprt = task->tk_xprt;
  395. unsigned long cwnd = xprt->cwnd;
  396. if (result >= 0 && cwnd <= xprt->cong) {
  397. /* The (cwnd >> 1) term makes sure
  398. * the result gets rounded properly. */
  399. cwnd += (RPC_CWNDSCALE * RPC_CWNDSCALE + (cwnd >> 1)) / cwnd;
  400. if (cwnd > RPC_MAXCWND(xprt))
  401. cwnd = RPC_MAXCWND(xprt);
  402. __xprt_lock_write_next_cong(xprt);
  403. } else if (result == -ETIMEDOUT) {
  404. cwnd >>= 1;
  405. if (cwnd < RPC_CWNDSCALE)
  406. cwnd = RPC_CWNDSCALE;
  407. }
  408. dprintk("RPC: cong %ld, cwnd was %ld, now %ld\n",
  409. xprt->cong, xprt->cwnd, cwnd);
  410. xprt->cwnd = cwnd;
  411. __xprt_put_cong(xprt, req);
  412. }
  413. EXPORT_SYMBOL_GPL(xprt_adjust_cwnd);
  414. /**
  415. * xprt_wake_pending_tasks - wake all tasks on a transport's pending queue
  416. * @xprt: transport with waiting tasks
  417. * @status: result code to plant in each task before waking it
  418. *
  419. */
  420. void xprt_wake_pending_tasks(struct rpc_xprt *xprt, int status)
  421. {
  422. if (status < 0)
  423. rpc_wake_up_status(&xprt->pending, status);
  424. else
  425. rpc_wake_up(&xprt->pending);
  426. }
  427. EXPORT_SYMBOL_GPL(xprt_wake_pending_tasks);
  428. /**
  429. * xprt_wait_for_buffer_space - wait for transport output buffer to clear
  430. * @task: task to be put to sleep
  431. * @action: function pointer to be executed after wait
  432. */
  433. void xprt_wait_for_buffer_space(struct rpc_task *task, rpc_action action)
  434. {
  435. struct rpc_rqst *req = task->tk_rqstp;
  436. struct rpc_xprt *xprt = req->rq_xprt;
  437. task->tk_timeout = req->rq_timeout;
  438. rpc_sleep_on(&xprt->pending, task, action);
  439. }
  440. EXPORT_SYMBOL_GPL(xprt_wait_for_buffer_space);
  441. /**
  442. * xprt_write_space - wake the task waiting for transport output buffer space
  443. * @xprt: transport with waiting tasks
  444. *
  445. * Can be called in a soft IRQ context, so xprt_write_space never sleeps.
  446. */
  447. void xprt_write_space(struct rpc_xprt *xprt)
  448. {
  449. if (unlikely(xprt->shutdown))
  450. return;
  451. spin_lock_bh(&xprt->transport_lock);
  452. if (xprt->snd_task) {
  453. dprintk("RPC: write space: waking waiting task on "
  454. "xprt %p\n", xprt);
  455. rpc_wake_up_queued_task(&xprt->pending, xprt->snd_task);
  456. }
  457. spin_unlock_bh(&xprt->transport_lock);
  458. }
  459. EXPORT_SYMBOL_GPL(xprt_write_space);
  460. /**
  461. * xprt_set_retrans_timeout_def - set a request's retransmit timeout
  462. * @task: task whose timeout is to be set
  463. *
  464. * Set a request's retransmit timeout based on the transport's
  465. * default timeout parameters. Used by transports that don't adjust
  466. * the retransmit timeout based on round-trip time estimation.
  467. */
  468. void xprt_set_retrans_timeout_def(struct rpc_task *task)
  469. {
  470. task->tk_timeout = task->tk_rqstp->rq_timeout;
  471. }
  472. EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_def);
  473. /*
  474. * xprt_set_retrans_timeout_rtt - set a request's retransmit timeout
  475. * @task: task whose timeout is to be set
  476. *
  477. * Set a request's retransmit timeout using the RTT estimator.
  478. */
  479. void xprt_set_retrans_timeout_rtt(struct rpc_task *task)
  480. {
  481. int timer = task->tk_msg.rpc_proc->p_timer;
  482. struct rpc_clnt *clnt = task->tk_client;
  483. struct rpc_rtt *rtt = clnt->cl_rtt;
  484. struct rpc_rqst *req = task->tk_rqstp;
  485. unsigned long max_timeout = clnt->cl_timeout->to_maxval;
  486. task->tk_timeout = rpc_calc_rto(rtt, timer);
  487. task->tk_timeout <<= rpc_ntimeo(rtt, timer) + req->rq_retries;
  488. if (task->tk_timeout > max_timeout || task->tk_timeout == 0)
  489. task->tk_timeout = max_timeout;
  490. }
  491. EXPORT_SYMBOL_GPL(xprt_set_retrans_timeout_rtt);
  492. static void xprt_reset_majortimeo(struct rpc_rqst *req)
  493. {
  494. const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
  495. req->rq_majortimeo = req->rq_timeout;
  496. if (to->to_exponential)
  497. req->rq_majortimeo <<= to->to_retries;
  498. else
  499. req->rq_majortimeo += to->to_increment * to->to_retries;
  500. if (req->rq_majortimeo > to->to_maxval || req->rq_majortimeo == 0)
  501. req->rq_majortimeo = to->to_maxval;
  502. req->rq_majortimeo += jiffies;
  503. }
  504. /**
  505. * xprt_adjust_timeout - adjust timeout values for next retransmit
  506. * @req: RPC request containing parameters to use for the adjustment
  507. *
  508. */
  509. int xprt_adjust_timeout(struct rpc_rqst *req)
  510. {
  511. struct rpc_xprt *xprt = req->rq_xprt;
  512. const struct rpc_timeout *to = req->rq_task->tk_client->cl_timeout;
  513. int status = 0;
  514. if (time_before(jiffies, req->rq_majortimeo)) {
  515. if (to->to_exponential)
  516. req->rq_timeout <<= 1;
  517. else
  518. req->rq_timeout += to->to_increment;
  519. if (to->to_maxval && req->rq_timeout >= to->to_maxval)
  520. req->rq_timeout = to->to_maxval;
  521. req->rq_retries++;
  522. } else {
  523. req->rq_timeout = to->to_initval;
  524. req->rq_retries = 0;
  525. xprt_reset_majortimeo(req);
  526. /* Reset the RTT counters == "slow start" */
  527. spin_lock_bh(&xprt->transport_lock);
  528. rpc_init_rtt(req->rq_task->tk_client->cl_rtt, to->to_initval);
  529. spin_unlock_bh(&xprt->transport_lock);
  530. status = -ETIMEDOUT;
  531. }
  532. if (req->rq_timeout == 0) {
  533. printk(KERN_WARNING "xprt_adjust_timeout: rq_timeout = 0!\n");
  534. req->rq_timeout = 5 * HZ;
  535. }
  536. return status;
  537. }
  538. static void xprt_autoclose(struct work_struct *work)
  539. {
  540. struct rpc_xprt *xprt =
  541. container_of(work, struct rpc_xprt, task_cleanup);
  542. xprt->ops->close(xprt);
  543. clear_bit(XPRT_CLOSE_WAIT, &xprt->state);
  544. xprt_release_write(xprt, NULL);
  545. }
  546. /**
  547. * xprt_disconnect_done - mark a transport as disconnected
  548. * @xprt: transport to flag for disconnect
  549. *
  550. */
  551. void xprt_disconnect_done(struct rpc_xprt *xprt)
  552. {
  553. dprintk("RPC: disconnected transport %p\n", xprt);
  554. spin_lock_bh(&xprt->transport_lock);
  555. xprt_clear_connected(xprt);
  556. xprt_wake_pending_tasks(xprt, -EAGAIN);
  557. spin_unlock_bh(&xprt->transport_lock);
  558. }
  559. EXPORT_SYMBOL_GPL(xprt_disconnect_done);
  560. /**
  561. * xprt_force_disconnect - force a transport to disconnect
  562. * @xprt: transport to disconnect
  563. *
  564. */
  565. void xprt_force_disconnect(struct rpc_xprt *xprt)
  566. {
  567. /* Don't race with the test_bit() in xprt_clear_locked() */
  568. spin_lock_bh(&xprt->transport_lock);
  569. set_bit(XPRT_CLOSE_WAIT, &xprt->state);
  570. /* Try to schedule an autoclose RPC call */
  571. if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
  572. queue_work(rpciod_workqueue, &xprt->task_cleanup);
  573. xprt_wake_pending_tasks(xprt, -EAGAIN);
  574. spin_unlock_bh(&xprt->transport_lock);
  575. }
  576. /**
  577. * xprt_conditional_disconnect - force a transport to disconnect
  578. * @xprt: transport to disconnect
  579. * @cookie: 'connection cookie'
  580. *
  581. * This attempts to break the connection if and only if 'cookie' matches
  582. * the current transport 'connection cookie'. It ensures that we don't
  583. * try to break the connection more than once when we need to retransmit
  584. * a batch of RPC requests.
  585. *
  586. */
  587. void xprt_conditional_disconnect(struct rpc_xprt *xprt, unsigned int cookie)
  588. {
  589. /* Don't race with the test_bit() in xprt_clear_locked() */
  590. spin_lock_bh(&xprt->transport_lock);
  591. if (cookie != xprt->connect_cookie)
  592. goto out;
  593. if (test_bit(XPRT_CLOSING, &xprt->state) || !xprt_connected(xprt))
  594. goto out;
  595. set_bit(XPRT_CLOSE_WAIT, &xprt->state);
  596. /* Try to schedule an autoclose RPC call */
  597. if (test_and_set_bit(XPRT_LOCKED, &xprt->state) == 0)
  598. queue_work(rpciod_workqueue, &xprt->task_cleanup);
  599. xprt_wake_pending_tasks(xprt, -EAGAIN);
  600. out:
  601. spin_unlock_bh(&xprt->transport_lock);
  602. }
  603. static void
  604. xprt_init_autodisconnect(unsigned long data)
  605. {
  606. struct rpc_xprt *xprt = (struct rpc_xprt *)data;
  607. spin_lock(&xprt->transport_lock);
  608. if (!list_empty(&xprt->recv) || xprt->shutdown)
  609. goto out_abort;
  610. if (test_and_set_bit(XPRT_LOCKED, &xprt->state))
  611. goto out_abort;
  612. spin_unlock(&xprt->transport_lock);
  613. set_bit(XPRT_CONNECTION_CLOSE, &xprt->state);
  614. queue_work(rpciod_workqueue, &xprt->task_cleanup);
  615. return;
  616. out_abort:
  617. spin_unlock(&xprt->transport_lock);
  618. }
  619. /**
  620. * xprt_connect - schedule a transport connect operation
  621. * @task: RPC task that is requesting the connect
  622. *
  623. */
  624. void xprt_connect(struct rpc_task *task)
  625. {
  626. struct rpc_xprt *xprt = task->tk_xprt;
  627. dprintk("RPC: %5u xprt_connect xprt %p %s connected\n", task->tk_pid,
  628. xprt, (xprt_connected(xprt) ? "is" : "is not"));
  629. if (!xprt_bound(xprt)) {
  630. task->tk_status = -EAGAIN;
  631. return;
  632. }
  633. if (!xprt_lock_write(xprt, task))
  634. return;
  635. if (test_and_clear_bit(XPRT_CLOSE_WAIT, &xprt->state))
  636. xprt->ops->close(xprt);
  637. if (xprt_connected(xprt))
  638. xprt_release_write(xprt, task);
  639. else {
  640. if (task->tk_rqstp)
  641. task->tk_rqstp->rq_bytes_sent = 0;
  642. task->tk_timeout = task->tk_rqstp->rq_timeout;
  643. rpc_sleep_on(&xprt->pending, task, xprt_connect_status);
  644. if (test_bit(XPRT_CLOSING, &xprt->state))
  645. return;
  646. if (xprt_test_and_set_connecting(xprt))
  647. return;
  648. xprt->stat.connect_start = jiffies;
  649. xprt->ops->connect(task);
  650. }
  651. }
  652. static void xprt_connect_status(struct rpc_task *task)
  653. {
  654. struct rpc_xprt *xprt = task->tk_xprt;
  655. if (task->tk_status == 0) {
  656. xprt->stat.connect_count++;
  657. xprt->stat.connect_time += (long)jiffies - xprt->stat.connect_start;
  658. dprintk("RPC: %5u xprt_connect_status: connection established\n",
  659. task->tk_pid);
  660. return;
  661. }
  662. switch (task->tk_status) {
  663. case -EAGAIN:
  664. dprintk("RPC: %5u xprt_connect_status: retrying\n", task->tk_pid);
  665. break;
  666. case -ETIMEDOUT:
  667. dprintk("RPC: %5u xprt_connect_status: connect attempt timed "
  668. "out\n", task->tk_pid);
  669. break;
  670. default:
  671. dprintk("RPC: %5u xprt_connect_status: error %d connecting to "
  672. "server %s\n", task->tk_pid, -task->tk_status,
  673. task->tk_client->cl_server);
  674. xprt_release_write(xprt, task);
  675. task->tk_status = -EIO;
  676. }
  677. }
  678. /**
  679. * xprt_lookup_rqst - find an RPC request corresponding to an XID
  680. * @xprt: transport on which the original request was transmitted
  681. * @xid: RPC XID of incoming reply
  682. *
  683. */
  684. struct rpc_rqst *xprt_lookup_rqst(struct rpc_xprt *xprt, __be32 xid)
  685. {
  686. struct list_head *pos;
  687. list_for_each(pos, &xprt->recv) {
  688. struct rpc_rqst *entry = list_entry(pos, struct rpc_rqst, rq_list);
  689. if (entry->rq_xid == xid)
  690. return entry;
  691. }
  692. dprintk("RPC: xprt_lookup_rqst did not find xid %08x\n",
  693. ntohl(xid));
  694. xprt->stat.bad_xids++;
  695. return NULL;
  696. }
  697. EXPORT_SYMBOL_GPL(xprt_lookup_rqst);
  698. static void xprt_update_rtt(struct rpc_task *task)
  699. {
  700. struct rpc_rqst *req = task->tk_rqstp;
  701. struct rpc_rtt *rtt = task->tk_client->cl_rtt;
  702. unsigned timer = task->tk_msg.rpc_proc->p_timer;
  703. long m = usecs_to_jiffies(ktime_to_us(req->rq_rtt));
  704. if (timer) {
  705. if (req->rq_ntrans == 1)
  706. rpc_update_rtt(rtt, timer, m);
  707. rpc_set_timeo(rtt, timer, req->rq_ntrans - 1);
  708. }
  709. }
  710. /**
  711. * xprt_complete_rqst - called when reply processing is complete
  712. * @task: RPC request that recently completed
  713. * @copied: actual number of bytes received from the transport
  714. *
  715. * Caller holds transport lock.
  716. */
  717. void xprt_complete_rqst(struct rpc_task *task, int copied)
  718. {
  719. struct rpc_rqst *req = task->tk_rqstp;
  720. struct rpc_xprt *xprt = req->rq_xprt;
  721. dprintk("RPC: %5u xid %08x complete (%d bytes received)\n",
  722. task->tk_pid, ntohl(req->rq_xid), copied);
  723. xprt->stat.recvs++;
  724. req->rq_rtt = ktime_sub(ktime_get(), req->rq_xtime);
  725. if (xprt->ops->timer != NULL)
  726. xprt_update_rtt(task);
  727. list_del_init(&req->rq_list);
  728. req->rq_private_buf.len = copied;
  729. /* Ensure all writes are done before we update */
  730. /* req->rq_reply_bytes_recvd */
  731. smp_wmb();
  732. req->rq_reply_bytes_recvd = copied;
  733. rpc_wake_up_queued_task(&xprt->pending, task);
  734. }
  735. EXPORT_SYMBOL_GPL(xprt_complete_rqst);
  736. static void xprt_timer(struct rpc_task *task)
  737. {
  738. struct rpc_rqst *req = task->tk_rqstp;
  739. struct rpc_xprt *xprt = req->rq_xprt;
  740. if (task->tk_status != -ETIMEDOUT)
  741. return;
  742. dprintk("RPC: %5u xprt_timer\n", task->tk_pid);
  743. spin_lock_bh(&xprt->transport_lock);
  744. if (!req->rq_reply_bytes_recvd) {
  745. if (xprt->ops->timer)
  746. xprt->ops->timer(task);
  747. } else
  748. task->tk_status = 0;
  749. spin_unlock_bh(&xprt->transport_lock);
  750. }
  751. static inline int xprt_has_timer(struct rpc_xprt *xprt)
  752. {
  753. return xprt->idle_timeout != 0;
  754. }
  755. /**
  756. * xprt_prepare_transmit - reserve the transport before sending a request
  757. * @task: RPC task about to send a request
  758. *
  759. */
  760. int xprt_prepare_transmit(struct rpc_task *task)
  761. {
  762. struct rpc_rqst *req = task->tk_rqstp;
  763. struct rpc_xprt *xprt = req->rq_xprt;
  764. int err = 0;
  765. dprintk("RPC: %5u xprt_prepare_transmit\n", task->tk_pid);
  766. spin_lock_bh(&xprt->transport_lock);
  767. if (req->rq_reply_bytes_recvd && !req->rq_bytes_sent) {
  768. err = req->rq_reply_bytes_recvd;
  769. goto out_unlock;
  770. }
  771. if (!xprt->ops->reserve_xprt(task))
  772. err = -EAGAIN;
  773. out_unlock:
  774. spin_unlock_bh(&xprt->transport_lock);
  775. return err;
  776. }
  777. void xprt_end_transmit(struct rpc_task *task)
  778. {
  779. xprt_release_write(task->tk_rqstp->rq_xprt, task);
  780. }
  781. /**
  782. * xprt_transmit - send an RPC request on a transport
  783. * @task: controlling RPC task
  784. *
  785. * We have to copy the iovec because sendmsg fiddles with its contents.
  786. */
  787. void xprt_transmit(struct rpc_task *task)
  788. {
  789. struct rpc_rqst *req = task->tk_rqstp;
  790. struct rpc_xprt *xprt = req->rq_xprt;
  791. int status;
  792. dprintk("RPC: %5u xprt_transmit(%u)\n", task->tk_pid, req->rq_slen);
  793. if (!req->rq_reply_bytes_recvd) {
  794. if (list_empty(&req->rq_list) && rpc_reply_expected(task)) {
  795. /*
  796. * Add to the list only if we're expecting a reply
  797. */
  798. spin_lock_bh(&xprt->transport_lock);
  799. /* Update the softirq receive buffer */
  800. memcpy(&req->rq_private_buf, &req->rq_rcv_buf,
  801. sizeof(req->rq_private_buf));
  802. /* Add request to the receive list */
  803. list_add_tail(&req->rq_list, &xprt->recv);
  804. spin_unlock_bh(&xprt->transport_lock);
  805. xprt_reset_majortimeo(req);
  806. /* Turn off autodisconnect */
  807. del_singleshot_timer_sync(&xprt->timer);
  808. }
  809. } else if (!req->rq_bytes_sent)
  810. return;
  811. req->rq_connect_cookie = xprt->connect_cookie;
  812. req->rq_xtime = ktime_get();
  813. status = xprt->ops->send_request(task);
  814. if (status != 0) {
  815. task->tk_status = status;
  816. return;
  817. }
  818. dprintk("RPC: %5u xmit complete\n", task->tk_pid);
  819. spin_lock_bh(&xprt->transport_lock);
  820. xprt->ops->set_retrans_timeout(task);
  821. xprt->stat.sends++;
  822. xprt->stat.req_u += xprt->stat.sends - xprt->stat.recvs;
  823. xprt->stat.bklog_u += xprt->backlog.qlen;
  824. /* Don't race with disconnect */
  825. if (!xprt_connected(xprt))
  826. task->tk_status = -ENOTCONN;
  827. else if (!req->rq_reply_bytes_recvd && rpc_reply_expected(task)) {
  828. /*
  829. * Sleep on the pending queue since
  830. * we're expecting a reply.
  831. */
  832. rpc_sleep_on(&xprt->pending, task, xprt_timer);
  833. }
  834. spin_unlock_bh(&xprt->transport_lock);
  835. }
  836. static void xprt_alloc_slot(struct rpc_task *task)
  837. {
  838. struct rpc_xprt *xprt = task->tk_xprt;
  839. task->tk_status = 0;
  840. if (task->tk_rqstp)
  841. return;
  842. if (!list_empty(&xprt->free)) {
  843. struct rpc_rqst *req = list_entry(xprt->free.next, struct rpc_rqst, rq_list);
  844. list_del_init(&req->rq_list);
  845. task->tk_rqstp = req;
  846. xprt_request_init(task, xprt);
  847. return;
  848. }
  849. dprintk("RPC: waiting for request slot\n");
  850. task->tk_status = -EAGAIN;
  851. task->tk_timeout = 0;
  852. rpc_sleep_on(&xprt->backlog, task, NULL);
  853. }
  854. static void xprt_free_slot(struct rpc_xprt *xprt, struct rpc_rqst *req)
  855. {
  856. memset(req, 0, sizeof(*req)); /* mark unused */
  857. spin_lock(&xprt->reserve_lock);
  858. list_add(&req->rq_list, &xprt->free);
  859. rpc_wake_up_next(&xprt->backlog);
  860. spin_unlock(&xprt->reserve_lock);
  861. }
  862. /**
  863. * xprt_reserve - allocate an RPC request slot
  864. * @task: RPC task requesting a slot allocation
  865. *
  866. * If no more slots are available, place the task on the transport's
  867. * backlog queue.
  868. */
  869. void xprt_reserve(struct rpc_task *task)
  870. {
  871. struct rpc_xprt *xprt = task->tk_xprt;
  872. task->tk_status = -EIO;
  873. spin_lock(&xprt->reserve_lock);
  874. xprt_alloc_slot(task);
  875. spin_unlock(&xprt->reserve_lock);
  876. }
  877. static inline __be32 xprt_alloc_xid(struct rpc_xprt *xprt)
  878. {
  879. return (__force __be32)xprt->xid++;
  880. }
  881. static inline void xprt_init_xid(struct rpc_xprt *xprt)
  882. {
  883. xprt->xid = net_random();
  884. }
  885. static void xprt_request_init(struct rpc_task *task, struct rpc_xprt *xprt)
  886. {
  887. struct rpc_rqst *req = task->tk_rqstp;
  888. req->rq_timeout = task->tk_client->cl_timeout->to_initval;
  889. req->rq_task = task;
  890. req->rq_xprt = xprt;
  891. req->rq_buffer = NULL;
  892. req->rq_xid = xprt_alloc_xid(xprt);
  893. req->rq_release_snd_buf = NULL;
  894. xprt_reset_majortimeo(req);
  895. dprintk("RPC: %5u reserved req %p xid %08x\n", task->tk_pid,
  896. req, ntohl(req->rq_xid));
  897. }
  898. /**
  899. * xprt_release - release an RPC request slot
  900. * @task: task which is finished with the slot
  901. *
  902. */
  903. void xprt_release(struct rpc_task *task)
  904. {
  905. struct rpc_xprt *xprt;
  906. struct rpc_rqst *req;
  907. if (!(req = task->tk_rqstp))
  908. return;
  909. xprt = req->rq_xprt;
  910. rpc_count_iostats(task);
  911. spin_lock_bh(&xprt->transport_lock);
  912. xprt->ops->release_xprt(xprt, task);
  913. if (xprt->ops->release_request)
  914. xprt->ops->release_request(task);
  915. if (!list_empty(&req->rq_list))
  916. list_del(&req->rq_list);
  917. xprt->last_used = jiffies;
  918. if (list_empty(&xprt->recv) && xprt_has_timer(xprt))
  919. mod_timer(&xprt->timer,
  920. xprt->last_used + xprt->idle_timeout);
  921. spin_unlock_bh(&xprt->transport_lock);
  922. if (req->rq_buffer)
  923. xprt->ops->buf_free(req->rq_buffer);
  924. if (req->rq_cred != NULL)
  925. put_rpccred(req->rq_cred);
  926. task->tk_rqstp = NULL;
  927. if (req->rq_release_snd_buf)
  928. req->rq_release_snd_buf(req);
  929. dprintk("RPC: %5u release request %p\n", task->tk_pid, req);
  930. if (likely(!bc_prealloc(req)))
  931. xprt_free_slot(xprt, req);
  932. else
  933. xprt_free_bc_request(req);
  934. }
  935. /**
  936. * xprt_create_transport - create an RPC transport
  937. * @args: rpc transport creation arguments
  938. *
  939. */
  940. struct rpc_xprt *xprt_create_transport(struct xprt_create *args)
  941. {
  942. struct rpc_xprt *xprt;
  943. struct rpc_rqst *req;
  944. struct xprt_class *t;
  945. spin_lock(&xprt_list_lock);
  946. list_for_each_entry(t, &xprt_list, list) {
  947. if (t->ident == args->ident) {
  948. spin_unlock(&xprt_list_lock);
  949. goto found;
  950. }
  951. }
  952. spin_unlock(&xprt_list_lock);
  953. printk(KERN_ERR "RPC: transport (%d) not supported\n", args->ident);
  954. return ERR_PTR(-EIO);
  955. found:
  956. xprt = t->setup(args);
  957. if (IS_ERR(xprt)) {
  958. dprintk("RPC: xprt_create_transport: failed, %ld\n",
  959. -PTR_ERR(xprt));
  960. return xprt;
  961. }
  962. kref_init(&xprt->kref);
  963. spin_lock_init(&xprt->transport_lock);
  964. spin_lock_init(&xprt->reserve_lock);
  965. INIT_LIST_HEAD(&xprt->free);
  966. INIT_LIST_HEAD(&xprt->recv);
  967. #if defined(CONFIG_NFS_V4_1)
  968. spin_lock_init(&xprt->bc_pa_lock);
  969. INIT_LIST_HEAD(&xprt->bc_pa_list);
  970. #endif /* CONFIG_NFS_V4_1 */
  971. INIT_WORK(&xprt->task_cleanup, xprt_autoclose);
  972. if (xprt_has_timer(xprt))
  973. setup_timer(&xprt->timer, xprt_init_autodisconnect,
  974. (unsigned long)xprt);
  975. else
  976. init_timer(&xprt->timer);
  977. xprt->last_used = jiffies;
  978. xprt->cwnd = RPC_INITCWND;
  979. xprt->bind_index = 0;
  980. rpc_init_wait_queue(&xprt->binding, "xprt_binding");
  981. rpc_init_wait_queue(&xprt->pending, "xprt_pending");
  982. rpc_init_wait_queue(&xprt->sending, "xprt_sending");
  983. rpc_init_wait_queue(&xprt->resend, "xprt_resend");
  984. rpc_init_priority_wait_queue(&xprt->backlog, "xprt_backlog");
  985. /* initialize free list */
  986. for (req = &xprt->slot[xprt->max_reqs-1]; req >= &xprt->slot[0]; req--)
  987. list_add(&req->rq_list, &xprt->free);
  988. xprt_init_xid(xprt);
  989. dprintk("RPC: created transport %p with %u slots\n", xprt,
  990. xprt->max_reqs);
  991. return xprt;
  992. }
  993. /**
  994. * xprt_destroy - destroy an RPC transport, killing off all requests.
  995. * @kref: kref for the transport to destroy
  996. *
  997. */
  998. static void xprt_destroy(struct kref *kref)
  999. {
  1000. struct rpc_xprt *xprt = container_of(kref, struct rpc_xprt, kref);
  1001. dprintk("RPC: destroying transport %p\n", xprt);
  1002. xprt->shutdown = 1;
  1003. del_timer_sync(&xprt->timer);
  1004. rpc_destroy_wait_queue(&xprt->binding);
  1005. rpc_destroy_wait_queue(&xprt->pending);
  1006. rpc_destroy_wait_queue(&xprt->sending);
  1007. rpc_destroy_wait_queue(&xprt->resend);
  1008. rpc_destroy_wait_queue(&xprt->backlog);
  1009. cancel_work_sync(&xprt->task_cleanup);
  1010. /*
  1011. * Tear down transport state and free the rpc_xprt
  1012. */
  1013. xprt->ops->destroy(xprt);
  1014. }
  1015. /**
  1016. * xprt_put - release a reference to an RPC transport.
  1017. * @xprt: pointer to the transport
  1018. *
  1019. */
  1020. void xprt_put(struct rpc_xprt *xprt)
  1021. {
  1022. kref_put(&xprt->kref, xprt_destroy);
  1023. }
  1024. /**
  1025. * xprt_get - return a reference to an RPC transport.
  1026. * @xprt: pointer to the transport
  1027. *
  1028. */
  1029. struct rpc_xprt *xprt_get(struct rpc_xprt *xprt)
  1030. {
  1031. kref_get(&xprt->kref);
  1032. return xprt;
  1033. }