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