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 D(INTERFACE
, "run %s for interface '%s'\n", action
, proto
->iface
->name
);
191 config
= blobmsg_format_json(state
->config
, true);
195 argv
[i
++] = handler
->script_name
;
196 argv
[i
++] = handler
->proto
.name
;
198 argv
[i
++] = proto
->iface
->name
;
200 if (proto
->iface
->main_dev
.dev
)
201 argv
[i
++] = proto
->iface
->main_dev
.dev
->ifname
;
205 ret
= netifd_start_process(argv
, envp
, proc
);
212 proto_shell_if_up_cb(struct interface_user
*dep
, struct interface
*iface
,
213 enum interface_event ev
)
215 struct proto_shell_dependency
*pdep
;
217 if (ev
!= IFEV_UP
&& ev
!= IFEV_UPDATE
)
220 pdep
= container_of(dep
, struct proto_shell_dependency
, dep
);
221 proto_shell_update_host_dep(pdep
);
225 proto_shell_if_down_cb(struct interface_user
*dep
, struct interface
*iface
,
226 enum interface_event ev
)
228 struct proto_shell_dependency
*pdep
;
229 struct proto_shell_state
*state
;
231 if (ev
== IFEV_UP
|| ev
== IFEV_UPDATE
)
234 pdep
= container_of(dep
, struct proto_shell_dependency
, dep
);
235 interface_remove_user(dep
);
236 dep
->cb
= proto_shell_if_up_cb
;
237 interface_add_user(dep
, NULL
);
240 if (state
->sm
== S_IDLE
) {
241 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
242 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
, false);
247 proto_shell_task_finish(struct proto_shell_state
*state
,
248 struct netifd_process
*task
)
252 if (task
== &state
->proto_task
)
253 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
256 if (task
== &state
->proto_task
)
257 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
,
262 if (state
->script_task
.uloop
.pending
||
263 state
->proto_task
.uloop
.pending
)
266 uloop_timeout_cancel(&state
->teardown_timeout
);
268 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
, false);
272 if (state
->script_task
.uloop
.pending
)
275 if (state
->proto_task
.uloop
.pending
) {
276 if (!state
->proto_task_killed
)
277 kill(state
->proto_task
.uloop
.pid
, SIGTERM
);
281 uloop_timeout_cancel(&state
->teardown_timeout
);
283 state
->proto
.proto_event(&state
->proto
, IFPEV_DOWN
);
289 proto_shell_teardown_timeout_cb(struct uloop_timeout
*timeout
)
291 struct proto_shell_state
*state
;
293 state
= container_of(timeout
, struct proto_shell_state
, teardown_timeout
);
295 netifd_kill_process(&state
->script_task
);
296 netifd_kill_process(&state
->proto_task
);
297 proto_shell_task_finish(state
, NULL
);
301 proto_shell_script_cb(struct netifd_process
*p
, int ret
)
303 struct proto_shell_state
*state
;
305 state
= container_of(p
, struct proto_shell_state
, script_task
);
306 proto_shell_task_finish(state
, p
);
310 proto_shell_task_cb(struct netifd_process
*p
, int ret
)
312 struct proto_shell_state
*state
;
314 state
= container_of(p
, struct proto_shell_state
, proto_task
);
316 if (state
->sm
== S_IDLE
|| state
->sm
== S_SETUP
)
317 state
->last_error
= WEXITSTATUS(ret
);
319 proto_shell_task_finish(state
, p
);
323 proto_shell_free(struct interface_proto_state
*proto
)
325 struct proto_shell_state
*state
;
327 state
= container_of(proto
, struct proto_shell_state
, proto
);
328 uloop_timeout_cancel(&state
->teardown_timeout
);
329 proto_shell_clear_host_dep(state
);
330 netifd_kill_process(&state
->script_task
);
331 netifd_kill_process(&state
->proto_task
);
337 proto_shell_parse_route_list(struct interface
*iface
, struct blob_attr
*attr
,
340 struct blob_attr
*cur
;
343 blobmsg_for_each_attr(cur
, attr
, rem
) {
344 if (blobmsg_type(cur
) != BLOBMSG_TYPE_TABLE
) {
345 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur
));
349 interface_ip_add_route(iface
, cur
, v6
);
354 proto_shell_parse_data(struct interface
*iface
, struct blob_attr
*attr
)
356 struct blob_attr
*cur
;
359 blobmsg_for_each_attr(cur
, attr
, rem
)
360 interface_add_data(iface
, cur
);
363 static struct device
*
364 proto_shell_create_tunnel(const char *name
, struct blob_attr
*attr
)
369 memset(&b
, 0, sizeof(b
));
370 blob_buf_init(&b
, 0);
371 blob_put(&b
, 0, blobmsg_data(attr
), blobmsg_data_len(attr
));
372 dev
= device_create(name
, &tunnel_device_type
, blob_data(b
.head
));
399 static const struct blobmsg_policy notify_attr
[__NOTIFY_LAST
] = {
400 [NOTIFY_ACTION
] = { .name
= "action", .type
= BLOBMSG_TYPE_INT32
},
401 [NOTIFY_ERROR
] = { .name
= "error", .type
= BLOBMSG_TYPE_ARRAY
},
402 [NOTIFY_COMMAND
] = { .name
= "command", .type
= BLOBMSG_TYPE_ARRAY
},
403 [NOTIFY_ENV
] = { .name
= "env", .type
= BLOBMSG_TYPE_ARRAY
},
404 [NOTIFY_SIGNAL
] = { .name
= "signal", .type
= BLOBMSG_TYPE_INT32
},
405 [NOTIFY_AVAILABLE
] = { .name
= "available", .type
= BLOBMSG_TYPE_BOOL
},
406 [NOTIFY_LINK_UP
] = { .name
= "link-up", .type
= BLOBMSG_TYPE_BOOL
},
407 [NOTIFY_IFNAME
] = { .name
= "ifname", .type
= BLOBMSG_TYPE_STRING
},
408 [NOTIFY_ADDR_EXT
] = { .name
= "address-external", .type
= BLOBMSG_TYPE_BOOL
},
409 [NOTIFY_ROUTES
] = { .name
= "routes", .type
= BLOBMSG_TYPE_ARRAY
},
410 [NOTIFY_ROUTES6
] = { .name
= "routes6", .type
= BLOBMSG_TYPE_ARRAY
},
411 [NOTIFY_TUNNEL
] = { .name
= "tunnel", .type
= BLOBMSG_TYPE_TABLE
},
412 [NOTIFY_DATA
] = { .name
= "data", .type
= BLOBMSG_TYPE_TABLE
},
413 [NOTIFY_KEEP
] = { .name
= "keep", .type
= BLOBMSG_TYPE_BOOL
},
414 [NOTIFY_HOST
] = { .name
= "host", .type
= BLOBMSG_TYPE_STRING
},
415 [NOTIFY_DNS
] = { .name
= "dns", .type
= BLOBMSG_TYPE_ARRAY
},
416 [NOTIFY_DNS_SEARCH
] = { .name
= "dns_search", .type
= BLOBMSG_TYPE_ARRAY
},
420 proto_shell_update_link(struct proto_shell_state
*state
, struct blob_attr
*data
, struct blob_attr
**tb
)
422 struct interface
*iface
= state
->proto
.iface
;
423 struct blob_attr
*cur
;
427 bool addr_ext
= false;
431 if (!tb
[NOTIFY_LINK_UP
])
432 return UBUS_STATUS_INVALID_ARGUMENT
;
434 up
= blobmsg_get_bool(tb
[NOTIFY_LINK_UP
]);
436 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
440 if ((cur
= tb
[NOTIFY_KEEP
]) != NULL
)
441 keep
= blobmsg_get_bool(cur
);
443 if ((cur
= tb
[NOTIFY_ADDR_EXT
]) != NULL
) {
444 addr_ext
= blobmsg_get_bool(cur
);
449 if (iface
->state
!= IFS_UP
|| !iface
->l3_dev
.dev
)
453 dev
= iface
->main_dev
.dev
;
454 if (tb
[NOTIFY_IFNAME
]) {
456 devname
= blobmsg_data(tb
[NOTIFY_IFNAME
]);
457 if (tb
[NOTIFY_TUNNEL
])
458 dev
= proto_shell_create_tunnel(devname
, tb
[NOTIFY_TUNNEL
]);
460 dev
= device_get(devname
, dev_create
);
464 return UBUS_STATUS_INVALID_ARGUMENT
;
466 interface_set_l3_dev(iface
, dev
);
467 if (device_claim(&iface
->l3_dev
) < 0)
468 return UBUS_STATUS_UNKNOWN_ERROR
;
470 device_set_present(dev
, true);
472 interface_update_start(iface
);
475 proto_apply_ip_settings(iface
, data
, addr_ext
);
477 if ((cur
= tb
[NOTIFY_ROUTES
]) != NULL
)
478 proto_shell_parse_route_list(state
->proto
.iface
, cur
, false);
480 if ((cur
= tb
[NOTIFY_ROUTES6
]) != NULL
)
481 proto_shell_parse_route_list(state
->proto
.iface
, cur
, true);
483 if ((cur
= tb
[NOTIFY_DNS
]))
484 interface_add_dns_server_list(&iface
->proto_ip
, cur
);
486 if ((cur
= tb
[NOTIFY_DNS_SEARCH
]))
487 interface_add_dns_search_list(&iface
->proto_ip
, cur
);
489 if ((cur
= tb
[NOTIFY_DATA
]))
490 proto_shell_parse_data(state
->proto
.iface
, cur
);
492 interface_update_complete(state
->proto
.iface
);
495 state
->proto
.proto_event(&state
->proto
, IFPEV_UP
);
502 fill_string_list(struct blob_attr
*attr
, char **argv
, int max
)
504 struct blob_attr
*cur
;
511 blobmsg_for_each_attr(cur
, attr
, rem
) {
512 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
515 if (!blobmsg_check_attr(cur
, NULL
))
518 argv
[argc
++] = blobmsg_data(cur
);
529 proto_shell_run_command(struct proto_shell_state
*state
, struct blob_attr
**tb
)
531 static char *argv
[64];
532 static char *env
[32];
534 if (!tb
[NOTIFY_COMMAND
])
537 if (!fill_string_list(tb
[NOTIFY_COMMAND
], argv
, ARRAY_SIZE(argv
)))
540 if (!fill_string_list(tb
[NOTIFY_ENV
], env
, ARRAY_SIZE(env
)))
543 netifd_start_process((const char **) argv
, (char **) env
, &state
->proto_task
);
548 return UBUS_STATUS_INVALID_ARGUMENT
;
552 proto_shell_kill_command(struct proto_shell_state
*state
, struct blob_attr
**tb
)
554 unsigned int signal
= ~0;
556 if (tb
[NOTIFY_SIGNAL
])
557 signal
= blobmsg_get_u32(tb
[NOTIFY_SIGNAL
]);
562 if (state
->proto_task
.uloop
.pending
) {
563 state
->proto_task_killed
= true;
564 kill(state
->proto_task
.uloop
.pid
, signal
);
571 proto_shell_notify_error(struct proto_shell_state
*state
, struct blob_attr
**tb
)
573 struct blob_attr
*cur
;
578 if (!tb
[NOTIFY_ERROR
])
579 return UBUS_STATUS_INVALID_ARGUMENT
;
581 blobmsg_for_each_attr(cur
, tb
[NOTIFY_ERROR
], rem
) {
582 if (n_data
+ 1 == ARRAY_SIZE(data
))
585 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
588 if (!blobmsg_check_attr(cur
, NULL
))
591 data
[n_data
++] = blobmsg_data(cur
);
597 interface_add_error(state
->proto
.iface
, state
->handler
->proto
.name
,
598 data
[0], (const char **) &data
[1], n_data
- 1);
603 return UBUS_STATUS_INVALID_ARGUMENT
;
607 proto_shell_block_restart(struct proto_shell_state
*state
, struct blob_attr
**tb
)
609 state
->proto
.iface
->autostart
= false;
614 proto_shell_set_available(struct proto_shell_state
*state
, struct blob_attr
**tb
)
616 if (!tb
[NOTIFY_AVAILABLE
])
617 return UBUS_STATUS_INVALID_ARGUMENT
;
619 interface_set_available(state
->proto
.iface
, blobmsg_get_bool(tb
[NOTIFY_AVAILABLE
]));
624 proto_shell_add_host_dependency(struct proto_shell_state
*state
, struct blob_attr
**tb
)
626 struct proto_shell_dependency
*dep
;
627 struct blob_attr
*host
= tb
[NOTIFY_HOST
];
628 struct blob_attr
*ifname_a
= tb
[NOTIFY_IFNAME
];
629 const char *ifname_str
= ifname_a
? blobmsg_data(ifname_a
) : "";
633 return UBUS_STATUS_INVALID_ARGUMENT
;
635 dep
= calloc_a(sizeof(*dep
), &ifname
, strlen(ifname_str
) + 1);
636 if (inet_pton(AF_INET
, blobmsg_data(host
), &dep
->host
) < 1) {
637 if (inet_pton(AF_INET6
, blobmsg_data(host
), &dep
->host
) < 1) {
639 return UBUS_STATUS_INVALID_ARGUMENT
;
646 dep
->interface
= strcpy(ifname
, ifname_str
);
648 dep
->dep
.cb
= proto_shell_if_up_cb
;
649 interface_add_user(&dep
->dep
, NULL
);
650 list_add(&dep
->list
, &state
->deps
);
651 proto_shell_update_host_dep(dep
);
653 return UBUS_STATUS_NOT_FOUND
;
659 proto_shell_setup_failed(struct proto_shell_state
*state
)
663 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
666 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
, false);
675 proto_shell_notify(struct interface_proto_state
*proto
, struct blob_attr
*attr
)
677 struct proto_shell_state
*state
;
678 struct blob_attr
*tb
[__NOTIFY_LAST
];
680 state
= container_of(proto
, struct proto_shell_state
, proto
);
682 blobmsg_parse(notify_attr
, __NOTIFY_LAST
, tb
, blob_data(attr
), blob_len(attr
));
683 if (!tb
[NOTIFY_ACTION
])
684 return UBUS_STATUS_INVALID_ARGUMENT
;
686 switch(blobmsg_get_u32(tb
[NOTIFY_ACTION
])) {
688 return proto_shell_update_link(state
, attr
, tb
);
690 return proto_shell_run_command(state
, tb
);
692 return proto_shell_kill_command(state
, tb
);
694 return proto_shell_notify_error(state
, tb
);
696 return proto_shell_block_restart(state
, tb
);
698 return proto_shell_set_available(state
, tb
);
700 return proto_shell_add_host_dependency(state
, tb
);
702 return proto_shell_setup_failed(state
);
704 return UBUS_STATUS_INVALID_ARGUMENT
;
708 static struct interface_proto_state
*
709 proto_shell_attach(const struct proto_handler
*h
, struct interface
*iface
,
710 struct blob_attr
*attr
)
712 struct proto_shell_state
*state
;
714 state
= calloc(1, sizeof(*state
));
715 INIT_LIST_HEAD(&state
->deps
);
717 state
->config
= malloc(blob_pad_len(attr
));
721 memcpy(state
->config
, attr
, blob_pad_len(attr
));
722 state
->proto
.free
= proto_shell_free
;
723 state
->proto
.notify
= proto_shell_notify
;
724 state
->proto
.cb
= proto_shell_handler
;
725 state
->teardown_timeout
.cb
= proto_shell_teardown_timeout_cb
;
726 state
->script_task
.cb
= proto_shell_script_cb
;
727 state
->script_task
.dir_fd
= proto_fd
;
728 state
->script_task
.log_prefix
= iface
->name
;
729 state
->proto_task
.cb
= proto_shell_task_cb
;
730 state
->proto_task
.dir_fd
= proto_fd
;
731 state
->proto_task
.log_prefix
= iface
->name
;
732 state
->handler
= container_of(h
, struct proto_shell_handler
, proto
);
734 return &state
->proto
;
742 proto_shell_add_handler(const char *script
, const char *name
, json_object
*obj
)
744 struct proto_shell_handler
*handler
;
745 struct proto_handler
*proto
;
746 json_object
*config
, *tmp
;
747 char *proto_name
, *script_name
;
749 handler
= calloc_a(sizeof(*handler
),
750 &proto_name
, strlen(name
) + 1,
751 &script_name
, strlen(script
) + 1);
755 handler
->script_name
= strcpy(script_name
, script
);
757 proto
= &handler
->proto
;
758 proto
->name
= strcpy(proto_name
, name
);
759 proto
->config_params
= &handler
->config
;
760 proto
->attach
= proto_shell_attach
;
762 tmp
= json_get_field(obj
, "no-device", json_type_boolean
);
763 if (tmp
&& json_object_get_boolean(tmp
))
764 handler
->proto
.flags
|= PROTO_FLAG_NODEV
;
766 tmp
= json_get_field(obj
, "available", json_type_boolean
);
767 if (tmp
&& json_object_get_boolean(tmp
))
768 handler
->proto
.flags
|= PROTO_FLAG_INIT_AVAILABLE
;
770 tmp
= json_get_field(obj
, "renew-handler", json_type_boolean
);
771 if (tmp
&& json_object_get_boolean(tmp
))
772 handler
->proto
.flags
|= PROTO_FLAG_RENEW_AVAILABLE
;
774 config
= json_get_field(obj
, "config", json_type_array
);
776 handler
->config_buf
= netifd_handler_parse_config(&handler
->config
, config
);
778 DPRINTF("Add handler for script %s: %s\n", script
, proto
->name
);
779 add_proto_handler(proto
);
782 void proto_shell_init(void)
784 proto_fd
= netifd_open_subdir("proto");
788 netifd_init_script_handlers(proto_fd
, proto_shell_add_handler
);