gcc/ada/g-socthi.ads

   1 ------------------------------------------------------------------------------
   2 --                                                                          --
   3 --                         GNAT COMPILER COMPONENTS                         --
   4 --                                                                          --
   5 --                    G N A T . S O C K E T S . T H I N                     --
   6 --                                                                          --
   7 --                                 S p e c                                  --
   8 --                                                                          --
   9 --              Copyright (C) 2001-2004 Ada Core Technologies, 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 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.                                                      --
  21 --                                                                          --
  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.                                      --
  28 --                                                                          --
  29 -- GNAT was originally developed  by the GNAT team at  New York University. --
  30 -- Extensive contributions were provided by Ada Core Technologies Inc.      --
  31 --                                                                          --
  32 ------------------------------------------------------------------------------
  33
  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.
  37
  38 --  This is the default version
  39
  40 with Interfaces.C.Pointers;
  41 with Interfaces.C.Strings;
  42 with GNAT.Sockets.Constants;
  43 with GNAT.OS_Lib;
  44
  45 with System;
  46
  47 package GNAT.Sockets.Thin is
  48
  49    --  This package is intended for hosts implementing BSD sockets with a
  50    --  standard interface. It will be used as a default for all the platforms
  51    --  that do not have a specific version of this file.
  52
  53    package C renames Interfaces.C;
  54
  55    use type C.int;
  56    --  This is so we can declare the Failure constant below
  57
  58    Success : constant C.int :=  0;
  59    Failure : constant C.int := -1;
  60
  61    function Socket_Errno return Integer renames GNAT.OS_Lib.Errno;
  62    --  Returns last socket error number.
  63
  64    function Socket_Error_Message (Errno : Integer) return C.Strings.chars_ptr;
  65    --  Returns the error message string for the error number Errno. If
  66    --  Errno is not known it returns "Unknown system error".
  67
  68    subtype Fd_Set_Access is System.Address;
  69    No_Fd_Set : constant Fd_Set_Access := System.Null_Address;
  70
  71    type Timeval_Unit is new C.int;
  72    pragma Convention (C, Timeval_Unit);
  73
  74    type Timeval is record
  75       Tv_Sec  : Timeval_Unit;
  76       Tv_Usec : Timeval_Unit;
  77    end record;
  78    pragma Convention (C, Timeval);
  79
  80    type Timeval_Access is access all Timeval;
  81    pragma Convention (C, Timeval_Access);
  82
  83    Immediat : constant Timeval := (0, 0);
  84
  85    type Int_Access is access all C.int;
  86    pragma Convention (C, Int_Access);
  87    --  Access to C integers
  88
  89    type Chars_Ptr_Array is array (C.size_t range <>) of
  90      aliased C.Strings.chars_ptr;
  91
  92    package Chars_Ptr_Pointers is
  93       new C.Pointers (C.size_t, C.Strings.chars_ptr, Chars_Ptr_Array,
  94                       C.Strings.Null_Ptr);
  95    --  Arrays of C (char *)
  96
  97    type In_Addr is record
  98       S_B1, S_B2, S_B3, S_B4 : C.unsigned_char;
  99    end record;
 100    pragma Convention (C, In_Addr);
 101    --  Internet address
 102
 103    type In_Addr_Access is access all In_Addr;
 104    pragma Convention (C, In_Addr_Access);
 105    --  Access to internet address
 106
 107    Inaddr_Any : aliased constant In_Addr := (others => 0);
 108    --  Any internet address (all the interfaces)
 109
 110    type In_Addr_Access_Array is array (C.size_t range <>)
 111      of aliased In_Addr_Access;
 112    pragma Convention (C, In_Addr_Access_Array);
 113
 114    package In_Addr_Access_Pointers is
 115      new C.Pointers (C.size_t, In_Addr_Access, In_Addr_Access_Array, null);
 116    --  Array of internet addresses
 117
 118    type Sockaddr is record
 119       Sa_Family : C.unsigned_short;
 120       Sa_Data   : C.char_array (1 .. 14);
 121    end record;
 122    pragma Convention (C, Sockaddr);
 123    --  Socket address
 124
 125    type Sockaddr_Access is access all Sockaddr;
 126    pragma Convention (C, Sockaddr_Access);
 127    --  Access to socket address
 128
 129    type Sockaddr_In is record
 130       Sin_Family : C.unsigned_short      := Constants.AF_INET;
 131       Sin_Port   : C.unsigned_short      := 0;
 132       Sin_Addr   : In_Addr               := Inaddr_Any;
 133       Sin_Zero   : C.char_array (1 .. 8) := (others => C.char'Val (0));
 134    end record;
 135    pragma Convention (C, Sockaddr_In);
 136    --  Internet socket address
 137
 138    type Sockaddr_In_Access is access all Sockaddr_In;
 139    pragma Convention (C, Sockaddr_In_Access);
 140    --  Access to internet socket address
 141
 142    procedure Set_Length
 143      (Sin : Sockaddr_In_Access;
 144       Len : C.int);
 145    pragma Inline (Set_Length);
 146    --  Set Sin.Sin_Length to Len.
 147    --  On this platform, nothing is done as there is no such field.
 148
 149    procedure Set_Family
 150      (Sin    : Sockaddr_In_Access;
 151       Family : C.int);
 152    pragma Inline (Set_Family);
 153    --  Set Sin.Sin_Family to Family
 154
 155    procedure Set_Port
 156      (Sin  : Sockaddr_In_Access;
 157       Port : C.unsigned_short);
 158    pragma Inline (Set_Port);
 159    --  Set Sin.Sin_Port to Port
 160
 161    procedure Set_Address
 162      (Sin     : Sockaddr_In_Access;
 163       Address : In_Addr);
 164    pragma Inline (Set_Address);
 165    --  Set Sin.Sin_Addr to Address
 166
 167    type Hostent is record
 168       H_Name      : C.Strings.chars_ptr;
 169       H_Aliases   : Chars_Ptr_Pointers.Pointer;
 170       H_Addrtype  : C.int;
 171       H_Length    : C.int;
 172       H_Addr_List : In_Addr_Access_Pointers.Pointer;
 173    end record;
 174    pragma Convention (C, Hostent);
 175    --  Host entry
 176
 177    type Hostent_Access is access all Hostent;
 178    pragma Convention (C, Hostent_Access);
 179    --  Access to host entry
 180
 181    type Servent is record
 182       S_Name    : C.Strings.chars_ptr;
 183       S_Aliases : Chars_Ptr_Pointers.Pointer;
 184       S_Port    : C.int;
 185       S_Proto   : C.Strings.chars_ptr;
 186    end record;
 187    pragma Convention (C, Servent);
 188    --  Service entry
 189
 190    type Servent_Access is access all Servent;
 191    pragma Convention (C, Servent_Access);
 192    --  Access to service entry
 193
 194    type Two_Int is array (0 .. 1) of C.int;
 195    pragma Convention (C, Two_Int);
 196    --  Used with pipe()
 197
 198    function C_Accept
 199      (S       : C.int;
 200       Addr    : System.Address;
 201       Addrlen : access C.int) return C.int;
 202
 203    function C_Bind
 204      (S       : C.int;
 205       Name    : System.Address;
 206       Namelen : C.int) return C.int;
 207
 208    function C_Close
 209      (Fd : C.int) return C.int;
 210
 211    function C_Connect
 212      (S       : C.int;
 213       Name    : System.Address;
 214       Namelen : C.int) return C.int;
 215
 216    function C_Gethostbyaddr
 217      (Addr : System.Address;
 218       Len  : C.int;
 219       Typ  : C.int) return Hostent_Access;
 220
 221    function C_Gethostbyname
 222      (Name : C.char_array) return Hostent_Access;
 223
 224    function C_Gethostname
 225      (Name    : System.Address;
 226       Namelen : C.int) return C.int;
 227
 228    function C_Getpeername
 229      (S       : C.int;
 230       Name    : System.Address;
 231       Namelen : access C.int) return C.int;
 232
 233    function C_Getservbyname
 234      (Name  : C.char_array;
 235       Proto : C.char_array) return Servent_Access;
 236
 237    function C_Getservbyport
 238      (Port  : C.int;
 239       Proto : C.char_array) return Servent_Access;
 240
 241    function C_Getsockname
 242      (S       : C.int;
 243       Name    : System.Address;
 244       Namelen : access C.int) return C.int;
 245
 246    function C_Getsockopt
 247      (S       : C.int;
 248       Level   : C.int;
 249       Optname : C.int;
 250       Optval  : System.Address;
 251       Optlen  : access C.int) return C.int;
 252
 253    function C_Inet_Addr
 254      (Cp : C.Strings.chars_ptr) return C.int;
 255
 256    function C_Ioctl
 257      (S    : C.int;
 258       Req  : C.int;
 259       Arg  : Int_Access) return C.int;
 260
 261    function C_Listen
 262      (S       : C.int;
 263       Backlog : C.int) return C.int;
 264
 265    function C_Readv
 266      (Fd     : C.int;
 267       Iov    : System.Address;
 268       Iovcnt : C.int) return C.int;
 269
 270    function C_Recv
 271      (S     : C.int;
 272       Msg   : System.Address;
 273       Len   : C.int;
 274       Flags : C.int) return C.int;
 275
 276    function C_Recvfrom
 277      (S       : C.int;
 278       Msg     : System.Address;
 279       Len     : C.int;
 280       Flags   : C.int;
 281       From    : Sockaddr_In_Access;
 282       Fromlen : access C.int) return C.int;
 283
 284    function C_Select
 285      (Nfds      : C.int;
 286       Readfds   : Fd_Set_Access;
 287       Writefds  : Fd_Set_Access;
 288       Exceptfds : Fd_Set_Access;
 289       Timeout   : Timeval_Access) return C.int;
 290
 291    function C_Send
 292      (S     : C.int;
 293       Msg   : System.Address;
 294       Len   : C.int;
 295       Flags : C.int) return C.int;
 296
 297    function C_Sendto
 298      (S     : C.int;
 299       Msg   : System.Address;
 300       Len   : C.int;
 301       Flags : C.int;
 302       To    : Sockaddr_In_Access;
 303       Tolen : C.int) return C.int;
 304
 305    function C_Setsockopt
 306      (S       : C.int;
 307       Level   : C.int;
 308       Optname : C.int;
 309       Optval  : System.Address;
 310       Optlen  : C.int) return C.int;
 311
 312    function C_Shutdown
 313      (S   : C.int;
 314       How : C.int) return C.int;
 315
 316    function C_Socket
 317      (Domain   : C.int;
 318       Typ      : C.int;
 319       Protocol : C.int) return C.int;
 320
 321    function C_Strerror
 322      (Errnum : C.int) return C.Strings.chars_ptr;
 323
 324    function C_System
 325      (Command : System.Address) return C.int;
 326
 327    function C_Writev
 328      (Fd     : C.int;
 329       Iov    : System.Address;
 330       Iovcnt : C.int) return C.int;
 331
 332    procedure Free_Socket_Set
 333      (Set : Fd_Set_Access);
 334    --  Free system-dependent socket set
 335
 336    procedure Get_Socket_From_Set
 337      (Set    : Fd_Set_Access;
 338       Socket : Int_Access;
 339       Last   : Int_Access);
 340    --  Get last socket in Socket and remove it from the socket
 341    --  set. The parameter Last is a maximum value of the largest
 342    --  socket. This hint is used to avoid scanning very large socket
 343    --  sets. After a call to Get_Socket_From_Set, Last is set back to
 344    --  the real largest socket in the socket set.
 345
 346    procedure Insert_Socket_In_Set
 347      (Set    : Fd_Set_Access;
 348       Socket : C.int);
 349    --  Insert socket in the socket set
 350
 351    function  Is_Socket_In_Set
 352      (Set    : Fd_Set_Access;
 353       Socket : C.int) return C.int;
 354    --  Check whether Socket is in the socket set, return a non-zero
 355    --  value if it is, zero if it is not.
 356
 357    procedure Last_Socket_In_Set
 358      (Set    : Fd_Set_Access;
 359       Last   : Int_Access);
 360    --  Find the largest socket in the socket set. This is needed for
 361    --  select(). When Last_Socket_In_Set is called, parameter Last is
 362    --  a maximum value of the largest socket. This hint is used to
 363    --  avoid scanning very large socket sets. After the call, Last is
 364    --  set back to the real largest socket in the socket set.
 365
 366    function  New_Socket_Set
 367      (Set : Fd_Set_Access) return Fd_Set_Access;
 368    --  Allocate a new socket set which is a system-dependent structure
 369    --  and initialize by copying Set if it is non-null, by making it
 370    --  empty otherwise.
 371
 372    procedure Remove_Socket_From_Set
 373      (Set    : Fd_Set_Access;
 374       Socket : C.int);
 375    --  Remove socket from the socket set
 376
 377    procedure Finalize;
 378    procedure Initialize (Process_Blocking_IO : Boolean);
 379
 380 private
 381    pragma Import (C, C_Bind, "bind");
 382    pragma Import (C, C_Close, "close");
 383    pragma Import (C, C_Gethostbyaddr, "gethostbyaddr");
 384    pragma Import (C, C_Gethostbyname, "gethostbyname");
 385    pragma Import (C, C_Gethostname, "gethostname");
 386    pragma Import (C, C_Getpeername, "getpeername");
 387    pragma Import (C, C_Getservbyname, "getservbyname");
 388    pragma Import (C, C_Getservbyport, "getservbyport");
 389    pragma Import (C, C_Getsockname, "getsockname");
 390    pragma Import (C, C_Getsockopt, "getsockopt");
 391    pragma Import (C, C_Inet_Addr, "inet_addr");
 392    pragma Import (C, C_Listen, "listen");
 393    pragma Import (C, C_Readv, "readv");
 394    pragma Import (C, C_Select, "select");
 395    pragma Import (C, C_Setsockopt, "setsockopt");
 396    pragma Import (C, C_Shutdown, "shutdown");
 397    pragma Import (C, C_Strerror, "strerror");
 398    pragma Import (C, C_System, "system");
 399    pragma Import (C, C_Writev, "writev");
 400
 401    pragma Import (C, Free_Socket_Set, "__gnat_free_socket_set");
 402    pragma Import (C, Get_Socket_From_Set, "__gnat_get_socket_from_set");
 403    pragma Import (C, Is_Socket_In_Set, "__gnat_is_socket_in_set");
 404    pragma Import (C, Last_Socket_In_Set, "__gnat_last_socket_in_set");
 405    pragma Import (C, New_Socket_Set, "__gnat_new_socket_set");
 406    pragma Import (C, Insert_Socket_In_Set, "__gnat_insert_socket_in_set");
 407    pragma Import (C, Remove_Socket_From_Set, "__gnat_remove_socket_from_set");
 408 end GNAT.Sockets.Thin;