discover: Handle and track plugin_options
authorSamuel Mendoza-Jonas <sam@mendozajonas.com>
Wed, 1 Feb 2017 05:11:43 +0000 (16:11 +1100)
committerSamuel Mendoza-Jonas <sam@mendozajonas.com>
Tue, 15 Aug 2017 03:03:28 +0000 (13:03 +1000)
Track plugin_options in the device_handler. Plugins can be added with
device_handler_add_plugin_option() and accessed via
device_handler_get_plugin().
Extend discover_server to support the new 'add' and 'remove' pb-protocol
actions and advertise new plugins to connecting clients.

Signed-off-by: Samuel Mendoza-Jonas <sam@mendozajonas.com>
discover/device-handler.c
discover/device-handler.h
discover/discover-server.c
discover/discover-server.h
test/parser/Makefile.am
test/parser/handler.c
test/parser/user-event.c [new file with mode: 0644]

index ec4a6f611ff289ee9d4bc61182401897c41ff1ba..3ef48ada77394e2252249b4495af81c8efe94291 100644 (file)
@@ -84,6 +84,9 @@ struct device_handler {
 
        struct list             progress;
        unsigned int            n_progress;
 
        struct list             progress;
        unsigned int            n_progress;
+
+       struct plugin_option    **plugins;
+       unsigned int            n_plugins;
 };
 
 static int mount_device(struct discover_device *dev);
 };
 
 static int mount_device(struct discover_device *dev);
@@ -126,6 +129,28 @@ const struct discover_device *device_handler_get_device(
        return handler->devices[index];
 }
 
        return handler->devices[index];
 }
 
+/**
+ * device_handler_get_plugin_count - Get the count of current handler plugins.
+ */
+int device_handler_get_plugin_count(const struct device_handler *handler)
+{
+       return handler->n_plugins;
+}
+
+/**
+ * discover_handler_get_plugin - Get a handler plugin by index.
+ */
+const struct plugin_option *device_handler_get_plugin(
+       const struct device_handler *handler, unsigned int index)
+{
+       if (index >= handler->n_plugins) {
+               assert(0 && "bad index");
+               return NULL;
+       }
+
+       return handler->plugins[index];
+}
+
 struct network *device_handler_get_network(
                const struct device_handler *handler)
 {
 struct network *device_handler_get_network(
                const struct device_handler *handler)
 {
@@ -385,6 +410,15 @@ void device_handler_reinit(struct device_handler *handler)
        handler->ramdisks = NULL;
        handler->n_ramdisks = 0;
 
        handler->ramdisks = NULL;
        handler->n_ramdisks = 0;
 
+       /* drop any known plugins */
+       for (i = 0; i < handler->n_plugins; i++)
+               talloc_free(handler->plugins[i]);
+       talloc_free(handler->plugins);
+       handler->plugins = NULL;
+       handler->n_plugins = 0;
+
+       discover_server_notify_plugins_remove(handler->server);
+
        device_handler_reinit_sources(handler);
 }
 
        device_handler_reinit_sources(handler);
 }
 
@@ -1408,6 +1442,36 @@ void device_handler_discover_context_commit(struct device_handler *handler,
        }
 }
 
        }
 }
 
