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-hswitch.h"
45 #include "afb-apiset.h"
46 #include "afb-autoset.h"
47 #include "afb-api-so.h"
48 #if WITH_DBUS_TRANSPARENCY
49 # include "afb-api-dbus.h"
51 #include "afb-api-ws.h"
55 #include "afb-session.h"
57 #include "afb-common.h"
58 #include "afb-export.h"
59 #include "afb-monitor.h"
62 #include "afb-hook-flags.h"
64 #include "afb-debug.h"
66 # include "afb-supervision.h"
69 #include "process-name.h"
70 #include "wrap-json.h"
72 #include "sig-monitor.h"
75 #if !defined(DEFAULT_BINDER_INTERFACE)
76 # define DEFAULT_BINDER_INTERFACE NULL
80 if SELF_PGROUP == 0 the launched command is the group leader
81 if SELF_PGROUP != 0 afb-daemon is the group leader
85 struct afb_apiset *main_apiset;
86 struct json_object *main_config;
88 static pid_t childpid;
91 * Tiny helper around putenv: add the variable name=value
93 * @param name name of the variable to set
94 * @param value value to set to the variable
96 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
98 static int addenv(const char *name, const char *value)
102 head = malloc(2 + strlen(name) + strlen(value));
107 middle = stpcpy(head, name);
109 strcpy(&middle[1], value);
114 * Tiny helper around addenv that export the real path
116 * @param name name of the variable to set
117 * @param path the path value to export to the variable
119 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
121 static int addenv_realpath(const char *name, const char *path)
123 char buffer[PATH_MAX];
124 char *p = realpath(path, buffer);
125 return p ? addenv(name, p) : -1;
129 * Tiny helper around addenv that export an integer
131 * @param name name of the variable to set
132 * @param value the integer value to export
134 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
136 static int addenv_int(const char *name, int value)
139 snprintf(buffer, sizeof buffer, "%d", value);
140 return addenv(name, buffer);
143 /*----------------------------------------------------------
144 | helpers for handling list of arguments
145 +--------------------------------------------------------- */
147 static const char *run_for_config_array_opt(const char *name,
148 int (*run) (void *closure, const char *value),
152 struct json_object *array, *value;
154 if (json_object_object_get_ex(main_config, name, &array)) {
155 if (!json_object_is_type(array, json_type_array))
156 return json_object_get_string(array);
157 n = (int)json_object_array_length(array);
158 for (i = 0 ; i < n ; i++) {
159 value = json_object_array_get_idx(array, i);
160 rc = run(closure, json_object_get_string(value));
162 return json_object_get_string(value);
168 static int run_start(void *closure, const char *value)
170 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set) = closure;
171 return starter(value, main_apiset, main_apiset) >= 0;
174 static void apiset_start_list(const char *name,
175 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set),
178 const char *item = run_for_config_array_opt(name, run_start, starter);
180 ERROR("can't start %s %s", message, item);
185 /*----------------------------------------------------------
187 | Handles on exit specific actions
188 +--------------------------------------------------------- */
189 static void exit_handler()
191 struct sigaction siga;
193 memset(&siga, 0, sizeof siga);
194 siga.sa_handler = SIG_IGN;
195 sigaction(SIGTERM, &siga, NULL);
199 else if (childpid > 0)
200 killpg(childpid, SIGTERM);
203 static void on_sigterm(int signum, siginfo_t *info, void *uctx)
205 NOTICE("Received SIGTERM");
209 static void on_sighup(int signum, siginfo_t *info, void *uctx)
211 NOTICE("Received SIGHUP");
215 static void setup_daemon()
217 struct sigaction siga;
219 /* install signal handlers */
220 memset(&siga, 0, sizeof siga);
221 siga.sa_flags = SA_SIGINFO;
223 siga.sa_sigaction = on_sigterm;
224 sigaction(SIGTERM, &siga, NULL);
226 siga.sa_sigaction = on_sighup;
227 sigaction(SIGHUP, &siga, NULL);
230 atexit(exit_handler);
232 /* ignore any SIGPIPE */
233 signal(SIGPIPE, SIG_IGN);
236 /*----------------------------------------------------------
238 | set the process in background
239 +--------------------------------------------------------- */
240 static void daemonize()
242 int fd = 0, daemon, nostdin;
248 wrap_json_unpack(main_config, "{s?b s?s}", "daemon", &daemon, "output", &output);
252 fd = open(output, O_WRONLY | O_APPEND | O_CREAT, 0640);
254 ERROR("Can't open output %s", output);
260 INFO("entering background mode");
264 ERROR("Failed to fork daemon process");
273 /* closes the input */
275 NOTICE("Redirecting output to %s", output);
284 close(0); /* except if 'daemon', ctrl+C still works after that */
287 /*---------------------------------------------------------
289 | Handles the HTTP server
290 +--------------------------------------------------------- */
291 static int init_alias(void *closure, const char *spec)
293 struct afb_hsrv *hsrv = closure;
294 char *path = strchr(spec, ':');
297 ERROR("Missing ':' in alias %s. Alias ignored", spec);
301 INFO("Alias for url=%s to path=%s", spec, path);
302 return afb_hsrv_add_alias(hsrv, spec, afb_common_rootdir_get_fd(), path,
306 static int init_http_server(struct afb_hsrv *hsrv)
309 const char *rootapi, *roothttp, *rootbase;
312 rc = wrap_json_unpack(main_config, "{ss ss s?s}",
314 "rootbase", &rootbase,
315 "roothttp", &roothttp);
317 ERROR("Can't get HTTP server config");
321 if (!afb_hsrv_add_handler(hsrv, rootapi,
322 afb_hswitch_websocket_switch, main_apiset, 20))
325 if (!afb_hsrv_add_handler(hsrv, rootapi,
326 afb_hswitch_apis, main_apiset, 10))
329 if (run_for_config_array_opt("alias", init_alias, hsrv))
332 if (roothttp != NULL) {
333 if (!afb_hsrv_add_alias(hsrv, "",
334 afb_common_rootdir_get_fd(), roothttp, -10, 1))
338 if (!afb_hsrv_add_handler(hsrv, rootbase,
339 afb_hswitch_one_page_api_redirect, NULL, -20))
345 static struct afb_hsrv *start_http_server()
348 const char *uploaddir, *rootdir;
349 struct afb_hsrv *hsrv;
350 int cache_timeout, http_port;
352 rc = wrap_json_unpack(main_config, "{ss ss si si}",
353 "uploaddir", &uploaddir,
355 "cache-eol", &cache_timeout,
358 ERROR("Can't get HTTP server start config");
362 if (afb_hreq_init_download_path(uploaddir)) {
363 ERROR("unable to set the upload directory %s", uploaddir);
367 hsrv = afb_hsrv_create();
369 ERROR("memory allocation failure");
373 if (!afb_hsrv_set_cache_timeout(hsrv, cache_timeout)
374 || !init_http_server(hsrv)) {
375 ERROR("initialisation of httpd failed");
380 NOTICE("Waiting port=%d rootdir=%s", http_port, rootdir);
381 NOTICE("Browser URL= http://localhost:%d", http_port);
383 rc = afb_hsrv_start(hsrv, 15);
385 ERROR("starting of httpd failed");
390 rc = afb_hsrv_add_interface_tcp(hsrv, DEFAULT_BINDER_INTERFACE, (uint16_t) http_port);
392 ERROR("setting interface failed");
400 /*---------------------------------------------------------
402 +--------------------------------------------------------- */
404 static void wait_child_and_exit()
406 pid_t pidchld = childpid;
410 killpg(pidchld, SIGKILL);
411 waitpid(pidchld, NULL, 0);
415 static void on_sigchld(int signum, siginfo_t *info, void *uctx)
417 if (info->si_pid == childpid) {
418 switch (info->si_code) {
422 jobs_exit(wait_child_and_exit);
435 #define SUBST_CHAR '@'
436 #define SUBST_STR "@"
438 static char *instanciate_string(const char *arg, const char *port, const char *token)
440 char *resu, *it, *wr;
443 /* get the changes */
446 it = strchrnul(arg, SUBST_CHAR);
449 case 'p': chg++; dif += (int)strlen(port) - 2; break;
450 case 't': chg++; dif += (int)strlen(token) - 2; break;
451 case SUBST_CHAR: it++; chg++; dif--; break;
454 it = strchrnul(it, SUBST_CHAR);
457 /* return arg when no change */
461 /* allocates the result */
462 resu = malloc((it - arg) + dif + 1);
464 ERROR("out of memory");
468 /* instanciate the arguments */
471 it = strchrnul(arg, SUBST_CHAR);
472 wr = mempcpy(wr, arg, it - arg);
476 case 'p': wr = stpcpy(wr, port); break;
477 case 't': wr = stpcpy(wr, token); break;
478 default: *wr++ = SUBST_CHAR; /*@fallthrough@*/
479 case SUBST_CHAR: *wr++ = *it;
488 static int instanciate_environ(const char *port, const char *token)
490 extern char **environ;
494 /* instantiate the environment */
495 for (i = 0 ; environ[i] ; i++) {
496 repl = instanciate_string(environ[i], port, token);
504 static char **instanciate_command_args(struct json_object *exec, const char *port, const char *token)
510 /* allocates the result */
511 n = (int)json_object_array_length(exec);
512 result = malloc((n + 1) * sizeof * result);
514 ERROR("out of memory");
518 /* instanciate the arguments */
519 for (i = 0 ; i < n ; i++) {
520 repl = instanciate_string(json_object_get_string(json_object_array_get_idx(exec, i)), port, token);
533 static int execute_command()
535 struct json_object *exec, *oport;
536 struct sigaction siga;
542 /* check whether a command is to execute or not */
543 if (!json_object_object_get_ex(main_config, "exec", &exec))
549 /* install signal handler */
550 memset(&siga, 0, sizeof siga);
551 siga.sa_sigaction = on_sigchld;
552 siga.sa_flags = SA_SIGINFO;
553 sigaction(SIGCHLD, &siga, NULL);
560 /* compute the string for port */
561 if (json_object_object_get_ex(main_config, "port", &oport))
562 rc = snprintf(port, sizeof port, "%s", json_object_get_string(oport));
564 rc = snprintf(port, sizeof port, "%cp", SUBST_CHAR);
565 if (rc < 0 || rc >= (int)(sizeof port)) {
566 ERROR("port->txt failed");
569 /* instantiate arguments and environment */
570 token = afb_session_initial_token();
571 args = instanciate_command_args(exec, port, token);
572 if (args && instanciate_environ(port, token) >= 0) {
576 execv(args[0], args);
577 ERROR("can't launch %s: %m", args[0]);
584 /*---------------------------------------------------------
586 +--------------------------------------------------------- */
590 struct afb_xreq xreq;
593 struct json_object *calls;
596 const char *callspec;
597 struct afb_session *session;
600 static void startup_call_reply(struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
602 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
606 NOTICE("startup call %s returned %s (%s)", sreq->callspec, json_object_get_string(object), info);
607 json_object_put(object);
609 ERROR("startup call %s ERROR! %s (%s)", sreq->callspec, error, info);
614 static void startup_call_current(struct startup_req *sreq);
616 static void startup_call_unref(struct afb_xreq *xreq)
618 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
622 json_object_put(sreq->xreq.json);
623 if (++sreq->index < sreq->count)
624 startup_call_current(sreq);
626 afb_session_close(sreq->session);
627 afb_session_unref(sreq->session);
632 static struct afb_xreq_query_itf startup_xreq_itf =
634 .reply = startup_call_reply,
635 .unref = startup_call_unref
638 static void startup_call_current(struct startup_req *sreq)
640 const char *api, *verb, *json;
641 enum json_tokener_error jerr;
643 sreq->callspec = json_object_get_string(json_object_array_get_idx(sreq->calls, sreq->index)),
644 api = sreq->callspec;
645 verb = strchr(api, '/');
647 json = strchr(verb, ':');
649 afb_xreq_init(&sreq->xreq, &startup_xreq_itf);
650 afb_context_init(&sreq->xreq.context, sreq->session, NULL);
651 sreq->xreq.context.validated = 1;
652 sreq->api = strndup(api, verb - api);
653 sreq->verb = strndup(verb + 1, json - verb - 1);
654 sreq->xreq.request.called_api = sreq->api;
655 sreq->xreq.request.called_verb = sreq->verb;
656 sreq->xreq.json = json_tokener_parse_verbose(json + 1, &jerr);
657 if (sreq->api && sreq->verb && jerr == json_tokener_success) {
658 afb_xreq_process(&sreq->xreq, main_apiset);
663 ERROR("Bad call specification %s", sreq->callspec);
667 static void run_startup_calls()
669 struct json_object *calls;
670 struct startup_req *sreq;
673 if (json_object_object_get_ex(main_config, "call", &calls)
674 && json_object_is_type(calls, json_type_array)
675 && (count = (int)json_object_array_length(calls))) {
676 sreq = calloc(1, sizeof *sreq);
677 sreq->session = afb_session_create(3600);
681 startup_call_current(sreq);
685 /*---------------------------------------------------------
686 | job for starting the daemon
687 +--------------------------------------------------------- */
689 static void start(int signum, void *arg)
692 const char *tracereq = NULL, *traceapi = NULL, *traceevt = NULL,
693 #if !defined(REMOVE_LEGACY_TRACE)
694 *tracesvc = NULL, *traceditf = NULL,
696 *traceses = NULL, *traceglob = NULL;
698 const char *workdir, *rootdir, *token, *rootapi;
699 struct json_object *settings;
700 struct afb_hsrv *hsrv;
701 int max_session_count, session_timeout, api_timeout;
702 int no_httpd, http_port;
706 afb_debug("start-entry");
709 ERROR("start aborted: received signal %s", strsignal(signum));
716 rootapi = token = NULL;
717 rc = wrap_json_unpack(main_config, "{"
722 #if !defined(REMOVE_LEGACY_TRACE)
725 "s?s s?s s?s s?s s?s"
734 "apitimeout", &api_timeout,
735 "cntxtimeout", &session_timeout,
736 "session-max", &max_session_count,
738 "no-httpd", &no_httpd,
743 #if !defined(REMOVE_LEGACY_TRACE)
744 "tracesvc", &tracesvc,
745 "traceditf", &traceditf,
747 "tracereq", &tracereq,
748 "traceapi", &traceapi,
749 "traceevt", &traceevt,
750 "traceses", &traceses,
751 "traceglob", &traceglob,
756 ERROR("Unable to get start config");
760 /* initialize session handling */
761 if (afb_session_init(max_session_count, session_timeout, token)) {
762 ERROR("initialisation of session manager failed");
766 /* set the directories */
767 mkdir(workdir, S_IRWXU | S_IRGRP | S_IXGRP);
768 if (chdir(workdir) < 0) {
769 ERROR("Can't enter working dir %s", workdir);
772 if (afb_common_rootdir_set(rootdir) < 0) {
773 ERROR("failed to set common root directory %s", rootdir);
776 if (addenv_realpath("AFB_WORKDIR", "." /* resolved by realpath */)
777 || addenv_realpath("AFB_ROOTDIR", rootdir /* relative to current directory */)) {
778 ERROR("can't set DIR environment");
785 ERROR("no port is defined");
788 if (http_port == 0) {
789 ERROR("random port is not implemented");
792 if (addenv_int("AFB_PORT", http_port)
793 || addenv("AFB_TOKEN", afb_session_initial_token())) {
794 ERROR("can't set HTTP environment");
799 /* configure the daemon */
800 afb_export_set_config(settings);
801 main_apiset = afb_apiset_create("main", api_timeout);
803 ERROR("can't create main api set");
806 if (afb_monitor_init(main_apiset, main_apiset) < 0) {
807 ERROR("failed to setup monitor");
811 if (afb_supervision_init(main_apiset, main_config) < 0) {
812 ERROR("failed to setup supervision");
820 afb_hook_create_xreq(NULL, NULL, NULL, afb_hook_flags_xreq_from_text(tracereq), NULL, NULL);
821 #if !defined(REMOVE_LEGACY_TRACE)
822 if (traceapi || tracesvc || traceditf)
823 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi)
824 | afb_hook_flags_legacy_ditf_from_text(traceditf)
825 | afb_hook_flags_legacy_svc_from_text(tracesvc), NULL, NULL);
828 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi), NULL, NULL);
831 afb_hook_create_evt(NULL, afb_hook_flags_evt_from_text(traceevt), NULL, NULL);
833 afb_hook_create_session(NULL, afb_hook_flags_session_from_text(traceses), NULL, NULL);
835 afb_hook_create_global(afb_hook_flags_global_from_text(traceglob), NULL, NULL);
838 /* load bindings and apis */
839 afb_debug("start-load");
840 #if WITH_DYNAMIC_BINDING
841 apiset_start_list("binding", afb_api_so_add_binding, "the binding");
842 apiset_start_list("ldpaths", afb_api_so_add_pathset_fails, "the binding path set");
843 apiset_start_list("weak-ldpaths", afb_api_so_add_pathset_nofails, "the weak binding path set");
845 apiset_start_list("auto-api", afb_autoset_add_any, "the automatic api path set");
846 #if WITH_DBUS_TRANSPARENCY
847 apiset_start_list("dbus-client", afb_api_dbus_add_client, "the afb-dbus client");
849 apiset_start_list("ws-client", afb_api_ws_add_client_weak, "the afb-websocket client");
851 DEBUG("Init config done");
853 /* start the services */
854 afb_debug("start-start");
855 #if !defined(NO_CALL_PERSONALITY)
856 personality((unsigned long)-1L);
858 if (afb_apiset_start_all_services(main_apiset) < 0)
861 /* export started apis */
862 apiset_start_list("ws-server", afb_api_ws_add_server, "the afb-websocket service");
863 #if WITH_DBUS_TRANSPARENCY
864 apiset_start_list("dbus-server", afb_api_dbus_add_server, "the afb-dbus service");
867 /* start the HTTP server */
868 afb_debug("start-http");
870 if (!afb_hreq_init_cookie(http_port, rootapi, session_timeout)) {
871 ERROR("initialisation of HTTP cookies failed");
875 hsrv = start_http_server();
880 /* run the startup calls */
881 afb_debug("start-call");
884 /* run the command */
885 afb_debug("start-exec");
886 if (execute_command() < 0)
891 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]");