hppa: Revise REG+D address support to allow long displacements before reload
[official-gcc.git] / gcc / ada / socket.c
blob1f41ada4686e96f94d979b7e997868e719c2f894
1 /****************************************************************************
2 * *
3 * GNAT COMPILER COMPONENTS *
4 * *
5 * S O C K E T *
6 * *
7 * C Implementation File *
8 * *
9 * Copyright (C) 2003-2023, Free Software Foundation, Inc. *
10 * *
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. *
17 * *
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. *
21 * *
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/>. *
26 * *
27 * GNAT was originally developed by the GNAT team at New York University. *
28 * Extensive contributions were provided by Ada Core Technologies Inc. *
29 * *
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. */
37 #ifndef _REENTRANT
38 #define _REENTRANT
39 #endif
40 #define _THREAD_SAFE
42 #include "gsocket.h"
44 #if defined (__FreeBSD__) || defined (__DragonFly__) \
45 || defined (__NetBSD__) || defined (__OpenBSD__)
46 typedef unsigned int IOCTL_Req_T;
47 #else
48 typedef int IOCTL_Req_T;
49 #endif
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)
58 #include <signal.h>
59 #endif
60 /* Required if we will be calling signal() in __gnat_disable_all_sigpipes() */
62 #include "raise.h"
63 /* Required for __gnat_malloc() */
65 #include <string.h>
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(
96 const char *node,
97 const char *service,
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 *);
109 #endif
111 #ifndef HAVE_INET_NTOP
112 extern const char *
113 __gnat_inet_ntop(int, const void *, char *, socklen_t);
114 #endif
116 /* Disable the sending of SIGPIPE for writes on a broken stream */
118 void
119 __gnat_disable_sigpipe (int fd ATTRIBUTE_UNUSED)
121 #ifdef SO_NOSIGPIPE
122 int val = 1;
123 (void) setsockopt (fd, SOL_SOCKET, SO_NOSIGPIPE, &val, sizeof val);
124 #endif
127 void
128 __gnat_disable_all_sigpipes (void)
130 #if !defined(SO_NOSIGPIPE) && !defined(MSG_NOSIGNAL) && defined(SIGPIPE)
131 (void) signal (SIGPIPE, SIG_IGN);
132 #endif
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).
140 #else
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
144 * write end.
147 __gnat_create_signalling_fds (int *fds) {
148 return pipe (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) {
157 char c;
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) {
167 char c = 0;
168 return write (wsig, &c, 1);
172 * Close one end of a pair of signalling fds
174 void
175 __gnat_close_signalling_fd (int sig) {
176 (void) close (sig);
178 #endif
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
197 * exclusion.
200 #ifdef HAVE_GETxxxBYyyy_R
202 __gnat_gethostbyname (const char *name,
203 struct hostent *ret, char *buf, size_t buflen,
204 int *h_errnop)
206 struct hostent *rh;
207 int ri;
209 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
210 (void) gethostbyname_r (name, ret, buf, buflen, &rh, h_errnop);
211 #else
212 rh = gethostbyname_r (name, ret, buf, buflen, h_errnop);
213 #endif
214 ri = (rh == NULL) ? -1 : 0;
215 return ri;
219 __gnat_gethostbyaddr (const char *addr, int len, int type,
220 struct hostent *ret, char *buf, size_t buflen,
221 int *h_errnop)
223 struct hostent *rh;
224 int ri;
226 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
227 (void) gethostbyaddr_r (addr, len, type, ret, buf, buflen, &rh, h_errnop);
228 #else
229 rh = gethostbyaddr_r (addr, len, type, ret, buf, buflen, h_errnop);
230 #endif
231 ri = (rh == NULL) ? -1 : 0;
232 return ri;
236 __gnat_getservbyname (const char *name, const char *proto,
237 struct servent *ret, char *buf, size_t buflen)
239 struct servent *rh;
240 int ri;
242 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
243 (void) getservbyname_r (name, proto, ret, buf, buflen, &rh);
244 #else
245 rh = getservbyname_r (name, proto, ret, buf, buflen);
246 #endif
247 ri = (rh == NULL) ? -1 : 0;
248 return ri;
252 __gnat_getservbyport (int port, const char *proto,
253 struct servent *ret, char *buf, size_t buflen)
255 struct servent *rh;
256 int ri;
258 #if defined(__linux__) || defined(__GLIBC__) || defined(__rtems__)
259 (void) getservbyport_r (port, proto, ret, buf, buflen, &rh);
260 #else
261 rh = getservbyport_r (port, proto, ret, buf, buflen);
262 #endif
263 ri = (rh == NULL) ? -1 : 0;
264 return ri;
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,
275 int *h_errnop)
277 vxw_h_addr = hostGetByName (name);
278 if (vxw_h_addr == ERROR) {
279 *h_errnop = __gnat_get_h_errno ();
280 return -1;
282 ret->h_name = name;
283 ret->h_aliases = &vxw_h_aliases;
284 ret->h_addrtype = AF_INET;
285 ret->h_length = 4;
286 ret->h_addr_list = &vxw_h_addr_list;
287 return 0;
291 __gnat_gethostbyaddr (const char *addr, int len, int type,
292 struct hostent *ret, char *buf, size_t buflen,
293 int *h_errnop)
295 if (type != AF_INET) {
296 *h_errnop = EAFNOSUPPORT;
297 return -1;
300 if (addr == NULL || len != 4) {
301 *h_errnop = EINVAL;
302 return -1;
305 if (hostGetByAddr (*(int*)addr, &vxw_h_name) != OK) {
306 *h_errnop = __gnat_get_h_errno ();
307 return -1;
310 vxw_h_addr = addr;
312 ret->h_name = &vxw_h_name;
313 ret->h_aliases = &vxw_h_aliases;
314 ret->h_addrtype = AF_INET;
315 ret->h_length = 4;
316 ret->h_addr_list = &vxw_h_addr_list;
317 return 0;
321 __gnat_getservbyname (const char *name, const char *proto,
322 struct servent *ret, char *buf, size_t buflen)
324 /* Not available under VxWorks */
325 return -1;
329 __gnat_getservbyport (int port, const char *proto,
330 struct servent *ret, char *buf, size_t buflen)
332 /* Not available under VxWorks */
333 return -1;
335 #else
337 __gnat_gethostbyname (const char *name, struct hostent *ret,
338 char *buf ATTRIBUTE_UNUSED, size_t buflen ATTRIBUTE_UNUSED,
339 int *h_errnop)
341 struct hostent *rh;
342 rh = gethostbyname (name);
343 if (rh == NULL) {
344 *h_errnop = __gnat_get_h_errno ();
345 return -1;
347 *ret = *rh;
348 *h_errnop = 0;
349 return 0;
353 __gnat_gethostbyaddr (const char *addr, int len, int type, struct hostent *ret,
354 char *buf ATTRIBUTE_UNUSED, size_t buflen ATTRIBUTE_UNUSED,
355 int *h_errnop)
357 struct hostent *rh;
358 rh = gethostbyaddr (addr, len, type);
359 if (rh == NULL) {
360 *h_errnop = __gnat_get_h_errno ();
361 return -1;
363 *ret = *rh;
364 *h_errnop = 0;
365 return 0;
369 __gnat_getservbyname (const char *name, const char *proto, struct servent *ret,
370 char *buf ATTRIBUTE_UNUSED, size_t buflen ATTRIBUTE_UNUSED)
372 struct servent *rh;
373 rh = getservbyname (name, proto);
374 if (rh == NULL)
375 return -1;
376 *ret = *rh;
377 return 0;
381 __gnat_getservbyport (int port, const char *proto, struct servent *ret,
382 char *buf ATTRIBUTE_UNUSED, size_t buflen ATTRIBUTE_UNUSED)
384 struct servent *rh;
385 rh = getservbyport (port, proto);
386 if (rh == NULL)
387 return -1;
388 *ret = *rh;
389 return 0;
391 #endif
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. */
398 void
399 __gnat_last_socket_in_set (fd_set *set, int *last)
401 int l;
402 l = -1;
404 #ifdef _WIN32
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];
410 #else
412 for (int s = *last; s != -1; s--)
413 if (FD_ISSET (s, set))
415 l = s;
416 break;
418 #endif
420 *last = l;
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. */
428 void
429 __gnat_get_socket_from_set (fd_set *set, int *last, int *socket)
431 *socket = *last;
432 FD_CLR (*socket, set);
433 __gnat_last_socket_in_set (set, last);
436 /* Insert SOCKET in the socket set SET. */
438 void
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. */
454 void
455 __gnat_remove_socket_from_set (fd_set *set, int socket)
457 FD_CLR (socket, set);
460 /* Reset SET */
461 void
462 __gnat_reset_socket_set (fd_set *set)
464 FD_ZERO (set);
467 /* Get the value of the last host error */
470 __gnat_get_h_errno (void) {
471 #ifdef __vxworks
472 int vxw_errno = errno;
474 switch (vxw_errno) {
475 case 0:
476 return 0;
478 #ifdef S_hostLib_HOST_NOT_FOUND
479 case S_hostLib_HOST_NOT_FOUND:
480 #endif
481 case S_hostLib_UNKNOWN_HOST:
482 return HOST_NOT_FOUND;
484 #ifdef S_hostLib_TRY_AGAIN
485 case S_hostLib_TRY_AGAIN:
486 return TRY_AGAIN;
487 #endif
489 #ifdef S_hostLib_NO_RECOVERY
490 case S_hostLib_NO_RECOVERY:
491 #endif
492 #ifdef S_hostLib_NETDB_INTERNAL
493 case S_hostLib_NETDB_INTERNAL:
494 #endif
495 case S_hostLib_INVALID_PARAMETER:
496 return NO_RECOVERY;
498 default:
499 return -1;
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.
507 extern int h_errno;
508 return h_errno;
510 #else
511 return h_errno;
512 #endif
515 /* Wrapper for ioctl(2), which is a variadic function */
518 __gnat_socket_ioctl (int fd, IOCTL_Req_T req, int *arg) {
519 #if defined (_WIN32)
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);
527 #else
528 return ioctl (fd, req, arg);
529 #endif
532 #ifndef HAVE_INET_PTON
535 __gnat_inet_pton (int af, const char *src, void *dst) {
536 switch (af) {
537 #if defined (_WIN32) && defined (AF_INET6)
538 case AF_INET6:
539 #endif
540 case AF_INET:
541 break;
542 default:
543 errno = EAFNOSUPPORT;
544 return -1;
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;
553 int rc;
555 ss.ss_family = af;
556 rc = WSAStringToAddressA ((char *)src, af, NULL, (struct sockaddr *)&ss,
557 &sslen);
558 if (rc == 0) {
559 switch (af) {
560 case AF_INET:
561 *(struct in_addr *)dst = ((struct sockaddr_in *)&ss)->sin_addr;
562 break;
563 #ifdef AF_INET6
564 case AF_INET6:
565 *(struct in6_addr *)dst = ((struct sockaddr_in6 *)&ss)->sin6_addr;
566 break;
567 #endif
570 return (rc == 0);
572 #elif defined (__hpux__)
573 in_addr_t addr;
574 int rc = -1;
576 if (src == NULL || dst == NULL) {
577 errno = EINVAL;
579 } else if (!strcmp (src, "255.255.255.255")) {
580 addr = 0xffffffff;
581 rc = 1;
583 } else {
584 addr = inet_addr (src);
585 rc = (addr != 0xffffffff);
587 if (rc == 1) {
588 *(in_addr_t *)dst = addr;
590 return rc;
592 #else
593 return -1;
594 #endif
596 #endif
598 #ifndef HAVE_INET_NTOP
600 const char *
601 __gnat_inet_ntop(int af, const void *src, char *dst, socklen_t size)
603 #ifdef _WIN32
604 struct sockaddr_storage ss;
605 int sslen = sizeof ss;
606 memset(&ss, 0, sslen);
607 ss.ss_family = af;
609 switch (af) {
610 case AF_INET6:
611 ((struct sockaddr_in6 *)&ss)->sin6_addr = *(struct in6_addr *)src;
612 break;
613 case AF_INET:
614 ((struct sockaddr_in *)&ss)->sin_addr = *(struct in_addr *)src;
615 break;
616 default:
617 errno = EAFNOSUPPORT;
618 return NULL;
621 DWORD sz = size;
623 if (WSAAddressToStringA((struct sockaddr*)&ss, sslen, 0, dst, &sz) != 0) {
624 return NULL;
626 return dst;
627 #else
628 return NULL;
629 #endif
631 #endif
634 * Accessor functions for struct hostent.
637 char * __gnat_hostent_h_name (struct hostent * h) {
638 return h->h_name;
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) {
650 return h->h_length;
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):
664 * struct servent
666 * char *s_name;
667 * char **s_aliases;
668 * int s_port;
669 * char *s_proto;
670 * };
672 * and on Windows (see mingw's socket.h):
674 * struct servent {
675 * char *s_name;
676 * char **s_aliases;
677 * #ifdef _WIN64
678 * char *s_proto;
679 * short s_port;
680 * #else
681 * short s_port;
682 * char *s_proto;
683 * #endif
684 * };
687 char *
688 __gnat_servent_s_name (struct servent * s)
690 return s->s_name;
693 char *
694 __gnat_servent_s_alias (struct servent * s, int index)
696 return s->s_aliases[index];
699 unsigned short
700 __gnat_servent_s_port (struct servent * s)
702 return s->s_port;
705 char *
706 __gnat_servent_s_proto (struct servent * s)
708 return s->s_proto;
711 #if defined(AF_INET6) && !defined(__rtems__)
713 int __gnat_getaddrinfo(
714 const char *node,
715 const char *service,
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) {
731 freeaddrinfo(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
737 // versions
739 switch (errcode) {
740 case EAI_AGAIN:
741 return "Temporary failure in name resolution.";
742 case EAI_BADFLAGS:
743 return "Invalid value for ai_flags.";
744 case EAI_FAIL:
745 return "Nonrecoverable failure in name resolution.";
746 case EAI_FAMILY:
747 return "The ai_family member is not supported.";
748 case EAI_MEMORY:
749 return "Memory allocation failure.";
750 #ifdef EAI_NODATA
751 // Could be not defined under the vxWorks
752 case EAI_NODATA:
753 return "No address associated with nodename.";
754 #endif
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 */
758 case EAI_NONAME:
759 return "Neither nodename nor servname provided, or not known.";
760 #endif
761 case EAI_SERVICE:
762 return "The servname parameter is not supported for ai_socktype.";
763 case EAI_SOCKTYPE:
764 return "The ai_socktype member is not supported.";
765 #ifdef EAI_SYSTEM
766 // Could be not defined, at least on Windows
767 case EAI_SYSTEM:
768 return "System error returned in errno";
769 #endif
770 default:
771 return "Unknown error.";
773 #else
774 return gai_strerror(errcode);
775 #endif
778 #else
780 int __gnat_getaddrinfo(
781 const char *node,
782 const char *service,
783 const struct addrinfo *hints,
784 struct addrinfo **res)
786 return -1;
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)
794 return -1;
797 void __gnat_freeaddrinfo(struct addrinfo *res) {
800 const char * __gnat_gai_strerror(int errcode) {
801 return "getaddinfo functions family is not supported";
804 #endif
806 int __gnat_minus_500ms() {
807 #if defined (_WIN32)
808 // Windows Server 2019 and Windows 8.0 do not need 500 millisecond socket
809 // timeout correction.
810 if (IsWindowsServer()) {
811 OSVERSIONINFO osvi;
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).
816 GetVersionEx(&osvi);
817 return osvi.dwMajorVersion < 10
818 || (osvi.dwMajorVersion == 10
819 && osvi.dwMinorVersion == 0
820 && osvi.dwBuildNumber < 17763);
821 } else {
822 return !IsWindows8OrGreater();
824 #else
825 return 0;
826 #endif
829 #endif /* defined(HAVE_SOCKETS) */