src/include/gnunet_network_lib.h

   1 /*
   2      This file is part of GNUnet.
   3      (C) 2009 Christian Grothoff (and other contributing authors)
   4
   5      GNUnet is free software; you can redistribute it and/or modify
   6      it under the terms of the GNU General Public License as published
   7      by the Free Software Foundation; either version 2, or (at your
   8      option) any later version.
   9
  10      GNUnet is distributed in the hope that it will be useful, but
  11      WITHOUT ANY WARRANTY; without even the implied warranty of
  12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13      General Public License for more details.
  14
  15      You should have received a copy of the GNU General Public License
  16      along with GNUnet; see the file COPYING.  If not, write to the
  17      Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18      Boston, MA 02111-1307, USA.
  19 */
  20
  21 /**
  22  * @file include/gnunet_network_lib.h
  23  * @brief basic low-level networking interface
  24  * @author Nils Durner
  25  */
  26
  27 #ifndef GNUNET_NETWORK_LIB_H
  28 #define GNUNET_NETWORK_LIB_H
  29
  30 #ifdef __cplusplus
  31 extern "C"
  32 {
  33 #if 0                           /* keep Emacsens' auto-indent happy */
  34 }
  35 #endif
  36 #endif
  37
  38
  39 /**
  40  * @brief handle to a socket
  41  */
  42 struct GNUNET_NETWORK_Handle;
  43
  44
  45 /**
  46  * @brief collection of IO descriptors
  47  */
  48 struct GNUNET_NETWORK_FDSet
  49 {
  50
  51   /**
  52    * Maximum number of any socket socket descriptor in the set (plus one)
  53    */
  54   int nsds;
  55
  56   /**
  57    * Bitset with the descriptors.
  58    */
  59   fd_set sds;
  60
  61 #ifdef WINDOWS
  62   /**
  63    * Linked list of handles
  64    */
  65   struct GNUNET_CONTAINER_SList *handles;
  66 #endif
  67
  68 };
  69
  70
  71
  72 #include "gnunet_disk_lib.h"
  73 #include "gnunet_time_lib.h"
  74
  75
  76 /**
  77  * Accept a new connection on a socket.  Configure it for non-blocking
  78  * IO and mark it as non-inheritable to child processes (set the
  79  * close-on-exec flag).
  80  *
  81  * @param desc bound socket
  82  * @param address address of the connecting peer, may be NULL
  83  * @param address_len length of address
  84  * @return client socket
  85  */
  86 struct GNUNET_NETWORK_Handle *GNUNET_NETWORK_socket_accept (const struct
  87                                                             GNUNET_NETWORK_Handle
  88                                                             *desc,
  89                                                             struct sockaddr
  90                                                             *address,
  91                                                             socklen_t *
  92                                                             address_len);
  93
  94
  95 /**
  96  * Box a native socket (and check that it is a socket).
  97  *
  98  * @param fd socket to box
  99  * @return NULL on error (including not supported on target platform)
 100  */
 101 struct GNUNET_NETWORK_Handle *GNUNET_NETWORK_socket_box_native (int fd);
 102
 103
 104 /**
 105  * Bind to a connected socket
 106  *
 107  * @param desc socket to bind
 108  * @param address address to be bound
 109  * @param address_len length of address
 110  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 111  */
 112 int GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
 113                                 const struct sockaddr *address,
 114                                 socklen_t address_len);
 115
 116 /**
 117  * Close a socket.
 118  *
 119  * @param desc socket to close
 120  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 121  */
 122 int GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc);
 123
 124
 125 /**
 126  * Connect a socket
 127  *
 128  * @param desc socket to connect
 129  * @param address peer address
 130  * @param address_len of address
 131  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 132  */
 133 int GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
 134                                    const struct sockaddr *address,
 135                                    socklen_t address_len);
 136
 137
 138 /**
 139  * Get socket options
 140  *
 141  * @param desc socket to inspect
 142  * @param level protocol level of the option
 143  * @param optname identifier of the option
 144  * @param optval options
 145  * @param optlen length of optval
 146  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 147  */
 148 int GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
 149                                       int level, int optname, void *optval,
 150                                       socklen_t * optlen);
 151
 152
 153 /**
 154  * Listen on a socket
 155  *
 156  * @param desc socket to start listening on
 157  * @param backlog length of the listen queue
 158  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 159  */
 160 int GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
 161                                   int backlog);
 162
 163
 164 /**
 165  * How much data is available to be read on this descriptor?
 166  * @param desc socket
 167  */
 168 ssize_t GNUNET_NETWORK_socket_recvfrom_amount (const struct
 169                                                GNUNET_NETWORK_Handle *desc);
 170
 171
 172 /**
 173  * Read data from a connected socket (always non-blocking).
 174  * @param desc socket
 175  * @param buffer buffer
 176  * @param length length of buffer
 177  * @param src_addr either the source to recv from, or all zeroes
 178  *        to be filled in by recvfrom
 179  * @param addrlen length of the addr
 180  */
 181 ssize_t               GNUNET_NETWORK_socket_recvfrom (const struct
 182                                                       GNUNET_NETWORK_Handle
 183                                                       *desc, void *buffer,
 184                                                       size_t length,
 185                                                       struct sockaddr *src_addr,
 186                                                       socklen_t * addrlen);
 187
 188
 189 /**
 190  * Read data from a connected socket (always non-blocking).
 191  *
 192  * @param desc socket
 193  * @param buffer buffer
 194  * @param length length of buffer
 195  * @return number of bytes read
 196  */
 197 ssize_t GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
 198                                     void *buffer, size_t length);
 199
 200
 201 /**
 202  * Check if sockets meet certain conditions
 203  * @param rfds set of sockets to be checked for readability
 204  * @param wfds set of sockets to be checked for writability
 205  * @param efds set of sockets to be checked for exceptions
 206  * @param timeout relative value when to return
 207  * @return number of selected sockets, GNUNET_SYSERR on error
 208  */
 209 int GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
 210                                   struct GNUNET_NETWORK_FDSet *wfds,
 211                                   struct GNUNET_NETWORK_FDSet *efds,
 212                                   struct GNUNET_TIME_Relative timeout);
 213
 214
 215 /**
 216  * Send data (always non-blocking).
 217  *
 218  * @param desc socket
 219  * @param buffer data to send
 220  * @param length size of the buffer
 221  * @return number of bytes sent, GNUNET_SYSERR on error
 222  */
 223 ssize_t GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
 224                                     const void *buffer, size_t length);
 225
 226
 227 /**
 228  * Send data to a particular destination (always non-blocking).
 229  * This function only works for UDP sockets.
 230  *
 231  * @param desc socket
 232  * @param message data to send
 233  * @param length size of the data
 234  * @param dest_addr destination address
 235  * @param dest_len length of address
 236  * @return number of bytes sent, GNUNET_SYSERR on error
 237  */
 238 ssize_t GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc,
 239                                       const void *message, size_t length,
 240                                       const struct sockaddr *dest_addr,
 241                                       socklen_t dest_len);
 242
 243
 244 /**
 245  * Set socket option
 246  *
 247  * @param fd socket
 248  * @param level protocol level of the option
 249  * @param option_name option identifier
 250  * @param option_value value to set
 251  * @param option_len size of option_value
 252  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 253  */
 254 int GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
 255                                       int level, int option_name,
 256                                       const void *option_value,
 257                                       socklen_t option_len);
 258
 259
 260 /**
 261  * Shut down socket operations
 262  *
 263  * @param desc socket
 264  * @param how type of shutdown
 265  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 266  */
 267 int GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
 268                                     int how);
 269
 270
 271 /**
 272  * Disable the "CORK" feature for communication with the given socket,
 273  * forcing the OS to immediately flush the buffer on transmission
 274  * instead of potentially buffering multiple messages.  Essentially
 275  * reduces the OS send buffers to zero.
 276  *
 277  * @param desc socket
 278  * @return GNUNET_OK on success, GNUNET_SYSERR otherwise
 279  */
 280 int GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc);
 281
 282
 283 /**
 284  * Create a new socket.   Configure it for non-blocking IO and
 285  * mark it as non-inheritable to child processes (set the
 286  * close-on-exec flag).
 287  *
 288  * @param domain domain of the socket
 289  * @param type socket type
 290  * @param protocol network protocol
 291  * @return new socket, NULL on error
 292  */
 293 struct GNUNET_NETWORK_Handle *GNUNET_NETWORK_socket_create (int domain,
 294                                                             int type,
 295                                                             int protocol);
 296
 297
 298 /**
 299  * Reset FD set (clears all file descriptors).
 300  *
 301  * @param fds fd set to clear
 302  */
 303 void GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds);
 304
 305
 306 /**
 307  * Add a socket to the FD set
 308  * @param fds fd set
 309  * @param desc socket to add
 310  */
 311 void GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
 312                                const struct GNUNET_NETWORK_Handle *desc);
 313
 314
 315 #ifdef __MINGW32__
 316 /* TODO: maybe #ifdef WINDOWS? -ndurner */
 317 /**
 318  * Add a W32 file handle to the fd set
 319  * @param fds fd set
 320  * @param h the file handle to add
 321  */
 322 void GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct
 323                                                         GNUNET_NETWORK_FDSet
 324                                                         *fds, HANDLE h);
 325 #endif
 326
 327
 328 /**
 329  * Check whether a socket is part of the fd set
 330  * @param fds fd set
 331  * @param desc socket
 332  * @return GNUNET_YES if the socket is in the set
 333  */
 334 int GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
 335                                 const struct GNUNET_NETWORK_Handle *desc);
 336
 337
 338 /**
 339  * Add one fd set to another
 340  * @param dst the fd set to add to
 341  * @param src the fd set to add from
 342  */
 343 void GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
 344                                const struct GNUNET_NETWORK_FDSet *src);
 345
 346
 347 /**
 348  * Copy one fd set to another
 349  * @param to destination
 350  * @param from source
 351  */
 352 void GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
 353                                 const struct GNUNET_NETWORK_FDSet *from);
 354
 355
 356 /**
 357  * Return file descriptor for this network handle
 358  *
 359  * @param desc wrapper to process
 360  * @return POSIX file descriptor
 361  */
 362 int GNUNET_NETWORK_get_fd (struct GNUNET_NETWORK_Handle *desc);
 363
 364
 365 /**
 366  * Copy a native fd set
 367  * @param to destination
 368  * @param from native source set
 369  * @param nfds the biggest socket number in from + 1
 370  */
 371 void GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
 372                                        const fd_set * from, int nfds);
 373
 374
 375 /**
 376  * Set a native fd in a set
 377  *
 378  * @param to destination
 379  * @param nfd native FD to set
 380  */
 381 void GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd);
 382
 383
 384 /**
 385  * Test native fd in a set
 386  *
 387  * @param to set to test, NULL for empty set
 388  * @param nfd native FD to test, -1 for none
 389  * @return GNUNET_YES if to contains nfd
 390  */
 391 int GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
 392                                       int nfd);
 393
 394
 395 /**
 396  * Add a file handle to the fd set
 397  * @param fds fd set
 398  * @param h the file handle to add
 399  */
 400 void GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
 401                                       const struct GNUNET_DISK_FileHandle *h);
 402
 403
 404 /**
 405  * Check if a file handle is part of an fd set
 406  * @param fds fd set
 407  * @param h file handle
 408  * @return GNUNET_YES if the file handle is part of the set
 409  */
 410 int GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
 411                                        const struct GNUNET_DISK_FileHandle *h);
 412
 413
 414 /**
 415  * Checks if two fd sets overlap
 416  * @param fds1 first fd set
 417  * @param fds2 second fd set
 418  * @return GNUNET_YES if they do overlap, GNUNET_NO otherwise
 419  */
 420 int GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
 421                                   const struct GNUNET_NETWORK_FDSet *fds2);
 422
 423
 424 /**
 425  * Creates an fd set
 426  * @return a new fd set
 427  */
 428 struct GNUNET_NETWORK_FDSet *GNUNET_NETWORK_fdset_create (void);
 429
 430
 431 /**
 432  * Releases the associated memory of an fd set
 433  * @param fds fd set
 434  */
 435 void GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds);
 436
 437
 438 #if 0                           /* keep Emacsens' auto-indent happy */
 439 {
 440 #endif
 441 #ifdef __cplusplus
 442 }
 443 #endif
 444
 445 #endif /* GNUNET_NETWORK_LIB_H */