Changeset 765

Timestamp:

09/24/05 23:58:47 (3 years ago)

Author:

minaguib

Message:

Merged branch "wdctlrestart":

* New wdctl command "restart" which will get wifidog to restart itself while preserving the existing clientlist. Perfect for 0-downtime upgrading!
* safe.c: New safe_fork that croaks if the fork fails, also takes care of closing some global file descriptors for the child
* debug.c: Now also logs the PID as part of every entry
* gateway.c: Handler for SIGCHLD now waitpid()s with WNOHANG flag to prevent deadlock when the handler is called and another wait() or waitpid() is used
* util.c: execute() now uses waitpid() instead of wait() to reap only the child it fork/executed
* Extra debugging entries throughout code

Files:

• trunk/wifidog/ChangeLog (modified) (1 diff)
• trunk/wifidog/src/client_list.c (modified) (2 diffs)
• trunk/wifidog/src/client_list.h (modified) (1 diff)
• trunk/wifidog/src/commandline.c (modified) (3 diffs)
• trunk/wifidog/src/conf.c (modified) (1 diff)
• trunk/wifidog/src/conf.h (modified) (2 diffs)
• trunk/wifidog/src/debug.c (modified) (1 diff)
• trunk/wifidog/src/firewall.c (modified) (4 diffs)
• trunk/wifidog/src/fw_iptables.c (modified) (2 diffs)
• trunk/wifidog/src/gateway.c (modified) (14 diffs)
• trunk/wifidog/src/safe.c (modified) (2 diffs)
• trunk/wifidog/src/safe.h (modified) (2 diffs)
• trunk/wifidog/src/util.c (modified) (4 diffs)
• trunk/wifidog/src/wdctl.c (modified) (5 diffs)
• trunk/wifidog/src/wdctl.h (modified) (1 diff)
• trunk/wifidog/src/wdctl_thread.c (modified) (3 diffs)

trunk/wifidog/ChangeLog

@@ -1 +1 @@
-# $Header$
+
+2005-09-24 Mina Naguib <mina@ilesansfil.org>
+        * New wdctl command "restart" which will get wifidog to restart itself
+        while preserving the existing clientlist.  Perfect for 0-downtime
+        upgrading!
+        * safe.c: New safe_fork that croaks if the fork fails, also takes care of
+        closing some global file descriptors for the child
+        * debug.c: Now also logs the PID as part of every entry
+        * gateway.c: Handler for SIGCHLD now waitpid()s with WNOHANG flag to prevent deadlock
+        when the handler is called and another wait() or waitpid() is used
+        * util.c: execute() now uses waitpid() instead of wait() to reap only the child
+        it fork/executed
+        * Extra debugging entries throughout code
-
-2005-09-24 Mina Naguib <mina@ilesansfil.org>

trunk/wifidog/src/client_list.c

@@ -51 +51 @@
- * Holds a pointer to the first element of the list 
- */ 
-static 
+
-
-/** Get the first element of the list of connected clients
@@ -96 +96 @@
-    curclient->mac = safe_strdup(mac);
-    curclient->token = safe_strdup(token);
-outgoing
+incoming_history = curclient->counters.outgoing = curclient->counters.outgoing_history
-    curclient->counters.last_updated = time(NULL);
-

trunk/wifidog/src/client_list.h

@@ -31 +31 @@
- */
-typedef struct _t_counters {
-
-
+
+
+
+
-    time_t      last_updated;   /**< @brief Last update of the counters */
-} t_counters;

trunk/wifidog/src/commandline.c

