blob: f2805d51bb15131c46d41fa9554c43ab2e9a492d [file] [log] [blame]
Johannes Schindelina97a7462009-10-09 12:21:57 +02001#include "cache.h"
Brandon Williamsb2141fc2017-06-14 11:07:36 -07002#include "config.h"
Johannes Schindelina97a7462009-10-09 12:21:57 +02003#include "notes.h"
Stefan Bellercbd53a22018-05-15 16:42:15 -07004#include "object-store.h"
Johan Herland73f464b2010-02-13 22:28:19 +01005#include "blob.h"
Johan Herland61a7cca2010-02-13 22:28:17 +01006#include "tree.h"
Johannes Schindelina97a7462009-10-09 12:21:57 +02007#include "utf8.h"
8#include "strbuf.h"
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02009#include "tree-walk.h"
Thomas Rast894a9d32010-03-12 18:04:26 +010010#include "string-list.h"
11#include "refs.h"
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +020012
Johan Herland23123ae2009-10-09 12:22:07 +020013/*
14 * Use a non-balancing simple 16-tree structure with struct int_node as
15 * internal nodes, and struct leaf_node as leaf nodes. Each int_node has a
16 * 16-array of pointers to its children.
17 * The bottom 2 bits of each pointer is used to identify the pointer type
18 * - ptr & 3 == 0 - NULL pointer, assert(ptr == NULL)
19 * - ptr & 3 == 1 - pointer to next internal node - cast to struct int_node *
20 * - ptr & 3 == 2 - pointer to note entry - cast to struct leaf_node *
21 * - ptr & 3 == 3 - pointer to subtree entry - cast to struct leaf_node *
22 *
23 * The root node is a statically allocated struct int_node.
24 */
25struct int_node {
26 void *a[16];
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +020027};
28
Johan Herland23123ae2009-10-09 12:22:07 +020029/*
30 * Leaf nodes come in two variants, note entries and subtree entries,
31 * distinguished by the LSb of the leaf node pointer (see above).
Johan Herlanda7e7eff2010-02-13 22:28:10 +010032 * As a note entry, the key is the SHA1 of the referenced object, and the
Johan Herland23123ae2009-10-09 12:22:07 +020033 * value is the SHA1 of the note object.
34 * As a subtree entry, the key is the prefix SHA1 (w/trailing NULs) of the
Johan Herlanda7e7eff2010-02-13 22:28:10 +010035 * referenced object, using the last byte of the key to store the length of
Johan Herland23123ae2009-10-09 12:22:07 +020036 * the prefix. The value is the SHA1 of the tree object containing the notes
37 * subtree.
38 */
39struct leaf_node {
brian m. carlson5dcc9692017-05-30 10:30:37 -070040 struct object_id key_oid;
41 struct object_id val_oid;
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +020042};
Johannes Schindelina97a7462009-10-09 12:21:57 +020043
Johan Herland851c2b32010-02-13 22:28:23 +010044/*
45 * A notes tree may contain entries that are not notes, and that do not follow
46 * the naming conventions of notes. There are typically none/few of these, but
47 * we still need to keep track of them. Keep a simple linked list sorted alpha-
48 * betically on the non-note path. The list is populated when parsing tree
49 * objects in load_subtree(), and the non-notes are correctly written back into
50 * the tree objects produced by write_notes_tree().
51 */
52struct non_note {
53 struct non_note *next; /* grounded (last->next == NULL) */
54 char *path;
55 unsigned int mode;
brian m. carlson5dcc9692017-05-30 10:30:37 -070056 struct object_id oid;
Johan Herland851c2b32010-02-13 22:28:23 +010057};
58
Johan Herland23123ae2009-10-09 12:22:07 +020059#define PTR_TYPE_NULL 0
60#define PTR_TYPE_INTERNAL 1
61#define PTR_TYPE_NOTE 2
62#define PTR_TYPE_SUBTREE 3
63
64#define GET_PTR_TYPE(ptr) ((uintptr_t) (ptr) & 3)
65#define CLR_PTR_TYPE(ptr) ((void *) ((uintptr_t) (ptr) & ~3))
66#define SET_PTR_TYPE(ptr, type) ((void *) ((uintptr_t) (ptr) | (type)))
67
Michael Haggerty65eb8e02017-08-26 10:28:01 +020068#define GET_NIBBLE(n, sha1) ((((sha1)[(n) >> 1]) >> ((~(n) & 0x01) << 2)) & 0x0f)
Johan Herland23123ae2009-10-09 12:22:07 +020069
brian m. carlsondd437452019-02-19 00:05:01 +000070#define KEY_INDEX (the_hash_algo->rawsz - 1)
71#define FANOUT_PATH_SEPARATORS (the_hash_algo->rawsz - 1)
72#define FANOUT_PATH_SEPARATORS_MAX ((GIT_MAX_HEXSZ / 2) - 1)
Johan Herland23123ae2009-10-09 12:22:07 +020073#define SUBTREE_SHA1_PREFIXCMP(key_sha1, subtree_sha1) \
brian m. carlson89c149f2017-05-30 10:30:38 -070074 (memcmp(key_sha1, subtree_sha1, subtree_sha1[KEY_INDEX]))
Johan Herland23123ae2009-10-09 12:22:07 +020075
Johan Herlandcd305392010-02-13 22:28:18 +010076struct notes_tree default_notes_tree;
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +020077
Jeff King2721ce22016-06-13 06:04:20 -040078static struct string_list display_notes_refs = STRING_LIST_INIT_NODUP;
Thomas Rast894a9d32010-03-12 18:04:26 +010079static struct notes_tree **display_notes_trees;
80
Johan Herland851c2b32010-02-13 22:28:23 +010081static void load_subtree(struct notes_tree *t, struct leaf_node *subtree,
82 struct int_node *node, unsigned int n);
Johan Herland23123ae2009-10-09 12:22:07 +020083
84/*
Johan Herlandef8db632009-10-09 12:22:09 +020085 * Search the tree until the appropriate location for the given key is found:
Johan Herland23123ae2009-10-09 12:22:07 +020086 * 1. Start at the root node, with n = 0
Johan Herlandef8db632009-10-09 12:22:09 +020087 * 2. If a[0] at the current level is a matching subtree entry, unpack that
88 * subtree entry and remove it; restart search at the current level.
89 * 3. Use the nth nibble of the key as an index into a:
90 * - If a[n] is an int_node, recurse from #2 into that node and increment n
Johan Herland23123ae2009-10-09 12:22:07 +020091 * - If a matching subtree entry, unpack that subtree entry (and remove it);
92 * restart search at the current level.
Johan Herlandef8db632009-10-09 12:22:09 +020093 * - Otherwise, we have found one of the following:
94 * - a subtree entry which does not match the key
95 * - a note entry which may or may not match the key
96 * - an unused leaf node (NULL)
97 * In any case, set *tree and *n, and return pointer to the tree location.
Johan Herland23123ae2009-10-09 12:22:07 +020098 */
Johan Herland851c2b32010-02-13 22:28:23 +010099static void **note_tree_search(struct notes_tree *t, struct int_node **tree,
Johan Herlandef8db632009-10-09 12:22:09 +0200100 unsigned char *n, const unsigned char *key_sha1)
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200101{
Johan Herland23123ae2009-10-09 12:22:07 +0200102 struct leaf_node *l;
Johan Herlandef8db632009-10-09 12:22:09 +0200103 unsigned char i;
104 void *p = (*tree)->a[0];
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200105
Johan Herlandef8db632009-10-09 12:22:09 +0200106 if (GET_PTR_TYPE(p) == PTR_TYPE_SUBTREE) {
107 l = (struct leaf_node *) CLR_PTR_TYPE(p);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700108 if (!SUBTREE_SHA1_PREFIXCMP(key_sha1, l->key_oid.hash)) {
Johan Herlandef8db632009-10-09 12:22:09 +0200109 /* unpack tree and resume search */
110 (*tree)->a[0] = NULL;
Johan Herland851c2b32010-02-13 22:28:23 +0100111 load_subtree(t, l, *tree, *n);
Johan Herlandef8db632009-10-09 12:22:09 +0200112 free(l);
Johan Herland851c2b32010-02-13 22:28:23 +0100113 return note_tree_search(t, tree, n, key_sha1);
Johan Herlandef8db632009-10-09 12:22:09 +0200114 }
115 }
116
117 i = GET_NIBBLE(*n, key_sha1);
118 p = (*tree)->a[i];
Johan Herland0ab1faa2010-02-13 22:28:09 +0100119 switch (GET_PTR_TYPE(p)) {
Johan Herland23123ae2009-10-09 12:22:07 +0200120 case PTR_TYPE_INTERNAL:
Johan Herlandef8db632009-10-09 12:22:09 +0200121 *tree = CLR_PTR_TYPE(p);
122 (*n)++;
Johan Herland851c2b32010-02-13 22:28:23 +0100123 return note_tree_search(t, tree, n, key_sha1);
Johan Herland23123ae2009-10-09 12:22:07 +0200124 case PTR_TYPE_SUBTREE:
125 l = (struct leaf_node *) CLR_PTR_TYPE(p);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700126 if (!SUBTREE_SHA1_PREFIXCMP(key_sha1, l->key_oid.hash)) {
Johan Herland23123ae2009-10-09 12:22:07 +0200127 /* unpack tree and resume search */
Johan Herlandef8db632009-10-09 12:22:09 +0200128 (*tree)->a[i] = NULL;
Johan Herland851c2b32010-02-13 22:28:23 +0100129 load_subtree(t, l, *tree, *n);
Johan Herland23123ae2009-10-09 12:22:07 +0200130 free(l);
Johan Herland851c2b32010-02-13 22:28:23 +0100131 return note_tree_search(t, tree, n, key_sha1);
Johan Herland23123ae2009-10-09 12:22:07 +0200132 }
Johan Herlandef8db632009-10-09 12:22:09 +0200133 /* fall through */
Johan Herland23123ae2009-10-09 12:22:07 +0200134 default:
Johan Herlandef8db632009-10-09 12:22:09 +0200135 return &((*tree)->a[i]);
Johan Herland23123ae2009-10-09 12:22:07 +0200136 }
Johan Herlandef8db632009-10-09 12:22:09 +0200137}
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200138
Johan Herlandef8db632009-10-09 12:22:09 +0200139/*
140 * To find a leaf_node:
141 * Search to the tree location appropriate for the given key:
142 * If a note entry with matching key, return the note entry, else return NULL.
143 */
Johan Herland851c2b32010-02-13 22:28:23 +0100144static struct leaf_node *note_tree_find(struct notes_tree *t,
145 struct int_node *tree, unsigned char n,
Johan Herlandef8db632009-10-09 12:22:09 +0200146 const unsigned char *key_sha1)
147{
Johan Herland851c2b32010-02-13 22:28:23 +0100148 void **p = note_tree_search(t, &tree, &n, key_sha1);
Johan Herlandef8db632009-10-09 12:22:09 +0200149 if (GET_PTR_TYPE(*p) == PTR_TYPE_NOTE) {
150 struct leaf_node *l = (struct leaf_node *) CLR_PTR_TYPE(*p);
Jeff Kinge3ff0682018-08-28 17:22:44 -0400151 if (hasheq(key_sha1, l->key_oid.hash))
Johan Herlandef8db632009-10-09 12:22:09 +0200152 return l;
Johan Herland23123ae2009-10-09 12:22:07 +0200153 }
154 return NULL;
155}
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200156
Johan Herland23123ae2009-10-09 12:22:07 +0200157/*
Johan Herland1ec666b2010-02-13 22:28:14 +0100158 * How to consolidate an int_node:
159 * If there are > 1 non-NULL entries, give up and return non-zero.
160 * Otherwise replace the int_node at the given index in the given parent node
Mike Hommey5a8e7c32017-03-26 10:52:12 +0900161 * with the only NOTE entry (or a NULL entry if no entries) from the given
162 * tree, and return 0.
Johan Herland1ec666b2010-02-13 22:28:14 +0100163 */
164static int note_tree_consolidate(struct int_node *tree,
165 struct int_node *parent, unsigned char index)
166{
167 unsigned int i;
168 void *p = NULL;
169
170 assert(tree && parent);
171 assert(CLR_PTR_TYPE(parent->a[index]) == tree);
172
173 for (i = 0; i < 16; i++) {
174 if (GET_PTR_TYPE(tree->a[i]) != PTR_TYPE_NULL) {
175 if (p) /* more than one entry */
176 return -2;
177 p = tree->a[i];
178 }
179 }
180
Mike Hommey5a8e7c32017-03-26 10:52:12 +0900181 if (p && (GET_PTR_TYPE(p) != PTR_TYPE_NOTE))
182 return -2;
Johan Herland1ec666b2010-02-13 22:28:14 +0100183 /* replace tree with p in parent[index] */
184 parent->a[index] = p;
185 free(tree);
186 return 0;
187}
188
189/*
190 * To remove a leaf_node:
191 * Search to the tree location appropriate for the given leaf_node's key:
192 * - If location does not hold a matching entry, abort and do nothing.
Johan Herland1ee1e432010-08-31 17:56:50 +0200193 * - Copy the matching entry's value into the given entry.
Johan Herland1ec666b2010-02-13 22:28:14 +0100194 * - Replace the matching leaf_node with a NULL entry (and free the leaf_node).
195 * - Consolidate int_nodes repeatedly, while walking up the tree towards root.
196 */
Johan Herland1ee1e432010-08-31 17:56:50 +0200197static void note_tree_remove(struct notes_tree *t,
198 struct int_node *tree, unsigned char n,
199 struct leaf_node *entry)
Johan Herland1ec666b2010-02-13 22:28:14 +0100200{
201 struct leaf_node *l;
brian m. carlsondd437452019-02-19 00:05:01 +0000202 struct int_node *parent_stack[GIT_MAX_RAWSZ];
Johan Herland1ec666b2010-02-13 22:28:14 +0100203 unsigned char i, j;
brian m. carlson5dcc9692017-05-30 10:30:37 -0700204 void **p = note_tree_search(t, &tree, &n, entry->key_oid.hash);
Johan Herland1ec666b2010-02-13 22:28:14 +0100205
206 assert(GET_PTR_TYPE(entry) == 0); /* no type bits set */
207 if (GET_PTR_TYPE(*p) != PTR_TYPE_NOTE)
208 return; /* type mismatch, nothing to remove */
209 l = (struct leaf_node *) CLR_PTR_TYPE(*p);
Jeff King9001dc22018-08-28 17:22:48 -0400210 if (!oideq(&l->key_oid, &entry->key_oid))
Johan Herland1ec666b2010-02-13 22:28:14 +0100211 return; /* key mismatch, nothing to remove */
212
213 /* we have found a matching entry */
brian m. carlson5dcc9692017-05-30 10:30:37 -0700214 oidcpy(&entry->val_oid, &l->val_oid);
Johan Herland1ec666b2010-02-13 22:28:14 +0100215 free(l);
216 *p = SET_PTR_TYPE(NULL, PTR_TYPE_NULL);
217
218 /* consolidate this tree level, and parent levels, if possible */
219 if (!n)
220 return; /* cannot consolidate top level */
221 /* first, build stack of ancestors between root and current node */
Johan Herlandcd305392010-02-13 22:28:18 +0100222 parent_stack[0] = t->root;
Johan Herland1ec666b2010-02-13 22:28:14 +0100223 for (i = 0; i < n; i++) {
brian m. carlson5dcc9692017-05-30 10:30:37 -0700224 j = GET_NIBBLE(i, entry->key_oid.hash);
Johan Herland1ec666b2010-02-13 22:28:14 +0100225 parent_stack[i + 1] = CLR_PTR_TYPE(parent_stack[i]->a[j]);
226 }
227 assert(i == n && parent_stack[i] == tree);
228 /* next, unwind stack until note_tree_consolidate() is done */
229 while (i > 0 &&
230 !note_tree_consolidate(parent_stack[i], parent_stack[i - 1],
brian m. carlson5dcc9692017-05-30 10:30:37 -0700231 GET_NIBBLE(i - 1, entry->key_oid.hash)))
Johan Herland1ec666b2010-02-13 22:28:14 +0100232 i--;
233}
234
Johan Herlanda5cdebe2010-11-09 22:49:40 +0100235/*
Johannes Schindelina97a7462009-10-09 12:21:57 +0200236 * To insert a leaf_node:
237 * Search to the tree location appropriate for the given leaf_node's key:
238 * - If location is unused (NULL), store the tweaked pointer directly there
239 * - If location holds a note entry that matches the note-to-be-inserted, then
240 * combine the two notes (by calling the given combine_notes function).
241 * - If location holds a note entry that matches the subtree-to-be-inserted,
242 * then unpack the subtree-to-be-inserted into the location.
243 * - If location holds a matching subtree entry, unpack the subtree at that
244 * location, and restart the insert operation from that level.
245 * - Else, create a new int_node, holding both the node-at-location and the
246 * node-to-be-inserted, and store the new int_node into the location.
247 */
Johan Herland180619a2010-11-15 00:52:26 +0100248static int note_tree_insert(struct notes_tree *t, struct int_node *tree,
Johannes Schindelina97a7462009-10-09 12:21:57 +0200249 unsigned char n, struct leaf_node *entry, unsigned char type,
250 combine_notes_fn combine_notes)
251{
252 struct int_node *new_node;
253 struct leaf_node *l;
brian m. carlson5dcc9692017-05-30 10:30:37 -0700254 void **p = note_tree_search(t, &tree, &n, entry->key_oid.hash);
Johan Herland180619a2010-11-15 00:52:26 +0100255 int ret = 0;
Johannes Schindelina97a7462009-10-09 12:21:57 +0200256
257 assert(GET_PTR_TYPE(entry) == 0); /* no type bits set */
258 l = (struct leaf_node *) CLR_PTR_TYPE(*p);
259 switch (GET_PTR_TYPE(*p)) {
260 case PTR_TYPE_NULL:
261 assert(!*p);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700262 if (is_null_oid(&entry->val_oid))
Johan Herlande2656c82010-11-09 22:49:41 +0100263 free(entry);
264 else
265 *p = SET_PTR_TYPE(entry, type);
Johan Herland180619a2010-11-15 00:52:26 +0100266 return 0;
Johannes Schindelina97a7462009-10-09 12:21:57 +0200267 case PTR_TYPE_NOTE:
268 switch (type) {
269 case PTR_TYPE_NOTE:
Jeff King4a7e27e2018-08-28 17:22:40 -0400270 if (oideq(&l->key_oid, &entry->key_oid)) {
Johannes Schindelina97a7462009-10-09 12:21:57 +0200271 /* skip concatenation if l == entry */
Mike Hommey779ad662019-08-25 14:18:18 +0900272 if (oideq(&l->val_oid, &entry->val_oid)) {
273 free(entry);
Johan Herland180619a2010-11-15 00:52:26 +0100274 return 0;
Mike Hommey779ad662019-08-25 14:18:18 +0900275 }
Johannes Schindelina97a7462009-10-09 12:21:57 +0200276
Patryk Obarab7d591d2018-01-28 01:13:17 +0100277 ret = combine_notes(&l->val_oid,
278 &entry->val_oid);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700279 if (!ret && is_null_oid(&l->val_oid))
Johan Herlande2656c82010-11-09 22:49:41 +0100280 note_tree_remove(t, tree, n, entry);
Johannes Schindelina97a7462009-10-09 12:21:57 +0200281 free(entry);
Johan Herland180619a2010-11-15 00:52:26 +0100282 return ret;
Johannes Schindelina97a7462009-10-09 12:21:57 +0200283 }
284 break;
285 case PTR_TYPE_SUBTREE:
brian m. carlson5dcc9692017-05-30 10:30:37 -0700286 if (!SUBTREE_SHA1_PREFIXCMP(l->key_oid.hash,
287 entry->key_oid.hash)) {
Johannes Schindelina97a7462009-10-09 12:21:57 +0200288 /* unpack 'entry' */
289 load_subtree(t, entry, tree, n);
290 free(entry);
Johan Herland180619a2010-11-15 00:52:26 +0100291 return 0;
Johannes Schindelina97a7462009-10-09 12:21:57 +0200292 }
293 break;
294 }
295 break;
296 case PTR_TYPE_SUBTREE:
brian m. carlson5dcc9692017-05-30 10:30:37 -0700297 if (!SUBTREE_SHA1_PREFIXCMP(entry->key_oid.hash, l->key_oid.hash)) {
Johannes Schindelina97a7462009-10-09 12:21:57 +0200298 /* unpack 'l' and restart insert */
299 *p = NULL;
300 load_subtree(t, l, tree, n);
301 free(l);
Johan Herland180619a2010-11-15 00:52:26 +0100302 return note_tree_insert(t, tree, n, entry, type,
303 combine_notes);
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200304 }
305 break;
306 }
307
308 /* non-matching leaf_node */
309 assert(GET_PTR_TYPE(*p) == PTR_TYPE_NOTE ||
310 GET_PTR_TYPE(*p) == PTR_TYPE_SUBTREE);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700311 if (is_null_oid(&entry->val_oid)) { /* skip insertion of empty note */
Johan Herlande2656c82010-11-09 22:49:41 +0100312 free(entry);
Johan Herland180619a2010-11-15 00:52:26 +0100313 return 0;
Johan Herlande2656c82010-11-09 22:49:41 +0100314 }
Brian Gesiak65bbf082014-05-27 00:33:52 +0900315 new_node = (struct int_node *) xcalloc(1, sizeof(struct int_node));
Johan Herland180619a2010-11-15 00:52:26 +0100316 ret = note_tree_insert(t, new_node, n + 1, l, GET_PTR_TYPE(*p),
317 combine_notes);
318 if (ret)
319 return ret;
Johan Herland23123ae2009-10-09 12:22:07 +0200320 *p = SET_PTR_TYPE(new_node, PTR_TYPE_INTERNAL);
Johan Herland180619a2010-11-15 00:52:26 +0100321 return note_tree_insert(t, new_node, n + 1, entry, type, combine_notes);
Johan Herlandef8db632009-10-09 12:22:09 +0200322}
323
Johan Herland23123ae2009-10-09 12:22:07 +0200324/* Free the entire notes data contained in the given tree */
325static void note_tree_free(struct int_node *tree)
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200326{
Johan Herland23123ae2009-10-09 12:22:07 +0200327 unsigned int i;
328 for (i = 0; i < 16; i++) {
329 void *p = tree->a[i];
Johan Herland0ab1faa2010-02-13 22:28:09 +0100330 switch (GET_PTR_TYPE(p)) {
Johan Herland23123ae2009-10-09 12:22:07 +0200331 case PTR_TYPE_INTERNAL:
332 note_tree_free(CLR_PTR_TYPE(p));
333 /* fall through */
334 case PTR_TYPE_NOTE:
335 case PTR_TYPE_SUBTREE:
336 free(CLR_PTR_TYPE(p));
337 }
338 }
339}
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200340
Johan Herland851c2b32010-02-13 22:28:23 +0100341static int non_note_cmp(const struct non_note *a, const struct non_note *b)
342{
343 return strcmp(a->path, b->path);
344}
345
Jeff Kingc29edfe2015-08-19 14:12:41 -0400346/* note: takes ownership of path string */
347static void add_non_note(struct notes_tree *t, char *path,
Johan Herland851c2b32010-02-13 22:28:23 +0100348 unsigned int mode, const unsigned char *sha1)
349{
350 struct non_note *p = t->prev_non_note, *n;
351 n = (struct non_note *) xmalloc(sizeof(struct non_note));
352 n->next = NULL;
Jeff Kingc29edfe2015-08-19 14:12:41 -0400353 n->path = path;
Johan Herland851c2b32010-02-13 22:28:23 +0100354 n->mode = mode;
brian m. carlson92e2cab2021-04-26 01:02:50 +0000355 oidread(&n->oid, sha1);
Johan Herland851c2b32010-02-13 22:28:23 +0100356 t->prev_non_note = n;
357
358 if (!t->first_non_note) {
359 t->first_non_note = n;
360 return;
361 }
362
363 if (non_note_cmp(p, n) < 0)
364 ; /* do nothing */
365 else if (non_note_cmp(t->first_non_note, n) <= 0)
366 p = t->first_non_note;
367 else {
368 /* n sorts before t->first_non_note */
369 n->next = t->first_non_note;
370 t->first_non_note = n;
371 return;
372 }
373
374 /* n sorts equal or after p */
375 while (p->next && non_note_cmp(p->next, n) <= 0)
376 p = p->next;
377
378 if (non_note_cmp(p, n) == 0) { /* n ~= p; overwrite p with n */
379 assert(strcmp(p->path, n->path) == 0);
380 p->mode = n->mode;
brian m. carlson5dcc9692017-05-30 10:30:37 -0700381 oidcpy(&p->oid, &n->oid);
Johan Herland851c2b32010-02-13 22:28:23 +0100382 free(n);
383 t->prev_non_note = p;
384 return;
385 }
386
387 /* n sorts between p and p->next */
388 n->next = p->next;
389 p->next = n;
390}
391
392static void load_subtree(struct notes_tree *t, struct leaf_node *subtree,
393 struct int_node *node, unsigned int n)
Johan Herland23123ae2009-10-09 12:22:07 +0200394{
brian m. carlson89c149f2017-05-30 10:30:38 -0700395 struct object_id object_oid;
Michael Haggerty06cfa752017-08-26 10:28:12 +0200396 size_t prefix_len;
Johan Herland23123ae2009-10-09 12:22:07 +0200397 void *buf;
398 struct tree_desc desc;
399 struct name_entry entry;
brian m. carlsondd437452019-02-19 00:05:01 +0000400 const unsigned hashsz = the_hash_algo->rawsz;
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200401
Nguyễn Thái Ngọc Duy5e575802019-06-27 16:28:48 +0700402 buf = fill_tree_descriptor(the_repository, &desc, &subtree->val_oid);
Johan Herland23123ae2009-10-09 12:22:07 +0200403 if (!buf)
404 die("Could not read %s for notes-index",
brian m. carlson5dcc9692017-05-30 10:30:37 -0700405 oid_to_hex(&subtree->val_oid));
Johan Herland23123ae2009-10-09 12:22:07 +0200406
brian m. carlson89c149f2017-05-30 10:30:38 -0700407 prefix_len = subtree->key_oid.hash[KEY_INDEX];
brian m. carlsondd437452019-02-19 00:05:01 +0000408 if (prefix_len >= hashsz)
Michael Haggerty39642812017-09-08 18:10:10 +0200409 BUG("prefix_len (%"PRIuMAX") is out of range", (uintmax_t)prefix_len);
410 if (prefix_len * 2 < n)
411 BUG("prefix_len (%"PRIuMAX") is too small", (uintmax_t)prefix_len);
brian m. carlson89c149f2017-05-30 10:30:38 -0700412 memcpy(object_oid.hash, subtree->key_oid.hash, prefix_len);
Johan Herland23123ae2009-10-09 12:22:07 +0200413 while (tree_entry(&desc, &entry)) {
Michael Haggertya2816392017-08-26 10:28:03 +0200414 unsigned char type;
415 struct leaf_node *l;
Michael Haggerty06cfa752017-08-26 10:28:12 +0200416 size_t path_len = strlen(entry.path);
Johan Herland23123ae2009-10-09 12:22:07 +0200417
brian m. carlsondd437452019-02-19 00:05:01 +0000418 if (path_len == 2 * (hashsz - prefix_len)) {
Michael Haggerty98c98972017-08-26 10:28:05 +0200419 /* This is potentially the remainder of the SHA-1 */
Michael Haggerty40432182017-08-26 10:28:07 +0200420
421 if (!S_ISREG(entry.mode))
422 /* notes must be blobs */
423 goto handle_non_note;
424
Michael Haggertycfdc88f2017-08-26 10:28:11 +0200425 if (hex_to_bytes(object_oid.hash + prefix_len, entry.path,
brian m. carlsondd437452019-02-19 00:05:01 +0000426 hashsz - prefix_len))
Michael Haggerty98c98972017-08-26 10:28:05 +0200427 goto handle_non_note; /* entry.path is not a SHA1 */
Johan Herland23123ae2009-10-09 12:22:07 +0200428
Johan Herland851c2b32010-02-13 22:28:23 +0100429 type = PTR_TYPE_NOTE;
Michael Haggerty98c98972017-08-26 10:28:05 +0200430 } else if (path_len == 2) {
431 /* This is potentially an internal node */
Michael Haggertyd49852d2017-08-26 10:28:10 +0200432 size_t len = prefix_len;
Michael Haggerty4d589b82017-08-26 10:28:06 +0200433
434 if (!S_ISDIR(entry.mode))
435 /* internal nodes must be trees */
436 goto handle_non_note;
437
Michael Haggertycfdc88f2017-08-26 10:28:11 +0200438 if (hex_to_bytes(object_oid.hash + len++, entry.path, 1))
Michael Haggerty98c98972017-08-26 10:28:05 +0200439 goto handle_non_note; /* entry.path is not a SHA1 */
440
Michael Haggertyd49852d2017-08-26 10:28:10 +0200441 /*
442 * Pad the rest of the SHA-1 with zeros,
443 * except for the last byte, where we write
444 * the length:
445 */
brian m. carlsondd437452019-02-19 00:05:01 +0000446 memset(object_oid.hash + len, 0, hashsz - len - 1);
Michael Haggertyd49852d2017-08-26 10:28:10 +0200447 object_oid.hash[KEY_INDEX] = (unsigned char)len;
Michael Haggerty4ebef532017-08-26 10:28:09 +0200448
Michael Haggertyd3b0c6b2017-08-26 10:28:02 +0200449 type = PTR_TYPE_SUBTREE;
Michael Haggerty98c98972017-08-26 10:28:05 +0200450 } else {
451 /* This can't be part of a note */
452 goto handle_non_note;
Johan Herland23123ae2009-10-09 12:22:07 +0200453 }
Michael Haggerty98c98972017-08-26 10:28:05 +0200454
René Scharfeca56dad2021-03-13 17:17:22 +0100455 CALLOC_ARRAY(l, 1);
Michael Haggerty4ebef532017-08-26 10:28:09 +0200456 oidcpy(&l->key_oid, &object_oid);
brian m. carlsonea82b2a2019-01-15 00:39:44 +0000457 oidcpy(&l->val_oid, &entry.oid);
brian m. carlson5a6dce72021-04-26 01:02:55 +0000458 oid_set_algo(&l->key_oid, the_hash_algo);
459 oid_set_algo(&l->val_oid, the_hash_algo);
Michael Haggertyd3b0c6b2017-08-26 10:28:02 +0200460 if (note_tree_insert(t, node, n, l, type,
461 combine_notes_concatenate))
462 die("Failed to load %s %s into notes tree "
463 "from %s",
464 type == PTR_TYPE_NOTE ? "note" : "subtree",
Jeff King60fe4772019-08-25 03:19:51 -0400465 oid_to_hex(&object_oid), t->ref);
Michael Haggertyd3b0c6b2017-08-26 10:28:02 +0200466
Johan Herland851c2b32010-02-13 22:28:23 +0100467 continue;
468
469handle_non_note:
470 /*
Michael Haggertycbeed9a2017-08-26 10:28:04 +0200471 * Determine full path for this non-note entry. The
472 * filename is already found in entry.path, but the
473 * directory part of the path must be deduced from the
474 * subtree containing this entry based on our
475 * knowledge that the overall notes tree follows a
476 * strict byte-based progressive fanout structure
477 * (i.e. using 2/38, 2/2/36, etc. fanouts).
Johan Herland851c2b32010-02-13 22:28:23 +0100478 */
479 {
Jeff Kingc29edfe2015-08-19 14:12:41 -0400480 struct strbuf non_note_path = STRBUF_INIT;
brian m. carlson5dcc9692017-05-30 10:30:37 -0700481 const char *q = oid_to_hex(&subtree->key_oid);
Michael Haggerty06cfa752017-08-26 10:28:12 +0200482 size_t i;
Johan Herland851c2b32010-02-13 22:28:23 +0100483 for (i = 0; i < prefix_len; i++) {
Jeff Kingc29edfe2015-08-19 14:12:41 -0400484 strbuf_addch(&non_note_path, *q++);
485 strbuf_addch(&non_note_path, *q++);
486 strbuf_addch(&non_note_path, '/');
Johan Herland851c2b32010-02-13 22:28:23 +0100487 }
Jeff Kingc29edfe2015-08-19 14:12:41 -0400488 strbuf_addstr(&non_note_path, entry.path);
brian m. carlson5a6dce72021-04-26 01:02:55 +0000489 oid_set_algo(&entry.oid, the_hash_algo);
Jeff Kingc29edfe2015-08-19 14:12:41 -0400490 add_non_note(t, strbuf_detach(&non_note_path, NULL),
brian m. carlsonea82b2a2019-01-15 00:39:44 +0000491 entry.mode, entry.oid.hash);
Johan Herland851c2b32010-02-13 22:28:23 +0100492 }
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200493 }
Johan Herland23123ae2009-10-09 12:22:07 +0200494 free(buf);
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200495}
496
Johan Herland73f77b92010-02-13 22:28:16 +0100497/*
498 * Determine optimal on-disk fanout for this part of the notes tree
499 *
500 * Given a (sub)tree and the level in the internal tree structure, determine
501 * whether or not the given existing fanout should be expanded for this
502 * (sub)tree.
503 *
504 * Values of the 'fanout' variable:
505 * - 0: No fanout (all notes are stored directly in the root notes tree)
506 * - 1: 2/38 fanout
507 * - 2: 2/2/36 fanout
508 * - 3: 2/2/2/34 fanout
509 * etc.
510 */
511static unsigned char determine_fanout(struct int_node *tree, unsigned char n,
512 unsigned char fanout)
513{
514 /*
515 * The following is a simple heuristic that works well in practice:
516 * For each even-numbered 16-tree level (remember that each on-disk
517 * fanout level corresponds to _two_ 16-tree levels), peek at all 16
518 * entries at that tree level. If all of them are either int_nodes or
519 * subtree entries, then there are likely plenty of notes below this
520 * level, so we return an incremented fanout.
521 */
522 unsigned int i;
523 if ((n % 2) || (n > 2 * fanout))
524 return fanout;
525 for (i = 0; i < 16; i++) {
526 switch (GET_PTR_TYPE(tree->a[i])) {
527 case PTR_TYPE_SUBTREE:
528 case PTR_TYPE_INTERNAL:
529 continue;
530 default:
531 return fanout;
532 }
533 }
534 return fanout + 1;
535}
536
brian m. carlsondd437452019-02-19 00:05:01 +0000537/* hex oid + '/' between each pair of hex digits + NUL */
538#define FANOUT_PATH_MAX GIT_MAX_HEXSZ + FANOUT_PATH_SEPARATORS_MAX + 1
Jeff King02e32b72015-09-24 17:08:24 -0400539
brian m. carlson0dbc6462019-02-19 00:05:02 +0000540static void construct_path_with_fanout(const unsigned char *hash,
Johan Herland73f77b92010-02-13 22:28:16 +0100541 unsigned char fanout, char *path)
542{
543 unsigned int i = 0, j = 0;
brian m. carlson0dbc6462019-02-19 00:05:02 +0000544 const char *hex_hash = hash_to_hex(hash);
brian m. carlsondd437452019-02-19 00:05:01 +0000545 assert(fanout < the_hash_algo->rawsz);
Johan Herland73f77b92010-02-13 22:28:16 +0100546 while (fanout) {
brian m. carlson0dbc6462019-02-19 00:05:02 +0000547 path[i++] = hex_hash[j++];
548 path[i++] = hex_hash[j++];
Johan Herland73f77b92010-02-13 22:28:16 +0100549 path[i++] = '/';
550 fanout--;
551 }
brian m. carlson0dbc6462019-02-19 00:05:02 +0000552 xsnprintf(path + i, FANOUT_PATH_MAX - i, "%s", hex_hash + j);
Johan Herland73f77b92010-02-13 22:28:16 +0100553}
554
Johan Herland851c2b32010-02-13 22:28:23 +0100555static int for_each_note_helper(struct notes_tree *t, struct int_node *tree,
556 unsigned char n, unsigned char fanout, int flags,
557 each_note_fn fn, void *cb_data)
Johan Herland73f77b92010-02-13 22:28:16 +0100558{
559 unsigned int i;
560 void *p;
561 int ret = 0;
562 struct leaf_node *l;
Jeff King02e32b72015-09-24 17:08:24 -0400563 static char path[FANOUT_PATH_MAX];
Johan Herland73f77b92010-02-13 22:28:16 +0100564
565 fanout = determine_fanout(tree, n, fanout);
566 for (i = 0; i < 16; i++) {
567redo:
568 p = tree->a[i];
569 switch (GET_PTR_TYPE(p)) {
570 case PTR_TYPE_INTERNAL:
571 /* recurse into int_node */
Johan Herland851c2b32010-02-13 22:28:23 +0100572 ret = for_each_note_helper(t, CLR_PTR_TYPE(p), n + 1,
Johan Herland73f77b92010-02-13 22:28:16 +0100573 fanout, flags, fn, cb_data);
574 break;
575 case PTR_TYPE_SUBTREE:
576 l = (struct leaf_node *) CLR_PTR_TYPE(p);
577 /*
578 * Subtree entries in the note tree represent parts of
579 * the note tree that have not yet been explored. There
580 * is a direct relationship between subtree entries at
581 * level 'n' in the tree, and the 'fanout' variable:
Johan Herlanddbc27472020-02-03 22:04:45 +0100582 * Subtree entries at level 'n < 2 * fanout' should be
Johan Herland73f77b92010-02-13 22:28:16 +0100583 * preserved, since they correspond exactly to a fanout
584 * directory in the on-disk structure. However, subtree
Johan Herlanddbc27472020-02-03 22:04:45 +0100585 * entries at level 'n >= 2 * fanout' should NOT be
Johan Herland73f77b92010-02-13 22:28:16 +0100586 * preserved, but rather consolidated into the above
587 * notes tree level. We achieve this by unconditionally
588 * unpacking subtree entries that exist below the
589 * threshold level at 'n = 2 * fanout'.
590 */
Johan Herlanddbc27472020-02-03 22:04:45 +0100591 if (n < 2 * fanout &&
Johan Herland73f77b92010-02-13 22:28:16 +0100592 flags & FOR_EACH_NOTE_YIELD_SUBTREES) {
593 /* invoke callback with subtree */
594 unsigned int path_len =
brian m. carlson89c149f2017-05-30 10:30:38 -0700595 l->key_oid.hash[KEY_INDEX] * 2 + fanout;
Jeff King02e32b72015-09-24 17:08:24 -0400596 assert(path_len < FANOUT_PATH_MAX - 1);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700597 construct_path_with_fanout(l->key_oid.hash,
598 fanout,
Johan Herland73f77b92010-02-13 22:28:16 +0100599 path);
600 /* Create trailing slash, if needed */
601 if (path[path_len - 1] != '/')
602 path[path_len++] = '/';
603 path[path_len] = '\0';
brian m. carlson490bc832017-05-30 10:30:39 -0700604 ret = fn(&l->key_oid, &l->val_oid,
brian m. carlson5dcc9692017-05-30 10:30:37 -0700605 path,
Johan Herland73f77b92010-02-13 22:28:16 +0100606 cb_data);
607 }
Johan Herlanddbc27472020-02-03 22:04:45 +0100608 if (n >= 2 * fanout ||
Johan Herland73f77b92010-02-13 22:28:16 +0100609 !(flags & FOR_EACH_NOTE_DONT_UNPACK_SUBTREES)) {
610 /* unpack subtree and resume traversal */
611 tree->a[i] = NULL;
Johan Herland851c2b32010-02-13 22:28:23 +0100612 load_subtree(t, l, tree, n);
Johan Herland73f77b92010-02-13 22:28:16 +0100613 free(l);
614 goto redo;
615 }
616 break;
617 case PTR_TYPE_NOTE:
618 l = (struct leaf_node *) CLR_PTR_TYPE(p);
brian m. carlson5dcc9692017-05-30 10:30:37 -0700619 construct_path_with_fanout(l->key_oid.hash, fanout,
620 path);
brian m. carlson490bc832017-05-30 10:30:39 -0700621 ret = fn(&l->key_oid, &l->val_oid, path,
brian m. carlson5dcc9692017-05-30 10:30:37 -0700622 cb_data);
Johan Herland73f77b92010-02-13 22:28:16 +0100623 break;
624 }
625 if (ret)
626 return ret;
627 }
628 return 0;
629}
630
Johan Herland61a7cca2010-02-13 22:28:17 +0100631struct tree_write_stack {
632 struct tree_write_stack *next;
633 struct strbuf buf;
634 char path[2]; /* path to subtree in next, if any */
635};
636
637static inline int matches_tree_write_stack(struct tree_write_stack *tws,
638 const char *full_path)
639{
640 return full_path[0] == tws->path[0] &&
641 full_path[1] == tws->path[1] &&
642 full_path[2] == '/';
643}
644
645static void write_tree_entry(struct strbuf *buf, unsigned int mode,
646 const char *path, unsigned int path_len, const
brian m. carlsondd437452019-02-19 00:05:01 +0000647 unsigned char *hash)
Johan Herland61a7cca2010-02-13 22:28:17 +0100648{
Junio C Hamanoc88f0cc2010-02-24 21:39:06 -0800649 strbuf_addf(buf, "%o %.*s%c", mode, path_len, path, '\0');
brian m. carlsondd437452019-02-19 00:05:01 +0000650 strbuf_add(buf, hash, the_hash_algo->rawsz);
Johan Herland61a7cca2010-02-13 22:28:17 +0100651}
652
653static void tree_write_stack_init_subtree(struct tree_write_stack *tws,
654 const char *path)
655{
656 struct tree_write_stack *n;
657 assert(!tws->next);
658 assert(tws->path[0] == '\0' && tws->path[1] == '\0');
659 n = (struct tree_write_stack *)
660 xmalloc(sizeof(struct tree_write_stack));
661 n->next = NULL;
brian m. carlsondd437452019-02-19 00:05:01 +0000662 strbuf_init(&n->buf, 256 * (32 + the_hash_algo->hexsz)); /* assume 256 entries per tree */
Johan Herland61a7cca2010-02-13 22:28:17 +0100663 n->path[0] = n->path[1] = '\0';
664 tws->next = n;
665 tws->path[0] = path[0];
666 tws->path[1] = path[1];
667}
668
669static int tree_write_stack_finish_subtree(struct tree_write_stack *tws)
670{
671 int ret;
672 struct tree_write_stack *n = tws->next;
brian m. carlson89c149f2017-05-30 10:30:38 -0700673 struct object_id s;
Johan Herland61a7cca2010-02-13 22:28:17 +0100674 if (n) {
675 ret = tree_write_stack_finish_subtree(n);
676 if (ret)
677 return ret;
Ævar Arnfjörð Bjarmasonc80d2262022-02-05 00:48:26 +0100678 ret = write_object_file(n->buf.buf, n->buf.len, OBJ_TREE, &s);
Johan Herland61a7cca2010-02-13 22:28:17 +0100679 if (ret)
680 return ret;
681 strbuf_release(&n->buf);
682 free(n);
683 tws->next = NULL;
brian m. carlson89c149f2017-05-30 10:30:38 -0700684 write_tree_entry(&tws->buf, 040000, tws->path, 2, s.hash);
Johan Herland61a7cca2010-02-13 22:28:17 +0100685 tws->path[0] = tws->path[1] = '\0';
686 }
687 return 0;
688}
689
690static int write_each_note_helper(struct tree_write_stack *tws,
691 const char *path, unsigned int mode,
brian m. carlson490bc832017-05-30 10:30:39 -0700692 const struct object_id *oid)
Johan Herland61a7cca2010-02-13 22:28:17 +0100693{
694 size_t path_len = strlen(path);
695 unsigned int n = 0;
696 int ret;
697
698 /* Determine common part of tree write stack */
699 while (tws && 3 * n < path_len &&
700 matches_tree_write_stack(tws, path + 3 * n)) {
701 n++;
702 tws = tws->next;
703 }
704
705 /* tws point to last matching tree_write_stack entry */
706 ret = tree_write_stack_finish_subtree(tws);
707 if (ret)
708 return ret;
709
710 /* Start subtrees needed to satisfy path */
711 while (3 * n + 2 < path_len && path[3 * n + 2] == '/') {
712 tree_write_stack_init_subtree(tws, path + 3 * n);
713 n++;
714 tws = tws->next;
715 }
716
717 /* There should be no more directory components in the given path */
718 assert(memchr(path + 3 * n, '/', path_len - (3 * n)) == NULL);
719
720 /* Finally add given entry to the current tree object */
721 write_tree_entry(&tws->buf, mode, path + 3 * n, path_len - (3 * n),
brian m. carlson490bc832017-05-30 10:30:39 -0700722 oid->hash);
Johan Herland61a7cca2010-02-13 22:28:17 +0100723
724 return 0;
725}
726
727struct write_each_note_data {
728 struct tree_write_stack *root;
Johan Herlanddbc27472020-02-03 22:04:45 +0100729 struct non_note **nn_list;
730 struct non_note *nn_prev;
Johan Herland61a7cca2010-02-13 22:28:17 +0100731};
732
Johan Herland851c2b32010-02-13 22:28:23 +0100733static int write_each_non_note_until(const char *note_path,
734 struct write_each_note_data *d)
735{
Johan Herlanddbc27472020-02-03 22:04:45 +0100736 struct non_note *p = d->nn_prev;
737 struct non_note *n = p ? p->next : *d->nn_list;
Ramsay Jones89fe1212010-06-21 19:52:29 +0100738 int cmp = 0, ret;
Johan Herland851c2b32010-02-13 22:28:23 +0100739 while (n && (!note_path || (cmp = strcmp(n->path, note_path)) <= 0)) {
740 if (note_path && cmp == 0)
741 ; /* do nothing, prefer note to non-note */
742 else {
743 ret = write_each_note_helper(d->root, n->path, n->mode,
brian m. carlson490bc832017-05-30 10:30:39 -0700744 &n->oid);
Johan Herland851c2b32010-02-13 22:28:23 +0100745 if (ret)
746 return ret;
747 }
Johan Herlanddbc27472020-02-03 22:04:45 +0100748 p = n;
Johan Herland851c2b32010-02-13 22:28:23 +0100749 n = n->next;
750 }
Johan Herlanddbc27472020-02-03 22:04:45 +0100751 d->nn_prev = p;
Johan Herland851c2b32010-02-13 22:28:23 +0100752 return 0;
753}
754
brian m. carlson490bc832017-05-30 10:30:39 -0700755static int write_each_note(const struct object_id *object_oid,
756 const struct object_id *note_oid, char *note_path,
Johan Herland61a7cca2010-02-13 22:28:17 +0100757 void *cb_data)
758{
759 struct write_each_note_data *d =
760 (struct write_each_note_data *) cb_data;
761 size_t note_path_len = strlen(note_path);
762 unsigned int mode = 0100644;
763
764 if (note_path[note_path_len - 1] == '/') {
765 /* subtree entry */
766 note_path_len--;
767 note_path[note_path_len] = '\0';
768 mode = 040000;
769 }
brian m. carlsondd437452019-02-19 00:05:01 +0000770 assert(note_path_len <= GIT_MAX_HEXSZ + FANOUT_PATH_SEPARATORS);
Johan Herland61a7cca2010-02-13 22:28:17 +0100771
Johan Herland851c2b32010-02-13 22:28:23 +0100772 /* Weave non-note entries into note entries */
773 return write_each_non_note_until(note_path, d) ||
brian m. carlson490bc832017-05-30 10:30:39 -0700774 write_each_note_helper(d->root, note_path, mode, note_oid);
Johan Herland61a7cca2010-02-13 22:28:17 +0100775}
776
Johan Herland00fbe632010-02-13 22:28:27 +0100777struct note_delete_list {
778 struct note_delete_list *next;
779 const unsigned char *sha1;
780};
781
brian m. carlson490bc832017-05-30 10:30:39 -0700782static int prune_notes_helper(const struct object_id *object_oid,
783 const struct object_id *note_oid, char *note_path,
Johan Herland00fbe632010-02-13 22:28:27 +0100784 void *cb_data)
785{
786 struct note_delete_list **l = (struct note_delete_list **) cb_data;
787 struct note_delete_list *n;
788
brian m. carlson490bc832017-05-30 10:30:39 -0700789 if (has_object_file(object_oid))
Johan Herland00fbe632010-02-13 22:28:27 +0100790 return 0; /* nothing to do for this note */
791
792 /* failed to find object => prune this note */
793 n = (struct note_delete_list *) xmalloc(sizeof(*n));
794 n->next = *l;
brian m. carlson490bc832017-05-30 10:30:39 -0700795 n->sha1 = object_oid->hash;
Johan Herland00fbe632010-02-13 22:28:27 +0100796 *l = n;
797 return 0;
798}
799
Patryk Obarab7d591d2018-01-28 01:13:17 +0100800int combine_notes_concatenate(struct object_id *cur_oid,
801 const struct object_id *new_oid)
Johan Herland73f464b2010-02-13 22:28:19 +0100802{
803 char *cur_msg = NULL, *new_msg = NULL, *buf;
804 unsigned long cur_len, new_len, buf_len;
805 enum object_type cur_type, new_type;
806 int ret;
807
808 /* read in both note blob objects */
Patryk Obarab7d591d2018-01-28 01:13:17 +0100809 if (!is_null_oid(new_oid))
brian m. carlsonb4f5aca2018-03-12 02:27:53 +0000810 new_msg = read_object_file(new_oid, &new_type, &new_len);
Johan Herland73f464b2010-02-13 22:28:19 +0100811 if (!new_msg || !new_len || new_type != OBJ_BLOB) {
812 free(new_msg);
813 return 0;
814 }
Patryk Obarab7d591d2018-01-28 01:13:17 +0100815 if (!is_null_oid(cur_oid))
brian m. carlsonb4f5aca2018-03-12 02:27:53 +0000816 cur_msg = read_object_file(cur_oid, &cur_type, &cur_len);
Johan Herland73f464b2010-02-13 22:28:19 +0100817 if (!cur_msg || !cur_len || cur_type != OBJ_BLOB) {
818 free(cur_msg);
819 free(new_msg);
Patryk Obarab7d591d2018-01-28 01:13:17 +0100820 oidcpy(cur_oid, new_oid);
Johan Herland73f464b2010-02-13 22:28:19 +0100821 return 0;
822 }
823
Johan Herlandd4990c42010-11-09 22:49:44 +0100824 /* we will separate the notes by two newlines anyway */
Johan Herland73f464b2010-02-13 22:28:19 +0100825 if (cur_msg[cur_len - 1] == '\n')
826 cur_len--;
827
828 /* concatenate cur_msg and new_msg into buf */
Johan Herlandd4990c42010-11-09 22:49:44 +0100829 buf_len = cur_len + 2 + new_len;
Johan Herland73f464b2010-02-13 22:28:19 +0100830 buf = (char *) xmalloc(buf_len);
831 memcpy(buf, cur_msg, cur_len);
832 buf[cur_len] = '\n';
Johan Herlandd4990c42010-11-09 22:49:44 +0100833 buf[cur_len + 1] = '\n';
834 memcpy(buf + cur_len + 2, new_msg, new_len);
Johan Herland73f464b2010-02-13 22:28:19 +0100835 free(cur_msg);
836 free(new_msg);
837
838 /* create a new blob object from buf */
Ævar Arnfjörð Bjarmasonc80d2262022-02-05 00:48:26 +0100839 ret = write_object_file(buf, buf_len, OBJ_BLOB, cur_oid);
Johan Herland73f464b2010-02-13 22:28:19 +0100840 free(buf);
841 return ret;
842}
843
Patryk Obarab7d591d2018-01-28 01:13:17 +0100844int combine_notes_overwrite(struct object_id *cur_oid,
845 const struct object_id *new_oid)
Johan Herland73f464b2010-02-13 22:28:19 +0100846{
Patryk Obarab7d591d2018-01-28 01:13:17 +0100847 oidcpy(cur_oid, new_oid);
Johan Herland73f464b2010-02-13 22:28:19 +0100848 return 0;
849}
850
Patryk Obarab7d591d2018-01-28 01:13:17 +0100851int combine_notes_ignore(struct object_id *cur_oid,
852 const struct object_id *new_oid)
Johan Herland73f464b2010-02-13 22:28:19 +0100853{
854 return 0;
855}
856
Michael Haggerty13135242012-11-04 08:07:08 +0100857/*
858 * Add the lines from the named object to list, with trailing
859 * newlines removed.
860 */
861static int string_list_add_note_lines(struct string_list *list,
Patryk Obarab7d591d2018-01-28 01:13:17 +0100862 const struct object_id *oid)
Johan Herlanda6a09092010-11-15 00:57:17 +0100863{
864 char *data;
865 unsigned long len;
866 enum object_type t;
Johan Herlanda6a09092010-11-15 00:57:17 +0100867
Patryk Obarab7d591d2018-01-28 01:13:17 +0100868 if (is_null_oid(oid))
Johan Herlanda6a09092010-11-15 00:57:17 +0100869 return 0;
870
871 /* read_sha1_file NUL-terminates */
brian m. carlsonb4f5aca2018-03-12 02:27:53 +0000872 data = read_object_file(oid, &t, &len);
Johan Herlanda6a09092010-11-15 00:57:17 +0100873 if (t != OBJ_BLOB || !data || !len) {
874 free(data);
875 return t != OBJ_BLOB || !data;
876 }
877
Michael Haggerty13135242012-11-04 08:07:08 +0100878 /*
879 * If the last line of the file is EOL-terminated, this will
880 * add an empty string to the list. But it will be removed
881 * later, along with any empty strings that came from empty
882 * lines within the file.
883 */
884 string_list_split(list, data, '\n', -1);
885 free(data);
Johan Herlanda6a09092010-11-15 00:57:17 +0100886 return 0;
887}
888
889static int string_list_join_lines_helper(struct string_list_item *item,
890 void *cb_data)
891{
892 struct strbuf *buf = cb_data;
893 strbuf_addstr(buf, item->string);
894 strbuf_addch(buf, '\n');
895 return 0;
896}
897
Patryk Obarab7d591d2018-01-28 01:13:17 +0100898int combine_notes_cat_sort_uniq(struct object_id *cur_oid,
899 const struct object_id *new_oid)
Johan Herlanda6a09092010-11-15 00:57:17 +0100900{
Michael Haggertyf992f0c2012-11-04 08:07:07 +0100901 struct string_list sort_uniq_list = STRING_LIST_INIT_DUP;
Johan Herlanda6a09092010-11-15 00:57:17 +0100902 struct strbuf buf = STRBUF_INIT;
903 int ret = 1;
904
905 /* read both note blob objects into unique_lines */
Patryk Obarab7d591d2018-01-28 01:13:17 +0100906 if (string_list_add_note_lines(&sort_uniq_list, cur_oid))
Johan Herlanda6a09092010-11-15 00:57:17 +0100907 goto out;
Patryk Obarab7d591d2018-01-28 01:13:17 +0100908 if (string_list_add_note_lines(&sort_uniq_list, new_oid))
Johan Herlanda6a09092010-11-15 00:57:17 +0100909 goto out;
Michael Haggerty13135242012-11-04 08:07:08 +0100910 string_list_remove_empty_items(&sort_uniq_list, 0);
Michael Haggerty3383e192014-11-25 09:02:35 +0100911 string_list_sort(&sort_uniq_list);
Michael Haggerty13135242012-11-04 08:07:08 +0100912 string_list_remove_duplicates(&sort_uniq_list, 0);
Johan Herlanda6a09092010-11-15 00:57:17 +0100913
914 /* create a new blob object from sort_uniq_list */
915 if (for_each_string_list(&sort_uniq_list,
916 string_list_join_lines_helper, &buf))
917 goto out;
918
Ævar Arnfjörð Bjarmasonc80d2262022-02-05 00:48:26 +0100919 ret = write_object_file(buf.buf, buf.len, OBJ_BLOB, cur_oid);
Johan Herlanda6a09092010-11-15 00:57:17 +0100920
921out:
922 strbuf_release(&buf);
923 string_list_clear(&sort_uniq_list, 0);
924 return ret;
925}
926
Jeff King63e14ee2022-08-19 06:08:32 -0400927static int string_list_add_one_ref(const char *refname,
Ævar Arnfjörð Bjarmason5cf88fd2022-08-25 19:09:48 +0200928 const struct object_id *oid UNUSED,
929 int flag UNUSED, void *cb)
Thomas Rast894a9d32010-03-12 18:04:26 +0100930{
931 struct string_list *refs = cb;
Michael Haggertyd235e992013-05-25 11:08:20 +0200932 if (!unsorted_string_list_has_string(refs, refname))
933 string_list_append(refs, refname);
Thomas Rast894a9d32010-03-12 18:04:26 +0100934 return 0;
935}
936
Michael Haggerty8c46bf92013-05-25 11:08:21 +0200937/*
938 * The list argument must have strdup_strings set on it.
939 */
Thomas Rast894a9d32010-03-12 18:04:26 +0100940void string_list_add_refs_by_glob(struct string_list *list, const char *glob)
941{
Michael Haggerty8c46bf92013-05-25 11:08:21 +0200942 assert(list->strdup_strings);
Thomas Rast894a9d32010-03-12 18:04:26 +0100943 if (has_glob_specials(glob)) {
Michael Haggertyfd950352015-05-25 18:38:59 +0000944 for_each_glob_ref(string_list_add_one_ref, glob, list);
Thomas Rast894a9d32010-03-12 18:04:26 +0100945 } else {
brian m. carlson89c149f2017-05-30 10:30:38 -0700946 struct object_id oid;
947 if (get_oid(glob, &oid))
Thomas Rast894a9d32010-03-12 18:04:26 +0100948 warning("notes ref %s is invalid", glob);
949 if (!unsorted_string_list_has_string(list, glob))
Julian Phillips1d2f80f2010-06-26 00:41:38 +0100950 string_list_append(list, glob);
Thomas Rast894a9d32010-03-12 18:04:26 +0100951 }
952}
953
954void string_list_add_refs_from_colon_sep(struct string_list *list,
955 const char *globs)
956{
Michael Haggerty6fa23772012-11-04 08:07:10 +0100957 struct string_list split = STRING_LIST_INIT_NODUP;
958 char *globs_copy = xstrdup(globs);
Thomas Rast894a9d32010-03-12 18:04:26 +0100959 int i;
960
Michael Haggerty6fa23772012-11-04 08:07:10 +0100961 string_list_split_in_place(&split, globs_copy, ':', -1);
962 string_list_remove_empty_items(&split, 0);
Thomas Rast894a9d32010-03-12 18:04:26 +0100963
Michael Haggerty6fa23772012-11-04 08:07:10 +0100964 for (i = 0; i < split.nr; i++)
965 string_list_add_refs_by_glob(list, split.items[i].string);
Thomas Rast894a9d32010-03-12 18:04:26 +0100966
Michael Haggerty6fa23772012-11-04 08:07:10 +0100967 string_list_clear(&split, 0);
968 free(globs_copy);
Thomas Rast894a9d32010-03-12 18:04:26 +0100969}
970
Thomas Rast894a9d32010-03-12 18:04:26 +0100971static int notes_display_config(const char *k, const char *v, void *cb)
972{
973 int *load_refs = cb;
974
975 if (*load_refs && !strcmp(k, "notes.displayref")) {
976 if (!v)
Nate Aversc3eb95a2020-11-22 22:23:41 -0500977 return config_error_nonbool(k);
Thomas Rast894a9d32010-03-12 18:04:26 +0100978 string_list_add_refs_by_glob(&display_notes_refs, v);
979 }
980
981 return 0;
982}
983
Johan Herland4a9cf1c2010-11-09 22:49:39 +0100984const char *default_notes_ref(void)
Thomas Rast894a9d32010-03-12 18:04:26 +0100985{
986 const char *notes_ref = NULL;
987 if (!notes_ref)
988 notes_ref = getenv(GIT_NOTES_REF_ENVIRONMENT);
989 if (!notes_ref)
990 notes_ref = notes_ref_name; /* value of core.notesRef config */
991 if (!notes_ref)
992 notes_ref = GIT_NOTES_DEFAULT_REF;
993 return notes_ref;
994}
995
Johan Herland73f464b2010-02-13 22:28:19 +0100996void init_notes(struct notes_tree *t, const char *notes_ref,
997 combine_notes_fn combine_notes, int flags)
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +0200998{
brian m. carlson13ac1412016-09-05 20:08:05 +0000999 struct object_id oid, object_oid;
Elijah Newren5ec1e722019-04-05 08:00:12 -07001000 unsigned short mode;
Johan Herland23123ae2009-10-09 12:22:07 +02001001 struct leaf_node root_tree;
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02001002
Johan Herlandcd305392010-02-13 22:28:18 +01001003 if (!t)
1004 t = &default_notes_tree;
1005 assert(!t->initialized);
Johan Herland709f79b2010-02-13 22:28:12 +01001006
1007 if (!notes_ref)
Thomas Rast894a9d32010-03-12 18:04:26 +01001008 notes_ref = default_notes_ref();
Derrick Stoleeb9342b32022-08-05 17:58:36 +00001009 update_ref_namespace(NAMESPACE_NOTES, xstrdup(notes_ref));
Johan Herland709f79b2010-02-13 22:28:12 +01001010
Johan Herland73f464b2010-02-13 22:28:19 +01001011 if (!combine_notes)
1012 combine_notes = combine_notes_concatenate;
1013
Brian Gesiak65bbf082014-05-27 00:33:52 +09001014 t->root = (struct int_node *) xcalloc(1, sizeof(struct int_node));
Johan Herland851c2b32010-02-13 22:28:23 +01001015 t->first_non_note = NULL;
1016 t->prev_non_note = NULL;
Jeff King8c53f072015-01-12 20:59:09 -05001017 t->ref = xstrdup_or_null(notes_ref);
Mike Hommeyee76f922015-10-08 11:54:43 +09001018 t->update_ref = (flags & NOTES_INIT_WRITABLE) ? t->ref : NULL;
Johan Herland73f464b2010-02-13 22:28:19 +01001019 t->combine_notes = combine_notes;
Johan Herlandcd305392010-02-13 22:28:18 +01001020 t->initialized = 1;
Thomas Rast7f710ea2010-03-12 18:04:36 +01001021 t->dirty = 0;
Johan Herlandcd305392010-02-13 22:28:18 +01001022
Johan Herland709f79b2010-02-13 22:28:12 +01001023 if (flags & NOTES_INIT_EMPTY || !notes_ref ||
brian m. carlsone82caf32017-07-13 23:49:28 +00001024 get_oid_treeish(notes_ref, &object_oid))
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02001025 return;
brian m. carlson34c290a2017-10-15 22:06:56 +00001026 if (flags & NOTES_INIT_WRITABLE && read_ref(notes_ref, &object_oid))
Mike Hommeyee76f922015-10-08 11:54:43 +09001027 die("Cannot use notes ref %s", notes_ref);
Nguyễn Thái Ngọc Duy50ddb082019-06-27 16:28:49 +07001028 if (get_tree_entry(the_repository, &object_oid, "", &oid, &mode))
Johan Herland709f79b2010-02-13 22:28:12 +01001029 die("Failed to read notes tree referenced by %s (%s)",
brian m. carlson13ac1412016-09-05 20:08:05 +00001030 notes_ref, oid_to_hex(&object_oid));
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02001031
brian m. carlson5dcc9692017-05-30 10:30:37 -07001032 oidclr(&root_tree.key_oid);
1033 oidcpy(&root_tree.val_oid, &oid);
Johan Herland851c2b32010-02-13 22:28:23 +01001034 load_subtree(t, &root_tree, t->root, 0);
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02001035}
1036
Mike Hommeyee76f922015-10-08 11:54:43 +09001037struct notes_tree **load_notes_trees(struct string_list *refs, int flags)
Thomas Rast894a9d32010-03-12 18:04:26 +01001038{
Alex Riesen8a57c6e2010-07-03 14:41:54 +02001039 struct string_list_item *item;
1040 int counter = 0;
Thomas Rast894a9d32010-03-12 18:04:26 +01001041 struct notes_tree **trees;
Jeff Kingb32fa952016-02-22 17:44:25 -05001042 ALLOC_ARRAY(trees, refs->nr + 1);
Alex Riesen8a57c6e2010-07-03 14:41:54 +02001043 for_each_string_list_item(item, refs) {
1044 struct notes_tree *t = xcalloc(1, sizeof(struct notes_tree));
Mike Hommeyee76f922015-10-08 11:54:43 +09001045 init_notes(t, item->string, combine_notes_ignore, flags);
Alex Riesen8a57c6e2010-07-03 14:41:54 +02001046 trees[counter++] = t;
1047 }
1048 trees[counter] = NULL;
Thomas Rast894a9d32010-03-12 18:04:26 +01001049 return trees;
1050}
1051
1052void init_display_notes(struct display_notes_opt *opt)
1053{
Denton Liue6e230e2019-12-09 05:10:41 -08001054 memset(opt, 0, sizeof(*opt));
1055 opt->use_default_notes = -1;
1056}
1057
Denton Liu1d729752019-12-11 16:49:50 -08001058void enable_default_display_notes(struct display_notes_opt *opt, int *show_notes)
Denton Liu452538c2019-12-09 05:10:44 -08001059{
Denton Liu1d729752019-12-11 16:49:50 -08001060 opt->use_default_notes = 1;
1061 *show_notes = 1;
1062}
Denton Liu452538c2019-12-09 05:10:44 -08001063
Denton Liu1d729752019-12-11 16:49:50 -08001064void enable_ref_display_notes(struct display_notes_opt *opt, int *show_notes,
1065 const char *ref) {
1066 struct strbuf buf = STRBUF_INIT;
1067 strbuf_addstr(&buf, ref);
1068 expand_notes_ref(&buf);
1069 string_list_append(&opt->extra_notes_refs,
1070 strbuf_detach(&buf, NULL));
1071 *show_notes = 1;
1072}
1073
1074void disable_display_notes(struct display_notes_opt *opt, int *show_notes)
1075{
1076 opt->use_default_notes = -1;
1077 /* we have been strdup'ing ourselves, so trick
1078 * string_list into free()ing strings */
1079 opt->extra_notes_refs.strdup_strings = 1;
1080 string_list_clear(&opt->extra_notes_refs, 0);
1081 opt->extra_notes_refs.strdup_strings = 0;
1082 *show_notes = 0;
Denton Liu452538c2019-12-09 05:10:44 -08001083}
1084
Denton Liu1e6ed542019-12-09 05:10:39 -08001085void load_display_notes(struct display_notes_opt *opt)
Thomas Rast894a9d32010-03-12 18:04:26 +01001086{
1087 char *display_ref_env;
1088 int load_config_refs = 0;
1089 display_notes_refs.strdup_strings = 1;
1090
1091 assert(!display_notes_trees);
1092
Jeff King3a03cf62011-03-29 16:57:27 -04001093 if (!opt || opt->use_default_notes > 0 ||
1094 (opt->use_default_notes == -1 && !opt->extra_notes_refs.nr)) {
Julian Phillips1d2f80f2010-06-26 00:41:38 +01001095 string_list_append(&display_notes_refs, default_notes_ref());
Thomas Rast894a9d32010-03-12 18:04:26 +01001096 display_ref_env = getenv(GIT_NOTES_DISPLAY_REF_ENVIRONMENT);
1097 if (display_ref_env) {
1098 string_list_add_refs_from_colon_sep(&display_notes_refs,
1099 display_ref_env);
1100 load_config_refs = 0;
1101 } else
1102 load_config_refs = 1;
1103 }
1104
1105 git_config(notes_display_config, &load_config_refs);
1106
Jeff King304cc112011-03-29 16:56:53 -04001107 if (opt) {
Alex Riesen8a57c6e2010-07-03 14:41:54 +02001108 struct string_list_item *item;
Jeff King304cc112011-03-29 16:56:53 -04001109 for_each_string_list_item(item, &opt->extra_notes_refs)
Alex Riesen8a57c6e2010-07-03 14:41:54 +02001110 string_list_add_refs_by_glob(&display_notes_refs,
1111 item->string);
1112 }
Thomas Rast894a9d32010-03-12 18:04:26 +01001113
Mike Hommeyee76f922015-10-08 11:54:43 +09001114 display_notes_trees = load_notes_trees(&display_notes_refs, 0);
Thomas Rast894a9d32010-03-12 18:04:26 +01001115 string_list_clear(&display_notes_refs, 0);
1116}
1117
brian m. carlson5ee8a952017-05-30 10:30:43 -07001118int add_note(struct notes_tree *t, const struct object_id *object_oid,
1119 const struct object_id *note_oid, combine_notes_fn combine_notes)
Johan Herland2626b532010-02-13 22:28:13 +01001120{
1121 struct leaf_node *l;
1122
Johan Herlandcd305392010-02-13 22:28:18 +01001123 if (!t)
1124 t = &default_notes_tree;
1125 assert(t->initialized);
Thomas Rast7f710ea2010-03-12 18:04:36 +01001126 t->dirty = 1;
Johan Herland73f464b2010-02-13 22:28:19 +01001127 if (!combine_notes)
1128 combine_notes = t->combine_notes;
Johan Herland2626b532010-02-13 22:28:13 +01001129 l = (struct leaf_node *) xmalloc(sizeof(struct leaf_node));
brian m. carlson5ee8a952017-05-30 10:30:43 -07001130 oidcpy(&l->key_oid, object_oid);
1131 oidcpy(&l->val_oid, note_oid);
Johan Herland180619a2010-11-15 00:52:26 +01001132 return note_tree_insert(t, t->root, 0, l, PTR_TYPE_NOTE, combine_notes);
Johan Herland2626b532010-02-13 22:28:13 +01001133}
1134
Johan Herland1ee1e432010-08-31 17:56:50 +02001135int remove_note(struct notes_tree *t, const unsigned char *object_sha1)
Johan Herland1ec666b2010-02-13 22:28:14 +01001136{
1137 struct leaf_node l;
1138
Johan Herlandcd305392010-02-13 22:28:18 +01001139 if (!t)
1140 t = &default_notes_tree;
1141 assert(t->initialized);
brian m. carlson92e2cab2021-04-26 01:02:50 +00001142 oidread(&l.key_oid, object_sha1);
brian m. carlson5dcc9692017-05-30 10:30:37 -07001143 oidclr(&l.val_oid);
Brandon Caseya502ab92010-03-18 10:03:43 -05001144 note_tree_remove(t, t->root, 0, &l);
brian m. carlson5dcc9692017-05-30 10:30:37 -07001145 if (is_null_oid(&l.val_oid)) /* no note was removed */
Johan Herland1ee1e432010-08-31 17:56:50 +02001146 return 1;
1147 t->dirty = 1;
1148 return 0;
Johan Herland1ec666b2010-02-13 22:28:14 +01001149}
1150
brian m. carlson9ef72232017-05-30 10:30:40 -07001151const struct object_id *get_note(struct notes_tree *t,
brian m. carlson5ee8a952017-05-30 10:30:43 -07001152 const struct object_id *oid)
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02001153{
Johan Herland9b391f22010-02-13 22:28:15 +01001154 struct leaf_node *found;
1155
Johan Herlandcd305392010-02-13 22:28:18 +01001156 if (!t)
1157 t = &default_notes_tree;
1158 assert(t->initialized);
brian m. carlson5ee8a952017-05-30 10:30:43 -07001159 found = note_tree_find(t, t->root, 0, oid->hash);
brian m. carlson9ef72232017-05-30 10:30:40 -07001160 return found ? &found->val_oid : NULL;
Johannes Schindelinfd53c9e2009-10-09 12:21:59 +02001161}
Johannes Schindelina97a7462009-10-09 12:21:57 +02001162
Johan Herlandcd305392010-02-13 22:28:18 +01001163int for_each_note(struct notes_tree *t, int flags, each_note_fn fn,
1164 void *cb_data)
Johan Herland73f77b92010-02-13 22:28:16 +01001165{
Johan Herlandcd305392010-02-13 22:28:18 +01001166 if (!t)
1167 t = &default_notes_tree;
1168 assert(t->initialized);
Johan Herland851c2b32010-02-13 22:28:23 +01001169 return for_each_note_helper(t, t->root, 0, 0, flags, fn, cb_data);
Johan Herland73f77b92010-02-13 22:28:16 +01001170}
1171
Patryk Obarabbca96d2018-01-28 01:13:18 +01001172int write_notes_tree(struct notes_tree *t, struct object_id *result)
Johan Herland61a7cca2010-02-13 22:28:17 +01001173{
1174 struct tree_write_stack root;
1175 struct write_each_note_data cb_data;
1176 int ret;
Patryk Obarabbca96d2018-01-28 01:13:18 +01001177 int flags;
Johan Herland61a7cca2010-02-13 22:28:17 +01001178
Johan Herlandcd305392010-02-13 22:28:18 +01001179 if (!t)
1180 t = &default_notes_tree;
1181 assert(t->initialized);
Johan Herland61a7cca2010-02-13 22:28:17 +01001182
1183 /* Prepare for traversal of current notes tree */
1184 root.next = NULL; /* last forward entry in list is grounded */
brian m. carlsondd437452019-02-19 00:05:01 +00001185 strbuf_init(&root.buf, 256 * (32 + the_hash_algo->hexsz)); /* assume 256 entries */
Johan Herland61a7cca2010-02-13 22:28:17 +01001186 root.path[0] = root.path[1] = '\0';
1187 cb_data.root = &root;
Johan Herlanddbc27472020-02-03 22:04:45 +01001188 cb_data.nn_list = &(t->first_non_note);
1189 cb_data.nn_prev = NULL;
Johan Herland61a7cca2010-02-13 22:28:17 +01001190
1191 /* Write tree objects representing current notes tree */
Patryk Obarabbca96d2018-01-28 01:13:18 +01001192 flags = FOR_EACH_NOTE_DONT_UNPACK_SUBTREES |
1193 FOR_EACH_NOTE_YIELD_SUBTREES;
1194 ret = for_each_note(t, flags, write_each_note, &cb_data) ||
1195 write_each_non_note_until(NULL, &cb_data) ||
1196 tree_write_stack_finish_subtree(&root) ||
Ævar Arnfjörð Bjarmasonc80d2262022-02-05 00:48:26 +01001197 write_object_file(root.buf.buf, root.buf.len, OBJ_TREE, result);
Johan Herland61a7cca2010-02-13 22:28:17 +01001198 strbuf_release(&root.buf);
1199 return ret;
1200}
1201
Michael J Grubera9f2adf2010-05-14 23:42:07 +02001202void prune_notes(struct notes_tree *t, int flags)
Johan Herland00fbe632010-02-13 22:28:27 +01001203{
1204 struct note_delete_list *l = NULL;
1205
1206 if (!t)
1207 t = &default_notes_tree;
1208 assert(t->initialized);
1209
1210 for_each_note(t, 0, prune_notes_helper, &l);
1211
1212 while (l) {
Michael J Grubera9f2adf2010-05-14 23:42:07 +02001213 if (flags & NOTES_PRUNE_VERBOSE)
brian m. carlson0dbc6462019-02-19 00:05:02 +00001214 printf("%s\n", hash_to_hex(l->sha1));
Michael J Grubera9f2adf2010-05-14 23:42:07 +02001215 if (!(flags & NOTES_PRUNE_DRYRUN))
1216 remove_note(t, l->sha1);
Johan Herland00fbe632010-02-13 22:28:27 +01001217 l = l->next;
1218 }
1219}
1220
Johan Herlandcd305392010-02-13 22:28:18 +01001221void free_notes(struct notes_tree *t)
Johan Herland27d57562009-10-09 12:22:06 +02001222{
Johan Herlandcd305392010-02-13 22:28:18 +01001223 if (!t)
1224 t = &default_notes_tree;
1225 if (t->root)
1226 note_tree_free(t->root);
1227 free(t->root);
Johan Herland851c2b32010-02-13 22:28:23 +01001228 while (t->first_non_note) {
1229 t->prev_non_note = t->first_non_note->next;
1230 free(t->first_non_note->path);
1231 free(t->first_non_note);
1232 t->first_non_note = t->prev_non_note;
1233 }
Johan Herlandcd305392010-02-13 22:28:18 +01001234 free(t->ref);
1235 memset(t, 0, sizeof(struct notes_tree));
Johan Herland27d57562009-10-09 12:22:06 +02001236}
1237
Junio C Hamano96531a52012-09-15 14:08:39 -07001238/*
1239 * Fill the given strbuf with the notes associated with the given object.
1240 *
1241 * If the given notes_tree structure is not initialized, it will be auto-
1242 * initialized to the default value (see documentation for init_notes() above).
1243 * If the given notes_tree is NULL, the internal/default notes_tree will be
1244 * used instead.
1245 *
Junio C Hamano76141e22012-10-17 21:41:54 -07001246 * (raw != 0) gives the %N userformat; otherwise, the note message is given
1247 * for human consumption.
Junio C Hamano96531a52012-09-15 14:08:39 -07001248 */
brian m. carlsonfb61e4d2017-05-30 10:30:41 -07001249static void format_note(struct notes_tree *t, const struct object_id *object_oid,
Junio C Hamano76141e22012-10-17 21:41:54 -07001250 struct strbuf *sb, const char *output_encoding, int raw)
Johannes Schindelina97a7462009-10-09 12:21:57 +02001251{
1252 static const char utf8[] = "utf-8";
brian m. carlson9ef72232017-05-30 10:30:40 -07001253 const struct object_id *oid;
Johannes Schindelina97a7462009-10-09 12:21:57 +02001254 char *msg, *msg_p;
1255 unsigned long linelen, msglen;
1256 enum object_type type;
1257
Johan Herlandcd305392010-02-13 22:28:18 +01001258 if (!t)
1259 t = &default_notes_tree;
1260 if (!t->initialized)
Johan Herland73f464b2010-02-13 22:28:19 +01001261 init_notes(t, NULL, NULL, 0);
Johannes Schindelina97a7462009-10-09 12:21:57 +02001262
brian m. carlson5ee8a952017-05-30 10:30:43 -07001263 oid = get_note(t, object_oid);
brian m. carlson9ef72232017-05-30 10:30:40 -07001264 if (!oid)
Johannes Schindelina97a7462009-10-09 12:21:57 +02001265 return;
1266
brian m. carlsonb4f5aca2018-03-12 02:27:53 +00001267 if (!(msg = read_object_file(oid, &type, &msglen)) || type != OBJ_BLOB) {
Johannes Schindelina97a7462009-10-09 12:21:57 +02001268 free(msg);
1269 return;
1270 }
1271
1272 if (output_encoding && *output_encoding &&
Junio C Hamano0e18bcd2012-10-18 22:41:56 -07001273 !is_encoding_utf8(output_encoding)) {
Johannes Schindelina97a7462009-10-09 12:21:57 +02001274 char *reencoded = reencode_string(msg, output_encoding, utf8);
1275 if (reencoded) {
1276 free(msg);
1277 msg = reencoded;
1278 msglen = strlen(msg);
1279 }
1280 }
1281
1282 /* we will end the annotation by a newline anyway */
1283 if (msglen && msg[msglen - 1] == '\n')
1284 msglen--;
1285
Junio C Hamano76141e22012-10-17 21:41:54 -07001286 if (!raw) {
Thomas Rast894a9d32010-03-12 18:04:26 +01001287 const char *ref = t->ref;
1288 if (!ref || !strcmp(ref, GIT_NOTES_DEFAULT_REF)) {
1289 strbuf_addstr(sb, "\nNotes:\n");
1290 } else {
Junio C Hamano145136a2020-01-30 11:35:46 -08001291 skip_prefix(ref, "refs/", &ref);
1292 skip_prefix(ref, "notes/", &ref);
Thomas Rast894a9d32010-03-12 18:04:26 +01001293 strbuf_addf(sb, "\nNotes (%s):\n", ref);
1294 }
1295 }
Johannes Schindelina97a7462009-10-09 12:21:57 +02001296
1297 for (msg_p = msg; msg_p < msg + msglen; msg_p += linelen + 1) {
1298 linelen = strchrnul(msg_p, '\n') - msg_p;
1299
Junio C Hamano76141e22012-10-17 21:41:54 -07001300 if (!raw)
Johan Herlandc56fcc82009-10-09 12:22:04 +02001301 strbuf_addstr(sb, " ");
Johannes Schindelina97a7462009-10-09 12:21:57 +02001302 strbuf_add(sb, msg_p, linelen);
1303 strbuf_addch(sb, '\n');
1304 }
1305
1306 free(msg);
1307}
Thomas Rast894a9d32010-03-12 18:04:26 +01001308
brian m. carlsonfb61e4d2017-05-30 10:30:41 -07001309void format_display_notes(const struct object_id *object_oid,
Junio C Hamano76141e22012-10-17 21:41:54 -07001310 struct strbuf *sb, const char *output_encoding, int raw)
Thomas Rast894a9d32010-03-12 18:04:26 +01001311{
1312 int i;
1313 assert(display_notes_trees);
1314 for (i = 0; display_notes_trees[i]; i++)
brian m. carlsonfb61e4d2017-05-30 10:30:41 -07001315 format_note(display_notes_trees[i], object_oid, sb,
Junio C Hamano76141e22012-10-17 21:41:54 -07001316 output_encoding, raw);
Thomas Rast894a9d32010-03-12 18:04:26 +01001317}
Thomas Rast160baa02010-03-12 18:04:31 +01001318
1319int copy_note(struct notes_tree *t,
brian m. carlson5ee8a952017-05-30 10:30:43 -07001320 const struct object_id *from_obj, const struct object_id *to_obj,
Johan Herland180619a2010-11-15 00:52:26 +01001321 int force, combine_notes_fn combine_notes)
Thomas Rast160baa02010-03-12 18:04:31 +01001322{
brian m. carlson9ef72232017-05-30 10:30:40 -07001323 const struct object_id *note = get_note(t, from_obj);
1324 const struct object_id *existing_note = get_note(t, to_obj);
Thomas Rast160baa02010-03-12 18:04:31 +01001325
1326 if (!force && existing_note)
1327 return 1;
1328
1329 if (note)
brian m. carlson5ee8a952017-05-30 10:30:43 -07001330 return add_note(t, to_obj, note, combine_notes);
Thomas Rast160baa02010-03-12 18:04:31 +01001331 else if (existing_note)
brian m. carlson14228442021-04-26 01:02:56 +00001332 return add_note(t, to_obj, null_oid(), combine_notes);
Thomas Rast160baa02010-03-12 18:04:31 +01001333
1334 return 0;
1335}
Jeff King03bb5782011-03-29 16:55:32 -04001336
1337void expand_notes_ref(struct strbuf *sb)
1338{
Christian Couder59556542013-11-30 21:55:40 +01001339 if (starts_with(sb->buf, "refs/notes/"))
Jeff King03bb5782011-03-29 16:55:32 -04001340 return; /* we're happy */
Christian Couder59556542013-11-30 21:55:40 +01001341 else if (starts_with(sb->buf, "notes/"))
René Scharfea91cc7f2020-02-09 14:44:23 +01001342 strbuf_insertstr(sb, 0, "refs/");
Jeff King03bb5782011-03-29 16:55:32 -04001343 else
René Scharfea91cc7f2020-02-09 14:44:23 +01001344 strbuf_insertstr(sb, 0, "refs/notes/");
Jeff King03bb5782011-03-29 16:55:32 -04001345}
Jacob Kellerb3715b72015-12-29 14:40:28 -08001346
1347void expand_loose_notes_ref(struct strbuf *sb)
1348{
brian m. carlson89c149f2017-05-30 10:30:38 -07001349 struct object_id object;
Jacob Kellerb3715b72015-12-29 14:40:28 -08001350
brian m. carlson89c149f2017-05-30 10:30:38 -07001351 if (get_oid(sb->buf, &object)) {
Jacob Kellerb3715b72015-12-29 14:40:28 -08001352 /* fallback to expand_notes_ref */
1353 expand_notes_ref(sb);
1354 }
1355}