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_STATE_RECOVER  = 0,
  42         NFS4CLNT_LEASE_EXPIRED,
  43 };
  44
  45 /*
  46  * struct rpc_sequence ensures that RPC calls are sent in the exact
  47  * order that they appear on the list.
  48  */
  49 struct rpc_sequence {
  50         struct rpc_wait_queue   wait;   /* RPC call delay queue */
  51         spinlock_t lock;                /* Protects the list */
  52         struct list_head list;          /* Defines sequence of RPC calls */
  53 };
  54
  55 #define NFS_SEQID_CONFIRMED 1
  56 struct nfs_seqid_counter {
  57         struct rpc_sequence *sequence;
  58         int flags;
  59         u32 counter;
  60 };
  61
  62 struct nfs_seqid {
  63         struct nfs_seqid_counter *sequence;
  64         struct list_head list;
  65 };
  66
  67 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
  68 {
  69         if (seqid_mutating_err(-status))
  70                 seqid->flags |= NFS_SEQID_CONFIRMED;
  71 }
  72
  73 struct nfs_unique_id {
  74         struct rb_node rb_node;
  75         __u64 id;
  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_unique_id so_owner_id;
  85         struct nfs_client    *so_client;
  86         struct nfs_server    *so_server;
  87         struct rb_node       so_client_node;
  88
  89         struct rpc_cred      *so_cred;   /* Associated cred */
  90
  91         spinlock_t           so_lock;
  92         atomic_t             so_count;
  93         struct list_head     so_states;
  94         struct list_head     so_delegations;
  95         struct nfs_seqid_counter so_seqid;
  96         struct rpc_sequence  so_sequence;
  97 };
  98
  99 /*
 100  * struct nfs4_state maintains the client-side state for a given
 101  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 102  *
 103  * OPEN:
 104  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 105  * we need to know how many files are open for reading or writing on a
 106  * given inode. This information too is stored here.
 107  *
 108  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 109  */
 110
 111 struct nfs4_lock_state {
 112         struct list_head        ls_locks;       /* Other lock stateids */
 113         struct nfs4_state *     ls_state;       /* Pointer to open state */
 114         fl_owner_t              ls_owner;       /* POSIX lock owner */
 115 #define NFS_LOCK_INITIALIZED 1
 116         int                     ls_flags;
 117         struct nfs_seqid_counter        ls_seqid;
 118         struct nfs_unique_id    ls_id;
 119         nfs4_stateid            ls_stateid;
 120         atomic_t                ls_count;
 121 };
 122
 123 /* bits for nfs4_state->flags */
 124 enum {
 125         LK_STATE_IN_USE,
 126         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 127         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 128         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 129         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 130 };
 131
 132 struct nfs4_state {
 133         struct list_head open_states;   /* List of states for the same state_owner */
 134         struct list_head inode_states;  /* List of states for the same inode */
 135         struct list_head lock_states;   /* List of subservient lock stateids */
 136
 137         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 138         struct inode *inode;            /* Pointer to the inode */
 139
 140         unsigned long flags;            /* Do we hold any locks? */
 141         spinlock_t state_lock;          /* Protects the lock_states list */
 142
 143         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 144         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 145         nfs4_stateid open_stateid;      /* OPEN stateid */
 146
 147         /* The following 3 fields are protected by owner->so_lock */
 148         unsigned int n_rdonly;          /* Number of read-only references */
 149         unsigned int n_wronly;          /* Number of write-only references */
 150         unsigned int n_rdwr;            /* Number of read/write references */
 151         int state;                      /* State on the server (R,W, or RW) */
 152         atomic_t count;
 153 };
 154
 155
 156 struct nfs4_exception {
 157         long timeout;
 158         int retry;
 159 };
 160
 161 struct nfs4_state_recovery_ops {
 162         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 163         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 164 };
 165
 166 extern struct dentry_operations nfs4_dentry_operations;
 167 extern const struct inode_operations nfs4_dir_inode_operations;
 168
 169 /* inode.c */
 170 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
 171 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
 172 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
 173
 174
 175 /* nfs4proc.c */
 176 extern int nfs4_map_errors(int err);
 177 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
 178 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
 179 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
 180 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
 181 extern int nfs4_do_close(struct path *path, struct nfs4_state *state);
 182 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
 183 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
 184 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 185 extern int nfs4_proc_fs_locations(struct inode *dir, struct qstr *name,
 186                 struct nfs4_fs_locations *fs_locations, struct page *page);
 187
 188 extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
 189 extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_ops;
 190
 191 extern const u32 nfs4_fattr_bitmap[2];
 192 extern const u32 nfs4_statfs_bitmap[2];
 193 extern const u32 nfs4_pathconf_bitmap[2];
 194 extern const u32 nfs4_fsinfo_bitmap[2];
 195 extern const u32 nfs4_fs_locations_bitmap[2];
 196
 197 /* nfs4renewd.c */
 198 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 199 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 200 extern void nfs4_kill_renewd(struct nfs_client *);
 201 extern void nfs4_renew_state(struct work_struct *);
 202
 203 /* nfs4state.c */
 204 struct rpc_cred *nfs4_get_renew_cred(struct nfs_client *clp);
 205
 206 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
 207 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 208 extern void nfs4_drop_state_owner(struct nfs4_state_owner *);
 209 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 210 extern void nfs4_put_open_state(struct nfs4_state *);
 211 extern void nfs4_close_state(struct path *, struct nfs4_state *, mode_t);
 212 extern void nfs4_state_set_mode_locked(struct nfs4_state *, mode_t);
 213 extern void nfs4_schedule_state_recovery(struct nfs_client *);
 214 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 215 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 216 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
 217
 218 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
 219 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 220 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 221 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 222 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 223
 224 extern const nfs4_stateid zero_stateid;
 225
 226 /* nfs4xdr.c */
 227 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
 228 extern struct rpc_procinfo nfs4_procedures[];
 229
 230 struct nfs4_mount_data;
 231
 232 /* callback_xdr.c */
 233 extern struct svc_version nfs4_callback_version1;
 234
 235 #else
 236
 237 #define nfs4_close_state(a, b, c) do { } while (0)
 238
 239 #endif /* CONFIG_NFS_V4 */
 240 #endif /* __LINUX_FS_NFS_NFS4_FS.H */