1 /****************************************************************************
3 * GNAT COMPILER COMPONENTS *
7 * C Implementation File *
9 * Copyright (C) 2003-2024, Free Software Foundation, Inc. *
11 * GNAT is free software; you can redistribute it and/or modify it under *
12 * terms of the GNU General Public License as published by the Free Soft- *
13 * ware Foundation; either version 3, or (at your option) any later ver- *
14 * sion. GNAT is distributed in the hope that it will be useful, but WITH- *
15 * OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY *
16 * or FITNESS FOR A PARTICULAR PURPOSE. *
18 * As a special exception under Section 7 of GPL version 3, you are granted *
19 * additional permissions described in the GCC Runtime Library Exception, *
20 * version 3.1, as published by the Free Software Foundation. *
22 * You should have received a copy of the GNU General Public License and *
23 * a copy of the GCC Runtime Library Exception along with this program; *
24 * see the files COPYING3 and COPYING.RUNTIME respectively. If not, see *
25 * <http://www.gnu.org/licenses/>. *
27 * GNAT was originally developed by the GNAT team at New York University. *
28 * Extensive contributions were provided by Ada Core Technologies Inc. *
30 ****************************************************************************/
32 /* This file provides a portable binding to the sockets API */
34 #define ATTRIBUTE_UNUSED __attribute__((unused))
36 /* Ensure access to errno is thread safe. */
44 #if defined (__FreeBSD__) || defined (__DragonFly__) \
45 || defined (__NetBSD__) || defined (__OpenBSD__)
46 typedef unsigned int IOCTL_Req_T
;
48 typedef int IOCTL_Req_T
;
51 #if defined(HAVE_SOCKETS)
53 /* Include all the necessary system-specific headers and define the
54 * necessary macros (shared with gen-oscons).
57 #if !defined(SO_NOSIGPIPE) && !defined (MSG_NOSIGNAL)
60 /* Required if we will be calling signal() in __gnat_disable_all_sigpipes() */
63 /* Required for __gnat_malloc() */
66 /* Required for memcpy() */
68 extern void __gnat_disable_sigpipe (int fd
);
69 extern void __gnat_disable_all_sigpipes (void);
70 extern int __gnat_create_signalling_fds (int *fds
);
71 extern int __gnat_read_signalling_fd (int rsig
);
72 extern int __gnat_write_signalling_fd (int wsig
);
73 extern void __gnat_close_signalling_fd (int sig
);
74 extern void __gnat_last_socket_in_set (fd_set
*, int *);
75 extern void __gnat_get_socket_from_set (fd_set
*, int *, int *);
76 extern void __gnat_insert_socket_in_set (fd_set
*, int);
77 extern int __gnat_is_socket_in_set (fd_set
*, int);
78 extern fd_set
*__gnat_new_socket_set (fd_set
*);
79 extern void __gnat_remove_socket_from_set (fd_set
*, int);
80 extern void __gnat_reset_socket_set (fd_set
*);
81 extern int __gnat_get_h_errno (void);
82 extern int __gnat_socket_ioctl (int, IOCTL_Req_T
, int *);
84 extern char * __gnat_servent_s_name (struct servent
*);
85 extern char * __gnat_servent_s_alias (struct servent
*, int index
);
86 extern unsigned short __gnat_servent_s_port (struct servent
*);
87 extern char * __gnat_servent_s_proto (struct servent
*);
89 extern char * __gnat_hostent_h_name (struct hostent
*);
90 extern char * __gnat_hostent_h_alias (struct hostent
*, int);
91 extern int __gnat_hostent_h_addrtype (struct hostent
*);
92 extern int __gnat_hostent_h_length (struct hostent
*);
93 extern char * __gnat_hostent_h_addr (struct hostent
*, int);
95 extern int __gnat_getaddrinfo(
98 const struct addrinfo
*hints
,
99 struct addrinfo
**res
);
100 int __gnat_getnameinfo(
101 const struct sockaddr
*sa
, socklen_t salen
,
102 char *host
, size_t hostlen
,
103 char *serv
, size_t servlen
, int flags
);
104 extern void __gnat_freeaddrinfo(struct addrinfo
*res
);
105 extern const char * __gnat_gai_strerror(int errcode
);
107 #ifndef HAVE_INET_PTON
108 extern int __gnat_inet_pton (int, const char *, void *);
111 #ifndef HAVE_INET_NTOP
113 __gnat_inet_ntop(int, const void *, char *, socklen_t
);
116 /* Disable the sending of SIGPIPE for writes on a broken stream */
119 __gnat_disable_sigpipe (int fd ATTRIBUTE_UNUSED
)
123 (void) setsockopt (fd
, SOL_SOCKET
, SO_NOSIGPIPE
, &val
, sizeof val
);
128 __gnat_disable_all_sigpipes (void)
130 #if !defined(SO_NOSIGPIPE) && !defined(MSG_NOSIGNAL) && defined(SIGPIPE)
131 (void) signal (SIGPIPE
, SIG_IGN
);
135 #if defined (_WIN32) || defined (__vxworks)
137 * Signalling FDs operations are implemented in Ada for these platforms
138 * (see subunit GNAT.Sockets.Thin.Signalling_Fds).
142 * Create a pair of connected file descriptors fds[0] and fds[1] used for
143 * signalling by a Selector object. fds[0] is the read end, and fds[1] the
147 __gnat_create_signalling_fds (int *fds
) {
152 * Read one byte of data from rsig, the read end of a pair of signalling fds
153 * created by __gnat_create_signalling_fds.
156 __gnat_read_signalling_fd (int rsig
) {
158 return read (rsig
, &c
, 1);
162 * Write one byte of data to wsig, the write end of a pair of signalling fds
163 * created by __gnat_create_signalling_fds.
166 __gnat_write_signalling_fd (int wsig
) {
168 return write (wsig
, &c
, 1);
172 * Close one end of a pair of signalling fds
175 __gnat_close_signalling_fd (int sig
) {
181 * Handling of gethostbyname, gethostbyaddr, getservbyname and getservbyport
182 * =========================================================================
184 * This module exposes __gnat_getXXXbyYYY operations with the same signature
185 * as the reentrant variant getXXXbyYYY_r.
187 * On platforms where getXXXbyYYY is intrinsically reentrant, the provided user
188 * buffer argument is ignored.
190 * When getXXXbyYYY is not reentrant but getXXXbyYYY_r exists, the latter is
191 * used, and the provided buffer argument must point to a valid, thread-local
192 * buffer (usually on the caller's stack).
194 * When getXXXbyYYY is not reentrant and no reentrant getXXXbyYYY_r variant
195 * is available, the non-reentrant getXXXbyYYY is called, the provided user
196 * buffer is ignored, and the caller is expected to take care of mutual
200 #ifdef HAVE_GETxxxBYyyy_R
202 __gnat_gethostbyname (const char *name
,
203 struct hostent
*ret
, char *buf
, size_t buflen
,
209 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
210 (void) gethostbyname_r (name
, ret
, buf
, buflen
, &rh
, h_errnop
);
212 rh
= gethostbyname_r (name
, ret
, buf
, buflen
, h_errnop
);
214 ri
= (rh
== NULL
) ? -1 : 0;
219 __gnat_gethostbyaddr (const char *addr
, int len
, int type
,
220 struct hostent
*ret
, char *buf
, size_t buflen
,
226 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
227 (void) gethostbyaddr_r (addr
, len
, type
, ret
, buf
, buflen
, &rh
, h_errnop
);
229 rh
= gethostbyaddr_r (addr
, len
, type
, ret
, buf
, buflen
, h_errnop
);
231 ri
= (rh
== NULL
) ? -1 : 0;
236 __gnat_getservbyname (const char *name
, const char *proto
,
237 struct servent
*ret
, char *buf
, size_t buflen
)
242 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
243 (void) getservbyname_r (name
, proto
, ret
, buf
, buflen
, &rh
);
245 rh
= getservbyname_r (name
, proto
, ret
, buf
, buflen
);
247 ri
= (rh
== NULL
) ? -1 : 0;
252 __gnat_getservbyport (int port
, const char *proto
,
253 struct servent
*ret
, char *buf
, size_t buflen
)
258 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
259 (void) getservbyport_r (port
, proto
, ret
, buf
, buflen
, &rh
);
261 rh
= getservbyport_r (port
, proto
, ret
, buf
, buflen
);
263 ri
= (rh
== NULL
) ? -1 : 0;
266 #elif defined (__vxworks)
267 static char vxw_h_name
[MAXHOSTNAMELEN
+ 1];
268 static char *vxw_h_aliases
[1] = { NULL
};
269 static int vxw_h_addr
;
270 static char *vxw_h_addr_list
[2] = { (char*) &vxw_h_addr
, NULL
};
273 __gnat_gethostbyname (const char *name
,
274 struct hostent
*ret
, char *buf
, size_t buflen
,
277 vxw_h_addr
= hostGetByName (name
);
278 if (vxw_h_addr
== ERROR
) {
279 *h_errnop
= __gnat_get_h_errno ();
283 ret
->h_aliases
= &vxw_h_aliases
;
284 ret
->h_addrtype
= AF_INET
;
286 ret
->h_addr_list
= &vxw_h_addr_list
;
291 __gnat_gethostbyaddr (const char *addr
, int len
, int type
,
292 struct hostent
*ret
, char *buf
, size_t buflen
,
295 if (type
!= AF_INET
) {
296 *h_errnop
= EAFNOSUPPORT
;
300 if (addr
== NULL
|| len
!= 4) {
305 if (hostGetByAddr (*(int*)addr
, &vxw_h_name
) != OK
) {
306 *h_errnop
= __gnat_get_h_errno ();
312 ret
->h_name
= &vxw_h_name
;
313 ret
->h_aliases
= &vxw_h_aliases
;
314 ret
->h_addrtype
= AF_INET
;
316 ret
->h_addr_list
= &vxw_h_addr_list
;
321 __gnat_getservbyname (const char *name
, const char *proto
,
322 struct servent
*ret
, char *buf
, size_t buflen
)
324 /* Not available under VxWorks */
329 __gnat_getservbyport (int port
, const char *proto
,
330 struct servent
*ret
, char *buf
, size_t buflen
)
332 /* Not available under VxWorks */
337 __gnat_gethostbyname (const char *name
, struct hostent
*ret
,
338 char *buf ATTRIBUTE_UNUSED
, size_t buflen ATTRIBUTE_UNUSED
,
342 rh
= gethostbyname (name
);
344 *h_errnop
= __gnat_get_h_errno ();
353 __gnat_gethostbyaddr (const char *addr
, int len
, int type
, struct hostent
*ret
,
354 char *buf ATTRIBUTE_UNUSED
, size_t buflen ATTRIBUTE_UNUSED
,
358 rh
= gethostbyaddr (addr
, len
, type
);
360 *h_errnop
= __gnat_get_h_errno ();
369 __gnat_getservbyname (const char *name
, const char *proto
, struct servent
*ret
,
370 char *buf ATTRIBUTE_UNUSED
, size_t buflen ATTRIBUTE_UNUSED
)
373 rh
= getservbyname (name
, proto
);
381 __gnat_getservbyport (int port
, const char *proto
, struct servent
*ret
,
382 char *buf ATTRIBUTE_UNUSED
, size_t buflen ATTRIBUTE_UNUSED
)
385 rh
= getservbyport (port
, proto
);
393 /* Find the largest socket in the socket set SET. This is needed for
394 `select'. LAST is the maximum value for the largest socket. This hint is
395 used to avoid scanning very large socket sets. On return, LAST is the
396 actual largest socket in the socket set. */
399 __gnat_last_socket_in_set (fd_set
*set
, int *last
)
405 /* More efficient method for NT. */
406 for (unsigned int s
= 0; s
< set
->fd_count
; s
++)
407 if ((int) set
->fd_array
[s
] > l
)
408 l
= set
->fd_array
[s
];
412 for (int s
= *last
; s
!= -1; s
--)
413 if (FD_ISSET (s
, set
))
423 /* Get last socket and remove it from the socket set SET. LAST is the
424 maximum value of the largest socket. This hint is used to avoid scanning
425 very large socket sets. On return, LAST is set to the actual largest
426 socket in the socket set. */
429 __gnat_get_socket_from_set (fd_set
*set
, int *last
, int *socket
)
432 FD_CLR (*socket
, set
);
433 __gnat_last_socket_in_set (set
, last
);
436 /* Insert SOCKET in the socket set SET. */
439 __gnat_insert_socket_in_set (fd_set
*set
, int socket
)
441 FD_SET (socket
, set
);
444 /* Check whether a given SOCKET is in the socket set SET. */
447 __gnat_is_socket_in_set (fd_set
*set
, int socket
)
449 return FD_ISSET (socket
, set
);
452 /* Remove SOCKET from the socket set SET. */
455 __gnat_remove_socket_from_set (fd_set
*set
, int socket
)
457 FD_CLR (socket
, set
);
462 __gnat_reset_socket_set (fd_set
*set
)
467 /* Get the value of the last host error */
470 __gnat_get_h_errno (void) {
472 int vxw_errno
= errno
;
478 #ifdef S_hostLib_HOST_NOT_FOUND
479 case S_hostLib_HOST_NOT_FOUND
:
481 case S_hostLib_UNKNOWN_HOST
:
482 return HOST_NOT_FOUND
;
484 #ifdef S_hostLib_TRY_AGAIN
485 case S_hostLib_TRY_AGAIN
:
489 #ifdef S_hostLib_NO_RECOVERY
490 case S_hostLib_NO_RECOVERY
:
492 #ifdef S_hostLib_NETDB_INTERNAL
493 case S_hostLib_NETDB_INTERNAL
:
495 case S_hostLib_INVALID_PARAMETER
:
502 #elif defined (__rtems__)
503 /* At this stage in the tool build, no networking .h files are available.
504 * Newlib does not provide networking .h files and RTEMS is not built yet.
505 * So we need to explicitly extern h_errno to access it.
515 /* Wrapper for ioctl(2), which is a variadic function */
518 __gnat_socket_ioctl (int fd
, IOCTL_Req_T req
, int *arg
) {
520 return ioctlsocket (fd
, req
, (unsigned long *)arg
);
521 #elif defined (__APPLE__)
523 * On Darwin, req is an unsigned long, and we want to convert without sign
524 * extension to get the proper bit pattern in the case of a 64 bit kernel.
526 return ioctl (fd
, (unsigned int) req
, arg
);
528 return ioctl (fd
, req
, arg
);
532 #ifndef HAVE_INET_PTON
535 __gnat_inet_pton (int af
, const char *src
, void *dst
) {
537 #if defined (_WIN32) && defined (AF_INET6)
543 errno
= EAFNOSUPPORT
;
547 #if defined (__vxworks)
548 return (inet_aton (src
, dst
) == OK
);
550 #elif defined (_WIN32)
551 struct sockaddr_storage ss
;
552 int sslen
= sizeof ss
;
556 rc
= WSAStringToAddressA ((char *)src
, af
, NULL
, (struct sockaddr
*)&ss
,
561 *(struct in_addr
*)dst
= ((struct sockaddr_in
*)&ss
)->sin_addr
;
565 *(struct in6_addr
*)dst
= ((struct sockaddr_in6
*)&ss
)->sin6_addr
;
572 #elif defined (__hpux__)
576 if (src
== NULL
|| dst
== NULL
) {
579 } else if (!strcmp (src
, "255.255.255.255")) {
584 addr
= inet_addr (src
);
585 rc
= (addr
!= 0xffffffff);
588 *(in_addr_t
*)dst
= addr
;
598 #ifndef HAVE_INET_NTOP
601 __gnat_inet_ntop(int af
, const void *src
, char *dst
, socklen_t size
)
604 struct sockaddr_storage ss
;
605 int sslen
= sizeof ss
;
606 memset(&ss
, 0, sslen
);
611 ((struct sockaddr_in6
*)&ss
)->sin6_addr
= *(struct in6_addr
*)src
;
614 ((struct sockaddr_in
*)&ss
)->sin_addr
= *(struct in_addr
*)src
;
617 errno
= EAFNOSUPPORT
;
623 if (WSAAddressToStringA((struct sockaddr
*)&ss
, sslen
, 0, dst
, &sz
) != 0) {
634 * Accessor functions for struct hostent.
637 char * __gnat_hostent_h_name (struct hostent
* h
) {
641 char * __gnat_hostent_h_alias (struct hostent
* h
, int index
) {
642 return h
->h_aliases
[index
];
645 int __gnat_hostent_h_addrtype (struct hostent
* h
) {
646 return h
->h_addrtype
;
649 int __gnat_hostent_h_length (struct hostent
* h
) {
653 char * __gnat_hostent_h_addr (struct hostent
* h
, int index
) {
654 return h
->h_addr_list
[index
];
658 * Accessor functions for struct servent.
660 * These are needed because servent has different representations on different
661 * platforms, and we don't want to deal with that on the Ada side. For example,
662 * on Linux, we have (see /usr/include netdb.h):
672 * and on Windows (see mingw's socket.h):
688 __gnat_servent_s_name (struct servent
* s
)
694 __gnat_servent_s_alias (struct servent
* s
, int index
)
696 return s
->s_aliases
[index
];
700 __gnat_servent_s_port (struct servent
* s
)
706 __gnat_servent_s_proto (struct servent
* s
)
711 #if defined(AF_INET6) && !defined(__rtems__)
713 int __gnat_getaddrinfo(
716 const struct addrinfo
*hints
,
717 struct addrinfo
**res
)
719 return getaddrinfo(node
, service
, hints
, res
);
722 int __gnat_getnameinfo(
723 const struct sockaddr
*sa
, socklen_t salen
,
724 char *host
, size_t hostlen
,
725 char *serv
, size_t servlen
, int flags
)
727 return getnameinfo(sa
, salen
, host
, hostlen
, serv
, servlen
, flags
);
730 void __gnat_freeaddrinfo(struct addrinfo
*res
) {
734 const char * __gnat_gai_strerror(int errcode
) {
735 #if defined(_WIN32) || defined(__vxworks)
736 // gai_strerror thread usafe on Windows and is not available on some vxWorks
741 return "Temporary failure in name resolution.";
743 return "Invalid value for ai_flags.";
745 return "Nonrecoverable failure in name resolution.";
747 return "The ai_family member is not supported.";
749 return "Memory allocation failure.";
751 // Could be not defined under the vxWorks
753 return "No address associated with nodename.";
755 #if EAI_NODATA != EAI_NONAME
756 /* with mingw64 runtime EAI_NODATA and EAI_NONAME have the same value.
757 This applies to both win32 and win64 */
759 return "Neither nodename nor servname provided, or not known.";
762 return "The servname parameter is not supported for ai_socktype.";
764 return "The ai_socktype member is not supported.";
766 // Could be not defined, at least on Windows
768 return "System error returned in errno";
771 return "Unknown error.";
774 return gai_strerror(errcode
);
780 int __gnat_getaddrinfo(
783 const struct addrinfo
*hints
,
784 struct addrinfo
**res
)
789 int __gnat_getnameinfo(
790 const struct sockaddr
*sa
, socklen_t salen
,
791 char *host
, size_t hostlen
,
792 char *serv
, size_t servlen
, int flags
)
797 void __gnat_freeaddrinfo(struct addrinfo
*res
) {
800 const char * __gnat_gai_strerror(int errcode
) {
801 return "getaddinfo functions family is not supported";
806 int __gnat_minus_500ms() {
808 // Windows Server 2019 and Windows 8.0 do not need 500 millisecond socket
809 // timeout correction.
810 if (IsWindowsServer()) {
812 ZeroMemory(&osvi
, sizeof(OSVERSIONINFO
));
813 osvi
.dwOSVersionInfoSize
= sizeof(OSVERSIONINFO
);
814 // Documentation proposes to use IsWindowsVersionOrGreater(10, 0, 17763)
815 // but it does not compare by the build number (last parameter).
817 return osvi
.dwMajorVersion
< 10
818 || (osvi
.dwMajorVersion
== 10
819 && osvi
.dwMinorVersion
== 0
820 && osvi
.dwBuildNumber
< 17763);
822 return !IsWindows8OrGreater();
829 #endif /* defined(HAVE_SOCKETS) */