5 #include "environment.h"
9 #include "list-objects.h"
10 #include "list-objects-filter-options.h"
12 #include "object-name.h"
13 #include "object-file.h"
14 #include "object-store-ll.h"
15 #include "pack-bitmap.h"
20 #include "reflog-walk.h"
24 static const char rev_list_usage
[] =
25 "git rev-list [<options>] <commit>... [--] [<path>...]\n"
29 " --max-age=<epoch>\n"
30 " --min-age=<epoch>\n"
33 " --min-parents=<n>\n"
35 " --max-parents=<n>\n"
43 " --exclude-hidden=[fetch|receive|uploadpack]\n"
49 " formatting output:\n"
52 " --objects | --objects-edge\n"
53 " --disk-usage[=human]\n"
55 " --header | --pretty\n"
56 " --[no-]object-names\n"
57 " --abbrev=<n> | --no-abbrev\n"
67 static struct progress
*progress
;
68 static unsigned progress_counter
;
70 static struct oidset omitted_objects
;
71 static int arg_print_omitted
; /* print objects omitted by filter */
73 static struct oidset missing_objects
;
75 MA_ERROR
= 0, /* fail if any missing objects are encountered */
76 MA_ALLOW_ANY
, /* silently allow ALL missing objects */
77 MA_PRINT
, /* print ALL missing objects in special section */
78 MA_ALLOW_PROMISOR
, /* silently allow all missing PROMISOR objects */
80 static enum missing_action arg_missing_action
;
82 /* display only the oid of each object encountered */
83 static int arg_show_object_names
= 1;
85 #define DEFAULT_OIDSET_SIZE (16*1024)
87 static int show_disk_usage
;
88 static off_t total_disk_usage
;
89 static int human_readable
;
91 static off_t
get_object_disk_usage(struct object
*obj
)
94 struct object_info oi
= OBJECT_INFO_INIT
;
95 oi
.disk_sizep
= &size
;
96 if (oid_object_info_extended(the_repository
, &obj
->oid
, &oi
, 0) < 0)
97 die(_("unable to get disk usage of %s"), oid_to_hex(&obj
->oid
));
101 static inline void finish_object__ma(struct object
*obj
)
104 * Whether or not we try to dynamically fetch missing objects
105 * from the server, we currently DO NOT have the object. We
106 * can either print, allow (ignore), or conditionally allow
109 switch (arg_missing_action
) {
111 die("missing %s object '%s'",
112 type_name(obj
->type
), oid_to_hex(&obj
->oid
));
119 oidset_insert(&missing_objects
, &obj
->oid
);
122 case MA_ALLOW_PROMISOR
:
123 if (is_promisor_object(&obj
->oid
))
125 die("unexpected missing %s object '%s'",
126 type_name(obj
->type
), oid_to_hex(&obj
->oid
));
130 BUG("unhandled missing_action");
135 static void finish_commit(struct commit
*commit
)
137 free_commit_list(commit
->parents
);
138 commit
->parents
= NULL
;
139 free_commit_buffer(the_repository
->parsed_objects
,
143 static void show_commit(struct commit
*commit
, void *data
)
145 struct rev_list_info
*info
= data
;
146 struct rev_info
*revs
= info
->revs
;
148 display_progress(progress
, ++progress_counter
);
150 if (revs
->do_not_die_on_missing_objects
&&
151 oidset_contains(&revs
->missing_commits
, &commit
->object
.oid
)) {
152 finish_object__ma(&commit
->object
);
157 total_disk_usage
+= get_object_disk_usage(&commit
->object
);
159 if (info
->flags
& REV_LIST_QUIET
) {
160 finish_commit(commit
);
164 graph_show_commit(revs
->graph
);
167 if (commit
->object
.flags
& PATCHSAME
)
169 else if (commit
->object
.flags
& SYMMETRIC_LEFT
)
173 finish_commit(commit
);
177 if (info
->show_timestamp
)
178 printf("%"PRItime
" ", commit
->date
);
179 if (info
->header_prefix
)
180 fputs(info
->header_prefix
, stdout
);
182 if (revs
->include_header
) {
184 fputs(get_revision_mark(revs
, commit
), stdout
);
185 if (revs
->abbrev_commit
&& revs
->abbrev
)
186 fputs(repo_find_unique_abbrev(the_repository
, &commit
->object
.oid
, revs
->abbrev
),
189 fputs(oid_to_hex(&commit
->object
.oid
), stdout
);
191 if (revs
->print_parents
) {
192 struct commit_list
*parents
= commit
->parents
;
194 printf(" %s", oid_to_hex(&parents
->item
->object
.oid
));
195 parents
= parents
->next
;
198 if (revs
->children
.name
) {
199 struct commit_list
*children
;
201 children
= lookup_decoration(&revs
->children
, &commit
->object
);
203 printf(" %s", oid_to_hex(&children
->item
->object
.oid
));
204 children
= children
->next
;
207 show_decorations(revs
, commit
);
208 if (revs
->commit_format
== CMIT_FMT_ONELINE
)
210 else if (revs
->include_header
)
213 if (revs
->verbose_header
) {
214 struct strbuf buf
= STRBUF_INIT
;
215 struct pretty_print_context ctx
= {0};
216 ctx
.abbrev
= revs
->abbrev
;
217 ctx
.date_mode
= revs
->date_mode
;
218 ctx
.date_mode_explicit
= revs
->date_mode_explicit
;
219 ctx
.fmt
= revs
->commit_format
;
220 ctx
.output_encoding
= get_log_output_encoding();
221 ctx
.color
= revs
->diffopt
.use_color
;
223 pretty_print_commit(&ctx
, commit
, &buf
);
225 if (revs
->commit_format
!= CMIT_FMT_ONELINE
)
226 graph_show_oneline(revs
->graph
);
228 graph_show_commit_msg(revs
->graph
, stdout
, &buf
);
231 * Add a newline after the commit message.
233 * Usually, this newline produces a blank
234 * padding line between entries, in which case
235 * we need to add graph padding on this line.
237 * However, the commit message may not end in a
238 * newline. In this case the newline simply
239 * ends the last line of the commit message,
240 * and we don't need any graph output. (This
241 * always happens with CMIT_FMT_ONELINE, and it
242 * happens with CMIT_FMT_USERFORMAT when the
243 * format doesn't explicitly end in a newline.)
245 if (buf
.len
&& buf
.buf
[buf
.len
- 1] == '\n')
246 graph_show_padding(revs
->graph
);
247 putchar(info
->hdr_termination
);
250 * If the message buffer is empty, just show
251 * the rest of the graph output for this
254 if (graph_show_remainder(revs
->graph
))
256 if (revs
->commit_format
== CMIT_FMT_ONELINE
)
259 strbuf_release(&buf
);
261 if (graph_show_remainder(revs
->graph
))
264 maybe_flush_or_die(stdout
, "stdout");
265 finish_commit(commit
);
268 static int finish_object(struct object
*obj
, const char *name UNUSED
,
271 struct rev_list_info
*info
= cb_data
;
272 if (oid_object_info_extended(the_repository
, &obj
->oid
, NULL
, 0) < 0) {
273 finish_object__ma(obj
);
276 if (info
->revs
->verify_objects
&& !obj
->parsed
&& obj
->type
!= OBJ_COMMIT
)
277 parse_object(the_repository
, &obj
->oid
);
281 static void show_object(struct object
*obj
, const char *name
, void *cb_data
)
283 struct rev_list_info
*info
= cb_data
;
284 struct rev_info
*revs
= info
->revs
;
286 if (finish_object(obj
, name
, cb_data
))
288 display_progress(progress
, ++progress_counter
);
290 total_disk_usage
+= get_object_disk_usage(obj
);
291 if (info
->flags
& REV_LIST_QUIET
)
296 * The object count is always accumulated in the .count_right
297 * field for traversal that is not a left-right traversal,
298 * and cmd_rev_list() made sure that a .count request that
299 * wants to count non-commit objects, which is handled by
300 * the show_object() callback, does not ask for .left_right.
306 if (arg_show_object_names
)
307 show_object_with_name(stdout
, obj
, name
);
309 printf("%s\n", oid_to_hex(&obj
->oid
));
312 static void show_edge(struct commit
*commit
)
314 printf("-%s\n", oid_to_hex(&commit
->object
.oid
));
317 static void print_var_str(const char *var
, const char *val
)
319 printf("%s='%s'\n", var
, val
);
322 static void print_var_int(const char *var
, int val
)
324 printf("%s=%d\n", var
, val
);
327 static int show_bisect_vars(struct rev_list_info
*info
, int reaches
, int all
)
329 int cnt
, flags
= info
->flags
;
330 char hex
[GIT_MAX_HEXSZ
+ 1] = "";
331 struct commit_list
*tried
;
332 struct rev_info
*revs
= info
->revs
;
337 revs
->commits
= filter_skipped(revs
->commits
, &tried
,
338 flags
& BISECT_SHOW_ALL
,
342 * revs->commits can reach "reaches" commits among
343 * "all" commits. If it is good, then there are
344 * (all-reaches) commits left to be bisected.
345 * On the other hand, if it is bad, then the set
346 * to bisect is "reaches".
347 * A bisect set of size N has (N-1) commits further
348 * to test, as we already know one bad one.
355 oid_to_hex_r(hex
, &revs
->commits
->item
->object
.oid
);
357 if (flags
& BISECT_SHOW_ALL
) {
358 traverse_commit_list(revs
, show_commit
, show_object
, info
);
362 print_var_str("bisect_rev", hex
);
363 print_var_int("bisect_nr", cnt
- 1);
364 print_var_int("bisect_good", all
- reaches
- 1);
365 print_var_int("bisect_bad", reaches
- 1);
366 print_var_int("bisect_all", all
);
367 print_var_int("bisect_steps", estimate_bisect_steps(all
));
372 static int show_object_fast(
373 const struct object_id
*oid
,
374 enum object_type type UNUSED
,
376 uint32_t name_hash UNUSED
,
377 struct packed_git
*found_pack UNUSED
,
378 off_t found_offset UNUSED
)
380 fprintf(stdout
, "%s\n", oid_to_hex(oid
));
384 static void print_disk_usage(off_t size
)
386 struct strbuf sb
= STRBUF_INIT
;
388 strbuf_humanise_bytes(&sb
, size
);
390 strbuf_addf(&sb
, "%"PRIuMAX
, (uintmax_t)size
);
395 static inline int parse_missing_action_value(const char *value
)
397 if (!strcmp(value
, "error")) {
398 arg_missing_action
= MA_ERROR
;
402 if (!strcmp(value
, "allow-any")) {
403 arg_missing_action
= MA_ALLOW_ANY
;
404 fetch_if_missing
= 0;
408 if (!strcmp(value
, "print")) {
409 arg_missing_action
= MA_PRINT
;
410 fetch_if_missing
= 0;
414 if (!strcmp(value
, "allow-promisor")) {
415 arg_missing_action
= MA_ALLOW_PROMISOR
;
416 fetch_if_missing
= 0;
423 static int try_bitmap_count(struct rev_info
*revs
,
424 int filter_provided_objects
)
426 uint32_t commit_count
= 0,
431 struct bitmap_index
*bitmap_git
;
433 /* This function only handles counting, not general traversal. */
438 * A bitmap result can't know left/right, etc, because we don't
441 if (revs
->left_right
|| revs
->cherry_mark
)
445 * If we're counting reachable objects, we can't handle a max count of
446 * commits to traverse, since we don't know which objects go with which
449 if (revs
->max_count
>= 0 &&
450 (revs
->tag_objects
|| revs
->tree_objects
|| revs
->blob_objects
))
454 * This must be saved before doing any walking, since the revision
455 * machinery will count it down to zero while traversing.
457 max_count
= revs
->max_count
;
459 bitmap_git
= prepare_bitmap_walk(revs
, filter_provided_objects
);
463 count_bitmap_commit_list(bitmap_git
, &commit_count
,
464 revs
->tree_objects
? &tree_count
: NULL
,
465 revs
->blob_objects
? &blob_count
: NULL
,
466 revs
->tag_objects
? &tag_count
: NULL
);
467 if (max_count
>= 0 && max_count
< commit_count
)
468 commit_count
= max_count
;
470 printf("%d\n", commit_count
+ tree_count
+ blob_count
+ tag_count
);
471 free_bitmap_index(bitmap_git
);
475 static int try_bitmap_traversal(struct rev_info
*revs
,
476 int filter_provided_objects
)
478 struct bitmap_index
*bitmap_git
;
481 * We can't use a bitmap result with a traversal limit, since the set
482 * of commits we'd get would be essentially random.
484 if (revs
->max_count
>= 0)
487 bitmap_git
= prepare_bitmap_walk(revs
, filter_provided_objects
);
491 traverse_bitmap_commit_list(bitmap_git
, revs
, &show_object_fast
);
492 free_bitmap_index(bitmap_git
);
496 static int try_bitmap_disk_usage(struct rev_info
*revs
,
497 int filter_provided_objects
)
499 struct bitmap_index
*bitmap_git
;
500 off_t size_from_bitmap
;
502 if (!show_disk_usage
)
505 bitmap_git
= prepare_bitmap_walk(revs
, filter_provided_objects
);
509 size_from_bitmap
= get_disk_usage_from_bitmap(bitmap_git
, revs
);
510 print_disk_usage(size_from_bitmap
);
512 free_bitmap_index(bitmap_git
);
516 int cmd_rev_list(int argc
, const char **argv
, const char *prefix
)
518 struct rev_info revs
;
519 struct rev_list_info info
;
520 struct setup_revision_opt s_r_opt
= {
521 .allow_exclude_promisor_objects
= 1,
525 int bisect_show_vars
= 0;
526 int bisect_find_all
= 0;
527 int use_bitmap_index
= 0;
528 int filter_provided_objects
= 0;
529 const char *show_progress
= NULL
;
532 if (argc
== 2 && !strcmp(argv
[1], "-h"))
533 usage(rev_list_usage
);
535 git_config(git_default_config
, NULL
);
536 repo_init_revisions(the_repository
, &revs
, prefix
);
537 revs
.abbrev
= DEFAULT_ABBREV
;
538 revs
.commit_format
= CMIT_FMT_UNSPECIFIED
;
539 revs
.include_header
= 1;
542 * Scan the argument list before invoking setup_revisions(), so that we
543 * know if fetch_if_missing needs to be set to 0.
545 * "--exclude-promisor-objects" acts as a pre-filter on missing objects
546 * by not crossing the boundary from realized objects to promisor
549 * Let "--missing" to conditionally set fetch_if_missing.
552 * NEEDSWORK: These loops that attempt to find presence of
553 * options without understanding that the options they are
554 * skipping are broken (e.g., it would not know "--grep
555 * --exclude-promisor-objects" is not triggering
556 * "--exclude-promisor-objects" option). We really need
557 * setup_revisions() to have a mechanism to allow and disallow
558 * some sets of options for different commands (like rev-list,
559 * replay, etc). Such a mechanism should do an early parsing
560 * of options and be able to manage the `--missing=...` and
561 * `--exclude-promisor-objects` options below.
563 for (i
= 1; i
< argc
; i
++) {
564 const char *arg
= argv
[i
];
565 if (!strcmp(arg
, "--exclude-promisor-objects")) {
566 fetch_if_missing
= 0;
567 revs
.exclude_promisor_objects
= 1;
571 for (i
= 1; i
< argc
; i
++) {
572 const char *arg
= argv
[i
];
573 if (skip_prefix(arg
, "--missing=", &arg
)) {
574 if (revs
.exclude_promisor_objects
)
575 die(_("options '%s' and '%s' cannot be used together"), "--exclude-promisor-objects", "--missing");
576 if (parse_missing_action_value(arg
))
581 if (arg_missing_action
)
582 revs
.do_not_die_on_missing_objects
= 1;
584 argc
= setup_revisions(argc
, argv
, &revs
, &s_r_opt
);
586 memset(&info
, 0, sizeof(info
));
591 if (revs
.diffopt
.flags
.quick
)
592 info
.flags
|= REV_LIST_QUIET
;
593 for (i
= 1 ; i
< argc
; i
++) {
594 const char *arg
= argv
[i
];
596 if (!strcmp(arg
, "--header")) {
597 revs
.verbose_header
= 1;
600 if (!strcmp(arg
, "--timestamp")) {
601 info
.show_timestamp
= 1;
604 if (!strcmp(arg
, "--bisect")) {
608 if (!strcmp(arg
, "--bisect-all")) {
611 info
.flags
|= BISECT_SHOW_ALL
;
612 revs
.show_decorations
= 1;
615 if (!strcmp(arg
, "--bisect-vars")) {
617 bisect_show_vars
= 1;
620 if (!strcmp(arg
, "--use-bitmap-index")) {
621 use_bitmap_index
= 1;
624 if (!strcmp(arg
, "--test-bitmap")) {
625 test_bitmap_walk(&revs
);
628 if (skip_prefix(arg
, "--progress=", &arg
)) {
632 if (!strcmp(arg
, "--filter-provided-objects")) {
633 filter_provided_objects
= 1;
636 if (!strcmp(arg
, "--filter-print-omitted")) {
637 arg_print_omitted
= 1;
641 if (!strcmp(arg
, "--exclude-promisor-objects"))
642 continue; /* already handled above */
643 if (skip_prefix(arg
, "--missing=", &arg
))
644 continue; /* already handled above */
646 if (!strcmp(arg
, ("--no-object-names"))) {
647 arg_show_object_names
= 0;
651 if (!strcmp(arg
, ("--object-names"))) {
652 arg_show_object_names
= 1;
656 if (!strcmp(arg
, ("--commit-header"))) {
657 revs
.include_header
= 1;
661 if (!strcmp(arg
, ("--no-commit-header"))) {
662 revs
.include_header
= 0;
666 if (skip_prefix(arg
, "--disk-usage", &arg
)) {
668 if (!strcmp(++arg
, "human")) {
671 die(_("invalid value for '%s': '%s', the only allowed format is '%s'"),
672 "--disk-usage=<format>", arg
, "human");
675 * Arguably should goto a label to continue chain of ifs?
676 * Doesn't matter unless we try to add --disk-usage-foo
679 usage(rev_list_usage
);
682 info
.flags
|= REV_LIST_QUIET
;
686 usage(rev_list_usage
);
689 if (revs
.commit_format
!= CMIT_FMT_USERFORMAT
)
690 revs
.include_header
= 1;
691 if (revs
.commit_format
!= CMIT_FMT_UNSPECIFIED
) {
692 /* The command line has a --pretty */
693 info
.hdr_termination
= '\n';
694 if (revs
.commit_format
== CMIT_FMT_ONELINE
|| !revs
.include_header
)
695 info
.header_prefix
= "";
697 info
.header_prefix
= "commit ";
699 else if (revs
.verbose_header
)
700 /* Only --header was specified */
701 revs
.commit_format
= CMIT_FMT_RAW
;
703 if ((!revs
.commits
&& reflog_walk_empty(revs
.reflog_info
) &&
704 (!(revs
.tag_objects
|| revs
.tree_objects
|| revs
.blob_objects
) &&
706 !revs
.rev_input_given
&& !revs
.read_from_stdin
) ||
708 usage(rev_list_usage
);
711 die(_("rev-list does not support display of notes"));
714 (revs
.tag_objects
|| revs
.tree_objects
|| revs
.blob_objects
) &&
715 (revs
.left_right
|| revs
.cherry_mark
))
716 die(_("marked counting and '%s' cannot be used together"), "--objects");
718 save_commit_buffer
= (revs
.verbose_header
||
719 revs
.grep_filter
.pattern_list
||
720 revs
.grep_filter
.header_list
);
725 progress
= start_delayed_progress(show_progress
, 0);
727 if (use_bitmap_index
) {
728 if (!try_bitmap_count(&revs
, filter_provided_objects
))
730 if (!try_bitmap_disk_usage(&revs
, filter_provided_objects
))
732 if (!try_bitmap_traversal(&revs
, filter_provided_objects
))
736 if (prepare_revision_walk(&revs
))
737 die("revision walk setup failed");
738 if (revs
.tree_objects
)
739 mark_edges_uninteresting(&revs
, show_edge
, 0);
743 unsigned bisect_flags
= 0;
746 bisect_flags
|= FIND_BISECTION_ALL
;
748 if (revs
.first_parent_only
)
749 bisect_flags
|= FIND_BISECTION_FIRST_PARENT_ONLY
;
751 find_bisection(&revs
.commits
, &reaches
, &all
, bisect_flags
);
753 if (bisect_show_vars
) {
754 ret
= show_bisect_vars(&info
, reaches
, all
);
759 if (filter_provided_objects
) {
760 struct commit_list
*c
;
761 for (i
= 0; i
< revs
.pending
.nr
; i
++) {
762 struct object_array_entry
*pending
= revs
.pending
.objects
+ i
;
763 pending
->item
->flags
|= NOT_USER_GIVEN
;
765 for (c
= revs
.commits
; c
; c
= c
->next
)
766 c
->item
->object
.flags
|= NOT_USER_GIVEN
;
769 if (arg_print_omitted
)
770 oidset_init(&omitted_objects
, DEFAULT_OIDSET_SIZE
);
771 if (arg_missing_action
== MA_PRINT
) {
772 oidset_init(&missing_objects
, DEFAULT_OIDSET_SIZE
);
773 /* Add missing tips */
774 oidset_insert_from_set(&missing_objects
, &revs
.missing_commits
);
775 oidset_clear(&revs
.missing_commits
);
778 traverse_commit_list_filtered(
779 &revs
, show_commit
, show_object
, &info
,
780 (arg_print_omitted
? &omitted_objects
: NULL
));
782 if (arg_print_omitted
) {
783 struct oidset_iter iter
;
784 struct object_id
*oid
;
785 oidset_iter_init(&omitted_objects
, &iter
);
786 while ((oid
= oidset_iter_next(&iter
)))
787 printf("~%s\n", oid_to_hex(oid
));
788 oidset_clear(&omitted_objects
);
790 if (arg_missing_action
== MA_PRINT
) {
791 struct oidset_iter iter
;
792 struct object_id
*oid
;
793 oidset_iter_init(&missing_objects
, &iter
);
794 while ((oid
= oidset_iter_next(&iter
)))
795 printf("?%s\n", oid_to_hex(oid
));
796 oidset_clear(&missing_objects
);
799 stop_progress(&progress
);
802 if (revs
.left_right
&& revs
.cherry_mark
)
803 printf("%d\t%d\t%d\n", revs
.count_left
, revs
.count_right
, revs
.count_same
);
804 else if (revs
.left_right
)
805 printf("%d\t%d\n", revs
.count_left
, revs
.count_right
);
806 else if (revs
.cherry_mark
)
807 printf("%d\t%d\n", revs
.count_left
+ revs
.count_right
, revs
.count_same
);
809 printf("%d\n", revs
.count_left
+ revs
.count_right
);
813 print_disk_usage(total_disk_usage
);
816 release_revisions(&revs
);