3 * - inotify not working ?
4 * - some per-conn info thing for control
5 * - manpage: document control master stuff
8 * build-lfs/backends/innduct --no-daemon -f `pwd`/fee sit dom
12 * Newsfeeds file entries should look like this:
13 * host.name.of.site[/exclude,exclude,...]\
14 * :pattern,pattern...[/distribution,distribution...]\
18 * sitename[/exclude,exclude,...]\
19 * :pattern,pattern...[/distribution,distribution...]\
25 * or might be blanked out
26 * <spc><spc><spc><spc>....
28 * F site.name main feed file
29 * opened/created, then written, by innd
32 * tokens blanked out by duct when processed
33 * site.name_lock lock preventing multiple ducts
34 * to hold lock must open,F_SETLK[W]
35 * and then stat to check that locked file
36 * still has name site.name_lock
37 * holder of this lock is "duct"
38 * (only) lockholder may remove the lockfile
39 * D site.name_flushing temporary feed file during flush (or crash)
40 * hardlink created by duct
42 * site.name_defer 431'd articles, still being written,
43 * created, written, used by duct
45 * site.name_backlog.<date>.<inum>
46 * 431'd articles, ready for innxmit or duct
47 * created (link/mv) by duct
48 * site.name_backlog<anything-else> (where <anything-else> does not
49 * contain '#' or '~') eg
50 * site.name_backlog.manual
51 * anything the sysadmin likes (eg, feed files
52 * from old feeds to be merged into this one)
53 * created (link/mv) by admin
54 * may be symlinks (in which case links
55 * may be written through, but only links
58 * It is safe to remove backlog files manually,
59 * if it's desired to throw away the backlog.
61 * Backlog files are also processed by innduct. We find the oldest
62 * backlog file which is at least a certain amount old, and feed it
63 * back into our processing. When every article in it has been read
64 * and processed, we unlink it and look for another backlog file.
66 * If we don't have a backlog file that we're reading, we close the
67 * defer file that we're writing and make it into a backlog file at
68 * the first convenient opportunity.
79 | | <----------------<---------------------------------'|
85 | F: innd writing, duct reading |
88 | | duct decides time to flush |
89 | | duct makes hardlink |
91 | V <------------------------'|
93 | F == D: innd writing, duct reading both exist |
96 | | <-----------<-------------<--'|
100 | V <---------------------. |
103 | D: innd writing, duct reading; or ENOENT | |
105 | | duct requests flush of feed | |
106 | | (others can too, harmlessly) | |
110 | D: innd flushing, duct; or ENOENT | |
112 | | inndcomm flush fails | |
113 | |`-------------------------->------------------' |
115 | | inndcomm reports no such site |
116 | |`---------------------------------------------------- | -.
118 | | innd finishes writing D, creates F | |
119 | | inndcomm reports flush successful | |
122 | Separated <----------------' |
123 | F: innd writing F!=D /
124 | D: duct reading; or ENOENT both exist /
126 | | duct gets to the end of D /
127 | | duct opens F too /
130 | F: innd writing, duct reading |
131 | D: duct finishing V
133 | | duct finishes processing D F: ENOENT
134 | V duct unlinks D D: duct reading
136 `--<--' | duct finishes
146 "duct reading" means innduct is reading the file but also
147 overwriting processed tokens.
151 * rune for printing diagrams:
153 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
158 /*============================== PROGRAM ==============================*/
160 #define _GNU_SOURCE 1
166 #include "inndcomm.h"
168 #include "inn/list.h"
169 #include "inn/innconf.h"
172 #include <sys/types.h>
173 #include <sys/wait.h>
174 #include <sys/stat.h>
175 #include <sys/socket.h>
194 #include <oop-read.h>
196 /*----- general definitions, probably best not changed -----*/
198 #define CONNCHILD_ESTATUS_STREAM 24
199 #define CONNCHILD_ESTATUS_NOSTREAM 25
201 #define INNDCOMMCHILD_ESTATUS_FAIL 26
202 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
204 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
205 #define MAX_CONTROL_COMMAND 1000
207 #define VA va_list al; va_start(al,fmt)
208 #define PRINTF(f,a) __attribute__((__format__(printf,f,a)))
209 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
211 /*----- doubly linked lists -----*/
213 #define ISNODE(T) struct node list_node
216 union { struct list li; T *for_type; } u; \
220 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
222 #define LIST_CHECKCANHAVENODE(l,n) \
223 ((void)((n) == ((l).u.for_type))) /* just for the type check */
225 #define LIST_ADDSOMEHOW(l,n,list_addsomehow) \
226 ( LIST_CHECKCANHAVENODE(l,n), \
227 list_addsomehow(&(l).u.li, NODE((n))), \
231 #define LIST_REMSOMEHOW(l,list_remsomehow) \
232 ( (typeof((l).u.for_type)) \
235 list_remsomehow(&(l).u.li) ) \
241 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
242 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
243 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
244 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
246 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
247 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
248 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
249 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
251 #define LIST_REMOVE(l,n) \
252 ( LIST_CHECKCANHAVENODE(l,n), \
253 list_remove(NODE((n))), \
257 #define LIST_INSERT(l,n,pred) \
258 ( LIST_CHECKCANHAVENODE(l,n), \
259 LIST_CHECKCANHAVENODE(l,pred), \
260 list_insert((struct list*)&(l), NODE((n)), NODE((pred))), \
264 /*----- type predeclarations -----*/
266 typedef struct Conn Conn;
267 typedef struct Article Article;
268 typedef struct InputFile InputFile;
269 typedef struct XmitDetails XmitDetails;
270 typedef struct Filemon_Perfile Filemon_Perfile;
271 typedef enum StateMachineState StateMachineState;
276 /*----- function predeclarations -----*/
278 static void conn_maybe_write(Conn *conn);
279 static void conn_make_some_xmits(Conn *conn);
280 static void *conn_write_some_xmits(Conn *conn);
282 static void xmit_free(XmitDetails *d);
284 #define SMS(newstate, periods, why) \
285 (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
286 static void statemc_setstate(StateMachineState newsms, int periods,
287 const char *forlog, const char *why);
289 static void statemc_start_flush(const char *why); /* Normal => Flushing */
290 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
292 static void article_done(Conn *conn, Article *art, int whichcount);
294 static void check_assign_articles(void);
295 static void queue_check_input_done(void);
297 static void statemc_check_flushing_done(void);
298 static void statemc_check_backlog_done(void);
300 static void postfork(void);
301 static void period(void);
303 static void open_defer(void);
304 static void close_defer(void);
305 static void search_backlog_file(void);
307 static void inputfile_reading_start(InputFile *ipf);
308 static void inputfile_reading_stop(InputFile *ipf);
310 static void filemon_start(InputFile *ipf);
311 static void filemon_stop(InputFile *ipf);
312 static void filemon_callback(InputFile *ipf);
314 static void vconnfail(Conn *conn, const char *fmt, va_list al) PRINTF(2,0);
315 static void connfail(Conn *conn, const char *fmt, ...) PRINTF(2,3);
317 static const oop_rd_style peer_rd_style;
318 static oop_rd_call peer_rd_err, peer_rd_ok;
320 /*----- configuration options -----*/
321 /* when changing defaults, remember to update the manpage */
323 static const char *sitename, *remote_host;
324 static const char *feedfile, *realsockdir="/tmp/innduct.control";
325 static int quiet_multiple=0;
326 static int become_daemon=1, try_filemon=1;
327 static int try_stream=1;
329 static const char *inndconffile;
331 static int max_connections=10;
332 static int max_queue_per_conn=200;
333 static int target_max_feedfile_size=100000;
334 static int period_seconds=60;
335 static int filepoll_seconds=5;
337 static int connection_setup_timeout=200;
338 static int inndcomm_flush_timeout=100;
340 static double nocheck_thresh= 95.0; /* converted from percentage by main */
341 static double nocheck_decay= 100; /* conv'd from articles to lambda by main */
343 /* all these are initialised to seconds, and converted to periods in main */
344 static int reconnect_delay_periods=1000;
345 static int flushfail_retry_periods=1000;
346 static int backlog_retry_minperiods=50;
347 static int backlog_spontrescan_periods=300;
348 static int spontaneous_flush_periods=100000;
349 static int need_activity_periods=1000;
351 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
352 static int max_bad_data_initial= 30;
353 /* in one corrupt 4096-byte block the number of newlines has
354 * mean 16 and standard deviation 3.99. 30 corresponds to z=+3.5 */
357 /*----- statistics -----*/
359 typedef enum { /* in queue in conn->sent */
360 art_Unchecked, /* not checked, not sent checking */
361 art_Wanted, /* checked, wanted sent body as requested */
362 art_Unsolicited, /* - sent body without check */
366 #define RESULT_COUNTS(RCS,RCN) \
375 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
376 #define RCI_TRIPLE_VALS_BASE(counts,x) \
377 counts[art_Unchecked] x \
378 + counts[art_Wanted] x \
379 + counts[art_Unsolicited] x, \
380 counts[art_Unchecked] x \
381 , counts[art_Wanted] x \
382 , counts[art_Unsolicited] x
385 #define RC_INDEX(x) RC_##x,
386 RESULT_COUNTS(RC_INDEX, RC_INDEX)
391 /*----- transmission buffers -----*/
396 xk_Malloc, xk_Const, xk_Artdata
408 /*----- core operational data structure types -----*/
411 /* This is also an instance of struct oop_readable */
412 struct oop_readable readable; /* first */
413 oop_readable_call *readable_callback;
414 void *readable_callback_user;
417 Filemon_Perfile *filemon;
419 oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
420 long inprogress; /* no. of articles read but not processed */
424 int counts[art_MaxState][RCI_max];
425 int readcount_ok, readcount_blank, readcount_err;
440 #define SMS_LIST(X) \
448 enum StateMachineState {
449 #define SMS_DEF_ENUM(s) sm_##s,
450 SMS_LIST(SMS_DEF_ENUM)
453 static const char *sms_names[]= {
454 #define SMS_DEF_NAME(s) #s ,
455 SMS_LIST(SMS_DEF_NAME)
461 int fd; /* may be 0, meaning closed (during construction/destruction) */
462 oop_read *rd; /* likewise */
463 int max_queue, stream, quitting;
464 int since_activity; /* periods */
465 ArticleList waiting; /* not yet told peer */
466 ArticleList priority; /* peer says send it now */
467 ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
468 struct iovec xmit[CONNIOVS];
469 XmitDetails xmitd[CONNIOVS];
474 /*----- general operational variables -----*/
476 /* main initialises */
477 static oop_source *loop;
478 static ConnList conns;
479 static ArticleList queue;
480 static char *path_lock, *path_flushing, *path_defer, *path_control;
481 static char *globpat_backlog;
482 static pid_t self_pid;
484 /* statemc_init initialises */
485 static StateMachineState sms;
487 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
488 static int sm_period_counter;
490 /* initialisation to 0 is good */
491 static int until_connect, until_backlog_nextscan;
492 static double accept_proportion;
493 static int nocheck, nocheck_reported;
495 /* for simulation, debugging, etc. */
496 int simulate_flush= -1;
498 /*========== logging ==========*/
500 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
501 static void logcore(int sysloglevel, const char *fmt, ...) {
504 vsyslog(sysloglevel,fmt,al);
506 if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
507 vfprintf(stderr,fmt,al);
513 static void logv(int sysloglevel, const char *pfx, int errnoval,
514 const char *fmt, va_list al) PRINTF(5,0);
515 static void logv(int sysloglevel, const char *pfx, int errnoval,
516 const char *fmt, va_list al) {
517 char msgbuf[256]; /* NB do not call xvasprintf here or you'll recurse */
518 vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
519 msgbuf[sizeof(msgbuf)-1]= 0;
521 if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
522 sysloglevel= LOG_ERR; /* run by wrong user, probably */
524 logcore(sysloglevel, "<%s>%s: %s%s%s",
525 sitename, pfx, msgbuf,
526 errnoval>=0 ? ": " : "",
527 errnoval>=0 ? strerror(errnoval) : "");
530 #define diewrap(fn, pfx, sysloglevel, err, estatus) \
531 static void fn(const char *fmt, ...) NORET_PRINTF(1,2); \
532 static void fn(const char *fmt, ...) { \
534 logv(sysloglevel, pfx, err, fmt, al); \
538 #define logwrap(fn, pfx, sysloglevel, err) \
539 static void fn(const char *fmt, ...) PRINTF(1,2); \
540 static void fn(const char *fmt, ...) { \
542 logv(sysloglevel, pfx, err, fmt, al); \
546 diewrap(sysdie, " critical", LOG_CRIT, errno, 16);
547 diewrap(die, " critical", LOG_CRIT, -1, 16);
549 diewrap(sysfatal, " fatal", LOG_ERR, errno, 12);
550 diewrap(fatal, " fatal", LOG_ERR, -1, 12);
552 logwrap(syswarn, " warning", LOG_WARNING, errno);
553 logwrap(warn, " warning", LOG_WARNING, -1);
555 logwrap(notice, " notice", LOG_NOTICE, -1);
556 logwrap(info, " info", LOG_INFO, -1);
557 logwrap(debug, " debug", LOG_DEBUG, -1);
560 /*========== utility functions etc. ==========*/
562 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
563 static char *xvasprintf(const char *fmt, va_list al) {
565 int rc= vasprintf(&str,fmt,al);
566 if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
569 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
570 static char *xasprintf(const char *fmt, ...) {
572 char *str= xvasprintf(fmt,al);
577 static int close_perhaps(int *fd) {
578 if (*fd <= 0) return 0;
583 static void xclose(int fd, const char *what, const char *what2) {
585 if (r) sysdie("close %s%s",what,what2?what2:"");
587 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
588 if (*fd <= 0) return;
589 xclose(*fd,what,what2);
593 static pid_t xfork(const char *what) {
597 if (child==-1) sysfatal("cannot fork for %s",what);
598 debug("forked %s %ld", what, (unsigned long)child);
599 if (!child) postfork();
603 static void on_fd_read_except(int fd, oop_call_fd callback) {
604 loop->on_fd(loop, fd, OOP_READ, callback, 0);
605 loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
607 static void cancel_fd_read_except(int fd) {
608 loop->cancel_fd(loop, fd, OOP_READ);
609 loop->cancel_fd(loop, fd, OOP_EXCEPTION);
612 static void report_child_status(const char *what, int status) {
613 if (WIFEXITED(status)) {
614 int es= WEXITSTATUS(status);
616 warn("%s: child died with error exit status %d", what, es);
617 } else if (WIFSIGNALED(status)) {
618 int sig= WTERMSIG(status);
619 const char *sigstr= strsignal(sig);
620 const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
622 warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
624 warn("%s: child died due to unknown fatal signal %d%s",
625 what, sig, coredump);
627 warn("%s: child died with unknown wait status %d", what,status);
631 static int xwaitpid(pid_t *pid, const char *what) {
634 int r= kill(*pid, SIGKILL);
635 if (r) sysdie("cannot kill %s child", what);
637 pid_t got= waitpid(*pid, &status, 0);
638 if (got==-1) sysdie("cannot reap %s child", what);
639 if (got==0) die("cannot reap %s child", what);
646 static void xunlink(const char *path, const char *what) {
648 if (r) sysdie("can't unlink %s %s", path, what);
651 static time_t xtime(void) {
653 if (now==-1) sysdie("time(2) failed");
657 static void xgettimeofday(struct timeval *tv_r) {
658 int r= gettimeofday(tv_r,0);
659 if (r) sysdie("gettimeofday(2) failed");
662 static void xsetnonblock(int fd, int nonblocking) {
663 int errnoval= oop_fd_nonblock(fd, nonblocking);
664 if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
667 static void check_isreg(const struct stat *stab, const char *path,
669 if (!S_ISREG(stab->st_mode))
670 die("%s %s not a plain file (mode 0%lo)",
671 what, path, (unsigned long)stab->st_mode);
674 static void xfstat(int fd, struct stat *stab_r, const char *what) {
675 int r= fstat(fd, stab_r);
676 if (r) sysdie("could not fstat %s", what);
679 static void xfstat_isreg(int fd, struct stat *stab_r,
680 const char *path, const char *what) {
681 xfstat(fd, stab_r, what);
682 check_isreg(stab_r, path, what);
685 static void xlstat_isreg(const char *path, struct stat *stab,
686 int *enoent_r /* 0 means ENOENT is fatal */,
688 int r= lstat(path, stab);
690 if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
691 sysdie("could not lstat %s %s", what, path);
693 if (enoent_r) *enoent_r= 0;
694 check_isreg(stab, path, what);
697 static int samefile(const struct stat *a, const struct stat *b) {
698 assert(S_ISREG(a->st_mode));
699 assert(S_ISREG(b->st_mode));
700 return (a->st_ino == b->st_ino &&
701 a->st_dev == b->st_dev);
704 static char *sanitise(const char *input) {
705 static char sanibuf[100]; /* returns pointer to this buffer! */
707 const char *p= input;
711 if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
713 if (!c) { *q++= '\''; *q=0; break; }
714 if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
715 sprintf(q,"\\x%02x",c);
721 static int isewouldblock(int errnoval) {
722 return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
726 /*========== command and control connections ==========*/
728 static int control_master;
730 typedef struct ControlConn ControlConn;
732 void (*destroy)(ControlConn*);
738 struct sockaddr_un un;
743 static const oop_rd_style control_rd_style= {
744 OOP_RD_DELIM_STRIP, '\n',
746 OOP_RD_SHORTREC_FORBID
749 static void control_destroy(ControlConn *cc) {
753 static void control_checkouterr(ControlConn *cc /* may destroy*/) {
754 if (ferror(cc->out) | fflush(cc->out)) {
755 info("CTRL%d write error %s", cc->fd, strerror(errno));
760 static void control_prompt(ControlConn *cc /* may destroy*/) {
761 fprintf(cc->out, "%s| ", sitename);
762 control_checkouterr(cc);
765 typedef struct ControlCommand ControlCommand;
766 struct ControlCommand {
768 void (*f)(ControlConn *cc, const ControlCommand *ccmd,
769 const char *arg, size_t argsz);
774 static const ControlCommand control_commands[];
777 static void ccmd_##wh(ControlConn *cc, const ControlCommand *c, \
778 const char *arg, size_t argsz)
781 fputs("commands:\n", cc->out);
782 const ControlCommand *ccmd;
783 for (ccmd=control_commands; ccmd->cmd; ccmd++)
784 fprintf(cc->out, " %s\n", ccmd->cmd);
787 CCMD(period) { period(); }
788 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
789 CCMD(setint) { *(int*)c->xdata= c->xval; }
791 static const ControlCommand control_commands[]= {
793 { "p", ccmd_period },
794 { "pretend flush", ccmd_setintarg, &simulate_flush },
795 { "poke sm", ccmd_setint, &sm_period_counter, 1 },
796 { "poke conn", ccmd_setint, &until_connect, 0 },
797 { "poke blscan", ccmd_setint, &until_backlog_nextscan, 0 },
798 { "wedge blscan", ccmd_setint, &until_backlog_nextscan, -1 },
802 static void *control_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
803 const char *errmsg, int errnoval,
804 const char *data, size_t recsz, void *cc_v) {
805 ControlConn *cc= cc_v;
808 info("CTRL%d closed", cc->fd);
813 if (recsz == 0) goto prompt;
815 const ControlCommand *ccmd;
816 for (ccmd=control_commands; ccmd->cmd; ccmd++) {
817 int l= strlen(ccmd->cmd);
818 if (recsz < l) continue;
819 if (recsz > l && data[l] != ' ') continue;
820 if (memcmp(data, ccmd->cmd, l)) continue;
822 int argl= (int)recsz - (l+1);
823 ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
827 fputs("unknown command; h for help\n", cc->out);
834 static void *control_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
835 const char *errmsg, int errnoval,
836 const char *data, size_t recsz, void *cc_v) {
837 ControlConn *cc= cc_v;
839 info("CTRL%d read error %s", cc->fd, errmsg);
844 static int control_conn_startup(ControlConn *cc /* may destroy*/,
846 cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
847 if (!cc->rd) { warn("oop_rd_new_fd control failed"); return -1; }
849 int er= oop_rd_read(cc->rd, &control_rd_style, MAX_CONTROL_COMMAND,
852 if (er) { errno= er; syswarn("oop_rd_read control failed"); return -1; }
854 info("CTRL%d %s ready", cc->fd, how);
859 static void control_stdio_destroy(ControlConn *cc) {
861 oop_rd_cancel(cc->rd);
862 errno= oop_rd_delete_tidy(cc->rd);
863 if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
868 static void control_stdio(void) {
869 ControlConn *cc= xmalloc(sizeof(*cc));
870 memset(cc,0,sizeof(*cc));
871 cc->destroy= control_stdio_destroy;
875 int r= control_conn_startup(cc,"stdio");
876 if (r) cc->destroy(cc);
879 static void control_accepted_destroy(ControlConn *cc) {
881 oop_rd_cancel(cc->rd);
882 oop_rd_delete_kill(cc->rd);
884 if (cc->out) { fclose(cc->out); cc->fd=0; }
885 close_perhaps(&cc->fd);
889 static void *control_master_readable(oop_source *lp, int master,
890 oop_event ev, void *u) {
891 ControlConn *cc= xmalloc(sizeof(*cc));
892 memset(cc,0,sizeof(*cc));
893 cc->destroy= control_accepted_destroy;
895 cc->salen= sizeof(cc->sa);
896 cc->fd= accept(master, &cc->sa.sa, &cc->salen);
897 if (cc->fd<0) { syswarn("error accepting control connection"); goto x; }
899 cc->out= fdopen(cc->fd, "w");
900 if (!cc->out) { syswarn("error fdopening accepted control conn"); goto x; }
902 int r= control_conn_startup(cc, "accepted");
912 #define NOCONTROL(...) do{ \
913 syswarn("no control socket, because failed to " __VA_ARGS__); \
917 static void control_init(void) {
922 struct sockaddr_un un;
925 memset(&sa,0,sizeof(sa));
926 int maxlen= sizeof(sa.un.sun_path);
928 int reallen= readlink(path_control, sa.un.sun_path, maxlen);
931 NOCONTROL("readlink control socket symlink path %s", path_control);
933 if (reallen >= maxlen) {
934 debug("control socket symlink path too long (r=%d)",reallen);
935 xunlink(path_control, "old (overlong) control socket symlink");
941 int r= lstat(realsockdir,&stab);
943 if (errno != ENOENT) NOCONTROL("lstat real socket dir %s", realsockdir);
945 r= mkdir(realsockdir, 0700);
946 if (r) NOCONTROL("mkdir real socket dir %s", realsockdir);
949 uid_t self= geteuid();
950 if (!S_ISDIR(stab.st_mode) ||
951 stab.st_uid != self ||
952 stab.st_mode & 0007) {
953 warn("no control socket, because real socket directory"
954 " is somehow wrong (ISDIR=%d, uid=%lu (exp.%lu), mode %lo)",
955 !!S_ISDIR(stab.st_mode),
956 (unsigned long)stab.st_uid, (unsigned long)self,
957 (unsigned long)stab.st_mode & 0777UL);
962 real= xasprintf("%s/s%lx.%lx", realsockdir,
963 (unsigned long)xtime(), (unsigned long)self_pid);
964 int reallen= strlen(real);
966 if (reallen >= maxlen) {
967 warn("no control socket, because tmpnam gave overly-long path"
971 r= symlink(real, path_control);
972 if (r) NOCONTROL("make control socket path %s a symlink to real"
973 " socket path %s", path_control, real);
974 memcpy(sa.un.sun_path, real, reallen);
977 int r= unlink(sa.un.sun_path);
978 if (r && errno!=ENOENT)
979 NOCONTROL("remove old real socket %s", sa.un.sun_path);
981 control_master= socket(PF_UNIX, SOCK_STREAM, 0);
982 if (control_master<0) NOCONTROL("create new control socket");
984 sa.un.sun_family= AF_UNIX;
985 int sl= strlen(sa.un.sun_path) + offsetof(struct sockaddr_un, sun_path);
986 r= bind(control_master, &sa.sa, sl);
987 if (r) NOCONTROL("bind to real socket path %s", sa.un.sun_path);
989 r= listen(control_master, 5);
990 if (r) NOCONTROL("listen");
992 xsetnonblock(control_master, 1);
994 loop->on_fd(loop, control_master, OOP_READ, control_master_readable, 0);
995 info("control socket ok, real path %s", sa.un.sun_path);
1001 xclose_perhaps(&control_master, "control master",0);
1005 /*========== management of connections ==========*/
1007 static void conn_closefd(Conn *conn, const char *msgprefix) {
1008 int r= close_perhaps(&conn->fd);
1009 if (r) info("C%d %serror closing socket: %s",
1010 conn->fd, msgprefix, strerror(errno));
1013 static void conn_dispose(Conn *conn) {
1016 oop_rd_cancel(conn->rd);
1017 oop_rd_delete_kill(conn->rd);
1021 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1022 loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1024 conn_closefd(conn,"");
1026 until_connect= reconnect_delay_periods;
1029 static void *conn_exception(oop_source *lp, int fd,
1030 oop_event ev, void *conn_v) {
1033 assert(fd == conn->fd);
1034 assert(ev == OOP_EXCEPTION);
1035 int r= read(conn->fd, &ch, 1);
1036 if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1037 else connfail(conn,"exceptional condition on socket (peer sent urgent"
1038 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1039 return OOP_CONTINUE;
1042 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1043 int requeue[art_MaxState];
1044 memset(requeue,0,sizeof(requeue));
1047 while ((art= LIST_REMHEAD(conn->priority))) LIST_ADDTAIL(queue, art);
1048 while ((art= LIST_REMHEAD(conn->waiting))) LIST_ADDTAIL(queue, art);
1049 while ((art= LIST_REMHEAD(conn->sent))) {
1050 requeue[art->state]++;
1051 if (art->state==art_Unsolicited) art->state= art_Unchecked;
1052 LIST_ADDTAIL(queue,art);
1057 for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1060 char *m= xvasprintf(fmt,al);
1061 warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1062 conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1065 LIST_REMOVE(conns,conn);
1067 check_assign_articles();
1070 static void connfail(Conn *conn, const char *fmt, ...) {
1073 vconnfail(conn,fmt,al);
1077 static void check_idle_conns(void) {
1079 for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn))
1080 conn->since_activity++;
1082 for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn)) {
1083 if (conn->since_activity <= need_activity_periods) continue;
1085 /* We need to shut this down */
1087 connfail(conn,"timed out waiting for response to QUIT");
1088 else if (conn->sent.count)
1089 connfail(conn,"timed out waiting for responses");
1090 else if (conn->waiting.count || conn->priority.count)
1091 connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1092 else if (conn->xmitu)
1093 connfail(conn,"peer has been sending responses"
1094 " before receiving our commands!");
1096 static const char quitcmd[]= "QUIT\r\n";
1097 int todo= sizeof(quitcmd)-1;
1098 const char *p= quitcmd;
1100 int r= write(conn->fd, p, todo);
1102 if (isewouldblock(errno))
1103 connfail(conn, "blocked writing QUIT to idle connection");
1105 connfail(conn, "failed to write QUIT to idle connection: %s",
1113 conn->since_activity= 0;
1114 debug("C%d is idle, quitting", conn->fd);
1123 /*---------- making new connections ----------*/
1125 static pid_t connecting_child;
1126 static int connecting_fdpass_sock;
1128 static void connect_attempt_discard(void) {
1129 if (connecting_child) {
1130 int status= xwaitpid(&connecting_child, "connect");
1131 if (!(WIFEXITED(status) ||
1132 (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1133 report_child_status("connect", status);
1135 if (connecting_fdpass_sock) {
1136 cancel_fd_read_except(connecting_fdpass_sock);
1137 xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1141 #define PREP_DECL_MSG_CMSG(msg) \
1143 struct iovec msgiov; \
1144 msgiov.iov_base= &msgbyte; \
1145 msgiov.iov_len= 1; \
1146 struct msghdr msg; \
1147 memset(&msg,0,sizeof(msg)); \
1148 char msg##cbuf[CMSG_SPACE(sizeof(int))]; \
1149 msg.msg_iov= &msgiov; \
1150 msg.msg_iovlen= 1; \
1151 msg.msg_control= msg##cbuf; \
1152 msg.msg_controllen= sizeof(msg##cbuf);
1154 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1157 assert(fd == connecting_fdpass_sock);
1159 PREP_DECL_MSG_CMSG(msg);
1161 ssize_t rs= recvmsg(fd, &msg, 0);
1163 if (isewouldblock(errno)) return OOP_CONTINUE;
1164 syswarn("failed to read socket from connecting child");
1168 conn= xmalloc(sizeof(*conn));
1169 memset(conn,0,sizeof(*conn));
1170 LIST_INIT(conn->waiting);
1171 LIST_INIT(conn->priority);
1172 LIST_INIT(conn->sent);
1174 struct cmsghdr *h= 0;
1175 if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1177 int status= xwaitpid(&connecting_child, "connect child (broken)");
1179 if (WIFEXITED(status)) {
1180 if (WEXITSTATUS(status) != 0 &&
1181 WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1182 WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1183 /* child already reported the problem */;
1185 if (e == OOP_EXCEPTION)
1186 warn("connect: connection child exited code %d but"
1187 " unexpected exception on fdpass socket",
1188 WEXITSTATUS(status));
1190 warn("connect: connection child exited code %d but"
1192 WEXITSTATUS(status), (int)rs);
1194 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1195 warn("connect: connection attempt timed out");
1197 report_child_status("connect", status);
1202 #define CHK(field, val) \
1203 if (h->cmsg_##field != val) { \
1204 die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1205 h->cmsg_##field, val); \
1208 CHK(level, SOL_SOCKET);
1209 CHK(type, SCM_RIGHTS);
1210 CHK(len, CMSG_LEN(sizeof(conn->fd)));
1213 if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1215 memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1218 pid_t got= waitpid(connecting_child, &status, 0);
1219 if (got==-1) sysdie("connect: real wait for child");
1220 assert(got == connecting_child);
1221 connecting_child= 0;
1223 if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1224 int es= WEXITSTATUS(status);
1226 case CONNCHILD_ESTATUS_STREAM: conn->stream= 1; break;
1227 case CONNCHILD_ESTATUS_NOSTREAM: conn->stream= 0; break;
1229 fatal("connect: child gave unexpected exit status %d", es);
1233 conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1235 loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1236 conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1237 if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1238 int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1240 &peer_rd_err, conn);
1241 if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1243 notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1244 LIST_ADDHEAD(conns, conn);
1246 connect_attempt_discard();
1247 check_assign_articles();
1248 return OOP_CONTINUE;
1252 connect_attempt_discard();
1253 return OOP_CONTINUE;
1256 static int allow_connect_start(void) {
1257 return conns.count < max_connections
1258 && !connecting_child
1262 static void connect_start(void) {
1263 assert(!connecting_child);
1264 assert(!connecting_fdpass_sock);
1266 info("starting connection attempt");
1269 int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1270 if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1272 connecting_child= xfork("connection");
1274 if (!connecting_child) {
1275 FILE *cn_from, *cn_to;
1276 char buf[NNTP_STRLEN+100];
1277 int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1279 xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1281 alarm(connection_setup_timeout);
1282 if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1286 unsigned char c= buf[l-1];
1287 if (!isspace(c)) break;
1288 if (c=='\n' || c=='\r') stripped=1;
1292 sysfatal("connect: connection attempt failed");
1295 fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1299 if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1300 sysfatal("connect: authentication failed");
1302 if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1304 sysfatal("connect: could not send MODE STREAM");
1305 buf[sizeof(buf)-1]= 0;
1306 if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1307 if (ferror(cn_from))
1308 sysfatal("connect: could not read response to MODE STREAM");
1310 fatal("connect: connection close in response to MODE STREAM");
1315 fatal("connect: response to MODE STREAM is too long: %.100s...",
1317 l--; if (l>0 && buf[l-1]=='\r') l--;
1320 int rcode= strtoul(buf,&ep,10);
1322 fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf));
1326 exitstatus= CONNCHILD_ESTATUS_STREAM;
1332 warn("connect: unexpected response to MODE STREAM: %.50s",
1338 int fd= fileno(cn_from);
1340 PREP_DECL_MSG_CMSG(msg);
1341 struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1342 cmsg->cmsg_level= SOL_SOCKET;
1343 cmsg->cmsg_type= SCM_RIGHTS;
1344 cmsg->cmsg_len= CMSG_LEN(sizeof(fd));
1345 memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1347 msg.msg_controllen= cmsg->cmsg_len;
1348 r= sendmsg(socks[1], &msg, 0);
1349 if (r<0) sysdie("sendmsg failed for new connection");
1350 if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1355 xclose(socks[1], "connecting fdpass child's socket",0);
1356 connecting_fdpass_sock= socks[0];
1357 xsetnonblock(connecting_fdpass_sock, 1);
1358 on_fd_read_except(connecting_fdpass_sock, connchild_event);
1361 /*---------- assigning articles to conns, and transmitting ----------*/
1363 static void check_assign_articles(void) {
1369 int spare=0, inqueue=0;
1371 /* Find a connection to offer this article. We prefer a busy
1372 * connection to an idle one, provided it's not full. We take the
1373 * first (oldest) and since that's stable, it will mean we fill up
1374 * connections in order. That way if we have too many
1375 * connections, the spare ones will go away eventually.
1377 for (walk=LIST_HEAD(conns); walk; walk=LIST_NEXT(walk)) {
1378 if (walk->quitting) continue;
1379 inqueue= walk->sent.count + walk->priority.count
1380 + walk->waiting.count;
1381 spare= walk->max_queue - inqueue;
1382 assert(inqueue <= max_queue_per_conn);
1384 if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1385 else if (spare>0) /*working*/ { use= walk; break; }
1388 if (!inqueue) use->since_activity= 0; /* reset idle counter */
1390 Article *art= LIST_REMHEAD(queue);
1392 LIST_ADDTAIL(use->waiting, art);
1395 conn_maybe_write(use);
1396 } else if (allow_connect_start()) {
1397 until_connect= reconnect_delay_periods;
1406 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1407 conn_maybe_write(u);
1408 return OOP_CONTINUE;
1411 static void conn_maybe_write(Conn *conn) {
1413 conn_make_some_xmits(conn);
1415 loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1419 void *rp= conn_write_some_xmits(conn);
1420 if (rp==OOP_CONTINUE) {
1421 loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1423 } else if (rp==OOP_HALT) {
1426 /* transmitted everything */
1433 /*========== article transmission ==========*/
1435 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1436 XmitKind kind) { /* caller must then fill in details */
1437 struct iovec *v= &conn->xmit[conn->xmitu];
1438 XmitDetails *d= &conn->xmitd[conn->xmitu++];
1439 v->iov_base= (char*)data;
1445 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1446 xmit_core(conn,data,len, xk_Const);
1448 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1450 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1451 XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1455 static void xmit_free(XmitDetails *d) {
1457 case xk_Malloc: free(d->info.malloc_tofree); break;
1458 case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1459 case xk_Const: break;
1464 static void *conn_write_some_xmits(Conn *conn) {
1466 * 0: nothing more to write, no need to call us again
1467 * OOP_CONTINUE: more to write but fd not writeable
1468 * OOP_HALT: disaster, have destroyed conn
1471 int count= conn->xmitu;
1472 if (!count) return 0;
1474 if (count > IOV_MAX) count= IOV_MAX;
1475 ssize_t rs= writev(conn->fd, conn->xmit, count);
1477 if (isewouldblock(errno)) return OOP_CONTINUE;
1478 connfail(conn, "write failed: %s", strerror(errno));
1484 for (done=0; rs && done<conn->xmitu; done++) {
1485 struct iovec *vp= &conn->xmit[done];
1486 XmitDetails *dp= &conn->xmitd[done];
1487 if (rs > vp->iov_len) {
1491 vp->iov_base= (char*)vp->iov_base + rs;
1495 int newu= conn->xmitu - done;
1496 memmove(conn->xmit, conn->xmit + done, newu * sizeof(*conn->xmit));
1497 memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1502 static void conn_make_some_xmits(Conn *conn) {
1504 if (conn->xmitu+5 > CONNIOVS)
1507 Article *art= LIST_REMHEAD(conn->priority);
1508 if (!art) art= LIST_REMHEAD(conn->waiting);
1511 if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1512 /* actually send it */
1514 ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1517 art->state == art_Unchecked ? art_Unsolicited :
1518 art->state == art_Wanted ? art_Wanted :
1521 if (!artdata) art->missing= 1;
1522 art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1526 XMIT_LITERAL("TAKETHIS ");
1527 xmit_noalloc(conn, art->messageid, art->midlen);
1528 XMIT_LITERAL("\r\n");
1529 xmit_artbody(conn, artdata);
1531 article_done(conn, art, -1);
1535 /* we got 235 from IHAVE */
1537 xmit_artbody(conn, artdata);
1539 XMIT_LITERAL(".\r\n");
1543 LIST_ADDTAIL(conn->sent, art);
1549 XMIT_LITERAL("CHECK ");
1551 XMIT_LITERAL("IHAVE ");
1552 xmit_noalloc(conn, art->messageid, art->midlen);
1553 XMIT_LITERAL("\r\n");
1555 assert(art->state == art_Unchecked);
1556 art->ipf->counts[art->state][RC_sent]++;
1557 LIST_ADDTAIL(conn->sent, art);
1563 /*========== handling responses from peer ==========*/
1565 static const oop_rd_style peer_rd_style= {
1566 OOP_RD_DELIM_STRIP, '\n',
1568 OOP_RD_SHORTREC_FORBID
1571 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1572 const char *errmsg, int errnoval,
1573 const char *data, size_t recsz, void *conn_v) {
1575 connfail(conn, "error receiving from peer: %s", errmsg);
1576 return OOP_CONTINUE;
1579 static Article *article_reply_check(Conn *conn, const char *response,
1580 int code_indicates_streaming,
1582 /* 1:yes, -1:no, 0:dontcare */,
1583 const char *sanitised_response) {
1584 Article *art= LIST_HEAD(conn->sent);
1588 "peer gave unexpected response when no commands outstanding: %s",
1589 sanitised_response);
1593 if (code_indicates_streaming) {
1594 assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1595 if (!conn->stream) {
1596 connfail(conn, "peer gave streaming response code "
1597 " to IHAVE or subsequent body: %s", sanitised_response);
1600 const char *got_mid= response+4;
1601 int got_midlen= strcspn(got_mid, " \n\r");
1602 if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1603 connfail(conn, "peer gave streaming response with syntactically invalid"
1604 " messageid: %s", sanitised_response);
1607 if (got_midlen != art->midlen ||
1608 memcmp(got_mid, art->messageid, got_midlen)) {
1609 connfail(conn, "peer gave streaming response code to wrong article -"
1610 " probable synchronisation problem; we offered: %s;"
1612 art->messageid, sanitised_response);
1617 connfail(conn, "peer gave non-streaming response code to"
1618 " CHECK/TAKETHIS: %s", sanitised_response);
1623 if (must_have_sent>0 && art->state < art_Wanted) {
1624 connfail(conn, "peer says article accepted but"
1625 " we had not sent the body: %s", sanitised_response);
1628 if (must_have_sent<0 && art->state >= art_Wanted) {
1629 connfail(conn, "peer says please sent the article but we just did: %s",
1630 sanitised_response);
1634 Article *art_again= LIST_REMHEAD(conn->sent);
1635 assert(art_again == art);
1639 static void update_nocheck(int accepted) {
1640 accept_proportion *= nocheck_decay;
1641 accept_proportion += accepted * (1.0 - nocheck_decay);
1642 int new_nocheck= accept_proportion >= nocheck_thresh;
1643 if (new_nocheck && !nocheck_reported) {
1644 notice("entering nocheck mode for the first time");
1645 nocheck_reported= 1;
1646 } else if (new_nocheck != nocheck) {
1647 debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1649 nocheck= new_nocheck;
1652 static void article_done(Conn *conn, Article *art, int whichcount) {
1653 if (!art->missing) art->ipf->counts[art->state][whichcount]++;
1655 if (whichcount == RC_accepted) update_nocheck(1);
1656 else if (whichcount == RC_unwanted) update_nocheck(0);
1658 InputFile *ipf= art->ipf;
1660 while (art->blanklen) {
1661 static const char spaces[]=
1671 int w= art->blanklen; if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1672 int r= pwrite(ipf->fd, spaces, w, art->offset);
1674 if (errno==EINTR) continue;
1675 sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1676 art->messageid, art->blanklen,
1677 (unsigned long)art->offset, ipf->path);
1679 assert(r>=0 && r<=w);
1685 assert(ipf->inprogress >= 0);
1688 if (!ipf->inprogress && ipf != main_input_file)
1689 queue_check_input_done();
1692 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1693 const char *errmsg, int errnoval,
1694 const char *data, size_t recsz, void *conn_v) {
1697 if (ev == OOP_RD_EOF) {
1698 connfail(conn, "unexpected EOF from peer");
1699 return OOP_CONTINUE;
1701 assert(ev == OOP_RD_OK);
1703 char *sani= sanitise(data);
1706 unsigned long code= strtoul(data, &ep, 10);
1707 if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1708 connfail(conn, "badly formatted response from peer: %s", sani);
1709 return OOP_CONTINUE;
1713 conn->waiting.count ||
1714 conn->priority.count ||
1718 if (conn->quitting) {
1719 if (code!=205 && code!=503) {
1720 connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1722 notice("C%d idle connection closed by us", conn->fd);
1724 LIST_REMOVE(conns,conn);
1727 return OOP_CONTINUE;
1730 conn->since_activity= 0;
1733 #define GET_ARTICLE(musthavesent) do{ \
1734 art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1735 if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */ \
1738 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{ \
1739 code_streaming= (streaming); \
1740 GET_ARTICLE(musthavesent); \
1741 article_done(conn, art, RC_##how); \
1745 #define PEERBADMSG(m) do { \
1746 connfail(conn, m ": %s", sani); return OOP_CONTINUE; \
1749 int code_streaming= 0;
1753 case 400: PEERBADMSG("peer stopped accepting articles");
1754 default: PEERBADMSG("peer sent unexpected message");
1757 if (conn_busy) PEERBADMSG("peer timed us out");
1758 notice("C%d idle connection closed by peer", conn->fd);
1759 LIST_REMOVE(conns,conn);
1761 return OOP_CONTINUE;
1763 case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1764 case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1766 case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1767 case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1769 case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1770 case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1772 case 238: /* CHECK says send it */
1774 case 335: /* IHAVE says send it */
1776 assert(art->state == art_Unchecked);
1777 art->ipf->counts[art->state][RC_accepted]++;
1778 art->state= art_Wanted;
1779 LIST_ADDTAIL(conn->priority, art);
1782 case 431: /* CHECK or TAKETHIS says try later */
1784 case 436: /* IHAVE says try later */
1787 if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1789 sysfatal("write to defer file %s",path_defer);
1790 article_done(conn, art, RC_deferred);
1796 conn_maybe_write(conn);
1797 check_assign_articles();
1798 return OOP_CONTINUE;
1802 /*========== monitoring of input files ==========*/
1804 static void feedfile_eof(InputFile *ipf) {
1805 assert(ipf != main_input_file); /* promised by tailing_try_read */
1806 inputfile_reading_stop(ipf);
1808 if (ipf == flushing_input_file) {
1809 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1810 if (main_input_file) inputfile_reading_start(main_input_file);
1811 statemc_check_flushing_done();
1812 } else if (ipf == backlog_input_file) {
1813 statemc_check_backlog_done();
1815 abort(); /* supposed to wait rather than get EOF on main input file */
1819 static InputFile *open_input_file(const char *path) {
1820 int fd= open(path, O_RDWR);
1822 if (errno==ENOENT) return 0;
1823 sysfatal("unable to open input file %s", path);
1827 InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
1828 memset(ipf,0,sizeof(*ipf));
1831 strcpy(ipf->path, path);
1836 static void close_input_file(InputFile *ipf) { /* does not free */
1837 assert(!ipf->readable_callback); /* must have had ->on_cancel */
1838 assert(!ipf->filemon); /* must have had inputfile_reading_stop */
1839 assert(!ipf->rd); /* must have had inputfile_reading_stop */
1840 assert(!ipf->inprogress); /* no dangling pointers pointing here */
1841 xclose_perhaps(&ipf->fd, "input file ", ipf->path);
1845 /*---------- dealing with articles read in the input file ----------*/
1847 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
1848 const char *data, const char *how) {
1849 warn("corrupted file: %s, offset %lu: %s: in %s",
1850 ipf->path, (unsigned long)offset, how, sanitise(data));
1851 ipf->readcount_err++;
1852 if (ipf->readcount_err > max_bad_data_initial +
1853 (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
1854 die("too much garbage in input file! (%d errs, %d ok, %d blank)",
1855 ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
1856 return OOP_CONTINUE;
1859 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
1860 oop_rd_event ev, const char *errmsg,
1861 int errnoval, const char *data, size_t recsz,
1863 InputFile *ipf= ipf_v;
1864 assert(ev == OOP_RD_SYSTEM);
1866 sysdie("error reading input file: %s, offset %lu",
1867 ipf->path, (unsigned long)ipf->offset);
1870 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
1871 oop_rd_event ev, const char *errmsg,
1872 int errnoval, const char *data, size_t recsz,
1874 InputFile *ipf= ipf_v;
1876 char tokentextbuf[sizeof(TOKEN)*2+3];
1878 if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
1880 off_t old_offset= ipf->offset;
1881 ipf->offset += recsz + 1;
1883 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
1885 if (ev==OOP_RD_PARTREC)
1886 feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
1887 /* but process it anyway */
1889 if (ipf->skippinglong) {
1890 if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
1891 return OOP_CONTINUE;
1893 if (ev==OOP_RD_LONG) {
1894 ipf->skippinglong= 1;
1895 X_BAD_DATA("overly long line");
1898 if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
1899 if (!recsz) X_BAD_DATA("empty line");
1902 if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
1903 ipf->readcount_blank++;
1904 return OOP_CONTINUE;
1907 char *space= strchr(data,' ');
1908 int tokenlen= space-data;
1909 int midlen= (int)recsz-tokenlen-1;
1910 if (midlen <= 2) X_BAD_DATA("no room for messageid");
1911 if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
1913 if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
1914 memcpy(tokentextbuf, data, tokenlen);
1915 tokentextbuf[tokenlen]= 0;
1916 if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
1918 ipf->readcount_ok++;
1920 art= xmalloc(sizeof(*art) - 1 + midlen + 1);
1921 art->state= art_Unchecked;
1922 art->midlen= midlen;
1923 art->ipf= ipf; ipf->inprogress++;
1924 art->token= TextToToken(tokentextbuf);
1925 art->offset= old_offset;
1926 art->blanklen= recsz;
1927 strcpy(art->messageid, space+1);
1928 LIST_ADDTAIL(queue, art);
1930 if (sms==sm_NORMAL && ipf==main_input_file &&
1931 ipf->offset >= target_max_feedfile_size)
1932 statemc_start_flush("feed file size");
1934 check_assign_articles();
1935 return OOP_CONTINUE;
1938 /*========== tailing input file ==========*/
1940 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
1942 InputFile *ipf= user;
1943 return ipf->readable_callback(loop, &ipf->readable,
1944 ipf->readable_callback_user);
1947 static void tailing_on_cancel(struct oop_readable *rable) {
1948 InputFile *ipf= (void*)rable;
1950 if (ipf->filemon) filemon_stop(ipf);
1951 loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1952 ipf->readable_callback= 0;
1955 static void tailing_queue_readable(InputFile *ipf) {
1956 /* lifetime of ipf here is OK because destruction will cause
1957 * on_cancel which will cancel this callback */
1958 loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
1961 static int tailing_on_readable(struct oop_readable *rable,
1962 oop_readable_call *cb, void *user) {
1963 InputFile *ipf= (void*)rable;
1965 tailing_on_cancel(rable);
1966 ipf->readable_callback= cb;
1967 ipf->readable_callback_user= user;
1970 tailing_queue_readable(ipf);
1974 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
1976 InputFile *ipf= (void*)rable;
1978 ssize_t r= read(ipf->fd, buffer, length);
1980 if (errno==EINTR) continue;
1984 if (ipf==main_input_file) {
1987 } else if (ipf==flushing_input_file) {
1989 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1990 } else if (ipf==backlog_input_file) {
1996 tailing_queue_readable(ipf);
2001 /*---------- filemon implemented with inotify ----------*/
2003 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2004 #define HAVE_FILEMON
2006 #include <sys/inotify.h>
2008 static int filemon_inotify_fd;
2009 static int filemon_inotify_wdmax;
2010 static InputFile **filemon_inotify_wd2ipf;
2012 struct Filemon_Perfile {
2016 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2017 int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2018 if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2020 if (wd >= filemon_inotify_wdmax) {
2022 filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2023 sizeof(*filemon_inotify_wd2ipf) * newmax);
2024 memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2025 sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2026 filemon_inotify_wdmax= newmax;
2029 assert(!filemon_inotify_wd2ipf[wd]);
2030 filemon_inotify_wd2ipf[wd]= ipf;
2032 debug("filemon inotify startfile %p wd=%d wdmax=%d",
2033 ipf, wd, filemon_inotify_wdmax);
2038 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2040 debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2041 int r= inotify_rm_watch(filemon_inotify_fd, wd);
2042 if (r) sysdie("inotify_rm_watch");
2043 filemon_inotify_wd2ipf[wd]= 0;
2046 static void *filemon_inotify_readable(oop_source *lp, int fd,
2047 oop_event e, void *u) {
2048 struct inotify_event iev;
2050 int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2052 if (isewouldblock(errno)) break;
2053 sysdie("read from inotify master");
2054 } else if (r==sizeof(iev)) {
2055 assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2057 die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2059 InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2060 debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);
2061 filemon_callback(ipf);
2063 return OOP_CONTINUE;
2066 static int filemon_method_init(void) {
2067 filemon_inotify_fd= inotify_init();
2068 if (filemon_inotify_fd<0) {
2069 syswarn("filemon/inotify: inotify_init failed");
2072 xsetnonblock(filemon_inotify_fd, 1);
2073 loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2075 debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2079 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2081 /*---------- filemon dummy implementation ----------*/
2083 #if !defined(HAVE_FILEMON)
2085 struct Filemon_Perfile { int dummy; };
2087 static int filemon_method_init(void) {
2088 warn("filemon/dummy: no filemon method compiled in");
2091 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2092 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2094 #endif /* !HAVE_FILEMON */
2096 /*---------- filemon generic interface ----------*/
2098 static void filemon_start(InputFile *ipf) {
2099 assert(!ipf->filemon);
2101 ipf->filemon= xmalloc(sizeof(*ipf->filemon));
2102 memset(ipf->filemon, 0, sizeof(*ipf->filemon));
2103 filemon_method_startfile(ipf, ipf->filemon);
2106 static void filemon_stop(InputFile *ipf) {
2107 if (!ipf->filemon) return;
2108 filemon_method_stopfile(ipf, ipf->filemon);
2113 static void filemon_callback(InputFile *ipf) {
2114 if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2115 ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2118 /*---------- interface to start and stop an input file ----------*/
2120 static const oop_rd_style feedfile_rdstyle= {
2121 OOP_RD_DELIM_STRIP, '\n',
2123 OOP_RD_SHORTREC_LONG,
2126 static void inputfile_reading_start(InputFile *ipf) {
2128 ipf->readable.on_readable= tailing_on_readable;
2129 ipf->readable.on_cancel= tailing_on_cancel;
2130 ipf->readable.try_read= tailing_try_read;
2131 ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2132 ipf->readable.delete_kill= 0;
2134 ipf->readable_callback= 0;
2135 ipf->readable_callback_user= 0;
2137 ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2140 int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2141 feedfile_got_article,ipf, feedfile_read_err, ipf);
2142 if (r) sysdie("unable start reading feedfile %s",ipf->path);
2145 static void inputfile_reading_stop(InputFile *ipf) {
2147 oop_rd_cancel(ipf->rd);
2148 oop_rd_delete(ipf->rd);
2150 assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2154 /*========== interaction with innd - state machine ==========*/
2156 /* See official state diagram at top of file. We implement
2167 |`---------------------------------------------------.
2169 |`---------------- - - - |
2170 D ENOENT | D EXISTS see OVERALL STATES diagram |
2171 | for full startup logic |
2174 | ============ try to |
2180 | | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT |
2181 ^ | hardlink F to D |
2184 | | our handle onto F is now onto D |
2187 | |<-------------------<---------------------<---------+
2189 | | spawn inndcomm flush |
2191 | ================== |
2192 | FLUSHING[-ABSENT] |
2194 | main D tail/none |
2195 | ================== |
2197 | | INNDCOMM FLUSH FAILS ^
2198 | |`----------------------->----------. |
2200 | | NO SUCH SITE V |
2201 ^ |`--------------->----. ==================== |
2202 | | \ FLUSHFAILED[-ABSENT] |
2204 | | FLUSH OK \ main D tail/none |
2205 | | open F \ ==================== |
2207 | | \ | TIME TO RETRY |
2208 | |`------->----. ,---<---'\ `----------------'
2209 | | D NONE | | D NONE `----.
2211 | ============= V V ============
2212 | SEPARATED-1 | | DROPPING-1
2213 | flsh->rd!=0 | | flsh->rd!=0
2214 | [Separated] | | [Dropping]
2215 | main F idle | | main none
2216 | old D tail | | old D tail
2217 | ============= | | ============
2219 ^ | EOF ON D | | defer | EOF ON D
2221 | =============== | | ===============
2222 | SEPARATED-2 | | DROPPING-2
2223 | flsh->rd==0 | V flsh->rd==0
2224 | [Finishing] | | [Dropping]
2225 | main F tail | `. main none
2226 | old D closed | `. old D closed
2227 | =============== V `. ===============
2229 | | ALL D PROCESSED `. | ALL D PROCESSED
2230 | V install defer as backlog `. | install defer
2231 ^ | close D `. | close D
2232 | | unlink D `. | unlink D
2235 `----------' ==============
2255 static void startup_set_input_file(InputFile *f) {
2256 assert(!main_input_file);
2258 inputfile_reading_start(f);
2261 static void statemc_lock(void) {
2263 struct stat stab, stabf;
2266 lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2267 if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2270 memset(&fl,0,sizeof(fl));
2272 fl.l_whence= SEEK_SET;
2273 int r= fcntl(lockfd, F_SETLK, &fl);
2275 if (errno==EACCES || isewouldblock(errno)) {
2276 if (quiet_multiple) exit(0);
2277 fatal("another duct holds the lockfile");
2279 sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2282 xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2284 xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2286 if (!lock_noent && samefile(&stab, &stabf))
2289 xclose(lockfd, "stale lockfile ", path_lock);
2292 FILE *lockfile= fdopen(lockfd, "w");
2293 if (!lockfile) sysdie("fdopen lockfile");
2295 int r= ftruncate(lockfd, 0);
2296 if (r) sysdie("truncate lockfile to write new info");
2298 if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2299 (unsigned long)self_pid,
2300 sitename, feedfile, remote_host) == EOF ||
2302 sysfatal("write info to lockfile %s", path_lock);
2304 debug("startup: locked");
2307 static void statemc_init(void) {
2308 struct stat stabdefer;
2310 search_backlog_file();
2313 xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2315 debug("startup: ductdefer ENOENT");
2317 debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2318 switch (stabdefer.st_nlink==1) {
2320 open_defer(); /* so that we will later close it and rename it */
2323 xunlink(path_defer, "stale defer file link"
2324 " (presumably hardlink to backlog file)");
2327 die("defer file %s has unexpected link count %d",
2328 path_defer, stabdefer.st_nlink);
2332 struct stat stab_f, stab_d;
2335 InputFile *file_d= open_input_file(path_flushing);
2336 if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2338 xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2340 if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2341 debug("startup: F==D => Hardlinked");
2342 xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2347 debug("startup: F ENOENT => Moved");
2348 if (file_d) startup_set_input_file(file_d);
2349 spawn_inndcomm_flush("feedfile missing at startup");
2350 /* => Flushing, sms:=FLUSHING */
2353 debug("startup: F!=D => Separated");
2354 startup_set_input_file(file_d);
2355 SMS(SEPARATED, 0, "found both old and current feed files");
2357 debug("startup: F exists, D ENOENT => Normal");
2358 InputFile *file_f= open_input_file(feedfile);
2359 if (!file_f) die("feed file vanished during startup");
2360 startup_set_input_file(file_f);
2361 SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2366 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2367 assert(sms == sm_NORMAL);
2369 debug("starting flush (%s) (%lu >?= %lu) (%d)",
2371 (unsigned long)(main_input_file ? main_input_file->offset : 0),
2372 (unsigned long)target_max_feedfile_size,
2375 int r= link(feedfile, path_flushing);
2376 if (r) sysfatal("link feedfile %s to flushing file %s",
2377 feedfile, path_flushing);
2380 xunlink(feedfile, "old feedfile link");
2383 spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2386 static void statemc_period_poll(void) {
2387 if (!sm_period_counter) return;
2388 sm_period_counter--;
2389 assert(sm_period_counter>=0);
2391 if (sm_period_counter) return;
2394 statemc_start_flush("periodic"); /* Normal => Flushing; => FLUSHING */
2396 case sm_FLUSHFAILED:
2397 spawn_inndcomm_flush("retry"); /* Moved => Flushing; => FLUSHING */
2404 static int inputfile_is_done(InputFile *ipf) {
2406 if (ipf->inprogress) return 0; /* new article in the meantime */
2407 if (ipf->rd) return 0; /* not had EOF */
2411 static void notice_processed(InputFile *ipf, const char *what,
2413 #define RCI_NOTHING(x) /* nothing */
2414 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2415 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2417 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2419 info("processed %s%s read=%d (+bl=%d,+err=%d)"
2420 " offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2421 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2424 ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2425 CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2426 , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2427 CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2428 , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2429 RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_VALS)
2435 static void statemc_check_backlog_done(void) {
2436 InputFile *ipf= backlog_input_file;
2437 if (!inputfile_is_done(ipf)) return;
2439 const char *slash= strrchr(ipf->path, '/');
2440 const char *leaf= slash ? slash+1 : ipf->path;
2441 const char *under= strchr(slash, '_');
2442 const char *rest= under ? under+1 : leaf;
2443 if (!strncmp(rest,"backlog",7)) rest += 7;
2444 notice_processed(ipf,"backlog ",rest);
2446 close_input_file(ipf);
2447 if (unlink(ipf->path)) {
2448 if (errno != ENOENT)
2449 sysdie("could not unlink processed backlog file %s", ipf->path);
2450 warn("backlog file %s vanished while we were reading it"
2451 " so we couldn't remove it (but it's done now, anyway)",
2455 backlog_input_file= 0;
2456 search_backlog_file();
2460 static void statemc_check_flushing_done(void) {
2461 InputFile *ipf= flushing_input_file;
2462 if (!inputfile_is_done(ipf)) return;
2464 assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2466 notice_processed(ipf,"feedfile","");
2470 xunlink(path_flushing, "old flushing file");
2472 close_input_file(flushing_input_file);
2473 free(flushing_input_file);
2474 flushing_input_file= 0;
2476 if (sms==sm_SEPARATED) {
2477 notice("flush complete");
2478 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2479 } else if (sms==sm_DROPPING) {
2480 SMS(DROPPED, 0, "old flush complete");
2481 search_backlog_file();
2482 notice("feed dropped, but will continue until backlog is finished");
2486 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2488 assert(!inputfile_is_done(main_input_file));
2489 statemc_check_flushing_done();
2490 statemc_check_backlog_done();
2491 return OOP_CONTINUE;
2494 static void queue_check_input_done(void) {
2495 loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2498 static void statemc_setstate(StateMachineState newsms, int periods,
2499 const char *forlog, const char *why) {
2501 sm_period_counter= periods;
2503 const char *xtra= "";
2506 case sm_FLUSHFAILED:
2507 if (!main_input_file) xtra= "-ABSENT";
2511 xtra= flushing_input_file->rd ? "-1" : "-2";
2517 info("state %s%s[%d] %s",forlog,xtra,periods,why);
2519 info("state %s%s %s",forlog,xtra,why);
2523 /*---------- defer and backlog files ----------*/
2525 static void open_defer(void) {
2530 defer= fopen(path_defer, "a+");
2531 if (!defer) sysfatal("could not open defer file %s", path_defer);
2533 /* truncate away any half-written records */
2535 xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2537 if (stab.st_size > LONG_MAX)
2538 die("defer file %s size is far too large", path_defer);
2543 long orgsize= stab.st_size;
2544 long truncto= stab.st_size;
2546 if (!truncto) break; /* was only (if anything) one half-truncated record */
2547 if (fseek(defer, truncto-1, SEEK_SET) < 0)
2548 sysdie("seek in defer file %s while truncating partial", path_defer);
2553 sysdie("failed read from defer file %s", path_defer);
2555 die("defer file %s shrank while we were checking it!", path_defer);
2561 if (stab.st_size != truncto) {
2562 warn("truncating half-record at end of defer file %s -"
2563 " shrinking by %ld bytes from %ld to %ld",
2564 path_defer, orgsize - truncto, orgsize, truncto);
2567 sysfatal("could not flush defer file %s", path_defer);
2568 if (ftruncate(fileno(defer), truncto))
2569 sysdie("could not truncate defer file %s", path_defer);
2572 info("continuing existing defer file %s (%ld bytes)",
2573 path_defer, orgsize);
2575 if (fseek(defer, truncto, SEEK_SET))
2576 sysdie("could not seek to new end of defer file %s", path_defer);
2579 static void close_defer(void) {
2584 xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2586 if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2589 time_t now= xtime();
2591 char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2593 (unsigned long)stab.st_ino);
2594 if (link(path_defer, backlog))
2595 sysfatal("could not install defer file %s as backlog file %s",
2596 path_defer, backlog);
2597 if (unlink(path_defer))
2598 sysdie("could not unlink old defer link %s to backlog file %s",
2599 path_defer, backlog);
2603 if (until_backlog_nextscan < 0 ||
2604 until_backlog_nextscan > backlog_retry_minperiods + 1)
2605 until_backlog_nextscan= backlog_retry_minperiods + 1;
2608 static void poll_backlog_file(void) {
2609 if (until_backlog_nextscan < 0) return;
2610 if (until_backlog_nextscan-- > 0) return;
2611 search_backlog_file();
2614 static void search_backlog_file(void) {
2615 /* returns non-0 iff there are any backlog files */
2620 const char *oldest_path=0;
2621 time_t oldest_mtime=0, now;
2623 if (backlog_input_file) return;
2627 r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2631 sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2633 fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2635 for (i=0; i<gl.gl_pathc; i++) {
2636 const char *path= gl.gl_pathv[i];
2638 if (strchr(path,'#') || strchr(path,'~')) {
2639 debug("backlog file search skipping %s", path);
2642 r= stat(path, &stab);
2644 syswarn("failed to stat backlog file %s", path);
2647 if (!S_ISREG(stab.st_mode)) {
2648 warn("backlog file %s is not a plain file (or link to one)", path);
2651 if (!oldest_path || stab.st_mtime < oldest_mtime) {
2653 oldest_mtime= stab.st_mtime;
2656 case GLOB_NOMATCH: /* fall through */
2659 sysdie("glob expansion of backlog pattern %s gave unexpected"
2660 " nonzero (error?) return value %d", globpat_backlog, r);
2664 debug("backlog scan: none");
2666 if (sms==sm_DROPPED) {
2667 notice("feed dropped and our work is complete");
2669 int r= unlink(path_control);
2670 if (r && errno!=ENOENT)
2671 syswarn("failed to remove control symlink for old feed");
2673 xunlink(path_lock, "lockfile for old feed");
2676 until_backlog_nextscan= backlog_spontrescan_periods;
2681 double age= difftime(now, oldest_mtime);
2682 long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2684 if (age_deficiency <= 0) {
2685 debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2686 age, age_deficiency, oldest_path);
2688 backlog_input_file= open_input_file(oldest_path);
2689 if (!backlog_input_file) {
2690 warn("backlog file %s vanished as we opened it", oldest_path);
2694 inputfile_reading_start(backlog_input_file);
2695 until_backlog_nextscan= -1;
2699 until_backlog_nextscan= age_deficiency / period_seconds;
2701 if (backlog_spontrescan_periods >= 0 &&
2702 until_backlog_nextscan > backlog_spontrescan_periods)
2703 until_backlog_nextscan= backlog_spontrescan_periods;
2705 debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2706 age, age_deficiency, until_backlog_nextscan, oldest_path);
2713 /*========== flushing the feed ==========*/
2715 static pid_t inndcomm_child;
2716 static int inndcomm_sentinel_fd;
2718 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
2719 assert(inndcomm_child);
2720 assert(fd == inndcomm_sentinel_fd);
2721 int status= xwaitpid(&inndcomm_child, "inndcomm");
2724 cancel_fd_read_except(fd);
2725 xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
2726 inndcomm_sentinel_fd= 0;
2728 assert(!flushing_input_file);
2730 if (WIFEXITED(status)) {
2731 switch (WEXITSTATUS(status)) {
2733 case INNDCOMMCHILD_ESTATUS_FAIL:
2736 case INNDCOMMCHILD_ESTATUS_NONESUCH:
2737 notice("feed has been dropped by innd, finishing up");
2738 flushing_input_file= main_input_file;
2739 tailing_queue_readable(flushing_input_file);
2740 /* we probably previously returned EAGAIN from our fake read method
2741 * when in fact we were at EOF, so signal another readable event
2742 * so we actually see the EOF */
2746 if (flushing_input_file) {
2747 SMS(DROPPING, 0, "feed dropped by innd, but must finish last flush");
2750 SMS(DROPPED, 0, "feed dropped by innd");
2751 search_backlog_file();
2753 return OOP_CONTINUE;
2757 flushing_input_file= main_input_file;
2758 tailing_queue_readable(flushing_input_file);
2760 main_input_file= open_input_file(feedfile);
2761 if (!main_input_file)
2762 die("flush succeeded but feedfile %s does not exist!", feedfile);
2764 if (flushing_input_file) {
2765 SMS(SEPARATED, spontaneous_flush_periods, "recovery flush complete");
2768 SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2770 return OOP_CONTINUE;
2773 goto unexpected_exitstatus;
2776 } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
2777 warn("flush timed out trying to talk to innd");
2780 unexpected_exitstatus:
2781 report_child_status("inndcomm child", status);
2785 SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
2786 return OOP_CONTINUE;
2789 static void inndcommfail(const char *what) {
2790 syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
2791 exit(INNDCOMMCHILD_ESTATUS_FAIL);
2794 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
2797 notice("flushing %s",why);
2799 assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
2800 assert(!inndcomm_child);
2801 assert(!inndcomm_sentinel_fd);
2803 if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
2805 inndcomm_child= xfork("inndcomm child");
2807 if (!inndcomm_child) {
2808 const char *flushargv[2]= { sitename, 0 };
2812 xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
2813 /* parent spots the autoclose of pipefds[1] when we die or exit */
2815 if (simulate_flush>=0) {
2816 warn("SIMULATING flush child status %d", simulate_flush);
2817 if (simulate_flush>128) raise(simulate_flush-128);
2818 else exit(simulate_flush);
2821 alarm(inndcomm_flush_timeout);
2822 r= ICCopen(); if (r) inndcommfail("connect");
2823 r= ICCcommand('f',flushargv,&reply); if (r<0) inndcommfail("transmit");
2824 if (!r) exit(0); /* yay! */
2826 if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
2827 syswarn("innd ctlinnd flush failed: innd said %s", reply);
2828 exit(INNDCOMMCHILD_ESTATUS_FAIL);
2833 xclose(pipefds[1], "inndcomm sentinel child's end",0);
2834 inndcomm_sentinel_fd= pipefds[0];
2835 assert(inndcomm_sentinel_fd);
2836 on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
2838 SMS(FLUSHING, 0, why);
2841 /*========== main program ==========*/
2843 static void postfork_inputfile(InputFile *ipf) {
2845 xclose(ipf->fd, "(in child) input file ", ipf->path);
2848 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
2849 /* we have no stdio streams that are buffered long-term */
2851 if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
2854 static void postfork(void) {
2855 if (signal(SIGPIPE, SIG_DFL) == SIG_ERR)
2856 sysdie("(in child) failed to reset SIGPIPE");
2858 postfork_inputfile(main_input_file);
2859 postfork_inputfile(flushing_input_file);
2862 for (conn=LIST_HEAD(conns); conn; conn=LIST_NEXT(conn))
2863 conn_closefd(conn,"(in child) ");
2865 postfork_stdio(defer, "defer file ", path_defer);
2868 typedef struct Every Every;
2870 struct timeval interval;
2875 static void every_schedule(Every *e, struct timeval base);
2877 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
2880 if (!e->fixed_rate) xgettimeofday(&base);
2881 every_schedule(e, base);
2882 return OOP_CONTINUE;
2885 static void every_schedule(Every *e, struct timeval base) {
2886 struct timeval when;
2887 timeradd(&base, &e->interval, &when);
2888 loop->on_time(loop, when, every_happens, e);
2891 static void every(int interval, int fixed_rate, void (*f)(void)) {
2892 Every *e= xmalloc(sizeof(*e));
2893 e->interval.tv_sec= interval;
2894 e->interval.tv_usec= 0;
2895 e->fixed_rate= fixed_rate;
2898 xgettimeofday(&now);
2899 every_schedule(e, now);
2902 static void filepoll(void) {
2903 filemon_callback(main_input_file);
2904 filemon_callback(flushing_input_file);
2907 static char *debug_report_ipf(InputFile *ipf) {
2908 if (!ipf) return xasprintf("none");
2910 const char *slash= strrchr(ipf->path,'/');
2911 const char *path= slash ? slash+1 : ipf->path;
2913 return xasprintf("%p/%s:ip=%ld,off=%ld,fd=%d%s",
2915 ipf->inprogress, (long)ipf->offset,
2916 ipf->fd, ipf->rd ? "" : ",!rd");
2919 static void period(void) {
2920 char *dipf_main= debug_report_ipf(main_input_file);
2921 char *dipf_flushing= debug_report_ipf(flushing_input_file);
2922 char *dipf_backlog= debug_report_ipf(backlog_input_file);
2925 " sms=%s[%d] conns=%d queue=%d until_connect=%d"
2926 " input_files main:%s flushing:%s backlog:%s"
2927 " children connecting=%ld inndcomm=%ld"
2929 sms_names[sms], sm_period_counter,
2930 conns.count, queue.count, until_connect,
2931 dipf_main, dipf_flushing, dipf_backlog,
2932 (long)connecting_child, (long)inndcomm_child
2936 free(dipf_flushing);
2939 if (until_connect) until_connect--;
2941 poll_backlog_file();
2942 if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
2943 statemc_period_poll();
2944 check_assign_articles();
2949 /*========== option parsing ==========*/
2951 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
2952 static void vbadusage(const char *fmt, va_list al) {
2953 char *m= xvasprintf(fmt,al);
2954 fprintf(stderr, "bad usage: %s\n"
2955 "say --help for help, or read the manpage\n",
2958 syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
2962 /*---------- generic option parser ----------*/
2964 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
2965 static void badusage(const char *fmt, ...) {
2972 of_seconds= 001000u,
2973 of_boolean= 002000u,
2976 typedef struct Option Option;
2977 typedef void OptionParser(const Option*, const char *val);
2981 const char *lng, *formarg;
2987 static void parse_options(const Option *options, char ***argvp) {
2988 /* on return *argvp is first non-option arg; argc is not updated */
2991 const char *arg= *++(*argvp);
2993 if (*arg != '-') break;
2994 if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
2996 while ((a= *++arg)) {
3000 char *equals= strchr(arg,'=');
3001 int len= equals ? (equals - arg) : strlen(arg);
3002 for (o=options; o->shrt || o->lng; o++)
3003 if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3005 badusage("unknown long option --%s",arg);
3008 if (equals) badusage("option --%s does not take a value",o->lng);
3010 } else if (equals) {
3014 if (!arg) badusage("option --%s needs a value for %s",
3015 o->lng, o->formarg);
3018 break; /* eaten the whole argument now */
3020 for (o=options; o->shrt || o->lng; o++)
3023 badusage("unknown short option -%c",a);
3030 if (!arg) badusage("option -%c needs a value for %s",
3031 o->shrt, o->formarg);
3034 break; /* eaten the whole argument now */
3040 #define DELIMPERHAPS(delim,str) (str) ? (delim) : "", (str) ? (str) : ""
3042 static void print_options(const Option *options, FILE *f) {
3044 for (o=options; o->shrt || o->lng; o++) {
3045 char shrt[2] = { o->shrt, 0 };
3046 char *optspec= xasprintf("%s%s%s%s%s",
3047 o->shrt ? "-" : "", shrt,
3048 o->shrt && o->lng ? "|" : "",
3049 DELIMPERHAPS("--", o->lng));
3050 fprintf(f, " %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3055 /*---------- specific option types ----------*/
3057 static void op_integer(const Option *o, const char *val) {
3060 unsigned long ul= strtoul(val,&ep,10);
3061 if (*ep || ep==val || errno || ul>INT_MAX)
3062 badusage("bad integer value for %s",o->lng);
3063 int *store= o->store;
3067 static void op_double(const Option *o, const char *val) {
3068 int *store= o->store;
3071 *store= strtod(val, &ep);
3072 if (*ep || ep==val || errno)
3073 badusage("bad floating point value for %s",o->lng);
3076 static void op_string(const Option *o, const char *val) {
3077 const char **store= o->store;
3081 static void op_seconds(const Option *o, const char *val) {
3082 int *store= o->store;
3086 double v= strtod(val,&ep);
3087 if (ep==val) badusage("bad time/duration value for %s",o->lng);
3089 if (!*ep || !strcmp(ep,"s") || !strcmp(ep,"sec")) unit= 1;
3090 else if (!strcmp(ep,"m") || !strcmp(ep,"min")) unit= 60;
3091 else if (!strcmp(ep,"h") || !strcmp(ep,"hour")) unit= 3600;
3092 else if (!strcmp(ep,"d") || !strcmp(ep,"day")) unit= 86400;
3093 else if (!strcmp(ep,"das")) unit= 10;
3094 else if (!strcmp(ep,"hs")) unit= 100;
3095 else if (!strcmp(ep,"ks")) unit= 1000;
3096 else if (!strcmp(ep,"Ms")) unit= 1000000;
3097 else badusage("bad units %s for time/duration value for %s",ep,o->lng);
3101 if (v > INT_MAX) badusage("time/duration value for %s out of range",o->lng);
3105 static void op_setint(const Option *o, const char *val) {
3106 int *store= o->store;
3110 /*---------- specific options ----------*/
3112 static void help(const Option *o, const char *val);
3114 static const Option innduct_options[]= {
3115 {'f',"feedfile", "F", &feedfile, op_string },
3116 {'q',"quiet-multiple", 0, &quiet_multiple, op_setint, 1 },
3117 {0,"no-daemon", 0, &become_daemon, op_setint, 0 },
3118 {0,"no-streaming", 0, &try_stream, op_setint, 0 },
3119 {0,"no-filemon", 0, &try_filemon, op_setint, 0 },
3120 {'C',"inndconf", "F", &inndconffile, op_string },
3121 {'P',"port", "PORT", &port, op_integer },
3122 {0,"ctrl-sock-dir", 0, &realsockdir, op_string },
3123 {0,"help", 0, 0, help },
3125 {0,"max-connections", "N", &max_connections, op_integer },
3126 {0,"max-queue-per-conn", "N", &max_queue_per_conn, op_integer },
3127 {0,"feedfile-flush-size","BYTES", &target_max_feedfile_size, op_integer },
3128 {0,"period-interval", "TIME", &period_seconds, op_seconds },
3130 {0,"connection-timeout", "TIME", &connection_setup_timeout, op_seconds },
3131 {0,"stuck-flush-timeout", "TIME", &inndcomm_flush_timeout, op_seconds },
3132 {0,"feedfile-poll", "TIME", &filepoll_seconds, op_seconds },
3134 {0,"no-check-proportion", "PERCENT", &nocheck_thresh, op_double },
3135 {0,"no-check-response-time","ARTICLES", &nocheck_decay, op_double },
3137 {0,"reconnect-interval", "PERIOD", &reconnect_delay_periods, op_seconds },
3138 {0,"flush-retry-interval", "PERIOD", &flushfail_retry_periods, op_seconds },
3139 {0,"earliest-deferred-retry","PERIOD", &backlog_retry_minperiods, op_seconds },
3140 {0,"backlog-rescan-interval","PERIOD",&backlog_spontrescan_periods,op_seconds},
3141 {0,"max-flush-interval", "PERIOD", &spontaneous_flush_periods,op_seconds },
3142 {0,"idle-timeout", "PERIOD", &need_activity_periods, op_seconds },
3144 {0,"max-bad-input-data-ratio","PERCENT", &max_bad_data_ratio, op_double },
3145 {0,"max-bad-input-data-init", "PERCENT", &max_bad_data_initial, op_integer },
3150 static void printusage(FILE *f) {
3151 fputs("usage: innduct [options] site [fqdn]\n"
3152 "available options are:\n", f);
3153 print_options(innduct_options, f);
3156 static void help(const Option *o, const char *val) {
3158 if (ferror(stdout) || fflush(stdout)) {
3159 perror("innduct: writing help");
3165 static void convert_to_periods_rndup(int *store) {
3166 *store += period_seconds-1;
3167 *store /= period_seconds;
3170 int main(int argc, char **argv) {
3176 parse_options(innduct_options, &argv);
3181 if (!sitename) badusage("need site name argument");
3182 remote_host= *argv++;
3183 if (*argv) badusage("too many non-option arguments");
3187 int r= innconf_read(inndconffile);
3188 if (!r) badusage("could not read inn.conf (more info on stderr)");
3190 if (!remote_host) remote_host= sitename;
3192 if (nocheck_thresh < 0 || nocheck_thresh > 100)
3193 badusage("nocheck threshold percentage must be between 0..100");
3194 nocheck_thresh *= 0.01;
3196 if (nocheck_decay < 0.1)
3197 badusage("nocheck decay articles must be at least 0.1");
3198 nocheck_decay= pow(0.5, 1.0/nocheck_decay);
3200 convert_to_periods_rndup(&reconnect_delay_periods);
3201 convert_to_periods_rndup(&flushfail_retry_periods);
3202 convert_to_periods_rndup(&backlog_retry_minperiods);
3203 convert_to_periods_rndup(&backlog_spontrescan_periods);
3204 convert_to_periods_rndup(&spontaneous_flush_periods);
3205 convert_to_periods_rndup(&need_activity_periods);
3207 if (max_bad_data_ratio < 0 || max_bad_data_ratio > 100)
3208 badusage("bad input data ratio must be between 0..100");
3209 max_bad_data_ratio *= 0.01;
3212 feedfile= xasprintf("%s/%s",innconf->pathoutgoing,sitename);
3213 } else if (!feedfile[0]) {
3214 badusage("feed filename must be nonempty");
3215 } else if (feedfile[strlen(feedfile)-1]=='/') {
3216 feedfile= xasprintf("%s%s",feedfile,sitename);
3219 const char *feedfile_forbidden= "?*[~#";
3221 while ((c= *feedfile_forbidden++))
3222 if (strchr(feedfile, c))
3223 badusage("feed filename may not contain metacharacter %c",c);
3227 path_lock= xasprintf("%s_lock", feedfile);
3228 path_flushing= xasprintf("%s_flushing", feedfile);
3229 path_defer= xasprintf("%s_defer", feedfile);
3230 path_control= xasprintf("%s_control", feedfile);
3231 globpat_backlog= xasprintf("%s_backlog*", feedfile);
3233 oop_source_sys *sysloop= oop_sys_new();
3234 if (!sysloop) sysdie("could not create liboop event loop");
3235 loop= (oop_source*)sysloop;
3237 if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3238 sysdie("could not ignore SIGPIPE");
3243 if (become_daemon) {
3245 for (i=3; i<255; i++)
3246 /* do this now before we open syslog, etc. */
3248 openlog("innduct",LOG_NDELAY|LOG_PID,LOG_NEWS);
3250 int null= open("/dev/null",O_RDWR);
3251 if (null<0) sysfatal("failed to open /dev/null");
3255 xclose(null, "/dev/null original fd",0);
3257 pid_t child1= xfork("daemonise first fork");
3258 if (child1) _exit(0);
3260 pid_t sid= setsid();
3261 if (sid != child1) sysfatal("setsid failed");
3263 pid_t child2= xfork("daemonise second fork");
3264 if (child2) _exit(0);
3268 if (self_pid==-1) sysdie("getpid");
3281 notice("filemon: suppressed by command line option, polling");
3283 filemon_ok= filemon_method_init();
3285 warn("filemon: no file monitoring available, polling");
3288 every(filepoll_seconds,0,filepoll);
3290 every(period_seconds,1,period);
3296 void *run= oop_sys_run(sysloop);
3297 assert(run == OOP_ERROR);
3298 sysdie("event loop failed");