@@ -29 +29 @@
-#include <unistd.h>
-#include <string.h>
+#include <syslog.h>
-
+#include "debug.h"
-#include "safe.h"
-#include "conf.h"
@@ -35 +37 @@
-#include "../config.h"
-
+/*
+ * Holds an argv that could be passed to exec*() if we restart ourselves
+ */
+char ** restartargv = NULL;
+
-static void usage(void);
+
+/*
+ * A flag to denote whether we were restarted via a parent wifidog, or started normally
+ * 0 means normally, otherwise it will be populated by the PID of the parent
+ */
+pid_t restarted = 0;
-
-/** @internal
@@ -54 +67 @@
-    printf("  -h            Print usage\n");
-    printf("  -v            Print version information\n");
+    printf("  -x pid        Used internally by WiFiDog when re-starting itself *DO NOT ISSUE THIS SWITCH MANUAlLY*\n");
+    printf("  -i <path>     Internal socket path used when re-starting self\n");
-    printf("\n");
-}
-
-/** Uses getopt() to parse the command line and set configuration values
+ * also populates restartargv
- */
-
-
-
+
-    int c;
+         int skiponrestart;
+         int i;
+
-    s_config *config = config_get_config();
-
-
-
-
-
-
-
+
+
+
+
-
-
-
-
-
-
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                }
-                break;
-
-
-
-
+
+
+
+
+
+
+
-
-
-
-
-
-
+
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-                                case 'v':
-                                         printf("This is WiFiDog version " VERSION "\n");
-                                         exit(1);
-                                         break;
-
-            default:
-                usage();
-                exit(1);
-                break;
-        }
-    }
-}
-

trunk/wifidog/src/conf.c

@@ -155 +155 @@
-        config.log_syslog = DEFAULT_LOG_SYSLOG;
-        config.wdctl_sock = safe_strdup(DEFAULT_WDCTL_SOCK);
+        config.internal_sock = safe_strdup(DEFAULT_INTERNAL_SOCK);
-        config.rulesets = NULL;
-        config.trustedmaclist = NULL;

trunk/wifidog/src/conf.h

@@ -42 +42 @@
-#define DEFAULT_SYSLOG_FACILITY LOG_DAEMON
-#define DEFAULT_WDCTL_SOCK "/tmp/wdctl.sock"
+#define DEFAULT_INTERNAL_SOCK "/tmp/wifidog.sock"
-#define DEFAULT_AUTHSERVPORT 80
-#define DEFAULT_AUTHSERVSSLPORT 443
@@ -100 +101 @@
-    char configfile[255];       /**< @brief name of the config file */
-    char *wdctl_sock;           /**< @brief wdctl path to socket */
+    char *internal_sock;                /**< @brief internal path to socket */
-    int daemon;                 /**< @brief if daemon > 0, use daemon mode */
-    int debuglevel;             /**< @brief Debug information verbosity */

trunk/wifidog/src/debug.c

@@ -49 +49 @@
-
-        if (level <= LOG_WARNING) {
-(%s:%d) ", level, ctime_r(&ts, buf
+[%u](%s:%d) ", level, ctime_r(&ts, buf), getpid(
-                            filename, line);
-            vfprintf(stderr, format, vlist);
-            fputc('\n', stderr);
-        } else if (!config->daemon) {
-(%s:%d) ", level, ctime_r(&ts, buf
+[%u](%s:%d) ", level, ctime_r(&ts, buf), getpid(
-                            filename, line);
-            vfprintf(stdout, format, vlist);

trunk/wifidog/src/firewall.c

@@ -70 +70 @@
-extern pthread_mutex_t client_list_mutex;
-
+/* from commandline.c */
+extern pid_t restarted;
+
-int icmp_fd = 0;
-
@@ -144 +147 @@
-{
-    int flags, oneopt = 1, zeroopt = 0;
+         int result = 0;
+         t_client * client = NULL;
-
-    debug(LOG_INFO, "Creating ICMP socket");
@@ -156 +161 @@
-
-    debug(LOG_INFO, "Initializing Firewall");
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-}
-
@@ -269 +287 @@
-                            fw_deny(p1->ip, p1->mac, p1->fw_connection_state);
-                            p1->fw_connection_state = FW_MARK_KNOWN;
-
+p1->counters.incoming_history = p1->counters.outgoing_history = 
-                            fw_allow(p1->ip, p1->mac, p1->fw_connection_state);
-                        }

trunk/wifidog/src/fw_iptables.c

