3 * Server side for UDP/IP based RPC. (Does some caching in the hopes of
4 * achieving execute-at-most-once semantics.)
6 * Copyright (c) 2010, Oracle America, Inc.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
12 * * Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * * Redistributions in binary form must reproduce the above
15 * copyright notice, this list of conditions and the following
16 * disclaimer in the documentation and/or other materials
17 * provided with the distribution.
18 * * Neither the name of the "Oracle America, Inc." nor the names of its
19 * contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
25 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
26 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
27 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
29 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
31 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
32 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
40 #include <sys/socket.h>
49 #include <libio/iolibio.h>
51 #define rpc_buffer(xprt) ((xprt)->xp_p1)
53 #define MAX(a, b) ((a > b) ? a : b)
56 static bool_t
svcudp_recv (SVCXPRT
*, struct rpc_msg
*);
57 static bool_t
svcudp_reply (SVCXPRT
*, struct rpc_msg
*);
58 static enum xprt_stat
svcudp_stat (SVCXPRT
*);
59 static bool_t
svcudp_getargs (SVCXPRT
*, xdrproc_t
, caddr_t
);
60 static bool_t
svcudp_freeargs (SVCXPRT
*, xdrproc_t
, caddr_t
);
61 static void svcudp_destroy (SVCXPRT
*);
63 static const struct xp_ops svcudp_op
=
73 static int cache_get (SVCXPRT
*, struct rpc_msg
*, char **replyp
,
75 static void cache_set (SVCXPRT
*xprt
, u_long replylen
);
82 u_int su_iosz
; /* byte size of send.recv buffer */
83 u_long su_xid
; /* transaction id */
84 XDR su_xdrs
; /* XDR handle */
85 char su_verfbody
[MAX_AUTH_BYTES
]; /* verifier body */
86 char *su_cache
; /* cached data, NULL if no cache */
88 #define su_data(xprt) ((struct svcudp_data *)(xprt->xp_p2))
92 * xprt = svcudp_create(sock);
94 * If sock<0 then a socket is created, else sock is used.
95 * If the socket, sock is not bound to a port then svcudp_create
96 * binds it to an arbitrary port. In any (successful) case,
97 * xprt->xp_sock is the registered socket number and xprt->xp_port is the
98 * associated port number.
99 * Once *xprt is initialized, it is registered as a transporter;
100 * see (svc.h, xprt_register).
101 * The routines returns NULL if a problem occurred.
104 svcudp_bufcreate (sock
, sendsz
, recvsz
)
106 u_int sendsz
, recvsz
;
108 bool_t madesock
= FALSE
;
110 struct svcudp_data
*su
;
111 struct sockaddr_in addr
;
112 socklen_t len
= sizeof (struct sockaddr_in
);
116 if (sock
== RPC_ANYSOCK
)
118 if ((sock
= __socket (AF_INET
, SOCK_DGRAM
, IPPROTO_UDP
)) < 0)
120 perror (_("svcudp_create: socket creation problem"));
121 return (SVCXPRT
*) NULL
;
125 __bzero ((char *) &addr
, sizeof (addr
));
126 addr
.sin_family
= AF_INET
;
127 if (bindresvport (sock
, &addr
))
130 (void) __bind (sock
, (struct sockaddr
*) &addr
, len
);
132 if (__getsockname (sock
, (struct sockaddr
*) &addr
, &len
) != 0)
134 perror (_("svcudp_create - cannot getsockname"));
136 (void) __close (sock
);
137 return (SVCXPRT
*) NULL
;
139 xprt
= (SVCXPRT
*) mem_alloc (sizeof (SVCXPRT
));
140 su
= (struct svcudp_data
*) mem_alloc (sizeof (*su
));
141 buf
= mem_alloc (((MAX (sendsz
, recvsz
) + 3) / 4) * 4);
142 if (xprt
== NULL
|| su
== NULL
|| buf
== NULL
)
144 (void) __fxprintf (NULL
, "%s: %s",
145 "svcudp_create", _("out of memory\n"));
146 mem_free (xprt
, sizeof (SVCXPRT
));
147 mem_free (su
, sizeof (*su
));
148 mem_free (buf
, ((MAX (sendsz
, recvsz
) + 3) / 4) * 4);
151 su
->su_iosz
= ((MAX (sendsz
, recvsz
) + 3) / 4) * 4;
152 rpc_buffer (xprt
) = buf
;
153 xdrmem_create (&(su
->su_xdrs
), rpc_buffer (xprt
), su
->su_iosz
, XDR_DECODE
);
155 xprt
->xp_p2
= (caddr_t
) su
;
156 xprt
->xp_verf
.oa_base
= su
->su_verfbody
;
157 xprt
->xp_ops
= &svcudp_op
;
158 xprt
->xp_port
= ntohs (addr
.sin_port
);
159 xprt
->xp_sock
= sock
;
162 if ((sizeof (struct iovec
) + sizeof (struct msghdr
)
163 + sizeof(struct cmsghdr
) + sizeof (struct in_pktinfo
))
164 > sizeof (xprt
->xp_pad
))
166 (void) __fxprintf (NULL
,"%s", _("\
167 svcudp_create: xp_pad is too small for IP_PKTINFO\n"));
171 if (__setsockopt (sock
, SOL_IP
, IP_PKTINFO
, (void *) &pad
,
173 /* Set the padding to all 1s. */
177 /* Clear the padding. */
179 memset (&xprt
->xp_pad
[0], pad
, sizeof (xprt
->xp_pad
));
181 xprt_register (xprt
);
184 #ifdef EXPORT_RPC_SYMBOLS
185 libc_hidden_def (svcudp_bufcreate
)
187 libc_hidden_nolink (svcudp_bufcreate
, GLIBC_2_0
)
194 return svcudp_bufcreate (sock
, UDPMSGSIZE
, UDPMSGSIZE
);
196 #ifdef EXPORT_RPC_SYMBOLS
197 libc_hidden_def (svcudp_create
)
199 libc_hidden_nolink (svcudp_create
, GLIBC_2_0
)
202 static enum xprt_stat
211 svcudp_recv (xprt
, msg
)
215 struct svcudp_data
*su
= su_data (xprt
);
216 XDR
*xdrs
= &(su
->su_xdrs
);
222 /* It is very tricky when you have IP aliases. We want to make sure
223 that we are sending the packet from the IP address where the
224 incoming packet is addressed to. H.J. */
227 struct msghdr
*mesgp
;
231 /* FIXME -- should xp_addrlen be a size_t? */
232 len
= (socklen_t
) sizeof(struct sockaddr_in
);
234 iovp
= (struct iovec
*) &xprt
->xp_pad
[0];
235 mesgp
= (struct msghdr
*) &xprt
->xp_pad
[sizeof (struct iovec
)];
236 if (mesgp
->msg_iovlen
)
238 iovp
->iov_base
= rpc_buffer (xprt
);
239 iovp
->iov_len
= su
->su_iosz
;
240 mesgp
->msg_iov
= iovp
;
241 mesgp
->msg_iovlen
= 1;
242 mesgp
->msg_name
= &(xprt
->xp_raddr
);
243 mesgp
->msg_namelen
= len
;
244 mesgp
->msg_control
= &xprt
->xp_pad
[sizeof (struct iovec
)
245 + sizeof (struct msghdr
)];
246 mesgp
->msg_controllen
= sizeof(xprt
->xp_pad
)
247 - sizeof (struct iovec
) - sizeof (struct msghdr
);
248 rlen
= __recvmsg (xprt
->xp_sock
, mesgp
, 0);
251 struct cmsghdr
*cmsg
;
252 len
= mesgp
->msg_namelen
;
253 cmsg
= CMSG_FIRSTHDR (mesgp
);
255 || CMSG_NXTHDR (mesgp
, cmsg
) != NULL
256 || cmsg
->cmsg_level
!= SOL_IP
257 || cmsg
->cmsg_type
!= IP_PKTINFO
258 || cmsg
->cmsg_len
< (sizeof (struct cmsghdr
)
259 + sizeof (struct in_pktinfo
)))
261 /* Not a simple IP_PKTINFO, ignore it. */
262 mesgp
->msg_control
= NULL
;
263 mesgp
->msg_controllen
= 0;
267 /* It was a simple IP_PKTIFO as we expected, discard the
269 struct in_pktinfo
*pkti
= (struct in_pktinfo
*) CMSG_DATA (cmsg
);
270 pkti
->ipi_ifindex
= 0;
276 rlen
= __recvfrom (xprt
->xp_sock
, rpc_buffer (xprt
),
277 (int) su
->su_iosz
, 0,
278 (struct sockaddr
*) &(xprt
->xp_raddr
), &len
);
279 xprt
->xp_addrlen
= len
;
280 if (rlen
== -1 && errno
== EINTR
)
282 if (rlen
< 16) /* < 4 32-bit ints? */
284 xdrs
->x_op
= XDR_DECODE
;
285 XDR_SETPOS (xdrs
, 0);
286 if (!xdr_callmsg (xdrs
, msg
))
288 su
->su_xid
= msg
->rm_xid
;
289 if (su
->su_cache
!= NULL
)
291 if (cache_get (xprt
, msg
, &reply
, &replylen
))
294 if (mesgp
->msg_iovlen
)
296 iovp
->iov_base
= reply
;
297 iovp
->iov_len
= replylen
;
298 (void) __sendmsg (xprt
->xp_sock
, mesgp
, 0);
302 (void) __sendto (xprt
->xp_sock
, reply
, (int) replylen
, 0,
303 (struct sockaddr
*) &xprt
->xp_raddr
, len
);
311 svcudp_reply (xprt
, msg
)
315 struct svcudp_data
*su
= su_data (xprt
);
316 XDR
*xdrs
= &(su
->su_xdrs
);
321 struct msghdr
*mesgp
;
324 xdrs
->x_op
= XDR_ENCODE
;
325 XDR_SETPOS (xdrs
, 0);
326 msg
->rm_xid
= su
->su_xid
;
327 if (xdr_replymsg (xdrs
, msg
))
329 slen
= (int) XDR_GETPOS (xdrs
);
331 mesgp
= (struct msghdr
*) &xprt
->xp_pad
[sizeof (struct iovec
)];
332 if (mesgp
->msg_iovlen
)
334 iovp
= (struct iovec
*) &xprt
->xp_pad
[0];
335 iovp
->iov_base
= rpc_buffer (xprt
);
336 iovp
->iov_len
= slen
;
337 sent
= __sendmsg (xprt
->xp_sock
, mesgp
, 0);
341 sent
= __sendto (xprt
->xp_sock
, rpc_buffer (xprt
), slen
, 0,
342 (struct sockaddr
*) &(xprt
->xp_raddr
),
347 if (su
->su_cache
&& slen
>= 0)
349 cache_set (xprt
, (u_long
) slen
);
357 svcudp_getargs (xprt
, xdr_args
, args_ptr
)
363 return (*xdr_args
) (&(su_data (xprt
)->su_xdrs
), args_ptr
);
367 svcudp_freeargs (xprt
, xdr_args
, args_ptr
)
372 XDR
*xdrs
= &(su_data (xprt
)->su_xdrs
);
374 xdrs
->x_op
= XDR_FREE
;
375 return (*xdr_args
) (xdrs
, args_ptr
);
379 svcudp_destroy (xprt
)
382 struct svcudp_data
*su
= su_data (xprt
);
384 xprt_unregister (xprt
);
385 (void) __close (xprt
->xp_sock
);
386 XDR_DESTROY (&(su
->su_xdrs
));
387 mem_free (rpc_buffer (xprt
), su
->su_iosz
);
388 mem_free ((caddr_t
) su
, sizeof (struct svcudp_data
));
389 mem_free ((caddr_t
) xprt
, sizeof (SVCXPRT
));
393 /***********this could be a separate file*********************/
396 * Fifo cache for udp server
397 * Copies pointers to reply buffers into fifo cache
398 * Buffers are sent again if retransmissions are detected.
401 #define SPARSENESS 4 /* 75% sparse */
403 #define CACHE_PERROR(msg) \
404 (void) __fxprintf(NULL, "%s\n", msg)
406 #define ALLOC(type, size) \
407 (type *) mem_alloc((unsigned) (sizeof(type) * (size)))
409 #define CALLOC(type, size) \
410 (type *) calloc (sizeof (type), size)
413 * An entry in the cache
415 typedef struct cache_node
*cache_ptr
;
419 * Index into cache is xid, proc, vers, prog and address
425 struct sockaddr_in cache_addr
;
427 * The cached reply and length
430 u_long cache_replylen
;
432 * Next node on the list, if there is a collision
434 cache_ptr cache_next
;
444 u_long uc_size
; /* size of cache */
445 cache_ptr
*uc_entries
; /* hash table of entries in cache */
446 cache_ptr
*uc_fifo
; /* fifo list of entries in cache */
447 u_long uc_nextvictim
; /* points to next victim in fifo list */
448 u_long uc_prog
; /* saved program number */
449 u_long uc_vers
; /* saved version number */
450 u_long uc_proc
; /* saved procedure number */
451 struct sockaddr_in uc_addr
; /* saved caller's address */
456 * the hashing function
458 #define CACHE_LOC(transp, xid) \
459 (xid % (SPARSENESS*((struct udp_cache *) su_data(transp)->su_cache)->uc_size))
463 * Enable use of the cache.
464 * Note: there is no disable.
467 svcudp_enablecache (SVCXPRT
*transp
, u_long size
)
469 struct svcudp_data
*su
= su_data (transp
);
470 struct udp_cache
*uc
;
472 if (su
->su_cache
!= NULL
)
474 CACHE_PERROR (_("enablecache: cache already enabled"));
477 uc
= ALLOC (struct udp_cache
, 1);
480 CACHE_PERROR (_("enablecache: could not allocate cache"));
484 uc
->uc_nextvictim
= 0;
485 uc
->uc_entries
= CALLOC (cache_ptr
, size
* SPARSENESS
);
486 if (uc
->uc_entries
== NULL
)
488 mem_free (uc
, sizeof (struct udp_cache
));
489 CACHE_PERROR (_("enablecache: could not allocate cache data"));
492 uc
->uc_fifo
= CALLOC (cache_ptr
, size
);
493 if (uc
->uc_fifo
== NULL
)
495 mem_free (uc
->uc_entries
, size
* SPARSENESS
);
496 mem_free (uc
, sizeof (struct udp_cache
));
497 CACHE_PERROR (_("enablecache: could not allocate cache fifo"));
500 su
->su_cache
= (char *) uc
;
503 libc_hidden_nolink (svcudp_enablecache
, GLIBC_2_0
)
507 * Set an entry in the cache
510 cache_set (SVCXPRT
*xprt
, u_long replylen
)
514 struct svcudp_data
*su
= su_data (xprt
);
515 struct udp_cache
*uc
= (struct udp_cache
*) su
->su_cache
;
520 * Find space for the new entry, either by
521 * reusing an old entry, or by mallocing a new one
523 victim
= uc
->uc_fifo
[uc
->uc_nextvictim
];
526 loc
= CACHE_LOC (xprt
, victim
->cache_xid
);
527 for (vicp
= &uc
->uc_entries
[loc
];
528 *vicp
!= NULL
&& *vicp
!= victim
;
529 vicp
= &(*vicp
)->cache_next
)
533 CACHE_PERROR (_("cache_set: victim not found"));
536 *vicp
= victim
->cache_next
; /* remote from cache */
537 newbuf
= victim
->cache_reply
;
541 victim
= ALLOC (struct cache_node
, 1);
544 CACHE_PERROR (_("cache_set: victim alloc failed"));
547 newbuf
= mem_alloc (su
->su_iosz
);
550 mem_free (victim
, sizeof (struct cache_node
));
551 CACHE_PERROR (_("cache_set: could not allocate new rpc_buffer"));
559 victim
->cache_replylen
= replylen
;
560 victim
->cache_reply
= rpc_buffer (xprt
);
561 rpc_buffer (xprt
) = newbuf
;
562 xdrmem_create (&(su
->su_xdrs
), rpc_buffer (xprt
), su
->su_iosz
, XDR_ENCODE
);
563 victim
->cache_xid
= su
->su_xid
;
564 victim
->cache_proc
= uc
->uc_proc
;
565 victim
->cache_vers
= uc
->uc_vers
;
566 victim
->cache_prog
= uc
->uc_prog
;
567 victim
->cache_addr
= uc
->uc_addr
;
568 loc
= CACHE_LOC (xprt
, victim
->cache_xid
);
569 victim
->cache_next
= uc
->uc_entries
[loc
];
570 uc
->uc_entries
[loc
] = victim
;
571 uc
->uc_fifo
[uc
->uc_nextvictim
++] = victim
;
572 uc
->uc_nextvictim
%= uc
->uc_size
;
576 * Try to get an entry from the cache
577 * return 1 if found, 0 if not found
580 cache_get (xprt
, msg
, replyp
, replylenp
)
588 struct svcudp_data
*su
= su_data (xprt
);
589 struct udp_cache
*uc
= (struct udp_cache
*) su
->su_cache
;
591 #define EQADDR(a1, a2) (memcmp((char*)&a1, (char*)&a2, sizeof(a1)) == 0)
593 loc
= CACHE_LOC (xprt
, su
->su_xid
);
594 for (ent
= uc
->uc_entries
[loc
]; ent
!= NULL
; ent
= ent
->cache_next
)
596 if (ent
->cache_xid
== su
->su_xid
&&
597 ent
->cache_proc
== uc
->uc_proc
&&
598 ent
->cache_vers
== uc
->uc_vers
&&
599 ent
->cache_prog
== uc
->uc_prog
&&
600 EQADDR (ent
->cache_addr
, uc
->uc_addr
))
602 *replyp
= ent
->cache_reply
;
603 *replylenp
= ent
->cache_replylen
;
608 * Failed to find entry
609 * Remember a few things so we can do a set later
611 uc
->uc_proc
= msg
->rm_call
.cb_proc
;
612 uc
->uc_vers
= msg
->rm_call
.cb_vers
;
613 uc
->uc_prog
= msg
->rm_call
.cb_prog
;
614 memcpy (&uc
->uc_addr
, &xprt
->xp_raddr
, sizeof (uc
->uc_addr
));