xprt.c 29 KB

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