include/rpc/pmap_prot.h

   1 /*
   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.
   8  *
   9  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  10  * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  11  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  12  *
  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.
  16  *
  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.
  20  *
  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.
  24  *
  25  * Sun Microsystems, Inc.
  26  * 2550 Garcia Avenue
  27  * Mountain View, California  94043
  28  *
  29  *      from: @(#)pmap_prot.h 1.14 88/02/08 SMI
  30  *      from: @(#)pmap_prot.h   2.1 88/07/29 4.0 RPCSRC
  31  * $NetBSD: pmap_prot.h,v 1.8 2000/06/02 22:57:55 fvdl Exp $
  32  * $FreeBSD: src/include/rpc/pmap_prot.h,v 1.12 2002/03/23 17:24:55 imp Exp $
  33  * $DragonFly: src/include/rpc/pmap_prot.h,v 1.3 2003/11/14 01:01:50 dillon Exp $
  34  */
  35
  36 /*
  37  * pmap_prot.h
  38  * Protocol for the local binder service, or pmap.
  39  *
  40  * Copyright (C) 1984, Sun Microsystems, Inc.
  41  *
  42  * The following procedures are supported by the protocol:
  43  *
  44  * PMAPPROC_NULL() returns ()
  45  *      takes nothing, returns nothing
  46  *
  47  * PMAPPROC_SET(struct pmap) returns (bool_t)
  48  *      TRUE is success, FALSE is failure.  Registers the tuple
  49  *      [prog, vers, prot, port].
  50  *
  51  * PMAPPROC_UNSET(struct pmap) returns (bool_t)
  52  *      TRUE is success, FALSE is failure.  Un-registers pair
  53  *      [prog, vers].  prot and port are ignored.
  54  *
  55  * PMAPPROC_GETPORT(struct pmap) returns (long unsigned).
  56  *      0 is failure.  Otherwise returns the port number where the pair
  57  *      [prog, vers] is registered.  It may lie!
  58  *
  59  * PMAPPROC_DUMP() RETURNS (struct pmaplist *)
  60  *
  61  * PMAPPROC_CALLIT(unsigned, unsigned, unsigned, string<>)
  62  *      RETURNS (port, string<>);
  63  * usage: encapsulatedresults = PMAPPROC_CALLIT(prog, vers, proc, encapsulatedargs);
  64  *      Calls the procedure on the local machine.  If it is not registered,
  65  *      this procedure is quite; ie it does not return error information!!!
  66  *      This procedure only is supported on rpc/udp and calls via
  67  *      rpc/udp.  This routine only passes null authentication parameters.
  68  *      This file has no interface to xdr routines for PMAPPROC_CALLIT.
  69  *
  70  * The service supports remote procedure calls on udp/ip or tcp/ip socket 111.
  71  */
  72
  73 #ifndef _RPC_PMAP_PROT_H_
  74 #define _RPC_PMAP_PROT_H_
  75 #include <sys/cdefs.h>
  76
  77 #define PMAPPORT                ((u_short)111)
  78 #define PMAPPROG                ((u_long)100000)
  79 #define PMAPVERS                ((u_long)2)
  80 #define PMAPVERS_PROTO          ((u_long)2)
  81 #define PMAPVERS_ORIG           ((u_long)1)
  82 #define PMAPPROC_NULL           ((u_long)0)
  83 #define PMAPPROC_SET            ((u_long)1)
  84 #define PMAPPROC_UNSET          ((u_long)2)
  85 #define PMAPPROC_GETPORT        ((u_long)3)
  86 #define PMAPPROC_DUMP           ((u_long)4)
  87 #define PMAPPROC_CALLIT         ((u_long)5)
  88
  89 struct pmap {
  90         long unsigned pm_prog;
  91         long unsigned pm_vers;
  92         long unsigned pm_prot;
  93         long unsigned pm_port;
  94 };
  95
  96 struct pmaplist {
  97         struct pmap     pml_map;
  98         struct pmaplist *pml_next;
  99 };
 100
 101 __BEGIN_DECLS
 102 extern bool_t   xdr_pmap(XDR *, struct pmap *);
 103 extern bool_t   xdr_pmaplist(XDR *, struct pmaplist **);
 104 extern bool_t   xdr_pmaplist_ptr(XDR *, struct pmaplist *);
 105 __END_DECLS
 106
 107 #endif /* !_RPC_PMAP_PROT_H_ */