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.)
29 * don't mind reconnecting if we just disconnected due to idle
30 * some weird disconnection event still investigating
34 * Newsfeeds file entries should look like this:
35 * host.name.of.site[/exclude,exclude,...]\
36 * :pattern,pattern...[/distribution,distribution...]\
40 * sitename[/exclude,exclude,...]\
41 * :pattern,pattern...[/distribution,distribution...]\
47 * or might be blanked out
48 * <spc><spc><spc><spc>....
50 * F site.name main feed file
51 * opened/created, then written, by innd
54 * tokens blanked out by duct when processed
55 * site.name_lock lock preventing multiple ducts
56 * to hold lock must open,F_SETLK[W]
57 * and then stat to check that locked file
58 * still has name site.name_lock
59 * holder of this lock is "duct"
60 * (only) lockholder may remove the lockfile
61 * D site.name_flushing temporary feed file during flush (or crash)
62 * hardlink created by duct
64 * site.name_defer 431'd articles, still being written,
65 * created, written, used by duct
67 * site.name_backlog.<date>.<inum>
68 * 431'd articles, ready for innxmit or duct
69 * created (link/mv) by duct
70 * site.name_backlog<anything-else> (where <anything-else> does not
71 * contain '#' or '~') eg
72 * site.name_backlog.manual
73 * anything the sysadmin likes (eg, feed files
74 * from old feeds to be merged into this one)
75 * created (link/mv) by admin
76 * may be symlinks (in which case links
77 * may be written through, but only links
80 * It is safe to remove backlog files manually,
81 * if it's desired to throw away the backlog.
83 * Backlog files are also processed by innduct. We find the oldest
84 * backlog file which is at least a certain amount old, and feed it
85 * back into our processing. When every article in it has been read
86 * and processed, we unlink it and look for another backlog file.
88 * If we don't have a backlog file that we're reading, we close the
89 * defer file that we're writing and make it into a backlog file at
90 * the first convenient opportunity.
101 | | <----------------<---------------------------------'|
107 | F: innd writing, duct reading |
110 | | duct decides time to flush |
111 | | duct makes hardlink |
113 | V <------------------------'|
115 | F == D: innd writing, duct reading both exist |
118 | | <-----------<-------------<--'|
119 | | open D F ENOENT |
122 | V <---------------------. |
125 | D: innd writing, duct reading; or ENOENT | |
127 | | duct requests flush of feed | |
128 | | (others can too, harmlessly) | |
132 | D: innd flushing, duct; or ENOENT | |
134 | | inndcomm flush fails | |
135 | |`-------------------------->------------------' |
137 | | inndcomm reports no such site |
138 | |`---------------------------------------------------- | -.
140 | | innd finishes writing D, creates F | |
141 | | inndcomm reports flush successful | |
144 | Separated <----------------' |
145 | F: innd writing F!=D /
146 | D: duct reading; or ENOENT both exist /
148 | | duct gets to the end of D /
149 | | duct opens F too /
152 | F: innd writing, duct reading |
153 | D: duct finishing V
155 | | duct finishes processing D F: ENOENT
156 | V duct unlinks D D: duct reading
158 `--<--' | duct finishes
168 "duct reading" means innduct is reading the file but also
169 overwriting processed tokens.
173 * rune for printing diagrams:
175 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
180 /*============================== PROGRAM ==============================*/
182 #define _GNU_SOURCE 1
188 #include "inndcomm.h"
190 #include "inn/list.h"
191 #include "inn/innconf.h"
194 #include <sys/types.h>
195 #include <sys/wait.h>
196 #include <sys/stat.h>
197 #include <sys/socket.h>
216 #include <oop-read.h>
218 /*----- general definitions, probably best not changed -----*/
220 #define CONNCHILD_ESTATUS_STREAM 24
221 #define CONNCHILD_ESTATUS_NOSTREAM 25
223 #define INNDCOMMCHILD_ESTATUS_FAIL 26
224 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
226 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
227 #define MAX_CLI_COMMAND 1000
229 #define VA va_list al; va_start(al,fmt)
230 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
231 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
232 #define NORET __attribute__((__noreturn__))
234 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
235 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
237 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
239 #define FOR_CONN(conn) \
240 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
242 /*----- doubly linked lists -----*/
244 #define ISNODE(T) struct node list_node
247 union { struct list li; T *for_type; } u; \
251 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
253 #define LIST_CHECKCANHAVENODE(l,n) \
254 ((void)((n) == ((l).u.for_type))) /* just for the type check */
256 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
257 ( LIST_CHECKCANHAVENODE(l,n), \
258 list_addsomehow(&(l).u.li, NODE((n))), \
262 #define LIST_REMSOMEHOW(l,list_remsomehow) \
263 ( (typeof((l).u.for_type)) \
266 list_remsomehow(&(l).u.li) ) \
272 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
273 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
274 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
275 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
277 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
278 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
279 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
280 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
282 #define LIST_REMOVE(l,n) \
283 ( LIST_CHECKCANHAVENODE(l,n), \
284 list_remove(NODE((n))), \
288 #define LIST_INSERT(l,n,pred) \
289 ( LIST_CHECKCANHAVENODE(l,n), \
290 LIST_CHECKCANHAVENODE(l,pred), \
291 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
295 /*----- type predeclarations -----*/
297 typedef struct Conn Conn;
298 typedef struct Article Article;
299 typedef struct InputFile InputFile;
300 typedef struct XmitDetails XmitDetails;
301 typedef struct Filemon_Perfile Filemon_Perfile;
302 typedef enum StateMachineState StateMachineState;
303 typedef struct CliCommand CliCommand;
308 /*----- function predeclarations -----*/
310 static void conn_maybe_write(Conn *conn);
311 static void conn_make_some_xmits(Conn *conn);
312 static void *conn_write_some_xmits(Conn *conn);
314 static void xmit_free(XmitDetails *d);
316 #define SMS(newstate, periods, why) \
317 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
318 static void statemc_setstate(StateMachineState newsms, int periods,
319 const char *forlog, const char *why);
321 static void statemc_start_flush(const char *why); /* Normal => Flushing */
322 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
323 static int trigger_flush_ok(const char *why /* 0 means timeout */);
324 /* => Flushing,FLUSHING, ret 1; or ret 0 */
326 static void article_done(Article *art, int whichcount);
328 static void check_assign_articles(void);
329 static void queue_check_input_done(void);
330 static void check_reading_pause_resume(InputFile *ipf);
332 static void statemc_check_flushing_done(void);
333 static void statemc_check_backlog_done(void);
335 static void postfork(void);
336 static void period(void);
338 static void open_defer(void);
339 static void close_defer(void);
340 static void search_backlog_file(void);
341 static void preterminate(void);
342 static void raise_default(int signo) NORET;
343 static char *debug_report_ipf(InputFile *ipf);
345 static void inputfile_reading_start(InputFile *ipf);
346 static void inputfile_reading_stop(InputFile *ipf);
347 static void inputfile_reading_pause(InputFile *ipf);
348 static void inputfile_reading_resume(InputFile *ipf);
349 /* pause and resume are idempotent, and no-op if not done _reading_start */
351 static void filemon_start(InputFile *ipf);
352 static void filemon_stop(InputFile *ipf);
353 static void tailing_make_readable(InputFile *ipf);
355 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
356 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
358 static const oop_rd_style peer_rd_style;
359 static oop_rd_call peer_rd_err, peer_rd_ok;
362 /*----- configuration options -----*/
363 /* when changing defaults, remember to update the manpage */
365 static const char *sitename, *remote_host;
366 static const char *feedfile, *path_run, *path_cli, *path_cli_dir;
367 static int quiet_multiple=0;
368 static int become_daemon=1, try_filemon=1;
369 static int try_stream=1;
371 static const char *inndconffile;
373 static int max_connections=10;
374 static int max_queue_per_conn=200;
375 static int target_max_feedfile_size=100000;
376 static int period_seconds=60;
377 static int filepoll_seconds=5;
378 static int max_queue_per_ipf=-1;
380 static int connection_setup_timeout=200;
381 static int inndcomm_flush_timeout=100;
383 static double nocheck_thresh= 95.0; /* converted from percentage by main */
384 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
386 /* all these are initialised to seconds, and converted to periods in main */
387 static int reconnect_delay_periods=1000;
388 static int flushfail_retry_periods=1000;
389 static int backlog_retry_minperiods=100;
390 static int backlog_spontrescan_periods=300;
391 static int spontaneous_flush_periods=100000;
392 static int max_separated_periods=2000;
393 static int need_activity_periods=1000;
395 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
396 static int max_bad_data_initial= 30;
397 /* in one corrupt 4096-byte block the number of newlines has
398 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
401 /*----- statistics -----*/
403 typedef enum { /* in queue in conn->sent */
404 art_Unchecked, /* not checked, not sent checking */
405 art_Wanted, /* checked, wanted sent body as requested */
406 art_Unsolicited, /* - sent body without check */
410 static const char *const artstate_names[]=
411 { "Unchecked", "Wanted", "Unsolicited", 0 };
413 #define RESULT_COUNTS(RCS,RCN) \
422 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
423 #define RCI_TRIPLE_VALS_BASE(counts,x) \
424 counts[art_Unchecked] x \
425 + counts[art_Wanted] x \
426 + counts[art_Unsolicited] x, \
427 counts[art_Unchecked] x \
428 , counts[art_Wanted] x \
429 , counts[art_Unsolicited] x
432 #define RC_INDEX(x) RC_##x,
433 RESULT_COUNTS(RC_INDEX, RC_INDEX)
438 /*----- transmission buffers -----*/
454 /*----- core operational data structure types -----*/
457 /* This is also an instance of struct oop_readable */
458 struct oop_readable readable; /* first */
459 oop_readable_call *readable_callback;
460 void *readable_callback_user;
463 Filemon_Perfile *filemon;
465 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
467 int skippinglong, paused, fake_readable;
470 long inprogress; /* includes queue.count and also articles in conns */
471 long autodefer; /* -1 means not doing autodefer */
473 int counts[art_MaxState][RCI_max];
474 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
489 #define SMS_LIST(X) \
497 enum StateMachineState {
498 #define SMS_DEF_ENUM(s) sm_##s,
499 SMS_LIST(SMS_DEF_ENUM)
502 static const char *sms_names[]= {
503 #define SMS_DEF_NAME(s) #s ,
504 SMS_LIST(SMS_DEF_NAME)
510 int fd; /* may be 0, meaning closed (during construction/destruction) */
511 oop_read *rd; /* likewise */
512 int max_queue, stream, quitting;
513 int since_activity; /* periods */
514 ArticleList waiting; /* not yet told peer */
515 ArticleList priority; /* peer says send it now */
516 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
517 struct iovec xmit[CONNIOVS];
518 XmitDetails xmitd[CONNIOVS];
523 /*----- general operational variables -----*/
525 /* main initialises */
526 static oop_source *loop;
527 static ConnList conns;
528 static char *path_lock, *path_flushing, *path_defer, *path_dump;
529 static char *globpat_backlog;
530 static pid_t self_pid;
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, ...) {
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 conn_closefd(Conn *conn, const char *msgprefix) {
1068 int r= close_perhaps(&conn->fd);
1069 if (r) info("C%d %serror closing socket: %s",
1070 conn->fd, msgprefix, strerror(errno));
1073 static void conn_dispose(Conn *conn) {
1076 oop_rd_cancel(conn->rd);
1077 oop_rd_delete_kill(conn->rd);
1081 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1082 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1084 conn_closefd(conn,"");
1086 until_connect= reconnect_delay_periods;
1089 static void *conn_exception(oop_source *lp, int fd,
1090 oop_event ev, void *conn_v) {
1093 assert(fd == conn->fd);
1094 assert(ev == OOP_EXCEPTION);
1095 int r= read(conn->fd, &ch, 1);
1096 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1097 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1098 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1099 return OOP_CONTINUE;
1102 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1103 int requeue[art_MaxState];
1104 memset(requeue,0,sizeof(requeue));
1108 while ((art= LIST_REMHEAD(conn->priority)))
1109 LIST_ADDTAIL(art->ipf->queue, art);
1111 while ((art= LIST_REMHEAD(conn->waiting)))
1112 LIST_ADDTAIL(art->ipf->queue, art);
1114 while ((art= LIST_REMHEAD(conn->sent))) {
1115 requeue[art->state]++;
1116 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1117 LIST_ADDTAIL(art->ipf->queue,art);
1118 check_reading_pause_resume(art->ipf);
1123 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1126 LIST_REMOVE(conns,conn);
1128 char *m= xvasprintf(fmt,al);
1129 warn("C%d (now %d) connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1130 conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1134 check_assign_articles();
1137 static void connfail(Conn *conn, const char *fmt, ...) {
1140 vconnfail(conn,fmt,al);
1144 static void check_idle_conns(void) {
1147 conn->since_activity++;
1150 if (conn->since_activity <= need_activity_periods) continue;
1152 /* We need to shut this down */
1154 connfail(conn,"timed out waiting for response to QUIT");
1155 else if (conn->sent.count)
1156 connfail(conn,"timed out waiting for responses");
1157 else if (conn->waiting.count || conn->priority.count)
1158 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1159 else if (conn->xmitu)
1160 connfail(conn,"peer has been sending responses"
1161 " before receiving our commands!");
1163 static const char quitcmd[]= "QUIT\r\n";
1164 int todo= sizeof(quitcmd)-1;
1165 const char *p= quitcmd;
1167 int r= write(conn->fd, p, todo);
1169 if (isewouldblock(errno))
1170 connfail(conn, "blocked writing QUIT to idle connection");
1172 connfail(conn, "failed to write QUIT to idle connection: %s",
1180 conn->since_activity= 0;
1181 debug("C%d is idle, quitting", conn->fd);
1190 /*---------- making new connections ----------*/
1192 static pid_t connecting_child;
1193 static int connecting_fdpass_sock;
1195 static void connect_attempt_discard(void) {
1196 if (connecting_child) {
1197 int status= xwaitpid(&connecting_child, "connect");
1198 if (!(WIFEXITED(status) ||
1199 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1200 report_child_status("connect", status);
1202 if (connecting_fdpass_sock) {
1203 cancel_fd_read_except(connecting_fdpass_sock);
1204 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1208 #define PREP_DECL_MSG_CMSG(msg) \
1210 struct iovec msgiov; \
1211 msgiov.iov_base= &msgbyte; \
1212 msgiov.iov_len= 1; \
1213 struct msghdr msg; \
1214 memset(&msg,0,sizeof(msg)); \
1215 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1216 msg.msg_iov= &msgiov; \
1217 msg.msg_iovlen= 1; \
1218 msg.msg_control= msg##cbuf; \
1219 msg.msg_controllen= sizeof(msg##cbuf);
1221 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1224 assert(fd == connecting_fdpass_sock);
1226 PREP_DECL_MSG_CMSG(msg);
1228 ssize_t rs= recvmsg(fd, &msg, 0);
1230 if (isewouldblock(errno)) return OOP_CONTINUE;
1231 syswarn("failed to read socket from connecting child");
1236 LIST_INIT(conn->waiting);
1237 LIST_INIT(conn->priority);
1238 LIST_INIT(conn->sent);
1240 struct cmsghdr *h= 0;
1241 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1243 int status= xwaitpid(&connecting_child, "connect child (broken)");
1245 if (WIFEXITED(status)) {
1246 if (WEXITSTATUS(status) != 0 &&
1247 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1248 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1249 /* child already reported the problem */;
1251 if (e == OOP_EXCEPTION)
1252 warn("connect: connection child exited code %d but"
1253 " unexpected exception on fdpass socket",
1254 WEXITSTATUS(status));
1256 warn("connect: connection child exited code %d but"
1258 WEXITSTATUS(status), (int)rs);
1260 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1261 warn("connect: connection attempt timed out");
1263 report_child_status("connect", status);
1268 #define CHK(field, val) \
1269 if (h->cmsg_##field != val) { \
1270 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1271 h->cmsg_##field, val); \
1274 CHK(level, SOL_SOCKET);
1275 CHK(type, SCM_RIGHTS);
1276 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1279 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1281 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1284 pid_t got= waitpid(connecting_child, &status, 0);
1285 if (got==-1) sysdie("connect: real wait for child");
1286 assert(got == connecting_child);
1287 connecting_child= 0;
1289 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1290 int es= WEXITSTATUS(status);
1292 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1293 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1295 fatal("connect: child gave unexpected exit status %d", es);
1299 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1301 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1302 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1303 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1304 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1306 &peer_rd_err, conn);
1307 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1309 LIST_ADDHEAD(conns, conn);
1310 notice("C%d (now %d) connected %s",
1311 conn->fd, conns.count, conn->stream ? "streaming" : "plain");
1313 connect_attempt_discard();
1314 check_assign_articles();
1315 return OOP_CONTINUE;
1319 connect_attempt_discard();
1320 return OOP_CONTINUE;
1323 static int allow_connect_start(void) {
1324 return conns.count < max_connections
1325 && !connecting_child
1329 static void connect_start(void) {
1330 assert(!connecting_child);
1331 assert(!connecting_fdpass_sock);
1333 info("starting connection attempt");
1336 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1337 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1339 connecting_child= xfork("connection");
1341 if (!connecting_child) {
1342 FILE *cn_from, *cn_to;
1343 char buf[NNTP_STRLEN+100];
1344 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1346 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1348 alarm(connection_setup_timeout);
1349 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1353 unsigned char c= buf[l-1];
1354 if (!isspace(c)) break;
1355 if (c=='\n' || c=='\r') stripped=1;
1359 sysfatal("connect: connection attempt failed");
1362 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1366 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1367 sysfatal("connect: authentication failed");
1369 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1371 sysfatal("connect: could not send MODE STREAM");
1372 buf[sizeof(buf)-1]= 0;
1373 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1374 if (ferror(cn_from))
1375 sysfatal("connect: could not read response to MODE STREAM");
1377 fatal("connect: connection close in response to MODE STREAM");
1382 fatal("connect: response to MODE STREAM is too long: %.100s...",
1384 l--; if (l>0 && buf[l-1]=='\r') l--;
1387 int rcode= strtoul(buf,&ep,10);
1389 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1393 exitstatus= CONNCHILD_ESTATUS_STREAM;
1399 warn("connect: unexpected response to MODE STREAM: %.50s",
1405 int fd= fileno(cn_from);
1407 PREP_DECL_MSG_CMSG(msg);
1408 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1409 cmsg->cmsg_level= SOL_SOCKET;
1410 cmsg->cmsg_type= SCM_RIGHTS;
1411 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1412 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1414 msg.msg_controllen= cmsg->cmsg_len;
1415 r= sendmsg(socks[1], &msg, 0);
1416 if (r<0) sysdie("sendmsg failed for new connection");
1417 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1422 xclose(socks[1], "connecting fdpass child's socket",0);
1423 connecting_fdpass_sock= socks[0];
1424 xsetnonblock(connecting_fdpass_sock, 1);
1425 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1428 /*---------- assigning articles to conns, and transmitting ----------*/
1430 static Article *dequeue_from(int peek, InputFile *ipf) {
1432 if (peek) return LIST_HEAD(ipf->queue);
1434 Article *art= LIST_REMHEAD(ipf->queue);
1436 check_reading_pause_resume(ipf);
1440 static Article *dequeue(int peek) {
1442 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1443 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1444 art= dequeue_from(peek, main_input_file); if (art) return art;
1448 static void check_assign_articles(void) {
1454 int spare=0, inqueue=0;
1456 /* Find a connection to offer this article. We prefer a busy
1457 * connection to an idle one, provided it's not full. We take the
1458 * first (oldest) and since that's stable, it will mean we fill up
1459 * connections in order. That way if we have too many
1460 * connections, the spare ones will go away eventually.
1463 if (walk->quitting) continue;
1464 inqueue= walk->sent.count + walk->priority.count
1465 + walk->waiting.count;
1466 spare= walk->max_queue - inqueue;
1467 assert(inqueue <= max_queue_per_conn);
1469 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1470 else if (spare>0) /*working*/ { use= walk; break; }
1473 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1475 Article *art= dequeue(0);
1477 LIST_ADDTAIL(use->waiting, art);
1480 conn_maybe_write(use);
1481 } else if (allow_connect_start()) {
1482 until_connect= reconnect_delay_periods;
1491 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1492 conn_maybe_write(u);
1493 return OOP_CONTINUE;
1496 static void conn_maybe_write(Conn *conn) {
1498 conn_make_some_xmits(conn);
1500 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1504 void *rp= conn_write_some_xmits(conn);
1505 if (rp==OOP_CONTINUE) {
1506 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1508 } else if (rp==OOP_HALT) {
1511 /* transmitted everything */
1518 /*---------- expiry, flow control and deferral ----------*/
1521 * flow control notes
1522 * to ensure articles go away eventually
1523 * separate queue for each input file
1525 * every period, check head of backlog queue for expiry with SMretrieve
1526 * if too old: discard, and check next article
1527 * also check every backlog article as we read it
1529 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1530 * one-off: eat queued articles from flushing and write them to defer
1531 * one-off: connfail all connections which have any articles from flushing
1532 * newly read articles from flushing go straight to defer
1533 * this should take care of it and get us out of this state
1534 * to avoid filling up ram needlessly
1536 * limit number of queued articles for each ipf
1537 * pause/resume inputfile tailing
1540 static void check_reading_pause_resume(InputFile *ipf) {
1541 if (ipf->queue.count >= max_queue_per_ipf)
1542 inputfile_reading_pause(ipf);
1544 inputfile_reading_resume(ipf);
1547 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1549 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1551 sysfatal("write to defer file %s",path_defer);
1552 article_done(art, whichcount);
1555 static int article_check_expired(Article *art /* must be queued, not conn */) {
1556 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1557 if (artdata) { SMfreearticle(artdata); return 0; }
1559 LIST_REMOVE(art->ipf->queue, art);
1561 art->ipf->count_nooffer_missing++;
1562 article_done(art,-1);
1566 static void inputfile_queue_check_expired(InputFile *ipf) {
1570 Article *art= LIST_HEAD(ipf->queue);
1571 int exp= article_check_expired(art);
1574 check_reading_pause_resume(ipf);
1577 static void article_autodefer(InputFile *ipf, Article *art) {
1579 article_defer(art,-1);
1582 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1584 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1585 if (art->ipf == ipf) return 1;
1589 static void autodefer_input_file_articles(InputFile *ipf) {
1591 while ((art= LIST_REMHEAD(ipf->queue)))
1592 article_autodefer(ipf, art);
1595 static void autodefer_input_file(InputFile *ipf) {
1598 autodefer_input_file_articles(ipf);
1600 if (ipf->inprogress) {
1603 if (has_article_in(&walk->waiting, ipf) ||
1604 has_article_in(&walk->priority, ipf) ||
1605 has_article_in(&walk->sent, ipf))
1608 while (ipf->inprogress) {
1610 if (walk->quitting < 0) goto found;
1611 abort(); /* where are they ?? */
1614 connfail(walk, "connection is stuck or crawling,"
1615 " and we need to finish flush");
1616 autodefer_input_file_articles(ipf);
1620 check_reading_pause_resume(ipf);
1623 /*========== article transmission ==========*/
1625 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1626 XmitKind kind) { /* caller must then fill in details */
1627 struct iovec *v= &conn->xmit[conn->xmitu];
1628 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1629 v->iov_base= (char*)data;
1635 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1636 xmit_core(conn,data,len, xk_Const);
1638 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1640 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1641 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1645 static void xmit_free(XmitDetails *d) {
1647 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1648 case xk_Const: break;
1653 static void *conn_write_some_xmits(Conn *conn) {
1655 * 0: nothing more to write, no need to call us again
1656 * OOP_CONTINUE: more to write but fd not writeable
1657 * OOP_HALT: disaster, have destroyed conn
1660 int count= conn->xmitu;
1661 if (!count) return 0;
1663 if (count > IOV_MAX) count= IOV_MAX;
1664 ssize_t rs= writev(conn->fd, conn->xmit, count);
1666 if (isewouldblock(errno)) return OOP_CONTINUE;
1667 connfail(conn, "write failed: %s", strerror(errno));
1673 for (done=0; rs; ) {
1674 assert(done<conn->xmitu);
1675 struct iovec *vp= &conn->xmit[done];
1676 XmitDetails *dp= &conn->xmitd[done];
1677 if (rs >= vp->iov_len) {
1679 xmit_free(dp); /* vp->iov_len -= vp->iov_len, etc. */
1682 vp->iov_base= (char*)vp->iov_base + rs;
1684 break; /* rs -= rs */
1687 int newu= conn->xmitu - done;
1688 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1689 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1694 static void conn_make_some_xmits(Conn *conn) {
1696 if (conn->xmitu+5 > CONNIOVS)
1699 Article *art= LIST_REMHEAD(conn->priority);
1700 if (!art) art= LIST_REMHEAD(conn->waiting);
1703 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1704 /* actually send it */
1706 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1709 art->state == art_Unchecked ? art_Unsolicited :
1710 art->state == art_Wanted ? art_Wanted :
1713 if (!artdata) art->missing= 1;
1714 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1718 XMIT_LITERAL("TAKETHIS ");
1719 xmit_noalloc(conn, art->messageid, art->midlen);
1720 XMIT_LITERAL("\r\n");
1721 xmit_artbody(conn, artdata);
1723 article_done(art, -1);
1727 /* we got 235 from IHAVE */
1729 xmit_artbody(conn, artdata);
1731 XMIT_LITERAL(".\r\n");
1735 LIST_ADDTAIL(conn->sent, art);
1741 XMIT_LITERAL("CHECK ");
1743 XMIT_LITERAL("IHAVE ");
1744 xmit_noalloc(conn, art->messageid, art->midlen);
1745 XMIT_LITERAL("\r\n");
1747 assert(art->state == art_Unchecked);
1748 art->ipf->counts[art->state][RC_sent]++;
1749 LIST_ADDTAIL(conn->sent, art);
1754 /*========== handling responses from peer ==========*/
1756 static const oop_rd_style peer_rd_style= {
1757 OOP_RD_DELIM_STRIP, '\n',
1759 OOP_RD_SHORTREC_FORBID
1762 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1763 const char *errmsg, int errnoval,
1764 const char *data, size_t recsz, void *conn_v) {
1766 connfail(conn, "error receiving from peer: %s", errmsg);
1767 return OOP_CONTINUE;
1770 static Article *article_reply_check(Conn *conn, const char *response,
1771 int code_indicates_streaming,
1773 /* 1:yes, -1:no, 0:dontcare */,
1774 const char *sanitised_response) {
1775 Article *art= LIST_HEAD(conn->sent);
1779 "peer gave unexpected response when no commands outstanding: %s",
1780 sanitised_response);
1784 if (code_indicates_streaming) {
1785 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1786 if (!conn->stream) {
1787 connfail(conn, "peer gave streaming response code "
1788 " to IHAVE or subsequent body: %s", sanitised_response);
1791 const char *got_mid= response+4;
1792 int got_midlen= strcspn(got_mid, " \n\r");
1793 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1794 connfail(conn, "peer gave streaming response with syntactically invalid"
1795 " messageid: %s", sanitised_response);
1798 if (got_midlen != art->midlen ||
1799 memcmp(got_mid, art->messageid, got_midlen)) {
1800 connfail(conn, "peer gave streaming response code to wrong article -"
1801 " probable synchronisation problem; we offered: %s;"
1803 art->messageid, sanitised_response);
1808 connfail(conn, "peer gave non-streaming response code to"
1809 " CHECK/TAKETHIS: %s", sanitised_response);
1814 if (must_have_sent>0 && art->state < art_Wanted) {
1815 connfail(conn, "peer says article accepted but"
1816 " we had not sent the body: %s", sanitised_response);
1819 if (must_have_sent<0 && art->state >= art_Wanted) {
1820 connfail(conn, "peer says please sent the article but we just did: %s",
1821 sanitised_response);
1825 Article *art_again= LIST_REMHEAD(conn->sent);
1826 assert(art_again == art);
1830 static void update_nocheck(int accepted) {
1831 accept_proportion *= nocheck_decay;
1832 accept_proportion += accepted * (1.0 - nocheck_decay);
1833 int new_nocheck= accept_proportion >= nocheck_thresh;
1834 if (new_nocheck && !nocheck_reported) {
1835 notice("entering nocheck mode for the first time");
1836 nocheck_reported= 1;
1837 } else if (new_nocheck != nocheck) {
1838 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1840 nocheck= new_nocheck;
1843 static void article_done(Article *art, int whichcount) {
1844 if (whichcount>=0 && !art->missing)
1845 art->ipf->counts[art->state][whichcount]++;
1847 if (whichcount == RC_accepted) update_nocheck(1);
1848 else if (whichcount == RC_unwanted) update_nocheck(0);
1850 InputFile *ipf= art->ipf;
1852 while (art->blanklen) {
1853 static const char spaces[]=
1863 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1864 int r= pwrite(ipf->fd, spaces, w, art->offset);
1866 if (errno==EINTR) continue;
1867 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1868 art->messageid, art->blanklen,
1869 (unsigned long)art->offset, ipf->path);
1871 assert(r>=0 && r<=w);
1877 assert(ipf->inprogress >= 0);
1880 if (!ipf->inprogress && ipf != main_input_file)
1881 queue_check_input_done();
1884 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1885 const char *errmsg, int errnoval,
1886 const char *data, size_t recsz, void *conn_v) {
1889 if (ev == OOP_RD_EOF) {
1890 connfail(conn, "unexpected EOF from peer");
1891 return OOP_CONTINUE;
1893 assert(ev == OOP_RD_OK);
1895 char *sani= sanitise(data,-1);
1898 unsigned long code= strtoul(data, &ep, 10);
1899 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1900 connfail(conn, "badly formatted response from peer: %s", sani);
1901 return OOP_CONTINUE;
1905 conn->waiting.count ||
1906 conn->priority.count ||
1910 if (conn->quitting) {
1911 if (code!=205 && code!=503) {
1912 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1914 LIST_REMOVE(conns,conn);
1915 notice("C%d (now %d) idle connection closed by us",
1916 conn->fd, conns.count);
1920 return OOP_CONTINUE;
1923 conn->since_activity= 0;
1926 #define GET_ARTICLE(musthavesent) do{ \
1927 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1928 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1931 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1932 code_streaming= (streaming); \
1933 GET_ARTICLE(musthavesent); \
1934 article_done(art, RC_##how); \
1938 #define PEERBADMSG(m) do { \
1939 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1942 int code_streaming= 0;
1946 default: PEERBADMSG("peer sent unexpected message");
1950 PEERBADMSG("peer timed us out or stopped accepting articles");
1952 LIST_REMOVE(conns,conn);
1953 notice("C%d (now %d) idle connection closed by peer",
1954 conns.count, conn->fd);
1956 return OOP_CONTINUE;
1958 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1959 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1961 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1962 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1964 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1965 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1967 case 238: /* CHECK says send it */
1969 case 335: /* IHAVE says send it */
1971 assert(art->state == art_Unchecked);
1972 art->ipf->counts[art->state][RC_accepted]++;
1973 art->state= art_Wanted;
1974 LIST_ADDTAIL(conn->priority, art);
1977 case 431: /* CHECK or TAKETHIS says try later */
1979 case 436: /* IHAVE says try later */
1981 article_defer(art, RC_deferred);
1987 conn_maybe_write(conn);
1988 check_assign_articles();
1989 return OOP_CONTINUE;
1993 /*========== monitoring of input files ==========*/
1995 static void feedfile_eof(InputFile *ipf) {
1996 assert(ipf != main_input_file); /* promised by tailing_try_read */
1997 inputfile_reading_stop(ipf);
1999 if (ipf == flushing_input_file) {
2000 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2001 if (main_input_file) inputfile_reading_start(main_input_file);
2002 statemc_check_flushing_done();
2003 } else if (ipf == backlog_input_file) {
2004 statemc_check_backlog_done();
2006 abort(); /* supposed to wait rather than get EOF on main input file */
2010 static InputFile *open_input_file(const char *path) {
2011 int fd= open(path, O_RDWR);
2013 if (errno==ENOENT) return 0;
2014 sysfatal("unable to open input file %s", path);
2018 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2019 memset(ipf,0,sizeof(*ipf));
2023 LIST_INIT(ipf->queue);
2024 strcpy(ipf->path, path);
2029 static void close_input_file(InputFile *ipf) { /* does not free */
2030 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2031 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2032 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2033 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2034 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2038 /*---------- dealing with articles read in the input file ----------*/
2040 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2041 const char *data, const char *how) {
2042 warn("corrupted file: %s, offset %lu: %s: in %s",
2043 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2044 ipf->readcount_err++;
2045 if (ipf->readcount_err > max_bad_data_initial +
2046 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2047 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2048 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2049 return OOP_CONTINUE;
2052 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2053 oop_rd_event ev, const char *errmsg,
2054 int errnoval, const char *data, size_t recsz,
2056 InputFile *ipf= ipf_v;
2057 assert(ev == OOP_RD_SYSTEM);
2059 sysdie("error reading input file: %s, offset %lu",
2060 ipf->path, (unsigned long)ipf->offset);
2063 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2064 oop_rd_event ev, const char *errmsg,
2065 int errnoval, const char *data, size_t recsz,
2067 InputFile *ipf= ipf_v;
2069 char tokentextbuf[sizeof(TOKEN)*2+3];
2071 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2073 off_t old_offset= ipf->offset;
2074 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2076 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2078 if (ev==OOP_RD_PARTREC)
2079 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2080 /* but process it anyway */
2082 if (ipf->skippinglong) {
2083 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2084 return OOP_CONTINUE;
2086 if (ev==OOP_RD_LONG) {
2087 ipf->skippinglong= 1;
2088 X_BAD_DATA("overly long line");
2091 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2092 if (!recsz) X_BAD_DATA("empty line");
2095 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2096 ipf->readcount_blank++;
2097 return OOP_CONTINUE;
2100 char *space= strchr(data,' ');
2101 int tokenlen= space-data;
2102 int midlen= (int)recsz-tokenlen-1;
2103 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2104 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2106 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2107 memcpy(tokentextbuf, data, tokenlen);
2108 tokentextbuf[tokenlen]= 0;
2109 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2111 ipf->readcount_ok++;
2113 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2114 memset(art,0,sizeof(*art));
2115 art->state= art_Unchecked;
2116 art->midlen= midlen;
2117 art->ipf= ipf; ipf->inprogress++;
2118 art->token= TextToToken(tokentextbuf);
2119 art->offset= old_offset;
2120 art->blanklen= recsz;
2121 strcpy(art->messageid, space+1);
2122 LIST_ADDTAIL(ipf->queue, art);
2124 if (ipf->autodefer >= 0)
2125 article_autodefer(ipf, art);
2126 else if (ipf==backlog_input_file)
2127 article_check_expired(art);
2129 if (sms==sm_NORMAL && ipf==main_input_file &&
2130 ipf->offset >= target_max_feedfile_size)
2131 statemc_start_flush("feed file size");
2133 check_assign_articles(); /* may destroy conn but that's OK */
2134 check_reading_pause_resume(ipf);
2135 return OOP_CONTINUE;
2138 /*========== tailing input file ==========*/
2140 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2142 /* lifetime of ipf here is OK because destruction will cause
2143 * on_cancel which will cancel this callback */
2144 InputFile *ipf= user;
2146 if (!ipf->fake_readable) return OOP_CONTINUE;
2148 /* we just keep calling readable until our caller (oop_rd)
2149 * has called try_read, and try_read has found EOF so given EAGAIN */
2150 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2152 return ipf->readable_callback(loop, &ipf->readable,
2153 ipf->readable_callback_user);
2156 static void tailing_on_cancel(struct oop_readable *rable) {
2157 InputFile *ipf= (void*)rable;
2159 if (ipf->filemon) filemon_stop(ipf);
2160 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2161 ipf->readable_callback= 0;
2164 static void tailing_make_readable(InputFile *ipf) {
2165 if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2167 ipf->fake_readable= 1;
2168 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2171 static int tailing_on_readable(struct oop_readable *rable,
2172 oop_readable_call *cb, void *user) {
2173 InputFile *ipf= (void*)rable;
2175 tailing_on_cancel(rable);
2176 ipf->readable_callback= cb;
2177 ipf->readable_callback_user= user;
2179 tailing_make_readable(ipf);
2183 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2185 InputFile *ipf= (void*)rable;
2187 ssize_t r= read(ipf->fd, buffer, length);
2189 if (errno==EINTR) continue;
2190 ipf->fake_readable= 0;
2194 if (ipf==main_input_file) {
2196 ipf->fake_readable= 0;
2198 } else if (ipf==flushing_input_file) {
2200 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2201 } else if (ipf==backlog_input_file) {
2211 /*---------- filemon implemented with inotify ----------*/
2213 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2214 #define HAVE_FILEMON
2216 #include <sys/inotify.h>
2218 static int filemon_inotify_fd;
2219 static int filemon_inotify_wdmax;
2220 static InputFile **filemon_inotify_wd2ipf;
2222 struct Filemon_Perfile {
2226 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2227 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2228 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2230 if (wd >= filemon_inotify_wdmax) {
2232 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2233 sizeof(*filemon_inotify_wd2ipf) * newmax);
2234 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2235 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2236 filemon_inotify_wdmax= newmax;
2239 assert(!filemon_inotify_wd2ipf[wd]);
2240 filemon_inotify_wd2ipf[wd]= ipf;
2242 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2243 ipf, wd, filemon_inotify_wdmax);
2248 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2250 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2251 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2252 if (r) sysdie("inotify_rm_watch");
2253 filemon_inotify_wd2ipf[wd]= 0;
2256 static void *filemon_inotify_readable(oop_source *lp, int fd,
2257 oop_event e, void *u) {
2258 struct inotify_event iev;
2260 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2262 if (isewouldblock(errno)) break;
2263 sysdie("read from inotify master");
2264 } else if (r==sizeof(iev)) {
2265 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2267 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2269 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2270 /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2271 tailing_make_readable(ipf);
2273 return OOP_CONTINUE;
2276 static int filemon_method_init(void) {
2277 filemon_inotify_fd= inotify_init();
2278 if (filemon_inotify_fd<0) {
2279 syswarn("filemon/inotify: inotify_init failed");
2282 xsetnonblock(filemon_inotify_fd, 1);
2283 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2285 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2289 static void filemon_method_dump_info(FILE *f) {
2291 fprintf(f,"inotify");
2292 DUMPV("%d",,filemon_inotify_fd);
2293 DUMPV("%d",,filemon_inotify_wdmax);
2294 for (i=0; i<filemon_inotify_wdmax; i++)
2295 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2298 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2300 /*---------- filemon dummy implementation ----------*/
2302 #if !defined(HAVE_FILEMON)
2304 struct Filemon_Perfile { int dummy; };
2306 static int filemon_method_init(void) {
2307 warn("filemon/dummy: no filemon method compiled in");
2310 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2311 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2312 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2314 #endif /* !HAVE_FILEMON */
2316 /*---------- filemon generic interface ----------*/
2318 static void filemon_start(InputFile *ipf) {
2319 assert(!ipf->filemon);
2322 filemon_method_startfile(ipf, ipf->filemon);
2325 static void filemon_stop(InputFile *ipf) {
2326 if (!ipf->filemon) return;
2327 filemon_method_stopfile(ipf, ipf->filemon);
2332 /*---------- interface to start and stop an input file ----------*/
2334 static const oop_rd_style feedfile_rdstyle= {
2335 OOP_RD_DELIM_STRIP, '\n',
2337 OOP_RD_SHORTREC_LONG,
2340 static void inputfile_reading_resume(InputFile *ipf) {
2341 if (!ipf->rd) return;
2342 if (!ipf->paused) return;
2344 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2345 feedfile_got_article,ipf, feedfile_read_err, ipf);
2346 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2351 static void inputfile_reading_pause(InputFile *ipf) {
2352 if (!ipf->rd) return;
2353 if (ipf->paused) return;
2354 oop_rd_cancel(ipf->rd);
2358 static void inputfile_reading_start(InputFile *ipf) {
2360 ipf->readable.on_readable= tailing_on_readable;
2361 ipf->readable.on_cancel= tailing_on_cancel;
2362 ipf->readable.try_read= tailing_try_read;
2363 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2364 ipf->readable.delete_kill= 0;
2366 ipf->readable_callback= 0;
2367 ipf->readable_callback_user= 0;
2369 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2373 inputfile_reading_resume(ipf);
2376 static void inputfile_reading_stop(InputFile *ipf) {
2378 inputfile_reading_pause(ipf);
2379 oop_rd_delete(ipf->rd);
2381 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2385 /*========== interaction with innd - state machine ==========*/
2387 /* See official state diagram at top of file. We implement
2398 |`---------------------------------------------------.
2400 |`---------------- - - - |
2401 D ENOENT | D EXISTS see OVERALL STATES diagram |
2402 | for full startup logic |
2405 | ============ try to |
2411 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2412 ^ | hardlink F to D |
2415 | | our handle onto F is now onto D |
2418 | |<-------------------<---------------------<---------+
2420 | | spawn inndcomm flush |
2422 | ================== |
2423 | FLUSHING[-ABSENT] |
2425 | main D tail/none |
2426 | ================== |
2428 | | INNDCOMM FLUSH FAILS ^
2429 | |`----------------------->----------. |
2431 | | NO SUCH SITE V |
2432 ^ |`--------------->----. ==================== |
2433 | | \ FLUSHFAILED[-ABSENT] |
2435 | | FLUSH OK \ main D tail/none |
2436 | | open F \ ==================== |
2438 | | \ | TIME TO RETRY |
2439 | |`------->----. ,---<---'\ `----------------'
2440 | | D NONE | | D NONE `----.
2442 | ============= V V ============
2443 | SEPARATED-1 | | DROPPING-1
2444 | flsh->rd!=0 | | flsh->rd!=0
2445 | [Separated] | | [Dropping]
2446 | main F idle | | main none
2447 | flsh D tail | | flsh D tail
2448 | ============= | | ============
2450 ^ | EOF ON D | | defer | EOF ON D
2452 | =============== | | ===============
2453 | SEPARATED-2 | | DROPPING-2
2454 | flsh->rd==0 | V flsh->rd==0
2455 | [Finishing] | | [Dropping]
2456 | main F tail | `. main none
2457 | flsh D closed | `. flsh D closed
2458 | =============== V `. ===============
2460 | | ALL D PROCESSED `. | ALL D PROCESSED
2461 | V install defer as backlog `. | install defer
2462 ^ | close D `. | close D
2463 | | unlink D `. | unlink D
2466 `----------' ==============
2486 static void startup_set_input_file(InputFile *f) {
2487 assert(!main_input_file);
2489 inputfile_reading_start(f);
2492 static void statemc_lock(void) {
2494 struct stat stab, stabf;
2497 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2498 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2501 memset(&fl,0,sizeof(fl));
2503 fl.l_whence= SEEK_SET;
2504 int r= fcntl(lockfd, F_SETLK, &fl);
2506 if (errno==EACCES || isewouldblock(errno)) {
2507 if (quiet_multiple) exit(0);
2508 fatal("another duct holds the lockfile");
2510 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2513 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2515 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2517 if (!lock_noent && samefile(&stab, &stabf))
2520 xclose(lockfd, "stale lockfile ", path_lock);
2523 FILE *lockfile= fdopen(lockfd, "w");
2524 if (!lockfile) sysdie("fdopen lockfile");
2526 int r= ftruncate(lockfd, 0);
2527 if (r) sysdie("truncate lockfile to write new info");
2529 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2530 (unsigned long)self_pid,
2531 sitename, feedfile, remote_host) == EOF ||
2533 sysfatal("write info to lockfile %s", path_lock);
2535 debug("startup: locked");
2538 static void statemc_init(void) {
2539 struct stat stabdefer;
2541 search_backlog_file();
2544 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2546 debug("startup: ductdefer ENOENT");
2548 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2549 switch (stabdefer.st_nlink==1) {
2551 open_defer(); /* so that we will later close it and rename it */
2554 xunlink(path_defer, "stale defer file link"
2555 " (presumably hardlink to backlog file)");
2558 die("defer file %s has unexpected link count %d",
2559 path_defer, stabdefer.st_nlink);
2563 struct stat stab_f, stab_d;
2566 InputFile *file_d= open_input_file(path_flushing);
2567 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2569 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2571 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2572 debug("startup: F==D => Hardlinked");
2573 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2578 debug("startup: F ENOENT => Moved");
2579 if (file_d) startup_set_input_file(file_d);
2580 spawn_inndcomm_flush("feedfile missing at startup");
2581 /* => Flushing, sms:=FLUSHING */
2584 debug("startup: F!=D => Separated");
2585 startup_set_input_file(file_d);
2586 flushing_input_file= main_input_file;
2587 main_input_file= open_input_file(feedfile);
2588 if (!main_input_file) die("feedfile vanished during startup");
2589 SMS(SEPARATED, max_separated_periods,
2590 "found both old and current feed files");
2592 debug("startup: F exists, D ENOENT => Normal");
2593 InputFile *file_f= open_input_file(feedfile);
2594 if (!file_f) die("feed file vanished during startup");
2595 startup_set_input_file(file_f);
2596 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2601 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2602 assert(sms == sm_NORMAL);
2604 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2606 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2607 (unsigned long)target_max_feedfile_size,
2610 int r= link(feedfile, path_flushing);
2611 if (r) sysfatal("link feedfile %s to flushing file %s",
2612 feedfile, path_flushing);
2615 xunlink(feedfile, "old feedfile link");
2618 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2621 static int trigger_flush_ok(const char *why) {
2625 statemc_start_flush(why ? why : "periodic");
2626 return 1; /* Normal => Flushing; => FLUSHING */
2628 case sm_FLUSHFAILED:
2629 spawn_inndcomm_flush(why ? why : "retry");
2630 return 1; /* Moved => Flushing; => FLUSHING */
2634 warn("abandoning old feedfile after flush (%s), autodeferring",
2635 why ? why : "took too long to complete");
2636 assert(flushing_input_file);
2637 autodefer_input_file(flushing_input_file);
2645 static void statemc_period_poll(void) {
2646 if (!until_flush) return;
2648 assert(until_flush>=0);
2650 if (until_flush) return;
2651 int ok= trigger_flush_ok(0);
2655 static int inputfile_is_done(InputFile *ipf) {
2657 if (ipf->inprogress) return 0; /* new article in the meantime */
2658 if (ipf->rd) return 0; /* not had EOF */
2662 static void notice_processed(InputFile *ipf, int completed,
2663 const char *what, const char *spec) {
2664 if (!ipf) return; /* allows preterminate to be lazy */
2666 #define RCI_NOTHING(x) /* nothing */
2667 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2668 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2670 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2672 char *inprog= completed
2673 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2674 : xasprintf(" inprogress=%ld", ipf->inprogress);
2675 char *autodefer= ipf->autodefer >= 0
2676 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2677 : xasprintf("%s","");
2679 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2680 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2681 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2683 completed?"completed":"processed", what, spec,
2684 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2685 inprog, autodefer, ipf->count_nooffer_missing,
2686 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2687 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2688 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2689 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2690 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2699 static void statemc_check_backlog_done(void) {
2700 InputFile *ipf= backlog_input_file;
2701 if (!inputfile_is_done(ipf)) return;
2703 const char *slash= strrchr(ipf->path, '/');
2704 const char *leaf= slash ? slash+1 : ipf->path;
2705 const char *under= strchr(slash, '_');
2706 const char *rest= under ? under+1 : leaf;
2707 if (!strncmp(rest,"backlog",7)) rest += 7;
2708 notice_processed(ipf,1,"backlog ",rest);
2710 close_input_file(ipf);
2711 if (unlink(ipf->path)) {
2712 if (errno != ENOENT)
2713 sysdie("could not unlink processed backlog file %s", ipf->path);
2714 warn("backlog file %s vanished while we were reading it"
2715 " so we couldn't remove it (but it's done now, anyway)",
2719 backlog_input_file= 0;
2720 search_backlog_file();
2724 static void statemc_check_flushing_done(void) {
2725 InputFile *ipf= flushing_input_file;
2726 if (!inputfile_is_done(ipf)) return;
2728 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2730 notice_processed(ipf,1,"feedfile","");
2734 xunlink(path_flushing, "old flushing file");
2736 close_input_file(flushing_input_file);
2737 free(flushing_input_file);
2738 flushing_input_file= 0;
2740 if (sms==sm_SEPARATED) {
2741 notice("flush complete");
2742 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2743 } else if (sms==sm_DROPPING) {
2744 SMS(DROPPED, max_separated_periods, "old flush complete");
2745 search_backlog_file();
2746 notice("feed dropped, but will continue until backlog is finished");
2750 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2752 assert(!inputfile_is_done(main_input_file));
2753 statemc_check_flushing_done();
2754 statemc_check_backlog_done();
2755 return OOP_CONTINUE;
2758 static void queue_check_input_done(void) {
2759 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2762 static void statemc_setstate(StateMachineState newsms, int periods,
2763 const char *forlog, const char *why) {
2765 until_flush= periods;
2767 const char *xtra= "";
2770 case sm_FLUSHFAILED:
2771 if (!main_input_file) xtra= "-ABSENT";
2775 xtra= flushing_input_file->rd ? "-1" : "-2";
2781 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2783 info("state %s%s %s",forlog,xtra,why);
2787 /*---------- defer and backlog files ----------*/
2789 static void open_defer(void) {
2794 defer= fopen(path_defer, "a+");
2795 if (!defer) sysfatal("could not open defer file %s", path_defer);
2797 /* truncate away any half-written records */
2799 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2801 if (stab.st_size > LONG_MAX)
2802 die("defer file %s size is far too large", path_defer);
2807 long orgsize= stab.st_size;
2808 long truncto= stab.st_size;
2810 if (!truncto) break; /* was only (if anything) one half-truncated record */
2811 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2812 sysdie("seek in defer file %s while truncating partial", path_defer);
2817 sysdie("failed read from defer file %s", path_defer);
2819 die("defer file %s shrank while we were checking it!", path_defer);
2825 if (stab.st_size != truncto) {
2826 warn("truncating half-record at end of defer file %s -"
2827 " shrinking by %ld bytes from %ld to %ld",
2828 path_defer, orgsize - truncto, orgsize, truncto);
2831 sysfatal("could not flush defer file %s", path_defer);
2832 if (ftruncate(fileno(defer), truncto))
2833 sysdie("could not truncate defer file %s", path_defer);
2836 info("continuing existing defer file %s (%ld bytes)",
2837 path_defer, orgsize);
2839 if (fseek(defer, truncto, SEEK_SET))
2840 sysdie("could not seek to new end of defer file %s", path_defer);
2843 static void close_defer(void) {
2848 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2850 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2853 time_t now= xtime();
2855 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2857 (unsigned long)stab.st_ino);
2858 if (link(path_defer, backlog))
2859 sysfatal("could not install defer file %s as backlog file %s",
2860 path_defer, backlog);
2861 if (unlink(path_defer))
2862 sysdie("could not unlink old defer link %s to backlog file %s",
2863 path_defer, backlog);
2867 if (until_backlog_nextscan < 0 ||
2868 until_backlog_nextscan > backlog_retry_minperiods + 1)
2869 until_backlog_nextscan= backlog_retry_minperiods + 1;
2872 static void poll_backlog_file(void) {
2873 if (until_backlog_nextscan < 0) return;
2874 if (until_backlog_nextscan-- > 0) return;
2875 search_backlog_file();
2878 static void search_backlog_file(void) {
2879 /* returns non-0 iff there are any backlog files */
2884 const char *oldest_path=0;
2885 time_t oldest_mtime=0, now;
2887 if (backlog_input_file) return;
2891 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2895 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2897 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2899 for (i=0; i<gl.gl_pathc; i++) {
2900 const char *path= gl.gl_pathv[i];
2902 if (strchr(path,'#') || strchr(path,'~')) {
2903 debug("backlog file search skipping %s", path);
2906 r= stat(path, &stab);
2908 syswarn("failed to stat backlog file %s", path);
2911 if (!S_ISREG(stab.st_mode)) {
2912 warn("backlog file %s is not a plain file (or link to one)", path);
2915 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2917 oldest_mtime= stab.st_mtime;
2920 case GLOB_NOMATCH: /* fall through */
2923 sysdie("glob expansion of backlog pattern %s gave unexpected"
2924 " nonzero (error?) return value %d", globpat_backlog, r);
2928 debug("backlog scan: none");
2930 if (sms==sm_DROPPED) {
2932 notice("feed dropped and our work is complete");
2934 int r= unlink(path_cli);
2935 if (r && errno!=ENOENT)
2936 syswarn("failed to unlink cli socket for old feed");
2938 xunlink(path_lock, "lockfile for old feed");
2941 until_backlog_nextscan= backlog_spontrescan_periods;
2946 double age= difftime(now, oldest_mtime);
2947 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2949 if (age_deficiency <= 0) {
2950 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2951 age, age_deficiency, oldest_path);
2953 backlog_input_file= open_input_file(oldest_path);
2954 if (!backlog_input_file) {
2955 warn("backlog file %s vanished as we opened it", oldest_path);
2959 inputfile_reading_start(backlog_input_file);
2960 until_backlog_nextscan= -1;
2964 until_backlog_nextscan= age_deficiency / period_seconds;
2966 if (backlog_spontrescan_periods >= 0 &&
2967 until_backlog_nextscan > backlog_spontrescan_periods)
2968 until_backlog_nextscan= backlog_spontrescan_periods;
2970 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2971 age, age_deficiency, until_backlog_nextscan, oldest_path);
2978 /*---------- shutdown and signal handling ----------*/
2980 static void preterminate(void) {
2981 if (in_child) return;
2982 notice_processed(main_input_file,0,"feedfile","");
2983 notice_processed(flushing_input_file,0,"flushing","");
2984 if (backlog_input_file)
2985 notice_processed(backlog_input_file,0, "backlog file ",
2986 backlog_input_file->path);
2989 static int signal_self_pipe[2];
2990 static sig_atomic_t terminate_sig_flag;
2992 static void raise_default(int signo) {
2993 xsigsetdefault(signo);
2998 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
2999 assert(fd=signal_self_pipe[0]);
3001 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3002 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
3003 if (r==0) die("eof on signal self pipe");
3004 if (terminate_sig_flag) {
3006 notice("terminating (%s)", strsignal(terminate_sig_flag));
3007 raise_default(terminate_sig_flag);
3009 return OOP_CONTINUE;
3012 static void sigarrived_handler(int signum) {
3017 if (!terminate_sig_flag) terminate_sig_flag= signum;
3022 write(signal_self_pipe[1],&x,1);
3025 static void init_signals(void) {
3026 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3027 sysdie("could not ignore SIGPIPE");
3029 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3031 xsetnonblock(signal_self_pipe[0],1);
3032 xsetnonblock(signal_self_pipe[1],1);
3034 struct sigaction sa;
3035 memset(&sa,0,sizeof(sa));
3036 sa.sa_handler= sigarrived_handler;
3037 sa.sa_flags= SA_RESTART;
3038 xsigaction(SIGTERM,&sa);
3039 xsigaction(SIGINT,&sa);
3041 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3044 /*========== flushing the feed ==========*/
3046 static pid_t inndcomm_child;
3047 static int inndcomm_sentinel_fd;
3049 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3050 assert(inndcomm_child);
3051 assert(fd == inndcomm_sentinel_fd);
3052 int status= xwaitpid(&inndcomm_child, "inndcomm");
3055 cancel_fd_read_except(fd);
3056 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3057 inndcomm_sentinel_fd= 0;
3059 assert(!flushing_input_file);
3061 if (WIFEXITED(status)) {
3062 switch (WEXITSTATUS(status)) {
3064 case INNDCOMMCHILD_ESTATUS_FAIL:
3067 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3068 notice("feed has been dropped by innd, finishing up");
3069 flushing_input_file= main_input_file;
3070 tailing_make_readable(flushing_input_file);
3071 /* we probably previously returned EAGAIN from our fake read method
3072 * when in fact we were at EOF, so signal another readable event
3073 * so we actually see the EOF */
3077 if (flushing_input_file) {
3078 SMS(DROPPING, max_separated_periods,
3079 "feed dropped by innd, but must finish last flush");
3082 SMS(DROPPED, 0, "feed dropped by innd");
3083 search_backlog_file();
3085 return OOP_CONTINUE;
3089 flushing_input_file= main_input_file;
3090 tailing_make_readable(flushing_input_file);
3092 main_input_file= open_input_file(feedfile);
3093 if (!main_input_file)
3094 die("flush succeeded but feedfile %s does not exist!"
3095 " (this probably means feedfile does not correspond"
3096 " to site %s in newsfeeds)", feedfile, sitename);
3098 if (flushing_input_file) {
3099 SMS(SEPARATED, max_separated_periods, "flush complete");
3102 SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3104 return OOP_CONTINUE;
3107 goto unexpected_exitstatus;
3110 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3111 warn("flush timed out trying to talk to innd");
3114 unexpected_exitstatus:
3115 report_child_status("inndcomm child", status);
3119 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3120 return OOP_CONTINUE;
3123 static void inndcommfail(const char *what) {
3124 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3125 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3128 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3131 notice("flushing %s",why);
3133 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3134 assert(!inndcomm_child);
3135 assert(!inndcomm_sentinel_fd);
3137 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3139 inndcomm_child= xfork("inndcomm child");
3141 if (!inndcomm_child) {
3142 const char *flushargv[2]= { sitename, 0 };
3146 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3147 /* parent spots the autoclose of pipefds[1] when we die or exit */
3149 if (simulate_flush>=0) {
3150 warn("SIMULATING flush child status %d", simulate_flush);
3151 if (simulate_flush>128) raise(simulate_flush-128);
3152 else exit(simulate_flush);
3155 alarm(inndcomm_flush_timeout);
3156 r= ICCopen(); if (r) inndcommfail("connect");
3157 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3158 if (!r) exit(0); /* yay! */
3160 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3161 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3162 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3167 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3168 inndcomm_sentinel_fd= pipefds[0];
3169 assert(inndcomm_sentinel_fd);
3170 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3172 SMS(FLUSHING, 0, why);
3175 /*========== main program ==========*/
3177 static void postfork_inputfile(InputFile *ipf) {
3179 xclose(ipf->fd, "(in child) input file ", ipf->path);
3182 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3183 /* we have no stdio streams that are buffered long-term */
3185 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3188 static void postfork(void) {
3191 xsigsetdefault(SIGTERM);
3192 xsigsetdefault(SIGINT);
3193 xsigsetdefault(SIGPIPE);
3194 if (terminate_sig_flag) raise(terminate_sig_flag);
3196 postfork_inputfile(main_input_file);
3197 postfork_inputfile(flushing_input_file);
3201 conn_closefd(conn,"(in child) ");
3203 postfork_stdio(defer, "defer file ", path_defer);
3206 typedef struct Every Every;
3208 struct timeval interval;
3213 static void every_schedule(Every *e, struct timeval base);
3215 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3218 if (!e->fixed_rate) xgettimeofday(&base);
3219 every_schedule(e, base);
3220 return OOP_CONTINUE;
3223 static void every_schedule(Every *e, struct timeval base) {
3224 struct timeval when;
3225 timeradd(&base, &e->interval, &when);
3226 loop->on_time(loop, when, every_happens, e);
3229 static void every(int interval, int fixed_rate, void (*f)(void)) {
3230 NEW_DECL(Every *,e);
3231 e->interval.tv_sec= interval;
3232 e->interval.tv_usec= 0;
3233 e->fixed_rate= fixed_rate;
3236 xgettimeofday(&now);
3237 every_schedule(e, now);
3240 static void filepoll(void) {
3241 tailing_make_readable(main_input_file);
3242 tailing_make_readable(flushing_input_file);
3245 static char *debug_report_ipf(InputFile *ipf) {
3246 if (!ipf) return xasprintf("none");
3248 const char *slash= strrchr(ipf->path,'/');
3249 const char *path= slash ? slash+1 : ipf->path;
3251 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3253 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3254 (long)ipf->offset, ipf->fd,
3255 ipf->rd ? "" : ",!rd",
3256 ipf->skippinglong ? "*skiplong" : "",
3257 ipf->rd && ipf->paused ? "*paused" : "");
3260 static void period(void) {
3261 char *dipf_main= debug_report_ipf(main_input_file);
3262 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3263 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3266 " sms=%s[%d] conns=%d until_connect=%d"
3267 " input_files main:%s flushing:%s backlog:%s[%d]"
3268 " children connecting=%ld inndcomm=%ld"
3270 sms_names[sms], until_flush, conns.count, until_connect,
3271 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3272 (long)connecting_child, (long)inndcomm_child
3276 free(dipf_flushing);
3279 if (until_connect) until_connect--;
3281 inputfile_queue_check_expired(backlog_input_file);
3282 poll_backlog_file();
3283 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3284 statemc_period_poll();
3285 check_assign_articles();
3290 /*========== dumping state ==========*/
3292 static void dump_article_list(FILE *f, const CliCommand *c,
3293 const ArticleList *al) {
3294 fprintf(f, " count=%d\n", al->count);
3295 if (!c->xval) return;
3297 int i; Article *art;
3298 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3299 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3300 DUMPV("%p", art->,ipf);
3301 DUMPV("%d", art->,missing);
3302 DUMPV("%lu", (unsigned long)art->,offset);
3303 DUMPV("%d", art->,blanklen);
3304 DUMPV("%d", art->,midlen);
3305 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3309 static void dump_input_file(FILE *f, const CliCommand *c,
3310 InputFile *ipf, const char *wh) {
3311 char *dipf= debug_report_ipf(ipf);
3312 fprintf(f,"input %s %s", wh, dipf);
3316 DUMPV("%d", ipf->,readcount_ok);
3317 DUMPV("%d", ipf->,readcount_blank);
3318 DUMPV("%d", ipf->,readcount_err);
3319 DUMPV("%d", ipf->,count_nooffer_missing);
3323 ArtState state; const char *const *statename;
3324 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3325 #define RC_DUMP_FMT(x) " " #x "=%d"
3326 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3327 fprintf(f,"input %s counts %-11s"
3328 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3330 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3332 fprintf(f,"input %s queue", wh);
3333 dump_article_list(f,c,&ipf->queue);
3339 fprintf(cc->out, "dumping state to %s\n", path_dump);
3340 FILE *f= fopen(path_dump, "w");
3341 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3343 fprintf(f,"general");
3344 DUMPV("%s", sms_names,[sms]);
3345 DUMPV("%d", ,until_flush);
3346 DUMPV("%ld", (long),self_pid);
3347 DUMPV("%p", , defer);
3348 DUMPV("%d", , until_connect);
3349 DUMPV("%d", , until_backlog_nextscan);
3350 DUMPV("%d", , simulate_flush);
3351 fprintf(f,"\nnocheck");
3352 DUMPV("%#.10f", , accept_proportion);
3353 DUMPV("%d", , nocheck);
3354 DUMPV("%d", , nocheck_reported);
3357 fprintf(f,"special");
3358 DUMPV("%ld", (long),connecting_child);
3359 DUMPV("%d", , connecting_fdpass_sock);
3360 DUMPV("%d", , cli_master);
3363 fprintf(f,"filemon ");
3364 filemon_method_dump_info(f);
3366 dump_input_file(f,c, main_input_file, "main" );
3367 dump_input_file(f,c, flushing_input_file, "flushing");
3368 dump_input_file(f,c, backlog_input_file, "backlog" );
3370 fprintf(f,"conns count=%d\n", conns.count);
3375 fprintf(f,"C%d",conn->fd);
3376 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3377 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3378 DUMPV("%d",conn->,since_activity);
3381 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3382 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3383 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3385 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3386 for (i=0; i<conn->xmitu; i++) {
3387 const struct iovec *iv= &conn->xmit[i];
3388 const XmitDetails *xd= &conn->xmitd[i];
3391 case xk_Const: dinfo= xasprintf("Const"); break;
3392 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3396 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3397 sanitise(iv->iov_base, iv->iov_len));
3403 DUMPV("%s", , feedfile);
3404 DUMPV("%s", , path_cli);
3405 DUMPV("%s", , path_lock);
3406 DUMPV("%s", , path_flushing);
3407 DUMPV("%s", , path_defer);
3408 DUMPV("%s", , path_dump);
3409 DUMPV("%s", , globpat_backlog);
3412 if (!!ferror(f) + !!fclose(f)) {
3413 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3418 /*========== option parsing ==========*/
3420 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3421 static void vbadusage(const char *fmt, va_list al) {
3422 char *m= xvasprintf(fmt,al);
3423 fprintf(stderr, "bad usage: %s\n"
3424 "say --help for help, or read the manpage\n",
3427 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3431 /*---------- generic option parser ----------*/
3433 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3434 static void badusage(const char *fmt, ...) {
3441 of_seconds= 001000u,
3442 of_boolean= 002000u,
3445 typedef struct Option Option;
3446 typedef void OptionParser(const Option*, const char *val);
3450 const char *lng, *formarg;
3456 static void parse_options(const Option *options, char ***argvp) {
3457 /* on return *argvp is first non-option arg; argc is not updated */
3460 const char *arg= *++(*argvp);
3462 if (*arg != '-') break;
3463 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3465 while ((a= *++arg)) {
3469 char *equals= strchr(arg,'=');
3470 int len= equals ? (equals - arg) : strlen(arg);
3471 for (o=options; o->shrt || o->lng; o++)
3472 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3474 badusage("unknown long option --%s",arg);
3477 if (equals) badusage("option --%s does not take a value",o->lng);
3479 } else if (equals) {
3483 if (!arg) badusage("option --%s needs a value for %s",
3484 o->lng, o->formarg);
3487 break; /* eaten the whole argument now */
3489 for (o=options; o->shrt || o->lng; o++)
3492 badusage("unknown short option -%c",a);
3499 if (!arg) badusage("option -%c needs a value for %s",
3500 o->shrt, o->formarg);
3503 break; /* eaten the whole argument now */
3509 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3511 static void print_options(const Option *options, FILE *f) {
3513 for (o=options; o->shrt || o->lng; o++) {
3514 char shrt[2] = { o->shrt, 0 };
3515 char *optspec= xasprintf("%s%s%s%s%s",
3516 o->shrt ? "-" : "", shrt,
3517 o->shrt && o->lng ? "|" : "",
3518 DELIMPERHAPS("--", o->lng));
3519 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3524 /*---------- specific option types ----------*/
3526 static void op_integer(const Option *o, const char *val) {
3529 unsigned long ul= strtoul(val,&ep,10);
3530 if (*ep || ep==val || errno || ul>INT_MAX)
3531 badusage("bad integer value for %s",o->lng);
3532 int *store= o->store;
3536 static void op_double(const Option *o, const char *val) {
3537 int *store= o->store;
3540 *store= strtod(val, &ep);
3541 if (*ep || ep==val || errno)
3542 badusage("bad floating point value for %s",o->lng);
3545 static void op_string(const Option *o, const char *val) {
3546 const char **store= o->store;
3550 static void op_seconds(const Option *o, const char *val) {
3551 int *store= o->store;
3555 double v= strtod(val,&ep);
3556 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3558 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3559 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3560 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3561 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3562 else if (!strcmp(ep,"das")) unit= 10;
3563 else if (!strcmp(ep,"hs")) unit= 100;
3564 else if (!strcmp(ep,"ks")) unit= 1000;
3565 else if (!strcmp(ep,"Ms")) unit= 1000000;
3566 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3570 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3574 static void op_setint(const Option *o, const char *val) {
3575 int *store= o->store;
3579 /*---------- specific options ----------*/
3581 static void help(const Option *o, const char *val);
3583 static const Option innduct_options[]= {
3584 {'f',"feedfile", "F", &feedfile, op_string },
3585 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3586 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3587 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3588 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3589 {'C',"inndconf", "F", &inndconffile, op_string },
3590 {'P',"port", "PORT", &port, op_integer },
3591 {0,"chdir", "DIR", &path_run, op_string },
3592 {0,"cli", "DIR/|PATH", &path_cli, op_string },
3593 {0,"help", 0, 0, help },
3595 {0,"max-connections", "N", &max_connections, op_integer },
3596 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3597 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3598 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3599 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3601 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3602 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3603 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3605 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3606 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3608 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3609 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3610 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3611 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3612 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3613 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3614 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3616 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3617 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3622 static void printusage(FILE *f) {
3623 fputs("usage: innduct [options] site [fqdn]\n"
3624 "available options are:\n", f);
3625 print_options(innduct_options, f);
3628 static void help(const Option *o, const char *val) {
3630 if (ferror(stdout) || fflush(stdout)) {
3631 perror("innduct: writing help");
3637 static void convert_to_periods_rndup(int *store) {
3638 *store += period_seconds-1;
3639 *store /= period_seconds;
3642 static int path_ends_slash(const char *specified) {
3643 int l= strlen(specified);
3645 return specified[l-1] == '/';
3648 int main(int argc, char **argv) {
3654 parse_options(innduct_options, &argv);
3659 if (!sitename) badusage("need site name argument");
3661 if (*argv) remote_host= *argv++;
3662 else remote_host= sitename;
3664 if (*argv) badusage("too many non-option arguments");
3668 int r= innconf_read(inndconffile);
3669 if (!r) badusage("could not read inn.conf (more info on stderr)");
3671 if (!remote_host) remote_host= sitename;
3673 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3674 badusage("nocheck threshold percentage must be between 0..100");
3675 nocheck_thresh *= 0.01;
3677 if (nocheck_decay < 0.1)
3678 badusage("nocheck decay articles must be at least 0.1");
3679 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3681 convert_to_periods_rndup(&reconnect_delay_periods);
3682 convert_to_periods_rndup(&flushfail_retry_periods);
3683 convert_to_periods_rndup(&backlog_retry_minperiods);
3684 convert_to_periods_rndup(&backlog_spontrescan_periods);
3685 convert_to_periods_rndup(&spontaneous_flush_periods);
3686 convert_to_periods_rndup(&max_separated_periods);
3687 convert_to_periods_rndup(&need_activity_periods);
3689 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3690 badusage("bad input data ratio must be between 0..100");
3691 max_bad_data_ratio *= 0.01;
3694 path_run= innconf->pathrun;
3696 if (!feedfile) feedfile= sitename;
3697 if (!feedfile[0]) badusage("feed filename, if specified, must be nonempty");
3698 if (path_ends_slash(feedfile))
3699 feedfile= xasprintf("%s%s", feedfile, sitename);
3700 if (feedfile[0] != '/')
3701 feedfile= xasprintf("%s/%s", innconf->pathoutgoing, feedfile);
3704 path_cli_dir= "innduct";
3705 } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3706 path_cli= 0; /* ok, don't then */
3707 } else if (path_ends_slash(path_cli)) {
3708 path_cli_dir= xasprintf("%.*s", strlen(path_cli)-1, path_cli);
3711 path_cli= xasprintf("%s/%s", path_cli_dir, sitename);
3713 if (max_queue_per_ipf<0)
3714 max_queue_per_ipf= max_queue_per_conn * 2;
3716 const char *feedfile_forbidden= "?*[~#";
3718 while ((c= *feedfile_forbidden++))
3719 if (strchr(feedfile, c))
3720 badusage("feed filename may not contain metacharacter %c",c);
3724 path_lock= xasprintf("%s_lock", feedfile);
3725 path_flushing= xasprintf("%s_flushing", feedfile);
3726 path_defer= xasprintf("%s_defer", feedfile);
3727 path_dump= xasprintf("%s_dump", feedfile);
3728 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3730 oop_source_sys *sysloop= oop_sys_new();
3731 if (!sysloop) sysdie("could not create liboop event loop");
3732 loop= (oop_source*)sysloop;
3736 if (become_daemon) {
3738 for (i=3; i<255; i++)
3739 /* do this now before we open syslog, etc. */
3741 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3743 int null= open("/dev/null",O_RDWR);
3744 if (null<0) sysfatal("failed to open /dev/null");
3748 xclose(null, "/dev/null original fd",0);
3750 pid_t child1= xfork("daemonise first fork");
3751 if (child1) _exit(0);
3753 pid_t sid= setsid();
3754 if (sid == -1) sysfatal("setsid failed");
3756 pid_t child2= xfork("daemonise second fork");
3757 if (child2) _exit(0);
3761 if (self_pid==-1) sysdie("getpid");
3764 if (r) sysdie("could not chdir to pathrun %s", path_run);
3773 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3774 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3783 notice("filemon: suppressed by command line option, polling");
3785 filemon_ok= filemon_method_init();
3787 warn("filemon: no file monitoring available, polling");
3790 every(filepoll_seconds,0,filepoll);
3792 every(period_seconds,1,period);
3798 void *run= oop_sys_run(sysloop);
3799 assert(run == OOP_ERROR);
3800 sysdie("event loop failed");