3 * - close idle connections
8 * Newsfeeds file entries should look like this:
9 * host.name.of.site[/exclude,exclude,...]\
10 * :pattern,pattern...[/distribution,distribution...]\
14 * sitename[/exclude,exclude,...]\
15 * :pattern,pattern...[/distribution,distribution...]\
21 * or might be blanked out
22 * <spc><spc><spc><spc>....
24 * F site.name main feed file
25 * opened/created, then written, by innd
28 * tokens blanked out by duct when processed
29 * site.name_lock lock preventing multiple ducts
30 * to hold lock must open,F_SETLK[W]
31 * and then stat to check that locked file
32 * still has name site.name_lock
33 * holder of this lock is "duct"
34 * (only) lockholder may remove the lockfile
35 * D site.name_flushing temporary feed file during flush (or crash)
36 * hardlink created by duct
38 * site.name_defer 431'd articles, still being written,
39 * created, written, used by duct
41 * site.name_backlog.<date>.<inum>
42 * 431'd articles, ready for innxmit or duct
43 * created (link/mv) by duct
44 * site.name_backlog<anything-else> (where <anything-else> does not
45 * contain '#' or '~') eg
46 * site.name_backlog.manual
47 * anything the sysadmin likes (eg, feed files
48 * from old feeds to be merged into this one)
49 * created (link/mv) by admin
50 * may be symlinks (in which case links
51 * may be written through, but only links
54 * It is safe to remove backlog files manually,
55 * if it's desired to throw away the backlog.
57 * Backlog files are also processed by innduct. We find the oldest
58 * backlog file which is at least a certain amount old, and feed it
59 * back into our processing. When every article in it has been read
60 * and processed, we unlink it and look for another backlog file.
62 * If we don't have a backlog file that we're reading, we close the
63 * defer file that we're writing and make it into a backlog file at
64 * the first convenient opportunity.
75 | | <----------------<---------------------------------'|
81 | F: innd writing, duct reading |
84 | | duct decides time to flush |
85 | | duct makes hardlink |
87 | V <------------------------'|
89 | F == D: innd writing, duct reading both exist |
92 | | <-----------<-------------<--'|
96 | V <---------------------. |
99 | D: innd writing, duct reading; or ENOENT | |
101 | | duct requests flush of feed | |
102 | | (others can too, harmlessly) | |
106 | D: innd flushing, duct; or ENOENT | |
108 | | inndcomm flush fails | |
109 | |`-------------------------->------------------' |
111 | | inndcomm reports no such site |
112 | |`---------------------------------------------------- | -.
114 | | innd finishes writing D, creates F | |
115 | | inndcomm reports flush successful | |
118 | Separated <----------------' |
119 | F: innd writing F!=D /
120 | D: duct reading; or ENOENT both exist /
122 | | duct gets to the end of D /
123 | | duct opens F too /
126 | F: innd writing, duct reading |
127 | D: duct finishing V
129 | | duct finishes processing D F: ENOENT
130 | V duct unlinks D D: duct reading
132 `--<--' | duct finishes
142 "duct reading" means innduct is reading the file but also
143 overwriting processed tokens.
147 * rune for printing diagrams:
149 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
154 /*============================== PROGRAM ==============================*/
158 #include "inn/list.h"
165 #include <sys/types.h>
166 #include <sys/wait.h>
167 #include <sys/stat.h>
168 #include <sys/socket.h>
181 #include <oop-read.h>
183 /*----- general definitions, probably best not changed -----*/
185 #define PERIOD_SECONDS 60
187 #define CONNCHILD_ESTATUS_STREAM 4
188 #define CONNCHILD_ESTATUS_NOSTREAM 5
190 #define INNDCOMMCHILD_ESTATUS_FAIL 6
191 #define INNDCOMMCHILD_ESTATUS_NONESUCH 7
193 /*----- doubly linked lists -----*/
195 #define ISNODE(T) struct { T *succ, *pred; } node /* must be at start */
196 #define DEFLIST(T) typedef struct { T *hd, *tl, *tp; int count; } T##List
198 #define NODE(n) (assert((void*)&(n)->node == &(n)), \
199 (struct node*)&(n)->node)
201 #define LIST_CHECKCANHAVENODE(l,n) \
202 ((void)((n) == ((l).hd))) /* just for the type check */
204 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
205 ( LIST_CHECKCANHAVENODE(l,n), \
206 list_addsomehow((struct list*)&(l), NODE((n))), \
210 #define LIST_REMSOMEHOW(l,list_remsomehow) \
214 list_remsomehow((struct list*)&(l)) ) \
220 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
221 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
222 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
223 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
225 #define LIST_HEAD(l) ((typeof((l).hd))(list_head((struct list*)&(l))))
226 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
227 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
229 #define LIST_REMOVE(l,n) \
230 ( LIST_CHECKCANHAVENODE(l,n), \
231 list_remove(NODE((n))), \
235 #define LIST_INSERT(l,n,pred) \
236 ( LIST_CHECKCANHAVENODE(l,n), \
237 LIST_CHECKCANHAVENODE(l,pred), \
238 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
242 /*----- type predeclarations -----*/
244 typedef struct Conn Conn;
245 typedef struct Article Article;
246 typedef struct InputFile InputFile;
247 typedef struct XmitDetails XmitDetails;
248 typedef enum StateMachineState StateMachineState;
253 /*----- function predeclarations -----*/
255 static void conn_maybe_write(Conn *conn);
256 static void conn_make_some_xmits(Conn *conn);
257 static void *conn_write_some_xmits(Conn *conn);
259 static void xmit_free(XmitDetails *d);
261 static int filemon_init(void);
262 static void filemon_setfile(int mainfeed_fd, const char *mainfeed_path);
263 static void filemon_callback(void);
265 static void statemc_setstate(StateMachineState newsms, int periods,
266 const char *forlog, const char *why);
267 static void check_master_queue(void);
268 static void queue_check_input_done(void);
270 static void postfork(const char *what);
271 static void postfork_inputfile(InputFile *ipf);
273 /*----- configuration options -----*/
275 static char *sitename, *feedfile;
276 static const char *remote_host;
277 static int quiet_multiple=0, become_daemon=1;
279 static int max_connections=10, max_queue_per_conn=200;
281 static int connection_setup_timeout=200, port=119, try_stream=1;
282 static int inndcomm_flush_timeout=100;
283 static int reconnect_delay_periods, flushfail_retry_periods, open_wait_periods;
284 static int backlog_retry_minperiods, backlog_spontaneous_rescan_periods;
285 static const char *inndconffile;
287 static double accept_proportion;
288 static double nocheck_thresh_pct= 95.0;
289 static double nocheck_thresh; /* computed in main from _pct */
290 static double nocheck_decay_articles= 100; /* converted to _decay */
291 static double nocheck_decay; /* computed in main from _articles */
292 static int nocheck, nocheck_reported;
295 /*----- statistics -----*/
297 typedef enum { /* in queue in conn->sent */
298 art_Unchecked, /* not checked, not sent checking */
299 art_Wanted, /* checked, wanted sent body as requested */
300 art_Unsolicited, /* - sent body without check */
304 #define RESULT_COUNTS(RCS,RCN) \
312 #define RCI_TRIPLE_FMT_BASE "%d(id%d+bd%d+nc%d)"
313 #define RCI_TRIPLE_VALS_BASE(counts,x) \
314 counts[art_Unchecked] x \
315 + counts[art_Wanted] x \
316 + counts[art_Unsolicited] x, \
317 counts[art_Unchecked] x \
318 , counts[art_Wanted] x \
319 , counts[art_Unsolicited] x
322 #define RC_INDEX(x) RC_##x,
323 RESULT_COUNTS(RC_INDEX, RC_INDEX)
328 /*----- transmission buffers -----*/
333 xk_Malloc, xk_Const, xk_Artdata
345 /*----- core operational data structure types -----*/
348 /* This is also an instance of struct oop_readable */
349 struct oop_readable readable; /* first */
350 oop_readable_call *readable_callback;
351 void *readable_callback_user;
354 struct Filemon_Perfile *filemon;
357 long inprogress; /* no. of articles read but not processed */
360 int counts[art_MaxState][RCI_max];
375 #define SMS_LIST(X) \
383 enum StateMachineState {
384 #define SMS_DEF_ENUM(s) sm_##s,
385 SMS_LIST(SMS_DEF_ENUM)
388 static const char *sms_names[]= {
389 #define SMS_DEF_NAME(s) #s ,
390 SMS_LIST(SMS_DEF_NAME)
396 int fd, max_queue, stream, quitting;
397 ArticleList waiting; /* not yet told peer */
398 ArticleList priority; /* peer says send it now */
399 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
400 struct iovec xmit[CONNIOVS];
401 XmitDetails xmitd[CONNIOVS];
406 /*----- operational variables -----*/
408 static oop_source *loop;
410 static int until_connect;
411 static ConnList conns;
412 static ArticleList queue;
414 static char *path_lock, *path_flushing, *path_defer;
416 #define SMS(newstate, periods, why) \
417 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
419 static StateMachineState sms;
421 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
422 static int sm_period_counter;
425 /*========== logging ==========*/
427 static void logcore(int sysloglevel, const char *fmt, ...)
428 __attribute__((__format__(printf,2,3)));
429 static void logcore(int sysloglevel, const char *fmt, ...) {
433 vsyslog(sysloglevel,fmt,al);
435 vfprintf(stderr,fmt,al);
441 static void logv(int sysloglevel, const char *pfx, int errnoval,
442 int exitstatus, const char *fmt, va_list al)
443 __attribute__((__format__(printf,5,0)));
444 static void logv(int sysloglevel, const char *pfx, int errnoval,
445 int exitstatus, const char *fmt, va_list al) {
446 char msgbuf[256]; /* NB do not call xvasprintf here or you'll recurse */
447 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
448 msgbuf[sizeof(msgbuf)-1]= 0;
450 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
451 sysloglevel= LOG_ERR; /* run by wrong user, probably */
453 logcore(sysloglevel, "<%s>%s: %s%s%s",
454 sitename, pfx, msgbuf,
455 errnoval>=0 ? ": " : "",
456 errnoval>=0 ? strerror(errnoval) : "");
459 #define logwrap(fn, pfx, sysloglevel, err, estatus) \
460 static void fn(const char *fmt, ...) \
461 __attribute__((__format__(printf,1,2))); \
462 static void fn(const char *fmt, ...) { \
465 logv(sysloglevel, pfx, err, estatus, fmt, al); \
468 logwrap(sysdie, " critical", LOG_CRIT, errno, 16);
469 logwrap(die, " critical", LOG_CRIT, -1, 16);
471 logwrap(sysfatal, " fatal", LOG_ERR, errno, 12);
472 logwrap(fatal, " fatal", LOG_ERR, -1, 12);
474 logwrap(syswarn, " warning", LOG_WARNING, errno, 0);
475 logwrap(warn, " warning", LOG_WARNING, -1, 0);
477 logwrap(notice, "", LOG_NOTICE, -1, 0);
478 logwrap(info, " info", LOG_INFO, -1, 0);
479 logwrap(debug, " debug", LOG_DEBUG, -1, 0);
482 /*========== utility functions etc. ==========*/
484 static char *xvasprintf(const char *fmt, va_list al)
485 __attribute__((__format__(printf,1,0)));
486 static char *xvasprintf(const char *fmt, va_list al) {
488 int rc= vasprintf(&str,fmt,al);
489 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
492 static char *xasprintf(const char *fmt, ...)
493 __attribute__((__format__(printf,1,2)));
494 static char *xasprintf(const char *fmt, ...) {
497 char *str= xvasprintf(fmt,al);
502 static void perhaps_close(int *fd) { if (*fd) { close(*fd); fd=0; } }
504 static pid_t xfork(const char *what) {
508 if (child==-1) sysdie("cannot fork for %s",what);
509 if (!child) postfork(what);
510 debug("forked %s %ld", what, (unsigned long)child);
514 static void on_fd_read_except(int fd, oop_call_fd callback) {
515 loop->on_fd(loop, fd, OOP_READ, callback, 0);
516 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
518 static void cancel_fd_read_except(int fd) {
519 loop->cancel_fd(loop, fd, OOP_READ);
520 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
523 static void report_child_status(const char *what, int status) {
524 if (WIFEXITED(status)) {
525 int es= WEXITSTATUS(status);
527 warn("%s: child died with error exit status %d",es);
528 } else if (WIFSIGNALED(status)) {
529 int sig= WTERMSIG(status);
530 const char *sigstr= strsignal(sig);
531 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
533 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
535 warn("%s: child died due to unknown fatal signal %d%s",
536 what, sig, coredump);
538 warn("%s: child died with unknown wait status %d", status);
542 static int xwaitpid(pid_t *pid, const char *what) {
545 int r= kill(*pid, SIGKILL);
546 if (r) sysdie("cannot kill %s child", what);
548 pid_t got= waitpid(*pid, &status, WNOHANG);
549 if (got==-1) sysdie("cannot reap %s child", what);
556 static void xunlink(const char *path, const char *what) {
558 if (r) sysdie("can't unlink %s %s", path, what);
561 static void check_isreg(const struct stat *stab, const char *path,
563 if (!S_ISREG(stab->st_mode))
564 die("%s %s not a plain file (mode 0%lo)",
565 what, path, (unsigned long)stab->st_mode);
568 static void xfstat(int fd, struct stat *stab_r, const char *what) {
569 int r= fstat(fd, stab_r);
570 if (r) sysdie("could not fstat %s", what);
573 static void xfstat_isreg(int fd, struct stat *stab_r,
574 const char *path, const char *what) {
575 xfstat(fd, stab_r, what);
576 check_isreg(stab_r, path, what);
579 static void xlstat_isreg(const char *path, struct stat *stab,
580 int *enoent_r /* 0 means ENOENT is fatal */,
582 int r= lstat(path, stab);
584 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
585 sysdie("could not lstat %s %s", what, path);
587 if (enoent_r) *enoent_r= 0;
588 check_isreg(stab, path, what);
591 static void setnonblock(int fd, int nonblocking) {
592 int r= fcntl(fd, F_GETFL); if (r<0) sysdie("setnonblocking fcntl F_GETFL");
593 if (nonblocking) r |= O_NONBLOCK;
594 else r &= ~O_NONBLOCK;
595 r= fcntl(fd, F_SETFL, r); if (r<0) sysdie("setnonblocking fcntl F_SETFL");
598 static int samefile(const struct stat *a, const struct stat *b) {
599 assert(S_ISREG(a->st_mode));
600 assert(S_ISREG(b->st_mode));
601 return (a->st_ino == b->st_ino &&
602 a->st_dev == b->st_dev);
605 static char *sanitise(const char *input) {
606 static char sanibuf[100]; /* returns pointer to this buffer! */
608 const char *p= input;
612 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
614 if (!c) { *q++= '\''; *q=0; break; }
615 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
616 sprintf(q,"\\x%02x",c);
622 /*========== making new connections ==========*/
624 static void conn_dispose(Conn *conn) {
626 perhaps_close(&conn->fd);
628 until_connect= reconnect_delay_periods;
631 static int connecting_sockets[2]= {-1,-1};
632 static pid_t connecting_child;
634 static void connect_attempt_discard(void) {
635 if (connecting_sockets[0])
636 cancel_fd_read_except(connecting_sockets[0]);
638 perhaps_close(&connecting_sockets[0]);
639 perhaps_close(&connecting_sockets[1]);
641 if (connecting_child) {
642 int r= kill(connecting_child, SIGTERM);
643 if (r) syswarn("failed to kill connecting child");
644 int status= xwaitpid(&connecting_child, "connect");
646 if (!(WIFEXITED(status) ||
647 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
648 report_child_status("connect", status);
652 #define PREP_DECL_MSG_CMSG(msg) \
654 memset(&msg,0,sizeof(msg)); \
655 char msg##cbuf[CMSG_SPACE(sizeof(fd))]; \
656 msg.msg_control= msg##cbuf; \
657 msg.msg_controllen= sizeof(msg##cbuf);
659 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
662 conn= xmalloc(sizeof(*conn));
663 memset(conn,0,sizeof(*conn));
665 PREP_DECL_MSG_CMSG(msg);
666 struct cmsghdr *h= 0;
667 ssize_t rs= recvmsg(fd, &msg, MSG_DONTWAIT);
668 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
671 pid_t got= waitpid(connecting_child, &status, WNOHANG);
673 assert(got==connecting_child);
675 if (WIFEXITED(status) &&
676 (WEXITSTATUS(status) != 0 &&
677 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
678 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)) {
679 /* child already reported the problem */
680 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
681 warn("connect: connection attempt timed out");
682 } else if (!WIFEXITED(status)) {
683 report_child_status("connect", status);
684 /* that's probably the root cause then */
687 /* child is still running apparently, report the socket problem */
689 syswarn("connect: read from child socket failed");
690 else if (e == OOP_EXCEPTION)
691 warn("connect: unexpected exception on child socket");
693 warn("connect: unexpected EOF on child socket");
698 #define CHK(field, val) \
699 if (h->cmsg_##field != val) { \
700 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d"); \
703 CHK(level, SOL_SOCKET);
704 CHK(type, SCM_RIGHTS);
705 CHK(len, CMSG_LEN(sizeof(conn->fd)));
708 if (CMSG_NXTHDR(&msg,h)) { die("connect: child sent many cmsgs"); goto x; }
710 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
713 pid_t got= waitpid(connecting_child, &status, 0);
714 if (got==-1) sysdie("connect: real wait for child");
715 assert(got == connecting_child);
718 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
719 int es= WEXITSTATUS(status);
721 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
722 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
724 fatal("connect: child gave unexpected exit status %d", es);
728 setnonblock(conn->fd, 1);
729 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
730 LIST_ADDHEAD(conns, conn);
731 notice("#%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
732 connect_attempt_discard();
733 check_master_queue();
738 connect_attempt_discard();
741 static void connect_start(void) {
742 assert(!connecting_sockets[0]);
743 assert(!connecting_sockets[1]);
744 assert(!connecting_child);
746 notice("starting connection attempt");
748 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, connecting_sockets);
749 if (r) { syswarn("connect: cannot create socketpair for child"); goto x; }
751 connecting_child= xfork("connection");
753 if (!connecting_child) {
754 FILE *cn_from, *cn_to;
755 char buf[NNTP_STRLEN+100];
756 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
758 r= close(connecting_sockets[0]);
759 if (r) sysdie("connect: close parent socket in child");
761 alarm(connection_setup_timeout);
762 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
763 if (buf[0]) fatal("connect: rejected: %s", sanitise(buf));
764 else sysfatal("connect: connection attempt failed");
766 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
767 sysfatal("connect: authentication failed");
769 if (fputs("MODE STREAM\r\n", cn_to) ||
771 sysfatal("connect: could not send MODE STREAM");
772 buf[sizeof(buf)-1]= 0;
773 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
775 sysfatal("connect: could not read response to MODE STREAM");
777 fatal("connect: connection close in response to MODE STREAM");
782 fatal("connect: response to MODE STREAM is too long: %.100s...",
783 remote_host, sanitise(buf));
784 l--; if (l>0 && buf[l-1]=='\r') l--;
787 int rcode= strtoul(buf,&ep,10);
789 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf));
793 exitstatus= CONNCHILD_ESTATUS_STREAM;
799 warn("connect: unexpected response to MODE STREAM: %.50s",
805 int fd= fileno(cn_from);
807 PREP_DECL_MSG_CMSG(msg);
808 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
809 cmsg->cmsg_level= SOL_SOCKET;
810 cmsg->cmsg_type= SCM_RIGHTS;
811 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
812 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
814 msg.msg_controllen= cmsg->cmsg_len;
815 r= sendmsg(connecting_sockets[1], &msg, 0);
816 if (r) sysdie("sendmsg failed for new connection");
821 r= close(connecting_sockets[1]); connecting_sockets[1]= 0;
822 if (r) sysdie("connect: close child socket in parent");
824 on_fd_read_except(connecting_sockets[0], connchild_event);
828 connect_attempt_discard();
832 /*========== overall control of article flow ==========*/
834 static void check_master_queue(void) {
842 /* Find a connection to offer this article. We prefer a busy
843 * connection to an idle one, provided it's not full. We take the
844 * first (oldest) and since that's stable, it will mean we fill up
845 * connections in order. That way if we have too many
846 * connections, the spare ones will go away eventually.
848 for (walk=LIST_HEAD(conns); walk; walk=LIST_NEXT(walk)) {
849 int inqueue= walk->sent.count + walk->priority.count
850 + walk->waiting.count;
851 spare= walk->max_queue - inqueue;
852 assert(inqueue <= max_queue_per_conn);
854 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
855 else if (spare>0) /*working*/ { use= walk; break; }
859 Article *art= LIST_REMHEAD(queue);
860 LIST_ADDTAIL(use->waiting, art);
863 conn_maybe_write(use);
864 } else if (conns.count < max_connections &&
865 !connecting_child && !until_connect) {
866 until_connect= reconnect_delay_periods;
875 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
880 static void conn_maybe_write(Conn *conn) {
883 conn_make_some_xmits(conn);
885 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
889 void *rp= conn_write_some_xmits(conn);
890 if (rp==OOP_CONTINUE) {
891 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
893 } else if (rp==OOP_HALT) {
896 /* transmitted everything */
903 static void vconnfail(Conn *conn, const char *fmt, va_list al)
904 __attribute__((__format__(printf,2,0)));
906 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
907 int requeue[art_MaxState];
910 while ((art= LIST_REMHEAD(conn->priority))) LIST_ADDTAIL(queue, art);
911 while ((art= LIST_REMHEAD(conn->waiting))) LIST_ADDTAIL(queue, art);
912 while ((art= LIST_REMHEAD(conn->sent))) {
913 requeue[art->state]++;
914 if (art->state==art_Unsolicited) art->state= art_Unchecked;
915 LIST_ADDTAIL(queue,art);
920 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
923 char *m= xvasprintf(fmt,al);
924 warn("#%d connection failed, requeueing " RCI_TRIPLE_FMT_BASE ": %s",
925 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
928 LIST_REMOVE(conns,conn);
930 check_master_queue();
933 static void connfail(Conn *conn, const char *fmt, ...)
934 __attribute__((__format__(printf,2,3)));
935 static void connfail(Conn *conn, const char *fmt, ...) {
938 vconnfail(conn,fmt,al);
942 /*========== article transmission ==========*/
944 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
945 XmitKind kind) { /* caller must then fill in details */
946 struct iovec *v= &conn->xmit[conn->xmitu];
947 XmitDetails *d= &conn->xmitd[conn->xmitu++];
948 v->iov_base= (char*)data;
954 static void xmit_noalloc(Conn *conn, const char *data, int len) {
955 xmit_core(conn,data,len, xk_Const);
957 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
959 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
960 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
964 static void xmit_free(XmitDetails *d) {
966 case xk_Malloc: free(d->info.malloc_tofree); break;
967 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
968 case xk_Const: break;
973 static void *conn_write_some_xmits(Conn *conn) {
975 * 0: nothing more to write, no need to call us again
976 * OOP_CONTINUE: more to write but fd not writeable
977 * OOP_HALT: disaster, have destroyed conn
980 int count= conn->xmitu;
981 if (!count) return 0;
983 if (count > IOV_MAX) count= IOV_MAX;
984 ssize_t rs= writev(conn->fd, conn->xmit, count);
986 if (errno == EAGAIN) return OOP_CONTINUE;
987 connfail(conn, "write failed: %s", strerror(errno));
993 for (done=0; rs && done<conn->xmitu; done++) {
994 struct iovec *vp= &conn->xmit[done];
995 XmitDetails *dp= &conn->xmitd[done];
996 if (rs > vp->iov_len) {
1004 int newu= conn->xmitu - done;
1005 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1006 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1011 static void conn_make_some_xmits(Conn *conn) {
1013 if (conn->xmitu+5 > CONNIOVS)
1016 Article *art= LIST_REMHEAD(priority);
1017 if (!art) art= LIST_REMHEAD(waiting);
1020 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1021 /* actually send it */
1023 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1027 XMIT_LITERAL("TAKETHIS ");
1028 xmit_noalloc(conn, art->messageid, art->midlen);
1029 XMIT_LITERAL("\r\n");
1030 xmit_artbody(conn, artdata);
1033 /* we got 235 from IHAVE */
1035 xmit_artbody(conn, artdata);
1037 XMIT_LITERAL(".\r\n");
1042 art->state == art_Unchecked ? art_Unsolicited :
1043 art->state == art_Wanted ? art_Wanted :
1045 art->ipf->counts[art->state][RC_sent]++;
1046 LIST_ADDTAIL(conn->sent, art);
1052 XMIT_LITERAL("IHAVE ");
1054 XMIT_LITERAL("CHECK ");
1055 xmit_noalloc(conn, art->messageid, art->midlen);
1056 XMIT_LITERAL("\r\n");
1058 assert(art->state == art_Unchecked);
1059 art->ipf->counts[art->state][RCI_sent]++;
1060 LIST_ADDTAIL(conn->sent, art);
1066 /*========== handling responses from peer ==========*/
1068 static const oop_rd_style peer_rd_style= {
1069 OOP_RD_DELIM_STRIP, '\n',
1071 OOP_RD_SHORTREC_FORBID
1074 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_event ev,
1075 const char *errmsg, int errnoval,
1076 const char *data, size_t recsz, void *conn_v) {
1078 connfail(conn, "error receiving from peer: %s", errmsg);
1079 return OOP_CONTINUE;
1082 static Article *article_reply_check(Conn *conn, const char *response,
1083 int code_indicates_streaming,
1085 /* 1:yes, -1:no, 0:dontcare */,
1086 const char *sanitised_response) {
1087 Article *art= LIST_HEAD(conn->sent);
1091 "peer gave unexpected response when no commands outstanding: %s",
1092 sanitised_response);
1096 if (code_indicates_streaming) {
1097 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1098 if (!conn->stream) {
1099 connfail(conn, "peer gave streaming response code "
1100 " to IHAVE or subsequent body: %s", sanitised_response);
1103 const char *got_mid= response+4;
1104 int got_midlen= strcspn(got_mid, " \n\r");
1105 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1106 connfail(conn, "peer gave streaming response with syntactically invalid"
1107 " messageid: %s", sanitised_response);
1110 if (got_midlen != art->midlen ||
1111 memcmp(got_mid, art->messageid, got_midlen)) {
1112 connfail(conn, "peer gave streaming response code to wrong article -"
1113 " probable synchronisation problem; we offered: %s;"
1115 art->messageid, sanitised_response);
1120 connfail(conn, "peer gave non-streaming response code to"
1121 " CHECK/TAKETHIS: %s", sanitised_response);
1126 if (must_have_sent>0 && art->state < art_Wanted) {
1127 connfail(conn, "peer says article accepted but"
1128 " we had not sent the body: %s", sanitised_response);
1131 if (must_have_sent<0 && art->state >= art_Wanted) {
1132 connfail(conn, "peer says please sent the article but we just did: %s",
1133 sanitised_response);
1137 Article *art_again= LIST_REMHEAD(conn->sent);
1138 assert(art_again == art);
1142 static void update_nocheck(int accepted) {
1143 accept_proportion *= nocheck_decay;
1144 accept_proportion += accepted * (1.0 - nocheck_decay);
1145 int new_nocheck= accept_proportion >= nocheck_thresh;
1146 if (new_nocheck && !nocheck_reported) {
1147 notice("entering nocheck mode for the first time");
1148 nocheck_reported= 1;
1149 } else if (new_nocheck != nocheck) {
1150 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1152 nocheck= new_nocheck;
1155 static void article_done(Conn *conn, Article *art, int whichcount) {
1156 art->ipf->counts[art->state][whichcount]++;
1157 if (whichcount == RC_accepted) update_nocheck(1);
1158 else if (whichcount == RC_unwanted) update_nocheck(0);
1160 InputFile *ipf= art->ipf;
1161 while (art->blanklen) {
1162 static const char spaces[]=
1167 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1168 int r= pwrite(ipf->fd, spaces, w, art->offset);
1170 if (errno==EINTR) continue;
1171 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1172 art->messageid, art->blanklen, art->offset, ipf->path);
1174 assert(r>=0 && r<=w);
1180 assert(ipf->inprogress >= 0);
1182 if (!ipf->inprogress && ipf != main_input_file)
1183 queue_check_input_done();
1188 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
1189 const char *errmsg, int errnoval,
1190 const char *data, size_t recsz, void *conn_v) {
1193 if (ev == OOP_RD_EOF) {
1194 connfail(conn, "unexpected EOF from peer");
1195 return OOP_CONTINUE;
1197 assert(ev == OOP_RD_OK);
1199 char *sani= sanitise(data);
1202 unsigned long code= strtoul(data, &ep, 10);
1203 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1204 connfail(conn, "badly formatted response from peer: %s", sani);
1205 return OOP_CONTINUE;
1208 if (conn->quitting) {
1209 if (code!=205 && code!=503) {
1210 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1212 notice("#%d idle connection closed\n");
1213 assert(!conn->waiting.count);
1214 assert(!conn->priority.count);
1215 assert(!conn->sent.count);
1216 assert(!conn->xmitu);
1217 LIST_REMOVE(conns,conn);
1220 return OOP_CONTINUE;
1225 #define GET_ARTICLE(musthavesent) \
1226 art= article_reply_check(conn, data, musthavesent, code_streaming, sani); \
1227 if (art) ; else return OOP_CONTINUE /* reply_check has failed the conn */
1229 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) \
1230 code_streaming= (streaming); \
1231 GET_ARTICLE(musthavesent); \
1232 article_done(conn, art, RC_##how); break;
1234 #define PEERBADMSG(m) connfail(conn, m ": %s", sani); return OOP_CONTINUE
1236 int code_streaming= 0;
1240 case 400: PEERBADMSG("peer stopped accepting articles");
1241 case 503: PEERBADMSG("peer timed us out");
1242 default: PEERBADMSG("peer sent unexpected message");
1244 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1245 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1247 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1248 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1250 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1251 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1253 case 238: /* CHECK says send it */
1255 case 335: /* IHAVE says send it */
1257 assert(art->state == art_Unchecked);
1258 art->ipf->counts[art->state][RC_accepted]++;
1259 art->state= art_Wanted;
1260 LIST_ADDTAIL(conn->priority, art);
1263 case 431: /* CHECK or TAKETHIS says try later */
1265 case 436: /* IHAVE says try later */
1268 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1270 sysfatal("write to defer file %s",path_defer);
1271 article_done(conn, art, RC_deferred);
1276 conn_maybe_write(sendon);
1277 check_master_queue();
1278 return OOP_CONTINUE;
1282 /*========== monitoring of input files ==========*/
1284 static void feedfile_eof(InputFile *ipf) {
1285 assert(ipf != main_input_file); /* promised by tailing_try_read */
1287 inputfile_tailing_stop(ipf);
1288 assert(ipf->fd >= 0);
1289 if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
1292 if (ipf == flushing_input_file) {
1293 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1294 if (main_input_file) inputfile_tailing_start(main_input_file);
1295 statemc_check_flushing_done();
1296 } else if (ipf == backlog_input_file) {
1297 statemc_check_backlog_done();
1299 abort(); /* supposed to wait rather than get EOF on main input file */
1303 static InputFile *open_input_file(const char *path) {
1304 int fd= open(path, O_RDONLY);
1306 if (errno==ENOENT) return 0;
1307 sysfatal("unable to open input file %s", path);
1310 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
1311 memset(ipf,0,sizeof(*ipf));
1313 ipf->readable.on_readable= tailing_on_readable;
1314 ipf->readable.on_cancel= tailing_on_cancel;
1315 ipf->readable.try_read= tailing_try_read;
1318 strcpy(ipf->path, path);
1323 static void close_input_file(InputFile *ipf) {
1324 assert(!ipf->readable_callback); /* must have had ->on_cancel */
1325 assert(!ipf->filemon); /* must have had inputfile_tailing_stop */
1326 assert(!ipf->rd); /* must have had inputfile_tailing_stop */
1327 assert(!ipf->inprogress); /* no dangling pointers pointing here */
1330 if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
1334 /*---------- dealing with articles read in the input file ----------*/
1336 typedef void *feedfile_got_article(oop_source *lp, oop_read *rd,
1337 oop_rd_event ev, const char *errmsg,
1339 const char *data, size_t recsz,
1341 InputFile *ipf= ipf_v;
1343 char tokentextbuf[sizeof(TOKEN)*2+3];
1345 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
1347 if (data[0] && data[0]!=' ') {
1348 char *space= strchr(data,' ');
1349 int tokenlen= space-data;
1350 int midlen= (int)recsz-tokenlen-1;
1351 if (midlen < 0) goto bad_data;
1353 if (tokenlen != sizeof(TOKEN)*2+2) goto bad_data;
1354 memcpy(tokentextbuf, data, tokenlen);
1355 tokentextbuf[tokenlen]= 0;
1356 if (!IsToken(tokentextbuf)) goto bad_data;
1358 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
1359 art->offset= ipf->offset;
1360 art->blanklen= recsz;
1361 art->midlen= midlen;
1362 art->state= art_Unchecked;
1363 art->ipf= ipf; ipf->inprogress++;
1364 art->token= TextToToken(tokentextbuf);
1365 strcpy(art->messageid, space+1);
1366 LIST_ADDTAIL(queue, art);
1368 ipf->offset += recsz + 1;
1370 if (sms==sm_NORMAL && ipf==main_input_file &&
1371 ipf->offset >= flush_threshold)
1372 statemc_start_flush("feed file size");
1374 check_master_queue();
1377 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
1378 assert(sms == sm_NORMAL);
1380 debug("starting flush (%s) (%lu >= %lu) (%d)",
1382 (unsigned long)ipf->offset, (unsigned long)flush_threshold,
1385 int r= link(feedfile, duct_path);
1386 if (r) sysdie("link feedfile %s to flushing file %s", feedfile,
1390 xunlink(feedfile, "old feedfile link");
1393 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
1396 /*========== tailing input file ==========*/
1398 static void filemon_start(InputFile *ipf) {
1399 assert(!ipf->filemon);
1401 ipf->filemon= xmalloc(sizeof(*ipf->filemon));
1402 memset(ipf->filemon, 0, sizeof(*ipf->filemon));
1403 filemon_method_startfile(ipf, ipf->filemon);
1406 static void filemon_stop(InputFile *ipf) {
1407 if (!ipf->filemon) return;
1408 filemon_method_stopfile(ipf, ipf->filemon);
1413 static void filemon_callback(InputFile *ipf) {
1414 ipf->readable_callback(ipf->readable_callback_user);
1417 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
1419 InputFile *ipf= user;
1420 return ipf->readable_callback(ipf->readable_callback_user);
1423 static void on_cancel(struct oop_readable *rable) {
1424 InputFile *ipf= (void*)rable;
1426 if (ipf->filemon) filemon_stopfile(ipf);
1427 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1428 ipf->readable_callback= 0;
1431 static void tailing_queue_readable(InputFile *ipf) {
1432 /* lifetime of ipf here is OK because destruction will cause
1433 * on_cancel which will cancel this callback */
1434 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1437 static int tailing_on_readable(struct oop_readable *rable,
1438 oop_readable_call *cb, void *user) {
1439 InputFile *ipf= (void*)rable;
1441 tailing_on_cancel(rable);
1442 ipf->readable_callback= cb;
1443 ipf->readable_callback_user= user;
1444 filemon_startfile(ipf);
1446 tailing_queue_readable(ipf);
1450 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
1452 InputFile *ipf= (void*)rable;
1454 ssize_t r= read(ipf->fd, buffer, length);
1456 if (errno==EINTR) continue;
1460 if (ipf==main_input_file) {
1463 } else if (ipf==flushing_input_file) {
1465 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1466 } else if (ipf==backlog_input_file) {
1476 /*---------- filemon implemented with inotify ----------*/
1478 #if defined(HAVE_INOTIFY) && !defined(HAVE_FILEMON)
1479 #define HAVE_FILEMON
1481 #include <linux/inotify.h>
1483 static int filemon_inotify_fd;
1484 static int filemon_inotify_wdmax;
1485 static InputFile **filemon_inotify_wd2ipf;
1487 typedef struct Filemon_Perfile {
1489 } Filemon_Inotify_Perfile;
1491 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
1492 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
1493 if (wd < 0) sysdie("inotify_add_watch %s", ipf->path);
1495 if (wd >= filemon_inotify_wdmax) {
1497 filemon_inotify_wd= xrealloc(filemon_inotify_wd2ipf,
1498 sizeof(*filemon_inotify_wd2ipf) * newmax);
1499 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
1500 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
1501 filemon_inotify_wdmax= newmax;
1504 assert(!filemon_inotify_wd2ipf[wd]);
1505 filemon_inotify_wd2ipf[wd]= ipf;
1507 debug("filemon inotify startfile %p wd=%d wdmax=%d",
1508 ipf, wd, filemon_inotify_wdmax);
1513 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
1515 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
1516 int r= inotify_rm_watch(filemon_inotify_fd, filemon_inotify_wd);
1517 if (r) sysdie("inotify_rm_watch");
1518 filemon_inotify_wd2ipf[wd]= 0;
1521 static void *filemon_inotify_readable(oop_source *lp, int fd,
1522 oop_event e, void *u) {
1523 struct inotify_event iev;
1525 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
1527 if (errno==EAGAIN) break;
1528 sysdie("read from inotify master");
1529 } else if (r==sizeof(iev)) {
1530 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
1532 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
1534 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
1535 debug("filemon inotify readable read %p wd=%p", iev.wd, ipf);
1536 filemon_callback(ipf);
1538 return OOP_CONTINUE;
1541 static int filemon_method_init(void) {
1542 filemon_inotify_fd= inotify_init();
1543 if (filemon_inotify_fd<0) {
1544 syswarn("could not initialise inotify: inotify_init failed");
1548 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable);
1550 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
1554 #endif /* HAVE_INOTIFY && !HAVE_FILEMON *//
1556 /*---------- filemon dummy implementation ----------*/
1558 #if !defined(HAVE_FILEMON)
1560 typedef struct Filemon_Perfile { int dummy; } Filemon_Dummy_Perfile;
1562 static int filemon_method_init(void) { return 0; }
1563 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
1564 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
1566 #endif /* !HAVE_FILEMON */
1568 /*---------- interface to start and stop an input file ----------*/
1570 static const oop_rd_style feedfile_rdstyle= {
1571 OOP_RD_DELIM_STRIP, '\n',
1573 OOP_RD_SHORTREC_EOF,
1576 static void inputfile_tailing_start(InputFile *ipf) {
1578 ipf->readable->on_readable= tailing_on_readable;
1579 ipf->readable->on_cancel= tailing_on_cancel;
1580 ipf->readable->try_read= tailing_try_read;
1581 ipf->readable->delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
1582 ipf->readable->delete_kill= 0;
1584 ipf->readable_callback= 0;
1585 ipf->readable_callback_user= 0;
1587 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
1590 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
1591 feedfile_got_article,ipf, feedfile_problem,ipf);
1592 if (r) sysdie("unable start reading feedfile %s",ipf->path);
1595 static void inputfile_tailing_stop(InputFile *ipf) {
1597 oop_rd_cancel(ipf->rd);
1598 oop_rd_delete(ipf->rd);
1600 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
1604 /*========== interaction with innd - state machine ==========*/
1606 /* See official state diagram at top of file. We implement
1617 |`---------------------------------------------------.
1619 |`---------------- - - - |
1620 D ENOENT | D EXISTS see OVERALL STATES diagram |
1621 | for full startup logic |
1624 | ============ try to |
1630 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
1631 ^ | hardlink F to D |
1634 | | our handle onto F is now onto D |
1637 | |<-------------------<---------------------<---------+
1639 | | spawn inndcomm flush |
1641 | ================== |
1642 | FLUSHING[-ABSENT] |
1644 | main D tail/none |
1645 | ================== |
1647 | | INNDCOMM FLUSH FAILS ^
1648 | |`----------------------->----------. |
1650 | | NO SUCH SITE V |
1651 ^ |`--------------->----. ==================== |
1652 | | \ FLUSHFAILED[-ABSENT] |
1654 | | FLUSH OK \ main D tail/none |
1655 | | open F \ ==================== |
1657 | | \ | TIME TO RETRY |
1658 | |`------->----. ,---<---'\ `----------------'
1659 | | D NONE | | D NONE `----.
1661 | ============= V V ============
1662 | SEPARATED-1 | | DROPPING-1
1663 | flsh->fd>=0 | | flsh->fd>=0
1664 | [Separated] | | [Dropping]
1665 | main F idle | | main none
1666 | old D tail | | old D tail
1667 | ============= | | ============
1669 ^ | EOF ON D | | defer | EOF ON D
1671 | =============== | | ===============
1672 | SEPARATED-2 | | DROPPING-2
1673 | flsh->fd==-1 | V flsh->fd==-1
1674 | [Finishing] | | [Dropping]
1675 | main F tail | `. main none
1676 | old D closed | `. old D closed
1677 | =============== V `. ===============
1679 | | ALL D PROCESSED `. | ALL D PROCESSED
1680 | V install defer as backlog `. | install defer
1681 ^ | close D `. | close D
1682 | | unlink D `. | unlink D
1685 `----------' ==============
1705 static void statemc_init(void) {
1706 struct stat stab, stabf;
1708 path_lock= xasprintf("%s_lock", feedfile);
1709 path_flushing= xasprintf("%s_flushing", feedfile);
1710 path_defer= xasprintf("%s_defer", feedfile);
1711 globpat_backlog= xasprintf("%s_backlog*", feedfile);
1714 int lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
1715 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
1718 memset(&fl,0,sizeof(fl));
1720 fl.l_whence= SEEK_SET;
1721 r= fcntl(lockfd, F_SETLK, &fl);
1723 if (errno==EACCES || errno==EAGAIN) {
1724 if (quiet_multiple) exit(0);
1725 fatal("another duct holds the lockfile");
1727 sysdie("fcntl F_SETLK lockfile %s", path_lock);
1730 xfstat_isreg(lockfd, &stabf, "lockfile");
1732 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
1734 if (!lock_noent && samefile(&stab, &stabf))
1738 sysdie("could not close stale lockfile %s", path_lock);
1740 debug("startup: locked");
1742 search_backlog_file();
1745 xlstat_isreg(path_defer, &stab, &defer_noent, "defer file");
1747 debug("startup: ductdefer ENOENT");
1749 debug("startup: ductdefer nlink=%ld", (long)stab.st_nlink);
1750 switch (stab.st_nlink==1) {
1752 open_defer(); /* so that we will later close it and rename it */
1755 xunlink(path_defer, "stale defer file link"
1756 " (presumably hardlink to backlog file)");
1759 die("defer file %s has unexpected link count %d",
1760 path_defer, stab.st_nlink);
1764 struct stat stab_f, stab_d;
1767 InputFile *file_d= open_input_file(path_flushing);
1768 if (file_d) xfstat_isreg(file_d->fd, &stab_d, "flushing file");
1770 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
1772 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
1773 debug("startup: F==D => Hardlinked");
1774 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
1779 debug("startup: F ENOENT => Moved");
1780 if (file_d) startup_set_input_file(file_d);
1781 spawn_inndcomm_flush("feedfile missing at startup");
1782 /* => Flushing, sms:=FLUSHING */
1785 debug("startup: F!=D => Separated");
1786 startup_set_input_file(file_d);
1787 SMS(SEPARATED, 0, "found both old and current feed files");
1789 debug("startup: F exists, D ENOENT => Normal");
1790 FILE *file_f= open_input_file(feedfile);
1791 if (!file_f) die("feed file vanished during startup");
1792 startup_set_input_file(file_f);
1793 SMS(NORMAL, flushfail_retry_periods, "normal startup");
1798 static void statemc_period_poll(void) {
1799 if (!sm_period_counter) return;
1800 sm_period_counter--;
1801 assert(sm_period_counter>=0);
1803 if (sm_period_counter) return;
1806 statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
1808 case sm_FLUSHFAILED:
1809 spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
1816 static void startup_set_input_file(InputFile *f) {
1817 assert(!main_input_file);
1819 inputfile_tailing_start(f);
1822 static int inputfile_is_done(InputFile *ipf) {
1824 if (ipf->inprogress) return 0; /* new article in the meantime */
1825 if (ipf->fd >= 0); return 0; /* not had EOF */
1829 static void notice_processed(InputFile *ipf, const char *what,
1831 #define RCI_NOTHING(x) /* nothing */
1832 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
1833 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, .x)
1835 info("processed %s%s offered=%d(ch%d,nc%d) accepted=%d(ch%d+nc%d)"
1836 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
1839 ipf->counts[art_Unchecked].sent + ipf->counts[art_Unsolicited].sent
1840 , ipf->counts[art_Unchecked].sent, ipf->counts[art_Unsolicited].sent,
1841 ipf->counts[art_Wanted].accepted + ipf->counts[art_Unsolicited].accepted
1842 ,ipf->counts[art_Wanted].accepted,ipf->counts[art_Unsolicited].accepted
1843 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
1847 static void statemc_check_backlog_done(void) {
1848 InputFile *ipf= backlog_input_file();
1849 if (!inputfile_is_done(ipf)) return;
1851 const char *slash= strrchr(ipf->path, "/");
1852 const char *leaf= slash ? slash+1 : ipf->path;
1853 const char *under= strchr(slash, "_");
1854 const char *rest= under ? under+1 : leaf;
1855 if (!strncmp(rest,"backlog",7)) rest += 7;
1856 notice_processed(ipf,"backlog:",rest);
1858 close_input_file(ipf);
1859 if (unlink(ipf->path)) {
1860 if (errno != ENOENT)
1861 sysdie("could not unlink processed backlog file %s", ipf->path);
1862 warn("backlog file %s vanished while we were reading it"
1863 " so we couldn't remove it (but it's done now, anyway)",
1867 backlog_input_file= 0;
1868 search_backlog_file();
1872 static void statemc_check_flushing_done(void) {
1873 InputFile *ipf= flushing_input_file;
1874 if (!inputfile_is_done(ipf)) return;
1876 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1878 notice_processed(ipf,"feedfile",0);
1882 xunlink(path_flushing, "old flushing file");
1884 close_input_file(flushing_input_file);
1885 free(flushing_input_file);
1886 flushing_input_file= 0;
1888 if (sms==sm_SEPARATED) {
1889 notice("flush complete");
1890 SMS(NORMAL, 0, "flush complete");
1891 } else if (sms==sm_DROPPING) {
1892 SMS(DROPPED, 0, "old flush complete");
1893 search_backlog_file();
1894 notice("feed dropped, but will continue until backlog is finished");
1898 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
1900 assert(!inputfile_is_done(main_input_file));
1901 statemc_check_flushing_done();
1902 statemc_check_backlog_done();
1903 return OOP_CONTINUE;
1906 static void queue_check_input_done(void) {
1907 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
1910 static void statemc_setstate(StateMachineState newsms, int periods,
1911 const char *forlog, const char *why) {
1913 sm_period_counter= periods;
1915 const char *xtra= "";
1917 case sm_FLUSHING: sm_FLUSHFAILED:
1918 if (!main_input_file) xtra= "-ABSENT";
1920 case sm_SEPARATED: case sm_DROPPING:
1921 xtra= flushing_input_file->fd >= 0 ? "-1" : "-2";
1927 info("%s%s[%d] %s",forlog,xtra,periods,why);
1929 info("%s%s %s",forlog,xtra,why);
1933 /*---------- defer and backlog files ----------*/
1935 static void open_defer(void) {
1940 defer= fopen(path_defer, "a+");
1941 if (!defer) sysfatal("could not open defer file %s", path_defer);
1943 /* truncate away any half-written records */
1945 xfstat_isreg(fileno(defer), &stab, "newly opened defer file");
1947 if (stab.st_size > LONG_MAX)
1948 die("defer file %s size is far too large", path_defer);
1953 long orgsize= stab.st_size;
1954 long truncto= stab.st_size;
1956 if (!truncto) break; /* was only (if anything) one half-truncated record */
1957 if (fseek(defer, truncto-1, SEEK_SET) < 0)
1958 sysdie("seek in defer file %s while truncating partial", path_defer);
1963 sysdie("failed read from defer file %s", path_defer);
1965 die("defer file %s shrank while we were checking it!", path_defer);
1971 if (stab.st_size != truncto) {
1972 warn("truncating half-record at end of defer file %s -"
1973 " shrinking by %ld bytes from %ld to %ld",
1974 path_defer, orgsize - truncto, orgsize, truncto);
1977 sysfatal("could not flush defer file %s", path_defer);
1978 if (ftruncate(fileno(defer), truncto))
1979 sysdie("could not truncate defer file %s", path_defer);
1982 info("continuing existing defer file %s (%ld bytes)",
1983 path_defer, orgsize);
1985 if (fseek(defer, truncto, SEEK_SET))
1986 sysdie("could not seek to new end of defer file %s", path_defer);
1989 static void close_defer(void) {
1993 xfstat(fileno(defer), &stab, "defer file");
1995 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
1998 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
1999 (unsigned long)now.tv_sec,
2000 (unsigned long)stab.st_ino);
2001 if (link(path_defer, path_backlog))
2002 sysfatal("could not install defer file %s as backlog file %s",
2003 path_defer, backlog);
2004 if (unlink(path_defer))
2005 sysdie("could not unlink old defer link %s to backlog file %s",
2006 path_defer, backlog);
2008 if (until_backlog_nextscan < 0 ||
2009 until_backlog_nextscan > backlog_retry_minperiods + 1)
2010 until_backlog_nextscan= backlog_retry_minperiods + 1;
2013 static void poll_backlog_file(void) {
2014 if (until_backlog_nextscan < 0) return;
2015 if (until_backlog_nextscan-- > 0) return;
2016 search_backlog_file();
2019 static void search_backlog_file(void) {
2020 /* returns non-0 iff there are any backlog files */
2025 const char *oldest_path=0;
2026 time_t oldest_mtime, now;
2028 if (backlog_input_file) return 3;
2032 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2036 sysdie("failed to expand backlog pattern %s", globpat_backlog);
2038 die("out of memory expanding backlog pattern %s", globpat_backlog);
2040 for (i=0; i<gl.gl_pathc; i++) {
2041 const char *path= gl.gl_pathv[i];
2043 if (strchr(path,'#') || strchr(path,'~')) {
2044 debug("backlog file search skipping %s", path);
2047 r= stat(path, &stab);
2049 syswarn("failed to stat backlog file %s", path);
2052 if (!S_ISREG(stab.st_mode)) {
2053 warn("backlog file %s is not a plain file (or link to one)", path);
2056 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2058 oldest_mtime= stab.st_mtime;
2061 case GLOB_NOMATCH: /* fall through */
2064 sysdie("glob expansion of backlog pattern %s gave unexpected"
2065 " nonzero (error?) return value %d", globpat_backlog, r);
2071 debug("backlog scan: none");
2073 if (sms==sm_DROPPED) {
2074 notice("feed dropped and our work is complete");
2075 xunlink(path_lock, "lockfile for old feed");
2078 until_backlog_nextscan= backlog_spontaneous_rescan_periods;
2082 now= time(); if (now==-1) sysdie("time(2) failed");
2083 double age= difftime(now, oldest_mtime);
2084 long age_deficiency= (backlog_retry_minperiods * PERIOD_SECONDS) - age;
2086 if (age_deficiency <= 0) {
2087 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2088 age, age_deficiency, oldest_path);
2090 backlog_input_file= open_input_file(oldest_path);
2091 if (!backlog_input_file) {
2092 warn("backlog file %s vanished as we opened it", backlog_input_file);
2095 inputfile_tailing_start(backlog_input_file);
2096 until_backlog_nextscan= -1;
2100 until_backlog_nextscan= age_deficiency / PERIOD_SECONDS;
2102 if (backlog_spontaneous_rescan_periods >= 0 &&
2103 until_backlog_nextscan > backlog_spontaneous_rescan_periods)
2104 until_backlog_nextscan= backlog_spontaneous_rescan_periods;
2106 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2107 age, age_deficiency, until_backlog_nextscan, oldest_path);
2111 /*========== flushing the feed ==========*/
2113 static pid_t inndcomm_child;
2115 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
2116 assert(inndcomm_child);
2117 int status= xwaitpid(&inndcomm_child, "inndcomm");
2118 loop->cancel_fd(fd);
2121 assert(!flushing_input_file);
2123 if (WIFEXITED(status)) {
2124 switch (WEXITSTATUS(status)) {
2126 case INNDCOMMCHILD_ESTATUS_FAIL:
2129 case INNDCOMMCHILD_ESTATUS_NONESUCH:
2130 warn("feed has been dropped by innd, finishing up");
2131 flushing_input_file= main_input_file;
2132 tailing_queue_readable(flushing_input_file);
2133 /* we probably previously returned EAGAIN from our fake read method
2134 * when in fact we were at EOF, so signal another readable event
2135 * so we actually see the EOF */
2139 if (flushing_input_file) {
2140 SMS(DROPPING, 0, "feed dropped by innd, but must finish last flush");
2143 SMS(DROPPED, 0, "feed dropped by innd");
2144 search_backlog_file();
2146 return OOP_CONTINUE;
2150 flushing_input_file= main_input_file;
2151 tailing_queue_readable(flushing_input_file);
2153 main_input_file= open_input_file(feedfile);
2154 if (!main_input_file)
2155 die("flush succeeded but feedfile %s does not exist!", feedfile);
2157 if (flushing_input_file) {
2158 SMS(SEPARATED, spontaneous_flush_periods, "recovery flush complete");
2161 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2163 return OOP_CONTINUE;
2166 goto unexpected_exitstatus;
2169 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
2170 warn("flush timed out trying to talk to innd");
2173 unexpected_exitstatus:
2174 report_child_status("inndcomm child", status);
2178 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
2181 static void inndcommfail(const char *what) {
2182 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
2183 exit(INNDCOMMCHILD_ESTATUS_FAIL);
2186 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
2189 notice("flushing %s",why);
2191 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
2192 assert(!inndcomm_child);
2194 if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
2196 inndcomm_child= xfork();
2198 if (!inndcomm_child) {
2199 static char flushargv[2]= { sitename, 0 };
2204 alarm(inndcomm_flush_timeout);
2205 r= ICCopen(); if (r) inndcommfail("connect");
2206 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
2207 if (!r) exit(0); /* yay! */
2209 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
2210 syswarn("innd ctlinnd flush failed: innd said %s", reply);
2211 exit(INNDCOMMCHILD_ESTATUS_FAIL);
2215 int sentinel_fd= pipefds[0];
2216 on_fd_read_except(sentinel_fd, inndcomm_event);
2218 SMS(FLUSHING, 0, why);
2221 /*========== main program ==========*/
2223 static void postfork_inputfile(InputFile *ipf) {
2225 assert(ipf->fd >= 0);
2230 static void postfork_stdio(FILE *f) {
2231 /* we have no stdio streams that are buffered long-term */
2235 static void postfork(const char *what) {
2236 if (signal(SIGPIPE, SIG_DFL) == SIG_ERR)
2237 sysdie("%s child: failed to reset SIGPIPE");
2239 postfork_inputfile(main_input_file);
2240 postfork_inputfile(flushing_input_file);
2243 for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn))
2246 postfork_stdio(defer);
2249 #define EVERY(what, interval, body) \
2250 static const struct timeval what##_timeout = { 5, 0 }; \
2251 static void what##_schedule(void); \
2252 static void *what##_timedout(oop_source *lp, struct timeval tv, void *u) { \
2254 what##_schedule(); \
2256 static void what##_schedule(void) { \
2257 loop->on_time(loop, what##_timeout, what##_timedout, 0); \
2260 EVERY(filepoll, {5,0}, {
2261 if (main_input_file && main_input_file->readable_callback)
2262 filemon_callback(main_input_file);
2265 #define DEBUGF_IPF(wh) " " #wh "=%p/%s:ip=%ld,off=%ld,fd=%d%s" \
2266 #define DEBUG_IPF(sh) \
2267 wh##_input_file, debug_ipf_path(wh##_input_file), \
2268 wh##_input_file->inprogress, (long)wh##_input_file->offset, \
2269 wh##_input_file->fd, wh##_input_file->rd ? "+" : ""
2270 static const char *debug_ipf_path(InputFile *ipf) {
2271 char *slash= strrchr(ipf->path,'/');
2272 return slash ? slash+1 : ipf->path;
2275 EVERY(period, {PERIOD_SECONDS,0}, {
2277 " sms=%s[%d] conns=%d queue=%d until_connect=%d"
2278 " input_files" DEBUGF_IPF(main) DEBUGF_IPF(old) DEBUGF_FMT(flushing)
2279 " children connecting=%ld inndcomm_child"
2281 sms_names[sms], sm_period_counter,
2282 queue.count, conns.count, until_connect,
2283 DEBUG_IPF(main), DEBUG_IPF(flushing), DEBUG_IPF(flushing),
2284 (long)connecting_child, (long)inndcomm_child
2287 if (until_connect) until_connect--;
2289 poll_backlog_file();
2290 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
2291 statemc_period_poll();
2292 check_master_queue();
2296 /*========== option parsing ==========*/
2299 of_seconds= 001000u;
2300 of_boolean= 002000u;
2303 typedef struct Option Option;
2304 typedef void OptionParser(const Option*, const char *val);
2314 void op_integer(const Option *o, const char *val) {
2317 unsigned long ul= strtoul(val,&ep,10);
2318 if (*ep || ep==val || errno || ul>INT_MAX)
2319 badusage("bad integer value for %s",o->long);
2320 int *store= o->store;
2324 void op_double(const Option *o, const char *val) {
2325 int *store= o->store;
2328 *store= strtod(val, &ep);
2329 if (*ep || ep==val || errno)
2330 badusage("bad floating point value for %s",o->long);
2333 void op_string(const Option *o, const char *val) {
2334 char **store= o->store;
2339 void op_seconds(const Option *o, const char *val) {
2340 int *store= o->store;
2343 double v= strtod(val,&ep);
2344 if (ep==val) badusage("bad time/duration value for %s",o->long);
2346 if (!*ep || !strcmp(ep,"s")) unit= 1;
2347 else if (!strcmp(ep,"m")) unit= 60;
2348 else if (!strcmp(ep,"h")) unit= 3600;
2349 else if (!strcmp(ep,"d")) unit= 86400;
2350 else badusage("bad units %s for time/duration value for %s",ep,o->long);
2354 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->long);
2358 void op_periods_rndup(const Option *o, const char *val) {
2359 int *store= o->store;
2361 *store += PERIOD_SECONDS-1;
2362 *store /= PERIOD_SECONDS;
2365 void op_periods_booltrue(const Option *o, const char *val) {
2366 int *store= o->store;
2369 void op_periods_boolfalse(const Option *o, const char *val) {
2370 int *store= o->store;
2374 static const Option options[]= {
2375 {'f',"feedfile", &feedfile, op_string },
2376 {'q',"quiet-multiple", &quiet_multiple, op_booltrue, 1 },
2378 { 0, "max-connections", &max_connections op_integer },
2379 { 0, "max-queue-per-conn", &max_queue_per_conn op_integer },
2382 { 0, "streaming", &try_stream, op_booltrue, 1 },
2383 { 0, "no-streaming", &try_stream, op_boolfalse, 1 },
2384 {'P',"port", &port op_integer },
2385 { 0, "inndconf", &inndconffile, op_string },
2386 {'d',"daemon", &become_daemon, op_booltrue, 1 },
2387 { 0, "no-daemon", &become_daemon, op_boolfalse, 1 },
2389 { 0, "no-check-proportion", &nocheck_thresh_pct, op_double },
2390 { 0, "no-check-filter", &nocheck_decay_articles, op_double },
2392 { 0, "reconnect-interval", &reconnect_delay_periods, op_periods_rndup },
2393 { 0, "flush-retry-interval", &flushfail_retry_periods, op_periods_rndup },
2394 { 0, "connection-timeout", &connection_timeout, op_seconds },
2395 { 0, "inndcomm-timeout", &inndcomm_flush_timeout, op_seconds },
2398 int main(int argc, char **argv) {
2404 if (*arg != '-') break;
2405 if (!strcmp(arg,"--")) { arg= *++argv; break; }
2407 while ((a= *++arg)) {
2411 char *equals= strchr(arg,'=');
2412 int len= equals ? (equals - arg) : strlen(arg);
2413 for (o=options; o->long; o++)
2414 if (strlen(o->long) == len && !memcmp(o->long,arg,len))
2416 badusage("unknown long option --%s",arg);
2419 if (equals) badusage("option --%s does not take a value",o->long);
2421 } else if (equals) {
2425 if (!arg) badusage("option --%s needs a value",o->long);
2428 break; /* eaten the whole argument now */
2430 for (o=options; o->long; o++)
2433 badusage("unknown short option -%c",a);
2440 if (!arg) badusage("option -%c needs a value",o->short);
2443 break; /* eaten the whole argument now */
2448 if (!arg) badusage("need site name argument");
2454 if (*++argv) badusage("too many non-option arguments");
2456 if (nocheck_thresh_pct < 0 || nocheck_thresh_pct > 100)
2457 badusage("nocheck threshold percentage must be between 0..100");
2458 nocheck_thresh= nocheck_thresh_pct * 0.01;
2460 if (nocheck_decay_articles < 0.1)
2461 badusage("nocheck decay articles must be at least 0.1");
2462 nocheck_decay= 1 - 1/nocheck_decay_articles;
2465 pathoutgoing= innconf->pathoutgoing;
2466 innconf_read(inndconffile);
2469 feedfile= xasprintf("%s/%s",pathoutgoing,sitename);
2470 else if (!feedfile[0])
2471 badusage("feed filename must be nonempty");
2472 else if (feedfile[strlen(feedfile)-1]=='/')
2473 feedfile= xasprintf("%s%s",feedfile,sitename);
2475 const char *feedfile_forbidden= "?*[~#";
2477 while ((c= *feedfile_forbidden++))
2478 if (strchr(feedfile, c))
2479 badusage("feed filename may not contain metacharacter %c",c);
2481 loop= oop_sys_new();
2482 if (!loop) sysdie("could not create liboop event loop");
2484 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
2485 sysdie("could not ignore SIGPIPE");
2487 if (become_daemon) {
2488 for (i=3; i<255; i++)
2489 /* do this now before we open syslog, etc. */
2491 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
2493 int null= open("/dev/null",O_RDWR);
2494 if (null<0) sysdie("failed to open /dev/null");
2500 pid_t child1= xfork("daemonise first fork");
2501 if (child1) _exit(0);
2503 pid_t sid= setsid();
2504 if (sid != child1) sysdie("setsid failed");
2506 pid_t child2= xfork("daemonise second fork");
2507 if (child2) _exit(0);
2512 if (!filemon_init()) {
2513 warn("no file monitoring available, polling");
2514 filepoll_schedule();