X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_network_lib.h;h=6c02f3577193f5ef54a2edef33b1f7317fe9f04d;hb=2bbb2934dbbe471640c67c3bc672120f35708fd1;hp=26a39d575db65cb6ec1d7d8a495f32537dbc5e77;hpb=70e6847205a9f9b9b660be2a173d5bc309eaa58d;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_network_lib.h b/src/include/gnunet_network_lib.h index 26a39d575..6c02f3577 100644 --- a/src/include/gnunet_network_lib.h +++ b/src/include/gnunet_network_lib.h @@ -1,27 +1,32 @@ /* This file is part of GNUnet. - (C) 2009 Christian Grothoff (and other contributing authors) + Copyright (C) 2009-2013 GNUnet e.V. - GNUnet is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published - by the Free Software Foundation; either version 2, or (at your - option) any later version. + GNUnet is free software: you can redistribute it and/or modify it + under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. GNUnet is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - General Public License for more details. + Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . - You should have received a copy of the GNU General Public License - along with GNUnet; see the file COPYING. If not, write to the - Free Software Foundation, Inc., 59 Temple Place - Suite 330, - Boston, MA 02111-1307, USA. + SPDX-License-Identifier: AGPL3.0-or-later */ /** - * @file include/gnunet_network_lib.h - * @brief basic, low-level TCP networking interface - * @author Christian Grothoff + * @author Nils Durner + * + * @file + * Basic low-level networking interface + * + * @defgroup network Network library + * Basic low-level networking interface + * @{ */ #ifndef GNUNET_NETWORK_LIB_H #define GNUNET_NETWORK_LIB_H @@ -34,266 +39,566 @@ extern "C" #endif #endif -#include "gnunet_scheduler_lib.h" + +/** + * @brief handle to a socket + */ +struct GNUNET_NETWORK_Handle; + + +/** + * @brief collection of IO descriptors + */ +struct GNUNET_NETWORK_FDSet +{ + + /** + * Maximum number of any socket descriptor in the set (plus one) + */ + int nsds; + + /** + * Bitset with the descriptors. + */ + fd_set sds; + +#ifdef WINDOWS + /** + * Array of file handles (from pipes) that are also in + * the FDSet. Needed as those cannot go into @e sds + * on W32. + */ + const struct GNUNET_DISK_FileHandle **handles; + + /** + * Size of the @e handles array + */ + unsigned int handles_size; + + /** + * Number of @e handles slots in use. Always + * smaller than @e handles_size. + */ + unsigned int handles_pos; + +#endif + +}; + +#include "gnunet_disk_lib.h" #include "gnunet_time_lib.h" /** - * Timeout we use on TCP connect before trying another - * result from the DNS resolver. 5s. + * Test if the given protocol family is supported by this system. + * + * @param pf protocol family to test (PF_INET, PF_INET6, PF_UNIX) + * @return #GNUNET_OK if the PF is supported + */ +int +GNUNET_NETWORK_test_pf (int pf); + + +/** + * Given a unixpath that is too long (larger than UNIX_PATH_MAX), + * shorten it to an acceptable length while keeping it unique + * and making sure it remains a valid filename (if possible). + * + * @param unixpath long path, will be freed (or same pointer returned + * with moved 0-termination). + * @return shortened unixpath, NULL on error + */ +char * +GNUNET_NETWORK_shorten_unixpath (char *unixpath); + + +#ifndef WINDOWS +/** + * If services crash, they can leave a unix domain socket file on the + * disk. This needs to be manually removed, because otherwise both + * bind() and connect() for the respective address will fail. In this + * function, we test if such a left-over file exists, and if so, + * remove it (unless there is a listening service at the address). + * + * @param un unix domain socket address to check + */ +void +GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un); +#endif + + +/** + * Accept a new connection on a socket. Configure it for non-blocking + * IO and mark it as non-inheritable to child processes (set the + * close-on-exec flag). + * + * @param desc bound socket + * @param address address of the connecting peer, may be NULL + * @param address_len length of address + * @return client socket + */ +struct GNUNET_NETWORK_Handle * +GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc, + struct sockaddr *address, + socklen_t *address_len); + + +/** + * Box a native socket (and check that it is a socket). + * + * @param fd socket to box + * @return NULL on error (including not supported on target platform) */ -#define GNUNET_NETWORK_CONNECT_RETRY_TIMEOUT GNUNET_TIME_relative_multiply (GNUNET_TIME_UNIT_SECONDS, 5) +struct GNUNET_NETWORK_Handle * +GNUNET_NETWORK_socket_box_native (SOCKTYPE fd); + /** - * @brief handle for a network socket + * Set if a socket should use blocking or non-blocking IO. + * + * @param fd socket + * @param doBlock blocking mode + * @return #GNUNET_OK on success, #GNUNET_SYSERR on error */ -struct GNUNET_NETWORK_SocketHandle; +int +GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, + int doBlock); + +/** + * Bind a socket to a particular address. + * + * @param desc socket to bind + * @param address address to be bound + * @param address_len length of @a address + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise + */ +int +GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc, + const struct sockaddr *address, + socklen_t address_len); /** - * Function to call for access control checks. + * Close a socket. * - * @param cls closure - * @param addr address - * @param addrlen length of address - * @return GNUNET_YES to allow, GNUNET_NO to deny, GNUNET_SYSERR - * for unknown address family (will be denied). + * @param desc socket to close + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -typedef int (*GNUNET_NETWORK_AccessCheck) (void *cls, - const struct sockaddr * addr, - socklen_t addrlen); +int +GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc); /** - * Callback function for data received from the network. Note that - * both "available" and "err" would be 0 if the read simply timed out. + * Only free memory of a socket, keep the file descriptor untouched. * - * @param cls closure - * @param buf pointer to received data - * @param available number of bytes availabe in "buf", - * possibly 0 (on errors) - * @param addr address of the sender - * @param addrlen size of addr - * @param errCode value of errno (on errors receiving) + * @param desc socket */ -typedef void (*GNUNET_NETWORK_Receiver) (void *cls, - const void *buf, - size_t available, - const struct sockaddr * addr, - socklen_t addrlen, int errCode); +void +GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc); /** - * Create a socket handle by boxing an existing OS socket. The OS - * socket should henceforth be no longer used directly. - * GNUNET_socket_destroy will close it. + * Connect a socket to some remote address. * - * @param sched scheduler to use - * @param osSocket existing socket to box - * @param maxbuf maximum write buffer size for the socket (use - * 0 for sockets that need no write buffers, such as listen sockets) - * @return the boxed socket handle + * @param desc socket to connect + * @param address peer address + * @param address_len of @a address + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -struct GNUNET_NETWORK_SocketHandle - *GNUNET_NETWORK_socket_create_from_existing (struct GNUNET_SCHEDULER_Handle - *sched, int osSocket, - size_t maxbuf); +int +GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc, + const struct sockaddr *address, + socklen_t address_len); /** - * Create a socket handle by accepting on a listen socket. This - * function may block if the listen socket has no connection ready. + * Get socket options * - * @param sched scheduler to use - * @param access function to use to check if access is allowed - * @param access_cls closure for access - * @param lsock listen socket - * @param maxbuf maximum write buffer size for the socket (use - * 0 for sockets that need no write buffers, such as listen sockets) - * @return the socket handle, NULL on error (for example, access refused) + * @param desc socket to inspect + * @param level protocol level of the option + * @param optname identifier of the option + * @param optval options + * @param optlen length of optval + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -struct GNUNET_NETWORK_SocketHandle - *GNUNET_NETWORK_socket_create_from_accept (struct GNUNET_SCHEDULER_Handle - *sched, - GNUNET_NETWORK_AccessCheck - access, void *access_cls, - int lsock, size_t maxbuf); +int +GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc, + int level, + int optname, + void *optval, + socklen_t *optlen); /** - * Create a socket handle by (asynchronously) connecting to a host. - * This function returns immediately, even if the connection has not - * yet been established. This function only creates TCP connections. + * Listen on a socket * - * @param sched scheduler to use - * @param hostname name of the host to connect to - * @param port port to connect to - * @param maxbuf maximum write buffer size for the socket (use - * 0 for sockets that need no write buffers, such as listen sockets) - * @return the socket handle + * @param desc socket to start listening on + * @param backlog length of the listen queue + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -struct GNUNET_NETWORK_SocketHandle - *GNUNET_NETWORK_socket_create_from_connect (struct GNUNET_SCHEDULER_Handle - *sched, const char *hostname, - uint16_t port, size_t maxbuf); +int +GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc, + int backlog); +/** + * How much data is available to be read on this descriptor? + * + * @param desc socket + * @returns #GNUNET_SYSERR if no data is available, or on error! + */ +ssize_t +GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc); + /** - * Create a socket handle by (asynchronously) connecting to a host. - * This function returns immediately, even if the connection has not - * yet been established. This function only creates TCP connections. + * Read data from a socket (always non-blocking). * - * @param sched scheduler to use - * @param af_family address family to use - * @param serv_addr server address - * @param addrlen length of server address - * @param maxbuf maximum write buffer size for the socket (use - * 0 for sockets that need no write buffers, such as listen sockets) - * @return the socket handle + * @param desc socket + * @param buffer buffer + * @param length length of buffer + * @param src_addr either the source to recv from, or all zeroes + * to be filled in by recvfrom + * @param addrlen length of the addr */ -struct GNUNET_NETWORK_SocketHandle - *GNUNET_NETWORK_socket_create_from_sockaddr (struct GNUNET_SCHEDULER_Handle - *sched, int af_family, - const struct sockaddr - *serv_addr, socklen_t addrlen, - size_t maxbuf); +ssize_t +GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc, + void *buffer, + size_t length, + struct sockaddr *src_addr, + socklen_t *addrlen); + /** - * Check if socket is valid (no fatal errors have happened so far). - * Note that a socket that is still trying to connect is considered - * valid. + * Read data from a connected socket (always non-blocking). * - * @param sock socket to check - * @return GNUNET_YES if valid, GNUNET_NO otherwise + * @param desc socket + * @param buffer buffer + * @param length length of buffer + * @return number of bytes read */ -int GNUNET_NETWORK_socket_check (struct GNUNET_NETWORK_SocketHandle *sock); +ssize_t +GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, + void *buffer, + size_t length); /** - * Obtain the network address of the other party. + * Check if sockets meet certain conditions. * - * @param sock the client to get the address for - * @param addr where to store the address - * @param addrlen where to store the length of the address - * @return GNUNET_OK on success + * @param rfds set of sockets to be checked for readability + * @param wfds set of sockets to be checked for writability + * @param efds set of sockets to be checked for exceptions + * @param timeout relative value when to return + * @return number of selected sockets, #GNUNET_SYSERR on error */ -int GNUNET_NETWORK_socket_get_address (struct GNUNET_NETWORK_SocketHandle - *sock, void **addr, size_t * addrlen); +int +GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds, + struct GNUNET_NETWORK_FDSet *wfds, + struct GNUNET_NETWORK_FDSet *efds, + struct GNUNET_TIME_Relative timeout); + /** - * Close the socket and free associated resources. Pending - * transmissions are simply dropped. A pending receive call will be - * called with an error code of "EPIPE". + * Send data (always non-blocking). * - * @param sock socket to destroy + * @param desc socket + * @param buffer data to send + * @param length size of the buffer + * @return number of bytes sent, #GNUNET_SYSERR on error */ -void GNUNET_NETWORK_socket_destroy (struct GNUNET_NETWORK_SocketHandle *sock); +ssize_t +GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, + const void *buffer, + size_t length); /** - * Receive data from the given socket. Note that this function will - * call "receiver" asynchronously using the scheduler. It will - * "immediately" return. Note that there MUST only be one active - * receive call per socket at any given point in time (so do not - * call receive again until the receiver callback has been invoked). + * Send data to a particular destination (always non-blocking). + * This function only works for UDP sockets. * - * @param sock socket handle - * @param max maximum number of bytes to read - * @param timeout maximum amount of time to wait - * @param receiver function to call with received data - * @param receiver_cls closure for receiver - * @return scheduler task ID used for receiving, GNUNET_SCHEDULER_NO_TASK on error + * @param desc socket + * @param message data to send + * @param length size of the data in @a message + * @param dest_addr destination address + * @param dest_len length of @a dest_addr + * @return number of bytes sent, #GNUNET_SYSERR on error */ -GNUNET_SCHEDULER_TaskIdentifier -GNUNET_NETWORK_receive (struct GNUNET_NETWORK_SocketHandle *sock, - size_t max, - struct GNUNET_TIME_Relative timeout, - GNUNET_NETWORK_Receiver receiver, void *receiver_cls); +ssize_t +GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc, + const void *message, + size_t length, + const struct sockaddr *dest_addr, + socklen_t dest_len); /** - * Cancel receive job on the given socket. Note that the - * receiver callback must not have been called yet in order - * for the cancellation to be valid. + * Set socket option * - * @param sock socket handle - * @param task task identifier returned from the receive call - * @return closure of the original receiver callback + * @param fd socket + * @param level protocol level of the option + * @param option_name option identifier + * @param option_value value to set + * @param option_len size of @a option_value + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -void *GNUNET_NETWORK_receive_cancel (struct GNUNET_NETWORK_SocketHandle *sock, - GNUNET_SCHEDULER_TaskIdentifier task); +int +GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, + int level, + int option_name, + const void *option_value, + socklen_t option_len); /** - * Function called to notify a client about the socket - * begin ready to queue more data. "buf" will be - * NULL and "size" zero if the socket was closed for - * writing in the meantime. + * Shut down socket operations * - * @param cls closure - * @param size number of bytes available in buf - * @param buf where the callee should write the message - * @return number of bytes written to buf + * @param desc socket + * @param how type of shutdown + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -typedef size_t (*GNUNET_NETWORK_TransmitReadyNotify) (void *cls, - size_t size, void *buf); +int +GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, + int how); /** - * Opaque handle that can be used to cancel - * a transmit-ready notification. + * Disable the "CORK" feature for communication with the given socket, + * forcing the OS to immediately flush the buffer on transmission + * instead of potentially buffering multiple messages. Essentially + * reduces the OS send buffers to zero. + * + * @param desc socket + * @return #GNUNET_OK on success, #GNUNET_SYSERR otherwise */ -struct GNUNET_NETWORK_TransmitHandle; +int +GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc); + /** - * Ask the socket to call us once the specified number of bytes - * are free in the transmission buffer. May call the notify - * method immediately if enough space is available. Note that - * this function will abort if "size" is greater than - * "maxbuf" (as specified when the socket handle was created). + * Create a new socket. Configure it for non-blocking IO and + * mark it as non-inheritable to child processes (set the + * close-on-exec flag). * - * Note that "notify" will be called either when enough - * buffer space is available OR when the socket is destroyed. - * The size parameter given to notify is guaranteed to be - * larger or equal to size if the buffer is ready, or zero - * if the socket was destroyed (or at least closed for - * writing). Finally, any time before 'notify' is called, a - * client may call "notify_transmit_ready_cancel" to cancel - * the transmission request. + * @param domain domain of the socket + * @param type socket type + * @param protocol network protocol + * @return new socket, NULL on error + */ +struct GNUNET_NETWORK_Handle * +GNUNET_NETWORK_socket_create (int domain, + int type, + int protocol); + + +/** + * Reset FD set (clears all file descriptors). * - * Only one transmission request can be scheduled at the same - * time. Notify will be run with the same scheduler priority - * as that of the caller. + * @param fds fd set to clear + */ +void +GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds); + + +/** + * Add a socket to the FD set * - * @param sock socket - * @param size number of bytes to send - * @param timeout after how long should we give up (and call - * notify with buf NULL and size 0)? - * @param notify function to call when buffer space is available - * @param notify_cls closure for notify - * @return non-NULL if the notify callback was queued, - * NULL if we are already going to notify someone else (busy) + * @param fds fd set + * @param desc socket to add */ -struct GNUNET_NETWORK_TransmitHandle - *GNUNET_NETWORK_notify_transmit_ready (struct GNUNET_NETWORK_SocketHandle - *sock, size_t size, - struct GNUNET_TIME_Relative timeout, - GNUNET_NETWORK_TransmitReadyNotify - notify, void *notify_cls); +void +GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_NETWORK_Handle *desc); +#if WINDOWS /** - * Cancel the specified transmission-ready - * notification. + * Add a W32 file handle to the fd set * - * @param h handle for notification to cancel + * @param fds fd set + * @param h the file handle to add */ void -GNUNET_NETWORK_notify_transmit_ready_cancel (struct - GNUNET_NETWORK_TransmitHandle - *h); +GNUNET_NETWORK_fdset_handle_set_native_w32_handle (struct GNUNET_NETWORK_FDSet *fds, + HANDLE h); +#endif +/** + * Check whether a socket is part of the fd set + * + * @param fds fd set + * @param desc socket + * @return #GNUNET_YES if the socket is in the set + */ +int +GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_NETWORK_Handle *desc); + + +/** + * Add one fd set to another (computes the union). + * + * @param dst the fd set to add to + * @param src the fd set to add from + */ +void +GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst, + const struct GNUNET_NETWORK_FDSet *src); + + +/** + * Copy one fd set to another + * + * @param to destination + * @param from source + */ +void +GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to, + const struct GNUNET_NETWORK_FDSet *from); + + +/** + * Return file descriptor for this network handle + * + * @param desc wrapper to process + * @return POSIX file descriptor + */ +int +GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc); + + +/** + * Return the sockaddr for this network handle + * + * @param desc wrapper to process + * @return POSIX file descriptor + */ +struct sockaddr* +GNUNET_NETWORK_get_addr (const struct GNUNET_NETWORK_Handle *desc); + + +/** + * Return sockaddr length for this network handle + * + * @param desc wrapper to process + * @return socklen_t for sockaddr + */ +socklen_t +GNUNET_NETWORK_get_addrlen (const struct GNUNET_NETWORK_Handle *desc); + + +/** + * Copy a native fd set into the GNUnet representation. + * + * @param to destination + * @param from native source set + * @param nfds the biggest socket number in from + 1 + */ +void +GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to, + const fd_set *from, + int nfds); + + +/** + * Set a native fd in a set + * + * @param to destination + * @param nfd native FD to set + */ +void +GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, + int nfd); + + +/** + * Test native fd in a set + * + * @param to set to test, NULL for empty set + * @param nfd native FD to test, -1 for none + * @return #GNUNET_YES if to contains nfd + */ +int +GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to, + int nfd); + + +/** + * Add a file handle to the fd set + * + * @param fds fd set + * @param h the file handle to add + */ +void +GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_DISK_FileHandle *h); + + +/** + * Add a file handle to the fd set + * On W32: ensure that the handle is first in the array. + * + * @param fds fd set + * @param h the file handle to add + */ +void +GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_DISK_FileHandle *h); + + +/** + * Check if a file handle is part of an fd set + * + * @param fds fd set + * @param h file handle + * @return #GNUNET_YES if the file handle is part of the set + */ +int +GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_DISK_FileHandle *h); + + +/** + * Checks if two fd sets overlap + * + * @param fds1 first fd set + * @param fds2 second fd set + * @return #GNUNET_YES if they do overlap, #GNUNET_NO otherwise + */ +int +GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1, + const struct GNUNET_NETWORK_FDSet *fds2); + + +/** + * Creates an fd set + * + * @return a new fd set + */ +struct GNUNET_NETWORK_FDSet * +GNUNET_NETWORK_fdset_create (void); + + +/** + * Releases the associated memory of an fd set + * + * @param fds fd set + */ +void +GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); + + +/** + * Test if the given @a port is available. + * + * @param ipproto transport protocol to test (i.e. IPPROTO_TCP) + * @param port port number to test + * @return #GNUNET_OK if the port is available, #GNUNET_NO if not + */ +int +GNUNET_NETWORK_test_port_free (int ipproto, + uint16_t port); + #if 0 /* keep Emacsens' auto-indent happy */ { @@ -302,7 +607,6 @@ GNUNET_NETWORK_notify_transmit_ready_cancel (struct } #endif +#endif /* GNUNET_NETWORK_LIB_H */ -/* ifndef GNUNET_NETWORK_LIB_H */ -#endif -/* end of gnunet_network_lib.h */ +/** @} */ /* end of group */