source: rtems-libbsd/freebsd/include/rpc/rpc_msg.h @ 7eeb079

4.115-freebsd-12freebsd-9.3
Last change on this file since 7eeb079 was 7eeb079, checked in by Sebastian Huber <sebastian.huber@…>, on Feb 2, 2015 at 1:27:13 PM

Update to FreeBSD 9.3

  • Property mode set to 100644
File size: 5.1 KB
Line 
1/*      $NetBSD: rpc_msg.h,v 1.11 2000/06/02 22:57:56 fvdl Exp $        */
2
3/*-
4 * Copyright (c) 2009, Sun Microsystems, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * - Redistributions of source code must retain the above copyright notice,
10 *   this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright notice,
12 *   this list of conditions and the following disclaimer in the documentation
13 *   and/or other materials provided with the distribution.
14 * - Neither the name of Sun Microsystems, Inc. nor the names of its
15 *   contributors may be used to endorse or promote products derived
16 *   from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 *
30 *      from: @(#)rpc_msg.h 1.7 86/07/16 SMI
31 *      from: @(#)rpc_msg.h     2.1 88/07/29 4.0 RPCSRC
32 * $FreeBSD$
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
54enum msg_type {
55        CALL=0,
56        REPLY=1
57};
58
59enum reply_stat {
60        MSG_ACCEPTED=0,
61        MSG_DENIED=1
62};
63
64enum 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
73enum 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 */
87struct 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 */
108struct 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 */
124struct 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 */
137struct 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 */
149struct 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 */
169extern 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 */
177extern 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 */
185extern bool_t   xdr_replymsg(XDR *, struct rpc_msg *);
186
187
188/*
189 * XDR routine to handle an accepted rpc reply.
190 * xdr_accepted_reply(xdrs, rej)
191 *      XDR *xdrs;
192 *      struct accepted_reply *rej;
193 */
194extern bool_t   xdr_accepted_reply(XDR *, struct accepted_reply *);
195
196/*
197 * XDR routine to handle a rejected rpc reply.
198 * xdr_rejected_reply(xdrs, rej)
199 *      XDR *xdrs;
200 *      struct rejected_reply *rej;
201 */
202extern bool_t   xdr_rejected_reply(XDR *, struct rejected_reply *);
203
204/*
205 * Fills in the error part of a reply message.
206 * _seterr_reply(msg, error)
207 *      struct rpc_msg *msg;
208 *      struct rpc_err *error;
209 */
210extern void     _seterr_reply(struct rpc_msg *, struct rpc_err *);
211__END_DECLS
212
213#endif /* !_RPC_RPC_MSG_H */
Note: See TracBrowser for help on using the repository browser.