2 * netifd - network interface daemon
3 * Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2
7 * as published by the Free Software Foundation
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
21 #include <arpa/inet.h>
22 #include <netinet/in.h>
26 #include "interface.h"
27 #include "interface-ip.h"
32 static int proto_fd = -1;
41 struct proto_shell_handler {
42 struct list_head list;
43 struct proto_handler proto;
48 struct uci_blob_param_list config;
51 struct proto_shell_dependency {
52 struct list_head list;
54 struct proto_shell_state *proto;
55 struct interface_user dep;
64 struct proto_shell_state {
65 struct interface_proto_state proto;
66 struct proto_shell_handler *handler;
67 struct blob_attr *config;
69 struct uloop_timeout teardown_timeout;
72 * Teardown and setup interface again if it is still not up (IFS_UP)
73 * after checkup_interval seconds since previous attempt. This check
74 * will be disabled when the config option "checkup_interval" is
75 * missing or has a negative value
78 struct uloop_timeout checkup_timeout;
80 struct netifd_process script_task;
81 struct netifd_process proto_task;
83 enum proto_shell_sm sm;
84 bool proto_task_killed;
89 struct list_head deps;
93 proto_shell_check_dependencies(struct proto_shell_state *state)
95 struct proto_shell_dependency *dep;
96 bool available = true;
98 list_for_each_entry(dep, &state->deps, list) {
106 interface_set_available(state->proto.iface, available);
110 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
111 enum interface_event ev);
113 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
114 enum interface_event ev);
117 proto_shell_update_host_dep(struct proto_shell_dependency *dep)
119 struct interface *iface = NULL;
124 if (dep->interface[0]) {
125 iface = vlist_find(&interfaces, dep->interface, iface, node);
127 if (!iface || iface->state != IFS_UP)
132 iface = interface_ip_add_target_route(&dep->host, dep->v6, iface);
137 interface_remove_user(&dep->dep);
138 dep->dep.cb = proto_shell_if_down_cb;
139 interface_add_user(&dep->dep, iface);
142 proto_shell_check_dependencies(dep->proto);
146 proto_shell_clear_host_dep(struct proto_shell_state *state)
148 struct proto_shell_dependency *dep, *tmp;
150 list_for_each_entry_safe(dep, tmp, &state->deps, list) {
151 interface_remove_user(&dep->dep);
152 list_del(&dep->list);
158 proto_shell_handler(struct interface_proto_state *proto,
159 enum interface_proto_cmd cmd, bool force)
161 struct proto_shell_state *state;
162 struct proto_shell_handler *handler;
163 struct netifd_process *proc;
164 static char error_buf[32];
169 int ret, i = 0, j = 0;
171 state = container_of(proto, struct proto_shell_state, proto);
172 handler = state->handler;
173 proc = &state->script_task;
175 if (cmd == PROTO_CMD_SETUP) {
179 state->last_error = -1;
180 proto_shell_clear_host_dep(state);
192 } else if (cmd == PROTO_CMD_RENEW) {
193 if (!(handler->proto.flags & PROTO_FLAG_RENEW_AVAILABLE))
196 if (state->script_task.uloop.pending) {
197 state->renew_pending = true;
201 state->renew_pending = false;
206 if (state->script_task.uloop.pending) {
207 uloop_timeout_set(&state->teardown_timeout, 1000);
208 kill(state->script_task.uloop.pid, SIGTERM);
209 if (state->proto_task.uloop.pending)
210 kill(state->proto_task.uloop.pid, SIGTERM);
211 state->renew_pending = false;
212 state->sm = S_SETUP_ABORT;
215 /* fall through if no script task is running */
218 state->renew_pending = false;
219 state->sm = S_TEARDOWN;
220 if (state->last_error >= 0) {
221 snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
222 envp[j++] = error_buf;
224 uloop_timeout_set(&state->teardown_timeout, 5000);
235 D(INTERFACE, "run %s for interface '%s'\n", action, proto->iface->name);
236 config = blobmsg_format_json(state->config, true);
240 argv[i++] = handler->script_name;
241 argv[i++] = handler->proto.name;
243 argv[i++] = proto->iface->name;
245 if (proto->iface->main_dev.dev)
246 argv[i++] = proto->iface->main_dev.dev->ifname;
250 ret = netifd_start_process(argv, envp, proc);
257 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
258 enum interface_event ev)
260 struct proto_shell_dependency *pdep;
262 if (ev != IFEV_UP && ev != IFEV_UPDATE)
265 pdep = container_of(dep, struct proto_shell_dependency, dep);
266 proto_shell_update_host_dep(pdep);
270 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
271 enum interface_event ev)
273 struct proto_shell_dependency *pdep;
274 struct proto_shell_state *state;
276 if (ev == IFEV_UP || ev == IFEV_UPDATE)
279 pdep = container_of(dep, struct proto_shell_dependency, dep);
280 interface_remove_user(dep);
281 dep->cb = proto_shell_if_up_cb;
282 interface_add_user(dep, NULL);
285 if (state->sm == S_IDLE) {
286 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
287 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
292 proto_shell_task_finish(struct proto_shell_state *state,
293 struct netifd_process *task)
297 if (task == &state->proto_task)
298 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
301 if (task == &state->proto_task)
302 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
304 else if (task == &state->script_task) {
305 if (state->renew_pending)
306 proto_shell_handler(&state->proto,
307 PROTO_CMD_RENEW, false);
308 else if (!(state->handler->proto.flags & PROTO_FLAG_NO_TASK) &&
309 !state->proto_task.uloop.pending &&
310 state->sm == S_SETUP)
311 proto_shell_handler(&state->proto,
315 /* check up status after setup attempt by this script_task */
316 if (state->sm == S_SETUP && state->checkup_interval > 0) {
317 uloop_timeout_set(&state->checkup_timeout,
318 state->checkup_interval * 1000);
324 if (state->script_task.uloop.pending ||
325 state->proto_task.uloop.pending)
328 /* completed aborting all tasks, now idle */
329 uloop_timeout_cancel(&state->teardown_timeout);
330 uloop_timeout_cancel(&state->checkup_timeout);
332 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
336 if (state->script_task.uloop.pending)
339 if (state->proto_task.uloop.pending) {
340 if (!state->proto_task_killed)
341 kill(state->proto_task.uloop.pid, SIGTERM);
345 /* completed tearing down all tasks, now idle */
346 uloop_timeout_cancel(&state->teardown_timeout);
347 uloop_timeout_cancel(&state->checkup_timeout);
349 state->proto.proto_event(&state->proto, IFPEV_DOWN);
355 proto_shell_teardown_timeout_cb(struct uloop_timeout *timeout)
357 struct proto_shell_state *state;
359 state = container_of(timeout, struct proto_shell_state, teardown_timeout);
361 netifd_kill_process(&state->script_task);
362 netifd_kill_process(&state->proto_task);
363 proto_shell_task_finish(state, NULL);
367 proto_shell_script_cb(struct netifd_process *p, int ret)
369 struct proto_shell_state *state;
371 state = container_of(p, struct proto_shell_state, script_task);
372 proto_shell_task_finish(state, p);
376 proto_shell_task_cb(struct netifd_process *p, int ret)
378 struct proto_shell_state *state;
380 state = container_of(p, struct proto_shell_state, proto_task);
382 if (state->sm == S_IDLE || state->sm == S_SETUP)
383 state->last_error = WEXITSTATUS(ret);
385 proto_shell_task_finish(state, p);
389 proto_shell_free(struct interface_proto_state *proto)
391 struct proto_shell_state *state;
393 state = container_of(proto, struct proto_shell_state, proto);
394 uloop_timeout_cancel(&state->teardown_timeout);
395 uloop_timeout_cancel(&state->checkup_timeout);
396 proto_shell_clear_host_dep(state);
397 netifd_kill_process(&state->script_task);
398 netifd_kill_process(&state->proto_task);
404 proto_shell_parse_route_list(struct interface *iface, struct blob_attr *attr,
407 struct blob_attr *cur;
410 blobmsg_for_each_attr(cur, attr, rem) {
411 if (blobmsg_type(cur) != BLOBMSG_TYPE_TABLE) {
412 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur));
416 interface_ip_add_route(iface, cur, v6);
421 proto_shell_parse_data(struct interface *iface, struct blob_attr *attr)
423 struct blob_attr *cur;
426 blobmsg_for_each_attr(cur, attr, rem)
427 interface_add_data(iface, cur);
430 static struct device *
431 proto_shell_create_tunnel(const char *name, struct blob_attr *attr)
436 memset(&b, 0, sizeof(b));
437 blob_buf_init(&b, 0);
438 blob_put(&b, 0, blobmsg_data(attr), blobmsg_data_len(attr));
439 dev = device_create(name, &tunnel_device_type, blob_data(b.head));
466 static const struct blobmsg_policy notify_attr[__NOTIFY_LAST] = {
467 [NOTIFY_ACTION] = { .name = "action", .type = BLOBMSG_TYPE_INT32 },
468 [NOTIFY_ERROR] = { .name = "error", .type = BLOBMSG_TYPE_ARRAY },
469 [NOTIFY_COMMAND] = { .name = "command", .type = BLOBMSG_TYPE_ARRAY },
470 [NOTIFY_ENV] = { .name = "env", .type = BLOBMSG_TYPE_ARRAY },
471 [NOTIFY_SIGNAL] = { .name = "signal", .type = BLOBMSG_TYPE_INT32 },
472 [NOTIFY_AVAILABLE] = { .name = "available", .type = BLOBMSG_TYPE_BOOL },
473 [NOTIFY_LINK_UP] = { .name = "link-up", .type = BLOBMSG_TYPE_BOOL },
474 [NOTIFY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING },
475 [NOTIFY_ADDR_EXT] = { .name = "address-external", .type = BLOBMSG_TYPE_BOOL },
476 [NOTIFY_ROUTES] = { .name = "routes", .type = BLOBMSG_TYPE_ARRAY },
477 [NOTIFY_ROUTES6] = { .name = "routes6", .type = BLOBMSG_TYPE_ARRAY },
478 [NOTIFY_TUNNEL] = { .name = "tunnel", .type = BLOBMSG_TYPE_TABLE },
479 [NOTIFY_DATA] = { .name = "data", .type = BLOBMSG_TYPE_TABLE },
480 [NOTIFY_KEEP] = { .name = "keep", .type = BLOBMSG_TYPE_BOOL },
481 [NOTIFY_HOST] = { .name = "host", .type = BLOBMSG_TYPE_STRING },
482 [NOTIFY_DNS] = { .name = "dns", .type = BLOBMSG_TYPE_ARRAY },
483 [NOTIFY_DNS_SEARCH] = { .name = "dns_search", .type = BLOBMSG_TYPE_ARRAY },
487 proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data, struct blob_attr **tb)
489 struct interface *iface = state->proto.iface;
490 struct blob_attr *cur;
494 bool addr_ext = false;
498 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
499 return UBUS_STATUS_PERMISSION_DENIED;
501 if (!tb[NOTIFY_LINK_UP])
502 return UBUS_STATUS_INVALID_ARGUMENT;
504 up = blobmsg_get_bool(tb[NOTIFY_LINK_UP]);
506 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
510 if ((cur = tb[NOTIFY_KEEP]) != NULL)
511 keep = blobmsg_get_bool(cur);
513 if ((cur = tb[NOTIFY_ADDR_EXT]) != NULL) {
514 addr_ext = blobmsg_get_bool(cur);
519 if (iface->state != IFS_UP || !iface->l3_dev.dev)
523 dev = iface->main_dev.dev;
524 if (tb[NOTIFY_IFNAME]) {
526 devname = blobmsg_data(tb[NOTIFY_IFNAME]);
527 if (tb[NOTIFY_TUNNEL])
528 dev = proto_shell_create_tunnel(devname, tb[NOTIFY_TUNNEL]);
530 dev = device_get(devname, dev_create);
534 return UBUS_STATUS_INVALID_ARGUMENT;
536 interface_set_l3_dev(iface, dev);
537 if (device_claim(&iface->l3_dev) < 0)
538 return UBUS_STATUS_UNKNOWN_ERROR;
540 device_set_present(dev, true);
543 interface_update_start(iface, keep);
545 proto_apply_ip_settings(iface, data, addr_ext);
547 if ((cur = tb[NOTIFY_ROUTES]) != NULL)
548 proto_shell_parse_route_list(state->proto.iface, cur, false);
550 if ((cur = tb[NOTIFY_ROUTES6]) != NULL)
551 proto_shell_parse_route_list(state->proto.iface, cur, true);
553 if ((cur = tb[NOTIFY_DNS]))
554 interface_add_dns_server_list(&iface->proto_ip, cur);
556 if ((cur = tb[NOTIFY_DNS_SEARCH]))
557 interface_add_dns_search_list(&iface->proto_ip, cur);
559 if ((cur = tb[NOTIFY_DATA]))
560 proto_shell_parse_data(state->proto.iface, cur);
562 interface_update_complete(state->proto.iface);
564 if ((state->sm != S_SETUP_ABORT) && (state->sm != S_TEARDOWN)) {
565 state->proto.proto_event(&state->proto, IFPEV_UP);
573 fill_string_list(struct blob_attr *attr, char **argv, int max)
575 struct blob_attr *cur;
582 blobmsg_for_each_attr(cur, attr, rem) {
583 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
586 if (!blobmsg_check_attr(cur, NULL))
589 argv[argc++] = blobmsg_data(cur);
600 proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
602 static char *argv[64];
603 static char *env[32];
605 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
606 return UBUS_STATUS_PERMISSION_DENIED;
608 if (!tb[NOTIFY_COMMAND])
611 if (!fill_string_list(tb[NOTIFY_COMMAND], argv, ARRAY_SIZE(argv)))
614 if (!fill_string_list(tb[NOTIFY_ENV], env, ARRAY_SIZE(env)))
617 netifd_start_process((const char **) argv, (char **) env, &state->proto_task);
622 return UBUS_STATUS_INVALID_ARGUMENT;
626 proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
628 unsigned int signal = ~0;
630 if (tb[NOTIFY_SIGNAL])
631 signal = blobmsg_get_u32(tb[NOTIFY_SIGNAL]);
636 if (state->proto_task.uloop.pending) {
637 if (signal == SIGTERM || signal == SIGKILL)
638 state->proto_task_killed = true;
639 kill(state->proto_task.uloop.pid, signal);
646 proto_shell_notify_error(struct proto_shell_state *state, struct blob_attr **tb)
648 struct blob_attr *cur;
653 if (!tb[NOTIFY_ERROR])
654 return UBUS_STATUS_INVALID_ARGUMENT;
656 blobmsg_for_each_attr(cur, tb[NOTIFY_ERROR], rem) {
657 if (n_data + 1 == ARRAY_SIZE(data))
660 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
663 if (!blobmsg_check_attr(cur, NULL))
666 data[n_data++] = blobmsg_data(cur);
672 interface_add_error(state->proto.iface, state->handler->proto.name,
673 data[0], (const char **) &data[1], n_data - 1);
678 return UBUS_STATUS_INVALID_ARGUMENT;
682 proto_shell_block_restart(struct proto_shell_state *state, struct blob_attr **tb)
684 state->proto.iface->autostart = false;
689 proto_shell_set_available(struct proto_shell_state *state, struct blob_attr **tb)
691 if (!tb[NOTIFY_AVAILABLE])
692 return UBUS_STATUS_INVALID_ARGUMENT;
694 interface_set_available(state->proto.iface, blobmsg_get_bool(tb[NOTIFY_AVAILABLE]));
699 proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_attr **tb)
701 struct proto_shell_dependency *dep;
702 const char *ifname = tb[NOTIFY_IFNAME] ? blobmsg_data(tb[NOTIFY_IFNAME]) : "";
703 const char *host = tb[NOTIFY_HOST] ? blobmsg_data(tb[NOTIFY_HOST]) : "";
705 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
706 return UBUS_STATUS_PERMISSION_DENIED;
708 dep = calloc(1, sizeof(*dep) + strlen(ifname) + 1);
710 return UBUS_STATUS_UNKNOWN_ERROR;
712 if (!host[0] && ifname[0]) {
714 } else if (inet_pton(AF_INET, host, &dep->host) < 1) {
715 if (inet_pton(AF_INET6, host, &dep->host) < 1) {
717 return UBUS_STATUS_INVALID_ARGUMENT;
724 strcpy(dep->interface, ifname);
726 dep->dep.cb = proto_shell_if_up_cb;
727 interface_add_user(&dep->dep, NULL);
728 list_add(&dep->list, &state->deps);
729 proto_shell_update_host_dep(dep);
731 return UBUS_STATUS_NOT_FOUND;
737 proto_shell_setup_failed(struct proto_shell_state *state)
743 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
746 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
751 ret = UBUS_STATUS_PERMISSION_DENIED;
758 proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
760 struct proto_shell_state *state;
761 struct blob_attr *tb[__NOTIFY_LAST];
763 state = container_of(proto, struct proto_shell_state, proto);
765 blobmsg_parse(notify_attr, __NOTIFY_LAST, tb, blob_data(attr), blob_len(attr));
766 if (!tb[NOTIFY_ACTION])
767 return UBUS_STATUS_INVALID_ARGUMENT;
769 switch(blobmsg_get_u32(tb[NOTIFY_ACTION])) {
771 return proto_shell_update_link(state, attr, tb);
773 return proto_shell_run_command(state, tb);
775 return proto_shell_kill_command(state, tb);
777 return proto_shell_notify_error(state, tb);
779 return proto_shell_block_restart(state, tb);
781 return proto_shell_set_available(state, tb);
783 return proto_shell_add_host_dependency(state, tb);
785 return proto_shell_setup_failed(state);
787 return UBUS_STATUS_INVALID_ARGUMENT;
792 proto_shell_checkup_timeout_cb(struct uloop_timeout *timeout)
794 struct proto_shell_state *state = container_of(timeout, struct
795 proto_shell_state, checkup_timeout);
796 struct interface_proto_state *proto = &state->proto;
797 struct interface *iface = proto->iface;
799 if (!iface->autostart)
802 if (iface->state == IFS_UP)
805 D(INTERFACE, "Interface '%s' is not up after %d sec\n",
806 iface->name, state->checkup_interval);
807 proto_shell_handler(proto, PROTO_CMD_TEARDOWN, false);
811 proto_shell_checkup_attach(struct proto_shell_state *state,
812 const struct blob_attr *attr)
814 struct blob_attr *tb;
815 struct blobmsg_policy checkup_policy = {
816 .name = "checkup_interval",
817 .type = BLOBMSG_TYPE_INT32
820 blobmsg_parse(&checkup_policy, 1, &tb, blob_data(attr), blob_len(attr));
822 state->checkup_interval = -1;
823 state->checkup_timeout.cb = NULL;
825 state->checkup_interval = blobmsg_get_u32(tb);
826 state->checkup_timeout.cb = proto_shell_checkup_timeout_cb;
830 static struct interface_proto_state *
831 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
832 struct blob_attr *attr)
834 struct proto_shell_state *state;
836 state = calloc(1, sizeof(*state));
840 INIT_LIST_HEAD(&state->deps);
842 state->config = malloc(blob_pad_len(attr));
846 memcpy(state->config, attr, blob_pad_len(attr));
847 proto_shell_checkup_attach(state, state->config);
848 state->proto.free = proto_shell_free;
849 state->proto.notify = proto_shell_notify;
850 state->proto.cb = proto_shell_handler;
851 state->teardown_timeout.cb = proto_shell_teardown_timeout_cb;
852 state->script_task.cb = proto_shell_script_cb;
853 state->script_task.dir_fd = proto_fd;
854 state->script_task.log_prefix = iface->name;
855 state->proto_task.cb = proto_shell_task_cb;
856 state->proto_task.dir_fd = proto_fd;
857 state->proto_task.log_prefix = iface->name;
858 state->handler = container_of(h, struct proto_shell_handler, proto);
860 return &state->proto;
868 proto_shell_add_handler(const char *script, const char *name, json_object *obj)
870 struct proto_shell_handler *handler;
871 struct proto_handler *proto;
872 json_object *config, *tmp;
873 char *proto_name, *script_name;
875 handler = calloc_a(sizeof(*handler),
876 &proto_name, strlen(name) + 1,
877 &script_name, strlen(script) + 1);
881 handler->script_name = strcpy(script_name, script);
883 proto = &handler->proto;
884 proto->name = strcpy(proto_name, name);
885 proto->config_params = &handler->config;
886 proto->attach = proto_shell_attach;
888 tmp = json_get_field(obj, "no-device", json_type_boolean);
889 if (tmp && json_object_get_boolean(tmp))
890 handler->proto.flags |= PROTO_FLAG_NODEV;
892 tmp = json_get_field(obj, "no-proto-task", json_type_boolean);
893 if (tmp && json_object_get_boolean(tmp))
894 handler->proto.flags |= PROTO_FLAG_NO_TASK;
896 tmp = json_get_field(obj, "available", json_type_boolean);
897 if (tmp && json_object_get_boolean(tmp))
898 handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
900 tmp = json_get_field(obj, "renew-handler", json_type_boolean);
901 if (tmp && json_object_get_boolean(tmp))
902 handler->proto.flags |= PROTO_FLAG_RENEW_AVAILABLE;
904 tmp = json_get_field(obj, "lasterror", json_type_boolean);
905 if (tmp && json_object_get_boolean(tmp))
906 handler->proto.flags |= PROTO_FLAG_LASTERROR;
908 tmp = json_get_field(obj, "teardown-on-l3-link-down", json_type_boolean);
909 if (tmp && json_object_get_boolean(tmp))
910 handler->proto.flags |= PROTO_FLAG_TEARDOWN_ON_L3_LINK_DOWN;
912 config = json_get_field(obj, "config", json_type_array);
914 handler->config_buf = netifd_handler_parse_config(&handler->config, config);
916 DPRINTF("Add handler for script %s: %s\n", script, proto->name);
917 add_proto_handler(proto);
920 void proto_shell_init(void)
922 proto_fd = netifd_open_subdir("proto");
926 netifd_init_script_handlers(proto_fd, proto_shell_add_handler);