fdwalk should return 0 on an empty directory
[kopensolaris-gnu/glibc.git] / sunrpc / clnt_tcp.c
1 /* @(#)clnt_tcp.c       2.2 88/08/01 4.0 RPCSRC */
2 /*
3  * Sun RPC is a product of Sun Microsystems, Inc. and is provided for
4  * unrestricted use provided that this legend is included on all tape
5  * media and as a part of the software program in whole or part.  Users
6  * may copy or modify Sun RPC without charge, but are not authorized
7  * to license or distribute it to anyone else except as part of a product or
8  * program developed by the user.
9  *
10  * SUN RPC IS PROVIDED AS IS WITH NO WARRANTIES OF ANY KIND INCLUDING THE
11  * WARRANTIES OF DESIGN, MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
12  * PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE OR TRADE PRACTICE.
13  *
14  * Sun RPC is provided with no support and without any obligation on the
15  * part of Sun Microsystems, Inc. to assist in its use, correction,
16  * modification or enhancement.
17  *
18  * SUN MICROSYSTEMS, INC. SHALL HAVE NO LIABILITY WITH RESPECT TO THE
19  * INFRINGEMENT OF COPYRIGHTS, TRADE SECRETS OR ANY PATENTS BY SUN RPC
20  * OR ANY PART THEREOF.
21  *
22  * In no event will Sun Microsystems, Inc. be liable for any lost revenue
23  * or profits or other special, indirect and consequential damages, even if
24  * Sun has been advised of the possibility of such damages.
25  *
26  * Sun Microsystems, Inc.
27  * 2550 Garcia Avenue
28  * Mountain View, California  94043
29  */
30 #if !defined(lint) && defined(SCCSIDS)
31 static char sccsid[] = "@(#)clnt_tcp.c 1.37 87/10/05 Copyr 1984 Sun Micro";
32 #endif
33
34 /*
35  * clnt_tcp.c, Implements a TCP/IP based, client side RPC.
36  *
37  * Copyright (C) 1984, Sun Microsystems, Inc.
38  *
39  * TCP based RPC supports 'batched calls'.
40  * A sequence of calls may be batched-up in a send buffer.  The rpc call
41  * return immediately to the client even though the call was not necessarily
42  * sent.  The batching occurs if the results' xdr routine is NULL (0) AND
43  * the rpc timeout value is zero (see clnt.h, rpc).
44  *
45  * Clients should NOT casually batch calls that in fact return results; that is,
46  * the server side should be aware that a call is batched and not produce any
47  * return message.  Batched calls that produce many result messages can
48  * deadlock (netlock) the client and the server....
49  *
50  * Now go hang yourself.
51  */
52
53 #include <netdb.h>
54 #include <errno.h>
55 #include <stdio.h>
56 #include <unistd.h>
57 #include <libintl.h>
58 #include <rpc/rpc.h>
59 #include <sys/poll.h>
60 #include <sys/socket.h>
61 #include <rpc/pmap_clnt.h>
62 #ifdef USE_IN_LIBIO
63 # include <wchar.h>
64 #endif
65
66 extern u_long _create_xid (void);
67
68 #define MCALL_MSG_SIZE 24
69
70 struct ct_data
71   {
72     int ct_sock;
73     bool_t ct_closeit;
74     struct timeval ct_wait;
75     bool_t ct_waitset;          /* wait set by clnt_control? */
76     struct sockaddr_in ct_addr;
77     struct rpc_err ct_error;
78     char ct_mcall[MCALL_MSG_SIZE];      /* marshalled callmsg */
79     u_int ct_mpos;              /* pos after marshal */
80     XDR ct_xdrs;
81   };
82
83 static int readtcp (char *, char *, int);
84 static int writetcp (char *, char *, int);
85
86 static enum clnt_stat clnttcp_call (CLIENT *, u_long, xdrproc_t, caddr_t,
87                                     xdrproc_t, caddr_t, struct timeval);
88 static void clnttcp_abort (void);
89 static void clnttcp_geterr (CLIENT *, struct rpc_err *);
90 static bool_t clnttcp_freeres (CLIENT *, xdrproc_t, caddr_t);
91 static bool_t clnttcp_control (CLIENT *, int, char *);
92 static void clnttcp_destroy (CLIENT *);
93
94 static const struct clnt_ops tcp_ops =
95 {
96   clnttcp_call,
97   clnttcp_abort,
98   clnttcp_geterr,
99   clnttcp_freeres,
100   clnttcp_destroy,
101   clnttcp_control
102 };
103
104 /*
105  * Create a client handle for a tcp/ip connection.
106  * If *sockp<0, *sockp is set to a newly created TCP socket and it is
107  * connected to raddr.  If *sockp non-negative then
108  * raddr is ignored.  The rpc/tcp package does buffering
109  * similar to stdio, so the client must pick send and receive buffer sizes,];
110  * 0 => use the default.
111  * If raddr->sin_port is 0, then a binder on the remote machine is
112  * consulted for the right port number.
113  * NB: *sockp is copied into a private area.
114  * NB: It is the clients responsibility to close *sockp.
115  * NB: The rpch->cl_auth is set null authentication.  Caller may wish to set this
116  * something more useful.
117  */
118 CLIENT *
119 clnttcp_create (struct sockaddr_in *raddr, u_long prog, u_long vers,
120                 int *sockp, u_int sendsz, u_int recvsz)
121 {
122   CLIENT *h;
123   struct ct_data *ct;
124   struct rpc_msg call_msg;
125
126   h = (CLIENT *) mem_alloc (sizeof (*h));
127   ct = (struct ct_data *) mem_alloc (sizeof (*ct));
128   if (h == NULL || ct == NULL)
129     {
130       struct rpc_createerr *ce = &get_rpc_createerr ();
131       (void) __fxprintf (NULL, "%s", _("clnttcp_create: out of memory\n"));
132       ce->cf_stat = RPC_SYSTEMERROR;
133       ce->cf_error.re_errno = ENOMEM;
134       goto fooy;
135     }
136
137   /*
138    * If no port number given ask the pmap for one
139    */
140   if (raddr->sin_port == 0)
141     {
142       u_short port;
143       if ((port = pmap_getport (raddr, prog, vers, IPPROTO_TCP)) == 0)
144         {
145           mem_free ((caddr_t) ct, sizeof (struct ct_data));
146           mem_free ((caddr_t) h, sizeof (CLIENT));
147           return ((CLIENT *) NULL);
148         }
149       raddr->sin_port = htons (port);
150     }
151
152   /*
153    * If no socket given, open one
154    */
155   if (*sockp < 0)
156     {
157       *sockp = __socket (AF_INET, SOCK_STREAM, IPPROTO_TCP);
158       (void) bindresvport (*sockp, (struct sockaddr_in *) 0);
159       if ((*sockp < 0)
160           || (__connect (*sockp, (struct sockaddr *) raddr,
161                          sizeof (*raddr)) < 0))
162         {
163           struct rpc_createerr *ce = &get_rpc_createerr ();
164           ce->cf_stat = RPC_SYSTEMERROR;
165           ce->cf_error.re_errno = errno;
166           if (*sockp >= 0)
167             (void) __close (*sockp);
168           goto fooy;
169         }
170       ct->ct_closeit = TRUE;
171     }
172   else
173     {
174       ct->ct_closeit = FALSE;
175     }
176
177   /*
178    * Set up private data struct
179    */
180   ct->ct_sock = *sockp;
181   ct->ct_wait.tv_usec = 0;
182   ct->ct_waitset = FALSE;
183   ct->ct_addr = *raddr;
184
185   /*
186    * Initialize call message
187    */
188   call_msg.rm_xid = _create_xid ();
189   call_msg.rm_direction = CALL;
190   call_msg.rm_call.cb_rpcvers = RPC_MSG_VERSION;
191   call_msg.rm_call.cb_prog = prog;
192   call_msg.rm_call.cb_vers = vers;
193
194   /*
195    * pre-serialize the static part of the call msg and stash it away
196    */
197   INTUSE(xdrmem_create) (&(ct->ct_xdrs), ct->ct_mcall, MCALL_MSG_SIZE,
198                          XDR_ENCODE);
199   if (!INTUSE(xdr_callhdr) (&(ct->ct_xdrs), &call_msg))
200     {
201       if (ct->ct_closeit)
202         {
203           (void) __close (*sockp);
204         }
205       goto fooy;
206     }
207   ct->ct_mpos = XDR_GETPOS (&(ct->ct_xdrs));
208   XDR_DESTROY (&(ct->ct_xdrs));
209
210   /*
211    * Create a client handle which uses xdrrec for serialization
212    * and authnone for authentication.
213    */
214   INTUSE(xdrrec_create) (&(ct->ct_xdrs), sendsz, recvsz,
215                          (caddr_t) ct, readtcp, writetcp);
216   h->cl_ops = (struct clnt_ops *) &tcp_ops;
217   h->cl_private = (caddr_t) ct;
218   h->cl_auth = INTUSE(authnone_create) ();
219   return h;
220
221 fooy:
222   /*
223    * Something goofed, free stuff and barf
224    */
225   mem_free ((caddr_t) ct, sizeof (struct ct_data));
226   mem_free ((caddr_t) h, sizeof (CLIENT));
227   return ((CLIENT *) NULL);
228 }
229 INTDEF (clnttcp_create)
230
231 static enum clnt_stat
232 clnttcp_call (h, proc, xdr_args, args_ptr, xdr_results, results_ptr, timeout)
233      CLIENT *h;
234      u_long proc;
235      xdrproc_t xdr_args;
236      caddr_t args_ptr;
237      xdrproc_t xdr_results;
238      caddr_t results_ptr;
239      struct timeval timeout;
240 {
241   struct ct_data *ct = (struct ct_data *) h->cl_private;
242   XDR *xdrs = &(ct->ct_xdrs);
243   struct rpc_msg reply_msg;
244   u_long x_id;
245   u_int32_t *msg_x_id = (u_int32_t *) (ct->ct_mcall);   /* yuk */
246   bool_t shipnow;
247   int refreshes = 2;
248
249   if (!ct->ct_waitset)
250     {
251       ct->ct_wait = timeout;
252     }
253
254   shipnow =
255     (xdr_results == (xdrproc_t) 0 && ct->ct_wait.tv_sec == 0
256      && ct->ct_wait.tv_usec == 0) ? FALSE : TRUE;
257
258 call_again:
259   xdrs->x_op = XDR_ENCODE;
260   ct->ct_error.re_status = RPC_SUCCESS;
261   x_id = ntohl (--(*msg_x_id));
262   if ((!XDR_PUTBYTES (xdrs, ct->ct_mcall, ct->ct_mpos)) ||
263       (!XDR_PUTLONG (xdrs, (long *) &proc)) ||
264       (!AUTH_MARSHALL (h->cl_auth, xdrs)) ||
265       (!(*xdr_args) (xdrs, args_ptr)))
266     {
267       if (ct->ct_error.re_status == RPC_SUCCESS)
268         ct->ct_error.re_status = RPC_CANTENCODEARGS;
269       (void) INTUSE(xdrrec_endofrecord) (xdrs, TRUE);
270       return (ct->ct_error.re_status);
271     }
272   if (!INTUSE(xdrrec_endofrecord) (xdrs, shipnow))
273     return ct->ct_error.re_status = RPC_CANTSEND;
274   if (!shipnow)
275     return RPC_SUCCESS;
276   /*
277    * Hack to provide rpc-based message passing
278    */
279   if (ct->ct_wait.tv_sec == 0 && ct->ct_wait.tv_usec == 0)
280     {
281       return ct->ct_error.re_status = RPC_TIMEDOUT;
282     }
283
284
285   /*
286    * Keep receiving until we get a valid transaction id
287    */
288   xdrs->x_op = XDR_DECODE;
289   while (TRUE)
290     {
291       reply_msg.acpted_rply.ar_verf = _null_auth;
292       reply_msg.acpted_rply.ar_results.where = NULL;
293       reply_msg.acpted_rply.ar_results.proc = (xdrproc_t)INTUSE(xdr_void);
294       if (!INTUSE(xdrrec_skiprecord) (xdrs))
295         return (ct->ct_error.re_status);
296       /* now decode and validate the response header */
297       if (!INTUSE(xdr_replymsg) (xdrs, &reply_msg))
298         {
299           if (ct->ct_error.re_status == RPC_SUCCESS)
300             continue;
301           return ct->ct_error.re_status;
302         }
303       if ((u_int32_t) reply_msg.rm_xid == (u_int32_t) x_id)
304         break;
305     }
306
307   /*
308    * process header
309    */
310   _seterr_reply (&reply_msg, &(ct->ct_error));
311   if (ct->ct_error.re_status == RPC_SUCCESS)
312     {
313       if (!AUTH_VALIDATE (h->cl_auth, &reply_msg.acpted_rply.ar_verf))
314         {
315           ct->ct_error.re_status = RPC_AUTHERROR;
316           ct->ct_error.re_why = AUTH_INVALIDRESP;
317         }
318       else if (!(*xdr_results) (xdrs, results_ptr))
319         {
320           if (ct->ct_error.re_status == RPC_SUCCESS)
321             ct->ct_error.re_status = RPC_CANTDECODERES;
322         }
323       /* free verifier ... */
324       if (reply_msg.acpted_rply.ar_verf.oa_base != NULL)
325         {
326           xdrs->x_op = XDR_FREE;
327           (void) INTUSE(xdr_opaque_auth) (xdrs,
328                                           &(reply_msg.acpted_rply.ar_verf));
329         }
330     }                           /* end successful completion */
331   else
332     {
333       /* maybe our credentials need to be refreshed ... */
334       if (refreshes-- && AUTH_REFRESH (h->cl_auth))
335         goto call_again;
336     }                           /* end of unsuccessful completion */
337   return ct->ct_error.re_status;
338 }
339
340 static void
341 clnttcp_geterr (h, errp)
342      CLIENT *h;
343      struct rpc_err *errp;
344 {
345   struct ct_data *ct =
346   (struct ct_data *) h->cl_private;
347
348   *errp = ct->ct_error;
349 }
350
351 static bool_t
352 clnttcp_freeres (cl, xdr_res, res_ptr)
353      CLIENT *cl;
354      xdrproc_t xdr_res;
355      caddr_t res_ptr;
356 {
357   struct ct_data *ct = (struct ct_data *) cl->cl_private;
358   XDR *xdrs = &(ct->ct_xdrs);
359
360   xdrs->x_op = XDR_FREE;
361   return (*xdr_res) (xdrs, res_ptr);
362 }
363
364 static void
365 clnttcp_abort ()
366 {
367 }
368
369 static bool_t
370 clnttcp_control (CLIENT *cl, int request, char *info)
371 {
372   struct ct_data *ct = (struct ct_data *) cl->cl_private;
373
374
375   switch (request)
376     {
377     case CLSET_FD_CLOSE:
378       ct->ct_closeit = TRUE;
379       break;
380     case CLSET_FD_NCLOSE:
381       ct->ct_closeit = FALSE;
382       break;
383     case CLSET_TIMEOUT:
384       ct->ct_wait = *(struct timeval *) info;
385       ct->ct_waitset = TRUE;
386       break;
387     case CLGET_TIMEOUT:
388       *(struct timeval *) info = ct->ct_wait;
389       break;
390     case CLGET_SERVER_ADDR:
391       *(struct sockaddr_in *) info = ct->ct_addr;
392       break;
393     case CLGET_FD:
394       *(int *)info = ct->ct_sock;
395       break;
396     case CLGET_XID:
397       /*
398        * use the knowledge that xid is the
399        * first element in the call structure *.
400        * This will get the xid of the PREVIOUS call
401        */
402       *(u_long *)info = ntohl (*(u_long *)ct->ct_mcall);
403       break;
404     case CLSET_XID:
405       /* This will set the xid of the NEXT call */
406       *(u_long *)ct->ct_mcall =  htonl (*(u_long *)info - 1);
407       /* decrement by 1 as clnttcp_call() increments once */
408     case CLGET_VERS:
409       /*
410        * This RELIES on the information that, in the call body,
411        * the version number field is the fifth field from the
412        * begining of the RPC header. MUST be changed if the
413        * call_struct is changed
414        */
415       *(u_long *)info = ntohl (*(u_long *)(ct->ct_mcall +
416                                            4 * BYTES_PER_XDR_UNIT));
417       break;
418     case CLSET_VERS:
419       *(u_long *)(ct->ct_mcall + 4 * BYTES_PER_XDR_UNIT)
420         = htonl (*(u_long *)info);
421       break;
422     case CLGET_PROG:
423       /*
424        * This RELIES on the information that, in the call body,
425        * the program number field is the  field from the
426        * begining of the RPC header. MUST be changed if the
427        * call_struct is changed
428        */
429       *(u_long *)info = ntohl(*(u_long *)(ct->ct_mcall +
430                                           3 * BYTES_PER_XDR_UNIT));
431       break;
432     case CLSET_PROG:
433       *(u_long *)(ct->ct_mcall + 3 * BYTES_PER_XDR_UNIT)
434         = htonl(*(u_long *)info);
435       break;
436     /* The following are only possible with TI-RPC */
437     case CLGET_RETRY_TIMEOUT:
438     case CLSET_RETRY_TIMEOUT:
439     case CLGET_SVC_ADDR:
440     case CLSET_SVC_ADDR:
441     case CLSET_PUSH_TIMOD:
442     case CLSET_POP_TIMOD:
443     default:
444       return FALSE;
445     }
446   return TRUE;
447 }
448
449
450 static void
451 clnttcp_destroy (CLIENT *h)
452 {
453   struct ct_data *ct =
454   (struct ct_data *) h->cl_private;
455
456   if (ct->ct_closeit)
457     {
458       (void) __close (ct->ct_sock);
459     }
460   XDR_DESTROY (&(ct->ct_xdrs));
461   mem_free ((caddr_t) ct, sizeof (struct ct_data));
462   mem_free ((caddr_t) h, sizeof (CLIENT));
463 }
464
465 /*
466  * Interface between xdr serializer and tcp connection.
467  * Behaves like the system calls, read & write, but keeps some error state
468  * around for the rpc level.
469  */
470 static int
471 readtcp (char *ctptr, char *buf, int len)
472 {
473   struct ct_data *ct = (struct ct_data *)ctptr;
474   struct pollfd fd;
475   int milliseconds = (ct->ct_wait.tv_sec * 1000) +
476     (ct->ct_wait.tv_usec / 1000);
477
478   if (len == 0)
479     return 0;
480
481   fd.fd = ct->ct_sock;
482   fd.events = POLLIN;
483   while (TRUE)
484     {
485       switch (__poll(&fd, 1, milliseconds))
486         {
487         case 0:
488           ct->ct_error.re_status = RPC_TIMEDOUT;
489           return -1;
490
491         case -1:
492           if (errno == EINTR)
493             continue;
494           ct->ct_error.re_status = RPC_CANTRECV;
495           ct->ct_error.re_errno = errno;
496           return -1;
497         }
498       break;
499     }
500   switch (len = __read (ct->ct_sock, buf, len))
501     {
502
503     case 0:
504       /* premature eof */
505       ct->ct_error.re_errno = ECONNRESET;
506       ct->ct_error.re_status = RPC_CANTRECV;
507       len = -1;                 /* it's really an error */
508       break;
509
510     case -1:
511       ct->ct_error.re_errno = errno;
512       ct->ct_error.re_status = RPC_CANTRECV;
513       break;
514     }
515   return len;
516 }
517
518 static int
519 writetcp (char *ctptr, char *buf, int len)
520 {
521   int i, cnt;
522   struct ct_data *ct = (struct ct_data*)ctptr;
523
524   for (cnt = len; cnt > 0; cnt -= i, buf += i)
525     {
526       if ((i = __write (ct->ct_sock, buf, cnt)) == -1)
527         {
528           ct->ct_error.re_errno = errno;
529           ct->ct_error.re_status = RPC_CANTSEND;
530           return -1;
531         }
532     }
533   return len;
534 }