blob: 647b323cc1d56f79347eee30f88445753e35d24a [file] [log] [blame]
Thomas Gleixner457c8992019-05-19 13:08:55 +01001// SPDX-License-Identifier: GPL-2.0-only
Chuck Levera5090502007-03-29 16:48:04 -04002/*
3 * In-kernel rpcbind client supporting versions 2, 3, and 4 of the rpcbind
4 * protocol
5 *
6 * Based on RFC 1833: "Binding Protocols for ONC RPC Version 2" and
7 * RFC 3530: "Network File System (NFS) version 4 Protocol"
8 *
9 * Original: Gilles Quillard, Bull Open Source, 2005 <gilles.quillard@bull.net>
10 * Updated: Chuck Lever, Oracle Corporation, 2007 <chuck.lever@oracle.com>
11 *
12 * Descended from net/sunrpc/pmap_clnt.c,
13 * Copyright (C) 1996, Olaf Kirch <okir@monad.swb.de>
14 */
15
Chuck Levercce63cd2007-07-01 12:13:12 -040016#include <linux/module.h>
17
Chuck Levera5090502007-03-29 16:48:04 -040018#include <linux/types.h>
19#include <linux/socket.h>
Chuck Lever7402ab192011-05-09 15:22:55 -040020#include <linux/un.h>
Chuck Leverd5b64432007-08-06 11:57:18 -040021#include <linux/in.h>
22#include <linux/in6.h>
Chuck Levera5090502007-03-29 16:48:04 -040023#include <linux/kernel.h>
24#include <linux/errno.h>
Chuck Leverc5266112009-12-03 15:58:56 -050025#include <linux/mutex.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090026#include <linux/slab.h>
Chuck Lever9d548b92008-09-15 16:27:30 -050027#include <net/ipv6.h>
Chuck Levera5090502007-03-29 16:48:04 -040028
29#include <linux/sunrpc/clnt.h>
Jeff Layton59766872013-02-04 12:50:00 -050030#include <linux/sunrpc/addr.h>
Chuck Levera5090502007-03-29 16:48:04 -040031#include <linux/sunrpc/sched.h>
\"Talpey, Thomas\0896a722007-09-10 13:48:23 -040032#include <linux/sunrpc/xprtsock.h>
Chuck Levera5090502007-03-29 16:48:04 -040033
Chuck Levere465cc32020-07-08 16:10:19 -040034#include <trace/events/sunrpc.h>
35
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +040036#include "netns.h"
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
Christoph Hellwig499b4982017-05-12 15:36:49 +0200130static const struct rpc_procinfo rpcb_procedures2[];
131static const struct rpc_procinfo rpcb_procedures3[];
132static const 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;
Christoph Hellwig499b4982017-05-12 15:36:49 +0200136 const 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,
Trond Myklebust786615b2013-08-05 16:04:47 -0400206 struct rpc_clnt *clnt4,
207 bool is_af_local)
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300208{
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400209 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400210
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300211 /* Protected by rpcb_create_local_mutex */
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400212 sn->rpcb_local_clnt = clnt;
213 sn->rpcb_local_clnt4 = clnt4;
Trond Myklebust786615b2013-08-05 16:04:47 -0400214 sn->rpcb_is_af_local = is_af_local ? 1 : 0;
Stephen Hemminger8fdee4c2018-07-24 12:29:15 -0700215 smp_wmb();
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400216 sn->rpcb_users = 1;
Stanislav Kinsbursky914edb12011-10-25 14:16:36 +0300217}
218
Chuck Lever7402ab192011-05-09 15:22:55 -0400219/*
220 * Returns zero on success, otherwise a negative errno value
221 * is returned.
222 */
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400223static int rpcb_create_local_unix(struct net *net)
Chuck Lever7402ab192011-05-09 15:22:55 -0400224{
225 static const struct sockaddr_un rpcb_localaddr_rpcbind = {
226 .sun_family = AF_LOCAL,
227 .sun_path = RPCBIND_SOCK_PATHNAME,
228 };
229 struct rpc_create_args args = {
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400230 .net = net,
Chuck Lever7402ab192011-05-09 15:22:55 -0400231 .protocol = XPRT_TRANSPORT_LOCAL,
232 .address = (struct sockaddr *)&rpcb_localaddr_rpcbind,
233 .addrsize = sizeof(rpcb_localaddr_rpcbind),
234 .servername = "localhost",
235 .program = &rpcb_program,
236 .version = RPCBVERS_2,
237 .authflavor = RPC_AUTH_NULL,
Trond Myklebust79caa5f2019-04-24 17:46:42 -0400238 .cred = current_cred(),
Trond Myklebust00326ed2013-08-05 14:10:43 -0400239 /*
240 * We turn off the idle timeout to prevent the kernel
241 * from automatically disconnecting the socket.
242 * Otherwise, we'd have to cache the mount namespace
243 * of the caller and somehow pass that to the socket
244 * reconnect code.
245 */
246 .flags = RPC_CLNT_CREATE_NO_IDLE_TIMEOUT,
Chuck Lever7402ab192011-05-09 15:22:55 -0400247 };
248 struct rpc_clnt *clnt, *clnt4;
249 int result = 0;
Chuck Levercc5598b2008-07-14 16:03:27 -0400250
Chuck Lever7402ab192011-05-09 15:22:55 -0400251 /*
252 * Because we requested an RPC PING at transport creation time,
253 * this works only if the user space portmapper is rpcbind, and
254 * it's listening on AF_LOCAL on the named socket.
255 */
256 clnt = rpc_create(&args);
257 if (IS_ERR(clnt)) {
Stanislav Kinsburskycaea33d2012-07-20 15:57:48 +0400258 result = PTR_ERR(clnt);
Chuck Lever7402ab192011-05-09 15:22:55 -0400259 goto out;
260 }
261
262 clnt4 = rpc_bind_new_program(clnt, &rpcb_program, RPCBVERS_4);
Chuck Lever1e664982020-07-08 16:10:35 -0400263 if (IS_ERR(clnt4))
Chuck Lever7402ab192011-05-09 15:22:55 -0400264 clnt4 = NULL;
Chuck Lever7402ab192011-05-09 15:22:55 -0400265
Trond Myklebust786615b2013-08-05 16:04:47 -0400266 rpcb_set_local(net, clnt, clnt4, true);
Chuck Lever7402ab192011-05-09 15:22:55 -0400267
268out:
269 return result;
270}
Chuck Leverc5266112009-12-03 15:58:56 -0500271
272/*
273 * Returns zero on success, otherwise a negative errno value
274 * is returned.
275 */
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400276static int rpcb_create_local_net(struct net *net)
Chuck Levercc5598b2008-07-14 16:03:27 -0400277{
Chuck Lever7402ab192011-05-09 15:22:55 -0400278 static const struct sockaddr_in rpcb_inaddr_loopback = {
279 .sin_family = AF_INET,
280 .sin_addr.s_addr = htonl(INADDR_LOOPBACK),
281 .sin_port = htons(RPCBIND_PORT),
282 };
Chuck Levercc5598b2008-07-14 16:03:27 -0400283 struct rpc_create_args args = {
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400284 .net = net,
Chuck Lever2a76b3b2009-12-03 15:58:56 -0500285 .protocol = XPRT_TRANSPORT_TCP,
Chuck Lever5a462112009-12-03 15:58:56 -0500286 .address = (struct sockaddr *)&rpcb_inaddr_loopback,
287 .addrsize = sizeof(rpcb_inaddr_loopback),
Chuck Levercc5598b2008-07-14 16:03:27 -0400288 .servername = "localhost",
289 .program = &rpcb_program,
Chuck Leverc5266112009-12-03 15:58:56 -0500290 .version = RPCBVERS_2,
Chuck Levercc5598b2008-07-14 16:03:27 -0400291 .authflavor = RPC_AUTH_UNIX,
Trond Myklebust79caa5f2019-04-24 17:46:42 -0400292 .cred = current_cred(),
Chuck Levercc5598b2008-07-14 16:03:27 -0400293 .flags = RPC_CLNT_CREATE_NOPING,
294 };
Chuck Leverc5266112009-12-03 15:58:56 -0500295 struct rpc_clnt *clnt, *clnt4;
296 int result = 0;
Chuck Levercc5598b2008-07-14 16:03:27 -0400297
Chuck Leverc5266112009-12-03 15:58:56 -0500298 clnt = rpc_create(&args);
299 if (IS_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);
Chuck Lever1e664982020-07-08 16:10:35 -0400310 if (IS_ERR(clnt4))
Chuck Leverc5266112009-12-03 15:58:56 -0500311 clnt4 = NULL;
Chuck Leverc5266112009-12-03 15:58:56 -0500312
Trond Myklebust786615b2013-08-05 16:04:47 -0400313 rpcb_set_local(net, clnt, clnt4, false);
Chuck Leverc5266112009-12-03 15:58:56 -0500314
315out:
Chuck Lever7402ab192011-05-09 15:22:55 -0400316 return result;
317}
318
319/*
320 * Returns zero on success, otherwise a negative errno value
321 * is returned.
322 */
Stanislav Kinsburskyf7a30c12012-01-13 12:52:51 +0400323int rpcb_create_local(struct net *net)
Chuck Lever7402ab192011-05-09 15:22:55 -0400324{
325 static DEFINE_MUTEX(rpcb_create_local_mutex);
326 int result = 0;
327
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400328 if (rpcb_get_local(net))
Chuck Lever7402ab192011-05-09 15:22:55 -0400329 return result;
330
331 mutex_lock(&rpcb_create_local_mutex);
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400332 if (rpcb_get_local(net))
Chuck Lever7402ab192011-05-09 15:22:55 -0400333 goto out;
334
Stanislav Kinsbursky2ea75a12012-01-13 12:52:18 +0400335 if (rpcb_create_local_unix(net) != 0)
336 result = rpcb_create_local_net(net);
Chuck Lever7402ab192011-05-09 15:22:55 -0400337
338out:
Chuck Leverc5266112009-12-03 15:58:56 -0500339 mutex_unlock(&rpcb_create_local_mutex);
340 return result;
Chuck Levercc5598b2008-07-14 16:03:27 -0400341}
342
Trond Myklebust03a9a422015-01-30 18:12:28 -0500343static struct rpc_clnt *rpcb_create(struct net *net, const char *nodename,
344 const char *hostname,
Stanislav Kinsburskyc2550e02012-01-13 12:52:35 +0400345 struct sockaddr *srvaddr, size_t salen,
Trond Myklebust79caa5f2019-04-24 17:46:42 -0400346 int proto, u32 version,
Eryu Guan6b996472021-03-22 13:29:04 +0800347 const struct cred *cred,
348 const struct rpc_timeout *timeo)
Chuck Levera5090502007-03-29 16:48:04 -0400349{
350 struct rpc_create_args args = {
Stanislav Kinsburskyc2550e02012-01-13 12:52:35 +0400351 .net = net,
Chuck Levera5090502007-03-29 16:48:04 -0400352 .protocol = proto,
353 .address = srvaddr,
Chuck Lever9f6ad262007-12-10 14:56:31 -0500354 .addrsize = salen,
Eryu Guan6b996472021-03-22 13:29:04 +0800355 .timeout = timeo,
Chuck Levera5090502007-03-29 16:48:04 -0400356 .servername = hostname,
Trond Myklebust03a9a422015-01-30 18:12:28 -0500357 .nodename = nodename,
Chuck Levera5090502007-03-29 16:48:04 -0400358 .program = &rpcb_program,
359 .version = version,
360 .authflavor = RPC_AUTH_UNIX,
Trond Myklebust79caa5f2019-04-24 17:46:42 -0400361 .cred = cred,
Chuck Lever423d8b02008-07-14 16:03:28 -0400362 .flags = (RPC_CLNT_CREATE_NOPING |
363 RPC_CLNT_CREATE_NONPRIVPORT),
Chuck Levera5090502007-03-29 16:48:04 -0400364 };
365
Chuck Leverd5b64432007-08-06 11:57:18 -0400366 switch (srvaddr->sa_family) {
367 case AF_INET:
368 ((struct sockaddr_in *)srvaddr)->sin_port = htons(RPCBIND_PORT);
369 break;
370 case AF_INET6:
371 ((struct sockaddr_in6 *)srvaddr)->sin6_port = htons(RPCBIND_PORT);
372 break;
373 default:
Pavel Emelyanovc636b572010-10-06 13:45:56 +0400374 return ERR_PTR(-EAFNOSUPPORT);
Chuck Leverd5b64432007-08-06 11:57:18 -0400375 }
376
Chuck Levera5090502007-03-29 16:48:04 -0400377 return rpc_create(&args);
378}
379
Trond Myklebust786615b2013-08-05 16:04:47 -0400380static int rpcb_register_call(struct sunrpc_net *sn, struct rpc_clnt *clnt, struct rpc_message *msg, bool is_set)
Chuck Leverbabe80e2008-07-14 16:03:29 -0400381{
Trond Myklebust786615b2013-08-05 16:04:47 -0400382 int flags = RPC_TASK_NOCONNECT;
383 int error, result = 0;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400384
Trond Myklebust786615b2013-08-05 16:04:47 -0400385 if (is_set || !sn->rpcb_is_af_local)
386 flags = RPC_TASK_SOFTCONN;
Chuck Lever14aeb212008-08-18 19:34:00 -0400387 msg->rpc_resp = &result;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400388
Trond Myklebust786615b2013-08-05 16:04:47 -0400389 error = rpc_call_sync(clnt, msg, flags);
Chuck Lever1e664982020-07-08 16:10:35 -0400390 if (error < 0)
Chuck Lever14aeb212008-08-18 19:34:00 -0400391 return error;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400392
Chuck Leverdb820d62008-09-25 11:57:05 -0400393 if (!result)
Chuck Lever14aeb212008-08-18 19:34:00 -0400394 return -EACCES;
Chuck Lever14aeb212008-08-18 19:34:00 -0400395 return 0;
Chuck Leverbabe80e2008-07-14 16:03:29 -0400396}
397
Chuck Levera5090502007-03-29 16:48:04 -0400398/**
399 * rpcb_register - set or unset a port registration with the local rpcbind svc
Randy Dunlapbda14602012-05-13 10:35:40 -0700400 * @net: target network namespace
Chuck Levera5090502007-03-29 16:48:04 -0400401 * @prog: RPC program number to bind
402 * @vers: RPC version number to bind
Chuck Leverc2e1b092008-07-14 16:03:30 -0400403 * @prot: transport protocol to register
Chuck Levera5090502007-03-29 16:48:04 -0400404 * @port: port value to register
Chuck Lever14aeb212008-08-18 19:34:00 -0400405 *
406 * Returns zero if the registration request was dispatched successfully
407 * and the rpcbind daemon returned success. Otherwise, returns an errno
408 * value that reflects the nature of the error (request could not be
409 * dispatched, timed out, or rpcbind returned an error).
Chuck Levera5090502007-03-29 16:48:04 -0400410 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400411 * RPC services invoke this function to advertise their contact
412 * information via the system's rpcbind daemon. RPC services
413 * invoke this function once for each [program, version, transport]
414 * tuple they wish to advertise.
Chuck Levera5090502007-03-29 16:48:04 -0400415 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400416 * Callers may also unregister RPC services that are no longer
417 * available by setting the passed-in port to zero. This removes
418 * all registered transports for [program, version] from the local
419 * rpcbind database.
420 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400421 * This function uses rpcbind protocol version 2 to contact the
422 * local rpcbind daemon.
423 *
424 * Registration works over both AF_INET and AF_INET6, and services
425 * registered via this function are advertised as available for any
426 * address. If the local rpcbind daemon is listening on AF_INET6,
427 * services registered via this function will be advertised on
428 * IN6ADDR_ANY (ie available for all AF_INET and AF_INET6
429 * addresses).
Chuck Levera5090502007-03-29 16:48:04 -0400430 */
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400431int rpcb_register(struct net *net, u32 prog, u32 vers, int prot, unsigned short port)
Chuck Levera5090502007-03-29 16:48:04 -0400432{
Chuck Levera5090502007-03-29 16:48:04 -0400433 struct rpcbind_args map = {
434 .r_prog = prog,
435 .r_vers = vers,
436 .r_prot = prot,
437 .r_port = port,
438 };
439 struct rpc_message msg = {
Chuck Levera5090502007-03-29 16:48:04 -0400440 .rpc_argp = &map,
Chuck Levera5090502007-03-29 16:48:04 -0400441 };
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400442 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Trond Myklebust786615b2013-08-05 16:04:47 -0400443 bool is_set = false;
Chuck Levera5090502007-03-29 16:48:04 -0400444
Chuck Leverc3adcc72020-07-08 16:10:40 -0400445 trace_pmap_register(prog, vers, prot, port);
Chuck Levera5090502007-03-29 16:48:04 -0400446
Chuck Leverbabe80e2008-07-14 16:03:29 -0400447 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_UNSET];
Trond Myklebust786615b2013-08-05 16:04:47 -0400448 if (port != 0) {
Chuck Leverbabe80e2008-07-14 16:03:29 -0400449 msg.rpc_proc = &rpcb_procedures2[RPCBPROC_SET];
Trond Myklebust786615b2013-08-05 16:04:47 -0400450 is_set = true;
451 }
Chuck Leverbabe80e2008-07-14 16:03:29 -0400452
Trond Myklebust786615b2013-08-05 16:04:47 -0400453 return rpcb_register_call(sn, sn->rpcb_local_clnt, &msg, is_set);
Chuck Levera5090502007-03-29 16:48:04 -0400454}
455
Chuck Leverc2e1b092008-07-14 16:03:30 -0400456/*
457 * Fill in AF_INET family-specific arguments to register
458 */
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400459static int rpcb_register_inet4(struct sunrpc_net *sn,
460 const struct sockaddr *sap,
Chuck Lever1673d0d2009-03-18 20:47:21 -0400461 struct rpc_message *msg)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400462{
Chuck Lever3aba4552009-03-18 20:47:06 -0400463 const struct sockaddr_in *sin = (const struct sockaddr_in *)sap;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400464 struct rpcbind_args *map = msg->rpc_argp;
Chuck Lever3aba4552009-03-18 20:47:06 -0400465 unsigned short port = ntohs(sin->sin_port);
Trond Myklebust786615b2013-08-05 16:04:47 -0400466 bool is_set = false;
Chuck Leverba809132009-08-09 15:09:35 -0400467 int result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400468
Trond Myklebustd77385f2011-10-17 16:08:10 -0700469 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400470
Chuck Leverc2e1b092008-07-14 16:03:30 -0400471 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
Trond Myklebust786615b2013-08-05 16:04:47 -0400472 if (port != 0) {
Chuck Leverc2e1b092008-07-14 16:03:30 -0400473 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
Trond Myklebust786615b2013-08-05 16:04:47 -0400474 is_set = true;
475 }
Chuck Leverc2e1b092008-07-14 16:03:30 -0400476
Trond Myklebust786615b2013-08-05 16:04:47 -0400477 result = rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, is_set);
Chuck Leverba809132009-08-09 15:09:35 -0400478 kfree(map->r_addr);
479 return result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400480}
481
482/*
483 * Fill in AF_INET6 family-specific arguments to register
484 */
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400485static int rpcb_register_inet6(struct sunrpc_net *sn,
486 const struct sockaddr *sap,
Chuck Lever1673d0d2009-03-18 20:47:21 -0400487 struct rpc_message *msg)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400488{
Chuck Lever3aba4552009-03-18 20:47:06 -0400489 const struct sockaddr_in6 *sin6 = (const struct sockaddr_in6 *)sap;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400490 struct rpcbind_args *map = msg->rpc_argp;
Chuck Lever3aba4552009-03-18 20:47:06 -0400491 unsigned short port = ntohs(sin6->sin6_port);
Trond Myklebust786615b2013-08-05 16:04:47 -0400492 bool is_set = false;
Chuck Leverba809132009-08-09 15:09:35 -0400493 int result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400494
Trond Myklebustd77385f2011-10-17 16:08:10 -0700495 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_KERNEL);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400496
Chuck Leverc2e1b092008-07-14 16:03:30 -0400497 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
Trond Myklebust786615b2013-08-05 16:04:47 -0400498 if (port != 0) {
Chuck Leverc2e1b092008-07-14 16:03:30 -0400499 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_SET];
Trond Myklebust786615b2013-08-05 16:04:47 -0400500 is_set = true;
501 }
Chuck Leverc2e1b092008-07-14 16:03:30 -0400502
Trond Myklebust786615b2013-08-05 16:04:47 -0400503 result = rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, is_set);
Chuck Leverba809132009-08-09 15:09:35 -0400504 kfree(map->r_addr);
505 return result;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400506}
507
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400508static int rpcb_unregister_all_protofamilies(struct sunrpc_net *sn,
509 struct rpc_message *msg)
Chuck Lever1673d0d2009-03-18 20:47:21 -0400510{
511 struct rpcbind_args *map = msg->rpc_argp;
512
Chuck Leverc3adcc72020-07-08 16:10:40 -0400513 trace_rpcb_unregister(map->r_prog, map->r_vers, map->r_netid);
Chuck Lever1673d0d2009-03-18 20:47:21 -0400514
515 map->r_addr = "";
516 msg->rpc_proc = &rpcb_procedures4[RPCBPROC_UNSET];
517
Trond Myklebust786615b2013-08-05 16:04:47 -0400518 return rpcb_register_call(sn, sn->rpcb_local_clnt4, msg, false);
Chuck Lever1673d0d2009-03-18 20:47:21 -0400519}
520
Chuck Leverc2e1b092008-07-14 16:03:30 -0400521/**
522 * rpcb_v4_register - set or unset a port registration with the local rpcbind
Randy Dunlapbda14602012-05-13 10:35:40 -0700523 * @net: target network namespace
Chuck Leverc2e1b092008-07-14 16:03:30 -0400524 * @program: RPC program number of service to (un)register
525 * @version: RPC version number of service to (un)register
526 * @address: address family, IP address, and port to (un)register
527 * @netid: netid of transport protocol to (un)register
Chuck Lever14aeb212008-08-18 19:34:00 -0400528 *
529 * Returns zero if the registration request was dispatched successfully
530 * and the rpcbind daemon returned success. Otherwise, returns an errno
531 * value that reflects the nature of the error (request could not be
532 * dispatched, timed out, or rpcbind returned an error).
Chuck Leverc2e1b092008-07-14 16:03:30 -0400533 *
534 * RPC services invoke this function to advertise their contact
535 * information via the system's rpcbind daemon. RPC services
536 * invoke this function once for each [program, version, address,
537 * netid] tuple they wish to advertise.
538 *
Chuck Lever1673d0d2009-03-18 20:47:21 -0400539 * Callers may also unregister RPC services that are registered at a
540 * specific address by setting the port number in @address to zero.
541 * They may unregister all registered protocol families at once for
542 * a service by passing a NULL @address argument. If @netid is ""
543 * then all netids for [program, version, address] are unregistered.
Chuck Leverc2e1b092008-07-14 16:03:30 -0400544 *
Chuck Leverc2e1b092008-07-14 16:03:30 -0400545 * This function uses rpcbind protocol version 4 to contact the
546 * local rpcbind daemon. The local rpcbind daemon must support
547 * version 4 of the rpcbind protocol in order for these functions
548 * to register a service successfully.
549 *
550 * Supported netids include "udp" and "tcp" for UDP and TCP over
551 * IPv4, and "udp6" and "tcp6" for UDP and TCP over IPv6,
552 * respectively.
553 *
554 * The contents of @address determine the address family and the
555 * port to be registered. The usual practice is to pass INADDR_ANY
556 * as the raw address, but specifying a non-zero address is also
557 * supported by this API if the caller wishes to advertise an RPC
558 * service on a specific network interface.
559 *
560 * Note that passing in INADDR_ANY does not create the same service
561 * registration as IN6ADDR_ANY. The former advertises an RPC
562 * service on any IPv4 address, but not on IPv6. The latter
563 * advertises the service on all IPv4 and IPv6 addresses.
564 */
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400565int rpcb_v4_register(struct net *net, const u32 program, const u32 version,
Chuck Lever14aeb212008-08-18 19:34:00 -0400566 const struct sockaddr *address, const char *netid)
Chuck Leverc2e1b092008-07-14 16:03:30 -0400567{
568 struct rpcbind_args map = {
569 .r_prog = program,
570 .r_vers = version,
571 .r_netid = netid,
572 .r_owner = RPCB_OWNER_STRING,
573 };
574 struct rpc_message msg = {
575 .rpc_argp = &map,
Chuck Leverc2e1b092008-07-14 16:03:30 -0400576 };
Stanislav Kinsbursky977ac312012-01-13 12:52:43 +0400577 struct sunrpc_net *sn = net_generic(net, sunrpc_net_id);
Chuck Leverc5266112009-12-03 15:58:56 -0500578
Stanislav Kinsburskydff02d42012-01-13 12:52:10 +0400579 if (sn->rpcb_local_clnt4 == NULL)
Chuck Leverc5266112009-12-03 15:58:56 -0500580 return -EPROTONOSUPPORT;
Chuck Leverc2e1b092008-07-14 16:03:30 -0400581
Chuck Lever1673d0d2009-03-18 20:47:21 -0400582 if (address == NULL)
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400583 return rpcb_unregister_all_protofamilies(sn, &msg);
Chuck Lever1673d0d2009-03-18 20:47:21 -0400584
Chuck Leverc3adcc72020-07-08 16:10:40 -0400585 trace_rpcb_register(map.r_prog, map.r_vers, map.r_addr, map.r_netid);
586
Chuck Leverc2e1b092008-07-14 16:03:30 -0400587 switch (address->sa_family) {
588 case AF_INET:
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400589 return rpcb_register_inet4(sn, address, &msg);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400590 case AF_INET6:
Stanislav Kinsbursky1a114a62012-01-13 12:52:26 +0400591 return rpcb_register_inet6(sn, address, &msg);
Chuck Leverc2e1b092008-07-14 16:03:30 -0400592 }
593
594 return -EAFNOSUPPORT;
595}
596
Christoph Hellwig499b4982017-05-12 15:36:49 +0200597static struct rpc_task *rpcb_call_async(struct rpc_clnt *rpcb_clnt,
598 struct rpcbind_args *map, const 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 Myklebustad01b2c2016-01-30 14:17:26 -0500626 struct rpc_xprt_switch *xps = rcu_access_pointer(clnt->cl_xpi.xpi_xpswitch);
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400627
628 while (parent != clnt) {
Trond Myklebustad01b2c2016-01-30 14:17:26 -0500629 if (rcu_access_pointer(parent->cl_xpi.xpi_xpswitch) != xps)
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;
Christoph Hellwig499b4982017-05-12 15:36:49 +0200649 const 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();
Trond Myklebustfb43d172016-01-30 16:39:26 -0500661 clnt = rpcb_find_transport_owner(task->tk_client);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500662 rcu_read_unlock();
Trond Myklebustfb43d172016-01-30 16:39:26 -0500663 xprt = xprt_get(task->tk_xprt);
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400664
Trond Myklebust381ba742008-07-07 12:18:53 -0400665 /* Put self on the wait queue to ensure we get notified if
666 * some other task is already attempting to bind the port */
Trond Myklebust6b2e6852019-04-07 13:58:49 -0400667 rpc_sleep_on_timeout(&xprt->binding, task,
668 NULL, jiffies + xprt->bind_timeout);
Trond Myklebust381ba742008-07-07 12:18:53 -0400669
Chuck Levera5090502007-03-29 16:48:04 -0400670 if (xprt_test_and_set_binding(xprt)) {
Trond Myklebust2446ab62012-03-01 17:00:56 -0500671 xprt_put(xprt);
Trond Myklebust381ba742008-07-07 12:18:53 -0400672 return;
Chuck Levera5090502007-03-29 16:48:04 -0400673 }
674
Chuck Levera5090502007-03-29 16:48:04 -0400675 /* Someone else may have bound if we slept */
676 if (xprt_bound(xprt)) {
677 status = 0;
Chuck Levera5090502007-03-29 16:48:04 -0400678 goto bailout_nofree;
679 }
680
Chuck Leverba809132009-08-09 15:09:35 -0400681 /* Parent transport's destination address */
Chuck Lever9f6ad262007-12-10 14:56:31 -0500682 salen = rpc_peeraddr(clnt, sap, sizeof(addr));
Chuck Leverd5b64432007-08-06 11:57:18 -0400683
684 /* Don't ever use rpcbind v2 for AF_INET6 requests */
Chuck Lever9f6ad262007-12-10 14:56:31 -0500685 switch (sap->sa_family) {
Chuck Leverd5b64432007-08-06 11:57:18 -0400686 case AF_INET:
Trond Myklebust803a9062008-07-01 15:20:55 -0400687 proc = rpcb_next_version[xprt->bind_index].rpc_proc;
688 bind_version = rpcb_next_version[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400689 break;
690 case AF_INET6:
Trond Myklebust803a9062008-07-01 15:20:55 -0400691 proc = rpcb_next_version6[xprt->bind_index].rpc_proc;
692 bind_version = rpcb_next_version6[xprt->bind_index].rpc_vers;
Chuck Leverd5b64432007-08-06 11:57:18 -0400693 break;
694 default:
695 status = -EAFNOSUPPORT;
Chuck Leverd5b64432007-08-06 11:57:18 -0400696 goto bailout_nofree;
697 }
Trond Myklebust803a9062008-07-01 15:20:55 -0400698 if (proc == NULL) {
Chuck Levera5090502007-03-29 16:48:04 -0400699 xprt->bind_index = 0;
Chuck Lever906462a2007-09-11 18:00:47 -0400700 status = -EPFNOSUPPORT;
Chuck Levera5090502007-03-29 16:48:04 -0400701 goto bailout_nofree;
702 }
Chuck Levera5090502007-03-29 16:48:04 -0400703
Chuck Levere465cc32020-07-08 16:10:19 -0400704 trace_rpcb_getport(clnt, task, bind_version);
Chuck Levera5090502007-03-29 16:48:04 -0400705
Trond Myklebust03a9a422015-01-30 18:12:28 -0500706 rpcb_clnt = rpcb_create(xprt->xprt_net,
707 clnt->cl_nodename,
708 xprt->servername, sap, salen,
Trond Myklebust79caa5f2019-04-24 17:46:42 -0400709 xprt->prot, bind_version,
Eryu Guan6b996472021-03-22 13:29:04 +0800710 clnt->cl_cred,
711 task->tk_client->cl_timeout);
Chuck Lever143b6c42007-08-16 16:03:31 -0400712 if (IS_ERR(rpcb_clnt)) {
713 status = PTR_ERR(rpcb_clnt);
Chuck Lever143b6c42007-08-16 16:03:31 -0400714 goto bailout_nofree;
715 }
716
J. Bruce Fieldscb24e352018-12-20 10:42:36 -0500717 map = kzalloc(sizeof(struct rpcbind_args), GFP_NOFS);
Chuck Levera5090502007-03-29 16:48:04 -0400718 if (!map) {
719 status = -ENOMEM;
Trond Myklebust96165e22008-10-03 16:48:40 -0400720 goto bailout_release_client;
Chuck Levera5090502007-03-29 16:48:04 -0400721 }
722 map->r_prog = clnt->cl_prog;
723 map->r_vers = clnt->cl_vers;
724 map->r_prot = xprt->prot;
725 map->r_port = 0;
Bryan Schumaker864cf9b2012-03-27 13:46:32 -0400726 map->r_xprt = xprt;
Trond Myklebust381ba742008-07-07 12:18:53 -0400727 map->r_status = -EIO;
Chuck Levera5090502007-03-29 16:48:04 -0400728
Chuck Leverba809132009-08-09 15:09:35 -0400729 switch (bind_version) {
730 case RPCBVERS_4:
731 case RPCBVERS_3:
Trond Myklebust2446ab62012-03-01 17:00:56 -0500732 map->r_netid = xprt->address_strings[RPC_DISPLAY_NETID];
J. Bruce Fieldscb24e352018-12-20 10:42:36 -0500733 map->r_addr = rpc_sockaddr2uaddr(sap, GFP_NOFS);
J. Bruce Fields81c88b12018-12-20 10:35:11 -0500734 if (!map->r_addr) {
735 status = -ENOMEM;
J. Bruce Fields81c88b12018-12-20 10:35:11 -0500736 goto bailout_free_args;
737 }
Chuck Leverba809132009-08-09 15:09:35 -0400738 map->r_owner = "";
739 break;
740 case RPCBVERS_2:
741 map->r_addr = NULL;
742 break;
743 default:
744 BUG();
745 }
746
Trond Myklebust803a9062008-07-01 15:20:55 -0400747 child = rpcb_call_async(rpcb_clnt, map, proc);
Trond Myklebust4c402b42007-06-14 16:40:32 -0400748 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400749
Trond Myklebust9a4bd292008-10-03 16:48:34 -0400750 xprt->stat.bind_count++;
751 rpc_put_task(child);
Chuck Levera5090502007-03-29 16:48:04 -0400752 return;
753
J. Bruce Fields81c88b12018-12-20 10:35:11 -0500754bailout_free_args:
755 kfree(map);
Trond Myklebust96165e22008-10-03 16:48:40 -0400756bailout_release_client:
757 rpc_release_client(rpcb_clnt);
Chuck Levera5090502007-03-29 16:48:04 -0400758bailout_nofree:
759 rpcb_wake_rpcbind_waiters(xprt, status);
Chuck Levera5090502007-03-29 16:48:04 -0400760 task->tk_status = status;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500761 xprt_put(xprt);
Chuck Levera5090502007-03-29 16:48:04 -0400762}
\"Talpey, Thomas\12444802007-09-10 13:45:36 -0400763EXPORT_SYMBOL_GPL(rpcb_getport_async);
Chuck Levera5090502007-03-29 16:48:04 -0400764
765/*
766 * Rpcbind child task calls this callback via tk_exit.
767 */
768static void rpcb_getport_done(struct rpc_task *child, void *data)
769{
770 struct rpcbind_args *map = data;
771 struct rpc_xprt *xprt = map->r_xprt;
Chuck Leverac1ae532020-07-08 16:10:24 -0400772
773 map->r_status = child->tk_status;
Chuck Levera5090502007-03-29 16:48:04 -0400774
Chuck Lever4784cb52007-09-11 18:00:36 -0400775 /* Garbage reply: retry with a lesser rpcbind version */
Chuck Leverac1ae532020-07-08 16:10:24 -0400776 if (map->r_status == -EIO)
777 map->r_status = -EPROTONOSUPPORT;
Chuck Lever4784cb52007-09-11 18:00:36 -0400778
Chuck Levera5090502007-03-29 16:48:04 -0400779 /* rpcbind server doesn't support this rpcbind protocol version */
Chuck Leverac1ae532020-07-08 16:10:24 -0400780 if (map->r_status == -EPROTONOSUPPORT)
Chuck Levera5090502007-03-29 16:48:04 -0400781 xprt->bind_index++;
782
Chuck Leverac1ae532020-07-08 16:10:24 -0400783 if (map->r_status < 0) {
Chuck Levera5090502007-03-29 16:48:04 -0400784 /* rpcbind server not available on remote host? */
Chuck Leverac1ae532020-07-08 16:10:24 -0400785 map->r_port = 0;
786
Chuck Levera5090502007-03-29 16:48:04 -0400787 } else if (map->r_port == 0) {
788 /* Requested RPC service wasn't registered on remote host */
Chuck Leverac1ae532020-07-08 16:10:24 -0400789 map->r_status = -EACCES;
Chuck Levera5090502007-03-29 16:48:04 -0400790 } else {
791 /* Succeeded */
Chuck Leverac1ae532020-07-08 16:10:24 -0400792 map->r_status = 0;
Chuck Levera5090502007-03-29 16:48:04 -0400793 }
794
Chuck Leverac1ae532020-07-08 16:10:24 -0400795 trace_rpcb_setport(child, map->r_status, map->r_port);
796 xprt->ops->set_port(xprt, map->r_port);
797 if (map->r_port)
798 xprt_set_bound(xprt);
Chuck Levera5090502007-03-29 16:48:04 -0400799}
800
Chuck Lever166b88d2008-07-14 16:03:26 -0400801/*
802 * XDR functions for rpcbind
803 */
804
Chuck Lever9f06c712010-12-14 14:59:18 +0000805static void rpcb_enc_mapping(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200806 const void *data)
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400807{
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200808 const struct rpcbind_args *rpcb = data;
Chuck Lever9f06c712010-12-14 14:59:18 +0000809 __be32 *p;
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400810
Chuck Lever9f06c712010-12-14 14:59:18 +0000811 p = xdr_reserve_space(xdr, RPCB_mappingargs_sz << 2);
Chuck Lever4129ccf2010-12-14 14:58:59 +0000812 *p++ = cpu_to_be32(rpcb->r_prog);
813 *p++ = cpu_to_be32(rpcb->r_vers);
814 *p++ = cpu_to_be32(rpcb->r_prot);
815 *p = cpu_to_be32(rpcb->r_port);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400816}
817
Chuck Leverbf269552010-12-14 14:59:29 +0000818static int rpcb_dec_getport(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200819 void *data)
Chuck Leverc0c077d2009-08-09 15:09:43 -0400820{
Christoph Hellwig605d7122017-05-08 15:00:29 +0200821 struct rpcbind_args *rpcb = data;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400822 unsigned long port;
Chuck Leverbf269552010-12-14 14:59:29 +0000823 __be32 *p;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400824
825 rpcb->r_port = 0;
826
Chuck Leverbf269552010-12-14 14:59:29 +0000827 p = xdr_inline_decode(xdr, 4);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400828 if (unlikely(p == NULL))
829 return -EIO;
830
Chuck Lever4129ccf2010-12-14 14:58:59 +0000831 port = be32_to_cpup(p);
Alexey Dobriyan4be929b2010-05-24 14:33:03 -0700832 if (unlikely(port > USHRT_MAX))
Chuck Leverc0c077d2009-08-09 15:09:43 -0400833 return -EIO;
834
835 rpcb->r_port = port;
836 return 0;
837}
838
Chuck Leverbf269552010-12-14 14:59:29 +0000839static int rpcb_dec_set(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200840 void *data)
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400841{
Christoph Hellwig605d7122017-05-08 15:00:29 +0200842 unsigned int *boolp = data;
Chuck Leverbf269552010-12-14 14:59:29 +0000843 __be32 *p;
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400844
Chuck Leverbf269552010-12-14 14:59:29 +0000845 p = xdr_inline_decode(xdr, 4);
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400846 if (unlikely(p == NULL))
847 return -EIO;
848
849 *boolp = 0;
Chuck Leverbf269552010-12-14 14:59:29 +0000850 if (*p != xdr_zero)
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400851 *boolp = 1;
Chuck Lever7ed0ff92009-08-09 15:09:42 -0400852 return 0;
853}
854
Chuck Lever4129ccf2010-12-14 14:58:59 +0000855static void encode_rpcb_string(struct xdr_stream *xdr, const char *string,
856 const u32 maxstrlen)
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400857{
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400858 __be32 *p;
Chuck Lever4129ccf2010-12-14 14:58:59 +0000859 u32 len;
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400860
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400861 len = strlen(string);
Weston Andros Adamson332e0082012-10-23 10:43:44 -0400862 WARN_ON_ONCE(len > maxstrlen);
863 if (len > maxstrlen)
864 /* truncate and hope for the best */
865 len = maxstrlen;
Chuck Lever4129ccf2010-12-14 14:58:59 +0000866 p = xdr_reserve_space(xdr, 4 + len);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400867 xdr_encode_opaque(p, string, len);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400868}
869
Chuck Lever9f06c712010-12-14 14:59:18 +0000870static void rpcb_enc_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200871 const void *data)
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400872{
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200873 const struct rpcbind_args *rpcb = data;
Chuck Lever9f06c712010-12-14 14:59:18 +0000874 __be32 *p;
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400875
Chuck Lever9f06c712010-12-14 14:59:18 +0000876 p = xdr_reserve_space(xdr, (RPCB_program_sz + RPCB_version_sz) << 2);
Chuck Lever4129ccf2010-12-14 14:58:59 +0000877 *p++ = cpu_to_be32(rpcb->r_prog);
878 *p = cpu_to_be32(rpcb->r_vers);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400879
Chuck Lever9f06c712010-12-14 14:59:18 +0000880 encode_rpcb_string(xdr, rpcb->r_netid, RPCBIND_MAXNETIDLEN);
881 encode_rpcb_string(xdr, rpcb->r_addr, RPCBIND_MAXUADDRLEN);
882 encode_rpcb_string(xdr, rpcb->r_owner, RPCB_MAXOWNERLEN);
Chuck Lever6f2c2db2009-08-09 15:09:40 -0400883}
884
Chuck Leverbf269552010-12-14 14:59:29 +0000885static int rpcb_dec_getaddr(struct rpc_rqst *req, struct xdr_stream *xdr,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200886 void *data)
Chuck Leverc0c077d2009-08-09 15:09:43 -0400887{
Christoph Hellwig605d7122017-05-08 15:00:29 +0200888 struct rpcbind_args *rpcb = data;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400889 struct sockaddr_storage address;
890 struct sockaddr *sap = (struct sockaddr *)&address;
Chuck Leverbf269552010-12-14 14:59:29 +0000891 __be32 *p;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400892 u32 len;
893
894 rpcb->r_port = 0;
895
Chuck Leverbf269552010-12-14 14:59:29 +0000896 p = xdr_inline_decode(xdr, 4);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400897 if (unlikely(p == NULL))
898 goto out_fail;
Chuck Lever4129ccf2010-12-14 14:58:59 +0000899 len = be32_to_cpup(p);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400900
901 /*
902 * If the returned universal address is a null string,
903 * the requested RPC service was not registered.
904 */
Chuck Lever15a798d2020-07-08 16:10:29 -0400905 if (len == 0)
Chuck Leverc0c077d2009-08-09 15:09:43 -0400906 return 0;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400907
908 if (unlikely(len > RPCBIND_MAXUADDRLEN))
909 goto out_fail;
910
Chuck Leverbf269552010-12-14 14:59:29 +0000911 p = xdr_inline_decode(xdr, len);
Chuck Leverc0c077d2009-08-09 15:09:43 -0400912 if (unlikely(p == NULL))
913 goto out_fail;
Chuck Leverc0c077d2009-08-09 15:09:43 -0400914
Stanislav Kinsburskyb030fb02012-01-13 14:02:40 +0400915 if (rpc_uaddr2sockaddr(req->rq_xprt->xprt_net, (char *)p, len,
916 sap, sizeof(address)) == 0)
Chuck Leverc0c077d2009-08-09 15:09:43 -0400917 goto out_fail;
918 rpcb->r_port = rpc_get_port(sap);
919
920 return 0;
921
922out_fail:
Chuck Leverc0c077d2009-08-09 15:09:43 -0400923 return -EIO;
924}
925
Chuck Levera5090502007-03-29 16:48:04 -0400926/*
927 * Not all rpcbind procedures described in RFC 1833 are implemented
928 * since the Linux kernel RPC code requires only these.
929 */
Chuck Leverf8b761e2009-08-09 15:09:44 -0400930
Christoph Hellwig499b4982017-05-12 15:36:49 +0200931static const struct rpc_procinfo rpcb_procedures2[] = {
Chuck Leverf8b761e2009-08-09 15:09:44 -0400932 [RPCBPROC_SET] = {
933 .p_proc = RPCBPROC_SET,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200934 .p_encode = rpcb_enc_mapping,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200935 .p_decode = rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400936 .p_arglen = RPCB_mappingargs_sz,
937 .p_replen = RPCB_setres_sz,
938 .p_statidx = RPCBPROC_SET,
939 .p_timer = 0,
940 .p_name = "SET",
941 },
942 [RPCBPROC_UNSET] = {
943 .p_proc = RPCBPROC_UNSET,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200944 .p_encode = rpcb_enc_mapping,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200945 .p_decode = rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400946 .p_arglen = RPCB_mappingargs_sz,
947 .p_replen = RPCB_setres_sz,
948 .p_statidx = RPCBPROC_UNSET,
949 .p_timer = 0,
950 .p_name = "UNSET",
951 },
952 [RPCBPROC_GETPORT] = {
953 .p_proc = RPCBPROC_GETPORT,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200954 .p_encode = rpcb_enc_mapping,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200955 .p_decode = rpcb_dec_getport,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400956 .p_arglen = RPCB_mappingargs_sz,
957 .p_replen = RPCB_getportres_sz,
958 .p_statidx = RPCBPROC_GETPORT,
959 .p_timer = 0,
960 .p_name = "GETPORT",
961 },
Chuck Levera5090502007-03-29 16:48:04 -0400962};
963
Christoph Hellwig499b4982017-05-12 15:36:49 +0200964static const struct rpc_procinfo rpcb_procedures3[] = {
Chuck Leverf8b761e2009-08-09 15:09:44 -0400965 [RPCBPROC_SET] = {
966 .p_proc = RPCBPROC_SET,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200967 .p_encode = rpcb_enc_getaddr,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200968 .p_decode = rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400969 .p_arglen = RPCB_getaddrargs_sz,
970 .p_replen = RPCB_setres_sz,
971 .p_statidx = RPCBPROC_SET,
972 .p_timer = 0,
973 .p_name = "SET",
974 },
975 [RPCBPROC_UNSET] = {
976 .p_proc = RPCBPROC_UNSET,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200977 .p_encode = rpcb_enc_getaddr,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200978 .p_decode = rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400979 .p_arglen = RPCB_getaddrargs_sz,
980 .p_replen = RPCB_setres_sz,
981 .p_statidx = RPCBPROC_UNSET,
982 .p_timer = 0,
983 .p_name = "UNSET",
984 },
985 [RPCBPROC_GETADDR] = {
986 .p_proc = RPCBPROC_GETADDR,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +0200987 .p_encode = rpcb_enc_getaddr,
Christoph Hellwig605d7122017-05-08 15:00:29 +0200988 .p_decode = rpcb_dec_getaddr,
Chuck Leverf8b761e2009-08-09 15:09:44 -0400989 .p_arglen = RPCB_getaddrargs_sz,
990 .p_replen = RPCB_getaddrres_sz,
991 .p_statidx = RPCBPROC_GETADDR,
992 .p_timer = 0,
993 .p_name = "GETADDR",
994 },
Chuck Levera5090502007-03-29 16:48:04 -0400995};
996
Christoph Hellwig499b4982017-05-12 15:36:49 +0200997static const struct rpc_procinfo rpcb_procedures4[] = {
Chuck Leverf8b761e2009-08-09 15:09:44 -0400998 [RPCBPROC_SET] = {
999 .p_proc = RPCBPROC_SET,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +02001000 .p_encode = rpcb_enc_getaddr,
Christoph Hellwig605d7122017-05-08 15:00:29 +02001001 .p_decode = rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001002 .p_arglen = RPCB_getaddrargs_sz,
1003 .p_replen = RPCB_setres_sz,
1004 .p_statidx = RPCBPROC_SET,
1005 .p_timer = 0,
1006 .p_name = "SET",
1007 },
1008 [RPCBPROC_UNSET] = {
1009 .p_proc = RPCBPROC_UNSET,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +02001010 .p_encode = rpcb_enc_getaddr,
Christoph Hellwig605d7122017-05-08 15:00:29 +02001011 .p_decode = rpcb_dec_set,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001012 .p_arglen = RPCB_getaddrargs_sz,
1013 .p_replen = RPCB_setres_sz,
1014 .p_statidx = RPCBPROC_UNSET,
1015 .p_timer = 0,
1016 .p_name = "UNSET",
1017 },
1018 [RPCBPROC_GETADDR] = {
1019 .p_proc = RPCBPROC_GETADDR,
Christoph Hellwig7d55f7f2017-05-08 09:59:45 +02001020 .p_encode = rpcb_enc_getaddr,
Christoph Hellwig605d7122017-05-08 15:00:29 +02001021 .p_decode = rpcb_dec_getaddr,
Chuck Leverf8b761e2009-08-09 15:09:44 -04001022 .p_arglen = RPCB_getaddrargs_sz,
1023 .p_replen = RPCB_getaddrres_sz,
1024 .p_statidx = RPCBPROC_GETADDR,
1025 .p_timer = 0,
1026 .p_name = "GETADDR",
1027 },
Chuck Levera5090502007-03-29 16:48:04 -04001028};
1029
Trond Myklebusta613fa12012-01-20 13:53:56 -05001030static const struct rpcb_info rpcb_next_version[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001031 {
1032 .rpc_vers = RPCBVERS_2,
1033 .rpc_proc = &rpcb_procedures2[RPCBPROC_GETPORT],
1034 },
1035 {
1036 .rpc_proc = NULL,
1037 },
Chuck Levera5090502007-03-29 16:48:04 -04001038};
1039
Trond Myklebusta613fa12012-01-20 13:53:56 -05001040static const struct rpcb_info rpcb_next_version6[] = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001041 {
1042 .rpc_vers = RPCBVERS_4,
Chuck Lever88424132008-06-25 17:24:47 -04001043 .rpc_proc = &rpcb_procedures4[RPCBPROC_GETADDR],
Chuck Leverfc200e72008-06-25 17:24:31 -04001044 },
1045 {
1046 .rpc_vers = RPCBVERS_3,
1047 .rpc_proc = &rpcb_procedures3[RPCBPROC_GETADDR],
1048 },
Chuck Leverfc200e72008-06-25 17:24:31 -04001049 {
1050 .rpc_proc = NULL,
1051 },
Chuck Leverd5b64432007-08-06 11:57:18 -04001052};
1053
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001054static unsigned int rpcb_version2_counts[ARRAY_SIZE(rpcb_procedures2)];
Trond Myklebusta613fa12012-01-20 13:53:56 -05001055static const struct rpc_version rpcb_version2 = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001056 .number = RPCBVERS_2,
Chuck Lever1ac7c232010-12-14 14:59:09 +00001057 .nrprocs = ARRAY_SIZE(rpcb_procedures2),
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001058 .procs = rpcb_procedures2,
1059 .counts = rpcb_version2_counts,
Chuck Levera5090502007-03-29 16:48:04 -04001060};
1061
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001062static unsigned int rpcb_version3_counts[ARRAY_SIZE(rpcb_procedures3)];
Trond Myklebusta613fa12012-01-20 13:53:56 -05001063static const struct rpc_version rpcb_version3 = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001064 .number = RPCBVERS_3,
Chuck Lever1ac7c232010-12-14 14:59:09 +00001065 .nrprocs = ARRAY_SIZE(rpcb_procedures3),
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001066 .procs = rpcb_procedures3,
1067 .counts = rpcb_version3_counts,
Chuck Levera5090502007-03-29 16:48:04 -04001068};
1069
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001070static unsigned int rpcb_version4_counts[ARRAY_SIZE(rpcb_procedures4)];
Trond Myklebusta613fa12012-01-20 13:53:56 -05001071static const struct rpc_version rpcb_version4 = {
Chuck Leverfc200e72008-06-25 17:24:31 -04001072 .number = RPCBVERS_4,
Chuck Lever1ac7c232010-12-14 14:59:09 +00001073 .nrprocs = ARRAY_SIZE(rpcb_procedures4),
Christoph Hellwig1c5876d2017-05-08 23:27:10 +02001074 .procs = rpcb_procedures4,
1075 .counts = rpcb_version4_counts,
Chuck Levera5090502007-03-29 16:48:04 -04001076};
1077
Trond Myklebusta613fa12012-01-20 13:53:56 -05001078static const struct rpc_version *rpcb_version[] = {
Chuck Levera5090502007-03-29 16:48:04 -04001079 NULL,
1080 NULL,
1081 &rpcb_version2,
1082 &rpcb_version3,
1083 &rpcb_version4
1084};
1085
1086static struct rpc_stat rpcb_stats;
1087
Trond Myklebusta613fa12012-01-20 13:53:56 -05001088static const struct rpc_program rpcb_program = {
Chuck Levera5090502007-03-29 16:48:04 -04001089 .name = "rpcbind",
1090 .number = RPCBIND_PROGRAM,
1091 .nrvers = ARRAY_SIZE(rpcb_version),
1092 .version = rpcb_version,
1093 .stats = &rpcb_stats,
1094};