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