LXR linux/fs/nfs/nfs4

   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
  14struct idmap;
  15
  16enum nfs4_client_state {
  17        NFS4CLNT_MANAGER_RUNNING  = 0,
  18        NFS4CLNT_CHECK_LEASE,
  19        NFS4CLNT_LEASE_EXPIRED,
  20        NFS4CLNT_RECLAIM_REBOOT,
  21        NFS4CLNT_RECLAIM_NOGRACE,
  22        NFS4CLNT_DELEGRETURN,
  23        NFS4CLNT_SESSION_RESET,
  24        NFS4CLNT_RECALL_SLOT,
  25        NFS4CLNT_LEASE_CONFIRM,
  26        NFS4CLNT_SERVER_SCOPE_MISMATCH,
  27        NFS4CLNT_PURGE_STATE,
  28        NFS4CLNT_BIND_CONN_TO_SESSION,
  29};
  30
  31enum nfs4_session_state {
  32        NFS4_SESSION_INITING,
  33        NFS4_SESSION_DRAINING,
  34};
  35
  36#define NFS4_RENEW_TIMEOUT              0x01
  37#define NFS4_RENEW_DELEGATION_CB        0x02
  38
  39struct nfs4_minor_version_ops {
  40        u32     minor_version;
  41
  42        int     (*call_sync)(struct rpc_clnt *clnt,
  43                        struct nfs_server *server,
  44                        struct rpc_message *msg,
  45                        struct nfs4_sequence_args *args,
  46                        struct nfs4_sequence_res *res,
  47                        int cache_reply);
  48        bool    (*match_stateid)(const nfs4_stateid *,
  49                        const nfs4_stateid *);
  50        int     (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
  51                        struct nfs_fsinfo *);
  52        const struct nfs4_state_recovery_ops *reboot_recovery_ops;
  53        const struct nfs4_state_recovery_ops *nograce_recovery_ops;
  54        const struct nfs4_state_maintenance_ops *state_renewal_ops;
  55};
  56
  57#define NFS_SEQID_CONFIRMED 1
  58struct nfs_seqid_counter {
  59        ktime_t create_time;
  60        int owner_id;
  61        int flags;
  62        u32 counter;
  63        spinlock_t lock;                /* Protects the list */
  64        struct list_head list;          /* Defines sequence of RPC calls */
  65        struct rpc_wait_queue   wait;   /* RPC call delay queue */
  66};
  67
  68struct nfs_seqid {
  69        struct nfs_seqid_counter *sequence;
  70        struct list_head list;
  71        struct rpc_task *task;
  72};
  73
  74static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  75{
  76        if (seqid_mutating_err(-status))
  77                seqid->flags |= NFS_SEQID_CONFIRMED;
  78}
  79
  80/*
  81 * NFS4 state_owners and lock_owners are simply labels for ordered
  82 * sequences of RPC calls. Their sole purpose is to provide once-only
  83 * semantics by allowing the server to identify replayed requests.
  84 */
  85struct nfs4_state_owner {
  86        struct nfs_server    *so_server;
  87        struct list_head     so_lru;
  88        unsigned long        so_expires;
  89        struct rb_node       so_server_node;
  90
  91        struct rpc_cred      *so_cred;   /* Associated cred */
  92
  93        spinlock_t           so_lock;
  94        atomic_t             so_count;
  95        unsigned long        so_flags;
  96        struct list_head     so_states;
  97        struct nfs_seqid_counter so_seqid;
  98};
  99
 100enum {
 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
 121struct 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
 132struct 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 1
 136        int                     ls_flags;
 137        struct nfs_seqid_counter        ls_seqid;
 138        nfs4_stateid            ls_stateid;
 139        atomic_t                ls_count;
 140        struct nfs4_lock_owner  ls_owner;
 141};
 142
 143/* bits for nfs4_state->flags */
 144enum {
 145        LK_STATE_IN_USE,
 146        NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 147        NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 148        NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 149        NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 150        NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 151        NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 152        NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 153};
 154
 155struct nfs4_state {
 156        struct list_head open_states;   /* List of states for the same state_owner */
 157        struct list_head inode_states;  /* List of states for the same inode */
 158        struct list_head lock_states;   /* List of subservient lock stateids */
 159
 160        struct nfs4_state_owner *owner; /* Pointer to the open owner */
 161        struct inode *inode;            /* Pointer to the inode */
 162
 163        unsigned long flags;            /* Do we hold any locks? */
 164        spinlock_t state_lock;          /* Protects the lock_states list */
 165
 166        seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 167        nfs4_stateid stateid;           /* Current stateid: may be delegation */
 168        nfs4_stateid open_stateid;      /* OPEN stateid */
 169
 170        /* The following 3 fields are protected by owner->so_lock */
 171        unsigned int n_rdonly;          /* Number of read-only references */
 172        unsigned int n_wronly;          /* Number of write-only references */
 173        unsigned int n_rdwr;            /* Number of read/write references */
 174        fmode_t state;                  /* State on the server (R,W, or RW) */
 175        atomic_t count;
 176};
 177
 178
 179struct nfs4_exception {
 180        long timeout;
 181        int retry;
 182        struct nfs4_state *state;
 183        struct inode *inode;
 184};
 185
 186struct nfs4_state_recovery_ops {
 187        int owner_flag_bit;
 188        int state_flag_bit;
 189        int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 190        int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 191        int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
 192        struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
 193        int (*reclaim_complete)(struct nfs_client *);
 194};
 195
 196struct nfs4_state_maintenance_ops {
 197        int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
 198        struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 199        int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 200};
 201
 202extern const struct dentry_operations nfs4_dentry_operations;
 203
 204/* dir.c */
 205int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
 206                    unsigned, umode_t, int *);
 207
 208/* super.c */
 209extern struct file_system_type nfs4_fs_type;
 210
 211/* nfs4namespace.c */
 212rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
 213struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
 214struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
 215                               struct nfs_fh *, struct nfs_fattr *);
 216
 217/* nfs4proc.c */
 218extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
 219extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
 220extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
 221extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
 222extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 223extern int nfs4_destroy_clientid(struct nfs_client *clp);
 224extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 225extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 226extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
 227extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 228extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
 229                                  struct nfs4_fs_locations *, struct page *);
 230extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
 231                            struct nfs_fh *, struct nfs_fattr *);
 232extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
 233extern int nfs4_release_lockowner(struct nfs4_lock_state *);
 234extern const struct xattr_handler *nfs4_xattr_handlers[];
 235
 236#if defined(CONFIG_NFS_V4_1)
 237static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 238{
 239        return server->nfs_client->cl_session;
 240}
 241
 242extern bool nfs4_set_task_privileged(struct rpc_task *task, void *dummy);
 243extern int nfs4_setup_sequence(const struct nfs_server *server,
 244                struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 245                struct rpc_task *task);
 246extern int nfs41_setup_sequence(struct nfs4_session *session,
 247                struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 248                struct rpc_task *task);
 249extern void nfs4_destroy_session(struct nfs4_session *session);
 250extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
 251extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
 252extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
 253extern int nfs4_init_session(struct nfs_server *server);
 254extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 255                struct nfs_fsinfo *fsinfo);
 256extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
 257                                  bool sync);
 258
 259static inline bool
 260is_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
 266static inline bool
 267is_ds_client(struct nfs_client *clp)
 268{
 269        return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
 270}
 271#else /* CONFIG_NFS_v4_1 */
 272static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 273{
 274        return NULL;
 275}
 276
 277static inline int nfs4_setup_sequence(const struct nfs_server *server,
 278                struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 279                struct rpc_task *task)
 280{
 281        return 0;
 282}
 283
 284static inline int nfs4_init_session(struct nfs_server *server)
 285{
 286        return 0;
 287}
 288
 289static inline bool
 290is_ds_only_client(struct nfs_client *clp)
 291{
 292        return false;
 293}
 294
 295static inline bool
 296is_ds_client(struct nfs_client *clp)
 297{
 298        return false;
 299}
 300#endif /* CONFIG_NFS_V4_1 */
 301
 302extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
 303
 304extern const u32 nfs4_fattr_bitmap[3];
 305extern const u32 nfs4_statfs_bitmap[2];
 306extern const u32 nfs4_pathconf_bitmap[2];
 307extern const u32 nfs4_fsinfo_bitmap[3];
 308extern const u32 nfs4_fs_locations_bitmap[2];
 309
 310void nfs4_free_client(struct nfs_client *);
 311
 312struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
 313
 314/* nfs4renewd.c */
 315extern void nfs4_schedule_state_renewal(struct nfs_client *);
 316extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 317extern void nfs4_kill_renewd(struct nfs_client *);
 318extern void nfs4_renew_state(struct work_struct *);
 319
 320/* nfs4state.c */
 321struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
 322struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 323#if defined(CONFIG_NFS_V4_1)
 324struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 325struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
 326extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
 327#else
 328static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
 329{
 330}
 331#endif /* CONFIG_NFS_V4_1 */
 332
 333extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
 334extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 335extern void nfs4_purge_state_owners(struct nfs_server *);
 336extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 337extern void nfs4_put_open_state(struct nfs4_state *);
 338extern void nfs4_close_state(struct nfs4_state *, fmode_t);
 339extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
 340extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 341extern void nfs_inode_find_state_and_recover(struct inode *inode,
 342                const nfs4_stateid *stateid);
 343extern void nfs4_schedule_lease_recovery(struct nfs_client *);
 344extern void nfs4_schedule_state_manager(struct nfs_client *);
 345extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
 346extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
 347extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 348extern void nfs41_handle_recall_slot(struct nfs_client *clp);
 349extern void nfs41_handle_server_scope(struct nfs_client *,
 350                                      struct nfs41_server_scope **);
 351extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 352extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 353extern void nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
 354                fmode_t, fl_owner_t, pid_t);
 355
 356extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
 357extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 358extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 359extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 360extern void nfs_release_seqid(struct nfs_seqid *seqid);
 361extern void nfs_free_seqid(struct nfs_seqid *seqid);
 362
 363extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
 364
 365extern const nfs4_stateid zero_stateid;
 366
 367/* nfs4super.c */
 368struct nfs_mount_info;
 369extern struct nfs_subversion nfs_v4;
 370struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
 371extern bool nfs4_disable_idmapping;
 372extern unsigned short max_session_slots;
 373extern unsigned short send_implementation_id;
 374
 375/* nfs4sysctl.c */
 376#ifdef CONFIG_SYSCTL
 377int nfs4_register_sysctl(void);
 378void nfs4_unregister_sysctl(void);
 379#else
 380static inline int nfs4_register_sysctl(void)
 381{
 382        return 0;
 383}
 384
 385static inline void nfs4_unregister_sysctl(void)
 386{
 387}
 388#endif
 389
 390/* nfs4xdr.c */
 391extern struct rpc_procinfo nfs4_procedures[];
 392
 393struct nfs4_mount_data;
 394
 395/* callback_xdr.c */
 396extern struct svc_version nfs4_callback_version1;
 397extern struct svc_version nfs4_callback_version4;
 398
 399static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
 400{
 401        memcpy(dst, src, sizeof(*dst));
 402}
 403
 404static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
 405{
 406        return memcmp(dst, src, sizeof(*dst)) == 0;
 407}
 408
 409#else
 410
 411#define nfs4_close_state(a, b) do { } while (0)
 412#define nfs4_close_sync(a, b) do { } while (0)
 413
 414#endif /* CONFIG_NFS_V4 */
 415#endif /* __LINUX_FS_NFS_NFS4_FS.H */
 416