1 # Copyright (C) 2018 all contributors <meta@public-inbox.org>
2 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
4 # This interface wraps and mimics PublicInbox::Import
5 package PublicInbox::V2Writable;
8 use Fcntl qw(:flock :DEFAULT);
9 use PublicInbox::SearchIdxPart;
10 use PublicInbox::SearchIdxSkeleton;
11 use PublicInbox::MIME;
13 use PublicInbox::Import;
14 use PublicInbox::MID qw(mids);
15 use PublicInbox::ContentId qw(content_id content_digest);
16 use PublicInbox::Inbox;
18 # an estimate of the post-packed size to the raw uncompressed size
19 my $PACKING_FACTOR = 0.4;
21 # assume 2 cores if GNU nproc(1) is not available
23 int($ENV{NPROC} || `nproc 2>/dev/null` || 2);
27 my ($class, $v2ibx, $creat) = @_;
28 my $dir = $v2ibx->{mainrepo} or die "no mainrepo in inbox\n";
32 File::Path::mkpath($dir);
34 die "$dir does not exist\n";
39 my $xpfx = "$dir/xap" . PublicInbox::Search::SCHEMA_VERSION;
41 # always load existing partitions in case core count changes:
43 foreach my $part (<$xpfx/*>) {
44 -d $part && $part =~ m!/\d+\z! or next;
46 Search::Xapian::Database->new($part)->close;
51 $nparts = nproc() if ($nparts == 0);
55 im => undef, # PublicInbox::Import
56 xap_rw => undef, # PublicInbox::V2SearchIdx
58 partitions => $nparts,
60 # limit each repo to 1GB or so
61 rotate_bytes => int((1024 * 1024 * 1024) / $PACKING_FACTOR),
66 # returns undef on duplicate or spam
67 # mimics Import::add and wraps it for v2
69 my ($self, $mime, $check_cb) = @_;
73 $mime = $check_cb->($mime) or return;
76 # All pipes (> $^F) known to Perl 5.6+ have FD_CLOEXEC set,
77 # as does SQLite 3.4.1+ (released in 2007-07-20), and
78 # Xapian 1.3.2+ (released 2015-03-15).
79 # For the most part, we can spawn git-fast-import without
80 # leaking FDs to it...
84 my $num = num_for($self, $mime, \$mid0);
85 defined $num or return; # duplicate
86 defined $mid0 or die "BUG: $mid0 undefined\n";
87 my $im = $self->importer;
88 my $cmt = $im->add($mime);
89 $cmt = $im->get_mark($cmt);
90 my ($oid, $len, $msgref) = @{$im->{last_object}};
92 my $nparts = $self->{partitions};
93 my $part = $num % $nparts;
94 my $idx = $self->idx_part($part);
95 $idx->index_raw($len, $msgref, $num, $oid, $mid0);
96 my $n = $self->{transact_bytes} += $len;
97 if ($n > (PublicInbox::SearchIdx::BATCH_BYTES * $nparts)) {
105 my ($self, $mime, $mid0) = @_;
106 my $mids = mids($mime->header_obj);
108 my $mid = $mids->[0];
109 my $num = $self->{skel}->{mm}->mid_insert($mid);
110 if (defined $num) { # common case
115 # crap, Message-ID is already known, hope somebody just resent:
117 foreach my $m (@$mids) {
118 # read-only lookup now safe to do after above barrier
119 my $existing = $self->lookup_content($mime, $m);
121 warn "<$m> resent\n";
122 return; # easy, don't store duplicates
127 warn "<$mid> reused for mismatched content\n";
129 # try the rest of the mids
130 foreach my $i (1..$#$mids) {
132 $num = $self->{skel}->{mm}->mid_insert($m);
134 warn "alternative <$m> for <$mid> found\n";
140 # none of the existing Message-IDs are good, generate a new one:
141 num_for_harder($self, $mime, $mid0);
145 my ($self, $mime, $mid0) = @_;
147 my $hdr = $mime->header_obj;
148 my $dig = content_digest($mime);
149 $$mid0 = $dig->clone->hexdigest . '@localhost';
150 my $num = $self->{skel}->{mm}->mid_insert($$mid0);
151 unless (defined $num) {
152 # it's hard to spoof the last Received: header
153 my @recvd = $hdr->header_raw('Received');
154 $dig->add("Received: $_") foreach (@recvd);
155 $$mid0 = $dig->clone->hexdigest . '@localhost';
156 $num = $self->{skel}->{mm}->mid_insert($$mid0);
158 # fall back to a random Message-ID and give up determinism:
159 until (defined($num)) {
161 $$mid0 = $dig->clone->hexdigest . '@localhost';
162 warn "using random Message-ID <$$mid0> as fallback\n";
163 $num = $self->{skel}->{mm}->mid_insert($$mid0);
166 my @cur = $hdr->header_raw('Message-Id');
167 $hdr->header_set('Message-Id', "<$$mid0>", @cur);
172 my ($self, $part) = @_;
173 $self->{idx_parts}->[$part];
179 return if $self->{idx_parts};
180 my $ibx = $self->{-inbox};
182 # do not leak read-only FDs to child processes, we only have these
183 # FDs for duplicate detection so they should not be
184 # frequently activated.
185 delete $ibx->{$_} foreach (qw(git mm search));
187 # first time initialization, first we create the skeleton pipe:
188 my $skel = $self->{skel} = PublicInbox::SearchIdxSkeleton->new($self);
190 # need to create all parts before initializing msgmap FD
191 my $max = $self->{partitions} - 1;
192 my $idx = $self->{idx_parts} = [];
193 for my $i (0..$max) {
194 push @$idx, PublicInbox::SearchIdxPart->new($self, $i, $skel);
197 # Now that all subprocesses are up, we can open the FD for SQLite:
198 $skel->_msgmap_init->{dbh}->begin_work;
202 my ($self, $mime, $cmt_msg) = @_;
205 my $im = $self->importer;
206 my $ibx = $self->{-inbox};
207 my $srch = $ibx->search;
208 my $cid = content_id($mime);
209 my $skel = $self->{skel};
210 my $parts = $self->{idx_parts};
211 my $mm = $skel->{mm};
213 my $mids = mids($mime->header_obj);
214 foreach my $mid (@$mids) {
215 $srch->reopen->each_smsg_by_mid($mid, sub {
218 my $msg = $ibx->msg_by_smsg($smsg);
219 if (!defined($msg)) {
220 warn "broken smsg for $mid\n";
224 my $cur = PublicInbox::MIME->new($msg);
225 if (content_id($cur) eq $cid) {
226 $mm->num_delete($smsg->num);
227 # $removed should only be set once assuming
228 # no bugs in our deduplication code:
230 $removed->{mime} = $cur;
231 $im->remove(\$orig, $cmt_msg);
233 $removed->num; # memoize this for callers
235 my $oid = $smsg->{blob};
236 foreach my $idx (@$parts, $skel) {
237 $idx->remote_remove($oid, $mid);
249 my $im = delete $self->{im};
250 $im->done if $im; # PublicInbox::Import::done
251 $self->searchidx_checkpoint(0);
256 my $im = $self->{im};
257 $im->checkpoint if $im; # PublicInbox::Import::checkpoint
258 $self->searchidx_checkpoint(1);
261 # issue a write barrier to ensure all data is visible to other processes
262 # and read-only ops. Order of data importance is: git > SQLite > Xapian
266 if (my $im = $self->{im}) {
269 my $skel = $self->{skel};
270 my $parts = $self->{idx_parts};
271 if ($parts && $skel) {
272 my $dbh = $skel->{mm}->{dbh};
273 $dbh->commit; # SQLite data is second in importance
275 # Now deal with Xapian
276 $skel->barrier_init(scalar(@$parts));
277 # each partition needs to issue a barrier command to skel:
278 $_->barrier foreach @$parts;
280 $skel->barrier_wait; # wait for each Xapian partition
284 $self->{transact_bytes} = 0;
287 sub searchidx_checkpoint {
288 my ($self, $more) = @_;
290 # order matters, we can only close {skel} after all partitions
291 # are done because the partitions also write to {skel}
292 if (my $parts = $self->{idx_parts}) {
293 foreach my $idx (@$parts) {
294 $idx->remote_commit; # propagates commit to skel
295 $idx->remote_close unless $more;
297 delete $self->{idx_parts} unless $more;
300 if (my $skel = $self->{skel}) {
301 my $dbh = $skel->{mm}->{dbh};
307 delete $self->{skel};
310 $self->{transact_bytes} = 0;
314 my ($self, $new) = @_;
315 my $pfx = "$self->{-inbox}->{mainrepo}/git";
316 my $git_dir = "$pfx/$new.git";
317 die "$git_dir exists\n" if -e $git_dir;
318 my @cmd = (qw(git init --bare -q), $git_dir);
319 PublicInbox::Import::run_die(\@cmd);
321 my $all = "$self->{-inbox}->{mainrepo}/all.git";
323 @cmd = (qw(git init --bare -q), $all);
324 PublicInbox::Import::run_die(\@cmd);
325 @cmd = (qw/git config/, "--file=$all/config",
326 'repack.writeBitmaps', 'true');
327 PublicInbox::Import::run_die(\@cmd);
330 @cmd = (qw/git config/, "--file=$git_dir/config",
331 'include.path', '../../all.git/config');
332 PublicInbox::Import::run_die(\@cmd);
334 my $alt = "$all/objects/info/alternates";
335 my $new_obj_dir = "../../git/$new.git/objects";
338 open(my $fh, '<', $alt) or die "open < $alt: $!\n";
339 %alts = map { chomp; $_ => 1 } (<$fh>);
341 return $git_dir if $alts{$new_obj_dir};
342 open my $fh, '>>', $alt or die "open >> $alt: $!\n";
343 print $fh "$new_obj_dir\n" or die "print >> $alt: $!\n";
344 close $fh or die "close $alt: $!\n";
350 my $im = $self->{im};
352 if ($im->{bytes_added} < $self->{rotate_bytes}) {
357 $self->searchidx_checkpoint(1);
359 my $git_dir = $self->git_init(++$self->{max_git});
360 my $git = PublicInbox::Git->new($git_dir);
361 return $self->import_init($git, 0);
367 my $pfx = "$self->{-inbox}->{mainrepo}/git";
369 foreach my $git_dir (glob("$pfx/*.git")) {
370 $git_dir =~ m!/(\d+)\.git\z! or next;
378 if (defined $latest) {
379 my $git = PublicInbox::Git->new($latest);
380 my $packed_bytes = $git->packed_bytes;
381 if ($packed_bytes >= $self->{rotate_bytes}) {
384 $self->{max_git} = $max;
385 return $self->import_init($git, $packed_bytes);
388 $self->{max_git} = $new;
389 $latest = $self->git_init($new);
390 $self->import_init(PublicInbox::Git->new($latest), 0);
394 my ($self, $git, $packed_bytes) = @_;
395 my $im = PublicInbox::Import->new($git, undef, undef, $self->{-inbox});
396 $im->{bytes_added} = int($packed_bytes / $PACKING_FACTOR);
397 $im->{want_object_info} = 1;
398 $im->{ssoma_lock} = 0;
399 $im->{path_type} = 'v2';
404 my ($self, $mime, $mid) = @_;
405 my $ibx = $self->{-inbox};
407 my $srch = $ibx->search->reopen;
408 my $cid = content_id($mime);
410 $srch->each_smsg_by_mid($mid, sub {
413 my $msg = $ibx->msg_by_smsg($smsg);
414 if (!defined($msg)) {
415 warn "broken smsg for $mid\n";
418 my $cur = PublicInbox::MIME->new($msg);
419 if (content_id($cur) eq $cid) {
420 $smsg->{mime} = $cur;
422 return 0; # break out of loop
431 if (my $parts = $self->{idx_parts}) {
432 $_->atfork_child foreach @$parts;
434 if (my $im = $self->{im}) {