2 * Copyright (C) 2015-2020 "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 int add_interface(void *closure, const char *value)
345 struct afb_hsrv *hsrv = closure;
348 rc = afb_hsrv_add_interface(hsrv, value);
352 static struct afb_hsrv *start_http_server()
355 const char *uploaddir, *rootdir, *errs;
356 struct afb_hsrv *hsrv;
357 int cache_timeout, http_port;
358 struct json_object *junk;
361 rc = wrap_json_unpack(main_config, "{ss ss si s?i}",
362 "uploaddir", &uploaddir,
364 "cache-eol", &cache_timeout,
367 ERROR("Can't get HTTP server start config");
371 if (afb_hreq_init_download_path(uploaddir)) {
372 static const char fallback_uploaddir[] = "/tmp";
373 WARNING("unable to set the upload directory %s", uploaddir);
374 if (afb_hreq_init_download_path(fallback_uploaddir)) {
375 ERROR("unable to fallback to upload directory %s", fallback_uploaddir);
378 uploaddir = fallback_uploaddir;
381 hsrv = afb_hsrv_create();
383 ERROR("memory allocation failure");
387 if (!afb_hsrv_set_cache_timeout(hsrv, cache_timeout)
388 || !init_http_server(hsrv)) {
389 ERROR("initialisation of httpd failed");
394 rc = afb_hsrv_start(hsrv, 15);
396 ERROR("starting of httpd failed");
401 NOTICE("Serving rootdir=%s uploaddir=%s", rootdir, uploaddir);
403 /* check if port is set */
405 /* not set, check existing interfaces */
406 if (!json_object_object_get_ex(main_config, "interface", &junk)) {
407 ERROR("No port and no interface ");
410 rc = afb_hsrv_add_interface_tcp(hsrv, DEFAULT_BINDER_INTERFACE, (uint16_t) http_port);
412 ERROR("setting interface failed");
416 NOTICE("Browser URL= http://localhost:%d", http_port);
419 errs = run_for_config_array_opt("interface", add_interface, hsrv);
421 ERROR("setting interface %s failed", errs);
429 /*---------------------------------------------------------
431 +--------------------------------------------------------- */
433 static void exit_at_end()
438 static void wait_child(int signum, void* arg)
440 pid_t pid = (pid_t)(intptr_t)arg;
441 pid_t pidchld = childpid;
443 if (pidchld == pid) {
446 killpg(pidchld, SIGKILL);
447 waitpid(pidchld, NULL, 0);
448 jobs_exit(exit_at_end);
450 waitpid(pid, NULL, 0);
454 static void on_sigchld(int signum, siginfo_t *info, void *uctx)
456 if (info->si_pid == childpid) {
457 switch (info->si_code) {
461 jobs_queue_lazy(0, 0, wait_child, (void*)(intptr_t)info->si_pid);
474 #define SUBST_CHAR '@'
475 #define SUBST_STR "@"
477 static char *instanciate_string(char *arg, const char *port, const char *token)
479 char *resu, *it, *wr, c;
482 /* get the changes */
485 it = strchrnul(arg, SUBST_CHAR);
488 if (c == 'p' && port) {
490 dif += (int)strlen(port) - 2;
491 } else if (c == 't' && token) {
493 dif += (int)strlen(token) - 2;
494 } else if (c == SUBST_CHAR) {
499 it = strchrnul(it, SUBST_CHAR);
502 /* return arg when no change */
506 /* allocates the result */
507 resu = malloc((it - arg) + dif + 1);
509 ERROR("out of memory");
513 /* instanciate the arguments */
516 it = strchrnul(arg, SUBST_CHAR);
517 wr = mempcpy(wr, arg, it - arg);
521 if (c == 'p' && port)
522 wr = stpcpy(wr, port);
523 else if (c == 't' && token)
524 wr = stpcpy(wr, token);
537 static int instanciate_environ(const char *port, const char *token)
539 extern char **environ;
543 /* instantiate the environment */
544 for (i = 0 ; environ[i] ; i++) {
545 repl = instanciate_string(environ[i], port, token);
553 static char **instanciate_command_args(struct json_object *exec, const char *port, const char *token)
559 /* allocates the result */
560 n = (int)json_object_array_length(exec);
561 result = malloc((n + 1) * sizeof * result);
563 ERROR("out of memory");
567 /* instanciate the arguments */
568 for (i = 0 ; i < n ; i++) {
569 item = (char*)json_object_get_string(json_object_array_get_idx(exec, i));
570 repl = instanciate_string(item, port, token);
581 static int execute_command()
583 struct json_object *exec, *oport, *otok;
584 struct sigaction siga;
585 const char *token, *port;
588 /* check whether a command is to execute or not */
589 if (!json_object_object_get_ex(main_config, "exec", &exec))
595 /* install signal handler */
596 memset(&siga, 0, sizeof siga);
597 siga.sa_sigaction = on_sigchld;
598 siga.sa_flags = SA_SIGINFO;
599 sigaction(SIGCHLD, &siga, NULL);
606 /* compute the string for port */
607 if (json_object_object_get_ex(main_config, "port", &oport))
608 port = json_object_get_string(oport);
611 /* instantiate arguments and environment */
612 if (json_object_object_get_ex(main_config, "token", &otok))
613 token = json_object_get_string(otok);
616 args = instanciate_command_args(exec, port, token);
617 if (args && instanciate_environ(port, token) >= 0) {
621 execv(args[0], args);
622 ERROR("can't launch %s: %m", args[0]);
628 /*---------------------------------------------------------
630 +--------------------------------------------------------- */
634 struct afb_xreq xreq;
637 struct json_object *calls;
640 const char *callspec;
641 struct afb_session *session;
644 static void startup_call_reply(struct afb_xreq *xreq, struct json_object *object, const char *error, const char *info)
646 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
650 NOTICE("startup call %s returned %s (%s)", sreq->callspec, json_object_get_string(object), info);
651 json_object_put(object);
653 ERROR("startup call %s ERROR! %s (%s)", sreq->callspec, error, info);
658 static void startup_call_current(struct startup_req *sreq);
660 static void startup_call_unref(struct afb_xreq *xreq)
662 struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
666 json_object_put(sreq->xreq.json);
667 if (++sreq->index < sreq->count)
668 startup_call_current(sreq);
670 afb_session_close(sreq->session);
671 afb_session_unref(sreq->session);
676 static struct afb_xreq_query_itf startup_xreq_itf =
678 .reply = startup_call_reply,
679 .unref = startup_call_unref
682 static void startup_call_current(struct startup_req *sreq)
684 const char *api, *verb, *json;
685 enum json_tokener_error jerr;
687 sreq->callspec = json_object_get_string(json_object_array_get_idx(sreq->calls, sreq->index)),
688 api = sreq->callspec;
689 verb = strchr(api, '/');
691 json = strchr(verb, ':');
693 afb_xreq_init(&sreq->xreq, &startup_xreq_itf);
694 afb_context_init_validated(&sreq->xreq.context, sreq->session, NULL, NULL);
695 sreq->api = strndup(api, verb - api);
696 sreq->verb = strndup(verb + 1, json - verb - 1);
697 sreq->xreq.request.called_api = sreq->api;
698 sreq->xreq.request.called_verb = sreq->verb;
699 sreq->xreq.json = json_tokener_parse_verbose(json + 1, &jerr);
700 if (sreq->api && sreq->verb && jerr == json_tokener_success) {
701 afb_xreq_process(&sreq->xreq, main_apiset);
706 ERROR("Bad call specification %s", sreq->callspec);
710 static void run_startup_calls()
712 struct json_object *calls;
713 struct startup_req *sreq;
716 if (json_object_object_get_ex(main_config, "call", &calls)
717 && json_object_is_type(calls, json_type_array)
718 && (count = (int)json_object_array_length(calls))) {
719 sreq = calloc(1, sizeof *sreq);
720 sreq->session = afb_session_create(3600);
724 startup_call_current(sreq);
728 /*---------------------------------------------------------
729 | job for starting the daemon
730 +--------------------------------------------------------- */
732 static void start(int signum, void *arg)
735 const char *tracereq = NULL, *traceapi = NULL, *traceevt = NULL,
736 #if !defined(REMOVE_LEGACY_TRACE)
737 *tracesvc = NULL, *traceditf = NULL,
739 *traceses = NULL, *traceglob = NULL;
741 const char *workdir, *rootdir, *token, *rootapi;
742 struct json_object *settings;
743 struct afb_hsrv *hsrv;
744 int max_session_count, session_timeout, api_timeout;
745 int no_httpd, http_port;
749 afb_debug("start-entry");
752 ERROR("start aborted: received signal %s", strsignal(signum));
759 rootapi = token = NULL;
760 rc = wrap_json_unpack(main_config, "{"
771 "apitimeout", &api_timeout,
772 "cntxtimeout", &session_timeout,
773 "session-max", &max_session_count,
775 "no-httpd", &no_httpd,
782 ERROR("Unable to get start config");
787 rc = wrap_json_unpack(main_config, "{"
788 #if !defined(REMOVE_LEGACY_TRACE)
791 "s?s s?s s?s s?s s?s"
794 #if !defined(REMOVE_LEGACY_TRACE)
795 "tracesvc", &tracesvc,
796 "traceditf", &traceditf,
798 "tracereq", &tracereq,
799 "traceapi", &traceapi,
800 "traceevt", &traceevt,
801 "traceses", &traceses,
802 "traceglob", &traceglob
805 ERROR("Unable to get hook config");
810 /* initialize session handling */
811 if (afb_session_init(max_session_count, session_timeout)) {
812 ERROR("initialisation of session manager failed");
816 /* set the directories */
817 mkdir(workdir, S_IRWXU | S_IRGRP | S_IXGRP);
818 if (chdir(workdir) < 0) {
819 ERROR("Can't enter working dir %s", workdir);
822 if (afb_common_rootdir_set(rootdir) < 0) {
823 ERROR("failed to set common root directory %s", rootdir);
826 if (addenv_realpath("AFB_WORKDIR", "." /* resolved by realpath */)
827 || addenv_realpath("AFB_ROOTDIR", rootdir /* relative to current directory */)) {
828 ERROR("can't set DIR environment");
834 if (http_port == 0) {
835 ERROR("random port is not implemented");
838 if ((http_port > 0 && addenv_int("AFB_PORT", http_port))
839 || (token && addenv("AFB_TOKEN", token))) {
840 ERROR("can't set HTTP environment");
845 /* configure the daemon */
846 afb_export_set_config(settings);
847 main_apiset = afb_apiset_create("main", api_timeout);
849 ERROR("can't create main api set");
852 if (afb_monitor_init(main_apiset, main_apiset) < 0) {
853 ERROR("failed to setup monitor");
857 if (afb_supervision_init(main_apiset, main_config) < 0) {
858 ERROR("failed to setup supervision");
866 afb_hook_create_xreq(NULL, NULL, NULL, afb_hook_flags_xreq_from_text(tracereq), NULL, NULL);
867 #if !defined(REMOVE_LEGACY_TRACE)
868 if (traceapi || tracesvc || traceditf)
869 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi)
870 | afb_hook_flags_legacy_ditf_from_text(traceditf)
871 | afb_hook_flags_legacy_svc_from_text(tracesvc), NULL, NULL);
874 afb_hook_create_api(NULL, afb_hook_flags_api_from_text(traceapi), NULL, NULL);
877 afb_hook_create_evt(NULL, afb_hook_flags_evt_from_text(traceevt), NULL, NULL);
879 afb_hook_create_session(NULL, afb_hook_flags_session_from_text(traceses), NULL, NULL);
881 afb_hook_create_global(afb_hook_flags_global_from_text(traceglob), NULL, NULL);
884 /* load bindings and apis */
885 afb_debug("start-load");
886 #if WITH_DYNAMIC_BINDING
887 apiset_start_list("binding", afb_api_so_add_binding, "the binding");
888 apiset_start_list("ldpaths", afb_api_so_add_pathset_fails, "the binding path set");
889 apiset_start_list("weak-ldpaths", afb_api_so_add_pathset_nofails, "the weak binding path set");
891 apiset_start_list("auto-api", afb_autoset_add_any, "the automatic api path set");
892 #if WITH_DBUS_TRANSPARENCY
893 apiset_start_list("dbus-client", afb_api_dbus_add_client, "the afb-dbus client");
895 apiset_start_list("ws-client", afb_api_ws_add_client_weak, "the afb-websocket client");
897 DEBUG("Init config done");
899 /* start the services */
900 afb_debug("start-start");
901 #if !defined(NO_CALL_PERSONALITY)
902 personality((unsigned long)-1L);
904 if (afb_apiset_start_all_services(main_apiset) < 0)
907 /* export started apis */
908 apiset_start_list("ws-server", afb_api_ws_add_server, "the afb-websocket service");
909 #if WITH_DBUS_TRANSPARENCY
910 apiset_start_list("dbus-server", afb_api_dbus_add_server, "the afb-dbus service");
913 /* start the HTTP server */
914 afb_debug("start-http");
916 if (!afb_hreq_init_cookie(http_port, rootapi, session_timeout)) {
917 ERROR("initialisation of HTTP cookies failed");
921 hsrv = start_http_server();
926 /* run the startup calls */
927 afb_debug("start-call");
930 /* run the command */
931 afb_debug("start-exec");
932 if (execute_command(http_port, token) < 0)
936 sd_notify(1, "READY=1");
938 /* activate the watchdog */
940 if (watchdog_activate() < 0)
941 ERROR("can't start the watchdog");
949 /*---------------------------------------------------------
951 | Parse option and launch action
952 +--------------------------------------------------------- */
954 int main(int argc, char *argv[])
956 struct json_object *obj;
957 afb_debug("main-entry");
959 // ------------- Build session handler & init config -------
960 main_config = afb_args_parse(argc, argv);
961 if (sig_monitor_init(
962 !json_object_object_get_ex(main_config, "trap-faults", &obj)
963 || json_object_get_boolean(obj)) < 0) {
964 ERROR("failed to initialise signal handlers");
969 if (json_object_object_get_ex(main_config, "name", &obj)) {
970 verbose_set_name(json_object_get_string(obj), 0);
971 process_name_set_name(json_object_get_string(obj));
972 process_name_replace_cmdline(argv, json_object_get_string(obj));
974 afb_debug("main-args");
976 // --------- run -----------
978 INFO("running with pid %d", getpid());
980 /* set the daemon environment */
983 afb_debug("main-start");
985 /* enter job processing */
986 jobs_start(3, 0, 100, start, NULL);
987 WARNING("hoops returned from jobs_enter! [report bug]");