]>
Commit | Line | Data |
---|---|---|
a97a7468 | 1 | #include "cache.h" |
b2141fc1 | 2 | #include "config.h" |
a97a7468 | 3 | #include "notes.h" |
cbd53a21 | 4 | #include "object-store.h" |
73f464b5 | 5 | #include "blob.h" |
61a7cca0 | 6 | #include "tree.h" |
a97a7468 JS |
7 | #include "utf8.h" |
8 | #include "strbuf.h" | |
fd53c9eb | 9 | #include "tree-walk.h" |
894a9d33 TR |
10 | #include "string-list.h" |
11 | #include "refs.h" | |
fd53c9eb | 12 | |
23123aec JH |
13 | /* |
14 | * Use a non-balancing simple 16-tree structure with struct int_node as | |
15 | * internal nodes, and struct leaf_node as leaf nodes. Each int_node has a | |
16 | * 16-array of pointers to its children. | |
17 | * The bottom 2 bits of each pointer is used to identify the pointer type | |
18 | * - ptr & 3 == 0 - NULL pointer, assert(ptr == NULL) | |
19 | * - ptr & 3 == 1 - pointer to next internal node - cast to struct int_node * | |
20 | * - ptr & 3 == 2 - pointer to note entry - cast to struct leaf_node * | |
21 | * - ptr & 3 == 3 - pointer to subtree entry - cast to struct leaf_node * | |
22 | * | |
23 | * The root node is a statically allocated struct int_node. | |
24 | */ | |
25 | struct int_node { | |
26 | void *a[16]; | |
fd53c9eb JS |
27 | }; |
28 | ||
23123aec JH |
29 | /* |
30 | * Leaf nodes come in two variants, note entries and subtree entries, | |
31 | * distinguished by the LSb of the leaf node pointer (see above). | |
a7e7eff6 | 32 | * As a note entry, the key is the SHA1 of the referenced object, and the |
23123aec JH |
33 | * value is the SHA1 of the note object. |
34 | * As a subtree entry, the key is the prefix SHA1 (w/trailing NULs) of the | |
a7e7eff6 | 35 | * referenced object, using the last byte of the key to store the length of |
23123aec JH |
36 | * the prefix. The value is the SHA1 of the tree object containing the notes |
37 | * subtree. | |
38 | */ | |
39 | struct leaf_node { | |
5dcc969e | 40 | struct object_id key_oid; |
41 | struct object_id val_oid; | |
fd53c9eb | 42 | }; |
a97a7468 | 43 | |
851c2b37 JH |
44 | /* |
45 | * A notes tree may contain entries that are not notes, and that do not follow | |
46 | * the naming conventions of notes. There are typically none/few of these, but | |
47 | * we still need to keep track of them. Keep a simple linked list sorted alpha- | |
48 | * betically on the non-note path. The list is populated when parsing tree | |
49 | * objects in load_subtree(), and the non-notes are correctly written back into | |
50 | * the tree objects produced by write_notes_tree(). | |
51 | */ | |
52 | struct non_note { | |
53 | struct non_note *next; /* grounded (last->next == NULL) */ | |
54 | char *path; | |
55 | unsigned int mode; | |
5dcc969e | 56 | struct object_id oid; |
851c2b37 JH |
57 | }; |
58 | ||
23123aec JH |
59 | #define PTR_TYPE_NULL 0 |
60 | #define PTR_TYPE_INTERNAL 1 | |
61 | #define PTR_TYPE_NOTE 2 | |
62 | #define PTR_TYPE_SUBTREE 3 | |
fd53c9eb | 63 | |
23123aec JH |
64 | #define GET_PTR_TYPE(ptr) ((uintptr_t) (ptr) & 3) |
65 | #define CLR_PTR_TYPE(ptr) ((void *) ((uintptr_t) (ptr) & ~3)) | |
66 | #define SET_PTR_TYPE(ptr, type) ((void *) ((uintptr_t) (ptr) | (type))) | |
fd53c9eb | 67 | |
65eb8e0c | 68 | #define GET_NIBBLE(n, sha1) ((((sha1)[(n) >> 1]) >> ((~(n) & 0x01) << 2)) & 0x0f) |
fd53c9eb | 69 | |
dd437451 | 70 | #define KEY_INDEX (the_hash_algo->rawsz - 1) |
71 | #define FANOUT_PATH_SEPARATORS (the_hash_algo->rawsz - 1) | |
72 | #define FANOUT_PATH_SEPARATORS_MAX ((GIT_MAX_HEXSZ / 2) - 1) | |
23123aec | 73 | #define SUBTREE_SHA1_PREFIXCMP(key_sha1, subtree_sha1) \ |
89c149f5 | 74 | (memcmp(key_sha1, subtree_sha1, subtree_sha1[KEY_INDEX])) |
fd53c9eb | 75 | |
cd305392 | 76 | struct notes_tree default_notes_tree; |
23123aec | 77 | |
2721ce21 | 78 | static struct string_list display_notes_refs = STRING_LIST_INIT_NODUP; |
894a9d33 TR |
79 | static struct notes_tree **display_notes_trees; |
80 | ||
851c2b37 JH |
81 | static void load_subtree(struct notes_tree *t, struct leaf_node *subtree, |
82 | struct int_node *node, unsigned int n); | |
23123aec JH |
83 | |
84 | /* | |
ef8db638 | 85 | * Search the tree until the appropriate location for the given key is found: |
23123aec | 86 | * 1. Start at the root node, with n = 0 |
ef8db638 JH |
87 | * 2. If a[0] at the current level is a matching subtree entry, unpack that |
88 | * subtree entry and remove it; restart search at the current level. | |
89 | * 3. Use the nth nibble of the key as an index into a: | |
90 | * - If a[n] is an int_node, recurse from #2 into that node and increment n | |
23123aec JH |
91 | * - If a matching subtree entry, unpack that subtree entry (and remove it); |
92 | * restart search at the current level. | |
ef8db638 JH |
93 | * - Otherwise, we have found one of the following: |
94 | * - a subtree entry which does not match the key | |
95 | * - a note entry which may or may not match the key | |
96 | * - an unused leaf node (NULL) | |
97 | * In any case, set *tree and *n, and return pointer to the tree location. | |
23123aec | 98 | */ |
851c2b37 | 99 | static void **note_tree_search(struct notes_tree *t, struct int_node **tree, |
ef8db638 | 100 | unsigned char *n, const unsigned char *key_sha1) |
23123aec JH |
101 | { |
102 | struct leaf_node *l; | |
ef8db638 JH |
103 | unsigned char i; |
104 | void *p = (*tree)->a[0]; | |
23123aec | 105 | |
ef8db638 JH |
106 | if (GET_PTR_TYPE(p) == PTR_TYPE_SUBTREE) { |
107 | l = (struct leaf_node *) CLR_PTR_TYPE(p); | |
5dcc969e | 108 | if (!SUBTREE_SHA1_PREFIXCMP(key_sha1, l->key_oid.hash)) { |
ef8db638 JH |
109 | /* unpack tree and resume search */ |
110 | (*tree)->a[0] = NULL; | |
851c2b37 | 111 | load_subtree(t, l, *tree, *n); |
ef8db638 | 112 | free(l); |
851c2b37 | 113 | return note_tree_search(t, tree, n, key_sha1); |
ef8db638 JH |
114 | } |
115 | } | |
116 | ||
117 | i = GET_NIBBLE(*n, key_sha1); | |
118 | p = (*tree)->a[i]; | |
0ab1faae | 119 | switch (GET_PTR_TYPE(p)) { |
23123aec | 120 | case PTR_TYPE_INTERNAL: |
ef8db638 JH |
121 | *tree = CLR_PTR_TYPE(p); |
122 | (*n)++; | |
851c2b37 | 123 | return note_tree_search(t, tree, n, key_sha1); |
23123aec JH |
124 | case PTR_TYPE_SUBTREE: |
125 | l = (struct leaf_node *) CLR_PTR_TYPE(p); | |
5dcc969e | 126 | if (!SUBTREE_SHA1_PREFIXCMP(key_sha1, l->key_oid.hash)) { |
23123aec | 127 | /* unpack tree and resume search */ |
ef8db638 | 128 | (*tree)->a[i] = NULL; |
851c2b37 | 129 | load_subtree(t, l, *tree, *n); |
23123aec | 130 | free(l); |
851c2b37 | 131 | return note_tree_search(t, tree, n, key_sha1); |
23123aec | 132 | } |
ef8db638 | 133 | /* fall through */ |
23123aec | 134 | default: |
ef8db638 | 135 | return &((*tree)->a[i]); |
fd53c9eb | 136 | } |
ef8db638 | 137 | } |
23123aec | 138 | |
ef8db638 JH |
139 | /* |
140 | * To find a leaf_node: | |
141 | * Search to the tree location appropriate for the given key: | |
142 | * If a note entry with matching key, return the note entry, else return NULL. | |
143 | */ | |
851c2b37 JH |
144 | static struct leaf_node *note_tree_find(struct notes_tree *t, |
145 | struct int_node *tree, unsigned char n, | |
ef8db638 JH |
146 | const unsigned char *key_sha1) |
147 | { | |
851c2b37 | 148 | void **p = note_tree_search(t, &tree, &n, key_sha1); |
ef8db638 JH |
149 | if (GET_PTR_TYPE(*p) == PTR_TYPE_NOTE) { |
150 | struct leaf_node *l = (struct leaf_node *) CLR_PTR_TYPE(*p); | |
e3ff0683 | 151 | if (hasheq(key_sha1, l->key_oid.hash)) |
ef8db638 | 152 | return l; |
23123aec JH |
153 | } |
154 | return NULL; | |
fd53c9eb JS |
155 | } |
156 | ||
1ec666b0 JH |
157 | /* |
158 | * How to consolidate an int_node: | |
159 | * If there are > 1 non-NULL entries, give up and return non-zero. | |
160 | * Otherwise replace the int_node at the given index in the given parent node | |
5a8e7c34 MH |
161 | * with the only NOTE entry (or a NULL entry if no entries) from the given |
162 | * tree, and return 0. | |
1ec666b0 JH |
163 | */ |
164 | static int note_tree_consolidate(struct int_node *tree, | |
165 | struct int_node *parent, unsigned char index) | |
166 | { | |
167 | unsigned int i; | |
168 | void *p = NULL; | |
169 | ||
170 | assert(tree && parent); | |
171 | assert(CLR_PTR_TYPE(parent->a[index]) == tree); | |
172 | ||
173 | for (i = 0; i < 16; i++) { | |
174 | if (GET_PTR_TYPE(tree->a[i]) != PTR_TYPE_NULL) { | |
175 | if (p) /* more than one entry */ | |
176 | return -2; | |
177 | p = tree->a[i]; | |
178 | } | |
179 | } | |
180 | ||
5a8e7c34 MH |
181 | if (p && (GET_PTR_TYPE(p) != PTR_TYPE_NOTE)) |
182 | return -2; | |
1ec666b0 JH |
183 | /* replace tree with p in parent[index] */ |
184 | parent->a[index] = p; | |
185 | free(tree); | |
186 | return 0; | |
187 | } | |
188 | ||
189 | /* | |
190 | * To remove a leaf_node: | |
191 | * Search to the tree location appropriate for the given leaf_node's key: | |
192 | * - If location does not hold a matching entry, abort and do nothing. | |
1ee1e43d | 193 | * - Copy the matching entry's value into the given entry. |
1ec666b0 JH |
194 | * - Replace the matching leaf_node with a NULL entry (and free the leaf_node). |
195 | * - Consolidate int_nodes repeatedly, while walking up the tree towards root. | |
196 | */ | |
1ee1e43d JH |
197 | static void note_tree_remove(struct notes_tree *t, |
198 | struct int_node *tree, unsigned char n, | |
199 | struct leaf_node *entry) | |
1ec666b0 JH |
200 | { |
201 | struct leaf_node *l; | |
dd437451 | 202 | struct int_node *parent_stack[GIT_MAX_RAWSZ]; |
1ec666b0 | 203 | unsigned char i, j; |
5dcc969e | 204 | void **p = note_tree_search(t, &tree, &n, entry->key_oid.hash); |
1ec666b0 JH |
205 | |
206 | assert(GET_PTR_TYPE(entry) == 0); /* no type bits set */ | |
207 | if (GET_PTR_TYPE(*p) != PTR_TYPE_NOTE) | |
208 | return; /* type mismatch, nothing to remove */ | |
209 | l = (struct leaf_node *) CLR_PTR_TYPE(*p); | |
9001dc2a | 210 | if (!oideq(&l->key_oid, &entry->key_oid)) |
1ec666b0 JH |
211 | return; /* key mismatch, nothing to remove */ |
212 | ||
213 | /* we have found a matching entry */ | |
5dcc969e | 214 | oidcpy(&entry->val_oid, &l->val_oid); |
1ec666b0 JH |
215 | free(l); |
216 | *p = SET_PTR_TYPE(NULL, PTR_TYPE_NULL); | |
217 | ||
218 | /* consolidate this tree level, and parent levels, if possible */ | |
219 | if (!n) | |
220 | return; /* cannot consolidate top level */ | |
221 | /* first, build stack of ancestors between root and current node */ | |
cd305392 | 222 | parent_stack[0] = t->root; |
1ec666b0 | 223 | for (i = 0; i < n; i++) { |
5dcc969e | 224 | j = GET_NIBBLE(i, entry->key_oid.hash); |
1ec666b0 JH |
225 | parent_stack[i + 1] = CLR_PTR_TYPE(parent_stack[i]->a[j]); |
226 | } | |
227 | assert(i == n && parent_stack[i] == tree); | |
228 | /* next, unwind stack until note_tree_consolidate() is done */ | |
229 | while (i > 0 && | |
230 | !note_tree_consolidate(parent_stack[i], parent_stack[i - 1], | |
5dcc969e | 231 | GET_NIBBLE(i - 1, entry->key_oid.hash))) |
1ec666b0 JH |
232 | i--; |
233 | } | |
234 | ||
23123aec JH |
235 | /* |
236 | * To insert a leaf_node: | |
ef8db638 JH |
237 | * Search to the tree location appropriate for the given leaf_node's key: |
238 | * - If location is unused (NULL), store the tweaked pointer directly there | |
239 | * - If location holds a note entry that matches the note-to-be-inserted, then | |
73f464b5 | 240 | * combine the two notes (by calling the given combine_notes function). |
ef8db638 JH |
241 | * - If location holds a note entry that matches the subtree-to-be-inserted, |
242 | * then unpack the subtree-to-be-inserted into the location. | |
243 | * - If location holds a matching subtree entry, unpack the subtree at that | |
244 | * location, and restart the insert operation from that level. | |
245 | * - Else, create a new int_node, holding both the node-at-location and the | |
246 | * node-to-be-inserted, and store the new int_node into the location. | |
23123aec | 247 | */ |
180619a5 | 248 | static int note_tree_insert(struct notes_tree *t, struct int_node *tree, |
851c2b37 | 249 | unsigned char n, struct leaf_node *entry, unsigned char type, |
73f464b5 | 250 | combine_notes_fn combine_notes) |
fd53c9eb | 251 | { |
23123aec | 252 | struct int_node *new_node; |
ef8db638 | 253 | struct leaf_node *l; |
5dcc969e | 254 | void **p = note_tree_search(t, &tree, &n, entry->key_oid.hash); |
180619a5 | 255 | int ret = 0; |
ef8db638 JH |
256 | |
257 | assert(GET_PTR_TYPE(entry) == 0); /* no type bits set */ | |
258 | l = (struct leaf_node *) CLR_PTR_TYPE(*p); | |
0ab1faae | 259 | switch (GET_PTR_TYPE(*p)) { |
23123aec | 260 | case PTR_TYPE_NULL: |
ef8db638 | 261 | assert(!*p); |
5dcc969e | 262 | if (is_null_oid(&entry->val_oid)) |
e2656c82 JH |
263 | free(entry); |
264 | else | |
265 | *p = SET_PTR_TYPE(entry, type); | |
180619a5 | 266 | return 0; |
ef8db638 JH |
267 | case PTR_TYPE_NOTE: |
268 | switch (type) { | |
269 | case PTR_TYPE_NOTE: | |
4a7e27e9 | 270 | if (oideq(&l->key_oid, &entry->key_oid)) { |
ef8db638 | 271 | /* skip concatenation if l == entry */ |
779ad664 MH |
272 | if (oideq(&l->val_oid, &entry->val_oid)) { |
273 | free(entry); | |
180619a5 | 274 | return 0; |
779ad664 | 275 | } |
ef8db638 | 276 | |
b7d591d1 PO |
277 | ret = combine_notes(&l->val_oid, |
278 | &entry->val_oid); | |
5dcc969e | 279 | if (!ret && is_null_oid(&l->val_oid)) |
e2656c82 | 280 | note_tree_remove(t, tree, n, entry); |
ef8db638 | 281 | free(entry); |
180619a5 | 282 | return ret; |
ef8db638 JH |
283 | } |
284 | break; | |
285 | case PTR_TYPE_SUBTREE: | |
5dcc969e | 286 | if (!SUBTREE_SHA1_PREFIXCMP(l->key_oid.hash, |
287 | entry->key_oid.hash)) { | |
ef8db638 | 288 | /* unpack 'entry' */ |
851c2b37 | 289 | load_subtree(t, entry, tree, n); |
ef8db638 | 290 | free(entry); |
180619a5 | 291 | return 0; |
ef8db638 JH |
292 | } |
293 | break; | |
294 | } | |
295 | break; | |
296 | case PTR_TYPE_SUBTREE: | |
5dcc969e | 297 | if (!SUBTREE_SHA1_PREFIXCMP(entry->key_oid.hash, l->key_oid.hash)) { |
ef8db638 JH |
298 | /* unpack 'l' and restart insert */ |
299 | *p = NULL; | |
851c2b37 | 300 | load_subtree(t, l, tree, n); |
ef8db638 | 301 | free(l); |
180619a5 JH |
302 | return note_tree_insert(t, tree, n, entry, type, |
303 | combine_notes); | |
23123aec | 304 | } |
ef8db638 | 305 | break; |
fd53c9eb | 306 | } |
ef8db638 JH |
307 | |
308 | /* non-matching leaf_node */ | |
309 | assert(GET_PTR_TYPE(*p) == PTR_TYPE_NOTE || | |
310 | GET_PTR_TYPE(*p) == PTR_TYPE_SUBTREE); | |
5dcc969e | 311 | if (is_null_oid(&entry->val_oid)) { /* skip insertion of empty note */ |
e2656c82 | 312 | free(entry); |
180619a5 | 313 | return 0; |
e2656c82 | 314 | } |
65bbf082 | 315 | new_node = (struct int_node *) xcalloc(1, sizeof(struct int_node)); |
180619a5 JH |
316 | ret = note_tree_insert(t, new_node, n + 1, l, GET_PTR_TYPE(*p), |
317 | combine_notes); | |
318 | if (ret) | |
319 | return ret; | |
ef8db638 | 320 | *p = SET_PTR_TYPE(new_node, PTR_TYPE_INTERNAL); |
180619a5 | 321 | return note_tree_insert(t, new_node, n + 1, entry, type, combine_notes); |
23123aec | 322 | } |
fd53c9eb | 323 | |
23123aec JH |
324 | /* Free the entire notes data contained in the given tree */ |
325 | static void note_tree_free(struct int_node *tree) | |
326 | { | |
327 | unsigned int i; | |
328 | for (i = 0; i < 16; i++) { | |
329 | void *p = tree->a[i]; | |
0ab1faae | 330 | switch (GET_PTR_TYPE(p)) { |
23123aec JH |
331 | case PTR_TYPE_INTERNAL: |
332 | note_tree_free(CLR_PTR_TYPE(p)); | |
333 | /* fall through */ | |
334 | case PTR_TYPE_NOTE: | |
335 | case PTR_TYPE_SUBTREE: | |
336 | free(CLR_PTR_TYPE(p)); | |
337 | } | |
fd53c9eb | 338 | } |
23123aec | 339 | } |
fd53c9eb | 340 | |
851c2b37 JH |
341 | static int non_note_cmp(const struct non_note *a, const struct non_note *b) |
342 | { | |
343 | return strcmp(a->path, b->path); | |
344 | } | |
345 | ||
c29edfef JK |
346 | /* note: takes ownership of path string */ |
347 | static void add_non_note(struct notes_tree *t, char *path, | |
851c2b37 JH |
348 | unsigned int mode, const unsigned char *sha1) |
349 | { | |
350 | struct non_note *p = t->prev_non_note, *n; | |
351 | n = (struct non_note *) xmalloc(sizeof(struct non_note)); | |
352 | n->next = NULL; | |
c29edfef | 353 | n->path = path; |
851c2b37 | 354 | n->mode = mode; |
92e2cab9 | 355 | oidread(&n->oid, sha1); |
851c2b37 JH |
356 | t->prev_non_note = n; |
357 | ||
358 | if (!t->first_non_note) { | |
359 | t->first_non_note = n; | |
360 | return; | |
361 | } | |
362 | ||
363 | if (non_note_cmp(p, n) < 0) | |
364 | ; /* do nothing */ | |
365 | else if (non_note_cmp(t->first_non_note, n) <= 0) | |
366 | p = t->first_non_note; | |
367 | else { | |
368 | /* n sorts before t->first_non_note */ | |
369 | n->next = t->first_non_note; | |
370 | t->first_non_note = n; | |
371 | return; | |
372 | } | |
373 | ||
374 | /* n sorts equal or after p */ | |
375 | while (p->next && non_note_cmp(p->next, n) <= 0) | |
376 | p = p->next; | |
377 | ||
378 | if (non_note_cmp(p, n) == 0) { /* n ~= p; overwrite p with n */ | |
379 | assert(strcmp(p->path, n->path) == 0); | |
380 | p->mode = n->mode; | |
5dcc969e | 381 | oidcpy(&p->oid, &n->oid); |
851c2b37 JH |
382 | free(n); |
383 | t->prev_non_note = p; | |
384 | return; | |
385 | } | |
386 | ||
387 | /* n sorts between p and p->next */ | |
388 | n->next = p->next; | |
389 | p->next = n; | |
390 | } | |
391 | ||
392 | static void load_subtree(struct notes_tree *t, struct leaf_node *subtree, | |
393 | struct int_node *node, unsigned int n) | |
fd53c9eb | 394 | { |
89c149f5 | 395 | struct object_id object_oid; |
06cfa756 | 396 | size_t prefix_len; |
23123aec | 397 | void *buf; |
fd53c9eb JS |
398 | struct tree_desc desc; |
399 | struct name_entry entry; | |
dd437451 | 400 | const unsigned hashsz = the_hash_algo->rawsz; |
23123aec | 401 | |
5e575807 | 402 | buf = fill_tree_descriptor(the_repository, &desc, &subtree->val_oid); |
23123aec JH |
403 | if (!buf) |
404 | die("Could not read %s for notes-index", | |
5dcc969e | 405 | oid_to_hex(&subtree->val_oid)); |
23123aec | 406 | |
89c149f5 | 407 | prefix_len = subtree->key_oid.hash[KEY_INDEX]; |
dd437451 | 408 | if (prefix_len >= hashsz) |
39642815 MH |
409 | BUG("prefix_len (%"PRIuMAX") is out of range", (uintmax_t)prefix_len); |
410 | if (prefix_len * 2 < n) | |
411 | BUG("prefix_len (%"PRIuMAX") is too small", (uintmax_t)prefix_len); | |
89c149f5 | 412 | memcpy(object_oid.hash, subtree->key_oid.hash, prefix_len); |
23123aec | 413 | while (tree_entry(&desc, &entry)) { |
a2816392 MH |
414 | unsigned char type; |
415 | struct leaf_node *l; | |
06cfa756 | 416 | size_t path_len = strlen(entry.path); |
98c9897d | 417 | |
dd437451 | 418 | if (path_len == 2 * (hashsz - prefix_len)) { |
98c9897d | 419 | /* This is potentially the remainder of the SHA-1 */ |
40432187 MH |
420 | |
421 | if (!S_ISREG(entry.mode)) | |
422 | /* notes must be blobs */ | |
423 | goto handle_non_note; | |
424 | ||
cfdc88f1 | 425 | if (hex_to_bytes(object_oid.hash + prefix_len, entry.path, |
dd437451 | 426 | hashsz - prefix_len)) |
98c9897d | 427 | goto handle_non_note; /* entry.path is not a SHA1 */ |
23123aec | 428 | |
851c2b37 | 429 | type = PTR_TYPE_NOTE; |
98c9897d MH |
430 | } else if (path_len == 2) { |
431 | /* This is potentially an internal node */ | |
d49852d6 | 432 | size_t len = prefix_len; |
4d589b87 MH |
433 | |
434 | if (!S_ISDIR(entry.mode)) | |
435 | /* internal nodes must be trees */ | |
436 | goto handle_non_note; | |
437 | ||
cfdc88f1 | 438 | if (hex_to_bytes(object_oid.hash + len++, entry.path, 1)) |
98c9897d | 439 | goto handle_non_note; /* entry.path is not a SHA1 */ |
a2816392 | 440 | |
d49852d6 MH |
441 | /* |
442 | * Pad the rest of the SHA-1 with zeros, | |
443 | * except for the last byte, where we write | |
444 | * the length: | |
445 | */ | |
dd437451 | 446 | memset(object_oid.hash + len, 0, hashsz - len - 1); |
d49852d6 | 447 | object_oid.hash[KEY_INDEX] = (unsigned char)len; |
4ebef533 | 448 | |
d3b0c6be | 449 | type = PTR_TYPE_SUBTREE; |
98c9897d MH |
450 | } else { |
451 | /* This can't be part of a note */ | |
452 | goto handle_non_note; | |
23123aec | 453 | } |
98c9897d | 454 | |
ca56dadb | 455 | CALLOC_ARRAY(l, 1); |
4ebef533 | 456 | oidcpy(&l->key_oid, &object_oid); |
ea82b2a0 | 457 | oidcpy(&l->val_oid, &entry.oid); |
5a6dce70 | 458 | oid_set_algo(&l->key_oid, the_hash_algo); |
459 | oid_set_algo(&l->val_oid, the_hash_algo); | |
d3b0c6be MH |
460 | if (note_tree_insert(t, node, n, l, type, |
461 | combine_notes_concatenate)) | |
462 | die("Failed to load %s %s into notes tree " | |
463 | "from %s", | |
464 | type == PTR_TYPE_NOTE ? "note" : "subtree", | |
60fe477a | 465 | oid_to_hex(&object_oid), t->ref); |
d3b0c6be | 466 | |
851c2b37 JH |
467 | continue; |
468 | ||
469 | handle_non_note: | |
470 | /* | |
cbeed9aa MH |
471 | * Determine full path for this non-note entry. The |
472 | * filename is already found in entry.path, but the | |
473 | * directory part of the path must be deduced from the | |
474 | * subtree containing this entry based on our | |
475 | * knowledge that the overall notes tree follows a | |
476 | * strict byte-based progressive fanout structure | |
477 | * (i.e. using 2/38, 2/2/36, etc. fanouts). | |
851c2b37 JH |
478 | */ |
479 | { | |
c29edfef | 480 | struct strbuf non_note_path = STRBUF_INIT; |
5dcc969e | 481 | const char *q = oid_to_hex(&subtree->key_oid); |
06cfa756 | 482 | size_t i; |
851c2b37 | 483 | for (i = 0; i < prefix_len; i++) { |
c29edfef JK |
484 | strbuf_addch(&non_note_path, *q++); |
485 | strbuf_addch(&non_note_path, *q++); | |
486 | strbuf_addch(&non_note_path, '/'); | |
851c2b37 | 487 | } |
c29edfef | 488 | strbuf_addstr(&non_note_path, entry.path); |
5a6dce70 | 489 | oid_set_algo(&entry.oid, the_hash_algo); |
c29edfef | 490 | add_non_note(t, strbuf_detach(&non_note_path, NULL), |
ea82b2a0 | 491 | entry.mode, entry.oid.hash); |
851c2b37 | 492 | } |
23123aec JH |
493 | } |
494 | free(buf); | |
495 | } | |
496 | ||
73f77b90 JH |
497 | /* |
498 | * Determine optimal on-disk fanout for this part of the notes tree | |
499 | * | |
500 | * Given a (sub)tree and the level in the internal tree structure, determine | |
501 | * whether or not the given existing fanout should be expanded for this | |
502 | * (sub)tree. | |
503 | * | |
504 | * Values of the 'fanout' variable: | |
505 | * - 0: No fanout (all notes are stored directly in the root notes tree) | |
506 | * - 1: 2/38 fanout | |
507 | * - 2: 2/2/36 fanout | |
508 | * - 3: 2/2/2/34 fanout | |
509 | * etc. | |
510 | */ | |
511 | static unsigned char determine_fanout(struct int_node *tree, unsigned char n, | |
512 | unsigned char fanout) | |
513 | { | |
514 | /* | |
515 | * The following is a simple heuristic that works well in practice: | |
516 | * For each even-numbered 16-tree level (remember that each on-disk | |
517 | * fanout level corresponds to _two_ 16-tree levels), peek at all 16 | |
518 | * entries at that tree level. If all of them are either int_nodes or | |
519 | * subtree entries, then there are likely plenty of notes below this | |
520 | * level, so we return an incremented fanout. | |
521 | */ | |
522 | unsigned int i; | |
523 | if ((n % 2) || (n > 2 * fanout)) | |
524 | return fanout; | |
525 | for (i = 0; i < 16; i++) { | |
526 | switch (GET_PTR_TYPE(tree->a[i])) { | |
527 | case PTR_TYPE_SUBTREE: | |
528 | case PTR_TYPE_INTERNAL: | |
529 | continue; | |
530 | default: | |
531 | return fanout; | |
532 | } | |
533 | } | |
534 | return fanout + 1; | |
535 | } | |
536 | ||
dd437451 | 537 | /* hex oid + '/' between each pair of hex digits + NUL */ |
538 | #define FANOUT_PATH_MAX GIT_MAX_HEXSZ + FANOUT_PATH_SEPARATORS_MAX + 1 | |
02e32b7d | 539 | |
0dbc6462 | 540 | static void construct_path_with_fanout(const unsigned char *hash, |
73f77b90 JH |
541 | unsigned char fanout, char *path) |
542 | { | |
543 | unsigned int i = 0, j = 0; | |
0dbc6462 | 544 | const char *hex_hash = hash_to_hex(hash); |
dd437451 | 545 | assert(fanout < the_hash_algo->rawsz); |
73f77b90 | 546 | while (fanout) { |
0dbc6462 | 547 | path[i++] = hex_hash[j++]; |
548 | path[i++] = hex_hash[j++]; | |
73f77b90 JH |
549 | path[i++] = '/'; |
550 | fanout--; | |
551 | } | |
0dbc6462 | 552 | xsnprintf(path + i, FANOUT_PATH_MAX - i, "%s", hex_hash + j); |
73f77b90 JH |
553 | } |
554 | ||
851c2b37 JH |
555 | static int for_each_note_helper(struct notes_tree *t, struct int_node *tree, |
556 | unsigned char n, unsigned char fanout, int flags, | |
557 | each_note_fn fn, void *cb_data) | |
73f77b90 JH |
558 | { |
559 | unsigned int i; | |
560 | void *p; | |
561 | int ret = 0; | |
562 | struct leaf_node *l; | |
02e32b7d | 563 | static char path[FANOUT_PATH_MAX]; |
73f77b90 JH |
564 | |
565 | fanout = determine_fanout(tree, n, fanout); | |
566 | for (i = 0; i < 16; i++) { | |
567 | redo: | |
568 | p = tree->a[i]; | |
569 | switch (GET_PTR_TYPE(p)) { | |
570 | case PTR_TYPE_INTERNAL: | |
571 | /* recurse into int_node */ | |
851c2b37 | 572 | ret = for_each_note_helper(t, CLR_PTR_TYPE(p), n + 1, |
73f77b90 JH |
573 | fanout, flags, fn, cb_data); |
574 | break; | |
575 | case PTR_TYPE_SUBTREE: | |
576 | l = (struct leaf_node *) CLR_PTR_TYPE(p); | |
577 | /* | |
578 | * Subtree entries in the note tree represent parts of | |
579 | * the note tree that have not yet been explored. There | |
580 | * is a direct relationship between subtree entries at | |
581 | * level 'n' in the tree, and the 'fanout' variable: | |
dbc27477 | 582 | * Subtree entries at level 'n < 2 * fanout' should be |
73f77b90 JH |
583 | * preserved, since they correspond exactly to a fanout |
584 | * directory in the on-disk structure. However, subtree | |
dbc27477 | 585 | * entries at level 'n >= 2 * fanout' should NOT be |
73f77b90 JH |
586 | * preserved, but rather consolidated into the above |
587 | * notes tree level. We achieve this by unconditionally | |
588 | * unpacking subtree entries that exist below the | |
589 | * threshold level at 'n = 2 * fanout'. | |
590 | */ | |
dbc27477 | 591 | if (n < 2 * fanout && |
73f77b90 JH |
592 | flags & FOR_EACH_NOTE_YIELD_SUBTREES) { |
593 | /* invoke callback with subtree */ | |
594 | unsigned int path_len = | |
89c149f5 | 595 | l->key_oid.hash[KEY_INDEX] * 2 + fanout; |
02e32b7d | 596 | assert(path_len < FANOUT_PATH_MAX - 1); |
5dcc969e | 597 | construct_path_with_fanout(l->key_oid.hash, |
598 | fanout, | |
73f77b90 JH |
599 | path); |
600 | /* Create trailing slash, if needed */ | |
601 | if (path[path_len - 1] != '/') | |
602 | path[path_len++] = '/'; | |
603 | path[path_len] = '\0'; | |
490bc83a | 604 | ret = fn(&l->key_oid, &l->val_oid, |
5dcc969e | 605 | path, |
73f77b90 JH |
606 | cb_data); |
607 | } | |
dbc27477 | 608 | if (n >= 2 * fanout || |
73f77b90 JH |
609 | !(flags & FOR_EACH_NOTE_DONT_UNPACK_SUBTREES)) { |
610 | /* unpack subtree and resume traversal */ | |
611 | tree->a[i] = NULL; | |
851c2b37 | 612 | load_subtree(t, l, tree, n); |
73f77b90 JH |
613 | free(l); |
614 | goto redo; | |
615 | } | |
616 | break; | |
617 | case PTR_TYPE_NOTE: | |
618 | l = (struct leaf_node *) CLR_PTR_TYPE(p); | |
5dcc969e | 619 | construct_path_with_fanout(l->key_oid.hash, fanout, |
620 | path); | |
490bc83a | 621 | ret = fn(&l->key_oid, &l->val_oid, path, |
5dcc969e | 622 | cb_data); |
73f77b90 JH |
623 | break; |
624 | } | |
625 | if (ret) | |
626 | return ret; | |
627 | } | |
628 | return 0; | |
629 | } | |
630 | ||
61a7cca0 JH |
631 | struct tree_write_stack { |
632 | struct tree_write_stack *next; | |
633 | struct strbuf buf; | |
634 | char path[2]; /* path to subtree in next, if any */ | |
635 | }; | |
636 | ||
637 | static inline int matches_tree_write_stack(struct tree_write_stack *tws, | |
638 | const char *full_path) | |
639 | { | |
640 | return full_path[0] == tws->path[0] && | |
641 | full_path[1] == tws->path[1] && | |
642 | full_path[2] == '/'; | |
643 | } | |
644 | ||
645 | static void write_tree_entry(struct strbuf *buf, unsigned int mode, | |
646 | const char *path, unsigned int path_len, const | |
dd437451 | 647 | unsigned char *hash) |
61a7cca0 | 648 | { |
c88f0cc7 | 649 | strbuf_addf(buf, "%o %.*s%c", mode, path_len, path, '\0'); |
dd437451 | 650 | strbuf_add(buf, hash, the_hash_algo->rawsz); |
61a7cca0 JH |
651 | } |
652 | ||
653 | static void tree_write_stack_init_subtree(struct tree_write_stack *tws, | |
654 | const char *path) | |
655 | { | |
656 | struct tree_write_stack *n; | |
657 | assert(!tws->next); | |
658 | assert(tws->path[0] == '\0' && tws->path[1] == '\0'); | |
659 | n = (struct tree_write_stack *) | |
660 | xmalloc(sizeof(struct tree_write_stack)); | |
661 | n->next = NULL; | |
dd437451 | 662 | strbuf_init(&n->buf, 256 * (32 + the_hash_algo->hexsz)); /* assume 256 entries per tree */ |
61a7cca0 JH |
663 | n->path[0] = n->path[1] = '\0'; |
664 | tws->next = n; | |
665 | tws->path[0] = path[0]; | |
666 | tws->path[1] = path[1]; | |
667 | } | |
668 | ||
669 | static int tree_write_stack_finish_subtree(struct tree_write_stack *tws) | |
670 | { | |
671 | int ret; | |
672 | struct tree_write_stack *n = tws->next; | |
89c149f5 | 673 | struct object_id s; |
61a7cca0 JH |
674 | if (n) { |
675 | ret = tree_write_stack_finish_subtree(n); | |
676 | if (ret) | |
677 | return ret; | |
c80d226a | 678 | ret = write_object_file(n->buf.buf, n->buf.len, OBJ_TREE, &s); |
61a7cca0 JH |
679 | if (ret) |
680 | return ret; | |
681 | strbuf_release(&n->buf); | |
682 | free(n); | |
683 | tws->next = NULL; | |
89c149f5 | 684 | write_tree_entry(&tws->buf, 040000, tws->path, 2, s.hash); |
61a7cca0 JH |
685 | tws->path[0] = tws->path[1] = '\0'; |
686 | } | |
687 | return 0; | |
688 | } | |
689 | ||
690 | static int write_each_note_helper(struct tree_write_stack *tws, | |
691 | const char *path, unsigned int mode, | |
490bc83a | 692 | const struct object_id *oid) |
61a7cca0 JH |
693 | { |
694 | size_t path_len = strlen(path); | |
695 | unsigned int n = 0; | |
696 | int ret; | |
697 | ||
698 | /* Determine common part of tree write stack */ | |
699 | while (tws && 3 * n < path_len && | |
700 | matches_tree_write_stack(tws, path + 3 * n)) { | |
701 | n++; | |
702 | tws = tws->next; | |
703 | } | |
704 | ||
705 | /* tws point to last matching tree_write_stack entry */ | |
706 | ret = tree_write_stack_finish_subtree(tws); | |
707 | if (ret) | |
708 | return ret; | |
709 | ||
710 | /* Start subtrees needed to satisfy path */ | |
711 | while (3 * n + 2 < path_len && path[3 * n + 2] == '/') { | |
712 | tree_write_stack_init_subtree(tws, path + 3 * n); | |
713 | n++; | |
714 | tws = tws->next; | |
715 | } | |
716 | ||
717 | /* There should be no more directory components in the given path */ | |
718 | assert(memchr(path + 3 * n, '/', path_len - (3 * n)) == NULL); | |
719 | ||
720 | /* Finally add given entry to the current tree object */ | |
721 | write_tree_entry(&tws->buf, mode, path + 3 * n, path_len - (3 * n), | |
490bc83a | 722 | oid->hash); |
61a7cca0 JH |
723 | |
724 | return 0; | |
725 | } | |
726 | ||
727 | struct write_each_note_data { | |
728 | struct tree_write_stack *root; | |
dbc27477 JH |
729 | struct non_note **nn_list; |
730 | struct non_note *nn_prev; | |
61a7cca0 JH |
731 | }; |
732 | ||
851c2b37 JH |
733 | static int write_each_non_note_until(const char *note_path, |
734 | struct write_each_note_data *d) | |
735 | { | |
dbc27477 JH |
736 | struct non_note *p = d->nn_prev; |
737 | struct non_note *n = p ? p->next : *d->nn_list; | |
89fe121d | 738 | int cmp = 0, ret; |
851c2b37 JH |
739 | while (n && (!note_path || (cmp = strcmp(n->path, note_path)) <= 0)) { |
740 | if (note_path && cmp == 0) | |
741 | ; /* do nothing, prefer note to non-note */ | |
742 | else { | |
743 | ret = write_each_note_helper(d->root, n->path, n->mode, | |
490bc83a | 744 | &n->oid); |
851c2b37 JH |
745 | if (ret) |
746 | return ret; | |
747 | } | |
dbc27477 | 748 | p = n; |
851c2b37 JH |
749 | n = n->next; |
750 | } | |
dbc27477 | 751 | d->nn_prev = p; |
851c2b37 JH |
752 | return 0; |
753 | } | |
754 | ||
490bc83a | 755 | static int write_each_note(const struct object_id *object_oid, |
756 | const struct object_id *note_oid, char *note_path, | |
61a7cca0 JH |
757 | void *cb_data) |
758 | { | |
759 | struct write_each_note_data *d = | |
760 | (struct write_each_note_data *) cb_data; | |
761 | size_t note_path_len = strlen(note_path); | |
762 | unsigned int mode = 0100644; | |
763 | ||
764 | if (note_path[note_path_len - 1] == '/') { | |
765 | /* subtree entry */ | |
766 | note_path_len--; | |
767 | note_path[note_path_len] = '\0'; | |
768 | mode = 040000; | |
769 | } | |
dd437451 | 770 | assert(note_path_len <= GIT_MAX_HEXSZ + FANOUT_PATH_SEPARATORS); |
61a7cca0 | 771 | |
851c2b37 JH |
772 | /* Weave non-note entries into note entries */ |
773 | return write_each_non_note_until(note_path, d) || | |
490bc83a | 774 | write_each_note_helper(d->root, note_path, mode, note_oid); |
61a7cca0 JH |
775 | } |
776 | ||
00fbe636 JH |
777 | struct note_delete_list { |
778 | struct note_delete_list *next; | |
779 | const unsigned char *sha1; | |
780 | }; | |
781 | ||
490bc83a | 782 | static int prune_notes_helper(const struct object_id *object_oid, |
783 | const struct object_id *note_oid, char *note_path, | |
00fbe636 JH |
784 | void *cb_data) |
785 | { | |
786 | struct note_delete_list **l = (struct note_delete_list **) cb_data; | |
787 | struct note_delete_list *n; | |
788 | ||
490bc83a | 789 | if (has_object_file(object_oid)) |
00fbe636 JH |
790 | return 0; /* nothing to do for this note */ |
791 | ||
792 | /* failed to find object => prune this note */ | |
793 | n = (struct note_delete_list *) xmalloc(sizeof(*n)); | |
794 | n->next = *l; | |
490bc83a | 795 | n->sha1 = object_oid->hash; |
00fbe636 JH |
796 | *l = n; |
797 | return 0; | |
798 | } | |
799 | ||
b7d591d1 PO |
800 | int combine_notes_concatenate(struct object_id *cur_oid, |
801 | const struct object_id *new_oid) | |
73f464b5 JH |
802 | { |
803 | char *cur_msg = NULL, *new_msg = NULL, *buf; | |
804 | unsigned long cur_len, new_len, buf_len; | |
805 | enum object_type cur_type, new_type; | |
806 | int ret; | |
807 | ||
808 | /* read in both note blob objects */ | |
b7d591d1 | 809 | if (!is_null_oid(new_oid)) |
b4f5aca4 | 810 | new_msg = read_object_file(new_oid, &new_type, &new_len); |
73f464b5 JH |
811 | if (!new_msg || !new_len || new_type != OBJ_BLOB) { |
812 | free(new_msg); | |
813 | return 0; | |
814 | } | |
b7d591d1 | 815 | if (!is_null_oid(cur_oid)) |
b4f5aca4 | 816 | cur_msg = read_object_file(cur_oid, &cur_type, &cur_len); |
73f464b5 JH |
817 | if (!cur_msg || !cur_len || cur_type != OBJ_BLOB) { |
818 | free(cur_msg); | |
819 | free(new_msg); | |
b7d591d1 | 820 | oidcpy(cur_oid, new_oid); |
73f464b5 JH |
821 | return 0; |
822 | } | |
823 | ||
d4990c4b | 824 | /* we will separate the notes by two newlines anyway */ |
73f464b5 JH |
825 | if (cur_msg[cur_len - 1] == '\n') |
826 | cur_len--; | |
827 | ||
828 | /* concatenate cur_msg and new_msg into buf */ | |
d4990c4b | 829 | buf_len = cur_len + 2 + new_len; |
73f464b5 JH |
830 | buf = (char *) xmalloc(buf_len); |
831 | memcpy(buf, cur_msg, cur_len); | |
832 | buf[cur_len] = '\n'; | |
d4990c4b JH |
833 | buf[cur_len + 1] = '\n'; |
834 | memcpy(buf + cur_len + 2, new_msg, new_len); | |
73f464b5 JH |
835 | free(cur_msg); |
836 | free(new_msg); | |
837 | ||
838 | /* create a new blob object from buf */ | |
c80d226a | 839 | ret = write_object_file(buf, buf_len, OBJ_BLOB, cur_oid); |
73f464b5 JH |
840 | free(buf); |
841 | return ret; | |
842 | } | |
843 | ||
b7d591d1 PO |
844 | int combine_notes_overwrite(struct object_id *cur_oid, |
845 | const struct object_id *new_oid) | |
73f464b5 | 846 | { |
b7d591d1 | 847 | oidcpy(cur_oid, new_oid); |
73f464b5 JH |
848 | return 0; |
849 | } | |
850 | ||
b7d591d1 PO |
851 | int combine_notes_ignore(struct object_id *cur_oid, |
852 | const struct object_id *new_oid) | |
73f464b5 JH |
853 | { |
854 | return 0; | |
855 | } | |
856 | ||
13135243 MH |
857 | /* |
858 | * Add the lines from the named object to list, with trailing | |
859 | * newlines removed. | |
860 | */ | |
861 | static int string_list_add_note_lines(struct string_list *list, | |
b7d591d1 | 862 | const struct object_id *oid) |
a6a09095 JH |
863 | { |
864 | char *data; | |
865 | unsigned long len; | |
866 | enum object_type t; | |
a6a09095 | 867 | |
b7d591d1 | 868 | if (is_null_oid(oid)) |
a6a09095 JH |
869 | return 0; |
870 | ||
871 | /* read_sha1_file NUL-terminates */ | |
b4f5aca4 | 872 | data = read_object_file(oid, &t, &len); |
a6a09095 JH |
873 | if (t != OBJ_BLOB || !data || !len) { |
874 | free(data); | |
875 | return t != OBJ_BLOB || !data; | |
876 | } | |
877 | ||
13135243 MH |
878 | /* |
879 | * If the last line of the file is EOL-terminated, this will | |
880 | * add an empty string to the list. But it will be removed | |
881 | * later, along with any empty strings that came from empty | |
882 | * lines within the file. | |
883 | */ | |
884 | string_list_split(list, data, '\n', -1); | |
885 | free(data); | |
a6a09095 JH |
886 | return 0; |
887 | } | |
888 | ||
889 | static int string_list_join_lines_helper(struct string_list_item *item, | |
890 | void *cb_data) | |
891 | { | |
892 | struct strbuf *buf = cb_data; | |
893 | strbuf_addstr(buf, item->string); | |
894 | strbuf_addch(buf, '\n'); | |
895 | return 0; | |
896 | } | |
897 | ||
b7d591d1 PO |
898 | int combine_notes_cat_sort_uniq(struct object_id *cur_oid, |
899 | const struct object_id *new_oid) | |
a6a09095 | 900 | { |
f992f0c8 | 901 | struct string_list sort_uniq_list = STRING_LIST_INIT_DUP; |
a6a09095 JH |
902 | struct strbuf buf = STRBUF_INIT; |
903 | int ret = 1; | |
904 | ||
905 | /* read both note blob objects into unique_lines */ | |
b7d591d1 | 906 | if (string_list_add_note_lines(&sort_uniq_list, cur_oid)) |
a6a09095 | 907 | goto out; |
b7d591d1 | 908 | if (string_list_add_note_lines(&sort_uniq_list, new_oid)) |
a6a09095 | 909 | goto out; |
13135243 | 910 | string_list_remove_empty_items(&sort_uniq_list, 0); |
3383e199 | 911 | string_list_sort(&sort_uniq_list); |
13135243 | 912 | string_list_remove_duplicates(&sort_uniq_list, 0); |
a6a09095 JH |
913 | |
914 | /* create a new blob object from sort_uniq_list */ | |
915 | if (for_each_string_list(&sort_uniq_list, | |
916 | string_list_join_lines_helper, &buf)) | |
917 | goto out; | |
918 | ||
c80d226a | 919 | ret = write_object_file(buf.buf, buf.len, OBJ_BLOB, cur_oid); |
a6a09095 JH |
920 | |
921 | out: | |
922 | strbuf_release(&buf); | |
923 | string_list_clear(&sort_uniq_list, 0); | |
924 | return ret; | |
925 | } | |
926 | ||
fd95035f | 927 | static int string_list_add_one_ref(const char *refname, const struct object_id *oid, |
894a9d33 TR |
928 | int flag, void *cb) |
929 | { | |
930 | struct string_list *refs = cb; | |
d235e994 MH |
931 | if (!unsorted_string_list_has_string(refs, refname)) |
932 | string_list_append(refs, refname); | |
894a9d33 TR |
933 | return 0; |
934 | } | |
935 | ||
8c46bf90 MH |
936 | /* |
937 | * The list argument must have strdup_strings set on it. | |
938 | */ | |
894a9d33 TR |
939 | void string_list_add_refs_by_glob(struct string_list *list, const char *glob) |
940 | { | |
8c46bf90 | 941 | assert(list->strdup_strings); |
894a9d33 | 942 | if (has_glob_specials(glob)) { |
fd95035f | 943 | for_each_glob_ref(string_list_add_one_ref, glob, list); |
894a9d33 | 944 | } else { |
89c149f5 | 945 | struct object_id oid; |
946 | if (get_oid(glob, &oid)) | |
894a9d33 TR |
947 | warning("notes ref %s is invalid", glob); |
948 | if (!unsorted_string_list_has_string(list, glob)) | |
1d2f80fa | 949 | string_list_append(list, glob); |
894a9d33 TR |
950 | } |
951 | } | |
952 | ||
953 | void string_list_add_refs_from_colon_sep(struct string_list *list, | |
954 | const char *globs) | |
955 | { | |
6fa23773 MH |
956 | struct string_list split = STRING_LIST_INIT_NODUP; |
957 | char *globs_copy = xstrdup(globs); | |
894a9d33 TR |
958 | int i; |
959 | ||
6fa23773 MH |
960 | string_list_split_in_place(&split, globs_copy, ':', -1); |
961 | string_list_remove_empty_items(&split, 0); | |
894a9d33 | 962 | |
6fa23773 MH |
963 | for (i = 0; i < split.nr; i++) |
964 | string_list_add_refs_by_glob(list, split.items[i].string); | |
894a9d33 | 965 | |
6fa23773 MH |
966 | string_list_clear(&split, 0); |
967 | free(globs_copy); | |
894a9d33 TR |
968 | } |
969 | ||
894a9d33 TR |
970 | static int notes_display_config(const char *k, const char *v, void *cb) |
971 | { | |
972 | int *load_refs = cb; | |
973 | ||
974 | if (*load_refs && !strcmp(k, "notes.displayref")) { | |
975 | if (!v) | |
c3eb95a0 | 976 | return config_error_nonbool(k); |
894a9d33 TR |
977 | string_list_add_refs_by_glob(&display_notes_refs, v); |
978 | } | |
979 | ||
980 | return 0; | |
981 | } | |
982 | ||
4a9cf1ce | 983 | const char *default_notes_ref(void) |
894a9d33 TR |
984 | { |
985 | const char *notes_ref = NULL; | |
986 | if (!notes_ref) | |
987 | notes_ref = getenv(GIT_NOTES_REF_ENVIRONMENT); | |
988 | if (!notes_ref) | |
989 | notes_ref = notes_ref_name; /* value of core.notesRef config */ | |
990 | if (!notes_ref) | |
991 | notes_ref = GIT_NOTES_DEFAULT_REF; | |
992 | return notes_ref; | |
993 | } | |
994 | ||
73f464b5 JH |
995 | void init_notes(struct notes_tree *t, const char *notes_ref, |
996 | combine_notes_fn combine_notes, int flags) | |
23123aec | 997 | { |
13ac1410 | 998 | struct object_id oid, object_oid; |
5ec1e728 | 999 | unsigned short mode; |
23123aec | 1000 | struct leaf_node root_tree; |
fd53c9eb | 1001 | |
cd305392 JH |
1002 | if (!t) |
1003 | t = &default_notes_tree; | |
1004 | assert(!t->initialized); | |
709f79b0 JH |
1005 | |
1006 | if (!notes_ref) | |
894a9d33 | 1007 | notes_ref = default_notes_ref(); |
709f79b0 | 1008 | |
73f464b5 JH |
1009 | if (!combine_notes) |
1010 | combine_notes = combine_notes_concatenate; | |
1011 | ||
65bbf082 | 1012 | t->root = (struct int_node *) xcalloc(1, sizeof(struct int_node)); |
851c2b37 JH |
1013 | t->first_non_note = NULL; |
1014 | t->prev_non_note = NULL; | |
8c53f071 | 1015 | t->ref = xstrdup_or_null(notes_ref); |
ee76f92f | 1016 | t->update_ref = (flags & NOTES_INIT_WRITABLE) ? t->ref : NULL; |
73f464b5 | 1017 | t->combine_notes = combine_notes; |
cd305392 | 1018 | t->initialized = 1; |
7f710ea9 | 1019 | t->dirty = 0; |
cd305392 | 1020 | |
709f79b0 | 1021 | if (flags & NOTES_INIT_EMPTY || !notes_ref || |
e82caf38 | 1022 | get_oid_treeish(notes_ref, &object_oid)) |
fd53c9eb | 1023 | return; |
34c290a6 | 1024 | if (flags & NOTES_INIT_WRITABLE && read_ref(notes_ref, &object_oid)) |
ee76f92f | 1025 | die("Cannot use notes ref %s", notes_ref); |
50ddb089 | 1026 | if (get_tree_entry(the_repository, &object_oid, "", &oid, &mode)) |
709f79b0 | 1027 | die("Failed to read notes tree referenced by %s (%s)", |
13ac1410 | 1028 | notes_ref, oid_to_hex(&object_oid)); |
fd53c9eb | 1029 | |
5dcc969e | 1030 | oidclr(&root_tree.key_oid); |
1031 | oidcpy(&root_tree.val_oid, &oid); | |
851c2b37 | 1032 | load_subtree(t, &root_tree, t->root, 0); |
fd53c9eb JS |
1033 | } |
1034 | ||
ee76f92f | 1035 | struct notes_tree **load_notes_trees(struct string_list *refs, int flags) |
894a9d33 | 1036 | { |
8a57c6e9 AR |
1037 | struct string_list_item *item; |
1038 | int counter = 0; | |
894a9d33 | 1039 | struct notes_tree **trees; |
b32fa95f | 1040 | ALLOC_ARRAY(trees, refs->nr + 1); |
8a57c6e9 AR |
1041 | for_each_string_list_item(item, refs) { |
1042 | struct notes_tree *t = xcalloc(1, sizeof(struct notes_tree)); | |
ee76f92f | 1043 | init_notes(t, item->string, combine_notes_ignore, flags); |
8a57c6e9 AR |
1044 | trees[counter++] = t; |
1045 | } | |
1046 | trees[counter] = NULL; | |
894a9d33 TR |
1047 | return trees; |
1048 | } | |
1049 | ||
1050 | void init_display_notes(struct display_notes_opt *opt) | |
e6e230ee DL |
1051 | { |
1052 | memset(opt, 0, sizeof(*opt)); | |
1053 | opt->use_default_notes = -1; | |
1054 | } | |
1055 | ||
1d729751 | 1056 | void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes) |
452538c3 | 1057 | { |
1d729751 DL |
1058 | opt->use_default_notes = 1; |
1059 | *show_notes = 1; | |
1060 | } | |
452538c3 | 1061 | |
1d729751 DL |
1062 | void enable_ref_display_notes(struct display_notes_opt *opt, int *show_notes, |
1063 | const char *ref) { | |
1064 | struct strbuf buf = STRBUF_INIT; | |
1065 | strbuf_addstr(&buf, ref); | |
1066 | expand_notes_ref(&buf); | |
1067 | string_list_append(&opt->extra_notes_refs, | |
1068 | strbuf_detach(&buf, NULL)); | |
1069 | *show_notes = 1; | |
1070 | } | |
1071 | ||
1072 | void disable_display_notes(struct display_notes_opt *opt, int *show_notes) | |
1073 | { | |
1074 | opt->use_default_notes = -1; | |
1075 | /* we have been strdup'ing ourselves, so trick | |
1076 | * string_list into free()ing strings */ | |
1077 | opt->extra_notes_refs.strdup_strings = 1; | |
1078 | string_list_clear(&opt->extra_notes_refs, 0); | |
1079 | opt->extra_notes_refs.strdup_strings = 0; | |
1080 | *show_notes = 0; | |
452538c3 DL |
1081 | } |
1082 | ||
1e6ed544 | 1083 | void load_display_notes(struct display_notes_opt *opt) |
894a9d33 TR |
1084 | { |
1085 | char *display_ref_env; | |
1086 | int load_config_refs = 0; | |
1087 | display_notes_refs.strdup_strings = 1; | |
1088 | ||
1089 | assert(!display_notes_trees); | |
1090 | ||
3a03cf6b JK |
1091 | if (!opt || opt->use_default_notes > 0 || |
1092 | (opt->use_default_notes == -1 && !opt->extra_notes_refs.nr)) { | |
1d2f80fa | 1093 | string_list_append(&display_notes_refs, default_notes_ref()); |
894a9d33 TR |
1094 | display_ref_env = getenv(GIT_NOTES_DISPLAY_REF_ENVIRONMENT); |
1095 | if (display_ref_env) { | |
1096 | string_list_add_refs_from_colon_sep(&display_notes_refs, | |
1097 | display_ref_env); | |
1098 | load_config_refs = 0; | |
1099 | } else | |
1100 | load_config_refs = 1; | |
1101 | } | |
1102 | ||
1103 | git_config(notes_display_config, &load_config_refs); | |
1104 | ||
304cc11c | 1105 | if (opt) { |
8a57c6e9 | 1106 | struct string_list_item *item; |
304cc11c | 1107 | for_each_string_list_item(item, &opt->extra_notes_refs) |
8a57c6e9 AR |
1108 | string_list_add_refs_by_glob(&display_notes_refs, |
1109 | item->string); | |
1110 | } | |
894a9d33 | 1111 | |
ee76f92f | 1112 | display_notes_trees = load_notes_trees(&display_notes_refs, 0); |
894a9d33 TR |
1113 | string_list_clear(&display_notes_refs, 0); |
1114 | } | |
1115 | ||
5ee8a954 | 1116 | int add_note(struct notes_tree *t, const struct object_id *object_oid, |
1117 | const struct object_id *note_oid, combine_notes_fn combine_notes) | |
2626b536 JH |
1118 | { |
1119 | struct leaf_node *l; | |
1120 | ||
cd305392 JH |
1121 | if (!t) |
1122 | t = &default_notes_tree; | |
1123 | assert(t->initialized); | |
7f710ea9 | 1124 | t->dirty = 1; |
73f464b5 JH |
1125 | if (!combine_notes) |
1126 | combine_notes = t->combine_notes; | |
2626b536 | 1127 | l = (struct leaf_node *) xmalloc(sizeof(struct leaf_node)); |
5ee8a954 | 1128 | oidcpy(&l->key_oid, object_oid); |
1129 | oidcpy(&l->val_oid, note_oid); | |
180619a5 | 1130 | return note_tree_insert(t, t->root, 0, l, PTR_TYPE_NOTE, combine_notes); |
2626b536 JH |
1131 | } |
1132 | ||
1ee1e43d | 1133 | int remove_note(struct notes_tree *t, const unsigned char *object_sha1) |
1ec666b0 JH |
1134 | { |
1135 | struct leaf_node l; | |
1136 | ||
cd305392 JH |
1137 | if (!t) |
1138 | t = &default_notes_tree; | |
1139 | assert(t->initialized); | |
92e2cab9 | 1140 | oidread(&l.key_oid, object_sha1); |
5dcc969e | 1141 | oidclr(&l.val_oid); |
a502ab93 | 1142 | note_tree_remove(t, t->root, 0, &l); |
5dcc969e | 1143 | if (is_null_oid(&l.val_oid)) /* no note was removed */ |
1ee1e43d JH |
1144 | return 1; |
1145 | t->dirty = 1; | |
1146 | return 0; | |
1ec666b0 JH |
1147 | } |
1148 | ||
9ef72230 | 1149 | const struct object_id *get_note(struct notes_tree *t, |
5ee8a954 | 1150 | const struct object_id *oid) |
fd53c9eb | 1151 | { |
9b391f21 JH |
1152 | struct leaf_node *found; |
1153 | ||
cd305392 JH |
1154 | if (!t) |
1155 | t = &default_notes_tree; | |
1156 | assert(t->initialized); | |
5ee8a954 | 1157 | found = note_tree_find(t, t->root, 0, oid->hash); |
9ef72230 | 1158 | return found ? &found->val_oid : NULL; |
fd53c9eb | 1159 | } |
a97a7468 | 1160 | |
cd305392 JH |
1161 | int for_each_note(struct notes_tree *t, int flags, each_note_fn fn, |
1162 | void *cb_data) | |
73f77b90 | 1163 | { |
cd305392 JH |
1164 | if (!t) |
1165 | t = &default_notes_tree; | |
1166 | assert(t->initialized); | |
851c2b37 | 1167 | return for_each_note_helper(t, t->root, 0, 0, flags, fn, cb_data); |
73f77b90 JH |
1168 | } |
1169 | ||
bbca96d5 | 1170 | int write_notes_tree(struct notes_tree *t, struct object_id *result) |
61a7cca0 JH |
1171 | { |
1172 | struct tree_write_stack root; | |
1173 | struct write_each_note_data cb_data; | |
1174 | int ret; | |
bbca96d5 | 1175 | int flags; |
61a7cca0 | 1176 | |
cd305392 JH |
1177 | if (!t) |
1178 | t = &default_notes_tree; | |
1179 | assert(t->initialized); | |
61a7cca0 JH |
1180 | |
1181 | /* Prepare for traversal of current notes tree */ | |
1182 | root.next = NULL; /* last forward entry in list is grounded */ | |
dd437451 | 1183 | strbuf_init(&root.buf, 256 * (32 + the_hash_algo->hexsz)); /* assume 256 entries */ |
61a7cca0 JH |
1184 | root.path[0] = root.path[1] = '\0'; |
1185 | cb_data.root = &root; | |
dbc27477 JH |
1186 | cb_data.nn_list = &(t->first_non_note); |
1187 | cb_data.nn_prev = NULL; | |
61a7cca0 JH |
1188 | |
1189 | /* Write tree objects representing current notes tree */ | |
bbca96d5 PO |
1190 | flags = FOR_EACH_NOTE_DONT_UNPACK_SUBTREES | |
1191 | FOR_EACH_NOTE_YIELD_SUBTREES; | |
1192 | ret = for_each_note(t, flags, write_each_note, &cb_data) || | |
1193 | write_each_non_note_until(NULL, &cb_data) || | |
1194 | tree_write_stack_finish_subtree(&root) || | |
c80d226a | 1195 | write_object_file(root.buf.buf, root.buf.len, OBJ_TREE, result); |
61a7cca0 JH |
1196 | strbuf_release(&root.buf); |
1197 | return ret; | |
1198 | } | |
1199 | ||
a9f2adff | 1200 | void prune_notes(struct notes_tree *t, int flags) |
00fbe636 JH |
1201 | { |
1202 | struct note_delete_list *l = NULL; | |
1203 | ||
1204 | if (!t) | |
1205 | t = &default_notes_tree; | |
1206 | assert(t->initialized); | |
1207 | ||
1208 | for_each_note(t, 0, prune_notes_helper, &l); | |
1209 | ||
1210 | while (l) { | |
a9f2adff | 1211 | if (flags & NOTES_PRUNE_VERBOSE) |
0dbc6462 | 1212 | printf("%s\n", hash_to_hex(l->sha1)); |
a9f2adff MG |
1213 | if (!(flags & NOTES_PRUNE_DRYRUN)) |
1214 | remove_note(t, l->sha1); | |
00fbe636 JH |
1215 | l = l->next; |
1216 | } | |
1217 | } | |
1218 | ||
cd305392 | 1219 | void free_notes(struct notes_tree *t) |
27d57564 | 1220 | { |
cd305392 JH |
1221 | if (!t) |
1222 | t = &default_notes_tree; | |
1223 | if (t->root) | |
1224 | note_tree_free(t->root); | |
1225 | free(t->root); | |
851c2b37 JH |
1226 | while (t->first_non_note) { |
1227 | t->prev_non_note = t->first_non_note->next; | |
1228 | free(t->first_non_note->path); | |
1229 | free(t->first_non_note); | |
1230 | t->first_non_note = t->prev_non_note; | |
1231 | } | |
cd305392 JH |
1232 | free(t->ref); |
1233 | memset(t, 0, sizeof(struct notes_tree)); | |
27d57564 JH |
1234 | } |
1235 | ||
96531a5e JH |
1236 | /* |
1237 | * Fill the given strbuf with the notes associated with the given object. | |
1238 | * | |
1239 | * If the given notes_tree structure is not initialized, it will be auto- | |
1240 | * initialized to the default value (see documentation for init_notes() above). | |
1241 | * If the given notes_tree is NULL, the internal/default notes_tree will be | |
1242 | * used instead. | |
1243 | * | |
76141e2e JH |
1244 | * (raw != 0) gives the %N userformat; otherwise, the note message is given |
1245 | * for human consumption. | |
96531a5e | 1246 | */ |
fb61e4d3 | 1247 | static void format_note(struct notes_tree *t, const struct object_id *object_oid, |
76141e2e | 1248 | struct strbuf *sb, const char *output_encoding, int raw) |
a97a7468 JS |
1249 | { |
1250 | static const char utf8[] = "utf-8"; | |
9ef72230 | 1251 | const struct object_id *oid; |
a97a7468 JS |
1252 | char *msg, *msg_p; |
1253 | unsigned long linelen, msglen; | |
1254 | enum object_type type; | |
1255 | ||
cd305392 JH |
1256 | if (!t) |
1257 | t = &default_notes_tree; | |
1258 | if (!t->initialized) | |
73f464b5 | 1259 | init_notes(t, NULL, NULL, 0); |
a97a7468 | 1260 | |
5ee8a954 | 1261 | oid = get_note(t, object_oid); |
9ef72230 | 1262 | if (!oid) |
a97a7468 JS |
1263 | return; |
1264 | ||
b4f5aca4 | 1265 | if (!(msg = read_object_file(oid, &type, &msglen)) || type != OBJ_BLOB) { |
a97a7468 JS |
1266 | free(msg); |
1267 | return; | |
1268 | } | |
1269 | ||
1270 | if (output_encoding && *output_encoding && | |
0e18bcd5 | 1271 | !is_encoding_utf8(output_encoding)) { |
a97a7468 JS |
1272 | char *reencoded = reencode_string(msg, output_encoding, utf8); |
1273 | if (reencoded) { | |
1274 | free(msg); | |
1275 | msg = reencoded; | |
1276 | msglen = strlen(msg); | |
1277 | } | |
1278 | } | |
1279 | ||
1280 | /* we will end the annotation by a newline anyway */ | |
1281 | if (msglen && msg[msglen - 1] == '\n') | |
1282 | msglen--; | |
1283 | ||
76141e2e | 1284 | if (!raw) { |
894a9d33 TR |
1285 | const char *ref = t->ref; |
1286 | if (!ref || !strcmp(ref, GIT_NOTES_DEFAULT_REF)) { | |
1287 | strbuf_addstr(sb, "\nNotes:\n"); | |
1288 | } else { | |
145136a9 JH |
1289 | skip_prefix(ref, "refs/", &ref); |
1290 | skip_prefix(ref, "notes/", &ref); | |
894a9d33 TR |
1291 | strbuf_addf(sb, "\nNotes (%s):\n", ref); |
1292 | } | |
1293 | } | |
a97a7468 JS |
1294 | |
1295 | for (msg_p = msg; msg_p < msg + msglen; msg_p += linelen + 1) { | |
1296 | linelen = strchrnul(msg_p, '\n') - msg_p; | |
1297 | ||
76141e2e | 1298 | if (!raw) |
c56fcc89 | 1299 | strbuf_addstr(sb, " "); |
a97a7468 JS |
1300 | strbuf_add(sb, msg_p, linelen); |
1301 | strbuf_addch(sb, '\n'); | |
1302 | } | |
1303 | ||
1304 | free(msg); | |
1305 | } | |
894a9d33 | 1306 | |
fb61e4d3 | 1307 | void format_display_notes(const struct object_id *object_oid, |
76141e2e | 1308 | struct strbuf *sb, const char *output_encoding, int raw) |
894a9d33 TR |
1309 | { |
1310 | int i; | |
1311 | assert(display_notes_trees); | |
1312 | for (i = 0; display_notes_trees[i]; i++) | |
fb61e4d3 | 1313 | format_note(display_notes_trees[i], object_oid, sb, |
76141e2e | 1314 | output_encoding, raw); |
894a9d33 | 1315 | } |
160baa0d TR |
1316 | |
1317 | int copy_note(struct notes_tree *t, | |
5ee8a954 | 1318 | const struct object_id *from_obj, const struct object_id *to_obj, |
180619a5 | 1319 | int force, combine_notes_fn combine_notes) |
160baa0d | 1320 | { |
9ef72230 | 1321 | const struct object_id *note = get_note(t, from_obj); |
1322 | const struct object_id *existing_note = get_note(t, to_obj); | |
160baa0d TR |
1323 | |
1324 | if (!force && existing_note) | |
1325 | return 1; | |
1326 | ||
1327 | if (note) | |
5ee8a954 | 1328 | return add_note(t, to_obj, note, combine_notes); |
160baa0d | 1329 | else if (existing_note) |
14228447 | 1330 | return add_note(t, to_obj, null_oid(), combine_notes); |
160baa0d TR |
1331 | |
1332 | return 0; | |
1333 | } | |
03bb5789 JK |
1334 | |
1335 | void expand_notes_ref(struct strbuf *sb) | |
1336 | { | |
59556548 | 1337 | if (starts_with(sb->buf, "refs/notes/")) |
03bb5789 | 1338 | return; /* we're happy */ |
59556548 | 1339 | else if (starts_with(sb->buf, "notes/")) |
a91cc7fa | 1340 | strbuf_insertstr(sb, 0, "refs/"); |
03bb5789 | 1341 | else |
a91cc7fa | 1342 | strbuf_insertstr(sb, 0, "refs/notes/"); |
03bb5789 | 1343 | } |
b3715b75 JK |
1344 | |
1345 | void expand_loose_notes_ref(struct strbuf *sb) | |
1346 | { | |
89c149f5 | 1347 | struct object_id object; |
b3715b75 | 1348 | |
89c149f5 | 1349 | if (get_oid(sb->buf, &object)) { |
b3715b75 JK |
1350 | /* fallback to expand_notes_ref */ |
1351 | expand_notes_ref(sb); | |
1352 | } | |
1353 | } |