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);
162 } else if (cmd == PROTO_CMD_RENEW) {
163 if (!(handler->proto.flags & PROTO_FLAG_RENEW_AVAILABLE))
167 if (state->sm == S_TEARDOWN)
170 if (state->script_task.uloop.pending) {
171 if (state->sm != S_SETUP_ABORT) {
172 uloop_timeout_set(&state->teardown_timeout, 1000);
173 kill(state->script_task.uloop.pid, SIGTERM);
174 if (state->proto_task.uloop.pending)
175 kill(state->proto_task.uloop.pid, SIGTERM);
176 state->sm = S_SETUP_ABORT;
182 state->sm = S_TEARDOWN;
183 if (state->last_error >= 0) {
184 snprintf(error_buf, sizeof(error_buf), "ERROR=%d", state->last_error);
185 envp[j++] = error_buf;
187 uloop_timeout_set(&state->teardown_timeout, 5000);
190 config = blobmsg_format_json(state->config, true);
194 argv[i++] = handler->script_name;
195 argv[i++] = handler->proto.name;
197 argv[i++] = proto->iface->name;
199 if (proto->iface->main_dev.dev)
200 argv[i++] = proto->iface->main_dev.dev->ifname;
204 ret = netifd_start_process(argv, envp, proc);
211 proto_shell_if_up_cb(struct interface_user *dep, struct interface *iface,
212 enum interface_event ev)
214 struct proto_shell_dependency *pdep;
216 if (ev != IFEV_UP && ev != IFEV_UPDATE)
219 pdep = container_of(dep, struct proto_shell_dependency, dep);
220 proto_shell_update_host_dep(pdep);
224 proto_shell_if_down_cb(struct interface_user *dep, struct interface *iface,
225 enum interface_event ev)
227 struct proto_shell_dependency *pdep;
228 struct proto_shell_state *state;
230 if (ev == IFEV_UP || ev == IFEV_UPDATE)
233 pdep = container_of(dep, struct proto_shell_dependency, dep);
234 interface_remove_user(dep);
235 dep->cb = proto_shell_if_up_cb;
236 interface_add_user(dep, NULL);
239 if (state->sm == S_IDLE) {
240 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
241 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
246 proto_shell_task_finish(struct proto_shell_state *state,
247 struct netifd_process *task)
251 if (task == &state->proto_task)
252 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
255 if (task == &state->proto_task)
256 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN,
261 if (state->script_task.uloop.pending ||
262 state->proto_task.uloop.pending)
265 uloop_timeout_cancel(&state->teardown_timeout);
267 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
271 if (state->script_task.uloop.pending)
274 if (state->proto_task.uloop.pending) {
275 if (!state->proto_task_killed)
276 kill(state->proto_task.uloop.pid, SIGTERM);
280 uloop_timeout_cancel(&state->teardown_timeout);
282 state->proto.proto_event(&state->proto, IFPEV_DOWN);
288 proto_shell_teardown_timeout_cb(struct uloop_timeout *timeout)
290 struct proto_shell_state *state;
292 state = container_of(timeout, struct proto_shell_state, teardown_timeout);
294 netifd_kill_process(&state->script_task);
295 netifd_kill_process(&state->proto_task);
296 proto_shell_task_finish(state, NULL);
300 proto_shell_script_cb(struct netifd_process *p, int ret)
302 struct proto_shell_state *state;
304 state = container_of(p, struct proto_shell_state, script_task);
305 proto_shell_task_finish(state, p);
309 proto_shell_task_cb(struct netifd_process *p, int ret)
311 struct proto_shell_state *state;
313 state = container_of(p, struct proto_shell_state, proto_task);
315 if (state->sm == S_IDLE || state->sm == S_SETUP)
316 state->last_error = WEXITSTATUS(ret);
318 proto_shell_task_finish(state, p);
322 proto_shell_free(struct interface_proto_state *proto)
324 struct proto_shell_state *state;
326 state = container_of(proto, struct proto_shell_state, proto);
327 uloop_timeout_cancel(&state->teardown_timeout);
328 proto_shell_clear_host_dep(state);
329 netifd_kill_process(&state->script_task);
330 netifd_kill_process(&state->proto_task);
336 proto_shell_parse_route_list(struct interface *iface, struct blob_attr *attr,
339 struct blob_attr *cur;
342 blobmsg_for_each_attr(cur, attr, rem) {
343 if (blobmsg_type(cur) != BLOBMSG_TYPE_TABLE) {
344 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur));
348 interface_ip_add_route(iface, cur, v6);
353 proto_shell_parse_data(struct interface *iface, struct blob_attr *attr)
355 struct blob_attr *cur;
358 blobmsg_for_each_attr(cur, attr, rem)
359 interface_add_data(iface, cur);
362 static struct device *
363 proto_shell_create_tunnel(const char *name, struct blob_attr *attr)
368 memset(&b, 0, sizeof(b));
369 blob_buf_init(&b, 0);
370 blob_put(&b, 0, blobmsg_data(attr), blobmsg_data_len(attr));
371 dev = device_create(name, &tunnel_device_type, blob_data(b.head));
398 static const struct blobmsg_policy notify_attr[__NOTIFY_LAST] = {
399 [NOTIFY_ACTION] = { .name = "action", .type = BLOBMSG_TYPE_INT32 },
400 [NOTIFY_ERROR] = { .name = "error", .type = BLOBMSG_TYPE_ARRAY },
401 [NOTIFY_COMMAND] = { .name = "command", .type = BLOBMSG_TYPE_ARRAY },
402 [NOTIFY_ENV] = { .name = "env", .type = BLOBMSG_TYPE_ARRAY },
403 [NOTIFY_SIGNAL] = { .name = "signal", .type = BLOBMSG_TYPE_INT32 },
404 [NOTIFY_AVAILABLE] = { .name = "available", .type = BLOBMSG_TYPE_BOOL },
405 [NOTIFY_LINK_UP] = { .name = "link-up", .type = BLOBMSG_TYPE_BOOL },
406 [NOTIFY_IFNAME] = { .name = "ifname", .type = BLOBMSG_TYPE_STRING },
407 [NOTIFY_ADDR_EXT] = { .name = "address-external", .type = BLOBMSG_TYPE_BOOL },
408 [NOTIFY_ROUTES] = { .name = "routes", .type = BLOBMSG_TYPE_ARRAY },
409 [NOTIFY_ROUTES6] = { .name = "routes6", .type = BLOBMSG_TYPE_ARRAY },
410 [NOTIFY_TUNNEL] = { .name = "tunnel", .type = BLOBMSG_TYPE_TABLE },
411 [NOTIFY_DATA] = { .name = "data", .type = BLOBMSG_TYPE_TABLE },
412 [NOTIFY_KEEP] = { .name = "keep", .type = BLOBMSG_TYPE_BOOL },
413 [NOTIFY_HOST] = { .name = "host", .type = BLOBMSG_TYPE_STRING },
414 [NOTIFY_DNS] = { .name = "dns", .type = BLOBMSG_TYPE_ARRAY },
415 [NOTIFY_DNS_SEARCH] = { .name = "dns_search", .type = BLOBMSG_TYPE_ARRAY },
419 proto_shell_update_link(struct proto_shell_state *state, struct blob_attr *data, struct blob_attr **tb)
421 struct interface *iface = state->proto.iface;
422 struct blob_attr *cur;
426 bool addr_ext = false;
430 if (!tb[NOTIFY_LINK_UP])
431 return UBUS_STATUS_INVALID_ARGUMENT;
433 up = blobmsg_get_bool(tb[NOTIFY_LINK_UP]);
435 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
439 if ((cur = tb[NOTIFY_KEEP]) != NULL)
440 keep = blobmsg_get_bool(cur);
442 if ((cur = tb[NOTIFY_ADDR_EXT]) != NULL) {
443 addr_ext = blobmsg_get_bool(cur);
448 if (iface->state != IFS_UP)
451 dev = iface->main_dev.dev;
452 if (tb[NOTIFY_IFNAME] && !keep) {
454 devname = blobmsg_data(tb[NOTIFY_IFNAME]);
455 if (tb[NOTIFY_TUNNEL])
456 dev = proto_shell_create_tunnel(devname, tb[NOTIFY_TUNNEL]);
458 dev = device_get(devname, dev_create);
462 return UBUS_STATUS_INVALID_ARGUMENT;
464 interface_set_l3_dev(iface, dev);
465 device_claim(&iface->l3_dev);
466 device_set_present(dev, true);
469 interface_update_start(iface);
471 proto_apply_ip_settings(iface, data, addr_ext);
473 if ((cur = tb[NOTIFY_ROUTES]) != NULL)
474 proto_shell_parse_route_list(state->proto.iface, cur, false);
476 if ((cur = tb[NOTIFY_ROUTES6]) != NULL)
477 proto_shell_parse_route_list(state->proto.iface, cur, true);
479 if ((cur = tb[NOTIFY_DNS]))
480 interface_add_dns_server_list(&iface->proto_ip, cur);
482 if ((cur = tb[NOTIFY_DNS_SEARCH]))
483 interface_add_dns_search_list(&iface->proto_ip, cur);
485 if ((cur = tb[NOTIFY_DATA]))
486 proto_shell_parse_data(state->proto.iface, cur);
488 interface_update_complete(state->proto.iface);
491 state->proto.proto_event(&state->proto, IFPEV_UP);
498 fill_string_list(struct blob_attr *attr, char **argv, int max)
500 struct blob_attr *cur;
507 blobmsg_for_each_attr(cur, attr, rem) {
508 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
511 if (!blobmsg_check_attr(cur, NULL))
514 argv[argc++] = blobmsg_data(cur);
525 proto_shell_run_command(struct proto_shell_state *state, struct blob_attr **tb)
527 static char *argv[64];
528 static char *env[32];
530 if (!tb[NOTIFY_COMMAND])
533 if (!fill_string_list(tb[NOTIFY_COMMAND], argv, ARRAY_SIZE(argv)))
536 if (!fill_string_list(tb[NOTIFY_ENV], env, ARRAY_SIZE(env)))
539 netifd_start_process((const char **) argv, (char **) env, &state->proto_task);
544 return UBUS_STATUS_INVALID_ARGUMENT;
548 proto_shell_kill_command(struct proto_shell_state *state, struct blob_attr **tb)
550 unsigned int signal = ~0;
552 if (tb[NOTIFY_SIGNAL])
553 signal = blobmsg_get_u32(tb[NOTIFY_SIGNAL]);
558 if (state->proto_task.uloop.pending) {
559 state->proto_task_killed = true;
560 kill(state->proto_task.uloop.pid, signal);
567 proto_shell_notify_error(struct proto_shell_state *state, struct blob_attr **tb)
569 struct blob_attr *cur;
574 if (!tb[NOTIFY_ERROR])
575 return UBUS_STATUS_INVALID_ARGUMENT;
577 blobmsg_for_each_attr(cur, tb[NOTIFY_ERROR], rem) {
578 if (n_data + 1 == ARRAY_SIZE(data))
581 if (blobmsg_type(cur) != BLOBMSG_TYPE_STRING)
584 if (!blobmsg_check_attr(cur, NULL))
587 data[n_data++] = blobmsg_data(cur);
593 interface_add_error(state->proto.iface, state->handler->proto.name,
594 data[0], (const char **) &data[1], n_data - 1);
599 return UBUS_STATUS_INVALID_ARGUMENT;
603 proto_shell_block_restart(struct proto_shell_state *state, struct blob_attr **tb)
605 state->proto.iface->autostart = false;
610 proto_shell_set_available(struct proto_shell_state *state, struct blob_attr **tb)
612 if (!tb[NOTIFY_AVAILABLE])
613 return UBUS_STATUS_INVALID_ARGUMENT;
615 interface_set_available(state->proto.iface, blobmsg_get_bool(tb[NOTIFY_AVAILABLE]));
620 proto_shell_add_host_dependency(struct proto_shell_state *state, struct blob_attr **tb)
622 struct proto_shell_dependency *dep;
623 struct blob_attr *host = tb[NOTIFY_HOST];
624 struct blob_attr *ifname_a = tb[NOTIFY_IFNAME];
625 const char *ifname_str = ifname_a ? blobmsg_data(ifname_a) : "";
629 return UBUS_STATUS_INVALID_ARGUMENT;
631 dep = calloc_a(sizeof(*dep), &ifname, strlen(ifname_str) + 1);
632 if (inet_pton(AF_INET, blobmsg_data(host), &dep->host) < 1) {
633 if (inet_pton(AF_INET6, blobmsg_data(host), &dep->host) < 1) {
635 return UBUS_STATUS_INVALID_ARGUMENT;
642 dep->interface = strcpy(ifname, ifname_str);
644 dep->dep.cb = proto_shell_if_up_cb;
645 interface_add_user(&dep->dep, NULL);
646 list_add(&dep->list, &state->deps);
647 proto_shell_update_host_dep(dep);
649 return UBUS_STATUS_NOT_FOUND;
655 proto_shell_setup_failed(struct proto_shell_state *state)
659 state->proto.proto_event(&state->proto, IFPEV_LINK_LOST);
662 proto_shell_handler(&state->proto, PROTO_CMD_TEARDOWN, false);
671 proto_shell_notify(struct interface_proto_state *proto, struct blob_attr *attr)
673 struct proto_shell_state *state;
674 struct blob_attr *tb[__NOTIFY_LAST];
676 state = container_of(proto, struct proto_shell_state, proto);
678 blobmsg_parse(notify_attr, __NOTIFY_LAST, tb, blob_data(attr), blob_len(attr));
679 if (!tb[NOTIFY_ACTION])
680 return UBUS_STATUS_INVALID_ARGUMENT;
682 switch(blobmsg_get_u32(tb[NOTIFY_ACTION])) {
684 return proto_shell_update_link(state, attr, tb);
686 return proto_shell_run_command(state, tb);
688 return proto_shell_kill_command(state, tb);
690 return proto_shell_notify_error(state, tb);
692 return proto_shell_block_restart(state, tb);
694 return proto_shell_set_available(state, tb);
696 return proto_shell_add_host_dependency(state, tb);
698 return proto_shell_setup_failed(state);
700 return UBUS_STATUS_INVALID_ARGUMENT;
704 static struct interface_proto_state *
705 proto_shell_attach(const struct proto_handler *h, struct interface *iface,
706 struct blob_attr *attr)
708 struct proto_shell_state *state;
710 state = calloc(1, sizeof(*state));
711 INIT_LIST_HEAD(&state->deps);
713 state->config = malloc(blob_pad_len(attr));
717 memcpy(state->config, attr, blob_pad_len(attr));
718 state->proto.free = proto_shell_free;
719 state->proto.notify = proto_shell_notify;
720 state->proto.cb = proto_shell_handler;
721 state->teardown_timeout.cb = proto_shell_teardown_timeout_cb;
722 state->script_task.cb = proto_shell_script_cb;
723 state->script_task.dir_fd = proto_fd;
724 state->script_task.log_prefix = iface->name;
725 state->proto_task.cb = proto_shell_task_cb;
726 state->proto_task.dir_fd = proto_fd;
727 state->proto_task.log_prefix = iface->name;
728 state->handler = container_of(h, struct proto_shell_handler, proto);
730 return &state->proto;
738 proto_shell_add_handler(const char *script, const char *name, json_object *obj)
740 struct proto_shell_handler *handler;
741 struct proto_handler *proto;
742 json_object *config, *tmp;
743 char *proto_name, *script_name;
745 handler = calloc_a(sizeof(*handler),
746 &proto_name, strlen(name) + 1,
747 &script_name, strlen(script) + 1);
751 handler->script_name = strcpy(script_name, script);
753 proto = &handler->proto;
754 proto->name = strcpy(proto_name, name);
755 proto->config_params = &handler->config;
756 proto->attach = proto_shell_attach;
758 tmp = json_get_field(obj, "no-device", json_type_boolean);
759 if (tmp && json_object_get_boolean(tmp))
760 handler->proto.flags |= PROTO_FLAG_NODEV;
762 tmp = json_get_field(obj, "available", json_type_boolean);
763 if (tmp && json_object_get_boolean(tmp))
764 handler->proto.flags |= PROTO_FLAG_INIT_AVAILABLE;
766 tmp = json_get_field(obj, "renew-handler", json_type_boolean);
767 if (tmp && json_object_get_boolean(tmp))
768 handler->proto.flags |= PROTO_FLAG_RENEW_AVAILABLE;
770 config = json_get_field(obj, "config", json_type_array);
772 handler->config_buf = netifd_handler_parse_config(&handler->config, config);
774 DPRINTF("Add handler for script %s: %s\n", script, proto->name);
775 add_proto_handler(proto);
778 void proto_shell_init(void)
780 proto_fd = netifd_open_subdir("proto");
784 netifd_init_script_handlers(proto_fd, proto_shell_add_handler);