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-2009, AdaCore                     --
  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,  51  Franklin  Street,  Fifth  Floor, --
  20 -- Boston, MA 02110-1301, 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.Strings;
  41
  42 with GNAT.OS_Lib;
  43 with GNAT.Sockets.Thin_Common;
  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    use Thin_Common;
  54
  55    package C renames Interfaces.C;
  56
  57    use type C.size_t;
  58    type ssize_t is range -(2 ** (C.size_t'Size - 1))
  59      .. +(2 ** (C.size_t'Size - 1) - 1);
  60    --  Signed type of the same size as size_t
  61
  62    function Socket_Errno return Integer renames GNAT.OS_Lib.Errno;
  63    --  Returns last socket error number
  64
  65    function Socket_Error_Message (Errno : Integer) return C.Strings.chars_ptr;
  66    --  Returns the error message string for the error number Errno. If Errno is
  67    --  not known, returns "Unknown system error".
  68
  69    function Host_Errno return Integer;
  70    pragma Import (C, Host_Errno, "__gnat_get_h_errno");
  71    --  Returns last host error number
  72
  73    package Host_Error_Messages is
  74
  75       function Host_Error_Message
  76         (H_Errno : Integer) return C.Strings.chars_ptr;
  77       --  Returns the error message string for the host error number H_Errno.
  78       --  If H_Errno is not known, returns "Unknown system error".
  79
  80    end Host_Error_Messages;
  81
  82    --------------------------------
  83    -- Standard library functions --
  84    --------------------------------
  85
  86    function C_Accept
  87      (S       : C.int;
  88       Addr    : System.Address;
  89       Addrlen : not null access C.int) return C.int;
  90
  91    function C_Bind
  92      (S       : C.int;
  93       Name    : System.Address;
  94       Namelen : C.int) return C.int;
  95
  96    function C_Close
  97      (Fd : C.int) return C.int;
  98
  99    function C_Connect
 100      (S       : C.int;
 101       Name    : System.Address;
 102       Namelen : C.int) return C.int;
 103
 104    function C_Gethostname
 105      (Name    : System.Address;
 106       Namelen : C.int) return C.int;
 107
 108    function C_Getpeername
 109      (S       : C.int;
 110       Name    : System.Address;
 111       Namelen : not null access C.int) return C.int;
 112
 113    function C_Getsockname
 114      (S       : C.int;
 115       Name    : System.Address;
 116       Namelen : not null access C.int) return C.int;
 117
 118    function C_Getsockopt
 119      (S       : C.int;
 120       Level   : C.int;
 121       Optname : C.int;
 122       Optval  : System.Address;
 123       Optlen  : not null access C.int) return C.int;
 124
 125    function Socket_Ioctl
 126      (S   : C.int;
 127       Req : C.int;
 128       Arg : access C.int) return C.int;
 129
 130    function C_Listen
 131      (S       : C.int;
 132       Backlog : C.int) return C.int;
 133
 134    function C_Recv
 135      (S     : C.int;
 136       Msg   : System.Address;
 137       Len   : C.int;
 138       Flags : C.int) return C.int;
 139
 140    function C_Recvfrom
 141      (S       : C.int;
 142       Msg     : System.Address;
 143       Len     : C.int;
 144       Flags   : C.int;
 145       From    : System.Address;
 146       Fromlen : not null access C.int) return C.int;
 147
 148    function C_Recvmsg
 149      (S     : C.int;
 150       Msg   : System.Address;
 151       Flags : C.int) return ssize_t;
 152
 153    function C_Select
 154      (Nfds      : C.int;
 155       Readfds   : access Fd_Set;
 156       Writefds  : access Fd_Set;
 157       Exceptfds : access Fd_Set;
 158       Timeout   : Timeval_Access) return C.int;
 159
 160    function C_Sendmsg
 161      (S     : C.int;
 162       Msg   : System.Address;
 163       Flags : C.int) return ssize_t;
 164
 165    function C_Sendto
 166      (S     : C.int;
 167       Msg   : System.Address;
 168       Len   : C.int;
 169       Flags : C.int;
 170       To    : System.Address;
 171       Tolen : C.int) return C.int;
 172
 173    function C_Setsockopt
 174      (S       : C.int;
 175       Level   : C.int;
 176       Optname : C.int;
 177       Optval  : System.Address;
 178       Optlen  : C.int) return C.int;
 179
 180    function C_Shutdown
 181      (S   : C.int;
 182       How : C.int) return C.int;
 183
 184    function C_Socket
 185      (Domain   : C.int;
 186       Typ      : C.int;
 187       Protocol : C.int) return C.int;
 188
 189    function C_Strerror
 190      (Errnum : C.int) return C.Strings.chars_ptr;
 191
 192    function C_System
 193      (Command : System.Address) return C.int;
 194
 195    -------------------------------------------------------
 196    -- Signalling file descriptors for selector abortion --
 197    -------------------------------------------------------
 198
 199    package Signalling_Fds is
 200
 201       function Create (Fds : not null access Fd_Pair) return C.int;
 202       pragma Convention (C, Create);
 203       --  Create a pair of connected descriptors suitable for use with C_Select
 204       --  (used for signalling in Selector objects).
 205
 206       function Read (Rsig : C.int) return C.int;
 207       pragma Convention (C, Read);
 208       --  Read one byte of data from rsig, the read end of a pair of signalling
 209       --  fds created by Create_Signalling_Fds.
 210
 211       function Write (Wsig : C.int) return C.int;
 212       pragma Convention (C, Write);
 213       --  Write one byte of data to wsig, the write end of a pair of signalling
 214       --  fds created by Create_Signalling_Fds.
 215
 216       procedure Close (Sig : C.int);
 217       pragma Convention (C, Close);
 218       --  Close one end of a pair of signalling fds (ignoring any error)
 219
 220    end Signalling_Fds;
 221
 222    -------------------------------------------
 223    -- Nonreentrant network databases access --
 224    -------------------------------------------
 225
 226    --  The following are used only on systems that have nonreentrant
 227    --  getXXXbyYYY functions, and do NOT have corresponding getXXXbyYYY_
 228    --  functions. Currently, LynxOS is the only such system.
 229
 230    function Nonreentrant_Gethostbyname
 231      (Name : C.char_array) return Hostent_Access;
 232
 233    function Nonreentrant_Gethostbyaddr
 234      (Addr      : System.Address;
 235       Addr_Len  : C.int;
 236       Addr_Type : C.int) return Hostent_Access;
 237
 238    function Nonreentrant_Getservbyname
 239      (Name  : C.char_array;
 240       Proto : C.char_array) return Servent_Access;
 241
 242    function Nonreentrant_Getservbyport
 243      (Port  : C.int;
 244       Proto : C.char_array) return Servent_Access;
 245
 246    procedure Initialize;
 247    procedure Finalize;
 248
 249 private
 250    pragma Import (C, C_Bind, "bind");
 251    pragma Import (C, C_Close, "close");
 252    pragma Import (C, C_Gethostname, "gethostname");
 253    pragma Import (C, C_Getpeername, "getpeername");
 254    pragma Import (C, C_Getsockname, "getsockname");
 255    pragma Import (C, C_Getsockopt, "getsockopt");
 256    pragma Import (C, C_Listen, "listen");
 257    pragma Import (C, C_Select, "select");
 258    pragma Import (C, C_Setsockopt, "setsockopt");
 259    pragma Import (C, C_Shutdown, "shutdown");
 260    pragma Import (C, C_Strerror, "strerror");
 261    pragma Import (C, C_System, "system");
 262
 263    pragma Import (C, Nonreentrant_Gethostbyname, "gethostbyname");
 264    pragma Import (C, Nonreentrant_Gethostbyaddr, "gethostbyaddr");
 265    pragma Import (C, Nonreentrant_Getservbyname, "getservbyname");
 266    pragma Import (C, Nonreentrant_Getservbyport, "getservbyport");
 267
 268 end GNAT.Sockets.Thin;