svclock.c 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910
  1. /*
  2. * linux/fs/lockd/svclock.c
  3. *
  4. * Handling of server-side locks, mostly of the blocked variety.
  5. * This is the ugliest part of lockd because we tread on very thin ice.
  6. * GRANT and CANCEL calls may get stuck, meet in mid-flight, etc.
  7. * IMNSHO introducing the grant callback into the NLM protocol was one
  8. * of the worst ideas Sun ever had. Except maybe for the idea of doing
  9. * NFS file locking at all.
  10. *
  11. * I'm trying hard to avoid race conditions by protecting most accesses
  12. * to a file's list of blocked locks through a semaphore. The global
  13. * list of blocked locks is not protected in this fashion however.
  14. * Therefore, some functions (such as the RPC callback for the async grant
  15. * call) move blocked locks towards the head of the list *while some other
  16. * process might be traversing it*. This should not be a problem in
  17. * practice, because this will only cause functions traversing the list
  18. * to visit some blocks twice.
  19. *
  20. * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
  21. */
  22. #include <linux/types.h>
  23. #include <linux/errno.h>
  24. #include <linux/kernel.h>
  25. #include <linux/sched.h>
  26. #include <linux/smp_lock.h>
  27. #include <linux/sunrpc/clnt.h>
  28. #include <linux/sunrpc/svc.h>
  29. #include <linux/lockd/nlm.h>
  30. #include <linux/lockd/lockd.h>
  31. #include <linux/kthread.h>
  32. #define NLMDBG_FACILITY NLMDBG_SVCLOCK
  33. #ifdef CONFIG_LOCKD_V4
  34. #define nlm_deadlock nlm4_deadlock
  35. #else
  36. #define nlm_deadlock nlm_lck_denied
  37. #endif
  38. static void nlmsvc_release_block(struct nlm_block *block);
  39. static void nlmsvc_insert_block(struct nlm_block *block, unsigned long);
  40. static void nlmsvc_remove_block(struct nlm_block *block);
  41. static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock);
  42. static void nlmsvc_freegrantargs(struct nlm_rqst *call);
  43. static const struct rpc_call_ops nlmsvc_grant_ops;
  44. /*
  45. * The list of blocked locks to retry
  46. */
  47. static LIST_HEAD(nlm_blocked);
  48. /*
  49. * Insert a blocked lock into the global list
  50. */
  51. static void
  52. nlmsvc_insert_block(struct nlm_block *block, unsigned long when)
  53. {
  54. struct nlm_block *b;
  55. struct list_head *pos;
  56. dprintk("lockd: nlmsvc_insert_block(%p, %ld)\n", block, when);
  57. if (list_empty(&block->b_list)) {
  58. kref_get(&block->b_count);
  59. } else {
  60. list_del_init(&block->b_list);
  61. }
  62. pos = &nlm_blocked;
  63. if (when != NLM_NEVER) {
  64. if ((when += jiffies) == NLM_NEVER)
  65. when ++;
  66. list_for_each(pos, &nlm_blocked) {
  67. b = list_entry(pos, struct nlm_block, b_list);
  68. if (time_after(b->b_when,when) || b->b_when == NLM_NEVER)
  69. break;
  70. }
  71. /* On normal exit from the loop, pos == &nlm_blocked,
  72. * so we will be adding to the end of the list - good
  73. */
  74. }
  75. list_add_tail(&block->b_list, pos);
  76. block->b_when = when;
  77. }
  78. /*
  79. * Remove a block from the global list
  80. */
  81. static inline void
  82. nlmsvc_remove_block(struct nlm_block *block)
  83. {
  84. if (!list_empty(&block->b_list)) {
  85. list_del_init(&block->b_list);
  86. nlmsvc_release_block(block);
  87. }
  88. }
  89. /*
  90. * Find a block for a given lock
  91. */
  92. static struct nlm_block *
  93. nlmsvc_lookup_block(struct nlm_file *file, struct nlm_lock *lock)
  94. {
  95. struct nlm_block *block;
  96. struct file_lock *fl;
  97. dprintk("lockd: nlmsvc_lookup_block f=%p pd=%d %Ld-%Ld ty=%d\n",
  98. file, lock->fl.fl_pid,
  99. (long long)lock->fl.fl_start,
  100. (long long)lock->fl.fl_end, lock->fl.fl_type);
  101. list_for_each_entry(block, &nlm_blocked, b_list) {
  102. fl = &block->b_call->a_args.lock.fl;
  103. dprintk("lockd: check f=%p pd=%d %Ld-%Ld ty=%d cookie=%s\n",
  104. block->b_file, fl->fl_pid,
  105. (long long)fl->fl_start,
  106. (long long)fl->fl_end, fl->fl_type,
  107. nlmdbg_cookie2a(&block->b_call->a_args.cookie));
  108. if (block->b_file == file && nlm_compare_locks(fl, &lock->fl)) {
  109. kref_get(&block->b_count);
  110. return block;
  111. }
  112. }
  113. return NULL;
  114. }
  115. static inline int nlm_cookie_match(struct nlm_cookie *a, struct nlm_cookie *b)
  116. {
  117. if (a->len != b->len)
  118. return 0;
  119. if (memcmp(a->data, b->data, a->len))
  120. return 0;
  121. return 1;
  122. }
  123. /*
  124. * Find a block with a given NLM cookie.
  125. */
  126. static inline struct nlm_block *
  127. nlmsvc_find_block(struct nlm_cookie *cookie)
  128. {
  129. struct nlm_block *block;
  130. list_for_each_entry(block, &nlm_blocked, b_list) {
  131. if (nlm_cookie_match(&block->b_call->a_args.cookie,cookie))
  132. goto found;
  133. }
  134. return NULL;
  135. found:
  136. dprintk("nlmsvc_find_block(%s): block=%p\n", nlmdbg_cookie2a(cookie), block);
  137. kref_get(&block->b_count);
  138. return block;
  139. }
  140. /*
  141. * Create a block and initialize it.
  142. *
  143. * Note: we explicitly set the cookie of the grant reply to that of
  144. * the blocked lock request. The spec explicitly mentions that the client
  145. * should _not_ rely on the callback containing the same cookie as the
  146. * request, but (as I found out later) that's because some implementations
  147. * do just this. Never mind the standards comittees, they support our
  148. * logging industries.
  149. *
  150. * 10 years later: I hope we can safely ignore these old and broken
  151. * clients by now. Let's fix this so we can uniquely identify an incoming
  152. * GRANTED_RES message by cookie, without having to rely on the client's IP
  153. * address. --okir
  154. */
  155. static struct nlm_block *
  156. nlmsvc_create_block(struct svc_rqst *rqstp, struct nlm_host *host,
  157. struct nlm_file *file, struct nlm_lock *lock,
  158. struct nlm_cookie *cookie)
  159. {
  160. struct nlm_block *block;
  161. struct nlm_rqst *call = NULL;
  162. nlm_get_host(host);
  163. call = nlm_alloc_call(host);
  164. if (call == NULL)
  165. return NULL;
  166. /* Allocate memory for block, and initialize arguments */
  167. block = kzalloc(sizeof(*block), GFP_KERNEL);
  168. if (block == NULL)
  169. goto failed;
  170. kref_init(&block->b_count);
  171. INIT_LIST_HEAD(&block->b_list);
  172. INIT_LIST_HEAD(&block->b_flist);
  173. if (!nlmsvc_setgrantargs(call, lock))
  174. goto failed_free;
  175. /* Set notifier function for VFS, and init args */
  176. call->a_args.lock.fl.fl_flags |= FL_SLEEP;
  177. call->a_args.lock.fl.fl_lmops = &nlmsvc_lock_operations;
  178. nlmclnt_next_cookie(&call->a_args.cookie);
  179. dprintk("lockd: created block %p...\n", block);
  180. /* Create and initialize the block */
  181. block->b_daemon = rqstp->rq_server;
  182. block->b_host = host;
  183. block->b_file = file;
  184. block->b_fl = NULL;
  185. file->f_count++;
  186. /* Add to file's list of blocks */
  187. list_add(&block->b_flist, &file->f_blocks);
  188. /* Set up RPC arguments for callback */
  189. block->b_call = call;
  190. call->a_flags = RPC_TASK_ASYNC;
  191. call->a_block = block;
  192. return block;
  193. failed_free:
  194. kfree(block);
  195. failed:
  196. nlm_release_call(call);
  197. return NULL;
  198. }
  199. /*
  200. * Delete a block.
  201. * It is the caller's responsibility to check whether the file
  202. * can be closed hereafter.
  203. */
  204. static int nlmsvc_unlink_block(struct nlm_block *block)
  205. {
  206. int status;
  207. dprintk("lockd: unlinking block %p...\n", block);
  208. /* Remove block from list */
  209. status = posix_unblock_lock(block->b_file->f_file, &block->b_call->a_args.lock.fl);
  210. nlmsvc_remove_block(block);
  211. return status;
  212. }
  213. static void nlmsvc_free_block(struct kref *kref)
  214. {
  215. struct nlm_block *block = container_of(kref, struct nlm_block, b_count);
  216. struct nlm_file *file = block->b_file;
  217. dprintk("lockd: freeing block %p...\n", block);
  218. /* Remove block from file's list of blocks */
  219. mutex_lock(&file->f_mutex);
  220. list_del_init(&block->b_flist);
  221. mutex_unlock(&file->f_mutex);
  222. nlmsvc_freegrantargs(block->b_call);
  223. nlm_release_call(block->b_call);
  224. nlm_release_file(block->b_file);
  225. kfree(block->b_fl);
  226. kfree(block);
  227. }
  228. static void nlmsvc_release_block(struct nlm_block *block)
  229. {
  230. if (block != NULL)
  231. kref_put(&block->b_count, nlmsvc_free_block);
  232. }
  233. /*
  234. * Loop over all blocks and delete blocks held by
  235. * a matching host.
  236. */
  237. void nlmsvc_traverse_blocks(struct nlm_host *host,
  238. struct nlm_file *file,
  239. nlm_host_match_fn_t match)
  240. {
  241. struct nlm_block *block, *next;
  242. restart:
  243. mutex_lock(&file->f_mutex);
  244. list_for_each_entry_safe(block, next, &file->f_blocks, b_flist) {
  245. if (!match(block->b_host, host))
  246. continue;
  247. /* Do not destroy blocks that are not on
  248. * the global retry list - why? */
  249. if (list_empty(&block->b_list))
  250. continue;
  251. kref_get(&block->b_count);
  252. mutex_unlock(&file->f_mutex);
  253. nlmsvc_unlink_block(block);
  254. nlmsvc_release_block(block);
  255. goto restart;
  256. }
  257. mutex_unlock(&file->f_mutex);
  258. }
  259. /*
  260. * Initialize arguments for GRANTED call. The nlm_rqst structure
  261. * has been cleared already.
  262. */
  263. static int nlmsvc_setgrantargs(struct nlm_rqst *call, struct nlm_lock *lock)
  264. {
  265. locks_copy_lock(&call->a_args.lock.fl, &lock->fl);
  266. memcpy(&call->a_args.lock.fh, &lock->fh, sizeof(call->a_args.lock.fh));
  267. call->a_args.lock.caller = utsname()->nodename;
  268. call->a_args.lock.oh.len = lock->oh.len;
  269. /* set default data area */
  270. call->a_args.lock.oh.data = call->a_owner;
  271. call->a_args.lock.svid = lock->fl.fl_pid;
  272. if (lock->oh.len > NLMCLNT_OHSIZE) {
  273. void *data = kmalloc(lock->oh.len, GFP_KERNEL);
  274. if (!data)
  275. return 0;
  276. call->a_args.lock.oh.data = (u8 *) data;
  277. }
  278. memcpy(call->a_args.lock.oh.data, lock->oh.data, lock->oh.len);
  279. return 1;
  280. }
  281. static void nlmsvc_freegrantargs(struct nlm_rqst *call)
  282. {
  283. if (call->a_args.lock.oh.data != call->a_owner)
  284. kfree(call->a_args.lock.oh.data);
  285. }
  286. /*
  287. * Deferred lock request handling for non-blocking lock
  288. */
  289. static __be32
  290. nlmsvc_defer_lock_rqst(struct svc_rqst *rqstp, struct nlm_block *block)
  291. {
  292. __be32 status = nlm_lck_denied_nolocks;
  293. block->b_flags |= B_QUEUED;
  294. nlmsvc_insert_block(block, NLM_TIMEOUT);
  295. block->b_cache_req = &rqstp->rq_chandle;
  296. if (rqstp->rq_chandle.defer) {
  297. block->b_deferred_req =
  298. rqstp->rq_chandle.defer(block->b_cache_req);
  299. if (block->b_deferred_req != NULL)
  300. status = nlm_drop_reply;
  301. }
  302. dprintk("lockd: nlmsvc_defer_lock_rqst block %p flags %d status %d\n",
  303. block, block->b_flags, ntohl(status));
  304. return status;
  305. }
  306. /*
  307. * Attempt to establish a lock, and if it can't be granted, block it
  308. * if required.
  309. */
  310. __be32
  311. nlmsvc_lock(struct svc_rqst *rqstp, struct nlm_file *file,
  312. struct nlm_host *host, struct nlm_lock *lock, int wait,
  313. struct nlm_cookie *cookie, int reclaim)
  314. {
  315. struct nlm_block *block = NULL;
  316. int error;
  317. __be32 ret;
  318. dprintk("lockd: nlmsvc_lock(%s/%ld, ty=%d, pi=%d, %Ld-%Ld, bl=%d)\n",
  319. file->f_file->f_path.dentry->d_inode->i_sb->s_id,
  320. file->f_file->f_path.dentry->d_inode->i_ino,
  321. lock->fl.fl_type, lock->fl.fl_pid,
  322. (long long)lock->fl.fl_start,
  323. (long long)lock->fl.fl_end,
  324. wait);
  325. /* Lock file against concurrent access */
  326. mutex_lock(&file->f_mutex);
  327. /* Get existing block (in case client is busy-waiting)
  328. * or create new block
  329. */
  330. block = nlmsvc_lookup_block(file, lock);
  331. if (block == NULL) {
  332. block = nlmsvc_create_block(rqstp, host, file, lock, cookie);
  333. ret = nlm_lck_denied_nolocks;
  334. if (block == NULL)
  335. goto out;
  336. lock = &block->b_call->a_args.lock;
  337. } else
  338. lock->fl.fl_flags &= ~FL_SLEEP;
  339. if (block->b_flags & B_QUEUED) {
  340. dprintk("lockd: nlmsvc_lock deferred block %p flags %d\n",
  341. block, block->b_flags);
  342. if (block->b_granted) {
  343. nlmsvc_unlink_block(block);
  344. ret = nlm_granted;
  345. goto out;
  346. }
  347. if (block->b_flags & B_TIMED_OUT) {
  348. nlmsvc_unlink_block(block);
  349. ret = nlm_lck_denied;
  350. goto out;
  351. }
  352. ret = nlm_drop_reply;
  353. goto out;
  354. }
  355. if (locks_in_grace() && !reclaim) {
  356. ret = nlm_lck_denied_grace_period;
  357. goto out;
  358. }
  359. if (!wait)
  360. lock->fl.fl_flags &= ~FL_SLEEP;
  361. error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
  362. lock->fl.fl_flags &= ~FL_SLEEP;
  363. dprintk("lockd: vfs_lock_file returned %d\n", error);
  364. switch (error) {
  365. case 0:
  366. ret = nlm_granted;
  367. goto out;
  368. case -EAGAIN:
  369. ret = nlm_lck_denied;
  370. goto out;
  371. case FILE_LOCK_DEFERRED:
  372. if (wait)
  373. break;
  374. /* Filesystem lock operation is in progress
  375. Add it to the queue waiting for callback */
  376. ret = nlmsvc_defer_lock_rqst(rqstp, block);
  377. goto out;
  378. case -EDEADLK:
  379. ret = nlm_deadlock;
  380. goto out;
  381. default: /* includes ENOLCK */
  382. ret = nlm_lck_denied_nolocks;
  383. goto out;
  384. }
  385. ret = nlm_lck_blocked;
  386. /* Append to list of blocked */
  387. nlmsvc_insert_block(block, NLM_NEVER);
  388. out:
  389. mutex_unlock(&file->f_mutex);
  390. nlmsvc_release_block(block);
  391. dprintk("lockd: nlmsvc_lock returned %u\n", ret);
  392. return ret;
  393. }
  394. /*
  395. * Test for presence of a conflicting lock.
  396. */
  397. __be32
  398. nlmsvc_testlock(struct svc_rqst *rqstp, struct nlm_file *file,
  399. struct nlm_host *host, struct nlm_lock *lock,
  400. struct nlm_lock *conflock, struct nlm_cookie *cookie)
  401. {
  402. struct nlm_block *block = NULL;
  403. int error;
  404. __be32 ret;
  405. dprintk("lockd: nlmsvc_testlock(%s/%ld, ty=%d, %Ld-%Ld)\n",
  406. file->f_file->f_path.dentry->d_inode->i_sb->s_id,
  407. file->f_file->f_path.dentry->d_inode->i_ino,
  408. lock->fl.fl_type,
  409. (long long)lock->fl.fl_start,
  410. (long long)lock->fl.fl_end);
  411. /* Get existing block (in case client is busy-waiting) */
  412. block = nlmsvc_lookup_block(file, lock);
  413. if (block == NULL) {
  414. struct file_lock *conf = kzalloc(sizeof(*conf), GFP_KERNEL);
  415. if (conf == NULL)
  416. return nlm_granted;
  417. block = nlmsvc_create_block(rqstp, host, file, lock, cookie);
  418. if (block == NULL) {
  419. kfree(conf);
  420. return nlm_granted;
  421. }
  422. block->b_fl = conf;
  423. }
  424. if (block->b_flags & B_QUEUED) {
  425. dprintk("lockd: nlmsvc_testlock deferred block %p flags %d fl %p\n",
  426. block, block->b_flags, block->b_fl);
  427. if (block->b_flags & B_TIMED_OUT) {
  428. nlmsvc_unlink_block(block);
  429. ret = nlm_lck_denied;
  430. goto out;
  431. }
  432. if (block->b_flags & B_GOT_CALLBACK) {
  433. nlmsvc_unlink_block(block);
  434. if (block->b_fl != NULL
  435. && block->b_fl->fl_type != F_UNLCK) {
  436. lock->fl = *block->b_fl;
  437. goto conf_lock;
  438. } else {
  439. ret = nlm_granted;
  440. goto out;
  441. }
  442. }
  443. ret = nlm_drop_reply;
  444. goto out;
  445. }
  446. if (locks_in_grace()) {
  447. ret = nlm_lck_denied_grace_period;
  448. goto out;
  449. }
  450. error = vfs_test_lock(file->f_file, &lock->fl);
  451. if (error == FILE_LOCK_DEFERRED) {
  452. ret = nlmsvc_defer_lock_rqst(rqstp, block);
  453. goto out;
  454. }
  455. if (error) {
  456. ret = nlm_lck_denied_nolocks;
  457. goto out;
  458. }
  459. if (lock->fl.fl_type == F_UNLCK) {
  460. ret = nlm_granted;
  461. goto out;
  462. }
  463. conf_lock:
  464. dprintk("lockd: conflicting lock(ty=%d, %Ld-%Ld)\n",
  465. lock->fl.fl_type, (long long)lock->fl.fl_start,
  466. (long long)lock->fl.fl_end);
  467. conflock->caller = "somehost"; /* FIXME */
  468. conflock->len = strlen(conflock->caller);
  469. conflock->oh.len = 0; /* don't return OH info */
  470. conflock->svid = lock->fl.fl_pid;
  471. conflock->fl.fl_type = lock->fl.fl_type;
  472. conflock->fl.fl_start = lock->fl.fl_start;
  473. conflock->fl.fl_end = lock->fl.fl_end;
  474. ret = nlm_lck_denied;
  475. out:
  476. if (block)
  477. nlmsvc_release_block(block);
  478. return ret;
  479. }
  480. /*
  481. * Remove a lock.
  482. * This implies a CANCEL call: We send a GRANT_MSG, the client replies
  483. * with a GRANT_RES call which gets lost, and calls UNLOCK immediately
  484. * afterwards. In this case the block will still be there, and hence
  485. * must be removed.
  486. */
  487. __be32
  488. nlmsvc_unlock(struct nlm_file *file, struct nlm_lock *lock)
  489. {
  490. int error;
  491. dprintk("lockd: nlmsvc_unlock(%s/%ld, pi=%d, %Ld-%Ld)\n",
  492. file->f_file->f_path.dentry->d_inode->i_sb->s_id,
  493. file->f_file->f_path.dentry->d_inode->i_ino,
  494. lock->fl.fl_pid,
  495. (long long)lock->fl.fl_start,
  496. (long long)lock->fl.fl_end);
  497. /* First, cancel any lock that might be there */
  498. nlmsvc_cancel_blocked(file, lock);
  499. lock->fl.fl_type = F_UNLCK;
  500. error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
  501. return (error < 0)? nlm_lck_denied_nolocks : nlm_granted;
  502. }
  503. /*
  504. * Cancel a previously blocked request.
  505. *
  506. * A cancel request always overrides any grant that may currently
  507. * be in progress.
  508. * The calling procedure must check whether the file can be closed.
  509. */
  510. __be32
  511. nlmsvc_cancel_blocked(struct nlm_file *file, struct nlm_lock *lock)
  512. {
  513. struct nlm_block *block;
  514. int status = 0;
  515. dprintk("lockd: nlmsvc_cancel(%s/%ld, pi=%d, %Ld-%Ld)\n",
  516. file->f_file->f_path.dentry->d_inode->i_sb->s_id,
  517. file->f_file->f_path.dentry->d_inode->i_ino,
  518. lock->fl.fl_pid,
  519. (long long)lock->fl.fl_start,
  520. (long long)lock->fl.fl_end);
  521. if (locks_in_grace())
  522. return nlm_lck_denied_grace_period;
  523. mutex_lock(&file->f_mutex);
  524. block = nlmsvc_lookup_block(file, lock);
  525. mutex_unlock(&file->f_mutex);
  526. if (block != NULL) {
  527. vfs_cancel_lock(block->b_file->f_file,
  528. &block->b_call->a_args.lock.fl);
  529. status = nlmsvc_unlink_block(block);
  530. nlmsvc_release_block(block);
  531. }
  532. return status ? nlm_lck_denied : nlm_granted;
  533. }
  534. /*
  535. * This is a callback from the filesystem for VFS file lock requests.
  536. * It will be used if fl_grant is defined and the filesystem can not
  537. * respond to the request immediately.
  538. * For GETLK request it will copy the reply to the nlm_block.
  539. * For SETLK or SETLKW request it will get the local posix lock.
  540. * In all cases it will move the block to the head of nlm_blocked q where
  541. * nlmsvc_retry_blocked() can send back a reply for SETLKW or revisit the
  542. * deferred rpc for GETLK and SETLK.
  543. */
  544. static void
  545. nlmsvc_update_deferred_block(struct nlm_block *block, struct file_lock *conf,
  546. int result)
  547. {
  548. block->b_flags |= B_GOT_CALLBACK;
  549. if (result == 0)
  550. block->b_granted = 1;
  551. else
  552. block->b_flags |= B_TIMED_OUT;
  553. if (conf) {
  554. if (block->b_fl)
  555. __locks_copy_lock(block->b_fl, conf);
  556. }
  557. }
  558. static int nlmsvc_grant_deferred(struct file_lock *fl, struct file_lock *conf,
  559. int result)
  560. {
  561. struct nlm_block *block;
  562. int rc = -ENOENT;
  563. lock_kernel();
  564. list_for_each_entry(block, &nlm_blocked, b_list) {
  565. if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
  566. dprintk("lockd: nlmsvc_notify_blocked block %p flags %d\n",
  567. block, block->b_flags);
  568. if (block->b_flags & B_QUEUED) {
  569. if (block->b_flags & B_TIMED_OUT) {
  570. rc = -ENOLCK;
  571. break;
  572. }
  573. nlmsvc_update_deferred_block(block, conf, result);
  574. } else if (result == 0)
  575. block->b_granted = 1;
  576. nlmsvc_insert_block(block, 0);
  577. svc_wake_up(block->b_daemon);
  578. rc = 0;
  579. break;
  580. }
  581. }
  582. unlock_kernel();
  583. if (rc == -ENOENT)
  584. printk(KERN_WARNING "lockd: grant for unknown block\n");
  585. return rc;
  586. }
  587. /*
  588. * Unblock a blocked lock request. This is a callback invoked from the
  589. * VFS layer when a lock on which we blocked is removed.
  590. *
  591. * This function doesn't grant the blocked lock instantly, but rather moves
  592. * the block to the head of nlm_blocked where it can be picked up by lockd.
  593. */
  594. static void
  595. nlmsvc_notify_blocked(struct file_lock *fl)
  596. {
  597. struct nlm_block *block;
  598. dprintk("lockd: VFS unblock notification for block %p\n", fl);
  599. list_for_each_entry(block, &nlm_blocked, b_list) {
  600. if (nlm_compare_locks(&block->b_call->a_args.lock.fl, fl)) {
  601. nlmsvc_insert_block(block, 0);
  602. svc_wake_up(block->b_daemon);
  603. return;
  604. }
  605. }
  606. printk(KERN_WARNING "lockd: notification for unknown block!\n");
  607. }
  608. static int nlmsvc_same_owner(struct file_lock *fl1, struct file_lock *fl2)
  609. {
  610. return fl1->fl_owner == fl2->fl_owner && fl1->fl_pid == fl2->fl_pid;
  611. }
  612. struct lock_manager_operations nlmsvc_lock_operations = {
  613. .fl_compare_owner = nlmsvc_same_owner,
  614. .fl_notify = nlmsvc_notify_blocked,
  615. .fl_grant = nlmsvc_grant_deferred,
  616. };
  617. /*
  618. * Try to claim a lock that was previously blocked.
  619. *
  620. * Note that we use both the RPC_GRANTED_MSG call _and_ an async
  621. * RPC thread when notifying the client. This seems like overkill...
  622. * Here's why:
  623. * - we don't want to use a synchronous RPC thread, otherwise
  624. * we might find ourselves hanging on a dead portmapper.
  625. * - Some lockd implementations (e.g. HP) don't react to
  626. * RPC_GRANTED calls; they seem to insist on RPC_GRANTED_MSG calls.
  627. */
  628. static void
  629. nlmsvc_grant_blocked(struct nlm_block *block)
  630. {
  631. struct nlm_file *file = block->b_file;
  632. struct nlm_lock *lock = &block->b_call->a_args.lock;
  633. int error;
  634. dprintk("lockd: grant blocked lock %p\n", block);
  635. kref_get(&block->b_count);
  636. /* Unlink block request from list */
  637. nlmsvc_unlink_block(block);
  638. /* If b_granted is true this means we've been here before.
  639. * Just retry the grant callback, possibly refreshing the RPC
  640. * binding */
  641. if (block->b_granted) {
  642. nlm_rebind_host(block->b_host);
  643. goto callback;
  644. }
  645. /* Try the lock operation again */
  646. lock->fl.fl_flags |= FL_SLEEP;
  647. error = vfs_lock_file(file->f_file, F_SETLK, &lock->fl, NULL);
  648. lock->fl.fl_flags &= ~FL_SLEEP;
  649. switch (error) {
  650. case 0:
  651. break;
  652. case FILE_LOCK_DEFERRED:
  653. dprintk("lockd: lock still blocked error %d\n", error);
  654. nlmsvc_insert_block(block, NLM_NEVER);
  655. nlmsvc_release_block(block);
  656. return;
  657. default:
  658. printk(KERN_WARNING "lockd: unexpected error %d in %s!\n",
  659. -error, __func__);
  660. nlmsvc_insert_block(block, 10 * HZ);
  661. nlmsvc_release_block(block);
  662. return;
  663. }
  664. callback:
  665. /* Lock was granted by VFS. */
  666. dprintk("lockd: GRANTing blocked lock.\n");
  667. block->b_granted = 1;
  668. /* keep block on the list, but don't reattempt until the RPC
  669. * completes or the submission fails
  670. */
  671. nlmsvc_insert_block(block, NLM_NEVER);
  672. /* Call the client -- use a soft RPC task since nlmsvc_retry_blocked
  673. * will queue up a new one if this one times out
  674. */
  675. error = nlm_async_call(block->b_call, NLMPROC_GRANTED_MSG,
  676. &nlmsvc_grant_ops);
  677. /* RPC submission failed, wait a bit and retry */
  678. if (error < 0)
  679. nlmsvc_insert_block(block, 10 * HZ);
  680. }
  681. /*
  682. * This is the callback from the RPC layer when the NLM_GRANTED_MSG
  683. * RPC call has succeeded or timed out.
  684. * Like all RPC callbacks, it is invoked by the rpciod process, so it
  685. * better not sleep. Therefore, we put the blocked lock on the nlm_blocked
  686. * chain once more in order to have it removed by lockd itself (which can
  687. * then sleep on the file semaphore without disrupting e.g. the nfs client).
  688. */
  689. static void nlmsvc_grant_callback(struct rpc_task *task, void *data)
  690. {
  691. struct nlm_rqst *call = data;
  692. struct nlm_block *block = call->a_block;
  693. unsigned long timeout;
  694. dprintk("lockd: GRANT_MSG RPC callback\n");
  695. lock_kernel();
  696. /* if the block is not on a list at this point then it has
  697. * been invalidated. Don't try to requeue it.
  698. *
  699. * FIXME: it's possible that the block is removed from the list
  700. * after this check but before the nlmsvc_insert_block. In that
  701. * case it will be added back. Perhaps we need better locking
  702. * for nlm_blocked?
  703. */
  704. if (list_empty(&block->b_list))
  705. goto out;
  706. /* Technically, we should down the file semaphore here. Since we
  707. * move the block towards the head of the queue only, no harm
  708. * can be done, though. */
  709. if (task->tk_status < 0) {
  710. /* RPC error: Re-insert for retransmission */
  711. timeout = 10 * HZ;
  712. } else {
  713. /* Call was successful, now wait for client callback */
  714. timeout = 60 * HZ;
  715. }
  716. nlmsvc_insert_block(block, timeout);
  717. svc_wake_up(block->b_daemon);
  718. out:
  719. unlock_kernel();
  720. }
  721. static void nlmsvc_grant_release(void *data)
  722. {
  723. struct nlm_rqst *call = data;
  724. lock_kernel();
  725. nlmsvc_release_block(call->a_block);
  726. unlock_kernel();
  727. }
  728. static const struct rpc_call_ops nlmsvc_grant_ops = {
  729. .rpc_call_done = nlmsvc_grant_callback,
  730. .rpc_release = nlmsvc_grant_release,
  731. };
  732. /*
  733. * We received a GRANT_RES callback. Try to find the corresponding
  734. * block.
  735. */
  736. void
  737. nlmsvc_grant_reply(struct nlm_cookie *cookie, __be32 status)
  738. {
  739. struct nlm_block *block;
  740. dprintk("grant_reply: looking for cookie %x, s=%d \n",
  741. *(unsigned int *)(cookie->data), status);
  742. if (!(block = nlmsvc_find_block(cookie)))
  743. return;
  744. if (block) {
  745. if (status == nlm_lck_denied_grace_period) {
  746. /* Try again in a couple of seconds */
  747. nlmsvc_insert_block(block, 10 * HZ);
  748. } else {
  749. /* Lock is now held by client, or has been rejected.
  750. * In both cases, the block should be removed. */
  751. nlmsvc_unlink_block(block);
  752. }
  753. }
  754. nlmsvc_release_block(block);
  755. }
  756. /* Helper function to handle retry of a deferred block.
  757. * If it is a blocking lock, call grant_blocked.
  758. * For a non-blocking lock or test lock, revisit the request.
  759. */
  760. static void
  761. retry_deferred_block(struct nlm_block *block)
  762. {
  763. if (!(block->b_flags & B_GOT_CALLBACK))
  764. block->b_flags |= B_TIMED_OUT;
  765. nlmsvc_insert_block(block, NLM_TIMEOUT);
  766. dprintk("revisit block %p flags %d\n", block, block->b_flags);
  767. if (block->b_deferred_req) {
  768. block->b_deferred_req->revisit(block->b_deferred_req, 0);
  769. block->b_deferred_req = NULL;
  770. }
  771. }
  772. /*
  773. * Retry all blocked locks that have been notified. This is where lockd
  774. * picks up locks that can be granted, or grant notifications that must
  775. * be retransmitted.
  776. */
  777. unsigned long
  778. nlmsvc_retry_blocked(void)
  779. {
  780. unsigned long timeout = MAX_SCHEDULE_TIMEOUT;
  781. struct nlm_block *block;
  782. while (!list_empty(&nlm_blocked) && !kthread_should_stop()) {
  783. block = list_entry(nlm_blocked.next, struct nlm_block, b_list);
  784. if (block->b_when == NLM_NEVER)
  785. break;
  786. if (time_after(block->b_when, jiffies)) {
  787. timeout = block->b_when - jiffies;
  788. break;
  789. }
  790. dprintk("nlmsvc_retry_blocked(%p, when=%ld)\n",
  791. block, block->b_when);
  792. if (block->b_flags & B_QUEUED) {
  793. dprintk("nlmsvc_retry_blocked delete block (%p, granted=%d, flags=%d)\n",
  794. block, block->b_granted, block->b_flags);
  795. retry_deferred_block(block);
  796. } else
  797. nlmsvc_grant_blocked(block);
  798. }
  799. return timeout;
  800. }