blob: 50dd55069d3dd7394c2e5768ac2086ac35c414de [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 Myklebuste005e802008-12-23 15:21:48 -050041 NFS4CLNT_MANAGER_RUNNING = 0,
Trond Myklebuste598d842008-12-23 15:21:42 -050042 NFS4CLNT_CHECK_LEASE,
Trond Myklebust58d97142006-01-03 09:55:24 +010043 NFS4CLNT_LEASE_EXPIRED,
Trond Myklebustb79a4a12008-12-23 15:21:41 -050044 NFS4CLNT_RECLAIM_REBOOT,
45 NFS4CLNT_RECLAIM_NOGRACE,
Trond Myklebust707fb4b2008-12-23 15:21:47 -050046 NFS4CLNT_DELEGRETURN,
Andy Adamson6df08182009-12-04 15:55:05 -050047 NFS4CLNT_SESSION_RESET,
Andy Adamsonea028ac2009-12-04 15:55:38 -050048 NFS4CLNT_SESSION_DRAINING,
Trond Myklebust4ce79712005-06-22 17:16:21 +000049};
50
51/*
Trond Myklebustcee54fc2005-10-18 14:20:12 -070052 * struct rpc_sequence ensures that RPC calls are sent in the exact
53 * order that they appear on the list.
54 */
55struct 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
62struct nfs_seqid_counter {
63 struct rpc_sequence *sequence;
64 int flags;
65 u32 counter;
66};
67
68struct nfs_seqid {
Trond Myklebustcee54fc2005-10-18 14:20:12 -070069 struct nfs_seqid_counter *sequence;
Trond Myklebust4e513362005-10-20 14:22:41 -070070 struct list_head list;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070071};
72
73static 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
Trond Myklebust9f958ab2007-07-02 13:58:33 -040079struct nfs_unique_id {
80 struct rb_node rb_node;
81 __u64 id;
82};
83
Trond Myklebustcee54fc2005-10-18 14:20:12 -070084/*
Trond Myklebust4ce79712005-06-22 17:16:21 +000085 * 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.
Trond Myklebust4ce79712005-06-22 17:16:21 +000088 */
89struct nfs4_state_owner {
Trond Myklebust9f958ab2007-07-02 13:58:33 -040090 struct nfs_unique_id so_owner_id;
David Howellsadfa6f92006-08-22 20:06:08 -040091 struct nfs_client *so_client;
Trond Myklebust6f2e64d2007-07-06 10:53:21 -040092 struct nfs_server *so_server;
Trond Myklebust9f958ab2007-07-02 13:58:33 -040093 struct rb_node so_client_node;
Trond Myklebust4ce79712005-06-22 17:16:21 +000094
95 struct rpc_cred *so_cred; /* Associated cred */
Trond Myklebust9f958ab2007-07-02 13:58:33 -040096
97 spinlock_t so_lock;
98 atomic_t so_count;
Trond Myklebust7eff03a2008-12-23 15:21:43 -050099 unsigned long so_flags;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000100 struct list_head so_states;
101 struct list_head so_delegations;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700102 struct nfs_seqid_counter so_seqid;
103 struct rpc_sequence so_sequence;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000104};
105
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500106enum {
107 NFS_OWNER_RECLAIM_REBOOT,
108 NFS_OWNER_RECLAIM_NOGRACE
109};
110
Trond Myklebust4ce79712005-06-22 17:16:21 +0000111/*
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
123struct nfs4_lock_state {
124 struct list_head ls_locks; /* Other lock stateids */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000125 struct nfs4_state * ls_state; /* Pointer to open state */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000126 fl_owner_t ls_owner; /* POSIX lock owner */
127#define NFS_LOCK_INITIALIZED 1
128 int ls_flags;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700129 struct nfs_seqid_counter ls_seqid;
Trond Myklebustd0dc3702008-01-10 16:07:54 -0500130 struct rpc_sequence ls_sequence;
Trond Myklebust9f958ab2007-07-02 13:58:33 -0400131 struct nfs_unique_id ls_id;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000132 nfs4_stateid ls_stateid;
133 atomic_t ls_count;
134};
135
136/* bits for nfs4_state->flags */
137enum {
138 LK_STATE_IN_USE,
Trond Myklebust003707c2007-07-05 18:07:55 -0400139 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 */
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500143 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
144 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000145};
146
147struct 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? */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000156 spinlock_t state_lock; /* Protects the lock_states list */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000157
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400158 seqlock_t seqlock; /* Protects the stateid/open_stateid */
Trond Myklebust003707c2007-07-05 18:07:55 -0400159 nfs4_stateid stateid; /* Current stateid: may be delegation */
160 nfs4_stateid open_stateid; /* OPEN stateid */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000161
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400162 /* The following 3 fields are protected by owner->so_lock */
Trond Myklebust003707c2007-07-05 18:07:55 -0400163 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 */
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500166 fmode_t state; /* State on the server (R,W, or RW) */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000167 atomic_t count;
168};
169
170
171struct nfs4_exception {
172 long timeout;
173 int retry;
Trond Myklebust9e33bed2008-12-23 15:21:46 -0500174 struct nfs4_state *state;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000175};
176
177struct nfs4_state_recovery_ops {
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500178 int owner_flag_bit;
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500179 int state_flag_bit;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000180 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
181 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
Andy Adamson591d71c2009-04-01 09:22:47 -0400182 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
Andy Adamson90a16612009-04-01 09:22:48 -0400183 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
Ricardo Labiagafce5c832009-12-05 16:08:41 -0500184 int (*reclaim_complete)(struct nfs_client *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000185};
186
Benny Halevy29fba382009-04-01 09:22:44 -0400187struct nfs4_state_maintenance_ops {
188 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
Andy Adamsona7b72102009-04-01 09:22:46 -0400189 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
Benny Halevy8e69514f2009-04-01 09:22:45 -0400190 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
Benny Halevy29fba382009-04-01 09:22:44 -0400191};
192
Al Virof786aa92009-02-20 05:51:22 +0000193extern const struct dentry_operations nfs4_dentry_operations;
Arjan van de Ven92e1d5b2007-02-12 00:55:39 -0800194extern const struct inode_operations nfs4_dir_inode_operations;
J. Bruce Fields6b3b5492005-06-22 17:16:22 +0000195
196/* inode.c */
197extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
198extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
199extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
200
Trond Myklebust4ce79712005-06-22 17:16:21 +0000201
202/* nfs4proc.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400203extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
204extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
Andy Adamson4d643d12009-12-04 15:52:24 -0500205extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
David Howellsadfa6f92006-08-22 20:06:08 -0400206extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
207extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
Andy Adamson591d71c2009-04-01 09:22:47 -0400208extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
Andy Adamson4d643d12009-12-04 15:52:24 -0500209extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
Trond Myklebusta49c3c72007-10-18 18:03:27 -0400210extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
Trond Myklebust02a913a2005-10-18 14:20:17 -0700211extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
212extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
Trond Myklebust55a97592006-06-09 09:34:19 -0400213extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
Trond Myklebust56659e92007-07-17 21:52:39 -0400214extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
Manoj Naik7aaa0b32006-06-09 09:34:23 -0400215 struct nfs4_fs_locations *fs_locations, struct page *page);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000216
Andy Adamson591d71c2009-04-01 09:22:47 -0400217extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[];
218extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[];
Andy Adamson557134a2009-04-01 09:21:53 -0400219#if defined(CONFIG_NFS_V4_1)
Andy Adamsonfbcd4ab2009-04-01 09:22:15 -0400220extern 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);
Andy Adamson557134a2009-04-01 09:21:53 -0400223extern void nfs4_destroy_session(struct nfs4_session *session);
224extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
Trond Myklebustf26468f2009-12-05 19:32:11 -0500225extern int nfs4_proc_create_session(struct nfs_client *);
Andy Adamsonc3fad1b2009-04-01 09:22:39 -0400226extern int nfs4_proc_destroy_session(struct nfs4_session *);
Trond Myklebustfccba802009-07-21 16:48:07 -0400227extern int nfs4_init_session(struct nfs_server *server);
Andy Adamsonfbcd4ab2009-04-01 09:22:15 -0400228#else /* CONFIG_NFS_v4_1 */
229static inline int nfs4_setup_sequence(struct nfs_client *clp,
230 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
231 int cache_reply, struct rpc_task *task)
232{
233 return 0;
234}
Trond Myklebustfccba802009-07-21 16:48:07 -0400235
236static inline int nfs4_init_session(struct nfs_server *server)
237{
238 return 0;
239}
Andy Adamson557134a2009-04-01 09:21:53 -0400240#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000241
Benny Halevy29fba382009-04-01 09:22:44 -0400242extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[];
243
Trond Myklebust4ce79712005-06-22 17:16:21 +0000244extern const u32 nfs4_fattr_bitmap[2];
245extern const u32 nfs4_statfs_bitmap[2];
246extern const u32 nfs4_pathconf_bitmap[2];
247extern const u32 nfs4_fsinfo_bitmap[2];
Manoj Naik830b8e32006-06-09 09:34:25 -0400248extern const u32 nfs4_fs_locations_bitmap[2];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000249
250/* nfs4renewd.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400251extern void nfs4_schedule_state_renewal(struct nfs_client *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000252extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
David Howellsadfa6f92006-08-22 20:06:08 -0400253extern void nfs4_kill_renewd(struct nfs_client *);
David Howells65f27f32006-11-22 14:55:48 +0000254extern void nfs4_renew_state(struct work_struct *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000255
256/* nfs4state.c */
Andy Adamsona7b72102009-04-01 09:22:46 -0400257struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
Trond Myklebust6dc9d572008-12-23 15:21:41 -0500258struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
Andy Adamsona7b72102009-04-01 09:22:46 -0400259#if defined(CONFIG_NFS_V4_1)
260struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
Andy Adamsonb4b82602009-04-01 09:22:49 -0400261struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
Andy Adamsona7b72102009-04-01 09:22:46 -0400262#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000263
264extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
265extern void nfs4_put_state_owner(struct nfs4_state_owner *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000266extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
267extern void nfs4_put_open_state(struct nfs4_state *);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500268extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
269extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
270extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
David Howellsadfa6f92006-08-22 20:06:08 -0400271extern void nfs4_schedule_state_recovery(struct nfs_client *);
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500272extern void nfs4_schedule_state_manager(struct nfs_client *);
Trond Myklebust9e33bed2008-12-23 15:21:46 -0500273extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
Alexandros Batsakis0629e372009-12-05 13:46:14 -0500274extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
Trond Myklebustfaf5f492005-10-18 14:20:15 -0700275extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000276extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000277extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
278
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700279extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
280extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
281extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
282extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
283extern void nfs_free_seqid(struct nfs_seqid *seqid);
284
Trond Myklebust4ce79712005-06-22 17:16:21 +0000285extern const nfs4_stateid zero_stateid;
286
287/* nfs4xdr.c */
Al Viro0dbb4c62006-10-19 23:28:49 -0700288extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000289extern struct rpc_procinfo nfs4_procedures[];
290
291struct nfs4_mount_data;
292
293/* callback_xdr.c */
294extern struct svc_version nfs4_callback_version1;
Alexandros Batsakis07bccc22009-12-05 13:19:01 -0500295extern struct svc_version nfs4_callback_version4;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000296
297#else
298
Trond Myklebust4a35bd42007-06-05 10:31:33 -0400299#define nfs4_close_state(a, b, c) do { } while (0)
Olof Johanssone9a40452007-10-19 20:41:49 -0500300#define nfs4_close_sync(a, b, c) do { } while (0)
Trond Myklebust4ce79712005-06-22 17:16:21 +0000301
302#endif /* CONFIG_NFS_V4 */
303#endif /* __LINUX_FS_NFS_NFS4_FS.H */