@@ -476 +476 @@
-            LOCK_CLIENT_LIST();
-            if ((p1 = client_list_find_by_ip(ip))) {
-p1->counters.outgoing
-
+(p1->counters.outgoing - p1->counters.outgoing_history)
+p1->counters.outgoing_history + 
-                    p1->counters.last_updated = time(NULL);
-                    debug(LOG_DEBUG, "%s - Updated counter.outgoing to %llu bytes", ip, counter);
@@ -514 +514 @@
-            LOCK_CLIENT_LIST();
-            if ((p1 = client_list_find_by_ip(ip))) {
-p1->counters.incoming
-
+(p1->counters.incoming - p1->counters.incoming_history)
+p1->counters.incoming_history + 
-                    debug(LOG_DEBUG, "%s - Updated counter.incoming to %llu bytes", ip, counter);
-                }

trunk/wifidog/src/gateway.c

@@ -35 +35 @@
-#include <time.h>
-
-/* for fork() */
-#include <sys/types.h>
-#include <unistd.h>
-
-/* for strerror() */
-#include <string.h>
@@ -45 +41 @@
-#include <sys/wait.h>
-
+/* for unix socket communication*/
+#include <sys/socket.h>
+#include <sys/un.h>
+
+#include "common.h"
-#include "httpd.h"
-#include "safe.h"
@@ -67 +68 @@
-static pthread_t tid_ping = 0; 
-
+/* The internal web server */
+httpd * webserver = NULL;
+
+/* from commandline.c */
+extern char ** restartargv;
+extern pid_t restarted;
+t_client *firstclient;
+
+/* from client_list.c */
+extern pthread_mutex_t client_list_mutex;
+
+/* Appends -x, the current PID, and NULL to restartargv
+ * see parse_commandline in commandline.c for details
+ */
+void append_x_restartargv(void) {
+        int i;
+
+        for (i=0; restartargv[i]; i++);
+
+        restartargv[i++] = safe_strdup("-x");
+        safe_asprintf(&(restartargv[i++]), "%d", getpid());
+}
+
+/* @internal
+ * @brief Connects to the parent via the internal socket
+ * Downloads from it the active client list
+ */
+void get_clients_from_parent(void) {
+        int sock;
+        struct sockaddr_un      sa_un;
+        s_config * config = NULL;
+        char linebuffer[MAX_BUF];
+        int len = 0;
+        char *running1 = NULL;
+        char *running2 = NULL;
+        char *token1 = NULL;
+        char *token2 = NULL;
+        char onechar;
+        char *command = NULL;
+        char *key = NULL;
+        char *value = NULL;
+        t_client * client = NULL;
+        t_client * lastclient = NULL;
+
+        config = config_get_config();
+        
+        debug(LOG_INFO, "Connecting to parent to download clients");
+
+        /* Connect to socket */
+        sock = socket(AF_UNIX, SOCK_STREAM, 0);
+        memset(&sa_un, 0, sizeof(sa_un));
+        sa_un.sun_family = AF_UNIX;
+        strncpy(sa_un.sun_path, config->internal_sock, (sizeof(sa_un.sun_path) - 1));
+
+        if (connect(sock, (struct sockaddr *)&sa_un, strlen(sa_un.sun_path) + sizeof(sa_un.sun_family))) {
+                debug(LOG_ERR, "Failed to connect to parent (%s) - client list not downloaded", strerror(errno));
+                return;
+        }
+
+        debug(LOG_INFO, "Connected to parent.  Downloading clients");
+
+        LOCK_CLIENT_LIST();
+
+        command = NULL;
+        memset(linebuffer, 0, sizeof(linebuffer));
+        len = 0;
+        client = NULL;
+        /* Get line by line */
+        while (read(sock, &onechar, 1) == 1) {
+                if (onechar == '\n') {
+                        /* End of line */
+                        onechar = '\0';
+                }
+                linebuffer[len++] = onechar;
+
+                if (!onechar) {
+                        /* We have a complete entry in linebuffer - parse it */
+                        debug(LOG_DEBUG, "Received from parent: [%s]", linebuffer);
+                        running1 = linebuffer;
+                        while ((token1 = strsep(&running1, "|")) != NULL) {
+                                if (!command) {
+                                        /* The first token is the command */
+                                        command = token1;
+                                }
+                                else {
+                                /* Token1 has something like "foo=bar" */
+                                        running2 = token1;
+                                        key = value = NULL;
+                                        while ((token2 = strsep(&running2, "=")) != NULL) {
+                                                if (!key) {
+                                                        key = token2;
+                                                }
+                                                else if (!value) {
+                                                        value = token2;
+                                                }
+                                        }
+                                }
+
+                                if (strcmp(command, "CLIENT") == 0) {
+                                        /* This line has info about a client in the client list */
+                                        if (!client) {
+                                                /* Create a new client struct */
+                                                client = safe_malloc(sizeof(t_client));
+                                                memset(client, 0, sizeof(t_client));
+                                        }
+                                }
+
+                                if (key && value) {
+                                        if (strcmp(command, "CLIENT") == 0) {
+                                                /* Assign the key into the appropriate slot in the connection structure */
+                                                if (strcmp(key, "ip") == 0) {
+                                                        client->ip = safe_strdup(value);
+                                                }
+                                                else if (strcmp(key, "mac") == 0) {
+                                                        client->mac = safe_strdup(value);
+                                                }
+                                                else if (strcmp(key, "token") == 0) {
+                                                        client->token = safe_strdup(value);
+                                                }
+                                                else if (strcmp(key, "fw_connection_state") == 0) {
+                                                        client->fw_connection_state = atoi(value);
+                                                }
+                                                else if (strcmp(key, "fd") == 0) {
+                                                        client->fd = atoi(value);
+                                                }
+                                                else if (strcmp(key, "counters_incoming") == 0) {
+                                                        client->counters.incoming_history = atoll(value);
+                                                        client->counters.incoming = client->counters.incoming_history;
+                                                }
+                                                else if (strcmp(key, "counters_outgoing") == 0) {
+                                                        client->counters.outgoing_history = atoll(value);
+                                                        client->counters.outgoing = client->counters.outgoing_history;
+                                                }
+                                                else if (strcmp(key, "counters_last_updated") == 0) {
+                                                        client->counters.last_updated = atol(value);
+                                                }
+                                                else {
+                                                        debug(LOG_NOTICE, "I don't know how to inherit key [%s] value [%s] from parent", key, value);
+                                                }
+                                        }
+                                }
+                        }
+
+                        /* End of parsing this command */
+                        if (client) {
+                                /* Add this client to the client list */
+                                if (!firstclient) {
+                                        firstclient = client;
+                                        lastclient = firstclient;
+                                }
+                                else {
+                                        lastclient->next = client;
+                                        lastclient = client;
+                                }
+                        }
+
+                        /* Clean up */
+                        command = NULL;
+                        memset(linebuffer, 0, sizeof(linebuffer));
+                        len = 0;
+                        client = NULL;
+                }
+        }
+
+        UNLOCK_CLIENT_LIST();
+        debug(LOG_INFO, "Client list downloaded successfully from parent");
+
+        close(sock);
+}
+
-/**@internal
- * @brief Handles SIGCHLD signals to avoid zombie processes
@@ -78 +249 @@
-{
-        int     status;
+        pid_t rc;
-        
-
+
+
+
+
+
-}
-
@@ -89 +265 @@
-        static  pthread_mutex_t sigterm_mutex = PTHREAD_MUTEX_INITIALIZER;
-
-C
+Handler for termination c
-
-        /* Makes sure we only call fw_destroy() once. */
@@ -100 +276 @@
-        }
-
-DEBUG
+INFO
-        fw_destroy();
-
@@ -116 +292 @@
-        }
-
-DEBUG
+NOTICE
-        exit(s == 0 ? 1 : 0);
-}
@@ -179 +355 @@
-main_loop(void)
-{
-        httpd * webserver;
-        int result;
-        pthread_t       tid;
@@ -186 +361 @@
-        void **params;
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
-
-  /* If we don't have the Gateway ID, construct it from the internal MAC address. Can't fail. */
@@ -210 +382 @@
-
-        /* Initializes the web server */
-
-
-
-
-
-
+
+
+
-                exit(1);
-        }
+
-        debug(LOG_DEBUG, "Assigning callbacks to web server");
-        httpdAddCContent(webserver, "/", "wifidog", 0, NULL, http_callback_wifidog);
@@ -226 +396 @@
-        httpdAddC404Content(webserver, http_callback_404);
-
-        /* Init the signals to catch chld/quit/etc */
-        init_signals();
-
-        /* Reset the firewall (if WiFiDog crashed) */
-        fw_destroy();
+        /* Then initialize it */
-        fw_init();
-
@@ -280 +448 @@
-                         * We got a connection
-                         *
-fork
+create
-                         */
-                        debug(LOG_INFO, "Received connection from %s, spawning worker thread", r->clientAddr);
@@ -307 +475 @@
-
-/** Reads the configuration file and then starts the main loop */
-
-
-
+
+
-        s_config *config = config_get_config();
-        config_init();
@@ -315 +482 @@
-        parse_commandline(argc, argv);
-
+        /* Initialize the config */
-        config_read(config->configfile);
-        config_validate();
-
+        /* Initializes the linked list of connected clients */
+        client_list_init();
+
+        /* Init the signals to catch chld/quit/etc */
+        init_signals();
+
+        if (restarted) {
+                /*
+                 * We were restarted and our parent is waiting for us to talk to it over the socket
+                 */
+                get_clients_from_parent();
+
+                /*
+                 * At this point the parent will start destroying itself and the firewall. Let it finish it's job before we continue
+                 */
+                while (kill(restarted, 0) != -1) {
+                        debug(LOG_INFO, "Waiting for parent PID %d to die before continuing loading", restarted);
+                        sleep(1);
+                }
+
+                debug(LOG_INFO, "Parent PID %d seems to be dead. Continuing loading.");
+        }
+
-        if (config->daemon) {
-
-                debug(LOG_INFO, "Forking into background");
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-                main_loop();
-        }

