1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- G N A T . S O C K E T S . T H I N --
9 -- Copyright (C) 2001-2014, AdaCore --
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 package provides a target dependent thin interface to the sockets
33 -- layer for use by the GNAT.Sockets package (g-socket.ads). This package
34 -- should not be directly with'ed by an applications program.
36 -- This version is for NT
38 with Ada
.Unchecked_Conversion
;
39 with Interfaces
.C
.Strings
; use Interfaces
.C
.Strings
;
40 with System
; use System
;
41 with System
.Storage_Elements
; use System
.Storage_Elements
;
43 package body GNAT
.Sockets
.Thin
is
48 WSAData_Dummy
: array (1 .. 512) of C
.int
;
50 WS_Version
: constant := 16#
0202#
;
53 Initialized
: Boolean := False;
55 function Standard_Connect
57 Name
: System
.Address
;
58 Namelen
: C
.int
) return C
.int
;
59 pragma Import
(Stdcall
, Standard_Connect
, "connect");
61 function Standard_Select
63 Readfds
: access Fd_Set
;
64 Writefds
: access Fd_Set
;
65 Exceptfds
: access Fd_Set
;
66 Timeout
: Timeval_Access
) return C
.int
;
67 pragma Import
(Stdcall
, Standard_Select
, "select");
108 N_WSAVERNOTSUPPORTED
,
117 Error_Messages
: constant array (Error_Type
) of chars_ptr
:=
119 New_String
("Interrupted system call"),
121 New_String
("Bad file number"),
123 New_String
("Permission denied"),
125 New_String
("Bad address"),
127 New_String
("Invalid argument"),
129 New_String
("Too many open files"),
131 New_String
("Operation would block"),
133 New_String
("Operation now in progress. This error is "
134 & "returned if any Windows Sockets API "
135 & "function is called while a blocking "
136 & "function is in progress"),
138 New_String
("Operation already in progress"),
140 New_String
("Socket operation on nonsocket"),
142 New_String
("Destination address required"),
144 New_String
("Message too long"),
146 New_String
("Protocol wrong type for socket"),
148 New_String
("Protocol not available"),
150 New_String
("Protocol not supported"),
152 New_String
("Socket type not supported"),
154 New_String
("Operation not supported on socket"),
156 New_String
("Protocol family not supported"),
158 New_String
("Address family not supported by protocol family"),
160 New_String
("Address already in use"),
162 New_String
("Cannot assign requested address"),
164 New_String
("Network is down. This error may be "
165 & "reported at any time if the Windows "
166 & "Sockets implementation detects an "
167 & "underlying failure"),
169 New_String
("Network is unreachable"),
171 New_String
("Network dropped connection on reset"),
173 New_String
("Software caused connection abort"),
175 New_String
("Connection reset by peer"),
177 New_String
("No buffer space available"),
179 New_String
("Socket is already connected"),
181 New_String
("Socket is not connected"),
183 New_String
("Cannot send after socket shutdown"),
185 New_String
("Too many references: cannot splice"),
187 New_String
("Connection timed out"),
189 New_String
("Connection refused"),
191 New_String
("Too many levels of symbolic links"),
193 New_String
("File name too long"),
195 New_String
("Host is down"),
197 New_String
("No route to host"),
199 New_String
("Returned by WSAStartup(), indicating that "
200 & "the network subsystem is unusable"),
201 N_WSAVERNOTSUPPORTED
=>
202 New_String
("Returned by WSAStartup(), indicating that "
203 & "the Windows Sockets DLL cannot support "
204 & "this application"),
205 N_WSANOTINITIALISED
=>
206 New_String
("Winsock not initialized. This message is "
207 & "returned by any function except WSAStartup(), "
208 & "indicating that a successful WSAStartup() has "
209 & "not yet been performed"),
211 New_String
("Disconnected"),
213 New_String
("Host not found. This message indicates "
214 & "that the key (name, address, and so on) was not found"),
216 New_String
("Nonauthoritative host not found. This error may "
217 & "suggest that the name service itself is not "
220 New_String
("Nonrecoverable error. This error may suggest that the "
221 & "name service itself is not functioning"),
223 New_String
("Valid name, no data record of requested type. "
224 & "This error indicates that the key (name, address, "
225 & "and so on) was not found."),
227 New_String
("Unknown system error"));
235 Name
: System
.Address
;
236 Namelen
: C
.int
) return C
.int
241 Res
:= Standard_Connect
(S
, Name
, Namelen
);
244 if Socket_Errno
= SOSC
.EWOULDBLOCK
then
245 Set_Socket_Errno
(SOSC
.EINPROGRESS
);
256 function Socket_Ioctl
258 Req
: SOSC
.IOCTL_Req_T
;
259 Arg
: access C
.int
) return C
.int
262 return C_Ioctl
(S
, Req
, Arg
);
271 Msg
: System
.Address
;
272 Flags
: C
.int
) return System
.CRTL
.ssize_t
276 Fill
: constant Boolean :=
277 SOSC
.MSG_WAITALL
/= -1
278 and then (C
.unsigned
(Flags
) and SOSC
.MSG_WAITALL
) /= 0;
279 -- Is the MSG_WAITALL flag set? If so we need to fully fill all vectors
285 for MH
'Address use Msg
;
287 Iovec
: array (0 .. MH
.Msg_Iovlen
- 1) of Vector_Element
;
288 for Iovec
'Address use MH
.Msg_Iov
;
289 pragma Import
(Ada
, Iovec
);
292 Current_Iovec
: Vector_Element
;
294 function To_Access
is new Ada
.Unchecked_Conversion
295 (System
.Address
, Stream_Element_Reference
);
296 pragma Warnings
(Off
, Stream_Element_Reference
);
298 Req
: Request_Type
(Name
=> N_Bytes_To_Read
);
301 -- Windows does not provide an implementation of recvmsg(). The spec for
302 -- WSARecvMsg() is incompatible with the data types we define, and is
303 -- available starting with Windows Vista and Server 2008 only. So,
304 -- we use C_Recv instead.
306 -- Check how much data are available
308 Control_Socket
(Socket_Type
(S
), Req
);
313 Current_Iovec
:= (Base
=> null, Length
=> 0);
316 if Current_Iovec
.Length
= 0 then
317 Iov_Index
:= Iov_Index
+ 1;
318 exit when Iov_Index
> Integer (Iovec
'Last);
319 Current_Iovec
:= Iovec
(SOSC
.Msg_Iovlen_T
(Iov_Index
));
325 Current_Iovec
.Base
.all'Address,
326 C
.int
(Current_Iovec
.Length
),
330 return System
.CRTL
.ssize_t
(Res
);
332 elsif Res
= 0 and then not Fill
then
336 pragma Assert
(Interfaces
.C
.size_t
(Res
) <= Current_Iovec
.Length
);
338 Count
:= Count
+ Res
;
339 Current_Iovec
.Length
:=
340 Current_Iovec
.Length
- Interfaces
.C
.size_t
(Res
);
341 Current_Iovec
.Base
:=
342 To_Access
(Current_Iovec
.Base
.all'Address
343 + Storage_Offset
(Res
));
345 -- If all the data that was initially available read, do not
346 -- attempt to receive more, since this might block, or merge data
347 -- from successive datagrams for a datagram-oriented socket. We
348 -- still try to receive more if we need to fill all vectors
349 -- (MSG_WAITALL flag is set).
351 exit when Natural (Count
) >= Req
.Size
354 -- Either we are not in fill mode
358 -- Or else last vector filled
360 or else (Interfaces
.C
.size_t
(Iov_Index
) = Iovec
'Last
361 and then Current_Iovec
.Length
= 0));
365 return System
.CRTL
.ssize_t
(Count
);
374 Readfds
: access Fd_Set
;
375 Writefds
: access Fd_Set
;
376 Exceptfds
: access Fd_Set
;
377 Timeout
: Timeval_Access
) return C
.int
379 pragma Warnings
(Off
, Exceptfds
);
381 Original_WFS
: aliased constant Fd_Set
:= Writefds
.all;
385 Last
: aliased C
.int
;
388 -- Asynchronous connection failures are notified in the exception fd
389 -- set instead of the write fd set. To ensure POSIX compatibility, copy
390 -- write fd set into exception fd set. Once select() returns, check any
391 -- socket present in the exception fd set and peek at incoming
392 -- out-of-band data. If the test is not successful, and the socket is
393 -- present in the initial write fd set, then move the socket from the
394 -- exception fd set to the write fd set.
396 if Writefds
/= No_Fd_Set_Access
then
398 -- Add any socket present in write fd set into exception fd set
401 WFS
: aliased Fd_Set
:= Writefds
.all;
406 (WFS
'Access, S
'Unchecked_Access, Last
'Unchecked_Access);
408 Insert_Socket_In_Set
(Exceptfds
, S
);
413 Res
:= Standard_Select
(Nfds
, Readfds
, Writefds
, Exceptfds
, Timeout
);
415 if Exceptfds
/= No_Fd_Set_Access
then
417 EFSC
: aliased Fd_Set
:= Exceptfds
.all;
418 Flag
: constant C
.int
:= SOSC
.MSG_PEEK
+ SOSC
.MSG_OOB
;
421 Fromlen
: aliased C
.int
;
427 (EFSC
'Access, S
'Unchecked_Access, Last
'Unchecked_Access);
429 -- No more sockets in EFSC
433 -- Check out-of-band data
437 (S
, Buffer
'Address, 1, Flag
,
438 From
=> System
.Null_Address
,
439 Fromlen
=> Fromlen
'Unchecked_Access);
440 -- Is Fromlen necessary if From is Null_Address???
442 -- If the signal is not an out-of-band data, then it
443 -- is a connection failure notification.
446 Remove_Socket_From_Set
(Exceptfds
, S
);
448 -- If S is present in the initial write fd set, move it from
449 -- exception fd set back to write fd set. Otherwise, ignore
450 -- this event since the user is not watching for it.
452 if Writefds
/= No_Fd_Set_Access
453 and then (Is_Socket_In_Set
(Original_WFS
'Access, S
) /= 0)
455 Insert_Socket_In_Set
(Writefds
, S
);
470 Msg
: System
.Address
;
471 Flags
: C
.int
) return System
.CRTL
.ssize_t
479 for MH
'Address use Msg
;
481 Iovec
: array (0 .. MH
.Msg_Iovlen
- 1) of Vector_Element
;
482 for Iovec
'Address use MH
.Msg_Iov
;
483 pragma Import
(Ada
, Iovec
);
486 -- Windows does not provide an implementation of sendmsg(). The spec for
487 -- WSASendMsg() is incompatible with the data types we define, and is
488 -- available starting with Windows Vista and Server 2008 only. So
489 -- use C_Sendto instead.
491 for J
in Iovec
'Range loop
495 Iovec
(J
).Base
.all'Address,
496 C
.int
(Iovec
(J
).Length
),
499 Tolen
=> C
.int
(MH
.Msg_Namelen
));
502 return System
.CRTL
.ssize_t
(Res
);
504 Count
:= Count
+ Res
;
507 -- Exit now if the buffer is not fully transmitted
509 exit when Interfaces
.C
.size_t
(Res
) < Iovec
(J
).Length
;
512 return System
.CRTL
.ssize_t
(Count
);
519 procedure Finalize
is
523 Initialized
:= False;
527 -------------------------
528 -- Host_Error_Messages --
529 -------------------------
531 package body Host_Error_Messages
is
533 -- On Windows, socket and host errors share the same code space, and
534 -- error messages are provided by Socket_Error_Message, so the default
535 -- separate body for Host_Error_Messages is not used in this case.
537 function Host_Error_Message
(H_Errno
: Integer) return String
538 renames Socket_Error_Message
;
540 end Host_Error_Messages
;
546 procedure Initialize
is
547 Return_Value
: Interfaces
.C
.int
;
549 if not Initialized
then
550 Return_Value
:= WSAStartup
(WS_Version
, WSAData_Dummy
'Address);
551 pragma Assert
(Return_Value
= 0);
560 package body Signalling_Fds
is separate;
562 --------------------------
563 -- Socket_Error_Message --
564 --------------------------
566 function Socket_Error_Message
(Errno
: Integer) return String is
567 use GNAT
.Sockets
.SOSC
;
569 Errm
: C
.Strings
.chars_ptr
;
573 when EINTR
=> Errm
:= Error_Messages
(N_EINTR
);
574 when EBADF
=> Errm
:= Error_Messages
(N_EBADF
);
575 when EACCES
=> Errm
:= Error_Messages
(N_EACCES
);
576 when EFAULT
=> Errm
:= Error_Messages
(N_EFAULT
);
577 when EINVAL
=> Errm
:= Error_Messages
(N_EINVAL
);
578 when EMFILE
=> Errm
:= Error_Messages
(N_EMFILE
);
579 when EWOULDBLOCK
=> Errm
:= Error_Messages
(N_EWOULDBLOCK
);
580 when EINPROGRESS
=> Errm
:= Error_Messages
(N_EINPROGRESS
);
581 when EALREADY
=> Errm
:= Error_Messages
(N_EALREADY
);
582 when ENOTSOCK
=> Errm
:= Error_Messages
(N_ENOTSOCK
);
583 when EDESTADDRREQ
=> Errm
:= Error_Messages
(N_EDESTADDRREQ
);
584 when EMSGSIZE
=> Errm
:= Error_Messages
(N_EMSGSIZE
);
585 when EPROTOTYPE
=> Errm
:= Error_Messages
(N_EPROTOTYPE
);
586 when ENOPROTOOPT
=> Errm
:= Error_Messages
(N_ENOPROTOOPT
);
587 when EPROTONOSUPPORT
=> Errm
:= Error_Messages
(N_EPROTONOSUPPORT
);
588 when ESOCKTNOSUPPORT
=> Errm
:= Error_Messages
(N_ESOCKTNOSUPPORT
);
589 when EOPNOTSUPP
=> Errm
:= Error_Messages
(N_EOPNOTSUPP
);
590 when EPFNOSUPPORT
=> Errm
:= Error_Messages
(N_EPFNOSUPPORT
);
591 when EAFNOSUPPORT
=> Errm
:= Error_Messages
(N_EAFNOSUPPORT
);
592 when EADDRINUSE
=> Errm
:= Error_Messages
(N_EADDRINUSE
);
593 when EADDRNOTAVAIL
=> Errm
:= Error_Messages
(N_EADDRNOTAVAIL
);
594 when ENETDOWN
=> Errm
:= Error_Messages
(N_ENETDOWN
);
595 when ENETUNREACH
=> Errm
:= Error_Messages
(N_ENETUNREACH
);
596 when ENETRESET
=> Errm
:= Error_Messages
(N_ENETRESET
);
597 when ECONNABORTED
=> Errm
:= Error_Messages
(N_ECONNABORTED
);
598 when ECONNRESET
=> Errm
:= Error_Messages
(N_ECONNRESET
);
599 when ENOBUFS
=> Errm
:= Error_Messages
(N_ENOBUFS
);
600 when EISCONN
=> Errm
:= Error_Messages
(N_EISCONN
);
601 when ENOTCONN
=> Errm
:= Error_Messages
(N_ENOTCONN
);
602 when ESHUTDOWN
=> Errm
:= Error_Messages
(N_ESHUTDOWN
);
603 when ETOOMANYREFS
=> Errm
:= Error_Messages
(N_ETOOMANYREFS
);
604 when ETIMEDOUT
=> Errm
:= Error_Messages
(N_ETIMEDOUT
);
605 when ECONNREFUSED
=> Errm
:= Error_Messages
(N_ECONNREFUSED
);
606 when ELOOP
=> Errm
:= Error_Messages
(N_ELOOP
);
607 when ENAMETOOLONG
=> Errm
:= Error_Messages
(N_ENAMETOOLONG
);
608 when EHOSTDOWN
=> Errm
:= Error_Messages
(N_EHOSTDOWN
);
609 when EHOSTUNREACH
=> Errm
:= Error_Messages
(N_EHOSTUNREACH
);
611 -- Windows-specific error codes
613 when WSASYSNOTREADY
=> Errm
:= Error_Messages
(N_WSASYSNOTREADY
);
614 when WSAVERNOTSUPPORTED
=>
615 Errm
:= Error_Messages
(N_WSAVERNOTSUPPORTED
);
616 when WSANOTINITIALISED
=>
617 Errm
:= Error_Messages
(N_WSANOTINITIALISED
);
619 Errm
:= Error_Messages
(N_WSAEDISCON
);
623 when HOST_NOT_FOUND
=> Errm
:= Error_Messages
(N_HOST_NOT_FOUND
);
624 when TRY_AGAIN
=> Errm
:= Error_Messages
(N_TRY_AGAIN
);
625 when NO_RECOVERY
=> Errm
:= Error_Messages
(N_NO_RECOVERY
);
626 when NO_DATA
=> Errm
:= Error_Messages
(N_NO_DATA
);
628 when others => Errm
:= Error_Messages
(N_OTHERS
);
632 end Socket_Error_Message
;
634 end GNAT
.Sockets
.Thin
;