load_subtree(): combine some common code
[git/git.git] / notes.c
CommitLineData
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 */
24struct 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 */
38struct 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 */
51struct 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 74struct notes_tree default_notes_tree;
23123aec 75
2721ce21 76static struct string_list display_notes_refs = STRING_LIST_INIT_NODUP;
894a9d33
TR
77static struct notes_tree **display_notes_trees;
78
851c2b37
JH
79static 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 97static 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
142static 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 */
162static 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
195static 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 246static 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
5dcc969e 273 ret = combine_notes(l->val_oid.hash,
274 entry->val_oid.hash);
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 */
321static 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
23123aec
JH
337/*
338 * Convert a partial SHA1 hex string to the corresponding partial SHA1 value.
339 * - hex - Partial SHA1 segment in ASCII hex format
340 * - hex_len - Length of above segment. Must be multiple of 2 between 0 and 40
67c9b422
MH
341 * - oid - Partial SHA1 value is written here
342 * - oid_len - Max #bytes to store in sha1, Must be >= hex_len / 2, and < 20
343 * Return 0 on success or -1 on error (invalid arguments or input not
344 * in hex format). Pad oid with NULs up to oid_len.
23123aec 345 */
89c149f5 346static int get_oid_hex_segment(const char *hex, unsigned int hex_len,
347 unsigned char *oid, unsigned int oid_len)
23123aec
JH
348{
349 unsigned int i, len = hex_len >> 1;
89c149f5 350 if (hex_len % 2 != 0 || len > oid_len)
23123aec
JH
351 return -1;
352 for (i = 0; i < len; i++) {
353 unsigned int val = (hexval(hex[0]) << 4) | hexval(hex[1]);
354 if (val & ~0xff)
355 return -1;
89c149f5 356 *oid++ = val;
23123aec
JH
357 hex += 2;
358 }
89c149f5 359 for (; i < oid_len; i++)
360 *oid++ = 0;
67c9b422 361 return 0;
fd53c9eb
JS
362}
363
851c2b37
JH
364static int non_note_cmp(const struct non_note *a, const struct non_note *b)
365{
366 return strcmp(a->path, b->path);
367}
368
c29edfef
JK
369/* note: takes ownership of path string */
370static void add_non_note(struct notes_tree *t, char *path,
851c2b37
JH
371 unsigned int mode, const unsigned char *sha1)
372{
373 struct non_note *p = t->prev_non_note, *n;
374 n = (struct non_note *) xmalloc(sizeof(struct non_note));
375 n->next = NULL;
c29edfef 376 n->path = path;
851c2b37 377 n->mode = mode;
5dcc969e 378 hashcpy(n->oid.hash, sha1);
851c2b37
JH
379 t->prev_non_note = n;
380
381 if (!t->first_non_note) {
382 t->first_non_note = n;
383 return;
384 }
385
386 if (non_note_cmp(p, n) < 0)
387 ; /* do nothing */
388 else if (non_note_cmp(t->first_non_note, n) <= 0)
389 p = t->first_non_note;
390 else {
391 /* n sorts before t->first_non_note */
392 n->next = t->first_non_note;
393 t->first_non_note = n;
394 return;
395 }
396
397 /* n sorts equal or after p */
398 while (p->next && non_note_cmp(p->next, n) <= 0)
399 p = p->next;
400
401 if (non_note_cmp(p, n) == 0) { /* n ~= p; overwrite p with n */
402 assert(strcmp(p->path, n->path) == 0);
403 p->mode = n->mode;
5dcc969e 404 oidcpy(&p->oid, &n->oid);
851c2b37
JH
405 free(n);
406 t->prev_non_note = p;
407 return;
408 }
409
410 /* n sorts between p and p->next */
411 n->next = p->next;
412 p->next = n;
413}
414
415static void load_subtree(struct notes_tree *t, struct leaf_node *subtree,
416 struct int_node *node, unsigned int n)
fd53c9eb 417{
89c149f5 418 struct object_id object_oid;
23123aec 419 unsigned int prefix_len;
23123aec 420 void *buf;
fd53c9eb
JS
421 struct tree_desc desc;
422 struct name_entry entry;
23123aec 423
5dcc969e 424 buf = fill_tree_descriptor(&desc, subtree->val_oid.hash);
23123aec
JH
425 if (!buf)
426 die("Could not read %s for notes-index",
5dcc969e 427 oid_to_hex(&subtree->val_oid));
23123aec 428
89c149f5 429 prefix_len = subtree->key_oid.hash[KEY_INDEX];
23123aec 430 assert(prefix_len * 2 >= n);
89c149f5 431 memcpy(object_oid.hash, subtree->key_oid.hash, prefix_len);
23123aec 432 while (tree_entry(&desc, &entry)) {
a2816392
MH
433 unsigned char type;
434 struct leaf_node *l;
98c9897d
MH
435 int path_len = strlen(entry.path);
436
437 if (path_len == 2 * (GIT_SHA1_RAWSZ - prefix_len)) {
438 /* This is potentially the remainder of the SHA-1 */
40432187
MH
439
440 if (!S_ISREG(entry.mode))
441 /* notes must be blobs */
442 goto handle_non_note;
443
98c9897d
MH
444 if (get_oid_hex_segment(entry.path, path_len,
445 object_oid.hash + prefix_len,
67c9b422 446 GIT_SHA1_RAWSZ - prefix_len))
98c9897d
MH
447 goto handle_non_note; /* entry.path is not a SHA1 */
448
449 type = PTR_TYPE_NOTE;
98c9897d
MH
450 } else if (path_len == 2) {
451 /* This is potentially an internal node */
4d589b87
MH
452
453 if (!S_ISDIR(entry.mode))
454 /* internal nodes must be trees */
455 goto handle_non_note;
456
98c9897d
MH
457 if (get_oid_hex_segment(entry.path, 2,
458 object_oid.hash + prefix_len,
67c9b422 459 GIT_SHA1_RAWSZ - prefix_len))
98c9897d 460 goto handle_non_note; /* entry.path is not a SHA1 */
a2816392 461
4ebef533
MH
462 object_oid.hash[KEY_INDEX] = (unsigned char) (prefix_len + 1);
463
d3b0c6be 464 type = PTR_TYPE_SUBTREE;
98c9897d
MH
465 } else {
466 /* This can't be part of a note */
467 goto handle_non_note;
23123aec 468 }
98c9897d 469
4ebef533
MH
470 l = xcalloc(1, sizeof(*l));
471 oidcpy(&l->key_oid, &object_oid);
472 oidcpy(&l->val_oid, entry.oid);
d3b0c6be
MH
473 if (note_tree_insert(t, node, n, l, type,
474 combine_notes_concatenate))
475 die("Failed to load %s %s into notes tree "
476 "from %s",
477 type == PTR_TYPE_NOTE ? "note" : "subtree",
478 oid_to_hex(&l->key_oid), t->ref);
479
851c2b37
JH
480 continue;
481
482handle_non_note:
483 /*
cbeed9aa
MH
484 * Determine full path for this non-note entry. The
485 * filename is already found in entry.path, but the
486 * directory part of the path must be deduced from the
487 * subtree containing this entry based on our
488 * knowledge that the overall notes tree follows a
489 * strict byte-based progressive fanout structure
490 * (i.e. using 2/38, 2/2/36, etc. fanouts).
851c2b37
JH
491 */
492 {
c29edfef 493 struct strbuf non_note_path = STRBUF_INIT;
5dcc969e 494 const char *q = oid_to_hex(&subtree->key_oid);
851c2b37
JH
495 int i;
496 for (i = 0; i < prefix_len; i++) {
c29edfef
JK
497 strbuf_addch(&non_note_path, *q++);
498 strbuf_addch(&non_note_path, *q++);
499 strbuf_addch(&non_note_path, '/');
851c2b37 500 }
c29edfef
JK
501 strbuf_addstr(&non_note_path, entry.path);
502 add_non_note(t, strbuf_detach(&non_note_path, NULL),
7d924c91 503 entry.mode, entry.oid->hash);
851c2b37 504 }
23123aec
JH
505 }
506 free(buf);
507}
508
73f77b90
JH
509/*
510 * Determine optimal on-disk fanout for this part of the notes tree
511 *
512 * Given a (sub)tree and the level in the internal tree structure, determine
513 * whether or not the given existing fanout should be expanded for this
514 * (sub)tree.
515 *
516 * Values of the 'fanout' variable:
517 * - 0: No fanout (all notes are stored directly in the root notes tree)
518 * - 1: 2/38 fanout
519 * - 2: 2/2/36 fanout
520 * - 3: 2/2/2/34 fanout
521 * etc.
522 */
523static unsigned char determine_fanout(struct int_node *tree, unsigned char n,
524 unsigned char fanout)
525{
526 /*
527 * The following is a simple heuristic that works well in practice:
528 * For each even-numbered 16-tree level (remember that each on-disk
529 * fanout level corresponds to _two_ 16-tree levels), peek at all 16
530 * entries at that tree level. If all of them are either int_nodes or
531 * subtree entries, then there are likely plenty of notes below this
532 * level, so we return an incremented fanout.
533 */
534 unsigned int i;
535 if ((n % 2) || (n > 2 * fanout))
536 return fanout;
537 for (i = 0; i < 16; i++) {
538 switch (GET_PTR_TYPE(tree->a[i])) {
539 case PTR_TYPE_SUBTREE:
540 case PTR_TYPE_INTERNAL:
541 continue;
542 default:
543 return fanout;
544 }
545 }
546 return fanout + 1;
547}
548
02e32b7d 549/* hex SHA1 + 19 * '/' + NUL */
89c149f5 550#define FANOUT_PATH_MAX GIT_SHA1_HEXSZ + FANOUT_PATH_SEPARATORS + 1
02e32b7d 551
73f77b90
JH
552static void construct_path_with_fanout(const unsigned char *sha1,
553 unsigned char fanout, char *path)
554{
555 unsigned int i = 0, j = 0;
556 const char *hex_sha1 = sha1_to_hex(sha1);
89c149f5 557 assert(fanout < GIT_SHA1_RAWSZ);
73f77b90
JH
558 while (fanout) {
559 path[i++] = hex_sha1[j++];
560 path[i++] = hex_sha1[j++];
561 path[i++] = '/';
562 fanout--;
563 }
02e32b7d 564 xsnprintf(path + i, FANOUT_PATH_MAX - i, "%s", hex_sha1 + j);
73f77b90
JH
565}
566
851c2b37
JH
567static int for_each_note_helper(struct notes_tree *t, struct int_node *tree,
568 unsigned char n, unsigned char fanout, int flags,
569 each_note_fn fn, void *cb_data)
73f77b90
JH
570{
571 unsigned int i;
572 void *p;
573 int ret = 0;
574 struct leaf_node *l;
02e32b7d 575 static char path[FANOUT_PATH_MAX];
73f77b90
JH
576
577 fanout = determine_fanout(tree, n, fanout);
578 for (i = 0; i < 16; i++) {
579redo:
580 p = tree->a[i];
581 switch (GET_PTR_TYPE(p)) {
582 case PTR_TYPE_INTERNAL:
583 /* recurse into int_node */
851c2b37 584 ret = for_each_note_helper(t, CLR_PTR_TYPE(p), n + 1,
73f77b90
JH
585 fanout, flags, fn, cb_data);
586 break;
587 case PTR_TYPE_SUBTREE:
588 l = (struct leaf_node *) CLR_PTR_TYPE(p);
589 /*
590 * Subtree entries in the note tree represent parts of
591 * the note tree that have not yet been explored. There
592 * is a direct relationship between subtree entries at
593 * level 'n' in the tree, and the 'fanout' variable:
594 * Subtree entries at level 'n <= 2 * fanout' should be
595 * preserved, since they correspond exactly to a fanout
596 * directory in the on-disk structure. However, subtree
597 * entries at level 'n > 2 * fanout' should NOT be
598 * preserved, but rather consolidated into the above
599 * notes tree level. We achieve this by unconditionally
600 * unpacking subtree entries that exist below the
601 * threshold level at 'n = 2 * fanout'.
602 */
603 if (n <= 2 * fanout &&
604 flags & FOR_EACH_NOTE_YIELD_SUBTREES) {
605 /* invoke callback with subtree */
606 unsigned int path_len =
89c149f5 607 l->key_oid.hash[KEY_INDEX] * 2 + fanout;
02e32b7d 608 assert(path_len < FANOUT_PATH_MAX - 1);
5dcc969e 609 construct_path_with_fanout(l->key_oid.hash,
610 fanout,
73f77b90
JH
611 path);
612 /* Create trailing slash, if needed */
613 if (path[path_len - 1] != '/')
614 path[path_len++] = '/';
615 path[path_len] = '\0';
490bc83a 616 ret = fn(&l->key_oid, &l->val_oid,
5dcc969e 617 path,
73f77b90
JH
618 cb_data);
619 }
620 if (n > fanout * 2 ||
621 !(flags & FOR_EACH_NOTE_DONT_UNPACK_SUBTREES)) {
622 /* unpack subtree and resume traversal */
623 tree->a[i] = NULL;
851c2b37 624 load_subtree(t, l, tree, n);
73f77b90
JH
625 free(l);
626 goto redo;
627 }
628 break;
629 case PTR_TYPE_NOTE:
630 l = (struct leaf_node *) CLR_PTR_TYPE(p);
5dcc969e 631 construct_path_with_fanout(l->key_oid.hash, fanout,
632 path);
490bc83a 633 ret = fn(&l->key_oid, &l->val_oid, path,
5dcc969e 634 cb_data);
73f77b90
JH
635 break;
636 }
637 if (ret)
638 return ret;
639 }
640 return 0;
641}
642
61a7cca0
JH
643struct tree_write_stack {
644 struct tree_write_stack *next;
645 struct strbuf buf;
646 char path[2]; /* path to subtree in next, if any */
647};
648
649static inline int matches_tree_write_stack(struct tree_write_stack *tws,
650 const char *full_path)
651{
652 return full_path[0] == tws->path[0] &&
653 full_path[1] == tws->path[1] &&
654 full_path[2] == '/';
655}
656
657static void write_tree_entry(struct strbuf *buf, unsigned int mode,
658 const char *path, unsigned int path_len, const
659 unsigned char *sha1)
660{
c88f0cc7 661 strbuf_addf(buf, "%o %.*s%c", mode, path_len, path, '\0');
89c149f5 662 strbuf_add(buf, sha1, GIT_SHA1_RAWSZ);
61a7cca0
JH
663}
664
665static void tree_write_stack_init_subtree(struct tree_write_stack *tws,
666 const char *path)
667{
668 struct tree_write_stack *n;
669 assert(!tws->next);
670 assert(tws->path[0] == '\0' && tws->path[1] == '\0');
671 n = (struct tree_write_stack *)
672 xmalloc(sizeof(struct tree_write_stack));
673 n->next = NULL;
89c149f5 674 strbuf_init(&n->buf, 256 * (32 + GIT_SHA1_HEXSZ)); /* assume 256 entries per tree */
61a7cca0
JH
675 n->path[0] = n->path[1] = '\0';
676 tws->next = n;
677 tws->path[0] = path[0];
678 tws->path[1] = path[1];
679}
680
681static int tree_write_stack_finish_subtree(struct tree_write_stack *tws)
682{
683 int ret;
684 struct tree_write_stack *n = tws->next;
89c149f5 685 struct object_id s;
61a7cca0
JH
686 if (n) {
687 ret = tree_write_stack_finish_subtree(n);
688 if (ret)
689 return ret;
89c149f5 690 ret = write_sha1_file(n->buf.buf, n->buf.len, tree_type, s.hash);
61a7cca0
JH
691 if (ret)
692 return ret;
693 strbuf_release(&n->buf);
694 free(n);
695 tws->next = NULL;
89c149f5 696 write_tree_entry(&tws->buf, 040000, tws->path, 2, s.hash);
61a7cca0
JH
697 tws->path[0] = tws->path[1] = '\0';
698 }
699 return 0;
700}
701
702static int write_each_note_helper(struct tree_write_stack *tws,
703 const char *path, unsigned int mode,
490bc83a 704 const struct object_id *oid)
61a7cca0
JH
705{
706 size_t path_len = strlen(path);
707 unsigned int n = 0;
708 int ret;
709
710 /* Determine common part of tree write stack */
711 while (tws && 3 * n < path_len &&
712 matches_tree_write_stack(tws, path + 3 * n)) {
713 n++;
714 tws = tws->next;
715 }
716
717 /* tws point to last matching tree_write_stack entry */
718 ret = tree_write_stack_finish_subtree(tws);
719 if (ret)
720 return ret;
721
722 /* Start subtrees needed to satisfy path */
723 while (3 * n + 2 < path_len && path[3 * n + 2] == '/') {
724 tree_write_stack_init_subtree(tws, path + 3 * n);
725 n++;
726 tws = tws->next;
727 }
728
729 /* There should be no more directory components in the given path */
730 assert(memchr(path + 3 * n, '/', path_len - (3 * n)) == NULL);
731
732 /* Finally add given entry to the current tree object */
733 write_tree_entry(&tws->buf, mode, path + 3 * n, path_len - (3 * n),
490bc83a 734 oid->hash);
61a7cca0
JH
735
736 return 0;
737}
738
739struct write_each_note_data {
740 struct tree_write_stack *root;
851c2b37 741 struct non_note *next_non_note;
61a7cca0
JH
742};
743
851c2b37
JH
744static int write_each_non_note_until(const char *note_path,
745 struct write_each_note_data *d)
746{
747 struct non_note *n = d->next_non_note;
89fe121d 748 int cmp = 0, ret;
851c2b37
JH
749 while (n && (!note_path || (cmp = strcmp(n->path, note_path)) <= 0)) {
750 if (note_path && cmp == 0)
751 ; /* do nothing, prefer note to non-note */
752 else {
753 ret = write_each_note_helper(d->root, n->path, n->mode,
490bc83a 754 &n->oid);
851c2b37
JH
755 if (ret)
756 return ret;
757 }
758 n = n->next;
759 }
760 d->next_non_note = n;
761 return 0;
762}
763
490bc83a 764static int write_each_note(const struct object_id *object_oid,
765 const struct object_id *note_oid, char *note_path,
61a7cca0
JH
766 void *cb_data)
767{
768 struct write_each_note_data *d =
769 (struct write_each_note_data *) cb_data;
770 size_t note_path_len = strlen(note_path);
771 unsigned int mode = 0100644;
772
773 if (note_path[note_path_len - 1] == '/') {
774 /* subtree entry */
775 note_path_len--;
776 note_path[note_path_len] = '\0';
777 mode = 040000;
778 }
89c149f5 779 assert(note_path_len <= GIT_SHA1_HEXSZ + FANOUT_PATH_SEPARATORS);
61a7cca0 780
851c2b37
JH
781 /* Weave non-note entries into note entries */
782 return write_each_non_note_until(note_path, d) ||
490bc83a 783 write_each_note_helper(d->root, note_path, mode, note_oid);
61a7cca0
JH
784}
785
00fbe636
JH
786struct note_delete_list {
787 struct note_delete_list *next;
788 const unsigned char *sha1;
789};
790
490bc83a 791static int prune_notes_helper(const struct object_id *object_oid,
792 const struct object_id *note_oid, char *note_path,
00fbe636
JH
793 void *cb_data)
794{
795 struct note_delete_list **l = (struct note_delete_list **) cb_data;
796 struct note_delete_list *n;
797
490bc83a 798 if (has_object_file(object_oid))
00fbe636
JH
799 return 0; /* nothing to do for this note */
800
801 /* failed to find object => prune this note */
802 n = (struct note_delete_list *) xmalloc(sizeof(*n));
803 n->next = *l;
490bc83a 804 n->sha1 = object_oid->hash;
00fbe636
JH
805 *l = n;
806 return 0;
807}
808
73f464b5
JH
809int combine_notes_concatenate(unsigned char *cur_sha1,
810 const unsigned char *new_sha1)
811{
812 char *cur_msg = NULL, *new_msg = NULL, *buf;
813 unsigned long cur_len, new_len, buf_len;
814 enum object_type cur_type, new_type;
815 int ret;
816
817 /* read in both note blob objects */
818 if (!is_null_sha1(new_sha1))
819 new_msg = read_sha1_file(new_sha1, &new_type, &new_len);
820 if (!new_msg || !new_len || new_type != OBJ_BLOB) {
821 free(new_msg);
822 return 0;
823 }
824 if (!is_null_sha1(cur_sha1))
825 cur_msg = read_sha1_file(cur_sha1, &cur_type, &cur_len);
826 if (!cur_msg || !cur_len || cur_type != OBJ_BLOB) {
827 free(cur_msg);
828 free(new_msg);
829 hashcpy(cur_sha1, new_sha1);
830 return 0;
831 }
832
d4990c4b 833 /* we will separate the notes by two newlines anyway */
73f464b5
JH
834 if (cur_msg[cur_len - 1] == '\n')
835 cur_len--;
836
837 /* concatenate cur_msg and new_msg into buf */
d4990c4b 838 buf_len = cur_len + 2 + new_len;
73f464b5
JH
839 buf = (char *) xmalloc(buf_len);
840 memcpy(buf, cur_msg, cur_len);
841 buf[cur_len] = '\n';
d4990c4b
JH
842 buf[cur_len + 1] = '\n';
843 memcpy(buf + cur_len + 2, new_msg, new_len);
73f464b5
JH
844 free(cur_msg);
845 free(new_msg);
846
847 /* create a new blob object from buf */
848 ret = write_sha1_file(buf, buf_len, blob_type, cur_sha1);
849 free(buf);
850 return ret;
851}
852
853int combine_notes_overwrite(unsigned char *cur_sha1,
854 const unsigned char *new_sha1)
855{
856 hashcpy(cur_sha1, new_sha1);
857 return 0;
858}
859
860int combine_notes_ignore(unsigned char *cur_sha1,
861 const unsigned char *new_sha1)
862{
863 return 0;
864}
865
13135243
MH
866/*
867 * Add the lines from the named object to list, with trailing
868 * newlines removed.
869 */
870static int string_list_add_note_lines(struct string_list *list,
a6a09095
JH
871 const unsigned char *sha1)
872{
873 char *data;
874 unsigned long len;
875 enum object_type t;
a6a09095
JH
876
877 if (is_null_sha1(sha1))
878 return 0;
879
880 /* read_sha1_file NUL-terminates */
881 data = read_sha1_file(sha1, &t, &len);
882 if (t != OBJ_BLOB || !data || !len) {
883 free(data);
884 return t != OBJ_BLOB || !data;
885 }
886
13135243
MH
887 /*
888 * If the last line of the file is EOL-terminated, this will
889 * add an empty string to the list. But it will be removed
890 * later, along with any empty strings that came from empty
891 * lines within the file.
892 */
893 string_list_split(list, data, '\n', -1);
894 free(data);
a6a09095
JH
895 return 0;
896}
897
898static int string_list_join_lines_helper(struct string_list_item *item,
899 void *cb_data)
900{
901 struct strbuf *buf = cb_data;
902 strbuf_addstr(buf, item->string);
903 strbuf_addch(buf, '\n');
904 return 0;
905}
906
907int combine_notes_cat_sort_uniq(unsigned char *cur_sha1,
908 const unsigned char *new_sha1)
909{
f992f0c8 910 struct string_list sort_uniq_list = STRING_LIST_INIT_DUP;
a6a09095
JH
911 struct strbuf buf = STRBUF_INIT;
912 int ret = 1;
913
914 /* read both note blob objects into unique_lines */
915 if (string_list_add_note_lines(&sort_uniq_list, cur_sha1))
916 goto out;
917 if (string_list_add_note_lines(&sort_uniq_list, new_sha1))
918 goto out;
13135243 919 string_list_remove_empty_items(&sort_uniq_list, 0);
3383e199 920 string_list_sort(&sort_uniq_list);
13135243 921 string_list_remove_duplicates(&sort_uniq_list, 0);
a6a09095
JH
922
923 /* create a new blob object from sort_uniq_list */
924 if (for_each_string_list(&sort_uniq_list,
925 string_list_join_lines_helper, &buf))
926 goto out;
927
928 ret = write_sha1_file(buf.buf, buf.len, blob_type, cur_sha1);
929
930out:
931 strbuf_release(&buf);
932 string_list_clear(&sort_uniq_list, 0);
933 return ret;
934}
935
fd95035f 936static int string_list_add_one_ref(const char *refname, const struct object_id *oid,
894a9d33
TR
937 int flag, void *cb)
938{
939 struct string_list *refs = cb;
d235e994
MH
940 if (!unsorted_string_list_has_string(refs, refname))
941 string_list_append(refs, refname);
894a9d33
TR
942 return 0;
943}
944
8c46bf90
MH
945/*
946 * The list argument must have strdup_strings set on it.
947 */
894a9d33
TR
948void string_list_add_refs_by_glob(struct string_list *list, const char *glob)
949{
8c46bf90 950 assert(list->strdup_strings);
894a9d33 951 if (has_glob_specials(glob)) {
fd95035f 952 for_each_glob_ref(string_list_add_one_ref, glob, list);
894a9d33 953 } else {
89c149f5 954 struct object_id oid;
955 if (get_oid(glob, &oid))
894a9d33
TR
956 warning("notes ref %s is invalid", glob);
957 if (!unsorted_string_list_has_string(list, glob))
1d2f80fa 958 string_list_append(list, glob);
894a9d33
TR
959 }
960}
961
962void string_list_add_refs_from_colon_sep(struct string_list *list,
963 const char *globs)
964{
6fa23773
MH
965 struct string_list split = STRING_LIST_INIT_NODUP;
966 char *globs_copy = xstrdup(globs);
894a9d33
TR
967 int i;
968
6fa23773
MH
969 string_list_split_in_place(&split, globs_copy, ':', -1);
970 string_list_remove_empty_items(&split, 0);
894a9d33 971
6fa23773
MH
972 for (i = 0; i < split.nr; i++)
973 string_list_add_refs_by_glob(list, split.items[i].string);
894a9d33 974
6fa23773
MH
975 string_list_clear(&split, 0);
976 free(globs_copy);
894a9d33
TR
977}
978
894a9d33
TR
979static int notes_display_config(const char *k, const char *v, void *cb)
980{
981 int *load_refs = cb;
982
983 if (*load_refs && !strcmp(k, "notes.displayref")) {
984 if (!v)
985 config_error_nonbool(k);
986 string_list_add_refs_by_glob(&display_notes_refs, v);
987 }
988
989 return 0;
990}
991
4a9cf1ce 992const char *default_notes_ref(void)
894a9d33
TR
993{
994 const char *notes_ref = NULL;
995 if (!notes_ref)
996 notes_ref = getenv(GIT_NOTES_REF_ENVIRONMENT);
997 if (!notes_ref)
998 notes_ref = notes_ref_name; /* value of core.notesRef config */
999 if (!notes_ref)
1000 notes_ref = GIT_NOTES_DEFAULT_REF;
1001 return notes_ref;
1002}
1003
73f464b5
JH
1004void init_notes(struct notes_tree *t, const char *notes_ref,
1005 combine_notes_fn combine_notes, int flags)
23123aec 1006{
13ac1410 1007 struct object_id oid, object_oid;
23123aec
JH
1008 unsigned mode;
1009 struct leaf_node root_tree;
fd53c9eb 1010
cd305392
JH
1011 if (!t)
1012 t = &default_notes_tree;
1013 assert(!t->initialized);
709f79b0
JH
1014
1015 if (!notes_ref)
894a9d33 1016 notes_ref = default_notes_ref();
709f79b0 1017
73f464b5
JH
1018 if (!combine_notes)
1019 combine_notes = combine_notes_concatenate;
1020
65bbf082 1021 t->root = (struct int_node *) xcalloc(1, sizeof(struct int_node));
851c2b37
JH
1022 t->first_non_note = NULL;
1023 t->prev_non_note = NULL;
8c53f071 1024 t->ref = xstrdup_or_null(notes_ref);
ee76f92f 1025 t->update_ref = (flags & NOTES_INIT_WRITABLE) ? t->ref : NULL;
73f464b5 1026 t->combine_notes = combine_notes;
cd305392 1027 t->initialized = 1;
7f710ea9 1028 t->dirty = 0;
cd305392 1029
709f79b0 1030 if (flags & NOTES_INIT_EMPTY || !notes_ref ||
13ac1410 1031 get_sha1_treeish(notes_ref, object_oid.hash))
fd53c9eb 1032 return;
13ac1410 1033 if (flags & NOTES_INIT_WRITABLE && read_ref(notes_ref, object_oid.hash))
ee76f92f 1034 die("Cannot use notes ref %s", notes_ref);
13ac1410 1035 if (get_tree_entry(object_oid.hash, "", oid.hash, &mode))
709f79b0 1036 die("Failed to read notes tree referenced by %s (%s)",
13ac1410 1037 notes_ref, oid_to_hex(&object_oid));
fd53c9eb 1038
5dcc969e 1039 oidclr(&root_tree.key_oid);
1040 oidcpy(&root_tree.val_oid, &oid);
851c2b37 1041 load_subtree(t, &root_tree, t->root, 0);
fd53c9eb
JS
1042}
1043
ee76f92f 1044struct notes_tree **load_notes_trees(struct string_list *refs, int flags)
894a9d33 1045{
8a57c6e9
AR
1046 struct string_list_item *item;
1047 int counter = 0;
894a9d33 1048 struct notes_tree **trees;
b32fa95f 1049 ALLOC_ARRAY(trees, refs->nr + 1);
8a57c6e9
AR
1050 for_each_string_list_item(item, refs) {
1051 struct notes_tree *t = xcalloc(1, sizeof(struct notes_tree));
ee76f92f 1052 init_notes(t, item->string, combine_notes_ignore, flags);
8a57c6e9
AR
1053 trees[counter++] = t;
1054 }
1055 trees[counter] = NULL;
894a9d33
TR
1056 return trees;
1057}
1058
1059void init_display_notes(struct display_notes_opt *opt)
1060{
1061 char *display_ref_env;
1062 int load_config_refs = 0;
1063 display_notes_refs.strdup_strings = 1;
1064
1065 assert(!display_notes_trees);
1066
3a03cf6b
JK
1067 if (!opt || opt->use_default_notes > 0 ||
1068 (opt->use_default_notes == -1 && !opt->extra_notes_refs.nr)) {
1d2f80fa 1069 string_list_append(&display_notes_refs, default_notes_ref());
894a9d33
TR
1070 display_ref_env = getenv(GIT_NOTES_DISPLAY_REF_ENVIRONMENT);
1071 if (display_ref_env) {
1072 string_list_add_refs_from_colon_sep(&display_notes_refs,
1073 display_ref_env);
1074 load_config_refs = 0;
1075 } else
1076 load_config_refs = 1;
1077 }
1078
1079 git_config(notes_display_config, &load_config_refs);
1080
304cc11c 1081 if (opt) {
8a57c6e9 1082 struct string_list_item *item;
304cc11c 1083 for_each_string_list_item(item, &opt->extra_notes_refs)
8a57c6e9
AR
1084 string_list_add_refs_by_glob(&display_notes_refs,
1085 item->string);
1086 }
894a9d33 1087
ee76f92f 1088 display_notes_trees = load_notes_trees(&display_notes_refs, 0);
894a9d33
TR
1089 string_list_clear(&display_notes_refs, 0);
1090}
1091
5ee8a954 1092int add_note(struct notes_tree *t, const struct object_id *object_oid,
1093 const struct object_id *note_oid, combine_notes_fn combine_notes)
2626b536
JH
1094{
1095 struct leaf_node *l;
1096
cd305392
JH
1097 if (!t)
1098 t = &default_notes_tree;
1099 assert(t->initialized);
7f710ea9 1100 t->dirty = 1;
73f464b5
JH
1101 if (!combine_notes)
1102 combine_notes = t->combine_notes;
2626b536 1103 l = (struct leaf_node *) xmalloc(sizeof(struct leaf_node));
5ee8a954 1104 oidcpy(&l->key_oid, object_oid);
1105 oidcpy(&l->val_oid, note_oid);
180619a5 1106 return note_tree_insert(t, t->root, 0, l, PTR_TYPE_NOTE, combine_notes);
2626b536
JH
1107}
1108
1ee1e43d 1109int remove_note(struct notes_tree *t, const unsigned char *object_sha1)
1ec666b0
JH
1110{
1111 struct leaf_node l;
1112
cd305392
JH
1113 if (!t)
1114 t = &default_notes_tree;
1115 assert(t->initialized);
5dcc969e 1116 hashcpy(l.key_oid.hash, object_sha1);
1117 oidclr(&l.val_oid);
a502ab93 1118 note_tree_remove(t, t->root, 0, &l);
5dcc969e 1119 if (is_null_oid(&l.val_oid)) /* no note was removed */
1ee1e43d
JH
1120 return 1;
1121 t->dirty = 1;
1122 return 0;
1ec666b0
JH
1123}
1124
9ef72230 1125const struct object_id *get_note(struct notes_tree *t,
5ee8a954 1126 const struct object_id *oid)
fd53c9eb 1127{
9b391f21
JH
1128 struct leaf_node *found;
1129
cd305392
JH
1130 if (!t)
1131 t = &default_notes_tree;
1132 assert(t->initialized);
5ee8a954 1133 found = note_tree_find(t, t->root, 0, oid->hash);
9ef72230 1134 return found ? &found->val_oid : NULL;
fd53c9eb 1135}
a97a7468 1136
cd305392
JH
1137int for_each_note(struct notes_tree *t, int flags, each_note_fn fn,
1138 void *cb_data)
73f77b90 1139{
cd305392
JH
1140 if (!t)
1141 t = &default_notes_tree;
1142 assert(t->initialized);
851c2b37 1143 return for_each_note_helper(t, t->root, 0, 0, flags, fn, cb_data);
73f77b90
JH
1144}
1145
cd305392 1146int write_notes_tree(struct notes_tree *t, unsigned char *result)
61a7cca0
JH
1147{
1148 struct tree_write_stack root;
1149 struct write_each_note_data cb_data;
1150 int ret;
1151
cd305392
JH
1152 if (!t)
1153 t = &default_notes_tree;
1154 assert(t->initialized);
61a7cca0
JH
1155
1156 /* Prepare for traversal of current notes tree */
1157 root.next = NULL; /* last forward entry in list is grounded */
89c149f5 1158 strbuf_init(&root.buf, 256 * (32 + GIT_SHA1_HEXSZ)); /* assume 256 entries */
61a7cca0
JH
1159 root.path[0] = root.path[1] = '\0';
1160 cb_data.root = &root;
851c2b37 1161 cb_data.next_non_note = t->first_non_note;
61a7cca0
JH
1162
1163 /* Write tree objects representing current notes tree */
cd305392 1164 ret = for_each_note(t, FOR_EACH_NOTE_DONT_UNPACK_SUBTREES |
61a7cca0
JH
1165 FOR_EACH_NOTE_YIELD_SUBTREES,
1166 write_each_note, &cb_data) ||
851c2b37 1167 write_each_non_note_until(NULL, &cb_data) ||
61a7cca0
JH
1168 tree_write_stack_finish_subtree(&root) ||
1169 write_sha1_file(root.buf.buf, root.buf.len, tree_type, result);
1170 strbuf_release(&root.buf);
1171 return ret;
1172}
1173
a9f2adff 1174void prune_notes(struct notes_tree *t, int flags)
00fbe636
JH
1175{
1176 struct note_delete_list *l = NULL;
1177
1178 if (!t)
1179 t = &default_notes_tree;
1180 assert(t->initialized);
1181
1182 for_each_note(t, 0, prune_notes_helper, &l);
1183
1184 while (l) {
a9f2adff
MG
1185 if (flags & NOTES_PRUNE_VERBOSE)
1186 printf("%s\n", sha1_to_hex(l->sha1));
1187 if (!(flags & NOTES_PRUNE_DRYRUN))
1188 remove_note(t, l->sha1);
00fbe636
JH
1189 l = l->next;
1190 }
1191}
1192
cd305392 1193void free_notes(struct notes_tree *t)
27d57564 1194{
cd305392
JH
1195 if (!t)
1196 t = &default_notes_tree;
1197 if (t->root)
1198 note_tree_free(t->root);
1199 free(t->root);
851c2b37
JH
1200 while (t->first_non_note) {
1201 t->prev_non_note = t->first_non_note->next;
1202 free(t->first_non_note->path);
1203 free(t->first_non_note);
1204 t->first_non_note = t->prev_non_note;
1205 }
cd305392
JH
1206 free(t->ref);
1207 memset(t, 0, sizeof(struct notes_tree));
27d57564
JH
1208}
1209
96531a5e
JH
1210/*
1211 * Fill the given strbuf with the notes associated with the given object.
1212 *
1213 * If the given notes_tree structure is not initialized, it will be auto-
1214 * initialized to the default value (see documentation for init_notes() above).
1215 * If the given notes_tree is NULL, the internal/default notes_tree will be
1216 * used instead.
1217 *
76141e2e
JH
1218 * (raw != 0) gives the %N userformat; otherwise, the note message is given
1219 * for human consumption.
96531a5e 1220 */
fb61e4d3 1221static void format_note(struct notes_tree *t, const struct object_id *object_oid,
76141e2e 1222 struct strbuf *sb, const char *output_encoding, int raw)
a97a7468
JS
1223{
1224 static const char utf8[] = "utf-8";
9ef72230 1225 const struct object_id *oid;
a97a7468
JS
1226 char *msg, *msg_p;
1227 unsigned long linelen, msglen;
1228 enum object_type type;
1229
cd305392
JH
1230 if (!t)
1231 t = &default_notes_tree;
1232 if (!t->initialized)
73f464b5 1233 init_notes(t, NULL, NULL, 0);
a97a7468 1234
5ee8a954 1235 oid = get_note(t, object_oid);
9ef72230 1236 if (!oid)
a97a7468
JS
1237 return;
1238
9ef72230 1239 if (!(msg = read_sha1_file(oid->hash, &type, &msglen)) || type != OBJ_BLOB) {
a97a7468
JS
1240 free(msg);
1241 return;
1242 }
1243
1244 if (output_encoding && *output_encoding &&
0e18bcd5 1245 !is_encoding_utf8(output_encoding)) {
a97a7468
JS
1246 char *reencoded = reencode_string(msg, output_encoding, utf8);
1247 if (reencoded) {
1248 free(msg);
1249 msg = reencoded;
1250 msglen = strlen(msg);
1251 }
1252 }
1253
1254 /* we will end the annotation by a newline anyway */
1255 if (msglen && msg[msglen - 1] == '\n')
1256 msglen--;
1257
76141e2e 1258 if (!raw) {
894a9d33
TR
1259 const char *ref = t->ref;
1260 if (!ref || !strcmp(ref, GIT_NOTES_DEFAULT_REF)) {
1261 strbuf_addstr(sb, "\nNotes:\n");
1262 } else {
59556548 1263 if (starts_with(ref, "refs/"))
894a9d33 1264 ref += 5;
59556548 1265 if (starts_with(ref, "notes/"))
894a9d33
TR
1266 ref += 6;
1267 strbuf_addf(sb, "\nNotes (%s):\n", ref);
1268 }
1269 }
a97a7468
JS
1270
1271 for (msg_p = msg; msg_p < msg + msglen; msg_p += linelen + 1) {
1272 linelen = strchrnul(msg_p, '\n') - msg_p;
1273
76141e2e 1274 if (!raw)
c56fcc89 1275 strbuf_addstr(sb, " ");
a97a7468
JS
1276 strbuf_add(sb, msg_p, linelen);
1277 strbuf_addch(sb, '\n');
1278 }
1279
1280 free(msg);
1281}
894a9d33 1282
fb61e4d3 1283void format_display_notes(const struct object_id *object_oid,
76141e2e 1284 struct strbuf *sb, const char *output_encoding, int raw)
894a9d33
TR
1285{
1286 int i;
1287 assert(display_notes_trees);
1288 for (i = 0; display_notes_trees[i]; i++)
fb61e4d3 1289 format_note(display_notes_trees[i], object_oid, sb,
76141e2e 1290 output_encoding, raw);
894a9d33 1291}
160baa0d
TR
1292
1293int copy_note(struct notes_tree *t,
5ee8a954 1294 const struct object_id *from_obj, const struct object_id *to_obj,
180619a5 1295 int force, combine_notes_fn combine_notes)
160baa0d 1296{
9ef72230 1297 const struct object_id *note = get_note(t, from_obj);
1298 const struct object_id *existing_note = get_note(t, to_obj);
160baa0d
TR
1299
1300 if (!force && existing_note)
1301 return 1;
1302
1303 if (note)
5ee8a954 1304 return add_note(t, to_obj, note, combine_notes);
160baa0d 1305 else if (existing_note)
5ee8a954 1306 return add_note(t, to_obj, &null_oid, combine_notes);
160baa0d
TR
1307
1308 return 0;
1309}
03bb5789
JK
1310
1311void expand_notes_ref(struct strbuf *sb)
1312{
59556548 1313 if (starts_with(sb->buf, "refs/notes/"))
03bb5789 1314 return; /* we're happy */
59556548 1315 else if (starts_with(sb->buf, "notes/"))
03bb5789
JK
1316 strbuf_insert(sb, 0, "refs/", 5);
1317 else
1318 strbuf_insert(sb, 0, "refs/notes/", 11);
1319}
b3715b75
JK
1320
1321void expand_loose_notes_ref(struct strbuf *sb)
1322{
89c149f5 1323 struct object_id object;
b3715b75 1324
89c149f5 1325 if (get_oid(sb->buf, &object)) {
b3715b75
JK
1326 /* fallback to expand_notes_ref */
1327 expand_notes_ref(sb);
1328 }
1329}