2 * Generic RPC client socket-level APIs for nfs-utils
4 * Copyright (C) 2008 Oracle Corporation. All rights reserved.
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public
17 * License along with this program; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 021110-1307, USA.
27 #include <sys/types.h>
33 #include <sys/socket.h>
34 #include <netinet/in.h>
36 #include <arpa/inet.h>
39 #include <rpc/pmap_prot.h>
44 #include <netconfig.h>
45 #include <rpc/rpcb_prot.h>
46 #endif /* HAVE_LIBTIRPC */
49 * If "-1" is specified in the tv_sec field, use these defaults instead.
51 #define NFSRPC_TIMEOUT_UDP (3)
52 #define NFSRPC_TIMEOUT_TCP (10)
55 * Set up an RPC client for communicating via a AF_LOCAL socket.
57 * @timeout is initialized upon return
59 * Returns a pointer to a prepared RPC client if successful; caller
60 * must destroy a non-NULL returned RPC client. Otherwise NULL, and
61 * rpc_createerr.cf_stat is set to reflect the error.
63 static CLIENT *nfs_get_localclient(const struct sockaddr *sap,
64 const socklen_t salen,
65 const rpcprog_t program,
66 const rpcvers_t version,
67 struct timeval *timeout)
70 struct sockaddr_storage address;
71 const struct netbuf nbuf = {
72 .maxlen = sizeof(struct sockaddr_un),
76 #endif /* HAVE_LIBTIRPC */
80 sock = socket(AF_LOCAL, SOCK_STREAM, 0);
82 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
83 rpc_createerr.cf_error.re_errno = errno;
87 if (timeout->tv_sec == -1)
88 timeout->tv_sec = NFSRPC_TIMEOUT_TCP;
91 memcpy(nbuf.buf, sap, (size_t)salen);
92 client = clnt_vc_create(sock, &nbuf, program, version, 0, 0);
93 #else /* !HAVE_LIBTIRPC */
94 client = clntunix_create((struct sockaddr_un *)sap,
95 program, version, &sock, 0, 0);
96 #endif /* !HAVE_LIBTIRPC */
98 CLNT_CONTROL(client, CLSET_FD_CLOSE, NULL);
106 * Bind a socket using an unused ephemeral source port.
108 * Returns zero on success, or returns -1 on error. errno is
109 * set to reflect the nature of the error.
111 static int nfs_bind(const int sock, const sa_family_t family)
113 struct sockaddr_in sin = {
114 .sin_family = AF_INET,
115 .sin_addr.s_addr = htonl(INADDR_ANY),
117 struct sockaddr_in6 sin6 = {
118 .sin6_family = AF_INET6,
119 .sin6_addr = IN6ADDR_ANY_INIT,
124 return bind(sock, (struct sockaddr *)&sin,
125 (socklen_t)sizeof(sin));
127 return bind(sock, (struct sockaddr *)&sin6,
128 (socklen_t)sizeof(sin6));
131 errno = EAFNOSUPPORT;
138 * Bind a socket using an unused privileged source port.
140 * Returns zero on success, or returns -1 on error. errno is
141 * set to reflect the nature of the error.
143 static int nfs_bindresvport(const int sock, const sa_family_t family)
145 struct sockaddr_in sin = {
146 .sin_family = AF_INET,
147 .sin_addr.s_addr = htonl(INADDR_ANY),
149 struct sockaddr_in6 sin6 = {
150 .sin6_family = AF_INET6,
151 .sin6_addr = IN6ADDR_ANY_INIT,
156 return bindresvport_sa(sock, (struct sockaddr *)&sin,
157 (socklen_t)sizeof(sin));
159 return bindresvport_sa(sock, (struct sockaddr *)&sin6,
160 (socklen_t)sizeof(sin6));
163 errno = EAFNOSUPPORT;
167 #else /* !IPV6_SUPPORT */
170 * Bind a socket using an unused privileged source port.
172 * Returns zero on success, or returns -1 on error. errno is
173 * set to reflect the nature of the error.
175 static int nfs_bindresvport(const int sock, const sa_family_t family)
177 if (family != AF_INET) {
178 errno = EAFNOSUPPORT;
182 return bindresvport(sock, NULL);
185 #endif /* !IPV6_SUPPORT */
188 * Perform a non-blocking connect on the socket fd.
190 * @timeout is modified to contain the time remaining (i.e. time provided
191 * minus time elasped).
193 * Returns zero on success, or returns -1 on error. errno is
194 * set to reflect the nature of the error.
196 static int nfs_connect_nb(const int fd, const struct sockaddr *sap,
197 const socklen_t salen, struct timeval *timeout)
202 flags = fcntl(fd, F_GETFL, 0);
206 ret = fcntl(fd, F_SETFL, flags | O_NONBLOCK);
211 * From here on subsequent sys calls could change errno so
212 * we set ret = -errno to capture it in case we decide to
215 ret = connect(fd, sap, salen);
216 if (ret < 0 && errno != EINPROGRESS) {
228 ret = select(fd + 1, NULL, &rset, NULL, timeout);
236 if (FD_ISSET(fd, &rset)) {
238 socklen_t len = (socklen_t)sizeof(ret);
240 status = getsockopt(fd, SOL_SOCKET, SO_ERROR, &ret, &len);
246 /* Oops - something wrong with connect */
254 (void)fcntl(fd, F_SETFL, flags);
259 * Set up an RPC client for communicating via a datagram socket.
260 * A connected UDP socket is used to detect a missing remote
261 * listener as quickly as possible.
263 * @timeout is initialized upon return
265 * Returns a pointer to a prepared RPC client if successful; caller
266 * must destroy a non-NULL returned RPC client. Otherwise NULL, and
267 * rpc_createerr.cf_stat is set to reflect the error.
269 static CLIENT *nfs_get_udpclient(const struct sockaddr *sap,
270 const socklen_t salen,
271 const rpcprog_t program,
272 const rpcvers_t version,
273 struct timeval *timeout,
279 struct sockaddr_storage address;
280 const struct netbuf nbuf = {
286 #else /* !HAVE_LIBTIRPC */
288 if (sap->sa_family != AF_INET) {
289 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
292 #endif /* !HAVE_LIBTIRPC */
294 sock = socket((int)sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
296 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
297 rpc_createerr.cf_error.re_errno = errno;
302 ret = nfs_bindresvport(sock, sap->sa_family);
304 ret = nfs_bind(sock, sap->sa_family);
306 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
307 rpc_createerr.cf_error.re_errno = errno;
312 if (timeout->tv_sec == -1)
313 timeout->tv_sec = NFSRPC_TIMEOUT_UDP;
315 ret = nfs_connect_nb(sock, sap, salen, timeout);
317 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
318 rpc_createerr.cf_error.re_errno = errno;
324 memcpy(nbuf.buf, sap, (size_t)salen);
325 client = clnt_dg_create(sock, &nbuf, program, version, 0, 0);
326 #else /* !HAVE_LIBTIRPC */
327 client = clntudp_create((struct sockaddr_in *)sap, program,
328 version, *timeout, &sock);
329 #endif /* !HAVE_LIBTIRPC */
330 if (client != NULL) {
331 CLNT_CONTROL(client, CLSET_RETRY_TIMEOUT, (char *)timeout);
332 CLNT_CONTROL(client, CLSET_FD_CLOSE, NULL);
340 * Set up and connect an RPC client for communicating via a stream socket.
342 * @timeout is initialized upon return
344 * Returns a pointer to a prepared and connected RPC client if
345 * successful; caller must destroy a non-NULL returned RPC client.
346 * Otherwise NULL, and rpc_createerr.cf_stat is set to reflect the
349 static CLIENT *nfs_get_tcpclient(const struct sockaddr *sap,
350 const socklen_t salen,
351 const rpcprog_t program,
352 const rpcvers_t version,
353 struct timeval *timeout,
359 struct sockaddr_storage address;
360 const struct netbuf nbuf = {
366 #else /* !HAVE_LIBTIRPC */
368 if (sap->sa_family != AF_INET) {
369 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
372 #endif /* !HAVE_LIBTIRPC */
374 sock = socket((int)sap->sa_family, SOCK_STREAM, IPPROTO_TCP);
376 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
377 rpc_createerr.cf_error.re_errno = errno;
382 ret = nfs_bindresvport(sock, sap->sa_family);
384 ret = nfs_bind(sock, sap->sa_family);
386 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
387 rpc_createerr.cf_error.re_errno = errno;
392 if (timeout->tv_sec == -1)
393 timeout->tv_sec = NFSRPC_TIMEOUT_TCP;
395 ret = nfs_connect_nb(sock, sap, salen, timeout);
397 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
398 rpc_createerr.cf_error.re_errno = errno;
404 memcpy(nbuf.buf, sap, (size_t)salen);
405 client = clnt_vc_create(sock, &nbuf, program, version, 0, 0);
406 #else /* !HAVE_LIBTIRPC */
407 client = clnttcp_create((struct sockaddr_in *)sap,
408 program, version, &sock, 0, 0);
409 #endif /* !HAVE_LIBTIRPC */
411 CLNT_CONTROL(client, CLSET_FD_CLOSE, NULL);
419 * nfs_get_rpcclient - acquire an RPC client
420 * @sap: pointer to socket address of RPC server
421 * @salen: length of socket address
422 * @transport: IPPROTO_ value of transport protocol to use
423 * @program: RPC program number
424 * @version: RPC version number
425 * @timeout: pointer to request timeout (must not be NULL)
427 * Set up an RPC client for communicating with an RPC program @program
428 * and @version on the server @sap over @transport. An unprivileged
429 * source port is used.
431 * Returns a pointer to a prepared RPC client if successful, and
432 * @timeout is initialized; caller must destroy a non-NULL returned RPC
433 * client. Otherwise returns NULL, and rpc_createerr.cf_stat is set to
436 CLIENT *nfs_get_rpcclient(const struct sockaddr *sap,
437 const socklen_t salen,
438 const unsigned short transport,
439 const rpcprog_t program,
440 const rpcvers_t version,
441 struct timeval *timeout)
443 struct sockaddr_in *sin = (struct sockaddr_in *)sap;
444 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
446 switch (sap->sa_family) {
448 return nfs_get_localclient(sap, salen, program,
451 if (sin->sin_port == 0) {
452 rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
457 if (sin6->sin6_port == 0) {
458 rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
463 rpc_createerr.cf_stat = RPC_UNKNOWNHOST;
469 return nfs_get_tcpclient(sap, salen, program, version,
473 return nfs_get_udpclient(sap, salen, program, version,
477 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
482 * nfs_get_priv_rpcclient - acquire an RPC client
483 * @sap: pointer to socket address of RPC server
484 * @salen: length of socket address
485 * @transport: IPPROTO_ value of transport protocol to use
486 * @program: RPC program number
487 * @version: RPC version number
488 * @timeout: pointer to request timeout (must not be NULL)
490 * Set up an RPC client for communicating with an RPC program @program
491 * and @version on the server @sap over @transport. A privileged
492 * source port is used.
494 * Returns a pointer to a prepared RPC client if successful, and
495 * @timeout is initialized; caller must destroy a non-NULL returned RPC
496 * client. Otherwise returns NULL, and rpc_createerr.cf_stat is set to
499 CLIENT *nfs_get_priv_rpcclient(const struct sockaddr *sap,
500 const socklen_t salen,
501 const unsigned short transport,
502 const rpcprog_t program,
503 const rpcvers_t version,
504 struct timeval *timeout)
506 struct sockaddr_in *sin = (struct sockaddr_in *)sap;
507 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
509 switch (sap->sa_family) {
511 return nfs_get_localclient(sap, salen, program,
514 if (sin->sin_port == 0) {
515 rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
520 if (sin6->sin6_port == 0) {
521 rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
526 rpc_createerr.cf_stat = RPC_UNKNOWNHOST;
532 return nfs_get_tcpclient(sap, salen, program, version,
536 return nfs_get_udpclient(sap, salen, program, version,
540 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
545 * nfs_getrpcbyname - convert an RPC program name to a rpcprog_t
546 * @program: default program number to use if names not found in db
547 * @table: pointer to table of 'char *' names to try to find
549 * Returns program number of first name to be successfully looked
550 * up, or the default program number if all lookups fail.
552 rpcprog_t nfs_getrpcbyname(const rpcprog_t program, const char *table[])
554 #ifdef HAVE_GETRPCBYNAME
555 struct rpcent *entry;
559 for (i = 0; table[i] != NULL; i++) {
560 entry = getrpcbyname(table[i]);
562 return (rpcprog_t)entry->r_number;
564 #endif /* HAVE_GETRPCBYNAME */