fs/nfs/nfs4_fs.h

   1 /*
   2  * linux/fs/nfs/nfs4_fs.h
   3  *
   4  * Copyright (C) 2005 Trond Myklebust
   5  *
   6  * NFSv4-specific filesystem definitions and declarations
   7  */
   8
   9 #ifndef __LINUX_FS_NFS_NFS4_FS_H
  10 #define __LINUX_FS_NFS_NFS4_FS_H
  11
  12 #if IS_ENABLED(CONFIG_NFS_V4)
  13
  14 #define NFS4_MAX_LOOP_ON_RECOVER (10)
  15
  16 #include <linux/seqlock.h>
  17
  18 struct idmap;
  19
  20 enum nfs4_client_state {
  21         NFS4CLNT_MANAGER_RUNNING  = 0,
  22         NFS4CLNT_CHECK_LEASE,
  23         NFS4CLNT_LEASE_EXPIRED,
  24         NFS4CLNT_RECLAIM_REBOOT,
  25         NFS4CLNT_RECLAIM_NOGRACE,
  26         NFS4CLNT_DELEGRETURN,
  27         NFS4CLNT_SESSION_RESET,
  28         NFS4CLNT_LEASE_CONFIRM,
  29         NFS4CLNT_SERVER_SCOPE_MISMATCH,
  30         NFS4CLNT_PURGE_STATE,
  31         NFS4CLNT_BIND_CONN_TO_SESSION,
  32 };
  33
  34 #define NFS4_RENEW_TIMEOUT              0x01
  35 #define NFS4_RENEW_DELEGATION_CB        0x02
  36
  37 struct nfs4_minor_version_ops {
  38         u32     minor_version;
  39         unsigned init_caps;
  40
  41         int     (*init_client)(struct nfs_client *);
  42         void    (*shutdown_client)(struct nfs_client *);
  43         bool    (*match_stateid)(const nfs4_stateid *,
  44                         const nfs4_stateid *);
  45         int     (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
  46                         struct nfs_fsinfo *);
  47         int     (*free_lock_state)(struct nfs_server *,
  48                         struct nfs4_lock_state *);
  49         const struct rpc_call_ops *call_sync_ops;
  50         const struct nfs4_state_recovery_ops *reboot_recovery_ops;
  51         const struct nfs4_state_recovery_ops *nograce_recovery_ops;
  52         const struct nfs4_state_maintenance_ops *state_renewal_ops;
  53 };
  54
  55 #define NFS_SEQID_CONFIRMED 1
  56 struct nfs_seqid_counter {
  57         ktime_t create_time;
  58         int owner_id;
  59         int flags;
  60         u32 counter;
  61         spinlock_t lock;                /* Protects the list */
  62         struct list_head list;          /* Defines sequence of RPC calls */
  63         struct rpc_wait_queue   wait;   /* RPC call delay queue */
  64 };
  65
  66 struct nfs_seqid {
  67         struct nfs_seqid_counter *sequence;
  68         struct list_head list;
  69         struct rpc_task *task;
  70 };
  71
  72 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  73 {
  74         if (seqid_mutating_err(-status))
  75                 seqid->flags |= NFS_SEQID_CONFIRMED;
  76 }
  77
  78 /*
  79  * NFS4 state_owners and lock_owners are simply labels for ordered
  80  * sequences of RPC calls. Their sole purpose is to provide once-only
  81  * semantics by allowing the server to identify replayed requests.
  82  */
  83 struct nfs4_state_owner {
  84         struct nfs_server    *so_server;
  85         struct list_head     so_lru;
  86         unsigned long        so_expires;
  87         struct rb_node       so_server_node;
  88
  89         struct rpc_cred      *so_cred;   /* Associated cred */
  90
  91         spinlock_t           so_lock;
  92         atomic_t             so_count;
  93         unsigned long        so_flags;
  94         struct list_head     so_states;
  95         struct nfs_seqid_counter so_seqid;
  96         seqcount_t           so_reclaim_seqcount;
  97         struct mutex         so_delegreturn_mutex;
  98 };
  99
 100 enum {
 101         NFS_OWNER_RECLAIM_REBOOT,
 102         NFS_OWNER_RECLAIM_NOGRACE
 103 };
 104
 105 #define NFS_LOCK_NEW            0
 106 #define NFS_LOCK_RECLAIM        1
 107 #define NFS_LOCK_EXPIRED        2
 108
 109 /*
 110  * struct nfs4_state maintains the client-side state for a given
 111  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 112  *
 113  * OPEN:
 114  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 115  * we need to know how many files are open for reading or writing on a
 116  * given inode. This information too is stored here.
 117  *
 118  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 119  */
 120
 121 struct nfs4_lock_owner {
 122         unsigned int lo_type;
 123 #define NFS4_ANY_LOCK_TYPE      (0U)
 124 #define NFS4_FLOCK_LOCK_TYPE    (1U << 0)
 125 #define NFS4_POSIX_LOCK_TYPE    (1U << 1)
 126         union {
 127                 fl_owner_t posix_owner;
 128                 pid_t flock_owner;
 129         } lo_u;
 130 };
 131
 132 struct nfs4_lock_state {
 133         struct list_head        ls_locks;       /* Other lock stateids */
 134         struct nfs4_state *     ls_state;       /* Pointer to open state */
 135 #define NFS_LOCK_INITIALIZED 0
 136 #define NFS_LOCK_LOST        1
 137         unsigned long           ls_flags;
 138         struct nfs_seqid_counter        ls_seqid;
 139         nfs4_stateid            ls_stateid;
 140         atomic_t                ls_count;
 141         struct nfs4_lock_owner  ls_owner;
 142 };
 143
 144 /* bits for nfs4_state->flags */
 145 enum {
 146         LK_STATE_IN_USE,
 147         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 148         NFS_OPEN_STATE,                 /* OPEN stateid is set */
 149         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 150         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 151         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 152         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 153         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 154         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 155         NFS_STATE_RECOVERY_FAILED,      /* OPEN stateid state recovery failed */
 156 };
 157
 158 struct nfs4_state {
 159         struct list_head open_states;   /* List of states for the same state_owner */
 160         struct list_head inode_states;  /* List of states for the same inode */
 161         struct list_head lock_states;   /* List of subservient lock stateids */
 162
 163         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 164         struct inode *inode;            /* Pointer to the inode */
 165
 166         unsigned long flags;            /* Do we hold any locks? */
 167         spinlock_t state_lock;          /* Protects the lock_states list */
 168
 169         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 170         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 171         nfs4_stateid open_stateid;      /* OPEN stateid */
 172
 173         /* The following 3 fields are protected by owner->so_lock */
 174         unsigned int n_rdonly;          /* Number of read-only references */
 175         unsigned int n_wronly;          /* Number of write-only references */
 176         unsigned int n_rdwr;            /* Number of read/write references */
 177         fmode_t state;                  /* State on the server (R,W, or RW) */
 178         atomic_t count;
 179 };
 180
 181
 182 struct nfs4_exception {
 183         long timeout;
 184         int retry;
 185         struct nfs4_state *state;
 186         struct inode *inode;
 187 };
 188
 189 struct nfs4_state_recovery_ops {
 190         int owner_flag_bit;
 191         int state_flag_bit;
 192         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 193         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 194         int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
 195         int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
 196         int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
 197                 struct rpc_cred *);
 198 };
 199
 200 struct nfs4_state_maintenance_ops {
 201         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
 202         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 203         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 204 };
 205
 206 extern const struct dentry_operations nfs4_dentry_operations;
 207
 208 /* dir.c */
 209 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
 210                     unsigned, umode_t, int *);
 211
 212 /* super.c */
 213 extern struct file_system_type nfs4_fs_type;
 214
 215 /* nfs4namespace.c */
 216 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
 217 struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
 218 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
 219                                struct nfs_fh *, struct nfs_fattr *);
 220
 221 /* nfs4proc.c */
 222 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
 223 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
 224 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
 225 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
 226 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 227 extern int nfs4_destroy_clientid(struct nfs_client *clp);
 228 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 229 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 230 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
 231 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 232 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
 233                                   struct nfs4_fs_locations *, struct page *);
 234 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
 235                             struct nfs_fh *, struct nfs_fattr *);
 236 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
 237 extern const struct xattr_handler *nfs4_xattr_handlers[];
 238 extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
 239                 const struct nfs_open_context *ctx,
 240                 const struct nfs_lock_context *l_ctx,
 241                 fmode_t fmode);
 242
 243 #if defined(CONFIG_NFS_V4_1)
 244 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 245 {
 246         return server->nfs_client->cl_session;
 247 }
 248
 249 extern int nfs41_setup_sequence(struct nfs4_session *session,
 250                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 251                 struct rpc_task *task);
 252 extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
 253 extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
 254 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 255                 struct nfs_fsinfo *fsinfo);
 256 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
 257                                   bool sync);
 258
 259 static inline bool
 260 is_ds_only_client(struct nfs_client *clp)
 261 {
 262         return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
 263                 EXCHGID4_FLAG_USE_PNFS_DS;
 264 }
 265
 266 static inline bool
 267 is_ds_client(struct nfs_client *clp)
 268 {
 269         return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
 270 }
 271
 272 static inline bool
 273 _nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
 274                     struct rpc_clnt **clntp, struct rpc_message *msg)
 275 {
 276         struct rpc_cred *newcred = NULL;
 277         rpc_authflavor_t flavor;
 278
 279         if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
 280                 spin_lock(&clp->cl_lock);
 281                 if (clp->cl_machine_cred != NULL)
 282                         /* don't call get_rpccred on the machine cred -
 283                          * a reference will be held for life of clp */
 284                         newcred = clp->cl_machine_cred;
 285                 spin_unlock(&clp->cl_lock);
 286                 msg->rpc_cred = newcred;
 287
 288                 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
 289                 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
 290                              flavor != RPC_AUTH_GSS_KRB5P);
 291                 *clntp = clp->cl_rpcclient;
 292
 293                 return true;
 294         }
 295         return false;
 296 }
 297
 298 /*
 299  * Function responsible for determining if an rpc_message should use the
 300  * machine cred under SP4_MACH_CRED and if so switching the credential and
 301  * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
 302  * Should be called before rpc_call_sync/rpc_call_async.
 303  */
 304 static inline void
 305 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
 306                    struct rpc_clnt **clntp, struct rpc_message *msg)
 307 {
 308         _nfs4_state_protect(clp, sp4_mode, clntp, msg);
 309 }
 310
 311 /*
 312  * Special wrapper to nfs4_state_protect for write.
 313  * If WRITE can use machine cred but COMMIT cannot, make sure all writes
 314  * that use machine cred use NFS_FILE_SYNC.
 315  */
 316 static inline void
 317 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
 318                          struct rpc_message *msg, struct nfs_write_data *wdata)
 319 {
 320         if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
 321             !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
 322                 wdata->args.stable = NFS_FILE_SYNC;
 323 }
 324 #else /* CONFIG_NFS_v4_1 */
 325 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 326 {
 327         return NULL;
 328 }
 329
 330 static inline bool
 331 is_ds_only_client(struct nfs_client *clp)
 332 {
 333         return false;
 334 }
 335
 336 static inline bool
 337 is_ds_client(struct nfs_client *clp)
 338 {
 339         return false;
 340 }
 341
 342 static inline void
 343 nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
 344                    struct rpc_clnt **clntp, struct rpc_message *msg)
 345 {
 346 }
 347
 348 static inline void
 349 nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
 350                          struct rpc_message *msg, struct nfs_write_data *wdata)
 351 {
 352 }
 353 #endif /* CONFIG_NFS_V4_1 */
 354
 355 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
 356
 357 extern const u32 nfs4_fattr_bitmap[3];
 358 extern const u32 nfs4_statfs_bitmap[3];
 359 extern const u32 nfs4_pathconf_bitmap[3];
 360 extern const u32 nfs4_fsinfo_bitmap[3];
 361 extern const u32 nfs4_fs_locations_bitmap[3];
 362
 363 void nfs40_shutdown_client(struct nfs_client *);
 364 void nfs41_shutdown_client(struct nfs_client *);
 365 int nfs40_init_client(struct nfs_client *);
 366 int nfs41_init_client(struct nfs_client *);
 367 void nfs4_free_client(struct nfs_client *);
 368
 369 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
 370
 371 /* nfs4renewd.c */
 372 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 373 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 374 extern void nfs4_kill_renewd(struct nfs_client *);
 375 extern void nfs4_renew_state(struct work_struct *);
 376
 377 /* nfs4state.c */
 378 struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
 379 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 380 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 381 int nfs4_discover_server_trunking(struct nfs_client *clp,
 382                         struct nfs_client **);
 383 int nfs40_discover_server_trunking(struct nfs_client *clp,
 384                         struct nfs_client **, struct rpc_cred *);
 385 #if defined(CONFIG_NFS_V4_1)
 386 int nfs41_discover_server_trunking(struct nfs_client *clp,
 387                         struct nfs_client **, struct rpc_cred *);
 388 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
 389 extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
 390 extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
 391
 392 #else
 393 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
 394 {
 395 }
 396 #endif /* CONFIG_NFS_V4_1 */
 397
 398 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
 399 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 400 extern void nfs4_purge_state_owners(struct nfs_server *);
 401 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 402 extern void nfs4_put_open_state(struct nfs4_state *);
 403 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
 404 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
 405 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 406 extern void nfs_inode_find_state_and_recover(struct inode *inode,
 407                 const nfs4_stateid *stateid);
 408 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
 409 extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
 410 extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
 411 extern void nfs4_schedule_state_manager(struct nfs_client *);
 412 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
 413 extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
 414 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 415 extern void nfs41_handle_server_scope(struct nfs_client *,
 416                                       struct nfs41_server_scope **);
 417 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 418 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 419 extern int nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
 420                 fmode_t, const struct nfs_lockowner *);
 421
 422 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
 423 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 424 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 425 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 426 extern void nfs_release_seqid(struct nfs_seqid *seqid);
 427 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 428
 429 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
 430
 431 extern const nfs4_stateid zero_stateid;
 432
 433 /* nfs4super.c */
 434 struct nfs_mount_info;
 435 extern struct nfs_subversion nfs_v4;
 436 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
 437 extern bool nfs4_disable_idmapping;
 438 extern unsigned short max_session_slots;
 439 extern unsigned short send_implementation_id;
 440 extern bool recover_lost_locks;
 441
 442 #define NFS4_CLIENT_ID_UNIQ_LEN         (64)
 443 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
 444
 445 /* nfs4sysctl.c */
 446 #ifdef CONFIG_SYSCTL
 447 int nfs4_register_sysctl(void);
 448 void nfs4_unregister_sysctl(void);
 449 #else
 450 static inline int nfs4_register_sysctl(void)
 451 {
 452         return 0;
 453 }
 454
 455 static inline void nfs4_unregister_sysctl(void)
 456 {
 457 }
 458 #endif
 459
 460 /* nfs4xdr.c */
 461 extern struct rpc_procinfo nfs4_procedures[];
 462
 463 struct nfs4_mount_data;
 464
 465 /* callback_xdr.c */
 466 extern struct svc_version nfs4_callback_version1;
 467 extern struct svc_version nfs4_callback_version4;
 468
 469 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
 470 {
 471         memcpy(dst, src, sizeof(*dst));
 472 }
 473
 474 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
 475 {
 476         return memcmp(dst, src, sizeof(*dst)) == 0;
 477 }
 478
 479 static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
 480 {
 481         return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
 482 }
 483
 484 #else
 485
 486 #define nfs4_close_state(a, b) do { } while (0)
 487 #define nfs4_close_sync(a, b) do { } while (0)
 488 #define nfs4_state_protect(a, b, c, d) do { } while (0)
 489 #define nfs4_state_protect_write(a, b, c, d) do { } while (0)
 490
 491 #endif /* CONFIG_NFS_V4 */
 492 #endif /* __LINUX_FS_NFS_NFS4_FS.H */