+void device_handler_add_plugin_option(struct device_handler *handler,
+               struct plugin_option *opt)
+{
+       struct plugin_option *tmp;
+       unsigned int i;
+
+       for (i = 0; i < handler->n_plugins; i++) {
+               tmp = handler->plugins[i];
+               /* If both id and version match, ignore */
+               if (strncmp(opt->id, tmp->id, strlen(opt->id)) == 0 &&
+                               strncmp(opt->version, tmp->version,
+                                       strlen(opt->version) == 0)) {
+                       pb_log("discover: Plugin '%s' already exists, ignoring\n",
+                                       opt->id);
+                       return;
+               }
+       }
+
+       handler->plugins = talloc_realloc(handler, handler->plugins,
+                       struct plugin_option *, handler->n_plugins + 1);
+       if (!handler->plugins) {
+               pb_log("Failed to allocate memory for new plugin\n");
+               handler->n_plugins = 0;
+               return;
+       }
+
+       handler->plugins[handler->n_plugins++] = opt;
+       discover_server_notify_plugin_option_add(handler->server, opt);
+}
+
 static void device_handler_update_lang(const char *lang)
 {
        const char *cur_lang;
 static void device_handler_update_lang(const char *lang)
 {
        const char *cur_lang;
index 133eff3f3cd1e8a3ebd5e91ed43101b38dbbce68..c1bbe7d3ae337bbcaf782138b8d52459c37496d5 100644 (file)
@@ -80,6 +80,9 @@ void device_handler_destroy(struct device_handler *devices);
 int device_handler_get_device_count(const struct device_handler *handler);
 const struct discover_device *device_handler_get_device(
        const struct device_handler *handler, unsigned int index);
 int device_handler_get_device_count(const struct device_handler *handler);
 const struct discover_device *device_handler_get_device(
        const struct device_handler *handler, unsigned int index);
+int device_handler_get_plugin_count(const struct device_handler *handler);
+const struct plugin_option *device_handler_get_plugin(
+       const struct device_handler *handler, unsigned int index);
 struct network *device_handler_get_network(
                const struct device_handler *handler);
 
 struct network *device_handler_get_network(
                const struct device_handler *handler);
 
@@ -126,6 +129,8 @@ struct discover_boot_option *discover_boot_option_create(
                struct discover_device *dev);
 void discover_context_add_boot_option(struct discover_context *ctx,
                struct discover_boot_option *opt);
                struct discover_device *dev);
 void discover_context_add_boot_option(struct discover_context *ctx,
                struct discover_boot_option *opt);
+void device_handler_add_plugin_option(struct device_handler *handler,
+               struct plugin_option *opt);
 
 int device_handler_user_event(struct device_handler *handler,
                                struct event *event);
 
 int device_handler_user_event(struct device_handler *handler,
                                struct event *event);
index a3087b3335d423fa1e01fc25ab6bfe705a23933f..e2e87ca43618d86086a7b1a75172636399e8f202 100644 (file)
@@ -139,6 +139,39 @@ static int write_boot_option_add_message(struct discover_server *server,
        return client_write_message(server, client, message);
 }
 
        return client_write_message(server, client, message);
 }
 
