utils.cpp

Go to the documentation of this file.

/*******************************************************************************
  Copyright(c) 2022 Ludovic Pollet. All rights reserved.
 
 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Library General Public
 License version 2 as published by the Free Software Foundation.
 
 This library 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
 Library General Public License for more details.
 
 You should have received a copy of the GNU Library General Public License
 along with this library; see the file COPYING.LIB.  If not, write to
 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 Boston, MA 02110-1301, USA.
*******************************************************************************/
 
#ifndef _GNU_SOURCE
#define _GNU_SOURCE // needed for siginfo_t and sigaction
#endif
 
#include <unistd.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <netdb.h>
#include <netinet/in.h>
#include <errno.h>
#include <fcntl.h>
#include <sys/socket.h>
#include <signal.h>
#include <system_error>
 
#include "utils.h"
 
void setupSigPipe()
{
    signal(SIGPIPE, SIG_IGN);
}
 
static void initUnixSocketAddr(const std::string &unixAddr, struct sockaddr_un &serv_addr_un, socklen_t &addrlen, bool bind)
{
    memset(&serv_addr_un, 0, sizeof(serv_addr_un));
    serv_addr_un.sun_family = AF_UNIX;
 
#ifdef __linux__
    (void) bind;
 
    // Using abstract socket path to avoid filesystem boilerplate
    strncpy(serv_addr_un.sun_path + 1, unixAddr.c_str(), sizeof(serv_addr_un.sun_path) - 1);
 
    int len = offsetof(struct sockaddr_un, sun_path) + unixAddr.size() + 1;
 
    addrlen = len;
#else
    // Using filesystem socket path
    strncpy(serv_addr_un.sun_path, unixAddr.c_str(), sizeof(serv_addr_un.sun_path) - 1);
 
    int len = offsetof(struct sockaddr_un, sun_path) + unixAddr.size();
 
    if (bind)
    {
        unlink(unixAddr.c_str());
    }
#endif
    addrlen = len;
}
 
 
int unixSocketListen(const std::string &unixAddr)
{
    struct sockaddr_un serv_addr_un;
    socklen_t addrlen;
 
    int sockfd;
    if ((sockfd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Socket");
    }
 
#ifndef __linux__
    fcntl(sockfd, F_SETFD, FD_CLOEXEC);
#endif
 
    int reuse = 1;
    if (setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &reuse, sizeof(reuse)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "setsockopt");
    }
 
    initUnixSocketAddr(unixAddr, serv_addr_un, addrlen, true);
 
    if (bind(sockfd, (struct sockaddr *)&serv_addr_un, addrlen) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Bind to " + unixAddr);
    }
 
    /* willing to accept connections with a backlog of 5 pending */
    if (::listen(sockfd, 5) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Listen to " + unixAddr);
    }
 
    return sockfd;
}
 
