rpc.subproj/pmap_prot2.c

   1 /*
   2  * Copyright (c) 1999-2018 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Portions Copyright (c) 1999 Apple Computer, Inc.  All Rights
   7  * Reserved.  This file contains Original Code and/or Modifications of
   8  * Original Code as defined in and that are subject to the Apple Public
   9  * Source License Version 1.1 (the "License").  You may not use this file
  10  * except in compliance with the License.  Please obtain a copy of the
  11  * License at http://www.apple.com/publicsource and read it before using
  12  * this file.
  13  *
  14  * The Original Code and all software distributed under the License are
  15  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  16  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  17  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT.  Please see the
  19  * License for the specific language governing rights and limitations
  20  * under the License.
  21  *
  22  * @APPLE_LICENSE_HEADER_END@
  23  */
  24 /*
  25  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
  26  * unrestricted use provided that this legend is included on all tape
  27  * media and as a part of the software program in whole or part.  Users
  28  * may copy or modify Sun RPC without charge, but are not authorized
  29  * to license or distribute it to anyone else except as part of a product or
  30  * program developed by the user.
  31  *
  32  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  33  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  34  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  35  *
  36  * Sun RPC is provided with no support and without any obligation on the
  37  * part of Sun Microsystems, Inc. to assist in its use, correction,
  38  * modification or enhancement.
  39  *
  40  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  41  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  42  * OR ANY PART THEREOF.
  43  *
  44  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  45  * or profits or other special, indirect and consequential damages, even if
  46  * Sun has been advised of the possibility of such damages.
  47  *
  48  * Sun Microsystems, Inc.
  49  * 2550 Garcia Avenue
  50  * Mountain View, California  94043
  51  */
  52
  53 #if defined(LIBC_SCCS) && !defined(lint)
  54 /*static char *sccsid = "from: @(#)pmap_prot2.c 1.3 87/08/11 Copyr 1984 Sun Micro";*/
  55 /*static char *sccsid = "from: @(#)pmap_prot2.c 2.1 88/07/29 4.0 RPCSRC";*/
  56 static char *rcsid = "$Id: pmap_prot2.c,v 1.3 2002/02/19 20:36:24 epeyton Exp $";
  57 #endif
  58
  59 /*
  60  * pmap_prot2.c
  61  * Protocol for the local binder service, or pmap.
  62  *
  63  * Copyright (C) 1984, Sun Microsystems, Inc.
  64  */
  65
  66 #include "libinfo_common.h"
  67
  68 #include <rpc/types.h>
  69 #include <rpc/xdr.h>
  70 #include <rpc/pmap_prot.h>
  71
  72
  73 /*
  74  * What is going on with linked lists? (!)
  75  * First recall the link list declaration from pmap_prot.h:
  76  *
  77  * struct pmaplist {
  78  *      struct pmap pml_map;
  79  *      struct pmaplist *pml_map;
  80  * };
  81  *
  82  * Compare that declaration with a corresponding xdr declaration that
  83  * is (a) pointer-less, and (b) recursive:
  84  *
  85  * typedef union switch (bool_t) {
  86  *
  87  *      case TRUE: struct {
  88  *              struct pmap;
  89  *              pmaplist_t foo;
  90  *      };
  91  *
  92  *      case FALSE: struct {};
  93  * } pmaplist_t;
  94  *
  95  * Notice that the xdr declaration has no nxt pointer while
  96  * the C declaration has no bool_t variable.  The bool_t can be
  97  * interpreted as ``more data follows me''; if FALSE then nothing
  98  * follows this bool_t; if TRUE then the bool_t is followed by
  99  * an actual struct pmap, and then (recursively) by the
 100  * xdr union, pamplist_t.
 101  *
 102  * This could be implemented via the xdr_union primitive, though this
 103  * would cause a one recursive call per element in the list.  Rather than do
 104  * that we can ``unwind'' the recursion
 105  * into a while loop and do the union arms in-place.
 106  *
 107  * The head of the list is what the C programmer wishes to past around
 108  * the net, yet is the data that the pointer points to which is interesting;
 109  * this sounds like a job for xdr_reference!
 110  */
 111 LIBINFO_EXPORT
 112 bool_t
 113 xdr_pmaplist(xdrs, rp)
 114         register XDR *xdrs;
 115         register struct pmaplist **rp;
 116 {
 117         /*
 118          * more_elements is pre-computed in case the direction is
 119          * XDR_ENCODE or XDR_FREE.  more_elements is overwritten by
 120          * xdr_bool when the direction is XDR_DECODE.
 121          */
 122         bool_t more_elements;
 123         register int freeing = (xdrs->x_op == XDR_FREE);
 124         register struct pmaplist **next = NULL;
 125
 126         while (TRUE) {
 127                 more_elements = (bool_t)(!(rp == NULL || *rp == NULL));
 128                 if (! xdr_bool(xdrs, &more_elements))
 129                         return (FALSE);
 130                 if (! more_elements)
 131                         return (TRUE);  /* we are done */
 132                 /*
 133                  * the unfortunate side effect of non-recursion is that in
 134                  * the case of freeing we must remember the next object
 135                  * before we free the current object ...
 136                  */
 137                 if (freeing)
 138                         next = &((*rp)->pml_next);
 139                 if (! xdr_reference(xdrs, (caddr_t *)rp, (u_int)sizeof(struct pmaplist), (xdrproc_t)xdr_pmap))
 140                         return (FALSE);
 141                 rp = (freeing) ? next : &((*rp)->pml_next);
 142         }
 143 }