3 * tailing reliable realtime streaming feeder for inn
5 * Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * (I believe that when you compile and link this as part of the inn2
21 * build, with the Makefile runes I have provided, all the libraries
22 * and files which end up included in innduct are licence-compatible
23 * with GPLv3. If not then please let me know. -Ian Jackson.)
27 * Newsfeeds file entries should look like this:
28 * host.name.of.site[/exclude,exclude,...]\
29 * :pattern,pattern...[/distribution,distribution...]\
33 * sitename[/exclude,exclude,...]\
34 * :pattern,pattern...[/distribution,distribution...]\
40 * or might be blanked out
41 * <spc><spc><spc><spc>....
43 * F site.name main feed file
44 * opened/created, then written, by innd
47 * tokens blanked out by duct when processed
48 * site.name_lock lock preventing multiple ducts
49 * to hold lock must open,F_SETLK[W]
50 * and then stat to check that locked file
51 * still has name site.name_lock
52 * holder of this lock is "duct"
53 * (only) lockholder may remove the lockfile
54 * D site.name_flushing temporary feed file during flush (or crash)
55 * hardlink created by duct
57 * site.name_defer 431'd articles, still being written,
58 * created, written, used by duct
60 * site.name_backlog.<date>.<inum>
61 * 431'd articles, ready for innxmit or duct
62 * created (link/mv) by duct
63 * site.name_backlog<anything-else> (where <anything-else> does not
64 * contain '#' or '~') eg
65 * site.name_backlog.manual
66 * anything the sysadmin likes (eg, feed files
67 * from old feeds to be merged into this one)
68 * created (link/mv) by admin
69 * may be symlinks (in which case links
70 * may be written through, but only links
73 * It is safe to remove backlog files manually,
74 * if it's desired to throw away the backlog.
76 * Backlog files are also processed by innduct. We find the oldest
77 * backlog file which is at least a certain amount old, and feed it
78 * back into our processing. When every article in it has been read
79 * and processed, we unlink it and look for another backlog file.
81 * If we don't have a backlog file that we're reading, we close the
82 * defer file that we're writing and make it into a backlog file at
83 * the first convenient opportunity.
94 | | <----------------<---------------------------------'|
100 | F: innd writing, duct reading |
103 | | duct decides time to flush |
104 | | duct makes hardlink |
106 | V <------------------------'|
108 | F == D: innd writing, duct reading both exist |
111 | | <-----------<-------------<--'|
112 | | open D F ENOENT |
115 | V <---------------------. |
118 | D: innd writing, duct reading; or ENOENT | |
120 | | duct requests flush of feed | |
121 | | (others can too, harmlessly) | |
125 | D: innd flushing, duct; or ENOENT | |
127 | | inndcomm flush fails | |
128 | |`-------------------------->------------------' |
130 | | inndcomm reports no such site |
131 | |`---------------------------------------------------- | -.
133 | | innd finishes writing D, creates F | |
134 | | inndcomm reports flush successful | |
137 | Separated <----------------' |
138 | F: innd writing F!=D /
139 | D: duct reading; or ENOENT both exist /
141 | | duct gets to the end of D /
142 | | duct opens F too /
145 | F: innd writing, duct reading |
146 | D: duct finishing V
148 | | duct finishes processing D F: ENOENT
149 | V duct unlinks D D: duct reading
151 `--<--' | duct finishes
161 "duct reading" means innduct is reading the file but also
162 overwriting processed tokens.
166 * rune for printing diagrams:
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
173 /*============================== PROGRAM ==============================*/
175 #define _GNU_SOURCE 1
181 #include "inndcomm.h"
183 #include "inn/list.h"
184 #include "inn/innconf.h"
187 #include <sys/types.h>
188 #include <sys/wait.h>
189 #include <sys/stat.h>
190 #include <sys/socket.h>
209 #include <oop-read.h>
211 /*----- general definitions, probably best not changed -----*/
213 #define CONNCHILD_ESTATUS_STREAM 24
214 #define CONNCHILD_ESTATUS_NOSTREAM 25
216 #define INNDCOMMCHILD_ESTATUS_FAIL 26
217 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
219 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
220 #define MAX_CLI_COMMAND 1000
222 #define VA va_list al; va_start(al,fmt)
223 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
224 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
225 #define NORET __attribute__((__noreturn__))
227 #define NEW(ptr) ((ptr)= zmmalloc(sizeof(*(ptr))))
228 #define NEW_DECL(type,ptr) type ptr = zmmalloc(sizeof(*(ptr)))
230 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
232 #define FOR_CONN(conn) \
233 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
235 /*----- doubly linked lists -----*/
237 #define ISNODE(T) struct node list_node
240 union { struct list li; T *for_type; } u; \
244 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
246 #define LIST_CHECKCANHAVENODE(l,n) \
247 ((void)((n) == ((l).u.for_type))) /* just for the type check */
249 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
250 ( LIST_CHECKCANHAVENODE(l,n), \
251 list_addsomehow(&(l).u.li, NODE((n))), \
255 #define LIST_REMSOMEHOW(l,list_remsomehow) \
256 ( (typeof((l).u.for_type)) \
259 list_remsomehow(&(l).u.li) ) \
265 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
266 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
267 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
268 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
270 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
271 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
272 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
273 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
275 #define LIST_REMOVE(l,n) \
276 ( LIST_CHECKCANHAVENODE(l,n), \
277 list_remove(NODE((n))), \
281 #define LIST_INSERT(l,n,pred) \
282 ( LIST_CHECKCANHAVENODE(l,n), \
283 LIST_CHECKCANHAVENODE(l,pred), \
284 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
288 /*----- type predeclarations -----*/
290 typedef struct Conn Conn;
291 typedef struct Article Article;
292 typedef struct InputFile InputFile;
293 typedef struct XmitDetails XmitDetails;
294 typedef struct Filemon_Perfile Filemon_Perfile;
295 typedef enum StateMachineState StateMachineState;
296 typedef struct CliCommand CliCommand;
301 /*----- function predeclarations -----*/
303 static void conn_maybe_write(Conn *conn);
304 static void conn_make_some_xmits(Conn *conn);
305 static void *conn_write_some_xmits(Conn *conn);
307 static void xmit_free(XmitDetails *d);
309 #define SMS(newstate, periods, why) \
310 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
311 static void statemc_setstate(StateMachineState newsms, int periods,
312 const char *forlog, const char *why);
314 static void statemc_start_flush(const char *why); /* Normal => Flushing */
315 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
316 static int trigger_flush_ok(const char *why /* 0 means timeout */);
317 /* => Flushing,FLUSHING, ret 1; or ret 0 */
319 static void article_done(Article *art, int whichcount);
321 static void check_assign_articles(void);
322 static void queue_check_input_done(void);
323 static void check_reading_pause_resume(InputFile *ipf);
325 static void statemc_check_flushing_done(void);
326 static void statemc_check_backlog_done(void);
328 static void postfork(void);
329 static void period(void);
331 static void open_defer(void);
332 static void close_defer(void);
333 static void search_backlog_file(void);
334 static void preterminate(void);
335 static void raise_default(int signo) NORET;
336 static char *debug_report_ipf(InputFile *ipf);
338 static void inputfile_reading_start(InputFile *ipf);
339 static void inputfile_reading_stop(InputFile *ipf);
340 static void inputfile_reading_pause(InputFile *ipf);
341 static void inputfile_reading_resume(InputFile *ipf);
342 /* pause and resume are idempotent, and no-op if not done _reading_start */
344 static void filemon_start(InputFile *ipf);
345 static void filemon_stop(InputFile *ipf);
346 static void tailing_make_readable(InputFile *ipf);
348 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
349 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
351 static const oop_rd_style peer_rd_style;
352 static oop_rd_call peer_rd_err, peer_rd_ok;
355 /*----- configuration options -----*/
356 /* when changing defaults, remember to update the manpage */
358 static const char *sitename, *remote_host;
359 static const char *feedfile, *path_run, *path_cli, *path_cli_dir;
360 static int quiet_multiple=0;
361 static int interactive=0, try_filemon=1;
362 static int try_stream=1;
364 static const char *inndconffile;
366 static int max_connections=10;
367 static int max_queue_per_conn=200;
368 static int target_max_feedfile_size=100000;
369 static int period_seconds=30;
370 static int filepoll_seconds=5;
371 static int max_queue_per_ipf=-1;
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
376 static double nocheck_thresh= 95.0; /* converted from percentage by main */
377 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=100;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
387 static int lowvol_thresh=3;
388 static int lowvol_periods=1000;
390 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
391 static int max_bad_data_initial= 30;
392 /* in one corrupt 4096-byte block the number of newlines has
393 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
396 /*----- statistics -----*/
398 typedef enum { /* in queue in conn->sent */
399 art_Unchecked, /* not checked, not sent checking */
400 art_Wanted, /* checked, wanted sent body as requested */
401 art_Unsolicited, /* - sent body without check */
405 static const char *const artstate_names[]=
406 { "Unchecked", "Wanted", "Unsolicited", 0 };
408 #define RESULT_COUNTS(RCS,RCN) \
417 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
418 #define RCI_TRIPLE_VALS_BASE(counts,x) \
419 counts[art_Unchecked] x \
420 + counts[art_Wanted] x \
421 + counts[art_Unsolicited] x, \
422 counts[art_Unchecked] x \
423 , counts[art_Wanted] x \
424 , counts[art_Unsolicited] x
427 #define RC_INDEX(x) RC_##x,
428 RESULT_COUNTS(RC_INDEX, RC_INDEX)
433 /*----- transmission buffers -----*/
449 /*----- core operational data structure types -----*/
452 /* This is also an instance of struct oop_readable */
453 struct oop_readable readable; /* first */
454 oop_readable_call *readable_callback;
455 void *readable_callback_user;
458 Filemon_Perfile *filemon;
460 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
462 int skippinglong, paused, fake_readable;
465 long inprogress; /* includes queue.count and also articles in conns */
466 long autodefer; /* -1 means not doing autodefer */
468 int counts[art_MaxState][RCI_max];
469 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
484 #define SMS_LIST(X) \
492 enum StateMachineState {
493 #define SMS_DEF_ENUM(s) sm_##s,
494 SMS_LIST(SMS_DEF_ENUM)
497 static const char *sms_names[]= {
498 #define SMS_DEF_NAME(s) #s ,
499 SMS_LIST(SMS_DEF_NAME)
505 int fd; /* may be 0, meaning closed (during construction/destruction) */
506 oop_read *rd; /* likewise */
507 int oopwriting; /* since on_fd is not idempotent */
508 int max_queue, stream;
509 const char *quitting;
510 int since_activity; /* periods */
511 ArticleList waiting; /* not yet told peer */
512 ArticleList priority; /* peer says send it now */
513 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
514 struct iovec xmit[CONNIOVS];
515 XmitDetails xmitd[CONNIOVS];
520 /*----- general operational variables -----*/
522 /* main initialises */
523 static oop_source *loop;
524 static ConnList conns;
525 static char *path_lock, *path_flushing, *path_defer, *path_dump;
526 static char *globpat_backlog;
527 static pid_t self_pid;
528 static int *lowvol_perperiod;
529 static int lowvol_circptr;
530 static int lowvol_total; /* does not include current period */
532 /* statemc_init initialises */
533 static StateMachineState sms;
534 static int until_flush;
535 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
538 /* initialisation to 0 is good */
539 static int until_connect, until_backlog_nextscan;
540 static double accept_proportion;
541 static int nocheck, nocheck_reported, in_child;
543 /* for simulation, debugging, etc. */
544 int simulate_flush= -1;
546 /*========== logging ==========*/
548 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
549 static void logcore(int sysloglevel, const char *fmt, ...) {
551 if (interactive < 2) {
552 vsyslog(sysloglevel,fmt,al);
554 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
555 vfprintf(stderr,fmt,al);
561 static void logv(int sysloglevel, const char *pfx, int errnoval,
562 const char *fmt, va_list al) PRINTF(5,0);
563 static void logv(int sysloglevel, const char *pfx, int errnoval,
564 const char *fmt, va_list al) {
565 char msgbuf[1024]; /* NB do not call mvasprintf here or you'll recurse */
566 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
567 msgbuf[sizeof(msgbuf)-1]= 0;
569 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
570 sysloglevel= LOG_ERR; /* run by wrong user, probably */
572 logcore(sysloglevel, "<%s>%s: %s%s%s",
573 sitename, pfx, msgbuf,
574 errnoval>=0 ? ": " : "",
575 errnoval>=0 ? strerror(errnoval) : "");
578 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
579 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
580 static void fn(const char *fmt, ...) { \
583 logv(sysloglevel, pfx, err, fmt, al); \
587 #define logwrap(fn, pfx, sysloglevel, err) \
588 static void fn(const char *fmt, ...) PRINTF(1,2); \
589 static void fn(const char *fmt, ...) { \
591 logv(sysloglevel, pfx, err, fmt, al); \
595 diewrap(syscrash, " critical", LOG_CRIT, errno, 16);
596 diewrap(crash, " critical", LOG_CRIT, -1, 16);
598 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
599 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
601 logwrap(syswarn, " warning", LOG_WARNING, errno);
602 logwrap(warn, " warning", LOG_WARNING, -1);
604 logwrap(notice, " notice", LOG_NOTICE, -1);
605 logwrap(info, " info", LOG_INFO, -1);
606 logwrap(debug, " debug", LOG_DEBUG, -1);
609 /*========== utility functions etc. ==========*/
611 /* error trapping wrappers are called mfoo rather than the more
612 * conventional xfoo because we don't want to clash with the existing
613 * xfoo functions in INN libs which use different error handlers
616 static char *mvasprintf(const char *fmt, va_list al) PRINTF(1,0);
617 static char *mvasprintf(const char *fmt, va_list al) {
619 int rc= vasprintf(&str,fmt,al);
620 if (rc<0) sysfatal("vasprintf(\"%s\",...) failed", fmt);
623 static char *masprintf(const char *fmt, ...) PRINTF(1,2);
624 static char *masprintf(const char *fmt, ...) {
626 char *str= mvasprintf(fmt,al);
631 static int close_perhaps(int *fd) {
632 if (*fd <= 0) return 0;
637 static void mclose(int fd, const char *what, const char *what2) {
639 if (r) syscrash("close %s%s",what,what2?what2:"");
641 static void mclose_perhaps(int *fd, const char *what, const char *what2) {
642 if (*fd <= 0) return;
643 mclose(*fd,what,what2);
647 static pid_t mfork(const char *what) {
651 if (child==-1) sysfatal("cannot fork for %s",what);
652 debug("forked %s %ld", what, (unsigned long)child);
653 if (!child) postfork();
657 static void on_fd_read_except(int fd, oop_call_fd callback) {
658 loop->on_fd(loop, fd, OOP_READ, callback, 0);
659 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
661 static void cancel_fd_read_except(int fd) {
662 loop->cancel_fd(loop, fd, OOP_READ);
663 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
666 static void report_child_status(const char *what, int status) {
667 if (WIFEXITED(status)) {
668 int es= WEXITSTATUS(status);
670 warn("%s: child died with error exit status %d", what, es);
671 } else if (WIFSIGNALED(status)) {
672 int sig= WTERMSIG(status);
673 const char *sigstr= strsignal(sig);
674 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
676 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
678 warn("%s: child died due to unknown fatal signal %d%s",
679 what, sig, coredump);
681 warn("%s: child died with unknown wait status %d", what,status);
685 static int mwaitpid(pid_t *pid, const char *what) {
688 int r= kill(*pid, SIGKILL);
689 if (r) syscrash("cannot kill %s child", what);
691 pid_t got= waitpid(*pid, &status, 0);
692 if (got==-1) syscrash("cannot reap %s child", what);
693 if (got==0) crash("cannot reap %s child", what);
700 static void *mmalloc(size_t sz) {
702 if (!p) sysfatal("unable to malloc %lu bytes",(unsigned long)sz);
706 static void *zmmalloc(size_t sz) {
707 void *p= mmalloc(sz);
712 static void munlink(const char *path, const char *what) {
714 if (r) syscrash("can't unlink %s %s", path, what);
717 static time_t mtime(void) {
719 if (now==-1) syscrash("time(2) failed");
723 static void msigaction(int signo, const struct sigaction *sa) {
724 int r= sigaction(signo,sa,0);
725 if (r) syscrash("sigaction failed for \"%s\"", strsignal(signo));
728 static void msigsetdefault(int signo) {
730 memset(&sa,0,sizeof(sa));
731 sa.sa_handler= SIG_DFL;
732 msigaction(signo,&sa);
735 static void mgettimeofday(struct timeval *tv_r) {
736 int r= gettimeofday(tv_r,0);
737 if (r) syscrash("gettimeofday(2) failed");
740 static void msetnonblock(int fd, int nonblocking) {
741 int errnoval= oop_fd_nonblock(fd, nonblocking);
742 if (errnoval) { errno= errnoval; syscrash("setnonblocking"); }
745 static void check_isreg(const struct stat *stab, const char *path,
747 if (!S_ISREG(stab->st_mode))
748 crash("%s %s not a plain file (mode 0%lo)",
749 what, path, (unsigned long)stab->st_mode);
752 static void mfstat(int fd, struct stat *stab_r, const char *what) {
753 int r= fstat(fd, stab_r);
754 if (r) syscrash("could not fstat %s", what);
757 static void mfstat_isreg(int fd, struct stat *stab_r,
758 const char *path, const char *what) {
759 mfstat(fd, stab_r, what);
760 check_isreg(stab_r, path, what);
763 static void mlstat_isreg(const char *path, struct stat *stab,
764 int *enoent_r /* 0 means ENOENT is fatal */,
766 int r= lstat(path, stab);
768 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
769 syscrash("could not lstat %s %s", what, path);
771 if (enoent_r) *enoent_r= 0;
772 check_isreg(stab, path, what);
775 static int samefile(const struct stat *a, const struct stat *b) {
776 assert(S_ISREG(a->st_mode));
777 assert(S_ISREG(b->st_mode));
778 return (a->st_ino == b->st_ino &&
779 a->st_dev == b->st_dev);
782 static char *sanitise(const char *input, int len) {
783 static char sanibuf[100]; /* returns pointer to this buffer! */
785 const char *p= input;
786 const char *endp= len>=0 ? input+len : 0;
790 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
791 int c= (!endp || p<endp) ? *p++ : 0;
792 if (!c) { *q++= '\''; *q=0; break; }
793 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
794 sprintf(q,"\\x%02x",c);
800 static int isewouldblock(int errnoval) {
801 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
804 /*========== command and control (CLI) connections ==========*/
806 static int cli_master;
808 typedef struct CliConn CliConn;
810 void (*destroy)(CliConn*);
816 struct sockaddr_un un;
821 static const oop_rd_style cli_rd_style= {
822 OOP_RD_DELIM_STRIP, '\n',
824 OOP_RD_SHORTREC_FORBID
827 static void cli_destroy(CliConn *cc) {
831 static void cli_checkouterr(CliConn *cc /* may destroy*/) {
832 if (ferror(cc->out) | fflush(cc->out)) {
833 info("CTRL%d write error %s", cc->fd, strerror(errno));
838 static void cli_prompt(CliConn *cc /* may destroy*/) {
839 fprintf(cc->out, "%s| ", sitename);
845 void (*f)(CliConn *cc, const CliCommand *ccmd,
846 const char *arg, size_t argsz);
851 static const CliCommand cli_commands[];
854 static void ccmd_##wh(CliConn *cc, const CliCommand *c, \
855 const char *arg, size_t argsz)
858 fputs("commands:\n", cc->out);
859 const CliCommand *ccmd;
860 for (ccmd=cli_commands; ccmd->cmd; ccmd++)
861 fprintf(cc->out, " %s\n", ccmd->cmd);
862 fputs("NB: permissible arguments are not shown above."
863 " Not all commands listed are safe. See innduct(8).\n", cc->out);
867 int ok= trigger_flush_ok("manual request");
868 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
873 notice("terminating (CTRL%d)",cc->fd);
874 raise_default(SIGTERM);
880 /* messing with our head: */
881 CCMD(period) { period(); }
882 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
883 CCMD(setint) { *(int*)c->xdata= c->xval; }
884 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
886 static const CliCommand cli_commands[]= {
888 { "flush", ccmd_flush },
889 { "stop", ccmd_stop },
890 { "dump q", ccmd_dump, 0,0 },
891 { "dump a", ccmd_dump, 0,1 },
893 { "p", ccmd_period },
895 #define POKES(cmd,func) \
896 { cmd "flush", func, &until_flush, 1 }, \
897 { cmd "conn", func, &until_connect, 0 }, \
898 { cmd "blscan", func, &until_backlog_nextscan, 0 },
899 POKES("next ", ccmd_setint)
900 POKES("prod ", ccmd_setint_period)
902 { "pretend flush", ccmd_setintarg, &simulate_flush },
903 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
907 static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
908 const char *errmsg, int errnoval,
909 const char *data, size_t recsz, void *cc_v) {
913 info("CTRL%d closed", cc->fd);
918 if (recsz == 0) goto prompt;
920 const CliCommand *ccmd;
921 for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
922 int l= strlen(ccmd->cmd);
923 if (recsz < l) continue;
924 if (recsz > l && data[l] != ' ') continue;
925 if (memcmp(data, ccmd->cmd, l)) continue;
927 int argl= (int)recsz - (l+1);
928 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
932 fputs("unknown command; h for help\n", cc->out);
939 static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
940 const char *errmsg, int errnoval,
941 const char *data, size_t recsz, void *cc_v) {
944 info("CTRL%d read error %s", cc->fd, errmsg);
949 static int cli_conn_startup(CliConn *cc /* may destroy*/,
951 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
952 if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
954 int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
957 if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
959 info("CTRL%d %s ready", cc->fd, how);
964 static void cli_stdio_destroy(CliConn *cc) {
966 oop_rd_cancel(cc->rd);
967 errno= oop_rd_delete_tidy(cc->rd);
968 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
973 static void cli_stdio(void) {
974 NEW_DECL(CliConn *,cc);
975 cc->destroy= cli_stdio_destroy;
979 int r= cli_conn_startup(cc,"stdio");
980 if (r) cc->destroy(cc);
983 static void cli_accepted_destroy(CliConn *cc) {
985 oop_rd_cancel(cc->rd);
986 oop_rd_delete_kill(cc->rd);
988 if (cc->out) { fclose(cc->out); cc->fd=0; }
989 close_perhaps(&cc->fd);
993 static void *cli_master_readable(oop_source *lp, int master,
994 oop_event ev, void *u) {
995 NEW_DECL(CliConn *,cc);
996 cc->destroy= cli_accepted_destroy;
998 cc->salen= sizeof(cc->sa);
999 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
1000 if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
1002 cc->out= fdopen(cc->fd, "w");
1003 if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
1005 int r= cli_conn_startup(cc, "accepted");
1008 return OOP_CONTINUE;
1012 return OOP_CONTINUE;
1015 #define NOCLI(...) do{ \
1016 syswarn("no cli listener, because failed to " __VA_ARGS__); \
1020 static void cli_init(void) {
1023 struct sockaddr_un un;
1026 memset(&sa,0,sizeof(sa));
1027 int maxlen= sizeof(sa.un.sun_path);
1030 info("control command line disabled");
1034 int pathlen= strlen(path_cli);
1035 if (pathlen > maxlen) {
1036 warn("no cli listener, because cli socket path %s too long (%d>%d)",
1037 path_cli, pathlen, maxlen);
1042 int r= mkdir(path_cli_dir, 0700);
1043 if (r && errno!=EEXIST)
1044 NOCLI("create cli socket directory %s", path_cli_dir);
1047 int r= unlink(path_cli);
1048 if (r && errno!=ENOENT)
1049 NOCLI("remove old cli socket %s", path_cli);
1051 cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1052 if (cli_master<0) NOCLI("create new cli master socket");
1054 int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1055 sa.un.sun_family= AF_UNIX;
1056 memcpy(sa.un.sun_path, path_cli, pathlen);
1058 r= bind(cli_master, &sa.sa, sl);
1059 if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1061 r= listen(cli_master, 5);
1062 if (r) NOCLI("listen to cli master socket");
1064 msetnonblock(cli_master, 1);
1066 loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1067 info("cli ready, listening on %s", path_cli);
1072 mclose_perhaps(&cli_master, "cli master",0);
1076 /*========== management of connections ==========*/
1078 static void reconnect_blocking_event(void) {
1079 until_connect= reconnect_delay_periods;
1082 static void conn_closefd(Conn *conn, const char *msgprefix) {
1083 int r= close_perhaps(&conn->fd);
1084 if (r) info("C%d %serror closing socket: %s",
1085 conn->fd, msgprefix, strerror(errno));
1088 static int conn_busy(Conn *conn) {
1090 conn->waiting.count ||
1091 conn->priority.count ||
1096 static void conn_dispose(Conn *conn) {
1099 oop_rd_cancel(conn->rd);
1100 oop_rd_delete_kill(conn->rd);
1104 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1105 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1107 conn_closefd(conn,"");
1111 static void *conn_exception(oop_source *lp, int fd,
1112 oop_event ev, void *conn_v) {
1115 assert(fd == conn->fd);
1116 assert(ev == OOP_EXCEPTION);
1117 int r= read(conn->fd, &ch, 1);
1118 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1119 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1120 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1121 return OOP_CONTINUE;
1124 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1125 int requeue[art_MaxState];
1126 memset(requeue,0,sizeof(requeue));
1130 while ((art= LIST_REMHEAD(conn->priority)))
1131 LIST_ADDTAIL(art->ipf->queue, art);
1133 while ((art= LIST_REMHEAD(conn->waiting)))
1134 LIST_ADDTAIL(art->ipf->queue, art);
1136 while ((art= LIST_REMHEAD(conn->sent))) {
1137 requeue[art->state]++;
1138 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1139 LIST_ADDTAIL(art->ipf->queue,art);
1140 check_reading_pause_resume(art->ipf);
1145 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1148 LIST_REMOVE(conns,conn);
1150 char *m= mvasprintf(fmt,al);
1151 warn("C%d (now %d) connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1152 conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1155 reconnect_blocking_event();
1157 check_assign_articles();
1160 static void connfail(Conn *conn, const char *fmt, ...) {
1163 vconnfail(conn,fmt,al);
1167 static void conn_idle_close(Conn *conn, const char *why) {
1168 static const char quitcmd[]= "QUIT\r\n";
1169 int todo= sizeof(quitcmd)-1;
1170 const char *p= quitcmd;
1172 int r= write(conn->fd, p, todo);
1174 if (isewouldblock(errno))
1175 connfail(conn, "blocked writing QUIT to idle connection");
1177 connfail(conn, "failed to write QUIT to idle connection: %s",
1184 conn->quitting= why;
1185 conn->since_activity= 0;
1186 debug("C%d is idle (%s), quitting", conn->fd, why);
1193 * For our last connection, we also shut it down if we have had
1194 * less than K in the last L
1196 static void check_idle_conns(void) {
1199 int volthisperiod= lowvol_perperiod[lowvol_circptr];
1201 lowvol_circptr %= lowvol_periods;
1202 lowvol_total += volthisperiod;
1203 lowvol_total -= lowvol_perperiod[lowvol_circptr];
1204 lowvol_perperiod[lowvol_circptr]= 0;
1207 conn->since_activity++;
1211 if (conn->since_activity <= need_activity_periods) continue;
1213 /* We need to shut this down */
1215 connfail(conn,"timed out waiting for response to QUIT (%s)",
1217 else if (conn->sent.count)
1218 connfail(conn,"timed out waiting for responses");
1219 else if (conn->waiting.count || conn->priority.count)
1220 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1221 else if (conn->xmitu)
1222 connfail(conn,"peer has been sending responses"
1223 " before receiving our commands!");
1225 conn_idle_close(conn, "no activity");
1230 conn= LIST_HEAD(conns);
1231 if (!volthisperiod &&
1233 lowvol_total < lowvol_thresh &&
1235 conn_idle_close(conn, "low volume");
1238 /*---------- making new connections ----------*/
1240 static pid_t connecting_child;
1241 static int connecting_fdpass_sock;
1243 static void connect_attempt_discard(void) {
1244 if (connecting_child) {
1245 int status= mwaitpid(&connecting_child, "connect");
1246 if (!(WIFEXITED(status) ||
1247 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1248 report_child_status("connect", status);
1250 if (connecting_fdpass_sock) {
1251 cancel_fd_read_except(connecting_fdpass_sock);
1252 mclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1256 #define PREP_DECL_MSG_CMSG(msg) \
1258 struct iovec msgiov; \
1259 msgiov.iov_base= &msgbyte; \
1260 msgiov.iov_len= 1; \
1261 struct msghdr msg; \
1262 memset(&msg,0,sizeof(msg)); \
1263 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1264 msg.msg_iov= &msgiov; \
1265 msg.msg_iovlen= 1; \
1266 msg.msg_control= msg##cbuf; \
1267 msg.msg_controllen= sizeof(msg##cbuf);
1269 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1272 assert(fd == connecting_fdpass_sock);
1274 PREP_DECL_MSG_CMSG(msg);
1276 ssize_t rs= recvmsg(fd, &msg, 0);
1278 if (isewouldblock(errno)) return OOP_CONTINUE;
1279 syswarn("failed to read socket from connecting child");
1284 LIST_INIT(conn->waiting);
1285 LIST_INIT(conn->priority);
1286 LIST_INIT(conn->sent);
1288 struct cmsghdr *h= 0;
1289 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1291 int status= mwaitpid(&connecting_child, "connect child (broken)");
1293 if (WIFEXITED(status)) {
1294 if (WEXITSTATUS(status) != 0 &&
1295 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1296 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1297 /* child already reported the problem */;
1299 if (e == OOP_EXCEPTION)
1300 warn("connect: connection child exited code %d but"
1301 " unexpected exception on fdpass socket",
1302 WEXITSTATUS(status));
1304 warn("connect: connection child exited code %d but"
1306 WEXITSTATUS(status), (int)rs);
1308 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1309 warn("connect: connection attempt timed out");
1311 report_child_status("connect", status);
1316 #define CHK(field, val) \
1317 if (h->cmsg_##field != val) { \
1318 crash("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1319 h->cmsg_##field, val); \
1322 CHK(level, SOL_SOCKET);
1323 CHK(type, SCM_RIGHTS);
1324 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1327 if (CMSG_NXTHDR(&msg,h)) crash("connect: child sent many cmsgs");
1329 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1332 pid_t got= waitpid(connecting_child, &status, 0);
1333 if (got==-1) syscrash("connect: real wait for child");
1334 assert(got == connecting_child);
1335 connecting_child= 0;
1337 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1338 int es= WEXITSTATUS(status);
1340 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1341 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1343 fatal("connect: child gave unexpected exit status %d", es);
1347 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1349 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1350 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1351 if (!conn->fd) crash("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1352 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1354 &peer_rd_err, conn);
1355 if (r) syscrash("oop_rd_read for peer (fd=%d)",conn->fd);
1357 LIST_ADDHEAD(conns, conn);
1358 notice("C%d (now %d) connected %s",
1359 conn->fd, conns.count, conn->stream ? "streaming" : "plain");
1361 connect_attempt_discard();
1362 check_assign_articles();
1363 return OOP_CONTINUE;
1367 connect_attempt_discard();
1368 reconnect_blocking_event();
1369 return OOP_CONTINUE;
1372 static int allow_connect_start(void) {
1373 return conns.count < max_connections
1374 && !connecting_child
1378 static void connect_start(void) {
1379 assert(!connecting_child);
1380 assert(!connecting_fdpass_sock);
1382 info("starting connection attempt");
1383 int ok_until_connect= until_connect;
1384 reconnect_blocking_event();
1387 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1388 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1390 connecting_child= mfork("connection");
1392 if (!connecting_child) {
1393 FILE *cn_from, *cn_to;
1394 char buf[NNTP_STRLEN+100];
1395 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1397 mclose(socks[0], "(in child) parent's connection fdpass socket",0);
1399 alarm(connection_setup_timeout);
1400 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1404 unsigned char c= buf[l-1];
1405 if (!isspace(c)) break;
1406 if (c=='\n' || c=='\r') stripped=1;
1410 sysfatal("connect: connection attempt failed");
1413 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1417 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1418 sysfatal("connect: authentication failed");
1420 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1422 sysfatal("connect: could not send MODE STREAM");
1423 buf[sizeof(buf)-1]= 0;
1424 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1425 if (ferror(cn_from))
1426 sysfatal("connect: could not read response to MODE STREAM");
1428 fatal("connect: connection close in response to MODE STREAM");
1433 fatal("connect: response to MODE STREAM is too long: %.100s...",
1435 l--; if (l>0 && buf[l-1]=='\r') l--;
1438 int rcode= strtoul(buf,&ep,10);
1440 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1444 exitstatus= CONNCHILD_ESTATUS_STREAM;
1450 warn("connect: unexpected response to MODE STREAM: %.50s",
1456 int fd= fileno(cn_from);
1458 PREP_DECL_MSG_CMSG(msg);
1459 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1460 cmsg->cmsg_level= SOL_SOCKET;
1461 cmsg->cmsg_type= SCM_RIGHTS;
1462 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1463 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1465 msg.msg_controllen= cmsg->cmsg_len;
1466 r= sendmsg(socks[1], &msg, 0);
1467 if (r<0) syscrash("sendmsg failed for new connection");
1468 if (r!=1) crash("sendmsg for new connection gave wrong result %d",r);
1473 mclose(socks[1], "connecting fdpass child's socket",0);
1474 connecting_fdpass_sock= socks[0];
1475 msetnonblock(connecting_fdpass_sock, 1);
1476 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1479 until_connect= ok_until_connect;
1482 /*---------- assigning articles to conns, and transmitting ----------*/
1484 static Article *dequeue_from(int peek, InputFile *ipf) {
1486 if (peek) return LIST_HEAD(ipf->queue);
1488 Article *art= LIST_REMHEAD(ipf->queue);
1490 check_reading_pause_resume(ipf);
1494 static Article *dequeue(int peek) {
1496 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1497 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1498 art= dequeue_from(peek, main_input_file); if (art) return art;
1502 static void check_assign_articles(void) {
1508 int spare=0, inqueue=0;
1510 /* Find a connection to offer this article. We prefer a busy
1511 * connection to an idle one, provided it's not full. We take the
1512 * first (oldest) and since that's stable, it will mean we fill up
1513 * connections in order. That way if we have too many
1514 * connections, the spare ones will go away eventually.
1517 if (walk->quitting) continue;
1518 inqueue= walk->sent.count + walk->priority.count
1519 + walk->waiting.count;
1520 spare= walk->max_queue - inqueue;
1521 assert(inqueue <= max_queue_per_conn);
1523 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1524 else if (spare>0) /*working*/ { use= walk; break; }
1527 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1529 Article *art= dequeue(0);
1531 LIST_ADDTAIL(use->waiting, art);
1532 lowvol_perperiod[lowvol_circptr]++;
1535 conn_maybe_write(use);
1536 } else if (allow_connect_start()) {
1545 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1546 conn_maybe_write(u);
1547 return OOP_CONTINUE;
1550 static void conn_maybe_write(Conn *conn) {
1552 conn_make_some_xmits(conn);
1554 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1555 conn->oopwriting= 0;
1559 void *rp= conn_write_some_xmits(conn);
1560 if (rp==OOP_CONTINUE) {
1561 if (!conn->oopwriting) {
1562 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1563 conn->oopwriting= 1;
1566 } else if (rp==OOP_HALT) {
1569 /* transmitted everything */
1576 /*---------- expiry, flow control and deferral ----------*/
1579 * flow control notes
1580 * to ensure articles go away eventually
1581 * separate queue for each input file
1583 * every period, check head of backlog queue for expiry with SMretrieve
1584 * if too old: discard, and check next article
1585 * also check every backlog article as we read it
1587 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1588 * one-off: eat queued articles from flushing and write them to defer
1589 * one-off: connfail all connections which have any articles from flushing
1590 * newly read articles from flushing go straight to defer
1591 * this should take care of it and get us out of this state
1592 * to avoid filling up ram needlessly
1594 * limit number of queued articles for each ipf
1595 * pause/resume inputfile tailing
1598 static void check_reading_pause_resume(InputFile *ipf) {
1599 if (ipf->queue.count >= max_queue_per_ipf)
1600 inputfile_reading_pause(ipf);
1602 inputfile_reading_resume(ipf);
1605 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1607 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1609 sysfatal("write to defer file %s",path_defer);
1610 article_done(art, whichcount);
1613 static int article_check_expired(Article *art /* must be queued, not conn */) {
1614 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1615 if (artdata) { SMfreearticle(artdata); return 0; }
1617 LIST_REMOVE(art->ipf->queue, art);
1619 art->ipf->count_nooffer_missing++;
1620 article_done(art,-1);
1624 static void inputfile_queue_check_expired(InputFile *ipf) {
1628 Article *art= LIST_HEAD(ipf->queue);
1629 int exp= article_check_expired(art);
1632 check_reading_pause_resume(ipf);
1635 static void article_autodefer(InputFile *ipf, Article *art) {
1637 article_defer(art,-1);
1640 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1642 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1643 if (art->ipf == ipf) return 1;
1647 static void autodefer_input_file_articles(InputFile *ipf) {
1649 while ((art= LIST_REMHEAD(ipf->queue)))
1650 article_autodefer(ipf, art);
1653 static void autodefer_input_file(InputFile *ipf) {
1654 static const char *const abandon= "stuck";
1657 autodefer_input_file_articles(ipf);
1659 if (ipf->inprogress) {
1662 if (has_article_in(&walk->waiting, ipf) ||
1663 has_article_in(&walk->priority, ipf) ||
1664 has_article_in(&walk->sent, ipf))
1665 walk->quitting= abandon;
1667 while (ipf->inprogress) {
1669 if (walk->quitting == abandon) goto found;
1670 abort(); /* where are they ?? */
1673 connfail(walk, "connection is stuck or crawling,"
1674 " and we need to finish flush");
1675 autodefer_input_file_articles(ipf);
1679 check_reading_pause_resume(ipf);
1682 /*========== article transmission ==========*/
1684 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1685 XmitKind kind) { /* caller must then fill in details */
1686 struct iovec *v= &conn->xmit[conn->xmitu];
1687 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1688 v->iov_base= (char*)data;
1694 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1695 xmit_core(conn,data,len, xk_Const);
1697 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1699 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1700 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1704 static void xmit_free(XmitDetails *d) {
1706 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1707 case xk_Const: break;
1712 static void *conn_write_some_xmits(Conn *conn) {
1714 * 0: nothing more to write, no need to call us again
1715 * OOP_CONTINUE: more to write but fd not writeable
1716 * OOP_HALT: disaster, have destroyed conn
1719 int count= conn->xmitu;
1720 if (!count) return 0;
1722 if (count > IOV_MAX) count= IOV_MAX;
1723 ssize_t rs= writev(conn->fd, conn->xmit, count);
1725 if (isewouldblock(errno)) return OOP_CONTINUE;
1726 connfail(conn, "write failed: %s", strerror(errno));
1732 for (done=0; rs; ) {
1733 assert(done<conn->xmitu);
1734 struct iovec *vp= &conn->xmit[done];
1735 XmitDetails *dp= &conn->xmitd[done];
1736 if (rs >= vp->iov_len) {
1738 xmit_free(dp); /* vp->iov_len -= vp->iov_len, etc. */
1741 vp->iov_base= (char*)vp->iov_base + rs;
1743 break; /* rs -= rs */
1746 int newu= conn->xmitu - done;
1747 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1748 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1753 static void conn_make_some_xmits(Conn *conn) {
1755 if (conn->xmitu+5 > CONNIOVS)
1758 Article *art= LIST_REMHEAD(conn->priority);
1759 if (!art) art= LIST_REMHEAD(conn->waiting);
1762 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1763 /* actually send it */
1765 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1768 art->state == art_Unchecked ? art_Unsolicited :
1769 art->state == art_Wanted ? art_Wanted :
1772 if (!artdata) art->missing= 1;
1773 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1777 XMIT_LITERAL("TAKETHIS ");
1778 xmit_noalloc(conn, art->messageid, art->midlen);
1779 XMIT_LITERAL("\r\n");
1780 xmit_artbody(conn, artdata);
1782 article_done(art, -1);
1786 /* we got 235 from IHAVE */
1788 xmit_artbody(conn, artdata);
1790 XMIT_LITERAL(".\r\n");
1794 LIST_ADDTAIL(conn->sent, art);
1800 XMIT_LITERAL("CHECK ");
1802 XMIT_LITERAL("IHAVE ");
1803 xmit_noalloc(conn, art->messageid, art->midlen);
1804 XMIT_LITERAL("\r\n");
1806 assert(art->state == art_Unchecked);
1807 art->ipf->counts[art->state][RC_sent]++;
1808 LIST_ADDTAIL(conn->sent, art);
1813 /*========== handling responses from peer ==========*/
1815 static const oop_rd_style peer_rd_style= {
1816 OOP_RD_DELIM_STRIP, '\n',
1818 OOP_RD_SHORTREC_FORBID
1821 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1822 const char *errmsg, int errnoval,
1823 const char *data, size_t recsz, void *conn_v) {
1825 connfail(conn, "error receiving from peer: %s", errmsg);
1826 return OOP_CONTINUE;
1829 static Article *article_reply_check(Conn *conn, const char *response,
1830 int code_indicates_streaming,
1832 /* 1:yes, -1:no, 0:dontcare */,
1833 const char *sanitised_response) {
1834 Article *art= LIST_HEAD(conn->sent);
1838 "peer gave unexpected response when no commands outstanding: %s",
1839 sanitised_response);
1843 if (code_indicates_streaming) {
1844 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1845 if (!conn->stream) {
1846 connfail(conn, "peer gave streaming response code "
1847 " to IHAVE or subsequent body: %s", sanitised_response);
1850 const char *got_mid= response+4;
1851 int got_midlen= strcspn(got_mid, " \n\r");
1852 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1853 connfail(conn, "peer gave streaming response with syntactically invalid"
1854 " messageid: %s", sanitised_response);
1857 if (got_midlen != art->midlen ||
1858 memcmp(got_mid, art->messageid, got_midlen)) {
1859 connfail(conn, "peer gave streaming response code to wrong article -"
1860 " probable synchronisation problem; we offered: %s;"
1862 art->messageid, sanitised_response);
1867 connfail(conn, "peer gave non-streaming response code to"
1868 " CHECK/TAKETHIS: %s", sanitised_response);
1873 if (must_have_sent>0 && art->state < art_Wanted) {
1874 connfail(conn, "peer says article accepted but"
1875 " we had not sent the body: %s", sanitised_response);
1878 if (must_have_sent<0 && art->state >= art_Wanted) {
1879 connfail(conn, "peer says please sent the article but we just did: %s",
1880 sanitised_response);
1884 Article *art_again= LIST_REMHEAD(conn->sent);
1885 assert(art_again == art);
1889 static void update_nocheck(int accepted) {
1890 accept_proportion *= nocheck_decay;
1891 accept_proportion += accepted * (1.0 - nocheck_decay);
1892 int new_nocheck= accept_proportion >= nocheck_thresh;
1893 if (new_nocheck && !nocheck_reported) {
1894 notice("entering nocheck mode for the first time");
1895 nocheck_reported= 1;
1896 } else if (new_nocheck != nocheck) {
1897 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1899 nocheck= new_nocheck;
1902 static void article_done(Article *art, int whichcount) {
1903 if (whichcount>=0 && !art->missing)
1904 art->ipf->counts[art->state][whichcount]++;
1906 if (whichcount == RC_accepted) update_nocheck(1);
1907 else if (whichcount == RC_unwanted) update_nocheck(0);
1909 InputFile *ipf= art->ipf;
1911 while (art->blanklen) {
1912 static const char spaces[]=
1922 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1923 int r= pwrite(ipf->fd, spaces, w, art->offset);
1925 if (errno==EINTR) continue;
1926 syscrash("failed to blank entry for %s (length %d at offset %lu) in %s",
1927 art->messageid, art->blanklen,
1928 (unsigned long)art->offset, ipf->path);
1930 assert(r>=0 && r<=w);
1936 assert(ipf->inprogress >= 0);
1939 if (!ipf->inprogress && ipf != main_input_file)
1940 queue_check_input_done();
1943 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1944 const char *errmsg, int errnoval,
1945 const char *data, size_t recsz, void *conn_v) {
1948 if (ev == OOP_RD_EOF) {
1949 connfail(conn, "unexpected EOF from peer");
1950 return OOP_CONTINUE;
1952 assert(ev == OOP_RD_OK);
1954 char *sani= sanitise(data,-1);
1957 unsigned long code= strtoul(data, &ep, 10);
1958 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1959 connfail(conn, "badly formatted response from peer: %s", sani);
1960 return OOP_CONTINUE;
1963 int busy= conn_busy(conn);
1965 if (conn->quitting) {
1966 if (code!=205 && code!=400) {
1967 connfail(conn, "peer gave unexpected response to QUIT (%s): %s",
1968 conn->quitting, sani);
1970 LIST_REMOVE(conns,conn);
1971 notice("C%d (now %d) idle connection closed (%s)",
1972 conn->fd, conns.count, conn->quitting);
1976 return OOP_CONTINUE;
1979 conn->since_activity= 0;
1982 #define GET_ARTICLE(musthavesent) do{ \
1983 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1984 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1987 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1988 code_streaming= (streaming); \
1989 GET_ARTICLE(musthavesent); \
1990 article_done(art, RC_##how); \
1994 #define PEERBADMSG(m) do { \
1995 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1998 int code_streaming= 0;
2002 default: PEERBADMSG("peer sent unexpected message");
2006 PEERBADMSG("peer timed us out or stopped accepting articles");
2008 LIST_REMOVE(conns,conn);
2009 notice("C%d (now %d) idle connection closed by peer",
2010 conns.count, conn->fd);
2012 return OOP_CONTINUE;
2014 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
2015 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
2017 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
2018 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
2020 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
2021 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
2023 case 238: /* CHECK says send it */
2025 case 335: /* IHAVE says send it */
2027 assert(art->state == art_Unchecked);
2028 art->ipf->counts[art->state][RC_accepted]++;
2029 art->state= art_Wanted;
2030 LIST_ADDTAIL(conn->priority, art);
2033 case 431: /* CHECK or TAKETHIS says try later */
2035 case 436: /* IHAVE says try later */
2037 article_defer(art, RC_deferred);
2043 conn_maybe_write(conn);
2044 check_assign_articles();
2045 return OOP_CONTINUE;
2049 /*========== monitoring of input files ==========*/
2051 static void feedfile_eof(InputFile *ipf) {
2052 assert(ipf != main_input_file); /* promised by tailing_try_read */
2053 inputfile_reading_stop(ipf);
2055 if (ipf == flushing_input_file) {
2056 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2057 if (main_input_file) inputfile_reading_start(main_input_file);
2058 statemc_check_flushing_done();
2059 } else if (ipf == backlog_input_file) {
2060 statemc_check_backlog_done();
2062 abort(); /* supposed to wait rather than get EOF on main input file */
2066 static InputFile *open_input_file(const char *path) {
2067 int fd= open(path, O_RDWR);
2069 if (errno==ENOENT) return 0;
2070 sysfatal("unable to open input file %s", path);
2074 InputFile *ipf= mmalloc(sizeof(*ipf) + strlen(path) + 1);
2075 memset(ipf,0,sizeof(*ipf));
2079 LIST_INIT(ipf->queue);
2080 strcpy(ipf->path, path);
2085 static void close_input_file(InputFile *ipf) { /* does not free */
2086 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2087 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2088 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2089 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2090 mclose_perhaps(&ipf->fd, "input file ", ipf->path);
2094 /*---------- dealing with articles read in the input file ----------*/
2096 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2097 const char *data, const char *how) {
2098 warn("corrupted file: %s, offset %lu: %s: in %s",
2099 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2100 ipf->readcount_err++;
2101 if (ipf->readcount_err > max_bad_data_initial +
2102 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2103 crash("too much garbage in input file! (%d errs, %d ok, %d blank)",
2104 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2105 return OOP_CONTINUE;
2108 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2109 oop_rd_event ev, const char *errmsg,
2110 int errnoval, const char *data, size_t recsz,
2112 InputFile *ipf= ipf_v;
2113 assert(ev == OOP_RD_SYSTEM);
2115 syscrash("error reading input file: %s, offset %lu",
2116 ipf->path, (unsigned long)ipf->offset);
2119 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2120 oop_rd_event ev, const char *errmsg,
2121 int errnoval, const char *data, size_t recsz,
2123 InputFile *ipf= ipf_v;
2125 char tokentextbuf[sizeof(TOKEN)*2+3];
2127 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2129 off_t old_offset= ipf->offset;
2130 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2132 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2134 if (ev==OOP_RD_PARTREC)
2135 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2136 /* but process it anyway */
2138 if (ipf->skippinglong) {
2139 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2140 return OOP_CONTINUE;
2142 if (ev==OOP_RD_LONG) {
2143 ipf->skippinglong= 1;
2144 X_BAD_DATA("overly long line");
2147 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2148 if (!recsz) X_BAD_DATA("empty line");
2151 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2152 ipf->readcount_blank++;
2153 return OOP_CONTINUE;
2156 char *space= strchr(data,' ');
2157 int tokenlen= space-data;
2158 int midlen= (int)recsz-tokenlen-1;
2159 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2160 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2162 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2163 memcpy(tokentextbuf, data, tokenlen);
2164 tokentextbuf[tokenlen]= 0;
2165 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2167 ipf->readcount_ok++;
2169 art= mmalloc(sizeof(*art) - 1 + midlen + 1);
2170 memset(art,0,sizeof(*art));
2171 art->state= art_Unchecked;
2172 art->midlen= midlen;
2173 art->ipf= ipf; ipf->inprogress++;
2174 art->token= TextToToken(tokentextbuf);
2175 art->offset= old_offset;
2176 art->blanklen= recsz;
2177 strcpy(art->messageid, space+1);
2178 LIST_ADDTAIL(ipf->queue, art);
2180 if (ipf->autodefer >= 0)
2181 article_autodefer(ipf, art);
2182 else if (ipf==backlog_input_file)
2183 article_check_expired(art);
2185 if (sms==sm_NORMAL && ipf==main_input_file &&
2186 ipf->offset >= target_max_feedfile_size)
2187 statemc_start_flush("feed file size");
2189 check_assign_articles(); /* may destroy conn but that's OK */
2190 check_reading_pause_resume(ipf);
2191 return OOP_CONTINUE;
2194 /*========== tailing input file ==========*/
2196 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2198 /* lifetime of ipf here is OK because destruction will cause
2199 * on_cancel which will cancel this callback */
2200 InputFile *ipf= user;
2202 if (!ipf->fake_readable) return OOP_CONTINUE;
2204 /* we just keep calling readable until our caller (oop_rd)
2205 * has called try_read, and try_read has found EOF so given EAGAIN */
2206 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2208 return ipf->readable_callback(loop, &ipf->readable,
2209 ipf->readable_callback_user);
2212 static void tailing_on_cancel(struct oop_readable *rable) {
2213 InputFile *ipf= (void*)rable;
2215 if (ipf->filemon) filemon_stop(ipf);
2216 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2217 ipf->readable_callback= 0;
2220 static void tailing_make_readable(InputFile *ipf) {
2221 if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2223 ipf->fake_readable= 1;
2224 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2227 static int tailing_on_readable(struct oop_readable *rable,
2228 oop_readable_call *cb, void *user) {
2229 InputFile *ipf= (void*)rable;
2231 tailing_on_cancel(rable);
2232 ipf->readable_callback= cb;
2233 ipf->readable_callback_user= user;
2235 tailing_make_readable(ipf);
2239 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2241 InputFile *ipf= (void*)rable;
2243 ssize_t r= read(ipf->fd, buffer, length);
2245 if (errno==EINTR) continue;
2246 ipf->fake_readable= 0;
2250 if (ipf==main_input_file) {
2252 ipf->fake_readable= 0;
2254 } else if (ipf==flushing_input_file) {
2256 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2257 } else if (ipf==backlog_input_file) {
2267 /*---------- filemon implemented with inotify ----------*/
2269 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2270 #define HAVE_FILEMON
2272 #include <sys/inotify.h>
2274 static int filemon_inotify_fd;
2275 static int filemon_inotify_wdmax;
2276 static InputFile **filemon_inotify_wd2ipf;
2278 struct Filemon_Perfile {
2282 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2283 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2284 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2286 if (wd >= filemon_inotify_wdmax) {
2288 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2289 sizeof(*filemon_inotify_wd2ipf) * newmax);
2290 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2291 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2292 filemon_inotify_wdmax= newmax;
2295 assert(!filemon_inotify_wd2ipf[wd]);
2296 filemon_inotify_wd2ipf[wd]= ipf;
2298 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2299 ipf, wd, filemon_inotify_wdmax);
2304 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2306 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2307 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2308 if (r) syscrash("inotify_rm_watch");
2309 filemon_inotify_wd2ipf[wd]= 0;
2312 static void *filemon_inotify_readable(oop_source *lp, int fd,
2313 oop_event e, void *u) {
2314 struct inotify_event iev;
2316 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2318 if (isewouldblock(errno)) break;
2319 syscrash("read from inotify master");
2320 } else if (r==sizeof(iev)) {
2321 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2323 crash("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2325 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2326 /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2327 tailing_make_readable(ipf);
2329 return OOP_CONTINUE;
2332 static int filemon_method_init(void) {
2333 filemon_inotify_fd= inotify_init();
2334 if (filemon_inotify_fd<0) {
2335 syswarn("filemon/inotify: inotify_init failed");
2338 msetnonblock(filemon_inotify_fd, 1);
2339 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2341 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2345 static void filemon_method_dump_info(FILE *f) {
2347 fprintf(f,"inotify");
2348 DUMPV("%d",,filemon_inotify_fd);
2349 DUMPV("%d",,filemon_inotify_wdmax);
2350 for (i=0; i<filemon_inotify_wdmax; i++)
2351 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2354 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2356 /*---------- filemon dummy implementation ----------*/
2358 #if !defined(HAVE_FILEMON)
2360 struct Filemon_Perfile { int dummy; };
2362 static int filemon_method_init(void) {
2363 warn("filemon/dummy: no filemon method compiled in");
2366 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2367 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2368 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2370 #endif /* !HAVE_FILEMON */
2372 /*---------- filemon generic interface ----------*/
2374 static void filemon_start(InputFile *ipf) {
2375 assert(!ipf->filemon);
2378 filemon_method_startfile(ipf, ipf->filemon);
2381 static void filemon_stop(InputFile *ipf) {
2382 if (!ipf->filemon) return;
2383 filemon_method_stopfile(ipf, ipf->filemon);
2388 /*---------- interface to start and stop an input file ----------*/
2390 static const oop_rd_style feedfile_rdstyle= {
2391 OOP_RD_DELIM_STRIP, '\n',
2393 OOP_RD_SHORTREC_LONG,
2396 static void inputfile_reading_resume(InputFile *ipf) {
2397 if (!ipf->rd) return;
2398 if (!ipf->paused) return;
2400 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2401 feedfile_got_article,ipf, feedfile_read_err, ipf);
2402 if (r) syscrash("unable start reading feedfile %s",ipf->path);
2407 static void inputfile_reading_pause(InputFile *ipf) {
2408 if (!ipf->rd) return;
2409 if (ipf->paused) return;
2410 oop_rd_cancel(ipf->rd);
2414 static void inputfile_reading_start(InputFile *ipf) {
2416 ipf->readable.on_readable= tailing_on_readable;
2417 ipf->readable.on_cancel= tailing_on_cancel;
2418 ipf->readable.try_read= tailing_try_read;
2419 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2420 ipf->readable.delete_kill= 0;
2422 ipf->readable_callback= 0;
2423 ipf->readable_callback_user= 0;
2425 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2429 inputfile_reading_resume(ipf);
2432 static void inputfile_reading_stop(InputFile *ipf) {
2434 inputfile_reading_pause(ipf);
2435 oop_rd_delete(ipf->rd);
2437 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2441 /*========== interaction with innd - state machine ==========*/
2443 /* See official state diagram at top of file. We implement
2454 |`---------------------------------------------------.
2456 |`---------------- - - - |
2457 D ENOENT | D EXISTS see OVERALL STATES diagram |
2458 | for full startup logic |
2461 | ============ try to |
2467 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2468 ^ | hardlink F to D |
2471 | | our handle onto F is now onto D |
2474 | |<-------------------<---------------------<---------+
2476 | | spawn inndcomm flush |
2478 | ================== |
2479 | FLUSHING[-ABSENT] |
2481 | main D tail/none |
2482 | ================== |
2484 | | INNDCOMM FLUSH FAILS ^
2485 | |`----------------------->----------. |
2487 | | NO SUCH SITE V |
2488 ^ |`--------------->----. ==================== |
2489 | | \ FLUSHFAILED[-ABSENT] |
2491 | | FLUSH OK \ main D tail/none |
2492 | | open F \ ==================== |
2494 | | \ | TIME TO RETRY |
2495 | |`------->----. ,---<---'\ `----------------'
2496 | | D NONE | | D NONE `----.
2498 | ============= V V ============
2499 | SEPARATED-1 | | DROPPING-1
2500 | flsh->rd!=0 | | flsh->rd!=0
2501 | [Separated] | | [Dropping]
2502 | main F idle | | main none
2503 | flsh D tail | | flsh D tail
2504 | ============= | | ============
2506 ^ | EOF ON D | | defer | EOF ON D
2508 | =============== | | ===============
2509 | SEPARATED-2 | | DROPPING-2
2510 | flsh->rd==0 | V flsh->rd==0
2511 | [Finishing] | | [Dropping]
2512 | main F tail | `. main none
2513 | flsh D closed | `. flsh D closed
2514 | =============== V `. ===============
2516 | | ALL D PROCESSED `. | ALL D PROCESSED
2517 | V install defer as backlog `. | install defer
2518 ^ | close D `. | close D
2519 | | unlink D `. | unlink D
2522 `----------' ==============
2542 static void startup_set_input_file(InputFile *f) {
2543 assert(!main_input_file);
2545 inputfile_reading_start(f);
2548 static void statemc_lock(void) {
2550 struct stat stab, stabf;
2553 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2554 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2557 memset(&fl,0,sizeof(fl));
2559 fl.l_whence= SEEK_SET;
2560 int r= fcntl(lockfd, F_SETLK, &fl);
2562 if (errno==EACCES || isewouldblock(errno)) {
2563 if (quiet_multiple) exit(0);
2564 fatal("another duct holds the lockfile");
2566 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2569 mfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2571 mlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2573 if (!lock_noent && samefile(&stab, &stabf))
2576 mclose(lockfd, "stale lockfile ", path_lock);
2579 FILE *lockfile= fdopen(lockfd, "w");
2580 if (!lockfile) syscrash("fdopen lockfile");
2582 int r= ftruncate(lockfd, 0);
2583 if (r) syscrash("truncate lockfile to write new info");
2585 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2586 (unsigned long)self_pid,
2587 sitename, feedfile, remote_host) == EOF ||
2589 sysfatal("write info to lockfile %s", path_lock);
2591 debug("startup: locked");
2594 static void statemc_init(void) {
2595 struct stat stabdefer;
2597 search_backlog_file();
2600 mlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2602 debug("startup: ductdefer ENOENT");
2604 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2605 switch (stabdefer.st_nlink==1) {
2607 open_defer(); /* so that we will later close it and rename it */
2610 munlink(path_defer, "stale defer file link"
2611 " (presumably hardlink to backlog file)");
2614 crash("defer file %s has unexpected link count %d",
2615 path_defer, stabdefer.st_nlink);
2619 struct stat stab_f, stab_d;
2622 InputFile *file_d= open_input_file(path_flushing);
2623 if (file_d) mfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2625 mlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2627 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2628 debug("startup: F==D => Hardlinked");
2629 munlink(feedfile, "feed file (during startup)"); /* => Moved */
2634 debug("startup: F ENOENT => Moved");
2635 if (file_d) startup_set_input_file(file_d);
2636 spawn_inndcomm_flush("feedfile missing at startup");
2637 /* => Flushing, sms:=FLUSHING */
2640 debug("startup: F!=D => Separated");
2641 startup_set_input_file(file_d);
2642 flushing_input_file= main_input_file;
2643 main_input_file= open_input_file(feedfile);
2644 if (!main_input_file) crash("feedfile vanished during startup");
2645 SMS(SEPARATED, max_separated_periods,
2646 "found both old and current feed files");
2648 debug("startup: F exists, D ENOENT => Normal");
2649 InputFile *file_f= open_input_file(feedfile);
2650 if (!file_f) crash("feed file vanished during startup");
2651 startup_set_input_file(file_f);
2652 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2657 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2658 assert(sms == sm_NORMAL);
2660 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2662 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2663 (unsigned long)target_max_feedfile_size,
2666 int r= link(feedfile, path_flushing);
2667 if (r) sysfatal("link feedfile %s to flushing file %s",
2668 feedfile, path_flushing);
2671 munlink(feedfile, "old feedfile link");
2674 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2677 static int trigger_flush_ok(const char *why) {
2681 statemc_start_flush(why ? why : "periodic");
2682 return 1; /* Normal => Flushing; => FLUSHING */
2684 case sm_FLUSHFAILED:
2685 spawn_inndcomm_flush(why ? why : "retry");
2686 return 1; /* Moved => Flushing; => FLUSHING */
2690 warn("abandoning old feedfile after flush (%s), autodeferring",
2691 why ? why : "took too long to complete");
2692 assert(flushing_input_file);
2693 autodefer_input_file(flushing_input_file);
2701 static void statemc_period_poll(void) {
2702 if (!until_flush) return;
2704 assert(until_flush>=0);
2706 if (until_flush) return;
2707 int ok= trigger_flush_ok(0);
2711 static int inputfile_is_done(InputFile *ipf) {
2713 if (ipf->inprogress) return 0; /* new article in the meantime */
2714 if (ipf->rd) return 0; /* not had EOF */
2718 static void notice_processed(InputFile *ipf, int completed,
2719 const char *what, const char *spec) {
2720 if (!ipf) return; /* allows preterminate to be lazy */
2722 #define RCI_NOTHING(x) /* nothing */
2723 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2724 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2726 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2728 char *inprog= completed
2729 ? masprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2730 : masprintf(" inprogress=%ld", ipf->inprogress);
2731 char *autodefer= ipf->autodefer >= 0
2732 ? masprintf(" autodeferred=%ld", ipf->autodefer)
2733 : masprintf("%s","");
2735 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2736 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2737 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2739 completed?"completed":"processed", what, spec,
2740 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2741 inprog, autodefer, ipf->count_nooffer_missing,
2742 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2743 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2744 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2745 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2746 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2755 static void statemc_check_backlog_done(void) {
2756 InputFile *ipf= backlog_input_file;
2757 if (!inputfile_is_done(ipf)) return;
2759 const char *slash= strrchr(ipf->path, '/');
2760 const char *leaf= slash ? slash+1 : ipf->path;
2761 const char *under= strchr(slash, '_');
2762 const char *rest= under ? under+1 : leaf;
2763 if (!strncmp(rest,"backlog",7)) rest += 7;
2764 notice_processed(ipf,1,"backlog ",rest);
2766 close_input_file(ipf);
2767 if (unlink(ipf->path)) {
2768 if (errno != ENOENT)
2769 syscrash("could not unlink processed backlog file %s", ipf->path);
2770 warn("backlog file %s vanished while we were reading it"
2771 " so we couldn't remove it (but it's done now, anyway)",
2775 backlog_input_file= 0;
2776 search_backlog_file();
2780 static void statemc_check_flushing_done(void) {
2781 InputFile *ipf= flushing_input_file;
2782 if (!inputfile_is_done(ipf)) return;
2784 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2786 notice_processed(ipf,1,"feedfile","");
2790 munlink(path_flushing, "old flushing file");
2792 close_input_file(flushing_input_file);
2793 free(flushing_input_file);
2794 flushing_input_file= 0;
2796 if (sms==sm_SEPARATED) {
2797 notice("flush complete");
2798 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2799 } else if (sms==sm_DROPPING) {
2800 SMS(DROPPED, max_separated_periods, "old flush complete");
2801 search_backlog_file();
2802 notice("feed dropped, but will continue until backlog is finished");
2806 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2808 assert(!inputfile_is_done(main_input_file));
2809 statemc_check_flushing_done();
2810 statemc_check_backlog_done();
2811 return OOP_CONTINUE;
2814 static void queue_check_input_done(void) {
2815 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2818 static void statemc_setstate(StateMachineState newsms, int periods,
2819 const char *forlog, const char *why) {
2821 until_flush= periods;
2823 const char *xtra= "";
2826 case sm_FLUSHFAILED:
2827 if (!main_input_file) xtra= "-ABSENT";
2831 xtra= flushing_input_file->rd ? "-1" : "-2";
2837 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2839 info("state %s%s %s",forlog,xtra,why);
2843 /*---------- defer and backlog files ----------*/
2845 static void open_defer(void) {
2850 defer= fopen(path_defer, "a+");
2851 if (!defer) sysfatal("could not open defer file %s", path_defer);
2853 /* truncate away any half-written records */
2855 mfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2857 if (stab.st_size > LONG_MAX)
2858 crash("defer file %s size is far too large", path_defer);
2863 long orgsize= stab.st_size;
2864 long truncto= stab.st_size;
2866 if (!truncto) break; /* was only (if anything) one half-truncated record */
2867 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2868 syscrash("seek in defer file %s while truncating partial", path_defer);
2873 syscrash("failed read from defer file %s", path_defer);
2875 crash("defer file %s shrank while we were checking it!", path_defer);
2881 if (stab.st_size != truncto) {
2882 warn("truncating half-record at end of defer file %s -"
2883 " shrinking by %ld bytes from %ld to %ld",
2884 path_defer, orgsize - truncto, orgsize, truncto);
2887 sysfatal("could not flush defer file %s", path_defer);
2888 if (ftruncate(fileno(defer), truncto))
2889 syscrash("could not truncate defer file %s", path_defer);
2892 info("continuing existing defer file %s (%ld bytes)",
2893 path_defer, orgsize);
2895 if (fseek(defer, truncto, SEEK_SET))
2896 syscrash("could not seek to new end of defer file %s", path_defer);
2899 static void close_defer(void) {
2904 mfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2906 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2909 time_t now= mtime();
2911 char *backlog= masprintf("%s_backlog_%lu.%lu", feedfile,
2913 (unsigned long)stab.st_ino);
2914 if (link(path_defer, backlog))
2915 sysfatal("could not install defer file %s as backlog file %s",
2916 path_defer, backlog);
2917 if (unlink(path_defer))
2918 syscrash("could not unlink old defer link %s to backlog file %s",
2919 path_defer, backlog);
2923 if (until_backlog_nextscan < 0 ||
2924 until_backlog_nextscan > backlog_retry_minperiods + 1)
2925 until_backlog_nextscan= backlog_retry_minperiods + 1;
2928 static void poll_backlog_file(void) {
2929 if (until_backlog_nextscan < 0) return;
2930 if (until_backlog_nextscan-- > 0) return;
2931 search_backlog_file();
2934 static void search_backlog_file(void) {
2935 /* returns non-0 iff there are any backlog files */
2940 const char *oldest_path=0;
2941 time_t oldest_mtime=0, now;
2943 if (backlog_input_file) return;
2947 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2951 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2953 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2955 for (i=0; i<gl.gl_pathc; i++) {
2956 const char *path= gl.gl_pathv[i];
2958 if (strchr(path,'#') || strchr(path,'~')) {
2959 debug("backlog file search skipping %s", path);
2962 r= stat(path, &stab);
2964 syswarn("failed to stat backlog file %s", path);
2967 if (!S_ISREG(stab.st_mode)) {
2968 warn("backlog file %s is not a plain file (or link to one)", path);
2971 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2973 oldest_mtime= stab.st_mtime;
2976 case GLOB_NOMATCH: /* fall through */
2979 syscrash("glob expansion of backlog pattern %s gave unexpected"
2980 " nonzero (error?) return value %d", globpat_backlog, r);
2984 debug("backlog scan: none");
2986 if (sms==sm_DROPPED) {
2988 notice("feed dropped and our work is complete");
2990 int r= unlink(path_cli);
2991 if (r && errno!=ENOENT)
2992 syswarn("failed to unlink cli socket for old feed");
2994 munlink(path_lock, "lockfile for old feed");
2997 until_backlog_nextscan= backlog_spontrescan_periods;
3002 double age= difftime(now, oldest_mtime);
3003 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
3005 if (age_deficiency <= 0) {
3006 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
3007 age, age_deficiency, oldest_path);
3009 backlog_input_file= open_input_file(oldest_path);
3010 if (!backlog_input_file) {
3011 warn("backlog file %s vanished as we opened it", oldest_path);
3015 inputfile_reading_start(backlog_input_file);
3016 until_backlog_nextscan= -1;
3020 until_backlog_nextscan= age_deficiency / period_seconds;
3022 if (backlog_spontrescan_periods >= 0 &&
3023 until_backlog_nextscan > backlog_spontrescan_periods)
3024 until_backlog_nextscan= backlog_spontrescan_periods;
3026 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
3027 age, age_deficiency, until_backlog_nextscan, oldest_path);
3034 /*---------- shutdown and signal handling ----------*/
3036 static void preterminate(void) {
3037 if (in_child) return;
3038 notice_processed(main_input_file,0,"feedfile","");
3039 notice_processed(flushing_input_file,0,"flushing","");
3040 if (backlog_input_file)
3041 notice_processed(backlog_input_file,0, "backlog file ",
3042 backlog_input_file->path);
3045 static int signal_self_pipe[2];
3046 static sig_atomic_t terminate_sig_flag;
3048 static void raise_default(int signo) {
3049 msigsetdefault(signo);
3054 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3055 assert(fd=signal_self_pipe[0]);
3057 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3058 if (r<0 && !isewouldblock(errno))
3059 syscrash("failed to read signal self pipe");
3060 if (r==0) crash("eof on signal self pipe");
3061 if (terminate_sig_flag) {
3063 notice("terminating (%s)", strsignal(terminate_sig_flag));
3064 raise_default(terminate_sig_flag);
3066 return OOP_CONTINUE;
3069 static void sigarrived_handler(int signum) {
3074 if (!terminate_sig_flag) terminate_sig_flag= signum;
3079 write(signal_self_pipe[1],&x,1);
3082 static void init_signals(void) {
3083 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3084 syscrash("could not ignore SIGPIPE");
3086 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3088 msetnonblock(signal_self_pipe[0],1);
3089 msetnonblock(signal_self_pipe[1],1);
3091 struct sigaction sa;
3092 memset(&sa,0,sizeof(sa));
3093 sa.sa_handler= sigarrived_handler;
3094 sa.sa_flags= SA_RESTART;
3095 msigaction(SIGTERM,&sa);
3096 msigaction(SIGINT,&sa);
3098 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3101 /*========== flushing the feed ==========*/
3103 static pid_t inndcomm_child;
3104 static int inndcomm_sentinel_fd;
3106 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3107 assert(inndcomm_child);
3108 assert(fd == inndcomm_sentinel_fd);
3109 int status= mwaitpid(&inndcomm_child, "inndcomm");
3112 cancel_fd_read_except(fd);
3113 mclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3114 inndcomm_sentinel_fd= 0;
3116 assert(!flushing_input_file);
3118 if (WIFEXITED(status)) {
3119 switch (WEXITSTATUS(status)) {
3121 case INNDCOMMCHILD_ESTATUS_FAIL:
3124 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3125 notice("feed has been dropped by innd, finishing up");
3126 flushing_input_file= main_input_file;
3127 tailing_make_readable(flushing_input_file);
3128 /* we probably previously returned EAGAIN from our fake read method
3129 * when in fact we were at EOF, so signal another readable event
3130 * so we actually see the EOF */
3134 if (flushing_input_file) {
3135 SMS(DROPPING, max_separated_periods,
3136 "feed dropped by innd, but must finish last flush");
3139 SMS(DROPPED, 0, "feed dropped by innd");
3140 search_backlog_file();
3142 return OOP_CONTINUE;
3146 flushing_input_file= main_input_file;
3147 tailing_make_readable(flushing_input_file);
3149 main_input_file= open_input_file(feedfile);
3150 if (!main_input_file)
3151 crash("flush succeeded but feedfile %s does not exist!"
3152 " (this probably means feedfile does not correspond"
3153 " to site %s in newsfeeds)", feedfile, sitename);
3155 if (flushing_input_file) {
3156 SMS(SEPARATED, max_separated_periods, "flush complete");
3159 SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3161 return OOP_CONTINUE;
3164 goto unexpected_exitstatus;
3167 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3168 warn("flush timed out trying to talk to innd");
3171 unexpected_exitstatus:
3172 report_child_status("inndcomm child", status);
3176 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3177 return OOP_CONTINUE;
3180 static void inndcommfail(const char *what) {
3181 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3182 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3185 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3188 notice("flushing %s",why);
3190 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3191 assert(!inndcomm_child);
3192 assert(!inndcomm_sentinel_fd);
3194 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3196 inndcomm_child= mfork("inndcomm child");
3198 if (!inndcomm_child) {
3199 const char *flushargv[2]= { sitename, 0 };
3203 mclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3204 /* parent spots the autoclose of pipefds[1] when we die or exit */
3206 if (simulate_flush>=0) {
3207 warn("SIMULATING flush child status %d", simulate_flush);
3208 if (simulate_flush>128) raise(simulate_flush-128);
3209 else exit(simulate_flush);
3212 alarm(inndcomm_flush_timeout);
3213 r= ICCopen(); if (r) inndcommfail("connect");
3214 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3215 if (!r) exit(0); /* yay! */
3217 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3218 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3219 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3224 mclose(pipefds[1], "inndcomm sentinel child's end",0);
3225 inndcomm_sentinel_fd= pipefds[0];
3226 assert(inndcomm_sentinel_fd);
3227 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3229 SMS(FLUSHING, 0, why);
3232 /*========== main program ==========*/
3234 static void postfork_inputfile(InputFile *ipf) {
3236 mclose(ipf->fd, "(in child) input file ", ipf->path);
3239 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3240 /* we have no stdio streams that are buffered long-term */
3242 if (fclose(f)) syscrash("(in child) close %s%s", what, what2?what2:0);
3245 static void postfork(void) {
3248 msigsetdefault(SIGTERM);
3249 msigsetdefault(SIGINT);
3250 msigsetdefault(SIGPIPE);
3251 if (terminate_sig_flag) raise(terminate_sig_flag);
3253 postfork_inputfile(main_input_file);
3254 postfork_inputfile(flushing_input_file);
3258 conn_closefd(conn,"(in child) ");
3260 postfork_stdio(defer, "defer file ", path_defer);
3263 typedef struct Every Every;
3265 struct timeval interval;
3270 static void every_schedule(Every *e, struct timeval base);
3272 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3275 if (!e->fixed_rate) mgettimeofday(&base);
3276 every_schedule(e, base);
3277 return OOP_CONTINUE;
3280 static void every_schedule(Every *e, struct timeval base) {
3281 struct timeval when;
3282 timeradd(&base, &e->interval, &when);
3283 loop->on_time(loop, when, every_happens, e);
3286 static void every(int interval, int fixed_rate, void (*f)(void)) {
3287 NEW_DECL(Every *,e);
3288 e->interval.tv_sec= interval;
3289 e->interval.tv_usec= 0;
3290 e->fixed_rate= fixed_rate;
3293 mgettimeofday(&now);
3294 every_schedule(e, now);
3297 static void filepoll(void) {
3298 tailing_make_readable(main_input_file);
3299 tailing_make_readable(flushing_input_file);
3302 static char *debug_report_ipf(InputFile *ipf) {
3303 if (!ipf) return masprintf("none");
3305 const char *slash= strrchr(ipf->path,'/');
3306 const char *path= slash ? slash+1 : ipf->path;
3308 return masprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3310 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3311 (long)ipf->offset, ipf->fd,
3312 ipf->rd ? "" : ",!rd",
3313 ipf->skippinglong ? "*skiplong" : "",
3314 ipf->rd && ipf->paused ? "*paused" : "");
3317 static void period(void) {
3318 char *dipf_main= debug_report_ipf(main_input_file);
3319 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3320 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3323 " sms=%s[%d] conns=%d until_connect=%d"
3324 " input_files main:%s flushing:%s backlog:%s[%d]"
3325 " children connecting=%ld inndcomm=%ld lowvol_total=%d"
3327 sms_names[sms], until_flush, conns.count, until_connect,
3328 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3329 (long)connecting_child, (long)inndcomm_child, lowvol_total
3333 free(dipf_flushing);
3336 if (until_connect) until_connect--;
3338 inputfile_queue_check_expired(backlog_input_file);
3339 poll_backlog_file();
3340 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3341 statemc_period_poll();
3342 check_assign_articles();
3347 /*========== dumping state ==========*/
3349 static void dump_article_list(FILE *f, const CliCommand *c,
3350 const ArticleList *al) {
3351 fprintf(f, " count=%d\n", al->count);
3352 if (!c->xval) return;
3354 int i; Article *art;
3355 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3356 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3357 DUMPV("%p", art->,ipf);
3358 DUMPV("%d", art->,missing);
3359 DUMPV("%lu", (unsigned long)art->,offset);
3360 DUMPV("%d", art->,blanklen);
3361 DUMPV("%d", art->,midlen);
3362 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3366 static void dump_input_file(FILE *f, const CliCommand *c,
3367 InputFile *ipf, const char *wh) {
3368 char *dipf= debug_report_ipf(ipf);
3369 fprintf(f,"input %s %s", wh, dipf);
3373 DUMPV("%d", ipf->,readcount_ok);
3374 DUMPV("%d", ipf->,readcount_blank);
3375 DUMPV("%d", ipf->,readcount_err);
3376 DUMPV("%d", ipf->,count_nooffer_missing);
3380 ArtState state; const char *const *statename;
3381 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3382 #define RC_DUMP_FMT(x) " " #x "=%d"
3383 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3384 fprintf(f,"input %s counts %-11s"
3385 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3387 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3389 fprintf(f,"input %s queue", wh);
3390 dump_article_list(f,c,&ipf->queue);
3396 fprintf(cc->out, "dumping state to %s\n", path_dump);
3397 FILE *f= fopen(path_dump, "w");
3398 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3400 fprintf(f,"general");
3401 DUMPV("%s", sms_names,[sms]);
3402 DUMPV("%d", ,until_flush);
3403 DUMPV("%ld", (long),self_pid);
3404 DUMPV("%p", , defer);
3405 DUMPV("%d", , until_connect);
3406 DUMPV("%d", , until_backlog_nextscan);
3407 DUMPV("%d", , simulate_flush);
3408 fprintf(f,"\nnocheck");
3409 DUMPV("%#.10f", , accept_proportion);
3410 DUMPV("%d", , nocheck);
3411 DUMPV("%d", , nocheck_reported);
3414 fprintf(f,"special");
3415 DUMPV("%ld", (long),connecting_child);
3416 DUMPV("%d", , connecting_fdpass_sock);
3417 DUMPV("%d", , cli_master);
3420 fprintf(f,"lowvol");
3421 DUMPV("%d", , lowvol_circptr);
3422 DUMPV("%d", , lowvol_total);
3424 for (i=0; i<lowvol_periods; i++) {
3426 if (i==lowvol_circptr) fprintf(f,"*");
3427 fprintf(f,"%d",lowvol_perperiod[i]);
3431 fprintf(f,"filemon ");
3432 filemon_method_dump_info(f);
3434 dump_input_file(f,c, main_input_file, "main" );
3435 dump_input_file(f,c, flushing_input_file, "flushing");
3436 dump_input_file(f,c, backlog_input_file, "backlog" );
3438 fprintf(f,"conns count=%d\n", conns.count);
3443 fprintf(f,"C%d",conn->fd);
3444 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3445 DUMPV("%d",conn->,stream); DUMPV("\"%s\"",conn->,quitting);
3446 DUMPV("%d",conn->,since_activity);
3449 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3450 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3451 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3453 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3454 for (i=0; i<conn->xmitu; i++) {
3455 const struct iovec *iv= &conn->xmit[i];
3456 const XmitDetails *xd= &conn->xmitd[i];
3459 case xk_Const: dinfo= masprintf("Const"); break;
3460 case xk_Artdata: dinfo= masprintf("A%p", xd->info.sm_art); break;
3464 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3465 sanitise(iv->iov_base, iv->iov_len));
3471 DUMPV("%s", , feedfile);
3472 DUMPV("%s", , path_cli);
3473 DUMPV("%s", , path_lock);
3474 DUMPV("%s", , path_flushing);
3475 DUMPV("%s", , path_defer);
3476 DUMPV("%s", , path_dump);
3477 DUMPV("%s", , globpat_backlog);
3480 if (!!ferror(f) + !!fclose(f)) {
3481 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3486 /*========== option parsing ==========*/
3488 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3489 static void vbadusage(const char *fmt, va_list al) {
3490 char *m= mvasprintf(fmt,al);
3491 fprintf(stderr, "bad usage: %s\n"
3492 "say --help for help, or read the manpage\n",
3494 if (interactive < 2)
3495 syslog(LOG_CRASH,"innduct: invoked with bad usage: %s",m);
3499 /*---------- generic option parser ----------*/
3501 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3502 static void badusage(const char *fmt, ...) {
3509 of_seconds= 001000u,
3510 of_boolean= 002000u,
3513 typedef struct Option Option;
3514 typedef void OptionParser(const Option*, const char *val);
3518 const char *lng, *formarg;
3524 static void parse_options(const Option *options, char ***argvp) {
3525 /* on return *argvp is first non-option arg; argc is not updated */
3528 const char *arg= *++(*argvp);
3530 if (*arg != '-') break;
3531 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3533 while ((a= *++arg)) {
3537 char *equals= strchr(arg,'=');
3538 int len= equals ? (equals - arg) : strlen(arg);
3539 for (o=options; o->shrt || o->lng; o++)
3540 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3542 badusage("unknown long option --%s",arg);
3545 if (equals) badusage("option --%s does not take a value",o->lng);
3547 } else if (equals) {
3551 if (!arg) badusage("option --%s needs a value for %s",
3552 o->lng, o->formarg);
3555 break; /* eaten the whole argument now */
3557 for (o=options; o->shrt || o->lng; o++)
3560 badusage("unknown short option -%c",a);
3567 if (!arg) badusage("option -%c needs a value for %s",
3568 o->shrt, o->formarg);
3571 break; /* eaten the whole argument now */
3577 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3579 static void print_options(const Option *options, FILE *f) {
3581 for (o=options; o->shrt || o->lng; o++) {
3582 char shrt[2] = { o->shrt, 0 };
3583 char *optspec= masprintf("%s%s%s%s%s",
3584 o->shrt ? "-" : "", shrt,
3585 o->shrt && o->lng ? "|" : "",
3586 DELIMPERHAPS("--", o->lng));
3587 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3592 /*---------- specific option types ----------*/
3594 static void op_integer(const Option *o, const char *val) {
3597 unsigned long ul= strtoul(val,&ep,10);
3598 if (*ep || ep==val || errno || ul>INT_MAX)
3599 badusage("bad integer value for %s",o->lng);
3600 int *store= o->store;
3604 static void op_double(const Option *o, const char *val) {
3605 int *store= o->store;
3608 *store= strtod(val, &ep);
3609 if (*ep || ep==val || errno)
3610 badusage("bad floating point value for %s",o->lng);
3613 static void op_string(const Option *o, const char *val) {
3614 const char **store= o->store;
3618 static void op_seconds(const Option *o, const char *val) {
3619 int *store= o->store;
3623 double v= strtod(val,&ep);
3624 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3626 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3627 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3628 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3629 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3630 else if (!strcmp(ep,"das")) unit= 10;
3631 else if (!strcmp(ep,"hs")) unit= 100;
3632 else if (!strcmp(ep,"ks")) unit= 1000;
3633 else if (!strcmp(ep,"Ms")) unit= 1000000;
3634 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3638 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3642 static void op_setint(const Option *o, const char *val) {
3643 int *store= o->store;
3647 /*---------- specific options ----------*/
3649 static void help(const Option *o, const char *val);
3651 static const Option innduct_options[]= {
3652 {'f',"feedfile", "F", &feedfile, op_string },
3653 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3654 {0,"no-daemon", 0, &interactive, op_setint, 1 },
3655 {0,"interactive", 0, &interactive, op_setint, 2 },
3656 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3657 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3658 {'C',"inndconf", "F", &inndconffile, op_string },
3659 {'P',"port", "PORT", &port, op_integer },
3660 {0,"chdir", "DIR", &path_run, op_string },
3661 {0,"cli", "DIR/|PATH", &path_cli, op_string },
3662 {0,"help", 0, 0, help },
3664 {0,"max-connections", "N", &max_connections, op_integer },
3665 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3666 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3667 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3668 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3670 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3671 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3672 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3674 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3675 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3677 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3678 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3679 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3680 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3681 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3682 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3683 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3684 {0,"low-volume-thresh", "PERIOD", &lowvol_thresh, op_integer },
3685 {0,"low-volume-window", "PERIOD", &lowvol_periods, op_seconds },
3687 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3688 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3693 static void printusage(FILE *f) {
3694 fputs("usage: innduct [options] site [fqdn]\n"
3695 "available options are:\n", f);
3696 print_options(innduct_options, f);
3699 static void help(const Option *o, const char *val) {
3701 if (ferror(stdout) || fflush(stdout)) {
3702 perror("innduct: writing help");
3708 static void convert_to_periods_rndup(int *store) {
3709 *store += period_seconds-1;
3710 *store /= period_seconds;
3713 static int path_ends_slash(const char *specified) {
3714 int l= strlen(specified);
3716 return specified[l-1] == '/';
3719 int main(int argc, char **argv) {
3725 parse_options(innduct_options, &argv);
3730 if (!sitename) badusage("need site name argument");
3732 if (*argv) remote_host= *argv++;
3733 else remote_host= sitename;
3735 if (*argv) badusage("too many non-option arguments");
3739 int r= innconf_read(inndconffile);
3740 if (!r) badusage("could not read inn.conf (more info on stderr)");
3742 if (!remote_host) remote_host= sitename;
3744 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3745 badusage("nocheck threshold percentage must be between 0..100");
3746 nocheck_thresh *= 0.01;
3748 if (nocheck_decay < 0.1)
3749 badusage("nocheck decay articles must be at least 0.1");
3750 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3752 convert_to_periods_rndup(&reconnect_delay_periods);
3753 convert_to_periods_rndup(&flushfail_retry_periods);
3754 convert_to_periods_rndup(&backlog_retry_minperiods);
3755 convert_to_periods_rndup(&backlog_spontrescan_periods);
3756 convert_to_periods_rndup(&spontaneous_flush_periods);
3757 convert_to_periods_rndup(&max_separated_periods);
3758 convert_to_periods_rndup(&need_activity_periods);
3759 convert_to_periods_rndup(&lowvol_periods);
3761 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3762 badusage("bad input data ratio must be between 0..100");
3763 max_bad_data_ratio *= 0.01;
3766 path_run= innconf->pathrun;
3768 if (!feedfile) feedfile= sitename;
3769 if (!feedfile[0]) badusage("feed filename, if specified, must be nonempty");
3770 if (path_ends_slash(feedfile))
3771 feedfile= masprintf("%s%s", feedfile, sitename);
3772 if (feedfile[0] != '/')
3773 feedfile= masprintf("%s/%s", innconf->pathoutgoing, feedfile);
3776 path_cli_dir= "innduct";
3777 } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3778 path_cli= 0; /* ok, don't then */
3779 } else if (path_ends_slash(path_cli)) {
3780 path_cli_dir= masprintf("%.*s", strlen(path_cli)-1, path_cli);
3783 path_cli= masprintf("%s/%s", path_cli_dir, sitename);
3785 if (max_queue_per_ipf<0)
3786 max_queue_per_ipf= max_queue_per_conn * 2;
3788 const char *feedfile_forbidden= "?*[~#";
3790 while ((c= *feedfile_forbidden++))
3791 if (strchr(feedfile, c))
3792 badusage("feed filename may not contain metacharacter %c",c);
3795 lowvol_perperiod= xcalloc(sizeof(*lowvol_perperiod), lowvol_periods);
3796 for (i=0; i<lowvol_periods; i++) {
3797 lowvol_perperiod[i]= lowvol_thresh;
3798 lowvol_total += lowvol_thresh;
3800 lowvol_total -= lowvol_thresh;
3804 path_lock= masprintf("%s_lock", feedfile);
3805 path_flushing= masprintf("%s_flushing", feedfile);
3806 path_defer= masprintf("%s_defer", feedfile);
3807 path_dump= masprintf("%s_dump", feedfile);
3808 globpat_backlog= masprintf("%s_backlog*", feedfile);
3810 oop_source_sys *sysloop= oop_sys_new();
3811 if (!sysloop) syscrash("could not create liboop event loop");
3812 loop= (oop_source*)sysloop;
3816 if (interactive < 1) {
3818 for (i=3; i<255; i++)
3819 /* do this now before we open syslog, etc. */
3823 if (interactive < 2)
3824 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3826 if (interactive < 1) {
3827 int null= open("/dev/null",O_RDWR);
3828 if (null<0) sysfatal("failed to open /dev/null");
3832 mclose(null, "/dev/null original fd",0);
3834 pid_t child1= mfork("daemonise first fork");
3835 if (child1) _exit(0);
3837 pid_t sid= setsid();
3838 if (sid == -1) sysfatal("setsid failed");
3840 pid_t child2= mfork("daemonise second fork");
3841 if (child2) _exit(0);
3845 if (self_pid==-1) syscrash("getpid");
3848 if (r) sysfatal("could not chdir to pathrun %s", path_run);
3857 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3858 r= SMinit(); if (!r) fatal("storage manager initialisation (SMinit) failed");
3860 if (interactive >= 2)
3867 notice("filemon: suppressed by command line option, polling");
3869 filemon_ok= filemon_method_init();
3871 warn("filemon: no file monitoring available, polling");
3874 every(filepoll_seconds,0,filepoll);
3876 every(period_seconds,1,period);
3882 void *run= oop_sys_run(sysloop);
3883 assert(run == OOP_ERROR);
3884 syscrash("event loop failed");