lockd: document use of mon_id argument in SM_MON requests
[pandora-kernel.git] / fs / lockd / mon.c
1 /*
2  * linux/fs/lockd/mon.c
3  *
4  * The kernel statd client.
5  *
6  * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
7  */
8
9 #include <linux/types.h>
10 #include <linux/utsname.h>
11 #include <linux/kernel.h>
12 #include <linux/sunrpc/clnt.h>
13 #include <linux/sunrpc/xprtsock.h>
14 #include <linux/sunrpc/svc.h>
15 #include <linux/lockd/lockd.h>
16 #include <linux/lockd/sm_inter.h>
17
18
19 #define NLMDBG_FACILITY         NLMDBG_MONITOR
20
21 #define XDR_ADDRBUF_LEN         (20)
22
23 static struct rpc_clnt *        nsm_create(void);
24
25 static struct rpc_program       nsm_program;
26
27 /*
28  * Local NSM state
29  */
30 int                             nsm_local_state;
31
32 /*
33  * Common procedure for SM_MON/SM_UNMON calls
34  */
35 static int
36 nsm_mon_unmon(struct nsm_handle *nsm, u32 proc, struct nsm_res *res)
37 {
38         struct rpc_clnt *clnt;
39         int             status;
40         struct nsm_args args;
41         struct rpc_message msg = {
42                 .rpc_argp       = &args,
43                 .rpc_resp       = res,
44         };
45
46         clnt = nsm_create();
47         if (IS_ERR(clnt)) {
48                 status = PTR_ERR(clnt);
49                 goto out;
50         }
51
52         memset(&args, 0, sizeof(args));
53         args.mon_name = nsm->sm_name;
54         args.addr = nsm->sm_addr.sin_addr.s_addr;
55         args.prog = NLM_PROGRAM;
56         args.vers = 3;
57         args.proc = NLMPROC_NSM_NOTIFY;
58         memset(res, 0, sizeof(*res));
59
60         msg.rpc_proc = &clnt->cl_procinfo[proc];
61         status = rpc_call_sync(clnt, &msg, 0);
62         if (status < 0)
63                 printk(KERN_DEBUG "nsm_mon_unmon: rpc failed, status=%d\n",
64                         status);
65         else
66                 status = 0;
67         rpc_shutdown_client(clnt);
68  out:
69         return status;
70 }
71
72 /*
73  * Set up monitoring of a remote host
74  */
75 int
76 nsm_monitor(struct nlm_host *host)
77 {
78         struct nsm_handle *nsm = host->h_nsmhandle;
79         struct nsm_res  res;
80         int             status;
81
82         dprintk("lockd: nsm_monitor(%s)\n", host->h_name);
83         BUG_ON(nsm == NULL);
84
85         if (nsm->sm_monitored)
86                 return 0;
87
88         status = nsm_mon_unmon(nsm, SM_MON, &res);
89
90         if (status < 0 || res.status != 0)
91                 printk(KERN_NOTICE "lockd: cannot monitor %s\n", host->h_name);
92         else
93                 nsm->sm_monitored = 1;
94         return status;
95 }
96
97 /*
98  * Cease to monitor remote host
99  */
100 int
101 nsm_unmonitor(struct nlm_host *host)
102 {
103         struct nsm_handle *nsm = host->h_nsmhandle;
104         struct nsm_res  res;
105         int             status = 0;
106
107         if (nsm == NULL)
108                 return 0;
109         host->h_nsmhandle = NULL;
110
111         if (atomic_read(&nsm->sm_count) == 1
112          && nsm->sm_monitored && !nsm->sm_sticky) {
113                 dprintk("lockd: nsm_unmonitor(%s)\n", host->h_name);
114
115                 status = nsm_mon_unmon(nsm, SM_UNMON, &res);
116                 if (status < 0)
117                         printk(KERN_NOTICE "lockd: cannot unmonitor %s\n",
118                                         host->h_name);
119                 else
120                         nsm->sm_monitored = 0;
121         }
122         nsm_release(nsm);
123         return status;
124 }
125
126 /*
127  * Create NSM client for the local host
128  */
129 static struct rpc_clnt *
130 nsm_create(void)
131 {
132         struct sockaddr_in      sin = {
133                 .sin_family     = AF_INET,
134                 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
135                 .sin_port       = 0,
136         };
137         struct rpc_create_args args = {
138                 .protocol       = XPRT_TRANSPORT_UDP,
139                 .address        = (struct sockaddr *)&sin,
140                 .addrsize       = sizeof(sin),
141                 .servername     = "localhost",
142                 .program        = &nsm_program,
143                 .version        = SM_VERSION,
144                 .authflavor     = RPC_AUTH_NULL,
145         };
146
147         return rpc_create(&args);
148 }
149
150 /*
151  * XDR functions for NSM.
152  */
153
154 static __be32 *xdr_encode_nsm_string(__be32 *p, char *string)
155 {
156         size_t len = strlen(string);
157
158         if (len > SM_MAXSTRLEN)
159                 len = SM_MAXSTRLEN;
160         return xdr_encode_opaque(p, string, len);
161 }
162
163 /*
164  * "mon_name" specifies the host to be monitored.
165  *
166  * Linux uses a text version of the IP address of the remote
167  * host as the host identifier (the "mon_name" argument).
168  *
169  * Linux statd always looks up the canonical hostname first for
170  * whatever remote hostname it receives, so this works alright.
171  */
172 static __be32 *xdr_encode_mon_name(__be32 *p, struct nsm_args *argp)
173 {
174         char    buffer[XDR_ADDRBUF_LEN + 1];
175         char    *name = argp->mon_name;
176
177         if (!nsm_use_hostnames) {
178                 snprintf(buffer, XDR_ADDRBUF_LEN,
179                          NIPQUAD_FMT, NIPQUAD(argp->addr));
180                 name = buffer;
181         }
182
183         return xdr_encode_nsm_string(p, name);
184 }
185
186 /*
187  * The "my_id" argument specifies the hostname and RPC procedure
188  * to be called when the status manager receives notification
189  * (via the SM_NOTIFY call) that the state of host "mon_name"
190  * has changed.
191  */
192 static __be32 *xdr_encode_my_id(__be32 *p, struct nsm_args *argp)
193 {
194         p = xdr_encode_nsm_string(p, utsname()->nodename);
195         if (!p)
196                 return ERR_PTR(-EIO);
197
198         *p++ = htonl(argp->prog);
199         *p++ = htonl(argp->vers);
200         *p++ = htonl(argp->proc);
201
202         return p;
203 }
204
205 /*
206  * The "mon_id" argument specifies the non-private arguments
207  * of an SM_MON or SM_UNMON call.
208  */
209 static __be32 *xdr_encode_mon_id(__be32 *p, struct nsm_args *argp)
210 {
211         p = xdr_encode_mon_name(p, argp);
212         if (!p)
213                 return ERR_PTR(-EIO);
214
215         return xdr_encode_my_id(p, argp);
216 }
217
218 static __be32 *
219 xdr_encode_common(struct rpc_rqst *rqstp, __be32 *p, struct nsm_args *argp)
220 {
221         char    buffer[20], *name;
222
223         /*
224          * Use the dotted-quad IP address of the remote host as
225          * identifier. Linux statd always looks up the canonical
226          * hostname first for whatever remote hostname it receives,
227          * so this works alright.
228          */
229         if (nsm_use_hostnames) {
230                 name = argp->mon_name;
231         } else {
232                 sprintf(buffer, "%u.%u.%u.%u", NIPQUAD(argp->addr));
233                 name = buffer;
234         }
235         if (!(p = xdr_encode_string(p, name))
236          || !(p = xdr_encode_string(p, utsname()->nodename)))
237                 return ERR_PTR(-EIO);
238         *p++ = htonl(argp->prog);
239         *p++ = htonl(argp->vers);
240         *p++ = htonl(argp->proc);
241
242         return p;
243 }
244
245 static int
246 xdr_encode_mon(struct rpc_rqst *rqstp, __be32 *p, struct nsm_args *argp)
247 {
248         p = xdr_encode_common(rqstp, p, argp);
249         if (IS_ERR(p))
250                 return PTR_ERR(p);
251
252         /* Surprise - there may even be room for an IPv6 address now */
253         *p++ = argp->addr;
254         *p++ = 0;
255         *p++ = 0;
256         *p++ = 0;
257         rqstp->rq_slen = xdr_adjust_iovec(rqstp->rq_svec, p);
258         return 0;
259 }
260
261 static int
262 xdr_encode_unmon(struct rpc_rqst *rqstp, __be32 *p, struct nsm_args *argp)
263 {
264         p = xdr_encode_common(rqstp, p, argp);
265         if (IS_ERR(p))
266                 return PTR_ERR(p);
267         rqstp->rq_slen = xdr_adjust_iovec(rqstp->rq_svec, p);
268         return 0;
269 }
270
271 static int
272 xdr_decode_stat_res(struct rpc_rqst *rqstp, __be32 *p, struct nsm_res *resp)
273 {
274         resp->status = ntohl(*p++);
275         resp->state = ntohl(*p++);
276         dprintk("nsm: xdr_decode_stat_res status %d state %d\n",
277                         resp->status, resp->state);
278         return 0;
279 }
280
281 static int
282 xdr_decode_stat(struct rpc_rqst *rqstp, __be32 *p, struct nsm_res *resp)
283 {
284         resp->state = ntohl(*p++);
285         return 0;
286 }
287
288 #define SM_my_name_sz   (1+XDR_QUADLEN(SM_MAXSTRLEN))
289 #define SM_my_id_sz     (3+1+SM_my_name_sz)
290 #define SM_mon_id_sz    (1+XDR_QUADLEN(20)+SM_my_id_sz)
291 #define SM_mon_sz       (SM_mon_id_sz+4)
292 #define SM_monres_sz    2
293 #define SM_unmonres_sz  1
294
295 static struct rpc_procinfo      nsm_procedures[] = {
296 [SM_MON] = {
297                 .p_proc         = SM_MON,
298                 .p_encode       = (kxdrproc_t) xdr_encode_mon,
299                 .p_decode       = (kxdrproc_t) xdr_decode_stat_res,
300                 .p_arglen       = SM_mon_sz,
301                 .p_replen       = SM_monres_sz,
302                 .p_statidx      = SM_MON,
303                 .p_name         = "MONITOR",
304         },
305 [SM_UNMON] = {
306                 .p_proc         = SM_UNMON,
307                 .p_encode       = (kxdrproc_t) xdr_encode_unmon,
308                 .p_decode       = (kxdrproc_t) xdr_decode_stat,
309                 .p_arglen       = SM_mon_id_sz,
310                 .p_replen       = SM_unmonres_sz,
311                 .p_statidx      = SM_UNMON,
312                 .p_name         = "UNMONITOR",
313         },
314 };
315
316 static struct rpc_version       nsm_version1 = {
317                 .number         = 1,
318                 .nrprocs        = ARRAY_SIZE(nsm_procedures),
319                 .procs          = nsm_procedures
320 };
321
322 static struct rpc_version *     nsm_version[] = {
323         [1] = &nsm_version1,
324 };
325
326 static struct rpc_stat          nsm_stats;
327
328 static struct rpc_program       nsm_program = {
329                 .name           = "statd",
330                 .number         = SM_PROGRAM,
331                 .nrvers         = ARRAY_SIZE(nsm_version),
332                 .version        = nsm_version,
333                 .stats          = &nsm_stats
334 };