3 * tailing reliable realtime streaming feeder for inn
5 * Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * (I believe that when you compile and link this as part of the inn2
21 * build, with the Makefile runes I have provided, all the libraries
22 * and files which end up included in innduct are licence-compatible
23 * with GPLv3. If not then please let me know. -Ian Jackson.)
27 * Newsfeeds file entries should look like this:
28 * host.name.of.site[/exclude,exclude,...]\
29 * :pattern,pattern...[/distribution,distribution...]\
33 * sitename[/exclude,exclude,...]\
34 * :pattern,pattern...[/distribution,distribution...]\
40 * or might be blanked out
41 * <spc><spc><spc><spc>....
43 * F site.name main feed file
44 * opened/created, then written, by innd
47 * tokens blanked out by duct when processed
48 * site.name_lock lock preventing multiple ducts
49 * to hold lock must open,F_SETLK[W]
50 * and then stat to check that locked file
51 * still has name site.name_lock
52 * holder of this lock is "duct"
53 * (only) lockholder may remove the lockfile
54 * D site.name_flushing temporary feed file during flush (or crash)
55 * hardlink created by duct
57 * site.name_defer 431'd articles, still being written,
58 * created, written, used by duct
60 * site.name_backlog.<date>.<inum>
61 * 431'd articles, ready for innxmit or duct
62 * created (link/mv) by duct
63 * site.name_backlog<anything-else> (where <anything-else> does not
64 * contain '#' or '~') eg
65 * site.name_backlog.manual
66 * anything the sysadmin likes (eg, feed files
67 * from old feeds to be merged into this one)
68 * created (link/mv) by admin
69 * may be symlinks (in which case links
70 * may be written through, but only links
73 * It is safe to remove backlog files manually,
74 * if it's desired to throw away the backlog.
76 * Backlog files are also processed by innduct. We find the oldest
77 * backlog file which is at least a certain amount old, and feed it
78 * back into our processing. When every article in it has been read
79 * and processed, we unlink it and look for another backlog file.
81 * If we don't have a backlog file that we're reading, we close the
82 * defer file that we're writing and make it into a backlog file at
83 * the first convenient opportunity.
94 | | <----------------<---------------------------------'|
100 | F: innd writing, duct reading |
103 | | duct decides time to flush |
104 | | duct makes hardlink |
106 | V <------------------------'|
108 | F == D: innd writing, duct reading both exist |
111 | | <-----------<-------------<--'|
112 | | open D F ENOENT |
115 | V <---------------------. |
118 | D: innd writing, duct reading; or ENOENT | |
120 | | duct requests flush of feed | |
121 | | (others can too, harmlessly) | |
125 | D: innd flushing, duct; or ENOENT | |
127 | | inndcomm flush fails | |
128 | |`-------------------------->------------------' |
130 | | inndcomm reports no such site |
131 | |`---------------------------------------------------- | -.
133 | | innd finishes writing D, creates F | |
134 | | inndcomm reports flush successful | |
137 | Separated <----------------' |
138 | F: innd writing F!=D /
139 | D: duct reading; or ENOENT both exist /
141 | | duct gets to the end of D /
142 | | duct opens F too /
145 | F: innd writing, duct reading |
146 | D: duct finishing V
148 | | duct finishes processing D F: ENOENT
149 | V duct unlinks D D: duct reading
151 `--<--' | duct finishes
161 "duct reading" means innduct is reading the file but also
162 overwriting processed tokens.
166 * rune for printing diagrams:
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
173 /*============================== PROGRAM ==============================*/
175 #define _GNU_SOURCE 1
181 #include "inndcomm.h"
183 #include "inn/list.h"
184 #include "inn/innconf.h"
187 #include <sys/types.h>
188 #include <sys/wait.h>
189 #include <sys/stat.h>
190 #include <sys/socket.h>
209 #include <oop-read.h>
211 /*----- general definitions, probably best not changed -----*/
213 #define CONNCHILD_ESTATUS_STREAM 24
214 #define CONNCHILD_ESTATUS_NOSTREAM 25
216 #define INNDCOMMCHILD_ESTATUS_FAIL 26
217 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
219 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
220 #define MAX_CONTROL_COMMAND 1000
222 #define VA va_list al; va_start(al,fmt)
223 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
224 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
225 #define NORET __attribute__((__noreturn__))
227 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
228 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
230 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
232 #define FOR_CONN(conn) \
233 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
235 /*----- doubly linked lists -----*/
237 #define ISNODE(T) struct node list_node
240 union { struct list li; T *for_type; } u; \
244 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
246 #define LIST_CHECKCANHAVENODE(l,n) \
247 ((void)((n) == ((l).u.for_type))) /* just for the type check */
249 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
250 ( LIST_CHECKCANHAVENODE(l,n), \
251 list_addsomehow(&(l).u.li, NODE((n))), \
255 #define LIST_REMSOMEHOW(l,list_remsomehow) \
256 ( (typeof((l).u.for_type)) \
259 list_remsomehow(&(l).u.li) ) \
265 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
266 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
267 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
268 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
270 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
271 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
272 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
273 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
275 #define LIST_REMOVE(l,n) \
276 ( LIST_CHECKCANHAVENODE(l,n), \
277 list_remove(NODE((n))), \
281 #define LIST_INSERT(l,n,pred) \
282 ( LIST_CHECKCANHAVENODE(l,n), \
283 LIST_CHECKCANHAVENODE(l,pred), \
284 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
288 /*----- type predeclarations -----*/
290 typedef struct Conn Conn;
291 typedef struct Article Article;
292 typedef struct InputFile InputFile;
293 typedef struct XmitDetails XmitDetails;
294 typedef struct Filemon_Perfile Filemon_Perfile;
295 typedef enum StateMachineState StateMachineState;
296 typedef struct ControlCommand ControlCommand;
301 /*----- function predeclarations -----*/
303 static void conn_maybe_write(Conn *conn);
304 static void conn_make_some_xmits(Conn *conn);
305 static void *conn_write_some_xmits(Conn *conn);
307 static void xmit_free(XmitDetails *d);
309 #define SMS(newstate, periods, why) \
310 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
311 static void statemc_setstate(StateMachineState newsms, int periods,
312 const char *forlog, const char *why);
314 static void statemc_start_flush(const char *why); /* Normal => Flushing */
315 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
316 static int trigger_flush_ok(const char *why /* 0 means timeout */);
317 /* => Flushing,FLUSHING, ret 1; or ret 0 */
319 static void article_done(Article *art, int whichcount);
321 static void check_assign_articles(void);
322 static void queue_check_input_done(void);
323 static void check_reading_pause_resume(InputFile *ipf);
325 static void statemc_check_flushing_done(void);
326 static void statemc_check_backlog_done(void);
328 static void postfork(void);
329 static void period(void);
331 static void open_defer(void);
332 static void close_defer(void);
333 static void search_backlog_file(void);
334 static void preterminate(void);
335 static void raise_default(int signo) NORET;
336 static char *debug_report_ipf(InputFile *ipf);
338 static void inputfile_reading_start(InputFile *ipf);
339 static void inputfile_reading_stop(InputFile *ipf);
340 static void inputfile_reading_pause(InputFile *ipf);
341 static void inputfile_reading_resume(InputFile *ipf);
342 /* pause and resume are idempotent, and no-op if not done _reading_start */
344 static void filemon_start(InputFile *ipf);
345 static void filemon_stop(InputFile *ipf);
346 static void filemon_callback(InputFile *ipf);
348 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
349 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
351 static const oop_rd_style peer_rd_style;
352 static oop_rd_call peer_rd_err, peer_rd_ok;
355 /*----- configuration options -----*/
356 /* when changing defaults, remember to update the manpage */
358 static const char *sitename, *remote_host;
359 static const char *feedfile, *path_control;
360 static int quiet_multiple=0;
361 static int become_daemon=1, try_filemon=1;
362 static int try_stream=1;
364 static const char *inndconffile;
366 static int max_connections=10;
367 static int max_queue_per_conn=200;
368 static int target_max_feedfile_size=100000;
369 static int period_seconds=60;
370 static int filepoll_seconds=5;
371 static int max_queue_per_ipf=-1;
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
376 static double nocheck_thresh= 95.0; /* converted from percentage by main */
377 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=50;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
388 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
389 static int max_bad_data_initial= 30;
390 /* in one corrupt 4096-byte block the number of newlines has
391 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
394 /*----- statistics -----*/
396 typedef enum { /* in queue in conn->sent */
397 art_Unchecked, /* not checked, not sent checking */
398 art_Wanted, /* checked, wanted sent body as requested */
399 art_Unsolicited, /* - sent body without check */
403 static const char *const artstate_names[]=
404 { "Unchecked", "Wanted", "Unsolicited", 0 };
406 #define RESULT_COUNTS(RCS,RCN) \
415 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
416 #define RCI_TRIPLE_VALS_BASE(counts,x) \
417 counts[art_Unchecked] x \
418 + counts[art_Wanted] x \
419 + counts[art_Unsolicited] x, \
420 counts[art_Unchecked] x \
421 , counts[art_Wanted] x \
422 , counts[art_Unsolicited] x
425 #define RC_INDEX(x) RC_##x,
426 RESULT_COUNTS(RC_INDEX, RC_INDEX)
431 /*----- transmission buffers -----*/
447 /*----- core operational data structure types -----*/
450 /* This is also an instance of struct oop_readable */
451 struct oop_readable readable; /* first */
452 oop_readable_call *readable_callback;
453 void *readable_callback_user;
456 Filemon_Perfile *filemon;
458 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
460 int skippinglong, paused;
463 long inprogress; /* includes queue.count and also articles in conns */
464 long autodefer; /* -1 means not doing autodefer */
466 int counts[art_MaxState][RCI_max];
467 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
482 #define SMS_LIST(X) \
490 enum StateMachineState {
491 #define SMS_DEF_ENUM(s) sm_##s,
492 SMS_LIST(SMS_DEF_ENUM)
495 static const char *sms_names[]= {
496 #define SMS_DEF_NAME(s) #s ,
497 SMS_LIST(SMS_DEF_NAME)
503 int fd; /* may be 0, meaning closed (during construction/destruction) */
504 oop_read *rd; /* likewise */
505 int max_queue, stream, quitting;
506 int since_activity; /* periods */
507 ArticleList waiting; /* not yet told peer */
508 ArticleList priority; /* peer says send it now */
509 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
510 struct iovec xmit[CONNIOVS];
511 XmitDetails xmitd[CONNIOVS];
516 /*----- general operational variables -----*/
518 /* main initialises */
519 static oop_source *loop;
520 static ConnList conns;
521 static char *path_lock, *path_flushing, *path_defer, *path_dump;
522 static char *globpat_backlog;
523 static pid_t self_pid;
525 /* statemc_init initialises */
526 static StateMachineState sms;
527 static int until_flush;
528 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
531 /* initialisation to 0 is good */
532 static int until_connect, until_backlog_nextscan;
533 static double accept_proportion;
534 static int nocheck, nocheck_reported, in_child;
536 /* for simulation, debugging, etc. */
537 int simulate_flush= -1;
539 /*========== logging ==========*/
541 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
542 static void logcore(int sysloglevel, const char *fmt, ...) {
545 vsyslog(sysloglevel,fmt,al);
547 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
548 vfprintf(stderr,fmt,al);
554 static void logv(int sysloglevel, const char *pfx, int errnoval,
555 const char *fmt, va_list al) PRINTF(5,0);
556 static void logv(int sysloglevel, const char *pfx, int errnoval,
557 const char *fmt, va_list al) {
558 char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
559 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
560 msgbuf[sizeof(msgbuf)-1]= 0;
562 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
563 sysloglevel= LOG_ERR; /* run by wrong user, probably */
565 logcore(sysloglevel, "<%s>%s: %s%s%s",
566 sitename, pfx, msgbuf,
567 errnoval>=0 ? ": " : "",
568 errnoval>=0 ? strerror(errnoval) : "");
571 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
572 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
573 static void fn(const char *fmt, ...) { \
576 logv(sysloglevel, pfx, err, fmt, al); \
580 #define logwrap(fn, pfx, sysloglevel, err) \
581 static void fn(const char *fmt, ...) PRINTF(1,2); \
582 static void fn(const char *fmt, ...) { \
584 logv(sysloglevel, pfx, err, fmt, al); \
588 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
589 diewrap(die, " critical", LOG_CRIT, -1, 16);
591 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
592 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
594 logwrap(syswarn, " warning", LOG_WARNING, errno);
595 logwrap(warn, " warning", LOG_WARNING, -1);
597 logwrap(notice, " notice", LOG_NOTICE, -1);
598 logwrap(info, " info", LOG_INFO, -1);
599 logwrap(debug, " debug", LOG_DEBUG, -1);
602 /*========== utility functions etc. ==========*/
604 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
605 static char *xvasprintf(const char *fmt, va_list al) {
607 int rc= vasprintf(&str,fmt,al);
608 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
611 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
612 static char *xasprintf(const char *fmt, ...) {
614 char *str= xvasprintf(fmt,al);
619 static int close_perhaps(int *fd) {
620 if (*fd <= 0) return 0;
625 static void xclose(int fd, const char *what, const char *what2) {
627 if (r) sysdie("close %s%s",what,what2?what2:"");
629 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
630 if (*fd <= 0) return;
631 xclose(*fd,what,what2);
635 static pid_t xfork(const char *what) {
639 if (child==-1) sysfatal("cannot fork for %s",what);
640 debug("forked %s %ld", what, (unsigned long)child);
641 if (!child) postfork();
645 static void on_fd_read_except(int fd, oop_call_fd callback) {
646 loop->on_fd(loop, fd, OOP_READ, callback, 0);
647 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
649 static void cancel_fd_read_except(int fd) {
650 loop->cancel_fd(loop, fd, OOP_READ);
651 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
654 static void report_child_status(const char *what, int status) {
655 if (WIFEXITED(status)) {
656 int es= WEXITSTATUS(status);
658 warn("%s: child died with error exit status %d", what, es);
659 } else if (WIFSIGNALED(status)) {
660 int sig= WTERMSIG(status);
661 const char *sigstr= strsignal(sig);
662 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
664 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
666 warn("%s: child died due to unknown fatal signal %d%s",
667 what, sig, coredump);
669 warn("%s: child died with unknown wait status %d", what,status);
673 static int xwaitpid(pid_t *pid, const char *what) {
676 int r= kill(*pid, SIGKILL);
677 if (r) sysdie("cannot kill %s child", what);
679 pid_t got= waitpid(*pid, &status, 0);
680 if (got==-1) sysdie("cannot reap %s child", what);
681 if (got==0) die("cannot reap %s child", what);
688 static void *zxmalloc(size_t sz) {
689 void *p= xmalloc(sz);
694 static void xunlink(const char *path, const char *what) {
696 if (r) sysdie("can't unlink %s %s", path, what);
699 static time_t xtime(void) {
701 if (now==-1) sysdie("time(2) failed");
705 static void xsigaction(int signo, const struct sigaction *sa) {
706 int r= sigaction(signo,sa,0);
707 if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
710 static void xsigsetdefault(int signo) {
712 memset(&sa,0,sizeof(sa));
713 sa.sa_handler= SIG_DFL;
714 xsigaction(signo,&sa);
717 static void xgettimeofday(struct timeval *tv_r) {
718 int r= gettimeofday(tv_r,0);
719 if (r) sysdie("gettimeofday(2) failed");
722 static void xsetnonblock(int fd, int nonblocking) {
723 int errnoval= oop_fd_nonblock(fd, nonblocking);
724 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
727 static void check_isreg(const struct stat *stab, const char *path,
729 if (!S_ISREG(stab->st_mode))
730 die("%s %s not a plain file (mode 0%lo)",
731 what, path, (unsigned long)stab->st_mode);
734 static void xfstat(int fd, struct stat *stab_r, const char *what) {
735 int r= fstat(fd, stab_r);
736 if (r) sysdie("could not fstat %s", what);
739 static void xfstat_isreg(int fd, struct stat *stab_r,
740 const char *path, const char *what) {
741 xfstat(fd, stab_r, what);
742 check_isreg(stab_r, path, what);
745 static void xlstat_isreg(const char *path, struct stat *stab,
746 int *enoent_r /* 0 means ENOENT is fatal */,
748 int r= lstat(path, stab);
750 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
751 sysdie("could not lstat %s %s", what, path);
753 if (enoent_r) *enoent_r= 0;
754 check_isreg(stab, path, what);
757 static int samefile(const struct stat *a, const struct stat *b) {
758 assert(S_ISREG(a->st_mode));
759 assert(S_ISREG(b->st_mode));
760 return (a->st_ino == b->st_ino &&
761 a->st_dev == b->st_dev);
764 static char *sanitise(const char *input, int len) {
765 static char sanibuf[100]; /* returns pointer to this buffer! */
767 const char *p= input;
768 const char *endp= len>=0 ? input+len : 0;
772 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
773 int c= (!endp || p<endp) ? *p++ : 0;
774 if (!c) { *q++= '\''; *q=0; break; }
775 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
776 sprintf(q,"\\x%02x",c);
782 static int isewouldblock(int errnoval) {
783 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
786 /*========== command and control connections ==========*/
788 static int control_master;
790 typedef struct ControlConn ControlConn;
792 void (*destroy)(ControlConn*);
798 struct sockaddr_un un;
803 static const oop_rd_style control_rd_style= {
804 OOP_RD_DELIM_STRIP, '\n',
806 OOP_RD_SHORTREC_FORBID
809 static void control_destroy(ControlConn *cc) {
813 static void control_checkouterr(ControlConn *cc /* may destroy*/) {
814 if (ferror(cc->out) | fflush(cc->out)) {
815 info("CTRL%d write error %s", cc->fd, strerror(errno));
820 static void control_prompt(ControlConn *cc /* may destroy*/) {
821 fprintf(cc->out, "%s| ", sitename);
822 control_checkouterr(cc);
825 struct ControlCommand {
827 void (*f)(ControlConn *cc, const ControlCommand *ccmd,
828 const char *arg, size_t argsz);
833 static const ControlCommand control_commands[];
836 static void ccmd_##wh(ControlConn *cc, const ControlCommand *c, \
837 const char *arg, size_t argsz)
840 fputs("commands:\n", cc->out);
841 const ControlCommand *ccmd;
842 for (ccmd=control_commands; ccmd->cmd; ccmd++)
843 fprintf(cc->out, " %s\n", ccmd->cmd);
844 fputs("NB: permissible arguments are not shown above."
845 " Not all commands listed are safe. See innduct(8).\n", cc->out);
849 int ok= trigger_flush_ok("manual request");
850 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
855 notice("terminating (CTRL%d)",cc->fd);
856 raise_default(SIGTERM);
862 /* messing with our head: */
863 CCMD(period) { period(); }
864 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
865 CCMD(setint) { *(int*)c->xdata= c->xval; }
866 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
868 static const ControlCommand control_commands[]= {
870 { "flush", ccmd_flush },
871 { "stop", ccmd_stop },
872 { "dump q", ccmd_dump, 0,0 },
873 { "dump a", ccmd_dump, 0,1 },
875 { "p", ccmd_period },
877 #define POKES(cmd,func) \
878 { cmd "flush", func, &until_flush, 1 }, \
879 { cmd "conn", func, &until_connect, 0 }, \
880 { cmd "blscan", func, &until_backlog_nextscan, 0 },
881 POKES("next ", ccmd_setint)
882 POKES("prod ", ccmd_setint_period)
884 { "pretend flush", ccmd_setintarg, &simulate_flush },
885 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
889 static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
890 const char *errmsg, int errnoval,
891 const char *data, size_t recsz, void *cc_v) {
892 ControlConn *cc= cc_v;
895 info("CTRL%d closed", cc->fd);
900 if (recsz == 0) goto prompt;
902 const ControlCommand *ccmd;
903 for (ccmd=control_commands; ccmd->cmd; ccmd++) {
904 int l= strlen(ccmd->cmd);
905 if (recsz < l) continue;
906 if (recsz > l && data[l] != ' ') continue;
907 if (memcmp(data, ccmd->cmd, l)) continue;
909 int argl= (int)recsz - (l+1);
910 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
914 fputs("unknown command; h for help\n", cc->out);
921 static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
922 const char *errmsg, int errnoval,
923 const char *data, size_t recsz, void *cc_v) {
924 ControlConn *cc= cc_v;
926 info("CTRL%d read error %s", cc->fd, errmsg);
931 static int control_conn_startup(ControlConn *cc /* may destroy*/,
933 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
934 if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
936 int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
939 if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
941 info("CTRL%d %s ready", cc->fd, how);
946 static void control_stdio_destroy(ControlConn *cc) {
948 oop_rd_cancel(cc->rd);
949 errno= oop_rd_delete_tidy(cc->rd);
950 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
955 static void control_stdio(void) {
956 NEW_DECL(ControlConn *,cc);
957 cc->destroy= control_stdio_destroy;
961 int r= control_conn_startup(cc,"stdio");
962 if (r) cc->destroy(cc);
965 static void control_accepted_destroy(ControlConn *cc) {
967 oop_rd_cancel(cc->rd);
968 oop_rd_delete_kill(cc->rd);
970 if (cc->out) { fclose(cc->out); cc->fd=0; }
971 close_perhaps(&cc->fd);
975 static void *control_master_readable(oop_source *lp, int master,
976 oop_event ev, void *u) {
977 NEW_DECL(ControlConn *,cc);
978 cc->destroy= control_accepted_destroy;
980 cc->salen= sizeof(cc->sa);
981 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
982 if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
984 cc->out= fdopen(cc->fd, "w");
985 if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
987 int r= control_conn_startup(cc, "accepted");
997 #define NOCONTROL(...) do{ \
998 syswarn("no control socket, because failed to " __VA_ARGS__); \
1002 static void control_init(void) {
1005 struct sockaddr_un un;
1008 memset(&sa,0,sizeof(sa));
1009 int maxlen= sizeof(sa.un.sun_path);
1011 int pathlen= strlen(path_control);
1012 if (pathlen > maxlen)
1013 NOCONTROL("control socket path %s too long (%d>%d)",
1014 path_control, pathlen, maxlen);
1016 int r= unlink(path_control);
1017 if (r && errno!=ENOENT)
1018 NOCONTROL("remove old control socket %s", path_control);
1020 control_master= socket(PF_UNIX, SOCK_STREAM, 0);
1021 if (control_master<0) NOCONTROL("create new control socket");
1023 int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
1024 sa.un.sun_family= AF_UNIX;
1025 memcpy(sa.un.sun_path, path_control, pathlen);
1027 r= bind(control_master, &sa.sa, sl);
1028 if (r) NOCONTROL("bind to control socket path %s", sa.un.sun_path);
1030 r= listen(control_master, 5);
1031 if (r) NOCONTROL("listen");
1033 xsetnonblock(control_master, 1);
1035 loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
1036 info("control socket ok, listening on %s", path_control);
1041 xclose_perhaps(&control_master, "control master",0);
1045 /*========== management of connections ==========*/
1047 static void conn_closefd(Conn *conn, const char *msgprefix) {
1048 int r= close_perhaps(&conn->fd);
1049 if (r) info("C%d %serror closing socket: %s",
1050 conn->fd, msgprefix, strerror(errno));
1053 static void conn_dispose(Conn *conn) {
1056 oop_rd_cancel(conn->rd);
1057 oop_rd_delete_kill(conn->rd);
1061 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1062 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1064 conn_closefd(conn,"");
1066 until_connect= reconnect_delay_periods;
1069 static void *conn_exception(oop_source *lp, int fd,
1070 oop_event ev, void *conn_v) {
1073 assert(fd == conn->fd);
1074 assert(ev == OOP_EXCEPTION);
1075 int r= read(conn->fd, &ch, 1);
1076 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1077 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1078 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1079 return OOP_CONTINUE;
1082 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1083 int requeue[art_MaxState];
1084 memset(requeue,0,sizeof(requeue));
1088 while ((art= LIST_REMHEAD(conn->priority)))
1089 LIST_ADDTAIL(art->ipf->queue, art);
1091 while ((art= LIST_REMHEAD(conn->waiting)))
1092 LIST_ADDTAIL(art->ipf->queue, art);
1094 while ((art= LIST_REMHEAD(conn->sent))) {
1095 requeue[art->state]++;
1096 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1097 LIST_ADDTAIL(art->ipf->queue,art);
1098 check_reading_pause_resume(art->ipf);
1103 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1106 char *m= xvasprintf(fmt,al);
1107 warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1108 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1111 LIST_REMOVE(conns,conn);
1113 check_assign_articles();
1116 static void connfail(Conn *conn, const char *fmt, ...) {
1119 vconnfail(conn,fmt,al);
1123 static void check_idle_conns(void) {
1126 conn->since_activity++;
1129 if (conn->since_activity <= need_activity_periods) continue;
1131 /* We need to shut this down */
1133 connfail(conn,"timed out waiting for response to QUIT");
1134 else if (conn->sent.count)
1135 connfail(conn,"timed out waiting for responses");
1136 else if (conn->waiting.count || conn->priority.count)
1137 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1138 else if (conn->xmitu)
1139 connfail(conn,"peer has been sending responses"
1140 " before receiving our commands!");
1142 static const char quitcmd[]= "QUIT\r\n";
1143 int todo= sizeof(quitcmd)-1;
1144 const char *p= quitcmd;
1146 int r= write(conn->fd, p, todo);
1148 if (isewouldblock(errno))
1149 connfail(conn, "blocked writing QUIT to idle connection");
1151 connfail(conn, "failed to write QUIT to idle connection: %s",
1159 conn->since_activity= 0;
1160 debug("C%d is idle, quitting", conn->fd);
1169 /*---------- making new connections ----------*/
1171 static pid_t connecting_child;
1172 static int connecting_fdpass_sock;
1174 static void connect_attempt_discard(void) {
1175 if (connecting_child) {
1176 int status= xwaitpid(&connecting_child, "connect");
1177 if (!(WIFEXITED(status) ||
1178 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1179 report_child_status("connect", status);
1181 if (connecting_fdpass_sock) {
1182 cancel_fd_read_except(connecting_fdpass_sock);
1183 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1187 #define PREP_DECL_MSG_CMSG(msg) \
1189 struct iovec msgiov; \
1190 msgiov.iov_base= &msgbyte; \
1191 msgiov.iov_len= 1; \
1192 struct msghdr msg; \
1193 memset(&msg,0,sizeof(msg)); \
1194 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1195 msg.msg_iov= &msgiov; \
1196 msg.msg_iovlen= 1; \
1197 msg.msg_control= msg##cbuf; \
1198 msg.msg_controllen= sizeof(msg##cbuf);
1200 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1203 assert(fd == connecting_fdpass_sock);
1205 PREP_DECL_MSG_CMSG(msg);
1207 ssize_t rs= recvmsg(fd, &msg, 0);
1209 if (isewouldblock(errno)) return OOP_CONTINUE;
1210 syswarn("failed to read socket from connecting child");
1215 LIST_INIT(conn->waiting);
1216 LIST_INIT(conn->priority);
1217 LIST_INIT(conn->sent);
1219 struct cmsghdr *h= 0;
1220 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1222 int status= xwaitpid(&connecting_child, "connect child (broken)");
1224 if (WIFEXITED(status)) {
1225 if (WEXITSTATUS(status) != 0 &&
1226 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1227 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1228 /* child already reported the problem */;
1230 if (e == OOP_EXCEPTION)
1231 warn("connect: connection child exited code %d but"
1232 " unexpected exception on fdpass socket",
1233 WEXITSTATUS(status));
1235 warn("connect: connection child exited code %d but"
1237 WEXITSTATUS(status), (int)rs);
1239 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1240 warn("connect: connection attempt timed out");
1242 report_child_status("connect", status);
1247 #define CHK(field, val) \
1248 if (h->cmsg_##field != val) { \
1249 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1250 h->cmsg_##field, val); \
1253 CHK(level, SOL_SOCKET);
1254 CHK(type, SCM_RIGHTS);
1255 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1258 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1260 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1263 pid_t got= waitpid(connecting_child, &status, 0);
1264 if (got==-1) sysdie("connect: real wait for child");
1265 assert(got == connecting_child);
1266 connecting_child= 0;
1268 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1269 int es= WEXITSTATUS(status);
1271 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1272 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1274 fatal("connect: child gave unexpected exit status %d", es);
1278 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1280 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1281 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1282 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1283 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1285 &peer_rd_err, conn);
1286 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1288 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1289 LIST_ADDHEAD(conns, conn);
1291 connect_attempt_discard();
1292 check_assign_articles();
1293 return OOP_CONTINUE;
1297 connect_attempt_discard();
1298 return OOP_CONTINUE;
1301 static int allow_connect_start(void) {
1302 return conns.count < max_connections
1303 && !connecting_child
1307 static void connect_start(void) {
1308 assert(!connecting_child);
1309 assert(!connecting_fdpass_sock);
1311 info("starting connection attempt");
1314 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1315 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1317 connecting_child= xfork("connection");
1319 if (!connecting_child) {
1320 FILE *cn_from, *cn_to;
1321 char buf[NNTP_STRLEN+100];
1322 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1324 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1326 alarm(connection_setup_timeout);
1327 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1331 unsigned char c= buf[l-1];
1332 if (!isspace(c)) break;
1333 if (c=='\n' || c=='\r') stripped=1;
1337 sysfatal("connect: connection attempt failed");
1340 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1344 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1345 sysfatal("connect: authentication failed");
1347 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1349 sysfatal("connect: could not send MODE STREAM");
1350 buf[sizeof(buf)-1]= 0;
1351 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1352 if (ferror(cn_from))
1353 sysfatal("connect: could not read response to MODE STREAM");
1355 fatal("connect: connection close in response to MODE STREAM");
1360 fatal("connect: response to MODE STREAM is too long: %.100s...",
1362 l--; if (l>0 && buf[l-1]=='\r') l--;
1365 int rcode= strtoul(buf,&ep,10);
1367 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1371 exitstatus= CONNCHILD_ESTATUS_STREAM;
1377 warn("connect: unexpected response to MODE STREAM: %.50s",
1383 int fd= fileno(cn_from);
1385 PREP_DECL_MSG_CMSG(msg);
1386 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1387 cmsg->cmsg_level= SOL_SOCKET;
1388 cmsg->cmsg_type= SCM_RIGHTS;
1389 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1390 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1392 msg.msg_controllen= cmsg->cmsg_len;
1393 r= sendmsg(socks[1], &msg, 0);
1394 if (r<0) sysdie("sendmsg failed for new connection");
1395 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1400 xclose(socks[1], "connecting fdpass child's socket",0);
1401 connecting_fdpass_sock= socks[0];
1402 xsetnonblock(connecting_fdpass_sock, 1);
1403 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1406 /*---------- assigning articles to conns, and transmitting ----------*/
1408 static Article *dequeue_from(int peek, InputFile *ipf) {
1410 if (peek) return LIST_HEAD(ipf->queue);
1412 Article *art= LIST_REMHEAD(ipf->queue);
1414 check_reading_pause_resume(ipf);
1418 static Article *dequeue(int peek) {
1420 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1421 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1422 art= dequeue_from(peek, main_input_file); if (art) return art;
1426 static void check_assign_articles(void) {
1432 int spare=0, inqueue=0;
1434 /* Find a connection to offer this article. We prefer a busy
1435 * connection to an idle one, provided it's not full. We take the
1436 * first (oldest) and since that's stable, it will mean we fill up
1437 * connections in order. That way if we have too many
1438 * connections, the spare ones will go away eventually.
1441 if (walk->quitting) continue;
1442 inqueue= walk->sent.count + walk->priority.count
1443 + walk->waiting.count;
1444 spare= walk->max_queue - inqueue;
1445 assert(inqueue <= max_queue_per_conn);
1447 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1448 else if (spare>0) /*working*/ { use= walk; break; }
1451 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1453 Article *art= dequeue(0);
1455 LIST_ADDTAIL(use->waiting, art);
1458 conn_maybe_write(use);
1459 } else if (allow_connect_start()) {
1460 until_connect= reconnect_delay_periods;
1469 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1470 conn_maybe_write(u);
1471 return OOP_CONTINUE;
1474 static void conn_maybe_write(Conn *conn) {
1476 conn_make_some_xmits(conn);
1478 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1482 void *rp= conn_write_some_xmits(conn);
1483 if (rp==OOP_CONTINUE) {
1484 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1486 } else if (rp==OOP_HALT) {
1489 /* transmitted everything */
1496 /*---------- expiry, flow control and deferral ----------*/
1499 * flow control notes
1500 * to ensure articles go away eventually
1501 * separate queue for each input file
1503 * every period, check head of backlog queue for expiry with SMretrieve
1504 * if too old: discard, and check next article
1505 * also check every backlog article as we read it
1507 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1508 * one-off: eat queued articles from flushing and write them to defer
1509 * one-off: connfail all connections which have any articles from flushing
1510 * newly read articles from flushing go straight to defer
1511 * this should take care of it and get us out of this state
1512 * to avoid filling up ram needlessly
1514 * limit number of queued articles for each ipf
1515 * pause/resume inputfile tailing
1518 static void check_reading_pause_resume(InputFile *ipf) {
1519 if (ipf->queue.count >= max_queue_per_ipf)
1520 inputfile_reading_pause(ipf);
1522 inputfile_reading_resume(ipf);
1525 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1527 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1529 sysfatal("write to defer file %s",path_defer);
1530 article_done(art, whichcount);
1533 static int article_check_expired(Article *art /* must be queued, not conn */) {
1534 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1535 if (artdata) { SMfreearticle(artdata); return 0; }
1537 LIST_REMOVE(art->ipf->queue, art);
1539 art->ipf->count_nooffer_missing++;
1540 article_done(art,-1);
1544 static void inputfile_queue_check_expired(InputFile *ipf) {
1548 Article *art= LIST_HEAD(ipf->queue);
1549 int exp= article_check_expired(art);
1552 check_reading_pause_resume(ipf);
1555 static void article_autodefer(InputFile *ipf, Article *art) {
1557 article_defer(art,-1);
1560 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1562 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1563 if (art->ipf == ipf) return 1;
1567 static void autodefer_input_file_articles(InputFile *ipf) {
1569 while ((art= LIST_REMHEAD(ipf->queue)))
1570 article_autodefer(ipf, art);
1573 static void autodefer_input_file(InputFile *ipf) {
1576 autodefer_input_file_articles(ipf);
1578 if (ipf->inprogress) {
1581 if (has_article_in(&walk->waiting, ipf) ||
1582 has_article_in(&walk->priority, ipf) ||
1583 has_article_in(&walk->sent, ipf))
1586 while (ipf->inprogress) {
1588 if (walk->quitting < 0) goto found;
1589 abort(); /* where are they ?? */
1592 connfail(walk, "connection is stuck or crawling,"
1593 " and we need to finish flush");
1594 autodefer_input_file_articles(ipf);
1598 check_reading_pause_resume(ipf);
1601 /*========== article transmission ==========*/
1603 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1604 XmitKind kind) { /* caller must then fill in details */
1605 struct iovec *v= &conn->xmit[conn->xmitu];
1606 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1607 v->iov_base= (char*)data;
1613 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1614 xmit_core(conn,data,len, xk_Const);
1616 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1618 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1619 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1623 static void xmit_free(XmitDetails *d) {
1625 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1626 case xk_Const: break;
1631 static void *conn_write_some_xmits(Conn *conn) {
1633 * 0: nothing more to write, no need to call us again
1634 * OOP_CONTINUE: more to write but fd not writeable
1635 * OOP_HALT: disaster, have destroyed conn
1638 int count= conn->xmitu;
1639 if (!count) return 0;
1641 if (count > IOV_MAX) count= IOV_MAX;
1642 ssize_t rs= writev(conn->fd, conn->xmit, count);
1644 if (isewouldblock(errno)) return OOP_CONTINUE;
1645 connfail(conn, "write failed: %s", strerror(errno));
1651 for (done=0; rs && done<conn->xmitu; done++) {
1652 struct iovec *vp= &conn->xmit[done];
1653 XmitDetails *dp= &conn->xmitd[done];
1654 if (rs > vp->iov_len) {
1658 vp->iov_base= (char*)vp->iov_base + rs;
1662 int newu= conn->xmitu - done;
1663 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1664 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1669 static void conn_make_some_xmits(Conn *conn) {
1671 if (conn->xmitu+5 > CONNIOVS)
1674 Article *art= LIST_REMHEAD(conn->priority);
1675 if (!art) art= LIST_REMHEAD(conn->waiting);
1678 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1679 /* actually send it */
1681 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1684 art->state == art_Unchecked ? art_Unsolicited :
1685 art->state == art_Wanted ? art_Wanted :
1688 if (!artdata) art->missing= 1;
1689 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1693 XMIT_LITERAL("TAKETHIS ");
1694 xmit_noalloc(conn, art->messageid, art->midlen);
1695 XMIT_LITERAL("\r\n");
1696 xmit_artbody(conn, artdata);
1698 article_done(art, -1);
1702 /* we got 235 from IHAVE */
1704 xmit_artbody(conn, artdata);
1706 XMIT_LITERAL(".\r\n");
1710 LIST_ADDTAIL(conn->sent, art);
1716 XMIT_LITERAL("CHECK ");
1718 XMIT_LITERAL("IHAVE ");
1719 xmit_noalloc(conn, art->messageid, art->midlen);
1720 XMIT_LITERAL("\r\n");
1722 assert(art->state == art_Unchecked);
1723 art->ipf->counts[art->state][RC_sent]++;
1724 LIST_ADDTAIL(conn->sent, art);
1729 /*========== handling responses from peer ==========*/
1731 static const oop_rd_style peer_rd_style= {
1732 OOP_RD_DELIM_STRIP, '\n',
1734 OOP_RD_SHORTREC_FORBID
1737 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1738 const char *errmsg, int errnoval,
1739 const char *data, size_t recsz, void *conn_v) {
1741 connfail(conn, "error receiving from peer: %s", errmsg);
1742 return OOP_CONTINUE;
1745 static Article *article_reply_check(Conn *conn, const char *response,
1746 int code_indicates_streaming,
1748 /* 1:yes, -1:no, 0:dontcare */,
1749 const char *sanitised_response) {
1750 Article *art= LIST_HEAD(conn->sent);
1754 "peer gave unexpected response when no commands outstanding: %s",
1755 sanitised_response);
1759 if (code_indicates_streaming) {
1760 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1761 if (!conn->stream) {
1762 connfail(conn, "peer gave streaming response code "
1763 " to IHAVE or subsequent body: %s", sanitised_response);
1766 const char *got_mid= response+4;
1767 int got_midlen= strcspn(got_mid, " \n\r");
1768 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1769 connfail(conn, "peer gave streaming response with syntactically invalid"
1770 " messageid: %s", sanitised_response);
1773 if (got_midlen != art->midlen ||
1774 memcmp(got_mid, art->messageid, got_midlen)) {
1775 connfail(conn, "peer gave streaming response code to wrong article -"
1776 " probable synchronisation problem; we offered: %s;"
1778 art->messageid, sanitised_response);
1783 connfail(conn, "peer gave non-streaming response code to"
1784 " CHECK/TAKETHIS: %s", sanitised_response);
1789 if (must_have_sent>0 && art->state < art_Wanted) {
1790 connfail(conn, "peer says article accepted but"
1791 " we had not sent the body: %s", sanitised_response);
1794 if (must_have_sent<0 && art->state >= art_Wanted) {
1795 connfail(conn, "peer says please sent the article but we just did: %s",
1796 sanitised_response);
1800 Article *art_again= LIST_REMHEAD(conn->sent);
1801 assert(art_again == art);
1805 static void update_nocheck(int accepted) {
1806 accept_proportion *= nocheck_decay;
1807 accept_proportion += accepted * (1.0 - nocheck_decay);
1808 int new_nocheck= accept_proportion >= nocheck_thresh;
1809 if (new_nocheck && !nocheck_reported) {
1810 notice("entering nocheck mode for the first time");
1811 nocheck_reported= 1;
1812 } else if (new_nocheck != nocheck) {
1813 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1815 nocheck= new_nocheck;
1818 static void article_done(Article *art, int whichcount) {
1819 if (whichcount>=0 && !art->missing)
1820 art->ipf->counts[art->state][whichcount]++;
1822 if (whichcount == RC_accepted) update_nocheck(1);
1823 else if (whichcount == RC_unwanted) update_nocheck(0);
1825 InputFile *ipf= art->ipf;
1827 while (art->blanklen) {
1828 static const char spaces[]=
1838 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1839 int r= pwrite(ipf->fd, spaces, w, art->offset);
1841 if (errno==EINTR) continue;
1842 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1843 art->messageid, art->blanklen,
1844 (unsigned long)art->offset, ipf->path);
1846 assert(r>=0 && r<=w);
1852 assert(ipf->inprogress >= 0);
1855 if (!ipf->inprogress && ipf != main_input_file)
1856 queue_check_input_done();
1859 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1860 const char *errmsg, int errnoval,
1861 const char *data, size_t recsz, void *conn_v) {
1864 if (ev == OOP_RD_EOF) {
1865 connfail(conn, "unexpected EOF from peer");
1866 return OOP_CONTINUE;
1868 assert(ev == OOP_RD_OK);
1870 char *sani= sanitise(data,-1);
1873 unsigned long code= strtoul(data, &ep, 10);
1874 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1875 connfail(conn, "badly formatted response from peer: %s", sani);
1876 return OOP_CONTINUE;
1880 conn->waiting.count ||
1881 conn->priority.count ||
1885 if (conn->quitting) {
1886 if (code!=205 && code!=503) {
1887 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1889 notice("C%d idle connection closed by us", conn->fd);
1891 LIST_REMOVE(conns,conn);
1894 return OOP_CONTINUE;
1897 conn->since_activity= 0;
1900 #define GET_ARTICLE(musthavesent) do{ \
1901 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1902 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1905 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1906 code_streaming= (streaming); \
1907 GET_ARTICLE(musthavesent); \
1908 article_done(art, RC_##how); \
1912 #define PEERBADMSG(m) do { \
1913 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1916 int code_streaming= 0;
1920 default: PEERBADMSG("peer sent unexpected message");
1924 PEERBADMSG("peer timed us out or stopped accepting articles");
1926 notice("C%d idle connection closed by peer", conn->fd);
1927 LIST_REMOVE(conns,conn);
1929 return OOP_CONTINUE;
1931 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1932 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1934 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1935 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1937 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1938 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1940 case 238: /* CHECK says send it */
1942 case 335: /* IHAVE says send it */
1944 assert(art->state == art_Unchecked);
1945 art->ipf->counts[art->state][RC_accepted]++;
1946 art->state= art_Wanted;
1947 LIST_ADDTAIL(conn->priority, art);
1950 case 431: /* CHECK or TAKETHIS says try later */
1952 case 436: /* IHAVE says try later */
1954 article_defer(art, RC_deferred);
1960 conn_maybe_write(conn);
1961 check_assign_articles();
1962 return OOP_CONTINUE;
1966 /*========== monitoring of input files ==========*/
1968 static void feedfile_eof(InputFile *ipf) {
1969 assert(ipf != main_input_file); /* promised by tailing_try_read */
1970 inputfile_reading_stop(ipf);
1972 if (ipf == flushing_input_file) {
1973 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1974 if (main_input_file) inputfile_reading_start(main_input_file);
1975 statemc_check_flushing_done();
1976 } else if (ipf == backlog_input_file) {
1977 statemc_check_backlog_done();
1979 abort(); /* supposed to wait rather than get EOF on main input file */
1983 static InputFile *open_input_file(const char *path) {
1984 int fd= open(path, O_RDWR);
1986 if (errno==ENOENT) return 0;
1987 sysfatal("unable to open input file %s", path);
1991 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
1992 memset(ipf,0,sizeof(*ipf));
1996 LIST_INIT(ipf->queue);
1997 strcpy(ipf->path, path);
2002 static void close_input_file(InputFile *ipf) { /* does not free */
2003 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2004 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2005 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2006 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2007 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2011 /*---------- dealing with articles read in the input file ----------*/
2013 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2014 const char *data, const char *how) {
2015 warn("corrupted file: %s, offset %lu: %s: in %s",
2016 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2017 ipf->readcount_err++;
2018 if (ipf->readcount_err > max_bad_data_initial +
2019 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2020 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2021 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2022 return OOP_CONTINUE;
2025 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2026 oop_rd_event ev, const char *errmsg,
2027 int errnoval, const char *data, size_t recsz,
2029 InputFile *ipf= ipf_v;
2030 assert(ev == OOP_RD_SYSTEM);
2032 sysdie("error reading input file: %s, offset %lu",
2033 ipf->path, (unsigned long)ipf->offset);
2036 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2037 oop_rd_event ev, const char *errmsg,
2038 int errnoval, const char *data, size_t recsz,
2040 InputFile *ipf= ipf_v;
2042 char tokentextbuf[sizeof(TOKEN)*2+3];
2044 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2046 off_t old_offset= ipf->offset;
2047 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2049 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2051 if (ev==OOP_RD_PARTREC)
2052 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2053 /* but process it anyway */
2055 if (ipf->skippinglong) {
2056 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2057 return OOP_CONTINUE;
2059 if (ev==OOP_RD_LONG) {
2060 ipf->skippinglong= 1;
2061 X_BAD_DATA("overly long line");
2064 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2065 if (!recsz) X_BAD_DATA("empty line");
2068 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2069 ipf->readcount_blank++;
2070 return OOP_CONTINUE;
2073 char *space= strchr(data,' ');
2074 int tokenlen= space-data;
2075 int midlen= (int)recsz-tokenlen-1;
2076 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2077 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2079 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2080 memcpy(tokentextbuf, data, tokenlen);
2081 tokentextbuf[tokenlen]= 0;
2082 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2084 ipf->readcount_ok++;
2086 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2087 memset(art,0,sizeof(*art));
2088 art->state= art_Unchecked;
2089 art->midlen= midlen;
2090 art->ipf= ipf; ipf->inprogress++;
2091 art->token= TextToToken(tokentextbuf);
2092 art->offset= old_offset;
2093 art->blanklen= recsz;
2094 strcpy(art->messageid, space+1);
2095 LIST_ADDTAIL(ipf->queue, art);
2097 if (ipf->autodefer >= 0)
2098 article_autodefer(ipf, art);
2099 else if (ipf==backlog_input_file)
2100 article_check_expired(art);
2102 if (sms==sm_NORMAL && ipf==main_input_file &&
2103 ipf->offset >= target_max_feedfile_size)
2104 statemc_start_flush("feed file size");
2106 check_assign_articles(); /* may destroy conn but that's OK */
2107 check_reading_pause_resume(ipf);
2108 return OOP_CONTINUE;
2111 /*========== tailing input file ==========*/
2113 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2115 InputFile *ipf= user;
2116 return ipf->readable_callback(loop, &ipf->readable,
2117 ipf->readable_callback_user);
2120 static void tailing_on_cancel(struct oop_readable *rable) {
2121 InputFile *ipf= (void*)rable;
2123 if (ipf->filemon) filemon_stop(ipf);
2124 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2125 ipf->readable_callback= 0;
2128 static void tailing_queue_readable(InputFile *ipf) {
2129 /* lifetime of ipf here is OK because destruction will cause
2130 * on_cancel which will cancel this callback */
2131 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2134 static int tailing_on_readable(struct oop_readable *rable,
2135 oop_readable_call *cb, void *user) {
2136 InputFile *ipf= (void*)rable;
2138 tailing_on_cancel(rable);
2139 ipf->readable_callback= cb;
2140 ipf->readable_callback_user= user;
2143 tailing_queue_readable(ipf);
2147 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2149 InputFile *ipf= (void*)rable;
2151 ssize_t r= read(ipf->fd, buffer, length);
2153 if (errno==EINTR) continue;
2157 if (ipf==main_input_file) {
2160 } else if (ipf==flushing_input_file) {
2162 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2163 } else if (ipf==backlog_input_file) {
2169 tailing_queue_readable(ipf);
2174 /*---------- filemon implemented with inotify ----------*/
2176 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2177 #define HAVE_FILEMON
2179 #include <sys/inotify.h>
2181 static int filemon_inotify_fd;
2182 static int filemon_inotify_wdmax;
2183 static InputFile **filemon_inotify_wd2ipf;
2185 struct Filemon_Perfile {
2189 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2190 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2191 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2193 if (wd >= filemon_inotify_wdmax) {
2195 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2196 sizeof(*filemon_inotify_wd2ipf) * newmax);
2197 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2198 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2199 filemon_inotify_wdmax= newmax;
2202 assert(!filemon_inotify_wd2ipf[wd]);
2203 filemon_inotify_wd2ipf[wd]= ipf;
2205 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2206 ipf, wd, filemon_inotify_wdmax);
2211 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2213 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2214 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2215 if (r) sysdie("inotify_rm_watch");
2216 filemon_inotify_wd2ipf[wd]= 0;
2219 static void *filemon_inotify_readable(oop_source *lp, int fd,
2220 oop_event e, void *u) {
2221 struct inotify_event iev;
2223 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2225 if (isewouldblock(errno)) break;
2226 sysdie("read from inotify master");
2227 } else if (r==sizeof(iev)) {
2228 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2230 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2232 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2233 /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2234 filemon_callback(ipf);
2236 return OOP_CONTINUE;
2239 static int filemon_method_init(void) {
2240 filemon_inotify_fd= inotify_init();
2241 if (filemon_inotify_fd<0) {
2242 syswarn("filemon/inotify: inotify_init failed");
2245 xsetnonblock(filemon_inotify_fd, 1);
2246 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2248 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2252 static void filemon_method_dump_info(FILE *f) {
2254 fprintf(f,"inotify");
2255 DUMPV("%d",,filemon_inotify_fd);
2256 DUMPV("%d",,filemon_inotify_wdmax);
2257 for (i=0; i<filemon_inotify_wdmax; i++)
2258 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2261 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2263 /*---------- filemon dummy implementation ----------*/
2265 #if !defined(HAVE_FILEMON)
2267 struct Filemon_Perfile { int dummy; };
2269 static int filemon_method_init(void) {
2270 warn("filemon/dummy: no filemon method compiled in");
2273 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2274 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2275 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2277 #endif /* !HAVE_FILEMON */
2279 /*---------- filemon generic interface ----------*/
2281 static void filemon_start(InputFile *ipf) {
2282 assert(!ipf->filemon);
2285 filemon_method_startfile(ipf, ipf->filemon);
2288 static void filemon_stop(InputFile *ipf) {
2289 if (!ipf->filemon) return;
2290 filemon_method_stopfile(ipf, ipf->filemon);
2295 static void filemon_callback(InputFile *ipf) {
2296 if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2297 ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2300 /*---------- interface to start and stop an input file ----------*/
2302 static const oop_rd_style feedfile_rdstyle= {
2303 OOP_RD_DELIM_STRIP, '\n',
2305 OOP_RD_SHORTREC_LONG,
2308 static void inputfile_reading_resume(InputFile *ipf) {
2309 if (!ipf->rd) return;
2310 if (!ipf->paused) return;
2312 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2313 feedfile_got_article,ipf, feedfile_read_err, ipf);
2314 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2319 static void inputfile_reading_pause(InputFile *ipf) {
2320 if (!ipf->rd) return;
2321 if (ipf->paused) return;
2322 oop_rd_cancel(ipf->rd);
2326 static void inputfile_reading_start(InputFile *ipf) {
2328 ipf->readable.on_readable= tailing_on_readable;
2329 ipf->readable.on_cancel= tailing_on_cancel;
2330 ipf->readable.try_read= tailing_try_read;
2331 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2332 ipf->readable.delete_kill= 0;
2334 ipf->readable_callback= 0;
2335 ipf->readable_callback_user= 0;
2337 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2341 inputfile_reading_resume(ipf);
2344 static void inputfile_reading_stop(InputFile *ipf) {
2346 inputfile_reading_pause(ipf);
2347 oop_rd_delete(ipf->rd);
2349 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2353 /*========== interaction with innd - state machine ==========*/
2355 /* See official state diagram at top of file. We implement
2366 |`---------------------------------------------------.
2368 |`---------------- - - - |
2369 D ENOENT | D EXISTS see OVERALL STATES diagram |
2370 | for full startup logic |
2373 | ============ try to |
2379 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2380 ^ | hardlink F to D |
2383 | | our handle onto F is now onto D |
2386 | |<-------------------<---------------------<---------+
2388 | | spawn inndcomm flush |
2390 | ================== |
2391 | FLUSHING[-ABSENT] |
2393 | main D tail/none |
2394 | ================== |
2396 | | INNDCOMM FLUSH FAILS ^
2397 | |`----------------------->----------. |
2399 | | NO SUCH SITE V |
2400 ^ |`--------------->----. ==================== |
2401 | | \ FLUSHFAILED[-ABSENT] |
2403 | | FLUSH OK \ main D tail/none |
2404 | | open F \ ==================== |
2406 | | \ | TIME TO RETRY |
2407 | |`------->----. ,---<---'\ `----------------'
2408 | | D NONE | | D NONE `----.
2410 | ============= V V ============
2411 | SEPARATED-1 | | DROPPING-1
2412 | flsh->rd!=0 | | flsh->rd!=0
2413 | [Separated] | | [Dropping]
2414 | main F idle | | main none
2415 | flsh D tail | | flsh D tail
2416 | ============= | | ============
2418 ^ | EOF ON D | | defer | EOF ON D
2420 | =============== | | ===============
2421 | SEPARATED-2 | | DROPPING-2
2422 | flsh->rd==0 | V flsh->rd==0
2423 | [Finishing] | | [Dropping]
2424 | main F tail | `. main none
2425 | flsh D closed | `. flsh D closed
2426 | =============== V `. ===============
2428 | | ALL D PROCESSED `. | ALL D PROCESSED
2429 | V install defer as backlog `. | install defer
2430 ^ | close D `. | close D
2431 | | unlink D `. | unlink D
2434 `----------' ==============
2454 static void startup_set_input_file(InputFile *f) {
2455 assert(!main_input_file);
2457 inputfile_reading_start(f);
2460 static void statemc_lock(void) {
2462 struct stat stab, stabf;
2465 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2466 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2469 memset(&fl,0,sizeof(fl));
2471 fl.l_whence= SEEK_SET;
2472 int r= fcntl(lockfd, F_SETLK, &fl);
2474 if (errno==EACCES || isewouldblock(errno)) {
2475 if (quiet_multiple) exit(0);
2476 fatal("another duct holds the lockfile");
2478 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2481 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2483 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2485 if (!lock_noent && samefile(&stab, &stabf))
2488 xclose(lockfd, "stale lockfile ", path_lock);
2491 FILE *lockfile= fdopen(lockfd, "w");
2492 if (!lockfile) sysdie("fdopen lockfile");
2494 int r= ftruncate(lockfd, 0);
2495 if (r) sysdie("truncate lockfile to write new info");
2497 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2498 (unsigned long)self_pid,
2499 sitename, feedfile, remote_host) == EOF ||
2501 sysfatal("write info to lockfile %s", path_lock);
2503 debug("startup: locked");
2506 static void statemc_init(void) {
2507 struct stat stabdefer;
2509 search_backlog_file();
2512 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2514 debug("startup: ductdefer ENOENT");
2516 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2517 switch (stabdefer.st_nlink==1) {
2519 open_defer(); /* so that we will later close it and rename it */
2522 xunlink(path_defer, "stale defer file link"
2523 " (presumably hardlink to backlog file)");
2526 die("defer file %s has unexpected link count %d",
2527 path_defer, stabdefer.st_nlink);
2531 struct stat stab_f, stab_d;
2534 InputFile *file_d= open_input_file(path_flushing);
2535 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2537 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2539 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2540 debug("startup: F==D => Hardlinked");
2541 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2546 debug("startup: F ENOENT => Moved");
2547 if (file_d) startup_set_input_file(file_d);
2548 spawn_inndcomm_flush("feedfile missing at startup");
2549 /* => Flushing, sms:=FLUSHING */
2552 debug("startup: F!=D => Separated");
2553 startup_set_input_file(file_d);
2554 flushing_input_file= main_input_file;
2555 main_input_file= open_input_file(feedfile);
2556 if (!main_input_file) die("feedfile vanished during startup");
2557 SMS(SEPARATED, max_separated_periods,
2558 "found both old and current feed files");
2560 debug("startup: F exists, D ENOENT => Normal");
2561 InputFile *file_f= open_input_file(feedfile);
2562 if (!file_f) die("feed file vanished during startup");
2563 startup_set_input_file(file_f);
2564 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2569 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2570 assert(sms == sm_NORMAL);
2572 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2574 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2575 (unsigned long)target_max_feedfile_size,
2578 int r= link(feedfile, path_flushing);
2579 if (r) sysfatal("link feedfile %s to flushing file %s",
2580 feedfile, path_flushing);
2583 xunlink(feedfile, "old feedfile link");
2586 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2589 static int trigger_flush_ok(const char *why) {
2593 statemc_start_flush(why ? why : "periodic");
2594 return 1; /* Normal => Flushing; => FLUSHING */
2596 case sm_FLUSHFAILED:
2597 spawn_inndcomm_flush(why ? why : "retry");
2598 return 1; /* Moved => Flushing; => FLUSHING */
2602 warn("abandoning old feedfile after flush (%s), autodeferring",
2603 why ? why : "took too long to complete");
2604 assert(flushing_input_file);
2605 autodefer_input_file(flushing_input_file);
2613 static void statemc_period_poll(void) {
2614 if (!until_flush) return;
2616 assert(until_flush>=0);
2618 if (until_flush) return;
2619 int ok= trigger_flush_ok(0);
2623 static int inputfile_is_done(InputFile *ipf) {
2625 if (ipf->inprogress) return 0; /* new article in the meantime */
2626 if (ipf->rd) return 0; /* not had EOF */
2630 static void notice_processed(InputFile *ipf, int completed,
2631 const char *what, const char *spec) {
2632 if (!ipf) return; /* allows preterminate to be lazy */
2634 #define RCI_NOTHING(x) /* nothing */
2635 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2636 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2638 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2640 char *inprog= completed
2641 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2642 : xasprintf(" inprogress=%ld", ipf->inprogress);
2643 char *autodefer= ipf->autodefer >= 0
2644 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2645 : xasprintf("%s","");
2647 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2648 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2649 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2651 completed?"completed":"processed", what, spec,
2652 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2653 inprog, autodefer, ipf->count_nooffer_missing,
2654 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2655 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2656 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2657 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2658 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2667 static void statemc_check_backlog_done(void) {
2668 InputFile *ipf= backlog_input_file;
2669 if (!inputfile_is_done(ipf)) return;
2671 const char *slash= strrchr(ipf->path, '/');
2672 const char *leaf= slash ? slash+1 : ipf->path;
2673 const char *under= strchr(slash, '_');
2674 const char *rest= under ? under+1 : leaf;
2675 if (!strncmp(rest,"backlog",7)) rest += 7;
2676 notice_processed(ipf,1,"backlog ",rest);
2678 close_input_file(ipf);
2679 if (unlink(ipf->path)) {
2680 if (errno != ENOENT)
2681 sysdie("could not unlink processed backlog file %s", ipf->path);
2682 warn("backlog file %s vanished while we were reading it"
2683 " so we couldn't remove it (but it's done now, anyway)",
2687 backlog_input_file= 0;
2688 search_backlog_file();
2692 static void statemc_check_flushing_done(void) {
2693 InputFile *ipf= flushing_input_file;
2694 if (!inputfile_is_done(ipf)) return;
2696 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2698 notice_processed(ipf,1,"feedfile","");
2702 xunlink(path_flushing, "old flushing file");
2704 close_input_file(flushing_input_file);
2705 free(flushing_input_file);
2706 flushing_input_file= 0;
2708 if (sms==sm_SEPARATED) {
2709 notice("flush complete");
2710 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2711 } else if (sms==sm_DROPPING) {
2712 SMS(DROPPED, max_separated_periods, "old flush complete");
2713 search_backlog_file();
2714 notice("feed dropped, but will continue until backlog is finished");
2718 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2720 assert(!inputfile_is_done(main_input_file));
2721 statemc_check_flushing_done();
2722 statemc_check_backlog_done();
2723 return OOP_CONTINUE;
2726 static void queue_check_input_done(void) {
2727 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2730 static void statemc_setstate(StateMachineState newsms, int periods,
2731 const char *forlog, const char *why) {
2733 until_flush= periods;
2735 const char *xtra= "";
2738 case sm_FLUSHFAILED:
2739 if (!main_input_file) xtra= "-ABSENT";
2743 xtra= flushing_input_file->rd ? "-1" : "-2";
2749 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2751 info("state %s%s %s",forlog,xtra,why);
2755 /*---------- defer and backlog files ----------*/
2757 static void open_defer(void) {
2762 defer= fopen(path_defer, "a+");
2763 if (!defer) sysfatal("could not open defer file %s", path_defer);
2765 /* truncate away any half-written records */
2767 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2769 if (stab.st_size > LONG_MAX)
2770 die("defer file %s size is far too large", path_defer);
2775 long orgsize= stab.st_size;
2776 long truncto= stab.st_size;
2778 if (!truncto) break; /* was only (if anything) one half-truncated record */
2779 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2780 sysdie("seek in defer file %s while truncating partial", path_defer);
2785 sysdie("failed read from defer file %s", path_defer);
2787 die("defer file %s shrank while we were checking it!", path_defer);
2793 if (stab.st_size != truncto) {
2794 warn("truncating half-record at end of defer file %s -"
2795 " shrinking by %ld bytes from %ld to %ld",
2796 path_defer, orgsize - truncto, orgsize, truncto);
2799 sysfatal("could not flush defer file %s", path_defer);
2800 if (ftruncate(fileno(defer), truncto))
2801 sysdie("could not truncate defer file %s", path_defer);
2804 info("continuing existing defer file %s (%ld bytes)",
2805 path_defer, orgsize);
2807 if (fseek(defer, truncto, SEEK_SET))
2808 sysdie("could not seek to new end of defer file %s", path_defer);
2811 static void close_defer(void) {
2816 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2818 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2821 time_t now= xtime();
2823 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2825 (unsigned long)stab.st_ino);
2826 if (link(path_defer, backlog))
2827 sysfatal("could not install defer file %s as backlog file %s",
2828 path_defer, backlog);
2829 if (unlink(path_defer))
2830 sysdie("could not unlink old defer link %s to backlog file %s",
2831 path_defer, backlog);
2835 if (until_backlog_nextscan < 0 ||
2836 until_backlog_nextscan > backlog_retry_minperiods + 1)
2837 until_backlog_nextscan= backlog_retry_minperiods + 1;
2840 static void poll_backlog_file(void) {
2841 if (until_backlog_nextscan < 0) return;
2842 if (until_backlog_nextscan-- > 0) return;
2843 search_backlog_file();
2846 static void search_backlog_file(void) {
2847 /* returns non-0 iff there are any backlog files */
2852 const char *oldest_path=0;
2853 time_t oldest_mtime=0, now;
2855 if (backlog_input_file) return;
2859 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2863 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2865 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2867 for (i=0; i<gl.gl_pathc; i++) {
2868 const char *path= gl.gl_pathv[i];
2870 if (strchr(path,'#') || strchr(path,'~')) {
2871 debug("backlog file search skipping %s", path);
2874 r= stat(path, &stab);
2876 syswarn("failed to stat backlog file %s", path);
2879 if (!S_ISREG(stab.st_mode)) {
2880 warn("backlog file %s is not a plain file (or link to one)", path);
2883 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2885 oldest_mtime= stab.st_mtime;
2888 case GLOB_NOMATCH: /* fall through */
2891 sysdie("glob expansion of backlog pattern %s gave unexpected"
2892 " nonzero (error?) return value %d", globpat_backlog, r);
2896 debug("backlog scan: none");
2898 if (sms==sm_DROPPED) {
2900 notice("feed dropped and our work is complete");
2902 int r= unlink(path_control);
2903 if (r && errno!=ENOENT)
2904 syswarn("failed to remove control symlink for old feed");
2906 xunlink(path_lock, "lockfile for old feed");
2909 until_backlog_nextscan= backlog_spontrescan_periods;
2914 double age= difftime(now, oldest_mtime);
2915 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2917 if (age_deficiency <= 0) {
2918 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2919 age, age_deficiency, oldest_path);
2921 backlog_input_file= open_input_file(oldest_path);
2922 if (!backlog_input_file) {
2923 warn("backlog file %s vanished as we opened it", oldest_path);
2927 inputfile_reading_start(backlog_input_file);
2928 until_backlog_nextscan= -1;
2932 until_backlog_nextscan= age_deficiency / period_seconds;
2934 if (backlog_spontrescan_periods >= 0 &&
2935 until_backlog_nextscan > backlog_spontrescan_periods)
2936 until_backlog_nextscan= backlog_spontrescan_periods;
2938 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2939 age, age_deficiency, until_backlog_nextscan, oldest_path);
2946 /*---------- shutdown and signal handling ----------*/
2948 static void preterminate(void) {
2949 if (in_child) return;
2950 notice_processed(main_input_file,0,"feedfile","");
2951 notice_processed(flushing_input_file,0,"flushing","");
2952 if (backlog_input_file)
2953 notice_processed(backlog_input_file,0, "backlog file ",
2954 backlog_input_file->path);
2957 static int signal_self_pipe[2];
2958 static sig_atomic_t terminate_sig_flag;
2960 static void raise_default(int signo) {
2961 xsigsetdefault(signo);
2966 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
2967 assert(fd=signal_self_pipe[0]);
2969 int r= read(signal_self_pipe[0], buf, sizeof(buf));
2970 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
2971 if (r==0) die("eof on signal self pipe");
2972 if (terminate_sig_flag) {
2974 notice("terminating (%s)", strsignal(terminate_sig_flag));
2975 raise_default(terminate_sig_flag);
2977 return OOP_CONTINUE;
2980 static void sigarrived_handler(int signum) {
2985 if (!terminate_sig_flag) terminate_sig_flag= signum;
2990 write(signal_self_pipe[1],&x,1);
2993 static void init_signals(void) {
2994 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
2995 sysdie("could not ignore SIGPIPE");
2997 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
2999 xsetnonblock(signal_self_pipe[0],1);
3000 xsetnonblock(signal_self_pipe[1],1);
3002 struct sigaction sa;
3003 memset(&sa,0,sizeof(sa));
3004 sa.sa_handler= sigarrived_handler;
3005 sa.sa_flags= SA_RESTART;
3006 xsigaction(SIGTERM,&sa);
3007 xsigaction(SIGINT,&sa);
3009 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3012 /*========== flushing the feed ==========*/
3014 static pid_t inndcomm_child;
3015 static int inndcomm_sentinel_fd;
3017 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3018 assert(inndcomm_child);
3019 assert(fd == inndcomm_sentinel_fd);
3020 int status= xwaitpid(&inndcomm_child, "inndcomm");
3023 cancel_fd_read_except(fd);
3024 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3025 inndcomm_sentinel_fd= 0;
3027 assert(!flushing_input_file);
3029 if (WIFEXITED(status)) {
3030 switch (WEXITSTATUS(status)) {
3032 case INNDCOMMCHILD_ESTATUS_FAIL:
3035 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3036 notice("feed has been dropped by innd, finishing up");
3037 flushing_input_file= main_input_file;
3038 tailing_queue_readable(flushing_input_file);
3039 /* we probably previously returned EAGAIN from our fake read method
3040 * when in fact we were at EOF, so signal another readable event
3041 * so we actually see the EOF */
3045 if (flushing_input_file) {
3046 SMS(DROPPING, max_separated_periods,
3047 "feed dropped by innd, but must finish last flush");
3050 SMS(DROPPED, 0, "feed dropped by innd");
3051 search_backlog_file();
3053 return OOP_CONTINUE;
3057 flushing_input_file= main_input_file;
3058 tailing_queue_readable(flushing_input_file);
3060 main_input_file= open_input_file(feedfile);
3061 if (!main_input_file)
3062 die("flush succeeded but feedfile %s does not exist!", feedfile);
3064 if (flushing_input_file) {
3065 SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3068 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3070 return OOP_CONTINUE;
3073 goto unexpected_exitstatus;
3076 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3077 warn("flush timed out trying to talk to innd");
3080 unexpected_exitstatus:
3081 report_child_status("inndcomm child", status);
3085 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3086 return OOP_CONTINUE;
3089 static void inndcommfail(const char *what) {
3090 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3091 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3094 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3097 notice("flushing %s",why);
3099 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3100 assert(!inndcomm_child);
3101 assert(!inndcomm_sentinel_fd);
3103 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3105 inndcomm_child= xfork("inndcomm child");
3107 if (!inndcomm_child) {
3108 const char *flushargv[2]= { sitename, 0 };
3112 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3113 /* parent spots the autoclose of pipefds[1] when we die or exit */
3115 if (simulate_flush>=0) {
3116 warn("SIMULATING flush child status %d", simulate_flush);
3117 if (simulate_flush>128) raise(simulate_flush-128);
3118 else exit(simulate_flush);
3121 alarm(inndcomm_flush_timeout);
3122 r= ICCopen(); if (r) inndcommfail("connect");
3123 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3124 if (!r) exit(0); /* yay! */
3126 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3127 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3128 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3133 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3134 inndcomm_sentinel_fd= pipefds[0];
3135 assert(inndcomm_sentinel_fd);
3136 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3138 SMS(FLUSHING, 0, why);
3141 /*========== main program ==========*/
3143 static void postfork_inputfile(InputFile *ipf) {
3145 xclose(ipf->fd, "(in child) input file ", ipf->path);
3148 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3149 /* we have no stdio streams that are buffered long-term */
3151 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3154 static void postfork(void) {
3157 xsigsetdefault(SIGTERM);
3158 xsigsetdefault(SIGINT);
3159 xsigsetdefault(SIGPIPE);
3160 if (terminate_sig_flag) raise(terminate_sig_flag);
3162 postfork_inputfile(main_input_file);
3163 postfork_inputfile(flushing_input_file);
3167 conn_closefd(conn,"(in child) ");
3169 postfork_stdio(defer, "defer file ", path_defer);
3172 typedef struct Every Every;
3174 struct timeval interval;
3179 static void every_schedule(Every *e, struct timeval base);
3181 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3184 if (!e->fixed_rate) xgettimeofday(&base);
3185 every_schedule(e, base);
3186 return OOP_CONTINUE;
3189 static void every_schedule(Every *e, struct timeval base) {
3190 struct timeval when;
3191 timeradd(&base, &e->interval, &when);
3192 loop->on_time(loop, when, every_happens, e);
3195 static void every(int interval, int fixed_rate, void (*f)(void)) {
3196 NEW_DECL(Every *,e);
3197 e->interval.tv_sec= interval;
3198 e->interval.tv_usec= 0;
3199 e->fixed_rate= fixed_rate;
3202 xgettimeofday(&now);
3203 every_schedule(e, now);
3206 static void filepoll(void) {
3207 filemon_callback(main_input_file);
3208 filemon_callback(flushing_input_file);
3211 static char *debug_report_ipf(InputFile *ipf) {
3212 if (!ipf) return xasprintf("none");
3214 const char *slash= strrchr(ipf->path,'/');
3215 const char *path= slash ? slash+1 : ipf->path;
3217 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3219 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3220 (long)ipf->offset, ipf->fd,
3221 ipf->rd ? "" : ",!rd",
3222 ipf->skippinglong ? "*skiplong" : "",
3223 ipf->rd && ipf->paused ? "*paused" : "");
3226 static void period(void) {
3227 char *dipf_main= debug_report_ipf(main_input_file);
3228 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3229 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3232 " sms=%s[%d] conns=%d until_connect=%d"
3233 " input_files main:%s flushing:%s backlog:%s[%d]"
3234 " children connecting=%ld inndcomm=%ld"
3236 sms_names[sms], until_flush, conns.count, until_connect,
3237 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3238 (long)connecting_child, (long)inndcomm_child
3242 free(dipf_flushing);
3245 if (until_connect) until_connect--;
3247 inputfile_queue_check_expired(backlog_input_file);
3248 poll_backlog_file();
3249 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3250 statemc_period_poll();
3251 check_assign_articles();
3256 /*========== dumping state ==========*/
3258 static void dump_article_list(FILE *f, const ControlCommand *c,
3259 const ArticleList *al) {
3260 fprintf(f, " count=%d\n", al->count);
3261 if (!c->xval) return;
3263 int i; Article *art;
3264 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3265 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3266 DUMPV("%p", art->,ipf);
3267 DUMPV("%d", art->,missing);
3268 DUMPV("%lu", (unsigned long)art->,offset);
3269 DUMPV("%d", art->,blanklen);
3270 DUMPV("%d", art->,midlen);
3271 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3275 static void dump_input_file(FILE *f, const ControlCommand *c,
3276 InputFile *ipf, const char *wh) {
3277 char *dipf= debug_report_ipf(ipf);
3278 fprintf(f,"input %s %s", wh, dipf);
3282 DUMPV("%d", ipf->,readcount_ok);
3283 DUMPV("%d", ipf->,readcount_blank);
3284 DUMPV("%d", ipf->,readcount_err);
3285 DUMPV("%d", ipf->,count_nooffer_missing);
3289 ArtState state; const char *const *statename;
3290 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3291 #define RC_DUMP_FMT(x) " " #x "=%d"
3292 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3293 fprintf(f,"input %s counts %-11s"
3294 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3296 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3298 fprintf(f,"input %s queue", wh);
3299 dump_article_list(f,c,&ipf->queue);
3305 fprintf(cc->out, "dumping state to %s\n", path_dump);
3306 FILE *f= fopen(path_dump, "w");
3307 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3309 fprintf(f,"general");
3310 DUMPV("%s", sms_names,[sms]);
3311 DUMPV("%d", ,until_flush);
3312 DUMPV("%ld", (long),self_pid);
3313 DUMPV("%p", , defer);
3314 DUMPV("%d", , until_connect);
3315 DUMPV("%d", , until_backlog_nextscan);
3316 DUMPV("%d", , simulate_flush);
3317 fprintf(f,"\nnocheck");
3318 DUMPV("%#.10f", , accept_proportion);
3319 DUMPV("%d", , nocheck);
3320 DUMPV("%d", , nocheck_reported);
3323 fprintf(f,"special");
3324 DUMPV("%ld", (long),connecting_child);
3325 DUMPV("%d", , connecting_fdpass_sock);
3326 DUMPV("%d", , control_master);
3329 fprintf(f,"filemon ");
3330 filemon_method_dump_info(f);
3332 dump_input_file(f,c, main_input_file, "main" );
3333 dump_input_file(f,c, flushing_input_file, "flushing");
3334 dump_input_file(f,c, backlog_input_file, "backlog" );
3336 fprintf(f,"conns count=%d\n", conns.count);
3341 fprintf(f,"C%d",conn->fd);
3342 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3343 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3344 DUMPV("%d",conn->,since_activity);
3347 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3348 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3349 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3351 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3352 for (i=0; i<conn->xmitu; i++) {
3353 const struct iovec *iv= &conn->xmit[i];
3354 const XmitDetails *xd= &conn->xmitd[i];
3357 case xk_Const: dinfo= xasprintf("Const"); break;
3358 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3362 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3363 sanitise(iv->iov_base, iv->iov_len));
3369 DUMPV("%s", , feedfile);
3370 DUMPV("%s", , path_control);
3371 DUMPV("%s", , path_lock);
3372 DUMPV("%s", , path_flushing);
3373 DUMPV("%s", , path_defer);
3374 DUMPV("%s", , path_dump);
3375 DUMPV("%s", , globpat_backlog);
3378 if (!!ferror(f) + !!fclose(f)) {
3379 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3384 /*========== option parsing ==========*/
3386 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3387 static void vbadusage(const char *fmt, va_list al) {
3388 char *m= xvasprintf(fmt,al);
3389 fprintf(stderr, "bad usage: %s\n"
3390 "say --help for help, or read the manpage\n",
3393 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3397 /*---------- generic option parser ----------*/
3399 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3400 static void badusage(const char *fmt, ...) {
3407 of_seconds= 001000u,
3408 of_boolean= 002000u,
3411 typedef struct Option Option;
3412 typedef void OptionParser(const Option*, const char *val);
3416 const char *lng, *formarg;
3422 static void parse_options(const Option *options, char ***argvp) {
3423 /* on return *argvp is first non-option arg; argc is not updated */
3426 const char *arg= *++(*argvp);
3428 if (*arg != '-') break;
3429 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3431 while ((a= *++arg)) {
3435 char *equals= strchr(arg,'=');
3436 int len= equals ? (equals - arg) : strlen(arg);
3437 for (o=options; o->shrt || o->lng; o++)
3438 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3440 badusage("unknown long option --%s",arg);
3443 if (equals) badusage("option --%s does not take a value",o->lng);
3445 } else if (equals) {
3449 if (!arg) badusage("option --%s needs a value for %s",
3450 o->lng, o->formarg);
3453 break; /* eaten the whole argument now */
3455 for (o=options; o->shrt || o->lng; o++)
3458 badusage("unknown short option -%c",a);
3465 if (!arg) badusage("option -%c needs a value for %s",
3466 o->shrt, o->formarg);
3469 break; /* eaten the whole argument now */
3475 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3477 static void print_options(const Option *options, FILE *f) {
3479 for (o=options; o->shrt || o->lng; o++) {
3480 char shrt[2] = { o->shrt, 0 };
3481 char *optspec= xasprintf("%s%s%s%s%s",
3482 o->shrt ? "-" : "", shrt,
3483 o->shrt && o->lng ? "|" : "",
3484 DELIMPERHAPS("--", o->lng));
3485 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3490 /*---------- specific option types ----------*/
3492 static void op_integer(const Option *o, const char *val) {
3495 unsigned long ul= strtoul(val,&ep,10);
3496 if (*ep || ep==val || errno || ul>INT_MAX)
3497 badusage("bad integer value for %s",o->lng);
3498 int *store= o->store;
3502 static void op_double(const Option *o, const char *val) {
3503 int *store= o->store;
3506 *store= strtod(val, &ep);
3507 if (*ep || ep==val || errno)
3508 badusage("bad floating point value for %s",o->lng);
3511 static void op_string(const Option *o, const char *val) {
3512 const char **store= o->store;
3516 static void op_seconds(const Option *o, const char *val) {
3517 int *store= o->store;
3521 double v= strtod(val,&ep);
3522 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3524 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3525 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3526 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3527 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3528 else if (!strcmp(ep,"das")) unit= 10;
3529 else if (!strcmp(ep,"hs")) unit= 100;
3530 else if (!strcmp(ep,"ks")) unit= 1000;
3531 else if (!strcmp(ep,"Ms")) unit= 1000000;
3532 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3536 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3540 static void op_setint(const Option *o, const char *val) {
3541 int *store= o->store;
3545 /*---------- specific options ----------*/
3547 static void help(const Option *o, const char *val);
3549 static const Option innduct_options[]= {
3550 {'f',"feedfile", "F", &feedfile, op_string },
3551 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3552 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3553 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3554 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3555 {'C',"inndconf", "F", &inndconffile, op_string },
3556 {'P',"port", "PORT", &port, op_integer },
3557 {0,"cli", 0, &path_control, op_string },
3558 {0,"help", 0, 0, help },
3560 {0,"max-connections", "N", &max_connections, op_integer },
3561 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3562 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3563 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3564 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3566 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3567 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3568 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3570 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3571 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3573 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3574 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3575 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3576 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3577 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3578 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3579 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3581 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3582 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3587 static void printusage(FILE *f) {
3588 fputs("usage: innduct [options] site [fqdn]\n"
3589 "available options are:\n", f);
3590 print_options(innduct_options, f);
3593 static void help(const Option *o, const char *val) {
3595 if (ferror(stdout) || fflush(stdout)) {
3596 perror("innduct: writing help");
3602 static void convert_to_periods_rndup(int *store) {
3603 *store += period_seconds-1;
3604 *store /= period_seconds;
3607 static void assemble_path(const char **path_io, const char *suffix,
3609 const char *const specified= *path_io;
3610 if (!specified[0]) badusage("%s, if specified, must be nonempty", what);
3611 if (specified[strlen(specified)-1]=='/')
3612 *path_io= xasprintf("%s%s%s", specified, sitename, suffix);
3615 int main(int argc, char **argv) {
3621 parse_options(innduct_options, &argv);
3626 if (!sitename) badusage("need site name argument");
3627 remote_host= *argv++;
3628 if (*argv) badusage("too many non-option arguments");
3632 int r= innconf_read(inndconffile);
3633 if (!r) badusage("could not read inn.conf (more info on stderr)");
3635 if (!remote_host) remote_host= sitename;
3637 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3638 badusage("nocheck threshold percentage must be between 0..100");
3639 nocheck_thresh *= 0.01;
3641 if (nocheck_decay < 0.1)
3642 badusage("nocheck decay articles must be at least 0.1");
3643 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3645 convert_to_periods_rndup(&reconnect_delay_periods);
3646 convert_to_periods_rndup(&flushfail_retry_periods);
3647 convert_to_periods_rndup(&backlog_retry_minperiods);
3648 convert_to_periods_rndup(&backlog_spontrescan_periods);
3649 convert_to_periods_rndup(&spontaneous_flush_periods);
3650 convert_to_periods_rndup(&max_separated_periods);
3651 convert_to_periods_rndup(&need_activity_periods);
3653 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3654 badusage("bad input data ratio must be between 0..100");
3655 max_bad_data_ratio *= 0.01;
3657 if (!feedfile) feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3658 else assemble_path(&feedfile, "", "feed filename");
3660 if (path_control) path_control= xasprintf("%s_cli", feedfile);
3661 else assemble_path(&path_control, "%s_cli", "control socket path");
3663 if (max_queue_per_ipf<0)
3664 max_queue_per_ipf= max_queue_per_conn * 2;
3666 const char *feedfile_forbidden= "?*[~#";
3668 while ((c= *feedfile_forbidden++))
3669 if (strchr(feedfile, c))
3670 badusage("feed filename may not contain metacharacter %c",c);
3674 path_lock= xasprintf("%s_lock", feedfile);
3675 path_flushing= xasprintf("%s_flushing", feedfile);
3676 path_defer= xasprintf("%s_defer", feedfile);
3677 path_dump= xasprintf("%s_dump", feedfile);
3678 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3680 oop_source_sys *sysloop= oop_sys_new();
3681 if (!sysloop) sysdie("could not create liboop event loop");
3682 loop= (oop_source*)sysloop;
3686 if (become_daemon) {
3688 for (i=3; i<255; i++)
3689 /* do this now before we open syslog, etc. */
3691 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3693 int null= open("/dev/null",O_RDWR);
3694 if (null<0) sysfatal("failed to open /dev/null");
3698 xclose(null, "/dev/null original fd",0);
3700 pid_t child1= xfork("daemonise first fork");
3701 if (child1) _exit(0);
3703 pid_t sid= setsid();
3704 if (sid != child1) sysfatal("setsid failed");
3706 pid_t child2= xfork("daemonise second fork");
3707 if (child2) _exit(0);
3711 if (self_pid==-1) sysdie("getpid");
3720 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3721 // r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3730 notice("filemon: suppressed by command line option, polling");
3732 filemon_ok= filemon_method_init();
3734 warn("filemon: no file monitoring available, polling");
3737 every(filepoll_seconds,0,filepoll);
3739 every(period_seconds,1,period);
3745 void *run= oop_sys_run(sysloop);
3746 assert(run == OOP_ERROR);
3747 sysdie("event loop failed");