2 #include "turbopfor-encode.h"
16 #include <string_view>
22 #define P4NENC_BOUND(n) ((n + 127) / 128 + (n + 32) * sizeof(uint32_t))
24 //#define dprintf(...) fprintf(stderr, __VA_ARGS__);
26 #define NUM_TRIGRAMS 16777216
29 using namespace std::chrono;
31 string zstd_compress(const string &src, string *tempbuf);
33 constexpr unsigned num_overflow_slots = 16;
35 static inline uint32_t read_unigram(const string_view s, size_t idx)
38 return (unsigned char)s[idx];
44 static inline uint32_t read_trigram(const string_view s, size_t start)
46 return read_unigram(s, start) |
47 (read_unigram(s, start + 1) << 8) |
48 (read_unigram(s, start + 2) << 16);
52 DBE_NORMAL = 0, /* A non-directory file */
53 DBE_DIRECTORY = 1, /* A directory */
54 DBE_END = 2 /* End of directory contents; contains no name */
62 uint8_t check_visibility;
73 class PostingListBuilder {
75 inline void add_docid(uint32_t docid);
79 size_t num_docids = 0;
82 void write_header(uint32_t docid);
85 vector<uint32_t> pending_deltas;
87 uint32_t last_block_end, last_docid = -1;
90 void PostingListBuilder::add_docid(uint32_t docid)
92 // Deduplicate against the last inserted value, if any.
93 if (docid == last_docid) {
97 if (num_docids == 0) {
101 last_block_end = last_docid = docid;
105 pending_deltas.push_back(docid - last_docid - 1);
107 if (pending_deltas.size() == 128) {
109 pending_deltas.clear();
110 last_block_end = docid;
115 void PostingListBuilder::finish()
117 if (pending_deltas.empty()) {
121 assert(!encoded.empty()); // write_header() should already have run.
123 // No interleaving for partial blocks.
124 unsigned char buf[P4NENC_BOUND(128)];
125 unsigned char *end = encode_pfor_single_block<128>(pending_deltas.data(), pending_deltas.size(), /*interleaved=*/false, buf);
126 encoded.append(reinterpret_cast<char *>(buf), reinterpret_cast<char *>(end));
129 void PostingListBuilder::append_block()
131 unsigned char buf[P4NENC_BOUND(128)];
132 assert(pending_deltas.size() == 128);
133 unsigned char *end = encode_pfor_single_block<128>(pending_deltas.data(), 128, /*interleaved=*/true, buf);
134 encoded.append(reinterpret_cast<char *>(buf), reinterpret_cast<char *>(end));
137 void PostingListBuilder::write_header(uint32_t docid)
139 unsigned char buf[P4NENC_BOUND(1)];
140 unsigned char *end = write_baseval(docid, buf);
141 encoded.append(reinterpret_cast<char *>(buf), end - buf);
146 Corpus(FILE *outfp, size_t block_size)
147 : invindex(new PostingListBuilder *[NUM_TRIGRAMS]), outfp(outfp), block_size(block_size)
149 fill(invindex.get(), invindex.get() + NUM_TRIGRAMS, nullptr);
153 for (unsigned i = 0; i < NUM_TRIGRAMS; ++i) {
158 void add_file(string filename);
161 vector<uint64_t> filename_blocks;
162 size_t num_files = 0, num_files_in_block = 0, num_blocks = 0;
163 bool seen_trigram(uint32_t trgm)
165 return invindex[trgm] != nullptr;
167 PostingListBuilder &get_pl_builder(uint32_t trgm)
169 if (invindex[trgm] == nullptr) {
170 invindex[trgm] = new PostingListBuilder;
172 return *invindex[trgm];
176 unique_ptr<PostingListBuilder *[]> invindex;
178 string current_block;
180 const size_t block_size;
183 void Corpus::add_file(string filename)
186 if (!current_block.empty()) {
187 current_block.push_back('\0');
189 current_block += filename;
190 if (++num_files_in_block == block_size) {
195 void Corpus::flush_block()
197 if (current_block.empty()) {
201 uint32_t docid = num_blocks;
204 const char *ptr = current_block.c_str();
205 while (ptr < current_block.c_str() + current_block.size()) {
208 for (size_t j = 0; j < s.size() - 2; ++j) {
209 uint32_t trgm = read_trigram(s, j);
210 get_pl_builder(trgm).add_docid(docid);
216 // Compress and add the filename block.
217 filename_blocks.push_back(ftell(outfp));
218 string compressed = zstd_compress(current_block, &tempbuf);
219 if (fwrite(compressed.data(), compressed.size(), 1, outfp) != 1) {
224 current_block.clear();
225 num_files_in_block = 0;
229 string read_cstr(FILE *fp)
245 void handle_directory(FILE *fp, Corpus *corpus)
248 if (fread(&dummy, sizeof(dummy), 1, fp) != 1) {
256 string dir_path = read_cstr(fp);
257 if (dir_path == "/") {
263 if (type == DBE_NORMAL) {
264 string filename = read_cstr(fp);
265 corpus->add_file(dir_path + "/" + filename);
266 } else if (type == DBE_DIRECTORY) {
267 string dirname = read_cstr(fp);
268 corpus->add_file(dir_path + "/" + dirname);
270 return; // Probably end.
275 void read_mlocate(const char *filename, Corpus *corpus)
277 FILE *fp = fopen(filename, "rb");
284 if (fread(&hdr, sizeof(hdr), 1, fp) != 1) {
285 perror("short read");
289 // TODO: Care about the base path.
290 string path = read_cstr(fp);
292 handle_directory(fp, corpus);
297 string zstd_compress(const string &src, string *tempbuf)
299 size_t max_size = ZSTD_compressBound(src.size());
300 if (tempbuf->size() < max_size) {
301 tempbuf->resize(max_size);
303 size_t size = ZSTD_compress(&(*tempbuf)[0], max_size, src.data(), src.size(), /*level=*/6);
304 return string(tempbuf->data(), size);
307 bool is_prime(uint32_t x)
309 if ((x % 2) == 0 || (x % 3) == 0) {
312 uint32_t limit = ceil(sqrt(x));
313 for (uint32_t factor = 5; factor <= limit; ++factor) {
314 if ((x % factor) == 0) {
321 uint32_t next_prime(uint32_t x)
326 while (!is_prime(x)) {
332 unique_ptr<Trigram[]> create_hashtable(Corpus &corpus, const vector<uint32_t> &all_trigrams, uint32_t ht_size, uint32_t num_overflow_slots)
334 unique_ptr<Trigram[]> ht(new Trigram[ht_size + num_overflow_slots + 1]); // 1 for the sentinel element at the end.
335 for (unsigned i = 0; i < ht_size + num_overflow_slots + 1; ++i) {
336 ht[i].trgm = uint32_t(-1);
337 ht[i].num_docids = 0;
340 for (uint32_t trgm : all_trigrams) {
341 // We don't know offset yet, so set it to zero.
342 Trigram to_insert{ trgm, uint32_t(corpus.get_pl_builder(trgm).num_docids), 0 };
344 uint32_t bucket = hash_trigram(trgm, ht_size);
345 unsigned distance = 0;
346 while (ht[bucket].num_docids != 0) {
347 // Robin Hood hashing; reduces the longest distance by a lot.
348 unsigned other_distance = bucket - hash_trigram(ht[bucket].trgm, ht_size);
349 if (distance > other_distance) {
350 swap(to_insert, ht[bucket]);
351 distance = other_distance;
354 ++bucket, ++distance;
355 if (distance > num_overflow_slots) {
359 ht[bucket] = to_insert;
364 void do_build(const char *infile, const char *outfile, int block_size)
366 steady_clock::time_point start __attribute__((unused)) = steady_clock::now();
369 FILE *outfp = fopen(outfile, "wb");
373 memcpy(hdr.magic, "\0plocate", 8);
374 hdr.version = -1; // Mark as broken.
375 hdr.hashtable_size = 0; // Not known yet.
376 hdr.extra_ht_slots = num_overflow_slots;
378 hdr.hash_table_offset_bytes = -1; // We don't know these offsets yet.
379 hdr.filename_index_offset_bytes = -1;
380 fwrite(&hdr, sizeof(hdr), 1, outfp);
382 Corpus corpus(outfp, block_size);
384 read_mlocate(infile, &corpus);
385 if (false) { // To read a plain text file.
386 FILE *fp = fopen(infile, "r");
389 if (fgets(buf, 1024, fp) == nullptr || feof(fp)) {
393 if (s.back() == '\n')
395 corpus.add_file(move(s));
399 corpus.flush_block();
400 dprintf("Read %zu files from %s\n", corpus.num_files, infile);
401 hdr.num_docids = corpus.filename_blocks.size();
403 // Stick an empty block at the end as sentinel.
404 corpus.filename_blocks.push_back(ftell(outfp));
405 const size_t bytes_for_filenames = corpus.filename_blocks.back() - corpus.filename_blocks.front();
407 // Write the offsets to the filenames.
408 hdr.filename_index_offset_bytes = ftell(outfp);
409 const size_t bytes_for_filename_index = corpus.filename_blocks.size() * sizeof(uint64_t);
410 fwrite(corpus.filename_blocks.data(), corpus.filename_blocks.size(), sizeof(uint64_t), outfp);
411 corpus.filename_blocks.clear();
412 corpus.filename_blocks.shrink_to_fit();
414 // Finish up encoding the posting lists.
415 size_t trigrams = 0, longest_posting_list = 0;
416 size_t bytes_for_posting_lists = 0;
417 for (unsigned trgm = 0; trgm < NUM_TRIGRAMS; ++trgm) {
418 if (!corpus.seen_trigram(trgm))
420 PostingListBuilder &pl_builder = corpus.get_pl_builder(trgm);
422 longest_posting_list = max(longest_posting_list, pl_builder.num_docids);
423 trigrams += pl_builder.num_docids;
424 bytes_for_posting_lists += pl_builder.encoded.size();
426 dprintf("%zu files, %zu different trigrams, %zu entries, avg len %.2f, longest %zu\n",
427 corpus.num_files, corpus.invindex.size(), trigrams, double(trigrams) / corpus.invindex.size(), longest_posting_list);
428 dprintf("%zu bytes used for posting lists (%.2f bits/entry)\n", bytes_for_posting_lists, 8 * bytes_for_posting_lists / double(trigrams));
430 dprintf("Building posting lists took %.1f ms.\n\n", 1e3 * duration<float>(steady_clock::now() - start).count());
432 // Find the used trigrams.
433 vector<uint32_t> all_trigrams;
434 for (unsigned trgm = 0; trgm < NUM_TRIGRAMS; ++trgm) {
435 if (corpus.seen_trigram(trgm)) {
436 all_trigrams.push_back(trgm);
440 // Create the hash table.
441 unique_ptr<Trigram[]> hashtable;
442 uint32_t ht_size = next_prime(all_trigrams.size());
444 hashtable = create_hashtable(corpus, all_trigrams, ht_size, num_overflow_slots);
445 if (hashtable == nullptr) {
446 dprintf("Failed creating hash table of size %u, increasing by 5%% and trying again.\n", ht_size);
447 ht_size = next_prime(ht_size * 1.05);
449 dprintf("Created hash table of size %u.\n\n", ht_size);
454 // Find the offsets for each posting list.
455 size_t bytes_for_hashtable = (ht_size + num_overflow_slots + 1) * sizeof(Trigram);
456 uint64_t offset = ftell(outfp) + bytes_for_hashtable;
457 for (unsigned i = 0; i < ht_size + num_overflow_slots + 1; ++i) {
458 hashtable[i].offset = offset; // Needs to be there even for empty slots.
459 if (hashtable[i].num_docids == 0) {
463 const string &encoded = corpus.get_pl_builder(hashtable[i].trgm).encoded;
464 offset += encoded.size();
467 // Write the hash table.
468 hdr.hash_table_offset_bytes = ftell(outfp);
469 hdr.hashtable_size = ht_size;
470 fwrite(hashtable.get(), ht_size + num_overflow_slots + 1, sizeof(Trigram), outfp);
472 // Write the actual posting lists.
473 for (unsigned i = 0; i < ht_size + num_overflow_slots + 1; ++i) {
474 if (hashtable[i].num_docids == 0) {
477 const string &encoded = corpus.get_pl_builder(hashtable[i].trgm).encoded;
478 fwrite(encoded.data(), encoded.size(), 1, outfp);
481 // Rewind, and write the updated header.
483 fseek(outfp, 0, SEEK_SET);
484 fwrite(&hdr, sizeof(hdr), 1, outfp);
487 size_t total_bytes __attribute__((unused)) = (bytes_for_hashtable + bytes_for_posting_lists + bytes_for_filename_index + bytes_for_filenames);
489 dprintf("Block size: %7d files\n", block_size);
490 dprintf("Hash table: %'7.1f MB\n", bytes_for_hashtable / 1048576.0);
491 dprintf("Posting lists: %'7.1f MB\n", bytes_for_posting_lists / 1048576.0);
492 dprintf("Filename index: %'7.1f MB\n", bytes_for_filename_index / 1048576.0);
493 dprintf("Filenames: %'7.1f MB\n", bytes_for_filenames / 1048576.0);
494 dprintf("Total: %'7.1f MB\n", total_bytes / 1048576.0);
501 "Usage: plocate-build MLOCATE_DB PLOCATE_DB\n"
503 "Generate plocate index from mlocate.db, typically /var/lib/mlocate/mlocate.db.\n"
504 "Normally, the destination should be /var/lib/mlocate/plocate.db.\n"
506 " -b, --block-size SIZE number of filenames to store in each block (default 32)\n"
507 " --help print this help\n"
508 " --version print version information\n");
513 printf("plocate-build %s\n", PLOCATE_VERSION);
514 printf("Copyright 2020 Steinar H. Gunderson\n");
515 printf("License GPLv2+: GNU GPL version 2 or later <https://gnu.org/licenses/gpl.html>.\n");
516 printf("This is free software: you are free to change and redistribute it.\n");
517 printf("There is NO WARRANTY, to the extent permitted by law.\n");
520 int main(int argc, char **argv)
522 static const struct option long_options[] = {
523 { "block-size", required_argument, 0, 'b' },
524 { "help", no_argument, 0, 'h' },
525 { "version", no_argument, 0, 'V' },
531 setlocale(LC_ALL, "");
533 int option_index = 0;
534 int c = getopt_long(argc, argv, "b:hV", long_options, &option_index);
540 block_size = atoi(optarg);
553 if (argc - optind != 2) {
558 do_build(argv[optind], argv[optind + 1], block_size);