Add foreground option to daemon
[guacd.git] / src / daemon.c
index 4364eee..018f624 100644 (file)
@@ -20,6 +20,7 @@
  * the Initial Developer. All Rights Reserved.
  *
  * Contributor(s):
+ *  David PHAM-VAN <d.pham-van@ulteo.com> Ulteo SAS - http://www.ulteo.com
  *
  * Alternatively, the contents of this file may be used under the terms of
  * either the GNU General Public License Version 2 or later (the "GPL"), or
 #include <stdlib.h>
 #include <stdio.h>
 #include <string.h>
+#include <signal.h>
 #include <sys/types.h>
 
-#ifdef __MINGW32__
-#include <winsock2.h>
-#else
 #include <sys/socket.h>
+#include <netdb.h>
 #include <netinet/in.h>
-#endif
-
-#ifdef HAVE_LIBPTHREAD
-#include <pthread.h>
-#elif defined(__MINGW32__)
-#include <windows.h>
-#include <process.h>
-#endif
 
 #include <errno.h>
+#include <syslog.h>
+#include <libgen.h>
 
 #include <guacamole/client.h>
-#include <guacamole/log.h>
-
-/* Windows / MINGW32 handles closing sockets differently */ 
-#ifdef __MINGW32__
-#define CLOSE_SOCKET(socket) closesocket(socket)
-#else
-#define CLOSE_SOCKET(socket) close(socket)
-#endif
-
-
-/* Cross-platform strerror()/errno clone */
-char error[65536];
-char* lasterror() {
-#ifdef __MINGW32__
-    snprintf(error, sizeof(error)-1, "ERROR #%i", GetLastError());
-    return error;
-#else
-    return strerror(errno);
-#endif
-}
+#include <guacamole/error.h>
 
+#include "client.h"
+#include "log.h"
 
