3 * tailing reliable realtime streaming feeder for inn
5 * Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
20 * (I believe that when you compile and link this as part of the inn2
21 * build, with the Makefile runes I have provided, all the libraries
22 * and files which end up included in innduct are licence-compatible
23 * with GPLv3. If not then please let me know. -Ian Jackson.)
27 * Newsfeeds file entries should look like this:
28 * host.name.of.site[/exclude,exclude,...]\
29 * :pattern,pattern...[/distribution,distribution...]\
33 * sitename[/exclude,exclude,...]\
34 * :pattern,pattern...[/distribution,distribution...]\
40 * or might be blanked out
41 * <spc><spc><spc><spc>....
43 * F site.name main feed file
44 * opened/created, then written, by innd
47 * tokens blanked out by duct when processed
48 * site.name_lock lock preventing multiple ducts
49 * to hold lock must open,F_SETLK[W]
50 * and then stat to check that locked file
51 * still has name site.name_lock
52 * holder of this lock is "duct"
53 * (only) lockholder may remove the lockfile
54 * D site.name_flushing temporary feed file during flush (or crash)
55 * hardlink created by duct
57 * site.name_defer 431'd articles, still being written,
58 * created, written, used by duct
60 * site.name_backlog.<date>.<inum>
61 * 431'd articles, ready for innxmit or duct
62 * created (link/mv) by duct
63 * site.name_backlog<anything-else> (where <anything-else> does not
64 * contain '#' or '~') eg
65 * site.name_backlog.manual
66 * anything the sysadmin likes (eg, feed files
67 * from old feeds to be merged into this one)
68 * created (link/mv) by admin
69 * may be symlinks (in which case links
70 * may be written through, but only links
73 * It is safe to remove backlog files manually,
74 * if it's desired to throw away the backlog.
76 * Backlog files are also processed by innduct. We find the oldest
77 * backlog file which is at least a certain amount old, and feed it
78 * back into our processing. When every article in it has been read
79 * and processed, we unlink it and look for another backlog file.
81 * If we don't have a backlog file that we're reading, we close the
82 * defer file that we're writing and make it into a backlog file at
83 * the first convenient opportunity.
94 | | <----------------<---------------------------------'|
100 | F: innd writing, duct reading |
103 | | duct decides time to flush |
104 | | duct makes hardlink |
106 | V <------------------------'|
108 | F == D: innd writing, duct reading both exist |
111 | | <-----------<-------------<--'|
112 | | open D F ENOENT |
115 | V <---------------------. |
118 | D: innd writing, duct reading; or ENOENT | |
120 | | duct requests flush of feed | |
121 | | (others can too, harmlessly) | |
125 | D: innd flushing, duct; or ENOENT | |
127 | | inndcomm flush fails | |
128 | |`-------------------------->------------------' |
130 | | inndcomm reports no such site |
131 | |`---------------------------------------------------- | -.
133 | | innd finishes writing D, creates F | |
134 | | inndcomm reports flush successful | |
137 | Separated <----------------' |
138 | F: innd writing F!=D /
139 | D: duct reading; or ENOENT both exist /
141 | | duct gets to the end of D /
142 | | duct opens F too /
145 | F: innd writing, duct reading |
146 | D: duct finishing V
148 | | duct finishes processing D F: ENOENT
149 | V duct unlinks D D: duct reading
151 `--<--' | duct finishes
161 "duct reading" means innduct is reading the file but also
162 overwriting processed tokens.
166 * rune for printing diagrams:
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
173 /*============================== PROGRAM ==============================*/
175 #define _GNU_SOURCE 1
181 #include "inndcomm.h"
183 #include "inn/list.h"
184 #include "inn/innconf.h"
185 #include "inn/messages.h"
188 #include <sys/types.h>
189 #include <sys/wait.h>
190 #include <sys/stat.h>
191 #include <sys/socket.h>
210 #include <oop-read.h>
212 /*----- general definitions, probably best not changed -----*/
214 #define CONNCHILD_ESTATUS_STREAM 24
215 #define CONNCHILD_ESTATUS_NOSTREAM 25
217 #define INNDCOMMCHILD_ESTATUS_FAIL 26
218 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
220 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
221 #define MAX_CLI_COMMAND 1000
223 #define VA va_list al; va_start(al,fmt)
224 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
225 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
226 #define NORET __attribute__((__noreturn__))
228 #define NEW(ptr) ((ptr)= zxmalloc(sizeof(*(ptr))))
229 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
231 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
233 #define FOR_CONN(conn) \
234 for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
236 /*----- doubly linked lists -----*/
238 #define ISNODE(T) struct node list_node
241 union { struct list li; T *for_type; } u; \
245 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
247 #define LIST_CHECKCANHAVENODE(l,n) \
248 ((void)((n) == ((l).u.for_type))) /* just for the type check */
250 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
251 ( LIST_CHECKCANHAVENODE(l,n), \
252 list_addsomehow(&(l).u.li, NODE((n))), \
256 #define LIST_REMSOMEHOW(l,list_remsomehow) \
257 ( (typeof((l).u.for_type)) \
260 list_remsomehow(&(l).u.li) ) \
266 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
267 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
268 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
269 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
271 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
272 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
273 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
274 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
276 #define LIST_REMOVE(l,n) \
277 ( LIST_CHECKCANHAVENODE(l,n), \
278 list_remove(NODE((n))), \
282 #define LIST_INSERT(l,n,pred) \
283 ( LIST_CHECKCANHAVENODE(l,n), \
284 LIST_CHECKCANHAVENODE(l,pred), \
285 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
289 /*----- type predeclarations -----*/
291 typedef struct Conn Conn;
292 typedef struct Article Article;
293 typedef struct InputFile InputFile;
294 typedef struct XmitDetails XmitDetails;
295 typedef struct Filemon_Perfile Filemon_Perfile;
296 typedef enum StateMachineState StateMachineState;
297 typedef struct CliCommand CliCommand;
302 /*----- function predeclarations -----*/
304 static void conn_maybe_write(Conn *conn);
305 static void conn_make_some_xmits(Conn *conn);
306 static void *conn_write_some_xmits(Conn *conn);
308 static void xmit_free(XmitDetails *d);
310 #define SMS(newstate, periods, why) \
311 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
312 static void statemc_setstate(StateMachineState newsms, int periods,
313 const char *forlog, const char *why);
315 static void statemc_start_flush(const char *why); /* Normal => Flushing */
316 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
317 static int trigger_flush_ok(const char *why /* 0 means timeout */);
318 /* => Flushing,FLUSHING, ret 1; or ret 0 */
320 static void article_done(Article *art, int whichcount);
322 static void check_assign_articles(void);
323 static void queue_check_input_done(void);
324 static void check_reading_pause_resume(InputFile *ipf);
326 static void statemc_check_flushing_done(void);
327 static void statemc_check_backlog_done(void);
329 static void postfork(void);
330 static void period(void);
332 static void open_defer(void);
333 static void close_defer(void);
334 static void search_backlog_file(void);
335 static void preterminate(void);
336 static void raise_default(int signo) NORET;
338 static void inputfile_reading_start(InputFile *ipf);
339 static void inputfile_reading_stop(InputFile *ipf);
340 static void inputfile_reading_pause(InputFile *ipf);
341 static void inputfile_reading_resume(InputFile *ipf);
342 /* pause and resume are idempotent, and no-op if not done _reading_start */
344 static void filemon_start(InputFile *ipf);
345 static void filemon_stop(InputFile *ipf);
346 static void tailing_make_readable(InputFile *ipf);
348 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
349 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
351 static const oop_rd_style peer_rd_style;
352 static oop_rd_call peer_rd_err, peer_rd_ok;
355 /*----- configuration options -----*/
356 /* when changing defaults, remember to update the manpage */
358 static const char *sitename, *remote_host;
359 static const char *feedfile, *path_run, *path_cli, *path_cli_dir;
360 static int quiet_multiple=0;
361 static int interactive=0, try_filemon=1;
362 static int try_stream=1;
364 static const char *inndconffile;
366 static int max_connections=10;
367 static int max_queue_per_conn=200;
368 static int target_max_feedfile_size=100000;
369 static int period_seconds=30;
370 static int filepoll_seconds=5;
371 static int max_queue_per_ipf=-1;
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
376 static double nocheck_thresh= 95.0; /* converted from percentage by main */
377 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=100;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
387 static int lowvol_thresh=3;
388 static int lowvol_periods=1000;
390 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
391 static int max_bad_data_initial= 30;
392 /* in one corrupt 4096-byte block the number of newlines has
393 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
396 /*----- statistics -----*/
398 typedef enum { /* in queue in conn->sent */
399 art_Unchecked, /* not checked, not sent checking */
400 art_Wanted, /* checked, wanted sent body as requested */
401 art_Unsolicited, /* - sent body without check */
405 static const char *const artstate_names[]=
406 { "Unchecked", "Wanted", "Unsolicited", 0 };
408 #define RESULT_COUNTS(RCS,RCN) \
417 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
418 #define RCI_TRIPLE_VALS_BASE(counts,x) \
419 counts[art_Unchecked] x \
420 + counts[art_Wanted] x \
421 + counts[art_Unsolicited] x, \
422 counts[art_Unchecked] x \
423 , counts[art_Wanted] x \
424 , counts[art_Unsolicited] x
427 #define RC_INDEX(x) RC_##x,
428 RESULT_COUNTS(RC_INDEX, RC_INDEX)
433 /*----- transmission buffers -----*/
449 /*----- core operational data structure types -----*/
452 /* This is also an instance of struct oop_readable */
453 struct oop_readable readable; /* first */
454 oop_readable_call *readable_callback;
455 void *readable_callback_user;
458 Filemon_Perfile *filemon;
460 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
462 int skippinglong, paused, fake_readable;
465 long inprogress; /* includes queue.count and also articles in conns */
466 long autodefer; /* -1 means not doing autodefer */
468 int counts[art_MaxState][RCI_max];
469 int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
484 #define SMS_LIST(X) \
492 enum StateMachineState {
493 #define SMS_DEF_ENUM(s) sm_##s,
494 SMS_LIST(SMS_DEF_ENUM)
497 static const char *sms_names[]= {
498 #define SMS_DEF_NAME(s) #s ,
499 SMS_LIST(SMS_DEF_NAME)
505 int fd; /* may be 0, meaning closed (during construction/destruction) */
506 oop_read *rd; /* likewise */
507 int oopwriting; /* since on_fd is not idempotent */
508 int max_queue, stream;
509 const char *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, *path_dump;
526 static char *globpat_backlog;
527 static pid_t self_pid;
528 static int *lowvol_perperiod;
529 static int lowvol_circptr;
530 static int lowvol_total; /* does not include current period */
532 /* statemc_init initialises */
533 static StateMachineState sms;
534 static int until_flush;
535 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
538 /* initialisation to 0 is good */
539 static int until_connect, until_backlog_nextscan;
540 static double accept_proportion;
541 static int nocheck, nocheck_reported, in_child;
543 /* for logging, simulation, debugging, etc. */
544 int simulate_flush= -1;
546 static const char *logv_prefix="";
548 /*========== logging ==========*/
550 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
551 static void logcore(int sysloglevel, const char *fmt, ...) {
553 if (logv_use_syslog) {
554 vsyslog(sysloglevel,fmt,al);
556 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
557 vfprintf(stderr,fmt,al);
563 static void logv(int sysloglevel, const char *pfx, int errnoval,
564 const char *fmt, va_list al) PRINTF(5,0);
565 static void logv(int sysloglevel, const char *pfx, int errnoval,
566 const char *fmt, va_list al) {
567 char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
568 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
569 msgbuf[sizeof(msgbuf)-1]= 0;
571 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
572 sysloglevel= LOG_ERR; /* run by wrong user, probably */
574 logcore(sysloglevel, "%s%s: %s%s%s",
575 logv_prefix, pfx, msgbuf,
576 errnoval>=0 ? ": " : "",
577 errnoval>=0 ? strerror(errnoval) : "");
580 #define DEFFATAL(fn, pfx, sysloglevel, err, estatus) \
581 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
582 static void fn(const char *fmt, ...) { \
585 logv(sysloglevel, pfx, err, fmt, al); \
589 #define DEFLOG(fn, pfx, sysloglevel, err) \
590 static void fn(const char *fmt, ...) PRINTF(1,2); \
591 static void fn(const char *fmt, ...) { \
593 logv(sysloglevel, pfx, err, fmt, al); \
597 #define INNLOGSET_DECLARE(fn, pfx, sysloglevel) \
598 static void duct_log_##fn(int l, const char *fmt, va_list al, int errval) \
600 static void duct_log_##fn(int l, const char *fmt, va_list al, int errval) { \
601 logv(sysloglevel, pfx, errval ? errval : -1, fmt, al); \
603 #define INNLOGSET_CALL(fn, pfx, sysloglevel) \
604 message_handlers_##fn(1, duct_log_##fn);
607 static int innduct_fatal_cleanup(void) { return 12; } /* used for libinn die */
609 /* We want to extend the set of logging functions from inn, and we
610 * want to prepend the site name to all our messages. */
612 DEFFATAL(syscrash, "critical", LOG_CRIT, errno, 16);
613 DEFFATAL(crash, "critical", LOG_CRIT, -1, 16);
615 #define INNLOGSETS(INNLOGSET) \
616 INNLOGSET(die, "fatal", LOG_ERR) \
617 INNLOGSET(warn, "warning", LOG_WARNING) \
618 INNLOGSET(notice, "notice", LOG_NOTICE) \
619 INNLOGSET(trace, "trace", LOG_NOTICE)
620 INNLOGSETS(INNLOGSET_DECLARE)
622 DEFLOG(info, "info", LOG_INFO, -1)
623 DEFLOG(dbg, "debug", LOG_DEBUG, -1)
626 /*========== utility functions etc. ==========*/
628 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
629 static char *xvasprintf(const char *fmt, va_list al) {
631 int rc= vasprintf(&str,fmt,al);
632 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
635 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
636 static char *xasprintf(const char *fmt, ...) {
638 char *str= xvasprintf(fmt,al);
643 static int close_perhaps(int *fd) {
644 if (*fd <= 0) return 0;
649 static void xclose(int fd, const char *what, const char *what2) {
651 if (r) syscrash("close %s%s",what,what2?what2:"");
653 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
654 if (*fd <= 0) return;
655 xclose(*fd,what,what2);
659 static pid_t xfork(const char *what) {
663 if (child==-1) sysdie("cannot fork for %s",what);
664 dbg("forked %s %ld", what, (unsigned long)child);
665 if (!child) postfork();
669 static void on_fd_read_except(int fd, oop_call_fd callback) {
670 loop->on_fd(loop, fd, OOP_READ, callback, 0);
671 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
673 static void cancel_fd_read_except(int fd) {
674 loop->cancel_fd(loop, fd, OOP_READ);
675 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
678 static void report_child_status(const char *what, int status) {
679 if (WIFEXITED(status)) {
680 int es= WEXITSTATUS(status);
682 warn("%s: child died with error exit status %d", what, es);
683 } else if (WIFSIGNALED(status)) {
684 int sig= WTERMSIG(status);
685 const char *sigstr= strsignal(sig);
686 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
688 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
690 warn("%s: child died due to unknown fatal signal %d%s",
691 what, sig, coredump);
693 warn("%s: child died with unknown wait status %d", what,status);
697 static int xwaitpid(pid_t *pid, const char *what) {
700 int r= kill(*pid, SIGKILL);
701 if (r) syscrash("cannot kill %s child", what);
703 pid_t got= waitpid(*pid, &status, 0);
704 if (got==-1) syscrash("cannot reap %s child", what);
705 if (got==0) crash("cannot reap %s child", what);
712 static void *zxmalloc(size_t sz) {
713 void *p= xmalloc(sz);
718 static void xunlink(const char *path, const char *what) {
720 if (r) syscrash("can't unlink %s %s", path, what);
723 static time_t xtime(void) {
725 if (now==-1) syscrash("time(2) failed");
729 static void xsigaction(int signo, const struct sigaction *sa) {
730 int r= sigaction(signo,sa,0);
731 if (r) syscrash("sigaction failed for \"%s\"", strsignal(signo));
734 static void xsigsetdefault(int signo) {
736 memset(&sa,0,sizeof(sa));
737 sa.sa_handler= SIG_DFL;
738 xsigaction(signo,&sa);
741 static void xgettimeofday(struct timeval *tv_r) {
742 int r= gettimeofday(tv_r,0);
743 if (r) syscrash("gettimeofday(2) failed");
746 static void xsetnonblock(int fd, int nonb) {
747 int errnoval= oop_fd_nonblock(fd, nonb);
748 if (errnoval) { errno= errnoval; syscrash("setnonblocking"); }
751 static void check_isreg(const struct stat *stab, const char *path,
753 if (!S_ISREG(stab->st_mode))
754 crash("%s %s not a plain file (mode 0%lo)",
755 what, path, (unsigned long)stab->st_mode);
758 static void xfstat(int fd, struct stat *stab_r, const char *what) {
759 int r= fstat(fd, stab_r);
760 if (r) syscrash("could not fstat %s", what);
763 static void xfstat_isreg(int fd, struct stat *stab_r,
764 const char *path, const char *what) {
765 xfstat(fd, stab_r, what);
766 check_isreg(stab_r, path, what);
769 static void xlstat_isreg(const char *path, struct stat *stab,
770 int *enoent_r /* 0 means ENOENT is fatal */,
772 int r= lstat(path, stab);
774 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
775 syscrash("could not lstat %s %s", what, path);
777 if (enoent_r) *enoent_r= 0;
778 check_isreg(stab, path, what);
781 static int samefile(const struct stat *a, const struct stat *b) {
782 assert(S_ISREG(a->st_mode));
783 assert(S_ISREG(b->st_mode));
784 return (a->st_ino == b->st_ino &&
785 a->st_dev == b->st_dev);
788 static char *sanitise(const char *input, int len) {
789 static char sanibuf[100]; /* returns pointer to this buffer! */
791 const char *p= input;
792 const char *endp= len>=0 ? input+len : 0;
796 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
797 int c= (!endp || p<endp) ? *p++ : 0;
798 if (!c) { *q++= '\''; *q=0; break; }
799 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
800 sprintf(q,"\\x%02x",c);
806 static int isewouldblock(int errnoval) {
807 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
810 /*========== command and control (CLI) connections ==========*/
812 static int cli_master;
814 typedef struct CliConn CliConn;
816 void (*destroy)(CliConn*);
822 struct sockaddr_un un;
827 static const oop_rd_style cli_rd_style= {
828 OOP_RD_DELIM_STRIP, '\n',
830 OOP_RD_SHORTREC_FORBID
833 static void cli_destroy(CliConn *cc) {
837 static void cli_checkouterr(CliConn *cc /* may destroy*/) {
838 if (ferror(cc->out) | fflush(cc->out)) {
839 info("CTRL%d write error %s", cc->fd, strerror(errno));
844 static void cli_prompt(CliConn *cc /* may destroy*/) {
845 fprintf(cc->out, "%s| ", sitename);
851 void (*f)(CliConn *cc, const CliCommand *ccmd,
852 const char *arg, size_t argsz);
857 static const CliCommand cli_commands[];
860 static void ccmd_##wh(CliConn *cc, const CliCommand *c, \
861 const char *arg, size_t argsz)
864 fputs("commands:\n", cc->out);
865 const CliCommand *ccmd;
866 for (ccmd=cli_commands; ccmd->cmd; ccmd++)
867 fprintf(cc->out, " %s\n", ccmd->cmd);
868 fputs("NB: permissible arguments are not shown above."
869 " Not all commands listed are safe. See innduct(8).\n", cc->out);
873 int ok= trigger_flush_ok("manual request");
874 if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
879 notice("terminating (CTRL%d)",cc->fd);
880 raise_default(SIGTERM);
886 /* messing with our head: */
887 CCMD(period) { period(); }
888 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
889 CCMD(setint) { *(int*)c->xdata= c->xval; }
890 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
892 static const CliCommand cli_commands[]= {
894 { "flush", ccmd_flush },
895 { "stop", ccmd_stop },
896 { "dump q", ccmd_dump, 0,0 },
897 { "dump a", ccmd_dump, 0,1 },
899 { "p", ccmd_period },
901 #define POKES(cmd,func) \
902 { cmd "flush", func, &until_flush, 1 }, \
903 { cmd "conn", func, &until_connect, 0 }, \
904 { cmd "blscan", func, &until_backlog_nextscan, 0 },
905 POKES("next ", ccmd_setint)
906 POKES("prod ", ccmd_setint_period)
908 { "pretend flush", ccmd_setintarg, &simulate_flush },
909 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
913 static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
914 const char *errmsg, int errnoval,
915 const char *data, size_t recszu, void *cc_v) {
919 info("CTRL%d closed", cc->fd);
924 if (recszu == 0) goto prompt;
925 assert(recszu <= INT_MAX);
928 const CliCommand *ccmd;
929 for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
930 int l= strlen(ccmd->cmd);
931 if (recsz < l) continue;
932 if (recsz > l && data[l] != ' ') continue;
933 if (memcmp(data, ccmd->cmd, l)) continue;
935 int argl= (int)recsz - (l+1);
936 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
940 fputs("unknown command; h for help\n", cc->out);
947 static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
948 const char *errmsg, int errnoval,
949 const char *data, size_t recsz, void *cc_v) {
952 info("CTRL%d read error %s", cc->fd, errmsg);
957 static int cli_conn_startup(CliConn *cc /* may destroy*/,
959 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
960 if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
962 int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
965 if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
967 info("CTRL%d %s ready", cc->fd, how);
972 static void cli_stdio_destroy(CliConn *cc) {
974 oop_rd_cancel(cc->rd);
975 errno= oop_rd_delete_tidy(cc->rd);
976 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
981 static void cli_stdio(void) {
982 NEW_DECL(CliConn *,cc);
983 cc->destroy= cli_stdio_destroy;
987 int r= cli_conn_startup(cc,"stdio");
988 if (r) cc->destroy(cc);
991 static void cli_accepted_destroy(CliConn *cc) {
993 oop_rd_cancel(cc->rd);
994 oop_rd_delete_kill(cc->rd);
996 if (cc->out) { fclose(cc->out); cc->fd=0; }
997 close_perhaps(&cc->fd);
1001 static void *cli_master_readable(oop_source *lp, int master,
1002 oop_event ev, void *u) {
1003 NEW_DECL(CliConn *,cc);
1004 cc->destroy= cli_accepted_destroy;
1006 cc->salen= sizeof(cc->sa);
1007 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
1008 if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
1010 cc->out= fdopen(cc->fd, "w");
1011 if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
1013 int r= cli_conn_startup(cc, "accepted");
1016 return OOP_CONTINUE;
1020 return OOP_CONTINUE;
1023 #define NOCLI(...) do{ \
1024 syswarn("no cli listener, because failed to " __VA_ARGS__); \
1028 static void cli_init(void) {
1031 struct sockaddr_un un;
1034 memset(&sa,0,sizeof(sa));
1035 int maxlen= sizeof(sa.un.sun_path);
1038 info("control command line disabled");
1042 int pathlen= strlen(path_cli);
1043 if (pathlen > maxlen) {
1044 warn("no cli listener, because cli socket path %s too long (%d>%d)",
1045 path_cli, pathlen, maxlen);
1050 int r= mkdir(path_cli_dir, 0700);
1051 if (r && errno!=EEXIST)
1052 NOCLI("create cli socket directory %s", path_cli_dir);
1055 int r= unlink(path_cli);
1056 if (r && errno!=ENOENT)
1057 NOCLI("remove old cli socket %s", path_cli);
1059 cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1060 if (cli_master<0) NOCLI("create new cli master socket");
1062 int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1063 sa.un.sun_family= AF_UNIX;
1064 memcpy(sa.un.sun_path, path_cli, pathlen);
1066 r= bind(cli_master, &sa.sa, sl);
1067 if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1069 r= listen(cli_master, 5);
1070 if (r) NOCLI("listen to cli master socket");
1072 xsetnonblock(cli_master, 1);
1074 loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1075 info("cli ready, listening on %s", path_cli);
1080 xclose_perhaps(&cli_master, "cli master",0);
1084 /*========== management of connections ==========*/
1086 static void reconnect_blocking_event(void) {
1087 until_connect= reconnect_delay_periods;
1090 static void conn_closefd(Conn *conn, const char *msgprefix) {
1091 int r= close_perhaps(&conn->fd);
1092 if (r) info("C%d %serror closing socket: %s",
1093 conn->fd, msgprefix, strerror(errno));
1096 static int conn_busy(Conn *conn) {
1098 conn->waiting.count ||
1099 conn->priority.count ||
1104 static void conn_dispose(Conn *conn) {
1107 oop_rd_cancel(conn->rd);
1108 oop_rd_delete_kill(conn->rd);
1112 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1113 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1115 conn_closefd(conn,"");
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 LIST_REMOVE(conns,conn);
1158 char *m= xvasprintf(fmt,al);
1159 warn("C%d (now %d) connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1160 conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1163 reconnect_blocking_event();
1165 check_assign_articles();
1168 static void connfail(Conn *conn, const char *fmt, ...) {
1171 vconnfail(conn,fmt,al);
1175 static void conn_idle_close(Conn *conn, const char *why) {
1176 static const char quitcmd[]= "QUIT\r\n";
1177 int todo= sizeof(quitcmd)-1;
1178 const char *p= quitcmd;
1180 int r= write(conn->fd, p, todo);
1182 if (isewouldblock(errno))
1183 connfail(conn, "blocked writing QUIT to idle connection");
1185 connfail(conn, "failed to write QUIT to idle connection: %s",
1192 conn->quitting= why;
1193 conn->since_activity= 0;
1194 dbg("C%d is idle (%s), quitting", conn->fd, why);
1201 * For our last connection, we also shut it down if we have had
1202 * less than K in the last L
1204 static void check_idle_conns(void) {
1207 int volthisperiod= lowvol_perperiod[lowvol_circptr];
1209 lowvol_circptr %= lowvol_periods;
1210 lowvol_total += volthisperiod;
1211 lowvol_total -= lowvol_perperiod[lowvol_circptr];
1212 lowvol_perperiod[lowvol_circptr]= 0;
1215 conn->since_activity++;
1219 if (conn->since_activity <= need_activity_periods) continue;
1221 /* We need to shut this down */
1223 connfail(conn,"timed out waiting for response to QUIT (%s)",
1225 else if (conn->sent.count)
1226 connfail(conn,"timed out waiting for responses");
1227 else if (conn->waiting.count || conn->priority.count)
1228 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1229 else if (conn->xmitu)
1230 connfail(conn,"peer has been sending responses"
1231 " before receiving our commands!");
1233 conn_idle_close(conn, "no activity");
1238 conn= LIST_HEAD(conns);
1239 if (!volthisperiod &&
1241 lowvol_total < lowvol_thresh &&
1243 conn_idle_close(conn, "low volume");
1246 /*---------- making new connections ----------*/
1248 static pid_t connecting_child;
1249 static int connecting_fdpass_sock;
1251 static void connect_attempt_discard(void) {
1252 if (connecting_child) {
1253 int status= xwaitpid(&connecting_child, "connect");
1254 if (!(WIFEXITED(status) ||
1255 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1256 report_child_status("connect", status);
1258 if (connecting_fdpass_sock) {
1259 cancel_fd_read_except(connecting_fdpass_sock);
1260 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1264 #define PREP_DECL_MSG_CMSG(msg) \
1266 struct iovec msgiov; \
1267 msgiov.iov_base= &msgbyte; \
1268 msgiov.iov_len= 1; \
1269 struct msghdr msg; \
1270 memset(&msg,0,sizeof(msg)); \
1271 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1272 msg.msg_iov= &msgiov; \
1273 msg.msg_iovlen= 1; \
1274 msg.msg_control= msg##cbuf; \
1275 msg.msg_controllen= sizeof(msg##cbuf);
1277 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1280 assert(fd == connecting_fdpass_sock);
1282 PREP_DECL_MSG_CMSG(msg);
1284 ssize_t rs= recvmsg(fd, &msg, 0);
1286 if (isewouldblock(errno)) return OOP_CONTINUE;
1287 syswarn("failed to read socket from connecting child");
1292 LIST_INIT(conn->waiting);
1293 LIST_INIT(conn->priority);
1294 LIST_INIT(conn->sent);
1296 struct cmsghdr *h= 0;
1297 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1299 int status= xwaitpid(&connecting_child, "connect child (broken)");
1301 if (WIFEXITED(status)) {
1302 if (WEXITSTATUS(status) != 0 &&
1303 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1304 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1305 /* child already reported the problem */;
1307 if (e == OOP_EXCEPTION)
1308 warn("connect: connection child exited code %d but"
1309 " unexpected exception on fdpass socket",
1310 WEXITSTATUS(status));
1312 warn("connect: connection child exited code %d but"
1314 WEXITSTATUS(status), (int)rs);
1316 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1317 warn("connect: connection attempt timed out");
1319 report_child_status("connect", status);
1324 #define CHK(field, val) \
1325 if (h->cmsg_##field != val) { \
1326 crash("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1327 h->cmsg_##field, val); \
1330 CHK(level, SOL_SOCKET);
1331 CHK(type, SCM_RIGHTS);
1332 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1335 if (CMSG_NXTHDR(&msg,h)) crash("connect: child sent many cmsgs");
1337 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1340 pid_t got= waitpid(connecting_child, &status, 0);
1341 if (got==-1) syscrash("connect: real wait for child");
1342 assert(got == connecting_child);
1343 connecting_child= 0;
1345 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1346 int es= WEXITSTATUS(status);
1348 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1349 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1351 die("connect: child gave unexpected exit status %d", es);
1355 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1357 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1358 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1359 if (!conn->fd) crash("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1360 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1362 &peer_rd_err, conn);
1363 if (r) syscrash("oop_rd_read for peer (fd=%d)",conn->fd);
1365 LIST_ADDHEAD(conns, conn);
1366 notice("C%d (now %d) connected %s",
1367 conn->fd, conns.count, conn->stream ? "streaming" : "plain");
1369 connect_attempt_discard();
1370 check_assign_articles();
1371 return OOP_CONTINUE;
1375 connect_attempt_discard();
1376 reconnect_blocking_event();
1377 return OOP_CONTINUE;
1380 static int allow_connect_start(void) {
1381 return conns.count < max_connections
1382 && !connecting_child
1386 static void connect_start(void) {
1387 assert(!connecting_child);
1388 assert(!connecting_fdpass_sock);
1390 info("starting connection attempt");
1391 int ok_until_connect= until_connect;
1392 reconnect_blocking_event();
1395 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1396 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1398 connecting_child= xfork("connection");
1400 if (!connecting_child) {
1401 FILE *cn_from, *cn_to;
1402 char buf[NNTP_STRLEN+100];
1403 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1405 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1407 alarm(connection_setup_timeout);
1408 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1412 unsigned char c= buf[l-1];
1413 if (!isspace(c)) break;
1414 if (c=='\n' || c=='\r') stripped=1;
1418 sysdie("connect: connection attempt failed");
1421 die("connect: %s: %s", stripped ? "rejected" : "failed",
1425 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1426 sysdie("connect: authentication failed");
1428 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1430 sysdie("connect: could not send MODE STREAM");
1431 buf[sizeof(buf)-1]= 0;
1432 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1433 if (ferror(cn_from))
1434 sysdie("connect: could not read response to MODE STREAM");
1436 die("connect: connection close in response to MODE STREAM");
1441 die("connect: response to MODE STREAM is too long: %.100s...",
1443 l--; if (l>0 && buf[l-1]=='\r') l--;
1446 int rcode= strtoul(buf,&ep,10);
1448 die("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1452 exitstatus= CONNCHILD_ESTATUS_STREAM;
1458 warn("connect: unexpected response to MODE STREAM: %.50s",
1464 int fd= fileno(cn_from);
1466 PREP_DECL_MSG_CMSG(msg);
1467 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1468 cmsg->cmsg_level= SOL_SOCKET;
1469 cmsg->cmsg_type= SCM_RIGHTS;
1470 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1471 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1473 msg.msg_controllen= cmsg->cmsg_len;
1474 r= sendmsg(socks[1], &msg, 0);
1475 if (r<0) syscrash("sendmsg failed for new connection");
1476 if (r!=1) crash("sendmsg for new connection gave wrong result %d",r);
1481 xclose(socks[1], "connecting fdpass child's socket",0);
1482 connecting_fdpass_sock= socks[0];
1483 xsetnonblock(connecting_fdpass_sock, 1);
1484 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1487 until_connect= ok_until_connect;
1490 /*---------- assigning articles to conns, and transmitting ----------*/
1492 static Article *dequeue_from(int peek, InputFile *ipf) {
1494 if (peek) return LIST_HEAD(ipf->queue);
1496 Article *art= LIST_REMHEAD(ipf->queue);
1498 check_reading_pause_resume(ipf);
1502 static Article *dequeue(int peek) {
1504 art= dequeue_from(peek, flushing_input_file); if (art) return art;
1505 art= dequeue_from(peek, backlog_input_file); if (art) return art;
1506 art= dequeue_from(peek, main_input_file); if (art) return art;
1510 static void check_assign_articles(void) {
1516 int spare=0, inqueue=0;
1518 /* Find a connection to offer this article. We prefer a busy
1519 * connection to an idle one, provided it's not full. We take the
1520 * first (oldest) and since that's stable, it will mean we fill up
1521 * connections in order. That way if we have too many
1522 * connections, the spare ones will go away eventually.
1525 if (walk->quitting) continue;
1526 inqueue= walk->sent.count + walk->priority.count
1527 + walk->waiting.count;
1528 spare= walk->max_queue - inqueue;
1529 assert(inqueue <= max_queue_per_conn);
1531 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1532 else if (spare>0) /*working*/ { use= walk; break; }
1535 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1537 Article *art= dequeue(0);
1539 LIST_ADDTAIL(use->waiting, art);
1540 lowvol_perperiod[lowvol_circptr]++;
1543 conn_maybe_write(use);
1544 } else if (allow_connect_start()) {
1553 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1554 conn_maybe_write(u);
1555 return OOP_CONTINUE;
1558 static void conn_maybe_write(Conn *conn) {
1560 conn_make_some_xmits(conn);
1562 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1563 conn->oopwriting= 0;
1567 void *rp= conn_write_some_xmits(conn);
1568 if (rp==OOP_CONTINUE) {
1569 if (!conn->oopwriting) {
1570 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1571 conn->oopwriting= 1;
1574 } else if (rp==OOP_HALT) {
1577 /* transmitted everything */
1584 /*---------- expiry, flow control and deferral ----------*/
1587 * flow control notes
1588 * to ensure articles go away eventually
1589 * separate queue for each input file
1591 * every period, check head of backlog queue for expiry with SMretrieve
1592 * if too old: discard, and check next article
1593 * also check every backlog article as we read it
1595 * after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1596 * one-off: eat queued articles from flushing and write them to defer
1597 * one-off: connfail all connections which have any articles from flushing
1598 * newly read articles from flushing go straight to defer
1599 * this should take care of it and get us out of this state
1600 * to avoid filling up ram needlessly
1602 * limit number of queued articles for each ipf
1603 * pause/resume inputfile tailing
1606 static void check_reading_pause_resume(InputFile *ipf) {
1607 if (ipf->queue.count >= max_queue_per_ipf)
1608 inputfile_reading_pause(ipf);
1610 inputfile_reading_resume(ipf);
1613 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1615 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1617 sysdie("write to defer file %s",path_defer);
1618 article_done(art, whichcount);
1621 static int article_check_expired(Article *art /* must be queued, not conn */) {
1622 ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1623 if (artdata) { SMfreearticle(artdata); return 0; }
1625 LIST_REMOVE(art->ipf->queue, art);
1627 art->ipf->count_nooffer_missing++;
1628 article_done(art,-1);
1632 static void inputfile_queue_check_expired(InputFile *ipf) {
1636 Article *art= LIST_HEAD(ipf->queue);
1637 int expd= article_check_expired(art);
1640 check_reading_pause_resume(ipf);
1643 static void article_autodefer(InputFile *ipf, Article *art) {
1645 article_defer(art,-1);
1648 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1650 for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1651 if (art->ipf == ipf) return 1;
1655 static void autodefer_input_file_articles(InputFile *ipf) {
1657 while ((art= LIST_REMHEAD(ipf->queue)))
1658 article_autodefer(ipf, art);
1661 static void autodefer_input_file(InputFile *ipf) {
1662 static const char *const abandon= "stuck";
1665 autodefer_input_file_articles(ipf);
1667 if (ipf->inprogress) {
1670 if (has_article_in(&walk->waiting, ipf) ||
1671 has_article_in(&walk->priority, ipf) ||
1672 has_article_in(&walk->sent, ipf))
1673 walk->quitting= abandon;
1675 while (ipf->inprogress) {
1677 if (walk->quitting == abandon) goto found;
1678 abort(); /* where are they ?? */
1681 connfail(walk, "connection is stuck or crawling,"
1682 " and we need to finish flush");
1683 autodefer_input_file_articles(ipf);
1687 check_reading_pause_resume(ipf);
1690 /*========== article transmission ==========*/
1692 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1693 XmitKind kind) { /* caller must then fill in details */
1694 struct iovec *v= &conn->xmit[conn->xmitu];
1695 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1696 v->iov_base= (char*)data;
1702 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1703 xmit_core(conn,data,len, xk_Const);
1705 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1707 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1708 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1712 static void xmit_free(XmitDetails *d) {
1714 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1715 case xk_Const: break;
1720 static void *conn_write_some_xmits(Conn *conn) {
1722 * 0: nothing more to write, no need to call us again
1723 * OOP_CONTINUE: more to write but fd not writeable
1724 * OOP_HALT: disaster, have destroyed conn
1727 int count= conn->xmitu;
1728 if (!count) return 0;
1730 if (count > IOV_MAX) count= IOV_MAX;
1731 ssize_t rs= writev(conn->fd, conn->xmit, count);
1733 if (isewouldblock(errno)) return OOP_CONTINUE;
1734 connfail(conn, "write failed: %s", strerror(errno));
1740 for (done=0; rs; ) {
1741 assert(done<conn->xmitu);
1742 struct iovec *vp= &conn->xmit[done];
1743 XmitDetails *dp= &conn->xmitd[done];
1744 assert(vp->iov_len <= SSIZE_MAX);
1745 if ((size_t)rs >= vp->iov_len) {
1747 xmit_free(dp); /* vp->iov_len -= vp->iov_len, etc. */
1750 vp->iov_base= (char*)vp->iov_base + rs;
1752 break; /* rs -= rs */
1755 int newu= conn->xmitu - done;
1756 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1757 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1762 static void conn_make_some_xmits(Conn *conn) {
1764 if (conn->xmitu+5 > CONNIOVS)
1767 Article *art= LIST_REMHEAD(conn->priority);
1768 if (!art) art= LIST_REMHEAD(conn->waiting);
1771 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1772 /* actually send it */
1774 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1777 art->state == art_Unchecked ? art_Unsolicited :
1778 art->state == art_Wanted ? art_Wanted :
1781 if (!artdata) art->missing= 1;
1782 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1786 XMIT_LITERAL("TAKETHIS ");
1787 xmit_noalloc(conn, art->messageid, art->midlen);
1788 XMIT_LITERAL("\r\n");
1789 xmit_artbody(conn, artdata);
1791 article_done(art, -1);
1795 /* we got 235 from IHAVE */
1797 xmit_artbody(conn, artdata);
1799 XMIT_LITERAL(".\r\n");
1803 LIST_ADDTAIL(conn->sent, art);
1809 XMIT_LITERAL("CHECK ");
1811 XMIT_LITERAL("IHAVE ");
1812 xmit_noalloc(conn, art->messageid, art->midlen);
1813 XMIT_LITERAL("\r\n");
1815 assert(art->state == art_Unchecked);
1816 art->ipf->counts[art->state][RC_sent]++;
1817 LIST_ADDTAIL(conn->sent, art);
1822 /*========== handling responses from peer ==========*/
1824 static const oop_rd_style peer_rd_style= {
1825 OOP_RD_DELIM_STRIP, '\n',
1827 OOP_RD_SHORTREC_FORBID
1830 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1831 const char *errmsg, int errnoval,
1832 const char *data, size_t recsz, void *conn_v) {
1834 connfail(conn, "error receiving from peer: %s", errmsg);
1835 return OOP_CONTINUE;
1838 static Article *article_reply_check(Conn *conn, const char *response,
1839 int code_indicates_streaming,
1841 /* 1:yes, -1:no, 0:dontcare */,
1842 const char *sanitised_response) {
1843 Article *art= LIST_HEAD(conn->sent);
1847 "peer gave unexpected response when no commands outstanding: %s",
1848 sanitised_response);
1852 if (code_indicates_streaming) {
1853 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1854 if (!conn->stream) {
1855 connfail(conn, "peer gave streaming response code "
1856 " to IHAVE or subsequent body: %s", sanitised_response);
1859 const char *got_mid= response+4;
1860 int got_midlen= strcspn(got_mid, " \n\r");
1861 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1862 connfail(conn, "peer gave streaming response with syntactically invalid"
1863 " messageid: %s", sanitised_response);
1866 if (got_midlen != art->midlen ||
1867 memcmp(got_mid, art->messageid, got_midlen)) {
1868 connfail(conn, "peer gave streaming response code to wrong article -"
1869 " probable synchronisation problem; we offered: %s;"
1871 art->messageid, sanitised_response);
1876 connfail(conn, "peer gave non-streaming response code to"
1877 " CHECK/TAKETHIS: %s", sanitised_response);
1882 if (must_have_sent>0 && art->state < art_Wanted) {
1883 connfail(conn, "peer says article accepted but"
1884 " we had not sent the body: %s", sanitised_response);
1887 if (must_have_sent<0 && art->state >= art_Wanted) {
1888 connfail(conn, "peer says please sent the article but we just did: %s",
1889 sanitised_response);
1893 Article *art_again= LIST_REMHEAD(conn->sent);
1894 assert(art_again == art);
1898 static void update_nocheck(int accepted) {
1899 accept_proportion *= nocheck_decay;
1900 accept_proportion += accepted * (1.0 - nocheck_decay);
1901 int new_nocheck= accept_proportion >= nocheck_thresh;
1902 if (new_nocheck && !nocheck_reported) {
1903 notice("entering nocheck mode for the first time");
1904 nocheck_reported= 1;
1905 } else if (new_nocheck != nocheck) {
1906 dbg("nocheck mode %s", new_nocheck ? "start" : "stop");
1908 nocheck= new_nocheck;
1911 static void article_done(Article *art, int whichcount) {
1912 if (whichcount>=0 && !art->missing)
1913 art->ipf->counts[art->state][whichcount]++;
1915 if (whichcount == RC_accepted) update_nocheck(1);
1916 else if (whichcount == RC_unwanted) update_nocheck(0);
1918 InputFile *ipf= art->ipf;
1920 while (art->blanklen) {
1921 static const char spaces[]=
1931 int nspaces= sizeof(spaces)-1;
1932 int w= art->blanklen; if (w > nspaces) w= nspaces;
1933 int r= pwrite(ipf->fd, spaces, w, art->offset);
1935 if (errno==EINTR) continue;
1936 syscrash("failed to blank entry for %s (length %d at offset %lu) in %s",
1937 art->messageid, art->blanklen,
1938 (unsigned long)art->offset, ipf->path);
1940 assert(r>=0 && r<=w);
1946 assert(ipf->inprogress >= 0);
1949 if (!ipf->inprogress && ipf != main_input_file)
1950 queue_check_input_done();
1953 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1954 const char *errmsg, int errnoval,
1955 const char *data, size_t recsz, void *conn_v) {
1958 if (ev == OOP_RD_EOF) {
1959 connfail(conn, "unexpected EOF from peer");
1960 return OOP_CONTINUE;
1962 assert(ev == OOP_RD_OK);
1964 char *sani= sanitise(data,-1);
1967 unsigned long code= strtoul(data, &ep, 10);
1968 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1969 connfail(conn, "badly formatted response from peer: %s", sani);
1970 return OOP_CONTINUE;
1973 int busy= conn_busy(conn);
1975 if (conn->quitting) {
1976 if (code!=205 && code!=400) {
1977 connfail(conn, "peer gave unexpected response to QUIT (%s): %s",
1978 conn->quitting, sani);
1980 LIST_REMOVE(conns,conn);
1981 notice("C%d (now %d) idle connection closed (%s)",
1982 conn->fd, conns.count, conn->quitting);
1986 return OOP_CONTINUE;
1989 conn->since_activity= 0;
1992 #define GET_ARTICLE(musthavesent) do{ \
1993 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1994 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1997 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1998 code_streaming= (streaming); \
1999 GET_ARTICLE(musthavesent); \
2000 article_done(art, RC_##how); \
2004 #define PEERBADMSG(m) do { \
2005 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
2008 int code_streaming= 0;
2012 default: PEERBADMSG("peer sent unexpected message");
2016 PEERBADMSG("peer timed us out or stopped accepting articles");
2018 LIST_REMOVE(conns,conn);
2019 notice("C%d (now %d) idle connection closed by peer",
2020 conns.count, conn->fd);
2022 return OOP_CONTINUE;
2024 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
2025 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
2027 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
2028 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
2030 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
2031 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
2033 case 238: /* CHECK says send it */
2035 case 335: /* IHAVE says send it */
2037 assert(art->state == art_Unchecked);
2038 art->ipf->counts[art->state][RC_accepted]++;
2039 art->state= art_Wanted;
2040 LIST_ADDTAIL(conn->priority, art);
2043 case 431: /* CHECK or TAKETHIS says try later */
2045 case 436: /* IHAVE says try later */
2047 article_defer(art, RC_deferred);
2053 conn_maybe_write(conn);
2054 check_assign_articles();
2055 return OOP_CONTINUE;
2059 /*========== monitoring of input files ==========*/
2061 static void feedfile_eof(InputFile *ipf) {
2062 assert(ipf != main_input_file); /* promised by tailing_try_read */
2063 inputfile_reading_stop(ipf);
2065 if (ipf == flushing_input_file) {
2066 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2067 if (main_input_file) inputfile_reading_start(main_input_file);
2068 statemc_check_flushing_done();
2069 } else if (ipf == backlog_input_file) {
2070 statemc_check_backlog_done();
2072 abort(); /* supposed to wait rather than get EOF on main input file */
2076 static InputFile *open_input_file(const char *path) {
2077 int fd= open(path, O_RDWR);
2079 if (errno==ENOENT) return 0;
2080 sysdie("unable to open input file %s", path);
2084 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2085 memset(ipf,0,sizeof(*ipf));
2089 LIST_INIT(ipf->queue);
2090 strcpy(ipf->path, path);
2095 static void close_input_file(InputFile *ipf) { /* does not free */
2096 assert(!ipf->readable_callback); /* must have had ->on_cancel */
2097 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2098 assert(!ipf->rd); /* must have had inputfile_reading_stop */
2099 assert(!ipf->inprogress); /* no dangling pointers pointing here */
2100 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2104 /*---------- dealing with articles read in the input file ----------*/
2106 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2107 const char *data, const char *how) {
2108 warn("corrupted file: %s, offset %lu: %s: in %s",
2109 ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2110 ipf->readcount_err++;
2111 if (ipf->readcount_err > max_bad_data_initial +
2112 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2113 crash("too much garbage in input file! (%d errs, %d ok, %d blank)",
2114 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2115 return OOP_CONTINUE;
2118 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2119 oop_rd_event ev, const char *errmsg,
2120 int errnoval, const char *data, size_t recsz,
2122 InputFile *ipf= ipf_v;
2123 assert(ev == OOP_RD_SYSTEM);
2125 syscrash("error reading input file: %s, offset %lu",
2126 ipf->path, (unsigned long)ipf->offset);
2129 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2130 oop_rd_event ev, const char *errmsg,
2131 int errnoval, const char *data, size_t recsz,
2133 InputFile *ipf= ipf_v;
2135 char tokentextbuf[sizeof(TOKEN)*2+3];
2137 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2139 off_t old_offset= ipf->offset;
2140 ipf->offset += recsz + !!(ev == OOP_RD_OK);
2142 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2144 if (ev==OOP_RD_PARTREC)
2145 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2146 /* but process it anyway */
2148 if (ipf->skippinglong) {
2149 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2150 return OOP_CONTINUE;
2152 if (ev==OOP_RD_LONG) {
2153 ipf->skippinglong= 1;
2154 X_BAD_DATA("overly long line");
2157 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2158 if (!recsz) X_BAD_DATA("empty line");
2161 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2162 ipf->readcount_blank++;
2163 return OOP_CONTINUE;
2166 char *space= strchr(data,' ');
2167 int tokenlen= space-data;
2168 int midlen= (int)recsz-tokenlen-1;
2169 if (midlen <= 2) X_BAD_DATA("no room for messageid");
2170 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2172 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2173 memcpy(tokentextbuf, data, tokenlen);
2174 tokentextbuf[tokenlen]= 0;
2175 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2177 ipf->readcount_ok++;
2179 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2180 memset(art,0,sizeof(*art));
2181 art->state= art_Unchecked;
2182 art->midlen= midlen;
2183 art->ipf= ipf; ipf->inprogress++;
2184 art->token= TextToToken(tokentextbuf);
2185 art->offset= old_offset;
2186 art->blanklen= recsz;
2187 strcpy(art->messageid, space+1);
2189 if (ipf->autodefer >= 0) {
2190 article_autodefer(ipf, art);
2192 LIST_ADDTAIL(ipf->queue, art);
2194 if (ipf==backlog_input_file)
2195 article_check_expired(art);
2198 if (sms==sm_NORMAL && ipf==main_input_file &&
2199 ipf->offset >= target_max_feedfile_size)
2200 statemc_start_flush("feed file size");
2202 check_assign_articles(); /* may destroy conn but that's OK */
2203 check_reading_pause_resume(ipf);
2204 return OOP_CONTINUE;
2207 /*========== tailing input file ==========*/
2209 static void *tailing_rable_call_time(oop_source *lp, struct timeval tv,
2211 /* lifetime of ipf here is OK because destruction will cause
2212 * on_cancel which will cancel this callback */
2213 InputFile *ipf= user;
2215 dbg("**TRACT** ipf=%p called",ipf);
2216 if (!ipf->fake_readable) return OOP_CONTINUE;
2218 /* we just keep calling readable until our caller (oop_rd)
2219 * has called try_read, and try_read has found EOF so given EAGAIN */
2220 dbg("**TRACT** ipf=%p reschedule",ipf);
2221 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2223 return ipf->readable_callback(loop, &ipf->readable,
2224 ipf->readable_callback_user);
2227 static void tailing_on_cancel(struct oop_readable *rable) {
2228 InputFile *ipf= (void*)rable;
2229 dbg("**TOR** ipf=%p on_cancel",ipf);
2231 if (ipf->filemon) filemon_stop(ipf);
2232 dbg("**TRACT** ipf=%p cancel",ipf);
2233 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2234 ipf->readable_callback= 0;
2237 static void tailing_make_readable(InputFile *ipf) {
2238 dbg("**TRACT** ipf=%p makereadable rcb=%p",ipf,
2239 (void*)ipf?ipf->readable_callback:0);
2240 if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2242 ipf->fake_readable= 1;
2243 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2246 static int tailing_on_readable(struct oop_readable *rable,
2247 oop_readable_call *cb, void *user) {
2248 InputFile *ipf= (void*)rable;
2249 dbg("**TOR** ipf=%p on_readable",ipf);
2251 tailing_on_cancel(rable);
2252 ipf->readable_callback= cb;
2253 ipf->readable_callback_user= user;
2255 tailing_make_readable(ipf);
2259 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2261 InputFile *ipf= (void*)rable;
2263 ssize_t r= read(ipf->fd, buffer, length);
2265 if (errno==EINTR) continue;
2266 ipf->fake_readable= 0;
2270 if (ipf==main_input_file) {
2272 ipf->fake_readable= 0;
2274 } else if (ipf==flushing_input_file) {
2276 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2277 } else if (ipf==backlog_input_file) {
2283 dbg("**TOR** ipf=%p try_read r=%d",ipf,r);
2288 /*---------- filemon implemented with inotify ----------*/
2290 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2291 #define HAVE_FILEMON
2293 #include <sys/inotify.h>
2295 static int filemon_inotify_fd;
2296 static int filemon_inotify_wdmax;
2297 static InputFile **filemon_inotify_wd2ipf;
2299 struct Filemon_Perfile {
2303 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2304 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2305 if (wd < 0) sysdie("inotify_add_watch %s", ipf->path);
2307 if (wd >= filemon_inotify_wdmax) {
2309 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2310 sizeof(*filemon_inotify_wd2ipf) * newmax);
2311 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2312 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2313 filemon_inotify_wdmax= newmax;
2316 assert(!filemon_inotify_wd2ipf[wd]);
2317 filemon_inotify_wd2ipf[wd]= ipf;
2319 dbg("filemon inotify startfile %p wd=%d wdmax=%d",
2320 ipf, wd, filemon_inotify_wdmax);
2325 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2327 dbg("filemon inotify stopfile %p wd=%d", ipf, wd);
2328 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2329 if (r) syscrash("inotify_rm_watch");
2330 filemon_inotify_wd2ipf[wd]= 0;
2333 static void *filemon_inotify_readable(oop_source *lp, int fd,
2334 oop_event e, void *u) {
2335 struct inotify_event iev;
2337 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2339 if (isewouldblock(errno)) break;
2340 syscrash("read from inotify master");
2341 } else if (r==sizeof(iev)) {
2342 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2344 crash("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2346 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2347 /*dbg("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2348 tailing_make_readable(ipf);
2350 return OOP_CONTINUE;
2353 static int filemon_method_init(void) {
2354 filemon_inotify_fd= inotify_init();
2355 if (filemon_inotify_fd<0) {
2356 syswarn("filemon/inotify: inotify_init failed");
2359 xsetnonblock(filemon_inotify_fd, 1);
2360 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2362 dbg("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2366 static void filemon_method_dump_info(FILE *f) {
2368 fprintf(f,"inotify");
2369 DUMPV("%d",,filemon_inotify_fd);
2370 DUMPV("%d",,filemon_inotify_wdmax);
2371 for (i=0; i<filemon_inotify_wdmax; i++)
2372 fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2375 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2377 /*---------- filemon dummy implementation ----------*/
2379 #if !defined(HAVE_FILEMON)
2381 struct Filemon_Perfile { int dummy; };
2383 static int filemon_method_init(void) {
2384 warn("filemon/dummy: no filemon method compiled in");
2387 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2388 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2389 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2391 #endif /* !HAVE_FILEMON */
2393 /*---------- filemon generic interface ----------*/
2395 static void filemon_start(InputFile *ipf) {
2396 assert(!ipf->filemon);
2399 filemon_method_startfile(ipf, ipf->filemon);
2402 static void filemon_stop(InputFile *ipf) {
2403 if (!ipf->filemon) return;
2404 filemon_method_stopfile(ipf, ipf->filemon);
2409 /*---------- interface to start and stop an input file ----------*/
2411 static const oop_rd_style feedfile_rdstyle= {
2412 OOP_RD_DELIM_STRIP, '\n',
2414 OOP_RD_SHORTREC_LONG,
2417 static void inputfile_reading_resume(InputFile *ipf) {
2418 if (!ipf->rd) return;
2419 if (!ipf->paused) return;
2421 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2422 feedfile_got_article,ipf, feedfile_read_err, ipf);
2423 if (r) syscrash("unable start reading feedfile %s",ipf->path);
2428 static void inputfile_reading_pause(InputFile *ipf) {
2429 if (!ipf->rd) return;
2430 if (ipf->paused) return;
2431 oop_rd_cancel(ipf->rd);
2435 static void inputfile_reading_start(InputFile *ipf) {
2437 ipf->readable.on_readable= tailing_on_readable;
2438 ipf->readable.on_cancel= tailing_on_cancel;
2439 ipf->readable.try_read= tailing_try_read;
2440 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2441 ipf->readable.delete_kill= 0;
2443 ipf->readable_callback= 0;
2444 ipf->readable_callback_user= 0;
2446 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2450 inputfile_reading_resume(ipf);
2453 static void inputfile_reading_stop(InputFile *ipf) {
2455 inputfile_reading_pause(ipf);
2456 oop_rd_delete(ipf->rd);
2458 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2462 /*========== interaction with innd - state machine ==========*/
2464 /* See official state diagram at top of file. We implement
2475 |`---------------------------------------------------.
2477 |`---------------- - - - |
2478 D ENOENT | D EXISTS see OVERALL STATES diagram |
2479 | for full startup logic |
2482 | ============ try to |
2488 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2489 ^ | hardlink F to D |
2492 | | our handle onto F is now onto D |
2495 | |<-------------------<---------------------<---------+
2497 | | spawn inndcomm flush |
2499 | ================== |
2500 | FLUSHING[-ABSENT] |
2502 | main D tail/none |
2503 | ================== |
2505 | | INNDCOMM FLUSH FAILS ^
2506 | |`----------------------->----------. |
2508 | | NO SUCH SITE V |
2509 ^ |`--------------->----. ==================== |
2510 | | \ FLUSHFAILED[-ABSENT] |
2512 | | FLUSH OK \ main D tail/none |
2513 | | open F \ ==================== |
2515 | | \ | TIME TO RETRY |
2516 | |`------->----. ,---<---'\ `----------------'
2517 | | D NONE | | D NONE `----.
2519 | ============= V V ============
2520 | SEPARATED-1 | | DROPPING-1
2521 | flsh->rd!=0 | | flsh->rd!=0
2522 | [Separated] | | [Dropping]
2523 | main F idle | | main none
2524 | flsh D tail | | flsh D tail
2525 | ============= | | ============
2527 ^ | EOF ON D | | defer | EOF ON D
2529 | =============== | | ===============
2530 | SEPARATED-2 | | DROPPING-2
2531 | flsh->rd==0 | V flsh->rd==0
2532 | [Finishing] | | [Dropping]
2533 | main F tail | `. main none
2534 | flsh D closed | `. flsh D closed
2535 | =============== V `. ===============
2537 | | ALL D PROCESSED `. | ALL D PROCESSED
2538 | V install defer as backlog `. | install defer
2539 ^ | close D `. | close D
2540 | | unlink D `. | unlink D
2543 `----------' ==============
2563 static void startup_set_input_file(InputFile *f) {
2564 assert(!main_input_file);
2566 inputfile_reading_start(f);
2569 static void statemc_lock(void) {
2571 struct stat stab, stabf;
2574 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2575 if (lockfd<0) sysdie("open lockfile %s", path_lock);
2578 memset(&fl,0,sizeof(fl));
2580 fl.l_whence= SEEK_SET;
2581 int r= fcntl(lockfd, F_SETLK, &fl);
2583 if (errno==EACCES || isewouldblock(errno)) {
2584 if (quiet_multiple) exit(0);
2585 die("another duct holds the lockfile");
2587 sysdie("fcntl F_SETLK lockfile %s", path_lock);
2590 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2592 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2594 if (!lock_noent && samefile(&stab, &stabf))
2597 xclose(lockfd, "stale lockfile ", path_lock);
2600 FILE *lockfile= fdopen(lockfd, "w");
2601 if (!lockfile) syscrash("fdopen lockfile");
2603 int r= ftruncate(lockfd, 0);
2604 if (r) syscrash("truncate lockfile to write new info");
2606 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2607 (unsigned long)self_pid,
2608 sitename, feedfile, remote_host) == EOF ||
2610 sysdie("write info to lockfile %s", path_lock);
2612 dbg("startup: locked");
2615 static void statemc_init(void) {
2616 struct stat stabdefer;
2618 search_backlog_file();
2621 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2623 dbg("startup: ductdefer ENOENT");
2625 dbg("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2626 switch (stabdefer.st_nlink==1) {
2628 open_defer(); /* so that we will later close it and rename it */
2631 xunlink(path_defer, "stale defer file link"
2632 " (presumably hardlink to backlog file)");
2635 crash("defer file %s has unexpected link count %d",
2636 path_defer, stabdefer.st_nlink);
2640 struct stat stab_f, stab_d;
2643 InputFile *file_d= open_input_file(path_flushing);
2644 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2646 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2648 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2649 dbg("startup: F==D => Hardlinked");
2650 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2655 dbg("startup: F ENOENT => Moved");
2656 if (file_d) startup_set_input_file(file_d);
2657 spawn_inndcomm_flush("feedfile missing at startup");
2658 /* => Flushing, sms:=FLUSHING */
2661 dbg("startup: F!=D => Separated");
2662 startup_set_input_file(file_d);
2663 flushing_input_file= main_input_file;
2664 main_input_file= open_input_file(feedfile);
2665 if (!main_input_file) crash("feedfile vanished during startup");
2666 SMS(SEPARATED, max_separated_periods,
2667 "found both old and current feed files");
2669 dbg("startup: F exists, D ENOENT => Normal");
2670 InputFile *file_f= open_input_file(feedfile);
2671 if (!file_f) crash("feed file vanished during startup");
2672 startup_set_input_file(file_f);
2673 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2678 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2679 assert(sms == sm_NORMAL);
2681 dbg("starting flush (%s) (%lu >?= %lu) (%d)",
2683 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2684 (unsigned long)target_max_feedfile_size,
2687 int r= link(feedfile, path_flushing);
2688 if (r) sysdie("link feedfile %s to flushing file %s",
2689 feedfile, path_flushing);
2692 xunlink(feedfile, "old feedfile link");
2695 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2698 static int trigger_flush_ok(const char *why) {
2702 statemc_start_flush(why ? why : "periodic");
2703 return 1; /* Normal => Flushing; => FLUSHING */
2705 case sm_FLUSHFAILED:
2706 spawn_inndcomm_flush(why ? why : "retry");
2707 return 1; /* Moved => Flushing; => FLUSHING */
2711 warn("abandoning old feedfile after flush (%s), autodeferring",
2712 why ? why : "took too long to complete");
2713 assert(flushing_input_file);
2714 autodefer_input_file(flushing_input_file);
2722 static void statemc_period_poll(void) {
2723 if (!until_flush) return;
2725 assert(until_flush>=0);
2727 if (until_flush) return;
2728 int ok= trigger_flush_ok(0);
2732 static int inputfile_is_done(InputFile *ipf) {
2734 if (ipf->inprogress) return 0; /* new article in the meantime */
2735 if (ipf->rd) return 0; /* not had EOF */
2739 static void notice_processed(InputFile *ipf, int completed,
2740 const char *what, const char *spec) {
2741 if (!ipf) return; /* allows preterminate to be lazy */
2743 #define RCI_NOTHING(x) /* nothing */
2744 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2745 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2747 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2749 char *inprog= completed
2750 ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2751 : xasprintf(" inprogress=%ld", ipf->inprogress);
2752 char *autodefer= ipf->autodefer >= 0
2753 ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2754 : xasprintf("%s","");
2756 info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2757 " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2758 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2760 completed?"completed":"processed", what, spec,
2761 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2762 inprog, autodefer, ipf->count_nooffer_missing,
2763 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2764 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2765 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2766 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2767 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2776 static void statemc_check_backlog_done(void) {
2777 InputFile *ipf= backlog_input_file;
2778 if (!inputfile_is_done(ipf)) return;
2780 const char *slash= strrchr(ipf->path, '/');
2781 const char *leaf= slash ? slash+1 : ipf->path;
2782 const char *under= strchr(slash, '_');
2783 const char *rest= under ? under+1 : leaf;
2784 if (!strncmp(rest,"backlog",7)) rest += 7;
2785 notice_processed(ipf,1,"backlog ",rest);
2787 close_input_file(ipf);
2788 if (unlink(ipf->path)) {
2789 if (errno != ENOENT)
2790 syscrash("could not unlink processed backlog file %s", ipf->path);
2791 warn("backlog file %s vanished while we were reading it"
2792 " so we couldn't remove it (but it's done now, anyway)",
2796 backlog_input_file= 0;
2797 search_backlog_file();
2801 static void statemc_check_flushing_done(void) {
2802 InputFile *ipf= flushing_input_file;
2803 if (!inputfile_is_done(ipf)) return;
2805 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2807 notice_processed(ipf,1,"feedfile","");
2811 xunlink(path_flushing, "old flushing file");
2813 close_input_file(flushing_input_file);
2814 free(flushing_input_file);
2815 flushing_input_file= 0;
2817 if (sms==sm_SEPARATED) {
2818 notice("flush complete");
2819 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2820 } else if (sms==sm_DROPPING) {
2821 SMS(DROPPED, max_separated_periods, "old flush complete");
2822 search_backlog_file();
2823 notice("feed dropped, but will continue until backlog is finished");
2827 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2829 /* main input file may be idle but if so that's because
2830 * we haven't got to it yet, but that doesn't mean it's really done */
2831 statemc_check_flushing_done();
2832 statemc_check_backlog_done();
2833 return OOP_CONTINUE;
2836 static void queue_check_input_done(void) {
2837 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2840 static void statemc_setstate(StateMachineState newsms, int periods,
2841 const char *forlog, const char *why) {
2843 until_flush= periods;
2845 const char *xtra= "";
2848 case sm_FLUSHFAILED:
2849 if (!main_input_file) xtra= "-ABSENT";
2853 xtra= flushing_input_file->rd ? "-1" : "-2";
2859 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2861 info("state %s%s %s",forlog,xtra,why);
2865 /*---------- defer and backlog files ----------*/
2867 static void open_defer(void) {
2872 defer= fopen(path_defer, "a+");
2873 if (!defer) sysdie("could not open defer file %s", path_defer);
2875 /* truncate away any half-written records */
2877 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2879 if (stab.st_size > LONG_MAX)
2880 crash("defer file %s size is far too large", path_defer);
2885 long orgsize= stab.st_size;
2886 long truncto= stab.st_size;
2888 if (!truncto) break; /* was only (if anything) one half-truncated record */
2889 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2890 syscrash("seek in defer file %s while truncating partial", path_defer);
2895 syscrash("failed read from defer file %s", path_defer);
2897 crash("defer file %s shrank while we were checking it!", path_defer);
2903 if (stab.st_size != truncto) {
2904 warn("truncating half-record at end of defer file %s -"
2905 " shrinking by %ld bytes from %ld to %ld",
2906 path_defer, orgsize - truncto, orgsize, truncto);
2909 sysdie("could not flush defer file %s", path_defer);
2910 if (ftruncate(fileno(defer), truncto))
2911 syscrash("could not truncate defer file %s", path_defer);
2914 info("continuing existing defer file %s (%ld bytes)",
2915 path_defer, orgsize);
2917 if (fseek(defer, truncto, SEEK_SET))
2918 syscrash("could not seek to new end of defer file %s", path_defer);
2921 static void close_defer(void) {
2926 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2928 if (fclose(defer)) sysdie("could not close defer file %s", path_defer);
2931 time_t now= xtime();
2933 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2935 (unsigned long)stab.st_ino);
2936 if (link(path_defer, backlog))
2937 sysdie("could not install defer file %s as backlog file %s",
2938 path_defer, backlog);
2939 if (unlink(path_defer))
2940 syscrash("could not unlink old defer link %s to backlog file %s",
2941 path_defer, backlog);
2945 if (until_backlog_nextscan < 0 ||
2946 until_backlog_nextscan > backlog_retry_minperiods + 1)
2947 until_backlog_nextscan= backlog_retry_minperiods + 1;
2950 static void poll_backlog_file(void) {
2951 if (until_backlog_nextscan < 0) return;
2952 if (until_backlog_nextscan-- > 0) return;
2953 search_backlog_file();
2956 static void search_backlog_file(void) {
2957 /* returns non-0 iff there are any backlog files */
2963 const char *oldest_path=0;
2964 time_t oldest_mtime=0, now;
2966 if (backlog_input_file) return;
2970 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2974 sysdie("failed to expand backlog pattern %s", globpat_backlog);
2976 die("out of memory expanding backlog pattern %s", globpat_backlog);
2978 for (ui=0; ui<gl.gl_pathc; ui++) {
2979 const char *path= gl.gl_pathv[ui];
2981 if (strchr(path,'#') || strchr(path,'~')) {
2982 dbg("backlog file search skipping %s", path);
2985 r= stat(path, &stab);
2987 syswarn("failed to stat backlog file %s", path);
2990 if (!S_ISREG(stab.st_mode)) {
2991 warn("backlog file %s is not a plain file (or link to one)", path);
2994 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2996 oldest_mtime= stab.st_mtime;
2999 case GLOB_NOMATCH: /* fall through */
3002 syscrash("glob expansion of backlog pattern %s gave unexpected"
3003 " nonzero (error?) return value %d", globpat_backlog, r);
3007 dbg("backlog scan: none");
3009 if (sms==sm_DROPPED) {
3011 notice("feed dropped and our work is complete");
3013 r= unlink(path_cli);
3014 if (r && errno!=ENOENT)
3015 syswarn("failed to unlink cli socket for old feed");
3017 xunlink(path_lock, "lockfile for old feed");
3020 until_backlog_nextscan= backlog_spontrescan_periods;
3025 double age= difftime(now, oldest_mtime);
3026 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
3028 if (age_deficiency <= 0) {
3029 dbg("backlog scan: found age=%f deficiency=%ld oldest=%s",
3030 age, age_deficiency, oldest_path);
3032 backlog_input_file= open_input_file(oldest_path);
3033 if (!backlog_input_file) {
3034 warn("backlog file %s vanished as we opened it", oldest_path);
3038 inputfile_reading_start(backlog_input_file);
3039 until_backlog_nextscan= -1;
3043 until_backlog_nextscan= age_deficiency / period_seconds;
3045 if (backlog_spontrescan_periods >= 0 &&
3046 until_backlog_nextscan > backlog_spontrescan_periods)
3047 until_backlog_nextscan= backlog_spontrescan_periods;
3049 dbg("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
3050 age, age_deficiency, until_backlog_nextscan, oldest_path);
3057 /*---------- shutdown and signal handling ----------*/
3059 static void preterminate(void) {
3060 if (in_child) return;
3061 notice_processed(main_input_file,0,"feedfile","");
3062 notice_processed(flushing_input_file,0,"flushing","");
3063 if (backlog_input_file)
3064 notice_processed(backlog_input_file,0, "backlog file ",
3065 backlog_input_file->path);
3068 static int signal_self_pipe[2];
3069 static sig_atomic_t terminate_sig_flag;
3071 static void raise_default(int signo) {
3072 xsigsetdefault(signo);
3077 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
3078 assert(fd=signal_self_pipe[0]);
3080 int r= read(signal_self_pipe[0], buf, sizeof(buf));
3081 if (r<0 && !isewouldblock(errno))
3082 syscrash("failed to read signal self pipe");
3083 if (r==0) crash("eof on signal self pipe");
3084 if (terminate_sig_flag) {
3086 notice("terminating (%s)", strsignal(terminate_sig_flag));
3087 raise_default(terminate_sig_flag);
3089 return OOP_CONTINUE;
3092 static void sigarrived_handler(int signum) {
3097 if (!terminate_sig_flag) terminate_sig_flag= signum;
3102 write(signal_self_pipe[1],&x,1);
3105 static void init_signals(void) {
3106 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3107 syscrash("could not ignore SIGPIPE");
3109 if (pipe(signal_self_pipe)) sysdie("create self-pipe for signals");
3111 xsetnonblock(signal_self_pipe[0],1);
3112 xsetnonblock(signal_self_pipe[1],1);
3114 struct sigaction sa;
3115 memset(&sa,0,sizeof(sa));
3116 sa.sa_handler= sigarrived_handler;
3117 sa.sa_flags= SA_RESTART;
3118 xsigaction(SIGTERM,&sa);
3119 xsigaction(SIGINT,&sa);
3121 on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3124 /*========== flushing the feed ==========*/
3126 static pid_t inndcomm_child;
3127 static int inndcomm_sentinel_fd;
3129 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3130 assert(inndcomm_child);
3131 assert(fd == inndcomm_sentinel_fd);
3132 int status= xwaitpid(&inndcomm_child, "inndcomm");
3135 cancel_fd_read_except(fd);
3136 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3137 inndcomm_sentinel_fd= 0;
3139 assert(!flushing_input_file);
3141 if (WIFEXITED(status)) {
3142 switch (WEXITSTATUS(status)) {
3144 case INNDCOMMCHILD_ESTATUS_FAIL:
3147 case INNDCOMMCHILD_ESTATUS_NONESUCH:
3148 notice("feed has been dropped by innd, finishing up");
3149 flushing_input_file= main_input_file;
3150 tailing_make_readable(flushing_input_file);
3151 /* we probably previously returned EAGAIN from our fake read method
3152 * when in fact we were at EOF, so signal another readable event
3153 * so we actually see the EOF */
3157 if (flushing_input_file) {
3158 SMS(DROPPING, max_separated_periods,
3159 "feed dropped by innd, but must finish last flush");
3162 SMS(DROPPED, 0, "feed dropped by innd");
3163 search_backlog_file();
3165 return OOP_CONTINUE;
3169 flushing_input_file= main_input_file;
3170 tailing_make_readable(flushing_input_file);
3172 main_input_file= open_input_file(feedfile);
3173 if (!main_input_file)
3174 crash("flush succeeded but feedfile %s does not exist!"
3175 " (this probably means feedfile does not correspond"
3176 " to site %s in newsfeeds)", feedfile, sitename);
3178 if (flushing_input_file) {
3179 SMS(SEPARATED, max_separated_periods, "flush complete");
3182 SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3184 return OOP_CONTINUE;
3187 goto unexpected_exitstatus;
3190 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3191 warn("flush timed out trying to talk to innd");
3194 unexpected_exitstatus:
3195 report_child_status("inndcomm child", status);
3199 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3200 return OOP_CONTINUE;
3203 static void inndcommfail(const char *what) {
3204 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3205 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3208 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3211 notice("flushing %s",why);
3213 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3214 assert(!inndcomm_child);
3215 assert(!inndcomm_sentinel_fd);
3217 if (pipe(pipefds)) sysdie("create pipe for inndcomm child sentinel");
3219 inndcomm_child= xfork("inndcomm child");
3221 if (!inndcomm_child) {
3222 const char *flushargv[2]= { sitename, 0 };
3226 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3227 /* parent spots the autoclose of pipefds[1] when we die or exit */
3229 if (simulate_flush>=0) {
3230 warn("SIMULATING flush child status %d", simulate_flush);
3231 if (simulate_flush>128) raise(simulate_flush-128);
3232 else exit(simulate_flush);
3235 alarm(inndcomm_flush_timeout);
3236 r= ICCopen(); if (r) inndcommfail("connect");
3237 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
3238 if (!r) exit(0); /* yay! */
3240 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3241 syswarn("innd ctlinnd flush failed: innd said %s", reply);
3242 exit(INNDCOMMCHILD_ESTATUS_FAIL);
3247 xclose(pipefds[1], "inndcomm sentinel child's end",0);
3248 inndcomm_sentinel_fd= pipefds[0];
3249 assert(inndcomm_sentinel_fd);
3250 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3252 SMS(FLUSHING, 0, why);
3255 /*========== main program ==========*/
3257 static void postfork_inputfile(InputFile *ipf) {
3259 xclose(ipf->fd, "(in child) input file ", ipf->path);
3262 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3263 /* we have no stdio streams that are buffered long-term */
3265 if (fclose(f)) syscrash("(in child) close %s%s", what, what2?what2:0);
3268 static void postfork(void) {
3271 xsigsetdefault(SIGTERM);
3272 xsigsetdefault(SIGINT);
3273 xsigsetdefault(SIGPIPE);
3274 if (terminate_sig_flag) raise(terminate_sig_flag);
3276 postfork_inputfile(main_input_file);
3277 postfork_inputfile(flushing_input_file);
3281 conn_closefd(conn,"(in child) ");
3283 postfork_stdio(defer, "defer file ", path_defer);
3286 typedef struct Every Every;
3288 struct timeval interval;
3293 static void every_schedule(Every *e, struct timeval base);
3295 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3298 if (!e->fixed_rate) xgettimeofday(&base);
3299 every_schedule(e, base);
3300 return OOP_CONTINUE;
3303 static void every_schedule(Every *e, struct timeval base) {
3304 struct timeval when;
3305 timeradd(&base, &e->interval, &when);
3306 loop->on_time(loop, when, every_happens, e);
3309 static void every(int interval, int fixed_rate, void (*f)(void)) {
3310 NEW_DECL(Every *,e);
3311 e->interval.tv_sec= interval;
3312 e->interval.tv_usec= 0;
3313 e->fixed_rate= fixed_rate;
3316 xgettimeofday(&now);
3317 every_schedule(e, now);
3320 static void filepoll(void) {
3321 tailing_make_readable(main_input_file);
3322 tailing_make_readable(flushing_input_file);
3325 static char *dbg_report_ipf(InputFile *ipf) {
3326 if (!ipf) return xasprintf("none");
3328 const char *slash= strrchr(ipf->path,'/');
3329 const char *path= slash ? slash+1 : ipf->path;
3331 return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3333 ipf->queue.count, ipf->inprogress, ipf->autodefer,
3334 (long)ipf->offset, ipf->fd,
3335 ipf->rd ? "" : ",!rd",
3336 ipf->skippinglong ? "*skiplong" : "",
3337 ipf->rd && ipf->paused ? "*paused" : "");
3340 static void period(void) {
3341 char *dipf_main= dbg_report_ipf(main_input_file);
3342 char *dipf_flushing= dbg_report_ipf(flushing_input_file);
3343 char *dipf_backlog= dbg_report_ipf(backlog_input_file);
3346 " sms=%s[%d] conns=%d until_connect=%d"
3347 " input_files main:%s flushing:%s backlog:%s[%d]"
3348 " children connecting=%ld inndcomm=%ld lowvol_total=%d"
3350 sms_names[sms], until_flush, conns.count, until_connect,
3351 dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3352 (long)connecting_child, (long)inndcomm_child, lowvol_total
3356 free(dipf_flushing);
3359 if (until_connect) until_connect--;
3361 inputfile_queue_check_expired(backlog_input_file);
3362 poll_backlog_file();
3363 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3364 statemc_period_poll();
3365 check_assign_articles();
3370 /*========== dumping state ==========*/
3372 static void dump_article_list(FILE *f, const CliCommand *c,
3373 const ArticleList *al) {
3374 fprintf(f, " count=%d\n", al->count);
3375 if (!c->xval) return;
3377 int i; Article *art;
3378 for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3379 fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3380 DUMPV("%p", art->,ipf);
3381 DUMPV("%d", art->,missing);
3382 DUMPV("%lu", (unsigned long)art->,offset);
3383 DUMPV("%d", art->,blanklen);
3384 DUMPV("%d", art->,midlen);
3385 fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3389 static void dump_input_file(FILE *f, const CliCommand *c,
3390 InputFile *ipf, const char *wh) {
3391 char *dipf= dbg_report_ipf(ipf);
3392 fprintf(f,"input %s %s", wh, dipf);
3396 DUMPV("%d", ipf->,readcount_ok);
3397 DUMPV("%d", ipf->,readcount_blank);
3398 DUMPV("%d", ipf->,readcount_err);
3399 DUMPV("%d", ipf->,count_nooffer_missing);
3403 ArtState state; const char *const *statename;
3404 for (state=0, statename=artstate_names; *statename; state++,statename++) {
3405 #define RC_DUMP_FMT(x) " " #x "=%d"
3406 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3407 fprintf(f,"input %s counts %-11s"
3408 RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3410 RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3412 fprintf(f,"input %s queue", wh);
3413 dump_article_list(f,c,&ipf->queue);
3419 fprintf(cc->out, "dumping state to %s\n", path_dump);
3420 FILE *f= fopen(path_dump, "w");
3421 if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3423 fprintf(f,"general");
3424 DUMPV("%s", sms_names,[sms]);
3425 DUMPV("%d", ,until_flush);
3426 DUMPV("%ld", (long),self_pid);
3427 DUMPV("%p", , defer);
3428 DUMPV("%d", , until_connect);
3429 DUMPV("%d", , until_backlog_nextscan);
3430 DUMPV("%d", , simulate_flush);
3431 fprintf(f,"\nnocheck");
3432 DUMPV("%#.10f", , accept_proportion);
3433 DUMPV("%d", , nocheck);
3434 DUMPV("%d", , nocheck_reported);
3437 fprintf(f,"special");
3438 DUMPV("%ld", (long),connecting_child);
3439 DUMPV("%d", , connecting_fdpass_sock);
3440 DUMPV("%d", , cli_master);
3443 fprintf(f,"lowvol");
3444 DUMPV("%d", , lowvol_circptr);
3445 DUMPV("%d", , lowvol_total);
3447 for (i=0; i<lowvol_periods; i++) {
3449 if (i==lowvol_circptr) fprintf(f,"*");
3450 fprintf(f,"%d",lowvol_perperiod[i]);
3454 fprintf(f,"filemon ");
3455 filemon_method_dump_info(f);
3457 dump_input_file(f,c, main_input_file, "main" );
3458 dump_input_file(f,c, flushing_input_file, "flushing");
3459 dump_input_file(f,c, backlog_input_file, "backlog" );
3461 fprintf(f,"conns count=%d\n", conns.count);
3466 fprintf(f,"C%d",conn->fd);
3467 DUMPV("%p",conn->,rd); DUMPV("%d",conn->,max_queue);
3468 DUMPV("%d",conn->,stream); DUMPV("\"%s\"",conn->,quitting);
3469 DUMPV("%d",conn->,since_activity);
3472 fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3473 fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3474 fprintf(f,"C%d sent", conn->fd); dump_article_list(f,c,&conn->sent);
3476 fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3477 for (i=0; i<conn->xmitu; i++) {
3478 const struct iovec *iv= &conn->xmit[i];
3479 const XmitDetails *xd= &conn->xmitd[i];
3482 case xk_Const: dinfo= xasprintf("Const"); break;
3483 case xk_Artdata: dinfo= xasprintf("A%p", xd->info.sm_art); break;
3487 fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3488 sanitise(iv->iov_base, iv->iov_len));
3494 DUMPV("%s", , feedfile);
3495 DUMPV("%s", , path_cli);
3496 DUMPV("%s", , path_lock);
3497 DUMPV("%s", , path_flushing);
3498 DUMPV("%s", , path_defer);
3499 DUMPV("%s", , path_dump);
3500 DUMPV("%s", , globpat_backlog);
3503 if (!!ferror(f) + !!fclose(f)) {
3504 fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3509 /*========== option parsing ==========*/
3511 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3512 static void vbadusage(const char *fmt, va_list al) {
3513 char *m= xvasprintf(fmt,al);
3514 fprintf(stderr, "bad usage: %s\n"
3515 "say --help for help, or read the manpage\n",
3517 if (interactive < 2)
3518 syslog(LOG_ERR,"innduct: invoked with bad usage: %s",m);
3522 /*---------- generic option parser ----------*/
3524 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3525 static void badusage(const char *fmt, ...) {
3532 of_seconds= 001000u,
3533 of_boolean= 002000u,
3536 typedef struct Option Option;
3537 typedef void OptionParser(const Option*, const char *val);
3541 const char *lng, *formarg;
3547 static void parse_options(const Option *options, char ***argvp) {
3548 /* on return *argvp is first non-option arg; argc is not updated */
3551 const char *arg= *++(*argvp);
3553 if (*arg != '-') break;
3554 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3556 while ((a= *++arg)) {
3560 char *equals= strchr(arg,'=');
3561 unsigned len= equals ? (size_t)(equals - arg) : strlen(arg);
3562 for (o=options; o->shrt || o->lng; o++)
3563 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3565 badusage("unknown long option --%s",arg);
3568 if (equals) badusage("option --%s does not take a value",o->lng);
3570 } else if (equals) {
3574 if (!arg) badusage("option --%s needs a value for %s",
3575 o->lng, o->formarg);
3578 break; /* eaten the whole argument now */
3580 for (o=options; o->shrt || o->lng; o++)
3583 badusage("unknown short option -%c",a);
3590 if (!arg) badusage("option -%c needs a value for %s",
3591 o->shrt, o->formarg);
3594 break; /* eaten the whole argument now */
3600 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3602 static void print_options(const Option *options, FILE *f) {
3604 for (o=options; o->shrt || o->lng; o++) {
3605 char shrt[2] = { o->shrt, 0 };
3606 char *optspec= xasprintf("%s%s%s%s%s",
3607 o->shrt ? "-" : "", shrt,
3608 o->shrt && o->lng ? "|" : "",
3609 DELIMPERHAPS("--", o->lng));
3610 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3615 /*---------- specific option types ----------*/
3617 static void op_integer(const Option *o, const char *val) {
3620 unsigned long ul= strtoul(val,&ep,10);
3621 if (*ep || ep==val || errno || ul>INT_MAX)
3622 badusage("bad integer value for %s",o->lng);
3623 int *store= o->store;
3627 static void op_double(const Option *o, const char *val) {
3628 int *store= o->store;
3631 *store= strtod(val, &ep);
3632 if (*ep || ep==val || errno)
3633 badusage("bad floating point value for %s",o->lng);
3636 static void op_string(const Option *o, const char *val) {
3637 const char **store= o->store;
3641 static void op_seconds(const Option *o, const char *val) {
3642 int *store= o->store;
3646 double v= strtod(val,&ep);
3647 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3649 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3650 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3651 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3652 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3653 else if (!strcmp(ep,"das")) unit= 10;
3654 else if (!strcmp(ep,"hs")) unit= 100;
3655 else if (!strcmp(ep,"ks")) unit= 1000;
3656 else if (!strcmp(ep,"Ms")) unit= 1000000;
3657 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3661 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3665 static void op_setint(const Option *o, const char *val) {
3666 int *store= o->store;
3670 /*---------- specific options ----------*/
3672 static void help(const Option *o, const char *val);
3674 static const Option innduct_options[]= {
3675 {'f',"feedfile", "F", &feedfile, op_string },
3676 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3677 {0,"no-daemon", 0, &interactive, op_setint, 1 },
3678 {0,"interactive", 0, &interactive, op_setint, 2 },
3679 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3680 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3681 {'C',"inndconf", "F", &inndconffile, op_string },
3682 {'P',"port", "PORT", &port, op_integer },
3683 {0,"chdir", "DIR", &path_run, op_string },
3684 {0,"cli", "DIR/|PATH", &path_cli, op_string },
3685 {0,"help", 0, 0, help },
3687 {0,"max-connections", "N", &max_connections, op_integer },
3688 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3689 {0,"max-queue-per-file", "N", &max_queue_per_ipf, op_integer },
3690 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3691 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3693 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3694 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3695 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3697 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3698 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3700 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3701 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3702 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3703 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3704 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3705 {0,"flush-finish-timeout", "PERIOD", &max_separated_periods, op_seconds },
3706 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3707 {0,"low-volume-thresh", "PERIOD", &lowvol_thresh, op_integer },
3708 {0,"low-volume-window", "PERIOD", &lowvol_periods, op_seconds },
3710 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3711 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3716 static void printusage(FILE *f) {
3717 fputs("usage: innduct [options] site [fqdn]\n"
3718 "available options are:\n", f);
3719 print_options(innduct_options, f);
3722 static void help(const Option *o, const char *val) {
3724 if (ferror(stdout) || fflush(stdout)) {
3725 perror("innduct: writing help");
3731 static void convert_to_periods_rndup(int *store) {
3732 *store += period_seconds-1;
3733 *store /= period_seconds;
3736 static int path_ends_slash(const char *specified) {
3737 int l= strlen(specified);
3739 return specified[l-1] == '/';
3742 int main(int argc, char **argv) {
3743 /* set up libinn logging */
3744 message_program_name= "innduct";
3745 message_fatal_cleanup= innduct_fatal_cleanup;
3746 INNLOGSETS(INNLOGSET_CALL)
3753 parse_options(innduct_options, &argv);
3758 if (!sitename) badusage("need site name argument");
3760 if (*argv) remote_host= *argv++;
3761 else remote_host= sitename;
3763 if (*argv) badusage("too many non-option arguments");
3767 int r= innconf_read(inndconffile);
3768 if (!r) badusage("could not read inn.conf");
3770 if (!remote_host) remote_host= sitename;
3772 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3773 badusage("nocheck threshold percentage must be between 0..100");
3774 nocheck_thresh *= 0.01;
3776 if (nocheck_decay < 0.1)
3777 badusage("nocheck decay articles must be at least 0.1");
3778 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3780 convert_to_periods_rndup(&reconnect_delay_periods);
3781 convert_to_periods_rndup(&flushfail_retry_periods);
3782 convert_to_periods_rndup(&backlog_retry_minperiods);
3783 convert_to_periods_rndup(&backlog_spontrescan_periods);
3784 convert_to_periods_rndup(&spontaneous_flush_periods);
3785 convert_to_periods_rndup(&max_separated_periods);
3786 convert_to_periods_rndup(&need_activity_periods);
3787 convert_to_periods_rndup(&lowvol_periods);
3789 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3790 badusage("bad input data ratio must be between 0..100");
3791 max_bad_data_ratio *= 0.01;
3794 path_run= innconf->pathrun;
3796 if (!feedfile) feedfile= sitename;
3797 if (!feedfile[0]) badusage("feed filename, if specified, must be nonempty");
3798 if (path_ends_slash(feedfile))
3799 feedfile= xasprintf("%s%s", feedfile, sitename);
3800 if (feedfile[0] != '/')
3801 feedfile= xasprintf("%s/%s", innconf->pathoutgoing, feedfile);
3804 path_cli_dir= "innduct";
3805 } else if (!path_cli[0] || !strcmp(path_cli,"none")) {
3806 path_cli= 0; /* ok, don't then */
3807 } else if (path_ends_slash(path_cli)) {
3808 path_cli_dir= xasprintf("%.*s", strlen(path_cli)-1, path_cli);
3811 path_cli= xasprintf("%s/%s", path_cli_dir, sitename);
3813 if (max_queue_per_ipf<0)
3814 max_queue_per_ipf= max_queue_per_conn * 2;
3816 const char *feedfile_forbidden= "?*[~#";
3818 while ((c= *feedfile_forbidden++))
3819 if (strchr(feedfile, c))
3820 badusage("feed filename may not contain metacharacter %c",c);
3823 lowvol_perperiod= xcalloc(sizeof(*lowvol_perperiod), lowvol_periods);
3824 for (i=0; i<lowvol_periods; i++) {
3825 lowvol_perperiod[i]= lowvol_thresh;
3826 lowvol_total += lowvol_thresh;
3828 lowvol_total -= lowvol_thresh;
3832 path_lock= xasprintf("%s_lock", feedfile);
3833 path_flushing= xasprintf("%s_flushing", feedfile);
3834 path_defer= xasprintf("%s_defer", feedfile);
3835 path_dump= xasprintf("%s_dump", feedfile);
3836 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3838 oop_source_sys *sysloop= oop_sys_new();
3839 if (!sysloop) syscrash("could not create liboop event loop");
3840 loop= (oop_source*)sysloop;
3844 if (interactive < 1) {
3845 for (i=3; i<255; i++)
3846 /* do this now before we open syslog, etc. */
3850 logv_prefix= xasprintf("%s| ", sitename);
3851 if (interactive < 2) {
3852 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3856 if (interactive < 1) {
3857 int null= open("/dev/null",O_RDWR);
3858 if (null<0) sysdie("failed to open /dev/null");
3862 xclose(null, "/dev/null original fd",0);
3864 pid_t child1= xfork("daemonise first fork");
3865 if (child1) _exit(0);
3867 pid_t sid= setsid();
3868 if (sid == -1) sysdie("setsid failed");
3870 pid_t child2= xfork("daemonise second fork");
3871 if (child2) _exit(0);
3875 if (self_pid==-1) syscrash("getpid");
3878 if (r) sysdie("could not chdir to pathrun %s", path_run);
3887 r= SMsetup(SM_PREOPEN, &val); if (!r) warn("SMsetup SM_PREOPEN failed");
3888 r= SMinit(); if (!r) die("storage manager initialisation (SMinit) failed");
3890 if (interactive >= 2)
3897 notice("filemon: suppressed by command line option, polling");
3899 filemon_ok= filemon_method_init();
3901 warn("filemon: no file monitoring available, polling");
3904 every(filepoll_seconds,0,filepoll);
3906 every(period_seconds,1,period);
3912 void *run= oop_sys_run(sysloop);
3913 assert(run == OOP_ERROR);
3914 syscrash("event loop failed");