fs/nfs/nfs4_fs.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * linux/fs/nfs/nfs4_fs.h
   4  *
   5  * Copyright (C) 2005 Trond Myklebust
   6  *
   7  * NFSv4-specific filesystem definitions and declarations
   8  */
   9
  10 #ifndef __LINUX_FS_NFS_NFS4_FS_H
  11 #define __LINUX_FS_NFS_NFS4_FS_H
  12
  13 #if defined(CONFIG_NFS_V4_2)
  14 #define NFS4_MAX_MINOR_VERSION 2
  15 #elif defined(CONFIG_NFS_V4_1)
  16 #define NFS4_MAX_MINOR_VERSION 1
  17 #else
  18 #define NFS4_MAX_MINOR_VERSION 0
  19 #endif
  20
  21 #if IS_ENABLED(CONFIG_NFS_V4)
  22
  23 #define NFS4_MAX_LOOP_ON_RECOVER (10)
  24
  25 #include <linux/seqlock.h>
  26
  27 struct idmap;
  28
  29 enum nfs4_client_state {
  30         NFS4CLNT_MANAGER_RUNNING  = 0,
  31         NFS4CLNT_CHECK_LEASE,
  32         NFS4CLNT_LEASE_EXPIRED,
  33         NFS4CLNT_RECLAIM_REBOOT,
  34         NFS4CLNT_RECLAIM_NOGRACE,
  35         NFS4CLNT_DELEGRETURN,
  36         NFS4CLNT_SESSION_RESET,
  37         NFS4CLNT_LEASE_CONFIRM,
  38         NFS4CLNT_SERVER_SCOPE_MISMATCH,
  39         NFS4CLNT_PURGE_STATE,
  40         NFS4CLNT_BIND_CONN_TO_SESSION,
  41         NFS4CLNT_MOVED,
  42         NFS4CLNT_LEASE_MOVED,
  43         NFS4CLNT_DELEGATION_EXPIRED,
  44         NFS4CLNT_RUN_MANAGER,
  45         NFS4CLNT_MANAGER_AVAILABLE,
  46         NFS4CLNT_RECALL_RUNNING,
  47         NFS4CLNT_RECALL_ANY_LAYOUT_READ,
  48         NFS4CLNT_RECALL_ANY_LAYOUT_RW,
  49         NFS4CLNT_DELEGRETURN_DELAYED,
  50 };
  51
  52 #define NFS4_RENEW_TIMEOUT              0x01
  53 #define NFS4_RENEW_DELEGATION_CB        0x02
  54
  55 struct nfs_seqid_counter;
  56 struct nfs4_minor_version_ops {
  57         u32     minor_version;
  58         unsigned init_caps;
  59
  60         int     (*init_client)(struct nfs_client *);
  61         void    (*shutdown_client)(struct nfs_client *);
  62         bool    (*match_stateid)(const nfs4_stateid *,
  63                         const nfs4_stateid *);
  64         int     (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
  65                         struct nfs_fsinfo *);
  66         void    (*free_lock_state)(struct nfs_server *,
  67                         struct nfs4_lock_state *);
  68         int     (*test_and_free_expired)(struct nfs_server *,
  69                         nfs4_stateid *, const struct cred *);
  70         struct nfs_seqid *
  71                 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
  72         void    (*session_trunk)(struct rpc_clnt *clnt,
  73                         struct rpc_xprt *xprt, void *data);
  74         const struct rpc_call_ops *call_sync_ops;
  75         const struct nfs4_state_recovery_ops *reboot_recovery_ops;
  76         const struct nfs4_state_recovery_ops *nograce_recovery_ops;
  77         const struct nfs4_state_maintenance_ops *state_renewal_ops;
  78         const struct nfs4_mig_recovery_ops *mig_recovery_ops;
  79 };
  80
  81 #define NFS_SEQID_CONFIRMED 1
  82 struct nfs_seqid_counter {
  83         ktime_t create_time;
  84         int owner_id;
  85         int flags;
  86         u32 counter;
  87         spinlock_t lock;                /* Protects the list */
  88         struct list_head list;          /* Defines sequence of RPC calls */
  89         struct rpc_wait_queue   wait;   /* RPC call delay queue */
  90 };
  91
  92 struct nfs_seqid {
  93         struct nfs_seqid_counter *sequence;
  94         struct list_head list;
  95         struct rpc_task *task;
  96 };
  97
  98 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  99 {
 100         if (seqid_mutating_err(-status))
 101                 seqid->flags |= NFS_SEQID_CONFIRMED;
 102 }
 103
 104 /*
 105  * NFS4 state_owners and lock_owners are simply labels for ordered
 106  * sequences of RPC calls. Their sole purpose is to provide once-only
 107  * semantics by allowing the server to identify replayed requests.
 108  */
 109 struct nfs4_state_owner {
 110         struct nfs_server    *so_server;
 111         struct list_head     so_lru;
 112         unsigned long        so_expires;
 113         struct rb_node       so_server_node;
 114
 115         const struct cred    *so_cred;   /* Associated cred */
 116
 117         spinlock_t           so_lock;
 118         atomic_t             so_count;
 119         unsigned long        so_flags;
 120         struct list_head     so_states;
 121         struct nfs_seqid_counter so_seqid;
 122         seqcount_spinlock_t  so_reclaim_seqcount;
 123         struct mutex         so_delegreturn_mutex;
 124 };
 125
 126 enum {
 127         NFS_OWNER_RECLAIM_REBOOT,
 128         NFS_OWNER_RECLAIM_NOGRACE
 129 };
 130
 131 #define NFS_LOCK_NEW            0
 132 #define NFS_LOCK_RECLAIM        1
 133 #define NFS_LOCK_EXPIRED        2
 134
 135 /*
 136  * struct nfs4_state maintains the client-side state for a given
 137  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 138  *
 139  * OPEN:
 140  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 141  * we need to know how many files are open for reading or writing on a
 142  * given inode. This information too is stored here.
 143  *
 144  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 145  */
 146
 147 struct nfs4_lock_state {
 148         struct list_head        ls_locks;       /* Other lock stateids */
 149         struct nfs4_state *     ls_state;       /* Pointer to open state */
 150 #define NFS_LOCK_INITIALIZED 0
 151 #define NFS_LOCK_LOST        1
 152 #define NFS_LOCK_UNLOCKING   2
 153         unsigned long           ls_flags;
 154         struct nfs_seqid_counter        ls_seqid;
 155         nfs4_stateid            ls_stateid;
 156         refcount_t              ls_count;
 157         fl_owner_t              ls_owner;
 158 };
 159
 160 /* bits for nfs4_state->flags */
 161 enum {
 162         LK_STATE_IN_USE,
 163         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 164         NFS_OPEN_STATE,                 /* OPEN stateid is set */
 165         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 166         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 167         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 168         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 169         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 170         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 171         NFS_STATE_RECOVERY_FAILED,      /* OPEN stateid state recovery failed */
 172         NFS_STATE_MAY_NOTIFY_LOCK,      /* server may CB_NOTIFY_LOCK */
 173         NFS_STATE_CHANGE_WAIT,          /* A state changing operation is outstanding */
 174         NFS_CLNT_DST_SSC_COPY_STATE,    /* dst server open state on client*/
 175         NFS_CLNT_SRC_SSC_COPY_STATE,    /* src server open state on client*/
 176         NFS_SRV_SSC_COPY_STATE,         /* ssc state on the dst server */
 177 };
 178
 179 struct nfs4_state {
 180         struct list_head open_states;   /* List of states for the same state_owner */
 181         struct list_head inode_states;  /* List of states for the same inode */
 182         struct list_head lock_states;   /* List of subservient lock stateids */
 183
 184         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 185         struct inode *inode;            /* Pointer to the inode */
 186
 187         unsigned long flags;            /* Do we hold any locks? */
 188         spinlock_t state_lock;          /* Protects the lock_states list */
 189
 190         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 191         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 192         nfs4_stateid open_stateid;      /* OPEN stateid */
 193
 194         /* The following 3 fields are protected by owner->so_lock */
 195         unsigned int n_rdonly;          /* Number of read-only references */
 196         unsigned int n_wronly;          /* Number of write-only references */
 197         unsigned int n_rdwr;            /* Number of read/write references */
 198         fmode_t state;                  /* State on the server (R,W, or RW) */
 199         refcount_t count;
 200
 201         wait_queue_head_t waitq;
 202         struct rcu_head rcu_head;
 203 };
 204
 205
 206 struct nfs4_exception {
 207         struct nfs4_state *state;
 208         struct inode *inode;
 209         nfs4_stateid *stateid;
 210         long timeout;
 211         unsigned char task_is_privileged : 1;
 212         unsigned char delay : 1,
 213                       recovering : 1,
 214                       retry : 1;
 215         bool interruptible;
 216 };
 217
 218 struct nfs4_state_recovery_ops {
 219         int owner_flag_bit;
 220         int state_flag_bit;
 221         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 222         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 223         int (*establish_clid)(struct nfs_client *, const struct cred *);
 224         int (*reclaim_complete)(struct nfs_client *, const struct cred *);
 225         int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
 226                 const struct cred *);
 227 };
 228
 229 struct nfs4_opendata {
 230         struct kref kref;
 231         struct nfs_openargs o_arg;
 232         struct nfs_openres o_res;
 233         struct nfs_open_confirmargs c_arg;
 234         struct nfs_open_confirmres c_res;
 235         struct nfs4_string owner_name;
 236         struct nfs4_string group_name;
 237         struct nfs4_label *a_label;
 238         struct nfs_fattr f_attr;
 239         struct dentry *dir;
 240         struct dentry *dentry;
 241         struct nfs4_state_owner *owner;
 242         struct nfs4_state *state;
 243         struct iattr attrs;
 244         struct nfs4_layoutget *lgp;
 245         unsigned long timestamp;
 246         bool rpc_done;
 247         bool file_created;
 248         bool is_recover;
 249         bool cancelled;
 250         int rpc_status;
 251 };
 252
 253 struct nfs4_add_xprt_data {
 254         struct nfs_client       *clp;
 255         const struct cred       *cred;
 256 };
 257
 258 struct nfs4_state_maintenance_ops {
 259         int (*sched_state_renewal)(struct nfs_client *, const struct cred *, unsigned);
 260         const struct cred * (*get_state_renewal_cred)(struct nfs_client *);
 261         int (*renew_lease)(struct nfs_client *, const struct cred *);
 262 };
 263
 264 struct nfs4_mig_recovery_ops {
 265         int (*get_locations)(struct nfs_server *, struct nfs_fh *,
 266                 struct nfs4_fs_locations *, struct page *, const struct cred *);
 267         int (*fsid_present)(struct inode *, const struct cred *);
 268 };
 269
 270 extern const struct dentry_operations nfs4_dentry_operations;
 271
 272 /* dir.c */
 273 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
 274                     unsigned, umode_t);
 275
 276 /* fs_context.c */
 277 extern struct file_system_type nfs4_fs_type;
 278
 279 /* nfs4namespace.c */
 280 struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
 281                                          const struct qstr *);
 282 int nfs4_submount(struct fs_context *, struct nfs_server *);
 283 int nfs4_replace_transport(struct nfs_server *server,
 284                                 const struct nfs4_fs_locations *locations);
 285 size_t nfs_parse_server_name(char *string, size_t len, struct sockaddr_storage *ss,
 286                              size_t salen, struct net *net, int port);
 287 /* nfs4proc.c */
 288 extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
 289 extern int nfs4_async_handle_error(struct rpc_task *task,
 290                                    struct nfs_server *server,
 291                                    struct nfs4_state *state, long *timeout);
 292 extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
 293                           struct rpc_message *, struct nfs4_sequence_args *,
 294                           struct nfs4_sequence_res *, int);
 295 extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
 296 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
 297 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
 298 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
 299 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
 300 extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
 301 extern int nfs4_destroy_clientid(struct nfs_client *clp);
 302 extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
 303 extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
 304 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
 305 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 306 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
 307                                   struct nfs4_fs_locations *, struct page *);
 308 extern int nfs4_proc_get_locations(struct nfs_server *, struct nfs_fh *,
 309                                    struct nfs4_fs_locations *,
 310                                    struct page *page, const struct cred *);
 311 extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
 312 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *,
 313                                                     struct dentry *,
 314                                                     struct nfs_fh *,
 315                                                     struct nfs_fattr *);
 316 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
 317 extern const struct xattr_handler *nfs4_xattr_handlers[];
 318 extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
 319                 const struct nfs_open_context *ctx,
 320                 const struct nfs_lock_context *l_ctx,
 321                 fmode_t fmode);
 322 extern void nfs4_bitmask_set(__u32 bitmask[], const __u32 src[],
 323                              struct inode *inode, unsigned long cache_validity);
 324 extern int nfs4_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
 325                              struct nfs_fattr *fattr, struct inode *inode);
 326 extern int update_open_stateid(struct nfs4_state *state,
 327                                 const nfs4_stateid *open_stateid,
 328                                 const nfs4_stateid *deleg_stateid,
 329                                 fmode_t fmode);
 330 extern int nfs4_proc_setlease(struct file *file, long arg,
 331                               struct file_lock **lease, void **priv);
 332 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 333                 struct nfs_fsinfo *fsinfo);
 334 extern void nfs4_update_changeattr(struct inode *dir,
 335                                    struct nfs4_change_info *cinfo,
 336                                    unsigned long timestamp,
 337                                    unsigned long cache_validity);
 338 extern int nfs4_buf_to_pages_noslab(const void *buf, size_t buflen,
 339                                     struct page **pages);
 340
 341 #if defined(CONFIG_NFS_V4_1)
 342 extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
 343 extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
 344 extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
 345 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
 346                                   bool sync);
 347 extern int nfs4_detect_session_trunking(struct nfs_client *clp,
 348                 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
 349
 350 static inline bool
 351 is_ds_only_client(struct nfs_client *clp)
 352 {
 353         return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
 354                 EXCHGID4_FLAG_USE_PNFS_DS;
 355 }
 356
 357 static inline bool
 358 is_ds_client(struct nfs_client *clp)
 359 {
 360         return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
 361 }
 362
 363 static inline bool
 364 _nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
 365                     struct rpc_clnt **clntp, struct rpc_message *msg)
 366 {
 367         rpc_authflavor_t flavor;
 368
 369         if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
 370             sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
 371                 /* Using machine creds for cleanup operations
 372                  * is only relevent if the client credentials
 373                  * might expire. So don't bother for
 374                  * RPC_AUTH_UNIX.  If file was only exported to
 375                  * sec=sys, the PUTFH would fail anyway.
 376                  */
 377                 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
 378                         return false;
 379         }
 380         if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
 381                 msg->rpc_cred = rpc_machine_cred();
 382
 383                 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
 384                 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
 385                              flavor != RPC_AUTH_GSS_KRB5P);
 386                 *clntp = clp->cl_rpcclient;
 387
 388                 return true;
 389         }
 390         return false;
 391 }
 392
 393 /*
 394  * Function responsible for determining if an rpc_message should use the
 395  * machine cred under SP4_MACH_CRED and if so switching the credential and
 396  * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
 397  * Should be called before rpc_call_sync/rpc_call_async.
 398  */
 399 static inline void
 400 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
 401                    struct rpc_clnt **clntp, struct rpc_message *msg)
 402 {
 403         _nfs4_state_protect(clp, sp4_mode, clntp, msg);
 404 }
 405
 406 /*
 407  * Special wrapper to nfs4_state_protect for write.
 408  * If WRITE can use machine cred but COMMIT cannot, make sure all writes
 409  * that use machine cred use NFS_FILE_SYNC.
 410  */
 411 static inline void
 412 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
 413                          struct rpc_message *msg, struct nfs_pgio_header *hdr)
 414 {
 415         if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
 416             !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
 417                 hdr->args.stable = NFS_FILE_SYNC;
 418 }
 419 #else /* CONFIG_NFS_v4_1 */
 420 static inline bool
 421 is_ds_only_client(struct nfs_client *clp)
 422 {
 423         return false;
 424 }
 425
 426 static inline bool
 427 is_ds_client(struct nfs_client *clp)
 428 {
 429         return false;
 430 }
 431
 432 static inline void
 433 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
 434                    struct rpc_clnt **clntp, struct rpc_message *msg)
 435 {
 436 }
 437
 438 static inline void
 439 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
 440                          struct rpc_message *msg, struct nfs_pgio_header *hdr)
 441 {
 442 }
 443 #endif /* CONFIG_NFS_V4_1 */
 444
 445 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
 446
 447 extern const u32 nfs4_fattr_bitmap[3];
 448 extern const u32 nfs4_statfs_bitmap[3];
 449 extern const u32 nfs4_pathconf_bitmap[3];
 450 extern const u32 nfs4_fsinfo_bitmap[3];
 451 extern const u32 nfs4_fs_locations_bitmap[3];
 452
 453 void nfs40_shutdown_client(struct nfs_client *);
 454 void nfs41_shutdown_client(struct nfs_client *);
 455 int nfs40_init_client(struct nfs_client *);
 456 int nfs41_init_client(struct nfs_client *);
 457 void nfs4_free_client(struct nfs_client *);
 458
 459 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
 460
 461 /* nfs4renewd.c */
 462 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 463 extern void nfs4_kill_renewd(struct nfs_client *);
 464 extern void nfs4_renew_state(struct work_struct *);
 465 extern void nfs4_set_lease_period(struct nfs_client *clp, unsigned long lease);
 466
 467
 468 /* nfs4state.c */
 469 extern const nfs4_stateid current_stateid;
 470
 471 const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
 472 const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
 473 const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
 474 int nfs4_discover_server_trunking(struct nfs_client *clp,
 475                         struct nfs_client **);
 476 int nfs40_discover_server_trunking(struct nfs_client *clp,
 477                         struct nfs_client **, const struct cred *);
 478 #if defined(CONFIG_NFS_V4_1)
 479 int nfs41_discover_server_trunking(struct nfs_client *clp,
 480                         struct nfs_client **, const struct cred *);
 481 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
 482 extern void nfs41_notify_server(struct nfs_client *);
 483 bool nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
 484                         struct nfs41_server_owner *o2);
 485 #else
 486 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
 487 {
 488 }
 489 #endif /* CONFIG_NFS_V4_1 */
 490
 491 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
 492 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 493 extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
 494 extern void nfs4_free_state_owners(struct list_head *head);
 495 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 496 extern void nfs4_put_open_state(struct nfs4_state *);
 497 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
 498 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
 499 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 500 extern void nfs_inode_find_state_and_recover(struct inode *inode,
 501                 const nfs4_stateid *stateid);
 502 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
 503 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
 504 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
 505 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
 506 extern void nfs4_schedule_state_manager(struct nfs_client *);
 507 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
 508 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
 509 extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
 510 extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
 511 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
 512 extern void nfs41_handle_server_scope(struct nfs_client *,
 513                                       struct nfs41_server_scope **);
 514 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 515 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 516 extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
 517                 const struct nfs_lock_context *, nfs4_stateid *,
 518                 const struct cred **);
 519 extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
 520                 struct nfs4_state *state);
 521
 522 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
 523 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 524 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 525 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 526 extern void nfs_release_seqid(struct nfs_seqid *seqid);
 527 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 528 extern int nfs4_setup_sequence(struct nfs_client *client,
 529                                 struct nfs4_sequence_args *args,
 530                                 struct nfs4_sequence_res *res,
 531                                 struct rpc_task *task);
 532 extern int nfs4_sequence_done(struct rpc_task *task,
 533                               struct nfs4_sequence_res *res);
 534
 535 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
 536 extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
 537 extern const nfs4_stateid zero_stateid;
 538 extern const nfs4_stateid invalid_stateid;
 539
 540 /* nfs4super.c */
 541 struct nfs_mount_info;
 542 extern struct nfs_subversion nfs_v4;
 543 extern bool nfs4_disable_idmapping;
 544 extern unsigned short max_session_slots;
 545 extern unsigned short max_session_cb_slots;
 546 extern unsigned short send_implementation_id;
 547 extern bool recover_lost_locks;
 548
 549 #define NFS4_CLIENT_ID_UNIQ_LEN         (64)
 550 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
 551
 552 extern int nfs4_try_get_tree(struct fs_context *);
 553 extern int nfs4_get_referral_tree(struct fs_context *);
 554
 555 /* nfs4sysctl.c */
 556 #ifdef CONFIG_SYSCTL
 557 int nfs4_register_sysctl(void);
 558 void nfs4_unregister_sysctl(void);
 559 #else
 560 static inline int nfs4_register_sysctl(void)
 561 {
 562         return 0;
 563 }
 564
 565 static inline void nfs4_unregister_sysctl(void)
 566 {
 567 }
 568 #endif
 569
 570 /* nfs4xdr.c */
 571 extern const struct rpc_procinfo nfs4_procedures[];
 572
 573 #ifdef CONFIG_NFS_V4_2
 574 extern const u32 nfs42_maxsetxattr_overhead;
 575 extern const u32 nfs42_maxgetxattr_overhead;
 576 extern const u32 nfs42_maxlistxattrs_overhead;
 577 #endif
 578
 579 struct nfs4_mount_data;
 580
 581 /* callback_xdr.c */
 582 extern const struct svc_version nfs4_callback_version1;
 583 extern const struct svc_version nfs4_callback_version4;
 584
 585 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
 586 {
 587         memcpy(dst->data, src->data, sizeof(dst->data));
 588         dst->type = src->type;
 589 }
 590
 591 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
 592 {
 593         if (dst->type != src->type)
 594                 return false;
 595         return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
 596 }
 597
 598 static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
 599 {
 600         return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
 601 }
 602
 603 static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
 604 {
 605         return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
 606 }
 607
 608 static inline bool nfs4_stateid_is_next(const nfs4_stateid *s1, const nfs4_stateid *s2)
 609 {
 610         u32 seq1 = be32_to_cpu(s1->seqid);
 611         u32 seq2 = be32_to_cpu(s2->seqid);
 612
 613         return seq2 == seq1 + 1U || (seq2 == 1U && seq1 == 0xffffffffU);
 614 }
 615
 616 static inline bool nfs4_stateid_match_or_older(const nfs4_stateid *dst, const nfs4_stateid *src)
 617 {
 618         return nfs4_stateid_match_other(dst, src) &&
 619                 !(src->seqid && nfs4_stateid_is_newer(dst, src));
 620 }
 621
 622 static inline void nfs4_stateid_seqid_inc(nfs4_stateid *s1)
 623 {
 624         u32 seqid = be32_to_cpu(s1->seqid);
 625
 626         if (++seqid == 0)
 627                 ++seqid;
 628         s1->seqid = cpu_to_be32(seqid);
 629 }
 630
 631 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
 632 {
 633         return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
 634 }
 635
 636 static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
 637                 const nfs4_stateid *stateid)
 638 {
 639         return test_bit(NFS_OPEN_STATE, &state->flags) &&
 640                 nfs4_stateid_match_other(&state->open_stateid, stateid);
 641 }
 642
 643 /* nfs42xattr.c */
 644 #ifdef CONFIG_NFS_V4_2
 645 extern int __init nfs4_xattr_cache_init(void);
 646 extern void nfs4_xattr_cache_exit(void);
 647 extern void nfs4_xattr_cache_add(struct inode *inode, const char *name,
 648                                  const char *buf, struct page **pages,
 649                                  ssize_t buflen);
 650 extern void nfs4_xattr_cache_remove(struct inode *inode, const char *name);
 651 extern ssize_t nfs4_xattr_cache_get(struct inode *inode, const char *name,
 652                                 char *buf, ssize_t buflen);
 653 extern void nfs4_xattr_cache_set_list(struct inode *inode, const char *buf,
 654                                       ssize_t buflen);
 655 extern ssize_t nfs4_xattr_cache_list(struct inode *inode, char *buf,
 656                                      ssize_t buflen);
 657 extern void nfs4_xattr_cache_zap(struct inode *inode);
 658 #else
 659 static inline void nfs4_xattr_cache_zap(struct inode *inode)
 660 {
 661 }
 662 #endif /* CONFIG_NFS_V4_2 */
 663
 664 #else /* CONFIG_NFS_V4 */
 665
 666 #define nfs4_close_state(a, b) do { } while (0)
 667 #define nfs4_close_sync(a, b) do { } while (0)
 668 #define nfs4_state_protect(a, b, c, d) do { } while (0)
 669 #define nfs4_state_protect_write(a, b, c, d) do { } while (0)
 670
 671
 672 #endif /* CONFIG_NFS_V4 */
 673 #endif /* __LINUX_FS_NFS_NFS4_FS.H */