FreeBSD/Linux Kernel Cross Reference
sys/rpc/clnt_vc.c
1 /* $NetBSD: clnt_vc.c,v 1.4 2000/07/14 08:40:42 fvdl Exp $ */
2
3 /*-
4 * Copyright (c) 2009, Sun Microsystems, Inc.
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions are met:
9 * - Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright notice,
12 * this list of conditions and the following disclaimer in the documentation
13 * and/or other materials provided with the distribution.
14 * - Neither the name of Sun Microsystems, Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived
16 * from this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #if defined(LIBC_SCCS) && !defined(lint)
32 static char *sccsid2 = "@(#)clnt_tcp.c 1.37 87/10/05 Copyr 1984 Sun Micro";
33 static char *sccsid = "@(#)clnt_tcp.c 2.2 88/08/01 4.0 RPCSRC";
34 static char sccsid3[] = "@(#)clnt_vc.c 1.19 89/03/16 Copyr 1988 Sun Micro";
35 #endif
36 #include <sys/cdefs.h>
37 __FBSDID("$FreeBSD$");
38
39 /*
40 * clnt_tcp.c, Implements a TCP/IP based, client side RPC.
41 *
42 * Copyright (C) 1984, Sun Microsystems, Inc.
43 *
44 * TCP based RPC supports 'batched calls'.
45 * A sequence of calls may be batched-up in a send buffer. The rpc call
46 * return immediately to the client even though the call was not necessarily
47 * sent. The batching occurs if the results' xdr routine is NULL (0) AND
48 * the rpc timeout value is zero (see clnt.h, rpc).
49 *
50 * Clients should NOT casually batch calls that in fact return results; that is,
51 * the server side should be aware that a call is batched and not produce any
52 * return message. Batched calls that produce many result messages can
53 * deadlock (netlock) the client and the server....
54 *
55 * Now go hang yourself.
56 */
57
58 #include <sys/param.h>
59 #include <sys/systm.h>
60 #include <sys/lock.h>
61 #include <sys/malloc.h>
62 #include <sys/mbuf.h>
63 #include <sys/mutex.h>
64 #include <sys/pcpu.h>
65 #include <sys/proc.h>
66 #include <sys/protosw.h>
67 #include <sys/socket.h>
68 #include <sys/socketvar.h>
69 #include <sys/sx.h>
70 #include <sys/syslog.h>
71 #include <sys/time.h>
72 #include <sys/uio.h>
73
74 #include <net/vnet.h>
75
76 #include <netinet/tcp.h>
77
78 #include <rpc/rpc.h>
79 #include <rpc/rpc_com.h>
80 #include <rpc/krpc.h>
81
82 struct cmessage {
83 struct cmsghdr cmsg;
84 struct cmsgcred cmcred;
85 };
86
87 static enum clnt_stat clnt_vc_call(CLIENT *, struct rpc_callextra *,
88 rpcproc_t, struct mbuf *, struct mbuf **, struct timeval);
89 static void clnt_vc_geterr(CLIENT *, struct rpc_err *);
90 static bool_t clnt_vc_freeres(CLIENT *, xdrproc_t, void *);
91 static void clnt_vc_abort(CLIENT *);
92 static bool_t clnt_vc_control(CLIENT *, u_int, void *);
93 static void clnt_vc_close(CLIENT *);
94 static void clnt_vc_destroy(CLIENT *);
95 static bool_t time_not_ok(struct timeval *);
96 static int clnt_vc_soupcall(struct socket *so, void *arg, int waitflag);
97
98 static struct clnt_ops clnt_vc_ops = {
99 .cl_call = clnt_vc_call,
100 .cl_abort = clnt_vc_abort,
101 .cl_geterr = clnt_vc_geterr,
102 .cl_freeres = clnt_vc_freeres,
103 .cl_close = clnt_vc_close,
104 .cl_destroy = clnt_vc_destroy,
105 .cl_control = clnt_vc_control
106 };
107
108 static void clnt_vc_upcallsdone(struct ct_data *);
109
110 /*
111 * Create a client handle for a connection.
112 * Default options are set, which the user can change using clnt_control()'s.
113 * The rpc/vc package does buffering similar to stdio, so the client
114 * must pick send and receive buffer sizes, 0 => use the default.
115 * NB: fd is copied into a private area.
116 * NB: The rpch->cl_auth is set null authentication. Caller may wish to
117 * set this something more useful.
118 *
119 * fd should be an open socket
120 */
121 CLIENT *
122 clnt_vc_create(
123 struct socket *so, /* open file descriptor */
124 struct sockaddr *raddr, /* servers address */
125 const rpcprog_t prog, /* program number */
126 const rpcvers_t vers, /* version number */
127 size_t sendsz, /* buffer recv size */
128 size_t recvsz, /* buffer send size */
129 int intrflag) /* interruptible */
130 {
131 CLIENT *cl; /* client handle */
132 struct ct_data *ct = NULL; /* client handle */
133 struct timeval now;
134 struct rpc_msg call_msg;
135 static uint32_t disrupt;
136 struct __rpc_sockinfo si;
137 XDR xdrs;
138 int error, interrupted, one = 1, sleep_flag;
139 struct sockopt sopt;
140
141 if (disrupt == 0)
142 disrupt = (uint32_t)(long)raddr;
143
144 cl = (CLIENT *)mem_alloc(sizeof (*cl));
145 ct = (struct ct_data *)mem_alloc(sizeof (*ct));
146
147 mtx_init(&ct->ct_lock, "ct->ct_lock", NULL, MTX_DEF);
148 ct->ct_threads = 0;
149 ct->ct_closing = FALSE;
150 ct->ct_closed = FALSE;
151 ct->ct_upcallrefs = 0;
152
153 if ((so->so_state & (SS_ISCONNECTED|SS_ISCONFIRMING)) == 0) {
154 error = soconnect(so, raddr, curthread);
155 SOCK_LOCK(so);
156 interrupted = 0;
157 sleep_flag = PSOCK;
158 if (intrflag != 0)
159 sleep_flag |= (PCATCH | PBDRY);
160 while ((so->so_state & SS_ISCONNECTING)
161 && so->so_error == 0) {
162 error = msleep(&so->so_timeo, SOCK_MTX(so),
163 sleep_flag, "connec", 0);
164 if (error) {
165 if (error == EINTR || error == ERESTART)
166 interrupted = 1;
167 break;
168 }
169 }
170 if (error == 0) {
171 error = so->so_error;
172 so->so_error = 0;
173 }
174 SOCK_UNLOCK(so);
175 if (error) {
176 if (!interrupted)
177 so->so_state &= ~SS_ISCONNECTING;
178 rpc_createerr.cf_stat = RPC_SYSTEMERROR;
179 rpc_createerr.cf_error.re_errno = error;
180 goto err;
181 }
182 }
183
184 if (!__rpc_socket2sockinfo(so, &si)) {
185 goto err;
186 }
187
188 if (so->so_proto->pr_flags & PR_CONNREQUIRED) {
189 bzero(&sopt, sizeof(sopt));
190 sopt.sopt_dir = SOPT_SET;
191 sopt.sopt_level = SOL_SOCKET;
192 sopt.sopt_name = SO_KEEPALIVE;
193 sopt.sopt_val = &one;
194 sopt.sopt_valsize = sizeof(one);
195 sosetopt(so, &sopt);
196 }
197
198 if (so->so_proto->pr_protocol == IPPROTO_TCP) {
199 bzero(&sopt, sizeof(sopt));
200 sopt.sopt_dir = SOPT_SET;
201 sopt.sopt_level = IPPROTO_TCP;
202 sopt.sopt_name = TCP_NODELAY;
203 sopt.sopt_val = &one;
204 sopt.sopt_valsize = sizeof(one);
205 sosetopt(so, &sopt);
206 }
207
208 ct->ct_closeit = FALSE;
209
210 /*
211 * Set up private data struct
212 */
213 ct->ct_socket = so;
214 ct->ct_wait.tv_sec = -1;
215 ct->ct_wait.tv_usec = -1;
216 memcpy(&ct->ct_addr, raddr, raddr->sa_len);
217
218 /*
219 * Initialize call message
220 */
221 getmicrotime(&now);
222 ct->ct_xid = ((uint32_t)++disrupt) ^ __RPC_GETXID(&now);
223 call_msg.rm_xid = ct->ct_xid;
224 call_msg.rm_direction = CALL;
225 call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;
226 call_msg.rm_call.cb_prog = (uint32_t)prog;
227 call_msg.rm_call.cb_vers = (uint32_t)vers;
228
229 /*
230 * pre-serialize the static part of the call msg and stash it away
231 */
232 xdrmem_create(&xdrs, ct->ct_mcallc, MCALL_MSG_SIZE,
233 XDR_ENCODE);
234 if (! xdr_callhdr(&xdrs, &call_msg)) {
235 if (ct->ct_closeit) {
236 soclose(ct->ct_socket);
237 }
238 goto err;
239 }
240 ct->ct_mpos = XDR_GETPOS(&xdrs);
241 XDR_DESTROY(&xdrs);
242 ct->ct_waitchan = "rpcrecv";
243 ct->ct_waitflag = 0;
244
245 /*
246 * Create a client handle which uses xdrrec for serialization
247 * and authnone for authentication.
248 */
249 sendsz = __rpc_get_t_size(si.si_af, si.si_proto, (int)sendsz);
250 recvsz = __rpc_get_t_size(si.si_af, si.si_proto, (int)recvsz);
251 error = soreserve(ct->ct_socket, sendsz, recvsz);
252 if (error != 0) {
253 if (ct->ct_closeit) {
254 soclose(ct->ct_socket);
255 }
256 goto err;
257 }
258 cl->cl_refs = 1;
259 cl->cl_ops = &clnt_vc_ops;
260 cl->cl_private = ct;
261 cl->cl_auth = authnone_create();
262
263 SOCKBUF_LOCK(&ct->ct_socket->so_rcv);
264 soupcall_set(ct->ct_socket, SO_RCV, clnt_vc_soupcall, ct);
265 SOCKBUF_UNLOCK(&ct->ct_socket->so_rcv);
266
267 ct->ct_record = NULL;
268 ct->ct_record_resid = 0;
269 TAILQ_INIT(&ct->ct_pending);
270 return (cl);
271
272 err:
273 mtx_destroy(&ct->ct_lock);
274 mem_free(ct, sizeof (struct ct_data));
275 mem_free(cl, sizeof (CLIENT));
276
277 return ((CLIENT *)NULL);
278 }
279
280 static enum clnt_stat
281 clnt_vc_call(
282 CLIENT *cl, /* client handle */
283 struct rpc_callextra *ext, /* call metadata */
284 rpcproc_t proc, /* procedure number */
285 struct mbuf *args, /* pointer to args */
286 struct mbuf **resultsp, /* pointer to results */
287 struct timeval utimeout)
288 {
289 struct ct_data *ct = (struct ct_data *) cl->cl_private;
290 AUTH *auth;
291 struct rpc_err *errp;
292 enum clnt_stat stat;
293 XDR xdrs;
294 struct rpc_msg reply_msg;
295 bool_t ok;
296 int nrefreshes = 2; /* number of times to refresh cred */
297 struct timeval timeout;
298 uint32_t xid;
299 struct mbuf *mreq = NULL, *results;
300 struct ct_request *cr;
301 int error;
302
303 cr = malloc(sizeof(struct ct_request), M_RPC, M_WAITOK);
304
305 mtx_lock(&ct->ct_lock);
306
307 if (ct->ct_closing || ct->ct_closed) {
308 mtx_unlock(&ct->ct_lock);
309 free(cr, M_RPC);
310 return (RPC_CANTSEND);
311 }
312 ct->ct_threads++;
313
314 if (ext) {
315 auth = ext->rc_auth;
316 errp = &ext->rc_err;
317 } else {
318 auth = cl->cl_auth;
319 errp = &ct->ct_error;
320 }
321
322 cr->cr_mrep = NULL;
323 cr->cr_error = 0;
324
325 if (ct->ct_wait.tv_usec == -1) {
326 timeout = utimeout; /* use supplied timeout */
327 } else {
328 timeout = ct->ct_wait; /* use default timeout */
329 }
330
331 call_again:
332 mtx_assert(&ct->ct_lock, MA_OWNED);
333
334 ct->ct_xid++;
335 xid = ct->ct_xid;
336
337 mtx_unlock(&ct->ct_lock);
338
339 /*
340 * Leave space to pre-pend the record mark.
341 */
342 MGETHDR(mreq, M_WAIT, MT_DATA);
343 mreq->m_data += sizeof(uint32_t);
344 KASSERT(ct->ct_mpos + sizeof(uint32_t) <= MHLEN,
345 ("RPC header too big"));
346 bcopy(ct->ct_mcallc, mreq->m_data, ct->ct_mpos);
347 mreq->m_len = ct->ct_mpos;
348
349 /*
350 * The XID is the first thing in the request.
351 */
352 *mtod(mreq, uint32_t *) = htonl(xid);
353
354 xdrmbuf_create(&xdrs, mreq, XDR_ENCODE);
355
356 errp->re_status = stat = RPC_SUCCESS;
357
358 if ((! XDR_PUTINT32(&xdrs, &proc)) ||
359 (! AUTH_MARSHALL(auth, xid, &xdrs,
360 m_copym(args, 0, M_COPYALL, M_WAITOK)))) {
361 errp->re_status = stat = RPC_CANTENCODEARGS;
362 mtx_lock(&ct->ct_lock);
363 goto out;
364 }
365 mreq->m_pkthdr.len = m_length(mreq, NULL);
366
367 /*
368 * Prepend a record marker containing the packet length.
369 */
370 M_PREPEND(mreq, sizeof(uint32_t), M_WAIT);
371 *mtod(mreq, uint32_t *) =
372 htonl(0x80000000 | (mreq->m_pkthdr.len - sizeof(uint32_t)));
373
374 cr->cr_xid = xid;
375 mtx_lock(&ct->ct_lock);
376 /*
377 * Check to see if the other end has already started to close down
378 * the connection. The upcall will have set ct_error.re_status
379 * to RPC_CANTRECV if this is the case.
380 * If the other end starts to close down the connection after this
381 * point, it will be detected later when cr_error is checked,
382 * since the request is in the ct_pending queue.
383 */
384 if (ct->ct_error.re_status == RPC_CANTRECV) {
385 if (errp != &ct->ct_error) {
386 errp->re_errno = ct->ct_error.re_errno;
387 errp->re_status = RPC_CANTRECV;
388 }
389 stat = RPC_CANTRECV;
390 goto out;
391 }
392 TAILQ_INSERT_TAIL(&ct->ct_pending, cr, cr_link);
393 mtx_unlock(&ct->ct_lock);
394
395 /*
396 * sosend consumes mreq.
397 */
398 error = sosend(ct->ct_socket, NULL, NULL, mreq, NULL, 0, curthread);
399 mreq = NULL;
400 if (error == EMSGSIZE) {
401 SOCKBUF_LOCK(&ct->ct_socket->so_snd);
402 sbwait(&ct->ct_socket->so_snd);
403 SOCKBUF_UNLOCK(&ct->ct_socket->so_snd);
404 AUTH_VALIDATE(auth, xid, NULL, NULL);
405 mtx_lock(&ct->ct_lock);
406 TAILQ_REMOVE(&ct->ct_pending, cr, cr_link);
407 goto call_again;
408 }
409
410 reply_msg.acpted_rply.ar_verf.oa_flavor = AUTH_NULL;
411 reply_msg.acpted_rply.ar_verf.oa_base = cr->cr_verf;
412 reply_msg.acpted_rply.ar_verf.oa_length = 0;
413 reply_msg.acpted_rply.ar_results.where = NULL;
414 reply_msg.acpted_rply.ar_results.proc = (xdrproc_t)xdr_void;
415
416 mtx_lock(&ct->ct_lock);
417 if (error) {
418 TAILQ_REMOVE(&ct->ct_pending, cr, cr_link);
419 errp->re_errno = error;
420 errp->re_status = stat = RPC_CANTSEND;
421 goto out;
422 }
423
424 /*
425 * Check to see if we got an upcall while waiting for the
426 * lock. In both these cases, the request has been removed
427 * from ct->ct_pending.
428 */
429 if (cr->cr_error) {
430 TAILQ_REMOVE(&ct->ct_pending, cr, cr_link);
431 errp->re_errno = cr->cr_error;
432 errp->re_status = stat = RPC_CANTRECV;
433 goto out;
434 }
435 if (cr->cr_mrep) {
436 TAILQ_REMOVE(&ct->ct_pending, cr, cr_link);
437 goto got_reply;
438 }
439
440 /*
441 * Hack to provide rpc-based message passing
442 */
443 if (timeout.tv_sec == 0 && timeout.tv_usec == 0) {
444 TAILQ_REMOVE(&ct->ct_pending, cr, cr_link);
445 errp->re_status = stat = RPC_TIMEDOUT;
446 goto out;
447 }
448
449 error = msleep(cr, &ct->ct_lock, ct->ct_waitflag, ct->ct_waitchan,
450 tvtohz(&timeout));
451
452 TAILQ_REMOVE(&ct->ct_pending, cr, cr_link);
453
454 if (error) {
455 /*
456 * The sleep returned an error so our request is still
457 * on the list. Turn the error code into an
458 * appropriate client status.
459 */
460 errp->re_errno = error;
461 switch (error) {
462 case EINTR:
463 case ERESTART:
464 stat = RPC_INTR;
465 break;
466 case EWOULDBLOCK:
467 stat = RPC_TIMEDOUT;
468 break;
469 default:
470 stat = RPC_CANTRECV;
471 }
472 errp->re_status = stat;
473 goto out;
474 } else {
475 /*
476 * We were woken up by the upcall. If the
477 * upcall had a receive error, report that,
478 * otherwise we have a reply.
479 */
480 if (cr->cr_error) {
481 errp->re_errno = cr->cr_error;
482 errp->re_status = stat = RPC_CANTRECV;
483 goto out;
484 }
485 }
486
487 got_reply:
488 /*
489 * Now decode and validate the response. We need to drop the
490 * lock since xdr_replymsg may end up sleeping in malloc.
491 */
492 mtx_unlock(&ct->ct_lock);
493
494 if (ext && ext->rc_feedback)
495 ext->rc_feedback(FEEDBACK_OK, proc, ext->rc_feedback_arg);
496
497 xdrmbuf_create(&xdrs, cr->cr_mrep, XDR_DECODE);
498 ok = xdr_replymsg(&xdrs, &reply_msg);
499 cr->cr_mrep = NULL;
500
501 if (ok) {
502 if ((reply_msg.rm_reply.rp_stat == MSG_ACCEPTED) &&
503 (reply_msg.acpted_rply.ar_stat == SUCCESS))
504 errp->re_status = stat = RPC_SUCCESS;
505 else
506 stat = _seterr_reply(&reply_msg, errp);
507
508 if (stat == RPC_SUCCESS) {
509 results = xdrmbuf_getall(&xdrs);
510 if (!AUTH_VALIDATE(auth, xid,
511 &reply_msg.acpted_rply.ar_verf,
512 &results)) {
513 errp->re_status = stat = RPC_AUTHERROR;
514 errp->re_why = AUTH_INVALIDRESP;
515 } else {
516 KASSERT(results,
517 ("auth validated but no result"));
518 *resultsp = results;
519 }
520 } /* end successful completion */
521 /*
522 * If unsuccesful AND error is an authentication error
523 * then refresh credentials and try again, else break
524 */
525 else if (stat == RPC_AUTHERROR)
526 /* maybe our credentials need to be refreshed ... */
527 if (nrefreshes > 0 &&
528 AUTH_REFRESH(auth, &reply_msg)) {
529 nrefreshes--;
530 XDR_DESTROY(&xdrs);
531 mtx_lock(&ct->ct_lock);
532 goto call_again;
533 }
534 /* end of unsuccessful completion */
535 } /* end of valid reply message */
536 else {
537 errp->re_status = stat = RPC_CANTDECODERES;
538 }
539 XDR_DESTROY(&xdrs);
540 mtx_lock(&ct->ct_lock);
541 out:
542 mtx_assert(&ct->ct_lock, MA_OWNED);
543
544 KASSERT(stat != RPC_SUCCESS || *resultsp,
545 ("RPC_SUCCESS without reply"));
546
547 if (mreq)
548 m_freem(mreq);
549 if (cr->cr_mrep)
550 m_freem(cr->cr_mrep);
551
552 ct->ct_threads--;
553 if (ct->ct_closing)
554 wakeup(ct);
555
556 mtx_unlock(&ct->ct_lock);
557
558 if (auth && stat != RPC_SUCCESS)
559 AUTH_VALIDATE(auth, xid, NULL, NULL);
560
561 free(cr, M_RPC);
562
563 return (stat);
564 }
565
566 static void
567 clnt_vc_geterr(CLIENT *cl, struct rpc_err *errp)
568 {
569 struct ct_data *ct = (struct ct_data *) cl->cl_private;
570
571 *errp = ct->ct_error;
572 }
573
574 static bool_t
575 clnt_vc_freeres(CLIENT *cl, xdrproc_t xdr_res, void *res_ptr)
576 {
577 XDR xdrs;
578 bool_t dummy;
579
580 xdrs.x_op = XDR_FREE;
581 dummy = (*xdr_res)(&xdrs, res_ptr);
582
583 return (dummy);
584 }
585
586 /*ARGSUSED*/
587 static void
588 clnt_vc_abort(CLIENT *cl)
589 {
590 }
591
592 static bool_t
593 clnt_vc_control(CLIENT *cl, u_int request, void *info)
594 {
595 struct ct_data *ct = (struct ct_data *)cl->cl_private;
596 void *infop = info;
597 SVCXPRT *xprt;
598
599 mtx_lock(&ct->ct_lock);
600
601 switch (request) {
602 case CLSET_FD_CLOSE:
603 ct->ct_closeit = TRUE;
604 mtx_unlock(&ct->ct_lock);
605 return (TRUE);
606 case CLSET_FD_NCLOSE:
607 ct->ct_closeit = FALSE;
608 mtx_unlock(&ct->ct_lock);
609 return (TRUE);
610 default:
611 break;
612 }
613
614 /* for other requests which use info */
615 if (info == NULL) {
616 mtx_unlock(&ct->ct_lock);
617 return (FALSE);
618 }
619 switch (request) {
620 case CLSET_TIMEOUT:
621 if (time_not_ok((struct timeval *)info)) {
622 mtx_unlock(&ct->ct_lock);
623 return (FALSE);
624 }
625 ct->ct_wait = *(struct timeval *)infop;
626 break;
627 case CLGET_TIMEOUT:
628 *(struct timeval *)infop = ct->ct_wait;
629 break;
630 case CLGET_SERVER_ADDR:
631 (void) memcpy(info, &ct->ct_addr, (size_t)ct->ct_addr.ss_len);
632 break;
633 case CLGET_SVC_ADDR:
634 /*
635 * Slightly different semantics to userland - we use
636 * sockaddr instead of netbuf.
637 */
638 memcpy(info, &ct->ct_addr, ct->ct_addr.ss_len);
639 break;
640 case CLSET_SVC_ADDR: /* set to new address */
641 mtx_unlock(&ct->ct_lock);
642 return (FALSE);
643 case CLGET_XID:
644 *(uint32_t *)info = ct->ct_xid;
645 break;
646 case CLSET_XID:
647 /* This will set the xid of the NEXT call */
648 /* decrement by 1 as clnt_vc_call() increments once */
649 ct->ct_xid = *(uint32_t *)info - 1;
650 break;
651 case CLGET_VERS:
652 /*
653 * This RELIES on the information that, in the call body,
654 * the version number field is the fifth field from the
655 * begining of the RPC header. MUST be changed if the
656 * call_struct is changed
657 */
658 *(uint32_t *)info =
659 ntohl(*(uint32_t *)(void *)(ct->ct_mcallc +
660 4 * BYTES_PER_XDR_UNIT));
661 break;
662
663 case CLSET_VERS:
664 *(uint32_t *)(void *)(ct->ct_mcallc +
665 4 * BYTES_PER_XDR_UNIT) =
666 htonl(*(uint32_t *)info);
667 break;
668
669 case CLGET_PROG:
670 /*
671 * This RELIES on the information that, in the call body,
672 * the program number field is the fourth field from the
673 * begining of the RPC header. MUST be changed if the
674 * call_struct is changed
675 */
676 *(uint32_t *)info =
677 ntohl(*(uint32_t *)(void *)(ct->ct_mcallc +
678 3 * BYTES_PER_XDR_UNIT));
679 break;
680
681 case CLSET_PROG:
682 *(uint32_t *)(void *)(ct->ct_mcallc +
683 3 * BYTES_PER_XDR_UNIT) =
684 htonl(*(uint32_t *)info);
685 break;
686
687 case CLSET_WAITCHAN:
688 ct->ct_waitchan = (const char *)info;
689 break;
690
691 case CLGET_WAITCHAN:
692 *(const char **) info = ct->ct_waitchan;
693 break;
694
695 case CLSET_INTERRUPTIBLE:
696 if (*(int *) info)
697 ct->ct_waitflag = PCATCH | PBDRY;
698 else
699 ct->ct_waitflag = 0;
700 break;
701
702 case CLGET_INTERRUPTIBLE:
703 if (ct->ct_waitflag)
704 *(int *) info = TRUE;
705 else
706 *(int *) info = FALSE;
707 break;
708
709 case CLSET_BACKCHANNEL:
710 xprt = (SVCXPRT *)info;
711 if (ct->ct_backchannelxprt == NULL) {
712 xprt->xp_p2 = ct;
713 ct->ct_backchannelxprt = xprt;
714 }
715 break;
716
717 default:
718 mtx_unlock(&ct->ct_lock);
719 return (FALSE);
720 }
721
722 mtx_unlock(&ct->ct_lock);
723 return (TRUE);
724 }
725
726 static void
727 clnt_vc_close(CLIENT *cl)
728 {
729 struct ct_data *ct = (struct ct_data *) cl->cl_private;
730 struct ct_request *cr;
731
732 mtx_lock(&ct->ct_lock);
733
734 if (ct->ct_closed) {
735 mtx_unlock(&ct->ct_lock);
736 return;
737 }
738
739 if (ct->ct_closing) {
740 while (ct->ct_closing)
741 msleep(ct, &ct->ct_lock, 0, "rpcclose", 0);
742 KASSERT(ct->ct_closed, ("client should be closed"));
743 mtx_unlock(&ct->ct_lock);
744 return;
745 }
746
747 if (ct->ct_socket) {
748 ct->ct_closing = TRUE;
749 mtx_unlock(&ct->ct_lock);
750
751 SOCKBUF_LOCK(&ct->ct_socket->so_rcv);
752 soupcall_clear(ct->ct_socket, SO_RCV);
753 clnt_vc_upcallsdone(ct);
754 SOCKBUF_UNLOCK(&ct->ct_socket->so_rcv);
755
756 /*
757 * Abort any pending requests and wait until everyone
758 * has finished with clnt_vc_call.
759 */
760 mtx_lock(&ct->ct_lock);
761 TAILQ_FOREACH(cr, &ct->ct_pending, cr_link) {
762 cr->cr_xid = 0;
763 cr->cr_error = ESHUTDOWN;
764 wakeup(cr);
765 }
766
767 while (ct->ct_threads)
768 msleep(ct, &ct->ct_lock, 0, "rpcclose", 0);
769 }
770
771 ct->ct_closing = FALSE;
772 ct->ct_closed = TRUE;
773 mtx_unlock(&ct->ct_lock);
774 wakeup(ct);
775 }
776
777 static void
778 clnt_vc_destroy(CLIENT *cl)
779 {
780 struct ct_data *ct = (struct ct_data *) cl->cl_private;
781 struct socket *so = NULL;
782 SVCXPRT *xprt;
783
784 clnt_vc_close(cl);
785
786 mtx_lock(&ct->ct_lock);
787 xprt = ct->ct_backchannelxprt;
788 ct->ct_backchannelxprt = NULL;
789 if (xprt != NULL) {
790 mtx_unlock(&ct->ct_lock); /* To avoid a LOR. */
791 sx_xlock(&xprt->xp_lock);
792 mtx_lock(&ct->ct_lock);
793 xprt->xp_p2 = NULL;
794 xprt_unregister(xprt);
795 }
796
797 if (ct->ct_socket) {
798 if (ct->ct_closeit) {
799 so = ct->ct_socket;
800 }
801 }
802
803 mtx_unlock(&ct->ct_lock);
804 if (xprt != NULL) {
805 sx_xunlock(&xprt->xp_lock);
806 SVC_RELEASE(xprt);
807 }
808
809 mtx_destroy(&ct->ct_lock);
810 if (so) {
811 soshutdown(so, SHUT_WR);
812 soclose(so);
813 }
814 mem_free(ct, sizeof(struct ct_data));
815 if (cl->cl_netid && cl->cl_netid[0])
816 mem_free(cl->cl_netid, strlen(cl->cl_netid) +1);
817 if (cl->cl_tp && cl->cl_tp[0])
818 mem_free(cl->cl_tp, strlen(cl->cl_tp) +1);
819 mem_free(cl, sizeof(CLIENT));
820 }
821
822 /*
823 * Make sure that the time is not garbage. -1 value is disallowed.
824 * Note this is different from time_not_ok in clnt_dg.c
825 */
826 static bool_t
827 time_not_ok(struct timeval *t)
828 {
829 return (t->tv_sec <= -1 || t->tv_sec > 100000000 ||
830 t->tv_usec <= -1 || t->tv_usec > 1000000);
831 }
832
833 int
834 clnt_vc_soupcall(struct socket *so, void *arg, int waitflag)
835 {
836 struct ct_data *ct = (struct ct_data *) arg;
837 struct uio uio;
838 struct mbuf *m, *m2;
839 struct ct_request *cr;
840 int error, rcvflag, foundreq;
841 uint32_t xid_plus_direction[2], header;
842 bool_t do_read;
843 SVCXPRT *xprt;
844 struct cf_conn *cd;
845
846 CTASSERT(sizeof(xid_plus_direction) == 2 * sizeof(uint32_t));
847 ct->ct_upcallrefs++;
848 uio.uio_td = curthread;
849 do {
850 /*
851 * If ct_record_resid is zero, we are waiting for a
852 * record mark.
853 */
854 if (ct->ct_record_resid == 0) {
855
856 /*
857 * Make sure there is either a whole record
858 * mark in the buffer or there is some other
859 * error condition
860 */
861 do_read = FALSE;
862 if (so->so_rcv.sb_cc >= sizeof(uint32_t)
863 || (so->so_rcv.sb_state & SBS_CANTRCVMORE)
864 || so->so_error)
865 do_read = TRUE;
866
867 if (!do_read)
868 break;
869
870 SOCKBUF_UNLOCK(&so->so_rcv);
871 uio.uio_resid = sizeof(uint32_t);
872 m = NULL;
873 rcvflag = MSG_DONTWAIT | MSG_SOCALLBCK;
874 error = soreceive(so, NULL, &uio, &m, NULL, &rcvflag);
875 SOCKBUF_LOCK(&so->so_rcv);
876
877 if (error == EWOULDBLOCK)
878 break;
879
880 /*
881 * If there was an error, wake up all pending
882 * requests.
883 */
884 if (error || uio.uio_resid > 0) {
885 wakeup_all:
886 mtx_lock(&ct->ct_lock);
887 if (!error) {
888 /*
889 * We must have got EOF trying
890 * to read from the stream.
891 */
892 error = ECONNRESET;
893 }
894 ct->ct_error.re_status = RPC_CANTRECV;
895 ct->ct_error.re_errno = error;
896 TAILQ_FOREACH(cr, &ct->ct_pending, cr_link) {
897 cr->cr_error = error;
898 wakeup(cr);
899 }
900 mtx_unlock(&ct->ct_lock);
901 break;
902 }
903 m_copydata(m, 0, sizeof(uint32_t), (char *)&header);
904 header = ntohl(header);
905 ct->ct_record = NULL;
906 ct->ct_record_resid = header & 0x7fffffff;
907 ct->ct_record_eor = ((header & 0x80000000) != 0);
908 m_freem(m);
909 } else {
910 /*
911 * Wait until the socket has the whole record
912 * buffered.
913 */
914 do_read = FALSE;
915 if (so->so_rcv.sb_cc >= ct->ct_record_resid
916 || (so->so_rcv.sb_state & SBS_CANTRCVMORE)
917 || so->so_error)
918 do_read = TRUE;
919
920 if (!do_read)
921 break;
922
923 /*
924 * We have the record mark. Read as much as
925 * the socket has buffered up to the end of
926 * this record.
927 */
928 SOCKBUF_UNLOCK(&so->so_rcv);
929 uio.uio_resid = ct->ct_record_resid;
930 m = NULL;
931 rcvflag = MSG_DONTWAIT | MSG_SOCALLBCK;
932 error = soreceive(so, NULL, &uio, &m, NULL, &rcvflag);
933 SOCKBUF_LOCK(&so->so_rcv);
934
935 if (error == EWOULDBLOCK)
936 break;
937
938 if (error || uio.uio_resid == ct->ct_record_resid)
939 goto wakeup_all;
940
941 /*
942 * If we have part of the record already,
943 * chain this bit onto the end.
944 */
945 if (ct->ct_record)
946 m_last(ct->ct_record)->m_next = m;
947 else
948 ct->ct_record = m;
949
950 ct->ct_record_resid = uio.uio_resid;
951
952 /*
953 * If we have the entire record, see if we can
954 * match it to a request.
955 */
956 if (ct->ct_record_resid == 0
957 && ct->ct_record_eor) {
958 /*
959 * The XID is in the first uint32_t of
960 * the reply and the message direction
961 * is the second one.
962 */
963 if (ct->ct_record->m_len <
964 sizeof(xid_plus_direction) &&
965 m_length(ct->ct_record, NULL) <
966 sizeof(xid_plus_direction)) {
967 m_freem(ct->ct_record);
968 break;
969 }
970 m_copydata(ct->ct_record, 0,
971 sizeof(xid_plus_direction),
972 (char *)xid_plus_direction);
973 xid_plus_direction[0] =
974 ntohl(xid_plus_direction[0]);
975 xid_plus_direction[1] =
976 ntohl(xid_plus_direction[1]);
977 /* Check message direction. */
978 if (xid_plus_direction[1] == CALL) {
979 /* This is a backchannel request. */
980 mtx_lock(&ct->ct_lock);
981 xprt = ct->ct_backchannelxprt;
982 if (xprt == NULL) {
983 mtx_unlock(&ct->ct_lock);
984 /* Just throw it away. */
985 m_freem(ct->ct_record);
986 ct->ct_record = NULL;
987 } else {
988 cd = (struct cf_conn *)
989 xprt->xp_p1;
990 m2 = cd->mreq;
991 /*
992 * The requests are chained
993 * in the m_nextpkt list.
994 */
995 while (m2 != NULL &&
996 m2->m_nextpkt != NULL)
997 /* Find end of list. */
998 m2 = m2->m_nextpkt;
999 if (m2 != NULL)
1000 m2->m_nextpkt =
1001 ct->ct_record;
1002 else
1003 cd->mreq =
1004 ct->ct_record;
1005 ct->ct_record->m_nextpkt =
1006 NULL;
1007 ct->ct_record = NULL;
1008 xprt_active(xprt);
1009 mtx_unlock(&ct->ct_lock);
1010 }
1011 } else {
1012 mtx_lock(&ct->ct_lock);
1013 foundreq = 0;
1014 TAILQ_FOREACH(cr, &ct->ct_pending,
1015 cr_link) {
1016 if (cr->cr_xid ==
1017 xid_plus_direction[0]) {
1018 /*
1019 * This one
1020 * matches. We leave
1021 * the reply mbuf in
1022 * cr->cr_mrep. Set
1023 * the XID to zero so
1024 * that we will ignore
1025 * any duplicated
1026 * replies.
1027 */
1028 cr->cr_xid = 0;
1029 cr->cr_mrep =
1030 ct->ct_record;
1031 cr->cr_error = 0;
1032 foundreq = 1;
1033 wakeup(cr);
1034 break;
1035 }
1036 }
1037 mtx_unlock(&ct->ct_lock);
1038
1039 if (!foundreq)
1040 m_freem(ct->ct_record);
1041 ct->ct_record = NULL;
1042 }
1043 }
1044 }
1045 } while (m);
1046 ct->ct_upcallrefs--;
1047 if (ct->ct_upcallrefs < 0)
1048 panic("rpcvc upcall refcnt");
1049 if (ct->ct_upcallrefs == 0)
1050 wakeup(&ct->ct_upcallrefs);
1051 return (SU_OK);
1052 }
1053
1054 /*
1055 * Wait for all upcalls in progress to complete.
1056 */
1057 static void
1058 clnt_vc_upcallsdone(struct ct_data *ct)
1059 {
1060
1061 SOCKBUF_LOCK_ASSERT(&ct->ct_socket->so_rcv);
1062
1063 while (ct->ct_upcallrefs > 0)
1064 (void) msleep(&ct->ct_upcallrefs,
1065 SOCKBUF_MTX(&ct->ct_socket->so_rcv), 0, "rpcvcup", 0);
1066 }
Cache object: d92f39e2e53d2f131506c9b0e575a587
|