3 * tailing reliable realtime streaming feeder for inn
5 * Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * (I believe that when you compile and link this as part of the inn2
21 * build, with the Makefile runes I have provided, all the libraries
22 * and files which end up included in innduct are licence-compatible
23 * with GPLv3. If not then please let me know. -Ian Jackson.)
27 * Newsfeeds file entries should look like this:
28 * host.name.of.site[/exclude,exclude,...]\
29 * :pattern,pattern...[/distribution,distribution...]\
33 * sitename[/exclude,exclude,...]\
34 * :pattern,pattern...[/distribution,distribution...]\
40 * or might be blanked out
41 * <spc><spc><spc><spc>....
43 * F site.name main feed file
44 * opened/created, then written, by innd
47 * tokens blanked out by duct when processed
48 * site.name_lock lock preventing multiple ducts
49 * to hold lock must open,F_SETLK[W]
50 * and then stat to check that locked file
51 * still has name site.name_lock
52 * holder of this lock is "duct"
53 * (only) lockholder may remove the lockfile
54 * D site.name_flushing temporary feed file during flush (or crash)
55 * hardlink created by duct
57 * site.name_defer 431'd articles, still being written,
58 * created, written, used by duct
60 * site.name_backlog.<date>.<inum>
61 * 431'd articles, ready for innxmit or duct
62 * created (link/mv) by duct
63 * site.name_backlog<anything-else> (where <anything-else> does not
64 * contain '#' or '~') eg
65 * site.name_backlog.manual
66 * anything the sysadmin likes (eg, feed files
67 * from old feeds to be merged into this one)
68 * created (link/mv) by admin
69 * may be symlinks (in which case links
70 * may be written through, but only links
73 * It is safe to remove backlog files manually,
74 * if it's desired to throw away the backlog.
76 * Backlog files are also processed by innduct. We find the oldest
77 * backlog file which is at least a certain amount old, and feed it
78 * back into our processing. When every article in it has been read
79 * and processed, we unlink it and look for another backlog file.
81 * If we don't have a backlog file that we're reading, we close the
82 * defer file that we're writing and make it into a backlog file at
83 * the first convenient opportunity.
94 | | <----------------<---------------------------------'|
100 | F: innd writing, duct reading |
103 | | duct decides time to flush |
104 | | duct makes hardlink |
106 | V <------------------------'|
108 | F == D: innd writing, duct reading both exist |
111 | | <-----------<-------------<--'|
112 | | open D F ENOENT |
115 | V <---------------------. |
118 | D: innd writing, duct reading; or ENOENT | |
120 | | duct requests flush of feed | |
121 | | (others can too, harmlessly) | |
125 | D: innd flushing, duct; or ENOENT | |
127 | | inndcomm flush fails | |
128 | |`-------------------------->------------------' |
130 | | inndcomm reports no such site |
131 | |`---------------------------------------------------- | -.
133 | | innd finishes writing D, creates F | |
134 | | inndcomm reports flush successful | |
137 | Separated <----------------' |
138 | F: innd writing F!=D /
139 | D: duct reading; or ENOENT both exist /
141 | | duct gets to the end of D /
142 | | duct opens F too /
145 | F: innd writing, duct reading |
146 | D: duct finishing V
148 | | duct finishes processing D F: ENOENT
149 | V duct unlinks D D: duct reading
151 `--<--' | duct finishes
161 "duct reading" means innduct is reading the file but also
162 overwriting processed tokens.
166 * rune for printing diagrams:
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
173 /*============================== PROGRAM ==============================*/
175 #define _GNU_SOURCE 1
181 #include "inndcomm.h"
183 #include "inn/list.h"
184 #include "inn/innconf.h"
187 #include <sys/types.h>
188 #include <sys/wait.h>
189 #include <sys/stat.h>
190 #include <sys/socket.h>
209 #include <oop-read.h>
211 /*----- general definitions, probably best not changed -----*/
213 #define CONNCHILD_ESTATUS_STREAM 24
214 #define CONNCHILD_ESTATUS_NOSTREAM 25
216 #define INNDCOMMCHILD_ESTATUS_FAIL 26
217 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
219 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
220 #define MAX_CLI_COMMAND 1000
222 #define VA va_list al; va_start(al,fmt)
223 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
224 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
225 #define NORET __attribute__((__noreturn__))
227 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
228 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
230 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
232 #define FOR_CONN(conn) \
233 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
235 /*----- doubly linked lists -----*/
237 #define ISNODE(T) struct node list_node
240 union { struct list li; T *for_type; } u; \
244 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
246 #define LIST_CHECKCANHAVENODE(l,n) \
247 ((void)((n) == ((l).u.for_type))) /* just for the type check */
249 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
250 ( LIST_CHECKCANHAVENODE(l,n), \
251 list_addsomehow(&(l).u.li, NODE((n))), \
255 #define LIST_REMSOMEHOW(l,list_remsomehow) \
256 ( (typeof((l).u.for_type)) \
259 list_remsomehow(&(l).u.li) ) \
265 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
266 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
267 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
268 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
270 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
271 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
272 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
273 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
275 #define LIST_REMOVE(l,n) \
276 ( LIST_CHECKCANHAVENODE(l,n), \
277 list_remove(NODE((n))), \
281 #define LIST_INSERT(l,n,pred) \
282 ( LIST_CHECKCANHAVENODE(l,n), \
283 LIST_CHECKCANHAVENODE(l,pred), \
284 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
288 /*----- type predeclarations -----*/
290 typedef struct Conn Conn;
291 typedef struct Article Article;
292 typedef struct InputFile InputFile;
293 typedef struct XmitDetails XmitDetails;
294 typedef struct Filemon_Perfile Filemon_Perfile;
295 typedef enum StateMachineState StateMachineState;
296 typedef struct CliCommand CliCommand;
301 /*----- function predeclarations -----*/
303 static void conn_maybe_write(Conn *conn);
304 static void conn_make_some_xmits(Conn *conn);
305 static void *conn_write_some_xmits(Conn *conn);
307 static void xmit_free(XmitDetails *d);
309 #define SMS(newstate, periods, why) \
310 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
311 static void statemc_setstate(StateMachineState newsms, int periods,
312 const char *forlog, const char *why);
314 static void statemc_start_flush(const char *why); /* Normal => Flushing */
315 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
316 static int trigger_flush_ok(const char *why /* 0 means timeout */);
317 /* => Flushing,FLUSHING, ret 1; or ret 0 */
319 static void article_done(Article *art, int whichcount);
321 static void check_assign_articles(void);
322 static void queue_check_input_done(void);
323 static void check_reading_pause_resume(InputFile *ipf);
325 static void statemc_check_flushing_done(void);
326 static void statemc_check_backlog_done(void);
328 static void postfork(void);
329 static void period(void);
331 static void open_defer(void);
332 static void close_defer(void);
333 static void search_backlog_file(void);
334 static void preterminate(void);
335 static void raise_default(int signo) NORET;
336 static char *debug_report_ipf(InputFile *ipf);
338 static void inputfile_reading_start(InputFile *ipf);
339 static void inputfile_reading_stop(InputFile *ipf);
340 static void inputfile_reading_pause(InputFile *ipf);
341 static void inputfile_reading_resume(InputFile *ipf);
342 /* pause and resume are idempotent, and no-op if not done _reading_start */
344 static void filemon_start(InputFile *ipf);
345 static void filemon_stop(InputFile *ipf);
346 static void tailing_make_readable(InputFile *ipf);
348 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
349 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
351 static const oop_rd_style peer_rd_style;
352 static oop_rd_call peer_rd_err, peer_rd_ok;
355 /*----- configuration options -----*/
356 /* when changing defaults, remember to update the manpage */
358 static const char *sitename, *remote_host;
359 static const char *feedfile, *path_run, *path_cli, *path_cli_dir;
360 static int quiet_multiple=0;
361 static int interactive=0, try_filemon=1;
362 static int try_stream=1;
364 static const char *inndconffile;
366 static int max_connections=10;
367 static int max_queue_per_conn=200;
368 static int target_max_feedfile_size=100000;
369 static int period_seconds=30;
370 static int filepoll_seconds=5;
371 static int max_queue_per_ipf=-1;
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
376 static double nocheck_thresh= 95.0; /* converted from percentage by main */
377 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=100;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
387 static int lowvol_thresh=3;
388 static int lowvol_periods=1000;
390 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
391 static int max_bad_data_initial= 30;
392 /* in one corrupt 4096-byte block the number of newlines has
393 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
396 /*----- statistics -----*/
398 typedef enum { /* in queue in conn->sent */
399 art_Unchecked, /* not checked, not sent checking */
400 art_Wanted, /* checked, wanted sent body as requested */
401 art_Unsolicited, /* - sent body without check */
405 static const char *const artstate_names[]=
406 { "Unchecked", "Wanted", "Unsolicited", 0 };
408 #define RESULT_COUNTS(RCS,RCN) \
417 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
418 #define RCI_TRIPLE_VALS_BASE(counts,x) \
419 counts[art_Unchecked] x \
420 + counts[art_Wanted] x \
421 + counts[art_Unsolicited] x, \
422 counts[art_Unchecked] x \
423 , counts[art_Wanted] x \
424 , counts[art_Unsolicited] x
427 #define RC_INDEX(x) RC_##x,
428 RESULT_COUNTS(RC_INDEX, RC_INDEX)
433 /*----- transmission buffers -----*/
449 /*----- core operational data structure types -----*/
452 /* This is also an instance of struct oop_readable */
453 struct oop_readable readable; /* first */
454 oop_readable_call *readable_callback;
455 void *readable_callback_user;
458 Filemon_Perfile *filemon;
460 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
462 int skippinglong, paused, fake_readable;
465 long inprogress; /* includes queue.count and also articles in conns */
466 long autodefer; /* -1 means not doing autodefer */
468 int counts[art_MaxState][RCI_max];
469 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
484 #define SMS_LIST(X) \
492 enum StateMachineState {
493 #define SMS_DEF_ENUM(s) sm_##s,
494 SMS_LIST(SMS_DEF_ENUM)
497 static const char *sms_names[]= {
498 #define SMS_DEF_NAME(s) #s ,
499 SMS_LIST(SMS_DEF_NAME)
505 int fd; /* may be 0, meaning closed (during construction/destruction) */
506 oop_read *rd; /* likewise */
507 int oopwriting; /* since on_fd is not idempotent */
508 int max_queue, stream;
509 const char *quitting;
510 int since_activity; /* periods */
511 ArticleList waiting; /* not yet told peer */
512 ArticleList priority; /* peer says send it now */
513 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
514 struct iovec xmit[CONNIOVS];
515 XmitDetails xmitd[CONNIOVS];
520 /*----- general operational variables -----*/
522 /* main initialises */
523 static oop_source *loop;
524 static ConnList conns;
525 static char *path_lock, *path_flushing, *path_defer, *path_dump;
526 static char *globpat_backlog;
527 static pid_t self_pid;
528 static int *lowvol_perperiod;
529 static int lowvol_circptr;
530 static int lowvol_total; /* does not include current period */
532 /* statemc_init initialises */
533 static StateMachineState sms;
534 static int until_flush;
535 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
538 /* initialisation to 0 is good */
539 static int until_connect, until_backlog_nextscan;
540 static double accept_proportion;
541 static int nocheck, nocheck_reported, in_child;
543 /* for simulation, debugging, etc. */
544 int simulate_flush= -1;
546 /*========== logging ==========*/
548 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
549 static void logcore(int sysloglevel, const char *fmt, ...) {
551 if (interactive < 2) {
552 vsyslog(sysloglevel,fmt,al);
554 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
555 vfprintf(stderr,fmt,al);
561 static void logv(int sysloglevel, const char *pfx, int errnoval,
562 const char *fmt, va_list al) PRINTF(5,0);
563 static void logv(int sysloglevel, const char *pfx, int errnoval,
564 const char *fmt, va_list al) {
565 char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
566 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
567 msgbuf[sizeof(msgbuf)-1]= 0;
569 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
570 sysloglevel= LOG_ERR; /* run by wrong user, probably */
572 logcore(sysloglevel, "<%s>%s: %s%s%s",
573 sitename, pfx, msgbuf,
574 errnoval>=0 ? ": " : "",
575 errnoval>=0 ? strerror(errnoval) : "");
578 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
579 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
580 static void fn(const char *fmt, ...) { \
583 logv(sysloglevel, pfx, err, fmt, al); \
587 #define logwrap(fn, pfx, sysloglevel, err) \
588 static void fn(const char *fmt, ...) PRINTF(1,2); \
589 static void fn(const char *fmt, ...) { \
591 logv(sysloglevel, pfx, err, fmt, al); \
595 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
596 diewrap(die, " critical", LOG_CRIT, -1, 16);
598 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
599 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
601 logwrap(syswarn, " warning", LOG_WARNING, errno);
602 logwrap(warn, " warning", LOG_WARNING, -1);
604 logwrap(notice, " notice", LOG_NOTICE, -1);
605 logwrap(info, " info", LOG_INFO, -1);
606 logwrap(debug, " debug", LOG_DEBUG, -1);
609 /*========== utility functions etc. ==========*/
611 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
612 static char *xvasprintf(const char *fmt, va_list al) {
614 int rc= vasprintf(&str,fmt,al);
615 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
618 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
619 static char *xasprintf(const char *fmt, ...) {
621 char *str= xvasprintf(fmt,al);
626 static int close_perhaps(int *fd) {
627 if (*fd <= 0) return 0;
632 static void xclose(int fd, const char *what, const char *what2) {
634 if (r) sysdie("close %s%s",what,what2?what2:"");
636 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
637 if (*fd <= 0) return;
638 xclose(*fd,what,what2);
642 static pid_t xfork(const char *what) {
646 if (child==-1) sysfatal("cannot fork for %s",what);
647 debug("forked %s %ld", what, (unsigned long)child);
648 if (!child) postfork();
652 static void on_fd_read_except(int fd, oop_call_fd callback) {
653 loop->on_fd(loop, fd, OOP_READ, callback, 0);
654 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
656 static void cancel_fd_read_except(int fd) {
657 loop->cancel_fd(loop, fd, OOP_READ);
658 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
661 static void report_child_status(const char *what, int status) {
662 if (WIFEXITED(status)) {
663 int es= WEXITSTATUS(status);
665 warn("%s: child died with error exit status %d", what, es);
666 } else if (WIFSIGNALED(status)) {
667 int sig= WTERMSIG(status);
668 const char *sigstr= strsignal(sig);
669 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
671 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
673 warn("%s: child died due to unknown fatal signal %d%s",
674 what, sig, coredump);
676 warn("%s: child died with unknown wait status %d", what,status);
680 static int xwaitpid(pid_t *pid, const char *what) {
683 int r= kill(*pid, SIGKILL);
684 if (r) sysdie("cannot kill %s child", what);
686 pid_t got= waitpid(*pid, &status, 0);
687 if (got==-1) sysdie("cannot reap %s child", what);
688 if (got==0) die("cannot reap %s child", what);
695 static void *zxmalloc(size_t sz) {
696 void *p= xmalloc(sz);
701 static void xunlink(const char *path, const char *what) {
703 if (r) sysdie("can't unlink %s %s", path, what);
706 static time_t xtime(void) {
708 if (now==-1) sysdie("time(2) failed");
712 static void xsigaction(int signo, const struct sigaction *sa) {
713 int r= sigaction(signo,sa,0);
714 if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
717 static void xsigsetdefault(int signo) {
719 memset(&sa,0,sizeof(sa));
720 sa.sa_handler= SIG_DFL;
721 xsigaction(signo,&sa);
724 static void xgettimeofday(struct timeval *tv_r) {
725 int r= gettimeofday(tv_r,0);
726 if (r) sysdie("gettimeofday(2) failed");
729 static void xsetnonblock(int fd, int nonblocking) {
730 int errnoval= oop_fd_nonblock(fd, nonblocking);
731 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
734 static void check_isreg(const struct stat *stab, const char *path,
736 if (!S_ISREG(stab->st_mode))
737 die("%s %s not a plain file (mode 0%lo)",
738 what, path, (unsigned long)stab->st_mode);
741 static void xfstat(int fd, struct stat *stab_r, const char *what) {
742 int r= fstat(fd, stab_r);
743 if (r) sysdie("could not fstat %s", what);
746 static void xfstat_isreg(int fd, struct stat *stab_r,
747 const char *path, const char *what) {
748 xfstat(fd, stab_r, what);
749 check_isreg(stab_r, path, what);
752 static void xlstat_isreg(const char *path, struct stat *stab,
753 int *enoent_r /* 0 means ENOENT is fatal */,
755 int r= lstat(path, stab);
757 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
758 sysdie("could not lstat %s %s", what, path);
760 if (enoent_r) *enoent_r= 0;
761 check_isreg(stab, path, what);
764 static int samefile(const struct stat *a, const struct stat *b) {
765 assert(S_ISREG(a->st_mode));
766 assert(S_ISREG(b->st_mode));
767 return (a->st_ino == b->st_ino &&
768 a->st_dev == b->st_dev);
771 static char *sanitise(const char *input, int len) {
772 static char sanibuf[100]; /* returns pointer to this buffer! */
774 const char *p= input;
775 const char *endp= len>=0 ? input+len : 0;
779 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
780 int c= (!endp || p<endp) ? *p++ : 0;
781 if (!c) { *q++= '\''; *q=0; break; }
782 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
783 sprintf(q,"\\x%02x",c);
789 static int isewouldblock(int errnoval) {
790 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
793 /*========== command and control (CLI) connections ==========*/
795 static int cli_master;
797 typedef struct CliConn CliConn;
799 void (*destroy)(CliConn*);
805 struct sockaddr_un un;
810 static const oop_rd_style cli_rd_style= {
811 OOP_RD_DELIM_STRIP, '\n',
813 OOP_RD_SHORTREC_FORBID
816 static void cli_destroy(CliConn *cc) {
820 static void cli_checkouterr(CliConn *cc /* may destroy*/) {
821 if (ferror(cc->out) | fflush(cc->out)) {
822 info("CTRL%d write error %s", cc->fd, strerror(errno));
827 static void cli_prompt(CliConn *cc /* may destroy*/) {
828 fprintf(cc->out, "%s| ", sitename);
834 void (*f)(CliConn *cc, const CliCommand *ccmd,
835 const char *arg, size_t argsz);
840 static const CliCommand cli_commands[];
843 static void ccmd_##wh(CliConn *cc, const CliCommand *c, \
844 const char *arg, size_t argsz)
847 fputs("commands:\n", cc->out);
848 const CliCommand *ccmd;
849 for (ccmd=cli_commands; ccmd->cmd; ccmd++)
850 fprintf(cc->out, " %s\n", ccmd->cmd);
851 fputs("NB: permissible arguments are not shown above."
852 " Not all commands listed are safe. See innduct(8).\n", cc->out);
856 int ok= trigger_flush_ok("manual request");
857 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
862 notice("terminating (CTRL%d)",cc->fd);
863 raise_default(SIGTERM);
869 /* messing with our head: */
870 CCMD(period) { period(); }
871 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
872 CCMD(setint) { *(int*)c->xdata= c->xval; }
873 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
875 static const CliCommand cli_commands[]= {
877 { "flush", ccmd_flush },
878 { "stop", ccmd_stop },
879 { "dump q", ccmd_dump, 0,0 },
880 { "dump a", ccmd_dump, 0,1 },
882 { "p", ccmd_period },
884 #define POKES(cmd,func) \
885 { cmd "flush", func, &until_flush, 1 }, \
886 { cmd "conn", func, &until_connect, 0 }, \
887 { cmd "blscan", func, &until_backlog_nextscan, 0 },
888 POKES("next ", ccmd_setint)
889 POKES("prod ", ccmd_setint_period)
891 { "pretend flush", ccmd_setintarg, &simulate_flush },
892 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
896 static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
897 const char *errmsg, int errnoval,
898 const char *data, size_t recsz, void *cc_v) {
902 info("CTRL%d closed", cc->fd);
907 if (recsz == 0) goto prompt;
909 const CliCommand *ccmd;
910 for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
911 int l= strlen(ccmd->cmd);
912 if (recsz < l) continue;
913 if (recsz > l && data[l] != ' ') continue;
914 if (memcmp(data, ccmd->cmd, l)) continue;
916 int argl= (int)recsz - (l+1);
917 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
921 fputs("unknown command; h for help\n", cc->out);
928 static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
929 const char *errmsg, int errnoval,
930 const char *data, size_t recsz, void *cc_v) {
933 info("CTRL%d read error %s", cc->fd, errmsg);
938 static int cli_conn_startup(CliConn *cc /* may destroy*/,
940 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
941 if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
943 int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
946 if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
948 info("CTRL%d %s ready", cc->fd, how);
953 static void cli_stdio_destroy(CliConn *cc) {
955 oop_rd_cancel(cc->rd);
956 errno= oop_rd_delete_tidy(cc->rd);
957 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
962 static void cli_stdio(void) {
963 NEW_DECL(CliConn *,cc);
964 cc->destroy= cli_stdio_destroy;
968 int r= cli_conn_startup(cc,"stdio");
969 if (r) cc->destroy(cc);
972 static void cli_accepted_destroy(CliConn *cc) {
974 oop_rd_cancel(cc->rd);
975 oop_rd_delete_kill(cc->rd);
977 if (cc->out) { fclose(cc->out); cc->fd=0; }
978 close_perhaps(&cc->fd);
982 static void *cli_master_readable(oop_source *lp, int master,
983 oop_event ev, void *u) {
984 NEW_DECL(CliConn *,cc);
985 cc->destroy= cli_accepted_destroy;
987 cc->salen= sizeof(cc->sa);
988 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
989 if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
991 cc->out= fdopen(cc->fd, "w");
992 if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
994 int r= cli_conn_startup(cc, "accepted");
1001 return OOP_CONTINUE;
1004 #define NOCLI(...) do{ \
1005 syswarn("no cli listener, because failed to " __VA_ARGS__); \
1009 static void cli_init(void) {
1012 struct sockaddr_un un;
1015 memset(&sa,0,sizeof(sa));
1016 int maxlen= sizeof(sa.un.sun_path);
1019 info("control command line disabled");
1023 int pathlen= strlen(path_cli);
1024 if (pathlen > maxlen) {
1025 warn("no cli listener, because cli socket path %s too long (%d>%d)",
1026 path_cli, pathlen, maxlen);
1031 int r= mkdir(path_cli_dir, 0700);
1032 if (r && errno!=EEXIST)
1033 NOCLI("create cli socket directory %s", path_cli_dir);
1036 int r= unlink(path_cli);
1037 if (r && errno!=ENOENT)
1038 NOCLI("remove old cli socket %s", path_cli);
1040 cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1041 if (cli_master<0) NOCLI("create new cli master socket");
1043 int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1044 sa.un.sun_family= AF_UNIX;
1045 memcpy(sa.un.sun_path, path_cli, pathlen);
1047 r= bind(cli_master, &sa.sa, sl);
1048 if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1050 r= listen(cli_master, 5);
1051 if (r) NOCLI("listen to cli master socket");
1053 xsetnonblock(cli_master, 1);
1055 loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1056 info("cli ready, listening on %s", path_cli);
1061 xclose_perhaps(&cli_master, "cli master",0);
1065 /*========== management of connections ==========*/
1067 static void reconnect_blocking_event(void) {
1068 until_connect= reconnect_delay_periods;
1071 static void conn_closefd(Conn *conn, const char *msgprefix) {
1072 int r= close_perhaps(&conn->fd);
1073 if (r) info("C%d %serror closing socket: %s",
1074 conn->fd, msgprefix, strerror(errno));
1077 static int conn_busy(Conn *conn) {
1079 conn->waiting.count ||
1080 conn->priority.count ||
1085 static void conn_dispose(Conn *conn) {
1088 oop_rd_cancel(conn->rd);
1089 oop_rd_delete_kill(conn->rd);
1093 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1094 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1096 conn_closefd(conn,"");
1100 static void *conn_exception(oop_source *lp, int fd,
1101 oop_event ev, void *conn_v) {
1104 assert(fd == conn->fd);
1105 assert(ev == OOP_EXCEPTION);
1106 int r= read(conn->fd, &ch, 1);
1107 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1108 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1109 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1110 return OOP_CONTINUE;
1113 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1114 int requeue[art_MaxState];
1115 memset(requeue,0,sizeof(requeue));
1119 while ((art= LIST_REMHEAD(conn->priority)))
1120 LIST_ADDTAIL(art->ipf->queue, art);
1122 while ((art= LIST_REMHEAD(conn->waiting)))
1123 LIST_ADDTAIL(art->ipf->queue, art);
1125 while ((art= LIST_REMHEAD(conn->sent))) {
1126 requeue[art->state]++;
1127 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1128 LIST_ADDTAIL(art->ipf->queue,art);
1129 check_reading_pause_resume(art->ipf);
1134 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1137 LIST_REMOVE(conns,conn);
1139 char *m= xvasprintf(fmt,al);
1140 warn("C%d (now %d) connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1141 conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1144 reconnect_blocking_event();
1146 check_assign_articles();
1149 static void connfail(Conn *conn, const char *fmt, ...) {
1152 vconnfail(conn,fmt,al);
1156 static void conn_idle_close(Conn *conn, const char *why) {
1157 static const char quitcmd[]= "QUIT\r\n";
1158 int todo= sizeof(quitcmd)-1;
1159 const char *p= quitcmd;
1161 int r= write(conn->fd, p, todo);
1163 if (isewouldblock(errno))
1164 connfail(conn, "blocked writing QUIT to idle connection");
1166 connfail(conn, "failed to write QUIT to idle connection: %s",
1173 conn->quitting= why;
1174 conn->since_activity= 0;
1175 debug("C%d is idle (%s), quitting", conn->fd, why);
1182 * For our last connection, we also shut it down if we have had
1183 * less than K in the last L
1185 static void check_idle_conns(void) {
1188 int volthisperiod= lowvol_perperiod[lowvol_circptr];
1190 lowvol_circptr %= lowvol_periods;
1191 lowvol_total += volthisperiod;
1192 lowvol_total -= lowvol_perperiod[lowvol_circptr];
1193 lowvol_perperiod[lowvol_circptr]= 0;
1196 conn->since_activity++;
1200 if (conn->since_activity <= need_activity_periods) continue;
1202 /* We need to shut this down */
1204 connfail(conn,"timed out waiting for response to QUIT (%s)",
1206 else if (conn->sent.count)
1207 connfail(conn,"timed out waiting for responses");
1208 else if (conn->waiting.count || conn->priority.count)
1209 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1210 else if (conn->xmitu)
1211 connfail(conn,"peer has been sending responses"
1212 " before receiving our commands!");
1214 conn_idle_close(conn, "no activity");
1219 conn= LIST_HEAD(conns);
1220 if (!volthisperiod &&
1222 lowvol_total < lowvol_thresh &&
1224 conn_idle_close(conn, "low volume");
1227 /*---------- making new connections ----------*/
1229 static pid_t connecting_child;
1230 static int connecting_fdpass_sock;
1232 static void connect_attempt_discard(void) {
1233 if (connecting_child) {
1234 int status= xwaitpid(&connecting_child, "connect");
1235 if (!(WIFEXITED(status) ||
1236 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1237 report_child_status("connect", status);
1239 if (connecting_fdpass_sock) {
1240 cancel_fd_read_except(connecting_fdpass_sock);
1241 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1245 #define PREP_DECL_MSG_CMSG(msg) \
1247 struct iovec msgiov; \
1248 msgiov.iov_base= &msgbyte; \
1249 msgiov.iov_len= 1; \
1250 struct msghdr msg; \
1251 memset(&msg,0,sizeof(msg)); \
1252 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1253 msg.msg_iov= &msgiov; \
1254 msg.msg_iovlen= 1; \
1255 msg.msg_control= msg##cbuf; \
1256 msg.msg_controllen= sizeof(msg##cbuf);
1258 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1261 assert(fd == connecting_fdpass_sock);
1263 PREP_DECL_MSG_CMSG(msg);
1265 ssize_t rs= recvmsg(fd, &msg, 0);
1267 if (isewouldblock(errno)) return OOP_CONTINUE;
1268 syswarn("failed to read socket from connecting child");
1273 LIST_INIT(conn->waiting);
1274 LIST_INIT(conn->priority);
1275 LIST_INIT(conn->sent);
1277 struct cmsghdr *h= 0;
1278 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1280 int status= xwaitpid(&connecting_child, "connect child (broken)");
1282 if (WIFEXITED(status)) {
1283 if (WEXITSTATUS(status) != 0 &&
1284 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1285 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1286 /* child already reported the problem */;
1288 if (e == OOP_EXCEPTION)
1289 warn("connect: connection child exited code %d but"
1290 " unexpected exception on fdpass socket",
1291 WEXITSTATUS(status));
1293 warn("connect: connection child exited code %d but"
1295 WEXITSTATUS(status), (int)rs);
1297 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1298 warn("connect: connection attempt timed out");
1300 report_child_status("connect", status);
1305 #define CHK(field, val) \
1306 if (h->cmsg_##field != val) { \
1307 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1308 h->cmsg_##field, val); \
1311 CHK(level, SOL_SOCKET);
1312 CHK(type, SCM_RIGHTS);
1313 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1316 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1318 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1321 pid_t got= waitpid(connecting_child, &status, 0);
1322 if (got==-1) sysdie("connect: real wait for child");
1323 assert(got == connecting_child);
1324 connecting_child= 0;
1326 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1327 int es= WEXITSTATUS(status);
1329 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1330 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1332 fatal("connect: child gave unexpected exit status %d", es);
1336 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1338 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1339 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1340 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1341 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1343 &peer_rd_err, conn);
1344 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1346 LIST_ADDHEAD(conns, conn);
1347 notice("C%d (now %d) connected %s",
1348 conn->fd, conns.count, conn->stream ? "streaming" : "plain");
1350 connect_attempt_discard();
1351 check_assign_articles();
1352 return OOP_CONTINUE;
1356 connect_attempt_discard();
1357 reconnect_blocking_event();
1358 return OOP_CONTINUE;
1361 static int allow_connect_start(void) {
1362 return conns.count < max_connections
1363 && !connecting_child
1367 static void connect_start(void) {
1368 assert(!connecting_child);
1369 assert(!connecting_fdpass_sock);
1371 info("starting connection attempt");
1372 int ok_until_connect= until_connect;
1373 reconnect_blocking_event();
1376 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1377 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1379 connecting_child= xfork("connection");
1381 if (!connecting_child) {
1382 FILE *cn_from, *cn_to;
1383 char buf[NNTP_STRLEN+100];
1384 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1386 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1388 alarm(connection_setup_timeout);
1389 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1393 unsigned char c= buf[l-1];
1394 if (!isspace(c)) break;
1395 if (c=='\n' || c=='\r') stripped=1;
1399 sysfatal("connect: connection attempt failed");
1402 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1406 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1407 sysfatal("connect: authentication failed");
1409 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1411 sysfatal("connect: could not send MODE STREAM");
1412 buf[sizeof(buf)-1]= 0;
1413 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1414 if (ferror(cn_from))
1415 sysfatal("connect: could not read response to MODE STREAM");
1417 fatal("connect: connection close in response to MODE STREAM");
1422 fatal("connect: response to MODE STREAM is too long: %.100s...",
1424 l--; if (l>0 && buf[l-1]=='\r') l--;
1427 int rcode= strtoul(buf,&ep,10);
1429 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1433 exitstatus= CONNCHILD_ESTATUS_STREAM;
1439 warn("connect: unexpected response to MODE STREAM: %.50s",
1445 int fd= fileno(cn_from);
1447 PREP_DECL_MSG_CMSG(msg);
1448 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1449 cmsg->cmsg_level= SOL_SOCKET;
1450 cmsg->cmsg_type= SCM_RIGHTS;
1451 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1452 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1454 msg.msg_controllen= cmsg->cmsg_len;
1455 r= sendmsg(socks[1], &msg, 0);
1456 if (r<0) sysdie("sendmsg failed for new connection");
1457 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1462 xclose(socks[1], "connecting fdpass child's socket",0);
1463 connecting_fdpass_sock= socks[0];
1464 xsetnonblock(connecting_fdpass_sock, 1);
1465 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1468 until_connect= ok_until_connect;
1471 /*---------- assigning articles to conns, and transmitting ----------*/
1473 static Article *dequeue_from(int peek, InputFile *ipf) {
1475 if (peek) return LIST_HEAD(ipf->queue);
1477 Article *art= LIST_REMHEAD(ipf->queue);
1479 check_reading_pause_resume(ipf);
1483 static Article *dequeue(int peek) {
1485 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1486 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1487 art= dequeue_from(peek, main_input_file); if (art) return art;
1491 static void check_assign_articles(void) {
1497 int spare=0, inqueue=0;
1499 /* Find a connection to offer this article. We prefer a busy
1500 * connection to an idle one, provided it's not full. We take the
1501 * first (oldest) and since that's stable, it will mean we fill up
1502 * connections in order. That way if we have too many
1503 * connections, the spare ones will go away eventually.
1506 if (walk->quitting) continue;
1507 inqueue= walk->sent.count + walk->priority.count
1508 + walk->waiting.count;
1509 spare= walk->max_queue - inqueue;
1510 assert(inqueue <= max_queue_per_conn);
1512 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1513 else if (spare>0) /*working*/ { use= walk; break; }
1516 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1518 Article *art= dequeue(0);
1520 LIST_ADDTAIL(use->waiting, art);
1521 lowvol_perperiod[lowvol_circptr]++;
1524 conn_maybe_write(use);
1525 } else if (allow_connect_start()) {
1534 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1535 conn_maybe_write(u);
1536 return OOP_CONTINUE;
1539 static void conn_maybe_write(Conn *conn) {
1541 conn_make_some_xmits(conn);
1543 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1544 conn->oopwriting= 0;
1548 void *rp= conn_write_some_xmits(conn);
1549 if (rp==OOP_CONTINUE) {
1550 if (!conn->oopwriting) {
1551 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1552 conn->oopwriting= 1;
1555 } else if (rp==OOP_HALT) {
1558 /* transmitted everything */
1565 /*---------- expiry, flow control and deferral ----------*/
1568 * flow control notes
1569 * to ensure articles go away eventually
1570 * separate queue for each input file
1572 * every period, check head of backlog queue for expiry with SMretrieve
1573 * if too old: discard, and check next article
1574 * also check every backlog article as we read it
1576 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1577 * one-off: eat queued articles from flushing and write them to defer
1578 * one-off: connfail all connections which have any articles from flushing
1579 * newly read articles from flushing go straight to defer
1580 * this should take care of it and get us out of this state
1581 * to avoid filling up ram needlessly
1583 * limit number of queued articles for each ipf
1584 * pause/resume inputfile tailing
1587 static void check_reading_pause_resume(InputFile *ipf) {
1588 if (ipf->queue.count >= max_queue_per_ipf)
1589 inputfile_reading_pause(ipf);
1591 inputfile_reading_resume(ipf);
1594 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1596 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1598 sysfatal("write to defer file %s",path_defer);
1599 article_done(art, whichcount);
1602 static int article_check_expired(Article *art /* must be queued, not conn */) {
1603 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1604 if (artdata) { SMfreearticle(artdata); return 0; }
1606 LIST_REMOVE(art->ipf->queue, art);
1608 art->ipf->count_nooffer_missing++;
1609 article_done(art,-1);
1613 static void inputfile_queue_check_expired(InputFile *ipf) {
1617 Article *art= LIST_HEAD(ipf->queue);
1618 int exp= article_check_expired(art);
1621 check_reading_pause_resume(ipf);
1624 static void article_autodefer(InputFile *ipf, Article *art) {
1626 article_defer(art,-1);
1629 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1631 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1632 if (art->ipf == ipf) return 1;
1636 static void autodefer_input_file_articles(InputFile *ipf) {
1638 while ((art= LIST_REMHEAD(ipf->queue)))
1639 article_autodefer(ipf, art);
1642 static void autodefer_input_file(InputFile *ipf) {
1643 static const char *const abandon= "stuck";
1646 autodefer_input_file_articles(ipf);
1648 if (ipf->inprogress) {
1651 if (has_article_in(&walk->waiting, ipf) ||
1652 has_article_in(&walk->priority, ipf) ||
1653 has_article_in(&walk->sent, ipf))
1654 walk->quitting= abandon;
1656 while (ipf->inprogress) {
1658 if (walk->quitting == abandon) goto found;
1659 abort(); /* where are they ?? */
1662 connfail(walk, "connection is stuck or crawling,"
1663 " and we need to finish flush");
1664 autodefer_input_file_articles(ipf);
1668 check_reading_pause_resume(ipf);
1671 /*========== article transmission ==========*/
1673 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1674 XmitKind kind) { /* caller must then fill in details */
1675 struct iovec *v= &conn->xmit[conn->xmitu];
1676 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1677 v->iov_base= (char*)data;
1683 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1684 xmit_core(conn,data,len, xk_Const);
1686 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1688 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1689 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1693 static void xmit_free(XmitDetails *d) {
1695 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1696 case xk_Const: break;
1701 static void *conn_write_some_xmits(Conn *conn) {
1703 * 0: nothing more to write, no need to call us again
1704 * OOP_CONTINUE: more to write but fd not writeable
1705 * OOP_HALT: disaster, have destroyed conn
1708 int count= conn->xmitu;
1709 if (!count) return 0;
1711 if (count > IOV_MAX) count= IOV_MAX;
1712 ssize_t rs= writev(conn->fd, conn->xmit, count);
1714 if (isewouldblock(errno)) return OOP_CONTINUE;
1715 connfail(conn, "write failed: %s", strerror(errno));
1721 for (done=0; rs; ) {
1722 assert(done<conn->xmitu);
1723 struct iovec *vp= &conn->xmit[done];
1724 XmitDetails *dp= &conn->xmitd[done];
1725 if (rs >= vp->iov_len) {
1727 xmit_free(dp); /* vp->iov_len -= vp->iov_len, etc. */
1730 vp->iov_base= (char*)vp->iov_base + rs;
1732 break; /* rs -= rs */
1735 int newu= conn->xmitu - done;
1736 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1737 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1742 static void conn_make_some_xmits(Conn *conn) {
1744 if (conn->xmitu+5 > CONNIOVS)
1747 Article *art= LIST_REMHEAD(conn->priority);
1748 if (!art) art= LIST_REMHEAD(conn->waiting);
1751 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1752 /* actually send it */
1754 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1757 art->state == art_Unchecked ? art_Unsolicited :
1758 art->state == art_Wanted ? art_Wanted :
1761 if (!artdata) art->missing= 1;
1762 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1766 XMIT_LITERAL("TAKETHIS ");
1767 xmit_noalloc(conn, art->messageid, art->midlen);
1768 XMIT_LITERAL("\r\n");
1769 xmit_artbody(conn, artdata);
1771 article_done(art, -1);
1775 /* we got 235 from IHAVE */
1777 xmit_artbody(conn, artdata);
1779 XMIT_LITERAL(".\r\n");
1783 LIST_ADDTAIL(conn->sent, art);
1789 XMIT_LITERAL("CHECK ");
1791 XMIT_LITERAL("IHAVE ");
1792 xmit_noalloc(conn, art->messageid, art->midlen);
1793 XMIT_LITERAL("\r\n");
1795 assert(art->state == art_Unchecked);
1796 art->ipf->counts[art->state][RC_sent]++;
1797 LIST_ADDTAIL(conn->sent, art);
1802 /*========== handling responses from peer ==========*/
1804 static const oop_rd_style peer_rd_style= {
1805 OOP_RD_DELIM_STRIP, '\n',
1807 OOP_RD_SHORTREC_FORBID
1810 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1811 const char *errmsg, int errnoval,
1812 const char *data, size_t recsz, void *conn_v) {
1814 connfail(conn, "error receiving from peer: %s", errmsg);
1815 return OOP_CONTINUE;
1818 static Article *article_reply_check(Conn *conn, const char *response,
1819 int code_indicates_streaming,
1821 /* 1:yes, -1:no, 0:dontcare */,
1822 const char *sanitised_response) {
1823 Article *art= LIST_HEAD(conn->sent);
1827 "peer gave unexpected response when no commands outstanding: %s",
1828 sanitised_response);
1832 if (code_indicates_streaming) {
1833 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1834 if (!conn->stream) {
1835 connfail(conn, "peer gave streaming response code "
1836 " to IHAVE or subsequent body: %s", sanitised_response);
1839 const char *got_mid= response+4;
1840 int got_midlen= strcspn(got_mid, " \n\r");
1841 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1842 connfail(conn, "peer gave streaming response with syntactically invalid"
1843 " messageid: %s", sanitised_response);
1846 if (got_midlen != art->midlen ||
1847 memcmp(got_mid, art->messageid, got_midlen)) {
1848 connfail(conn, "peer gave streaming response code to wrong article -"
1849 " probable synchronisation problem; we offered: %s;"
1851 art->messageid, sanitised_response);
1856 connfail(conn, "peer gave non-streaming response code to"
1857 " CHECK/TAKETHIS: %s", sanitised_response);
1862 if (must_have_sent>0 && art->state < art_Wanted) {
1863 connfail(conn, "peer says article accepted but"
1864 " we had not sent the body: %s", sanitised_response);
1867 if (must_have_sent<0 && art->state >= art_Wanted) {
1868 connfail(conn, "peer says please sent the article but we just did: %s",
1869 sanitised_response);
1873 Article *art_again= LIST_REMHEAD(conn->sent);
1874 assert(art_again == art);
1878 static void update_nocheck(int accepted) {
1879 accept_proportion *= nocheck_decay;
1880 accept_proportion += accepted * (1.0 - nocheck_decay);
1881 int new_nocheck= accept_proportion >= nocheck_thresh;
1882 if (new_nocheck && !nocheck_reported) {
1883 notice("entering nocheck mode for the first time");
1884 nocheck_reported= 1;
1885 } else if (new_nocheck != nocheck) {
1886 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1888 nocheck= new_nocheck;
1891 static void article_done(Article *art, int whichcount) {
1892 if (whichcount>=0 && !art->missing)
1893 art->ipf->counts[art->state][whichcount]++;
1895 if (whichcount == RC_accepted) update_nocheck(1);
1896 else if (whichcount == RC_unwanted) update_nocheck(0);
1898 InputFile *ipf= art->ipf;
1900 while (art->blanklen) {
1901 static const char spaces[]=
1911 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1912 int r= pwrite(ipf->fd, spaces, w, art->offset);
1914 if (errno==EINTR) continue;
1915 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1916 art->messageid, art->blanklen,
1917 (unsigned long)art->offset, ipf->path);
1919 assert(r>=0 && r<=w);
1925 assert(ipf->inprogress >= 0);
1928 if (!ipf->inprogress && ipf != main_input_file)
1929 queue_check_input_done();
1932 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1933 const char *errmsg, int errnoval,
1934 const char *data, size_t recsz, void *conn_v) {
1937 if (ev == OOP_RD_EOF) {
1938 connfail(conn, "unexpected EOF from peer");
1939 return OOP_CONTINUE;
1941 assert(ev == OOP_RD_OK);
1943 char *sani= sanitise(data,-1);
1946 unsigned long code= strtoul(data, &ep, 10);
1947 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1948 connfail(conn, "badly formatted response from peer: %s", sani);
1949 return OOP_CONTINUE;
1952 int busy= conn_busy(conn);
1954 if (conn->quitting) {
1955 if (code!=205 && code!=400) {
1956 connfail(conn, "peer gave unexpected response to QUIT (%s): %s",
1957 conn->quitting, sani);
1959 LIST_REMOVE(conns,conn);
1960 notice("C%d (now %d) idle connection closed (%s)",
1961 conn->fd, conns.count, conn->quitting);
1965 return OOP_CONTINUE;
1968 conn->since_activity= 0;
1971 #define GET_ARTICLE(musthavesent) do{ \
1972 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1973 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1976 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1977 code_streaming= (streaming); \
1978 GET_ARTICLE(musthavesent); \
1979 article_done(art, RC_##how); \
1983 #define PEERBADMSG(m) do { \
1984 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1987 int code_streaming= 0;
1991 default: PEERBADMSG("peer sent unexpected message");
1995 PEERBADMSG("peer timed us out or stopped accepting articles");
1997 LIST_REMOVE(conns,conn);
1998 notice("C%d (now %d) idle connection closed by peer",
1999 conns.count, conn->fd);
2001 return OOP_CONTINUE;
2003 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
2004 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
2006 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
2007 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
2009 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
2010 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
2012 case 238: /* CHECK says send it */
2014 case 335: /* IHAVE says send it */
2016 assert(art->state == art_Unchecked);
2017 art->ipf->counts[art->state][RC_accepted]++;
2018 art->state= art_Wanted;
2019 LIST_ADDTAIL(conn->priority, art);
2022 case 431: /* CHECK or TAKETHIS says try later */
2024 case 436: /* IHAVE says try later */
2026 article_defer(art, RC_deferred);
2032 conn_maybe_write(conn);
2033 check_assign_articles();
2034 return OOP_CONTINUE;
2038 /*========== monitoring of input files ==========*/
2040 static void feedfile_eof(InputFile *ipf) {
2041 assert(ipf != main_input_file); /* promised by tailing_try_read */
2042 inputfile_reading_stop(ipf);
2044 if (ipf == flushing_input_file) {
2045 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2046 if (main_input_file) inputfile_reading_start(main_input_file);
2047 statemc_check_flushing_done();
2048 } else if (ipf == backlog_input_file) {
2049 statemc_check_backlog_done();
2051 abort(); /* supposed to wait rather than get EOF on main input file */
2055 static InputFile *open_input_file(const char *path) {
2056 int fd= open(path, O_RDWR);
2058 if (errno==ENOENT) return 0;
2059 sysfatal("unable to open input file %s", path);
2063 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2064 memset(ipf,0,sizeof(*ipf));
2068 LIST_INIT(ipf->queue);
2069 strcpy(ipf->path, path);
2074 static void close_input_file(InputFile *ipf) { /* does not free */
2075 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2076 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2077 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2078 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2079 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2083 /*---------- dealing with articles read in the input file ----------*/
2085 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2086 const char *data, const char *how) {
2087 warn("corrupted file: %s, offset %lu: %s: in %s",
2088 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2089 ipf->readcount_err++;
2090 if (ipf->readcount_err > max_bad_data_initial +
2091 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2092 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2093 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2094 return OOP_CONTINUE;
2097 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2098 oop_rd_event ev, const char *errmsg,
2099 int errnoval, const char *data, size_t recsz,
2101 InputFile *ipf= ipf_v;
2102 assert(ev == OOP_RD_SYSTEM);
2104 sysdie("error reading input file: %s, offset %lu",
2105 ipf->path, (unsigned long)ipf->offset);
2108 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2109 oop_rd_event ev, const char *errmsg,
2110 int errnoval, const char *data, size_t recsz,
2112 InputFile *ipf= ipf_v;
2114 char tokentextbuf[sizeof(TOKEN)*2+3];
2116 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2118 off_t old_offset= ipf->offset;
2119 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2121 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2123 if (ev==OOP_RD_PARTREC)
2124 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2125 /* but process it anyway */
2127 if (ipf->skippinglong) {
2128 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2129 return OOP_CONTINUE;
2131 if (ev==OOP_RD_LONG) {
2132 ipf->skippinglong= 1;
2133 X_BAD_DATA("overly long line");
2136 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2137 if (!recsz) X_BAD_DATA("empty line");
2140 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2141 ipf->readcount_blank++;
2142 return OOP_CONTINUE;
2145 char *space= strchr(data,' ');
2146 int tokenlen= space-data;
2147 int midlen= (int)recsz-tokenlen-1;
2148 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2149 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2151 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2152 memcpy(tokentextbuf, data, tokenlen);
2153 tokentextbuf[tokenlen]= 0;
2154 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2156 ipf->readcount_ok++;
2158 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2159 memset(art,0,sizeof(*art));
2160 art->state= art_Unchecked;
2161 art->midlen= midlen;
2162 art->ipf= ipf; ipf->inprogress++;
2163 art->token= TextToToken(tokentextbuf);
2164 art->offset= old_offset;
2165 art->blanklen= recsz;
2166 strcpy(art->messageid, space+1);
2167 LIST_ADDTAIL(ipf->queue, art);
2169 if (ipf->autodefer >= 0)
2170 article_autodefer(ipf, art);
2171 else if (ipf==backlog_input_file)
2172 article_check_expired(art);
2174 if (sms==sm_NORMAL && ipf==main_input_file &&
2175 ipf->offset >= target_max_feedfile_size)
2176 statemc_start_flush("feed file size");
2178 check_assign_articles(); /* may destroy conn but that's OK */
2179 check_reading_pause_resume(ipf);
2180 return OOP_CONTINUE;
2183 /*========== tailing input file ==========*/
2185 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2187 /* lifetime of ipf here is OK because destruction will cause
2188 * on_cancel which will cancel this callback */
2189 InputFile *ipf= user;
2191 if (!ipf->fake_readable) return OOP_CONTINUE;
2193 /* we just keep calling readable until our caller (oop_rd)
2194 * has called try_read, and try_read has found EOF so given EAGAIN */
2195 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2197 return ipf->readable_callback(loop, &ipf->readable,
2198 ipf->readable_callback_user);
2201 static void tailing_on_cancel(struct oop_readable *rable) {
2202 InputFile *ipf= (void*)rable;
2204 if (ipf->filemon) filemon_stop(ipf);
2205 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2206 ipf->readable_callback= 0;
2209 static void tailing_make_readable(InputFile *ipf) {
2210 if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2212 ipf->fake_readable= 1;
2213 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2216 static int tailing_on_readable(struct oop_readable *rable,
2217 oop_readable_call *cb, void *user) {
2218 InputFile *ipf= (void*)rable;
2220 tailing_on_cancel(rable);
2221 ipf->readable_callback= cb;
2222 ipf->readable_callback_user= user;
2224 tailing_make_readable(ipf);
2228 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2230 InputFile *ipf= (void*)rable;
2232 ssize_t r= read(ipf->fd, buffer, length);
2234 if (errno==EINTR) continue;
2235 ipf->fake_readable= 0;
2239 if (ipf==main_input_file) {
2241 ipf->fake_readable= 0;
2243 } else if (ipf==flushing_input_file) {
2245 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2246 } else if (ipf==backlog_input_file) {
2256 /*---------- filemon implemented with inotify ----------*/
2258 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2259 #define HAVE_FILEMON
2261 #include <sys/inotify.h>
2263 static int filemon_inotify_fd;
2264 static int filemon_inotify_wdmax;
2265 static InputFile **filemon_inotify_wd2ipf;
2267 struct Filemon_Perfile {
2271 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2272 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2273 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2275 if (wd >= filemon_inotify_wdmax) {
2277 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2278 sizeof(*filemon_inotify_wd2ipf) * newmax);
2279 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2280 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2281 filemon_inotify_wdmax= newmax;
2284 assert(!filemon_inotify_wd2ipf[wd]);
2285 filemon_inotify_wd2ipf[wd]= ipf;
2287 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2288 ipf, wd, filemon_inotify_wdmax);
2293 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2295 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2296 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2297 if (r) sysdie("inotify_rm_watch");
2298 filemon_inotify_wd2ipf[wd]= 0;
2301 static void *filemon_inotify_readable(oop_source *lp, int fd,
2302 oop_event e, void *u) {
2303 struct inotify_event iev;
2305 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2307 if (isewouldblock(errno)) break;
2308 sysdie("read from inotify master");
2309 } else if (r==sizeof(iev)) {
2310 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2312 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2314 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2315 /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2316 tailing_make_readable(ipf);
2318 return OOP_CONTINUE;
2321 static int filemon_method_init(void) {
2322 filemon_inotify_fd= inotify_init();
2323 if (filemon_inotify_fd<0) {
2324 syswarn("filemon/inotify: inotify_init failed");
2327 xsetnonblock(filemon_inotify_fd, 1);
2328 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2330 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2334 static void filemon_method_dump_info(FILE *f) {
2336 fprintf(f,"inotify");
2337 DUMPV("%d",,filemon_inotify_fd);
2338 DUMPV("%d",,filemon_inotify_wdmax);
2339 for (i=0; i<filemon_inotify_wdmax; i++)
2340 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2343 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2345 /*---------- filemon dummy implementation ----------*/
2347 #if !defined(HAVE_FILEMON)
2349 struct Filemon_Perfile { int dummy; };
2351 static int filemon_method_init(void) {
2352 warn("filemon/dummy: no filemon method compiled in");
2355 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2356 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2357 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2359 #endif /* !HAVE_FILEMON */
2361 /*---------- filemon generic interface ----------*/
2363 static void filemon_start(InputFile *ipf) {
2364 assert(!ipf->filemon);
2367 filemon_method_startfile(ipf, ipf->filemon);
2370 static void filemon_stop(InputFile *ipf) {
2371 if (!ipf->filemon) return;
2372 filemon_method_stopfile(ipf, ipf->filemon);
2377 /*---------- interface to start and stop an input file ----------*/
2379 static const oop_rd_style feedfile_rdstyle= {
2380 OOP_RD_DELIM_STRIP, '\n',
2382 OOP_RD_SHORTREC_LONG,
2385 static void inputfile_reading_resume(InputFile *ipf) {
2386 if (!ipf->rd) return;
2387 if (!ipf->paused) return;
2389 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2390 feedfile_got_article,ipf, feedfile_read_err, ipf);
2391 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2396 static void inputfile_reading_pause(InputFile *ipf) {
2397 if (!ipf->rd) return;
2398 if (ipf->paused) return;
2399 oop_rd_cancel(ipf->rd);
2403 static void inputfile_reading_start(InputFile *ipf) {
2405 ipf->readable.on_readable= tailing_on_readable;
2406 ipf->readable.on_cancel= tailing_on_cancel;
2407 ipf->readable.try_read= tailing_try_read;
2408 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2409 ipf->readable.delete_kill= 0;
2411 ipf->readable_callback= 0;
2412 ipf->readable_callback_user= 0;
2414 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2418 inputfile_reading_resume(ipf);
2421 static void inputfile_reading_stop(InputFile *ipf) {
2423 inputfile_reading_pause(ipf);
2424 oop_rd_delete(ipf->rd);
2426 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2430 /*========== interaction with innd - state machine ==========*/
2432 /* See official state diagram at top of file. We implement
2443 |`---------------------------------------------------.
2445 |`---------------- - - - |
2446 D ENOENT | D EXISTS see OVERALL STATES diagram |
2447 | for full startup logic |
2450 | ============ try to |
2456 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2457 ^ | hardlink F to D |
2460 | | our handle onto F is now onto D |
2463 | |<-------------------<---------------------<---------+
2465 | | spawn inndcomm flush |
2467 | ================== |
2468 | FLUSHING[-ABSENT] |
2470 | main D tail/none |
2471 | ================== |
2473 | | INNDCOMM FLUSH FAILS ^
2474 | |`----------------------->----------. |
2476 | | NO SUCH SITE V |
2477 ^ |`--------------->----. ==================== |
2478 | | \ FLUSHFAILED[-ABSENT] |
2480 | | FLUSH OK \ main D tail/none |
2481 | | open F \ ==================== |
2483 | | \ | TIME TO RETRY |
2484 | |`------->----. ,---<---'\ `----------------'
2485 | | D NONE | | D NONE `----.
2487 | ============= V V ============
2488 | SEPARATED-1 | | DROPPING-1
2489 | flsh->rd!=0 | | flsh->rd!=0
2490 | [Separated] | | [Dropping]
2491 | main F idle | | main none
2492 | flsh D tail | | flsh D tail
2493 | ============= | | ============
2495 ^ | EOF ON D | | defer | EOF ON D
2497 | =============== | | ===============
2498 | SEPARATED-2 | | DROPPING-2
2499 | flsh->rd==0 | V flsh->rd==0
2500 | [Finishing] | | [Dropping]
2501 | main F tail | `. main none
2502 | flsh D closed | `. flsh D closed
2503 | =============== V `. ===============
2505 | | ALL D PROCESSED `. | ALL D PROCESSED
2506 | V install defer as backlog `. | install defer
2507 ^ | close D `. | close D
2508 | | unlink D `. | unlink D
2511 `----------' ==============
2531 static void startup_set_input_file(InputFile *f) {
2532 assert(!main_input_file);
2534 inputfile_reading_start(f);
2537 static void statemc_lock(void) {
2539 struct stat stab, stabf;
2542 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2543 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2546 memset(&fl,0,sizeof(fl));
2548 fl.l_whence= SEEK_SET;
2549 int r= fcntl(lockfd, F_SETLK, &fl);
2551 if (errno==EACCES || isewouldblock(errno)) {
2552 if (quiet_multiple) exit(0);
2553 fatal("another duct holds the lockfile");
2555 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2558 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2560 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2562 if (!lock_noent && samefile(&stab, &stabf))
2565 xclose(lockfd, "stale lockfile ", path_lock);
2568 FILE *lockfile= fdopen(lockfd, "w");
2569 if (!lockfile) sysdie("fdopen lockfile");
2571 int r= ftruncate(lockfd, 0);
2572 if (r) sysdie("truncate lockfile to write new info");
2574 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2575 (unsigned long)self_pid,
2576 sitename, feedfile, remote_host) == EOF ||
2578 sysfatal("write info to lockfile %s", path_lock);
2580 debug("startup: locked");
2583 static void statemc_init(void) {
2584 struct stat stabdefer;
2586 search_backlog_file();
2589 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2591 debug("startup: ductdefer ENOENT");
2593 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2594 switch (stabdefer.st_nlink==1) {
2596 open_defer(); /* so that we will later close it and rename it */
2599 xunlink(path_defer, "stale defer file link"
2600 " (presumably hardlink to backlog file)");
2603 die("defer file %s has unexpected link count %d",
2604 path_defer, stabdefer.st_nlink);
2608 struct stat stab_f, stab_d;
2611 InputFile *file_d= open_input_file(path_flushing);
2612 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2614 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2616 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2617 debug("startup: F==D => Hardlinked");
2618 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2623 debug("startup: F ENOENT => Moved");
2624 if (file_d) startup_set_input_file(file_d);
2625 spawn_inndcomm_flush("feedfile missing at startup");
2626 /* => Flushing, sms:=FLUSHING */
2629 debug("startup: F!=D => Separated");
2630 startup_set_input_file(file_d);
2631 flushing_input_file= main_input_file;
2632 main_input_file= open_input_file(feedfile);
2633 if (!main_input_file) die("feedfile vanished during startup");
2634 SMS(SEPARATED, max_separated_periods,
2635 "found both old and current feed files");
2637 debug("startup: F exists, D ENOENT => Normal");
2638 InputFile *file_f= open_input_file(feedfile);
2639 if (!file_f) die("feed file vanished during startup");
2640 startup_set_input_file(file_f);
2641 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2646 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2647 assert(sms == sm_NORMAL);
2649 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2651 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2652 (unsigned long)target_max_feedfile_size,
2655 int r= link(feedfile, path_flushing);
2656 if (r) sysfatal("link feedfile %s to flushing file %s",
2657 feedfile, path_flushing);
2660 xunlink(feedfile, "old feedfile link");
2663 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2666 static int trigger_flush_ok(const char *why) {
2670 statemc_start_flush(why ? why : "periodic");
2671 return 1; /* Normal => Flushing; => FLUSHING */
2673 case sm_FLUSHFAILED:
2674 spawn_inndcomm_flush(why ? why : "retry");
2675 return 1; /* Moved => Flushing; => FLUSHING */
2679 warn("abandoning old feedfile after flush (%s), autodeferring",
2680 why ? why : "took too long to complete");
2681 assert(flushing_input_file);
2682 autodefer_input_file(flushing_input_file);
2690 static void statemc_period_poll(void) {
2691 if (!until_flush) return;
2693 assert(until_flush>=0);
2695 if (until_flush) return;
2696 int ok= trigger_flush_ok(0);
2700 static int inputfile_is_done(InputFile *ipf) {
2702 if (ipf->inprogress) return 0; /* new article in the meantime */
2703 if (ipf->rd) return 0; /* not had EOF */
2707 static void notice_processed(InputFile *ipf, int completed,
2708 const char *what, const char *spec) {
2709 if (!ipf) return; /* allows preterminate to be lazy */
2711 #define RCI_NOTHING(x) /* nothing */
2712 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2713 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2715 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2717 char *inprog= completed
2718 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2719 : xasprintf(" inprogress=%ld", ipf->inprogress);
2720 char *autodefer= ipf->autodefer >= 0
2721 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2722 : xasprintf("%s","");
2724 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2725 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2726 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2728 completed?"completed":"processed", what, spec,
2729 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2730 inprog, autodefer, ipf->count_nooffer_missing,
2731 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2732 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2733 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2734 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2735 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2744 static void statemc_check_backlog_done(void) {
2745 InputFile *ipf= backlog_input_file;
2746 if (!inputfile_is_done(ipf)) return;
2748 const char *slash= strrchr(ipf->path, '/');
2749 const char *leaf= slash ? slash+1 : ipf->path;
2750 const char *under= strchr(slash, '_');
2751 const char *rest= under ? under+1 : leaf;
2752 if (!strncmp(rest,"backlog",7)) rest += 7;
2753 notice_processed(ipf,1,"backlog ",rest);
2755 close_input_file(ipf);
2756 if (unlink(ipf->path)) {
2757 if (errno != ENOENT)
2758 sysdie("could not unlink processed backlog file %s", ipf->path);
2759 warn("backlog file %s vanished while we were reading it"
2760 " so we couldn't remove it (but it's done now, anyway)",
2764 backlog_input_file= 0;
2765 search_backlog_file();
2769 static void statemc_check_flushing_done(void) {
2770 InputFile *ipf= flushing_input_file;
2771 if (!inputfile_is_done(ipf)) return;
2773 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2775 notice_processed(ipf,1,"feedfile","");
2779 xunlink(path_flushing, "old flushing file");
2781 close_input_file(flushing_input_file);
2782 free(flushing_input_file);
2783 flushing_input_file= 0;
2785 if (sms==sm_SEPARATED) {
2786 notice("flush complete");
2787 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2788 } else if (sms==sm_DROPPING) {
2789 SMS(DROPPED, max_separated_periods, "old flush complete");
2790 search_backlog_file();
2791 notice("feed dropped, but will continue until backlog is finished");
2795 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2797 assert(!inputfile_is_done(main_input_file));
2798 statemc_check_flushing_done();
2799 statemc_check_backlog_done();
2800 return OOP_CONTINUE;
2803 static void queue_check_input_done(void) {
2804 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2807 static void statemc_setstate(StateMachineState newsms, int periods,
2808 const char *forlog, const char *why) {
2810 until_flush= periods;
2812 const char *xtra= "";
2815 case sm_FLUSHFAILED:
2816 if (!main_input_file) xtra= "-ABSENT";
2820 xtra= flushing_input_file->rd ? "-1" : "-2";
2826 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2828 info("state %s%s %s",forlog,xtra,why);
2832 /*---------- defer and backlog files ----------*/
2834 static void open_defer(void) {
2839 defer= fopen(path_defer, "a+");
2840 if (!defer) sysfatal("could not open defer file %s", path_defer);
2842 /* truncate away any half-written records */
2844 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2846 if (stab.st_size > LONG_MAX)
2847 die("defer file %s size is far too large", path_defer);
2852 long orgsize= stab.st_size;
2853 long truncto= stab.st_size;
2855 if (!truncto) break; /* was only (if anything) one half-truncated record */
2856 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2857 sysdie("seek in defer file %s while truncating partial", path_defer);
2862 sysdie("failed read from defer file %s", path_defer);
2864 die("defer file %s shrank while we were checking it!", path_defer);
2870 if (stab.st_size != truncto) {
2871 warn("truncating half-record at end of defer file %s -"
2872 " shrinking by %ld bytes from %ld to %ld",
2873 path_defer, orgsize - truncto, orgsize, truncto);
2876 sysfatal("could not flush defer file %s", path_defer);
2877 if (ftruncate(fileno(defer), truncto))
2878 sysdie("could not truncate defer file %s", path_defer);
2881 info("continuing existing defer file %s (%ld bytes)",
2882 path_defer, orgsize);
2884 if (fseek(defer, truncto, SEEK_SET))
2885 sysdie("could not seek to new end of defer file %s", path_defer);
2888 static void close_defer(void) {
2893 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2895 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2898 time_t now= xtime();
2900 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2902 (unsigned long)stab.st_ino);
2903 if (link(path_defer, backlog))
2904 sysfatal("could not install defer file %s as backlog file %s",
2905 path_defer, backlog);
2906 if (unlink(path_defer))
2907 sysdie("could not unlink old defer link %s to backlog file %s",
2908 path_defer, backlog);
2912 if (until_backlog_nextscan < 0 ||
2913 until_backlog_nextscan > backlog_retry_minperiods + 1)
2914 until_backlog_nextscan= backlog_retry_minperiods + 1;
2917 static void poll_backlog_file(void) {
2918 if (until_backlog_nextscan < 0) return;
2919 if (until_backlog_nextscan-- > 0) return;
2920 search_backlog_file();
2923 static void search_backlog_file(void) {
2924 /* returns non-0 iff there are any backlog files */
2929 const char *oldest_path=0;
2930 time_t oldest_mtime=0, now;
2932 if (backlog_input_file) return;
2936 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2940 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2942 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2944 for (i=0; i<gl.gl_pathc; i++) {
2945 const char *path= gl.gl_pathv[i];
2947 if (strchr(path,'#') || strchr(path,'~')) {
2948 debug("backlog file search skipping %s", path);
2951 r= stat(path, &stab);
2953 syswarn("failed to stat backlog file %s", path);
2956 if (!S_ISREG(stab.st_mode)) {
2957 warn("backlog file %s is not a plain file (or link to one)", path);
2960 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2962 oldest_mtime= stab.st_mtime;
2965 case GLOB_NOMATCH: /* fall through */
2968 sysdie("glob expansion of backlog pattern %s gave unexpected"
2969 " nonzero (error?) return value %d", globpat_backlog, r);
2973 debug("backlog scan: none");
2975 if (sms==sm_DROPPED) {
2977 notice("feed dropped and our work is complete");
2979 int r= unlink(path_cli);
2980 if (r && errno!=ENOENT)
2981 syswarn("failed to unlink cli socket for old feed");
2983 xunlink(path_lock, "lockfile for old feed");
2986 until_backlog_nextscan= backlog_spontrescan_periods;
2991 double age= difftime(now, oldest_mtime);
2992 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2994 if (age_deficiency <= 0) {
2995 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2996 age, age_deficiency, oldest_path);
2998 backlog_input_file= open_input_file(oldest_path);
2999 if (!backlog_input_file) {
3000 warn("backlog file %s vanished as we opened it", oldest_path);
3004 inputfile_reading_start(backlog_input_file);
3005 until_backlog_nextscan= -1;
3009 until_backlog_nextscan= age_deficiency / period_seconds;
3011 if (backlog_spontrescan_periods >= 0 &&
3012 until_backlog_nextscan > backlog_spontrescan_periods)
3013 until_backlog_nextscan= backlog_spontrescan_periods;
3015 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
3016 age, age_deficiency, until_backlog_nextscan, oldest_path);
3023 /*---------- shutdown and signal handling ----------*/
3025 static void preterminate(void) {
3026 if (in_child) return;
3027 notice_processed(main_input_file,0,"feedfile","");
3028 notice_processed(flushing_input_file,0,"flushing","");
3029 if (backlog_input_file)
3030 notice_processed(backlog_input_file,0, "backlog file ",
3031 backlog_input_file->path);
3034 static int signal_self_pipe[2];
3035 static sig_atomic_t terminate_sig_flag;
3037 static void raise_default(int signo) {
3038 xsigsetdefault(signo);
3043 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3044 assert(fd=signal_self_pipe[0]);
3046 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3047 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
3048 if (r==0) die("eof on signal self pipe");
3049 if (terminate_sig_flag) {
3051 notice("terminating (%s)", strsignal(terminate_sig_flag));
3052 raise_default(terminate_sig_flag);
3054 return OOP_CONTINUE;
3057 static void sigarrived_handler(int signum) {
3062 if (!terminate_sig_flag) terminate_sig_flag= signum;
3067 write(signal_self_pipe[1],&x,1);
3070 static void init_signals(void) {
3071 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3072 sysdie("could not ignore SIGPIPE");
3074 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3076 xsetnonblock(signal_self_pipe[0],1);
3077 xsetnonblock(signal_self_pipe[1],1);
3079 struct sigaction sa;
3080 memset(&sa,0,sizeof(sa));
3081 sa.sa_handler= sigarrived_handler;
3082 sa.sa_flags= SA_RESTART;
3083 xsigaction(SIGTERM,&sa);
3084 xsigaction(SIGINT,&sa);
3086 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3089 /*========== flushing the feed ==========*/
3091 static pid_t inndcomm_child;
3092 static int inndcomm_sentinel_fd;
3094 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3095 assert(inndcomm_child);
3096 assert(fd == inndcomm_sentinel_fd);
3097 int status= xwaitpid(&inndcomm_child, "inndcomm");
3100 cancel_fd_read_except(fd);
3101 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3102 inndcomm_sentinel_fd= 0;
3104 assert(!flushing_input_file);
3106 if (WIFEXITED(status)) {
3107 switch (WEXITSTATUS(status)) {
3109 case INNDCOMMCHILD_ESTATUS_FAIL:
3112 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3113 notice("feed has been dropped by innd, finishing up");
3114 flushing_input_file= main_input_file;
3115 tailing_make_readable(flushing_input_file);
3116 /* we probably previously returned EAGAIN from our fake read method
3117 * when in fact we were at EOF, so signal another readable event
3118 * so we actually see the EOF */
3122 if (flushing_input_file) {
3123 SMS(DROPPING, max_separated_periods,
3124 "feed dropped by innd, but must finish last flush");
3127 SMS(DROPPED, 0, "feed dropped by innd");
3128 search_backlog_file();
3130 return OOP_CONTINUE;
3134 flushing_input_file= main_input_file;
3135 tailing_make_readable(flushing_input_file);
3137 main_input_file= open_input_file(feedfile);
3138 if (!main_input_file)
3139 die("flush succeeded but feedfile %s does not exist!"
3140 " (this probably means feedfile does not correspond"
3141 " to site %s in newsfeeds)", feedfile, sitename);
3143 if (flushing_input_file) {
3144 SMS(SEPARATED, max_separated_periods, "flush complete");
3147 SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3149 return OOP_CONTINUE;
3152 goto unexpected_exitstatus;
3155 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3156 warn("flush timed out trying to talk to innd");
3159 unexpected_exitstatus:
3160 report_child_status("inndcomm child", status);
3164 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3165 return OOP_CONTINUE;
3168 static void inndcommfail(const char *what) {
3169 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3170 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3173 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3176 notice("flushing %s",why);
3178 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3179 assert(!inndcomm_child);
3180 assert(!inndcomm_sentinel_fd);
3182 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3184 inndcomm_child= xfork("inndcomm child");
3186 if (!inndcomm_child) {
3187 const char *flushargv[2]= { sitename, 0 };
3191 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3192 /* parent spots the autoclose of pipefds[1] when we die or exit */
3194 if (simulate_flush>=0) {
3195 warn("SIMULATING flush child status %d", simulate_flush);
3196 if (simulate_flush>128) raise(simulate_flush-128);
3197 else exit(simulate_flush);
3200 alarm(inndcomm_flush_timeout);
3201 r= ICCopen(); if (r) inndcommfail("connect");
3202 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3203 if (!r) exit(0); /* yay! */
3205 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3206 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3207 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3212 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3213 inndcomm_sentinel_fd= pipefds[0];
3214 assert(inndcomm_sentinel_fd);
3215 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3217 SMS(FLUSHING, 0, why);
3220 /*========== main program ==========*/
3222 static void postfork_inputfile(InputFile *ipf) {
3224 xclose(ipf->fd, "(in child) input file ", ipf->path);
3227 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3228 /* we have no stdio streams that are buffered long-term */
3230 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3233 static void postfork(void) {
3236 xsigsetdefault(SIGTERM);
3237 xsigsetdefault(SIGINT);
3238 xsigsetdefault(SIGPIPE);
3239 if (terminate_sig_flag) raise(terminate_sig_flag);
3241 postfork_inputfile(main_input_file);
3242 postfork_inputfile(flushing_input_file);
3246 conn_closefd(conn,"(in child) ");
3248 postfork_stdio(defer, "defer file ", path_defer);
3251 typedef struct Every Every;
3253 struct timeval interval;
3258 static void every_schedule(Every *e, struct timeval base);
3260 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3263 if (!e->fixed_rate) xgettimeofday(&base);
3264 every_schedule(e, base);
3265 return OOP_CONTINUE;
3268 static void every_schedule(Every *e, struct timeval base) {
3269 struct timeval when;
3270 timeradd(&base, &e->interval, &when);
3271 loop->on_time(loop, when, every_happens, e);
3274 static void every(int interval, int fixed_rate, void (*f)(void)) {
3275 NEW_DECL(Every *,e);
3276 e->interval.tv_sec= interval;
3277 e->interval.tv_usec= 0;
3278 e->fixed_rate= fixed_rate;
3281 xgettimeofday(&now);
3282 every_schedule(e, now);
3285 static void filepoll(void) {
3286 tailing_make_readable(main_input_file);
3287 tailing_make_readable(flushing_input_file);
3290 static char *debug_report_ipf(InputFile *ipf) {
3291 if (!ipf) return xasprintf("none");
3293 const char *slash= strrchr(ipf->path,'/');
3294 const char *path= slash ? slash+1 : ipf->path;
3296 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3298 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3299 (long)ipf->offset, ipf->fd,
3300 ipf->rd ? "" : ",!rd",
3301 ipf->skippinglong ? "*skiplong" : "",
3302 ipf->rd && ipf->paused ? "*paused" : "");
3305 static void period(void) {
3306 char *dipf_main= debug_report_ipf(main_input_file);
3307 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3308 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3311 " sms=%s[%d] conns=%d until_connect=%d"
3312 " input_files main:%s flushing:%s backlog:%s[%d]"
3313 " children connecting=%ld inndcomm=%ld lowvol_total=%d"
3315 sms_names[sms], until_flush, conns.count, until_connect,
3316 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3317 (long)connecting_child, (long)inndcomm_child, lowvol_total
3321 free(dipf_flushing);
3324 if (until_connect) until_connect--;
3326 inputfile_queue_check_expired(backlog_input_file);
3327 poll_backlog_file();
3328 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3329 statemc_period_poll();
3330 check_assign_articles();
3335 /*========== dumping state ==========*/
3337 static void dump_article_list(FILE *f, const CliCommand *c,
3338 const ArticleList *al) {
3339 fprintf(f, " count=%d\n", al->count);
3340 if (!c->xval) return;
3342 int i; Article *art;
3343 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3344 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3345 DUMPV("%p", art->,ipf);
3346 DUMPV("%d", art->,missing);
3347 DUMPV("%lu", (unsigned long)art->,offset);
3348 DUMPV("%d", art->,blanklen);
3349 DUMPV("%d", art->,midlen);
3350 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3354 static void dump_input_file(FILE *f, const CliCommand *c,
3355 InputFile *ipf, const char *wh) {
3356 char *dipf= debug_report_ipf(ipf);
3357 fprintf(f,"input %s %s", wh, dipf);
3361 DUMPV("%d", ipf->,readcount_ok);
3362 DUMPV("%d", ipf->,readcount_blank);
3363 DUMPV("%d", ipf->,readcount_err);
3364 DUMPV("%d", ipf->,count_nooffer_missing);
3368 ArtState state; const char *const *statename;
3369 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3370 #define RC_DUMP_FMT(x) " " #x "=%d"
3371 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3372 fprintf(f,"input %s counts %-11s"
3373 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3375 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3377 fprintf(f,"input %s queue", wh);
3378 dump_article_list(f,c,&ipf->queue);
3384 fprintf(cc->out, "dumping state to %s\n", path_dump);
3385 FILE *f= fopen(path_dump, "w");
3386 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3388 fprintf(f,"general");
3389 DUMPV("%s", sms_names,[sms]);
3390 DUMPV("%d", ,until_flush);
3391 DUMPV("%ld", (long),self_pid);
3392 DUMPV("%p", , defer);
3393 DUMPV("%d", , until_connect);
3394 DUMPV("%d", , until_backlog_nextscan);
3395 DUMPV("%d", , simulate_flush);
3396 fprintf(f,"\nnocheck");
3397 DUMPV("%#.10f", , accept_proportion);
3398 DUMPV("%d", , nocheck);
3399 DUMPV("%d", , nocheck_reported);
3402 fprintf(f,"special");
3403 DUMPV("%ld", (long),connecting_child);
3404 DUMPV("%d", , connecting_fdpass_sock);
3405 DUMPV("%d", , cli_master);
3408 fprintf(f,"lowvol");
3409 DUMPV("%d", , lowvol_circptr);
3410 DUMPV("%d", , lowvol_total);
3412 for (i=0; i<lowvol_periods; i++) {
3414 if (i==lowvol_circptr) fprintf(f,"*");
3415 fprintf(f,"%d",lowvol_perperiod[i]);
3419 fprintf(f,"filemon ");
3420 filemon_method_dump_info(f);
3422 dump_input_file(f,c, main_input_file, "main" );
3423 dump_input_file(f,c, flushing_input_file, "flushing");
3424 dump_input_file(f,c, backlog_input_file, "backlog" );
3426 fprintf(f,"conns count=%d\n", conns.count);
3431 fprintf(f,"C%d",conn->fd);
3432 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3433 DUMPV("%d",conn->,stream); DUMPV("\"%s\"",conn->,quitting);
3434 DUMPV("%d",conn->,since_activity);
3437 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3438 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3439 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3441 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3442 for (i=0; i<conn->xmitu; i++) {
3443 const struct iovec *iv= &conn->xmit[i];
3444 const XmitDetails *xd= &conn->xmitd[i];
3447 case xk_Const: dinfo= xasprintf("Const"); break;
3448 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3452 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3453 sanitise(iv->iov_base, iv->iov_len));
3459 DUMPV("%s", , feedfile);
3460 DUMPV("%s", , path_cli);
3461 DUMPV("%s", , path_lock);
3462 DUMPV("%s", , path_flushing);
3463 DUMPV("%s", , path_defer);
3464 DUMPV("%s", , path_dump);
3465 DUMPV("%s", , globpat_backlog);
3468 if (!!ferror(f) + !!fclose(f)) {
3469 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3474 /*========== option parsing ==========*/
3476 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3477 static void vbadusage(const char *fmt, va_list al) {
3478 char *m= xvasprintf(fmt,al);
3479 fprintf(stderr, "bad usage: %s\n"
3480 "say --help for help, or read the manpage\n",
3482 if (interactive < 2)
3483 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3487 /*---------- generic option parser ----------*/
3489 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3490 static void badusage(const char *fmt, ...) {
3497 of_seconds= 001000u,
3498 of_boolean= 002000u,
3501 typedef struct Option Option;
3502 typedef void OptionParser(const Option*, const char *val);
3506 const char *lng, *formarg;
3512 static void parse_options(const Option *options, char ***argvp) {
3513 /* on return *argvp is first non-option arg; argc is not updated */
3516 const char *arg= *++(*argvp);
3518 if (*arg != '-') break;
3519 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3521 while ((a= *++arg)) {
3525 char *equals= strchr(arg,'=');
3526 int len= equals ? (equals - arg) : strlen(arg);
3527 for (o=options; o->shrt || o->lng; o++)
3528 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3530 badusage("unknown long option --%s",arg);
3533 if (equals) badusage("option --%s does not take a value",o->lng);
3535 } else if (equals) {
3539 if (!arg) badusage("option --%s needs a value for %s",
3540 o->lng, o->formarg);
3543 break; /* eaten the whole argument now */
3545 for (o=options; o->shrt || o->lng; o++)
3548 badusage("unknown short option -%c",a);
3555 if (!arg) badusage("option -%c needs a value for %s",
3556 o->shrt, o->formarg);
3559 break; /* eaten the whole argument now */
3565 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3567 static void print_options(const Option *options, FILE *f) {
3569 for (o=options; o->shrt || o->lng; o++) {
3570 char shrt[2] = { o->shrt, 0 };
3571 char *optspec= xasprintf("%s%s%s%s%s",
3572 o->shrt ? "-" : "", shrt,
3573 o->shrt && o->lng ? "|" : "",
3574 DELIMPERHAPS("--", o->lng));
3575 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3580 /*---------- specific option types ----------*/
3582 static void op_integer(const Option *o, const char *val) {
3585 unsigned long ul= strtoul(val,&ep,10);
3586 if (*ep || ep==val || errno || ul>INT_MAX)
3587 badusage("bad integer value for %s",o->lng);
3588 int *store= o->store;
3592 static void op_double(const Option *o, const char *val) {
3593 int *store= o->store;
3596 *store= strtod(val, &ep);
3597 if (*ep || ep==val || errno)
3598 badusage("bad floating point value for %s",o->lng);
3601 static void op_string(const Option *o, const char *val) {
3602 const char **store= o->store;
3606 static void op_seconds(const Option *o, const char *val) {
3607 int *store= o->store;
3611 double v= strtod(val,&ep);
3612 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3614 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3615 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3616 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3617 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3618 else if (!strcmp(ep,"das")) unit= 10;
3619 else if (!strcmp(ep,"hs")) unit= 100;
3620 else if (!strcmp(ep,"ks")) unit= 1000;
3621 else if (!strcmp(ep,"Ms")) unit= 1000000;
3622 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3626 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3630 static void op_setint(const Option *o, const char *val) {
3631 int *store= o->store;
3635 /*---------- specific options ----------*/
3637 static void help(const Option *o, const char *val);
3639 static const Option innduct_options[]= {
3640 {'f',"feedfile", "F", &feedfile, op_string },
3641 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3642 {0,"no-daemon", 0, &interactive, op_setint, 1 },
3643 {0,"interactive", 0, &interactive, op_setint, 2 },
3644 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3645 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3646 {'C',"inndconf", "F", &inndconffile, op_string },
3647 {'P',"port", "PORT", &port, op_integer },
3648 {0,"chdir", "DIR", &path_run, op_string },
3649 {0,"cli", "DIR/|PATH", &path_cli, op_string },
3650 {0,"help", 0, 0, help },
3652 {0,"max-connections", "N", &max_connections, op_integer },
3653 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3654 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3655 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3656 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3658 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3659 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3660 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3662 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3663 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3665 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3666 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3667 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3668 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3669 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3670 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3671 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3672 {0,"low-volume-thresh", "PERIOD", &lowvol_thresh, op_integer },
3673 {0,"low-volume-window", "PERIOD", &lowvol_periods, op_seconds },
3675 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3676 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3681 static void printusage(FILE *f) {
3682 fputs("usage: innduct [options] site [fqdn]\n"
3683 "available options are:\n", f);
3684 print_options(innduct_options, f);
3687 static void help(const Option *o, const char *val) {
3689 if (ferror(stdout) || fflush(stdout)) {
3690 perror("innduct: writing help");
3696 static void convert_to_periods_rndup(int *store) {
3697 *store += period_seconds-1;
3698 *store /= period_seconds;
3701 static int path_ends_slash(const char *specified) {
3702 int l= strlen(specified);
3704 return specified[l-1] == '/';
3707 int main(int argc, char **argv) {
3713 parse_options(innduct_options, &argv);
3718 if (!sitename) badusage("need site name argument");
3720 if (*argv) remote_host= *argv++;
3721 else remote_host= sitename;
3723 if (*argv) badusage("too many non-option arguments");
3727 int r= innconf_read(inndconffile);
3728 if (!r) badusage("could not read inn.conf (more info on stderr)");
3730 if (!remote_host) remote_host= sitename;
3732 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3733 badusage("nocheck threshold percentage must be between 0..100");
3734 nocheck_thresh *= 0.01;
3736 if (nocheck_decay < 0.1)
3737 badusage("nocheck decay articles must be at least 0.1");
3738 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3740 convert_to_periods_rndup(&reconnect_delay_periods);
3741 convert_to_periods_rndup(&flushfail_retry_periods);
3742 convert_to_periods_rndup(&backlog_retry_minperiods);
3743 convert_to_periods_rndup(&backlog_spontrescan_periods);
3744 convert_to_periods_rndup(&spontaneous_flush_periods);
3745 convert_to_periods_rndup(&max_separated_periods);
3746 convert_to_periods_rndup(&need_activity_periods);
3747 convert_to_periods_rndup(&lowvol_periods);
3749 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3750 badusage("bad input data ratio must be between 0..100");
3751 max_bad_data_ratio *= 0.01;
3754 path_run= innconf->pathrun;
3756 if (!feedfile) feedfile= sitename;
3757 if (!feedfile[0]) badusage("feed filename, if specified, must be nonempty");
3758 if (path_ends_slash(feedfile))
3759 feedfile= xasprintf("%s%s", feedfile, sitename);
3760 if (feedfile[0] != '/')
3761 feedfile= xasprintf("%s/%s", innconf->pathoutgoing, feedfile);
3764 path_cli_dir= "innduct";
3765 } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3766 path_cli= 0; /* ok, don't then */
3767 } else if (path_ends_slash(path_cli)) {
3768 path_cli_dir= xasprintf("%.*s", strlen(path_cli)-1, path_cli);
3771 path_cli= xasprintf("%s/%s", path_cli_dir, sitename);
3773 if (max_queue_per_ipf<0)
3774 max_queue_per_ipf= max_queue_per_conn * 2;
3776 const char *feedfile_forbidden= "?*[~#";
3778 while ((c= *feedfile_forbidden++))
3779 if (strchr(feedfile, c))
3780 badusage("feed filename may not contain metacharacter %c",c);
3783 lowvol_perperiod= xcalloc(sizeof(*lowvol_perperiod), lowvol_periods);
3784 for (i=0; i<lowvol_periods; i++) {
3785 lowvol_perperiod[i]= lowvol_thresh;
3786 lowvol_total += lowvol_thresh;
3788 lowvol_total -= lowvol_thresh;
3792 path_lock= xasprintf("%s_lock", feedfile);
3793 path_flushing= xasprintf("%s_flushing", feedfile);
3794 path_defer= xasprintf("%s_defer", feedfile);
3795 path_dump= xasprintf("%s_dump", feedfile);
3796 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3798 oop_source_sys *sysloop= oop_sys_new();
3799 if (!sysloop) sysdie("could not create liboop event loop");
3800 loop= (oop_source*)sysloop;
3804 if (interactive < 1) {
3806 for (i=3; i<255; i++)
3807 /* do this now before we open syslog, etc. */
3811 if (interactive < 2)
3812 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3814 if (interactive < 1) {
3815 int null= open("/dev/null",O_RDWR);
3816 if (null<0) sysfatal("failed to open /dev/null");
3820 xclose(null, "/dev/null original fd",0);
3822 pid_t child1= xfork("daemonise first fork");
3823 if (child1) _exit(0);
3825 pid_t sid= setsid();
3826 if (sid == -1) sysfatal("setsid failed");
3828 pid_t child2= xfork("daemonise second fork");
3829 if (child2) _exit(0);
3833 if (self_pid==-1) sysdie("getpid");
3836 if (r) sysdie("could not chdir to pathrun %s", path_run);
3845 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3846 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3848 if (interactive >= 2)
3855 notice("filemon: suppressed by command line option, polling");
3857 filemon_ok= filemon_method_init();
3859 warn("filemon: no file monitoring available, polling");
3862 every(filepoll_seconds,0,filepoll);
3864 every(period_seconds,1,period);
3870 void *run= oop_sys_run(sysloop);
3871 assert(run == OOP_ERROR);
3872 sysdie("event loop failed");