308 lines
10 KiB
C
308 lines
10 KiB
C
/***************************************************************************
|
|
*
|
|
* File Name: ./hprrm/rpcsvc.h
|
|
*
|
|
* Copyright (C) 1993-1996 Hewlett-Packard Company.
|
|
* All rights reserved.
|
|
*
|
|
* 11311 Chinden Blvd.
|
|
* Boise, Idaho 83714
|
|
*
|
|
* This is a part of the HP JetAdmin Printer Utility
|
|
*
|
|
* This source code is only intended as a supplement for support and
|
|
* localization of HP JetAdmin by 3rd party Operating System vendors.
|
|
* Modification of source code cannot be made without the express written
|
|
* consent of Hewlett-Packard.
|
|
*
|
|
*
|
|
* Description:
|
|
*
|
|
* Author: Name
|
|
*
|
|
*
|
|
* Modification history:
|
|
*
|
|
* date initials change description
|
|
*
|
|
* mm-dd-yy MJB
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
*
|
|
***************************************************************************/
|
|
|
|
#ifndef __SVC_HEADER__
|
|
#define __SVC_HEADER__
|
|
|
|
#include "rpsyshdr.h"
|
|
#include "aut.h"
|
|
#include "tlitypes.h"
|
|
/*
|
|
* .unsupp/sys/_ became sxu
|
|
* machine/ became sxm
|
|
* sys/ became sx
|
|
* arpa/ became sx
|
|
* netinet/ became sx
|
|
* net/ became sx
|
|
* rpc/ became
|
|
* auth_ became aut
|
|
* auth became aut
|
|
* clnt_ became clnt
|
|
* nfsv3_ became nfs
|
|
* nfsv3 became nfs
|
|
* getrpc became gr
|
|
* pmap_ became pmap
|
|
* rpc_ became rpc
|
|
* svc_ became svc
|
|
* unix_ became ux
|
|
* unix became ux
|
|
* xdr_ became xdr
|
|
* reference became rf
|
|
* commondata became cd
|
|
* tablesize became tsz
|
|
* get_myaddress became gmyad
|
|
* bindresvport became brvp
|
|
* generic became gnc
|
|
* getmaps became map
|
|
* getport became port
|
|
* _prot became pro
|
|
* prot became pro
|
|
* simple became simp
|
|
* callmsg became call
|
|
* error became err
|
|
* stdsyms became syms
|
|
* socket became sock
|
|
* sysmacros became macs
|
|
* if_arp became ifarp
|
|
* errno became ern
|
|
* ioctl became ioct
|
|
* signal became sig
|
|
* param became parm
|
|
* types became typs
|
|
*/
|
|
/*
|
|
* Sun RPC is a product of Sun Microsystems, Inc. and is provided for
|
|
* 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
|
|
* 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
|
|
* program developed by the user or with the express written consent of
|
|
* Sun Microsystems, Inc.
|
|
*
|
|
* SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
|
|
* WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
|
|
* 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
|
|
* part of Sun Microsystems, Inc. to assist in its use, correction,
|
|
* modification or enhancement.
|
|
*
|
|
* SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
|
|
* INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
|
|
* OR ANY PART THEREOF.
|
|
*
|
|
* In no event will Sun Microsystems, Inc. be liable for any lost revenue
|
|
* or profits or other special, indirect and consequential damages, even if
|
|
* Sun has been advised of the possibility of such damages.
|
|
*
|
|
* Sun Microsystems, Inc.
|
|
* 2550 Garcia Avenue
|
|
* Mountain View, California 94043
|
|
*/
|
|
/* @(#)svc.h 1.55 91/03/11 SMI */
|
|
|
|
/*
|
|
* svc.h, Server-side remote procedure call interface.
|
|
*
|
|
* Copyright (C) 1984, Sun Microsystems, Inc.
|
|
*/
|
|
|
|
|
|
/*
|
|
* This interface must manage two items concerning remote procedure calling:
|
|
*
|
|
* 1) An arbitrary number of transport connections upon which rpc requests
|
|
* are received. They are created and registered by routines in svc_generic.c,
|
|
* svc_vc.c and svc_dg.c; they in turn call xprt_register and
|
|
* xprt_unregister.
|
|
*
|
|
* 2) An arbitrary number of locally registered services. Services are
|
|
* described by the following four data: program number, version number,
|
|
* "service dispatch" function, a transport handle, and a boolean that
|
|
* indicates whether or not the exported program should be registered with a
|
|
* local binder service; if true the program's number and version and the
|
|
* address from the transport handle are registered with the binder.
|
|
* These data are registered with rpcbind via svc_reg().
|
|
*
|
|
* A service's dispatch function is called whenever an rpc request comes in
|
|
* on a transport. The request's program and version numbers must match
|
|
* those of the registered service. The dispatch function is passed two
|
|
* parameters, struct svc_req * and SVCXPRT *, defined below.
|
|
*/
|
|
|
|
enum xprt_stat {
|
|
XPRT_DIED,
|
|
XPRT_MOREREQS,
|
|
XPRT_IDLE
|
|
};
|
|
|
|
/*
|
|
* Server side transport handle
|
|
*/
|
|
typedef struct {
|
|
fd_t xp_fd;
|
|
#define xp_sock xp_fd
|
|
u_short xp_port; /* associated port number.
|
|
* Obsoleted, but still used to
|
|
* specify whether rendezvouser
|
|
* or normal connection
|
|
*/
|
|
struct xp_ops {
|
|
bool_t (*xp_recv)(); /* receive incomming requests */
|
|
enum xprt_stat (*xp_stat)(); /* get transport status */
|
|
bool_t (*xp_getargs)(); /* get arguments */
|
|
bool_t (*xp_reply)(); /* send reply */
|
|
bool_t (*xp_freeargs)();/* free mem allocated for args */
|
|
void (*xp_destroy)(); /* destroy this struct */
|
|
} *xp_ops;
|
|
int xp_addrlen; /* length of remote addr. Obsoleted */
|
|
char *xp_tp; /* transport provider device name */
|
|
char *xp_netid; /* network token */
|
|
struct netbuf xp_ltaddr; /* local transport address */
|
|
struct netbuf xp_rtaddr; /* remote transport address */
|
|
char xp_raddr[16]; /* remote address. Now obsoleted */
|
|
struct opaque_auth xp_verf; /* raw response verifier */
|
|
caddr_t xp_p1; /* private: for use by svc ops */
|
|
caddr_t xp_p2; /* private: for use by svc ops */
|
|
caddr_t xp_p3; /* private: for use by svc lib */
|
|
} SVCXPRT;
|
|
|
|
/*
|
|
* Approved ways of getting address of caller
|
|
*/
|
|
#define svc_getrpccaller(x) (&(x)->xp_rtaddr)
|
|
#define svc_getudpcaller(x) ((struct sockaddr_in *)(x)->xp_rtaddr.buf)
|
|
|
|
/*
|
|
* Operations defined on an SVCXPRT handle
|
|
*
|
|
* SVCXPRT *xprt;
|
|
* struct rpc_msg *msg;
|
|
* xdrproc_t xargs;
|
|
* caddr_t argsp;
|
|
*/
|
|
#define SVC_RECV(xprt, msg) \
|
|
(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
|
|
#define svc_recv(xprt, msg) \
|
|
(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
|
|
|
|
#define SVC_STAT(xprt) \
|
|
(*(xprt)->xp_ops->xp_stat)(xprt)
|
|
#define svc_stat(xprt) \
|
|
(*(xprt)->xp_ops->xp_stat)(xprt)
|
|
|
|
#define SVC_GETARGS(xprt, xargs, argsp) \
|
|
(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
|
|
#define svc_getargs(xprt, xargs, argsp) \
|
|
(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
|
|
|
|
#define SVC_REPLY(xprt, msg) \
|
|
(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
|
|
#define svc_reply(xprt, msg) \
|
|
(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
|
|
|
|
#define SVC_FREEARGS(xprt, xargs, argsp) \
|
|
(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
|
|
#define svc_freeargs(xprt, xargs, argsp) \
|
|
(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
|
|
|
|
#define SVC_DESTROY(xprt) \
|
|
(*(xprt)->xp_ops->xp_destroy)(xprt)
|
|
#define svc_destroy(xprt) \
|
|
(*(xprt)->xp_ops->xp_destroy)(xprt)
|
|
|
|
|
|
/*
|
|
* Service request
|
|
*/
|
|
struct svc_req {
|
|
prog_t rq_prog; /* service program number */
|
|
vers_t rq_vers; /* service protocol version */
|
|
proc_t rq_proc; /* the desired procedure */
|
|
struct opaque_auth rq_cred; /* raw creds from the wire */
|
|
caddr_t rq_clntcred; /* read only cooked cred */
|
|
SVCXPRT *rq_xprt; /* associated transport */
|
|
};
|
|
|
|
|
|
/*
|
|
* When the service routine is called, it must first check to see if it
|
|
* knows about the procedure; if not, it should call svcerr_noproc
|
|
* and return. If so, it should deserialize its arguments via
|
|
* SVC_GETARGS (defined above). If the deserialization does not work,
|
|
* svcerr_decode should be called followed by a return. Successful
|
|
* decoding of the arguments should be followed the execution of the
|
|
* procedure's code and a call to svc_sendreply.
|
|
*
|
|
* Also, if the service refuses to execute the procedure due to too-
|
|
* weak authentication parameters, svcerr_weakauth should be called.
|
|
* Note: do not confuse access-control failure with weak authentication!
|
|
*
|
|
* NB: In pure implementations of rpc, the caller always waits for a reply
|
|
* msg. This message is sent when svc_sendreply is called.
|
|
* Therefore pure service implementations should always call
|
|
* svc_sendreply even if the function logically returns void; use
|
|
* xdr.h - xdr_void for the xdr routine. HOWEVER, connectionful rpc allows
|
|
* for the abuse of pure rpc via batched calling or pipelining. In the
|
|
* case of a batched call, svc_sendreply should NOT be called since
|
|
* this would send a return message, which is what batching tries to avoid.
|
|
* It is the service/protocol writer's responsibility to know which calls are
|
|
* batched and which are not. Warning: responding to batch calls may
|
|
* deadlock the caller and server processes!
|
|
*/
|
|
/* extern bool_t svc_sendreply (SVCXPRT *, xdrproc_t, caddr_t); */
|
|
/* extern void svcerr_decode (SVCXPRT *); */
|
|
/* extern void svcerr_weakauth (SVCXPRT *); */
|
|
/* extern void svcerr_noproc (SVCXPRT *); */
|
|
/* extern void svcerr_progvers (SVCXPRT *, vers_t, vers_t); */
|
|
/* extern void svcerr_auth (SVCXPRT *, enum auth_stat); */
|
|
/* extern void svcerr_noprog (SVCXPRT *); */
|
|
/* extern void svcerr_systemerr (SVCXPRT *); */
|
|
|
|
|
|
|
|
/*
|
|
* Lowest level dispatching -OR- who owns this process anyway.
|
|
* Somebody has to wait for incoming requests and then call the correct
|
|
* service routine. The routine svc_run does infinite waiting; i.e.,
|
|
* svc_run never returns.
|
|
* Since another (co-existant) package may wish to selectively wait for
|
|
* incoming calls or other events outside of the rpc architecture, the
|
|
* routine svc_getreq is provided. It must be passed readfds, the
|
|
* "in-place" results of a select call (see select, section XXX).
|
|
*/
|
|
|
|
/*
|
|
* Global keeper of rpc service descriptors in use
|
|
* dynamic; must be inspected before each call to select
|
|
*/
|
|
extern fd_set svc_fdset;
|
|
#define svc_fds svc_fdset.fds_bits[0] /* compatibility */
|
|
|
|
/********************** BM KLUDGE *******************/
|
|
/* Actually svc_soc.h doesn't have anything we need --
|
|
* prototypes were moved to svcext.h.
|
|
*/
|
|
#if 0
|
|
#ifdef PORTMAP
|
|
/* For backward compatibility */
|
|
#include "svc_soc.h"
|
|
#endif /* PORTMAP */
|
|
#endif /* 0 */
|
|
/******************** END BM KLUDGE *****************/
|
|
|
|
#endif /* not __SVC_HEADER__ */
|