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"
185 #include "inn/messages.h"
188 #include <sys/types.h>
189 #include <sys/wait.h>
190 #include <sys/stat.h>
191 #include <sys/socket.h>
210 #include <oop-read.h>
212 /*----- general definitions, probably best not changed -----*/
214 #define CONNCHILD_ESTATUS_STREAM 24
215 #define CONNCHILD_ESTATUS_NOSTREAM 25
217 #define INNDCOMMCHILD_ESTATUS_FAIL 26
218 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
220 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
221 #define MAX_CLI_COMMAND 1000
223 #define VA va_list al; va_start(al,fmt)
224 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
225 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
226 #define NORET __attribute__((__noreturn__))
228 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
229 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
231 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
233 #define FOR_CONN(conn) \
234 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
236 /*----- doubly linked lists -----*/
238 #define ISNODE(T) struct node list_node
241 union { struct list li; T *for_type; } u; \
245 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
247 #define LIST_CHECKCANHAVENODE(l,n) \
248 ((void)((n) == ((l).u.for_type))) /* just for the type check */
250 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
251 ( LIST_CHECKCANHAVENODE(l,n), \
252 list_addsomehow(&(l).u.li, NODE((n))), \
256 #define LIST_REMSOMEHOW(l,list_remsomehow) \
257 ( (typeof((l).u.for_type)) \
260 list_remsomehow(&(l).u.li) ) \
266 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
267 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
268 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
269 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
271 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
272 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
273 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
274 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
276 #define LIST_REMOVE(l,n) \
277 ( LIST_CHECKCANHAVENODE(l,n), \
278 list_remove(NODE((n))), \
282 #define LIST_INSERT(l,n,pred) \
283 ( LIST_CHECKCANHAVENODE(l,n), \
284 LIST_CHECKCANHAVENODE(l,pred), \
285 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
289 /*----- type predeclarations -----*/
291 typedef struct Conn Conn;
292 typedef struct Article Article;
293 typedef struct InputFile InputFile;
294 typedef struct XmitDetails XmitDetails;
295 typedef struct Filemon_Perfile Filemon_Perfile;
296 typedef enum StateMachineState StateMachineState;
297 typedef struct CliCommand CliCommand;
302 /*----- function predeclarations -----*/
304 static void conn_maybe_write(Conn *conn);
305 static void conn_make_some_xmits(Conn *conn);
306 static void *conn_write_some_xmits(Conn *conn);
308 static void xmit_free(XmitDetails *d);
310 #define SMS(newstate, periods, why) \
311 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
312 static void statemc_setstate(StateMachineState newsms, int periods,
313 const char *forlog, const char *why);
315 static void statemc_start_flush(const char *why); /* Normal => Flushing */
316 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
317 static int trigger_flush_ok(const char *why /* 0 means timeout */);
318 /* => Flushing,FLUSHING, ret 1; or ret 0 */
320 static void article_done(Article *art, int whichcount);
322 static void check_assign_articles(void);
323 static void queue_check_input_done(void);
324 static void check_reading_pause_resume(InputFile *ipf);
326 static void statemc_check_flushing_done(void);
327 static void statemc_check_backlog_done(void);
329 static void postfork(void);
330 static void period(void);
332 static void open_defer(void);
333 static void close_defer(void);
334 static void search_backlog_file(void);
335 static void preterminate(void);
336 static void raise_default(int signo) NORET;
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 logging, simulation, debugging, etc. */
544 int simulate_flush= -1;
546 static const char *logv_prefix="";
548 /*========== logging ==========*/
550 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
551 static void logcore(int sysloglevel, const char *fmt, ...) {
553 if (logv_use_syslog) {
554 vsyslog(sysloglevel,fmt,al);
556 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
557 vfprintf(stderr,fmt,al);
563 static void logv(int sysloglevel, const char *pfx, int errnoval,
564 const char *fmt, va_list al) PRINTF(5,0);
565 static void logv(int sysloglevel, const char *pfx, int errnoval,
566 const char *fmt, va_list al) {
567 char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
568 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
569 msgbuf[sizeof(msgbuf)-1]= 0;
571 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
572 sysloglevel= LOG_ERR; /* run by wrong user, probably */
574 logcore(sysloglevel, "%s%s: %s%s%s",
575 logv_prefix, pfx, msgbuf,
576 errnoval>=0 ? ": " : "",
577 errnoval>=0 ? strerror(errnoval) : "");
580 #define DEFFATAL(fn, pfx, sysloglevel, err, estatus) \
581 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
582 static void fn(const char *fmt, ...) { \
585 logv(sysloglevel, pfx, err, fmt, al); \
589 #define DEFLOG(fn, pfx, sysloglevel, err) \
590 static void fn(const char *fmt, ...) PRINTF(1,2); \
591 static void fn(const char *fmt, ...) { \
593 logv(sysloglevel, pfx, err, fmt, al); \
597 #define INNLOGSET_DECLARE(fn, pfx, sysloglevel) \
598 static void duct_log_##fn(int l, const char *fmt, va_list al, int errval) { \
599 logv(sysloglevel, pfx, errval ? errval : -1, fmt, al); \
601 #define INNLOGSET_CALL(fn, pfx, sysloglevel) \
602 message_handlers_##fn(1, duct_log_##fn);
605 static int innduct_fatal_cleanup(void) { return 12; } /* used for libinn die */
607 /* We want to extend the set of logging functions from inn, and we
608 * want to prepend the site name to all our messages. */
610 DEFFATAL(syscrash, "critical", LOG_CRIT, errno, 16);
611 DEFFATAL(crash, "critical", LOG_CRIT, -1, 16);
613 #define INNLOGSETS(INNLOGSET) \
614 INNLOGSET(die, "fatal", LOG_ERR) \
615 INNLOGSET(warn, "warning", LOG_WARNING) \
616 INNLOGSET(notice, "notice", LOG_NOTICE) \
617 INNLOGSET(trace, "trace", LOG_NOTICE)
618 INNLOGSETS(INNLOGSET_DECLARE)
620 DEFLOG(info, "info", LOG_INFO, -1)
621 DEFLOG(dbg, "debug", LOG_DEBUG, -1)
624 /*========== utility functions etc. ==========*/
626 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
627 static char *xvasprintf(const char *fmt, va_list al) {
629 int rc= vasprintf(&str,fmt,al);
630 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
633 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
634 static char *xasprintf(const char *fmt, ...) {
636 char *str= xvasprintf(fmt,al);
641 static int close_perhaps(int *fd) {
642 if (*fd <= 0) return 0;
647 static void xclose(int fd, const char *what, const char *what2) {
649 if (r) syscrash("close %s%s",what,what2?what2:"");
651 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
652 if (*fd <= 0) return;
653 xclose(*fd,what,what2);
657 static pid_t xfork(const char *what) {
661 if (child==-1) sysdie("cannot fork for %s",what);
662 dbg("forked %s %ld", what, (unsigned long)child);
663 if (!child) postfork();
667 static void on_fd_read_except(int fd, oop_call_fd callback) {
668 loop->on_fd(loop, fd, OOP_READ, callback, 0);
669 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
671 static void cancel_fd_read_except(int fd) {
672 loop->cancel_fd(loop, fd, OOP_READ);
673 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
676 static void report_child_status(const char *what, int status) {
677 if (WIFEXITED(status)) {
678 int es= WEXITSTATUS(status);
680 warn("%s: child died with error exit status %d", what, es);
681 } else if (WIFSIGNALED(status)) {
682 int sig= WTERMSIG(status);
683 const char *sigstr= strsignal(sig);
684 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
686 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
688 warn("%s: child died due to unknown fatal signal %d%s",
689 what, sig, coredump);
691 warn("%s: child died with unknown wait status %d", what,status);
695 static int xwaitpid(pid_t *pid, const char *what) {
698 int r= kill(*pid, SIGKILL);
699 if (r) syscrash("cannot kill %s child", what);
701 pid_t got= waitpid(*pid, &status, 0);
702 if (got==-1) syscrash("cannot reap %s child", what);
703 if (got==0) crash("cannot reap %s child", what);
710 static void *zxmalloc(size_t sz) {
711 void *p= xmalloc(sz);
716 static void xunlink(const char *path, const char *what) {
718 if (r) syscrash("can't unlink %s %s", path, what);
721 static time_t xtime(void) {
723 if (now==-1) syscrash("time(2) failed");
727 static void xsigaction(int signo, const struct sigaction *sa) {
728 int r= sigaction(signo,sa,0);
729 if (r) syscrash("sigaction failed for \"%s\"", strsignal(signo));
732 static void xsigsetdefault(int signo) {
734 memset(&sa,0,sizeof(sa));
735 sa.sa_handler= SIG_DFL;
736 xsigaction(signo,&sa);
739 static void xgettimeofday(struct timeval *tv_r) {
740 int r= gettimeofday(tv_r,0);
741 if (r) syscrash("gettimeofday(2) failed");
744 static void xsetnonblock(int fd, int nonblocking) {
745 int errnoval= oop_fd_nonblock(fd, nonblocking);
746 if (errnoval) { errno= errnoval; syscrash("setnonblocking"); }
749 static void check_isreg(const struct stat *stab, const char *path,
751 if (!S_ISREG(stab->st_mode))
752 crash("%s %s not a plain file (mode 0%lo)",
753 what, path, (unsigned long)stab->st_mode);
756 static void xfstat(int fd, struct stat *stab_r, const char *what) {
757 int r= fstat(fd, stab_r);
758 if (r) syscrash("could not fstat %s", what);
761 static void xfstat_isreg(int fd, struct stat *stab_r,
762 const char *path, const char *what) {
763 xfstat(fd, stab_r, what);
764 check_isreg(stab_r, path, what);
767 static void xlstat_isreg(const char *path, struct stat *stab,
768 int *enoent_r /* 0 means ENOENT is fatal */,
770 int r= lstat(path, stab);
772 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
773 syscrash("could not lstat %s %s", what, path);
775 if (enoent_r) *enoent_r= 0;
776 check_isreg(stab, path, what);
779 static int samefile(const struct stat *a, const struct stat *b) {
780 assert(S_ISREG(a->st_mode));
781 assert(S_ISREG(b->st_mode));
782 return (a->st_ino == b->st_ino &&
783 a->st_dev == b->st_dev);
786 static char *sanitise(const char *input, int len) {
787 static char sanibuf[100]; /* returns pointer to this buffer! */
789 const char *p= input;
790 const char *endp= len>=0 ? input+len : 0;
794 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
795 int c= (!endp || p<endp) ? *p++ : 0;
796 if (!c) { *q++= '\''; *q=0; break; }
797 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
798 sprintf(q,"\\x%02x",c);
804 static int isewouldblock(int errnoval) {
805 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
808 /*========== command and control (CLI) connections ==========*/
810 static int cli_master;
812 typedef struct CliConn CliConn;
814 void (*destroy)(CliConn*);
820 struct sockaddr_un un;
825 static const oop_rd_style cli_rd_style= {
826 OOP_RD_DELIM_STRIP, '\n',
828 OOP_RD_SHORTREC_FORBID
831 static void cli_destroy(CliConn *cc) {
835 static void cli_checkouterr(CliConn *cc /* may destroy*/) {
836 if (ferror(cc->out) | fflush(cc->out)) {
837 info("CTRL%d write error %s", cc->fd, strerror(errno));
842 static void cli_prompt(CliConn *cc /* may destroy*/) {
843 fprintf(cc->out, "%s| ", sitename);
849 void (*f)(CliConn *cc, const CliCommand *ccmd,
850 const char *arg, size_t argsz);
855 static const CliCommand cli_commands[];
858 static void ccmd_##wh(CliConn *cc, const CliCommand *c, \
859 const char *arg, size_t argsz)
862 fputs("commands:\n", cc->out);
863 const CliCommand *ccmd;
864 for (ccmd=cli_commands; ccmd->cmd; ccmd++)
865 fprintf(cc->out, " %s\n", ccmd->cmd);
866 fputs("NB: permissible arguments are not shown above."
867 " Not all commands listed are safe. See innduct(8).\n", cc->out);
871 int ok= trigger_flush_ok("manual request");
872 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
877 notice("terminating (CTRL%d)",cc->fd);
878 raise_default(SIGTERM);
884 /* messing with our head: */
885 CCMD(period) { period(); }
886 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
887 CCMD(setint) { *(int*)c->xdata= c->xval; }
888 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
890 static const CliCommand cli_commands[]= {
892 { "flush", ccmd_flush },
893 { "stop", ccmd_stop },
894 { "dump q", ccmd_dump, 0,0 },
895 { "dump a", ccmd_dump, 0,1 },
897 { "p", ccmd_period },
899 #define POKES(cmd,func) \
900 { cmd "flush", func, &until_flush, 1 }, \
901 { cmd "conn", func, &until_connect, 0 }, \
902 { cmd "blscan", func, &until_backlog_nextscan, 0 },
903 POKES("next ", ccmd_setint)
904 POKES("prod ", ccmd_setint_period)
906 { "pretend flush", ccmd_setintarg, &simulate_flush },
907 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
911 static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
912 const char *errmsg, int errnoval,
913 const char *data, size_t recsz, void *cc_v) {
917 info("CTRL%d closed", cc->fd);
922 if (recsz == 0) goto prompt;
924 const CliCommand *ccmd;
925 for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
926 int l= strlen(ccmd->cmd);
927 if (recsz < l) continue;
928 if (recsz > l && data[l] != ' ') continue;
929 if (memcmp(data, ccmd->cmd, l)) continue;
931 int argl= (int)recsz - (l+1);
932 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
936 fputs("unknown command; h for help\n", cc->out);
943 static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
944 const char *errmsg, int errnoval,
945 const char *data, size_t recsz, void *cc_v) {
948 info("CTRL%d read error %s", cc->fd, errmsg);
953 static int cli_conn_startup(CliConn *cc /* may destroy*/,
955 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
956 if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
958 int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
961 if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
963 info("CTRL%d %s ready", cc->fd, how);
968 static void cli_stdio_destroy(CliConn *cc) {
970 oop_rd_cancel(cc->rd);
971 errno= oop_rd_delete_tidy(cc->rd);
972 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
977 static void cli_stdio(void) {
978 NEW_DECL(CliConn *,cc);
979 cc->destroy= cli_stdio_destroy;
983 int r= cli_conn_startup(cc,"stdio");
984 if (r) cc->destroy(cc);
987 static void cli_accepted_destroy(CliConn *cc) {
989 oop_rd_cancel(cc->rd);
990 oop_rd_delete_kill(cc->rd);
992 if (cc->out) { fclose(cc->out); cc->fd=0; }
993 close_perhaps(&cc->fd);
997 static void *cli_master_readable(oop_source *lp, int master,
998 oop_event ev, void *u) {
999 NEW_DECL(CliConn *,cc);
1000 cc->destroy= cli_accepted_destroy;
1002 cc->salen= sizeof(cc->sa);
1003 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
1004 if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
1006 cc->out= fdopen(cc->fd, "w");
1007 if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
1009 int r= cli_conn_startup(cc, "accepted");
1012 return OOP_CONTINUE;
1016 return OOP_CONTINUE;
1019 #define NOCLI(...) do{ \
1020 syswarn("no cli listener, because failed to " __VA_ARGS__); \
1024 static void cli_init(void) {
1027 struct sockaddr_un un;
1030 memset(&sa,0,sizeof(sa));
1031 int maxlen= sizeof(sa.un.sun_path);
1034 info("control command line disabled");
1038 int pathlen= strlen(path_cli);
1039 if (pathlen > maxlen) {
1040 warn("no cli listener, because cli socket path %s too long (%d>%d)",
1041 path_cli, pathlen, maxlen);
1046 int r= mkdir(path_cli_dir, 0700);
1047 if (r && errno!=EEXIST)
1048 NOCLI("create cli socket directory %s", path_cli_dir);
1051 int r= unlink(path_cli);
1052 if (r && errno!=ENOENT)
1053 NOCLI("remove old cli socket %s", path_cli);
1055 cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1056 if (cli_master<0) NOCLI("create new cli master socket");
1058 int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1059 sa.un.sun_family= AF_UNIX;
1060 memcpy(sa.un.sun_path, path_cli, pathlen);
1062 r= bind(cli_master, &sa.sa, sl);
1063 if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1065 r= listen(cli_master, 5);
1066 if (r) NOCLI("listen to cli master socket");
1068 xsetnonblock(cli_master, 1);
1070 loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1071 info("cli ready, listening on %s", path_cli);
1076 xclose_perhaps(&cli_master, "cli master",0);
1080 /*========== management of connections ==========*/
1082 static void reconnect_blocking_event(void) {
1083 until_connect= reconnect_delay_periods;
1086 static void conn_closefd(Conn *conn, const char *msgprefix) {
1087 int r= close_perhaps(&conn->fd);
1088 if (r) info("C%d %serror closing socket: %s",
1089 conn->fd, msgprefix, strerror(errno));
1092 static int conn_busy(Conn *conn) {
1094 conn->waiting.count ||
1095 conn->priority.count ||
1100 static void conn_dispose(Conn *conn) {
1103 oop_rd_cancel(conn->rd);
1104 oop_rd_delete_kill(conn->rd);
1108 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1109 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1111 conn_closefd(conn,"");
1115 static void *conn_exception(oop_source *lp, int fd,
1116 oop_event ev, void *conn_v) {
1119 assert(fd == conn->fd);
1120 assert(ev == OOP_EXCEPTION);
1121 int r= read(conn->fd, &ch, 1);
1122 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1123 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1124 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1125 return OOP_CONTINUE;
1128 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1129 int requeue[art_MaxState];
1130 memset(requeue,0,sizeof(requeue));
1134 while ((art= LIST_REMHEAD(conn->priority)))
1135 LIST_ADDTAIL(art->ipf->queue, art);
1137 while ((art= LIST_REMHEAD(conn->waiting)))
1138 LIST_ADDTAIL(art->ipf->queue, art);
1140 while ((art= LIST_REMHEAD(conn->sent))) {
1141 requeue[art->state]++;
1142 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1143 LIST_ADDTAIL(art->ipf->queue,art);
1144 check_reading_pause_resume(art->ipf);
1149 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1152 LIST_REMOVE(conns,conn);
1154 char *m= xvasprintf(fmt,al);
1155 warn("C%d (now %d) connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1156 conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1159 reconnect_blocking_event();
1161 check_assign_articles();
1164 static void connfail(Conn *conn, const char *fmt, ...) {
1167 vconnfail(conn,fmt,al);
1171 static void conn_idle_close(Conn *conn, const char *why) {
1172 static const char quitcmd[]= "QUIT\r\n";
1173 int todo= sizeof(quitcmd)-1;
1174 const char *p= quitcmd;
1176 int r= write(conn->fd, p, todo);
1178 if (isewouldblock(errno))
1179 connfail(conn, "blocked writing QUIT to idle connection");
1181 connfail(conn, "failed to write QUIT to idle connection: %s",
1188 conn->quitting= why;
1189 conn->since_activity= 0;
1190 dbg("C%d is idle (%s), quitting", conn->fd, why);
1197 * For our last connection, we also shut it down if we have had
1198 * less than K in the last L
1200 static void check_idle_conns(void) {
1203 int volthisperiod= lowvol_perperiod[lowvol_circptr];
1205 lowvol_circptr %= lowvol_periods;
1206 lowvol_total += volthisperiod;
1207 lowvol_total -= lowvol_perperiod[lowvol_circptr];
1208 lowvol_perperiod[lowvol_circptr]= 0;
1211 conn->since_activity++;
1215 if (conn->since_activity <= need_activity_periods) continue;
1217 /* We need to shut this down */
1219 connfail(conn,"timed out waiting for response to QUIT (%s)",
1221 else if (conn->sent.count)
1222 connfail(conn,"timed out waiting for responses");
1223 else if (conn->waiting.count || conn->priority.count)
1224 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1225 else if (conn->xmitu)
1226 connfail(conn,"peer has been sending responses"
1227 " before receiving our commands!");
1229 conn_idle_close(conn, "no activity");
1234 conn= LIST_HEAD(conns);
1235 if (!volthisperiod &&
1237 lowvol_total < lowvol_thresh &&
1239 conn_idle_close(conn, "low volume");
1242 /*---------- making new connections ----------*/
1244 static pid_t connecting_child;
1245 static int connecting_fdpass_sock;
1247 static void connect_attempt_discard(void) {
1248 if (connecting_child) {
1249 int status= xwaitpid(&connecting_child, "connect");
1250 if (!(WIFEXITED(status) ||
1251 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1252 report_child_status("connect", status);
1254 if (connecting_fdpass_sock) {
1255 cancel_fd_read_except(connecting_fdpass_sock);
1256 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1260 #define PREP_DECL_MSG_CMSG(msg) \
1262 struct iovec msgiov; \
1263 msgiov.iov_base= &msgbyte; \
1264 msgiov.iov_len= 1; \
1265 struct msghdr msg; \
1266 memset(&msg,0,sizeof(msg)); \
1267 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1268 msg.msg_iov= &msgiov; \
1269 msg.msg_iovlen= 1; \
1270 msg.msg_control= msg##cbuf; \
1271 msg.msg_controllen= sizeof(msg##cbuf);
1273 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1276 assert(fd == connecting_fdpass_sock);
1278 PREP_DECL_MSG_CMSG(msg);
1280 ssize_t rs= recvmsg(fd, &msg, 0);
1282 if (isewouldblock(errno)) return OOP_CONTINUE;
1283 syswarn("failed to read socket from connecting child");
1288 LIST_INIT(conn->waiting);
1289 LIST_INIT(conn->priority);
1290 LIST_INIT(conn->sent);
1292 struct cmsghdr *h= 0;
1293 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1295 int status= xwaitpid(&connecting_child, "connect child (broken)");
1297 if (WIFEXITED(status)) {
1298 if (WEXITSTATUS(status) != 0 &&
1299 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1300 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1301 /* child already reported the problem */;
1303 if (e == OOP_EXCEPTION)
1304 warn("connect: connection child exited code %d but"
1305 " unexpected exception on fdpass socket",
1306 WEXITSTATUS(status));
1308 warn("connect: connection child exited code %d but"
1310 WEXITSTATUS(status), (int)rs);
1312 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1313 warn("connect: connection attempt timed out");
1315 report_child_status("connect", status);
1320 #define CHK(field, val) \
1321 if (h->cmsg_##field != val) { \
1322 crash("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1323 h->cmsg_##field, val); \
1326 CHK(level, SOL_SOCKET);
1327 CHK(type, SCM_RIGHTS);
1328 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1331 if (CMSG_NXTHDR(&msg,h)) crash("connect: child sent many cmsgs");
1333 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1336 pid_t got= waitpid(connecting_child, &status, 0);
1337 if (got==-1) syscrash("connect: real wait for child");
1338 assert(got == connecting_child);
1339 connecting_child= 0;
1341 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1342 int es= WEXITSTATUS(status);
1344 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1345 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1347 die("connect: child gave unexpected exit status %d", es);
1351 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1353 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1354 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1355 if (!conn->fd) crash("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1356 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1358 &peer_rd_err, conn);
1359 if (r) syscrash("oop_rd_read for peer (fd=%d)",conn->fd);
1361 LIST_ADDHEAD(conns, conn);
1362 notice("C%d (now %d) connected %s",
1363 conn->fd, conns.count, conn->stream ? "streaming" : "plain");
1365 connect_attempt_discard();
1366 check_assign_articles();
1367 return OOP_CONTINUE;
1371 connect_attempt_discard();
1372 reconnect_blocking_event();
1373 return OOP_CONTINUE;
1376 static int allow_connect_start(void) {
1377 return conns.count < max_connections
1378 && !connecting_child
1382 static void connect_start(void) {
1383 assert(!connecting_child);
1384 assert(!connecting_fdpass_sock);
1386 info("starting connection attempt");
1387 int ok_until_connect= until_connect;
1388 reconnect_blocking_event();
1391 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1392 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1394 connecting_child= xfork("connection");
1396 if (!connecting_child) {
1397 FILE *cn_from, *cn_to;
1398 char buf[NNTP_STRLEN+100];
1399 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1401 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1403 alarm(connection_setup_timeout);
1404 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1408 unsigned char c= buf[l-1];
1409 if (!isspace(c)) break;
1410 if (c=='\n' || c=='\r') stripped=1;
1414 sysdie("connect: connection attempt failed");
1417 die("connect: %s: %s", stripped ? "rejected" : "failed",
1421 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1422 sysdie("connect: authentication failed");
1424 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1426 sysdie("connect: could not send MODE STREAM");
1427 buf[sizeof(buf)-1]= 0;
1428 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1429 if (ferror(cn_from))
1430 sysdie("connect: could not read response to MODE STREAM");
1432 die("connect: connection close in response to MODE STREAM");
1437 die("connect: response to MODE STREAM is too long: %.100s...",
1439 l--; if (l>0 && buf[l-1]=='\r') l--;
1442 int rcode= strtoul(buf,&ep,10);
1444 die("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1448 exitstatus= CONNCHILD_ESTATUS_STREAM;
1454 warn("connect: unexpected response to MODE STREAM: %.50s",
1460 int fd= fileno(cn_from);
1462 PREP_DECL_MSG_CMSG(msg);
1463 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1464 cmsg->cmsg_level= SOL_SOCKET;
1465 cmsg->cmsg_type= SCM_RIGHTS;
1466 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1467 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1469 msg.msg_controllen= cmsg->cmsg_len;
1470 r= sendmsg(socks[1], &msg, 0);
1471 if (r<0) syscrash("sendmsg failed for new connection");
1472 if (r!=1) crash("sendmsg for new connection gave wrong result %d",r);
1477 xclose(socks[1], "connecting fdpass child's socket",0);
1478 connecting_fdpass_sock= socks[0];
1479 xsetnonblock(connecting_fdpass_sock, 1);
1480 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1483 until_connect= ok_until_connect;
1486 /*---------- assigning articles to conns, and transmitting ----------*/
1488 static Article *dequeue_from(int peek, InputFile *ipf) {
1490 if (peek) return LIST_HEAD(ipf->queue);
1492 Article *art= LIST_REMHEAD(ipf->queue);
1494 check_reading_pause_resume(ipf);
1498 static Article *dequeue(int peek) {
1500 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1501 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1502 art= dequeue_from(peek, main_input_file); if (art) return art;
1506 static void check_assign_articles(void) {
1512 int spare=0, inqueue=0;
1514 /* Find a connection to offer this article. We prefer a busy
1515 * connection to an idle one, provided it's not full. We take the
1516 * first (oldest) and since that's stable, it will mean we fill up
1517 * connections in order. That way if we have too many
1518 * connections, the spare ones will go away eventually.
1521 if (walk->quitting) continue;
1522 inqueue= walk->sent.count + walk->priority.count
1523 + walk->waiting.count;
1524 spare= walk->max_queue - inqueue;
1525 assert(inqueue <= max_queue_per_conn);
1527 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1528 else if (spare>0) /*working*/ { use= walk; break; }
1531 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1533 Article *art= dequeue(0);
1535 LIST_ADDTAIL(use->waiting, art);
1536 lowvol_perperiod[lowvol_circptr]++;
1539 conn_maybe_write(use);
1540 } else if (allow_connect_start()) {
1549 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1550 conn_maybe_write(u);
1551 return OOP_CONTINUE;
1554 static void conn_maybe_write(Conn *conn) {
1556 conn_make_some_xmits(conn);
1558 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1559 conn->oopwriting= 0;
1563 void *rp= conn_write_some_xmits(conn);
1564 if (rp==OOP_CONTINUE) {
1565 if (!conn->oopwriting) {
1566 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1567 conn->oopwriting= 1;
1570 } else if (rp==OOP_HALT) {
1573 /* transmitted everything */
1580 /*---------- expiry, flow control and deferral ----------*/
1583 * flow control notes
1584 * to ensure articles go away eventually
1585 * separate queue for each input file
1587 * every period, check head of backlog queue for expiry with SMretrieve
1588 * if too old: discard, and check next article
1589 * also check every backlog article as we read it
1591 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1592 * one-off: eat queued articles from flushing and write them to defer
1593 * one-off: connfail all connections which have any articles from flushing
1594 * newly read articles from flushing go straight to defer
1595 * this should take care of it and get us out of this state
1596 * to avoid filling up ram needlessly
1598 * limit number of queued articles for each ipf
1599 * pause/resume inputfile tailing
1602 static void check_reading_pause_resume(InputFile *ipf) {
1603 if (ipf->queue.count >= max_queue_per_ipf)
1604 inputfile_reading_pause(ipf);
1606 inputfile_reading_resume(ipf);
1609 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1611 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1613 sysdie("write to defer file %s",path_defer);
1614 article_done(art, whichcount);
1617 static int article_check_expired(Article *art /* must be queued, not conn */) {
1618 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1619 if (artdata) { SMfreearticle(artdata); return 0; }
1621 LIST_REMOVE(art->ipf->queue, art);
1623 art->ipf->count_nooffer_missing++;
1624 article_done(art,-1);
1628 static void inputfile_queue_check_expired(InputFile *ipf) {
1632 Article *art= LIST_HEAD(ipf->queue);
1633 int exp= article_check_expired(art);
1636 check_reading_pause_resume(ipf);
1639 static void article_autodefer(InputFile *ipf, Article *art) {
1641 article_defer(art,-1);
1644 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1646 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1647 if (art->ipf == ipf) return 1;
1651 static void autodefer_input_file_articles(InputFile *ipf) {
1653 while ((art= LIST_REMHEAD(ipf->queue)))
1654 article_autodefer(ipf, art);
1657 static void autodefer_input_file(InputFile *ipf) {
1658 static const char *const abandon= "stuck";
1661 autodefer_input_file_articles(ipf);
1663 if (ipf->inprogress) {
1666 if (has_article_in(&walk->waiting, ipf) ||
1667 has_article_in(&walk->priority, ipf) ||
1668 has_article_in(&walk->sent, ipf))
1669 walk->quitting= abandon;
1671 while (ipf->inprogress) {
1673 if (walk->quitting == abandon) goto found;
1674 abort(); /* where are they ?? */
1677 connfail(walk, "connection is stuck or crawling,"
1678 " and we need to finish flush");
1679 autodefer_input_file_articles(ipf);
1683 check_reading_pause_resume(ipf);
1686 /*========== article transmission ==========*/
1688 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1689 XmitKind kind) { /* caller must then fill in details */
1690 struct iovec *v= &conn->xmit[conn->xmitu];
1691 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1692 v->iov_base= (char*)data;
1698 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1699 xmit_core(conn,data,len, xk_Const);
1701 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1703 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1704 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1708 static void xmit_free(XmitDetails *d) {
1710 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1711 case xk_Const: break;
1716 static void *conn_write_some_xmits(Conn *conn) {
1718 * 0: nothing more to write, no need to call us again
1719 * OOP_CONTINUE: more to write but fd not writeable
1720 * OOP_HALT: disaster, have destroyed conn
1723 int count= conn->xmitu;
1724 if (!count) return 0;
1726 if (count > IOV_MAX) count= IOV_MAX;
1727 ssize_t rs= writev(conn->fd, conn->xmit, count);
1729 if (isewouldblock(errno)) return OOP_CONTINUE;
1730 connfail(conn, "write failed: %s", strerror(errno));
1736 for (done=0; rs; ) {
1737 assert(done<conn->xmitu);
1738 struct iovec *vp= &conn->xmit[done];
1739 XmitDetails *dp= &conn->xmitd[done];
1740 if (rs >= vp->iov_len) {
1742 xmit_free(dp); /* vp->iov_len -= vp->iov_len, etc. */
1745 vp->iov_base= (char*)vp->iov_base + rs;
1747 break; /* rs -= rs */
1750 int newu= conn->xmitu - done;
1751 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1752 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1757 static void conn_make_some_xmits(Conn *conn) {
1759 if (conn->xmitu+5 > CONNIOVS)
1762 Article *art= LIST_REMHEAD(conn->priority);
1763 if (!art) art= LIST_REMHEAD(conn->waiting);
1766 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1767 /* actually send it */
1769 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1772 art->state == art_Unchecked ? art_Unsolicited :
1773 art->state == art_Wanted ? art_Wanted :
1776 if (!artdata) art->missing= 1;
1777 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1781 XMIT_LITERAL("TAKETHIS ");
1782 xmit_noalloc(conn, art->messageid, art->midlen);
1783 XMIT_LITERAL("\r\n");
1784 xmit_artbody(conn, artdata);
1786 article_done(art, -1);
1790 /* we got 235 from IHAVE */
1792 xmit_artbody(conn, artdata);
1794 XMIT_LITERAL(".\r\n");
1798 LIST_ADDTAIL(conn->sent, art);
1804 XMIT_LITERAL("CHECK ");
1806 XMIT_LITERAL("IHAVE ");
1807 xmit_noalloc(conn, art->messageid, art->midlen);
1808 XMIT_LITERAL("\r\n");
1810 assert(art->state == art_Unchecked);
1811 art->ipf->counts[art->state][RC_sent]++;
1812 LIST_ADDTAIL(conn->sent, art);
1817 /*========== handling responses from peer ==========*/
1819 static const oop_rd_style peer_rd_style= {
1820 OOP_RD_DELIM_STRIP, '\n',
1822 OOP_RD_SHORTREC_FORBID
1825 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1826 const char *errmsg, int errnoval,
1827 const char *data, size_t recsz, void *conn_v) {
1829 connfail(conn, "error receiving from peer: %s", errmsg);
1830 return OOP_CONTINUE;
1833 static Article *article_reply_check(Conn *conn, const char *response,
1834 int code_indicates_streaming,
1836 /* 1:yes, -1:no, 0:dontcare */,
1837 const char *sanitised_response) {
1838 Article *art= LIST_HEAD(conn->sent);
1842 "peer gave unexpected response when no commands outstanding: %s",
1843 sanitised_response);
1847 if (code_indicates_streaming) {
1848 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1849 if (!conn->stream) {
1850 connfail(conn, "peer gave streaming response code "
1851 " to IHAVE or subsequent body: %s", sanitised_response);
1854 const char *got_mid= response+4;
1855 int got_midlen= strcspn(got_mid, " \n\r");
1856 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1857 connfail(conn, "peer gave streaming response with syntactically invalid"
1858 " messageid: %s", sanitised_response);
1861 if (got_midlen != art->midlen ||
1862 memcmp(got_mid, art->messageid, got_midlen)) {
1863 connfail(conn, "peer gave streaming response code to wrong article -"
1864 " probable synchronisation problem; we offered: %s;"
1866 art->messageid, sanitised_response);
1871 connfail(conn, "peer gave non-streaming response code to"
1872 " CHECK/TAKETHIS: %s", sanitised_response);
1877 if (must_have_sent>0 && art->state < art_Wanted) {
1878 connfail(conn, "peer says article accepted but"
1879 " we had not sent the body: %s", sanitised_response);
1882 if (must_have_sent<0 && art->state >= art_Wanted) {
1883 connfail(conn, "peer says please sent the article but we just did: %s",
1884 sanitised_response);
1888 Article *art_again= LIST_REMHEAD(conn->sent);
1889 assert(art_again == art);
1893 static void update_nocheck(int accepted) {
1894 accept_proportion *= nocheck_decay;
1895 accept_proportion += accepted * (1.0 - nocheck_decay);
1896 int new_nocheck= accept_proportion >= nocheck_thresh;
1897 if (new_nocheck && !nocheck_reported) {
1898 notice("entering nocheck mode for the first time");
1899 nocheck_reported= 1;
1900 } else if (new_nocheck != nocheck) {
1901 dbg("nocheck mode %s", new_nocheck ? "start" : "stop");
1903 nocheck= new_nocheck;
1906 static void article_done(Article *art, int whichcount) {
1907 if (whichcount>=0 && !art->missing)
1908 art->ipf->counts[art->state][whichcount]++;
1910 if (whichcount == RC_accepted) update_nocheck(1);
1911 else if (whichcount == RC_unwanted) update_nocheck(0);
1913 InputFile *ipf= art->ipf;
1915 while (art->blanklen) {
1916 static const char spaces[]=
1926 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1927 int r= pwrite(ipf->fd, spaces, w, art->offset);
1929 if (errno==EINTR) continue;
1930 syscrash("failed to blank entry for %s (length %d at offset %lu) in %s",
1931 art->messageid, art->blanklen,
1932 (unsigned long)art->offset, ipf->path);
1934 assert(r>=0 && r<=w);
1940 assert(ipf->inprogress >= 0);
1943 if (!ipf->inprogress && ipf != main_input_file)
1944 queue_check_input_done();
1947 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1948 const char *errmsg, int errnoval,
1949 const char *data, size_t recsz, void *conn_v) {
1952 if (ev == OOP_RD_EOF) {
1953 connfail(conn, "unexpected EOF from peer");
1954 return OOP_CONTINUE;
1956 assert(ev == OOP_RD_OK);
1958 char *sani= sanitise(data,-1);
1961 unsigned long code= strtoul(data, &ep, 10);
1962 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1963 connfail(conn, "badly formatted response from peer: %s", sani);
1964 return OOP_CONTINUE;
1967 int busy= conn_busy(conn);
1969 if (conn->quitting) {
1970 if (code!=205 && code!=400) {
1971 connfail(conn, "peer gave unexpected response to QUIT (%s): %s",
1972 conn->quitting, sani);
1974 LIST_REMOVE(conns,conn);
1975 notice("C%d (now %d) idle connection closed (%s)",
1976 conn->fd, conns.count, conn->quitting);
1980 return OOP_CONTINUE;
1983 conn->since_activity= 0;
1986 #define GET_ARTICLE(musthavesent) do{ \
1987 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1988 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1991 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1992 code_streaming= (streaming); \
1993 GET_ARTICLE(musthavesent); \
1994 article_done(art, RC_##how); \
1998 #define PEERBADMSG(m) do { \
1999 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
2002 int code_streaming= 0;
2006 default: PEERBADMSG("peer sent unexpected message");
2010 PEERBADMSG("peer timed us out or stopped accepting articles");
2012 LIST_REMOVE(conns,conn);
2013 notice("C%d (now %d) idle connection closed by peer",
2014 conns.count, conn->fd);
2016 return OOP_CONTINUE;
2018 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
2019 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
2021 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
2022 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
2024 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
2025 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
2027 case 238: /* CHECK says send it */
2029 case 335: /* IHAVE says send it */
2031 assert(art->state == art_Unchecked);
2032 art->ipf->counts[art->state][RC_accepted]++;
2033 art->state= art_Wanted;
2034 LIST_ADDTAIL(conn->priority, art);
2037 case 431: /* CHECK or TAKETHIS says try later */
2039 case 436: /* IHAVE says try later */
2041 article_defer(art, RC_deferred);
2047 conn_maybe_write(conn);
2048 check_assign_articles();
2049 return OOP_CONTINUE;
2053 /*========== monitoring of input files ==========*/
2055 static void feedfile_eof(InputFile *ipf) {
2056 assert(ipf != main_input_file); /* promised by tailing_try_read */
2057 inputfile_reading_stop(ipf);
2059 if (ipf == flushing_input_file) {
2060 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2061 if (main_input_file) inputfile_reading_start(main_input_file);
2062 statemc_check_flushing_done();
2063 } else if (ipf == backlog_input_file) {
2064 statemc_check_backlog_done();
2066 abort(); /* supposed to wait rather than get EOF on main input file */
2070 static InputFile *open_input_file(const char *path) {
2071 int fd= open(path, O_RDWR);
2073 if (errno==ENOENT) return 0;
2074 sysdie("unable to open input file %s", path);
2078 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2079 memset(ipf,0,sizeof(*ipf));
2083 LIST_INIT(ipf->queue);
2084 strcpy(ipf->path, path);
2089 static void close_input_file(InputFile *ipf) { /* does not free */
2090 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2091 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2092 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2093 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2094 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2098 /*---------- dealing with articles read in the input file ----------*/
2100 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2101 const char *data, const char *how) {
2102 warn("corrupted file: %s, offset %lu: %s: in %s",
2103 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2104 ipf->readcount_err++;
2105 if (ipf->readcount_err > max_bad_data_initial +
2106 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2107 crash("too much garbage in input file! (%d errs, %d ok, %d blank)",
2108 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2109 return OOP_CONTINUE;
2112 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2113 oop_rd_event ev, const char *errmsg,
2114 int errnoval, const char *data, size_t recsz,
2116 InputFile *ipf= ipf_v;
2117 assert(ev == OOP_RD_SYSTEM);
2119 syscrash("error reading input file: %s, offset %lu",
2120 ipf->path, (unsigned long)ipf->offset);
2123 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2124 oop_rd_event ev, const char *errmsg,
2125 int errnoval, const char *data, size_t recsz,
2127 InputFile *ipf= ipf_v;
2129 char tokentextbuf[sizeof(TOKEN)*2+3];
2131 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2133 off_t old_offset= ipf->offset;
2134 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2136 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2138 if (ev==OOP_RD_PARTREC)
2139 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2140 /* but process it anyway */
2142 if (ipf->skippinglong) {
2143 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2144 return OOP_CONTINUE;
2146 if (ev==OOP_RD_LONG) {
2147 ipf->skippinglong= 1;
2148 X_BAD_DATA("overly long line");
2151 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2152 if (!recsz) X_BAD_DATA("empty line");
2155 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2156 ipf->readcount_blank++;
2157 return OOP_CONTINUE;
2160 char *space= strchr(data,' ');
2161 int tokenlen= space-data;
2162 int midlen= (int)recsz-tokenlen-1;
2163 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2164 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2166 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2167 memcpy(tokentextbuf, data, tokenlen);
2168 tokentextbuf[tokenlen]= 0;
2169 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2171 ipf->readcount_ok++;
2173 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2174 memset(art,0,sizeof(*art));
2175 art->state= art_Unchecked;
2176 art->midlen= midlen;
2177 art->ipf= ipf; ipf->inprogress++;
2178 art->token= TextToToken(tokentextbuf);
2179 art->offset= old_offset;
2180 art->blanklen= recsz;
2181 strcpy(art->messageid, space+1);
2183 if (ipf->autodefer >= 0) {
2184 article_autodefer(ipf, art);
2186 LIST_ADDTAIL(ipf->queue, art);
2188 if (ipf==backlog_input_file)
2189 article_check_expired(art);
2192 if (sms==sm_NORMAL && ipf==main_input_file &&
2193 ipf->offset >= target_max_feedfile_size)
2194 statemc_start_flush("feed file size");
2196 check_assign_articles(); /* may destroy conn but that's OK */
2197 check_reading_pause_resume(ipf);
2198 return OOP_CONTINUE;
2201 /*========== tailing input file ==========*/
2203 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2205 /* lifetime of ipf here is OK because destruction will cause
2206 * on_cancel which will cancel this callback */
2207 InputFile *ipf= user;
2209 dbg("**TRACT** ipf=%p called",ipf);
2210 if (!ipf->fake_readable) return OOP_CONTINUE;
2212 /* we just keep calling readable until our caller (oop_rd)
2213 * has called try_read, and try_read has found EOF so given EAGAIN */
2214 dbg("**TRACT** ipf=%p reschedule",ipf);
2215 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2217 return ipf->readable_callback(loop, &ipf->readable,
2218 ipf->readable_callback_user);
2221 static void tailing_on_cancel(struct oop_readable *rable) {
2222 InputFile *ipf= (void*)rable;
2223 dbg("**TOR** ipf=%p on_cancel",ipf);
2225 if (ipf->filemon) filemon_stop(ipf);
2226 dbg("**TRACT** ipf=%p cancel",ipf);
2227 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2228 ipf->readable_callback= 0;
2231 static void tailing_make_readable(InputFile *ipf) {
2232 dbg("**TRACT** ipf=%p makereadable rcb=%p",ipf,
2233 (void*)ipf?ipf->readable_callback:0);
2234 if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2236 ipf->fake_readable= 1;
2237 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2240 static int tailing_on_readable(struct oop_readable *rable,
2241 oop_readable_call *cb, void *user) {
2242 InputFile *ipf= (void*)rable;
2243 dbg("**TOR** ipf=%p on_readable",ipf);
2245 tailing_on_cancel(rable);
2246 ipf->readable_callback= cb;
2247 ipf->readable_callback_user= user;
2249 tailing_make_readable(ipf);
2253 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2255 InputFile *ipf= (void*)rable;
2257 ssize_t r= read(ipf->fd, buffer, length);
2259 if (errno==EINTR) continue;
2260 ipf->fake_readable= 0;
2264 if (ipf==main_input_file) {
2266 ipf->fake_readable= 0;
2268 } else if (ipf==flushing_input_file) {
2270 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2271 } else if (ipf==backlog_input_file) {
2277 dbg("**TOR** ipf=%p try_read r=%d",ipf,r);
2282 /*---------- filemon implemented with inotify ----------*/
2284 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2285 #define HAVE_FILEMON
2287 #include <sys/inotify.h>
2289 static int filemon_inotify_fd;
2290 static int filemon_inotify_wdmax;
2291 static InputFile **filemon_inotify_wd2ipf;
2293 struct Filemon_Perfile {
2297 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2298 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2299 if (wd < 0) sysdie("inotify_add_watch %s", ipf->path);
2301 if (wd >= filemon_inotify_wdmax) {
2303 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2304 sizeof(*filemon_inotify_wd2ipf) * newmax);
2305 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2306 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2307 filemon_inotify_wdmax= newmax;
2310 assert(!filemon_inotify_wd2ipf[wd]);
2311 filemon_inotify_wd2ipf[wd]= ipf;
2313 dbg("filemon inotify startfile %p wd=%d wdmax=%d",
2314 ipf, wd, filemon_inotify_wdmax);
2319 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2321 dbg("filemon inotify stopfile %p wd=%d", ipf, wd);
2322 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2323 if (r) syscrash("inotify_rm_watch");
2324 filemon_inotify_wd2ipf[wd]= 0;
2327 static void *filemon_inotify_readable(oop_source *lp, int fd,
2328 oop_event e, void *u) {
2329 struct inotify_event iev;
2331 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2333 if (isewouldblock(errno)) break;
2334 syscrash("read from inotify master");
2335 } else if (r==sizeof(iev)) {
2336 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2338 crash("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2340 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2341 /*dbg("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2342 tailing_make_readable(ipf);
2344 return OOP_CONTINUE;
2347 static int filemon_method_init(void) {
2348 filemon_inotify_fd= inotify_init();
2349 if (filemon_inotify_fd<0) {
2350 syswarn("filemon/inotify: inotify_init failed");
2353 xsetnonblock(filemon_inotify_fd, 1);
2354 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2356 dbg("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2360 static void filemon_method_dump_info(FILE *f) {
2362 fprintf(f,"inotify");
2363 DUMPV("%d",,filemon_inotify_fd);
2364 DUMPV("%d",,filemon_inotify_wdmax);
2365 for (i=0; i<filemon_inotify_wdmax; i++)
2366 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2369 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2371 /*---------- filemon dummy implementation ----------*/
2373 #if !defined(HAVE_FILEMON)
2375 struct Filemon_Perfile { int dummy; };
2377 static int filemon_method_init(void) {
2378 warn("filemon/dummy: no filemon method compiled in");
2381 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2382 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2383 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2385 #endif /* !HAVE_FILEMON */
2387 /*---------- filemon generic interface ----------*/
2389 static void filemon_start(InputFile *ipf) {
2390 assert(!ipf->filemon);
2393 filemon_method_startfile(ipf, ipf->filemon);
2396 static void filemon_stop(InputFile *ipf) {
2397 if (!ipf->filemon) return;
2398 filemon_method_stopfile(ipf, ipf->filemon);
2403 /*---------- interface to start and stop an input file ----------*/
2405 static const oop_rd_style feedfile_rdstyle= {
2406 OOP_RD_DELIM_STRIP, '\n',
2408 OOP_RD_SHORTREC_LONG,
2411 static void inputfile_reading_resume(InputFile *ipf) {
2412 if (!ipf->rd) return;
2413 if (!ipf->paused) return;
2415 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2416 feedfile_got_article,ipf, feedfile_read_err, ipf);
2417 if (r) syscrash("unable start reading feedfile %s",ipf->path);
2422 static void inputfile_reading_pause(InputFile *ipf) {
2423 if (!ipf->rd) return;
2424 if (ipf->paused) return;
2425 oop_rd_cancel(ipf->rd);
2429 static void inputfile_reading_start(InputFile *ipf) {
2431 ipf->readable.on_readable= tailing_on_readable;
2432 ipf->readable.on_cancel= tailing_on_cancel;
2433 ipf->readable.try_read= tailing_try_read;
2434 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2435 ipf->readable.delete_kill= 0;
2437 ipf->readable_callback= 0;
2438 ipf->readable_callback_user= 0;
2440 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2444 inputfile_reading_resume(ipf);
2447 static void inputfile_reading_stop(InputFile *ipf) {
2449 inputfile_reading_pause(ipf);
2450 oop_rd_delete(ipf->rd);
2452 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2456 /*========== interaction with innd - state machine ==========*/
2458 /* See official state diagram at top of file. We implement
2469 |`---------------------------------------------------.
2471 |`---------------- - - - |
2472 D ENOENT | D EXISTS see OVERALL STATES diagram |
2473 | for full startup logic |
2476 | ============ try to |
2482 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2483 ^ | hardlink F to D |
2486 | | our handle onto F is now onto D |
2489 | |<-------------------<---------------------<---------+
2491 | | spawn inndcomm flush |
2493 | ================== |
2494 | FLUSHING[-ABSENT] |
2496 | main D tail/none |
2497 | ================== |
2499 | | INNDCOMM FLUSH FAILS ^
2500 | |`----------------------->----------. |
2502 | | NO SUCH SITE V |
2503 ^ |`--------------->----. ==================== |
2504 | | \ FLUSHFAILED[-ABSENT] |
2506 | | FLUSH OK \ main D tail/none |
2507 | | open F \ ==================== |
2509 | | \ | TIME TO RETRY |
2510 | |`------->----. ,---<---'\ `----------------'
2511 | | D NONE | | D NONE `----.
2513 | ============= V V ============
2514 | SEPARATED-1 | | DROPPING-1
2515 | flsh->rd!=0 | | flsh->rd!=0
2516 | [Separated] | | [Dropping]
2517 | main F idle | | main none
2518 | flsh D tail | | flsh D tail
2519 | ============= | | ============
2521 ^ | EOF ON D | | defer | EOF ON D
2523 | =============== | | ===============
2524 | SEPARATED-2 | | DROPPING-2
2525 | flsh->rd==0 | V flsh->rd==0
2526 | [Finishing] | | [Dropping]
2527 | main F tail | `. main none
2528 | flsh D closed | `. flsh D closed
2529 | =============== V `. ===============
2531 | | ALL D PROCESSED `. | ALL D PROCESSED
2532 | V install defer as backlog `. | install defer
2533 ^ | close D `. | close D
2534 | | unlink D `. | unlink D
2537 `----------' ==============
2557 static void startup_set_input_file(InputFile *f) {
2558 assert(!main_input_file);
2560 inputfile_reading_start(f);
2563 static void statemc_lock(void) {
2565 struct stat stab, stabf;
2568 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2569 if (lockfd<0) sysdie("open lockfile %s", path_lock);
2572 memset(&fl,0,sizeof(fl));
2574 fl.l_whence= SEEK_SET;
2575 int r= fcntl(lockfd, F_SETLK, &fl);
2577 if (errno==EACCES || isewouldblock(errno)) {
2578 if (quiet_multiple) exit(0);
2579 die("another duct holds the lockfile");
2581 sysdie("fcntl F_SETLK lockfile %s", path_lock);
2584 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2586 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2588 if (!lock_noent && samefile(&stab, &stabf))
2591 xclose(lockfd, "stale lockfile ", path_lock);
2594 FILE *lockfile= fdopen(lockfd, "w");
2595 if (!lockfile) syscrash("fdopen lockfile");
2597 int r= ftruncate(lockfd, 0);
2598 if (r) syscrash("truncate lockfile to write new info");
2600 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2601 (unsigned long)self_pid,
2602 sitename, feedfile, remote_host) == EOF ||
2604 sysdie("write info to lockfile %s", path_lock);
2606 dbg("startup: locked");
2609 static void statemc_init(void) {
2610 struct stat stabdefer;
2612 search_backlog_file();
2615 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2617 dbg("startup: ductdefer ENOENT");
2619 dbg("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2620 switch (stabdefer.st_nlink==1) {
2622 open_defer(); /* so that we will later close it and rename it */
2625 xunlink(path_defer, "stale defer file link"
2626 " (presumably hardlink to backlog file)");
2629 crash("defer file %s has unexpected link count %d",
2630 path_defer, stabdefer.st_nlink);
2634 struct stat stab_f, stab_d;
2637 InputFile *file_d= open_input_file(path_flushing);
2638 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2640 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2642 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2643 dbg("startup: F==D => Hardlinked");
2644 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2649 dbg("startup: F ENOENT => Moved");
2650 if (file_d) startup_set_input_file(file_d);
2651 spawn_inndcomm_flush("feedfile missing at startup");
2652 /* => Flushing, sms:=FLUSHING */
2655 dbg("startup: F!=D => Separated");
2656 startup_set_input_file(file_d);
2657 flushing_input_file= main_input_file;
2658 main_input_file= open_input_file(feedfile);
2659 if (!main_input_file) crash("feedfile vanished during startup");
2660 SMS(SEPARATED, max_separated_periods,
2661 "found both old and current feed files");
2663 dbg("startup: F exists, D ENOENT => Normal");
2664 InputFile *file_f= open_input_file(feedfile);
2665 if (!file_f) crash("feed file vanished during startup");
2666 startup_set_input_file(file_f);
2667 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2672 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2673 assert(sms == sm_NORMAL);
2675 dbg("starting flush (%s) (%lu >?= %lu) (%d)",
2677 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2678 (unsigned long)target_max_feedfile_size,
2681 int r= link(feedfile, path_flushing);
2682 if (r) sysdie("link feedfile %s to flushing file %s",
2683 feedfile, path_flushing);
2686 xunlink(feedfile, "old feedfile link");
2689 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2692 static int trigger_flush_ok(const char *why) {
2696 statemc_start_flush(why ? why : "periodic");
2697 return 1; /* Normal => Flushing; => FLUSHING */
2699 case sm_FLUSHFAILED:
2700 spawn_inndcomm_flush(why ? why : "retry");
2701 return 1; /* Moved => Flushing; => FLUSHING */
2705 warn("abandoning old feedfile after flush (%s), autodeferring",
2706 why ? why : "took too long to complete");
2707 assert(flushing_input_file);
2708 autodefer_input_file(flushing_input_file);
2716 static void statemc_period_poll(void) {
2717 if (!until_flush) return;
2719 assert(until_flush>=0);
2721 if (until_flush) return;
2722 int ok= trigger_flush_ok(0);
2726 static int inputfile_is_done(InputFile *ipf) {
2728 if (ipf->inprogress) return 0; /* new article in the meantime */
2729 if (ipf->rd) return 0; /* not had EOF */
2733 static void notice_processed(InputFile *ipf, int completed,
2734 const char *what, const char *spec) {
2735 if (!ipf) return; /* allows preterminate to be lazy */
2737 #define RCI_NOTHING(x) /* nothing */
2738 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2739 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2741 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2743 char *inprog= completed
2744 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2745 : xasprintf(" inprogress=%ld", ipf->inprogress);
2746 char *autodefer= ipf->autodefer >= 0
2747 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2748 : xasprintf("%s","");
2750 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2751 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2752 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2754 completed?"completed":"processed", what, spec,
2755 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2756 inprog, autodefer, ipf->count_nooffer_missing,
2757 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2758 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2759 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2760 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2761 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2770 static void statemc_check_backlog_done(void) {
2771 InputFile *ipf= backlog_input_file;
2772 if (!inputfile_is_done(ipf)) return;
2774 const char *slash= strrchr(ipf->path, '/');
2775 const char *leaf= slash ? slash+1 : ipf->path;
2776 const char *under= strchr(slash, '_');
2777 const char *rest= under ? under+1 : leaf;
2778 if (!strncmp(rest,"backlog",7)) rest += 7;
2779 notice_processed(ipf,1,"backlog ",rest);
2781 close_input_file(ipf);
2782 if (unlink(ipf->path)) {
2783 if (errno != ENOENT)
2784 syscrash("could not unlink processed backlog file %s", ipf->path);
2785 warn("backlog file %s vanished while we were reading it"
2786 " so we couldn't remove it (but it's done now, anyway)",
2790 backlog_input_file= 0;
2791 search_backlog_file();
2795 static void statemc_check_flushing_done(void) {
2796 InputFile *ipf= flushing_input_file;
2797 if (!inputfile_is_done(ipf)) return;
2799 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2801 notice_processed(ipf,1,"feedfile","");
2805 xunlink(path_flushing, "old flushing file");
2807 close_input_file(flushing_input_file);
2808 free(flushing_input_file);
2809 flushing_input_file= 0;
2811 if (sms==sm_SEPARATED) {
2812 notice("flush complete");
2813 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2814 } else if (sms==sm_DROPPING) {
2815 SMS(DROPPED, max_separated_periods, "old flush complete");
2816 search_backlog_file();
2817 notice("feed dropped, but will continue until backlog is finished");
2821 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2823 /* main input file may be idle but if so that's because
2824 * we haven't got to it yet, but that doesn't mean it's really done */
2825 statemc_check_flushing_done();
2826 statemc_check_backlog_done();
2827 return OOP_CONTINUE;
2830 static void queue_check_input_done(void) {
2831 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2834 static void statemc_setstate(StateMachineState newsms, int periods,
2835 const char *forlog, const char *why) {
2837 until_flush= periods;
2839 const char *xtra= "";
2842 case sm_FLUSHFAILED:
2843 if (!main_input_file) xtra= "-ABSENT";
2847 xtra= flushing_input_file->rd ? "-1" : "-2";
2853 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2855 info("state %s%s %s",forlog,xtra,why);
2859 /*---------- defer and backlog files ----------*/
2861 static void open_defer(void) {
2866 defer= fopen(path_defer, "a+");
2867 if (!defer) sysdie("could not open defer file %s", path_defer);
2869 /* truncate away any half-written records */
2871 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2873 if (stab.st_size > LONG_MAX)
2874 crash("defer file %s size is far too large", path_defer);
2879 long orgsize= stab.st_size;
2880 long truncto= stab.st_size;
2882 if (!truncto) break; /* was only (if anything) one half-truncated record */
2883 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2884 syscrash("seek in defer file %s while truncating partial", path_defer);
2889 syscrash("failed read from defer file %s", path_defer);
2891 crash("defer file %s shrank while we were checking it!", path_defer);
2897 if (stab.st_size != truncto) {
2898 warn("truncating half-record at end of defer file %s -"
2899 " shrinking by %ld bytes from %ld to %ld",
2900 path_defer, orgsize - truncto, orgsize, truncto);
2903 sysdie("could not flush defer file %s", path_defer);
2904 if (ftruncate(fileno(defer), truncto))
2905 syscrash("could not truncate defer file %s", path_defer);
2908 info("continuing existing defer file %s (%ld bytes)",
2909 path_defer, orgsize);
2911 if (fseek(defer, truncto, SEEK_SET))
2912 syscrash("could not seek to new end of defer file %s", path_defer);
2915 static void close_defer(void) {
2920 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2922 if (fclose(defer)) sysdie("could not close defer file %s", path_defer);
2925 time_t now= xtime();
2927 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2929 (unsigned long)stab.st_ino);
2930 if (link(path_defer, backlog))
2931 sysdie("could not install defer file %s as backlog file %s",
2932 path_defer, backlog);
2933 if (unlink(path_defer))
2934 syscrash("could not unlink old defer link %s to backlog file %s",
2935 path_defer, backlog);
2939 if (until_backlog_nextscan < 0 ||
2940 until_backlog_nextscan > backlog_retry_minperiods + 1)
2941 until_backlog_nextscan= backlog_retry_minperiods + 1;
2944 static void poll_backlog_file(void) {
2945 if (until_backlog_nextscan < 0) return;
2946 if (until_backlog_nextscan-- > 0) return;
2947 search_backlog_file();
2950 static void search_backlog_file(void) {
2951 /* returns non-0 iff there are any backlog files */
2956 const char *oldest_path=0;
2957 time_t oldest_mtime=0, now;
2959 if (backlog_input_file) return;
2963 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2967 sysdie("failed to expand backlog pattern %s", globpat_backlog);
2969 die("out of memory expanding backlog pattern %s", globpat_backlog);
2971 for (i=0; i<gl.gl_pathc; i++) {
2972 const char *path= gl.gl_pathv[i];
2974 if (strchr(path,'#') || strchr(path,'~')) {
2975 dbg("backlog file search skipping %s", path);
2978 r= stat(path, &stab);
2980 syswarn("failed to stat backlog file %s", path);
2983 if (!S_ISREG(stab.st_mode)) {
2984 warn("backlog file %s is not a plain file (or link to one)", path);
2987 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2989 oldest_mtime= stab.st_mtime;
2992 case GLOB_NOMATCH: /* fall through */
2995 syscrash("glob expansion of backlog pattern %s gave unexpected"
2996 " nonzero (error?) return value %d", globpat_backlog, r);
3000 dbg("backlog scan: none");
3002 if (sms==sm_DROPPED) {
3004 notice("feed dropped and our work is complete");
3006 int r= unlink(path_cli);
3007 if (r && errno!=ENOENT)
3008 syswarn("failed to unlink cli socket for old feed");
3010 xunlink(path_lock, "lockfile for old feed");
3013 until_backlog_nextscan= backlog_spontrescan_periods;
3018 double age= difftime(now, oldest_mtime);
3019 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
3021 if (age_deficiency <= 0) {
3022 dbg("backlog scan: found age=%f deficiency=%ld oldest=%s",
3023 age, age_deficiency, oldest_path);
3025 backlog_input_file= open_input_file(oldest_path);
3026 if (!backlog_input_file) {
3027 warn("backlog file %s vanished as we opened it", oldest_path);
3031 inputfile_reading_start(backlog_input_file);
3032 until_backlog_nextscan= -1;
3036 until_backlog_nextscan= age_deficiency / period_seconds;
3038 if (backlog_spontrescan_periods >= 0 &&
3039 until_backlog_nextscan > backlog_spontrescan_periods)
3040 until_backlog_nextscan= backlog_spontrescan_periods;
3042 dbg("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
3043 age, age_deficiency, until_backlog_nextscan, oldest_path);
3050 /*---------- shutdown and signal handling ----------*/
3052 static void preterminate(void) {
3053 if (in_child) return;
3054 notice_processed(main_input_file,0,"feedfile","");
3055 notice_processed(flushing_input_file,0,"flushing","");
3056 if (backlog_input_file)
3057 notice_processed(backlog_input_file,0, "backlog file ",
3058 backlog_input_file->path);
3061 static int signal_self_pipe[2];
3062 static sig_atomic_t terminate_sig_flag;
3064 static void raise_default(int signo) {
3065 xsigsetdefault(signo);
3070 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3071 assert(fd=signal_self_pipe[0]);
3073 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3074 if (r<0 && !isewouldblock(errno))
3075 syscrash("failed to read signal self pipe");
3076 if (r==0) crash("eof on signal self pipe");
3077 if (terminate_sig_flag) {
3079 notice("terminating (%s)", strsignal(terminate_sig_flag));
3080 raise_default(terminate_sig_flag);
3082 return OOP_CONTINUE;
3085 static void sigarrived_handler(int signum) {
3090 if (!terminate_sig_flag) terminate_sig_flag= signum;
3095 write(signal_self_pipe[1],&x,1);
3098 static void init_signals(void) {
3099 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3100 syscrash("could not ignore SIGPIPE");
3102 if (pipe(signal_self_pipe)) sysdie("create self-pipe for signals");
3104 xsetnonblock(signal_self_pipe[0],1);
3105 xsetnonblock(signal_self_pipe[1],1);
3107 struct sigaction sa;
3108 memset(&sa,0,sizeof(sa));
3109 sa.sa_handler= sigarrived_handler;
3110 sa.sa_flags= SA_RESTART;
3111 xsigaction(SIGTERM,&sa);
3112 xsigaction(SIGINT,&sa);
3114 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3117 /*========== flushing the feed ==========*/
3119 static pid_t inndcomm_child;
3120 static int inndcomm_sentinel_fd;
3122 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3123 assert(inndcomm_child);
3124 assert(fd == inndcomm_sentinel_fd);
3125 int status= xwaitpid(&inndcomm_child, "inndcomm");
3128 cancel_fd_read_except(fd);
3129 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3130 inndcomm_sentinel_fd= 0;
3132 assert(!flushing_input_file);
3134 if (WIFEXITED(status)) {
3135 switch (WEXITSTATUS(status)) {
3137 case INNDCOMMCHILD_ESTATUS_FAIL:
3140 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3141 notice("feed has been dropped by innd, finishing up");
3142 flushing_input_file= main_input_file;
3143 tailing_make_readable(flushing_input_file);
3144 /* we probably previously returned EAGAIN from our fake read method
3145 * when in fact we were at EOF, so signal another readable event
3146 * so we actually see the EOF */
3150 if (flushing_input_file) {
3151 SMS(DROPPING, max_separated_periods,
3152 "feed dropped by innd, but must finish last flush");
3155 SMS(DROPPED, 0, "feed dropped by innd");
3156 search_backlog_file();
3158 return OOP_CONTINUE;
3162 flushing_input_file= main_input_file;
3163 tailing_make_readable(flushing_input_file);
3165 main_input_file= open_input_file(feedfile);
3166 if (!main_input_file)
3167 crash("flush succeeded but feedfile %s does not exist!"
3168 " (this probably means feedfile does not correspond"
3169 " to site %s in newsfeeds)", feedfile, sitename);
3171 if (flushing_input_file) {
3172 SMS(SEPARATED, max_separated_periods, "flush complete");
3175 SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3177 return OOP_CONTINUE;
3180 goto unexpected_exitstatus;
3183 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3184 warn("flush timed out trying to talk to innd");
3187 unexpected_exitstatus:
3188 report_child_status("inndcomm child", status);
3192 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3193 return OOP_CONTINUE;
3196 static void inndcommfail(const char *what) {
3197 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3198 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3201 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3204 notice("flushing %s",why);
3206 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3207 assert(!inndcomm_child);
3208 assert(!inndcomm_sentinel_fd);
3210 if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
3212 inndcomm_child= xfork("inndcomm child");
3214 if (!inndcomm_child) {
3215 const char *flushargv[2]= { sitename, 0 };
3219 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3220 /* parent spots the autoclose of pipefds[1] when we die or exit */
3222 if (simulate_flush>=0) {
3223 warn("SIMULATING flush child status %d", simulate_flush);
3224 if (simulate_flush>128) raise(simulate_flush-128);
3225 else exit(simulate_flush);
3228 alarm(inndcomm_flush_timeout);
3229 r= ICCopen(); if (r) inndcommfail("connect");
3230 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3231 if (!r) exit(0); /* yay! */
3233 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3234 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3235 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3240 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3241 inndcomm_sentinel_fd= pipefds[0];
3242 assert(inndcomm_sentinel_fd);
3243 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3245 SMS(FLUSHING, 0, why);
3248 /*========== main program ==========*/
3250 static void postfork_inputfile(InputFile *ipf) {
3252 xclose(ipf->fd, "(in child) input file ", ipf->path);
3255 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3256 /* we have no stdio streams that are buffered long-term */
3258 if (fclose(f)) syscrash("(in child) close %s%s", what, what2?what2:0);
3261 static void postfork(void) {
3264 xsigsetdefault(SIGTERM);
3265 xsigsetdefault(SIGINT);
3266 xsigsetdefault(SIGPIPE);
3267 if (terminate_sig_flag) raise(terminate_sig_flag);
3269 postfork_inputfile(main_input_file);
3270 postfork_inputfile(flushing_input_file);
3274 conn_closefd(conn,"(in child) ");
3276 postfork_stdio(defer, "defer file ", path_defer);
3279 typedef struct Every Every;
3281 struct timeval interval;
3286 static void every_schedule(Every *e, struct timeval base);
3288 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3291 if (!e->fixed_rate) xgettimeofday(&base);
3292 every_schedule(e, base);
3293 return OOP_CONTINUE;
3296 static void every_schedule(Every *e, struct timeval base) {
3297 struct timeval when;
3298 timeradd(&base, &e->interval, &when);
3299 loop->on_time(loop, when, every_happens, e);
3302 static void every(int interval, int fixed_rate, void (*f)(void)) {
3303 NEW_DECL(Every *,e);
3304 e->interval.tv_sec= interval;
3305 e->interval.tv_usec= 0;
3306 e->fixed_rate= fixed_rate;
3309 xgettimeofday(&now);
3310 every_schedule(e, now);
3313 static void filepoll(void) {
3314 tailing_make_readable(main_input_file);
3315 tailing_make_readable(flushing_input_file);
3318 static char *dbg_report_ipf(InputFile *ipf) {
3319 if (!ipf) return xasprintf("none");
3321 const char *slash= strrchr(ipf->path,'/');
3322 const char *path= slash ? slash+1 : ipf->path;
3324 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3326 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3327 (long)ipf->offset, ipf->fd,
3328 ipf->rd ? "" : ",!rd",
3329 ipf->skippinglong ? "*skiplong" : "",
3330 ipf->rd && ipf->paused ? "*paused" : "");
3333 static void period(void) {
3334 char *dipf_main= dbg_report_ipf(main_input_file);
3335 char *dipf_flushing= dbg_report_ipf(flushing_input_file);
3336 char *dipf_backlog= dbg_report_ipf(backlog_input_file);
3339 " sms=%s[%d] conns=%d until_connect=%d"
3340 " input_files main:%s flushing:%s backlog:%s[%d]"
3341 " children connecting=%ld inndcomm=%ld lowvol_total=%d"
3343 sms_names[sms], until_flush, conns.count, until_connect,
3344 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3345 (long)connecting_child, (long)inndcomm_child, lowvol_total
3349 free(dipf_flushing);
3352 if (until_connect) until_connect--;
3354 inputfile_queue_check_expired(backlog_input_file);
3355 poll_backlog_file();
3356 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3357 statemc_period_poll();
3358 check_assign_articles();
3363 /*========== dumping state ==========*/
3365 static void dump_article_list(FILE *f, const CliCommand *c,
3366 const ArticleList *al) {
3367 fprintf(f, " count=%d\n", al->count);
3368 if (!c->xval) return;
3370 int i; Article *art;
3371 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3372 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3373 DUMPV("%p", art->,ipf);
3374 DUMPV("%d", art->,missing);
3375 DUMPV("%lu", (unsigned long)art->,offset);
3376 DUMPV("%d", art->,blanklen);
3377 DUMPV("%d", art->,midlen);
3378 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3382 static void dump_input_file(FILE *f, const CliCommand *c,
3383 InputFile *ipf, const char *wh) {
3384 char *dipf= dbg_report_ipf(ipf);
3385 fprintf(f,"input %s %s", wh, dipf);
3389 DUMPV("%d", ipf->,readcount_ok);
3390 DUMPV("%d", ipf->,readcount_blank);
3391 DUMPV("%d", ipf->,readcount_err);
3392 DUMPV("%d", ipf->,count_nooffer_missing);
3396 ArtState state; const char *const *statename;
3397 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3398 #define RC_DUMP_FMT(x) " " #x "=%d"
3399 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3400 fprintf(f,"input %s counts %-11s"
3401 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3403 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3405 fprintf(f,"input %s queue", wh);
3406 dump_article_list(f,c,&ipf->queue);
3412 fprintf(cc->out, "dumping state to %s\n", path_dump);
3413 FILE *f= fopen(path_dump, "w");
3414 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3416 fprintf(f,"general");
3417 DUMPV("%s", sms_names,[sms]);
3418 DUMPV("%d", ,until_flush);
3419 DUMPV("%ld", (long),self_pid);
3420 DUMPV("%p", , defer);
3421 DUMPV("%d", , until_connect);
3422 DUMPV("%d", , until_backlog_nextscan);
3423 DUMPV("%d", , simulate_flush);
3424 fprintf(f,"\nnocheck");
3425 DUMPV("%#.10f", , accept_proportion);
3426 DUMPV("%d", , nocheck);
3427 DUMPV("%d", , nocheck_reported);
3430 fprintf(f,"special");
3431 DUMPV("%ld", (long),connecting_child);
3432 DUMPV("%d", , connecting_fdpass_sock);
3433 DUMPV("%d", , cli_master);
3436 fprintf(f,"lowvol");
3437 DUMPV("%d", , lowvol_circptr);
3438 DUMPV("%d", , lowvol_total);
3440 for (i=0; i<lowvol_periods; i++) {
3442 if (i==lowvol_circptr) fprintf(f,"*");
3443 fprintf(f,"%d",lowvol_perperiod[i]);
3447 fprintf(f,"filemon ");
3448 filemon_method_dump_info(f);
3450 dump_input_file(f,c, main_input_file, "main" );
3451 dump_input_file(f,c, flushing_input_file, "flushing");
3452 dump_input_file(f,c, backlog_input_file, "backlog" );
3454 fprintf(f,"conns count=%d\n", conns.count);
3459 fprintf(f,"C%d",conn->fd);
3460 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3461 DUMPV("%d",conn->,stream); DUMPV("\"%s\"",conn->,quitting);
3462 DUMPV("%d",conn->,since_activity);
3465 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3466 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3467 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3469 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3470 for (i=0; i<conn->xmitu; i++) {
3471 const struct iovec *iv= &conn->xmit[i];
3472 const XmitDetails *xd= &conn->xmitd[i];
3475 case xk_Const: dinfo= xasprintf("Const"); break;
3476 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3480 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3481 sanitise(iv->iov_base, iv->iov_len));
3487 DUMPV("%s", , feedfile);
3488 DUMPV("%s", , path_cli);
3489 DUMPV("%s", , path_lock);
3490 DUMPV("%s", , path_flushing);
3491 DUMPV("%s", , path_defer);
3492 DUMPV("%s", , path_dump);
3493 DUMPV("%s", , globpat_backlog);
3496 if (!!ferror(f) + !!fclose(f)) {
3497 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3502 /*========== option parsing ==========*/
3504 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3505 static void vbadusage(const char *fmt, va_list al) {
3506 char *m= xvasprintf(fmt,al);
3507 fprintf(stderr, "bad usage: %s\n"
3508 "say --help for help, or read the manpage\n",
3510 if (interactive < 2)
3511 syslog(LOG_ERR,"innduct: invoked with bad usage: %s",m);
3515 /*---------- generic option parser ----------*/
3517 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3518 static void badusage(const char *fmt, ...) {
3525 of_seconds= 001000u,
3526 of_boolean= 002000u,
3529 typedef struct Option Option;
3530 typedef void OptionParser(const Option*, const char *val);
3534 const char *lng, *formarg;
3540 static void parse_options(const Option *options, char ***argvp) {
3541 /* on return *argvp is first non-option arg; argc is not updated */
3544 const char *arg= *++(*argvp);
3546 if (*arg != '-') break;
3547 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3549 while ((a= *++arg)) {
3553 char *equals= strchr(arg,'=');
3554 int len= equals ? (equals - arg) : strlen(arg);
3555 for (o=options; o->shrt || o->lng; o++)
3556 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3558 badusage("unknown long option --%s",arg);
3561 if (equals) badusage("option --%s does not take a value",o->lng);
3563 } else if (equals) {
3567 if (!arg) badusage("option --%s needs a value for %s",
3568 o->lng, o->formarg);
3571 break; /* eaten the whole argument now */
3573 for (o=options; o->shrt || o->lng; o++)
3576 badusage("unknown short option -%c",a);
3583 if (!arg) badusage("option -%c needs a value for %s",
3584 o->shrt, o->formarg);
3587 break; /* eaten the whole argument now */
3593 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3595 static void print_options(const Option *options, FILE *f) {
3597 for (o=options; o->shrt || o->lng; o++) {
3598 char shrt[2] = { o->shrt, 0 };
3599 char *optspec= xasprintf("%s%s%s%s%s",
3600 o->shrt ? "-" : "", shrt,
3601 o->shrt && o->lng ? "|" : "",
3602 DELIMPERHAPS("--", o->lng));
3603 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3608 /*---------- specific option types ----------*/
3610 static void op_integer(const Option *o, const char *val) {
3613 unsigned long ul= strtoul(val,&ep,10);
3614 if (*ep || ep==val || errno || ul>INT_MAX)
3615 badusage("bad integer value for %s",o->lng);
3616 int *store= o->store;
3620 static void op_double(const Option *o, const char *val) {
3621 int *store= o->store;
3624 *store= strtod(val, &ep);
3625 if (*ep || ep==val || errno)
3626 badusage("bad floating point value for %s",o->lng);
3629 static void op_string(const Option *o, const char *val) {
3630 const char **store= o->store;
3634 static void op_seconds(const Option *o, const char *val) {
3635 int *store= o->store;
3639 double v= strtod(val,&ep);
3640 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3642 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3643 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3644 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3645 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3646 else if (!strcmp(ep,"das")) unit= 10;
3647 else if (!strcmp(ep,"hs")) unit= 100;
3648 else if (!strcmp(ep,"ks")) unit= 1000;
3649 else if (!strcmp(ep,"Ms")) unit= 1000000;
3650 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3654 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3658 static void op_setint(const Option *o, const char *val) {
3659 int *store= o->store;
3663 /*---------- specific options ----------*/
3665 static void help(const Option *o, const char *val);
3667 static const Option innduct_options[]= {
3668 {'f',"feedfile", "F", &feedfile, op_string },
3669 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3670 {0,"no-daemon", 0, &interactive, op_setint, 1 },
3671 {0,"interactive", 0, &interactive, op_setint, 2 },
3672 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3673 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3674 {'C',"inndconf", "F", &inndconffile, op_string },
3675 {'P',"port", "PORT", &port, op_integer },
3676 {0,"chdir", "DIR", &path_run, op_string },
3677 {0,"cli", "DIR/|PATH", &path_cli, op_string },
3678 {0,"help", 0, 0, help },
3680 {0,"max-connections", "N", &max_connections, op_integer },
3681 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3682 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3683 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3684 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3686 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3687 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3688 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3690 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3691 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3693 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3694 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3695 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3696 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3697 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3698 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3699 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3700 {0,"low-volume-thresh", "PERIOD", &lowvol_thresh, op_integer },
3701 {0,"low-volume-window", "PERIOD", &lowvol_periods, op_seconds },
3703 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3704 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3709 static void printusage(FILE *f) {
3710 fputs("usage: innduct [options] site [fqdn]\n"
3711 "available options are:\n", f);
3712 print_options(innduct_options, f);
3715 static void help(const Option *o, const char *val) {
3717 if (ferror(stdout) || fflush(stdout)) {
3718 perror("innduct: writing help");
3724 static void convert_to_periods_rndup(int *store) {
3725 *store += period_seconds-1;
3726 *store /= period_seconds;
3729 static int path_ends_slash(const char *specified) {
3730 int l= strlen(specified);
3732 return specified[l-1] == '/';
3735 int main(int argc, char **argv) {
3736 /* set up libinn logging */
3737 message_program_name= "innduct";
3738 message_fatal_cleanup= innduct_fatal_cleanup;
3739 INNLOGSETS(INNLOGSET_CALL)
3746 parse_options(innduct_options, &argv);
3751 if (!sitename) badusage("need site name argument");
3753 if (*argv) remote_host= *argv++;
3754 else remote_host= sitename;
3756 if (*argv) badusage("too many non-option arguments");
3760 int r= innconf_read(inndconffile);
3761 if (!r) badusage("could not read inn.conf");
3763 if (!remote_host) remote_host= sitename;
3765 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3766 badusage("nocheck threshold percentage must be between 0..100");
3767 nocheck_thresh *= 0.01;
3769 if (nocheck_decay < 0.1)
3770 badusage("nocheck decay articles must be at least 0.1");
3771 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3773 convert_to_periods_rndup(&reconnect_delay_periods);
3774 convert_to_periods_rndup(&flushfail_retry_periods);
3775 convert_to_periods_rndup(&backlog_retry_minperiods);
3776 convert_to_periods_rndup(&backlog_spontrescan_periods);
3777 convert_to_periods_rndup(&spontaneous_flush_periods);
3778 convert_to_periods_rndup(&max_separated_periods);
3779 convert_to_periods_rndup(&need_activity_periods);
3780 convert_to_periods_rndup(&lowvol_periods);
3782 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3783 badusage("bad input data ratio must be between 0..100");
3784 max_bad_data_ratio *= 0.01;
3787 path_run= innconf->pathrun;
3789 if (!feedfile) feedfile= sitename;
3790 if (!feedfile[0]) badusage("feed filename, if specified, must be nonempty");
3791 if (path_ends_slash(feedfile))
3792 feedfile= xasprintf("%s%s", feedfile, sitename);
3793 if (feedfile[0] != '/')
3794 feedfile= xasprintf("%s/%s", innconf->pathoutgoing, feedfile);
3797 path_cli_dir= "innduct";
3798 } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3799 path_cli= 0; /* ok, don't then */
3800 } else if (path_ends_slash(path_cli)) {
3801 path_cli_dir= xasprintf("%.*s", strlen(path_cli)-1, path_cli);
3804 path_cli= xasprintf("%s/%s", path_cli_dir, sitename);
3806 if (max_queue_per_ipf<0)
3807 max_queue_per_ipf= max_queue_per_conn * 2;
3809 const char *feedfile_forbidden= "?*[~#";
3811 while ((c= *feedfile_forbidden++))
3812 if (strchr(feedfile, c))
3813 badusage("feed filename may not contain metacharacter %c",c);
3816 lowvol_perperiod= xcalloc(sizeof(*lowvol_perperiod), lowvol_periods);
3817 for (i=0; i<lowvol_periods; i++) {
3818 lowvol_perperiod[i]= lowvol_thresh;
3819 lowvol_total += lowvol_thresh;
3821 lowvol_total -= lowvol_thresh;
3825 path_lock= xasprintf("%s_lock", feedfile);
3826 path_flushing= xasprintf("%s_flushing", feedfile);
3827 path_defer= xasprintf("%s_defer", feedfile);
3828 path_dump= xasprintf("%s_dump", feedfile);
3829 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3831 oop_source_sys *sysloop= oop_sys_new();
3832 if (!sysloop) syscrash("could not create liboop event loop");
3833 loop= (oop_source*)sysloop;
3837 if (interactive < 1) {
3839 for (i=3; i<255; i++)
3840 /* do this now before we open syslog, etc. */
3844 logv_prefix= xasprintf("%s| ", sitename);
3845 if (interactive < 2) {
3846 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3850 if (interactive < 1) {
3851 int null= open("/dev/null",O_RDWR);
3852 if (null<0) sysdie("failed to open /dev/null");
3856 xclose(null, "/dev/null original fd",0);
3858 pid_t child1= xfork("daemonise first fork");
3859 if (child1) _exit(0);
3861 pid_t sid= setsid();
3862 if (sid == -1) sysdie("setsid failed");
3864 pid_t child2= xfork("daemonise second fork");
3865 if (child2) _exit(0);
3869 if (self_pid==-1) syscrash("getpid");
3872 if (r) sysdie("could not chdir to pathrun %s", path_run);
3881 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3882 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3884 if (interactive >= 2)
3891 notice("filemon: suppressed by command line option, polling");
3893 filemon_ok= filemon_method_init();
3895 warn("filemon: no file monitoring available, polling");
3898 every(filepoll_seconds,0,filepoll);
3900 every(period_seconds,1,period);
3906 void *run= oop_sys_run(sysloop);
3907 assert(run == OOP_ERROR);
3908 syscrash("event loop failed");