blob: 795a0f4e920bf8b4e52e78458b210fea02df8132 [file] [log] [blame]
Chuck Levera5090502007-03-29 16:48:04 -04001/*
2 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
3 * protocol
4 *
5 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
6 * RFC 3530: "Network File System (NFS) version 4 Protocol"
7 *
8 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
9 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
10 *
11 * Descended from net/sunrpc/pmap_clnt.c,
12 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
13 */
14
Chuck Levercce63cd2007-07-01 12:13:12 -040015#include <linux/module.h>
16
Chuck Levera5090502007-03-29 16:48:04 -040017#include <linux/types.h>
18#include <linux/socket.h>
Chuck Lever7402ab192011-05-09 15:22:55 -040019#include <linux/un.h>
Chuck Leverd5b64432007-08-06 11:57:18 -040020#include <linux/in.h>
21#include <linux/in6.h>
Chuck Levera5090502007-03-29 16:48:04 -040022#include <linux/kernel.h>
23#include <linux/errno.h>
Chuck Leverc5266112009-12-03 15:58:56 -050024#include <linux/mutex.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090025#include <linux/slab.h>
Chuck Lever9d548b92008-09-15 16:27:30 -050026#include <net/ipv6.h>
Chuck Levera5090502007-03-29 16:48:04 -040027
28#include <linux/sunrpc/clnt.h>
29#include <linux/sunrpc/sched.h>
\"Talpey, Thomas\0896a722007-09-10 13:48:23 -040030#include <linux/sunrpc/xprtsock.h>
Chuck Levera5090502007-03-29 16:48:04 -040031
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +040032#include "netns.h"
33
Chuck Levera5090502007-03-29 16:48:04 -040034#ifdef RPC_DEBUG
35# define RPCDBG_FACILITY RPCDBG_BIND
36#endif
37
Chuck Lever7402ab192011-05-09 15:22:55 -040038#define RPCBIND_SOCK_PATHNAME "/var/run/rpcbind.sock"
39
Chuck Levera5090502007-03-29 16:48:04 -040040#define RPCBIND_PROGRAM (100000u)
41#define RPCBIND_PORT (111u)
42
Chuck Leverfc200e72008-06-25 17:24:31 -040043#define RPCBVERS_2 (2u)
44#define RPCBVERS_3 (3u)
45#define RPCBVERS_4 (4u)
46
Chuck Levera5090502007-03-29 16:48:04 -040047enum {
48 RPCBPROC_NULL,
49 RPCBPROC_SET,
50 RPCBPROC_UNSET,
51 RPCBPROC_GETPORT,
52 RPCBPROC_GETADDR = 3, /* alias for GETPORT */
53 RPCBPROC_DUMP,
54 RPCBPROC_CALLIT,
55 RPCBPROC_BCAST = 5, /* alias for CALLIT */
56 RPCBPROC_GETTIME,
57 RPCBPROC_UADDR2TADDR,
58 RPCBPROC_TADDR2UADDR,
59 RPCBPROC_GETVERSADDR,
60 RPCBPROC_INDIRECT,
61 RPCBPROC_GETADDRLIST,
62 RPCBPROC_GETSTAT,
63};
64
Chuck Levera5090502007-03-29 16:48:04 -040065/*
Chuck Levera5090502007-03-29 16:48:04 -040066 * r_owner
67 *
68 * The "owner" is allowed to unset a service in the rpcbind database.
Chuck Lever126e4bc2009-03-18 20:47:14 -040069 *
70 * For AF_LOCAL SET/UNSET requests, rpcbind treats this string as a
71 * UID which it maps to a local user name via a password lookup.
72 * In all other cases it is ignored.
73 *
74 * For SET/UNSET requests, user space provides a value, even for
75 * network requests, and GETADDR uses an empty string. We follow
76 * those precedents here.
Chuck Levera5090502007-03-29 16:48:04 -040077 */
Chuck Lever126e4bc2009-03-18 20:47:14 -040078#define RPCB_OWNER_STRING "0"
Chuck Levera5090502007-03-29 16:48:04 -040079#define RPCB_MAXOWNERLEN sizeof(RPCB_OWNER_STRING)
80
Chuck Lever0b10bf52009-08-09 15:09:33 -040081/*
82 * XDR data type sizes
83 */
84#define RPCB_program_sz (1)
85#define RPCB_version_sz (1)
86#define RPCB_protocol_sz (1)
87#define RPCB_port_sz (1)
88#define RPCB_boolean_sz (1)
89
90#define RPCB_netid_sz (1 + XDR_QUADLEN(RPCBIND_MAXNETIDLEN))
91#define RPCB_addr_sz (1 + XDR_QUADLEN(RPCBIND_MAXUADDRLEN))
92#define RPCB_ownerstring_sz (1 + XDR_QUADLEN(RPCB_MAXOWNERLEN))
93
94/*
95 * XDR argument and result sizes
96 */
97#define RPCB_mappingargs_sz (RPCB_program_sz + RPCB_version_sz + \
98 RPCB_protocol_sz + RPCB_port_sz)
99#define RPCB_getaddrargs_sz (RPCB_program_sz + RPCB_version_sz + \
100 RPCB_netid_sz + RPCB_addr_sz + \
101 RPCB_ownerstring_sz)
102
103#define RPCB_getportres_sz RPCB_port_sz
104#define RPCB_setres_sz RPCB_boolean_sz
105
106/*
107 * Note that RFC 1833 does not put any size restrictions on the
108 * address string returned by the remote rpcbind database.
109 */
110#define RPCB_getaddrres_sz RPCB_addr_sz
111
Chuck Levera5090502007-03-29 16:48:04 -0400112static void rpcb_getport_done(struct rpc_task *, void *);
Trond Myklebust381ba742008-07-07 12:18:53 -0400113static void rpcb_map_release(void *data);
Trond Myklebusta613fa12012-01-20 13:53:56 -0500114static const struct rpc_program rpcb_program;
Chuck Levera5090502007-03-29 16:48:04 -0400115
116struct rpcbind_args {
117 struct rpc_xprt * r_xprt;
118
119 u32 r_prog;
120 u32 r_vers;
121 u32 r_prot;
122 unsigned short r_port;
Trond Myklebust86d61d82008-01-07 21:16:56 -0500123 const char * r_netid;
124 const char * r_addr;
125 const char * r_owner;
Trond Myklebust381ba742008-07-07 12:18:53 -0400126
127 int r_status;
Chuck Levera5090502007-03-29 16:48:04 -0400128};
129
130static struct rpc_procinfo rpcb_procedures2[];
131static struct rpc_procinfo rpcb_procedures3[];
Chuck Leverc2e1b092008-07-14 16:03:30 -0400132static struct rpc_procinfo rpcb_procedures4[];
Chuck Levera5090502007-03-29 16:48:04 -0400133
Chuck Leverd5b64432007-08-06 11:57:18 -0400134struct rpcb_info {
Chuck Leverfc200e72008-06-25 17:24:31 -0400135 u32 rpc_vers;
Chuck Levera5090502007-03-29 16:48:04 -0400136 struct rpc_procinfo * rpc_proc;
Chuck Leverd5b64432007-08-06 11:57:18 -0400137};
138
Trond Myklebusta613fa12012-01-20 13:53:56 -0500139static const struct rpcb_info rpcb_next_version[];
140static const struct rpcb_info rpcb_next_version6[];
Chuck Levera5090502007-03-29 16:48:04 -0400141
Chuck Levera5090502007-03-29 16:48:04 -0400142static const struct rpc_call_ops rpcb_getport_ops = {
Chuck Levera5090502007-03-29 16:48:04 -0400143 .rpc_call_done = rpcb_getport_done,
144 .rpc_release = rpcb_map_release,
145};
146
147static void rpcb_wake_rpcbind_waiters(struct rpc_xprt *xprt, int status)
148{
149 xprt_clear_binding(xprt);
150 rpc_wake_up_status(&xprt->binding, status);
151}
152
Trond Myklebust381ba742008-07-07 12:18:53 -0400153static void rpcb_map_release(void *data)
154{
155 struct rpcbind_args *map = data;
156
157 rpcb_wake_rpcbind_waiters(map->r_xprt, map->r_status);
158 xprt_put(map->r_xprt);
Chuck Leverba809132009-08-09 15:09:35 -0400159 kfree(map->r_addr);
Trond Myklebust381ba742008-07-07 12:18:53 -0400160 kfree(map);
161}
162
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400163static int rpcb_get_local(struct net *net)
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300164{
165 int cnt;
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400166 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300167
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400168 spin_lock(&sn->rpcb_clnt_lock);
169 if (sn->rpcb_users)
170 sn->rpcb_users++;
171 cnt = sn->rpcb_users;
172 spin_unlock(&sn->rpcb_clnt_lock);
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300173
174 return cnt;
175}
176
Stanislav Kinsburskyf7a30c12012-01-13 12:52:51 +0400177void rpcb_put_local(struct net *net)
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300178{
Stanislav Kinsburskyf7a30c12012-01-13 12:52:51 +0400179 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400180 struct rpc_clnt *clnt = sn->rpcb_local_clnt;
181 struct rpc_clnt *clnt4 = sn->rpcb_local_clnt4;
Stanislav Kinsbursky9793f7c2012-05-02 16:08:38 +0400182 int shutdown = 0;
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300183
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400184 spin_lock(&sn->rpcb_clnt_lock);
Stanislav Kinsbursky9793f7c2012-05-02 16:08:38 +0400185 if (sn->rpcb_users) {
186 if (--sn->rpcb_users == 0) {
187 sn->rpcb_local_clnt = NULL;
188 sn->rpcb_local_clnt4 = NULL;
189 }
190 shutdown = !sn->rpcb_users;
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300191 }
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400192 spin_unlock(&sn->rpcb_clnt_lock);
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300193
194 if (shutdown) {
195 /*
196 * cleanup_rpcb_clnt - remove xprtsock's sysctls, unregister
197 */
198 if (clnt4)
199 rpc_shutdown_client(clnt4);
200 if (clnt)
201 rpc_shutdown_client(clnt);
202 }
203}
204
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400205static void rpcb_set_local(struct net *net, struct rpc_clnt *clnt,
206 struct rpc_clnt *clnt4)
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300207{
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400208 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400209
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300210 /* Protected by rpcb_create_local_mutex */
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400211 sn->rpcb_local_clnt = clnt;
212 sn->rpcb_local_clnt4 = clnt4;
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300213 smp_wmb();
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400214 sn->rpcb_users = 1;
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300215 dprintk("RPC: created new rpcb local clients (rpcb_local_clnt: "
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400216 "%p, rpcb_local_clnt4: %p) for net %p%s\n",
217 sn->rpcb_local_clnt, sn->rpcb_local_clnt4,
218 net, (net == &init_net) ? " (init_net)" : "");
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300219}
220
Chuck Lever7402ab192011-05-09 15:22:55 -0400221/*
222 * Returns zero on success, otherwise a negative errno value
223 * is returned.
224 */
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400225static int rpcb_create_local_unix(struct net *net)
Chuck Lever7402ab192011-05-09 15:22:55 -0400226{
227 static const struct sockaddr_un rpcb_localaddr_rpcbind = {
228 .sun_family = AF_LOCAL,
229 .sun_path = RPCBIND_SOCK_PATHNAME,
230 };
231 struct rpc_create_args args = {
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400232 .net = net,
Chuck Lever7402ab192011-05-09 15:22:55 -0400233 .protocol = XPRT_TRANSPORT_LOCAL,
234 .address = (struct sockaddr *)&rpcb_localaddr_rpcbind,
235 .addrsize = sizeof(rpcb_localaddr_rpcbind),
236 .servername = "localhost",
237 .program = &rpcb_program,
238 .version = RPCBVERS_2,
239 .authflavor = RPC_AUTH_NULL,
240 };
241 struct rpc_clnt *clnt, *clnt4;
242 int result = 0;
Chuck Levercc5598b2008-07-14 16:03:27 -0400243
Chuck Lever7402ab192011-05-09 15:22:55 -0400244 /*
245 * Because we requested an RPC PING at transport creation time,
246 * this works only if the user space portmapper is rpcbind, and
247 * it's listening on AF_LOCAL on the named socket.
248 */
249 clnt = rpc_create(&args);
250 if (IS_ERR(clnt)) {
251 dprintk("RPC: failed to create AF_LOCAL rpcbind "
252 "client (errno %ld).\n", PTR_ERR(clnt));
Stanislav Kinsburskycaea33d2012-07-20 15:57:48 +0400253 result = PTR_ERR(clnt);
Chuck Lever7402ab192011-05-09 15:22:55 -0400254 goto out;
255 }
256
257 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
258 if (IS_ERR(clnt4)) {
259 dprintk("RPC: failed to bind second program to "
260 "rpcbind v4 client (errno %ld).\n",
261 PTR_ERR(clnt4));
262 clnt4 = NULL;
263 }
264
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400265 rpcb_set_local(net, clnt, clnt4);
Chuck Lever7402ab192011-05-09 15:22:55 -0400266
267out:
268 return result;
269}
Chuck Leverc5266112009-12-03 15:58:56 -0500270
271/*
272 * Returns zero on success, otherwise a negative errno value
273 * is returned.
274 */
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400275static int rpcb_create_local_net(struct net *net)
Chuck Levercc5598b2008-07-14 16:03:27 -0400276{
Chuck Lever7402ab192011-05-09 15:22:55 -0400277 static const struct sockaddr_in rpcb_inaddr_loopback = {
278 .sin_family = AF_INET,
279 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
280 .sin_port = htons(RPCBIND_PORT),
281 };
Chuck Levercc5598b2008-07-14 16:03:27 -0400282 struct rpc_create_args args = {
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400283 .net = net,
Chuck Lever2a76b3b2009-12-03 15:58:56 -0500284 .protocol = XPRT_TRANSPORT_TCP,
Chuck Lever5a462112009-12-03 15:58:56 -0500285 .address = (struct sockaddr *)&rpcb_inaddr_loopback,
286 .addrsize = sizeof(rpcb_inaddr_loopback),
Chuck Levercc5598b2008-07-14 16:03:27 -0400287 .servername = "localhost",
288 .program = &rpcb_program,
Chuck Leverc5266112009-12-03 15:58:56 -0500289 .version = RPCBVERS_2,
Chuck Levercc5598b2008-07-14 16:03:27 -0400290 .authflavor = RPC_AUTH_UNIX,
291 .flags = RPC_CLNT_CREATE_NOPING,
292 };
Chuck Leverc5266112009-12-03 15:58:56 -0500293 struct rpc_clnt *clnt, *clnt4;
294 int result = 0;
Chuck Levercc5598b2008-07-14 16:03:27 -0400295
Chuck Leverc5266112009-12-03 15:58:56 -0500296 clnt = rpc_create(&args);
297 if (IS_ERR(clnt)) {
298 dprintk("RPC: failed to create local rpcbind "
299 "client (errno %ld).\n", PTR_ERR(clnt));
Stanislav Kinsburskycaea33d2012-07-20 15:57:48 +0400300 result = PTR_ERR(clnt);
Chuck Leverc5266112009-12-03 15:58:56 -0500301 goto out;
302 }
303
304 /*
305 * This results in an RPC ping. On systems running portmapper,
306 * the v4 ping will fail. Proceed anyway, but disallow rpcb
307 * v4 upcalls.
308 */
309 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
310 if (IS_ERR(clnt4)) {
Chuck Lever38359352010-09-21 16:55:48 -0400311 dprintk("RPC: failed to bind second program to "
312 "rpcbind v4 client (errno %ld).\n",
313 PTR_ERR(clnt4));
Chuck Leverc5266112009-12-03 15:58:56 -0500314 clnt4 = NULL;
315 }
316
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400317 rpcb_set_local(net, clnt, clnt4);
Chuck Leverc5266112009-12-03 15:58:56 -0500318
319out:
Chuck Lever7402ab192011-05-09 15:22:55 -0400320 return result;
321}
322
323/*
324 * Returns zero on success, otherwise a negative errno value
325 * is returned.
326 */
Stanislav Kinsburskyf7a30c12012-01-13 12:52:51 +0400327int rpcb_create_local(struct net *net)
Chuck Lever7402ab192011-05-09 15:22:55 -0400328{
329 static DEFINE_MUTEX(rpcb_create_local_mutex);
330 int result = 0;
331
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400332 if (rpcb_get_local(net))
Chuck Lever7402ab192011-05-09 15:22:55 -0400333 return result;
334
335 mutex_lock(&rpcb_create_local_mutex);
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400336 if (rpcb_get_local(net))
Chuck Lever7402ab192011-05-09 15:22:55 -0400337 goto out;
338
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400339 if (rpcb_create_local_unix(net) != 0)
340 result = rpcb_create_local_net(net);
Chuck Lever7402ab192011-05-09 15:22:55 -0400341
342out:
Chuck Leverc5266112009-12-03 15:58:56 -0500343 mutex_unlock(&rpcb_create_local_mutex);
344 return result;
Chuck Levercc5598b2008-07-14 16:03:27 -0400345}
346
Trond Myklebust6eac7d32012-01-20 13:53:37 -0500347static struct rpc_clnt *rpcb_create(struct net *net, const char *hostname,
Stanislav Kinsburskyc2550e02012-01-13 12:52:35 +0400348 struct sockaddr *srvaddr, size_t salen,
349 int proto, u32 version)
Chuck Levera5090502007-03-29 16:48:04 -0400350{
351 struct rpc_create_args args = {
Stanislav Kinsburskyc2550e02012-01-13 12:52:35 +0400352 .net = net,
Chuck Levera5090502007-03-29 16:48:04 -0400353 .protocol = proto,
354 .address = srvaddr,
Chuck Lever9f6ad262007-12-10 14:56:31 -0500355 .addrsize = salen,
Chuck Levera5090502007-03-29 16:48:04 -0400356 .servername = hostname,
357 .program = &rpcb_program,
358 .version = version,
359 .authflavor = RPC_AUTH_UNIX,
Chuck Lever423d8b02008-07-14 16:03:28 -0400360 .flags = (RPC_CLNT_CREATE_NOPING |
361 RPC_CLNT_CREATE_NONPRIVPORT),
Chuck Levera5090502007-03-29 16:48:04 -0400362 };
363
Chuck Leverd5b64432007-08-06 11:57:18 -0400364 switch (srvaddr->sa_family) {
365 case AF_INET:
366 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
367 break;
368 case AF_INET6:
369 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
370 break;
371 default:
Pavel Emelyanovc636b572010-10-06 13:45:56 +0400372 return ERR_PTR(-EAFNOSUPPORT);
Chuck Leverd5b64432007-08-06 11:57:18 -0400373 }
374
Chuck Levera5090502007-03-29 16:48:04 -0400375 return rpc_create(&args);
376}
377
Chuck Leverc5266112009-12-03 15:58:56 -0500378static int rpcb_register_call(struct rpc_clnt *clnt, struct rpc_message *msg)
Chuck Leverbabe80e2008-07-14 16:03:29 -0400379{
Chuck Lever14aeb212008-08-18 19:34:00 -0400380 int result, error = 0;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400381
Chuck Lever14aeb212008-08-18 19:34:00 -0400382 msg->rpc_resp = &result;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400383
Chuck Lever2a76b3b2009-12-03 15:58:56 -0500384 error = rpc_call_sync(clnt, msg, RPC_TASK_SOFTCONN);
Chuck Lever14aeb212008-08-18 19:34:00 -0400385 if (error < 0) {
Chuck Lever363f7242009-03-18 20:47:44 -0400386 dprintk("RPC: failed to contact local rpcbind "
Chuck Leverbabe80e2008-07-14 16:03:29 -0400387 "server (errno %d).\n", -error);
Chuck Lever14aeb212008-08-18 19:34:00 -0400388 return error;
389 }
Chuck Leverbabe80e2008-07-14 16:03:29 -0400390
Chuck Leverdb820d62008-09-25 11:57:05 -0400391 if (!result)
Chuck Lever14aeb212008-08-18 19:34:00 -0400392 return -EACCES;
Chuck Lever14aeb212008-08-18 19:34:00 -0400393 return 0;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400394}
395
Chuck Levera5090502007-03-29 16:48:04 -0400396/**
397 * rpcb_register - set or unset a port registration with the local rpcbind svc
Randy Dunlapbda14602012-05-13 10:35:40 -0700398 * @net: target network namespace
Chuck Levera5090502007-03-29 16:48:04 -0400399 * @prog: RPC program number to bind
400 * @vers: RPC version number to bind
Chuck Leverc2e1b092008-07-14 16:03:30 -0400401 * @prot: transport protocol to register
Chuck Levera5090502007-03-29 16:48:04 -0400402 * @port: port value to register
Chuck Lever14aeb212008-08-18 19:34:00 -0400403 *
404 * Returns zero if the registration request was dispatched successfully
405 * and the rpcbind daemon returned success. Otherwise, returns an errno
406 * value that reflects the nature of the error (request could not be
407 * dispatched, timed out, or rpcbind returned an error).
Chuck Levera5090502007-03-29 16:48:04 -0400408 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400409 * RPC services invoke this function to advertise their contact
410 * information via the system's rpcbind daemon. RPC services
411 * invoke this function once for each [program, version, transport]
412 * tuple they wish to advertise.
Chuck Levera5090502007-03-29 16:48:04 -0400413 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400414 * Callers may also unregister RPC services that are no longer
415 * available by setting the passed-in port to zero. This removes
416 * all registered transports for [program, version] from the local
417 * rpcbind database.
418 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400419 * This function uses rpcbind protocol version 2 to contact the
420 * local rpcbind daemon.
421 *
422 * Registration works over both AF_INET and AF_INET6, and services
423 * registered via this function are advertised as available for any
424 * address. If the local rpcbind daemon is listening on AF_INET6,
425 * services registered via this function will be advertised on
426 * IN6ADDR_ANY (ie available for all AF_INET and AF_INET6
427 * addresses).
Chuck Levera5090502007-03-29 16:48:04 -0400428 */
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400429int rpcb_register(struct net *net, u32 prog, u32 vers, int prot, unsigned short port)
Chuck Levera5090502007-03-29 16:48:04 -0400430{
Chuck Levera5090502007-03-29 16:48:04 -0400431 struct rpcbind_args map = {
432 .r_prog = prog,
433 .r_vers = vers,
434 .r_prot = prot,
435 .r_port = port,
436 };
437 struct rpc_message msg = {
Chuck Levera5090502007-03-29 16:48:04 -0400438 .rpc_argp = &map,
Chuck Levera5090502007-03-29 16:48:04 -0400439 };
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400440 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Chuck Levera5090502007-03-29 16:48:04 -0400441
442 dprintk("RPC: %sregistering (%u, %u, %d, %u) with local "
443 "rpcbind\n", (port ? "" : "un"),
444 prog, vers, prot, port);
445
Chuck Leverbabe80e2008-07-14 16:03:29 -0400446 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_UNSET];
447 if (port)
448 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_SET];
449
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400450 return rpcb_register_call(sn->rpcb_local_clnt, &msg);
Chuck Levera5090502007-03-29 16:48:04 -0400451}
452
Chuck Leverc2e1b092008-07-14 16:03:30 -0400453/*
454 * Fill in AF_INET family-specific arguments to register
455 */
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400456static int rpcb_register_inet4(struct sunrpc_net *sn,
457 const struct sockaddr *sap,
Chuck Lever1673d0d2009-03-18 20:47:21 -0400458 struct rpc_message *msg)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400459{
Chuck Lever3aba4552009-03-18 20:47:06 -0400460 const struct sockaddr_in *sin = (const struct sockaddr_in *)sap;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400461 struct rpcbind_args *map = msg->rpc_argp;
Chuck Lever3aba4552009-03-18 20:47:06 -0400462 unsigned short port = ntohs(sin->sin_port);
Chuck Leverba809132009-08-09 15:09:35 -0400463 int result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400464
Trond Myklebustd77385f2011-10-17 16:08:10 -0700465 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400466
467 dprintk("RPC: %sregistering [%u, %u, %s, '%s'] with "
468 "local rpcbind\n", (port ? "" : "un"),
469 map->r_prog, map->r_vers,
470 map->r_addr, map->r_netid);
471
472 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
473 if (port)
474 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
475
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400476 result = rpcb_register_call(sn->rpcb_local_clnt4, msg);
Chuck Leverba809132009-08-09 15:09:35 -0400477 kfree(map->r_addr);
478 return result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400479}
480
481/*
482 * Fill in AF_INET6 family-specific arguments to register
483 */
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400484static int rpcb_register_inet6(struct sunrpc_net *sn,
485 const struct sockaddr *sap,
Chuck Lever1673d0d2009-03-18 20:47:21 -0400486 struct rpc_message *msg)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400487{
Chuck Lever3aba4552009-03-18 20:47:06 -0400488 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sap;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400489 struct rpcbind_args *map = msg->rpc_argp;
Chuck Lever3aba4552009-03-18 20:47:06 -0400490 unsigned short port = ntohs(sin6->sin6_port);
Chuck Leverba809132009-08-09 15:09:35 -0400491 int result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400492
Trond Myklebustd77385f2011-10-17 16:08:10 -0700493 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400494
495 dprintk("RPC: %sregistering [%u, %u, %s, '%s'] with "
496 "local rpcbind\n", (port ? "" : "un"),
497 map->r_prog, map->r_vers,
498 map->r_addr, map->r_netid);
499
500 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
501 if (port)
502 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
503
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400504 result = rpcb_register_call(sn->rpcb_local_clnt4, msg);
Chuck Leverba809132009-08-09 15:09:35 -0400505 kfree(map->r_addr);
506 return result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400507}
508
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400509static int rpcb_unregister_all_protofamilies(struct sunrpc_net *sn,
510 struct rpc_message *msg)
Chuck Lever1673d0d2009-03-18 20:47:21 -0400511{
512 struct rpcbind_args *map = msg->rpc_argp;
513
514 dprintk("RPC: unregistering [%u, %u, '%s'] with "
515 "local rpcbind\n",
516 map->r_prog, map->r_vers, map->r_netid);
517
518 map->r_addr = "";
519 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
520
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400521 return rpcb_register_call(sn->rpcb_local_clnt4, msg);
Chuck Lever1673d0d2009-03-18 20:47:21 -0400522}
523
Chuck Leverc2e1b092008-07-14 16:03:30 -0400524/**
525 * rpcb_v4_register - set or unset a port registration with the local rpcbind
Randy Dunlapbda14602012-05-13 10:35:40 -0700526 * @net: target network namespace
Chuck Leverc2e1b092008-07-14 16:03:30 -0400527 * @program: RPC program number of service to (un)register
528 * @version: RPC version number of service to (un)register
529 * @address: address family, IP address, and port to (un)register
530 * @netid: netid of transport protocol to (un)register
Chuck Lever14aeb212008-08-18 19:34:00 -0400531 *
532 * Returns zero if the registration request was dispatched successfully
533 * and the rpcbind daemon returned success. Otherwise, returns an errno
534 * value that reflects the nature of the error (request could not be
535 * dispatched, timed out, or rpcbind returned an error).
Chuck Leverc2e1b092008-07-14 16:03:30 -0400536 *
537 * RPC services invoke this function to advertise their contact
538 * information via the system's rpcbind daemon. RPC services
539 * invoke this function once for each [program, version, address,
540 * netid] tuple they wish to advertise.
541 *
Chuck Lever1673d0d2009-03-18 20:47:21 -0400542 * Callers may also unregister RPC services that are registered at a
543 * specific address by setting the port number in @address to zero.
544 * They may unregister all registered protocol families at once for
545 * a service by passing a NULL @address argument. If @netid is ""
546 * then all netids for [program, version, address] are unregistered.
Chuck Leverc2e1b092008-07-14 16:03:30 -0400547 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400548 * This function uses rpcbind protocol version 4 to contact the
549 * local rpcbind daemon. The local rpcbind daemon must support
550 * version 4 of the rpcbind protocol in order for these functions
551 * to register a service successfully.
552 *
553 * Supported netids include "udp" and "tcp" for UDP and TCP over
554 * IPv4, and "udp6" and "tcp6" for UDP and TCP over IPv6,
555 * respectively.
556 *
557 * The contents of @address determine the address family and the
558 * port to be registered. The usual practice is to pass INADDR_ANY
559 * as the raw address, but specifying a non-zero address is also
560 * supported by this API if the caller wishes to advertise an RPC
561 * service on a specific network interface.
562 *
563 * Note that passing in INADDR_ANY does not create the same service
564 * registration as IN6ADDR_ANY. The former advertises an RPC
565 * service on any IPv4 address, but not on IPv6. The latter
566 * advertises the service on all IPv4 and IPv6 addresses.
567 */
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400568int rpcb_v4_register(struct net *net, const u32 program, const u32 version,
Chuck Lever14aeb212008-08-18 19:34:00 -0400569 const struct sockaddr *address, const char *netid)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400570{
571 struct rpcbind_args map = {
572 .r_prog = program,
573 .r_vers = version,
574 .r_netid = netid,
575 .r_owner = RPCB_OWNER_STRING,
576 };
577 struct rpc_message msg = {
578 .rpc_argp = &map,
Chuck Leverc2e1b092008-07-14 16:03:30 -0400579 };
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400580 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Chuck Leverc5266112009-12-03 15:58:56 -0500581
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400582 if (sn->rpcb_local_clnt4 == NULL)
Chuck Leverc5266112009-12-03 15:58:56 -0500583 return -EPROTONOSUPPORT;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400584
Chuck Lever1673d0d2009-03-18 20:47:21 -0400585 if (address == NULL)
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400586 return rpcb_unregister_all_protofamilies(sn, &msg);
Chuck Lever1673d0d2009-03-18 20:47:21 -0400587
Chuck Leverc2e1b092008-07-14 16:03:30 -0400588 switch (address->sa_family) {
589 case AF_INET:
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400590 return rpcb_register_inet4(sn, address, &msg);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400591 case AF_INET6:
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400592 return rpcb_register_inet6(sn, address, &msg);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400593 }
594
595 return -EAFNOSUPPORT;
596}
597
Trond Myklebust803a9062008-07-01 15:20:55 -0400598static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt, struct rpcbind_args *map, struct rpc_procinfo *proc)
Trond Myklebust5138fde2007-07-14 15:40:01 -0400599{
600 struct rpc_message msg = {
Trond Myklebust803a9062008-07-01 15:20:55 -0400601 .rpc_proc = proc,
Trond Myklebust5138fde2007-07-14 15:40:01 -0400602 .rpc_argp = map,
Chuck Leverc0c077d2009-08-09 15:09:43 -0400603 .rpc_resp = map,
Trond Myklebust5138fde2007-07-14 15:40:01 -0400604 };
605 struct rpc_task_setup task_setup_data = {
606 .rpc_client = rpcb_clnt,
607 .rpc_message = &msg,
608 .callback_ops = &rpcb_getport_ops,
609 .callback_data = map,
Chuck Lever012da152009-12-03 15:58:56 -0500610 .flags = RPC_TASK_ASYNC | RPC_TASK_SOFTCONN,
Trond Myklebust5138fde2007-07-14 15:40:01 -0400611 };
612
613 return rpc_run_task(&task_setup_data);
614}
615
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400616/*
617 * In the case where rpc clients have been cloned, we want to make
618 * sure that we use the program number/version etc of the actual
619 * owner of the xprt. To do so, we walk back up the tree of parents
620 * to find whoever created the transport and/or whoever has the
621 * autobind flag set.
622 */
623static struct rpc_clnt *rpcb_find_transport_owner(struct rpc_clnt *clnt)
624{
625 struct rpc_clnt *parent = clnt->cl_parent;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500626 struct rpc_xprt *xprt = rcu_dereference(clnt->cl_xprt);
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400627
628 while (parent != clnt) {
Trond Myklebust2446ab62012-03-01 17:00:56 -0500629 if (rcu_dereference(parent->cl_xprt) != xprt)
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400630 break;
631 if (clnt->cl_autobind)
632 break;
633 clnt = parent;
634 parent = parent->cl_parent;
635 }
636 return clnt;
637}
638
Chuck Levera5090502007-03-29 16:48:04 -0400639/**
Chuck Lever45160d62007-07-01 12:13:17 -0400640 * rpcb_getport_async - obtain the port for a given RPC service on a given host
Chuck Levera5090502007-03-29 16:48:04 -0400641 * @task: task that is waiting for portmapper request
642 *
643 * This one can be called for an ongoing RPC request, and can be used in
644 * an async (rpciod) context.
645 */
Chuck Lever45160d62007-07-01 12:13:17 -0400646void rpcb_getport_async(struct rpc_task *task)
Chuck Levera5090502007-03-29 16:48:04 -0400647{
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400648 struct rpc_clnt *clnt;
Trond Myklebust803a9062008-07-01 15:20:55 -0400649 struct rpc_procinfo *proc;
Chuck Lever0a48f5d2007-12-10 14:56:38 -0500650 u32 bind_version;
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400651 struct rpc_xprt *xprt;
Chuck Levera5090502007-03-29 16:48:04 -0400652 struct rpc_clnt *rpcb_clnt;
Ben Greearec0dd262011-07-12 10:27:55 -0700653 struct rpcbind_args *map;
Chuck Levera5090502007-03-29 16:48:04 -0400654 struct rpc_task *child;
Chuck Lever9f6ad262007-12-10 14:56:31 -0500655 struct sockaddr_storage addr;
656 struct sockaddr *sap = (struct sockaddr *)&addr;
657 size_t salen;
Chuck Levera5090502007-03-29 16:48:04 -0400658 int status;
659
Trond Myklebust2446ab62012-03-01 17:00:56 -0500660 rcu_read_lock();
661 do {
662 clnt = rpcb_find_transport_owner(task->tk_client);
663 xprt = xprt_get(rcu_dereference(clnt->cl_xprt));
664 } while (xprt == NULL);
665 rcu_read_unlock();
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400666
Chuck Lever45160d62007-07-01 12:13:17 -0400667 dprintk("RPC: %5u %s(%s, %u, %u, %d)\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800668 task->tk_pid, __func__,
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500669 xprt->servername, clnt->cl_prog, clnt->cl_vers, xprt->prot);
Chuck Levera5090502007-03-29 16:48:04 -0400670
Trond Myklebust381ba742008-07-07 12:18:53 -0400671 /* Put self on the wait queue to ensure we get notified if
672 * some other task is already attempting to bind the port */
673 rpc_sleep_on(&xprt->binding, task, NULL);
674
Chuck Levera5090502007-03-29 16:48:04 -0400675 if (xprt_test_and_set_binding(xprt)) {
Chuck Lever45160d62007-07-01 12:13:17 -0400676 dprintk("RPC: %5u %s: waiting for another binder\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800677 task->tk_pid, __func__);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500678 xprt_put(xprt);
Trond Myklebust381ba742008-07-07 12:18:53 -0400679 return;
Chuck Levera5090502007-03-29 16:48:04 -0400680 }
681
Chuck Levera5090502007-03-29 16:48:04 -0400682 /* Someone else may have bound if we slept */
683 if (xprt_bound(xprt)) {
684 status = 0;
Chuck Lever45160d62007-07-01 12:13:17 -0400685 dprintk("RPC: %5u %s: already bound\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800686 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400687 goto bailout_nofree;
688 }
689
Chuck Leverba809132009-08-09 15:09:35 -0400690 /* Parent transport's destination address */
Chuck Lever9f6ad262007-12-10 14:56:31 -0500691 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
Chuck Leverd5b64432007-08-06 11:57:18 -0400692
693 /* Don't ever use rpcbind v2 for AF_INET6 requests */
Chuck Lever9f6ad262007-12-10 14:56:31 -0500694 switch (sap->sa_family) {
Chuck Leverd5b64432007-08-06 11:57:18 -0400695 case AF_INET:
Trond Myklebust803a9062008-07-01 15:20:55 -0400696 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
697 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400698 break;
699 case AF_INET6:
Trond Myklebust803a9062008-07-01 15:20:55 -0400700 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
701 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400702 break;
703 default:
704 status = -EAFNOSUPPORT;
705 dprintk("RPC: %5u %s: bad address family\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800706 task->tk_pid, __func__);
Chuck Leverd5b64432007-08-06 11:57:18 -0400707 goto bailout_nofree;
708 }
Trond Myklebust803a9062008-07-01 15:20:55 -0400709 if (proc == NULL) {
Chuck Levera5090502007-03-29 16:48:04 -0400710 xprt->bind_index = 0;
Chuck Lever906462a2007-09-11 18:00:47 -0400711 status = -EPFNOSUPPORT;
Chuck Lever45160d62007-07-01 12:13:17 -0400712 dprintk("RPC: %5u %s: no more getport versions available\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800713 task->tk_pid, __func__);
Chuck Levera5090502007-03-29 16:48:04 -0400714 goto bailout_nofree;
715 }
Chuck Levera5090502007-03-29 16:48:04 -0400716
Chuck Lever45160d62007-07-01 12:13:17 -0400717 dprintk("RPC: %5u %s: trying rpcbind version %u\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800718 task->tk_pid, __func__, bind_version);
Chuck Levera5090502007-03-29 16:48:04 -0400719
Trond Myklebust4e0038b2012-03-01 17:01:05 -0500720 rpcb_clnt = rpcb_create(xprt->xprt_net, xprt->servername, sap, salen,
Stanislav Kinsburskyc2550e02012-01-13 12:52:35 +0400721 xprt->prot, bind_version);
Chuck Lever143b6c42007-08-16 16:03:31 -0400722 if (IS_ERR(rpcb_clnt)) {
723 status = PTR_ERR(rpcb_clnt);
724 dprintk("RPC: %5u %s: rpcb_create failed, error %ld\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800725 task->tk_pid, __func__, PTR_ERR(rpcb_clnt));
Chuck Lever143b6c42007-08-16 16:03:31 -0400726 goto bailout_nofree;
727 }
728
Chuck Levera5090502007-03-29 16:48:04 -0400729 map = kzalloc(sizeof(struct rpcbind_args), GFP_ATOMIC);
730 if (!map) {
731 status = -ENOMEM;
Chuck Lever45160d62007-07-01 12:13:17 -0400732 dprintk("RPC: %5u %s: no memory available\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800733 task->tk_pid, __func__);
Trond Myklebust96165e22008-10-03 16:48:40 -0400734 goto bailout_release_client;
Chuck Levera5090502007-03-29 16:48:04 -0400735 }
736 map->r_prog = clnt->cl_prog;
737 map->r_vers = clnt->cl_vers;
738 map->r_prot = xprt->prot;
739 map->r_port = 0;
Bryan Schumaker864cf9b2012-03-27 13:46:32 -0400740 map->r_xprt = xprt;
Trond Myklebust381ba742008-07-07 12:18:53 -0400741 map->r_status = -EIO;
Chuck Levera5090502007-03-29 16:48:04 -0400742
Chuck Leverba809132009-08-09 15:09:35 -0400743 switch (bind_version) {
744 case RPCBVERS_4:
745 case RPCBVERS_3:
Trond Myklebust2446ab62012-03-01 17:00:56 -0500746 map->r_netid = xprt->address_strings[RPC_DISPLAY_NETID];
Trond Myklebustd77385f2011-10-17 16:08:10 -0700747 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_ATOMIC);
Chuck Leverba809132009-08-09 15:09:35 -0400748 map->r_owner = "";
749 break;
750 case RPCBVERS_2:
751 map->r_addr = NULL;
752 break;
753 default:
754 BUG();
755 }
756
Trond Myklebust803a9062008-07-01 15:20:55 -0400757 child = rpcb_call_async(rpcb_clnt, map, proc);
Trond Myklebust4c402b42007-06-14 16:40:32 -0400758 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400759 if (IS_ERR(child)) {
Trond Myklebust0d3a34b2008-07-07 12:18:52 -0400760 /* rpcb_map_release() has freed the arguments */
Chuck Lever45160d62007-07-01 12:13:17 -0400761 dprintk("RPC: %5u %s: rpc_run_task failed\n",
Harvey Harrison0dc47872008-03-05 20:47:47 -0800762 task->tk_pid, __func__);
Trond Myklebust381ba742008-07-07 12:18:53 -0400763 return;
Chuck Levera5090502007-03-29 16:48:04 -0400764 }
Chuck Levera5090502007-03-29 16:48:04 -0400765
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400766 xprt->stat.bind_count++;
767 rpc_put_task(child);
Chuck Levera5090502007-03-29 16:48:04 -0400768 return;
769
Trond Myklebust96165e22008-10-03 16:48:40 -0400770bailout_release_client:
771 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400772bailout_nofree:
773 rpcb_wake_rpcbind_waiters(xprt, status);
Chuck Levera5090502007-03-29 16:48:04 -0400774 task->tk_status = status;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500775 xprt_put(xprt);
Chuck Levera5090502007-03-29 16:48:04 -0400776}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400777EXPORT_SYMBOL_GPL(rpcb_getport_async);
Chuck Levera5090502007-03-29 16:48:04 -0400778
779/*
780 * Rpcbind child task calls this callback via tk_exit.
781 */
782static void rpcb_getport_done(struct rpc_task *child, void *data)
783{
784 struct rpcbind_args *map = data;
785 struct rpc_xprt *xprt = map->r_xprt;
786 int status = child->tk_status;
787
Chuck Lever4784cb52007-09-11 18:00:36 -0400788 /* Garbage reply: retry with a lesser rpcbind version */
789 if (status == -EIO)
790 status = -EPROTONOSUPPORT;
791
Chuck Levera5090502007-03-29 16:48:04 -0400792 /* rpcbind server doesn't support this rpcbind protocol version */
793 if (status == -EPROTONOSUPPORT)
794 xprt->bind_index++;
795
796 if (status < 0) {
797 /* rpcbind server not available on remote host? */
798 xprt->ops->set_port(xprt, 0);
799 } else if (map->r_port == 0) {
800 /* Requested RPC service wasn't registered on remote host */
801 xprt->ops->set_port(xprt, 0);
802 status = -EACCES;
803 } else {
804 /* Succeeded */
805 xprt->ops->set_port(xprt, map->r_port);
806 xprt_set_bound(xprt);
807 status = 0;
808 }
809
810 dprintk("RPC: %5u rpcb_getport_done(status %d, port %u)\n",
811 child->tk_pid, status, map->r_port);
812
Trond Myklebust381ba742008-07-07 12:18:53 -0400813 map->r_status = status;
Chuck Levera5090502007-03-29 16:48:04 -0400814}
815
Chuck Lever166b88d2008-07-14 16:03:26 -0400816/*
817 * XDR functions for rpcbind
818 */
819
Chuck Lever9f06c712010-12-14 14:59:18 +0000820static void rpcb_enc_mapping(struct rpc_rqst *req, struct xdr_stream *xdr,
821 const struct rpcbind_args *rpcb)
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400822{
Chuck Lever9f06c712010-12-14 14:59:18 +0000823 __be32 *p;
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400824
825 dprintk("RPC: %5u encoding PMAP_%s call (%u, %u, %d, %u)\n",
Trond Myklebustffa94db2012-03-20 09:22:00 -0400826 req->rq_task->tk_pid,
827 req->rq_task->tk_msg.rpc_proc->p_name,
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400828 rpcb->r_prog, rpcb->r_vers, rpcb->r_prot, rpcb->r_port);
829
Chuck Lever9f06c712010-12-14 14:59:18 +0000830 p = xdr_reserve_space(xdr, RPCB_mappingargs_sz << 2);
Chuck Lever4129ccf2010-12-14 14:58:59 +0000831 *p++ = cpu_to_be32(rpcb->r_prog);
832 *p++ = cpu_to_be32(rpcb->r_vers);
833 *p++ = cpu_to_be32(rpcb->r_prot);
834 *p = cpu_to_be32(rpcb->r_port);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400835}
836
Chuck Leverbf269552010-12-14 14:59:29 +0000837static int rpcb_dec_getport(struct rpc_rqst *req, struct xdr_stream *xdr,
Chuck Leverc0c077d2009-08-09 15:09:43 -0400838 struct rpcbind_args *rpcb)
839{
Chuck Leverc0c077d2009-08-09 15:09:43 -0400840 unsigned long port;
Chuck Leverbf269552010-12-14 14:59:29 +0000841 __be32 *p;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400842
843 rpcb->r_port = 0;
844
Chuck Leverbf269552010-12-14 14:59:29 +0000845 p = xdr_inline_decode(xdr, 4);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400846 if (unlikely(p == NULL))
847 return -EIO;
848
Chuck Lever4129ccf2010-12-14 14:58:59 +0000849 port = be32_to_cpup(p);
Trond Myklebustffa94db2012-03-20 09:22:00 -0400850 dprintk("RPC: %5u PMAP_%s result: %lu\n", req->rq_task->tk_pid,
851 req->rq_task->tk_msg.rpc_proc->p_name, port);
Alexey Dobriyan4be929b2010-05-24 14:33:03 -0700852 if (unlikely(port > USHRT_MAX))
Chuck Leverc0c077d2009-08-09 15:09:43 -0400853 return -EIO;
854
855 rpcb->r_port = port;
856 return 0;
857}
858
Chuck Leverbf269552010-12-14 14:59:29 +0000859static int rpcb_dec_set(struct rpc_rqst *req, struct xdr_stream *xdr,
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400860 unsigned int *boolp)
861{
Chuck Leverbf269552010-12-14 14:59:29 +0000862 __be32 *p;
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400863
Chuck Leverbf269552010-12-14 14:59:29 +0000864 p = xdr_inline_decode(xdr, 4);
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400865 if (unlikely(p == NULL))
866 return -EIO;
867
868 *boolp = 0;
Chuck Leverbf269552010-12-14 14:59:29 +0000869 if (*p != xdr_zero)
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400870 *boolp = 1;
871
872 dprintk("RPC: %5u RPCB_%s call %s\n",
Trond Myklebustffa94db2012-03-20 09:22:00 -0400873 req->rq_task->tk_pid,
874 req->rq_task->tk_msg.rpc_proc->p_name,
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400875 (*boolp ? "succeeded" : "failed"));
876 return 0;
877}
878
Chuck Lever4129ccf2010-12-14 14:58:59 +0000879static void encode_rpcb_string(struct xdr_stream *xdr, const char *string,
880 const u32 maxstrlen)
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400881{
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400882 __be32 *p;
Chuck Lever4129ccf2010-12-14 14:58:59 +0000883 u32 len;
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400884
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400885 len = strlen(string);
Weston Andros Adamson332e0082012-10-23 10:43:44 -0400886 WARN_ON_ONCE(len > maxstrlen);
887 if (len > maxstrlen)
888 /* truncate and hope for the best */
889 len = maxstrlen;
Chuck Lever4129ccf2010-12-14 14:58:59 +0000890 p = xdr_reserve_space(xdr, 4 + len);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400891 xdr_encode_opaque(p, string, len);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400892}
893
Chuck Lever9f06c712010-12-14 14:59:18 +0000894static void rpcb_enc_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
895 const struct rpcbind_args *rpcb)
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400896{
Chuck Lever9f06c712010-12-14 14:59:18 +0000897 __be32 *p;
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400898
899 dprintk("RPC: %5u encoding RPCB_%s call (%u, %u, '%s', '%s')\n",
Trond Myklebustffa94db2012-03-20 09:22:00 -0400900 req->rq_task->tk_pid,
901 req->rq_task->tk_msg.rpc_proc->p_name,
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400902 rpcb->r_prog, rpcb->r_vers,
903 rpcb->r_netid, rpcb->r_addr);
904
Chuck Lever9f06c712010-12-14 14:59:18 +0000905 p = xdr_reserve_space(xdr, (RPCB_program_sz + RPCB_version_sz) << 2);
Chuck Lever4129ccf2010-12-14 14:58:59 +0000906 *p++ = cpu_to_be32(rpcb->r_prog);
907 *p = cpu_to_be32(rpcb->r_vers);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400908
Chuck Lever9f06c712010-12-14 14:59:18 +0000909 encode_rpcb_string(xdr, rpcb->r_netid, RPCBIND_MAXNETIDLEN);
910 encode_rpcb_string(xdr, rpcb->r_addr, RPCBIND_MAXUADDRLEN);
911 encode_rpcb_string(xdr, rpcb->r_owner, RPCB_MAXOWNERLEN);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400912}
913
Chuck Leverbf269552010-12-14 14:59:29 +0000914static int rpcb_dec_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
Chuck Leverc0c077d2009-08-09 15:09:43 -0400915 struct rpcbind_args *rpcb)
916{
917 struct sockaddr_storage address;
918 struct sockaddr *sap = (struct sockaddr *)&address;
Chuck Leverbf269552010-12-14 14:59:29 +0000919 __be32 *p;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400920 u32 len;
921
922 rpcb->r_port = 0;
923
Chuck Leverbf269552010-12-14 14:59:29 +0000924 p = xdr_inline_decode(xdr, 4);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400925 if (unlikely(p == NULL))
926 goto out_fail;
Chuck Lever4129ccf2010-12-14 14:58:59 +0000927 len = be32_to_cpup(p);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400928
929 /*
930 * If the returned universal address is a null string,
931 * the requested RPC service was not registered.
932 */
933 if (len == 0) {
934 dprintk("RPC: %5u RPCB reply: program not registered\n",
Trond Myklebustffa94db2012-03-20 09:22:00 -0400935 req->rq_task->tk_pid);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400936 return 0;
937 }
938
939 if (unlikely(len > RPCBIND_MAXUADDRLEN))
940 goto out_fail;
941
Chuck Leverbf269552010-12-14 14:59:29 +0000942 p = xdr_inline_decode(xdr, len);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400943 if (unlikely(p == NULL))
944 goto out_fail;
Trond Myklebustffa94db2012-03-20 09:22:00 -0400945 dprintk("RPC: %5u RPCB_%s reply: %s\n", req->rq_task->tk_pid,
946 req->rq_task->tk_msg.rpc_proc->p_name, (char *)p);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400947
Stanislav Kinsburskyb030fb02012-01-13 14:02:40 +0400948 if (rpc_uaddr2sockaddr(req->rq_xprt->xprt_net, (char *)p, len,
949 sap, sizeof(address)) == 0)
Chuck Leverc0c077d2009-08-09 15:09:43 -0400950 goto out_fail;
951 rpcb->r_port = rpc_get_port(sap);
952
953 return 0;
954
955out_fail:
956 dprintk("RPC: %5u malformed RPCB_%s reply\n",
Trond Myklebustffa94db2012-03-20 09:22:00 -0400957 req->rq_task->tk_pid,
958 req->rq_task->tk_msg.rpc_proc->p_name);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400959 return -EIO;
960}
961
Chuck Levera5090502007-03-29 16:48:04 -0400962/*
963 * Not all rpcbind procedures described in RFC 1833 are implemented
964 * since the Linux kernel RPC code requires only these.
965 */
Chuck Leverf8b761e2009-08-09 15:09:44 -0400966
Chuck Levera5090502007-03-29 16:48:04 -0400967static struct rpc_procinfo rpcb_procedures2[] = {
Chuck Leverf8b761e2009-08-09 15:09:44 -0400968 [RPCBPROC_SET] = {
969 .p_proc = RPCBPROC_SET,
Chuck Lever9f06c712010-12-14 14:59:18 +0000970 .p_encode = (kxdreproc_t)rpcb_enc_mapping,
Chuck Leverbf269552010-12-14 14:59:29 +0000971 .p_decode = (kxdrdproc_t)rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400972 .p_arglen = RPCB_mappingargs_sz,
973 .p_replen = RPCB_setres_sz,
974 .p_statidx = RPCBPROC_SET,
975 .p_timer = 0,
976 .p_name = "SET",
977 },
978 [RPCBPROC_UNSET] = {
979 .p_proc = RPCBPROC_UNSET,
Chuck Lever9f06c712010-12-14 14:59:18 +0000980 .p_encode = (kxdreproc_t)rpcb_enc_mapping,
Chuck Leverbf269552010-12-14 14:59:29 +0000981 .p_decode = (kxdrdproc_t)rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400982 .p_arglen = RPCB_mappingargs_sz,
983 .p_replen = RPCB_setres_sz,
984 .p_statidx = RPCBPROC_UNSET,
985 .p_timer = 0,
986 .p_name = "UNSET",
987 },
988 [RPCBPROC_GETPORT] = {
989 .p_proc = RPCBPROC_GETPORT,
Chuck Lever9f06c712010-12-14 14:59:18 +0000990 .p_encode = (kxdreproc_t)rpcb_enc_mapping,
Chuck Leverbf269552010-12-14 14:59:29 +0000991 .p_decode = (kxdrdproc_t)rpcb_dec_getport,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400992 .p_arglen = RPCB_mappingargs_sz,
993 .p_replen = RPCB_getportres_sz,
994 .p_statidx = RPCBPROC_GETPORT,
995 .p_timer = 0,
996 .p_name = "GETPORT",
997 },
Chuck Levera5090502007-03-29 16:48:04 -0400998};
999
1000static struct rpc_procinfo rpcb_procedures3[] = {
Chuck Leverf8b761e2009-08-09 15:09:44 -04001001 [RPCBPROC_SET] = {
1002 .p_proc = RPCBPROC_SET,
Chuck Lever9f06c712010-12-14 14:59:18 +00001003 .p_encode = (kxdreproc_t)rpcb_enc_getaddr,
Chuck Leverbf269552010-12-14 14:59:29 +00001004 .p_decode = (kxdrdproc_t)rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001005 .p_arglen = RPCB_getaddrargs_sz,
1006 .p_replen = RPCB_setres_sz,
1007 .p_statidx = RPCBPROC_SET,
1008 .p_timer = 0,
1009 .p_name = "SET",
1010 },
1011 [RPCBPROC_UNSET] = {
1012 .p_proc = RPCBPROC_UNSET,
Chuck Lever9f06c712010-12-14 14:59:18 +00001013 .p_encode = (kxdreproc_t)rpcb_enc_getaddr,
Chuck Leverbf269552010-12-14 14:59:29 +00001014 .p_decode = (kxdrdproc_t)rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001015 .p_arglen = RPCB_getaddrargs_sz,
1016 .p_replen = RPCB_setres_sz,
1017 .p_statidx = RPCBPROC_UNSET,
1018 .p_timer = 0,
1019 .p_name = "UNSET",
1020 },
1021 [RPCBPROC_GETADDR] = {
1022 .p_proc = RPCBPROC_GETADDR,
Chuck Lever9f06c712010-12-14 14:59:18 +00001023 .p_encode = (kxdreproc_t)rpcb_enc_getaddr,
Chuck Leverbf269552010-12-14 14:59:29 +00001024 .p_decode = (kxdrdproc_t)rpcb_dec_getaddr,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001025 .p_arglen = RPCB_getaddrargs_sz,
1026 .p_replen = RPCB_getaddrres_sz,
1027 .p_statidx = RPCBPROC_GETADDR,
1028 .p_timer = 0,
1029 .p_name = "GETADDR",
1030 },
Chuck Levera5090502007-03-29 16:48:04 -04001031};
1032
1033static struct rpc_procinfo rpcb_procedures4[] = {
Chuck Leverf8b761e2009-08-09 15:09:44 -04001034 [RPCBPROC_SET] = {
1035 .p_proc = RPCBPROC_SET,
Chuck Lever9f06c712010-12-14 14:59:18 +00001036 .p_encode = (kxdreproc_t)rpcb_enc_getaddr,
Chuck Leverbf269552010-12-14 14:59:29 +00001037 .p_decode = (kxdrdproc_t)rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001038 .p_arglen = RPCB_getaddrargs_sz,
1039 .p_replen = RPCB_setres_sz,
1040 .p_statidx = RPCBPROC_SET,
1041 .p_timer = 0,
1042 .p_name = "SET",
1043 },
1044 [RPCBPROC_UNSET] = {
1045 .p_proc = RPCBPROC_UNSET,
Chuck Lever9f06c712010-12-14 14:59:18 +00001046 .p_encode = (kxdreproc_t)rpcb_enc_getaddr,
Chuck Leverbf269552010-12-14 14:59:29 +00001047 .p_decode = (kxdrdproc_t)rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001048 .p_arglen = RPCB_getaddrargs_sz,
1049 .p_replen = RPCB_setres_sz,
1050 .p_statidx = RPCBPROC_UNSET,
1051 .p_timer = 0,
1052 .p_name = "UNSET",
1053 },
1054 [RPCBPROC_GETADDR] = {
1055 .p_proc = RPCBPROC_GETADDR,
Chuck Lever9f06c712010-12-14 14:59:18 +00001056 .p_encode = (kxdreproc_t)rpcb_enc_getaddr,
Chuck Leverbf269552010-12-14 14:59:29 +00001057 .p_decode = (kxdrdproc_t)rpcb_dec_getaddr,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001058 .p_arglen = RPCB_getaddrargs_sz,
1059 .p_replen = RPCB_getaddrres_sz,
1060 .p_statidx = RPCBPROC_GETADDR,
1061 .p_timer = 0,
1062 .p_name = "GETADDR",
1063 },
Chuck Levera5090502007-03-29 16:48:04 -04001064};
1065
Trond Myklebusta613fa12012-01-20 13:53:56 -05001066static const struct rpcb_info rpcb_next_version[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001067 {
1068 .rpc_vers = RPCBVERS_2,
1069 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
1070 },
1071 {
1072 .rpc_proc = NULL,
1073 },
Chuck Levera5090502007-03-29 16:48:04 -04001074};
1075
Trond Myklebusta613fa12012-01-20 13:53:56 -05001076static const struct rpcb_info rpcb_next_version6[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001077 {
1078 .rpc_vers = RPCBVERS_4,
Chuck Lever88424132008-06-25 17:24:47 -04001079 .rpc_proc = &rpcb_procedures4[RPCBPROC_GETADDR],
Chuck Leverfc200e72008-06-25 17:24:31 -04001080 },
1081 {
1082 .rpc_vers = RPCBVERS_3,
1083 .rpc_proc = &rpcb_procedures3[RPCBPROC_GETADDR],
1084 },
Chuck Leverfc200e72008-06-25 17:24:31 -04001085 {
1086 .rpc_proc = NULL,
1087 },
Chuck Leverd5b64432007-08-06 11:57:18 -04001088};
1089
Trond Myklebusta613fa12012-01-20 13:53:56 -05001090static const struct rpc_version rpcb_version2 = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001091 .number = RPCBVERS_2,
Chuck Lever1ac7c232010-12-14 14:59:09 +00001092 .nrprocs = ARRAY_SIZE(rpcb_procedures2),
Chuck Levera5090502007-03-29 16:48:04 -04001093 .procs = rpcb_procedures2
1094};
1095
Trond Myklebusta613fa12012-01-20 13:53:56 -05001096static const struct rpc_version rpcb_version3 = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001097 .number = RPCBVERS_3,
Chuck Lever1ac7c232010-12-14 14:59:09 +00001098 .nrprocs = ARRAY_SIZE(rpcb_procedures3),
Chuck Levera5090502007-03-29 16:48:04 -04001099 .procs = rpcb_procedures3
1100};
1101
Trond Myklebusta613fa12012-01-20 13:53:56 -05001102static const struct rpc_version rpcb_version4 = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001103 .number = RPCBVERS_4,
Chuck Lever1ac7c232010-12-14 14:59:09 +00001104 .nrprocs = ARRAY_SIZE(rpcb_procedures4),
Chuck Levera5090502007-03-29 16:48:04 -04001105 .procs = rpcb_procedures4
1106};
1107
Trond Myklebusta613fa12012-01-20 13:53:56 -05001108static const struct rpc_version *rpcb_version[] = {
Chuck Levera5090502007-03-29 16:48:04 -04001109 NULL,
1110 NULL,
1111 &rpcb_version2,
1112 &rpcb_version3,
1113 &rpcb_version4
1114};
1115
1116static struct rpc_stat rpcb_stats;
1117
Trond Myklebusta613fa12012-01-20 13:53:56 -05001118static const struct rpc_program rpcb_program = {
Chuck Levera5090502007-03-29 16:48:04 -04001119 .name = "rpcbind",
1120 .number = RPCBIND_PROGRAM,
1121 .nrvers = ARRAY_SIZE(rpcb_version),
1122 .version = rpcb_version,
1123 .stats = &rpcb_stats,
1124};