2 * Newsfeeds file entries should look like this:
3 * host.name.of.site[/exclude,exclude,...]\
4 * :pattern,pattern...[/distribution,distribution...]\
8 * sitename[/exclude,exclude,...]\
9 * :pattern,pattern...[/distribution,distribution...]\
15 * or might be blanked out
16 * <spc><spc><spc><spc>....
18 * F site.name main feed file
19 * opened/created, then written, by innd
22 * tokens blanked out by duct when processed
23 * site.name_lock lock preventing multiple ducts
24 * to hold lock must open,F_SETLK[W]
25 * and then stat to check that locked file
26 * still has name site.name_lock
27 * holder of this lock is "duct"
28 * (only) lockholder may remove the lockfile
29 * D site.name_flushing temporary feed file during flush (or crash)
30 * hardlink created by duct
32 * site.name_defer 431'd articles, still being written,
33 * created, written, used by duct
35 * site.name_backlog.<date>.<inum>
36 * 431'd articles, ready for innxmit or duct
37 * created (link/mv) by duct
38 * site.name_backlog<anything-else> (where <anything-else> does not
39 * contain '#' or '~') eg
40 * site.name_backlog.manual
41 * anything the sysadmin likes (eg, feed files
42 * from old feeds to be merged into this one)
43 * created (link/mv) by admin
44 * may be symlinks (in which case links
45 * may be written through, but only links
48 * It is safe to remove backlog files manually,
49 * if it's desired to throw away the backlog.
51 * Backlog files are also processed by innduct. We find the oldest
52 * backlog file which is at least a certain amount old, and feed it
53 * back into our processing. When every article in it has been read
54 * and processed, we unlink it and look for another backlog file.
56 * If we don't have a backlog file that we're reading, we close the
57 * defer file that we're writing and make it into a backlog file at
58 * the first convenient opportunity.
69 | | <----------------<---------------------------------'|
75 | F: innd writing, duct reading |
78 | | duct decides time to flush |
79 | | duct makes hardlink |
81 | V <------------------------'|
83 | F == D: innd writing, duct reading both exist |
86 | | <-----------<-------------<--'|
90 | V <---------------------. |
93 | D: innd writing, duct reading; or ENOENT | |
95 | | duct requests flush of feed | |
96 | | (others can too, harmlessly) | |
100 | D: innd flushing, duct; or ENOENT | |
102 | | inndcomm flush fails | |
103 | |`-------------------------->------------------' |
105 | | inndcomm reports no such site |
106 | |`---------------------------------------------------- | -.
108 | | innd finishes writing D, creates F | |
109 | | inndcomm reports flush successful | |
112 | Separated <----------------' |
113 | F: innd writing F!=D /
114 | D: duct reading; or ENOENT both exist /
116 | | duct gets to the end of D /
117 | | duct opens F too /
120 | F: innd writing, duct reading |
121 | D: duct finishing V
123 | | duct finishes processing D F: ENOENT
124 | V duct unlinks D D: duct reading
126 `--<--' | duct finishes
136 "duct reading" means innduct is reading the file but also
137 overwriting processed tokens.
141 * rune for printing diagrams:
143 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
153 #include "oop-read.h"
156 #include <sys/types.h>
157 #include <sys/wait.h>
158 #include <sys/stat.h>
159 #include <sys/socket.h>
167 /*----- general definitions, probably best not changed -----*/
169 #define PERIOD_SECONDS 60
171 #define CONNCHILD_ESTATUS_STREAM 4
172 #define CONNCHILD_ESTATUS_NOSTREAM 5
174 #define INNDCOMMCHILD_ESTATUS_FAIL 6
175 #define INNDCOMMCHILD_ESTATUS_NONESUCH 7
177 typedef struct Conn Conn;
178 typedef struct Article Article;
180 /*----- configuration options -----*/
182 static char *sitename, *feedfile;
183 static const char *remote_host;
184 static int quiet_multiple=0, become_daemon=1;
186 static int max_connections=10, max_queue_per_conn=200;
188 static int connection_setup_timeout=200, port=119, try_stream=1;
189 static int inndcomm_flush_timeout=100;
190 static int reconnect_delay_periods, flushfail_retry_periods, open_wait_periods;
191 static int backlog_retry_minperiods, backlog_spontaneous_rescan_periods;
192 static const char *inndconffile;
194 static double accept_proportion;
195 static double nocheck_thresh_pct= 95.0;
196 static double nocheck_thresh; /* computed in main from _pct */
197 static double nocheck_decay_articles= 100; /* converted to _decay */
198 static double nocheck_decay; /* computed in main from _articles */
199 static int nocheck, nocheck_reported;
202 /*----- doubly linked lists -----*/
204 #define ISNODE(T) T *next, *back;
205 #define LIST(T) struct { T *head, *tail, *tailpred; int count; }
207 #define NODE(n) ((struct node*)&(n)->head)
209 #define LIST_ADDHEAD(l,n) \
210 (list_addhead((struct list*)&(l), NODE((n))), (void)(l).count++)
211 #define LIST_ADDTAIL(l,n) \
212 (list_addtail((struct list*)&(l), NODE((n))), (void)(l).count++)
214 #define LIST_REMHEAD(l) \
215 ((l).count ? ((l).count--, (void*)list_remhead((struct list*)&(l))) : 0)
216 #define LIST_REMTAIL(l) \
217 ((l).count ? ((l).count--, (void*)list_remtail((struct list*)&(l))) : 0)
218 #define LIST_REMOVE(l,n) \
219 (list_remove(NODE((n))), (void)(l).count--)
220 #define LIST_INSERT(l,n,pred) \
221 (list_insert((struct list*)&(l), NODE((n)), NODE((pred))), (void)(l).count++)
224 /*----- statistics -----*/
226 typedef enum { /* in queue in conn->sent */
227 art_Unchecked, /* not checked, not sent checking */
228 art_Wanted, /* checked, wanted sent body as requested */
229 art_Unsolicited, /* - sent body without check */
233 #define RESULT_COUNTS(RCS,RCN) \
241 #define RCI_TRIPLE_FMT_BASE "%d(id%d+bd%d+nc%d)"
242 #define RCI_TRIPLE_VALS_BASE(counts,x) \
243 , counts[art_Unchecked] x \
244 + counts[art_Wanted] x \
245 + counts[art_Unsolicited] x, \
246 counts[art_Unchecked] x \
247 , counts[art_Wanted] x \
248 , counts[art_Unsolicited] x
251 #define RC_INDEX(x) RCI_##x,
252 RESULT_COUNTS(RC_INDEX, RC_INDEX)
257 /*----- transmission buffers -----*/
262 xk_Malloc, xk_Const, xk_Artdata
274 /*----- core operational data structure types -----*/
276 typedef struct InputFile {
277 /* This is an instance of struct oop_readable */
278 struct oop_readable readable; /* first */
279 oop_readable_call *readable_callback;
280 void *readable_callback_user;
283 struct Filemon_Perfile *filemon;
286 long inprogress; /* no. of articles read but not processed */
289 int counts[art_MaxState][RCI_max];
303 #define SMS_LIST(X) \
312 #define SMS_DEF_ENUM(s) sm_##s,
313 SMS_LIST(SMS_DEF_ENUM)
316 static const char *sms_names[]= {
317 #define SMS_DEF_NAME(s) #s ,
318 SMS_LIST(SMS_DEF_NAME)
324 int fd, max_queue, stream;
325 LIST(Article) queue; /* not yet told peer, or CHECK said send it */
326 LIST(Article) sent; /* offered/transmitted - in xmit or waiting reply */
327 struct iovec xmit[CONNIOVS];
328 XmitDetails xmitd[CONNIOVS];
333 /*----- operational variables -----*/
335 static oop_source *loop;
338 static LIST(Conn) idle, working, full;
339 static LIST(Article) *queue;
341 static char *path_lock, *path_flushing, *path_defer;
343 #define SMS(newstate, periods, why) \
344 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
346 static StateMachineState sms;
348 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
349 static int sm_period_counter;
352 /*----- function predeclarations -----*/
354 static void conn_check_work(Conn *conn);
356 static int filemon_init(void);
357 static void filemon_setfile(int mainfeed_fd, const char *mainfeed_path);
358 static void filemon_callback(void);
360 static void statemc_setstate(StateMachineState newsms, int periods,
361 const char *forlog, const char *why);
363 /*========== logging ==========*/
365 static void logcore(int sysloglevel, const char *fmt, ...)
366 __attribute__((__format__(printf,2,3)));
367 static void logcore(int sysloglevel, const char *fmt, ...) {
371 vsyslog(sysloglevel,fmt,al);
373 vfprintf(stderr,fmt,al);
379 static void logv(int sysloglevel, const char *pfx, int errnoval,
380 int exitstatus, const char *fmt, va_list al)
381 __attribute__((__format__(printf,5,0)));
382 static void logv(int sysloglevel, const char *pfx, int errnoval,
383 int exitstatus, const char *fmt, va_list al) {
385 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
386 msgbuf[sizeof(msgbuf)-1]= 0;
388 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
389 sysloglevel= LOG_ERR; /* run by wrong user, probably */
391 logcore(sysloglevel, "<%s>%s: %s%s%s",
392 sitename, pfx, msgbuf,
393 errnoval>=0 ? ": " : "",
394 errnoval>=0 ? strerror(errnoval) : "");
397 #define logwrap(fn, pfx, sysloglevel, err, estatus) \
398 static void fn(const char *fmt, ...) \
399 __attribute__((__format__(printf,1,2))); \
400 static void fn(const char *fmt, ...) { \
403 logv(sysloglevel, pfx, err, estatus, fmt, al); \
406 logwrap(sysdie, " critical", LOG_CRIT, errno, 16);
407 logwrap(die, " critical", LOG_CRIT, -1, 16);
409 logwrap(sysfatal, " fatal", LOG_ERR, errno, 12);
410 logwrap(fatal, " fatal", LOG_ERR, -1, 12);
412 logwrap(syswarn, " warning", LOG_WARNING, errno, 0);
413 logwrap(warn, " warning", LOG_WARNING, -1, 0);
415 logwrap(notice, "", LOG_NOTICE, -1, 0);
416 logwrap(info, " info", LOG_INFO, -1, 0);
417 logwrap(debug, " debug", LOG_DEBUG, -1, 0);
420 /*========== utility functions etc. ==========*/
422 static void perhaps_close(int *fd) { if (*fd) { close(*fd); fd=0; } }
424 static void *xmalloc(size_t sz) {
428 sysdie("malloc (%ld bytes) failed", (unsigned long)sz);
431 static pid_t xfork(const char *what) {
435 if (child==-1) sysdie("cannot fork for %s",what);
436 if (!child) postfork(what);
437 debug("forked %s %ld", what, (unsigned long)child);
441 static void on_fd_read_except(int fd, oop_call_fd callback) {
442 loop->on_fd(loop, fd, OOP_READ, callback, 0);
443 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
445 static void cancel_fd_read_except(int fd) {
446 loop->cancel_fd(loop, fd, OOP_READ);
447 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
450 static void report_child_status(const char *what, int status) {
451 if (WIFEXITED(status)) {
452 int es= WEXITSTATUS(status);
454 warn("%s: child died with error exit status %d",es);
455 } else if (WIFSIGNALED(status)) {
456 int sig= WTERMSIG(status);
457 const char *sigstr= strsignal(sig);
458 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
460 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
462 warn("%s: child died due to unknown fatal signal %d%s",
463 what, sig, coredump);
465 warn("%s: child died with unknown wait status %d", status);
469 static int xwaitpid(pid_t *pid, const char *what) {
472 int r= kill(*pid, SIGKILL);
473 if (r) sysdie("cannot kill %s child", what);
475 pid_t got= waitpid(*pid, &status, WNOHANG);
476 if (got==-1) sysdie("cannot reap %s child", what);
483 static void xunlink(const char *path, const char *what) {
485 if (r) sysdie("can't unlink %s %s", path, what);
488 static void check_isreg(const struct stat *stab, const char *path,
490 if (!S_ISREG(stab->st_mode))
491 die("%s %s not a plain file (mode 0%lo)",
492 what, path, (unsigned long)stab->st_mode);
495 static void xfstat(int fd, struct stat *stab_r, const char *what) {
496 int r= fstab(fd, stab_r);
497 if (r) sysdie("could not fstat %s", what);
500 static void xfstat_isreg(int fd, struct stat *stab_r,
501 const char *path, const char *what) {
502 xfstat(fd, stab_r, what);
503 check_isreg(stab_r, path, what);
506 static void xlstat_isreg(const char *path, struct stat *stab,
507 int *enoent_r /* 0 means ENOENT is fatal */,
509 int r= lstat(path, stab);
511 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
512 sysdie("could not lstat %s %s", what, path);
514 if (enoent_r) *enoent_r= 0;
515 check_isreg(stab, path, what);
518 static int samefile(const struct stat *a, const struct stat *b) {
519 assert(S_ISREG(a->st_mode));
520 assert(S_ISREG(b->st_mode));
521 return (a->st_ino == b->st_ino &&
522 a->st_dev == b->st_dev);
525 /*========== making new connections ==========*/
527 static int connecting_sockets[2]= {-1,-1};
528 static pid_t connecting_child;
530 static void connect_attempt_discard(void) {
531 if (connecting_sockets[0])
532 cancel_fd(connecting_sockets[0]);
534 perhaps_close(&connecting_sockets[0]);
535 perhaps_close(&connecting_sockets[1]);
537 if (connecting_child) {
538 int r= kill(connecting_child, SIGTERM);
539 if (r) syswarn("failed to kill connecting child");
540 int status= xwaitpid(&connecting_child, "connect");
542 if (!(WIFEXITED(status) ||
543 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
544 report_child_status("connect", status);
548 #define PREP_DECL_MSG_CMSG(msg) \
550 memset(&msg,0,sizeof(msg)); \
551 char msg##cbuf[CMSG_SPACE(sizeof(fd))]; \
552 msg.msg_control= msg##cbuf; \
553 msg.msg_controllen= sizeof(msg##cbuf);
555 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
558 conn= xmalloc(sizeof(*conn));
559 memset(conn,0,sizeof(*conn));
561 PREP_DECL_MSG_CMSG(msg);
562 struct cmsghdr *h= 0;
563 ssize_t rs= recvmsg(fd, &msg, MSG_DONTWAIT);
564 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
567 pid_t got= waitpid(connecting_child, &status, WNOHANG);
569 assert(got==connecting_child);
571 if (WIFEXITED(status) &&
572 (WEXITSTATUS(status) != 0
573 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
574 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)) {
575 /* child already reported the problem */
576 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALARM) {
577 warn("connect: connection attempt timed out");
578 } else if (!WIFEXITED(status)) {
579 report_child_status("connect", status);
580 /* that's probably the root cause then */
583 /* child is still running apparently, report the socket problem */
585 syswarn("connect: read from child socket failed");
586 else if (e == OOP_EXCEPTIONN)
587 warn("connect: unexpected exception on child socket");
589 warn("connect: unexpected EOF on child socket");
594 #define CHK(field, val) \
595 if (h->cmsg_##field != val) { \
596 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d"); \
599 CHK(level, SOL_SOCKET);
600 CHK(type, SCM_RIGHTS);
601 CHK(len, CMSG_LEN(sizeof(conn-b>fd)));
604 if (CMSG_NXTHDR,&msg,h) { die("connect: child sent many cmsgs"); goto x; }
606 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
608 pid_t got= waitpid(connecting_child, &status, 0);
609 if (got==-1) sysdie("connect: real wait for child");
610 assert(got == connecting_child);
613 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
614 int es= WEXITSTATUS(status);
616 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
617 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
619 fatal("connect: child gave unexpected exit status %d", es);
625 LIST_ADDHEAD(idle, conn);
626 notice("#%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
627 connect_attempt_discard();
628 check_master_queue();
633 perhaps_close(&conn->fd);
636 connect_attempt_discard();
639 static void connect_start(void) {
640 assert(!connecting_sockets[0]);
641 assert(!connecting_sockets[1]);
642 assert(!connecting_child);
644 notice("starting connection attempt");
646 r= socketpair(AF_UNIX, SOCK_STREAM, 0, connecting_sockets);
647 if (r) { syswarn("connect: cannot create socketpair for child"); goto x; }
649 connecting_child= xfork("connection");
651 if (!connecting_child) {
652 FILE *cn_from, *cn_to;
653 char buf[NNTP_STRLEN+100];
654 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
656 r= close(connecting_sockets[0]);
657 if (r) sysdie("connect: close parent socket in child");
659 alarm(connection_setup_timeout);
660 if (NNTPconnect(remote_host, port, &cn_from, &cn_to, buf) < 0) {
662 sanitise_inplace(buf);
663 fatal("connect: rejected: %s", buf);
665 sysfatal("connect: connection attempt failed");
668 if (NNTPsendpassword(remote_host, cn_from, cn_to) < 0)
669 sysfatal("connect: authentication failed");
671 if (fputs("MODE STREAM\r\n", cn_to) ||
673 sysfatal("connect: could not send MODE STREAM");
674 buf[sizeof(buf)-1]= 0;
675 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
677 sysfatal("connect: could not read response to MODE STREAM");
679 fatal("connect: connection close in response to MODE STREAM");
684 sanitise_inplace(buf);
685 fatal("connect: response to MODE STREAM is too long: %.100s...",
688 l--; if (l>0 && buf[1-]=='\r') l--;
691 int rcode= strtoul(buf,&ep,10);
693 sanitise_inplace(buf);
694 fatal("connect: bad response to MODE STREAM: %.50s", buf);
698 exitstatus= CONNCHILD_ESTATUS_STREAM;
704 sanitise_inplace(buf);
705 warn("connect: unexpected response to MODE STREAM: %.50s", buf);
710 int fd= fileno(cn_from);
712 PREP_DECL_MSG_CMSG(msg);
713 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
714 cmsg->cmsg_level= SOL_SOCKET;
715 cmsg->cmsg_type= SCM_RIGHTS;
716 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
717 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
719 msg.msg_controllen= cmsg->cmsg_len;
720 r= sendmsg(connecting_sockets[1], &msg, 0);
721 if (r) sysdie("sendmsg failed for new connection");
726 r= close(connecting_sockets[1]); connecting_sockets[1]= 0;
727 if (r) sysdie("connect: close child socket in parent");
729 on_fd_read_except(connecting_sockets[0], connchild_event);
733 connect_attempt_discard();
737 /*========== overall control of article flow ==========*/
739 static void check_master_queue(void) {
743 Conn *last_assigned=0;
746 conn_assign_one_article(&working, &last_assigned);
747 } else if (idle.head) {
748 conn_assign_one_article(&idle, &last_assigned);
749 } else if (nconns < maxconns && queue.count >= max_queue_per_conn &&
750 !connecting_child && !connect_delay) {
751 connect_delay= reconnect_delay_periods;
757 conn_check_work(last_assigned);
760 static void conn_assign_one_article(LIST(Conn) *connlist,
761 Conn **last_assigned) {
762 Conn *conn= connlist->head;
764 LIST_REMOVE(*connlist, conn);
765 Article *art= LIST_REMHEAD(queue);
766 LIST_ADDTAIL(conn->queue, art);
767 LIST_ADD(*conn_determine_right_list(conn), conn);
769 /* This slightly odd arrangement is so that we call conn_check_work
770 * once after filling the queue for a new connection in
771 * check_master_queue, rather than for each article. */
772 if (conn != *last_assigned && *last_assigned)
773 conn_check_work(*last_assigned);
774 *last_assigned= conn;
777 static int conn_total_queued_articles(Conn *conn) {
778 return conn->sent.count + conn->queue.count;
781 static LIST(Conn) *conn_determine_right_list(Conn *conn) {
782 int inqueue= conn_total_queued_articles(conn);
783 assert(inqueue <= max_queue);
784 if (inqueue == 0) return &idle;
785 if (inqueue == conn->max_queue) return &full;
789 static void *conn_writeable(oop_source *l, int fd, int ev, void *u) {
794 static void conn_check_work(Conn *conn) {
797 conn_make_some_xmits(conn);
799 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
803 void *rp= conn_write_some_xmits(conn);
804 if (rp==OOP_CONTINUE) {
805 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
807 } else if (rp==OOP_HALT) {
810 /* transmitted everything */
817 static void vconnfail(Conn *conn, const char *fmt, va_list al)
818 __attribute__((printf,2,0));
820 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
821 int requeue[art_MaxState];
824 while ((art= LIST_REMHEAD(conn->queue))) LIST_ADDTAIL(queue);
825 while ((art= LIST_REMHEAD(conn->sent))) {
826 counts[art->state]++;
827 if (art->state==art_Unsolicited) art->state= art_Unchecked;
833 for (i=0, dp=&conn->xmitd; i<conn->xmitu; i++, dp++)
836 char *m= xvasprintf(fmt,al);
837 warn("#%d connection failed, requeueing " RCI_TRIPLE_FMT_BASE ": %s",
838 conn->fd, RCI_TRIPLE_FMT_VALS(requeue, /*nothing*/), m);
844 connect_delay= reconnect_delay_periods;
845 check_master_queue();
848 static void connfail(Connection *conn, const char *fmt, ...)
849 __attribute__((printf,2,3));
850 static void connfail(Connection *conn, const char *fmt, ...) {
857 /*========== article transmission ==========*/
859 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
860 XmitKind kind) { /* caller must then fill in details */
861 struct iovec *v= &conn->xmit[conn->xmitu];
862 XmitDetails *d= &conn->xmitd[conn->xmitu++];
869 static void xmit_noalloc(Conn *conn, const char *data, int len) {
870 xmit_core(conn,data,len, xk_Const);
872 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
874 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
875 XmitDetails *d= xmit_core(conn, ah->data, ah->len, sk_Artdata);
879 static void xmit_free(XmitDetails *d) {
881 case xk_Malloc: free(d->info.malloc_tofree); break;
882 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
883 case xk_Const: break;
888 static void *conn_write_some_xmits(Conn *conn) {
890 * 0: nothing more to write, no need to call us again
891 * OOP_CONTINUE: more to write but fd not writeable
892 * OOP_HALT: disaster, have destroyed conn
895 int count= conn->xmitu;
896 if (!count) return 0;
898 if (count > IOV_MAX) count= IOV_MAX;
899 ssize_t rs= writev(conn->fd, conn->xmit, count);
901 if (errno == EAGAIN) return OOP_CONTINUE;
902 connfail(conn, "write failed: %s", strerror(errno));
907 for (done=0; rs && done<xmitu; done++) {
908 struct iovec *vp= &conn->xmit[done];
909 XmitDetails *dp= &conn->xmitd[done];
910 if (rs > vp->iov_len) {
918 int newu= conn->xmitu - done;
919 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
920 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
925 static void conn_make_some_xmits(Conn *conn) {
927 if (conn->xmitu+5 > CONNIOVS)
930 Article *art= LIST_REMHEAD(queue);
933 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
934 /* actually send it */
936 ARTHANDLE *artdata= SMretrieve();
940 XMIT_LITERAL("TAKETHIS ");
941 xmit_noalloc(conn, art->mid, art->midlen);
942 XMIT_LITERAL("\r\n");
943 xmit_artbody(conn, artdata);
946 /* we got 235 from IHAVE */
948 xmit_artbody(conn, artdata);
950 XMIT_LITERAL(".\r\n");
955 art->state == art_Unchecked ? art_Unsolicited :
956 art->state == art_Wanted ? art_Wanted :
958 art->ipf->counts[art->state].sent++;
959 LIST_ADDTAIL(conn->sent, art);
965 XMIT_LITERAL("IHAVE ");
967 XMIT_LITERAL("CHECK ");
968 xmit_noalloc(art->mid, art->midlen);
969 XMIT_LITERAL("\r\n");
971 assert(art->state == art_Unchecked);
972 art->ipf->counts[art->state].sent++;
973 LIST_ADDTAIL(conn->sent, art);
979 /*========== handling responses from peer ==========*/
981 static const oop_rd_style peer_rd_style= {
982 OOP_RD_DELIM_STRIP, '\n',
984 OOP_RD_SHORTREC_FORBID
987 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_event ev,
988 const char *errmsg, int errnoval,
989 const char *data, size_t recsz, void *conn_v) {
991 connfail(conn, "error receiving from peer: %s", errmsg);
995 static Article *article_reply_check(Connection *conn, const char *response,
996 int code_indicates_streaming,
998 /* 1:yes, -1:no, 0:dontcare */,
999 const char *sanitised_response) {
1000 Article *art= conn->sent.head;
1004 "peer gave unexpected response when no commands outstanding: %s",
1005 sanitised_response);
1009 if (code_indicates_streaming) {
1010 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1011 if (!conn->stream) {
1012 connfail("peer gave streaming response code "
1013 " to IHAVE or subsequent body: %s", sanitised_response);
1016 const char *got_mid= response+4;
1017 int got_midlen= strcspn(got_mid, " \n\r");
1018 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1019 connfail("peer gave streaming response with syntactically invalid"
1020 " messageid: %s", sanitised_response);
1023 if (got_midlen != art->midlen ||
1024 memcmp(got_mid, art->messageid, got_midlen)) {
1025 connfail("peer gave streaming response code to wrong article -"
1026 " probable synchronisation problem; we offered: %s;"
1028 art->messageid, sanitised_response);
1033 connfail("peer gave non-streaming response code to CHECK/TAKETHIS: %s",
1034 sanitised_response);
1039 if (must_have_sent>0 && art->state < art_Wanted) {
1040 connfail("peer says article accepted but we had not sent the body: %s",
1041 sanitised_response);
1044 if (must_have_sent<0 && art->state >= art_Wanted) {
1045 connfail("peer says please sent the article but we just did: %s",
1046 sanitised_response);
1050 Article *art_again= LIST_REMHEAD(conn->sent);
1051 assert(art_again == art);
1055 static void update_nocheck(int accepted) {
1056 accept_proportion *= accept_decay;
1057 accept_proportion += accepted;
1058 int new_nocheck= accept_proportion >= nocheck_thresh;
1059 if (new_nocheck && !nocheck_reported) {
1060 notice("entering nocheck mode for the first time");
1061 nocheck_reported= 1;
1062 } else if (new_nocheck != nocheck) {
1063 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1065 nocheck= new_nocheck;
1068 static void article_done(Connection *conn, Article *art, int whichcount) {
1069 art->ipf->counts[art->state][whichcount]++;
1070 if (whichcount == RC_accepted) update_nocheck(1);
1071 else if (whichcount == RC_unwanted) update_nocheck(0);
1073 InputFile *ipf= art->ipf;
1074 while (art->blanklen) {
1075 static const char spaces[]=
1080 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1081 int r= pwrite(ipf->fd, spaces, w, art->offset);
1083 if (errno==EINTR) continue;
1084 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1085 art->messageid, art->blanklen, art->offset, ipf->path);
1087 assert(r>=0 && r<=w);
1093 assert(ipf->inprogress >= 0);
1095 if (!ipf->inprogress && ipf != main_input_file)
1096 queue_check_input_done();
1101 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_event ev,
1102 const char *errmsg, int errnoval,
1103 const char *data, size_t recsz, void *conn_v) {
1106 if (ev == OOP_RD_EOF) {
1107 connfail(conn, "unexpected EOF from peer");
1108 return OOP_CONTINUE;
1110 assert(ev == OOP_RD_OK);
1113 unsigned long code= strtoul(data, &ep, 10);
1114 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1116 const char *p= data;
1120 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"..."); break; }
1122 if (!c) { *q++= '\''; break; }
1123 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
1124 sprintf(q,"\\x%02x",c);
1127 connfail(conn, "badly formatted response from peer: %s", sanibuf);
1128 return OOP_CONTINUE;
1131 if (conn->quitting) {
1133 connfail(conn, "peer gave failure response to QUIT: %s", sani);
1134 return OOP_CONTINUE;
1142 #define GET_ARTICLE(musthavesent) \
1143 art= article_reply_check(conn, data, musthavesent, code_streaming, sani); \
1144 if (art) ; else return OOP_CONTINUE /* reply_check has failed the conn */
1146 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) \
1147 code_streaming= (streaming) \
1148 GET_ARTICLE(musthavesent); \
1149 article_done(conn, art, RC_##how); break;
1151 #define PEERBADMSG(m) connfail(conn, m ": %s", sani); return OOP_CONTINUE
1153 int code_streaming= 0;
1157 case 400: PEERBADMSG("peer stopped accepting articles");
1158 case 503: PEERBADMSG("peer timed us out");
1159 default: PEERBADMSG("peer sent unexpected message");
1161 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1162 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1164 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1165 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1167 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1168 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1170 case 238: /* CHECK says send it */
1172 case 335: /* IHAVE says send it */
1174 assert(art->state == art_Unchecked);
1175 art->ipf->counts[art->state].accepted++;
1176 art->state= art_Wanted;
1177 LIST_ADDTAIL(conn->queue);
1180 case 431: /* CHECK or TAKETHIS says try later */
1182 case 436: /* IHAVE says try later */
1185 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1187 sysfatal("write to defer file %s",path_defer);
1188 article_done(conn, art, RC_deferred);
1193 check_check_work(conn);
1194 return OOP_CONTINUE;
1198 /*========== monitoring of input files ==========*/
1200 static void feedfile_eof(InputFile *ipf) {
1201 assert(ipf != main_input_file); /* promised by tailing_try_read */
1203 inputfile_tailing_stop(ipf);
1204 assert(ipf->fd >= 0);
1205 if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
1208 if (ipf == flushing_input_file) {
1209 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1210 if (main_input_file) inputfile_tailing_start(main_input_file);
1211 statemc_check_flushing_done();
1212 } else if (ipf == backlog_input_file) {
1213 statemc_check_backlog_done();
1215 abort(); /* supposed to wait rather than get EOF on main input file */
1219 static InputFile *open_input_file(const char *path) {
1220 int fd= open(path, O_RDONLY);
1222 if (errno==ENOENT) return 0;
1223 sysfatal("unable to open input file %s", path);
1226 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
1227 memset(ipf,0,sizeof(*ipf));
1229 ipf->readable.on_readable= tailing_on_readable;
1230 ipf->readable.on_cancel= tailing_on_cancel;
1231 ipf->readable.try_read= tailing_try_read;
1234 strcpy(ipf->path, path);
1239 static void close_input_file(InputFile *ipf) {
1240 assert(!ipf->readable_callback); /* must have had ->on_cancel */
1241 assert(!ipf->filemon); /* must have had inputfile_tailing_stop */
1242 assert(!ipf->rd); /* must have had inputfile_tailing_stop */
1243 assert(!ipf->inprogress); /* no dangling pointers pointing here */
1246 if (close(ipf->fd)) sysdie("could not close input file %s", ipf->path);
1250 /*---------- dealing with articles read in the input file ----------*/
1252 typedef void *feedfile_got_article(oop_source *lp, oop_read *rd,
1253 oop_rd_event ev, const char *errmsg,
1255 const char *data, size_t recsz,
1257 InputFile *ipf= ipf_v;
1259 char tokentextbuf[sizeof(TOKEN)*2+3];
1261 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
1263 if (data[0] && data[0]!=' ') {
1264 char *space= strchr(data,' ');
1265 int tokenlen= space-data;
1266 int midlen= (int)recsz-tokenlen-1;
1267 if (midlen < 0) goto bad_data;
1269 if (tokenlen != sizeof(TOKEN)*2+2) goto bad_data;
1270 memcpy(tokentextbuf, data, tokenlen);
1271 tokentextbuf[tokenlen]= 0;
1272 if (!IsToken(tokentextbuf)) goto bad_data;
1274 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
1275 art->offset= ipf->offset;
1276 art->blanklen= recsz;
1277 art->midlen= midlen;
1278 art->state= art_Unchecked;
1279 art->ipf= ipf; ipf->inprogress++;
1280 art->token= TextToToken(tokentextbuf);
1281 strcpy(art->messageid, space+1);
1282 LIST_ADDTAIL(queue, art);
1284 ipf->offset += recsz + 1;
1286 if (sms==sm_NORMAL && ipf==main_input_file &&
1287 ipf->offset >= flush_threshold)
1288 statemc_start_flush("feed file size");
1290 check_master_queue();
1293 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
1294 assert(sms == sm_NORMAL);
1296 debug("starting flush (%s) (%lu >= %lu) (%d)",
1298 (unsigned long)ipf->offset, (unsigned long)flush_threshold,
1301 int r= link(feedfile, duct_path);
1302 if (r) sysdie("link feedfile %s to flushing file %s", feedfile,
1306 xunlink(feedfile, "old feedfile link");
1309 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
1312 /*========== tailing input file ==========*/
1314 static void filemon_start(InputFile *ipf) {
1315 assert(!ipf->filemon);
1317 ipf->filemon= xmalloc(sizeof(*ipf->filemon));
1318 memset(ipf->filemon, 0, sizeof(*ipf->filemon));
1319 filemon_method_startfile(ipf, ipf->filemon);
1322 static void filemon_stop(InputFile *ipf) {
1323 if (!ipf->filemon) return;
1324 filemon_method_stopfile(ipf, ipf->filemon);
1329 static void filemon_callback(InputFile *ipf) {
1330 ipf->readable_callback(ipf->readable_callback_user);
1333 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
1335 InputFile *ipf= user;
1336 return ipf->readable_callback(ipf->readable_callback_user);
1339 static void on_cancel(struct oop_readable *rable) {
1340 InputFile *ipf= (void*)rable;
1342 if (ipf->filemon) filemon_stopfile(ipf);
1343 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1344 ipf->readable_callback= 0;
1347 static void tailing_queue_readable(InputFile *ipf) {
1348 /* lifetime of ipf here is OK because destruction will cause
1349 * on_cancel which will cancel this callback */
1350 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1353 static int tailing_on_readable(struct oop_readable *rable,
1354 oop_readable_call *cb, void *user) {
1355 InputFile *ipf= (void*)rable;
1357 tailing_on_cancel(rable);
1358 ipf->readable_callback= cb;
1359 ipf->readable_callback_user= user;
1360 filemon_startfile(ipf);
1362 tailing_queue_readable(ipf);
1366 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
1368 InputFile *ipf= (void*)rable;
1370 ssize_t r= read(ipf->fd, buffer, length);
1372 if (errno==EINTR) continue;
1376 if (ipf==main_input_file) {
1379 } else if (ipf==flushing_input_file) {
1381 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1382 } else if (ipf==backlog_input_file) {
1392 /*---------- filemon implemented with inotify ----------*/
1394 #if defined(HAVE_INOTIFY) && !defined(HAVE_FILEMON)
1395 #define HAVE_FILEMON
1397 #include <linux/inotify.h>
1399 static int filemon_inotify_fd;
1400 static int filemon_inotify_wdmax;
1401 static InputFile **filemon_inotify_wd2ipf;
1403 typedef struct Filemon_Perfile {
1405 } Filemon_Inotify_Perfile;
1407 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
1408 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
1409 if (wd < 0) sysdie("inotify_add_watch %s", ipf->path);
1411 if (wd >= filemon_inotify_wdmax) {
1413 filemon_inotify_wd= xrealloc(filemon_inotify_wd2ipf,
1414 sizeof(*filemon_inotify_wd2ipf) * newmax);
1415 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
1416 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
1417 filemon_inotify_wdmax= newmax;
1420 assert(!filemon_inotify_wd2ipf[wd]);
1421 filemon_inotify_wd2ipf[wd]= ipf;
1423 debug("filemon inotify startfile %p wd=%d wdmax=%d",
1424 ipf, wd, filemon_inotify_wdmax);
1429 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
1431 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
1432 int r= inotify_rm_watch(filemon_inotify_fd, filemon_inotify_wd);
1433 if (r) sysdie("inotify_rm_watch");
1434 filemon_inotify_wd2ipf[wd]= 0;
1437 static void *filemon_inotify_readable(oop_source *lp, int fd,
1438 oop_event e, void *u) {
1439 struct inotify_event iev;
1441 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
1443 if (errno==EAGAIN) break;
1444 sysdie("read from inotify master");
1445 } else if (r==sizeof(iev)) {
1446 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
1448 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
1450 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
1451 debug("filemon inotify readable read %p wd=%p", iev.wd, ipf);
1452 filemon_callback(ipf);
1454 return OOP_CONTINUE;
1457 static int filemon_method_init(void) {
1458 filemon_inotify_fd= inotify_init();
1459 if (filemon_inotify_fd<0) {
1460 syswarn("could not initialise inotify: inotify_init failed");
1464 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable);
1466 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
1470 #endif /* HAVE_INOTIFY && !HAVE_FILEMON *//
1472 /*---------- filemon dummy implementation ----------*/
1474 #if !defined(HAVE_FILEMON)
1476 typedef struct Filemon_Perfile { int dummy; } Filemon_Dummy_Perfile;
1478 static int filemon_method_init(void) { return 0; }
1479 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
1480 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
1482 #endif /* !HAVE_FILEMON */
1484 /*---------- interface to start and stop an input file ----------*/
1486 static const oop_rd_style feedfile_rdstyle= {
1487 OOP_RD_DELIM_STRIP, '\n',
1489 OOP_RD_SHORTREC_EOF,
1492 static void inputfile_tailing_start(InputFile *ipf) {
1494 ipf->readable->on_readable= tailing_on_readable;
1495 ipf->readable->on_cancel= tailing_on_cancel;
1496 ipf->readable->try_read= tailing_try_read;
1497 ipf->readable->delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
1498 ipf->readable->delete_kill= 0;
1500 ipf->readable_callback= 0;
1501 ipf->readable_callback_user= 0;
1503 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
1506 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
1507 feedfile_got_article,ipf, feedfile_problem,ipf);
1508 if (r) sysdie("unable start reading feedfile %s",ipf->path);
1511 static void inputfile_tailing_stop(InputFile *ipf) {
1513 oop_rd_cancel(ipf->rd);
1514 oop_rd_delete(ipf->rd);
1516 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
1520 /*========== interaction with innd - state machine ==========*/
1522 /* See official state diagram at top of file. We implement
1533 |`---------------------------------------------------.
1535 |`---------------- - - - |
1536 D ENOENT | D EXISTS see OVERALL STATES diagram |
1537 | for full startup logic |
1540 | ============ try to |
1546 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
1547 ^ | hardlink F to D |
1550 | | our handle onto F is now onto D |
1553 | |<-------------------<---------------------<---------+
1555 | | spawn inndcomm flush |
1557 | ================== |
1558 | FLUSHING[-ABSENT] |
1560 | main D tail/none |
1561 | ================== |
1563 | | INNDCOMM FLUSH FAILS ^
1564 | |`----------------------->----------. |
1566 | | NO SUCH SITE V |
1567 ^ |`--------------->----. ==================== |
1568 | | \ FLUSHFAILED[-ABSENT] |
1570 | | FLUSH OK \ main D tail/none |
1571 | | open F \ ==================== |
1573 | | \ | TIME TO RETRY |
1574 | |`------->----. ,---<---'\ `----------------'
1575 | | D NONE | | D NONE `----.
1577 | ============= V V ============
1578 | SEPARATED-1 | | DROPPING-1
1579 | flsh->fd>=0 | | flsh->fd>=0
1580 | [Separated] | | [Dropping]
1581 | main F idle | | main none
1582 | old D tail | | old D tail
1583 | ============= | | ============
1585 ^ | EOF ON D | | defer | EOF ON D
1587 | =============== | | ===============
1588 | SEPARATED-2 | | DROPPING-2
1589 | flsh->fd==-1 | V flsh->fd==-1
1590 | [Finishing] | | [Dropping]
1591 | main F tail | `. main none
1592 | old D closed | `. old D closed
1593 | =============== V `. ===============
1595 | | ALL D PROCESSED `. | ALL D PROCESSED
1596 | V install defer as backlog `. | install defer
1597 ^ | close D `. | close D
1598 | | unlink D `. | unlink D
1601 `----------' ==============
1621 static void statemc_init(void) {
1622 struct stat stab, stabf;
1624 path_lock= xasprintf("%s_lock", feedfile);
1625 path_flushing= xasprintf("%s_flushing", feedfile);
1626 path_defer= xasprintf("%s_defer", feedfile);
1627 globpat_backlog= xasprintf("%s_backlog*", feedfile);
1630 int lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
1631 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
1634 memset(&fl,0,sizeof(fl));
1636 fl.l_whence= SEEK_SET;
1637 r= fcntl(lockfd, F_SETLK, &fl);
1639 if (errno==EACCES || errno==EAGAIN) {
1640 if (quiet_multiple) exit(0);
1641 fatal("another duct holds the lockfile");
1643 sysdie("fcntl F_SETLK lockfile %s", path_lock);
1646 xfstat_isreg(lockfd, &stabf, "lockfile");
1648 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
1650 if (!lock_noent && samefile(&stab, &stabf))
1654 sysdie("could not close stale lockfile %s", path_lock);
1656 debug("startup: locked");
1658 search_backlog_file();
1661 xlstat_isreg(path_defer, &stab, &defer_noent, "defer file");
1663 debug("startup: ductdefer ENOENT");
1665 debug("startup: ductdefer nlink=%ld", (long)stab.st_nlink);
1666 switch (stab.st_nlink==1) {
1668 open_defer(); /* so that we will later close it and rename it */
1671 xunlink(path_defer, "stale defer file link"
1672 " (presumably hardlink to backlog file)");
1675 die("defer file %s has unexpected link count %d",
1676 path_defer, stab.st_nlink);
1680 struct stat stab_f, stab_d;
1683 InputFile *file_d= open_input_file(path_flushing);
1684 if (file_d) xfstat_isreg(file_d->fd, &stab_d, "flushing file");
1686 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
1688 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
1689 debug("startup: F==D => Hardlinked");
1690 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
1695 debug("startup: F ENOENT => Moved");
1696 if (file_d) startup_set_input_file(file_d);
1697 spawn_inndcomm_flush("feedfile missing at startup");
1698 /* => Flushing, sms:=FLUSHING */
1701 debug("startup: F!=D => Separated");
1702 startup_set_input_file(file_d);
1703 SMS(SEPARATED, 0, "found both old and current feed files");
1705 debug("startup: F exists, D ENOENT => Normal");
1706 FILE *file_f= open_input_file(feedfile);
1707 if (!file_f) die("feed file vanished during startup");
1708 startup_set_input_file(file_f);
1709 SMS(NORMAL, flushfail_retry_periods, "normal startup");
1714 static void statemc_period_poll(void) {
1715 if (!sm_period_counter) return;
1716 sm_period_counter--;
1717 assert(sm_period_counter>=0);
1719 if (sm_period_counter) return;
1722 statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
1724 case sm_FLUSHFAILED:
1725 spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
1732 static void startup_set_input_file(InputFile *f) {
1733 assert(!main_input_file);
1735 inputfile_tailing_start(f);
1738 static int inputfile_is_done(InputFile *ipf) {
1740 if (ipf->inprogress) return 0; /* new article in the meantime */
1741 if (ipf->fd >= 0); return 0; /* not had EOF */
1745 static void notice_processed(InputFile *ipf, const char *what,
1747 #define RCI_NOTHING(x) /* nothing */
1748 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
1749 #define RCI_TRIPLE_VALS(x) RCI_TRIPLE_VALS_BASE(ipf->counts, .x)
1751 info("processed %s%s offered=%d(ch%d,nc%d) accepted=%d(ch%d+nc%d)"
1752 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
1755 ipf->counts[art_Unchecked].sent + ipf->counts[art_Unsolicited].sent
1756 , ipf->counts[art_Unchecked].sent, ipf->counts[art_Unsolicited].sent,
1757 ipf->counts[art_Wanted].accepted + ipf->counts[art_Unsolicited].accepted
1758 ,ipf->counts[art_Wanted].accepted,ipf->counts[art_Unsolicited].accepted
1759 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
1763 static void statemc_check_backlog_done(void) {
1764 InputFile *ipf= backlog_input_file();
1765 if (!inputfile_is_done(ipf)) return;
1767 const char *slash= strrchr(ipf->path, "/");
1768 const char *leaf= slash ? slash+1 : ipf->path;
1769 const char *under= strchr(slash, "_");
1770 const char *rest= under ? under+1 : leaf;
1771 if (!strncmp(rest,"backlog",7)) rest += 7;
1772 notice_processed(ipf,"backlog:",rest);
1774 close_input_file(ipf);
1775 if (unlink(ipf->path)) {
1776 if (errno != ENOENT)
1777 sysdie("could not unlink processed backlog file %s", ipf->path);
1778 warn("backlog file %s vanished while we were reading it"
1779 " so we couldn't remove it (but it's done now, anyway)",
1783 backlog_input_file= 0;
1784 search_backlog_file();
1788 static void statemc_check_flushing_done(void) {
1789 InputFile *ipf= flushing_input_file;
1790 if (!inputfile_is_done(ipf)) return;
1792 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1794 notice_processed(ipf,"feedfile",0);
1798 xunlink(path_flushing, "old flushing file");
1800 close_input_file(flushing_input_file);
1801 free(flushing_input_file);
1802 flushing_input_file= 0;
1804 if (sms==sm_SEPARATED) {
1805 notice("flush complete");
1806 SMS(NORMAL, 0, "flush complete");
1807 } else if (sms==sm_DROPPING) {
1808 SMS(DROPPED, 0, "old flush complete");
1809 search_backlog_file();
1810 notice("feed dropped, but will continue until backlog is finished");
1814 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
1816 assert(!inputfile_is_done(main_input_file));
1817 statemc_check_flushing_done();
1818 statemc_check_backlog_done();
1819 return OOP_CONTINUE;
1822 static void queue_check_input_done(void) {
1823 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
1826 static void statemc_setstate(StateMachineState newsms, int periods,
1827 const char *forlog, const char *why) {
1829 sm_period_counter= periods;
1831 const char *xtra= "";
1833 case sm_FLUSHING: sm_FLUSHFAILED:
1834 if (!main_input_file) xtra= "-ABSENT";
1836 case sm_SEPARATED: case sm_DROPPING:
1837 xtra= flushing_input_file->fd >= 0 ? "-1" : "-2";
1843 info("%s%s[%d] %s",forlog,xtra,periods,why);
1845 info("%s%s %s",forlog,xtra,why);
1849 /*---------- defer and backlog files ----------*/
1851 static void open_defer(void) {
1856 defer= fopen(path_defer, "a+");
1857 if (!defer) sysfatal("could not open defer file %s", path_defer);
1859 /* truncate away any half-written records */
1861 xfstat_isreg(fileno(defer), &stab, "newly opened defer file");
1863 if (stab.st_size > LONG_MAX)
1864 die("defer file %s size is far too large", path_defer);
1869 long orgsize= stab.st_size;
1870 long truncto= stab.st_size;
1872 if (!truncto) break; /* was only (if anything) one half-truncated record */
1873 if (fseek(defer, truncto-1, SEEK_SET) < 0)
1874 sysdie("seek in defer file %s while truncating partial", path_defer);
1879 sysdie("failed read from defer file %s", path_defer);
1881 die("defer file %s shrank while we were checking it!", path_defer);
1887 if (stab.st_size != truncto) {
1888 warn("truncating half-record at end of defer file %s -"
1889 " shrinking by %ld bytes from %ld to %ld",
1890 path_defer, orgsize - truncto, orgsize, truncto);
1893 sysfatal("could not flush defer file %s", path_defer);
1894 if (ftruncate(fileno(defer), truncto))
1895 sysdie("could not truncate defer file %s", path_defer);
1898 info("continuing existing defer file %s (%ld bytes)",
1899 path_defer, orgsize);
1901 if (fseek(defer, truncto, SEEK_SET))
1902 sysdie("could not seek to new end of defer file %s", path_defer);
1905 static void close_defer(void) {
1909 xfstat(fileno(defer), &stab, "defer file");
1911 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
1914 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
1915 (unsigned long)now.tv_sec,
1916 (unsigned long)stab.st_ino);
1917 if (link(path_defer, path_backlog))
1918 sysfatal("could not install defer file %s as backlog file %s",
1919 path_defer, backlog);
1920 if (unlink(path_defer))
1921 sysdie("could not unlink old defer link %s to backlog file %s",
1922 path_defer, backlog);
1924 if (until_backlog_nextscan < 0 ||
1925 until_backlog_nextscan > backlog_retry_minperiods + 1)
1926 until_backlog_nextscan= backlog_retry_minperiods + 1;
1929 static void poll_backlog_file(void) {
1930 if (until_backlog_nextscan < 0) return;
1931 if (until_backlog_nextscan-- > 0) return;
1932 search_backlog_file();
1935 static void search_backlog_file(void) {
1936 /* returns non-0 iff there are any backlog files */
1941 const char *oldest_path=0;
1942 time_t oldest_mtime, now;
1944 if (backlog_input_file) return 3;
1948 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
1952 sysdie("failed to expand backlog pattern %s", globpat_backlog);
1954 die("out of memory expanding backlog pattern %s", globpat_backlog);
1956 for (i=0; i<gl.gl_pathc; i++) {
1957 const char *path= gl.gl_pathv[i];
1959 if (strchr(path,'#') || strchr(path,'~')) {
1960 debug("backlog file search skipping %s", path);
1963 r= stat(path, &stab);
1965 syswarn("failed to stat backlog file %s", path);
1968 if (!S_ISREG(stab.st_mode)) {
1969 warn("backlog file %s is not a plain file (or link to one)", path);
1972 if (!oldest_path || stab.st_mtime < oldest_mtime) {
1974 oldest_mtime= stab.st_mtime;
1977 case GLOB_NOMATCH: /* fall through */
1980 sysdie("glob expansion of backlog pattern %s gave unexpected"
1981 " nonzero (error?) return value %d", globpat_backlog, r);
1987 debug("backlog scan: none");
1989 if (sms==sm_DROPPED) {
1990 notice("feed dropped and our work is complete");
1991 xunlink(path_lock, "lockfile for old feed");
1994 until_backlog_nextscan= backlog_spontaneous_rescan_periods;
1998 now= time(); if (now==-1) sysdie("time(2) failed");
1999 double age= difftime(now, oldest_mtime);
2000 long age_deficiency= (backlog_retry_minperiods * PERIOD_SECONDS) - age;
2002 if (age_deficiency <= 0) {
2003 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2004 age, age_deficiency, oldest_path);
2006 backlog_input_file= open_input_file(oldest_path);
2007 if (!backlog_input_file) {
2008 warn("backlog file %s vanished as we opened it", backlog_input_file);
2011 inputfile_tailing_start(backlog_input_file);
2012 until_backlog_nextscan= -1;
2016 until_backlog_nextscan= age_deficiency / PERIOD_SECONDS;
2018 if (backlog_spontaneous_rescan_periods >= 0 &&
2019 until_backlog_nextscan > backlog_spontaneous_rescan_periods)
2020 until_backlog_nextscan= backlog_spontaneous_rescan_periods;
2022 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2023 age, age_deficiency, until_backlog_nextscan, oldest_path);
2027 /*========== flushing the feed ==========*/
2029 static pid_t inndcomm_child;
2031 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
2032 assert(inndcomm_child);
2033 int status= xwaitpid(&inndcomm_child, "inndcomm");
2034 loop->cancel_fd(fd);
2037 assert(!flushing_input_file);
2039 if (WIFEXITED(status)) {
2040 switch (WEXITSTATUS(status)) {
2042 case INNDCOMMCHILD_ESTATUS_FAIL:
2045 case INNDCOMMCHILD_ESTATUS_NONESUCH:
2046 warn("feed has been dropped by innd, finishing up");
2047 flushing_input_file= main_input_file;
2048 tailing_queue_readable(flushing_input_file);
2049 /* we probably previously returned EAGAIN from our fake read method
2050 * when in fact we were at EOF, so signal another readable event
2051 * so we actually see the EOF */
2055 if (flushing_input_file) {
2056 SMS(DROPPING, 0, "feed dropped by innd, but must finish last flush");
2059 SMS(DROPPED, 0, "feed dropped by innd");
2060 search_backlog_file();
2062 return OOP_CONTINUE;
2066 flushing_input_file= main_input_file;
2067 tailing_queue_readable(flushing_input_file);
2069 main_input_file= open_input_file(feedfile);
2070 if (!main_input_file)
2071 die("flush succeeded but feedfile %s does not exist!", feedfile);
2073 if (flushing_input_file) {
2074 SMS(SEPARATED, spontaneous_flush_periods, "recovery flush complete");
2077 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2079 return OOP_CONTINUE;
2082 goto unexpected_exitstatus;
2085 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
2086 warn("flush timed out trying to talk to innd");
2089 unexpected_exitstatus:
2090 report_child_status("inndcomm child", status);
2094 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
2097 static void inndcommfail(const char *what) {
2098 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
2099 exit(INNDCOMMCHILD_ESTATUS_FAIL);
2102 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
2105 notice("flushing %s",why);
2107 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
2108 assert(!inndcomm_child);
2110 if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
2112 inndcomm_child= xfork();
2114 if (!inndcomm_child) {
2115 static char flushargv[2]= { sitename, 0 };
2120 alarm(inndcomm_flush_timeout);
2121 r= ICCopen(); if (r) inndcommfail("connect");
2122 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
2123 if (!r) exit(0); /* yay! */
2125 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
2126 syswarn("innd ctlinnd flush failed: innd said %s", reply);
2127 exit(INNDCOMMCHILD_ESTATUS_FAIL);
2131 int sentinel_fd= pipefds[0];
2132 on_fd_read_except(sentinel_fd, inndcomm_event);
2134 SMS(FLUSHING, 0, why);
2137 /*========== main program ==========*/
2139 static void postfork_inputfile(InputFile *ipf) {
2141 assert(ipf->fd >= 0);
2146 static void postfork_conns(Connection *conn) {
2153 static void postfork_stdio(FILE *f) {
2154 /* we have no stdio streams that are buffered long-term */
2158 static void postfork(const char *what) {
2159 if (signal(SIGPIPE, SIG_DFL) == SIG_ERR)
2160 sysdie("%s child: failed to reset SIGPIPE");
2162 postfork_inputfile(main_input_file);
2163 postfork_inputfile(flushing_input_file);
2164 postfork_conns(idle.head);
2165 postfork_conns(working.head);
2166 postfork_conns(full.head);
2167 postfork_stdio(defer);
2170 #define EVERY(what, interval, body) \
2171 static const struct timeval what##_timeout = { 5, 0 }; \
2172 static void what##_schedule(void); \
2173 static void *what##_timedout(oop_source *lp, struct timeval tv, void *u) { \
2175 what##_schedule(); \
2177 static void what##_schedule(void) { \
2178 loop->on_time(loop, what##_timeout, what##_timedout, 0); \
2181 EVERY(filepoll, {5,0}, {
2182 if (main_input_file && main_input_file->readable_callback)
2183 filemon_callback(main_input_file);
2186 #define DEBUGF_IPF(wh) " " #wh "=%p/%s:ip=%ld,off=%ld,fd=%d%s" \
2187 #define DEBUG_IPF(sh) \
2188 wh##_input_file, debug_ipf_path(wh##_input_file), \
2189 wh##_input_file->inprogress, (long)wh##_input_file->offset, \
2190 wh##_input_file->fd, wh##_input_file->rd ? "+" : ""
2191 static const char *debug_ipf_path(InputFile *ipf) {
2192 char *slash= strrchr(ipf->path,'/');
2193 return slash ? slash+1 : ipf->path;
2196 EVERY(period, {PERIOD_SECONDS,0}, {
2198 " sms=%s[%d] queue=%d connect_delay=%d"
2199 " input_files" DEBUGF_IPF(main) DEBUGF_IPF(old) DEBUGF_FMT(flushing)
2200 " conns idle=%d working=%d full=%d"
2201 " children connecting=%ld inndcomm_child"
2203 sms_names[sms], sm_period_counter, queue.count, connect_delay,
2204 DEBUG_IPF(main), DEBUG_IPF(flushing), DEBUG_IPF(flushing),
2205 idle.count, working.count, full.count,
2206 (long)connecting_child, (long)inndcomm_child
2209 if (connect_delay) connect_delay--;
2211 poll_backlog_file();
2212 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
2213 statemc_period_poll();
2214 check_master_queue();
2218 /*========== option parsing ==========*/
2221 of_seconds= 001000u;
2222 of_boolean= 002000u;
2225 typedef struct Option Option;
2226 typedef void OptionParser(const Option*, const char *val);
2236 void op_integer(const Option *o, const char *val) {
2239 unsigned long ul= strtoul(val,&ep,10);
2240 if (*ep || ep==val || errno || ul>INT_MAX)
2241 badusage("bad integer value for %s",o->long);
2242 int *store= o->store;
2246 void op_double(const Option *o, const char *val) {
2247 int *store= o->store;
2250 *store= strtod(val, &ep);
2251 if (*ep || ep==val || errno)
2252 badusage("bad floating point value for %s",o->long);
2255 void op_string(const Option *o, const char *val) {
2256 char **store= o->store;
2261 void op_seconds(const Option *o, const char *val) {
2262 int *store= o->store;
2265 double v= strtod(val,&ep);
2266 if (ep==val) badusage("bad time/duration value for %s",o->long);
2268 if (!*ep || !strcmp(ep,"s")) unit= 1;
2269 else if (!strcmp(ep,"m")) unit= 60;
2270 else if (!strcmp(ep,"h")) unit= 3600;
2271 else if (!strcmp(ep,"d")) unit= 86400;
2272 else badusage("bad units %s for time/duration value for %s",ep,o->long);
2276 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->long);
2280 void op_periods_rndup(const Option *o, const char *val) {
2281 int *store= o->store;
2283 *store += PERIOD_SECONDS-1;
2284 *store /= PERIOD_SECONDS;
2287 void op_periods_booltrue(const Option *o, const char *val) {
2288 int *store= o->store;
2291 void op_periods_boolfalse(const Option *o, const char *val) {
2292 int *store= o->store;
2296 static const Option options[]= {
2297 {'f',"feedfile", &feedfile, op_string },
2298 {'q',"quiet-multiple", &quiet_multiple, op_booltrue, 1 },
2300 { 0, "max-connections", &max_connections op_integer },
2301 { 0, "max-queue-per-conn", &max_queue_per_conn op_integer },
2304 { 0, "streaming", &try_stream, op_booltrue, 1 },
2305 { 0, "no-streaming", &try_stream, op_boolfalse, 1 },
2306 {'P',"port", &port op_integer },
2307 { 0, "inndconf", &inndconffile, op_string },
2308 {'d',"daemon", &become_daemon, op_booltrue, 1 },
2309 { 0, "no-daemon", &become_daemon, op_boolfalse, 1 },
2311 { 0, "no-check-proportion", &nocheck_thresh_pct, op_double },
2312 { 0, "no-check-filter", &nocheck_decay_articles, op_double },
2314 { 0, "reconnect-interval", &reconnect_delay_periods, op_periods_rndup },
2315 { 0, "flush-retry-interval", &flushfail_retry_periods, op_periods_rndup },
2316 { 0, "connection-timeout", &connection_timeout, op_seconds },
2317 { 0, "inndcomm-timeout", &inndcomm_flush_timeout, op_seconds },
2320 int main(int argc, char **argv) {
2326 if (*arg != '-') break;
2327 if (!strcmp(arg,"--")) { arg= *++argv; break; }
2329 while ((a= *++arg)) {
2333 char *equals= strchr(arg,'=');
2334 int len= equals ? (equals - arg) : strlen(arg);
2335 for (o=options; o->long; o++)
2336 if (strlen(o->long) == len && !memcmp(o->long,arg,len))
2338 badusage("unknown long option --%s",arg);
2341 if (equals) badusage("option --%s does not take a value",o->long);
2343 } else if (equals) {
2347 if (!arg) badusage("option --%s needs a value",o->long);
2350 break; /* eaten the whole argument now */
2352 for (o=options; o->long; o++)
2355 badusage("unknown short option -%c",a);
2362 if (!arg) badusage("option -%c needs a value",o->short);
2365 break; /* eaten the whole argument now */
2370 if (!arg) badusage("need site name argument");
2376 if (*++argv) badusage("too many non-option arguments");
2378 if (nocheck_thresh_pct < 0 || nocheck_thresh_pct > 100)
2379 badusage("nocheck threshold percentage must be between 0..100");
2380 nocheck_thresh= nocheck_thresh_pct * 0.01;
2382 if (nocheck_decay_articles < 0.1)
2383 badusage("nocheck decay articles must be at least 0.1");
2384 nocheck_decay= 1 - 1/nocheck_decay_articles;
2387 pathoutgoing= innconf->pathoutgoing;
2388 innconf_read(inndconffile);
2391 feedfile= xasprintf("%s/%s",pathoutgoing,sitename);
2392 else if (!feedfile[0])
2393 badusage("feed filename must be nonempty");
2394 else if (feedfile[strlen(feedfile)-1]=='/')
2395 feedfile= xasprintf("%s%s",feedfile,sitename);
2397 const char *feedfile_forbidden= "?*[~#";
2399 while ((c= *feedfile_forbidden++))
2400 if (strchr(feedfile, c))
2401 badusage("feed filename may not contain metacharacter %c",c);
2403 loop= oop_sys_new();
2404 if (!loop) sysdie("could not create liboop event loop");
2406 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
2407 sysdie("could not ignore SIGPIPE");
2409 if (become_daemon) {
2410 for (i=3; i<255; i++)
2411 /* do this now before we open syslog, etc. */
2413 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
2415 int null= open("/dev/null",O_RDWR);
2416 if (null<0) sysdie("failed to open /dev/null");
2422 pid_t child1= xfork("daemonise first fork");
2423 if (child1) _exit(0);
2425 pid_t sid= setsid();
2426 if (sid != child1) sysdie("setsid failed");
2428 pid_t child2= xfork("daemonise second fork");
2429 if (child2) _exit(0);
2434 if (!filemon_init()) {
2435 warn("no file monitoring available, polling");
2436 filepoll_schedule();