2 * Copyright (C) 2015-2019 "IoT.bzh"
3 * Author "Fulup Ar Foll"
4 * Author José Bollo <jose.bollo@iot.bzh>
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
10 * http://www.apache.org/licenses/LICENSE-2.0
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
33 #if !defined(NO_CALL_PERSONALITY)
34 #include <sys/personality.h>
37 #include <json-c/json.h>
40 # include <systemd/sd-daemon.h>
44 #include "afb-apiset.h"
45 #include "afb-autoset.h"
46 #include "afb-api-so.h"
47 #if WITH_DBUS_TRANSPARENCY
48 # include "afb-api-dbus.h"
50 #include "afb-api-ws.h"
52 #include "afb-session.h"
54 #include "afb-common.h"
55 #include "afb-export.h"
56 #include "afb-monitor.h"
59 #include "afb-hook-flags.h"
61 #include "afb-debug.h"
63 # include "afb-supervision.h"
65 #if WITH_LIBMICROHTTPD
66 # include "afb-hsrv.h"
67 # include "afb-hreq.h"
68 # include "afb-hswitch.h"
71 #include "process-name.h"
72 #include "wrap-json.h"
74 #include "sig-monitor.h"
77 #if !defined(DEFAULT_BINDER_INTERFACE)
78 # define DEFAULT_BINDER_INTERFACE NULL
82 if SELF_PGROUP == 0 the launched command is the group leader
83 if SELF_PGROUP != 0 afb-daemon is the group leader
87 struct afb_apiset *main_apiset;
88 struct json_object *main_config;
90 static pid_t childpid;
93 * Tiny helper around putenv: add the variable name=value
95 * @param name name of the variable to set
96 * @param value value to set to the variable
98 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
100 static int addenv(const char *name, const char *value)
104 head = malloc(2 + strlen(name) + strlen(value));
109 middle = stpcpy(head, name);
111 strcpy(&middle[1], value);
116 * Tiny helper around addenv that export the real path
118 * @param name name of the variable to set
119 * @param path the path value to export to the variable
121 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
123 static int addenv_realpath(const char *name, const char *path)
125 char buffer[PATH_MAX];
126 char *p = realpath(path, buffer);
127 return p ? addenv(name, p) : -1;
131 * Tiny helper around addenv that export an integer
133 * @param name name of the variable to set
134 * @param value the integer value to export
136 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
138 static int addenv_int(const char *name, int value)
141 snprintf(buffer, sizeof buffer, "%d", value);
142 return addenv(name, buffer);
145 /*----------------------------------------------------------
146 | helpers for handling list of arguments
147 +--------------------------------------------------------- */
149 static const char *run_for_config_array_opt(const char *name,
150 int (*run) (void *closure, const char *value),
154 struct json_object *array, *value;
156 if (json_object_object_get_ex(main_config, name, &array)) {
157 if (!json_object_is_type(array, json_type_array))
158 return json_object_get_string(array);
159 n = (int)json_object_array_length(array);
160 for (i = 0 ; i < n ; i++) {
161 value = json_object_array_get_idx(array, i);
162 rc = run(closure, json_object_get_string(value));
164 return json_object_get_string(value);
170 static int run_start(void *closure, const char *value)
172 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set) = closure;
173 return starter(value, main_apiset, main_apiset) >= 0;
176 static void apiset_start_list(const char *name,
177 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set),
180 const char *item = run_for_config_array_opt(name, run_start, starter);
182 ERROR("can't start %s %s", message, item);
187 /*----------------------------------------------------------
189 | Handles on exit specific actions
190 +--------------------------------------------------------- */
191 static void exit_handler()
193 struct sigaction siga;
195 memset(&siga, 0, sizeof siga);
196 siga.sa_handler = SIG_IGN;
197 sigaction(SIGTERM, &siga, NULL);
201 else if (childpid > 0)
202 killpg(childpid, SIGTERM);
205 static void on_sigterm(int signum, siginfo_t *info, void *uctx)
207 NOTICE("Received SIGTERM");
211 static void on_sighup(int signum, siginfo_t *info, void *uctx)
213 NOTICE("Received SIGHUP");
217 static void setup_daemon()
219 struct sigaction siga;
221 /* install signal handlers */
222 memset(&siga, 0, sizeof siga);
223 siga.sa_flags = SA_SIGINFO;
225 siga.sa_sigaction = on_sigterm;
226 sigaction(SIGTERM, &siga, NULL);
228 siga.sa_sigaction = on_sighup;
229 sigaction(SIGHUP, &siga, NULL);
232 atexit(exit_handler);
234 /* ignore any SIGPIPE */
235 signal(SIGPIPE, SIG_IGN);
238 /*----------------------------------------------------------
240 | set the process in background
241 +--------------------------------------------------------- */
242 static void daemonize()
244 int fd = 0, daemon, nostdin;
250 wrap_json_unpack(main_config, "{s?b s?s}", "daemon", &daemon, "output", &output);
254 fd = open(output, O_WRONLY | O_APPEND | O_CREAT, 0640);
256 ERROR("Can't open output %s", output);
262 INFO("entering background mode");
266 ERROR("Failed to fork daemon process");
275 /* closes the input */
277 NOTICE("Redirecting output to %s", output);
286 close(0); /* except if 'daemon', ctrl+C still works after that */
289 /*---------------------------------------------------------
291 | Handles the HTTP server
292 +--------------------------------------------------------- */
293 #if WITH_LIBMICROHTTPD
294 static int init_alias(void *closure, const char *spec)
296 struct afb_hsrv *hsrv = closure;
297 char *path = strchr(spec, ':');
300 ERROR("Missing ':' in alias %s. Alias ignored", spec);
304 INFO("Alias for url=%s to path=%s", spec, path);
305 return afb_hsrv_add_alias(hsrv, spec, afb_common_rootdir_get_fd(), path,
309 static int init_http_server(struct afb_hsrv *hsrv)
312 const char *rootapi, *roothttp, *rootbase;
315 rc = wrap_json_unpack(main_config, "{ss ss s?s}",
317 "rootbase", &rootbase,
318 "roothttp", &roothttp);
320 ERROR("Can't get HTTP server config");
324 if (!afb_hsrv_add_handler(hsrv, rootapi,
325 afb_hswitch_websocket_switch, main_apiset, 20))
328 if (!afb_hsrv_add_handler(hsrv, rootapi,
329 afb_hswitch_apis, main_apiset, 10))
332 if (run_for_config_array_opt("alias", init_alias, hsrv))
335 if (roothttp != NULL) {
336 if (!afb_hsrv_add_alias(hsrv, "",
337 afb_common_rootdir_get_fd(), roothttp, -10, 1))
341 if (!afb_hsrv_add_handler(hsrv, rootbase,
342 afb_hswitch_one_page_api_redirect, NULL, -20))
348 static struct afb_hsrv *start_http_server()
351 const char *uploaddir, *rootdir;
352 struct afb_hsrv *hsrv;
353 int cache_timeout, http_port;
355 rc = wrap_json_unpack(main_config, "{ss ss si si}",
356 "uploaddir", &uploaddir,
358 "cache-eol", &cache_timeout,
361 ERROR("Can't get HTTP server start config");
365 if (afb_hreq_init_download_path(uploaddir)) {
366 ERROR("unable to set the upload directory %s", uploaddir);
370 hsrv = afb_hsrv_create();
372 ERROR("memory allocation failure");
376 if (!afb_hsrv_set_cache_timeout(hsrv, cache_timeout)
377 || !init_http_server(hsrv)) {
378 ERROR("initialisation of httpd failed");
383 NOTICE("Waiting port=%d rootdir=%s", http_port, rootdir);
384 NOTICE("Browser URL= http://localhost:%d", http_port);
386 rc = afb_hsrv_start(hsrv, 15);
388 ERROR("starting of httpd failed");
393 rc = afb_hsrv_add_interface_tcp(hsrv, DEFAULT_BINDER_INTERFACE, (uint16_t) http_port);
395 ERROR("setting interface failed");
404 /*---------------------------------------------------------
406 +--------------------------------------------------------- */
408 static void wait_child_and_exit()
410 pid_t pidchld = childpid;
414 killpg(pidchld, SIGKILL);
415 waitpid(pidchld, NULL, 0);
419 static void on_sigchld(int signum, siginfo_t *info, void *uctx)
421 if (info->si_pid == childpid) {
422 switch (info->si_code) {
426 jobs_exit(wait_child_and_exit);
439 #define SUBST_CHAR '@'
440 #define SUBST_STR "@"
442 static char *instanciate_string(const char *arg, const char *port, const char *token)
444 char *resu, *it, *wr;
447 /* get the changes */
450 it = strchrnul(arg, SUBST_CHAR);
453 case 'p': chg++; dif += (int)strlen(port) - 2; break;
454 case 't': chg++; dif += (int)strlen(token) - 2; break;
455 case SUBST_CHAR: it++; chg++; dif--; break;
458 it = strchrnul(it, SUBST_CHAR);
461 /* return arg when no change */
465 /* allocates the result */
466 resu = malloc((it - arg) + dif + 1);
468 ERROR("out of memory");
472 /* instanciate the arguments */
475 it = strchrnul(arg, SUBST_CHAR);
476 wr = mempcpy(wr, arg, it - arg);
480 case 'p': wr = stpcpy(wr, port); break;
481 case 't': wr = stpcpy(wr, token); break;
482 default: *wr++ = SUBST_CHAR; /*@fallthrough@*/
483 case SUBST_CHAR: *wr++ = *it;
492 static int instanciate_environ(const char *port, const char *token)
494 extern char **environ;
498 /* instantiate the environment */
499 for (i = 0 ; environ[i] ; i++) {
500 repl = instanciate_string(environ[i], port, token);
508 static char **instanciate_command_args(struct json_object *exec, const char *port, const char *token)
514 /* allocates the result */
515 n = (int)json_object_array_length(exec);
516 result = malloc((n + 1) * sizeof * result);
518 ERROR("out of memory");
522 /* instanciate the arguments */
523 for (i = 0 ; i < n ; i++) {
524 repl = instanciate_string(json_object_get_string(json_object_array_get_idx(exec, i)), port, token);
537 static int execute_command()
539 struct json_object *exec, *oport;
540 struct sigaction siga;
546 /* check whether a command is to execute or not */
547 if (!json_object_object_get_ex(main_config, "exec", &exec))
553 /* install signal handler */
554 memset(&siga, 0, sizeof siga);
555 siga.sa_sigaction = on_sigchld;
556 siga.sa_flags = SA_SIGINFO;
557 sigaction(SIGCHLD, &siga, NULL);
564 /* compute the string for port */
565 if (json_object_object_get_ex(main_config, "port", &oport))
566 rc = snprintf(port, sizeof port, "%s", json_object_get_string(oport));
568 rc = snprintf(port, sizeof port, "%cp", SUBST_CHAR);
569 if (rc < 0 || rc >= (int)(sizeof port)) {
570 ERROR("port->txt failed");
573 /* instantiate arguments and environment */
574 token = afb_session_initial_token();
575 args = instanciate_command_args(exec, port, token);
576 if (args && instanciate_environ(port, token) >= 0) {
580 execv(args[0], args);
581 ERROR("can't launch %s: %m", args[0]);
588 /*---------------------------------------------------------
590 +--------------------------------------------------------- */
594 struct afb_xreq xreq;
597 struct json_object *calls;
600 const char *callspec;
601 struct afb_session *session;
604 static void startup_call_reply(struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
606 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
610 NOTICE("startup call %s returned %s (%s)", sreq->callspec, json_object_get_string(object), info);
611 json_object_put(object);
613 ERROR("startup call %s ERROR! %s (%s)", sreq->callspec, error, info);
618 static void startup_call_current(struct startup_req *sreq);
620 static void startup_call_unref(struct afb_xreq *xreq)
622 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
626 json_object_put(sreq->xreq.json);
627 if (++sreq->index < sreq->count)
628 startup_call_current(sreq);
630 afb_session_close(sreq->session);
631 afb_session_unref(sreq->session);
636 static struct afb_xreq_query_itf startup_xreq_itf =
638 .reply = startup_call_reply,
639 .unref = startup_call_unref
642 static void startup_call_current(struct startup_req *sreq)
644 const char *api, *verb, *json;
645 enum json_tokener_error jerr;
647 sreq->callspec = json_object_get_string(json_object_array_get_idx(sreq->calls, sreq->index)),
648 api = sreq->callspec;
649 verb = strchr(api, '/');
651 json = strchr(verb, ':');
653 afb_xreq_init(&sreq->xreq, &startup_xreq_itf);
654 afb_context_init(&sreq->xreq.context, sreq->session, NULL);
655 sreq->xreq.context.validated = 1;
656 sreq->api = strndup(api, verb - api);
657 sreq->verb = strndup(verb + 1, json - verb - 1);
658 sreq->xreq.request.called_api = sreq->api;
659 sreq->xreq.request.called_verb = sreq->verb;
660 sreq->xreq.json = json_tokener_parse_verbose(json + 1, &jerr);
661 if (sreq->api && sreq->verb && jerr == json_tokener_success) {
662 afb_xreq_process(&sreq->xreq, main_apiset);
667 ERROR("Bad call specification %s", sreq->callspec);
671 static void run_startup_calls()
673 struct json_object *calls;
674 struct startup_req *sreq;
677 if (json_object_object_get_ex(main_config, "call", &calls)
678 && json_object_is_type(calls, json_type_array)
679 && (count = (int)json_object_array_length(calls))) {
680 sreq = calloc(1, sizeof *sreq);
681 sreq->session = afb_session_create(3600);
685 startup_call_current(sreq);
689 /*---------------------------------------------------------
690 | job for starting the daemon
691 +--------------------------------------------------------- */
693 static void start(int signum, void *arg)
696 const char *tracereq = NULL, *traceapi = NULL, *traceevt = NULL,
697 #if !defined(REMOVE_LEGACY_TRACE)
698 *tracesvc = NULL, *traceditf = NULL,
700 *traceses = NULL, *traceglob = NULL;
702 const char *workdir = NULL, *rootdir = NULL, *token = NULL;
703 struct json_object *settings = NULL;
704 int max_session_count, session_timeout, api_timeout;
706 #if WITH_LIBMICROHTTPD
707 const char *rootapi = NULL;
708 int no_httpd = 0, http_port = -1;
709 struct afb_hsrv *hsrv;
713 afb_debug("start-entry");
716 ERROR("start aborted: received signal %s", strsignal(signum));
720 rc = wrap_json_unpack(main_config, "{"
723 #if WITH_LIBMICROHTTPD
727 #if !defined(REMOVE_LEGACY_TRACE)
730 "s?s s?s s?s s?s s?s"
739 "apitimeout", &api_timeout,
740 "cntxtimeout", &session_timeout,
741 "session-max", &max_session_count,
743 #if WITH_LIBMICROHTTPD
744 "no-httpd", &no_httpd,
749 #if !defined(REMOVE_LEGACY_TRACE)
750 "tracesvc", &tracesvc,
751 "traceditf", &traceditf,
753 "tracereq", &tracereq,
754 "traceapi", &traceapi,
755 "traceevt", &traceevt,
756 "traceses", &traceses,
757 "traceglob", &traceglob,
762 ERROR("Unable to get start config");
766 /* initialize session handling */
767 if (afb_session_init(max_session_count, session_timeout, token)) {
768 ERROR("initialisation of session manager failed");
772 /* set the directories */
773 mkdir(workdir, S_IRWXU | S_IRGRP | S_IXGRP);
774 if (chdir(workdir) < 0) {
775 ERROR("Can't enter working dir %s", workdir);
778 if (afb_common_rootdir_set(rootdir) < 0) {
779 ERROR("failed to set common root directory %s", rootdir);
782 if (addenv_realpath("AFB_WORKDIR", "." /* resolved by realpath */)
783 || addenv_realpath("AFB_ROOTDIR", rootdir /* relative to current directory */)) {
784 ERROR("can't set DIR environment");
788 #if WITH_LIBMICROHTTPD
792 ERROR("no port is defined");
795 if (http_port == 0) {
796 ERROR("random port is not implemented");
799 if (addenv_int("AFB_PORT", http_port)
800 || addenv("AFB_TOKEN", afb_session_initial_token())) {
801 ERROR("can't set HTTP environment");
807 /* configure the daemon */
808 afb_export_set_config(settings);
809 main_apiset = afb_apiset_create("main", api_timeout);
811 ERROR("can't create main api set");
814 if (afb_monitor_init(main_apiset, main_apiset) < 0) {
815 ERROR("failed to setup monitor");
819 if (afb_supervision_init(main_apiset, main_config) < 0) {
820 ERROR("failed to setup supervision");
828 afb_hook_create_xreq(NULL, NULL, NULL, afb_hook_flags_xreq_from_text(tracereq), NULL, NULL);
829 #if !defined(REMOVE_LEGACY_TRACE)
830 if (traceapi || tracesvc || traceditf)
831 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi)
832 | afb_hook_flags_legacy_ditf_from_text(traceditf)
833 | afb_hook_flags_legacy_svc_from_text(tracesvc), NULL, NULL);
836 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi), NULL, NULL);
839 afb_hook_create_evt(NULL, afb_hook_flags_evt_from_text(traceevt), NULL, NULL);
841 afb_hook_create_session(NULL, afb_hook_flags_session_from_text(traceses), NULL, NULL);
843 afb_hook_create_global(afb_hook_flags_global_from_text(traceglob), NULL, NULL);
846 /* load bindings and apis */
847 afb_debug("start-load");
848 #if WITH_DYNAMIC_BINDING
849 apiset_start_list("binding", afb_api_so_add_binding, "the binding");
850 apiset_start_list("ldpaths", afb_api_so_add_pathset_fails, "the binding path set");
851 apiset_start_list("weak-ldpaths", afb_api_so_add_pathset_nofails, "the weak binding path set");
853 apiset_start_list("auto-api", afb_autoset_add_any, "the automatic api path set");
854 #if WITH_DBUS_TRANSPARENCY
855 apiset_start_list("dbus-client", afb_api_dbus_add_client, "the afb-dbus client");
857 apiset_start_list("ws-client", afb_api_ws_add_client_weak, "the afb-websocket client");
859 DEBUG("Init config done");
861 /* start the services */
862 afb_debug("start-start");
863 #if !defined(NO_CALL_PERSONALITY)
864 personality((unsigned long)-1L);
866 if (afb_apiset_start_all_services(main_apiset) < 0)
869 /* export started apis */
870 apiset_start_list("ws-server", afb_api_ws_add_server, "the afb-websocket service");
871 #if WITH_DBUS_TRANSPARENCY
872 apiset_start_list("dbus-server", afb_api_dbus_add_server, "the afb-dbus service");
875 /* start the HTTP server */
876 #if WITH_LIBMICROHTTPD
877 afb_debug("start-http");
879 if (!afb_hreq_init_cookie(http_port, rootapi, session_timeout)) {
880 ERROR("initialisation of HTTP cookies failed");
884 hsrv = start_http_server();
890 /* run the startup calls */
891 afb_debug("start-call");
894 /* run the command */
895 afb_debug("start-exec");
896 if (execute_command() < 0)
901 sd_notify(1, "READY=1");
904 /* activate the watchdog */
906 if (watchdog_activate() < 0)
907 ERROR("can't start the watchdog");
915 /*---------------------------------------------------------
917 | Parse option and launch action
918 +--------------------------------------------------------- */
920 int main(int argc, char *argv[])
922 struct json_object *obj;
923 afb_debug("main-entry");
925 // ------------- Build session handler & init config -------
926 main_config = afb_args_parse(argc, argv);
927 if (sig_monitor_init(
928 !json_object_object_get_ex(main_config, "trap-faults", &obj)
929 || json_object_get_boolean(obj)) < 0) {
930 ERROR("failed to initialise signal handlers");
935 if (json_object_object_get_ex(main_config, "name", &obj)) {
936 verbose_set_name(json_object_get_string(obj), 0);
937 process_name_set_name(json_object_get_string(obj));
938 process_name_replace_cmdline(argv, json_object_get_string(obj));
940 afb_debug("main-args");
942 // --------- run -----------
944 INFO("running with pid %d", getpid());
946 /* set the daemon environment */
949 afb_debug("main-start");
951 /* enter job processing */
952 jobs_start(3, 0, 50, start, NULL);
953 WARNING("hoops returned from jobs_enter! [report bug]");