chiark / gitweb /
fix zero overwrite
[innduct.git] / 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     warn("abandoning old feedfile after flush (%s), autodeferring",
194          why ? why : "took too long to complete");
195     assert(flushing_input_file);
196     autodefer_input_file(flushing_input_file);
197     return 1;
198
199   default:
200     return 0;
201   }
202 }
203
204 void statemc_period_poll(void) {
205   if (!until_flush) return;
206   until_flush--;
207   assert(until_flush>=0);
208
209   if (until_flush) return;
210   int ok= trigger_flush_ok(0);
211   assert(ok);
212 }
213
214 static int inputfile_is_done(InputFile *ipf) {
215   if (!ipf) return 0;
216   if (ipf->inprogress) return 0; /* new article in the meantime */
217   if (ipf->rd) return 0; /* not had EOF */
218   return 1;
219 }
220
221 static void notice_processed_counts(Counts *counts, int completed,
222                                     InputFile *ipf_xtra, const char *what) {
223
224 #define RCI_NOTHING(x) /* nothing */
225 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
226 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(counts->results, [RC_##x])
227
228 #define CNT(art,rc) (counts->results[art_##art][RC_##rc])
229
230   assert(!completed || ipf_xtra);
231
232   char *inprog= completed
233     ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
234     : xasprintf(" inprogress=%ld", ipf_xtra->inprogress);
235   char *autodefer= ipf_xtra && ipf_xtra->autodefer >= 0
236     ? xasprintf(" autodeferred=%ld", ipf_xtra->autodefer)
237     : xasprintf("%s","");
238
239   info("%s %s read=%d (+bl=%d,+err=%d)%s%s"
240        " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
241        RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
242        ,
243        completed?"completed":"processed", what,
244        counts->events[read_ok], counts->events[read_blank],
245          counts->events[read_err],
246        inprog, autodefer, counts->events[nooffer_missing],
247        CNT(Unchecked,sent) + CNT(Unsolicited,sent)
248        , CNT(Unchecked,sent), CNT(Unsolicited,sent),
249        CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
250        , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
251        RESULT_COUNTS(RCI_NOTHING,  RCI_TRIPLE_VALS)
252        );
253
254   memset(counts, 0, sizeof(*counts));
255
256   free(inprog);
257   free(autodefer);
258
259 #undef CNT
260 }
261
262 static void notice_processed_inputfile(InputFile *ipf, int completed,
263                                        const char *what) {
264   if (!ipf) return; /* allows showstats to be lazy */
265   notice_processed_counts(&ipf->counts, completed, ipf, what);
266 }
267
268 static void backlog_accumulate_counts(InputFile *ipf) {
269   int i,j;
270   if (!ipf) return;
271
272   for (i=0; i<art_MaxState; i++)
273     for (j=0; j<RCI_max; j++)
274       backlog_counts.results[i][j] += ipf->counts.results[i][j];
275
276   for (i=0; i<ECI_max; i++)
277     backlog_counts.events[i] += ipf->counts.events[i];
278
279   memset(&ipf->counts, 0, sizeof(ipf->counts));
280   backlog_counts_report= 1;
281 }
282
283 void statemc_check_backlog_done(void) {
284   InputFile *ipf= backlog_input_file;
285   if (!inputfile_is_done(ipf)) return;
286
287   backlog_accumulate_counts(ipf);
288   close_input_file(ipf);
289   if (unlink(ipf->path)) {
290     if (errno != ENOENT)
291       syscrash("could not unlink processed backlog file %s", ipf->path);
292     warn("backlog file %s vanished while we were reading it"
293          " so we couldn't remove it (but it's done now, anyway)",
294          ipf->path);
295   }
296   free(ipf);
297   backlog_input_file= 0;
298   search_backlog_file();
299   return;
300 }
301
302 void statemc_check_flushing_done(void) {
303   InputFile *ipf= flushing_input_file;
304   if (!inputfile_is_done(ipf)) return;
305
306   assert(sms==sm_SEPARATED || sms==sm_DROPPING);
307
308   notice_processed_inputfile(ipf,1,"feedfile");
309
310   close_defer();
311
312   xunlink(path_flushing, "old flushing file");
313
314   close_input_file(flushing_input_file);
315   free(flushing_input_file);
316   flushing_input_file= 0;
317
318   if (sms==sm_SEPARATED) {
319     notice("flush complete");
320     SMS(NORMAL, spontaneous_flush_periods, "flush complete");
321   } else if (sms==sm_DROPPING) {
322     SMS(DROPPED, max_separated_periods, "old flush complete");
323     search_backlog_file();
324     notice("feed dropped, but will continue until backlog is finished");
325   }
326 }
327
328 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
329                                       void *u) {
330   /* main input file may be idle but if so that's because
331    * we haven't got to it yet, but that doesn't mean it's really done */
332   statemc_check_flushing_done();
333   statemc_check_backlog_done();
334   return OOP_CONTINUE;
335 }
336
337 void queue_check_input_done(void) {
338   loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
339 }
340
341 void statemc_setstate(StateMachineState newsms, int periods,
342                       const char *forlog, const char *why) {
343   sms= newsms;
344   until_flush= periods;
345
346   const char *xtra= "";
347   switch (sms) {
348   case sm_FLUSHING:
349   case sm_FLUSHFAILED:
350     if (!main_input_file) xtra= "-ABSENT";
351     break;
352   case sm_SEPARATED:
353   case sm_DROPPING:
354     xtra= flushing_input_file->rd ? "-1" : "-2";
355     break;
356   default:;
357   }
358
359   if (periods) {
360     info("state %s%s[%d] %s",forlog,xtra,periods,why);
361   } else {
362     info("state %s%s %s",forlog,xtra,why);
363   }
364 }
365
366 /*========== flushing the feed ==========*/
367
368 pid_t inndcomm_child;
369 static int inndcomm_sentinel_fd;
370
371 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
372   assert(inndcomm_child);
373   assert(fd == inndcomm_sentinel_fd);
374   int status= xwaitpid(&inndcomm_child, "inndcomm");
375   inndcomm_child= 0;
376   
377   cancel_fd_read_except(fd);
378   xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
379   inndcomm_sentinel_fd= 0;
380
381   assert(!flushing_input_file);
382
383   if (WIFEXITED(status)) {
384     switch (WEXITSTATUS(status)) {
385
386     case INNDCOMMCHILD_ESTATUS_FAIL:
387       goto failed;
388
389     case INNDCOMMCHILD_ESTATUS_NONESUCH:
390       notice("feed has been dropped by innd, finishing up");
391       flushing_input_file= main_input_file;
392       tailing_make_readable(flushing_input_file);
393         /* we probably previously returned EAGAIN from our fake read method
394          * when in fact we were at EOF, so signal another readable event
395          * so we actually see the EOF */
396
397       main_input_file= 0;
398
399       if (flushing_input_file) {
400         SMS(DROPPING, max_separated_periods,
401             "feed dropped by innd, but must finish last flush");
402       } else {
403         close_defer();
404         SMS(DROPPED, 0, "feed dropped by innd");
405         search_backlog_file();
406       }
407       return OOP_CONTINUE;
408
409     case 0:
410       /* as above */
411       flushing_input_file= main_input_file;
412       tailing_make_readable(flushing_input_file);
413
414       main_input_file= open_input_file(feedfile);
415       if (!main_input_file)
416         crash("flush succeeded but feedfile %s does not exist!"
417               " (this probably means feedfile does not correspond"
418               " to site %s in newsfeeds)", feedfile, sitename);
419
420       if (flushing_input_file) {
421         SMS(SEPARATED, max_separated_periods, "flush complete");
422       } else {
423         close_defer();
424         SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
425       }
426       return OOP_CONTINUE;
427
428     default:
429       goto unexpected_exitstatus;
430
431     }
432   } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
433     warn("flush timed out trying to talk to innd");
434     goto failed;
435   } else {
436   unexpected_exitstatus:
437     report_child_status("inndcomm child", status);
438   }
439
440  failed:
441   SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
442   return OOP_CONTINUE;
443 }
444
445 static void inndcommfail(const char *what) {
446   syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
447   exit(INNDCOMMCHILD_ESTATUS_FAIL);
448 }
449
450 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
451   int pipefds[2];
452
453   notice("flushing %s",why);
454
455   assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
456   assert(!inndcomm_child);
457   assert(!inndcomm_sentinel_fd);
458
459   if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
460
461   inndcomm_child= xfork("inndcomm child");
462
463   if (!inndcomm_child) {
464     const char *flushargv[2]= { sitename, 0 };
465     char *reply;
466     int r;
467
468     xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
469     /* parent spots the autoclose of pipefds[1] when we die or exit */
470
471     if (simulate_flush>=0) {
472       warn("SIMULATING flush child status %d", simulate_flush);
473       if (simulate_flush>128) raise(simulate_flush-128);
474       else exit(simulate_flush);
475     }
476
477     alarm(inndcomm_flush_timeout);
478     r= ICCopen();                         if (r)   inndcommfail("connect");
479     r= ICCcommand('f',flushargv,&reply);  if (r<0) inndcommfail("transmit");
480     if (!r) exit(0); /* yay! */
481
482     if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
483     syswarn("innd ctlinnd flush failed: innd said %s", reply);
484     exit(INNDCOMMCHILD_ESTATUS_FAIL);
485   }
486
487   simulate_flush= -1;
488
489   xclose(pipefds[1], "inndcomm sentinel child's end",0);
490   inndcomm_sentinel_fd= pipefds[0];
491   assert(inndcomm_sentinel_fd);
492   on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
493
494   SMS(FLUSHING, 0, why);
495 }
496
497 /*---------- shutdown and signal handling ----------*/
498
499 void preterminate(void) {
500   if (in_child) return;
501   showstats();
502 }
503
504 void showstats(void) {
505   notice_processed_inputfile(main_input_file,     0, "feedfile");
506   notice_processed_inputfile(flushing_input_file, 0, "flushing");
507
508   backlog_accumulate_counts(backlog_input_file);
509   if (backlog_counts_report) {
510     notice_processed_counts(&backlog_counts, 0,
511                             backlog_input_file, "backlogs");
512     backlog_counts_report= 0;
513   }
514   until_stats_log= stats_log_periods;
515 }
516
517 static int signal_self_pipe[2];
518
519 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
520   assert(fd=signal_self_pipe[0]);
521   char buf[PIPE_BUF];
522   int r= read(signal_self_pipe[0], buf, sizeof(buf));
523   if (r<0 && !isewouldblock(errno))
524     syscrash("failed to read signal self pipe");
525   if (r==0) crash("eof on signal self pipe");
526   if (terminate_sig_flag) {
527     preterminate();
528     notice("terminating (%s)", strsignal(terminate_sig_flag));
529     raise_default(terminate_sig_flag);
530   }
531   return OOP_CONTINUE;
532 }
533
534 static void sigarrived_handler(int signum) {
535   static char x;
536   switch (signum) {
537   case SIGTERM:
538   case SIGINT:
539     if (!terminate_sig_flag) terminate_sig_flag= signum;
540     break;
541   default:
542     abort();
543   }
544   write(signal_self_pipe[1],&x,1);
545 }
546
547 void init_signals(void) {
548   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
549     syscrash("could not ignore SIGPIPE");
550
551   if (pipe(signal_self_pipe)) sysdie("create self-pipe for signals");
552
553   xsetnonblock(signal_self_pipe[0],1);
554   xsetnonblock(signal_self_pipe[1],1);
555
556   struct sigaction sa;
557   memset(&sa,0,sizeof(sa));
558   sa.sa_handler= sigarrived_handler;
559   sa.sa_flags= SA_RESTART;
560   xsigaction(SIGTERM,&sa);
561   xsigaction(SIGINT,&sa);
562
563   on_fd_read_except(signal_self_pipe[0], sigarrived_event);
564 }
565