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: @(#)rpc_msg.h 1.7 86/07/16 SMI
30  *        from: @(#)rpc_msg.h 2.1 88/07/29 4.0 RPCSRC
31  * $FreeBSD: src/include/rpc/rpc_msg.h,v 1.11.2.1 1999/08/29 14:39:07 peter Exp $
32  */
33 
34 /*
35  * rpc_msg.h
36  * rpc message definition
37  *
38  * Copyright (C) 1984, Sun Microsystems, Inc.
39  */
40 
41 #define SUNRPC_MSG_VERSION    ((uint32_t) 2)
42 
43 /*
44  * Bottom up definition of an rpc message.
45  * NOTE: call and reply use the same overall struct but
46  * different parts of unions within it.
47  */
48 
49 enum sunrpc_msg_type {
50           SUNRPC_CALL=0,
51           SUNRPC_REPLY=1
52 };
53 
54 enum sunrpc_reply_stat {
55           SUNRPC_MSG_ACCEPTED=0,
56           SUNRPC_MSG_DENIED=1
57 };
58 
59 enum sunrpc_accept_stat {
60           SUNRPC_SUCCESS=0,
61           SUNRPC_PROG_UNAVAIL=1,
62           SUNRPC_PROG_MISMATCH=2,
63           SUNRPC_PROC_UNAVAIL=3,
64           SUNRPC_GARBAGE_ARGS=4,
65           SUNRPC_SYSTEM_ERR=5
66 };
67 
68 enum sunrpc_reject_stat {
69           SUNRPC_RPC_MISMATCH=0,
70           SUNRPC_AUTH_ERROR=1
71 };
72 
73 /*
74  * Reply part of an rpc exchange
75  */
76 
77 /*
78  * Reply to an rpc request that was rejected by the server.
79  */
80 struct sunrpc_rejected_reply {
81           nd_uint32_t                    rj_stat; /* enum reject_stat */
82           union {
83                     struct {
84                               nd_uint32_t low;
85                               nd_uint32_t high;
86                     } RJ_versions;
87                     nd_uint32_t RJ_why;  /* enum auth_stat - why authentication did not work */
88           } ru;
89 #define   rj_vers   ru.RJ_versions
90 #define   rj_why    ru.RJ_why
91 };
92 
93 /*
94  * Body of a reply to an rpc request.
95  */
96 struct sunrpc_reply_body {
97           nd_uint32_t         rp_stat;            /* enum reply_stat */
98           struct sunrpc_rejected_reply rp_reject; /* if rejected */
99 };
100 
101 /*
102  * Body of an rpc request call.
103  */
104 struct sunrpc_call_body {
105           nd_uint32_t cb_rpcvers;       /* must be equal to two */
106           nd_uint32_t cb_prog;
107           nd_uint32_t cb_vers;
108           nd_uint32_t cb_proc;
109           struct sunrpc_opaque_auth cb_cred;
110           /* followed by opaque verifier */
111 };
112 
113 /*
114  * The rpc message
115  */
116 struct sunrpc_msg {
117           nd_uint32_t                   rm_xid;
118           nd_uint32_t                   rm_direction;       /* enum msg_type */
119           union {
120                     struct sunrpc_call_body RM_cmb;
121                     struct sunrpc_reply_body RM_rmb;
122           } ru;
123 #define   rm_call             ru.RM_cmb
124 #define   rm_reply  ru.RM_rmb
125 };
126 #define   acpted_rply         ru.RM_rmb.ru.RP_ar
127 #define   rjcted_rply         ru.RM_rmb.ru.RP_dr
128