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_CLI_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 CliCommand CliCommand;
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 tailing_make_readable(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_run, *path_cli, *path_cli_dir;
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, fake_readable;
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 (CLI) connections ==========*/
788 static int cli_master;
790 typedef struct CliConn CliConn;
792 void (*destroy)(CliConn*);
798 struct sockaddr_un un;
803 static const oop_rd_style cli_rd_style= {
804 OOP_RD_DELIM_STRIP, '\n',
806 OOP_RD_SHORTREC_FORBID
809 static void cli_destroy(CliConn *cc) {
813 static void cli_checkouterr(CliConn *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 cli_prompt(CliConn *cc /* may destroy*/) {
821 fprintf(cc->out, "%s| ", sitename);
827 void (*f)(CliConn *cc, const CliCommand *ccmd,
828 const char *arg, size_t argsz);
833 static const CliCommand cli_commands[];
836 static void ccmd_##wh(CliConn *cc, const CliCommand *c, \
837 const char *arg, size_t argsz)
840 fputs("commands:\n", cc->out);
841 const CliCommand *ccmd;
842 for (ccmd=cli_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 CliCommand cli_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 *cli_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) {
895 info("CTRL%d closed", cc->fd);
900 if (recsz == 0) goto prompt;
902 const CliCommand *ccmd;
903 for (ccmd=cli_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 *cli_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) {
926 info("CTRL%d read error %s", cc->fd, errmsg);
931 static int cli_conn_startup(CliConn *cc /* may destroy*/,
933 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
934 if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
936 int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
939 if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
941 info("CTRL%d %s ready", cc->fd, how);
946 static void cli_stdio_destroy(CliConn *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 cli_stdio(void) {
956 NEW_DECL(CliConn *,cc);
957 cc->destroy= cli_stdio_destroy;
961 int r= cli_conn_startup(cc,"stdio");
962 if (r) cc->destroy(cc);
965 static void cli_accepted_destroy(CliConn *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 *cli_master_readable(oop_source *lp, int master,
976 oop_event ev, void *u) {
977 NEW_DECL(CliConn *,cc);
978 cc->destroy= cli_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 cli connection"); goto x; }
984 cc->out= fdopen(cc->fd, "w");
985 if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
987 int r= cli_conn_startup(cc, "accepted");
997 #define NOCLI(...) do{ \
998 syswarn("no cli listener, because failed to " __VA_ARGS__); \
1002 static void cli_init(void) {
1005 struct sockaddr_un un;
1008 memset(&sa,0,sizeof(sa));
1009 int maxlen= sizeof(sa.un.sun_path);
1012 info("control command line disabled");
1016 int pathlen= strlen(path_cli);
1017 if (pathlen > maxlen) {
1018 warn("no cli listener, because cli socket path %s too long (%d>%d)",
1019 path_cli, pathlen, maxlen);
1024 int r= mkdir(path_cli_dir, 0700);
1025 if (r && errno!=EEXIST)
1026 NOCLI("create cli socket directory %s", path_cli_dir);
1029 int r= unlink(path_cli);
1030 if (r && errno!=ENOENT)
1031 NOCLI("remove old cli socket %s", path_cli);
1033 cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1034 if (cli_master<0) NOCLI("create new cli master socket");
1036 int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1037 sa.un.sun_family= AF_UNIX;
1038 memcpy(sa.un.sun_path, path_cli, pathlen);
1040 r= bind(cli_master, &sa.sa, sl);
1041 if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1043 r= listen(cli_master, 5);
1044 if (r) NOCLI("listen to cli master socket");
1046 xsetnonblock(cli_master, 1);
1048 loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1049 info("cli ready, listening on %s", path_cli);
1054 xclose_perhaps(&cli_master, "cli master",0);
1058 /*========== management of connections ==========*/
1060 static void conn_closefd(Conn *conn, const char *msgprefix) {
1061 int r= close_perhaps(&conn->fd);
1062 if (r) info("C%d %serror closing socket: %s",
1063 conn->fd, msgprefix, strerror(errno));
1066 static void conn_dispose(Conn *conn) {
1069 oop_rd_cancel(conn->rd);
1070 oop_rd_delete_kill(conn->rd);
1074 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1075 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1077 conn_closefd(conn,"");
1079 until_connect= reconnect_delay_periods;
1082 static void *conn_exception(oop_source *lp, int fd,
1083 oop_event ev, void *conn_v) {
1086 assert(fd == conn->fd);
1087 assert(ev == OOP_EXCEPTION);
1088 int r= read(conn->fd, &ch, 1);
1089 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1090 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1091 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1092 return OOP_CONTINUE;
1095 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1096 int requeue[art_MaxState];
1097 memset(requeue,0,sizeof(requeue));
1101 while ((art= LIST_REMHEAD(conn->priority)))
1102 LIST_ADDTAIL(art->ipf->queue, art);
1104 while ((art= LIST_REMHEAD(conn->waiting)))
1105 LIST_ADDTAIL(art->ipf->queue, art);
1107 while ((art= LIST_REMHEAD(conn->sent))) {
1108 requeue[art->state]++;
1109 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1110 LIST_ADDTAIL(art->ipf->queue,art);
1111 check_reading_pause_resume(art->ipf);
1116 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1119 char *m= xvasprintf(fmt,al);
1120 warn("C%d connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1121 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1124 LIST_REMOVE(conns,conn);
1126 check_assign_articles();
1129 static void connfail(Conn *conn, const char *fmt, ...) {
1132 vconnfail(conn,fmt,al);
1136 static void check_idle_conns(void) {
1139 conn->since_activity++;
1142 if (conn->since_activity <= need_activity_periods) continue;
1144 /* We need to shut this down */
1146 connfail(conn,"timed out waiting for response to QUIT");
1147 else if (conn->sent.count)
1148 connfail(conn,"timed out waiting for responses");
1149 else if (conn->waiting.count || conn->priority.count)
1150 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1151 else if (conn->xmitu)
1152 connfail(conn,"peer has been sending responses"
1153 " before receiving our commands!");
1155 static const char quitcmd[]= "QUIT\r\n";
1156 int todo= sizeof(quitcmd)-1;
1157 const char *p= quitcmd;
1159 int r= write(conn->fd, p, todo);
1161 if (isewouldblock(errno))
1162 connfail(conn, "blocked writing QUIT to idle connection");
1164 connfail(conn, "failed to write QUIT to idle connection: %s",
1172 conn->since_activity= 0;
1173 debug("C%d is idle, quitting", conn->fd);
1182 /*---------- making new connections ----------*/
1184 static pid_t connecting_child;
1185 static int connecting_fdpass_sock;
1187 static void connect_attempt_discard(void) {
1188 if (connecting_child) {
1189 int status= xwaitpid(&connecting_child, "connect");
1190 if (!(WIFEXITED(status) ||
1191 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1192 report_child_status("connect", status);
1194 if (connecting_fdpass_sock) {
1195 cancel_fd_read_except(connecting_fdpass_sock);
1196 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1200 #define PREP_DECL_MSG_CMSG(msg) \
1202 struct iovec msgiov; \
1203 msgiov.iov_base= &msgbyte; \
1204 msgiov.iov_len= 1; \
1205 struct msghdr msg; \
1206 memset(&msg,0,sizeof(msg)); \
1207 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1208 msg.msg_iov= &msgiov; \
1209 msg.msg_iovlen= 1; \
1210 msg.msg_control= msg##cbuf; \
1211 msg.msg_controllen= sizeof(msg##cbuf);
1213 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1216 assert(fd == connecting_fdpass_sock);
1218 PREP_DECL_MSG_CMSG(msg);
1220 ssize_t rs= recvmsg(fd, &msg, 0);
1222 if (isewouldblock(errno)) return OOP_CONTINUE;
1223 syswarn("failed to read socket from connecting child");
1228 LIST_INIT(conn->waiting);
1229 LIST_INIT(conn->priority);
1230 LIST_INIT(conn->sent);
1232 struct cmsghdr *h= 0;
1233 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1235 int status= xwaitpid(&connecting_child, "connect child (broken)");
1237 if (WIFEXITED(status)) {
1238 if (WEXITSTATUS(status) != 0 &&
1239 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1240 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1241 /* child already reported the problem */;
1243 if (e == OOP_EXCEPTION)
1244 warn("connect: connection child exited code %d but"
1245 " unexpected exception on fdpass socket",
1246 WEXITSTATUS(status));
1248 warn("connect: connection child exited code %d but"
1250 WEXITSTATUS(status), (int)rs);
1252 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1253 warn("connect: connection attempt timed out");
1255 report_child_status("connect", status);
1260 #define CHK(field, val) \
1261 if (h->cmsg_##field != val) { \
1262 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1263 h->cmsg_##field, val); \
1266 CHK(level, SOL_SOCKET);
1267 CHK(type, SCM_RIGHTS);
1268 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1271 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1273 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1276 pid_t got= waitpid(connecting_child, &status, 0);
1277 if (got==-1) sysdie("connect: real wait for child");
1278 assert(got == connecting_child);
1279 connecting_child= 0;
1281 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1282 int es= WEXITSTATUS(status);
1284 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1285 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1287 fatal("connect: child gave unexpected exit status %d", es);
1291 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1293 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1294 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1295 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1296 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1298 &peer_rd_err, conn);
1299 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1301 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1302 LIST_ADDHEAD(conns, conn);
1304 connect_attempt_discard();
1305 check_assign_articles();
1306 return OOP_CONTINUE;
1310 connect_attempt_discard();
1311 return OOP_CONTINUE;
1314 static int allow_connect_start(void) {
1315 return conns.count < max_connections
1316 && !connecting_child
1320 static void connect_start(void) {
1321 assert(!connecting_child);
1322 assert(!connecting_fdpass_sock);
1324 info("starting connection attempt");
1327 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1328 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1330 connecting_child= xfork("connection");
1332 if (!connecting_child) {
1333 FILE *cn_from, *cn_to;
1334 char buf[NNTP_STRLEN+100];
1335 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1337 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1339 alarm(connection_setup_timeout);
1340 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1344 unsigned char c= buf[l-1];
1345 if (!isspace(c)) break;
1346 if (c=='\n' || c=='\r') stripped=1;
1350 sysfatal("connect: connection attempt failed");
1353 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1357 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1358 sysfatal("connect: authentication failed");
1360 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1362 sysfatal("connect: could not send MODE STREAM");
1363 buf[sizeof(buf)-1]= 0;
1364 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1365 if (ferror(cn_from))
1366 sysfatal("connect: could not read response to MODE STREAM");
1368 fatal("connect: connection close in response to MODE STREAM");
1373 fatal("connect: response to MODE STREAM is too long: %.100s...",
1375 l--; if (l>0 && buf[l-1]=='\r') l--;
1378 int rcode= strtoul(buf,&ep,10);
1380 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1384 exitstatus= CONNCHILD_ESTATUS_STREAM;
1390 warn("connect: unexpected response to MODE STREAM: %.50s",
1396 int fd= fileno(cn_from);
1398 PREP_DECL_MSG_CMSG(msg);
1399 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1400 cmsg->cmsg_level= SOL_SOCKET;
1401 cmsg->cmsg_type= SCM_RIGHTS;
1402 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1403 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1405 msg.msg_controllen= cmsg->cmsg_len;
1406 r= sendmsg(socks[1], &msg, 0);
1407 if (r<0) sysdie("sendmsg failed for new connection");
1408 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1413 xclose(socks[1], "connecting fdpass child's socket",0);
1414 connecting_fdpass_sock= socks[0];
1415 xsetnonblock(connecting_fdpass_sock, 1);
1416 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1419 /*---------- assigning articles to conns, and transmitting ----------*/
1421 static Article *dequeue_from(int peek, InputFile *ipf) {
1423 if (peek) return LIST_HEAD(ipf->queue);
1425 Article *art= LIST_REMHEAD(ipf->queue);
1427 check_reading_pause_resume(ipf);
1431 static Article *dequeue(int peek) {
1433 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1434 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1435 art= dequeue_from(peek, main_input_file); if (art) return art;
1439 static void check_assign_articles(void) {
1445 int spare=0, inqueue=0;
1447 /* Find a connection to offer this article. We prefer a busy
1448 * connection to an idle one, provided it's not full. We take the
1449 * first (oldest) and since that's stable, it will mean we fill up
1450 * connections in order. That way if we have too many
1451 * connections, the spare ones will go away eventually.
1454 if (walk->quitting) continue;
1455 inqueue= walk->sent.count + walk->priority.count
1456 + walk->waiting.count;
1457 spare= walk->max_queue - inqueue;
1458 assert(inqueue <= max_queue_per_conn);
1460 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1461 else if (spare>0) /*working*/ { use= walk; break; }
1464 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1466 Article *art= dequeue(0);
1468 LIST_ADDTAIL(use->waiting, art);
1471 conn_maybe_write(use);
1472 } else if (allow_connect_start()) {
1473 until_connect= reconnect_delay_periods;
1482 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1483 conn_maybe_write(u);
1484 return OOP_CONTINUE;
1487 static void conn_maybe_write(Conn *conn) {
1489 conn_make_some_xmits(conn);
1491 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1495 void *rp= conn_write_some_xmits(conn);
1496 if (rp==OOP_CONTINUE) {
1497 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1499 } else if (rp==OOP_HALT) {
1502 /* transmitted everything */
1509 /*---------- expiry, flow control and deferral ----------*/
1512 * flow control notes
1513 * to ensure articles go away eventually
1514 * separate queue for each input file
1516 * every period, check head of backlog queue for expiry with SMretrieve
1517 * if too old: discard, and check next article
1518 * also check every backlog article as we read it
1520 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1521 * one-off: eat queued articles from flushing and write them to defer
1522 * one-off: connfail all connections which have any articles from flushing
1523 * newly read articles from flushing go straight to defer
1524 * this should take care of it and get us out of this state
1525 * to avoid filling up ram needlessly
1527 * limit number of queued articles for each ipf
1528 * pause/resume inputfile tailing
1531 static void check_reading_pause_resume(InputFile *ipf) {
1532 if (ipf->queue.count >= max_queue_per_ipf)
1533 inputfile_reading_pause(ipf);
1535 inputfile_reading_resume(ipf);
1538 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1540 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1542 sysfatal("write to defer file %s",path_defer);
1543 article_done(art, whichcount);
1546 static int article_check_expired(Article *art /* must be queued, not conn */) {
1547 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1548 if (artdata) { SMfreearticle(artdata); return 0; }
1550 LIST_REMOVE(art->ipf->queue, art);
1552 art->ipf->count_nooffer_missing++;
1553 article_done(art,-1);
1557 static void inputfile_queue_check_expired(InputFile *ipf) {
1561 Article *art= LIST_HEAD(ipf->queue);
1562 int exp= article_check_expired(art);
1565 check_reading_pause_resume(ipf);
1568 static void article_autodefer(InputFile *ipf, Article *art) {
1570 article_defer(art,-1);
1573 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1575 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1576 if (art->ipf == ipf) return 1;
1580 static void autodefer_input_file_articles(InputFile *ipf) {
1582 while ((art= LIST_REMHEAD(ipf->queue)))
1583 article_autodefer(ipf, art);
1586 static void autodefer_input_file(InputFile *ipf) {
1589 autodefer_input_file_articles(ipf);
1591 if (ipf->inprogress) {
1594 if (has_article_in(&walk->waiting, ipf) ||
1595 has_article_in(&walk->priority, ipf) ||
1596 has_article_in(&walk->sent, ipf))
1599 while (ipf->inprogress) {
1601 if (walk->quitting < 0) goto found;
1602 abort(); /* where are they ?? */
1605 connfail(walk, "connection is stuck or crawling,"
1606 " and we need to finish flush");
1607 autodefer_input_file_articles(ipf);
1611 check_reading_pause_resume(ipf);
1614 /*========== article transmission ==========*/
1616 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1617 XmitKind kind) { /* caller must then fill in details */
1618 struct iovec *v= &conn->xmit[conn->xmitu];
1619 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1620 v->iov_base= (char*)data;
1626 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1627 xmit_core(conn,data,len, xk_Const);
1629 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1631 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1632 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1636 static void xmit_free(XmitDetails *d) {
1638 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1639 case xk_Const: break;
1644 static void *conn_write_some_xmits(Conn *conn) {
1646 * 0: nothing more to write, no need to call us again
1647 * OOP_CONTINUE: more to write but fd not writeable
1648 * OOP_HALT: disaster, have destroyed conn
1651 int count= conn->xmitu;
1652 if (!count) return 0;
1654 if (count > IOV_MAX) count= IOV_MAX;
1655 ssize_t rs= writev(conn->fd, conn->xmit, count);
1657 if (isewouldblock(errno)) return OOP_CONTINUE;
1658 connfail(conn, "write failed: %s", strerror(errno));
1664 for (done=0; rs && done<conn->xmitu; done++) {
1665 struct iovec *vp= &conn->xmit[done];
1666 XmitDetails *dp= &conn->xmitd[done];
1667 if (rs > vp->iov_len) {
1671 vp->iov_base= (char*)vp->iov_base + rs;
1675 int newu= conn->xmitu - done;
1676 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1677 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1682 static void conn_make_some_xmits(Conn *conn) {
1684 if (conn->xmitu+5 > CONNIOVS)
1687 Article *art= LIST_REMHEAD(conn->priority);
1688 if (!art) art= LIST_REMHEAD(conn->waiting);
1691 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1692 /* actually send it */
1694 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1697 art->state == art_Unchecked ? art_Unsolicited :
1698 art->state == art_Wanted ? art_Wanted :
1701 if (!artdata) art->missing= 1;
1702 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1706 XMIT_LITERAL("TAKETHIS ");
1707 xmit_noalloc(conn, art->messageid, art->midlen);
1708 XMIT_LITERAL("\r\n");
1709 xmit_artbody(conn, artdata);
1711 article_done(art, -1);
1715 /* we got 235 from IHAVE */
1717 xmit_artbody(conn, artdata);
1719 XMIT_LITERAL(".\r\n");
1723 LIST_ADDTAIL(conn->sent, art);
1729 XMIT_LITERAL("CHECK ");
1731 XMIT_LITERAL("IHAVE ");
1732 xmit_noalloc(conn, art->messageid, art->midlen);
1733 XMIT_LITERAL("\r\n");
1735 assert(art->state == art_Unchecked);
1736 art->ipf->counts[art->state][RC_sent]++;
1737 LIST_ADDTAIL(conn->sent, art);
1742 /*========== handling responses from peer ==========*/
1744 static const oop_rd_style peer_rd_style= {
1745 OOP_RD_DELIM_STRIP, '\n',
1747 OOP_RD_SHORTREC_FORBID
1750 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1751 const char *errmsg, int errnoval,
1752 const char *data, size_t recsz, void *conn_v) {
1754 connfail(conn, "error receiving from peer: %s", errmsg);
1755 return OOP_CONTINUE;
1758 static Article *article_reply_check(Conn *conn, const char *response,
1759 int code_indicates_streaming,
1761 /* 1:yes, -1:no, 0:dontcare */,
1762 const char *sanitised_response) {
1763 Article *art= LIST_HEAD(conn->sent);
1767 "peer gave unexpected response when no commands outstanding: %s",
1768 sanitised_response);
1772 if (code_indicates_streaming) {
1773 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1774 if (!conn->stream) {
1775 connfail(conn, "peer gave streaming response code "
1776 " to IHAVE or subsequent body: %s", sanitised_response);
1779 const char *got_mid= response+4;
1780 int got_midlen= strcspn(got_mid, " \n\r");
1781 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1782 connfail(conn, "peer gave streaming response with syntactically invalid"
1783 " messageid: %s", sanitised_response);
1786 if (got_midlen != art->midlen ||
1787 memcmp(got_mid, art->messageid, got_midlen)) {
1788 connfail(conn, "peer gave streaming response code to wrong article -"
1789 " probable synchronisation problem; we offered: %s;"
1791 art->messageid, sanitised_response);
1796 connfail(conn, "peer gave non-streaming response code to"
1797 " CHECK/TAKETHIS: %s", sanitised_response);
1802 if (must_have_sent>0 && art->state < art_Wanted) {
1803 connfail(conn, "peer says article accepted but"
1804 " we had not sent the body: %s", sanitised_response);
1807 if (must_have_sent<0 && art->state >= art_Wanted) {
1808 connfail(conn, "peer says please sent the article but we just did: %s",
1809 sanitised_response);
1813 Article *art_again= LIST_REMHEAD(conn->sent);
1814 assert(art_again == art);
1818 static void update_nocheck(int accepted) {
1819 accept_proportion *= nocheck_decay;
1820 accept_proportion += accepted * (1.0 - nocheck_decay);
1821 int new_nocheck= accept_proportion >= nocheck_thresh;
1822 if (new_nocheck && !nocheck_reported) {
1823 notice("entering nocheck mode for the first time");
1824 nocheck_reported= 1;
1825 } else if (new_nocheck != nocheck) {
1826 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1828 nocheck= new_nocheck;
1831 static void article_done(Article *art, int whichcount) {
1832 if (whichcount>=0 && !art->missing)
1833 art->ipf->counts[art->state][whichcount]++;
1835 if (whichcount == RC_accepted) update_nocheck(1);
1836 else if (whichcount == RC_unwanted) update_nocheck(0);
1838 InputFile *ipf= art->ipf;
1840 while (art->blanklen) {
1841 static const char spaces[]=
1851 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1852 int r= pwrite(ipf->fd, spaces, w, art->offset);
1854 if (errno==EINTR) continue;
1855 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1856 art->messageid, art->blanklen,
1857 (unsigned long)art->offset, ipf->path);
1859 assert(r>=0 && r<=w);
1865 assert(ipf->inprogress >= 0);
1868 if (!ipf->inprogress && ipf != main_input_file)
1869 queue_check_input_done();
1872 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1873 const char *errmsg, int errnoval,
1874 const char *data, size_t recsz, void *conn_v) {
1877 if (ev == OOP_RD_EOF) {
1878 connfail(conn, "unexpected EOF from peer");
1879 return OOP_CONTINUE;
1881 assert(ev == OOP_RD_OK);
1883 char *sani= sanitise(data,-1);
1886 unsigned long code= strtoul(data, &ep, 10);
1887 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1888 connfail(conn, "badly formatted response from peer: %s", sani);
1889 return OOP_CONTINUE;
1893 conn->waiting.count ||
1894 conn->priority.count ||
1898 if (conn->quitting) {
1899 if (code!=205 && code!=503) {
1900 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1902 notice("C%d idle connection closed by us", conn->fd);
1904 LIST_REMOVE(conns,conn);
1907 return OOP_CONTINUE;
1910 conn->since_activity= 0;
1913 #define GET_ARTICLE(musthavesent) do{ \
1914 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1915 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1918 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1919 code_streaming= (streaming); \
1920 GET_ARTICLE(musthavesent); \
1921 article_done(art, RC_##how); \
1925 #define PEERBADMSG(m) do { \
1926 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1929 int code_streaming= 0;
1933 default: PEERBADMSG("peer sent unexpected message");
1937 PEERBADMSG("peer timed us out or stopped accepting articles");
1939 notice("C%d idle connection closed by peer", conn->fd);
1940 LIST_REMOVE(conns,conn);
1942 return OOP_CONTINUE;
1944 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1945 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1947 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1948 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1950 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1951 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1953 case 238: /* CHECK says send it */
1955 case 335: /* IHAVE says send it */
1957 assert(art->state == art_Unchecked);
1958 art->ipf->counts[art->state][RC_accepted]++;
1959 art->state= art_Wanted;
1960 LIST_ADDTAIL(conn->priority, art);
1963 case 431: /* CHECK or TAKETHIS says try later */
1965 case 436: /* IHAVE says try later */
1967 article_defer(art, RC_deferred);
1973 conn_maybe_write(conn);
1974 check_assign_articles();
1975 return OOP_CONTINUE;
1979 /*========== monitoring of input files ==========*/
1981 static void feedfile_eof(InputFile *ipf) {
1982 assert(ipf != main_input_file); /* promised by tailing_try_read */
1983 inputfile_reading_stop(ipf);
1985 if (ipf == flushing_input_file) {
1986 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1987 if (main_input_file) inputfile_reading_start(main_input_file);
1988 statemc_check_flushing_done();
1989 } else if (ipf == backlog_input_file) {
1990 statemc_check_backlog_done();
1992 abort(); /* supposed to wait rather than get EOF on main input file */
1996 static InputFile *open_input_file(const char *path) {
1997 int fd= open(path, O_RDWR);
1999 if (errno==ENOENT) return 0;
2000 sysfatal("unable to open input file %s", path);
2004 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2005 memset(ipf,0,sizeof(*ipf));
2009 LIST_INIT(ipf->queue);
2010 strcpy(ipf->path, path);
2015 static void close_input_file(InputFile *ipf) { /* does not free */
2016 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2017 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2018 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2019 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2020 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2024 /*---------- dealing with articles read in the input file ----------*/
2026 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2027 const char *data, const char *how) {
2028 warn("corrupted file: %s, offset %lu: %s: in %s",
2029 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2030 ipf->readcount_err++;
2031 if (ipf->readcount_err > max_bad_data_initial +
2032 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2033 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2034 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2035 return OOP_CONTINUE;
2038 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2039 oop_rd_event ev, const char *errmsg,
2040 int errnoval, const char *data, size_t recsz,
2042 InputFile *ipf= ipf_v;
2043 assert(ev == OOP_RD_SYSTEM);
2045 sysdie("error reading input file: %s, offset %lu",
2046 ipf->path, (unsigned long)ipf->offset);
2049 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2050 oop_rd_event ev, const char *errmsg,
2051 int errnoval, const char *data, size_t recsz,
2053 InputFile *ipf= ipf_v;
2055 char tokentextbuf[sizeof(TOKEN)*2+3];
2057 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2059 off_t old_offset= ipf->offset;
2060 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2062 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2064 if (ev==OOP_RD_PARTREC)
2065 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2066 /* but process it anyway */
2068 if (ipf->skippinglong) {
2069 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2070 return OOP_CONTINUE;
2072 if (ev==OOP_RD_LONG) {
2073 ipf->skippinglong= 1;
2074 X_BAD_DATA("overly long line");
2077 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2078 if (!recsz) X_BAD_DATA("empty line");
2081 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2082 ipf->readcount_blank++;
2083 return OOP_CONTINUE;
2086 char *space= strchr(data,' ');
2087 int tokenlen= space-data;
2088 int midlen= (int)recsz-tokenlen-1;
2089 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2090 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2092 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2093 memcpy(tokentextbuf, data, tokenlen);
2094 tokentextbuf[tokenlen]= 0;
2095 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2097 ipf->readcount_ok++;
2099 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2100 memset(art,0,sizeof(*art));
2101 art->state= art_Unchecked;
2102 art->midlen= midlen;
2103 art->ipf= ipf; ipf->inprogress++;
2104 art->token= TextToToken(tokentextbuf);
2105 art->offset= old_offset;
2106 art->blanklen= recsz;
2107 strcpy(art->messageid, space+1);
2108 LIST_ADDTAIL(ipf->queue, art);
2110 if (ipf->autodefer >= 0)
2111 article_autodefer(ipf, art);
2112 else if (ipf==backlog_input_file)
2113 article_check_expired(art);
2115 if (sms==sm_NORMAL && ipf==main_input_file &&
2116 ipf->offset >= target_max_feedfile_size)
2117 statemc_start_flush("feed file size");
2119 check_assign_articles(); /* may destroy conn but that's OK */
2120 check_reading_pause_resume(ipf);
2121 return OOP_CONTINUE;
2124 /*========== tailing input file ==========*/
2126 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2128 /* lifetime of ipf here is OK because destruction will cause
2129 * on_cancel which will cancel this callback */
2130 InputFile *ipf= user;
2132 if (!ipf->fake_readable) return OOP_CONTINUE;
2134 /* we just keep calling readable until our caller (oop_rd)
2135 * has called try_read, and try_read has found EOF so given EAGAIN */
2136 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2138 return ipf->readable_callback(loop, &ipf->readable,
2139 ipf->readable_callback_user);
2142 static void tailing_on_cancel(struct oop_readable *rable) {
2143 InputFile *ipf= (void*)rable;
2145 if (ipf->filemon) filemon_stop(ipf);
2146 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2147 ipf->readable_callback= 0;
2150 static void tailing_make_readable(InputFile *ipf) {
2151 if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2153 ipf->fake_readable= 1;
2154 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2157 static int tailing_on_readable(struct oop_readable *rable,
2158 oop_readable_call *cb, void *user) {
2159 InputFile *ipf= (void*)rable;
2161 tailing_on_cancel(rable);
2162 ipf->readable_callback= cb;
2163 ipf->readable_callback_user= user;
2165 tailing_make_readable(ipf);
2169 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2171 InputFile *ipf= (void*)rable;
2173 ssize_t r= read(ipf->fd, buffer, length);
2175 if (errno==EINTR) continue;
2176 ipf->fake_readable= 0;
2180 if (ipf==main_input_file) {
2182 ipf->fake_readable= 0;
2184 } else if (ipf==flushing_input_file) {
2186 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2187 } else if (ipf==backlog_input_file) {
2197 /*---------- filemon implemented with inotify ----------*/
2199 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2200 #define HAVE_FILEMON
2202 #include <sys/inotify.h>
2204 static int filemon_inotify_fd;
2205 static int filemon_inotify_wdmax;
2206 static InputFile **filemon_inotify_wd2ipf;
2208 struct Filemon_Perfile {
2212 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2213 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2214 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2216 if (wd >= filemon_inotify_wdmax) {
2218 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2219 sizeof(*filemon_inotify_wd2ipf) * newmax);
2220 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2221 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2222 filemon_inotify_wdmax= newmax;
2225 assert(!filemon_inotify_wd2ipf[wd]);
2226 filemon_inotify_wd2ipf[wd]= ipf;
2228 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2229 ipf, wd, filemon_inotify_wdmax);
2234 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2236 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2237 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2238 if (r) sysdie("inotify_rm_watch");
2239 filemon_inotify_wd2ipf[wd]= 0;
2242 static void *filemon_inotify_readable(oop_source *lp, int fd,
2243 oop_event e, void *u) {
2244 struct inotify_event iev;
2246 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2248 if (isewouldblock(errno)) break;
2249 sysdie("read from inotify master");
2250 } else if (r==sizeof(iev)) {
2251 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2253 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2255 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2256 /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2257 tailing_make_readable(ipf);
2259 return OOP_CONTINUE;
2262 static int filemon_method_init(void) {
2263 filemon_inotify_fd= inotify_init();
2264 if (filemon_inotify_fd<0) {
2265 syswarn("filemon/inotify: inotify_init failed");
2268 xsetnonblock(filemon_inotify_fd, 1);
2269 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2271 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2275 static void filemon_method_dump_info(FILE *f) {
2277 fprintf(f,"inotify");
2278 DUMPV("%d",,filemon_inotify_fd);
2279 DUMPV("%d",,filemon_inotify_wdmax);
2280 for (i=0; i<filemon_inotify_wdmax; i++)
2281 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2284 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2286 /*---------- filemon dummy implementation ----------*/
2288 #if !defined(HAVE_FILEMON)
2290 struct Filemon_Perfile { int dummy; };
2292 static int filemon_method_init(void) {
2293 warn("filemon/dummy: no filemon method compiled in");
2296 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2297 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2298 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2300 #endif /* !HAVE_FILEMON */
2302 /*---------- filemon generic interface ----------*/
2304 static void filemon_start(InputFile *ipf) {
2305 assert(!ipf->filemon);
2308 filemon_method_startfile(ipf, ipf->filemon);
2311 static void filemon_stop(InputFile *ipf) {
2312 if (!ipf->filemon) return;
2313 filemon_method_stopfile(ipf, ipf->filemon);
2318 /*---------- interface to start and stop an input file ----------*/
2320 static const oop_rd_style feedfile_rdstyle= {
2321 OOP_RD_DELIM_STRIP, '\n',
2323 OOP_RD_SHORTREC_LONG,
2326 static void inputfile_reading_resume(InputFile *ipf) {
2327 if (!ipf->rd) return;
2328 if (!ipf->paused) return;
2330 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2331 feedfile_got_article,ipf, feedfile_read_err, ipf);
2332 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2337 static void inputfile_reading_pause(InputFile *ipf) {
2338 if (!ipf->rd) return;
2339 if (ipf->paused) return;
2340 oop_rd_cancel(ipf->rd);
2344 static void inputfile_reading_start(InputFile *ipf) {
2346 ipf->readable.on_readable= tailing_on_readable;
2347 ipf->readable.on_cancel= tailing_on_cancel;
2348 ipf->readable.try_read= tailing_try_read;
2349 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2350 ipf->readable.delete_kill= 0;
2352 ipf->readable_callback= 0;
2353 ipf->readable_callback_user= 0;
2355 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2359 inputfile_reading_resume(ipf);
2362 static void inputfile_reading_stop(InputFile *ipf) {
2364 inputfile_reading_pause(ipf);
2365 oop_rd_delete(ipf->rd);
2367 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2371 /*========== interaction with innd - state machine ==========*/
2373 /* See official state diagram at top of file. We implement
2384 |`---------------------------------------------------.
2386 |`---------------- - - - |
2387 D ENOENT | D EXISTS see OVERALL STATES diagram |
2388 | for full startup logic |
2391 | ============ try to |
2397 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2398 ^ | hardlink F to D |
2401 | | our handle onto F is now onto D |
2404 | |<-------------------<---------------------<---------+
2406 | | spawn inndcomm flush |
2408 | ================== |
2409 | FLUSHING[-ABSENT] |
2411 | main D tail/none |
2412 | ================== |
2414 | | INNDCOMM FLUSH FAILS ^
2415 | |`----------------------->----------. |
2417 | | NO SUCH SITE V |
2418 ^ |`--------------->----. ==================== |
2419 | | \ FLUSHFAILED[-ABSENT] |
2421 | | FLUSH OK \ main D tail/none |
2422 | | open F \ ==================== |
2424 | | \ | TIME TO RETRY |
2425 | |`------->----. ,---<---'\ `----------------'
2426 | | D NONE | | D NONE `----.
2428 | ============= V V ============
2429 | SEPARATED-1 | | DROPPING-1
2430 | flsh->rd!=0 | | flsh->rd!=0
2431 | [Separated] | | [Dropping]
2432 | main F idle | | main none
2433 | flsh D tail | | flsh D tail
2434 | ============= | | ============
2436 ^ | EOF ON D | | defer | EOF ON D
2438 | =============== | | ===============
2439 | SEPARATED-2 | | DROPPING-2
2440 | flsh->rd==0 | V flsh->rd==0
2441 | [Finishing] | | [Dropping]
2442 | main F tail | `. main none
2443 | flsh D closed | `. flsh D closed
2444 | =============== V `. ===============
2446 | | ALL D PROCESSED `. | ALL D PROCESSED
2447 | V install defer as backlog `. | install defer
2448 ^ | close D `. | close D
2449 | | unlink D `. | unlink D
2452 `----------' ==============
2472 static void startup_set_input_file(InputFile *f) {
2473 assert(!main_input_file);
2475 inputfile_reading_start(f);
2478 static void statemc_lock(void) {
2480 struct stat stab, stabf;
2483 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2484 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2487 memset(&fl,0,sizeof(fl));
2489 fl.l_whence= SEEK_SET;
2490 int r= fcntl(lockfd, F_SETLK, &fl);
2492 if (errno==EACCES || isewouldblock(errno)) {
2493 if (quiet_multiple) exit(0);
2494 fatal("another duct holds the lockfile");
2496 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2499 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2501 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2503 if (!lock_noent && samefile(&stab, &stabf))
2506 xclose(lockfd, "stale lockfile ", path_lock);
2509 FILE *lockfile= fdopen(lockfd, "w");
2510 if (!lockfile) sysdie("fdopen lockfile");
2512 int r= ftruncate(lockfd, 0);
2513 if (r) sysdie("truncate lockfile to write new info");
2515 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2516 (unsigned long)self_pid,
2517 sitename, feedfile, remote_host) == EOF ||
2519 sysfatal("write info to lockfile %s", path_lock);
2521 debug("startup: locked");
2524 static void statemc_init(void) {
2525 struct stat stabdefer;
2527 search_backlog_file();
2530 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2532 debug("startup: ductdefer ENOENT");
2534 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2535 switch (stabdefer.st_nlink==1) {
2537 open_defer(); /* so that we will later close it and rename it */
2540 xunlink(path_defer, "stale defer file link"
2541 " (presumably hardlink to backlog file)");
2544 die("defer file %s has unexpected link count %d",
2545 path_defer, stabdefer.st_nlink);
2549 struct stat stab_f, stab_d;
2552 InputFile *file_d= open_input_file(path_flushing);
2553 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2555 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2557 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2558 debug("startup: F==D => Hardlinked");
2559 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2564 debug("startup: F ENOENT => Moved");
2565 if (file_d) startup_set_input_file(file_d);
2566 spawn_inndcomm_flush("feedfile missing at startup");
2567 /* => Flushing, sms:=FLUSHING */
2570 debug("startup: F!=D => Separated");
2571 startup_set_input_file(file_d);
2572 flushing_input_file= main_input_file;
2573 main_input_file= open_input_file(feedfile);
2574 if (!main_input_file) die("feedfile vanished during startup");
2575 SMS(SEPARATED, max_separated_periods,
2576 "found both old and current feed files");
2578 debug("startup: F exists, D ENOENT => Normal");
2579 InputFile *file_f= open_input_file(feedfile);
2580 if (!file_f) die("feed file vanished during startup");
2581 startup_set_input_file(file_f);
2582 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2587 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2588 assert(sms == sm_NORMAL);
2590 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2592 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2593 (unsigned long)target_max_feedfile_size,
2596 int r= link(feedfile, path_flushing);
2597 if (r) sysfatal("link feedfile %s to flushing file %s",
2598 feedfile, path_flushing);
2601 xunlink(feedfile, "old feedfile link");
2604 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2607 static int trigger_flush_ok(const char *why) {
2611 statemc_start_flush(why ? why : "periodic");
2612 return 1; /* Normal => Flushing; => FLUSHING */
2614 case sm_FLUSHFAILED:
2615 spawn_inndcomm_flush(why ? why : "retry");
2616 return 1; /* Moved => Flushing; => FLUSHING */
2620 warn("abandoning old feedfile after flush (%s), autodeferring",
2621 why ? why : "took too long to complete");
2622 assert(flushing_input_file);
2623 autodefer_input_file(flushing_input_file);
2631 static void statemc_period_poll(void) {
2632 if (!until_flush) return;
2634 assert(until_flush>=0);
2636 if (until_flush) return;
2637 int ok= trigger_flush_ok(0);
2641 static int inputfile_is_done(InputFile *ipf) {
2643 if (ipf->inprogress) return 0; /* new article in the meantime */
2644 if (ipf->rd) return 0; /* not had EOF */
2648 static void notice_processed(InputFile *ipf, int completed,
2649 const char *what, const char *spec) {
2650 if (!ipf) return; /* allows preterminate to be lazy */
2652 #define RCI_NOTHING(x) /* nothing */
2653 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2654 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2656 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2658 char *inprog= completed
2659 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2660 : xasprintf(" inprogress=%ld", ipf->inprogress);
2661 char *autodefer= ipf->autodefer >= 0
2662 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2663 : xasprintf("%s","");
2665 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2666 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2667 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2669 completed?"completed":"processed", what, spec,
2670 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2671 inprog, autodefer, ipf->count_nooffer_missing,
2672 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2673 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2674 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2675 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2676 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2685 static void statemc_check_backlog_done(void) {
2686 InputFile *ipf= backlog_input_file;
2687 if (!inputfile_is_done(ipf)) return;
2689 const char *slash= strrchr(ipf->path, '/');
2690 const char *leaf= slash ? slash+1 : ipf->path;
2691 const char *under= strchr(slash, '_');
2692 const char *rest= under ? under+1 : leaf;
2693 if (!strncmp(rest,"backlog",7)) rest += 7;
2694 notice_processed(ipf,1,"backlog ",rest);
2696 close_input_file(ipf);
2697 if (unlink(ipf->path)) {
2698 if (errno != ENOENT)
2699 sysdie("could not unlink processed backlog file %s", ipf->path);
2700 warn("backlog file %s vanished while we were reading it"
2701 " so we couldn't remove it (but it's done now, anyway)",
2705 backlog_input_file= 0;
2706 search_backlog_file();
2710 static void statemc_check_flushing_done(void) {
2711 InputFile *ipf= flushing_input_file;
2712 if (!inputfile_is_done(ipf)) return;
2714 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2716 notice_processed(ipf,1,"feedfile","");
2720 xunlink(path_flushing, "old flushing file");
2722 close_input_file(flushing_input_file);
2723 free(flushing_input_file);
2724 flushing_input_file= 0;
2726 if (sms==sm_SEPARATED) {
2727 notice("flush complete");
2728 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2729 } else if (sms==sm_DROPPING) {
2730 SMS(DROPPED, max_separated_periods, "old flush complete");
2731 search_backlog_file();
2732 notice("feed dropped, but will continue until backlog is finished");
2736 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2738 assert(!inputfile_is_done(main_input_file));
2739 statemc_check_flushing_done();
2740 statemc_check_backlog_done();
2741 return OOP_CONTINUE;
2744 static void queue_check_input_done(void) {
2745 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2748 static void statemc_setstate(StateMachineState newsms, int periods,
2749 const char *forlog, const char *why) {
2751 until_flush= periods;
2753 const char *xtra= "";
2756 case sm_FLUSHFAILED:
2757 if (!main_input_file) xtra= "-ABSENT";
2761 xtra= flushing_input_file->rd ? "-1" : "-2";
2767 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2769 info("state %s%s %s",forlog,xtra,why);
2773 /*---------- defer and backlog files ----------*/
2775 static void open_defer(void) {
2780 defer= fopen(path_defer, "a+");
2781 if (!defer) sysfatal("could not open defer file %s", path_defer);
2783 /* truncate away any half-written records */
2785 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2787 if (stab.st_size > LONG_MAX)
2788 die("defer file %s size is far too large", path_defer);
2793 long orgsize= stab.st_size;
2794 long truncto= stab.st_size;
2796 if (!truncto) break; /* was only (if anything) one half-truncated record */
2797 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2798 sysdie("seek in defer file %s while truncating partial", path_defer);
2803 sysdie("failed read from defer file %s", path_defer);
2805 die("defer file %s shrank while we were checking it!", path_defer);
2811 if (stab.st_size != truncto) {
2812 warn("truncating half-record at end of defer file %s -"
2813 " shrinking by %ld bytes from %ld to %ld",
2814 path_defer, orgsize - truncto, orgsize, truncto);
2817 sysfatal("could not flush defer file %s", path_defer);
2818 if (ftruncate(fileno(defer), truncto))
2819 sysdie("could not truncate defer file %s", path_defer);
2822 info("continuing existing defer file %s (%ld bytes)",
2823 path_defer, orgsize);
2825 if (fseek(defer, truncto, SEEK_SET))
2826 sysdie("could not seek to new end of defer file %s", path_defer);
2829 static void close_defer(void) {
2834 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2836 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2839 time_t now= xtime();
2841 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2843 (unsigned long)stab.st_ino);
2844 if (link(path_defer, backlog))
2845 sysfatal("could not install defer file %s as backlog file %s",
2846 path_defer, backlog);
2847 if (unlink(path_defer))
2848 sysdie("could not unlink old defer link %s to backlog file %s",
2849 path_defer, backlog);
2853 if (until_backlog_nextscan < 0 ||
2854 until_backlog_nextscan > backlog_retry_minperiods + 1)
2855 until_backlog_nextscan= backlog_retry_minperiods + 1;
2858 static void poll_backlog_file(void) {
2859 if (until_backlog_nextscan < 0) return;
2860 if (until_backlog_nextscan-- > 0) return;
2861 search_backlog_file();
2864 static void search_backlog_file(void) {
2865 /* returns non-0 iff there are any backlog files */
2870 const char *oldest_path=0;
2871 time_t oldest_mtime=0, now;
2873 if (backlog_input_file) return;
2877 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2881 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2883 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2885 for (i=0; i<gl.gl_pathc; i++) {
2886 const char *path= gl.gl_pathv[i];
2888 if (strchr(path,'#') || strchr(path,'~')) {
2889 debug("backlog file search skipping %s", path);
2892 r= stat(path, &stab);
2894 syswarn("failed to stat backlog file %s", path);
2897 if (!S_ISREG(stab.st_mode)) {
2898 warn("backlog file %s is not a plain file (or link to one)", path);
2901 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2903 oldest_mtime= stab.st_mtime;
2906 case GLOB_NOMATCH: /* fall through */
2909 sysdie("glob expansion of backlog pattern %s gave unexpected"
2910 " nonzero (error?) return value %d", globpat_backlog, r);
2914 debug("backlog scan: none");
2916 if (sms==sm_DROPPED) {
2918 notice("feed dropped and our work is complete");
2920 int r= unlink(path_cli);
2921 if (r && errno!=ENOENT)
2922 syswarn("failed to unlink cli socket for old feed");
2924 xunlink(path_lock, "lockfile for old feed");
2927 until_backlog_nextscan= backlog_spontrescan_periods;
2932 double age= difftime(now, oldest_mtime);
2933 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2935 if (age_deficiency <= 0) {
2936 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2937 age, age_deficiency, oldest_path);
2939 backlog_input_file= open_input_file(oldest_path);
2940 if (!backlog_input_file) {
2941 warn("backlog file %s vanished as we opened it", oldest_path);
2945 inputfile_reading_start(backlog_input_file);
2946 until_backlog_nextscan= -1;
2950 until_backlog_nextscan= age_deficiency / period_seconds;
2952 if (backlog_spontrescan_periods >= 0 &&
2953 until_backlog_nextscan > backlog_spontrescan_periods)
2954 until_backlog_nextscan= backlog_spontrescan_periods;
2956 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2957 age, age_deficiency, until_backlog_nextscan, oldest_path);
2964 /*---------- shutdown and signal handling ----------*/
2966 static void preterminate(void) {
2967 if (in_child) return;
2968 notice_processed(main_input_file,0,"feedfile","");
2969 notice_processed(flushing_input_file,0,"flushing","");
2970 if (backlog_input_file)
2971 notice_processed(backlog_input_file,0, "backlog file ",
2972 backlog_input_file->path);
2975 static int signal_self_pipe[2];
2976 static sig_atomic_t terminate_sig_flag;
2978 static void raise_default(int signo) {
2979 xsigsetdefault(signo);
2984 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
2985 assert(fd=signal_self_pipe[0]);
2987 int r= read(signal_self_pipe[0], buf, sizeof(buf));
2988 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
2989 if (r==0) die("eof on signal self pipe");
2990 if (terminate_sig_flag) {
2992 notice("terminating (%s)", strsignal(terminate_sig_flag));
2993 raise_default(terminate_sig_flag);
2995 return OOP_CONTINUE;
2998 static void sigarrived_handler(int signum) {
3003 if (!terminate_sig_flag) terminate_sig_flag= signum;
3008 write(signal_self_pipe[1],&x,1);
3011 static void init_signals(void) {
3012 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3013 sysdie("could not ignore SIGPIPE");
3015 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3017 xsetnonblock(signal_self_pipe[0],1);
3018 xsetnonblock(signal_self_pipe[1],1);
3020 struct sigaction sa;
3021 memset(&sa,0,sizeof(sa));
3022 sa.sa_handler= sigarrived_handler;
3023 sa.sa_flags= SA_RESTART;
3024 xsigaction(SIGTERM,&sa);
3025 xsigaction(SIGINT,&sa);
3027 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3030 /*========== flushing the feed ==========*/
3032 static pid_t inndcomm_child;
3033 static int inndcomm_sentinel_fd;
3035 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3036 assert(inndcomm_child);
3037 assert(fd == inndcomm_sentinel_fd);
3038 int status= xwaitpid(&inndcomm_child, "inndcomm");
3041 cancel_fd_read_except(fd);
3042 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3043 inndcomm_sentinel_fd= 0;
3045 assert(!flushing_input_file);
3047 if (WIFEXITED(status)) {
3048 switch (WEXITSTATUS(status)) {
3050 case INNDCOMMCHILD_ESTATUS_FAIL:
3053 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3054 notice("feed has been dropped by innd, finishing up");
3055 flushing_input_file= main_input_file;
3056 tailing_make_readable(flushing_input_file);
3057 /* we probably previously returned EAGAIN from our fake read method
3058 * when in fact we were at EOF, so signal another readable event
3059 * so we actually see the EOF */
3063 if (flushing_input_file) {
3064 SMS(DROPPING, max_separated_periods,
3065 "feed dropped by innd, but must finish last flush");
3068 SMS(DROPPED, 0, "feed dropped by innd");
3069 search_backlog_file();
3071 return OOP_CONTINUE;
3075 flushing_input_file= main_input_file;
3076 tailing_make_readable(flushing_input_file);
3078 main_input_file= open_input_file(feedfile);
3079 if (!main_input_file)
3080 die("flush succeeded but feedfile %s does not exist!", feedfile);
3082 if (flushing_input_file) {
3083 SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3086 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3088 return OOP_CONTINUE;
3091 goto unexpected_exitstatus;
3094 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3095 warn("flush timed out trying to talk to innd");
3098 unexpected_exitstatus:
3099 report_child_status("inndcomm child", status);
3103 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3104 return OOP_CONTINUE;
3107 static void inndcommfail(const char *what) {
3108 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3109 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3112 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3115 notice("flushing %s",why);
3117 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3118 assert(!inndcomm_child);
3119 assert(!inndcomm_sentinel_fd);
3121 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3123 inndcomm_child= xfork("inndcomm child");
3125 if (!inndcomm_child) {
3126 const char *flushargv[2]= { sitename, 0 };
3130 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3131 /* parent spots the autoclose of pipefds[1] when we die or exit */
3133 if (simulate_flush>=0) {
3134 warn("SIMULATING flush child status %d", simulate_flush);
3135 if (simulate_flush>128) raise(simulate_flush-128);
3136 else exit(simulate_flush);
3139 alarm(inndcomm_flush_timeout);
3140 r= ICCopen(); if (r) inndcommfail("connect");
3141 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3142 if (!r) exit(0); /* yay! */
3144 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3145 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3146 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3151 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3152 inndcomm_sentinel_fd= pipefds[0];
3153 assert(inndcomm_sentinel_fd);
3154 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3156 SMS(FLUSHING, 0, why);
3159 /*========== main program ==========*/
3161 static void postfork_inputfile(InputFile *ipf) {
3163 xclose(ipf->fd, "(in child) input file ", ipf->path);
3166 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3167 /* we have no stdio streams that are buffered long-term */
3169 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3172 static void postfork(void) {
3175 xsigsetdefault(SIGTERM);
3176 xsigsetdefault(SIGINT);
3177 xsigsetdefault(SIGPIPE);
3178 if (terminate_sig_flag) raise(terminate_sig_flag);
3180 postfork_inputfile(main_input_file);
3181 postfork_inputfile(flushing_input_file);
3185 conn_closefd(conn,"(in child) ");
3187 postfork_stdio(defer, "defer file ", path_defer);
3190 typedef struct Every Every;
3192 struct timeval interval;
3197 static void every_schedule(Every *e, struct timeval base);
3199 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3202 if (!e->fixed_rate) xgettimeofday(&base);
3203 every_schedule(e, base);
3204 return OOP_CONTINUE;
3207 static void every_schedule(Every *e, struct timeval base) {
3208 struct timeval when;
3209 timeradd(&base, &e->interval, &when);
3210 loop->on_time(loop, when, every_happens, e);
3213 static void every(int interval, int fixed_rate, void (*f)(void)) {
3214 NEW_DECL(Every *,e);
3215 e->interval.tv_sec= interval;
3216 e->interval.tv_usec= 0;
3217 e->fixed_rate= fixed_rate;
3220 xgettimeofday(&now);
3221 every_schedule(e, now);
3224 static void filepoll(void) {
3225 tailing_make_readable(main_input_file);
3226 tailing_make_readable(flushing_input_file);
3229 static char *debug_report_ipf(InputFile *ipf) {
3230 if (!ipf) return xasprintf("none");
3232 const char *slash= strrchr(ipf->path,'/');
3233 const char *path= slash ? slash+1 : ipf->path;
3235 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3237 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3238 (long)ipf->offset, ipf->fd,
3239 ipf->rd ? "" : ",!rd",
3240 ipf->skippinglong ? "*skiplong" : "",
3241 ipf->rd && ipf->paused ? "*paused" : "");
3244 static void period(void) {
3245 char *dipf_main= debug_report_ipf(main_input_file);
3246 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3247 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3250 " sms=%s[%d] conns=%d until_connect=%d"
3251 " input_files main:%s flushing:%s backlog:%s[%d]"
3252 " children connecting=%ld inndcomm=%ld"
3254 sms_names[sms], until_flush, conns.count, until_connect,
3255 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3256 (long)connecting_child, (long)inndcomm_child
3260 free(dipf_flushing);
3263 if (until_connect) until_connect--;
3265 inputfile_queue_check_expired(backlog_input_file);
3266 poll_backlog_file();
3267 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3268 statemc_period_poll();
3269 check_assign_articles();
3274 /*========== dumping state ==========*/
3276 static void dump_article_list(FILE *f, const CliCommand *c,
3277 const ArticleList *al) {
3278 fprintf(f, " count=%d\n", al->count);
3279 if (!c->xval) return;
3281 int i; Article *art;
3282 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3283 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3284 DUMPV("%p", art->,ipf);
3285 DUMPV("%d", art->,missing);
3286 DUMPV("%lu", (unsigned long)art->,offset);
3287 DUMPV("%d", art->,blanklen);
3288 DUMPV("%d", art->,midlen);
3289 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3293 static void dump_input_file(FILE *f, const CliCommand *c,
3294 InputFile *ipf, const char *wh) {
3295 char *dipf= debug_report_ipf(ipf);
3296 fprintf(f,"input %s %s", wh, dipf);
3300 DUMPV("%d", ipf->,readcount_ok);
3301 DUMPV("%d", ipf->,readcount_blank);
3302 DUMPV("%d", ipf->,readcount_err);
3303 DUMPV("%d", ipf->,count_nooffer_missing);
3307 ArtState state; const char *const *statename;
3308 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3309 #define RC_DUMP_FMT(x) " " #x "=%d"
3310 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3311 fprintf(f,"input %s counts %-11s"
3312 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3314 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3316 fprintf(f,"input %s queue", wh);
3317 dump_article_list(f,c,&ipf->queue);
3323 fprintf(cc->out, "dumping state to %s\n", path_dump);
3324 FILE *f= fopen(path_dump, "w");
3325 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3327 fprintf(f,"general");
3328 DUMPV("%s", sms_names,[sms]);
3329 DUMPV("%d", ,until_flush);
3330 DUMPV("%ld", (long),self_pid);
3331 DUMPV("%p", , defer);
3332 DUMPV("%d", , until_connect);
3333 DUMPV("%d", , until_backlog_nextscan);
3334 DUMPV("%d", , simulate_flush);
3335 fprintf(f,"\nnocheck");
3336 DUMPV("%#.10f", , accept_proportion);
3337 DUMPV("%d", , nocheck);
3338 DUMPV("%d", , nocheck_reported);
3341 fprintf(f,"special");
3342 DUMPV("%ld", (long),connecting_child);
3343 DUMPV("%d", , connecting_fdpass_sock);
3344 DUMPV("%d", , cli_master);
3347 fprintf(f,"filemon ");
3348 filemon_method_dump_info(f);
3350 dump_input_file(f,c, main_input_file, "main" );
3351 dump_input_file(f,c, flushing_input_file, "flushing");
3352 dump_input_file(f,c, backlog_input_file, "backlog" );
3354 fprintf(f,"conns count=%d\n", conns.count);
3359 fprintf(f,"C%d",conn->fd);
3360 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3361 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3362 DUMPV("%d",conn->,since_activity);
3365 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3366 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3367 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3369 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3370 for (i=0; i<conn->xmitu; i++) {
3371 const struct iovec *iv= &conn->xmit[i];
3372 const XmitDetails *xd= &conn->xmitd[i];
3375 case xk_Const: dinfo= xasprintf("Const"); break;
3376 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3380 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3381 sanitise(iv->iov_base, iv->iov_len));
3387 DUMPV("%s", , feedfile);
3388 DUMPV("%s", , path_cli);
3389 DUMPV("%s", , path_lock);
3390 DUMPV("%s", , path_flushing);
3391 DUMPV("%s", , path_defer);
3392 DUMPV("%s", , path_dump);
3393 DUMPV("%s", , globpat_backlog);
3396 if (!!ferror(f) + !!fclose(f)) {
3397 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3402 /*========== option parsing ==========*/
3404 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3405 static void vbadusage(const char *fmt, va_list al) {
3406 char *m= xvasprintf(fmt,al);
3407 fprintf(stderr, "bad usage: %s\n"
3408 "say --help for help, or read the manpage\n",
3411 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3415 /*---------- generic option parser ----------*/
3417 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3418 static void badusage(const char *fmt, ...) {
3425 of_seconds= 001000u,
3426 of_boolean= 002000u,
3429 typedef struct Option Option;
3430 typedef void OptionParser(const Option*, const char *val);
3434 const char *lng, *formarg;
3440 static void parse_options(const Option *options, char ***argvp) {
3441 /* on return *argvp is first non-option arg; argc is not updated */
3444 const char *arg= *++(*argvp);
3446 if (*arg != '-') break;
3447 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3449 while ((a= *++arg)) {
3453 char *equals= strchr(arg,'=');
3454 int len= equals ? (equals - arg) : strlen(arg);
3455 for (o=options; o->shrt || o->lng; o++)
3456 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3458 badusage("unknown long option --%s",arg);
3461 if (equals) badusage("option --%s does not take a value",o->lng);
3463 } else if (equals) {
3467 if (!arg) badusage("option --%s needs a value for %s",
3468 o->lng, o->formarg);
3471 break; /* eaten the whole argument now */
3473 for (o=options; o->shrt || o->lng; o++)
3476 badusage("unknown short option -%c",a);
3483 if (!arg) badusage("option -%c needs a value for %s",
3484 o->shrt, o->formarg);
3487 break; /* eaten the whole argument now */
3493 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3495 static void print_options(const Option *options, FILE *f) {
3497 for (o=options; o->shrt || o->lng; o++) {
3498 char shrt[2] = { o->shrt, 0 };
3499 char *optspec= xasprintf("%s%s%s%s%s",
3500 o->shrt ? "-" : "", shrt,
3501 o->shrt && o->lng ? "|" : "",
3502 DELIMPERHAPS("--", o->lng));
3503 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3508 /*---------- specific option types ----------*/
3510 static void op_integer(const Option *o, const char *val) {
3513 unsigned long ul= strtoul(val,&ep,10);
3514 if (*ep || ep==val || errno || ul>INT_MAX)
3515 badusage("bad integer value for %s",o->lng);
3516 int *store= o->store;
3520 static void op_double(const Option *o, const char *val) {
3521 int *store= o->store;
3524 *store= strtod(val, &ep);
3525 if (*ep || ep==val || errno)
3526 badusage("bad floating point value for %s",o->lng);
3529 static void op_string(const Option *o, const char *val) {
3530 const char **store= o->store;
3534 static void op_seconds(const Option *o, const char *val) {
3535 int *store= o->store;
3539 double v= strtod(val,&ep);
3540 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3542 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3543 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3544 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3545 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3546 else if (!strcmp(ep,"das")) unit= 10;
3547 else if (!strcmp(ep,"hs")) unit= 100;
3548 else if (!strcmp(ep,"ks")) unit= 1000;
3549 else if (!strcmp(ep,"Ms")) unit= 1000000;
3550 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3554 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3558 static void op_setint(const Option *o, const char *val) {
3559 int *store= o->store;
3563 /*---------- specific options ----------*/
3565 static void help(const Option *o, const char *val);
3567 static const Option innduct_options[]= {
3568 {'f',"feedfile", "F", &feedfile, op_string },
3569 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3570 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3571 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3572 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3573 {'C',"inndconf", "F", &inndconffile, op_string },
3574 {'P',"port", "PORT", &port, op_integer },
3575 {0,"chdir", "DIR", &path_run, op_string },
3576 {0,"cli", "DIR/|PATH", &path_cli, op_string },
3577 {0,"help", 0, 0, help },
3579 {0,"max-connections", "N", &max_connections, op_integer },
3580 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3581 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3582 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3583 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3585 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3586 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3587 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3589 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3590 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3592 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3593 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3594 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3595 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3596 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3597 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3598 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3600 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3601 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3606 static void printusage(FILE *f) {
3607 fputs("usage: innduct [options] site [fqdn]\n"
3608 "available options are:\n", f);
3609 print_options(innduct_options, f);
3612 static void help(const Option *o, const char *val) {
3614 if (ferror(stdout) || fflush(stdout)) {
3615 perror("innduct: writing help");
3621 static void convert_to_periods_rndup(int *store) {
3622 *store += period_seconds-1;
3623 *store /= period_seconds;
3626 static int path_ends_slash(const char *specified) {
3627 int l= strlen(specified);
3629 return specified[l-1] == '/';
3632 int main(int argc, char **argv) {
3638 parse_options(innduct_options, &argv);
3643 if (!sitename) badusage("need site name argument");
3644 remote_host= *argv++;
3645 if (*argv) badusage("too many non-option arguments");
3649 int r= innconf_read(inndconffile);
3650 if (!r) badusage("could not read inn.conf (more info on stderr)");
3652 if (!remote_host) remote_host= sitename;
3654 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3655 badusage("nocheck threshold percentage must be between 0..100");
3656 nocheck_thresh *= 0.01;
3658 if (nocheck_decay < 0.1)
3659 badusage("nocheck decay articles must be at least 0.1");
3660 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3662 convert_to_periods_rndup(&reconnect_delay_periods);
3663 convert_to_periods_rndup(&flushfail_retry_periods);
3664 convert_to_periods_rndup(&backlog_retry_minperiods);
3665 convert_to_periods_rndup(&backlog_spontrescan_periods);
3666 convert_to_periods_rndup(&spontaneous_flush_periods);
3667 convert_to_periods_rndup(&max_separated_periods);
3668 convert_to_periods_rndup(&need_activity_periods);
3670 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3671 badusage("bad input data ratio must be between 0..100");
3672 max_bad_data_ratio *= 0.01;
3675 path_run= innconf->pathrun;
3678 feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3679 } else if (!feedfile[0]) {
3680 badusage("feed filename, if specified, must be nonempty");
3681 } else if (path_ends_slash(feedfile)) {
3682 feedfile= xasprintf("%s%s", feedfile, sitename);
3686 path_cli_dir= "innduct";
3687 } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3688 path_cli= 0; /* ok, don't then */
3689 } else if (path_ends_slash(path_cli)) {
3690 path_cli_dir= xasprintf("%.*s", strlen(path_cli)-1, path_cli);
3693 path_cli= xasprintf("%s/%s", path_cli_dir, sitename);
3695 if (max_queue_per_ipf<0)
3696 max_queue_per_ipf= max_queue_per_conn * 2;
3698 const char *feedfile_forbidden= "?*[~#";
3700 while ((c= *feedfile_forbidden++))
3701 if (strchr(feedfile, c))
3702 badusage("feed filename may not contain metacharacter %c",c);
3707 if (r) sysdie("could not chdir to pathrun %s", path_run);
3709 path_lock= xasprintf("%s_lock", feedfile);
3710 path_flushing= xasprintf("%s_flushing", feedfile);
3711 path_defer= xasprintf("%s_defer", feedfile);
3712 path_dump= xasprintf("%s_dump", feedfile);
3713 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3715 oop_source_sys *sysloop= oop_sys_new();
3716 if (!sysloop) sysdie("could not create liboop event loop");
3717 loop= (oop_source*)sysloop;
3721 if (become_daemon) {
3723 for (i=3; i<255; i++)
3724 /* do this now before we open syslog, etc. */
3726 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3728 int null= open("/dev/null",O_RDWR);
3729 if (null<0) sysfatal("failed to open /dev/null");
3733 xclose(null, "/dev/null original fd",0);
3735 pid_t child1= xfork("daemonise first fork");
3736 if (child1) _exit(0);
3738 pid_t sid= setsid();
3739 if (sid == -1) sysfatal("setsid failed");
3741 pid_t child2= xfork("daemonise second fork");
3742 if (child2) _exit(0);
3746 if (self_pid==-1) sysdie("getpid");
3755 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3756 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3765 notice("filemon: suppressed by command line option, polling");
3767 filemon_ok= filemon_method_init();
3769 warn("filemon: no file monitoring available, polling");
3772 every(filepoll_seconds,0,filepoll);
3774 every(period_seconds,1,period);
3780 void *run= oop_sys_run(sysloop);
3781 assert(run == OOP_ERROR);
3782 sysdie("event loop failed");