chiark / gitweb /
Fix writev rs iovec loop
[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 tailing_make_readable(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_run, *path_cli, *path_cli_dir;
360 static int quiet_multiple=0;
361 static int become_daemon=1, try_filemon=1;
362 static int try_stream=1;
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=100;
383 static int backlog_spontrescan_periods=300;
384 static int spontaneous_flush_periods=100000;
385 static int max_separated_periods=2000;
386 static int need_activity_periods=1000;
387
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, fake_readable;
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   LIST_REMOVE(conns,conn);
1120
1121   char *m= xvasprintf(fmt,al);
1122   warn("C%d (now %d) connection failed requeueing " RCI_TRIPLE_FMT_BASE ": %s",
1123        conn->fd, conns.count, RCI_TRIPLE_VALS_BASE(requeue, /*nothing*/), m);
1124   free(m);
1125
1126   conn_dispose(conn);
1127   check_assign_articles();
1128 }
1129
1130 static void connfail(Conn *conn, const char *fmt, ...) {
1131   va_list al;
1132   va_start(al,fmt);
1133   vconnfail(conn,fmt,al);
1134   va_end(al);
1135 }
1136
1137 static void check_idle_conns(void) {
1138   Conn *conn;
1139   FOR_CONN(conn)
1140     conn->since_activity++;
1141  search_again:
1142   FOR_CONN(conn) {
1143     if (conn->since_activity <= need_activity_periods) continue;
1144
1145     /* We need to shut this down */
1146     if (conn->quitting)
1147       connfail(conn,"timed out waiting for response to QUIT");
1148     else if (conn->sent.count)
1149       connfail(conn,"timed out waiting for responses");
1150     else if (conn->waiting.count || conn->priority.count)
1151       connfail(conn,"BUG IN INNDUCT conn has queue but nothing sent");
1152     else if (conn->xmitu)
1153       connfail(conn,"peer has been sending responses"
1154                " before receiving our commands!");
1155     else {
1156       static const char quitcmd[]= "QUIT\r\n";
1157       int todo= sizeof(quitcmd)-1;
1158       const char *p= quitcmd;
1159       for (;;) {
1160         int r= write(conn->fd, p, todo);
1161         if (r<0) {
1162           if (isewouldblock(errno))
1163             connfail(conn, "blocked writing QUIT to idle connection");
1164           else
1165             connfail(conn, "failed to write QUIT to idle connection: %s",
1166                      strerror(errno));
1167           break;
1168         }
1169         assert(r<=todo);
1170         todo -= r;
1171         if (!todo) {
1172           conn->quitting= 1;
1173           conn->since_activity= 0;
1174           debug("C%d is idle, quitting", conn->fd);
1175           break;
1176         }
1177       }
1178     }
1179     goto search_again;
1180   }
1181 }  
1182
1183 /*---------- making new connections ----------*/
1184
1185 static pid_t connecting_child;
1186 static int connecting_fdpass_sock;
1187
1188 static void connect_attempt_discard(void) {
1189   if (connecting_child) {
1190     int status= xwaitpid(&connecting_child, "connect");
1191     if (!(WIFEXITED(status) ||
1192           (WIFSIGNALED(status) && WTERMSIG(status) == SIGKILL)))
1193       report_child_status("connect", status);
1194   }
1195   if (connecting_fdpass_sock) {
1196     cancel_fd_read_except(connecting_fdpass_sock);
1197     xclose_perhaps(&connecting_fdpass_sock, "connecting fdpass socket",0);
1198   }
1199 }
1200
1201 #define PREP_DECL_MSG_CMSG(msg)                 \
1202   char msgbyte= 0;                              \
1203   struct iovec msgiov;                          \
1204   msgiov.iov_base= &msgbyte;                    \
1205   msgiov.iov_len= 1;                            \
1206   struct msghdr msg;                            \
1207   memset(&msg,0,sizeof(msg));                   \
1208   char msg##cbuf[CMSG_SPACE(sizeof(int))];      \
1209   msg.msg_iov= &msgiov;                         \
1210   msg.msg_iovlen= 1;                            \
1211   msg.msg_control= msg##cbuf;                   \
1212   msg.msg_controllen= sizeof(msg##cbuf);
1213
1214 static void *connchild_event(oop_source *lp, int fd, oop_event e, void *u) {
1215   Conn *conn= 0;
1216
1217   assert(fd == connecting_fdpass_sock);
1218
1219   PREP_DECL_MSG_CMSG(msg);
1220   
1221   ssize_t rs= recvmsg(fd, &msg, 0);
1222   if (rs<0) {
1223     if (isewouldblock(errno)) return OOP_CONTINUE;
1224     syswarn("failed to read socket from connecting child");
1225     goto x;
1226   }
1227
1228   NEW(conn);
1229   LIST_INIT(conn->waiting);
1230   LIST_INIT(conn->priority);
1231   LIST_INIT(conn->sent);
1232
1233   struct cmsghdr *h= 0;
1234   if (rs >= 0) h= CMSG_FIRSTHDR(&msg);
1235   if (!h) {
1236     int status= xwaitpid(&connecting_child, "connect child (broken)");
1237
1238     if (WIFEXITED(status)) {
1239       if (WEXITSTATUS(status) != 0 &&
1240           WEXITSTATUS(status) != CONNCHILD_ESTATUS_STREAM &&
1241           WEXITSTATUS(status) != CONNCHILD_ESTATUS_NOSTREAM)
1242         /* child already reported the problem */;
1243       else {
1244         if (e == OOP_EXCEPTION)
1245           warn("connect: connection child exited code %d but"
1246                " unexpected exception on fdpass socket",
1247                WEXITSTATUS(status));
1248         else
1249           warn("connect: connection child exited code %d but"
1250                " no cmsg (rs=%d)",
1251                WEXITSTATUS(status), (int)rs);
1252       }
1253     } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
1254       warn("connect: connection attempt timed out");
1255     } else {
1256       report_child_status("connect", status);
1257     }
1258     goto x;
1259   }
1260
1261 #define CHK(field, val)                                                  \
1262   if (h->cmsg_##field != val) {                                          \
1263     die("connect: child sent cmsg with cmsg_" #field "=%d, expected %d", \
1264         h->cmsg_##field, val);                                           \
1265     goto x;                                                              \
1266   }
1267   CHK(level, SOL_SOCKET);
1268   CHK(type,  SCM_RIGHTS);
1269   CHK(len,   CMSG_LEN(sizeof(conn->fd)));
1270 #undef CHK
1271
1272   if (CMSG_NXTHDR(&msg,h)) die("connect: child sent many cmsgs");
1273
1274   memcpy(&conn->fd, CMSG_DATA(h), sizeof(conn->fd));
1275
1276   int status;
1277   pid_t got= waitpid(connecting_child, &status, 0);
1278   if (got==-1) sysdie("connect: real wait for child");
1279   assert(got == connecting_child);
1280   connecting_child= 0;
1281
1282   if (!WIFEXITED(status)) { report_child_status("connect",status); goto x; }
1283   int es= WEXITSTATUS(status);
1284   switch (es) {
1285   case CONNCHILD_ESTATUS_STREAM:    conn->stream= 1;   break;
1286   case CONNCHILD_ESTATUS_NOSTREAM:  conn->stream= 0;   break;
1287   default:
1288     fatal("connect: child gave unexpected exit status %d", es);
1289   }
1290
1291   /* Phew! */
1292   conn->max_queue= conn->stream ? max_queue_per_conn : 1;
1293
1294   loop->on_fd(loop, conn->fd, OOP_EXCEPTION, conn_exception, conn);
1295   conn->rd= oop_rd_new_fd(loop,conn->fd, 0, 0); /* sets nonblocking, too */
1296   if (!conn->fd) die("oop_rd_new_fd conn failed (fd=%d)",conn->fd);
1297   int r= oop_rd_read(conn->rd, &peer_rd_style, NNTP_STRLEN,
1298                      &peer_rd_ok, conn,
1299                      &peer_rd_err, conn);
1300   if (r) sysdie("oop_rd_read for peer (fd=%d)",conn->fd);
1301
1302   LIST_ADDHEAD(conns, conn);
1303   notice("C%d (now %d) connected %s",
1304          conn->fd, conns.count, conn->stream ? "streaming" : "plain");
1305
1306   connect_attempt_discard();
1307   check_assign_articles();
1308   return OOP_CONTINUE;
1309
1310  x:
1311   conn_dispose(conn);
1312   connect_attempt_discard();
1313   return OOP_CONTINUE;
1314 }
1315
1316 static int allow_connect_start(void) {
1317   return conns.count < max_connections
1318     && !connecting_child
1319     && !until_connect;
1320 }
1321
1322 static void connect_start(void) {
1323   assert(!connecting_child);
1324   assert(!connecting_fdpass_sock);
1325
1326   info("starting connection attempt");
1327
1328   int socks[2];
1329   int r= socketpair(AF_UNIX, SOCK_STREAM, 0, socks);
1330   if (r) { syswarn("connect: cannot create socketpair for child"); return; }
1331
1332   connecting_child= xfork("connection");
1333
1334   if (!connecting_child) {
1335     FILE *cn_from, *cn_to;
1336     char buf[NNTP_STRLEN+100];
1337     int exitstatus= CONNCHILD_ESTATUS_NOSTREAM;
1338
1339     xclose(socks[0], "(in child) parent's connection fdpass socket",0);
1340
1341     alarm(connection_setup_timeout);
1342     if (NNTPconnect((char*)remote_host, port, &cn_from, &cn_to, buf) < 0) {
1343       int l= strlen(buf);
1344       int stripped=0;
1345       while (l>0) {
1346         unsigned char c= buf[l-1];
1347         if (!isspace(c)) break;
1348         if (c=='\n' || c=='\r') stripped=1;
1349         --l;
1350       }
1351       if (!buf[0]) {
1352         sysfatal("connect: connection attempt failed");
1353       } else {
1354         buf[l]= 0;
1355         fatal("connect: %s: %s", stripped ? "rejected" : "failed",
1356               sanitise(buf,-1));
1357       }
1358     }
1359     if (NNTPsendpassword((char*)remote_host, cn_from, cn_to) < 0)
1360       sysfatal("connect: authentication failed");
1361     if (try_stream) {
1362       if (fputs("MODE STREAM\r\n", cn_to)==EOF ||
1363           fflush(cn_to))
1364         sysfatal("connect: could not send MODE STREAM");
1365       buf[sizeof(buf)-1]= 0;
1366       if (!fgets(buf, sizeof(buf)-1, cn_from)) {
1367         if (ferror(cn_from))
1368           sysfatal("connect: could not read response to MODE STREAM");
1369         else
1370           fatal("connect: connection close in response to MODE STREAM");
1371       }
1372       int l= strlen(buf);
1373       assert(l>=1);
1374       if (buf[l-1]!='\n')
1375         fatal("connect: response to MODE STREAM is too long: %.100s...",
1376               sanitise(buf,-1));
1377       l--;  if (l>0 && buf[l-1]=='\r') l--;
1378       buf[l]= 0;
1379       char *ep;
1380       int rcode= strtoul(buf,&ep,10);
1381       if (ep != &buf[3])
1382         fatal("connect: bad response to MODE STREAM: %.50s", sanitise(buf,-1));
1383
1384       switch (rcode) {
1385       case 203:
1386         exitstatus= CONNCHILD_ESTATUS_STREAM;
1387         break;
1388       case 480:
1389       case 500:
1390         break;
1391       default:
1392         warn("connect: unexpected response to MODE STREAM: %.50s",
1393              sanitise(buf,-1));
1394         exitstatus= 2;
1395         break;
1396       }
1397     }
1398     int fd= fileno(cn_from);
1399
1400     PREP_DECL_MSG_CMSG(msg);
1401     struct cmsghdr *cmsg= CMSG_FIRSTHDR(&msg);
1402     cmsg->cmsg_level= SOL_SOCKET;
1403     cmsg->cmsg_type=  SCM_RIGHTS;
1404     cmsg->cmsg_len=   CMSG_LEN(sizeof(fd));
1405     memcpy(CMSG_DATA(cmsg), &fd, sizeof(fd));
1406
1407     msg.msg_controllen= cmsg->cmsg_len;
1408     r= sendmsg(socks[1], &msg, 0);
1409     if (r<0) sysdie("sendmsg failed for new connection");
1410     if (r!=1) die("sendmsg for new connection gave wrong result %d",r);
1411
1412     _exit(exitstatus);
1413   }
1414
1415   xclose(socks[1], "connecting fdpass child's socket",0);
1416   connecting_fdpass_sock= socks[0];
1417   xsetnonblock(connecting_fdpass_sock, 1);
1418   on_fd_read_except(connecting_fdpass_sock, connchild_event);
1419 }
1420
1421 /*---------- assigning articles to conns, and transmitting ----------*/
1422
1423 static Article *dequeue_from(int peek, InputFile *ipf) {
1424   if (!ipf) return 0;
1425   if (peek) return LIST_HEAD(ipf->queue);
1426
1427   Article *art= LIST_REMHEAD(ipf->queue);
1428   if (!art) return 0;
1429   check_reading_pause_resume(ipf);
1430   return art;
1431 }
1432
1433 static Article *dequeue(int peek) {
1434   Article *art;
1435   art= dequeue_from(peek, flushing_input_file);  if (art) return art;
1436   art= dequeue_from(peek, backlog_input_file);   if (art) return art;
1437   art= dequeue_from(peek, main_input_file);      if (art) return art;
1438   return 0;
1439 }
1440
1441 static void check_assign_articles(void) {
1442   for (;;) {
1443     if (!dequeue(1))
1444       break;
1445
1446     Conn *walk, *use=0;
1447     int spare=0, inqueue=0;
1448
1449     /* Find a connection to offer this article.  We prefer a busy
1450      * connection to an idle one, provided it's not full.  We take the
1451      * first (oldest) and since that's stable, it will mean we fill up
1452      * connections in order.  That way if we have too many
1453      * connections, the spare ones will go away eventually.
1454      */
1455     FOR_CONN(walk) {
1456       if (walk->quitting) continue;
1457       inqueue= walk->sent.count + walk->priority.count
1458              + walk->waiting.count;
1459       spare= walk->max_queue - inqueue;
1460       assert(inqueue <= max_queue_per_conn);
1461       assert(spare >= 0);
1462       if (inqueue==0) /*idle*/ { if (!use) use= walk; }
1463       else if (spare>0) /*working*/ { use= walk; break; }
1464     }
1465     if (use) {
1466       if (!inqueue) use->since_activity= 0; /* reset idle counter */
1467       while (spare>0) {
1468         Article *art= dequeue(0);
1469         if (!art) break;
1470         LIST_ADDTAIL(use->waiting, art);
1471         spare--;
1472       }
1473       conn_maybe_write(use);
1474     } else if (allow_connect_start()) {
1475       until_connect= reconnect_delay_periods;
1476       connect_start();
1477       break;
1478     } else {
1479       break;
1480     }
1481   }
1482 }
1483
1484 static void *conn_writeable(oop_source *l, int fd, oop_event ev, void *u) {
1485   conn_maybe_write(u);
1486   return OOP_CONTINUE;
1487 }
1488
1489 static void conn_maybe_write(Conn *conn)  {
1490   for (;;) {
1491     conn_make_some_xmits(conn);
1492     if (!conn->xmitu) {
1493       loop->cancel_fd(loop, conn->fd, OOP_WRITE);
1494       return;
1495     }
1496
1497     void *rp= conn_write_some_xmits(conn);
1498     if (rp==OOP_CONTINUE) {
1499       loop->on_fd(loop, conn->fd, OOP_WRITE, conn_writeable, conn);
1500       return;
1501     } else if (rp==OOP_HALT) {
1502       return;
1503     } else if (!rp) {
1504       /* transmitted everything */
1505     } else {
1506       abort();
1507     }
1508   }
1509 }
1510
1511 /*---------- expiry, flow control and deferral ----------*/
1512
1513 /*
1514  * flow control notes
1515  * to ensure articles go away eventually
1516  * separate queue for each input file
1517  *   queue expiry
1518  *     every period, check head of backlog queue for expiry with SMretrieve
1519  *       if too old: discard, and check next article
1520  *     also check every backlog article as we read it
1521  *   flush expiry
1522  *     after too long in SEPARATED/DROPPING ie Separated/Finishing/Dropping
1523  *     one-off: eat queued articles from flushing and write them to defer
1524  *     one-off: connfail all connections which have any articles from flushing
1525  *     newly read articles from flushing go straight to defer
1526  *     this should take care of it and get us out of this state
1527  * to avoid filling up ram needlessly
1528  *   input control
1529  *     limit number of queued articles for each ipf
1530  *     pause/resume inputfile tailing
1531  */
1532
1533 static void check_reading_pause_resume(InputFile *ipf) {
1534   if (ipf->queue.count >= max_queue_per_ipf)
1535     inputfile_reading_pause(ipf);
1536   else
1537     inputfile_reading_resume(ipf);
1538 }
1539
1540 static void article_defer(Article *art /* not on a queue */, int whichcount) {
1541   open_defer();
1542   if (fprintf(defer, "%s %s\n", TokenToText(art->token), art->messageid) <0
1543       || fflush(defer))
1544     sysfatal("write to defer file %s",path_defer);
1545   article_done(art, whichcount);
1546 }
1547
1548 static int article_check_expired(Article *art /* must be queued, not conn */) {
1549   ARTHANDLE *artdata= SMretrieve(art->token, RETR_STAT);
1550   if (artdata) { SMfreearticle(artdata); return 0; }
1551
1552   LIST_REMOVE(art->ipf->queue, art);
1553   art->missing= 1;
1554   art->ipf->count_nooffer_missing++;
1555   article_done(art,-1);
1556   return 1;
1557 }
1558
1559 static void inputfile_queue_check_expired(InputFile *ipf) {
1560   if (!ipf) return;
1561
1562   for (;;) {
1563     Article *art= LIST_HEAD(ipf->queue);
1564     int exp= article_check_expired(art);
1565     if (!exp) break;
1566   }
1567   check_reading_pause_resume(ipf);
1568 }
1569
1570 static void article_autodefer(InputFile *ipf, Article *art) {
1571   ipf->autodefer++;
1572   article_defer(art,-1);
1573 }
1574
1575 static int has_article_in(const ArticleList *al, InputFile *ipf) {
1576   Article *art;
1577   for (art=LIST_HEAD(*al); art; art=LIST_NEXT(art))
1578     if (art->ipf == ipf) return 1;
1579   return 0;
1580 }
1581
1582 static void autodefer_input_file_articles(InputFile *ipf) {
1583   Article *art;
1584   while ((art= LIST_REMHEAD(ipf->queue)))
1585     article_autodefer(ipf, art);
1586 }
1587
1588 static void autodefer_input_file(InputFile *ipf) {
1589   ipf->autodefer= 0;
1590
1591   autodefer_input_file_articles(ipf);
1592
1593   if (ipf->inprogress) {
1594     Conn *walk;
1595     FOR_CONN(walk) {
1596       if (has_article_in(&walk->waiting,  ipf) ||
1597           has_article_in(&walk->priority, ipf) ||
1598           has_article_in(&walk->sent,     ipf))
1599         walk->quitting= -1;
1600     }
1601     while (ipf->inprogress) {
1602       FOR_CONN(walk)
1603         if (walk->quitting < 0) goto found;
1604       abort(); /* where are they ?? */
1605
1606     found:
1607       connfail(walk, "connection is stuck or crawling,"
1608                " and we need to finish flush");
1609       autodefer_input_file_articles(ipf);
1610     }
1611   }
1612
1613   check_reading_pause_resume(ipf);
1614 }
1615
1616 /*========== article transmission ==========*/
1617
1618 static XmitDetails *xmit_core(Conn *conn, const char *data, int len,
1619                   XmitKind kind) { /* caller must then fill in details */
1620   struct iovec *v= &conn->xmit[conn->xmitu];
1621   XmitDetails *d= &conn->xmitd[conn->xmitu++];
1622   v->iov_base= (char*)data;
1623   v->iov_len= len;
1624   d->kind= kind;
1625   return d;
1626 }
1627
1628 static void xmit_noalloc(Conn *conn, const char *data, int len) {
1629   xmit_core(conn,data,len, xk_Const);
1630 }
1631 #define XMIT_LITERAL(lit) (xmit_noalloc(conn, (lit), sizeof(lit)-1))
1632
1633 static void xmit_artbody(Conn *conn, ARTHANDLE *ah /* consumed */) {
1634   XmitDetails *d= xmit_core(conn, ah->data, ah->len, xk_Artdata);
1635   d->info.sm_art= ah;
1636 }
1637
1638 static void xmit_free(XmitDetails *d) {
1639   switch (d->kind) {
1640   case xk_Artdata: SMfreearticle(d->info.sm_art); break;
1641   case xk_Const:                                  break;
1642   default: abort();
1643   }
1644 }
1645
1646 static void *conn_write_some_xmits(Conn *conn) {
1647   /* return values:
1648    *      0:            nothing more to write, no need to call us again
1649    *      OOP_CONTINUE: more to write but fd not writeable
1650    *      OOP_HALT:     disaster, have destroyed conn
1651    */
1652   for (;;) {
1653     int count= conn->xmitu;
1654     if (!count) return 0;
1655
1656     if (count > IOV_MAX) count= IOV_MAX;
1657     ssize_t rs= writev(conn->fd, conn->xmit, count);
1658     if (rs < 0) {
1659       if (isewouldblock(errno)) return OOP_CONTINUE;
1660       connfail(conn, "write failed: %s", strerror(errno));
1661       return OOP_HALT;
1662     }
1663     assert(rs > 0);
1664
1665     int done;
1666     for (done=0; rs; ) {
1667       assert(done<conn->xmitu);
1668       struct iovec *vp= &conn->xmit[done];
1669       XmitDetails *dp= &conn->xmitd[done];
1670       if (rs >= vp->iov_len) {
1671         rs -= vp->iov_len;
1672         xmit_free(dp); /* vp->iov_len -= vp->iov_len, etc. */
1673         done++;
1674       } else {
1675         vp->iov_base= (char*)vp->iov_base + rs;
1676         vp->iov_len -= rs;
1677         break; /* rs -= rs */
1678       }
1679     }
1680     int newu= conn->xmitu - done;
1681     memmove(conn->xmit,  conn->xmit  + done, newu * sizeof(*conn->xmit));
1682     memmove(conn->xmitd, conn->xmitd + done, newu * sizeof(*conn->xmitd));
1683     conn->xmitu= newu;
1684   }
1685 }
1686
1687 static void conn_make_some_xmits(Conn *conn) {
1688   for (;;) {
1689     if (conn->xmitu+5 > CONNIOVS)
1690       break;
1691
1692     Article *art= LIST_REMHEAD(conn->priority);
1693     if (!art) art= LIST_REMHEAD(conn->waiting);
1694     if (!art) break;
1695
1696     if (art->state >= art_Wanted || (conn->stream && nocheck)) {
1697       /* actually send it */
1698
1699       ARTHANDLE *artdata= SMretrieve(art->token, RETR_ALL);
1700
1701       art->state=
1702         art->state == art_Unchecked ? art_Unsolicited :
1703         art->state == art_Wanted    ? art_Wanted      :
1704         (abort(),-1);
1705
1706       if (!artdata) art->missing= 1;
1707       art->ipf->counts[art->state][ artdata ? RC_sent : RC_missing ]++;
1708
1709       if (conn->stream) {
1710         if (artdata) {
1711           XMIT_LITERAL("TAKETHIS ");
1712           xmit_noalloc(conn, art->messageid, art->midlen);
1713           XMIT_LITERAL("\r\n");
1714           xmit_artbody(conn, artdata);
1715         } else {
1716           article_done(art, -1);
1717           continue;
1718         }
1719       } else {
1720         /* we got 235 from IHAVE */
1721         if (artdata) {
1722           xmit_artbody(conn, artdata);
1723         } else {
1724           XMIT_LITERAL(".\r\n");
1725         }
1726       }
1727
1728       LIST_ADDTAIL(conn->sent, art);
1729
1730     } else {
1731       /* check it */
1732
1733       if (conn->stream)
1734         XMIT_LITERAL("CHECK ");
1735       else
1736         XMIT_LITERAL("IHAVE ");
1737       xmit_noalloc(conn, art->messageid, art->midlen);
1738       XMIT_LITERAL("\r\n");
1739
1740       assert(art->state == art_Unchecked);
1741       art->ipf->counts[art->state][RC_sent]++;
1742       LIST_ADDTAIL(conn->sent, art);
1743     }
1744   }
1745 }
1746
1747 /*========== handling responses from peer ==========*/
1748
1749 static const oop_rd_style peer_rd_style= {
1750   OOP_RD_DELIM_STRIP, '\n',
1751   OOP_RD_NUL_FORBID,
1752   OOP_RD_SHORTREC_FORBID
1753 };
1754
1755 static void *peer_rd_err(oop_source *lp, oop_read *oread, oop_rd_event ev,
1756                          const char *errmsg, int errnoval,
1757                          const char *data, size_t recsz, void *conn_v) {
1758   Conn *conn= conn_v;
1759   connfail(conn, "error receiving from peer: %s", errmsg);
1760   return OOP_CONTINUE;
1761 }
1762
1763 static Article *article_reply_check(Conn *conn, const char *response,
1764                                     int code_indicates_streaming,
1765                                     int must_have_sent
1766                                         /* 1:yes, -1:no, 0:dontcare */,
1767                                     const char *sanitised_response) {
1768   Article *art= LIST_HEAD(conn->sent);
1769
1770   if (!art) {
1771     connfail(conn,
1772              "peer gave unexpected response when no commands outstanding: %s",
1773              sanitised_response);
1774     return 0;
1775   }
1776
1777   if (code_indicates_streaming) {
1778     assert(!memchr(response, 0, 4)); /* ensured by peer_rd_ok */
1779     if (!conn->stream) {
1780       connfail(conn, "peer gave streaming response code "
1781                " to IHAVE or subsequent body: %s", sanitised_response);
1782       return 0;
1783     }
1784     const char *got_mid= response+4;
1785     int got_midlen= strcspn(got_mid, " \n\r");
1786     if (got_midlen<3 || got_mid[0]!='<' || got_mid[got_midlen-1]!='>') {
1787       connfail(conn, "peer gave streaming response with syntactically invalid"
1788                " messageid: %s", sanitised_response);
1789       return 0;
1790     }
1791     if (got_midlen != art->midlen ||
1792         memcmp(got_mid, art->messageid, got_midlen)) {
1793       connfail(conn, "peer gave streaming response code to wrong article -"
1794                " probable synchronisation problem; we offered: %s;"
1795                " peer said: %s",
1796                art->messageid, sanitised_response);
1797       return 0;
1798     }
1799   } else {
1800     if (conn->stream) {
1801       connfail(conn, "peer gave non-streaming response code to"
1802                " CHECK/TAKETHIS: %s", sanitised_response);
1803       return 0;
1804     }
1805   }
1806
1807   if (must_have_sent>0 && art->state < art_Wanted) {
1808     connfail(conn, "peer says article accepted but"
1809              " we had not sent the body: %s", sanitised_response);
1810     return 0;
1811   }
1812   if (must_have_sent<0 && art->state >= art_Wanted) {
1813     connfail(conn, "peer says please sent the article but we just did: %s",
1814              sanitised_response);
1815     return 0;
1816   }
1817
1818   Article *art_again= LIST_REMHEAD(conn->sent);
1819   assert(art_again == art);
1820   return art;
1821 }
1822
1823 static void update_nocheck(int accepted) {
1824   accept_proportion *= nocheck_decay;
1825   accept_proportion += accepted * (1.0 - nocheck_decay);
1826   int new_nocheck= accept_proportion >= nocheck_thresh;
1827   if (new_nocheck && !nocheck_reported) {
1828     notice("entering nocheck mode for the first time");
1829     nocheck_reported= 1;
1830   } else if (new_nocheck != nocheck) {
1831     debug("nocheck mode %s", new_nocheck ? "start" : "stop");
1832   }
1833   nocheck= new_nocheck;
1834 }
1835
1836 static void article_done(Article *art, int whichcount) {
1837   if (whichcount>=0 && !art->missing)
1838     art->ipf->counts[art->state][whichcount]++;
1839
1840   if (whichcount == RC_accepted) update_nocheck(1);
1841   else if (whichcount == RC_unwanted) update_nocheck(0);
1842
1843   InputFile *ipf= art->ipf;
1844
1845   while (art->blanklen) {
1846     static const char spaces[]=
1847       "                                                                "
1848       "                                                                "
1849       "                                                                "
1850       "                                                                "
1851       "                                                                "
1852       "                                                                "
1853       "                                                                "
1854       "                                                                "
1855       "                                                                ";
1856     int w= art->blanklen;  if (w >= sizeof(spaces)) w= sizeof(spaces)-1;
1857     int r= pwrite(ipf->fd, spaces, w, art->offset);
1858     if (r==-1) {
1859       if (errno==EINTR) continue;
1860       sysdie("failed to blank entry for %s (length %d at offset %lu) in %s",
1861              art->messageid, art->blanklen,
1862              (unsigned long)art->offset, ipf->path);
1863     }
1864     assert(r>=0 && r<=w);
1865     art->blanklen -= w;
1866     art->offset += w;
1867   }
1868
1869   ipf->inprogress--;
1870   assert(ipf->inprogress >= 0);
1871   free(art);
1872
1873   if (!ipf->inprogress && ipf != main_input_file)
1874     queue_check_input_done();
1875 }
1876
1877 static void *peer_rd_ok(oop_source *lp, oop_read *oread, oop_rd_event ev,
1878                         const char *errmsg, int errnoval,
1879                         const char *data, size_t recsz, void *conn_v) {
1880   Conn *conn= conn_v;
1881
1882   if (ev == OOP_RD_EOF) {
1883     connfail(conn, "unexpected EOF from peer");
1884     return OOP_CONTINUE;
1885   }
1886   assert(ev == OOP_RD_OK);
1887
1888   char *sani= sanitise(data,-1);
1889
1890   char *ep;
1891   unsigned long code= strtoul(data, &ep, 10);
1892   if (ep != data+3 || *ep != ' ' || data[0]=='0') {
1893     connfail(conn, "badly formatted response from peer: %s", sani);
1894     return OOP_CONTINUE;
1895   }
1896
1897   int conn_busy=
1898     conn->waiting.count ||
1899     conn->priority.count ||
1900     conn->sent.count ||
1901     conn->xmitu;
1902
1903   if (conn->quitting) {
1904     if (code!=205 && code!=503) {
1905       connfail(conn, "peer gave unexpected response to QUIT: %s", sani);
1906     } else {
1907       LIST_REMOVE(conns,conn);
1908       notice("C%d (now %d) idle connection closed by us",
1909              conn->fd, conns.count);
1910       assert(!conn_busy);
1911       conn_dispose(conn);
1912     }
1913     return OOP_CONTINUE;
1914   }
1915
1916   conn->since_activity= 0;
1917   Article *art;
1918
1919 #define GET_ARTICLE(musthavesent) do{                                         \
1920     art= article_reply_check(conn, data, code_streaming, musthavesent, sani); \
1921     if (!art) return OOP_CONTINUE; /* reply_check has failed the conn */      \
1922   }while(0) 
1923
1924 #define ARTICLE_DEALTWITH(streaming,musthavesent,how) do{       \
1925     code_streaming= (streaming);                                \
1926     GET_ARTICLE(musthavesent);                                  \
1927     article_done(art, RC_##how);                                \
1928     goto dealtwith;                                             \
1929   }while(0)
1930
1931 #define PEERBADMSG(m) do {                                      \
1932     connfail(conn, m ": %s", sani);  return OOP_CONTINUE;       \
1933   }while(0)
1934
1935   int code_streaming= 0;
1936
1937   switch (code) {
1938
1939   default:  PEERBADMSG("peer sent unexpected message");
1940
1941   case 400:
1942     if (conn_busy)
1943       PEERBADMSG("peer timed us out or stopped accepting articles");
1944
1945     LIST_REMOVE(conns,conn);
1946     notice("C%d (now %d) idle connection closed by peer",
1947            conns.count, conn->fd);
1948     conn_dispose(conn);
1949     return OOP_CONTINUE;
1950
1951   case 435: ARTICLE_DEALTWITH(0,0,unwanted); /* IHAVE says they have it */
1952   case 438: ARTICLE_DEALTWITH(1,0,unwanted); /* CHECK/TAKETHIS: they have it */
1953
1954   case 235: ARTICLE_DEALTWITH(0,1,accepted); /* IHAVE says thanks */
1955   case 239: ARTICLE_DEALTWITH(1,1,accepted); /* TAKETHIS says thanks */
1956
1957   case 437: ARTICLE_DEALTWITH(0,0,rejected); /* IHAVE says rejected */
1958   case 439: ARTICLE_DEALTWITH(1,0,rejected); /* TAKETHIS says rejected */
1959
1960   case 238: /* CHECK says send it */
1961     code_streaming= 1;
1962   case 335: /* IHAVE says send it */
1963     GET_ARTICLE(-1);
1964     assert(art->state == art_Unchecked);
1965     art->ipf->counts[art->state][RC_accepted]++;
1966     art->state= art_Wanted;
1967     LIST_ADDTAIL(conn->priority, art);
1968     break;
1969
1970   case 431: /* CHECK or TAKETHIS says try later */
1971     code_streaming= 1;
1972   case 436: /* IHAVE says try later */
1973     GET_ARTICLE(0);
1974     article_defer(art, RC_deferred);
1975     break;
1976
1977   }
1978 dealtwith:
1979
1980   conn_maybe_write(conn);
1981   check_assign_articles();
1982   return OOP_CONTINUE;
1983 }
1984
1985
1986 /*========== monitoring of input files ==========*/
1987
1988 static void feedfile_eof(InputFile *ipf) {
1989   assert(ipf != main_input_file); /* promised by tailing_try_read */
1990   inputfile_reading_stop(ipf);
1991
1992   if (ipf == flushing_input_file) {
1993     assert(sms==sm_SEPARATED || sms==sm_DROPPING);
1994     if (main_input_file) inputfile_reading_start(main_input_file);
1995     statemc_check_flushing_done();
1996   } else if (ipf == backlog_input_file) {
1997     statemc_check_backlog_done();
1998   } else {
1999     abort(); /* supposed to wait rather than get EOF on main input file */
2000   }
2001 }
2002
2003 static InputFile *open_input_file(const char *path) {
2004   int fd= open(path, O_RDWR);
2005   if (fd<0) {
2006     if (errno==ENOENT) return 0;
2007     sysfatal("unable to open input file %s", path);
2008   }
2009   assert(fd>0);
2010
2011   InputFile *ipf= xmalloc(sizeof(*ipf) + strlen(path) + 1);
2012   memset(ipf,0,sizeof(*ipf));
2013
2014   ipf->fd= fd;
2015   ipf->autodefer= -1;
2016   LIST_INIT(ipf->queue);
2017   strcpy(ipf->path, path);
2018
2019   return ipf;
2020 }
2021
2022 static void close_input_file(InputFile *ipf) { /* does not free */
2023   assert(!ipf->readable_callback); /* must have had ->on_cancel */
2024   assert(!ipf->filemon); /* must have had inputfile_reading_stop */
2025   assert(!ipf->rd); /* must have had inputfile_reading_stop */
2026   assert(!ipf->inprogress); /* no dangling pointers pointing here */
2027   xclose_perhaps(&ipf->fd, "input file ", ipf->path);
2028 }
2029
2030
2031 /*---------- dealing with articles read in the input file ----------*/
2032
2033 static void *feedfile_got_bad_data(InputFile *ipf, off_t offset,
2034                                    const char *data, const char *how) {
2035   warn("corrupted file: %s, offset %lu: %s: in %s",
2036        ipf->path, (unsigned long)offset, how, sanitise(data,-1));
2037   ipf->readcount_err++;
2038   if (ipf->readcount_err > max_bad_data_initial +
2039       (ipf->readcount_ok+ipf->readcount_blank) / max_bad_data_ratio)
2040     die("too much garbage in input file!  (%d errs, %d ok, %d blank)",
2041         ipf->readcount_err, ipf->readcount_ok, ipf->readcount_blank);
2042   return OOP_CONTINUE;
2043 }
2044
2045 static void *feedfile_read_err(oop_source *lp, oop_read *rd,
2046                                oop_rd_event ev, const char *errmsg,
2047                                int errnoval, const char *data, size_t recsz,
2048                                void *ipf_v) {
2049   InputFile *ipf= ipf_v;
2050   assert(ev == OOP_RD_SYSTEM);
2051   errno= errnoval;
2052   sysdie("error reading input file: %s, offset %lu",
2053          ipf->path, (unsigned long)ipf->offset);
2054 }
2055
2056 static void *feedfile_got_article(oop_source *lp, oop_read *rd,
2057                                   oop_rd_event ev, const char *errmsg,
2058                                   int errnoval, const char *data, size_t recsz,
2059                                   void *ipf_v) {
2060   InputFile *ipf= ipf_v;
2061   Article *art;
2062   char tokentextbuf[sizeof(TOKEN)*2+3];
2063
2064   if (!data) { feedfile_eof(ipf); return OOP_CONTINUE; }
2065
2066   off_t old_offset= ipf->offset;
2067   ipf->offset += recsz + !!(ev == OOP_RD_OK);
2068
2069 #define X_BAD_DATA(m) return feedfile_got_bad_data(ipf,old_offset,data,m);
2070
2071   if (ev==OOP_RD_PARTREC)
2072     feedfile_got_bad_data(ipf,old_offset,data,"missing final newline");
2073     /* but process it anyway */
2074
2075   if (ipf->skippinglong) {
2076     if (ev==OOP_RD_OK) ipf->skippinglong= 0; /* fine now */
2077     return OOP_CONTINUE;
2078   }
2079   if (ev==OOP_RD_LONG) {
2080     ipf->skippinglong= 1;
2081     X_BAD_DATA("overly long line");
2082   }
2083
2084   if (memchr(data,'\0',recsz)) X_BAD_DATA("nul byte");
2085   if (!recsz) X_BAD_DATA("empty line");
2086
2087   if (data[0]==' ') {
2088     if (strspn(data," ") != recsz) X_BAD_DATA("line partially blanked");
2089     ipf->readcount_blank++;
2090     return OOP_CONTINUE;
2091   }
2092
2093   char *space= strchr(data,' ');
2094   int tokenlen= space-data;
2095   int midlen= (int)recsz-tokenlen-1;
2096   if (midlen <= 2) X_BAD_DATA("no room for messageid");
2097   if (space[1]!='<' || space[midlen]!='>') X_BAD_DATA("invalid messageid");
2098
2099   if (tokenlen != sizeof(TOKEN)*2+2) X_BAD_DATA("token wrong length");
2100   memcpy(tokentextbuf, data, tokenlen);
2101   tokentextbuf[tokenlen]= 0;
2102   if (!IsToken(tokentextbuf)) X_BAD_DATA("token wrong syntax");
2103
2104   ipf->readcount_ok++;
2105
2106   art= xmalloc(sizeof(*art) - 1 + midlen + 1);
2107   memset(art,0,sizeof(*art));
2108   art->state= art_Unchecked;
2109   art->midlen= midlen;
2110   art->ipf= ipf;  ipf->inprogress++;
2111   art->token= TextToToken(tokentextbuf);
2112   art->offset= old_offset;
2113   art->blanklen= recsz;
2114   strcpy(art->messageid, space+1);
2115   LIST_ADDTAIL(ipf->queue, art);
2116
2117   if (ipf->autodefer >= 0)
2118     article_autodefer(ipf, art);
2119   else if (ipf==backlog_input_file)
2120     article_check_expired(art);
2121
2122   if (sms==sm_NORMAL && ipf==main_input_file &&
2123       ipf->offset >= target_max_feedfile_size)
2124     statemc_start_flush("feed file size");
2125
2126   check_assign_articles(); /* may destroy conn but that's OK */
2127   check_reading_pause_resume(ipf);
2128   return OOP_CONTINUE;
2129 }
2130
2131 /*========== tailing input file ==========*/
2132
2133 static void *tailing_rable_call_time(oop_source *loop, struct timeval tv,
2134                                      void *user) {
2135   /* lifetime of ipf here is OK because destruction will cause
2136    * on_cancel which will cancel this callback */
2137   InputFile *ipf= user;
2138
2139   if (!ipf->fake_readable) return OOP_CONTINUE;
2140
2141   /* we just keep calling readable until our caller (oop_rd)
2142    * has called try_read, and try_read has found EOF so given EAGAIN */
2143   loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2144
2145   return ipf->readable_callback(loop, &ipf->readable,
2146                                 ipf->readable_callback_user);
2147 }
2148
2149 static void tailing_on_cancel(struct oop_readable *rable) {
2150   InputFile *ipf= (void*)rable;
2151
2152   if (ipf->filemon) filemon_stop(ipf);
2153   loop->cancel_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2154   ipf->readable_callback= 0;
2155 }
2156
2157 static void tailing_make_readable(InputFile *ipf) {
2158   if (!ipf || !ipf->readable_callback) /* so callers can be naive */
2159     return;
2160   ipf->fake_readable= 1;
2161   loop->on_time(loop, OOP_TIME_NOW, tailing_rable_call_time, ipf);
2162 }
2163
2164 static int tailing_on_readable(struct oop_readable *rable,
2165                                 oop_readable_call *cb, void *user) {
2166   InputFile *ipf= (void*)rable;
2167
2168   tailing_on_cancel(rable);
2169   ipf->readable_callback= cb;
2170   ipf->readable_callback_user= user;
2171   filemon_start(ipf);
2172   tailing_make_readable(ipf);
2173   return 0;
2174 }
2175
2176 static ssize_t tailing_try_read(struct oop_readable *rable, void *buffer,
2177                                 size_t length) {
2178   InputFile *ipf= (void*)rable;
2179   for (;;) {
2180     ssize_t r= read(ipf->fd, buffer, length);
2181     if (r==-1) {
2182       if (errno==EINTR) continue;
2183       ipf->fake_readable= 0;
2184       return r;
2185     }
2186     if (!r) {
2187       if (ipf==main_input_file) {
2188         errno=EAGAIN;
2189         ipf->fake_readable= 0;
2190         return -1;
2191       } else if (ipf==flushing_input_file) {
2192         assert(ipf->rd);
2193         assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2194       } else if (ipf==backlog_input_file) {
2195         assert(ipf->rd);
2196       } else {
2197         abort();
2198       }
2199     }
2200     return r;
2201   }
2202 }
2203
2204 /*---------- filemon implemented with inotify ----------*/
2205
2206 #if defined(HAVE_SYS_INOTIFY_H) && !defined(HAVE_FILEMON)
2207 #define HAVE_FILEMON
2208
2209 #include <sys/inotify.h>
2210
2211 static int filemon_inotify_fd;
2212 static int filemon_inotify_wdmax;
2213 static InputFile **filemon_inotify_wd2ipf;
2214
2215 struct Filemon_Perfile {
2216   int wd;
2217 };
2218
2219 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) {
2220   int wd= inotify_add_watch(filemon_inotify_fd, ipf->path, IN_MODIFY);
2221   if (wd < 0) sysfatal("inotify_add_watch %s", ipf->path);
2222
2223   if (wd >= filemon_inotify_wdmax) {
2224     int newmax= wd+2;
2225     filemon_inotify_wd2ipf= xrealloc(filemon_inotify_wd2ipf,
2226                                  sizeof(*filemon_inotify_wd2ipf) * newmax);
2227     memset(filemon_inotify_wd2ipf + filemon_inotify_wdmax, 0,
2228            sizeof(*filemon_inotify_wd2ipf) * (newmax - filemon_inotify_wdmax));
2229     filemon_inotify_wdmax= newmax;
2230   }
2231
2232   assert(!filemon_inotify_wd2ipf[wd]);
2233   filemon_inotify_wd2ipf[wd]= ipf;
2234
2235   debug("filemon inotify startfile %p wd=%d wdmax=%d",
2236         ipf, wd, filemon_inotify_wdmax);
2237
2238   pf->wd= wd;
2239 }
2240
2241 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) {
2242   int wd= pf->wd;
2243   debug("filemon inotify stopfile %p wd=%d", ipf, wd);
2244   int r= inotify_rm_watch(filemon_inotify_fd, wd);
2245   if (r) sysdie("inotify_rm_watch");
2246   filemon_inotify_wd2ipf[wd]= 0;
2247 }
2248
2249 static void *filemon_inotify_readable(oop_source *lp, int fd,
2250                                       oop_event e, void *u) {
2251   struct inotify_event iev;
2252   for (;;) {
2253     int r= read(filemon_inotify_fd, &iev, sizeof(iev));
2254     if (r==-1) {
2255       if (isewouldblock(errno)) break;
2256       sysdie("read from inotify master");
2257     } else if (r==sizeof(iev)) {
2258       assert(iev.wd >= 0 && iev.wd < filemon_inotify_wdmax);
2259     } else {
2260       die("inotify read %d bytes wanted struct of %d", r, (int)sizeof(iev));
2261     }
2262     InputFile *ipf= filemon_inotify_wd2ipf[iev.wd];
2263     /*debug("filemon inotify readable read %p wd=%d", ipf, iev.wd);*/
2264     tailing_make_readable(ipf);
2265   }
2266   return OOP_CONTINUE;
2267 }
2268
2269 static int filemon_method_init(void) {
2270   filemon_inotify_fd= inotify_init();
2271   if (filemon_inotify_fd<0) {
2272     syswarn("filemon/inotify: inotify_init failed");
2273     return 0;
2274   }
2275   xsetnonblock(filemon_inotify_fd, 1);
2276   loop->on_fd(loop, filemon_inotify_fd, OOP_READ, filemon_inotify_readable, 0);
2277
2278   debug("filemon inotify init filemon_inotify_fd=%d", filemon_inotify_fd);
2279   return 1;
2280 }
2281
2282 static void filemon_method_dump_info(FILE *f) {
2283   int i;
2284   fprintf(f,"inotify");
2285   DUMPV("%d",,filemon_inotify_fd);
2286   DUMPV("%d",,filemon_inotify_wdmax);
2287   for (i=0; i<filemon_inotify_wdmax; i++)
2288     fprintf(f," wd2ipf[%d]=%p\n", i, filemon_inotify_wd2ipf[i]);
2289 }
2290
2291 #endif /* HAVE_INOTIFY && !HAVE_FILEMON */
2292
2293 /*---------- filemon dummy implementation ----------*/
2294
2295 #if !defined(HAVE_FILEMON)
2296
2297 struct Filemon_Perfile { int dummy; };
2298
2299 static int filemon_method_init(void) {
2300   warn("filemon/dummy: no filemon method compiled in");
2301   return 0;
2302 }
2303 static void filemon_method_startfile(InputFile *ipf, Filemon_Perfile *pf) { }
2304 static void filemon_method_stopfile(InputFile *ipf, Filemon_Perfile *pf) { }
2305 static void filemon_method_dump_info(FILE *f) { fprintf(f,"dummy\n"); }
2306
2307 #endif /* !HAVE_FILEMON */
2308
2309 /*---------- filemon generic interface ----------*/
2310
2311 static void filemon_start(InputFile *ipf) {
2312   assert(!ipf->filemon);
2313
2314   NEW(ipf->filemon);
2315   filemon_method_startfile(ipf, ipf->filemon);
2316 }
2317
2318 static void filemon_stop(InputFile *ipf) {
2319   if (!ipf->filemon) return;
2320   filemon_method_stopfile(ipf, ipf->filemon);
2321   free(ipf->filemon);
2322   ipf->filemon= 0;
2323 }
2324
2325 /*---------- interface to start and stop an input file ----------*/
2326
2327 static const oop_rd_style feedfile_rdstyle= {
2328   OOP_RD_DELIM_STRIP, '\n',
2329   OOP_RD_NUL_PERMIT,
2330   OOP_RD_SHORTREC_LONG,
2331 };
2332
2333 static void inputfile_reading_resume(InputFile *ipf) {
2334   if (!ipf->rd) return;
2335   if (!ipf->paused) return;
2336
2337   int r= oop_rd_read(ipf->rd, &feedfile_rdstyle, MAX_LINE_FEEDFILE,
2338                      feedfile_got_article,ipf, feedfile_read_err, ipf);
2339   if (r) sysdie("unable start reading feedfile %s",ipf->path);
2340
2341   ipf->paused= 0;
2342 }
2343
2344 static void inputfile_reading_pause(InputFile *ipf) {
2345   if (!ipf->rd) return;
2346   if (ipf->paused) return;
2347   oop_rd_cancel(ipf->rd);
2348   ipf->paused= 1;
2349 }
2350
2351 static void inputfile_reading_start(InputFile *ipf) {
2352   assert(!ipf->rd);
2353   ipf->readable.on_readable= tailing_on_readable;
2354   ipf->readable.on_cancel=   tailing_on_cancel;
2355   ipf->readable.try_read=    tailing_try_read;
2356   ipf->readable.delete_tidy= 0; /* we never call oop_rd_delete_{tidy,kill} */
2357   ipf->readable.delete_kill= 0;
2358
2359   ipf->readable_callback= 0;
2360   ipf->readable_callback_user= 0;
2361
2362   ipf->rd= oop_rd_new(loop, &ipf->readable, 0,0);
2363   assert(ipf->rd);
2364
2365   ipf->paused= 1;
2366   inputfile_reading_resume(ipf);
2367 }
2368
2369 static void inputfile_reading_stop(InputFile *ipf) {
2370   assert(ipf->rd);
2371   inputfile_reading_pause(ipf);
2372   oop_rd_delete(ipf->rd);
2373   ipf->rd= 0;
2374   assert(!ipf->filemon); /* we shouldn't be monitoring it now */
2375 }
2376
2377
2378 /*========== interaction with innd - state machine ==========*/
2379
2380 /* See official state diagram at top of file.  We implement
2381  * this as follows:
2382  * -8<-
2383
2384             .=======.
2385             ||START||
2386             `======='
2387                 |
2388                 | open F
2389                 |
2390                 |    F ENOENT
2391                 |`---------------------------------------------------.
2392       F OPEN OK |                                                    |
2393                 |`---------------- - - -                             |
2394        D ENOENT |       D EXISTS   see OVERALL STATES diagram        |
2395                 |                  for full startup logic            |
2396      ,--------->|                                                    |
2397      |          V                                                    |
2398      |     ============                                       try to |
2399      |      NORMAL                                            open D |
2400      |     [Normal]                                                  |
2401      |      main F tail                                              |
2402      |     ============                                              V
2403      |          |                                                    |
2404      |          | F IS SO BIG WE SHOULD FLUSH, OR TIMEOUT            |
2405      ^          | hardlink F to D                                    |
2406      |     [Hardlinked]                                              |
2407      |          | unlink F                                           |
2408      |          | our handle onto F is now onto D                    |
2409      |     [Moved]                                                   |
2410      |          |                                                    |
2411      |          |<-------------------<---------------------<---------+
2412      |          |                                                    |
2413      |          | spawn inndcomm flush                               |
2414      |          V                                                    |
2415      |     ==================                                        |
2416      |      FLUSHING[-ABSENT]                                        |
2417      |     [Flushing]                                                |
2418      |     main D tail/none                                          |
2419      |     ==================                                        |
2420      |          |                                                    |
2421      |          |   INNDCOMM FLUSH FAILS                             ^
2422      |          |`----------------------->----------.                |
2423      |          |                                   |                |
2424      |          |   NO SUCH SITE                    V                |
2425      ^          |`--------------->----.         ==================== |
2426      |          |                      \        FLUSHFAILED[-ABSENT] |
2427      |          |                       \         [Moved]            |
2428      |          | FLUSH OK               \       main D tail/none    |
2429      |          | open F                  \     ==================== |
2430      |          |                          \        |                |
2431      |          |                           \       | TIME TO RETRY  |
2432      |          |`------->----.     ,---<---'\      `----------------'
2433      |          |    D NONE   |     | D NONE  `----.
2434      |          V             |     |              V
2435      |     =============      V     V             ============
2436      |      SEPARATED-1       |     |              DROPPING-1
2437      |      flsh->rd!=0       |     |              flsh->rd!=0
2438      |     [Separated]        |     |             [Dropping]
2439      |      main F idle       |     |              main none
2440      |      flsh D tail       |     |              flsh D tail
2441      |     =============      |     |             ============
2442      |          |             |     | install       |
2443      ^          | EOF ON D    |     |  defer        | EOF ON D
2444      |          V             |     |               V
2445      |     ===============    |     |             ===============
2446      |      SEPARATED-2       |     |              DROPPING-2
2447      |      flsh->rd==0       |     V              flsh->rd==0
2448      |     [Finishing]        |     |             [Dropping]
2449      |      main F tail       |     `.             main none
2450      |      flsh D closed     |       `.           flsh D closed
2451      |     ===============    V         `.        ===============
2452      |          |                         `.          |
2453      |          | ALL D PROCESSED           `.        | ALL D PROCESSED
2454      |          V install defer as backlog    `.      | install defer
2455      ^          | close D                       `.    | close D
2456      |          | unlink D                        `.  | unlink D
2457      |          |                                  |  |
2458      |          |                                  V  V
2459      `----------'                               ==============
2460                                                  DROPPED
2461                                                 [Dropped]
2462                                                  main none
2463                                                  flsh none
2464                                                  some backlog
2465                                                 ==============
2466                                                       |
2467                                                       | ALL BACKLOG DONE
2468                                                       |
2469                                                       | unlink lock
2470                                                       | exit
2471                                                       V
2472                                                   ==========
2473                                                    (ESRCH)
2474                                                   [Droppped]
2475                                                   ==========
2476  * ->8-
2477  */
2478
2479 static void startup_set_input_file(InputFile *f) {
2480   assert(!main_input_file);
2481   main_input_file= f;
2482   inputfile_reading_start(f);
2483 }
2484
2485 static void statemc_lock(void) {
2486   int lockfd;
2487   struct stat stab, stabf;
2488   
2489   for (;;) {
2490     lockfd= open(path_lock, O_CREAT|O_RDWR, 0600);
2491     if (lockfd<0) sysfatal("open lockfile %s", path_lock);
2492
2493     struct flock fl;
2494     memset(&fl,0,sizeof(fl));
2495     fl.l_type= F_WRLCK;
2496     fl.l_whence= SEEK_SET;
2497     int r= fcntl(lockfd, F_SETLK, &fl);
2498     if (r==-1) {
2499       if (errno==EACCES || isewouldblock(errno)) {
2500         if (quiet_multiple) exit(0);
2501         fatal("another duct holds the lockfile");
2502       }
2503       sysfatal("fcntl F_SETLK lockfile %s", path_lock);
2504     }
2505
2506     xfstat_isreg(lockfd, &stabf, path_lock, "lockfile");
2507     int lock_noent;
2508     xlstat_isreg(path_lock, &stab, &lock_noent, "lockfile");
2509
2510     if (!lock_noent && samefile(&stab, &stabf))
2511       break;
2512
2513     xclose(lockfd, "stale lockfile ", path_lock);
2514   }
2515
2516   FILE *lockfile= fdopen(lockfd, "w");
2517   if (!lockfile) sysdie("fdopen lockfile");
2518
2519   int r= ftruncate(lockfd, 0);
2520   if (r) sysdie("truncate lockfile to write new info");
2521
2522   if (fprintf(lockfile, "pid %ld\nsite %s\nfeedfile %s\nfqdn %s\n",
2523               (unsigned long)self_pid,
2524               sitename, feedfile, remote_host) == EOF ||
2525       fflush(lockfile))
2526     sysfatal("write info to lockfile %s", path_lock);
2527
2528   debug("startup: locked");
2529 }
2530
2531 static void statemc_init(void) {
2532   struct stat stabdefer;
2533
2534   search_backlog_file();
2535
2536   int defer_noent;
2537   xlstat_isreg(path_defer, &stabdefer, &defer_noent, "defer file");
2538   if (defer_noent) {
2539     debug("startup: ductdefer ENOENT");
2540   } else {
2541     debug("startup: ductdefer nlink=%ld", (long)stabdefer.st_nlink);
2542     switch (stabdefer.st_nlink==1) {
2543     case 1:
2544       open_defer(); /* so that we will later close it and rename it */
2545       break;
2546     case 2:
2547       xunlink(path_defer, "stale defer file link"
2548               " (presumably hardlink to backlog file)");
2549       break;
2550     default:
2551       die("defer file %s has unexpected link count %d",
2552           path_defer, stabdefer.st_nlink);
2553     }
2554   }
2555
2556   struct stat stab_f, stab_d;
2557   int noent_f;
2558
2559   InputFile *file_d= open_input_file(path_flushing);
2560   if (file_d) xfstat_isreg(file_d->fd, &stab_d, path_flushing,"flushing file");
2561
2562   xlstat_isreg(feedfile, &stab_f, &noent_f, "feedfile");
2563
2564   if (!noent_f && file_d && samefile(&stab_f, &stab_d)) {
2565     debug("startup: F==D => Hardlinked");
2566     xunlink(feedfile, "feed file (during startup)"); /* => Moved */
2567     noent_f= 1;
2568   }
2569
2570   if (noent_f) {
2571     debug("startup: F ENOENT => Moved");
2572     if (file_d) startup_set_input_file(file_d);
2573     spawn_inndcomm_flush("feedfile missing at startup");
2574     /* => Flushing, sms:=FLUSHING */
2575   } else {
2576     if (file_d) {
2577       debug("startup: F!=D => Separated");
2578       startup_set_input_file(file_d);
2579       flushing_input_file= main_input_file;
2580       main_input_file= open_input_file(feedfile);
2581       if (!main_input_file) die("feedfile vanished during startup");
2582       SMS(SEPARATED, max_separated_periods,
2583           "found both old and current feed files");
2584     } else {
2585       debug("startup: F exists, D ENOENT => Normal");
2586       InputFile *file_f= open_input_file(feedfile);
2587       if (!file_f) die("feed file vanished during startup");
2588       startup_set_input_file(file_f);
2589       SMS(NORMAL, spontaneous_flush_periods, "normal startup");
2590     }
2591   }
2592 }
2593
2594 static void statemc_start_flush(const char *why) { /* Normal => Flushing */
2595   assert(sms == sm_NORMAL);
2596
2597   debug("starting flush (%s) (%lu >?= %lu) (%d)",
2598         why,
2599         (unsigned long)(main_input_file ? main_input_file->offset : 0),
2600         (unsigned long)target_max_feedfile_size,
2601         until_flush);
2602
2603   int r= link(feedfile, path_flushing);
2604   if (r) sysfatal("link feedfile %s to flushing file %s",
2605                   feedfile, path_flushing);
2606   /* => Hardlinked */
2607
2608   xunlink(feedfile, "old feedfile link");
2609   /* => Moved */
2610
2611   spawn_inndcomm_flush(why); /* => Flushing FLUSHING */
2612 }
2613
2614 static int trigger_flush_ok(const char *why) {
2615   switch (sms) {
2616
2617   case sm_NORMAL:
2618     statemc_start_flush(why ? why : "periodic");
2619     return 1;                           /* Normal => Flushing; => FLUSHING */
2620
2621   case sm_FLUSHFAILED:
2622     spawn_inndcomm_flush(why ? why : "retry");
2623     return 1;                            /* Moved => Flushing; => FLUSHING */
2624
2625   case sm_SEPARATED:
2626   case sm_DROPPING:
2627     warn("abandoning old feedfile after flush (%s), autodeferring",
2628          why ? why : "took too long to complete");
2629     assert(flushing_input_file);
2630     autodefer_input_file(flushing_input_file);
2631     return 1;
2632
2633   default:
2634     return 0;
2635   }
2636 }
2637
2638 static void statemc_period_poll(void) {
2639   if (!until_flush) return;
2640   until_flush--;
2641   assert(until_flush>=0);
2642
2643   if (until_flush) return;
2644   int ok= trigger_flush_ok(0);
2645   assert(ok);
2646 }
2647
2648 static int inputfile_is_done(InputFile *ipf) {
2649   if (!ipf) return 0;
2650   if (ipf->inprogress) return 0; /* new article in the meantime */
2651   if (ipf->rd) return 0; /* not had EOF */
2652   return 1;
2653 }
2654
2655 static void notice_processed(InputFile *ipf, int completed,
2656                              const char *what, const char *spec) {
2657   if (!ipf) return; /* allows preterminate to be lazy */
2658
2659 #define RCI_NOTHING(x) /* nothing */
2660 #define RCI_TRIPLE_FMT(x) " " #x "=" RCI_TRIPLE_FMT_BASE
2661 #define RCI_TRIPLE_VALS(x) , RCI_TRIPLE_VALS_BASE(ipf->counts, [RC_##x])
2662
2663 #define CNT(art,rc) (ipf->counts[art_##art][RC_##rc])
2664
2665   char *inprog= completed
2666     ? xasprintf("%s","") /* GCC produces a stupid warning for printf("") ! */
2667     : xasprintf(" inprogress=%ld", ipf->inprogress);
2668   char *autodefer= ipf->autodefer >= 0
2669     ? xasprintf(" autodeferred=%ld", ipf->autodefer)
2670     : xasprintf("%s","");
2671
2672   info("%s %s%s read=%d (+bl=%d,+err=%d)%s%s"
2673        " missing=%d offered=%d (ch=%d,nc=%d) accepted=%d (ch=%d,nc=%d)"
2674        RESULT_COUNTS(RCI_NOTHING, RCI_TRIPLE_FMT)
2675        ,
2676        completed?"completed":"processed", what, spec,
2677        ipf->readcount_ok, ipf->readcount_blank, ipf->readcount_err,
2678        inprog, autodefer, ipf->count_nooffer_missing,
2679        CNT(Unchecked,sent) + CNT(Unsolicited,sent)
2680        , CNT(Unchecked,sent), CNT(Unsolicited,sent),
2681        CNT(Wanted,accepted) + CNT(Unsolicited,accepted)
2682        , CNT(Wanted,accepted), CNT(Unsolicited,accepted)
2683        RESULT_COUNTS(RCI_NOTHING,  RCI_TRIPLE_VALS)
2684        );
2685
2686   free(inprog);
2687   free(autodefer);
2688
2689 #undef CNT
2690 }
2691
2692 static void statemc_check_backlog_done(void) {
2693   InputFile *ipf= backlog_input_file;
2694   if (!inputfile_is_done(ipf)) return;
2695
2696   const char *slash= strrchr(ipf->path, '/');
2697   const char *leaf= slash ? slash+1 : ipf->path;
2698   const char *under= strchr(slash, '_');
2699   const char *rest= under ? under+1 : leaf;
2700   if (!strncmp(rest,"backlog",7)) rest += 7;
2701   notice_processed(ipf,1,"backlog ",rest);
2702
2703   close_input_file(ipf);
2704   if (unlink(ipf->path)) {
2705     if (errno != ENOENT)
2706       sysdie("could not unlink processed backlog file %s", ipf->path);
2707     warn("backlog file %s vanished while we were reading it"
2708          " so we couldn't remove it (but it's done now, anyway)",
2709          ipf->path);
2710   }
2711   free(ipf);
2712   backlog_input_file= 0;
2713   search_backlog_file();
2714   return;
2715 }
2716
2717 static void statemc_check_flushing_done(void) {
2718   InputFile *ipf= flushing_input_file;
2719   if (!inputfile_is_done(ipf)) return;
2720
2721   assert(sms==sm_SEPARATED || sms==sm_DROPPING);
2722
2723   notice_processed(ipf,1,"feedfile","");
2724
2725   close_defer();
2726
2727   xunlink(path_flushing, "old flushing file");
2728
2729   close_input_file(flushing_input_file);
2730   free(flushing_input_file);
2731   flushing_input_file= 0;
2732
2733   if (sms==sm_SEPARATED) {
2734     notice("flush complete");
2735     SMS(NORMAL, spontaneous_flush_periods, "flush complete");
2736   } else if (sms==sm_DROPPING) {
2737     SMS(DROPPED, max_separated_periods, "old flush complete");
2738     search_backlog_file();
2739     notice("feed dropped, but will continue until backlog is finished");
2740   }
2741 }
2742
2743 static void *statemc_check_input_done(oop_source *lp, struct timeval now,
2744                                       void *u) {
2745   assert(!inputfile_is_done(main_input_file));
2746   statemc_check_flushing_done();
2747   statemc_check_backlog_done();
2748   return OOP_CONTINUE;
2749 }
2750
2751 static void queue_check_input_done(void) {
2752   loop->on_time(loop, OOP_TIME_NOW, statemc_check_input_done, 0);
2753 }
2754
2755 static void statemc_setstate(StateMachineState newsms, int periods,
2756                              const char *forlog, const char *why) {
2757   sms= newsms;
2758   until_flush= periods;
2759
2760   const char *xtra= "";
2761   switch (sms) {
2762   case sm_FLUSHING:
2763   case sm_FLUSHFAILED:
2764     if (!main_input_file) xtra= "-ABSENT";
2765     break;
2766   case sm_SEPARATED:
2767   case sm_DROPPING:
2768     xtra= flushing_input_file->rd ? "-1" : "-2";
2769     break;
2770   default:;
2771   }
2772
2773   if (periods) {
2774     info("state %s%s[%d] %s",forlog,xtra,periods,why);
2775   } else {
2776     info("state %s%s %s",forlog,xtra,why);
2777   }
2778 }
2779
2780 /*---------- defer and backlog files ----------*/
2781
2782 static void open_defer(void) {
2783   struct stat stab;
2784
2785   if (defer) return;
2786
2787   defer= fopen(path_defer, "a+");
2788   if (!defer) sysfatal("could not open defer file %s", path_defer);
2789
2790   /* truncate away any half-written records */
2791
2792   xfstat_isreg(fileno(defer), &stab, path_defer, "newly opened defer file");
2793
2794   if (stab.st_size > LONG_MAX)
2795     die("defer file %s size is far too large", path_defer);
2796
2797   if (!stab.st_size)
2798     return;
2799
2800   long orgsize= stab.st_size;
2801   long truncto= stab.st_size;
2802   for (;;) {
2803     if (!truncto) break; /* was only (if anything) one half-truncated record */
2804     if (fseek(defer, truncto-1, SEEK_SET) < 0)
2805       sysdie("seek in defer file %s while truncating partial", path_defer);
2806
2807     int r= getc(defer);
2808     if (r==EOF) {
2809       if (ferror(defer))
2810         sysdie("failed read from defer file %s", path_defer);
2811       else
2812         die("defer file %s shrank while we were checking it!", path_defer);
2813     }
2814     if (r=='\n') break;
2815     truncto--;
2816   }
2817
2818   if (stab.st_size != truncto) {
2819     warn("truncating half-record at end of defer file %s -"
2820          " shrinking by %ld bytes from %ld to %ld",
2821          path_defer, orgsize - truncto, orgsize, truncto);
2822
2823     if (fflush(defer))
2824       sysfatal("could not flush defer file %s", path_defer);
2825     if (ftruncate(fileno(defer), truncto))
2826       sysdie("could not truncate defer file %s", path_defer);
2827
2828   } else {
2829     info("continuing existing defer file %s (%ld bytes)",
2830          path_defer, orgsize);
2831   }
2832   if (fseek(defer, truncto, SEEK_SET))
2833     sysdie("could not seek to new end of defer file %s", path_defer);
2834 }
2835
2836 static void close_defer(void) {
2837   if (!defer)
2838     return;
2839
2840   struct stat stab;
2841   xfstat_isreg(fileno(defer), &stab, path_defer, "defer file");
2842
2843   if (fclose(defer)) sysfatal("could not close defer file %s", path_defer);
2844   defer= 0;
2845
2846   time_t now= xtime();
2847
2848   char *backlog= xasprintf("%s_backlog_%lu.%lu", feedfile,
2849                            (unsigned long)now,
2850                            (unsigned long)stab.st_ino);
2851   if (link(path_defer, backlog))
2852     sysfatal("could not install defer file %s as backlog file %s",
2853            path_defer, backlog);
2854   if (unlink(path_defer))
2855     sysdie("could not unlink old defer link %s to backlog file %s",
2856            path_defer, backlog);
2857
2858   free(backlog);
2859
2860   if (until_backlog_nextscan < 0 ||
2861       until_backlog_nextscan > backlog_retry_minperiods + 1)
2862     until_backlog_nextscan= backlog_retry_minperiods + 1;
2863 }
2864
2865 static void poll_backlog_file(void) {
2866   if (until_backlog_nextscan < 0) return;
2867   if (until_backlog_nextscan-- > 0) return;
2868   search_backlog_file();
2869 }
2870
2871 static void search_backlog_file(void) {
2872   /* returns non-0 iff there are any backlog files */
2873
2874   glob_t gl;
2875   int r, i;
2876   struct stat stab;
2877   const char *oldest_path=0;
2878   time_t oldest_mtime=0, now;
2879
2880   if (backlog_input_file) return;
2881
2882  try_again:
2883
2884   r= glob(globpat_backlog, GLOB_ERR|GLOB_MARK|GLOB_NOSORT, 0, &gl);
2885
2886   switch (r) {
2887   case GLOB_ABORTED:
2888     sysfatal("failed to expand backlog pattern %s", globpat_backlog);
2889   case GLOB_NOSPACE:
2890     fatal("out of memory expanding backlog pattern %s", globpat_backlog);
2891   case 0:
2892     for (i=0; i<gl.gl_pathc; i++) {
2893       const char *path= gl.gl_pathv[i];
2894
2895       if (strchr(path,'#') || strchr(path,'~')) {
2896         debug("backlog file search skipping %s", path);
2897         continue;
2898       }
2899       r= stat(path, &stab);
2900       if (r) {
2901         syswarn("failed to stat backlog file %s", path);
2902         continue;
2903       }
2904       if (!S_ISREG(stab.st_mode)) {
2905         warn("backlog file %s is not a plain file (or link to one)", path);
2906         continue;
2907       }
2908       if (!oldest_path || stab.st_mtime < oldest_mtime) {
2909         oldest_path= path;
2910         oldest_mtime= stab.st_mtime;
2911       }
2912     }
2913   case GLOB_NOMATCH: /* fall through */
2914     break;
2915   default:
2916     sysdie("glob expansion of backlog pattern %s gave unexpected"
2917            " nonzero (error?) return value %d", globpat_backlog, r);
2918   }
2919
2920   if (!oldest_path) {
2921     debug("backlog scan: none");
2922
2923     if (sms==sm_DROPPED) {
2924       preterminate();
2925       notice("feed dropped and our work is complete");
2926
2927       int r= unlink(path_cli);
2928       if (r && errno!=ENOENT)
2929         syswarn("failed to unlink cli socket for old feed");
2930
2931       xunlink(path_lock, "lockfile for old feed");
2932       exit(4);
2933     }
2934     until_backlog_nextscan= backlog_spontrescan_periods;
2935     goto xfree;
2936   }
2937
2938   now= xtime();
2939   double age= difftime(now, oldest_mtime);
2940   long age_deficiency= (backlog_retry_minperiods * period_seconds) - age;
2941
2942   if (age_deficiency <= 0) {
2943     debug("backlog scan: found age=%f deficiency=%ld oldest=%s",
2944           age, age_deficiency, oldest_path);
2945
2946     backlog_input_file= open_input_file(oldest_path);
2947     if (!backlog_input_file) {
2948       warn("backlog file %s vanished as we opened it", oldest_path);
2949       globfree(&gl);
2950       goto try_again;
2951     }
2952     inputfile_reading_start(backlog_input_file);
2953     until_backlog_nextscan= -1;
2954     goto xfree;
2955   }
2956
2957   until_backlog_nextscan= age_deficiency / period_seconds;
2958
2959   if (backlog_spontrescan_periods >= 0 &&
2960       until_backlog_nextscan > backlog_spontrescan_periods)
2961     until_backlog_nextscan= backlog_spontrescan_periods;
2962
2963   debug("backlog scan: young age=%f deficiency=%ld nextscan=%d oldest=%s",
2964         age, age_deficiency, until_backlog_nextscan, oldest_path);
2965
2966  xfree:
2967   globfree(&gl);
2968   return;
2969 }
2970
2971 /*---------- shutdown and signal handling ----------*/
2972
2973 static void preterminate(void) {
2974   if (in_child) return;
2975   notice_processed(main_input_file,0,"feedfile","");
2976   notice_processed(flushing_input_file,0,"flushing","");
2977   if (backlog_input_file)
2978     notice_processed(backlog_input_file,0, "backlog file ",
2979                      backlog_input_file->path);
2980 }
2981
2982 static int signal_self_pipe[2];
2983 static sig_atomic_t terminate_sig_flag;
2984
2985 static void raise_default(int signo) {
2986   xsigsetdefault(signo);
2987   raise(signo);
2988   abort();
2989 }
2990
2991 static void *sigarrived_event(oop_source *lp, int fd, oop_event e, void *u) {
2992   assert(fd=signal_self_pipe[0]);
2993   char buf[PIPE_BUF];
2994   int r= read(signal_self_pipe[0], buf, sizeof(buf));
2995   if (r<0 && !isewouldblock(errno)) sysdie("failed to read signal self pipe");
2996   if (r==0) die("eof on signal self pipe");
2997   if (terminate_sig_flag) {
2998     preterminate();
2999     notice("terminating (%s)", strsignal(terminate_sig_flag));
3000     raise_default(terminate_sig_flag);
3001   }
3002   return OOP_CONTINUE;
3003 }
3004
3005 static void sigarrived_handler(int signum) {
3006   static char x;
3007   switch (signum) {
3008   case SIGTERM:
3009   case SIGINT:
3010     if (!terminate_sig_flag) terminate_sig_flag= signum;
3011     break;
3012   default:
3013     abort();
3014   }
3015   write(signal_self_pipe[1],&x,1);
3016 }
3017
3018 static void init_signals(void) {
3019   if (signal(SIGPIPE, SIG_IGN) == SIG_ERR)
3020     sysdie("could not ignore SIGPIPE");
3021
3022   if (pipe(signal_self_pipe)) sysfatal("create self-pipe for signals");
3023
3024   xsetnonblock(signal_self_pipe[0],1);
3025   xsetnonblock(signal_self_pipe[1],1);
3026
3027   struct sigaction sa;
3028   memset(&sa,0,sizeof(sa));
3029   sa.sa_handler= sigarrived_handler;
3030   sa.sa_flags= SA_RESTART;
3031   xsigaction(SIGTERM,&sa);
3032   xsigaction(SIGINT,&sa);
3033
3034   on_fd_read_except(signal_self_pipe[0], sigarrived_event);
3035 }
3036
3037 /*========== flushing the feed ==========*/
3038
3039 static pid_t inndcomm_child;
3040 static int inndcomm_sentinel_fd;
3041
3042 static void *inndcomm_event(oop_source *lp, int fd, oop_event e, void *u) {
3043   assert(inndcomm_child);
3044   assert(fd == inndcomm_sentinel_fd);
3045   int status= xwaitpid(&inndcomm_child, "inndcomm");
3046   inndcomm_child= 0;
3047   
3048   cancel_fd_read_except(fd);
3049   xclose_perhaps(&fd, "inndcomm sentinel pipe",0);
3050   inndcomm_sentinel_fd= 0;
3051
3052   assert(!flushing_input_file);
3053
3054   if (WIFEXITED(status)) {
3055     switch (WEXITSTATUS(status)) {
3056
3057     case INNDCOMMCHILD_ESTATUS_FAIL:
3058       goto failed;
3059
3060     case INNDCOMMCHILD_ESTATUS_NONESUCH:
3061       notice("feed has been dropped by innd, finishing up");
3062       flushing_input_file= main_input_file;
3063       tailing_make_readable(flushing_input_file);
3064         /* we probably previously returned EAGAIN from our fake read method
3065          * when in fact we were at EOF, so signal another readable event
3066          * so we actually see the EOF */
3067
3068       main_input_file= 0;
3069
3070       if (flushing_input_file) {
3071         SMS(DROPPING, max_separated_periods,
3072             "feed dropped by innd, but must finish last flush");
3073       } else {
3074         close_defer();
3075         SMS(DROPPED, 0, "feed dropped by innd");
3076         search_backlog_file();
3077       }
3078       return OOP_CONTINUE;
3079
3080     case 0:
3081       /* as above */
3082       flushing_input_file= main_input_file;
3083       tailing_make_readable(flushing_input_file);
3084
3085       main_input_file= open_input_file(feedfile);
3086       if (!main_input_file)
3087         die("flush succeeded but feedfile %s does not exist!"
3088             " (this probably means feedfile does not correspond"
3089             " to site %s in newsfeeds)", feedfile, sitename);
3090
3091       if (flushing_input_file) {
3092         SMS(SEPARATED, max_separated_periods, "flush complete");
3093       } else {
3094         close_defer();
3095         SMS(NORMAL, spontaneous_flush_periods, "recovery flush complete");
3096       }
3097       return OOP_CONTINUE;
3098
3099     default:
3100       goto unexpected_exitstatus;
3101
3102     }
3103   } else if (WIFSIGNALED(status) && WTERMSIG(status) == SIGALRM) {
3104     warn("flush timed out trying to talk to innd");
3105     goto failed;
3106   } else {
3107   unexpected_exitstatus:
3108     report_child_status("inndcomm child", status);
3109   }
3110
3111  failed:
3112   SMS(FLUSHFAILED, flushfail_retry_periods, "flush failed, will retry");
3113   return OOP_CONTINUE;
3114 }
3115
3116 static void inndcommfail(const char *what) {
3117   syswarn("error communicating with innd: %s failed: %s", what, ICCfailure);
3118   exit(INNDCOMMCHILD_ESTATUS_FAIL);
3119 }
3120
3121 void spawn_inndcomm_flush(const char *why) { /* Moved => Flushing */
3122   int pipefds[2];
3123
3124   notice("flushing %s",why);
3125
3126   assert(sms==sm_NORMAL || sms==sm_FLUSHFAILED);
3127   assert(!inndcomm_child);
3128   assert(!inndcomm_sentinel_fd);
3129
3130   if (pipe(pipefds)) sysfatal("create pipe for inndcomm child sentinel");
3131
3132   inndcomm_child= xfork("inndcomm child");
3133
3134   if (!inndcomm_child) {
3135     const char *flushargv[2]= { sitename, 0 };
3136     char *reply;
3137     int r;
3138
3139     xclose(pipefds[0], "(in child) inndcomm sentinel parent's end",0);
3140     /* parent spots the autoclose of pipefds[1] when we die or exit */
3141
3142     if (simulate_flush>=0) {
3143       warn("SIMULATING flush child status %d", simulate_flush);
3144       if (simulate_flush>128) raise(simulate_flush-128);
3145       else exit(simulate_flush);
3146     }
3147
3148     alarm(inndcomm_flush_timeout);
3149     r= ICCopen();                         if (r)   inndcommfail("connect");
3150     r= ICCcommand('f',flushargv,&reply);  if (r<0) inndcommfail("transmit");
3151     if (!r) exit(0); /* yay! */
3152
3153     if (!strcmp(reply, "1 No such site")) exit(INNDCOMMCHILD_ESTATUS_NONESUCH);
3154     syswarn("innd ctlinnd flush failed: innd said %s", reply);
3155     exit(INNDCOMMCHILD_ESTATUS_FAIL);
3156   }
3157
3158   simulate_flush= -1;
3159
3160   xclose(pipefds[1], "inndcomm sentinel child's end",0);
3161   inndcomm_sentinel_fd= pipefds[0];
3162   assert(inndcomm_sentinel_fd);
3163   on_fd_read_except(inndcomm_sentinel_fd, inndcomm_event);
3164
3165   SMS(FLUSHING, 0, why);
3166 }
3167
3168 /*========== main program ==========*/
3169
3170 static void postfork_inputfile(InputFile *ipf) {
3171   if (!ipf) return;
3172   xclose(ipf->fd, "(in child) input file ", ipf->path);
3173 }
3174
3175 static void postfork_stdio(FILE *f, const char *what, const char *what2) {
3176   /* we have no stdio streams that are buffered long-term */
3177   if (!f) return;
3178   if (fclose(f)) sysdie("(in child) close %s%s", what, what2?what2:0);
3179 }
3180
3181 static void postfork(void) {
3182   in_child= 1;
3183
3184   xsigsetdefault(SIGTERM);
3185   xsigsetdefault(SIGINT);
3186   xsigsetdefault(SIGPIPE);
3187   if (terminate_sig_flag) raise(terminate_sig_flag);
3188
3189   postfork_inputfile(main_input_file);
3190   postfork_inputfile(flushing_input_file);
3191
3192   Conn *conn;
3193   FOR_CONN(conn)
3194     conn_closefd(conn,"(in child) ");
3195
3196   postfork_stdio(defer, "defer file ", path_defer);
3197 }
3198
3199 typedef struct Every Every;
3200 struct Every {
3201   struct timeval interval;
3202   int fixed_rate;
3203   void (*f)(void);
3204 };
3205
3206 static void every_schedule(Every *e, struct timeval base);
3207
3208 static void *every_happens(oop_source *lp, struct timeval base, void *e_v) {
3209   Every *e= e_v;
3210   e->f();
3211   if (!e->fixed_rate) xgettimeofday(&base);
3212   every_schedule(e, base);
3213   return OOP_CONTINUE;
3214 }
3215
3216 static void every_schedule(Every *e, struct timeval base) {
3217   struct timeval when;
3218   timeradd(&base, &e->interval, &when);
3219   loop->on_time(loop, when, every_happens, e);
3220 }
3221
3222 static void every(int interval, int fixed_rate, void (*f)(void)) {
3223   NEW_DECL(Every *,e);
3224   e->interval.tv_sec= interval;
3225   e->interval.tv_usec= 0;
3226   e->fixed_rate= fixed_rate;
3227   e->f= f;
3228   struct timeval now;
3229   xgettimeofday(&now);
3230   every_schedule(e, now);
3231 }
3232
3233 static void filepoll(void) {
3234   tailing_make_readable(main_input_file);
3235   tailing_make_readable(flushing_input_file);
3236 }
3237
3238 static char *debug_report_ipf(InputFile *ipf) {
3239   if (!ipf) return xasprintf("none");
3240
3241   const char *slash= strrchr(ipf->path,'/');
3242   const char *path= slash ? slash+1 : ipf->path;
3243
3244   return xasprintf("%p/%s:queue=%d,ip=%ld,autodef=%ld,off=%ld,fd=%d%s%s%s",
3245                    ipf, path,
3246                    ipf->queue.count, ipf->inprogress, ipf->autodefer,
3247                    (long)ipf->offset, ipf->fd,
3248                    ipf->rd ? "" : ",!rd",
3249                    ipf->skippinglong ? "*skiplong" : "",
3250                    ipf->rd && ipf->paused ? "*paused" : "");
3251 }
3252
3253 static void period(void) {
3254   char *dipf_main=     debug_report_ipf(main_input_file);
3255   char *dipf_flushing= debug_report_ipf(flushing_input_file);
3256   char *dipf_backlog=  debug_report_ipf(backlog_input_file);
3257
3258   debug("PERIOD"
3259         " sms=%s[%d] conns=%d until_connect=%d"
3260         " input_files main:%s flushing:%s backlog:%s[%d]"
3261         " children connecting=%ld inndcomm=%ld"
3262         ,
3263         sms_names[sms], until_flush, conns.count, until_connect,
3264         dipf_main, dipf_flushing, dipf_backlog, until_backlog_nextscan,
3265         (long)connecting_child, (long)inndcomm_child
3266         );
3267
3268   free(dipf_main);
3269   free(dipf_flushing);
3270   free(dipf_backlog);
3271
3272   if (until_connect) until_connect--;
3273
3274   inputfile_queue_check_expired(backlog_input_file);
3275   poll_backlog_file();
3276   if (!backlog_input_file) close_defer(); /* want to start on a new backlog */
3277   statemc_period_poll();
3278   check_assign_articles();
3279   check_idle_conns();
3280 }
3281
3282
3283 /*========== dumping state ==========*/
3284
3285 static void dump_article_list(FILE *f, const CliCommand *c,
3286                               const ArticleList *al) {
3287   fprintf(f, " count=%d\n", al->count);
3288   if (!c->xval) return;
3289   
3290   int i; Article *art;
3291   for (i=0, art=LIST_HEAD(*al); art; i++, art=LIST_NEXT(art)) {
3292     fprintf(f," #%05d %-11s", i, artstate_names[art->state]);
3293     DUMPV("%p", art->,ipf);
3294     DUMPV("%d", art->,missing);
3295     DUMPV("%lu", (unsigned long)art->,offset);
3296     DUMPV("%d", art->,blanklen);
3297     DUMPV("%d", art->,midlen);
3298     fprintf(f, " %s %s\n", TokenToText(art->token), art->messageid);
3299   }
3300 }
3301   
3302 static void dump_input_file(FILE *f, const CliCommand *c,
3303                             InputFile *ipf, const char *wh) {
3304   char *dipf= debug_report_ipf(ipf);
3305   fprintf(f,"input %s %s", wh, dipf);
3306   free(dipf);
3307   
3308   if (ipf) {
3309     DUMPV("%d", ipf->,readcount_ok);
3310     DUMPV("%d", ipf->,readcount_blank);
3311     DUMPV("%d", ipf->,readcount_err);
3312     DUMPV("%d", ipf->,count_nooffer_missing);
3313   }
3314   fprintf(f,"\n");
3315   if (ipf) {
3316     ArtState state; const char *const *statename; 
3317     for (state=0, statename=artstate_names; *statename; state++,statename++) {
3318 #define RC_DUMP_FMT(x) " " #x "=%d"
3319 #define RC_DUMP_VAL(x) ,ipf->counts[state][RC_##x]
3320       fprintf(f,"input %s counts %-11s"
3321               RESULT_COUNTS(RC_DUMP_FMT,RC_DUMP_FMT) "\n",
3322               wh, *statename
3323               RESULT_COUNTS(RC_DUMP_VAL,RC_DUMP_VAL));
3324     }
3325     fprintf(f,"input %s queue", wh);
3326     dump_article_list(f,c,&ipf->queue);
3327   }
3328 }
3329
3330 CCMD(dump) {
3331   int i;
3332   fprintf(cc->out, "dumping state to %s\n", path_dump);
3333   FILE *f= fopen(path_dump, "w");
3334   if (!f) { fprintf(cc->out, "failed: open: %s\n", strerror(errno)); return; }
3335
3336   fprintf(f,"general");
3337   DUMPV("%s", sms_names,[sms]);
3338   DUMPV("%d", ,until_flush);
3339   DUMPV("%ld", (long),self_pid);
3340   DUMPV("%p", , defer);
3341   DUMPV("%d", , until_connect);
3342   DUMPV("%d", , until_backlog_nextscan);
3343   DUMPV("%d", , simulate_flush);
3344   fprintf(f,"\nnocheck");
3345   DUMPV("%#.10f", , accept_proportion);
3346   DUMPV("%d", , nocheck);
3347   DUMPV("%d", , nocheck_reported);
3348   fprintf(f,"\n");
3349
3350   fprintf(f,"special");
3351   DUMPV("%ld", (long),connecting_child);
3352   DUMPV("%d", , connecting_fdpass_sock);
3353   DUMPV("%d", , cli_master);
3354   fprintf(f,"\n");
3355
3356   fprintf(f,"filemon ");
3357   filemon_method_dump_info(f);
3358
3359   dump_input_file(f,c, main_input_file,     "main"    );
3360   dump_input_file(f,c, flushing_input_file, "flushing");
3361   dump_input_file(f,c, backlog_input_file,  "backlog" );
3362
3363   fprintf(f,"conns count=%d\n", conns.count);
3364
3365   Conn *conn;
3366   FOR_CONN(conn) {
3367
3368     fprintf(f,"C%d",conn->fd);
3369     DUMPV("%p",conn->,rd);             DUMPV("%d",conn->,max_queue);
3370     DUMPV("%d",conn->,stream);         DUMPV("%d",conn->,quitting);
3371     DUMPV("%d",conn->,since_activity);
3372     fprintf(f,"\n");
3373
3374     fprintf(f,"C%d waiting", conn->fd); dump_article_list(f,c,&conn->waiting);
3375     fprintf(f,"C%d priority",conn->fd); dump_article_list(f,c,&conn->priority);
3376     fprintf(f,"C%d sent",    conn->fd); dump_article_list(f,c,&conn->sent);
3377
3378     fprintf(f,"C%d xmit xmitu=%d\n", conn->fd, conn->xmitu);
3379     for (i=0; i<conn->xmitu; i++) {
3380       const struct iovec *iv= &conn->xmit[i];
3381       const XmitDetails *xd= &conn->xmitd[i];
3382       char *dinfo;
3383       switch (xd->kind) {
3384       case xk_Const:    dinfo= xasprintf("Const");                 break;
3385       case xk_Artdata:  dinfo= xasprintf("A%p", xd->info.sm_art);  break;
3386       default:
3387         abort();
3388       }
3389       fprintf(f," #%03d %-11s l=%d %s\n", i, dinfo, iv->iov_len,
3390               sanitise(iv->iov_base, iv->iov_len));
3391       free(dinfo);
3392     }
3393   }
3394
3395   fprintf(f,"paths");
3396   DUMPV("%s", , feedfile);
3397   DUMPV("%s", , path_cli);
3398   DUMPV("%s", , path_lock);
3399   DUMPV("%s", , path_flushing);
3400   DUMPV("%s", , path_defer);
3401   DUMPV("%s", , path_dump);
3402   DUMPV("%s", , globpat_backlog);
3403   fprintf(f,"\n");
3404
3405   if (!!ferror(f) + !!fclose(f)) {
3406     fprintf(cc->out, "failed: write: %s\n", strerror(errno));
3407     return;
3408   }
3409 }
3410
3411 /*========== option parsing ==========*/
3412
3413 static void vbadusage(const char *fmt, va_list al) NORET_PRINTF(1,0);
3414 static void vbadusage(const char *fmt, va_list al) {
3415   char *m= xvasprintf(fmt,al);
3416   fprintf(stderr, "bad usage: %s\n"
3417           "say --help for help, or read the manpage\n",
3418           m);
3419   if (become_daemon)
3420     syslog(LOG_CRIT,"innduct: invoked with bad usage: %s",m);
3421   exit(8);
3422 }
3423
3424 /*---------- generic option parser ----------*/
3425
3426 static void badusage(const char *fmt, ...) NORET_PRINTF(1,2);
3427 static void badusage(const char *fmt, ...) {
3428   va_list al;
3429   va_start(al,fmt);
3430   vbadusage(fmt,al);
3431 }
3432
3433 enum OptFlags {
3434   of_seconds= 001000u,
3435   of_boolean= 002000u,
3436 };
3437
3438 typedef struct Option Option;
3439 typedef void OptionParser(const Option*, const char *val);
3440
3441 struct Option {
3442   int shrt;
3443   const char *lng, *formarg;
3444   void *store;
3445   OptionParser *fn;
3446   int intval;
3447 };
3448
3449 static void parse_options(const Option *options, char ***argvp) {
3450   /* on return *argvp is first non-option arg; argc is not updated */
3451
3452   for (;;) {
3453     const char *arg= *++(*argvp);
3454     if (!arg) break;
3455     if (*arg != '-') break;
3456     if (!strcmp(arg,"--")) { arg= *++(*argvp); break; }
3457     int a;
3458     while ((a= *++arg)) {
3459       const Option *o;
3460       if (a=='-') {
3461         arg++;
3462         char *equals= strchr(arg,'=');
3463         int len= equals ? (equals - arg) : strlen(arg);
3464         for (o=options; o->shrt || o->lng; o++)
3465           if (strlen(o->lng) == len && !memcmp(o->lng,arg,len))
3466             goto found_long;
3467         badusage("unknown long option --%s",arg);
3468       found_long:
3469         if (!o->formarg) {
3470           if (equals) badusage("option --%s does not take a value",o->lng);
3471           arg= 0;
3472         } else if (equals) {
3473           arg= equals+1;
3474         } else {
3475           arg= *++(*argvp);
3476           if (!arg) badusage("option --%s needs a value for %s",
3477                              o->lng, o->formarg);
3478         }
3479         o->fn(o, arg);
3480         break; /* eaten the whole argument now */
3481       }
3482       for (o=options; o->shrt || o->lng; o++)
3483         if (a == o->shrt)
3484           goto found_short;
3485       badusage("unknown short option -%c",a);
3486     found_short:
3487       if (!o->formarg) {
3488         o->fn(o,0);
3489       } else {
3490         if (!*++arg) {
3491           arg= *++(*argvp);
3492           if (!arg) badusage("option -%c needs a value for %s",
3493                              o->shrt, o->formarg);
3494         }
3495         o->fn(o,arg);
3496         break; /* eaten the whole argument now */
3497       }
3498     }
3499   }
3500 }
3501
3502 #define DELIMPERHAPS(delim,str)  (str) ? (delim) : "", (str) ? (str) : ""
3503
3504 static void print_options(const Option *options, FILE *f) {
3505   const Option *o;
3506   for (o=options; o->shrt || o->lng; o++) {
3507     char shrt[2] = { o->shrt, 0 };
3508     char *optspec= xasprintf("%s%s%s%s%s",
3509                              o->shrt ? "-" : "", shrt,
3510                              o->shrt && o->lng ? "|" : "",
3511                              DELIMPERHAPS("--", o->lng));
3512     fprintf(f, "  %s%s%s\n", optspec, DELIMPERHAPS(" ", o->formarg));
3513     free(optspec);
3514   }
3515 }
3516
3517 /*---------- specific option types ----------*/
3518
3519 static void op_integer(const Option *o, const char *val) {
3520   char *ep;
3521   errno= 0;
3522   unsigned long ul= strtoul(val,&ep,10);
3523</