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 #ifdef CONFIG_NFS_V4
  13
  14 struct idmap;
  15
  16 /*
  17  * In a seqid-mutating op, this macro controls which error return
  18  * values trigger incrementation of the seqid.
  19  *
  20  * from rfc 3010:
  21  * The client MUST monotonically increment the sequence number for the
  22  * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
  23  * operations.  This is true even in the event that the previous
  24  * operation that used the sequence number received an error.  The only
  25  * exception to this rule is if the previous operation received one of
  26  * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
  27  * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
  28  * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
  29  *
  30  */
  31 #define seqid_mutating_err(err)       \
  32 (((err) != NFSERR_STALE_CLIENTID) &&  \
  33  ((err) != NFSERR_STALE_STATEID)  &&  \
  34  ((err) != NFSERR_BAD_STATEID)    &&  \
  35  ((err) != NFSERR_BAD_SEQID)      &&  \
  36  ((err) != NFSERR_BAD_XDR)        &&  \
  37  ((err) != NFSERR_RESOURCE)       &&  \
  38  ((err) != NFSERR_NOFILEHANDLE))
  39
  40 enum nfs4_client_state {
  41         NFS4CLNT_MANAGER_RUNNING  = 0,
  42         NFS4CLNT_CHECK_LEASE,
  43         NFS4CLNT_LEASE_EXPIRED,
  44         NFS4CLNT_RECLAIM_REBOOT,
  45         NFS4CLNT_RECLAIM_NOGRACE,
  46         NFS4CLNT_DELEGRETURN,
  47         NFS4CLNT_SESSION_RESET,
  48         NFS4CLNT_RECALL_SLOT,
  49 };
  50
  51 enum nfs4_session_state {
  52         NFS4_SESSION_DRAINING,
  53 };
  54
  55 struct nfs4_minor_version_ops {
  56         u32     minor_version;
  57
  58         int     (*call_sync)(struct nfs_server *server,
  59                         struct rpc_message *msg,
  60                         struct nfs4_sequence_args *args,
  61                         struct nfs4_sequence_res *res,
  62                         int cache_reply);
  63         const struct nfs4_state_recovery_ops *reboot_recovery_ops;
  64         const struct nfs4_state_recovery_ops *nograce_recovery_ops;
  65         const struct nfs4_state_maintenance_ops *state_renewal_ops;
  66 };
  67
  68 /*
  69  * struct rpc_sequence ensures that RPC calls are sent in the exact
  70  * order that they appear on the list.
  71  */
  72 struct rpc_sequence {
  73         struct rpc_wait_queue   wait;   /* RPC call delay queue */
  74         spinlock_t lock;                /* Protects the list */
  75         struct list_head list;          /* Defines sequence of RPC calls */
  76 };
  77
  78 #define NFS_SEQID_CONFIRMED 1
  79 struct nfs_seqid_counter {
  80         struct rpc_sequence *sequence;
  81         int flags;
  82         u32 counter;
  83 };
  84
  85 struct nfs_seqid {
  86         struct nfs_seqid_counter *sequence;
  87         struct list_head list;
  88 };
  89
  90 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  91 {
  92         if (seqid_mutating_err(-status))
  93                 seqid->flags |= NFS_SEQID_CONFIRMED;
  94 }
  95
  96 struct nfs_unique_id {
  97         struct rb_node rb_node;
  98         __u64 id;
  99 };
 100
 101 /*
 102  * NFS4 state_owners and lock_owners are simply labels for ordered
 103  * sequences of RPC calls. Their sole purpose is to provide once-only
 104  * semantics by allowing the server to identify replayed requests.
 105  */
 106 struct nfs4_state_owner {
 107         struct nfs_unique_id so_owner_id;
 108         struct nfs_client    *so_client;
 109         struct nfs_server    *so_server;
 110         struct rb_node       so_client_node;
 111
 112         struct rpc_cred      *so_cred;   /* Associated cred */
 113
 114         spinlock_t           so_lock;
 115         atomic_t             so_count;
 116         unsigned long        so_flags;
 117         struct list_head     so_states;
 118         struct list_head     so_delegations;
 119         struct nfs_seqid_counter so_seqid;
 120         struct rpc_sequence  so_sequence;
 121 };
 122
 123 enum {
 124         NFS_OWNER_RECLAIM_REBOOT,
 125         NFS_OWNER_RECLAIM_NOGRACE
 126 };
 127
 128 #define NFS_LOCK_NEW            0
 129 #define NFS_LOCK_RECLAIM        1
 130 #define NFS_LOCK_EXPIRED        2
 131
 132 /*
 133  * struct nfs4_state maintains the client-side state for a given
 134  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 135  *
 136  * OPEN:
 137  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 138  * we need to know how many files are open for reading or writing on a
 139  * given inode. This information too is stored here.
 140  *
 141  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 142  */
 143
 144 struct nfs4_lock_state {
 145         struct list_head        ls_locks;       /* Other lock stateids */
 146         struct nfs4_state *     ls_state;       /* Pointer to open state */
 147         fl_owner_t              ls_owner;       /* POSIX lock owner */
 148 #define NFS_LOCK_INITIALIZED 1
 149         int                     ls_flags;
 150         struct nfs_seqid_counter        ls_seqid;
 151         struct rpc_sequence     ls_sequence;
 152         struct nfs_unique_id    ls_id;
 153         nfs4_stateid            ls_stateid;
 154         atomic_t                ls_count;
 155 };
 156
 157 /* bits for nfs4_state->flags */
 158 enum {
 159         LK_STATE_IN_USE,
 160         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 161         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 162         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 163         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 164         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 165         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 166         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 167 };
 168
 169 struct nfs4_state {
 170         struct list_head open_states;   /* List of states for the same state_owner */
 171         struct list_head inode_states;  /* List of states for the same inode */
 172         struct list_head lock_states;   /* List of subservient lock stateids */
 173
 174         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 175         struct inode *inode;            /* Pointer to the inode */
 176
 177         unsigned long flags;            /* Do we hold any locks? */
 178         spinlock_t state_lock;          /* Protects the lock_states list */
 179
 180         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 181         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 182         nfs4_stateid open_stateid;      /* OPEN stateid */
 183
 184         /* The following 3 fields are protected by owner->so_lock */
 185         unsigned int n_rdonly;          /* Number of read-only references */
 186         unsigned int n_wronly;          /* Number of write-only references */
 187         unsigned int n_rdwr;            /* Number of read/write references */
 188         fmode_t state;                  /* State on the server (R,W, or RW) */
 189         atomic_t count;
 190 };
 191
 192
 193 struct nfs4_exception {
 194         long timeout;
 195         int retry;
 196         struct nfs4_state *state;
 197 };
 198
 199 struct 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
 209 struct nfs4_state_maintenance_ops {
 210         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
 211         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 212         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 213 };
 214
 215 extern const struct dentry_operations nfs4_dentry_operations;
 216 extern const struct inode_operations nfs4_dir_inode_operations;
 217
 218 /* inode.c */
 219 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
 220 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
 221 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
 222
 223
 224 /* nfs4proc.c */
 225 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
 226 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
 227 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 228 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
 229 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
 230 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 231 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 232 extern int nfs4_do_close(struct path *path, struct nfs4_state *state, gfp_t gfp_mask, int wait);
 233 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
 234 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
 235 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 236 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
 237                 struct nfs4_fs_locations *fs_locations, struct page *page);
 238
 239 #if defined(CONFIG_NFS_V4_1)
 240 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 241 {
 242         return server->nfs_client->cl_session;
 243 }
 244
 245 extern int nfs4_setup_sequence(const struct nfs_server *server,
 246                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 247                 int cache_reply, struct rpc_task *task);
 248 extern void nfs4_destroy_session(struct nfs4_session *session);
 249 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
 250 extern int nfs4_proc_create_session(struct nfs_client *);
 251 extern int nfs4_proc_destroy_session(struct nfs4_session *);
 252 extern int nfs4_init_session(struct nfs_server *server);
 253 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 254                 struct nfs_fsinfo *fsinfo);
 255 #else /* CONFIG_NFS_v4_1 */
 256 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
 257 {
 258         return NULL;
 259 }
 260
 261 static inline int nfs4_setup_sequence(const struct nfs_server *server,
 262                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 263                 int cache_reply, struct rpc_task *task)
 264 {
 265         return 0;
 266 }
 267
 268 static inline int nfs4_init_session(struct nfs_server *server)
 269 {
 270         return 0;
 271 }
 272 #endif /* CONFIG_NFS_V4_1 */
 273
 274 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
 275
 276 extern const u32 nfs4_fattr_bitmap[2];
 277 extern const u32 nfs4_statfs_bitmap[2];
 278 extern const u32 nfs4_pathconf_bitmap[2];
 279 extern const u32 nfs4_fsinfo_bitmap[2];
 280 extern const u32 nfs4_fs_locations_bitmap[2];
 281
 282 /* nfs4renewd.c */
 283 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 284 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 285 extern void nfs4_kill_renewd(struct nfs_client *);
 286 extern void nfs4_renew_state(struct work_struct *);
 287
 288 /* nfs4state.c */
 289 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
 290 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 291 #if defined(CONFIG_NFS_V4_1)
 292 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 293 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
 294 #endif /* CONFIG_NFS_V4_1 */
 295
 296 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
 297 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 298 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 299 extern void nfs4_put_open_state(struct nfs4_state *);
 300 extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
 301 extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
 302 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 303 extern void nfs4_schedule_state_recovery(struct nfs_client *);
 304 extern void nfs4_schedule_state_manager(struct nfs_client *);
 305 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
 306 extern int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state);
 307 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 308 extern void nfs41_handle_recall_slot(struct nfs_client *clp);
 309 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 310 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 311 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
 312
 313 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
 314 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 315 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 316 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 317 extern void nfs_release_seqid(struct nfs_seqid *seqid);
 318 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 319
 320 extern const nfs4_stateid zero_stateid;
 321
 322 /* nfs4xdr.c */
 323 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
 324 extern struct rpc_procinfo nfs4_procedures[];
 325
 326 struct nfs4_mount_data;
 327
 328 /* callback_xdr.c */
 329 extern struct svc_version nfs4_callback_version1;
 330 extern struct svc_version nfs4_callback_version4;
 331
 332 #else
 333
 334 #define nfs4_close_state(a, b, c) do { } while (0)
 335 #define nfs4_close_sync(a, b, c) do { } while (0)
 336
 337 #endif /* CONFIG_NFS_V4 */
 338 #endif /* __LINUX_FS_NFS_NFS4_FS.H */