fs/nfs/delegation.c

   1 /*
   2  * linux/fs/nfs/delegation.c
   3  *
   4  * Copyright (C) 2004 Trond Myklebust
   5  *
   6  * NFS file delegation management
   7  *
   8  */
   9 #include <linux/completion.h>
  10 #include <linux/kthread.h>
  11 #include <linux/module.h>
  12 #include <linux/sched.h>
  13 #include <linux/slab.h>
  14 #include <linux/spinlock.h>
  15
  16 #include <linux/nfs4.h>
  17 #include <linux/nfs_fs.h>
  18 #include <linux/nfs_xdr.h>
  19
  20 #include "nfs4_fs.h"
  21 #include "delegation.h"
  22 #include "internal.h"
  23 #include "nfs4trace.h"
  24
  25 static void nfs_free_delegation(struct nfs_delegation *delegation)
  26 {
  27         if (delegation->cred) {
  28                 put_rpccred(delegation->cred);
  29                 delegation->cred = NULL;
  30         }
  31         kfree_rcu(delegation, rcu);
  32 }
  33
  34 /**
  35  * nfs_mark_delegation_referenced - set delegation's REFERENCED flag
  36  * @delegation: delegation to process
  37  *
  38  */
  39 void nfs_mark_delegation_referenced(struct nfs_delegation *delegation)
  40 {
  41         set_bit(NFS_DELEGATION_REFERENCED, &delegation->flags);
  42 }
  43
  44 static bool
  45 nfs4_is_valid_delegation(const struct nfs_delegation *delegation,
  46                 fmode_t flags)
  47 {
  48         if (delegation != NULL && (delegation->type & flags) == flags &&
  49             !test_bit(NFS_DELEGATION_REVOKED, &delegation->flags) &&
  50             !test_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
  51                 return true;
  52         return false;
  53 }
  54
  55 static int
  56 nfs4_do_check_delegation(struct inode *inode, fmode_t flags, bool mark)
  57 {
  58         struct nfs_delegation *delegation;
  59         int ret = 0;
  60
  61         flags &= FMODE_READ|FMODE_WRITE;
  62         rcu_read_lock();
  63         delegation = rcu_dereference(NFS_I(inode)->delegation);
  64         if (nfs4_is_valid_delegation(delegation, flags)) {
  65                 if (mark)
  66                         nfs_mark_delegation_referenced(delegation);
  67                 ret = 1;
  68         }
  69         rcu_read_unlock();
  70         return ret;
  71 }
  72 /**
  73  * nfs_have_delegation - check if inode has a delegation, mark it
  74  * NFS_DELEGATION_REFERENCED if there is one.
  75  * @inode: inode to check
  76  * @flags: delegation types to check for
  77  *
  78  * Returns one if inode has the indicated delegation, otherwise zero.
  79  */
  80 int nfs4_have_delegation(struct inode *inode, fmode_t flags)
  81 {
  82         return nfs4_do_check_delegation(inode, flags, true);
  83 }
  84
  85 /*
  86  * nfs4_check_delegation - check if inode has a delegation, do not mark
  87  * NFS_DELEGATION_REFERENCED if it has one.
  88  */
  89 int nfs4_check_delegation(struct inode *inode, fmode_t flags)
  90 {
  91         return nfs4_do_check_delegation(inode, flags, false);
  92 }
  93
  94 static int nfs_delegation_claim_locks(struct nfs_open_context *ctx, struct nfs4_state *state, const nfs4_stateid *stateid)
  95 {
  96         struct inode *inode = state->inode;
  97         struct file_lock *fl;
  98         struct file_lock_context *flctx = inode->i_flctx;
  99         struct list_head *list;
 100         int status = 0;
 101
 102         if (flctx == NULL)
 103                 goto out;
 104
 105         list = &flctx->flc_posix;
 106         spin_lock(&flctx->flc_lock);
 107 restart:
 108         list_for_each_entry(fl, list, fl_list) {
 109                 if (nfs_file_open_context(fl->fl_file) != ctx)
 110                         continue;
 111                 spin_unlock(&flctx->flc_lock);
 112                 status = nfs4_lock_delegation_recall(fl, state, stateid);
 113                 if (status < 0)
 114                         goto out;
 115                 spin_lock(&flctx->flc_lock);
 116         }
 117         if (list == &flctx->flc_posix) {
 118                 list = &flctx->flc_flock;
 119                 goto restart;
 120         }
 121         spin_unlock(&flctx->flc_lock);
 122 out:
 123         return status;
 124 }
 125
 126 static int nfs_delegation_claim_opens(struct inode *inode,
 127                 const nfs4_stateid *stateid, fmode_t type)
 128 {
 129         struct nfs_inode *nfsi = NFS_I(inode);
 130         struct nfs_open_context *ctx;
 131         struct nfs4_state_owner *sp;
 132         struct nfs4_state *state;
 133         unsigned int seq;
 134         int err;
 135
 136 again:
 137         spin_lock(&inode->i_lock);
 138         list_for_each_entry(ctx, &nfsi->open_files, list) {
 139                 state = ctx->state;
 140                 if (state == NULL)
 141                         continue;
 142                 if (!test_bit(NFS_DELEGATED_STATE, &state->flags))
 143                         continue;
 144                 if (!nfs4_valid_open_stateid(state))
 145                         continue;
 146                 if (!nfs4_stateid_match(&state->stateid, stateid))
 147                         continue;
 148                 get_nfs_open_context(ctx);
 149                 spin_unlock(&inode->i_lock);
 150                 sp = state->owner;
 151                 /* Block nfs4_proc_unlck */
 152                 mutex_lock(&sp->so_delegreturn_mutex);
 153                 seq = raw_seqcount_begin(&sp->so_reclaim_seqcount);
 154                 err = nfs4_open_delegation_recall(ctx, state, stateid, type);
 155                 if (!err)
 156                         err = nfs_delegation_claim_locks(ctx, state, stateid);
 157                 if (!err && read_seqcount_retry(&sp->so_reclaim_seqcount, seq))
 158                         err = -EAGAIN;
 159                 mutex_unlock(&sp->so_delegreturn_mutex);
 160                 put_nfs_open_context(ctx);
 161                 if (err != 0)
 162                         return err;
 163                 goto again;
 164         }
 165         spin_unlock(&inode->i_lock);
 166         return 0;
 167 }
 168
 169 /**
 170  * nfs_inode_reclaim_delegation - process a delegation reclaim request
 171  * @inode: inode to process
 172  * @cred: credential to use for request
 173  * @res: new delegation state from server
 174  *
 175  */
 176 void nfs_inode_reclaim_delegation(struct inode *inode, struct rpc_cred *cred,
 177                                   struct nfs_openres *res)
 178 {
 179         struct nfs_delegation *delegation;
 180         struct rpc_cred *oldcred = NULL;
 181
 182         rcu_read_lock();
 183         delegation = rcu_dereference(NFS_I(inode)->delegation);
 184         if (delegation != NULL) {
 185                 spin_lock(&delegation->lock);
 186                 if (delegation->inode != NULL) {
 187                         nfs4_stateid_copy(&delegation->stateid, &res->delegation);
 188                         delegation->type = res->delegation_type;
 189                         delegation->pagemod_limit = res->pagemod_limit;
 190                         oldcred = delegation->cred;
 191                         delegation->cred = get_rpccred(cred);
 192                         clear_bit(NFS_DELEGATION_NEED_RECLAIM,
 193                                   &delegation->flags);
 194                         spin_unlock(&delegation->lock);
 195                         rcu_read_unlock();
 196                         put_rpccred(oldcred);
 197                         trace_nfs4_reclaim_delegation(inode, res->delegation_type);
 198                 } else {
 199                         /* We appear to have raced with a delegation return. */
 200                         spin_unlock(&delegation->lock);
 201                         rcu_read_unlock();
 202                         nfs_inode_set_delegation(inode, cred, res);
 203                 }
 204         } else {
 205                 rcu_read_unlock();
 206         }
 207 }
 208
 209 static int nfs_do_return_delegation(struct inode *inode, struct nfs_delegation *delegation, int issync)
 210 {
 211         int res = 0;
 212
 213         if (!test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
 214                 res = nfs4_proc_delegreturn(inode,
 215                                 delegation->cred,
 216                                 &delegation->stateid,
 217                                 issync);
 218         nfs_free_delegation(delegation);
 219         return res;
 220 }
 221
 222 static struct inode *nfs_delegation_grab_inode(struct nfs_delegation *delegation)
 223 {
 224         struct inode *inode = NULL;
 225
 226         spin_lock(&delegation->lock);
 227         if (delegation->inode != NULL)
 228                 inode = igrab(delegation->inode);
 229         spin_unlock(&delegation->lock);
 230         return inode;
 231 }
 232
 233 static struct nfs_delegation *
 234 nfs_start_delegation_return_locked(struct nfs_inode *nfsi)
 235 {
 236         struct nfs_delegation *ret = NULL;
 237         struct nfs_delegation *delegation = rcu_dereference(nfsi->delegation);
 238
 239         if (delegation == NULL)
 240                 goto out;
 241         spin_lock(&delegation->lock);
 242         if (!test_and_set_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
 243                 ret = delegation;
 244         spin_unlock(&delegation->lock);
 245 out:
 246         return ret;
 247 }
 248
 249 static struct nfs_delegation *
 250 nfs_start_delegation_return(struct nfs_inode *nfsi)
 251 {
 252         struct nfs_delegation *delegation;
 253
 254         rcu_read_lock();
 255         delegation = nfs_start_delegation_return_locked(nfsi);
 256         rcu_read_unlock();
 257         return delegation;
 258 }
 259
 260 static void
 261 nfs_abort_delegation_return(struct nfs_delegation *delegation,
 262                 struct nfs_client *clp)
 263 {
 264
 265         spin_lock(&delegation->lock);
 266         clear_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
 267         set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
 268         spin_unlock(&delegation->lock);
 269         set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
 270 }
 271
 272 static struct nfs_delegation *
 273 nfs_detach_delegation_locked(struct nfs_inode *nfsi,
 274                 struct nfs_delegation *delegation,
 275                 struct nfs_client *clp)
 276 {
 277         struct nfs_delegation *deleg_cur =
 278                 rcu_dereference_protected(nfsi->delegation,
 279                                 lockdep_is_held(&clp->cl_lock));
 280
 281         if (deleg_cur == NULL || delegation != deleg_cur)
 282                 return NULL;
 283
 284         spin_lock(&delegation->lock);
 285         set_bit(NFS_DELEGATION_RETURNING, &delegation->flags);
 286         list_del_rcu(&delegation->super_list);
 287         delegation->inode = NULL;
 288         rcu_assign_pointer(nfsi->delegation, NULL);
 289         spin_unlock(&delegation->lock);
 290         return delegation;
 291 }
 292
 293 static struct nfs_delegation *nfs_detach_delegation(struct nfs_inode *nfsi,
 294                 struct nfs_delegation *delegation,
 295                 struct nfs_server *server)
 296 {
 297         struct nfs_client *clp = server->nfs_client;
 298
 299         spin_lock(&clp->cl_lock);
 300         delegation = nfs_detach_delegation_locked(nfsi, delegation, clp);
 301         spin_unlock(&clp->cl_lock);
 302         return delegation;
 303 }
 304
 305 static struct nfs_delegation *
 306 nfs_inode_detach_delegation(struct inode *inode)
 307 {
 308         struct nfs_inode *nfsi = NFS_I(inode);
 309         struct nfs_server *server = NFS_SERVER(inode);
 310         struct nfs_delegation *delegation;
 311
 312         delegation = nfs_start_delegation_return(nfsi);
 313         if (delegation == NULL)
 314                 return NULL;
 315         return nfs_detach_delegation(nfsi, delegation, server);
 316 }
 317
 318 static void
 319 nfs_update_inplace_delegation(struct nfs_delegation *delegation,
 320                 const struct nfs_delegation *update)
 321 {
 322         if (nfs4_stateid_is_newer(&update->stateid, &delegation->stateid)) {
 323                 delegation->stateid.seqid = update->stateid.seqid;
 324                 smp_wmb();
 325                 delegation->type = update->type;
 326         }
 327 }
 328
 329 /**
 330  * nfs_inode_set_delegation - set up a delegation on an inode
 331  * @inode: inode to which delegation applies
 332  * @cred: cred to use for subsequent delegation processing
 333  * @res: new delegation state from server
 334  *
 335  * Returns zero on success, or a negative errno value.
 336  */
 337 int nfs_inode_set_delegation(struct inode *inode, struct rpc_cred *cred, struct nfs_openres *res)
 338 {
 339         struct nfs_server *server = NFS_SERVER(inode);
 340         struct nfs_client *clp = server->nfs_client;
 341         struct nfs_inode *nfsi = NFS_I(inode);
 342         struct nfs_delegation *delegation, *old_delegation;
 343         struct nfs_delegation *freeme = NULL;
 344         int status = 0;
 345
 346         delegation = kmalloc(sizeof(*delegation), GFP_NOFS);
 347         if (delegation == NULL)
 348                 return -ENOMEM;
 349         nfs4_stateid_copy(&delegation->stateid, &res->delegation);
 350         delegation->type = res->delegation_type;
 351         delegation->pagemod_limit = res->pagemod_limit;
 352         delegation->change_attr = inode->i_version;
 353         delegation->cred = get_rpccred(cred);
 354         delegation->inode = inode;
 355         delegation->flags = 1<<NFS_DELEGATION_REFERENCED;
 356         spin_lock_init(&delegation->lock);
 357
 358         spin_lock(&clp->cl_lock);
 359         old_delegation = rcu_dereference_protected(nfsi->delegation,
 360                                         lockdep_is_held(&clp->cl_lock));
 361         if (old_delegation != NULL) {
 362                 /* Is this an update of the existing delegation? */
 363                 if (nfs4_stateid_match_other(&old_delegation->stateid,
 364                                         &delegation->stateid)) {
 365                         nfs_update_inplace_delegation(old_delegation,
 366                                         delegation);
 367                         goto out;
 368                 }
 369                 /*
 370                  * Deal with broken servers that hand out two
 371                  * delegations for the same file.
 372                  * Allow for upgrades to a WRITE delegation, but
 373                  * nothing else.
 374                  */
 375                 dfprintk(FILE, "%s: server %s handed out "
 376                                 "a duplicate delegation!\n",
 377                                 __func__, clp->cl_hostname);
 378                 if (delegation->type == old_delegation->type ||
 379                     !(delegation->type & FMODE_WRITE)) {
 380                         freeme = delegation;
 381                         delegation = NULL;
 382                         goto out;
 383                 }
 384                 if (test_and_set_bit(NFS_DELEGATION_RETURNING,
 385                                         &old_delegation->flags))
 386                         goto out;
 387                 freeme = nfs_detach_delegation_locked(nfsi,
 388                                 old_delegation, clp);
 389                 if (freeme == NULL)
 390                         goto out;
 391         }
 392         list_add_tail_rcu(&delegation->super_list, &server->delegations);
 393         rcu_assign_pointer(nfsi->delegation, delegation);
 394         delegation = NULL;
 395
 396         /* Ensure we revalidate the attributes and page cache! */
 397         spin_lock(&inode->i_lock);
 398         nfsi->cache_validity |= NFS_INO_REVAL_FORCED;
 399         spin_unlock(&inode->i_lock);
 400         trace_nfs4_set_delegation(inode, res->delegation_type);
 401
 402 out:
 403         spin_unlock(&clp->cl_lock);
 404         if (delegation != NULL)
 405                 nfs_free_delegation(delegation);
 406         if (freeme != NULL)
 407                 nfs_do_return_delegation(inode, freeme, 0);
 408         return status;
 409 }
 410
 411 /*
 412  * Basic procedure for returning a delegation to the server
 413  */
 414 static int nfs_end_delegation_return(struct inode *inode, struct nfs_delegation *delegation, int issync)
 415 {
 416         struct nfs_client *clp = NFS_SERVER(inode)->nfs_client;
 417         struct nfs_inode *nfsi = NFS_I(inode);
 418         int err = 0;
 419
 420         if (delegation == NULL)
 421                 return 0;
 422         do {
 423                 if (test_bit(NFS_DELEGATION_REVOKED, &delegation->flags))
 424                         break;
 425                 err = nfs_delegation_claim_opens(inode, &delegation->stateid,
 426                                 delegation->type);
 427                 if (!issync || err != -EAGAIN)
 428                         break;
 429                 /*
 430                  * Guard against state recovery
 431                  */
 432                 err = nfs4_wait_clnt_recover(clp);
 433         } while (err == 0);
 434
 435         if (err) {
 436                 nfs_abort_delegation_return(delegation, clp);
 437                 goto out;
 438         }
 439         if (!nfs_detach_delegation(nfsi, delegation, NFS_SERVER(inode)))
 440                 goto out;
 441
 442         err = nfs_do_return_delegation(inode, delegation, issync);
 443 out:
 444         return err;
 445 }
 446
 447 static bool nfs_delegation_need_return(struct nfs_delegation *delegation)
 448 {
 449         bool ret = false;
 450
 451         if (test_bit(NFS_DELEGATION_RETURNING, &delegation->flags))
 452                 goto out;
 453         if (test_and_clear_bit(NFS_DELEGATION_RETURN, &delegation->flags))
 454                 ret = true;
 455         if (test_and_clear_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags) && !ret) {
 456                 struct inode *inode;
 457
 458                 spin_lock(&delegation->lock);
 459                 inode = delegation->inode;
 460                 if (inode && list_empty(&NFS_I(inode)->open_files))
 461                         ret = true;
 462                 spin_unlock(&delegation->lock);
 463         }
 464 out:
 465         return ret;
 466 }
 467
 468 /**
 469  * nfs_client_return_marked_delegations - return previously marked delegations
 470  * @clp: nfs_client to process
 471  *
 472  * Note that this function is designed to be called by the state
 473  * manager thread. For this reason, it cannot flush the dirty data,
 474  * since that could deadlock in case of a state recovery error.
 475  *
 476  * Returns zero on success, or a negative errno value.
 477  */
 478 int nfs_client_return_marked_delegations(struct nfs_client *clp)
 479 {
 480         struct nfs_delegation *delegation;
 481         struct nfs_server *server;
 482         struct inode *inode;
 483         int err = 0;
 484
 485 restart:
 486         rcu_read_lock();
 487         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
 488                 list_for_each_entry_rcu(delegation, &server->delegations,
 489                                                                 super_list) {
 490                         if (!nfs_delegation_need_return(delegation))
 491                                 continue;
 492                         if (!nfs_sb_active(server->super))
 493                                 continue;
 494                         inode = nfs_delegation_grab_inode(delegation);
 495                         if (inode == NULL) {
 496                                 rcu_read_unlock();
 497                                 nfs_sb_deactive(server->super);
 498                                 goto restart;
 499                         }
 500                         delegation = nfs_start_delegation_return_locked(NFS_I(inode));
 501                         rcu_read_unlock();
 502
 503                         err = nfs_end_delegation_return(inode, delegation, 0);
 504                         iput(inode);
 505                         nfs_sb_deactive(server->super);
 506                         if (!err)
 507                                 goto restart;
 508                         set_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state);
 509                         return err;
 510                 }
 511         }
 512         rcu_read_unlock();
 513         return 0;
 514 }
 515
 516 /**
 517  * nfs_inode_return_delegation_noreclaim - return delegation, don't reclaim opens
 518  * @inode: inode to process
 519  *
 520  * Does not protect against delegation reclaims, therefore really only safe
 521  * to be called from nfs4_clear_inode().
 522  */
 523 void nfs_inode_return_delegation_noreclaim(struct inode *inode)
 524 {
 525         struct nfs_delegation *delegation;
 526
 527         delegation = nfs_inode_detach_delegation(inode);
 528         if (delegation != NULL)
 529                 nfs_do_return_delegation(inode, delegation, 1);
 530 }
 531
 532 /**
 533  * nfs_inode_return_delegation - synchronously return a delegation
 534  * @inode: inode to process
 535  *
 536  * This routine will always flush any dirty data to disk on the
 537  * assumption that if we need to return the delegation, then
 538  * we should stop caching.
 539  *
 540  * Returns zero on success, or a negative errno value.
 541  */
 542 int nfs4_inode_return_delegation(struct inode *inode)
 543 {
 544         struct nfs_inode *nfsi = NFS_I(inode);
 545         struct nfs_delegation *delegation;
 546         int err = 0;
 547
 548         nfs_wb_all(inode);
 549         delegation = nfs_start_delegation_return(nfsi);
 550         if (delegation != NULL)
 551                 err = nfs_end_delegation_return(inode, delegation, 1);
 552         return err;
 553 }
 554
 555 static void nfs_mark_return_if_closed_delegation(struct nfs_server *server,
 556                 struct nfs_delegation *delegation)
 557 {
 558         set_bit(NFS_DELEGATION_RETURN_IF_CLOSED, &delegation->flags);
 559         set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
 560 }
 561
 562 static void nfs_mark_return_delegation(struct nfs_server *server,
 563                 struct nfs_delegation *delegation)
 564 {
 565         set_bit(NFS_DELEGATION_RETURN, &delegation->flags);
 566         set_bit(NFS4CLNT_DELEGRETURN, &server->nfs_client->cl_state);
 567 }
 568
 569 static bool nfs_server_mark_return_all_delegations(struct nfs_server *server)
 570 {
 571         struct nfs_delegation *delegation;
 572         bool ret = false;
 573
 574         list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
 575                 nfs_mark_return_delegation(server, delegation);
 576                 ret = true;
 577         }
 578         return ret;
 579 }
 580
 581 static void nfs_client_mark_return_all_delegations(struct nfs_client *clp)
 582 {
 583         struct nfs_server *server;
 584
 585         rcu_read_lock();
 586         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
 587                 nfs_server_mark_return_all_delegations(server);
 588         rcu_read_unlock();
 589 }
 590
 591 static void nfs_delegation_run_state_manager(struct nfs_client *clp)
 592 {
 593         if (test_bit(NFS4CLNT_DELEGRETURN, &clp->cl_state))
 594                 nfs4_schedule_state_manager(clp);
 595 }
 596
 597 /**
 598  * nfs_expire_all_delegations
 599  * @clp: client to process
 600  *
 601  */
 602 void nfs_expire_all_delegations(struct nfs_client *clp)
 603 {
 604         nfs_client_mark_return_all_delegations(clp);
 605         nfs_delegation_run_state_manager(clp);
 606 }
 607
 608 /**
 609  * nfs_super_return_all_delegations - return delegations for one superblock
 610  * @sb: sb to process
 611  *
 612  */
 613 void nfs_server_return_all_delegations(struct nfs_server *server)
 614 {
 615         struct nfs_client *clp = server->nfs_client;
 616         bool need_wait;
 617
 618         if (clp == NULL)
 619                 return;
 620
 621         rcu_read_lock();
 622         need_wait = nfs_server_mark_return_all_delegations(server);
 623         rcu_read_unlock();
 624
 625         if (need_wait) {
 626                 nfs4_schedule_state_manager(clp);
 627                 nfs4_wait_clnt_recover(clp);
 628         }
 629 }
 630
 631 static void nfs_mark_return_unused_delegation_types(struct nfs_server *server,
 632                                                  fmode_t flags)
 633 {
 634         struct nfs_delegation *delegation;
 635
 636         list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
 637                 if ((delegation->type == (FMODE_READ|FMODE_WRITE)) && !(flags & FMODE_WRITE))
 638                         continue;
 639                 if (delegation->type & flags)
 640                         nfs_mark_return_if_closed_delegation(server, delegation);
 641         }
 642 }
 643
 644 static void nfs_client_mark_return_unused_delegation_types(struct nfs_client *clp,
 645                                                         fmode_t flags)
 646 {
 647         struct nfs_server *server;
 648
 649         rcu_read_lock();
 650         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
 651                 nfs_mark_return_unused_delegation_types(server, flags);
 652         rcu_read_unlock();
 653 }
 654
 655 static void nfs_mark_delegation_revoked(struct nfs_server *server,
 656                 struct nfs_delegation *delegation)
 657 {
 658         set_bit(NFS_DELEGATION_REVOKED, &delegation->flags);
 659         delegation->stateid.type = NFS4_INVALID_STATEID_TYPE;
 660         nfs_mark_return_delegation(server, delegation);
 661 }
 662
 663 static bool nfs_revoke_delegation(struct inode *inode,
 664                 const nfs4_stateid *stateid)
 665 {
 666         struct nfs_delegation *delegation;
 667         bool ret = false;
 668
 669         rcu_read_lock();
 670         delegation = rcu_dereference(NFS_I(inode)->delegation);
 671         if (delegation == NULL)
 672                 goto out;
 673         if (stateid && !nfs4_stateid_match(stateid, &delegation->stateid))
 674                 goto out;
 675         nfs_mark_delegation_revoked(NFS_SERVER(inode), delegation);
 676         ret = true;
 677 out:
 678         rcu_read_unlock();
 679         return ret;
 680 }
 681
 682 void nfs_remove_bad_delegation(struct inode *inode,
 683                 const nfs4_stateid *stateid)
 684 {
 685         struct nfs_delegation *delegation;
 686
 687         if (!nfs_revoke_delegation(inode, stateid))
 688                 return;
 689         delegation = nfs_inode_detach_delegation(inode);
 690         if (delegation) {
 691                 nfs_inode_find_state_and_recover(inode, &delegation->stateid);
 692                 nfs_free_delegation(delegation);
 693         }
 694 }
 695 EXPORT_SYMBOL_GPL(nfs_remove_bad_delegation);
 696
 697 /**
 698  * nfs_expire_unused_delegation_types
 699  * @clp: client to process
 700  * @flags: delegation types to expire
 701  *
 702  */
 703 void nfs_expire_unused_delegation_types(struct nfs_client *clp, fmode_t flags)
 704 {
 705         nfs_client_mark_return_unused_delegation_types(clp, flags);
 706         nfs_delegation_run_state_manager(clp);
 707 }
 708
 709 static void nfs_mark_return_unreferenced_delegations(struct nfs_server *server)
 710 {
 711         struct nfs_delegation *delegation;
 712
 713         list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
 714                 if (test_and_clear_bit(NFS_DELEGATION_REFERENCED, &delegation->flags))
 715                         continue;
 716                 nfs_mark_return_if_closed_delegation(server, delegation);
 717         }
 718 }
 719
 720 /**
 721  * nfs_expire_unreferenced_delegations - Eliminate unused delegations
 722  * @clp: nfs_client to process
 723  *
 724  */
 725 void nfs_expire_unreferenced_delegations(struct nfs_client *clp)
 726 {
 727         struct nfs_server *server;
 728
 729         rcu_read_lock();
 730         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
 731                 nfs_mark_return_unreferenced_delegations(server);
 732         rcu_read_unlock();
 733
 734         nfs_delegation_run_state_manager(clp);
 735 }
 736
 737 /**
 738  * nfs_async_inode_return_delegation - asynchronously return a delegation
 739  * @inode: inode to process
 740  * @stateid: state ID information
 741  *
 742  * Returns zero on success, or a negative errno value.
 743  */
 744 int nfs_async_inode_return_delegation(struct inode *inode,
 745                                       const nfs4_stateid *stateid)
 746 {
 747         struct nfs_server *server = NFS_SERVER(inode);
 748         struct nfs_client *clp = server->nfs_client;
 749         struct nfs_delegation *delegation;
 750
 751         rcu_read_lock();
 752         delegation = rcu_dereference(NFS_I(inode)->delegation);
 753         if (delegation == NULL)
 754                 goto out_enoent;
 755         if (stateid != NULL &&
 756             !clp->cl_mvops->match_stateid(&delegation->stateid, stateid))
 757                 goto out_enoent;
 758         nfs_mark_return_delegation(server, delegation);
 759         rcu_read_unlock();
 760
 761         nfs_delegation_run_state_manager(clp);
 762         return 0;
 763 out_enoent:
 764         rcu_read_unlock();
 765         return -ENOENT;
 766 }
 767
 768 static struct inode *
 769 nfs_delegation_find_inode_server(struct nfs_server *server,
 770                                  const struct nfs_fh *fhandle)
 771 {
 772         struct nfs_delegation *delegation;
 773         struct inode *res = NULL;
 774
 775         list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
 776                 spin_lock(&delegation->lock);
 777                 if (delegation->inode != NULL &&
 778                     nfs_compare_fh(fhandle, &NFS_I(delegation->inode)->fh) == 0) {
 779                         res = igrab(delegation->inode);
 780                 }
 781                 spin_unlock(&delegation->lock);
 782                 if (res != NULL)
 783                         break;
 784         }
 785         return res;
 786 }
 787
 788 /**
 789  * nfs_delegation_find_inode - retrieve the inode associated with a delegation
 790  * @clp: client state handle
 791  * @fhandle: filehandle from a delegation recall
 792  *
 793  * Returns pointer to inode matching "fhandle," or NULL if a matching inode
 794  * cannot be found.
 795  */
 796 struct inode *nfs_delegation_find_inode(struct nfs_client *clp,
 797                                         const struct nfs_fh *fhandle)
 798 {
 799         struct nfs_server *server;
 800         struct inode *res = NULL;
 801
 802         rcu_read_lock();
 803         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
 804                 res = nfs_delegation_find_inode_server(server, fhandle);
 805                 if (res != NULL)
 806                         break;
 807         }
 808         rcu_read_unlock();
 809         return res;
 810 }
 811
 812 static void nfs_delegation_mark_reclaim_server(struct nfs_server *server)
 813 {
 814         struct nfs_delegation *delegation;
 815
 816         list_for_each_entry_rcu(delegation, &server->delegations, super_list) {
 817                 /*
 818                  * If the delegation may have been admin revoked, then we
 819                  * cannot reclaim it.
 820                  */
 821                 if (test_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags))
 822                         continue;
 823                 set_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
 824         }
 825 }
 826
 827 /**
 828  * nfs_delegation_mark_reclaim - mark all delegations as needing to be reclaimed
 829  * @clp: nfs_client to process
 830  *
 831  */
 832 void nfs_delegation_mark_reclaim(struct nfs_client *clp)
 833 {
 834         struct nfs_server *server;
 835
 836         rcu_read_lock();
 837         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
 838                 nfs_delegation_mark_reclaim_server(server);
 839         rcu_read_unlock();
 840 }
 841
 842 /**
 843  * nfs_delegation_reap_unclaimed - reap unclaimed delegations after reboot recovery is done
 844  * @clp: nfs_client to process
 845  *
 846  */
 847 void nfs_delegation_reap_unclaimed(struct nfs_client *clp)
 848 {
 849         struct nfs_delegation *delegation;
 850         struct nfs_server *server;
 851         struct inode *inode;
 852
 853 restart:
 854         rcu_read_lock();
 855         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
 856                 list_for_each_entry_rcu(delegation, &server->delegations,
 857                                                                 super_list) {
 858                         if (test_bit(NFS_DELEGATION_RETURNING,
 859                                                 &delegation->flags))
 860                                 continue;
 861                         if (test_bit(NFS_DELEGATION_NEED_RECLAIM,
 862                                                 &delegation->flags) == 0)
 863                                 continue;
 864                         if (!nfs_sb_active(server->super))
 865                                 continue;
 866                         inode = nfs_delegation_grab_inode(delegation);
 867                         if (inode == NULL) {
 868                                 rcu_read_unlock();
 869                                 nfs_sb_deactive(server->super);
 870                                 goto restart;
 871                         }
 872                         delegation = nfs_start_delegation_return_locked(NFS_I(inode));
 873                         rcu_read_unlock();
 874                         if (delegation != NULL) {
 875                                 delegation = nfs_detach_delegation(NFS_I(inode),
 876                                         delegation, server);
 877                                 if (delegation != NULL)
 878                                         nfs_free_delegation(delegation);
 879                         }
 880                         iput(inode);
 881                         nfs_sb_deactive(server->super);
 882                         goto restart;
 883                 }
 884         }
 885         rcu_read_unlock();
 886 }
 887
 888 static inline bool nfs4_server_rebooted(const struct nfs_client *clp)
 889 {
 890         return (clp->cl_state & (BIT(NFS4CLNT_CHECK_LEASE) |
 891                                 BIT(NFS4CLNT_LEASE_EXPIRED) |
 892                                 BIT(NFS4CLNT_SESSION_RESET))) != 0;
 893 }
 894
 895 static void nfs_mark_test_expired_delegation(struct nfs_server *server,
 896             struct nfs_delegation *delegation)
 897 {
 898         if (delegation->stateid.type == NFS4_INVALID_STATEID_TYPE)
 899                 return;
 900         clear_bit(NFS_DELEGATION_NEED_RECLAIM, &delegation->flags);
 901         set_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags);
 902         set_bit(NFS4CLNT_DELEGATION_EXPIRED, &server->nfs_client->cl_state);
 903 }
 904
 905 static void nfs_inode_mark_test_expired_delegation(struct nfs_server *server,
 906                 struct inode *inode)
 907 {
 908         struct nfs_delegation *delegation;
 909
 910         rcu_read_lock();
 911         delegation = rcu_dereference(NFS_I(inode)->delegation);
 912         if (delegation)
 913                 nfs_mark_test_expired_delegation(server, delegation);
 914         rcu_read_unlock();
 915
 916 }
 917
 918 static void nfs_delegation_mark_test_expired_server(struct nfs_server *server)
 919 {
 920         struct nfs_delegation *delegation;
 921
 922         list_for_each_entry_rcu(delegation, &server->delegations, super_list)
 923                 nfs_mark_test_expired_delegation(server, delegation);
 924 }
 925
 926 /**
 927  * nfs_mark_test_expired_all_delegations - mark all delegations for testing
 928  * @clp: nfs_client to process
 929  *
 930  * Iterates through all the delegations associated with this server and
 931  * marks them as needing to be checked for validity.
 932  */
 933 void nfs_mark_test_expired_all_delegations(struct nfs_client *clp)
 934 {
 935         struct nfs_server *server;
 936
 937         rcu_read_lock();
 938         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
 939                 nfs_delegation_mark_test_expired_server(server);
 940         rcu_read_unlock();
 941 }
 942
 943 /**
 944  * nfs_reap_expired_delegations - reap expired delegations
 945  * @clp: nfs_client to process
 946  *
 947  * Iterates through all the delegations associated with this server and
 948  * checks if they have may have been revoked. This function is usually
 949  * expected to be called in cases where the server may have lost its
 950  * lease.
 951  */
 952 void nfs_reap_expired_delegations(struct nfs_client *clp)
 953 {
 954         const struct nfs4_minor_version_ops *ops = clp->cl_mvops;
 955         struct nfs_delegation *delegation;
 956         struct nfs_server *server;
 957         struct inode *inode;
 958         struct rpc_cred *cred;
 959         nfs4_stateid stateid;
 960
 961 restart:
 962         rcu_read_lock();
 963         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link) {
 964                 list_for_each_entry_rcu(delegation, &server->delegations,
 965                                                                 super_list) {
 966                         if (test_bit(NFS_DELEGATION_RETURNING,
 967                                                 &delegation->flags))
 968                                 continue;
 969                         if (test_bit(NFS_DELEGATION_TEST_EXPIRED,
 970                                                 &delegation->flags) == 0)
 971                                 continue;
 972                         if (!nfs_sb_active(server->super))
 973                                 continue;
 974                         inode = nfs_delegation_grab_inode(delegation);
 975                         if (inode == NULL) {
 976                                 rcu_read_unlock();
 977                                 nfs_sb_deactive(server->super);
 978                                 goto restart;
 979                         }
 980                         cred = get_rpccred_rcu(delegation->cred);
 981                         nfs4_stateid_copy(&stateid, &delegation->stateid);
 982                         clear_bit(NFS_DELEGATION_TEST_EXPIRED, &delegation->flags);
 983                         rcu_read_unlock();
 984                         if (cred != NULL &&
 985                             ops->test_and_free_expired(server, &stateid, cred) < 0) {
 986                                 nfs_revoke_delegation(inode, &stateid);
 987                                 nfs_inode_find_state_and_recover(inode, &stateid);
 988                         }
 989                         put_rpccred(cred);
 990                         if (nfs4_server_rebooted(clp)) {
 991                                 nfs_inode_mark_test_expired_delegation(server,inode);
 992                                 iput(inode);
 993                                 nfs_sb_deactive(server->super);
 994                                 return;
 995                         }
 996                         iput(inode);
 997                         nfs_sb_deactive(server->super);
 998                         goto restart;
 999                 }
1000         }
1001         rcu_read_unlock();
1002 }
1003
1004 /**
1005  * nfs_delegations_present - check for existence of delegations
1006  * @clp: client state handle
1007  *
1008  * Returns one if there are any nfs_delegation structures attached
1009  * to this nfs_client.
1010  */
1011 int nfs_delegations_present(struct nfs_client *clp)
1012 {
1013         struct nfs_server *server;
1014         int ret = 0;
1015
1016         rcu_read_lock();
1017         list_for_each_entry_rcu(server, &clp->cl_superblocks, client_link)
1018                 if (!list_empty(&server->delegations)) {
1019                         ret = 1;
1020                         break;
1021                 }
1022         rcu_read_unlock();
1023         return ret;
1024 }
1025
1026 /**
1027  * nfs4_copy_delegation_stateid - Copy inode's state ID information
1028  * @inode: inode to check
1029  * @flags: delegation type requirement
1030  * @dst: stateid data structure to fill in
1031  * @cred: optional argument to retrieve credential
1032  *
1033  * Returns "true" and fills in "dst->data" * if inode had a delegation,
1034  * otherwise "false" is returned.
1035  */
1036 bool nfs4_copy_delegation_stateid(struct inode *inode, fmode_t flags,
1037                 nfs4_stateid *dst, struct rpc_cred **cred)
1038 {
1039         struct nfs_inode *nfsi = NFS_I(inode);
1040         struct nfs_delegation *delegation;
1041         bool ret;
1042
1043         flags &= FMODE_READ|FMODE_WRITE;
1044         rcu_read_lock();
1045         delegation = rcu_dereference(nfsi->delegation);
1046         ret = nfs4_is_valid_delegation(delegation, flags);
1047         if (ret) {
1048                 nfs4_stateid_copy(dst, &delegation->stateid);
1049                 nfs_mark_delegation_referenced(delegation);
1050                 if (cred)
1051                         *cred = get_rpccred(delegation->cred);
1052         }
1053         rcu_read_unlock();
1054         return ret;
1055 }
1056
1057 /**
1058  * nfs4_delegation_flush_on_close - Check if we must flush file on close
1059  * @inode: inode to check
1060  *
1061  * This function checks the number of outstanding writes to the file
1062  * against the delegation 'space_limit' field to see if
1063  * the spec requires us to flush the file on close.
1064  */
1065 bool nfs4_delegation_flush_on_close(const struct inode *inode)
1066 {
1067         struct nfs_inode *nfsi = NFS_I(inode);
1068         struct nfs_delegation *delegation;
1069         bool ret = true;
1070
1071         rcu_read_lock();
1072         delegation = rcu_dereference(nfsi->delegation);
1073         if (delegation == NULL || !(delegation->type & FMODE_WRITE))
1074                 goto out;
1075         if (nfsi->nrequests < delegation->pagemod_limit)
1076                 ret = false;
1077 out:
1078         rcu_read_unlock();
1079         return ret;
1080 }