sunrpc/rpc/rpc_msg.h

   1 /* @(#)rpc_msg.h        2.1 88/07/29 4.0 RPCSRC */
   2 /*
   3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
   4  * unrestricted use provided that this legend is included on all tape
   5  * media and as a part of the software program in whole or part.  Users
   6  * may copy or modify Sun RPC without charge, but are not authorized
   7  * to license or distribute it to anyone else except as part of a product or
   8  * program developed by the user.
   9  *
  10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
  11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
  12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
  13  *
  14  * Sun RPC is provided with no support and without any obligation on the
  15  * part of Sun Microsystems, Inc. to assist in its use, correction,
  16  * modification or enhancement.
  17  *
  18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
  19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
  20  * OR ANY PART THEREOF.
  21  *
  22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
  23  * or profits or other special, indirect and consequential damages, even if
  24  * Sun has been advised of the possibility of such damages.
  25  *
  26  * Sun Microsystems, Inc.
  27  * 2550 Garcia Avenue
  28  * Mountain View, California  94043
  29  */
  30 /*      @(#)rpc_msg.h 1.7 86/07/16 SMI      */
  31
  32 /*
  33  * rpc_msg.h
  34  * rpc message definition
  35  *
  36  * Copyright (C) 1984, Sun Microsystems, Inc.
  37  */
  38
  39 #define RPC_MSG_VERSION         ((u_long) 2)
  40 #define RPC_SERVICE_PORT        ((u_short) 2048)
  41
  42 __BEGIN_DECLS
  43
  44 /*
  45  * Bottom up definition of an rpc message.
  46  * NOTE: call and reply use the same overall struct but
  47  * different parts of unions within it.
  48  */
  49
  50 enum msg_type {
  51         CALL=0,
  52         REPLY=1
  53 };
  54
  55 enum reply_stat {
  56         MSG_ACCEPTED=0,
  57         MSG_DENIED=1
  58 };
  59
  60 enum accept_stat {
  61         SUCCESS=0,
  62         PROG_UNAVAIL=1,
  63         PROG_MISMATCH=2,
  64         PROC_UNAVAIL=3,
  65         GARBAGE_ARGS=4,
  66         SYSTEM_ERR=5
  67 };
  68
  69 enum reject_stat {
  70         RPC_MISMATCH=0,
  71         AUTH_ERROR=1
  72 };
  73
  74 /*
  75  * Reply part of an rpc exchange
  76  */
  77
  78 /*
  79  * Reply to an rpc request that was accepted by the server.
  80  * Note: there could be an error even though the request was
  81  * accepted.
  82  */
  83 struct accepted_reply {
  84         struct opaque_auth      ar_verf;
  85         enum accept_stat        ar_stat;
  86         union {
  87                 struct {
  88                         u_long  low;
  89                         u_long  high;
  90                 } AR_versions;
  91                 struct {
  92                         caddr_t where;
  93                         xdrproc_t proc;
  94                 } AR_results;
  95                 /* and many other null cases */
  96         } ru;
  97 #define ar_results      ru.AR_results
  98 #define ar_vers         ru.AR_versions
  99 };
 100
 101 /*
 102  * Reply to an rpc request that was rejected by the server.
 103  */
 104 struct rejected_reply {
 105         enum reject_stat rj_stat;
 106         union {
 107                 struct {
 108                         u_long low;
 109                         u_long high;
 110                 } RJ_versions;
 111                 enum auth_stat RJ_why;  /* why authentication did not work */
 112         } ru;
 113 #define rj_vers ru.RJ_versions
 114 #define rj_why  ru.RJ_why
 115 };
 116
 117 /*
 118  * Body of a reply to an rpc request.
 119  */
 120 struct reply_body {
 121         enum reply_stat rp_stat;
 122         union {
 123                 struct accepted_reply RP_ar;
 124                 struct rejected_reply RP_dr;
 125         } ru;
 126 #define rp_acpt ru.RP_ar
 127 #define rp_rjct ru.RP_dr
 128 };
 129
 130 /*
 131  * Body of an rpc request call.
 132  */
 133 struct call_body {
 134         u_long cb_rpcvers;      /* must be equal to two */
 135         u_long cb_prog;
 136         u_long cb_vers;
 137         u_long cb_proc;
 138         struct opaque_auth cb_cred;
 139         struct opaque_auth cb_verf; /* protocol specific - provided by client */
 140 };
 141
 142 /*
 143  * The rpc message
 144  */
 145 struct rpc_msg {
 146         u_long                  rm_xid;
 147         enum msg_type           rm_direction;
 148         union {
 149                 struct call_body RM_cmb;
 150                 struct reply_body RM_rmb;
 151         } ru;
 152 #define rm_call         ru.RM_cmb
 153 #define rm_reply        ru.RM_rmb
 154 };
 155 #define acpted_rply     ru.RM_rmb.ru.RP_ar
 156 #define rjcted_rply     ru.RM_rmb.ru.RP_dr
 157
 158
 159 /*
 160  * XDR routine to handle a rpc message.
 161  * xdr_callmsg(xdrs, cmsg)
 162  *      XDR *xdrs;
 163  *      struct rpc_msg *cmsg;
 164  */
 165 extern bool_t   xdr_callmsg __P ((XDR *__xdrs, struct rpc_msg *__cmsg));
 166
 167 /*
 168  * XDR routine to pre-serialize the static part of a rpc message.
 169  * xdr_callhdr(xdrs, cmsg)
 170  *      XDR *xdrs;
 171  *      struct rpc_msg *cmsg;
 172  */
 173 extern bool_t   xdr_callhdr __P ((XDR *__xdrs, struct rpc_msg *__cmsg));
 174
 175 /*
 176  * XDR routine to handle a rpc reply.
 177  * xdr_replymsg(xdrs, rmsg)
 178  *      XDR *xdrs;
 179  *      struct rpc_msg *rmsg;
 180  */
 181 extern bool_t   xdr_replymsg __P ((XDR *__xdrs, struct rpc_msg *__rmsg));
 182
 183 /*
 184  * Fills in the error part of a reply message.
 185  * _seterr_reply(msg, error)
 186  *      struct rpc_msg *msg;
 187  *      struct rpc_err *error;
 188  */
 189 extern void     _seterr_reply __P ((struct rpc_msg *__msg,
 190                                     struct rpc_err *__error));
 191
 192 __END_DECLS
 193
 194 #endif /* rpc/rpc_msg.h */