proto-shell: Model config parameter "no-proto-task" as a proto flag
[project/netifd.git] / proto-shell.c
index 629f43b..998a44c 100644 (file)
@@ -41,10 +41,11 @@ enum proto_shell_sm {
 struct proto_shell_handler {
        struct list_head list;
        struct proto_handler proto;
-       struct uci_blob_param_list config;
        char *config_buf;
+       char *script_name;
        bool init_available;
-       char script_name[];
+
+       struct uci_blob_param_list config;
 };
 
 struct proto_shell_dependency {
@@ -55,6 +56,7 @@ struct proto_shell_dependency {
 
        union if_addr host;
        bool v6;
+       bool any;
 
        char interface[];
 };
@@ -66,11 +68,21 @@ struct proto_shell_state {
 
        struct uloop_timeout teardown_timeout;
 
+       /*
+        * Teardown and setup interface again if it is still not up (IFS_UP)
+        * after checkup_interval seconds since previous attempt.  This check
+        * will be disabled when the config option "checkup_interval" is
+        * missing or has a negative value
+        */
+       int checkup_interval;
+       struct uloop_timeout checkup_timeout;
+
        struct netifd_process script_task;
        struct netifd_process proto_task;
 
        enum proto_shell_sm sm;
        bool proto_task_killed;
+       bool renew_pending;
 
        int last_error;
 
@@ -109,10 +121,16 @@ proto_shell_update_host_dep(struct proto_shell_dependency *dep)
        if (dep->dep.iface)
                goto out;
 
-       if (dep->interface[0])
+       if (dep->interface[0]) {
                iface = vlist_find(&interfaces, dep->interface, iface, node);
 
-       iface = interface_ip_add_target_route(&dep->host, dep->v6, iface);
+               if (!iface || iface->state != IFS_UP)
+                       goto out;
+       }
+
+       if (!dep->any)
+               iface = interface_ip_add_target_route(&dep->host, dep->v6, iface);
+
        if (!iface)
                goto out;
 
@@ -155,33 +173,66 @@ proto_shell_handler(struct interface_proto_state *proto,
        proc = &state->script_task;
 
        if (cmd == PROTO_CMD_SETUP) {
-               action = "setup";
-               state->last_error = -1;
-               proto_shell_clear_host_dep(state);
-       } else {
-               if (state->sm == S_TEARDOWN)
+               switch (state->sm) {
+               case S_IDLE:
+                       action = "setup";
+                       state->last_error = -1;
+                       proto_shell_clear_host_dep(state);
+                       state->sm = S_SETUP;
+                       break;
+
+               case S_SETUP_ABORT:
+               case S_TEARDOWN:
+               case S_SETUP:
+                       return 0;
+
+               default:
+                       return -1;
+               }
+       } else if (cmd == PROTO_CMD_RENEW) {
+               if (!(handler->proto.flags & PROTO_FLAG_RENEW_AVAILABLE))
                        return 0;
 
                if (state->script_task.uloop.pending) {
-                       if (state->sm != S_SETUP_ABORT) {
+                       state->renew_pending = true;
+                       return 0;
+               }
+
+               state->renew_pending = false;
+               action = "renew";
+       } else {
+               switch (state->sm) {
+               case S_SETUP:
+                       if (state->script_task.uloop.pending) {
                                uloop_timeout_set(&state->teardown_timeout, 1000);
                                kill(state->script_task.uloop.pid, SIGTERM);
                                if (state->proto_task.uloop.pending)
                                        kill(state->proto_task.uloop.pid, SIGTERM);
+                               state->renew_pending = false;
                                state->sm = S_SETUP_ABORT;
+                               return 0;
+                       }
+               /* fall through if no script task is running */
+               case S_IDLE:
+                       action = "teardown";
+                       state->renew_pending = false;
+                       state->sm = S_TEARDOWN;
+                       if (state->last_error >= 0) {
+                               snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
+                               envp[j++] = error_buf;
                        }
+                       uloop_timeout_set(&state->teardown_timeout, 5000);
+                       break;
+
+               case S_TEARDOWN:
                        return 0;
-               }
 
-               action = "teardown";
-               state->sm = S_TEARDOWN;
-               if (state->last_error >= 0) {
-                       snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
-                       envp[j++] = error_buf;
+               default:
+                       return -1;
                }
-               uloop_timeout_set(&state->teardown_timeout, 5000);
        }
 
+       D(INTERFACE, "run %s for interface '%s'\n", action, proto->iface->name);
        config = blobmsg_format_json(state->config, true);
        if (!config)
                return -1;
@@ -250,6 +301,23 @@ proto_shell_task_finish(struct proto_shell_state *state,
                if (task == &state->proto_task)
                        proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
                                            false);
+               else if (task == &state->script_task) {
+                       if (state->renew_pending)
+                               proto_shell_handler(&state->proto,
+                                                   PROTO_CMD_RENEW, false);
+                       else if (!(state->handler->proto.flags & PROTO_FLAG_NO_TASK) &&
+                                !state->proto_task.uloop.pending &&
+                                state->sm == S_SETUP)
+                               proto_shell_handler(&state->proto,
+                                                   PROTO_CMD_TEARDOWN,
+                                                   false);
+
+                       /* check up status after setup attempt by this script_task */
+                       if (state->sm == S_SETUP && state->checkup_interval > 0) {
+                               uloop_timeout_set(&state->checkup_timeout,
+                                                 state->checkup_interval * 1000);
+                       }
+               }
                break;
 
        case S_SETUP_ABORT:
@@ -257,7 +325,9 @@ proto_shell_task_finish(struct proto_shell_state *state,
                    state->proto_task.uloop.pending)
                        break;
 
+               /* completed aborting all tasks, now idle */
                uloop_timeout_cancel(&state->teardown_timeout);
+               uloop_timeout_cancel(&state->checkup_timeout);
                state->sm = S_IDLE;
                proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
                break;
@@ -272,7 +342,9 @@ proto_shell_task_finish(struct proto_shell_state *state,
                        break;
                }
 
+               /* completed tearing down all tasks, now idle */
                uloop_timeout_cancel(&state->teardown_timeout);
+               uloop_timeout_cancel(&state->checkup_timeout);
                state->sm = S_IDLE;
                state->proto.proto_event(&state->proto, IFPEV_DOWN);
                break;
@@ -320,6 +392,7 @@ proto_shell_free(struct interface_proto_state *proto)
 
        state = container_of(proto, struct proto_shell_state, proto);
        uloop_timeout_cancel(&state->teardown_timeout);
+       uloop_timeout_cancel(&state->checkup_timeout);
        proto_shell_clear_host_dep(state);
        netifd_kill_process(&state->script_task);
        netifd_kill_process(&state->proto_task);
@@ -422,6 +495,9 @@ proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data,
        bool keep = false;
        bool up;
 
+       if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
+               return UBUS_STATUS_PERMISSION_DENIED;
+
        if (!tb[NOTIFY_LINK_UP])
                return UBUS_STATUS_INVALID_ARGUMENT;
 
@@ -440,30 +516,31 @@ proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data,
                        dev_create = 2;
        }
 
-       if (!tb[NOTIFY_IFNAME]) {
-               if (!iface->main_dev.dev)
-                       return UBUS_STATUS_INVALID_ARGUMENT;
-       } else if (!keep || iface->state != IFS_UP) {
+       if (iface->state != IFS_UP || !iface->l3_dev.dev)
                keep = false;
-               devname = blobmsg_data(tb[NOTIFY_IFNAME]);
-               if (tb[NOTIFY_TUNNEL]) {
-                       dev = proto_shell_create_tunnel(devname,
-                               tb[NOTIFY_TUNNEL]);
-                       if (!dev)
-                               return UBUS_STATUS_INVALID_ARGUMENT;
-               } else {
-                       dev = device_get(devname, dev_create);
-                       if (!dev)
-                               return UBUS_STATUS_NOT_FOUND;
+
+       if (!keep) {
+               dev = iface->main_dev.dev;
+               if (tb[NOTIFY_IFNAME]) {
+                       keep = false;
+                       devname = blobmsg_data(tb[NOTIFY_IFNAME]);
+                       if (tb[NOTIFY_TUNNEL])
+                               dev = proto_shell_create_tunnel(devname, tb[NOTIFY_TUNNEL]);
+                       else
+                               dev = device_get(devname, dev_create);
                }
 
+               if (!dev)
+                       return UBUS_STATUS_INVALID_ARGUMENT;
+
                interface_set_l3_dev(iface, dev);
-               device_claim(&iface->l3_dev);
+               if (device_claim(&iface->l3_dev) < 0)
+                       return UBUS_STATUS_UNKNOWN_ERROR;
+
                device_set_present(dev, true);
-       }
 
-       if (!keep)
                interface_update_start(iface);
+       }
 
        proto_apply_ip_settings(iface, data, addr_ext);
 
@@ -479,15 +556,17 @@ proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data,
        if ((cur = tb[NOTIFY_DNS_SEARCH]))
                interface_add_dns_search_list(&iface->proto_ip, cur);
 
-       interface_update_complete(state->proto.iface);
-
-       if (!keep)
-               state->proto.proto_event(&state->proto, IFPEV_UP);
-       state->sm = S_IDLE;
-
        if ((cur = tb[NOTIFY_DATA]))
                proto_shell_parse_data(state->proto.iface, cur);
 
+       interface_update_complete(state->proto.iface);
+
+       if ((state->sm != S_SETUP_ABORT) && (state->sm != S_TEARDOWN)) {
+               if (!keep)
+                       state->proto.proto_event(&state->proto, IFPEV_UP);
+               state->sm = S_IDLE;
+       }
+
        return 0;
 }
 
@@ -524,6 +603,9 @@ proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
        static char *argv[64];
        static char *env[32];
 
+       if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
+               return UBUS_STATUS_PERMISSION_DENIED;
+
        if (!tb[NOTIFY_COMMAND])
                goto error;
 
@@ -553,7 +635,8 @@ proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
                signal = SIGTERM;
 
        if (state->proto_task.uloop.pending) {
-               state->proto_task_killed = true;
+               if (signal == SIGTERM || signal == SIGKILL)
+                       state->proto_task_killed = true;
                kill(state->proto_task.uloop.pid, signal);
        }
 
@@ -617,16 +700,20 @@ static int
 proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_attr **tb)
 {
        struct proto_shell_dependency *dep;
-       struct blob_attr *host = tb[NOTIFY_HOST];
-       struct blob_attr *ifname = tb[NOTIFY_IFNAME];
-       size_t ifnamelen = (ifname) ? blobmsg_data_len(ifname) : 1;
+       const char *ifname = tb[NOTIFY_IFNAME] ? blobmsg_data(tb[NOTIFY_IFNAME]) : "";
+       const char *host = tb[NOTIFY_HOST] ? blobmsg_data(tb[NOTIFY_HOST]) : "";
 
-       if (!host)
-               return UBUS_STATUS_INVALID_ARGUMENT;
+       if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
+               return UBUS_STATUS_PERMISSION_DENIED;
+
+       dep = calloc(1, sizeof(*dep) + strlen(ifname) + 1);
+       if (!dep)
+               return UBUS_STATUS_UNKNOWN_ERROR;
 
-       dep = calloc(1, sizeof(*dep) + ifnamelen);
-       if (inet_pton(AF_INET, blobmsg_data(host), &dep->host) < 1) {
-               if (inet_pton(AF_INET6, blobmsg_data(host), &dep->host) < 1) {
+       if (!host[0] && ifname[0]) {
+               dep->any = true;
+       } else if (inet_pton(AF_INET, host, &dep->host) < 1) {
+               if (inet_pton(AF_INET6, host, &dep->host) < 1) {
                        free(dep);
                        return UBUS_STATUS_INVALID_ARGUMENT;
                } else {
@@ -635,10 +722,7 @@ proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_att
        }
 
        dep->proto = state;
-       if (ifname)
-               memcpy(dep->interface, blobmsg_data(ifname), ifnamelen);
-       else
-               dep->interface[0] = 0;
+       strcpy(dep->interface, ifname);
 
        dep->dep.cb = proto_shell_if_up_cb;
        interface_add_user(&dep->dep, NULL);
@@ -653,6 +737,8 @@ proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_att
 static int
 proto_shell_setup_failed(struct proto_shell_state *state)
 {
+       int ret = 0;
+
        switch (state->sm) {
        case S_IDLE:
                state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
@@ -660,10 +746,13 @@ proto_shell_setup_failed(struct proto_shell_state *state)
        case S_SETUP:
                proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
                break;
+       case S_SETUP_ABORT:
+       case S_TEARDOWN:
        default:
+               ret = UBUS_STATUS_PERMISSION_DENIED;
                break;
        }
-       return 0;
+       return ret;
 }
 
 static int
@@ -700,6 +789,45 @@ proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
        }
 }
 
+static void
+proto_shell_checkup_timeout_cb(struct uloop_timeout *timeout)
+{
+       struct proto_shell_state *state = container_of(timeout, struct
+                       proto_shell_state, checkup_timeout);
+       struct interface_proto_state *proto = &state->proto;
+       struct interface *iface = proto->iface;
+
+       if (!iface->autostart)
+               return;
+
+       if (iface->state == IFS_UP)
+               return;
+
+       D(INTERFACE, "Interface '%s' is not up after %d sec\n",
+                       iface->name, state->checkup_interval);
+       proto_shell_handler(proto, PROTO_CMD_TEARDOWN, false);
+}
+
+static void
+proto_shell_checkup_attach(struct proto_shell_state *state,
+               const struct blob_attr *attr)
+{
+       struct blob_attr *tb;
+       struct blobmsg_policy checkup_policy = {
+               .name = "checkup_interval",
+               .type = BLOBMSG_TYPE_INT32
+       };
+
+       blobmsg_parse(&checkup_policy, 1, &tb, blob_data(attr), blob_len(attr));
+       if (!tb) {
+               state->checkup_interval = -1;
+               state->checkup_timeout.cb = NULL;
+       } else {
+               state->checkup_interval = blobmsg_get_u32(tb);
+               state->checkup_timeout.cb = proto_shell_checkup_timeout_cb;
+       }
+}
+
 static struct interface_proto_state *
 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
                   struct blob_attr *attr)
@@ -707,6 +835,9 @@ proto_shell_attach(const struct proto_handler *h, struct interface *iface,
        struct proto_shell_state *state;
 
        state = calloc(1, sizeof(*state));
+       if (!state)
+               return NULL;
+
        INIT_LIST_HEAD(&state->deps);
 
        state->config = malloc(blob_pad_len(attr));
@@ -714,6 +845,7 @@ proto_shell_attach(const struct proto_handler *h, struct interface *iface,
                goto error;
 
        memcpy(state->config, attr, blob_pad_len(attr));
+       proto_shell_checkup_attach(state, state->config);
        state->proto.free = proto_shell_free;
        state->proto.notify = proto_shell_notify;
        state->proto.cb = proto_shell_handler;
@@ -739,18 +871,18 @@ proto_shell_add_handler(const char *script, const char *name, json_object *obj)
        struct proto_shell_handler *handler;
        struct proto_handler *proto;
        json_object *config, *tmp;
-       char *str;
+       char *proto_name, *script_name;
 
-       handler = calloc_a(sizeof(*handler) + strlen(script) + 1,
-                          &str, strlen(name) + 1);
+       handler = calloc_a(sizeof(*handler),
+                          &proto_name, strlen(name) + 1,
+                          &script_name, strlen(script) + 1);
        if (!handler)
                return;
 
-       strcpy(handler->script_name, script);
-       strcpy(str, name);
+       handler->script_name = strcpy(script_name, script);
 
        proto = &handler->proto;
-       proto->name = str;
+       proto->name = strcpy(proto_name, name);
        proto->config_params = &handler->config;
        proto->attach = proto_shell_attach;
 
@@ -758,10 +890,26 @@ proto_shell_add_handler(const char *script, const char *name, json_object *obj)
        if (tmp && json_object_get_boolean(tmp))
                handler->proto.flags |= PROTO_FLAG_NODEV;
 
+       tmp = json_get_field(obj, "no-proto-task", json_type_boolean);
+       if (tmp && json_object_get_boolean(tmp))
+               handler->proto.flags |= PROTO_FLAG_NO_TASK;
+
        tmp = json_get_field(obj, "available", json_type_boolean);
        if (tmp && json_object_get_boolean(tmp))
                handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
 
+       tmp = json_get_field(obj, "renew-handler", json_type_boolean);
+       if (tmp && json_object_get_boolean(tmp))
+               handler->proto.flags |= PROTO_FLAG_RENEW_AVAILABLE;
+
+       tmp = json_get_field(obj, "lasterror", json_type_boolean);
+       if (tmp && json_object_get_boolean(tmp))
+               handler->proto.flags |= PROTO_FLAG_LASTERROR;
+
+       tmp = json_get_field(obj, "teardown-on-l3-link-down", json_type_boolean);
+       if (tmp && json_object_get_boolean(tmp))
+               handler->proto.flags |= PROTO_FLAG_TEARDOWN_ON_L3_LINK_DOWN;
+
        config = json_get_field(obj, "config", json_type_array);
        if (config)
                handler->config_buf = netifd_handler_parse_config(&handler->config, config);
@@ -770,7 +918,7 @@ proto_shell_add_handler(const char *script, const char *name, json_object *obj)
        add_proto_handler(proto);
 }
 
-static void __init proto_shell_init(void)
+void proto_shell_init(void)
 {
        proto_fd = netifd_open_subdir("proto");
        if (proto_fd < 0)