2 * Copyright (c) 1999-2018 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
6 * Portions Copyright (c) 1999 Apple Computer, Inc. All Rights
7 * Reserved. This file contains Original Code and/or Modifications of
8 * Original Code as defined in and that are subject to the Apple Public
9 * Source License Version 1.1 (the "License"). You may not use this file
10 * except in compliance with the License. Please obtain a copy of the
11 * License at http://www.apple.com/publicsource and read it before using
14 * The Original Code and all software distributed under the License are
15 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
16 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
17 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE OR NON- INFRINGEMENT. Please see the
19 * License for the specific language governing rights and limitations
22 * @APPLE_LICENSE_HEADER_END@
25 * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
26 * unrestricted use provided that this legend is included on all tape
27 * media and as a part of the software program in whole or part. Users
28 * may copy or modify Sun RPC without charge, but are not authorized
29 * to license or distribute it to anyone else except as part of a product or
30 * program developed by the user.
32 * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
33 * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
34 * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
36 * Sun RPC is provided with no support and without any obligation on the
37 * part of Sun Microsystems, Inc. to assist in its use, correction,
38 * modification or enhancement.
40 * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
41 * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
42 * OR ANY PART THEREOF.
44 * In no event will Sun Microsystems, Inc. be liable for any lost revenue
45 * or profits or other special, indirect and consequential damages, even if
46 * Sun has been advised of the possibility of such damages.
48 * Sun Microsystems, Inc.
50 * Mountain View, California 94043
53 #if defined(LIBC_SCCS) && !defined(lint)
54 /*static char *sccsid = "from: @(#)svc.c 1.44 88/02/08 Copyr 1984 Sun Micro";*/
55 /*static char *sccsid = "from: @(#)svc.c 2.4 88/08/11 4.0 RPCSRC";*/
56 static char *rcsid
= "$Id: svc.c,v 1.4 2002/02/19 20:36:24 epeyton Exp $";
60 * svc.c, Server-side remote procedure call interface.
62 * There are two sets of procedures here. The xprt routines are
63 * for handling transport handles. The svc routines handle the
64 * list of service routines.
66 * Copyright (C) 1984, Sun Microsystems, Inc.
69 #include "libinfo_common.h"
73 #include <sys/errno.h>
75 #include <rpc/pmap_clnt.h>
79 static SVCXPRT
**xports
;
81 #define NULL_SVC ((struct svc_callout *)0)
82 #define RQCRED_SIZE 400 /* this size is excessive */
84 #define max(a, b) (a > b ? a : b)
88 * Each entry represents a set of procedures (an rpc program).
89 * The dispatch routine takes request structs and runs the
90 * apropriate procedure.
92 static struct svc_callout
{
93 struct svc_callout
*sc_next
;
101 void (*sc_dispatch
)();
104 static struct svc_callout
*svc_find();
106 /* *************** SVCXPRT related stuff **************** */
108 extern int svc_maxfd
;
111 * Activate a transport handle.
118 register int sock
= xprt
->xp_sock
;
120 if (xports
== NULL
) {
121 xports
= (SVCXPRT
**)
122 mem_alloc(FD_SETSIZE
* sizeof(SVCXPRT
*));
124 if (sock
< FD_SETSIZE
) {
126 FD_SET(sock
, &svc_fdset
);
127 svc_maxfd
= max(svc_maxfd
, sock
);
132 * De-activate a transport handle.
136 xprt_unregister(xprt
)
139 register int sock
= xprt
->xp_sock
;
141 if ((sock
< FD_SETSIZE
) && (xports
[sock
] == xprt
)) {
142 xports
[sock
] = (SVCXPRT
*)0;
143 FD_CLR(sock
, &svc_fdset
);
144 if (sock
== svc_maxfd
) {
145 for (svc_maxfd
--; svc_maxfd
>=0; svc_maxfd
--)
146 if (xports
[svc_maxfd
])
153 /* ********************** CALLOUT list related stuff ************* */
156 * Add a service program to the callout list.
157 * The dispatch routine will be called when a rpc request for this
158 * program number comes in.
162 svc_register(xprt
, prog
, vers
, dispatch
, protocol
)
177 struct svc_callout
*prev
;
178 register struct svc_callout
*s
;
180 if ((s
= svc_find(prog
, vers
, &prev
)) != NULL_SVC
) {
181 if (s
->sc_dispatch
== dispatch
)
182 goto pmap_it
; /* he is registering another xptr */
185 s
= (struct svc_callout
*)mem_alloc(sizeof(struct svc_callout
));
186 if (s
== (struct svc_callout
*)0) {
191 s
->sc_dispatch
= dispatch
;
192 s
->sc_next
= svc_head
;
195 /* now register the information with the local binder service */
197 return (pmap_set(prog
, vers
, protocol
, xprt
->xp_port
));
203 * Remove a service program from the callout list.
207 svc_unregister(prog
, vers
)
216 struct svc_callout
*prev
;
217 register struct svc_callout
*s
;
219 if ((s
= svc_find(prog
, vers
, &prev
)) == NULL_SVC
)
221 if (prev
== NULL_SVC
) {
222 svc_head
= s
->sc_next
;
224 prev
->sc_next
= s
->sc_next
;
226 s
->sc_next
= NULL_SVC
;
227 mem_free((char *) s
, (u_int
) sizeof(struct svc_callout
));
228 /* now unregister the information with the local binder service */
229 (void)pmap_unset(prog
, vers
);
233 * Search the callout list for a program number, return the callout
236 static struct svc_callout
*
237 svc_find(prog
, vers
, prev
)
245 struct svc_callout
**prev
;
247 register struct svc_callout
*s
, *p
;
250 for (s
= svc_head
; s
!= NULL_SVC
; s
= s
->sc_next
) {
251 if ((s
->sc_prog
== prog
) && (s
->sc_vers
== vers
))
260 /* ******************* REPLY GENERATION ROUTINES ************ */
263 * Send a reply to an rpc request
267 svc_sendreply(xprt
, xdr_results
, xdr_location
)
268 register SVCXPRT
*xprt
;
269 xdrproc_t xdr_results
;
270 caddr_t xdr_location
;
274 rply
.rm_direction
= REPLY
;
275 rply
.rm_reply
.rp_stat
= MSG_ACCEPTED
;
276 rply
.acpted_rply
.ar_verf
= xprt
->xp_verf
;
277 rply
.acpted_rply
.ar_stat
= SUCCESS
;
278 rply
.acpted_rply
.ar_results
.where
= xdr_location
;
279 rply
.acpted_rply
.ar_results
.proc
= xdr_results
;
280 return (SVC_REPLY(xprt
, &rply
));
284 * No procedure error reply
289 register SVCXPRT
*xprt
;
293 rply
.rm_direction
= REPLY
;
294 rply
.rm_reply
.rp_stat
= MSG_ACCEPTED
;
295 rply
.acpted_rply
.ar_verf
= xprt
->xp_verf
;
296 rply
.acpted_rply
.ar_stat
= PROC_UNAVAIL
;
297 SVC_REPLY(xprt
, &rply
);
301 * Can't decode args error reply
306 register SVCXPRT
*xprt
;
310 rply
.rm_direction
= REPLY
;
311 rply
.rm_reply
.rp_stat
= MSG_ACCEPTED
;
312 rply
.acpted_rply
.ar_verf
= xprt
->xp_verf
;
313 rply
.acpted_rply
.ar_stat
= GARBAGE_ARGS
;
314 SVC_REPLY(xprt
, &rply
);
322 svcerr_systemerr(xprt
)
323 register SVCXPRT
*xprt
;
327 rply
.rm_direction
= REPLY
;
328 rply
.rm_reply
.rp_stat
= MSG_ACCEPTED
;
329 rply
.acpted_rply
.ar_verf
= xprt
->xp_verf
;
330 rply
.acpted_rply
.ar_stat
= SYSTEM_ERR
;
331 SVC_REPLY(xprt
, &rply
);
335 * Authentication error reply
339 svcerr_auth(xprt
, why
)
345 rply
.rm_direction
= REPLY
;
346 rply
.rm_reply
.rp_stat
= MSG_DENIED
;
347 rply
.rjcted_rply
.rj_stat
= AUTH_ERROR
;
348 rply
.rjcted_rply
.rj_why
= why
;
349 SVC_REPLY(xprt
, &rply
);
353 * Auth too weak error reply
357 svcerr_weakauth(xprt
)
361 svcerr_auth(xprt
, AUTH_TOOWEAK
);
365 * Program unavailable error reply
370 register SVCXPRT
*xprt
;
374 rply
.rm_direction
= REPLY
;
375 rply
.rm_reply
.rp_stat
= MSG_ACCEPTED
;
376 rply
.acpted_rply
.ar_verf
= xprt
->xp_verf
;
377 rply
.acpted_rply
.ar_stat
= PROG_UNAVAIL
;
378 SVC_REPLY(xprt
, &rply
);
382 * Program version mismatch error reply
386 svcerr_progvers(xprt
, low_vers
, high_vers
)
388 register SVCXPRT
*xprt
;
392 register SVCXPRT
*xprt
;
399 rply
.rm_direction
= REPLY
;
400 rply
.rm_reply
.rp_stat
= MSG_ACCEPTED
;
401 rply
.acpted_rply
.ar_verf
= xprt
->xp_verf
;
402 rply
.acpted_rply
.ar_stat
= PROG_MISMATCH
;
403 rply
.acpted_rply
.ar_vers
.low
= low_vers
;
404 rply
.acpted_rply
.ar_vers
.high
= high_vers
;
405 SVC_REPLY(xprt
, &rply
);
408 /* ******************* SERVER INPUT STUFF ******************* */
411 * Get server side input from some transport.
413 * Statement of authentication parameters management:
414 * This function owns and manages all authentication parameters, specifically
415 * the "raw" parameters (msg.rm_call.cb_cred and msg.rm_call.cb_verf) and
416 * the "cooked" credentials (rqst->rq_clntcred).
417 * However, this function does not know the structure of the cooked
418 * credentials, so it make the following assumptions:
419 * a) the structure is contiguous (no pointers), and
420 * b) the cred structure size does not exceed RQCRED_SIZE bytes.
421 * In all events, all three parameters are freed upon exit from this routine.
422 * The storage is trivially management on the call stack in user land, but
423 * is mallocated in kernel land.
434 readfds
.fds_bits
[0] = rdfds
;
435 svc_getreqset(&readfds
);
440 svc_getreqset(readfds
)
454 register SVCXPRT
*xprt
;
456 register uint32_t mask
;
458 register u_long mask
;
462 register uint32_t *maskp
;
464 register u_long
*maskp
;
467 char cred_area
[2*MAX_AUTH_BYTES
+ RQCRED_SIZE
];
468 msg
.rm_call
.cb_cred
.oa_base
= cred_area
;
469 msg
.rm_call
.cb_verf
.oa_base
= &(cred_area
[MAX_AUTH_BYTES
]);
470 r
.rq_clntcred
= &(cred_area
[2*MAX_AUTH_BYTES
]);
473 maskp
= (uint32_t *)readfds
->fds_bits
;
475 maskp
= (u_long
*)readfds
->fds_bits
;
477 for (sock
= 0; sock
<= svc_maxfd
; sock
+= NFDBITS
) {
478 for (mask
= *maskp
++; (bit
= ffs(mask
)); mask
^= (1 << (bit
- 1))) {
479 if ((sock
+ bit
) > (svc_maxfd
+ 1))
480 /* if we're past our sockets */
482 /* sock has input waiting */
483 xprt
= xports
[sock
+ bit
- 1];
485 /* But do we control sock? */
487 /* now receive msgs from xprtprt (support batch calls) */
489 if (SVC_RECV(xprt
, &msg
)) {
491 /* now find the exported program and call it */
492 register struct svc_callout
*s
;
496 r
.rq_prog
= msg
.rm_call
.cb_prog
;
497 r
.rq_vers
= msg
.rm_call
.cb_vers
;
498 r
.rq_proc
= msg
.rm_call
.cb_proc
;
499 r
.rq_cred
= msg
.rm_call
.cb_cred
;
500 /* first authenticate the message */
501 if ((why
= _authenticate(&r
, &msg
)) != AUTH_OK
) {
502 svcerr_auth(xprt
, why
);
505 /* now match message with a registered service*/
509 for (s
= svc_head
; s
!= NULL_SVC
; s
= s
->sc_next
) {
510 if (s
->sc_prog
== r
.rq_prog
) {
511 if (s
->sc_vers
== r
.rq_vers
) {
512 (*s
->sc_dispatch
)(&r
, xprt
);
514 } /* found correct version */
516 if (s
->sc_vers
< low_vers
)
517 low_vers
= s
->sc_vers
;
518 if (s
->sc_vers
> high_vers
)
519 high_vers
= s
->sc_vers
;
520 } /* found correct program */
523 * if we got here, the program or version
527 svcerr_progvers(xprt
,
528 low_vers
, high_vers
);
531 /* Fall through to ... */
534 if ((stat
= SVC_STAT(xprt
)) == XPRT_DIED
){
538 } while (stat
== XPRT_MOREREQS
);