Check-in of original version of ONCRPC library (and headers) from
[shibboleth/sp.git] / oncrpc / pmap_pro.c
1 /*********************************************************************
2  * RPC for the Windows NT Operating System
3  * 1993 by Martin F. Gergeleit
4  * Users may use, copy or modify Sun RPC for the Windows NT Operating 
5  * System according to the Sun copyright below.
6  *
7  * RPC for the Windows NT Operating System COMES WITH ABSOLUTELY NO 
8  * WARRANTY, NOR WILL I BE LIABLE FOR ANY DAMAGES INCURRED FROM THE 
9  * USE OF. USE ENTIRELY AT YOUR OWN RISK!!!
10  *********************************************************************/
11
12 /* @(#)pmap_prot2.c     2.1 88/07/29 4.0 RPCSRC */
13 /*
14  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
15  * unrestricted use provided that this legend is included on all tape
16  * media and as a part of the software program in whole or part.  Users
17  * may copy or modify Sun RPC without charge, but are not authorized
18  * to license or distribute it to anyone else except as part of a product or
19  * program developed by the user.
20  * 
21  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
22  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
24  * 
25  * Sun RPC is provided with no support and without any obligation on the
26  * part of Sun Microsystems, Inc. to assist in its use, correction,
27  * modification or enhancement.
28  * 
29  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
30  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
31  * OR ANY PART THEREOF.
32  * 
33  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
34  * or profits or other special, indirect and consequential damages, even if
35  * Sun has been advised of the possibility of such damages.
36  * 
37  * Sun Microsystems, Inc.
38  * 2550 Garcia Avenue
39  * Mountain View, California  94043
40  */
41 #if !defined(lint) && defined(SCCSIDS)
42 static char sccsid[] = "@(#)pmap_prot2.c 1.3 87/08/11 Copyr 1984 Sun Micro";
43 #endif
44
45 /*
46  * pmap_prot2.c
47  * Protocol for the local binder service, or pmap.
48  *
49  * Copyright (C) 1984, Sun Microsystems, Inc.
50  */
51
52 #include <rpc/types.h>
53 #include <rpc/xdr.h>
54 #ifdef WIN32
55 #include <rpc/pmap_pro.h>
56 #else
57 #include <rpc/pmap_prot.h>
58 #endif
59
60 /* 
61  * What is going on with linked lists? (!)
62  * First recall the link list declaration from pmap_prot.h:
63  *
64  * struct pmaplist {
65  *      struct pmap pml_map;
66  *      struct pmaplist *pml_map;
67  * };
68  *
69  * Compare that declaration with a corresponding xdr declaration that 
70  * is (a) pointer-less, and (b) recursive:
71  *
72  * typedef union switch (bool_t) {
73  * 
74  *      case TRUE: struct {
75  *              struct pmap;
76  *              pmaplist_t foo;
77  *      };
78  *
79  *      case FALSE: struct {};
80  * } pmaplist_t;
81  *
82  * Notice that the xdr declaration has no nxt pointer while
83  * the C declaration has no bool_t variable.  The bool_t can be
84  * interpreted as ``more data follows me''; if FALSE then nothing
85  * follows this bool_t; if TRUE then the bool_t is followed by
86  * an actual struct pmap, and then (recursively) by the 
87  * xdr union, pamplist_t.  
88  *
89  * This could be implemented via the xdr_union primitive, though this
90  * would cause a one recursive call per element in the list.  Rather than do
91  * that we can ``unwind'' the recursion
92  * into a while loop and do the union arms in-place.
93  *
94  * The head of the list is what the C programmer wishes to past around
95  * the net, yet is the data that the pointer points to which is interesting;
96  * this sounds like a job for xdr_reference!
97  */
98 bool_t
99 xdr_pmaplist(xdrs, rp)
100         register XDR *xdrs;
101         register struct pmaplist **rp;
102 {
103         /*
104          * more_elements is pre-computed in case the direction is
105          * XDR_ENCODE or XDR_FREE.  more_elements is overwritten by
106          * xdr_bool when the direction is XDR_DECODE.
107          */
108         bool_t more_elements;
109         register int freeing = (xdrs->x_op == XDR_FREE);
110         register struct pmaplist **next;
111
112         while (TRUE) {
113                 more_elements = (bool_t)(*rp != NULL);
114                 if (! xdr_bool(xdrs, &more_elements))
115                         return (FALSE);
116                 if (! more_elements)
117                         return (TRUE);  /* we are done */
118                 /*
119                  * the unfortunate side effect of non-recursion is that in
120                  * the case of freeing we must remember the next object
121                  * before we free the current object ...
122                  */
123                 if (freeing)
124                         next = &((*rp)->pml_next); 
125                 if (! xdr_reference(xdrs, (caddr_t *)rp,
126                     (u_int)sizeof(struct pmaplist), xdr_pmap))
127                         return (FALSE);
128                 rp = (freeing) ? next : &((*rp)->pml_next);
129         }
130 }