Add fully flexible task handling framework
authorMarcel Holtmann <marcel@holtmann.org>
Sat, 8 Aug 2009 01:52:11 +0000 (18:52 -0700)
committerMarcel Holtmann <marcel@holtmann.org>
Sat, 8 Aug 2009 01:52:11 +0000 (18:52 -0700)
include/task.h
src/task.c

index dbeb3a7..ec68935 100644 (file)
@@ -22,6 +22,8 @@
 #ifndef __CONNMAN_TASK_H
 #define __CONNMAN_TASK_H
 
+#include <dbus/dbus.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -34,9 +36,27 @@ extern "C" {
 
 struct connman_task;
 
-struct connman_task *connman_task_create(void);
+typedef void (* connman_task_exit_t) (struct connman_task *task,
+                                                       void *user_data);
+
+typedef void (* connman_task_notify_t) (struct connman_task *task,
+                               DBusMessage *message, void *user_data);
+
+struct connman_task *connman_task_create(const char *program);
 void connman_task_destroy(struct connman_task *task);
 
+int connman_task_add_argument(struct connman_task *task,
+                               const char *argument, const char *value);
+int connman_task_add_variable(struct connman_task *task,
+                               const char *key, const char *value);
+
+int connman_task_set_notify(struct connman_task *task, const char *member,
+                       connman_task_notify_t function, void *user_data);
+
+int connman_task_run(struct connman_task *task,
+                       connman_task_exit_t function, void *user_data);
+int connman_task_stop(struct connman_task *task);
+
 #ifdef __cplusplus
 }
 #endif
index da94b3f..550027b 100644 (file)
 #include <config.h>
 #endif
 
+#include <unistd.h>
+#include <sys/wait.h>
+
 #include <glib.h>
 
 #include "connman.h"
 
+struct notify_data {
+       connman_task_notify_t func;
+       void *data;
+};
+
 struct connman_task {
        char *path;
        pid_t pid;
+       GPtrArray *argv;
+       GPtrArray *envp;
+       connman_task_exit_t exit_func;
+       void *exit_data;
+       GHashTable *notify;
 };
 
 static GHashTable *task_hash = NULL;
 
 static volatile gint task_counter;
 
+static DBusConnection *connection;
+
+static void free_pointer(gpointer data, gpointer user_data)
+{
+       g_free(data);
+}
+
 static void free_task(gpointer data)
 {
        struct connman_task *task = data;
 
        DBG("task %p", task);
 
+       g_hash_table_destroy(task->notify);
+       task->notify = NULL;
+
+       if (task->pid > 0)
+               kill(task->pid, SIGTERM);
+
+       g_ptr_array_foreach(task->envp, free_pointer, NULL);
+       g_ptr_array_free(task->envp, TRUE);
+
+       g_ptr_array_foreach(task->argv, free_pointer, NULL);
+       g_ptr_array_free(task->argv, TRUE);
+
        g_free(task->path);
        g_free(task);
 }
 
-struct connman_task *connman_task_create(void)
+/**
+ * connman_task_create:
+ * @program: name of executable
+ *
+ * Allocate a new task of given #program
+ *
+ * Returns: a newly-allocated #connman_task structure
+ */
+struct connman_task *connman_task_create(const char *program)
 {
        struct connman_task *task;
        gint counter;
+       char *str;
 
        DBG("");
 
@@ -62,6 +103,15 @@ struct connman_task *connman_task_create(void)
        task->path = g_strdup_printf("/task/%d", counter);
        task->pid = -1;
 
+       task->argv = g_ptr_array_new();
+       task->envp = g_ptr_array_new();
+
+       str = g_strdup(program);
+       g_ptr_array_add(task->argv, str);
+
+       task->notify = g_hash_table_new_full(g_str_hash, g_str_equal,
+                                                       g_free, g_free);
+
        DBG("task %p", task);
 
        g_hash_table_insert(task_hash, task->path, task);
@@ -69,6 +119,12 @@ struct connman_task *connman_task_create(void)
        return task;
 }
 
+/**
+ * connman_task_destory:
+ * @task: task structure
+ *
+ * Remove and destory #task
+ */
 void connman_task_destroy(struct connman_task *task)
 {
        DBG("task %p", task);
@@ -76,11 +132,193 @@ void connman_task_destroy(struct connman_task *task)
        g_hash_table_remove(task_hash, task->path);
 }
 
