network.c File Reference

basic, low-level networking interface More...

#include "platform.h"
#include "gnunet_common.h"
#include "disk.h"

Include dependency graph for network.c:

Go to the source code of this file.

Data Structures
struct	GNUNET_NETWORK_Handle
	handle to a socket More...

Macros
#define	LOG(kind, ...)   GNUNET_log_from (kind, "util-network", __VA_ARGS__)
#define	LOG_STRERROR_FILE(kind, syscall, filename)
#define	LOG_STRERROR(kind, syscall)
#define	DEBUG_NETWORK   GNUNET_EXTRA_LOGGING
#define	INVALID_SOCKET   -1
#define	FD_COPY(s, d)   do { GNUNET_memcpy ((d), (s), sizeof(fd_set)); } while (0)

Functions
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_test_pf (int pf)
	Test if the given protocol family is supported by this system.
char *	GNUNET_NETWORK_shorten_unixpath (char *unixpath)
	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).
void	GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un)
	If services crash, they can leave a unix domain socket file on the disk.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd, int doBlock)
	Set if a socket should use blocking or non-blocking IO.
static int	socket_set_inheritable (const struct GNUNET_NETWORK_Handle *h)
	Make a socket non-inheritable to child processes.
static void	socket_set_nodelay (const struct GNUNET_NETWORK_Handle *h)
	Disable delays when sending data via the socket.
static int	initialize_network_handle (struct GNUNET_NETWORK_Handle *h, int af, int type)
	Perform proper canonical initialization for a network handle.
struct GNUNET_NETWORK_Handle *	GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc, struct sockaddr *address, socklen_t *address_len)
	Accept a new connection on a socket.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
	Bind a socket to a particular address.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)
	Close a socket.
void	GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc)
	Only free memory of a socket, keep the file descriptor untouched.
struct GNUNET_NETWORK_Handle *	GNUNET_NETWORK_socket_box_native (int fd)
	Box a native socket (and check that it is a socket).
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc, const struct sockaddr *address, socklen_t address_len)
	Connect a socket to some remote address.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc, int level, int optname, void *optval, socklen_t *optlen)
	Get socket options.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc, int backlog)
	Listen on a socket.
ssize_t	GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc)
	How much data is available to be read on this descriptor?
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 socket (always non-blocking).
ssize_t	GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc, void *buffer, size_t length)
	Read data from a connected socket (always non-blocking).
ssize_t	GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc, const void *buffer, size_t length)
	Send data (always non-blocking).
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)
	Send data to a particular destination (always non-blocking).
int	GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd, int level, int option_name, const void *option_value, socklen_t option_len)
	Set socket option.
struct GNUNET_NETWORK_Handle *	GNUNET_NETWORK_socket_create (int domain, int type, int protocol)
	Create a new socket.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc, int how)
	Shut down socket operations.
enum GNUNET_GenericReturnValue	GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc)
	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.
void	GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)
	Reset FD set.
void	GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_NETWORK_Handle *desc)
	Add a socket to the FD set.
int	GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_NETWORK_Handle *desc)
	Check whether a socket is part of the fd set.
void	GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst, const struct GNUNET_NETWORK_FDSet *src)
	Add one fd set to another.
void	GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to, const struct GNUNET_NETWORK_FDSet *from)
	Copy one fd set to another.
int	GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc)
	Return file descriptor for this network handle.
struct sockaddr *	GNUNET_NETWORK_get_addr (const struct GNUNET_NETWORK_Handle *desc)
	Return sockaddr for this network handle.
socklen_t	GNUNET_NETWORK_get_addrlen (const struct GNUNET_NETWORK_Handle *desc)
	Return sockaddr length for this network handle.
void	GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to, const fd_set *from, int nfds)
	Copy a native fd set.
void	GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to, int nfd)
	Set a native fd in a set.
int	GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to, int nfd)
	Test native fd in a set.
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.
void	GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h)
	Add a file handle to the fd set.
int	GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds, const struct GNUNET_DISK_FileHandle *h)
	Check if a file handle is part of an fd set.
int	GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1, const struct GNUNET_NETWORK_FDSet *fds2)
	Checks if two fd sets overlap.
struct GNUNET_NETWORK_FDSet *	GNUNET_NETWORK_fdset_create ()
	Creates an fd set.
void	GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)
	Releases the associated memory of an fd set.
int	GNUNET_NETWORK_test_port_free (int ipproto, uint16_t port)
	Test if the given port is available.
int	GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds, struct GNUNET_NETWORK_FDSet *wfds, struct GNUNET_NETWORK_FDSet *efds, const struct GNUNET_TIME_Relative timeout)
	Check if sockets or pipes meet certain conditions.

