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