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#ifdef 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_LAYOUTRECALL,
  24        NFS4CLNT_SESSION_RESET,
  25        NFS4CLNT_RECALL_SLOT,
  26        NFS4CLNT_LEASE_CONFIRM,
  27        NFS4CLNT_SERVER_SCOPE_MISMATCH,
  28};
  29
  30enum nfs4_session_state {
  31        NFS4_SESSION_INITING,
  32        NFS4_SESSION_DRAINING,
  33};
  34
  35#define NFS4_RENEW_TIMEOUT              0x01
  36#define NFS4_RENEW_DELEGATION_CB        0x02
  37
  38struct nfs4_minor_version_ops {
  39        u32     minor_version;
  40
  41        int     (*call_sync)(struct rpc_clnt *clnt,
  42                        struct nfs_server *server,
  43                        struct rpc_message *msg,
  44                        struct nfs4_sequence_args *args,
  45                        struct nfs4_sequence_res *res,
  46                        int cache_reply);
  47        int     (*validate_stateid)(struct nfs_delegation *,
  48                        const nfs4_stateid *);
  49        int     (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
  50                        struct nfs_fsinfo *);
  51        const struct nfs4_state_recovery_ops *reboot_recovery_ops;
  52        const struct nfs4_state_recovery_ops *nograce_recovery_ops;
  53        const struct nfs4_state_maintenance_ops *state_renewal_ops;
  54};
  55
  56/*
  57 * struct rpc_sequence ensures that RPC calls are sent in the exact
  58 * order that they appear on the list.
  59 */
  60struct rpc_sequence {
  61        struct rpc_wait_queue   wait;   /* RPC call delay queue */
  62        spinlock_t lock;                /* Protects the list */
  63        struct list_head list;          /* Defines sequence of RPC calls */
  64};
  65
  66#define NFS_SEQID_CONFIRMED 1
  67struct nfs_seqid_counter {
  68        struct rpc_sequence *sequence;
  69        int flags;
  70        u32 counter;
  71};
  72
  73struct nfs_seqid {
  74        struct nfs_seqid_counter *sequence;
  75        struct list_head list;
  76};
  77
  78static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  79{
  80        if (seqid_mutating_err(-status))
  81                seqid->flags |= NFS_SEQID_CONFIRMED;
  82}
  83
  84struct nfs_unique_id {
  85        struct rb_node rb_node;
  86        __u64 id;
  87};
  88
  89/*
  90 * NFS4 state_owners and lock_owners are simply labels for ordered
  91 * sequences of RPC calls. Their sole purpose is to provide once-only
  92 * semantics by allowing the server to identify replayed requests.
  93 */
  94struct nfs4_state_owner {
  95        struct nfs_unique_id so_owner_id;
  96        struct nfs_server    *so_server;
  97        struct list_head     so_lru;
  98        unsigned long        so_expires;
  99        struct rb_node       so_server_node;
 100
 101        struct rpc_cred      *so_cred;   /* Associated cred */
 102
 103        spinlock_t           so_lock;
 104        atomic_t             so_count;
 105        unsigned long        so_flags;
 106        struct list_head     so_states;
 107        struct nfs_seqid_counter so_seqid;
 108        struct rpc_sequence  so_sequence;
 109};
 110
 111enum {
 112        NFS_OWNER_RECLAIM_REBOOT,
 113        NFS_OWNER_RECLAIM_NOGRACE
 114};
 115
 116#define NFS_LOCK_NEW            0
 117#define NFS_LOCK_RECLAIM        1
 118#define NFS_LOCK_EXPIRED        2
 119
 120/*
 121 * struct nfs4_state maintains the client-side state for a given
 122 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 123 *
 124 * OPEN:
 125 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 126 * we need to know how many files are open for reading or writing on a
 127 * given inode. This information too is stored here.
 128 *
 129 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 130 */
 131
 132struct nfs4_lock_owner {
 133        unsigned int lo_type;
 134#define NFS4_ANY_LOCK_TYPE      (0U)
 135#define NFS4_FLOCK_LOCK_TYPE    (1U << 0)
 136#define NFS4_POSIX_LOCK_TYPE    (1U << 1)
 137        union {
 138                fl_owner_t posix_owner;
 139                pid_t flock_owner;
 140        } lo_u;
 141};
 142
 143struct nfs4_lock_state {
 144        struct list_head        ls_locks;       /* Other lock stateids */
 145        struct nfs4_state *     ls_state;       /* Pointer to open state */
 146#define NFS_LOCK_INITIALIZED 1
 147        int                     ls_flags;
 148        struct nfs_seqid_counter        ls_seqid;
 149        struct rpc_sequence     ls_sequence;
 150        struct nfs_unique_id    ls_id;
 151        nfs4_stateid            ls_stateid;
 152        atomic_t                ls_count;
 153        struct nfs4_lock_owner  ls_owner;
 154};
 155
 156/* bits for nfs4_state->flags */
 157enum {
 158        LK_STATE_IN_USE,
 159        NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 160        NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 161        NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 162        NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 163        NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 164        NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 165        NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 166};
 167
 168struct nfs4_state {
 169        struct list_head open_states;   /* List of states for the same state_owner */
 170        struct list_head inode_states;  /* List of states for the same inode */
 171        struct list_head lock_states;   /* List of subservient lock stateids */
 172
 173        struct nfs4_state_owner *owner; /* Pointer to the open owner */
 174        struct inode *inode;            /* Pointer to the inode */
 175
 176        unsigned long flags;            /* Do we hold any locks? */
 177        spinlock_t state_lock;          /* Protects the lock_states list */
 178
 179        seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 180        nfs4_stateid stateid;           /* Current stateid: may be delegation */
 181        nfs4_stateid open_stateid;      /* OPEN stateid */
 182
 183        /* The following 3 fields are protected by owner->so_lock */
 184        unsigned int n_rdonly;          /* Number of read-only references */
 185        unsigned int n_wronly;          /* Number of write-only references */
 186        unsigned int n_rdwr;            /* Number of read/write references */
 187        fmode_t state;                  /* State on the server (R,W, or RW) */
 188        atomic_t count;
 189};
 190
 191
 192struct nfs4_exception {
 193        long timeout;
 194        int retry;
 195        struct nfs4_state *state;
 196        struct inode *inode;
 197};
 198
 199struct nfs4_state_recovery_ops {
 200        int owner_flag_bit;
 201        int state_flag_bit;
 202        int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 203        int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 204        int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
 205        struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
 206        int (*reclaim_complete)(struct nfs_client *);
 207};
 208
 209struct nfs4_state_maintenance_ops {
 210        int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
 211        struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 212        int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 213};
 214
 215extern const struct dentry_operations nfs4_dentry_operations;
 216extern const struct inode_operations nfs4_dir_inode_operations;
 217
 218/* nfs4proc.c */
 219extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
 220extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
 221extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 222extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 223extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 224extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
 225extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 226extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
 227                struct nfs4_fs_locations *fs_locations, struct page *page);
 228extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
 229extern const struct xattr_handler *nfs4_xattr_handlers[];
 230
 231#if defined(CONFIG_NFS_V4_1)
 232static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 233{
 234        return server->nfs_client->cl_session;
 235}
 236
 237extern int nfs4_setup_sequence(const struct nfs_server *server,
 238                struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 239                int cache_reply, struct rpc_task *task);
 240extern int nfs41_setup_sequence(struct nfs4_session *session,
 241                struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 242                int cache_reply, struct rpc_task *task);
 243extern void nfs4_destroy_session(struct nfs4_session *session);
 244extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
 245extern int nfs4_proc_create_session(struct nfs_client *);
 246extern int nfs4_proc_destroy_session(struct nfs4_session *);
 247extern int nfs4_init_session(struct nfs_server *server);
 248extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 249                struct nfs_fsinfo *fsinfo);
 250extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
 251                                  bool sync);
 252
 253static inline bool
 254is_ds_only_client(struct nfs_client *clp)
 255{
 256        return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
 257                EXCHGID4_FLAG_USE_PNFS_DS;
 258}
 259
 260static inline bool
 261is_ds_client(struct nfs_client *clp)
 262{
 263        return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
 264}
 265#else /* CONFIG_NFS_v4_1 */
 266static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 267{
 268        return NULL;
 269}
 270
 271static inline int nfs4_setup_sequence(const struct nfs_server *server,
 272                struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 273                int cache_reply, struct rpc_task *task)
 274{
 275        return 0;
 276}
 277
 278static inline int nfs4_init_session(struct nfs_server *server)
 279{
 280        return 0;
 281}
 282
 283static inline bool
 284is_ds_only_client(struct nfs_client *clp)
 285{
 286        return false;
 287}
 288
 289static inline bool
 290is_ds_client(struct nfs_client *clp)
 291{
 292        return false;
 293}
 294#endif /* CONFIG_NFS_V4_1 */
 295
 296extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
 297
 298extern const u32 nfs4_fattr_bitmap[2];
 299extern const u32 nfs4_statfs_bitmap[2];
 300extern const u32 nfs4_pathconf_bitmap[2];
 301extern const u32 nfs4_fsinfo_bitmap[3];
 302extern const u32 nfs4_fs_locations_bitmap[2];
 303
 304/* nfs4renewd.c */
 305extern void nfs4_schedule_state_renewal(struct nfs_client *);
 306extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 307extern void nfs4_kill_renewd(struct nfs_client *);
 308extern void nfs4_renew_state(struct work_struct *);
 309
 310/* nfs4state.c */
 311struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
 312struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 313#if defined(CONFIG_NFS_V4_1)
 314struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 315struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
 316extern void nfs4_schedule_session_recovery(struct nfs4_session *);
 317#else
 318static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
 319{
 320}
 321#endif /* CONFIG_NFS_V4_1 */
 322
 323extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
 324extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 325extern void nfs4_purge_state_owners(struct nfs_server *);
 326extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 327extern void nfs4_put_open_state(struct nfs4_state *);
 328extern void nfs4_close_state(struct nfs4_state *, fmode_t);
 329extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
 330extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 331extern void nfs_inode_find_state_and_recover(struct inode *inode,
 332                const nfs4_stateid *stateid);
 333extern void nfs4_schedule_lease_recovery(struct nfs_client *);
 334extern void nfs4_schedule_state_manager(struct nfs_client *);
 335extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
 336extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
 337extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 338extern void nfs41_handle_recall_slot(struct nfs_client *clp);
 339extern void nfs41_handle_server_scope(struct nfs_client *,
 340                                      struct server_scope **);
 341extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 342extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 343extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t, pid_t);
 344
 345extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
 346extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 347extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 348extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 349extern void nfs_release_seqid(struct nfs_seqid *seqid);
 350extern void nfs_free_seqid(struct nfs_seqid *seqid);
 351
 352extern const nfs4_stateid zero_stateid;
 353
 354/* nfs4xdr.c */
 355extern struct rpc_procinfo nfs4_procedures[];
 356
 357struct nfs4_mount_data;
 358
 359/* callback_xdr.c */
 360extern struct svc_version nfs4_callback_version1;
 361extern struct svc_version nfs4_callback_version4;
 362
 363#else
 364
 365#define nfs4_close_state(a, b) do { } while (0)
 366#define nfs4_close_sync(a, b) do { } while (0)
 367
 368#endif /* CONFIG_NFS_V4 */
 369#endif /* __LINUX_FS_NFS_NFS4_FS.H */
 370