1 /****************************************************************************
3 * GNAT COMPILER COMPONENTS *
7 * C Implementation File *
9 * Copyright (C) 2003-2019, 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. */
42 #if defined (__FreeBSD__) || defined (__DragonFly__) \
43 || defined (__NetBSD__) || defined (__OpenBSD__)
44 typedef unsigned int IOCTL_Req_T
;
46 typedef int IOCTL_Req_T
;
49 #if defined(HAVE_SOCKETS)
51 /* Include all the necessary system-specific headers and define the
52 * necessary macros (shared with gen-oscons).
55 #if !defined(SO_NOSIGPIPE) && !defined (MSG_NOSIGNAL)
58 /* Required if we will be calling signal() in __gnat_disable_all_sigpipes() */
61 /* Required for __gnat_malloc() */
64 /* Required for memcpy() */
66 extern void __gnat_disable_sigpipe (int fd
);
67 extern void __gnat_disable_all_sigpipes (void);
68 extern int __gnat_create_signalling_fds (int *fds
);
69 extern int __gnat_read_signalling_fd (int rsig
);
70 extern int __gnat_write_signalling_fd (int wsig
);
71 extern void __gnat_close_signalling_fd (int sig
);
72 extern void __gnat_last_socket_in_set (fd_set
*, int *);
73 extern void __gnat_get_socket_from_set (fd_set
*, int *, int *);
74 extern void __gnat_insert_socket_in_set (fd_set
*, int);
75 extern int __gnat_is_socket_in_set (fd_set
*, int);
76 extern fd_set
*__gnat_new_socket_set (fd_set
*);
77 extern void __gnat_remove_socket_from_set (fd_set
*, int);
78 extern void __gnat_reset_socket_set (fd_set
*);
79 extern int __gnat_get_h_errno (void);
80 extern int __gnat_socket_ioctl (int, IOCTL_Req_T
, int *);
82 extern char * __gnat_servent_s_name (struct servent
*);
83 extern char * __gnat_servent_s_alias (struct servent
*, int index
);
84 extern unsigned short __gnat_servent_s_port (struct servent
*);
85 extern char * __gnat_servent_s_proto (struct servent
*);
87 extern char * __gnat_hostent_h_name (struct hostent
*);
88 extern char * __gnat_hostent_h_alias (struct hostent
*, int);
89 extern int __gnat_hostent_h_addrtype (struct hostent
*);
90 extern int __gnat_hostent_h_length (struct hostent
*);
91 extern char * __gnat_hostent_h_addr (struct hostent
*, int);
93 extern int __gnat_getaddrinfo(
96 const struct addrinfo
*hints
,
97 struct addrinfo
**res
);
98 int __gnat_getnameinfo(
99 const struct sockaddr
*sa
, socklen_t salen
,
100 char *host
, size_t hostlen
,
101 char *serv
, size_t servlen
, int flags
);
102 extern void __gnat_freeaddrinfo(struct addrinfo
*res
);
103 extern const char * __gnat_gai_strerror(int errcode
);
105 #ifndef HAVE_INET_PTON
106 extern int __gnat_inet_pton (int, const char *, void *);
109 #ifndef HAVE_INET_NTOP
111 __gnat_inet_ntop(int, const void *, char *, socklen_t
);
114 /* Disable the sending of SIGPIPE for writes on a broken stream */
117 __gnat_disable_sigpipe (int fd ATTRIBUTE_UNUSED
)
121 (void) setsockopt (fd
, SOL_SOCKET
, SO_NOSIGPIPE
, &val
, sizeof val
);
126 __gnat_disable_all_sigpipes (void)
128 #if !defined(SO_NOSIGPIPE) && !defined(MSG_NOSIGNAL) && defined(SIGPIPE)
129 (void) signal (SIGPIPE
, SIG_IGN
);
133 #if defined (_WIN32) || defined (__vxworks)
135 * Signalling FDs operations are implemented in Ada for these platforms
136 * (see subunit GNAT.Sockets.Thin.Signalling_Fds).
140 * Create a pair of connected file descriptors fds[0] and fds[1] used for
141 * signalling by a Selector object. fds[0] is the read end, and fds[1] the
145 __gnat_create_signalling_fds (int *fds
) {
150 * Read one byte of data from rsig, the read end of a pair of signalling fds
151 * created by __gnat_create_signalling_fds.
154 __gnat_read_signalling_fd (int rsig
) {
156 return read (rsig
, &c
, 1);
160 * Write one byte of data to wsig, the write end of a pair of signalling fds
161 * created by __gnat_create_signalling_fds.
164 __gnat_write_signalling_fd (int wsig
) {
166 return write (wsig
, &c
, 1);
170 * Close one end of a pair of signalling fds
173 __gnat_close_signalling_fd (int sig
) {
179 * Handling of gethostbyname, gethostbyaddr, getservbyname and getservbyport
180 * =========================================================================
182 * This module exposes __gnat_getXXXbyYYY operations with the same signature
183 * as the reentrant variant getXXXbyYYY_r.
185 * On platforms where getXXXbyYYY is intrinsically reentrant, the provided user
186 * buffer argument is ignored.
188 * When getXXXbyYYY is not reentrant but getXXXbyYYY_r exists, the latter is
189 * used, and the provided buffer argument must point to a valid, thread-local
190 * buffer (usually on the caller's stack).
192 * When getXXXbyYYY is not reentrant and no reentrant getXXXbyYYY_r variant
193 * is available, the non-reentrant getXXXbyYYY is called, the provided user
194 * buffer is ignored, and the caller is expected to take care of mutual
198 #ifdef HAVE_GETxxxBYyyy_R
200 __gnat_gethostbyname (const char *name
,
201 struct hostent
*ret
, char *buf
, size_t buflen
,
207 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
208 (void) gethostbyname_r (name
, ret
, buf
, buflen
, &rh
, h_errnop
);
210 rh
= gethostbyname_r (name
, ret
, buf
, buflen
, h_errnop
);
212 ri
= (rh
== NULL
) ? -1 : 0;
217 __gnat_gethostbyaddr (const char *addr
, int len
, int type
,
218 struct hostent
*ret
, char *buf
, size_t buflen
,
224 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
225 (void) gethostbyaddr_r (addr
, len
, type
, ret
, buf
, buflen
, &rh
, h_errnop
);
227 rh
= gethostbyaddr_r (addr
, len
, type
, ret
, buf
, buflen
, h_errnop
);
229 ri
= (rh
== NULL
) ? -1 : 0;
234 __gnat_getservbyname (const char *name
, const char *proto
,
235 struct servent
*ret
, char *buf
, size_t buflen
)
240 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
241 (void) getservbyname_r (name
, proto
, ret
, buf
, buflen
, &rh
);
243 rh
= getservbyname_r (name
, proto
, ret
, buf
, buflen
);
245 ri
= (rh
== NULL
) ? -1 : 0;
250 __gnat_getservbyport (int port
, const char *proto
,
251 struct servent
*ret
, char *buf
, size_t buflen
)
256 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
257 (void) getservbyport_r (port
, proto
, ret
, buf
, buflen
, &rh
);
259 rh
= getservbyport_r (port
, proto
, ret
, buf
, buflen
);
261 ri
= (rh
== NULL
) ? -1 : 0;
264 #elif defined (__vxworks)
265 static char vxw_h_name
[MAXHOSTNAMELEN
+ 1];
266 static char *vxw_h_aliases
[1] = { NULL
};
267 static int vxw_h_addr
;
268 static char *vxw_h_addr_list
[2] = { (char*) &vxw_h_addr
, NULL
};
271 __gnat_gethostbyname (const char *name
,
272 struct hostent
*ret
, char *buf
, size_t buflen
,
275 vxw_h_addr
= hostGetByName (name
);
276 if (vxw_h_addr
== ERROR
) {
277 *h_errnop
= __gnat_get_h_errno ();
281 ret
->h_aliases
= &vxw_h_aliases
;
282 ret
->h_addrtype
= AF_INET
;
284 ret
->h_addr_list
= &vxw_h_addr_list
;
289 __gnat_gethostbyaddr (const char *addr
, int len
, int type
,
290 struct hostent
*ret
, char *buf
, size_t buflen
,
293 if (type
!= AF_INET
) {
294 *h_errnop
= EAFNOSUPPORT
;
298 if (addr
== NULL
|| len
!= 4) {
303 if (hostGetByAddr (*(int*)addr
, &vxw_h_name
) != OK
) {
304 *h_errnop
= __gnat_get_h_errno ();
310 ret
->h_name
= &vxw_h_name
;
311 ret
->h_aliases
= &vxw_h_aliases
;
312 ret
->h_addrtype
= AF_INET
;
314 ret
->h_addr_list
= &vxw_h_addr_list
;
318 __gnat_getservbyname (const char *name
, const char *proto
,
319 struct servent
*ret
, char *buf
, size_t buflen
)
321 /* Not available under VxWorks */
326 __gnat_getservbyport (int port
, const char *proto
,
327 struct servent
*ret
, char *buf
, size_t buflen
)
329 /* Not available under VxWorks */
334 __gnat_gethostbyname (const char *name
,
335 struct hostent
*ret
, char *buf
, size_t buflen
,
339 rh
= gethostbyname (name
);
341 *h_errnop
= __gnat_get_h_errno ();
350 __gnat_gethostbyaddr (const char *addr
, int len
, int type
,
351 struct hostent
*ret
, char *buf
, size_t buflen
,
355 rh
= gethostbyaddr (addr
, len
, type
);
357 *h_errnop
= __gnat_get_h_errno ();
366 __gnat_getservbyname (const char *name
, const char *proto
,
367 struct servent
*ret
, char *buf
, size_t buflen
)
370 rh
= getservbyname (name
, proto
);
378 __gnat_getservbyport (int port
, const char *proto
,
379 struct servent
*ret
, char *buf
, size_t buflen
)
382 rh
= getservbyport (port
, proto
);
390 /* Find the largest socket in the socket set SET. This is needed for
391 `select'. LAST is the maximum value for the largest socket. This hint is
392 used to avoid scanning very large socket sets. On return, LAST is the
393 actual largest socket in the socket set. */
396 __gnat_last_socket_in_set (fd_set
*set
, int *last
)
403 /* More efficient method for NT. */
404 for (s
= 0; s
< set
->fd_count
; s
++)
405 if ((int) set
->fd_array
[s
] > l
)
406 l
= set
->fd_array
[s
];
410 for (s
= *last
; s
!= -1; s
--)
411 if (FD_ISSET (s
, set
))
421 /* Get last socket and remove it from the socket set SET. LAST is the
422 maximum value of the largest socket. This hint is used to avoid scanning
423 very large socket sets. On return, LAST is set to the actual largest
424 socket in the socket set. */
427 __gnat_get_socket_from_set (fd_set
*set
, int *last
, int *socket
)
430 FD_CLR (*socket
, set
);
431 __gnat_last_socket_in_set (set
, last
);
434 /* Insert SOCKET in the socket set SET. */
437 __gnat_insert_socket_in_set (fd_set
*set
, int socket
)
439 FD_SET (socket
, set
);
442 /* Check whether a given SOCKET is in the socket set SET. */
445 __gnat_is_socket_in_set (fd_set
*set
, int socket
)
447 return FD_ISSET (socket
, set
);
450 /* Remove SOCKET from the socket set SET. */
453 __gnat_remove_socket_from_set (fd_set
*set
, int socket
)
455 FD_CLR (socket
, set
);
460 __gnat_reset_socket_set (fd_set
*set
)
465 /* Get the value of the last host error */
468 __gnat_get_h_errno (void) {
470 int vxw_errno
= errno
;
476 #ifdef S_hostLib_HOST_NOT_FOUND
477 case S_hostLib_HOST_NOT_FOUND
:
479 case S_hostLib_UNKNOWN_HOST
:
480 return HOST_NOT_FOUND
;
482 #ifdef S_hostLib_TRY_AGAIN
483 case S_hostLib_TRY_AGAIN
:
487 #ifdef S_hostLib_NO_RECOVERY
488 case S_hostLib_NO_RECOVERY
:
490 #ifdef S_hostLib_NETDB_INTERNAL
491 case S_hostLib_NETDB_INTERNAL
:
493 case S_hostLib_INVALID_PARAMETER
:
500 #elif defined (__rtems__)
501 /* At this stage in the tool build, no networking .h files are available.
502 * Newlib does not provide networking .h files and RTEMS is not built yet.
503 * So we need to explicitly extern h_errno to access it.
513 /* Wrapper for ioctl(2), which is a variadic function */
516 __gnat_socket_ioctl (int fd
, IOCTL_Req_T req
, int *arg
) {
518 return ioctlsocket (fd
, req
, arg
);
519 #elif defined (__APPLE__)
521 * On Darwin, req is an unsigned long, and we want to convert without sign
522 * extension to get the proper bit pattern in the case of a 64 bit kernel.
524 return ioctl (fd
, (unsigned int) req
, arg
);
526 return ioctl (fd
, req
, arg
);
530 #ifndef HAVE_INET_PTON
533 __gnat_inet_pton (int af
, const char *src
, void *dst
) {
535 #if defined (_WIN32) && defined (AF_INET6)
541 errno
= EAFNOSUPPORT
;
545 #if defined (__vxworks)
546 return (inet_aton (src
, dst
) == OK
);
548 #elif defined (_WIN32)
549 struct sockaddr_storage ss
;
550 int sslen
= sizeof ss
;
554 rc
= WSAStringToAddressA (src
, af
, NULL
, (struct sockaddr
*)&ss
, &sslen
);
558 *(struct in_addr
*)dst
= ((struct sockaddr_in
*)&ss
)->sin_addr
;
562 *(struct in6_addr
*)dst
= ((struct sockaddr_in6
*)&ss
)->sin6_addr
;
569 #elif defined (__hpux__)
573 if (src
== NULL
|| dst
== NULL
) {
576 } else if (!strcmp (src
, "255.255.255.255")) {
581 addr
= inet_addr (src
);
582 rc
= (addr
!= 0xffffffff);
585 *(in_addr_t
*)dst
= addr
;
592 #ifndef HAVE_INET_NTOP
595 __gnat_inet_ntop(int af
, const void *src
, char *dst
, socklen_t size
)
598 struct sockaddr_storage ss
;
599 int sslen
= sizeof ss
;
600 memset(&ss
, 0, sslen
);
605 ((struct sockaddr_in6
*)&ss
)->sin6_addr
= *(struct in6_addr
*)src
;
608 ((struct sockaddr_in
*)&ss
)->sin_addr
= *(struct in_addr
*)src
;
611 errno
= EAFNOSUPPORT
;
617 if (WSAAddressToStringA((struct sockaddr
*)&ss
, sslen
, 0, dst
, &sz
) != 0) {
628 * Accessor functions for struct hostent.
631 char * __gnat_hostent_h_name (struct hostent
* h
) {
635 char * __gnat_hostent_h_alias (struct hostent
* h
, int index
) {
636 return h
->h_aliases
[index
];
639 int __gnat_hostent_h_addrtype (struct hostent
* h
) {
640 return h
->h_addrtype
;
643 int __gnat_hostent_h_length (struct hostent
* h
) {
647 char * __gnat_hostent_h_addr (struct hostent
* h
, int index
) {
648 return h
->h_addr_list
[index
];
652 * Accessor functions for struct servent.
654 * These are needed because servent has different representations on different
655 * platforms, and we don't want to deal with that on the Ada side. For example,
656 * on Linux, we have (see /usr/include netdb.h):
666 * and on Windows (see mingw's socket.h):
682 __gnat_servent_s_name (struct servent
* s
)
688 __gnat_servent_s_alias (struct servent
* s
, int index
)
690 return s
->s_aliases
[index
];
694 __gnat_servent_s_port (struct servent
* s
)
700 __gnat_servent_s_proto (struct servent
* s
)
705 #if defined(AF_INET6) && !defined(__rtems__)
707 #if defined (__vxworks)
708 #define getaddrinfo ipcom_getaddrinfo
709 #define getnameinfo ipcom_getnameinfo
710 #define freeaddrinfo ipcom_freeaddrinfo
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 #endif /* defined(HAVE_SOCKETS) */