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