include/rpc/rpc_msg.h

   1 /*-
   2  * Copyright (c) 2009, Sun Microsystems, Inc.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are met:
   7  * - Redistributions of source code must retain the above copyright notice,
   8  *   this list of conditions and the following disclaimer.
   9  * - Redistributions in binary form must reproduce the above copyright notice,
  10  *   this list of conditions and the following disclaimer in the documentation
  11  *   and/or other materials provided with the distribution.
  12  * - Neither the name of Sun Microsystems, Inc. nor the names of its
  13  *   contributors may be used to endorse or promote products derived
  14  *   from this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  20  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26  * POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  *      from: @(#)rpc_msg.h 1.7 86/07/16 SMI
  29  *      from: @(#)rpc_msg.h     2.1 88/07/29 4.0 RPCSRC
  30  * $NetBSD: rpc_msg.h,v 1.11 2000/06/02 22:57:56 fvdl Exp $
  31  * $FreeBSD: src/include/rpc/rpc_msg.h,v 1.15 2003/01/01 18:48:42 schweikh Exp $
  32  * $DragonFly: src/include/rpc/rpc_msg.h,v 1.4 2007/12/04 20:59:15 swildner Exp $
  33  */
  34
  35 /*
  36  * rpc_msg.h
  37  * rpc message definition
  38  *
  39  * Copyright (C) 1984, Sun Microsystems, Inc.
  40  */
  41
  42 #ifndef _RPC_RPC_MSG_H_
  43 #define _RPC_RPC_MSG_H_
  44
  45 #define RPC_MSG_VERSION         ((u_int32_t) 2)
  46 #define RPC_SERVICE_PORT        ((u_short) 2048)
  47
  48 /*
  49  * Bottom up definition of an rpc message.
  50  * NOTE: call and reply use the same overall stuct but
  51  * different parts of unions within it.
  52  */
  53
  54 enum msg_type {
  55         CALL=0,
  56         REPLY=1
  57 };
  58
  59 enum reply_stat {
  60         MSG_ACCEPTED=0,
  61         MSG_DENIED=1
  62 };
  63
  64 enum accept_stat {
  65         SUCCESS=0,
  66         PROG_UNAVAIL=1,
  67         PROG_MISMATCH=2,
  68         PROC_UNAVAIL=3,
  69         GARBAGE_ARGS=4,
  70         SYSTEM_ERR=5
  71 };
  72
  73 enum reject_stat {
  74         RPC_MISMATCH=0,
  75         AUTH_ERROR=1
  76 };
  77
  78 /*
  79  * Reply part of an rpc exchange
  80  */
  81
  82 /*
  83  * Reply to an rpc request that was accepted by the server.
  84  * Note: there could be an error even though the request was
  85  * accepted.
  86  */
  87 struct accepted_reply {
  88         struct opaque_auth      ar_verf;
  89         enum accept_stat        ar_stat;
  90         union {
  91                 struct {
  92                         rpcvers_t low;
  93                         rpcvers_t high;
  94                 } AR_versions;
  95                 struct {
  96                         caddr_t where;
  97                         xdrproc_t proc;
  98                 } AR_results;
  99                 /* and many other null cases */
 100         } ru;
 101 #define ar_results      ru.AR_results
 102 #define ar_vers         ru.AR_versions
 103 };
 104
 105 /*
 106  * Reply to an rpc request that was rejected by the server.
 107  */
 108 struct rejected_reply {
 109         enum reject_stat rj_stat;
 110         union {
 111                 struct {
 112                         rpcvers_t low;
 113                         rpcvers_t high;
 114                 } RJ_versions;
 115                 enum auth_stat RJ_why;  /* why authentication did not work */
 116         } ru;
 117 #define rj_vers ru.RJ_versions
 118 #define rj_why  ru.RJ_why
 119 };
 120
 121 /*
 122  * Body of a reply to an rpc request.
 123  */
 124 struct reply_body {
 125         enum reply_stat rp_stat;
 126         union {
 127                 struct accepted_reply RP_ar;
 128                 struct rejected_reply RP_dr;
 129         } ru;
 130 #define rp_acpt ru.RP_ar
 131 #define rp_rjct ru.RP_dr
 132 };
 133
 134 /*
 135  * Body of an rpc request call.
 136  */
 137 struct call_body {
 138         rpcvers_t cb_rpcvers;   /* must be equal to two */
 139         rpcprog_t cb_prog;
 140         rpcvers_t cb_vers;
 141         rpcproc_t cb_proc;
 142         struct opaque_auth cb_cred;
 143         struct opaque_auth cb_verf; /* protocol specific - provided by client */
 144 };
 145
 146 /*
 147  * The rpc message
 148  */
 149 struct rpc_msg {
 150         u_int32_t               rm_xid;
 151         enum msg_type           rm_direction;
 152         union {
 153                 struct call_body RM_cmb;
 154                 struct reply_body RM_rmb;
 155         } ru;
 156 #define rm_call         ru.RM_cmb
 157 #define rm_reply        ru.RM_rmb
 158 };
 159 #define acpted_rply     ru.RM_rmb.ru.RP_ar
 160 #define rjcted_rply     ru.RM_rmb.ru.RP_dr
 161
 162 __BEGIN_DECLS
 163 /*
 164  * XDR routine to handle a rpc message.
 165  * xdr_callmsg(xdrs, cmsg)
 166  *      XDR *xdrs;
 167  *      struct rpc_msg *cmsg;
 168  */
 169 extern bool_t   xdr_callmsg(XDR *, struct rpc_msg *);
 170
 171 /*
 172  * XDR routine to pre-serialize the static part of a rpc message.
 173  * xdr_callhdr(xdrs, cmsg)
 174  *      XDR *xdrs;
 175  *      struct rpc_msg *cmsg;
 176  */
 177 extern bool_t   xdr_callhdr(XDR *, struct rpc_msg *);
 178
 179 /*
 180  * XDR routine to handle a rpc reply.
 181  * xdr_replymsg(xdrs, rmsg)
 182  *      XDR *xdrs;
 183  *      struct rpc_msg *rmsg;
 184  */
 185 extern bool_t   xdr_replymsg(XDR *, struct rpc_msg *);
 186
 187 /*
 188  * XDR routine to handle an accepted rpc reply.
 189  * xdr_accepted_reply(xdrs, rej)
 190  *      XDR *xdrs;
 191  *      struct accepted_reply *rej;
 192  */
 193 extern bool_t   xdr_accepted_reply(XDR *, struct accepted_reply *);
 194
 195 /*
 196  * XDR routine to handle a rejected rpc reply.
 197  * xdr_rejected_reply(xdrs, rej)
 198  *      XDR *xdrs;
 199  *      struct rejected_reply *rej;
 200  */
 201 extern bool_t   xdr_rejected_reply(XDR *, struct rejected_reply *);
 202
 203 /*
 204  * Fills in the error part of a reply message.
 205  * _seterr_reply(msg, error)
 206  *      struct rpc_msg *msg;
 207  *      struct rpc_err *error;
 208  */
 209 extern void     _seterr_reply(struct rpc_msg *, struct rpc_err *);
 210 __END_DECLS
 211
 212 #endif /* !_RPC_RPC_MSG_H_ */