3 * tailing reliable realtime streaming feeder for inn
5 * Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * (I believe that when you compile and link this as part of the inn2
21 * build, with the Makefile runes I have provided, all the libraries
22 * and files which end up included in innduct are licence-compatible
23 * with GPLv3. If not then please let me know. -Ian Jackson.)
27 * Newsfeeds file entries should look like this:
28 * host.name.of.site[/exclude,exclude,...]\
29 * :pattern,pattern...[/distribution,distribution...]\
33 * sitename[/exclude,exclude,...]\
34 * :pattern,pattern...[/distribution,distribution...]\
40 * or might be blanked out
41 * <spc><spc><spc><spc>....
43 * F site.name main feed file
44 * opened/created, then written, by innd
47 * tokens blanked out by duct when processed
48 * site.name_lock lock preventing multiple ducts
49 * to hold lock must open,F_SETLK[W]
50 * and then stat to check that locked file
51 * still has name site.name_lock
52 * holder of this lock is "duct"
53 * (only) lockholder may remove the lockfile
54 * D site.name_flushing temporary feed file during flush (or crash)
55 * hardlink created by duct
57 * site.name_defer 431'd articles, still being written,
58 * created, written, used by duct
60 * site.name_backlog.<date>.<inum>
61 * 431'd articles, ready for innxmit or duct
62 * created (link/mv) by duct
63 * site.name_backlog<anything-else> (where <anything-else> does not
64 * contain '#' or '~') eg
65 * site.name_backlog.manual
66 * anything the sysadmin likes (eg, feed files
67 * from old feeds to be merged into this one)
68 * created (link/mv) by admin
69 * may be symlinks (in which case links
70 * may be written through, but only links
73 * It is safe to remove backlog files manually,
74 * if it's desired to throw away the backlog.
76 * Backlog files are also processed by innduct. We find the oldest
77 * backlog file which is at least a certain amount old, and feed it
78 * back into our processing. When every article in it has been read
79 * and processed, we unlink it and look for another backlog file.
81 * If we don't have a backlog file that we're reading, we close the
82 * defer file that we're writing and make it into a backlog file at
83 * the first convenient opportunity.
94 | | <----------------<---------------------------------'|
100 | F: innd writing, duct reading |
103 | | duct decides time to flush |
104 | | duct makes hardlink |
106 | V <------------------------'|
108 | F == D: innd writing, duct reading both exist |
111 | | <-----------<-------------<--'|
112 | | open D F ENOENT |
115 | V <---------------------. |
118 | D: innd writing, duct reading; or ENOENT | |
120 | | duct requests flush of feed | |
121 | | (others can too, harmlessly) | |
125 | D: innd flushing, duct; or ENOENT | |
127 | | inndcomm flush fails | |
128 | |`-------------------------->------------------' |
130 | | inndcomm reports no such site |
131 | |`---------------------------------------------------- | -.
133 | | innd finishes writing D, creates F | |
134 | | inndcomm reports flush successful | |
137 | Separated <----------------' |
138 | F: innd writing F!=D /
139 | D: duct reading; or ENOENT both exist /
141 | | duct gets to the end of D /
142 | | duct opens F too /
145 | F: innd writing, duct reading |
146 | D: duct finishing V
148 | | duct finishes processing D F: ENOENT
149 | V duct unlinks D D: duct reading
151 `--<--' | duct finishes
161 "duct reading" means innduct is reading the file but also
162 overwriting processed tokens.
166 * rune for printing diagrams:
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
173 /*============================== PROGRAM ==============================*/
175 #define _GNU_SOURCE 1
181 #include "inndcomm.h"
183 #include "inn/list.h"
184 #include "inn/innconf.h"
187 #include <sys/types.h>
188 #include <sys/wait.h>
189 #include <sys/stat.h>
190 #include <sys/socket.h>
209 #include <oop-read.h>
211 /*----- general definitions, probably best not changed -----*/
213 #define CONNCHILD_ESTATUS_STREAM 24
214 #define CONNCHILD_ESTATUS_NOSTREAM 25
216 #define INNDCOMMCHILD_ESTATUS_FAIL 26
217 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
219 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
220 #define MAX_CONTROL_COMMAND 1000
222 #define VA va_list al; va_start(al,fmt)
223 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
224 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
225 #define NORET __attribute__((__noreturn__))
227 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
228 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
230 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
232 #define FOR_CONN(conn) \
233 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
235 /*----- doubly linked lists -----*/
237 #define ISNODE(T) struct node list_node
240 union { struct list li; T *for_type; } u; \
244 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
246 #define LIST_CHECKCANHAVENODE(l,n) \
247 ((void)((n) == ((l).u.for_type))) /* just for the type check */
249 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
250 ( LIST_CHECKCANHAVENODE(l,n), \
251 list_addsomehow(&(l).u.li, NODE((n))), \
255 #define LIST_REMSOMEHOW(l,list_remsomehow) \
256 ( (typeof((l).u.for_type)) \
259 list_remsomehow(&(l).u.li) ) \
265 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
266 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
267 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
268 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
270 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
271 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
272 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
273 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
275 #define LIST_REMOVE(l,n) \
276 ( LIST_CHECKCANHAVENODE(l,n), \
277 list_remove(NODE((n))), \
281 #define LIST_INSERT(l,n,pred) \
282 ( LIST_CHECKCANHAVENODE(l,n), \
283 LIST_CHECKCANHAVENODE(l,pred), \
284 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
288 /*----- type predeclarations -----*/
290 typedef struct Conn Conn;
291 typedef struct Article Article;
292 typedef struct InputFile InputFile;
293 typedef struct XmitDetails XmitDetails;
294 typedef struct Filemon_Perfile Filemon_Perfile;
295 typedef enum StateMachineState StateMachineState;
296 typedef struct ControlCommand ControlCommand;
301 /*----- function predeclarations -----*/
303 static void conn_maybe_write(Conn *conn);
304 static void conn_make_some_xmits(Conn *conn);
305 static void *conn_write_some_xmits(Conn *conn);
307 static void xmit_free(XmitDetails *d);
309 #define SMS(newstate, periods, why) \
310 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
311 static void statemc_setstate(StateMachineState newsms, int periods,
312 const char *forlog, const char *why);
314 static void statemc_start_flush(const char *why); /* Normal => Flushing */
315 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
316 static int trigger_flush_ok(void); /* => Flushing,FLUSHING, ret 1; or ret 0 */
318 static void article_done(Article *art, int whichcount);
320 static void check_assign_articles(void);
321 static void queue_check_input_done(void);
322 static void check_reading_pause_resume(InputFile *ipf);
324 static void statemc_check_flushing_done(void);
325 static void statemc_check_backlog_done(void);
327 static void postfork(void);
328 static void period(void);
330 static void open_defer(void);
331 static void close_defer(void);
332 static void search_backlog_file(void);
333 static void preterminate(void);
334 static void raise_default(int signo) NORET;
335 static char *debug_report_ipf(InputFile *ipf);
337 static void inputfile_reading_start(InputFile *ipf);
338 static void inputfile_reading_stop(InputFile *ipf);
339 static void inputfile_reading_pause(InputFile *ipf);
340 static void inputfile_reading_resume(InputFile *ipf);
341 /* pause and resume are idempotent, and no-op if not done _reading_start */
343 static void filemon_start(InputFile *ipf);
344 static void filemon_stop(InputFile *ipf);
345 static void filemon_callback(InputFile *ipf);
347 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
348 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
350 static const oop_rd_style peer_rd_style;
351 static oop_rd_call peer_rd_err, peer_rd_ok;
354 /*----- configuration options -----*/
355 /* when changing defaults, remember to update the manpage */
357 static const char *sitename, *remote_host;
358 static const char *feedfile, *realsockdir="/tmp/innduct.control";
359 static int quiet_multiple=0;
360 static int become_daemon=1, try_filemon=1;
361 static int try_stream=1;
363 static const char *inndconffile;
365 static int max_connections=10;
366 static int max_queue_per_conn=200;
367 static int target_max_feedfile_size=100000;
368 static int period_seconds=60;
369 static int filepoll_seconds=5;
370 static int max_queue_per_ipf=-1;
371 static int realsockdir_any_perms=0;
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
376 static double nocheck_thresh= 95.0; /* converted from percentage by main */
377 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=50;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
388 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
389 static int max_bad_data_initial= 30;
390 /* in one corrupt 4096-byte block the number of newlines has
391 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
394 /*----- statistics -----*/
396 typedef enum { /* in queue in conn->sent */
397 art_Unchecked, /* not checked, not sent checking */
398 art_Wanted, /* checked, wanted sent body as requested */
399 art_Unsolicited, /* - sent body without check */
403 static const char *const artstate_names[]=
404 { "Unchecked", "Wanted", "Unsolicited", 0 };
406 #define RESULT_COUNTS(RCS,RCN) \
415 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
416 #define RCI_TRIPLE_VALS_BASE(counts,x) \
417 counts[art_Unchecked] x \
418 + counts[art_Wanted] x \
419 + counts[art_Unsolicited] x, \
420 counts[art_Unchecked] x \
421 , counts[art_Wanted] x \
422 , counts[art_Unsolicited] x
425 #define RC_INDEX(x) RC_##x,
426 RESULT_COUNTS(RC_INDEX, RC_INDEX)
431 /*----- transmission buffers -----*/
447 /*----- core operational data structure types -----*/
450 /* This is also an instance of struct oop_readable */
451 struct oop_readable readable; /* first */
452 oop_readable_call *readable_callback;
453 void *readable_callback_user;
456 Filemon_Perfile *filemon;
458 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
460 int skippinglong, paused;
463 long inprogress; /* includes queue.count and also articles in conns */
464 long autodefer; /* -1 means not doing autodefer */
466 int counts[art_MaxState][RCI_max];
467 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
482 #define SMS_LIST(X) \
490 enum StateMachineState {
491 #define SMS_DEF_ENUM(s) sm_##s,
492 SMS_LIST(SMS_DEF_ENUM)
495 static const char *sms_names[]= {
496 #define SMS_DEF_NAME(s) #s ,
497 SMS_LIST(SMS_DEF_NAME)
503 int fd; /* may be 0, meaning closed (during construction/destruction) */
504 oop_read *rd; /* likewise */
505 int max_queue, stream, quitting;
506 int since_activity; /* periods */
507 ArticleList waiting; /* not yet told peer */
508 ArticleList priority; /* peer says send it now */
509 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
510 struct iovec xmit[CONNIOVS];
511 XmitDetails xmitd[CONNIOVS];
516 /*----- general operational variables -----*/
518 /* main initialises */
519 static oop_source *loop;
520 static ConnList conns;
521 static char *path_lock, *path_flushing, *path_defer;
522 static char *path_control, *path_dump;
523 static char *globpat_backlog;
524 static pid_t self_pid;
526 /* statemc_init initialises */
527 static StateMachineState sms;
528 static int until_flush;
529 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
532 /* initialisation to 0 is good */
533 static int until_connect, until_backlog_nextscan;
534 static double accept_proportion;
535 static int nocheck, nocheck_reported, in_child;
537 /* for simulation, debugging, etc. */
538 int simulate_flush= -1;
540 /*========== logging ==========*/
542 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
543 static void logcore(int sysloglevel, const char *fmt, ...) {
546 vsyslog(sysloglevel,fmt,al);
548 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
549 vfprintf(stderr,fmt,al);
555 static void logv(int sysloglevel, const char *pfx, int errnoval,
556 const char *fmt, va_list al) PRINTF(5,0);
557 static void logv(int sysloglevel, const char *pfx, int errnoval,
558 const char *fmt, va_list al) {
559 char msgbuf[256]; /* NB do not call xvasprintf here or you'll recurse */
560 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
561 msgbuf[sizeof(msgbuf)-1]= 0;
563 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
564 sysloglevel= LOG_ERR; /* run by wrong user, probably */
566 logcore(sysloglevel, "<%s>%s: %s%s%s",
567 sitename, pfx, msgbuf,
568 errnoval>=0 ? ": " : "",
569 errnoval>=0 ? strerror(errnoval) : "");
572 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
573 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
574 static void fn(const char *fmt, ...) { \
577 logv(sysloglevel, pfx, err, fmt, al); \
581 #define logwrap(fn, pfx, sysloglevel, err) \
582 static void fn(const char *fmt, ...) PRINTF(1,2); \
583 static void fn(const char *fmt, ...) { \
585 logv(sysloglevel, pfx, err, fmt, al); \
589 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
590 diewrap(die, " critical", LOG_CRIT, -1, 16);
592 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
593 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
595 logwrap(syswarn, " warning", LOG_WARNING, errno);
596 logwrap(warn, " warning", LOG_WARNING, -1);
598 logwrap(notice, " notice", LOG_NOTICE, -1);
599 logwrap(info, " info", LOG_INFO, -1);
600 logwrap(debug, " debug", LOG_DEBUG, -1);
603 /*========== utility functions etc. ==========*/
605 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
606 static char *xvasprintf(const char *fmt, va_list al) {
608 int rc= vasprintf(&str,fmt,al);
609 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
612 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
613 static char *xasprintf(const char *fmt, ...) {
615 char *str= xvasprintf(fmt,al);
620 static int close_perhaps(int *fd) {
621 if (*fd <= 0) return 0;
626 static void xclose(int fd, const char *what, const char *what2) {
628 if (r) sysdie("close %s%s",what,what2?what2:"");
630 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
631 if (*fd <= 0) return;
632 xclose(*fd,what,what2);
636 static pid_t xfork(const char *what) {
640 if (child==-1) sysfatal("cannot fork for %s",what);
641 debug("forked %s %ld", what, (unsigned long)child);
642 if (!child) postfork();
646 static void on_fd_read_except(int fd, oop_call_fd callback) {
647 loop->on_fd(loop, fd, OOP_READ, callback, 0);
648 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
650 static void cancel_fd_read_except(int fd) {
651 loop->cancel_fd(loop, fd, OOP_READ);
652 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
655 static void report_child_status(const char *what, int status) {
656 if (WIFEXITED(status)) {
657 int es= WEXITSTATUS(status);
659 warn("%s: child died with error exit status %d", what, es);
660 } else if (WIFSIGNALED(status)) {
661 int sig= WTERMSIG(status);
662 const char *sigstr= strsignal(sig);
663 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
665 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
667 warn("%s: child died due to unknown fatal signal %d%s",
668 what, sig, coredump);
670 warn("%s: child died with unknown wait status %d", what,status);
674 static int xwaitpid(pid_t *pid, const char *what) {
677 int r= kill(*pid, SIGKILL);
678 if (r) sysdie("cannot kill %s child", what);
680 pid_t got= waitpid(*pid, &status, 0);
681 if (got==-1) sysdie("cannot reap %s child", what);
682 if (got==0) die("cannot reap %s child", what);
689 static void *zxmalloc(size_t sz) {
690 void *p= xmalloc(sz);
695 static void xunlink(const char *path, const char *what) {
697 if (r) sysdie("can't unlink %s %s", path, what);
700 static time_t xtime(void) {
702 if (now==-1) sysdie("time(2) failed");
706 static void xsigaction(int signo, const struct sigaction *sa) {
707 int r= sigaction(signo,sa,0);
708 if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
711 static void xsigsetdefault(int signo) {
713 memset(&sa,0,sizeof(sa));
714 sa.sa_handler= SIG_DFL;
715 xsigaction(signo,&sa);
718 static void xgettimeofday(struct timeval *tv_r) {
719 int r= gettimeofday(tv_r,0);
720 if (r) sysdie("gettimeofday(2) failed");
723 static void xsetnonblock(int fd, int nonblocking) {
724 int errnoval= oop_fd_nonblock(fd, nonblocking);
725 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
728 static void check_isreg(const struct stat *stab, const char *path,
730 if (!S_ISREG(stab->st_mode))
731 die("%s %s not a plain file (mode 0%lo)",
732 what, path, (unsigned long)stab->st_mode);
735 static void xfstat(int fd, struct stat *stab_r, const char *what) {
736 int r= fstat(fd, stab_r);
737 if (r) sysdie("could not fstat %s", what);
740 static void xfstat_isreg(int fd, struct stat *stab_r,
741 const char *path, const char *what) {
742 xfstat(fd, stab_r, what);
743 check_isreg(stab_r, path, what);
746 static void xlstat_isreg(const char *path, struct stat *stab,
747 int *enoent_r /* 0 means ENOENT is fatal */,
749 int r= lstat(path, stab);
751 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
752 sysdie("could not lstat %s %s", what, path);
754 if (enoent_r) *enoent_r= 0;
755 check_isreg(stab, path, what);
758 static int samefile(const struct stat *a, const struct stat *b) {
759 assert(S_ISREG(a->st_mode));
760 assert(S_ISREG(b->st_mode));
761 return (a->st_ino == b->st_ino &&
762 a->st_dev == b->st_dev);
765 static char *sanitise(const char *input, int len) {
766 static char sanibuf[100]; /* returns pointer to this buffer! */
768 const char *p= input;
769 const char *endp= len>=0 ? input+len : 0;
773 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
774 int c= (!endp || p<endp) ? *p++ : 0;
775 if (!c) { *q++= '\''; *q=0; break; }
776 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
777 sprintf(q,"\\x%02x",c);
783 static int isewouldblock(int errnoval) {
784 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
787 /*========== command and control connections ==========*/
789 static int control_master;
791 typedef struct ControlConn ControlConn;
793 void (*destroy)(ControlConn*);
799 struct sockaddr_un un;
804 static const oop_rd_style control_rd_style= {
805 OOP_RD_DELIM_STRIP, '\n',
807 OOP_RD_SHORTREC_FORBID
810 static void control_destroy(ControlConn *cc) {
814 static void control_checkouterr(ControlConn *cc /* may destroy*/) {
815 if (ferror(cc->out) | fflush(cc->out)) {
816 info("CTRL%d write error %s", cc->fd, strerror(errno));
821 static void control_prompt(ControlConn *cc /* may destroy*/) {
822 fprintf(cc->out, "%s| ", sitename);
823 control_checkouterr(cc);
826 struct ControlCommand {
828 void (*f)(ControlConn *cc, const ControlCommand *ccmd,
829 const char *arg, size_t argsz);
834 static const ControlCommand control_commands[];
837 static void ccmd_##wh(ControlConn *cc, const ControlCommand *c, \
838 const char *arg, size_t argsz)
841 fputs("commands:\n", cc->out);
842 const ControlCommand *ccmd;
843 for (ccmd=control_commands; ccmd->cmd; ccmd++)
844 fprintf(cc->out, " %s\n", ccmd->cmd);
845 fputs("NB: permissible arguments are not shown above."
846 " Not all commands listed are safe. See innduct(8).\n", cc->out);
850 int ok= trigger_flush_ok();
851 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
856 notice("terminating (CTRL%d)",cc->fd);
857 raise_default(SIGTERM);
863 /* messing with our head: */
864 CCMD(period) { period(); }
865 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
866 CCMD(setint) { *(int*)c->xdata= c->xval; }
867 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
869 static const ControlCommand control_commands[]= {
871 { "flush", ccmd_flush },
872 { "stop", ccmd_stop },
873 { "dump q", ccmd_dump, 0,0 },
874 { "dump a", ccmd_dump, 0,1 },
876 { "p", ccmd_period },
878 #define POKES(cmd,func) \
879 { cmd "flush", func, &until_flush, 1 }, \
880 { cmd "conn", func, &until_connect, 0 }, \
881 { cmd "blscan", func, &until_backlog_nextscan, 0 },
882 POKES("next ", ccmd_setint)
883 POKES("prod ", ccmd_setint_period)
885 { "pretend flush", ccmd_setintarg, &simulate_flush },
886 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
890 static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
891 const char *errmsg, int errnoval,
892 const char *data, size_t recsz, void *cc_v) {
893 ControlConn *cc= cc_v;
896 info("CTRL%d closed", cc->fd);
901 if (recsz == 0) goto prompt;
903 const ControlCommand *ccmd;
904 for (ccmd=control_commands; ccmd->cmd; ccmd++) {
905 int l= strlen(ccmd->cmd);
906 if (recsz < l) continue;
907 if (recsz > l && data[l] != ' ') continue;
908 if (memcmp(data, ccmd->cmd, l)) continue;
910 int argl= (int)recsz - (l+1);
911 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
915 fputs("unknown command; h for help\n", cc->out);
922 static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
923 const char *errmsg, int errnoval,
924 const char *data, size_t recsz, void *cc_v) {
925 ControlConn *cc= cc_v;
927 info("CTRL%d read error %s", cc->fd, errmsg);
932 static int control_conn_startup(ControlConn *cc /* may destroy*/,
934 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
935 if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
937 int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
940 if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
942 info("CTRL%d %s ready", cc->fd, how);
947 static void control_stdio_destroy(ControlConn *cc) {
949 oop_rd_cancel(cc->rd);
950 errno= oop_rd_delete_tidy(cc->rd);
951 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
956 static void control_stdio(void) {
957 NEW_DECL(ControlConn *,cc);
958 cc->destroy= control_stdio_destroy;
962 int r= control_conn_startup(cc,"stdio");
963 if (r) cc->destroy(cc);
966 static void control_accepted_destroy(ControlConn *cc) {
968 oop_rd_cancel(cc->rd);
969 oop_rd_delete_kill(cc->rd);
971 if (cc->out) { fclose(cc->out); cc->fd=0; }
972 close_perhaps(&cc->fd);
976 static void *control_master_readable(oop_source *lp, int master,
977 oop_event ev, void *u) {
978 NEW_DECL(ControlConn *,cc);
979 cc->destroy= control_accepted_destroy;
981 cc->salen= sizeof(cc->sa);
982 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
983 if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
985 cc->out= fdopen(cc->fd, "w");
986 if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
988 int r= control_conn_startup(cc, "accepted");
998 #define NOCONTROL(...) do{ \
999 syswarn("no control socket, because failed to " __VA_ARGS__); \
1003 static void control_init(void) {
1008 struct sockaddr_un un;
1011 memset(&sa,0,sizeof(sa));
1012 int maxlen= sizeof(sa.un.sun_path);
1014 int reallen= readlink(path_control, sa.un.sun_path, maxlen);
1016 if (errno != ENOENT)
1017 NOCONTROL("readlink control socket symlink path %s", path_control);
1019 if (reallen >= maxlen) {
1020 debug("control socket symlink path too long (r=%d)",reallen);
1021 xunlink(path_control, "old (overlong) control socket symlink");
1027 int r= lstat(realsockdir,&stab);
1029 if (errno != ENOENT) NOCONTROL("lstat real socket dir %s", realsockdir);
1031 r= mkdir(realsockdir, 0700);
1032 if (r) NOCONTROL("mkdir real socket dir %s", realsockdir);
1034 } else if (!realsockdir_any_perms) {
1035 uid_t self= geteuid();
1036 if (!S_ISDIR(stab.st_mode) ||
1037 stab.st_uid != self ||
1038 stab.st_mode & 0007) {
1039 warn("no control socket, because real socket directory"
1040 " is somehow wrong (ISDIR=%d, uid=%lu (exp.%lu), mode %lo)",
1041 !!S_ISDIR(stab.st_mode),
1042 (unsigned long)stab.st_uid, (unsigned long)self,
1043 (unsigned long)stab.st_mode & 0777UL);
1048 real= xasprintf("%s/s%lx.%lx", realsockdir,
1049 (unsigned long)xtime(), (unsigned long)self_pid);
1050 int reallen= strlen(real);
1052 if (reallen >= maxlen) {
1053 warn("no control socket, because tmpnam gave overly-long path"
1057 r= symlink(real, path_control);
1058 if (r) NOCONTROL("make control socket path %s a symlink to real"
1059 " socket path %s", path_control, real);
1060 memcpy(sa.un.sun_path, real, reallen);
1063 int r= unlink(sa.un.sun_path);
1064 if (r && errno!=ENOENT)
1065 NOCONTROL("remove old real socket %s", sa.un.sun_path);
1067 control_master= socket(PF_UNIX, SOCK_STREAM, 0);
1068 if (control_master<0) NOCONTROL("create new control socket");
1070 sa.un.sun_family= AF_UNIX;
1071 int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
1072 r= bind(control_master, &sa.sa, sl);
1073 if (r) NOCONTROL("bind to real socket path %s", sa.un.sun_path);
1075 r= listen(control_master, 5);
1076 if (r) NOCONTROL("listen");
1078 xsetnonblock(control_master, 1);
1080 loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
1081 info("control socket ok, real path %s", sa.un.sun_path);
1087 xclose_perhaps(&control_master, "control master",0);
1091 /*========== management of connections ==========*/
1093 static void conn_closefd(Conn *conn, const char *msgprefix) {
1094 int r= close_perhaps(&conn->fd);
1095 if (r) info("C%d %serror closing socket: %s",
1096 conn->fd, msgprefix, strerror(errno));
1099 static void conn_dispose(Conn *conn) {
1102 oop_rd_cancel(conn->rd);
1103 oop_rd_delete_kill(conn->rd);
1107 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1108 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1110 conn_closefd(conn,"");
1112 until_connect= reconnect_delay_periods;
1115 static void *conn_exception(oop_source *lp, int fd,
1116 oop_event ev, void *conn_v) {
1119 assert(fd == conn->fd);
1120 assert(ev == OOP_EXCEPTION);
1121 int r= read(conn->fd, &ch, 1);
1122 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1123 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1124 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1125 return OOP_CONTINUE;
1128 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1129 int requeue[art_MaxState];
1130 memset(requeue,0,sizeof(requeue));
1134 while ((art= LIST_REMHEAD(conn->priority)))
1135 LIST_ADDTAIL(art->ipf->queue, art);
1137 while ((art= LIST_REMHEAD(conn->waiting)))
1138 LIST_ADDTAIL(art->ipf->queue, art);
1140 while ((art= LIST_REMHEAD(conn->sent))) {
1141 requeue[art->state]++;
1142 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1143 LIST_ADDTAIL(art->ipf->queue,art);
1144 check_reading_pause_resume(art->ipf);
1149 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1152 char *m= xvasprintf(fmt,al);
1153 warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1154 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1157 LIST_REMOVE(conns,conn);
1159 check_assign_articles();
1162 static void connfail(Conn *conn, const char *fmt, ...) {
1165 vconnfail(conn,fmt,al);
1169 static void check_idle_conns(void) {
1172 conn->since_activity++;
1175 if (conn->since_activity <= need_activity_periods) continue;
1177 /* We need to shut this down */
1179 connfail(conn,"timed out waiting for response to QUIT");
1180 else if (conn->sent.count)
1181 connfail(conn,"timed out waiting for responses");
1182 else if (conn->waiting.count || conn->priority.count)
1183 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1184 else if (conn->xmitu)
1185 connfail(conn,"peer has been sending responses"
1186 " before receiving our commands!");
1188 static const char quitcmd[]= "QUIT\r\n";
1189 int todo= sizeof(quitcmd)-1;
1190 const char *p= quitcmd;
1192 int r= write(conn->fd, p, todo);
1194 if (isewouldblock(errno))
1195 connfail(conn, "blocked writing QUIT to idle connection");
1197 connfail(conn, "failed to write QUIT to idle connection: %s",
1205 conn->since_activity= 0;
1206 debug("C%d is idle, quitting", conn->fd);
1215 /*---------- making new connections ----------*/
1217 static pid_t connecting_child;
1218 static int connecting_fdpass_sock;
1220 static void connect_attempt_discard(void) {
1221 if (connecting_child) {
1222 int status= xwaitpid(&connecting_child, "connect");
1223 if (!(WIFEXITED(status) ||
1224 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1225 report_child_status("connect", status);
1227 if (connecting_fdpass_sock) {
1228 cancel_fd_read_except(connecting_fdpass_sock);
1229 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1233 #define PREP_DECL_MSG_CMSG(msg) \
1235 struct iovec msgiov; \
1236 msgiov.iov_base= &msgbyte; \
1237 msgiov.iov_len= 1; \
1238 struct msghdr msg; \
1239 memset(&msg,0,sizeof(msg)); \
1240 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1241 msg.msg_iov= &msgiov; \
1242 msg.msg_iovlen= 1; \
1243 msg.msg_control= msg##cbuf; \
1244 msg.msg_controllen= sizeof(msg##cbuf);
1246 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1249 assert(fd == connecting_fdpass_sock);
1251 PREP_DECL_MSG_CMSG(msg);
1253 ssize_t rs= recvmsg(fd, &msg, 0);
1255 if (isewouldblock(errno)) return OOP_CONTINUE;
1256 syswarn("failed to read socket from connecting child");
1261 LIST_INIT(conn->waiting);
1262 LIST_INIT(conn->priority);
1263 LIST_INIT(conn->sent);
1265 struct cmsghdr *h= 0;
1266 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1268 int status= xwaitpid(&connecting_child, "connect child (broken)");
1270 if (WIFEXITED(status)) {
1271 if (WEXITSTATUS(status) != 0 &&
1272 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1273 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1274 /* child already reported the problem */;
1276 if (e == OOP_EXCEPTION)
1277 warn("connect: connection child exited code %d but"
1278 " unexpected exception on fdpass socket",
1279 WEXITSTATUS(status));
1281 warn("connect: connection child exited code %d but"
1283 WEXITSTATUS(status), (int)rs);
1285 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1286 warn("connect: connection attempt timed out");
1288 report_child_status("connect", status);
1293 #define CHK(field, val) \
1294 if (h->cmsg_##field != val) { \
1295 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1296 h->cmsg_##field, val); \
1299 CHK(level, SOL_SOCKET);
1300 CHK(type, SCM_RIGHTS);
1301 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1304 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1306 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1309 pid_t got= waitpid(connecting_child, &status, 0);
1310 if (got==-1) sysdie("connect: real wait for child");
1311 assert(got == connecting_child);
1312 connecting_child= 0;
1314 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1315 int es= WEXITSTATUS(status);
1317 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1318 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1320 fatal("connect: child gave unexpected exit status %d", es);
1324 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1326 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1327 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1328 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1329 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1331 &peer_rd_err, conn);
1332 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1334 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1335 LIST_ADDHEAD(conns, conn);
1337 connect_attempt_discard();
1338 check_assign_articles();
1339 return OOP_CONTINUE;
1343 connect_attempt_discard();
1344 return OOP_CONTINUE;
1347 static int allow_connect_start(void) {
1348 return conns.count < max_connections
1349 && !connecting_child
1353 static void connect_start(void) {
1354 assert(!connecting_child);
1355 assert(!connecting_fdpass_sock);
1357 info("starting connection attempt");
1360 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1361 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1363 connecting_child= xfork("connection");
1365 if (!connecting_child) {
1366 FILE *cn_from, *cn_to;
1367 char buf[NNTP_STRLEN+100];
1368 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1370 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1372 alarm(connection_setup_timeout);
1373 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1377 unsigned char c= buf[l-1];
1378 if (!isspace(c)) break;
1379 if (c=='\n' || c=='\r') stripped=1;
1383 sysfatal("connect: connection attempt failed");
1386 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1390 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1391 sysfatal("connect: authentication failed");
1393 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1395 sysfatal("connect: could not send MODE STREAM");
1396 buf[sizeof(buf)-1]= 0;
1397 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1398 if (ferror(cn_from))
1399 sysfatal("connect: could not read response to MODE STREAM");
1401 fatal("connect: connection close in response to MODE STREAM");
1406 fatal("connect: response to MODE STREAM is too long: %.100s...",
1408 l--; if (l>0 && buf[l-1]=='\r') l--;
1411 int rcode= strtoul(buf,&ep,10);
1413 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1417 exitstatus= CONNCHILD_ESTATUS_STREAM;
1423 warn("connect: unexpected response to MODE STREAM: %.50s",
1429 int fd= fileno(cn_from);
1431 PREP_DECL_MSG_CMSG(msg);
1432 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1433 cmsg->cmsg_level= SOL_SOCKET;
1434 cmsg->cmsg_type= SCM_RIGHTS;
1435 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1436 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1438 msg.msg_controllen= cmsg->cmsg_len;
1439 r= sendmsg(socks[1], &msg, 0);
1440 if (r<0) sysdie("sendmsg failed for new connection");
1441 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1446 xclose(socks[1], "connecting fdpass child's socket",0);
1447 connecting_fdpass_sock= socks[0];
1448 xsetnonblock(connecting_fdpass_sock, 1);
1449 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1452 /*---------- assigning articles to conns, and transmitting ----------*/
1454 static Article *dequeue_from(int peek, InputFile *ipf) {
1456 if (peek) return LIST_HEAD(ipf->queue);
1458 Article *art= LIST_REMHEAD(ipf->queue);
1460 check_reading_pause_resume(ipf);
1464 static Article *dequeue(int peek) {
1466 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1467 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1468 art= dequeue_from(peek, main_input_file); if (art) return art;
1472 static void check_assign_articles(void) {
1478 int spare=0, inqueue=0;
1480 /* Find a connection to offer this article. We prefer a busy
1481 * connection to an idle one, provided it's not full. We take the
1482 * first (oldest) and since that's stable, it will mean we fill up
1483 * connections in order. That way if we have too many
1484 * connections, the spare ones will go away eventually.
1487 if (walk->quitting) continue;
1488 inqueue= walk->sent.count + walk->priority.count
1489 + walk->waiting.count;
1490 spare= walk->max_queue - inqueue;
1491 assert(inqueue <= max_queue_per_conn);
1493 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1494 else if (spare>0) /*working*/ { use= walk; break; }
1497 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1499 Article *art= dequeue(0);
1501 LIST_ADDTAIL(use->waiting, art);
1504 conn_maybe_write(use);
1505 } else if (allow_connect_start()) {
1506 until_connect= reconnect_delay_periods;
1515 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1516 conn_maybe_write(u);
1517 return OOP_CONTINUE;
1520 static void conn_maybe_write(Conn *conn) {
1522 conn_make_some_xmits(conn);
1524 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1528 void *rp= conn_write_some_xmits(conn);
1529 if (rp==OOP_CONTINUE) {
1530 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1532 } else if (rp==OOP_HALT) {
1535 /* transmitted everything */
1542 /*---------- expiry, flow control and deferral ----------*/
1545 * flow control notes
1546 * to ensure articles go away eventually
1547 * separate queue for each input file
1549 * every period, check head of backlog queue for expiry with SMretrieve
1550 * if too old: discard, and check next article
1551 * also check every backlog article as we read it
1553 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1554 * one-off: eat queued articles from flushing and write them to defer
1555 * one-off: connfail all connections which have any articles from flushing
1556 * newly read articles from flushing go straight to defer
1557 * this should take care of it and get us out of this state
1558 * to avoid filling up ram needlessly
1560 * limit number of queued articles for each ipf
1561 * pause/resume inputfile tailing
1564 static void check_reading_pause_resume(InputFile *ipf) {
1565 if (ipf->queue.count >= max_queue_per_ipf)
1566 inputfile_reading_pause(ipf);
1568 inputfile_reading_resume(ipf);
1571 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1573 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1575 sysfatal("write to defer file %s",path_defer);
1576 article_done(art, whichcount);
1579 static int article_check_expired(Article *art /* must be queued, not conn */) {
1580 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1581 if (artdata) { SMfreearticle(artdata); return 0; }
1583 LIST_REMOVE(art->ipf->queue, art);
1585 art->ipf->count_nooffer_missing++;
1586 article_done(art,-1);
1590 static void inputfile_queue_check_expired(InputFile *ipf) {
1594 Article *art= LIST_HEAD(ipf->queue);
1595 int exp= article_check_expired(art);
1598 check_reading_pause_resume(ipf);
1601 static void article_autodefer(InputFile *ipf, Article *art) {
1603 article_defer(art,-1);
1606 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1608 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1609 if (art->ipf == ipf) return 1;
1613 static void autodefer_input_file_articles(InputFile *ipf) {
1615 while ((art= LIST_REMHEAD(ipf->queue)))
1616 article_autodefer(ipf, art);
1619 static void autodefer_input_file(InputFile *ipf) {
1622 autodefer_input_file_articles(ipf);
1624 if (ipf->inprogress) {
1627 if (has_article_in(&walk->waiting, ipf) ||
1628 has_article_in(&walk->priority, ipf) ||
1629 has_article_in(&walk->sent, ipf))
1632 while (ipf->inprogress) {
1634 if (walk->quitting < 0) goto found;
1635 abort(); /* where are they ?? */
1638 connfail(walk, "connection is stuck or crawling,"
1639 " and we need to finish flush");
1640 autodefer_input_file_articles(ipf);
1644 check_reading_pause_resume(ipf);
1647 /*========== article transmission ==========*/
1649 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1650 XmitKind kind) { /* caller must then fill in details */
1651 struct iovec *v= &conn->xmit[conn->xmitu];
1652 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1653 v->iov_base= (char*)data;
1659 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1660 xmit_core(conn,data,len, xk_Const);
1662 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1664 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1665 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1669 static void xmit_free(XmitDetails *d) {
1671 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1672 case xk_Const: break;
1677 static void *conn_write_some_xmits(Conn *conn) {
1679 * 0: nothing more to write, no need to call us again
1680 * OOP_CONTINUE: more to write but fd not writeable
1681 * OOP_HALT: disaster, have destroyed conn
1684 int count= conn->xmitu;
1685 if (!count) return 0;
1687 if (count > IOV_MAX) count= IOV_MAX;
1688 ssize_t rs= writev(conn->fd, conn->xmit, count);
1690 if (isewouldblock(errno)) return OOP_CONTINUE;
1691 connfail(conn, "write failed: %s", strerror(errno));
1697 for (done=0; rs && done<conn->xmitu; done++) {
1698 struct iovec *vp= &conn->xmit[done];
1699 XmitDetails *dp= &conn->xmitd[done];
1700 if (rs > vp->iov_len) {
1704 vp->iov_base= (char*)vp->iov_base + rs;
1708 int newu= conn->xmitu - done;
1709 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1710 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1715 static void conn_make_some_xmits(Conn *conn) {
1717 if (conn->xmitu+5 > CONNIOVS)
1720 Article *art= LIST_REMHEAD(conn->priority);
1721 if (!art) art= LIST_REMHEAD(conn->waiting);
1724 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1725 /* actually send it */
1727 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1730 art->state == art_Unchecked ? art_Unsolicited :
1731 art->state == art_Wanted ? art_Wanted :
1734 if (!artdata) art->missing= 1;
1735 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1739 XMIT_LITERAL("TAKETHIS ");
1740 xmit_noalloc(conn, art->messageid, art->midlen);
1741 XMIT_LITERAL("\r\n");
1742 xmit_artbody(conn, artdata);
1744 article_done(art, -1);
1748 /* we got 235 from IHAVE */
1750 xmit_artbody(conn, artdata);
1752 XMIT_LITERAL(".\r\n");
1756 LIST_ADDTAIL(conn->sent, art);
1762 XMIT_LITERAL("CHECK ");
1764 XMIT_LITERAL("IHAVE ");
1765 xmit_noalloc(conn, art->messageid, art->midlen);
1766 XMIT_LITERAL("\r\n");
1768 assert(art->state == art_Unchecked);
1769 art->ipf->counts[art->state][RC_sent]++;
1770 LIST_ADDTAIL(conn->sent, art);
1775 /*========== handling responses from peer ==========*/
1777 static const oop_rd_style peer_rd_style= {
1778 OOP_RD_DELIM_STRIP, '\n',
1780 OOP_RD_SHORTREC_FORBID
1783 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1784 const char *errmsg, int errnoval,
1785 const char *data, size_t recsz, void *conn_v) {
1787 connfail(conn, "error receiving from peer: %s", errmsg);
1788 return OOP_CONTINUE;
1791 static Article *article_reply_check(Conn *conn, const char *response,
1792 int code_indicates_streaming,
1794 /* 1:yes, -1:no, 0:dontcare */,
1795 const char *sanitised_response) {
1796 Article *art= LIST_HEAD(conn->sent);
1800 "peer gave unexpected response when no commands outstanding: %s",
1801 sanitised_response);
1805 if (code_indicates_streaming) {
1806 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1807 if (!conn->stream) {
1808 connfail(conn, "peer gave streaming response code "
1809 " to IHAVE or subsequent body: %s", sanitised_response);
1812 const char *got_mid= response+4;
1813 int got_midlen= strcspn(got_mid, " \n\r");
1814 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1815 connfail(conn, "peer gave streaming response with syntactically invalid"
1816 " messageid: %s", sanitised_response);
1819 if (got_midlen != art->midlen ||
1820 memcmp(got_mid, art->messageid, got_midlen)) {
1821 connfail(conn, "peer gave streaming response code to wrong article -"
1822 " probable synchronisation problem; we offered: %s;"
1824 art->messageid, sanitised_response);
1829 connfail(conn, "peer gave non-streaming response code to"
1830 " CHECK/TAKETHIS: %s", sanitised_response);
1835 if (must_have_sent>0 && art->state < art_Wanted) {
1836 connfail(conn, "peer says article accepted but"
1837 " we had not sent the body: %s", sanitised_response);
1840 if (must_have_sent<0 && art->state >= art_Wanted) {
1841 connfail(conn, "peer says please sent the article but we just did: %s",
1842 sanitised_response);
1846 Article *art_again= LIST_REMHEAD(conn->sent);
1847 assert(art_again == art);
1851 static void update_nocheck(int accepted) {
1852 accept_proportion *= nocheck_decay;
1853 accept_proportion += accepted * (1.0 - nocheck_decay);
1854 int new_nocheck= accept_proportion >= nocheck_thresh;
1855 if (new_nocheck && !nocheck_reported) {
1856 notice("entering nocheck mode for the first time");
1857 nocheck_reported= 1;
1858 } else if (new_nocheck != nocheck) {
1859 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1861 nocheck= new_nocheck;
1864 static void article_done(Article *art, int whichcount) {
1865 if (whichcount>=0 && !art->missing)
1866 art->ipf->counts[art->state][whichcount]++;
1868 if (whichcount == RC_accepted) update_nocheck(1);
1869 else if (whichcount == RC_unwanted) update_nocheck(0);
1871 InputFile *ipf= art->ipf;
1873 while (art->blanklen) {
1874 static const char spaces[]=
1884 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1885 int r= pwrite(ipf->fd, spaces, w, art->offset);
1887 if (errno==EINTR) continue;
1888 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1889 art->messageid, art->blanklen,
1890 (unsigned long)art->offset, ipf->path);
1892 assert(r>=0 && r<=w);
1898 assert(ipf->inprogress >= 0);
1901 if (!ipf->inprogress && ipf != main_input_file)
1902 queue_check_input_done();
1905 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1906 const char *errmsg, int errnoval,
1907 const char *data, size_t recsz, void *conn_v) {
1910 if (ev == OOP_RD_EOF) {
1911 connfail(conn, "unexpected EOF from peer");
1912 return OOP_CONTINUE;
1914 assert(ev == OOP_RD_OK);
1916 char *sani= sanitise(data,-1);
1919 unsigned long code= strtoul(data, &ep, 10);
1920 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1921 connfail(conn, "badly formatted response from peer: %s", sani);
1922 return OOP_CONTINUE;
1926 conn->waiting.count ||
1927 conn->priority.count ||
1931 if (conn->quitting) {
1932 if (code!=205 && code!=503) {
1933 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1935 notice("C%d idle connection closed by us", conn->fd);
1937 LIST_REMOVE(conns,conn);
1940 return OOP_CONTINUE;
1943 conn->since_activity= 0;
1946 #define GET_ARTICLE(musthavesent) do{ \
1947 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1948 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1951 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1952 code_streaming= (streaming); \
1953 GET_ARTICLE(musthavesent); \
1954 article_done(art, RC_##how); \
1958 #define PEERBADMSG(m) do { \
1959 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1962 int code_streaming= 0;
1966 default: PEERBADMSG("peer sent unexpected message");
1970 PEERBADMSG("peer timed us out or stopped accepting articles");
1972 notice("C%d idle connection closed by peer", conn->fd);
1973 LIST_REMOVE(conns,conn);
1975 return OOP_CONTINUE;
1977 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1978 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1980 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1981 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1983 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1984 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1986 case 238: /* CHECK says send it */
1988 case 335: /* IHAVE says send it */
1990 assert(art->state == art_Unchecked);
1991 art->ipf->counts[art->state][RC_accepted]++;
1992 art->state= art_Wanted;
1993 LIST_ADDTAIL(conn->priority, art);
1996 case 431: /* CHECK or TAKETHIS says try later */
1998 case 436: /* IHAVE says try later */
2000 article_defer(art, RC_deferred);
2006 conn_maybe_write(conn);
2007 check_assign_articles();
2008 return OOP_CONTINUE;
2012 /*========== monitoring of input files ==========*/
2014 static void feedfile_eof(InputFile *ipf) {
2015 assert(ipf != main_input_file); /* promised by tailing_try_read */
2016 inputfile_reading_stop(ipf);
2018 if (ipf == flushing_input_file) {
2019 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2020 if (main_input_file) inputfile_reading_start(main_input_file);
2021 statemc_check_flushing_done();
2022 } else if (ipf == backlog_input_file) {
2023 statemc_check_backlog_done();
2025 abort(); /* supposed to wait rather than get EOF on main input file */
2029 static InputFile *open_input_file(const char *path) {
2030 int fd= open(path, O_RDWR);
2032 if (errno==ENOENT) return 0;
2033 sysfatal("unable to open input file %s", path);
2037 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2038 memset(ipf,0,sizeof(*ipf));
2042 LIST_INIT(ipf->queue);
2043 strcpy(ipf->path, path);
2048 static void close_input_file(InputFile *ipf) { /* does not free */
2049 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2050 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2051 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2052 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2053 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2057 /*---------- dealing with articles read in the input file ----------*/
2059 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2060 const char *data, const char *how) {
2061 warn("corrupted file: %s, offset %lu: %s: in %s",
2062 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2063 ipf->readcount_err++;
2064 if (ipf->readcount_err > max_bad_data_initial +
2065 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2066 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2067 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2068 return OOP_CONTINUE;
2071 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2072 oop_rd_event ev, const char *errmsg,
2073 int errnoval, const char *data, size_t recsz,
2075 InputFile *ipf= ipf_v;
2076 assert(ev == OOP_RD_SYSTEM);
2078 sysdie("error reading input file: %s, offset %lu",
2079 ipf->path, (unsigned long)ipf->offset);
2082 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2083 oop_rd_event ev, const char *errmsg,
2084 int errnoval, const char *data, size_t recsz,
2086 InputFile *ipf= ipf_v;
2088 char tokentextbuf[sizeof(TOKEN)*2+3];
2090 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2092 off_t old_offset= ipf->offset;
2093 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2095 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2097 if (ev==OOP_RD_PARTREC)
2098 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2099 /* but process it anyway */
2101 if (ipf->skippinglong) {
2102 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2103 return OOP_CONTINUE;
2105 if (ev==OOP_RD_LONG) {
2106 ipf->skippinglong= 1;
2107 X_BAD_DATA("overly long line");
2110 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2111 if (!recsz) X_BAD_DATA("empty line");
2114 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2115 ipf->readcount_blank++;
2116 return OOP_CONTINUE;
2119 char *space= strchr(data,' ');
2120 int tokenlen= space-data;
2121 int midlen= (int)recsz-tokenlen-1;
2122 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2123 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2125 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2126 memcpy(tokentextbuf, data, tokenlen);
2127 tokentextbuf[tokenlen]= 0;
2128 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2130 ipf->readcount_ok++;
2132 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2133 memset(art,0,sizeof(*art));
2134 art->state= art_Unchecked;
2135 art->midlen= midlen;
2136 art->ipf= ipf; ipf->inprogress++;
2137 art->token= TextToToken(tokentextbuf);
2138 art->offset= old_offset;
2139 art->blanklen= recsz;
2140 strcpy(art->messageid, space+1);
2141 LIST_ADDTAIL(ipf->queue, art);
2143 if (ipf->autodefer >= 0)
2144 article_autodefer(ipf, art);
2145 else if (ipf==backlog_input_file)
2146 article_check_expired(art);
2148 if (sms==sm_NORMAL && ipf==main_input_file &&
2149 ipf->offset >= target_max_feedfile_size)
2150 statemc_start_flush("feed file size");
2152 check_assign_articles(); /* may destroy conn but that's OK */
2153 check_reading_pause_resume(ipf);
2154 return OOP_CONTINUE;
2157 /*========== tailing input file ==========*/
2159 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2161 InputFile *ipf= user;
2162 return ipf->readable_callback(loop, &ipf->readable,
2163 ipf->readable_callback_user);
2166 static void tailing_on_cancel(struct oop_readable *rable) {
2167 InputFile *ipf= (void*)rable;
2169 if (ipf->filemon) filemon_stop(ipf);
2170 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2171 ipf->readable_callback= 0;
2174 static void tailing_queue_readable(InputFile *ipf) {
2175 /* lifetime of ipf here is OK because destruction will cause
2176 * on_cancel which will cancel this callback */
2177 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2180 static int tailing_on_readable(struct oop_readable *rable,
2181 oop_readable_call *cb, void *user) {
2182 InputFile *ipf= (void*)rable;
2184 tailing_on_cancel(rable);
2185 ipf->readable_callback= cb;
2186 ipf->readable_callback_user= user;
2189 tailing_queue_readable(ipf);
2193 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2195 InputFile *ipf= (void*)rable;
2197 ssize_t r= read(ipf->fd, buffer, length);
2199 if (errno==EINTR) continue;
2203 if (ipf==main_input_file) {
2206 } else if (ipf==flushing_input_file) {
2208 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2209 } else if (ipf==backlog_input_file) {
2215 tailing_queue_readable(ipf);
2220 /*---------- filemon implemented with inotify ----------*/
2222 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2223 #define HAVE_FILEMON
2225 #include <sys/inotify.h>
2227 static int filemon_inotify_fd;
2228 static int filemon_inotify_wdmax;
2229 static InputFile **filemon_inotify_wd2ipf;
2231 struct Filemon_Perfile {
2235 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2236 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2237 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2239 if (wd >= filemon_inotify_wdmax) {
2241 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2242 sizeof(*filemon_inotify_wd2ipf) * newmax);
2243 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2244 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2245 filemon_inotify_wdmax= newmax;
2248 assert(!filemon_inotify_wd2ipf[wd]);
2249 filemon_inotify_wd2ipf[wd]= ipf;
2251 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2252 ipf, wd, filemon_inotify_wdmax);
2257 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2259 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2260 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2261 if (r) sysdie("inotify_rm_watch");
2262 filemon_inotify_wd2ipf[wd]= 0;
2265 static void *filemon_inotify_readable(oop_source *lp, int fd,
2266 oop_event e, void *u) {
2267 struct inotify_event iev;
2269 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2271 if (isewouldblock(errno)) break;
2272 sysdie("read from inotify master");
2273 } else if (r==sizeof(iev)) {
2274 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2276 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2278 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2279 debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);
2280 filemon_callback(ipf);
2282 return OOP_CONTINUE;
2285 static int filemon_method_init(void) {
2286 filemon_inotify_fd= inotify_init();
2287 if (filemon_inotify_fd<0) {
2288 syswarn("filemon/inotify: inotify_init failed");
2291 xsetnonblock(filemon_inotify_fd, 1);
2292 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2294 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2298 static void filemon_method_dump_info(FILE *f) {
2300 fprintf(f,"inotify");
2301 DUMPV("%d",,filemon_inotify_fd);
2302 DUMPV("%d",,filemon_inotify_wdmax);
2303 for (i=0; i<filemon_inotify_wdmax; i++)
2304 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2307 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2309 /*---------- filemon dummy implementation ----------*/
2311 #if !defined(HAVE_FILEMON)
2313 struct Filemon_Perfile { int dummy; };
2315 static int filemon_method_init(void) {
2316 warn("filemon/dummy: no filemon method compiled in");
2319 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2320 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2321 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2323 #endif /* !HAVE_FILEMON */
2325 /*---------- filemon generic interface ----------*/
2327 static void filemon_start(InputFile *ipf) {
2328 assert(!ipf->filemon);
2331 filemon_method_startfile(ipf, ipf->filemon);
2334 static void filemon_stop(InputFile *ipf) {
2335 if (!ipf->filemon) return;
2336 filemon_method_stopfile(ipf, ipf->filemon);
2341 static void filemon_callback(InputFile *ipf) {
2342 if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2343 ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2346 /*---------- interface to start and stop an input file ----------*/
2348 static const oop_rd_style feedfile_rdstyle= {
2349 OOP_RD_DELIM_STRIP, '\n',
2351 OOP_RD_SHORTREC_LONG,
2354 static void inputfile_reading_resume(InputFile *ipf) {
2355 if (!ipf->rd) return;
2356 if (!ipf->paused) return;
2358 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2359 feedfile_got_article,ipf, feedfile_read_err, ipf);
2360 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2365 static void inputfile_reading_pause(InputFile *ipf) {
2366 if (!ipf->rd) return;
2367 if (ipf->paused) return;
2368 oop_rd_cancel(ipf->rd);
2372 static void inputfile_reading_start(InputFile *ipf) {
2374 ipf->readable.on_readable= tailing_on_readable;
2375 ipf->readable.on_cancel= tailing_on_cancel;
2376 ipf->readable.try_read= tailing_try_read;
2377 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2378 ipf->readable.delete_kill= 0;
2380 ipf->readable_callback= 0;
2381 ipf->readable_callback_user= 0;
2383 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2387 inputfile_reading_resume(ipf);
2390 static void inputfile_reading_stop(InputFile *ipf) {
2392 inputfile_reading_pause(ipf);
2393 oop_rd_delete(ipf->rd);
2395 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2399 /*========== interaction with innd - state machine ==========*/
2401 /* See official state diagram at top of file. We implement
2412 |`---------------------------------------------------.
2414 |`---------------- - - - |
2415 D ENOENT | D EXISTS see OVERALL STATES diagram |
2416 | for full startup logic |
2419 | ============ try to |
2425 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2426 ^ | hardlink F to D |
2429 | | our handle onto F is now onto D |
2432 | |<-------------------<---------------------<---------+
2434 | | spawn inndcomm flush |
2436 | ================== |
2437 | FLUSHING[-ABSENT] |
2439 | main D tail/none |
2440 | ================== |
2442 | | INNDCOMM FLUSH FAILS ^
2443 | |`----------------------->----------. |
2445 | | NO SUCH SITE V |
2446 ^ |`--------------->----. ==================== |
2447 | | \ FLUSHFAILED[-ABSENT] |
2449 | | FLUSH OK \ main D tail/none |
2450 | | open F \ ==================== |
2452 | | \ | TIME TO RETRY |
2453 | |`------->----. ,---<---'\ `----------------'
2454 | | D NONE | | D NONE `----.
2456 | ============= V V ============
2457 | SEPARATED-1 | | DROPPING-1
2458 | flsh->rd!=0 | | flsh->rd!=0
2459 | [Separated] | | [Dropping]
2460 | main F idle | | main none
2461 | flsh D tail | | flsh D tail
2462 | ============= | | ============
2464 ^ | EOF ON D | | defer | EOF ON D
2466 | =============== | | ===============
2467 | SEPARATED-2 | | DROPPING-2
2468 | flsh->rd==0 | V flsh->rd==0
2469 | [Finishing] | | [Dropping]
2470 | main F tail | `. main none
2471 | flsh D closed | `. flsh D closed
2472 | =============== V `. ===============
2474 | | ALL D PROCESSED `. | ALL D PROCESSED
2475 | V install defer as backlog `. | install defer
2476 ^ | close D `. | close D
2477 | | unlink D `. | unlink D
2480 `----------' ==============
2500 static void startup_set_input_file(InputFile *f) {
2501 assert(!main_input_file);
2503 inputfile_reading_start(f);
2506 static void statemc_lock(void) {
2508 struct stat stab, stabf;
2511 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2512 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2515 memset(&fl,0,sizeof(fl));
2517 fl.l_whence= SEEK_SET;
2518 int r= fcntl(lockfd, F_SETLK, &fl);
2520 if (errno==EACCES || isewouldblock(errno)) {
2521 if (quiet_multiple) exit(0);
2522 fatal("another duct holds the lockfile");
2524 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2527 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2529 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2531 if (!lock_noent && samefile(&stab, &stabf))
2534 xclose(lockfd, "stale lockfile ", path_lock);
2537 FILE *lockfile= fdopen(lockfd, "w");
2538 if (!lockfile) sysdie("fdopen lockfile");
2540 int r= ftruncate(lockfd, 0);
2541 if (r) sysdie("truncate lockfile to write new info");
2543 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2544 (unsigned long)self_pid,
2545 sitename, feedfile, remote_host) == EOF ||
2547 sysfatal("write info to lockfile %s", path_lock);
2549 debug("startup: locked");
2552 static void statemc_init(void) {
2553 struct stat stabdefer;
2555 search_backlog_file();
2558 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2560 debug("startup: ductdefer ENOENT");
2562 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2563 switch (stabdefer.st_nlink==1) {
2565 open_defer(); /* so that we will later close it and rename it */
2568 xunlink(path_defer, "stale defer file link"
2569 " (presumably hardlink to backlog file)");
2572 die("defer file %s has unexpected link count %d",
2573 path_defer, stabdefer.st_nlink);
2577 struct stat stab_f, stab_d;
2580 InputFile *file_d= open_input_file(path_flushing);
2581 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2583 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2585 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2586 debug("startup: F==D => Hardlinked");
2587 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2592 debug("startup: F ENOENT => Moved");
2593 if (file_d) startup_set_input_file(file_d);
2594 spawn_inndcomm_flush("feedfile missing at startup");
2595 /* => Flushing, sms:=FLUSHING */
2598 debug("startup: F!=D => Separated");
2599 startup_set_input_file(file_d);
2600 flushing_input_file= main_input_file;
2601 main_input_file= open_input_file(feedfile);
2602 if (!main_input_file) die("feedfile vanished during startup");
2603 SMS(SEPARATED, max_separated_periods,
2604 "found both old and current feed files");
2606 debug("startup: F exists, D ENOENT => Normal");
2607 InputFile *file_f= open_input_file(feedfile);
2608 if (!file_f) die("feed file vanished during startup");
2609 startup_set_input_file(file_f);
2610 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2615 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2616 assert(sms == sm_NORMAL);
2618 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2620 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2621 (unsigned long)target_max_feedfile_size,
2624 int r= link(feedfile, path_flushing);
2625 if (r) sysfatal("link feedfile %s to flushing file %s",
2626 feedfile, path_flushing);
2629 xunlink(feedfile, "old feedfile link");
2632 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2635 static int trigger_flush_ok(void) { /* => Flushing,FLUSHING, ret 1; or ret 0 */
2639 statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
2642 case sm_FLUSHFAILED:
2643 spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
2648 warn("took too long to complete old feedfile after flush, autodeferring");
2649 assert(flushing_input_file);
2650 autodefer_input_file(flushing_input_file);
2658 static void statemc_period_poll(void) {
2659 if (!until_flush) return;
2661 assert(until_flush>=0);
2663 if (until_flush) return;
2664 int ok= trigger_flush_ok();
2668 static int inputfile_is_done(InputFile *ipf) {
2670 if (ipf->inprogress) return 0; /* new article in the meantime */
2671 if (ipf->rd) return 0; /* not had EOF */
2675 static void notice_processed(InputFile *ipf, int completed,
2676 const char *what, const char *spec) {
2677 if (!ipf) return; /* allows preterminate to be lazy */
2679 #define RCI_NOTHING(x) /* nothing */
2680 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2681 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2683 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2685 char *inprog= completed
2686 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2687 : xasprintf(" inprogress=%ld", ipf->inprogress);
2688 char *autodefer= ipf->autodefer >= 0
2689 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2690 : xasprintf("%s","");
2692 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2693 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2694 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2696 completed?"completed":"processed", what, spec,
2697 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2698 inprog, autodefer, ipf->count_nooffer_missing,
2699 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2700 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2701 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2702 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2703 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2712 static void statemc_check_backlog_done(void) {
2713 InputFile *ipf= backlog_input_file;
2714 if (!inputfile_is_done(ipf)) return;
2716 const char *slash= strrchr(ipf->path, '/');
2717 const char *leaf= slash ? slash+1 : ipf->path;
2718 const char *under= strchr(slash, '_');
2719 const char *rest= under ? under+1 : leaf;
2720 if (!strncmp(rest,"backlog",7)) rest += 7;
2721 notice_processed(ipf,1,"backlog ",rest);
2723 close_input_file(ipf);
2724 if (unlink(ipf->path)) {
2725 if (errno != ENOENT)
2726 sysdie("could not unlink processed backlog file %s", ipf->path);
2727 warn("backlog file %s vanished while we were reading it"
2728 " so we couldn't remove it (but it's done now, anyway)",
2732 backlog_input_file= 0;
2733 search_backlog_file();
2737 static void statemc_check_flushing_done(void) {
2738 InputFile *ipf= flushing_input_file;
2739 if (!inputfile_is_done(ipf)) return;
2741 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2743 notice_processed(ipf,1,"feedfile","");
2747 xunlink(path_flushing, "old flushing file");
2749 close_input_file(flushing_input_file);
2750 free(flushing_input_file);
2751 flushing_input_file= 0;
2753 if (sms==sm_SEPARATED) {
2754 notice("flush complete");
2755 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2756 } else if (sms==sm_DROPPING) {
2757 SMS(DROPPED, max_separated_periods, "old flush complete");
2758 search_backlog_file();
2759 notice("feed dropped, but will continue until backlog is finished");
2763 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2765 assert(!inputfile_is_done(main_input_file));
2766 statemc_check_flushing_done();
2767 statemc_check_backlog_done();
2768 return OOP_CONTINUE;
2771 static void queue_check_input_done(void) {
2772 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2775 static void statemc_setstate(StateMachineState newsms, int periods,
2776 const char *forlog, const char *why) {
2778 until_flush= periods;
2780 const char *xtra= "";
2783 case sm_FLUSHFAILED:
2784 if (!main_input_file) xtra= "-ABSENT";
2788 xtra= flushing_input_file->rd ? "-1" : "-2";
2794 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2796 info("state %s%s %s",forlog,xtra,why);
2800 /*---------- defer and backlog files ----------*/
2802 static void open_defer(void) {
2807 defer= fopen(path_defer, "a+");
2808 if (!defer) sysfatal("could not open defer file %s", path_defer);
2810 /* truncate away any half-written records */
2812 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2814 if (stab.st_size > LONG_MAX)
2815 die("defer file %s size is far too large", path_defer);
2820 long orgsize= stab.st_size;
2821 long truncto= stab.st_size;
2823 if (!truncto) break; /* was only (if anything) one half-truncated record */
2824 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2825 sysdie("seek in defer file %s while truncating partial", path_defer);
2830 sysdie("failed read from defer file %s", path_defer);
2832 die("defer file %s shrank while we were checking it!", path_defer);
2838 if (stab.st_size != truncto) {
2839 warn("truncating half-record at end of defer file %s -"
2840 " shrinking by %ld bytes from %ld to %ld",
2841 path_defer, orgsize - truncto, orgsize, truncto);
2844 sysfatal("could not flush defer file %s", path_defer);
2845 if (ftruncate(fileno(defer), truncto))
2846 sysdie("could not truncate defer file %s", path_defer);
2849 info("continuing existing defer file %s (%ld bytes)",
2850 path_defer, orgsize);
2852 if (fseek(defer, truncto, SEEK_SET))
2853 sysdie("could not seek to new end of defer file %s", path_defer);
2856 static void close_defer(void) {
2861 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2863 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2866 time_t now= xtime();
2868 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2870 (unsigned long)stab.st_ino);
2871 if (link(path_defer, backlog))
2872 sysfatal("could not install defer file %s as backlog file %s",
2873 path_defer, backlog);
2874 if (unlink(path_defer))
2875 sysdie("could not unlink old defer link %s to backlog file %s",
2876 path_defer, backlog);
2880 if (until_backlog_nextscan < 0 ||
2881 until_backlog_nextscan > backlog_retry_minperiods + 1)
2882 until_backlog_nextscan= backlog_retry_minperiods + 1;
2885 static void poll_backlog_file(void) {
2886 if (until_backlog_nextscan < 0) return;
2887 if (until_backlog_nextscan-- > 0) return;
2888 search_backlog_file();
2891 static void search_backlog_file(void) {
2892 /* returns non-0 iff there are any backlog files */
2897 const char *oldest_path=0;
2898 time_t oldest_mtime=0, now;
2900 if (backlog_input_file) return;
2904 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2908 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2910 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2912 for (i=0; i<gl.gl_pathc; i++) {
2913 const char *path= gl.gl_pathv[i];
2915 if (strchr(path,'#') || strchr(path,'~')) {
2916 debug("backlog file search skipping %s", path);
2919 r= stat(path, &stab);
2921 syswarn("failed to stat backlog file %s", path);
2924 if (!S_ISREG(stab.st_mode)) {
2925 warn("backlog file %s is not a plain file (or link to one)", path);
2928 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2930 oldest_mtime= stab.st_mtime;
2933 case GLOB_NOMATCH: /* fall through */
2936 sysdie("glob expansion of backlog pattern %s gave unexpected"
2937 " nonzero (error?) return value %d", globpat_backlog, r);
2941 debug("backlog scan: none");
2943 if (sms==sm_DROPPED) {
2945 notice("feed dropped and our work is complete");
2947 int r= unlink(path_control);
2948 if (r && errno!=ENOENT)
2949 syswarn("failed to remove control symlink for old feed");
2951 xunlink(path_lock, "lockfile for old feed");
2954 until_backlog_nextscan= backlog_spontrescan_periods;
2959 double age= difftime(now, oldest_mtime);
2960 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2962 if (age_deficiency <= 0) {
2963 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2964 age, age_deficiency, oldest_path);
2966 backlog_input_file= open_input_file(oldest_path);
2967 if (!backlog_input_file) {
2968 warn("backlog file %s vanished as we opened it", oldest_path);
2972 inputfile_reading_start(backlog_input_file);
2973 until_backlog_nextscan= -1;
2977 until_backlog_nextscan= age_deficiency / period_seconds;
2979 if (backlog_spontrescan_periods >= 0 &&
2980 until_backlog_nextscan > backlog_spontrescan_periods)
2981 until_backlog_nextscan= backlog_spontrescan_periods;
2983 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2984 age, age_deficiency, until_backlog_nextscan, oldest_path);
2991 /*---------- shutdown and signal handling ----------*/
2993 static void preterminate(void) {
2994 if (in_child) return;
2995 notice_processed(main_input_file,0,"feedfile","");
2996 notice_processed(flushing_input_file,0,"flushing","");
2997 if (backlog_input_file)
2998 notice_processed(backlog_input_file,0, "backlog file ",
2999 backlog_input_file->path);
3002 static int signal_self_pipe[2];
3003 static sig_atomic_t terminate_sig_flag;
3005 static void raise_default(int signo) {
3006 xsigsetdefault(signo);
3011 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3012 assert(fd=signal_self_pipe[0]);
3014 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3015 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
3016 if (r==0) die("eof on signal self pipe");
3017 if (terminate_sig_flag) {
3019 notice("terminating (%s)", strsignal(terminate_sig_flag));
3020 raise_default(terminate_sig_flag);
3022 return OOP_CONTINUE;
3025 static void sigarrived_handler(int signum) {
3030 if (!terminate_sig_flag) terminate_sig_flag= signum;
3035 write(signal_self_pipe[1],&x,1);
3038 static void init_signals(void) {
3039 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3040 sysdie("could not ignore SIGPIPE");
3042 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3044 xsetnonblock(signal_self_pipe[0],1);
3045 xsetnonblock(signal_self_pipe[1],1);
3047 struct sigaction sa;
3048 memset(&sa,0,sizeof(sa));
3049 sa.sa_handler= sigarrived_handler;
3050 sa.sa_flags= SA_RESTART;
3051 xsigaction(SIGTERM,&sa);
3052 xsigaction(SIGINT,&sa);
3054 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3057 /*========== flushing the feed ==========*/
3059 static pid_t inndcomm_child;
3060 static int inndcomm_sentinel_fd;
3062 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3063 assert(inndcomm_child);
3064 assert(fd == inndcomm_sentinel_fd);
3065 int status= xwaitpid(&inndcomm_child, "inndcomm");
3068 cancel_fd_read_except(fd);
3069 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3070 inndcomm_sentinel_fd= 0;
3072 assert(!flushing_input_file);
3074 if (WIFEXITED(status)) {
3075 switch (WEXITSTATUS(status)) {
3077 case INNDCOMMCHILD_ESTATUS_FAIL:
3080 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3081 notice("feed has been dropped by innd, finishing up");
3082 flushing_input_file= main_input_file;
3083 tailing_queue_readable(flushing_input_file);
3084 /* we probably previously returned EAGAIN from our fake read method
3085 * when in fact we were at EOF, so signal another readable event
3086 * so we actually see the EOF */
3090 if (flushing_input_file) {
3091 SMS(DROPPING, max_separated_periods,
3092 "feed dropped by innd, but must finish last flush");
3095 SMS(DROPPED, 0, "feed dropped by innd");
3096 search_backlog_file();
3098 return OOP_CONTINUE;
3102 flushing_input_file= main_input_file;
3103 tailing_queue_readable(flushing_input_file);
3105 main_input_file= open_input_file(feedfile);
3106 if (!main_input_file)
3107 die("flush succeeded but feedfile %s does not exist!", feedfile);
3109 if (flushing_input_file) {
3110 SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3113 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3115 return OOP_CONTINUE;
3118 goto unexpected_exitstatus;
3121 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3122 warn("flush timed out trying to talk to innd");
3125 unexpected_exitstatus:
3126 report_child_status("inndcomm child", status);
3130 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3131 return OOP_CONTINUE;
3134 static void inndcommfail(const char *what) {
3135 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3136 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3139 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3142 notice("flushing %s",why);
3144 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3145 assert(!inndcomm_child);
3146 assert(!inndcomm_sentinel_fd);
3148 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3150 inndcomm_child= xfork("inndcomm child");
3152 if (!inndcomm_child) {
3153 const char *flushargv[2]= { sitename, 0 };
3157 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3158 /* parent spots the autoclose of pipefds[1] when we die or exit */
3160 if (simulate_flush>=0) {
3161 warn("SIMULATING flush child status %d", simulate_flush);
3162 if (simulate_flush>128) raise(simulate_flush-128);
3163 else exit(simulate_flush);
3166 alarm(inndcomm_flush_timeout);
3167 r= ICCopen(); if (r) inndcommfail("connect");
3168 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3169 if (!r) exit(0); /* yay! */
3171 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3172 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3173 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3178 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3179 inndcomm_sentinel_fd= pipefds[0];
3180 assert(inndcomm_sentinel_fd);
3181 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3183 SMS(FLUSHING, 0, why);
3186 /*========== main program ==========*/
3188 static void postfork_inputfile(InputFile *ipf) {
3190 xclose(ipf->fd, "(in child) input file ", ipf->path);
3193 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3194 /* we have no stdio streams that are buffered long-term */
3196 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3199 static void postfork(void) {
3202 xsigsetdefault(SIGTERM);
3203 xsigsetdefault(SIGINT);
3204 xsigsetdefault(SIGPIPE);
3205 if (terminate_sig_flag) raise(terminate_sig_flag);
3207 postfork_inputfile(main_input_file);
3208 postfork_inputfile(flushing_input_file);
3212 conn_closefd(conn,"(in child) ");
3214 postfork_stdio(defer, "defer file ", path_defer);
3217 typedef struct Every Every;
3219 struct timeval interval;
3224 static void every_schedule(Every *e, struct timeval base);
3226 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3229 if (!e->fixed_rate) xgettimeofday(&base);
3230 every_schedule(e, base);
3231 return OOP_CONTINUE;
3234 static void every_schedule(Every *e, struct timeval base) {
3235 struct timeval when;
3236 timeradd(&base, &e->interval, &when);
3237 loop->on_time(loop, when, every_happens, e);
3240 static void every(int interval, int fixed_rate, void (*f)(void)) {
3241 NEW_DECL(Every *,e);
3242 e->interval.tv_sec= interval;
3243 e->interval.tv_usec= 0;
3244 e->fixed_rate= fixed_rate;
3247 xgettimeofday(&now);
3248 every_schedule(e, now);
3251 static void filepoll(void) {
3252 filemon_callback(main_input_file);
3253 filemon_callback(flushing_input_file);
3256 static char *debug_report_ipf(InputFile *ipf) {
3257 if (!ipf) return xasprintf("none");
3259 const char *slash= strrchr(ipf->path,'/');
3260 const char *path= slash ? slash+1 : ipf->path;
3262 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3264 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3265 (long)ipf->offset, ipf->fd,
3266 ipf->rd ? "" : ",!rd",
3267 ipf->skippinglong ? "*skiplong" : "",
3268 ipf->rd && ipf->paused ? "*paused" : "");
3271 static void period(void) {
3272 char *dipf_main= debug_report_ipf(main_input_file);
3273 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3274 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3277 " sms=%s[%d] conns=%d until_connect=%d"
3278 " input_files main:%s flushing:%s backlog:%s[%d]"
3279 " children connecting=%ld inndcomm=%ld"
3281 sms_names[sms], until_flush, conns.count, until_connect,
3282 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3283 (long)connecting_child, (long)inndcomm_child
3287 free(dipf_flushing);
3290 if (until_connect) until_connect--;
3292 inputfile_queue_check_expired(backlog_input_file);
3293 poll_backlog_file();
3294 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3295 statemc_period_poll();
3296 check_assign_articles();
3301 /*========== dumping state ==========*/
3303 static void dump_article_list(FILE *f, const ControlCommand *c,
3304 const ArticleList *al) {
3305 fprintf(f, " count=%d\n", al->count);
3306 if (!c->xval) return;
3308 int i; Article *art;
3309 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3310 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3311 DUMPV("%p", art->,ipf);
3312 DUMPV("%d", art->,missing);
3313 DUMPV("%lu", (unsigned long)art->,offset);
3314 DUMPV("%d", art->,blanklen);
3315 DUMPV("%d", art->,midlen);
3316 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3320 static void dump_input_file(FILE *f, const ControlCommand *c,
3321 InputFile *ipf, const char *wh) {
3322 char *dipf= debug_report_ipf(ipf);
3323 fprintf(f,"input %s %s", wh, dipf);
3327 DUMPV("%d", ipf->,readcount_ok);
3328 DUMPV("%d", ipf->,readcount_blank);
3329 DUMPV("%d", ipf->,readcount_err);
3330 DUMPV("%d", ipf->,count_nooffer_missing);
3334 ArtState state; const char *const *statename;
3335 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3336 #define RC_DUMP_FMT(x) " " #x "=%d"
3337 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3338 fprintf(f,"input %s counts %-11s"
3339 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3341 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3343 fprintf(f,"input %s queue", wh);
3344 dump_article_list(f,c,&ipf->queue);
3350 fprintf(cc->out, "dumping state to %s\n", path_dump);
3351 FILE *f= fopen(path_dump, "w");
3352 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3354 fprintf(f,"general");
3355 DUMPV("%s", sms_names,[sms]);
3356 DUMPV("%d", ,until_flush);
3357 DUMPV("%ld", (long),self_pid);
3358 DUMPV("%p", , defer);
3359 DUMPV("%d", , until_connect);
3360 DUMPV("%d", , until_backlog_nextscan);
3361 DUMPV("%d", , simulate_flush);
3362 fprintf(f,"\nnocheck");
3363 DUMPV("%#.10f", , accept_proportion);
3364 DUMPV("%d", , nocheck);
3365 DUMPV("%d", , nocheck_reported);
3368 fprintf(f,"special");
3369 DUMPV("%ld", (long),connecting_child);
3370 DUMPV("%d", , connecting_fdpass_sock);
3371 DUMPV("%d", , control_master);
3374 fprintf(f,"filemon ");
3375 filemon_method_dump_info(f);
3377 dump_input_file(f,c, main_input_file, "main" );
3378 dump_input_file(f,c, flushing_input_file, "flushing");
3379 dump_input_file(f,c, backlog_input_file, "backlog" );
3381 fprintf(f,"conns count=%d\n", conns.count);
3386 fprintf(f,"C%d",conn->fd);
3387 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3388 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3389 DUMPV("%d",conn->,since_activity);
3392 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3393 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3394 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3396 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3397 for (i=0; i<conn->xmitu; i++) {
3398 const struct iovec *iv= &conn->xmit[i];
3399 const XmitDetails *xd= &conn->xmitd[i];
3402 case xk_Const: dinfo= xasprintf("Const"); break;
3403 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3407 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3408 sanitise(iv->iov_base, iv->iov_len));
3414 DUMPV("%s", , path_lock);
3415 DUMPV("%s", , path_flushing);
3416 DUMPV("%s", , path_defer);
3417 DUMPV("%s", , path_control);
3418 DUMPV("%s", , path_dump);
3419 DUMPV("%s", , globpat_backlog);
3422 if (!!ferror(f) + !!fclose(f)) {
3423 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3428 /*========== option parsing ==========*/
3430 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3431 static void vbadusage(const char *fmt, va_list al) {
3432 char *m= xvasprintf(fmt,al);
3433 fprintf(stderr, "bad usage: %s\n"
3434 "say --help for help, or read the manpage\n",
3437 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3441 /*---------- generic option parser ----------*/
3443 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3444 static void badusage(const char *fmt, ...) {
3451 of_seconds= 001000u,
3452 of_boolean= 002000u,
3455 typedef struct Option Option;
3456 typedef void OptionParser(const Option*, const char *val);
3460 const char *lng, *formarg;
3466 static void parse_options(const Option *options, char ***argvp) {
3467 /* on return *argvp is first non-option arg; argc is not updated */
3470 const char *arg= *++(*argvp);
3472 if (*arg != '-') break;
3473 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3475 while ((a= *++arg)) {
3479 char *equals= strchr(arg,'=');
3480 int len= equals ? (equals - arg) : strlen(arg);
3481 for (o=options; o->shrt || o->lng; o++)
3482 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3484 badusage("unknown long option --%s",arg);
3487 if (equals) badusage("option --%s does not take a value",o->lng);
3489 } else if (equals) {
3493 if (!arg) badusage("option --%s needs a value for %s",
3494 o->lng, o->formarg);
3497 break; /* eaten the whole argument now */
3499 for (o=options; o->shrt || o->lng; o++)
3502 badusage("unknown short option -%c",a);
3509 if (!arg) badusage("option -%c needs a value for %s",
3510 o->shrt, o->formarg);
3513 break; /* eaten the whole argument now */
3519 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3521 static void print_options(const Option *options, FILE *f) {
3523 for (o=options; o->shrt || o->lng; o++) {
3524 char shrt[2] = { o->shrt, 0 };
3525 char *optspec= xasprintf("%s%s%s%s%s",
3526 o->shrt ? "-" : "", shrt,
3527 o->shrt && o->lng ? "|" : "",
3528 DELIMPERHAPS("--", o->lng));
3529 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3534 /*---------- specific option types ----------*/
3536 static void op_integer(const Option *o, const char *val) {
3539 unsigned long ul= strtoul(val,&ep,10);
3540 if (*ep || ep==val || errno || ul>INT_MAX)
3541 badusage("bad integer value for %s",o->lng);
3542 int *store= o->store;
3546 static void op_double(const Option *o, const char *val) {
3547 int *store= o->store;
3550 *store= strtod(val, &ep);
3551 if (*ep || ep==val || errno)
3552 badusage("bad floating point value for %s",o->lng);
3555 static void op_string(const Option *o, const char *val) {
3556 const char **store= o->store;
3560 static void op_seconds(const Option *o, const char *val) {
3561 int *store= o->store;
3565 double v= strtod(val,&ep);
3566 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3568 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3569 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3570 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3571 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3572 else if (!strcmp(ep,"das")) unit= 10;
3573 else if (!strcmp(ep,"hs")) unit= 100;
3574 else if (!strcmp(ep,"ks")) unit= 1000;
3575 else if (!strcmp(ep,"Ms")) unit= 1000000;
3576 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3580 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3584 static void op_setint(const Option *o, const char *val) {
3585 int *store= o->store;
3589 /*---------- specific options ----------*/
3591 static void help(const Option *o, const char *val);
3593 static const Option innduct_options[]= {
3594 {'f',"feedfile", "F", &feedfile, op_string },
3595 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3596 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3597 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3598 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3599 {'C',"inndconf", "F", &inndconffile, op_string },
3600 {'P',"port", "PORT", &port, op_integer },
3601 {0,"ctrl-sock-dir", 0, &realsockdir, op_string },
3602 {0,"no-ctrl-sock-dir-perms-check",0,&realsockdir_any_perms, op_setint, 0 },
3603 {0,"help", 0, 0, help },
3605 {0,"max-connections", "N", &max_connections, op_integer },
3606 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3607 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3608 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3609 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3611 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3612 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3613 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3615 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3616 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3618 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3619 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3620 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3621 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3622 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3623 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3624 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3626 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3627 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3632 static void printusage(FILE *f) {
3633 fputs("usage: innduct [options] site [fqdn]\n"
3634 "available options are:\n", f);
3635 print_options(innduct_options, f);
3638 static void help(const Option *o, const char *val) {
3640 if (ferror(stdout) || fflush(stdout)) {
3641 perror("innduct: writing help");
3647 static void convert_to_periods_rndup(int *store) {
3648 *store += period_seconds-1;
3649 *store /= period_seconds;
3652 int main(int argc, char **argv) {
3658 parse_options(innduct_options, &argv);
3663 if (!sitename) badusage("need site name argument");
3664 remote_host= *argv++;
3665 if (*argv) badusage("too many non-option arguments");
3669 int r= innconf_read(inndconffile);
3670 if (!r) badusage("could not read inn.conf (more info on stderr)");
3672 if (!remote_host) remote_host= sitename;
3674 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3675 badusage("nocheck threshold percentage must be between 0..100");
3676 nocheck_thresh *= 0.01;
3678 if (nocheck_decay < 0.1)
3679 badusage("nocheck decay articles must be at least 0.1");
3680 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3682 convert_to_periods_rndup(&reconnect_delay_periods);
3683 convert_to_periods_rndup(&flushfail_retry_periods);
3684 convert_to_periods_rndup(&backlog_retry_minperiods);
3685 convert_to_periods_rndup(&backlog_spontrescan_periods);
3686 convert_to_periods_rndup(&spontaneous_flush_periods);
3687 convert_to_periods_rndup(&max_separated_periods);
3688 convert_to_periods_rndup(&need_activity_periods);
3690 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3691 badusage("bad input data ratio must be between 0..100");
3692 max_bad_data_ratio *= 0.01;
3695 feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3696 } else if (!feedfile[0]) {
3697 badusage("feed filename must be nonempty");
3698 } else if (feedfile[strlen(feedfile)-1]=='/') {
3699 feedfile= xasprintf("%s%s",feedfile,sitename);
3702 if (max_queue_per_ipf<0)
3703 max_queue_per_ipf= max_queue_per_conn * 2;
3705 const char *feedfile_forbidden= "?*[~#";
3707 while ((c= *feedfile_forbidden++))
3708 if (strchr(feedfile, c))
3709 badusage("feed filename may not contain metacharacter %c",c);
3713 path_lock= xasprintf("%s_lock", feedfile);
3714 path_flushing= xasprintf("%s_flushing", feedfile);
3715 path_defer= xasprintf("%s_defer", feedfile);
3716 path_control= xasprintf("%s_control", feedfile);
3717 path_dump= xasprintf("%s_dump", feedfile);
3718 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3720 oop_source_sys *sysloop= oop_sys_new();
3721 if (!sysloop) sysdie("could not create liboop event loop");
3722 loop= (oop_source*)sysloop;
3726 if (become_daemon) {
3728 for (i=3; i<255; i++)
3729 /* do this now before we open syslog, etc. */
3731 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3733 int null= open("/dev/null",O_RDWR);
3734 if (null<0) sysfatal("failed to open /dev/null");
3738 xclose(null, "/dev/null original fd",0);
3740 pid_t child1= xfork("daemonise first fork");
3741 if (child1) _exit(0);
3743 pid_t sid= setsid();
3744 if (sid != child1) sysfatal("setsid failed");
3746 pid_t child2= xfork("daemonise second fork");
3747 if (child2) _exit(0);
3751 if (self_pid==-1) sysdie("getpid");
3760 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3761 // r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3770 notice("filemon: suppressed by command line option, polling");
3772 filemon_ok= filemon_method_init();
3774 warn("filemon: no file monitoring available, polling");
3777 every(filepoll_seconds,0,filepoll);
3779 every(period_seconds,1,period);
3785 void *run= oop_sys_run(sysloop);
3786 assert(run == OOP_ERROR);
3787 sysdie("event loop failed");