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