replace strbuf_expand_dict_cb() with strbuf_expand_step()
[git.git] / builtin / rev-list.c
blob6dc8be492a2c424623de0dddc0006a1b0a242f7e
1 #include "cache.h"
2 #include "config.h"
3 #include "commit.h"
4 #include "diff.h"
5 #include "environment.h"
6 #include "gettext.h"
7 #include "hex.h"
8 #include "revision.h"
9 #include "list-objects.h"
10 #include "list-objects-filter.h"
11 #include "list-objects-filter-options.h"
12 #include "object.h"
13 #include "object-name.h"
14 #include "object-file.h"
15 #include "object-store.h"
16 #include "pack.h"
17 #include "pack-bitmap.h"
18 #include "builtin.h"
19 #include "log-tree.h"
20 #include "graph.h"
21 #include "bisect.h"
22 #include "progress.h"
23 #include "reflog-walk.h"
24 #include "oidset.h"
25 #include "packfile.h"
27 static const char rev_list_usage[] =
28 "git rev-list [<options>] <commit>... [--] [<path>...]\n"
29 "\n"
30 " limiting output:\n"
31 " --max-count=<n>\n"
32 " --max-age=<epoch>\n"
33 " --min-age=<epoch>\n"
34 " --sparse\n"
35 " --no-merges\n"
36 " --min-parents=<n>\n"
37 " --no-min-parents\n"
38 " --max-parents=<n>\n"
39 " --no-max-parents\n"
40 " --remove-empty\n"
41 " --all\n"
42 " --branches\n"
43 " --tags\n"
44 " --remotes\n"
45 " --stdin\n"
46 " --exclude-hidden=[fetch|receive|uploadpack]\n"
47 " --quiet\n"
48 " ordering output:\n"
49 " --topo-order\n"
50 " --date-order\n"
51 " --reverse\n"
52 " formatting output:\n"
53 " --parents\n"
54 " --children\n"
55 " --objects | --objects-edge\n"
56 " --disk-usage[=human]\n"
57 " --unpacked\n"
58 " --header | --pretty\n"
59 " --[no-]object-names\n"
60 " --abbrev=<n> | --no-abbrev\n"
61 " --abbrev-commit\n"
62 " --left-right\n"
63 " --count\n"
64 " special purpose:\n"
65 " --bisect\n"
66 " --bisect-vars\n"
67 " --bisect-all"
70 static struct progress *progress;
71 static unsigned progress_counter;
73 static struct oidset omitted_objects;
74 static int arg_print_omitted; /* print objects omitted by filter */
76 static struct oidset missing_objects;
77 enum missing_action {
78 MA_ERROR = 0, /* fail if any missing objects are encountered */
79 MA_ALLOW_ANY, /* silently allow ALL missing objects */
80 MA_PRINT, /* print ALL missing objects in special section */
81 MA_ALLOW_PROMISOR, /* silently allow all missing PROMISOR objects */
83 static enum missing_action arg_missing_action;
85 /* display only the oid of each object encountered */
86 static int arg_show_object_names = 1;
88 #define DEFAULT_OIDSET_SIZE (16*1024)
90 static int show_disk_usage;
91 static off_t total_disk_usage;
92 static int human_readable;
94 static off_t get_object_disk_usage(struct object *obj)
96 off_t size;
97 struct object_info oi = OBJECT_INFO_INIT;
98 oi.disk_sizep = &size;
99 if (oid_object_info_extended(the_repository, &obj->oid, &oi, 0) < 0)
100 die(_("unable to get disk usage of %s"), oid_to_hex(&obj->oid));
101 return size;
104 static void finish_commit(struct commit *commit);
105 static void show_commit(struct commit *commit, void *data)
107 struct rev_list_info *info = data;
108 struct rev_info *revs = info->revs;
110 display_progress(progress, ++progress_counter);
112 if (show_disk_usage)
113 total_disk_usage += get_object_disk_usage(&commit->object);
115 if (info->flags & REV_LIST_QUIET) {
116 finish_commit(commit);
117 return;
120 graph_show_commit(revs->graph);
122 if (revs->count) {
123 if (commit->object.flags & PATCHSAME)
124 revs->count_same++;
125 else if (commit->object.flags & SYMMETRIC_LEFT)
126 revs->count_left++;
127 else
128 revs->count_right++;
129 finish_commit(commit);
130 return;
133 if (info->show_timestamp)
134 printf("%"PRItime" ", commit->date);
135 if (info->header_prefix)
136 fputs(info->header_prefix, stdout);
138 if (revs->include_header) {
139 if (!revs->graph)
140 fputs(get_revision_mark(revs, commit), stdout);
141 if (revs->abbrev_commit && revs->abbrev)
142 fputs(repo_find_unique_abbrev(the_repository, &commit->object.oid, revs->abbrev),
143 stdout);
144 else
145 fputs(oid_to_hex(&commit->object.oid), stdout);
147 if (revs->print_parents) {
148 struct commit_list *parents = commit->parents;
149 while (parents) {
150 printf(" %s", oid_to_hex(&parents->item->object.oid));
151 parents = parents->next;
154 if (revs->children.name) {
155 struct commit_list *children;
157 children = lookup_decoration(&revs->children, &commit->object);
158 while (children) {
159 printf(" %s", oid_to_hex(&children->item->object.oid));
160 children = children->next;
163 show_decorations(revs, commit);
164 if (revs->commit_format == CMIT_FMT_ONELINE)
165 putchar(' ');
166 else if (revs->include_header)
167 putchar('\n');
169 if (revs->verbose_header) {
170 struct strbuf buf = STRBUF_INIT;
171 struct pretty_print_context ctx = {0};
172 ctx.abbrev = revs->abbrev;
173 ctx.date_mode = revs->date_mode;
174 ctx.date_mode_explicit = revs->date_mode_explicit;
175 ctx.fmt = revs->commit_format;
176 ctx.output_encoding = get_log_output_encoding();
177 ctx.color = revs->diffopt.use_color;
178 pretty_print_commit(&ctx, commit, &buf);
179 if (buf.len) {
180 if (revs->commit_format != CMIT_FMT_ONELINE)
181 graph_show_oneline(revs->graph);
183 graph_show_commit_msg(revs->graph, stdout, &buf);
186 * Add a newline after the commit message.
188 * Usually, this newline produces a blank
189 * padding line between entries, in which case
190 * we need to add graph padding on this line.
192 * However, the commit message may not end in a
193 * newline. In this case the newline simply
194 * ends the last line of the commit message,
195 * and we don't need any graph output. (This
196 * always happens with CMIT_FMT_ONELINE, and it
197 * happens with CMIT_FMT_USERFORMAT when the
198 * format doesn't explicitly end in a newline.)
200 if (buf.len && buf.buf[buf.len - 1] == '\n')
201 graph_show_padding(revs->graph);
202 putchar(info->hdr_termination);
203 } else {
205 * If the message buffer is empty, just show
206 * the rest of the graph output for this
207 * commit.
209 if (graph_show_remainder(revs->graph))
210 putchar('\n');
211 if (revs->commit_format == CMIT_FMT_ONELINE)
212 putchar('\n');
214 strbuf_release(&buf);
215 } else {
216 if (graph_show_remainder(revs->graph))
217 putchar('\n');
219 maybe_flush_or_die(stdout, "stdout");
220 finish_commit(commit);
223 static void finish_commit(struct commit *commit)
225 free_commit_list(commit->parents);
226 commit->parents = NULL;
227 free_commit_buffer(the_repository->parsed_objects,
228 commit);
231 static inline void finish_object__ma(struct object *obj)
234 * Whether or not we try to dynamically fetch missing objects
235 * from the server, we currently DO NOT have the object. We
236 * can either print, allow (ignore), or conditionally allow
237 * (ignore) them.
239 switch (arg_missing_action) {
240 case MA_ERROR:
241 die("missing %s object '%s'",
242 type_name(obj->type), oid_to_hex(&obj->oid));
243 return;
245 case MA_ALLOW_ANY:
246 return;
248 case MA_PRINT:
249 oidset_insert(&missing_objects, &obj->oid);
250 return;
252 case MA_ALLOW_PROMISOR:
253 if (is_promisor_object(&obj->oid))
254 return;
255 die("unexpected missing %s object '%s'",
256 type_name(obj->type), oid_to_hex(&obj->oid));
257 return;
259 default:
260 BUG("unhandled missing_action");
261 return;
265 static int finish_object(struct object *obj, const char *name UNUSED,
266 void *cb_data)
268 struct rev_list_info *info = cb_data;
269 if (oid_object_info_extended(the_repository, &obj->oid, NULL, 0) < 0) {
270 finish_object__ma(obj);
271 return 1;
273 if (info->revs->verify_objects && !obj->parsed && obj->type != OBJ_COMMIT)
274 parse_object(the_repository, &obj->oid);
275 return 0;
278 static void show_object(struct object *obj, const char *name, void *cb_data)
280 struct rev_list_info *info = cb_data;
281 struct rev_info *revs = info->revs;
283 if (finish_object(obj, name, cb_data))
284 return;
285 display_progress(progress, ++progress_counter);
286 if (show_disk_usage)
287 total_disk_usage += get_object_disk_usage(obj);
288 if (info->flags & REV_LIST_QUIET)
289 return;
291 if (revs->count) {
293 * The object count is always accumulated in the .count_right
294 * field for traversal that is not a left-right traversal,
295 * and cmd_rev_list() made sure that a .count request that
296 * wants to count non-commit objects, which is handled by
297 * the show_object() callback, does not ask for .left_right.
299 revs->count_right++;
300 return;
303 if (arg_show_object_names)
304 show_object_with_name(stdout, obj, name);
305 else
306 printf("%s\n", oid_to_hex(&obj->oid));
309 static void show_edge(struct commit *commit)
311 printf("-%s\n", oid_to_hex(&commit->object.oid));
314 static void print_var_str(const char *var, const char *val)
316 printf("%s='%s'\n", var, val);
319 static void print_var_int(const char *var, int val)
321 printf("%s=%d\n", var, val);
324 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
326 int cnt, flags = info->flags;
327 char hex[GIT_MAX_HEXSZ + 1] = "";
328 struct commit_list *tried;
329 struct rev_info *revs = info->revs;
331 if (!revs->commits)
332 return 1;
334 revs->commits = filter_skipped(revs->commits, &tried,
335 flags & BISECT_SHOW_ALL,
336 NULL, NULL);
339 * revs->commits can reach "reaches" commits among
340 * "all" commits. If it is good, then there are
341 * (all-reaches) commits left to be bisected.
342 * On the other hand, if it is bad, then the set
343 * to bisect is "reaches".
344 * A bisect set of size N has (N-1) commits further
345 * to test, as we already know one bad one.
347 cnt = all - reaches;
348 if (cnt < reaches)
349 cnt = reaches;
351 if (revs->commits)
352 oid_to_hex_r(hex, &revs->commits->item->object.oid);
354 if (flags & BISECT_SHOW_ALL) {
355 traverse_commit_list(revs, show_commit, show_object, info);
356 printf("------\n");
359 print_var_str("bisect_rev", hex);
360 print_var_int("bisect_nr", cnt - 1);
361 print_var_int("bisect_good", all - reaches - 1);
362 print_var_int("bisect_bad", reaches - 1);
363 print_var_int("bisect_all", all);
364 print_var_int("bisect_steps", estimate_bisect_steps(all));
366 return 0;
369 static int show_object_fast(
370 const struct object_id *oid,
371 enum object_type type UNUSED,
372 int exclude UNUSED,
373 uint32_t name_hash UNUSED,
374 struct packed_git *found_pack UNUSED,
375 off_t found_offset UNUSED)
377 fprintf(stdout, "%s\n", oid_to_hex(oid));
378 return 1;
381 static void print_disk_usage(off_t size)
383 struct strbuf sb = STRBUF_INIT;
384 if (human_readable)
385 strbuf_humanise_bytes(&sb, size);
386 else
387 strbuf_addf(&sb, "%"PRIuMAX, (uintmax_t)size);
388 puts(sb.buf);
389 strbuf_release(&sb);
392 static inline int parse_missing_action_value(const char *value)
394 if (!strcmp(value, "error")) {
395 arg_missing_action = MA_ERROR;
396 return 1;
399 if (!strcmp(value, "allow-any")) {
400 arg_missing_action = MA_ALLOW_ANY;
401 fetch_if_missing = 0;
402 return 1;
405 if (!strcmp(value, "print")) {
406 arg_missing_action = MA_PRINT;
407 fetch_if_missing = 0;
408 return 1;
411 if (!strcmp(value, "allow-promisor")) {
412 arg_missing_action = MA_ALLOW_PROMISOR;
413 fetch_if_missing = 0;
414 return 1;
417 return 0;
420 static int try_bitmap_count(struct rev_info *revs,
421 int filter_provided_objects)
423 uint32_t commit_count = 0,
424 tag_count = 0,
425 tree_count = 0,
426 blob_count = 0;
427 int max_count;
428 struct bitmap_index *bitmap_git;
430 /* This function only handles counting, not general traversal. */
431 if (!revs->count)
432 return -1;
435 * A bitmap result can't know left/right, etc, because we don't
436 * actually traverse.
438 if (revs->left_right || revs->cherry_mark)
439 return -1;
442 * If we're counting reachable objects, we can't handle a max count of
443 * commits to traverse, since we don't know which objects go with which
444 * commit.
446 if (revs->max_count >= 0 &&
447 (revs->tag_objects || revs->tree_objects || revs->blob_objects))
448 return -1;
451 * This must be saved before doing any walking, since the revision
452 * machinery will count it down to zero while traversing.
454 max_count = revs->max_count;
456 bitmap_git = prepare_bitmap_walk(revs, filter_provided_objects);
457 if (!bitmap_git)
458 return -1;
460 count_bitmap_commit_list(bitmap_git, &commit_count,
461 revs->tree_objects ? &tree_count : NULL,
462 revs->blob_objects ? &blob_count : NULL,
463 revs->tag_objects ? &tag_count : NULL);
464 if (max_count >= 0 && max_count < commit_count)
465 commit_count = max_count;
467 printf("%d\n", commit_count + tree_count + blob_count + tag_count);
468 free_bitmap_index(bitmap_git);
469 return 0;
472 static int try_bitmap_traversal(struct rev_info *revs,
473 int filter_provided_objects)
475 struct bitmap_index *bitmap_git;
478 * We can't use a bitmap result with a traversal limit, since the set
479 * of commits we'd get would be essentially random.
481 if (revs->max_count >= 0)
482 return -1;
484 bitmap_git = prepare_bitmap_walk(revs, filter_provided_objects);
485 if (!bitmap_git)
486 return -1;
488 traverse_bitmap_commit_list(bitmap_git, revs, &show_object_fast);
489 free_bitmap_index(bitmap_git);
490 return 0;
493 static int try_bitmap_disk_usage(struct rev_info *revs,
494 int filter_provided_objects)
496 struct bitmap_index *bitmap_git;
497 off_t size_from_bitmap;
499 if (!show_disk_usage)
500 return -1;
502 bitmap_git = prepare_bitmap_walk(revs, filter_provided_objects);
503 if (!bitmap_git)
504 return -1;
506 size_from_bitmap = get_disk_usage_from_bitmap(bitmap_git, revs);
507 print_disk_usage(size_from_bitmap);
508 return 0;
511 int cmd_rev_list(int argc, const char **argv, const char *prefix)
513 struct rev_info revs;
514 struct rev_list_info info;
515 struct setup_revision_opt s_r_opt = {
516 .allow_exclude_promisor_objects = 1,
518 int i;
519 int bisect_list = 0;
520 int bisect_show_vars = 0;
521 int bisect_find_all = 0;
522 int use_bitmap_index = 0;
523 int filter_provided_objects = 0;
524 const char *show_progress = NULL;
525 int ret = 0;
527 if (argc == 2 && !strcmp(argv[1], "-h"))
528 usage(rev_list_usage);
530 git_config(git_default_config, NULL);
531 repo_init_revisions(the_repository, &revs, prefix);
532 revs.abbrev = DEFAULT_ABBREV;
533 revs.commit_format = CMIT_FMT_UNSPECIFIED;
534 revs.include_header = 1;
537 * Scan the argument list before invoking setup_revisions(), so that we
538 * know if fetch_if_missing needs to be set to 0.
540 * "--exclude-promisor-objects" acts as a pre-filter on missing objects
541 * by not crossing the boundary from realized objects to promisor
542 * objects.
544 * Let "--missing" to conditionally set fetch_if_missing.
546 for (i = 1; i < argc; i++) {
547 const char *arg = argv[i];
548 if (!strcmp(arg, "--exclude-promisor-objects")) {
549 fetch_if_missing = 0;
550 revs.exclude_promisor_objects = 1;
551 break;
554 for (i = 1; i < argc; i++) {
555 const char *arg = argv[i];
556 if (skip_prefix(arg, "--missing=", &arg)) {
557 if (revs.exclude_promisor_objects)
558 die(_("options '%s' and '%s' cannot be used together"), "--exclude-promisor-objects", "--missing");
559 if (parse_missing_action_value(arg))
560 break;
564 if (arg_missing_action)
565 revs.do_not_die_on_missing_tree = 1;
567 argc = setup_revisions(argc, argv, &revs, &s_r_opt);
569 memset(&info, 0, sizeof(info));
570 info.revs = &revs;
571 if (revs.bisect)
572 bisect_list = 1;
574 if (revs.diffopt.flags.quick)
575 info.flags |= REV_LIST_QUIET;
576 for (i = 1 ; i < argc; i++) {
577 const char *arg = argv[i];
579 if (!strcmp(arg, "--header")) {
580 revs.verbose_header = 1;
581 continue;
583 if (!strcmp(arg, "--timestamp")) {
584 info.show_timestamp = 1;
585 continue;
587 if (!strcmp(arg, "--bisect")) {
588 bisect_list = 1;
589 continue;
591 if (!strcmp(arg, "--bisect-all")) {
592 bisect_list = 1;
593 bisect_find_all = 1;
594 info.flags |= BISECT_SHOW_ALL;
595 revs.show_decorations = 1;
596 continue;
598 if (!strcmp(arg, "--bisect-vars")) {
599 bisect_list = 1;
600 bisect_show_vars = 1;
601 continue;
603 if (!strcmp(arg, "--use-bitmap-index")) {
604 use_bitmap_index = 1;
605 continue;
607 if (!strcmp(arg, "--test-bitmap")) {
608 test_bitmap_walk(&revs);
609 goto cleanup;
611 if (skip_prefix(arg, "--progress=", &arg)) {
612 show_progress = arg;
613 continue;
615 if (!strcmp(arg, "--filter-provided-objects")) {
616 filter_provided_objects = 1;
617 continue;
619 if (!strcmp(arg, "--filter-print-omitted")) {
620 arg_print_omitted = 1;
621 continue;
624 if (!strcmp(arg, "--exclude-promisor-objects"))
625 continue; /* already handled above */
626 if (skip_prefix(arg, "--missing=", &arg))
627 continue; /* already handled above */
629 if (!strcmp(arg, ("--no-object-names"))) {
630 arg_show_object_names = 0;
631 continue;
634 if (!strcmp(arg, ("--object-names"))) {
635 arg_show_object_names = 1;
636 continue;
639 if (!strcmp(arg, ("--commit-header"))) {
640 revs.include_header = 1;
641 continue;
644 if (!strcmp(arg, ("--no-commit-header"))) {
645 revs.include_header = 0;
646 continue;
649 if (skip_prefix(arg, "--disk-usage", &arg)) {
650 if (*arg == '=') {
651 if (!strcmp(++arg, "human")) {
652 human_readable = 1;
653 } else
654 die(_("invalid value for '%s': '%s', the only allowed format is '%s'"),
655 "--disk-usage=<format>", arg, "human");
656 } else if (*arg) {
658 * Arguably should goto a label to continue chain of ifs?
659 * Doesn't matter unless we try to add --disk-usage-foo
660 * afterwards.
662 usage(rev_list_usage);
664 show_disk_usage = 1;
665 info.flags |= REV_LIST_QUIET;
666 continue;
669 usage(rev_list_usage);
672 if (revs.commit_format != CMIT_FMT_USERFORMAT)
673 revs.include_header = 1;
674 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
675 /* The command line has a --pretty */
676 info.hdr_termination = '\n';
677 if (revs.commit_format == CMIT_FMT_ONELINE || !revs.include_header)
678 info.header_prefix = "";
679 else
680 info.header_prefix = "commit ";
682 else if (revs.verbose_header)
683 /* Only --header was specified */
684 revs.commit_format = CMIT_FMT_RAW;
686 if ((!revs.commits && reflog_walk_empty(revs.reflog_info) &&
687 (!(revs.tag_objects || revs.tree_objects || revs.blob_objects) &&
688 !revs.pending.nr) &&
689 !revs.rev_input_given && !revs.read_from_stdin) ||
690 revs.diff)
691 usage(rev_list_usage);
693 if (revs.show_notes)
694 die(_("rev-list does not support display of notes"));
696 if (revs.count &&
697 (revs.tag_objects || revs.tree_objects || revs.blob_objects) &&
698 (revs.left_right || revs.cherry_mark))
699 die(_("marked counting and '%s' cannot be used together"), "--objects");
701 save_commit_buffer = (revs.verbose_header ||
702 revs.grep_filter.pattern_list ||
703 revs.grep_filter.header_list);
704 if (bisect_list)
705 revs.limited = 1;
707 if (show_progress)
708 progress = start_delayed_progress(show_progress, 0);
710 if (use_bitmap_index) {
711 if (!try_bitmap_count(&revs, filter_provided_objects))
712 goto cleanup;
713 if (!try_bitmap_disk_usage(&revs, filter_provided_objects))
714 goto cleanup;
715 if (!try_bitmap_traversal(&revs, filter_provided_objects))
716 goto cleanup;
719 if (prepare_revision_walk(&revs))
720 die("revision walk setup failed");
721 if (revs.tree_objects)
722 mark_edges_uninteresting(&revs, show_edge, 0);
724 if (bisect_list) {
725 int reaches, all;
726 unsigned bisect_flags = 0;
728 if (bisect_find_all)
729 bisect_flags |= FIND_BISECTION_ALL;
731 if (revs.first_parent_only)
732 bisect_flags |= FIND_BISECTION_FIRST_PARENT_ONLY;
734 find_bisection(&revs.commits, &reaches, &all, bisect_flags);
736 if (bisect_show_vars) {
737 ret = show_bisect_vars(&info, reaches, all);
738 goto cleanup;
742 if (filter_provided_objects) {
743 struct commit_list *c;
744 for (i = 0; i < revs.pending.nr; i++) {
745 struct object_array_entry *pending = revs.pending.objects + i;
746 pending->item->flags |= NOT_USER_GIVEN;
748 for (c = revs.commits; c; c = c->next)
749 c->item->object.flags |= NOT_USER_GIVEN;
752 if (arg_print_omitted)
753 oidset_init(&omitted_objects, DEFAULT_OIDSET_SIZE);
754 if (arg_missing_action == MA_PRINT)
755 oidset_init(&missing_objects, DEFAULT_OIDSET_SIZE);
757 traverse_commit_list_filtered(
758 &revs, show_commit, show_object, &info,
759 (arg_print_omitted ? &omitted_objects : NULL));
761 if (arg_print_omitted) {
762 struct oidset_iter iter;
763 struct object_id *oid;
764 oidset_iter_init(&omitted_objects, &iter);
765 while ((oid = oidset_iter_next(&iter)))
766 printf("~%s\n", oid_to_hex(oid));
767 oidset_clear(&omitted_objects);
769 if (arg_missing_action == MA_PRINT) {
770 struct oidset_iter iter;
771 struct object_id *oid;
772 oidset_iter_init(&missing_objects, &iter);
773 while ((oid = oidset_iter_next(&iter)))
774 printf("?%s\n", oid_to_hex(oid));
775 oidset_clear(&missing_objects);
778 stop_progress(&progress);
780 if (revs.count) {
781 if (revs.left_right && revs.cherry_mark)
782 printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
783 else if (revs.left_right)
784 printf("%d\t%d\n", revs.count_left, revs.count_right);
785 else if (revs.cherry_mark)
786 printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
787 else
788 printf("%d\n", revs.count_left + revs.count_right);
791 if (show_disk_usage)
792 print_disk_usage(total_disk_usage);
794 cleanup:
795 release_revisions(&revs);
796 return ret;