blob: d2802b1ca3b9b84d57efbadd789c019094e2bc2e [file] [log] [blame]
Trond Myklebust4ce79712005-06-22 17:16:21 +00001/*
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
14struct 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
40enum nfs4_client_state {
Trond Myklebust433fbe42006-01-03 09:55:22 +010041 NFS4CLNT_STATE_RECOVER = 0,
Trond Myklebust58d97142006-01-03 09:55:24 +010042 NFS4CLNT_LEASE_EXPIRED,
Trond Myklebust4ce79712005-06-22 17:16:21 +000043};
44
45/*
Trond Myklebustcee54fc2005-10-18 14:20:12 -070046 * struct rpc_sequence ensures that RPC calls are sent in the exact
47 * order that they appear on the list.
48 */
49struct 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
56struct nfs_seqid_counter {
57 struct rpc_sequence *sequence;
58 int flags;
59 u32 counter;
60};
61
62struct nfs_seqid {
Trond Myklebustcee54fc2005-10-18 14:20:12 -070063 struct nfs_seqid_counter *sequence;
Trond Myklebust4e513362005-10-20 14:22:41 -070064 struct list_head list;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070065};
66
67static 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
Trond Myklebust9f958ab2007-07-02 13:58:33 -040073struct nfs_unique_id {
74 struct rb_node rb_node;
75 __u64 id;
76};
77
Trond Myklebustcee54fc2005-10-18 14:20:12 -070078/*
Trond Myklebust4ce79712005-06-22 17:16:21 +000079 * 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.
Trond Myklebust4ce79712005-06-22 17:16:21 +000082 */
83struct nfs4_state_owner {
Trond Myklebust9f958ab2007-07-02 13:58:33 -040084 struct nfs_unique_id so_owner_id;
David Howellsadfa6f92006-08-22 20:06:08 -040085 struct nfs_client *so_client;
Trond Myklebust6f2e64d2007-07-06 10:53:21 -040086 struct nfs_server *so_server;
Trond Myklebust9f958ab2007-07-02 13:58:33 -040087 struct rb_node so_client_node;
Trond Myklebust4ce79712005-06-22 17:16:21 +000088
89 struct rpc_cred *so_cred; /* Associated cred */
Trond Myklebust9f958ab2007-07-02 13:58:33 -040090
91 spinlock_t so_lock;
92 atomic_t so_count;
Trond Myklebust4ce79712005-06-22 17:16:21 +000093 struct list_head so_states;
94 struct list_head so_delegations;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070095 struct nfs_seqid_counter so_seqid;
96 struct rpc_sequence so_sequence;
Trond Myklebust4ce79712005-06-22 17:16:21 +000097};
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
111struct nfs4_lock_state {
112 struct list_head ls_locks; /* Other lock stateids */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000113 struct nfs4_state * ls_state; /* Pointer to open state */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000114 fl_owner_t ls_owner; /* POSIX lock owner */
115#define NFS_LOCK_INITIALIZED 1
116 int ls_flags;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700117 struct nfs_seqid_counter ls_seqid;
Trond Myklebust9f958ab2007-07-02 13:58:33 -0400118 struct nfs_unique_id ls_id;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000119 nfs4_stateid ls_stateid;
120 atomic_t ls_count;
121};
122
123/* bits for nfs4_state->flags */
124enum {
125 LK_STATE_IN_USE,
Trond Myklebust003707c2007-07-05 18:07:55 -0400126 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 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000130};
131
132struct 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? */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000141 spinlock_t state_lock; /* Protects the lock_states list */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000142
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400143 seqlock_t seqlock; /* Protects the stateid/open_stateid */
Trond Myklebust003707c2007-07-05 18:07:55 -0400144 nfs4_stateid stateid; /* Current stateid: may be delegation */
145 nfs4_stateid open_stateid; /* OPEN stateid */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000146
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400147 /* The following 3 fields are protected by owner->so_lock */
Trond Myklebust003707c2007-07-05 18:07:55 -0400148 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 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000151 int state; /* State on the server (R,W, or RW) */
152 atomic_t count;
153};
154
155
156struct nfs4_exception {
157 long timeout;
158 int retry;
159};
160
161struct 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
166extern struct dentry_operations nfs4_dentry_operations;
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800167extern const struct inode_operations nfs4_dir_inode_operations;
J. Bruce Fields6b3b5492005-06-22 17:16:22 +0000168
169/* inode.c */
170extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
171extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
172extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
173
Trond Myklebust4ce79712005-06-22 17:16:21 +0000174
175/* nfs4proc.c */
176extern int nfs4_map_errors(int err);
David Howellsadfa6f92006-08-22 20:06:08 -0400177extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
178extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
179extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
180extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
Trond Myklebust4a35bd42007-06-05 10:31:33 -0400181extern int nfs4_do_close(struct path *path, struct nfs4_state *state);
Trond Myklebust02a913a2005-10-18 14:20:17 -0700182extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
183extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
Trond Myklebust55a97592006-06-09 09:34:19 -0400184extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
Trond Myklebust56659e92007-07-17 21:52:39 -0400185extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
Manoj Naik7aaa0b32006-06-09 09:34:23 -0400186 struct nfs4_fs_locations *fs_locations, struct page *page);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000187
188extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
189extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_ops;
190
191extern const u32 nfs4_fattr_bitmap[2];
192extern const u32 nfs4_statfs_bitmap[2];
193extern const u32 nfs4_pathconf_bitmap[2];
194extern const u32 nfs4_fsinfo_bitmap[2];
Manoj Naik830b8e32006-06-09 09:34:25 -0400195extern const u32 nfs4_fs_locations_bitmap[2];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000196
197/* nfs4renewd.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400198extern void nfs4_schedule_state_renewal(struct nfs_client *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000199extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
David Howellsadfa6f92006-08-22 20:06:08 -0400200extern void nfs4_kill_renewd(struct nfs_client *);
David Howells65f27f32006-11-22 14:55:48 +0000201extern void nfs4_renew_state(struct work_struct *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000202
203/* nfs4state.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400204struct rpc_cred *nfs4_get_renew_cred(struct nfs_client *clp);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000205
206extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
207extern void nfs4_put_state_owner(struct nfs4_state_owner *);
208extern void nfs4_drop_state_owner(struct nfs4_state_owner *);
209extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
210extern void nfs4_put_open_state(struct nfs4_state *);
Trond Myklebust4a35bd42007-06-05 10:31:33 -0400211extern void nfs4_close_state(struct path *, struct nfs4_state *, mode_t);
Trond Myklebust4cecb762005-11-04 15:32:58 -0500212extern void nfs4_state_set_mode_locked(struct nfs4_state *, mode_t);
David Howellsadfa6f92006-08-22 20:06:08 -0400213extern void nfs4_schedule_state_recovery(struct nfs_client *);
Trond Myklebustfaf5f492005-10-18 14:20:15 -0700214extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000215extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000216extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
217
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700218extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
219extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
220extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
221extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
222extern void nfs_free_seqid(struct nfs_seqid *seqid);
223
Trond Myklebust4ce79712005-06-22 17:16:21 +0000224extern const nfs4_stateid zero_stateid;
225
226/* nfs4xdr.c */
Al Viro0dbb4c62006-10-19 23:28:49 -0700227extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000228extern struct rpc_procinfo nfs4_procedures[];
229
230struct nfs4_mount_data;
231
232/* callback_xdr.c */
233extern struct svc_version nfs4_callback_version1;
234
235#else
236
Trond Myklebust4a35bd42007-06-05 10:31:33 -0400237#define nfs4_close_state(a, b, c) do { } while (0)
Trond Myklebust4ce79712005-06-22 17:16:21 +0000238
239#endif /* CONFIG_NFS_V4 */
240#endif /* __LINUX_FS_NFS_NFS4_FS.H */