hashmap: add API to disable item counting when threaded
[git/git.git] / builtin / describe.c
CommitLineData
908e5310 1#include "cache.h"
b2141fc1 2#include "config.h"
697cc8ef 3#include "lockfile.h"
908e5310 4#include "commit.h"
635d4134 5#include "tag.h"
908e5310 6#include "refs.h"
9a0eaf83 7#include "builtin.h"
23615708 8#include "exec_cmd.h"
166185be 9#include "parse-options.h"
9f67d2e8 10#include "diff.h"
29d8a834 11#include "hashmap.h"
45bc950b 12#include "argv-array.h"
b0176ce6 13#include "run-command.h"
908e5310 14
c4472643 15#define SEEN (1u << 0)
8713ab30
SP
16#define MAX_TAGS (FLAG_BITS - 1)
17
166185be 18static const char * const describe_usage[] = {
9c9b4f2f
AH
19 N_("git describe [<options>] [<commit-ish>...]"),
20 N_("git describe [<options>] --dirty"),
166185be
PH
21 NULL
22};
908e5310 23
8713ab30 24static int debug; /* Display lots of verbose info */
7e425c4f
SP
25static int all; /* Any valid ref can be used */
26static int tags; /* Allow lightweight tags */
518120e3 27static int longformat;
e00dd1e9 28static int first_parent;
dce96489 29static int abbrev = -1; /* unspecified */
8713ab30 30static int max_candidates = 10;
29d8a834 31static struct hashmap names;
d1645d02 32static int have_util;
43f8080e 33static struct string_list patterns = STRING_LIST_INIT_NODUP;
77d21f29 34static struct string_list exclude_patterns = STRING_LIST_INIT_NODUP;
da2478db 35static int always;
b0176ce6 36static const char *suffix, *dirty, *broken;
9f67d2e8
JP
37
38/* diff-index command arguments to check if working tree is dirty. */
39static const char *diff_index_args[] = {
40 "diff-index", "--quiet", "HEAD", "--", NULL
41};
42
e7eb5034 43struct commit_name {
29d8a834 44 struct hashmap_entry entry;
6439b5d9 45 struct object_id peeled;
212945d4 46 struct tag *tag;
03e8b541
SP
47 unsigned prio:2; /* annotated tag = 2, tag = 1, head = 0 */
48 unsigned name_checked:1;
6439b5d9 49 struct object_id oid;
219a0f33 50 char *path;
e7eb5034 51};
c4472643 52
cf69fd49 53static const char *prio_names[] = {
646c3bd1 54 N_("head"), N_("lightweight"), N_("annotated"),
cf69fd49 55};
908e5310 56
7663cdc8 57static int commit_name_cmp(const void *unused_cmp_data,
0068cede
SB
58 const void *entry,
59 const void *entry_or_key,
7663cdc8 60 const void *peeled)
29d8a834 61{
0068cede
SB
62 const struct commit_name *cn1 = entry;
63 const struct commit_name *cn2 = entry_or_key;
64
6439b5d9 65 return oidcmp(&cn1->peeled, peeled ? peeled : &cn2->peeled);
29d8a834
KB
66}
67
6439b5d9 68static inline struct commit_name *find_commit_name(const struct object_id *peeled)
3cfa4db3 69{
6439b5d9 70 return hashmap_get_from_hash(&names, sha1hash(peeled->hash), peeled->hash);
d1645d02
AK
71}
72
03e8b541
SP
73static int replace_name(struct commit_name *e,
74 int prio,
6439b5d9 75 const struct object_id *oid,
03e8b541
SP
76 struct tag **tag)
77{
78 if (!e || e->prio < prio)
79 return 1;
80
81 if (e->prio == 2 && prio == 2) {
82 /* Multiple annotated tags point to the same commit.
83 * Select one to keep based upon their tagger date.
84 */
85 struct tag *t;
86
87 if (!e->tag) {
d3101b53 88 t = lookup_tag(&e->oid);
03e8b541
SP
89 if (!t || parse_tag(t))
90 return 1;
91 e->tag = t;
92 }
93
d3101b53 94 t = lookup_tag(oid);
03e8b541
SP
95 if (!t || parse_tag(t))
96 return 0;
97 *tag = t;
98
99 if (e->tag->date < t->date)
100 return 1;
101 }
102
103 return 0;
104}
105
64deb858 106static void add_to_known_names(const char *path,
6439b5d9 107 const struct object_id *peeled,
212945d4 108 int prio,
6439b5d9 109 const struct object_id *oid)
908e5310 110{
3cfa4db3 111 struct commit_name *e = find_commit_name(peeled);
03e8b541 112 struct tag *tag = NULL;
6439b5d9 113 if (replace_name(e, prio, oid, &tag)) {
1e1ade18
AK
114 if (!e) {
115 e = xmalloc(sizeof(struct commit_name));
6439b5d9 116 oidcpy(&e->peeled, peeled);
117 hashmap_entry_init(e, sha1hash(peeled->hash));
29d8a834 118 hashmap_add(&names, e);
219a0f33 119 e->path = NULL;
1e1ade18 120 }
03e8b541 121 e->tag = tag;
e7eb5034 122 e->prio = prio;
03e8b541 123 e->name_checked = 0;
6439b5d9 124 oidcpy(&e->oid, oid);
219a0f33
MH
125 free(e->path);
126 e->path = xstrdup(path);
908e5310 127 }
908e5310
LT
128}
129
99a2cfbf 130static int get_name(const char *path, const struct object_id *oid, int flag, void *cb_data)
908e5310 131{
59556548 132 int is_tag = starts_with(path, "refs/tags/");
99a2cfbf 133 struct object_id peeled;
46e1d6eb 134 int is_annotated, prio;
feededd0 135
46e1d6eb
JH
136 /* Reject anything outside refs/tags/ unless --all */
137 if (!all && !is_tag)
8a5a1884
SP
138 return 0;
139
77d21f29
JK
140 /*
141 * If we're given exclude patterns, first exclude any tag which match
142 * any of the exclude pattern.
143 */
144 if (exclude_patterns.nr) {
145 struct string_list_item *item;
146
147 if (!is_tag)
148 return 0;
149
150 for_each_string_list_item(item, &exclude_patterns) {
55d34269 151 if (!wildmatch(item->string, path + 10, 0))
77d21f29
JK
152 return 0;
153 }
154 }
155
43f8080e
JK
156 /*
157 * If we're given patterns, accept only tags which match at least one
158 * pattern.
159 */
160 if (patterns.nr) {
161 struct string_list_item *item;
162
163 if (!is_tag)
164 return 0;
165
166 for_each_string_list_item(item, &patterns) {
55d34269 167 if (!wildmatch(item->string, path + 10, 0))
43f8080e
JK
168 break;
169
170 /* If we get here, no pattern matched. */
171 return 0;
172 }
173 }
46e1d6eb
JH
174
175 /* Is it annotated? */
99a2cfbf
MH
176 if (!peel_ref(path, peeled.hash)) {
177 is_annotated = !!oidcmp(oid, &peeled);
feededd0 178 } else {
99a2cfbf 179 oidcpy(&peeled, oid);
46e1d6eb 180 is_annotated = 0;
feededd0 181 }
64deb858 182
46e1d6eb
JH
183 /*
184 * By default, we only use annotated tags, but with --tags
185 * we fall back to lightweight ones (even without --tags,
186 * we still remember lightweight ones, only to give hints
187 * in an error message). --all allows any refs to be used.
2d9e7c9f 188 */
46e1d6eb
JH
189 if (is_annotated)
190 prio = 2;
191 else if (is_tag)
192 prio = 1;
64deb858
JH
193 else
194 prio = 0;
195
6439b5d9 196 add_to_known_names(all ? path + 5 : path + 10, &peeled, prio, oid);
908e5310
LT
197 return 0;
198}
199
80dbae03 200struct possible_tag {
80dbae03 201 struct commit_name *name;
cf69fd49
SP
202 int depth;
203 int found_order;
8713ab30 204 unsigned flag_within;
80dbae03
SP
205};
206
cf69fd49
SP
207static int compare_pt(const void *a_, const void *b_)
208{
209 struct possible_tag *a = (struct possible_tag *)a_;
210 struct possible_tag *b = (struct possible_tag *)b_;
cf69fd49
SP
211 if (a->depth != b->depth)
212 return a->depth - b->depth;
213 if (a->found_order != b->found_order)
214 return a->found_order - b->found_order;
215 return 0;
216}
217
1b600e65
SP
218static unsigned long finish_depth_computation(
219 struct commit_list **list,
220 struct possible_tag *best)
221{
222 unsigned long seen_commits = 0;
223 while (*list) {
224 struct commit *c = pop_commit(list);
225 struct commit_list *parents = c->parents;
226 seen_commits++;
227 if (c->object.flags & best->flag_within) {
228 struct commit_list *a = *list;
229 while (a) {
230 struct commit *i = a->item;
231 if (!(i->object.flags & best->flag_within))
232 break;
233 a = a->next;
234 }
235 if (!a)
236 break;
237 } else
238 best->depth++;
239 while (parents) {
240 struct commit *p = parents->item;
241 parse_commit(p);
242 if (!(p->object.flags & SEEN))
47e44ed1 243 commit_list_insert_by_date(p, list);
1b600e65
SP
244 p->object.flags |= c->object.flags;
245 parents = parents->next;
246 }
247 }
248 return seen_commits;
249}
250
212945d4
SP
251static void display_name(struct commit_name *n)
252{
253 if (n->prio == 2 && !n->tag) {
d3101b53 254 n->tag = lookup_tag(&n->oid);
03e8b541 255 if (!n->tag || parse_tag(n->tag))
e41f1cb3 256 die(_("annotated tag %s not available"), n->path);
03e8b541
SP
257 }
258 if (n->tag && !n->name_checked) {
259 if (!n->tag->tag)
e41f1cb3 260 die(_("annotated tag %s has no embedded name"), n->path);
81dc223d 261 if (strcmp(n->tag->tag, all ? n->path + 5 : n->path))
e41f1cb3 262 warning(_("tag '%s' is really '%s' here"), n->tag->tag, n->path);
03e8b541 263 n->name_checked = 1;
212945d4
SP
264 }
265
266 if (n->tag)
267 printf("%s", n->tag->tag);
268 else
269 printf("%s", n->path);
870cf7d6
JH
270}
271
6439b5d9 272static void show_suffix(int depth, const struct object_id *oid)
870cf7d6 273{
6439b5d9 274 printf("-%d-g%s", depth, find_unique_abbrev(oid->hash, abbrev));
212945d4
SP
275}
276
554fe20d 277static void describe(const char *arg, int last_one)
908e5310 278{
6439b5d9 279 struct object_id oid;
8713ab30 280 struct commit *cmit, *gave_up_on = NULL;
908e5310 281 struct commit_list *list;
908e5310 282 struct commit_name *n;
cf69fd49 283 struct possible_tag all_matches[MAX_TAGS];
8713ab30
SP
284 unsigned int match_cnt = 0, annotated_cnt = 0, cur_match;
285 unsigned long seen_commits = 0;
4d23660e 286 unsigned int unannotated_cnt = 0;
908e5310 287
6439b5d9 288 if (get_oid(arg, &oid))
e41f1cb3 289 die(_("Not a valid object name %s"), arg);
bc83266a 290 cmit = lookup_commit_reference(&oid);
4c34a2c5 291 if (!cmit)
e41f1cb3 292 die(_("%s is not a valid '%s' object"), arg, commit_type);
4c34a2c5 293
6439b5d9 294 n = find_commit_name(&cmit->object.oid);
7a0d61bb 295 if (n && (tags || all || n->prio == 2)) {
870cf7d6
JH
296 /*
297 * Exact match to an existing ref.
298 */
212945d4 299 display_name(n);
870cf7d6 300 if (longformat)
6439b5d9 301 show_suffix(0, n->tag ? &n->tag->tagged->oid : &oid);
b0176ce6
SB
302 if (suffix)
303 printf("%s", suffix);
212945d4 304 printf("\n");
908e5310
LT
305 return;
306 }
307
2c33f757 308 if (!max_candidates)
f2fd0760 309 die(_("no tag exactly matches '%s'"), oid_to_hex(&cmit->object.oid));
8713ab30 310 if (debug)
e41f1cb3 311 fprintf(stderr, _("searching to describe %s\n"), arg);
8713ab30 312
d1645d02 313 if (!have_util) {
29d8a834
KB
314 struct hashmap_iter iter;
315 struct commit *c;
316 struct commit_name *n = hashmap_iter_first(&names, &iter);
317 for (; n; n = hashmap_iter_next(&iter)) {
bc83266a 318 c = lookup_commit_reference_gently(&n->peeled, 1);
29d8a834
KB
319 if (c)
320 c->util = n;
321 }
d1645d02
AK
322 have_util = 1;
323 }
324
908e5310 325 list = NULL;
8713ab30 326 cmit->object.flags = SEEN;
908e5310
LT
327 commit_list_insert(cmit, &list);
328 while (list) {
80dbae03 329 struct commit *c = pop_commit(&list);
dccd0c2a 330 struct commit_list *parents = c->parents;
8713ab30 331 seen_commits++;
e7eb5034 332 n = c->util;
908e5310 333 if (n) {
4d23660e
TR
334 if (!tags && !all && n->prio < 2) {
335 unannotated_cnt++;
336 } else if (match_cnt < max_candidates) {
8713ab30
SP
337 struct possible_tag *t = &all_matches[match_cnt++];
338 t->name = n;
339 t->depth = seen_commits - 1;
340 t->flag_within = 1u << match_cnt;
8a8169c0 341 t->found_order = match_cnt;
8713ab30
SP
342 c->object.flags |= t->flag_within;
343 if (n->prio == 2)
344 annotated_cnt++;
345 }
346 else {
347 gave_up_on = c;
348 break;
349 }
350 }
351 for (cur_match = 0; cur_match < match_cnt; cur_match++) {
352 struct possible_tag *t = &all_matches[cur_match];
353 if (!(c->object.flags & t->flag_within))
354 t->depth++;
355 }
356 if (annotated_cnt && !list) {
357 if (debug)
e41f1cb3 358 fprintf(stderr, _("finished search at %s\n"),
f2fd0760 359 oid_to_hex(&c->object.oid));
8713ab30 360 break;
dccd0c2a
SP
361 }
362 while (parents) {
363 struct commit *p = parents->item;
364 parse_commit(p);
8713ab30 365 if (!(p->object.flags & SEEN))
47e44ed1 366 commit_list_insert_by_date(p, &list);
8713ab30 367 p->object.flags |= c->object.flags;
dccd0c2a 368 parents = parents->next;
e00dd1e9
MC
369
370 if (first_parent)
371 break;
80dbae03
SP
372 }
373 }
374
da2478db 375 if (!match_cnt) {
f2fd0760 376 struct object_id *oid = &cmit->object.oid;
da2478db 377 if (always) {
f2fd0760 378 printf("%s", find_unique_abbrev(oid->hash, abbrev));
b0176ce6
SB
379 if (suffix)
380 printf("%s", suffix);
9f67d2e8 381 printf("\n");
da2478db
JH
382 return;
383 }
4d23660e 384 if (unannotated_cnt)
e41f1cb3
ÆAB
385 die(_("No annotated tags can describe '%s'.\n"
386 "However, there were unannotated tags: try --tags."),
f2fd0760 387 oid_to_hex(oid));
4d23660e 388 else
e41f1cb3
ÆAB
389 die(_("No tags can describe '%s'.\n"
390 "Try --always, or create some tags."),
f2fd0760 391 oid_to_hex(oid));
da2478db 392 }
80dbae03 393
9ed0d8d6 394 QSORT(all_matches, match_cnt, compare_pt);
1b600e65
SP
395
396 if (gave_up_on) {
47e44ed1 397 commit_list_insert_by_date(gave_up_on, &list);
1b600e65
SP
398 seen_commits--;
399 }
400 seen_commits += finish_depth_computation(&list, &all_matches[0]);
401 free_commit_list(list);
402
8713ab30 403 if (debug) {
646c3bd1
MG
404 static int label_width = -1;
405 if (label_width < 0) {
406 int i, w;
407 for (i = 0; i < ARRAY_SIZE(prio_names); i++) {
408 w = strlen(_(prio_names[i]));
409 if (label_width < w)
410 label_width = w;
411 }
412 }
8713ab30
SP
413 for (cur_match = 0; cur_match < match_cnt; cur_match++) {
414 struct possible_tag *t = &all_matches[cur_match];
646c3bd1
MG
415 fprintf(stderr, " %-*s %8d %s\n",
416 label_width, _(prio_names[t->name->prio]),
8713ab30
SP
417 t->depth, t->name->path);
418 }
e41f1cb3 419 fprintf(stderr, _("traversed %lu commits\n"), seen_commits);
8713ab30
SP
420 if (gave_up_on) {
421 fprintf(stderr,
e41f1cb3
ÆAB
422 _("more than %i tags found; listed %i most recent\n"
423 "gave up search at %s\n"),
8713ab30 424 max_candidates, max_candidates,
f2fd0760 425 oid_to_hex(&gave_up_on->object.oid));
8713ab30 426 }
80dbae03 427 }
212945d4
SP
428
429 display_name(all_matches[0].name);
430 if (abbrev)
6439b5d9 431 show_suffix(all_matches[0].depth, &cmit->object.oid);
b0176ce6
SB
432 if (suffix)
433 printf("%s", suffix);
212945d4 434 printf("\n");
80dbae03 435
8713ab30
SP
436 if (!last_one)
437 clear_commit_marks(cmit, -1);
908e5310
LT
438}
439
9a0eaf83 440int cmd_describe(int argc, const char **argv, const char *prefix)
908e5310 441{
23615708 442 int contains = 0;
166185be 443 struct option options[] = {
d5d09d47
SB
444 OPT_BOOL(0, "contains", &contains, N_("find the tag that comes after the commit")),
445 OPT_BOOL(0, "debug", &debug, N_("debug search strategy on stderr")),
446 OPT_BOOL(0, "all", &all, N_("use any ref")),
447 OPT_BOOL(0, "tags", &tags, N_("use any tag, even unannotated")),
448 OPT_BOOL(0, "long", &longformat, N_("always use long format")),
449 OPT_BOOL(0, "first-parent", &first_parent, N_("only follow first parent")),
166185be 450 OPT__ABBREV(&abbrev),
2c33f757 451 OPT_SET_INT(0, "exact-match", &max_candidates,
bfb0737d 452 N_("only output exact matches"), 0),
166185be 453 OPT_INTEGER(0, "candidates", &max_candidates,
bfb0737d 454 N_("consider <n> most recent tags (default: 10)")),
43f8080e 455 OPT_STRING_LIST(0, "match", &patterns, N_("pattern"),
bfb0737d 456 N_("only consider tags matching <pattern>")),
77d21f29
JK
457 OPT_STRING_LIST(0, "exclude", &exclude_patterns, N_("pattern"),
458 N_("do not consider tags matching <pattern>")),
d5d09d47
SB
459 OPT_BOOL(0, "always", &always,
460 N_("show abbreviated commit object as fallback")),
bfb0737d 461 {OPTION_STRING, 0, "dirty", &dirty, N_("mark"),
d5d09d47
SB
462 N_("append <mark> on dirty working tree (default: \"-dirty\")"),
463 PARSE_OPT_OPTARG, NULL, (intptr_t) "-dirty"},
b0176ce6
SB
464 {OPTION_STRING, 0, "broken", &broken, N_("mark"),
465 N_("append <mark> on broken working tree (default: \"-broken\")"),
466 PARSE_OPT_OPTARG, NULL, (intptr_t) "-broken"},
166185be
PH
467 OPT_END(),
468 };
908e5310 469
dce96489 470 git_config(git_default_config, NULL);
37782920 471 argc = parse_options(argc, argv, prefix, options, describe_usage, 0);
dce96489
LT
472 if (abbrev < 0)
473 abbrev = DEFAULT_ABBREV;
474
2c33f757
SP
475 if (max_candidates < 0)
476 max_candidates = 0;
166185be
PH
477 else if (max_candidates > MAX_TAGS)
478 max_candidates = MAX_TAGS;
4c34a2c5 479
8c599c74 480 save_commit_buffer = 0;
8112894d 481
518120e3 482 if (longformat && abbrev == 0)
e41f1cb3 483 die(_("--long is incompatible with --abbrev=0"));
518120e3 484
23615708 485 if (contains) {
43f8080e 486 struct string_list_item *item;
45bc950b
JH
487 struct argv_array args;
488
489 argv_array_init(&args);
adfc1857
JH
490 argv_array_pushl(&args, "name-rev",
491 "--peel-tag", "--name-only", "--no-undefined",
45bc950b 492 NULL);
da2478db 493 if (always)
45bc950b 494 argv_array_push(&args, "--always");
30ffa603 495 if (!all) {
45bc950b 496 argv_array_push(&args, "--tags");
43f8080e
JK
497 for_each_string_list_item(item, &patterns)
498 argv_array_pushf(&args, "--refs=refs/tags/%s", item->string);
77d21f29
JK
499 for_each_string_list_item(item, &exclude_patterns)
500 argv_array_pushf(&args, "--exclude=refs/tags/%s", item->string);
45bc950b 501 }
2bd07065
SG
502 if (argc)
503 argv_array_pushv(&args, argv);
504 else
505 argv_array_push(&args, "HEAD");
45bc950b 506 return cmd_name_rev(args.argc, args.argv, prefix);
23615708
SP
507 }
508
0068cede 509 hashmap_init(&names, commit_name_cmp, NULL, 0);
99a2cfbf 510 for_each_rawref(get_name, NULL);
8b604d19 511 if (!hashmap_get_size(&names) && !always)
e41f1cb3 512 die(_("No names found, cannot describe anything."));
fb423da0 513
166185be 514 if (argc == 0) {
b0176ce6
SB
515 if (broken) {
516 struct child_process cp = CHILD_PROCESS_INIT;
517 argv_array_pushv(&cp.args, diff_index_args);
518 cp.git_cmd = 1;
519 cp.no_stdin = 1;
520 cp.no_stdout = 1;
521
522 if (!dirty)
523 dirty = "-dirty";
524
525 switch (run_command(&cp)) {
526 case 0:
527 suffix = NULL;
528 break;
529 case 1:
530 suffix = dirty;
531 break;
532 default:
533 /* diff-index aborted abnormally */
534 suffix = broken;
535 }
536 } else if (dirty) {
bb571486
AC
537 static struct lock_file index_lock;
538 int fd;
539
540 read_cache_preload(NULL);
541 refresh_index(&the_index, REFRESH_QUIET|REFRESH_UNMERGED,
542 NULL, NULL, NULL);
543 fd = hold_locked_index(&index_lock, 0);
544 if (0 <= fd)
545 update_index_if_able(&the_index, &index_lock);
546
547 if (!cmd_diff_index(ARRAY_SIZE(diff_index_args) - 1,
548 diff_index_args, prefix))
b0176ce6
SB
549 suffix = NULL;
550 else
551 suffix = dirty;
bb571486 552 }
fec9ebf1 553 describe("HEAD", 1);
9f67d2e8 554 } else if (dirty) {
a8a5406a 555 die(_("--dirty is incompatible with commit-ishes"));
b0176ce6
SB
556 } else if (broken) {
557 die(_("--broken is incompatible with commit-ishes"));
166185be 558 } else {
c4472643 559 while (argc-- > 0)
166185be 560 describe(*argv++, argc == 0);
166185be 561 }
908e5310
LT
562 return 0;
563}