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.)
28 * specify perms of /tmp/innduct.control
33 * build-lfs/backends/innduct --connection-timeout=30 --no-daemon -C ../inn.conf -f `pwd`/fee sit localhost
37 * Newsfeeds file entries should look like this:
38 * host.name.of.site[/exclude,exclude,...]\
39 * :pattern,pattern...[/distribution,distribution...]\
43 * sitename[/exclude,exclude,...]\
44 * :pattern,pattern...[/distribution,distribution...]\
50 * or might be blanked out
51 * <spc><spc><spc><spc>....
53 * F site.name main feed file
54 * opened/created, then written, by innd
57 * tokens blanked out by duct when processed
58 * site.name_lock lock preventing multiple ducts
59 * to hold lock must open,F_SETLK[W]
60 * and then stat to check that locked file
61 * still has name site.name_lock
62 * holder of this lock is "duct"
63 * (only) lockholder may remove the lockfile
64 * D site.name_flushing temporary feed file during flush (or crash)
65 * hardlink created by duct
67 * site.name_defer 431'd articles, still being written,
68 * created, written, used by duct
70 * site.name_backlog.<date>.<inum>
71 * 431'd articles, ready for innxmit or duct
72 * created (link/mv) by duct
73 * site.name_backlog<anything-else> (where <anything-else> does not
74 * contain '#' or '~') eg
75 * site.name_backlog.manual
76 * anything the sysadmin likes (eg, feed files
77 * from old feeds to be merged into this one)
78 * created (link/mv) by admin
79 * may be symlinks (in which case links
80 * may be written through, but only links
83 * It is safe to remove backlog files manually,
84 * if it's desired to throw away the backlog.
86 * Backlog files are also processed by innduct. We find the oldest
87 * backlog file which is at least a certain amount old, and feed it
88 * back into our processing. When every article in it has been read
89 * and processed, we unlink it and look for another backlog file.
91 * If we don't have a backlog file that we're reading, we close the
92 * defer file that we're writing and make it into a backlog file at
93 * the first convenient opportunity.
104 | | <----------------<---------------------------------'|
110 | F: innd writing, duct reading |
113 | | duct decides time to flush |
114 | | duct makes hardlink |
116 | V <------------------------'|
118 | F == D: innd writing, duct reading both exist |
121 | | <-----------<-------------<--'|
122 | | open D F ENOENT |
125 | V <---------------------. |
128 | D: innd writing, duct reading; or ENOENT | |
130 | | duct requests flush of feed | |
131 | | (others can too, harmlessly) | |
135 | D: innd flushing, duct; or ENOENT | |
137 | | inndcomm flush fails | |
138 | |`-------------------------->------------------' |
140 | | inndcomm reports no such site |
141 | |`---------------------------------------------------- | -.
143 | | innd finishes writing D, creates F | |
144 | | inndcomm reports flush successful | |
147 | Separated <----------------' |
148 | F: innd writing F!=D /
149 | D: duct reading; or ENOENT both exist /
151 | | duct gets to the end of D /
152 | | duct opens F too /
155 | F: innd writing, duct reading |
156 | D: duct finishing V
158 | | duct finishes processing D F: ENOENT
159 | V duct unlinks D D: duct reading
161 `--<--' | duct finishes
171 "duct reading" means innduct is reading the file but also
172 overwriting processed tokens.
176 * rune for printing diagrams:
178 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
183 /*============================== PROGRAM ==============================*/
185 #define _GNU_SOURCE 1
191 #include "inndcomm.h"
193 #include "inn/list.h"
194 #include "inn/innconf.h"
197 #include <sys/types.h>
198 #include <sys/wait.h>
199 #include <sys/stat.h>
200 #include <sys/socket.h>
219 #include <oop-read.h>
221 /*----- general definitions, probably best not changed -----*/
223 #define CONNCHILD_ESTATUS_STREAM 24
224 #define CONNCHILD_ESTATUS_NOSTREAM 25
226 #define INNDCOMMCHILD_ESTATUS_FAIL 26
227 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
229 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
230 #define MAX_CONTROL_COMMAND 1000
232 #define VA va_list al; va_start(al,fmt)
233 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
234 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
235 #define NORET __attribute__((__noreturn__))
237 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
238 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
240 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
242 #define FOR_CONN(conn) \
243 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
245 /*----- doubly linked lists -----*/
247 #define ISNODE(T) struct node list_node
250 union { struct list li; T *for_type; } u; \
254 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
256 #define LIST_CHECKCANHAVENODE(l,n) \
257 ((void)((n) == ((l).u.for_type))) /* just for the type check */
259 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
260 ( LIST_CHECKCANHAVENODE(l,n), \
261 list_addsomehow(&(l).u.li, NODE((n))), \
265 #define LIST_REMSOMEHOW(l,list_remsomehow) \
266 ( (typeof((l).u.for_type)) \
269 list_remsomehow(&(l).u.li) ) \
275 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
276 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
277 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
278 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
280 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
281 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
282 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
283 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
285 #define LIST_REMOVE(l,n) \
286 ( LIST_CHECKCANHAVENODE(l,n), \
287 list_remove(NODE((n))), \
291 #define LIST_INSERT(l,n,pred) \
292 ( LIST_CHECKCANHAVENODE(l,n), \
293 LIST_CHECKCANHAVENODE(l,pred), \
294 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
298 /*----- type predeclarations -----*/
300 typedef struct Conn Conn;
301 typedef struct Article Article;
302 typedef struct InputFile InputFile;
303 typedef struct XmitDetails XmitDetails;
304 typedef struct Filemon_Perfile Filemon_Perfile;
305 typedef enum StateMachineState StateMachineState;
306 typedef struct ControlCommand ControlCommand;
311 /*----- function predeclarations -----*/
313 static void conn_maybe_write(Conn *conn);
314 static void conn_make_some_xmits(Conn *conn);
315 static void *conn_write_some_xmits(Conn *conn);
317 static void xmit_free(XmitDetails *d);
319 #define SMS(newstate, periods, why) \
320 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
321 static void statemc_setstate(StateMachineState newsms, int periods,
322 const char *forlog, const char *why);
324 static void statemc_start_flush(const char *why); /* Normal => Flushing */
325 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
326 static int trigger_flush_ok(const char *why /* 0 means timeout */);
327 /* => Flushing,FLUSHING, ret 1; or ret 0 */
329 static void article_done(Article *art, int whichcount);
331 static void check_assign_articles(void);
332 static void queue_check_input_done(void);
333 static void check_reading_pause_resume(InputFile *ipf);
335 static void statemc_check_flushing_done(void);
336 static void statemc_check_backlog_done(void);
338 static void postfork(void);
339 static void period(void);
341 static void open_defer(void);
342 static void close_defer(void);
343 static void search_backlog_file(void);
344 static void preterminate(void);
345 static void raise_default(int signo) NORET;
346 static char *debug_report_ipf(InputFile *ipf);
348 static void inputfile_reading_start(InputFile *ipf);
349 static void inputfile_reading_stop(InputFile *ipf);
350 static void inputfile_reading_pause(InputFile *ipf);
351 static void inputfile_reading_resume(InputFile *ipf);
352 /* pause and resume are idempotent, and no-op if not done _reading_start */
354 static void filemon_start(InputFile *ipf);
355 static void filemon_stop(InputFile *ipf);
356 static void filemon_callback(InputFile *ipf);
358 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
359 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
361 static const oop_rd_style peer_rd_style;
362 static oop_rd_call peer_rd_err, peer_rd_ok;
364 /*----- configuration options -----*/
365 /* when changing defaults, remember to update the manpage */
367 static const char *sitename, *remote_host;
368 static const char *feedfile, *realsockdir="/tmp/innduct.control";
369 static int quiet_multiple=0;
370 static int become_daemon=1, try_filemon=1;
371 static int try_stream=1;
373 static const char *inndconffile;
375 static int max_connections=10;
376 static int max_queue_per_conn=200;
377 static int target_max_feedfile_size=100000;
378 static int period_seconds=60;
379 static int filepoll_seconds=5;
380 static int max_queue_per_ipf=-1;
382 static int connection_setup_timeout=200;
383 static int inndcomm_flush_timeout=100;
385 static double nocheck_thresh= 95.0; /* converted from percentage by main */
386 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
388 /* all these are initialised to seconds, and converted to periods in main */
389 static int reconnect_delay_periods=1000;
390 static int flushfail_retry_periods=1000;
391 static int backlog_retry_minperiods=50;
392 static int backlog_spontrescan_periods=300;
393 static int spontaneous_flush_periods=100000;
394 static int max_separated_periods=2000;
395 static int need_activity_periods=1000;
397 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
398 static int max_bad_data_initial= 30;
399 /* in one corrupt 4096-byte block the number of newlines has
400 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
403 /*----- statistics -----*/
405 typedef enum { /* in queue in conn->sent */
406 art_Unchecked, /* not checked, not sent checking */
407 art_Wanted, /* checked, wanted sent body as requested */
408 art_Unsolicited, /* - sent body without check */
412 static const char *const artstate_names[]=
413 { "Unchecked", "Wanted", "Unsolicited", 0 };
415 #define RESULT_COUNTS(RCS,RCN) \
424 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
425 #define RCI_TRIPLE_VALS_BASE(counts,x) \
426 counts[art_Unchecked] x \
427 + counts[art_Wanted] x \
428 + counts[art_Unsolicited] x, \
429 counts[art_Unchecked] x \
430 , counts[art_Wanted] x \
431 , counts[art_Unsolicited] x
434 #define RC_INDEX(x) RC_##x,
435 RESULT_COUNTS(RC_INDEX, RC_INDEX)
440 /*----- transmission buffers -----*/
456 /*----- core operational data structure types -----*/
459 /* This is also an instance of struct oop_readable */
460 struct oop_readable readable; /* first */
461 oop_readable_call *readable_callback;
462 void *readable_callback_user;
465 Filemon_Perfile *filemon;
467 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
469 int skippinglong, paused;
472 long inprogress; /* includes queue.count and also articles in conns */
473 long autodefer; /* -1 means not doing autodefer */
475 int counts[art_MaxState][RCI_max];
476 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
491 #define SMS_LIST(X) \
499 enum StateMachineState {
500 #define SMS_DEF_ENUM(s) sm_##s,
501 SMS_LIST(SMS_DEF_ENUM)
504 static const char *sms_names[]= {
505 #define SMS_DEF_NAME(s) #s ,
506 SMS_LIST(SMS_DEF_NAME)
512 int fd; /* may be 0, meaning closed (during construction/destruction) */
513 oop_read *rd; /* likewise */
514 int max_queue, stream, quitting;
515 int since_activity; /* periods */
516 ArticleList waiting; /* not yet told peer */
517 ArticleList priority; /* peer says send it now */
518 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
519 struct iovec xmit[CONNIOVS];
520 XmitDetails xmitd[CONNIOVS];
525 /*----- general operational variables -----*/
527 /* main initialises */
528 static oop_source *loop;
529 static ConnList conns;
530 static char *path_lock, *path_flushing, *path_defer;
531 static char *path_control, *path_dump;
532 static char *globpat_backlog;
533 static pid_t self_pid;
535 /* statemc_init initialises */
536 static StateMachineState sms;
537 static int until_flush;
538 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
541 /* initialisation to 0 is good */
542 static int until_connect, until_backlog_nextscan;
543 static double accept_proportion;
544 static int nocheck, nocheck_reported, in_child;
546 /* for simulation, debugging, etc. */
547 int simulate_flush= -1;
549 /*========== logging ==========*/
551 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
552 static void logcore(int sysloglevel, const char *fmt, ...) {
555 vsyslog(sysloglevel,fmt,al);
557 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
558 vfprintf(stderr,fmt,al);
564 static void logv(int sysloglevel, const char *pfx, int errnoval,
565 const char *fmt, va_list al) PRINTF(5,0);
566 static void logv(int sysloglevel, const char *pfx, int errnoval,
567 const char *fmt, va_list al) {
568 char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
569 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
570 msgbuf[sizeof(msgbuf)-1]= 0;
572 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
573 sysloglevel= LOG_ERR; /* run by wrong user, probably */
575 logcore(sysloglevel, "<%s>%s: %s%s%s",
576 sitename, pfx, msgbuf,
577 errnoval>=0 ? ": " : "",
578 errnoval>=0 ? strerror(errnoval) : "");
581 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
582 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
583 static void fn(const char *fmt, ...) { \
586 logv(sysloglevel, pfx, err, fmt, al); \
590 #define logwrap(fn, pfx, sysloglevel, err) \
591 static void fn(const char *fmt, ...) PRINTF(1,2); \
592 static void fn(const char *fmt, ...) { \
594 logv(sysloglevel, pfx, err, fmt, al); \
598 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
599 diewrap(die, " critical", LOG_CRIT, -1, 16);
601 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
602 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
604 logwrap(syswarn, " warning", LOG_WARNING, errno);
605 logwrap(warn, " warning", LOG_WARNING, -1);
607 logwrap(notice, " notice", LOG_NOTICE, -1);
608 logwrap(info, " info", LOG_INFO, -1);
609 logwrap(debug, " debug", LOG_DEBUG, -1);
612 /*========== utility functions etc. ==========*/
614 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
615 static char *xvasprintf(const char *fmt, va_list al) {
617 int rc= vasprintf(&str,fmt,al);
618 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
621 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
622 static char *xasprintf(const char *fmt, ...) {
624 char *str= xvasprintf(fmt,al);
629 static int close_perhaps(int *fd) {
630 if (*fd <= 0) return 0;
635 static void xclose(int fd, const char *what, const char *what2) {
637 if (r) sysdie("close %s%s",what,what2?what2:"");
639 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
640 if (*fd <= 0) return;
641 xclose(*fd,what,what2);
645 static pid_t xfork(const char *what) {
649 if (child==-1) sysfatal("cannot fork for %s",what);
650 debug("forked %s %ld", what, (unsigned long)child);
651 if (!child) postfork();
655 static void on_fd_read_except(int fd, oop_call_fd callback) {
656 loop->on_fd(loop, fd, OOP_READ, callback, 0);
657 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
659 static void cancel_fd_read_except(int fd) {
660 loop->cancel_fd(loop, fd, OOP_READ);
661 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
664 static void report_child_status(const char *what, int status) {
665 if (WIFEXITED(status)) {
666 int es= WEXITSTATUS(status);
668 warn("%s: child died with error exit status %d", what, es);
669 } else if (WIFSIGNALED(status)) {
670 int sig= WTERMSIG(status);
671 const char *sigstr= strsignal(sig);
672 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
674 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
676 warn("%s: child died due to unknown fatal signal %d%s",
677 what, sig, coredump);
679 warn("%s: child died with unknown wait status %d", what,status);
683 static int xwaitpid(pid_t *pid, const char *what) {
686 int r= kill(*pid, SIGKILL);
687 if (r) sysdie("cannot kill %s child", what);
689 pid_t got= waitpid(*pid, &status, 0);
690 if (got==-1) sysdie("cannot reap %s child", what);
691 if (got==0) die("cannot reap %s child", what);
698 static void *zxmalloc(size_t sz) {
699 void *p= xmalloc(sz);
704 static void xunlink(const char *path, const char *what) {
706 if (r) sysdie("can't unlink %s %s", path, what);
709 static time_t xtime(void) {
711 if (now==-1) sysdie("time(2) failed");
715 static void xsigaction(int signo, const struct sigaction *sa) {
716 int r= sigaction(signo,sa,0);
717 if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
720 static void xsigsetdefault(int signo) {
722 memset(&sa,0,sizeof(sa));
723 sa.sa_handler= SIG_DFL;
724 xsigaction(signo,&sa);
727 static void xgettimeofday(struct timeval *tv_r) {
728 int r= gettimeofday(tv_r,0);
729 if (r) sysdie("gettimeofday(2) failed");
732 static void xsetnonblock(int fd, int nonblocking) {
733 int errnoval= oop_fd_nonblock(fd, nonblocking);
734 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
737 static void check_isreg(const struct stat *stab, const char *path,
739 if (!S_ISREG(stab->st_mode))
740 die("%s %s not a plain file (mode 0%lo)",
741 what, path, (unsigned long)stab->st_mode);
744 static void xfstat(int fd, struct stat *stab_r, const char *what) {
745 int r= fstat(fd, stab_r);
746 if (r) sysdie("could not fstat %s", what);
749 static void xfstat_isreg(int fd, struct stat *stab_r,
750 const char *path, const char *what) {
751 xfstat(fd, stab_r, what);
752 check_isreg(stab_r, path, what);
755 static void xlstat_isreg(const char *path, struct stat *stab,
756 int *enoent_r /* 0 means ENOENT is fatal */,
758 int r= lstat(path, stab);
760 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
761 sysdie("could not lstat %s %s", what, path);
763 if (enoent_r) *enoent_r= 0;
764 check_isreg(stab, path, what);
767 static int samefile(const struct stat *a, const struct stat *b) {
768 assert(S_ISREG(a->st_mode));
769 assert(S_ISREG(b->st_mode));
770 return (a->st_ino == b->st_ino &&
771 a->st_dev == b->st_dev);
774 static char *sanitise(const char *input, int len) {
775 static char sanibuf[100]; /* returns pointer to this buffer! */
777 const char *p= input;
778 const char *endp= len>=0 ? input+len : 0;
782 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
783 int c= (!endp || p<endp) ? *p++ : 0;
784 if (!c) { *q++= '\''; *q=0; break; }
785 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
786 sprintf(q,"\\x%02x",c);
792 static int isewouldblock(int errnoval) {
793 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
796 /*========== command and control connections ==========*/
798 static int control_master;
800 typedef struct ControlConn ControlConn;
802 void (*destroy)(ControlConn*);
808 struct sockaddr_un un;
813 static const oop_rd_style control_rd_style= {
814 OOP_RD_DELIM_STRIP, '\n',
816 OOP_RD_SHORTREC_FORBID
819 static void control_destroy(ControlConn *cc) {
823 static void control_checkouterr(ControlConn *cc /* may destroy*/) {
824 if (ferror(cc->out) | fflush(cc->out)) {
825 info("CTRL%d write error %s", cc->fd, strerror(errno));
830 static void control_prompt(ControlConn *cc /* may destroy*/) {
831 fprintf(cc->out, "%s| ", sitename);
832 control_checkouterr(cc);
835 struct ControlCommand {
837 void (*f)(ControlConn *cc, const ControlCommand *ccmd,
838 const char *arg, size_t argsz);
843 static const ControlCommand control_commands[];
846 static void ccmd_##wh(ControlConn *cc, const ControlCommand *c, \
847 const char *arg, size_t argsz)
850 fputs("commands:\n", cc->out);
851 const ControlCommand *ccmd;
852 for (ccmd=control_commands; ccmd->cmd; ccmd++)
853 fprintf(cc->out, " %s\n", ccmd->cmd);
854 fputs("NB: permissible arguments are not shown above."
855 " Not all commands listed are safe. See innduct(8).\n", cc->out);
859 int ok= trigger_flush_ok("manual request");
860 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
865 notice("terminating (CTRL%d)",cc->fd);
866 raise_default(SIGTERM);
872 /* messing with our head: */
873 CCMD(period) { period(); }
874 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
875 CCMD(setint) { *(int*)c->xdata= c->xval; }
876 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
878 static const ControlCommand control_commands[]= {
880 { "flush", ccmd_flush },
881 { "stop", ccmd_stop },
882 { "dump q", ccmd_dump, 0,0 },
883 { "dump a", ccmd_dump, 0,1 },
885 { "p", ccmd_period },
887 #define POKES(cmd,func) \
888 { cmd "flush", func, &until_flush, 1 }, \
889 { cmd "conn", func, &until_connect, 0 }, \
890 { cmd "blscan", func, &until_backlog_nextscan, 0 },
891 POKES("next ", ccmd_setint)
892 POKES("prod ", ccmd_setint_period)
894 { "pretend flush", ccmd_setintarg, &simulate_flush },
895 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
899 static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
900 const char *errmsg, int errnoval,
901 const char *data, size_t recsz, void *cc_v) {
902 ControlConn *cc= cc_v;
905 info("CTRL%d closed", cc->fd);
910 if (recsz == 0) goto prompt;
912 const ControlCommand *ccmd;
913 for (ccmd=control_commands; ccmd->cmd; ccmd++) {
914 int l= strlen(ccmd->cmd);
915 if (recsz < l) continue;
916 if (recsz > l && data[l] != ' ') continue;
917 if (memcmp(data, ccmd->cmd, l)) continue;
919 int argl= (int)recsz - (l+1);
920 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
924 fputs("unknown command; h for help\n", cc->out);
931 static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
932 const char *errmsg, int errnoval,
933 const char *data, size_t recsz, void *cc_v) {
934 ControlConn *cc= cc_v;
936 info("CTRL%d read error %s", cc->fd, errmsg);
941 static int control_conn_startup(ControlConn *cc /* may destroy*/,
943 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
944 if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
946 int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
949 if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
951 info("CTRL%d %s ready", cc->fd, how);
956 static void control_stdio_destroy(ControlConn *cc) {
958 oop_rd_cancel(cc->rd);
959 errno= oop_rd_delete_tidy(cc->rd);
960 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
965 static void control_stdio(void) {
966 NEW_DECL(ControlConn *,cc);
967 cc->destroy= control_stdio_destroy;
971 int r= control_conn_startup(cc,"stdio");
972 if (r) cc->destroy(cc);
975 static void control_accepted_destroy(ControlConn *cc) {
977 oop_rd_cancel(cc->rd);
978 oop_rd_delete_kill(cc->rd);
980 if (cc->out) { fclose(cc->out); cc->fd=0; }
981 close_perhaps(&cc->fd);
985 static void *control_master_readable(oop_source *lp, int master,
986 oop_event ev, void *u) {
987 NEW_DECL(ControlConn *,cc);
988 cc->destroy= control_accepted_destroy;
990 cc->salen= sizeof(cc->sa);
991 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
992 if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
994 cc->out= fdopen(cc->fd, "w");
995 if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
997 int r= control_conn_startup(cc, "accepted");
1000 return OOP_CONTINUE;
1004 return OOP_CONTINUE;
1007 #define NOCONTROL(...) do{ \
1008 syswarn("no control socket, because failed to " __VA_ARGS__); \
1012 static void control_init(void) {
1017 struct sockaddr_un un;
1020 memset(&sa,0,sizeof(sa));
1021 int maxlen= sizeof(sa.un.sun_path);
1023 int reallen= readlink(path_control, sa.un.sun_path, maxlen);
1025 if (errno != ENOENT)
1026 NOCONTROL("readlink control socket symlink path %s", path_control);
1028 if (reallen >= maxlen) {
1029 debug("control socket symlink path too long (r=%d)",reallen);
1030 xunlink(path_control, "old (overlong) control socket symlink");
1036 int r= lstat(realsockdir,&stab);
1038 if (errno != ENOENT) NOCONTROL("lstat real socket dir %s", realsockdir);
1040 r= mkdir(realsockdir, 0700);
1041 if (r) NOCONTROL("mkdir real socket dir %s", realsockdir);
1044 uid_t self= geteuid();
1045 if (!S_ISDIR(stab.st_mode) ||
1046 stab.st_uid != self ||
1047 stab.st_mode & 0007) {
1048 warn("no control socket, because real socket directory"
1049 " is somehow wrong (ISDIR=%d, uid=%lu (exp.%lu), mode %lo)",
1050 !!S_ISDIR(stab.st_mode),
1051 (unsigned long)stab.st_uid, (unsigned long)self,
1052 (unsigned long)stab.st_mode & 0777UL);
1057 real= xasprintf("%s/s%lx.%lx", realsockdir,
1058 (unsigned long)xtime(), (unsigned long)self_pid);
1059 int reallen= strlen(real);
1061 if (reallen >= maxlen) {
1062 warn("no control socket, because tmpnam gave overly-long path"
1066 r= symlink(real, path_control);
1067 if (r) NOCONTROL("make control socket path %s a symlink to real"
1068 " socket path %s", path_control, real);
1069 memcpy(sa.un.sun_path, real, reallen);
1072 int r= unlink(sa.un.sun_path);
1073 if (r && errno!=ENOENT)
1074 NOCONTROL("remove old real socket %s", sa.un.sun_path);
1076 control_master= socket(PF_UNIX, SOCK_STREAM, 0);
1077 if (control_master<0) NOCONTROL("create new control socket");
1079 sa.un.sun_family= AF_UNIX;
1080 int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
1081 r= bind(control_master, &sa.sa, sl);
1082 if (r) NOCONTROL("bind to real socket path %s", sa.un.sun_path);
1084 r= listen(control_master, 5);
1085 if (r) NOCONTROL("listen");
1087 xsetnonblock(control_master, 1);
1089 loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
1090 info("control socket ok, real path %s", sa.un.sun_path);
1096 xclose_perhaps(&control_master, "control master",0);
1100 /*========== management of connections ==========*/
1102 static void conn_closefd(Conn *conn, const char *msgprefix) {
1103 int r= close_perhaps(&conn->fd);
1104 if (r) info("C%d %serror closing socket: %s",
1105 conn->fd, msgprefix, strerror(errno));
1108 static void conn_dispose(Conn *conn) {
1111 oop_rd_cancel(conn->rd);
1112 oop_rd_delete_kill(conn->rd);
1116 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1117 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1119 conn_closefd(conn,"");
1121 until_connect= reconnect_delay_periods;
1124 static void *conn_exception(oop_source *lp, int fd,
1125 oop_event ev, void *conn_v) {
1128 assert(fd == conn->fd);
1129 assert(ev == OOP_EXCEPTION);
1130 int r= read(conn->fd, &ch, 1);
1131 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1132 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1133 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1134 return OOP_CONTINUE;
1137 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1138 int requeue[art_MaxState];
1139 memset(requeue,0,sizeof(requeue));
1143 while ((art= LIST_REMHEAD(conn->priority)))
1144 LIST_ADDTAIL(art->ipf->queue, art);
1146 while ((art= LIST_REMHEAD(conn->waiting)))
1147 LIST_ADDTAIL(art->ipf->queue, art);
1149 while ((art= LIST_REMHEAD(conn->sent))) {
1150 requeue[art->state]++;
1151 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1152 LIST_ADDTAIL(art->ipf->queue,art);
1153 check_reading_pause_resume(art->ipf);
1158 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1161 char *m= xvasprintf(fmt,al);
1162 warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1163 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1166 LIST_REMOVE(conns,conn);
1168 check_assign_articles();
1171 static void connfail(Conn *conn, const char *fmt, ...) {
1174 vconnfail(conn,fmt,al);
1178 static void check_idle_conns(void) {
1181 conn->since_activity++;
1184 if (conn->since_activity <= need_activity_periods) continue;
1186 /* We need to shut this down */
1188 connfail(conn,"timed out waiting for response to QUIT");
1189 else if (conn->sent.count)
1190 connfail(conn,"timed out waiting for responses");
1191 else if (conn->waiting.count || conn->priority.count)
1192 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1193 else if (conn->xmitu)
1194 connfail(conn,"peer has been sending responses"
1195 " before receiving our commands!");
1197 static const char quitcmd[]= "QUIT\r\n";
1198 int todo= sizeof(quitcmd)-1;
1199 const char *p= quitcmd;
1201 int r= write(conn->fd, p, todo);
1203 if (isewouldblock(errno))
1204 connfail(conn, "blocked writing QUIT to idle connection");
1206 connfail(conn, "failed to write QUIT to idle connection: %s",
1214 conn->since_activity= 0;
1215 debug("C%d is idle, quitting", conn->fd);
1224 /*---------- making new connections ----------*/
1226 static pid_t connecting_child;
1227 static int connecting_fdpass_sock;
1229 static void connect_attempt_discard(void) {
1230 if (connecting_child) {
1231 int status= xwaitpid(&connecting_child, "connect");
1232 if (!(WIFEXITED(status) ||
1233 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1234 report_child_status("connect", status);
1236 if (connecting_fdpass_sock) {
1237 cancel_fd_read_except(connecting_fdpass_sock);
1238 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1242 #define PREP_DECL_MSG_CMSG(msg) \
1244 struct iovec msgiov; \
1245 msgiov.iov_base= &msgbyte; \
1246 msgiov.iov_len= 1; \
1247 struct msghdr msg; \
1248 memset(&msg,0,sizeof(msg)); \
1249 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1250 msg.msg_iov= &msgiov; \
1251 msg.msg_iovlen= 1; \
1252 msg.msg_control= msg##cbuf; \
1253 msg.msg_controllen= sizeof(msg##cbuf);
1255 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1258 assert(fd == connecting_fdpass_sock);
1260 PREP_DECL_MSG_CMSG(msg);
1262 ssize_t rs= recvmsg(fd, &msg, 0);
1264 if (isewouldblock(errno)) return OOP_CONTINUE;
1265 syswarn("failed to read socket from connecting child");
1270 LIST_INIT(conn->waiting);
1271 LIST_INIT(conn->priority);
1272 LIST_INIT(conn->sent);
1274 struct cmsghdr *h= 0;
1275 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1277 int status= xwaitpid(&connecting_child, "connect child (broken)");
1279 if (WIFEXITED(status)) {
1280 if (WEXITSTATUS(status) != 0 &&
1281 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1282 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1283 /* child already reported the problem */;
1285 if (e == OOP_EXCEPTION)
1286 warn("connect: connection child exited code %d but"
1287 " unexpected exception on fdpass socket",
1288 WEXITSTATUS(status));
1290 warn("connect: connection child exited code %d but"
1292 WEXITSTATUS(status), (int)rs);
1294 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1295 warn("connect: connection attempt timed out");
1297 report_child_status("connect", status);
1302 #define CHK(field, val) \
1303 if (h->cmsg_##field != val) { \
1304 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1305 h->cmsg_##field, val); \
1308 CHK(level, SOL_SOCKET);
1309 CHK(type, SCM_RIGHTS);
1310 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1313 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1315 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1318 pid_t got= waitpid(connecting_child, &status, 0);
1319 if (got==-1) sysdie("connect: real wait for child");
1320 assert(got == connecting_child);
1321 connecting_child= 0;
1323 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1324 int es= WEXITSTATUS(status);
1326 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1327 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1329 fatal("connect: child gave unexpected exit status %d", es);
1333 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1335 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1336 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1337 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1338 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1340 &peer_rd_err, conn);
1341 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1343 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1344 LIST_ADDHEAD(conns, conn);
1346 connect_attempt_discard();
1347 check_assign_articles();
1348 return OOP_CONTINUE;
1352 connect_attempt_discard();
1353 return OOP_CONTINUE;
1356 static int allow_connect_start(void) {
1357 return conns.count < max_connections
1358 && !connecting_child
1362 static void connect_start(void) {
1363 assert(!connecting_child);
1364 assert(!connecting_fdpass_sock);
1366 info("starting connection attempt");
1369 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1370 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1372 connecting_child= xfork("connection");
1374 if (!connecting_child) {
1375 FILE *cn_from, *cn_to;
1376 char buf[NNTP_STRLEN+100];
1377 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1379 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1381 alarm(connection_setup_timeout);
1382 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1386 unsigned char c= buf[l-1];
1387 if (!isspace(c)) break;
1388 if (c=='\n' || c=='\r') stripped=1;
1392 sysfatal("connect: connection attempt failed");
1395 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1399 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1400 sysfatal("connect: authentication failed");
1402 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1404 sysfatal("connect: could not send MODE STREAM");
1405 buf[sizeof(buf)-1]= 0;
1406 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1407 if (ferror(cn_from))
1408 sysfatal("connect: could not read response to MODE STREAM");
1410 fatal("connect: connection close in response to MODE STREAM");
1415 fatal("connect: response to MODE STREAM is too long: %.100s...",
1417 l--; if (l>0 && buf[l-1]=='\r') l--;
1420 int rcode= strtoul(buf,&ep,10);
1422 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1426 exitstatus= CONNCHILD_ESTATUS_STREAM;
1432 warn("connect: unexpected response to MODE STREAM: %.50s",
1438 int fd= fileno(cn_from);
1440 PREP_DECL_MSG_CMSG(msg);
1441 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1442 cmsg->cmsg_level= SOL_SOCKET;
1443 cmsg->cmsg_type= SCM_RIGHTS;
1444 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1445 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1447 msg.msg_controllen= cmsg->cmsg_len;
1448 r= sendmsg(socks[1], &msg, 0);
1449 if (r<0) sysdie("sendmsg failed for new connection");
1450 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1455 xclose(socks[1], "connecting fdpass child's socket",0);
1456 connecting_fdpass_sock= socks[0];
1457 xsetnonblock(connecting_fdpass_sock, 1);
1458 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1461 /*---------- assigning articles to conns, and transmitting ----------*/
1463 static Article *dequeue_from(int peek, InputFile *ipf) {
1465 if (peek) return LIST_HEAD(ipf->queue);
1467 Article *art= LIST_REMHEAD(ipf->queue);
1469 check_reading_pause_resume(ipf);
1473 static Article *dequeue(int peek) {
1475 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1476 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1477 art= dequeue_from(peek, main_input_file); if (art) return art;
1481 static void check_assign_articles(void) {
1487 int spare=0, inqueue=0;
1489 /* Find a connection to offer this article. We prefer a busy
1490 * connection to an idle one, provided it's not full. We take the
1491 * first (oldest) and since that's stable, it will mean we fill up
1492 * connections in order. That way if we have too many
1493 * connections, the spare ones will go away eventually.
1496 if (walk->quitting) continue;
1497 inqueue= walk->sent.count + walk->priority.count
1498 + walk->waiting.count;
1499 spare= walk->max_queue - inqueue;
1500 assert(inqueue <= max_queue_per_conn);
1502 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1503 else if (spare>0) /*working*/ { use= walk; break; }
1506 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1508 Article *art= dequeue(0);
1510 LIST_ADDTAIL(use->waiting, art);
1513 conn_maybe_write(use);
1514 } else if (allow_connect_start()) {
1515 until_connect= reconnect_delay_periods;
1524 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1525 conn_maybe_write(u);
1526 return OOP_CONTINUE;
1529 static void conn_maybe_write(Conn *conn) {
1531 conn_make_some_xmits(conn);
1533 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1537 void *rp= conn_write_some_xmits(conn);
1538 if (rp==OOP_CONTINUE) {
1539 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1541 } else if (rp==OOP_HALT) {
1544 /* transmitted everything */
1551 /*---------- expiry, flow control and deferral ----------*/
1554 * flow control notes
1555 * to ensure articles go away eventually
1556 * separate queue for each input file
1558 * every period, check head of backlog queue for expiry with SMretrieve
1559 * if too old: discard, and check next article
1560 * also check every backlog article as we read it
1562 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1563 * one-off: eat queued articles from flushing and write them to defer
1564 * one-off: connfail all connections which have any articles from flushing
1565 * newly read articles from flushing go straight to defer
1566 * this should take care of it and get us out of this state
1567 * to avoid filling up ram needlessly
1569 * limit number of queued articles for each ipf
1570 * pause/resume inputfile tailing
1573 static void check_reading_pause_resume(InputFile *ipf) {
1574 if (ipf->queue.count >= max_queue_per_ipf)
1575 inputfile_reading_pause(ipf);
1577 inputfile_reading_resume(ipf);
1580 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1582 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1584 sysfatal("write to defer file %s",path_defer);
1585 article_done(art, whichcount);
1588 static int article_check_expired(Article *art /* must be queued, not conn */) {
1589 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1590 if (artdata) { SMfreearticle(artdata); return 0; }
1592 LIST_REMOVE(art->ipf->queue, art);
1594 art->ipf->count_nooffer_missing++;
1595 article_done(art,-1);
1599 static void inputfile_queue_check_expired(InputFile *ipf) {
1603 Article *art= LIST_HEAD(ipf->queue);
1604 int exp= article_check_expired(art);
1607 check_reading_pause_resume(ipf);
1610 static void article_autodefer(InputFile *ipf, Article *art) {
1612 article_defer(art,-1);
1615 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1617 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1618 if (art->ipf == ipf) return 1;
1622 static void autodefer_input_file_articles(InputFile *ipf) {
1624 while ((art= LIST_REMHEAD(ipf->queue)))
1625 article_autodefer(ipf, art);
1628 static void autodefer_input_file(InputFile *ipf) {
1631 autodefer_input_file_articles(ipf);
1633 if (ipf->inprogress) {
1636 if (has_article_in(&walk->waiting, ipf) ||
1637 has_article_in(&walk->priority, ipf) ||
1638 has_article_in(&walk->sent, ipf))
1641 while (ipf->inprogress) {
1643 if (walk->quitting < 0) goto found;
1644 abort(); /* where are they ?? */
1647 connfail(walk, "connection is stuck or crawling,"
1648 " and we need to finish flush");
1649 autodefer_input_file_articles(ipf);
1653 check_reading_pause_resume(ipf);
1656 /*========== article transmission ==========*/
1658 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1659 XmitKind kind) { /* caller must then fill in details */
1660 struct iovec *v= &conn->xmit[conn->xmitu];
1661 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1662 v->iov_base= (char*)data;
1668 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1669 xmit_core(conn,data,len, xk_Const);
1671 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1673 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1674 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1678 static void xmit_free(XmitDetails *d) {
1680 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1681 case xk_Const: break;
1686 static void *conn_write_some_xmits(Conn *conn) {
1688 * 0: nothing more to write, no need to call us again
1689 * OOP_CONTINUE: more to write but fd not writeable
1690 * OOP_HALT: disaster, have destroyed conn
1693 int count= conn->xmitu;
1694 if (!count) return 0;
1696 if (count > IOV_MAX) count= IOV_MAX;
1697 ssize_t rs= writev(conn->fd, conn->xmit, count);
1699 if (isewouldblock(errno)) return OOP_CONTINUE;
1700 connfail(conn, "write failed: %s", strerror(errno));
1706 for (done=0; rs && done<conn->xmitu; done++) {
1707 struct iovec *vp= &conn->xmit[done];
1708 XmitDetails *dp= &conn->xmitd[done];
1709 if (rs > vp->iov_len) {
1713 vp->iov_base= (char*)vp->iov_base + rs;
1717 int newu= conn->xmitu - done;
1718 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1719 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1724 static void conn_make_some_xmits(Conn *conn) {
1726 if (conn->xmitu+5 > CONNIOVS)
1729 Article *art= LIST_REMHEAD(conn->priority);
1730 if (!art) art= LIST_REMHEAD(conn->waiting);
1733 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1734 /* actually send it */
1736 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1739 art->state == art_Unchecked ? art_Unsolicited :
1740 art->state == art_Wanted ? art_Wanted :
1743 if (!artdata) art->missing= 1;
1744 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1748 XMIT_LITERAL("TAKETHIS ");
1749 xmit_noalloc(conn, art->messageid, art->midlen);
1750 XMIT_LITERAL("\r\n");
1751 xmit_artbody(conn, artdata);
1753 article_done(art, -1);
1757 /* we got 235 from IHAVE */
1759 xmit_artbody(conn, artdata);
1761 XMIT_LITERAL(".\r\n");
1765 LIST_ADDTAIL(conn->sent, art);
1771 XMIT_LITERAL("CHECK ");
1773 XMIT_LITERAL("IHAVE ");
1774 xmit_noalloc(conn, art->messageid, art->midlen);
1775 XMIT_LITERAL("\r\n");
1777 assert(art->state == art_Unchecked);
1778 art->ipf->counts[art->state][RC_sent]++;
1779 LIST_ADDTAIL(conn->sent, art);
1784 /*========== handling responses from peer ==========*/
1786 static const oop_rd_style peer_rd_style= {
1787 OOP_RD_DELIM_STRIP, '\n',
1789 OOP_RD_SHORTREC_FORBID
1792 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1793 const char *errmsg, int errnoval,
1794 const char *data, size_t recsz, void *conn_v) {
1796 connfail(conn, "error receiving from peer: %s", errmsg);
1797 return OOP_CONTINUE;
1800 static Article *article_reply_check(Conn *conn, const char *response,
1801 int code_indicates_streaming,
1803 /* 1:yes, -1:no, 0:dontcare */,
1804 const char *sanitised_response) {
1805 Article *art= LIST_HEAD(conn->sent);
1809 "peer gave unexpected response when no commands outstanding: %s",
1810 sanitised_response);
1814 if (code_indicates_streaming) {
1815 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1816 if (!conn->stream) {
1817 connfail(conn, "peer gave streaming response code "
1818 " to IHAVE or subsequent body: %s", sanitised_response);
1821 const char *got_mid= response+4;
1822 int got_midlen= strcspn(got_mid, " \n\r");
1823 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1824 connfail(conn, "peer gave streaming response with syntactically invalid"
1825 " messageid: %s", sanitised_response);
1828 if (got_midlen != art->midlen ||
1829 memcmp(got_mid, art->messageid, got_midlen)) {
1830 connfail(conn, "peer gave streaming response code to wrong article -"
1831 " probable synchronisation problem; we offered: %s;"
1833 art->messageid, sanitised_response);
1838 connfail(conn, "peer gave non-streaming response code to"
1839 " CHECK/TAKETHIS: %s", sanitised_response);
1844 if (must_have_sent>0 && art->state < art_Wanted) {
1845 connfail(conn, "peer says article accepted but"
1846 " we had not sent the body: %s", sanitised_response);
1849 if (must_have_sent<0 && art->state >= art_Wanted) {
1850 connfail(conn, "peer says please sent the article but we just did: %s",
1851 sanitised_response);
1855 Article *art_again= LIST_REMHEAD(conn->sent);
1856 assert(art_again == art);
1860 static void update_nocheck(int accepted) {
1861 accept_proportion *= nocheck_decay;
1862 accept_proportion += accepted * (1.0 - nocheck_decay);
1863 int new_nocheck= accept_proportion >= nocheck_thresh;
1864 if (new_nocheck && !nocheck_reported) {
1865 notice("entering nocheck mode for the first time");
1866 nocheck_reported= 1;
1867 } else if (new_nocheck != nocheck) {
1868 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1870 nocheck= new_nocheck;
1873 static void article_done(Article *art, int whichcount) {
1874 if (whichcount>=0 && !art->missing)
1875 art->ipf->counts[art->state][whichcount]++;
1877 if (whichcount == RC_accepted) update_nocheck(1);
1878 else if (whichcount == RC_unwanted) update_nocheck(0);
1880 InputFile *ipf= art->ipf;
1882 while (art->blanklen) {
1883 static const char spaces[]=
1893 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1894 int r= pwrite(ipf->fd, spaces, w, art->offset);
1896 if (errno==EINTR) continue;
1897 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1898 art->messageid, art->blanklen,
1899 (unsigned long)art->offset, ipf->path);
1901 assert(r>=0 && r<=w);
1907 assert(ipf->inprogress >= 0);
1910 if (!ipf->inprogress && ipf != main_input_file)
1911 queue_check_input_done();
1914 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1915 const char *errmsg, int errnoval,
1916 const char *data, size_t recsz, void *conn_v) {
1919 if (ev == OOP_RD_EOF) {
1920 connfail(conn, "unexpected EOF from peer");
1921 return OOP_CONTINUE;
1923 assert(ev == OOP_RD_OK);
1925 char *sani= sanitise(data,-1);
1928 unsigned long code= strtoul(data, &ep, 10);
1929 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1930 connfail(conn, "badly formatted response from peer: %s", sani);
1931 return OOP_CONTINUE;
1935 conn->waiting.count ||
1936 conn->priority.count ||
1940 if (conn->quitting) {
1941 if (code!=205 && code!=503) {
1942 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1944 notice("C%d idle connection closed by us", conn->fd);
1946 LIST_REMOVE(conns,conn);
1949 return OOP_CONTINUE;
1952 conn->since_activity= 0;
1955 #define GET_ARTICLE(musthavesent) do{ \
1956 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1957 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1960 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1961 code_streaming= (streaming); \
1962 GET_ARTICLE(musthavesent); \
1963 article_done(art, RC_##how); \
1967 #define PEERBADMSG(m) do { \
1968 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1971 int code_streaming= 0;
1975 default: PEERBADMSG("peer sent unexpected message");
1979 PEERBADMSG("peer timed us out or stopped accepting articles");
1981 notice("C%d idle connection closed by peer", conn->fd);
1982 LIST_REMOVE(conns,conn);
1984 return OOP_CONTINUE;
1986 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1987 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1989 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1990 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1992 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1993 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1995 case 238: /* CHECK says send it */
1997 case 335: /* IHAVE says send it */
1999 assert(art->state == art_Unchecked);
2000 art->ipf->counts[art->state][RC_accepted]++;
2001 art->state= art_Wanted;
2002 LIST_ADDTAIL(conn->priority, art);
2005 case 431: /* CHECK or TAKETHIS says try later */
2007 case 436: /* IHAVE says try later */
2009 article_defer(art, RC_deferred);
2015 conn_maybe_write(conn);
2016 check_assign_articles();
2017 return OOP_CONTINUE;
2021 /*========== monitoring of input files ==========*/
2023 static void feedfile_eof(InputFile *ipf) {
2024 assert(ipf != main_input_file); /* promised by tailing_try_read */
2025 inputfile_reading_stop(ipf);
2027 if (ipf == flushing_input_file) {
2028 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2029 if (main_input_file) inputfile_reading_start(main_input_file);
2030 statemc_check_flushing_done();
2031 } else if (ipf == backlog_input_file) {
2032 statemc_check_backlog_done();
2034 abort(); /* supposed to wait rather than get EOF on main input file */
2038 static InputFile *open_input_file(const char *path) {
2039 int fd= open(path, O_RDWR);
2041 if (errno==ENOENT) return 0;
2042 sysfatal("unable to open input file %s", path);
2046 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2047 memset(ipf,0,sizeof(*ipf));
2051 LIST_INIT(ipf->queue);
2052 strcpy(ipf->path, path);
2057 static void close_input_file(InputFile *ipf) { /* does not free */
2058 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2059 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2060 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2061 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2062 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2066 /*---------- dealing with articles read in the input file ----------*/
2068 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2069 const char *data, const char *how) {
2070 warn("corrupted file: %s, offset %lu: %s: in %s",
2071 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2072 ipf->readcount_err++;
2073 if (ipf->readcount_err > max_bad_data_initial +
2074 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2075 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2076 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2077 return OOP_CONTINUE;
2080 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2081 oop_rd_event ev, const char *errmsg,
2082 int errnoval, const char *data, size_t recsz,
2084 InputFile *ipf= ipf_v;
2085 assert(ev == OOP_RD_SYSTEM);
2087 sysdie("error reading input file: %s, offset %lu",
2088 ipf->path, (unsigned long)ipf->offset);
2091 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2092 oop_rd_event ev, const char *errmsg,
2093 int errnoval, const char *data, size_t recsz,
2095 InputFile *ipf= ipf_v;
2097 char tokentextbuf[sizeof(TOKEN)*2+3];
2099 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2101 off_t old_offset= ipf->offset;
2102 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2104 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2106 if (ev==OOP_RD_PARTREC)
2107 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2108 /* but process it anyway */
2110 if (ipf->skippinglong) {
2111 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2112 return OOP_CONTINUE;
2114 if (ev==OOP_RD_LONG) {
2115 ipf->skippinglong= 1;
2116 X_BAD_DATA("overly long line");
2119 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2120 if (!recsz) X_BAD_DATA("empty line");
2123 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2124 ipf->readcount_blank++;
2125 return OOP_CONTINUE;
2128 char *space= strchr(data,' ');
2129 int tokenlen= space-data;
2130 int midlen= (int)recsz-tokenlen-1;
2131 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2132 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2134 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2135 memcpy(tokentextbuf, data, tokenlen);
2136 tokentextbuf[tokenlen]= 0;
2137 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2139 ipf->readcount_ok++;
2141 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2142 memset(art,0,sizeof(*art));
2143 art->state= art_Unchecked;
2144 art->midlen= midlen;
2145 art->ipf= ipf; ipf->inprogress++;
2146 art->token= TextToToken(tokentextbuf);
2147 art->offset= old_offset;
2148 art->blanklen= recsz;
2149 strcpy(art->messageid, space+1);
2150 LIST_ADDTAIL(ipf->queue, art);
2152 if (ipf->autodefer >= 0)
2153 article_autodefer(ipf, art);
2154 else if (ipf==backlog_input_file)
2155 article_check_expired(art);
2157 if (sms==sm_NORMAL && ipf==main_input_file &&
2158 ipf->offset >= target_max_feedfile_size)
2159 statemc_start_flush("feed file size");
2161 check_assign_articles(); /* may destroy conn but that's OK */
2162 check_reading_pause_resume(ipf);
2163 return OOP_CONTINUE;
2166 /*========== tailing input file ==========*/
2168 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2170 InputFile *ipf= user;
2171 return ipf->readable_callback(loop, &ipf->readable,
2172 ipf->readable_callback_user);
2175 static void tailing_on_cancel(struct oop_readable *rable) {
2176 InputFile *ipf= (void*)rable;
2178 if (ipf->filemon) filemon_stop(ipf);
2179 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2180 ipf->readable_callback= 0;
2183 static void tailing_queue_readable(InputFile *ipf) {
2184 /* lifetime of ipf here is OK because destruction will cause
2185 * on_cancel which will cancel this callback */
2186 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2189 static int tailing_on_readable(struct oop_readable *rable,
2190 oop_readable_call *cb, void *user) {
2191 InputFile *ipf= (void*)rable;
2193 tailing_on_cancel(rable);
2194 ipf->readable_callback= cb;
2195 ipf->readable_callback_user= user;
2198 tailing_queue_readable(ipf);
2202 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2204 InputFile *ipf= (void*)rable;
2206 ssize_t r= read(ipf->fd, buffer, length);
2208 if (errno==EINTR) continue;
2212 if (ipf==main_input_file) {
2215 } else if (ipf==flushing_input_file) {
2217 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2218 } else if (ipf==backlog_input_file) {
2224 tailing_queue_readable(ipf);
2229 /*---------- filemon implemented with inotify ----------*/
2231 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2232 #define HAVE_FILEMON
2234 #include <sys/inotify.h>
2236 static int filemon_inotify_fd;
2237 static int filemon_inotify_wdmax;
2238 static InputFile **filemon_inotify_wd2ipf;
2240 struct Filemon_Perfile {
2244 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2245 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2246 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2248 if (wd >= filemon_inotify_wdmax) {
2250 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2251 sizeof(*filemon_inotify_wd2ipf) * newmax);
2252 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2253 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2254 filemon_inotify_wdmax= newmax;
2257 assert(!filemon_inotify_wd2ipf[wd]);
2258 filemon_inotify_wd2ipf[wd]= ipf;
2260 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2261 ipf, wd, filemon_inotify_wdmax);
2266 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2268 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2269 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2270 if (r) sysdie("inotify_rm_watch");
2271 filemon_inotify_wd2ipf[wd]= 0;
2274 static void *filemon_inotify_readable(oop_source *lp, int fd,
2275 oop_event e, void *u) {
2276 struct inotify_event iev;
2278 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2280 if (isewouldblock(errno)) break;
2281 sysdie("read from inotify master");
2282 } else if (r==sizeof(iev)) {
2283 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2285 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2287 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2288 /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2289 filemon_callback(ipf);
2291 return OOP_CONTINUE;
2294 static int filemon_method_init(void) {
2295 filemon_inotify_fd= inotify_init();
2296 if (filemon_inotify_fd<0) {
2297 syswarn("filemon/inotify: inotify_init failed");
2300 xsetnonblock(filemon_inotify_fd, 1);
2301 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2303 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2307 static void filemon_method_dump_info(FILE *f) {
2309 fprintf(f,"inotify");
2310 DUMPV("%d",,filemon_inotify_fd);
2311 DUMPV("%d",,filemon_inotify_wdmax);
2312 for (i=0; i<filemon_inotify_wdmax; i++)
2313 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2316 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2318 /*---------- filemon dummy implementation ----------*/
2320 #if !defined(HAVE_FILEMON)
2322 struct Filemon_Perfile { int dummy; };
2324 static int filemon_method_init(void) {
2325 warn("filemon/dummy: no filemon method compiled in");
2328 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2329 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2330 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2332 #endif /* !HAVE_FILEMON */
2334 /*---------- filemon generic interface ----------*/
2336 static void filemon_start(InputFile *ipf) {
2337 assert(!ipf->filemon);
2340 filemon_method_startfile(ipf, ipf->filemon);
2343 static void filemon_stop(InputFile *ipf) {
2344 if (!ipf->filemon) return;
2345 filemon_method_stopfile(ipf, ipf->filemon);
2350 static void filemon_callback(InputFile *ipf) {
2351 if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2352 ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2355 /*---------- interface to start and stop an input file ----------*/
2357 static const oop_rd_style feedfile_rdstyle= {
2358 OOP_RD_DELIM_STRIP, '\n',
2360 OOP_RD_SHORTREC_LONG,
2363 static void inputfile_reading_resume(InputFile *ipf) {
2364 if (!ipf->rd) return;
2365 if (!ipf->paused) return;
2367 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2368 feedfile_got_article,ipf, feedfile_read_err, ipf);
2369 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2374 static void inputfile_reading_pause(InputFile *ipf) {
2375 if (!ipf->rd) return;
2376 if (ipf->paused) return;
2377 oop_rd_cancel(ipf->rd);
2381 static void inputfile_reading_start(InputFile *ipf) {
2383 ipf->readable.on_readable= tailing_on_readable;
2384 ipf->readable.on_cancel= tailing_on_cancel;
2385 ipf->readable.try_read= tailing_try_read;
2386 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2387 ipf->readable.delete_kill= 0;
2389 ipf->readable_callback= 0;
2390 ipf->readable_callback_user= 0;
2392 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2396 inputfile_reading_resume(ipf);
2399 static void inputfile_reading_stop(InputFile *ipf) {
2401 inputfile_reading_pause(ipf);
2402 oop_rd_delete(ipf->rd);
2404 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2408 /*========== interaction with innd - state machine ==========*/
2410 /* See official state diagram at top of file. We implement
2421 |`---------------------------------------------------.
2423 |`---------------- - - - |
2424 D ENOENT | D EXISTS see OVERALL STATES diagram |
2425 | for full startup logic |
2428 | ============ try to |
2434 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2435 ^ | hardlink F to D |
2438 | | our handle onto F is now onto D |
2441 | |<-------------------<---------------------<---------+
2443 | | spawn inndcomm flush |
2445 | ================== |
2446 | FLUSHING[-ABSENT] |
2448 | main D tail/none |
2449 | ================== |
2451 | | INNDCOMM FLUSH FAILS ^
2452 | |`----------------------->----------. |
2454 | | NO SUCH SITE V |
2455 ^ |`--------------->----. ==================== |
2456 | | \ FLUSHFAILED[-ABSENT] |
2458 | | FLUSH OK \ main D tail/none |
2459 | | open F \ ==================== |
2461 | | \ | TIME TO RETRY |
2462 | |`------->----. ,---<---'\ `----------------'
2463 | | D NONE | | D NONE `----.
2465 | ============= V V ============
2466 | SEPARATED-1 | | DROPPING-1
2467 | flsh->rd!=0 | | flsh->rd!=0
2468 | [Separated] | | [Dropping]
2469 | main F idle | | main none
2470 | flsh D tail | | flsh D tail
2471 | ============= | | ============
2473 ^ | EOF ON D | | defer | EOF ON D
2475 | =============== | | ===============
2476 | SEPARATED-2 | | DROPPING-2
2477 | flsh->rd==0 | V flsh->rd==0
2478 | [Finishing] | | [Dropping]
2479 | main F tail | `. main none
2480 | flsh D closed | `. flsh D closed
2481 | =============== V `. ===============
2483 | | ALL D PROCESSED `. | ALL D PROCESSED
2484 | V install defer as backlog `. | install defer
2485 ^ | close D `. | close D
2486 | | unlink D `. | unlink D
2489 `----------' ==============
2509 static void startup_set_input_file(InputFile *f) {
2510 assert(!main_input_file);
2512 inputfile_reading_start(f);
2515 static void statemc_lock(void) {
2517 struct stat stab, stabf;
2520 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2521 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2524 memset(&fl,0,sizeof(fl));
2526 fl.l_whence= SEEK_SET;
2527 int r= fcntl(lockfd, F_SETLK, &fl);
2529 if (errno==EACCES || isewouldblock(errno)) {
2530 if (quiet_multiple) exit(0);
2531 fatal("another duct holds the lockfile");
2533 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2536 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2538 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2540 if (!lock_noent && samefile(&stab, &stabf))
2543 xclose(lockfd, "stale lockfile ", path_lock);
2546 FILE *lockfile= fdopen(lockfd, "w");
2547 if (!lockfile) sysdie("fdopen lockfile");
2549 int r= ftruncate(lockfd, 0);
2550 if (r) sysdie("truncate lockfile to write new info");
2552 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2553 (unsigned long)self_pid,
2554 sitename, feedfile, remote_host) == EOF ||
2556 sysfatal("write info to lockfile %s", path_lock);
2558 debug("startup: locked");
2561 static void statemc_init(void) {
2562 struct stat stabdefer;
2564 search_backlog_file();
2567 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2569 debug("startup: ductdefer ENOENT");
2571 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2572 switch (stabdefer.st_nlink==1) {
2574 open_defer(); /* so that we will later close it and rename it */
2577 xunlink(path_defer, "stale defer file link"
2578 " (presumably hardlink to backlog file)");
2581 die("defer file %s has unexpected link count %d",
2582 path_defer, stabdefer.st_nlink);
2586 struct stat stab_f, stab_d;
2589 InputFile *file_d= open_input_file(path_flushing);
2590 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2592 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2594 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2595 debug("startup: F==D => Hardlinked");
2596 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2601 debug("startup: F ENOENT => Moved");
2602 if (file_d) startup_set_input_file(file_d);
2603 spawn_inndcomm_flush("feedfile missing at startup");
2604 /* => Flushing, sms:=FLUSHING */
2607 debug("startup: F!=D => Separated");
2608 startup_set_input_file(file_d);
2609 flushing_input_file= main_input_file;
2610 main_input_file= open_input_file(feedfile);
2611 if (!main_input_file) die("feedfile vanished during startup");
2612 SMS(SEPARATED, max_separated_periods,
2613 "found both old and current feed files");
2615 debug("startup: F exists, D ENOENT => Normal");
2616 InputFile *file_f= open_input_file(feedfile);
2617 if (!file_f) die("feed file vanished during startup");
2618 startup_set_input_file(file_f);
2619 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2624 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2625 assert(sms == sm_NORMAL);
2627 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2629 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2630 (unsigned long)target_max_feedfile_size,
2633 int r= link(feedfile, path_flushing);
2634 if (r) sysfatal("link feedfile %s to flushing file %s",
2635 feedfile, path_flushing);
2638 xunlink(feedfile, "old feedfile link");
2641 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2644 static int trigger_flush_ok(const char *why) {
2648 statemc_start_flush(why ? why : "periodic");
2649 return 1; /* Normal => Flushing; => FLUSHING */
2651 case sm_FLUSHFAILED:
2652 spawn_inndcomm_flush(why ? why : "retry");
2653 return 1; /* Moved => Flushing; => FLUSHING */
2657 warn("abandoning old feedfile after flush (%s), autodeferring",
2658 why ? why : "took too long to complete");
2659 assert(flushing_input_file);
2660 autodefer_input_file(flushing_input_file);
2668 static void statemc_period_poll(void) {
2669 if (!until_flush) return;
2671 assert(until_flush>=0);
2673 if (until_flush) return;
2674 int ok= trigger_flush_ok(0);
2678 static int inputfile_is_done(InputFile *ipf) {
2680 if (ipf->inprogress) return 0; /* new article in the meantime */
2681 if (ipf->rd) return 0; /* not had EOF */
2685 static void notice_processed(InputFile *ipf, int completed,
2686 const char *what, const char *spec) {
2687 if (!ipf) return; /* allows preterminate to be lazy */
2689 #define RCI_NOTHING(x) /* nothing */
2690 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2691 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2693 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2695 char *inprog= completed
2696 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2697 : xasprintf(" inprogress=%ld", ipf->inprogress);
2698 char *autodefer= ipf->autodefer >= 0
2699 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2700 : xasprintf("%s","");
2702 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2703 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2704 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2706 completed?"completed":"processed", what, spec,
2707 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2708 inprog, autodefer, ipf->count_nooffer_missing,
2709 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2710 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2711 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2712 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2713 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2722 static void statemc_check_backlog_done(void) {
2723 InputFile *ipf= backlog_input_file;
2724 if (!inputfile_is_done(ipf)) return;
2726 const char *slash= strrchr(ipf->path, '/');
2727 const char *leaf= slash ? slash+1 : ipf->path;
2728 const char *under= strchr(slash, '_');
2729 const char *rest= under ? under+1 : leaf;
2730 if (!strncmp(rest,"backlog",7)) rest += 7;
2731 notice_processed(ipf,1,"backlog ",rest);
2733 close_input_file(ipf);
2734 if (unlink(ipf->path)) {
2735 if (errno != ENOENT)
2736 sysdie("could not unlink processed backlog file %s", ipf->path);
2737 warn("backlog file %s vanished while we were reading it"
2738 " so we couldn't remove it (but it's done now, anyway)",
2742 backlog_input_file= 0;
2743 search_backlog_file();
2747 static void statemc_check_flushing_done(void) {
2748 InputFile *ipf= flushing_input_file;
2749 if (!inputfile_is_done(ipf)) return;
2751 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2753 notice_processed(ipf,1,"feedfile","");
2757 xunlink(path_flushing, "old flushing file");
2759 close_input_file(flushing_input_file);
2760 free(flushing_input_file);
2761 flushing_input_file= 0;
2763 if (sms==sm_SEPARATED) {
2764 notice("flush complete");
2765 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2766 } else if (sms==sm_DROPPING) {
2767 SMS(DROPPED, max_separated_periods, "old flush complete");
2768 search_backlog_file();
2769 notice("feed dropped, but will continue until backlog is finished");
2773 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2775 assert(!inputfile_is_done(main_input_file));
2776 statemc_check_flushing_done();
2777 statemc_check_backlog_done();
2778 return OOP_CONTINUE;
2781 static void queue_check_input_done(void) {
2782 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2785 static void statemc_setstate(StateMachineState newsms, int periods,
2786 const char *forlog, const char *why) {
2788 until_flush= periods;
2790 const char *xtra= "";
2793 case sm_FLUSHFAILED:
2794 if (!main_input_file) xtra= "-ABSENT";
2798 xtra= flushing_input_file->rd ? "-1" : "-2";
2804 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2806 info("state %s%s %s",forlog,xtra,why);
2810 /*---------- defer and backlog files ----------*/
2812 static void open_defer(void) {
2817 defer= fopen(path_defer, "a+");
2818 if (!defer) sysfatal("could not open defer file %s", path_defer);
2820 /* truncate away any half-written records */
2822 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2824 if (stab.st_size > LONG_MAX)
2825 die("defer file %s size is far too large", path_defer);
2830 long orgsize= stab.st_size;
2831 long truncto= stab.st_size;
2833 if (!truncto) break; /* was only (if anything) one half-truncated record */
2834 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2835 sysdie("seek in defer file %s while truncating partial", path_defer);
2840 sysdie("failed read from defer file %s", path_defer);
2842 die("defer file %s shrank while we were checking it!", path_defer);
2848 if (stab.st_size != truncto) {
2849 warn("truncating half-record at end of defer file %s -"
2850 " shrinking by %ld bytes from %ld to %ld",
2851 path_defer, orgsize - truncto, orgsize, truncto);
2854 sysfatal("could not flush defer file %s", path_defer);
2855 if (ftruncate(fileno(defer), truncto))
2856 sysdie("could not truncate defer file %s", path_defer);
2859 info("continuing existing defer file %s (%ld bytes)",
2860 path_defer, orgsize);
2862 if (fseek(defer, truncto, SEEK_SET))
2863 sysdie("could not seek to new end of defer file %s", path_defer);
2866 static void close_defer(void) {
2871 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2873 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2876 time_t now= xtime();
2878 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2880 (unsigned long)stab.st_ino);
2881 if (link(path_defer, backlog))
2882 sysfatal("could not install defer file %s as backlog file %s",
2883 path_defer, backlog);
2884 if (unlink(path_defer))
2885 sysdie("could not unlink old defer link %s to backlog file %s",
2886 path_defer, backlog);
2890 if (until_backlog_nextscan < 0 ||
2891 until_backlog_nextscan > backlog_retry_minperiods + 1)
2892 until_backlog_nextscan= backlog_retry_minperiods + 1;
2895 static void poll_backlog_file(void) {
2896 if (until_backlog_nextscan < 0) return;
2897 if (until_backlog_nextscan-- > 0) return;
2898 search_backlog_file();
2901 static void search_backlog_file(void) {
2902 /* returns non-0 iff there are any backlog files */
2907 const char *oldest_path=0;
2908 time_t oldest_mtime=0, now;
2910 if (backlog_input_file) return;
2914 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2918 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2920 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2922 for (i=0; i<gl.gl_pathc; i++) {
2923 const char *path= gl.gl_pathv[i];
2925 if (strchr(path,'#') || strchr(path,'~')) {
2926 debug("backlog file search skipping %s", path);
2929 r= stat(path, &stab);
2931 syswarn("failed to stat backlog file %s", path);
2934 if (!S_ISREG(stab.st_mode)) {
2935 warn("backlog file %s is not a plain file (or link to one)", path);
2938 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2940 oldest_mtime= stab.st_mtime;
2943 case GLOB_NOMATCH: /* fall through */
2946 sysdie("glob expansion of backlog pattern %s gave unexpected"
2947 " nonzero (error?) return value %d", globpat_backlog, r);
2951 debug("backlog scan: none");
2953 if (sms==sm_DROPPED) {
2955 notice("feed dropped and our work is complete");
2957 int r= unlink(path_control);
2958 if (r && errno!=ENOENT)
2959 syswarn("failed to remove control symlink for old feed");
2961 xunlink(path_lock, "lockfile for old feed");
2964 until_backlog_nextscan= backlog_spontrescan_periods;
2969 double age= difftime(now, oldest_mtime);
2970 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2972 if (age_deficiency <= 0) {
2973 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2974 age, age_deficiency, oldest_path);
2976 backlog_input_file= open_input_file(oldest_path);
2977 if (!backlog_input_file) {
2978 warn("backlog file %s vanished as we opened it", oldest_path);
2982 inputfile_reading_start(backlog_input_file);
2983 until_backlog_nextscan= -1;
2987 until_backlog_nextscan= age_deficiency / period_seconds;
2989 if (backlog_spontrescan_periods >= 0 &&
2990 until_backlog_nextscan > backlog_spontrescan_periods)
2991 until_backlog_nextscan= backlog_spontrescan_periods;
2993 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2994 age, age_deficiency, until_backlog_nextscan, oldest_path);
3001 /*---------- shutdown and signal handling ----------*/
3003 static void preterminate(void) {
3004 if (in_child) return;
3005 notice_processed(main_input_file,0,"feedfile","");
3006 notice_processed(flushing_input_file,0,"flushing","");
3007 if (backlog_input_file)
3008 notice_processed(backlog_input_file,0, "backlog file ",
3009 backlog_input_file->path);
3012 static int signal_self_pipe[2];
3013 static sig_atomic_t terminate_sig_flag;
3015 static void raise_default(int signo) {
3016 xsigsetdefault(signo);
3021 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3022 assert(fd=signal_self_pipe[0]);
3024 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3025 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
3026 if (r==0) die("eof on signal self pipe");
3027 if (terminate_sig_flag) {
3029 notice("terminating (%s)", strsignal(terminate_sig_flag));
3030 raise_default(terminate_sig_flag);
3032 return OOP_CONTINUE;
3035 static void sigarrived_handler(int signum) {
3040 if (!terminate_sig_flag) terminate_sig_flag= signum;
3045 write(signal_self_pipe[1],&x,1);
3048 static void init_signals(void) {
3049 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3050 sysdie("could not ignore SIGPIPE");
3052 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3054 xsetnonblock(signal_self_pipe[0],1);
3055 xsetnonblock(signal_self_pipe[1],1);
3057 struct sigaction sa;
3058 memset(&sa,0,sizeof(sa));
3059 sa.sa_handler= sigarrived_handler;
3060 sa.sa_flags= SA_RESTART;
3061 xsigaction(SIGTERM,&sa);
3062 xsigaction(SIGINT,&sa);
3064 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3067 /*========== flushing the feed ==========*/
3069 static pid_t inndcomm_child;
3070 static int inndcomm_sentinel_fd;
3072 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3073 assert(inndcomm_child);
3074 assert(fd == inndcomm_sentinel_fd);
3075 int status= xwaitpid(&inndcomm_child, "inndcomm");
3078 cancel_fd_read_except(fd);
3079 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3080 inndcomm_sentinel_fd= 0;
3082 assert(!flushing_input_file);
3084 if (WIFEXITED(status)) {
3085 switch (WEXITSTATUS(status)) {
3087 case INNDCOMMCHILD_ESTATUS_FAIL:
3090 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3091 notice("feed has been dropped by innd, finishing up");
3092 flushing_input_file= main_input_file;
3093 tailing_queue_readable(flushing_input_file);
3094 /* we probably previously returned EAGAIN from our fake read method
3095 * when in fact we were at EOF, so signal another readable event
3096 * so we actually see the EOF */
3100 if (flushing_input_file) {
3101 SMS(DROPPING, max_separated_periods,
3102 "feed dropped by innd, but must finish last flush");
3105 SMS(DROPPED, 0, "feed dropped by innd");
3106 search_backlog_file();
3108 return OOP_CONTINUE;
3112 flushing_input_file= main_input_file;
3113 tailing_queue_readable(flushing_input_file);
3115 main_input_file= open_input_file(feedfile);
3116 if (!main_input_file)
3117 die("flush succeeded but feedfile %s does not exist!", feedfile);
3119 if (flushing_input_file) {
3120 SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3123 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3125 return OOP_CONTINUE;
3128 goto unexpected_exitstatus;
3131 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3132 warn("flush timed out trying to talk to innd");
3135 unexpected_exitstatus:
3136 report_child_status("inndcomm child", status);
3140 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3141 return OOP_CONTINUE;
3144 static void inndcommfail(const char *what) {
3145 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3146 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3149 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3152 notice("flushing %s",why);
3154 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3155 assert(!inndcomm_child);
3156 assert(!inndcomm_sentinel_fd);
3158 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3160 inndcomm_child= xfork("inndcomm child");
3162 if (!inndcomm_child) {
3163 const char *flushargv[2]= { sitename, 0 };
3167 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3168 /* parent spots the autoclose of pipefds[1] when we die or exit */
3170 if (simulate_flush>=0) {
3171 warn("SIMULATING flush child status %d", simulate_flush);
3172 if (simulate_flush>128) raise(simulate_flush-128);
3173 else exit(simulate_flush);
3176 alarm(inndcomm_flush_timeout);
3177 r= ICCopen(); if (r) inndcommfail("connect");
3178 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3179 if (!r) exit(0); /* yay! */
3181 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3182 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3183 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3188 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3189 inndcomm_sentinel_fd= pipefds[0];
3190 assert(inndcomm_sentinel_fd);
3191 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3193 SMS(FLUSHING, 0, why);
3196 /*========== main program ==========*/
3198 static void postfork_inputfile(InputFile *ipf) {
3200 xclose(ipf->fd, "(in child) input file ", ipf->path);
3203 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3204 /* we have no stdio streams that are buffered long-term */
3206 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3209 static void postfork(void) {
3212 xsigsetdefault(SIGTERM);
3213 xsigsetdefault(SIGINT);
3214 xsigsetdefault(SIGPIPE);
3215 if (terminate_sig_flag) raise(terminate_sig_flag);
3217 postfork_inputfile(main_input_file);
3218 postfork_inputfile(flushing_input_file);
3222 conn_closefd(conn,"(in child) ");
3224 postfork_stdio(defer, "defer file ", path_defer);
3227 typedef struct Every Every;
3229 struct timeval interval;
3234 static void every_schedule(Every *e, struct timeval base);
3236 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3239 if (!e->fixed_rate) xgettimeofday(&base);
3240 every_schedule(e, base);
3241 return OOP_CONTINUE;
3244 static void every_schedule(Every *e, struct timeval base) {
3245 struct timeval when;
3246 timeradd(&base, &e->interval, &when);
3247 loop->on_time(loop, when, every_happens, e);
3250 static void every(int interval, int fixed_rate, void (*f)(void)) {
3251 NEW_DECL(Every *,e);
3252 e->interval.tv_sec= interval;
3253 e->interval.tv_usec= 0;
3254 e->fixed_rate= fixed_rate;
3257 xgettimeofday(&now);
3258 every_schedule(e, now);
3261 static void filepoll(void) {
3262 filemon_callback(main_input_file);
3263 filemon_callback(flushing_input_file);
3266 static char *debug_report_ipf(InputFile *ipf) {
3267 if (!ipf) return xasprintf("none");
3269 const char *slash= strrchr(ipf->path,'/');
3270 const char *path= slash ? slash+1 : ipf->path;
3272 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3274 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3275 (long)ipf->offset, ipf->fd,
3276 ipf->rd ? "" : ",!rd",
3277 ipf->skippinglong ? "*skiplong" : "",
3278 ipf->rd && ipf->paused ? "*paused" : "");
3281 static void period(void) {
3282 char *dipf_main= debug_report_ipf(main_input_file);
3283 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3284 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3287 " sms=%s[%d] conns=%d until_connect=%d"
3288 " input_files main:%s flushing:%s backlog:%s[%d]"
3289 " children connecting=%ld inndcomm=%ld"
3291 sms_names[sms], until_flush, conns.count, until_connect,
3292 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3293 (long)connecting_child, (long)inndcomm_child
3297 free(dipf_flushing);
3300 if (until_connect) until_connect--;
3302 inputfile_queue_check_expired(backlog_input_file);
3303 poll_backlog_file();
3304 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3305 statemc_period_poll();
3306 check_assign_articles();
3311 /*========== dumping state ==========*/
3313 static void dump_article_list(FILE *f, const ControlCommand *c,
3314 const ArticleList *al) {
3315 fprintf(f, " count=%d\n", al->count);
3316 if (!c->xval) return;
3318 int i; Article *art;
3319 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3320 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3321 DUMPV("%p", art->,ipf);
3322 DUMPV("%d", art->,missing);
3323 DUMPV("%lu", (unsigned long)art->,offset);
3324 DUMPV("%d", art->,blanklen);
3325 DUMPV("%d", art->,midlen);
3326 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3330 static void dump_input_file(FILE *f, const ControlCommand *c,
3331 InputFile *ipf, const char *wh) {
3332 char *dipf= debug_report_ipf(ipf);
3333 fprintf(f,"input %s %s", wh, dipf);
3337 DUMPV("%d", ipf->,readcount_ok);
3338 DUMPV("%d", ipf->,readcount_blank);
3339 DUMPV("%d", ipf->,readcount_err);
3340 DUMPV("%d", ipf->,count_nooffer_missing);
3344 ArtState state; const char *const *statename;
3345 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3346 #define RC_DUMP_FMT(x) " " #x "=%d"
3347 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3348 fprintf(f,"input %s counts %-11s"
3349 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3351 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3353 fprintf(f,"input %s queue", wh);
3354 dump_article_list(f,c,&ipf->queue);
3360 fprintf(cc->out, "dumping state to %s\n", path_dump);
3361 FILE *f= fopen(path_dump, "w");
3362 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3364 fprintf(f,"general");
3365 DUMPV("%s", sms_names,[sms]);
3366 DUMPV("%d", ,until_flush);
3367 DUMPV("%ld", (long),self_pid);
3368 DUMPV("%p", , defer);
3369 DUMPV("%d", , until_connect);
3370 DUMPV("%d", , until_backlog_nextscan);
3371 DUMPV("%d", , simulate_flush);
3372 fprintf(f,"\nnocheck");
3373 DUMPV("%#.10f", , accept_proportion);
3374 DUMPV("%d", , nocheck);
3375 DUMPV("%d", , nocheck_reported);
3378 fprintf(f,"special");
3379 DUMPV("%ld", (long),connecting_child);
3380 DUMPV("%d", , connecting_fdpass_sock);
3381 DUMPV("%d", , control_master);
3384 fprintf(f,"filemon ");
3385 filemon_method_dump_info(f);
3387 dump_input_file(f,c, main_input_file, "main" );
3388 dump_input_file(f,c, flushing_input_file, "flushing");
3389 dump_input_file(f,c, backlog_input_file, "backlog" );
3391 fprintf(f,"conns count=%d\n", conns.count);
3396 fprintf(f,"C%d",conn->fd);
3397 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3398 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3399 DUMPV("%d",conn->,since_activity);
3402 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3403 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3404 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3406 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3407 for (i=0; i<conn->xmitu; i++) {
3408 const struct iovec *iv= &conn->xmit[i];
3409 const XmitDetails *xd= &conn->xmitd[i];
3412 case xk_Const: dinfo= xasprintf("Const"); break;
3413 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3417 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3418 sanitise(iv->iov_base, iv->iov_len));
3424 DUMPV("%s", , path_lock);
3425 DUMPV("%s", , path_flushing);
3426 DUMPV("%s", , path_defer);
3427 DUMPV("%s", , path_control);
3428 DUMPV("%s", , path_dump);
3429 DUMPV("%s", , globpat_backlog);
3432 if (!!ferror(f) + !!fclose(f)) {
3433 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3438 /*========== option parsing ==========*/
3440 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3441 static void vbadusage(const char *fmt, va_list al) {
3442 char *m= xvasprintf(fmt,al);
3443 fprintf(stderr, "bad usage: %s\n"
3444 "say --help for help, or read the manpage\n",
3447 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3451 /*---------- generic option parser ----------*/
3453 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3454 static void badusage(const char *fmt, ...) {
3461 of_seconds= 001000u,
3462 of_boolean= 002000u,
3465 typedef struct Option Option;
3466 typedef void OptionParser(const Option*, const char *val);
3470 const char *lng, *formarg;
3476 static void parse_options(const Option *options, char ***argvp) {
3477 /* on return *argvp is first non-option arg; argc is not updated */
3480 const char *arg= *++(*argvp);
3482 if (*arg != '-') break;
3483 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3485 while ((a= *++arg)) {
3489 char *equals= strchr(arg,'=');
3490 int len= equals ? (equals - arg) : strlen(arg);
3491 for (o=options; o->shrt || o->lng; o++)
3492 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3494 badusage("unknown long option --%s",arg);
3497 if (equals) badusage("option --%s does not take a value",o->lng);
3499 } else if (equals) {
3503 if (!arg) badusage("option --%s needs a value for %s",
3504 o->lng, o->formarg);
3507 break; /* eaten the whole argument now */
3509 for (o=options; o->shrt || o->lng; o++)
3512 badusage("unknown short option -%c",a);
3519 if (!arg) badusage("option -%c needs a value for %s",
3520 o->shrt, o->formarg);
3523 break; /* eaten the whole argument now */
3529 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3531 static void print_options(const Option *options, FILE *f) {
3533 for (o=options; o->shrt || o->lng; o++) {
3534 char shrt[2] = { o->shrt, 0 };
3535 char *optspec= xasprintf("%s%s%s%s%s",
3536 o->shrt ? "-" : "", shrt,
3537 o->shrt && o->lng ? "|" : "",
3538 DELIMPERHAPS("--", o->lng));
3539 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3544 /*---------- specific option types ----------*/
3546 static void op_integer(const Option *o, const char *val) {
3549 unsigned long ul= strtoul(val,&ep,10);
3550 if (*ep || ep==val || errno || ul>INT_MAX)
3551 badusage("bad integer value for %s",o->lng);
3552 int *store= o->store;
3556 static void op_double(const Option *o, const char *val) {
3557 int *store= o->store;
3560 *store= strtod(val, &ep);
3561 if (*ep || ep==val || errno)
3562 badusage("bad floating point value for %s",o->lng);
3565 static void op_string(const Option *o, const char *val) {
3566 const char **store= o->store;
3570 static void op_seconds(const Option *o, const char *val) {
3571 int *store= o->store;
3575 double v= strtod(val,&ep);
3576 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3578 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3579 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3580 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3581 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3582 else if (!strcmp(ep,"das")) unit= 10;
3583 else if (!strcmp(ep,"hs")) unit= 100;
3584 else if (!strcmp(ep,"ks")) unit= 1000;
3585 else if (!strcmp(ep,"Ms")) unit= 1000000;
3586 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3590 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3594 static void op_setint(const Option *o, const char *val) {
3595 int *store= o->store;
3599 /*---------- specific options ----------*/
3601 static void help(const Option *o, const char *val);
3603 static const Option innduct_options[]= {
3604 {'f',"feedfile", "F", &feedfile, op_string },
3605 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3606 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3607 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3608 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3609 {'C',"inndconf", "F", &inndconffile, op_string },
3610 {'P',"port", "PORT", &port, op_integer },
3611 {0,"ctrl-sock-dir", 0, &realsockdir, op_string },
3612 {0,"help", 0, 0, help },
3614 {0,"max-connections", "N", &max_connections, op_integer },
3615 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3616 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3617 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3618 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3620 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3621 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3622 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3624 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3625 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3627 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3628 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3629 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3630 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3631 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3632 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3633 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3635 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3636 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3641 static void printusage(FILE *f) {
3642 fputs("usage: innduct [options] site [fqdn]\n"
3643 "available options are:\n", f);
3644 print_options(innduct_options, f);
3647 static void help(const Option *o, const char *val) {
3649 if (ferror(stdout) || fflush(stdout)) {
3650 perror("innduct: writing help");
3656 static void convert_to_periods_rndup(int *store) {
3657 *store += period_seconds-1;
3658 *store /= period_seconds;
3661 int main(int argc, char **argv) {
3667 parse_options(innduct_options, &argv);
3672 if (!sitename) badusage("need site name argument");
3673 remote_host= *argv++;
3674 if (*argv) badusage("too many non-option arguments");
3678 int r= innconf_read(inndconffile);
3679 if (!r) badusage("could not read inn.conf (more info on stderr)");
3681 if (!remote_host) remote_host= sitename;
3683 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3684 badusage("nocheck threshold percentage must be between 0..100");
3685 nocheck_thresh *= 0.01;
3687 if (nocheck_decay < 0.1)
3688 badusage("nocheck decay articles must be at least 0.1");
3689 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3691 convert_to_periods_rndup(&reconnect_delay_periods);
3692 convert_to_periods_rndup(&flushfail_retry_periods);
3693 convert_to_periods_rndup(&backlog_retry_minperiods);
3694 convert_to_periods_rndup(&backlog_spontrescan_periods);
3695 convert_to_periods_rndup(&spontaneous_flush_periods);
3696 convert_to_periods_rndup(&max_separated_periods);
3697 convert_to_periods_rndup(&need_activity_periods);
3699 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3700 badusage("bad input data ratio must be between 0..100");
3701 max_bad_data_ratio *= 0.01;
3704 feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3705 } else if (!feedfile[0]) {
3706 badusage("feed filename must be nonempty");
3707 } else if (feedfile[strlen(feedfile)-1]=='/') {
3708 feedfile= xasprintf("%s%s",feedfile,sitename);
3711 if (max_queue_per_ipf<0)
3712 max_queue_per_ipf= max_queue_per_conn * 2;
3714 const char *feedfile_forbidden= "?*[~#";
3716 while ((c= *feedfile_forbidden++))
3717 if (strchr(feedfile, c))
3718 badusage("feed filename may not contain metacharacter %c",c);
3722 path_lock= xasprintf("%s_lock", feedfile);
3723 path_flushing= xasprintf("%s_flushing", feedfile);
3724 path_defer= xasprintf("%s_defer", feedfile);
3725 path_control= xasprintf("%s_control", feedfile);
3726 path_dump= xasprintf("%s_dump", feedfile);
3727 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3729 oop_source_sys *sysloop= oop_sys_new();
3730 if (!sysloop) sysdie("could not create liboop event loop");
3731 loop= (oop_source*)sysloop;
3735 if (become_daemon) {
3737 for (i=3; i<255; i++)
3738 /* do this now before we open syslog, etc. */
3740 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3742 int null= open("/dev/null",O_RDWR);
3743 if (null<0) sysfatal("failed to open /dev/null");
3747 xclose(null, "/dev/null original fd",0);
3749 pid_t child1= xfork("daemonise first fork");
3750 if (child1) _exit(0);
3752 pid_t sid= setsid();
3753 if (sid != child1) sysfatal("setsid failed");
3755 pid_t child2= xfork("daemonise second fork");
3756 if (child2) _exit(0);
3760 if (self_pid==-1) sysdie("getpid");
3769 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3770 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3779 notice("filemon: suppressed by command line option, polling");
3781 filemon_ok= filemon_method_init();
3783 warn("filemon: no file monitoring available, polling");
3786 every(filepoll_seconds,0,filepoll);
3788 every(period_seconds,1,period);
3794 void *run= oop_sys_run(sysloop);
3795 assert(run == OOP_ERROR);
3796 sysdie("event loop failed");