trunk/wifidog/src/safe.c

@@ -28 +28 @@
- */
-
+
-#include <stdarg.h>
+#include <stdio.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-
+#include "httpd.h"
-#include "safe.h"
-#include "debug.h"
-#include <syslog.h>
+
+/* From gateway.c */
+extern httpd * webserver;
-
-void * safe_malloc (size_t size) {
@@ -83 +89 @@
-        return (retval);
-}
+
+pid_t safe_fork(void) {
+        pid_t result;
+        result = fork();
+
+        if (result == -1) {
+                debug(LOG_CRIT, "Failed to fork: %s.  Bailing out", strerror(errno));
+                exit (1);
+        }
+        else if (result == 0) {
+                /* I'm the child - do some cleanup */
+                if (webserver) {
+                        close(webserver->serverSock);
+                        webserver = NULL;
+                }
+        }
+
+        return result;
+}
+

trunk/wifidog/src/safe.h

@@ -29 +29 @@
-
-#include <stdarg.h> /* For va_list */
+#include <sys/types.h> /* For fork */
+#include <unistd.h> /* For fork */
-
-/** @brief Safe version of malloc
@@ -46 +48 @@
-int safe_vasprintf(char **strp, const char *fmt, va_list ap);
-
+/* @brief Safe version of fork
+ */
+
+pid_t safe_fork(void);
+
-#endif /* _SAFE_H_ */
-

trunk/wifidog/src/util.c

@@ -65 +65 @@
-extern  pthread_mutex_t config_mutex;
-
+/* Defined in commandline.c */
+extern pid_t restarted;
+
-/* XXX Do these need to be locked ? */
-static time_t last_online_time = 0;
@@ -89 +92 @@
-    new_argv[3] = NULL;
-
-
-
-
-
+
+