chiark / gitweb /
sort out cli dir stuff
[inn-innduct.git] / backends / innduct.c
1 /*
2  *  innduct
3  *  tailing reliable realtime streaming feeder for inn
4  *
5  *  Copyright (C) 2010 Ian Jackson <ijackson@chiark.greenend.org.uk>
6  * 
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.
11  * 
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.
16  * 
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/>.
19  *
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.)
24  */
25
26 /*
27  * Newsfeeds file entries should look like this:
28  *     host.name.of.site[/exclude,exclude,...]\
29  *             :pattern,pattern...[/distribution,distribution...]\
30  *             :Tf,Wnm
31  *             :
32  * or
33  *     sitename[/exclude,exclude,...]\
34  *             :pattern,pattern...[/distribution,distribution...]\
35  *             :Tf,Wnm
36  *             :host.name.of.site
37  *
38  * Four files full of
39  *    token messageid
40  * or might be blanked out
41  *    <spc><spc><spc><spc>....
42  *
43  * F site.name                 main feed file
44  *                                opened/created, then written, by innd
45  *                                read by duct
46  *                                unlinked by duct
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
56  *                                unlinked by duct
57  *   site.name_defer           431'd articles, still being written,
58  *                                created, written, used by duct
59  *
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
71  *                                will be removed.
72  *
73  *                             It is safe to remove backlog files manually,
74  *                             if it's desired to throw away the backlog.
75  *
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.
80  *
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.
84  * -8<-
85
86
87    OVERALL STATES:
88
89                                                                 START
90                                                                   |
91      ,-->--.                                                 check F, D
92      |     |                                                      |
93      |     |                                                      |
94      |     |  <----------------<---------------------------------'|
95      |     |                                       F exists       |
96      |     |                                       D ENOENT       |
97      |     |  duct opens F                                        |
98      |     V                                                      |
99      |  Normal                                                    |
100      |   F: innd writing, duct reading                            |
101      |   D: ENOENT                                                |
102      |     |                                                      |
103      |     |  duct decides time to flush                          |
104      |     |  duct makes hardlink                                 |
105      |     |                                                      |
106      |     V                            <------------------------'|
107      |  Hardlinked                                  F==D          |
108      |   F == D: innd writing, duct reading         both exist    |
109      ^     |                                                      |
110      |     |  duct unlinks F                                      |
111      |     |                        <-----------<-------------<--'|
112      |     |                           open D         F ENOENT    |
113      |     |                           if exists                  |
114      |     |                                                      |
115      |     V                        <---------------------.       |
116      |  Moved                                             |       |
117      |   F: ENOENT                                        |       |
118      |   D: innd writing, duct reading; or ENOENT         |       |
119      |     |                                              |       |
120      |     |  duct requests flush of feed                 |       |
121      |     |   (others can too, harmlessly)               |       |
122      |     V                                              |       |
123      |  Flushing                                          |       |
124      |   F: ENOENT                                        |       |
125      |   D: innd flushing, duct; or ENOENT                |       |
126      |     |                                              |       |
127      |     |   inndcomm flush fails                       |       |
128      |     |`-------------------------->------------------'       |
129      |     |                                                      |
130      |     |   inndcomm reports no such site                      |
131      |     |`---------------------------------------------------- | -.
132      |     |                                                      |  |
133      |     |  innd finishes writing D, creates F                  |  |
134      |     |  inndcomm reports flush successful                   |  |
135      |     |                                                      |  |
136      |     V                                                      |  |
137      |  Separated                                <----------------'  |
138      |   F: innd writing                            F!=D             /
139      |   D: duct reading; or ENOENT                  both exist     /
140      |     |                                                       /
141      |     |  duct gets to the end of D                           /
142      |     |  duct opens F too                                   /
143      |     V                                                    /
144      |  Finishing                                              /
145      |   F: innd writing, duct reading                        |
146      |   D: duct finishing                                    V
147      |     |                                            Dropping
148      |     |  duct finishes processing D                 F: ENOENT
149      |     V  duct unlinks D                             D: duct reading
150      |     |                                                  |
151      `--<--'                                                  | duct finishes
152                                                               |  processing D
153                                                               | duct unlinks D
154                                                               | duct exits
155                                                               V
156                                                         Dropped
157                                                          F: ENOENT
158                                                          D: ENOENT
159                                                          duct not running
160
161    "duct reading" means innduct is reading the file but also
162    overwriting processed tokens.
163
164  * ->8- -^L-
165  *
166  * rune for printing diagrams:
167
168 perl -ne 'print if m/-8\<-/..m/-\>8-/; print "\f" if m/-\^L-/' backends/innduct.c |a2ps -R -B -ops
169
170  *
171  */
172
173 /*============================== PROGRAM ==============================*/
174
175 #define _GNU_SOURCE 1
176
177 #include "config.h"
178 #include "storage.h"
179 #include "nntp.h"
180 #include "libinn.h"
181 #include "inndcomm.h"
182
183 #include "inn/list.h"
184 #include "inn/innconf.h"
185
186 #include <sys/uio.h>
187 #include <sys/types.h>
188 #include <sys/wait.h>
189 #include <sys/stat.h>
190 #include <sys/socket.h>
191 #include <sys/un.h>
192 #include <unistd.h>
193 #include <string.h>
194 #include <signal.h>
195 #include <stdio.h>
196 #include <errno.h>
197 #include <syslog.h>
198 #include <fcntl.h>
199 #include <stdarg.h>
200 #include <assert.h>
201 #include <stdlib.h>
202 #include <stddef.h>
203 #include <glob.h>
204 #include <time.h>
205 #include <math.h>
206 #include <ctype.h>
207
208 #include <oop.h>
209 #include <oop-read.h>
210
211 /*----- general definitions, probably best not changed -----*/
212
213 #define CONNCHILD_ESTATUS_STREAM   24
214 #define CONNCHILD_ESTATUS_NOSTREAM 25
215
216 #define INNDCOMMCHILD_ESTATUS_FAIL     26
217 #define INNDCOMMCHILD_ESTATUS_NONESUCH 27
218
219 #define MAX_LINE_FEEDFILE (NNTP_MSGID_MAXLEN + sizeof(TOKEN)*2 + 10)
220 #define MAX_CLI_COMMAND 1000
221
222 #define VA                va_list al;  va_start(al,fmt)
223 #define PRINTF(f,a)       __attribute__((__format__(printf,f,a)))
224 #define NORET_PRINTF(f,a) __attribute__((__noreturn__,__format__(printf,f,a)))
225 #define NORET             __attribute__((__noreturn__))
226
227 #define NEW(ptr)              ((ptr)= zxmalloc(sizeof(*(ptr))))
228 #define NEW_DECL(type,ptr) type ptr = zxmalloc(sizeof(*(ptr)))
229
230 #define DUMPV(fmt,pfx,v) fprintf(f, " " #v "=" fmt, pfx v);
231
232 #define FOR_CONN(conn) \
233   for ((conn)=LIST_HEAD(conns); (conn); (conn)=LIST_NEXT((conn)))
234
235 /*----- doubly linked lists -----*/
236
237 #define ISNODE(T)   struct node list_node
238 #define DEFLIST(T)                              \
239    typedef struct {                             \
240      union { struct list li; T *for_type; } u;  \
241      int count;                                 \
242    } T##List
243
244 #define NODE(n) (assert((void*)&(n)->list_node == (n)), &(n)->list_node)
245
246 #define LIST_CHECKCANHAVENODE(l,n) \
247   ((void)((n) == ((l).u.for_type))) /* just for the type check */
248
249 #define LIST_ADDSOMEHOW(l,n,list_addsomehow)    \
250  ( LIST_CHECKCANHAVENODE(l,n),                  \
251    list_addsomehow(&(l).u.li, NODE((n))),       \
252    (void)(l).count++                            \
253    )
254
255 #define LIST_REMSOMEHOW(l,list_remsomehow)      \
256  ( (typeof((l).u.for_type))                     \
257    ( (l).count                                  \
258      ? ( (l).count--,                           \
259          list_remsomehow(&(l).u.li) )           \
260      : 0                                        \
261      )                                          \
262    )
263
264
265 #define LIST_ADDHEAD(l,n) LIST_ADDSOMEHOW((l),(n),list_addhead)
266 #define LIST_ADDTAIL(l,n) LIST_ADDSOMEHOW((l),(n),list_addtail)
267 #define LIST_REMHEAD(l) LIST_REMSOMEHOW((l),list_remhead)
268 #define LIST_REMTAIL(l) LIST_REMSOMEHOW((l),list_remtail)
269
270 #define LIST_INIT(l) ((l).count=0, list_new(&(l).u.li))
271 #define LIST_HEAD(l) ((typeof((l).u.for_type))(list_head((struct list*)&(l))))
272 #define LIST_NEXT(n) ((typeof(n))list_succ(NODE((n))))
273 #define LIST_BACK(n) ((typeof(n))list_pred(NODE((n))))
274
275 #define LIST_REMOVE(l,n)                        \
276  ( LIST_CHECKCANHAVENODE(l,n),                  \
277    list_remove(NODE((n))),                      \
278    (void)(l).count--                            \
279    )
280
281 #define LIST_INSERT(l,n,pred)                                   \
282  ( LIST_CHECKCANHAVENODE(l,n),                                  \
283    LIST_CHECKCANHAVENODE(l,pred),                               \
284    list_insert((struct list*)&(l), NODE((n)), NODE((pred))),    \
285    (void)(l).count++                                            \
286    )
287
288 /*----- type predeclarations -----*/
289
290 typedef struct Conn Conn;
291 typedef struct Article Article;
292 typedef struct InputFile InputFile;
293 typedef struct XmitDetails XmitDetails;
294 typedef struct Filemon_Perfile Filemon_Perfile;
295 typedef enum StateMachineState StateMachineState;
296 typedef struct CliCommand CliCommand;
297
298 DEFLIST(Conn);
299 DEFLIST(Article);
300
301 /*----- function predeclarations -----*/
302
303 static void conn_maybe_write(Conn *conn);
304 static void conn_make_some_xmits(Conn *conn);
305 static void *conn_write_some_xmits(Conn *conn);
306
307 static void xmit_free(XmitDetails *d);
308
309 #define SMS(newstate, periods, why) \
310    (statemc_setstate(sm_##newstate,(periods),#newstate,(why)))
311 static void statemc_setstate(StateMachineState newsms, int periods,
312                              const char *forlog, const char *why);
313
314 static void statemc_start_flush(const char *why); /* Normal => Flushing */
315 static void spawn_inndcomm_flush(const char *why); /* Moved => Flushing */
316 static int trigger_flush_ok(const char *why /* 0 means timeout */);
317                                   /* => Flushing,FLUSHING, ret 1; or ret 0 */
318
319 static void article_done(Article *art, int whichcount);
320
321 static void check_assign_articles(void);
322 static void queue_check_input_done(void);
323 static void check_reading_pause_resume(InputFile *ipf);
324
325 static void statemc_check_flushing_done(void);
326 static void statemc_check_backlog_done(void);
327
328 static void postfork(void);
329 static void period(void);
330
331 static void open_defer(void);
332 static void close_defer(void);
333 static void search_backlog_file(void);
334 static void preterminate(void);
335 static void raise_default(int signo) NORET;
336 static char *debug_report_ipf(InputFile *ipf);
337
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 */
343
344 static void filemon_start(InputFile *ipf);
345 static void filemon_stop(InputFile *ipf);
346 static void filemon_callback(InputFile *ipf);
347
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);
350
351 static const oop_rd_style peer_rd_style;
352 static oop_rd_call peer_rd_err, peer_rd_ok;
353
354
355 /*----- configuration options -----*/
356 /* when changing defaults, remember to update the manpage */
357
358 static const char *sitename, *remote_host;
359 static const char *feedfile, *path_cli, *path_cli_dir;
360 static int quiet_multiple=0;
361 static int become_daemon=1, try_filemon=1;
362 static int try_stream=1;
363 static int port=119;
364 static const char *inndconffile;
365
366 static int max_connections=10;
367 static int max_queue_per_conn=200;
368 static int target_max_feedfile_size=100000;
369 static int period_seconds=60;
370 static int filepoll_seconds=5;
371 static int max_queue_per_ipf=-1;
372
373 static int connection_setup_timeout=200;
374 static int inndcomm_flush_timeout=100;
375
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 */
378
379 /* all these are initialised to seconds, and converted to periods in main */
380 static int reconnect_delay_periods=1000;
381 static int flushfail_retry_periods=1000;
382 static int backlog_retry_minperiods=50;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
387
388 static double max_bad_data_ratio= 1; /* conv'd from percentage by main */
389 static int max_bad_data_initial= 30;
390   /* in one corrupt 4096-byte block the number of newlines has
391    * mean 16 and standard deviation 3.99.  30 corresponds to z=+3.5 */
392
393
394 /*----- statistics -----*/
395
396 typedef enum {      /* in queue                 in conn->sent             */
397   art_Unchecked,    /*   not checked, not sent    checking                */
398   art_Wanted,       /*   checked, wanted          sent body as requested  */
399   art_Unsolicited,  /*   -                        sent body without check */
400   art_MaxState,
401 } ArtState;
402
403 static const char *const artstate_names[]=
404   { "Unchecked", "Wanted", "Unsolicited", 0 };
405
406 #define RESULT_COUNTS(RCS,RCN)                  \
407   RCS(sent)                                     \
408   RCS(accepted)                                 \
409   RCN(unwanted)                                 \
410   RCN(rejected)                                 \
411   RCN(deferred)                                 \
412   RCN(missing)                                  \
413   RCN(connretry)
414
415 #define RCI_TRIPLE_FMT_BASE "%d (id=%d,bod=%d,nc=%d)"
416 #define RCI_TRIPLE_VALS_BASE(counts,x)          \
417        counts[art_Unchecked] x                  \
418        + counts[art_Wanted] x                   \
419        + counts[art_Unsolicited] x,             \
420        counts[art_Unchecked] x                  \
421        , counts[art_Wanted] x                   \
422        , counts[art_Unsolicited] x
423
424 typedef enum {
425 #define RC_INDEX(x) RC_##x,
426   RESULT_COUNTS(RC_INDEX, RC_INDEX)
427   RCI_max
428 } ResultCountIndex;
429
430
431 /*----- transmission buffers -----*/
432
433 #define CONNIOVS 128
434
435 typedef enum {
436   xk_Const, xk_Artdata
437 } XmitKind;
438
439 struct XmitDetails {
440   XmitKind kind;
441   union {
442     ARTHANDLE *sm_art;
443   } info;
444 };
445
446
447 /*----- core operational data structure types -----*/
448
449 struct InputFile {
450   /* This is also an instance of struct oop_readable */
451   struct oop_readable readable; /* first */
452   oop_readable_call *readable_callback;
453   void *readable_callback_user;
454
455   int fd;
456   Filemon_Perfile *filemon;
457
458   oop_read *rd; /* non-0: reading; 0: constructing, or had EOF */
459   off_t offset;
460   int skippinglong, paused;
461
462   ArticleList queue;
463   long inprogress; /* includes queue.count and also articles in conns */
464   long autodefer; /* -1 means not doing autodefer */
465
466   int counts[art_MaxState][RCI_max];
467   int readcount_ok, readcount_blank, readcount_err, count_nooffer_missing;
468   char path[];
469 };
470
471 struct Article {
472   ISNODE(Article);
473   ArtState state;
474   int midlen, missing;
475   InputFile *ipf;
476   TOKEN token;
477   off_t offset;
478   int blanklen;
479   char messageid[1];
480 };
481
482 #define SMS_LIST(X)                             \
483   X(NORMAL)                                     \
484   X(FLUSHING)                                   \
485   X(FLUSHFAILED)                                \
486   X(SEPARATED)                                  \
487   X(DROPPING)                                   \
488   X(DROPPED)
489
490 enum StateMachineState {
491 #define SMS_DEF_ENUM(s) sm_##s,
492   SMS_LIST(SMS_DEF_ENUM)
493 };
494
495 static const char *sms_names[]= {
496 #define SMS_DEF_NAME(s) #s ,
497   SMS_LIST(SMS_DEF_NAME)
498   0
499 };
500
501 struct Conn {
502   ISNODE(Conn);
503   int fd; /* may be 0, meaning closed (during construction/destruction) */
504   oop_read *rd; /* likewise */
505   int max_queue, stream, quitting;
506   int since_activity; /* periods */
507   ArticleList waiting; /* not yet told peer */
508   ArticleList priority; /* peer says send it now */
509   ArticleList sent; /* offered/transmitted - in xmit or waiting reply */
510   struct iovec xmit[CONNIOVS];
511   XmitDetails xmitd[CONNIOVS];
512   int xmitu;
513 };
514
515
516 /*----- general operational variables -----*/
517
518 /* main initialises */
519 static oop_source *loop;
520 static ConnList conns;
521 static char *path_lock, *path_flushing, *path_defer, *path_dump;
522 static char *globpat_backlog;
523 static pid_t self_pid;
524
525 /* statemc_init initialises */
526 static StateMachineState sms;
527 static int until_flush;
528 static InputFile *main_input_file, *flushing_input_file, *backlog_input_file;
529 static FILE *defer;
530
531 /* initialisation to 0 is good */
532 static int until_connect, until_backlog_nextscan;
533 static double accept_proportion;
534 static int nocheck, nocheck_reported, in_child;
535
536 /* for simulation, debugging, etc. */
537 int simulate_flush= -1;
538
539 /*========== logging ==========*/
540
541 static void logcore(int sysloglevel, const char *fmt, ...) PRINTF(2,3);
542 static void logcore(int sysloglevel, const char *fmt, ...) {
543   VA;
544   if (become_daemon) {
545     vsyslog(sysloglevel,fmt,al);
546   } else {
547     if (self_pid) fprintf(stderr,"[%lu] ",(unsigned long)self_pid);
548     vfprintf(stderr,fmt,al);
549     putc('\n',stderr);
550   }
551   va_end(al);
552 }
553
554 static void logv(int sysloglevel, const char *pfx, int errnoval,
555                  const char *fmt, va_list al) PRINTF(5,0);
556 static void logv(int sysloglevel, const char *pfx, int errnoval,
557                  const char *fmt, va_list al) {
558   char msgbuf[1024]; /* NB do not call xvasprintf here or you'll recurse */
559   vsnprintf(msgbuf,sizeof(msgbuf), fmt,al);
560   msgbuf[sizeof(msgbuf)-1]= 0;
561
562   if (sysloglevel >= LOG_ERR && (errnoval==EACCES || errnoval==EPERM))
563     sysloglevel= LOG_ERR; /* run by wrong user, probably */
564
565   logcore(sysloglevel, "<%s>%s: %s%s%s",
566          sitename, pfx, msgbuf,
567          errnoval>=0 ? ": " : "",
568          errnoval>=0 ? strerror(errnoval) : "");
569 }
570
571 #define diewrap(fn, pfx, sysloglevel, err, estatus)             \
572   static void fn(const char *fmt, ...) NORET_PRINTF(1,2);       \
573   static void fn(const char *fmt, ...) {                        \
574     preterminate();                                             \
575     VA;                                                         \
576     logv(sysloglevel, pfx, err, fmt, al);                       \
577     exit(estatus);                                              \
578   }
579
580 #define logwrap(fn, pfx, sysloglevel, err)              \
581   static void fn(const char *fmt, ...) PRINTF(1,2);     \
582   static void fn(const char *fmt, ...) {                \
583     VA;                                                 \
584     logv(sysloglevel, pfx, err, fmt, al);               \
585     va_end(al);                                         \
586   }
587
588 diewrap(sysdie,   " critical", LOG_CRIT,    errno, 16);
589 diewrap(die,      " critical", LOG_CRIT,    -1,    16);
590
591 diewrap(sysfatal, " fatal",    LOG_ERR,     errno, 12);
592 diewrap(fatal,    " fatal",    LOG_ERR,     -1,    12);
593
594 logwrap(syswarn,  " warning",  LOG_WARNING, errno);
595 logwrap(warn,     " warning",  LOG_WARNING, -1);
596
597 logwrap(notice,   " notice",   LOG_NOTICE,  -1);
598 logwrap(info,     " info",     LOG_INFO,    -1);
599 logwrap(debug,    " debug",    LOG_DEBUG,   -1);
600
601
602 /*========== utility functions etc. ==========*/
603
604 static char *xvasprintf(const char *fmt, va_list al) PRINTF(1,0);
605 static char *xvasprintf(const char *fmt, va_list al) {
606   char *str;
607   int rc= vasprintf(&str,fmt,al);
608   if (rc<0) sysdie("vasprintf(\"%s\",...) failed", fmt);
609   return str;
610 }
611 static char *xasprintf(const char *fmt, ...) PRINTF(1,2);
612 static char *xasprintf(const char *fmt, ...) {
613   VA;
614   char *str= xvasprintf(fmt,al);
615   va_end(al);
616   return str;
617 }
618
619 static int close_perhaps(int *fd) {
620   if (*fd <= 0) return 0;
621   int r= close(*fd);
622   *fd=0;
623   return r;
624 }
625 static void xclose(int fd, const char *what, const char *what2) {
626   int r= close(fd);
627   if (r) sysdie("close %s%s",what,what2?what2:"");
628 }
629 static void xclose_perhaps(int *fd, const char *what, const char *what2) {
630   if (*fd <= 0) return;
631   xclose(*fd,what,what2);
632   *fd=0;
633 }
634
635 static pid_t xfork(const char *what) {
636   pid_t child;
637
638   child= fork();
639   if (child==-1) sysfatal("cannot fork for %s",what);
640   debug("forked %s %ld", what, (unsigned long)child);
641   if (!child) postfork();
642   return child;
643 }
644
645 static void on_fd_read_except(int fd, oop_call_fd callback) {
646   loop->on_fd(loop, fd, OOP_READ,      callback, 0);
647   loop->on_fd(loop, fd, OOP_EXCEPTION, callback, 0);
648 }
649 static void cancel_fd_read_except(int fd) {
650   loop->cancel_fd(loop, fd, OOP_READ);
651   loop->cancel_fd(loop, fd, OOP_EXCEPTION);
652 }
653
654 static void report_child_status(const char *what, int status) {
655   if (WIFEXITED(status)) {
656     int es= WEXITSTATUS(status);
657     if (es)
658       warn("%s: child died with error exit status %d", what, es);
659   } else if (WIFSIGNALED(status)) {
660     int sig= WTERMSIG(status);
661     const char *sigstr= strsignal(sig);
662     const char *coredump= WCOREDUMP(status) ? " (core dumped)" : "";
663     if (sigstr)
664       warn("%s: child died due to fatal signal %s%s", what, sigstr, coredump);
665     else
666       warn("%s: child died due to unknown fatal signal %d%s",
667            what, sig, coredump);
668   } else {
669     warn("%s: child died with unknown wait status %d", what,status);
670   }
671 }
672
673 static int xwaitpid(pid_t *pid, const char *what) {
674   int status;
675
676   int r= kill(*pid, SIGKILL);
677   if (r) sysdie("cannot kill %s child", what);
678
679   pid_t got= waitpid(*pid, &status, 0);
680   if (got==-1) sysdie("cannot reap %s child", what);
681   if (got==0) die("cannot reap %s child", what);
682
683   *pid= 0;
684
685   return status;
686 }
687
688 static void *zxmalloc(size_t sz) {
689   void *p= xmalloc(sz);
690   memset(p,0,sz);
691   return p;
692 }
693
694 static void xunlink(const char *path, const char *what) {
695   int r= unlink(path);
696   if (r) sysdie("can't unlink %s %s", path, what);
697 }
698
699 static time_t xtime(void) {
700   time_t now= time(0);
701   if (now==-1) sysdie("time(2) failed");
702   return now;
703 }
704
705 static void xsigaction(int signo, const struct sigaction *sa) {
706   int r= sigaction(signo,sa,0);
707   if (r) sysdie("sigaction failed for \"%s\"", strsignal(signo));
708 }
709
710 static void xsigsetdefault(int signo) {
711   struct sigaction sa;
712   memset(&sa,0,sizeof(sa));
713   sa.sa_handler= SIG_DFL;
714   xsigaction(signo,&sa);
715 }
716
717 static void xgettimeofday(struct timeval *tv_r) {
718   int r= gettimeofday(tv_r,0);
719   if (r) sysdie("gettimeofday(2) failed");
720 }
721
722 static void xsetnonblock(int fd, int nonblocking) {
723   int errnoval= oop_fd_nonblock(fd, nonblocking);
724   if (errnoval) { errno= errnoval; sysdie("setnonblocking"); }
725 }
726
727 static void check_isreg(const struct stat *stab, const char *path,
728                         const char *what) {
729   if (!S_ISREG(stab->st_mode))
730     die("%s %s not a plain file (mode 0%lo)",
731         what, path, (unsigned long)stab->st_mode);
732 }
733
734 static void xfstat(int fd, struct stat *stab_r, const char *what) {
735   int r= fstat(fd, stab_r);
736   if (r) sysdie("could not fstat %s", what);
737 }
738
739 static void xfstat_isreg(int fd, struct stat *stab_r,
740                          const char *path, const char *what) {
741   xfstat(fd, stab_r, what);
742   check_isreg(stab_r, path, what);
743 }
744
745 static void xlstat_isreg(const char *path, struct stat *stab,
746                          int *enoent_r /* 0 means ENOENT is fatal */,
747                          const char *what) {
748   int r= lstat(path, stab);
749   if (r) {
750     if (errno==ENOENT && enoent_r) { *enoent_r=1; return; }
751     sysdie("could not lstat %s %s", what, path);
752   }
753   if (enoent_r) *enoent_r= 0;
754   check_isreg(stab, path, what);
755 }
756
757 static int samefile(const struct stat *a, const struct stat *b) {
758   assert(S_ISREG(a->st_mode));
759   assert(S_ISREG(b->st_mode));
760   return (a->st_ino == b->st_ino &&
761           a->st_dev == b->st_dev);
762 }
763
764 static char *sanitise(const char *input, int len) {
765   static char sanibuf[100]; /* returns pointer to this buffer! */
766
767   const char *p= input;
768   const char *endp= len>=0 ? input+len : 0;
769   char *q= sanibuf;
770   *q++= '`';
771   for (;;) {
772     if (q > sanibuf+sizeof(sanibuf)-8) { strcpy(q,"'.."); break; }
773     int c= (!endp || p<endp) ? *p++ : 0;
774     if (!c) { *q++= '\''; *q=0; break; }
775     if (c>=' ' && c<=126 && c!='\\') { *q++= c; continue; }
776     sprintf(q,"\\x%02x",c);
777     q += 4;
778   }
779   return sanibuf;
780 }
781
782 static int isewouldblock(int errnoval) {
783   return errnoval==EWOULDBLOCK || errnoval==EAGAIN;
784 }
785
786 /*========== command and control (CLI) connections ==========*/
787
788 static int cli_master;
789
790 typedef struct CliConn CliConn;
791 struct CliConn {
792   void (*destroy)(CliConn*);
793   int fd;
794   oop_read *rd;
795   FILE *out;
796   union {
797     struct sockaddr sa;
798     struct sockaddr_un un;
799   } sa;
800   socklen_t salen;
801 };
802
803 static const oop_rd_style cli_rd_style= {
804   OOP_RD_DELIM_STRIP, '\n',
805   OOP_RD_NUL_FORBID,
806   OOP_RD_SHORTREC_FORBID
807 };
808
809 static void cli_destroy(CliConn *cc) {
810   cc->destroy(cc);
811 }
812
813 static void cli_checkouterr(CliConn *cc /* may destroy*/) {
814   if (ferror(cc->out) | fflush(cc->out)) {
815     info("CTRL%d write error %s", cc->fd, strerror(errno));
816     cli_destroy(cc);
817   }
818 }
819
820 static void cli_prompt(CliConn *cc /* may destroy*/) {
821   fprintf(cc->out, "%s| ", sitename);
822   cli_checkouterr(cc);
823 }
824
825 struct CliCommand {
826   const char *cmd;
827   void (*f)(CliConn *cc, const CliCommand *ccmd,
828             const char *arg, size_t argsz);
829   void *xdata;
830   int xval;
831 };
832
833 static const CliCommand cli_commands[];
834
835 #define CCMD(wh)                                                \
836   static void ccmd_##wh(CliConn *cc, const CliCommand *c,       \
837                         const char *arg, size_t argsz)
838
839 CCMD(help) {
840   fputs("commands:\n", cc->out);
841   const CliCommand *ccmd;
842   for (ccmd=cli_commands; ccmd->cmd; ccmd++)
843     fprintf(cc->out, " %s\n", ccmd->cmd);
844   fputs("NB: permissible arguments are not shown above."
845         "  Not all commands listed are safe.  See innduct(8).\n", cc->out);
846 }
847
848 CCMD(flush) {
849   int ok= trigger_flush_ok("manual request");
850   if (!ok) fprintf(cc->out,"already flushing (state is %s)\n", sms_names[sms]);
851 }
852
853 CCMD(stop) {
854   preterminate();
855   notice("terminating (CTRL%d)",cc->fd);
856   raise_default(SIGTERM);
857   abort();
858 }
859
860 CCMD(dump);
861
862 /* messing with our head: */
863 CCMD(period) { period(); }
864 CCMD(setintarg) { *(int*)c->xdata= atoi(arg); }
865 CCMD(setint) { *(int*)c->xdata= c->xval; }
866 CCMD(setint_period) { *(int*)c->xdata= c->xval; period(); }
867
868 static const CliCommand cli_commands[]= {
869   { "h",             ccmd_help      },
870   { "flush",         ccmd_flush     },
871   { "stop",          ccmd_stop      },
872   { "dump q",        ccmd_dump, 0,0 },
873   { "dump a",        ccmd_dump, 0,1 },
874
875   { "p",             ccmd_period    },
876
877 #define POKES(cmd,func)                                                 \
878   { cmd "flush",     func,           &until_flush,             1 },     \
879   { cmd "conn",      func,           &until_connect,           0 },     \
880   { cmd "blscan",    func,           &until_backlog_nextscan,  0 },
881 POKES("next ", ccmd_setint)
882 POKES("prod ", ccmd_setint_period)
883
884   { "pretend flush", ccmd_setintarg, &simulate_flush             },
885   { "wedge blscan",  ccmd_setint,    &until_backlog_nextscan, -1 },
886   { 0 }
887 };
888
889 static void *cli_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
890                        const char *errmsg, int errnoval,
891                        const char *data, size_t recsz, void *cc_v) {
892   CliConn *cc= cc_v;
893
894   if (!data) {
895     info("CTRL%d closed", cc->fd);
896     cc->destroy(cc);
897     return OOP_CONTINUE;
898   }
899
900   if (recsz == 0) goto prompt;
901
902   const CliCommand *ccmd;
903   for (ccmd=cli_commands; ccmd->cmd; ccmd++) {
904     int l= strlen(ccmd->cmd);
905     if (recsz < l) continue;
906     if (recsz > l && data[l] != ' ') continue;
907     if (memcmp(data, ccmd->cmd, l)) continue;
908
909     int argl= (int)recsz - (l+1); 
910     ccmd->f(cc, ccmd, argl>=0 ? data+l+1 : 0, argl);
911     goto prompt;
912   }
913
914   fputs("unknown command; h for help\n", cc->out);
915
916  prompt:
917   cli_prompt(cc);
918   return OOP_CONTINUE;
919 }
920
921 static void *cli_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
922                         const char *errmsg, int errnoval,
923                         const char *data, size_t recsz, void *cc_v) {
924   CliConn *cc= cc_v;
925   
926   info("CTRL%d read error %s", cc->fd, errmsg);
927   cc->destroy(cc);
928   return OOP_CONTINUE;
929 }
930
931 static int cli_conn_startup(CliConn *cc /* may destroy*/,
932                                 const char *how) {
933   cc->rd= oop_rd_new_fd(loop, cc->fd, 0,0);
934   if (!cc->rd) { warn("oop_rd_new_fd cli failed"); return -1; }
935
936   int er= oop_rd_read(cc->rd, &cli_rd_style, MAX_CLI_COMMAND,
937                       cli_rd_ok, cc,
938                       cli_rd_err, cc);
939   if (er) { errno= er; syswarn("oop_rd_read cli failed"); return -1; }
940
941   info("CTRL%d %s ready", cc->fd, how);
942   cli_prompt(cc);
943   return 0;
944 }
945
946 static void cli_stdio_destroy(CliConn *cc) {
947   if (cc->rd) {
948     oop_rd_cancel(cc->rd);
949     errno= oop_rd_delete_tidy(cc->rd);
950     if (errno) syswarn("oop_rd_delete tidy failed (no-nonblock stdin?)");
951   }
952   free(cc);
953 }
954
955 static void cli_stdio(void) {
956   NEW_DECL(CliConn *,cc);
957   cc->destroy= cli_stdio_destroy;
958
959   cc->fd= 0;
960   cc->out= stdout;
961   int r= cli_conn_startup(cc,"stdio");
962   if (r) cc->destroy(cc);
963 }
964
965 static void cli_accepted_destroy(CliConn *cc) {
966   if (cc->rd) {
967     oop_rd_cancel(cc->rd);
968     oop_rd_delete_kill(cc->rd);
969   }
970   if (cc->out) { fclose(cc->out); cc->fd=0; }
971   close_perhaps(&cc->fd);
972   free(cc);
973 }
974
975 static void *cli_master_readable(oop_source *lp, int master,
976                                  oop_event ev, void *u) {
977   NEW_DECL(CliConn *,cc);
978   cc->destroy= cli_accepted_destroy;
979
980   cc->salen= sizeof(cc->sa);
981   cc->fd= accept(master, &cc->sa.sa, &cc->salen);
982   if (cc->fd<0) { syswarn("error accepting cli connection"); goto x; }
983
984   cc->out= fdopen(cc->fd, "w");
985   if (!cc->out) { syswarn("error fdopening accepted cli connection"); goto x; }
986
987   int r= cli_conn_startup(cc, "accepted");
988   if (r) goto x;
989
990   return OOP_CONTINUE;
991
992  x:
993   cc->destroy(cc);
994   return OOP_CONTINUE;
995 }
996
997 #define NOCLI(...) do{                                          \
998     syswarn("no cli listener, because failed to " __VA_ARGS__); \
999     goto nocli;                                                 \
1000   }while(0)
1001
1002 static void cli_init(void) {
1003   union {
1004     struct sockaddr sa;
1005     struct sockaddr_un un;
1006   } sa;
1007
1008   memset(&sa,0,sizeof(sa));
1009   int maxlen= sizeof(sa.un.sun_path);
1010
1011   if (!path_cli) {
1012     info("control command line disabled");
1013     return;
1014   }
1015
1016   int pathlen= strlen(path_cli);
1017   if (pathlen > maxlen) {
1018     warn("no cli listener, because cli socket path %s too long (%d>%d)",
1019          path_cli, pathlen, maxlen);
1020     return;
1021   }
1022
1023   if (path_cli_dir) {
1024     int r= mkdir(path_cli_dir, 0700);
1025     if (r && errno!=EEXIST)
1026       NOCLI("create cli socket directory %s", path_cli_dir);
1027   }
1028
1029   int r= unlink(path_cli);
1030   if (r && errno!=ENOENT)
1031     NOCLI("remove old cli socket %s", path_cli);
1032
1033   cli_master= socket(PF_UNIX, SOCK_STREAM, 0);
1034   if (cli_master<0) NOCLI("create new cli master socket");
1035
1036   int sl= pathlen + offsetof(struct sockaddr_un, sun_path);
1037   sa.un.sun_family= AF_UNIX;
1038   memcpy(sa.un.sun_path, path_cli, pathlen);
1039
1040   r= bind(cli_master, &sa.sa, sl);
1041   if (r) NOCLI("bind to cli socket path %s", sa.un.sun_path);
1042
1043   r= listen(cli_master, 5);
1044   if (r) NOCLI("listen to cli master socket");
1045
1046   xsetnonblock(cli_master, 1);
1047
1048   loop->on_fd(loop, cli_master, OOP_READ, cli_master_readable, 0);
1049   info("cli ready, listening on %s", path_cli);
1050
1051   return;
1052
1053  nocli:
1054   xclose_perhaps(&cli_master, "cli master",0);
1055   return;
1056 }
1057
1058 /*========== management of connections ==========*/
1059
1060 static void conn_closefd(Conn *conn, const char *msgprefix) {
1061   int r= close_perhaps(&conn->fd);
1062   if (r) info("C%d %serror closing socket: %s",
1063               conn->fd, msgprefix, strerror(errno));
1064 }
1065
1066 static void conn_dispose(Conn *conn) {
1067   if (!conn) return;
1068   if (conn->rd) {
1069     oop_rd_cancel(conn->rd);
1070     oop_rd_delete_kill(conn->rd);
1071     conn->rd= 0;
1072   }
1073   if (conn->fd) {
1074     loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1075     loop->cancel_fd(loop, conn->fd, OOP_EXCEPTION);
1076   }
1077   conn_closefd(conn,"");
1078   free(conn);
1079   until_connect= reconnect_delay_periods;
1080 }
1081
1082 static void *conn_exception(oop_source *lp, int fd,
1083                             oop_event ev, void *conn_v) {
1084   Conn *conn= conn_v;
1085   unsigned char ch;
1086   assert(fd == conn->fd);
1087   assert(ev == OOP_EXCEPTION);
1088   int r= read(conn->fd, &ch, 1);
1089   if (r<0) connfail(conn,"read failed: %s",strerror(errno));
1090   else connfail(conn,"exceptional condition on socket (peer sent urgent"
1091                 " data? read(,&ch,1)=%d,ch='\\x%02x')",r,ch);
1092   return OOP_CONTINUE;
1093 }  
1094
1095 static void vconnfail(Conn *conn, const char *fmt, va_list al) {
1096   int requeue[art_MaxState];
1097   memset(requeue,0,sizeof(requeue));
1098
1099   Article *art;
1100   
1101   while ((art= LIST_REMHEAD(conn->priority)))
1102     LIST_ADDTAIL(art->ipf->queue, art);
1103
1104   while ((art= LIST_REMHEAD(conn->waiting)))
1105     LIST_ADDTAIL(art->ipf->queue, art);
1106
1107   while ((art= LIST_REMHEAD(conn->sent))) {
1108     requeue[art->state]++;
1109     if (art->state==art_Unsolicited) art->state= art_Unchecked;
1110     LIST_ADDTAIL(art->ipf->queue,art);
1111     check_reading_pause_resume(art->ipf);
1112   }
1113
1114   int i;
1115   XmitDetails *d;
1116   for (i=0, d=conn->xmitd; i<conn->xmitu; i++, d++)
1117     xmit_free(d);
1118
1119   char *m= xvasprintf(fmt,al);
1120   warn("C%d connection failed (requeueing " RCI_TRIPLE_FMT_BASE "): %s",
1121        conn->fd, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1122   free(m);
1123
1124   LIST_REMOVE(conns,conn);
1125   conn_dispose(conn);
1126   check_assign_articles();
1127 }
1128
1129 static void connfail(Conn *conn, const char *fmt, ...) {
1130   va_list al;
1131   va_start(al,fmt);
1132   vconnfail(conn,fmt,al);
1133   va_end(al);
1134 }
1135
1136 static void check_idle_conns(void) {
1137   Conn *conn;
1138   FOR_CONN(conn)
1139     conn->since_activity++;
1140  search_again:
1141   FOR_CONN(conn) {
1142     if (conn->since_activity <= need_activity_periods) continue;
1143
1144     /* We need to shut this down */
1145     if (conn->quitting)
1146       connfail(conn,"timed out waiting for response to QUIT");
1147     else if (conn->sent.count)
1148       connfail(conn,"timed out waiting for responses");
1149     else if (conn->waiting.count || conn->priority.count)
1150       connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1151     else if (conn->xmitu)
1152       connfail(conn,"peer has been sending responses"
1153                " before receiving our commands!");
1154     else {
1155       static const char quitcmd[]= "QUIT\r\n";
1156       int todo= sizeof(quitcmd)-1;
1157       const char *p= quitcmd;
1158       for (;;) {
1159         int r= write(conn->fd, p, todo);
1160         if (r<0) {
1161           if (isewouldblock(errno))
1162             connfail(conn, "blocked writing QUIT to idle connection");
1163           else
1164             connfail(conn, "failed to write QUIT to idle connection: %s",
1165                      strerror(errno));
1166           break;
1167         }
1168         assert(r<=todo);
1169         todo -= r;
1170         if (!todo) {
1171           conn->quitting= 1;
1172           conn->since_activity= 0;
1173           debug("C%d is idle, quitting", conn->fd);
1174           break;
1175         }
1176       }
1177     }
1178     goto search_again;
1179   }
1180 }  
1181
1182 /*---------- making new connections ----------*/
1183
1184 static pid_t connecting_child;
1185 static int connecting_fdpass_sock;
1186
1187 static void connect_attempt_discard(void) {
1188   if (connecting_child) {
1189     int status= xwaitpid(&connecting_child, "connect");
1190     if (!(WIFEXITED(status) ||
1191           (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1192       report_child_status("connect", status);
1193   }
1194   if (connecting_fdpass_sock) {
1195     cancel_fd_read_except(connecting_fdpass_sock);
1196     xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1197   }
1198 }
1199
1200 #define PREP_DECL_MSG_CMSG(msg)                 \
1201   char msgbyte= 0;                              \
1202   struct iovec msgiov;                          \
1203   msgiov.iov_base= &msgbyte;                    \
1204   msgiov.iov_len= 1;                            \
1205   struct msghdr msg;                            \
1206   memset(&msg,0,sizeof(msg));                   \
1207   char msg##cbuf[CMSG_SPACE(sizeof(int))];      \
1208   msg.msg_iov= &msgiov;                         \
1209   msg.msg_iovlen= 1;                            \
1210   msg.msg_control= msg##cbuf;                   \
1211   msg.msg_controllen= sizeof(msg##cbuf);
1212
1213 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1214   Conn *conn= 0;
1215
1216   assert(fd == connecting_fdpass_sock);
1217
1218   PREP_DECL_MSG_CMSG(msg);
1219   
1220   ssize_t rs= recvmsg(fd, &msg, 0);
1221   if (rs<0) {
1222     if (isewouldblock(errno)) return OOP_CONTINUE;
1223     syswarn("failed to read socket from connecting child");
1224     goto x;
1225   }
1226
1227   NEW(conn);
1228   LIST_INIT(conn->waiting);
1229   LIST_INIT(conn->priority);
1230   LIST_INIT(conn->sent);
1231
1232   struct cmsghdr *h= 0;
1233   if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1234   if (!h) {
1235     int status= xwaitpid(&connecting_child, "connect child (broken)");
1236
1237     if (WIFEXITED(status)) {
1238       if (WEXITSTATUS(status) != 0 &&
1239           WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1240           WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1241         /* child already reported the problem */;
1242       else {
1243         if (e == OOP_EXCEPTION)
1244           warn("connect: connection child exited code %d but"
1245                " unexpected exception on fdpass socket",
1246                WEXITSTATUS(status));
1247         else
1248           warn("connect: connection child exited code %d but"
1249                " no cmsg (rs=%d)",
1250                WEXITSTATUS(status), (int)rs);
1251       }
1252     } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1253       warn("connect: connection attempt timed out");
1254     } else {
1255       report_child_status("connect", status);
1256     }
1257     goto x;
1258   }
1259
1260 #define CHK(field, val)                                                  \
1261   if (h->cmsg_##field != val) {                                          \
1262     die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1263         h->cmsg_##field, val);                                           \
1264     goto x;                                                              \
1265   }
1266   CHK(level, SOL_SOCKET);
1267   CHK(type,  SCM_RIGHTS);
1268   CHK(len,   CMSG_LEN(sizeof(conn->fd)));
1269 #undef CHK
1270
1271   if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1272
1273   memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1274
1275   int status;
1276   pid_t got= waitpid(connecting_child, &status, 0);
1277   if (got==-1) sysdie("connect: real wait for child");
1278   assert(got == connecting_child);
1279   connecting_child= 0;
1280
1281   if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1282   int es= WEXITSTATUS(status);
1283   switch (es) {
1284   case CONNCHILD_ESTATUS_STREAM:    conn->stream= 1;   break;
1285   case CONNCHILD_ESTATUS_NOSTREAM:  conn->stream= 0;   break;
1286   default:
1287     fatal("connect: child gave unexpected exit status %d", es);
1288   }
1289
1290   /* Phew! */
1291   conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1292
1293   loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1294   conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1295   if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1296   int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1297                      &peer_rd_ok, conn,
1298                      &peer_rd_err, conn);
1299   if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1300
1301   notice("C%d connected %s", conn->fd, conn->stream ? "streaming" : "plain");
1302   LIST_ADDHEAD(conns, conn);
1303
1304   connect_attempt_discard();
1305   check_assign_articles();
1306   return OOP_CONTINUE;
1307
1308  x:
1309   conn_dispose(conn);
1310   connect_attempt_discard();
1311   return OOP_CONTINUE;
1312 }
1313
1314 static int allow_connect_start(void) {
1315   return conns.count < max_connections
1316     && !connecting_child
1317     && !until_connect;
1318 }
1319
1320 static void connect_start(void) {
1321   assert(!connecting_child);
1322   assert(!connecting_fdpass_sock);
1323
1324   info("starting connection attempt");
1325
1326   int socks[2];
1327   int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1328   if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1329
1330   connecting_child= xfork("connection");
1331
1332   if (!connecting_child) {
1333     FILE *cn_from, *cn_to;
1334     char buf[NNTP_STRLEN+100];
1335     int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1336
1337     xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1338
1339     alarm(connection_setup_timeout);
1340     if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1341       int l= strlen(buf);
1342       int stripped=0;
1343       while (l>0) {
1344         unsigned char c= buf[l-1];
1345         if (!isspace(c)) break;
1346         if (c=='\n' || c=='\r') stripped=1;
1347         --l;
1348       }
1349       if (!buf[0]) {
1350         sysfatal("connect: connection attempt failed");
1351       } else {
1352         buf[l]= 0;
1353         fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1354               sanitise(buf,-1));
1355       }
1356     }
1357     if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1358       sysfatal("connect: authentication failed");
1359     if (try_stream) {
1360       if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1361           fflush(cn_to))
1362         sysfatal("connect: could not send MODE STREAM");
1363       buf[sizeof(buf)-1]= 0;
1364       if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1365         if (ferror(cn_from))
1366           sysfatal("connect: could not read response to MODE STREAM");
1367         else
1368           fatal("connect: connection close in response to MODE STREAM");
1369       }
1370       int l= strlen(buf);
1371       assert(l>=1);
1372       if (buf[l-1]!='\n')
1373         fatal("connect: response to MODE STREAM is too long: %.100s...",
1374               sanitise(buf,-1));
1375       l--;  if (l>0 && buf[l-1]=='\r') l--;
1376       buf[l]= 0;
1377       char *ep;
1378       int rcode= strtoul(buf,&ep,10);
1379       if (ep != &buf[3])
1380         fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1381
1382       switch (rcode) {
1383       case 203:
1384         exitstatus= CONNCHILD_ESTATUS_STREAM;
1385         break;
1386       case 480:
1387       case 500:
1388         break;
1389       default:
1390         warn("connect: unexpected response to MODE STREAM: %.50s",
1391              sanitise(buf,-1));
1392         exitstatus= 2;
1393         break;
1394       }
1395     }
1396     int fd= fileno(cn_from);
1397
1398     PREP_DECL_MSG_CMSG(msg);
1399     struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1400     cmsg->cmsg_level= SOL_SOCKET;
1401     cmsg->cmsg_type=  SCM_RIGHTS;
1402     cmsg->cmsg_len=   CMSG_LEN(sizeof(fd));
1403     memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1404
1405     msg.msg_controllen= cmsg->cmsg_len;
1406     r= sendmsg(socks[1], &msg, 0);
1407     if (r<0) sysdie("sendmsg failed for new connection");
1408     if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1409
1410     _exit(exitstatus);
1411   }
1412
1413   xclose(socks[1], "connecting fdpass child's socket",0);
1414   connecting_fdpass_sock= socks[0];
1415   xsetnonblock(connecting_fdpass_sock, 1);
1416   on_fd_read_except(connecting_fdpass_sock, connchild_event);
1417 }
1418
1419 /*---------- assigning articles to conns, and transmitting ----------*/
1420
1421 static Article *dequeue_from(int peek, InputFile *ipf) {
1422   if (!ipf) return 0;
1423   if (peek) return LIST_HEAD(ipf->queue);
1424
1425   Article *art= LIST_REMHEAD(ipf->queue);
1426   if (!art) return 0;
1427   check_reading_pause_resume(ipf);
1428   return art;
1429 }
1430
1431 static Article *dequeue(int peek) {
1432   Article *art;
1433   art= dequeue_from(peek, flushing_input_file);  if (art) return art;
1434   art= dequeue_from(peek, backlog_input_file);   if (art) return art;
1435   art= dequeue_from(peek, main_input_file);      if (art) return art;
1436   return 0;
1437 }
1438
1439 static void check_assign_articles(void) {
1440   for (;;) {
1441     if (!dequeue(1))
1442       break;
1443
1444     Conn *walk, *use=0;
1445     int spare=0, inqueue=0;
1446
1447     /* Find a connection to offer this article.  We prefer a busy
1448      * connection to an idle one, provided it's not full.  We take the
1449      * first (oldest) and since that's stable, it will mean we fill up
1450      * connections in order.  That way if we have too many
1451      * connections, the spare ones will go away eventually.
1452      */
1453     FOR_CONN(walk) {
1454       if (walk->quitting) continue;
1455       inqueue= walk->sent.count + walk->priority.count
1456              + walk->waiting.count;
1457       spare= walk->max_queue - inqueue;
1458       assert(inqueue <= max_queue_per_conn);
1459       assert(spare >= 0);
1460       if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1461       else if (spare>0) /*working*/ { use= walk; break; }
1462     }
1463     if (use) {
1464       if (!inqueue) use->since_activity= 0; /* reset idle counter */
1465       while (spare>0) {
1466         Article *art= dequeue(0);
1467         if (!art) break;
1468         LIST_ADDTAIL(use->waiting, art);
1469         spare--;
1470       }
1471       conn_maybe_write(use);
1472     } else if (allow_connect_start()) {
1473       until_connect= reconnect_delay_periods;
1474       connect_start();
1475       break;
1476     } else {
1477       break;
1478     }
1479   }
1480 }
1481
1482 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1483   conn_maybe_write(u);
1484   return OOP_CONTINUE;
1485 }
1486
1487 static void conn_maybe_write(Conn *conn)  {
1488   for (;;) {
1489     conn_make_some_xmits(conn);
1490     if (!conn->xmitu) {
1491       loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1492       return;
1493     }
1494
1495     void *rp= conn_write_some_xmits(conn);
1496     if (rp==OOP_CONTINUE) {
1497       loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1498       return;
1499     } else if (rp==OOP_HALT) {
1500       return;
1501     } else if (!rp) {
1502       /* transmitted everything */
1503     } else {
1504       abort();
1505     }
1506   }
1507 }
1508
1509 /*---------- expiry, flow control and deferral ----------*/
1510
1511 /*
1512  * flow control notes
1513  * to ensure articles go away eventually
1514  * separate queue for each input file
1515  *   queue expiry
1516  *     every period, check head of backlog queue for expiry with SMretrieve
1517  *       if too old: discard, and check next article
1518  *     also check every backlog article as we read it
1519  *   flush expiry
1520  *     after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1521  *     one-off: eat queued articles from flushing and write them to defer
1522  *     one-off: connfail all connections which have any articles from flushing
1523  *     newly read articles from flushing go straight to defer
1524  *     this should take care of it and get us out of this state
1525  * to avoid filling up ram needlessly
1526  *   input control
1527  *     limit number of queued articles for each ipf
1528  *     pause/resume inputfile tailing
1529  */
1530
1531 static void check_reading_pause_resume(InputFile *ipf) {
1532   if (ipf->queue.count >= max_queue_per_ipf)
1533     inputfile_reading_pause(ipf);
1534   else
1535     inputfile_reading_resume(ipf);
1536 }
1537
1538 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1539   open_defer();
1540   if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1541       || fflush(defer))
1542     sysfatal("write to defer file %s",path_defer);
1543   article_done(art, whichcount);
1544 }
1545
1546 static int article_check_expired(Article *art /* must be queued, not conn */) {
1547   ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1548   if (artdata) { SMfreearticle(artdata); return 0; }
1549
1550   LIST_REMOVE(art->ipf->queue, art);
1551   art->missing= 1;
1552   art->ipf->count_nooffer_missing++;
1553   article_done(art,-1);
1554   return 1;
1555 }
1556
1557 static void inputfile_queue_check_expired(InputFile *ipf) {
1558   if (!ipf) return;
1559
1560   for (;;) {
1561     Article *art= LIST_HEAD(ipf->queue);
1562     int exp= article_check_expired(art);
1563     if (!exp) break;
1564   }
1565   check_reading_pause_resume(ipf);
1566 }
1567
1568 static void article_autodefer(InputFile *ipf, Article *art) {
1569   ipf->autodefer++;
1570   article_defer(art,-1);
1571 }
1572
1573 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1574   Article *art;
1575   for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1576     if (art->ipf == ipf) return 1;
1577   return 0;
1578 }
1579
1580 static void autodefer_input_file_articles(InputFile *ipf) {
1581   Article *art;
1582   while ((art= LIST_REMHEAD(ipf->queue)))
1583     article_autodefer(ipf, art);
1584 }
1585
1586 static void autodefer_input_file(InputFile *ipf) {
1587   ipf->autodefer= 0;
1588
1589   autodefer_input_file_articles(ipf);
1590
1591   if (ipf->inprogress) {
1592     Conn *walk;
1593     FOR_CONN(walk) {
1594       if (has_article_in(&walk->waiting,  ipf) ||
1595           has_article_in(&walk->priority, ipf) ||
1596           has_article_in(&walk->sent,     ipf))
1597         walk->quitting= -1;
1598     }
1599     while (ipf->inprogress) {
1600       FOR_CONN(walk)
1601         if (walk->quitting < 0) goto found;
1602       abort(); /* where are they ?? */
1603
1604     found:
1605       connfail(walk, "connection is stuck or crawling,"
1606                " and we need to finish flush");
1607       autodefer_input_file_articles(ipf);
1608     }
1609   }
1610
1611   check_reading_pause_resume(ipf);
1612 }
1613
1614 /*========== article transmission ==========*/
1615
1616 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1617                   XmitKind kind) { /* caller must then fill in details */
1618   struct iovec *v= &conn->xmit[conn->xmitu];
1619   XmitDetails *d= &conn->xmitd[conn->xmitu++];
1620   v->iov_base= (char*)data;
1621   v->iov_len= len;
1622   d->kind= kind;
1623   return d;
1624 }
1625
1626 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1627   xmit_core(conn,data,len, xk_Const);
1628 }
1629 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1630
1631 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1632   XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1633   d->info.sm_art= ah;
1634 }
1635
1636 static void xmit_free(XmitDetails *d) {
1637   switch (d->kind) {
1638   case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1639   case xk_Const:                                  break;
1640   default: abort();
1641   }
1642 }
1643
1644 static void *conn_write_some_xmits(Conn *conn) {
1645   /* return values:
1646    *      0:            nothing more to write, no need to call us again
1647    *      OOP_CONTINUE: more to write but fd not writeable
1648    *      OOP_HALT:     disaster, have destroyed conn
1649    */
1650   for (;;) {
1651     int count= conn->xmitu;
1652     if (!count) return 0;
1653
1654     if (count > IOV_MAX) count= IOV_MAX;
1655     ssize_t rs= writev(conn->fd, conn->xmit, count);
1656     if (rs < 0) {
1657       if (isewouldblock(errno)) return OOP_CONTINUE;
1658       connfail(conn, "write failed: %s", strerror(errno));
1659       return OOP_HALT;
1660     }
1661     assert(rs > 0);
1662
1663     int done;
1664     for (done=0; rs && done<conn->xmitu; done++) {
1665       struct iovec *vp= &conn->xmit[done];
1666       XmitDetails *dp= &conn->xmitd[done];
1667       if (rs > vp->iov_len) {
1668         rs -= vp->iov_len;
1669         xmit_free(dp);
1670       } else {
1671         vp->iov_base= (char*)vp->iov_base + rs;
1672         vp->iov_len -= rs;
1673       }
1674     }
1675     int newu= conn->xmitu - done;
1676     memmove(conn->xmit,  conn->xmit  + done, newu * sizeof(*conn->xmit));
1677     memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1678     conn->xmitu= newu;
1679   }
1680 }
1681
1682 static void conn_make_some_xmits(Conn *conn) {
1683   for (;;) {
1684     if (conn->xmitu+5 > CONNIOVS)
1685       break;
1686
1687     Article *art= LIST_REMHEAD(conn->priority);
1688     if (!art) art= LIST_REMHEAD(conn->waiting);
1689     if (!art) break;
1690
1691     if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1692       /* actually send it */
1693
1694       ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1695
1696       art->state=
1697         art->state == art_Unchecked ? art_Unsolicited :
1698         art->state == art_Wanted    ? art_Wanted      :
1699         (abort(),-1);
1700
1701       if (!artdata) art->missing= 1;
1702       art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1703
1704       if (conn->stream) {
1705         if (artdata) {
1706           XMIT_LITERAL("TAKETHIS ");
1707           xmit_noalloc(conn, art->messageid, art->midlen);
1708           XMIT_LITERAL("\r\n");
1709           xmit_artbody(conn, artdata);
1710         } else {
1711           article_done(art, -1);
1712           continue;
1713         }
1714       } else {
1715         /* we got 235 from IHAVE */
1716         if (artdata) {
1717           xmit_artbody(conn, artdata);
1718         } else {
1719           XMIT_LITERAL(".\r\n");
1720         }
1721       }
1722
1723       LIST_ADDTAIL(conn->sent, art);
1724
1725     } else {
1726       /* check it */
1727
1728       if (conn->stream)
1729         XMIT_LITERAL("CHECK ");
1730       else
1731         XMIT_LITERAL("IHAVE ");
1732       xmit_noalloc(conn, art->messageid, art->midlen);
1733       XMIT_LITERAL("\r\n");
1734
1735       assert(art->state == art_Unchecked);
1736       art->ipf->counts[art->state][RC_sent]++;
1737       LIST_ADDTAIL(conn->sent, art);
1738     }
1739   }
1740 }
1741
1742 /*========== handling responses from peer ==========*/
1743
1744 static const oop_rd_style peer_rd_style= {
1745   OOP_RD_DELIM_STRIP, '\n',
1746   OOP_RD_NUL_FORBID,
1747   OOP_RD_SHORTREC_FORBID
1748 };
1749
1750 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1751                          const char *errmsg, int errnoval,
1752                          const char *data, size_t recsz, void *conn_v) {
1753   Conn *conn= conn_v;
1754   connfail(conn, "error receiving from peer: %s", errmsg);
1755   return OOP_CONTINUE;
1756 }
1757
1758 static Article *article_reply_check(Conn *conn, const char *response,
1759                                     int code_indicates_streaming,
1760                                     int must_have_sent
1761                                         /* 1:yes, -1:no, 0:dontcare */,
1762                                     const char *sanitised_response) {
1763   Article *art= LIST_HEAD(conn->sent);
1764
1765   if (!art) {
1766     connfail(conn,
1767              "peer gave unexpected response when no commands outstanding: %s",
1768              sanitised_response);
1769     return 0;
1770   }
1771
1772   if (code_indicates_streaming) {
1773     assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1774     if (!conn->stream) {
1775       connfail(conn, "peer gave streaming response code "
1776                " to IHAVE or subsequent body: %s", sanitised_response);
1777       return 0;
1778     }
1779     const char *got_mid= response+4;
1780     int got_midlen= strcspn(got_mid, " \n\r");
1781     if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1782       connfail(conn, "peer gave streaming response with syntactically invalid"
1783                " messageid: %s", sanitised_response);
1784       return 0;
1785     }
1786     if (got_midlen != art->midlen ||
1787         memcmp(got_mid, art->messageid, got_midlen)) {
1788       connfail(conn, "peer gave streaming response code to wrong article -"
1789                " probable synchronisation problem; we offered: %s;"
1790                " peer said: %s",
1791                art->messageid, sanitised_response);
1792       return 0;
1793     }
1794   } else {
1795     if (conn->stream) {
1796       connfail(conn, "peer gave non-streaming response code to"
1797                " CHECK/TAKETHIS: %s", sanitised_response);
1798       return 0;
1799     }
1800   }
1801
1802   if (must_have_sent>0 && art->state < art_Wanted) {
1803     connfail(conn, "peer says article accepted but"
1804              " we had not sent the body: %s", sanitised_response);
1805     return 0;
1806   }
1807   if (must_have_sent<0 && art->state >= art_Wanted) {
1808     connfail(conn, "peer says please sent the article but we just did: %s",
1809              sanitised_response);
1810     return 0;
1811   }
1812
1813   Article *art_again= LIST_REMHEAD(conn->sent);
1814   assert(art_again == art);
1815   return art;
1816 }
1817
1818 static void update_nocheck(int accepted) {
1819   accept_proportion *= nocheck_decay;
1820   accept_proportion += accepted * (1.0 - nocheck_decay);
1821   int new_nocheck= accept_proportion >= nocheck_thresh;
1822   if (new_nocheck && !nocheck_reported) {
1823     notice("entering nocheck mode for the first time");
1824     nocheck_reported= 1;
1825   } else if (new_nocheck != nocheck) {
1826     debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1827   }
1828   nocheck= new_nocheck;
1829 }
1830
1831 static void article_done(Article *art, int whichcount) {
1832   if (whichcount>=0 && !art->missing)
1833     art->ipf->counts[art->state][whichcount]++;
1834
1835   if (whichcount == RC_accepted) update_nocheck(1);
1836   else if (whichcount == RC_unwanted) update_nocheck(0);
1837
1838   InputFile *ipf= art->ipf;
1839
1840   while (art->blanklen) {
1841     static const char spaces[]=
1842       "                                                                "
1843       "                                                                "
1844       "                                                                "
1845       "                                                                "
1846       "                                                                "
1847       "                                                                "
1848       "                                                                "
1849       "                                                                "
1850       "                                                                ";
1851     int w= art->blanklen;  if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1852     int r= pwrite(ipf->fd, spaces, w, art->offset);
1853     if (r==-1) {
1854       if (errno==EINTR) continue;
1855       sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1856              art->messageid, art->blanklen,
1857              (unsigned long)art->offset, ipf->path);
1858     }
1859     assert(r>=0 && r<=w);
1860     art->blanklen -= w;
1861     art->offset += w;
1862   }
1863
1864   ipf->inprogress--;
1865   assert(ipf->inprogress >= 0);
1866   free(art);
1867
1868   if (!ipf->inprogress && ipf != main_input_file)
1869     queue_check_input_done();
1870 }
1871
1872 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1873                         const char *errmsg, int errnoval,
1874                         const char *data, size_t recsz, void *conn_v) {
1875   Conn *conn= conn_v;
1876
1877   if (ev == OOP_RD_EOF) {
1878     connfail(conn, "unexpected EOF from peer");
1879     return OOP_CONTINUE;
1880   }
1881   assert(ev == OOP_RD_OK);
1882
1883   char *sani= sanitise(data,-1);
1884
1885   char *ep;
1886   unsigned long code= strtoul(data, &ep, 10);
1887   if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1888     connfail(conn, "badly formatted response from peer: %s", sani);
1889     return OOP_CONTINUE;
1890   }
1891
1892   int conn_busy=
1893     conn->waiting.count ||
1894     conn->priority.count ||
1895     conn->sent.count ||
1896     conn->xmitu;
1897
1898   if (conn->quitting) {
1899     if (code!=205 && code!=503) {
1900       connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1901     } else {
1902       notice("C%d idle connection closed by us", conn->fd);
1903       assert(!conn_busy);
1904       LIST_REMOVE(conns,conn);
1905       conn_dispose(conn);
1906     }
1907     return OOP_CONTINUE;
1908   }
1909
1910   conn->since_activity= 0;
1911   Article *art;
1912
1913 #define GET_ARTICLE(musthavesent) do{                                         \
1914     art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1915     if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */      \
1916   }while(0) 
1917
1918 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{       \
1919     code_streaming= (streaming);                                \
1920     GET_ARTICLE(musthavesent);                                  \
1921     article_done(art, RC_##how);                                \
1922     goto dealtwith;                                             \
1923   }while(0)
1924
1925 #define PEERBADMSG(m) do {                                      \
1926     connfail(conn, m ": %s", sani);  return OOP_CONTINUE;       \
1927   }while(0)
1928
1929   int code_streaming= 0;
1930
1931   switch (code) {
1932
1933   default:  PEERBADMSG("peer sent unexpected message");
1934
1935   case 400:
1936     if (conn_busy)
1937       PEERBADMSG("peer timed us out or stopped accepting articles");
1938
1939     notice("C%d idle connection closed by peer", conn->fd);
1940     LIST_REMOVE(conns,conn);
1941     conn_dispose(conn);
1942     return OOP_CONTINUE;
1943
1944   case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1945   case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1946
1947   case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1948   case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1949
1950   case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1951   case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1952
1953   case 238: /* CHECK says send it */
1954     code_streaming= 1;
1955   case 335: /* IHAVE says send it */
1956     GET_ARTICLE(-1);
1957     assert(art->state == art_Unchecked);
1958     art->ipf->counts[art->state][RC_accepted]++;
1959     art->state= art_Wanted;
1960     LIST_ADDTAIL(conn->priority, art);
1961     break;
1962
1963   case 431: /* CHECK or TAKETHIS says try later */
1964     code_streaming= 1;
1965   case 436: /* IHAVE says try later */
1966     GET_ARTICLE(0);
1967     article_defer(art, RC_deferred);
1968     break;
1969
1970   }
1971 dealtwith:
1972
1973   conn_maybe_write(conn);
1974   check_assign_articles();
1975   return OOP_CONTINUE;
1976 }
1977
1978
1979 /*========== monitoring of input files ==========*/
1980
1981 static void feedfile_eof(InputFile *ipf) {
1982   assert(ipf != main_input_file); /* promised by tailing_try_read */
1983   inputfile_reading_stop(ipf);
1984
1985   if (ipf == flushing_input_file) {
1986     assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1987     if (main_input_file) inputfile_reading_start(main_input_file);
1988     statemc_check_flushing_done();
1989   } else if (ipf == backlog_input_file) {
1990     statemc_check_backlog_done();
1991   } else {
1992     abort(); /* supposed to wait rather than get EOF on main input file */
1993   }
1994 }
1995
1996 static InputFile *open_input_file(const char *path) {
1997   int fd= open(path, O_RDWR);
1998   if (fd<0) {
1999     if (errno==ENOENT) return 0;
2000     sysfatal("unable to open input file %s", path);
2001   }
2002   assert(fd>0);
2003
2004   InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2005   memset(ipf,0,sizeof(*ipf));
2006
2007   ipf->fd= fd;
2008   ipf->autodefer= -1;
2009   LIST_INIT(ipf->queue);
2010   strcpy(ipf->path, path);
2011
2012   return ipf;
2013 }
2014
2015 static void close_input_file(InputFile *ipf) { /* does not free */
2016   assert(!ipf->readable_callback); /* must have had ->on_cancel */
2017   assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2018   assert(!ipf->rd); /* must have had inputfile_reading_stop */
2019   assert(!ipf->inprogress); /* no dangling pointers pointing here */
2020   xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2021 }
2022
2023
2024 /*---------- dealing with articles read in the input file ----------*/
2025
2026 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2027                                    const char *data, const char *how) {
2028   warn("corrupted file: %s, offset %lu: %s: in %s",
2029        ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2030   ipf->readcount_err++;
2031   if (ipf->readcount_err > max_bad_data_initial +
2032       (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2033     die("too much garbage in input file!  (%d errs, %d ok, %d blank)",
2034         ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2035   return OOP_CONTINUE;
2036 }
2037
2038 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2039                                oop_rd_event ev, const char *errmsg,
2040                                int errnoval, const char *data, size_t recsz,
2041                                void *ipf_v) {
2042   InputFile *ipf= ipf_v;
2043   assert(ev == OOP_RD_SYSTEM);
2044   errno= errnoval;
2045   sysdie("error reading input file: %s, offset %lu",
2046          ipf->path, (unsigned long)ipf->offset);
2047 }
2048
2049 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2050                                   oop_rd_event ev, const char *errmsg,
2051                                   int errnoval, const char *data, size_t recsz,
2052                                   void *ipf_v) {
2053   InputFile *ipf= ipf_v;
2054   Article *art;
2055   char tokentextbuf[sizeof(TOKEN)*2+3];
2056
2057   if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2058
2059   off_t old_offset= ipf->offset;
2060   ipf->offset += recsz + !!(ev == OOP_RD_OK);
2061
2062 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2063
2064   if (ev==OOP_RD_PARTREC)
2065     feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2066     /* but process it anyway */
2067
2068   if (ipf->skippinglong) {
2069     if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2070     return OOP_CONTINUE;
2071   }
2072   if (ev==OOP_RD_LONG) {
2073     ipf->skippinglong= 1;
2074     X_BAD_DATA("overly long line");
2075   }
2076
2077   if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2078   if (!recsz) X_BAD_DATA("empty line");
2079
2080   if (data[0]==' ') {
2081     if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2082     ipf->readcount_blank++;
2083     return OOP_CONTINUE;
2084   }
2085
2086   char *space= strchr(data,' ');
2087   int tokenlen= space-data;
2088   int midlen= (int)recsz-tokenlen-1;
2089   if (midlen <= 2) X_BAD_DATA("no room for messageid");
2090   if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2091
2092   if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2093   memcpy(tokentextbuf, data, tokenlen);
2094   tokentextbuf[tokenlen]= 0;
2095   if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2096
2097   ipf->readcount_ok++;
2098
2099   art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2100   memset(art,0,sizeof(*art));
2101   art->state= art_Unchecked;
2102   art->midlen= midlen;
2103   art->ipf= ipf;  ipf->inprogress++;
2104   art->token= TextToToken(tokentextbuf);
2105   art->offset= old_offset;
2106   art->blanklen= recsz;
2107   strcpy(art->messageid, space+1);
2108   LIST_ADDTAIL(ipf->queue, art);
2109
2110   if (ipf->autodefer >= 0)
2111     article_autodefer(ipf, art);
2112   else if (ipf==backlog_input_file)
2113     article_check_expired(art);
2114
2115   if (sms==sm_NORMAL && ipf==main_input_file &&
2116       ipf->offset >= target_max_feedfile_size)
2117     statemc_start_flush("feed file size");
2118
2119   check_assign_articles(); /* may destroy conn but that's OK */
2120   check_reading_pause_resume(ipf);
2121   return OOP_CONTINUE;
2122 }
2123
2124 /*========== tailing input file ==========*/
2125
2126 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2127                                      void *user) {
2128   InputFile *ipf= user;
2129   return ipf->readable_callback(loop, &ipf->readable,
2130                                 ipf->readable_callback_user);
2131 }
2132
2133 static void tailing_on_cancel(struct oop_readable *rable) {
2134   InputFile *ipf= (void*)rable;
2135
2136   if (ipf->filemon) filemon_stop(ipf);
2137   loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2138   ipf->readable_callback= 0;
2139 }
2140
2141 static void tailing_queue_readable(InputFile *ipf) {
2142   /* lifetime of ipf here is OK because destruction will cause
2143    * on_cancel which will cancel this callback */
2144   loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2145 }
2146
2147 static int tailing_on_readable(struct oop_readable *rable,
2148                                 oop_readable_call *cb, void *user) {
2149   InputFile *ipf= (void*)rable;
2150
2151   tailing_on_cancel(rable);
2152   ipf->readable_callback= cb;
2153   ipf->readable_callback_user= user;
2154   filemon_start(ipf);
2155
2156   tailing_queue_readable(ipf);
2157   return 0;
2158 }
2159
2160 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2161                                 size_t length) {
2162   InputFile *ipf= (void*)rable;
2163   for (;;) {
2164     ssize_t r= read(ipf->fd, buffer, length);
2165     if (r==-1) {
2166       if (errno==EINTR) continue;
2167       return r;
2168     }
2169     if (!r) {
2170       if (ipf==main_input_file) {
2171         errno=EAGAIN;
2172         return -1;
2173       } else if (ipf==flushing_input_file) {
2174         assert(ipf->rd);
2175         assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2176       } else if (ipf==backlog_input_file) {
2177         assert(ipf->rd);
2178       } else {
2179         abort();
2180       }
2181     }
2182     tailing_queue_readable(ipf);
2183     return r;
2184   }
2185 }
2186
2187 /*---------- filemon implemented with inotify ----------*/
2188
2189 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2190 #define HAVE_FILEMON
2191
2192 #include <sys/inotify.h>
2193
2194 static int filemon_inotify_fd;
2195 static int filemon_inotify_wdmax;
2196 static InputFile **filemon_inotify_wd2ipf;
2197
2198 struct Filemon_Perfile {
2199   int wd;
2200 };
2201
2202 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2203   int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2204   if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2205
2206   if (wd >= filemon_inotify_wdmax) {
2207     int newmax= wd+2;
2208     filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2209                                  sizeof(*filemon_inotify_wd2ipf) * newmax);
2210     memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2211            sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2212     filemon_inotify_wdmax= newmax;
2213   }
2214
2215   assert(!filemon_inotify_wd2ipf[wd]);
2216   filemon_inotify_wd2ipf[wd]= ipf;
2217
2218   debug("filemon inotify startfile %p wd=%d wdmax=%d",
2219         ipf, wd, filemon_inotify_wdmax);
2220
2221   pf->wd= wd;
2222 }
2223
2224 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2225   int wd= pf->wd;
2226   debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2227   int r= inotify_rm_watch(filemon_inotify_fd, wd);
2228   if (r) sysdie("inotify_rm_watch");
2229   filemon_inotify_wd2ipf[wd]= 0;
2230 }
2231
2232 static void *filemon_inotify_readable(oop_source *lp, int fd,
2233                                       oop_event e, void *u) {
2234   struct inotify_event iev;
2235   for (;;) {
2236     int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2237     if (r==-1) {
2238       if (isewouldblock(errno)) break;
2239       sysdie("read from inotify master");
2240     } else if (r==sizeof(iev)) {
2241       assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2242     } else {
2243       die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2244     }
2245     InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2246     /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2247     filemon_callback(ipf);
2248   }
2249   return OOP_CONTINUE;
2250 }
2251
2252 static int filemon_method_init(void) {
2253   filemon_inotify_fd= inotify_init();
2254   if (filemon_inotify_fd<0) {
2255     syswarn("filemon/inotify: inotify_init failed");
2256     return 0;
2257   }
2258   xsetnonblock(filemon_inotify_fd, 1);
2259   loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2260
2261   debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2262   return 1;
2263 }
2264
2265 static void filemon_method_dump_info(FILE *f) {
2266   int i;
2267   fprintf(f,"inotify");
2268   DUMPV("%d",,filemon_inotify_fd);
2269   DUMPV("%d",,filemon_inotify_wdmax);
2270   for (i=0; i<filemon_inotify_wdmax; i++)
2271     fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2272 }
2273
2274 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2275
2276 /*---------- filemon dummy implementation ----------*/
2277
2278 #if !defined(HAVE_FILEMON)
2279
2280 struct Filemon_Perfile { int dummy; };
2281
2282 static int filemon_method_init(void) {
2283   warn("filemon/dummy: no filemon method compiled in");
2284   return 0;
2285 }
2286 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2287 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2288 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2289
2290 #endif /* !HAVE_FILEMON */
2291
2292 /*---------- filemon generic interface ----------*/
2293
2294 static void filemon_start(InputFile *ipf) {
2295   assert(!ipf->filemon);
2296
2297   NEW(ipf->filemon);
2298   filemon_method_startfile(ipf, ipf->filemon);
2299 }
2300
2301 static void filemon_stop(InputFile *ipf) {
2302   if (!ipf->filemon) return;
2303   filemon_method_stopfile(ipf, ipf->filemon);
2304   free(ipf->filemon);
2305   ipf->filemon= 0;
2306 }
2307
2308 static void filemon_callback(InputFile *ipf) {
2309   if (ipf && ipf->readable_callback) /* so filepoll() can be naive */
2310     ipf->readable_callback(loop, &ipf->readable, ipf->readable_callback_user);
2311 }
2312
2313 /*---------- interface to start and stop an input file ----------*/
2314
2315 static const oop_rd_style feedfile_rdstyle= {
2316   OOP_RD_DELIM_STRIP, '\n',
2317   OOP_RD_NUL_PERMIT,
2318   OOP_RD_SHORTREC_LONG,
2319 };
2320
2321 static void inputfile_reading_resume(InputFile *ipf) {
2322   if (!ipf->rd) return;
2323   if (!ipf->paused) return;
2324
2325   int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2326                      feedfile_got_article,ipf, feedfile_read_err, ipf);
2327   if (r) sysdie("unable start reading feedfile %s",ipf->path);
2328
2329   ipf->paused= 0;
2330 }
2331
2332 static void inputfile_reading_pause(InputFile *ipf) {
2333   if (!ipf->rd) return;
2334   if (ipf->paused) return;
2335   oop_rd_cancel(ipf->rd);
2336   ipf->paused= 1;
2337 }
2338
2339 static void inputfile_reading_start(InputFile *ipf) {
2340   assert(!ipf->rd);
2341   ipf->readable.on_readable= tailing_on_readable;
2342   ipf->readable.on_cancel=   tailing_on_cancel;
2343   ipf->readable.try_read=    tailing_try_read;
2344   ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2345   ipf->readable.delete_kill= 0;
2346
2347   ipf->readable_callback= 0;
2348   ipf->readable_callback_user= 0;
2349
2350   ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2351   assert(ipf->rd);
2352
2353   ipf->paused= 1;
2354   inputfile_reading_resume(ipf);
2355 }
2356
2357 static void inputfile_reading_stop(InputFile *ipf) {
2358   assert(ipf->rd);
2359   inputfile_reading_pause(ipf);
2360   oop_rd_delete(ipf->rd);
2361   ipf->rd= 0;
2362   assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2363 }
2364
2365
2366 /*========== interaction with innd - state machine ==========*/
2367
2368 /* See official state diagram at top of file.  We implement
2369  * this as follows:
2370  * -8<-
2371
2372             .=======.
2373             ||START||
2374             `======='
2375                 |
2376                 | open F
2377                 |
2378                 |    F ENOENT
2379                 |`---------------------------------------------------.
2380       F OPEN OK |                                                    |
2381                 |`---------------- - - -                             |
2382        D ENOENT |       D EXISTS   see OVERALL STATES diagram        |
2383                 |                  for full startup logic            |
2384      ,--------->|                                                    |
2385      |          V                                                    |
2386      |     ============                                       try to |
2387      |      NORMAL                                            open D |
2388      |     [Normal]                                                  |
2389      |      main F tail                                              |
2390      |     ============                                              V
2391      |          |                                                    |
2392      |          | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT            |
2393      ^          | hardlink F to D                                    |
2394      |     [Hardlinked]                                              |
2395      |          | unlink F                                           |
2396      |          | our handle onto F is now onto D                    |
2397      |     [Moved]                                                   |
2398      |          |                                                    |
2399      |          |<-------------------<---------------------<---------+
2400      |          |                                                    |
2401      |          | spawn inndcomm flush                               |
2402      |          V                                                    |
2403      |     ==================                                        |
2404      |      FLUSHING[-ABSENT]                                        |
2405      |     [Flushing]                                                |
2406      |     main D tail/none                                          |
2407      |     ==================                                        |
2408      |          |                                                    |
2409      |          |   INNDCOMM FLUSH FAILS                             ^
2410      |          |`----------------------->----------.                |
2411      |          |                                   |                |
2412      |          |   NO SUCH SITE                    V                |
2413      ^          |`--------------->----.         ==================== |
2414      |          |                      \        FLUSHFAILED[-ABSENT] |
2415      |          |                       \         [Moved]            |
2416      |          | FLUSH OK               \       main D tail/none    |
2417      |          | open F                  \     ==================== |
2418      |          |                          \        |                |
2419      |          |                           \       | TIME TO RETRY  |
2420      |          |`------->----.     ,---<---'\      `----------------'
2421      |          |    D NONE   |     | D NONE  `----.
2422      |          V             |     |              V
2423      |     =============      V     V             ============
2424      |      SEPARATED-1       |     |              DROPPING-1
2425      |      flsh->rd!=0       |     |              flsh->rd!=0
2426      |     [Separated]        |     |             [Dropping]
2427      |      main F idle       |     |              main none
2428      |      flsh D tail       |     |              flsh D tail
2429      |     =============      |     |             ============
2430      |          |             |     | install       |
2431      ^          | EOF ON D    |     |  defer        | EOF ON D
2432      |          V             |     |               V
2433      |     ===============    |     |             ===============
2434      |      SEPARATED-2       |     |              DROPPING-2
2435      |      flsh->rd==0       |     V              flsh->rd==0
2436      |     [Finishing]        |     |             [Dropping]
2437      |      main F tail       |     `.             main none
2438      |      flsh D closed     |       `.           flsh D closed
2439      |     ===============    V         `.        ===============
2440      |          |                         `.          |
2441      |          | ALL D PROCESSED           `.        | ALL D PROCESSED
2442      |          V install defer as backlog    `.      | install defer
2443      ^          | close D                       `.    | close D
2444      |          | unlink D                        `.  | unlink D
2445      |          |                                  |  |
2446      |          |                                  V  V
2447      `----------'                               ==============
2448                                                  DROPPED
2449                                                 [Dropped]
2450                                                  main none
2451                                                  flsh none
2452                                                  some backlog
2453                                                 ==============
2454                                                       |
2455                                                       | ALL BACKLOG DONE
2456                                                       |
2457                                                       | unlink lock
2458                                                       | exit
2459                                                       V
2460                                                   ==========
2461                                                    (ESRCH)
2462                                                   [Droppped]
2463                                                   ==========
2464  * ->8-
2465  */
2466
2467 static void startup_set_input_file(InputFile *f) {
2468   assert(!main_input_file);
2469   main_input_file= f;
2470   inputfile_reading_start(f);
2471 }
2472
2473 static void statemc_lock(void) {
2474   int lockfd;
2475   struct stat stab, stabf;
2476   
2477   for (;;) {
2478     lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2479     if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2480
2481     struct flock fl;
2482     memset(&fl,0,sizeof(fl));
2483     fl.l_type= F_WRLCK;
2484     fl.l_whence= SEEK_SET;
2485     int r= fcntl(lockfd, F_SETLK, &fl);
2486     if (r==-1) {
2487       if (errno==EACCES || isewouldblock(errno)) {
2488         if (quiet_multiple) exit(0);
2489         fatal("another duct holds the lockfile");
2490       }
2491       sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2492     }
2493
2494     xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2495     int lock_noent;
2496     xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2497
2498     if (!lock_noent && samefile(&stab, &stabf))
2499       break;
2500
2501     xclose(lockfd, "stale lockfile ", path_lock);
2502   }
2503
2504   FILE *lockfile= fdopen(lockfd, "w");
2505   if (!lockfile) sysdie("fdopen lockfile");
2506
2507   int r= ftruncate(lockfd, 0);
2508   if (r) sysdie("truncate lockfile to write new info");
2509
2510   if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2511               (unsigned long)self_pid,
2512               sitename, feedfile, remote_host) == EOF ||
2513       fflush(lockfile))
2514     sysfatal("write info to lockfile %s", path_lock);
2515
2516   debug("startup: locked");
2517 }
2518
2519 static void statemc_init(void) {
2520   struct stat stabdefer;
2521
2522   search_backlog_file();
2523
2524   int defer_noent;
2525   xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2526   if (defer_noent) {
2527     debug("startup: ductdefer ENOENT");
2528   } else {
2529     debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2530     switch (stabdefer.st_nlink==1) {
2531     case 1:
2532       open_defer(); /* so that we will later close it and rename it */
2533       break;
2534     case 2:
2535       xunlink(path_defer, "stale defer file link"
2536               " (presumably hardlink to backlog file)");
2537       break;
2538     default:
2539       die("defer file %s has unexpected link count %d",
2540           path_defer, stabdefer.st_nlink);
2541     }
2542   }
2543
2544   struct stat stab_f, stab_d;
2545   int noent_f;
2546
2547   InputFile *file_d= open_input_file(path_flushing);
2548   if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2549
2550   xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2551
2552   if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2553     debug("startup: F==D => Hardlinked");
2554     xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2555     noent_f= 1;
2556   }
2557
2558   if (noent_f) {
2559     debug("startup: F ENOENT => Moved");
2560     if (file_d) startup_set_input_file(file_d);
2561     spawn_inndcomm_flush("feedfile missing at startup");
2562     /* => Flushing, sms:=FLUSHING */
2563   } else {
2564     if (file_d) {
2565       debug("startup: F!=D => Separated");
2566       startup_set_input_file(file_d);
2567       flushing_input_file= main_input_file;
2568       main_input_file= open_input_file(feedfile);
2569       if (!main_input_file) die("feedfile vanished during startup");
2570       SMS(SEPARATED, max_separated_periods,
2571           "found both old and current feed files");
2572     } else {
2573       debug("startup: F exists, D ENOENT => Normal");
2574       InputFile *file_f= open_input_file(feedfile);
2575       if (!file_f) die("feed file vanished during startup");
2576       startup_set_input_file(file_f);
2577       SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2578     }
2579   }
2580 }
2581
2582 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2583   assert(sms == sm_NORMAL);
2584
2585   debug("starting flush (%s) (%lu >?= %lu) (%d)",
2586         why,
2587         (unsigned long)(main_input_file ? main_input_file->offset : 0),
2588         (unsigned long)target_max_feedfile_size,
2589         until_flush);
2590
2591   int r= link(feedfile, path_flushing);
2592   if (r) sysfatal("link feedfile %s to flushing file %s",
2593                   feedfile, path_flushing);
2594   /* => Hardlinked */
2595
2596   xunlink(feedfile, "old feedfile link");
2597   /* => Moved */
2598
2599   spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2600 }
2601
2602 static int trigger_flush_ok(const char *why) {
2603   switch (sms) {
2604
2605   case sm_NORMAL:
2606     statemc_start_flush(why ? why : "periodic");
2607     return 1;                           /* Normal => Flushing; => FLUSHING */
2608
2609   case sm_FLUSHFAILED:
2610     spawn_inndcomm_flush(why ? why : "retry");
2611     return 1;                            /* Moved => Flushing; => FLUSHING */
2612
2613   case sm_SEPARATED:
2614   case sm_DROPPING:
2615     warn("abandoning old feedfile after flush (%s), autodeferring",
2616          why ? why : "took too long to complete");
2617     assert(flushing_input_file);
2618     autodefer_input_file(flushing_input_file);
2619     return 1;
2620
2621   default:
2622     return 0;
2623   }
2624 }
2625
2626 static void statemc_period_poll(void) {
2627   if (!until_flush) return;
2628   until_flush--;
2629   assert(until_flush>=0);
2630
2631   if (until_flush) return;
2632   int ok= trigger_flush_ok(0);
2633   assert(ok);
2634 }
2635
2636 static int inputfile_is_done(InputFile *ipf) {
2637   if (!ipf) return 0;
2638   if (ipf->inprogress) return 0; /* new article in the meantime */
2639   if (ipf->rd) return 0; /* not had EOF */
2640   return 1;
2641 }
2642
2643 static void notice_processed(InputFile *ipf, int completed,
2644                              const char *what, const char *spec) {
2645   if (!ipf) return; /* allows preterminate to be lazy */
2646
2647 #define RCI_NOTHING(x) /* nothing */
2648 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2649 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2650
2651 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2652
2653   char *inprog= completed
2654     ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2655     : xasprintf(" inprogress=%ld", ipf->inprogress);
2656   char *autodefer= ipf->autodefer >= 0
2657     ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2658     : xasprintf("%s","");
2659
2660   info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2661        " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2662        RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2663        ,
2664        completed?"completed":"processed", what, spec,
2665        ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2666        inprog, autodefer, ipf->count_nooffer_missing,
2667        CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2668        , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2669        CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2670        , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2671        RESULT_COUNTS(RCI_NOTHING,  RCI_TRIPLE_VALS)
2672        );
2673
2674   free(inprog);
2675   free(autodefer);
2676
2677 #undef CNT
2678 }
2679
2680 static void statemc_check_backlog_done(void) {
2681   InputFile *ipf= backlog_input_file;
2682   if (!inputfile_is_done(ipf)) return;
2683
2684   const char *slash= strrchr(ipf->path, '/');
2685   const char *leaf= slash ? slash+1 : ipf->path;
2686   const char *under= strchr(slash, '_');
2687   const char *rest= under ? under+1 : leaf;
2688   if (!strncmp(rest,"backlog",7)) rest += 7;
2689   notice_processed(ipf,1,"backlog ",rest);
2690
2691   close_input_file(ipf);
2692   if (unlink(ipf->path)) {
2693     if (errno != ENOENT)
2694       sysdie("could not unlink processed backlog file %s", ipf->path);
2695     warn("backlog file %s vanished while we were reading it"
2696          " so we couldn't remove it (but it's done now, anyway)",
2697          ipf->path);
2698   }
2699   free(ipf);
2700   backlog_input_file= 0;
2701   search_backlog_file();
2702   return;
2703 }
2704
2705 static void statemc_check_flushing_done(void) {
2706   InputFile *ipf= flushing_input_file;
2707   if (!inputfile_is_done(ipf)) return;
2708
2709   assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2710
2711   notice_processed(ipf,1,"feedfile","");
2712
2713   close_defer();
2714
2715   xunlink(path_flushing, "old flushing file");
2716
2717   close_input_file(flushing_input_file);
2718   free(flushing_input_file);
2719   flushing_input_file= 0;
2720
2721   if (sms==sm_SEPARATED) {
2722     notice("flush complete");
2723     SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2724   } else if (sms==sm_DROPPING) {
2725     SMS(DROPPED, max_separated_periods, "old flush complete");
2726     search_backlog_file();
2727     notice("feed dropped, but will continue until backlog is finished");
2728   }
2729 }
2730
2731 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2732                                       void *u) {
2733   assert(!inputfile_is_done(main_input_file));
2734   statemc_check_flushing_done();
2735   statemc_check_backlog_done();
2736   return OOP_CONTINUE;
2737 }
2738
2739 static void queue_check_input_done(void) {
2740   loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2741 }
2742
2743 static void statemc_setstate(StateMachineState newsms, int periods,
2744                              const char *forlog, const char *why) {
2745   sms= newsms;
2746   until_flush= periods;
2747
2748   const char *xtra= "";
2749   switch (sms) {
2750   case sm_FLUSHING:
2751   case sm_FLUSHFAILED:
2752     if (!main_input_file) xtra= "-ABSENT";
2753     break;
2754   case sm_SEPARATED:
2755   case sm_DROPPING:
2756     xtra= flushing_input_file->rd ? "-1" : "-2";
2757     break;
2758   default:;
2759   }
2760
2761   if (periods) {
2762     info("state %s%s[%d] %s",forlog,xtra,periods,why);
2763   } else {
2764     info("state %s%s %s",forlog,xtra,why);
2765   }
2766 }
2767
2768 /*---------- defer and backlog files ----------*/
2769
2770 static void open_defer(void) {
2771   struct stat stab;
2772
2773   if (defer) return;
2774
2775   defer= fopen(path_defer, "a+");
2776   if (!defer) sysfatal("could not open defer file %s", path_defer);
2777
2778   /* truncate away any half-written records */
2779
2780   xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2781
2782   if (stab.st_size > LONG_MAX)
2783     die("defer file %s size is far too large", path_defer);
2784
2785   if (!stab.st_size)
2786     return;
2787
2788   long orgsize= stab.st_size;
2789   long truncto= stab.st_size;
2790   for (;;) {
2791     if (!truncto) break; /* was only (if anything) one half-truncated record */
2792     if (fseek(defer, truncto-1, SEEK_SET) < 0)
2793       sysdie("seek in defer file %s while truncating partial", path_defer);
2794
2795     int r= getc(defer);
2796     if (r==EOF) {
2797       if (ferror(defer))
2798         sysdie("failed read from defer file %s", path_defer);
2799       else
2800         die("defer file %s shrank while we were checking it!", path_defer);
2801     }
2802     if (r=='\n') break;
2803     truncto--;
2804   }
2805
2806   if (stab.st_size != truncto) {
2807     warn("truncating half-record at end of defer file %s -"
2808          " shrinking by %ld bytes from %ld to %ld",
2809          path_defer, orgsize - truncto, orgsize, truncto);
2810
2811     if (fflush(defer))
2812       sysfatal("could not flush defer file %s", path_defer);
2813     if (ftruncate(fileno(defer), truncto))
2814       sysdie("could not truncate defer file %s", path_defer);
2815
2816   } else {
2817     info("continuing existing defer file %s (%ld bytes)",
2818          path_defer, orgsize);
2819   }
2820   if (fseek(defer, truncto, SEEK_SET))
2821     sysdie("could not seek to new end of defer file %s", path_defer);
2822 }
2823
2824 static void close_defer(void) {
2825   if (!defer)
2826     return;
2827
2828   struct stat stab;
2829   xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2830
2831   if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2832   defer= 0;
2833
2834   time_t now= xtime();
2835
2836   char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2837                            (unsigned long)now,
2838                            (unsigned long)stab.st_ino);
2839   if (link(path_defer, backlog))
2840     sysfatal("could not install defer file %s as backlog file %s",
2841            path_defer, backlog);
2842   if (unlink(path_defer))
2843     sysdie("could not unlink old defer link %s to backlog file %s",
2844            path_defer, backlog);
2845
2846   free(backlog);
2847
2848   if (until_backlog_nextscan < 0 ||
2849       until_backlog_nextscan > backlog_retry_minperiods + 1)
2850     until_backlog_nextscan= backlog_retry_minperiods + 1;
2851 }
2852
2853 static void poll_backlog_file(void) {
2854   if (until_backlog_nextscan < 0) return;
2855   if (until_backlog_nextscan-- > 0) return;
2856   search_backlog_file();
2857 }
2858
2859 static void search_backlog_file(void) {
2860   /* returns non-0 iff there are any backlog files */
2861
2862   glob_t gl;
2863   int r, i;
2864   struct stat stab;
2865   const char *oldest_path=0;
2866   time_t oldest_mtime=0, now;
2867
2868   if (backlog_input_file) return;
2869
2870  try_again:
2871
2872   r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2873
2874   switch (r) {
2875   case GLOB_ABORTED:
2876     sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2877   case GLOB_NOSPACE:
2878     fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2879   case 0:
2880     for (i=0; i<gl.gl_pathc; i++) {
2881       const char *path= gl.gl_pathv[i];
2882
2883       if (strchr(path,'#') || strchr(path,'~')) {
2884         debug("backlog file search skipping %s", path);
2885         continue;
2886       }
2887       r= stat(path, &stab);
2888       if (r) {
2889         syswarn("failed to stat backlog file %s", path);
2890         continue;
2891       }
2892       if (!S_ISREG(stab.st_mode)) {
2893         warn("backlog file %s is not a plain file (or link to one)", path);
2894         continue;
2895       }
2896       if (!oldest_path || stab.st_mtime < oldest_mtime) {
2897         oldest_path= path;
2898         oldest_mtime= stab.st_mtime;
2899       }
2900     }
2901   case GLOB_NOMATCH: /* fall through */
2902     break;
2903   default:
2904     sysdie("glob expansion of backlog pattern %s gave unexpected"
2905            " nonzero (error?) return value %d", globpat_backlog, r);
2906   }
2907
2908   if (!oldest_path) {
2909     debug("backlog scan: none");
2910
2911     if (sms==sm_DROPPED) {
2912       preterminate();
2913       notice("feed dropped and our work is complete");
2914
2915       int r= unlink(path_cli);
2916       if (r && errno!=ENOENT)
2917         syswarn("failed to unlink cli socket for old feed");
2918
2919       xunlink(path_lock, "lockfile for old feed");
2920       exit(4);
2921     }
2922     until_backlog_nextscan= backlog_spontrescan_periods;
2923     goto xfree;
2924   }
2925
2926   now= xtime();
2927   double age= difftime(now, oldest_mtime);
2928   long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2929
2930   if (age_deficiency <= 0) {
2931     debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2932           age, age_deficiency, oldest_path);
2933
2934     backlog_input_file= open_input_file(oldest_path);
2935     if (!backlog_input_file) {
2936       warn("backlog file %s vanished as we opened it", oldest_path);
2937       globfree(&gl);
2938       goto try_again;
2939     }
2940     inputfile_reading_start(backlog_input_file);
2941     until_backlog_nextscan= -1;
2942     goto xfree;
2943   }
2944
2945   until_backlog_nextscan= age_deficiency / period_seconds;
2946
2947   if (backlog_spontrescan_periods >= 0 &&
2948       until_backlog_nextscan > backlog_spontrescan_periods)
2949     until_backlog_nextscan= backlog_spontrescan_periods;
2950
2951   debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2952         age, age_deficiency, until_backlog_nextscan, oldest_path);
2953
2954  xfree:
2955   globfree(&gl);
2956   return;
2957 }
2958
2959 /*---------- shutdown and signal handling ----------*/
2960
2961 static void preterminate(void) {
2962   if (in_child) return;
2963   notice_processed(main_input_file,0,"feedfile","");
2964   notice_processed(flushing_input_file,0,"flushing","");
2965   if (backlog_input_file)
2966     notice_processed(backlog_input_file,0, "backlog file ",
2967                      backlog_input_file->path);
2968 }
2969
2970 static int signal_self_pipe[2];
2971 static sig_atomic_t terminate_sig_flag;
2972
2973 static void raise_default(int signo) {
2974   xsigsetdefault(signo);
2975   raise(signo);
2976   abort();
2977 }
2978
2979 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
2980   assert(fd=signal_self_pipe[0]);
2981   char buf[PIPE_BUF];
2982   int r= read(signal_self_pipe[0], buf, sizeof(buf));
2983   if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
2984   if (r==0) die("eof on signal self pipe");
2985   if (terminate_sig_flag) {
2986     preterminate();
2987     notice("terminating (%s)", strsignal(terminate_sig_flag));
2988     raise_default(terminate_sig_flag);
2989   }
2990   return OOP_CONTINUE;
2991 }
2992
2993 static void sigarrived_handler(int signum) {
2994   static char x;
2995   switch (signum) {
2996   case SIGTERM:
2997   case SIGINT:
2998     if (!terminate_sig_flag) terminate_sig_flag= signum;
2999     break;
3000   default:
3001     abort();
3002   }
3003   write(signal_self_pipe[1],&x,1);
3004 }
3005
3006 static void init_signals(void) {
3007   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3008     sysdie("could not ignore SIGPIPE");
3009
3010   if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3011
3012   xsetnonblock(signal_self_pipe[0],1);
3013   xsetnonblock(signal_self_pipe[1],1);
3014
3015   struct sigaction sa;
3016   memset(&sa,0,sizeof(sa));
3017   sa.sa_handler= sigarrived_handler;
3018   sa.sa_flags= SA_RESTART;
3019   xsigaction(SIGTERM,&sa);
3020   xsigaction(SIGINT,&sa);
3021
3022   on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3023 }
3024
3025 /*========== flushing the feed ==========*/
3026
3027 static pid_t inndcomm_child;
3028 static int inndcomm_sentinel_fd;
3029
3030 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3031   assert(inndcomm_child);
3032   assert(fd == inndcomm_sentinel_fd);
3033   int status= xwaitpid(&inndcomm_child, "inndcomm");
3034   inndcomm_child= 0;
3035   
3036   cancel_fd_read_except(fd);
3037   xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3038   inndcomm_sentinel_fd= 0;
3039
3040   assert(!flushing_input_file);
3041
3042   if (WIFEXITED(status)) {
3043     switch (WEXITSTATUS(status)) {
3044
3045     case INNDCOMMCHILD_ESTATUS_FAIL:
3046       goto failed;
3047
3048     case INNDCOMMCHILD_ESTATUS_NONESUCH:
3049       notice("feed has been dropped by innd, finishing up");
3050       flushing_input_file= main_input_file;
3051       tailing_queue_readable(flushing_input_file);
3052         /* we probably previously returned EAGAIN from our fake read method
3053          * when in fact we were at EOF, so signal another readable event
3054          * so we actually see the EOF */
3055
3056       main_input_file= 0;
3057
3058       if (flushing_input_file) {
3059         SMS(DROPPING, max_separated_periods,
3060             "feed dropped by innd, but must finish last flush");
3061       } else {
3062         close_defer();
3063         SMS(DROPPED, 0, "feed dropped by innd");
3064         search_backlog_file();
3065       }
3066       return OOP_CONTINUE;
3067
3068     case 0:
3069       /* as above */
3070       flushing_input_file= main_input_file;
3071       tailing_queue_readable(flushing_input_file);
3072
3073       main_input_file= open_input_file(feedfile);
3074       if (!main_input_file)
3075         die("flush succeeded but feedfile %s does not exist!", feedfile);
3076
3077       if (flushing_input_file) {
3078         SMS(SEPARATED, max_separated_periods, "recovery flush complete");
3079       } else {
3080         close_defer();
3081         SMS(NORMAL, spontaneous_flush_periods, "flush complete");
3082       }
3083       return OOP_CONTINUE;
3084
3085     default:
3086       goto unexpected_exitstatus;
3087
3088     }
3089   } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3090     warn("flush timed out trying to talk to innd");
3091     goto failed;
3092   } else {
3093   unexpected_exitstatus:
3094     report_child_status("inndcomm child", status);
3095   }
3096
3097  failed:
3098   SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3099   return OOP_CONTINUE;
3100 }
3101
3102 static void inndcommfail(const char *what) {
3103   syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3104   exit(INNDCOMMCHILD_ESTATUS_FAIL);
3105 }
3106
3107 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3108   int pipefds[2];
3109
3110   notice("flushing %s",why);
3111
3112   assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3113   assert(!inndcomm_child);
3114   assert(!inndcomm_sentinel_fd);
3115
3116   if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3117
3118   inndcomm_child= xfork("inndcomm child");
3119
3120   if (!inndcomm_child) {
3121     const char *flushargv[2]= { sitename, 0 };
3122     char *reply;
3123     int r;
3124
3125     xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3126     /* parent spots the autoclose of pipefds[1] when we die or exit */
3127
3128     if (simulate_flush>=0) {
3129       warn("SIMULATING flush child status %d", simulate_flush);
3130       if (simulate_flush>128) raise(simulate_flush-128);
3131       else exit(simulate_flush);
3132     }
3133
3134     alarm(inndcomm_flush_timeout);
3135     r= ICCopen();                         if (r)   inndcommfail("connect");
3136     r= ICCcommand('f',flushargv,&reply);  if (r<0) inndcommfail("transmit");
3137     if (!r) exit(0); /* yay! */
3138
3139     if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3140     syswarn("innd ctlinnd flush failed: innd said %s", reply);
3141     exit(INNDCOMMCHILD_ESTATUS_FAIL);
3142   }
3143
3144   simulate_flush= -1;
3145
3146   xclose(pipefds[1], "inndcomm sentinel child's end",0);
3147   inndcomm_sentinel_fd= pipefds[0];
3148   assert(inndcomm_sentinel_fd);
3149   on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3150
3151   SMS(FLUSHING, 0, why);
3152 }
3153
3154 /*========== main program ==========*/
3155
3156 static void postfork_inputfile(InputFile *ipf) {
3157   if (!ipf) return;
3158   xclose(ipf->fd, "(in child) input file ", ipf->path);
3159 }
3160
3161 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3162   /* we have no stdio streams that are buffered long-term */
3163   if (!f) return;
3164   if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3165 }
3166
3167 static void postfork(void) {
3168   in_child= 1;
3169
3170   xsigsetdefault(SIGTERM);
3171   xsigsetdefault(SIGINT);
3172   xsigsetdefault(SIGPIPE);
3173   if (terminate_sig_flag) raise(terminate_sig_flag);
3174
3175   postfork_inputfile(main_input_file);
3176   postfork_inputfile(flushing_input_file);
3177
3178   Conn *conn;
3179   FOR_CONN(conn)
3180     conn_closefd(conn,"(in child) ");
3181
3182   postfork_stdio(defer, "defer file ", path_defer);
3183 }
3184
3185 typedef struct Every Every;
3186 struct Every {
3187   struct timeval interval;
3188   int fixed_rate;
3189   void (*f)(void);
3190 };
3191
3192 static void every_schedule(Every *e, struct timeval base);
3193
3194 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3195   Every *e= e_v;
3196   e->f();
3197   if (!e->fixed_rate) xgettimeofday(&base);
3198   every_schedule(e, base);
3199   return OOP_CONTINUE;
3200 }
3201
3202 static void every_schedule(Every *e, struct timeval base) {
3203   struct timeval when;
3204   timeradd(&base, &e->interval, &when);
3205   loop->on_time(loop, when, every_happens, e);
3206 }
3207
3208 static void every(int interval, int fixed_rate, void (*f)(void)) {
3209   NEW_DECL(Every *,e);
3210   e->interval.tv_sec= interval;
3211   e->interval.tv_usec= 0;
3212   e->fixed_rate= fixed_rate;
3213   e->f= f;
3214   struct timeval now;
3215   xgettimeofday(&now);
3216   every_schedule(e, now);
3217 }
3218
3219 static void filepoll(void) {
3220   filemon_callback(main_input_file);
3221   filemon_callback(flushing_input_file);
3222 }
3223
3224 static char *debug_report_ipf(InputFile *ipf) {
3225   if (!ipf) return xasprintf("none");
3226
3227   const char *slash= strrchr(ipf->path,'/');
3228   const char *path= slash ? slash+1 : ipf->path;
3229
3230   return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3231                    ipf, path,
3232                    ipf->queue.count, ipf->inprogress, ipf->autodefer,
3233                    (long)ipf->offset, ipf->fd,
3234                    ipf->rd ? "" : ",!rd",
3235                    ipf->skippinglong ? "*skiplong" : "",
3236                    ipf->rd && ipf->paused ? "*paused" : "");
3237 }
3238
3239 static void period(void) {
3240   char *dipf_main=     debug_report_ipf(main_input_file);
3241   char *dipf_flushing= debug_report_ipf(flushing_input_file);
3242   char *dipf_backlog=  debug_report_ipf(backlog_input_file);
3243
3244   debug("PERIOD"
3245         " sms=%s[%d] conns=%d until_connect=%d"
3246         " input_files main:%s flushing:%s backlog:%s[%d]"
3247         " children connecting=%ld inndcomm=%ld"
3248         ,
3249         sms_names[sms], until_flush, conns.count, until_connect,
3250         dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3251         (long)connecting_child, (long)inndcomm_child
3252         );
3253
3254   free(dipf_main);
3255   free(dipf_flushing);
3256   free(dipf_backlog);
3257
3258   if (until_connect) until_connect--;
3259
3260   inputfile_queue_check_expired(backlog_input_file);
3261   poll_backlog_file();
3262   if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3263   statemc_period_poll();
3264   check_assign_articles();
3265   check_idle_conns();
3266 }
3267
3268
3269 /*========== dumping state ==========*/
3270
3271 static void dump_article_list(FILE *f, const CliCommand *c,
3272                               const ArticleList *al) {
3273   fprintf(f, " count=%d\n", al->count);
3274   if (!c->xval) return;
3275   
3276   int i; Article *art;
3277   for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3278     fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3279     DUMPV("%p", art->,ipf);
3280     DUMPV("%d", art->,missing);
3281     DUMPV("%lu", (unsigned long)art->,offset);
3282     DUMPV("%d", art->,blanklen);
3283     DUMPV("%d", art->,midlen);
3284     fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3285   }
3286 }
3287   
3288 static void dump_input_file(FILE *f, const CliCommand *c,
3289                             InputFile *ipf, const char *wh) {
3290   char *dipf= debug_report_ipf(ipf);
3291   fprintf(f,"input %s %s", wh, dipf);
3292   free(dipf);
3293   
3294   if (ipf) {
3295     DUMPV("%d", ipf->,readcount_ok);
3296     DUMPV("%d", ipf->,readcount_blank);
3297     DUMPV("%d", ipf->,readcount_err);
3298     DUMPV("%d", ipf->,count_nooffer_missing);
3299   }
3300   fprintf(f,"\n");
3301   if (ipf) {
3302     ArtState state; const char *const *statename; 
3303     for (state=0, statename=artstate_names; *statename; state++,statename++) {
3304 #define RC_DUMP_FMT(x) " " #x "=%d"
3305 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3306       fprintf(f,"input %s counts %-11s"
3307               RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3308               wh, *statename
3309               RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3310     }
3311     fprintf(f,"input %s queue", wh);
3312     dump_article_list(f,c,&ipf->queue);
3313   }
3314 }
3315
3316 CCMD(dump) {
3317   int i;
3318   fprintf(cc->out, "dumping state to %s\n", path_dump);
3319   FILE *f= fopen(path_dump, "w");
3320   if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3321
3322   fprintf(f,"general");
3323   DUMPV("%s", sms_names,[sms]);
3324   DUMPV("%d", ,until_flush);
3325   DUMPV("%ld", (long),self_pid);
3326   DUMPV("%p", , defer);
3327   DUMPV("%d", , until_connect);
3328   DUMPV("%d", , until_backlog_nextscan);
3329   DUMPV("%d", , simulate_flush);
3330   fprintf(f,"\nnocheck");
3331   DUMPV("%#.10f", , accept_proportion);
3332   DUMPV("%d", , nocheck);
3333   DUMPV("%d", , nocheck_reported);
3334   fprintf(f,"\n");
3335
3336   fprintf(f,"special");
3337   DUMPV("%ld", (long),connecting_child);
3338   DUMPV("%d", , connecting_fdpass_sock);
3339   DUMPV("%d", , cli_master);
3340   fprintf(f,"\n");
3341
3342   fprintf(f,"filemon ");
3343   filemon_method_dump_info(f);
3344
3345   dump_input_file(f,c, main_input_file,     "main"    );
3346   dump_input_file(f,c, flushing_input_file, "flushing");
3347   dump_input_file(f,c, backlog_input_file,  "backlog" );
3348
3349   fprintf(f,"conns count=%d\n", conns.count);
3350
3351   Conn *conn;
3352   FOR_CONN(conn) {
3353
3354     fprintf(f,"C%d",conn->fd);
3355     DUMPV("%p",conn->,rd);             DUMPV("%d",conn->,max_queue);
3356     DUMPV("%d",conn->,stream);         DUMPV("%d",conn->,quitting);
3357     DUMPV("%d",conn->,since_activity);
3358     fprintf(f,"\n");
3359
3360     fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3361     fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3362     fprintf(f,"C%d sent",    conn->fd); dump_article_list(f,c,&conn->sent);
3363
3364     fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3365     for (i=0; i<conn->xmitu; i++) {
3366       const struct iovec *iv= &conn->xmit[i];
3367       const XmitDetails *xd= &conn->xmitd[i];
3368       char *dinfo;
3369       switch (xd->kind) {
3370       case xk_Const:    dinfo= xasprintf("Const");                 break;
3371       case xk_Artdata:  dinfo= xasprintf("A%p", xd->info.sm_art);  break;
3372       default:
3373         abort();
3374       }
3375       fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3376               sanitise(iv->iov_base, iv->iov_len));
3377       free(dinfo);
3378     }
3379   }
3380
3381   fprintf(f,"paths");
3382   DUMPV("%s", , feedfile);
3383   DUMPV("%s", , path_cli);
3384   DUMPV("%s", , path_lock);
3385   DUMPV("%s", , path_flushing);
3386   DUMPV("%s", , path_defer);
3387   DUMPV("%s", , path_dump);
3388   DUMPV("%s", , globpat_backlog);
3389   fprintf(f,"\n");
3390
3391   if (!!ferror(f) + !!fclose(f)) {
3392     fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3393     return;
3394   }
3395 }
3396
3397 /*========== option parsing ==========*/
3398
3399 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3400 static void vbadusage(const char *fmt, va_list al) {
3401   char *m= xvasprintf(fmt,al);
3402   fprintf(stderr, "bad usage: %s\n"
3403           "say --help for help, or read the manpage\n",
3404           m);
3405   if (become_daemon)
3406     syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3407   exit(8);
3408 }
3409
3410 /*---------- generic option parser ----------*/
3411
3412 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3413 static void badusage(const char *fmt, ...) {
3414   va_list al;
3415   va_start(al,fmt);
3416   vbadusage(fmt,al);
3417 }
3418
3419 enum OptFlags {
3420   of_seconds= 001000u,
3421   of_boolean= 002000u,
3422 };
3423
3424 typedef struct Option Option;
3425 typedef void OptionParser(const Option*, const char *val);
3426
3427 struct Option {
3428   int shrt;
3429   const char *lng, *formarg;
3430   void *store;
3431   OptionParser *fn;
3432   int intval;
3433 };
3434
3435 static void parse_options(const Option *options, char ***argvp) {
3436   /* on return *argvp is first non-option arg; argc is not updated */
3437
3438   for (;;) {
3439     const char *arg= *++(*argvp);
3440     if (!arg) break;
3441     if (*arg != '-') break;
3442     if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3443     int a;
3444     while ((a= *++arg)) {
3445       const Option *o;
3446       if (a=='-') {
3447         arg++;
3448         char *equals= strchr(arg,'=');
3449         int len= equals ? (equals - arg) : strlen(arg);
3450         for (o=options; o->shrt || o->lng; o++)
3451           if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3452             goto found_long;
3453         badusage("unknown long option --%s",arg);
3454       found_long:
3455         if (!o->formarg) {
3456           if (equals) badusage("option --%s does not take a value",o->lng);
3457           arg= 0;
3458         } else if (equals) {
3459           arg= equals+1;
3460         } else {
3461           arg= *++(*argvp);
3462           if (!arg) badusage("option --%s needs a value for %s",
3463                              o->lng, o->formarg);
3464         }
3465         o->fn(o, arg);
3466         break; /* eaten the whole argument now */
3467       }
3468       for (o=options; o->shrt || o->lng; o++)
3469         if (a == o->shrt)
3470           goto found_short;
3471       badusage("unknown short option -%c",a);
3472     found_short:
3473       if (!o->formarg) {
3474         o->fn(o,0);
3475       } else {
3476         if (!*++arg) {
3477           arg= *++(*argvp);
3478           if (!arg) badusage("option -%c needs a value for %s",
3479                              o->shrt, o->formarg);
3480         }
3481         o->fn(o,arg);
3482         break; /* eaten the whole argument now */
3483       }
3484     }
3485   }
3486 }
3487
3488 #define DELIMPERHAPS(delim,str)  (str) ? (delim) : "", (str) ? (str) : ""
3489
3490 static void print_options(const Option *options, FILE *f) {
3491   const Option *o;
3492   for (o=options; o->shrt || o->lng; o++) {
3493     char shrt[2] = { o->shrt, 0 };
3494     char *optspec= xasprintf("%s%s%s%s%s",
3495                              o->shrt ? "-" : "", shrt,
3496                              o->shrt && o->lng ? "|" : "",
3497                              DELIMPERHAPS("--", o->lng));
3498     fprintf(f, "  %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3499     free(optspec);
3500   }
3501 }
3502
3503 /*---------- specific option types ----------*/
3504
3505 static void op_integer(const Option *o, const char *val) {
3506   char *ep;
3507   errno= 0;
3508   unsigned long ul= strtoul(val,&ep,10);
3509   if (*ep || ep==val || errno || ul>INT_MAX)
3510     badusage("bad integer value for %s",o->lng);
3511   int *store= o->store;
3512   *store= ul;
3513 }
3514
3515 static void op_double(const Option *o, const char *val) {
3516   int *store= o->store;
3517   char *ep;
3518   errno= 0;
3519   *store= strtod(val, &ep);
3520   if (*ep || ep==val || errno)
3521     badusage("bad floating point value for %s",o->lng);
3522 }
3523
3524 static void op_string(const Option *o, const char *val) {
3525   const char **store= o->store;