2 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
3 * unrestricted use provided that this legend is included on all tape
4 * media and as a part of the software program in whole or part. Users
5 * may copy or modify Sun RPC without charge, but are not authorized
6 * to license or distribute it to anyone else except as part of a product or
7 * program developed by the user.
9 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
10 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
11 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13 * Sun RPC is provided with no support and without any obligation on the
14 * part of Sun Microsystems, Inc. to assist in its use, correction,
15 * modification or enhancement.
17 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
18 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
19 * OR ANY PART THEREOF.
21 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
22 * or profits or other special, indirect and consequential damages, even if
23 * Sun has been advised of the possibility of such damages.
25 * Sun Microsystems, Inc.
27 * Mountain View, California 94043
31 * xdr_rec.c, Implements TCP/IP based XDR streams with a "record marking"
32 * layer above tcp (for rpc's use).
34 * Copyright (C) 1984, Sun Microsystems, Inc.
36 * These routines interface XDRSTREAMS to a tcp/ip connection.
37 * There is a record marking layer between the xdr stream
38 * and the tcp transport level. A record is composed on one or more
39 * record fragments. A record fragment is a thirty-two bit header followed
40 * by n bytes of data, where n is contained in the header. The header
41 * is represented as a htonl(u_long). The high order bit encodes
42 * whether or not the fragment is the last fragment of the record
43 * (1 => fragment is last, 0 => more fragments to follow.
44 * The other 31 bits encode the byte length of the fragment.
59 # include <libio/iolibio.h>
60 # define fputs(s, f) _IO_fputs (s, f)
61 libc_hidden_proto(fwprintf)
64 libc_hidden_proto(memcpy)
65 libc_hidden_proto(fputs)
66 libc_hidden_proto(lseek)
68 static bool_t xdrrec_getlong (XDR *, long *);
69 static bool_t xdrrec_putlong (XDR *, const long *);
70 static bool_t xdrrec_getbytes (XDR *, caddr_t, u_int);
71 static bool_t xdrrec_putbytes (XDR *, const char *, u_int);
72 static u_int xdrrec_getpos (const XDR *);
73 static bool_t xdrrec_setpos (XDR *, u_int);
74 static int32_t *xdrrec_inline (XDR *, int);
75 static void xdrrec_destroy (XDR *);
76 static bool_t xdrrec_getint32 (XDR *, int32_t *);
77 static bool_t xdrrec_putint32 (XDR *, const int32_t *);
79 static const struct xdr_ops xdrrec_ops = {
93 * A record is composed of one or more record fragments.
94 * A record fragment is a two-byte header followed by zero to
95 * 2**32-1 bytes. The header is treated as a long unsigned and is
96 * encode/decoded to the network via htonl/ntohl. The low order 31 bits
97 * are a byte count of the fragment. The highest order bit is a boolean:
98 * 1 => this fragment is the last fragment of the record,
99 * 0 => this fragment is followed by more fragment(s).
101 * The fragment/record machinery is not general; it is constructed to
102 * meet the needs of xdr and rpc based on tcp.
105 #define LAST_FRAG (1UL << 31)
107 typedef struct rec_strm
114 int (*writeit) (char *, char *, int);
115 caddr_t out_base; /* output buffer (points to frag header) */
116 caddr_t out_finger; /* next output position */
117 caddr_t out_boundry; /* data cannot up to this address */
118 u_int32_t *frag_header; /* beginning of curren fragment */
119 bool_t frag_sent; /* true if buffer sent in middle of record */
123 int (*readit) (char *, char *, int);
124 u_long in_size; /* fixed size of the input buffer */
126 caddr_t in_finger; /* location of next byte to be had */
127 caddr_t in_boundry; /* can read up to this location */
128 long fbtbc; /* fragment bytes to be consumed */
135 static u_int fix_buf_size (u_int) internal_function;
136 static bool_t skip_input_bytes (RECSTREAM *, long) internal_function;
137 static bool_t flush_out (RECSTREAM *, bool_t) internal_function;
138 static bool_t set_input_fragment (RECSTREAM *) internal_function;
139 static bool_t get_input_bytes (RECSTREAM *, caddr_t, int) internal_function;
142 * Create an xdr handle for xdrrec
143 * xdrrec_create fills in xdrs. Sendsize and recvsize are
144 * send and recv buffer sizes (0 => use default).
145 * tcp_handle is an opaque handle that is passed as the first parameter to
146 * the procedures readit and writeit. Readit and writeit are read and
147 * write respectively. They are like the system
148 * calls expect that they take an opaque handle rather than an fd.
150 libc_hidden_proto(xdrrec_create)
152 xdrrec_create (XDR *xdrs, u_int sendsize,
153 u_int recvsize, caddr_t tcp_handle,
154 int (*readit) (char *, char *, int),
155 int (*writeit) (char *, char *, int))
157 RECSTREAM *rstrm = (RECSTREAM *) mem_alloc (sizeof (RECSTREAM));
161 sendsize = fix_buf_size (sendsize);
162 recvsize = fix_buf_size (recvsize);
163 buf = mem_alloc (sendsize + recvsize + BYTES_PER_XDR_UNIT);
165 if (rstrm == NULL || buf == NULL)
168 if (_IO_fwide (stderr, 0) > 0)
169 (void) fwprintf (stderr, L"%s", _("xdrrec_create: out of memory\n"));
172 (void) fputs (_("xdrrec_create: out of memory\n"), stderr);
173 mem_free (rstrm, sizeof (RECSTREAM));
174 mem_free (buf, sendsize + recvsize + BYTES_PER_XDR_UNIT);
176 * This is bad. Should rework xdrrec_create to
177 * return a handle, and in this case return NULL
182 * adjust sizes and allocate buffer quad byte aligned
184 rstrm->sendsize = sendsize;
185 rstrm->recvsize = recvsize;
186 rstrm->the_buffer = buf;
187 tmp = rstrm->the_buffer;
188 if ((size_t)tmp % BYTES_PER_XDR_UNIT)
189 tmp += BYTES_PER_XDR_UNIT - (size_t)tmp % BYTES_PER_XDR_UNIT;
190 rstrm->out_base = tmp;
191 rstrm->in_base = tmp + sendsize;
195 /* We have to add the const since the `struct xdr_ops' in `struct XDR'
197 xdrs->x_ops = (struct xdr_ops *) &xdrrec_ops;
198 xdrs->x_private = (caddr_t) rstrm;
199 rstrm->tcp_handle = tcp_handle;
200 rstrm->readit = readit;
201 rstrm->writeit = writeit;
202 rstrm->out_finger = rstrm->out_boundry = rstrm->out_base;
203 rstrm->frag_header = (u_int32_t *) rstrm->out_base;
204 rstrm->out_finger += 4;
205 rstrm->out_boundry += sendsize;
206 rstrm->frag_sent = FALSE;
207 rstrm->in_size = recvsize;
208 rstrm->in_boundry = rstrm->in_base;
209 rstrm->in_finger = (rstrm->in_boundry += recvsize);
211 rstrm->last_frag = TRUE;
213 libc_hidden_def(xdrrec_create)
217 * The routines defined below are the xdr ops which will go into the
218 * xdr handle filled in by xdrrec_create.
222 xdrrec_getlong (XDR *xdrs, long *lp)
224 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
225 int32_t *buflp = (int32_t *) rstrm->in_finger;
228 /* first try the inline, fast case */
229 if (rstrm->fbtbc >= BYTES_PER_XDR_UNIT &&
230 rstrm->in_boundry - (char *) buflp >= BYTES_PER_XDR_UNIT)
232 *lp = (int32_t) ntohl (*buflp);
233 rstrm->fbtbc -= BYTES_PER_XDR_UNIT;
234 rstrm->in_finger += BYTES_PER_XDR_UNIT;
238 if (!xdrrec_getbytes (xdrs, (caddr_t) & mylong,
241 *lp = (int32_t) ntohl (mylong);
247 xdrrec_putlong (XDR *xdrs, const long *lp)
249 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
250 int32_t *dest_lp = (int32_t *) rstrm->out_finger;
252 if ((rstrm->out_finger += BYTES_PER_XDR_UNIT) > rstrm->out_boundry)
255 * this case should almost never happen so the code is
258 rstrm->out_finger -= BYTES_PER_XDR_UNIT;
259 rstrm->frag_sent = TRUE;
260 if (!flush_out (rstrm, FALSE))
262 dest_lp = (int32_t *) rstrm->out_finger;
263 rstrm->out_finger += BYTES_PER_XDR_UNIT;
265 *dest_lp = htonl (*lp);
269 static bool_t /* must manage buffers, fragments, and records */
270 xdrrec_getbytes (XDR *xdrs, caddr_t addr, u_int len)
272 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
277 current = rstrm->fbtbc;
280 if (rstrm->last_frag)
282 if (!set_input_fragment (rstrm))
286 current = (len < current) ? len : current;
287 if (!get_input_bytes (rstrm, addr, current))
290 rstrm->fbtbc -= current;
297 xdrrec_putbytes (XDR *xdrs, const char *addr, u_int len)
299 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
304 current = rstrm->out_boundry - rstrm->out_finger;
305 current = (len < current) ? len : current;
306 memcpy (rstrm->out_finger, addr, current);
307 rstrm->out_finger += current;
310 if (rstrm->out_finger == rstrm->out_boundry && len > 0)
312 rstrm->frag_sent = TRUE;
313 if (!flush_out (rstrm, FALSE))
321 xdrrec_getpos (const XDR *xdrs)
323 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
326 pos = lseek ((int) (long) rstrm->tcp_handle, (long) 0, 1);
332 pos += rstrm->out_finger - rstrm->out_base;
336 pos -= rstrm->in_boundry - rstrm->in_finger;
347 xdrrec_setpos (XDR *xdrs, u_int pos)
349 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
350 u_int currpos = xdrrec_getpos (xdrs);
351 int delta = currpos - pos;
354 if ((int) currpos != -1)
359 newpos = rstrm->out_finger - delta;
360 if (newpos > (caddr_t) rstrm->frag_header &&
361 newpos < rstrm->out_boundry)
363 rstrm->out_finger = newpos;
369 newpos = rstrm->in_finger - delta;
370 if ((delta < (int) (rstrm->fbtbc)) &&
371 (newpos <= rstrm->in_boundry) &&
372 (newpos >= rstrm->in_base))
374 rstrm->in_finger = newpos;
375 rstrm->fbtbc -= delta;
387 xdrrec_inline (XDR *xdrs, int len)
389 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
396 if ((rstrm->out_finger + len) <= rstrm->out_boundry)
398 buf = (int32_t *) rstrm->out_finger;
399 rstrm->out_finger += len;
404 if ((len <= rstrm->fbtbc) &&
405 ((rstrm->in_finger + len) <= rstrm->in_boundry))
407 buf = (int32_t *) rstrm->in_finger;
409 rstrm->in_finger += len;
420 xdrrec_destroy (XDR *xdrs)
422 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
424 mem_free (rstrm->the_buffer,
425 rstrm->sendsize + rstrm->recvsize + BYTES_PER_XDR_UNIT);
426 mem_free ((caddr_t) rstrm, sizeof (RECSTREAM));
430 xdrrec_getint32 (XDR *xdrs, int32_t *ip)
432 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
433 int32_t *bufip = (int32_t *) rstrm->in_finger;
436 /* first try the inline, fast case */
437 if (rstrm->fbtbc >= BYTES_PER_XDR_UNIT &&
438 rstrm->in_boundry - (char *) bufip >= BYTES_PER_XDR_UNIT)
440 *ip = ntohl (*bufip);
441 rstrm->fbtbc -= BYTES_PER_XDR_UNIT;
442 rstrm->in_finger += BYTES_PER_XDR_UNIT;
446 if (!xdrrec_getbytes (xdrs, (caddr_t) &mylong,
449 *ip = ntohl (mylong);
455 xdrrec_putint32 (XDR *xdrs, const int32_t *ip)
457 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
458 int32_t *dest_ip = (int32_t *) rstrm->out_finger;
460 if ((rstrm->out_finger += BYTES_PER_XDR_UNIT) > rstrm->out_boundry)
463 * this case should almost never happen so the code is
466 rstrm->out_finger -= BYTES_PER_XDR_UNIT;
467 rstrm->frag_sent = TRUE;
468 if (!flush_out (rstrm, FALSE))
470 dest_ip = (int32_t *) rstrm->out_finger;
471 rstrm->out_finger += BYTES_PER_XDR_UNIT;
473 *dest_ip = htonl (*ip);
478 * Exported routines to manage xdr records
482 * Before reading (deserializing from the stream, one should always call
483 * this procedure to guarantee proper record alignment.
485 libc_hidden_proto(xdrrec_skiprecord)
487 xdrrec_skiprecord (XDR *xdrs)
489 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
491 while (rstrm->fbtbc > 0 || (!rstrm->last_frag))
493 if (!skip_input_bytes (rstrm, rstrm->fbtbc))
496 if ((!rstrm->last_frag) && (!set_input_fragment (rstrm)))
499 rstrm->last_frag = FALSE;
502 libc_hidden_def(xdrrec_skiprecord)
505 * Lookahead function.
506 * Returns TRUE iff there is no more input in the buffer
507 * after consuming the rest of the current record.
509 libc_hidden_proto(xdrrec_eof)
511 xdrrec_eof (XDR *xdrs)
513 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
515 while (rstrm->fbtbc > 0 || (!rstrm->last_frag))
517 if (!skip_input_bytes (rstrm, rstrm->fbtbc))
520 if ((!rstrm->last_frag) && (!set_input_fragment (rstrm)))
523 if (rstrm->in_finger == rstrm->in_boundry)
527 libc_hidden_def(xdrrec_eof)
530 * The client must tell the package when an end-of-record has occurred.
531 * The second parameter tells whether the record should be flushed to the
532 * (output) tcp stream. (This lets the package support batched or
533 * pipelined procedure calls.) TRUE => immediate flush to tcp connection.
535 libc_hidden_proto(xdrrec_endofrecord)
537 xdrrec_endofrecord (XDR *xdrs, bool_t sendnow)
539 RECSTREAM *rstrm = (RECSTREAM *) xdrs->x_private;
540 u_long len; /* fragment length */
542 if (sendnow || rstrm->frag_sent
543 || rstrm->out_finger + BYTES_PER_XDR_UNIT >= rstrm->out_boundry)
545 rstrm->frag_sent = FALSE;
546 return flush_out (rstrm, TRUE);
548 len = (rstrm->out_finger - (char *) rstrm->frag_header
549 - BYTES_PER_XDR_UNIT);
550 *rstrm->frag_header = htonl ((u_long) len | LAST_FRAG);
551 rstrm->frag_header = (u_int32_t *) rstrm->out_finger;
552 rstrm->out_finger += BYTES_PER_XDR_UNIT;
555 libc_hidden_def(xdrrec_endofrecord)
558 * Internal useful routines
562 flush_out (RECSTREAM *rstrm, bool_t eor)
564 u_long eormask = (eor == TRUE) ? LAST_FRAG : 0;
565 u_long len = (rstrm->out_finger - (char *) rstrm->frag_header
566 - BYTES_PER_XDR_UNIT);
568 *rstrm->frag_header = htonl (len | eormask);
569 len = rstrm->out_finger - rstrm->out_base;
570 if ((*(rstrm->writeit)) (rstrm->tcp_handle, rstrm->out_base, (int) len)
573 rstrm->frag_header = (u_int32_t *) rstrm->out_base;
574 rstrm->out_finger = (caddr_t) rstrm->out_base + BYTES_PER_XDR_UNIT;
578 static bool_t /* knows nothing about records! Only about input buffers */
579 fill_input_buf (RECSTREAM *rstrm)
585 where = rstrm->in_base;
586 i = (size_t) rstrm->in_boundry % BYTES_PER_XDR_UNIT;
588 len = rstrm->in_size - i;
589 if ((len = (*(rstrm->readit)) (rstrm->tcp_handle, where, len)) == -1)
591 rstrm->in_finger = where;
593 rstrm->in_boundry = where;
597 static bool_t /* knows nothing about records! Only about input buffers */
599 get_input_bytes (RECSTREAM *rstrm, caddr_t addr, int len)
605 current = rstrm->in_boundry - rstrm->in_finger;
608 if (!fill_input_buf (rstrm))
612 current = (len < current) ? len : current;
613 memcpy (addr, rstrm->in_finger, current);
614 rstrm->in_finger += current;
621 static bool_t /* next two bytes of the input stream are treated as a header */
623 set_input_fragment (RECSTREAM *rstrm)
627 if (! get_input_bytes (rstrm, (caddr_t)&header, BYTES_PER_XDR_UNIT))
629 header = ntohl (header);
630 rstrm->last_frag = ((header & LAST_FRAG) == 0) ? FALSE : TRUE;
632 * Sanity check. Try not to accept wildly incorrect fragment
633 * sizes. Unfortunately, only a size of zero can be identified as
634 * 'wildely incorrect', and this only, if it is not the last
635 * fragment of a message. Ridiculously large fragment sizes may look
636 * wrong, but we don't have any way to be certain that they aren't
637 * what the client actually intended to send us. Many existing RPC
638 * implementations may sent a fragment of size zero as the last
639 * fragment of a message.
643 rstrm->fbtbc = header & ~LAST_FRAG;
647 static bool_t /* consumes input bytes; knows nothing about records! */
649 skip_input_bytes (RECSTREAM *rstrm, long cnt)
655 current = rstrm->in_boundry - rstrm->in_finger;
658 if (!fill_input_buf (rstrm))
662 current = (cnt < current) ? cnt : current;
663 rstrm->in_finger += current;
671 fix_buf_size (u_int s)