/* $NetBSD: rpc_msg.h,v 1.11 2000/06/02 22:57:56 fvdl Exp $ */
|
/* $NetBSD: rpc_msg.h,v 1.11 2000/06/02 22:57:56 fvdl Exp $ */
|
|
|
/*
|
/*
|
* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
|
* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
|
* unrestricted use provided that this legend is included on all tape
|
* unrestricted use provided that this legend is included on all tape
|
* media and as a part of the software program in whole or part. Users
|
* media and as a part of the software program in whole or part. Users
|
* may copy or modify Sun RPC without charge, but are not authorized
|
* may copy or modify Sun RPC without charge, but are not authorized
|
* to license or distribute it to anyone else except as part of a product or
|
* to license or distribute it to anyone else except as part of a product or
|
* program developed by the user.
|
* program developed by the user.
|
*
|
*
|
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
|
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
|
* WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
* WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
|
* PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
|
*
|
*
|
* Sun RPC is provided with no support and without any obligation on the
|
* Sun RPC is provided with no support and without any obligation on the
|
* part of Sun Microsystems, Inc. to assist in its use, correction,
|
* part of Sun Microsystems, Inc. to assist in its use, correction,
|
* modification or enhancement.
|
* modification or enhancement.
|
*
|
*
|
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
|
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
|
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
|
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
|
* OR ANY PART THEREOF.
|
* OR ANY PART THEREOF.
|
*
|
*
|
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
|
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
|
* or profits or other special, indirect and consequential damages, even if
|
* or profits or other special, indirect and consequential damages, even if
|
* Sun has been advised of the possibility of such damages.
|
* Sun has been advised of the possibility of such damages.
|
*
|
*
|
* Sun Microsystems, Inc.
|
* Sun Microsystems, Inc.
|
* 2550 Garcia Avenue
|
* 2550 Garcia Avenue
|
* Mountain View, California 94043
|
* Mountain View, California 94043
|
*
|
*
|
* from: @(#)rpc_msg.h 1.7 86/07/16 SMI
|
* from: @(#)rpc_msg.h 1.7 86/07/16 SMI
|
* from: @(#)rpc_msg.h 2.1 88/07/29 4.0 RPCSRC
|
* from: @(#)rpc_msg.h 2.1 88/07/29 4.0 RPCSRC
|
* $FreeBSD: src/include/rpc/rpc_msg.h,v 1.14 2002/03/23 17:24:55 imp Exp $
|
* $FreeBSD: src/include/rpc/rpc_msg.h,v 1.14 2002/03/23 17:24:55 imp Exp $
|
*/
|
*/
|
|
|
/*
|
/*
|
* rpc_msg.h
|
* rpc_msg.h
|
* rpc message definition
|
* rpc message definition
|
*
|
*
|
* Copyright (C) 1984, Sun Microsystems, Inc.
|
* Copyright (C) 1984, Sun Microsystems, Inc.
|
*/
|
*/
|
|
|
#ifndef _RPC_RPC_MSG_H
|
#ifndef _RPC_RPC_MSG_H
|
#define _RPC_RPC_MSG_H
|
#define _RPC_RPC_MSG_H
|
|
|
#define RPC_MSG_VERSION ((u_int32_t) 2)
|
#define RPC_MSG_VERSION ((u_int32_t) 2)
|
#define RPC_SERVICE_PORT ((u_short) 2048)
|
#define RPC_SERVICE_PORT ((u_short) 2048)
|
|
|
/*
|
/*
|
* Bottom up definition of an rpc message.
|
* Bottom up definition of an rpc message.
|
* NOTE: call and reply use the same overall stuct but
|
* NOTE: call and reply use the same overall stuct but
|
* different parts of unions within it.
|
* different parts of unions within it.
|
*/
|
*/
|
|
|
enum msg_type {
|
enum msg_type {
|
CALL=0,
|
CALL=0,
|
REPLY=1
|
REPLY=1
|
};
|
};
|
|
|
enum reply_stat {
|
enum reply_stat {
|
MSG_ACCEPTED=0,
|
MSG_ACCEPTED=0,
|
MSG_DENIED=1
|
MSG_DENIED=1
|
};
|
};
|
|
|
enum accept_stat {
|
enum accept_stat {
|
SUCCESS=0,
|
SUCCESS=0,
|
PROG_UNAVAIL=1,
|
PROG_UNAVAIL=1,
|
PROG_MISMATCH=2,
|
PROG_MISMATCH=2,
|
PROC_UNAVAIL=3,
|
PROC_UNAVAIL=3,
|
GARBAGE_ARGS=4,
|
GARBAGE_ARGS=4,
|
SYSTEM_ERR=5
|
SYSTEM_ERR=5
|
};
|
};
|
|
|
enum reject_stat {
|
enum reject_stat {
|
RPC_MISMATCH=0,
|
RPC_MISMATCH=0,
|
AUTH_ERROR=1
|
AUTH_ERROR=1
|
};
|
};
|
|
|
/*
|
/*
|
* Reply part of an rpc exchange
|
* Reply part of an rpc exchange
|
*/
|
*/
|
|
|
/*
|
/*
|
* Reply to an rpc request that was accepted by the server.
|
* Reply to an rpc request that was accepted by the server.
|
* Note: there could be an error even though the request was
|
* Note: there could be an error even though the request was
|
* accepted.
|
* accepted.
|
*/
|
*/
|
struct accepted_reply {
|
struct accepted_reply {
|
struct opaque_auth ar_verf;
|
struct opaque_auth ar_verf;
|
enum accept_stat ar_stat;
|
enum accept_stat ar_stat;
|
union {
|
union {
|
struct {
|
struct {
|
rpcvers_t low;
|
rpcvers_t low;
|
rpcvers_t high;
|
rpcvers_t high;
|
} AR_versions;
|
} AR_versions;
|
struct {
|
struct {
|
caddr_t where;
|
caddr_t where;
|
xdrproc_t proc;
|
xdrproc_t proc;
|
} AR_results;
|
} AR_results;
|
/* and many other null cases */
|
/* and many other null cases */
|
} ru;
|
} ru;
|
#define ar_results ru.AR_results
|
#define ar_results ru.AR_results
|
#define ar_vers ru.AR_versions
|
#define ar_vers ru.AR_versions
|
};
|
};
|
|
|
/*
|
/*
|
* Reply to an rpc request that was rejected by the server.
|
* Reply to an rpc request that was rejected by the server.
|
*/
|
*/
|
struct rejected_reply {
|
struct rejected_reply {
|
enum reject_stat rj_stat;
|
enum reject_stat rj_stat;
|
union {
|
union {
|
struct {
|
struct {
|
rpcvers_t low;
|
rpcvers_t low;
|
rpcvers_t high;
|
rpcvers_t high;
|
} RJ_versions;
|
} RJ_versions;
|
enum auth_stat RJ_why; /* why authentication did not work */
|
enum auth_stat RJ_why; /* why authentication did not work */
|
} ru;
|
} ru;
|
#define rj_vers ru.RJ_versions
|
#define rj_vers ru.RJ_versions
|
#define rj_why ru.RJ_why
|
#define rj_why ru.RJ_why
|
};
|
};
|
|
|
/*
|
/*
|
* Body of a reply to an rpc request.
|
* Body of a reply to an rpc request.
|
*/
|
*/
|
struct reply_body {
|
struct reply_body {
|
enum reply_stat rp_stat;
|
enum reply_stat rp_stat;
|
union {
|
union {
|
struct accepted_reply RP_ar;
|
struct accepted_reply RP_ar;
|
struct rejected_reply RP_dr;
|
struct rejected_reply RP_dr;
|
} ru;
|
} ru;
|
#define rp_acpt ru.RP_ar
|
#define rp_acpt ru.RP_ar
|
#define rp_rjct ru.RP_dr
|
#define rp_rjct ru.RP_dr
|
};
|
};
|
|
|
/*
|
/*
|
* Body of an rpc request call.
|
* Body of an rpc request call.
|
*/
|
*/
|
struct call_body {
|
struct call_body {
|
rpcvers_t cb_rpcvers; /* must be equal to two */
|
rpcvers_t cb_rpcvers; /* must be equal to two */
|
rpcprog_t cb_prog;
|
rpcprog_t cb_prog;
|
rpcvers_t cb_vers;
|
rpcvers_t cb_vers;
|
rpcproc_t cb_proc;
|
rpcproc_t cb_proc;
|
struct opaque_auth cb_cred;
|
struct opaque_auth cb_cred;
|
struct opaque_auth cb_verf; /* protocol specific - provided by client */
|
struct opaque_auth cb_verf; /* protocol specific - provided by client */
|
};
|
};
|
|
|
/*
|
/*
|
* The rpc message
|
* The rpc message
|
*/
|
*/
|
struct rpc_msg {
|
struct rpc_msg {
|
u_int32_t rm_xid;
|
u_int32_t rm_xid;
|
enum msg_type rm_direction;
|
enum msg_type rm_direction;
|
union {
|
union {
|
struct call_body RM_cmb;
|
struct call_body RM_cmb;
|
struct reply_body RM_rmb;
|
struct reply_body RM_rmb;
|
} ru;
|
} ru;
|
#define rm_call ru.RM_cmb
|
#define rm_call ru.RM_cmb
|
#define rm_reply ru.RM_rmb
|
#define rm_reply ru.RM_rmb
|
};
|
};
|
#define acpted_rply ru.RM_rmb.ru.RP_ar
|
#define acpted_rply ru.RM_rmb.ru.RP_ar
|
#define rjcted_rply ru.RM_rmb.ru.RP_dr
|
#define rjcted_rply ru.RM_rmb.ru.RP_dr
|
|
|
__BEGIN_DECLS
|
__BEGIN_DECLS
|
/*
|
/*
|
* XDR routine to handle a rpc message.
|
* XDR routine to handle a rpc message.
|
* xdr_callmsg(xdrs, cmsg)
|
* xdr_callmsg(xdrs, cmsg)
|
* XDR *xdrs;
|
* XDR *xdrs;
|
* struct rpc_msg *cmsg;
|
* struct rpc_msg *cmsg;
|
*/
|
*/
|
extern bool_t xdr_callmsg(XDR *, struct rpc_msg *);
|
extern bool_t xdr_callmsg(XDR *, struct rpc_msg *);
|
|
|
/*
|
/*
|
* XDR routine to pre-serialize the static part of a rpc message.
|
* XDR routine to pre-serialize the static part of a rpc message.
|
* xdr_callhdr(xdrs, cmsg)
|
* xdr_callhdr(xdrs, cmsg)
|
* XDR *xdrs;
|
* XDR *xdrs;
|
* struct rpc_msg *cmsg;
|
* struct rpc_msg *cmsg;
|
*/
|
*/
|
extern bool_t xdr_callhdr(XDR *, struct rpc_msg *);
|
extern bool_t xdr_callhdr(XDR *, struct rpc_msg *);
|
|
|
/*
|
/*
|
* XDR routine to handle a rpc reply.
|
* XDR routine to handle a rpc reply.
|
* xdr_replymsg(xdrs, rmsg)
|
* xdr_replymsg(xdrs, rmsg)
|
* XDR *xdrs;
|
* XDR *xdrs;
|
* struct rpc_msg *rmsg;
|
* struct rpc_msg *rmsg;
|
*/
|
*/
|
extern bool_t xdr_replymsg(XDR *, struct rpc_msg *);
|
extern bool_t xdr_replymsg(XDR *, struct rpc_msg *);
|
|
|
|
|
/*
|
/*
|
* XDR routine to handle a accepted rpc reply.
|
* XDR routine to handle a accepted rpc reply.
|
* xdr_accepted_reply(xdrs, rej)
|
* xdr_accepted_reply(xdrs, rej)
|
* XDR *xdrs;
|
* XDR *xdrs;
|
* struct accepted_reply *rej;
|
* struct accepted_reply *rej;
|
*/
|
*/
|
extern bool_t xdr_accepted_reply(XDR *, struct accepted_reply *);
|
extern bool_t xdr_accepted_reply(XDR *, struct accepted_reply *);
|
|
|
/*
|
/*
|
* XDR routine to handle a rejected rpc reply.
|
* XDR routine to handle a rejected rpc reply.
|
* xdr_rejected_reply(xdrs, rej)
|
* xdr_rejected_reply(xdrs, rej)
|
* XDR *xdrs;
|
* XDR *xdrs;
|
* struct rejected_reply *rej;
|
* struct rejected_reply *rej;
|
*/
|
*/
|
extern bool_t xdr_rejected_reply(XDR *, struct rejected_reply *);
|
extern bool_t xdr_rejected_reply(XDR *, struct rejected_reply *);
|
|
|
/*
|
/*
|
* Fills in the error part of a reply message.
|
* Fills in the error part of a reply message.
|
* _seterr_reply(msg, error)
|
* _seterr_reply(msg, error)
|
* struct rpc_msg *msg;
|
* struct rpc_msg *msg;
|
* struct rpc_err *error;
|
* struct rpc_err *error;
|
*/
|
*/
|
extern void _seterr_reply(struct rpc_msg *, struct rpc_err *);
|
extern void _seterr_reply(struct rpc_msg *, struct rpc_err *);
|
__END_DECLS
|
__END_DECLS
|
|
|
#endif /* !_RPC_RPC_MSG_H */
|
#endif /* !_RPC_RPC_MSG_H */
|
|
|
