sched.c 29 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136
  1. /*
  2. * linux/net/sunrpc/sched.c
  3. *
  4. * Scheduling for synchronous and asynchronous RPC requests.
  5. *
  6. * Copyright (C) 1996 Olaf Kirch, <okir@monad.swb.de>
  7. *
  8. * TCP NFS related read + write fixes
  9. * (C) 1999 Dave Airlie, University of Limerick, Ireland <airlied@linux.ie>
  10. */
  11. #include <linux/module.h>
  12. #include <linux/sched.h>
  13. #include <linux/interrupt.h>
  14. #include <linux/slab.h>
  15. #include <linux/mempool.h>
  16. #include <linux/smp.h>
  17. #include <linux/spinlock.h>
  18. #include <linux/mutex.h>
  19. #include <linux/freezer.h>
  20. #include <linux/sunrpc/clnt.h>
  21. #include "sunrpc.h"
  22. #if IS_ENABLED(CONFIG_SUNRPC_DEBUG)
  23. #define RPCDBG_FACILITY RPCDBG_SCHED
  24. #endif
  25. #define CREATE_TRACE_POINTS
  26. #include <trace/events/sunrpc.h>
  27. /*
  28. * RPC slabs and memory pools
  29. */
  30. #define RPC_BUFFER_MAXSIZE (2048)
  31. #define RPC_BUFFER_POOLSIZE (8)
  32. #define RPC_TASK_POOLSIZE (8)
  33. static struct kmem_cache *rpc_task_slabp __read_mostly;
  34. static struct kmem_cache *rpc_buffer_slabp __read_mostly;
  35. static mempool_t *rpc_task_mempool __read_mostly;
  36. static mempool_t *rpc_buffer_mempool __read_mostly;
  37. static void rpc_async_schedule(struct work_struct *);
  38. static void rpc_release_task(struct rpc_task *task);
  39. static void __rpc_queue_timer_fn(unsigned long ptr);
  40. /*
  41. * RPC tasks sit here while waiting for conditions to improve.
  42. */
  43. static struct rpc_wait_queue delay_queue;
  44. /*
  45. * rpciod-related stuff
  46. */
  47. struct workqueue_struct *rpciod_workqueue;
  48. /*
  49. * Disable the timer for a given RPC task. Should be called with
  50. * queue->lock and bh_disabled in order to avoid races within
  51. * rpc_run_timer().
  52. */
  53. static void
  54. __rpc_disable_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
  55. {
  56. if (task->tk_timeout == 0)
  57. return;
  58. dprintk("RPC: %5u disabling timer\n", task->tk_pid);
  59. task->tk_timeout = 0;
  60. list_del(&task->u.tk_wait.timer_list);
  61. if (list_empty(&queue->timer_list.list))
  62. del_timer(&queue->timer_list.timer);
  63. }
  64. static void
  65. rpc_set_queue_timer(struct rpc_wait_queue *queue, unsigned long expires)
  66. {
  67. queue->timer_list.expires = expires;
  68. mod_timer(&queue->timer_list.timer, expires);
  69. }
  70. /*
  71. * Set up a timer for the current task.
  72. */
  73. static void
  74. __rpc_add_timer(struct rpc_wait_queue *queue, struct rpc_task *task)
  75. {
  76. if (!task->tk_timeout)
  77. return;
  78. dprintk("RPC: %5u setting alarm for %u ms\n",
  79. task->tk_pid, jiffies_to_msecs(task->tk_timeout));
  80. task->u.tk_wait.expires = jiffies + task->tk_timeout;
  81. if (list_empty(&queue->timer_list.list) || time_before(task->u.tk_wait.expires, queue->timer_list.expires))
  82. rpc_set_queue_timer(queue, task->u.tk_wait.expires);
  83. list_add(&task->u.tk_wait.timer_list, &queue->timer_list.list);
  84. }
  85. static void rpc_rotate_queue_owner(struct rpc_wait_queue *queue)
  86. {
  87. struct list_head *q = &queue->tasks[queue->priority];
  88. struct rpc_task *task;
  89. if (!list_empty(q)) {
  90. task = list_first_entry(q, struct rpc_task, u.tk_wait.list);
  91. if (task->tk_owner == queue->owner)
  92. list_move_tail(&task->u.tk_wait.list, q);
  93. }
  94. }
  95. static void rpc_set_waitqueue_priority(struct rpc_wait_queue *queue, int priority)
  96. {
  97. if (queue->priority != priority) {
  98. /* Fairness: rotate the list when changing priority */
  99. rpc_rotate_queue_owner(queue);
  100. queue->priority = priority;
  101. }
  102. }
  103. static void rpc_set_waitqueue_owner(struct rpc_wait_queue *queue, pid_t pid)
  104. {
  105. queue->owner = pid;
  106. queue->nr = RPC_BATCH_COUNT;
  107. }
  108. static void rpc_reset_waitqueue_priority(struct rpc_wait_queue *queue)
  109. {
  110. rpc_set_waitqueue_priority(queue, queue->maxpriority);
  111. rpc_set_waitqueue_owner(queue, 0);
  112. }
  113. /*
  114. * Add new request to a priority queue.
  115. */
  116. static void __rpc_add_wait_queue_priority(struct rpc_wait_queue *queue,
  117. struct rpc_task *task,
  118. unsigned char queue_priority)
  119. {
  120. struct list_head *q;
  121. struct rpc_task *t;
  122. INIT_LIST_HEAD(&task->u.tk_wait.links);
  123. if (unlikely(queue_priority > queue->maxpriority))
  124. queue_priority = queue->maxpriority;
  125. if (queue_priority > queue->priority)
  126. rpc_set_waitqueue_priority(queue, queue_priority);
  127. q = &queue->tasks[queue_priority];
  128. list_for_each_entry(t, q, u.tk_wait.list) {
  129. if (t->tk_owner == task->tk_owner) {
  130. list_add_tail(&task->u.tk_wait.list, &t->u.tk_wait.links);
  131. return;
  132. }
  133. }
  134. list_add_tail(&task->u.tk_wait.list, q);
  135. }
  136. /*
  137. * Add new request to wait queue.
  138. *
  139. * Swapper tasks always get inserted at the head of the queue.
  140. * This should avoid many nasty memory deadlocks and hopefully
  141. * improve overall performance.
  142. * Everyone else gets appended to the queue to ensure proper FIFO behavior.
  143. */
  144. static void __rpc_add_wait_queue(struct rpc_wait_queue *queue,
  145. struct rpc_task *task,
  146. unsigned char queue_priority)
  147. {
  148. WARN_ON_ONCE(RPC_IS_QUEUED(task));
  149. if (RPC_IS_QUEUED(task))
  150. return;
  151. if (RPC_IS_PRIORITY(queue))
  152. __rpc_add_wait_queue_priority(queue, task, queue_priority);
  153. else if (RPC_IS_SWAPPER(task))
  154. list_add(&task->u.tk_wait.list, &queue->tasks[0]);
  155. else
  156. list_add_tail(&task->u.tk_wait.list, &queue->tasks[0]);
  157. task->tk_waitqueue = queue;
  158. queue->qlen++;
  159. /* barrier matches the read in rpc_wake_up_task_queue_locked() */
  160. smp_wmb();
  161. rpc_set_queued(task);
  162. dprintk("RPC: %5u added to queue %p \"%s\"\n",
  163. task->tk_pid, queue, rpc_qname(queue));
  164. }
  165. /*
  166. * Remove request from a priority queue.
  167. */
  168. static void __rpc_remove_wait_queue_priority(struct rpc_task *task)
  169. {
  170. struct rpc_task *t;
  171. if (!list_empty(&task->u.tk_wait.links)) {
  172. t = list_entry(task->u.tk_wait.links.next, struct rpc_task, u.tk_wait.list);
  173. list_move(&t->u.tk_wait.list, &task->u.tk_wait.list);
  174. list_splice_init(&task->u.tk_wait.links, &t->u.tk_wait.links);
  175. }
  176. }
  177. /*
  178. * Remove request from queue.
  179. * Note: must be called with spin lock held.
  180. */
  181. static void __rpc_remove_wait_queue(struct rpc_wait_queue *queue, struct rpc_task *task)
  182. {
  183. __rpc_disable_timer(queue, task);
  184. if (RPC_IS_PRIORITY(queue))
  185. __rpc_remove_wait_queue_priority(task);
  186. list_del(&task->u.tk_wait.list);
  187. queue->qlen--;
  188. dprintk("RPC: %5u removed from queue %p \"%s\"\n",
  189. task->tk_pid, queue, rpc_qname(queue));
  190. }
  191. static void __rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname, unsigned char nr_queues)
  192. {
  193. int i;
  194. spin_lock_init(&queue->lock);
  195. for (i = 0; i < ARRAY_SIZE(queue->tasks); i++)
  196. INIT_LIST_HEAD(&queue->tasks[i]);
  197. queue->maxpriority = nr_queues - 1;
  198. rpc_reset_waitqueue_priority(queue);
  199. queue->qlen = 0;
  200. setup_timer(&queue->timer_list.timer, __rpc_queue_timer_fn, (unsigned long)queue);
  201. INIT_LIST_HEAD(&queue->timer_list.list);
  202. rpc_assign_waitqueue_name(queue, qname);
  203. }
  204. void rpc_init_priority_wait_queue(struct rpc_wait_queue *queue, const char *qname)
  205. {
  206. __rpc_init_priority_wait_queue(queue, qname, RPC_NR_PRIORITY);
  207. }
  208. EXPORT_SYMBOL_GPL(rpc_init_priority_wait_queue);
  209. void rpc_init_wait_queue(struct rpc_wait_queue *queue, const char *qname)
  210. {
  211. __rpc_init_priority_wait_queue(queue, qname, 1);
  212. }
  213. EXPORT_SYMBOL_GPL(rpc_init_wait_queue);
  214. void rpc_destroy_wait_queue(struct rpc_wait_queue *queue)
  215. {
  216. del_timer_sync(&queue->timer_list.timer);
  217. }
  218. EXPORT_SYMBOL_GPL(rpc_destroy_wait_queue);
  219. static int rpc_wait_bit_killable(struct wait_bit_key *key, int mode)
  220. {
  221. freezable_schedule_unsafe();
  222. if (signal_pending_state(mode, current))
  223. return -ERESTARTSYS;
  224. return 0;
  225. }
  226. #if IS_ENABLED(CONFIG_SUNRPC_DEBUG) || IS_ENABLED(CONFIG_TRACEPOINTS)
  227. static void rpc_task_set_debuginfo(struct rpc_task *task)
  228. {
  229. static atomic_t rpc_pid;
  230. task->tk_pid = atomic_inc_return(&rpc_pid);
  231. }
  232. #else
  233. static inline void rpc_task_set_debuginfo(struct rpc_task *task)
  234. {
  235. }
  236. #endif
  237. static void rpc_set_active(struct rpc_task *task)
  238. {
  239. rpc_task_set_debuginfo(task);
  240. set_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
  241. trace_rpc_task_begin(task->tk_client, task, NULL);
  242. }
  243. /*
  244. * Mark an RPC call as having completed by clearing the 'active' bit
  245. * and then waking up all tasks that were sleeping.
  246. */
  247. static int rpc_complete_task(struct rpc_task *task)
  248. {
  249. void *m = &task->tk_runstate;
  250. wait_queue_head_t *wq = bit_waitqueue(m, RPC_TASK_ACTIVE);
  251. struct wait_bit_key k = __WAIT_BIT_KEY_INITIALIZER(m, RPC_TASK_ACTIVE);
  252. unsigned long flags;
  253. int ret;
  254. trace_rpc_task_complete(task->tk_client, task, NULL);
  255. spin_lock_irqsave(&wq->lock, flags);
  256. clear_bit(RPC_TASK_ACTIVE, &task->tk_runstate);
  257. ret = atomic_dec_and_test(&task->tk_count);
  258. if (waitqueue_active(wq))
  259. __wake_up_locked_key(wq, TASK_NORMAL, &k);
  260. spin_unlock_irqrestore(&wq->lock, flags);
  261. return ret;
  262. }
  263. /*
  264. * Allow callers to wait for completion of an RPC call
  265. *
  266. * Note the use of out_of_line_wait_on_bit() rather than wait_on_bit()
  267. * to enforce taking of the wq->lock and hence avoid races with
  268. * rpc_complete_task().
  269. */
  270. int __rpc_wait_for_completion_task(struct rpc_task *task, wait_bit_action_f *action)
  271. {
  272. if (action == NULL)
  273. action = rpc_wait_bit_killable;
  274. return out_of_line_wait_on_bit(&task->tk_runstate, RPC_TASK_ACTIVE,
  275. action, TASK_KILLABLE);
  276. }
  277. EXPORT_SYMBOL_GPL(__rpc_wait_for_completion_task);
  278. /*
  279. * Make an RPC task runnable.
  280. *
  281. * Note: If the task is ASYNC, and is being made runnable after sitting on an
  282. * rpc_wait_queue, this must be called with the queue spinlock held to protect
  283. * the wait queue operation.
  284. * Note the ordering of rpc_test_and_set_running() and rpc_clear_queued(),
  285. * which is needed to ensure that __rpc_execute() doesn't loop (due to the
  286. * lockless RPC_IS_QUEUED() test) before we've had a chance to test
  287. * the RPC_TASK_RUNNING flag.
  288. */
  289. static void rpc_make_runnable(struct rpc_task *task)
  290. {
  291. bool need_wakeup = !rpc_test_and_set_running(task);
  292. rpc_clear_queued(task);
  293. if (!need_wakeup)
  294. return;
  295. if (RPC_IS_ASYNC(task)) {
  296. INIT_WORK(&task->u.tk_work, rpc_async_schedule);
  297. queue_work(rpciod_workqueue, &task->u.tk_work);
  298. } else
  299. wake_up_bit(&task->tk_runstate, RPC_TASK_QUEUED);
  300. }
  301. /*
  302. * Prepare for sleeping on a wait queue.
  303. * By always appending tasks to the list we ensure FIFO behavior.
  304. * NB: An RPC task will only receive interrupt-driven events as long
  305. * as it's on a wait queue.
  306. */
  307. static void __rpc_sleep_on_priority(struct rpc_wait_queue *q,
  308. struct rpc_task *task,
  309. rpc_action action,
  310. unsigned char queue_priority)
  311. {
  312. dprintk("RPC: %5u sleep_on(queue \"%s\" time %lu)\n",
  313. task->tk_pid, rpc_qname(q), jiffies);
  314. trace_rpc_task_sleep(task->tk_client, task, q);
  315. __rpc_add_wait_queue(q, task, queue_priority);
  316. WARN_ON_ONCE(task->tk_callback != NULL);
  317. task->tk_callback = action;
  318. __rpc_add_timer(q, task);
  319. }
  320. void rpc_sleep_on(struct rpc_wait_queue *q, struct rpc_task *task,
  321. rpc_action action)
  322. {
  323. /* We shouldn't ever put an inactive task to sleep */
  324. WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
  325. if (!RPC_IS_ACTIVATED(task)) {
  326. task->tk_status = -EIO;
  327. rpc_put_task_async(task);
  328. return;
  329. }
  330. /*
  331. * Protect the queue operations.
  332. */
  333. spin_lock_bh(&q->lock);
  334. __rpc_sleep_on_priority(q, task, action, task->tk_priority);
  335. spin_unlock_bh(&q->lock);
  336. }
  337. EXPORT_SYMBOL_GPL(rpc_sleep_on);
  338. void rpc_sleep_on_priority(struct rpc_wait_queue *q, struct rpc_task *task,
  339. rpc_action action, int priority)
  340. {
  341. /* We shouldn't ever put an inactive task to sleep */
  342. WARN_ON_ONCE(!RPC_IS_ACTIVATED(task));
  343. if (!RPC_IS_ACTIVATED(task)) {
  344. task->tk_status = -EIO;
  345. rpc_put_task_async(task);
  346. return;
  347. }
  348. /*
  349. * Protect the queue operations.
  350. */
  351. spin_lock_bh(&q->lock);
  352. __rpc_sleep_on_priority(q, task, action, priority - RPC_PRIORITY_LOW);
  353. spin_unlock_bh(&q->lock);
  354. }
  355. EXPORT_SYMBOL_GPL(rpc_sleep_on_priority);
  356. /**
  357. * __rpc_do_wake_up_task - wake up a single rpc_task
  358. * @queue: wait queue
  359. * @task: task to be woken up
  360. *
  361. * Caller must hold queue->lock, and have cleared the task queued flag.
  362. */
  363. static void __rpc_do_wake_up_task(struct rpc_wait_queue *queue, struct rpc_task *task)
  364. {
  365. dprintk("RPC: %5u __rpc_wake_up_task (now %lu)\n",
  366. task->tk_pid, jiffies);
  367. /* Has the task been executed yet? If not, we cannot wake it up! */
  368. if (!RPC_IS_ACTIVATED(task)) {
  369. printk(KERN_ERR "RPC: Inactive task (%p) being woken up!\n", task);
  370. return;
  371. }
  372. trace_rpc_task_wakeup(task->tk_client, task, queue);
  373. __rpc_remove_wait_queue(queue, task);
  374. rpc_make_runnable(task);
  375. dprintk("RPC: __rpc_wake_up_task done\n");
  376. }
  377. /*
  378. * Wake up a queued task while the queue lock is being held
  379. */
  380. static void rpc_wake_up_task_queue_locked(struct rpc_wait_queue *queue, struct rpc_task *task)
  381. {
  382. if (RPC_IS_QUEUED(task)) {
  383. smp_rmb();
  384. if (task->tk_waitqueue == queue)
  385. __rpc_do_wake_up_task(queue, task);
  386. }
  387. }
  388. /*
  389. * Wake up a task on a specific queue
  390. */
  391. void rpc_wake_up_queued_task(struct rpc_wait_queue *queue, struct rpc_task *task)
  392. {
  393. spin_lock_bh(&queue->lock);
  394. rpc_wake_up_task_queue_locked(queue, task);
  395. spin_unlock_bh(&queue->lock);
  396. }
  397. EXPORT_SYMBOL_GPL(rpc_wake_up_queued_task);
  398. /*
  399. * Wake up the next task on a priority queue.
  400. */
  401. static struct rpc_task *__rpc_find_next_queued_priority(struct rpc_wait_queue *queue)
  402. {
  403. struct list_head *q;
  404. struct rpc_task *task;
  405. /*
  406. * Service a batch of tasks from a single owner.
  407. */
  408. q = &queue->tasks[queue->priority];
  409. if (!list_empty(q)) {
  410. task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
  411. if (queue->owner == task->tk_owner) {
  412. if (--queue->nr)
  413. goto out;
  414. list_move_tail(&task->u.tk_wait.list, q);
  415. }
  416. /*
  417. * Check if we need to switch queues.
  418. */
  419. goto new_owner;
  420. }
  421. /*
  422. * Service the next queue.
  423. */
  424. do {
  425. if (q == &queue->tasks[0])
  426. q = &queue->tasks[queue->maxpriority];
  427. else
  428. q = q - 1;
  429. if (!list_empty(q)) {
  430. task = list_entry(q->next, struct rpc_task, u.tk_wait.list);
  431. goto new_queue;
  432. }
  433. } while (q != &queue->tasks[queue->priority]);
  434. rpc_reset_waitqueue_priority(queue);
  435. return NULL;
  436. new_queue:
  437. rpc_set_waitqueue_priority(queue, (unsigned int)(q - &queue->tasks[0]));
  438. new_owner:
  439. rpc_set_waitqueue_owner(queue, task->tk_owner);
  440. out:
  441. return task;
  442. }
  443. static struct rpc_task *__rpc_find_next_queued(struct rpc_wait_queue *queue)
  444. {
  445. if (RPC_IS_PRIORITY(queue))
  446. return __rpc_find_next_queued_priority(queue);
  447. if (!list_empty(&queue->tasks[0]))
  448. return list_first_entry(&queue->tasks[0], struct rpc_task, u.tk_wait.list);
  449. return NULL;
  450. }
  451. /*
  452. * Wake up the first task on the wait queue.
  453. */
  454. struct rpc_task *rpc_wake_up_first(struct rpc_wait_queue *queue,
  455. bool (*func)(struct rpc_task *, void *), void *data)
  456. {
  457. struct rpc_task *task = NULL;
  458. dprintk("RPC: wake_up_first(%p \"%s\")\n",
  459. queue, rpc_qname(queue));
  460. spin_lock_bh(&queue->lock);
  461. task = __rpc_find_next_queued(queue);
  462. if (task != NULL) {
  463. if (func(task, data))
  464. rpc_wake_up_task_queue_locked(queue, task);
  465. else
  466. task = NULL;
  467. }
  468. spin_unlock_bh(&queue->lock);
  469. return task;
  470. }
  471. EXPORT_SYMBOL_GPL(rpc_wake_up_first);
  472. static bool rpc_wake_up_next_func(struct rpc_task *task, void *data)
  473. {
  474. return true;
  475. }
  476. /*
  477. * Wake up the next task on the wait queue.
  478. */
  479. struct rpc_task *rpc_wake_up_next(struct rpc_wait_queue *queue)
  480. {
  481. return rpc_wake_up_first(queue, rpc_wake_up_next_func, NULL);
  482. }
  483. EXPORT_SYMBOL_GPL(rpc_wake_up_next);
  484. /**
  485. * rpc_wake_up - wake up all rpc_tasks
  486. * @queue: rpc_wait_queue on which the tasks are sleeping
  487. *
  488. * Grabs queue->lock
  489. */
  490. void rpc_wake_up(struct rpc_wait_queue *queue)
  491. {
  492. struct list_head *head;
  493. spin_lock_bh(&queue->lock);
  494. head = &queue->tasks[queue->maxpriority];
  495. for (;;) {
  496. while (!list_empty(head)) {
  497. struct rpc_task *task;
  498. task = list_first_entry(head,
  499. struct rpc_task,
  500. u.tk_wait.list);
  501. rpc_wake_up_task_queue_locked(queue, task);
  502. }
  503. if (head == &queue->tasks[0])
  504. break;
  505. head--;
  506. }
  507. spin_unlock_bh(&queue->lock);
  508. }
  509. EXPORT_SYMBOL_GPL(rpc_wake_up);
  510. /**
  511. * rpc_wake_up_status - wake up all rpc_tasks and set their status value.
  512. * @queue: rpc_wait_queue on which the tasks are sleeping
  513. * @status: status value to set
  514. *
  515. * Grabs queue->lock
  516. */
  517. void rpc_wake_up_status(struct rpc_wait_queue *queue, int status)
  518. {
  519. struct list_head *head;
  520. spin_lock_bh(&queue->lock);
  521. head = &queue->tasks[queue->maxpriority];
  522. for (;;) {
  523. while (!list_empty(head)) {
  524. struct rpc_task *task;
  525. task = list_first_entry(head,
  526. struct rpc_task,
  527. u.tk_wait.list);
  528. task->tk_status = status;
  529. rpc_wake_up_task_queue_locked(queue, task);
  530. }
  531. if (head == &queue->tasks[0])
  532. break;
  533. head--;
  534. }
  535. spin_unlock_bh(&queue->lock);
  536. }
  537. EXPORT_SYMBOL_GPL(rpc_wake_up_status);
  538. static void __rpc_queue_timer_fn(unsigned long ptr)
  539. {
  540. struct rpc_wait_queue *queue = (struct rpc_wait_queue *)ptr;
  541. struct rpc_task *task, *n;
  542. unsigned long expires, now, timeo;
  543. spin_lock(&queue->lock);
  544. expires = now = jiffies;
  545. list_for_each_entry_safe(task, n, &queue->timer_list.list, u.tk_wait.timer_list) {
  546. timeo = task->u.tk_wait.expires;
  547. if (time_after_eq(now, timeo)) {
  548. dprintk("RPC: %5u timeout\n", task->tk_pid);
  549. task->tk_status = -ETIMEDOUT;
  550. rpc_wake_up_task_queue_locked(queue, task);
  551. continue;
  552. }
  553. if (expires == now || time_after(expires, timeo))
  554. expires = timeo;
  555. }
  556. if (!list_empty(&queue->timer_list.list))
  557. rpc_set_queue_timer(queue, expires);
  558. spin_unlock(&queue->lock);
  559. }
  560. static void __rpc_atrun(struct rpc_task *task)
  561. {
  562. if (task->tk_status == -ETIMEDOUT)
  563. task->tk_status = 0;
  564. }
  565. /*
  566. * Run a task at a later time
  567. */
  568. void rpc_delay(struct rpc_task *task, unsigned long delay)
  569. {
  570. task->tk_timeout = delay;
  571. rpc_sleep_on(&delay_queue, task, __rpc_atrun);
  572. }
  573. EXPORT_SYMBOL_GPL(rpc_delay);
  574. /*
  575. * Helper to call task->tk_ops->rpc_call_prepare
  576. */
  577. void rpc_prepare_task(struct rpc_task *task)
  578. {
  579. task->tk_ops->rpc_call_prepare(task, task->tk_calldata);
  580. }
  581. static void
  582. rpc_init_task_statistics(struct rpc_task *task)
  583. {
  584. /* Initialize retry counters */
  585. task->tk_garb_retry = 2;
  586. task->tk_cred_retry = 2;
  587. task->tk_rebind_retry = 2;
  588. /* starting timestamp */
  589. task->tk_start = ktime_get();
  590. }
  591. static void
  592. rpc_reset_task_statistics(struct rpc_task *task)
  593. {
  594. task->tk_timeouts = 0;
  595. task->tk_flags &= ~(RPC_CALL_MAJORSEEN|RPC_TASK_KILLED|RPC_TASK_SENT);
  596. rpc_init_task_statistics(task);
  597. }
  598. /*
  599. * Helper that calls task->tk_ops->rpc_call_done if it exists
  600. */
  601. void rpc_exit_task(struct rpc_task *task)
  602. {
  603. task->tk_action = NULL;
  604. if (task->tk_ops->rpc_call_done != NULL) {
  605. task->tk_ops->rpc_call_done(task, task->tk_calldata);
  606. if (task->tk_action != NULL) {
  607. WARN_ON(RPC_ASSASSINATED(task));
  608. /* Always release the RPC slot and buffer memory */
  609. xprt_release(task);
  610. rpc_reset_task_statistics(task);
  611. }
  612. }
  613. }
  614. void rpc_exit(struct rpc_task *task, int status)
  615. {
  616. task->tk_status = status;
  617. task->tk_action = rpc_exit_task;
  618. if (RPC_IS_QUEUED(task))
  619. rpc_wake_up_queued_task(task->tk_waitqueue, task);
  620. }
  621. EXPORT_SYMBOL_GPL(rpc_exit);
  622. void rpc_release_calldata(const struct rpc_call_ops *ops, void *calldata)
  623. {
  624. if (ops->rpc_release != NULL)
  625. ops->rpc_release(calldata);
  626. }
  627. /*
  628. * This is the RPC `scheduler' (or rather, the finite state machine).
  629. */
  630. static void __rpc_execute(struct rpc_task *task)
  631. {
  632. struct rpc_wait_queue *queue;
  633. int task_is_async = RPC_IS_ASYNC(task);
  634. int status = 0;
  635. dprintk("RPC: %5u __rpc_execute flags=0x%x\n",
  636. task->tk_pid, task->tk_flags);
  637. WARN_ON_ONCE(RPC_IS_QUEUED(task));
  638. if (RPC_IS_QUEUED(task))
  639. return;
  640. for (;;) {
  641. void (*do_action)(struct rpc_task *);
  642. /*
  643. * Execute any pending callback first.
  644. */
  645. do_action = task->tk_callback;
  646. task->tk_callback = NULL;
  647. if (do_action == NULL) {
  648. /*
  649. * Perform the next FSM step.
  650. * tk_action may be NULL if the task has been killed.
  651. * In particular, note that rpc_killall_tasks may
  652. * do this at any time, so beware when dereferencing.
  653. */
  654. do_action = task->tk_action;
  655. if (do_action == NULL)
  656. break;
  657. }
  658. trace_rpc_task_run_action(task->tk_client, task, task->tk_action);
  659. do_action(task);
  660. /*
  661. * Lockless check for whether task is sleeping or not.
  662. */
  663. if (!RPC_IS_QUEUED(task))
  664. continue;
  665. /*
  666. * The queue->lock protects against races with
  667. * rpc_make_runnable().
  668. *
  669. * Note that once we clear RPC_TASK_RUNNING on an asynchronous
  670. * rpc_task, rpc_make_runnable() can assign it to a
  671. * different workqueue. We therefore cannot assume that the
  672. * rpc_task pointer may still be dereferenced.
  673. */
  674. queue = task->tk_waitqueue;
  675. spin_lock_bh(&queue->lock);
  676. if (!RPC_IS_QUEUED(task)) {
  677. spin_unlock_bh(&queue->lock);
  678. continue;
  679. }
  680. rpc_clear_running(task);
  681. spin_unlock_bh(&queue->lock);
  682. if (task_is_async)
  683. return;
  684. /* sync task: sleep here */
  685. dprintk("RPC: %5u sync task going to sleep\n", task->tk_pid);
  686. status = out_of_line_wait_on_bit(&task->tk_runstate,
  687. RPC_TASK_QUEUED, rpc_wait_bit_killable,
  688. TASK_KILLABLE);
  689. if (status == -ERESTARTSYS) {
  690. /*
  691. * When a sync task receives a signal, it exits with
  692. * -ERESTARTSYS. In order to catch any callbacks that
  693. * clean up after sleeping on some queue, we don't
  694. * break the loop here, but go around once more.
  695. */
  696. dprintk("RPC: %5u got signal\n", task->tk_pid);
  697. task->tk_flags |= RPC_TASK_KILLED;
  698. rpc_exit(task, -ERESTARTSYS);
  699. }
  700. dprintk("RPC: %5u sync task resuming\n", task->tk_pid);
  701. }
  702. dprintk("RPC: %5u return %d, status %d\n", task->tk_pid, status,
  703. task->tk_status);
  704. /* Release all resources associated with the task */
  705. rpc_release_task(task);
  706. }
  707. /*
  708. * User-visible entry point to the scheduler.
  709. *
  710. * This may be called recursively if e.g. an async NFS task updates
  711. * the attributes and finds that dirty pages must be flushed.
  712. * NOTE: Upon exit of this function the task is guaranteed to be
  713. * released. In particular note that tk_release() will have
  714. * been called, so your task memory may have been freed.
  715. */
  716. void rpc_execute(struct rpc_task *task)
  717. {
  718. bool is_async = RPC_IS_ASYNC(task);
  719. rpc_set_active(task);
  720. rpc_make_runnable(task);
  721. if (!is_async)
  722. __rpc_execute(task);
  723. }
  724. static void rpc_async_schedule(struct work_struct *work)
  725. {
  726. __rpc_execute(container_of(work, struct rpc_task, u.tk_work));
  727. }
  728. /**
  729. * rpc_malloc - allocate an RPC buffer
  730. * @task: RPC task that will use this buffer
  731. * @size: requested byte size
  732. *
  733. * To prevent rpciod from hanging, this allocator never sleeps,
  734. * returning NULL and suppressing warning if the request cannot be serviced
  735. * immediately.
  736. * The caller can arrange to sleep in a way that is safe for rpciod.
  737. *
  738. * Most requests are 'small' (under 2KiB) and can be serviced from a
  739. * mempool, ensuring that NFS reads and writes can always proceed,
  740. * and that there is good locality of reference for these buffers.
  741. *
  742. * In order to avoid memory starvation triggering more writebacks of
  743. * NFS requests, we avoid using GFP_KERNEL.
  744. */
  745. void *rpc_malloc(struct rpc_task *task, size_t size)
  746. {
  747. struct rpc_buffer *buf;
  748. gfp_t gfp = GFP_NOIO | __GFP_NOWARN;
  749. if (RPC_IS_SWAPPER(task))
  750. gfp = __GFP_MEMALLOC | GFP_NOWAIT | __GFP_NOWARN;
  751. size += sizeof(struct rpc_buffer);
  752. if (size <= RPC_BUFFER_MAXSIZE)
  753. buf = mempool_alloc(rpc_buffer_mempool, gfp);
  754. else
  755. buf = kmalloc(size, gfp);
  756. if (!buf)
  757. return NULL;
  758. buf->len = size;
  759. dprintk("RPC: %5u allocated buffer of size %zu at %p\n",
  760. task->tk_pid, size, buf);
  761. return &buf->data;
  762. }
  763. EXPORT_SYMBOL_GPL(rpc_malloc);
  764. /**
  765. * rpc_free - free buffer allocated via rpc_malloc
  766. * @buffer: buffer to free
  767. *
  768. */
  769. void rpc_free(void *buffer)
  770. {
  771. size_t size;
  772. struct rpc_buffer *buf;
  773. if (!buffer)
  774. return;
  775. buf = container_of(buffer, struct rpc_buffer, data);
  776. size = buf->len;
  777. dprintk("RPC: freeing buffer of size %zu at %p\n",
  778. size, buf);
  779. if (size <= RPC_BUFFER_MAXSIZE)
  780. mempool_free(buf, rpc_buffer_mempool);
  781. else
  782. kfree(buf);
  783. }
  784. EXPORT_SYMBOL_GPL(rpc_free);
  785. /*
  786. * Creation and deletion of RPC task structures
  787. */
  788. static void rpc_init_task(struct rpc_task *task, const struct rpc_task_setup *task_setup_data)
  789. {
  790. memset(task, 0, sizeof(*task));
  791. atomic_set(&task->tk_count, 1);
  792. task->tk_flags = task_setup_data->flags;
  793. task->tk_ops = task_setup_data->callback_ops;
  794. task->tk_calldata = task_setup_data->callback_data;
  795. INIT_LIST_HEAD(&task->tk_task);
  796. task->tk_priority = task_setup_data->priority - RPC_PRIORITY_LOW;
  797. task->tk_owner = current->tgid;
  798. /* Initialize workqueue for async tasks */
  799. task->tk_workqueue = task_setup_data->workqueue;
  800. if (task->tk_ops->rpc_call_prepare != NULL)
  801. task->tk_action = rpc_prepare_task;
  802. rpc_init_task_statistics(task);
  803. dprintk("RPC: new task initialized, procpid %u\n",
  804. task_pid_nr(current));
  805. }
  806. static struct rpc_task *
  807. rpc_alloc_task(void)
  808. {
  809. return (struct rpc_task *)mempool_alloc(rpc_task_mempool, GFP_NOIO);
  810. }
  811. /*
  812. * Create a new task for the specified client.
  813. */
  814. struct rpc_task *rpc_new_task(const struct rpc_task_setup *setup_data)
  815. {
  816. struct rpc_task *task = setup_data->task;
  817. unsigned short flags = 0;
  818. if (task == NULL) {
  819. task = rpc_alloc_task();
  820. if (task == NULL) {
  821. rpc_release_calldata(setup_data->callback_ops,
  822. setup_data->callback_data);
  823. return ERR_PTR(-ENOMEM);
  824. }
  825. flags = RPC_TASK_DYNAMIC;
  826. }
  827. rpc_init_task(task, setup_data);
  828. task->tk_flags |= flags;
  829. dprintk("RPC: allocated task %p\n", task);
  830. return task;
  831. }
  832. /*
  833. * rpc_free_task - release rpc task and perform cleanups
  834. *
  835. * Note that we free up the rpc_task _after_ rpc_release_calldata()
  836. * in order to work around a workqueue dependency issue.
  837. *
  838. * Tejun Heo states:
  839. * "Workqueue currently considers two work items to be the same if they're
  840. * on the same address and won't execute them concurrently - ie. it
  841. * makes a work item which is queued again while being executed wait
  842. * for the previous execution to complete.
  843. *
  844. * If a work function frees the work item, and then waits for an event
  845. * which should be performed by another work item and *that* work item
  846. * recycles the freed work item, it can create a false dependency loop.
  847. * There really is no reliable way to detect this short of verifying
  848. * every memory free."
  849. *
  850. */
  851. static void rpc_free_task(struct rpc_task *task)
  852. {
  853. unsigned short tk_flags = task->tk_flags;
  854. rpc_release_calldata(task->tk_ops, task->tk_calldata);
  855. if (tk_flags & RPC_TASK_DYNAMIC) {
  856. dprintk("RPC: %5u freeing task\n", task->tk_pid);
  857. mempool_free(task, rpc_task_mempool);
  858. }
  859. }
  860. static void rpc_async_release(struct work_struct *work)
  861. {
  862. rpc_free_task(container_of(work, struct rpc_task, u.tk_work));
  863. }
  864. static void rpc_release_resources_task(struct rpc_task *task)
  865. {
  866. xprt_release(task);
  867. if (task->tk_msg.rpc_cred) {
  868. put_rpccred(task->tk_msg.rpc_cred);
  869. task->tk_msg.rpc_cred = NULL;
  870. }
  871. rpc_task_release_client(task);
  872. }
  873. static void rpc_final_put_task(struct rpc_task *task,
  874. struct workqueue_struct *q)
  875. {
  876. if (q != NULL) {
  877. INIT_WORK(&task->u.tk_work, rpc_async_release);
  878. queue_work(q, &task->u.tk_work);
  879. } else
  880. rpc_free_task(task);
  881. }
  882. static void rpc_do_put_task(struct rpc_task *task, struct workqueue_struct *q)
  883. {
  884. if (atomic_dec_and_test(&task->tk_count)) {
  885. rpc_release_resources_task(task);
  886. rpc_final_put_task(task, q);
  887. }
  888. }
  889. void rpc_put_task(struct rpc_task *task)
  890. {
  891. rpc_do_put_task(task, NULL);
  892. }
  893. EXPORT_SYMBOL_GPL(rpc_put_task);
  894. void rpc_put_task_async(struct rpc_task *task)
  895. {
  896. rpc_do_put_task(task, task->tk_workqueue);
  897. }
  898. EXPORT_SYMBOL_GPL(rpc_put_task_async);
  899. static void rpc_release_task(struct rpc_task *task)
  900. {
  901. dprintk("RPC: %5u release task\n", task->tk_pid);
  902. WARN_ON_ONCE(RPC_IS_QUEUED(task));
  903. rpc_release_resources_task(task);
  904. /*
  905. * Note: at this point we have been removed from rpc_clnt->cl_tasks,
  906. * so it should be safe to use task->tk_count as a test for whether
  907. * or not any other processes still hold references to our rpc_task.
  908. */
  909. if (atomic_read(&task->tk_count) != 1 + !RPC_IS_ASYNC(task)) {
  910. /* Wake up anyone who may be waiting for task completion */
  911. if (!rpc_complete_task(task))
  912. return;
  913. } else {
  914. if (!atomic_dec_and_test(&task->tk_count))
  915. return;
  916. }
  917. rpc_final_put_task(task, task->tk_workqueue);
  918. }
  919. int rpciod_up(void)
  920. {
  921. return try_module_get(THIS_MODULE) ? 0 : -EINVAL;
  922. }
  923. void rpciod_down(void)
  924. {
  925. module_put(THIS_MODULE);
  926. }
  927. /*
  928. * Start up the rpciod workqueue.
  929. */
  930. static int rpciod_start(void)
  931. {
  932. struct workqueue_struct *wq;
  933. /*
  934. * Create the rpciod thread and wait for it to start.
  935. */
  936. dprintk("RPC: creating workqueue rpciod\n");
  937. /* Note: highpri because network receive is latency sensitive */
  938. wq = alloc_workqueue("rpciod", WQ_MEM_RECLAIM | WQ_HIGHPRI, 0);
  939. rpciod_workqueue = wq;
  940. return rpciod_workqueue != NULL;
  941. }
  942. static void rpciod_stop(void)
  943. {
  944. struct workqueue_struct *wq = NULL;
  945. if (rpciod_workqueue == NULL)
  946. return;
  947. dprintk("RPC: destroying workqueue rpciod\n");
  948. wq = rpciod_workqueue;
  949. rpciod_workqueue = NULL;
  950. destroy_workqueue(wq);
  951. }
  952. void
  953. rpc_destroy_mempool(void)
  954. {
  955. rpciod_stop();
  956. mempool_destroy(rpc_buffer_mempool);
  957. mempool_destroy(rpc_task_mempool);
  958. kmem_cache_destroy(rpc_task_slabp);
  959. kmem_cache_destroy(rpc_buffer_slabp);
  960. rpc_destroy_wait_queue(&delay_queue);
  961. }
  962. int
  963. rpc_init_mempool(void)
  964. {
  965. /*
  966. * The following is not strictly a mempool initialisation,
  967. * but there is no harm in doing it here
  968. */
  969. rpc_init_wait_queue(&delay_queue, "delayq");
  970. if (!rpciod_start())
  971. goto err_nomem;
  972. rpc_task_slabp = kmem_cache_create("rpc_tasks",
  973. sizeof(struct rpc_task),
  974. 0, SLAB_HWCACHE_ALIGN,
  975. NULL);
  976. if (!rpc_task_slabp)
  977. goto err_nomem;
  978. rpc_buffer_slabp = kmem_cache_create("rpc_buffers",
  979. RPC_BUFFER_MAXSIZE,
  980. 0, SLAB_HWCACHE_ALIGN,
  981. NULL);
  982. if (!rpc_buffer_slabp)
  983. goto err_nomem;
  984. rpc_task_mempool = mempool_create_slab_pool(RPC_TASK_POOLSIZE,
  985. rpc_task_slabp);
  986. if (!rpc_task_mempool)
  987. goto err_nomem;
  988. rpc_buffer_mempool = mempool_create_slab_pool(RPC_BUFFER_POOLSIZE,
  989. rpc_buffer_slabp);
  990. if (!rpc_buffer_mempool)
  991. goto err_nomem;
  992. return 0;
  993. err_nomem:
  994. rpc_destroy_mempool();
  995. return -ENOMEM;
  996. }