+static int write_plugin_option_add_message(struct discover_server *server,
+               struct client *client, const struct plugin_option *opt)
+{
+       struct pb_protocol_message *message;
+       int len;
+
+       len = pb_protocol_plugin_option_len(opt);
+
+       message = pb_protocol_create_message(client,
+                       PB_PROTOCOL_ACTION_PLUGIN_OPTION_ADD, len);
+       if (!message)
+               return -1;
+
+       pb_protocol_serialise_plugin_option(opt, message->payload, len);
+
+       return client_write_message(server, client, message);
+}
+
+static int write_plugins_remove_message(struct discover_server *server,
+               struct client *client)
+{
+       struct pb_protocol_message *message;
+
+       message = pb_protocol_create_message(client,
+                       PB_PROTOCOL_ACTION_PLUGINS_REMOVE, 0);
+       if (!message)
+               return -1;
+
+       /* No payload so nothing to serialise */
+
+       return client_write_message(server, client, message);
+}
+
 static int write_device_remove_message(struct discover_server *server,
                struct client *client, char *dev_id)
 {
 static int write_device_remove_message(struct discover_server *server,
                struct client *client, char *dev_id)
 {
@@ -284,7 +317,7 @@ static int discover_server_process_connection(void *arg)
 {
        struct discover_server *server = arg;
        struct statuslog_entry *entry;
 {
        struct discover_server *server = arg;
        struct statuslog_entry *entry;
-       int fd, rc, i, n_devices;
+       int fd, rc, i, n_devices, n_plugins;
        struct client *client;
 
        /* accept the incoming connection */
        struct client *client;
 
        /* accept the incoming connection */
@@ -339,6 +372,15 @@ static int discover_server_process_connection(void *arg)
        list_for_each_entry(&server->status, entry, list)
                write_boot_status_message(server, client, entry->status);
 
        list_for_each_entry(&server->status, entry, list)
                write_boot_status_message(server, client, entry->status);
 
+       /* send installed plugins to client */
+       n_plugins = device_handler_get_plugin_count(server->device_handler);
+       for (i = 0; i < n_plugins; i++) {
+               const struct plugin_option *plugin;
+
+               plugin = device_handler_get_plugin(server->device_handler, i);
+               write_plugin_option_add_message(server, client, plugin);
+       }
+
        return 0;
 }
 
        return 0;
 }
 
@@ -416,6 +458,23 @@ void discover_server_notify_config(struct discover_server *server,
                write_config_message(server, client, config);
 }
 
                write_config_message(server, client, config);
 }
 
+void discover_server_notify_plugin_option_add(struct discover_server *server,
+               struct plugin_option *opt)
+{
+       struct client *client;
+
+       list_for_each_entry(&server->clients, client, list)
+               write_plugin_option_add_message(server, client, opt);
+}
+
+void discover_server_notify_plugins_remove(struct discover_server *server)
+{
+       struct client *client;
+
+       list_for_each_entry(&server->clients, client, list)
+               write_plugins_remove_message(server, client);
+}
+
 void discover_server_set_device_source(struct discover_server *server,
                struct device_handler *handler)
 {
 void discover_server_set_device_source(struct discover_server *server,
                struct device_handler *handler)
 {
index 97d07e62a37312c02697911f3f4ebea852c8e14e..9f3aa6274a699ae91ad53f8f3e26885f844f031e 100644 (file)
@@ -7,6 +7,8 @@ struct discover_server;
 struct device_handler;
 struct boot_option;
 struct status;
 struct device_handler;
 struct boot_option;
 struct status;
+struct plugin_option;
+struct boot_status;
 struct system_info;
 struct device;
 struct config;
 struct system_info;
 struct device;
 struct config;
@@ -30,4 +32,7 @@ void discover_server_notify_system_info(struct discover_server *server,
                const struct system_info *sysinfo);
 void discover_server_notify_config(struct discover_server *server,
                const struct config *config);
                const struct system_info *sysinfo);
 void discover_server_notify_config(struct discover_server *server,
                const struct config *config);
+void discover_server_notify_plugin_option_add(struct discover_server *server,
+               struct plugin_option *option);
+void discover_server_notify_plugins_remove(struct discover_server *server);
 #endif /* _DISCOVER_SERVER_H */
 #endif /* _DISCOVER_SERVER_H */
index 9a6be6d1614e02508b6e87cfe3e5a5b4b06b734b..fa644fe3f98daa417cc49289e0eb0791965dd754 100644 (file)
@@ -100,6 +100,7 @@ test_parser_libtest_ro_SOURCES = \
        test/parser/utils.c \
        test/parser/handler.c \
        test/parser/network.c \
        test/parser/utils.c \
        test/parser/handler.c \
        test/parser/network.c \
+       test/parser/user-event.c \
        test/parser/parser-test.h \
        discover/yaboot-parser.c \
        discover/kboot-parser.c \
        test/parser/parser-test.h \
        discover/yaboot-parser.c \
        discover/kboot-parser.c \
index e455c2221a6c0c8a0819cc1f5b2c65736f584b9d..a9856b494fe2d29048901690d1e0bb75800178c9 100644 (file)
@@ -7,6 +7,7 @@
 #include "device-handler.h"
 
 struct network;
 #include "device-handler.h"
 
 struct network;
+struct client;
 
 typedef void (*boot_status_fn)(void *arg, struct status *);
 
 
 typedef void (*boot_status_fn)(void *arg, struct status *);
 
@@ -110,3 +111,8 @@ void pending_network_jobs_start(void)
 void pending_network_jobs_cancel(void)
 {
 }
 void pending_network_jobs_cancel(void)
 {
 }
+
+void discover_server_notify_plugins_remove(struct discover_server *server)
+{
+       (void)server;
+}
diff --git a/test/parser/user-event.c b/test/parser/user-event.c
new file mode 100644 (file)
index 0000000..43d15b7
--- /dev/null
@@ -0,0 +1,13 @@
+
+#include <assert.h>
+
+#include <types/types.h>
+
+struct device_handler;
+
+void device_handler_add_plugin_option(struct device_handler *handler,
+               struct plugin_option *opt)
+{
+       (void)handler;
+       (void)opt;
+}