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