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