14ce79717STrond Myklebust /* 24ce79717STrond Myklebust * linux/fs/nfs/nfs4_fs.h 34ce79717STrond Myklebust * 44ce79717STrond Myklebust * Copyright (C) 2005 Trond Myklebust 54ce79717STrond Myklebust * 64ce79717STrond Myklebust * NFSv4-specific filesystem definitions and declarations 74ce79717STrond Myklebust */ 84ce79717STrond Myklebust 94ce79717STrond Myklebust #ifndef __LINUX_FS_NFS_NFS4_FS_H 104ce79717STrond Myklebust #define __LINUX_FS_NFS_NFS4_FS_H 114ce79717STrond Myklebust 124ce79717STrond Myklebust #ifdef CONFIG_NFS_V4 134ce79717STrond Myklebust 144ce79717STrond Myklebust struct idmap; 154ce79717STrond Myklebust 164ce79717STrond Myklebust /* 174ce79717STrond Myklebust * In a seqid-mutating op, this macro controls which error return 184ce79717STrond Myklebust * values trigger incrementation of the seqid. 194ce79717STrond Myklebust * 204ce79717STrond Myklebust * from rfc 3010: 214ce79717STrond Myklebust * The client MUST monotonically increment the sequence number for the 224ce79717STrond Myklebust * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE 234ce79717STrond Myklebust * operations. This is true even in the event that the previous 244ce79717STrond Myklebust * operation that used the sequence number received an error. The only 254ce79717STrond Myklebust * exception to this rule is if the previous operation received one of 264ce79717STrond Myklebust * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID, 274ce79717STrond Myklebust * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR, 284ce79717STrond Myklebust * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE. 294ce79717STrond Myklebust * 304ce79717STrond Myklebust */ 314ce79717STrond Myklebust #define seqid_mutating_err(err) \ 324ce79717STrond Myklebust (((err) != NFSERR_STALE_CLIENTID) && \ 334ce79717STrond Myklebust ((err) != NFSERR_STALE_STATEID) && \ 344ce79717STrond Myklebust ((err) != NFSERR_BAD_STATEID) && \ 354ce79717STrond Myklebust ((err) != NFSERR_BAD_SEQID) && \ 364ce79717STrond Myklebust ((err) != NFSERR_BAD_XDR) && \ 374ce79717STrond Myklebust ((err) != NFSERR_RESOURCE) && \ 384ce79717STrond Myklebust ((err) != NFSERR_NOFILEHANDLE)) 394ce79717STrond Myklebust 404ce79717STrond Myklebust enum nfs4_client_state { 41433fbe4cSTrond Myklebust NFS4CLNT_STATE_RECOVER = 0, 4258d9714aSTrond Myklebust NFS4CLNT_LEASE_EXPIRED, 434ce79717STrond Myklebust }; 444ce79717STrond Myklebust 454ce79717STrond Myklebust /* 46cee54fc9STrond Myklebust * struct rpc_sequence ensures that RPC calls are sent in the exact 47cee54fc9STrond Myklebust * order that they appear on the list. 48cee54fc9STrond Myklebust */ 49cee54fc9STrond Myklebust struct rpc_sequence { 50cee54fc9STrond Myklebust struct rpc_wait_queue wait; /* RPC call delay queue */ 51cee54fc9STrond Myklebust spinlock_t lock; /* Protects the list */ 52cee54fc9STrond Myklebust struct list_head list; /* Defines sequence of RPC calls */ 53cee54fc9STrond Myklebust }; 54cee54fc9STrond Myklebust 55cee54fc9STrond Myklebust #define NFS_SEQID_CONFIRMED 1 56cee54fc9STrond Myklebust struct nfs_seqid_counter { 57cee54fc9STrond Myklebust struct rpc_sequence *sequence; 58cee54fc9STrond Myklebust int flags; 59cee54fc9STrond Myklebust u32 counter; 60cee54fc9STrond Myklebust }; 61cee54fc9STrond Myklebust 62cee54fc9STrond Myklebust struct nfs_seqid { 63cee54fc9STrond Myklebust struct nfs_seqid_counter *sequence; 644e51336aSTrond Myklebust struct list_head list; 65cee54fc9STrond Myklebust }; 66cee54fc9STrond Myklebust 67cee54fc9STrond Myklebust static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status) 68cee54fc9STrond Myklebust { 69cee54fc9STrond Myklebust if (seqid_mutating_err(-status)) 70cee54fc9STrond Myklebust seqid->flags |= NFS_SEQID_CONFIRMED; 71cee54fc9STrond Myklebust } 72cee54fc9STrond Myklebust 739f958ab8STrond Myklebust struct nfs_unique_id { 749f958ab8STrond Myklebust struct rb_node rb_node; 759f958ab8STrond Myklebust __u64 id; 769f958ab8STrond Myklebust }; 779f958ab8STrond Myklebust 78cee54fc9STrond Myklebust /* 794ce79717STrond Myklebust * NFS4 state_owners and lock_owners are simply labels for ordered 804ce79717STrond Myklebust * sequences of RPC calls. Their sole purpose is to provide once-only 814ce79717STrond Myklebust * semantics by allowing the server to identify replayed requests. 824ce79717STrond Myklebust */ 834ce79717STrond Myklebust struct nfs4_state_owner { 849f958ab8STrond Myklebust struct nfs_unique_id so_owner_id; 85adfa6f98SDavid Howells struct nfs_client *so_client; 869f958ab8STrond Myklebust struct rb_node so_client_node; 874ce79717STrond Myklebust 884ce79717STrond Myklebust struct rpc_cred *so_cred; /* Associated cred */ 899f958ab8STrond Myklebust 909f958ab8STrond Myklebust spinlock_t so_lock; 919f958ab8STrond Myklebust atomic_t so_count; 924ce79717STrond Myklebust struct list_head so_states; 934ce79717STrond Myklebust struct list_head so_delegations; 94cee54fc9STrond Myklebust struct nfs_seqid_counter so_seqid; 95cee54fc9STrond Myklebust struct rpc_sequence so_sequence; 964ce79717STrond Myklebust }; 974ce79717STrond Myklebust 984ce79717STrond Myklebust /* 994ce79717STrond Myklebust * struct nfs4_state maintains the client-side state for a given 1004ce79717STrond Myklebust * (state_owner,inode) tuple (OPEN) or state_owner (LOCK). 1014ce79717STrond Myklebust * 1024ce79717STrond Myklebust * OPEN: 1034ce79717STrond Myklebust * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server, 1044ce79717STrond Myklebust * we need to know how many files are open for reading or writing on a 1054ce79717STrond Myklebust * given inode. This information too is stored here. 1064ce79717STrond Myklebust * 1074ce79717STrond Myklebust * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN) 1084ce79717STrond Myklebust */ 1094ce79717STrond Myklebust 1104ce79717STrond Myklebust struct nfs4_lock_state { 1114ce79717STrond Myklebust struct list_head ls_locks; /* Other lock stateids */ 1128d0a8a9dSTrond Myklebust struct nfs4_state * ls_state; /* Pointer to open state */ 1134ce79717STrond Myklebust fl_owner_t ls_owner; /* POSIX lock owner */ 1144ce79717STrond Myklebust #define NFS_LOCK_INITIALIZED 1 1154ce79717STrond Myklebust int ls_flags; 116cee54fc9STrond Myklebust struct nfs_seqid_counter ls_seqid; 1179f958ab8STrond Myklebust struct nfs_unique_id ls_id; 1184ce79717STrond Myklebust nfs4_stateid ls_stateid; 1194ce79717STrond Myklebust atomic_t ls_count; 1204ce79717STrond Myklebust }; 1214ce79717STrond Myklebust 1224ce79717STrond Myklebust /* bits for nfs4_state->flags */ 1234ce79717STrond Myklebust enum { 1244ce79717STrond Myklebust LK_STATE_IN_USE, 125003707c7STrond Myklebust NFS_DELEGATED_STATE, /* Current stateid is delegation */ 126003707c7STrond Myklebust NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */ 127003707c7STrond Myklebust NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */ 128003707c7STrond Myklebust NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */ 1294ce79717STrond Myklebust }; 1304ce79717STrond Myklebust 1314ce79717STrond Myklebust struct nfs4_state { 1324ce79717STrond Myklebust struct list_head open_states; /* List of states for the same state_owner */ 1334ce79717STrond Myklebust struct list_head inode_states; /* List of states for the same inode */ 1344ce79717STrond Myklebust struct list_head lock_states; /* List of subservient lock stateids */ 1354ce79717STrond Myklebust 1364ce79717STrond Myklebust struct nfs4_state_owner *owner; /* Pointer to the open owner */ 1374ce79717STrond Myklebust struct inode *inode; /* Pointer to the inode */ 1384ce79717STrond Myklebust 1394ce79717STrond Myklebust unsigned long flags; /* Do we hold any locks? */ 1408d0a8a9dSTrond Myklebust spinlock_t state_lock; /* Protects the lock_states list */ 1414ce79717STrond Myklebust 1428bda4e4cSTrond Myklebust seqlock_t seqlock; /* Protects the stateid/open_stateid */ 143003707c7STrond Myklebust nfs4_stateid stateid; /* Current stateid: may be delegation */ 144003707c7STrond Myklebust nfs4_stateid open_stateid; /* OPEN stateid */ 1454ce79717STrond Myklebust 1468bda4e4cSTrond Myklebust /* The following 3 fields are protected by owner->so_lock */ 147003707c7STrond Myklebust unsigned int n_rdonly; /* Number of read-only references */ 148003707c7STrond Myklebust unsigned int n_wronly; /* Number of write-only references */ 149003707c7STrond Myklebust unsigned int n_rdwr; /* Number of read/write references */ 1504ce79717STrond Myklebust int state; /* State on the server (R,W, or RW) */ 1514ce79717STrond Myklebust atomic_t count; 1524ce79717STrond Myklebust }; 1534ce79717STrond Myklebust 1544ce79717STrond Myklebust 1554ce79717STrond Myklebust struct nfs4_exception { 1564ce79717STrond Myklebust long timeout; 1574ce79717STrond Myklebust int retry; 1584ce79717STrond Myklebust }; 1594ce79717STrond Myklebust 1604ce79717STrond Myklebust struct nfs4_state_recovery_ops { 1614ce79717STrond Myklebust int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *); 1624ce79717STrond Myklebust int (*recover_lock)(struct nfs4_state *, struct file_lock *); 1634ce79717STrond Myklebust }; 1644ce79717STrond Myklebust 1654ce79717STrond Myklebust extern struct dentry_operations nfs4_dentry_operations; 16692e1d5beSArjan van de Ven extern const struct inode_operations nfs4_dir_inode_operations; 1676b3b5496SJ. Bruce Fields 1686b3b5496SJ. Bruce Fields /* inode.c */ 1696b3b5496SJ. Bruce Fields extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t); 1706b3b5496SJ. Bruce Fields extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int); 1716b3b5496SJ. Bruce Fields extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t); 1726b3b5496SJ. Bruce Fields 1734ce79717STrond Myklebust 1744ce79717STrond Myklebust /* nfs4proc.c */ 1754ce79717STrond Myklebust extern int nfs4_map_errors(int err); 176adfa6f98SDavid Howells extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *); 177adfa6f98SDavid Howells extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *); 178adfa6f98SDavid Howells extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *); 179adfa6f98SDavid Howells extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *); 1804a35bd41STrond Myklebust extern int nfs4_do_close(struct path *path, struct nfs4_state *state); 18102a913a7STrond Myklebust extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *); 18202a913a7STrond Myklebust extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *); 18355a97593STrond Myklebust extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle); 184c228fd3aSTrond Myklebust extern int nfs4_proc_fs_locations(struct inode *dir, struct qstr *name, 1857aaa0b3bSManoj Naik struct nfs4_fs_locations *fs_locations, struct page *page); 1864ce79717STrond Myklebust 1874ce79717STrond Myklebust extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops; 1884ce79717STrond Myklebust extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_ops; 1894ce79717STrond Myklebust 1904ce79717STrond Myklebust extern const u32 nfs4_fattr_bitmap[2]; 1914ce79717STrond Myklebust extern const u32 nfs4_statfs_bitmap[2]; 1924ce79717STrond Myklebust extern const u32 nfs4_pathconf_bitmap[2]; 1934ce79717STrond Myklebust extern const u32 nfs4_fsinfo_bitmap[2]; 194830b8e33SManoj Naik extern const u32 nfs4_fs_locations_bitmap[2]; 1954ce79717STrond Myklebust 1964ce79717STrond Myklebust /* nfs4renewd.c */ 197adfa6f98SDavid Howells extern void nfs4_schedule_state_renewal(struct nfs_client *); 1984ce79717STrond Myklebust extern void nfs4_renewd_prepare_shutdown(struct nfs_server *); 199adfa6f98SDavid Howells extern void nfs4_kill_renewd(struct nfs_client *); 20065f27f38SDavid Howells extern void nfs4_renew_state(struct work_struct *); 2014ce79717STrond Myklebust 2024ce79717STrond Myklebust /* nfs4state.c */ 203adfa6f98SDavid Howells struct rpc_cred *nfs4_get_renew_cred(struct nfs_client *clp); 2044ce79717STrond Myklebust 2054ce79717STrond Myklebust extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *); 2064ce79717STrond Myklebust extern void nfs4_put_state_owner(struct nfs4_state_owner *); 2074ce79717STrond Myklebust extern void nfs4_drop_state_owner(struct nfs4_state_owner *); 2084ce79717STrond Myklebust extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *); 2094ce79717STrond Myklebust extern void nfs4_put_open_state(struct nfs4_state *); 2104a35bd41STrond Myklebust extern void nfs4_close_state(struct path *, struct nfs4_state *, mode_t); 2114cecb76fSTrond Myklebust extern void nfs4_state_set_mode_locked(struct nfs4_state *, mode_t); 212adfa6f98SDavid Howells extern void nfs4_schedule_state_recovery(struct nfs_client *); 213faf5f49cSTrond Myklebust extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp); 2148d0a8a9dSTrond Myklebust extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl); 2154ce79717STrond Myklebust extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t); 2164ce79717STrond Myklebust 217cee54fc9STrond Myklebust extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter); 218cee54fc9STrond Myklebust extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task); 219cee54fc9STrond Myklebust extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid); 220cee54fc9STrond Myklebust extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid); 221cee54fc9STrond Myklebust extern void nfs_free_seqid(struct nfs_seqid *seqid); 222cee54fc9STrond Myklebust 2234ce79717STrond Myklebust extern const nfs4_stateid zero_stateid; 2244ce79717STrond Myklebust 2254ce79717STrond Myklebust /* nfs4xdr.c */ 2260dbb4c67SAl Viro extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus); 2274ce79717STrond Myklebust extern struct rpc_procinfo nfs4_procedures[]; 2284ce79717STrond Myklebust 2294ce79717STrond Myklebust struct nfs4_mount_data; 2304ce79717STrond Myklebust 2314ce79717STrond Myklebust /* callback_xdr.c */ 2324ce79717STrond Myklebust extern struct svc_version nfs4_callback_version1; 2334ce79717STrond Myklebust 2344ce79717STrond Myklebust #else 2354ce79717STrond Myklebust 2364a35bd41STrond Myklebust #define nfs4_close_state(a, b, c) do { } while (0) 2374ce79717STrond Myklebust 2384ce79717STrond Myklebust #endif /* CONFIG_NFS_V4 */ 2394ce79717STrond Myklebust #endif /* __LINUX_FS_NFS_NFS4_FS.H */ 240