]> git.sesse.net Git - plocate/blob - database-builder.cpp
Add a native updatedb.
[plocate] / database-builder.cpp
1 #include "database-builder.h"
2
3 #include "dprintf.h"
4 #include "turbopfor-encode.h"
5
6 #include <algorithm>
7 #include <assert.h>
8 #include <fcntl.h>
9 #include <string.h>
10 #include <string_view>
11 #include <sys/stat.h>
12 #include <sys/time.h>
13 #include <sys/types.h>
14 #include <unistd.h>
15 #include <zdict.h>
16 #include <zstd.h>
17
18 #define P4NENC_BOUND(n) ((n + 127) / 128 + (n + 32) * sizeof(uint32_t))
19
20 #define NUM_TRIGRAMS 16777216
21
22 using namespace std;
23 using namespace std::chrono;
24
25 constexpr unsigned num_overflow_slots = 16;
26
27 string zstd_compress(const string &src, ZSTD_CDict *cdict, string *tempbuf);
28
29 static inline uint32_t read_unigram(const string_view s, size_t idx)
30 {
31         if (idx < s.size()) {
32                 return (unsigned char)s[idx];
33         } else {
34                 return 0;
35         }
36 }
37
38 static inline uint32_t read_trigram(const string_view s, size_t start)
39 {
40         return read_unigram(s, start) |
41                 (read_unigram(s, start + 1) << 8) |
42                 (read_unigram(s, start + 2) << 16);
43 }
44
45 class PostingListBuilder {
46 public:
47         inline void add_docid(uint32_t docid);
48         void finish();
49
50         string encoded;
51         size_t num_docids = 0;
52
53 private:
54         void write_header(uint32_t docid);
55         void append_block();
56
57         vector<uint32_t> pending_deltas;
58
59         uint32_t last_block_end, last_docid = -1;
60 };
61
62 void PostingListBuilder::add_docid(uint32_t docid)
63 {
64         // Deduplicate against the last inserted value, if any.
65         if (docid == last_docid) {
66                 return;
67         }
68
69         if (num_docids == 0) {
70                 // Very first docid.
71                 write_header(docid);
72                 ++num_docids;
73                 last_block_end = last_docid = docid;
74                 return;
75         }
76
77         pending_deltas.push_back(docid - last_docid - 1);
78         last_docid = docid;
79         if (pending_deltas.size() == 128) {
80                 append_block();
81                 pending_deltas.clear();
82                 last_block_end = docid;
83         }
84         ++num_docids;
85 }
86
87 void PostingListBuilder::finish()
88 {
89         if (pending_deltas.empty()) {
90                 return;
91         }
92
93         assert(!encoded.empty());  // write_header() should already have run.
94
95         // No interleaving for partial blocks.
96         unsigned char buf[P4NENC_BOUND(128)];
97         unsigned char *end = encode_pfor_single_block<128>(pending_deltas.data(), pending_deltas.size(), /*interleaved=*/false, buf);
98         encoded.append(reinterpret_cast<char *>(buf), reinterpret_cast<char *>(end));
99 }
100
101 void PostingListBuilder::append_block()
102 {
103         unsigned char buf[P4NENC_BOUND(128)];
104         assert(pending_deltas.size() == 128);
105         unsigned char *end = encode_pfor_single_block<128>(pending_deltas.data(), 128, /*interleaved=*/true, buf);
106         encoded.append(reinterpret_cast<char *>(buf), reinterpret_cast<char *>(end));
107 }
108
109 void PostingListBuilder::write_header(uint32_t docid)
110 {
111         unsigned char buf[P4NENC_BOUND(1)];
112         unsigned char *end = write_baseval(docid, buf);
113         encoded.append(reinterpret_cast<char *>(buf), end - buf);
114 }
115
116 void DictionaryBuilder::add_file(string filename, dir_time)
117 {
118         if (keep_current_block) {  // Only bother saving the filenames if we're actually keeping the block.
119                 if (!current_block.empty()) {
120                         current_block.push_back('\0');
121                 }
122                 current_block += filename;
123         }
124         if (++num_files_in_block == block_size) {
125                 flush_block();
126         }
127 }
128
129 void DictionaryBuilder::flush_block()
130 {
131         if (keep_current_block) {
132                 if (slot_for_current_block == -1) {
133                         lengths.push_back(current_block.size());
134                         sampled_blocks.push_back(move(current_block));
135                 } else {
136                         lengths[slot_for_current_block] = current_block.size();
137                         sampled_blocks[slot_for_current_block] = move(current_block);
138                 }
139         }
140         current_block.clear();
141         num_files_in_block = 0;
142         ++block_num;
143
144         if (block_num < blocks_to_keep) {
145                 keep_current_block = true;
146                 slot_for_current_block = -1;
147         } else {
148                 // Keep every block with equal probability (reservoir sampling).
149                 uint64_t idx = uniform_int_distribution<uint64_t>(0, block_num)(reservoir_rand);
150                 keep_current_block = (idx < blocks_to_keep);
151                 slot_for_current_block = idx;
152         }
153 }
154
155 string DictionaryBuilder::train(size_t buf_size)
156 {
157         string dictionary_buf;
158         sort(sampled_blocks.begin(), sampled_blocks.end());  // Seemingly important for decompression speed.
159         for (const string &block : sampled_blocks) {
160                 dictionary_buf += block;
161         }
162
163         string buf;
164         buf.resize(buf_size);
165         size_t ret = ZDICT_trainFromBuffer(&buf[0], buf_size, dictionary_buf.data(), lengths.data(), lengths.size());
166         if (ret == size_t(-1)) {
167                 return "";
168         }
169         dprintf("Sampled %zu bytes in %zu blocks, built a dictionary of size %zu\n", dictionary_buf.size(), lengths.size(), ret);
170         buf.resize(ret);
171
172         sampled_blocks.clear();
173         lengths.clear();
174
175         return buf;
176 }
177
178 Corpus::Corpus(FILE *outfp, size_t block_size, ZSTD_CDict *cdict, bool store_dir_times)
179         : invindex(new PostingListBuilder *[NUM_TRIGRAMS]), outfp(outfp), block_size(block_size), store_dir_times(store_dir_times), cdict(cdict)
180 {
181         fill(invindex.get(), invindex.get() + NUM_TRIGRAMS, nullptr);
182         if (store_dir_times) {
183                 dir_time_ctx = ZSTD_createCStream();
184                 ZSTD_initCStream(dir_time_ctx, /*level=*/6);
185         }
186 }
187
188 Corpus::~Corpus()
189 {
190         for (unsigned i = 0; i < NUM_TRIGRAMS; ++i) {
191                 delete invindex[i];
192         }
193 }
194
195 PostingListBuilder &Corpus::get_pl_builder(uint32_t trgm)
196 {
197         if (invindex[trgm] == nullptr) {
198                 invindex[trgm] = new PostingListBuilder;
199         }
200         return *invindex[trgm];
201 }
202
203 void Corpus::add_file(string filename, dir_time dt)
204 {
205         ++num_files;
206         if (!current_block.empty()) {
207                 current_block.push_back('\0');
208         }
209         current_block += filename;
210         if (++num_files_in_block == block_size) {
211                 flush_block();
212         }
213
214         if (store_dir_times) {
215                 if (dt.sec == -1) {
216                         // Not a directory.
217                         dir_times.push_back('\0');
218                 } else {
219                         dir_times.push_back('\1');
220                         dir_times.append(reinterpret_cast<char *>(&dt.sec), sizeof(dt.sec));
221                         dir_times.append(reinterpret_cast<char *>(&dt.nsec), sizeof(dt.nsec));
222                 }
223                 compress_dir_times(/*allowed_slop=*/4096);
224         }
225 }
226
227 void Corpus::compress_dir_times(size_t allowed_slop) {
228         while (dir_times.size() >= allowed_slop) {
229                 size_t old_size = dir_times_compressed.size();
230                 dir_times_compressed.resize(old_size + 4096);
231
232                 ZSTD_outBuffer outbuf;
233                 outbuf.dst = dir_times_compressed.data() + old_size;
234                 outbuf.size = 4096;
235                 outbuf.pos = 0;
236
237                 ZSTD_inBuffer inbuf;
238                 inbuf.src = dir_times.data();
239                 inbuf.size = dir_times.size();
240                 inbuf.pos = 0;
241
242                 int ret = ZSTD_compressStream(dir_time_ctx, &outbuf, &inbuf);
243                 if (ret < 0) {
244                         fprintf(stderr, "ZSTD_compressStream() failed\n");
245                         exit(1);
246                 }
247
248                 dir_times_compressed.resize(old_size + outbuf.pos);
249                 dir_times.erase(dir_times.begin(), dir_times.begin() + inbuf.pos);
250
251                 if (outbuf.pos == 0 && inbuf.pos == 0) {
252                         // Nothing happened (not enough data?), try again later.
253                         return;
254                 }
255         }
256 }
257
258 void Corpus::flush_block()
259 {
260         if (current_block.empty()) {
261                 return;
262         }
263
264         uint32_t docid = num_blocks;
265
266         // Create trigrams.
267         const char *ptr = current_block.c_str();
268         while (ptr < current_block.c_str() + current_block.size()) {
269                 string_view s(ptr);
270                 if (s.size() >= 3) {
271                         for (size_t j = 0; j < s.size() - 2; ++j) {
272                                 uint32_t trgm = read_trigram(s, j);
273                                 get_pl_builder(trgm).add_docid(docid);
274                         }
275                 }
276                 ptr += s.size() + 1;
277         }
278
279         // Compress and add the filename block.
280         filename_blocks.push_back(ftell(outfp));
281         string compressed = zstd_compress(current_block, cdict, &tempbuf);
282         if (fwrite(compressed.data(), compressed.size(), 1, outfp) != 1) {
283                 perror("fwrite()");
284                 exit(1);
285         }
286
287         current_block.clear();
288         num_files_in_block = 0;
289         ++num_blocks;
290 }
291
292 void Corpus::finish()
293 {
294         flush_block();
295 }
296
297 size_t Corpus::num_trigrams() const
298 {
299         size_t num = 0;
300         for (unsigned trgm = 0; trgm < NUM_TRIGRAMS; ++trgm) {
301                 if (invindex[trgm] != nullptr) {
302                         ++num;
303                 }
304         }
305         return num;
306 }
307
308 string Corpus::get_compressed_dir_times()
309 {
310         if (!store_dir_times) {
311                 return "";
312         }
313         compress_dir_times(/*allowed_slop=*/0);
314         assert(dir_times.empty());
315
316         for ( ;; ) {
317                 size_t old_size = dir_times_compressed.size();
318                 dir_times_compressed.resize(old_size + 4096);
319
320                 ZSTD_outBuffer outbuf;
321                 outbuf.dst = dir_times_compressed.data() + old_size;
322                 outbuf.size = 4096;
323                 outbuf.pos = 0;
324
325                 int ret = ZSTD_endStream(dir_time_ctx, &outbuf);
326                 if (ret < 0) {
327                         fprintf(stderr, "ZSTD_compressStream() failed\n");
328                         exit(1);
329                 }
330
331                 dir_times_compressed.resize(old_size + outbuf.pos);
332
333                 if (ret == 0) {
334                         // All done.
335                         break;
336                 }
337         }
338
339         return dir_times_compressed;
340 }
341
342 string zstd_compress(const string &src, ZSTD_CDict *cdict, string *tempbuf)
343 {
344         static ZSTD_CCtx *ctx = nullptr;
345         if (ctx == nullptr) {
346                 ctx = ZSTD_createCCtx();
347         }
348
349         size_t max_size = ZSTD_compressBound(src.size());
350         if (tempbuf->size() < max_size) {
351                 tempbuf->resize(max_size);
352         }
353         size_t size;
354         if (cdict == nullptr) {
355                 size = ZSTD_compressCCtx(ctx, &(*tempbuf)[0], max_size, src.data(), src.size(), /*level=*/6);
356         } else {
357                 size = ZSTD_compress_usingCDict(ctx, &(*tempbuf)[0], max_size, src.data(), src.size(), cdict);
358         }
359         return string(tempbuf->data(), size);
360 }
361
362 bool is_prime(uint32_t x)
363 {
364         if ((x % 2) == 0 || (x % 3) == 0) {
365                 return false;
366         }
367         uint32_t limit = ceil(sqrt(x));
368         for (uint32_t factor = 5; factor <= limit; ++factor) {
369                 if ((x % factor) == 0) {
370                         return false;
371                 }
372         }
373         return true;
374 }
375
376 uint32_t next_prime(uint32_t x)
377 {
378         if ((x % 2) == 0) {
379                 ++x;
380         }
381         while (!is_prime(x)) {
382                 x += 2;
383         }
384         return x;
385 }
386
387 unique_ptr<Trigram[]> create_hashtable(Corpus &corpus, const vector<uint32_t> &all_trigrams, uint32_t ht_size, uint32_t num_overflow_slots)
388 {
389         unique_ptr<Trigram[]> ht(new Trigram[ht_size + num_overflow_slots + 1]);  // 1 for the sentinel element at the end.
390         for (unsigned i = 0; i < ht_size + num_overflow_slots + 1; ++i) {
391                 ht[i].trgm = uint32_t(-1);
392                 ht[i].num_docids = 0;
393                 ht[i].offset = 0;
394         }
395         for (uint32_t trgm : all_trigrams) {
396                 // We don't know offset yet, so set it to zero.
397                 Trigram to_insert{ trgm, uint32_t(corpus.get_pl_builder(trgm).num_docids), 0 };
398
399                 uint32_t bucket = hash_trigram(trgm, ht_size);
400                 unsigned distance = 0;
401                 while (ht[bucket].num_docids != 0) {
402                         // Robin Hood hashing; reduces the longest distance by a lot.
403                         unsigned other_distance = bucket - hash_trigram(ht[bucket].trgm, ht_size);
404                         if (distance > other_distance) {
405                                 swap(to_insert, ht[bucket]);
406                                 distance = other_distance;
407                         }
408
409                         ++bucket, ++distance;
410                         if (distance > num_overflow_slots) {
411                                 return nullptr;
412                         }
413                 }
414                 ht[bucket] = to_insert;
415         }
416         return ht;
417 }
418
419 DatabaseBuilder::DatabaseBuilder(const char *outfile, gid_t owner, int block_size, string dictionary)
420         : outfile(outfile), block_size(block_size)
421 {
422         umask(0027);
423
424         string path = outfile;
425         path.resize(path.find_last_of('/') + 1);
426         if (path.empty()) {
427                 path = ".";
428         }
429         int fd = open(path.c_str(), O_WRONLY | O_TMPFILE, 0640);
430         if (fd == -1) {
431                 perror(path.c_str());
432                 exit(1);
433         }
434
435         if (owner != (gid_t)-1) {
436                 if (fchown(fd, (uid_t)-1, owner) == -1) {
437                         perror("fchown");
438                         exit(1);
439                 }
440         }
441
442         outfp = fdopen(fd, "wb");
443         if (outfp == nullptr) {
444                 perror(outfile);
445                 exit(1);
446         }
447
448         // Write the header.
449         memcpy(hdr.magic, "\0plocate", 8);
450         hdr.version = -1;  // Mark as broken.
451         hdr.hashtable_size = 0;  // Not known yet.
452         hdr.extra_ht_slots = num_overflow_slots;
453         hdr.num_docids = 0;
454         hdr.hash_table_offset_bytes = -1;  // We don't know these offsets yet.
455         hdr.max_version = 2;
456         hdr.filename_index_offset_bytes = -1;
457         hdr.zstd_dictionary_length_bytes = -1;
458         fwrite(&hdr, sizeof(hdr), 1, outfp);
459
460         if (dictionary.empty()) {
461                 hdr.zstd_dictionary_offset_bytes = 0;
462                 hdr.zstd_dictionary_length_bytes = 0;
463         } else {
464                 hdr.zstd_dictionary_offset_bytes = ftell(outfp);
465                 fwrite(dictionary.data(), dictionary.size(), 1, outfp);
466                 hdr.zstd_dictionary_length_bytes = dictionary.size();
467                 cdict = ZSTD_createCDict(dictionary.data(), dictionary.size(), /*level=*/6);
468         }
469
470         hdr.directory_data_length_bytes = 0;
471         hdr.directory_data_offset_bytes = 0;
472         hdr.next_zstd_dictionary_length_bytes = 0;
473         hdr.next_zstd_dictionary_offset_bytes = 0;
474         hdr.conf_block_length_bytes = 0;
475         hdr.conf_block_offset_bytes = 0;
476 }
477
478 Corpus *DatabaseBuilder::start_corpus(bool store_dir_times)
479 {
480         corpus_start = steady_clock::now();
481         corpus = new Corpus(outfp, block_size, cdict, store_dir_times);
482         return corpus;
483 }
484
485 void DatabaseBuilder::set_next_dictionary(std::string next_dictionary)
486 {
487         this->next_dictionary = move(next_dictionary);
488 }
489
490 void DatabaseBuilder::set_conf_block(std::string conf_block)
491 {
492         this->conf_block = move(conf_block);
493 }
494
495 void DatabaseBuilder::finish_corpus()
496 {
497         corpus->finish();
498         hdr.num_docids = corpus->filename_blocks.size();
499
500         // Stick an empty block at the end as sentinel.
501         corpus->filename_blocks.push_back(ftell(outfp));
502         const size_t bytes_for_filenames = corpus->filename_blocks.back() - corpus->filename_blocks.front();
503
504         // Write the offsets to the filenames.
505         hdr.filename_index_offset_bytes = ftell(outfp);
506         const size_t bytes_for_filename_index = corpus->filename_blocks.size() * sizeof(uint64_t);
507         fwrite(corpus->filename_blocks.data(), corpus->filename_blocks.size(), sizeof(uint64_t), outfp);
508         corpus->filename_blocks.clear();
509         corpus->filename_blocks.shrink_to_fit();
510
511         // Finish up encoding the posting lists.
512         size_t trigrams = 0, longest_posting_list = 0;
513         size_t bytes_for_posting_lists = 0;
514         for (unsigned trgm = 0; trgm < NUM_TRIGRAMS; ++trgm) {
515                 if (!corpus->seen_trigram(trgm))
516                         continue;
517                 PostingListBuilder &pl_builder = corpus->get_pl_builder(trgm);
518                 pl_builder.finish();
519                 longest_posting_list = max(longest_posting_list, pl_builder.num_docids);
520                 trigrams += pl_builder.num_docids;
521                 bytes_for_posting_lists += pl_builder.encoded.size();
522         }
523         size_t num_trigrams = corpus->num_trigrams();
524         dprintf("%zu files, %zu different trigrams, %zu entries, avg len %.2f, longest %zu\n",
525                 corpus->num_files, num_trigrams, trigrams, double(trigrams) / num_trigrams, longest_posting_list);
526         dprintf("%zu bytes used for posting lists (%.2f bits/entry)\n", bytes_for_posting_lists, 8 * bytes_for_posting_lists / double(trigrams));
527
528         dprintf("Building posting lists took %.1f ms.\n\n", 1e3 * duration<float>(steady_clock::now() - corpus_start).count());
529
530         // Find the used trigrams.
531         vector<uint32_t> all_trigrams;
532         for (unsigned trgm = 0; trgm < NUM_TRIGRAMS; ++trgm) {
533                 if (corpus->seen_trigram(trgm)) {
534                         all_trigrams.push_back(trgm);
535                 }
536         }
537
538         // Create the hash table.
539         unique_ptr<Trigram[]> hashtable;
540         uint32_t ht_size = next_prime(all_trigrams.size());
541         for (;;) {
542                 hashtable = create_hashtable(*corpus, all_trigrams, ht_size, num_overflow_slots);
543                 if (hashtable == nullptr) {
544                         dprintf("Failed creating hash table of size %u, increasing by 5%% and trying again.\n", ht_size);
545                         ht_size = next_prime(ht_size * 1.05);
546                 } else {
547                         dprintf("Created hash table of size %u.\n\n", ht_size);
548                         break;
549                 }
550         }
551
552         // Find the offsets for each posting list.
553         size_t bytes_for_hashtable = (ht_size + num_overflow_slots + 1) * sizeof(Trigram);
554         uint64_t offset = ftell(outfp) + bytes_for_hashtable;
555         for (unsigned i = 0; i < ht_size + num_overflow_slots + 1; ++i) {
556                 hashtable[i].offset = offset;  // Needs to be there even for empty slots.
557                 if (hashtable[i].num_docids == 0) {
558                         continue;
559                 }
560
561                 const string &encoded = corpus->get_pl_builder(hashtable[i].trgm).encoded;
562                 offset += encoded.size();
563         }
564
565         // Write the hash table.
566         hdr.hash_table_offset_bytes = ftell(outfp);
567         hdr.hashtable_size = ht_size;
568         fwrite(hashtable.get(), ht_size + num_overflow_slots + 1, sizeof(Trigram), outfp);
569
570         // Write the actual posting lists.
571         for (unsigned i = 0; i < ht_size + num_overflow_slots + 1; ++i) {
572                 if (hashtable[i].num_docids == 0) {
573                         continue;
574                 }
575                 const string &encoded = corpus->get_pl_builder(hashtable[i].trgm).encoded;
576                 fwrite(encoded.data(), encoded.size(), 1, outfp);
577         }
578
579         // Finally, write the directory times (for updatedb).
580         string compressed_dir_times = corpus->get_compressed_dir_times();
581         size_t bytes_for_compressed_dir_times = 0;
582         if (!compressed_dir_times.empty()) {
583                 hdr.directory_data_offset_bytes = ftell(outfp);
584                 hdr.directory_data_length_bytes = compressed_dir_times.size();
585                 fwrite(compressed_dir_times.data(), compressed_dir_times.size(), 1, outfp);
586                 bytes_for_compressed_dir_times = compressed_dir_times.size();
587                 compressed_dir_times.clear();
588         }
589
590         // Write the recommended dictionary for next update.
591         if (!next_dictionary.empty()) {
592                 hdr.next_zstd_dictionary_offset_bytes = ftell(outfp);
593                 hdr.next_zstd_dictionary_length_bytes = next_dictionary.size();
594                 fwrite(next_dictionary.data(), next_dictionary.size(), 1, outfp);
595         }
596
597         // And the configuration block.
598         if (!conf_block.empty()) {
599                 hdr.next_zstd_dictionary_offset_bytes = ftell(outfp);
600                 hdr.next_zstd_dictionary_length_bytes = conf_block.size();
601                 fwrite(conf_block.data(), conf_block.size(), 1, outfp);
602         }
603
604         // Rewind, and write the updated header.
605         hdr.version = 1;
606         fseek(outfp, 0, SEEK_SET);
607         fwrite(&hdr, sizeof(hdr), 1, outfp);
608
609         // Give the file a proper name, making it visible in the file system.
610         // TODO: It would be nice to be able to do this atomically, like with rename.
611         unlink(outfile.c_str());
612         char procpath[256];
613         snprintf(procpath, sizeof(procpath), "/proc/self/fd/%d", fileno(outfp));
614         if (linkat(AT_FDCWD, procpath, AT_FDCWD, outfile.c_str(), AT_SYMLINK_FOLLOW) == -1) {
615                 perror("linkat");
616                 exit(1);
617         }
618
619         fclose(outfp);
620
621         size_t total_bytes = (bytes_for_hashtable + bytes_for_posting_lists + bytes_for_filename_index + bytes_for_filenames + bytes_for_compressed_dir_times);
622
623         dprintf("Block size:     %7d files\n", block_size);
624         dprintf("Dictionary:     %'7.1f MB\n", hdr.zstd_dictionary_length_bytes / 1048576.0);
625         dprintf("Hash table:     %'7.1f MB\n", bytes_for_hashtable / 1048576.0);
626         dprintf("Posting lists:  %'7.1f MB\n", bytes_for_posting_lists / 1048576.0);
627         dprintf("Filename index: %'7.1f MB\n", bytes_for_filename_index / 1048576.0);
628         dprintf("Filenames:      %'7.1f MB\n", bytes_for_filenames / 1048576.0);
629         if (bytes_for_compressed_dir_times != 0) {
630                 dprintf("Modify times:   %'7.1f MB\n", bytes_for_compressed_dir_times / 1048576.0);
631         }
632         dprintf("Total:          %'7.1f MB\n", total_bytes / 1048576.0);
633         dprintf("\n");
634 }