int tcpSocketListen(int port)
{
    struct sockaddr_in serv_socket;
    int sockfd;
    int reuse = 1;
 
    /* make socket endpoint */
    if ((sockfd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Socket");
    }
 
    /* bind to given port for any IP address */
    memset(&serv_socket, 0, sizeof(serv_socket));
    serv_socket.sin_family = AF_INET;
    serv_socket.sin_addr.s_addr = htonl(INADDR_ANY);
    serv_socket.sin_port = htons((unsigned short)port);
    if (setsockopt(sockfd, SOL_SOCKET, SO_REUSEADDR, &reuse, sizeof(reuse)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "SO_REUSEADDR");
    }
    if (bind(sockfd, (struct sockaddr *)&serv_socket, sizeof(serv_socket)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Bind to " + std::to_string(port));
    }
 
    /* willing to accept connections with a backlog of 5 pending */
    if (::listen(sockfd, 5) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Listen to " + std::to_string(port));
    }
 
    return sockfd;
}
 
 
int socketAccept(int fd)
{
    /* get a private connection to new client */
    int cli_fd  = ::accept(fd, 0, 0);
    if (cli_fd < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Accept failed");
    }
    return cli_fd;
}
 
int unixSocketConnect(const std::string &unixAddr, bool failAllowed)
{
    struct sockaddr_un serv_addr_un;
    socklen_t addrlen;
 
    int sockfd;
    if ((sockfd = socket(AF_UNIX, SOCK_STREAM, 0)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "Socket");
    }
 
    initUnixSocketAddr(unixAddr, serv_addr_un, addrlen, false);
 
    int ret = ::connect(sockfd, (struct sockaddr *)&serv_addr_un, addrlen);
    if (ret != -1)
    {
        return sockfd;
    }
 
    int e = errno;
    close(sockfd);
    if (!failAllowed)
    {
        throw std::system_error(e, std::generic_category(), "Connect to " + unixAddr);
    }
    return -1;
}
 
void unixSocketSendFds(int fd, int count, int * fds)
{
    struct msghdr msgh;
    struct iovec iov[1];
    char buff[1] = {0};
    int cmsghdrlength;
    struct cmsghdr * cmsgh;
 
 
    cmsghdrlength = CMSG_SPACE((count * sizeof(int)));
    // FIXME: abort on alloc error here
    cmsgh = (struct cmsghdr*)malloc(cmsghdrlength);
 
    /* Write the fd as ancillary data */
    cmsgh->cmsg_len = CMSG_LEN(count * sizeof(int));
    cmsgh->cmsg_level = SOL_SOCKET;
    cmsgh->cmsg_type = SCM_RIGHTS;
    msgh.msg_control = cmsgh;
    msgh.msg_controllen = cmsghdrlength;
    for(int i = 0; i < count; ++i)
    {
        ((int *) CMSG_DATA(CMSG_FIRSTHDR(&msgh)))[i] = fds[i];
    }
 
    iov[0].iov_base = buff;
    iov[0].iov_len = 1;
 
    msgh.msg_flags = 0;
    msgh.msg_name = NULL;
    msgh.msg_namelen = 0;
    msgh.msg_iov = iov;
    msgh.msg_iovlen = 1;
 
    int ret = sendmsg(fd, &msgh,  MSG_NOSIGNAL);
 
    if (ret == -1)
    {
        throw std::system_error(errno, std::generic_category(), "Failed to send fds");
    }
    if (ret == 0)
    {
        throw std::runtime_error("Channel closed when sending fds");
    }
}
 
void unixSocketRecvFds(int fd, int count, int * fdsDest)
{
    char buf[1];
    struct msghdr msgh;
    struct iovec iov;
 
    union
    {
        struct cmsghdr cmsgh;
        /* Space large enough to hold an 'int' */
        char control[CMSG_SPACE(16 * sizeof(int))];
    } control_un;
 
    if (count > 16)
    {
        throw std::runtime_error("Cannot pass that amount of fds");
    }
 
 
 
    iov.iov_base = buf;
    iov.iov_len = 1;
 
    msgh.msg_name = NULL;
    msgh.msg_namelen = 0;
    msgh.msg_iov = &iov;
    msgh.msg_iovlen = 1;
    msgh.msg_flags = 0;
    msgh.msg_control = control_un.control;
    msgh.msg_controllen = sizeof(control_un.control);
 
    int recvflag;
#ifdef __linux__
    recvflag = MSG_CMSG_CLOEXEC;
#else
    recvflag = 0;
#endif
 
    int size = recvmsg(fd, &msgh, recvflag);
    if (size == -1)
    {
        throw std::system_error(errno, std::generic_category(), "Could not receive fds");
    }
 
    for (struct cmsghdr * cmsg = CMSG_FIRSTHDR(&msgh); cmsg != NULL; cmsg = CMSG_NXTHDR(&msgh, cmsg))
    {
        if (cmsg->cmsg_level == SOL_SOCKET && cmsg->cmsg_type == SCM_RIGHTS)
        {
            int fdCount = 0;
            while(cmsg->cmsg_len >= CMSG_LEN((fdCount + 1) * sizeof(int)))
            {
                fdCount++;
            }
            fprintf(stderr, "Received fd : %d\n", fdCount);
            if (fdCount != count)
            {
                throw std::runtime_error("Wrong number of fds received");
            }
            int * fds = (int*)CMSG_DATA(cmsg);
            for(int i = 0; i < fdCount; ++i)
            {
#ifndef __linux__
                fcntl(fds[i], F_SETFD, FD_CLOEXEC);
#endif
                fdsDest[i] = fds[i];
            }
 
            return;
        }
    }
    throw std::runtime_error("Did not receive fds");
}
 
int tcpSocketConnect(const std::string &host, int port, bool failAllowed)
{
    struct sockaddr_in serv_addr;
    int sockfd;
 
    /* lookup host address */
    auto hp = gethostbyname(host.c_str());
    if (!hp)
    {
        throw std::system_error(h_errno, std::generic_category(), "Could not resolve " + host);
    }
 
    /* create a socket to the INDI server */
    (void)memset((char *)&serv_addr, 0, sizeof(serv_addr));
    serv_addr.sin_family      = AF_INET;
    serv_addr.sin_addr.s_addr = ((struct in_addr *)(hp->h_addr_list[0]))->s_addr;
    serv_addr.sin_port        = htons(port);
    if ((sockfd = socket(AF_INET, SOCK_STREAM, 0)) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "socket");
    }
 
    /* connect */
    if (connect(sockfd, (struct sockaddr *)&serv_addr, sizeof(serv_addr)) < 0)
    {
        if (!failAllowed)
        {
            throw std::system_error(errno, std::generic_category(), "Connect to " + host);
        }
        auto e = errno;
        close(sockfd);
        errno = e;
        return -1;
    }
 
    return sockfd;
}
 
 
int tcpSocketPort(int fd)
{
    struct sockaddr_in addr;
    socklen_t len = sizeof(addr);
    if (getsockname(fd, (struct sockaddr *)&addr, &len) < 0)
    {
        throw std::system_error(errno, std::generic_category(), "getsockname");
    }
    return ntohs(addr.sin_port);
}
 
int findFreeTcpPort()
{
    // Let the kernel pick a free port, then release it for the process under test
    int fd = tcpSocketListen(0);
    int port = tcpSocketPort(fd);
    close(fd);
    return port;
}
 
std::string uniqueTestName(const std::string &prefix)
{
    return prefix + "-" + std::to_string(getpid());
}