+/**
+ * connman_task_add_argument:
+ * @task: task structure
+ * @argument: argument name
+ * @value: optional argument value
+ *
+ * Add a new command line argument
+ */
+int connman_task_add_argument(struct connman_task *task,
+                               const char *argument, const char *value)
+{
+       char *str;
+
+       DBG("task %p arg %s val %s", task, argument, value);
+
+       if (argument == NULL)
+               return -EINVAL;
+
+       str = g_strdup(argument);
+       g_ptr_array_add(task->argv, str);
+
+       if (value != NULL) {
+               str = g_strdup(value);
+               g_ptr_array_add(task->argv, str);
+       }
+
+       return 0;
+}
+
+/**
+ * connman_task_add_variable:
+ * @task: task structure
+ * @key: variable name
+ * @value: optional variable value
+ *
+ * Add a new environment variable
+ */
+int connman_task_add_variable(struct connman_task *task,
+                               const char *key, const char *value)
+{
+       char *str;
+
+       DBG("task %p key %s val %s", task, key, value);
+
+       if (key == NULL)
+               return -EINVAL;
+
+       str = g_strdup_printf("%s=%s", key, value ? value : "");
+       g_ptr_array_add(task->envp, str);
+
+       return 0;
+}
+
+/**
+ * connman_task_set_notify:
+ * @task: task structure
+ * @member: notifcation method name
+ * @function: notification callback
+ * @user_data: optional notification user data
+ *
+ * Set notification handler for #member
+ */
+int connman_task_set_notify(struct connman_task *task, const char *member,
+                       connman_task_notify_t function, void *user_data)
+{
+       struct notify_data *notify;
+
+       DBG("task %p", task);
+
+       notify = g_try_new0(struct notify_data, 1);
+       if (notify == NULL)
+               return -ENOMEM;
+
+       notify->func = function;
+       notify->data = user_data;
+
+       g_hash_table_insert(task->notify, g_strdup(member), notify);
+
+       return 0;
+}
+
+static void task_died(GPid pid, gint status, gpointer user_data)
+{
+       struct connman_task *task = user_data;
+
+       if (WIFEXITED(status))
+               DBG("task %p exit status %d", task, WEXITSTATUS(status));
+       else
+               DBG("task %p signal %d", task, WTERMSIG(status));
+
+       g_spawn_close_pid(pid);
+       task->pid = -1;
+
+       if (task->exit_func)
+               task->exit_func(task, task->exit_data);
+}
+
+static void task_setup(gpointer user_data)
+{
+       struct connman_task *task = user_data;
+
+       DBG("task %p", task);
+}
+
+/**
+ * connman_task_run:
+ * @task: task structure
+ * @function: exit callback
+ * @user_data: optional exit user data
+ *
+ * Execute program specified by #task
+ */
+int connman_task_run(struct connman_task *task,
+                       connman_task_exit_t function, void *user_data)
+{
+       GSpawnFlags flags = G_SPAWN_DO_NOT_REAP_CHILD |
+                                               G_SPAWN_STDOUT_TO_DEV_NULL;
+       char **argv, **envp;
+
+       DBG("task %p", task);
+
+       if (task->pid > 0)
+               return -EALREADY;
+
+       task->exit_func = function;
+       task->exit_data = user_data;
+
+       if (g_ptr_array_index(task->argv, task->argv->len - 1) != NULL)
+               g_ptr_array_add(task->argv, NULL);
+
+       if (task->envp->len == 0 || g_ptr_array_index(task->envp,
+                                       task->envp->len - 1) != NULL) {
+               if (g_hash_table_size(task->notify) > 0) {
+                       const char *busname;
+                       char *str;
+
+                       busname = dbus_bus_get_unique_name(connection);
+                       str = g_strdup_printf("CONNMAN_BUSNAME=%s", busname);
+                       g_ptr_array_add(task->envp, str);
+
+                       str = g_strdup_printf("CONNMAN_INTERFACE=%s",
+                                               CONNMAN_TASK_INTERFACE);
+                       g_ptr_array_add(task->envp, str);
+
+                       str = g_strdup_printf("CONNMAN_PATH=%s", task->path);
+                       g_ptr_array_add(task->envp, str);
+               }
+
+               g_ptr_array_add(task->envp, NULL);
+       }
+
+       argv = (char **) task->argv->pdata;
+       envp = (char **) task->envp->pdata;
+
+       if (g_spawn_async(NULL, argv, envp, flags,
+                               task_setup, task, &task->pid, NULL) == FALSE) {
+               connman_error("Failed to spawn %s", argv[0]);
+               return -EIO;
+       }
+
+       g_child_watch_add(task->pid, task_died, task);
+
+       return 0;
+}
+
+/**
+ * connman_task_stop:
+ * @task: task structure
+ *
+ * Stop program specified by #task
+ */
+int connman_task_stop(struct connman_task *task)
+{
+       DBG("task %p", task);
+
+       if (task->pid > 0)
+               kill(task->pid, SIGTERM);
+
+       return 0;
+}
+
 static DBusHandlerResult task_filter(DBusConnection *connection,
                                        DBusMessage *message, void *user_data)
 {
        struct connman_task *task;
-       const char *path;
+       struct notify_data *notify;
+       const char *path, *member;
 
        if (dbus_message_get_type(message) != DBUS_MESSAGE_TYPE_METHOD_CALL)
                return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
@@ -97,14 +335,36 @@ static DBusHandlerResult task_filter(DBusConnection *connection,
        if (task == NULL)
                return DBUS_HANDLER_RESULT_NOT_YET_HANDLED;
 
+       if (dbus_message_get_no_reply(message) == FALSE) {
+               DBusMessage *reply;
+               dbus_bool_t result;
+
+               reply = dbus_message_new_method_return(message);
+               if (reply == NULL)
+                       return DBUS_HANDLER_RESULT_NEED_MEMORY;
+
+               result = dbus_connection_send(connection, reply, NULL);
+
+               dbus_message_unref(reply);
+       }
+
+       member = dbus_message_get_member(message);
+       if (member == NULL)
+               return DBUS_HANDLER_RESULT_HANDLED;
+
+       notify = g_hash_table_lookup(task->notify, member);
+       if (notify == NULL)
+               return DBUS_HANDLER_RESULT_HANDLED;
+
+       if (notify->func)
+               notify->func(task, message, notify->data);
+
        return DBUS_HANDLER_RESULT_HANDLED;
 }
 
 static const char *task_rule = "type=method_call"
                                        ",interface=" CONNMAN_TASK_INTERFACE;
 
-static DBusConnection *connection;
-
 int __connman_task_init(void)
 {
        DBG("");