Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
[yaz-moved-to-github.git] / comstack / tcpip.c
1 /*
2  * Copyright (c) 1995-1999, Index Data
3  * See the file LICENSE for details.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: tcpip.c,v $
7  * Revision 1.30  1999-04-20 09:56:48  adam
8  * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
9  * Modified all encoders/decoders to reflect this change.
10  *
11  * Revision 1.29  1999/04/16 14:45:55  adam
12  * Added interface for tcpd wrapper for access control.
13  *
14  * Revision 1.28  1999/03/31 11:11:14  adam
15  * Function getprotobyname only called once. Minor change in tcpip_get
16  * to handle multi-threaded conditions.
17  *
18  * Revision 1.27  1999/02/02 13:57:31  adam
19  * Uses preprocessor define WIN32 instead of WINDOWS to build code
20  * for Microsoft WIN32.
21  *
22  * Revision 1.26  1999/01/08 11:23:14  adam
23  * Added const modifier to some of the BER/ODR encoding routines.
24  *
25  * Revision 1.25  1998/07/07 15:49:23  adam
26  * Added braces to avoid warning.
27  *
28  * Revision 1.24  1998/06/29 07:59:17  adam
29  * Minor fix.
30  *
31  * Revision 1.23  1998/06/23 15:37:50  adam
32  * Added type cast to prevent warning.
33  *
34  * Revision 1.22  1998/06/22 11:32:36  adam
35  * Added 'conditional cs_listen' feature.
36  *
37  * Revision 1.21  1998/05/20 09:55:32  adam
38  * Function tcpip_get treats EINPROGRESS error in the same way as
39  * EWOULDBLOCK. EINPROGRESS shouldn't be returned - but it is on
40  * Solaris in some cases.
41  *
42  * Revision 1.20  1998/05/18 10:10:40  adam
43  * Minor change to avoid C++ warning.
44  *
45  * Revision 1.19  1998/02/11 11:53:33  adam
46  * Changed code so that it compiles as C++.
47  *
48  * Revision 1.18  1997/09/29 07:15:25  adam
49  * Changed use of setsockopt to avoid warnings on MSVC.
50  *
51  * Revision 1.17  1997/09/17 12:10:30  adam
52  * YAZ version 1.4.
53  *
54  * Revision 1.16  1997/09/01 08:49:14  adam
55  * New windows NT/95 port using MSV5.0. Minor changes only.
56  *
57  * Revision 1.15  1997/05/14 06:53:33  adam
58  * C++ support.
59  *
60  * Revision 1.14  1997/05/01 15:06:32  adam
61  * Moved WINSOCK init. code to tcpip_init routine.
62  *
63  * Revision 1.13  1996/11/01 08:45:18  adam
64  * Bug fix: used close on MS-Windows. Fixed to closesocket.
65  *
66  * Revision 1.12  1996/07/06 19:58:30  quinn
67  * System headerfiles gathered in yconfig
68  *
69  * Revision 1.11  1996/02/23  10:00:39  quinn
70  * WAIS Work
71  *
72  * Revision 1.10  1996/02/20  12:52:11  quinn
73  * WAIS protocol support.
74  *
75  * Revision 1.9  1996/02/10  12:23:11  quinn
76  * Enablie inetd operations fro TCP/IP stack
77  *
78  * Revision 1.8  1995/11/01  13:54:27  quinn
79  * Minor adjustments
80  *
81  * Revision 1.7  1995/10/30  12:41:16  quinn
82  * Added hostname lookup for server.
83  *
84  * Revision 1.6  1995/09/29  17:12:00  quinn
85  * Smallish
86  *
87  * Revision 1.5  1995/09/29  17:01:48  quinn
88  * More Windows work
89  *
90  * Revision 1.4  1995/09/28  10:12:26  quinn
91  * Windows-support changes
92  *
93  * Revision 1.3  1995/09/27  15:02:45  quinn
94  * Modified function heads & prototypes.
95  *
96  * Revision 1.2  1995/06/15  12:30:06  quinn
97  * Added @ as hostname alias for INADDR ANY.
98  *
99  * Revision 1.1  1995/06/14  09:58:20  quinn
100  * Renamed yazlib to comstack.
101  *
102  * Revision 1.20  1995/05/16  08:51:16  quinn
103  * License, documentation, and memory fixes
104  *
105  * Revision 1.19  1995/04/10  10:24:08  quinn
106  * Some bug-fixes.
107  *
108  * Revision 1.18  1995/03/30  13:29:27  quinn
109  * Added REUSEADDR in tcpip_bind
110  *
111  * Revision 1.17  1995/03/27  08:36:10  quinn
112  * Some work on nonblocking operation in xmosi.c and rfct.c.
113  * Added protocol parameter to cs_create()
114  *
115  * Revision 1.16  1995/03/21  15:53:41  quinn
116  * Added rcvconnect
117  *
118  * Revision 1.15  1995/03/21  12:31:27  quinn
119  * Added check for EINPROGRESS on connect.
120  *
121  * Revision 1.14  1995/03/20  09:47:21  quinn
122  * Added server-side support to xmosi.c
123  * Fixed possible problems in rfct
124  * Other little mods
125  *
126  * Revision 1.13  1995/03/15  16:15:13  adam
127  * Removed p_write.
128  *
129  * Revision 1.12  1995/03/15  15:36:27  quinn
130  * Mods to support nonblocking I/O
131  *
132  * Revision 1.11  1995/03/15  08:37:57  quinn
133  * Now we're pretty much set for nonblocking I/O.
134  *
135  * Revision 1.10  1995/03/14  17:00:07  quinn
136  * Bug-fixes - added tracing info to tcpip.c
137  *
138  * Revision 1.9  1995/03/14  10:28:42  quinn
139  * Adding server-side support to tcpip.c and fixing bugs in nonblocking I/O
140  *
141  * Revision 1.8  1995/03/10  14:22:50  quinn
142  * Removed debug output.
143  *
144  * Revision 1.7  1995/03/10  11:44:59  quinn
145  * Fixes and debugging
146  *
147  * Revision 1.6  1995/03/07  10:26:55  quinn
148  * Initialized type field in the comstacks.
149  *
150  * Revision 1.5  1995/02/14  20:40:07  quinn
151  * Various stuff.
152  *
153  * Revision 1.4  1995/02/14  11:54:49  quinn
154  * Beginning to add full CCL.
155  *
156  * Revision 1.3  1995/02/10  18:58:10  quinn
157  * Fixed tcpip_get (formerly tcpip_read).
158  * Turned tst (cli) into a proper, event-driven thingy.
159  *
160  * Revision 1.2  1995/02/10  15:55:47  quinn
161  * Small things.
162  *
163  * Revision 1.1  1995/02/09  15:51:52  quinn
164  * Works better now.
165  *
166  */
167
168 #include <stdio.h>
169 #include <string.h>
170 #include <stdlib.h>
171 #ifndef WIN32
172 #include <unistd.h>
173 #endif
174 #include <errno.h>
175 #include <fcntl.h>
176
177 #include <comstack.h>
178 #include <tcpip.h>
179 #include <log.h>
180
181 /* Chas added the following, so we get the definition of completeBER */
182 #include <odr.h>
183
184 int tcpip_close(COMSTACK h);
185 int tcpip_put(COMSTACK h, char *buf, int size);
186 int tcpip_get(COMSTACK h, char **buf, int *bufsize);
187 int tcpip_connect(COMSTACK h, void *address);
188 int tcpip_more(COMSTACK h);
189 int tcpip_rcvconnect(COMSTACK h);
190 int tcpip_bind(COMSTACK h, void *address, int mode);
191 int tcpip_listen(COMSTACK h, char *raddr, int *addrlen,
192                  int (*check_ip)(void *cd, const char *a, int len, int type),
193                  void *cd);
194
195 COMSTACK tcpip_accept(COMSTACK h);
196 char *tcpip_addrstr(COMSTACK h);
197 void *tcpip_straddr(COMSTACK h, const char *str);
198
199 #undef TRACE_TCPIP
200 #ifdef TRACE_TCPIP
201 #define TRC(x) x
202 #else
203 #define TRC(X)
204 #endif
205
206 typedef struct tcpip_state
207 {
208     char *altbuf; /* alternate buffer for surplus data */
209     int altsize;  /* size as xmalloced */
210     int altlen;   /* length of data or 0 if none */
211
212     int written;  /* -1 if we aren't writing */
213     int towrite;  /* to verify against user input */
214     int (*complete)(const unsigned char *buf, int len); /* length/comple. */
215     struct sockaddr_in addr;  /* returned by cs_straddr */
216     char buf[128]; /* returned by cs_addrstr */
217 } tcpip_state;
218
219 #ifdef WIN32
220 static int tcpip_init (void)
221 {
222     static int initialized = 0;
223     if (!initialized)
224     {
225         WORD requested;
226         WSADATA wd;
227
228         requested = MAKEWORD(1, 1);
229         if (WSAStartup(requested, &wd))
230             return 0;
231         initialized = 1;
232     }
233     return 1;
234 }
235 #else
236
237 static int proto_number = 0;
238
239 static int tcpip_init (void)
240 {
241     struct protoent *proto;
242     /* only call getprotobyname once, in case it allocates memory */
243     if (!(proto = getprotobyname("tcp")))
244         return 0;
245     proto_number = proto->p_proto;
246     return 1;
247 }
248 #endif
249 /*
250  * This function is always called through the cs_create() macro.
251  * s >= 0: socket has already been established for us.
252  */
253 COMSTACK tcpip_type(int s, int blocking, int protocol)
254 {
255     COMSTACK p;
256     tcpip_state *state;
257     int new_socket;
258 #ifdef WIN32
259     unsigned long tru = 1;
260 #endif
261
262     if (!tcpip_init ())
263         return 0;
264     if (s < 0)
265     {
266 #ifdef WIN32
267         if ((s = socket(AF_INET, SOCK_STREAM, 0)) < 0)
268             return 0;
269 #else
270         if ((s = socket(AF_INET, SOCK_STREAM, proto_number)) < 0)
271             return 0;
272 #endif
273         new_socket = 1;
274     }
275     else
276         new_socket = 0;
277     if (!(p = (struct comstack *)xmalloc(sizeof(struct comstack))))
278         return 0;
279     if (!(state = (struct tcpip_state *)(p->cprivate =
280                                          xmalloc(sizeof(tcpip_state)))))
281         return 0;
282
283 #ifdef WIN32
284     if (!(p->blocking = blocking) && ioctlsocket(s, FIONBIO, &tru) < 0)
285 #else
286     if (!(p->blocking = blocking) && fcntl(s, F_SETFL, O_NONBLOCK) < 0)
287 #endif
288         return 0;
289
290     p->iofile = s;
291     p->type = tcpip_type;
292     p->protocol = (enum oid_proto) protocol;
293
294     p->f_connect = tcpip_connect;
295     p->f_rcvconnect = tcpip_rcvconnect;
296     p->f_get = tcpip_get;
297     p->f_put = tcpip_put;
298     p->f_close = tcpip_close;
299     p->f_more = tcpip_more;
300     p->f_bind = tcpip_bind;
301     p->f_listen = tcpip_listen;
302     p->f_accept = tcpip_accept;
303     p->f_addrstr = tcpip_addrstr;
304     p->f_straddr = tcpip_straddr;
305
306     p->state = new_socket ? CS_UNBND : CS_IDLE; /* state of line */
307     p->event = CS_NONE;
308     p->cerrno = 0;
309     p->stackerr = 0;
310
311     state->altbuf = 0;
312     state->altsize = state->altlen = 0;
313     state->towrite = state->written = -1;
314     if (protocol == PROTO_WAIS)
315         state->complete = completeWAIS;
316     else
317         state->complete = completeBER;
318
319     p->timeout = COMSTACK_DEFAULT_TIMEOUT;
320     TRC(fprintf(stderr, "Created new TCPIP comstack\n"));
321
322     return p;
323 }
324
325 int tcpip_strtoaddr_ex(const char *str, struct sockaddr_in *add)
326 {
327     struct hostent *hp;
328     char *p, buf[512];
329     short int port = 210;
330     unsigned tmpadd;
331
332     if (!tcpip_init ())
333         return 0;
334     TRC(fprintf(stderr, "tcpip_strtoaddress: %s\n", str ? str : "NULL"));
335     add->sin_family = AF_INET;
336     strcpy(buf, str);
337     if ((p = strchr(buf, ':')))
338     {
339         *p = 0;
340         port = atoi(p + 1);
341     }
342     add->sin_port = htons(port);
343     if (!strcmp("@", buf))
344         add->sin_addr.s_addr = INADDR_ANY;
345     else if ((hp = gethostbyname(buf)))
346         memcpy(&add->sin_addr.s_addr, *hp->h_addr_list,
347                sizeof(struct in_addr));
348     else if ((tmpadd = (unsigned) inet_addr(buf)) != 0)
349         memcpy(&add->sin_addr.s_addr, &tmpadd, sizeof(struct in_addr));
350     else
351         return 0;
352     return 1;
353 }
354
355 void *tcpip_straddr(COMSTACK h, const char *str)
356 {
357     tcpip_state *sp = (tcpip_state *)h->cprivate;
358
359     if (!tcpip_strtoaddr_ex (str, &sp->addr))
360         return 0;
361     return &sp->addr;
362 }
363
364 struct sockaddr_in *tcpip_strtoaddr(const char *str)
365 {
366     static struct sockaddr_in add;
367     
368     if (!tcpip_strtoaddr_ex (str, &add))
369         return 0;
370     return &add;
371 }
372
373 int tcpip_more(COMSTACK h)
374 {
375     tcpip_state *sp = (tcpip_state *)h->cprivate;
376     
377     return sp->altlen && (*sp->complete)((unsigned char *) sp->altbuf,
378         sp->altlen);
379 }
380
381 /*
382  * connect(2) will block (sometimes) - nothing we can do short of doing
383  * weird things like spawning subprocesses or threading or some weird junk
384  * like that.
385  */
386 int tcpip_connect(COMSTACK h, void *address)
387 {
388     struct sockaddr_in *add = (struct sockaddr_in *)address;
389
390     TRC(fprintf(stderr, "tcpip_connect\n"));
391     if (connect(h->iofile, (struct sockaddr *) add, sizeof(*add)) < 0)
392     {
393 #ifdef WIN32
394         if (WSAGetLastError() == WSAEWOULDBLOCK)
395 #else
396         if (errno == EINPROGRESS)
397 #endif
398             return 1;
399         return -1;
400     }
401     h->state = CS_DATAXFER;
402     return 0;
403 }
404
405 /*
406  * nop
407  */
408 int tcpip_rcvconnect(COMSTACK h)
409 {
410     TRC(fprintf(stderr, "tcpip_rcvconnect\n"));
411     return 0;
412 }
413
414 int tcpip_bind(COMSTACK h, void *address, int mode)
415 {
416     struct sockaddr *addr = (struct sockaddr *)address;
417 #ifdef WIN32
418     BOOL one = 1;
419 #else
420     unsigned long one = 1;
421 #endif
422
423     TRC(fprintf(stderr, "tcpip_bind\n"));
424     if (setsockopt(h->iofile, SOL_SOCKET, SO_REUSEADDR, (char*) 
425         &one, sizeof(one)) < 0)
426     {
427         h->cerrno = CSYSERR;
428         return -1;
429     }
430     if (bind(h->iofile, addr, sizeof(struct sockaddr_in)) < 0)
431     {
432         h->cerrno = CSYSERR;
433         return -1;
434     }
435     if (mode == CS_SERVER && listen(h->iofile, 3) < 0)
436     {
437         h->cerrno = CSYSERR;
438         return -1;
439     }
440     h->state = CS_IDLE;
441     return 0;
442 }
443
444 int tcpip_listen(COMSTACK h, char *raddr, int *addrlen,
445                  int (*check_ip)(void *cd, const char *a, int len, int t),
446                  void *cd)
447 {
448     struct sockaddr_in addr;
449     int len = sizeof(addr);
450
451     TRC(fprintf(stderr, "tcpip_listen pid=%d\n", getpid()));
452     if (h->state != CS_IDLE)
453     {
454         h->cerrno = CSOUTSTATE;
455         return -1;
456     }
457     if ((h->newfd = accept(h->iofile, (struct sockaddr*)&addr, &len)) < 0)
458     {
459 #ifdef WIN32
460         if (WSAGetLastError() == WSAEWOULDBLOCK)
461 #else
462         if (errno == EWOULDBLOCK)
463 #endif
464
465             h->cerrno = CSNODATA;
466         else
467             h->cerrno = CSYSERR;
468         return -1;
469     }
470     if (addrlen && (size_t) (*addrlen) >= sizeof(struct sockaddr_in))
471         memcpy(raddr, &addr, *addrlen = sizeof(struct sockaddr_in));
472     else if (addrlen)
473         *addrlen = 0;
474     if (check_ip && (*check_ip)(cd, (const char *) &addr,
475         sizeof(addr), AF_INET))
476     {
477         h->cerrno = CSDENY;
478 #ifdef WIN32
479         closesocket(h->newfd);
480 #else
481         close(h->newfd);
482 #endif
483         return -1;
484     }
485     h->state = CS_INCON;
486     return 0;
487 }
488
489 COMSTACK tcpip_accept(COMSTACK h)
490 {
491     COMSTACK cnew;
492     tcpip_state *state, *st = (tcpip_state *)h->cprivate;
493 #ifdef WIN32
494     unsigned long tru = 1;
495 #endif
496
497     TRC(fprintf(stderr, "tcpip_accept\n"));
498     if (h->state != CS_INCON)
499     {
500         h->cerrno = CSOUTSTATE;
501         return 0;
502     }
503     if (!(cnew = (COMSTACK)xmalloc(sizeof(*cnew))))
504     {
505         h->cerrno = CSYSERR;
506         return 0;
507     }
508     memcpy(cnew, h, sizeof(*h));
509     cnew->iofile = h->newfd;
510     if (!(state = (tcpip_state *)
511           (cnew->cprivate = xmalloc(sizeof(tcpip_state)))))
512     {
513         h->cerrno = CSYSERR;
514         return 0;
515     }
516 #ifdef WIN32
517     if (!cnew->blocking && ioctlsocket(cnew->iofile, FIONBIO, &tru) < 0)
518 #else
519     if (!cnew->blocking && fcntl(cnew->iofile, F_SETFL, O_NONBLOCK) < 0)
520 #endif
521         return 0;
522     state->altbuf = 0;
523     state->altsize = state->altlen = 0;
524     state->towrite = state->written = -1;
525     state->complete = st->complete;
526     cnew->state = CS_DATAXFER;
527     h->state = CS_IDLE;
528     return cnew;
529 }
530
531 #define CS_TCPIP_BUFCHUNK 4096
532
533 /*
534  * Return: -1 error, >1 good, len of buffer, ==1 incomplete buffer,
535  * 0=connection closed.
536  */
537 int tcpip_get(COMSTACK h, char **buf, int *bufsize)
538 {
539     tcpip_state *sp = (tcpip_state *)h->cprivate;
540     char *tmpc;
541     int tmpi, berlen, rest, req, tomove;
542     int hasread = 0, res;
543
544     TRC(fprintf(stderr, "tcpip_get: bufsize=%d\n", *bufsize));
545     if (sp->altlen) /* switch buffers */
546     {
547         TRC(fprintf(stderr, "  %d bytes in altbuf (0x%x)\n", sp->altlen,
548             (unsigned) sp->altbuf));
549         tmpc = *buf;
550         tmpi = *bufsize;
551         *buf = sp->altbuf;
552         *bufsize = sp->altsize;
553         hasread = sp->altlen;
554         sp->altlen = 0;
555         sp->altbuf = tmpc;
556         sp->altsize = tmpi;
557     }
558     while (!(berlen = (*sp->complete)((unsigned char *)*buf, hasread)))
559     {
560         if (!*bufsize)
561         {
562             if (!(*buf = (char *)xmalloc(*bufsize = CS_TCPIP_BUFCHUNK)))
563                 return -1;
564         }
565         else if (*bufsize - hasread < CS_TCPIP_BUFCHUNK)
566             if (!(*buf =(char *)xrealloc(*buf, *bufsize *= 2)))
567                 return -1;
568         if ((res = recv(h->iofile, *buf + hasread, CS_TCPIP_BUFCHUNK, 0)) < 0)
569         {
570 #ifdef WIN32
571             if (WSAGetLastError() == WSAEWOULDBLOCK)
572                 break;
573             else
574                 return -1;
575 #else
576             if (errno == EWOULDBLOCK
577 #ifdef EINPROGRESS
578                 || errno == EINPROGRESS
579 #endif
580                 )
581                 break;
582             else if (errno == 0)
583                 continue;
584             else
585                 return -1;
586 #endif
587         }
588         if (!res)
589             return 0;
590         hasread += res;
591         TRC(fprintf(stderr, "  res=%d, hasread=%d\n", res, hasread));
592     }
593     TRC(fprintf(stderr, "  Out of read loop with hasread=%d, berlen=%d\n",
594         hasread, berlen));
595     /* move surplus buffer (or everything if we didn't get a BER rec.) */
596     if (hasread > berlen)
597     {
598         tomove = req = hasread - berlen;
599         rest = tomove % CS_TCPIP_BUFCHUNK;
600         if (rest)
601             req += CS_TCPIP_BUFCHUNK - rest;
602         if (!sp->altbuf)
603         {
604             if (!(sp->altbuf = (char *)xmalloc(sp->altsize = req)))
605                 return -1;
606         } else if (sp->altsize < req)
607             if (!(sp->altbuf =(char *)xrealloc(sp->altbuf, sp->altsize = req)))
608                 return -1;
609         TRC(fprintf(stderr, "  Moving %d bytes to altbuf(0x%x)\n", tomove,
610             (unsigned) sp->altbuf));
611         memcpy(sp->altbuf, *buf + berlen, sp->altlen = tomove);
612     }
613     if (berlen < CS_TCPIP_BUFCHUNK - 1)
614         *(*buf + berlen) = '\0';
615     return berlen ? berlen : 1;
616 }
617
618 /*
619  * Returns 1, 0 or -1
620  * In nonblocking mode, you must call again with same buffer while
621  * return value is 1.
622  */
623 int tcpip_put(COMSTACK h, char *buf, int size)
624 {
625     int res;
626     struct tcpip_state *state = (struct tcpip_state *)h->cprivate;
627
628     TRC(fprintf(stderr, "tcpip_put: size=%d\n", size));
629     if (state->towrite < 0)
630     {
631         state->towrite = size;
632         state->written = 0;
633     }
634     else if (state->towrite != size)
635     {
636         h->cerrno = CSWRONGBUF;
637         return -1;
638     }
639     while (state->towrite > state->written)
640     {
641         if ((res = send(h->iofile, buf + state->written, size -
642             state->written, 0)) < 0)
643         {
644 #ifdef WIN32
645             if (WSAGetLastError() == WSAEWOULDBLOCK)
646 #else
647             if (errno == EAGAIN)
648 #endif
649             {
650                 TRC(fprintf(stderr, "  Flow control stop\n"));
651                 return 1;
652             }
653             h->cerrno = CSYSERR;
654             return -1;
655         }
656         state->written += res;
657         TRC(fprintf(stderr, "  Wrote %d, written=%d, nbytes=%d\n",
658             res, state->written, size));
659     }
660     state->towrite = state->written = -1;
661     TRC(fprintf(stderr, "  Ok\n"));
662     return 0;
663 }
664
665 int tcpip_close(COMSTACK h)
666 {
667     tcpip_state *sp = (struct tcpip_state *)h->cprivate;
668
669     TRC(fprintf(stderr, "tcpip_close\n"));
670     if (h->iofile != -1)
671 #ifdef WIN32
672         closesocket(h->iofile);
673 #else
674         close(h->iofile);
675 #endif
676     if (sp->altbuf)
677         xfree(sp->altbuf);
678     xfree(sp);
679     xfree(h);
680     return 0;
681 }
682
683 char *tcpip_addrstr(COMSTACK h)
684 {
685     struct sockaddr_in addr;
686     tcpip_state *sp = (struct tcpip_state *)h->cprivate;
687     char *r, *buf = sp->buf;
688     size_t len;
689     struct hostent *host;
690     
691     len = sizeof(addr);
692     if (getpeername(h->iofile, (struct sockaddr*) &addr, &len) < 0)
693     {
694         h->cerrno = CSYSERR;
695         return 0;
696     }
697     if ((host = gethostbyaddr((char*)&addr.sin_addr, sizeof(addr.sin_addr),
698                               AF_INET)))
699         r = (char*) host->h_name;
700     else
701         r = inet_ntoa(addr.sin_addr);
702     sprintf(buf, "tcp:%s", r);
703     return buf;
704 }