1 /* @(#)rpc_prot.c 2.3 88/08/07 4.0 RPCSRC */
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.
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.
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.
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.
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.
26 * Sun Microsystems, Inc.
28 * Mountain View, California 94043
30 #if !defined(lint) && defined(SCCSIDS)
31 static char sccsid[] = "@(#)rpc_prot.c 1.36 87/08/11 Copyr 1984 Sun Micro";
37 * Copyright (C) 1984, Sun Microsystems, Inc.
39 * This set of routines implements the rpc message definition,
40 * its serializer and some common rpc utility routines.
41 * The routines are meant for various implementations of rpc -
42 * they are NOT for the rpc client or rpc service implementations!
43 * Because authentication stuff is easy and is part of rpc, the opaque
44 * routines are also in this program.
47 #include <sys/param.h>
51 /* * * * * * * * * * * * * * XDR Authentication * * * * * * * * * * * */
54 * XDR an opaque authentication struct
58 xdr_opaque_auth (XDR *xdrs, struct opaque_auth *ap)
61 if (xdr_enum (xdrs, &(ap->oa_flavor)))
62 return xdr_bytes (xdrs, &ap->oa_base,
63 &ap->oa_length, MAX_AUTH_BYTES);
71 xdr_des_block (XDR *xdrs, des_block *blkp)
73 return xdr_opaque (xdrs, (caddr_t) blkp, sizeof (des_block));
76 /* * * * * * * * * * * * * * XDR RPC MESSAGE * * * * * * * * * * * * * * * */
79 * XDR the MSG_ACCEPTED part of a reply message union
82 xdr_accepted_reply (XDR *xdrs, struct accepted_reply *ar)
84 /* personalized union, rather than calling xdr_union */
85 if (!xdr_opaque_auth (xdrs, &(ar->ar_verf)))
87 if (!xdr_enum (xdrs, (enum_t *) & (ar->ar_stat)))
92 return ((*(ar->ar_results.proc)) (xdrs, ar->ar_results.where));
94 if (!xdr_u_long (xdrs, &(ar->ar_vers.low)))
96 return (xdr_u_long (xdrs, &(ar->ar_vers.high)));
100 return TRUE; /* TRUE => open ended set of problems */
104 * XDR the MSG_DENIED part of a reply message union
107 xdr_rejected_reply (XDR *xdrs, struct rejected_reply *rr)
109 /* personalized union, rather than calling xdr_union */
110 if (!xdr_enum (xdrs, (enum_t *) & (rr->rj_stat)))
115 if (!xdr_u_long (xdrs, &(rr->rj_vers.low)))
117 return xdr_u_long (xdrs, &(rr->rj_vers.high));
120 return xdr_enum (xdrs, (enum_t *) & (rr->rj_why));
125 static const struct xdr_discrim reply_dscrm[3] =
127 {(int) MSG_ACCEPTED, (xdrproc_t) xdr_accepted_reply},
128 {(int) MSG_DENIED, (xdrproc_t) xdr_rejected_reply},
129 {__dontcare__, NULL_xdrproc_t}};
132 * XDR a reply message
135 xdr_replymsg (xdrs, rmsg)
137 struct rpc_msg *rmsg;
139 if (xdr_u_long (xdrs, &(rmsg->rm_xid)) &&
140 xdr_enum (xdrs, (enum_t *) & (rmsg->rm_direction)) &&
141 (rmsg->rm_direction == REPLY))
142 return xdr_union (xdrs, (enum_t *) & (rmsg->rm_reply.rp_stat),
143 (caddr_t) & (rmsg->rm_reply.ru), reply_dscrm,
150 * Serializes the "static part" of a call message header.
151 * The fields include: rm_xid, rm_direction, rpcvers, prog, and vers.
152 * The rm_xid is not really static, but the user can easily munge on the fly.
155 xdr_callhdr (xdrs, cmsg)
157 struct rpc_msg *cmsg;
160 cmsg->rm_direction = CALL;
161 cmsg->rm_call.cb_rpcvers = RPC_MSG_VERSION;
163 (xdrs->x_op == XDR_ENCODE) &&
164 xdr_u_long (xdrs, &(cmsg->rm_xid)) &&
165 xdr_enum (xdrs, (enum_t *) & (cmsg->rm_direction)) &&
166 xdr_u_long (xdrs, &(cmsg->rm_call.cb_rpcvers)) &&
167 xdr_u_long (xdrs, &(cmsg->rm_call.cb_prog)))
168 return xdr_u_long (xdrs, &(cmsg->rm_call.cb_vers));
172 /* ************************** Client utility routine ************* */
175 accepted (enum accept_stat acpt_stat,
176 struct rpc_err *error)
182 error->re_status = RPC_PROGUNAVAIL;
186 error->re_status = RPC_PROGVERSMISMATCH;
190 error->re_status = RPC_PROCUNAVAIL;
194 error->re_status = RPC_CANTDECODEARGS;
198 error->re_status = RPC_SYSTEMERROR;
202 error->re_status = RPC_SUCCESS;
205 /* something's wrong, but we don't know what ... */
206 error->re_status = RPC_FAILED;
207 error->re_lb.s1 = (long) MSG_ACCEPTED;
208 error->re_lb.s2 = (long) acpt_stat;
212 rejected (enum reject_stat rjct_stat,
213 struct rpc_err *error)
217 case RPC_VERSMISMATCH:
218 error->re_status = RPC_VERSMISMATCH;
221 error->re_status = RPC_AUTHERROR;
224 /* something's wrong, but we don't know what ... */
225 error->re_status = RPC_FAILED;
226 error->re_lb.s1 = (long) MSG_DENIED;
227 error->re_lb.s2 = (long) rjct_stat;
233 * given a reply message, fills in the error
236 _seterr_reply (struct rpc_msg *msg,
237 struct rpc_err *error)
239 /* optimized for normal, SUCCESSful case */
240 switch (msg->rm_reply.rp_stat)
243 if (msg->acpted_rply.ar_stat == SUCCESS)
245 error->re_status = RPC_SUCCESS;
248 accepted (msg->acpted_rply.ar_stat, error);
252 rejected (msg->rjcted_rply.rj_stat, error);
256 error->re_status = RPC_FAILED;
257 error->re_lb.s1 = (long) (msg->rm_reply.rp_stat);
260 switch (error->re_status)
263 case RPC_VERSMISMATCH:
264 error->re_vers.low = msg->rjcted_rply.rj_vers.low;
265 error->re_vers.high = msg->rjcted_rply.rj_vers.high;
269 error->re_why = msg->rjcted_rply.rj_why;
272 case RPC_PROGVERSMISMATCH:
273 error->re_vers.low = msg->acpted_rply.ar_vers.low;
274 error->re_vers.high = msg->acpted_rply.ar_vers.high;