src/main.c

   1 /*
   2  * Copyright (C) 2015, 2016, 2017 "IoT.bzh"
   3  * Author "Fulup Ar Foll"
   4  * Author José Bollo <jose.bollo@iot.bzh>
   5  *
   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
   9  *
  10  *   http://www.apache.org/licenses/LICENSE-2.0
  11  *
  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.
  17  */
  18
  19 #define _GNU_SOURCE
  20 #define AFB_BINDING_PRAGMA_NO_VERBOSE_MACRO
  21
  22 #include <stdlib.h>
  23 #include <stdio.h>
  24 #include <stdint.h>
  25 #include <signal.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28 #include <fcntl.h>
  29 #include <sys/stat.h>
  30 #include <sys/wait.h>
  31
  32 #if !defined(NO_CALL_PERSONALITY)
  33 #include <sys/personality.h>
  34 #endif
  35
  36 #include <json-c/json.h>
  37
  38 #include <systemd/sd-daemon.h>
  39
  40 #include "afb-config.h"
  41 #include "afb-hswitch.h"
  42 #include "afb-apiset.h"
  43 #include "afb-api-so.h"
  44 #include "afb-api-dbus.h"
  45 #include "afb-api-ws.h"
  46 #include "afb-hsrv.h"
  47 #include "afb-hreq.h"
  48 #include "afb-xreq.h"
  49 #include "jobs.h"
  50 #include "afb-session.h"
  51 #include "verbose.h"
  52 #include "afb-common.h"
  53 #include "afb-monitor.h"
  54 #include "afb-hook.h"
  55 #include "sd-fds.h"
  56 #include "afb-debug.h"
  57 #include "process-name.h"
  58
  59 /*
  60    if SELF_PGROUP == 0 the launched command is the group leader
  61    if SELF_PGROUP != 0 afb-daemon is the group leader
  62 */
  63 #define SELF_PGROUP 1
  64
  65 struct afb_apiset *main_apiset;
  66
  67 static struct afb_config *config;
  68 static pid_t childpid;
  69
  70 /*----------------------------------------------------------
  71  |   helpers for handling list of arguments
  72  +--------------------------------------------------------- */
  73
  74 /*
  75  * Calls the callback 'run' for each value of the 'list'
  76  * until the callback returns 0 or the end of the list is reached.
  77  * Returns either NULL if the end of the list is reached or a pointer
  78  * to the item whose value made 'run' return 0.
  79  * 'closure' is used for passing user data.
  80  */
  81 static struct afb_config_list *run_for_list(struct afb_config_list *list,
  82                                             int (*run) (void *closure, char *value),
  83                                             void *closure)
  84 {
  85         while (list && run(closure, list->value))
  86                 list = list->next;
  87         return list;
  88 }
  89
  90 static int run_start(void *closure, char *value)
  91 {
  92         int (*starter) (const char *value, struct afb_apiset *apiset) = closure;
  93         return starter(value, main_apiset) >= 0;
  94 }
  95
  96 static void apiset_start_list(struct afb_config_list *list,
  97                        int (*starter) (const char *value, struct afb_apiset *apiset), const char *message)
  98 {
  99         list = run_for_list(list, run_start, starter);
 100         if (list) {
 101                 ERROR("can't start %s %s", message, list->value);
 102                 exit(1);
 103         }
 104 }
 105
 106 /*----------------------------------------------------------
 107  | exit_handler
 108  |   Handles on exit specific actions
 109  +--------------------------------------------------------- */
 110 static void exit_handler()
 111 {
 112         struct sigaction siga;
 113
 114         memset(&siga, 0, sizeof siga);
 115         siga.sa_handler = SIG_IGN;
 116         sigaction(SIGTERM, &siga, NULL);
 117
 118         if (SELF_PGROUP)
 119                 killpg(0, SIGTERM);
 120         else if (childpid > 0)
 121                 killpg(childpid, SIGTERM);
 122 }
 123
 124 static void on_sigterm(int signum, siginfo_t *info, void *uctx)
 125 {
 126         NOTICE("Received SIGTERM");
 127         exit(0);
 128 }
 129
 130 static void on_sighup(int signum, siginfo_t *info, void *uctx)
 131 {
 132         NOTICE("Received SIGHUP");
 133         /* TODO */
 134 }
 135
 136 static void setup_daemon()
 137 {
 138         struct sigaction siga;
 139
 140         /* install signal handlers */
 141         memset(&siga, 0, sizeof siga);
 142         siga.sa_flags = SA_SIGINFO;
 143
 144         siga.sa_sigaction = on_sigterm;
 145         sigaction(SIGTERM, &siga, NULL);
 146
 147         siga.sa_sigaction = on_sighup;
 148         sigaction(SIGHUP, &siga, NULL);
 149
 150         /* handle groups */
 151         atexit(exit_handler);
 152
 153         /* ignore any SIGPIPE */
 154         signal(SIGPIPE, SIG_IGN);
 155 }
 156
 157 /*----------------------------------------------------------
 158  | daemonize
 159  |   set the process in background
 160  +--------------------------------------------------------- */
 161 static void daemonize()
 162 {
 163         int consoleFD;
 164         int pid;
 165
 166         // open /dev/console to redirect output messAFBes
 167         consoleFD = open(config->console, O_WRONLY | O_APPEND | O_CREAT, 0640);
 168         if (consoleFD < 0) {
 169                 ERROR("AFB-daemon cannot open /dev/console (use --foreground)");
 170                 exit(1);
 171         }
 172         // fork process when running background mode
 173         pid = fork();
 174
 175         // if fail nothing much to do
 176         if (pid == -1) {
 177                 ERROR("AFB-daemon Failed to fork son process");
 178                 exit(1);
 179         }
 180         // if in father process, just leave
 181         if (pid != 0)
 182                 _exit(0);
 183
 184         // son process get all data in standalone mode
 185         NOTICE("background mode [pid:%d console:%s]", getpid(),
 186                config->console);
 187
 188         // redirect default I/O on console
 189         close(2);
 190         dup(consoleFD);         // redirect stderr
 191         close(1);
 192         dup(consoleFD);         // redirect stdout
 193         close(0);               // no need for stdin
 194         close(consoleFD);
 195
 196 #if 0
 197         setsid();               // allow father process to fully exit
 198         sleep(2);               // allow main to leave and release port
 199 #endif
 200 }
 201
 202 /*---------------------------------------------------------
 203  | http server
 204  |   Handles the HTTP server
 205  +--------------------------------------------------------- */
 206 static int init_alias(void *closure, char *spec)
 207 {
 208         struct afb_hsrv *hsrv = closure;
 209         char *path = strchr(spec, ':');
 210
 211         if (path == NULL) {
 212                 ERROR("Missing ':' in alias %s. Alias ignored", spec);
 213                 return 1;
 214         }
 215         *path++ = 0;
 216         INFO("Alias for url=%s to path=%s", spec, path);
 217         return afb_hsrv_add_alias(hsrv, spec, afb_common_rootdir_get_fd(), path,
 218                                   0, 0);
 219 }
 220
 221 static int init_http_server(struct afb_hsrv *hsrv)
 222 {
 223         if (!afb_hsrv_add_handler
 224             (hsrv, config->rootapi, afb_hswitch_websocket_switch, main_apiset, 20))
 225                 return 0;
 226
 227         if (!afb_hsrv_add_handler
 228             (hsrv, config->rootapi, afb_hswitch_apis, main_apiset, 10))
 229                 return 0;
 230
 231         if (run_for_list(config->aliases, init_alias, hsrv))
 232                 return 0;
 233
 234         if (config->roothttp != NULL) {
 235                 if (!afb_hsrv_add_alias
 236                     (hsrv, "", afb_common_rootdir_get_fd(), config->roothttp,
 237                      -10, 1))
 238                         return 0;
 239         }
 240
 241         if (!afb_hsrv_add_handler
 242             (hsrv, config->rootbase, afb_hswitch_one_page_api_redirect, NULL,
 243              -20))
 244                 return 0;
 245
 246         return 1;
 247 }
 248
 249 static struct afb_hsrv *start_http_server()
 250 {
 251         int rc;
 252         struct afb_hsrv *hsrv;
 253
 254         if (afb_hreq_init_download_path(config->uploaddir)) {
 255                 ERROR("unable to set the upload directory %s", config->uploaddir);
 256                 return NULL;
 257         }
 258
 259         hsrv = afb_hsrv_create();
 260         if (hsrv == NULL) {
 261                 ERROR("memory allocation failure");
 262                 return NULL;
 263         }
 264
 265         if (!afb_hsrv_set_cache_timeout(hsrv, config->cacheTimeout)
 266             || !init_http_server(hsrv)) {
 267                 ERROR("initialisation of httpd failed");
 268                 afb_hsrv_put(hsrv);
 269                 return NULL;
 270         }
 271
 272         NOTICE("Waiting port=%d rootdir=%s", config->httpdPort, config->rootdir);
 273         NOTICE("Browser URL= http://localhost:%d", config->httpdPort);
 274
 275         rc = afb_hsrv_start(hsrv, (uint16_t) config->httpdPort, 15);
 276         if (!rc) {
 277                 ERROR("starting of httpd failed");
 278                 afb_hsrv_put(hsrv);
 279                 return NULL;
 280         }
 281
 282         return hsrv;
 283 }
 284
 285 /*---------------------------------------------------------
 286  | execute_command
 287  |
 288  +--------------------------------------------------------- */
 289
 290 static void on_sigchld(int signum, siginfo_t *info, void *uctx)
 291 {
 292         if (info->si_pid == childpid) {
 293                 switch (info->si_code) {
 294                 case CLD_EXITED:
 295                 case CLD_KILLED:
 296                 case CLD_DUMPED:
 297                         childpid = 0;
 298                         if (!SELF_PGROUP)
 299                                 killpg(info->si_pid, SIGKILL);
 300                         waitpid(info->si_pid, NULL, 0);
 301                         exit(0);
 302                 }
 303         }
 304 }
 305
 306 /*
 307 # @@ @
 308 # @p port
 309 # @t token
 310 */
 311
 312 #define SUBST_CHAR  '@'
 313 #define SUBST_STR   "@"
 314
 315 static char *instanciate_string(char *arg, const char *port, const char *token)
 316 {
 317         char *resu, *it, *wr;
 318         int chg, dif;
 319
 320         /* get the changes */
 321         chg = 0;
 322         dif = 0;
 323         it = strchrnul(arg, SUBST_CHAR);
 324         while (*it) {
 325                 switch(*++it) {
 326                 case 'p': chg++; dif += (int)strlen(port) - 2; break;
 327                 case 't': chg++; dif += (int)strlen(token) - 2; break;
 328                 case SUBST_CHAR: it++; chg++; dif--; break;
 329                 default: break;
 330                 }
 331                 it = strchrnul(it, SUBST_CHAR);
 332         }
 333
 334         /* return arg when no change */
 335         if (!chg)
 336                 return arg;
 337
 338         /* allocates the result */
 339         resu = malloc((it - arg) + dif + 1);
 340         if (!resu) {
 341                 ERROR("out of memory");
 342                 return NULL;
 343         }
 344
 345         /* instanciate the arguments */
 346         wr = resu;
 347         for (;;) {
 348                 it = strchrnul(arg, SUBST_CHAR);
 349                 wr = mempcpy(wr, arg, it - arg);
 350                 if (!*it)
 351                         break;
 352                 switch(*++it) {
 353                 case 'p': wr = stpcpy(wr, port); break;
 354                 case 't': wr = stpcpy(wr, token); break;
 355                 default: *wr++ = SUBST_CHAR; /*@fallthrough@*/
 356                 case SUBST_CHAR: *wr++ = *it;
 357                 }
 358                 arg = ++it;
 359         }
 360
 361         *wr = 0;
 362         return resu;
 363 }
 364
 365 static int instanciate_environ(const char *port, const char *token)
 366 {
 367         extern char **environ;
 368         char *repl;
 369         int i;
 370
 371         /* instanciate the environment */
 372         for (i = 0 ; environ[i] ; i++) {
 373                 repl = instanciate_string(environ[i], port, token);
 374                 if (!repl)
 375                         return -1;
 376                 environ[i] = repl;
 377         }
 378         return 0;
 379 }
 380
 381 static int instanciate_command_args(const char *port, const char *token)
 382 {
 383         char *repl;
 384         int i;
 385
 386         /* instanciate the arguments */
 387         for (i = 0 ; config->exec[i] ; i++) {
 388                 repl = instanciate_string(config->exec[i], port, token);
 389                 if (!repl)
 390                         return -1;
 391                 config->exec[i] = repl;
 392         }
 393         return 0;
 394 }
 395
 396 static int execute_command()
 397 {
 398         struct sigaction siga;
 399         char port[20];
 400         int rc;
 401
 402         /* check whether a command is to execute or not */
 403         if (!config->exec || !config->exec[0])
 404                 return 0;
 405
 406         if (SELF_PGROUP)
 407                 setpgid(0, 0);
 408
 409         /* install signal handler */
 410         memset(&siga, 0, sizeof siga);
 411         siga.sa_sigaction = on_sigchld;
 412         siga.sa_flags = SA_SIGINFO;
 413         sigaction(SIGCHLD, &siga, NULL);
 414
 415         /* fork now */
 416         childpid = fork();
 417         if (childpid)
 418                 return 0;
 419
 420         /* compute the string for port */
 421         if (config->httpdPort)
 422                 rc = snprintf(port, sizeof port, "%d", config->httpdPort);
 423         else
 424                 rc = snprintf(port, sizeof port, "%cp", SUBST_CHAR);
 425         if (rc < 0 || rc >= (int)(sizeof port)) {
 426                 ERROR("port->txt failed");
 427         }
 428         else {
 429                 /* instanciate arguments and environment */
 430                 if (instanciate_command_args(port, config->token) >= 0
 431                  && instanciate_environ(port, config->token) >= 0) {
 432                         /* run */
 433                         if (!SELF_PGROUP)
 434                                 setpgid(0, 0);
 435                         execv(config->exec[0], config->exec);
 436                         ERROR("can't launch %s: %m", config->exec[0]);
 437                 }
 438         }
 439         exit(1);
 440         return -1;
 441 }
 442
 443 /*---------------------------------------------------------
 444  | startup calls
 445  +--------------------------------------------------------- */
 446
 447 struct startup_req
 448 {
 449         struct afb_xreq xreq;
 450         char *api;
 451         char *verb;
 452         struct afb_config_list *current;
 453         struct afb_session *session;
 454 };
 455
 456 static void startup_call_reply(struct afb_xreq *xreq, int status, struct json_object *obj)
 457 {
 458         struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
 459
 460         if (status >= 0)
 461                 NOTICE("startup call %s returned %s", sreq->current->value, json_object_get_string(obj));
 462         else {
 463                 ERROR("startup call %s ERROR! %s", sreq->current->value, json_object_get_string(obj));
 464                 exit(1);
 465         }
 466 }
 467
 468 static void startup_call_current(struct startup_req *sreq);
 469
 470 static void startup_call_unref(struct afb_xreq *xreq)
 471 {
 472         struct startup_req *sreq = CONTAINER_OF_XREQ(struct startup_req, xreq);
 473
 474         free(sreq->api);
 475         free(sreq->verb);
 476         json_object_put(sreq->xreq.json);
 477         sreq->current = sreq->current->next;
 478         if (sreq->current)
 479                 startup_call_current(sreq);
 480         else {
 481                 afb_session_close(sreq->session);
 482                 afb_session_unref(sreq->session);
 483                 free(sreq);
 484         }
 485 }
 486
 487 static struct afb_xreq_query_itf startup_xreq_itf =
 488 {
 489         .reply = startup_call_reply,
 490         .unref = startup_call_unref
 491 };
 492
 493 static void startup_call_current(struct startup_req *sreq)
 494 {
 495         char *api, *verb, *json;
 496
 497         api = sreq->current->value;
 498         verb = strchr(api, '/');
 499         if (verb) {
 500                 json = strchr(verb, ':');
 501                 if (json) {
 502                         afb_xreq_init(&sreq->xreq, &startup_xreq_itf);
 503                         afb_context_init(&sreq->xreq.context, sreq->session, NULL);
 504                         sreq->xreq.context.validated = 1;
 505                         sreq->api = strndup(api, verb - api);
 506                         sreq->verb = strndup(verb + 1, json - verb - 1);
 507                         sreq->xreq.api = sreq->api;
 508                         sreq->xreq.verb = sreq->verb;
 509                         sreq->xreq.json = json_tokener_parse(json + 1);
 510                         if (sreq->api && sreq->verb && sreq->xreq.json) {
 511                                 afb_xreq_process(&sreq->xreq, main_apiset);
 512                                 return;
 513                         }
 514                 }
 515         }
 516         ERROR("Bad call specification %s", sreq->current->value);
 517         exit(1);
 518 }
 519
 520 static void run_startup_calls()
 521 {
 522         struct afb_config_list *list;
 523         struct startup_req *sreq;
 524
 525         list = config->calls;
 526         if (list) {
 527                 sreq = calloc(1, sizeof *sreq);
 528                 sreq->session = afb_session_create("startup", 3600);
 529                 sreq->current = list;
 530                 startup_call_current(sreq);
 531         }
 532 }
 533
 534 /*---------------------------------------------------------
 535  | job for starting the daemon
 536  +--------------------------------------------------------- */
 537
 538 static void start(int signum)
 539 {
 540         struct afb_hsrv *hsrv;
 541
 542         afb_debug("start-entry");
 543
 544         if (signum) {
 545                 ERROR("start aborted: received signal %s", strsignal(signum));
 546                 exit(1);
 547         }
 548
 549         // ------------------ sanity check ----------------------------------------
 550         if (config->httpdPort <= 0) {
 551                 ERROR("no port is defined");
 552                 goto error;
 553         }
 554
 555         /* set the directories */
 556         mkdir(config->workdir, S_IRWXU | S_IRGRP | S_IXGRP);
 557         if (chdir(config->workdir) < 0) {
 558                 ERROR("Can't enter working dir %s", config->workdir);
 559                 goto error;
 560         }
 561         if (afb_common_rootdir_set(config->rootdir) < 0) {
 562                 ERROR("failed to set common root directory");
 563                 goto error;
 564         }
 565
 566         /* configure the daemon */
 567         afb_session_init(config->nbSessionMax, config->cntxTimeout, config->token);
 568         if (!afb_hreq_init_cookie(config->httpdPort, config->rootapi, config->cntxTimeout)) {
 569                 ERROR("initialisation of cookies failed");
 570                 goto error;
 571         }
 572         main_apiset = afb_apiset_create("main", config->apiTimeout);
 573         if (!main_apiset) {
 574                 ERROR("can't create main api set");
 575                 goto error;
 576         }
 577         if (afb_monitor_init() < 0) {
 578                 ERROR("failed to setup monitor");
 579                 goto error;
 580         }
 581
 582         /* install hooks */
 583         if (config->tracereq)
 584                 afb_hook_create_xreq(NULL, NULL, NULL, config->tracereq, NULL, NULL);
 585         if (config->traceditf)
 586                 afb_hook_create_ditf(NULL, config->traceditf, NULL, NULL);
 587         if (config->tracesvc)
 588                 afb_hook_create_svc(NULL, config->tracesvc, NULL, NULL);
 589         if (config->traceevt)
 590                 afb_hook_create_evt(NULL, config->traceevt, NULL, NULL);
 591
 592         /* load bindings */
 593         afb_debug("start-load");
 594         apiset_start_list(config->so_bindings, afb_api_so_add_binding, "the binding");
 595         apiset_start_list(config->dbus_clients, afb_api_dbus_add_client, "the afb-dbus client");
 596         apiset_start_list(config->ws_clients, afb_api_ws_add_client, "the afb-websocket client");
 597         apiset_start_list(config->ldpaths, afb_api_so_add_pathset_fails, "the binding path set");
 598         apiset_start_list(config->weak_ldpaths, afb_api_so_add_pathset_nofails, "the weak binding path set");
 599
 600         apiset_start_list(config->dbus_servers, afb_api_dbus_add_server, "the afb-dbus service");
 601         apiset_start_list(config->ws_servers, afb_api_ws_add_server, "the afb-websocket service");
 602
 603         DEBUG("Init config done");
 604
 605         /* start the services */
 606         afb_debug("start-start");
 607 #if !defined(NO_CALL_PERSONALITY)
 608         personality((unsigned long)-1L);
 609 #endif
 610         if (afb_apiset_start_all_services(main_apiset, 1) < 0)
 611                 goto error;
 612
 613         /* start the HTTP server */
 614         afb_debug("start-http");
 615         if (!config->noHttpd) {
 616                 hsrv = start_http_server();
 617                 if (hsrv == NULL)
 618                         goto error;
 619         }
 620
 621         /* run the startup calls */
 622         afb_debug("start-call");
 623         run_startup_calls();
 624
 625         /* run the command */
 626         afb_debug("start-exec");
 627         if (execute_command() < 0)
 628                 goto error;
 629
 630         /* ready */
 631         sd_notify(1, "READY=1");
 632         return;
 633 error:
 634         exit(1);
 635 }
 636
 637 /*---------------------------------------------------------
 638  | main
 639  |   Parse option and launch action
 640  +--------------------------------------------------------- */
 641
 642 int main(int argc, char *argv[])
 643 {
 644         afb_debug("main-entry");
 645
 646         // let's run this program with a low priority
 647         nice(20);
 648
 649         sd_fds_init();
 650
 651         // ------------- Build session handler & init config -------
 652         config = afb_config_parse_arguments(argc, argv);
 653         if (config->name) {
 654                 verbose_set_name(config->name, 0);
 655                 process_name_set_name(config->name);
 656                 process_name_replace_cmdline(argv, config->name);
 657         }
 658         afb_debug("main-args");
 659
 660         // --------- run -----------
 661         if (config->background) {
 662                 // --------- in background mode -----------
 663                 INFO("entering background mode");
 664                 daemonize();
 665         } else {
 666                 // ---- in foreground mode --------------------
 667                 INFO("entering foreground mode");
 668         }
 669         INFO("running with pid %d", getpid());
 670
 671         /* set the daemon environment */
 672         setup_daemon();
 673
 674         afb_debug("main-start");
 675
 676         /* enter job processing */
 677         jobs_start(3, 0, 50, start);
 678         WARNING("hoops returned from jobs_enter! [report bug]");
 679         return 1;
 680 }
 681