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(void); /* => Flushing,FLUSHING, ret 1; or ret 0 */
328 static void article_done(Article *art, int whichcount);
330 static void check_assign_articles(void);
331 static void queue_check_input_done(void);
332 static void check_reading_pause_resume(InputFile *ipf);
334 static void statemc_check_flushing_done(void);
335 static void statemc_check_backlog_done(void);
337 static void postfork(void);
338 static void period(void);
340 static void open_defer(void);
341 static void close_defer(void);
342 static void search_backlog_file(void);
343 static void preterminate(void);
344 static void raise_default(int signo) NORET;
345 static char *debug_report_ipf(InputFile *ipf);
347 static void inputfile_reading_start(InputFile *ipf);
348 static void inputfile_reading_stop(InputFile *ipf);
349 static void inputfile_reading_pause(InputFile *ipf);
350 static void inputfile_reading_resume(InputFile *ipf);
351 /* pause and resume are idempotent, and no-op if not done _reading_start */
353 static void filemon_start(InputFile *ipf);
354 static void filemon_stop(InputFile *ipf);
355 static void filemon_callback(InputFile *ipf);
357 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
358 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
360 static const oop_rd_style peer_rd_style;
361 static oop_rd_call peer_rd_err, peer_rd_ok;
363 /*----- configuration options -----*/
364 /* when changing defaults, remember to update the manpage */
366 static const char *sitename, *remote_host;
367 static const char *feedfile, *realsockdir="/tmp/innduct.control";
368 static int quiet_multiple=0;
369 static int become_daemon=1, try_filemon=1;
370 static int try_stream=1;
372 static const char *inndconffile;
374 static int max_connections=10;
375 static int max_queue_per_conn=200;
376 static int target_max_feedfile_size=100000;
377 static int period_seconds=60;
378 static int filepoll_seconds=5;
379 static int max_queue_per_ipf=-1;
381 static int connection_setup_timeout=200;
382 static int inndcomm_flush_timeout=100;
384 static double nocheck_thresh= 95.0; /* converted from percentage by main */
385 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
387 /* all these are initialised to seconds, and converted to periods in main */
388 static int reconnect_delay_periods=1000;
389 static int flushfail_retry_periods=1000;
390 static int backlog_retry_minperiods=50;
391 static int backlog_spontrescan_periods=300;
392 static int spontaneous_flush_periods=100000;
393 static int max_separated_periods=2000;
394 static int need_activity_periods=1000;
396 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
397 static int max_bad_data_initial= 30;
398 /* in one corrupt 4096-byte block the number of newlines has
399 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
402 /*----- statistics -----*/
404 typedef enum { /* in queue in conn->sent */
405 art_Unchecked, /* not checked, not sent checking */
406 art_Wanted, /* checked, wanted sent body as requested */
407 art_Unsolicited, /* - sent body without check */
411 static const char *const artstate_names[]=
412 { "Unchecked", "Wanted", "Unsolicited", 0 };
414 #define RESULT_COUNTS(RCS,RCN) \
423 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
424 #define RCI_TRIPLE_VALS_BASE(counts,x) \
425 counts[art_Unchecked] x \
426 + counts[art_Wanted] x \
427 + counts[art_Unsolicited] x, \
428 counts[art_Unchecked] x \
429 , counts[art_Wanted] x \
430 , counts[art_Unsolicited] x
433 #define RC_INDEX(x) RC_##x,
434 RESULT_COUNTS(RC_INDEX, RC_INDEX)
439 /*----- transmission buffers -----*/
455 /*----- core operational data structure types -----*/
458 /* This is also an instance of struct oop_readable */
459 struct oop_readable readable; /* first */
460 oop_readable_call *readable_callback;
461 void *readable_callback_user;
464 Filemon_Perfile *filemon;
466 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
468 int skippinglong, paused;
471 long inprogress; /* includes queue.count and also articles in conns */
472 long autodefer; /* -1 means not doing autodefer */
474 int counts[art_MaxState][RCI_max];
475 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
490 #define SMS_LIST(X) \
498 enum StateMachineState {
499 #define SMS_DEF_ENUM(s) sm_##s,
500 SMS_LIST(SMS_DEF_ENUM)
503 static const char *sms_names[]= {
504 #define SMS_DEF_NAME(s) #s ,
505 SMS_LIST(SMS_DEF_NAME)
511 int fd; /* may be 0, meaning closed (during construction/destruction) */
512 oop_read *rd; /* likewise */
513 int max_queue, stream, quitting;
514 int since_activity; /* periods */
515 ArticleList waiting; /* not yet told peer */
516 ArticleList priority; /* peer says send it now */
517 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
518 struct iovec xmit[CONNIOVS];
519 XmitDetails xmitd[CONNIOVS];
524 /*----- general operational variables -----*/
526 /* main initialises */
527 static oop_source *loop;
528 static ConnList conns;
529 static char *path_lock, *path_flushing, *path_defer;
530 static char *path_control, *path_dump;
531 static char *globpat_backlog;
532 static pid_t self_pid;
534 /* statemc_init initialises */
535 static StateMachineState sms;
536 static int until_flush;
537 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
540 /* initialisation to 0 is good */
541 static int until_connect, until_backlog_nextscan;
542 static double accept_proportion;
543 static int nocheck, nocheck_reported, in_child;
545 /* for simulation, debugging, etc. */
546 int simulate_flush= -1;
548 /*========== logging ==========*/
550 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
551 static void logcore(int sysloglevel, const char *fmt, ...) {
554 vsyslog(sysloglevel,fmt,al);
556 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
557 vfprintf(stderr,fmt,al);
563 static void logv(int sysloglevel, const char *pfx, int errnoval,
564 const char *fmt, va_list al) PRINTF(5,0);
565 static void logv(int sysloglevel, const char *pfx, int errnoval,
566 const char *fmt, va_list al) {
567 char msgbuf[256]; /* NB do not call xvasprintf here or you'll recurse */
568 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
569 msgbuf[sizeof(msgbuf)-1]= 0;
571 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
572 sysloglevel= LOG_ERR; /* run by wrong user, probably */
574 logcore(sysloglevel, "<%s>%s: %s%s%s",
575 sitename, pfx, msgbuf,
576 errnoval>=0 ? ": " : "",
577 errnoval>=0 ? strerror(errnoval) : "");
580 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
581 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
582 static void fn(const char *fmt, ...) { \
585 logv(sysloglevel, pfx, err, fmt, al); \
589 #define logwrap(fn, pfx, sysloglevel, err) \
590 static void fn(const char *fmt, ...) PRINTF(1,2); \
591 static void fn(const char *fmt, ...) { \
593 logv(sysloglevel, pfx, err, fmt, al); \
597 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
598 diewrap(die, " critical", LOG_CRIT, -1, 16);
600 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
601 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
603 logwrap(syswarn, " warning", LOG_WARNING, errno);
604 logwrap(warn, " warning", LOG_WARNING, -1);
606 logwrap(notice, " notice", LOG_NOTICE, -1);
607 logwrap(info, " info", LOG_INFO, -1);
608 logwrap(debug, " debug", LOG_DEBUG, -1);
611 /*========== utility functions etc. ==========*/
613 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
614 static char *xvasprintf(const char *fmt, va_list al) {
616 int rc= vasprintf(&str,fmt,al);
617 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
620 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
621 static char *xasprintf(const char *fmt, ...) {
623 char *str= xvasprintf(fmt,al);
628 static int close_perhaps(int *fd) {
629 if (*fd <= 0) return 0;
634 static void xclose(int fd, const char *what, const char *what2) {
636 if (r) sysdie("close %s%s",what,what2?what2:"");
638 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
639 if (*fd <= 0) return;
640 xclose(*fd,what,what2);
644 static pid_t xfork(const char *what) {
648 if (child==-1) sysfatal("cannot fork for %s",what);
649 debug("forked %s %ld", what, (unsigned long)child);
650 if (!child) postfork();
654 static void on_fd_read_except(int fd, oop_call_fd callback) {
655 loop->on_fd(loop, fd, OOP_READ, callback, 0);
656 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
658 static void cancel_fd_read_except(int fd) {
659 loop->cancel_fd(loop, fd, OOP_READ);
660 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
663 static void report_child_status(const char *what, int status) {
664 if (WIFEXITED(status)) {
665 int es= WEXITSTATUS(status);
667 warn("%s: child died with error exit status %d", what, es);
668 } else if (WIFSIGNALED(status)) {
669 int sig= WTERMSIG(status);
670 const char *sigstr= strsignal(sig);
671 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
673 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
675 warn("%s: child died due to unknown fatal signal %d%s",
676 what, sig, coredump);
678 warn("%s: child died with unknown wait status %d", what,status);
682 static int xwaitpid(pid_t *pid, const char *what) {
685 int r= kill(*pid, SIGKILL);
686 if (r) sysdie("cannot kill %s child", what);
688 pid_t got= waitpid(*pid, &status, 0);
689 if (got==-1) sysdie("cannot reap %s child", what);
690 if (got==0) die("cannot reap %s child", what);
697 static void *zxmalloc(size_t sz) {
698 void *p= xmalloc(sz);
703 static void xunlink(const char *path, const char *what) {
705 if (r) sysdie("can't unlink %s %s", path, what);
708 static time_t xtime(void) {
710 if (now==-1) sysdie("time(2) failed");
714 static void xsigaction(int signo, const struct sigaction *sa) {
715 int r= sigaction(signo,sa,0);
716 if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
719 static void xsigsetdefault(int signo) {
721 memset(&sa,0,sizeof(sa));
722 sa.sa_handler= SIG_DFL;
723 xsigaction(signo,&sa);
726 static void xgettimeofday(struct timeval *tv_r) {
727 int r= gettimeofday(tv_r,0);
728 if (r) sysdie("gettimeofday(2) failed");
731 static void xsetnonblock(int fd, int nonblocking) {
732 int errnoval= oop_fd_nonblock(fd, nonblocking);
733 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
736 static void check_isreg(const struct stat *stab, const char *path,
738 if (!S_ISREG(stab->st_mode))
739 die("%s %s not a plain file (mode 0%lo)",
740 what, path, (unsigned long)stab->st_mode);
743 static void xfstat(int fd, struct stat *stab_r, const char *what) {
744 int r= fstat(fd, stab_r);
745 if (r) sysdie("could not fstat %s", what);
748 static void xfstat_isreg(int fd, struct stat *stab_r,
749 const char *path, const char *what) {
750 xfstat(fd, stab_r, what);
751 check_isreg(stab_r, path, what);
754 static void xlstat_isreg(const char *path, struct stat *stab,
755 int *enoent_r /* 0 means ENOENT is fatal */,
757 int r= lstat(path, stab);
759 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
760 sysdie("could not lstat %s %s", what, path);
762 if (enoent_r) *enoent_r= 0;
763 check_isreg(stab, path, what);
766 static int samefile(const struct stat *a, const struct stat *b) {
767 assert(S_ISREG(a->st_mode));
768 assert(S_ISREG(b->st_mode));
769 return (a->st_ino == b->st_ino &&
770 a->st_dev == b->st_dev);
773 static char *sanitise(const char *input, int len) {
774 static char sanibuf[100]; /* returns pointer to this buffer! */
776 const char *p= input;
777 const char *endp= len>=0 ? input+len : 0;
781 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
782 int c= (!endp || p<endp) ? *p++ : 0;
783 if (!c) { *q++= '\''; *q=0; break; }
784 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
785 sprintf(q,"\\x%02x",c);
791 static int isewouldblock(int errnoval) {
792 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
795 /*========== command and control connections ==========*/
797 static int control_master;
799 typedef struct ControlConn ControlConn;
801 void (*destroy)(ControlConn*);
807 struct sockaddr_un un;
812 static const oop_rd_style control_rd_style= {
813 OOP_RD_DELIM_STRIP, '\n',
815 OOP_RD_SHORTREC_FORBID
818 static void control_destroy(ControlConn *cc) {
822 static void control_checkouterr(ControlConn *cc /* may destroy*/) {
823 if (ferror(cc->out) | fflush(cc->out)) {
824 info("CTRL%d write error %s", cc->fd, strerror(errno));
829 static void control_prompt(ControlConn *cc /* may destroy*/) {
830 fprintf(cc->out, "%s| ", sitename);
831 control_checkouterr(cc);
834 struct ControlCommand {
836 void (*f)(ControlConn *cc, const ControlCommand *ccmd,
837 const char *arg, size_t argsz);
842 static const ControlCommand control_commands[];
845 static void ccmd_##wh(ControlConn *cc, const ControlCommand *c, \
846 const char *arg, size_t argsz)
849 fputs("commands:\n", cc->out);
850 const ControlCommand *ccmd;
851 for (ccmd=control_commands; ccmd->cmd; ccmd++)
852 fprintf(cc->out, " %s\n", ccmd->cmd);
853 fputs("NB: permissible arguments are not shown above."
854 " Not all commands listed are safe. See innduct(8).\n", cc->out);
858 int ok= trigger_flush_ok();
859 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
864 notice("terminating (CTRL%d)",cc->fd);
865 raise_default(SIGTERM);
871 /* messing with our head: */
872 CCMD(period) { period(); }
873 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
874 CCMD(setint) { *(int*)c->xdata= c->xval; }
875 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
877 static const ControlCommand control_commands[]= {
879 { "flush", ccmd_flush },
880 { "stop", ccmd_stop },
881 { "dump q", ccmd_dump, 0,0 },
882 { "dump a", ccmd_dump, 0,1 },
884 { "p", ccmd_period },
886 #define POKES(cmd,func) \
887 { cmd "flush", func, &until_flush, 1 }, \
888 { cmd "conn", func, &until_connect, 0 }, \
889 { cmd "blscan", func, &until_backlog_nextscan, 0 },
890 POKES("next ", ccmd_setint)
891 POKES("prod ", ccmd_setint_period)
893 { "pretend flush", ccmd_setintarg, &simulate_flush },
894 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
898 static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
899 const char *errmsg, int errnoval,
900 const char *data, size_t recsz, void *cc_v) {
901 ControlConn *cc= cc_v;
904 info("CTRL%d closed", cc->fd);
909 if (recsz == 0) goto prompt;
911 const ControlCommand *ccmd;
912 for (ccmd=control_commands; ccmd->cmd; ccmd++) {
913 int l= strlen(ccmd->cmd);
914 if (recsz < l) continue;
915 if (recsz > l && data[l] != ' ') continue;
916 if (memcmp(data, ccmd->cmd, l)) continue;
918 int argl= (int)recsz - (l+1);
919 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
923 fputs("unknown command; h for help\n", cc->out);
930 static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
931 const char *errmsg, int errnoval,
932 const char *data, size_t recsz, void *cc_v) {
933 ControlConn *cc= cc_v;
935 info("CTRL%d read error %s", cc->fd, errmsg);
940 static int control_conn_startup(ControlConn *cc /* may destroy*/,
942 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
943 if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
945 int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
948 if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
950 info("CTRL%d %s ready", cc->fd, how);
955 static void control_stdio_destroy(ControlConn *cc) {
957 oop_rd_cancel(cc->rd);
958 errno= oop_rd_delete_tidy(cc->rd);
959 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
964 static void control_stdio(void) {
965 NEW_DECL(ControlConn *,cc);
966 cc->destroy= control_stdio_destroy;
970 int r= control_conn_startup(cc,"stdio");
971 if (r) cc->destroy(cc);
974 static void control_accepted_destroy(ControlConn *cc) {
976 oop_rd_cancel(cc->rd);
977 oop_rd_delete_kill(cc->rd);
979 if (cc->out) { fclose(cc->out); cc->fd=0; }
980 close_perhaps(&cc->fd);
984 static void *control_master_readable(oop_source *lp, int master,
985 oop_event ev, void *u) {
986 NEW_DECL(ControlConn *,cc);
987 cc->destroy= control_accepted_destroy;
989 cc->salen= sizeof(cc->sa);
990 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
991 if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
993 cc->out= fdopen(cc->fd, "w");
994 if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
996 int r= control_conn_startup(cc, "accepted");
1003 return OOP_CONTINUE;
1006 #define NOCONTROL(...) do{ \
1007 syswarn("no control socket, because failed to " __VA_ARGS__); \
1011 static void control_init(void) {
1016 struct sockaddr_un un;
1019 memset(&sa,0,sizeof(sa));
1020 int maxlen= sizeof(sa.un.sun_path);
1022 int reallen= readlink(path_control, sa.un.sun_path, maxlen);
1024 if (errno != ENOENT)
1025 NOCONTROL("readlink control socket symlink path %s", path_control);
1027 if (reallen >= maxlen) {
1028 debug("control socket symlink path too long (r=%d)",reallen);
1029 xunlink(path_control, "old (overlong) control socket symlink");
1035 int r= lstat(realsockdir,&stab);
1037 if (errno != ENOENT) NOCONTROL("lstat real socket dir %s", realsockdir);
1039 r= mkdir(realsockdir, 0700);
1040 if (r) NOCONTROL("mkdir real socket dir %s", realsockdir);
1043 uid_t self= geteuid();
1044 if (!S_ISDIR(stab.st_mode) ||
1045 stab.st_uid != self ||
1046 stab.st_mode & 0007) {
1047 warn("no control socket, because real socket directory"
1048 " is somehow wrong (ISDIR=%d, uid=%lu (exp.%lu), mode %lo)",
1049 !!S_ISDIR(stab.st_mode),
1050 (unsigned long)stab.st_uid, (unsigned long)self,
1051 (unsigned long)stab.st_mode & 0777UL);
1056 real= xasprintf("%s/s%lx.%lx", realsockdir,
1057 (unsigned long)xtime(), (unsigned long)self_pid);
1058 int reallen= strlen(real);
1060 if (reallen >= maxlen) {
1061 warn("no control socket, because tmpnam gave overly-long path"
1065 r= symlink(real, path_control);
1066 if (r) NOCONTROL("make control socket path %s a symlink to real"
1067 " socket path %s", path_control, real);
1068 memcpy(sa.un.sun_path, real, reallen);
1071 int r= unlink(sa.un.sun_path);
1072 if (r && errno!=ENOENT)
1073 NOCONTROL("remove old real socket %s", sa.un.sun_path);
1075 control_master= socket(PF_UNIX, SOCK_STREAM, 0);
1076 if (control_master<0) NOCONTROL("create new control socket");
1078 sa.un.sun_family= AF_UNIX;
1079 int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
1080 r= bind(control_master, &sa.sa, sl);
1081 if (r) NOCONTROL("bind to real socket path %s", sa.un.sun_path);
1083 r= listen(control_master, 5);
1084 if (r) NOCONTROL("listen");
1086 xsetnonblock(control_master, 1);
1088 loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
1089 info("control socket ok, real path %s", sa.un.sun_path);
1095 xclose_perhaps(&control_master, "control master",0);
1099 /*========== management of connections ==========*/
1101 static void conn_closefd(Conn *conn, const char *msgprefix) {
1102 int r= close_perhaps(&conn->fd);
1103 if (r) info("C%d %serror closing socket: %s",
1104 conn->fd, msgprefix, strerror(errno));
1107 static void conn_dispose(Conn *conn) {
1110 oop_rd_cancel(conn->rd);
1111 oop_rd_delete_kill(conn->rd);
1115 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1116 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1118 conn_closefd(conn,"");
1120 until_connect= reconnect_delay_periods;
1123 static void *conn_exception(oop_source *lp, int fd,
1124 oop_event ev, void *conn_v) {
1127 assert(fd == conn->fd);
1128 assert(ev == OOP_EXCEPTION);
1129 int r= read(conn->fd, &ch, 1);
1130 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1131 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1132 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1133 return OOP_CONTINUE;
1136 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1137 int requeue[art_MaxState];
1138 memset(requeue,0,sizeof(requeue));
1142 while ((art= LIST_REMHEAD(conn->priority)))
1143 LIST_ADDTAIL(art->ipf->queue, art);
1145 while ((art= LIST_REMHEAD(conn->waiting)))
1146 LIST_ADDTAIL(art->ipf->queue, art);
1148 while ((art= LIST_REMHEAD(conn->sent))) {
1149 requeue[art->state]++;
1150 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1151 LIST_ADDTAIL(art->ipf->queue,art);
1152 check_reading_pause_resume(art->ipf);
1157 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1160 char *m= xvasprintf(fmt,al);
1161 warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1162 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1165 LIST_REMOVE(conns,conn);
1167 check_assign_articles();
1170 static void connfail(Conn *conn, const char *fmt, ...) {
1173 vconnfail(conn,fmt,al);
1177 static void check_idle_conns(void) {
1180 conn->since_activity++;
1183 if (conn->since_activity <= need_activity_periods) continue;
1185 /* We need to shut this down */
1187 connfail(conn,"timed out waiting for response to QUIT");
1188 else if (conn->sent.count)
1189 connfail(conn,"timed out waiting for responses");
1190 else if (conn->waiting.count || conn->priority.count)
1191 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1192 else if (conn->xmitu)
1193 connfail(conn,"peer has been sending responses"
1194 " before receiving our commands!");
1196 static const char quitcmd[]= "QUIT\r\n";
1197 int todo= sizeof(quitcmd)-1;
1198 const char *p= quitcmd;
1200 int r= write(conn->fd, p, todo);
1202 if (isewouldblock(errno))
1203 connfail(conn, "blocked writing QUIT to idle connection");
1205 connfail(conn, "failed to write QUIT to idle connection: %s",
1213 conn->since_activity= 0;
1214 debug("C%d is idle, quitting", conn->fd);
1223 /*---------- making new connections ----------*/
1225 static pid_t connecting_child;
1226 static int connecting_fdpass_sock;
1228 static void connect_attempt_discard(void) {
1229 if (connecting_child) {
1230 int status= xwaitpid(&connecting_child, "connect");
1231 if (!(WIFEXITED(status) ||
1232 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1233 report_child_status("connect", status);
1235 if (connecting_fdpass_sock) {
1236 cancel_fd_read_except(connecting_fdpass_sock);
1237 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1241 #define PREP_DECL_MSG_CMSG(msg) \
1243 struct iovec msgiov; \
1244 msgiov.iov_base= &msgbyte; \
1245 msgiov.iov_len= 1; \
1246 struct msghdr msg; \
1247 memset(&msg,0,sizeof(msg)); \
1248 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1249 msg.msg_iov= &msgiov; \
1250 msg.msg_iovlen= 1; \
1251 msg.msg_control= msg##cbuf; \
1252 msg.msg_controllen= sizeof(msg##cbuf);
1254 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1257 assert(fd == connecting_fdpass_sock);
1259 PREP_DECL_MSG_CMSG(msg);
1261 ssize_t rs= recvmsg(fd, &msg, 0);
1263 if (isewouldblock(errno)) return OOP_CONTINUE;
1264 syswarn("failed to read socket from connecting child");
1269 LIST_INIT(conn->waiting);
1270 LIST_INIT(conn->priority);
1271 LIST_INIT(conn->sent);
1273 struct cmsghdr *h= 0;
1274 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1276 int status= xwaitpid(&connecting_child, "connect child (broken)");
1278 if (WIFEXITED(status)) {
1279 if (WEXITSTATUS(status) != 0 &&
1280 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1281 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1282 /* child already reported the problem */;
1284 if (e == OOP_EXCEPTION)
1285 warn("connect: connection child exited code %d but"
1286 " unexpected exception on fdpass socket",
1287 WEXITSTATUS(status));
1289 warn("connect: connection child exited code %d but"
1291 WEXITSTATUS(status), (int)rs);
1293 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1294 warn("connect: connection attempt timed out");
1296 report_child_status("connect", status);
1301 #define CHK(field, val) \
1302 if (h->cmsg_##field != val) { \
1303 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1304 h->cmsg_##field, val); \
1307 CHK(level, SOL_SOCKET);
1308 CHK(type, SCM_RIGHTS);
1309 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1312 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1314 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1317 pid_t got= waitpid(connecting_child, &status, 0);
1318 if (got==-1) sysdie("connect: real wait for child");
1319 assert(got == connecting_child);
1320 connecting_child= 0;
1322 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1323 int es= WEXITSTATUS(status);
1325 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1326 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1328 fatal("connect: child gave unexpected exit status %d", es);
1332 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1334 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1335 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1336 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1337 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1339 &peer_rd_err, conn);
1340 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1342 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1343 LIST_ADDHEAD(conns, conn);
1345 connect_attempt_discard();
1346 check_assign_articles();
1347 return OOP_CONTINUE;
1351 connect_attempt_discard();
1352 return OOP_CONTINUE;
1355 static int allow_connect_start(void) {
1356 return conns.count < max_connections
1357 && !connecting_child
1361 static void connect_start(void) {
1362 assert(!connecting_child);
1363 assert(!connecting_fdpass_sock);
1365 info("starting connection attempt");
1368 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1369 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1371 connecting_child= xfork("connection");
1373 if (!connecting_child) {
1374 FILE *cn_from, *cn_to;
1375 char buf[NNTP_STRLEN+100];
1376 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1378 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1380 alarm(connection_setup_timeout);
1381 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1385 unsigned char c= buf[l-1];
1386 if (!isspace(c)) break;
1387 if (c=='\n' || c=='\r') stripped=1;
1391 sysfatal("connect: connection attempt failed");
1394 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1398 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1399 sysfatal("connect: authentication failed");
1401 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1403 sysfatal("connect: could not send MODE STREAM");
1404 buf[sizeof(buf)-1]= 0;
1405 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1406 if (ferror(cn_from))
1407 sysfatal("connect: could not read response to MODE STREAM");
1409 fatal("connect: connection close in response to MODE STREAM");
1414 fatal("connect: response to MODE STREAM is too long: %.100s...",
1416 l--; if (l>0 && buf[l-1]=='\r') l--;
1419 int rcode= strtoul(buf,&ep,10);
1421 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1425 exitstatus= CONNCHILD_ESTATUS_STREAM;
1431 warn("connect: unexpected response to MODE STREAM: %.50s",
1437 int fd= fileno(cn_from);
1439 PREP_DECL_MSG_CMSG(msg);
1440 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1441 cmsg->cmsg_level= SOL_SOCKET;
1442 cmsg->cmsg_type= SCM_RIGHTS;
1443 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1444 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1446 msg.msg_controllen= cmsg->cmsg_len;
1447 r= sendmsg(socks[1], &msg, 0);
1448 if (r<0) sysdie("sendmsg failed for new connection");
1449 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1454 xclose(socks[1], "connecting fdpass child's socket",0);
1455 connecting_fdpass_sock= socks[0];
1456 xsetnonblock(connecting_fdpass_sock, 1);
1457 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1460 /*---------- assigning articles to conns, and transmitting ----------*/
1462 static Article *dequeue_from(int peek, InputFile *ipf) {
1464 if (peek) return LIST_HEAD(ipf->queue);
1466 Article *art= LIST_REMHEAD(ipf->queue);
1468 check_reading_pause_resume(ipf);
1472 static Article *dequeue(int peek) {
1474 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1475 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1476 art= dequeue_from(peek, main_input_file); if (art) return art;
1480 static void check_assign_articles(void) {
1486 int spare=0, inqueue=0;
1488 /* Find a connection to offer this article. We prefer a busy
1489 * connection to an idle one, provided it's not full. We take the
1490 * first (oldest) and since that's stable, it will mean we fill up
1491 * connections in order. That way if we have too many
1492 * connections, the spare ones will go away eventually.
1495 if (walk->quitting) continue;
1496 inqueue= walk->sent.count + walk->priority.count
1497 + walk->waiting.count;
1498 spare= walk->max_queue - inqueue;
1499 assert(inqueue <= max_queue_per_conn);
1501 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1502 else if (spare>0) /*working*/ { use= walk; break; }
1505 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1507 Article *art= dequeue(0);
1509 LIST_ADDTAIL(use->waiting, art);
1512 conn_maybe_write(use);
1513 } else if (allow_connect_start()) {
1514 until_connect= reconnect_delay_periods;
1523 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1524 conn_maybe_write(u);
1525 return OOP_CONTINUE;
1528 static void conn_maybe_write(Conn *conn) {
1530 conn_make_some_xmits(conn);
1532 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1536 void *rp= conn_write_some_xmits(conn);
1537 if (rp==OOP_CONTINUE) {
1538 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1540 } else if (rp==OOP_HALT) {
1543 /* transmitted everything */
1550 /*---------- expiry, flow control and deferral ----------*/
1553 * flow control notes
1554 * to ensure articles go away eventually
1555 * separate queue for each input file
1557 * every period, check head of backlog queue for expiry with SMretrieve
1558 * if too old: discard, and check next article
1559 * also check every backlog article as we read it
1561 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1562 * one-off: eat queued articles from flushing and write them to defer
1563 * one-off: connfail all connections which have any articles from flushing
1564 * newly read articles from flushing go straight to defer
1565 * this should take care of it and get us out of this state
1566 * to avoid filling up ram needlessly
1568 * limit number of queued articles for each ipf
1569 * pause/resume inputfile tailing
1572 static void check_reading_pause_resume(InputFile *ipf) {
1573 if (ipf->queue.count >= max_queue_per_ipf)
1574 inputfile_reading_pause(ipf);
1576 inputfile_reading_resume(ipf);
1579 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1581 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1583 sysfatal("write to defer file %s",path_defer);
1584 article_done(art, whichcount);
1587 static int article_check_expired(Article *art /* must be queued, not conn */) {
1588 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1589 if (artdata) { SMfreearticle(artdata); return 0; }
1591 LIST_REMOVE(art->ipf->queue, art);
1593 art->ipf->count_nooffer_missing++;
1594 article_done(art,-1);
1598 static void inputfile_queue_check_expired(InputFile *ipf) {
1602 Article *art= LIST_HEAD(ipf->queue);
1603 int exp= article_check_expired(art);
1606 check_reading_pause_resume(ipf);
1609 static void article_autodefer(InputFile *ipf, Article *art) {
1611 article_defer(art,-1);
1614 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1616 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1617 if (art->ipf == ipf) return 1;
1621 static void autodefer_input_file_articles(InputFile *ipf) {
1623 while ((art= LIST_REMHEAD(ipf->queue)))
1624 article_autodefer(ipf, art);
1627 static void autodefer_input_file(InputFile *ipf) {
1630 autodefer_input_file_articles(ipf);
1632 if (ipf->inprogress) {
1635 if (has_article_in(&walk->waiting, ipf) ||
1636 has_article_in(&walk->priority, ipf) ||
1637 has_article_in(&walk->sent, ipf))
1640 while (ipf->inprogress) {
1642 if (walk->quitting < 0) goto found;
1643 abort(); /* where are they ?? */
1646 connfail(walk, "connection is stuck or crawling,"
1647 " and we need to finish flush");
1648 autodefer_input_file_articles(ipf);
1652 check_reading_pause_resume(ipf);
1655 /*========== article transmission ==========*/
1657 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1658 XmitKind kind) { /* caller must then fill in details */
1659 struct iovec *v= &conn->xmit[conn->xmitu];
1660 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1661 v->iov_base= (char*)data;
1667 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1668 xmit_core(conn,data,len, xk_Const);
1670 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1672 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1673 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1677 static void xmit_free(XmitDetails *d) {
1679 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1680 case xk_Const: break;
1685 static void *conn_write_some_xmits(Conn *conn) {
1687 * 0: nothing more to write, no need to call us again
1688 * OOP_CONTINUE: more to write but fd not writeable
1689 * OOP_HALT: disaster, have destroyed conn
1692 int count= conn->xmitu;
1693 if (!count) return 0;
1695 if (count > IOV_MAX) count= IOV_MAX;
1696 ssize_t rs= writev(conn->fd, conn->xmit, count);
1698 if (isewouldblock(errno)) return OOP_CONTINUE;
1699 connfail(conn, "write failed: %s", strerror(errno));
1705 for (done=0; rs && done<conn->xmitu; done++) {
1706 struct iovec *vp= &conn->xmit[done];
1707 XmitDetails *dp= &conn->xmitd[done];
1708 if (rs > vp->iov_len) {
1712 vp->iov_base= (char*)vp->iov_base + rs;
1716 int newu= conn->xmitu - done;
1717 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1718 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1723 static void conn_make_some_xmits(Conn *conn) {
1725 if (conn->xmitu+5 > CONNIOVS)
1728 Article *art= LIST_REMHEAD(conn->priority);
1729 if (!art) art= LIST_REMHEAD(conn->waiting);
1732 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1733 /* actually send it */
1735 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1738 art->state == art_Unchecked ? art_Unsolicited :
1739 art->state == art_Wanted ? art_Wanted :
1742 if (!artdata) art->missing= 1;
1743 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1747 XMIT_LITERAL("TAKETHIS ");
1748 xmit_noalloc(conn, art->messageid, art->midlen);
1749 XMIT_LITERAL("\r\n");
1750 xmit_artbody(conn, artdata);
1752 article_done(art, -1);
1756 /* we got 235 from IHAVE */
1758 xmit_artbody(conn, artdata);
1760 XMIT_LITERAL(".\r\n");
1764 LIST_ADDTAIL(conn->sent, art);
1770 XMIT_LITERAL("CHECK ");
1772 XMIT_LITERAL("IHAVE ");
1773 xmit_noalloc(conn, art->messageid, art->midlen);
1774 XMIT_LITERAL("\r\n");
1776 assert(art->state == art_Unchecked);
1777 art->ipf->counts[art->state][RC_sent]++;
1778 LIST_ADDTAIL(conn->sent, art);
1783 /*========== handling responses from peer ==========*/
1785 static const oop_rd_style peer_rd_style= {
1786 OOP_RD_DELIM_STRIP, '\n',
1788 OOP_RD_SHORTREC_FORBID
1791 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1792 const char *errmsg, int errnoval,
1793 const char *data, size_t recsz, void *conn_v) {
1795 connfail(conn, "error receiving from peer: %s", errmsg);
1796 return OOP_CONTINUE;
1799 static Article *article_reply_check(Conn *conn, const char *response,
1800 int code_indicates_streaming,
1802 /* 1:yes, -1:no, 0:dontcare */,
1803 const char *sanitised_response) {
1804 Article *art= LIST_HEAD(conn->sent);
1808 "peer gave unexpected response when no commands outstanding: %s",
1809 sanitised_response);
1813 if (code_indicates_streaming) {
1814 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1815 if (!conn->stream) {
1816 connfail(conn, "peer gave streaming response code "
1817 " to IHAVE or subsequent body: %s", sanitised_response);
1820 const char *got_mid= response+4;
1821 int got_midlen= strcspn(got_mid, " \n\r");
1822 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1823 connfail(conn, "peer gave streaming response with syntactically invalid"
1824 " messageid: %s", sanitised_response);
1827 if (got_midlen != art->midlen ||
1828 memcmp(got_mid, art->messageid, got_midlen)) {
1829 connfail(conn, "peer gave streaming response code to wrong article -"
1830 " probable synchronisation problem; we offered: %s;"
1832 art->messageid, sanitised_response);
1837 connfail(conn, "peer gave non-streaming response code to"
1838 " CHECK/TAKETHIS: %s", sanitised_response);
1843 if (must_have_sent>0 && art->state < art_Wanted) {
1844 connfail(conn, "peer says article accepted but"
1845 " we had not sent the body: %s", sanitised_response);
1848 if (must_have_sent<0 && art->state >= art_Wanted) {
1849 connfail(conn, "peer says please sent the article but we just did: %s",
1850 sanitised_response);
1854 Article *art_again= LIST_REMHEAD(conn->sent);
1855 assert(art_again == art);
1859 static void update_nocheck(int accepted) {
1860 accept_proportion *= nocheck_decay;
1861 accept_proportion += accepted * (1.0 - nocheck_decay);
1862 int new_nocheck= accept_proportion >= nocheck_thresh;
1863 if (new_nocheck && !nocheck_reported) {
1864 notice("entering nocheck mode for the first time");
1865 nocheck_reported= 1;
1866 } else if (new_nocheck != nocheck) {
1867 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1869 nocheck= new_nocheck;
1872 static void article_done(Article *art, int whichcount) {
1873 if (whichcount>=0 && !art->missing)
1874 art->ipf->counts[art->state][whichcount]++;
1876 if (whichcount == RC_accepted) update_nocheck(1);
1877 else if (whichcount == RC_unwanted) update_nocheck(0);
1879 InputFile *ipf= art->ipf;
1881 while (art->blanklen) {
1882 static const char spaces[]=
1892 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1893 int r= pwrite(ipf->fd, spaces, w, art->offset);
1895 if (errno==EINTR) continue;
1896 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1897 art->messageid, art->blanklen,
1898 (unsigned long)art->offset, ipf->path);
1900 assert(r>=0 && r<=w);
1906 assert(ipf->inprogress >= 0);
1909 if (!ipf->inprogress && ipf != main_input_file)
1910 queue_check_input_done();
1913 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1914 const char *errmsg, int errnoval,
1915 const char *data, size_t recsz, void *conn_v) {
1918 if (ev == OOP_RD_EOF) {
1919 connfail(conn, "unexpected EOF from peer");
1920 return OOP_CONTINUE;
1922 assert(ev == OOP_RD_OK);
1924 char *sani= sanitise(data,-1);
1927 unsigned long code= strtoul(data, &ep, 10);
1928 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1929 connfail(conn, "badly formatted response from peer: %s", sani);
1930 return OOP_CONTINUE;
1934 conn->waiting.count ||
1935 conn->priority.count ||
1939 if (conn->quitting) {
1940 if (code!=205 && code!=503) {
1941 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1943 notice("C%d idle connection closed by us", conn->fd);
1945 LIST_REMOVE(conns,conn);
1948 return OOP_CONTINUE;
1951 conn->since_activity= 0;
1954 #define GET_ARTICLE(musthavesent) do{ \
1955 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1956 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1959 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1960 code_streaming= (streaming); \
1961 GET_ARTICLE(musthavesent); \
1962 article_done(art, RC_##how); \
1966 #define PEERBADMSG(m) do { \
1967 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1970 int code_streaming= 0;
1974 default: PEERBADMSG("peer sent unexpected message");
1978 PEERBADMSG("peer timed us out or stopped accepting articles");
1980 notice("C%d idle connection closed by peer", conn->fd);
1981 LIST_REMOVE(conns,conn);
1983 return OOP_CONTINUE;
1985 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1986 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1988 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1989 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1991 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1992 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1994 case 238: /* CHECK says send it */
1996 case 335: /* IHAVE says send it */
1998 assert(art->state == art_Unchecked);
1999 art->ipf->counts[art->state][RC_accepted]++;
2000 art->state= art_Wanted;
2001 LIST_ADDTAIL(conn->priority, art);
2004 case 431: /* CHECK or TAKETHIS says try later */
2006 case 436: /* IHAVE says try later */
2008 article_defer(art, RC_deferred);
2014 conn_maybe_write(conn);
2015 check_assign_articles();
2016 return OOP_CONTINUE;
2020 /*========== monitoring of input files ==========*/
2022 static void feedfile_eof(InputFile *ipf) {
2023 assert(ipf != main_input_file); /* promised by tailing_try_read */
2024 inputfile_reading_stop(ipf);
2026 if (ipf == flushing_input_file) {
2027 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2028 if (main_input_file) inputfile_reading_start(main_input_file);
2029 statemc_check_flushing_done();
2030 } else if (ipf == backlog_input_file) {
2031 statemc_check_backlog_done();
2033 abort(); /* supposed to wait rather than get EOF on main input file */
2037 static InputFile *open_input_file(const char *path) {
2038 int fd= open(path, O_RDWR);
2040 if (errno==ENOENT) return 0;
2041 sysfatal("unable to open input file %s", path);
2045 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2046 memset(ipf,0,sizeof(*ipf));
2050 LIST_INIT(ipf->queue);
2051 strcpy(ipf->path, path);
2056 static void close_input_file(InputFile *ipf) { /* does not free */
2057 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2058 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2059 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2060 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2061 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2065 /*---------- dealing with articles read in the input file ----------*/
2067 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2068 const char *data, const char *how) {
2069 warn("corrupted file: %s, offset %lu: %s: in %s",
2070 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2071 ipf->readcount_err++;
2072 if (ipf->readcount_err > max_bad_data_initial +
2073 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2074 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2075 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2076 return OOP_CONTINUE;
2079 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2080 oop_rd_event ev, const char *errmsg,
2081 int errnoval, const char *data, size_t recsz,
2083 InputFile *ipf= ipf_v;
2084 assert(ev == OOP_RD_SYSTEM);
2086 sysdie("error reading input file: %s, offset %lu",
2087 ipf->path, (unsigned long)ipf->offset);
2090 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2091 oop_rd_event ev, const char *errmsg,
2092 int errnoval, const char *data, size_t recsz,
2094 InputFile *ipf= ipf_v;
2096 char tokentextbuf[sizeof(TOKEN)*2+3];
2098 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2100 off_t old_offset= ipf->offset;
2101 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2103 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2105 if (ev==OOP_RD_PARTREC)
2106 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2107 /* but process it anyway */
2109 if (ipf->skippinglong) {
2110 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2111 return OOP_CONTINUE;
2113 if (ev==OOP_RD_LONG) {
2114 ipf->skippinglong= 1;
2115 X_BAD_DATA("overly long line");
2118 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2119 if (!recsz) X_BAD_DATA("empty line");
2122 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2123 ipf->readcount_blank++;
2124 return OOP_CONTINUE;
2127 char *space= strchr(data,' ');
2128 int tokenlen= space-data;
2129 int midlen= (int)recsz-tokenlen-1;
2130 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2131 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2133 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2134 memcpy(tokentextbuf, data, tokenlen);
2135 tokentextbuf[tokenlen]= 0;
2136 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2138 ipf->readcount_ok++;
2140 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2141 memset(art,0,sizeof(*art));
2142 art->state= art_Unchecked;
2143 art->midlen= midlen;
2144 art->ipf= ipf; ipf->inprogress++;
2145 art->token= TextToToken(tokentextbuf);
2146 art->offset= old_offset;
2147 art->blanklen= recsz;
2148 strcpy(art->messageid, space+1);
2149 LIST_ADDTAIL(ipf->queue, art);
2151 if (ipf->autodefer >= 0)
2152 article_autodefer(ipf, art);
2153 else if (ipf==backlog_input_file)
2154 article_check_expired(art);
2156 if (sms==sm_NORMAL && ipf==main_input_file &&
2157 ipf->offset >= target_max_feedfile_size)
2158 statemc_start_flush("feed file size");
2160 check_assign_articles(); /* may destroy conn but that's OK */
2161 check_reading_pause_resume(ipf);
2162 return OOP_CONTINUE;
2165 /*========== tailing input file ==========*/
2167 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2169 InputFile *ipf= user;
2170 return ipf->readable_callback(loop, &ipf->readable,
2171 ipf->readable_callback_user);
2174 static void tailing_on_cancel(struct oop_readable *rable) {
2175 InputFile *ipf= (void*)rable;
2177 if (ipf->filemon) filemon_stop(ipf);
2178 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2179 ipf->readable_callback= 0;
2182 static void tailing_queue_readable(InputFile *ipf) {
2183 /* lifetime of ipf here is OK because destruction will cause
2184 * on_cancel which will cancel this callback */
2185 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2188 static int tailing_on_readable(struct oop_readable *rable,
2189 oop_readable_call *cb, void *user) {
2190 InputFile *ipf= (void*)rable;
2192 tailing_on_cancel(rable);
2193 ipf->readable_callback= cb;
2194 ipf->readable_callback_user= user;
2197 tailing_queue_readable(ipf);
2201 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2203 InputFile *ipf= (void*)rable;
2205 ssize_t r= read(ipf->fd, buffer, length);
2207 if (errno==EINTR) continue;
2211 if (ipf==main_input_file) {
2214 } else if (ipf==flushing_input_file) {
2216 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2217 } else if (ipf==backlog_input_file) {
2223 tailing_queue_readable(ipf);
2228 /*---------- filemon implemented with inotify ----------*/
2230 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2231 #define HAVE_FILEMON
2233 #include <sys/inotify.h>
2235 static int filemon_inotify_fd;
2236 static int filemon_inotify_wdmax;
2237 static InputFile **filemon_inotify_wd2ipf;
2239 struct Filemon_Perfile {
2243 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2244 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2245 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2247 if (wd >= filemon_inotify_wdmax) {
2249 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2250 sizeof(*filemon_inotify_wd2ipf) * newmax);
2251 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2252 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2253 filemon_inotify_wdmax= newmax;
2256 assert(!filemon_inotify_wd2ipf[wd]);
2257 filemon_inotify_wd2ipf[wd]= ipf;
2259 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2260 ipf, wd, filemon_inotify_wdmax);
2265 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2267 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2268 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2269 if (r) sysdie("inotify_rm_watch");
2270 filemon_inotify_wd2ipf[wd]= 0;
2273 static void *filemon_inotify_readable(oop_source *lp, int fd,
2274 oop_event e, void *u) {
2275 struct inotify_event iev;
2277 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2279 if (isewouldblock(errno)) break;
2280 sysdie("read from inotify master");
2281 } else if (r==sizeof(iev)) {
2282 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2284 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2286 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2287 debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);
2288 filemon_callback(ipf);
2290 return OOP_CONTINUE;
2293 static int filemon_method_init(void) {
2294 filemon_inotify_fd= inotify_init();
2295 if (filemon_inotify_fd<0) {
2296 syswarn("filemon/inotify: inotify_init failed");
2299 xsetnonblock(filemon_inotify_fd, 1);
2300 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2302 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2306 static void filemon_method_dump_info(FILE *f) {
2308 fprintf(f,"inotify");
2309 DUMPV("%d",,filemon_inotify_fd);
2310 DUMPV("%d",,filemon_inotify_wdmax);
2311 for (i=0; i<filemon_inotify_wdmax; i++)
2312 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2315 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2317 /*---------- filemon dummy implementation ----------*/
2319 #if !defined(HAVE_FILEMON)
2321 struct Filemon_Perfile { int dummy; };
2323 static int filemon_method_init(void) {
2324 warn("filemon/dummy: no filemon method compiled in");
2327 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2328 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2329 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2331 #endif /* !HAVE_FILEMON */
2333 /*---------- filemon generic interface ----------*/
2335 static void filemon_start(InputFile *ipf) {
2336 assert(!ipf->filemon);
2339 filemon_method_startfile(ipf, ipf->filemon);
2342 static void filemon_stop(InputFile *ipf) {
2343 if (!ipf->filemon) return;
2344 filemon_method_stopfile(ipf, ipf->filemon);
2349 static void filemon_callback(InputFile *ipf) {
2350 if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2351 ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2354 /*---------- interface to start and stop an input file ----------*/
2356 static const oop_rd_style feedfile_rdstyle= {
2357 OOP_RD_DELIM_STRIP, '\n',
2359 OOP_RD_SHORTREC_LONG,
2362 static void inputfile_reading_resume(InputFile *ipf) {
2363 if (!ipf->rd) return;
2364 if (!ipf->paused) return;
2366 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2367 feedfile_got_article,ipf, feedfile_read_err, ipf);
2368 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2373 static void inputfile_reading_pause(InputFile *ipf) {
2374 if (!ipf->rd) return;
2375 if (ipf->paused) return;
2376 oop_rd_cancel(ipf->rd);
2380 static void inputfile_reading_start(InputFile *ipf) {
2382 ipf->readable.on_readable= tailing_on_readable;
2383 ipf->readable.on_cancel= tailing_on_cancel;
2384 ipf->readable.try_read= tailing_try_read;
2385 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2386 ipf->readable.delete_kill= 0;
2388 ipf->readable_callback= 0;
2389 ipf->readable_callback_user= 0;
2391 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2395 inputfile_reading_resume(ipf);
2398 static void inputfile_reading_stop(InputFile *ipf) {
2400 inputfile_reading_pause(ipf);
2401 oop_rd_delete(ipf->rd);
2403 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2407 /*========== interaction with innd - state machine ==========*/
2409 /* See official state diagram at top of file. We implement
2420 |`---------------------------------------------------.
2422 |`---------------- - - - |
2423 D ENOENT | D EXISTS see OVERALL STATES diagram |
2424 | for full startup logic |
2427 | ============ try to |
2433 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2434 ^ | hardlink F to D |
2437 | | our handle onto F is now onto D |
2440 | |<-------------------<---------------------<---------+
2442 | | spawn inndcomm flush |
2444 | ================== |
2445 | FLUSHING[-ABSENT] |
2447 | main D tail/none |
2448 | ================== |
2450 | | INNDCOMM FLUSH FAILS ^
2451 | |`----------------------->----------. |
2453 | | NO SUCH SITE V |
2454 ^ |`--------------->----. ==================== |
2455 | | \ FLUSHFAILED[-ABSENT] |
2457 | | FLUSH OK \ main D tail/none |
2458 | | open F \ ==================== |
2460 | | \ | TIME TO RETRY |
2461 | |`------->----. ,---<---'\ `----------------'
2462 | | D NONE | | D NONE `----.
2464 | ============= V V ============
2465 | SEPARATED-1 | | DROPPING-1
2466 | flsh->rd!=0 | | flsh->rd!=0
2467 | [Separated] | | [Dropping]
2468 | main F idle | | main none
2469 | flsh D tail | | flsh D tail
2470 | ============= | | ============
2472 ^ | EOF ON D | | defer | EOF ON D
2474 | =============== | | ===============
2475 | SEPARATED-2 | | DROPPING-2
2476 | flsh->rd==0 | V flsh->rd==0
2477 | [Finishing] | | [Dropping]
2478 | main F tail | `. main none
2479 | flsh D closed | `. flsh D closed
2480 | =============== V `. ===============
2482 | | ALL D PROCESSED `. | ALL D PROCESSED
2483 | V install defer as backlog `. | install defer
2484 ^ | close D `. | close D
2485 | | unlink D `. | unlink D
2488 `----------' ==============
2508 static void startup_set_input_file(InputFile *f) {
2509 assert(!main_input_file);
2511 inputfile_reading_start(f);
2514 static void statemc_lock(void) {
2516 struct stat stab, stabf;
2519 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2520 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2523 memset(&fl,0,sizeof(fl));
2525 fl.l_whence= SEEK_SET;
2526 int r= fcntl(lockfd, F_SETLK, &fl);
2528 if (errno==EACCES || isewouldblock(errno)) {
2529 if (quiet_multiple) exit(0);
2530 fatal("another duct holds the lockfile");
2532 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2535 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2537 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2539 if (!lock_noent && samefile(&stab, &stabf))
2542 xclose(lockfd, "stale lockfile ", path_lock);
2545 FILE *lockfile= fdopen(lockfd, "w");
2546 if (!lockfile) sysdie("fdopen lockfile");
2548 int r= ftruncate(lockfd, 0);
2549 if (r) sysdie("truncate lockfile to write new info");
2551 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2552 (unsigned long)self_pid,
2553 sitename, feedfile, remote_host) == EOF ||
2555 sysfatal("write info to lockfile %s", path_lock);
2557 debug("startup: locked");
2560 static void statemc_init(void) {
2561 struct stat stabdefer;
2563 search_backlog_file();
2566 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2568 debug("startup: ductdefer ENOENT");
2570 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2571 switch (stabdefer.st_nlink==1) {
2573 open_defer(); /* so that we will later close it and rename it */
2576 xunlink(path_defer, "stale defer file link"
2577 " (presumably hardlink to backlog file)");
2580 die("defer file %s has unexpected link count %d",
2581 path_defer, stabdefer.st_nlink);
2585 struct stat stab_f, stab_d;
2588 InputFile *file_d= open_input_file(path_flushing);
2589 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2591 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2593 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2594 debug("startup: F==D => Hardlinked");
2595 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2600 debug("startup: F ENOENT => Moved");
2601 if (file_d) startup_set_input_file(file_d);
2602 spawn_inndcomm_flush("feedfile missing at startup");
2603 /* => Flushing, sms:=FLUSHING */
2606 debug("startup: F!=D => Separated");
2607 startup_set_input_file(file_d);
2608 flushing_input_file= main_input_file;
2609 main_input_file= open_input_file(feedfile);
2610 if (!main_input_file) die("feedfile vanished during startup");
2611 SMS(SEPARATED, max_separated_periods,
2612 "found both old and current feed files");
2614 debug("startup: F exists, D ENOENT => Normal");
2615 InputFile *file_f= open_input_file(feedfile);
2616 if (!file_f) die("feed file vanished during startup");
2617 startup_set_input_file(file_f);
2618 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2623 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2624 assert(sms == sm_NORMAL);
2626 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2628 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2629 (unsigned long)target_max_feedfile_size,
2632 int r= link(feedfile, path_flushing);
2633 if (r) sysfatal("link feedfile %s to flushing file %s",
2634 feedfile, path_flushing);
2637 xunlink(feedfile, "old feedfile link");
2640 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2643 static int trigger_flush_ok(void) { /* => Flushing,FLUSHING, ret 1; or ret 0 */
2647 statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
2650 case sm_FLUSHFAILED:
2651 spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
2656 warn("took too long to complete old feedfile after flush, autodeferring");
2657 assert(flushing_input_file);
2658 autodefer_input_file(flushing_input_file);
2666 static void statemc_period_poll(void) {
2667 if (!until_flush) return;
2669 assert(until_flush>=0);
2671 if (until_flush) return;
2672 int ok= trigger_flush_ok();
2676 static int inputfile_is_done(InputFile *ipf) {
2678 if (ipf->inprogress) return 0; /* new article in the meantime */
2679 if (ipf->rd) return 0; /* not had EOF */
2683 static void notice_processed(InputFile *ipf, int completed,
2684 const char *what, const char *spec) {
2685 if (!ipf) return; /* allows preterminate to be lazy */
2687 #define RCI_NOTHING(x) /* nothing */
2688 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2689 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2691 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2693 char *inprog= completed
2694 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2695 : xasprintf(" inprogress=%ld", ipf->inprogress);
2696 char *autodefer= ipf->autodefer >= 0
2697 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2698 : xasprintf("%s","");
2700 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2701 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2702 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2704 completed?"completed":"processed", what, spec,
2705 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2706 inprog, autodefer, ipf->count_nooffer_missing,
2707 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2708 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2709 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2710 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2711 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2720 static void statemc_check_backlog_done(void) {
2721 InputFile *ipf= backlog_input_file;
2722 if (!inputfile_is_done(ipf)) return;
2724 const char *slash= strrchr(ipf->path, '/');
2725 const char *leaf= slash ? slash+1 : ipf->path;
2726 const char *under= strchr(slash, '_');
2727 const char *rest= under ? under+1 : leaf;
2728 if (!strncmp(rest,"backlog",7)) rest += 7;
2729 notice_processed(ipf,1,"backlog ",rest);
2731 close_input_file(ipf);
2732 if (unlink(ipf->path)) {
2733 if (errno != ENOENT)
2734 sysdie("could not unlink processed backlog file %s", ipf->path);
2735 warn("backlog file %s vanished while we were reading it"
2736 " so we couldn't remove it (but it's done now, anyway)",
2740 backlog_input_file= 0;
2741 search_backlog_file();
2745 static void statemc_check_flushing_done(void) {
2746 InputFile *ipf= flushing_input_file;
2747 if (!inputfile_is_done(ipf)) return;
2749 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2751 notice_processed(ipf,1,"feedfile","");
2755 xunlink(path_flushing, "old flushing file");
2757 close_input_file(flushing_input_file);
2758 free(flushing_input_file);
2759 flushing_input_file= 0;
2761 if (sms==sm_SEPARATED) {
2762 notice("flush complete");
2763 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2764 } else if (sms==sm_DROPPING) {
2765 SMS(DROPPED, max_separated_periods, "old flush complete");
2766 search_backlog_file();
2767 notice("feed dropped, but will continue until backlog is finished");
2771 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2773 assert(!inputfile_is_done(main_input_file));
2774 statemc_check_flushing_done();
2775 statemc_check_backlog_done();
2776 return OOP_CONTINUE;
2779 static void queue_check_input_done(void) {
2780 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2783 static void statemc_setstate(StateMachineState newsms, int periods,
2784 const char *forlog, const char *why) {
2786 until_flush= periods;
2788 const char *xtra= "";
2791 case sm_FLUSHFAILED:
2792 if (!main_input_file) xtra= "-ABSENT";
2796 xtra= flushing_input_file->rd ? "-1" : "-2";
2802 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2804 info("state %s%s %s",forlog,xtra,why);
2808 /*---------- defer and backlog files ----------*/
2810 static void open_defer(void) {
2815 defer= fopen(path_defer, "a+");
2816 if (!defer) sysfatal("could not open defer file %s", path_defer);
2818 /* truncate away any half-written records */
2820 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2822 if (stab.st_size > LONG_MAX)
2823 die("defer file %s size is far too large", path_defer);
2828 long orgsize= stab.st_size;
2829 long truncto= stab.st_size;
2831 if (!truncto) break; /* was only (if anything) one half-truncated record */
2832 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2833 sysdie("seek in defer file %s while truncating partial", path_defer);
2838 sysdie("failed read from defer file %s", path_defer);
2840 die("defer file %s shrank while we were checking it!", path_defer);
2846 if (stab.st_size != truncto) {
2847 warn("truncating half-record at end of defer file %s -"
2848 " shrinking by %ld bytes from %ld to %ld",
2849 path_defer, orgsize - truncto, orgsize, truncto);
2852 sysfatal("could not flush defer file %s", path_defer);
2853 if (ftruncate(fileno(defer), truncto))
2854 sysdie("could not truncate defer file %s", path_defer);
2857 info("continuing existing defer file %s (%ld bytes)",
2858 path_defer, orgsize);
2860 if (fseek(defer, truncto, SEEK_SET))
2861 sysdie("could not seek to new end of defer file %s", path_defer);
2864 static void close_defer(void) {
2869 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2871 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2874 time_t now= xtime();
2876 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2878 (unsigned long)stab.st_ino);
2879 if (link(path_defer, backlog))
2880 sysfatal("could not install defer file %s as backlog file %s",
2881 path_defer, backlog);
2882 if (unlink(path_defer))
2883 sysdie("could not unlink old defer link %s to backlog file %s",
2884 path_defer, backlog);
2888 if (until_backlog_nextscan < 0 ||
2889 until_backlog_nextscan > backlog_retry_minperiods + 1)
2890 until_backlog_nextscan= backlog_retry_minperiods + 1;
2893 static void poll_backlog_file(void) {
2894 if (until_backlog_nextscan < 0) return;
2895 if (until_backlog_nextscan-- > 0) return;
2896 search_backlog_file();
2899 static void search_backlog_file(void) {
2900 /* returns non-0 iff there are any backlog files */
2905 const char *oldest_path=0;
2906 time_t oldest_mtime=0, now;
2908 if (backlog_input_file) return;
2912 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2916 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2918 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2920 for (i=0; i<gl.gl_pathc; i++) {
2921 const char *path= gl.gl_pathv[i];
2923 if (strchr(path,'#') || strchr(path,'~')) {
2924 debug("backlog file search skipping %s", path);
2927 r= stat(path, &stab);
2929 syswarn("failed to stat backlog file %s", path);
2932 if (!S_ISREG(stab.st_mode)) {
2933 warn("backlog file %s is not a plain file (or link to one)", path);
2936 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2938 oldest_mtime= stab.st_mtime;
2941 case GLOB_NOMATCH: /* fall through */
2944 sysdie("glob expansion of backlog pattern %s gave unexpected"
2945 " nonzero (error?) return value %d", globpat_backlog, r);
2949 debug("backlog scan: none");
2951 if (sms==sm_DROPPED) {
2953 notice("feed dropped and our work is complete");
2955 int r= unlink(path_control);
2956 if (r && errno!=ENOENT)
2957 syswarn("failed to remove control symlink for old feed");
2959 xunlink(path_lock, "lockfile for old feed");
2962 until_backlog_nextscan= backlog_spontrescan_periods;
2967 double age= difftime(now, oldest_mtime);
2968 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2970 if (age_deficiency <= 0) {
2971 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2972 age, age_deficiency, oldest_path);
2974 backlog_input_file= open_input_file(oldest_path);
2975 if (!backlog_input_file) {
2976 warn("backlog file %s vanished as we opened it", oldest_path);
2980 inputfile_reading_start(backlog_input_file);
2981 until_backlog_nextscan= -1;
2985 until_backlog_nextscan= age_deficiency / period_seconds;
2987 if (backlog_spontrescan_periods >= 0 &&
2988 until_backlog_nextscan > backlog_spontrescan_periods)
2989 until_backlog_nextscan= backlog_spontrescan_periods;
2991 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2992 age, age_deficiency, until_backlog_nextscan, oldest_path);
2999 /*---------- shutdown and signal handling ----------*/
3001 static void preterminate(void) {
3002 if (in_child) return;
3003 notice_processed(main_input_file,0,"feedfile","");
3004 notice_processed(flushing_input_file,0,"flushing","");
3005 if (backlog_input_file)
3006 notice_processed(backlog_input_file,0, "backlog file ",
3007 backlog_input_file->path);
3010 static int signal_self_pipe[2];
3011 static sig_atomic_t terminate_sig_flag;
3013 static void raise_default(int signo) {
3014 xsigsetdefault(signo);
3019 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3020 assert(fd=signal_self_pipe[0]);
3022 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3023 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
3024 if (r==0) die("eof on signal self pipe");
3025 if (terminate_sig_flag) {
3027 notice("terminating (%s)", strsignal(terminate_sig_flag));
3028 raise_default(terminate_sig_flag);
3030 return OOP_CONTINUE;
3033 static void sigarrived_handler(int signum) {
3038 if (!terminate_sig_flag) terminate_sig_flag= signum;
3043 write(signal_self_pipe[1],&x,1);
3046 static void init_signals(void) {
3047 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3048 sysdie("could not ignore SIGPIPE");
3050 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3052 xsetnonblock(signal_self_pipe[0],1);
3053 xsetnonblock(signal_self_pipe[1],1);
3055 struct sigaction sa;
3056 memset(&sa,0,sizeof(sa));
3057 sa.sa_handler= sigarrived_handler;
3058 sa.sa_flags= SA_RESTART;
3059 xsigaction(SIGTERM,&sa);
3060 xsigaction(SIGINT,&sa);
3062 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3065 /*========== flushing the feed ==========*/
3067 static pid_t inndcomm_child;
3068 static int inndcomm_sentinel_fd;
3070 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3071 assert(inndcomm_child);
3072 assert(fd == inndcomm_sentinel_fd);
3073 int status= xwaitpid(&inndcomm_child, "inndcomm");
3076 cancel_fd_read_except(fd);
3077 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3078 inndcomm_sentinel_fd= 0;
3080 assert(!flushing_input_file);
3082 if (WIFEXITED(status)) {
3083 switch (WEXITSTATUS(status)) {
3085 case INNDCOMMCHILD_ESTATUS_FAIL:
3088 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3089 notice("feed has been dropped by innd, finishing up");
3090 flushing_input_file= main_input_file;
3091 tailing_queue_readable(flushing_input_file);
3092 /* we probably previously returned EAGAIN from our fake read method
3093 * when in fact we were at EOF, so signal another readable event
3094 * so we actually see the EOF */
3098 if (flushing_input_file) {
3099 SMS(DROPPING, max_separated_periods,
3100 "feed dropped by innd, but must finish last flush");
3103 SMS(DROPPED, 0, "feed dropped by innd");
3104 search_backlog_file();
3106 return OOP_CONTINUE;
3110 flushing_input_file= main_input_file;
3111 tailing_queue_readable(flushing_input_file);
3113 main_input_file= open_input_file(feedfile);
3114 if (!main_input_file)
3115 die("flush succeeded but feedfile %s does not exist!", feedfile);
3117 if (flushing_input_file) {
3118 SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3121 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3123 return OOP_CONTINUE;
3126 goto unexpected_exitstatus;
3129 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3130 warn("flush timed out trying to talk to innd");
3133 unexpected_exitstatus:
3134 report_child_status("inndcomm child", status);
3138 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3139 return OOP_CONTINUE;
3142 static void inndcommfail(const char *what) {
3143 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3144 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3147 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3150 notice("flushing %s",why);
3152 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3153 assert(!inndcomm_child);
3154 assert(!inndcomm_sentinel_fd);
3156 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3158 inndcomm_child= xfork("inndcomm child");
3160 if (!inndcomm_child) {
3161 const char *flushargv[2]= { sitename, 0 };
3165 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3166 /* parent spots the autoclose of pipefds[1] when we die or exit */
3168 if (simulate_flush>=0) {
3169 warn("SIMULATING flush child status %d", simulate_flush);
3170 if (simulate_flush>128) raise(simulate_flush-128);
3171 else exit(simulate_flush);
3174 alarm(inndcomm_flush_timeout);
3175 r= ICCopen(); if (r) inndcommfail("connect");
3176 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3177 if (!r) exit(0); /* yay! */
3179 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3180 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3181 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3186 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3187 inndcomm_sentinel_fd= pipefds[0];
3188 assert(inndcomm_sentinel_fd);
3189 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3191 SMS(FLUSHING, 0, why);
3194 /*========== main program ==========*/
3196 static void postfork_inputfile(InputFile *ipf) {
3198 xclose(ipf->fd, "(in child) input file ", ipf->path);
3201 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3202 /* we have no stdio streams that are buffered long-term */
3204 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3207 static void postfork(void) {
3210 xsigsetdefault(SIGTERM);
3211 xsigsetdefault(SIGINT);
3212 xsigsetdefault(SIGPIPE);
3213 if (terminate_sig_flag) raise(terminate_sig_flag);
3215 postfork_inputfile(main_input_file);
3216 postfork_inputfile(flushing_input_file);
3220 conn_closefd(conn,"(in child) ");
3222 postfork_stdio(defer, "defer file ", path_defer);
3225 typedef struct Every Every;
3227 struct timeval interval;
3232 static void every_schedule(Every *e, struct timeval base);
3234 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3237 if (!e->fixed_rate) xgettimeofday(&base);
3238 every_schedule(e, base);
3239 return OOP_CONTINUE;
3242 static void every_schedule(Every *e, struct timeval base) {
3243 struct timeval when;
3244 timeradd(&base, &e->interval, &when);
3245 loop->on_time(loop, when, every_happens, e);
3248 static void every(int interval, int fixed_rate, void (*f)(void)) {
3249 NEW_DECL(Every *,e);
3250 e->interval.tv_sec= interval;
3251 e->interval.tv_usec= 0;
3252 e->fixed_rate= fixed_rate;
3255 xgettimeofday(&now);
3256 every_schedule(e, now);
3259 static void filepoll(void) {
3260 filemon_callback(main_input_file);
3261 filemon_callback(flushing_input_file);
3264 static char *debug_report_ipf(InputFile *ipf) {
3265 if (!ipf) return xasprintf("none");
3267 const char *slash= strrchr(ipf->path,'/');
3268 const char *path= slash ? slash+1 : ipf->path;
3270 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3272 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3273 (long)ipf->offset, ipf->fd,
3274 ipf->rd ? "" : ",!rd",
3275 ipf->skippinglong ? "*skiplong" : "",
3276 ipf->rd && ipf->paused ? "*paused" : "");
3279 static void period(void) {
3280 char *dipf_main= debug_report_ipf(main_input_file);
3281 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3282 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3285 " sms=%s[%d] conns=%d until_connect=%d"
3286 " input_files main:%s flushing:%s backlog:%s[%d]"
3287 " children connecting=%ld inndcomm=%ld"
3289 sms_names[sms], until_flush, conns.count, until_connect,
3290 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3291 (long)connecting_child, (long)inndcomm_child
3295 free(dipf_flushing);
3298 if (until_connect) until_connect--;
3300 inputfile_queue_check_expired(backlog_input_file);
3301 poll_backlog_file();
3302 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3303 statemc_period_poll();
3304 check_assign_articles();
3309 /*========== dumping state ==========*/
3311 static void dump_article_list(FILE *f, const ControlCommand *c,
3312 const ArticleList *al) {
3313 fprintf(f, " count=%d\n", al->count);
3314 if (!c->xval) return;
3316 int i; Article *art;
3317 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3318 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3319 DUMPV("%p", art->,ipf);
3320 DUMPV("%d", art->,missing);
3321 DUMPV("%lu", (unsigned long)art->,offset);
3322 DUMPV("%d", art->,blanklen);
3323 DUMPV("%d", art->,midlen);
3324 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3328 static void dump_input_file(FILE *f, const ControlCommand *c,
3329 InputFile *ipf, const char *wh) {
3330 char *dipf= debug_report_ipf(ipf);
3331 fprintf(f,"input %s %s", wh, dipf);
3335 DUMPV("%d", ipf->,readcount_ok);
3336 DUMPV("%d", ipf->,readcount_blank);
3337 DUMPV("%d", ipf->,readcount_err);
3338 DUMPV("%d", ipf->,count_nooffer_missing);
3342 ArtState state; const char *const *statename;
3343 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3344 #define RC_DUMP_FMT(x) " " #x "=%d"
3345 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3346 fprintf(f,"input %s counts %-11s"
3347 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3349 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3351 fprintf(f,"input %s queue", wh);
3352 dump_article_list(f,c,&ipf->queue);
3358 fprintf(cc->out, "dumping state to %s\n", path_dump);
3359 FILE *f= fopen(path_dump, "w");
3360 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3362 fprintf(f,"general");
3363 DUMPV("%s", sms_names,[sms]);
3364 DUMPV("%d", ,until_flush);
3365 DUMPV("%ld", (long),self_pid);
3366 DUMPV("%p", , defer);
3367 DUMPV("%d", , until_connect);
3368 DUMPV("%d", , until_backlog_nextscan);
3369 DUMPV("%d", , simulate_flush);
3370 fprintf(f,"\nnocheck");
3371 DUMPV("%#.10f", , accept_proportion);
3372 DUMPV("%d", , nocheck);
3373 DUMPV("%d", , nocheck_reported);
3376 fprintf(f,"special");
3377 DUMPV("%ld", (long),connecting_child);
3378 DUMPV("%d", , connecting_fdpass_sock);
3379 DUMPV("%d", , control_master);
3382 fprintf(f,"filemon ");
3383 filemon_method_dump_info(f);
3385 dump_input_file(f,c, main_input_file, "main" );
3386 dump_input_file(f,c, flushing_input_file, "flushing");
3387 dump_input_file(f,c, backlog_input_file, "backlog" );
3389 fprintf(f,"conns count=%d\n", conns.count);
3394 fprintf(f,"C%d",conn->fd);
3395 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3396 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3397 DUMPV("%d",conn->,since_activity);
3400 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3401 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3402 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3404 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3405 for (i=0; i<conn->xmitu; i++) {
3406 const struct iovec *iv= &conn->xmit[i];
3407 const XmitDetails *xd= &conn->xmitd[i];
3410 case xk_Const: dinfo= xasprintf("Const"); break;
3411 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3415 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3416 sanitise(iv->iov_base, iv->iov_len));
3422 DUMPV("%s", , path_lock);
3423 DUMPV("%s", , path_flushing);
3424 DUMPV("%s", , path_defer);
3425 DUMPV("%s", , path_control);
3426 DUMPV("%s", , path_dump);
3427 DUMPV("%s", , globpat_backlog);
3430 if (!!ferror(f) + !!fclose(f)) {
3431 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3436 /*========== option parsing ==========*/
3438 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3439 static void vbadusage(const char *fmt, va_list al) {
3440 char *m= xvasprintf(fmt,al);
3441 fprintf(stderr, "bad usage: %s\n"
3442 "say --help for help, or read the manpage\n",
3445 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3449 /*---------- generic option parser ----------*/
3451 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3452 static void badusage(const char *fmt, ...) {
3459 of_seconds= 001000u,
3460 of_boolean= 002000u,
3463 typedef struct Option Option;
3464 typedef void OptionParser(const Option*, const char *val);
3468 const char *lng, *formarg;
3474 static void parse_options(const Option *options, char ***argvp) {
3475 /* on return *argvp is first non-option arg; argc is not updated */
3478 const char *arg= *++(*argvp);
3480 if (*arg != '-') break;
3481 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3483 while ((a= *++arg)) {
3487 char *equals= strchr(arg,'=');
3488 int len= equals ? (equals - arg) : strlen(arg);
3489 for (o=options; o->shrt || o->lng; o++)
3490 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3492 badusage("unknown long option --%s",arg);
3495 if (equals) badusage("option --%s does not take a value",o->lng);
3497 } else if (equals) {
3501 if (!arg) badusage("option --%s needs a value for %s",
3502 o->lng, o->formarg);
3505 break; /* eaten the whole argument now */
3507 for (o=options; o->shrt || o->lng; o++)
3510 badusage("unknown short option -%c",a);
3517 if (!arg) badusage("option -%c needs a value for %s",
3518 o->shrt, o->formarg);
3521 break; /* eaten the whole argument now */
3527 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3529 static void print_options(const Option *options, FILE *f) {
3531 for (o=options; o->shrt || o->lng; o++) {
3532 char shrt[2] = { o->shrt, 0 };
3533 char *optspec= xasprintf("%s%s%s%s%s",
3534 o->shrt ? "-" : "", shrt,
3535 o->shrt && o->lng ? "|" : "",
3536 DELIMPERHAPS("--", o->lng));
3537 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3542 /*---------- specific option types ----------*/
3544 static void op_integer(const Option *o, const char *val) {
3547 unsigned long ul= strtoul(val,&ep,10);
3548 if (*ep || ep==val || errno || ul>INT_MAX)
3549 badusage("bad integer value for %s",o->lng);
3550 int *store= o->store;
3554 static void op_double(const Option *o, const char *val) {
3555 int *store= o->store;
3558 *store= strtod(val, &ep);
3559 if (*ep || ep==val || errno)
3560 badusage("bad floating point value for %s",o->lng);
3563 static void op_string(const Option *o, const char *val) {
3564 const char **store= o->store;
3568 static void op_seconds(const Option *o, const char *val) {
3569 int *store= o->store;
3573 double v= strtod(val,&ep);
3574 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3576 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3577 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3578 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3579 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3580 else if (!strcmp(ep,"das")) unit= 10;
3581 else if (!strcmp(ep,"hs")) unit= 100;
3582 else if (!strcmp(ep,"ks")) unit= 1000;
3583 else if (!strcmp(ep,"Ms")) unit= 1000000;
3584 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3588 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3592 static void op_setint(const Option *o, const char *val) {
3593 int *store= o->store;
3597 /*---------- specific options ----------*/
3599 static void help(const Option *o, const char *val);
3601 static const Option innduct_options[]= {
3602 {'f',"feedfile", "F", &feedfile, op_string },
3603 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3604 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3605 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3606 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3607 {'C',"inndconf", "F", &inndconffile, op_string },
3608 {'P',"port", "PORT", &port, op_integer },
3609 {0,"ctrl-sock-dir", 0, &realsockdir, op_string },
3610 {0,"help", 0, 0, help },
3612 {0,"max-connections", "N", &max_connections, op_integer },
3613 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3614 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3615 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3616 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3618 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3619 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3620 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3622 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3623 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3625 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3626 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3627 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3628 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3629 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3630 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3631 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3633 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3634 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3639 static void printusage(FILE *f) {
3640 fputs("usage: innduct [options] site [fqdn]\n"
3641 "available options are:\n", f);
3642 print_options(innduct_options, f);
3645 static void help(const Option *o, const char *val) {
3647 if (ferror(stdout) || fflush(stdout)) {
3648 perror("innduct: writing help");
3654 static void convert_to_periods_rndup(int *store) {
3655 *store += period_seconds-1;
3656 *store /= period_seconds;
3659 int main(int argc, char **argv) {
3665 parse_options(innduct_options, &argv);
3670 if (!sitename) badusage("need site name argument");
3671 remote_host= *argv++;
3672 if (*argv) badusage("too many non-option arguments");
3676 int r= innconf_read(inndconffile);
3677 if (!r) badusage("could not read inn.conf (more info on stderr)");
3679 if (!remote_host) remote_host= sitename;
3681 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3682 badusage("nocheck threshold percentage must be between 0..100");
3683 nocheck_thresh *= 0.01;
3685 if (nocheck_decay < 0.1)
3686 badusage("nocheck decay articles must be at least 0.1");
3687 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3689 convert_to_periods_rndup(&reconnect_delay_periods);
3690 convert_to_periods_rndup(&flushfail_retry_periods);
3691 convert_to_periods_rndup(&backlog_retry_minperiods);
3692 convert_to_periods_rndup(&backlog_spontrescan_periods);
3693 convert_to_periods_rndup(&spontaneous_flush_periods);
3694 convert_to_periods_rndup(&max_separated_periods);
3695 convert_to_periods_rndup(&need_activity_periods);
3697 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3698 badusage("bad input data ratio must be between 0..100");
3699 max_bad_data_ratio *= 0.01;
3702 feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3703 } else if (!feedfile[0]) {
3704 badusage("feed filename must be nonempty");
3705 } else if (feedfile[strlen(feedfile)-1]=='/') {
3706 feedfile= xasprintf("%s%s",feedfile,sitename);
3709 if (max_queue_per_ipf<0)
3710 max_queue_per_ipf= max_queue_per_conn * 2;
3712 const char *feedfile_forbidden= "?*[~#";
3714 while ((c= *feedfile_forbidden++))
3715 if (strchr(feedfile, c))
3716 badusage("feed filename may not contain metacharacter %c",c);
3720 path_lock= xasprintf("%s_lock", feedfile);
3721 path_flushing= xasprintf("%s_flushing", feedfile);
3722 path_defer= xasprintf("%s_defer", feedfile);
3723 path_control= xasprintf("%s_control", feedfile);
3724 path_dump= xasprintf("%s_dump", feedfile);
3725 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3727 oop_source_sys *sysloop= oop_sys_new();
3728 if (!sysloop) sysdie("could not create liboop event loop");
3729 loop= (oop_source*)sysloop;
3733 if (become_daemon) {
3735 for (i=3; i<255; i++)
3736 /* do this now before we open syslog, etc. */
3738 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3740 int null= open("/dev/null",O_RDWR);
3741 if (null<0) sysfatal("failed to open /dev/null");
3745 xclose(null, "/dev/null original fd",0);
3747 pid_t child1= xfork("daemonise first fork");
3748 if (child1) _exit(0);
3750 pid_t sid= setsid();
3751 if (sid != child1) sysfatal("setsid failed");
3753 pid_t child2= xfork("daemonise second fork");
3754 if (child2) _exit(0);
3758 if (self_pid==-1) sysdie("getpid");
3767 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3768 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3777 notice("filemon: suppressed by command line option, polling");
3779 filemon_ok= filemon_method_init();
3781 warn("filemon: no file monitoring available, polling");
3784 every(filepoll_seconds,0,filepoll);
3786 every(period_seconds,1,period);
3792 void *run= oop_sys_run(sysloop);
3793 assert(run == OOP_ERROR);
3794 sysdie("event loop failed");