Detailed Description

basic, low-level networking interface

Author

Nils Durner

Christian Grothoff

Definition in file network.c.

Macro Definition Documentation

LOG

#define LOG	(		kind,
			...
	)		GNUNET_log_from (kind, "util-network", __VA_ARGS__)

Definition at line 31 of file network.c.

LOG_STRERROR_FILE

#define LOG_STRERROR_FILE	(		kind,
			syscall,
			filename
	)

Value:

                                                                   GNUNET_log_from_strerror_file (kind, \
                                                                   "util-network", \
                                                                   syscall, \
                                                                   filename)

Definition at line 32 of file network.c.

{
  int fd;
 
  int af;
 
  int type;
 
  socklen_t addrlen;
 
  struct sockaddr *addr;
};
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_test_pf (int pf)
{
  static int cache_v4 = -1;
  static int cache_v6 = -1;
  static int cache_un = -1;
  int s;
  int ret;
 
  switch (pf)
  {
  case PF_INET:
    if (-1 != cache_v4)
      return cache_v4;
    break;
 
  case PF_INET6:
    if (-1 != cache_v6)
      return cache_v6;
    break;
 
#ifdef PF_UNIX
  case PF_UNIX:
    if (-1 != cache_un)
      return cache_un;
    break;
#endif
  }
  s = socket (pf, SOCK_STREAM, 0);
  if (-1 == s)
  {
    if (EAFNOSUPPORT != errno)
    {
      GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
                           "socket");
      return GNUNET_SYSERR;
    }
    ret = GNUNET_NO;
  }
  else
  {
    GNUNET_break (0 == close (s));
    ret = GNUNET_OK;
  }
  switch (pf)
  {
  case PF_INET:
    cache_v4 = ret;
    break;
 
  case PF_INET6:
    cache_v6 = ret;
    break;
 
#ifdef PF_UNIX
  case PF_UNIX:
    cache_un = ret;
    break;
#endif
  }
  return ret;
}
 
 
char *
GNUNET_NETWORK_shorten_unixpath (char *unixpath)
{
  struct sockaddr_un dummy;
  size_t slen;
  char *end;
  struct GNUNET_HashCode sh;
  struct GNUNET_CRYPTO_HashAsciiEncoded ae;
  size_t upm;
 
  upm = sizeof(dummy.sun_path);
  slen = strlen (unixpath);
  if (slen < upm)
    return unixpath; /* no shortening required */
  GNUNET_CRYPTO_hash (unixpath, slen, &sh);
  while (16 + strlen (unixpath) >= upm)
  {
    if (NULL == (end = strrchr (unixpath, '/')))
    {
      GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
                  _ (
                    "Unable to shorten unix path `%s' while keeping name unique\n"),
                  unixpath);
      GNUNET_free (unixpath);
      return NULL;
    }
    *end = '\0';
  }
  GNUNET_CRYPTO_hash_to_enc (&sh, &ae);
  ae.encoding[16] = '\0';
  strcat (unixpath, (char *) ae.encoding);
  return unixpath;
}
 
 
void
GNUNET_NETWORK_unix_precheck (const struct sockaddr_un *un)
{
  int s;
  int eno;
  struct stat sbuf;
  int ret;
 
  s = socket (AF_UNIX, SOCK_STREAM, 0);
  if (-1 == s)
  {
    GNUNET_log_strerror (GNUNET_ERROR_TYPE_WARNING,
                         "Failed to open AF_UNIX socket");
    return;
  }
  ret = connect (s,
                 (struct sockaddr *) un,
                 sizeof(struct sockaddr_un));
  eno = errno;
  GNUNET_break (0 == close (s));
  if (0 == ret)
    return; /* another process is listening, do not remove! */
  if (ECONNREFUSED != eno)
    return; /* some other error, likely "no such file or directory" -- all well */
  /* should unlink, but sanity checks first */
  if (0 != stat (un->sun_path,
                 &sbuf))
    return; /* failed to 'stat', likely does not exist after all */
  if (S_IFSOCK != (S_IFMT & sbuf.st_mode))
    return; /* refuse to unlink anything except sockets */
  /* finally, really unlink */
  GNUNET_log (GNUNET_ERROR_TYPE_INFO,
              "Removing left-over `%s' from previous execution\n",
              un->sun_path);
  if (0 != unlink (un->sun_path))
    GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
                              "unlink",
                              un->sun_path);
}
 
 
#ifndef FD_COPY
#define FD_COPY(s, d) do { GNUNET_memcpy ((d), (s), sizeof(fd_set)); } while (0)
#endif
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_set_blocking (struct GNUNET_NETWORK_Handle *fd,
                                    int doBlock)
{
  int flags = fcntl (fd->fd, F_GETFL);
 
  if (flags == -1)
  {
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
                  "fcntl");
    return GNUNET_SYSERR;
  }
  if (doBlock)
    flags &= ~O_NONBLOCK;
 
  else
    flags |= O_NONBLOCK;
  if (0 != fcntl (fd->fd,
                  F_SETFL,
                  flags))
 
  {
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
                  "fcntl");
    return GNUNET_SYSERR;
  }
  return GNUNET_OK;
}
 
 
static int
socket_set_inheritable (const struct GNUNET_NETWORK_Handle *h)
{
  int i;
  i = fcntl (h->fd, F_GETFD);
  if (i < 0)
    return GNUNET_SYSERR;
  if (i == (i | FD_CLOEXEC))
    return GNUNET_OK;
  i |= FD_CLOEXEC;
  if (fcntl (h->fd, F_SETFD, i) < 0)
    return GNUNET_SYSERR;
 
  return GNUNET_OK;
}
 
 
#ifdef DARWIN
static int
socket_set_nosigpipe (const struct GNUNET_NETWORK_Handle *h)
{
  int abs_value = 1;
 
  if (0 !=
      setsockopt (h->fd, SOL_SOCKET, SO_NOSIGPIPE,
                  (const void *) &abs_value,
                  sizeof(abs_value)))
    return GNUNET_SYSERR;
  return GNUNET_OK;
}
 
 
#endif
 
 
static void
socket_set_nodelay (const struct GNUNET_NETWORK_Handle *h)
{
  int value = 1;
 
  if (0 !=
      setsockopt (h->fd,
                  IPPROTO_TCP,
                  TCP_NODELAY,
                  &value, sizeof(value)))
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
                  "setsockopt");
}
 
 
static int
initialize_network_handle (struct GNUNET_NETWORK_Handle *h,
                           int af,
                           int type)
{
  int eno;
 
  h->af = af;
  h->type = type;
  if (h->fd == INVALID_SOCKET)
  {
    eno = errno;
    GNUNET_free (h);
    errno = eno;
    return GNUNET_SYSERR;
  }
 
  if (h->fd >= FD_SETSIZE)
  {
    GNUNET_break (GNUNET_OK ==
                  GNUNET_NETWORK_socket_close (h));
    errno = EMFILE;
    return GNUNET_SYSERR;
  }
 
  if (GNUNET_OK != socket_set_inheritable (h))
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                  "socket_set_inheritable");
 
  if (GNUNET_SYSERR == GNUNET_NETWORK_socket_set_blocking (h, GNUNET_NO))
  {
    eno = errno;
    GNUNET_break (0);
    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
    errno = eno;
    return GNUNET_SYSERR;
  }
