X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=src%2Finclude%2Fgnunet_network_lib.h;h=06a5ce9038021667978c95ba56ab569535317cfb;hb=f2061adfbfeabe988a185145d9df140d14131e74;hp=492713c464e5499e9e0c3f3059c1349046fdd0fb;hpb=f1b9c5c115139b02cac1cae4f053792e1e5b1ccb;p=oweals%2Fgnunet.git diff --git a/src/include/gnunet_network_lib.h b/src/include/gnunet_network_lib.h index 492713c46..06a5ce903 100644 --- a/src/include/gnunet_network_lib.h +++ b/src/include/gnunet_network_lib.h @@ -36,23 +36,59 @@ extern "C" #endif - /** * @brief handle to a socket */ struct GNUNET_NETWORK_Handle; + /** * @brief collection of IO descriptors */ -struct GNUNET_NETWORK_FDSet; +struct GNUNET_NETWORK_FDSet +{ + + /** + * Maximum number of any socket socket descriptor in the set (plus one) + */ + int nsds; + + /** + * Bitset with the descriptors. + */ + fd_set sds; + +#ifdef WINDOWS + /** + * Linked list of handles + */ + struct GNUNET_CONTAINER_SList *handles; +#endif + +}; #include "gnunet_disk_lib.h" #include "gnunet_time_lib.h" + +/** + * 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); + + /** - * accept a new connection on a socket + * 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 @@ -61,79 +97,121 @@ struct GNUNET_NETWORK_FDSet; */ struct GNUNET_NETWORK_Handle * GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc, - struct sockaddr *address, - socklen_t *address_len); + struct sockaddr *address, + socklen_t * address_len); + /** - * Make a non-inheritable to child processes (sets the - * close-on-exec flag). + * Box a native socket (and check that it is a socket). * - * @param socket - * @return GNUNET_OK on success, GNUNET_SYSERR otherwise - * @warning Not implemented on Windows + * @param fd socket to box + * @return NULL on error (including not supported on target platform) */ -int -GNUNET_NETWORK_socket_set_inheritable (const struct GNUNET_NETWORK_Handle - *desc); +struct GNUNET_NETWORK_Handle * +GNUNET_NETWORK_socket_box_native (SOCKTYPE fd); + /** * Bind to a connected socket - * @param desc socket + * + * @param desc socket to bind * @param address address to be bound * @param address_len length of 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); +int +GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc, + const struct sockaddr *address, + socklen_t address_len); /** - * Close a socket - * @param desc socket + * Close a socket. + * + * @param desc socket to close * @return GNUNET_OK on success, GNUNET_SYSERR otherwise */ -int GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc); +int +GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc); + /** * Connect a socket - * @param desc socket + * + * @param desc socket to connect * @param address peer address - * @param length of address + * @param address_len of address * @return GNUNET_OK on success, GNUNET_SYSERR otherwise */ -int GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc, - const struct sockaddr *address, socklen_t address_len); +int +GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc, + const struct sockaddr *address, + socklen_t address_len); + /** * Get socket options - * @param desc socket + * + * @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 */ -int GNUNET_NETWORK_socket_getsockopt(const struct GNUNET_NETWORK_Handle *desc, int level, int optname, - void *optval, socklen_t *optlen); +int +GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc, + int level, int optname, void *optval, + socklen_t * optlen); + /** * Listen on a socket - * @param desc socket + * + * @param desc socket to start listening on * @param backlog length of the listen queue * @return GNUNET_OK on success, GNUNET_SYSERR otherwise */ -int GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc, int backlog); +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 + */ +ssize_t +GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle + *desc); + /** - * Read data from a connected socket + * Read data from a connected socket (always non-blocking). + * @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 + */ +ssize_t +GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc, + void *buffer, size_t length, + struct sockaddr *src_addr, socklen_t *addrlen); + + +/** + * Read data from a connected socket (always non-blocking). * * @param desc socket * @param buffer buffer * @param length length of buffer - * @param flags type of message reception * @return number of bytes read */ -ssize_t GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, void *buffer, - size_t length, int flags); +ssize_t +GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, + void *buffer, size_t length); + /** * Check if sockets meet certain conditions @@ -143,47 +221,47 @@ ssize_t GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, vo * @param timeout relative value when to return * @return number of selected sockets, GNUNET_SYSERR on error */ -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); +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); -/** - * 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 - */ -int GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, - int doBlock); /** - * Send data + * Send data (always non-blocking). + * * @param desc socket * @param buffer data to send * @param length size of the buffer - * @param flags type of message transmission * @return number of bytes sent, GNUNET_SYSERR on error */ -ssize_t GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, - const void *buffer, size_t length, int flags); +ssize_t +GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, + const void *buffer, size_t length); + /** - * Send data + * Send data to a particular destination (always non-blocking). + * This function only works for UDP sockets. + * * @param desc socket * @param message data to send * @param length size of the data - * @param flags type of message transmission * @param dest_addr destination address * @param dest_len length of address * @return number of bytes sent, GNUNET_SYSERR on error */ -ssize_t GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc, - const void *message, size_t length, int flags, - const struct sockaddr *dest_addr, - socklen_t dest_len); +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); + /** * Set socket option + * * @param fd socket * @param level protocol level of the option * @param option_name option identifier @@ -191,83 +269,184 @@ ssize_t GNUNET_NETWORK_socket_sendto (const struct GNUNET_NETWORK_Handle *desc, * @param option_len size of option_value * @return GNUNET_OK on success, GNUNET_SYSERR otherwise */ -int GNUNET_NETWORK_socket_setsockopt(struct GNUNET_NETWORK_Handle *fd, int level, int option_name, - const void *option_value, socklen_t option_len); +int +GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level, + int option_name, const void *option_value, + socklen_t option_len); + /** * Shut down socket operations + * * @param desc socket * @param how type of shutdown * @return GNUNET_OK on success, GNUNET_SYSERR otherwise */ -int GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how); +int +GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how); + + +/** + * 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 + */ +int +GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc); + /** - * Create a new socket + * 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). + * * @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_socket (int domain, int type, int protocol); +struct GNUNET_NETWORK_Handle * +GNUNET_NETWORK_socket_create (int domain, int type, int protocol); + /** * Reset FD set (clears all file descriptors). * * @param fds fd set to clear */ -void GNUNET_NETWORK_fdset_zero(struct GNUNET_NETWORK_FDSet *fds); +void +GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds); + /** * Add a socket to the FD set * @param fds fd set * @param desc socket to add */ -void GNUNET_NETWORK_fdset_set(struct GNUNET_NETWORK_FDSet *fds, - const struct GNUNET_NETWORK_Handle *desc); +void +GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_NETWORK_Handle *desc); + + +#if WINDOWS +/** + * Add a W32 file handle to the fd set + * @param fds fd set + * @param h the file handle to add + */ +void +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); +int +GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_NETWORK_Handle *desc); + /** * Add one fd set to another * @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); +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); +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 (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 (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 (struct GNUNET_NETWORK_Handle *desc); + /** * Copy a native fd set * @param to destination * @param from native source set - * @param the biggest socket number in from + 1 + * @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); +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); +void +GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_DISK_FileHandle *h); + /** * Check if a file handle is part of an fd set @@ -275,8 +454,10 @@ void GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds, * @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); +int +GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds, + const struct GNUNET_DISK_FileHandle *h); + /** * Checks if two fd sets overlap @@ -284,20 +465,25 @@ int GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds, * @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); +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); +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); +void +GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds); #if 0 /* keep Emacsens' auto-indent happy */