-typedef struct client_thread_data {
+void guacd_handle_connection(int fd) {
 
-    int fd;
+    guac_client* client;
+    guac_client_plugin* plugin;
+    guac_instruction* select;
+    guac_instruction* connect;
 
-} client_thread_data;
+    /* Open guac_socket */
+    guac_socket* socket = guac_socket_open(fd);
 
+    /* Get protocol from select instruction */
+    select = guac_protocol_expect_instruction(
+            socket, GUACD_USEC_TIMEOUT, "select");
+    if (select == NULL) {
 
-void* start_client_thread(void* data) {
+        /* Log error */
+        guacd_log_guac_error("Error reading \"select\"");
 
-    guac_client* client;
-    client_thread_data* thread_data = (client_thread_data*) data;
+        /* Free resources */
+        guac_socket_close(socket);
+        return;
+    }
+
+    /* Validate args to select */
+    if (select->argc != 1) {
+
+        /* Log error */
+        guacd_log_error("Bad number of arguments to \"select\" (%i)",
+                select->argc);
+
+        /* Free resources */
+        guac_socket_close(socket);
+        return;
+    }
+
+    guacd_log_info("Protocol \"%s\" selected", select->argv[0]);
+
+    /* Get plugin from protocol in select */
+    plugin = guac_client_plugin_open(select->argv[0]);
+    guac_instruction_free(select);
+
+    if (plugin == NULL) {
+
+        /* Log error */
+        guacd_log_guac_error("Error loading client plugin");
+
+        /* Free resources */
+        guac_socket_close(socket);
+        return;
+    }
+
+    /* Send args response */
+    if (guac_protocol_send_args(socket, plugin->args)
+            || guac_socket_flush(socket)) {
 
-    GUAC_LOG_INFO("Spawning client");
+        /* Log error */
+        guacd_log_guac_error("Error sending \"args\"");
 
-    /* Load and start client */
-    client = guac_get_client(thread_data->fd); 
+        if (guac_client_plugin_close(plugin))
+            guacd_log_guac_error("Error closing client plugin");
+
+        guac_socket_close(socket);
+        return;
+    }
+
+    /* Get args from connect instruction */
+    connect = guac_protocol_expect_instruction(
+            socket, GUACD_USEC_TIMEOUT, "connect");
+    if (connect == NULL) {
+
+        /* Log error */
+        guacd_log_guac_error("Error reading \"connect\"");
+
+        if (guac_client_plugin_close(plugin))
+            guacd_log_guac_error("Error closing client plugin");
+
+        guac_socket_close(socket);
+        return;
+    }
+
+    /* Load and init client */
+    client = guac_client_plugin_get_client(plugin, socket,
+            connect->argc, connect->argv,
+            guacd_client_log_info, guacd_client_log_error);
+
+    guac_instruction_free(connect);
 
     if (client == NULL) {
-        GUAC_LOG_ERROR("Client retrieval failed");
-        return NULL;
+
+        guacd_log_guac_error("Error instantiating client");
+
+        if (guac_client_plugin_close(plugin))
+            guacd_log_guac_error("Error closing client plugin");
+
+        guac_socket_close(socket);
+        return;
     }
 
-    guac_start_client(client);
+    /* Start client threads */
+    guacd_log_info("Starting client");
+    if (guacd_client_start(client))
+        guacd_log_error("Client finished abnormally");
+    else
+        guacd_log_info("Client finished normally");
 
-    guac_free_client(client);
+    /* Clean up */
+    guac_client_free(client);
+    if (guac_client_plugin_close(plugin))
+        guacd_log_error("Error closing client plugin");
 
     /* Close socket */
-    if (CLOSE_SOCKET(thread_data->fd) < 0) {
-        GUAC_LOG_ERROR("Error closing connection: %s", lasterror());
-        free(data);
-        return NULL;
-    }
+    guac_socket_close(socket);
 
-    GUAC_LOG_INFO("Client finished");
-    free(data);
-    return NULL;
+    return;
 
 }
 
@@ -123,129 +178,191 @@ int main(int argc, char* argv[]) {
 
     /* Server */
     int socket_fd;
-    struct sockaddr_in server_addr;
+    struct addrinfo* addresses;
+    struct addrinfo* current_address;
+    char bound_address[1024];
+    char bound_port[64];
     int opt_on = 1;
 
+    struct addrinfo hints = {
+        .ai_family   = AF_UNSPEC,
+        .ai_socktype = SOCK_STREAM,
+        .ai_protocol = IPPROTO_TCP
+    };
+
     /* Client */
     struct sockaddr_in client_addr;
-    unsigned int client_addr_len;
+    socklen_t client_addr_len;
     int connected_socket_fd;
 
     /* Arguments */
-    int listen_port = 4822; /* Default port */
+    char* listen_address = NULL; /* Default address of INADDR_ANY */
+    char* listen_port = "4822";  /* Default port */
+    char* pidfile = NULL;
     int opt;
+    int foreground = 0;
 
-    char* pidfile = NULL;
+    /* General */
+    int retval;
 
     /* Daemon Process */
     pid_t daemon_pid;
 
-#ifdef __MINGW32__
-    /* Structure for holding winsock version info */
-    WSADATA wsadata;
-#endif
-
     /* Parse arguments */
-    while ((opt = getopt(argc, argv, "l:p:")) != -1) {
+    while ((opt = getopt(argc, argv, "l:b:p:f")) != -1) {
         if (opt == 'l') {
-            listen_port = atoi(optarg);
-            if (listen_port <= 0) {
-                fprintf(stderr, "Invalid port: %s\n", optarg);
-                exit(EXIT_FAILURE);
-            }
+            listen_port = strdup(optarg);
+        }
+        else if (opt == 'b') {
+            listen_address = strdup(optarg);
+        }
+        else if (opt == 'f') {
+            foreground = 1;
         }
         else if (opt == 'p') {
             pidfile = strdup(optarg);
         }
         else {
-            fprintf(stderr, "USAGE: %s [-l LISTENPORT] [-p PIDFILE]\n", argv[0]);
+
+            fprintf(stderr, "USAGE: %s"
+                    " [-l LISTENPORT]"
+                    " [-b LISTENADDRESS]"
+                    " [-f foreground]"
+                    " [-p PIDFILE]\n", argv[0]);
+
             exit(EXIT_FAILURE);
         }
     }
 
-    /* Get binding address */
-    memset(&server_addr, 0, sizeof(server_addr)); /* Zero struct */
-    server_addr.sin_family = AF_INET;
-    server_addr.sin_addr.s_addr = INADDR_ANY;
-    server_addr.sin_port = htons(listen_port);
+    /* Set up logging prefix */
+    strncpy(log_prefix, basename(argv[0]), sizeof(log_prefix));
 
-#ifdef __MINGW32__
-    /* If compiling for Windows, init winsock. */
-    if (WSAStartup(MAKEWORD(1,1), &wsadata) == SOCKET_ERROR) {
-        fprintf(stderr, "Error creating socket.");
+
+    /* Get addresses for binding */
+    if ((retval = getaddrinfo(listen_address, listen_port, &hints, &addresses))) {
+        guacd_log_error("Error parsing given address or port: %s",
+                gai_strerror(retval));
         exit(EXIT_FAILURE);
     }
-#endif
 
     /* Get socket */
     socket_fd = socket(AF_INET, SOCK_STREAM, 0);
     if (socket_fd < 0) {
-        fprintf(stderr, "Error opening socket: %s\n", lasterror());
+        guacd_log_error("Error opening socket: %s", strerror(errno));
         exit(EXIT_FAILURE);
     }
 
-    if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, &opt_on, sizeof(opt_on))) {
-        fprintf(stderr, "Warning: Unable to set socket options for reuse: %s\n", lasterror());
+    /* Allow socket reuse */
+    if (setsockopt(socket_fd, SOL_SOCKET, SO_REUSEADDR, (void*) &opt_on, sizeof(opt_on))) {
+        guacd_log_info("Unable to set socket options for reuse: %s", strerror(errno));
     }
 
-    /* Bind socket to address */
-    if (bind(socket_fd, (struct sockaddr*) &server_addr,
-                sizeof(server_addr)) < 0) {
-        fprintf(stderr, "Error binding socket: %s\n", lasterror());
-        exit(EXIT_FAILURE);
-    } 
+    /* Attempt binding of each address until success */
+    current_address = addresses;
+    while (current_address != NULL) {
+
+        int retval;
+
+        /* Resolve hostname */
+        if ((retval = getnameinfo(current_address->ai_addr,
+                current_address->ai_addrlen,
+                bound_address, sizeof(bound_address),
+                bound_port, sizeof(bound_port),
+                NI_NUMERICHOST | NI_NUMERICSERV)))
+            guacd_log_error("Unable to resolve host: %s",
+                    gai_strerror(retval));
+
+        /* Attempt to bind socket to address */
+        if (bind(socket_fd,
+                    current_address->ai_addr,
+                    current_address->ai_addrlen) == 0) {
+
+            guacd_log_info("Successfully bound socket to "
+                    "host %s, port %s", bound_address, bound_port);
+
+            /* Done if successful bind */
+            break;
+
+        }
+
+        /* Otherwise log information regarding bind failure */
+        else
+            guacd_log_info("Unable to bind socket to "
+                    "host %s, port %s: %s",
+                    bound_address, bound_port, strerror(errno));
 
-    /* Fork into background */
-#ifdef HAVE_FORK
-    daemon_pid = fork();
+        current_address = current_address->ai_next;
 
-    /* If error, fail */
-    if (daemon_pid == -1) {
-        fprintf(stderr, "Error forking daemon process: %s\n", lasterror());
+    }
+
+    /* If unable to bind to anything, fail */
+    if (current_address == NULL) {
+        guacd_log_error("Unable to bind socket to any addresses.");
         exit(EXIT_FAILURE);
     }
 
-    /* If parent, write PID file and exit */
-    else if (daemon_pid != 0) {
+    if (!foreground) {
+        /* Fork into background */
+        daemon_pid = fork();
+
+        /* If error, fail */
+        if (daemon_pid == -1) {
+            guacd_log_error("Error forking daemon process: %s", strerror(errno));
+            exit(EXIT_FAILURE);
+        }
+
+        /* If parent, write PID file and exit */
+        else if (daemon_pid != 0) {
 
-        if (pidfile != NULL) {
+            if (pidfile != NULL) {
 
-            /* Attempt to open pidfile and write PID */
-            FILE* pidf = fopen(pidfile, "w");
-            if (pidf) {
-                fprintf(pidf, "%d\n", daemon_pid);
-                fclose(pidf);
-            }
+                /* Attempt to open pidfile and write PID */
+                FILE* pidf = fopen(pidfile, "w");
+                if (pidf) {
+                    fprintf(pidf, "%d\n", daemon_pid);
+                    fclose(pidf);
+                }
+
+                /* Warn on failure */
+                else {
+                    guacd_log_error("Could not write PID file: %s", strerror(errno));
+                    exit(EXIT_FAILURE);
+                }
 
-            /* Warn on failure */
-            else {
-                fprintf(stderr, "WARNING: Could not write PID file: %s\n", lasterror());
-                exit(EXIT_FAILURE);
             }
 
+            exit(EXIT_SUCCESS);
         }
+    }
+
+    /* Open log */
+    openlog(NULL, LOG_PID, LOG_DAEMON);
+
+    /* Ignore SIGPIPE */
+    if (signal(SIGPIPE, SIG_IGN) == SIG_ERR) {
+        guacd_log_info("Could not set handler for SIGPIPE to ignore. SIGPIPE may cause termination of the daemon.");
+    }
 
-        exit(EXIT_SUCCESS);
+    /* Ignore SIGCHLD (force automatic removal of children) */
+    if (signal(SIGCHLD, SIG_IGN) == SIG_ERR) {
+        guacd_log_info("Could not set handler for SIGCHLD to ignore. Child processes may pile up in the process table.");
     }
-#else
-    GUAC_LOG_INFO("fork() not defined at compile time.");
-    GUAC_LOG_INFO("guacd running in foreground only.");
-#endif
 
-    /* Otherwise, this is the daemon */
-    GUAC_LOG_INFO("Started, listening on port %i", listen_port);
+    /* Log listening status */
+    syslog(LOG_INFO,
+            "Listening on host %s, port %s", bound_address, bound_port);
+
+    /* Free addresses */
+    freeaddrinfo(addresses);
 
     /* Daemon loop */
     for (;;) {
 
-#ifdef HAVE_LIBPTHREAD
-        pthread_t thread;
-#endif
-        client_thread_data* data;
+        pid_t child_pid;
 
         /* Listen for connections */
         if (listen(socket_fd, 5) < 0) {
-            GUAC_LOG_ERROR("Could not listen on socket: %s", lasterror());
+            guacd_log_error("Could not listen on socket: %s", strerror(errno));
             return 3;
         }
 
@@ -253,37 +370,42 @@ int main(int argc, char* argv[]) {
         client_addr_len = sizeof(client_addr);
         connected_socket_fd = accept(socket_fd, (struct sockaddr*) &client_addr, &client_addr_len);
         if (connected_socket_fd < 0) {
-            GUAC_LOG_ERROR("Could not accept client connection: %s", lasterror());
+            guacd_log_error("Could not accept client connection: %s", strerror(errno));
             return 3;
         }
 
-        data = malloc(sizeof(client_thread_data));
-        data->fd = connected_socket_fd;
-
-#ifdef HAVE_LIBPTHREAD
-        if (pthread_create(&thread, NULL, start_client_thread, (void*) data)) {
-            GUAC_LOG_ERROR("Could not create client thread: %s", lasterror());
-            return 3;
+        /* 
+         * Once connection is accepted, send child into background.
+         *
+         * Note that we prefer fork() over threads for connection-handling
+         * processes as they give each connection its own memory area, and
+         * isolate the main daemon and other connections from errors in any
+         * particular client plugin.
+         */
+
+        child_pid = fork();
+
+        /* If error, log */
+        if (child_pid == -1)
+            guacd_log_error("Error forking child process: %s", strerror(errno));
+
+        /* If child, start client, and exit when finished */
+        else if (child_pid == 0) {
+            guacd_handle_connection(connected_socket_fd);
+            close(connected_socket_fd);
+            return 0;
         }
 
-        pthread_detach(thread);
-#elif __MINGW32__
-        if (_beginthread(start_client_thread, 0, (void*) data) == -1L) { 
-            GUAC_LOG_ERROR("Could not create client thread: %s", lasterror());
-            return 3;
+        /* If parent, close reference to child's descriptor */
+        else if (close(connected_socket_fd) < 0) {
+            guacd_log_error("Error closing daemon reference to child descriptor: %s", strerror(errno));
         }
-#else
-#warning THREAD SUPPORT NOT FOUND! guacd will only be able to handle one connection at a time.
-        GUAC_LOG_INFO("Thread support not present at compile time.");
-        GUAC_LOG_INFO("guacd handling one connection at a time.");
-        start_client_thread(data);
-#endif
 
     }
 
     /* Close socket */
-    if (CLOSE_SOCKET(socket_fd) < 0) {
-        GUAC_LOG_ERROR("Could not close socket: %s", lasterror());
+    if (close(socket_fd) < 0) {
+        guacd_log_error("Could not close socket: %s", strerror(errno));
         return 3;
     }