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