2 * clnt_udp.c, Implements a UDP/IP based, client side RPC.
4 * Copyright (c) 2010, Oracle America, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials
15 * provided with the distribution.
16 * * Neither the name of the "Oracle America, Inc." nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
41 #include <sys/socket.h>
42 #include <sys/ioctl.h>
46 #include <rpc/pmap_clnt.h>
57 #include <kernel-features.h>
58 #include <inet/net-internal.h>
59 #include <shlib-compat.h>
61 extern u_long
_create_xid (void);
64 * UDP bases client side rpc operations
66 static enum clnt_stat
clntudp_call (CLIENT
*, u_long
, xdrproc_t
, caddr_t
,
67 xdrproc_t
, caddr_t
, struct timeval
);
68 static void clntudp_abort (void);
69 static void clntudp_geterr (CLIENT
*, struct rpc_err
*);
70 static bool_t
clntudp_freeres (CLIENT
*, xdrproc_t
, caddr_t
);
71 static bool_t
clntudp_control (CLIENT
*, int, char *);
72 static void clntudp_destroy (CLIENT
*);
74 static const struct clnt_ops udp_ops
=
85 * Private data kept per client handle. This private struct is
86 * unfortunately part of the ABI; ypbind contains a copy of it and
87 * accesses it through CLIENT::cl_private field.
93 struct sockaddr_in cu_raddr
;
95 struct timeval cu_wait
;
96 struct timeval cu_total
;
97 struct rpc_err cu_error
;
107 * Create a UDP based client handle.
108 * If *sockp<0, *sockp is set to a newly created UPD socket.
109 * If raddr->sin_port is 0 a binder on the remote machine
110 * is consulted for the correct port number.
111 * NB: It is the clients responsibility to close *sockp.
112 * NB: The rpch->cl_auth is initialized to null authentication.
113 * Caller may wish to set this something more useful.
115 * wait is the amount of time used between retransmitting a call if
116 * no response has been heard; retransmission occurs until the actual
117 * rpc call times out.
119 * sendsz and recvsz are the maximum allowable packet sizes that can be
123 __libc_clntudp_bufcreate (struct sockaddr_in
*raddr
, u_long program
,
124 u_long version
, struct timeval wait
, int *sockp
,
125 u_int sendsz
, u_int recvsz
, int flags
)
128 struct cu_data
*cu
= NULL
;
129 struct rpc_msg call_msg
;
131 cl
= (CLIENT
*) mem_alloc (sizeof (CLIENT
));
132 sendsz
= ((sendsz
+ 3) / 4) * 4;
133 recvsz
= ((recvsz
+ 3) / 4) * 4;
134 cu
= (struct cu_data
*) mem_alloc (sizeof (*cu
) + sendsz
+ recvsz
);
135 if (cl
== NULL
|| cu
== NULL
)
137 struct rpc_createerr
*ce
= &get_rpc_createerr ();
138 (void) __fxprintf (NULL
, "%s: %s",
139 "clntudp_create", _("out of memory\n"));
140 ce
->cf_stat
= RPC_SYSTEMERROR
;
141 ce
->cf_error
.re_errno
= ENOMEM
;
144 cu
->cu_outbuf
= &cu
->cu_inbuf
[recvsz
];
146 if (raddr
->sin_port
== 0)
150 pmap_getport (raddr
, program
, version
, IPPROTO_UDP
)) == 0)
154 raddr
->sin_port
= htons (port
);
156 cl
->cl_ops
= (struct clnt_ops
*) &udp_ops
;
157 cl
->cl_private
= (caddr_t
) cu
;
158 cu
->cu_raddr
= *raddr
;
159 cu
->cu_rlen
= sizeof (cu
->cu_raddr
);
161 cu
->cu_total
.tv_sec
= -1;
162 cu
->cu_total
.tv_usec
= -1;
163 cu
->cu_sendsz
= sendsz
;
164 cu
->cu_recvsz
= recvsz
;
165 call_msg
.rm_xid
= _create_xid ();
166 call_msg
.rm_direction
= CALL
;
167 call_msg
.rm_call
.cb_rpcvers
= RPC_MSG_VERSION
;
168 call_msg
.rm_call
.cb_prog
= program
;
169 call_msg
.rm_call
.cb_vers
= version
;
170 xdrmem_create (&(cu
->cu_outxdrs
), cu
->cu_outbuf
, sendsz
, XDR_ENCODE
);
171 if (!xdr_callhdr (&(cu
->cu_outxdrs
), &call_msg
))
175 cu
->cu_xdrpos
= XDR_GETPOS (&(cu
->cu_outxdrs
));
178 *sockp
= __socket (AF_INET
, SOCK_DGRAM
|SOCK_NONBLOCK
|flags
, IPPROTO_UDP
);
179 if (__glibc_unlikely (*sockp
< 0))
181 struct rpc_createerr
*ce
= &get_rpc_createerr ();
182 ce
->cf_stat
= RPC_SYSTEMERROR
;
183 ce
->cf_error
.re_errno
= errno
;
186 /* attempt to bind to prov port */
187 (void) bindresvport (*sockp
, (struct sockaddr_in
*) 0);
191 __setsockopt (*sockp
, SOL_IP
, IP_RECVERR
, &on
, sizeof(on
));
194 cu
->cu_closeit
= TRUE
;
198 cu
->cu_closeit
= FALSE
;
200 cu
->cu_sock
= *sockp
;
201 cl
->cl_auth
= authnone_create ();
205 mem_free ((caddr_t
) cu
, sizeof (*cu
) + sendsz
+ recvsz
);
207 mem_free ((caddr_t
) cl
, sizeof (CLIENT
));
208 return (CLIENT
*) NULL
;
210 #ifdef EXPORT_RPC_SYMBOLS
211 libc_hidden_def (__libc_clntudp_bufcreate
)
213 libc_hidden_nolink_sunrpc (__libc_clntudp_bufcreate
, GLIBC_PRIVATE
)
217 clntudp_bufcreate (struct sockaddr_in
*raddr
, u_long program
, u_long version
,
218 struct timeval wait
, int *sockp
, u_int sendsz
,
221 return __libc_clntudp_bufcreate (raddr
, program
, version
, wait
,
222 sockp
, sendsz
, recvsz
, 0);
224 libc_hidden_nolink_sunrpc (clntudp_bufcreate
, GLIBC_2_0
)
227 clntudp_create (struct sockaddr_in
*raddr
, u_long program
, u_long version
,
228 struct timeval wait
, int *sockp
)
230 return __libc_clntudp_bufcreate (raddr
, program
, version
, wait
,
231 sockp
, UDPMSGSIZE
, UDPMSGSIZE
, 0);
233 #ifdef EXPORT_RPC_SYMBOLS
234 libc_hidden_def (clntudp_create
)
236 libc_hidden_nolink_sunrpc (clntudp_create
, GLIBC_2_0
)
240 is_network_up (int sock
)
244 if (getifaddrs (&ifa
) != 0)
247 struct ifaddrs
*run
= ifa
;
250 if ((run
->ifa_flags
& IFF_UP
) != 0
251 && run
->ifa_addr
!= NULL
252 && run
->ifa_addr
->sa_family
== AF_INET
)
263 static enum clnt_stat
264 clntudp_call (/* client handle */
266 /* procedure number */
268 /* xdr routine for args */
270 /* pointer to args */
272 /* xdr routine for results */
274 /* pointer to results */
276 /* seconds to wait before giving up */
277 struct timeval utimeout
)
279 struct cu_data
*cu
= (struct cu_data
*) cl
->cl_private
;
285 struct sockaddr_in from
;
286 struct rpc_msg reply_msg
;
289 int nrefreshes
= 2; /* number of times to refresh cred */
290 int anyup
; /* any network interface up */
292 struct deadline_current_time current_time
= __deadline_current_time ();
293 struct deadline total_deadline
; /* Determined once by overall timeout. */
294 struct deadline response_deadline
; /* Determined anew for each query. */
296 /* Choose the timeout value. For non-sending usage (xargs == NULL),
297 the total deadline does not matter, only cu->cu_wait is used
302 if (cu
->cu_total
.tv_usec
== -1)
303 /* Use supplied timeout. */
306 /* Use default timeout. */
308 if (!__is_timeval_valid_timeout (tv
))
309 return (cu
->cu_error
.re_status
= RPC_TIMEDOUT
);
310 total_deadline
= __deadline_from_timeval (current_time
, tv
);
313 /* Guard against bad timeout specification. */
314 if (!__is_timeval_valid_timeout (cu
->cu_wait
))
315 return (cu
->cu_error
.re_status
= RPC_TIMEDOUT
);
318 xdrs
= &(cu
->cu_outxdrs
);
321 xdrs
->x_op
= XDR_ENCODE
;
322 XDR_SETPOS (xdrs
, cu
->cu_xdrpos
);
324 * the transaction is the first thing in the out buffer
326 (*(uint32_t *) (cu
->cu_outbuf
))++;
327 if ((!XDR_PUTLONG (xdrs
, (long *) &proc
)) ||
328 (!AUTH_MARSHALL (cl
->cl_auth
, xdrs
)) ||
329 (!(*xargs
) (xdrs
, argsp
)))
330 return (cu
->cu_error
.re_status
= RPC_CANTENCODEARGS
);
331 outlen
= (int) XDR_GETPOS (xdrs
);
334 if (__sendto (cu
->cu_sock
, cu
->cu_outbuf
, outlen
, 0,
335 (struct sockaddr
*) &(cu
->cu_raddr
), cu
->cu_rlen
)
338 cu
->cu_error
.re_errno
= errno
;
339 return (cu
->cu_error
.re_status
= RPC_CANTSEND
);
342 /* sendto may have blocked, so recompute the current time. */
343 current_time
= __deadline_current_time ();
345 response_deadline
= __deadline_from_timeval (current_time
, cu
->cu_wait
);
347 reply_msg
.acpted_rply
.ar_verf
= _null_auth
;
348 reply_msg
.acpted_rply
.ar_results
.where
= resultsp
;
349 reply_msg
.acpted_rply
.ar_results
.proc
= xresults
;
354 /* Per-response retry loop. current_time must be up-to-date at the
361 if (__deadline_elapsed (current_time
, total_deadline
))
362 /* Overall timeout expired. */
363 return (cu
->cu_error
.re_status
= RPC_TIMEDOUT
);
364 milliseconds
= __deadline_to_ms
365 (current_time
, __deadline_first (total_deadline
,
367 if (milliseconds
== 0)
368 /* Per-query timeout expired. */
373 /* xatgs == NULL. Collect a response without sending a
374 query. In this mode, we need to ignore the total
376 milliseconds
= __deadline_to_ms (current_time
, response_deadline
);
377 if (milliseconds
== 0)
378 /* Cannot send again, so bail out. */
379 return (cu
->cu_error
.re_status
= RPC_CANTSEND
);
382 switch (__poll (&fd
, 1, milliseconds
))
388 anyup
= is_network_up (cu
->cu_sock
);
390 return (cu
->cu_error
.re_status
= RPC_CANTRECV
);
396 cu
->cu_error
.re_errno
= errno
;
397 return (cu
->cu_error
.re_status
= RPC_CANTRECV
);
400 if (fd
.revents
& POLLERR
)
403 struct cmsghdr
*cmsg
;
404 struct sock_extended_err
*e
;
405 struct sockaddr_in err_addr
;
407 char *cbuf
= malloc (outlen
+ 256);
412 cu
->cu_error
.re_errno
= errno
;
413 return (cu
->cu_error
.re_status
= RPC_CANTRECV
);
416 iov
.iov_base
= cbuf
+ 256;
417 iov
.iov_len
= outlen
;
418 msg
.msg_name
= (void *) &err_addr
;
419 msg
.msg_namelen
= sizeof (err_addr
);
423 msg
.msg_control
= cbuf
;
424 msg
.msg_controllen
= 256;
425 ret
= __recvmsg (cu
->cu_sock
, &msg
, MSG_ERRQUEUE
);
427 && memcmp (cbuf
+ 256, cu
->cu_outbuf
, ret
) == 0
428 && (msg
.msg_flags
& MSG_ERRQUEUE
)
429 && ((msg
.msg_namelen
== 0
431 || (msg
.msg_namelen
== sizeof (err_addr
)
432 && err_addr
.sin_family
== AF_INET
433 && memcmp (&err_addr
.sin_addr
, &cu
->cu_raddr
.sin_addr
,
434 sizeof (err_addr
.sin_addr
)) == 0
435 && err_addr
.sin_port
== cu
->cu_raddr
.sin_port
)))
436 for (cmsg
= CMSG_FIRSTHDR (&msg
); cmsg
;
437 cmsg
= CMSG_NXTHDR (&msg
, cmsg
))
438 if (cmsg
->cmsg_level
== SOL_IP
&& cmsg
->cmsg_type
== IP_RECVERR
)
440 e
= (struct sock_extended_err
*) CMSG_DATA(cmsg
);
441 cu
->cu_error
.re_errno
= e
->ee_errno
;
443 return (cu
->cu_error
.re_status
= RPC_CANTRECV
);
450 fromlen
= sizeof (struct sockaddr
);
451 inlen
= __recvfrom (cu
->cu_sock
, cu
->cu_inbuf
,
452 (int) cu
->cu_recvsz
, MSG_DONTWAIT
,
453 (struct sockaddr
*) &from
, &fromlen
);
455 while (inlen
< 0 && errno
== EINTR
);
458 if (errno
== EWOULDBLOCK
)
460 cu
->cu_error
.re_errno
= errno
;
461 return (cu
->cu_error
.re_status
= RPC_CANTRECV
);
463 /* Accept the response if the packet is sufficiently long and
464 the transaction ID matches the query (if available). */
467 || memcmp (cu
->cu_inbuf
, cu
->cu_outbuf
,
468 sizeof (uint32_t)) == 0))
472 /* Update the current time because poll and recvmsg waited for
474 current_time
= __deadline_current_time ();
478 * now decode and validate the response
480 xdrmem_create (&reply_xdrs
, cu
->cu_inbuf
, (u_int
) inlen
, XDR_DECODE
);
481 ok
= xdr_replymsg (&reply_xdrs
, &reply_msg
);
482 /* XDR_DESTROY(&reply_xdrs); save a few cycles on noop destroy */
485 _seterr_reply (&reply_msg
, &(cu
->cu_error
));
486 if (cu
->cu_error
.re_status
== RPC_SUCCESS
)
488 if (!AUTH_VALIDATE (cl
->cl_auth
,
489 &reply_msg
.acpted_rply
.ar_verf
))
491 cu
->cu_error
.re_status
= RPC_AUTHERROR
;
492 cu
->cu_error
.re_why
= AUTH_INVALIDRESP
;
494 if (reply_msg
.acpted_rply
.ar_verf
.oa_base
!= NULL
)
496 xdrs
->x_op
= XDR_FREE
;
497 (void) xdr_opaque_auth (xdrs
, &(reply_msg
.acpted_rply
.ar_verf
));
499 } /* end successful completion */
502 /* maybe our credentials need to be refreshed ... */
503 if (nrefreshes
> 0 && AUTH_REFRESH (cl
->cl_auth
))
508 } /* end of unsuccessful completion */
509 } /* end of valid reply message */
512 cu
->cu_error
.re_status
= RPC_CANTDECODERES
;
514 return cu
->cu_error
.re_status
;
518 clntudp_geterr (CLIENT
*cl
, struct rpc_err
*errp
)
520 struct cu_data
*cu
= (struct cu_data
*) cl
->cl_private
;
522 *errp
= cu
->cu_error
;
527 clntudp_freeres (CLIENT
*cl
, xdrproc_t xdr_res
, caddr_t res_ptr
)
529 struct cu_data
*cu
= (struct cu_data
*) cl
->cl_private
;
530 XDR
*xdrs
= &(cu
->cu_outxdrs
);
532 xdrs
->x_op
= XDR_FREE
;
533 return (*xdr_res
) (xdrs
, res_ptr
);
542 clntudp_control (CLIENT
*cl
, int request
, char *info
)
544 struct cu_data
*cu
= (struct cu_data
*) cl
->cl_private
;
551 cu
->cu_closeit
= TRUE
;
553 case CLSET_FD_NCLOSE
:
554 cu
->cu_closeit
= FALSE
;
557 cu
->cu_total
= *(struct timeval
*) info
;
560 *(struct timeval
*) info
= cu
->cu_total
;
562 case CLSET_RETRY_TIMEOUT
:
563 cu
->cu_wait
= *(struct timeval
*) info
;
565 case CLGET_RETRY_TIMEOUT
:
566 *(struct timeval
*) info
= cu
->cu_wait
;
568 case CLGET_SERVER_ADDR
:
569 *(struct sockaddr_in
*) info
= cu
->cu_raddr
;
572 *(int *)info
= cu
->cu_sock
;
576 * use the knowledge that xid is the
577 * first element in the call structure *.
578 * This will get the xid of the PREVIOUS call
580 memcpy (&ui32
, cu
->cu_outbuf
, sizeof (ui32
));
582 memcpy (info
, &ul
, sizeof (ul
));
585 /* This will set the xid of the NEXT call */
586 memcpy (&ul
, info
, sizeof (ul
));
587 ui32
= htonl (ul
- 1);
588 memcpy (cu
->cu_outbuf
, &ui32
, sizeof (ui32
));
589 /* decrement by 1 as clntudp_call() increments once */
593 * This RELIES on the information that, in the call body,
594 * the version number field is the fifth field from the
595 * beginning of the RPC header. MUST be changed if the
596 * call_struct is changed
598 memcpy (&ui32
, cu
->cu_outbuf
+ 4 * BYTES_PER_XDR_UNIT
, sizeof (ui32
));
600 memcpy (info
, &ul
, sizeof (ul
));
603 memcpy (&ul
, info
, sizeof (ul
));
605 memcpy (cu
->cu_outbuf
+ 4 * BYTES_PER_XDR_UNIT
, &ui32
, sizeof (ui32
));
609 * This RELIES on the information that, in the call body,
610 * the program number field is the field from the
611 * beginning of the RPC header. MUST be changed if the
612 * call_struct is changed
614 memcpy (&ui32
, cu
->cu_outbuf
+ 3 * BYTES_PER_XDR_UNIT
, sizeof (ui32
));
616 memcpy (info
, &ul
, sizeof (ul
));
619 memcpy (&ul
, info
, sizeof (ul
));
621 memcpy (cu
->cu_outbuf
+ 3 * BYTES_PER_XDR_UNIT
, &ui32
, sizeof (ui32
));
623 /* The following are only possible with TI-RPC */
626 case CLSET_PUSH_TIMOD
:
627 case CLSET_POP_TIMOD
:
635 clntudp_destroy (CLIENT
*cl
)
637 struct cu_data
*cu
= (struct cu_data
*) cl
->cl_private
;
641 (void) __close (cu
->cu_sock
);
643 XDR_DESTROY (&(cu
->cu_outxdrs
));
644 mem_free ((caddr_t
) cu
, (sizeof (*cu
) + cu
->cu_sendsz
+ cu
->cu_recvsz
));
645 mem_free ((caddr_t
) cl
, sizeof (CLIENT
));