xref: /freebsd/include/rpc/svc.h (revision a220d00e74dd245b4fca59c5eca0c53963686325)
1 /*	$NetBSD: svc.h,v 1.17 2000/06/02 22:57:56 fvdl Exp $	*/
2 
3 /*
4  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
5  * unrestricted use provided that this legend is included on all tape
6  * media and as a part of the software program in whole or part.  Users
7  * may copy or modify Sun RPC without charge, but are not authorized
8  * to license or distribute it to anyone else except as part of a product or
9  * program developed by the user.
10  *
11  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
12  * WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
13  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
14  *
15  * Sun RPC is provided with no support and without any obligation on the
16  * part of Sun Microsystems, Inc. to assist in its use, correction,
17  * modification or enhancement.
18  *
19  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
20  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
21  * OR ANY PART THEREOF.
22  *
23  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
24  * or profits or other special, indirect and consequential damages, even if
25  * Sun has been advised of the possibility of such damages.
26  *
27  * Sun Microsystems, Inc.
28  * 2550 Garcia Avenue
29  * Mountain View, California  94043
30  *
31  *	from: @(#)svc.h 1.35 88/12/17 SMI
32  *	from: @(#)svc.h      1.27    94/04/25 SMI
33  * $FreeBSD$
34  */
35 
36 /*
37  * svc.h, Server-side remote procedure call interface.
38  *
39  * Copyright (C) 1986-1993 by Sun Microsystems, Inc.
40  */
41 
42 #ifndef _RPC_SVC_H
43 #define _RPC_SVC_H
44 #include <sys/cdefs.h>
45 
46 /*
47  * This interface must manage two items concerning remote procedure calling:
48  *
49  * 1) An arbitrary number of transport connections upon which rpc requests
50  * are received.  The two most notable transports are TCP and UDP;  they are
51  * created and registered by routines in svc_tcp.c and svc_udp.c, respectively;
52  * they in turn call xprt_register and xprt_unregister.
53  *
54  * 2) An arbitrary number of locally registered services.  Services are
55  * described by the following four data: program number, version number,
56  * "service dispatch" function, a transport handle, and a boolean that
57  * indicates whether or not the exported program should be registered with a
58  * local binder service;  if true the program's number and version and the
59  * port number from the transport handle are registered with the binder.
60  * These data are registered with the rpc svc system via svc_register.
61  *
62  * A service's dispatch function is called whenever an rpc request comes in
63  * on a transport.  The request's program and version numbers must match
64  * those of the registered service.  The dispatch function is passed two
65  * parameters, struct svc_req * and SVCXPRT *, defined below.
66  */
67 
68 /*
69  *      Service control requests
70  */
71 #define SVCGET_VERSQUIET	1
72 #define SVCSET_VERSQUIET	2
73 
74 
75 enum xprt_stat {
76 	XPRT_DIED,
77 	XPRT_MOREREQS,
78 	XPRT_IDLE
79 };
80 
81 /*
82  * Server side transport handle
83  */
84 typedef struct __rpc_svcxprt {
85 	int		xp_fd;
86 	u_short		xp_port;	 /* associated port number */
87 	const struct xp_ops {
88 	    /* receive incoming requests */
89 	    bool_t	(*xp_recv) __P((struct __rpc_svcxprt *,
90 				struct rpc_msg *));
91 	    /* get transport status */
92 	    enum xprt_stat (*xp_stat) __P((struct __rpc_svcxprt *));
93 	    /* get arguments */
94 	    bool_t	(*xp_getargs) __P((struct __rpc_svcxprt *, xdrproc_t,
95 				caddr_t));
96 	    /* send reply */
97 	    bool_t	(*xp_reply) __P((struct __rpc_svcxprt *,
98 				struct rpc_msg *));
99 	    /* free mem allocated for args */
100 	    bool_t	(*xp_freeargs) __P((struct __rpc_svcxprt *, xdrproc_t,
101 				caddr_t));
102 	    /* destroy this struct */
103 	    void	(*xp_destroy) __P((struct __rpc_svcxprt *));
104 	} *xp_ops;
105 	int		xp_addrlen;	 /* length of remote address */
106 	struct sockaddr_in xp_raddr;	 /* remote addr. (backward ABI compat) */
107 	/* XXX - fvdl stick this here for ABI backward compat reasons */
108 	const struct xp_ops2 {
109 		/* catch-all function */
110 		bool_t  (*xp_control) __P((struct __rpc_svcxprt *, const u_int,
111 					   void *));
112 	} *xp_ops2;
113 	char		*xp_tp;		 /* transport provider device name */
114 	char		*xp_netid;	 /* network token */
115 	struct netbuf	xp_ltaddr;	 /* local transport address */
116 	struct netbuf	xp_rtaddr;	 /* remote transport address */
117 	struct opaque_auth xp_verf;	 /* raw response verifier */
118 	void		*xp_p1;		 /* private: for use by svc ops */
119 	void		*xp_p2;		 /* private: for use by svc ops */
120 	void		*xp_p3;		 /* private: for use by svc lib */
121 	int		xp_type;	 /* transport type */
122 } SVCXPRT;
123 
124 /*
125  * Service request
126  */
127 struct svc_req {
128 	u_int32_t	rq_prog;	/* service program number */
129 	u_int32_t	rq_vers;	/* service protocol version */
130 	u_int32_t	rq_proc;	/* the desired procedure */
131 	struct opaque_auth rq_cred;	/* raw creds from the wire */
132 	void		*rq_clntcred;	/* read only cooked cred */
133 	SVCXPRT		*rq_xprt;	/* associated transport */
134 };
135 
136 /*
137  *  Approved way of getting address of caller
138  */
139 #define svc_getrpccaller(x) (&(x)->xp_rtaddr)
140 
141 /*
142  * FreeBSD-only definition to get the creds of the caller (AF_LOCAL).
143  */
144 #define __svc_getcallercreds(x) ((struct cmsgcred *)(x)->xp_p2)
145 
146 /*
147  * Operations defined on an SVCXPRT handle
148  *
149  * SVCXPRT		*xprt;
150  * struct rpc_msg	*msg;
151  * xdrproc_t		 xargs;
152  * caddr_t		 argsp;
153  */
154 #define SVC_RECV(xprt, msg)				\
155 	(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
156 #define svc_recv(xprt, msg)				\
157 	(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
158 
159 #define SVC_STAT(xprt)					\
160 	(*(xprt)->xp_ops->xp_stat)(xprt)
161 #define svc_stat(xprt)					\
162 	(*(xprt)->xp_ops->xp_stat)(xprt)
163 
164 #define SVC_GETARGS(xprt, xargs, argsp)			\
165 	(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
166 #define svc_getargs(xprt, xargs, argsp)			\
167 	(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
168 
169 #define SVC_REPLY(xprt, msg)				\
170 	(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
171 #define svc_reply(xprt, msg)				\
172 	(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
173 
174 #define SVC_FREEARGS(xprt, xargs, argsp)		\
175 	(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
176 #define svc_freeargs(xprt, xargs, argsp)		\
177 	(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
178 
179 #define SVC_DESTROY(xprt)				\
180 	(*(xprt)->xp_ops->xp_destroy)(xprt)
181 #define svc_destroy(xprt)				\
182 	(*(xprt)->xp_ops->xp_destroy)(xprt)
183 
184 #define SVC_CONTROL(xprt, rq, in)			\
185 	(*(xprt)->xp_ops2->xp_control)((xprt), (rq), (in))
186 
187 /*
188  * Service registration
189  *
190  * svc_reg(xprt, prog, vers, dispatch, nconf)
191  *	const SVCXPRT *xprt;
192  *	const rpcprog_t prog;
193  *	const rpcvers_t vers;
194  *	const void (*dispatch)();
195  *	const struct netconfig *nconf;
196  */
197 
198 __BEGIN_DECLS
199 extern bool_t	svc_reg __P((SVCXPRT *, const rpcprog_t, const rpcvers_t,
200 			void (*) __P((struct svc_req *, SVCXPRT *)),
201 			const struct netconfig *));
202 __END_DECLS
203 
204 /*
205  * Service un-registration
206  *
207  * svc_unreg(prog, vers)
208  *	const rpcprog_t prog;
209  *	const rpcvers_t vers;
210  */
211 
212 __BEGIN_DECLS
213 extern void	svc_unreg __P((const rpcprog_t, const rpcvers_t));
214 __END_DECLS
215 
216 /*
217  * Transport registration.
218  *
219  * xprt_register(xprt)
220  *	SVCXPRT *xprt;
221  */
222 __BEGIN_DECLS
223 extern void	xprt_register	__P((SVCXPRT *));
224 __END_DECLS
225 
226 /*
227  * Transport un-register
228  *
229  * xprt_unregister(xprt)
230  *	SVCXPRT *xprt;
231  */
232 __BEGIN_DECLS
233 extern void	xprt_unregister	__P((SVCXPRT *));
234 __END_DECLS
235 
236 
237 /*
238  * When the service routine is called, it must first check to see if it
239  * knows about the procedure;  if not, it should call svcerr_noproc
240  * and return.  If so, it should deserialize its arguments via
241  * SVC_GETARGS (defined above).  If the deserialization does not work,
242  * svcerr_decode should be called followed by a return.  Successful
243  * decoding of the arguments should be followed the execution of the
244  * procedure's code and a call to svc_sendreply.
245  *
246  * Also, if the service refuses to execute the procedure due to too-
247  * weak authentication parameters, svcerr_weakauth should be called.
248  * Note: do not confuse access-control failure with weak authentication!
249  *
250  * NB: In pure implementations of rpc, the caller always waits for a reply
251  * msg.  This message is sent when svc_sendreply is called.
252  * Therefore pure service implementations should always call
253  * svc_sendreply even if the function logically returns void;  use
254  * xdr.h - xdr_void for the xdr routine.  HOWEVER, tcp based rpc allows
255  * for the abuse of pure rpc via batched calling or pipelining.  In the
256  * case of a batched call, svc_sendreply should NOT be called since
257  * this would send a return message, which is what batching tries to avoid.
258  * It is the service/protocol writer's responsibility to know which calls are
259  * batched and which are not.  Warning: responding to batch calls may
260  * deadlock the caller and server processes!
261  */
262 
263 __BEGIN_DECLS
264 extern bool_t	svc_sendreply	__P((SVCXPRT *, xdrproc_t, char *));
265 extern void	svcerr_decode	__P((SVCXPRT *));
266 extern void	svcerr_weakauth	__P((SVCXPRT *));
267 extern void	svcerr_noproc	__P((SVCXPRT *));
268 extern void	svcerr_progvers	__P((SVCXPRT *, rpcvers_t, rpcvers_t));
269 extern void	svcerr_auth	__P((SVCXPRT *, enum auth_stat));
270 extern void	svcerr_noprog	__P((SVCXPRT *));
271 extern void	svcerr_systemerr __P((SVCXPRT *));
272 extern int	rpc_reg __P((rpcprog_t, rpcvers_t, rpcproc_t,
273 			     char *(*) __P((char *)), xdrproc_t, xdrproc_t,
274 			     char *));
275 __END_DECLS
276 
277 /*
278  * Lowest level dispatching -OR- who owns this process anyway.
279  * Somebody has to wait for incoming requests and then call the correct
280  * service routine.  The routine svc_run does infinite waiting; i.e.,
281  * svc_run never returns.
282  * Since another (co-existant) package may wish to selectively wait for
283  * incoming calls or other events outside of the rpc architecture, the
284  * routine svc_getreq is provided.  It must be passed readfds, the
285  * "in-place" results of a select system call (see select, section 2).
286  */
287 
288 /*
289  * Global keeper of rpc service descriptors in use
290  * dynamic; must be inspected before each call to select
291  */
292 extern int svc_maxfd;
293 #ifdef FD_SETSIZE
294 extern fd_set svc_fdset;
295 #define svc_fds svc_fdset.fds_bits[0]	/* compatibility */
296 #else
297 extern int svc_fds;
298 #endif /* def FD_SETSIZE */
299 
300 /*
301  * a small program implemented by the svc_rpc implementation itself;
302  * also see clnt.h for protocol numbers.
303  */
304 __BEGIN_DECLS
305 extern void rpctest_service __P((void));
306 __END_DECLS
307 
308 __BEGIN_DECLS
309 extern void	svc_getreq	__P((int));
310 extern void	svc_getreqset	__P((fd_set *));
311 extern void	svc_getreq_common	__P((int));
312 struct pollfd;
313 extern void	svc_getreq_poll __P((struct pollfd *, int));
314 
315 extern void	svc_run		__P((void));
316 extern void	svc_exit	__P((void));
317 __END_DECLS
318 
319 /*
320  * Socket to use on svcxxx_create call to get default socket
321  */
322 #define	RPC_ANYSOCK	-1
323 #define RPC_ANYFD	RPC_ANYSOCK
324 
325 /*
326  * These are the existing service side transport implementations
327  */
328 
329 __BEGIN_DECLS
330 /*
331  * Transport independent svc_create routine.
332  */
333 extern int svc_create __P((void (*) __P((struct svc_req *, SVCXPRT *)),
334 			   const rpcprog_t, const rpcvers_t, const char *));
335 /*
336  *      void (*dispatch)();             -- dispatch routine
337  *      const rpcprog_t prognum;        -- program number
338  *      const rpcvers_t versnum;        -- version number
339  *      const char *nettype;            -- network type
340  */
341 
342 
343 /*
344  * Generic server creation routine. It takes a netconfig structure
345  * instead of a nettype.
346  */
347 
348 extern SVCXPRT *svc_tp_create __P((void (*) __P((struct svc_req *, SVCXPRT *)),
349 				   const rpcprog_t, const rpcvers_t,
350 				   const struct netconfig *));
351         /*
352          * void (*dispatch)();            -- dispatch routine
353          * const rpcprog_t prognum;       -- program number
354          * const rpcvers_t versnum;       -- version number
355          * const struct netconfig *nconf; -- netconfig structure
356          */
357 
358 
359 /*
360  * Generic TLI create routine
361  */
362 extern SVCXPRT *svc_tli_create __P((const int, const struct netconfig *,
363 				    const struct t_bind *, const u_int,
364 				    const u_int));
365 /*
366  *      const int fd;                   -- connection end point
367  *      const struct netconfig *nconf;  -- netconfig structure for network
368  *      const struct t_bind *bindaddr;  -- local bind address
369  *      const u_int sendsz;             -- max sendsize
370  *      const u_int recvsz;             -- max recvsize
371  */
372 
373 /*
374  * Connectionless and connectionful create routines
375  */
376 
377 extern SVCXPRT *svc_vc_create __P((const int, const u_int, const u_int));
378 /*
379  *      const int fd;                           -- open connection end point
380  *      const u_int sendsize;                   -- max send size
381  *      const u_int recvsize;                   -- max recv size
382  */
383 
384 /*
385  * Added for compatibility to old rpc 4.0. Obsoleted by svc_vc_create().
386  */
387 extern SVCXPRT *svcunix_create __P((int, u_int, u_int, char *));
388 
389 extern SVCXPRT *svc_dg_create __P((const int, const u_int, const u_int));
390         /*
391          * const int fd;                                -- open connection
392          * const u_int sendsize;                        -- max send size
393          * const u_int recvsize;                        -- max recv size
394          */
395 
396 
397 /*
398  * the routine takes any *open* connection
399  * descriptor as its first input and is used for open connections.
400  */
401 extern SVCXPRT *svc_fd_create __P((const int, const u_int, const u_int));
402 /*
403  *      const int fd;                           -- open connection end point
404  *      const u_int sendsize;                   -- max send size
405  *      const u_int recvsize;                   -- max recv size
406  */
407 
408 /*
409  * Added for compatibility to old rpc 4.0. Obsoleted by svc_fd_create().
410  */
411 extern SVCXPRT *svcunixfd_create __P((int, u_int, u_int));
412 
413 /*
414  * Memory based rpc (for speed check and testing)
415  */
416 extern SVCXPRT *svc_raw_create __P((void));
417 
418 /*
419  * svc_dg_enable_cache() enables the cache on dg transports.
420  */
421 int svc_dg_enablecache __P((SVCXPRT *, const u_int));
422 
423 int __rpc_get_local_uid(SVCXPRT *transp, uid_t *uid);
424 
425 __END_DECLS
426 
427 
428 /* for backward compatibility */
429 #include <rpc/svc_soc.h>
430 
431 #endif /* !_RPC_SVC_H */
432