libt2n: (gerd) add client timeouts & tests, hello peek missing
[libt2n] / src / socket_server.cpp
index f0e573b..0eff676 100644 (file)
 
 #include "socket_server.hxx"
 #include "t2n_exception.hxx"
+#include "log.hxx"
 
 using namespace std;
 
 namespace libt2n
 {
 
-socket_server::socket_server(int port, const char* ip)
-    : server()
+/** @brief create a new tcp-based server
+    @param port tcp port you want to listen on
+    @param ip the local ip you want to listen on. "0.0.0.0" means all local ips (default).
+*/
+socket_server::socket_server(int port, const std::string& ip)
+    : server(), socket_handler(0,tcp_s)
 {
-    socket_type=tcp_s;
+    /* Create the socket. */
+    sock = socket (PF_INET, SOCK_STREAM, 0);
+    if (sock < 0)
+        EXCEPTIONSTREAM(error,t2n_server_error,"error opening socket: " << strerror(errno));
+
+    set_socket_options(sock);
+
+    /* Give the socket a name. */
+    struct sockaddr_in sockaddr;
+    sockaddr.sin_family = AF_INET;
+    sockaddr.sin_port = htons(port);
+
+    if (inet_aton(ip.c_str(),&sockaddr.sin_addr) == 0)
+        EXCEPTIONSTREAM(error,t2n_server_error,"failed listening on invalid ip " << ip);
+
+    if (bind (sock, (struct sockaddr *) &sockaddr, sizeof (sockaddr)) < 0)
+        EXCEPTIONSTREAM(error,t2n_server_error,"error binding socket: " << strerror(errno));
 
+    start_listening();
 }
 
-socket_server::socket_server(const char* path, mode_t filemode, const char* user, const char* group)
-    : server()
+/** @brief create a new unix-socked-based server
+    @param path path of the socket
+    @param filemode permissions you want to open the socket with
+    @param user local username for the socket
+    @param group local groupname for the socket
+*/
+socket_server::socket_server(const std::string& path, mode_t filemode, const std::string& user, const std::string& group)
+    : server(), socket_handler(0,unix_s)
 {
-    socket_type=unix_s;
     unix_path=path;
 
     /* Create the socket. */
     sock = socket (PF_UNIX, SOCK_STREAM, 0);
     if (sock < 0)
-    {
-        string err="error opening socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_server_error,"error opening socket: " << strerror(errno));
 
     set_socket_options(sock);
 
@@ -77,130 +99,51 @@ socket_server::socket_server(const char* path, mode_t filemode, const char* user
     unlink (unix_name.sun_path);
 
     if (bind (sock, (struct sockaddr *) &unix_name, sizeof (unix_name)) < 0)
-    {
-        string err="error binding socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_server_error,"error binding socket: " << strerror(errno));
 
     /* change permissions */
     if (chmod (unix_name.sun_path, filemode) != 0) 
-    {
-        string err="error changing permission: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+        EXCEPTIONSTREAM(error,t2n_server_error,"error changing permission: " << strerror(errno));
 
-    struct passwd *socket_user = getpwnam (user);
-    if (socket_user == NULL) 
+    if (!user.empty() && !group.empty())
     {
-        string err="error getting socket user: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+        // TODO maybe use current user/group if one of them is empty
 
-    struct group *socket_group = getgrnam (group);
-    if (socket_group == NULL) 
-    {
-        string err="error getting socket group: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+        struct passwd *socket_user = getpwnam (user.c_str());
+        if (socket_user == NULL) 
+            EXCEPTIONSTREAM(error,t2n_server_error,"error getting socket user: " << strerror(errno));
 
-    if (chown (unix_name.sun_path, socket_user->pw_uid, socket_group->gr_gid) != 0) 
-    {
-        string err="error changing socket ownership: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+        struct group *socket_group = getgrnam (group.c_str());
+        if (socket_group == NULL) 
+            EXCEPTIONSTREAM(error,t2n_server_error,"error getting socket group: " << strerror(errno));
 
-    if (listen (sock, 5) < 0)
-    {
-        string err="error listening to socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
+        if (chown (unix_name.sun_path, socket_user->pw_uid, socket_group->gr_gid) != 0) 
+            EXCEPTIONSTREAM(error,t2n_server_error,"error changing socket ownership: " << strerror(errno));
     }
 
-    /* clear & insert server sock into the fd_tab to prepare select */
-    FD_ZERO(&connection_set);
-    FD_SET (sock, &connection_set);
+    start_listening();
 }
 
-void socket_server::set_socket_options(int sock)
+socket_server::~socket_server()
 {
-    int i=1;
-
-    /* fast reuse enable */
-    if (setsockopt(sock,SOL_SOCKET, SO_REUSEADDR, &i, sizeof(i)) < 0)
-    {
-        string err="error setting socket option: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-
-    /* keepalive enable */
-    if (setsockopt(sock,SOL_SOCKET, SO_KEEPALIVE, &i, sizeof(i)) < 0)
-    {
-        string err="error setting socket option: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-
-    /* close on exec */
-    int fdflags;
-    fdflags=fcntl(sock,F_GETFD, 0);
-    if (fdflags < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-    fdflags |= FD_CLOEXEC;
-    if (fcntl(sock,F_SETFD,fdflags) < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+    socket_handler::close();
 
-    /* non-blocking mode */
-    int flflags;
-    flflags=fcntl(sock,F_GETFL,0);
-    if (flflags < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-    flflags |= O_NONBLOCK;
-    if (fcntl(sock,F_SETFL,flflags) < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
+    if (get_type()==unix_s)
+        unlink(unix_path.c_str());
 }
 
-socket_server::~socket_server()
+/// start listening on a new server socket (called by the constructors)
+void socket_server::start_listening()
 {
-    close(sock);
+    if (listen (sock, 5) < 0)
+        EXCEPTIONSTREAM(error,t2n_server_error,"error listening to socket: " << strerror(errno));
 
-    if (socket_type==unix_s)
-        unlink(unix_path.c_str());
+    /* clear & insert server sock into the fd_tab to prepare select */
+    FD_ZERO(&connection_set);
+    FD_SET (sock, &connection_set);
 }
 
+/// handle a new connection from a client
 void socket_server::new_connection()
 {
     struct sockaddr_un clientname;
@@ -211,74 +154,34 @@ void socket_server::new_connection()
     {
         if (errno == EAGAIN)
         {
-            log(error, "accept error (EAGAIN): no connection waiting");
+            LOGSTREAM(error,"accept error (EAGAIN): no connection waiting");
             return;
         }
 
         /* default: break */
-        string err="error accepting connection: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
+        EXCEPTIONSTREAM(error,t2n_server_error,"error accepting connection: " << strerror(errno));
     }
 
     FD_SET (newsock, &connection_set);
 
-    int i=1;
+    socket_server_connection *nc=new socket_server_connection(newsock, get_type(), get_default_timeout());
+    nc->set_socket_options(newsock);
 
-    /* keepalive enable */
-    if (setsockopt(newsock,SOL_SOCKET, SO_KEEPALIVE, &i, sizeof(i)) < 0)
-    {
-        string err="error setting socket option: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-
-    /* close on exec */
-    int fdflags;
-    fdflags=fcntl(newsock,F_GETFD, 0);
-    if (fdflags < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-    fdflags |= FD_CLOEXEC;
-    if (fcntl(newsock,F_SETFD,fdflags) < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-
-    /* non-blocking mode */
-    int flflags;
-    flflags=fcntl(newsock,F_GETFL,0);
-    if (flflags < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-    flflags |= O_NONBLOCK;
-    if (fcntl(newsock,F_SETFL,flflags) < 0)
-    {
-        string err="fcntl error on socket: ";
-        err+=strerror(errno);
-        log(error, err);
-        throw t2n_server_error(err);
-    }
-
-    add_connection(new socket_connection(newsock, get_default_timeout()));
+    add_connection(nc);
 
     return;
 }
 
-void socket_server::fill_buffer(long long usec_timeout)
+/** @brief look for new connections and new data in any of the existing connections
+    @param usec_timeout wait until new data is found, max timeout usecs.
+            -1: wait endless
+            0: return instantly
+    @param usec_timeout_remaining if non-NULL the function will write the
+            not used time to the given target
+    @retval true if new data was found (does not mean that the received data 
+            is a complete packet though)
+*/
+bool socket_server::fill_buffer(long long usec_timeout,long long* usec_timeout_remaining)
 {
     fd_set used_fdset=connection_set;
 
@@ -299,6 +202,10 @@ void socket_server::fill_buffer(long long usec_timeout)
 
     int ret=select (FD_SETSIZE, &used_fdset, NULL, NULL, timeout_ptr);
 
+    // return the timeout we did not use
+    if (usec_timeout > 0 && usec_timeout_remaining != NULL)
+        *usec_timeout_remaining=(tval.tv_sec*1000000)+tval.tv_usec;
+
     if (ret < 0)
     {
         if (errno == EINTR)
@@ -307,12 +214,7 @@ void socket_server::fill_buffer(long long usec_timeout)
             ret=0;
         }
         else
-        {
-            string err="select error: ";
-            err+=strerror(errno);
-            log(error, err);
-            throw t2n_server_error(err);
-        }
+            EXCEPTIONSTREAM(error,t2n_server_error,"select error: " << strerror(errno));
     }
 
     if (ret > 0)
@@ -326,152 +228,45 @@ void socket_server::fill_buffer(long long usec_timeout)
         }
 
         // check all connections for pending data
-        fill_connection_buffers();
+        return fill_connection_buffers();
     }
 
-    return;
+    return false;
 }
 
-void socket_server::fill_connection_buffers()
+/// call fill_buffer() on all connections, called from fill_buffer()
+bool socket_server::fill_connection_buffers()
 {
-    std::map<unsigned int, connection*>::iterator ie=connections.end();
-    for(std::map<unsigned int, connection*>::iterator i=connections.begin(); i != ie; i++)
-        if (!i->second->is_closed())
-        {
-            socket_connection* cp=dynamic_cast<socket_connection*>(i->second);
-            cp->fill_buffer(connection_set);
-        }
-}
+    bool data_found;
 
-socket_connection::socket_connection(int _sock, int _timeout)
-    : connection(_timeout)
-{
-    sock=_sock;
+    std::map<unsigned int, server_connection*>::iterator ie=connections.end();
+    for(std::map<unsigned int, server_connection*>::iterator i=connections.begin(); i != ie; i++)
+        if (!i->second->server_connection::is_closed())
+            if (i->second->fill_buffer(0))
+                data_found=true;
+
+    return data_found;
 }
 
-void socket_connection::close()
+/// remove the socket of a connection after the connection has been closed
+void socket_server::remove_connection_socket(int sock)
 {
-
+    FD_CLR(sock, &connection_set);
 }
 
-void socket_connection::fill_buffer(fd_set &cur_fdset)
+/// close this connection. complete data waiting in the buffer can still be retrieved.
+void socket_server_connection::close()
 {
-    bool try_again=false;
-
-    if (is_closed() || !FD_ISSET (sock, &cur_fdset))
-        return;                                                // no data pending or connection closed
-
-    // data pending -> go and get it
-    char socket_buffer[recv_buffer_size];
-
-    int nbytes = read (sock, socket_buffer, recv_buffer_size);
-    if (nbytes < 0)
+    if (!server_connection::is_closed())
     {
-        if (errno == EAGAIN)
-        {
-            if (my_server)
-                my_server->log(server::error,"read error: no data (EAGAIN) for connection "+get_id_string());
-            return;
-        }
-        else if (errno == EINTR)
-        {
-            // interrupted, try again
-            try_again=true;
-        }
-        else
-        {
-            if (my_server)
-                my_server->log(server::error,"error reading from socket of connection "+get_id_string()+": "+strerror(errno));
-            return;
-        }
+        socket_handler::close();
+        server_connection::close();
     }
 
-    // End-of-file
-    if (nbytes == 0 && !try_again)
+    if (my_server)
     {
-        close();
-        return;
+        dynamic_cast<socket_server*>(my_server)->remove_connection_socket(sock);
     }
-
-    // Data read -> store it
-    if (nbytes > 0)
-        buffer.assign(socket_buffer,nbytes);
-
-    // more data waiting?
-    fd_set active_fd_set;
-    struct timeval tval;
-
-    FD_ZERO (&active_fd_set);
-    FD_SET (sock, &active_fd_set);
-
-    /* no waiting */
-    tval.tv_sec=0;
-    tval.tv_usec=0;
-
-    if (select (FD_SETSIZE, &active_fd_set, NULL, NULL, &tval) >0)
-    {
-        /* more data waiting -> recurse */
-        fill_buffer(active_fd_set);
-    }
-
-    reset_timeout();
-
-    return;
-}
-
-void socket_connection::write(const std::string& data)
-{
-    static const unsigned int write_block_size=4096;
-
-    if (is_closed())
-        return;
-
-    // prepend packet size to data
-    packet_size_indicator psize=data.size();
-    string send_data(data);
-    send_data.insert(0,(char*)psize,sizeof(packet_size_indicator));
-
-    int offset = 0;
-    while (offset < send_data.size())
-    {
-        unsigned int write_size=write_block_size;
-
-        if (offset+write_size > send_data.size())
-            write_size = send_data.size()-offset;
-
-        int rtn;
-        while ((rtn=::write(sock, send_data.data()+offset, write_size)) &&
-               rtn == -1 && (errno == EAGAIN || errno == EINTR))
-        {
-            usleep (80000);
-            if (my_server)
-                my_server->log(server::debug,"resuming write() call after EAGAIN or EINTR for connection "+get_id_string());
-        }
-
-        if (rtn == -1)
-        {
-            if (my_server)
-                my_server->log(server::error,"write() error on connection "+get_id_string()+": "+strerror(errno));
-        }
-        else if (rtn != write_size)
-        {
-            if (my_server)
-            {
-                ostringstream msg;
-                msg << "write() error on connection " << get_id() 
-                    << ": wrote " << rtn << " bytes, should have been " 
-                    << write_size << " (complete: " << send_data.size() << ")";
-
-                my_server->log(server::error,msg.str());
-            }
-        }
-
-        offset += write_size;
-    }
-
-    reset_timeout();
-
-    return;
 }
 
 }