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_SESSION_DRAINING,
  49 };
  50
  51 /*
  52  * struct rpc_sequence ensures that RPC calls are sent in the exact
  53  * order that they appear on the list.
  54  */
  55 struct rpc_sequence {
  56         struct rpc_wait_queue   wait;   /* RPC call delay queue */
  57         spinlock_t lock;                /* Protects the list */
  58         struct list_head list;          /* Defines sequence of RPC calls */
  59 };
  60
  61 #define NFS_SEQID_CONFIRMED 1
  62 struct nfs_seqid_counter {
  63         struct rpc_sequence *sequence;
  64         int flags;
  65         u32 counter;
  66 };
  67
  68 struct nfs_seqid {
  69         struct nfs_seqid_counter *sequence;
  70         struct list_head list;
  71 };
  72
  73 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  74 {
  75         if (seqid_mutating_err(-status))
  76                 seqid->flags |= NFS_SEQID_CONFIRMED;
  77 }
  78
  79 struct nfs_unique_id {
  80         struct rb_node rb_node;
  81         __u64 id;
  82 };
  83
  84 /*
  85  * NFS4 state_owners and lock_owners are simply labels for ordered
  86  * sequences of RPC calls. Their sole purpose is to provide once-only
  87  * semantics by allowing the server to identify replayed requests.
  88  */
  89 struct nfs4_state_owner {
  90         struct nfs_unique_id so_owner_id;
  91         struct nfs_client    *so_client;
  92         struct nfs_server    *so_server;
  93         struct rb_node       so_client_node;
  94
  95         struct rpc_cred      *so_cred;   /* Associated cred */
  96
  97         spinlock_t           so_lock;
  98         atomic_t             so_count;
  99         unsigned long        so_flags;
 100         struct list_head     so_states;
 101         struct list_head     so_delegations;
 102         struct nfs_seqid_counter so_seqid;
 103         struct rpc_sequence  so_sequence;
 104 };
 105
 106 enum {
 107         NFS_OWNER_RECLAIM_REBOOT,
 108         NFS_OWNER_RECLAIM_NOGRACE
 109 };
 110
 111 #define NFS_LOCK_NEW            0
 112 #define NFS_LOCK_RECLAIM        1
 113 #define NFS_LOCK_EXPIRED        2
 114
 115 /*
 116  * struct nfs4_state maintains the client-side state for a given
 117  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 118  *
 119  * OPEN:
 120  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 121  * we need to know how many files are open for reading or writing on a
 122  * given inode. This information too is stored here.
 123  *
 124  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 125  */
 126
 127 struct nfs4_lock_state {
 128         struct list_head        ls_locks;       /* Other lock stateids */
 129         struct nfs4_state *     ls_state;       /* Pointer to open state */
 130         fl_owner_t              ls_owner;       /* POSIX lock owner */
 131 #define NFS_LOCK_INITIALIZED 1
 132         int                     ls_flags;
 133         struct nfs_seqid_counter        ls_seqid;
 134         struct rpc_sequence     ls_sequence;
 135         struct nfs_unique_id    ls_id;
 136         nfs4_stateid            ls_stateid;
 137         atomic_t                ls_count;
 138 };
 139
 140 /* bits for nfs4_state->flags */
 141 enum {
 142         LK_STATE_IN_USE,
 143         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 144         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 145         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 146         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 147         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 148         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 149         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
 150 };
 151
 152 struct nfs4_state {
 153         struct list_head open_states;   /* List of states for the same state_owner */
 154         struct list_head inode_states;  /* List of states for the same inode */
 155         struct list_head lock_states;   /* List of subservient lock stateids */
 156
 157         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 158         struct inode *inode;            /* Pointer to the inode */
 159
 160         unsigned long flags;            /* Do we hold any locks? */
 161         spinlock_t state_lock;          /* Protects the lock_states list */
 162
 163         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 164         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 165         nfs4_stateid open_stateid;      /* OPEN stateid */
 166
 167         /* The following 3 fields are protected by owner->so_lock */
 168         unsigned int n_rdonly;          /* Number of read-only references */
 169         unsigned int n_wronly;          /* Number of write-only references */
 170         unsigned int n_rdwr;            /* Number of read/write references */
 171         fmode_t state;                  /* State on the server (R,W, or RW) */
 172         atomic_t count;
 173 };
 174
 175
 176 struct nfs4_exception {
 177         long timeout;
 178         int retry;
 179         struct nfs4_state *state;
 180 };
 181
 182 struct nfs4_state_recovery_ops {
 183         int owner_flag_bit;
 184         int state_flag_bit;
 185         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 186         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 187         int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
 188         struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
 189         int (*reclaim_complete)(struct nfs_client *);
 190 };
 191
 192 struct nfs4_state_maintenance_ops {
 193         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
 194         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 195         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 196 };
 197
 198 extern const struct dentry_operations nfs4_dentry_operations;
 199 extern const struct inode_operations nfs4_dir_inode_operations;
 200
 201 /* inode.c */
 202 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
 203 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
 204 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
 205
 206
 207 /* nfs4proc.c */
 208 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
 209 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
 210 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 211 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
 212 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
 213 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 214 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 215 extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
 216 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
 217 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
 218 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 219 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
 220                 struct nfs4_fs_locations *fs_locations, struct page *page);
 221
 222 extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[];
 223 extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[];
 224 #if defined(CONFIG_NFS_V4_1)
 225 extern int nfs4_setup_sequence(struct nfs_client *clp,
 226                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 227                 int cache_reply, struct rpc_task *task);
 228 extern void nfs4_destroy_session(struct nfs4_session *session);
 229 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
 230 extern int nfs4_proc_create_session(struct nfs_client *);
 231 extern int nfs4_proc_destroy_session(struct nfs4_session *);
 232 extern int nfs4_init_session(struct nfs_server *server);
 233 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 234                 struct nfs_fsinfo *fsinfo);
 235 #else /* CONFIG_NFS_v4_1 */
 236 static inline int nfs4_setup_sequence(struct nfs_client *clp,
 237                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 238                 int cache_reply, struct rpc_task *task)
 239 {
 240         return 0;
 241 }
 242
 243 static inline int nfs4_init_session(struct nfs_server *server)
 244 {
 245         return 0;
 246 }
 247 #endif /* CONFIG_NFS_V4_1 */
 248
 249 extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[];
 250
 251 extern const u32 nfs4_fattr_bitmap[2];
 252 extern const u32 nfs4_statfs_bitmap[2];
 253 extern const u32 nfs4_pathconf_bitmap[2];
 254 extern const u32 nfs4_fsinfo_bitmap[2];
 255 extern const u32 nfs4_fs_locations_bitmap[2];
 256
 257 /* nfs4renewd.c */
 258 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 259 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 260 extern void nfs4_kill_renewd(struct nfs_client *);
 261 extern void nfs4_renew_state(struct work_struct *);
 262
 263 /* nfs4state.c */
 264 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
 265 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 266 #if defined(CONFIG_NFS_V4_1)
 267 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 268 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
 269 #endif /* CONFIG_NFS_V4_1 */
 270
 271 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
 272 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 273 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 274 extern void nfs4_put_open_state(struct nfs4_state *);
 275 extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
 276 extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
 277 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 278 extern void nfs4_schedule_state_recovery(struct nfs_client *);
 279 extern void nfs4_schedule_state_manager(struct nfs_client *);
 280 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
 281 extern int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state);
 282 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 283 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 284 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 285 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
 286
 287 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
 288 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 289 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 290 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 291 extern void nfs_release_seqid(struct nfs_seqid *seqid);
 292 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 293
 294 extern const nfs4_stateid zero_stateid;
 295
 296 /* nfs4xdr.c */
 297 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
 298 extern struct rpc_procinfo nfs4_procedures[];
 299
 300 struct nfs4_mount_data;
 301
 302 /* callback_xdr.c */
 303 extern struct svc_version nfs4_callback_version1;
 304 extern struct svc_version nfs4_callback_version4;
 305
 306 #else
 307
 308 #define nfs4_close_state(a, b, c) do { } while (0)
 309 #define nfs4_close_sync(a, b, c) do { } while (0)
 310
 311 #endif /* CONFIG_NFS_V4 */
 312 #endif /* __LINUX_FS_NFS_NFS4_FS.H */