home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / C / Applications / Portable Patmos / usr / include / rpc / svc.h < prev    next >
Encoding:
C/C++ Source or Header  |  1994-11-08  |  9.2 KB  |  303 lines  |  [TEXT/R*ch]
  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, MERCHANTIBILITY 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: @(#)svc.h 1.20 88/02/08 SMI 
  30.  *    from: @(#)svc.h    2.2 88/07/29 4.0 RPCSRC
  31.  *    $Id: svc.h,v 1.3 1993/08/01 18:45:52 mycroft Exp $
  32.  */
  33.  
  34. /*
  35.  * svc.h, Server-side remote procedure call interface.
  36.  *
  37.  * Copyright (C) 1984, Sun Microsystems, Inc.
  38.  */
  39.  
  40. #ifndef _RPC_SVC_H
  41. #define _RPC_SVC_H
  42. #include <sys/cdefs.h>
  43.  
  44. /*
  45.  * This interface must manage two items concerning remote procedure calling:
  46.  *
  47.  * 1) An arbitrary number of transport connections upon which rpc requests
  48.  * are received.  The two most notable transports are TCP and UDP;  they are
  49.  * created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
  50.  * they in turn call xprt_register and xprt_unregister.
  51.  *
  52.  * 2) An arbitrary number of locally registered services.  Services are
  53.  * described by the following four data: program number, version number,
  54.  * "service dispatch" function, a transport handle, and a boolean that
  55.  * indicates whether or not the exported program should be registered with a
  56.  * local binder service;  if true the program's number and version and the
  57.  * port number from the transport handle are registered with the binder.
  58.  * These data are registered with the rpc svc system via svc_register.
  59.  *
  60.  * A service's dispatch function is called whenever an rpc request comes in
  61.  * on a transport.  The request's program and version numbers must match
  62.  * those of the registered service.  The dispatch function is passed two
  63.  * parameters, struct svc_req * and SVCXPRT *, defined below.
  64.  */
  65.  
  66. enum xprt_stat {
  67.     XPRT_DIED,
  68.     XPRT_MOREREQS,
  69.     XPRT_IDLE
  70. };
  71.  
  72. /*
  73.  * Server side transport handle
  74.  */
  75. typedef struct {
  76.     int        xp_sock;
  77.     u_short        xp_port;     /* associated port number */
  78.     struct xp_ops {
  79.         bool_t    (*xp_recv)();     /* receive incomming requests */
  80.         enum xprt_stat (*xp_stat)(); /* get transport status */
  81.         bool_t    (*xp_getargs)(); /* get arguments */
  82.         bool_t    (*xp_reply)();     /* send reply */
  83.         bool_t    (*xp_freeargs)();/* free mem allocated for args */
  84.         void    (*xp_destroy)(); /* destroy this struct */
  85.     } *xp_ops;
  86.     int        xp_addrlen;     /* length of remote address */
  87.     struct sockaddr_in xp_raddr;     /* remote address */
  88.     struct opaque_auth xp_verf;     /* raw response verifier */
  89.     caddr_t        xp_p1;         /* private */
  90.     caddr_t        xp_p2;         /* private */
  91. } SVCXPRT;
  92.  
  93. /*
  94.  *  Approved way of getting address of caller
  95.  */
  96. #define svc_getcaller(x) (&(x)->xp_raddr)
  97.  
  98. /*
  99.  * Operations defined on an SVCXPRT handle
  100.  *
  101.  * SVCXPRT        *xprt;
  102.  * struct rpc_msg    *msg;
  103.  * xdrproc_t         xargs;
  104.  * caddr_t         argsp;
  105.  */
  106. #define SVC_RECV(xprt, msg)                \
  107.     (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
  108. #define svc_recv(xprt, msg)                \
  109.     (*(xprt)->xp_ops->xp_recv)((xprt), (msg))
  110.  
  111. #define SVC_STAT(xprt)                    \
  112.     (*(xprt)->xp_ops->xp_stat)(xprt)
  113. #define svc_stat(xprt)                    \
  114.     (*(xprt)->xp_ops->xp_stat)(xprt)
  115.  
  116. #define SVC_GETARGS(xprt, xargs, argsp)            \
  117.     (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
  118. #define svc_getargs(xprt, xargs, argsp)            \
  119.     (*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
  120.  
  121. #define SVC_REPLY(xprt, msg)                \
  122.     (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
  123. #define svc_reply(xprt, msg)                \
  124.     (*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
  125.  
  126. #define SVC_FREEARGS(xprt, xargs, argsp)        \
  127.     (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
  128. #define svc_freeargs(xprt, xargs, argsp)        \
  129.     (*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
  130.  
  131. #define SVC_DESTROY(xprt)                \
  132.     (*(xprt)->xp_ops->xp_destroy)(xprt)
  133. #define svc_destroy(xprt)                \
  134.     (*(xprt)->xp_ops->xp_destroy)(xprt)
  135.  
  136.  
  137. /*
  138.  * Service request
  139.  */
  140. struct svc_req {
  141.     u_long        rq_prog;    /* service program number */
  142.     u_long        rq_vers;    /* service protocol version */
  143.     u_long        rq_proc;    /* the desired procedure */
  144.     struct opaque_auth rq_cred;    /* raw creds from the wire */
  145.     caddr_t        rq_clntcred;    /* read only cooked cred */
  146.     SVCXPRT    *rq_xprt;        /* associated transport */
  147. };
  148.  
  149.  
  150. /*
  151.  * Service registration
  152.  *
  153.  * svc_register(xprt, prog, vers, dispatch, protocol)
  154.  *    SVCXPRT *xprt;
  155.  *    u_long prog;
  156.  *    u_long vers;
  157.  *    void (*dispatch)();
  158.  *    int protocol;  /* like TCP or UDP, zero means do not register 
  159.  */
  160. __BEGIN_DECLS
  161. extern bool_t    svc_register __P((SVCXPRT *, u_long, u_long, void (*)(), int));
  162. __END_DECLS
  163.  
  164. /*
  165.  * Service un-registration
  166.  *
  167.  * svc_unregister(prog, vers)
  168.  *    u_long prog;
  169.  *    u_long vers;
  170.  */
  171. __BEGIN_DECLS
  172. extern void    svc_unregister __P((u_long, u_long));
  173. __END_DECLS
  174.  
  175. /*
  176.  * Transport registration.
  177.  *
  178.  * xprt_register(xprt)
  179.  *    SVCXPRT *xprt;
  180.  */
  181. __BEGIN_DECLS
  182. extern void    xprt_register    __P((SVCXPRT *));
  183. __END_DECLS
  184.  
  185. /*
  186.  * Transport un-register
  187.  *
  188.  * xprt_unregister(xprt)
  189.  *    SVCXPRT *xprt;
  190.  */
  191. __BEGIN_DECLS
  192. extern void    xprt_unregister    __P((SVCXPRT *));
  193. __END_DECLS
  194.  
  195.  
  196.  
  197.  
  198. /*
  199.  * When the service routine is called, it must first check to see if it
  200.  * knows about the procedure;  if not, it should call svcerr_noproc
  201.  * and return.  If so, it should deserialize its arguments via 
  202.  * SVC_GETARGS (defined above).  If the deserialization does not work,
  203.  * svcerr_decode should be called followed by a return.  Successful
  204.  * decoding of the arguments should be followed the execution of the
  205.  * procedure's code and a call to svc_sendreply.
  206.  *
  207.  * Also, if the service refuses to execute the procedure due to too-
  208.  * weak authentication parameters, svcerr_weakauth should be called.
  209.  * Note: do not confuse access-control failure with weak authentication!
  210.  *
  211.  * NB: In pure implementations of rpc, the caller always waits for a reply
  212.  * msg.  This message is sent when svc_sendreply is called.  
  213.  * Therefore pure service implementations should always call
  214.  * svc_sendreply even if the function logically returns void;  use
  215.  * xdr.h - xdr_void for the xdr routine.  HOWEVER, tcp based rpc allows
  216.  * for the abuse of pure rpc via batched calling or pipelining.  In the
  217.  * case of a batched call, svc_sendreply should NOT be called since
  218.  * this would send a return message, which is what batching tries to avoid.
  219.  * It is the service/protocol writer's responsibility to know which calls are
  220.  * batched and which are not.  Warning: responding to batch calls may
  221.  * deadlock the caller and server processes!
  222.  */
  223.  
  224. __BEGIN_DECLS
  225. extern bool_t    svc_sendreply    __P((SVCXPRT *, xdrproc_t, char *));
  226. extern void    svcerr_decode    __P((SVCXPRT *));
  227. extern void    svcerr_weakauth    __P((SVCXPRT *));
  228. extern void    svcerr_noproc    __P((SVCXPRT *));
  229. extern void    svcerr_progvers    __P((SVCXPRT *, u_long, u_long));
  230. extern void    svcerr_auth    __P((SVCXPRT *, enum auth_stat));
  231. extern void    svcerr_noprog    __P((SVCXPRT *));
  232. extern void    svcerr_systemerr __P((SVCXPRT *));
  233. __END_DECLS
  234.     
  235. /*
  236.  * Lowest level dispatching -OR- who owns this process anyway.
  237.  * Somebody has to wait for incoming requests and then call the correct
  238.  * service routine.  The routine svc_run does infinite waiting; i.e.,
  239.  * svc_run never returns.
  240.  * Since another (co-existant) package may wish to selectively wait for
  241.  * incoming calls or other events outside of the rpc architecture, the
  242.  * routine svc_getreq is provided.  It must be passed readfds, the
  243.  * "in-place" results of a select system call (see select, section 2).
  244.  */
  245.  
  246. /*
  247.  * Global keeper of rpc service descriptors in use
  248.  * dynamic; must be inspected before each call to select 
  249.  */
  250. #ifdef FD_SETSIZE
  251. extern fd_set svc_fdset;
  252. #define svc_fds svc_fdset.fds_bits[0]    /* compatibility */
  253. #else
  254. extern int svc_fds;
  255. #endif /* def FD_SETSIZE */
  256.  
  257. /*
  258.  * a small program implemented by the svc_rpc implementation itself;
  259.  * also see clnt.h for protocol numbers.
  260.  */
  261. extern void rpctest_service();
  262.  
  263. __BEGIN_DECLS
  264. extern void    svc_getreq    __P((int));
  265. extern void    svc_getreqset    __P((fd_set *));
  266. extern void    svc_run        __P((void));
  267. __END_DECLS
  268.  
  269. /*
  270.  * Socket to use on svcxxx_create call to get default socket
  271.  */
  272. #define    RPC_ANYSOCK    -1
  273.  
  274. /*
  275.  * These are the existing service side transport implementations
  276.  */
  277.  
  278. /*
  279.  * Memory based rpc for testing and timing.
  280.  */
  281. __BEGIN_DECLS
  282. extern SVCXPRT *svcraw_create __P((void));
  283. __END_DECLS
  284.  
  285.  
  286. /*
  287.  * Udp based rpc.
  288.  */
  289. __BEGIN_DECLS
  290. extern SVCXPRT *svcudp_create __P((int));
  291. extern SVCXPRT *svcudp_bufcreate __P((int, u_int, u_int));
  292. __END_DECLS
  293.  
  294.  
  295. /*
  296.  * Tcp based rpc.
  297.  */
  298. __BEGIN_DECLS
  299. extern SVCXPRT *svctcp_create __P((int, u_int, u_int));
  300. __END_DECLS
  301.  
  302. #endif /* !_RPC_SVC_H */
  303.