Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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
14#include <linux/config.h>
15#include <linux/in.h>
16#include <linux/fs.h>
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 */
39struct nlm_host {
40 struct nlm_host * h_next; /* linked list (hash table) */
41 struct sockaddr_in h_addr; /* peer address */
42 struct rpc_clnt * h_rpcclnt; /* RPC client to talk to peer */
43 char h_name[20]; /* 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_inuse : 1,
49 h_killed : 1,
50 h_monitored : 1;
51 wait_queue_head_t h_gracewait; /* wait while reclaiming */
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 */
56 struct semaphore h_sema; /* 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};
62
63/*
64 * Map an fl_owner_t into a unique 32-bit "pid"
65 */
66struct nlm_lockowner {
67 struct list_head list;
68 atomic_t count;
69
70 struct nlm_host *host;
71 fl_owner_t owner;
72 uint32_t pid;
73};
74
75/*
76 * Memory chunk for NLM client RPC request.
77 */
78#define NLMCLNT_OHSIZE (sizeof(system_utsname.nodename)+10)
79struct nlm_rqst {
80 unsigned int a_flags; /* initial RPC task flags */
81 struct nlm_host * a_host; /* host handle */
82 struct nlm_args a_args; /* arguments */
83 struct nlm_res a_res; /* result */
84 char a_owner[NLMCLNT_OHSIZE];
85};
86
87/*
88 * This struct describes a file held open by lockd on behalf of
89 * an NFS client.
90 */
91struct nlm_file {
92 struct nlm_file * f_next; /* linked list */
93 struct nfs_fh f_handle; /* NFS file handle */
94 struct file * f_file; /* VFS file pointer */
95 struct nlm_share * f_shares; /* DOS shares */
96 struct nlm_block * f_blocks; /* blocked locks */
97 unsigned int f_locks; /* guesstimate # of locks */
98 unsigned int f_count; /* reference count */
99 struct semaphore f_sema; /* avoid concurrent access */
100 int f_hash; /* hash of f_handle */
101};
102
103/*
104 * This is a server block (i.e. a lock requested by some client which
105 * couldn't be granted because of a conflicting lock).
106 */
107#define NLM_NEVER (~(unsigned long) 0)
108struct nlm_block {
109 struct nlm_block * b_next; /* linked list (all blocks) */
110 struct nlm_block * b_fnext; /* linked list (per file) */
111 struct nlm_rqst b_call; /* RPC args & callback info */
112 struct svc_serv * b_daemon; /* NLM service */
113 struct nlm_host * b_host; /* host handle for RPC clnt */
114 unsigned long b_when; /* next re-xmit */
115 unsigned int b_id; /* block id */
116 unsigned char b_queued; /* re-queued */
117 unsigned char b_granted; /* VFS granted lock */
118 unsigned char b_incall; /* doing callback */
119 unsigned char b_done; /* callback complete */
120 struct nlm_file * b_file; /* file in question */
121};
122
123/*
124 * Valid actions for nlmsvc_traverse_files
125 */
126#define NLM_ACT_CHECK 0 /* check for locks */
127#define NLM_ACT_MARK 1 /* mark & sweep */
128#define NLM_ACT_UNLOCK 2 /* release all locks */
129
130/*
131 * Global variables
132 */
133extern struct rpc_program nlm_program;
134extern struct svc_procedure nlmsvc_procedures[];
135#ifdef CONFIG_LOCKD_V4
136extern struct svc_procedure nlmsvc_procedures4[];
137#endif
138extern int nlmsvc_grace_period;
139extern unsigned long nlmsvc_timeout;
140
141/*
142 * Lockd client functions
143 */
144struct nlm_rqst * nlmclnt_alloc_call(void);
145int nlmclnt_block(struct nlm_host *, struct file_lock *, u32 *);
146int nlmclnt_cancel(struct nlm_host *, struct file_lock *);
147u32 nlmclnt_grant(struct nlm_lock *);
148void nlmclnt_recovery(struct nlm_host *, u32);
149int nlmclnt_reclaim(struct nlm_host *, struct file_lock *);
150int nlmclnt_setgrantargs(struct nlm_rqst *, struct nlm_lock *);
151void nlmclnt_freegrantargs(struct nlm_rqst *);
152
153/*
154 * Host cache
155 */
156struct nlm_host * nlmclnt_lookup_host(struct sockaddr_in *, int, int);
157struct nlm_host * nlmsvc_lookup_host(struct svc_rqst *);
158struct nlm_host * nlm_lookup_host(int server, struct sockaddr_in *, int, int);
159struct rpc_clnt * nlm_bind_host(struct nlm_host *);
160void nlm_rebind_host(struct nlm_host *);
161struct nlm_host * nlm_get_host(struct nlm_host *);
162void nlm_release_host(struct nlm_host *);
163void nlm_shutdown_hosts(void);
164extern struct nlm_host *nlm_find_client(void);
165
166
167/*
168 * Server-side lock handling
169 */
170int nlmsvc_async_call(struct nlm_rqst *, u32, rpc_action);
171u32 nlmsvc_lock(struct svc_rqst *, struct nlm_file *,
172 struct nlm_lock *, int, struct nlm_cookie *);
173u32 nlmsvc_unlock(struct nlm_file *, struct nlm_lock *);
174u32 nlmsvc_testlock(struct nlm_file *, struct nlm_lock *,
175 struct nlm_lock *);
176u32 nlmsvc_cancel_blocked(struct nlm_file *, struct nlm_lock *);
177unsigned long nlmsvc_retry_blocked(void);
178int nlmsvc_traverse_blocks(struct nlm_host *, struct nlm_file *,
179 int action);
180void nlmsvc_grant_reply(struct svc_rqst *, struct nlm_cookie *, u32);
181
182/*
183 * File handling for the server personality
184 */
185u32 nlm_lookup_file(struct svc_rqst *, struct nlm_file **,
186 struct nfs_fh *);
187void nlm_release_file(struct nlm_file *);
188void nlmsvc_mark_resources(void);
189void nlmsvc_free_host_resources(struct nlm_host *);
190void nlmsvc_invalidate_all(void);
191
192static __inline__ struct inode *
193nlmsvc_file_inode(struct nlm_file *file)
194{
195 return file->f_file->f_dentry->d_inode;
196}
197
198/*
199 * Compare two host addresses (needs modifying for ipv6)
200 */
201static __inline__ int
202nlm_cmp_addr(struct sockaddr_in *sin1, struct sockaddr_in *sin2)
203{
204 return sin1->sin_addr.s_addr == sin2->sin_addr.s_addr;
205}
206
207/*
208 * Compare two NLM locks.
209 * When the second lock is of type F_UNLCK, this acts like a wildcard.
210 */
211static __inline__ int
212nlm_compare_locks(struct file_lock *fl1, struct file_lock *fl2)
213{
214 return fl1->fl_pid == fl2->fl_pid
215 && fl1->fl_start == fl2->fl_start
216 && fl1->fl_end == fl2->fl_end
217 &&(fl1->fl_type == fl2->fl_type || fl2->fl_type == F_UNLCK);
218}
219
220extern struct lock_manager_operations nlmsvc_lock_operations;
221
222#endif /* __KERNEL__ */
223
224#endif /* LINUX_LOCKD_LOCKD_H */