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