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