lockd.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374
  1. /* SPDX-License-Identifier: GPL-2.0 */
  2. /*
  3. * linux/include/linux/lockd/lockd.h
  4. *
  5. * General-purpose lockd include file.
  6. *
  7. * Copyright (C) 1996 Olaf Kirch <okir@monad.swb.de>
  8. */
  9. #ifndef LINUX_LOCKD_LOCKD_H
  10. #define LINUX_LOCKD_LOCKD_H
  11. #include <linux/in.h>
  12. #include <linux/in6.h>
  13. #include <net/ipv6.h>
  14. #include <linux/fs.h>
  15. #include <linux/kref.h>
  16. #include <linux/refcount.h>
  17. #include <linux/utsname.h>
  18. #include <linux/lockd/bind.h>
  19. #include <linux/lockd/xdr.h>
  20. #ifdef CONFIG_LOCKD_V4
  21. #include <linux/lockd/xdr4.h>
  22. #endif
  23. #include <linux/lockd/debug.h>
  24. #include <linux/sunrpc/svc.h>
  25. /*
  26. * Version string
  27. */
  28. #define LOCKD_VERSION "0.5"
  29. /*
  30. * Default timeout for RPC calls (seconds)
  31. */
  32. #define LOCKD_DFLT_TIMEO 10
  33. /*
  34. * Lockd host handle (used both by the client and server personality).
  35. */
  36. struct nlm_host {
  37. struct hlist_node h_hash; /* doubly linked list */
  38. struct sockaddr_storage h_addr; /* peer address */
  39. size_t h_addrlen;
  40. struct sockaddr_storage h_srcaddr; /* our address (optional) */
  41. size_t h_srcaddrlen;
  42. struct rpc_clnt *h_rpcclnt; /* RPC client to talk to peer */
  43. char *h_name; /* remote hostname */
  44. u32 h_version; /* interface version */
  45. unsigned short h_proto; /* transport proto */
  46. unsigned short h_reclaiming : 1,
  47. h_server : 1, /* server side, not client side */
  48. h_noresvport : 1,
  49. h_inuse : 1;
  50. wait_queue_head_t h_gracewait; /* wait while reclaiming */
  51. struct rw_semaphore h_rwsem; /* Reboot recovery lock */
  52. u32 h_state; /* pseudo-state counter */
  53. u32 h_nsmstate; /* true remote NSM state */
  54. u32 h_pidcount; /* Pseudopids */
  55. refcount_t h_count; /* reference count */
  56. struct mutex h_mutex; /* mutex for pmap binding */
  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;
  61. struct list_head h_granted; /* Locks in GRANTED state */
  62. struct list_head h_reclaim; /* Locks in RECLAIM state */
  63. struct nsm_handle *h_nsmhandle; /* NSM status handle */
  64. char *h_addrbuf; /* address eyecatcher */
  65. struct net *net; /* host net */
  66. const struct cred *h_cred;
  67. char nodename[UNX_MAXNODENAME + 1];
  68. const struct nlmclnt_operations *h_nlmclnt_ops; /* Callback ops for NLM users */
  69. };
  70. /*
  71. * The largest string sm_addrbuf should hold is a full-size IPv6 address
  72. * (no "::" anywhere) with a scope ID. The buffer size is computed to
  73. * hold eight groups of colon-separated four-hex-digit numbers, a
  74. * percent sign, a scope id (at most 32 bits, in decimal), and NUL.
  75. */
  76. #define NSM_ADDRBUF ((8 * 4 + 7) + (1 + 10) + 1)
  77. struct nsm_handle {
  78. struct list_head sm_link;
  79. refcount_t sm_count;
  80. char *sm_mon_name;
  81. char *sm_name;
  82. struct sockaddr_storage sm_addr;
  83. size_t sm_addrlen;
  84. unsigned int sm_monitored : 1,
  85. sm_sticky : 1; /* don't unmonitor */
  86. struct nsm_private sm_priv;
  87. char sm_addrbuf[NSM_ADDRBUF];
  88. };
  89. /*
  90. * Rigorous type checking on sockaddr type conversions
  91. */
  92. static inline struct sockaddr_in *nlm_addr_in(const struct nlm_host *host)
  93. {
  94. return (struct sockaddr_in *)&host->h_addr;
  95. }
  96. static inline struct sockaddr *nlm_addr(const struct nlm_host *host)
  97. {
  98. return (struct sockaddr *)&host->h_addr;
  99. }
  100. static inline struct sockaddr_in *nlm_srcaddr_in(const struct nlm_host *host)
  101. {
  102. return (struct sockaddr_in *)&host->h_srcaddr;
  103. }
  104. static inline struct sockaddr *nlm_srcaddr(const struct nlm_host *host)
  105. {
  106. return (struct sockaddr *)&host->h_srcaddr;
  107. }
  108. /*
  109. * Map an fl_owner_t into a unique 32-bit "pid"
  110. */
  111. struct nlm_lockowner {
  112. struct list_head list;
  113. refcount_t count;
  114. struct nlm_host *host;
  115. fl_owner_t owner;
  116. uint32_t pid;
  117. };
  118. struct nlm_wait;
  119. /*
  120. * Memory chunk for NLM client RPC request.
  121. */
  122. #define NLMCLNT_OHSIZE ((__NEW_UTS_LEN) + 10u)
  123. struct nlm_rqst {
  124. refcount_t a_count;
  125. unsigned int a_flags; /* initial RPC task flags */
  126. struct nlm_host * a_host; /* host handle */
  127. struct nlm_args a_args; /* arguments */
  128. struct nlm_res a_res; /* result */
  129. struct nlm_block * a_block;
  130. unsigned int a_retries; /* Retry count */
  131. u8 a_owner[NLMCLNT_OHSIZE];
  132. void * a_callback_data; /* sent to nlmclnt_operations callbacks */
  133. };
  134. /*
  135. * This struct describes a file held open by lockd on behalf of
  136. * an NFS client.
  137. */
  138. struct nlm_file {
  139. struct hlist_node f_list; /* linked list */
  140. struct nfs_fh f_handle; /* NFS file handle */
  141. struct file * f_file; /* VFS file pointer */
  142. struct nlm_share * f_shares; /* DOS shares */
  143. struct list_head f_blocks; /* blocked locks */
  144. unsigned int f_locks; /* guesstimate # of locks */
  145. unsigned int f_count; /* reference count */
  146. struct mutex f_mutex; /* avoid concurrent access */
  147. };
  148. /*
  149. * This is a server block (i.e. a lock requested by some client which
  150. * couldn't be granted because of a conflicting lock).
  151. */
  152. #define NLM_NEVER (~(unsigned long) 0)
  153. /* timeout on non-blocking call: */
  154. #define NLM_TIMEOUT (7 * HZ)
  155. struct nlm_block {
  156. struct kref b_count; /* Reference count */
  157. struct list_head b_list; /* linked list of all blocks */
  158. struct list_head b_flist; /* linked list (per file) */
  159. struct nlm_rqst * b_call; /* RPC args & callback info */
  160. struct svc_serv * b_daemon; /* NLM service */
  161. struct nlm_host * b_host; /* host handle for RPC clnt */
  162. unsigned long b_when; /* next re-xmit */
  163. unsigned int b_id; /* block id */
  164. unsigned char b_granted; /* VFS granted lock */
  165. struct nlm_file * b_file; /* file in question */
  166. struct cache_req * b_cache_req; /* deferred request handling */
  167. struct cache_deferred_req * b_deferred_req;
  168. unsigned int b_flags; /* block flags */
  169. #define B_QUEUED 1 /* lock queued */
  170. #define B_GOT_CALLBACK 2 /* got lock or conflicting lock */
  171. #define B_TIMED_OUT 4 /* filesystem too slow to respond */
  172. };
  173. /*
  174. * Global variables
  175. */
  176. extern const struct rpc_program nlm_program;
  177. extern const struct svc_procedure nlmsvc_procedures[];
  178. #ifdef CONFIG_LOCKD_V4
  179. extern const struct svc_procedure nlmsvc_procedures4[];
  180. #endif
  181. extern int nlmsvc_grace_period;
  182. extern unsigned long nlmsvc_timeout;
  183. extern bool nsm_use_hostnames;
  184. extern u32 nsm_local_state;
  185. /*
  186. * Lockd client functions
  187. */
  188. struct nlm_rqst * nlm_alloc_call(struct nlm_host *host);
  189. int nlm_async_call(struct nlm_rqst *, u32, const struct rpc_call_ops *);
  190. int nlm_async_reply(struct nlm_rqst *, u32, const struct rpc_call_ops *);
  191. void nlmclnt_release_call(struct nlm_rqst *);
  192. struct nlm_wait * nlmclnt_prepare_block(struct nlm_host *host, struct file_lock *fl);
  193. void nlmclnt_finish_block(struct nlm_wait *block);
  194. int nlmclnt_block(struct nlm_wait *block, struct nlm_rqst *req, long timeout);
  195. __be32 nlmclnt_grant(const struct sockaddr *addr,
  196. const struct nlm_lock *lock);
  197. void nlmclnt_recovery(struct nlm_host *);
  198. int nlmclnt_reclaim(struct nlm_host *, struct file_lock *,
  199. struct nlm_rqst *);
  200. void nlmclnt_next_cookie(struct nlm_cookie *);
  201. /*
  202. * Host cache
  203. */
  204. struct nlm_host *nlmclnt_lookup_host(const struct sockaddr *sap,
  205. const size_t salen,
  206. const unsigned short protocol,
  207. const u32 version,
  208. const char *hostname,
  209. int noresvport,
  210. struct net *net,
  211. const struct cred *cred);
  212. void nlmclnt_release_host(struct nlm_host *);
  213. struct nlm_host *nlmsvc_lookup_host(const struct svc_rqst *rqstp,
  214. const char *hostname,
  215. const size_t hostname_len);
  216. void nlmsvc_release_host(struct nlm_host *);
  217. struct rpc_clnt * nlm_bind_host(struct nlm_host *);
  218. void nlm_rebind_host(struct nlm_host *);
  219. struct nlm_host * nlm_get_host(struct nlm_host *);
  220. void nlm_shutdown_hosts(void);
  221. void nlm_shutdown_hosts_net(struct net *net);
  222. void nlm_host_rebooted(const struct net *net,
  223. const struct nlm_reboot *);
  224. /*
  225. * Host monitoring
  226. */
  227. int nsm_monitor(const struct nlm_host *host);
  228. void nsm_unmonitor(const struct nlm_host *host);
  229. struct nsm_handle *nsm_get_handle(const struct net *net,
  230. const struct sockaddr *sap,
  231. const size_t salen,
  232. const char *hostname,
  233. const size_t hostname_len);
  234. struct nsm_handle *nsm_reboot_lookup(const struct net *net,
  235. const struct nlm_reboot *info);
  236. void nsm_release(struct nsm_handle *nsm);
  237. /*
  238. * This is used in garbage collection and resource reclaim
  239. * A return value != 0 means destroy the lock/block/share
  240. */
  241. typedef int (*nlm_host_match_fn_t)(void *cur, struct nlm_host *ref);
  242. /*
  243. * Server-side lock handling
  244. */
  245. __be32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
  246. struct nlm_host *, struct nlm_lock *, int,
  247. struct nlm_cookie *, int);
  248. __be32 nlmsvc_unlock(struct net *net, struct nlm_file *, struct nlm_lock *);
  249. __be32 nlmsvc_testlock(struct svc_rqst *, struct nlm_file *,
  250. struct nlm_host *, struct nlm_lock *,
  251. struct nlm_lock *, struct nlm_cookie *);
  252. __be32 nlmsvc_cancel_blocked(struct net *net, struct nlm_file *, struct nlm_lock *);
  253. unsigned long nlmsvc_retry_blocked(void);
  254. void nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
  255. nlm_host_match_fn_t match);
  256. void nlmsvc_grant_reply(struct nlm_cookie *, __be32);
  257. void nlmsvc_release_call(struct nlm_rqst *);
  258. void nlmsvc_locks_init_private(struct file_lock *, struct nlm_host *, pid_t);
  259. /*
  260. * File handling for the server personality
  261. */
  262. __be32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
  263. struct nfs_fh *);
  264. void nlm_release_file(struct nlm_file *);
  265. void nlmsvc_release_lockowner(struct nlm_lock *);
  266. void nlmsvc_mark_resources(struct net *);
  267. void nlmsvc_free_host_resources(struct nlm_host *);
  268. void nlmsvc_invalidate_all(void);
  269. /*
  270. * Cluster failover support
  271. */
  272. int nlmsvc_unlock_all_by_sb(struct super_block *sb);
  273. int nlmsvc_unlock_all_by_ip(struct sockaddr *server_addr);
  274. static inline struct inode *nlmsvc_file_inode(struct nlm_file *file)
  275. {
  276. return locks_inode(file->f_file);
  277. }
  278. static inline int __nlm_privileged_request4(const struct sockaddr *sap)
  279. {
  280. const struct sockaddr_in *sin = (struct sockaddr_in *)sap;
  281. if (ntohs(sin->sin_port) > 1023)
  282. return 0;
  283. return ipv4_is_loopback(sin->sin_addr.s_addr);
  284. }
  285. #if IS_ENABLED(CONFIG_IPV6)
  286. static inline int __nlm_privileged_request6(const struct sockaddr *sap)
  287. {
  288. const struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
  289. if (ntohs(sin6->sin6_port) > 1023)
  290. return 0;
  291. if (ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_MAPPED)
  292. return ipv4_is_loopback(sin6->sin6_addr.s6_addr32[3]);
  293. return ipv6_addr_type(&sin6->sin6_addr) & IPV6_ADDR_LOOPBACK;
  294. }
  295. #else /* IS_ENABLED(CONFIG_IPV6) */
  296. static inline int __nlm_privileged_request6(const struct sockaddr *sap)
  297. {
  298. return 0;
  299. }
  300. #endif /* IS_ENABLED(CONFIG_IPV6) */
  301. /*
  302. * Ensure incoming requests are from local privileged callers.
  303. *
  304. * Return TRUE if sender is local and is connecting via a privileged port;
  305. * otherwise return FALSE.
  306. */
  307. static inline int nlm_privileged_requester(const struct svc_rqst *rqstp)
  308. {
  309. const struct sockaddr *sap = svc_addr(rqstp);
  310. switch (sap->sa_family) {
  311. case AF_INET:
  312. return __nlm_privileged_request4(sap);
  313. case AF_INET6:
  314. return __nlm_privileged_request6(sap);
  315. default:
  316. return 0;
  317. }
  318. }
  319. /*
  320. * Compare two NLM locks.
  321. * When the second lock is of type F_UNLCK, this acts like a wildcard.
  322. */
  323. static inline int nlm_compare_locks(const struct file_lock *fl1,
  324. const struct file_lock *fl2)
  325. {
  326. return locks_inode(fl1->fl_file) == locks_inode(fl2->fl_file)
  327. && fl1->fl_pid == fl2->fl_pid
  328. && fl1->fl_owner == fl2->fl_owner
  329. && fl1->fl_start == fl2->fl_start
  330. && fl1->fl_end == fl2->fl_end
  331. &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
  332. }
  333. extern const struct lock_manager_operations nlmsvc_lock_operations;
  334. #endif /* LINUX_LOCKD_LOCKD_H */