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;
136 * Perform a non-blocking connect on the socket fd.
138 * @timeout is modified to contain the time remaining (i.e. time provided
139 * minus time elasped).
141 * Returns zero on success, or returns -1 on error. errno is
142 * set to reflect the nature of the error.
144 static int nfs_connect_nb(const int fd, const struct sockaddr *sap,
145 const socklen_t salen, struct timeval *timeout)
150 flags = fcntl(fd, F_GETFL, 0);
154 ret = fcntl(fd, F_SETFL, flags | O_NONBLOCK);
159 * From here on subsequent sys calls could change errno so
160 * we set ret = -errno to capture it in case we decide to
163 ret = connect(fd, sap, salen);
164 if (ret < 0 && errno != EINPROGRESS) {
176 ret = select(fd + 1, NULL, &rset, NULL, timeout);
184 if (FD_ISSET(fd, &rset)) {
186 socklen_t len = (socklen_t)sizeof(ret);
188 status = getsockopt(fd, SOL_SOCKET, SO_ERROR, &ret, &len);
194 /* Oops - something wrong with connect */
202 (void)fcntl(fd, F_SETFL, flags);
207 * Set up an RPC client for communicating via a datagram socket.
208 * A connected UDP socket is used to detect a missing remote
209 * listener as quickly as possible.
211 * @timeout is initialized upon return
213 * Returns a pointer to a prepared RPC client if successful; caller
214 * must destroy a non-NULL returned RPC client. Otherwise NULL, and
215 * rpc_createerr.cf_stat is set to reflect the error.
217 static CLIENT *nfs_get_udpclient(const struct sockaddr *sap,
218 const socklen_t salen,
219 const rpcprog_t program,
220 const rpcvers_t version,
221 struct timeval *timeout)
226 struct sockaddr_storage address;
227 const struct netbuf nbuf = {
233 #else /* !HAVE_LIBTIRPC */
235 if (sap->sa_family != AF_INET) {
236 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
239 #endif /* !HAVE_LIBTIRPC */
241 sock = socket((int)sap->sa_family, SOCK_DGRAM, IPPROTO_UDP);
243 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
244 rpc_createerr.cf_error.re_errno = errno;
248 ret = nfs_bind(sock, sap->sa_family);
250 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
251 rpc_createerr.cf_error.re_errno = errno;
256 if (timeout->tv_sec == -1)
257 timeout->tv_sec = NFSRPC_TIMEOUT_UDP;
259 ret = nfs_connect_nb(sock, sap, salen, timeout);
261 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
262 rpc_createerr.cf_error.re_errno = errno;
268 memcpy(nbuf.buf, sap, (size_t)salen);
269 client = clnt_dg_create(sock, &nbuf, program, version, 0, 0);
270 #else /* !HAVE_LIBTIRPC */
271 client = clntudp_create((struct sockaddr_in *)sap, program,
272 version, *timeout, &sock);
273 #endif /* !HAVE_LIBTIRPC */
274 if (client != NULL) {
275 CLNT_CONTROL(client, CLSET_RETRY_TIMEOUT, (char *)timeout);
276 CLNT_CONTROL(client, CLSET_FD_CLOSE, NULL);
284 * Set up and connect an RPC client for communicating via a stream socket.
286 * @timeout is initialized upon return
288 * Returns a pointer to a prepared and connected RPC client if
289 * successful; caller must destroy a non-NULL returned RPC client.
290 * Otherwise NULL, and rpc_createerr.cf_stat is set to reflect the
293 static CLIENT *nfs_get_tcpclient(const struct sockaddr *sap,
294 const socklen_t salen,
295 const rpcprog_t program,
296 const rpcvers_t version,
297 struct timeval *timeout)
302 struct sockaddr_storage address;
303 const struct netbuf nbuf = {
309 #else /* !HAVE_LIBTIRPC */
311 if (sap->sa_family != AF_INET) {
312 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
315 #endif /* !HAVE_LIBTIRPC */
317 sock = socket((int)sap->sa_family, SOCK_STREAM, IPPROTO_TCP);
319 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
320 rpc_createerr.cf_error.re_errno = errno;
324 ret = nfs_bind(sock, sap->sa_family);
326 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
327 rpc_createerr.cf_error.re_errno = errno;
332 if (timeout->tv_sec == -1)
333 timeout->tv_sec = NFSRPC_TIMEOUT_TCP;
335 ret = nfs_connect_nb(sock, sap, salen, timeout);
337 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
338 rpc_createerr.cf_error.re_errno = errno;
344 memcpy(nbuf.buf, sap, (size_t)salen);
345 client = clnt_vc_create(sock, &nbuf, program, version, 0, 0);
346 #else /* !HAVE_LIBTIRPC */
347 client = clnttcp_create((struct sockaddr_in *)sap,
348 program, version, &sock, 0, 0);
349 #endif /* !HAVE_LIBTIRPC */
351 CLNT_CONTROL(client, CLSET_FD_CLOSE, NULL);
359 * nfs_get_rpcclient - acquire an RPC client
360 * @sap: pointer to socket address of RPC server
361 * @salen: length of socket address
362 * @transport: IPPROTO_ value of transport protocol to use
363 * @program: RPC program number
364 * @version: RPC version number
365 * @timeout: pointer to request timeout (must not be NULL)
367 * Set up an RPC client for communicating with an RPC program @program
368 * and @version on the server @sap over @transport.
370 * Returns a pointer to a prepared RPC client if successful, and
371 * @timeout is initialized; caller must destroy a non-NULL returned RPC
372 * client. Otherwise returns NULL, and rpc_createerr.cf_stat is set to
375 CLIENT *nfs_get_rpcclient(const struct sockaddr *sap,
376 const socklen_t salen,
377 const unsigned short transport,
378 const rpcprog_t program,
379 const rpcvers_t version,
380 struct timeval *timeout)
382 struct sockaddr_in *sin = (struct sockaddr_in *)sap;
383 struct sockaddr_in6 *sin6 = (struct sockaddr_in6 *)sap;
385 switch (sap->sa_family) {
387 return nfs_get_localclient(sap, salen, program,
390 if (sin->sin_port == 0) {
391 rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
396 if (sin6->sin6_port == 0) {
397 rpc_createerr.cf_stat = RPC_UNKNOWNADDR;
402 rpc_createerr.cf_stat = RPC_UNKNOWNHOST;
408 return nfs_get_tcpclient(sap, salen, program, version, timeout);
411 return nfs_get_udpclient(sap, salen, program, version, timeout);
414 rpc_createerr.cf_stat = RPC_UNKNOWNPROTO;
419 * nfs_getrpcbyname - convert an RPC program name to a rpcprog_t
420 * @program: default program number to use if names not found in db
421 * @table: pointer to table of 'char *' names to try to find
423 * Returns program number of first name to be successfully looked
424 * up, or the default program number if all lookups fail.
426 rpcprog_t nfs_getrpcbyname(const rpcprog_t program, const char *table[])
428 #ifdef HAVE_GETRPCBYNAME
429 struct rpcent *entry;
433 for (i = 0; table[i] != NULL; i++) {
434 entry = getrpcbyname(table[i]);
436 return (rpcprog_t)entry->r_number;
438 #endif /* HAVE_GETRPCBYNAME */