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;
55 struct proto_shell_state *proto;
56 struct interface_user dep;
62 struct proto_shell_state {
63 struct interface_proto_state proto;
64 struct proto_shell_handler *handler;
65 struct blob_attr *config;
67 struct uloop_timeout teardown_timeout;
69 struct netifd_process script_task;
70 struct netifd_process proto_task;
72 enum proto_shell_sm sm;
73 bool proto_task_killed;
78 struct list_head deps;
82 proto_shell_check_dependencies(struct proto_shell_state *state)
84 struct proto_shell_dependency *dep;
85 bool available = true;
87 list_for_each_entry(dep, &state->deps, list) {
95 interface_set_available(state->proto.iface, available);
99 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
100 enum interface_event ev);
102 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
103 enum interface_event ev);
106 proto_shell_update_host_dep(struct proto_shell_dependency *dep)
108 struct interface *iface = NULL;
113 if (dep->interface[0])
114 iface = vlist_find(&interfaces, dep->interface, iface, node);
116 iface = interface_ip_add_target_route(&dep->host, dep->v6, iface);
120 interface_remove_user(&dep->dep);
121 dep->dep.cb = proto_shell_if_down_cb;
122 interface_add_user(&dep->dep, iface);
125 proto_shell_check_dependencies(dep->proto);
129 proto_shell_clear_host_dep(struct proto_shell_state *state)
131 struct proto_shell_dependency *dep, *tmp;
133 list_for_each_entry_safe(dep, tmp, &state->deps, list) {
134 interface_remove_user(&dep->dep);
135 list_del(&dep->list);
141 proto_shell_handler(struct interface_proto_state *proto,
142 enum interface_proto_cmd cmd, bool force)
144 struct proto_shell_state *state;
145 struct proto_shell_handler *handler;
146 struct netifd_process *proc;
147 static char error_buf[32];
152 int ret, i = 0, j = 0;
154 state = container_of(proto, struct proto_shell_state, proto);
155 handler = state->handler;
156 proc = &state->script_task;
158 if (cmd == PROTO_CMD_SETUP) {
160 state->last_error = -1;
161 proto_shell_clear_host_dep(state);
163 } else if (cmd == PROTO_CMD_RENEW) {
164 if (!(handler->proto.flags & PROTO_FLAG_RENEW_AVAILABLE))
167 if (state->script_task.uloop.pending) {
168 state->renew_pending = true;
172 state->renew_pending = false;
175 if (state->sm == S_TEARDOWN)
178 state->renew_pending = false;
179 if (state->script_task.uloop.pending) {
180 if (state->sm != S_SETUP_ABORT) {
181 uloop_timeout_set(&state->teardown_timeout, 1000);
182 kill(state->script_task.uloop.pid, SIGTERM);
183 if (state->proto_task.uloop.pending)
184 kill(state->proto_task.uloop.pid, SIGTERM);
185 state->sm = S_SETUP_ABORT;
191 state->sm = S_TEARDOWN;
192 if (state->last_error >= 0) {
193 snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
194 envp[j++] = error_buf;
196 uloop_timeout_set(&state->teardown_timeout, 5000);
199 D(INTERFACE, "run %s for interface '%s'\n", action, proto->iface->name);
200 config = blobmsg_format_json(state->config, true);
204 argv[i++] = handler->script_name;
205 argv[i++] = handler->proto.name;
207 argv[i++] = proto->iface->name;
209 if (proto->iface->main_dev.dev)
210 argv[i++] = proto->iface->main_dev.dev->ifname;
214 ret = netifd_start_process(argv, envp, proc);
221 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
222 enum interface_event ev)
224 struct proto_shell_dependency *pdep;
226 if (ev != IFEV_UP && ev != IFEV_UPDATE)
229 pdep = container_of(dep, struct proto_shell_dependency, dep);
230 proto_shell_update_host_dep(pdep);
234 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
235 enum interface_event ev)
237 struct proto_shell_dependency *pdep;
238 struct proto_shell_state *state;
240 if (ev == IFEV_UP || ev == IFEV_UPDATE)
243 pdep = container_of(dep, struct proto_shell_dependency, dep);
244 interface_remove_user(dep);
245 dep->cb = proto_shell_if_up_cb;
246 interface_add_user(dep, NULL);
249 if (state->sm == S_IDLE) {
250 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
251 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
256 proto_shell_task_finish(struct proto_shell_state *state,
257 struct netifd_process *task)
261 if (task == &state->proto_task)
262 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
265 if (task == &state->proto_task)
266 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
268 if (task == &state->script_task && state->renew_pending)
269 proto_shell_handler(&state->proto, PROTO_CMD_RENEW,
274 if (state->script_task.uloop.pending ||
275 state->proto_task.uloop.pending)
278 uloop_timeout_cancel(&state->teardown_timeout);
280 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
284 if (state->script_task.uloop.pending)
287 if (state->proto_task.uloop.pending) {
288 if (!state->proto_task_killed)
289 kill(state->proto_task.uloop.pid, SIGTERM);
293 uloop_timeout_cancel(&state->teardown_timeout);
295 state->proto.proto_event(&state->proto, IFPEV_DOWN);
301 proto_shell_teardown_timeout_cb(struct uloop_timeout *timeout)
303 struct proto_shell_state *state;
305 state = container_of(timeout, struct proto_shell_state, teardown_timeout);
307 netifd_kill_process(&state->script_task);
308 netifd_kill_process(&state->proto_task);
309 proto_shell_task_finish(state, NULL);
313 proto_shell_script_cb(struct netifd_process *p, int ret)
315 struct proto_shell_state *state;
317 state = container_of(p, struct proto_shell_state, script_task);
318 proto_shell_task_finish(state, p);
322 proto_shell_task_cb(struct netifd_process *p, int ret)
324 struct proto_shell_state *state;
326 state = container_of(p, struct proto_shell_state, proto_task);
328 if (state->sm == S_IDLE || state->sm == S_SETUP)
329 state->last_error = WEXITSTATUS(ret);
331 proto_shell_task_finish(state, p);
335 proto_shell_free(struct interface_proto_state *proto)
337 struct proto_shell_state *state;
339 state = container_of(proto, struct proto_shell_state, proto);
340 uloop_timeout_cancel(&state->teardown_timeout);
341 proto_shell_clear_host_dep(state);
342 netifd_kill_process(&state->script_task);
343 netifd_kill_process(&state->proto_task);
349 proto_shell_parse_route_list(struct interface *iface, struct blob_attr *attr,
352 struct blob_attr *cur;
355 blobmsg_for_each_attr(cur, attr, rem) {
356 if (blobmsg_type(cur) != BLOBMSG_TYPE_TABLE) {
357 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur));
361 interface_ip_add_route(iface, cur, v6);
366 proto_shell_parse_data(struct interface *iface, struct blob_attr *attr)
368 struct blob_attr *cur;
371 blobmsg_for_each_attr(cur, attr, rem)
372 interface_add_data(iface, cur);
375 static struct device *
376 proto_shell_create_tunnel(const char *name, struct blob_attr *attr)
381 memset(&b, 0, sizeof(b));
382 blob_buf_init(&b, 0);
383 blob_put(&b, 0, blobmsg_data(attr), blobmsg_data_len(attr));
384 dev = device_create(name, &tunnel_device_type, blob_data(b.head));
411 static const struct blobmsg_policy notify_attr[__NOTIFY_LAST] = {
412 [NOTIFY_ACTION] = { .name = "action", .type = BLOBMSG_TYPE_INT32 },
413 [NOTIFY_ERROR] = { .name = "error", .type = BLOBMSG_TYPE_ARRAY },
414 [NOTIFY_COMMAND] = { .name = "command", .type = BLOBMSG_TYPE_ARRAY },
415 [NOTIFY_ENV] = { .name = "env", .type = BLOBMSG_TYPE_ARRAY },
416 [NOTIFY_SIGNAL] = { .name = "signal", .type = BLOBMSG_TYPE_INT32 },
417 [NOTIFY_AVAILABLE] = { .name = "available", .type = BLOBMSG_TYPE_BOOL },
418 [NOTIFY_LINK_UP] = { .name = "link-up", .type = BLOBMSG_TYPE_BOOL },
419 [NOTIFY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING },
420 [NOTIFY_ADDR_EXT] = { .name = "address-external", .type = BLOBMSG_TYPE_BOOL },
421 [NOTIFY_ROUTES] = { .name = "routes", .type = BLOBMSG_TYPE_ARRAY },
422 [NOTIFY_ROUTES6] = { .name = "routes6", .type = BLOBMSG_TYPE_ARRAY },
423 [NOTIFY_TUNNEL] = { .name = "tunnel", .type = BLOBMSG_TYPE_TABLE },
424 [NOTIFY_DATA] = { .name = "data", .type = BLOBMSG_TYPE_TABLE },
425 [NOTIFY_KEEP] = { .name = "keep", .type = BLOBMSG_TYPE_BOOL },
426 [NOTIFY_HOST] = { .name = "host", .type = BLOBMSG_TYPE_STRING },
427 [NOTIFY_DNS] = { .name = "dns", .type = BLOBMSG_TYPE_ARRAY },
428 [NOTIFY_DNS_SEARCH] = { .name = "dns_search", .type = BLOBMSG_TYPE_ARRAY },
432 proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data, struct blob_attr **tb)
434 struct interface *iface = state->proto.iface;
435 struct blob_attr *cur;
439 bool addr_ext = false;
443 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
444 return UBUS_STATUS_PERMISSION_DENIED;
446 if (!tb[NOTIFY_LINK_UP])
447 return UBUS_STATUS_INVALID_ARGUMENT;
449 up = blobmsg_get_bool(tb[NOTIFY_LINK_UP]);
451 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
455 if ((cur = tb[NOTIFY_KEEP]) != NULL)
456 keep = blobmsg_get_bool(cur);
458 if ((cur = tb[NOTIFY_ADDR_EXT]) != NULL) {
459 addr_ext = blobmsg_get_bool(cur);
464 if (iface->state != IFS_UP || !iface->l3_dev.dev)
468 dev = iface->main_dev.dev;
469 if (tb[NOTIFY_IFNAME]) {
471 devname = blobmsg_data(tb[NOTIFY_IFNAME]);
472 if (tb[NOTIFY_TUNNEL])
473 dev = proto_shell_create_tunnel(devname, tb[NOTIFY_TUNNEL]);
475 dev = device_get(devname, dev_create);
479 return UBUS_STATUS_INVALID_ARGUMENT;
481 interface_set_l3_dev(iface, dev);
482 if (device_claim(&iface->l3_dev) < 0)
483 return UBUS_STATUS_UNKNOWN_ERROR;
485 device_set_present(dev, true);
487 interface_update_start(iface);
490 proto_apply_ip_settings(iface, data, addr_ext);
492 if ((cur = tb[NOTIFY_ROUTES]) != NULL)
493 proto_shell_parse_route_list(state->proto.iface, cur, false);
495 if ((cur = tb[NOTIFY_ROUTES6]) != NULL)
496 proto_shell_parse_route_list(state->proto.iface, cur, true);
498 if ((cur = tb[NOTIFY_DNS]))
499 interface_add_dns_server_list(&iface->proto_ip, cur);
501 if ((cur = tb[NOTIFY_DNS_SEARCH]))
502 interface_add_dns_search_list(&iface->proto_ip, cur);
504 if ((cur = tb[NOTIFY_DATA]))
505 proto_shell_parse_data(state->proto.iface, cur);
507 interface_update_complete(state->proto.iface);
509 if ((state->sm != S_SETUP_ABORT) && (state->sm != S_TEARDOWN)) {
511 state->proto.proto_event(&state->proto, IFPEV_UP);
519 fill_string_list(struct blob_attr *attr, char **argv, int max)
521 struct blob_attr *cur;
528 blobmsg_for_each_attr(cur, attr, rem) {
529 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
532 if (!blobmsg_check_attr(cur, NULL))
535 argv[argc++] = blobmsg_data(cur);
546 proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
548 static char *argv[64];
549 static char *env[32];
551 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
552 return UBUS_STATUS_PERMISSION_DENIED;
554 if (!tb[NOTIFY_COMMAND])
557 if (!fill_string_list(tb[NOTIFY_COMMAND], argv, ARRAY_SIZE(argv)))
560 if (!fill_string_list(tb[NOTIFY_ENV], env, ARRAY_SIZE(env)))
563 netifd_start_process((const char **) argv, (char **) env, &state->proto_task);
568 return UBUS_STATUS_INVALID_ARGUMENT;
572 proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
574 unsigned int signal = ~0;
576 if (tb[NOTIFY_SIGNAL])
577 signal = blobmsg_get_u32(tb[NOTIFY_SIGNAL]);
582 if (state->proto_task.uloop.pending) {
583 if (signal == SIGTERM || signal == SIGKILL)
584 state->proto_task_killed = true;
585 kill(state->proto_task.uloop.pid, signal);
592 proto_shell_notify_error(struct proto_shell_state *state, struct blob_attr **tb)
594 struct blob_attr *cur;
599 if (!tb[NOTIFY_ERROR])
600 return UBUS_STATUS_INVALID_ARGUMENT;
602 blobmsg_for_each_attr(cur, tb[NOTIFY_ERROR], rem) {
603 if (n_data + 1 == ARRAY_SIZE(data))
606 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
609 if (!blobmsg_check_attr(cur, NULL))
612 data[n_data++] = blobmsg_data(cur);
618 interface_add_error(state->proto.iface, state->handler->proto.name,
619 data[0], (const char **) &data[1], n_data - 1);
624 return UBUS_STATUS_INVALID_ARGUMENT;
628 proto_shell_block_restart(struct proto_shell_state *state, struct blob_attr **tb)
630 state->proto.iface->autostart = false;
635 proto_shell_set_available(struct proto_shell_state *state, struct blob_attr **tb)
637 if (!tb[NOTIFY_AVAILABLE])
638 return UBUS_STATUS_INVALID_ARGUMENT;
640 interface_set_available(state->proto.iface, blobmsg_get_bool(tb[NOTIFY_AVAILABLE]));
645 proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_attr **tb)
647 struct proto_shell_dependency *dep;
648 struct blob_attr *host = tb[NOTIFY_HOST];
649 struct blob_attr *ifname_a = tb[NOTIFY_IFNAME];
650 const char *ifname_str = ifname_a ? blobmsg_data(ifname_a) : "";
653 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
654 return UBUS_STATUS_PERMISSION_DENIED;
657 return UBUS_STATUS_INVALID_ARGUMENT;
659 dep = calloc_a(sizeof(*dep), &ifname, strlen(ifname_str) + 1);
660 if (inet_pton(AF_INET, blobmsg_data(host), &dep->host) < 1) {
661 if (inet_pton(AF_INET6, blobmsg_data(host), &dep->host) < 1) {
663 return UBUS_STATUS_INVALID_ARGUMENT;
670 dep->interface = strcpy(ifname, ifname_str);
672 dep->dep.cb = proto_shell_if_up_cb;
673 interface_add_user(&dep->dep, NULL);
674 list_add(&dep->list, &state->deps);
675 proto_shell_update_host_dep(dep);
677 return UBUS_STATUS_NOT_FOUND;
683 proto_shell_setup_failed(struct proto_shell_state *state)
689 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
692 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
697 ret = UBUS_STATUS_PERMISSION_DENIED;
704 proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
706 struct proto_shell_state *state;
707 struct blob_attr *tb[__NOTIFY_LAST];
709 state = container_of(proto, struct proto_shell_state, proto);
711 blobmsg_parse(notify_attr, __NOTIFY_LAST, tb, blob_data(attr), blob_len(attr));
712 if (!tb[NOTIFY_ACTION])
713 return UBUS_STATUS_INVALID_ARGUMENT;
715 switch(blobmsg_get_u32(tb[NOTIFY_ACTION])) {
717 return proto_shell_update_link(state, attr, tb);
719 return proto_shell_run_command(state, tb);
721 return proto_shell_kill_command(state, tb);
723 return proto_shell_notify_error(state, tb);
725 return proto_shell_block_restart(state, tb);
727 return proto_shell_set_available(state, tb);
729 return proto_shell_add_host_dependency(state, tb);
731 return proto_shell_setup_failed(state);
733 return UBUS_STATUS_INVALID_ARGUMENT;
737 static struct interface_proto_state *
738 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
739 struct blob_attr *attr)
741 struct proto_shell_state *state;
743 state = calloc(1, sizeof(*state));
744 INIT_LIST_HEAD(&state->deps);
746 state->config = malloc(blob_pad_len(attr));
750 memcpy(state->config, attr, blob_pad_len(attr));
751 state->proto.free = proto_shell_free;
752 state->proto.notify = proto_shell_notify;
753 state->proto.cb = proto_shell_handler;
754 state->teardown_timeout.cb = proto_shell_teardown_timeout_cb;
755 state->script_task.cb = proto_shell_script_cb;
756 state->script_task.dir_fd = proto_fd;
757 state->script_task.log_prefix = iface->name;
758 state->proto_task.cb = proto_shell_task_cb;
759 state->proto_task.dir_fd = proto_fd;
760 state->proto_task.log_prefix = iface->name;
761 state->handler = container_of(h, struct proto_shell_handler, proto);
763 return &state->proto;
771 proto_shell_add_handler(const char *script, const char *name, json_object *obj)
773 struct proto_shell_handler *handler;
774 struct proto_handler *proto;
775 json_object *config, *tmp;
776 char *proto_name, *script_name;
778 handler = calloc_a(sizeof(*handler),
779 &proto_name, strlen(name) + 1,
780 &script_name, strlen(script) + 1);
784 handler->script_name = strcpy(script_name, script);
786 proto = &handler->proto;
787 proto->name = strcpy(proto_name, name);
788 proto->config_params = &handler->config;
789 proto->attach = proto_shell_attach;
791 tmp = json_get_field(obj, "no-device", json_type_boolean);
792 if (tmp && json_object_get_boolean(tmp))
793 handler->proto.flags |= PROTO_FLAG_NODEV;
795 tmp = json_get_field(obj, "available", json_type_boolean);
796 if (tmp && json_object_get_boolean(tmp))
797 handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
799 tmp = json_get_field(obj, "renew-handler", json_type_boolean);
800 if (tmp && json_object_get_boolean(tmp))
801 handler->proto.flags |= PROTO_FLAG_RENEW_AVAILABLE;
803 config = json_get_field(obj, "config", json_type_array);
805 handler->config_buf = netifd_handler_parse_config(&handler->config, config);
807 DPRINTF("Add handler for script %s: %s\n", script, proto->name);
808 add_proto_handler(proto);
811 void proto_shell_init(void)
813 proto_fd = netifd_open_subdir("proto");
817 netifd_init_script_handlers(proto_fd, proto_shell_add_handler);