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"
50 #include "afb-api-js.h"
54 #include "afb-session.h"
56 #include "afb-common.h"
57 #include "afb-export.h"
58 #include "afb-monitor.h"
61 #include "afb-hook-flags.h"
63 #include "afb-debug.h"
65 # include "afb-supervision.h"
68 #include "process-name.h"
69 #include "wrap-json.h"
71 #include "sig-monitor.h"
74 #if !defined(DEFAULT_BINDER_INTERFACE)
75 # define DEFAULT_BINDER_INTERFACE NULL
79 if SELF_PGROUP == 0 the launched command is the group leader
80 if SELF_PGROUP != 0 afb-daemon is the group leader
84 struct afb_apiset *main_apiset;
85 struct json_object *main_config;
87 static pid_t childpid;
90 * Tiny helper around putenv: add the variable name=value
92 * @param name name of the variable to set
93 * @param value value to set to the variable
95 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
97 static int addenv(const char *name, const char *value)
101 head = malloc(2 + strlen(name) + strlen(value));
106 middle = stpcpy(head, name);
108 strcpy(&middle[1], value);
113 * Tiny helper around addenv that export the real path
115 * @param name name of the variable to set
116 * @param path the path value to export to the variable
118 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
120 static int addenv_realpath(const char *name, const char *path)
122 char buffer[PATH_MAX];
123 char *p = realpath(path, buffer);
124 return p ? addenv(name, p) : -1;
128 * Tiny helper around addenv that export an integer
130 * @param name name of the variable to set
131 * @param value the integer value to export
133 * @return 0 in case of success or -1 in case of error (with errno set to ENOMEM)
135 static int addenv_int(const char *name, int value)
138 snprintf(buffer, sizeof buffer, "%d", value);
139 return addenv(name, buffer);
142 /*----------------------------------------------------------
143 | helpers for handling list of arguments
144 +--------------------------------------------------------- */
146 static const char *run_for_config_array_opt(const char *name,
147 int (*run) (void *closure, const char *value),
151 struct json_object *array, *value;
153 if (json_object_object_get_ex(main_config, name, &array)) {
154 if (!json_object_is_type(array, json_type_array))
155 return json_object_get_string(array);
156 n = (int)json_object_array_length(array);
157 for (i = 0 ; i < n ; i++) {
158 value = json_object_array_get_idx(array, i);
159 rc = run(closure, json_object_get_string(value));
161 return json_object_get_string(value);
167 static int run_start(void *closure, const char *value)
169 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set) = closure;
170 return starter(value, main_apiset, main_apiset) >= 0;
173 static void apiset_start_list(const char *name,
174 int (*starter) (const char *value, struct afb_apiset *declare_set, struct afb_apiset *call_set),
177 const char *item = run_for_config_array_opt(name, run_start, starter);
179 ERROR("can't start %s %s", message, item);
184 /*----------------------------------------------------------
186 | Handles on exit specific actions
187 +--------------------------------------------------------- */
188 static void exit_handler()
190 struct sigaction siga;
192 memset(&siga, 0, sizeof siga);
193 siga.sa_handler = SIG_IGN;
194 sigaction(SIGTERM, &siga, NULL);
198 else if (childpid > 0)
199 killpg(childpid, SIGTERM);
202 static void on_sigterm(int signum, siginfo_t *info, void *uctx)
204 NOTICE("Received SIGTERM");
208 static void on_sighup(int signum, siginfo_t *info, void *uctx)
210 NOTICE("Received SIGHUP");
214 static void setup_daemon()
216 struct sigaction siga;
218 /* install signal handlers */
219 memset(&siga, 0, sizeof siga);
220 siga.sa_flags = SA_SIGINFO;
222 siga.sa_sigaction = on_sigterm;
223 sigaction(SIGTERM, &siga, NULL);
225 siga.sa_sigaction = on_sighup;
226 sigaction(SIGHUP, &siga, NULL);
229 atexit(exit_handler);
231 /* ignore any SIGPIPE */
232 signal(SIGPIPE, SIG_IGN);
235 /*----------------------------------------------------------
237 | set the process in background
238 +--------------------------------------------------------- */
239 static void daemonize()
241 int fd = 0, daemon, nostdin;
247 wrap_json_unpack(main_config, "{s?b s?s}", "daemon", &daemon, "output", &output);
251 fd = open(output, O_WRONLY | O_APPEND | O_CREAT, 0640);
253 ERROR("Can't open output %s", output);
259 INFO("entering background mode");
263 ERROR("Failed to fork daemon process");
272 /* closes the input */
274 NOTICE("Redirecting output to %s", output);
283 close(0); /* except if 'daemon', ctrl+C still works after that */
286 /*---------------------------------------------------------
288 | Handles the HTTP server
289 +--------------------------------------------------------- */
290 static int init_alias(void *closure, const char *spec)
292 struct afb_hsrv *hsrv = closure;
293 char *path = strchr(spec, ':');
296 ERROR("Missing ':' in alias %s. Alias ignored", spec);
300 INFO("Alias for url=%s to path=%s", spec, path);
301 return afb_hsrv_add_alias(hsrv, spec, afb_common_rootdir_get_fd(), path,
305 static int init_http_server(struct afb_hsrv *hsrv)
308 const char *rootapi, *roothttp, *rootbase;
311 rc = wrap_json_unpack(main_config, "{ss ss s?s}",
313 "rootbase", &rootbase,
314 "roothttp", &roothttp);
316 ERROR("Can't get HTTP server config");
320 if (!afb_hsrv_add_handler(hsrv, rootapi,
321 afb_hswitch_websocket_switch, main_apiset, 20))
324 if (!afb_hsrv_add_handler(hsrv, rootapi,
325 afb_hswitch_apis, main_apiset, 10))
328 if (run_for_config_array_opt("alias", init_alias, hsrv))
331 if (roothttp != NULL) {
332 if (!afb_hsrv_add_alias(hsrv, "",
333 afb_common_rootdir_get_fd(), roothttp, -10, 1))
337 if (!afb_hsrv_add_handler(hsrv, rootbase,
338 afb_hswitch_one_page_api_redirect, NULL, -20))
344 static struct afb_hsrv *start_http_server()
347 const char *uploaddir, *rootdir;
348 struct afb_hsrv *hsrv;
349 int cache_timeout, http_port;
351 rc = wrap_json_unpack(main_config, "{ss ss si si}",
352 "uploaddir", &uploaddir,
354 "cache-eol", &cache_timeout,
357 ERROR("Can't get HTTP server start config");
361 if (afb_hreq_init_download_path(uploaddir)) {
362 static const char fallback_uploaddir[] = "/tmp";
363 WARNING("unable to set the upload directory %s", uploaddir);
364 if (afb_hreq_init_download_path(fallback_uploaddir)) {
365 ERROR("unable to fallback to upload directory %s", fallback_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");
403 /*---------------------------------------------------------
405 +--------------------------------------------------------- */
407 static void exit_at_end()
412 static void wait_child(int signum, void* arg)
414 pid_t pid = (pid_t)(intptr_t)arg;
415 pid_t pidchld = childpid;
417 if (pidchld == pid) {
420 killpg(pidchld, SIGKILL);
421 waitpid(pidchld, NULL, 0);
422 jobs_exit(exit_at_end);
424 waitpid(pid, NULL, 0);
428 static void on_sigchld(int signum, siginfo_t *info, void *uctx)
430 if (info->si_pid == childpid) {
431 switch (info->si_code) {
435 jobs_queue_lazy(0, 0, wait_child, (void*)(intptr_t)info->si_pid);
448 #define SUBST_CHAR '@'
449 #define SUBST_STR "@"
451 static char *instanciate_string(const char *arg, const char *port, const char *token)
453 char *resu, *it, *wr;
456 /* get the changes */
459 it = strchrnul(arg, SUBST_CHAR);
462 case 'p': chg++; dif += (int)strlen(port) - 2; break;
463 case 't': chg++; dif += (int)strlen(token) - 2; break;
464 case SUBST_CHAR: it++; chg++; dif--; break;
467 it = strchrnul(it, SUBST_CHAR);
470 /* return arg when no change */
474 /* allocates the result */
475 resu = malloc((it - arg) + dif + 1);
477 ERROR("out of memory");
481 /* instanciate the arguments */
484 it = strchrnul(arg, SUBST_CHAR);
485 wr = mempcpy(wr, arg, it - arg);
489 case 'p': wr = stpcpy(wr, port); break;
490 case 't': wr = stpcpy(wr, token); break;
491 default: *wr++ = SUBST_CHAR; /*@fallthrough@*/
492 case SUBST_CHAR: *wr++ = *it;
501 static int instanciate_environ(const char *port, const char *token)
503 extern char **environ;
507 /* instantiate the environment */
508 for (i = 0 ; environ[i] ; i++) {
509 repl = instanciate_string(environ[i], port, token);
517 static char **instanciate_command_args(struct json_object *exec, const char *port, const char *token)
523 /* allocates the result */
524 n = (int)json_object_array_length(exec);
525 result = malloc((n + 1) * sizeof * result);
527 ERROR("out of memory");
531 /* instanciate the arguments */
532 for (i = 0 ; i < n ; i++) {
533 repl = instanciate_string(json_object_get_string(json_object_array_get_idx(exec, i)), port, token);
546 static int execute_command()
548 struct json_object *exec, *oport;
549 struct sigaction siga;
555 /* check whether a command is to execute or not */
556 if (!json_object_object_get_ex(main_config, "exec", &exec))
562 /* install signal handler */
563 memset(&siga, 0, sizeof siga);
564 siga.sa_sigaction = on_sigchld;
565 siga.sa_flags = SA_SIGINFO;
566 sigaction(SIGCHLD, &siga, NULL);
573 /* compute the string for port */
574 if (json_object_object_get_ex(main_config, "port", &oport))
575 rc = snprintf(port, sizeof port, "%s", json_object_get_string(oport));
577 rc = snprintf(port, sizeof port, "%cp", SUBST_CHAR);
578 if (rc < 0 || rc >= (int)(sizeof port)) {
579 ERROR("port->txt failed");
582 /* instantiate arguments and environment */
583 token = afb_session_initial_token();
584 args = instanciate_command_args(exec, port, token);
585 if (args && instanciate_environ(port, token) >= 0) {
589 execv(args[0], args);
590 ERROR("can't launch %s: %m", args[0]);
597 /*---------------------------------------------------------
599 +--------------------------------------------------------- */
603 struct afb_xreq xreq;
606 struct json_object *calls;
609 const char *callspec;
610 struct afb_session *session;
613 static void startup_call_reply(struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
615 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
619 NOTICE("startup call %s returned %s (%s)", sreq->callspec, json_object_get_string(object), info);
620 json_object_put(object);
622 ERROR("startup call %s ERROR! %s (%s)", sreq->callspec, error, info);
627 static void startup_call_current(struct startup_req *sreq);
629 static void startup_call_unref(struct afb_xreq *xreq)
631 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
635 json_object_put(sreq->xreq.json);
636 if (++sreq->index < sreq->count)
637 startup_call_current(sreq);
639 afb_session_close(sreq->session);
640 afb_session_unref(sreq->session);
645 static struct afb_xreq_query_itf startup_xreq_itf =
647 .reply = startup_call_reply,
648 .unref = startup_call_unref
651 static void startup_call_current(struct startup_req *sreq)
653 const char *api, *verb, *json;
654 enum json_tokener_error jerr;
656 sreq->callspec = json_object_get_string(json_object_array_get_idx(sreq->calls, sreq->index)),
657 api = sreq->callspec;
658 verb = strchr(api, '/');
660 json = strchr(verb, ':');
662 afb_xreq_init(&sreq->xreq, &startup_xreq_itf);
663 afb_context_init_validated(&sreq->xreq.context, sreq->session);
664 sreq->api = strndup(api, verb - api);
665 sreq->verb = strndup(verb + 1, json - verb - 1);
666 sreq->xreq.request.called_api = sreq->api;
667 sreq->xreq.request.called_verb = sreq->verb;
668 sreq->xreq.json = json_tokener_parse_verbose(json + 1, &jerr);
669 if (sreq->api && sreq->verb && jerr == json_tokener_success) {
670 afb_xreq_process(&sreq->xreq, main_apiset);
675 ERROR("Bad call specification %s", sreq->callspec);
679 static void run_startup_calls()
681 struct json_object *calls;
682 struct startup_req *sreq;
685 if (json_object_object_get_ex(main_config, "call", &calls)
686 && json_object_is_type(calls, json_type_array)
687 && (count = (int)json_object_array_length(calls))) {
688 sreq = calloc(1, sizeof *sreq);
689 sreq->session = afb_session_create(3600);
693 startup_call_current(sreq);
697 /*---------------------------------------------------------
698 | job for starting the daemon
699 +--------------------------------------------------------- */
701 static void start(int signum, void *arg)
704 const char *tracereq = NULL, *traceapi = NULL, *traceevt = NULL,
705 #if !defined(REMOVE_LEGACY_TRACE)
706 *tracesvc = NULL, *traceditf = NULL,
708 *traceses = NULL, *traceglob = NULL;
710 const char *workdir, *rootdir, *token, *rootapi;
711 struct json_object *settings;
712 struct afb_hsrv *hsrv;
713 int max_session_count, session_timeout, api_timeout;
714 int no_httpd, http_port;
718 afb_debug("start-entry");
721 ERROR("start aborted: received signal %s", strsignal(signum));
728 rootapi = token = NULL;
729 rc = wrap_json_unpack(main_config, "{"
734 #if !defined(REMOVE_LEGACY_TRACE)
737 "s?s s?s s?s s?s s?s"
746 "apitimeout", &api_timeout,
747 "cntxtimeout", &session_timeout,
748 "session-max", &max_session_count,
750 "no-httpd", &no_httpd,
755 #if !defined(REMOVE_LEGACY_TRACE)
756 "tracesvc", &tracesvc,
757 "traceditf", &traceditf,
759 "tracereq", &tracereq,
760 "traceapi", &traceapi,
761 "traceevt", &traceevt,
762 "traceses", &traceses,
763 "traceglob", &traceglob,
768 ERROR("Unable to get start config");
772 /* initialize session handling */
773 if (afb_session_init(max_session_count, session_timeout, token)) {
774 ERROR("initialisation of session manager failed");
778 /* set the directories */
779 mkdir(workdir, S_IRWXU | S_IRGRP | S_IXGRP);
780 if (chdir(workdir) < 0) {
781 ERROR("Can't enter working dir %s", workdir);
784 if (afb_common_rootdir_set(rootdir) < 0) {
785 ERROR("failed to set common root directory %s", rootdir);
788 if (addenv_realpath("AFB_WORKDIR", "." /* resolved by realpath */)
789 || addenv_realpath("AFB_ROOTDIR", rootdir /* relative to current directory */)) {
790 ERROR("can't set DIR environment");
797 ERROR("no port is defined");
800 if (http_port == 0) {
801 ERROR("random port is not implemented");
804 if (addenv_int("AFB_PORT", http_port)
805 || addenv("AFB_TOKEN", afb_session_initial_token())) {
806 ERROR("can't set HTTP environment");
811 /* configure the daemon */
812 afb_export_set_config(settings);
813 main_apiset = afb_apiset_create("main", api_timeout);
815 ERROR("can't create main api set");
818 if (afb_monitor_init(main_apiset, main_apiset) < 0) {
819 ERROR("failed to setup monitor");
823 if (afb_supervision_init(main_apiset, main_config) < 0) {
824 ERROR("failed to setup supervision");
832 afb_hook_create_xreq(NULL, NULL, NULL, afb_hook_flags_xreq_from_text(tracereq), NULL, NULL);
833 #if !defined(REMOVE_LEGACY_TRACE)
834 if (traceapi || tracesvc || traceditf)
835 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi)
836 | afb_hook_flags_legacy_ditf_from_text(traceditf)
837 | afb_hook_flags_legacy_svc_from_text(tracesvc), NULL, NULL);
840 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi), NULL, NULL);
843 afb_hook_create_evt(NULL, afb_hook_flags_evt_from_text(traceevt), NULL, NULL);
845 afb_hook_create_session(NULL, afb_hook_flags_session_from_text(traceses), NULL, NULL);
847 afb_hook_create_global(afb_hook_flags_global_from_text(traceglob), NULL, NULL);
850 /* load bindings and apis */
851 afb_debug("start-load");
852 #if WITH_DYNAMIC_BINDING
853 apiset_start_list("binding", afb_api_so_add_binding, "the binding");
854 apiset_start_list("ldpaths", afb_api_so_add_pathset_fails, "the binding path set");
855 apiset_start_list("weak-ldpaths", afb_api_so_add_pathset_nofails, "the weak binding path set");
857 apiset_start_list("auto-api", afb_autoset_add_any, "the automatic api path set");
858 apiset_start_list("jsapi", afb_api_js_add, "the jsapi");
859 #if WITH_DBUS_TRANSPARENCY
860 apiset_start_list("dbus-client", afb_api_dbus_add_client, "the afb-dbus client");
862 apiset_start_list("ws-client", afb_api_ws_add_client_weak, "the afb-websocket client");
864 DEBUG("Init config done");
866 /* start the services */
867 afb_debug("start-start");
868 #if !defined(NO_CALL_PERSONALITY)
869 personality((unsigned long)-1L);
871 if (afb_apiset_start_all_services(main_apiset) < 0)
874 /* export started apis */
875 apiset_start_list("ws-server", afb_api_ws_add_server, "the afb-websocket service");
876 #if WITH_DBUS_TRANSPARENCY
877 apiset_start_list("dbus-server", afb_api_dbus_add_server, "the afb-dbus service");
880 /* start the HTTP server */
881 afb_debug("start-http");
883 if (!afb_hreq_init_cookie(http_port, rootapi, session_timeout)) {
884 ERROR("initialisation of HTTP cookies failed");
888 hsrv = start_http_server();
893 /* run the startup calls */
894 afb_debug("start-call");
897 /* run the command */
898 afb_debug("start-exec");
899 if (execute_command() < 0)
903 sd_notify(1, "READY=1");
905 /* activate the watchdog */
907 if (watchdog_activate() < 0)
908 ERROR("can't start the watchdog");
916 /*---------------------------------------------------------
918 | Parse option and launch action
919 +--------------------------------------------------------- */
921 int main(int argc, char *argv[])
923 struct json_object *obj;
924 afb_debug("main-entry");
926 // ------------- Build session handler & init config -------
927 main_config = afb_args_parse(argc, argv);
928 if (sig_monitor_init(
929 !json_object_object_get_ex(main_config, "trap-faults", &obj)
930 || json_object_get_boolean(obj)) < 0) {
931 ERROR("failed to initialise signal handlers");
936 if (json_object_object_get_ex(main_config, "name", &obj)) {
937 verbose_set_name(json_object_get_string(obj), 0);
938 process_name_set_name(json_object_get_string(obj));
939 process_name_replace_cmdline(argv, json_object_get_string(obj));
941 afb_debug("main-args");
943 // --------- run -----------
945 INFO("running with pid %d", getpid());
947 /* set the daemon environment */
950 afb_debug("main-start");
952 /* enter job processing */
953 jobs_start(3, 0, 100, start, NULL);
954 WARNING("hoops returned from jobs_enter! [report bug]");