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) {
162 state->last_error = -1;
163 proto_shell_clear_host_dep(state);
175 } else if (cmd == PROTO_CMD_RENEW) {
176 if (!(handler->proto.flags & PROTO_FLAG_RENEW_AVAILABLE))
179 if (state->script_task.uloop.pending) {
180 state->renew_pending = true;
184 state->renew_pending = false;
187 if (state->sm == S_TEARDOWN)
190 state->renew_pending = false;
191 if (state->script_task.uloop.pending) {
192 if (state->sm != S_SETUP_ABORT) {
193 uloop_timeout_set(&state->teardown_timeout, 1000);
194 kill(state->script_task.uloop.pid, SIGTERM);
195 if (state->proto_task.uloop.pending)
196 kill(state->proto_task.uloop.pid, SIGTERM);
197 state->sm = S_SETUP_ABORT;
203 state->sm = S_TEARDOWN;
204 if (state->last_error >= 0) {
205 snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
206 envp[j++] = error_buf;
208 uloop_timeout_set(&state->teardown_timeout, 5000);
211 D(INTERFACE, "run %s for interface '%s'\n", action, proto->iface->name);
212 config = blobmsg_format_json(state->config, true);
216 argv[i++] = handler->script_name;
217 argv[i++] = handler->proto.name;
219 argv[i++] = proto->iface->name;
221 if (proto->iface->main_dev.dev)
222 argv[i++] = proto->iface->main_dev.dev->ifname;
226 ret = netifd_start_process(argv, envp, proc);
233 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
234 enum interface_event ev)
236 struct proto_shell_dependency *pdep;
238 if (ev != IFEV_UP && ev != IFEV_UPDATE)
241 pdep = container_of(dep, struct proto_shell_dependency, dep);
242 proto_shell_update_host_dep(pdep);
246 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
247 enum interface_event ev)
249 struct proto_shell_dependency *pdep;
250 struct proto_shell_state *state;
252 if (ev == IFEV_UP || ev == IFEV_UPDATE)
255 pdep = container_of(dep, struct proto_shell_dependency, dep);
256 interface_remove_user(dep);
257 dep->cb = proto_shell_if_up_cb;
258 interface_add_user(dep, NULL);
261 if (state->sm == S_IDLE) {
262 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
263 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
268 proto_shell_task_finish(struct proto_shell_state *state,
269 struct netifd_process *task)
273 if (task == &state->proto_task)
274 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
277 if (task == &state->proto_task)
278 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
280 if (task == &state->script_task && state->renew_pending)
281 proto_shell_handler(&state->proto, PROTO_CMD_RENEW,
286 if (state->script_task.uloop.pending ||
287 state->proto_task.uloop.pending)
290 uloop_timeout_cancel(&state->teardown_timeout);
292 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
296 if (state->script_task.uloop.pending)
299 if (state->proto_task.uloop.pending) {
300 if (!state->proto_task_killed)
301 kill(state->proto_task.uloop.pid, SIGTERM);
305 uloop_timeout_cancel(&state->teardown_timeout);
307 state->proto.proto_event(&state->proto, IFPEV_DOWN);
313 proto_shell_teardown_timeout_cb(struct uloop_timeout *timeout)
315 struct proto_shell_state *state;
317 state = container_of(timeout, struct proto_shell_state, teardown_timeout);
319 netifd_kill_process(&state->script_task);
320 netifd_kill_process(&state->proto_task);
321 proto_shell_task_finish(state, NULL);
325 proto_shell_script_cb(struct netifd_process *p, int ret)
327 struct proto_shell_state *state;
329 state = container_of(p, struct proto_shell_state, script_task);
330 proto_shell_task_finish(state, p);
334 proto_shell_task_cb(struct netifd_process *p, int ret)
336 struct proto_shell_state *state;
338 state = container_of(p, struct proto_shell_state, proto_task);
340 if (state->sm == S_IDLE || state->sm == S_SETUP)
341 state->last_error = WEXITSTATUS(ret);
343 proto_shell_task_finish(state, p);
347 proto_shell_free(struct interface_proto_state *proto)
349 struct proto_shell_state *state;
351 state = container_of(proto, struct proto_shell_state, proto);
352 uloop_timeout_cancel(&state->teardown_timeout);
353 proto_shell_clear_host_dep(state);
354 netifd_kill_process(&state->script_task);
355 netifd_kill_process(&state->proto_task);
361 proto_shell_parse_route_list(struct interface *iface, struct blob_attr *attr,
364 struct blob_attr *cur;
367 blobmsg_for_each_attr(cur, attr, rem) {
368 if (blobmsg_type(cur) != BLOBMSG_TYPE_TABLE) {
369 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur));
373 interface_ip_add_route(iface, cur, v6);
378 proto_shell_parse_data(struct interface *iface, struct blob_attr *attr)
380 struct blob_attr *cur;
383 blobmsg_for_each_attr(cur, attr, rem)
384 interface_add_data(iface, cur);
387 static struct device *
388 proto_shell_create_tunnel(const char *name, struct blob_attr *attr)
393 memset(&b, 0, sizeof(b));
394 blob_buf_init(&b, 0);
395 blob_put(&b, 0, blobmsg_data(attr), blobmsg_data_len(attr));
396 dev = device_create(name, &tunnel_device_type, blob_data(b.head));
423 static const struct blobmsg_policy notify_attr[__NOTIFY_LAST] = {
424 [NOTIFY_ACTION] = { .name = "action", .type = BLOBMSG_TYPE_INT32 },
425 [NOTIFY_ERROR] = { .name = "error", .type = BLOBMSG_TYPE_ARRAY },
426 [NOTIFY_COMMAND] = { .name = "command", .type = BLOBMSG_TYPE_ARRAY },
427 [NOTIFY_ENV] = { .name = "env", .type = BLOBMSG_TYPE_ARRAY },
428 [NOTIFY_SIGNAL] = { .name = "signal", .type = BLOBMSG_TYPE_INT32 },
429 [NOTIFY_AVAILABLE] = { .name = "available", .type = BLOBMSG_TYPE_BOOL },
430 [NOTIFY_LINK_UP] = { .name = "link-up", .type = BLOBMSG_TYPE_BOOL },
431 [NOTIFY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING },
432 [NOTIFY_ADDR_EXT] = { .name = "address-external", .type = BLOBMSG_TYPE_BOOL },
433 [NOTIFY_ROUTES] = { .name = "routes", .type = BLOBMSG_TYPE_ARRAY },
434 [NOTIFY_ROUTES6] = { .name = "routes6", .type = BLOBMSG_TYPE_ARRAY },
435 [NOTIFY_TUNNEL] = { .name = "tunnel", .type = BLOBMSG_TYPE_TABLE },
436 [NOTIFY_DATA] = { .name = "data", .type = BLOBMSG_TYPE_TABLE },
437 [NOTIFY_KEEP] = { .name = "keep", .type = BLOBMSG_TYPE_BOOL },
438 [NOTIFY_HOST] = { .name = "host", .type = BLOBMSG_TYPE_STRING },
439 [NOTIFY_DNS] = { .name = "dns", .type = BLOBMSG_TYPE_ARRAY },
440 [NOTIFY_DNS_SEARCH] = { .name = "dns_search", .type = BLOBMSG_TYPE_ARRAY },
444 proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data, struct blob_attr **tb)
446 struct interface *iface = state->proto.iface;
447 struct blob_attr *cur;
451 bool addr_ext = false;
455 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
456 return UBUS_STATUS_PERMISSION_DENIED;
458 if (!tb[NOTIFY_LINK_UP])
459 return UBUS_STATUS_INVALID_ARGUMENT;
461 up = blobmsg_get_bool(tb[NOTIFY_LINK_UP]);
463 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
467 if ((cur = tb[NOTIFY_KEEP]) != NULL)
468 keep = blobmsg_get_bool(cur);
470 if ((cur = tb[NOTIFY_ADDR_EXT]) != NULL) {
471 addr_ext = blobmsg_get_bool(cur);
476 if (iface->state != IFS_UP || !iface->l3_dev.dev)
480 dev = iface->main_dev.dev;
481 if (tb[NOTIFY_IFNAME]) {
483 devname = blobmsg_data(tb[NOTIFY_IFNAME]);
484 if (tb[NOTIFY_TUNNEL])
485 dev = proto_shell_create_tunnel(devname, tb[NOTIFY_TUNNEL]);
487 dev = device_get(devname, dev_create);
491 return UBUS_STATUS_INVALID_ARGUMENT;
493 interface_set_l3_dev(iface, dev);
494 if (device_claim(&iface->l3_dev) < 0)
495 return UBUS_STATUS_UNKNOWN_ERROR;
497 device_set_present(dev, true);
499 interface_update_start(iface);
502 proto_apply_ip_settings(iface, data, addr_ext);
504 if ((cur = tb[NOTIFY_ROUTES]) != NULL)
505 proto_shell_parse_route_list(state->proto.iface, cur, false);
507 if ((cur = tb[NOTIFY_ROUTES6]) != NULL)
508 proto_shell_parse_route_list(state->proto.iface, cur, true);
510 if ((cur = tb[NOTIFY_DNS]))
511 interface_add_dns_server_list(&iface->proto_ip, cur);
513 if ((cur = tb[NOTIFY_DNS_SEARCH]))
514 interface_add_dns_search_list(&iface->proto_ip, cur);
516 if ((cur = tb[NOTIFY_DATA]))
517 proto_shell_parse_data(state->proto.iface, cur);
519 interface_update_complete(state->proto.iface);
521 if ((state->sm != S_SETUP_ABORT) && (state->sm != S_TEARDOWN)) {
523 state->proto.proto_event(&state->proto, IFPEV_UP);
531 fill_string_list(struct blob_attr *attr, char **argv, int max)
533 struct blob_attr *cur;
540 blobmsg_for_each_attr(cur, attr, rem) {
541 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
544 if (!blobmsg_check_attr(cur, NULL))
547 argv[argc++] = blobmsg_data(cur);
558 proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
560 static char *argv[64];
561 static char *env[32];
563 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
564 return UBUS_STATUS_PERMISSION_DENIED;
566 if (!tb[NOTIFY_COMMAND])
569 if (!fill_string_list(tb[NOTIFY_COMMAND], argv, ARRAY_SIZE(argv)))
572 if (!fill_string_list(tb[NOTIFY_ENV], env, ARRAY_SIZE(env)))
575 netifd_start_process((const char **) argv, (char **) env, &state->proto_task);
580 return UBUS_STATUS_INVALID_ARGUMENT;
584 proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
586 unsigned int signal = ~0;
588 if (tb[NOTIFY_SIGNAL])
589 signal = blobmsg_get_u32(tb[NOTIFY_SIGNAL]);
594 if (state->proto_task.uloop.pending) {
595 if (signal == SIGTERM || signal == SIGKILL)
596 state->proto_task_killed = true;
597 kill(state->proto_task.uloop.pid, signal);
604 proto_shell_notify_error(struct proto_shell_state *state, struct blob_attr **tb)
606 struct blob_attr *cur;
611 if (!tb[NOTIFY_ERROR])
612 return UBUS_STATUS_INVALID_ARGUMENT;
614 blobmsg_for_each_attr(cur, tb[NOTIFY_ERROR], rem) {
615 if (n_data + 1 == ARRAY_SIZE(data))
618 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
621 if (!blobmsg_check_attr(cur, NULL))
624 data[n_data++] = blobmsg_data(cur);
630 interface_add_error(state->proto.iface, state->handler->proto.name,
631 data[0], (const char **) &data[1], n_data - 1);
636 return UBUS_STATUS_INVALID_ARGUMENT;
640 proto_shell_block_restart(struct proto_shell_state *state, struct blob_attr **tb)
642 state->proto.iface->autostart = false;
647 proto_shell_set_available(struct proto_shell_state *state, struct blob_attr **tb)
649 if (!tb[NOTIFY_AVAILABLE])
650 return UBUS_STATUS_INVALID_ARGUMENT;
652 interface_set_available(state->proto.iface, blobmsg_get_bool(tb[NOTIFY_AVAILABLE]));
657 proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_attr **tb)
659 struct proto_shell_dependency *dep;
660 struct blob_attr *host = tb[NOTIFY_HOST];
661 struct blob_attr *ifname_a = tb[NOTIFY_IFNAME];
662 const char *ifname_str = ifname_a ? blobmsg_data(ifname_a) : "";
665 if (state->sm == S_TEARDOWN || state->sm == S_SETUP_ABORT)
666 return UBUS_STATUS_PERMISSION_DENIED;
669 return UBUS_STATUS_INVALID_ARGUMENT;
671 dep = calloc_a(sizeof(*dep), &ifname, strlen(ifname_str) + 1);
672 if (inet_pton(AF_INET, blobmsg_data(host), &dep->host) < 1) {
673 if (inet_pton(AF_INET6, blobmsg_data(host), &dep->host) < 1) {
675 return UBUS_STATUS_INVALID_ARGUMENT;
682 dep->interface = strcpy(ifname, ifname_str);
684 dep->dep.cb = proto_shell_if_up_cb;
685 interface_add_user(&dep->dep, NULL);
686 list_add(&dep->list, &state->deps);
687 proto_shell_update_host_dep(dep);
689 return UBUS_STATUS_NOT_FOUND;
695 proto_shell_setup_failed(struct proto_shell_state *state)
701 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
704 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
709 ret = UBUS_STATUS_PERMISSION_DENIED;
716 proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
718 struct proto_shell_state *state;
719 struct blob_attr *tb[__NOTIFY_LAST];
721 state = container_of(proto, struct proto_shell_state, proto);
723 blobmsg_parse(notify_attr, __NOTIFY_LAST, tb, blob_data(attr), blob_len(attr));
724 if (!tb[NOTIFY_ACTION])
725 return UBUS_STATUS_INVALID_ARGUMENT;
727 switch(blobmsg_get_u32(tb[NOTIFY_ACTION])) {
729 return proto_shell_update_link(state, attr, tb);
731 return proto_shell_run_command(state, tb);
733 return proto_shell_kill_command(state, tb);
735 return proto_shell_notify_error(state, tb);
737 return proto_shell_block_restart(state, tb);
739 return proto_shell_set_available(state, tb);
741 return proto_shell_add_host_dependency(state, tb);
743 return proto_shell_setup_failed(state);
745 return UBUS_STATUS_INVALID_ARGUMENT;
749 static struct interface_proto_state *
750 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
751 struct blob_attr *attr)
753 struct proto_shell_state *state;
755 state = calloc(1, sizeof(*state));
756 INIT_LIST_HEAD(&state->deps);
758 state->config = malloc(blob_pad_len(attr));
762 memcpy(state->config, attr, blob_pad_len(attr));
763 state->proto.free = proto_shell_free;
764 state->proto.notify = proto_shell_notify;
765 state->proto.cb = proto_shell_handler;
766 state->teardown_timeout.cb = proto_shell_teardown_timeout_cb;
767 state->script_task.cb = proto_shell_script_cb;
768 state->script_task.dir_fd = proto_fd;
769 state->script_task.log_prefix = iface->name;
770 state->proto_task.cb = proto_shell_task_cb;
771 state->proto_task.dir_fd = proto_fd;
772 state->proto_task.log_prefix = iface->name;
773 state->handler = container_of(h, struct proto_shell_handler, proto);
775 return &state->proto;
783 proto_shell_add_handler(const char *script, const char *name, json_object *obj)
785 struct proto_shell_handler *handler;
786 struct proto_handler *proto;
787 json_object *config, *tmp;
788 char *proto_name, *script_name;
790 handler = calloc_a(sizeof(*handler),
791 &proto_name, strlen(name) + 1,
792 &script_name, strlen(script) + 1);
796 handler->script_name = strcpy(script_name, script);
798 proto = &handler->proto;
799 proto->name = strcpy(proto_name, name);
800 proto->config_params = &handler->config;
801 proto->attach = proto_shell_attach;
803 tmp = json_get_field(obj, "no-device", json_type_boolean);
804 if (tmp && json_object_get_boolean(tmp))
805 handler->proto.flags |= PROTO_FLAG_NODEV;
807 tmp = json_get_field(obj, "available", json_type_boolean);
808 if (tmp && json_object_get_boolean(tmp))
809 handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
811 tmp = json_get_field(obj, "renew-handler", json_type_boolean);
812 if (tmp && json_object_get_boolean(tmp))
813 handler->proto.flags |= PROTO_FLAG_RENEW_AVAILABLE;
815 config = json_get_field(obj, "config", json_type_array);
817 handler->config_buf = netifd_handler_parse_config(&handler->config, config);
819 DPRINTF("Add handler for script %s: %s\n", script, proto->name);
820 add_proto_handler(proto);
823 void proto_shell_init(void)
825 proto_fd = netifd_open_subdir("proto");
829 netifd_init_script_handlers(proto_fd, proto_shell_add_handler);