lib/PublicInbox/V2Writable.pm

   1 # Copyright (C) 2018-2020 all contributors <meta@public-inbox.org>
   2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
   3
   4 # This interface wraps and mimics PublicInbox::Import
   5 # Used to write to V2 inboxes (see L<public-inbox-v2-format(5)>).
   6 package PublicInbox::V2Writable;
   7 use strict;
   8 use v5.10.1;
   9 use parent qw(PublicInbox::Lock);
  10 use PublicInbox::SearchIdxShard;
  11 use PublicInbox::IdxStack;
  12 use PublicInbox::Eml;
  13 use PublicInbox::Git;
  14 use PublicInbox::Import;
  15 use PublicInbox::MID qw(mids references);
  16 use PublicInbox::ContentHash qw(content_hash content_digest);
  17 use PublicInbox::InboxWritable;
  18 use PublicInbox::OverIdx;
  19 use PublicInbox::Msgmap;
  20 use PublicInbox::Spawn qw(spawn popen_rd);
  21 use PublicInbox::SearchIdx qw(log2stack crlf_adjust is_ancestor check_size);
  22 use IO::Handle; # ->autoflush
  23 use File::Temp qw(tempfile);
  24
  25 my $OID = qr/[a-f0-9]{40,}/;
  26 # an estimate of the post-packed size to the raw uncompressed size
  27 my $PACKING_FACTOR = 0.4;
  28
  29 # SATA storage lags behind what CPUs are capable of, so relying on
  30 # nproc(1) can be misleading and having extra Xapian shards is a
  31 # waste of FDs and space.  It can also lead to excessive IO latency
  32 # and slow things down.  Users on NVME or other fast storage can
  33 # use the NPROC env or switches in our script/public-inbox-* programs
  34 # to increase Xapian shards
  35 our $NPROC_MAX_DEFAULT = 4;
  36
  37 sub detect_nproc () {
  38         # getconf(1) is POSIX, but *NPROCESSORS* vars are not
  39         for (qw(_NPROCESSORS_ONLN NPROCESSORS_ONLN)) {
  40                 `getconf $_ 2>/dev/null` =~ /^(\d+)$/ and return $1;
  41         }
  42         for my $nproc (qw(nproc gnproc)) { # GNU coreutils nproc
  43                 `$nproc 2>/dev/null` =~ /^(\d+)$/ and return $1;
  44         }
  45
  46         # should we bother with `sysctl hw.ncpu`?  Those only give
  47         # us total processor count, not online processor count.
  48         undef
  49 }
  50
  51 sub nproc_shards ($) {
  52         my ($creat_opt) = @_;
  53         my $n = $creat_opt->{nproc} if ref($creat_opt) eq 'HASH';
  54         $n //= $ENV{NPROC};
  55         if (!$n) {
  56                 # assume 2 cores if not detectable or zero
  57                 state $NPROC_DETECTED = detect_nproc() || 2;
  58                 $n = $NPROC_DETECTED;
  59                 $n = $NPROC_MAX_DEFAULT if $n > $NPROC_MAX_DEFAULT;
  60         }
  61
  62         # subtract for the main process and git-fast-import
  63         $n -= 1;
  64         $n < 1 ? 1 : $n;
  65 }
  66
  67 sub count_shards ($) {
  68         my ($self) = @_;
  69         my $n = 0;
  70         my $xpfx = $self->{xpfx};
  71
  72         # always load existing shards in case core count changes:
  73         # Also, shard count may change while -watch is running
  74         # due to "xcpdb --reshard"
  75         if (-d $xpfx) {
  76                 my $XapianDatabase;
  77                 foreach my $shard (<$xpfx/*>) {
  78                         -d $shard && $shard =~ m!/[0-9]+\z! or next;
  79                         $XapianDatabase //= do {
  80                                 require PublicInbox::Search;
  81                                 PublicInbox::Search::load_xapian();
  82                                 $PublicInbox::Search::X{Database};
  83                         };
  84                         eval {
  85                                 $XapianDatabase->new($shard)->close;
  86                                 $n++;
  87                         };
  88                 }
  89         }
  90         $n;
  91 }
  92
  93 sub new {
  94         # $creat may be any true value, or 0/undef.  A hashref is true,
  95         # and $creat->{nproc} may be set to an integer
  96         my ($class, $v2ibx, $creat) = @_;
  97         $v2ibx = PublicInbox::InboxWritable->new($v2ibx);
  98         my $dir = $v2ibx->assert_usable_dir;
  99         unless (-d $dir) {
 100                 if ($creat) {
 101                         require File::Path;
 102                         File::Path::mkpath($dir);
 103                 } else {
 104                         die "$dir does not exist\n";
 105                 }
 106         }
 107         $v2ibx->umask_prepare;
 108
 109         my $xpfx = "$dir/xap" . PublicInbox::Search::SCHEMA_VERSION;
 110         my $self = {
 111                 ibx => $v2ibx,
 112                 im => undef, #  PublicInbox::Import
 113                 parallel => 1,
 114                 transact_bytes => 0,
 115                 total_bytes => 0,
 116                 current_info => '',
 117                 xpfx => $xpfx,
 118                 over => PublicInbox::OverIdx->new("$xpfx/over.sqlite3"),
 119                 lock_path => "$dir/inbox.lock",
 120                 # limit each git repo (epoch) to 1GB or so
 121                 rotate_bytes => int((1024 * 1024 * 1024) / $PACKING_FACTOR),
 122                 last_commit => [], # git epoch -> commit
 123         };
 124         $self->{over}->{-no_fsync} = 1 if $v2ibx->{-no_fsync};
 125         $self->{shards} = count_shards($self) || nproc_shards($creat);
 126         bless $self, $class;
 127 }
 128
 129 # public (for now?)
 130 sub init_inbox {
 131         my ($self, $shards, $skip_epoch, $skip_artnum) = @_;
 132         if (defined $shards) {
 133                 $self->{parallel} = 0 if $shards == 0;
 134                 $self->{shards} = $shards if $shards > 0;
 135         }
 136         $self->idx_init;
 137         $self->{mm}->skip_artnum($skip_artnum) if defined $skip_artnum;
 138         my $epoch_max = -1;
 139         git_dir_latest($self, \$epoch_max);
 140         if (defined $skip_epoch && $epoch_max == -1) {
 141                 $epoch_max = $skip_epoch;
 142         }
 143         $self->git_init($epoch_max >= 0 ? $epoch_max : 0);
 144         $self->done;
 145 }
 146
 147 # returns undef on duplicate or spam
 148 # mimics Import::add and wraps it for v2
 149 sub add {
 150         my ($self, $eml, $check_cb) = @_;
 151         $self->{ibx}->with_umask(\&_add, $self, $eml, $check_cb);
 152 }
 153
 154 sub batch_bytes ($) {
 155         my ($self) = @_;
 156         ($self->{parallel} ? $self->{shards} : 1) *
 157                 $PublicInbox::SearchIdx::BATCH_BYTES;
 158 }
 159
 160 # indexes a message, returns true if checkpointing is needed
 161 sub do_idx ($$$$) {
 162         my ($self, $msgref, $mime, $smsg) = @_;
 163         $smsg->{bytes} = $smsg->{raw_bytes} + crlf_adjust($$msgref);
 164         $self->{over}->add_overview($mime, $smsg);
 165         my $idx = idx_shard($self, $smsg->{num} % $self->{shards});
 166         $idx->index_raw($msgref, $mime, $smsg);
 167         my $n = $self->{transact_bytes} += $smsg->{raw_bytes};
 168         $n >= batch_bytes($self);
 169 }
 170
 171 sub _add {
 172         my ($self, $mime, $check_cb) = @_;
 173
 174         # spam check:
 175         if ($check_cb) {
 176                 $mime = $check_cb->($mime, $self->{ibx}) or return;
 177         }
 178
 179         # All pipes (> $^F) known to Perl 5.6+ have FD_CLOEXEC set,
 180         # as does SQLite 3.4.1+ (released in 2007-07-20), and
 181         # Xapian 1.3.2+ (released 2015-03-15).
 182         # For the most part, we can spawn git-fast-import without
 183         # leaking FDs to it...
 184         $self->idx_init;
 185
 186         my ($num, $mid0) = v2_num_for($self, $mime);
 187         defined $num or return; # duplicate
 188         defined $mid0 or die "BUG: \$mid0 undefined\n";
 189         my $im = $self->importer;
 190         my $smsg = bless { mid => $mid0, num => $num }, 'PublicInbox::Smsg';
 191         my $cmt = $im->add($mime, undef, $smsg); # sets $smsg->{ds|ts|blob}
 192         $cmt = $im->get_mark($cmt);
 193         $self->{last_commit}->[$self->{epoch_max}] = $cmt;
 194
 195         my $msgref = delete $smsg->{-raw_email};
 196         if (do_idx($self, $msgref, $mime, $smsg)) {
 197                 $self->checkpoint;
 198         }
 199
 200         $cmt;
 201 }
 202
 203 sub v2_num_for {
 204         my ($self, $mime) = @_;
 205         my $mids = mids($mime);
 206         if (@$mids) {
 207                 my $mid = $mids->[0];
 208                 my $num = $self->{mm}->mid_insert($mid);
 209                 if (defined $num) { # common case
 210                         return ($num, $mid);
 211                 }
 212
 213                 # crap, Message-ID is already known, hope somebody just resent:
 214                 foreach my $m (@$mids) {
 215                         # read-only lookup now safe to do after above barrier
 216                         # easy, don't store duplicates
 217                         # note: do not add more diagnostic info here since
 218                         # it gets noisy on public-inbox-watch restarts
 219                         return () if content_exists($self, $mime, $m);
 220                 }
 221
 222                 # AltId may pre-populate article numbers (e.g. X-Mail-Count
 223                 # or NNTP article number), use that article number if it's
 224                 # not in Over.
 225                 my $altid = $self->{ibx}->{altid};
 226                 if ($altid && grep(/:file=msgmap\.sqlite3\z/, @$altid)) {
 227                         my $num = $self->{mm}->num_for($mid);
 228
 229                         if (defined $num && !$self->{over}->get_art($num)) {
 230                                 return ($num, $mid);
 231                         }
 232                 }
 233
 234                 # very unlikely:
 235                 warn "<$mid> reused for mismatched content\n";
 236
 237                 # try the rest of the mids
 238                 for(my $i = $#$mids; $i >= 1; $i--) {
 239                         my $m = $mids->[$i];
 240                         $num = $self->{mm}->mid_insert($m);
 241                         if (defined $num) {
 242                                 warn "alternative <$m> for <$mid> found\n";
 243                                 return ($num, $m);
 244                         }
 245                 }
 246         }
 247         # none of the existing Message-IDs are good, generate a new one:
 248         v2_num_for_harder($self, $mime);
 249 }
 250
 251 sub v2_num_for_harder {
 252         my ($self, $eml) = @_;
 253
 254         my $dig = content_digest($eml);
 255         my $mid0 = PublicInbox::Import::digest2mid($dig, $eml);
 256         my $num = $self->{mm}->mid_insert($mid0);
 257         unless (defined $num) {
 258                 # it's hard to spoof the last Received: header
 259                 my @recvd = $eml->header_raw('Received');
 260                 $dig->add("Received: $_") foreach (@recvd);
 261                 $mid0 = PublicInbox::Import::digest2mid($dig, $eml);
 262                 $num = $self->{mm}->mid_insert($mid0);
 263
 264                 # fall back to a random Message-ID and give up determinism:
 265                 until (defined($num)) {
 266                         $dig->add(rand);
 267                         $mid0 = PublicInbox::Import::digest2mid($dig, $eml);
 268                         warn "using random Message-ID <$mid0> as fallback\n";
 269                         $num = $self->{mm}->mid_insert($mid0);
 270                 }
 271         }
 272         PublicInbox::Import::append_mid($eml, $mid0);
 273         ($num, $mid0);
 274 }
 275
 276 sub idx_shard {
 277         my ($self, $shard_i) = @_;
 278         $self->{idx_shards}->[$shard_i];
 279 }
 280
 281 sub _idx_init { # with_umask callback
 282         my ($self, $opt) = @_;
 283         $self->lock_acquire unless $opt && $opt->{-skip_lock};
 284         $self->{over}->create;
 285
 286         # xcpdb can change shard count while -watch is idle
 287         my $nshards = count_shards($self);
 288         $self->{shards} = $nshards if $nshards && $nshards != $self->{shards};
 289
 290         # need to create all shards before initializing msgmap FD
 291         # idx_shards must be visible to all forked processes
 292         my $max = $self->{shards} - 1;
 293         my $idx = $self->{idx_shards} = [];
 294         push @$idx, PublicInbox::SearchIdxShard->new($self, $_) for (0..$max);
 295
 296         # Now that all subprocesses are up, we can open the FDs
 297         # for SQLite:
 298         my $mm = $self->{mm} = PublicInbox::Msgmap->new_file(
 299                                 "$self->{ibx}->{inboxdir}/msgmap.sqlite3",
 300                                 $self->{ibx}->{-no_fsync} ? 2 : 1);
 301         $mm->{dbh}->begin_work;
 302 }
 303
 304 # idempotent
 305 sub idx_init {
 306         my ($self, $opt) = @_;
 307         return if $self->{idx_shards};
 308         my $ibx = $self->{ibx};
 309
 310         # do not leak read-only FDs to child processes, we only have these
 311         # FDs for duplicate detection so they should not be
 312         # frequently activated.
 313         delete @$ibx{qw(mm search)};
 314         $ibx->git->cleanup;
 315
 316         $self->{parallel} = 0 if ($ibx->{indexlevel}//'') eq 'basic';
 317         if ($self->{parallel}) {
 318                 pipe(my ($r, $w)) or die "pipe failed: $!";
 319                 # pipe for barrier notifications doesn't need to be big,
 320                 # 1031: F_SETPIPE_SZ
 321                 fcntl($w, 1031, 4096) if $^O eq 'linux';
 322                 $self->{bnote} = [ $r, $w ];
 323                 $w->autoflush(1);
 324         }
 325
 326         $ibx->umask_prepare;
 327         $ibx->with_umask(\&_idx_init, $self, $opt);
 328 }
 329
 330 # returns an array mapping [ epoch => latest_commit ]
 331 # latest_commit may be undef if nothing was done to that epoch
 332 # $replace_map = { $object_id => $strref, ... }
 333 sub _replace_oids ($$$) {
 334         my ($self, $mime, $replace_map) = @_;
 335         $self->done;
 336         my $pfx = "$self->{ibx}->{inboxdir}/git";
 337         my $rewrites = []; # epoch => commit
 338         my $max = $self->{epoch_max};
 339
 340         unless (defined($max)) {
 341                 defined(my $latest = git_dir_latest($self, \$max)) or return;
 342                 $self->{epoch_max} = $max;
 343         }
 344
 345         foreach my $i (0..$max) {
 346                 my $git_dir = "$pfx/$i.git";
 347                 -d $git_dir or next;
 348                 my $git = PublicInbox::Git->new($git_dir);
 349                 my $im = $self->import_init($git, 0, 1);
 350                 $rewrites->[$i] = $im->replace_oids($mime, $replace_map);
 351                 $im->done;
 352         }
 353         $rewrites;
 354 }
 355
 356 sub content_hashes ($) {
 357         my ($mime) = @_;
 358         my @chashes = ( content_hash($mime) );
 359
 360         # We still support Email::MIME, here, and
 361         # Email::MIME->as_string doesn't always round-trip, so we may
 362         # use a second content_hash
 363         my $rt = content_hash(PublicInbox::Eml->new(\($mime->as_string)));
 364         push @chashes, $rt if $chashes[0] ne $rt;
 365         \@chashes;
 366 }
 367
 368 sub content_matches ($$) {
 369         my ($chashes, $existing) = @_;
 370         my $chash = content_hash($existing);
 371         foreach (@$chashes) {
 372                 return 1 if $_ eq $chash
 373         }
 374         0
 375 }
 376
 377 # used for removing or replacing (purging)
 378 sub rewrite_internal ($$;$$$) {
 379         my ($self, $old_eml, $cmt_msg, $new_eml, $sref) = @_;
 380         $self->idx_init;
 381         my ($im, $need_reindex, $replace_map);
 382         if ($sref) {
 383                 $replace_map = {}; # oid => sref
 384                 $need_reindex = [] if $new_eml;
 385         } else {
 386                 $im = $self->importer;
 387         }
 388         my $over = $self->{over};
 389         my $chashes = content_hashes($old_eml);
 390         my $removed = [];
 391         my $mids = mids($old_eml);
 392
 393         # We avoid introducing new blobs into git since the raw content
 394         # can be slightly different, so we do not need the user-supplied
 395         # message now that we have the mids and content_hash
 396         $old_eml = undef;
 397         my $mark;
 398
 399         foreach my $mid (@$mids) {
 400                 my %gone; # num => [ smsg, $mime, raw ]
 401                 my ($id, $prev);
 402                 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
 403                         my $msg = get_blob($self, $smsg);
 404                         if (!defined($msg)) {
 405                                 warn "broken smsg for $mid\n";
 406                                 next; # continue
 407                         }
 408                         my $orig = $$msg;
 409                         my $cur = PublicInbox::Eml->new($msg);
 410                         if (content_matches($chashes, $cur)) {
 411                                 $gone{$smsg->{num}} = [ $smsg, $cur, \$orig ];
 412                         }
 413                 }
 414                 my $n = scalar keys %gone;
 415                 next unless $n;
 416                 if ($n > 1) {
 417                         warn "BUG: multiple articles linked to <$mid>\n",
 418                                 join(',', sort keys %gone), "\n";
 419                 }
 420                 foreach my $num (keys %gone) {
 421                         my ($smsg, $mime, $orig) = @{$gone{$num}};
 422                         # $removed should only be set once assuming
 423                         # no bugs in our deduplication code:
 424                         $removed = [ undef, $mime, $smsg ];
 425                         my $oid = $smsg->{blob};
 426                         if ($replace_map) {
 427                                 $replace_map->{$oid} = $sref;
 428                         } else {
 429                                 ($mark, undef) = $im->remove($orig, $cmt_msg);
 430                                 $removed->[0] = $mark;
 431                         }
 432                         $orig = undef;
 433                         if ($need_reindex) { # ->replace
 434                                 push @$need_reindex, $smsg;
 435                         } else { # ->purge or ->remove
 436                                 $self->{mm}->num_delete($num);
 437                         }
 438                         unindex_oid_remote($self, $oid, $mid);
 439                 }
 440         }
 441
 442         if (defined $mark) {
 443                 my $cmt = $im->get_mark($mark);
 444                 $self->{last_commit}->[$self->{epoch_max}] = $cmt;
 445         }
 446         if ($replace_map && scalar keys %$replace_map) {
 447                 my $rewrites = _replace_oids($self, $new_eml, $replace_map);
 448                 return { rewrites => $rewrites, need_reindex => $need_reindex };
 449         }
 450         defined($mark) ? $removed : undef;
 451 }
 452
 453 # public (see PublicInbox::Import->remove), but note the 3rd element
 454 # (retval[2]) is not part of the stable API shared with Import->remove
 455 sub remove {
 456         my ($self, $eml, $cmt_msg) = @_;
 457         my $r = $self->{ibx}->with_umask(\&rewrite_internal,
 458                                                 $self, $eml, $cmt_msg);
 459         defined($r) && defined($r->[0]) ? @$r: undef;
 460 }
 461
 462 sub _replace ($$;$$) {
 463         my ($self, $old_eml, $new_eml, $sref) = @_;
 464         my $arg = [ $self, $old_eml, undef, $new_eml, $sref ];
 465         my $rewritten = $self->{ibx}->with_umask(\&rewrite_internal,
 466                         $self, $old_eml, undef, $new_eml, $sref) or return;
 467
 468         my $rewrites = $rewritten->{rewrites};
 469         # ->done is called if there are rewrites since we gc+prune from git
 470         $self->idx_init if @$rewrites;
 471
 472         for my $i (0..$#$rewrites) {
 473                 defined(my $cmt = $rewrites->[$i]) or next;
 474                 $self->{last_commit}->[$i] = $cmt;
 475         }
 476         $rewritten;
 477 }
 478
 479 # public
 480 sub purge {
 481         my ($self, $mime) = @_;
 482         my $rewritten = _replace($self, $mime, undef, \'') or return;
 483         $rewritten->{rewrites}
 484 }
 485
 486 # returns the git object_id of $fh, does not write the object to FS
 487 sub git_hash_raw ($$) {
 488         my ($self, $raw) = @_;
 489         # grab the expected OID we have to reindex:
 490         pipe(my($in, $w)) or die "pipe: $!";
 491         my $git_dir = $self->{ibx}->git->{git_dir};
 492         my $cmd = ['git', "--git-dir=$git_dir", qw(hash-object --stdin)];
 493         my $r = popen_rd($cmd, undef, { 0 => $in });
 494         print $w $$raw or die "print \$w: $!";
 495         close $w or die "close \$w: $!";
 496         local $/ = "\n";
 497         chomp(my $oid = <$r>);
 498         close $r or die "git hash-object failed: $?";
 499         $oid =~ /\A$OID\z/ or die "OID not expected: $oid";
 500         $oid;
 501 }
 502
 503 sub _check_mids_match ($$$) {
 504         my ($old_list, $new_list, $hdrs) = @_;
 505         my %old_mids = map { $_ => 1 } @$old_list;
 506         my %new_mids = map { $_ => 1 } @$new_list;
 507         my @old = keys %old_mids;
 508         my @new = keys %new_mids;
 509         my $err = "$hdrs may not be changed when replacing\n";
 510         die $err if scalar(@old) != scalar(@new);
 511         delete @new_mids{@old};
 512         delete @old_mids{@new};
 513         die $err if (scalar(keys %old_mids) || scalar(keys %new_mids));
 514 }
 515
 516 # Changing Message-IDs or References with ->replace isn't supported.
 517 # The rules for dealing with messages with multiple or conflicting
 518 # Message-IDs are pretty complex and rethreading hasn't been fully
 519 # implemented, yet.
 520 sub check_mids_match ($$) {
 521         my ($old, $new) = @_;
 522         _check_mids_match(mids($old), mids($new), 'Message-ID(s)');
 523         _check_mids_match(references($old), references($new),
 524                         'References/In-Reply-To');
 525 }
 526
 527 # public
 528 sub replace ($$$) {
 529         my ($self, $old_mime, $new_mime) = @_;
 530
 531         check_mids_match($old_mime, $new_mime);
 532
 533         # mutt will always add Content-Length:, Status:, Lines: when editing
 534         PublicInbox::Import::drop_unwanted_headers($new_mime);
 535
 536         my $raw = $new_mime->as_string;
 537         my $expect_oid = git_hash_raw($self, \$raw);
 538         my $rewritten = _replace($self, $old_mime, $new_mime, \$raw) or return;
 539         my $need_reindex = $rewritten->{need_reindex};
 540
 541         # just in case we have bugs in deduplication code:
 542         my $n = scalar(@$need_reindex);
 543         if ($n > 1) {
 544                 my $list = join(', ', map {
 545                                         "$_->{num}: <$_->{mid}>"
 546                                 } @$need_reindex);
 547                 warn <<"";
 548 W: rewritten $n messages matching content of original message (expected: 1).
 549 W: possible bug in public-inbox, NNTP article IDs and Message-IDs follow:
 550 W: $list
 551
 552         }
 553
 554         # make sure we really got the OID:
 555         my ($blob, $type, $bytes) = $self->{ibx}->git->check($expect_oid);
 556         $blob eq $expect_oid or die "BUG: $expect_oid not found after replace";
 557
 558         # don't leak FDs to Xapian:
 559         $self->{ibx}->git->cleanup;
 560
 561         # reindex modified messages:
 562         for my $smsg (@$need_reindex) {
 563                 my $new_smsg = bless {
 564                         blob => $blob,
 565                         raw_bytes => $bytes,
 566                         num => $smsg->{num},
 567                         mid => $smsg->{mid},
 568                 }, 'PublicInbox::Smsg';
 569                 my $sync = { autime => $smsg->{ds}, cotime => $smsg->{ts} };
 570                 $new_smsg->populate($new_mime, $sync);
 571                 do_idx($self, \$raw, $new_mime, $new_smsg);
 572         }
 573         $rewritten->{rewrites};
 574 }
 575
 576 sub last_epoch_commit ($$;$) {
 577         my ($self, $i, $cmt) = @_;
 578         my $v = PublicInbox::Search::SCHEMA_VERSION();
 579         $self->{mm}->last_commit_xap($v, $i, $cmt);
 580 }
 581
 582 sub set_last_commits ($) {
 583         my ($self) = @_;
 584         defined(my $epoch_max = $self->{epoch_max}) or return;
 585         my $last_commit = $self->{last_commit};
 586         foreach my $i (0..$epoch_max) {
 587                 defined(my $cmt = $last_commit->[$i]) or next;
 588                 $last_commit->[$i] = undef;
 589                 last_epoch_commit($self, $i, $cmt);
 590         }
 591 }
 592
 593 sub barrier_init {
 594         my ($self, $n) = @_;
 595         $self->{bnote} or return;
 596         --$n;
 597         my $barrier = { map { $_ => 1 } (0..$n) };
 598 }
 599
 600 sub barrier_wait {
 601         my ($self, $barrier) = @_;
 602         my $bnote = $self->{bnote} or return;
 603         my $r = $bnote->[0];
 604         while (scalar keys %$barrier) {
 605                 defined(my $l = readline($r)) or die "EOF on barrier_wait: $!";
 606                 $l =~ /\Abarrier (\d+)/ or die "bad line on barrier_wait: $l";
 607                 delete $barrier->{$1} or die "bad shard[$1] on barrier wait";
 608         }
 609 }
 610
 611 # public
 612 sub checkpoint ($;$) {
 613         my ($self, $wait) = @_;
 614
 615         if (my $im = $self->{im}) {
 616                 if ($wait) {
 617                         $im->barrier;
 618                 } else {
 619                         $im->checkpoint;
 620                 }
 621         }
 622         my $shards = $self->{idx_shards};
 623         if ($shards) {
 624                 my $dbh = $self->{mm}->{dbh};
 625
 626                 # SQLite msgmap data is second in importance
 627                 $dbh->commit;
 628
 629                 # SQLite overview is third
 630                 $self->{over}->commit_lazy;
 631
 632                 # Now deal with Xapian
 633                 if ($wait) {
 634                         my $barrier = $self->barrier_init(scalar @$shards);
 635
 636                         # each shard needs to issue a barrier command
 637                         $_->remote_barrier for @$shards;
 638
 639                         # wait for each Xapian shard
 640                         $self->barrier_wait($barrier);
 641                 } else {
 642                         $_->remote_commit for @$shards;
 643                 }
 644
 645                 # last_commit is special, don't commit these until
 646                 # remote shards are done:
 647                 $dbh->begin_work;
 648                 set_last_commits($self);
 649                 $dbh->commit;
 650
 651                 $dbh->begin_work;
 652         }
 653         $self->{total_bytes} += $self->{transact_bytes};
 654         $self->{transact_bytes} = 0;
 655 }
 656
 657 # issue a write barrier to ensure all data is visible to other processes
 658 # and read-only ops.  Order of data importance is: git > SQLite > Xapian
 659 # public
 660 sub barrier { checkpoint($_[0], 1) };
 661
 662 # public
 663 sub done {
 664         my ($self) = @_;
 665         my $err = '';
 666         if (my $im = delete $self->{im}) {
 667                 eval { $im->done }; # PublicInbox::Import::done
 668                 $err .= "import done: $@\n" if $@;
 669         }
 670         if (!$err) {
 671                 eval { checkpoint($self) };
 672                 $err .= "checkpoint: $@\n" if $@;
 673         }
 674         if (my $mm = delete $self->{mm}) {
 675                 my $m = $err ? 'rollback' : 'commit';
 676                 eval { $mm->{dbh}->$m };
 677                 $err .= "msgmap $m: $@\n" if $@;
 678         }
 679         my $shards = delete $self->{idx_shards};
 680         if ($shards) {
 681                 for (@$shards) {
 682                         eval { $_->remote_close };
 683                         $err .= "shard close: $@\n" if $@;
 684                 }
 685         }
 686         eval { $self->{over}->disconnect };
 687         $err .= "over disconnect: $@\n" if $@;
 688         delete $self->{bnote};
 689         my $nbytes = $self->{total_bytes};
 690         $self->{total_bytes} = 0;
 691         $self->lock_release(!!$nbytes) if $shards;
 692         $self->{ibx}->git->cleanup;
 693         die $err if $err;
 694 }
 695
 696 sub fill_alternates ($$) {
 697         my ($self, $epoch) = @_;
 698
 699         my $pfx = "$self->{ibx}->{inboxdir}/git";
 700         my $all = "$self->{ibx}->{inboxdir}/all.git";
 701         PublicInbox::Import::init_bare($all) unless -d $all;
 702         my $info_dir = "$all/objects/info";
 703         my $alt = "$info_dir/alternates";
 704         my (%alt, $new);
 705         my $mode = 0644;
 706         if (-e $alt) {
 707                 open(my $fh, '<', $alt) or die "open < $alt: $!\n";
 708                 $mode = (stat($fh))[2] & 07777;
 709
 710                 # we assign a sort score to every alternate and favor
 711                 # the newest (highest numbered) one because loose objects
 712                 # require scanning epochs and only the latest epoch is
 713                 # expected to see loose objects
 714                 my $score;
 715                 my $other = 0; # in case admin adds non-epoch repos
 716                 %alt = map {;
 717                         if (m!\A\Q../../\E([0-9]+)\.git/objects\z!) {
 718                                 $score = $1 + 0;
 719                         } else {
 720                                 $score = --$other;
 721                         }
 722                         $_ => $score;
 723                 } split(/\n+/, do { local $/; <$fh> });
 724         }
 725
 726         foreach my $i (0..$epoch) {
 727                 my $dir = "../../git/$i.git/objects";
 728                 if (!exists($alt{$dir}) && -d "$pfx/$i.git") {
 729                         $alt{$dir} = $i;
 730                         $new = 1;
 731                 }
 732         }
 733         return unless $new;
 734
 735         my ($fh, $tmp) = tempfile('alt-XXXXXXXX', DIR => $info_dir);
 736         print $fh join("\n", sort { $alt{$b} <=> $alt{$a} } keys %alt), "\n"
 737                 or die "print $tmp: $!\n";
 738         chmod($mode, $fh) or die "fchmod $tmp: $!\n";
 739         close $fh or die "close $tmp $!\n";
 740         rename($tmp, $alt) or die "rename $tmp => $alt: $!\n";
 741 }
 742
 743 sub git_init {
 744         my ($self, $epoch) = @_;
 745         my $git_dir = "$self->{ibx}->{inboxdir}/git/$epoch.git";
 746         PublicInbox::Import::init_bare($git_dir);
 747         my @cmd = (qw/git config/, "--file=$git_dir/config",
 748                         'include.path', '../../all.git/config');
 749         PublicInbox::Import::run_die(\@cmd);
 750         fill_alternates($self, $epoch);
 751         $git_dir
 752 }
 753
 754 sub git_dir_latest {
 755         my ($self, $max) = @_;
 756         $$max = -1;
 757         my $pfx = "$self->{ibx}->{inboxdir}/git";
 758         return unless -d $pfx;
 759         my $latest;
 760         opendir my $dh, $pfx or die "opendir $pfx: $!\n";
 761         while (defined(my $git_dir = readdir($dh))) {
 762                 $git_dir =~ m!\A([0-9]+)\.git\z! or next;
 763                 if ($1 > $$max) {
 764                         $$max = $1;
 765                         $latest = "$pfx/$git_dir";
 766                 }
 767         }
 768         $latest;
 769 }
 770
 771 sub importer {
 772         my ($self) = @_;
 773         my $im = $self->{im};
 774         if ($im) {
 775                 if ($im->{bytes_added} < $self->{rotate_bytes}) {
 776                         return $im;
 777                 } else {
 778                         $self->{im} = undef;
 779                         $im->done;
 780                         $im = undef;
 781                         $self->checkpoint;
 782                         my $git_dir = $self->git_init(++$self->{epoch_max});
 783                         my $git = PublicInbox::Git->new($git_dir);
 784                         return $self->import_init($git, 0);
 785                 }
 786         }
 787         my $epoch = 0;
 788         my $max;
 789         my $latest = git_dir_latest($self, \$max);
 790         if (defined $latest) {
 791                 my $git = PublicInbox::Git->new($latest);
 792                 my $packed_bytes = $git->packed_bytes;
 793                 my $unpacked_bytes = $packed_bytes / $PACKING_FACTOR;
 794
 795                 if ($unpacked_bytes >= $self->{rotate_bytes}) {
 796                         $epoch = $max + 1;
 797                 } else {
 798                         $self->{epoch_max} = $max;
 799                         return $self->import_init($git, $packed_bytes);
 800                 }
 801         }
 802         $self->{epoch_max} = $epoch;
 803         $latest = $self->git_init($epoch);
 804         $self->import_init(PublicInbox::Git->new($latest), 0);
 805 }
 806
 807 sub import_init {
 808         my ($self, $git, $packed_bytes, $tmp) = @_;
 809         my $im = PublicInbox::Import->new($git, undef, undef, $self->{ibx});
 810         $im->{bytes_added} = int($packed_bytes / $PACKING_FACTOR);
 811         $im->{lock_path} = undef;
 812         $im->{path_type} = 'v2';
 813         $self->{im} = $im unless $tmp;
 814         $im;
 815 }
 816
 817 # XXX experimental
 818 sub diff ($$$) {
 819         my ($mid, $cur, $new) = @_;
 820
 821         my ($ah, $an) = tempfile('email-cur-XXXXXXXX', TMPDIR => 1);
 822         print $ah $cur->as_string or die "print: $!";
 823         close $ah or die "close: $!";
 824         my ($bh, $bn) = tempfile('email-new-XXXXXXXX', TMPDIR => 1);
 825         PublicInbox::Import::drop_unwanted_headers($new);
 826         print $bh $new->as_string or die "print: $!";
 827         close $bh or die "close: $!";
 828         my $cmd = [ qw(diff -u), $an, $bn ];
 829         print STDERR "# MID conflict <$mid>\n";
 830         my $pid = spawn($cmd, undef, { 1 => 2 });
 831         waitpid($pid, 0) == $pid or die "diff did not finish";
 832         unlink($an, $bn);
 833 }
 834
 835 sub get_blob ($$) {
 836         my ($self, $smsg) = @_;
 837         if (my $im = $self->{im}) {
 838                 my $msg = $im->cat_blob($smsg->{blob});
 839                 return $msg if $msg;
 840         }
 841         # older message, should be in alternates
 842         $self->{ibx}->msg_by_smsg($smsg);
 843 }
 844
 845 sub content_exists ($$$) {
 846         my ($self, $mime, $mid) = @_;
 847         my $over = $self->{over};
 848         my $chashes = content_hashes($mime);
 849         my ($id, $prev);
 850         while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
 851                 my $msg = get_blob($self, $smsg);
 852                 if (!defined($msg)) {
 853                         warn "broken smsg for $mid\n";
 854                         next;
 855                 }
 856                 my $cur = PublicInbox::Eml->new($msg);
 857                 return 1 if content_matches($chashes, $cur);
 858
 859                 # XXX DEBUG_DIFF is experimental and may be removed
 860                 diff($mid, $cur, $mime) if $ENV{DEBUG_DIFF};
 861         }
 862         undef;
 863 }
 864
 865 sub atfork_child {
 866         my ($self) = @_;
 867         if (my $shards = $self->{idx_shards}) {
 868                 $_->atfork_child foreach @$shards;
 869         }
 870         if (my $im = $self->{im}) {
 871                 $im->atfork_child;
 872         }
 873         die "unexpected mm" if $self->{mm};
 874         close $self->{bnote}->[0] or die "close bnote[0]: $!\n";
 875         $self->{bnote}->[1];
 876 }
 877
 878 sub reindex_checkpoint ($$) {
 879         my ($self, $sync) = @_;
 880
 881         $self->{ibx}->git->cleanup; # *async_wait
 882         ${$sync->{need_checkpoint}} = 0;
 883         my $mm_tmp = $sync->{mm_tmp};
 884         $mm_tmp->atfork_prepare if $mm_tmp;
 885         $self->done; # release lock
 886
 887         if (my $pr = $sync->{-opt}->{-progress}) {
 888                 $pr->(sprintf($sync->{-regen_fmt}, ${$sync->{nr}}));
 889         }
 890
 891         # allow -watch or -mda to write...
 892         $self->idx_init; # reacquire lock
 893         $mm_tmp->atfork_parent if $mm_tmp;
 894 }
 895
 896 sub index_oid { # cat_async callback
 897         my ($bref, $oid, $type, $size, $arg) = @_;
 898         return if $size == 0; # purged
 899         my ($num, $mid0);
 900         my $eml = PublicInbox::Eml->new($$bref);
 901         my $mids = mids($eml);
 902         my $chash = content_hash($eml);
 903         my $self = $arg->{v2w};
 904
 905         if (scalar(@$mids) == 0) {
 906                 warn "E: $oid has no Message-ID, skipping\n";
 907                 return;
 908         }
 909
 910         # {unindexed} is unlikely
 911         if ((my $unindexed = $arg->{unindexed}) && scalar(@$mids) == 1) {
 912                 $num = delete($unindexed->{$mids->[0]});
 913                 if (defined $num) {
 914                         $mid0 = $mids->[0];
 915                         $self->{mm}->mid_set($num, $mid0);
 916                         delete($arg->{unindexed}) if !keys(%$unindexed);
 917                 }
 918         }
 919         if (!defined($num)) { # reuse if reindexing (or duplicates)
 920                 my $over = $self->{over};
 921                 for my $mid (@$mids) {
 922                         ($num, $mid0) = $over->num_mid0_for_oid($oid, $mid);
 923                         last if defined $num;
 924                 }
 925         }
 926         $mid0 //= do { # is this a number we got before?
 927                 $num = $arg->{mm_tmp}->num_for($mids->[0]);
 928                 defined($num) ? $mids->[0] : undef;
 929         };
 930         if (!defined($num)) {
 931                 for (my $i = $#$mids; $i >= 1; $i--) {
 932                         $num = $arg->{mm_tmp}->num_for($mids->[$i]);
 933                         if (defined($num)) {
 934                                 $mid0 = $mids->[$i];
 935                                 last;
 936                         }
 937                 }
 938         }
 939         if (defined($num)) {
 940                 $arg->{mm_tmp}->num_delete($num);
 941         } else { # never seen
 942                 $num = $self->{mm}->mid_insert($mids->[0]);
 943                 if (defined($num)) {
 944                         $mid0 = $mids->[0];
 945                 } else { # rare, try the rest of them, backwards
 946                         for (my $i = $#$mids; $i >= 1; $i--) {
 947                                 $num = $self->{mm}->mid_insert($mids->[$i]);
 948                                 if (defined($num)) {
 949                                         $mid0 = $mids->[$i];
 950                                         last;
 951                                 }
 952                         }
 953                 }
 954         }
 955         if (!defined($num)) {
 956                 warn "E: $oid <", join('> <', @$mids), "> is a duplicate\n";
 957                 return;
 958         }
 959         ++${$arg->{nr}};
 960         my $smsg = bless {
 961                 raw_bytes => $size,
 962                 num => $num,
 963                 blob => $oid,
 964                 mid => $mid0,
 965         }, 'PublicInbox::Smsg';
 966         $smsg->populate($eml, $arg);
 967         if (do_idx($self, $bref, $eml, $smsg)) {
 968                 ${$arg->{need_checkpoint}} = 1;
 969         }
 970 }
 971
 972 # only update last_commit for $i on reindex iff newer than current
 973 sub update_last_commit ($$$$) {
 974         my ($self, $git, $i, $cmt) = @_;
 975         my $last = last_epoch_commit($self, $i);
 976         if (defined $last && is_ancestor($git, $last, $cmt)) {
 977                 my @cmd = (qw(rev-list --count), "$last..$cmt");
 978                 chomp(my $n = $git->qx(@cmd));
 979                 return if $n ne '' && $n == 0;
 980         }
 981         last_epoch_commit($self, $i, $cmt);
 982 }
 983
 984 sub git_dir_n ($$) { "$_[0]->{ibx}->{inboxdir}/git/$_[1].git" }
 985
 986 sub last_commits ($$) {
 987         my ($self, $epoch_max) = @_;
 988         my $heads = [];
 989         for (my $i = $epoch_max; $i >= 0; $i--) {
 990                 $heads->[$i] = last_epoch_commit($self, $i);
 991         }
 992         $heads;
 993 }
 994
 995 # returns a revision range for git-log(1)
 996 sub log_range ($$$$$) {
 997         my ($self, $sync, $git, $i, $tip) = @_;
 998         my $opt = $sync->{-opt};
 999         my $pr = $opt->{-progress} if (($opt->{verbose} || 0) > 1);
1000         my $cur = $sync->{ranges}->[$i] or do {
1001                 $pr->("$i.git indexing all of $tip") if $pr;
1002                 return $tip; # all of it
1003         };
1004
1005         # fast equality check to avoid (v)fork+execve overhead
1006         if ($cur eq $tip) {
1007                 $sync->{ranges}->[$i] = undef;
1008                 return;
1009         }
1010
1011         my $range = "$cur..$tip";
1012         $pr->("$i.git checking contiguity... ") if $pr;
1013         if (is_ancestor($git, $cur, $tip)) { # common case
1014                 $pr->("OK\n") if $pr;
1015                 my $n = $git->qx(qw(rev-list --count), $range);
1016                 chomp($n);
1017                 if ($n == 0) {
1018                         $sync->{ranges}->[$i] = undef;
1019                         $pr->("$i.git has nothing new\n") if $pr;
1020                         return; # nothing to do
1021                 }
1022                 $pr->("$i.git has $n changes since $cur\n") if $pr;
1023         } else {
1024                 $pr->("FAIL\n") if $pr;
1025                 warn <<"";
1026 discontiguous range: $range
1027 Rewritten history? (in $git->{git_dir})
1028
1029                 chomp(my $base = $git->qx('merge-base', $tip, $cur));
1030                 if ($base) {
1031                         $range = "$base..$tip";
1032                         warn "found merge-base: $base\n"
1033                 } else {
1034                         $range = $tip;
1035                         warn "discarding history at $cur\n";
1036                 }
1037                 warn <<"";
1038 reindexing $git->{git_dir} starting at
1039 $range
1040
1041                 $sync->{unindex_range}->{$i} = "$base..$cur";
1042         }
1043         $range;
1044 }
1045
1046 sub sync_prepare ($$$) {
1047         my ($self, $sync, $epoch_max) = @_;
1048         my $pr = $sync->{-opt}->{-progress};
1049         my $regen_max = 0;
1050         my $head = $self->{ibx}->{ref_head} || 'refs/heads/master';
1051
1052         # reindex stops at the current heads and we later rerun index_sync
1053         # without {reindex}
1054         my $reindex_heads = last_commits($self, $epoch_max) if $sync->{reindex};
1055
1056         for (my $i = $epoch_max; $i >= 0; $i--) {
1057                 my $git_dir = git_dir_n($self, $i);
1058                 -d $git_dir or next; # missing epochs are fine
1059                 my $git = PublicInbox::Git->new($git_dir);
1060                 if ($reindex_heads) {
1061                         $head = $reindex_heads->[$i] or next;
1062                 }
1063                 chomp(my $tip = $git->qx(qw(rev-parse -q --verify), $head));
1064
1065                 next if $?; # new repo
1066                 my $range = log_range($self, $sync, $git, $i, $tip) or next;
1067                 # can't use 'rev-list --count' if we use --diff-filter
1068                 $pr->("$i.git counting $range ... ") if $pr;
1069                 # Don't bump num_highwater on --reindex by using {D}.
1070                 # We intentionally do NOT use {D} in the non-reindex case
1071                 # because we want NNTP article number gaps from unindexed
1072                 # messages to show up in mirrors, too.
1073                 $sync->{D} //= $sync->{reindex} ? {} : undef; # OID_BIN => NR
1074                 my $stk = log2stack($sync, $git, $range, $self->{ibx});
1075                 my $nr = $stk ? $stk->num_records : 0;
1076                 $pr->("$nr\n") if $pr;
1077                 $sync->{stacks}->[$i] = $stk if $stk;
1078                 $regen_max += $nr;
1079         }
1080
1081         # XXX this should not happen unless somebody bypasses checks in
1082         # our code and blindly injects "d" file history into git repos
1083         if (my @leftovers = keys %{delete($sync->{D}) // {}}) {
1084                 warn('W: unindexing '.scalar(@leftovers)." leftovers\n");
1085                 my $arg = { v2w => $self };
1086                 my $all = $self->{ibx}->git;
1087                 for my $oid (@leftovers) {
1088                         $oid = unpack('H*', $oid);
1089                         $self->{current_info} = "leftover $oid";
1090                         $all->cat_async($oid, \&unindex_oid, $arg);
1091                 }
1092                 $all->cat_async_wait;
1093         }
1094         if (!$regen_max && !keys(%{$self->{unindex_range}})) {
1095                 $sync->{-regen_fmt} = "%u/?\n";
1096                 return 0;
1097         }
1098
1099         # reindex should NOT see new commits anymore, if we do,
1100         # it's a problem and we need to notice it via die()
1101         my $pad = length($regen_max) + 1;
1102         $sync->{-regen_fmt} = "% ${pad}u/$regen_max\n";
1103         $sync->{nr} = \(my $nr = 0);
1104         return -1 if $sync->{reindex};
1105         $regen_max + $self->{mm}->num_highwater() || 0;
1106 }
1107
1108 sub unindex_oid_remote ($$$) {
1109         my ($self, $oid, $mid) = @_;
1110         my @removed = $self->{over}->remove_oid($oid, $mid);
1111         for my $num (@removed) {
1112                 my $idx = idx_shard($self, $num % $self->{shards});
1113                 $idx->remote_remove($oid, $num);
1114         }
1115 }
1116
1117 sub unindex_oid ($$;$) { # git->cat_async callback
1118         my ($bref, $oid, $type, $size, $sync) = @_;
1119         my $self = $sync->{v2w};
1120         my $unindexed = $sync->{in_unindex} ? $sync->{unindexed} : undef;
1121         my $mm = $self->{mm};
1122         my $mids = mids(PublicInbox::Eml->new($bref));
1123         undef $$bref;
1124         my $over = $self->{over};
1125         foreach my $mid (@$mids) {
1126                 my %gone;
1127                 my ($id, $prev);
1128                 while (my $smsg = $over->next_by_mid($mid, \$id, \$prev)) {
1129                         $gone{$smsg->{num}} = 1 if $oid eq $smsg->{blob};
1130                 }
1131                 my $n = scalar(keys(%gone)) or next;
1132                 if ($n > 1) {
1133                         warn "BUG: multiple articles linked to $oid\n",
1134                                 join(',',sort keys %gone), "\n";
1135                 }
1136                 foreach my $num (keys %gone) {
1137                         if ($unindexed) {
1138                                 my $mid0 = $mm->mid_for($num);
1139                                 $unindexed->{$mid0} = $num;
1140                         }
1141                         $mm->num_delete($num);
1142                 }
1143                 unindex_oid_remote($self, $oid, $mid);
1144         }
1145 }
1146
1147 # this is rare, it only happens when we get discontiguous history in
1148 # a mirror because the source used -purge or -edit
1149 sub unindex ($$$$) {
1150         my ($self, $sync, $git, $unindex_range) = @_;
1151         my $unindexed = $sync->{unindexed} //= {}; # $mid0 => $num
1152         my $before = scalar keys %$unindexed;
1153         # order does not matter, here:
1154         my @cmd = qw(log --raw -r
1155                         --no-notes --no-color --no-abbrev --no-renames);
1156         my $fh = $git->popen(@cmd, $unindex_range);
1157         my $all = $self->{ibx}->git;
1158         local $sync->{in_unindex} = 1;
1159         while (<$fh>) {
1160                 /\A:\d{6} 100644 $OID ($OID) [AM]\tm$/o or next;
1161                 $all->cat_async($1, \&unindex_oid, $sync);
1162         }
1163         close $fh or die "git log failed: \$?=$?";
1164         $all->cat_async_wait;
1165
1166         return unless $sync->{-opt}->{prune};
1167         my $after = scalar keys %$unindexed;
1168         return if $before == $after;
1169
1170         # ensure any blob can not longer be accessed via dumb HTTP
1171         PublicInbox::Import::run_die(['git', "--git-dir=$git->{git_dir}",
1172                 qw(-c gc.reflogExpire=now gc --prune=all --quiet)]);
1173 }
1174
1175 sub sync_ranges ($$$) {
1176         my ($self, $sync, $epoch_max) = @_;
1177         my $reindex = $sync->{reindex};
1178
1179         return last_commits($self, $epoch_max) unless $reindex;
1180         return [] if ref($reindex) ne 'HASH';
1181
1182         my $ranges = $reindex->{from}; # arrayref;
1183         if (ref($ranges) ne 'ARRAY') {
1184                 die 'BUG: $reindex->{from} not an ARRAY';
1185         }
1186         $ranges;
1187 }
1188
1189 sub index_xap_only { # git->cat_async callback
1190         my ($bref, $oid, $type, $size, $smsg) = @_;
1191         my $self = $smsg->{v2w};
1192         my $idx = idx_shard($self, $smsg->{num} % $self->{shards});
1193         $smsg->{raw_bytes} = $size;
1194         $idx->index_raw($bref, undef, $smsg);
1195         $self->{transact_bytes} += $size;
1196 }
1197
1198 sub index_xap_step ($$$;$) {
1199         my ($self, $sync, $beg, $step) = @_;
1200         my $ibx = $self->{ibx};
1201         my $all = $ibx->git;
1202         my $over = $ibx->over;
1203         my $batch_bytes = batch_bytes($self);
1204         $step //= $self->{shards};
1205         my $end = $sync->{art_end};
1206         if (my $pr = $sync->{-opt}->{-progress}) {
1207                 $pr->("Xapian indexlevel=$ibx->{indexlevel} ".
1208                         "$beg..$end (% $step)\n");
1209         }
1210         for (my $num = $beg; $num <= $end; $num += $step) {
1211                 my $smsg = $over->get_art($num) or next;
1212                 $smsg->{v2w} = $self;
1213                 $all->cat_async($smsg->{blob}, \&index_xap_only, $smsg);
1214                 if ($self->{transact_bytes} >= $batch_bytes) {
1215                         ${$sync->{nr}} = $num;
1216                         reindex_checkpoint($self, $sync);
1217                 }
1218         }
1219 }
1220
1221 sub index_epoch ($$$) {
1222         my ($self, $sync, $i) = @_;
1223
1224         my $git_dir = git_dir_n($self, $i);
1225         -d $git_dir or return; # missing epochs are fine
1226         my $git = PublicInbox::Git->new($git_dir);
1227         if (my $unindex_range = delete $sync->{unindex_range}->{$i}) { # rare
1228                 unindex($self, $sync, $git, $unindex_range);
1229         }
1230         defined(my $stk = $sync->{stacks}->[$i]) or return;
1231         $sync->{stacks}->[$i] = undef;
1232         my $all = $self->{ibx}->git;
1233         while (my ($f, $at, $ct, $oid) = $stk->pop_rec) {
1234                 $self->{current_info} = "$i.git $oid";
1235                 if ($f eq 'm') {
1236                         my $arg = { %$sync, autime => $at, cotime => $ct };
1237                         if ($sync->{index_max_size}) {
1238                                 $all->check_async($oid, \&check_size, $arg);
1239                         } else {
1240                                 $all->cat_async($oid, \&index_oid, $arg);
1241                         }
1242                 } elsif ($f eq 'd') {
1243                         $all->cat_async($oid, \&unindex_oid, $sync);
1244                 }
1245                 if (${$sync->{need_checkpoint}}) {
1246                         reindex_checkpoint($self, $sync);
1247                 }
1248         }
1249         $all->check_async_wait;
1250         $all->cat_async_wait;
1251         update_last_commit($self, $git, $i, $stk->{latest_cmt});
1252 }
1253
1254 sub xapian_only {
1255         my ($self, $opt, $sync) = @_;
1256         my $seq = $opt->{sequentialshard};
1257         local $self->{parallel} = 0 if $seq;
1258         $self->idx_init($opt); # acquire lock
1259         if (my $art_end = $self->{ibx}->mm->max) {
1260                 $sync //= {
1261                         need_checkpoint => \(my $bool = 0),
1262                         -opt => $opt,
1263                         v2w => $self,
1264                         nr => \(my $nr = 0),
1265                         -regen_fmt => "%u/?\n",
1266                 };
1267                 $sync->{art_end} = $art_end;
1268                 if ($seq || !$self->{parallel}) {
1269                         my $shard_end = $self->{shards} - 1;
1270                         index_xap_step($self, $sync, $_) for (0..$shard_end);
1271                 } else { # parallel (maybe)
1272                         index_xap_step($self, $sync, 0, 1);
1273                 }
1274         }
1275         $self->{ibx}->git->cat_async_wait;
1276         $self->done;
1277 }
1278
1279 # public, called by public-inbox-index
1280 sub index_sync {
1281         my ($self, $opt) = @_;
1282         $opt //= $_[1] //= {};
1283         goto \&xapian_only if $opt->{xapianonly};
1284
1285         my $pr = $opt->{-progress};
1286         my $epoch_max;
1287         my $latest = git_dir_latest($self, \$epoch_max);
1288         return unless defined $latest;
1289
1290         my $seq = $opt->{sequentialshard};
1291         my $idxlevel = $self->{ibx}->{indexlevel};
1292         local $self->{ibx}->{indexlevel} = 'basic' if $seq;
1293
1294         $self->idx_init($opt); # acquire lock
1295         fill_alternates($self, $epoch_max);
1296         $self->{over}->rethread_prepare($opt);
1297         my $sync = {
1298                 need_checkpoint => \(my $bool = 0),
1299                 unindex_range => {}, # EPOCH => oid_old..oid_new
1300                 reindex => $opt->{reindex},
1301                 -opt => $opt,
1302                 v2w => $self,
1303         };
1304         $sync->{ranges} = sync_ranges($self, $sync, $epoch_max);
1305         if (sync_prepare($self, $sync, $epoch_max)) {
1306                 # tmp_clone seems to fail if inside a transaction, so
1307                 # we rollback here (because we opened {mm} for reading)
1308                 # Note: we do NOT rely on DBI transactions for atomicity;
1309                 # only for batch performance.
1310                 $self->{mm}->{dbh}->rollback;
1311                 $self->{mm}->{dbh}->begin_work;
1312                 $sync->{mm_tmp} =
1313                         $self->{mm}->tmp_clone($self->{ibx}->{inboxdir});
1314         }
1315         if ($sync->{index_max_size} = $self->{ibx}->{index_max_size}) {
1316                 $sync->{index_oid} = \&index_oid;
1317         }
1318         # work forwards through history
1319         index_epoch($self, $sync, $_) for (0..$epoch_max);
1320         $self->{over}->rethread_done($opt);
1321         $self->done;
1322
1323         if (my $nr = $sync->{nr}) {
1324                 my $pr = $sync->{-opt}->{-progress};
1325                 $pr->('all.git '.sprintf($sync->{-regen_fmt}, $$nr)) if $pr;
1326         }
1327
1328         if ($seq) { # deal with Xapian shards sequentially
1329                 $self->{ibx}->{indexlevel} = $idxlevel;
1330                 delete $sync->{mm_tmp};
1331                 xapian_only($self, $opt, $sync);
1332         }
1333
1334         # reindex does not pick up new changes, so we rerun w/o it:
1335         if ($opt->{reindex}) {
1336                 my %again = %$opt;
1337                 $sync = undef;
1338                 delete @again{qw(rethread reindex -skip_lock)};
1339                 index_sync($self, \%again);
1340         }
1341 }
1342
1343 1;