#ifdef DARWIN
  if (GNUNET_SYSERR == socket_set_nosigpipe (h))
  {
    eno = errno;
    GNUNET_break (0);
    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
    errno = eno;
    return GNUNET_SYSERR;
  }
#endif
  if ((type == SOCK_STREAM)
#ifdef AF_UNIX
      && (af != AF_UNIX)
#endif
      )
    socket_set_nodelay (h);
  return GNUNET_OK;
}
 
 
struct GNUNET_NETWORK_Handle *
GNUNET_NETWORK_socket_accept (const struct GNUNET_NETWORK_Handle *desc,
                              struct sockaddr *address,
                              socklen_t *address_len)
{
  struct GNUNET_NETWORK_Handle *ret;
  int eno;
 
  ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
#if DEBUG_NETWORK
  {
    struct sockaddr_storage name;
    socklen_t namelen = sizeof(name);
 
    int gsn = getsockname (desc->fd,
                           (struct sockaddr *) &name,
                           &namelen);
 
    if (0 == gsn)
      LOG (GNUNET_ERROR_TYPE_DEBUG,
           "Accepting connection on `%s'\n",
           GNUNET_a2s ((const struct sockaddr *) &name,
                       namelen));
  }
#endif
  ret->fd = accept (desc->fd,
                    address,
                    address_len);
  if (-1 == ret->fd)
  {
    eno = errno;
    GNUNET_free (ret);
    errno = eno;
    return NULL;
  }
  if (GNUNET_OK !=
      initialize_network_handle (ret,
                                 (NULL != address) ? address->sa_family :
                                 desc->af,
                                 SOCK_STREAM))
  {
    return NULL;
  }
  return ret;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_bind (struct GNUNET_NETWORK_Handle *desc,
                            const struct sockaddr *address,
                            socklen_t address_len)
{
  int ret;
 
#ifdef IPV6_V6ONLY
#ifdef IPPROTO_IPV6
  {
    const int on = 1;
 
    if (AF_INET6 == desc->af)
      if (setsockopt (desc->fd,
                      IPPROTO_IPV6,
                      IPV6_V6ONLY,
                      (const void *) &on,
                      sizeof(on)))
        LOG_STRERROR (GNUNET_ERROR_TYPE_DEBUG,
                      "setsockopt");
  }
#endif
#endif
  if (AF_UNIX == address->sa_family)
    GNUNET_NETWORK_unix_precheck ((const struct sockaddr_un *) address);
 
  {
    const int on = 1;
 
    if ( (SOCK_STREAM == desc->type) &&
         (0 != setsockopt (desc->fd,
                           SOL_SOCKET,
                           SO_REUSEADDR,
                           &on, sizeof(on))) )
      LOG_STRERROR (GNUNET_ERROR_TYPE_DEBUG,
                    "setsockopt");
  }
  {
    /* set permissions of newly created non-abstract UNIX domain socket to
       "user-only"; applications can choose to relax this later */
    mode_t old_mask = 0; /* assigned to make compiler happy */
    const struct sockaddr_un *un = (const struct sockaddr_un *) address;
    int not_abstract = 0;
 
    if ((AF_UNIX == address->sa_family)
        && ('\0' != un->sun_path[0]))  /* Not an abstract socket */
      not_abstract = 1;
    if (not_abstract)
      old_mask = umask (S_IWGRP | S_IRGRP | S_IXGRP | S_IWOTH | S_IROTH
                        | S_IXOTH);
 
    ret = bind (desc->fd,
                address,
                address_len);
 
    if (not_abstract)
      (void) umask (old_mask);
  }
  if (0 != ret)
    return GNUNET_SYSERR;
 
  desc->addr = GNUNET_malloc (address_len);
  GNUNET_memcpy (desc->addr, address, address_len);
  desc->addrlen = address_len;
 
  return GNUNET_OK;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_close (struct GNUNET_NETWORK_Handle *desc)
{
  int ret;
  const struct sockaddr_un *un;
 
  ret = close (desc->fd);
  un = (const struct sockaddr_un *) desc->addr;
 
  /* Cleanup the UNIX domain socket and its parent directories in case of non
     abstract sockets */
  if ((AF_UNIX == desc->af) &&
      (NULL != desc->addr) &&
      ('\0' != un->sun_path[0]))
  {
    char *dirname = GNUNET_strndup (un->sun_path,
                                    sizeof(un->sun_path));
 
    if (0 != unlink (dirname))
    {
      LOG_STRERROR_FILE (GNUNET_ERROR_TYPE_WARNING,
                         "unlink",
                         dirname);
    }
    else
    {
      size_t len;
 
      len = strlen (dirname);
      while ((len > 0) && (dirname[len] != DIR_SEPARATOR))
        len--;
      dirname[len] = '\0';
      if ((0 != len) && (0 != rmdir (dirname)))
      {
        switch (errno)
        {
        case EACCES:
        case ENOTEMPTY:
        case EPERM:
          /* these are normal and can just be ignored */
          break;
 
        default:
          GNUNET_log_strerror_file (GNUNET_ERROR_TYPE_WARNING,
                                    "rmdir",
                                    dirname);
          break;
        }
      }
    }
    GNUNET_free (dirname);
  }
  GNUNET_NETWORK_socket_free_memory_only_ (desc);
  return (ret == 0) ? GNUNET_OK : GNUNET_SYSERR;
}
 
 
void
GNUNET_NETWORK_socket_free_memory_only_ (struct GNUNET_NETWORK_Handle *desc)
{
  GNUNET_free (desc->addr);
  GNUNET_free (desc);
}
 
 
struct GNUNET_NETWORK_Handle *
GNUNET_NETWORK_socket_box_native (int fd)
{
  struct GNUNET_NETWORK_Handle *ret;
 
  if (fcntl (fd, F_GETFD) < 0)
    return NULL;                /* invalid FD */
  ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
  ret->fd = fd;
  ret->af = AF_UNSPEC;
  return ret;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_connect (const struct GNUNET_NETWORK_Handle *desc,
                               const struct sockaddr *address,
                               socklen_t address_len)
{
  int ret;
 
  ret = connect (desc->fd,
                 address,
                 address_len);
 
  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_getsockopt (const struct GNUNET_NETWORK_Handle *desc,
                                  int level,
                                  int optname,
                                  void *optval,
                                  socklen_t *optlen)
{
  int ret;
 
  ret = getsockopt (desc->fd,
                    level,
                    optname,
                    optval, optlen);
 
  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_listen (const struct GNUNET_NETWORK_Handle *desc,
                              int backlog)
{
  int ret;
 
  ret = listen (desc->fd,
                backlog);
 
  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
}
 
 
ssize_t
GNUNET_NETWORK_socket_recvfrom_amount (const struct GNUNET_NETWORK_Handle *desc)
{
  int error;
 
  /* How much is there to be read? */
  int pending;
 
  error = ioctl (desc->fd,
                 FIONREAD,
                 &pending);
  if (0 == error)
    return (ssize_t) pending;
  return GNUNET_SYSERR;
}
 
 
ssize_t
GNUNET_NETWORK_socket_recvfrom (const struct GNUNET_NETWORK_Handle *desc,
                                void *buffer,
                                size_t length,
                                struct sockaddr *src_addr,
                                socklen_t *addrlen)
{
  int flags = 0;
 
#ifdef MSG_DONTWAIT
  flags |= MSG_DONTWAIT;
#endif
  return recvfrom (desc->fd,
                   buffer,
                   length,
                   flags,
                   src_addr,
                   addrlen);
}
 
 
ssize_t
GNUNET_NETWORK_socket_recv (const struct GNUNET_NETWORK_Handle *desc,
                            void *buffer,
                            size_t length)
{
  int ret;
  int flags;
 
  flags = 0;
 
#ifdef MSG_DONTWAIT
  flags |= MSG_DONTWAIT;
#endif
  ret = recv (desc->fd,
              buffer,
              length,
              flags);
  return ret;
}
 
 
ssize_t
GNUNET_NETWORK_socket_send (const struct GNUNET_NETWORK_Handle *desc,
                            const void *buffer,
                            size_t length)
{
  int ret;
  int flags;
 
  flags = 0;
#ifdef MSG_DONTWAIT
  flags |= MSG_DONTWAIT;
#endif
#ifdef MSG_NOSIGNAL
  flags |= MSG_NOSIGNAL;
#endif
  ret = send (desc->fd,
              buffer,
              length,
              flags);
  return ret;
}
 
 
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)
{
  int flags = 0;
 
#ifdef MSG_DONTWAIT
  flags |= MSG_DONTWAIT;
#endif
#ifdef MSG_NOSIGNAL
  flags |= MSG_NOSIGNAL;
#endif
  return sendto (desc->fd,
                 message,
                 length,
                 flags,
                 dest_addr,
                 dest_len);
}
 
 
int
GNUNET_NETWORK_socket_setsockopt (struct GNUNET_NETWORK_Handle *fd,
                                  int level,
                                  int option_name,
                                  const void *option_value,
                                  socklen_t option_len)
{
  return (0 == setsockopt (fd->fd,
                           level,
                           option_name,
                           option_value,
                           option_len))
    ? GNUNET_OK
    : GNUNET_SYSERR;
}
 
 
struct GNUNET_NETWORK_Handle *
GNUNET_NETWORK_socket_create (int domain,
                              int type,
                              int protocol)
{
  struct GNUNET_NETWORK_Handle *ret;
  int fd;
 
  fd = socket (domain, type, protocol);
  if (-1 == fd)
    return NULL;
  ret = GNUNET_new (struct GNUNET_NETWORK_Handle);
  ret->fd = fd;
  if (GNUNET_OK !=
      initialize_network_handle (ret,
                                 domain,
                                 type))
    return NULL;
  return ret;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_shutdown (struct GNUNET_NETWORK_Handle *desc,
                                int how)
{
  int ret;
 
  ret = shutdown (desc->fd, how);
 
  return (0 == ret) ? GNUNET_OK : GNUNET_SYSERR;
}
 
 
enum GNUNET_GenericReturnValue
GNUNET_NETWORK_socket_disable_corking (struct GNUNET_NETWORK_Handle *desc)
{
  int ret = 0;
 
#ifdef __linux__
  int value = 0;
 
  if (0 !=
      (ret =
         setsockopt (desc->fd,
                     SOL_SOCKET,
                     SO_SNDBUF,
                     &value,
                     sizeof(value))))
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
                  "setsockopt");
  if (0 !=
      (ret =
         setsockopt (desc->fd,
                     SOL_SOCKET,
                     SO_RCVBUF,
                     &value,
                     sizeof(value))))
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
                  "setsockopt");
#endif
  return ret == 0 ? GNUNET_OK : GNUNET_SYSERR;
}
 
 
void
GNUNET_NETWORK_fdset_zero (struct GNUNET_NETWORK_FDSet *fds)
{
  FD_ZERO (&fds->sds);
  fds->nsds = 0;
}
 
 
void
GNUNET_NETWORK_fdset_set (struct GNUNET_NETWORK_FDSet *fds,
                          const struct GNUNET_NETWORK_Handle *desc)
{
  FD_SET (desc->fd,
          &fds->sds);
  fds->nsds = GNUNET_MAX (fds->nsds,
                          desc->fd + 1);
}
 
 
int
GNUNET_NETWORK_fdset_isset (const struct GNUNET_NETWORK_FDSet *fds,
                            const struct GNUNET_NETWORK_Handle *desc)
{
  return FD_ISSET (desc->fd,
                   &fds->sds);
}
 
 
void
GNUNET_NETWORK_fdset_add (struct GNUNET_NETWORK_FDSet *dst,
                          const struct GNUNET_NETWORK_FDSet *src)
{
  int nfds;
 
  for (nfds = src->nsds; nfds >= 0; nfds--)
    if (FD_ISSET (nfds, &src->sds))
      FD_SET (nfds, &dst->sds);
  dst->nsds = GNUNET_MAX (dst->nsds,
                          src->nsds);
}
 
 
void
GNUNET_NETWORK_fdset_copy (struct GNUNET_NETWORK_FDSet *to,
                           const struct GNUNET_NETWORK_FDSet *from)
{
  FD_COPY (&from->sds,
           &to->sds);
  to->nsds = from->nsds;
}
 
 
int
GNUNET_NETWORK_get_fd (const struct GNUNET_NETWORK_Handle *desc)
{
  return desc->fd;
}
 
 
struct sockaddr*
GNUNET_NETWORK_get_addr (const struct GNUNET_NETWORK_Handle *desc)
{
  return desc->addr;
}
 
 
socklen_t
GNUNET_NETWORK_get_addrlen (const struct GNUNET_NETWORK_Handle *desc)
{
  return desc->addrlen;
}
 
 
void
GNUNET_NETWORK_fdset_copy_native (struct GNUNET_NETWORK_FDSet *to,
                                  const fd_set *from,
                                  int nfds)
{
  FD_COPY (from,
           &to->sds);
  to->nsds = nfds;
}
 
 
void
GNUNET_NETWORK_fdset_set_native (struct GNUNET_NETWORK_FDSet *to,
                                 int nfd)
{
  GNUNET_assert ((nfd >= 0) && (nfd < FD_SETSIZE));
  FD_SET (nfd, &to->sds);
  to->nsds = GNUNET_MAX (nfd + 1,
                         to->nsds);
}
 
 
int
GNUNET_NETWORK_fdset_test_native (const struct GNUNET_NETWORK_FDSet *to,
                                  int nfd)
{
  if ((-1 == nfd) ||
      (NULL == to))
    return GNUNET_NO;
  return FD_ISSET (nfd, &to->sds) ? GNUNET_YES : GNUNET_NO;
}
 
 
void
GNUNET_NETWORK_fdset_handle_set (struct GNUNET_NETWORK_FDSet *fds,
                                 const struct GNUNET_DISK_FileHandle *h)
{
  int fd;
 
  GNUNET_assert (GNUNET_OK ==
                 GNUNET_DISK_internal_file_handle_ (h, &fd));
  FD_SET (fd,
          &fds->sds);
  fds->nsds = GNUNET_MAX (fd + 1,
                          fds->nsds);
}
 
 
void
GNUNET_NETWORK_fdset_handle_set_first (struct GNUNET_NETWORK_FDSet *fds,
                                       const struct GNUNET_DISK_FileHandle *h)
{
  GNUNET_NETWORK_fdset_handle_set (fds, h);
}
 
 
int
GNUNET_NETWORK_fdset_handle_isset (const struct GNUNET_NETWORK_FDSet *fds,
                                   const struct GNUNET_DISK_FileHandle *h)
{
  return FD_ISSET (h->fd,
                   &fds->sds);
}
 
 
int
GNUNET_NETWORK_fdset_overlap (const struct GNUNET_NETWORK_FDSet *fds1,
                              const struct GNUNET_NETWORK_FDSet *fds2)
{
  int nfds;
 
  nfds = GNUNET_MIN (fds1->nsds,
                     fds2->nsds);
  while (nfds > 0)
  {
    nfds--;
    if ((FD_ISSET (nfds,
                   &fds1->sds)) &&
        (FD_ISSET (nfds,
                   &fds2->sds)))
      return GNUNET_YES;
  }
  return GNUNET_NO;
}
 
 
struct GNUNET_NETWORK_FDSet *
GNUNET_NETWORK_fdset_create ()
{
  struct GNUNET_NETWORK_FDSet *fds;
 
  fds = GNUNET_new (struct GNUNET_NETWORK_FDSet);
  GNUNET_NETWORK_fdset_zero (fds);
  return fds;
}
 
 
void
GNUNET_NETWORK_fdset_destroy (struct GNUNET_NETWORK_FDSet *fds)
{
  GNUNET_free (fds);
}
 
 
int
GNUNET_NETWORK_test_port_free (int ipproto,
                               uint16_t port)
{
  struct GNUNET_NETWORK_Handle *socket;
  int bind_status;
  int socktype;
  char open_port_str[6];
  struct addrinfo hint;
  struct addrinfo *ret;
  struct addrinfo *ai;
 
  GNUNET_snprintf (open_port_str,
                   sizeof(open_port_str),
                   "%u",
                   (unsigned int) port);
  socktype = (IPPROTO_TCP == ipproto) ? SOCK_STREAM : SOCK_DGRAM;
  ret = NULL;
  memset (&hint, 0, sizeof(hint));
  hint.ai_family = AF_UNSPEC; /* IPv4 and IPv6 */
  hint.ai_socktype = socktype;
  hint.ai_protocol = ipproto;
  hint.ai_addrlen = 0;
  hint.ai_addr = NULL;
  hint.ai_canonname = NULL;
  hint.ai_next = NULL;
  hint.ai_flags = AI_PASSIVE | AI_NUMERICSERV; /* Wild card address */
  GNUNET_assert (0 == getaddrinfo (NULL,
                                   open_port_str,
                                   &hint,
                                   &ret));
  bind_status = GNUNET_NO;
  for (ai = ret; NULL != ai; ai = ai->ai_next)
  {
    socket = GNUNET_NETWORK_socket_create (ai->ai_family,
                                           ai->ai_socktype,
                                           ai->ai_protocol);
    if (NULL == socket)
      continue;
    bind_status = GNUNET_NETWORK_socket_bind (socket,
                                              ai->ai_addr,
                                              ai->ai_addrlen);
    GNUNET_NETWORK_socket_close (socket);
    if (GNUNET_OK != bind_status)
      break;
  }
  freeaddrinfo (ret);
  return bind_status;
}
 
 
int
GNUNET_NETWORK_socket_select (struct GNUNET_NETWORK_FDSet *rfds,
                              struct GNUNET_NETWORK_FDSet *wfds,
                              struct GNUNET_NETWORK_FDSet *efds,
                              const struct GNUNET_TIME_Relative timeout)
{
  int nfds;
  struct timeval tv;
 
  if (NULL != rfds)
    nfds = rfds->nsds;
  else
    nfds = 0;
  if (NULL != wfds)
    nfds = GNUNET_MAX (nfds,
                       wfds->nsds);
  if (NULL != efds)
    nfds = GNUNET_MAX (nfds,
                       efds->nsds);
  if ((0 == nfds) &&
      (timeout.rel_value_us == GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us))
  {
    GNUNET_break (0);
    LOG (GNUNET_ERROR_TYPE_ERROR,
         _ (
           "Fatal internal logic error, process hangs in `%s' (abort with CTRL-C)!\n"),
         "select");
  }
  if (timeout.rel_value_us / GNUNET_TIME_UNIT_SECONDS.rel_value_us > (unsigned
                                                                      long long)
      LONG_MAX)
  {
    tv.tv_sec = LONG_MAX;
    tv.tv_usec = 999999L;
  }
  else
  {
    tv.tv_sec = (long) (timeout.rel_value_us
                        / GNUNET_TIME_UNIT_SECONDS.rel_value_us);
    tv.tv_usec =
      (timeout.rel_value_us
       - (tv.tv_sec * GNUNET_TIME_UNIT_SECONDS.rel_value_us));
  }
  return select (nfds,
                 (NULL != rfds) ? &rfds->sds : NULL,
                 (NULL != wfds) ? &wfds->sds : NULL,
                 (NULL != efds) ? &efds->sds : NULL,
                 (timeout.rel_value_us ==
                  GNUNET_TIME_UNIT_FOREVER_REL.rel_value_us) ? NULL : &tv);
}
 
 
/* end of network.c */

LOG_STRERROR

#define LOG_STRERROR	(		kind,
			syscall
	)

Value:

                                                              GNUNET_log_from_strerror (kind, \
                                                              "util-network", \
                                                              syscall)

Definition at line 37 of file network.c.

DEBUG_NETWORK

#define DEBUG_NETWORK   GNUNET_EXTRA_LOGGING

Definition at line 41 of file network.c.

INVALID_SOCKET

#define INVALID_SOCKET   -1

Definition at line 45 of file network.c.

FD_COPY

#define FD_COPY	(		s,
			d
	)		do { GNUNET_memcpy ((d), (s), sizeof(fd_set)); } while (0)

Definition at line 219 of file network.c.

Function Documentation

socket_set_inheritable()

static int socket_set_inheritable ( const struct GNUNET_NETWORK_Handle *  h )

static

Make a socket non-inheritable to child processes.

Parameters

h	the socket to make non-inheritable

Returns

GNUNET_OK on success, GNUNET_SYSERR otherwise

Warning

Not implemented on Windows

Definition at line 261 of file network.c.

{
  int i;
  i = fcntl (h->fd, F_GETFD);
  if (i < 0)
    return GNUNET_SYSERR;
  if (i == (i | FD_CLOEXEC))
    return GNUNET_OK;
  i |= FD_CLOEXEC;
  if (fcntl (h->fd, F_SETFD, i) < 0)
    return GNUNET_SYSERR;
 
  return GNUNET_OK;
}

References GNUNET_OK, GNUNET_SYSERR, and h.

Referenced by initialize_network_handle().

Here is the caller graph for this function:

socket_set_nodelay()

static void socket_set_nodelay ( const struct GNUNET_NETWORK_Handle *  h )

static

Disable delays when sending data via the socket.

(GNUnet makes sure that messages are as big as possible already).

Parameters

h	the socket to make non-delaying

Definition at line 308 of file network.c.

{
  int value = 1;
 
  if (0 !=
      setsockopt (h->fd,
                  IPPROTO_TCP,
                  TCP_NODELAY,
                  &value, sizeof(value)))
    LOG_STRERROR (GNUNET_ERROR_TYPE_WARNING,
                  "setsockopt");
}

References GNUNET_ERROR_TYPE_WARNING, h, LOG_STRERROR, and value.

Referenced by initialize_network_handle().

Here is the caller graph for this function:

initialize_network_handle()

static int initialize_network_handle ( struct GNUNET_NETWORK_Handle *  h, int  af, int  type  )

static

Perform proper canonical initialization for a network handle.

Set it to non-blocking, make it non-inheritable to child processes, disable SIGPIPE, enable "nodelay" (if non-UNIX stream socket) and check that it is smaller than FD_SETSIZE.

Parameters

h	socket to initialize
af	address family of the socket
type	socket type

Returns

GNUNET_OK on success, GNUNET_SYSERR if initialization failed and the handle was destroyed

Definition at line 335 of file network.c.

{
  int eno;
 
  h->af = af;
  h->type = type;
  if (h->fd == INVALID_SOCKET)
  {
    eno = errno;
    GNUNET_free (h);
    errno = eno;
    return GNUNET_SYSERR;
  }
 
  if (h->fd >= FD_SETSIZE)
  {
    GNUNET_break (GNUNET_OK ==
                  GNUNET_NETWORK_socket_close (h));
    errno = EMFILE;
    return GNUNET_SYSERR;
  }
 
  if (GNUNET_OK != socket_set_inheritable (h))
    LOG_STRERROR (GNUNET_ERROR_TYPE_ERROR | GNUNET_ERROR_TYPE_BULK,
                  "socket_set_inheritable");
 
  if (GNUNET_SYSERR == GNUNET_NETWORK_socket_set_blocking (h, GNUNET_NO))
  {
    eno = errno;
    GNUNET_break (0);
    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
    errno = eno;
    return GNUNET_SYSERR;
  }
#ifdef DARWIN
  if (GNUNET_SYSERR == socket_set_nosigpipe (h))
  {
    eno = errno;
    GNUNET_break (0);
    GNUNET_break (GNUNET_OK == GNUNET_NETWORK_socket_close (h));
    errno = eno;
    return GNUNET_SYSERR;
  }
#endif
  if ((type == SOCK_STREAM)
#ifdef AF_UNIX
      && (af != AF_UNIX)
#endif
      )
    socket_set_nodelay (h);
  return GNUNET_OK;
}

References GNUNET_break, GNUNET_ERROR_TYPE_BULK, GNUNET_ERROR_TYPE_ERROR, GNUNET_free, GNUNET_NETWORK_socket_close(), GNUNET_NETWORK_socket_set_blocking(), GNUNET_NO, GNUNET_OK, GNUNET_SYSERR, h, INVALID_SOCKET, LOG_STRERROR, socket_set_inheritable(), socket_set_nodelay(), and type.

Referenced by GNUNET_NETWORK_socket_accept(), and GNUNET_NETWORK_socket_create().

Here is the call graph for this function:

Here is the caller graph for this function: