xref: /illumos-gate/usr/src/uts/common/rpc/svc.h (revision ba2be53024c0b999e74ba9adcd7d80fec5df8c57)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 /* Copyright (c) 1983, 1984, 1985, 1986, 1987, 1988, 1989 AT&T */
26 /* All Rights Reserved */
27 /*
28  * Portions of this source code were derived from Berkeley
29  * 4.3 BSD under license from the Regents of the University of
30  * California.
31  */
32 
33 /*
34  * svc.h, Server-side remote procedure call interface.
35  */
36 
37 #ifndef	_RPC_SVC_H
38 #define	_RPC_SVC_H
39 
40 #pragma ident	"%Z%%M%	%I%	%E% SMI"
41 
42 #include <rpc/rpc_com.h>
43 #include <rpc/rpc_msg.h>
44 #include <sys/tihdr.h>
45 #include <sys/poll.h>
46 #include <sys/tsol/label.h>
47 
48 #ifdef	_KERNEL
49 #include <rpc/svc_auth.h>
50 #include <sys/callb.h>
51 #endif	/* _KERNEL */
52 
53 /*
54  * This interface must manage two items concerning remote procedure calling:
55  *
56  * 1) An arbitrary number of transport connections upon which rpc requests
57  * are received. They are created and registered by routines in svc_generic.c,
58  * svc_vc.c and svc_dg.c; they in turn call xprt_register and
59  * xprt_unregister.
60  *
61  * 2) An arbitrary number of locally registered services.  Services are
62  * described by the following four data: program number, version number,
63  * "service dispatch" function, a transport handle, and a boolean that
64  * indicates whether or not the exported program should be registered with a
65  * local binder service;  if true the program's number and version and the
66  * address from the transport handle are registered with the binder.
67  * These data are registered with rpcbind via svc_reg().
68  *
69  * A service's dispatch function is called whenever an rpc request comes in
70  * on a transport.  The request's program and version numbers must match
71  * those of the registered service.  The dispatch function is passed two
72  * parameters, struct svc_req * and SVCXPRT *, defined below.
73  */
74 
75 #ifdef __cplusplus
76 extern "C" {
77 #endif
78 
79 /*
80  * Server-side transport handles.
81  * The actual type definitions are below.
82  */
83 #ifdef	_KERNEL
84 typedef struct __svcmasterxprt	SVCMASTERXPRT;	/* Master transport handle */
85 typedef struct __svcxprt	SVCXPRT;	/* Per-thread clone handle */
86 typedef	struct __svcpool	SVCPOOL;	/* Kernel thread pool	   */
87 #else	/* _KERNEL */
88 typedef struct __svcxprt	SVCXPRT;	/* Server transport handle */
89 #endif	/* _KERNEL */
90 
91 /*
92  *  Prototype of error handler callback
93  */
94 #ifndef _KERNEL
95 typedef void (*svc_errorhandler_t)(const SVCXPRT* svc, const bool_t isAConn);
96 #endif
97 
98 /*
99  * Service request.
100  *
101  * PSARC 2003/523 Contract Private Interface
102  * svc_req
103  * Changes must be reviewed by Solaris File Sharing
104  * Changes must be communicated to contract-2003-523@sun.com
105  */
106 struct svc_req {
107 	rpcprog_t	rq_prog;	/* service program number */
108 	rpcvers_t	rq_vers;	/* service protocol version */
109 	rpcproc_t	rq_proc;	/* the desired procedure */
110 	struct opaque_auth rq_cred;	/* raw creds from the wire */
111 	caddr_t		rq_clntcred;	/* read only cooked cred */
112 	SVCXPRT		*rq_xprt;	/* associated transport */
113 	bslabel_t	*rq_label;	/* TSOL label of the request */
114 };
115 
116 #ifdef _KERNEL
117 struct dupreq {
118 	uint32_t	dr_xid;
119 	rpcproc_t	dr_proc;
120 	rpcvers_t	dr_vers;
121 	rpcprog_t	dr_prog;
122 	struct netbuf	dr_addr;
123 	struct netbuf	dr_resp;
124 	void		(*dr_resfree)();
125 	int		dr_status;
126 	struct dupreq	*dr_next;
127 	struct dupreq	*dr_chain;
128 };
129 
130 /*
131  * States of requests for duplicate request caching.
132  */
133 #define	DUP_NEW			0x00	/* new entry */
134 #define	DUP_INPROGRESS		0x01	/* request already going */
135 #define	DUP_DONE		0x02	/* request done */
136 #define	DUP_DROP		0x03	/* request dropped */
137 #define	DUP_ERROR		0x04	/* error in dup req cache */
138 
139 /*
140  * Prototype for a service dispatch routine.
141  */
142 typedef void (SVC_DISPATCH)(struct svc_req *, SVCXPRT *);
143 
144 /*
145  * The service provider callout.
146  * Each entry identifies a dispatch routine to be called
147  * for a given RPC program number and a version fitting
148  * into the registered range.
149  */
150 typedef struct {
151 	rpcprog_t	sc_prog;	/* RPC Program number */
152 	rpcvers_t	sc_versmin;	/* Min version number */
153 	rpcvers_t	sc_versmax;	/* Max version number */
154 	SVC_DISPATCH	*sc_dispatch;	/* Dispatch routine   */
155 } SVC_CALLOUT;
156 
157 /*
158  * Table of service provider `callouts' for an RPC
159  * transport handle. If sct_free is TRUE then transport
160  * destructor is supposed to deallocate this table.
161  */
162 typedef struct {
163 	size_t		sct_size;	/* Number of entries  */
164 	bool_t		sct_free;	/* Deallocate if true */
165 	SVC_CALLOUT	*sct_sc;	/* Callout entries    */
166 } SVC_CALLOUT_TABLE;
167 
168 struct svc_ops {
169 	bool_t	(*xp_recv)(SVCXPRT *, mblk_t *, struct rpc_msg *);
170 		/* receive incoming requests */
171 	bool_t	(*xp_getargs)(SVCXPRT *, xdrproc_t, caddr_t);
172 		/* get arguments */
173 	bool_t	(*xp_reply)(SVCXPRT *, struct rpc_msg *);
174 		/* send reply */
175 	bool_t	(*xp_freeargs)(SVCXPRT *, xdrproc_t, caddr_t);
176 		/* free mem allocated for args */
177 	void	(*xp_destroy)(SVCMASTERXPRT *);
178 		/* destroy this struct */
179 	int	(*xp_dup)(struct svc_req *, caddr_t, int,
180 				struct dupreq **, bool_t *);
181 		/* check for dup */
182 	void	(*xp_dupdone)(struct dupreq *, caddr_t, void (*)(), int, int);
183 		/* mark dup entry as completed */
184 	int32_t *(*xp_getres)(SVCXPRT *, int);
185 		/* get pointer to response buffer */
186 	void	(*xp_freeres)(SVCXPRT *);
187 		/* destroy pre-serialized response */
188 	void	(*xp_clone_destroy)(SVCXPRT *);
189 		/* destroy a clone xprt */
190 	void	(*xp_start)(SVCMASTERXPRT *);
191 		/* `ready-to-receive' */
192 };
193 #else	/* _KERNEL */
194 /*
195  *	Service control requests
196  */
197 #define	SVCGET_VERSQUIET	1
198 #define	SVCSET_VERSQUIET	2
199 #define	SVCGET_XID		4
200 #define	SVCSET_KEEPALIVE	5
201 #define	SVCSET_CONNMAXREC	6
202 #define	SVCGET_CONNMAXREC	7
203 #define	SVCGET_RECVERRHANDLER	8
204 #define	SVCSET_RECVERRHANDLER	9
205 
206 enum xprt_stat {
207 	XPRT_DIED,
208 	XPRT_MOREREQS,
209 	XPRT_IDLE
210 };
211 
212 struct xp_ops {
213 #ifdef	__STDC__
214 	bool_t	(*xp_recv)(SVCXPRT *, struct rpc_msg *);
215 		/* receive incoming requests */
216 	enum xprt_stat (*xp_stat)(SVCXPRT *);
217 		/* get transport status */
218 	bool_t	(*xp_getargs)(SVCXPRT *, xdrproc_t, caddr_t);
219 		/* get arguments */
220 	bool_t	(*xp_reply)(SVCXPRT *,	struct rpc_msg *);
221 		/* send reply */
222 	bool_t	(*xp_freeargs)(SVCXPRT *, xdrproc_t, caddr_t);
223 		/* free mem allocated for args */
224 	void	(*xp_destroy)(SVCXPRT *);
225 		/* destroy this struct */
226 	bool_t	(*xp_control)(SVCXPRT *, const uint_t,	void *);
227 		/* catch-all control function */
228 #else	/* __STDC__ */
229 	bool_t	(*xp_recv)(); /* receive incoming requests */
230 	enum xprt_stat (*xp_stat)(); /* get transport status */
231 	bool_t	(*xp_getargs)(); /* get arguments */
232 	bool_t	(*xp_reply)(); /* send reply */
233 	bool_t	(*xp_freeargs)(); /* free mem allocated for args */
234 	void	(*xp_destroy)(); /* destroy this struct */
235 	bool_t	(*xp_control)(); /* catch-all control function */
236 #endif	/* __STDC__ */
237 };
238 #endif	/* _KERNEL */
239 
240 #ifdef	_KERNEL
241 /*
242  * SVCPOOL
243  * Kernel RPC server-side thread pool structure.
244  */
245 typedef struct __svcxprt_qnode __SVCXPRT_QNODE;	/* Defined in svc.c */
246 
247 struct __svcpool {
248 	/*
249 	 * Thread pool variables.
250 	 *
251 	 * The pool's thread lock p_thread_lock protects:
252 	 * - p_threads, p_detached_threads, p_reserved_threads and p_closing
253 	 * The pool's request lock protects:
254 	 * - p_asleep, p_drowsy, p_reqs, p_walkers, p_req_cv.
255 	 * The following fields are `initialized constants':
256 	 * - p_id, p_stksize, p_timeout.
257 	 * Access to p_next and p_prev is protected by the pool
258 	 * list lock.
259 	 */
260 	SVCPOOL		*p_next;		/* Next pool in the list  */
261 	SVCPOOL		*p_prev;		/* Prev pool in the list  */
262 	int		p_id;			/* Pool id		  */
263 	int		p_threads;		/* Non-detached threads	  */
264 	int		p_detached_threads;	/* Detached threads	  */
265 	int		p_maxthreads;		/* Max threads in the pool */
266 	int		p_redline;		/* `Redline' for the pool */
267 	int		p_reserved_threads;	/* Reserved threads	  */
268 	kmutex_t	p_thread_lock;		/* Thread lock		  */
269 	int		p_asleep;		/* Asleep threads	  */
270 	int		p_drowsy;		/* Drowsy flag		  */
271 	kcondvar_t 	p_req_cv;		/* svc_poll() sleep var.  */
272 	clock_t		p_timeout;		/* svc_poll() timeout	  */
273 	kmutex_t	p_req_lock;		/* Request lock		  */
274 	int		p_reqs;			/* Pending requests	  */
275 	int		p_walkers;		/* Walking threads	  */
276 	int		p_max_same_xprt;	/* Max reqs from the xprt */
277 	int		p_stksize;		/* Stack size for svc_run */
278 	bool_t		p_closing : 1;		/* Pool is closing	  */
279 
280 	/*
281 	 * Thread creator variables.
282 	 * The `creator signaled' flag is turned on when a signal is send
283 	 * to the creator thread (to create a new service thread). The
284 	 * creator clears when the thread is created. The protocol is not
285 	 * to signal the creator thread when the flag is on. However,
286 	 * a new thread should signal the creator if there are more
287 	 * requests in the queue.
288 	 *
289 	 * When the pool is closing (ie it has been already unregistered from
290 	 * the pool list) the last thread on the last transport should turn
291 	 * the p_creator_exit flag on. This tells the creator thread to
292 	 * free the pool structure and exit.
293 	 */
294 	bool_t		p_creator_signaled : 1;	/* Create requested flag  */
295 	bool_t		p_creator_exit : 1;	/* If true creator exits  */
296 	kcondvar_t	p_creator_cv;		/* Creator cond. variable */
297 	kmutex_t	p_creator_lock;		/* Creator lock		  */
298 
299 	/*
300 	 * Doubly linked list containing `registered' master transport handles.
301 	 * There is no special structure for a list node. Instead the
302 	 * SVCMASTERXPRT structure has the xp_next and xp_prev fields.
303 	 *
304 	 * The p_lrwlock protects access to xprt->xp_next and xprt->xp_prev.
305 	 * A service thread should also acquire a reader lock before accessing
306 	 * any transports it is no longer linked to (to prevent them from
307 	 * being destroyed).
308 	 *
309 	 * The list lock governs also the `pool is closing' flag.
310 	 */
311 	size_t		p_lcount;		/* Current count	  */
312 	SVCMASTERXPRT	*p_lhead;		/* List head		  */
313 	krwlock_t	p_lrwlock;		/* R/W lock		  */
314 
315 	/*
316 	 * Circular linked list for the `xprt-ready' queue (FIFO).
317 	 * Must be initialized with svc_xprt_qinit() before it is used.
318 	 *
319 	 * The writer's end is protected by the pool's request lock
320 	 * (pool->p_req_lock). The reader's end is protected by q_end_lock.
321 	 *
322 	 * When the queue is full the p_qoverflow flag is raised. It stays
323 	 * on until all the pending request are drained.
324 	 */
325 	size_t		p_qsize;		/* Number of queue nodes  */
326 	int		p_qoverflow : 1;	/* Overflow flag	  */
327 	__SVCXPRT_QNODE *p_qbody;		/* Queue body (array)	  */
328 	__SVCXPRT_QNODE *p_qtop;		/* Writer's end of FIFO   */
329 	__SVCXPRT_QNODE *p_qend;		/* Reader's end of FIFO	  */
330 	kmutex_t	p_qend_lock;		/* Reader's end lock	  */
331 
332 	/*
333 	 * Userspace thread creator variables.
334 	 * Thread creation is actually done in userland, via a thread
335 	 * that is parked in the kernel. When that thread is signaled,
336 	 * it returns back down to the daemon from whence it came and
337 	 * does the lwp create.
338 	 *
339 	 * A parallel "creator" thread runs in the kernel. That is the
340 	 * thread that will signal for the user thread to return to
341 	 * userland and do its work.
342 	 *
343 	 * Since the thread doesn't always exist (there could be a race
344 	 * if two threads are created in rapid succession), we set
345 	 * p_signal_create_thread to FALSE when we're ready to accept work.
346 	 *
347 	 * p_user_exit is set to true when the service pool is about
348 	 * to close. This is done so that the user creation thread
349 	 * can be informed and cleanup any userland state.
350 	 */
351 
352 	bool_t		p_signal_create_thread : 1; /* Create requested flag  */
353 	bool_t		p_user_exit : 1;	/* If true creator exits  */
354 	bool_t		p_user_waiting : 1;	/* Thread waiting for work */
355 	kcondvar_t	p_user_cv;		/* Creator cond. variable */
356 	kmutex_t	p_user_lock;		/* Creator lock		  */
357 	void		(*p_offline)();		/* callout for unregister */
358 	void		(*p_shutdown)();	/* callout for shutdown */
359 };
360 
361 /*
362  * Server side transport handle (SVCMASTERXPRT).
363  * xprt->xp_req_lock governs the following fields in xprt:
364  *		xp_req_head, xp_req_tail.
365  * xprt->xp_thread_lock governs the following fields in xprt:
366  *		xp_threads, xp_detached_threads.
367  *
368  * xp_req_tail is only valid if xp_req_head is non-NULL
369  *
370  * The xp_threads count is the number of attached threads.  These threads
371  * are able to handle new requests, and it is expected that they will not
372  * block for a very long time handling a given request. The
373  * xp_detached_threads count is the number of threads that have detached
374  * themselves from the transport. These threads can block indefinitely
375  * while handling a request.  Once they complete the request, they exit.
376  *
377  * A kernel service provider may register a callback function "closeproc"
378  * for a transport.  When the transport is closing the last exiting attached
379  * thread - xp_threads goes to zero - it calls the callback function, passing
380  * it a reference to the transport.  This call is made with xp_thread_lock
381  * held, so any cleanup bookkeeping it does should be done quickly.
382  *
383  * When the transport is closing the last exiting thread is supposed
384  * to destroy/free the data structure.
385  */
386 typedef struct __svcxprt_common {
387 	struct file	*xpc_fp;
388 	struct svc_ops	*xpc_ops;
389 	queue_t		*xpc_wq;	/* queue to write onto		*/
390 	cred_t		*xpc_cred;	/* cached cred for server to use */
391 	int32_t		xpc_type;	/* transport type		*/
392 	int		xpc_msg_size;	/* TSDU or TIDU size		*/
393 	struct netbuf	xpc_rtaddr;	/* remote transport address	*/
394 	SVC_CALLOUT_TABLE *xpc_sct;
395 } __SVCXPRT_COMMON;
396 
397 #define	xp_fp		xp_xpc.xpc_fp
398 #define	xp_ops		xp_xpc.xpc_ops
399 #define	xp_wq		xp_xpc.xpc_wq
400 #define	xp_cred		xp_xpc.xpc_cred
401 #define	xp_type		xp_xpc.xpc_type
402 #define	xp_msg_size	xp_xpc.xpc_msg_size
403 #define	xp_rtaddr	xp_xpc.xpc_rtaddr
404 #define	xp_sct		xp_xpc.xpc_sct
405 
406 struct __svcmasterxprt {
407 	SVCMASTERXPRT 	*xp_next;	/* Next transport in the list	*/
408 	SVCMASTERXPRT 	*xp_prev;	/* Prev transport in the list	*/
409 	__SVCXPRT_COMMON xp_xpc;	/* Fields common with the clone	*/
410 	SVCPOOL		*xp_pool;	/* Pointer to the pool		*/
411 	mblk_t		*xp_req_head;	/* Request queue head		*/
412 	mblk_t		*xp_req_tail;	/* Request queue tail		*/
413 	kmutex_t	xp_req_lock;	/* Request lock			*/
414 	int		xp_threads;	/* Current num. of attached threads */
415 	int		xp_detached_threads; /* num. of detached threads */
416 	kmutex_t	xp_thread_lock;	/* Thread count lock		*/
417 	void		(*xp_closeproc)(const SVCMASTERXPRT *);
418 					/* optional; see comments above	*/
419 	char		*xp_netid;	/* network token		*/
420 	struct netbuf	xp_addrmask;	/* address mask			*/
421 
422 	caddr_t		xp_p2;		/* private: for use by svc ops  */
423 };
424 
425 /*
426  * Service thread `clone' transport handle (SVCXPRT)
427  *
428  * PSARC 2003/523 Contract Private Interface
429  * SVCXPRT
430  * Changes must be reviewed by Solaris File Sharing
431  * Changes must be communicated to contract-2003-523@sun.com
432  *
433  * The xp_p2buf buffer is used as the storage for a transport type
434  * specific structure. It is private for the svc ops for a given
435  * transport type.
436  */
437 
438 #define	SVC_P2LEN   64
439 
440 struct __svcxprt {
441 	__SVCXPRT_COMMON xp_xpc;
442 	SVCMASTERXPRT	*xp_master;	/* back ptr to master		*/
443 
444 	/* The following fileds are on a per-thread basis */
445 	callb_cpr_t	*xp_cprp;	/* unused padding for Contract	*/
446 	bool_t		xp_reserved : 1; /* is thread reserved?		*/
447 	bool_t		xp_detached : 1; /* is thread detached?		*/
448 	int		xp_same_xprt;	/* Reqs from the same xprt	*/
449 
450 	/* The following fields are used on a per-request basis */
451 	struct opaque_auth xp_verf;	/* raw response verifier	*/
452 	SVCAUTH		xp_auth;	/* auth flavor of current req	*/
453 	void		*xp_cookie;	/* a cookie			*/
454 	uint32_t	xp_xid;		/* id				*/
455 	XDR		xp_xdrin;	/* input xdr stream		*/
456 	XDR		xp_xdrout;	/* output xdr stream		*/
457 
458 	/* Private for svc ops */
459 	char		xp_p2buf[SVC_P2LEN]; /* udp_data or cots_data_t */
460 						/* or clone_rdma_data_t */
461 };
462 #else	/* _KERNEL */
463 struct __svcxprt {
464 	int		xp_fd;
465 #define	xp_sock		xp_fd
466 	ushort_t	xp_port;
467 	/*
468 	 * associated port number.
469 	 * Obsolete, but still used to
470 	 * specify whether rendezvouser
471 	 * or normal connection
472 	 */
473 	struct	xp_ops	*xp_ops;
474 	int		xp_addrlen;	/* length of remote addr. Obsoleted */
475 	char		*xp_tp;		/* transport provider device name */
476 	char		*xp_netid;	/* network token */
477 	struct netbuf	xp_ltaddr;	/* local transport address */
478 	struct netbuf	xp_rtaddr;	/* remote transport address */
479 	char		xp_raddr[16];	/* remote address. Now obsoleted */
480 	struct opaque_auth xp_verf;	/* raw response verifier */
481 	caddr_t		xp_p1;		/* private: for use by svc ops */
482 	caddr_t		xp_p2;		/* private: for use by svc ops */
483 	caddr_t		xp_p3;		/* private: for use by svc lib */
484 	int		xp_type;	/* transport type */
485 	/*
486 	 * callback on client death
487 	 * First parameter is the current structure,
488 	 * Second parameter :
489 	 *	- FALSE for the service listener
490 	 *	- TRUE for a real connected socket
491 	 */
492 	svc_errorhandler_t xp_closeclnt;
493 };
494 #endif	/* _KERNEL */
495 
496 /*
497  *  Approved way of getting address of caller,
498  *  address mask, and netid of transport.
499  */
500 #define	svc_getrpccaller(x) (&(x)->xp_rtaddr)
501 #ifdef _KERNEL
502 #define	svc_getcaller(x) (&(x)->xp_rtaddr.buf)
503 #define	svc_getaddrmask(x) (&(x)->xp_master->xp_addrmask)
504 #define	svc_getnetid(x) ((x)->xp_master->xp_netid)
505 #endif	/* _KERNEL */
506 
507 /*
508  * Operations defined on an SVCXPRT handle
509  */
510 
511 #ifdef	_KERNEL
512 #define	SVC_RECV(clone_xprt, mp, msg) \
513 	(*(clone_xprt)->xp_ops->xp_recv)((clone_xprt), (mp), (msg))
514 
515 /*
516  * PSARC 2003/523 Contract Private Interface
517  * SVC_GETARGS
518  * Changes must be reviewed by Solaris File Sharing
519  * Changes must be communicated to contract-2003-523@sun.com
520  */
521 #define	SVC_GETARGS(clone_xprt, xargs, argsp) \
522 	(*(clone_xprt)->xp_ops->xp_getargs)((clone_xprt), (xargs), (argsp))
523 
524 #define	SVC_REPLY(clone_xprt, msg) \
525 	(*(clone_xprt)->xp_ops->xp_reply) ((clone_xprt), (msg))
526 
527 #define	SVC_FREEARGS(clone_xprt, xargs, argsp) \
528 	(*(clone_xprt)->xp_ops->xp_freeargs)((clone_xprt), (xargs), (argsp))
529 
530 #define	SVC_GETRES(clone_xprt, size) \
531 	(*(clone_xprt)->xp_ops->xp_getres)((clone_xprt), (size))
532 
533 #define	SVC_FREERES(clone_xprt)	\
534 	(*(clone_xprt)->xp_ops->xp_freeres)(clone_xprt)
535 
536 #define	SVC_DESTROY(xprt) \
537 	(*(xprt)->xp_ops->xp_destroy)(xprt)
538 
539 /*
540  * PSARC 2003/523 Contract Private Interfaces
541  * SVC_DUP, SVC_DUPDONE, SVC_DUP_EXT, SVC_DUPDONE_EXT
542  * Changes must be reviewed by Solaris File Sharing
543  * Changes must be communicated to contract-2003-523@sun.com
544  *
545  * SVC_DUP and SVC_DUPDONE are defined here for backward compatibility.
546  */
547 #define	SVC_DUP_EXT(clone_xprt, req, res, size, drpp, dupcachedp) \
548 	(*(clone_xprt)->xp_ops->xp_dup)(req, res, size, drpp, dupcachedp)
549 
550 #define	SVC_DUPDONE_EXT(clone_xprt, dr, res, resfree, size, status) \
551 	(*(clone_xprt)->xp_ops->xp_dupdone)(dr, res, resfree, size, status)
552 
553 #define	SVC_DUP(clone_xprt, req, res, size, drpp) \
554 	(*(clone_xprt)->xp_ops->xp_dup)(req, res, size, drpp, NULL)
555 
556 #define	SVC_DUPDONE(clone_xprt, dr, res, size, status) \
557 	(*(clone_xprt)->xp_ops->xp_dupdone)(dr, res, NULL, size, status)
558 
559 #define	SVC_CLONE_DESTROY(clone_xprt) \
560 	(*(clone_xprt)->xp_ops->xp_clone_destroy)(clone_xprt)
561 
562 
563 #define	SVC_START(xprt) \
564 	(*(xprt)->xp_ops->xp_start)(xprt)
565 
566 #else	/* _KERNEL */
567 
568 #define	SVC_RECV(xprt, msg) \
569 	(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
570 #define	svc_recv(xprt, msg) \
571 	(*(xprt)->xp_ops->xp_recv)((xprt), (msg))
572 
573 #define	SVC_STAT(xprt) \
574 	(*(xprt)->xp_ops->xp_stat)(xprt)
575 #define	svc_stat(xprt) \
576 	(*(xprt)->xp_ops->xp_stat)(xprt)
577 
578 #define	SVC_GETARGS(xprt, xargs, argsp) \
579 	(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
580 #define	svc_getargs(xprt, xargs, argsp)	\
581 	(*(xprt)->xp_ops->xp_getargs)((xprt), (xargs), (argsp))
582 
583 #define	SVC_REPLY(xprt, msg) \
584 	(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
585 #define	svc_reply(xprt, msg) \
586 	(*(xprt)->xp_ops->xp_reply) ((xprt), (msg))
587 
588 #define	SVC_FREEARGS(xprt, xargs, argsp) \
589 	(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
590 #define	svc_freeargs(xprt, xargs, argsp) \
591 	(*(xprt)->xp_ops->xp_freeargs)((xprt), (xargs), (argsp))
592 
593 #define	SVC_GETRES(xprt, size) \
594 	(*(xprt)->xp_ops->xp_getres)((xprt), (size))
595 #define	svc_getres(xprt, size) \
596 	(*(xprt)->xp_ops->xp_getres)((xprt), (size))
597 
598 #define	SVC_FREERES(xprt) \
599 	(*(xprt)->xp_ops->xp_freeres)(xprt)
600 #define	svc_freeres(xprt) \
601 	(*(xprt)->xp_ops->xp_freeres)(xprt)
602 
603 #define	SVC_DESTROY(xprt) \
604 	(*(xprt)->xp_ops->xp_destroy)(xprt)
605 #define	svc_destroy(xprt) \
606 	(*(xprt)->xp_ops->xp_destroy)(xprt)
607 
608 /*
609  * PSARC 2003/523 Contract Private Interface
610  * SVC_CONTROL
611  * Changes must be reviewed by Solaris File Sharing
612  * Changes must be communicated to contract-2003-523@sun.com
613  */
614 #define	SVC_CONTROL(xprt, rq, in) \
615 	(*(xprt)->xp_ops->xp_control)((xprt), (rq), (in))
616 #endif	/* _KERNEL */
617 
618 /*
619  * Pool id's reserved for NFS, NLM, and the NFSv4 callback program.
620  */
621 #define	NFS_SVCPOOL_ID		0x01
622 #define	NLM_SVCPOOL_ID		0x02
623 #define	NFS_CB_SVCPOOL_ID	0x03
624 #define	RDC_SVCPOOL_ID		0x05	/* SNDR, PSARC 2001/699 */
625 
626 struct svcpool_args {
627 	uint32_t	id;		/* Pool id */
628 	uint32_t	maxthreads;	/* Max threads in the pool */
629 	uint32_t	redline;	/* `Redline' for the pool */
630 	uint32_t	qsize;		/* `xprt-ready' queue size */
631 	uint32_t	timeout;	/* svc_poll() timeout */
632 	uint32_t	stksize;	/* svc_run() stack size */
633 	uint32_t	max_same_xprt;	/* Max reqs from the same xprt */
634 };
635 
636 
637 #ifdef	_KERNEL
638 /*
639  * Transport registration and thread pool creation.
640  */
641 extern int	svc_xprt_register(SVCMASTERXPRT *, int);
642 extern void	svc_xprt_unregister(SVCMASTERXPRT *);
643 extern int	svc_pool_create(struct svcpool_args *);
644 extern int	svc_wait(int);
645 extern int	svc_do_run(int);
646 #define	SVCPSET_SHUTDOWN_PROC	1
647 #define	SVCPSET_UNREGISTER_PROC	2
648 extern int	svc_pool_control(int, int, void *);
649 #else	/* _KERNEL */
650 #ifdef	__STDC__
651 extern bool_t	rpc_reg(const rpcprog_t, const rpcvers_t, const rpcproc_t,
652 			char *(*)(char *), const xdrproc_t, const xdrproc_t,
653 			const char *);
654 
655 /*
656  * Service registration
657  *
658  * svc_reg(xprt, prog, vers, dispatch, nconf)
659  *	const SVCXPRT *xprt;
660  *	const rpcprog_t prog;
661  *	const rpcvers_t vers;
662  *	const void (*dispatch)();
663  *	const struct netconfig *nconf;
664  */
665 extern bool_t	svc_reg(const SVCXPRT *, const rpcprog_t, const rpcvers_t,
666 			void (*)(struct svc_req *, SVCXPRT *),
667 			const struct netconfig *);
668 
669 /*
670  * Service authentication registration
671  *
672  * svc_auth_reg(cred_flavor, handler)
673  *    int cred_flavor;
674  *    enum auth_stat (*handler)();
675  */
676 extern int	svc_auth_reg(int, enum auth_stat (*)());
677 
678 /*
679  * Service un-registration
680  *
681  * svc_unreg(prog, vers)
682  *	const rpcprog_t prog;
683  *	const rpcvers_t vers;
684  */
685 extern void	svc_unreg(const rpcprog_t, const rpcvers_t);
686 
687 /*
688  * Transport registration/unregistration.
689  *
690  * xprt_register(xprt)
691  *	const SVCXPRT *xprt;
692  *
693  * xprt_unregister(xprt)
694  *	const SVCXPRT *xprt;
695  */
696 extern void	xprt_register(const SVCXPRT *);
697 extern void	xprt_unregister(const SVCXPRT *);
698 #else	/* __STDC__ */
699 extern bool_t	rpc_reg();
700 extern bool_t	svc_reg();
701 extern bool_t	svc_auth_reg();
702 extern void	svc_unreg();
703 extern void	xprt_register();
704 extern void	xprt_unregister();
705 #endif /* __STDC__ */
706 #endif	/* _KERNEL */
707 
708 
709 /*
710  * When the service routine is called, it must first check to see if it
711  * knows about the procedure;  if not, it should call svcerr_noproc
712  * and return.  If so, it should deserialize its arguments via
713  * SVC_GETARGS (defined above).  If the deserialization does not work,
714  * svcerr_decode should be called followed by a return.  Successful
715  * decoding of the arguments should be followed the execution of the
716  * procedure's code and a call to svc_sendreply.
717  *
718  * Also, if the service refuses to execute the procedure due to too-
719  * weak authentication parameters, svcerr_weakauth should be called.
720  * Note: do not confuse access-control failure with weak authentication!
721  *
722  * NB: In pure implementations of rpc, the caller always waits for a reply
723  * msg.  This message is sent when svc_sendreply is called.
724  * Therefore pure service implementations should always call
725  * svc_sendreply even if the function logically returns void;  use
726  * xdr.h - xdr_void for the xdr routine.  HOWEVER, connectionful rpc allows
727  * for the abuse of pure rpc via batched calling or pipelining.  In the
728  * case of a batched call, svc_sendreply should NOT be called since
729  * this would send a return message, which is what batching tries to avoid.
730  * It is the service/protocol writer's responsibility to know which calls are
731  * batched and which are not.  Warning: responding to batch calls may
732  * deadlock the caller and server processes!
733  */
734 #ifdef	__STDC__
735 extern bool_t	svc_sendreply(const SVCXPRT *, const xdrproc_t,	const caddr_t);
736 extern void	svcerr_decode(const SVCXPRT *);
737 extern void	svcerr_weakauth(const SVCXPRT *);
738 extern void	svcerr_noproc(const SVCXPRT *);
739 extern void	svcerr_progvers(const SVCXPRT *, const rpcvers_t,
740     const rpcvers_t);
741 extern void	svcerr_auth(const SVCXPRT *, const enum auth_stat);
742 extern void	svcerr_noprog(const SVCXPRT *);
743 extern void	svcerr_systemerr(const SVCXPRT *);
744 #else	/* __STDC__ */
745 extern bool_t	svc_sendreply();
746 extern void	svcerr_decode();
747 extern void	svcerr_weakauth();
748 extern void	svcerr_noproc();
749 extern void	svcerr_progvers();
750 extern void	svcerr_auth();
751 extern void	svcerr_noprog();
752 extern void	svcerr_systemerr();
753 #endif	/* __STDC__ */
754 
755 #ifdef	_KERNEL
756 /*
757  * Kernel RPC functions.
758  */
759 extern void	svc_init(void);
760 extern void	svc_cots_init(void);
761 extern void	svc_clts_init(void);
762 extern void	mt_kstat_init(void);
763 extern void	mt_kstat_fini(void);
764 extern int	svc_tli_kcreate(struct file *, uint_t, char *,
765 				struct netbuf *, SVCMASTERXPRT **,
766 				SVC_CALLOUT_TABLE *,
767 				void (*closeproc)(const SVCMASTERXPRT *),
768 				int, bool_t);
769 extern int	svc_clts_kcreate(struct file *, uint_t, struct T_info_ack *,
770 				SVCMASTERXPRT **);
771 extern int	svc_cots_kcreate(struct file *, uint_t, struct T_info_ack *,
772 				SVCMASTERXPRT **);
773 extern void	svc_queuereq(queue_t *, mblk_t *);
774 extern void	svc_queueclean(queue_t *);
775 extern void	svc_queueclose(queue_t *);
776 extern int	svc_reserve_thread(SVCXPRT *);
777 extern void	svc_unreserve_thread(SVCXPRT *);
778 extern callb_cpr_t *svc_detach_thread(SVCXPRT *);
779 
780 /*
781  * For RDMA based kRPC.
782  * "rdma_xprt_record" is a reference to master transport handles
783  * in kRPC thread pools. This is an easy way of tracking and shuting
784  * down rdma based kRPC transports on demand.
785  * "rdma_xprt_group" is a list of RDMA based mster transport handles
786  * or records in a kRPC thread pool.
787  */
788 typedef struct rdma_xprt_record		rdma_xprt_record_t;
789 struct rdma_xprt_record {
790 	int			rtr_type;	/* Type of rdma; IB/VI/RDDP */
791 	SVCMASTERXPRT		*rtr_xprt_ptr;	/* Ptr to master xprt handle */
792 	rdma_xprt_record_t	*rtr_next;	/* Ptr to next record */
793 };
794 
795 typedef struct {
796 	int			rtg_count;	/* Number transport records */
797 	int			rtg_poolid;	/* Pool Id for this group */
798 	rdma_xprt_record_t	*rtg_listhead;	/* Head of the records list */
799 } rdma_xprt_group_t;
800 
801 extern int	svc_rdma_kcreate(char *, SVC_CALLOUT_TABLE *, int,
802 			rdma_xprt_group_t *);
803 extern void	svc_rdma_kstop(SVCMASTERXPRT *);
804 extern void	svc_rdma_kdestroy(SVCMASTERXPRT *);
805 extern void	rdma_stop(rdma_xprt_group_t);
806 
807 /*
808  * GSS cleanup method.
809  */
810 extern void	rpc_gss_cleanup(SVCXPRT *);
811 #else	/* _KERNEL */
812 /*
813  * Lowest level dispatching -OR- who owns this process anyway.
814  * Somebody has to wait for incoming requests and then call the correct
815  * service routine.  The routine svc_run does infinite waiting; i.e.,
816  * svc_run never returns.
817  * Since another (co-existant) package may wish to selectively wait for
818  * incoming calls or other events outside of the rpc architecture, the
819  * routine svc_getreq_poll is provided.  It must be passed pollfds, the
820  * "in-place" results of a poll call (see poll, section 2).
821  */
822 
823 /*
824  * Global keeper of rpc service descriptors in use
825  * dynamic; must be inspected before each call to select or poll
826  */
827 extern pollfd_t	*svc_pollfd;
828 extern int	svc_max_pollfd;
829 extern fd_set	svc_fdset;
830 #if !defined(_LP64) && FD_SETSIZE > 1024
831 extern fd_set	_new_svc_fdset;
832 #ifdef __PRAGMA_REDEFINE_EXTNAME
833 #pragma redefine_extname	svc_fdset	_new_svc_fdset
834 #else   /* __PRAGMA_REDEFINE_EXTNAME */
835 #define	svc_fdset	_new_svc_fdset
836 #endif  /* __PRAGMA_REDEFINE_EXTNAME */
837 #endif	/* LP64 && FD_SETSIZE > 1024 */
838 #define	svc_fds svc_fdset.fds_bits[0]	/* compatibility */
839 
840 /*
841  * A small program implemented by the svc_rpc implementation itself.
842  * Also see clnt.h for protocol numbers.
843  */
844 #ifdef __STDC__
845 extern void	svc_getreq(int);
846 extern void	svc_getreq_common(const int);
847 extern void	svc_getreqset(fd_set *); /* takes fdset instead of int */
848 extern void	svc_getreq_poll(struct pollfd *, const int);
849 extern void	svc_run(void);
850 extern void	svc_exit(void);
851 #else	/* __STDC__ */
852 extern void	rpctest_service();
853 extern void	svc_getreqset();
854 extern void	svc_getreq();
855 extern void	svc_getreq_common();
856 extern void	svc_getreqset();	 /* takes fdset instead of int */
857 extern void	svc_getreq_poll();
858 extern void	svc_run();
859 extern void	svc_exit();
860 #endif	/* __STDC__ */
861 
862 /*
863  *  Functions used to manage user file descriptors
864  */
865 typedef int svc_input_id_t;
866 typedef void (*svc_callback_t)(svc_input_id_t id, int fd,
867 				unsigned int events, void* cookie);
868 
869 #ifdef __STDC__
870 extern svc_input_id_t svc_add_input(int fd, unsigned int events,
871 				svc_callback_t user_callback,
872 				void* cookie);
873 extern int svc_remove_input(svc_input_id_t id);
874 #else	/* __STDC__ */
875 extern svc_input_id_t svc_add_input();
876 extern int	svc_remove_input();
877 #endif
878 
879 /*
880  * These are the existing service side transport implementations.
881  *
882  * Transport independent svc_create routine.
883  */
884 #ifdef __STDC__
885 extern int	svc_create(void (*)(struct svc_req *, SVCXPRT *),
886 				const rpcprog_t, const rpcvers_t,
887 				const char *);
888 	/*
889 	 * 	void (*dispatch)();		-- dispatch routine
890 	 *	const rpcprog_t prognum;	-- program number
891 	 *	const rpcvers_t versnum;	-- version number
892 	 *	const char *nettype;		-- network type
893 	 */
894 
895 /*
896  * Generic server creation routine. It takes a netconfig structure
897  * instead of a nettype.
898  */
899 extern SVCXPRT	*svc_tp_create(void (*)(struct svc_req *, SVCXPRT *),
900 				const rpcprog_t, const rpcvers_t,
901 				const struct netconfig *);
902 	/*
903 	 * void (*dispatch)();			-- dispatch routine
904 	 * const rpcprog_t prognum;		-- program number
905 	 * const rpcvers_t versnum;		-- version number
906 	 * const struct netconfig *nconf;	-- netconfig structure
907 	 */
908 
909 /*
910  * Generic TLI create routine
911  */
912 extern  SVCXPRT	*svc_tli_create(const int, const struct netconfig *,
913 				const struct t_bind *, const uint_t,
914 				const uint_t);
915 	/*
916 	 *	const int fd;			-- connection end point
917 	 *	const struct netconfig *nconf;	-- netconfig structure
918 	 *	const struct t_bind *bindaddr;	-- local bind address
919 	 *	const uint_t sendsz;		-- max sendsize
920 	 *	const uint_t recvsz;		-- max recvsize
921 	 */
922 
923 /*
924  * Connectionless and connectionful create routines.
925  */
926 extern SVCXPRT	*svc_vc_create(const int, const uint_t, const uint_t);
927 	/*
928 	 *	const int fd;			-- open connection end point
929 	 *	const uint_t sendsize;		-- max send size
930 	 *	const uint_t recvsize;		-- max recv size
931 	 */
932 
933 extern SVCXPRT	*svc_dg_create(const int, const uint_t, const uint_t);
934 	/*
935 	 * const int fd;			-- open connection
936 	 * const uint_t sendsize;		-- max send size
937 	 * const uint_t recvsize;		-- max recv size
938 	 */
939 
940 /*
941  * the routine takes any *open* TLI file
942  * descriptor as its first input and is used for open connections.
943  */
944 extern  SVCXPRT	*svc_fd_create(const int, const uint_t, const uint_t);
945 	/*
946 	 * 	const int fd;			-- open connection end point
947 	 * 	const uint_t sendsize;		-- max send size
948 	 * 	const uint_t recvsize;		-- max recv size
949 	 */
950 
951 /*
952  * Memory based rpc (for speed check and testing)
953  */
954 extern SVCXPRT	*svc_raw_create(void);
955 
956 /*
957  * Creation of service over doors transport.
958  */
959 extern SVCXPRT	*svc_door_create(void (*)(struct svc_req *, SVCXPRT *),
960 				const rpcprog_t, const rpcvers_t,
961 				const uint_t);
962 	/*
963 	 * 	void (*dispatch)();		-- dispatch routine
964 	 *	const rpcprog_t prognum;	-- program number
965 	 *	const rpcvers_t versnum;	-- version number
966 	 *	const uint_t sendsize;		-- send buffer size
967 	 */
968 
969 /*
970  * Service control interface
971  */
972 extern	bool_t	svc_control(SVCXPRT *, const uint_t, void *);
973 	/*
974 	 *	SVCXPRT *svc;			-- service to manipulate
975 	 *	const uint_t req;		-- request
976 	 *	void *info;			-- argument to request
977 	 */
978 
979 /*
980  * svc_dg_enable_cache() enables the cache on dg transports.
981  */
982 extern int svc_dg_enablecache(SVCXPRT *, const uint_t);
983 #else	/* __STDC__ */
984 extern int	svc_create();
985 extern SVCXPRT	*svc_tp_create();
986 extern SVCXPRT	*svc_tli_create();
987 extern SVCXPRT	*svc_vc_create();
988 extern SVCXPRT	*svc_dg_create();
989 extern SVCXPRT	*svc_fd_create();
990 extern SVCXPRT	*svc_raw_create();
991 extern SVCXPRT	*svc_door_create();
992 extern int svc_dg_enablecache();
993 #endif	/* __STDC__ */
994 
995 extern boolean_t is_multilevel(rpcprog_t);
996 
997 #ifdef	PORTMAP
998 /* For backward compatibility */
999 #include <rpc/svc_soc.h>
1000 #endif	/* PORTMAP */
1001 
1002 /*
1003  * For user level MT hot server functions
1004  */
1005 
1006 /*
1007  * Different MT modes
1008  */
1009 #define	RPC_SVC_MT_NONE		0	/* default, single-threaded */
1010 #define	RPC_SVC_MT_AUTO		1	/* automatic MT mode */
1011 #define	RPC_SVC_MT_USER		2	/* user MT mode */
1012 
1013 #ifdef	__STDC__
1014 extern void	svc_done(SVCXPRT *);
1015 #else
1016 extern void	svc_done();
1017 #endif	/* __STDC__ */
1018 
1019 /*
1020  * Obtaining local credentials.
1021  */
1022 typedef struct __svc_local_cred_t {
1023 	uid_t	euid;	/* effective uid */
1024 	gid_t	egid;	/* effective gid */
1025 	uid_t	ruid;	/* real uid */
1026 	gid_t	rgid;	/* real gid */
1027 	pid_t	pid;	/* caller's pid, or -1 if not available */
1028 } svc_local_cred_t;
1029 
1030 #ifdef __STDC__
1031 struct ucred_s;
1032 extern void	svc_fd_negotiate_ucred(int);
1033 extern int	svc_getcallerucred(const SVCXPRT *, struct ucred_s **);
1034 extern bool_t	svc_get_local_cred(SVCXPRT *, svc_local_cred_t *);
1035 #else
1036 extern void	svc_fd_negotiate_ucred();
1037 extern int	svc_getcallerucred();
1038 extern bool_t	svc_get_local_cred();
1039 #endif	/* __STDC__ */
1040 
1041 /*
1042  * Private interfaces and structures for user level duplicate request caching.
1043  * The interfaces and data structures are not committed and subject to
1044  * change in future releases. Currently only intended for use by automountd.
1045  */
1046 struct dupreq {
1047 	uint32_t	dr_xid;
1048 	rpcproc_t	dr_proc;
1049 	rpcvers_t	dr_vers;
1050 	rpcprog_t	dr_prog;
1051 	struct netbuf	dr_addr;
1052 	struct netbuf	dr_resp;
1053 	int		dr_status;
1054 	time_t		dr_time;
1055 	uint_t		dr_hash;
1056 	struct dupreq	*dr_next;
1057 	struct dupreq	*dr_prev;
1058 	struct dupreq	*dr_chain;
1059 	struct dupreq	*dr_prevchain;
1060 };
1061 
1062 /*
1063  * The fixedtime state is defined if we want to expand the routines to
1064  * handle and encompass fixed size caches.
1065  */
1066 #define	DUPCACHE_FIXEDTIME	0
1067 
1068 /*
1069  * States of requests for duplicate request caching.
1070  * These are the same as defined for the kernel.
1071  */
1072 #define	DUP_NEW			0x00	/* new entry */
1073 #define	DUP_INPROGRESS		0x01	/* request already going */
1074 #define	DUP_DONE		0x02	/* request done */
1075 #define	DUP_DROP		0x03	/* request dropped */
1076 #define	DUP_ERROR		0x04	/* error in dup req cache */
1077 
1078 #ifdef __STDC__
1079 extern bool_t	__svc_dupcache_init(void *, int, char **);
1080 extern int	__svc_dup(struct svc_req *, caddr_t *, uint_t *, char *);
1081 extern int	__svc_dupdone(struct svc_req *, caddr_t, uint_t, int, char *);
1082 extern bool_t	__svc_vc_dupcache_init(SVCXPRT *, void *, int);
1083 extern int	__svc_vc_dup(struct svc_req *, caddr_t *, uint_t *);
1084 extern int	__svc_vc_dupdone(struct svc_req *, caddr_t, uint_t, int);
1085 #else
1086 extern bool_t	__svc_dupcache_init();
1087 extern int	__svc_dup();
1088 extern int	__svc_dupdone();
1089 extern bool_t	__svc_vc_dupcache_init();
1090 extern int	__svc_vc_dup();
1091 extern int	__svc_vc_dupdone();
1092 #endif	/* __STDC__ */
1093 #endif	/* _KERNEL */
1094 
1095 #ifdef	__cplusplus
1096 }
1097 #endif
1098 
1099 #endif	/* !_RPC_SVC_H */
1100