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;
77 struct list_head deps;
81 proto_shell_check_dependencies(struct proto_shell_state *state)
83 struct proto_shell_dependency *dep;
84 bool available = true;
86 list_for_each_entry(dep, &state->deps, list) {
94 interface_set_available(state->proto.iface, available);
98 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
99 enum interface_event ev);
101 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
102 enum interface_event ev);
105 proto_shell_update_host_dep(struct proto_shell_dependency *dep)
107 struct interface *iface = NULL;
112 if (dep->interface[0])
113 iface = vlist_find(&interfaces, dep->interface, iface, node);
115 iface = interface_ip_add_target_route(&dep->host, dep->v6, iface);
119 interface_remove_user(&dep->dep);
120 dep->dep.cb = proto_shell_if_down_cb;
121 interface_add_user(&dep->dep, iface);
124 proto_shell_check_dependencies(dep->proto);
128 proto_shell_clear_host_dep(struct proto_shell_state *state)
130 struct proto_shell_dependency *dep, *tmp;
132 list_for_each_entry_safe(dep, tmp, &state->deps, list) {
133 interface_remove_user(&dep->dep);
134 list_del(&dep->list);
140 proto_shell_handler(struct interface_proto_state *proto,
141 enum interface_proto_cmd cmd, bool force)
143 struct proto_shell_state *state;
144 struct proto_shell_handler *handler;
145 struct netifd_process *proc;
146 static char error_buf[32];
151 int ret, i = 0, j = 0;
153 state = container_of(proto, struct proto_shell_state, proto);
154 handler = state->handler;
155 proc = &state->script_task;
157 if (cmd == PROTO_CMD_SETUP) {
159 state->last_error = -1;
160 proto_shell_clear_host_dep(state);
163 if (state->sm == S_TEARDOWN)
166 if (state->script_task.uloop.pending) {
167 if (state->sm != S_SETUP_ABORT) {
168 uloop_timeout_set(&state->teardown_timeout, 1000);
169 kill(state->script_task.uloop.pid, SIGTERM);
170 if (state->proto_task.uloop.pending)
171 kill(state->proto_task.uloop.pid, SIGTERM);
172 state->sm = S_SETUP_ABORT;
178 state->sm = S_TEARDOWN;
179 if (state->last_error >= 0) {
180 snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
181 envp[j++] = error_buf;
183 uloop_timeout_set(&state->teardown_timeout, 5000);
186 config = blobmsg_format_json(state->config, true);
190 argv[i++] = handler->script_name;
191 argv[i++] = handler->proto.name;
193 argv[i++] = proto->iface->name;
195 if (proto->iface->main_dev.dev)
196 argv[i++] = proto->iface->main_dev.dev->ifname;
200 ret = netifd_start_process(argv, envp, proc);
207 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
208 enum interface_event ev)
210 struct proto_shell_dependency *pdep;
212 if (ev != IFEV_UP && ev != IFEV_UPDATE)
215 pdep = container_of(dep, struct proto_shell_dependency, dep);
216 proto_shell_update_host_dep(pdep);
220 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
221 enum interface_event ev)
223 struct proto_shell_dependency *pdep;
224 struct proto_shell_state *state;
226 if (ev == IFEV_UP || ev == IFEV_UPDATE)
229 pdep = container_of(dep, struct proto_shell_dependency, dep);
230 interface_remove_user(dep);
231 dep->cb = proto_shell_if_up_cb;
232 interface_add_user(dep, NULL);
235 if (state->sm == S_IDLE) {
236 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
237 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
242 proto_shell_task_finish(struct proto_shell_state *state,
243 struct netifd_process *task)
247 if (task == &state->proto_task)
248 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
251 if (task == &state->proto_task)
252 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
257 if (state->script_task.uloop.pending ||
258 state->proto_task.uloop.pending)
261 uloop_timeout_cancel(&state->teardown_timeout);
263 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
267 if (state->script_task.uloop.pending)
270 if (state->proto_task.uloop.pending) {
271 if (!state->proto_task_killed)
272 kill(state->proto_task.uloop.pid, SIGTERM);
276 uloop_timeout_cancel(&state->teardown_timeout);
278 state->proto.proto_event(&state->proto, IFPEV_DOWN);
284 proto_shell_teardown_timeout_cb(struct uloop_timeout *timeout)
286 struct proto_shell_state *state;
288 state = container_of(timeout, struct proto_shell_state, teardown_timeout);
290 netifd_kill_process(&state->script_task);
291 netifd_kill_process(&state->proto_task);
292 proto_shell_task_finish(state, NULL);
296 proto_shell_script_cb(struct netifd_process *p, int ret)
298 struct proto_shell_state *state;
300 state = container_of(p, struct proto_shell_state, script_task);
301 proto_shell_task_finish(state, p);
305 proto_shell_task_cb(struct netifd_process *p, int ret)
307 struct proto_shell_state *state;
309 state = container_of(p, struct proto_shell_state, proto_task);
311 if (state->sm == S_IDLE || state->sm == S_SETUP)
312 state->last_error = WEXITSTATUS(ret);
314 proto_shell_task_finish(state, p);
318 proto_shell_free(struct interface_proto_state *proto)
320 struct proto_shell_state *state;
322 state = container_of(proto, struct proto_shell_state, proto);
323 uloop_timeout_cancel(&state->teardown_timeout);
324 proto_shell_clear_host_dep(state);
325 netifd_kill_process(&state->script_task);
326 netifd_kill_process(&state->proto_task);
332 proto_shell_parse_route_list(struct interface *iface, struct blob_attr *attr,
335 struct blob_attr *cur;
338 blobmsg_for_each_attr(cur, attr, rem) {
339 if (blobmsg_type(cur) != BLOBMSG_TYPE_TABLE) {
340 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur));
344 interface_ip_add_route(iface, cur, v6);
349 proto_shell_parse_data(struct interface *iface, struct blob_attr *attr)
351 struct blob_attr *cur;
354 blobmsg_for_each_attr(cur, attr, rem)
355 interface_add_data(iface, cur);
358 static struct device *
359 proto_shell_create_tunnel(const char *name, struct blob_attr *attr)
364 memset(&b, 0, sizeof(b));
365 blob_buf_init(&b, 0);
366 blob_put(&b, 0, blobmsg_data(attr), blobmsg_data_len(attr));
367 dev = device_create(name, &tunnel_device_type, blob_data(b.head));
394 static const struct blobmsg_policy notify_attr[__NOTIFY_LAST] = {
395 [NOTIFY_ACTION] = { .name = "action", .type = BLOBMSG_TYPE_INT32 },
396 [NOTIFY_ERROR] = { .name = "error", .type = BLOBMSG_TYPE_ARRAY },
397 [NOTIFY_COMMAND] = { .name = "command", .type = BLOBMSG_TYPE_ARRAY },
398 [NOTIFY_ENV] = { .name = "env", .type = BLOBMSG_TYPE_ARRAY },
399 [NOTIFY_SIGNAL] = { .name = "signal", .type = BLOBMSG_TYPE_INT32 },
400 [NOTIFY_AVAILABLE] = { .name = "available", .type = BLOBMSG_TYPE_BOOL },
401 [NOTIFY_LINK_UP] = { .name = "link-up", .type = BLOBMSG_TYPE_BOOL },
402 [NOTIFY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING },
403 [NOTIFY_ADDR_EXT] = { .name = "address-external", .type = BLOBMSG_TYPE_BOOL },
404 [NOTIFY_ROUTES] = { .name = "routes", .type = BLOBMSG_TYPE_ARRAY },
405 [NOTIFY_ROUTES6] = { .name = "routes6", .type = BLOBMSG_TYPE_ARRAY },
406 [NOTIFY_TUNNEL] = { .name = "tunnel", .type = BLOBMSG_TYPE_TABLE },
407 [NOTIFY_DATA] = { .name = "data", .type = BLOBMSG_TYPE_TABLE },
408 [NOTIFY_KEEP] = { .name = "keep", .type = BLOBMSG_TYPE_BOOL },
409 [NOTIFY_HOST] = { .name = "host", .type = BLOBMSG_TYPE_STRING },
410 [NOTIFY_DNS] = { .name = "dns", .type = BLOBMSG_TYPE_ARRAY },
411 [NOTIFY_DNS_SEARCH] = { .name = "dns_search", .type = BLOBMSG_TYPE_ARRAY },
415 proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data, struct blob_attr **tb)
417 struct interface *iface = state->proto.iface;
418 struct blob_attr *cur;
422 bool addr_ext = false;
426 if (!tb[NOTIFY_LINK_UP])
427 return UBUS_STATUS_INVALID_ARGUMENT;
429 up = blobmsg_get_bool(tb[NOTIFY_LINK_UP]);
431 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
435 if ((cur = tb[NOTIFY_KEEP]) != NULL)
436 keep = blobmsg_get_bool(cur);
438 if ((cur = tb[NOTIFY_ADDR_EXT]) != NULL) {
439 addr_ext = blobmsg_get_bool(cur);
444 if (!tb[NOTIFY_IFNAME]) {
445 if (!iface->main_dev.dev)
446 return UBUS_STATUS_INVALID_ARGUMENT;
447 } else if (!keep || iface->state != IFS_UP) {
449 devname = blobmsg_data(tb[NOTIFY_IFNAME]);
450 if (tb[NOTIFY_TUNNEL]) {
451 dev = proto_shell_create_tunnel(devname,
454 return UBUS_STATUS_INVALID_ARGUMENT;
456 dev = device_get(devname, dev_create);
458 return UBUS_STATUS_NOT_FOUND;
461 interface_set_l3_dev(iface, dev);
462 device_claim(&iface->l3_dev);
463 device_set_present(dev, true);
467 interface_update_start(iface);
469 proto_apply_ip_settings(iface, data, addr_ext);
471 if ((cur = tb[NOTIFY_ROUTES]) != NULL)
472 proto_shell_parse_route_list(state->proto.iface, cur, false);
474 if ((cur = tb[NOTIFY_ROUTES6]) != NULL)
475 proto_shell_parse_route_list(state->proto.iface, cur, true);
477 if ((cur = tb[NOTIFY_DNS]))
478 interface_add_dns_server_list(&iface->proto_ip, cur);
480 if ((cur = tb[NOTIFY_DNS_SEARCH]))
481 interface_add_dns_search_list(&iface->proto_ip, cur);
483 if ((cur = tb[NOTIFY_DATA]))
484 proto_shell_parse_data(state->proto.iface, cur);
486 interface_update_complete(state->proto.iface);
489 state->proto.proto_event(&state->proto, IFPEV_UP);
496 fill_string_list(struct blob_attr *attr, char **argv, int max)
498 struct blob_attr *cur;
505 blobmsg_for_each_attr(cur, attr, rem) {
506 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
509 if (!blobmsg_check_attr(cur, NULL))
512 argv[argc++] = blobmsg_data(cur);
523 proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
525 static char *argv[64];
526 static char *env[32];
528 if (!tb[NOTIFY_COMMAND])
531 if (!fill_string_list(tb[NOTIFY_COMMAND], argv, ARRAY_SIZE(argv)))
534 if (!fill_string_list(tb[NOTIFY_ENV], env, ARRAY_SIZE(env)))
537 netifd_start_process((const char **) argv, (char **) env, &state->proto_task);
542 return UBUS_STATUS_INVALID_ARGUMENT;
546 proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
548 unsigned int signal = ~0;
550 if (tb[NOTIFY_SIGNAL])
551 signal = blobmsg_get_u32(tb[NOTIFY_SIGNAL]);
556 if (state->proto_task.uloop.pending) {
557 state->proto_task_killed = true;
558 kill(state->proto_task.uloop.pid, signal);
565 proto_shell_notify_error(struct proto_shell_state *state, struct blob_attr **tb)
567 struct blob_attr *cur;
572 if (!tb[NOTIFY_ERROR])
573 return UBUS_STATUS_INVALID_ARGUMENT;
575 blobmsg_for_each_attr(cur, tb[NOTIFY_ERROR], rem) {
576 if (n_data + 1 == ARRAY_SIZE(data))
579 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
582 if (!blobmsg_check_attr(cur, NULL))
585 data[n_data++] = blobmsg_data(cur);
591 interface_add_error(state->proto.iface, state->handler->proto.name,
592 data[0], (const char **) &data[1], n_data - 1);
597 return UBUS_STATUS_INVALID_ARGUMENT;
601 proto_shell_block_restart(struct proto_shell_state *state, struct blob_attr **tb)
603 state->proto.iface->autostart = false;
608 proto_shell_set_available(struct proto_shell_state *state, struct blob_attr **tb)
610 if (!tb[NOTIFY_AVAILABLE])
611 return UBUS_STATUS_INVALID_ARGUMENT;
613 interface_set_available(state->proto.iface, blobmsg_get_bool(tb[NOTIFY_AVAILABLE]));
618 proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_attr **tb)
620 struct proto_shell_dependency *dep;
621 struct blob_attr *host = tb[NOTIFY_HOST];
622 struct blob_attr *ifname_a = tb[NOTIFY_IFNAME];
623 const char *ifname_str = ifname_a ? blobmsg_data(ifname_a) : "";
627 return UBUS_STATUS_INVALID_ARGUMENT;
629 dep = calloc_a(sizeof(*dep), &ifname, strlen(ifname_str) + 1);
630 if (inet_pton(AF_INET, blobmsg_data(host), &dep->host) < 1) {
631 if (inet_pton(AF_INET6, blobmsg_data(host), &dep->host) < 1) {
633 return UBUS_STATUS_INVALID_ARGUMENT;
640 dep->interface = strcpy(ifname, ifname_str);
642 dep->dep.cb = proto_shell_if_up_cb;
643 interface_add_user(&dep->dep, NULL);
644 list_add(&dep->list, &state->deps);
645 proto_shell_update_host_dep(dep);
647 return UBUS_STATUS_NOT_FOUND;
653 proto_shell_setup_failed(struct proto_shell_state *state)
657 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
660 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
669 proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
671 struct proto_shell_state *state;
672 struct blob_attr *tb[__NOTIFY_LAST];
674 state = container_of(proto, struct proto_shell_state, proto);
676 blobmsg_parse(notify_attr, __NOTIFY_LAST, tb, blob_data(attr), blob_len(attr));
677 if (!tb[NOTIFY_ACTION])
678 return UBUS_STATUS_INVALID_ARGUMENT;
680 switch(blobmsg_get_u32(tb[NOTIFY_ACTION])) {
682 return proto_shell_update_link(state, attr, tb);
684 return proto_shell_run_command(state, tb);
686 return proto_shell_kill_command(state, tb);
688 return proto_shell_notify_error(state, tb);
690 return proto_shell_block_restart(state, tb);
692 return proto_shell_set_available(state, tb);
694 return proto_shell_add_host_dependency(state, tb);
696 return proto_shell_setup_failed(state);
698 return UBUS_STATUS_INVALID_ARGUMENT;
702 static struct interface_proto_state *
703 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
704 struct blob_attr *attr)
706 struct proto_shell_state *state;
708 state = calloc(1, sizeof(*state));
709 INIT_LIST_HEAD(&state->deps);
711 state->config = malloc(blob_pad_len(attr));
715 memcpy(state->config, attr, blob_pad_len(attr));
716 state->proto.free = proto_shell_free;
717 state->proto.notify = proto_shell_notify;
718 state->proto.cb = proto_shell_handler;
719 state->teardown_timeout.cb = proto_shell_teardown_timeout_cb;
720 state->script_task.cb = proto_shell_script_cb;
721 state->script_task.dir_fd = proto_fd;
722 state->script_task.log_prefix = iface->name;
723 state->proto_task.cb = proto_shell_task_cb;
724 state->proto_task.dir_fd = proto_fd;
725 state->proto_task.log_prefix = iface->name;
726 state->handler = container_of(h, struct proto_shell_handler, proto);
728 return &state->proto;
736 proto_shell_add_handler(const char *script, const char *name, json_object *obj)
738 struct proto_shell_handler *handler;
739 struct proto_handler *proto;
740 json_object *config, *tmp;
741 char *proto_name, *script_name;
743 handler = calloc_a(sizeof(*handler),
744 &proto_name, strlen(name) + 1,
745 &script_name, strlen(script) + 1);
749 handler->script_name = strcpy(script_name, script);
751 proto = &handler->proto;
752 proto->name = strcpy(proto_name, name);
753 proto->config_params = &handler->config;
754 proto->attach = proto_shell_attach;
756 tmp = json_get_field(obj, "no-device", json_type_boolean);
757 if (tmp && json_object_get_boolean(tmp))
758 handler->proto.flags |= PROTO_FLAG_NODEV;
760 tmp = json_get_field(obj, "available", json_type_boolean);
761 if (tmp && json_object_get_boolean(tmp))
762 handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
764 config = json_get_field(obj, "config", json_type_array);
766 handler->config_buf = netifd_handler_parse_config(&handler->config, config);
768 DPRINTF("Add handler for script %s: %s\n", script, proto->name);
769 add_proto_handler(proto);
772 void proto_shell_init(void)
774 proto_fd = netifd_open_subdir("proto");
778 netifd_init_script_handlers(proto_fd, proto_shell_add_handler);