Allow to independently monitor and dump events.

In large networks there is much traffic on the socket. This induces
high load even when only a subset of the data is relevant. This commit
introduces new commands on the socket for monitor neighbour, monitor
route, monitor xroute, monitor interface that will exclusively show
changes for these structures.

Author: christf

babeld.man

@@ -607,18 +607,13 @@ replies with one or more lines of data terminated by one of
 or
 .BR bad .
 
-The following requests are currently defined:
-.IP \(bu 2
-any configuration file directive, including
-.BR interface ;
+All configuration file directives are valid socket requests, including:
 .IP \(bu
-.BR "flush interface" ;
+.BR "[flush] interface"
 .IP \(bu
-.BR dump ;
+.BR "dump [neighbour|route|xroute|interface]"
 .IP \(bu
-.B monitor
-and
-.BR unmonitor ;
+.BR "[un]monitor [neighbour|route|xroute|interface]"
 .IP \(bu
 .BR quit .
 .SH EXAMPLES

configuration.c

@@ -969,6 +969,40 @@ parse_option(int c, gnc_t gnc, void *closure, char *token)
 
 }
 
+int
+parse_monitor_dump_filter(char *token, int *action_return, int c, gnc_t *gnc, void *closure)
+{
+    char *token2 = NULL;
+    c = skip_whitespace(c, *gnc, closure);
+
+    c = getword(c, &token2, *gnc, closure);
+
+    int filter = 0;
+    if(token2) {
+        if(strcmp(token2, "route") == 0)
+            filter = FILTER_ROUTE;
+        else if(strcmp(token2, "interface") == 0)
+            filter = FILTER_INTERFACE;
+        else if(strcmp(token2, "xroute") == 0)
+            filter = FILTER_XROUTE;
+        else if(strcmp(token2, "neighbour") == 0)
+            filter = FILTER_NEIGHBOUR;
+        else
+            filter = FILTER_INVALID;
+        free(token2);
+    }
+
+    c = skip_eol(c, *gnc, closure);
+    if(filter < FILTER_INVALID) {
+        *action_return += filter;
+        if(!filter) // no (invalid) filters detected, show everything
+            c = -1;
+    } else {
+        c = -2;
+    }
+    return c;
+}
+
 static int
 parse_config_line(int c, gnc_t gnc, void *closure,
                   int *action_return, const char **message_return)
@@ -996,20 +1030,14 @@ parse_config_line(int c, gnc_t gnc, void *closure,
             goto fail;
         *action_return = CONFIG_ACTION_QUIT;
     } else if(strcmp(token, "dump") == 0) {
-        c = skip_eol(c, gnc, closure);
-        if(c < -1 || !action_return)
-            goto fail;
         *action_return = CONFIG_ACTION_DUMP;
+        c = parse_monitor_dump_filter(token, action_return, c, &gnc, closure);
     } else if(strcmp(token, "monitor") == 0) {
-        c = skip_eol(c, gnc, closure);
-        if(c < -1 || !action_return)
-            goto fail;
         *action_return = CONFIG_ACTION_MONITOR;
+        c = parse_monitor_dump_filter(token, action_return, c, &gnc, closure);
     } else if(strcmp(token, "unmonitor") == 0) {
-        c = skip_eol(c, gnc, closure);
-        if(c < -1 || !action_return)
-            goto fail;
         *action_return = CONFIG_ACTION_UNMONITOR;
+        c = parse_monitor_dump_filter(token, action_return, c, &gnc, closure);
     } else if(config_finalised && !local_server_write) {
         /* The remaining directives are only allowed in read-write mode. */
         c = skip_to_eol(c, gnc, closure);

configuration.h

@@ -25,9 +25,27 @@ THE SOFTWARE.
 #define CONFIG_ACTION_DONE 0
 #define CONFIG_ACTION_QUIT 1
 #define CONFIG_ACTION_DUMP 2
-#define CONFIG_ACTION_MONITOR 3
-#define CONFIG_ACTION_UNMONITOR 4
-#define CONFIG_ACTION_NO 5
+#define CONFIG_ACTION_DUMP_NEIGHBOUR 3
+#define CONFIG_ACTION_DUMP_ROUTE 4
+#define CONFIG_ACTION_DUMP_XROUTE 5
+#define CONFIG_ACTION_DUMP_INTERFACE 6
+#define CONFIG_ACTION_NO 7
+#define CONFIG_ACTION_MONITOR 8
+#define CONFIG_ACTION_MONITOR_NEIGHBOUR 9
+#define CONFIG_ACTION_MONITOR_ROUTE 10
+#define CONFIG_ACTION_MONITOR_XROUTE 11
+#define CONFIG_ACTION_MONITOR_INTERFACE 12
+#define CONFIG_ACTION_UNMONITOR 13
+#define CONFIG_ACTION_UNMONITOR_NEIGHBOUR 14
+#define CONFIG_ACTION_UNMONITOR_ROUTE 15
+#define CONFIG_ACTION_UNMONITOR_XROUTE 16
+#define CONFIG_ACTION_UNMONITOR_INTERFACE 17
+
+#define FILTER_NEIGHBOUR 1
+#define FILTER_ROUTE 2
+#define FILTER_XROUTE 3
+#define FILTER_INTERFACE 4
+#define FILTER_INVALID 255
 
 struct filter_result {
     unsigned int add_metric; /* allow = 0, deny = INF, metric = <0..INF> */

local.c

@@ -133,11 +133,12 @@ local_notify_interface(struct interface *ifp, int kind)
 {
     int i;
     for(i = 0; i < num_local_sockets; i++) {
-        if(local_sockets[i].monitor)
+        if(local_sockets[i].monitor & (0x01 << SHOW_INTERFACE))
             local_notify_interface_1(&local_sockets[i], ifp, kind);
     }
 }
 
+
 static void
 local_notify_neighbour_1(struct local_socket *s,
                          struct neighbour *neigh, int kind)
@@ -188,7 +189,7 @@ local_notify_neighbour(struct neighbour *neigh, int kind)
 {
     int i;
     for(i = 0; i < num_local_sockets; i++) {
-        if(local_sockets[i].monitor)
+        if(local_sockets[i].monitor & (0x01 << SHOW_NEIGHBOUR))
             local_notify_neighbour_1(&local_sockets[i], neigh, kind);
     }
 }
@@ -225,7 +226,7 @@ local_notify_xroute(struct xroute *xroute, int kind)
 {
     int i;
     for(i = 0; i < num_local_sockets; i++) {
-        if(local_sockets[i].monitor)
+        if(local_sockets[i].monitor & (0x01 << SHOW_XROUTE))
             local_notify_xroute_1(&local_sockets[i], xroute, kind);
     }
 }
@@ -270,26 +271,36 @@ local_notify_route(struct babel_route *route, int kind)
 {
     int i;
     for(i = 0; i < num_local_sockets; i++) {
-        if(local_sockets[i].monitor)
+        if(local_sockets[i].monitor & (0x01 << SHOW_ROUTE))
             local_notify_route_1(&local_sockets[i], route, kind);
     }
 }
 
+
 static void
-local_notify_all_1(struct local_socket *s)
+local_notify_all_neighbour_1(struct local_socket *s)
 {
-    struct interface *ifp;
     struct neighbour *neigh;
-    struct xroute_stream *xroutes;
-    struct route_stream *routes;
+
+    FOR_ALL_NEIGHBOURS(neigh) {
+        local_notify_neighbour_1(s, neigh, LOCAL_ADD);
+    }
+}
+
+static void
+local_notify_all_interface_1(struct local_socket *s)
+{
+    struct interface *ifp;
 
     FOR_ALL_INTERFACES(ifp) {
         local_notify_interface_1(s, ifp, LOCAL_ADD);
     }
+}
 
-    FOR_ALL_NEIGHBOURS(neigh) {
-        local_notify_neighbour_1(s, neigh, LOCAL_ADD);
-    }
+static void
+local_notify_all_xroute_1(struct local_socket *s)
+{
+    struct xroute_stream *xroutes;
 
     xroutes = xroute_stream();
     if(xroutes) {
@@ -301,6 +312,12 @@ local_notify_all_1(struct local_socket *s)
         }
         xroute_stream_done(xroutes);
     }
+}
+
+static void
+local_notify_all_route_1(struct local_socket *s)
+{
+    struct route_stream *routes;
 
     routes = route_stream(ROUTE_ALL);
     if(routes) {
@@ -312,9 +329,60 @@ local_notify_all_1(struct local_socket *s)
         }
         route_stream_done(routes);
     }
-    return;
 }
 
+static void
+local_notify_all(struct local_socket *s, unsigned int mask)
+{
+    if(mask & (0x01 << SHOW_INTERFACE))
+        local_notify_all_interface_1(s);
+    if(mask & (0x01 << SHOW_NEIGHBOUR))
+        local_notify_all_neighbour_1(s);
+    if(mask & (0x01 << SHOW_ROUTE))
+        local_notify_all_route_1(s);
+    if(mask & (0x01 << SHOW_XROUTE))
+        local_notify_all_xroute_1(s);
+}
+
+static void
+local_notify_all_1(struct local_socket *s)
+{
+    local_notify_all_interface_1(s);
+    local_notify_all_neighbour_1(s);
+    local_notify_all_xroute_1(s);
+    local_notify_all_route_1(s);
+}
+
+static unsigned int
+show_flags_map(int rc)
+{
+    switch(rc) {
+    case CONFIG_ACTION_MONITOR_ROUTE:
+    case CONFIG_ACTION_UNMONITOR_ROUTE:
+    case CONFIG_ACTION_DUMP_ROUTE:
+        return 0x01 << SHOW_ROUTE;
+    case CONFIG_ACTION_MONITOR_INTERFACE:
+    case CONFIG_ACTION_UNMONITOR_INTERFACE:
+    case CONFIG_ACTION_DUMP_INTERFACE:
+        return 0x01 << SHOW_INTERFACE;
+    case CONFIG_ACTION_MONITOR_XROUTE:
+    case CONFIG_ACTION_UNMONITOR_XROUTE:
+    case CONFIG_ACTION_DUMP_XROUTE:
+        return 0x01 << SHOW_XROUTE;
+    case CONFIG_ACTION_MONITOR_NEIGHBOUR:
+    case CONFIG_ACTION_UNMONITOR_NEIGHBOUR:
+    case CONFIG_ACTION_DUMP_NEIGHBOUR:
+        return 0x01 << SHOW_NEIGHBOUR;
+    case CONFIG_ACTION_MONITOR:
+    case CONFIG_ACTION_UNMONITOR:
+    case CONFIG_ACTION_DUMP:
+        return 0xff;
+    }
+    return 0;
+}
+
+
+
 int
 local_read(struct local_socket *s)
 {
@@ -352,19 +420,36 @@ local_read(struct local_socket *s)
             shutdown(s->fd, 1);
             reply[0] = '\0';
             break;
+        case CONFIG_ACTION_DUMP_INTERFACE:
+        case CONFIG_ACTION_DUMP_ROUTE:
+        case CONFIG_ACTION_DUMP_XROUTE:
+        case CONFIG_ACTION_DUMP_NEIGHBOUR:
         case CONFIG_ACTION_DUMP:
-            local_notify_all_1(s);
+            local_notify_all(s, show_flags_map(rc));
             break;
         case CONFIG_ACTION_MONITOR:
+            s->monitor = 0xff;
             local_notify_all_1(s);
-            s->monitor = 1;
+            break;
+        case CONFIG_ACTION_MONITOR_NEIGHBOUR:
+        case CONFIG_ACTION_MONITOR_INTERFACE:
+        case CONFIG_ACTION_MONITOR_ROUTE:
+        case CONFIG_ACTION_MONITOR_XROUTE:
+            s->monitor |= show_flags_map(rc);
+            local_notify_all(s, show_flags_map(rc));
+            break;
+        case CONFIG_ACTION_UNMONITOR_NEIGHBOUR:
+        case CONFIG_ACTION_UNMONITOR_INTERFACE:
+        case CONFIG_ACTION_UNMONITOR_ROUTE:
+        case CONFIG_ACTION_UNMONITOR_XROUTE:
+            s->monitor &= ~show_flags_map(rc);
             break;
         case CONFIG_ACTION_UNMONITOR:
-            s->monitor = 0;
+            s->monitor = 0x00;
             break;
         case CONFIG_ACTION_NO:
             snprintf(reply, sizeof(reply), "no%s%s\n",
-                     message ? " " : "", message ? message : "");
+                            message ? " " : "", message ? message : "");
             break;
         default:
             snprintf(reply, sizeof(reply), "bad\n");

local.h

@@ -38,9 +38,14 @@ struct local_socket {
     int fd;
     char *buf;
     int n;
-    int monitor;
+    unsigned int monitor;
 };
 
+#define SHOW_NEIGHBOUR 1
+#define SHOW_INTERFACE 2
+#define SHOW_ROUTE 3
+#define SHOW_XROUTE 4
+
 extern int local_server_socket;
 extern struct local_socket local_sockets[MAX_LOCAL_SOCKETS];
 extern int num_local_sockets;