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.)
29 * build-lfs/backends/innduct --connection-timeout=30 --no-daemon -C ../inn.conf -f `pwd`/fee sit localhost
33 * Newsfeeds file entries should look like this:
34 * host.name.of.site[/exclude,exclude,...]\
35 * :pattern,pattern...[/distribution,distribution...]\
39 * sitename[/exclude,exclude,...]\
40 * :pattern,pattern...[/distribution,distribution...]\
46 * or might be blanked out
47 * <spc><spc><spc><spc>....
49 * F site.name main feed file
50 * opened/created, then written, by innd
53 * tokens blanked out by duct when processed
54 * site.name_lock lock preventing multiple ducts
55 * to hold lock must open,F_SETLK[W]
56 * and then stat to check that locked file
57 * still has name site.name_lock
58 * holder of this lock is "duct"
59 * (only) lockholder may remove the lockfile
60 * D site.name_flushing temporary feed file during flush (or crash)
61 * hardlink created by duct
63 * site.name_defer 431'd articles, still being written,
64 * created, written, used by duct
66 * site.name_backlog.<date>.<inum>
67 * 431'd articles, ready for innxmit or duct
68 * created (link/mv) by duct
69 * site.name_backlog<anything-else> (where <anything-else> does not
70 * contain '#' or '~') eg
71 * site.name_backlog.manual
72 * anything the sysadmin likes (eg, feed files
73 * from old feeds to be merged into this one)
74 * created (link/mv) by admin
75 * may be symlinks (in which case links
76 * may be written through, but only links
79 * It is safe to remove backlog files manually,
80 * if it's desired to throw away the backlog.
82 * Backlog files are also processed by innduct. We find the oldest
83 * backlog file which is at least a certain amount old, and feed it
84 * back into our processing. When every article in it has been read
85 * and processed, we unlink it and look for another backlog file.
87 * If we don't have a backlog file that we're reading, we close the
88 * defer file that we're writing and make it into a backlog file at
89 * the first convenient opportunity.
100 | | <----------------<---------------------------------'|
106 | F: innd writing, duct reading |
109 | | duct decides time to flush |
110 | | duct makes hardlink |
112 | V <------------------------'|
114 | F == D: innd writing, duct reading both exist |
117 | | <-----------<-------------<--'|
118 | | open D F ENOENT |
121 | V <---------------------. |
124 | D: innd writing, duct reading; or ENOENT | |
126 | | duct requests flush of feed | |
127 | | (others can too, harmlessly) | |
131 | D: innd flushing, duct; or ENOENT | |
133 | | inndcomm flush fails | |
134 | |`-------------------------->------------------' |
136 | | inndcomm reports no such site |
137 | |`---------------------------------------------------- | -.
139 | | innd finishes writing D, creates F | |
140 | | inndcomm reports flush successful | |
143 | Separated <----------------' |
144 | F: innd writing F!=D /
145 | D: duct reading; or ENOENT both exist /
147 | | duct gets to the end of D /
148 | | duct opens F too /
151 | F: innd writing, duct reading |
152 | D: duct finishing V
154 | | duct finishes processing D F: ENOENT
155 | V duct unlinks D D: duct reading
157 `--<--' | duct finishes
167 "duct reading" means innduct is reading the file but also
168 overwriting processed tokens.
172 * rune for printing diagrams:
174 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
179 /*============================== PROGRAM ==============================*/
181 #define _GNU_SOURCE 1
187 #include "inndcomm.h"
189 #include "inn/list.h"
190 #include "inn/innconf.h"
193 #include <sys/types.h>
194 #include <sys/wait.h>
195 #include <sys/stat.h>
196 #include <sys/socket.h>
215 #include <oop-read.h>
217 /*----- general definitions, probably best not changed -----*/
219 #define CONNCHILD_ESTATUS_STREAM 24
220 #define CONNCHILD_ESTATUS_NOSTREAM 25
222 #define INNDCOMMCHILD_ESTATUS_FAIL 26
223 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
225 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
226 #define MAX_CONTROL_COMMAND 1000
228 #define VA va_list al; va_start(al,fmt)
229 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
230 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
231 #define NORET __attribute__((__noreturn__))
233 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
234 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
236 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
238 #define FOR_CONN(conn) \
239 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
241 /*----- doubly linked lists -----*/
243 #define ISNODE(T) struct node list_node
246 union { struct list li; T *for_type; } u; \
250 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
252 #define LIST_CHECKCANHAVENODE(l,n) \
253 ((void)((n) == ((l).u.for_type))) /* just for the type check */
255 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
256 ( LIST_CHECKCANHAVENODE(l,n), \
257 list_addsomehow(&(l).u.li, NODE((n))), \
261 #define LIST_REMSOMEHOW(l,list_remsomehow) \
262 ( (typeof((l).u.for_type)) \
265 list_remsomehow(&(l).u.li) ) \
271 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
272 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
273 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
274 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
276 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
277 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
278 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
279 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
281 #define LIST_REMOVE(l,n) \
282 ( LIST_CHECKCANHAVENODE(l,n), \
283 list_remove(NODE((n))), \
287 #define LIST_INSERT(l,n,pred) \
288 ( LIST_CHECKCANHAVENODE(l,n), \
289 LIST_CHECKCANHAVENODE(l,pred), \
290 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
294 /*----- type predeclarations -----*/
296 typedef struct Conn Conn;
297 typedef struct Article Article;
298 typedef struct InputFile InputFile;
299 typedef struct XmitDetails XmitDetails;
300 typedef struct Filemon_Perfile Filemon_Perfile;
301 typedef enum StateMachineState StateMachineState;
302 typedef struct ControlCommand ControlCommand;
307 /*----- function predeclarations -----*/
309 static void conn_maybe_write(Conn *conn);
310 static void conn_make_some_xmits(Conn *conn);
311 static void *conn_write_some_xmits(Conn *conn);
313 static void xmit_free(XmitDetails *d);
315 #define SMS(newstate, periods, why) \
316 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
317 static void statemc_setstate(StateMachineState newsms, int periods,
318 const char *forlog, const char *why);
320 static void statemc_start_flush(const char *why); /* Normal => Flushing */
321 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
322 static int trigger_flush_ok(void); /* => Flushing,FLUSHING, ret 1; or ret 0 */
324 static void article_done(Article *art, int whichcount);
326 static void check_assign_articles(void);
327 static void queue_check_input_done(void);
328 static void check_reading_pause_resume(InputFile *ipf);
330 static void statemc_check_flushing_done(void);
331 static void statemc_check_backlog_done(void);
333 static void postfork(void);
334 static void period(void);
336 static void open_defer(void);
337 static void close_defer(void);
338 static void search_backlog_file(void);
339 static void preterminate(void);
340 static void raise_default(int signo) NORET;
341 static char *debug_report_ipf(InputFile *ipf);
343 static void inputfile_reading_start(InputFile *ipf);
344 static void inputfile_reading_stop(InputFile *ipf);
345 static void inputfile_reading_pause(InputFile *ipf);
346 static void inputfile_reading_resume(InputFile *ipf);
347 /* pause and resume are idempotent, and no-op if not done _reading_start */
349 static void filemon_start(InputFile *ipf);
350 static void filemon_stop(InputFile *ipf);
351 static void filemon_callback(InputFile *ipf);
353 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
354 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
356 static const oop_rd_style peer_rd_style;
357 static oop_rd_call peer_rd_err, peer_rd_ok;
359 /*----- configuration options -----*/
360 /* when changing defaults, remember to update the manpage */
362 static const char *sitename, *remote_host;
363 static const char *feedfile, *realsockdir="/tmp/innduct.control";
364 static int quiet_multiple=0;
365 static int become_daemon=1, try_filemon=1;
366 static int try_stream=1;
368 static const char *inndconffile;
370 static int max_connections=10;
371 static int max_queue_per_conn=200;
372 static int target_max_feedfile_size=100000;
373 static int period_seconds=60;
374 static int filepoll_seconds=5;
375 static int max_queue_per_ipf=-1;
377 static int connection_setup_timeout=200;
378 static int inndcomm_flush_timeout=100;
380 static double nocheck_thresh= 95.0; /* converted from percentage by main */
381 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
383 /* all these are initialised to seconds, and converted to periods in main */
384 static int reconnect_delay_periods=1000;
385 static int flushfail_retry_periods=1000;
386 static int backlog_retry_minperiods=50;
387 static int backlog_spontrescan_periods=300;
388 static int spontaneous_flush_periods=100000;
389 static int max_separated_periods=2000;
390 static int need_activity_periods=1000;
392 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
393 static int max_bad_data_initial= 30;
394 /* in one corrupt 4096-byte block the number of newlines has
395 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
398 /*----- statistics -----*/
400 typedef enum { /* in queue in conn->sent */
401 art_Unchecked, /* not checked, not sent checking */
402 art_Wanted, /* checked, wanted sent body as requested */
403 art_Unsolicited, /* - sent body without check */
407 static const char *const artstate_names[]=
408 { "Unchecked", "Wanted", "Unsolicited", 0 };
410 #define RESULT_COUNTS(RCS,RCN) \
419 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
420 #define RCI_TRIPLE_VALS_BASE(counts,x) \
421 counts[art_Unchecked] x \
422 + counts[art_Wanted] x \
423 + counts[art_Unsolicited] x, \
424 counts[art_Unchecked] x \
425 , counts[art_Wanted] x \
426 , counts[art_Unsolicited] x
429 #define RC_INDEX(x) RC_##x,
430 RESULT_COUNTS(RC_INDEX, RC_INDEX)
435 /*----- transmission buffers -----*/
451 /*----- core operational data structure types -----*/
454 /* This is also an instance of struct oop_readable */
455 struct oop_readable readable; /* first */
456 oop_readable_call *readable_callback;
457 void *readable_callback_user;
460 Filemon_Perfile *filemon;
462 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
464 int skippinglong, paused;
467 long inprogress; /* includes queue.count and also articles in conns */
468 long autodefer; /* -1 means not doing autodefer */
470 int counts[art_MaxState][RCI_max];
471 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
486 #define SMS_LIST(X) \
494 enum StateMachineState {
495 #define SMS_DEF_ENUM(s) sm_##s,
496 SMS_LIST(SMS_DEF_ENUM)
499 static const char *sms_names[]= {
500 #define SMS_DEF_NAME(s) #s ,
501 SMS_LIST(SMS_DEF_NAME)
507 int fd; /* may be 0, meaning closed (during construction/destruction) */
508 oop_read *rd; /* likewise */
509 int max_queue, stream, quitting;
510 int since_activity; /* periods */
511 ArticleList waiting; /* not yet told peer */
512 ArticleList priority; /* peer says send it now */
513 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
514 struct iovec xmit[CONNIOVS];
515 XmitDetails xmitd[CONNIOVS];
520 /*----- general operational variables -----*/
522 /* main initialises */
523 static oop_source *loop;
524 static ConnList conns;
525 static char *path_lock, *path_flushing, *path_defer;
526 static char *path_control, *path_dump;
527 static char *globpat_backlog;
528 static pid_t self_pid;
530 /* statemc_init initialises */
531 static StateMachineState sms;
532 static int until_flush;
533 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
536 /* initialisation to 0 is good */
537 static int until_connect, until_backlog_nextscan;
538 static double accept_proportion;
539 static int nocheck, nocheck_reported, in_child;
541 /* for simulation, debugging, etc. */
542 int simulate_flush= -1;
544 /*========== logging ==========*/
546 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
547 static void logcore(int sysloglevel, const char *fmt, ...) {
550 vsyslog(sysloglevel,fmt,al);
552 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
553 vfprintf(stderr,fmt,al);
559 static void logv(int sysloglevel, const char *pfx, int errnoval,
560 const char *fmt, va_list al) PRINTF(5,0);
561 static void logv(int sysloglevel, const char *pfx, int errnoval,
562 const char *fmt, va_list al) {
563 char msgbuf[256]; /* NB do not call xvasprintf here or you'll recurse */
564 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
565 msgbuf[sizeof(msgbuf)-1]= 0;
567 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
568 sysloglevel= LOG_ERR; /* run by wrong user, probably */
570 logcore(sysloglevel, "<%s>%s: %s%s%s",
571 sitename, pfx, msgbuf,
572 errnoval>=0 ? ": " : "",
573 errnoval>=0 ? strerror(errnoval) : "");
576 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
577 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
578 static void fn(const char *fmt, ...) { \
581 logv(sysloglevel, pfx, err, fmt, al); \
585 #define logwrap(fn, pfx, sysloglevel, err) \
586 static void fn(const char *fmt, ...) PRINTF(1,2); \
587 static void fn(const char *fmt, ...) { \
589 logv(sysloglevel, pfx, err, fmt, al); \
593 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
594 diewrap(die, " critical", LOG_CRIT, -1, 16);
596 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
597 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
599 logwrap(syswarn, " warning", LOG_WARNING, errno);
600 logwrap(warn, " warning", LOG_WARNING, -1);
602 logwrap(notice, " notice", LOG_NOTICE, -1);
603 logwrap(info, " info", LOG_INFO, -1);
604 logwrap(debug, " debug", LOG_DEBUG, -1);
607 /*========== utility functions etc. ==========*/
609 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
610 static char *xvasprintf(const char *fmt, va_list al) {
612 int rc= vasprintf(&str,fmt,al);
613 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
616 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
617 static char *xasprintf(const char *fmt, ...) {
619 char *str= xvasprintf(fmt,al);
624 static int close_perhaps(int *fd) {
625 if (*fd <= 0) return 0;
630 static void xclose(int fd, const char *what, const char *what2) {
632 if (r) sysdie("close %s%s",what,what2?what2:"");
634 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
635 if (*fd <= 0) return;
636 xclose(*fd,what,what2);
640 static pid_t xfork(const char *what) {
644 if (child==-1) sysfatal("cannot fork for %s",what);
645 debug("forked %s %ld", what, (unsigned long)child);
646 if (!child) postfork();
650 static void on_fd_read_except(int fd, oop_call_fd callback) {
651 loop->on_fd(loop, fd, OOP_READ, callback, 0);
652 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
654 static void cancel_fd_read_except(int fd) {
655 loop->cancel_fd(loop, fd, OOP_READ);
656 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
659 static void report_child_status(const char *what, int status) {
660 if (WIFEXITED(status)) {
661 int es= WEXITSTATUS(status);
663 warn("%s: child died with error exit status %d", what, es);
664 } else if (WIFSIGNALED(status)) {
665 int sig= WTERMSIG(status);
666 const char *sigstr= strsignal(sig);
667 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
669 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
671 warn("%s: child died due to unknown fatal signal %d%s",
672 what, sig, coredump);
674 warn("%s: child died with unknown wait status %d", what,status);
678 static int xwaitpid(pid_t *pid, const char *what) {
681 int r= kill(*pid, SIGKILL);
682 if (r) sysdie("cannot kill %s child", what);
684 pid_t got= waitpid(*pid, &status, 0);
685 if (got==-1) sysdie("cannot reap %s child", what);
686 if (got==0) die("cannot reap %s child", what);
693 static void *zxmalloc(size_t sz) {
694 void *p= xmalloc(sz);
699 static void xunlink(const char *path, const char *what) {
701 if (r) sysdie("can't unlink %s %s", path, what);
704 static time_t xtime(void) {
706 if (now==-1) sysdie("time(2) failed");
710 static void xsigaction(int signo, const struct sigaction *sa) {
711 int r= sigaction(signo,sa,0);
712 if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
715 static void xsigsetdefault(int signo) {
717 memset(&sa,0,sizeof(sa));
718 sa.sa_handler= SIG_DFL;
719 xsigaction(signo,&sa);
722 static void xgettimeofday(struct timeval *tv_r) {
723 int r= gettimeofday(tv_r,0);
724 if (r) sysdie("gettimeofday(2) failed");
727 static void xsetnonblock(int fd, int nonblocking) {
728 int errnoval= oop_fd_nonblock(fd, nonblocking);
729 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
732 static void check_isreg(const struct stat *stab, const char *path,
734 if (!S_ISREG(stab->st_mode))
735 die("%s %s not a plain file (mode 0%lo)",
736 what, path, (unsigned long)stab->st_mode);
739 static void xfstat(int fd, struct stat *stab_r, const char *what) {
740 int r= fstat(fd, stab_r);
741 if (r) sysdie("could not fstat %s", what);
744 static void xfstat_isreg(int fd, struct stat *stab_r,
745 const char *path, const char *what) {
746 xfstat(fd, stab_r, what);
747 check_isreg(stab_r, path, what);
750 static void xlstat_isreg(const char *path, struct stat *stab,
751 int *enoent_r /* 0 means ENOENT is fatal */,
753 int r= lstat(path, stab);
755 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
756 sysdie("could not lstat %s %s", what, path);
758 if (enoent_r) *enoent_r= 0;
759 check_isreg(stab, path, what);
762 static int samefile(const struct stat *a, const struct stat *b) {
763 assert(S_ISREG(a->st_mode));
764 assert(S_ISREG(b->st_mode));
765 return (a->st_ino == b->st_ino &&
766 a->st_dev == b->st_dev);
769 static char *sanitise(const char *input, int len) {
770 static char sanibuf[100]; /* returns pointer to this buffer! */
772 const char *p= input;
773 const char *endp= len>=0 ? input+len : 0;
777 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
778 int c= (!endp || p<endp) ? *p++ : 0;
779 if (!c) { *q++= '\''; *q=0; break; }
780 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
781 sprintf(q,"\\x%02x",c);
787 static int isewouldblock(int errnoval) {
788 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
791 /*========== command and control connections ==========*/
793 static int control_master;
795 typedef struct ControlConn ControlConn;
797 void (*destroy)(ControlConn*);
803 struct sockaddr_un un;
808 static const oop_rd_style control_rd_style= {
809 OOP_RD_DELIM_STRIP, '\n',
811 OOP_RD_SHORTREC_FORBID
814 static void control_destroy(ControlConn *cc) {
818 static void control_checkouterr(ControlConn *cc /* may destroy*/) {
819 if (ferror(cc->out) | fflush(cc->out)) {
820 info("CTRL%d write error %s", cc->fd, strerror(errno));
825 static void control_prompt(ControlConn *cc /* may destroy*/) {
826 fprintf(cc->out, "%s| ", sitename);
827 control_checkouterr(cc);
830 struct ControlCommand {
832 void (*f)(ControlConn *cc, const ControlCommand *ccmd,
833 const char *arg, size_t argsz);
838 static const ControlCommand control_commands[];
841 static void ccmd_##wh(ControlConn *cc, const ControlCommand *c, \
842 const char *arg, size_t argsz)
845 fputs("commands:\n", cc->out);
846 const ControlCommand *ccmd;
847 for (ccmd=control_commands; ccmd->cmd; ccmd++)
848 fprintf(cc->out, " %s\n", ccmd->cmd);
849 fputs("NB: permissible arguments are not shown above."
850 " Not all commands listed are safe. See innduct(8).\n", cc->out);
854 int ok= trigger_flush_ok();
855 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
860 notice("terminating (CTRL%d)",cc->fd);
861 raise_default(SIGTERM);
867 /* messing with our head: */
868 CCMD(period) { period(); }
869 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
870 CCMD(setint) { *(int*)c->xdata= c->xval; }
871 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
873 static const ControlCommand control_commands[]= {
875 { "flush", ccmd_flush },
876 { "stop", ccmd_stop },
877 { "dump q", ccmd_dump, 0,0 },
878 { "dump a", ccmd_dump, 0,1 },
880 { "p", ccmd_period },
882 #define POKES(cmd,func) \
883 { cmd "flush", func, &until_flush, 1 }, \
884 { cmd "conn", func, &until_connect, 0 }, \
885 { cmd "blscan", func, &until_backlog_nextscan, 0 },
886 POKES("next ", ccmd_setint)
887 POKES("prod ", ccmd_setint_period)
889 { "pretend flush", ccmd_setintarg, &simulate_flush },
890 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
894 static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
895 const char *errmsg, int errnoval,
896 const char *data, size_t recsz, void *cc_v) {
897 ControlConn *cc= cc_v;
900 info("CTRL%d closed", cc->fd);
905 if (recsz == 0) goto prompt;
907 const ControlCommand *ccmd;
908 for (ccmd=control_commands; ccmd->cmd; ccmd++) {
909 int l= strlen(ccmd->cmd);
910 if (recsz < l) continue;
911 if (recsz > l && data[l] != ' ') continue;
912 if (memcmp(data, ccmd->cmd, l)) continue;
914 int argl= (int)recsz - (l+1);
915 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
919 fputs("unknown command; h for help\n", cc->out);
926 static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
927 const char *errmsg, int errnoval,
928 const char *data, size_t recsz, void *cc_v) {
929 ControlConn *cc= cc_v;
931 info("CTRL%d read error %s", cc->fd, errmsg);
936 static int control_conn_startup(ControlConn *cc /* may destroy*/,
938 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
939 if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
941 int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
944 if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
946 info("CTRL%d %s ready", cc->fd, how);
951 static void control_stdio_destroy(ControlConn *cc) {
953 oop_rd_cancel(cc->rd);
954 errno= oop_rd_delete_tidy(cc->rd);
955 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
960 static void control_stdio(void) {
961 NEW_DECL(ControlConn *,cc);
962 cc->destroy= control_stdio_destroy;
966 int r= control_conn_startup(cc,"stdio");
967 if (r) cc->destroy(cc);
970 static void control_accepted_destroy(ControlConn *cc) {
972 oop_rd_cancel(cc->rd);
973 oop_rd_delete_kill(cc->rd);
975 if (cc->out) { fclose(cc->out); cc->fd=0; }
976 close_perhaps(&cc->fd);
980 static void *control_master_readable(oop_source *lp, int master,
981 oop_event ev, void *u) {
982 NEW_DECL(ControlConn *,cc);
983 cc->destroy= control_accepted_destroy;
985 cc->salen= sizeof(cc->sa);
986 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
987 if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
989 cc->out= fdopen(cc->fd, "w");
990 if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
992 int r= control_conn_startup(cc, "accepted");
1002 #define NOCONTROL(...) do{ \
1003 syswarn("no control socket, because failed to " __VA_ARGS__); \
1007 static void control_init(void) {
1012 struct sockaddr_un un;
1015 memset(&sa,0,sizeof(sa));
1016 int maxlen= sizeof(sa.un.sun_path);
1018 int reallen= readlink(path_control, sa.un.sun_path, maxlen);
1020 if (errno != ENOENT)
1021 NOCONTROL("readlink control socket symlink path %s", path_control);
1023 if (reallen >= maxlen) {
1024 debug("control socket symlink path too long (r=%d)",reallen);
1025 xunlink(path_control, "old (overlong) control socket symlink");
1031 int r= lstat(realsockdir,&stab);
1033 if (errno != ENOENT) NOCONTROL("lstat real socket dir %s", realsockdir);
1035 r= mkdir(realsockdir, 0700);
1036 if (r) NOCONTROL("mkdir real socket dir %s", realsockdir);
1039 uid_t self= geteuid();
1040 if (!S_ISDIR(stab.st_mode) ||
1041 stab.st_uid != self ||
1042 stab.st_mode & 0007) {
1043 warn("no control socket, because real socket directory"
1044 " is somehow wrong (ISDIR=%d, uid=%lu (exp.%lu), mode %lo)",
1045 !!S_ISDIR(stab.st_mode),
1046 (unsigned long)stab.st_uid, (unsigned long)self,
1047 (unsigned long)stab.st_mode & 0777UL);
1052 real= xasprintf("%s/s%lx.%lx", realsockdir,
1053 (unsigned long)xtime(), (unsigned long)self_pid);
1054 int reallen= strlen(real);
1056 if (reallen >= maxlen) {
1057 warn("no control socket, because tmpnam gave overly-long path"
1061 r= symlink(real, path_control);
1062 if (r) NOCONTROL("make control socket path %s a symlink to real"
1063 " socket path %s", path_control, real);
1064 memcpy(sa.un.sun_path, real, reallen);
1067 int r= unlink(sa.un.sun_path);
1068 if (r && errno!=ENOENT)
1069 NOCONTROL("remove old real socket %s", sa.un.sun_path);
1071 control_master= socket(PF_UNIX, SOCK_STREAM, 0);
1072 if (control_master<0) NOCONTROL("create new control socket");
1074 sa.un.sun_family= AF_UNIX;
1075 int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
1076 r= bind(control_master, &sa.sa, sl);
1077 if (r) NOCONTROL("bind to real socket path %s", sa.un.sun_path);
1079 r= listen(control_master, 5);
1080 if (r) NOCONTROL("listen");
1082 xsetnonblock(control_master, 1);
1084 loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
1085 info("control socket ok, real path %s", sa.un.sun_path);
1091 xclose_perhaps(&control_master, "control master",0);
1095 /*========== management of connections ==========*/
1097 static void conn_closefd(Conn *conn, const char *msgprefix) {
1098 int r= close_perhaps(&conn->fd);
1099 if (r) info("C%d %serror closing socket: %s",
1100 conn->fd, msgprefix, strerror(errno));
1103 static void conn_dispose(Conn *conn) {
1106 oop_rd_cancel(conn->rd);
1107 oop_rd_delete_kill(conn->rd);
1111 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1112 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1114 conn_closefd(conn,"");
1116 until_connect= reconnect_delay_periods;
1119 static void *conn_exception(oop_source *lp, int fd,
1120 oop_event ev, void *conn_v) {
1123 assert(fd == conn->fd);
1124 assert(ev == OOP_EXCEPTION);
1125 int r= read(conn->fd, &ch, 1);
1126 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1127 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1128 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1129 return OOP_CONTINUE;
1132 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1133 int requeue[art_MaxState];
1134 memset(requeue,0,sizeof(requeue));
1138 while ((art= LIST_REMHEAD(conn->priority)))
1139 LIST_ADDTAIL(art->ipf->queue, art);
1141 while ((art= LIST_REMHEAD(conn->waiting)))
1142 LIST_ADDTAIL(art->ipf->queue, art);
1144 while ((art= LIST_REMHEAD(conn->sent))) {
1145 requeue[art->state]++;
1146 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1147 LIST_ADDTAIL(art->ipf->queue,art);
1148 check_reading_pause_resume(art->ipf);
1153 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1156 char *m= xvasprintf(fmt,al);
1157 warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1158 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1161 LIST_REMOVE(conns,conn);
1163 check_assign_articles();
1166 static void connfail(Conn *conn, const char *fmt, ...) {
1169 vconnfail(conn,fmt,al);
1173 static void check_idle_conns(void) {
1176 conn->since_activity++;
1179 if (conn->since_activity <= need_activity_periods) continue;
1181 /* We need to shut this down */
1183 connfail(conn,"timed out waiting for response to QUIT");
1184 else if (conn->sent.count)
1185 connfail(conn,"timed out waiting for responses");
1186 else if (conn->waiting.count || conn->priority.count)
1187 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1188 else if (conn->xmitu)
1189 connfail(conn,"peer has been sending responses"
1190 " before receiving our commands!");
1192 static const char quitcmd[]= "QUIT\r\n";
1193 int todo= sizeof(quitcmd)-1;
1194 const char *p= quitcmd;
1196 int r= write(conn->fd, p, todo);
1198 if (isewouldblock(errno))
1199 connfail(conn, "blocked writing QUIT to idle connection");
1201 connfail(conn, "failed to write QUIT to idle connection: %s",
1209 conn->since_activity= 0;
1210 debug("C%d is idle, quitting", conn->fd);
1219 /*---------- making new connections ----------*/
1221 static pid_t connecting_child;
1222 static int connecting_fdpass_sock;
1224 static void connect_attempt_discard(void) {
1225 if (connecting_child) {
1226 int status= xwaitpid(&connecting_child, "connect");
1227 if (!(WIFEXITED(status) ||
1228 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1229 report_child_status("connect", status);
1231 if (connecting_fdpass_sock) {
1232 cancel_fd_read_except(connecting_fdpass_sock);
1233 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1237 #define PREP_DECL_MSG_CMSG(msg) \
1239 struct iovec msgiov; \
1240 msgiov.iov_base= &msgbyte; \
1241 msgiov.iov_len= 1; \
1242 struct msghdr msg; \
1243 memset(&msg,0,sizeof(msg)); \
1244 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1245 msg.msg_iov= &msgiov; \
1246 msg.msg_iovlen= 1; \
1247 msg.msg_control= msg##cbuf; \
1248 msg.msg_controllen= sizeof(msg##cbuf);
1250 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1253 assert(fd == connecting_fdpass_sock);
1255 PREP_DECL_MSG_CMSG(msg);
1257 ssize_t rs= recvmsg(fd, &msg, 0);
1259 if (isewouldblock(errno)) return OOP_CONTINUE;
1260 syswarn("failed to read socket from connecting child");
1265 LIST_INIT(conn->waiting);
1266 LIST_INIT(conn->priority);
1267 LIST_INIT(conn->sent);
1269 struct cmsghdr *h= 0;
1270 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1272 int status= xwaitpid(&connecting_child, "connect child (broken)");
1274 if (WIFEXITED(status)) {
1275 if (WEXITSTATUS(status) != 0 &&
1276 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1277 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1278 /* child already reported the problem */;
1280 if (e == OOP_EXCEPTION)
1281 warn("connect: connection child exited code %d but"
1282 " unexpected exception on fdpass socket",
1283 WEXITSTATUS(status));
1285 warn("connect: connection child exited code %d but"
1287 WEXITSTATUS(status), (int)rs);
1289 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1290 warn("connect: connection attempt timed out");
1292 report_child_status("connect", status);
1297 #define CHK(field, val) \
1298 if (h->cmsg_##field != val) { \
1299 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1300 h->cmsg_##field, val); \
1303 CHK(level, SOL_SOCKET);
1304 CHK(type, SCM_RIGHTS);
1305 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1308 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1310 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1313 pid_t got= waitpid(connecting_child, &status, 0);
1314 if (got==-1) sysdie("connect: real wait for child");
1315 assert(got == connecting_child);
1316 connecting_child= 0;
1318 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1319 int es= WEXITSTATUS(status);
1321 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1322 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1324 fatal("connect: child gave unexpected exit status %d", es);
1328 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1330 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1331 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1332 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1333 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1335 &peer_rd_err, conn);
1336 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1338 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1339 LIST_ADDHEAD(conns, conn);
1341 connect_attempt_discard();
1342 check_assign_articles();
1343 return OOP_CONTINUE;
1347 connect_attempt_discard();
1348 return OOP_CONTINUE;
1351 static int allow_connect_start(void) {
1352 return conns.count < max_connections
1353 && !connecting_child
1357 static void connect_start(void) {
1358 assert(!connecting_child);
1359 assert(!connecting_fdpass_sock);
1361 info("starting connection attempt");
1364 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1365 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1367 connecting_child= xfork("connection");
1369 if (!connecting_child) {
1370 FILE *cn_from, *cn_to;
1371 char buf[NNTP_STRLEN+100];
1372 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1374 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1376 alarm(connection_setup_timeout);
1377 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1381 unsigned char c= buf[l-1];
1382 if (!isspace(c)) break;
1383 if (c=='\n' || c=='\r') stripped=1;
1387 sysfatal("connect: connection attempt failed");
1390 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1394 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1395 sysfatal("connect: authentication failed");
1397 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1399 sysfatal("connect: could not send MODE STREAM");
1400 buf[sizeof(buf)-1]= 0;
1401 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1402 if (ferror(cn_from))
1403 sysfatal("connect: could not read response to MODE STREAM");
1405 fatal("connect: connection close in response to MODE STREAM");
1410 fatal("connect: response to MODE STREAM is too long: %.100s...",
1412 l--; if (l>0 && buf[l-1]=='\r') l--;
1415 int rcode= strtoul(buf,&ep,10);
1417 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1421 exitstatus= CONNCHILD_ESTATUS_STREAM;
1427 warn("connect: unexpected response to MODE STREAM: %.50s",
1433 int fd= fileno(cn_from);
1435 PREP_DECL_MSG_CMSG(msg);
1436 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1437 cmsg->cmsg_level= SOL_SOCKET;
1438 cmsg->cmsg_type= SCM_RIGHTS;
1439 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1440 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1442 msg.msg_controllen= cmsg->cmsg_len;
1443 r= sendmsg(socks[1], &msg, 0);
1444 if (r<0) sysdie("sendmsg failed for new connection");
1445 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1450 xclose(socks[1], "connecting fdpass child's socket",0);
1451 connecting_fdpass_sock= socks[0];
1452 xsetnonblock(connecting_fdpass_sock, 1);
1453 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1456 /*---------- assigning articles to conns, and transmitting ----------*/
1458 static Article *dequeue_from(int peek, InputFile *ipf) {
1460 if (peek) return LIST_HEAD(ipf->queue);
1462 Article *art= LIST_REMHEAD(ipf->queue);
1464 check_reading_pause_resume(ipf);
1468 static Article *dequeue(int peek) {
1470 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1471 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1472 art= dequeue_from(peek, main_input_file); if (art) return art;
1476 static void check_assign_articles(void) {
1482 int spare=0, inqueue=0;
1484 /* Find a connection to offer this article. We prefer a busy
1485 * connection to an idle one, provided it's not full. We take the
1486 * first (oldest) and since that's stable, it will mean we fill up
1487 * connections in order. That way if we have too many
1488 * connections, the spare ones will go away eventually.
1491 if (walk->quitting) continue;
1492 inqueue= walk->sent.count + walk->priority.count
1493 + walk->waiting.count;
1494 spare= walk->max_queue - inqueue;
1495 assert(inqueue <= max_queue_per_conn);
1497 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1498 else if (spare>0) /*working*/ { use= walk; break; }
1501 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1503 Article *art= dequeue(0);
1505 LIST_ADDTAIL(use->waiting, art);
1508 conn_maybe_write(use);
1509 } else if (allow_connect_start()) {
1510 until_connect= reconnect_delay_periods;
1519 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1520 conn_maybe_write(u);
1521 return OOP_CONTINUE;
1524 static void conn_maybe_write(Conn *conn) {
1526 conn_make_some_xmits(conn);
1528 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1532 void *rp= conn_write_some_xmits(conn);
1533 if (rp==OOP_CONTINUE) {
1534 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1536 } else if (rp==OOP_HALT) {
1539 /* transmitted everything */
1546 /*---------- expiry, flow control and deferral ----------*/
1549 * flow control notes
1550 * to ensure articles go away eventually
1551 * separate queue for each input file
1553 * every period, check head of backlog queue for expiry with SMretrieve
1554 * if too old: discard, and check next article
1555 * also check every backlog article as we read it
1557 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1558 * one-off: eat queued articles from flushing and write them to defer
1559 * one-off: connfail all connections which have any articles from flushing
1560 * newly read articles from flushing go straight to defer
1561 * this should take care of it and get us out of this state
1562 * to avoid filling up ram needlessly
1564 * limit number of queued articles for each ipf
1565 * pause/resume inputfile tailing
1568 static void check_reading_pause_resume(InputFile *ipf) {
1569 if (ipf->queue.count >= max_queue_per_ipf)
1570 inputfile_reading_pause(ipf);
1572 inputfile_reading_resume(ipf);
1575 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1577 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1579 sysfatal("write to defer file %s",path_defer);
1580 article_done(art, whichcount);
1583 static int article_check_expired(Article *art /* must be queued, not conn */) {
1584 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1585 if (artdata) { SMfreearticle(artdata); return 0; }
1587 LIST_REMOVE(art->ipf->queue, art);
1589 art->ipf->count_nooffer_missing++;
1590 article_done(art,-1);
1594 static void inputfile_queue_check_expired(InputFile *ipf) {
1598 Article *art= LIST_HEAD(ipf->queue);
1599 int exp= article_check_expired(art);
1602 check_reading_pause_resume(ipf);
1605 static void article_autodefer(InputFile *ipf, Article *art) {
1607 article_defer(art,-1);
1610 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1612 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1613 if (art->ipf == ipf) return 1;
1617 static void autodefer_input_file_articles(InputFile *ipf) {
1619 while ((art= LIST_REMHEAD(ipf->queue)))
1620 article_autodefer(ipf, art);
1623 static void autodefer_input_file(InputFile *ipf) {
1626 autodefer_input_file_articles(ipf);
1628 if (ipf->inprogress) {
1631 if (has_article_in(&walk->waiting, ipf) ||
1632 has_article_in(&walk->priority, ipf) ||
1633 has_article_in(&walk->sent, ipf))
1636 while (ipf->inprogress) {
1638 if (walk->quitting < 0) goto found;
1639 abort(); /* where are they ?? */
1642 connfail(walk, "connection is stuck or crawling,"
1643 " and we need to finish flush");
1644 autodefer_input_file_articles(ipf);
1648 check_reading_pause_resume(ipf);
1651 /*========== article transmission ==========*/
1653 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1654 XmitKind kind) { /* caller must then fill in details */
1655 struct iovec *v= &conn->xmit[conn->xmitu];
1656 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1657 v->iov_base= (char*)data;
1663 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1664 xmit_core(conn,data,len, xk_Const);
1666 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1668 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1669 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1673 static void xmit_free(XmitDetails *d) {
1675 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1676 case xk_Const: break;
1681 static void *conn_write_some_xmits(Conn *conn) {
1683 * 0: nothing more to write, no need to call us again
1684 * OOP_CONTINUE: more to write but fd not writeable
1685 * OOP_HALT: disaster, have destroyed conn
1688 int count= conn->xmitu;
1689 if (!count) return 0;
1691 if (count > IOV_MAX) count= IOV_MAX;
1692 ssize_t rs= writev(conn->fd, conn->xmit, count);
1694 if (isewouldblock(errno)) return OOP_CONTINUE;
1695 connfail(conn, "write failed: %s", strerror(errno));
1701 for (done=0; rs && done<conn->xmitu; done++) {
1702 struct iovec *vp= &conn->xmit[done];
1703 XmitDetails *dp= &conn->xmitd[done];
1704 if (rs > vp->iov_len) {
1708 vp->iov_base= (char*)vp->iov_base + rs;
1712 int newu= conn->xmitu - done;
1713 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1714 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1719 static void conn_make_some_xmits(Conn *conn) {
1721 if (conn->xmitu+5 > CONNIOVS)
1724 Article *art= LIST_REMHEAD(conn->priority);
1725 if (!art) art= LIST_REMHEAD(conn->waiting);
1728 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1729 /* actually send it */
1731 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1734 art->state == art_Unchecked ? art_Unsolicited :
1735 art->state == art_Wanted ? art_Wanted :
1738 if (!artdata) art->missing= 1;
1739 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1743 XMIT_LITERAL("TAKETHIS ");
1744 xmit_noalloc(conn, art->messageid, art->midlen);
1745 XMIT_LITERAL("\r\n");
1746 xmit_artbody(conn, artdata);
1748 article_done(art, -1);
1752 /* we got 235 from IHAVE */
1754 xmit_artbody(conn, artdata);
1756 XMIT_LITERAL(".\r\n");
1760 LIST_ADDTAIL(conn->sent, art);
1766 XMIT_LITERAL("CHECK ");
1768 XMIT_LITERAL("IHAVE ");
1769 xmit_noalloc(conn, art->messageid, art->midlen);
1770 XMIT_LITERAL("\r\n");
1772 assert(art->state == art_Unchecked);
1773 art->ipf->counts[art->state][RC_sent]++;
1774 LIST_ADDTAIL(conn->sent, art);
1779 /*========== handling responses from peer ==========*/
1781 static const oop_rd_style peer_rd_style= {
1782 OOP_RD_DELIM_STRIP, '\n',
1784 OOP_RD_SHORTREC_FORBID
1787 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1788 const char *errmsg, int errnoval,
1789 const char *data, size_t recsz, void *conn_v) {
1791 connfail(conn, "error receiving from peer: %s", errmsg);
1792 return OOP_CONTINUE;
1795 static Article *article_reply_check(Conn *conn, const char *response,
1796 int code_indicates_streaming,
1798 /* 1:yes, -1:no, 0:dontcare */,
1799 const char *sanitised_response) {
1800 Article *art= LIST_HEAD(conn->sent);
1804 "peer gave unexpected response when no commands outstanding: %s",
1805 sanitised_response);
1809 if (code_indicates_streaming) {
1810 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1811 if (!conn->stream) {
1812 connfail(conn, "peer gave streaming response code "
1813 " to IHAVE or subsequent body: %s", sanitised_response);
1816 const char *got_mid= response+4;
1817 int got_midlen= strcspn(got_mid, " \n\r");
1818 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1819 connfail(conn, "peer gave streaming response with syntactically invalid"
1820 " messageid: %s", sanitised_response);
1823 if (got_midlen != art->midlen ||
1824 memcmp(got_mid, art->messageid, got_midlen)) {
1825 connfail(conn, "peer gave streaming response code to wrong article -"
1826 " probable synchronisation problem; we offered: %s;"
1828 art->messageid, sanitised_response);
1833 connfail(conn, "peer gave non-streaming response code to"
1834 " CHECK/TAKETHIS: %s", sanitised_response);
1839 if (must_have_sent>0 && art->state < art_Wanted) {
1840 connfail(conn, "peer says article accepted but"
1841 " we had not sent the body: %s", sanitised_response);
1844 if (must_have_sent<0 && art->state >= art_Wanted) {
1845 connfail(conn, "peer says please sent the article but we just did: %s",
1846 sanitised_response);
1850 Article *art_again= LIST_REMHEAD(conn->sent);
1851 assert(art_again == art);
1855 static void update_nocheck(int accepted) {
1856 accept_proportion *= nocheck_decay;
1857 accept_proportion += accepted * (1.0 - nocheck_decay);
1858 int new_nocheck= accept_proportion >= nocheck_thresh;
1859 if (new_nocheck && !nocheck_reported) {
1860 notice("entering nocheck mode for the first time");
1861 nocheck_reported= 1;
1862 } else if (new_nocheck != nocheck) {
1863 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1865 nocheck= new_nocheck;
1868 static void article_done(Article *art, int whichcount) {
1869 if (whichcount>=0 && !art->missing)
1870 art->ipf->counts[art->state][whichcount]++;
1872 if (whichcount == RC_accepted) update_nocheck(1);
1873 else if (whichcount == RC_unwanted) update_nocheck(0);
1875 InputFile *ipf= art->ipf;
1877 while (art->blanklen) {
1878 static const char spaces[]=
1888 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1889 int r= pwrite(ipf->fd, spaces, w, art->offset);
1891 if (errno==EINTR) continue;
1892 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1893 art->messageid, art->blanklen,
1894 (unsigned long)art->offset, ipf->path);
1896 assert(r>=0 && r<=w);
1902 assert(ipf->inprogress >= 0);
1905 if (!ipf->inprogress && ipf != main_input_file)
1906 queue_check_input_done();
1909 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1910 const char *errmsg, int errnoval,
1911 const char *data, size_t recsz, void *conn_v) {
1914 if (ev == OOP_RD_EOF) {
1915 connfail(conn, "unexpected EOF from peer");
1916 return OOP_CONTINUE;
1918 assert(ev == OOP_RD_OK);
1920 char *sani= sanitise(data,-1);
1923 unsigned long code= strtoul(data, &ep, 10);
1924 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1925 connfail(conn, "badly formatted response from peer: %s", sani);
1926 return OOP_CONTINUE;
1930 conn->waiting.count ||
1931 conn->priority.count ||
1935 if (conn->quitting) {
1936 if (code!=205 && code!=503) {
1937 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1939 notice("C%d idle connection closed by us", conn->fd);
1941 LIST_REMOVE(conns,conn);
1944 return OOP_CONTINUE;
1947 conn->since_activity= 0;
1950 #define GET_ARTICLE(musthavesent) do{ \
1951 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1952 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1955 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1956 code_streaming= (streaming); \
1957 GET_ARTICLE(musthavesent); \
1958 article_done(art, RC_##how); \
1962 #define PEERBADMSG(m) do { \
1963 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1966 int code_streaming= 0;
1970 default: PEERBADMSG("peer sent unexpected message");
1974 PEERBADMSG("peer timed us out or stopped accepting articles");
1976 notice("C%d idle connection closed by peer", conn->fd);
1977 LIST_REMOVE(conns,conn);
1979 return OOP_CONTINUE;
1981 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1982 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1984 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1985 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1987 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1988 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1990 case 238: /* CHECK says send it */
1992 case 335: /* IHAVE says send it */
1994 assert(art->state == art_Unchecked);
1995 art->ipf->counts[art->state][RC_accepted]++;
1996 art->state= art_Wanted;
1997 LIST_ADDTAIL(conn->priority, art);
2000 case 431: /* CHECK or TAKETHIS says try later */
2002 case 436: /* IHAVE says try later */
2004 article_defer(art, RC_deferred);
2010 conn_maybe_write(conn);
2011 check_assign_articles();
2012 return OOP_CONTINUE;
2016 /*========== monitoring of input files ==========*/
2018 static void feedfile_eof(InputFile *ipf) {
2019 assert(ipf != main_input_file); /* promised by tailing_try_read */
2020 inputfile_reading_stop(ipf);
2022 if (ipf == flushing_input_file) {
2023 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2024 if (main_input_file) inputfile_reading_start(main_input_file);
2025 statemc_check_flushing_done();
2026 } else if (ipf == backlog_input_file) {
2027 statemc_check_backlog_done();
2029 abort(); /* supposed to wait rather than get EOF on main input file */
2033 static InputFile *open_input_file(const char *path) {
2034 int fd= open(path, O_RDWR);
2036 if (errno==ENOENT) return 0;
2037 sysfatal("unable to open input file %s", path);
2041 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2042 memset(ipf,0,sizeof(*ipf));
2046 LIST_INIT(ipf->queue);
2047 strcpy(ipf->path, path);
2052 static void close_input_file(InputFile *ipf) { /* does not free */
2053 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2054 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2055 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2056 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2057 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2061 /*---------- dealing with articles read in the input file ----------*/
2063 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2064 const char *data, const char *how) {
2065 warn("corrupted file: %s, offset %lu: %s: in %s",
2066 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2067 ipf->readcount_err++;
2068 if (ipf->readcount_err > max_bad_data_initial +
2069 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2070 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
2071 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2072 return OOP_CONTINUE;
2075 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2076 oop_rd_event ev, const char *errmsg,
2077 int errnoval, const char *data, size_t recsz,
2079 InputFile *ipf= ipf_v;
2080 assert(ev == OOP_RD_SYSTEM);
2082 sysdie("error reading input file: %s, offset %lu",
2083 ipf->path, (unsigned long)ipf->offset);
2086 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2087 oop_rd_event ev, const char *errmsg,
2088 int errnoval, const char *data, size_t recsz,
2090 InputFile *ipf= ipf_v;
2092 char tokentextbuf[sizeof(TOKEN)*2+3];
2094 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2096 off_t old_offset= ipf->offset;
2097 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2099 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2101 if (ev==OOP_RD_PARTREC)
2102 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2103 /* but process it anyway */
2105 if (ipf->skippinglong) {
2106 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2107 return OOP_CONTINUE;
2109 if (ev==OOP_RD_LONG) {
2110 ipf->skippinglong= 1;
2111 X_BAD_DATA("overly long line");
2114 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2115 if (!recsz) X_BAD_DATA("empty line");
2118 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2119 ipf->readcount_blank++;
2120 return OOP_CONTINUE;
2123 char *space= strchr(data,' ');
2124 int tokenlen= space-data;
2125 int midlen= (int)recsz-tokenlen-1;
2126 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2127 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2129 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2130 memcpy(tokentextbuf, data, tokenlen);
2131 tokentextbuf[tokenlen]= 0;
2132 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2134 ipf->readcount_ok++;
2136 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2137 memset(art,0,sizeof(*art));
2138 art->state= art_Unchecked;
2139 art->midlen= midlen;
2140 art->ipf= ipf; ipf->inprogress++;
2141 art->token= TextToToken(tokentextbuf);
2142 art->offset= old_offset;
2143 art->blanklen= recsz;
2144 strcpy(art->messageid, space+1);
2145 LIST_ADDTAIL(ipf->queue, art);
2147 if (ipf->autodefer >= 0)
2148 article_autodefer(ipf, art);
2149 else if (ipf==backlog_input_file)
2150 article_check_expired(art);
2152 if (sms==sm_NORMAL && ipf==main_input_file &&
2153 ipf->offset >= target_max_feedfile_size)
2154 statemc_start_flush("feed file size");
2156 check_assign_articles(); /* may destroy conn but that's OK */
2157 check_reading_pause_resume(ipf);
2158 return OOP_CONTINUE;
2161 /*========== tailing input file ==========*/
2163 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2165 InputFile *ipf= user;
2166 return ipf->readable_callback(loop, &ipf->readable,
2167 ipf->readable_callback_user);
2170 static void tailing_on_cancel(struct oop_readable *rable) {
2171 InputFile *ipf= (void*)rable;
2173 if (ipf->filemon) filemon_stop(ipf);
2174 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2175 ipf->readable_callback= 0;
2178 static void tailing_queue_readable(InputFile *ipf) {
2179 /* lifetime of ipf here is OK because destruction will cause
2180 * on_cancel which will cancel this callback */
2181 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2184 static int tailing_on_readable(struct oop_readable *rable,
2185 oop_readable_call *cb, void *user) {
2186 InputFile *ipf= (void*)rable;
2188 tailing_on_cancel(rable);
2189 ipf->readable_callback= cb;
2190 ipf->readable_callback_user= user;
2193 tailing_queue_readable(ipf);
2197 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2199 InputFile *ipf= (void*)rable;
2201 ssize_t r= read(ipf->fd, buffer, length);
2203 if (errno==EINTR) continue;
2207 if (ipf==main_input_file) {
2210 } else if (ipf==flushing_input_file) {
2212 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2213 } else if (ipf==backlog_input_file) {
2219 tailing_queue_readable(ipf);
2224 /*---------- filemon implemented with inotify ----------*/
2226 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2227 #define HAVE_FILEMON
2229 #include <sys/inotify.h>
2231 static int filemon_inotify_fd;
2232 static int filemon_inotify_wdmax;
2233 static InputFile **filemon_inotify_wd2ipf;
2235 struct Filemon_Perfile {
2239 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2240 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2241 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2243 if (wd >= filemon_inotify_wdmax) {
2245 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2246 sizeof(*filemon_inotify_wd2ipf) * newmax);
2247 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2248 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2249 filemon_inotify_wdmax= newmax;
2252 assert(!filemon_inotify_wd2ipf[wd]);
2253 filemon_inotify_wd2ipf[wd]= ipf;
2255 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2256 ipf, wd, filemon_inotify_wdmax);
2261 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2263 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2264 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2265 if (r) sysdie("inotify_rm_watch");
2266 filemon_inotify_wd2ipf[wd]= 0;
2269 static void *filemon_inotify_readable(oop_source *lp, int fd,
2270 oop_event e, void *u) {
2271 struct inotify_event iev;
2273 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2275 if (isewouldblock(errno)) break;
2276 sysdie("read from inotify master");
2277 } else if (r==sizeof(iev)) {
2278 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2280 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2282 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2283 debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);
2284 filemon_callback(ipf);
2286 return OOP_CONTINUE;
2289 static int filemon_method_init(void) {
2290 filemon_inotify_fd= inotify_init();
2291 if (filemon_inotify_fd<0) {
2292 syswarn("filemon/inotify: inotify_init failed");
2295 xsetnonblock(filemon_inotify_fd, 1);
2296 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2298 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2302 static void filemon_method_dump_info(FILE *f) {
2304 fprintf(f,"inotify");
2305 DUMPV("%d",,filemon_inotify_fd);
2306 DUMPV("%d",,filemon_inotify_wdmax);
2307 for (i=0; i<filemon_inotify_wdmax; i++)
2308 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2311 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2313 /*---------- filemon dummy implementation ----------*/
2315 #if !defined(HAVE_FILEMON)
2317 struct Filemon_Perfile { int dummy; };
2319 static int filemon_method_init(void) {
2320 warn("filemon/dummy: no filemon method compiled in");
2323 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2324 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2325 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2327 #endif /* !HAVE_FILEMON */
2329 /*---------- filemon generic interface ----------*/
2331 static void filemon_start(InputFile *ipf) {
2332 assert(!ipf->filemon);
2335 filemon_method_startfile(ipf, ipf->filemon);
2338 static void filemon_stop(InputFile *ipf) {
2339 if (!ipf->filemon) return;
2340 filemon_method_stopfile(ipf, ipf->filemon);
2345 static void filemon_callback(InputFile *ipf) {
2346 if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2347 ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2350 /*---------- interface to start and stop an input file ----------*/
2352 static const oop_rd_style feedfile_rdstyle= {
2353 OOP_RD_DELIM_STRIP, '\n',
2355 OOP_RD_SHORTREC_LONG,
2358 static void inputfile_reading_resume(InputFile *ipf) {
2359 if (!ipf->rd) return;
2360 if (!ipf->paused) return;
2362 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2363 feedfile_got_article,ipf, feedfile_read_err, ipf);
2364 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2369 static void inputfile_reading_pause(InputFile *ipf) {
2370 if (!ipf->rd) return;
2371 if (ipf->paused) return;
2372 oop_rd_cancel(ipf->rd);
2376 static void inputfile_reading_start(InputFile *ipf) {
2378 ipf->readable.on_readable= tailing_on_readable;
2379 ipf->readable.on_cancel= tailing_on_cancel;
2380 ipf->readable.try_read= tailing_try_read;
2381 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2382 ipf->readable.delete_kill= 0;
2384 ipf->readable_callback= 0;
2385 ipf->readable_callback_user= 0;
2387 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2391 inputfile_reading_resume(ipf);
2394 static void inputfile_reading_stop(InputFile *ipf) {
2396 inputfile_reading_pause(ipf);
2397 oop_rd_delete(ipf->rd);
2399 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2403 /*========== interaction with innd - state machine ==========*/
2405 /* See official state diagram at top of file. We implement
2416 |`---------------------------------------------------.
2418 |`---------------- - - - |
2419 D ENOENT | D EXISTS see OVERALL STATES diagram |
2420 | for full startup logic |
2423 | ============ try to |
2429 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2430 ^ | hardlink F to D |
2433 | | our handle onto F is now onto D |
2436 | |<-------------------<---------------------<---------+
2438 | | spawn inndcomm flush |
2440 | ================== |
2441 | FLUSHING[-ABSENT] |
2443 | main D tail/none |
2444 | ================== |
2446 | | INNDCOMM FLUSH FAILS ^
2447 | |`----------------------->----------. |
2449 | | NO SUCH SITE V |
2450 ^ |`--------------->----. ==================== |
2451 | | \ FLUSHFAILED[-ABSENT] |
2453 | | FLUSH OK \ main D tail/none |
2454 | | open F \ ==================== |
2456 | | \ | TIME TO RETRY |
2457 | |`------->----. ,---<---'\ `----------------'
2458 | | D NONE | | D NONE `----.
2460 | ============= V V ============
2461 | SEPARATED-1 | | DROPPING-1
2462 | flsh->rd!=0 | | flsh->rd!=0
2463 | [Separated] | | [Dropping]
2464 | main F idle | | main none
2465 | flsh D tail | | flsh D tail
2466 | ============= | | ============
2468 ^ | EOF ON D | | defer | EOF ON D
2470 | =============== | | ===============
2471 | SEPARATED-2 | | DROPPING-2
2472 | flsh->rd==0 | V flsh->rd==0
2473 | [Finishing] | | [Dropping]
2474 | main F tail | `. main none
2475 | flsh D closed | `. flsh D closed
2476 | =============== V `. ===============
2478 | | ALL D PROCESSED `. | ALL D PROCESSED
2479 | V install defer as backlog `. | install defer
2480 ^ | close D `. | close D
2481 | | unlink D `. | unlink D
2484 `----------' ==============
2504 static void startup_set_input_file(InputFile *f) {
2505 assert(!main_input_file);
2507 inputfile_reading_start(f);
2510 static void statemc_lock(void) {
2512 struct stat stab, stabf;
2515 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2516 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2519 memset(&fl,0,sizeof(fl));
2521 fl.l_whence= SEEK_SET;
2522 int r= fcntl(lockfd, F_SETLK, &fl);
2524 if (errno==EACCES || isewouldblock(errno)) {
2525 if (quiet_multiple) exit(0);
2526 fatal("another duct holds the lockfile");
2528 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2531 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2533 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2535 if (!lock_noent && samefile(&stab, &stabf))
2538 xclose(lockfd, "stale lockfile ", path_lock);
2541 FILE *lockfile= fdopen(lockfd, "w");
2542 if (!lockfile) sysdie("fdopen lockfile");
2544 int r= ftruncate(lockfd, 0);
2545 if (r) sysdie("truncate lockfile to write new info");
2547 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2548 (unsigned long)self_pid,
2549 sitename, feedfile, remote_host) == EOF ||
2551 sysfatal("write info to lockfile %s", path_lock);
2553 debug("startup: locked");
2556 static void statemc_init(void) {
2557 struct stat stabdefer;
2559 search_backlog_file();
2562 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2564 debug("startup: ductdefer ENOENT");
2566 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2567 switch (stabdefer.st_nlink==1) {
2569 open_defer(); /* so that we will later close it and rename it */
2572 xunlink(path_defer, "stale defer file link"
2573 " (presumably hardlink to backlog file)");
2576 die("defer file %s has unexpected link count %d",
2577 path_defer, stabdefer.st_nlink);
2581 struct stat stab_f, stab_d;
2584 InputFile *file_d= open_input_file(path_flushing);
2585 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2587 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2589 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2590 debug("startup: F==D => Hardlinked");
2591 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2596 debug("startup: F ENOENT => Moved");
2597 if (file_d) startup_set_input_file(file_d);
2598 spawn_inndcomm_flush("feedfile missing at startup");
2599 /* => Flushing, sms:=FLUSHING */
2602 debug("startup: F!=D => Separated");
2603 startup_set_input_file(file_d);
2604 flushing_input_file= main_input_file;
2605 main_input_file= open_input_file(feedfile);
2606 if (!main_input_file) die("feedfile vanished during startup");
2607 SMS(SEPARATED, max_separated_periods,
2608 "found both old and current feed files");
2610 debug("startup: F exists, D ENOENT => Normal");
2611 InputFile *file_f= open_input_file(feedfile);
2612 if (!file_f) die("feed file vanished during startup");
2613 startup_set_input_file(file_f);
2614 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2619 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2620 assert(sms == sm_NORMAL);
2622 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2624 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2625 (unsigned long)target_max_feedfile_size,
2628 int r= link(feedfile, path_flushing);
2629 if (r) sysfatal("link feedfile %s to flushing file %s",
2630 feedfile, path_flushing);
2633 xunlink(feedfile, "old feedfile link");
2636 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2639 static int trigger_flush_ok(void) { /* => Flushing,FLUSHING, ret 1; or ret 0 */
2643 statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
2646 case sm_FLUSHFAILED:
2647 spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
2652 warn("took too long to complete old feedfile after flush, autodeferring");
2653 assert(flushing_input_file);
2654 autodefer_input_file(flushing_input_file);
2662 static void statemc_period_poll(void) {
2663 if (!until_flush) return;
2665 assert(until_flush>=0);
2667 if (until_flush) return;
2668 int ok= trigger_flush_ok();
2672 static int inputfile_is_done(InputFile *ipf) {
2674 if (ipf->inprogress) return 0; /* new article in the meantime */
2675 if (ipf->rd) return 0; /* not had EOF */
2679 static void notice_processed(InputFile *ipf, int completed,
2680 const char *what, const char *spec) {
2681 if (!ipf) return; /* allows preterminate to be lazy */
2683 #define RCI_NOTHING(x) /* nothing */
2684 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2685 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2687 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2689 char *inprog= completed
2690 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2691 : xasprintf(" inprogress=%ld", ipf->inprogress);
2692 char *autodefer= ipf->autodefer >= 0
2693 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2694 : xasprintf("%s","");
2696 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2697 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2698 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2700 completed?"completed":"processed", what, spec,
2701 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2702 inprog, autodefer, ipf->count_nooffer_missing,
2703 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2704 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2705 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2706 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2707 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2716 static void statemc_check_backlog_done(void) {
2717 InputFile *ipf= backlog_input_file;
2718 if (!inputfile_is_done(ipf)) return;
2720 const char *slash= strrchr(ipf->path, '/');
2721 const char *leaf= slash ? slash+1 : ipf->path;
2722 const char *under= strchr(slash, '_');
2723 const char *rest= under ? under+1 : leaf;
2724 if (!strncmp(rest,"backlog",7)) rest += 7;
2725 notice_processed(ipf,1,"backlog ",rest);
2727 close_input_file(ipf);
2728 if (unlink(ipf->path)) {
2729 if (errno != ENOENT)
2730 sysdie("could not unlink processed backlog file %s", ipf->path);
2731 warn("backlog file %s vanished while we were reading it"
2732 " so we couldn't remove it (but it's done now, anyway)",
2736 backlog_input_file= 0;
2737 search_backlog_file();
2741 static void statemc_check_flushing_done(void) {
2742 InputFile *ipf= flushing_input_file;
2743 if (!inputfile_is_done(ipf)) return;
2745 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2747 notice_processed(ipf,1,"feedfile","");
2751 xunlink(path_flushing, "old flushing file");
2753 close_input_file(flushing_input_file);
2754 free(flushing_input_file);
2755 flushing_input_file= 0;
2757 if (sms==sm_SEPARATED) {
2758 notice("flush complete");
2759 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2760 } else if (sms==sm_DROPPING) {
2761 SMS(DROPPED, max_separated_periods, "old flush complete");
2762 search_backlog_file();
2763 notice("feed dropped, but will continue until backlog is finished");
2767 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2769 assert(!inputfile_is_done(main_input_file));
2770 statemc_check_flushing_done();
2771 statemc_check_backlog_done();
2772 return OOP_CONTINUE;
2775 static void queue_check_input_done(void) {
2776 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2779 static void statemc_setstate(StateMachineState newsms, int periods,
2780 const char *forlog, const char *why) {
2782 until_flush= periods;
2784 const char *xtra= "";
2787 case sm_FLUSHFAILED:
2788 if (!main_input_file) xtra= "-ABSENT";
2792 xtra= flushing_input_file->rd ? "-1" : "-2";
2798 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2800 info("state %s%s %s",forlog,xtra,why);
2804 /*---------- defer and backlog files ----------*/
2806 static void open_defer(void) {
2811 defer= fopen(path_defer, "a+");
2812 if (!defer) sysfatal("could not open defer file %s", path_defer);
2814 /* truncate away any half-written records */
2816 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2818 if (stab.st_size > LONG_MAX)
2819 die("defer file %s size is far too large", path_defer);
2824 long orgsize= stab.st_size;
2825 long truncto= stab.st_size;
2827 if (!truncto) break; /* was only (if anything) one half-truncated record */
2828 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2829 sysdie("seek in defer file %s while truncating partial", path_defer);
2834 sysdie("failed read from defer file %s", path_defer);
2836 die("defer file %s shrank while we were checking it!", path_defer);
2842 if (stab.st_size != truncto) {
2843 warn("truncating half-record at end of defer file %s -"
2844 " shrinking by %ld bytes from %ld to %ld",
2845 path_defer, orgsize - truncto, orgsize, truncto);
2848 sysfatal("could not flush defer file %s", path_defer);
2849 if (ftruncate(fileno(defer), truncto))
2850 sysdie("could not truncate defer file %s", path_defer);
2853 info("continuing existing defer file %s (%ld bytes)",
2854 path_defer, orgsize);
2856 if (fseek(defer, truncto, SEEK_SET))
2857 sysdie("could not seek to new end of defer file %s", path_defer);
2860 static void close_defer(void) {
2865 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2867 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2870 time_t now= xtime();
2872 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2874 (unsigned long)stab.st_ino);
2875 if (link(path_defer, backlog))
2876 sysfatal("could not install defer file %s as backlog file %s",
2877 path_defer, backlog);
2878 if (unlink(path_defer))
2879 sysdie("could not unlink old defer link %s to backlog file %s",
2880 path_defer, backlog);
2884 if (until_backlog_nextscan < 0 ||
2885 until_backlog_nextscan > backlog_retry_minperiods + 1)
2886 until_backlog_nextscan= backlog_retry_minperiods + 1;
2889 static void poll_backlog_file(void) {
2890 if (until_backlog_nextscan < 0) return;
2891 if (until_backlog_nextscan-- > 0) return;
2892 search_backlog_file();
2895 static void search_backlog_file(void) {
2896 /* returns non-0 iff there are any backlog files */
2901 const char *oldest_path=0;
2902 time_t oldest_mtime=0, now;
2904 if (backlog_input_file) return;
2908 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2912 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2914 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2916 for (i=0; i<gl.gl_pathc; i++) {
2917 const char *path= gl.gl_pathv[i];
2919 if (strchr(path,'#') || strchr(path,'~')) {
2920 debug("backlog file search skipping %s", path);
2923 r= stat(path, &stab);
2925 syswarn("failed to stat backlog file %s", path);
2928 if (!S_ISREG(stab.st_mode)) {
2929 warn("backlog file %s is not a plain file (or link to one)", path);
2932 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2934 oldest_mtime= stab.st_mtime;
2937 case GLOB_NOMATCH: /* fall through */
2940 sysdie("glob expansion of backlog pattern %s gave unexpected"
2941 " nonzero (error?) return value %d", globpat_backlog, r);
2945 debug("backlog scan: none");
2947 if (sms==sm_DROPPED) {
2949 notice("feed dropped and our work is complete");
2951 int r= unlink(path_control);
2952 if (r && errno!=ENOENT)
2953 syswarn("failed to remove control symlink for old feed");
2955 xunlink(path_lock, "lockfile for old feed");
2958 until_backlog_nextscan= backlog_spontrescan_periods;
2963 double age= difftime(now, oldest_mtime);
2964 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2966 if (age_deficiency <= 0) {
2967 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2968 age, age_deficiency, oldest_path);
2970 backlog_input_file= open_input_file(oldest_path);
2971 if (!backlog_input_file) {
2972 warn("backlog file %s vanished as we opened it", oldest_path);
2976 inputfile_reading_start(backlog_input_file);
2977 until_backlog_nextscan= -1;
2981 until_backlog_nextscan= age_deficiency / period_seconds;
2983 if (backlog_spontrescan_periods >= 0 &&
2984 until_backlog_nextscan > backlog_spontrescan_periods)
2985 until_backlog_nextscan= backlog_spontrescan_periods;
2987 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2988 age, age_deficiency, until_backlog_nextscan, oldest_path);
2995 /*---------- shutdown and signal handling ----------*/
2997 static void preterminate(void) {
2998 if (in_child) return;
2999 notice_processed(main_input_file,0,"feedfile","");
3000 notice_processed(flushing_input_file,0,"flushing","");
3001 if (backlog_input_file)
3002 notice_processed(backlog_input_file,0, "backlog file ",
3003 backlog_input_file->path);
3006 static int signal_self_pipe[2];
3007 static sig_atomic_t terminate_sig_flag;
3009 static void raise_default(int signo) {
3010 xsigsetdefault(signo);
3015 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3016 assert(fd=signal_self_pipe[0]);
3018 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3019 if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
3020 if (r==0) die("eof on signal self pipe");
3021 if (terminate_sig_flag) {
3023 notice("terminating (%s)", strsignal(terminate_sig_flag));
3024 raise_default(terminate_sig_flag);
3026 return OOP_CONTINUE;
3029 static void sigarrived_handler(int signum) {
3034 if (!terminate_sig_flag) terminate_sig_flag= signum;
3039 write(signal_self_pipe[1],&x,1);
3042 static void init_signals(void) {
3043 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3044 sysdie("could not ignore SIGPIPE");
3046 if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3048 xsetnonblock(signal_self_pipe[0],1);
3049 xsetnonblock(signal_self_pipe[1],1);
3051 struct sigaction sa;
3052 memset(&sa,0,sizeof(sa));
3053 sa.sa_handler= sigarrived_handler;
3054 sa.sa_flags= SA_RESTART;
3055 xsigaction(SIGTERM,&sa);
3056 xsigaction(SIGINT,&sa);
3058 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3061 /*========== flushing the feed ==========*/
3063 static pid_t inndcomm_child;
3064 static int inndcomm_sentinel_fd;
3066 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3067 assert(inndcomm_child);
3068 assert(fd == inndcomm_sentinel_fd);
3069 int status= xwaitpid(&inndcomm_child, "inndcomm");
3072 cancel_fd_read_except(fd);
3073 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3074 inndcomm_sentinel_fd= 0;
3076 assert(!flushing_input_file);
3078 if (WIFEXITED(status)) {
3079 switch (WEXITSTATUS(status)) {
3081 case INNDCOMMCHILD_ESTATUS_FAIL:
3084 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3085 notice("feed has been dropped by innd, finishing up");
3086 flushing_input_file= main_input_file;
3087 tailing_queue_readable(flushing_input_file);
3088 /* we probably previously returned EAGAIN from our fake read method
3089 * when in fact we were at EOF, so signal another readable event
3090 * so we actually see the EOF */
3094 if (flushing_input_file) {
3095 SMS(DROPPING, max_separated_periods,
3096 "feed dropped by innd, but must finish last flush");
3099 SMS(DROPPED, 0, "feed dropped by innd");
3100 search_backlog_file();
3102 return OOP_CONTINUE;
3106 flushing_input_file= main_input_file;
3107 tailing_queue_readable(flushing_input_file);
3109 main_input_file= open_input_file(feedfile);
3110 if (!main_input_file)
3111 die("flush succeeded but feedfile %s does not exist!", feedfile);
3113 if (flushing_input_file) {
3114 SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3117 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3119 return OOP_CONTINUE;
3122 goto unexpected_exitstatus;
3125 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3126 warn("flush timed out trying to talk to innd");
3129 unexpected_exitstatus:
3130 report_child_status("inndcomm child", status);
3134 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3135 return OOP_CONTINUE;
3138 static void inndcommfail(const char *what) {
3139 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3140 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3143 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3146 notice("flushing %s",why);
3148 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3149 assert(!inndcomm_child);
3150 assert(!inndcomm_sentinel_fd);
3152 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3154 inndcomm_child= xfork("inndcomm child");
3156 if (!inndcomm_child) {
3157 const char *flushargv[2]= { sitename, 0 };
3161 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3162 /* parent spots the autoclose of pipefds[1] when we die or exit */
3164 if (simulate_flush>=0) {
3165 warn("SIMULATING flush child status %d", simulate_flush);
3166 if (simulate_flush>128) raise(simulate_flush-128);
3167 else exit(simulate_flush);
3170 alarm(inndcomm_flush_timeout);
3171 r= ICCopen(); if (r) inndcommfail("connect");
3172 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3173 if (!r) exit(0); /* yay! */
3175 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3176 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3177 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3182 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3183 inndcomm_sentinel_fd= pipefds[0];
3184 assert(inndcomm_sentinel_fd);
3185 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3187 SMS(FLUSHING, 0, why);
3190 /*========== main program ==========*/
3192 static void postfork_inputfile(InputFile *ipf) {
3194 xclose(ipf->fd, "(in child) input file ", ipf->path);
3197 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3198 /* we have no stdio streams that are buffered long-term */
3200 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3203 static void postfork(void) {
3206 xsigsetdefault(SIGTERM);
3207 xsigsetdefault(SIGINT);
3208 xsigsetdefault(SIGPIPE);
3209 if (terminate_sig_flag) raise(terminate_sig_flag);
3211 postfork_inputfile(main_input_file);
3212 postfork_inputfile(flushing_input_file);
3216 conn_closefd(conn,"(in child) ");
3218 postfork_stdio(defer, "defer file ", path_defer);
3221 typedef struct Every Every;
3223 struct timeval interval;
3228 static void every_schedule(Every *e, struct timeval base);
3230 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3233 if (!e->fixed_rate) xgettimeofday(&base);
3234 every_schedule(e, base);
3235 return OOP_CONTINUE;
3238 static void every_schedule(Every *e, struct timeval base) {
3239 struct timeval when;
3240 timeradd(&base, &e->interval, &when);
3241 loop->on_time(loop, when, every_happens, e);
3244 static void every(int interval, int fixed_rate, void (*f)(void)) {
3245 NEW_DECL(Every *,e);
3246 e->interval.tv_sec= interval;
3247 e->interval.tv_usec= 0;
3248 e->fixed_rate= fixed_rate;
3251 xgettimeofday(&now);
3252 every_schedule(e, now);
3255 static void filepoll(void) {
3256 filemon_callback(main_input_file);
3257 filemon_callback(flushing_input_file);
3260 static char *debug_report_ipf(InputFile *ipf) {
3261 if (!ipf) return xasprintf("none");
3263 const char *slash= strrchr(ipf->path,'/');
3264 const char *path= slash ? slash+1 : ipf->path;
3266 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3268 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3269 (long)ipf->offset, ipf->fd,
3270 ipf->rd ? "" : ",!rd",
3271 ipf->skippinglong ? "*skiplong" : "",
3272 ipf->rd && ipf->paused ? "*paused" : "");
3275 static void period(void) {
3276 char *dipf_main= debug_report_ipf(main_input_file);
3277 char *dipf_flushing= debug_report_ipf(flushing_input_file);
3278 char *dipf_backlog= debug_report_ipf(backlog_input_file);
3281 " sms=%s[%d] conns=%d until_connect=%d"
3282 " input_files main:%s flushing:%s backlog:%s[%d]"
3283 " children connecting=%ld inndcomm=%ld"
3285 sms_names[sms], until_flush, conns.count, until_connect,
3286 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3287 (long)connecting_child, (long)inndcomm_child
3291 free(dipf_flushing);
3294 if (until_connect) until_connect--;
3296 inputfile_queue_check_expired(backlog_input_file);
3297 poll_backlog_file();
3298 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3299 statemc_period_poll();
3300 check_assign_articles();
3305 /*========== dumping state ==========*/
3307 static void dump_article_list(FILE *f, const ControlCommand *c,
3308 const ArticleList *al) {
3309 fprintf(f, " count=%d\n", al->count);
3310 if (!c->xval) return;
3312 int i; Article *art;
3313 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3314 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3315 DUMPV("%p", art->,ipf);
3316 DUMPV("%d", art->,missing);
3317 DUMPV("%lu", (unsigned long)art->,offset);
3318 DUMPV("%d", art->,blanklen);
3319 DUMPV("%d", art->,midlen);
3320 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3324 static void dump_input_file(FILE *f, const ControlCommand *c,
3325 InputFile *ipf, const char *wh) {
3326 char *dipf= debug_report_ipf(ipf);
3327 fprintf(f,"input %s %s", wh, dipf);
3331 DUMPV("%d", ipf->,readcount_ok);
3332 DUMPV("%d", ipf->,readcount_blank);
3333 DUMPV("%d", ipf->,readcount_err);
3337 ArtState state; const char *const *statename;
3338 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3339 #define RC_DUMP_FMT(x) " " #x "=%d"
3340 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3341 fprintf(f,"input %s counts %-11s"
3342 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3344 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3346 fprintf(f,"input %s queue", wh);
3347 dump_article_list(f,c,&ipf->queue);
3353 fprintf(cc->out, "dumping state to %s\n", path_dump);
3354 FILE *f= fopen(path_dump, "w");
3355 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3357 fprintf(f,"general");
3358 DUMPV("%s", sms_names,[sms]);
3359 DUMPV("%d", ,until_flush);
3360 DUMPV("%ld", (long),self_pid);
3361 DUMPV("%p", , defer);
3362 DUMPV("%d", , until_connect);
3363 DUMPV("%d", , until_backlog_nextscan);
3364 DUMPV("%d", , simulate_flush);
3365 fprintf(f,"\nnocheck");
3366 DUMPV("%#.10f", , accept_proportion);
3367 DUMPV("%d", , nocheck);
3368 DUMPV("%d", , nocheck_reported);
3371 fprintf(f,"special");
3372 DUMPV("%ld", (long),connecting_child);
3373 DUMPV("%d", , connecting_fdpass_sock);
3374 DUMPV("%d", , control_master);
3377 fprintf(f,"filemon ");
3378 filemon_method_dump_info(f);
3380 dump_input_file(f,c, main_input_file, "main" );
3381 dump_input_file(f,c, flushing_input_file, "flushing");
3382 dump_input_file(f,c, backlog_input_file, "backlog" );
3384 fprintf(f,"conns count=%d\n", conns.count);
3389 fprintf(f,"C%d",conn->fd);
3390 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3391 DUMPV("%d",conn->,stream); DUMPV("%d",conn->,quitting);
3392 DUMPV("%d",conn->,since_activity);
3395 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3396 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3397 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3399 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3400 for (i=0; i<conn->xmitu; i++) {
3401 const struct iovec *iv= &conn->xmit[i];
3402 const XmitDetails *xd= &conn->xmitd[i];
3405 case xk_Const: dinfo= xasprintf("Const"); break;
3406 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3410 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3411 sanitise(iv->iov_base, iv->iov_len));
3417 DUMPV("%s", , path_lock);
3418 DUMPV("%s", , path_flushing);
3419 DUMPV("%s", , path_defer);
3420 DUMPV("%s", , path_control);
3421 DUMPV("%s", , path_dump);
3422 DUMPV("%s", , globpat_backlog);
3425 if (!!ferror(f) + !!fclose(f)) {
3426 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3431 /*========== option parsing ==========*/
3433 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3434 static void vbadusage(const char *fmt, va_list al) {
3435 char *m= xvasprintf(fmt,al);
3436 fprintf(stderr, "bad usage: %s\n"
3437 "say --help for help, or read the manpage\n",
3440 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3444 /*---------- generic option parser ----------*/
3446 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3447 static void badusage(const char *fmt, ...) {
3454 of_seconds= 001000u,
3455 of_boolean= 002000u,
3458 typedef struct Option Option;
3459 typedef void OptionParser(const Option*, const char *val);
3463 const char *lng, *formarg;
3469 static void parse_options(const Option *options, char ***argvp) {
3470 /* on return *argvp is first non-option arg; argc is not updated */
3473 const char *arg= *++(*argvp);
3475 if (*arg != '-') break;
3476 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3478 while ((a= *++arg)) {
3482 char *equals= strchr(arg,'=');
3483 int len= equals ? (equals - arg) : strlen(arg);
3484 for (o=options; o->shrt || o->lng; o++)
3485 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3487 badusage("unknown long option --%s",arg);
3490 if (equals) badusage("option --%s does not take a value",o->lng);
3492 } else if (equals) {
3496 if (!arg) badusage("option --%s needs a value for %s",
3497 o->lng, o->formarg);
3500 break; /* eaten the whole argument now */
3502 for (o=options; o->shrt || o->lng; o++)
3505 badusage("unknown short option -%c",a);
3512 if (!arg) badusage("option -%c needs a value for %s",
3513 o->shrt, o->formarg);
3516 break; /* eaten the whole argument now */
3522 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3524 static void print_options(const Option *options, FILE *f) {
3526 for (o=options; o->shrt || o->lng; o++) {
3527 char shrt[2] = { o->shrt, 0 };
3528 char *optspec= xasprintf("%s%s%s%s%s",
3529 o->shrt ? "-" : "", shrt,
3530 o->shrt && o->lng ? "|" : "",
3531 DELIMPERHAPS("--", o->lng));
3532 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3537 /*---------- specific option types ----------*/
3539 static void op_integer(const Option *o, const char *val) {
3542 unsigned long ul= strtoul(val,&ep,10);
3543 if (*ep || ep==val || errno || ul>INT_MAX)
3544 badusage("bad integer value for %s",o->lng);
3545 int *store= o->store;
3549 static void op_double(const Option *o, const char *val) {
3550 int *store= o->store;
3553 *store= strtod(val, &ep);
3554 if (*ep || ep==val || errno)
3555 badusage("bad floating point value for %s",o->lng);
3558 static void op_string(const Option *o, const char *val) {
3559 const char **store= o->store;
3563 static void op_seconds(const Option *o, const char *val) {
3564 int *store= o->store;
3568 double v= strtod(val,&ep);
3569 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3571 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3572 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3573 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3574 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3575 else if (!strcmp(ep,"das")) unit= 10;
3576 else if (!strcmp(ep,"hs")) unit= 100;
3577 else if (!strcmp(ep,"ks")) unit= 1000;
3578 else if (!strcmp(ep,"Ms")) unit= 1000000;
3579 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3583 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3587 static void op_setint(const Option *o, const char *val) {
3588 int *store= o->store;
3592 /*---------- specific options ----------*/
3594 static void help(const Option *o, const char *val);
3596 static const Option innduct_options[]= {
3597 {'f',"feedfile", "F", &feedfile, op_string },
3598 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3599 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3600 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3601 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3602 {'C',"inndconf", "F", &inndconffile, op_string },
3603 {'P',"port", "PORT", &port, op_integer },
3604 {0,"ctrl-sock-dir", 0, &realsockdir, op_string },
3605 {0,"help", 0, 0, help },
3607 {0,"max-connections", "N", &max_connections, op_integer },
3608 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3609 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3610 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3611 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3613 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3614 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3615 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3617 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3618 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3620 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3621 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3622 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3623 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3624 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3625 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3626 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3628 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3629 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3634 static void printusage(FILE *f) {
3635 fputs("usage: innduct [options] site [fqdn]\n"
3636 "available options are:\n", f);
3637 print_options(innduct_options, f);
3640 static void help(const Option *o, const char *val) {
3642 if (ferror(stdout) || fflush(stdout)) {
3643 perror("innduct: writing help");
3649 static void convert_to_periods_rndup(int *store) {
3650 *store += period_seconds-1;
3651 *store /= period_seconds;
3654 int main(int argc, char **argv) {
3660 parse_options(innduct_options, &argv);
3665 if (!sitename) badusage("need site name argument");
3666 remote_host= *argv++;
3667 if (*argv) badusage("too many non-option arguments");
3671 int r= innconf_read(inndconffile);
3672 if (!r) badusage("could not read inn.conf (more info on stderr)");
3674 if (!remote_host) remote_host= sitename;
3676 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3677 badusage("nocheck threshold percentage must be between 0..100");
3678 nocheck_thresh *= 0.01;
3680 if (nocheck_decay < 0.1)
3681 badusage("nocheck decay articles must be at least 0.1");
3682 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3684 convert_to_periods_rndup(&reconnect_delay_periods);
3685 convert_to_periods_rndup(&flushfail_retry_periods);
3686 convert_to_periods_rndup(&backlog_retry_minperiods);
3687 convert_to_periods_rndup(&backlog_spontrescan_periods);
3688 convert_to_periods_rndup(&spontaneous_flush_periods);
3689 convert_to_periods_rndup(&max_separated_periods);
3690 convert_to_periods_rndup(&need_activity_periods);
3692 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3693 badusage("bad input data ratio must be between 0..100");
3694 max_bad_data_ratio *= 0.01;
3697 feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3698 } else if (!feedfile[0]) {
3699 badusage("feed filename must be nonempty");
3700 } else if (feedfile[strlen(feedfile)-1]=='/') {
3701 feedfile= xasprintf("%s%s",feedfile,sitename);
3704 if (max_queue_per_ipf<0)
3705 max_queue_per_ipf= max_queue_per_conn * 2;
3707 const char *feedfile_forbidden= "?*[~#";
3709 while ((c= *feedfile_forbidden++))
3710 if (strchr(feedfile, c))
3711 badusage("feed filename may not contain metacharacter %c",c);
3715 path_lock= xasprintf("%s_lock", feedfile);
3716 path_flushing= xasprintf("%s_flushing", feedfile);
3717 path_defer= xasprintf("%s_defer", feedfile);
3718 path_control= xasprintf("%s_control", feedfile);
3719 path_dump= xasprintf("%s_dump", feedfile);
3720 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3722 oop_source_sys *sysloop= oop_sys_new();
3723 if (!sysloop) sysdie("could not create liboop event loop");
3724 loop= (oop_source*)sysloop;
3728 if (become_daemon) {
3730 for (i=3; i<255; i++)
3731 /* do this now before we open syslog, etc. */
3733 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3735 int null= open("/dev/null",O_RDWR);
3736 if (null<0) sysfatal("failed to open /dev/null");
3740 xclose(null, "/dev/null original fd",0);
3742 pid_t child1= xfork("daemonise first fork");
3743 if (child1) _exit(0);
3745 pid_t sid= setsid();
3746 if (sid != child1) sysfatal("setsid failed");
3748 pid_t child2= xfork("daemonise second fork");
3749 if (child2) _exit(0);
3753 if (self_pid==-1) sysdie("getpid");
3768 notice("filemon: suppressed by command line option, polling");
3770 filemon_ok= filemon_method_init();
3772 warn("filemon: no file monitoring available, polling");
3775 every(filepoll_seconds,0,filepoll);
3777 every(period_seconds,1,period);
3783 void *run= oop_sys_run(sysloop);
3784 assert(run == OOP_ERROR);
3785 sysdie("event loop failed");