usr/src/uts/common/rpc/pmap_prot.x

   1 /*
   2  * CDDL HEADER START
   3  *
   4  * The contents of this file are subject to the terms of the
   5  * Common Development and Distribution License, Version 1.0 only
   6  * (the "License").  You may not use this file except in compliance
   7  * with the License.
   8  *
   9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  10  * or http://www.opensolaris.org/os/licensing.
  11  * See the License for the specific language governing permissions
  12  * and limitations under the License.
  13  *
  14  * When distributing Covered Code, include this CDDL HEADER in each
  15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  16  * If applicable, add the following below this CDDL HEADER, with the
  17  * fields enclosed by brackets "[]" replaced with your own identifying
  18  * information: Portions Copyright [yyyy] [name of copyright owner]
  19  *
  20  * CDDL HEADER END
  21  */
  22 %/*
  23 % * Copyright (c) 1984,1989 by Sun Microsystems, Inc.
  24 % */
  25
  26 %/* from pmap_prot.x */
  27
  28 #ifdef RPC_HDR
  29 %
  30 %#pragma ident  "%Z%%M% %I%     %E% SMI"
  31 %
  32 %#ifndef _KERNEL
  33 %
  34 #endif
  35
  36 /*
  37  * Port Mapper Protocol Specification (in RPC Language)
  38  * derived from RFC 1057
  39  */
  40
  41 %/*
  42 % * Protocol for the local binder service, or pmap.
  43 % *
  44 % * Copyright (C) 1984, Sun Microsystems, Inc.
  45 % *
  46 % * The following procedures are supported by the protocol:
  47 % *
  48 % * PMAPPROC_NULL() returns ()
  49 % *     takes nothing, returns nothing
  50 % *
  51 % * PMAPPROC_SET(struct pmap) returns (bool_t)
  52 % *     TRUE is success, FALSE is failure.  Registers the tuple
  53 % *     [prog, vers, prot, port].
  54 % *
  55 % * PMAPPROC_UNSET(struct pmap) returns (bool_t)
  56 % *     TRUE is success, FALSE is failure.  Un-registers pair
  57 % *     [prog, vers].  prot and port are ignored.
  58 % *
  59 % * PMAPPROC_GETPORT(struct pmap) returns (rpcport_t).
  60 % *     0 is failure.  Otherwise returns the port number where the pair
  61 % *     [prog, vers] is registered.  It may lie!
  62 % *
  63 % * PMAPPROC_DUMP() RETURNS (struct pmaplist_ptr)
  64 % *
  65 % * PMAPPROC_CALLIT(unsigned, unsigned, unsigned, string<>)
  66 % *     RETURNS (port, string<>);
  67 % * usage: encapsulatedresults = PMAPPROC_CALLIT(prog, vers, proc,
  68 % *                                             encapsulatedargs);
  69 % *     Calls the procedure on the local machine.  If it is not registered,
  70 % *     this procedure is quite; ie it does not return error information!!!
  71 % *     This procedure only is supported on rpc/udp and calls via
  72 % *     rpc/udp.  This routine only passes null authentication parameters.
  73 % *     This file has no interface to xdr routines for PMAPPROC_CALLIT.
  74 % *
  75 % * The service supports remote procedure calls on udp/ip or tcp/ip socket 111.
  76 % */
  77 %
  78 const PMAPPORT = 111;   /* portmapper port number */
  79 %
  80 %
  81 %/*
  82 % * A mapping of (program, version, protocol) to port number
  83 % */
  84
  85 struct pmap {
  86         rpcprog_t pm_prog;
  87         rpcvers_t pm_vers;
  88         rpcprot_t pm_prot;
  89         rpcport_t pm_port;
  90 };
  91 #ifdef RPC_HDR
  92 %
  93 %typedef pmap PMAP;
  94 %
  95 #endif
  96 %
  97 %/*
  98 % * Supported values for the "prot" field
  99 % */
 100 %
 101 const PMAP_IPPROTO_TCP = 6;     /* protocol number for TCP/IP */
 102 const PMAP_IPPROTO_UDP = 17;    /* protocol number for UDP/IP */
 103 %
 104 %
 105 %/*
 106 % * A list of mappings
 107 % *
 108 % * Below are two definitions for the pmaplist structure.  This is done because
 109 % * xdr_pmaplist() is specified to take a struct pmaplist **, rather than a
 110 % * struct pmaplist * that rpcgen would produce.  One version of the pmaplist
 111 % * structure (actually called pm__list) is used with rpcgen, and the other is
 112 % * defined only in the header file for compatibility with the specified
 113 % * interface.
 114 % */
 115
 116 struct pm__list {
 117         pmap pml_map;
 118         struct pm__list *pml_next;
 119 };
 120
 121 typedef pm__list *pmaplist_ptr;         /* results of PMAPPROC_DUMP */
 122
 123 #ifdef RPC_HDR
 124 %
 125 %struct pmaplist {
 126 %       PMAP pml_map;
 127 %       struct pmaplist *pml_next;
 128 %};
 129 %
 130 %typedef struct pmaplist pmaplist;
 131 %typedef struct pmaplist PMAPLIST;
 132 %
 133 %#ifdef __cplusplus
 134 %extern "C" {
 135 %#endif
 136 %extern  bool_t xdr_pmaplist(XDR *, pmaplist**);
 137 %#ifdef __cplusplus
 138 %}
 139 %#endif
 140 %
 141 #endif
 142
 143 %
 144 %/*
 145 % * Arguments to callit
 146 % */
 147
 148 struct rmtcallargs {
 149         rpcprog_t prog;
 150         rpcvers_t vers;
 151         rpcproc_t proc;
 152         opaque args<>;
 153 };
 154 #ifdef RPC_HDR
 155 %
 156 %/*
 157 % * Client-side only representation of rmtcallargs structure.
 158 % *
 159 % * The routine that XDRs the rmtcallargs structure must deal with the
 160 % * opaque arguments in the "args" structure.  xdr_rmtcall_args() needs to be
 161 % * passed the XDR routine that knows the args' structure.  This routine
 162 % * doesn't need to go over-the-wire (and it wouldn't make sense anyway) since
 163 % * the application being called knows the args structure already.  So we use a
 164 % * different "XDR" structure on the client side, p_rmtcallargs, which includes
 165 % * the args' XDR routine.
 166 % */
 167 %struct p_rmtcallargs {
 168 %       rpcprog_t prog;
 169 %       rpcvers_t vers;
 170 %       rpcproc_t proc;
 171 %       struct {
 172 %               u_int args_len;
 173 %               char *args_val;
 174 %       } args;
 175 %       xdrproc_t       xdr_args;       /* encodes args */
 176 %};
 177 %
 178 #endif  /* def RPC_HDR */
 179 %
 180 %
 181 %/*
 182 % * Results of callit
 183 % */
 184
 185 struct rmtcallres {
 186         rpcport_t port;
 187         opaque res<>;
 188 };
 189 #ifdef RPC_HDR
 190 %
 191 %/*
 192 % * Client-side only representation of rmtcallres structure.
 193 % */
 194 %struct p_rmtcallres {
 195 %       rpcport_t port;
 196 %       struct {
 197 %               u_int res_len;
 198 %               char *res_val;
 199 %       } res;
 200 %       xdrproc_t       xdr_res;        /* decodes res */
 201 %};
 202 %
 203 #endif  /* def RPC_HDR */
 204
 205 /*
 206  * Port mapper procedures
 207  */
 208
 209 program PMAPPROG {
 210    version PMAPVERS {
 211         void
 212         PMAPPROC_NULL(void)     = 0;
 213
 214         bool
 215         PMAPPROC_SET(pmap)      = 1;
 216
 217         bool
 218         PMAPPROC_UNSET(pmap)    = 2;
 219
 220         rpcport_t
 221         PMAPPROC_GETPORT(pmap)  = 3;
 222
 223         pmaplist_ptr
 224         PMAPPROC_DUMP(void)     = 4;
 225
 226         rmtcallres
 227         PMAPPROC_CALLIT(rmtcallargs)  = 5;
 228    } = 2;
 229 } = 100000;
 230 %
 231 #ifdef RPC_HDR
 232 %#define        PMAPVERS_PROTO          ((rpcvers_t)2)
 233 %#define        PMAPVERS_ORIG           ((rpcvers_t)1)
 234 %
 235 %#else          /* ndef _KERNEL */
 236 %
 237 %#include <rpc/pmap_rmt.h>
 238 %
 239 %#ifdef __cplusplus
 240 %extern "C" {
 241 %#endif
 242 %
 243 %#define        PMAPPORT 111
 244 %
 245 %struct pmap {
 246 %       rpcprog_t pm_prog;
 247 %       rpcvers_t pm_vers;
 248 %       rpcprot_t pm_prot;
 249 %       rpcport_t pm_port;
 250 %};
 251 %typedef struct pmap PMAP;
 252 %extern bool_t xdr_pmap (XDR *, struct pmap *);
 253 %
 254 %struct pmaplist {
 255 %       struct pmap pml_map;
 256 %       struct pmaplist *pml_next;
 257 %};
 258 %typedef struct pmaplist PMAPLIST;
 259 %typedef struct pmaplist *pmaplist_ptr;
 260 %
 261 %
 262 %#ifdef __cplusplus
 263 %}
 264 %#endif
 265 %
 266 %#endif         /* ndef _KERNEL */
 267 #endif
 268