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 /*
 112  * struct nfs4_state maintains the client-side state for a given
 113  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 114  *
 115  * OPEN:
 116  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 117  * we need to know how many files are open for reading or writing on a
 118  * given inode. This information too is stored here.
 119  *
 120  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 121  */
 122
 123 struct nfs4_lock_state {
 124         struct list_head        ls_locks;       /* Other lock stateids */
 125         struct nfs4_state *     ls_state;       /* Pointer to open state */
 126         fl_owner_t              ls_owner;       /* POSIX lock owner */
 127 #define NFS_LOCK_INITIALIZED 1
 128         int                     ls_flags;
 129         struct nfs_seqid_counter        ls_seqid;
 130         struct rpc_sequence     ls_sequence;
 131         struct nfs_unique_id    ls_id;
 132         nfs4_stateid            ls_stateid;
 133         atomic_t                ls_count;
 134 };
 135
 136 /* bits for nfs4_state->flags */
 137 enum {
 138         LK_STATE_IN_USE,
 139         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
 140         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
 141         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
 142         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
 143         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
 144         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
 145 };
 146
 147 struct nfs4_state {
 148         struct list_head open_states;   /* List of states for the same state_owner */
 149         struct list_head inode_states;  /* List of states for the same inode */
 150         struct list_head lock_states;   /* List of subservient lock stateids */
 151
 152         struct nfs4_state_owner *owner; /* Pointer to the open owner */
 153         struct inode *inode;            /* Pointer to the inode */
 154
 155         unsigned long flags;            /* Do we hold any locks? */
 156         spinlock_t state_lock;          /* Protects the lock_states list */
 157
 158         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
 159         nfs4_stateid stateid;           /* Current stateid: may be delegation */
 160         nfs4_stateid open_stateid;      /* OPEN stateid */
 161
 162         /* The following 3 fields are protected by owner->so_lock */
 163         unsigned int n_rdonly;          /* Number of read-only references */
 164         unsigned int n_wronly;          /* Number of write-only references */
 165         unsigned int n_rdwr;            /* Number of read/write references */
 166         fmode_t state;                  /* State on the server (R,W, or RW) */
 167         atomic_t count;
 168 };
 169
 170
 171 struct nfs4_exception {
 172         long timeout;
 173         int retry;
 174         struct nfs4_state *state;
 175 };
 176
 177 struct nfs4_state_recovery_ops {
 178         int owner_flag_bit;
 179         int state_flag_bit;
 180         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
 181         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
 182         int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
 183         struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
 184         int (*reclaim_complete)(struct nfs_client *);
 185 };
 186
 187 struct nfs4_state_maintenance_ops {
 188         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
 189         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
 190         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
 191 };
 192
 193 extern const struct dentry_operations nfs4_dentry_operations;
 194 extern const struct inode_operations nfs4_dir_inode_operations;
 195
 196 /* inode.c */
 197 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
 198 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
 199 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
 200
 201
 202 /* nfs4proc.c */
 203 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
 204 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
 205 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
 206 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
 207 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
 208 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
 209 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
 210 extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
 211 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
 212 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
 213 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
 214 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
 215                 struct nfs4_fs_locations *fs_locations, struct page *page);
 216
 217 extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[];
 218 extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[];
 219 #if defined(CONFIG_NFS_V4_1)
 220 extern int nfs4_setup_sequence(struct nfs_client *clp,
 221                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 222                 int cache_reply, struct rpc_task *task);
 223 extern void nfs4_destroy_session(struct nfs4_session *session);
 224 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
 225 extern int nfs4_proc_create_session(struct nfs_client *);
 226 extern int nfs4_proc_destroy_session(struct nfs4_session *);
 227 extern int nfs4_init_session(struct nfs_server *server);
 228 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
 229                 struct nfs_fsinfo *fsinfo);
 230 #else /* CONFIG_NFS_v4_1 */
 231 static inline int nfs4_setup_sequence(struct nfs_client *clp,
 232                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
 233                 int cache_reply, struct rpc_task *task)
 234 {
 235         return 0;
 236 }
 237
 238 static inline int nfs4_init_session(struct nfs_server *server)
 239 {
 240         return 0;
 241 }
 242 #endif /* CONFIG_NFS_V4_1 */
 243
 244 extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[];
 245
 246 extern const u32 nfs4_fattr_bitmap[2];
 247 extern const u32 nfs4_statfs_bitmap[2];
 248 extern const u32 nfs4_pathconf_bitmap[2];
 249 extern const u32 nfs4_fsinfo_bitmap[2];
 250 extern const u32 nfs4_fs_locations_bitmap[2];
 251
 252 /* nfs4renewd.c */
 253 extern void nfs4_schedule_state_renewal(struct nfs_client *);
 254 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
 255 extern void nfs4_kill_renewd(struct nfs_client *);
 256 extern void nfs4_renew_state(struct work_struct *);
 257
 258 /* nfs4state.c */
 259 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
 260 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
 261 #if defined(CONFIG_NFS_V4_1)
 262 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
 263 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
 264 #endif /* CONFIG_NFS_V4_1 */
 265
 266 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
 267 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
 268 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
 269 extern void nfs4_put_open_state(struct nfs4_state *);
 270 extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
 271 extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
 272 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
 273 extern void nfs4_schedule_state_recovery(struct nfs_client *);
 274 extern void nfs4_schedule_state_manager(struct nfs_client *);
 275 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
 276 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
 277 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
 278 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
 279 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
 280
 281 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
 282 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
 283 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
 284 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
 285 extern void nfs_free_seqid(struct nfs_seqid *seqid);
 286
 287 extern const nfs4_stateid zero_stateid;
 288
 289 /* nfs4xdr.c */
 290 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
 291 extern struct rpc_procinfo nfs4_procedures[];
 292
 293 struct nfs4_mount_data;
 294
 295 /* callback_xdr.c */
 296 extern struct svc_version nfs4_callback_version1;
 297 extern struct svc_version nfs4_callback_version4;
 298
 299 #else
 300
 301 #define nfs4_close_state(a, b, c) do { } while (0)
 302 #define nfs4_close_sync(a, b, c) do { } while (0)
 303
 304 #endif /* CONFIG_NFS_V4 */
 305 #endif /* __LINUX_FS_NFS_NFS4_FS.H */