1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- G N A T . S O C K E T S --
9 -- Copyright (C) 2001-2003 Ada Core Technologies, 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 2, 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. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, --
20 -- MA 02111-1307, USA. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 with Ada.Streams; use Ada.Streams;
35 with Ada.Exceptions; use Ada.Exceptions;
36 with Ada.Unchecked_Conversion;
37 with Ada.Unchecked_Deallocation;
39 with Interfaces.C.Strings;
41 with GNAT.OS_Lib; use GNAT.OS_Lib;
42 with GNAT.Sockets.Constants;
43 with GNAT.Sockets.Thin; use GNAT.Sockets.Thin;
46 with GNAT.Sockets.Linker_Options;
47 pragma Warnings (Off, GNAT.Sockets.Linker_Options);
48 -- Need to include pragma Linker_Options which is platform dependent.
50 with System; use System;
52 package body GNAT.Sockets is
54 use type C.int, System.Address;
56 Finalized : Boolean := False;
57 Initialized : Boolean := False;
59 ENOERROR : constant := 0;
61 -- Correspondance tables
63 Families : constant array (Family_Type) of C.int :=
64 (Family_Inet => Constants.AF_INET,
65 Family_Inet6 => Constants.AF_INET6);
67 Levels : constant array (Level_Type) of C.int :=
68 (Socket_Level => Constants.SOL_SOCKET,
69 IP_Protocol_For_IP_Level => Constants.IPPROTO_IP,
70 IP_Protocol_For_UDP_Level => Constants.IPPROTO_UDP,
71 IP_Protocol_For_TCP_Level => Constants.IPPROTO_TCP);
73 Modes : constant array (Mode_Type) of C.int :=
74 (Socket_Stream => Constants.SOCK_STREAM,
75 Socket_Datagram => Constants.SOCK_DGRAM);
77 Shutmodes : constant array (Shutmode_Type) of C.int :=
78 (Shut_Read => Constants.SHUT_RD,
79 Shut_Write => Constants.SHUT_WR,
80 Shut_Read_Write => Constants.SHUT_RDWR);
82 Requests : constant array (Request_Name) of C.int :=
83 (Non_Blocking_IO => Constants.FIONBIO,
84 N_Bytes_To_Read => Constants.FIONREAD);
86 Options : constant array (Option_Name) of C.int :=
87 (Keep_Alive => Constants.SO_KEEPALIVE,
88 Reuse_Address => Constants.SO_REUSEADDR,
89 Broadcast => Constants.SO_BROADCAST,
90 Send_Buffer => Constants.SO_SNDBUF,
91 Receive_Buffer => Constants.SO_RCVBUF,
92 Linger => Constants.SO_LINGER,
93 Error => Constants.SO_ERROR,
94 No_Delay => Constants.TCP_NODELAY,
95 Add_Membership => Constants.IP_ADD_MEMBERSHIP,
96 Drop_Membership => Constants.IP_DROP_MEMBERSHIP,
97 Multicast_TTL => Constants.IP_MULTICAST_TTL,
98 Multicast_Loop => Constants.IP_MULTICAST_LOOP);
100 Flags : constant array (0 .. 3) of C.int :=
101 (0 => Constants.MSG_OOB, -- Process_Out_Of_Band_Data
102 1 => Constants.MSG_PEEK, -- Peek_At_Incoming_Data
103 2 => Constants.MSG_WAITALL, -- Wait_For_A_Full_Reception
104 3 => Constants.MSG_EOR); -- Send_End_Of_Record
106 Socket_Error_Id : constant Exception_Id := Socket_Error'Identity;
107 Host_Error_Id : constant Exception_Id := Host_Error'Identity;
109 Hex_To_Char : constant String (1 .. 16) := "0123456789ABCDEF";
110 -- Use to print in hexadecimal format
112 function To_In_Addr is new Ada.Unchecked_Conversion (C.int, In_Addr);
113 function To_Int is new Ada.Unchecked_Conversion (In_Addr, C.int);
115 -----------------------
116 -- Local subprograms --
117 -----------------------
119 function Resolve_Error
120 (Error_Value : Integer;
121 From_Errno : Boolean := True)
123 -- Associate an enumeration value (error_type) to en error value
124 -- (errno). From_Errno prevents from mixing h_errno with errno.
126 function To_Name (N : String) return Name_Type;
127 function To_String (HN : Name_Type) return String;
128 -- Conversion functions
130 function To_Int (F : Request_Flag_Type) return C.int;
132 function Short_To_Network
133 (S : C.unsigned_short)
134 return C.unsigned_short;
135 pragma Inline (Short_To_Network);
136 -- Convert a port number into a network port number
138 function Network_To_Short
139 (S : C.unsigned_short)
140 return C.unsigned_short
141 renames Short_To_Network;
142 -- Symetric operation
145 (Val : Inet_Addr_VN_Type;
146 Hex : Boolean := False)
148 -- Output an array of inet address components either in
149 -- hexadecimal or in decimal mode.
151 function Is_IP_Address (Name : String) return Boolean;
152 -- Return true when Name is an IP address in standard dot notation.
154 function To_In_Addr (Addr : Inet_Addr_Type) return Thin.In_Addr;
155 function To_Inet_Addr (Addr : In_Addr) return Inet_Addr_Type;
156 -- Conversion functions
158 function To_Host_Entry (E : Hostent) return Host_Entry_Type;
159 -- Conversion function
161 function To_Service_Entry (E : Servent) return Service_Entry_Type;
162 -- Conversion function
164 function To_Timeval (Val : Selector_Duration) return Timeval;
165 -- Separate Val in seconds and microseconds
167 procedure Raise_Socket_Error (Error : Integer);
168 -- Raise Socket_Error with an exception message describing
171 procedure Raise_Host_Error (Error : Integer);
172 -- Raise Host_Error exception with message describing error code
173 -- (note hstrerror seems to be obsolete).
175 procedure Narrow (Item : in out Socket_Set_Type);
176 -- Update Last as it may be greater than the real last socket.
178 -- Types needed for Datagram_Socket_Stream_Type
180 type Datagram_Socket_Stream_Type is new Root_Stream_Type with record
181 Socket : Socket_Type;
183 From : Sock_Addr_Type;
186 type Datagram_Socket_Stream_Access is
187 access all Datagram_Socket_Stream_Type;
190 (Stream : in out Datagram_Socket_Stream_Type;
191 Item : out Ada.Streams.Stream_Element_Array;
192 Last : out Ada.Streams.Stream_Element_Offset);
195 (Stream : in out Datagram_Socket_Stream_Type;
196 Item : Ada.Streams.Stream_Element_Array);
198 -- Types needed for Stream_Socket_Stream_Type
200 type Stream_Socket_Stream_Type is new Root_Stream_Type with record
201 Socket : Socket_Type;
204 type Stream_Socket_Stream_Access is
205 access all Stream_Socket_Stream_Type;
208 (Stream : in out Stream_Socket_Stream_Type;
209 Item : out Ada.Streams.Stream_Element_Array;
210 Last : out Ada.Streams.Stream_Element_Offset);
213 (Stream : in out Stream_Socket_Stream_Type;
214 Item : Ada.Streams.Stream_Element_Array);
220 function "+" (L, R : Request_Flag_Type) return Request_Flag_Type is
229 procedure Abort_Selector (Selector : Selector_Type) is
232 pragma Warnings (Off, Discard);
235 -- Send an empty array to unblock C select system call
237 Discard := C_Write (C.int (Selector.W_Sig_Socket), Buf'Address, 1);
244 procedure Accept_Socket
245 (Server : Socket_Type;
246 Socket : out Socket_Type;
247 Address : out Sock_Addr_Type)
250 Sin : aliased Sockaddr_In;
251 Len : aliased C.int := Sin'Size / 8;
254 Res := C_Accept (C.int (Server), Sin'Address, Len'Access);
256 if Res = Failure then
257 Raise_Socket_Error (Socket_Errno);
260 Socket := Socket_Type (Res);
262 Address.Addr := To_Inet_Addr (Sin.Sin_Addr);
263 Address.Port := Port_Type (Network_To_Short (Sin.Sin_Port));
271 (E : Host_Entry_Type;
273 return Inet_Addr_Type
276 return E.Addresses (N);
279 ----------------------
280 -- Addresses_Length --
281 ----------------------
283 function Addresses_Length (E : Host_Entry_Type) return Natural is
285 return E.Addresses_Length;
286 end Addresses_Length;
293 (E : Host_Entry_Type;
298 return To_String (E.Aliases (N));
306 (S : Service_Entry_Type;
311 return To_String (S.Aliases (N));
318 function Aliases_Length (E : Host_Entry_Type) return Natural is
320 return E.Aliases_Length;
327 function Aliases_Length (S : Service_Entry_Type) return Natural is
329 return S.Aliases_Length;
336 procedure Bind_Socket
337 (Socket : Socket_Type;
338 Address : Sock_Addr_Type)
341 Sin : aliased Sockaddr_In;
342 Len : constant C.int := Sin'Size / 8;
345 if Address.Family = Family_Inet6 then
349 Set_Length (Sin'Unchecked_Access, Len);
350 Set_Family (Sin'Unchecked_Access, Families (Address.Family));
352 (Sin'Unchecked_Access,
353 Short_To_Network (C.unsigned_short (Address.Port)));
355 Res := C_Bind (C.int (Socket), Sin'Address, Len);
357 if Res = Failure then
358 Raise_Socket_Error (Socket_Errno);
366 procedure Check_Selector
367 (Selector : in out Selector_Type;
368 R_Socket_Set : in out Socket_Set_Type;
369 W_Socket_Set : in out Socket_Set_Type;
370 Status : out Selector_Status;
371 Timeout : Selector_Duration := Forever)
373 E_Socket_Set : Socket_Set_Type; -- (No_Socket, No_Socket_Set)
376 (Selector, R_Socket_Set, W_Socket_Set, E_Socket_Set, Status, Timeout);
379 procedure Check_Selector
380 (Selector : in out Selector_Type;
381 R_Socket_Set : in out Socket_Set_Type;
382 W_Socket_Set : in out Socket_Set_Type;
383 E_Socket_Set : in out Socket_Set_Type;
384 Status : out Selector_Status;
385 Timeout : Selector_Duration := Forever)
389 RSet : Socket_Set_Type;
390 WSet : Socket_Set_Type;
391 ESet : Socket_Set_Type;
392 TVal : aliased Timeval;
393 TPtr : Timeval_Access;
398 -- No timeout or Forever is indicated by a null timeval pointer
400 if Timeout = Forever then
403 TVal := To_Timeval (Timeout);
404 TPtr := TVal'Unchecked_Access;
407 -- Copy R_Socket_Set in RSet and add read signalling socket
409 RSet := (Set => New_Socket_Set (R_Socket_Set.Set),
410 Last => R_Socket_Set.Last);
411 Set (RSet, Selector.R_Sig_Socket);
413 -- Copy W_Socket_Set in WSet
415 WSet := (Set => New_Socket_Set (W_Socket_Set.Set),
416 Last => W_Socket_Set.Last);
418 -- Copy E_Socket_Set in ESet
420 ESet := (Set => New_Socket_Set (E_Socket_Set.Set),
421 Last => E_Socket_Set.Last);
423 Last := C.int'Max (C.int'Max (C.int (RSet.Last),
435 -- If Select was resumed because of read signalling socket,
436 -- read this data and remove socket from set.
438 if Is_Set (RSet, Selector.R_Sig_Socket) then
439 Clear (RSet, Selector.R_Sig_Socket);
444 Res := C_Read (C.int (Selector.R_Sig_Socket), Buf'Address, 1);
453 -- Update RSet, WSet and ESet in regard to their new socket
460 -- Reset RSet as it should be if R_Sig_Socket was not added.
462 if Is_Empty (RSet) then
466 if Is_Empty (WSet) then
470 if Is_Empty (ESet) then
474 -- Deliver RSet, WSet and ESet.
476 Empty (R_Socket_Set);
477 R_Socket_Set := RSet;
479 Empty (W_Socket_Set);
480 W_Socket_Set := WSet;
482 Empty (E_Socket_Set);
483 E_Socket_Set := ESet;
491 (Item : in out Socket_Set_Type;
492 Socket : Socket_Type)
494 Last : aliased C.int := C.int (Item.Last);
497 if Item.Last /= No_Socket then
498 Remove_Socket_From_Set (Item.Set, C.int (Socket));
499 Last_Socket_In_Set (Item.Set, Last'Unchecked_Access);
500 Item.Last := Socket_Type (Last);
508 -- Comments needed below ???
509 -- Why are exceptions ignored ???
511 procedure Close_Selector (Selector : in out Selector_Type) is
514 Close_Socket (Selector.R_Sig_Socket);
522 Close_Socket (Selector.W_Sig_Socket);
534 procedure Close_Socket (Socket : Socket_Type) is
538 Res := C_Close (C.int (Socket));
540 if Res = Failure then
541 Raise_Socket_Error (Socket_Errno);
549 procedure Connect_Socket
550 (Socket : Socket_Type;
551 Server : in out Sock_Addr_Type)
554 Sin : aliased Sockaddr_In;
555 Len : constant C.int := Sin'Size / 8;
558 if Server.Family = Family_Inet6 then
562 Set_Length (Sin'Unchecked_Access, Len);
563 Set_Family (Sin'Unchecked_Access, Families (Server.Family));
564 Set_Address (Sin'Unchecked_Access, To_In_Addr (Server.Addr));
566 (Sin'Unchecked_Access,
567 Short_To_Network (C.unsigned_short (Server.Port)));
569 Res := C_Connect (C.int (Socket), Sin'Address, Len);
571 if Res = Failure then
572 Raise_Socket_Error (Socket_Errno);
580 procedure Control_Socket
581 (Socket : Socket_Type;
582 Request : in out Request_Type)
589 when Non_Blocking_IO =>
590 Arg := C.int (Boolean'Pos (Request.Enabled));
592 when N_Bytes_To_Read =>
599 Requests (Request.Name),
600 Arg'Unchecked_Access);
602 if Res = Failure then
603 Raise_Socket_Error (Socket_Errno);
607 when Non_Blocking_IO =>
610 when N_Bytes_To_Read =>
611 Request.Size := Natural (Arg);
621 (Source : Socket_Set_Type;
622 Target : in out Socket_Set_Type)
626 if Source.Last /= No_Socket then
627 Target.Set := New_Socket_Set (Source.Set);
628 Target.Last := Source.Last;
632 ---------------------
633 -- Create_Selector --
634 ---------------------
636 procedure Create_Selector (Selector : out Selector_Type) is
641 Sin : aliased Sockaddr_In;
642 Len : aliased C.int := Sin'Size / 8;
646 -- We open two signalling sockets. One of them is used to
647 -- send data to the other, which is included in a C_Select
648 -- socket set. The communication is used to force the call
649 -- to C_Select to complete, and the waiting task to resume
652 -- Create a listening socket
654 S0 := C_Socket (Constants.AF_INET, Constants.SOCK_STREAM, 0);
656 Raise_Socket_Error (Socket_Errno);
659 -- Sin is already correctly initialized. Bind the socket to any
662 Res := C_Bind (S0, Sin'Address, Len);
663 if Res = Failure then
666 Raise_Socket_Error (Err);
669 -- Get the port used by the socket
671 Res := C_Getsockname (S0, Sin'Address, Len'Access);
673 if Res = Failure then
676 Raise_Socket_Error (Err);
679 Res := C_Listen (S0, 2);
681 if Res = Failure then
684 Raise_Socket_Error (Err);
687 S1 := C_Socket (Constants.AF_INET, Constants.SOCK_STREAM, 0);
692 Raise_Socket_Error (Err);
695 -- Use INADDR_LOOPBACK
697 Sin.Sin_Addr.S_B1 := 127;
698 Sin.Sin_Addr.S_B2 := 0;
699 Sin.Sin_Addr.S_B3 := 0;
700 Sin.Sin_Addr.S_B4 := 1;
702 -- Do a connect and accept the connection
704 Res := C_Connect (S1, Sin'Address, Len);
706 if Res = Failure then
710 Raise_Socket_Error (Err);
713 S2 := C_Accept (S0, Sin'Address, Len'Access);
719 Raise_Socket_Error (Err);
724 if Res = Failure then
725 Raise_Socket_Error (Socket_Errno);
728 Selector.R_Sig_Socket := Socket_Type (S1);
729 Selector.W_Sig_Socket := Socket_Type (S2);
736 procedure Create_Socket
737 (Socket : out Socket_Type;
738 Family : Family_Type := Family_Inet;
739 Mode : Mode_Type := Socket_Stream)
744 Res := C_Socket (Families (Family), Modes (Mode), 0);
746 if Res = Failure then
747 Raise_Socket_Error (Socket_Errno);
750 Socket := Socket_Type (Res);
757 procedure Empty (Item : in out Socket_Set_Type) is
759 if Item.Set /= No_Socket_Set then
760 Free_Socket_Set (Item.Set);
761 Item.Set := No_Socket_Set;
764 Item.Last := No_Socket;
771 procedure Finalize is
785 procedure Free (Stream : in out Stream_Access) is
786 procedure Do_Free is new Ada.Unchecked_Deallocation
787 (Ada.Streams.Root_Stream_Type'Class, Stream_Access);
797 (Item : in out Socket_Set_Type;
798 Socket : out Socket_Type)
801 L : aliased C.int := C.int (Item.Last);
804 if Item.Last /= No_Socket then
806 (Item.Set, L'Unchecked_Access, S'Unchecked_Access);
807 Item.Last := Socket_Type (L);
808 Socket := Socket_Type (S);
818 function Get_Address (Stream : Stream_Access) return Sock_Addr_Type is
820 if Stream = null then
823 elsif Stream.all in Datagram_Socket_Stream_Type then
824 return Datagram_Socket_Stream_Type (Stream.all).From;
827 return Get_Peer_Name (Stream_Socket_Stream_Type (Stream.all).Socket);
831 -------------------------
832 -- Get_Host_By_Address --
833 -------------------------
835 function Get_Host_By_Address
836 (Address : Inet_Addr_Type;
837 Family : Family_Type := Family_Inet)
838 return Host_Entry_Type
840 pragma Unreferenced (Family);
842 HA : aliased In_Addr := To_In_Addr (Address);
843 Res : Hostent_Access;
847 -- This C function is not always thread-safe. Protect against
848 -- concurrent access.
851 Res := C_Gethostbyaddr (HA'Address, HA'Size / 8, Constants.AF_INET);
856 Raise_Host_Error (Err);
859 -- Translate from the C format to the API format
862 HE : constant Host_Entry_Type := To_Host_Entry (Res.all);
868 end Get_Host_By_Address;
870 ----------------------
871 -- Get_Host_By_Name --
872 ----------------------
874 function Get_Host_By_Name (Name : String) return Host_Entry_Type is
875 HN : constant C.char_array := C.To_C (Name);
876 Res : Hostent_Access;
880 -- Detect IP address name and redirect to Inet_Addr.
882 if Is_IP_Address (Name) then
883 return Get_Host_By_Address (Inet_Addr (Name));
886 -- This C function is not always thread-safe. Protect against
887 -- concurrent access.
890 Res := C_Gethostbyname (HN);
895 Raise_Host_Error (Err);
898 -- Translate from the C format to the API format
901 HE : constant Host_Entry_Type := To_Host_Entry (Res.all);
907 end Get_Host_By_Name;
913 function Get_Peer_Name (Socket : Socket_Type) return Sock_Addr_Type is
914 Sin : aliased Sockaddr_In;
915 Len : aliased C.int := Sin'Size / 8;
916 Res : Sock_Addr_Type (Family_Inet);
919 if C_Getpeername (C.int (Socket), Sin'Address, Len'Access) = Failure then
920 Raise_Socket_Error (Socket_Errno);
923 Res.Addr := To_Inet_Addr (Sin.Sin_Addr);
924 Res.Port := Port_Type (Network_To_Short (Sin.Sin_Port));
929 -------------------------
930 -- Get_Service_By_Name --
931 -------------------------
933 function Get_Service_By_Name
936 return Service_Entry_Type
938 SN : constant C.char_array := C.To_C (Name);
939 SP : constant C.char_array := C.To_C (Protocol);
940 Res : Servent_Access;
943 -- This C function is not always thread-safe. Protect against
944 -- concurrent access.
947 Res := C_Getservbyname (SN, SP);
951 Ada.Exceptions.Raise_Exception
952 (Service_Error'Identity, "Service not found");
955 -- Translate from the C format to the API format
958 SE : constant Service_Entry_Type := To_Service_Entry (Res.all);
964 end Get_Service_By_Name;
966 -------------------------
967 -- Get_Service_By_Port --
968 -------------------------
970 function Get_Service_By_Port
973 return Service_Entry_Type
975 SP : constant C.char_array := C.To_C (Protocol);
976 Res : Servent_Access;
979 -- This C function is not always thread-safe. Protect against
980 -- concurrent access.
983 Res := C_Getservbyport
984 (C.int (Short_To_Network (C.unsigned_short (Port))), SP);
988 Ada.Exceptions.Raise_Exception
989 (Service_Error'Identity, "Service not found");
992 -- Translate from the C format to the API format
995 SE : constant Service_Entry_Type := To_Service_Entry (Res.all);
1001 end Get_Service_By_Port;
1003 ---------------------
1004 -- Get_Socket_Name --
1005 ---------------------
1007 function Get_Socket_Name
1008 (Socket : Socket_Type)
1009 return Sock_Addr_Type
1011 Sin : aliased Sockaddr_In;
1012 Len : aliased C.int := Sin'Size / 8;
1014 Addr : Sock_Addr_Type := No_Sock_Addr;
1017 Res := C_Getsockname (C.int (Socket), Sin'Address, Len'Access);
1018 if Res /= Failure then
1019 Addr.Addr := To_Inet_Addr (Sin.Sin_Addr);
1020 Addr.Port := Port_Type (Network_To_Short (Sin.Sin_Port));
1024 end Get_Socket_Name;
1026 -----------------------
1027 -- Get_Socket_Option --
1028 -----------------------
1030 function Get_Socket_Option
1031 (Socket : Socket_Type;
1032 Level : Level_Type := Socket_Level;
1036 use type C.unsigned_char;
1038 V8 : aliased Two_Int;
1040 V1 : aliased C.unsigned_char;
1041 Len : aliased C.int;
1042 Add : System.Address;
1044 Opt : Option_Type (Name);
1048 when Multicast_Loop |
1076 Add, Len'Unchecked_Access);
1078 if Res = Failure then
1079 Raise_Socket_Error (Socket_Errno);
1087 Opt.Enabled := (V4 /= 0);
1090 Opt.Enabled := (V8 (V8'First) /= 0);
1091 Opt.Seconds := Natural (V8 (V8'Last));
1095 Opt.Size := Natural (V4);
1098 Opt.Error := Resolve_Error (Integer (V4));
1100 when Add_Membership |
1102 Opt.Multiaddr := To_Inet_Addr (To_In_Addr (V8 (V8'First)));
1103 Opt.Interface := To_Inet_Addr (To_In_Addr (V8 (V8'Last)));
1105 when Multicast_TTL =>
1106 Opt.Time_To_Live := Integer (V1);
1108 when Multicast_Loop =>
1109 Opt.Enabled := (V1 /= 0);
1114 end Get_Socket_Option;
1120 function Host_Name return String is
1121 Name : aliased C.char_array (1 .. 64);
1125 Res := C_Gethostname (Name'Address, Name'Length);
1127 if Res = Failure then
1128 Raise_Socket_Error (Socket_Errno);
1131 return C.To_Ada (Name);
1139 (Val : Inet_Addr_VN_Type;
1140 Hex : Boolean := False)
1143 -- The largest Inet_Addr_Comp_Type image occurs with IPv4. It
1144 -- has at most a length of 3 plus one '.' character.
1146 Buffer : String (1 .. 4 * Val'Length);
1147 Length : Natural := 1;
1148 Separator : Character;
1150 procedure Img10 (V : Inet_Addr_Comp_Type);
1151 -- Append to Buffer image of V in decimal format
1153 procedure Img16 (V : Inet_Addr_Comp_Type);
1154 -- Append to Buffer image of V in hexadecimal format
1156 procedure Img10 (V : Inet_Addr_Comp_Type) is
1157 Img : constant String := V'Img;
1158 Len : constant Natural := Img'Length - 1;
1161 Buffer (Length .. Length + Len - 1) := Img (2 .. Img'Last);
1162 Length := Length + Len;
1165 procedure Img16 (V : Inet_Addr_Comp_Type) is
1167 Buffer (Length) := Hex_To_Char (Natural (V / 16) + 1);
1168 Buffer (Length + 1) := Hex_To_Char (Natural (V mod 16) + 1);
1169 Length := Length + 2;
1172 -- Start of processing for Image
1181 for J in Val'Range loop
1188 if J /= Val'Last then
1189 Buffer (Length) := Separator;
1190 Length := Length + 1;
1194 return Buffer (1 .. Length - 1);
1201 function Image (Value : Inet_Addr_Type) return String is
1203 if Value.Family = Family_Inet then
1204 return Image (Inet_Addr_VN_Type (Value.Sin_V4), Hex => False);
1206 return Image (Inet_Addr_VN_Type (Value.Sin_V6), Hex => True);
1214 function Image (Value : Sock_Addr_Type) return String is
1215 Port : constant String := Value.Port'Img;
1218 return Image (Value.Addr) & ':' & Port (2 .. Port'Last);
1225 function Image (Socket : Socket_Type) return String is
1234 function Inet_Addr (Image : String) return Inet_Addr_Type is
1235 use Interfaces.C.Strings;
1237 Img : chars_ptr := New_String (Image);
1242 Res := C_Inet_Addr (Img);
1246 if Res = Failure then
1247 Raise_Socket_Error (Err);
1250 return To_Inet_Addr (To_In_Addr (Res));
1257 procedure Initialize (Process_Blocking_IO : Boolean := False) is
1259 if not Initialized then
1260 Initialized := True;
1261 Thin.Initialize (Process_Blocking_IO);
1269 function Is_Empty (Item : Socket_Set_Type) return Boolean is
1271 return Item.Last = No_Socket;
1278 function Is_IP_Address (Name : String) return Boolean is
1280 for J in Name'Range loop
1282 and then Name (J) not in '0' .. '9'
1296 (Item : Socket_Set_Type;
1297 Socket : Socket_Type)
1301 return Item.Last /= No_Socket
1302 and then Socket <= Item.Last
1303 and then Is_Socket_In_Set (Item.Set, C.int (Socket));
1310 procedure Listen_Socket
1311 (Socket : Socket_Type;
1312 Length : Positive := 15)
1317 Res := C_Listen (C.int (Socket), C.int (Length));
1318 if Res = Failure then
1319 Raise_Socket_Error (Socket_Errno);
1327 procedure Narrow (Item : in out Socket_Set_Type) is
1328 Last : aliased C.int := C.int (Item.Last);
1331 if Item.Set /= No_Socket_Set then
1332 Last_Socket_In_Set (Item.Set, Last'Unchecked_Access);
1333 Item.Last := Socket_Type (Last);
1341 function Official_Name (E : Host_Entry_Type) return String is
1343 return To_String (E.Official);
1350 function Official_Name (S : Service_Entry_Type) return String is
1352 return To_String (S.Official);
1359 function Port_Number (S : Service_Entry_Type) return Port_Type is
1368 function Protocol_Name (S : Service_Entry_Type) return String is
1370 return To_String (S.Protocol);
1373 ----------------------
1374 -- Raise_Host_Error --
1375 ----------------------
1377 procedure Raise_Host_Error (Error : Integer) is
1379 function Error_Message return String;
1380 -- We do not use a C function like strerror because hstrerror
1381 -- that would correspond seems to be obsolete. Return
1382 -- appropriate string for error value.
1384 function Error_Message return String is
1387 when Constants.HOST_NOT_FOUND => return "Host not found";
1388 when Constants.TRY_AGAIN => return "Try again";
1389 when Constants.NO_RECOVERY => return "No recovery";
1390 when Constants.NO_DATA => return "No address";
1391 when others => return "Unknown error";
1395 -- Start of processing for Raise_Host_Error
1398 Ada.Exceptions.Raise_Exception (Host_Error'Identity, Error_Message);
1399 end Raise_Host_Error;
1401 ------------------------
1402 -- Raise_Socket_Error --
1403 ------------------------
1405 procedure Raise_Socket_Error (Error : Integer) is
1406 use type C.Strings.chars_ptr;
1408 function Image (E : Integer) return String;
1409 function Image (E : Integer) return String is
1410 Msg : String := E'Img & "] ";
1412 Msg (Msg'First) := '[';
1417 Ada.Exceptions.Raise_Exception
1418 (Socket_Error'Identity, Image (Error) & Socket_Error_Message (Error));
1419 end Raise_Socket_Error;
1426 (Stream : in out Datagram_Socket_Stream_Type;
1427 Item : out Ada.Streams.Stream_Element_Array;
1428 Last : out Ada.Streams.Stream_Element_Offset)
1430 First : Ada.Streams.Stream_Element_Offset := Item'First;
1431 Index : Ada.Streams.Stream_Element_Offset := First - 1;
1432 Max : constant Ada.Streams.Stream_Element_Offset := Item'Last;
1438 Item (First .. Max),
1444 -- Exit when all or zero data received. Zero means that
1445 -- the socket peer is closed.
1447 exit when Index < First or else Index = Max;
1458 (Stream : in out Stream_Socket_Stream_Type;
1459 Item : out Ada.Streams.Stream_Element_Array;
1460 Last : out Ada.Streams.Stream_Element_Offset)
1462 First : Ada.Streams.Stream_Element_Offset := Item'First;
1463 Index : Ada.Streams.Stream_Element_Offset := First - 1;
1464 Max : constant Ada.Streams.Stream_Element_Offset := Item'Last;
1468 Receive_Socket (Stream.Socket, Item (First .. Max), Index);
1471 -- Exit when all or zero data received. Zero means that
1472 -- the socket peer is closed.
1474 exit when Index < First or else Index = Max;
1480 --------------------
1481 -- Receive_Socket --
1482 --------------------
1484 procedure Receive_Socket
1485 (Socket : Socket_Type;
1486 Item : out Ada.Streams.Stream_Element_Array;
1487 Last : out Ada.Streams.Stream_Element_Offset;
1488 Flags : Request_Flag_Type := No_Request_Flag)
1490 use type Ada.Streams.Stream_Element_Offset;
1497 Item (Item'First)'Address,
1501 if Res = Failure then
1502 Raise_Socket_Error (Socket_Errno);
1505 Last := Item'First + Ada.Streams.Stream_Element_Offset (Res - 1);
1508 --------------------
1509 -- Receive_Socket --
1510 --------------------
1512 procedure Receive_Socket
1513 (Socket : Socket_Type;
1514 Item : out Ada.Streams.Stream_Element_Array;
1515 Last : out Ada.Streams.Stream_Element_Offset;
1516 From : out Sock_Addr_Type;
1517 Flags : Request_Flag_Type := No_Request_Flag)
1519 use type Ada.Streams.Stream_Element_Offset;
1522 Sin : aliased Sockaddr_In;
1523 Len : aliased C.int := Sin'Size / 8;
1529 Item (Item'First)'Address,
1532 Sin'Unchecked_Access,
1533 Len'Unchecked_Access);
1535 if Res = Failure then
1536 Raise_Socket_Error (Socket_Errno);
1539 Last := Item'First + Ada.Streams.Stream_Element_Offset (Res - 1);
1541 From.Addr := To_Inet_Addr (Sin.Sin_Addr);
1542 From.Port := Port_Type (Network_To_Short (Sin.Sin_Port));
1549 function Resolve_Error
1550 (Error_Value : Integer;
1551 From_Errno : Boolean := True)
1554 use GNAT.Sockets.Constants;
1557 if not From_Errno then
1559 when Constants.HOST_NOT_FOUND => return Unknown_Host;
1560 when Constants.TRY_AGAIN => return Host_Name_Lookup_Failure;
1561 when Constants.NO_RECOVERY =>
1562 return Non_Recoverable_Error;
1563 when Constants.NO_DATA => return Unknown_Server_Error;
1564 when others => return Cannot_Resolve_Error;
1569 when ENOERROR => return Success;
1570 when EACCES => return Permission_Denied;
1571 when EADDRINUSE => return Address_Already_In_Use;
1572 when EADDRNOTAVAIL => return Cannot_Assign_Requested_Address;
1573 when EAFNOSUPPORT =>
1574 return Address_Family_Not_Supported_By_Protocol;
1575 when EALREADY => return Operation_Already_In_Progress;
1576 when EBADF => return Bad_File_Descriptor;
1577 when ECONNABORTED => return Software_Caused_Connection_Abort;
1578 when ECONNREFUSED => return Connection_Refused;
1579 when ECONNRESET => return Connection_Reset_By_Peer;
1580 when EDESTADDRREQ => return Destination_Address_Required;
1581 when EFAULT => return Bad_Address;
1582 when EHOSTDOWN => return Host_Is_Down;
1583 when EHOSTUNREACH => return No_Route_To_Host;
1584 when EINPROGRESS => return Operation_Now_In_Progress;
1585 when EINTR => return Interrupted_System_Call;
1586 when EINVAL => return Invalid_Argument;
1587 when EIO => return Input_Output_Error;
1588 when EISCONN => return Transport_Endpoint_Already_Connected;
1589 when ELOOP => return Too_Many_Symbolic_Links;
1590 when EMFILE => return Too_Many_Open_Files;
1591 when EMSGSIZE => return Message_Too_Long;
1592 when ENAMETOOLONG => return File_Name_Too_Long;
1593 when ENETDOWN => return Network_Is_Down;
1595 return Network_Dropped_Connection_Because_Of_Reset;
1596 when ENETUNREACH => return Network_Is_Unreachable;
1597 when ENOBUFS => return No_Buffer_Space_Available;
1598 when ENOPROTOOPT => return Protocol_Not_Available;
1599 when ENOTCONN => return Transport_Endpoint_Not_Connected;
1600 when ENOTSOCK => return Socket_Operation_On_Non_Socket;
1601 when EOPNOTSUPP => return Operation_Not_Supported;
1602 when EPFNOSUPPORT => return Protocol_Family_Not_Supported;
1603 when EPROTONOSUPPORT => return Protocol_Not_Supported;
1604 when EPROTOTYPE => return Protocol_Wrong_Type_For_Socket;
1606 return Cannot_Send_After_Transport_Endpoint_Shutdown;
1607 when ESOCKTNOSUPPORT => return Socket_Type_Not_Supported;
1608 when ETIMEDOUT => return Connection_Timed_Out;
1609 when ETOOMANYREFS => return Too_Many_References;
1610 when EWOULDBLOCK => return Resource_Temporarily_Unavailable;
1611 when others => null;
1614 return Cannot_Resolve_Error;
1617 -----------------------
1618 -- Resolve_Exception --
1619 -----------------------
1621 function Resolve_Exception
1622 (Occurrence : Exception_Occurrence)
1625 Id : constant Exception_Id := Exception_Identity (Occurrence);
1626 Msg : constant String := Exception_Message (Occurrence);
1627 First : Natural := Msg'First;
1632 while First <= Msg'Last
1633 and then Msg (First) not in '0' .. '9'
1638 if First > Msg'Last then
1639 return Cannot_Resolve_Error;
1644 while Last < Msg'Last
1645 and then Msg (Last + 1) in '0' .. '9'
1650 Val := Integer'Value (Msg (First .. Last));
1652 if Id = Socket_Error_Id then
1653 return Resolve_Error (Val);
1655 elsif Id = Host_Error_Id then
1656 return Resolve_Error (Val, False);
1659 return Cannot_Resolve_Error;
1661 end Resolve_Exception;
1663 --------------------
1664 -- Receive_Vector --
1665 --------------------
1667 procedure Receive_Vector
1668 (Socket : Socket_Type;
1669 Vector : Vector_Type;
1670 Count : out Ada.Streams.Stream_Element_Count)
1678 Vector (Vector'First)'Address,
1681 if Res = Failure then
1682 Raise_Socket_Error (Socket_Errno);
1685 Count := Ada.Streams.Stream_Element_Count (Res);
1692 procedure Send_Socket
1693 (Socket : Socket_Type;
1694 Item : Ada.Streams.Stream_Element_Array;
1695 Last : out Ada.Streams.Stream_Element_Offset;
1696 Flags : Request_Flag_Type := No_Request_Flag)
1698 use type Ada.Streams.Stream_Element_Offset;
1706 Item (Item'First)'Address,
1710 if Res = Failure then
1711 Raise_Socket_Error (Socket_Errno);
1714 Last := Item'First + Ada.Streams.Stream_Element_Offset (Res - 1);
1721 procedure Send_Socket
1722 (Socket : Socket_Type;
1723 Item : Ada.Streams.Stream_Element_Array;
1724 Last : out Ada.Streams.Stream_Element_Offset;
1725 To : Sock_Addr_Type;
1726 Flags : Request_Flag_Type := No_Request_Flag)
1728 use type Ada.Streams.Stream_Element_Offset;
1731 Sin : aliased Sockaddr_In;
1732 Len : constant C.int := Sin'Size / 8;
1735 Set_Length (Sin'Unchecked_Access, Len);
1736 Set_Family (Sin'Unchecked_Access, Families (To.Family));
1737 Set_Address (Sin'Unchecked_Access, To_In_Addr (To.Addr));
1739 (Sin'Unchecked_Access,
1740 Short_To_Network (C.unsigned_short (To.Port)));
1744 Item (Item'First)'Address,
1747 Sin'Unchecked_Access,
1750 if Res = Failure then
1751 Raise_Socket_Error (Socket_Errno);
1754 Last := Item'First + Ada.Streams.Stream_Element_Offset (Res - 1);
1761 procedure Send_Vector
1762 (Socket : Socket_Type;
1763 Vector : Vector_Type;
1764 Count : out Ada.Streams.Stream_Element_Count)
1771 Vector (Vector'First)'Address,
1774 if Res = Failure then
1775 Raise_Socket_Error (Socket_Errno);
1778 Count := Ada.Streams.Stream_Element_Count (Res);
1785 procedure Set (Item : in out Socket_Set_Type; Socket : Socket_Type) is
1787 if Item.Set = No_Socket_Set then
1788 Item.Set := New_Socket_Set (No_Socket_Set);
1789 Item.Last := Socket;
1791 elsif Item.Last < Socket then
1792 Item.Last := Socket;
1795 Insert_Socket_In_Set (Item.Set, C.int (Socket));
1798 -----------------------
1799 -- Set_Socket_Option --
1800 -----------------------
1802 procedure Set_Socket_Option
1803 (Socket : Socket_Type;
1804 Level : Level_Type := Socket_Level;
1805 Option : Option_Type)
1807 V8 : aliased Two_Int;
1809 V1 : aliased C.unsigned_char;
1810 Len : aliased C.int;
1811 Add : System.Address := Null_Address;
1820 V4 := C.int (Boolean'Pos (Option.Enabled));
1825 V8 (V8'First) := C.int (Boolean'Pos (Option.Enabled));
1826 V8 (V8'Last) := C.int (Option.Seconds);
1832 V4 := C.int (Option.Size);
1837 V4 := C.int (Boolean'Pos (True));
1841 when Add_Membership |
1843 V8 (V8'First) := To_Int (To_In_Addr (Option.Multiaddr));
1844 V8 (V8'Last) := To_Int (To_In_Addr (Option.Interface));
1848 when Multicast_TTL =>
1849 V1 := C.unsigned_char (Option.Time_To_Live);
1853 when Multicast_Loop =>
1854 V1 := C.unsigned_char (Boolean'Pos (Option.Enabled));
1863 Options (Option.Name),
1866 if Res = Failure then
1867 Raise_Socket_Error (Socket_Errno);
1869 end Set_Socket_Option;
1871 ----------------------
1872 -- Short_To_Network --
1873 ----------------------
1875 function Short_To_Network (S : C.unsigned_short) return C.unsigned_short is
1876 use type C.unsigned_short;
1879 pragma Warnings (Off);
1881 -- Big-endian case. No conversion needed. On these platforms,
1882 -- htons() defaults to a null procedure.
1884 if Default_Bit_Order = High_Order_First then
1887 -- Little-endian case. We must swap the high and low bytes of this
1888 -- short to make the port number network compliant.
1891 return (S / 256) + (S mod 256) * 256;
1894 pragma Warnings (On);
1895 end Short_To_Network;
1897 ---------------------
1898 -- Shutdown_Socket --
1899 ---------------------
1901 procedure Shutdown_Socket
1902 (Socket : Socket_Type;
1903 How : Shutmode_Type := Shut_Read_Write)
1908 Res := C_Shutdown (C.int (Socket), Shutmodes (How));
1910 if Res = Failure then
1911 Raise_Socket_Error (Socket_Errno);
1913 end Shutdown_Socket;
1920 (Socket : Socket_Type;
1921 Send_To : Sock_Addr_Type)
1922 return Stream_Access
1924 S : Datagram_Socket_Stream_Access;
1927 S := new Datagram_Socket_Stream_Type;
1930 S.From := Get_Socket_Name (Socket);
1931 return Stream_Access (S);
1938 function Stream (Socket : Socket_Type) return Stream_Access is
1939 S : Stream_Socket_Stream_Access;
1942 S := new Stream_Socket_Stream_Type;
1944 return Stream_Access (S);
1951 function To_C (Socket : Socket_Type) return Integer is
1953 return Integer (Socket);
1960 function To_Host_Entry (E : Hostent) return Host_Entry_Type is
1963 Official : constant String :=
1964 C.Strings.Value (E.H_Name);
1966 Aliases : constant Chars_Ptr_Array :=
1967 Chars_Ptr_Pointers.Value (E.H_Aliases);
1968 -- H_Aliases points to a list of name aliases. The list is
1969 -- terminated by a NULL pointer.
1971 Addresses : constant In_Addr_Access_Array :=
1972 In_Addr_Access_Pointers.Value (E.H_Addr_List);
1973 -- H_Addr_List points to a list of binary addresses (in network
1974 -- byte order). The list is terminated by a NULL pointer.
1976 -- H_Length is not used because it is currently only set to 4.
1977 -- H_Addrtype is always AF_INET
1979 Result : Host_Entry_Type
1980 (Aliases_Length => Aliases'Length - 1,
1981 Addresses_Length => Addresses'Length - 1);
1982 -- The last element is a null pointer.
1988 Result.Official := To_Name (Official);
1990 Source := Aliases'First;
1991 Target := Result.Aliases'First;
1992 while Target <= Result.Aliases_Length loop
1993 Result.Aliases (Target) :=
1994 To_Name (C.Strings.Value (Aliases (Source)));
1995 Source := Source + 1;
1996 Target := Target + 1;
1999 Source := Addresses'First;
2000 Target := Result.Addresses'First;
2001 while Target <= Result.Addresses_Length loop
2002 Result.Addresses (Target) :=
2003 To_Inet_Addr (Addresses (Source).all);
2004 Source := Source + 1;
2005 Target := Target + 1;
2015 function To_In_Addr (Addr : Inet_Addr_Type) return Thin.In_Addr is
2017 if Addr.Family = Family_Inet then
2018 return (S_B1 => C.unsigned_char (Addr.Sin_V4 (1)),
2019 S_B2 => C.unsigned_char (Addr.Sin_V4 (2)),
2020 S_B3 => C.unsigned_char (Addr.Sin_V4 (3)),
2021 S_B4 => C.unsigned_char (Addr.Sin_V4 (4)));
2031 function To_Inet_Addr
2033 return Inet_Addr_Type
2035 Result : Inet_Addr_Type;
2038 Result.Sin_V4 (1) := Inet_Addr_Comp_Type (Addr.S_B1);
2039 Result.Sin_V4 (2) := Inet_Addr_Comp_Type (Addr.S_B2);
2040 Result.Sin_V4 (3) := Inet_Addr_Comp_Type (Addr.S_B3);
2041 Result.Sin_V4 (4) := Inet_Addr_Comp_Type (Addr.S_B4);
2050 function To_Int (F : Request_Flag_Type) return C.int
2052 Current : Request_Flag_Type := F;
2053 Result : C.int := 0;
2056 for J in Flags'Range loop
2057 exit when Current = 0;
2059 if Current mod 2 /= 0 then
2060 if Flags (J) = -1 then
2061 Raise_Socket_Error (Constants.EOPNOTSUPP);
2063 Result := Result + Flags (J);
2066 Current := Current / 2;
2076 function To_Name (N : String) return Name_Type is
2078 return Name_Type'(N'Length, N);
2081 ----------------------
2082 -- To_Service_Entry --
2083 ----------------------
2085 function To_Service_Entry (E : Servent) return Service_Entry_Type is
2088 Official : constant String :=
2089 C.Strings.Value (E.S_Name);
2091 Aliases : constant Chars_Ptr_Array :=
2092 Chars_Ptr_Pointers.Value (E.S_Aliases);
2093 -- S_Aliases points to a list of name aliases. The list is
2094 -- terminated by a NULL pointer.
2096 Protocol : constant String :=
2097 C.Strings.Value (E.S_Proto);
2099 Result : Service_Entry_Type
2100 (Aliases_Length => Aliases'Length - 1);
2101 -- The last element is a null pointer.
2107 Result.Official := To_Name (Official);
2109 Source := Aliases'First;
2110 Target := Result.Aliases'First;
2111 while Target <= Result.Aliases_Length loop
2112 Result.Aliases (Target) :=
2113 To_Name (C.Strings.Value (Aliases (Source)));
2114 Source := Source + 1;
2115 Target := Target + 1;
2119 Port_Type (Network_To_Short (C.unsigned_short (E.S_Port)));
2121 Result.Protocol := To_Name (Protocol);
2124 end To_Service_Entry;
2130 function To_String (HN : Name_Type) return String is
2132 return HN.Name (1 .. HN.Length);
2139 function To_Timeval (Val : Selector_Duration) return Timeval is
2144 S := Timeval_Unit (Val - 0.5);
2145 MS := Timeval_Unit (1_000_000 * (Val - Selector_Duration (S)));
2154 (Stream : in out Datagram_Socket_Stream_Type;
2155 Item : Ada.Streams.Stream_Element_Array)
2157 First : Ada.Streams.Stream_Element_Offset := Item'First;
2158 Index : Ada.Streams.Stream_Element_Offset := First - 1;
2159 Max : constant Ada.Streams.Stream_Element_Offset := Item'Last;
2165 Item (First .. Max),
2169 -- Exit when all or zero data sent. Zero means that the
2170 -- socket has been closed by peer.
2172 exit when Index < First or else Index = Max;
2177 if Index /= Max then
2187 (Stream : in out Stream_Socket_Stream_Type;
2188 Item : Ada.Streams.Stream_Element_Array)
2190 First : Ada.Streams.Stream_Element_Offset := Item'First;
2191 Index : Ada.Streams.Stream_Element_Offset := First - 1;
2192 Max : constant Ada.Streams.Stream_Element_Offset := Item'Last;
2196 Send_Socket (Stream.Socket, Item (First .. Max), Index);
2198 -- Exit when all or zero data sent. Zero means that the
2199 -- socket has been closed by peer.
2201 exit when Index < First or else Index = Max;
2206 if Index /= Max then