backends/innduct.c

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