svclock.c 24 KB

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