Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * linux/include/linux/lockd/lockd.h |
| 3 | * |
| 4 | * General-purpose lockd include file. |
| 5 | * |
| 6 | * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de> |
| 7 | */ |
| 8 | |
| 9 | #ifndef LINUX_LOCKD_LOCKD_H |
| 10 | #define LINUX_LOCKD_LOCKD_H |
| 11 | |
| 12 | #ifdef __KERNEL__ |
| 13 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 14 | #include <linux/in.h> |
| 15 | #include <linux/fs.h> |
Trond Myklebust | 6849c0c | 2006-03-20 13:44:39 -0500 | [diff] [blame] | 16 | #include <linux/kref.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 17 | #include <linux/utsname.h> |
| 18 | #include <linux/nfsd/nfsfh.h> |
| 19 | #include <linux/lockd/bind.h> |
| 20 | #include <linux/lockd/xdr.h> |
| 21 | #ifdef CONFIG_LOCKD_V4 |
| 22 | #include <linux/lockd/xdr4.h> |
| 23 | #endif |
| 24 | #include <linux/lockd/debug.h> |
| 25 | |
| 26 | /* |
| 27 | * Version string |
| 28 | */ |
| 29 | #define LOCKD_VERSION "0.5" |
| 30 | |
| 31 | /* |
| 32 | * Default timeout for RPC calls (seconds) |
| 33 | */ |
| 34 | #define LOCKD_DFLT_TIMEO 10 |
| 35 | |
| 36 | /* |
| 37 | * Lockd host handle (used both by the client and server personality). |
| 38 | */ |
| 39 | struct nlm_host { |
Olaf Kirch | 0cea327 | 2006-10-04 02:15:56 -0700 | [diff] [blame] | 40 | struct hlist_node h_hash; /* doubly linked list */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 41 | struct sockaddr_in h_addr; /* peer address */ |
Frank van Maarseveen | c98451b | 2007-07-09 22:25:29 +0200 | [diff] [blame] | 42 | struct sockaddr_in h_saddr; /* our address (optional) */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 43 | struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */ |
Olaf Kirch | 8dead0d | 2006-10-04 02:15:53 -0700 | [diff] [blame] | 44 | char * h_name; /* remote hostname */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 45 | u32 h_version; /* interface version */ |
| 46 | unsigned short h_proto; /* transport proto */ |
| 47 | unsigned short h_reclaiming : 1, |
| 48 | h_server : 1, /* server side, not client side */ |
NeilBrown | 350fce8 | 2006-10-04 02:16:00 -0700 | [diff] [blame] | 49 | h_inuse : 1; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 50 | wait_queue_head_t h_gracewait; /* wait while reclaiming */ |
Trond Myklebust | 28df955 | 2006-06-09 09:40:27 -0400 | [diff] [blame] | 51 | struct rw_semaphore h_rwsem; /* Reboot recovery lock */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 52 | u32 h_state; /* pseudo-state counter */ |
| 53 | u32 h_nsmstate; /* true remote NSM state */ |
| 54 | u32 h_pidcount; /* Pseudopids */ |
| 55 | atomic_t h_count; /* reference count */ |
Trond Myklebust | 5046791 | 2006-06-09 09:40:24 -0400 | [diff] [blame] | 56 | struct mutex h_mutex; /* mutex for pmap binding */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 57 | unsigned long h_nextrebind; /* next portmap call */ |
| 58 | unsigned long h_expires; /* eligible for GC */ |
| 59 | struct list_head h_lockowners; /* Lockowners for the client */ |
| 60 | spinlock_t h_lock; |
Christoph Hellwig | 26bcbf9 | 2006-03-20 13:44:40 -0500 | [diff] [blame] | 61 | struct list_head h_granted; /* Locks in GRANTED state */ |
| 62 | struct list_head h_reclaim; /* Locks in RECLAIM state */ |
Olaf Kirch | 8dead0d | 2006-10-04 02:15:53 -0700 | [diff] [blame] | 63 | struct nsm_handle * h_nsmhandle; /* NSM status handle */ |
| 64 | }; |
| 65 | |
| 66 | struct nsm_handle { |
| 67 | struct list_head sm_link; |
| 68 | atomic_t sm_count; |
| 69 | char * sm_name; |
| 70 | struct sockaddr_in sm_addr; |
| 71 | unsigned int sm_monitored : 1, |
| 72 | sm_sticky : 1; /* don't unmonitor */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 73 | }; |
| 74 | |
| 75 | /* |
| 76 | * Map an fl_owner_t into a unique 32-bit "pid" |
| 77 | */ |
| 78 | struct nlm_lockowner { |
| 79 | struct list_head list; |
| 80 | atomic_t count; |
| 81 | |
| 82 | struct nlm_host *host; |
| 83 | fl_owner_t owner; |
| 84 | uint32_t pid; |
| 85 | }; |
| 86 | |
Trond Myklebust | ecdbf76 | 2005-06-22 17:16:31 +0000 | [diff] [blame] | 87 | struct nlm_wait; |
| 88 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 89 | /* |
| 90 | * Memory chunk for NLM client RPC request. |
| 91 | */ |
Chuck Lever | 511d2e8 | 2007-03-29 16:47:47 -0400 | [diff] [blame] | 92 | #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 93 | struct nlm_rqst { |
| 94 | unsigned int a_flags; /* initial RPC task flags */ |
| 95 | struct nlm_host * a_host; /* host handle */ |
| 96 | struct nlm_args a_args; /* arguments */ |
| 97 | struct nlm_res a_res; /* result */ |
Trond Myklebust | 9273723 | 2006-03-20 13:44:45 -0500 | [diff] [blame] | 98 | struct nlm_block * a_block; |
Trond Myklebust | aaaa994 | 2006-02-01 12:18:25 -0500 | [diff] [blame] | 99 | unsigned int a_retries; /* Retry count */ |
Trond Myklebust | 9273723 | 2006-03-20 13:44:45 -0500 | [diff] [blame] | 100 | u8 a_owner[NLMCLNT_OHSIZE]; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 101 | }; |
| 102 | |
| 103 | /* |
| 104 | * This struct describes a file held open by lockd on behalf of |
| 105 | * an NFS client. |
| 106 | */ |
| 107 | struct nlm_file { |
Olaf Kirch | 07ba806 | 2006-10-04 02:15:58 -0700 | [diff] [blame] | 108 | struct hlist_node f_list; /* linked list */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 109 | struct nfs_fh f_handle; /* NFS file handle */ |
| 110 | struct file * f_file; /* VFS file pointer */ |
| 111 | struct nlm_share * f_shares; /* DOS shares */ |
Olaf Kirch | 68a2d76c | 2006-10-04 02:15:57 -0700 | [diff] [blame] | 112 | struct list_head f_blocks; /* blocked locks */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 113 | unsigned int f_locks; /* guesstimate # of locks */ |
| 114 | unsigned int f_count; /* reference count */ |
Neil Brown | 89e63ef | 2006-10-04 02:16:06 -0700 | [diff] [blame] | 115 | struct mutex f_mutex; /* avoid concurrent access */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | }; |
| 117 | |
| 118 | /* |
| 119 | * This is a server block (i.e. a lock requested by some client which |
| 120 | * couldn't be granted because of a conflicting lock). |
| 121 | */ |
| 122 | #define NLM_NEVER (~(unsigned long) 0) |
Marc Eshel | 2b36f41 | 2006-11-28 16:26:47 -0500 | [diff] [blame] | 123 | /* timeout on non-blocking call: */ |
| 124 | #define NLM_TIMEOUT (7 * HZ) |
| 125 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 126 | struct nlm_block { |
Trond Myklebust | 6849c0c | 2006-03-20 13:44:39 -0500 | [diff] [blame] | 127 | struct kref b_count; /* Reference count */ |
Olaf Kirch | 68a2d76c | 2006-10-04 02:15:57 -0700 | [diff] [blame] | 128 | struct list_head b_list; /* linked list of all blocks */ |
| 129 | struct list_head b_flist; /* linked list (per file) */ |
Trond Myklebust | 9273723 | 2006-03-20 13:44:45 -0500 | [diff] [blame] | 130 | struct nlm_rqst * b_call; /* RPC args & callback info */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 131 | struct svc_serv * b_daemon; /* NLM service */ |
| 132 | struct nlm_host * b_host; /* host handle for RPC clnt */ |
| 133 | unsigned long b_when; /* next re-xmit */ |
| 134 | unsigned int b_id; /* block id */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 135 | unsigned char b_granted; /* VFS granted lock */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 136 | struct nlm_file * b_file; /* file in question */ |
Marc Eshel | 2b36f41 | 2006-11-28 16:26:47 -0500 | [diff] [blame] | 137 | struct cache_req * b_cache_req; /* deferred request handling */ |
| 138 | struct file_lock * b_fl; /* set for GETLK */ |
| 139 | struct cache_deferred_req * b_deferred_req; |
| 140 | unsigned int b_flags; /* block flags */ |
| 141 | #define B_QUEUED 1 /* lock queued */ |
| 142 | #define B_GOT_CALLBACK 2 /* got lock or conflicting lock */ |
| 143 | #define B_TIMED_OUT 4 /* filesystem too slow to respond */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 144 | }; |
| 145 | |
| 146 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 147 | * Global variables |
| 148 | */ |
| 149 | extern struct rpc_program nlm_program; |
| 150 | extern struct svc_procedure nlmsvc_procedures[]; |
| 151 | #ifdef CONFIG_LOCKD_V4 |
| 152 | extern struct svc_procedure nlmsvc_procedures4[]; |
| 153 | #endif |
| 154 | extern int nlmsvc_grace_period; |
| 155 | extern unsigned long nlmsvc_timeout; |
Olaf Kirch | abd1f50 | 2006-10-04 02:16:01 -0700 | [diff] [blame] | 156 | extern int nsm_use_hostnames; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 157 | |
| 158 | /* |
| 159 | * Lockd client functions |
| 160 | */ |
Trond Myklebust | 9273723 | 2006-03-20 13:44:45 -0500 | [diff] [blame] | 161 | struct nlm_rqst * nlm_alloc_call(struct nlm_host *host); |
| 162 | void nlm_release_call(struct nlm_rqst *); |
| 163 | int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
Trond Myklebust | d471662 | 2006-03-20 13:44:45 -0500 | [diff] [blame] | 164 | int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *); |
Trond Myklebust | 3a649b8 | 2006-03-20 13:44:44 -0500 | [diff] [blame] | 165 | struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl); |
| 166 | void nlmclnt_finish_block(struct nlm_wait *block); |
| 167 | int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout); |
Al Viro | 52921e0 | 2006-10-19 23:28:46 -0700 | [diff] [blame] | 168 | __be32 nlmclnt_grant(const struct sockaddr_in *addr, const struct nlm_lock *); |
Olaf Kirch | 5c8dd29 | 2006-10-04 02:15:55 -0700 | [diff] [blame] | 169 | void nlmclnt_recovery(struct nlm_host *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 170 | int nlmclnt_reclaim(struct nlm_host *, struct file_lock *); |
Olaf Kirch | 031d869 | 2006-10-04 02:16:02 -0700 | [diff] [blame] | 171 | void nlmclnt_next_cookie(struct nlm_cookie *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 172 | |
| 173 | /* |
| 174 | * Host cache |
| 175 | */ |
Chuck Lever | eb18860 | 2008-03-14 14:18:37 -0400 | [diff] [blame] | 176 | struct nlm_host *nlmclnt_lookup_host(const struct sockaddr_in *sin, |
| 177 | int proto, u32 version, |
| 178 | const char *hostname, |
| 179 | unsigned int hostname_len); |
Chuck Lever | 48df020 | 2007-11-01 16:56:53 -0400 | [diff] [blame] | 180 | struct nlm_host *nlmsvc_lookup_host(struct svc_rqst *, const char *, |
| 181 | unsigned int); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 182 | struct rpc_clnt * nlm_bind_host(struct nlm_host *); |
| 183 | void nlm_rebind_host(struct nlm_host *); |
| 184 | struct nlm_host * nlm_get_host(struct nlm_host *); |
| 185 | void nlm_release_host(struct nlm_host *); |
| 186 | void nlm_shutdown_hosts(void); |
Chuck Lever | 48df020 | 2007-11-01 16:56:53 -0400 | [diff] [blame] | 187 | extern void nlm_host_rebooted(const struct sockaddr_in *, const char *, |
| 188 | unsigned int, u32); |
Olaf Kirch | 8dead0d | 2006-10-04 02:15:53 -0700 | [diff] [blame] | 189 | void nsm_release(struct nsm_handle *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 190 | |
| 191 | |
| 192 | /* |
Olaf Kirch | f2af793 | 2006-10-04 02:15:59 -0700 | [diff] [blame] | 193 | * This is used in garbage collection and resource reclaim |
| 194 | * A return value != 0 means destroy the lock/block/share |
| 195 | */ |
| 196 | typedef int (*nlm_host_match_fn_t)(struct nlm_host *cur, struct nlm_host *ref); |
| 197 | |
| 198 | /* |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 199 | * Server-side lock handling |
| 200 | */ |
Al Viro | 52921e0 | 2006-10-19 23:28:46 -0700 | [diff] [blame] | 201 | __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | struct nlm_lock *, int, struct nlm_cookie *); |
Al Viro | 52921e0 | 2006-10-19 23:28:46 -0700 | [diff] [blame] | 203 | __be32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *); |
Marc Eshel | 85f3f1b3 | 2006-11-28 16:27:06 -0500 | [diff] [blame] | 204 | __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *, |
| 205 | struct nlm_lock *, struct nlm_lock *, struct nlm_cookie *); |
Al Viro | 52921e0 | 2006-10-19 23:28:46 -0700 | [diff] [blame] | 206 | __be32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | unsigned long nlmsvc_retry_blocked(void); |
J. Bruce Fields | f3ee439f | 2006-03-20 23:24:13 -0500 | [diff] [blame] | 208 | void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *, |
Olaf Kirch | f2af793 | 2006-10-04 02:15:59 -0700 | [diff] [blame] | 209 | nlm_host_match_fn_t match); |
Al Viro | e8c5c04 | 2006-12-13 00:35:03 -0800 | [diff] [blame] | 210 | void nlmsvc_grant_reply(struct nlm_cookie *, __be32); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 211 | |
| 212 | /* |
| 213 | * File handling for the server personality |
| 214 | */ |
Al Viro | 52921e0 | 2006-10-19 23:28:46 -0700 | [diff] [blame] | 215 | __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **, |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 216 | struct nfs_fh *); |
| 217 | void nlm_release_file(struct nlm_file *); |
| 218 | void nlmsvc_mark_resources(void); |
| 219 | void nlmsvc_free_host_resources(struct nlm_host *); |
| 220 | void nlmsvc_invalidate_all(void); |
| 221 | |
Chuck Lever | f34ec99 | 2008-03-14 14:18:45 -0400 | [diff] [blame] | 222 | static inline struct inode *nlmsvc_file_inode(struct nlm_file *file) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 223 | { |
Josef Sipek | 225a719 | 2006-12-08 02:37:18 -0800 | [diff] [blame] | 224 | return file->f_file->f_path.dentry->d_inode; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 225 | } |
| 226 | |
| 227 | /* |
| 228 | * Compare two host addresses (needs modifying for ipv6) |
| 229 | */ |
Chuck Lever | f34ec99 | 2008-03-14 14:18:45 -0400 | [diff] [blame] | 230 | static inline int nlm_cmp_addr(const struct sockaddr_in *sin1, |
| 231 | const struct sockaddr_in *sin2) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 232 | { |
| 233 | return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr; |
| 234 | } |
| 235 | |
| 236 | /* |
| 237 | * Compare two NLM locks. |
| 238 | * When the second lock is of type F_UNLCK, this acts like a wildcard. |
| 239 | */ |
Chuck Lever | f34ec99 | 2008-03-14 14:18:45 -0400 | [diff] [blame] | 240 | static inline int nlm_compare_locks(const struct file_lock *fl1, |
| 241 | const struct file_lock *fl2) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 242 | { |
| 243 | return fl1->fl_pid == fl2->fl_pid |
Marc Eshel | 3134cbe | 2006-06-09 09:40:20 -0400 | [diff] [blame] | 244 | && fl1->fl_owner == fl2->fl_owner |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 245 | && fl1->fl_start == fl2->fl_start |
| 246 | && fl1->fl_end == fl2->fl_end |
| 247 | &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK); |
| 248 | } |
| 249 | |
| 250 | extern struct lock_manager_operations nlmsvc_lock_operations; |
| 251 | |
| 252 | #endif /* __KERNEL__ */ |
| 253 | |
| 254 | #endif /* LINUX_LOCKD_LOCKD_H */ |