This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #61392] Method call documentation in perlobj.pod
[perl5.git] / win32 / win32sck.c
1 /* win32sck.c
2  *
3  * (c) 1995 Microsoft Corporation. All rights reserved. 
4  *              Developed by hip communications inc., http://info.hip.com/info/
5  * Portions (c) 1993 Intergraph Corporation. All rights reserved.
6  *
7  *    You may distribute under the terms of either the GNU General Public
8  *    License or the Artistic License, as specified in the README file.
9  */
10
11 #define WIN32IO_IS_STDIO
12 #define WIN32SCK_IS_STDSCK
13 #define WIN32_LEAN_AND_MEAN
14 #define PERLIO_NOT_STDIO 0
15 #ifdef __GNUC__
16 #define Win32_Winsock
17 #endif
18 #include <windows.h>
19 #include <ws2spi.h>
20
21 #include "EXTERN.h"
22 #include "perl.h"
23
24 #include "Win32iop.h"
25 #include <sys/socket.h>
26 #include <fcntl.h>
27 #include <sys/stat.h>
28 #include <assert.h>
29 #include <io.h>
30
31 /* thanks to Beverly Brown      (beverly@datacube.com) */
32 #ifdef USE_SOCKETS_AS_HANDLES
33 #       define OPEN_SOCKET(x)   win32_open_osfhandle(x,O_RDWR|O_BINARY)
34 #       define TO_SOCKET(x)     _get_osfhandle(x)
35 #else
36 #       define OPEN_SOCKET(x)   (x)
37 #       define TO_SOCKET(x)     (x)
38 #endif  /* USE_SOCKETS_AS_HANDLES */
39
40 #define StartSockets() \
41     STMT_START {                                        \
42         if (!wsock_started)                             \
43             start_sockets();                            \
44     } STMT_END
45
46 #define SOCKET_TEST(x, y) \
47     STMT_START {                                        \
48         StartSockets();                                 \
49         if((x) == (y))                                  \
50             errno = WSAGetLastError();                  \
51     } STMT_END
52
53 #define SOCKET_TEST_ERROR(x) SOCKET_TEST(x, SOCKET_ERROR)
54
55 static struct servent* win32_savecopyservent(struct servent*d,
56                                              struct servent*s,
57                                              const char *proto);
58
59 static int wsock_started = 0;
60
61 EXTERN_C void
62 EndSockets(void)
63 {
64     if (wsock_started)
65         WSACleanup();
66 }
67
68 void
69 start_sockets(void) 
70 {
71     dTHX;
72     unsigned short version;
73     WSADATA retdata;
74     int ret;
75
76     /*
77      * initalize the winsock interface and insure that it is
78      * cleaned up at exit.
79      */
80     version = 0x2;
81     if(ret = WSAStartup(version, &retdata))
82         Perl_croak_nocontext("Unable to locate winsock library!\n");
83     if(retdata.wVersion != version)
84         Perl_croak_nocontext("Could not find version 2.0 of winsock dll\n");
85
86     /* atexit((void (*)(void)) EndSockets); */
87     wsock_started = 1;
88 }
89
90 #ifndef USE_SOCKETS_AS_HANDLES
91 #undef fdopen
92 FILE *
93 my_fdopen(int fd, char *mode)
94 {
95     FILE *fp;
96     char sockbuf[256];
97     int optlen = sizeof(sockbuf);
98     int retval;
99
100     if (!wsock_started)
101         return(fdopen(fd, mode));
102
103     retval = getsockopt((SOCKET)fd, SOL_SOCKET, SO_TYPE, sockbuf, &optlen);
104     if(retval == SOCKET_ERROR && WSAGetLastError() == WSAENOTSOCK) {
105         return(fdopen(fd, mode));
106     }
107
108     /*
109      * If we get here, then fd is actually a socket.
110      */
111     Newxz(fp, 1, FILE); /* XXX leak, good thing this code isn't used */
112     if(fp == NULL) {
113         errno = ENOMEM;
114         return NULL;
115     }
116
117     fp->_file = fd;
118     if(*mode == 'r')
119         fp->_flag = _IOREAD;
120     else
121         fp->_flag = _IOWRT;
122    
123     return fp;
124 }
125 #endif  /* USE_SOCKETS_AS_HANDLES */
126
127
128 u_long
129 win32_htonl(u_long hostlong)
130 {
131     StartSockets();
132     return htonl(hostlong);
133 }
134
135 u_short
136 win32_htons(u_short hostshort)
137 {
138     StartSockets();
139     return htons(hostshort);
140 }
141
142 u_long
143 win32_ntohl(u_long netlong)
144 {
145     StartSockets();
146     return ntohl(netlong);
147 }
148
149 u_short
150 win32_ntohs(u_short netshort)
151 {
152     StartSockets();
153     return ntohs(netshort);
154 }
155
156
157
158 SOCKET
159 win32_accept(SOCKET s, struct sockaddr *addr, int *addrlen)
160 {
161     SOCKET r;
162
163     SOCKET_TEST((r = accept(TO_SOCKET(s), addr, addrlen)), INVALID_SOCKET);
164     return OPEN_SOCKET(r);
165 }
166
167 int
168 win32_bind(SOCKET s, const struct sockaddr *addr, int addrlen)
169 {
170     int r;
171
172     SOCKET_TEST_ERROR(r = bind(TO_SOCKET(s), addr, addrlen));
173     return r;
174 }
175
176 int
177 win32_connect(SOCKET s, const struct sockaddr *addr, int addrlen)
178 {
179     int r;
180
181     SOCKET_TEST_ERROR(r = connect(TO_SOCKET(s), addr, addrlen));
182     return r;
183 }
184
185
186 int
187 win32_getpeername(SOCKET s, struct sockaddr *addr, int *addrlen)
188 {
189     int r;
190
191     SOCKET_TEST_ERROR(r = getpeername(TO_SOCKET(s), addr, addrlen));
192     return r;
193 }
194
195 int
196 win32_getsockname(SOCKET s, struct sockaddr *addr, int *addrlen)
197 {
198     int r;
199
200     SOCKET_TEST_ERROR(r = getsockname(TO_SOCKET(s), addr, addrlen));
201     return r;
202 }
203
204 int
205 win32_getsockopt(SOCKET s, int level, int optname, char *optval, int *optlen)
206 {
207     int r;
208
209     SOCKET_TEST_ERROR(r = getsockopt(TO_SOCKET(s), level, optname, optval, optlen));
210     return r;
211 }
212
213 int
214 win32_ioctlsocket(SOCKET s, long cmd, u_long *argp)
215 {
216     int r;
217
218     SOCKET_TEST_ERROR(r = ioctlsocket(TO_SOCKET(s), cmd, argp));
219     return r;
220 }
221
222 int
223 win32_listen(SOCKET s, int backlog)
224 {
225     int r;
226
227     SOCKET_TEST_ERROR(r = listen(TO_SOCKET(s), backlog));
228     return r;
229 }
230
231 int
232 win32_recv(SOCKET s, char *buf, int len, int flags)
233 {
234     int r;
235
236     SOCKET_TEST_ERROR(r = recv(TO_SOCKET(s), buf, len, flags));
237     return r;
238 }
239
240 int
241 win32_recvfrom(SOCKET s, char *buf, int len, int flags, struct sockaddr *from, int *fromlen)
242 {
243     int r;
244     int frombufsize = *fromlen;
245
246     SOCKET_TEST_ERROR(r = recvfrom(TO_SOCKET(s), buf, len, flags, from, fromlen));
247     /* Winsock's recvfrom() only returns a valid 'from' when the socket
248      * is connectionless.  Perl expects a valid 'from' for all types
249      * of sockets, so go the extra mile.
250      */
251     if (r != SOCKET_ERROR && frombufsize == *fromlen)
252         (void)win32_getpeername(s, from, fromlen);
253     return r;
254 }
255
256 /* select contributed by Vincent R. Slyngstad (vrs@ibeam.intel.com) */
257 int
258 win32_select(int nfds, Perl_fd_set* rd, Perl_fd_set* wr, Perl_fd_set* ex, const struct timeval* timeout)
259 {
260     int r;
261 #ifdef USE_SOCKETS_AS_HANDLES
262     int i, fd, save_errno = errno;
263     FD_SET nrd, nwr, nex;
264
265     /* winsock seems incapable of dealing with all three null fd_sets,
266      * so do the (millisecond) sleep as a special case
267      */
268     if (!(rd || wr || ex)) {
269         if (timeout)
270             Sleep(timeout->tv_sec  * 1000 +
271                   timeout->tv_usec / 1000);     /* do the best we can */
272         else
273             Sleep(UINT_MAX);
274         return 0;
275     }
276     StartSockets();
277
278     FD_ZERO(&nrd);
279     FD_ZERO(&nwr);
280     FD_ZERO(&nex);
281     for (i = 0; i < nfds; i++) {
282         fd = TO_SOCKET(i);
283         if (rd && PERL_FD_ISSET(i,rd))
284             FD_SET((unsigned)fd, &nrd);
285         if (wr && PERL_FD_ISSET(i,wr))
286             FD_SET((unsigned)fd, &nwr);
287         if (ex && PERL_FD_ISSET(i,ex))
288             FD_SET((unsigned)fd, &nex);
289     }
290
291     errno = save_errno;
292     SOCKET_TEST_ERROR(r = select(nfds, &nrd, &nwr, &nex, timeout));
293     save_errno = errno;
294
295     for (i = 0; i < nfds; i++) {
296         fd = TO_SOCKET(i);
297         if (rd && PERL_FD_ISSET(i,rd) && !FD_ISSET(fd, &nrd))
298             PERL_FD_CLR(i,rd);
299         if (wr && PERL_FD_ISSET(i,wr) && !FD_ISSET(fd, &nwr))
300             PERL_FD_CLR(i,wr);
301         if (ex && PERL_FD_ISSET(i,ex) && !FD_ISSET(fd, &nex))
302             PERL_FD_CLR(i,ex);
303     }
304     errno = save_errno;
305 #else
306     SOCKET_TEST_ERROR(r = select(nfds, rd, wr, ex, timeout));
307 #endif
308     return r;
309 }
310
311 int
312 win32_send(SOCKET s, const char *buf, int len, int flags)
313 {
314     int r;
315
316     SOCKET_TEST_ERROR(r = send(TO_SOCKET(s), buf, len, flags));
317     return r;
318 }
319
320 int
321 win32_sendto(SOCKET s, const char *buf, int len, int flags,
322              const struct sockaddr *to, int tolen)
323 {
324     int r;
325
326     SOCKET_TEST_ERROR(r = sendto(TO_SOCKET(s), buf, len, flags, to, tolen));
327     return r;
328 }
329
330 int
331 win32_setsockopt(SOCKET s, int level, int optname, const char *optval, int optlen)
332 {
333     int r;
334
335     SOCKET_TEST_ERROR(r = setsockopt(TO_SOCKET(s), level, optname, optval, optlen));
336     return r;
337 }
338     
339 int
340 win32_shutdown(SOCKET s, int how)
341 {
342     int r;
343
344     SOCKET_TEST_ERROR(r = shutdown(TO_SOCKET(s), how));
345     return r;
346 }
347
348 int
349 win32_closesocket(SOCKET s)
350 {
351     int r;
352
353     SOCKET_TEST_ERROR(r = closesocket(TO_SOCKET(s)));
354     return r;
355 }
356
357 #ifdef USE_SOCKETS_AS_HANDLES
358 #define WIN32_OPEN_SOCKET(af, type, protocol) open_ifs_socket(af, type, protocol)
359
360 void
361 convert_proto_info_w2a(WSAPROTOCOL_INFOW *in, WSAPROTOCOL_INFOA *out)
362 {
363     Copy(in, out, 1, WSAPROTOCOL_INFOA);
364     wcstombs(out->szProtocol, in->szProtocol, sizeof(out->szProtocol));
365 }
366
367 SOCKET
368 open_ifs_socket(int af, int type, int protocol)
369 {
370     dTHX;
371     char *s;
372     unsigned long proto_buffers_len = 0;
373     int error_code;
374     SOCKET out = INVALID_SOCKET;
375
376     if ((s = PerlEnv_getenv("PERL_ALLOW_NON_IFS_LSP")) && atoi(s))
377         return WSASocket(af, type, protocol, NULL, 0, 0);
378
379     if (WSCEnumProtocols(NULL, NULL, &proto_buffers_len, &error_code) == SOCKET_ERROR
380         && error_code == WSAENOBUFS)
381     {
382         WSAPROTOCOL_INFOW *proto_buffers;
383         int protocols_available = 0;       
384  
385         Newx(proto_buffers, proto_buffers_len / sizeof(WSAPROTOCOL_INFOW),
386             WSAPROTOCOL_INFOW);
387
388         if ((protocols_available = WSCEnumProtocols(NULL, proto_buffers, 
389             &proto_buffers_len, &error_code)) != SOCKET_ERROR)
390         {
391             int i;
392             for (i = 0; i < protocols_available; i++)
393             {
394                 WSAPROTOCOL_INFOA proto_info;
395
396                 if ((af != AF_UNSPEC && af != proto_buffers[i].iAddressFamily)
397                     || (type != proto_buffers[i].iSocketType)
398                     || (protocol != 0 && proto_buffers[i].iProtocol != 0 &&
399                         protocol != proto_buffers[i].iProtocol))
400                     continue;
401
402                 if ((proto_buffers[i].dwServiceFlags1 & XP1_IFS_HANDLES) == 0)
403                     continue;
404
405                 convert_proto_info_w2a(&(proto_buffers[i]), &proto_info);
406
407                 out = WSASocket(af, type, protocol, &proto_info, 0, 0);
408                 break;
409             }
410         }
411
412         Safefree(proto_buffers);
413     }
414
415     return out;
416 }
417
418 #else
419 #define WIN32_OPEN_SOCKET(af, type, protocol) socket(af, type, protocol)
420 #endif
421
422 SOCKET
423 win32_socket(int af, int type, int protocol)
424 {
425     SOCKET s;
426
427 #ifndef USE_SOCKETS_AS_HANDLES
428     SOCKET_TEST(s = socket(af, type, protocol), INVALID_SOCKET);
429 #else
430     StartSockets();
431
432     if((s = WIN32_OPEN_SOCKET(af, type, protocol)) == INVALID_SOCKET)
433         errno = WSAGetLastError();
434     else
435         s = OPEN_SOCKET(s);
436 #endif  /* USE_SOCKETS_AS_HANDLES */
437
438     return s;
439 }
440
441 /*
442  * close RTL fd while respecting sockets
443  * added as temporary measure until PerlIO has real
444  * Win32 native layer
445  *   -- BKS, 11-11-2000
446 */
447
448 int my_close(int fd)
449 {
450     int osf;
451     if (!wsock_started)         /* No WinSock? */
452         return(close(fd));      /* Then not a socket. */
453     osf = TO_SOCKET(fd);/* Get it now before it's gone! */
454     if (osf != -1) {
455         int err;
456         err = closesocket(osf);
457         if (err == 0) {
458 #if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
459             _set_osfhnd(fd, INVALID_HANDLE_VALUE);
460 #endif
461             (void)close(fd);    /* handle already closed, ignore error */
462             return 0;
463         }
464         else if (err == SOCKET_ERROR) {
465             err = WSAGetLastError();
466             if (err != WSAENOTSOCK) {
467                 (void)close(fd);
468                 errno = err;
469                 return EOF;
470             }
471         }
472     }
473     return close(fd);
474 }
475
476 #undef fclose
477 int
478 my_fclose (FILE *pf)
479 {
480     int osf;
481     if (!wsock_started)         /* No WinSock? */
482         return(fclose(pf));     /* Then not a socket. */
483     osf = TO_SOCKET(win32_fileno(pf));/* Get it now before it's gone! */
484     if (osf != -1) {
485         int err;
486         win32_fflush(pf);
487         err = closesocket(osf);
488         if (err == 0) {
489 #if defined(USE_FIXED_OSFHANDLE) || defined(PERL_MSVCRT_READFIX)
490             _set_osfhnd(win32_fileno(pf), INVALID_HANDLE_VALUE);
491 #endif
492             (void)fclose(pf);   /* handle already closed, ignore error */
493             return 0;
494         }
495         else if (err == SOCKET_ERROR) {
496             err = WSAGetLastError();
497             if (err != WSAENOTSOCK) {
498                 (void)fclose(pf);
499                 errno = err;
500                 return EOF;
501             }
502         }
503     }
504     return fclose(pf);
505 }
506
507 #undef fstat
508 int
509 my_fstat(int fd, Stat_t *sbufptr)
510 {
511     /* This fixes a bug in fstat() on Windows 9x.  fstat() uses the
512      * GetFileType() win32 syscall, which will fail on Windows 9x.
513      * So if we recognize a socket on Windows 9x, we return the
514      * same results as on Windows NT/2000.
515      * XXX this should be extended further to set S_IFSOCK on
516      * sbufptr->st_mode.
517      */
518     int osf;
519     if (!wsock_started || IsWinNT()) {
520 #if defined(WIN64) || defined(USE_LARGE_FILES)
521 #if defined(__BORLANDC__) /* buk */
522         return win32_fstat(fd, sbufptr );
523 #else
524         return _fstati64(fd, sbufptr);
525 #endif
526 #else
527         return fstat(fd, sbufptr);
528 #endif
529     }
530
531     osf = TO_SOCKET(fd);
532     if (osf != -1) {
533         char sockbuf[256];
534         int optlen = sizeof(sockbuf);
535         int retval;
536
537         retval = getsockopt((SOCKET)osf, SOL_SOCKET, SO_TYPE, sockbuf, &optlen);
538         if (retval != SOCKET_ERROR || WSAGetLastError() != WSAENOTSOCK) {
539 #if defined(__BORLANDC__)&&(__BORLANDC__<=0x520)
540             sbufptr->st_mode = S_IFIFO;
541 #else
542             sbufptr->st_mode = _S_IFIFO;
543 #endif
544             sbufptr->st_rdev = sbufptr->st_dev = (dev_t)fd;
545             sbufptr->st_nlink = 1;
546             sbufptr->st_uid = sbufptr->st_gid = sbufptr->st_ino = 0;
547             sbufptr->st_atime = sbufptr->st_mtime = sbufptr->st_ctime = 0;
548             sbufptr->st_size = (Off_t)0;
549             return 0;
550         }
551     }
552 #if defined(WIN64) || defined(USE_LARGE_FILES)
553 #if defined(__BORLANDC__) /* buk */
554     return win32_fstat(fd, sbufptr );
555 #else
556     return _fstati64(fd, sbufptr);
557 #endif
558 #else
559     return fstat(fd, sbufptr);
560 #endif
561 }
562
563 struct hostent *
564 win32_gethostbyaddr(const char *addr, int len, int type)
565 {
566     struct hostent *r;
567
568     SOCKET_TEST(r = gethostbyaddr(addr, len, type), NULL);
569     return r;
570 }
571
572 struct hostent *
573 win32_gethostbyname(const char *name)
574 {
575     struct hostent *r;
576
577     SOCKET_TEST(r = gethostbyname(name), NULL);
578     return r;
579 }
580
581 int
582 win32_gethostname(char *name, int len)
583 {
584     int r;
585
586     SOCKET_TEST_ERROR(r = gethostname(name, len));
587     return r;
588 }
589
590 struct protoent *
591 win32_getprotobyname(const char *name)
592 {
593     struct protoent *r;
594
595     SOCKET_TEST(r = getprotobyname(name), NULL);
596     return r;
597 }
598
599 struct protoent *
600 win32_getprotobynumber(int num)
601 {
602     struct protoent *r;
603
604     SOCKET_TEST(r = getprotobynumber(num), NULL);
605     return r;
606 }
607
608 struct servent *
609 win32_getservbyname(const char *name, const char *proto)
610 {
611     dTHX;    
612     struct servent *r;
613
614     SOCKET_TEST(r = getservbyname(name, proto), NULL);
615     if (r) {
616         r = win32_savecopyservent(&w32_servent, r, proto);
617     }
618     return r;
619 }
620
621 struct servent *
622 win32_getservbyport(int port, const char *proto)
623 {
624     dTHX; 
625     struct servent *r;
626
627     SOCKET_TEST(r = getservbyport(port, proto), NULL);
628     if (r) {
629         r = win32_savecopyservent(&w32_servent, r, proto);
630     }
631     return r;
632 }
633
634 int
635 win32_ioctl(int i, unsigned int u, char *data)
636 {
637     dTHX;
638     u_long u_long_arg; 
639     int retval;
640     
641     if (!wsock_started) {
642         Perl_croak_nocontext("ioctl implemented only on sockets");
643         /* NOTREACHED */
644     }
645
646     /* mauke says using memcpy avoids alignment issues */
647     memcpy(&u_long_arg, data, sizeof u_long_arg); 
648     retval = ioctlsocket(TO_SOCKET(i), (long)u, &u_long_arg);
649     memcpy(data, &u_long_arg, sizeof u_long_arg);
650     
651     if (retval == SOCKET_ERROR) {
652         if (WSAGetLastError() == WSAENOTSOCK) {
653             Perl_croak_nocontext("ioctl implemented only on sockets");
654             /* NOTREACHED */
655         }
656         errno = WSAGetLastError();
657     }
658     return retval;
659 }
660
661 char FAR *
662 win32_inet_ntoa(struct in_addr in)
663 {
664     StartSockets();
665     return inet_ntoa(in);
666 }
667
668 unsigned long
669 win32_inet_addr(const char FAR *cp)
670 {
671     StartSockets();
672     return inet_addr(cp);
673 }
674
675 /*
676  * Networking stubs
677  */
678
679 void
680 win32_endhostent() 
681 {
682     dTHX;
683     Perl_croak_nocontext("endhostent not implemented!\n");
684 }
685
686 void
687 win32_endnetent()
688 {
689     dTHX;
690     Perl_croak_nocontext("endnetent not implemented!\n");
691 }
692
693 void
694 win32_endprotoent()
695 {
696     dTHX;
697     Perl_croak_nocontext("endprotoent not implemented!\n");
698 }
699
700 void
701 win32_endservent()
702 {
703     dTHX;
704     Perl_croak_nocontext("endservent not implemented!\n");
705 }
706
707
708 struct netent *
709 win32_getnetent(void) 
710 {
711     dTHX;
712     Perl_croak_nocontext("getnetent not implemented!\n");
713     return (struct netent *) NULL;
714 }
715
716 struct netent *
717 win32_getnetbyname(char *name) 
718 {
719     dTHX;
720     Perl_croak_nocontext("getnetbyname not implemented!\n");
721     return (struct netent *)NULL;
722 }
723
724 struct netent *
725 win32_getnetbyaddr(long net, int type) 
726 {
727     dTHX;
728     Perl_croak_nocontext("getnetbyaddr not implemented!\n");
729     return (struct netent *)NULL;
730 }
731
732 struct protoent *
733 win32_getprotoent(void) 
734 {
735     dTHX;
736     Perl_croak_nocontext("getprotoent not implemented!\n");
737     return (struct protoent *) NULL;
738 }
739
740 struct servent *
741 win32_getservent(void) 
742 {
743     dTHX;
744     Perl_croak_nocontext("getservent not implemented!\n");
745     return (struct servent *) NULL;
746 }
747
748 void
749 win32_sethostent(int stayopen)
750 {
751     dTHX;
752     Perl_croak_nocontext("sethostent not implemented!\n");
753 }
754
755
756 void
757 win32_setnetent(int stayopen)
758 {
759     dTHX;
760     Perl_croak_nocontext("setnetent not implemented!\n");
761 }
762
763
764 void
765 win32_setprotoent(int stayopen)
766 {
767     dTHX;
768     Perl_croak_nocontext("setprotoent not implemented!\n");
769 }
770
771
772 void
773 win32_setservent(int stayopen)
774 {
775     dTHX;
776     Perl_croak_nocontext("setservent not implemented!\n");
777 }
778
779 static struct servent*
780 win32_savecopyservent(struct servent*d, struct servent*s, const char *proto)
781 {
782     d->s_name = s->s_name;
783     d->s_aliases = s->s_aliases;
784     d->s_port = s->s_port;
785 #ifndef __BORLANDC__    /* Buggy on Win95 and WinNT-with-Borland-WSOCK */
786     if (!IsWin95() && s->s_proto && strlen(s->s_proto))
787         d->s_proto = s->s_proto;
788     else
789 #endif
790     if (proto && strlen(proto))
791         d->s_proto = (char *)proto;
792     else
793         d->s_proto = "tcp";
794    
795     return d;
796 }
797
798