xref: /openssl/include/internal/sockets.h (revision 38e8392b)
1 /*
2  * Copyright 1995-2024 The OpenSSL Project Authors. All Rights Reserved.
3  *
4  * Licensed under the Apache License 2.0 (the "License").  You may not use
5  * this file except in compliance with the License.  You can obtain a copy
6  * in the file LICENSE in the source distribution or at
7  * https://www.openssl.org/source/license.html
8  */
9 
10 #ifndef OSSL_INTERNAL_SOCKETS_H
11 # define OSSL_INTERNAL_SOCKETS_H
12 # pragma once
13 
14 # include <openssl/opensslconf.h>
15 
16 # if defined(OPENSSL_SYS_VXWORKS) || defined(OPENSSL_SYS_UEFI)
17 #  define NO_SYS_PARAM_H
18 # endif
19 # ifdef WIN32
20 #  define NO_SYS_UN_H
21 # endif
22 # ifdef OPENSSL_SYS_VMS
23 #  define NO_SYS_PARAM_H
24 #  define NO_SYS_UN_H
25 # endif
26 
27 # ifdef OPENSSL_NO_SOCK
28 
29 # elif defined(OPENSSL_SYS_WINDOWS) || defined(OPENSSL_SYS_MSDOS)
30 #  if defined(__DJGPP__)
31 #   define WATT32
32 #   define WATT32_NO_OLDIES
33 #   include <sys/socket.h>
34 #   include <sys/un.h>
35 #   include <tcp.h>
36 #   include <netdb.h>
37 #   include <arpa/inet.h>
38 #   include <netinet/tcp.h>
39 #  elif defined(_WIN32_WCE) && _WIN32_WCE<410
40 #   define getservbyname _masked_declaration_getservbyname
41 #  endif
42 #  if !defined(IPPROTO_IP)
43     /* winsock[2].h was included already? */
44 #   include "internal/e_winsock.h"
45 #  endif
46 #  ifdef getservbyname
47      /* this is used to be wcecompat/include/winsock_extras.h */
48 #   undef getservbyname
49 struct servent *PASCAL getservbyname(const char *, const char *);
50 #  endif
51 
52 #  ifdef _WIN64
53 /*
54  * Even though sizeof(SOCKET) is 8, it's safe to cast it to int, because
55  * the value constitutes an index in per-process table of limited size
56  * and not a real pointer. And we also depend on fact that all processors
57  * Windows run on happen to be two's-complement, which allows to
58  * interchange INVALID_SOCKET and -1.
59  */
60 #   define socket(d,t,p)   ((int)socket(d,t,p))
61 #   define accept(s,f,l)   ((int)accept(s,f,l))
62 #  endif
63 
64 /* Windows have other names for shutdown() reasons */
65 #  ifndef SHUT_RD
66 #   define SHUT_RD SD_RECEIVE
67 #  endif
68 #  ifndef SHUT_WR
69 #   define SHUT_WR SD_SEND
70 #  endif
71 #  ifndef SHUT_RDWR
72 #   define SHUT_RDWR SD_BOTH
73 #  endif
74 
75 # else
76 #  if defined(__APPLE__)
77     /*
78      * This must be defined before including <netinet/in6.h> to get
79      * IPV6_RECVPKTINFO
80      */
81 #   define __APPLE_USE_RFC_3542
82 #  endif
83 
84 #  ifndef NO_SYS_PARAM_H
85 #   include <sys/param.h>
86 #  endif
87 #  ifdef OPENSSL_SYS_VXWORKS
88 #   include <time.h>
89 #  endif
90 
91 #  include <netdb.h>
92 #  if defined(OPENSSL_SYS_VMS)
93 typedef size_t socklen_t;        /* Currently appears to be missing on VMS */
94 #  endif
95 #  if defined(OPENSSL_SYS_VMS_NODECC)
96 #   include <socket.h>
97 #   include <in.h>
98 #   include <inet.h>
99 #  else
100 #   include <poll.h>
101 #   include <sys/socket.h>
102 #   if !defined(NO_SYS_UN_H) && defined(AF_UNIX) && !defined(OPENSSL_NO_UNIX_SOCK)
103 #    include <sys/un.h>
104 #    ifndef UNIX_PATH_MAX
105 #     define UNIX_PATH_MAX sizeof(((struct sockaddr_un *)NULL)->sun_path)
106 #    endif
107 #   endif
108 #   ifdef FILIO_H
109 #    include <sys/filio.h> /* FIONBIO in some SVR4, e.g. unixware, solaris */
110 #   endif
111 #   include <netinet/in.h>
112 #   include <arpa/inet.h>
113 #   include <netinet/tcp.h>
114 #  endif
115 
116 #  ifdef OPENSSL_SYS_AIX
117 #   include <sys/select.h>
118 #  endif
119 
120 #  ifdef OPENSSL_SYS_UNIX
121 #    ifndef OPENSSL_SYS_TANDEM
122 #     include <poll.h>
123 #    endif
124 #    include <errno.h>
125 #  endif
126 
127 #  ifndef VMS
128 #   include <sys/ioctl.h>
129 #  else
130 #   if !defined(TCPIP_TYPE_SOCKETSHR) && defined(__VMS_VER) && (__VMS_VER > 70000000)
131      /* ioctl is only in VMS > 7.0 and when socketshr is not used */
132 #    include <sys/ioctl.h>
133 #   endif
134 #   include <unixio.h>
135 #   if defined(TCPIP_TYPE_SOCKETSHR)
136 #    include <socketshr.h>
137 #   endif
138 #  endif
139 
140 #  ifndef INVALID_SOCKET
141 #   define INVALID_SOCKET      (-1)
142 #  endif
143 # endif
144 
145 /*
146  * Some IPv6 implementations are broken, you can disable them in known
147  * bad versions.
148  */
149 # if !defined(OPENSSL_USE_IPV6)
150 #  if defined(AF_INET6)
151 #   define OPENSSL_USE_IPV6 1
152 #  else
153 #   define OPENSSL_USE_IPV6 0
154 #  endif
155 # endif
156 
157 /*
158  * Some platforms define AF_UNIX, but don't support it
159  */
160 # if !defined(OPENSSL_NO_UNIX_SOCK)
161 #  if !defined(AF_UNIX) || defined(NO_SYS_UN_H)
162 #   define OPENSSL_NO_UNIX_SOCK
163 #  endif
164 # endif
165 
166 # define get_last_socket_error() errno
167 # define clear_socket_error()    errno=0
168 # define get_last_socket_error_is_eintr() (get_last_socket_error() == EINTR)
169 
170 # if defined(OPENSSL_SYS_WINDOWS)
171 #  undef get_last_socket_error
172 #  undef clear_socket_error
173 #  undef get_last_socket_error_is_eintr
174 #  define get_last_socket_error() WSAGetLastError()
175 #  define clear_socket_error()    WSASetLastError(0)
176 #  define get_last_socket_error_is_eintr() (get_last_socket_error() == WSAEINTR)
177 #  define readsocket(s,b,n)       recv((s),(b),(n),0)
178 #  define writesocket(s,b,n)      send((s),(b),(n),0)
179 # elif defined(__DJGPP__)
180 #  define closesocket(s)          close_s(s)
181 #  define readsocket(s,b,n)       read_s(s,b,n)
182 #  define writesocket(s,b,n)      send(s,b,n,0)
183 # elif defined(OPENSSL_SYS_VMS)
184 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
185 #  define closesocket(s)          close(s)
186 #  define readsocket(s,b,n)       recv((s),(b),(n),0)
187 #  define writesocket(s,b,n)      send((s),(b),(n),0)
188 # elif defined(OPENSSL_SYS_VXWORKS)
189 #  define ioctlsocket(a,b,c)          ioctl((a),(b),(int)(c))
190 #  define closesocket(s)              close(s)
191 #  define readsocket(s,b,n)           read((s),(b),(n))
192 #  define writesocket(s,b,n)          write((s),(char *)(b),(n))
193 # elif defined(OPENSSL_SYS_TANDEM)
194 #  define readsocket(s,b,n)       read((s),(b),(n))
195 #  define writesocket(s,b,n)      write((s),(b),(n))
196 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
197 #  define closesocket(s)          close(s)
198 # else
199 #  define ioctlsocket(a,b,c)      ioctl(a,b,c)
200 #  define closesocket(s)          close(s)
201 #  define readsocket(s,b,n)       read((s),(b),(n))
202 #  define writesocket(s,b,n)      write((s),(b),(n))
203 # endif
204 
205 /* also in apps/include/apps.h */
206 # if defined(OPENSSL_SYS_WIN32) || defined(OPENSSL_SYS_WINCE)
207 #  define openssl_fdset(a, b) FD_SET((unsigned int)(a), b)
208 # else
209 #  define openssl_fdset(a, b) FD_SET(a, b)
210 # endif
211 
212 #endif
213