1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
/* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
/* All Rights Reserved */
/*
* Portions of this source code were derived from Berkeley
* 4.3 BSD under license from the Regents of the University of
* California.
*/
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* xdr_rec.c, Implements (TCP/IP based) XDR streams with a "record marking"
* layer above connection oriented transport layer (e.g. tcp) (for rpc's use).
*
*
* These routines interface XDRSTREAMS to a (tcp/ip) connection transport.
* There is a record marking layer between the xdr stream
* and the (tcp) cv transport level. A record is composed on one or more
* record fragments. A record fragment is a thirty-two bit header followed
* by n bytes of data, where n is contained in the header. The header
* is represented as a htonl(ulong_t). The order bit encodes
* whether or not the fragment is the last fragment of the record
* (1 => fragment is last, 0 => more fragments to follow.
* The other 31 bits encode the byte length of the fragment.
*/
#include "mt.h"
#include "rpc_mt.h"
#include <stdio.h>
#include <rpc/types.h>
#include <rpc/rpc.h>
#include <sys/types.h>
#include <syslog.h>
#include <memory.h>
#include <stdlib.h>
#include <unistd.h>
#include <inttypes.h>
#include <string.h>
/*
* A record is composed of one or more record fragments.
* A record fragment is a four-byte header followed by zero to
* 2**32-1 bytes. The header is treated as a long unsigned and is
* encode/decoded to the network via htonl/ntohl. The low order 31 bits
* are a byte count of the fragment. The highest order bit is a boolean:
* 1 => this fragment is the last fragment of the record,
* 0 => this fragment is followed by more fragment(s).
*
* The fragment/record machinery is not general; it is constructed to
* meet the needs of xdr and rpc based on tcp.
*/
#define LAST_FRAG (((uint32_t)1 << 31))
/*
* Minimum fragment size is size of rpc callmsg over TCP:
* xid direction vers prog vers proc
* cred flavor, cred length, cred
* verf flavor, verf length, verf
* (with no cred or verf allocated)
*/
#define MIN_FRAG (10 * BYTES_PER_XDR_UNIT)
typedef struct rec_strm {
caddr_t tcp_handle;
/*
* out-going bits
*/
int (*writeit)();
caddr_t out_base; /* output buffer (points to frag header) */
caddr_t out_finger; /* next output position */
caddr_t out_boundry; /* data cannot up to this address */
uint32_t *frag_header; /* beginning of current fragment */
bool_t frag_sent; /* true if buffer sent in middle of record */
/*
* in-coming bits
*/
int (*readit)();
caddr_t in_base; /* input buffer */
caddr_t in_finger; /* location of next byte to be had */
caddr_t in_boundry; /* can read up to this location */
int fbtbc; /* fragment bytes to be consumed */
bool_t last_frag;
uint_t sendsize;
uint_t recvsize;
/*
* Is this the first time that the
* getbytes routine has been called ?
*/
uint_t firsttime;
/*
* Is this non-blocked?
*/
uint_t in_nonblock; /* non-blocked input */
uint_t in_needpoll; /* need to poll to get more data ? */
uint32_t in_maxrecsz; /* maximum record size */
caddr_t in_nextrec; /* start of next record */
uint32_t in_nextrecsz; /* part of next record in buffer */
} RECSTREAM;
static uint_t fix_buf_size(uint_t);
static struct xdr_ops *xdrrec_ops(void);
static bool_t xdrrec_getbytes(XDR *, caddr_t, int);
static bool_t flush_out(RECSTREAM *, bool_t);
static bool_t get_input_bytes(RECSTREAM *, caddr_t, int, bool_t);
static bool_t set_input_fragment(RECSTREAM *);
static bool_t skip_input_bytes(RECSTREAM *, int32_t);
bool_t __xdrrec_getbytes_nonblock(XDR *, enum xprt_stat *);
/*
* Create an xdr handle for xdrrec
* xdrrec_create fills in xdrs. Sendsize and recvsize are
* send and recv buffer sizes (0 => use default).
* vc_handle is an opaque handle that is passed as the first parameter to
* the procedures readit and writeit. Readit and writeit are read and
* write respectively. They are like the system calls expect that they
* take an opaque handle rather than an fd.
*/
static const char mem_err_msg_rec[] = "xdrrec_create: out of memory";
void
xdrrec_create(XDR *xdrs, const uint_t sendsize, const uint_t recvsize,
const caddr_t tcp_handle, int (*readit)(), int (*writeit)())
{
RECSTREAM *rstrm = malloc(sizeof (RECSTREAM));
/*
* XXX: Should still rework xdrrec_create to return a handle,
* and in any malloc-failure case return NULL.
*/
if (rstrm == NULL) {
(void) syslog(LOG_ERR, mem_err_msg_rec);
return;
}
/*
* Adjust sizes and allocate buffers; malloc(3C)
* provides a buffer suitably aligned for any use, so
* there's no need for us to mess around with alignment.
*
* Since non-blocking connections may need to reallocate the input
* buffer, we use separate malloc()s for input and output.
*/
rstrm->sendsize = fix_buf_size(sendsize);
rstrm->recvsize = fix_buf_size(recvsize);
rstrm->out_base = malloc(rstrm->sendsize);
if (rstrm->out_base == NULL) {
(void) syslog(LOG_ERR, mem_err_msg_rec);
free(rstrm);
return;
}
rstrm->in_base = malloc(rstrm->recvsize);
if (rstrm->in_base == NULL) {
(void) syslog(LOG_ERR, mem_err_msg_rec);
free(rstrm->out_base);
free(rstrm);
return;
}
/*
* now the rest ...
*/
xdrs->x_ops = xdrrec_ops();
xdrs->x_private = (caddr_t)rstrm;
rstrm->tcp_handle = tcp_handle;
rstrm->readit = readit;
rstrm->writeit = writeit;
rstrm->out_finger = rstrm->out_boundry = rstrm->out_base;
/* LINTED pointer cast */
rstrm->frag_header = (uint32_t *)rstrm->out_base;
rstrm->out_finger += sizeof (uint_t);
rstrm->out_boundry += rstrm->sendsize;
rstrm->frag_sent = FALSE;
rstrm->in_boundry = rstrm->in_base;
rstrm->in_finger = (rstrm->in_boundry += rstrm->recvsize);
rstrm->fbtbc = 0;
rstrm->last_frag = TRUE;
rstrm->firsttime = 0;
rstrm->in_nonblock = 0;
rstrm->in_needpoll = 1;
rstrm->in_maxrecsz = 0;
rstrm->in_nextrec = rstrm->in_base;
rstrm->in_nextrecsz = 0;
}
/*
* Align input stream. If all applications behaved correctly, this
* defensive procedure will not be necessary, since received data will be
* aligned correctly.
*/
static void
align_instream(RECSTREAM *rstrm)
{
int current = rstrm->in_boundry - rstrm->in_finger;
(void) memcpy(rstrm->in_base, rstrm->in_finger, current);
rstrm->in_finger = rstrm->in_base;
rstrm->in_boundry = rstrm->in_finger + current;
}
/*
* The routines defined below are the xdr ops which will go into the
* xdr handle filled in by xdrrec_create.
*/
static bool_t
xdrrec_getint32(XDR *xdrs, int32_t *ip)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
/* LINTED pointer cast */
int32_t *buflp = (int32_t *)(rstrm->in_finger);
int32_t mylong;
/* first try the inline, fast case */
if ((rstrm->fbtbc >= (int)sizeof (int32_t)) &&
((uint_t)(rstrm->in_boundry - (caddr_t)buflp) >=
(uint_t)sizeof (int32_t))) {
/*
* Check if buflp is longword aligned. If not, align it.
*/
if (((uintptr_t)buflp) & ((int)sizeof (int32_t) - 1)) {
align_instream(rstrm);
/* LINTED pointer cast */
buflp = (int32_t *)(rstrm->in_finger);
}
*ip = (int32_t)ntohl((uint32_t)(*buflp));
rstrm->fbtbc -= (int)sizeof (int32_t);
rstrm->in_finger += sizeof (int32_t);
} else {
if (!xdrrec_getbytes(xdrs, (caddr_t)&mylong, sizeof (int32_t)))
return (FALSE);
*ip = (int32_t)ntohl((uint32_t)mylong);
}
return (TRUE);
}
static bool_t
xdrrec_putint32(XDR *xdrs, int32_t *ip)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
/* LINTED pointer cast */
int32_t *dest_lp = ((int32_t *)(rstrm->out_finger));
if ((rstrm->out_finger += sizeof (int32_t)) > rstrm->out_boundry) {
/*
* this case should almost never happen so the code is
* inefficient
*/
rstrm->out_finger -= sizeof (int32_t);
rstrm->frag_sent = TRUE;
if (!flush_out(rstrm, FALSE))
return (FALSE);
/* LINTED pointer cast */
dest_lp = ((int32_t *)(rstrm->out_finger));
rstrm->out_finger += sizeof (int32_t);
}
*dest_lp = (int32_t)htonl((uint32_t)(*ip));
return (TRUE);
}
static bool_t
xdrrec_getlong(XDR *xdrs, long *lp)
{
int32_t i;
if (!xdrrec_getint32(xdrs, &i))
return (FALSE);
*lp = (long)i;
return (TRUE);
}
static bool_t
xdrrec_putlong(XDR *xdrs, long *lp)
{
int32_t i;
#if defined(_LP64)
if ((*lp > INT32_MAX) || (*lp < INT32_MIN))
return (FALSE);
#endif
i = (int32_t)*lp;
return (xdrrec_putint32(xdrs, &i));
}
static bool_t /* must manage buffers, fragments, and records */
xdrrec_getbytes(XDR *xdrs, caddr_t addr, int len)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
int current;
while (len > 0) {
current = rstrm->fbtbc;
if (current == 0) {
if (rstrm->last_frag)
return (FALSE);
if (!set_input_fragment(rstrm))
return (FALSE);
continue;
}
current = (len < current) ? len : current;
if (!get_input_bytes(rstrm, addr, current, FALSE))
return (FALSE);
addr += current;
rstrm->fbtbc -= current;
len -= current;
}
return (TRUE);
}
static bool_t
xdrrec_putbytes(XDR *xdrs, caddr_t addr, int len)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
int current;
while (len > 0) {
current = (uintptr_t)rstrm->out_boundry -
(uintptr_t)rstrm->out_finger;
current = (len < current) ? len : current;
(void) memcpy(rstrm->out_finger, addr, current);
rstrm->out_finger += current;
addr += current;
len -= current;
if (rstrm->out_finger == rstrm->out_boundry) {
rstrm->frag_sent = TRUE;
if (!flush_out(rstrm, FALSE))
return (FALSE);
}
}
return (TRUE);
}
/*
* This is just like the ops vector x_getbytes(), except that
* instead of returning success or failure on getting a certain number
* of bytes, it behaves much more like the read() system call against a
* pipe -- it returns up to the number of bytes requested and a return of
* zero indicates end-of-record. A -1 means something very bad happened.
*/
uint_t /* must manage buffers, fragments, and records */
xdrrec_readbytes(XDR *xdrs, caddr_t addr, uint_t l)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
int current, len;
len = l;
while (len > 0) {
current = rstrm->fbtbc;
if (current == 0) {
if (rstrm->last_frag)
return (l - len);
if (!set_input_fragment(rstrm))
return ((uint_t)-1);
continue;
}
current = (len < current) ? len : current;
if (!get_input_bytes(rstrm, addr, current, FALSE))
return ((uint_t)-1);
addr += current;
rstrm->fbtbc -= current;
len -= current;
}
return (l - len);
}
static uint_t
xdrrec_getpos(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)xdrs->x_private;
int32_t pos;
pos = lseek((intptr_t)rstrm->tcp_handle, 0, 1);
if (pos != -1)
switch (xdrs->x_op) {
case XDR_ENCODE:
pos += rstrm->out_finger - rstrm->out_base;
break;
case XDR_DECODE:
pos -= rstrm->in_boundry - rstrm->in_finger;
break;
default:
pos = (uint_t)-1;
break;
}
return ((uint_t)pos);
}
static bool_t
xdrrec_setpos(XDR *xdrs, uint_t pos)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)xdrs->x_private;
uint_t currpos = xdrrec_getpos(xdrs);
int delta = currpos - pos;
caddr_t newpos;
if ((int)currpos != -1)
switch (xdrs->x_op) {
case XDR_ENCODE:
newpos = rstrm->out_finger - delta;
if ((newpos > (caddr_t)(rstrm->frag_header)) &&
(newpos < rstrm->out_boundry)) {
rstrm->out_finger = newpos;
return (TRUE);
}
break;
case XDR_DECODE:
newpos = rstrm->in_finger - delta;
if ((delta < (int)(rstrm->fbtbc)) &&
(newpos <= rstrm->in_boundry) &&
(newpos >= rstrm->in_base)) {
rstrm->in_finger = newpos;
rstrm->fbtbc -= delta;
return (TRUE);
}
break;
}
return (FALSE);
}
static rpc_inline_t *
xdrrec_inline(XDR *xdrs, int len)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)xdrs->x_private;
rpc_inline_t *buf = NULL;
switch (xdrs->x_op) {
case XDR_ENCODE:
if ((rstrm->out_finger + len) <= rstrm->out_boundry) {
/* LINTED pointer cast */
buf = (rpc_inline_t *)rstrm->out_finger;
rstrm->out_finger += len;
}
break;
case XDR_DECODE:
if ((len <= rstrm->fbtbc) &&
((rstrm->in_finger + len) <= rstrm->in_boundry)) {
/*
* Check if rstrm->in_finger is longword aligned;
* if not, align it.
*/
if (((intptr_t)rstrm->in_finger) &
(sizeof (int32_t) - 1))
align_instream(rstrm);
/* LINTED pointer cast */
buf = (rpc_inline_t *)rstrm->in_finger;
rstrm->fbtbc -= len;
rstrm->in_finger += len;
}
break;
}
return (buf);
}
static void
xdrrec_destroy(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)xdrs->x_private;
free(rstrm->out_base);
free(rstrm->in_base);
free(rstrm);
}
/*
* Exported routines to manage xdr records
*/
/*
* Before reading (deserializing) from the stream, one should always call
* this procedure to guarantee proper record alignment.
*/
bool_t
xdrrec_skiprecord(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
if (rstrm->in_nonblock) {
enum xprt_stat pstat;
/*
* Read and discard a record from the non-blocking
* buffer. Return succes only if a complete record can
* be retrieved without blocking, or if the buffer was
* empty and there was no data to fetch.
*/
if (__xdrrec_getbytes_nonblock(xdrs, &pstat) ||
(pstat == XPRT_MOREREQS &&
rstrm->in_finger == rstrm->in_boundry)) {
rstrm->fbtbc = 0;
return (TRUE);
}
return (FALSE);
}
while (rstrm->fbtbc > 0 || (!rstrm->last_frag)) {
if (!skip_input_bytes(rstrm, rstrm->fbtbc))
return (FALSE);
rstrm->fbtbc = 0;
if ((!rstrm->last_frag) && (!set_input_fragment(rstrm)))
return (FALSE);
}
rstrm->last_frag = FALSE;
return (TRUE);
}
/*
* Look ahead fuction.
* Returns TRUE iff there is no more input in the buffer
* after consuming the rest of the current record.
*/
bool_t
xdrrec_eof(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
if (rstrm->in_nonblock) {
/*
* If in_needpoll is true, the non-blocking XDR stream
* does not have a complete record.
*/
return (rstrm->in_needpoll);
}
while (rstrm->fbtbc > 0 || (!rstrm->last_frag)) {
if (!skip_input_bytes(rstrm, rstrm->fbtbc))
return (TRUE);
rstrm->fbtbc = 0;
if ((!rstrm->last_frag) && (!set_input_fragment(rstrm)))
return (TRUE);
}
if (rstrm->in_finger == rstrm->in_boundry)
return (TRUE);
return (FALSE);
}
/*
* The client must tell the package when an end-of-record has occurred.
* The second parameters tells whether the record should be flushed to the
* (output) tcp stream. (This let's the package support batched or
* pipelined procedure calls.) TRUE => immmediate flush to tcp connection.
*/
bool_t
xdrrec_endofrecord(XDR *xdrs, bool_t sendnow)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
uint32_t len; /* fragment length */
if (sendnow || rstrm->frag_sent ||
((uintptr_t)rstrm->out_finger + sizeof (uint32_t) >=
(uintptr_t)rstrm->out_boundry)) {
rstrm->frag_sent = FALSE;
return (flush_out(rstrm, TRUE));
}
len = (uintptr_t)(rstrm->out_finger) - (uintptr_t)(rstrm->frag_header) -
sizeof (uint32_t);
*(rstrm->frag_header) = htonl((uint32_t)len | LAST_FRAG);
/* LINTED pointer cast */
rstrm->frag_header = (uint32_t *)rstrm->out_finger;
rstrm->out_finger += sizeof (uint32_t);
return (TRUE);
}
/*
* Internal useful routines
*/
static bool_t
flush_out(RECSTREAM *rstrm, bool_t eor)
{
uint32_t eormask = (eor == TRUE) ? LAST_FRAG : 0;
uint32_t len = (uintptr_t)(rstrm->out_finger) -
(uintptr_t)(rstrm->frag_header) - sizeof (uint32_t);
int written;
*(rstrm->frag_header) = htonl(len | eormask);
len = (uintptr_t)(rstrm->out_finger) - (uintptr_t)(rstrm->out_base);
written = (*(rstrm->writeit))
(rstrm->tcp_handle, rstrm->out_base, (int)len);
/*
* Handle the specific 'CANT_STORE' error. In this case, the
* fragment must be cleared.
*/
if ((written != (int)len) && (written != -2))
return (FALSE);
/* LINTED pointer cast */
rstrm->frag_header = (uint32_t *)rstrm->out_base;
rstrm->out_finger = (caddr_t)rstrm->out_base + sizeof (uint32_t);
return (TRUE);
}
/* knows nothing about records! Only about input buffers */
static bool_t
fill_input_buf(RECSTREAM *rstrm, bool_t do_align)
{
caddr_t where;
int len;
if (rstrm->in_nonblock) {
/* Should never get here in the non-blocking case */
return (FALSE);
}
where = rstrm->in_base;
if (do_align) {
len = rstrm->recvsize;
} else {
uint_t i = (uintptr_t)rstrm->in_boundry % BYTES_PER_XDR_UNIT;
where += i;
len = rstrm->recvsize - i;
}
if ((len = (*(rstrm->readit))(rstrm->tcp_handle, where, len)) == -1)
return (FALSE);
rstrm->in_finger = where;
where += len;
rstrm->in_boundry = where;
return (TRUE);
}
/* knows nothing about records! Only about input buffers */
static bool_t
get_input_bytes(RECSTREAM *rstrm, caddr_t addr,
int len, bool_t do_align)
{
int current;
if (rstrm->in_nonblock) {
/*
* Data should already be in the rstrm buffer, so we just
* need to copy it to 'addr'.
*/
current = (int)(rstrm->in_boundry - rstrm->in_finger);
if (len > current)
return (FALSE);
(void) memcpy(addr, rstrm->in_finger, len);
rstrm->in_finger += len;
addr += len;
return (TRUE);
}
while (len > 0) {
current = (intptr_t)rstrm->in_boundry -
(intptr_t)rstrm->in_finger;
if (current == 0) {
if (!fill_input_buf(rstrm, do_align))
return (FALSE);
continue;
}
current = (len < current) ? len : current;
(void) memcpy(addr, rstrm->in_finger, current);
rstrm->in_finger += current;
addr += current;
len -= current;
do_align = FALSE;
}
return (TRUE);
}
/* next four bytes of the input stream are treated as a header */
static bool_t
set_input_fragment(RECSTREAM *rstrm)
{
uint32_t header;
if (rstrm->in_nonblock) {
/*
* In the non-blocking case, the fragment headers should
* already have been consumed, so we should never get
* here. Might as well return failure right away.
*/
return (FALSE);
}
if (!get_input_bytes(rstrm, (caddr_t)&header, (int)sizeof (header),
rstrm->last_frag))
return (FALSE);
header = (uint32_t)ntohl(header);
rstrm->last_frag = ((header & LAST_FRAG) == 0) ? FALSE : TRUE;
rstrm->fbtbc = header & (~LAST_FRAG);
return (TRUE);
}
/* consumes input bytes; knows nothing about records! */
static bool_t
skip_input_bytes(RECSTREAM *rstrm, int32_t cnt)
{
int current;
while (cnt > 0) {
current = (intptr_t)rstrm->in_boundry -
(intptr_t)rstrm->in_finger;
if (current == 0) {
if (!fill_input_buf(rstrm, FALSE))
return (FALSE);
continue;
}
current = (cnt < current) ? cnt : current;
rstrm->in_finger += current;
cnt -= current;
}
return (TRUE);
}
static bool_t
__xdrrec_nonblock_realloc(RECSTREAM *rstrm, uint32_t newsize)
{
caddr_t newbuf = rstrm->in_base;
ptrdiff_t offset;
bool_t ret = TRUE;
if (newsize > rstrm->recvsize) {
newbuf = (caddr_t)realloc(newbuf, newsize);
if (newbuf == 0) {
ret = FALSE;
} else {
/* Make pointers valid for the new buffer */
offset = newbuf - rstrm->in_base;
rstrm->in_finger += offset;
rstrm->in_boundry += offset;
rstrm->in_nextrec += offset;
rstrm->in_base = newbuf;
rstrm->recvsize = newsize;
}
}
return (ret);
}
/*
* adjust sizes and allocate buffer quad byte aligned
*/
bool_t
__xdrrec_set_conn_nonblock(XDR *xdrs, uint32_t tcp_maxrecsz)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
size_t newsize;
rstrm->in_nonblock = TRUE;
if (tcp_maxrecsz == 0) {
/*
* If maxrecsz has not been set, use the default
* that was set from xdrrec_create() and
* fix_buf_size()
*/
rstrm->in_maxrecsz = rstrm->recvsize;
return (TRUE);
}
rstrm->in_maxrecsz = tcp_maxrecsz;
if (tcp_maxrecsz <= rstrm->recvsize)
return (TRUE);
/*
* For nonblocked connection, the entire record is read into the
* buffer before any xdr processing. This implies that the record
* size must allow for the maximum expected message size of the
* service. However, it's inconvenient to allocate very large
* buffers up front, so we limit ourselves to a reasonable
* default size here, and reallocate (up to the maximum record
* size allowed for the connection) as necessary.
*/
if ((newsize = tcp_maxrecsz) > RPC_MAXDATASIZE) {
newsize = RPC_MAXDATASIZE;
}
if (!__xdrrec_nonblock_realloc(rstrm, newsize)) {
(void) syslog(LOG_ERR, mem_err_msg_rec);
free(rstrm->out_base);
free(rstrm->in_base);
free(rstrm);
return (FALSE);
}
return (TRUE);
}
/*
* Retrieve input data from the non-blocking connection, increase
* the size of the read buffer if necessary, and check that the
* record size stays below the allowed maximum for the connection.
*/
bool_t
__xdrrec_getbytes_nonblock(XDR *xdrs, enum xprt_stat *pstat)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
uint32_t prevbytes_thisrec, minreqrecsize;
uint32_t *header;
int32_t len_received = 0;
uint32_t unprocessed = 0;
/*
* For connection oriented protocols, there's no guarantee that
* we will receive the data nicely chopped into records, no
* matter how it was sent. We use the in_nextrec pointer to
* indicate where in the buffer the next record starts. If
* in_nextrec != in_base, there's data in the buffer from
* previous reads, and if in_nextrecsz > 0, we need to copy
* the portion of the next record already read to the start of
* the input buffer
*/
if (rstrm->in_nextrecsz > 0) {
/* Starting on new record with data already in the buffer */
(void) memmove(rstrm->in_base, rstrm->in_nextrec,
rstrm->in_nextrecsz);
rstrm->in_nextrec = rstrm->in_finger = rstrm->in_base;
rstrm->in_boundry = rstrm->in_nextrec + rstrm->in_nextrecsz;
unprocessed = rstrm->in_nextrecsz;
rstrm->in_nextrecsz = 0;
} else if (rstrm->in_nextrec == rstrm->in_base) {
/* Starting on new record with empty buffer */
rstrm->in_boundry = rstrm->in_finger = rstrm->in_base;
rstrm->last_frag = FALSE;
rstrm->in_needpoll = TRUE;
}
prevbytes_thisrec = (uint32_t)(rstrm->in_boundry - rstrm->in_base);
/* Do we need to retrieve data ? */
if (rstrm->in_needpoll) {
int len_requested, len_total_received;
rstrm->in_needpoll = FALSE;
len_total_received =
(int)(rstrm->in_boundry - rstrm->in_base);
len_requested = rstrm->recvsize - len_total_received;
/*
* if len_requested is 0, this means that the input
* buffer is full and need to be increased.
* The minimum record size we will need is whatever's
* already in the buffer, plus what's yet to be
* consumed in the current fragment, plus space for at
* least one more fragment header, if this is not the
* last fragment. We use the RNDUP() macro to
* account for possible realignment of the next
* fragment header.
*/
if (len_requested == 0) {
minreqrecsize = rstrm->recvsize +
rstrm->fbtbc +
(rstrm->last_frag ? 0 : sizeof (*header));
minreqrecsize = RNDUP(minreqrecsize);
if (minreqrecsize == rstrm->recvsize) {
/*
* no more bytes to be consumed and
* last fragment. We should never end up
* here. Might as well return failure
* right away.
*/
*pstat = XPRT_DIED;
return (FALSE);
}
if (minreqrecsize > rstrm->in_maxrecsz)
goto recsz_invalid;
else
goto needpoll;
}
if ((len_received = (*(rstrm->readit))(rstrm->tcp_handle,
rstrm->in_boundry, len_requested)) == -1) {
*pstat = XPRT_DIED;
return (FALSE);
}
rstrm->in_boundry += len_received;
rstrm->in_nextrec = rstrm->in_boundry;
}
/* Account for any left over data from previous processing */
len_received += unprocessed;
/* Set a lower limit on the buffer space we'll need */
minreqrecsize = prevbytes_thisrec + rstrm->fbtbc;
/*
* Consume bytes for this record until it's either complete,
* rejected, or we need to poll for more bytes.
*
* If fbtbc == 0, in_finger points to the start of the fragment
* header. Otherwise, it points to the start of the fragment data.
*/
while (len_received > 0) {
if (rstrm->fbtbc == 0) {
uint32_t hdrlen, minfraglen = 0;
uint32_t len_recvd_thisfrag;
bool_t last_frag;
len_recvd_thisfrag = (uint32_t)(rstrm->in_boundry -
rstrm->in_finger);
/* LINTED pointer cast */
header = (uint32_t *)rstrm->in_finger;
hdrlen = (len_recvd_thisfrag < sizeof (*header)) ?
len_recvd_thisfrag : sizeof (*header);
(void) memcpy(&minfraglen, header, hdrlen);
last_frag = (ntohl(minfraglen) & LAST_FRAG) != 0;
minfraglen = ntohl(minfraglen) & (~LAST_FRAG);
/*
* The minimum record size we will need is whatever's
* already in the buffer, plus the size of this
* fragment, plus (if this isn't the last fragment)
* space for at least one more fragment header. We
* use the RNDUP() macro to account for possible
* realignment of the next fragment header.
*/
minreqrecsize += minfraglen +
(last_frag?0:sizeof (*header));
minreqrecsize = RNDUP(minreqrecsize);
if (hdrlen < sizeof (*header)) {
/*
* We only have a partial fragment header,
* but we can still put a lower limit on the
* final fragment size, and check against the
* maximum allowed.
*/
if (len_recvd_thisfrag > 0 &&
(minreqrecsize > rstrm->in_maxrecsz)) {
goto recsz_invalid;
}
/* Need more bytes to obtain fbtbc value */
goto needpoll;
}
/*
* We've got a complete fragment header, so
* 'minfraglen' is the actual fragment length, and
* 'minreqrecsize' the requested record size.
*/
rstrm->last_frag = last_frag;
rstrm->fbtbc = minfraglen;
/*
* Check that the sum of the total number of bytes read
* so far (for the record) and the size of the incoming
* fragment is less than the maximum allowed.
*
* If this is the last fragment, also check that the
* record (message) meets the minimum length
* requirement.
*
* If this isn't the last fragment, check for a zero
* fragment length. Accepting such fragments would
* leave us open to an attack where the sender keeps
* the connection open indefinitely, without any
* progress, by occasionally sending a zero length
* fragment.
*/
if ((minreqrecsize > rstrm->in_maxrecsz) ||
(rstrm->last_frag && minreqrecsize < MIN_FRAG) ||
(!rstrm->last_frag && minfraglen == 0)) {
recsz_invalid:
rstrm->fbtbc = 0;
rstrm->last_frag = 1;
*pstat = XPRT_DIED;
return (FALSE);
}
/*
* Make this fragment abut the previous one. If it's
* the first fragment, just advance in_finger past
* the header. This avoids buffer copying for the
* usual case where there's one fragment per record.
*/
if (rstrm->in_finger == rstrm->in_base) {
rstrm->in_finger += sizeof (*header);
} else {
rstrm->in_boundry -= sizeof (*header);
(void) memmove(rstrm->in_finger,
rstrm->in_finger + sizeof (*header),
rstrm->in_boundry - rstrm->in_finger);
}
/* Consume the fragment header */
if (len_received > sizeof (*header)) {
len_received -= sizeof (*header);
} else {
len_received = 0;
}
}
/*
* Consume whatever fragment bytes we have.
* If we've received all bytes for this fragment, advance
* in_finger to point to the start of the next fragment
* header. Otherwise, make fbtbc tell how much is left in
* in this fragment and advance finger to point to end of
* fragment data.
*/
if (len_received >= rstrm->fbtbc) {
len_received -= rstrm->fbtbc;
rstrm->in_finger += rstrm->fbtbc;
rstrm->fbtbc = 0;
} else {
rstrm->fbtbc -= len_received;
rstrm->in_finger += len_received;
len_received = 0;
}
/*
* If there's more data in the buffer, there are two
* possibilities:
*
* (1) This is the last fragment, so the extra data
* presumably belongs to the next record.
*
* (2) Not the last fragment, so we'll start over
* from the top of the loop.
*/
if (len_received > 0 && rstrm->last_frag) {
rstrm->in_nextrec = rstrm->in_finger;
rstrm->in_nextrecsz = (uint32_t)(rstrm->in_boundry -
rstrm->in_nextrec);
len_received = 0;
}
}
/* Was this the last fragment, and have we read the entire record ? */
if (rstrm->last_frag && rstrm->fbtbc == 0) {
*pstat = XPRT_MOREREQS;
/*
* We've been using both in_finger and fbtbc for our own
* purposes. Now's the time to update them to be what
* xdrrec_inline() expects. Set in_finger to point to the
* start of data for this record, and fbtbc to the number
* of bytes in the record.
*/
rstrm->fbtbc = (int)(rstrm->in_finger -
rstrm->in_base - sizeof (*header));
rstrm->in_finger = rstrm->in_base + sizeof (*header);
if (rstrm->in_nextrecsz == 0)
rstrm->in_nextrec = rstrm->in_base;
return (TRUE);
}
needpoll:
/*
* Need more bytes, so we set the needpoll flag, and go back to
* the main RPC request loop. However, first we reallocate the
* input buffer, if necessary.
*/
if (minreqrecsize > rstrm->recvsize) {
if (!__xdrrec_nonblock_realloc(rstrm, minreqrecsize)) {
rstrm->fbtbc = 0;
rstrm->last_frag = 1;
*pstat = XPRT_DIED;
return (FALSE);
}
}
rstrm->in_needpoll = TRUE;
*pstat = XPRT_MOREREQS;
return (FALSE);
}
int
__is_xdrrec_first(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
return ((rstrm->firsttime == TRUE) ? 1 : 0);
}
int
__xdrrec_setfirst(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
/*
* Set rstrm->firsttime only if the input buffer is empty.
* Otherwise, the first read from the network could skip
* a poll.
*/
if (rstrm->in_finger == rstrm->in_boundry)
rstrm->firsttime = TRUE;
else
rstrm->firsttime = FALSE;
return (1);
}
int
__xdrrec_resetfirst(XDR *xdrs)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
rstrm->firsttime = FALSE;
return (1);
}
static uint_t
fix_buf_size(uint_t s)
{
if (s < 100)
s = 4000;
return (RNDUP(s));
}
static bool_t
xdrrec_control(XDR *xdrs, int request, void *info)
{
/* LINTED pointer cast */
RECSTREAM *rstrm = (RECSTREAM *)(xdrs->x_private);
xdr_bytesrec *xptr;
switch (request) {
case XDR_GET_BYTES_AVAIL:
/* Check if at end of fragment and not last fragment */
if ((rstrm->fbtbc == 0) && (!rstrm->last_frag))
if (!set_input_fragment(rstrm)) {
return (FALSE);
};
xptr = (xdr_bytesrec *)info;
xptr->xc_is_last_record = rstrm->last_frag;
xptr->xc_num_avail = rstrm->fbtbc;
return (TRUE);
default:
return (FALSE);
}
}
static struct xdr_ops *
xdrrec_ops(void)
{
static struct xdr_ops ops;
extern mutex_t ops_lock;
/* VARIABLES PROTECTED BY ops_lock: ops */
(void) mutex_lock(&ops_lock);
if (ops.x_getlong == NULL) {
ops.x_getlong = xdrrec_getlong;
ops.x_putlong = xdrrec_putlong;
ops.x_getbytes = xdrrec_getbytes;
ops.x_putbytes = xdrrec_putbytes;
ops.x_getpostn = xdrrec_getpos;
ops.x_setpostn = xdrrec_setpos;
ops.x_inline = xdrrec_inline;
ops.x_destroy = xdrrec_destroy;
ops.x_control = xdrrec_control;
#if defined(_LP64)
ops.x_getint32 = xdrrec_getint32;
ops.x_putint32 = xdrrec_putint32;
#endif
}
(void) mutex_unlock(&ops_lock);
return (&ops);
}
|