statemc.c

   1 /*
   2  *  innduct
   3  *  tailing reliable realtime streaming feeder for inn
   4  *  statemc.c - state machine core (see README.states).
   5  *
   6  *  Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
   7  *
   8  *  This program is free software: you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation, either version 3 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20  *
  21  *  (I believe that when you compile and link this as part of the inn2
  22  *  build, with the Makefile runes I have provided, all the libraries
  23  *  and files which end up included in innduct are licence-compatible
  24  *  with GPLv3.  If not then please let me know.  -Ian Jackson.)
  25  */
  26
  27 #include "innduct.h"
  28
  29
  30 /* statemc_init initialises */
  31 StateMachineState sms;
  32 int until_flush;
  33 InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
  34 Counts backlog_counts;
  35 int backlog_counts_report;
  36 FILE *defer;
  37
  38 /* initialisation to 0 is good */
  39 int until_connect, until_backlog_nextscan;
  40 double accept_proportion;
  41 int nocheck, nocheck_reported, in_child;
  42 sig_atomic_t terminate_sig_flag;
  43
  44
  45 static void startup_set_input_file(InputFile *f) {
  46   assert(!main_input_file);
  47   main_input_file= f;
  48   inputfile_reading_start(f);
  49 }
  50
  51 void statemc_lock(void) {
  52   int lockfd;
  53   struct stat stab, stabf;
  54
  55   for (;;) {
  56     lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
  57     if (lockfd<0) sysdie("open lockfile %s", path_lock);
  58
  59     struct flock fl;
  60     memset(&fl,0,sizeof(fl));
  61     fl.l_type= F_WRLCK;
  62     fl.l_whence= SEEK_SET;
  63     int r= fcntl(lockfd, F_SETLK, &fl);
  64     if (r==-1) {
  65       if (errno==EACCES || isewouldblock(errno)) {
  66         if (quiet_multiple) exit(0);
  67         die("another duct holds the lockfile");
  68       }
  69       sysdie("fcntl F_SETLK lockfile %s", path_lock);
  70     }
  71
  72     xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
  73     int lock_noent;
  74     xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
  75
  76     if (!lock_noent && samefile(&stab, &stabf))
  77       break;
  78
  79     xclose(lockfd, "stale lockfile ", path_lock);
  80   }
  81
  82   FILE *lockfile= fdopen(lockfd, "w");
  83   if (!lockfile) syscrash("fdopen lockfile");
  84
  85   int r= ftruncate(lockfd, 0);
  86   if (r) syscrash("truncate lockfile to write new info");
  87
  88   if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
  89               (unsigned long)self_pid,
  90               sitename, feedfile, remote_host) == EOF ||
  91       fflush(lockfile))
  92     sysdie("write info to lockfile %s", path_lock);
  93
  94   dbg("startup: locked");
  95 }
  96
  97 void statemc_init(void) {
  98   struct stat stabdefer;
  99
 100   search_backlog_file();
 101
 102   int defer_noent;
 103   xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
 104   if (defer_noent) {
 105     dbg("startup: ductdefer ENOENT");
 106   } else {
 107     dbg("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
 108     switch (stabdefer.st_nlink==1) {
 109     case 1:
 110       open_defer(); /* so that we will later close it and rename it */
 111       break;
 112     case 2:
 113       xunlink(path_defer, "stale defer file link"
 114               " (presumably hardlink to backlog file)");
 115       break;
 116     default:
 117       crash("defer file %s has unexpected link count %d",
 118             path_defer, stabdefer.st_nlink);
 119     }
 120   }
 121
 122   struct stat stab_f, stab_d;
 123   int noent_f;
 124
 125   InputFile *file_d= open_input_file(path_flushing);
 126   if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
 127
 128   xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
 129
 130   if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
 131     dbg("startup: F==D => Hardlinked");
 132     xunlink(feedfile, "feed file (during startup)"); /* => Moved */
 133     noent_f= 1;
 134   }
 135
 136   if (noent_f) {
 137     dbg("startup: F ENOENT => Moved");
 138     if (file_d) startup_set_input_file(file_d);
 139     spawn_inndcomm_flush("feedfile missing at startup");
 140     /* => Flushing, sms:=FLUSHING */
 141   } else {
 142     if (file_d) {
 143       dbg("startup: F!=D => Separated");
 144       startup_set_input_file(file_d);
 145       flushing_input_file= main_input_file;
 146       main_input_file= open_input_file(feedfile);
 147       if (!main_input_file) crash("feedfile vanished during startup");
 148       SMS(SEPARATED, max_separated_periods,
 149           "found both old and current feed files");
 150     } else {
 151       dbg("startup: F exists, D ENOENT => Normal");
 152       InputFile *file_f= open_input_file(feedfile);
 153       if (!file_f) crash("feed file vanished during startup");
 154       startup_set_input_file(file_f);
 155       SMS(NORMAL, spontaneous_flush_periods, "normal startup");
 156     }
 157   }
 158 }
 159
 160 void statemc_start_flush(const char *why) { /* Normal => Flushing */
 161   assert(sms == sm_NORMAL);
 162
 163   dbg("starting flush (%s) (%lu >?= %lu) (%d)",
 164         why,
 165         (unsigned long)(main_input_file ? main_input_file->offset : 0),
 166         (unsigned long)target_max_feedfile_size,
 167         until_flush);
 168
 169   int r= link(feedfile, path_flushing);
 170   if (r) sysdie("link feedfile %s to flushing file %s",
 171                 feedfile, path_flushing);
 172   /* => Hardlinked */
 173
 174   xunlink(feedfile, "old feedfile link");
 175   /* => Moved */
 176
 177   spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
 178 }
 179
 180 int trigger_flush_ok(const char *why) {
 181   switch (sms) {
 182
 183   case sm_NORMAL:
 184     statemc_start_flush(why ? why : "periodic");
 185     return 1;                           /* Normal => Flushing; => FLUSHING */
 186
 187   case sm_FLUSHFAILED:
 188     spawn_inndcomm_flush(why ? why : "retry");
 189     return 1;                            /* Moved => Flushing; => FLUSHING */
 190
 191   case sm_SEPARATED:
 192   case sm_DROPPING:
 193     if (conns.count)
 194       warn("abandoning old feedfile after flush (%s), autodeferring",
 195            why ? why : "took too long to complete");
 196     else
 197       info("autodeferring after flush (%s)",
 198            why ? why : "no connections");
 199     assert(flushing_input_file);
 200     autodefer_input_file(flushing_input_file);
 201     return 1;
 202
 203   default:
 204     return 0;
 205   }
 206 }
 207
 208 void statemc_period_poll(void) {
 209   if (!until_flush) return;
 210   until_flush--;
 211   assert(until_flush>=0);
 212
 213   if (until_flush) return;
 214   int ok= trigger_flush_ok(0);
 215   assert(ok);
 216 }
 217
 218 static int inputfile_is_done(InputFile *ipf) {
 219   if (!ipf) return 0;
 220   if (ipf->inprogress) return 0; /* new article in the meantime */
 221   if (ipf->rd) return 0; /* not had EOF */
 222   return 1;
 223 }
 224
 225 static void notice_processed_counts(Counts *counts, int completed,
 226                                     InputFile *ipf_xtra, const char *what) {
 227
 228 #define RCI_NOTHING(x) /* nothing */
 229 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
 230 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(counts->results, [RC_##x])
 231
 232 #define CNT(art,rc) (counts->results[art_##art][RC_##rc])
 233
 234   char *inprog= ipf_xtra && !completed
 235     ? xasprintf(" inprogress=%ld", ipf_xtra->inprogress)
 236     : xasprintf("%s",""); /* GCC produces a stupid warning for printf("") ! */
 237   char *autodefer= ipf_xtra && ipf_xtra->autodefer >= 0
 238     ? xasprintf(" autodeferred=%ld", ipf_xtra->autodefer)
 239     : xasprintf("%s","");
 240
 241   notice("%s %s read=%d (+bl=%d,+err=%d)%s%s"
 242        " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
 243        RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
 244        ,
 245        completed?"completed":"processed", what,
 246        counts->events[read_ok], counts->events[read_blank],
 247          counts->events[read_err],
 248        inprog, autodefer, counts->events[nooffer_missing],
 249        CNT(Unchecked,sent) + CNT(Unsolicited,sent)
 250        , CNT(Unchecked,sent), CNT(Unsolicited,sent),
 251        CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
 252        , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
 253        RESULT_COUNTS(RCI_NOTHING,  RCI_TRIPLE_VALS)
 254        );
 255
 256   memset(counts, 0, sizeof(*counts));
 257
 258   free(inprog);
 259   free(autodefer);
 260
 261 #undef CNT
 262 }
 263
 264 static void notice_processed_inputfile(InputFile *ipf, int completed,
 265                                        const char *what) {
 266   if (!ipf) return; /* allows showstats to be lazy */
 267   notice_processed_counts(&ipf->counts, completed, ipf, what);
 268 }
 269
 270 static void backlog_accumulate_counts(InputFile *ipf) {
 271   int i,j;
 272   if (!ipf) return;
 273
 274   for (i=0; i<art_MaxState; i++)
 275     for (j=0; j<RCI_max; j++)
 276       backlog_counts.results[i][j] += ipf->counts.results[i][j];
 277
 278   for (i=0; i<ECI_max; i++)
 279     backlog_counts.events[i] += ipf->counts.events[i];
 280
 281   memset(&ipf->counts, 0, sizeof(ipf->counts));
 282   backlog_counts_report= 1;
 283 }
 284
 285 void statemc_check_backlog_done(void) {
 286   InputFile *ipf= backlog_input_file;
 287   if (!inputfile_is_done(ipf)) return;
 288
 289   backlog_accumulate_counts(ipf);
 290   close_input_file(ipf);
 291   if (unlink(ipf->path)) {
 292     if (errno != ENOENT)
 293       syscrash("could not unlink processed backlog file %s", ipf->path);
 294     warn("backlog file %s vanished while we were reading it"
 295          " so we couldn't remove it (but it's done now, anyway)",
 296          ipf->path);
 297   }
 298   free(ipf);
 299   backlog_input_file= 0;
 300   search_backlog_file();
 301   return;
 302 }
 303
 304 void statemc_check_flushing_done(void) {
 305   InputFile *ipf= flushing_input_file;
 306   if (!inputfile_is_done(ipf)) return;
 307
 308   assert(sms==sm_SEPARATED || sms==sm_DROPPING);
 309
 310   notice_processed_inputfile(ipf,1,"batch");
 311
 312   close_defer();
 313
 314   xunlink(path_flushing, "old flushing file");
 315
 316   close_input_file(flushing_input_file);
 317   free(flushing_input_file);
 318   flushing_input_file= 0;
 319
 320   if (sms==sm_SEPARATED) {
 321     notice("flush complete");
 322     SMS(NORMAL, spontaneous_flush_periods, "flush complete");
 323   } else if (sms==sm_DROPPING) {
 324     SMS(DROPPED, max_separated_periods, "old flush complete");
 325     search_backlog_file();
 326     notice("feed dropped, but will continue until backlog is finished");
 327   }
 328 }
 329
 330 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
 331                                       void *u) {
 332   /* main input file may be idle but if so that's because
 333    * we haven't got to it yet, but that doesn't mean it's really done */
 334   statemc_check_flushing_done();
 335   statemc_check_backlog_done();
 336   return OOP_CONTINUE;
 337 }
 338
 339 void queue_check_input_done(void) {
 340   loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
 341 }
 342
 343 void statemc_setstate(StateMachineState newsms, int periods,
 344                       const char *forlog, const char *why) {
 345   sms= newsms;
 346   until_flush= periods;
 347
 348   const char *xtra= "";
 349   switch (sms) {
 350   case sm_FLUSHING:
 351   case sm_FLUSHFAILED:
 352     if (!main_input_file) xtra= "-ABSENT";
 353     break;
 354   case sm_SEPARATED:
 355   case sm_DROPPING:
 356     xtra= flushing_input_file->rd ? "-1" : "-2";
 357     break;
 358   default:;
 359   }
 360
 361   if (periods) {
 362     info("state %s%s[%d] %s",forlog,xtra,periods,why);
 363   } else {
 364     info("state %s%s %s",forlog,xtra,why);
 365   }
 366 }
 367
 368 /*========== flushing the feed ==========*/
 369
 370 pid_t inndcomm_child;
 371 static int inndcomm_sentinel_fd;
 372
 373 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
 374   assert(inndcomm_child);
 375   assert(fd == inndcomm_sentinel_fd);
 376   int status= xwaitpid(&inndcomm_child, "inndcomm");
 377   inndcomm_child= 0;
 378
 379   cancel_fd_read_except(fd);
 380   xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
 381   inndcomm_sentinel_fd= 0;
 382
 383   assert(!flushing_input_file);
 384
 385   if (WIFEXITED(status)) {
 386     switch (WEXITSTATUS(status)) {
 387
 388     case INNDCOMMCHILD_ESTATUS_FAIL:
 389       goto failed;
 390
 391     case INNDCOMMCHILD_ESTATUS_NONESUCH:
 392       notice("feed has been dropped by innd, finishing up");
 393       flushing_input_file= main_input_file;
 394       tailing_make_readable(flushing_input_file);
 395         /* we probably previously returned EAGAIN from our fake read method
 396          * when in fact we were at EOF, so signal another readable event
 397          * so we actually see the EOF */
 398
 399       main_input_file= 0;
 400
 401       if (flushing_input_file) {
 402         SMS(DROPPING, max_separated_periods,
 403             "feed dropped by innd, but must finish last flush");
 404       } else {
 405         close_defer();
 406         SMS(DROPPED, 0, "feed dropped by innd");
 407         search_backlog_file();
 408       }
 409       return OOP_CONTINUE;
 410
 411     case 0:
 412       /* as above */
 413       flushing_input_file= main_input_file;
 414       tailing_make_readable(flushing_input_file);
 415
 416       main_input_file= open_input_file(feedfile);
 417       if (!main_input_file)
 418         crash("flush succeeded but feedfile %s does not exist!"
 419               " (this probably means feedfile does not correspond"
 420               " to site %s in newsfeeds)", feedfile, sitename);
 421
 422       if (flushing_input_file) {
 423         SMS(SEPARATED, max_separated_periods, "flush complete");
 424       } else {
 425         close_defer();
 426         SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
 427       }
 428       return OOP_CONTINUE;
 429
 430     default:
 431       goto unexpected_exitstatus;
 432
 433     }
 434   } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
 435     warn("flush timed out trying to talk to innd");
 436     goto failed;
 437   } else {
 438   unexpected_exitstatus:
 439     report_child_status("inndcomm child", status);
 440   }
 441
 442  failed:
 443   SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
 444   return OOP_CONTINUE;
 445 }
 446
 447 static void inndcommfail(const char *what) {
 448   syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
 449   exit(INNDCOMMCHILD_ESTATUS_FAIL);
 450 }
 451
 452 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
 453   int pipefds[2];
 454
 455   notice("flushing %s",why);
 456
 457   assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
 458   assert(!inndcomm_child);
 459   assert(!inndcomm_sentinel_fd);
 460
 461   if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
 462
 463   inndcomm_child= xfork("inndcomm child");
 464
 465   if (!inndcomm_child) {
 466     const char *flushargv[2]= { sitename, 0 };
 467     char *reply;
 468     int r;
 469
 470     xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
 471     /* parent spots the autoclose of pipefds[1] when we die or exit */
 472
 473     if (simulate_flush>=0) {
 474       warn("SIMULATING flush child status %d", simulate_flush);
 475       if (simulate_flush>128) raise(simulate_flush-128);
 476       else exit(simulate_flush);
 477     }
 478
 479     alarm(inndcomm_flush_timeout);
 480     r= ICCopen();                         if (r)   inndcommfail("connect");
 481     r= ICCcommand('f',flushargv,&reply);  if (r<0) inndcommfail("transmit");
 482     if (!r) exit(0); /* yay! */
 483
 484     if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
 485     syswarn("innd ctlinnd flush failed: innd said %s", reply);
 486     exit(INNDCOMMCHILD_ESTATUS_FAIL);
 487   }
 488
 489   simulate_flush= -1;
 490
 491   xclose(pipefds[1], "inndcomm sentinel child's end",0);
 492   inndcomm_sentinel_fd= pipefds[0];
 493   assert(inndcomm_sentinel_fd);
 494   on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
 495
 496   SMS(FLUSHING, 0, why);
 497 }
 498
 499 /*---------- shutdown and signal handling ----------*/
 500
 501 void preterminate(void) {
 502   if (in_child) return;
 503   showstats();
 504 }
 505
 506 void showstats(void) {
 507   notice_conns_stats();
 508   notice_processed_inputfile(main_input_file,     0, "feedfile");
 509   notice_processed_inputfile(flushing_input_file, 0, "flushing");
 510
 511   backlog_accumulate_counts(backlog_input_file);
 512   if (backlog_counts_report) {
 513     notice_processed_counts(&backlog_counts, 0,
 514                             backlog_input_file, "backlogs");
 515     backlog_counts_report= 0;
 516   }
 517   until_stats_log= stats_log_periods;
 518 }
 519
 520 static int signal_self_pipe[2];
 521
 522 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
 523   assert(fd=signal_self_pipe[0]);
 524   char buf[PIPE_BUF];
 525   int r= read(signal_self_pipe[0], buf, sizeof(buf));
 526   if (r<0 && !isewouldblock(errno))
 527     syscrash("failed to read signal self pipe");
 528   if (r==0) crash("eof on signal self pipe");
 529   if (terminate_sig_flag) {
 530     preterminate();
 531     notice("terminating (%s)", strsignal(terminate_sig_flag));
 532     raise_default(terminate_sig_flag);
 533   }
 534   return OOP_CONTINUE;
 535 }
 536
 537 static void sigarrived_handler(int signum) {
 538   static char x;
 539   switch (signum) {
 540   case SIGTERM:
 541   case SIGINT:
 542     if (!terminate_sig_flag) terminate_sig_flag= signum;
 543     break;
 544   default:
 545     abort();
 546   }
 547   write(signal_self_pipe[1],&x,1);
 548 }
 549
 550 void init_signals(void) {
 551   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
 552     syscrash("could not ignore SIGPIPE");
 553
 554   if (pipe(signal_self_pipe)) sysdie("create self-pipe for signals");
 555
 556   xsetnonblock(signal_self_pipe[0],1);
 557   xsetnonblock(signal_self_pipe[1],1);
 558
 559   struct sigaction sa;
 560   memset(&sa,0,sizeof(sa));
 561   sa.sa_handler= sigarrived_handler;
 562   sa.sa_flags= SA_RESTART;
 563   xsigaction(SIGTERM,&sa);
 564   xsigaction(SIGINT,&sa);
 565
 566   on_fd_read_except(signal_self_pipe[0], sigarrived_event);
 567 }
 568