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>
39 #include <systemd/sd-daemon.h>
42 #include "afb-hswitch.h"
43 #include "afb-apiset.h"
44 #include "afb-autoset.h"
45 #include "afb-api-so.h"
46 #if WITH_DBUS_TRANSPARENCY
47 # include "afb-api-dbus.h"
49 #include "afb-api-ws.h"
53 #include "afb-session.h"
55 #include "afb-common.h"
56 #include "afb-export.h"
57 #include "afb-monitor.h"
60 #include "afb-hook-flags.h"
62 #include "afb-debug.h"
64 # include "afb-supervision.h"
67 #include "process-name.h"
68 #include "wrap-json.h"
70 #include "sig-monitor.h"
73 #if !defined(DEFAULT_BINDER_INTERFACE)
74 # define DEFAULT_BINDER_INTERFACE NULL
78 if SELF_PGROUP == 0 the launched command is the group leader
79 if SELF_PGROUP != 0 afb-daemon is the group leader
83 struct afb_apiset *main_apiset;
84 struct json_object *main_config;
86 static pid_t childpid;
89 * Tiny helper around putenv: add the variable name=value
91 * @param name name of the variable to set
92 * @param value value to set to the variable
94 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
96 static int addenv(const char *name, const char *value)
100 head = malloc(2 + strlen(name) + strlen(value));
105 middle = stpcpy(head, name);
107 strcpy(&middle[1], value);
112 * Tiny helper around addenv that export the real path
114 * @param name name of the variable to set
115 * @param path the path value to export to the variable
117 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
119 static int addenv_realpath(const char *name, const char *path)
121 char buffer[PATH_MAX];
122 char *p = realpath(path, buffer);
123 return p ? addenv(name, p) : -1;
127 * Tiny helper around addenv that export an integer
129 * @param name name of the variable to set
130 * @param value the integer value to export
132 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
134 static int addenv_int(const char *name, int value)
137 snprintf(buffer, sizeof buffer, "%d", value);
138 return addenv(name, buffer);
141 /*----------------------------------------------------------
142 | helpers for handling list of arguments
143 +--------------------------------------------------------- */
145 static const char *run_for_config_array_opt(const char *name,
146 int (*run) (void *closure, const char *value),
150 struct json_object *array, *value;
152 if (json_object_object_get_ex(main_config, name, &array)) {
153 if (!json_object_is_type(array, json_type_array))
154 return json_object_get_string(array);
155 n = (int)json_object_array_length(array);
156 for (i = 0 ; i < n ; i++) {
157 value = json_object_array_get_idx(array, i);
158 rc = run(closure, json_object_get_string(value));
160 return json_object_get_string(value);
166 static int run_start(void *closure, const char *value)
168 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set) = closure;
169 return starter(value, main_apiset, main_apiset) >= 0;
172 static void apiset_start_list(const char *name,
173 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set),
176 const char *item = run_for_config_array_opt(name, run_start, starter);
178 ERROR("can't start %s %s", message, item);
183 /*----------------------------------------------------------
185 | Handles on exit specific actions
186 +--------------------------------------------------------- */
187 static void exit_handler()
189 struct sigaction siga;
191 memset(&siga, 0, sizeof siga);
192 siga.sa_handler = SIG_IGN;
193 sigaction(SIGTERM, &siga, NULL);
197 else if (childpid > 0)
198 killpg(childpid, SIGTERM);
201 static void on_sigterm(int signum, siginfo_t *info, void *uctx)
203 NOTICE("Received SIGTERM");
207 static void on_sighup(int signum, siginfo_t *info, void *uctx)
209 NOTICE("Received SIGHUP");
213 static void setup_daemon()
215 struct sigaction siga;
217 /* install signal handlers */
218 memset(&siga, 0, sizeof siga);
219 siga.sa_flags = SA_SIGINFO;
221 siga.sa_sigaction = on_sigterm;
222 sigaction(SIGTERM, &siga, NULL);
224 siga.sa_sigaction = on_sighup;
225 sigaction(SIGHUP, &siga, NULL);
228 atexit(exit_handler);
230 /* ignore any SIGPIPE */
231 signal(SIGPIPE, SIG_IGN);
234 /*----------------------------------------------------------
236 | set the process in background
237 +--------------------------------------------------------- */
238 static void daemonize()
240 int fd = 0, daemon, nostdin;
246 wrap_json_unpack(main_config, "{s?b s?s}", "daemon", &daemon, "output", &output);
250 fd = open(output, O_WRONLY | O_APPEND | O_CREAT, 0640);
252 ERROR("Can't open output %s", output);
258 INFO("entering background mode");
262 ERROR("Failed to fork daemon process");
271 /* closes the input */
273 NOTICE("Redirecting output to %s", output);
282 close(0); /* except if 'daemon', ctrl+C still works after that */
285 /*---------------------------------------------------------
287 | Handles the HTTP server
288 +--------------------------------------------------------- */
289 static int init_alias(void *closure, const char *spec)
291 struct afb_hsrv *hsrv = closure;
292 char *path = strchr(spec, ':');
295 ERROR("Missing ':' in alias %s. Alias ignored", spec);
299 INFO("Alias for url=%s to path=%s", spec, path);
300 return afb_hsrv_add_alias(hsrv, spec, afb_common_rootdir_get_fd(), path,
304 static int init_http_server(struct afb_hsrv *hsrv)
307 const char *rootapi, *roothttp, *rootbase;
310 rc = wrap_json_unpack(main_config, "{ss ss s?s}",
312 "rootbase", &rootbase,
313 "roothttp", &roothttp);
315 ERROR("Can't get HTTP server config");
319 if (!afb_hsrv_add_handler(hsrv, rootapi,
320 afb_hswitch_websocket_switch, main_apiset, 20))
323 if (!afb_hsrv_add_handler(hsrv, rootapi,
324 afb_hswitch_apis, main_apiset, 10))
327 if (run_for_config_array_opt("alias", init_alias, hsrv))
330 if (roothttp != NULL) {
331 if (!afb_hsrv_add_alias(hsrv, "",
332 afb_common_rootdir_get_fd(), roothttp, -10, 1))
336 if (!afb_hsrv_add_handler(hsrv, rootbase,
337 afb_hswitch_one_page_api_redirect, NULL, -20))
343 static struct afb_hsrv *start_http_server()
346 const char *uploaddir, *rootdir;
347 struct afb_hsrv *hsrv;
348 int cache_timeout, http_port;
350 rc = wrap_json_unpack(main_config, "{ss ss si si}",
351 "uploaddir", &uploaddir,
353 "cache-eol", &cache_timeout,
356 ERROR("Can't get HTTP server start config");
360 if (afb_hreq_init_download_path(uploaddir)) {
361 static const char fallback_uploaddir[] = "/tmp";
362 WARNING("unable to set the upload directory %s", uploaddir);
363 if (afb_hreq_init_download_path(fallback_uploaddir)) {
364 ERROR("unable to fallback to upload directory %s", fallback_uploaddir);
369 hsrv = afb_hsrv_create();
371 ERROR("memory allocation failure");
375 if (!afb_hsrv_set_cache_timeout(hsrv, cache_timeout)
376 || !init_http_server(hsrv)) {
377 ERROR("initialisation of httpd failed");
382 NOTICE("Waiting port=%d rootdir=%s", http_port, rootdir);
383 NOTICE("Browser URL= http://localhost:%d", http_port);
385 rc = afb_hsrv_start(hsrv, 15);
387 ERROR("starting of httpd failed");
392 rc = afb_hsrv_add_interface_tcp(hsrv, DEFAULT_BINDER_INTERFACE, (uint16_t) http_port);
394 ERROR("setting interface failed");
402 /*---------------------------------------------------------
404 +--------------------------------------------------------- */
406 static void wait_child_and_exit()
408 pid_t pidchld = childpid;
412 killpg(pidchld, SIGKILL);
413 waitpid(pidchld, NULL, 0);
417 static void on_sigchld(int signum, siginfo_t *info, void *uctx)
419 if (info->si_pid == childpid) {
420 switch (info->si_code) {
424 jobs_exit(wait_child_and_exit);
437 #define SUBST_CHAR '@'
438 #define SUBST_STR "@"
440 static char *instanciate_string(const char *arg, const char *port, const char *token)
442 char *resu, *it, *wr;
445 /* get the changes */
448 it = strchrnul(arg, SUBST_CHAR);
451 case 'p': chg++; dif += (int)strlen(port) - 2; break;
452 case 't': chg++; dif += (int)strlen(token) - 2; break;
453 case SUBST_CHAR: it++; chg++; dif--; break;
456 it = strchrnul(it, SUBST_CHAR);
459 /* return arg when no change */
463 /* allocates the result */
464 resu = malloc((it - arg) + dif + 1);
466 ERROR("out of memory");
470 /* instanciate the arguments */
473 it = strchrnul(arg, SUBST_CHAR);
474 wr = mempcpy(wr, arg, it - arg);
478 case 'p': wr = stpcpy(wr, port); break;
479 case 't': wr = stpcpy(wr, token); break;
480 default: *wr++ = SUBST_CHAR; /*@fallthrough@*/
481 case SUBST_CHAR: *wr++ = *it;
490 static int instanciate_environ(const char *port, const char *token)
492 extern char **environ;
496 /* instantiate the environment */
497 for (i = 0 ; environ[i] ; i++) {
498 repl = instanciate_string(environ[i], port, token);
506 static char **instanciate_command_args(struct json_object *exec, const char *port, const char *token)
512 /* allocates the result */
513 n = (int)json_object_array_length(exec);
514 result = malloc((n + 1) * sizeof * result);
516 ERROR("out of memory");
520 /* instanciate the arguments */
521 for (i = 0 ; i < n ; i++) {
522 repl = instanciate_string(json_object_get_string(json_object_array_get_idx(exec, i)), port, token);
535 static int execute_command()
537 struct json_object *exec, *oport;
538 struct sigaction siga;
544 /* check whether a command is to execute or not */
545 if (!json_object_object_get_ex(main_config, "exec", &exec))
551 /* install signal handler */
552 memset(&siga, 0, sizeof siga);
553 siga.sa_sigaction = on_sigchld;
554 siga.sa_flags = SA_SIGINFO;
555 sigaction(SIGCHLD, &siga, NULL);
562 /* compute the string for port */
563 if (json_object_object_get_ex(main_config, "port", &oport))
564 rc = snprintf(port, sizeof port, "%s", json_object_get_string(oport));
566 rc = snprintf(port, sizeof port, "%cp", SUBST_CHAR);
567 if (rc < 0 || rc >= (int)(sizeof port)) {
568 ERROR("port->txt failed");
571 /* instantiate arguments and environment */
572 token = afb_session_initial_token();
573 args = instanciate_command_args(exec, port, token);
574 if (args && instanciate_environ(port, token) >= 0) {
578 execv(args[0], args);
579 ERROR("can't launch %s: %m", args[0]);
586 /*---------------------------------------------------------
588 +--------------------------------------------------------- */
592 struct afb_xreq xreq;
595 struct json_object *calls;
598 const char *callspec;
599 struct afb_session *session;
602 static void startup_call_reply(struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
604 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
608 NOTICE("startup call %s returned %s (%s)", sreq->callspec, json_object_get_string(object), info);
609 json_object_put(object);
611 ERROR("startup call %s ERROR! %s (%s)", sreq->callspec, error, info);
616 static void startup_call_current(struct startup_req *sreq);
618 static void startup_call_unref(struct afb_xreq *xreq)
620 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
624 json_object_put(sreq->xreq.json);
625 if (++sreq->index < sreq->count)
626 startup_call_current(sreq);
628 afb_session_close(sreq->session);
629 afb_session_unref(sreq->session);
634 static struct afb_xreq_query_itf startup_xreq_itf =
636 .reply = startup_call_reply,
637 .unref = startup_call_unref
640 static void startup_call_current(struct startup_req *sreq)
642 const char *api, *verb, *json;
643 enum json_tokener_error jerr;
645 sreq->callspec = json_object_get_string(json_object_array_get_idx(sreq->calls, sreq->index)),
646 api = sreq->callspec;
647 verb = strchr(api, '/');
649 json = strchr(verb, ':');
651 afb_xreq_init(&sreq->xreq, &startup_xreq_itf);
652 afb_context_init(&sreq->xreq.context, sreq->session, NULL);
653 sreq->xreq.context.validated = 1;
654 sreq->api = strndup(api, verb - api);
655 sreq->verb = strndup(verb + 1, json - verb - 1);
656 sreq->xreq.request.called_api = sreq->api;
657 sreq->xreq.request.called_verb = sreq->verb;
658 sreq->xreq.json = json_tokener_parse_verbose(json + 1, &jerr);
659 if (sreq->api && sreq->verb && jerr == json_tokener_success) {
660 afb_xreq_process(&sreq->xreq, main_apiset);
665 ERROR("Bad call specification %s", sreq->callspec);
669 static void run_startup_calls()
671 struct json_object *calls;
672 struct startup_req *sreq;
675 if (json_object_object_get_ex(main_config, "call", &calls)
676 && json_object_is_type(calls, json_type_array)
677 && (count = (int)json_object_array_length(calls))) {
678 sreq = calloc(1, sizeof *sreq);
679 sreq->session = afb_session_create(3600);
683 startup_call_current(sreq);
687 /*---------------------------------------------------------
688 | job for starting the daemon
689 +--------------------------------------------------------- */
691 static void start(int signum, void *arg)
694 const char *tracereq = NULL, *traceapi = NULL, *traceevt = NULL,
695 #if !defined(REMOVE_LEGACY_TRACE)
696 *tracesvc = NULL, *traceditf = NULL,
698 *traceses = NULL, *traceglob = NULL;
700 const char *workdir, *rootdir, *token, *rootapi;
701 struct json_object *settings;
702 struct afb_hsrv *hsrv;
703 int max_session_count, session_timeout, api_timeout;
704 int no_httpd, http_port;
708 afb_debug("start-entry");
711 ERROR("start aborted: received signal %s", strsignal(signum));
718 rootapi = token = NULL;
719 rc = wrap_json_unpack(main_config, "{"
724 #if !defined(REMOVE_LEGACY_TRACE)
727 "s?s s?s s?s s?s s?s"
736 "apitimeout", &api_timeout,
737 "cntxtimeout", &session_timeout,
738 "session-max", &max_session_count,
740 "no-httpd", &no_httpd,
745 #if !defined(REMOVE_LEGACY_TRACE)
746 "tracesvc", &tracesvc,
747 "traceditf", &traceditf,
749 "tracereq", &tracereq,
750 "traceapi", &traceapi,
751 "traceevt", &traceevt,
752 "traceses", &traceses,
753 "traceglob", &traceglob,
758 ERROR("Unable to get start config");
762 /* initialize session handling */
763 if (afb_session_init(max_session_count, session_timeout, token)) {
764 ERROR("initialisation of session manager failed");
768 /* set the directories */
769 mkdir(workdir, S_IRWXU | S_IRGRP | S_IXGRP);
770 if (chdir(workdir) < 0) {
771 ERROR("Can't enter working dir %s", workdir);
774 if (afb_common_rootdir_set(rootdir) < 0) {
775 ERROR("failed to set common root directory %s", rootdir);
778 if (addenv_realpath("AFB_WORKDIR", "." /* resolved by realpath */)
779 || addenv_realpath("AFB_ROOTDIR", rootdir /* relative to current directory */)) {
780 ERROR("can't set DIR environment");
787 ERROR("no port is defined");
790 if (http_port == 0) {
791 ERROR("random port is not implemented");
794 if (addenv_int("AFB_PORT", http_port)
795 || addenv("AFB_TOKEN", afb_session_initial_token())) {
796 ERROR("can't set HTTP environment");
801 /* configure the daemon */
802 afb_export_set_config(settings);
803 main_apiset = afb_apiset_create("main", api_timeout);
805 ERROR("can't create main api set");
808 if (afb_monitor_init(main_apiset, main_apiset) < 0) {
809 ERROR("failed to setup monitor");
813 if (afb_supervision_init(main_apiset, main_config) < 0) {
814 ERROR("failed to setup supervision");
822 afb_hook_create_xreq(NULL, NULL, NULL, afb_hook_flags_xreq_from_text(tracereq), NULL, NULL);
823 #if !defined(REMOVE_LEGACY_TRACE)
824 if (traceapi || tracesvc || traceditf)
825 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi)
826 | afb_hook_flags_legacy_ditf_from_text(traceditf)
827 | afb_hook_flags_legacy_svc_from_text(tracesvc), NULL, NULL);
830 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi), NULL, NULL);
833 afb_hook_create_evt(NULL, afb_hook_flags_evt_from_text(traceevt), NULL, NULL);
835 afb_hook_create_session(NULL, afb_hook_flags_session_from_text(traceses), NULL, NULL);
837 afb_hook_create_global(afb_hook_flags_global_from_text(traceglob), NULL, NULL);
840 /* load bindings and apis */
841 afb_debug("start-load");
842 #if WITH_DYNAMIC_BINDING
843 apiset_start_list("binding", afb_api_so_add_binding, "the binding");
844 apiset_start_list("ldpaths", afb_api_so_add_pathset_fails, "the binding path set");
845 apiset_start_list("weak-ldpaths", afb_api_so_add_pathset_nofails, "the weak binding path set");
847 apiset_start_list("auto-api", afb_autoset_add_any, "the automatic api path set");
848 #if WITH_DBUS_TRANSPARENCY
849 apiset_start_list("dbus-client", afb_api_dbus_add_client, "the afb-dbus client");
851 apiset_start_list("ws-client", afb_api_ws_add_client_weak, "the afb-websocket client");
853 DEBUG("Init config done");
855 /* start the services */
856 afb_debug("start-start");
857 #if !defined(NO_CALL_PERSONALITY)
858 personality((unsigned long)-1L);
860 if (afb_apiset_start_all_services(main_apiset) < 0)
863 /* export started apis */
864 apiset_start_list("ws-server", afb_api_ws_add_server, "the afb-websocket service");
865 #if WITH_DBUS_TRANSPARENCY
866 apiset_start_list("dbus-server", afb_api_dbus_add_server, "the afb-dbus service");
869 /* start the HTTP server */
870 afb_debug("start-http");
872 if (!afb_hreq_init_cookie(http_port, rootapi, session_timeout)) {
873 ERROR("initialisation of HTTP cookies failed");
877 hsrv = start_http_server();
882 /* run the startup calls */
883 afb_debug("start-call");
886 /* run the command */
887 afb_debug("start-exec");
888 if (execute_command() < 0)
892 sd_notify(1, "READY=1");
894 /* activate the watchdog */
896 if (watchdog_activate() < 0)
897 ERROR("can't start the watchdog");
905 /*---------------------------------------------------------
907 | Parse option and launch action
908 +--------------------------------------------------------- */
910 int main(int argc, char *argv[])
912 struct json_object *obj;
913 afb_debug("main-entry");
915 // ------------- Build session handler & init config -------
916 main_config = afb_args_parse(argc, argv);
917 if (sig_monitor_init(
918 !json_object_object_get_ex(main_config, "trap-faults", &obj)
919 || json_object_get_boolean(obj)) < 0) {
920 ERROR("failed to initialise signal handlers");
925 if (json_object_object_get_ex(main_config, "name", &obj)) {
926 verbose_set_name(json_object_get_string(obj), 0);
927 process_name_set_name(json_object_get_string(obj));
928 process_name_replace_cmdline(argv, json_object_get_string(obj));
930 afb_debug("main-args");
932 // --------- run -----------
934 INFO("running with pid %d", getpid());
936 /* set the daemon environment */
939 afb_debug("main-start");
941 /* enter job processing */
942 jobs_start(3, 0, 50, start, NULL);
943 WARNING("hoops returned from jobs_enter! [report bug]");