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-2007, 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 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, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, 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 -- This package provides a target dependent thin interface to the sockets
35 -- layer for use by the GNAT.Sockets package (g-socket.ads). This package
36 -- should not be directly with'ed by an applications program.
38 -- This version is for NT
40 with Interfaces.C.Pointers;
41 with Interfaces.C.Strings;
43 with GNAT.Sockets.Constants;
47 package GNAT.Sockets.Thin is
49 package C renames Interfaces.C;
52 -- So that we can declare the Failure constant below
54 Success : constant C.int := 0;
55 Failure : constant C.int := -1;
57 function Socket_Errno return Integer;
58 -- Returns last socket error number
60 procedure Set_Socket_Errno (Errno : Integer);
61 -- Set last socket error number
63 function Socket_Error_Message (Errno : Integer) return C.Strings.chars_ptr;
64 -- Returns the error message string for the error number Errno. If Errno is
65 -- not known, returns "Unknown system error".
67 function Host_Errno return Integer;
68 pragma Import (C, Host_Errno, "__gnat_get_h_errno");
69 -- Returns last host error number
71 package Host_Error_Messages is
73 function Host_Error_Message
74 (H_Errno : Integer) return C.Strings.chars_ptr;
75 -- Returns the error message string for the host error number H_Errno.
76 -- If H_Errno is not known, returns "Unknown system error".
78 end Host_Error_Messages;
80 subtype Fd_Set_Access is System.Address;
81 No_Fd_Set : constant Fd_Set_Access := System.Null_Address;
84 range -2 ** (8 * Constants.SIZEOF_tv_sec - 1)
85 .. 2 ** (8 * Constants.SIZEOF_tv_sec - 1) - 1;
86 for time_t'Size use 8 * Constants.SIZEOF_tv_sec;
87 pragma Convention (C, time_t);
90 range -2 ** (8 * Constants.SIZEOF_tv_usec - 1)
91 .. 2 ** (8 * Constants.SIZEOF_tv_usec - 1) - 1;
92 for suseconds_t'Size use 8 * Constants.SIZEOF_tv_usec;
93 pragma Convention (C, suseconds_t);
95 type Timeval is record
97 Tv_Usec : suseconds_t;
99 pragma Convention (C, Timeval);
101 type Timeval_Access is access all Timeval;
102 pragma Convention (C, Timeval_Access);
104 Immediat : constant Timeval := (0, 0);
106 type Int_Access is access all C.int;
107 pragma Convention (C, Int_Access);
108 -- Access to C integers
110 type Chars_Ptr_Array is array (C.size_t range <>) of
111 aliased C.Strings.chars_ptr;
113 package Chars_Ptr_Pointers is
114 new C.Pointers (C.size_t, C.Strings.chars_ptr, Chars_Ptr_Array,
116 -- Arrays of C (char *)
118 type In_Addr is record
119 S_B1, S_B2, S_B3, S_B4 : C.unsigned_char;
121 for In_Addr'Alignment use C.int'Alignment;
122 pragma Convention (C, In_Addr);
123 -- IPv4 address, represented as a network-order C.int. Note that the
124 -- underlying operating system may assume that values of this type have
125 -- C.int alignment, so we need to provide a suitable alignment clause here.
127 type In_Addr_Access is access all In_Addr;
128 pragma Convention (C, In_Addr_Access);
129 -- Access to internet address
131 Inaddr_Any : aliased constant In_Addr := (others => 0);
132 -- Any internet address (all the interfaces)
134 type In_Addr_Access_Array is array (C.size_t range <>)
135 of aliased In_Addr_Access;
136 pragma Convention (C, In_Addr_Access_Array);
138 package In_Addr_Access_Pointers is
139 new C.Pointers (C.size_t, In_Addr_Access, In_Addr_Access_Array, null);
140 -- Array of internet addresses
142 type Sockaddr is record
143 Sa_Family : C.unsigned_short;
144 Sa_Data : C.char_array (1 .. 14);
146 pragma Convention (C, Sockaddr);
149 type Sockaddr_Access is access all Sockaddr;
150 pragma Convention (C, Sockaddr_Access);
151 -- Access to socket address
153 type Sockaddr_In is record
154 Sin_Family : C.unsigned_short := Constants.AF_INET;
155 Sin_Port : C.unsigned_short := 0;
156 Sin_Addr : In_Addr := Inaddr_Any;
157 Sin_Zero : C.char_array (1 .. 8) := (others => C.char'Val (0));
159 pragma Convention (C, Sockaddr_In);
160 -- Internet socket address
162 type Sockaddr_In_Access is access all Sockaddr_In;
163 pragma Convention (C, Sockaddr_In_Access);
164 -- Access to internet socket address
167 (Sin : Sockaddr_In_Access;
169 pragma Inline (Set_Length);
170 -- Set Sin.Sin_Length to Len.
171 -- On this platform, nothing is done as there is no such field.
174 (Sin : Sockaddr_In_Access;
176 pragma Inline (Set_Family);
177 -- Set Sin.Sin_Family to Family
180 (Sin : Sockaddr_In_Access;
181 Port : C.unsigned_short);
182 pragma Inline (Set_Port);
183 -- Set Sin.Sin_Port to Port
185 procedure Set_Address
186 (Sin : Sockaddr_In_Access;
188 pragma Inline (Set_Address);
189 -- Set Sin.Sin_Addr to Address
191 type Hostent is record
192 H_Name : C.Strings.chars_ptr;
193 H_Aliases : Chars_Ptr_Pointers.Pointer;
194 H_Addrtype : C.short;
196 H_Addr_List : In_Addr_Access_Pointers.Pointer;
198 pragma Convention (C, Hostent);
201 type Hostent_Access is access all Hostent;
202 pragma Convention (C, Hostent_Access);
203 -- Access to host entry
205 type Servent is record
206 S_Name : C.Strings.chars_ptr;
207 S_Aliases : Chars_Ptr_Pointers.Pointer;
209 S_Proto : C.Strings.chars_ptr;
211 pragma Convention (C, Servent);
214 type Servent_Access is access all Servent;
215 pragma Convention (C, Servent_Access);
216 -- Access to service entry
218 type Two_Ints is array (0 .. 1) of C.int;
219 pragma Convention (C, Two_Ints);
220 -- Container for two int values
222 subtype Fd_Pair is Two_Ints;
223 -- Two_Ints as used for Create_Signalling_Fds: a pair of connected file
224 -- descriptors, one of which (the "read end" of the connection) being used
225 -- for reading, the other one (the "write end") being used for writing.
227 Read_End : constant := 0;
228 Write_End : constant := 1;
229 -- Indices into an Fd_Pair value providing access to each of the connected
232 --------------------------------
233 -- Standard library functions --
234 --------------------------------
238 Addr : System.Address;
239 Addrlen : not null access C.int) return C.int;
243 Name : System.Address;
244 Namelen : C.int) return C.int;
247 (Fd : C.int) return C.int;
251 Name : System.Address;
252 Namelen : C.int) return C.int;
254 function C_Gethostname
255 (Name : System.Address;
256 Namelen : C.int) return C.int;
258 function C_Getpeername
260 Name : System.Address;
261 Namelen : not null access C.int) return C.int;
263 function C_Getsockname
265 Name : System.Address;
266 Namelen : not null access C.int) return C.int;
268 function C_Getsockopt
272 Optval : System.Address;
273 Optlen : not null access C.int) return C.int;
276 (Cp : C.Strings.chars_ptr) return C.int;
281 Arg : Int_Access) return C.int;
285 Backlog : C.int) return C.int;
289 Iov : System.Address;
290 Iovcnt : C.int) return C.int;
294 Msg : System.Address;
296 Flags : C.int) return C.int;
300 Msg : System.Address;
303 From : Sockaddr_In_Access;
304 Fromlen : not null access C.int) return C.int;
308 Readfds : Fd_Set_Access;
309 Writefds : Fd_Set_Access;
310 Exceptfds : Fd_Set_Access;
311 Timeout : Timeval_Access) return C.int;
315 Msg : System.Address;
317 Flags : C.int) return C.int;
321 Msg : System.Address;
324 To : Sockaddr_In_Access;
325 Tolen : C.int) return C.int;
327 function C_Setsockopt
331 Optval : System.Address;
332 Optlen : C.int) return C.int;
336 How : C.int) return C.int;
341 Protocol : C.int) return C.int;
344 (Errnum : C.int) return C.Strings.chars_ptr;
347 (Command : System.Address) return C.int;
351 Iov : System.Address;
352 Iovcnt : C.int) return C.int;
355 (WS_Version : Interfaces.C.int;
356 WSADataAddress : System.Address) return Interfaces.C.int;
358 -------------------------------------------------------
359 -- Signalling file descriptors for selector abortion --
360 -------------------------------------------------------
362 package Signalling_Fds is
364 function Create (Fds : not null access Fd_Pair) return C.int;
365 pragma Convention (C, Create);
366 -- Create a pair of connected descriptors suitable for use with C_Select
367 -- (used for signalling in Selector objects).
369 function Read (Rsig : C.int) return C.int;
370 pragma Convention (C, Read);
371 -- Read one byte of data from rsig, the read end of a pair of signalling
372 -- fds created by Create_Signalling_Fds.
374 function Write (Wsig : C.int) return C.int;
375 pragma Convention (C, Write);
376 -- Write one byte of data to wsig, the write end of a pair of signalling
377 -- fds created by Create_Signalling_Fds.
379 procedure Close (Sig : C.int);
380 pragma Convention (C, Close);
381 -- Close one end of a pair of signalling fds (ignoring any error)
385 ----------------------------
386 -- Socket sets management --
387 ----------------------------
389 procedure Free_Socket_Set
390 (Set : Fd_Set_Access);
391 -- Free system-dependent socket set
393 procedure Get_Socket_From_Set
394 (Set : Fd_Set_Access;
397 -- Get last socket in Socket and remove it from the socket set. The
398 -- parameter Last is a maximum value of the largest socket. This hint is
399 -- used to avoid scanning very large socket sets. After a call to
400 -- Get_Socket_From_Set, Last is set back to the real largest socket in the
403 procedure Insert_Socket_In_Set
404 (Set : Fd_Set_Access;
406 -- Insert socket in the socket set
408 function Is_Socket_In_Set
409 (Set : Fd_Set_Access;
410 Socket : C.int) return C.int;
411 -- Check whether Socket is in the socket set, return a non-zero
412 -- value if it is, zero if it is not.
414 procedure Last_Socket_In_Set
415 (Set : Fd_Set_Access;
417 -- Find the largest socket in the socket set. This is needed for select().
418 -- When Last_Socket_In_Set is called, parameter Last is a maximum value of
419 -- the largest socket. This hint is used to avoid scanning very large
420 -- socket sets. After the call, Last is set back to the real largest socket
421 -- in the socket set.
423 function New_Socket_Set
424 (Set : Fd_Set_Access) return Fd_Set_Access;
425 -- Allocate a new socket set which is a system-dependent structure and
426 -- initialize by copying Set if it is non-null, by making it empty
429 procedure Remove_Socket_From_Set
430 (Set : Fd_Set_Access;
432 -- Remove socket from the socket set
434 procedure WSACleanup;
436 procedure Initialize;
440 pragma Import (Stdcall, C_Accept, "accept");
441 pragma Import (Stdcall, C_Bind, "bind");
442 pragma Import (Stdcall, C_Close, "closesocket");
443 pragma Import (Stdcall, C_Gethostname, "gethostname");
444 pragma Import (Stdcall, C_Getpeername, "getpeername");
445 pragma Import (Stdcall, C_Getsockname, "getsockname");
446 pragma Import (Stdcall, C_Getsockopt, "getsockopt");
447 pragma Import (Stdcall, C_Inet_Addr, "inet_addr");
448 pragma Import (Stdcall, C_Ioctl, "ioctlsocket");
449 pragma Import (Stdcall, C_Listen, "listen");
450 pragma Import (Stdcall, C_Recv, "recv");
451 pragma Import (Stdcall, C_Recvfrom, "recvfrom");
452 pragma Import (Stdcall, C_Send, "send");
453 pragma Import (Stdcall, C_Sendto, "sendto");
454 pragma Import (Stdcall, C_Setsockopt, "setsockopt");
455 pragma Import (Stdcall, C_Shutdown, "shutdown");
456 pragma Import (Stdcall, C_Socket, "socket");
457 pragma Import (C, C_Strerror, "strerror");
458 pragma Import (C, C_System, "_system");
459 pragma Import (Stdcall, Socket_Errno, "WSAGetLastError");
460 pragma Import (Stdcall, Set_Socket_Errno, "WSASetLastError");
461 pragma Import (Stdcall, WSAStartup, "WSAStartup");
462 pragma Import (Stdcall, WSACleanup, "WSACleanup");
464 pragma Import (C, Free_Socket_Set, "__gnat_free_socket_set");
465 pragma Import (C, Get_Socket_From_Set, "__gnat_get_socket_from_set");
466 pragma Import (C, Is_Socket_In_Set, "__gnat_is_socket_in_set");
467 pragma Import (C, Last_Socket_In_Set, "__gnat_last_socket_in_set");
468 pragma Import (C, New_Socket_Set, "__gnat_new_socket_set");
469 pragma Import (C, Insert_Socket_In_Set, "__gnat_insert_socket_in_set");
470 pragma Import (C, Remove_Socket_From_Set, "__gnat_remove_socket_from_set");
472 end GNAT.Sockets.Thin;