2 * clnt_unix.c, Implements a TCP/IP based, client side RPC.
4 * Copyright (c) 2010, Oracle America, Inc.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions are
10 * * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * * Redistributions in binary form must reproduce the above
13 * copyright notice, this list of conditions and the following
14 * disclaimer in the documentation and/or other materials
15 * provided with the distribution.
16 * * Neither the name of the "Oracle America, Inc." nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
24 * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
25 * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
27 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 * TCP based RPC supports 'batched calls'.
34 * A sequence of calls may be batched-up in a send buffer. The rpc call
35 * return immediately to the client even though the call was not necessarily
36 * sent. The batching occurs if the results' xdr routine is NULL (0) AND
37 * the rpc timeout value is zero (see clnt.h, rpc).
39 * Clients should NOT casually batch calls that in fact return results; that is,
40 * the server side should be aware that a call is batched and not produce any
41 * return message. Batched calls that produce many result messages can
42 * deadlock (netlock) the client and the server....
44 * Now go hang yourself.
55 #include <sys/socket.h>
56 #include <rpc/pmap_clnt.h>
59 extern u_long
_create_xid (void);
61 #define MCALL_MSG_SIZE 24
67 struct timeval ct_wait
;
68 bool_t ct_waitset
; /* wait set by clnt_control? */
69 struct sockaddr_un ct_addr
;
70 struct rpc_err ct_error
;
71 char ct_mcall
[MCALL_MSG_SIZE
]; /* marshalled callmsg */
72 u_int ct_mpos
; /* pos after marshal */
76 static int readunix (char *, char *, int);
77 static int writeunix (char *, char *, int);
79 static enum clnt_stat
clntunix_call (CLIENT
*, u_long
, xdrproc_t
, caddr_t
,
80 xdrproc_t
, caddr_t
, struct timeval
);
81 static void clntunix_abort (void);
82 static void clntunix_geterr (CLIENT
*, struct rpc_err
*);
83 static bool_t
clntunix_freeres (CLIENT
*, xdrproc_t
, caddr_t
);
84 static bool_t
clntunix_control (CLIENT
*, int, char *);
85 static void clntunix_destroy (CLIENT
*);
87 static const struct clnt_ops unix_ops
=
98 * Create a client handle for a tcp/ip connection.
99 * If *sockp<0, *sockp is set to a newly created TCP socket and it is
100 * connected to raddr. If *sockp non-negative then
101 * raddr is ignored. The rpc/tcp package does buffering
102 * similar to stdio, so the client must pick send and receive buffer sizes,];
103 * 0 => use the default.
104 * If raddr->sin_port is 0, then a binder on the remote machine is
105 * consulted for the right port number.
106 * NB: *sockp is copied into a private area.
107 * NB: It is the clients responsibility to close *sockp.
108 * NB: The rpch->cl_auth is set null authentication. Caller may wish to set this
109 * something more useful.
112 clntunix_create (struct sockaddr_un
*raddr
, u_long prog
, u_long vers
,
113 int *sockp
, u_int sendsz
, u_int recvsz
)
116 struct ct_data
*ct
= (struct ct_data
*) mem_alloc (sizeof (*ct
));
117 struct rpc_msg call_msg
;
120 h
= (CLIENT
*) mem_alloc (sizeof (*h
));
121 if (h
== NULL
|| ct
== NULL
)
123 struct rpc_createerr
*ce
= &get_rpc_createerr ();
124 (void) __fxprintf (NULL
, "%s: %s", __func__
, _("out of memory\n"));
125 ce
->cf_stat
= RPC_SYSTEMERROR
;
126 ce
->cf_error
.re_errno
= ENOMEM
;
131 * If no socket given, open one
135 *sockp
= __socket (AF_UNIX
, SOCK_STREAM
, 0);
136 len
= strlen (raddr
->sun_path
) + sizeof (raddr
->sun_family
) + 1;
138 || __connect (*sockp
, (struct sockaddr
*) raddr
, len
) < 0)
140 struct rpc_createerr
*ce
= &get_rpc_createerr ();
141 ce
->cf_stat
= RPC_SYSTEMERROR
;
142 ce
->cf_error
.re_errno
= errno
;
147 ct
->ct_closeit
= TRUE
;
151 ct
->ct_closeit
= FALSE
;
155 * Set up private data struct
157 ct
->ct_sock
= *sockp
;
158 ct
->ct_wait
.tv_usec
= 0;
159 ct
->ct_waitset
= FALSE
;
160 ct
->ct_addr
= *raddr
;
163 * Initialize call message
165 call_msg
.rm_xid
= _create_xid ();
166 call_msg
.rm_direction
= CALL
;
167 call_msg
.rm_call
.cb_rpcvers
= RPC_MSG_VERSION
;
168 call_msg
.rm_call
.cb_prog
= prog
;
169 call_msg
.rm_call
.cb_vers
= vers
;
172 * pre-serialize the static part of the call msg and stash it away
174 xdrmem_create (&(ct
->ct_xdrs
), ct
->ct_mcall
, MCALL_MSG_SIZE
, XDR_ENCODE
);
175 if (!xdr_callhdr (&(ct
->ct_xdrs
), &call_msg
))
181 ct
->ct_mpos
= XDR_GETPOS (&(ct
->ct_xdrs
));
182 XDR_DESTROY (&(ct
->ct_xdrs
));
185 * Create a client handle which uses xdrrec for serialization
186 * and authnone for authentication.
188 xdrrec_create (&(ct
->ct_xdrs
), sendsz
, recvsz
,
189 (caddr_t
) ct
, readunix
, writeunix
);
190 h
->cl_ops
= (struct clnt_ops
*) &unix_ops
;
191 h
->cl_private
= (caddr_t
) ct
;
192 h
->cl_auth
= authnone_create ();
197 * Something goofed, free stuff and barf
199 mem_free ((caddr_t
) ct
, sizeof (struct ct_data
));
200 mem_free ((caddr_t
) h
, sizeof (CLIENT
));
201 return (CLIENT
*) NULL
;
203 libc_hidden_nolink_sunrpc (clntunix_create
, GLIBC_2_1
)
205 static enum clnt_stat
206 clntunix_call (CLIENT
*h
, u_long proc
, xdrproc_t xdr_args
, caddr_t args_ptr
,
207 xdrproc_t xdr_results
, caddr_t results_ptr
,
208 struct timeval timeout
)
210 struct ct_data
*ct
= (struct ct_data
*) h
->cl_private
;
211 XDR
*xdrs
= &(ct
->ct_xdrs
);
212 struct rpc_msg reply_msg
;
214 u_int32_t
*msg_x_id
= (u_int32_t
*) (ct
->ct_mcall
); /* yuk */
220 ct
->ct_wait
= timeout
;
224 (xdr_results
== (xdrproc_t
) 0 && ct
->ct_wait
.tv_sec
== 0
225 && ct
->ct_wait
.tv_usec
== 0) ? FALSE
: TRUE
;
228 xdrs
->x_op
= XDR_ENCODE
;
229 ct
->ct_error
.re_status
= RPC_SUCCESS
;
230 x_id
= ntohl (--(*msg_x_id
));
231 if ((!XDR_PUTBYTES (xdrs
, ct
->ct_mcall
, ct
->ct_mpos
)) ||
232 (!XDR_PUTLONG (xdrs
, (long *) &proc
)) ||
233 (!AUTH_MARSHALL (h
->cl_auth
, xdrs
)) ||
234 (!(*xdr_args
) (xdrs
, args_ptr
)))
236 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
237 ct
->ct_error
.re_status
= RPC_CANTENCODEARGS
;
238 (void) xdrrec_endofrecord (xdrs
, TRUE
);
239 return ct
->ct_error
.re_status
;
241 if (!xdrrec_endofrecord (xdrs
, shipnow
))
242 return ct
->ct_error
.re_status
= RPC_CANTSEND
;
246 * Hack to provide rpc-based message passing
248 if (ct
->ct_wait
.tv_sec
== 0 && ct
->ct_wait
.tv_usec
== 0)
249 return ct
->ct_error
.re_status
= RPC_TIMEDOUT
;
253 * Keep receiving until we get a valid transaction id
255 xdrs
->x_op
= XDR_DECODE
;
258 reply_msg
.acpted_rply
.ar_verf
= _null_auth
;
259 reply_msg
.acpted_rply
.ar_results
.where
= NULL
;
260 reply_msg
.acpted_rply
.ar_results
.proc
= (xdrproc_t
)xdr_void
;
261 if (!xdrrec_skiprecord (xdrs
))
262 return ct
->ct_error
.re_status
;
263 /* now decode and validate the response header */
264 if (!xdr_replymsg (xdrs
, &reply_msg
))
266 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
268 return ct
->ct_error
.re_status
;
270 if (reply_msg
.rm_xid
== x_id
)
277 _seterr_reply (&reply_msg
, &(ct
->ct_error
));
278 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
280 if (!AUTH_VALIDATE (h
->cl_auth
, &reply_msg
.acpted_rply
.ar_verf
))
282 ct
->ct_error
.re_status
= RPC_AUTHERROR
;
283 ct
->ct_error
.re_why
= AUTH_INVALIDRESP
;
285 else if (!(*xdr_results
) (xdrs
, results_ptr
))
287 if (ct
->ct_error
.re_status
== RPC_SUCCESS
)
288 ct
->ct_error
.re_status
= RPC_CANTDECODERES
;
290 /* free verifier ... */
291 if (reply_msg
.acpted_rply
.ar_verf
.oa_base
!= NULL
)
293 xdrs
->x_op
= XDR_FREE
;
294 (void) xdr_opaque_auth (xdrs
, &(reply_msg
.acpted_rply
.ar_verf
));
296 } /* end successful completion */
299 /* maybe our credentials need to be refreshed ... */
300 if (refreshes
-- && AUTH_REFRESH (h
->cl_auth
))
302 } /* end of unsuccessful completion */
303 return ct
->ct_error
.re_status
;
307 clntunix_geterr (CLIENT
*h
, struct rpc_err
*errp
)
309 struct ct_data
*ct
= (struct ct_data
*) h
->cl_private
;
311 *errp
= ct
->ct_error
;
315 clntunix_freeres (CLIENT
*cl
, xdrproc_t xdr_res
, caddr_t res_ptr
)
317 struct ct_data
*ct
= (struct ct_data
*) cl
->cl_private
;
318 XDR
*xdrs
= &(ct
->ct_xdrs
);
320 xdrs
->x_op
= XDR_FREE
;
321 return (*xdr_res
) (xdrs
, res_ptr
);
325 clntunix_abort (void)
330 clntunix_control (CLIENT
*cl
, int request
, char *info
)
332 struct ct_data
*ct
= (struct ct_data
*) cl
->cl_private
;
339 ct
->ct_closeit
= TRUE
;
341 case CLSET_FD_NCLOSE
:
342 ct
->ct_closeit
= FALSE
;
345 ct
->ct_wait
= *(struct timeval
*) info
;
348 *(struct timeval
*) info
= ct
->ct_wait
;
350 case CLGET_SERVER_ADDR
:
351 *(struct sockaddr_un
*) info
= ct
->ct_addr
;
354 *(int *)info
= ct
->ct_sock
;
358 * use the knowledge that xid is the
359 * first element in the call structure *.
360 * This will get the xid of the PREVIOUS call
362 memcpy (&ui32
, ct
->ct_mcall
, sizeof (ui32
));
364 memcpy (info
, &ul
, sizeof (ul
));
367 /* This will set the xid of the NEXT call */
368 memcpy (&ul
, info
, sizeof (ul
));
369 ui32
= htonl (ul
- 1);
370 memcpy (ct
->ct_mcall
, &ui32
, sizeof (ui32
));
371 /* decrement by 1 as clntunix_call() increments once */
375 * This RELIES on the information that, in the call body,
376 * the version number field is the fifth field from the
377 * beginning of the RPC header. MUST be changed if the
378 * call_struct is changed
380 memcpy (&ui32
, ct
->ct_mcall
+ 4 * BYTES_PER_XDR_UNIT
, sizeof (ui32
));
382 memcpy (info
, &ul
, sizeof (ul
));
385 memcpy (&ul
, info
, sizeof (ul
));
387 memcpy (ct
->ct_mcall
+ 4 * BYTES_PER_XDR_UNIT
, &ui32
, sizeof (ui32
));
391 * This RELIES on the information that, in the call body,
392 * the program number field is the field from the
393 * beginning of the RPC header. MUST be changed if the
394 * call_struct is changed
396 memcpy (&ui32
, ct
->ct_mcall
+ 3 * BYTES_PER_XDR_UNIT
, sizeof (ui32
));
398 memcpy (info
, &ul
, sizeof (ul
));
401 memcpy (&ul
, info
, sizeof (ul
));
403 memcpy (ct
->ct_mcall
+ 3 * BYTES_PER_XDR_UNIT
, &ui32
, sizeof (ui32
));
405 /* The following are only possible with TI-RPC */
406 case CLGET_RETRY_TIMEOUT
:
407 case CLSET_RETRY_TIMEOUT
:
410 case CLSET_PUSH_TIMOD
:
411 case CLSET_POP_TIMOD
:
420 clntunix_destroy (CLIENT
*h
)
423 (struct ct_data
*) h
->cl_private
;
427 (void) __close (ct
->ct_sock
);
429 XDR_DESTROY (&(ct
->ct_xdrs
));
430 mem_free ((caddr_t
) ct
, sizeof (struct ct_data
));
431 mem_free ((caddr_t
) h
, sizeof (CLIENT
));
435 __msgread (int sock
, void *data
, size_t cnt
)
439 #ifdef SCM_CREDENTIALS
440 static char cm
[CMSG_SPACE(sizeof (struct ucred
))];
451 #ifdef SCM_CREDENTIALS
452 msg
.msg_control
= (caddr_t
) &cm
;
453 msg
.msg_controllen
= CMSG_SPACE(sizeof (struct ucred
));
460 if (__setsockopt (sock
, SOL_SOCKET
, SO_PASSCRED
, &on
, sizeof (on
)))
466 len
= __recvmsg (sock
, &msg
, 0);
469 if (msg
.msg_flags
& MSG_CTRUNC
|| len
== 0)
480 __msgwrite (int sock
, void *data
, size_t cnt
)
482 #ifndef SCM_CREDENTIALS
483 /* We cannot implement this reliably. */
484 __set_errno (ENOSYS
);
489 struct cmsghdr
*cmsg
= alloca (CMSG_SPACE(sizeof (struct ucred
)));
493 /* XXX I'm not sure, if gete?id() is always correct, or if we should use
494 get?id(). But since keyserv needs geteuid(), we have no other chance.
495 It would be much better, if the kernel could pass both to the server. */
496 cred
.pid
= __getpid ();
497 cred
.uid
= __geteuid ();
498 cred
.gid
= __getegid ();
500 memcpy (CMSG_DATA(cmsg
), &cred
, sizeof (struct ucred
));
501 cmsg
->cmsg_level
= SOL_SOCKET
;
502 cmsg
->cmsg_type
= SCM_CREDENTIALS
;
503 cmsg
->cmsg_len
= sizeof(*cmsg
) + sizeof(struct ucred
);
512 msg
.msg_control
= cmsg
;
513 msg
.msg_controllen
= CMSG_ALIGN(cmsg
->cmsg_len
);
517 len
= __sendmsg (sock
, &msg
, 0);
529 * Interface between xdr serializer and unix connection.
530 * Behaves like the system calls, read & write, but keeps some error state
531 * around for the rpc level.
534 readunix (char *ctptr
, char *buf
, int len
)
536 struct ct_data
*ct
= (struct ct_data
*) ctptr
;
538 int milliseconds
= ((ct
->ct_wait
.tv_sec
* 1000)
539 + (ct
->ct_wait
.tv_usec
/ 1000));
548 switch (__poll (&fd
, 1, milliseconds
))
551 ct
->ct_error
.re_status
= RPC_TIMEDOUT
;
557 ct
->ct_error
.re_status
= RPC_CANTRECV
;
558 ct
->ct_error
.re_errno
= errno
;
563 switch (len
= __msgread (ct
->ct_sock
, buf
, len
))
568 ct
->ct_error
.re_errno
= ECONNRESET
;
569 ct
->ct_error
.re_status
= RPC_CANTRECV
;
570 len
= -1; /* it's really an error */
574 ct
->ct_error
.re_errno
= errno
;
575 ct
->ct_error
.re_status
= RPC_CANTRECV
;
582 writeunix (char *ctptr
, char *buf
, int len
)
585 struct ct_data
*ct
= (struct ct_data
*) ctptr
;
587 for (cnt
= len
; cnt
> 0; cnt
-= i
, buf
+= i
)
589 if ((i
= __msgwrite (ct
->ct_sock
, buf
, cnt
)) == -1)
591 ct
->ct_error
.re_errno
= errno
;
592 ct
->ct_error
.re_status
= RPC_CANTSEND
;