svc.h
上传用户:szlgq88
上传日期:2009-04-28
资源大小:48287k
文件大小:10k
源码类别:

嵌入式Linux

开发平台:

Unix_Linux

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