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.
24 #include <arpa/inet.h>
25 #include <netinet/in.h>
27 #include <libubox/blobmsg_json.h>
30 #include "interface.h"
31 #include "interface-ip.h"
34 static struct netifd_fd proto_fd
;
43 struct proto_shell_handler
{
44 struct list_head list
;
45 struct proto_handler proto
;
46 struct config_param_list config
;
52 struct proto_shell_dependency
{
53 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
;
112 iface
= interface_ip_add_target_route(&dep
->host
, dep
->v6
);
116 interface_remove_user(&dep
->dep
);
117 dep
->dep
.cb
= proto_shell_if_down_cb
;
118 interface_add_user(&dep
->dep
, iface
);
121 proto_shell_check_dependencies(dep
->proto
);
125 proto_shell_clear_host_dep(struct proto_shell_state
*state
)
127 struct proto_shell_dependency
*dep
, *tmp
;
129 list_for_each_entry_safe(dep
, tmp
, &state
->deps
, list
) {
130 interface_remove_user(&dep
->dep
);
131 list_del(&dep
->list
);
137 proto_shell_handler(struct interface_proto_state
*proto
,
138 enum interface_proto_cmd cmd
, bool force
)
140 struct proto_shell_state
*state
;
141 struct proto_shell_handler
*handler
;
142 struct netifd_process
*proc
;
143 static char error_buf
[32];
148 int ret
, i
= 0, j
= 0;
150 state
= container_of(proto
, struct proto_shell_state
, proto
);
151 handler
= state
->handler
;
152 proc
= &state
->script_task
;
154 if (cmd
== PROTO_CMD_SETUP
) {
156 state
->last_error
= -1;
157 proto_shell_clear_host_dep(state
);
159 if (state
->sm
== S_TEARDOWN
)
162 if (state
->script_task
.uloop
.pending
) {
163 if (state
->sm
!= S_SETUP_ABORT
) {
164 uloop_timeout_set(&state
->teardown_timeout
, 1000);
165 kill(state
->script_task
.uloop
.pid
, SIGTERM
);
166 if (state
->proto_task
.uloop
.pending
)
167 kill(state
->proto_task
.uloop
.pid
, SIGTERM
);
168 state
->sm
= S_SETUP_ABORT
;
174 state
->sm
= S_TEARDOWN
;
175 if (state
->last_error
>= 0) {
176 snprintf(error_buf
, sizeof(error_buf
), "ERROR=%d", state
->last_error
);
177 envp
[j
++] = error_buf
;
179 uloop_timeout_set(&state
->teardown_timeout
, 5000);
182 config
= blobmsg_format_json(state
->config
, true);
186 argv
[i
++] = handler
->script_name
;
187 argv
[i
++] = handler
->proto
.name
;
189 argv
[i
++] = proto
->iface
->name
;
191 if (proto
->iface
->main_dev
.dev
)
192 argv
[i
++] = proto
->iface
->main_dev
.dev
->ifname
;
196 ret
= netifd_start_process(argv
, envp
, proc
);
203 proto_shell_if_up_cb(struct interface_user
*dep
, struct interface
*iface
,
204 enum interface_event ev
)
206 struct proto_shell_dependency
*pdep
;
211 pdep
= container_of(dep
, struct proto_shell_dependency
, dep
);
212 proto_shell_update_host_dep(pdep
);
216 proto_shell_if_down_cb(struct interface_user
*dep
, struct interface
*iface
,
217 enum interface_event ev
)
219 struct proto_shell_dependency
*pdep
;
220 struct proto_shell_state
*state
;
225 pdep
= container_of(dep
, struct proto_shell_dependency
, dep
);
226 interface_remove_user(dep
);
227 dep
->cb
= proto_shell_if_up_cb
;
228 interface_add_user(dep
, NULL
);
231 if (state
->sm
== S_IDLE
) {
232 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
233 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
, false);
238 proto_shell_task_finish(struct proto_shell_state
*state
,
239 struct netifd_process
*task
)
243 if (task
== &state
->proto_task
)
244 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
247 if (task
== &state
->proto_task
)
248 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
,
253 if (state
->script_task
.uloop
.pending
||
254 state
->proto_task
.uloop
.pending
)
257 uloop_timeout_cancel(&state
->teardown_timeout
);
259 proto_shell_handler(&state
->proto
, PROTO_CMD_TEARDOWN
, false);
263 if (state
->script_task
.uloop
.pending
)
266 if (state
->proto_task
.uloop
.pending
) {
267 if (!state
->proto_task_killed
)
268 kill(state
->proto_task
.uloop
.pid
, SIGTERM
);
272 uloop_timeout_cancel(&state
->teardown_timeout
);
274 state
->proto
.proto_event(&state
->proto
, IFPEV_DOWN
);
280 proto_shell_teardown_timeout_cb(struct uloop_timeout
*timeout
)
282 struct proto_shell_state
*state
;
284 state
= container_of(timeout
, struct proto_shell_state
, teardown_timeout
);
286 netifd_kill_process(&state
->script_task
);
287 netifd_kill_process(&state
->proto_task
);
288 proto_shell_task_finish(state
, NULL
);
292 proto_shell_script_cb(struct netifd_process
*p
, int ret
)
294 struct proto_shell_state
*state
;
296 state
= container_of(p
, struct proto_shell_state
, script_task
);
297 proto_shell_task_finish(state
, p
);
301 proto_shell_task_cb(struct netifd_process
*p
, int ret
)
303 struct proto_shell_state
*state
;
305 state
= container_of(p
, struct proto_shell_state
, proto_task
);
307 if (state
->sm
== S_IDLE
|| state
->sm
== S_SETUP
)
308 state
->last_error
= WEXITSTATUS(ret
);
310 proto_shell_task_finish(state
, p
);
314 proto_shell_free(struct interface_proto_state
*proto
)
316 struct proto_shell_state
*state
;
318 state
= container_of(proto
, struct proto_shell_state
, proto
);
319 netifd_kill_process(&state
->script_task
);
320 netifd_kill_process(&state
->proto_task
);
326 proto_shell_parse_route_list(struct interface
*iface
, struct blob_attr
*attr
,
329 struct blob_attr
*cur
;
332 blobmsg_for_each_attr(cur
, attr
, rem
) {
333 if (blobmsg_type(cur
) != BLOBMSG_TYPE_TABLE
) {
334 DPRINTF("Ignore wrong route type: %d\n", blobmsg_type(cur
));
338 interface_ip_add_route(iface
, cur
, v6
);
343 proto_shell_parse_data(struct interface
*iface
, struct blob_attr
*attr
)
345 struct blob_attr
*cur
;
348 blobmsg_for_each_attr(cur
, attr
, rem
)
349 interface_add_data(iface
, cur
);
352 static struct device
*
353 proto_shell_create_tunnel(const char *name
, struct blob_attr
*attr
)
358 memset(&b
, 0, sizeof(b
));
359 blob_buf_init(&b
, 0);
360 blob_put(&b
, 0, blobmsg_data(attr
), blobmsg_data_len(attr
));
361 dev
= device_create(name
, &tunnel_device_type
, blob_data(b
.head
));
386 static const struct blobmsg_policy notify_attr
[__NOTIFY_LAST
] = {
387 [NOTIFY_ACTION
] = { .name
= "action", .type
= BLOBMSG_TYPE_INT32
},
388 [NOTIFY_ERROR
] = { .name
= "error", .type
= BLOBMSG_TYPE_ARRAY
},
389 [NOTIFY_COMMAND
] = { .name
= "command", .type
= BLOBMSG_TYPE_ARRAY
},
390 [NOTIFY_ENV
] = { .name
= "env", .type
= BLOBMSG_TYPE_ARRAY
},
391 [NOTIFY_SIGNAL
] = { .name
= "signal", .type
= BLOBMSG_TYPE_INT32
},
392 [NOTIFY_AVAILABLE
] = { .name
= "available", .type
= BLOBMSG_TYPE_BOOL
},
393 [NOTIFY_LINK_UP
] = { .name
= "link-up", .type
= BLOBMSG_TYPE_BOOL
},
394 [NOTIFY_IFNAME
] = { .name
= "ifname", .type
= BLOBMSG_TYPE_STRING
},
395 [NOTIFY_ADDR_EXT
] = { .name
= "address-external", .type
= BLOBMSG_TYPE_BOOL
},
396 [NOTIFY_ROUTES
] = { .name
= "routes", .type
= BLOBMSG_TYPE_ARRAY
},
397 [NOTIFY_ROUTES6
] = { .name
= "routes6", .type
= BLOBMSG_TYPE_ARRAY
},
398 [NOTIFY_TUNNEL
] = { .name
= "tunnel", .type
= BLOBMSG_TYPE_TABLE
},
399 [NOTIFY_DATA
] = { .name
= "data", .type
= BLOBMSG_TYPE_TABLE
},
400 [NOTIFY_KEEP
] = { .name
= "keep", .type
= BLOBMSG_TYPE_BOOL
},
401 [NOTIFY_HOST
] = { .name
= "host", .type
= BLOBMSG_TYPE_STRING
},
405 proto_shell_update_link(struct proto_shell_state
*state
, struct blob_attr
*data
, struct blob_attr
**tb
)
407 struct interface
*iface
= state
->proto
.iface
;
408 struct blob_attr
*cur
;
412 bool addr_ext
= false;
416 if (!tb
[NOTIFY_LINK_UP
])
417 return UBUS_STATUS_INVALID_ARGUMENT
;
419 up
= blobmsg_get_bool(tb
[NOTIFY_LINK_UP
]);
421 state
->proto
.proto_event(&state
->proto
, IFPEV_LINK_LOST
);
425 if ((cur
= tb
[NOTIFY_KEEP
]) != NULL
)
426 keep
= blobmsg_get_bool(cur
);
428 if ((cur
= tb
[NOTIFY_ADDR_EXT
]) != NULL
) {
429 addr_ext
= blobmsg_get_bool(cur
);
434 if (!tb
[NOTIFY_IFNAME
]) {
435 if (!iface
->main_dev
.dev
)
436 return UBUS_STATUS_INVALID_ARGUMENT
;
437 } else if (!keep
|| iface
->state
!= IFS_UP
) {
439 devname
= blobmsg_data(tb
[NOTIFY_IFNAME
]);
440 if (tb
[NOTIFY_TUNNEL
]) {
441 dev
= proto_shell_create_tunnel(devname
,
444 return UBUS_STATUS_INVALID_ARGUMENT
;
446 dev
= device_get(devname
, dev_create
);
448 return UBUS_STATUS_NOT_FOUND
;
451 interface_set_l3_dev(iface
, dev
);
452 device_claim(&iface
->l3_dev
);
456 interface_update_start(iface
);
458 proto_apply_ip_settings(iface
, data
, addr_ext
);
460 if ((cur
= tb
[NOTIFY_ROUTES
]) != NULL
)
461 proto_shell_parse_route_list(state
->proto
.iface
, cur
, false);
463 if ((cur
= tb
[NOTIFY_ROUTES6
]) != NULL
)
464 proto_shell_parse_route_list(state
->proto
.iface
, cur
, true);
466 interface_update_complete(state
->proto
.iface
);
469 state
->proto
.proto_event(&state
->proto
, IFPEV_UP
);
472 if ((cur
= tb
[NOTIFY_DATA
]))
473 proto_shell_parse_data(state
->proto
.iface
, cur
);
479 fill_string_list(struct blob_attr
*attr
, char **argv
, int max
)
481 struct blob_attr
*cur
;
488 blobmsg_for_each_attr(cur
, attr
, rem
) {
489 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
492 if (!blobmsg_check_attr(cur
, NULL
))
495 argv
[argc
++] = blobmsg_data(cur
);
506 proto_shell_run_command(struct proto_shell_state
*state
, struct blob_attr
**tb
)
508 static char *argv
[64];
509 static char *env
[32];
511 if (!tb
[NOTIFY_COMMAND
])
514 if (!fill_string_list(tb
[NOTIFY_COMMAND
], argv
, ARRAY_SIZE(argv
)))
517 if (!fill_string_list(tb
[NOTIFY_ENV
], env
, ARRAY_SIZE(env
)))
520 netifd_start_process((const char **) argv
, (char **) env
, &state
->proto_task
);
525 return UBUS_STATUS_INVALID_ARGUMENT
;
529 proto_shell_kill_command(struct proto_shell_state
*state
, struct blob_attr
**tb
)
531 unsigned int signal
= ~0;
533 if (tb
[NOTIFY_SIGNAL
])
534 signal
= blobmsg_get_u32(tb
[NOTIFY_SIGNAL
]);
539 if (state
->proto_task
.uloop
.pending
) {
540 state
->proto_task_killed
= true;
541 kill(state
->proto_task
.uloop
.pid
, signal
);
548 proto_shell_notify_error(struct proto_shell_state
*state
, struct blob_attr
**tb
)
550 struct blob_attr
*cur
;
555 if (!tb
[NOTIFY_ERROR
])
556 return UBUS_STATUS_INVALID_ARGUMENT
;
558 blobmsg_for_each_attr(cur
, tb
[NOTIFY_ERROR
], rem
) {
559 if (n_data
+ 1 == ARRAY_SIZE(data
))
562 if (blobmsg_type(cur
) != BLOBMSG_TYPE_STRING
)
565 if (!blobmsg_check_attr(cur
, NULL
))
568 data
[n_data
++] = blobmsg_data(cur
);
574 interface_add_error(state
->proto
.iface
, state
->handler
->proto
.name
,
575 data
[0], (const char **) &data
[1], n_data
- 1);
580 return UBUS_STATUS_INVALID_ARGUMENT
;
584 proto_shell_block_restart(struct proto_shell_state
*state
, struct blob_attr
**tb
)
586 state
->proto
.iface
->autostart
= false;
591 proto_shell_set_available(struct proto_shell_state
*state
, struct blob_attr
**tb
)
593 if (!tb
[NOTIFY_AVAILABLE
])
594 return UBUS_STATUS_INVALID_ARGUMENT
;
596 interface_set_available(state
->proto
.iface
, blobmsg_get_bool(tb
[NOTIFY_AVAILABLE
]));
601 proto_shell_add_host_dependency(struct proto_shell_state
*state
, struct blob_attr
**tb
)
603 struct proto_shell_dependency
*dep
;
604 struct blob_attr
*host
= tb
[NOTIFY_HOST
];
607 return UBUS_STATUS_INVALID_ARGUMENT
;
609 dep
= calloc(1, sizeof(*dep
));
610 if (!inet_pton(AF_INET
, blobmsg_data(host
), &dep
->host
)) {
612 return UBUS_STATUS_INVALID_ARGUMENT
;
616 dep
->dep
.cb
= proto_shell_if_up_cb
;
617 interface_add_user(&dep
->dep
, NULL
);
618 list_add(&dep
->list
, &state
->deps
);
619 proto_shell_update_host_dep(dep
);
621 return UBUS_STATUS_NOT_FOUND
;
627 proto_shell_notify(struct interface_proto_state
*proto
, struct blob_attr
*attr
)
629 struct proto_shell_state
*state
;
630 struct blob_attr
*tb
[__NOTIFY_LAST
];
632 state
= container_of(proto
, struct proto_shell_state
, proto
);
634 blobmsg_parse(notify_attr
, __NOTIFY_LAST
, tb
, blob_data(attr
), blob_len(attr
));
635 if (!tb
[NOTIFY_ACTION
])
636 return UBUS_STATUS_INVALID_ARGUMENT
;
638 switch(blobmsg_get_u32(tb
[NOTIFY_ACTION
])) {
640 return proto_shell_update_link(state
, attr
, tb
);
642 return proto_shell_run_command(state
, tb
);
644 return proto_shell_kill_command(state
, tb
);
646 return proto_shell_notify_error(state
, tb
);
648 return proto_shell_block_restart(state
, tb
);
650 return proto_shell_set_available(state
, tb
);
652 return proto_shell_add_host_dependency(state
, tb
);
654 return UBUS_STATUS_INVALID_ARGUMENT
;
658 static struct interface_proto_state
*
659 proto_shell_attach(const struct proto_handler
*h
, struct interface
*iface
,
660 struct blob_attr
*attr
)
662 struct proto_shell_state
*state
;
664 state
= calloc(1, sizeof(*state
));
665 INIT_LIST_HEAD(&state
->deps
);
667 state
->config
= malloc(blob_pad_len(attr
));
671 memcpy(state
->config
, attr
, blob_pad_len(attr
));
672 state
->proto
.free
= proto_shell_free
;
673 state
->proto
.notify
= proto_shell_notify
;
674 state
->proto
.cb
= proto_shell_handler
;
675 state
->teardown_timeout
.cb
= proto_shell_teardown_timeout_cb
;
676 state
->script_task
.cb
= proto_shell_script_cb
;
677 state
->script_task
.dir_fd
= proto_fd
.fd
;
678 state
->script_task
.log_prefix
= iface
->name
;
679 state
->proto_task
.cb
= proto_shell_task_cb
;
680 state
->proto_task
.dir_fd
= proto_fd
.fd
;
681 state
->proto_task
.log_prefix
= iface
->name
;
682 state
->handler
= container_of(h
, struct proto_shell_handler
, proto
);
684 return &state
->proto
;
692 check_type(json_object
*obj
, json_type type
)
697 if (json_object_get_type(obj
) != type
)
703 static inline json_object
*
704 get_field(json_object
*obj
, const char *name
, json_type type
)
706 return check_type(json_object_object_get(obj
, name
), type
);
710 proto_shell_parse_config(struct config_param_list
*config
, json_object
*obj
)
712 struct blobmsg_policy
*attrs
;
713 char *str_buf
, *str_cur
;
717 config
->n_params
= json_object_array_length(obj
);
718 attrs
= calloc(1, sizeof(*attrs
) * config
->n_params
);
722 config
->params
= attrs
;
723 for (i
= 0; i
< config
->n_params
; i
++) {
724 json_object
*cur
, *name
, *type
;
726 cur
= check_type(json_object_array_get_idx(obj
, i
), json_type_array
);
730 name
= check_type(json_object_array_get_idx(cur
, 0), json_type_string
);
734 type
= check_type(json_object_array_get_idx(cur
, 1), json_type_int
);
738 attrs
[i
].name
= json_object_get_string(name
);
739 attrs
[i
].type
= json_object_get_int(type
);
740 if (attrs
[i
].type
> BLOBMSG_TYPE_LAST
)
743 str_len
+= strlen(attrs
[i
].name
) + 1;
746 str_buf
= malloc(str_len
);
751 for (i
= 0; i
< config
->n_params
; i
++) {
752 const char *name
= attrs
[i
].name
;
754 attrs
[i
].name
= str_cur
;
755 str_cur
+= sprintf(str_cur
, "%s", name
) + 1;
762 config
->n_params
= 0;
767 proto_shell_add_handler(const char *script
, json_object
*obj
)
769 struct proto_shell_handler
*handler
;
770 struct proto_handler
*proto
;
771 json_object
*config
, *tmp
;
775 if (!check_type(obj
, json_type_object
))
778 tmp
= get_field(obj
, "name", json_type_string
);
782 name
= json_object_get_string(tmp
);
784 handler
= calloc(1, sizeof(*handler
) +
790 strcpy(handler
->script_name
, script
);
792 str
= handler
->script_name
+ strlen(handler
->script_name
) + 1;
795 proto
= &handler
->proto
;
797 proto
->config_params
= &handler
->config
;
798 proto
->attach
= proto_shell_attach
;
800 tmp
= get_field(obj
, "no-device", json_type_boolean
);
801 if (tmp
&& json_object_get_boolean(tmp
))
802 handler
->proto
.flags
|= PROTO_FLAG_NODEV
;
804 tmp
= get_field(obj
, "available", json_type_boolean
);
805 if (tmp
&& json_object_get_boolean(tmp
))
806 handler
->proto
.flags
|= PROTO_FLAG_INIT_AVAILABLE
;
808 config
= get_field(obj
, "config", json_type_array
);
810 handler
->config_buf
= proto_shell_parse_config(&handler
->config
, config
);
812 DPRINTF("Add handler for script %s: %s\n", script
, proto
->name
);
813 add_proto_handler(proto
);
816 static void proto_shell_add_script(const char *name
)
818 struct json_tokener
*tok
= NULL
;
820 static char buf
[512];
825 #define DUMP_SUFFIX " '' dump"
827 cmd
= alloca(strlen(name
) + 1 + sizeof(DUMP_SUFFIX
));
828 sprintf(cmd
, "%s" DUMP_SUFFIX
, name
);
835 start
= fgets(buf
, sizeof(buf
), f
);
842 tok
= json_tokener_new();
844 obj
= json_tokener_parse_ex(tok
, start
, len
);
845 if (!is_error(obj
)) {
846 proto_shell_add_handler(name
, obj
);
847 json_object_put(obj
);
848 json_tokener_free(tok
);
850 } else if (start
[len
- 1] == '\n') {
851 json_tokener_free(tok
);
854 } while (!feof(f
) && !ferror(f
));
857 json_tokener_free(tok
);
862 static void __init
proto_shell_init(void)
868 main_fd
= open(".", O_RDONLY
| O_DIRECTORY
);
872 if (chdir(main_path
)) {
873 perror("chdir(main path)");
877 if (chdir("./proto"))
880 proto_fd
.fd
= open(".", O_RDONLY
| O_DIRECTORY
);
884 netifd_fd_add(&proto_fd
);
885 glob("./*.sh", 0, NULL
, &g
);
886 for (i
= 0; i
< g
.gl_pathc
; i
++)
887 proto_shell_add_script(g
.gl_pathv
[i
]);