]>
Commit | Line | Data |
---|---|---|
3449f8c4 | 1 | #include "cache.h" |
f394e093 | 2 | #include "gettext.h" |
3449f8c4 | 3 | #include "pack-revindex.h" |
a80d72db | 4 | #include "object-store.h" |
4828ce98 | 5 | #include "packfile.h" |
ec8e7760 | 6 | #include "config.h" |
f894081d | 7 | #include "midx.h" |
3449f8c4 | 8 | |
d5bc7c60 TB |
9 | struct revindex_entry { |
10 | off_t offset; | |
11 | unsigned int nr; | |
12 | }; | |
13 | ||
3449f8c4 NP |
14 | /* |
15 | * Pack index for existing packs give us easy access to the offsets into | |
16 | * corresponding pack file where each object's data starts, but the entries | |
17 | * do not store the size of the compressed representation (uncompressed | |
18 | * size is easily available by examining the pack entry header). It is | |
19 | * also rather expensive to find the sha1 for an object given its offset. | |
20 | * | |
f4015337 JK |
21 | * The pack index file is sorted by object name mapping to offset; |
22 | * this revindex array is a list of offset/index_nr pairs | |
3449f8c4 NP |
23 | * ordered by offset, so if you know the offset of an object, next offset |
24 | * is where its packed representation ends and the index_nr can be used to | |
25 | * get the object sha1 from the main index. | |
26 | */ | |
27 | ||
8b8dfd51 JK |
28 | /* |
29 | * This is a least-significant-digit radix sort. | |
30 | * | |
31 | * It sorts each of the "n" items in "entries" by its offset field. The "max" | |
32 | * parameter must be at least as large as the largest offset in the array, | |
33 | * and lets us quit the sort early. | |
34 | */ | |
35 | static void sort_revindex(struct revindex_entry *entries, unsigned n, off_t max) | |
3449f8c4 | 36 | { |
8b8dfd51 JK |
37 | /* |
38 | * We use a "digit" size of 16 bits. That keeps our memory | |
39 | * usage reasonable, and we can generally (for a 4G or smaller | |
40 | * packfile) quit after two rounds of radix-sorting. | |
41 | */ | |
42 | #define DIGIT_SIZE (16) | |
43 | #define BUCKETS (1 << DIGIT_SIZE) | |
44 | /* | |
45 | * We want to know the bucket that a[i] will go into when we are using | |
46 | * the digit that is N bits from the (least significant) end. | |
47 | */ | |
48 | #define BUCKET_FOR(a, i, bits) (((a)[(i)].offset >> (bits)) & (BUCKETS-1)) | |
49 | ||
50 | /* | |
51 | * We need O(n) temporary storage. Rather than do an extra copy of the | |
52 | * partial results into "entries", we sort back and forth between the | |
53 | * real array and temporary storage. In each iteration of the loop, we | |
54 | * keep track of them with alias pointers, always sorting from "from" | |
55 | * to "to". | |
56 | */ | |
b32fa95f | 57 | struct revindex_entry *tmp, *from, *to; |
8b8dfd51 | 58 | int bits; |
b32fa95f JK |
59 | unsigned *pos; |
60 | ||
61 | ALLOC_ARRAY(pos, BUCKETS); | |
62 | ALLOC_ARRAY(tmp, n); | |
63 | from = entries; | |
64 | to = tmp; | |
8b8dfd51 JK |
65 | |
66 | /* | |
67 | * If (max >> bits) is zero, then we know that the radix digit we are | |
68 | * on (and any higher) will be zero for all entries, and our loop will | |
69 | * be a no-op, as everybody lands in the same zero-th bucket. | |
70 | */ | |
71 | for (bits = 0; max >> bits; bits += DIGIT_SIZE) { | |
8b8dfd51 JK |
72 | unsigned i; |
73 | ||
74 | memset(pos, 0, BUCKETS * sizeof(*pos)); | |
75 | ||
76 | /* | |
77 | * We want pos[i] to store the index of the last element that | |
78 | * will go in bucket "i" (actually one past the last element). | |
79 | * To do this, we first count the items that will go in each | |
80 | * bucket, which gives us a relative offset from the last | |
81 | * bucket. We can then cumulatively add the index from the | |
82 | * previous bucket to get the true index. | |
83 | */ | |
84 | for (i = 0; i < n; i++) | |
85 | pos[BUCKET_FOR(from, i, bits)]++; | |
86 | for (i = 1; i < BUCKETS; i++) | |
87 | pos[i] += pos[i-1]; | |
88 | ||
89 | /* | |
90 | * Now we can drop the elements into their correct buckets (in | |
91 | * our temporary array). We iterate the pos counter backwards | |
92 | * to avoid using an extra index to count up. And since we are | |
93 | * going backwards there, we must also go backwards through the | |
94 | * array itself, to keep the sort stable. | |
95 | * | |
96 | * Note that we use an unsigned iterator to make sure we can | |
97 | * handle 2^32-1 objects, even on a 32-bit system. But this | |
98 | * means we cannot use the more obvious "i >= 0" loop condition | |
99 | * for counting backwards, and must instead check for | |
100 | * wrap-around with UINT_MAX. | |
101 | */ | |
102 | for (i = n - 1; i != UINT_MAX; i--) | |
103 | to[--pos[BUCKET_FOR(from, i, bits)]] = from[i]; | |
104 | ||
105 | /* | |
106 | * Now "to" contains the most sorted list, so we swap "from" and | |
107 | * "to" for the next iteration. | |
108 | */ | |
35d803bc | 109 | SWAP(from, to); |
8b8dfd51 JK |
110 | } |
111 | ||
112 | /* | |
113 | * If we ended with our data in the original array, great. If not, | |
114 | * we have to move it back from the temporary storage. | |
115 | */ | |
116 | if (from != entries) | |
45ccef87 | 117 | COPY_ARRAY(entries, tmp, n); |
8b8dfd51 JK |
118 | free(tmp); |
119 | free(pos); | |
120 | ||
121 | #undef BUCKET_FOR | |
122 | #undef BUCKETS | |
123 | #undef DIGIT_SIZE | |
3449f8c4 NP |
124 | } |
125 | ||
126 | /* | |
127 | * Ordered list of offsets of objects in the pack. | |
128 | */ | |
9d98bbf5 | 129 | static void create_pack_revindex(struct packed_git *p) |
3449f8c4 | 130 | { |
33de80b1 | 131 | const unsigned num_ent = p->num_objects; |
012b32bb | 132 | unsigned i; |
3449f8c4 | 133 | const char *index = p->index_data; |
fa130802 | 134 | const unsigned hashsz = the_hash_algo->rawsz; |
3449f8c4 | 135 | |
11529ece | 136 | ALLOC_ARRAY(p->revindex, num_ent + 1); |
3449f8c4 NP |
137 | index += 4 * 256; |
138 | ||
139 | if (p->index_version > 1) { | |
140 | const uint32_t *off_32 = | |
f86f7695 | 141 | (uint32_t *)(index + 8 + (size_t)p->num_objects * (hashsz + 4)); |
3449f8c4 NP |
142 | const uint32_t *off_64 = off_32 + p->num_objects; |
143 | for (i = 0; i < num_ent; i++) { | |
33de80b1 | 144 | const uint32_t off = ntohl(*off_32++); |
3449f8c4 | 145 | if (!(off & 0x80000000)) { |
9d98bbf5 | 146 | p->revindex[i].offset = off; |
3449f8c4 | 147 | } else { |
ad622a25 DS |
148 | p->revindex[i].offset = get_be64(off_64); |
149 | off_64 += 2; | |
3449f8c4 | 150 | } |
9d98bbf5 | 151 | p->revindex[i].nr = i; |
3449f8c4 NP |
152 | } |
153 | } else { | |
154 | for (i = 0; i < num_ent; i++) { | |
33de80b1 | 155 | const uint32_t hl = *((uint32_t *)(index + (hashsz + 4) * i)); |
9d98bbf5 JK |
156 | p->revindex[i].offset = ntohl(hl); |
157 | p->revindex[i].nr = i; | |
3449f8c4 NP |
158 | } |
159 | } | |
160 | ||
fa130802 | 161 | /* |
162 | * This knows the pack format -- the hash trailer | |
3449f8c4 NP |
163 | * follows immediately after the last object data. |
164 | */ | |
fa130802 | 165 | p->revindex[num_ent].offset = p->pack_size - hashsz; |
9d98bbf5 JK |
166 | p->revindex[num_ent].nr = -1; |
167 | sort_revindex(p->revindex, num_ent, p->pack_size); | |
3449f8c4 NP |
168 | } |
169 | ||
2f4ba2a8 | 170 | static int create_pack_revindex_in_memory(struct packed_git *p) |
3449f8c4 | 171 | { |
ec8e7760 TB |
172 | if (git_env_bool(GIT_TEST_REV_INDEX_DIE_IN_MEMORY, 0)) |
173 | die("dying as requested by '%s'", | |
174 | GIT_TEST_REV_INDEX_DIE_IN_MEMORY); | |
2f4ba2a8 TB |
175 | if (open_pack_index(p)) |
176 | return -1; | |
177 | create_pack_revindex(p); | |
4828ce98 | 178 | return 0; |
92e5c77c VM |
179 | } |
180 | ||
2f4ba2a8 TB |
181 | static char *pack_revindex_filename(struct packed_git *p) |
182 | { | |
183 | size_t len; | |
184 | if (!strip_suffix(p->pack_name, ".pack", &len)) | |
185 | BUG("pack_name does not end in .pack"); | |
186 | return xstrfmt("%.*s.rev", (int)len, p->pack_name); | |
187 | } | |
188 | ||
189 | #define RIDX_HEADER_SIZE (12) | |
190 | #define RIDX_MIN_SIZE (RIDX_HEADER_SIZE + (2 * the_hash_algo->rawsz)) | |
191 | ||
192 | struct revindex_header { | |
193 | uint32_t signature; | |
194 | uint32_t version; | |
195 | uint32_t hash_id; | |
196 | }; | |
197 | ||
198 | static int load_revindex_from_disk(char *revindex_name, | |
199 | uint32_t num_objects, | |
200 | const uint32_t **data_p, size_t *len_p) | |
201 | { | |
202 | int fd, ret = 0; | |
203 | struct stat st; | |
204 | void *data = NULL; | |
205 | size_t revindex_size; | |
206 | struct revindex_header *hdr; | |
207 | ||
2a250d61 TB |
208 | if (git_env_bool(GIT_TEST_REV_INDEX_DIE_ON_DISK, 0)) |
209 | die("dying as requested by '%s'", GIT_TEST_REV_INDEX_DIE_ON_DISK); | |
210 | ||
2f4ba2a8 TB |
211 | fd = git_open(revindex_name); |
212 | ||
213 | if (fd < 0) { | |
214 | ret = -1; | |
215 | goto cleanup; | |
216 | } | |
217 | if (fstat(fd, &st)) { | |
218 | ret = error_errno(_("failed to read %s"), revindex_name); | |
219 | goto cleanup; | |
220 | } | |
221 | ||
222 | revindex_size = xsize_t(st.st_size); | |
223 | ||
224 | if (revindex_size < RIDX_MIN_SIZE) { | |
225 | ret = error(_("reverse-index file %s is too small"), revindex_name); | |
226 | goto cleanup; | |
227 | } | |
228 | ||
229 | if (revindex_size - RIDX_MIN_SIZE != st_mult(sizeof(uint32_t), num_objects)) { | |
230 | ret = error(_("reverse-index file %s is corrupt"), revindex_name); | |
231 | goto cleanup; | |
232 | } | |
233 | ||
234 | data = xmmap(NULL, revindex_size, PROT_READ, MAP_PRIVATE, fd, 0); | |
235 | hdr = data; | |
236 | ||
237 | if (ntohl(hdr->signature) != RIDX_SIGNATURE) { | |
238 | ret = error(_("reverse-index file %s has unknown signature"), revindex_name); | |
239 | goto cleanup; | |
240 | } | |
241 | if (ntohl(hdr->version) != 1) { | |
242 | ret = error(_("reverse-index file %s has unsupported version %"PRIu32), | |
243 | revindex_name, ntohl(hdr->version)); | |
244 | goto cleanup; | |
245 | } | |
246 | if (!(ntohl(hdr->hash_id) == 1 || ntohl(hdr->hash_id) == 2)) { | |
247 | ret = error(_("reverse-index file %s has unsupported hash id %"PRIu32), | |
248 | revindex_name, ntohl(hdr->hash_id)); | |
249 | goto cleanup; | |
250 | } | |
251 | ||
252 | cleanup: | |
253 | if (ret) { | |
254 | if (data) | |
255 | munmap(data, revindex_size); | |
256 | } else { | |
257 | *len_p = revindex_size; | |
258 | *data_p = (const uint32_t *)data; | |
259 | } | |
260 | ||
66f52fa2 TB |
261 | if (fd >= 0) |
262 | close(fd); | |
2f4ba2a8 TB |
263 | return ret; |
264 | } | |
265 | ||
266 | static int load_pack_revindex_from_disk(struct packed_git *p) | |
267 | { | |
268 | char *revindex_name; | |
269 | int ret; | |
270 | if (open_pack_index(p)) | |
271 | return -1; | |
272 | ||
273 | revindex_name = pack_revindex_filename(p); | |
274 | ||
275 | ret = load_revindex_from_disk(revindex_name, | |
276 | p->num_objects, | |
277 | &p->revindex_map, | |
278 | &p->revindex_size); | |
279 | if (ret) | |
280 | goto cleanup; | |
281 | ||
282 | p->revindex_data = (const uint32_t *)((const char *)p->revindex_map + RIDX_HEADER_SIZE); | |
283 | ||
284 | cleanup: | |
285 | free(revindex_name); | |
286 | return ret; | |
287 | } | |
288 | ||
65308ad8 | 289 | int load_pack_revindex(struct repository *r, struct packed_git *p) |
2f4ba2a8 TB |
290 | { |
291 | if (p->revindex || p->revindex_data) | |
292 | return 0; | |
293 | ||
dbcf6116 TB |
294 | prepare_repo_settings(r); |
295 | ||
296 | if (r->settings.pack_read_reverse_index && | |
297 | !load_pack_revindex_from_disk(p)) | |
2f4ba2a8 TB |
298 | return 0; |
299 | else if (!create_pack_revindex_in_memory(p)) | |
300 | return 0; | |
301 | return -1; | |
302 | } | |
303 | ||
0d30feef DS |
304 | /* |
305 | * verify_pack_revindex verifies that the on-disk rev-index for the given | |
306 | * pack-file is the same that would be created if written from scratch. | |
307 | * | |
308 | * A negative number is returned on error. | |
309 | */ | |
310 | int verify_pack_revindex(struct packed_git *p) | |
311 | { | |
312 | return 0; | |
313 | } | |
314 | ||
f894081d TB |
315 | int load_midx_revindex(struct multi_pack_index *m) |
316 | { | |
60980aed | 317 | struct strbuf revindex_name = STRBUF_INIT; |
f894081d | 318 | int ret; |
7f514b7a | 319 | |
f894081d TB |
320 | if (m->revindex_data) |
321 | return 0; | |
322 | ||
7f514b7a TB |
323 | if (m->chunk_revindex) { |
324 | /* | |
325 | * If the MIDX `m` has a `RIDX` chunk, then use its contents for | |
326 | * the reverse index instead of trying to load a separate `.rev` | |
327 | * file. | |
328 | * | |
329 | * Note that we do *not* set `m->revindex_map` here, since we do | |
330 | * not want to accidentally call munmap() in the middle of the | |
331 | * MIDX. | |
332 | */ | |
333 | trace2_data_string("load_midx_revindex", the_repository, | |
334 | "source", "midx"); | |
335 | m->revindex_data = (const uint32_t *)m->chunk_revindex; | |
336 | return 0; | |
337 | } | |
338 | ||
09a77999 TB |
339 | trace2_data_string("load_midx_revindex", the_repository, |
340 | "source", "rev"); | |
341 | ||
60980aed | 342 | get_midx_rev_filename(&revindex_name, m); |
f894081d | 343 | |
60980aed | 344 | ret = load_revindex_from_disk(revindex_name.buf, |
f894081d TB |
345 | m->num_objects, |
346 | &m->revindex_map, | |
347 | &m->revindex_len); | |
348 | if (ret) | |
349 | goto cleanup; | |
350 | ||
351 | m->revindex_data = (const uint32_t *)((const char *)m->revindex_map + RIDX_HEADER_SIZE); | |
352 | ||
353 | cleanup: | |
60980aed | 354 | strbuf_release(&revindex_name); |
f894081d TB |
355 | return ret; |
356 | } | |
357 | ||
358 | int close_midx_revindex(struct multi_pack_index *m) | |
359 | { | |
360 | if (!m || !m->revindex_map) | |
361 | return 0; | |
362 | ||
363 | munmap((void*)m->revindex_map, m->revindex_len); | |
364 | ||
365 | m->revindex_map = NULL; | |
366 | m->revindex_data = NULL; | |
367 | m->revindex_len = 0; | |
368 | ||
369 | return 0; | |
370 | } | |
371 | ||
8389855a | 372 | int offset_to_pack_pos(struct packed_git *p, off_t ofs, uint32_t *pos) |
92e5c77c | 373 | { |
8389855a | 374 | unsigned lo, hi; |
8389855a | 375 | |
65308ad8 | 376 | if (load_pack_revindex(the_repository, p) < 0) |
8389855a TB |
377 | return -1; |
378 | ||
379 | lo = 0; | |
380 | hi = p->num_objects + 1; | |
92e5c77c | 381 | |
3449f8c4 | 382 | do { |
33de80b1 | 383 | const unsigned mi = lo + (hi - lo) / 2; |
e5dcd784 TB |
384 | off_t got = pack_pos_to_offset(p, mi); |
385 | ||
386 | if (got == ofs) { | |
8389855a TB |
387 | *pos = mi; |
388 | return 0; | |
e5dcd784 | 389 | } else if (ofs < got) |
3449f8c4 NP |
390 | hi = mi; |
391 | else | |
392 | lo = mi + 1; | |
393 | } while (lo < hi); | |
92e5c77c | 394 | |
08698b1e | 395 | error("bad offset for revindex"); |
92e5c77c VM |
396 | return -1; |
397 | } | |
398 | ||
f33fb6e4 TB |
399 | uint32_t pack_pos_to_index(struct packed_git *p, uint32_t pos) |
400 | { | |
2f4ba2a8 | 401 | if (!(p->revindex || p->revindex_data)) |
f33fb6e4 TB |
402 | BUG("pack_pos_to_index: reverse index not yet loaded"); |
403 | if (p->num_objects <= pos) | |
404 | BUG("pack_pos_to_index: out-of-bounds object at %"PRIu32, pos); | |
2f4ba2a8 TB |
405 | |
406 | if (p->revindex) | |
407 | return p->revindex[pos].nr; | |
408 | else | |
409 | return get_be32(p->revindex_data + pos); | |
f33fb6e4 TB |
410 | } |
411 | ||
412 | off_t pack_pos_to_offset(struct packed_git *p, uint32_t pos) | |
413 | { | |
2f4ba2a8 | 414 | if (!(p->revindex || p->revindex_data)) |
f33fb6e4 TB |
415 | BUG("pack_pos_to_index: reverse index not yet loaded"); |
416 | if (p->num_objects < pos) | |
417 | BUG("pack_pos_to_offset: out-of-bounds object at %"PRIu32, pos); | |
2f4ba2a8 TB |
418 | |
419 | if (p->revindex) | |
420 | return p->revindex[pos].offset; | |
421 | else if (pos == p->num_objects) | |
422 | return p->pack_size - the_hash_algo->rawsz; | |
423 | else | |
424 | return nth_packed_object_offset(p, pack_pos_to_index(p, pos)); | |
f33fb6e4 | 425 | } |
f894081d TB |
426 | |
427 | uint32_t pack_pos_to_midx(struct multi_pack_index *m, uint32_t pos) | |
428 | { | |
429 | if (!m->revindex_data) | |
430 | BUG("pack_pos_to_midx: reverse index not yet loaded"); | |
431 | if (m->num_objects <= pos) | |
432 | BUG("pack_pos_to_midx: out-of-bounds object at %"PRIu32, pos); | |
433 | return get_be32(m->revindex_data + pos); | |
434 | } | |
435 | ||
436 | struct midx_pack_key { | |
437 | uint32_t pack; | |
438 | off_t offset; | |
439 | ||
440 | uint32_t preferred_pack; | |
441 | struct multi_pack_index *midx; | |
442 | }; | |
443 | ||
444 | static int midx_pack_order_cmp(const void *va, const void *vb) | |
445 | { | |
446 | const struct midx_pack_key *key = va; | |
447 | struct multi_pack_index *midx = key->midx; | |
448 | ||
449 | uint32_t versus = pack_pos_to_midx(midx, (uint32_t*)vb - (const uint32_t *)midx->revindex_data); | |
450 | uint32_t versus_pack = nth_midxed_pack_int_id(midx, versus); | |
451 | off_t versus_offset; | |
452 | ||
453 | uint32_t key_preferred = key->pack == key->preferred_pack; | |
454 | uint32_t versus_preferred = versus_pack == key->preferred_pack; | |
455 | ||
456 | /* | |
457 | * First, compare the preferred-ness, noting that the preferred pack | |
458 | * comes first. | |
459 | */ | |
460 | if (key_preferred && !versus_preferred) | |
461 | return -1; | |
462 | else if (!key_preferred && versus_preferred) | |
463 | return 1; | |
464 | ||
465 | /* Then, break ties first by comparing the pack IDs. */ | |
466 | if (key->pack < versus_pack) | |
467 | return -1; | |
468 | else if (key->pack > versus_pack) | |
469 | return 1; | |
470 | ||
471 | /* Finally, break ties by comparing offsets within a pack. */ | |
472 | versus_offset = nth_midxed_offset(midx, versus); | |
473 | if (key->offset < versus_offset) | |
474 | return -1; | |
475 | else if (key->offset > versus_offset) | |
476 | return 1; | |
477 | ||
478 | return 0; | |
479 | } | |
480 | ||
481 | int midx_to_pack_pos(struct multi_pack_index *m, uint32_t at, uint32_t *pos) | |
482 | { | |
483 | struct midx_pack_key key; | |
484 | uint32_t *found; | |
485 | ||
486 | if (!m->revindex_data) | |
487 | BUG("midx_to_pack_pos: reverse index not yet loaded"); | |
488 | if (m->num_objects <= at) | |
489 | BUG("midx_to_pack_pos: out-of-bounds object at %"PRIu32, at); | |
490 | ||
491 | key.pack = nth_midxed_pack_int_id(m, at); | |
492 | key.offset = nth_midxed_offset(m, at); | |
493 | key.midx = m; | |
494 | /* | |
495 | * The preferred pack sorts first, so determine its identifier by | |
496 | * looking at the first object in pseudo-pack order. | |
497 | * | |
498 | * Note that if no --preferred-pack is explicitly given when writing a | |
499 | * multi-pack index, then whichever pack has the lowest identifier | |
500 | * implicitly is preferred (and includes all its objects, since ties are | |
501 | * broken first by pack identifier). | |
502 | */ | |
503 | key.preferred_pack = nth_midxed_pack_int_id(m, pack_pos_to_midx(m, 0)); | |
504 | ||
505 | found = bsearch(&key, m->revindex_data, m->num_objects, | |
506 | sizeof(*m->revindex_data), midx_pack_order_cmp); | |
507 | ||
508 | if (!found) | |
509 | return error("bad offset for revindex"); | |
510 | ||
511 | *pos = found - m->revindex_data; | |
512 | return 0; | |
513 | } |