/**
* Resolve IPv4/IPv6 address and create a ready-to-use active or passive socket.
*
- * @param l3type The layer-3 type (\p AF_INET, \p AF_INET6, \p AF_UNSPEC)
- * @param l4type The layer-4 type (\p IPPROTO_xxx).
- * @param passive Whether this is a passive (1) or active (0) socket/
- * @param host Remote or local hostname or IPv/6 address string.
- * @param port_number Decimal port number.
- *
- * This creates a ready-made IPv4/v6 socket structure after looking up the necessary
- * parameters. The interpretation of \a host depends on the value of \a passive:
- * - on a passive socket host is interpreted as an interface IPv4/6 address
- * (can be left NULL);
- * - on an active socket, \a host is the peer DNS name or IPv4/6 address to connect to;
- * - \a port_number is in either case the numeric port number (not service string).
- * Furthermore, bind(2) is called on passive sockets, and connect(2) on active sockets.
- * The algorithm tries all possible address combinations until it succeeds.
- *
- * \return This function returns 1 on success and \a -E_ADDRESS_LOOKUP when no matching
- * connection could be set up (with details in the error log).
- *
- * \sa ipv6(7), getaddrinfo(3), bind(2), connect(2)
+ * \param l3type The layer-3 type (\p AF_INET, \p AF_INET6, \p AF_UNSPEC).
+ * \param l4type The layer-4 type (\p IPPROTO_xxx).
+ * \param passive Whether this is a passive (1) or active (0) socket.
+ * \param host Remote or local hostname or IPv/6 address string.
+ * \param port_number Decimal port number.
+ *
+ * This creates a ready-made IPv4/v6 socket structure after looking up the
+ * necessary parameters. The interpretation of \a host depends on the value of
+ * \a passive:
+ * - on a passive socket host is interpreted as an interface IPv4/6 address
+ * (can be left NULL);
+ * - on an active socket, \a host is the peer DNS name or IPv4/6 address
+ * to connect to;
+ * - \a port_number is in either case the numeric port number (not service
+ * string).
+ *
+ * Furthermore, bind(2) is called on passive sockets, and connect(2) on active
+ * sockets. The algorithm tries all possible address combinations until it
+ * succeeds.
+ *
+ * \return This function returns 1 on success and \a -E_ADDRESS_LOOKUP when no
+ * matching connection could be set up (with details in the error log).
+ *
+ * \sa ipv6(7), getaddrinfo(3), bind(2), connect(2).
*/
int makesock(unsigned l3type, unsigned l4type, int passive,
const char *host, unsigned short port_number)
int rc, on = 1, sockfd = -1,
socktype = sock_type(l4type);
- /*
- * Set up address hint structure
- */
+ /* Set up address hint structure */
memset(&hints, 0, sizeof(hints));
hints.ai_family = l3type;
/* getaddrinfo does not really work well with SOCK_DCCP */
if (passive && host == NULL)
hints.ai_flags |= AI_PASSIVE;
- /*
- * Obtain local/remote address information
- */
+ /* Obtain local/remote address information */
if ((rc = getaddrinfo(host, port, &hints, passive ? &local : &remote))) {
PARA_ERROR_LOG("can not resolve %s address %s#%s: %s.\n",
layer4_name(l4type),
return -E_ADDRESS_LOOKUP;
}
- /*
- * Iterate over all src/dst combination, exhausting dst first
- */
+ /* Iterate over all src/dst combination, exhausting dst first */
for (src = local, dst = remote; src != NULL || dst != NULL; /* no op */ ) {
if (src && dst && src->ai_family == AF_INET
- && dst->ai_family == AF_INET6) /* v4 -> v6 is not possible */
- goto get_next_dst;
+ && dst->ai_family == AF_INET6)
+ goto get_next_dst; /* v4 -> v6 is not possible */
- sockfd = socket(src ? src->ai_family : dst->ai_family, socktype, l4type);
+ sockfd = socket(src ? src->ai_family : dst->ai_family,
+ socktype, l4type);
if (sockfd < 0)
goto get_next_dst;
/*
- * Set those options that need to be set before establishing the connection
+ * Set those options that need to be set before establishing
+ * the connection. Reuse the address on passive (listening)
+ * sockets to avoid failure on restart.
*/
- /* Reuse the address on passive (listening) sockets to avoid failure on restart */
- if (passive && setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &on, sizeof(on)) == -1) {
- PARA_ERROR_LOG("can not set SO_REUSEADDR: %s\n", strerror(errno));
+ if (passive && setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR,
+ &on, sizeof(on)) == -1) {
+ PARA_ERROR_LOG("can not set SO_REUSEADDR: %s\n",
+ strerror(errno));
return -ERRNO_TO_PARA_ERROR(errno);
}
close(sockfd);
goto get_next_src;
}
- if (!dst)
- break; /* bind-only completed successfully */
+ if (!dst) /* bind-only completed successfully */
+ break;
}
if (dst && connect(sockfd, dst->ai_addr, dst->ai_addrlen) == 0)
- break; /* connection completed successfully */
+ break; /* connection completed successfully */
close(sockfd);
get_next_dst:
if (dst && (dst = dst->ai_next))
continue;
get_next_src:
- if (src && (src = src->ai_next))
- dst = remote; /* restart inner loop */
+ if (src && (src = src->ai_next)) /* restart inner loop */
+ dst = remote;
}
if (local)
freeaddrinfo(local);
freeaddrinfo(remote);
if (src == NULL && dst == NULL) {
- PARA_ERROR_LOG("can not create %s socket %s#%s.\n", layer4_name(l4type),
- host? : (passive? "[loopback]" : "[localhost]"), port);
+ PARA_ERROR_LOG("can not create %s socket %s#%s.\n",
+ layer4_name(l4type), host? : (passive?
+ "[loopback]" : "[localhost]"), port);
return -ERRNO_TO_PARA_ERROR(errno);
}
return sockfd;
/**
* Create a passive / listening socket.
- * \param l3type The network-layer type (\p AF_xxx)
- * \param l4type The transport-layer type (\p IPPROTO_xxx).
- * \param port The decimal port number to listen on.
*
- * \return Positive integer (socket descriptor) on success, negative value otherwise.
+ * \param l3type The network-layer type (\p AF_xxx).
+ * \param l4type The transport-layer type (\p IPPROTO_xxx).
+ * \param port The decimal port number to listen on.
+ *
+ * \return Positive integer (socket descriptor) on success, negative value
+ * otherwise.
+ *
* \sa makesock(), ip(7), ipv6(7), bind(2), listen(2).
*/
int para_listen(unsigned l3type, unsigned l4type, unsigned short port)
/**
* Print numeric host and port number (beware - uses static char).
- * \param sa The IPv4/IPv6 socket address to use.
- * \param len The length of \p sa.
*
- * \sa getnameinfo(3)
+ * \param sa The IPv4/IPv6 socket address to use.
+ * \param len The length of \p sa.
+ *
+ * \sa getnameinfo(3).
*/
char *host_and_port(struct sockaddr *sa, socklen_t len)
{
- static char output[NI_MAXHOST + NI_MAXSERV + 2];
- char hbuf[NI_MAXHOST],
- sbuf[NI_MAXSERV];
- int ret;
+ static char output[NI_MAXHOST + NI_MAXSERV + 2];
+ char hbuf[NI_MAXHOST], sbuf[NI_MAXSERV];
+ int ret;
ret = getnameinfo(sa, len, hbuf, sizeof(hbuf), sbuf, sizeof(sbuf),
NI_NUMERICHOST | NI_NUMERICSERV);
/**
* Look up the local or remote side of a connected socket structure.
- * \param fd The socket descriptor of the connected socket.
- * \param getname Either \fn getsockname() for local, or \fn getpeername() for remote side.
*
- * \return A static character string identifying hostname and port of the chosen side
- * \sa getsockname(2), getpeername(2)
+ * \param fd The socket descriptor of the connected socket.
+ * \param getname Either \p getsockname() for local, or \p getpeername() for
+ * remote side.
+ *
+ * \return A static character string identifying hostname and port of the
+ * chosen side.
+ *
+ * \sa getsockname(2), getpeername(2).
*/
-static char *__get_sock_name(int fd, int (*getname)(int, struct sockaddr*, socklen_t *))
+static char *__get_sock_name(int fd, int (*getname)(int, struct sockaddr*,
+ socklen_t *))
{
- struct sockaddr_storage ss;
- socklen_t sslen = sizeof(ss);
+ struct sockaddr_storage ss;
+ socklen_t sslen = sizeof(ss);
if (getname(fd, (struct sockaddr *)&ss, &sslen) < 0) {
static char *dont_know = "(don't know)";
- PARA_ERROR_LOG("can not determine address from fd %d: %s\n", fd, strerror(errno));
+ PARA_ERROR_LOG("can not determine address from fd %d: %s\n",
+ fd, strerror(errno));
return dont_know;
}
-
return host_and_port((struct sockaddr *)&ss, sslen);
}
}
/**
- * prepare a structure for \p AF_UNIX socket addresses
+ * Prepare a structure for \p AF_UNIX socket addresses.
*
- * \param u pointer to the struct to be prepared
- * \param name the socket pathname
+ * \param u Pointer to the struct to be prepared.
+ * \param name The socket pathname.
*
* This just copies \a name to the sun_path component of \a u.
*
*
* \return The file descriptor, on success, negative on errors.
*
- * \sa create_local_socket(), unix(7), connect(2)
+ * \sa create_local_socket(), unix(7), connect(2).
*/
int create_remote_socket(const char *name)
{
}
#else /* HAVE_UCRED */
/**
- * send NULL terminated buffer and Unix credentials of the current process
+ * Send \p NULL-terminated buffer and Unix credentials of the current process.
*
- * \param sock the socket file descriptor
- * \param buf the buffer to be sent
+ * \param sock The socket file descriptor.
+ * \param buf The buffer to be sent.
*
* \return On success, this call returns the number of characters sent. On
* error, \p -E_SENDMSG is returned.
*
- * \sa okir's Black Hats Manual
- * \sa sendmsg(2)
+ * \sa sendmsg(2), okir's Black Hats Manual.
*/
ssize_t send_cred_buffer(int sock, char *buf)
{
}
/**
- * receive a buffer and the Unix credentials of the sending process
+ * Receive a buffer and the Unix credentials of the sending process.
*
- * \param fd the socket file descriptor
- * \param buf the buffer to store the message
- * \param size the size of \a buffer
+ * \param fd the socket file descriptor.
+ * \param buf the buffer to store the message.
+ * \param size the size of \a buffer.
*
* \return negative on errors, the user id on success.
*
- * \sa okir's Black Hats Manual
- * \sa recvmsg(2)
+ * \sa recvmsg(2), okir's Black Hats Manual.
*/
int recv_cred_buffer(int fd, char *buf, size_t size)
{
#endif /* HAVE_UCRED */
/**
- * receive a buffer and check for a pattern
+ * Receive a buffer and check for a pattern.
*
- * \param fd the file descriptor to receive from
- * \param pattern the expected pattern
- * \param bufsize the size of the internal buffer
+ * \param fd The file descriptor to receive from.
+ * \param pattern The expected pattern.
+ * \param bufsize The size of the internal buffer.
*
* \return Positive if \a pattern was received, negative otherwise.
*
* If at least \p strlen(\a pattern) bytes were received, the beginning of
* the received buffer is compared with \a pattern, ignoring case.
*
- * \sa recv_buffer()
- * \sa strncasecmp(3)
+ * \sa recv_buffer(), \sa strncasecmp(3).
*/
int recv_pattern(int fd, const char *pattern, size_t bufsize)
{
ret = 1;
out:
if (ret < 0) {
- PARA_NOTICE_LOG("n = %d, did not receive pattern '%s'\n", n, pattern);
+ PARA_NOTICE_LOG("n = %d, did not receive pattern '%s'\n", n,
+ pattern);
if (n > 0)
PARA_NOTICE_LOG("recvd: %s\n", buf);
}
projects / paraslash.git / commitdiff