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