9f31837d303f1f302266fdd03298ddce73867ba0
[git/git.git] / builtin / rev-list.c
1 #include "cache.h"
2 #include "config.h"
3 #include "commit.h"
4 #include "diff.h"
5 #include "revision.h"
6 #include "list-objects.h"
7 #include "list-objects-filter.h"
8 #include "list-objects-filter-options.h"
9 #include "object.h"
10 #include "object-store.h"
11 #include "pack.h"
12 #include "pack-bitmap.h"
13 #include "builtin.h"
14 #include "log-tree.h"
15 #include "graph.h"
16 #include "bisect.h"
17 #include "progress.h"
18 #include "reflog-walk.h"
19 #include "oidset.h"
20 #include "packfile.h"
21 #include "object-store.h"
22
23 static const char rev_list_usage[] =
24 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
25 " limiting output:\n"
26 " --max-count=<n>\n"
27 " --max-age=<epoch>\n"
28 " --min-age=<epoch>\n"
29 " --sparse\n"
30 " --no-merges\n"
31 " --min-parents=<n>\n"
32 " --no-min-parents\n"
33 " --max-parents=<n>\n"
34 " --no-max-parents\n"
35 " --remove-empty\n"
36 " --all\n"
37 " --branches\n"
38 " --tags\n"
39 " --remotes\n"
40 " --stdin\n"
41 " --quiet\n"
42 " ordering output:\n"
43 " --topo-order\n"
44 " --date-order\n"
45 " --reverse\n"
46 " formatting output:\n"
47 " --parents\n"
48 " --children\n"
49 " --objects | --objects-edge\n"
50 " --unpacked\n"
51 " --header | --pretty\n"
52 " --abbrev=<n> | --no-abbrev\n"
53 " --abbrev-commit\n"
54 " --left-right\n"
55 " --count\n"
56 " special purpose:\n"
57 " --bisect\n"
58 " --bisect-vars\n"
59 " --bisect-all"
60 ;
61
62 static struct progress *progress;
63 static unsigned progress_counter;
64
65 static struct list_objects_filter_options filter_options;
66 static struct oidset omitted_objects;
67 static int arg_print_omitted; /* print objects omitted by filter */
68
69 static struct oidset missing_objects;
70 enum missing_action {
71 MA_ERROR = 0, /* fail if any missing objects are encountered */
72 MA_ALLOW_ANY, /* silently allow ALL missing objects */
73 MA_PRINT, /* print ALL missing objects in special section */
74 MA_ALLOW_PROMISOR, /* silently allow all missing PROMISOR objects */
75 };
76 static enum missing_action arg_missing_action;
77
78 #define DEFAULT_OIDSET_SIZE (16*1024)
79
80 static void finish_commit(struct commit *commit, void *data);
81 static void show_commit(struct commit *commit, void *data)
82 {
83 struct rev_list_info *info = data;
84 struct rev_info *revs = info->revs;
85
86 display_progress(progress, ++progress_counter);
87
88 if (info->flags & REV_LIST_QUIET) {
89 finish_commit(commit, data);
90 return;
91 }
92
93 graph_show_commit(revs->graph);
94
95 if (revs->count) {
96 if (commit->object.flags & PATCHSAME)
97 revs->count_same++;
98 else if (commit->object.flags & SYMMETRIC_LEFT)
99 revs->count_left++;
100 else
101 revs->count_right++;
102 finish_commit(commit, data);
103 return;
104 }
105
106 if (info->show_timestamp)
107 printf("%"PRItime" ", commit->date);
108 if (info->header_prefix)
109 fputs(info->header_prefix, stdout);
110
111 if (!revs->graph)
112 fputs(get_revision_mark(revs, commit), stdout);
113 if (revs->abbrev_commit && revs->abbrev)
114 fputs(find_unique_abbrev(&commit->object.oid, revs->abbrev),
115 stdout);
116 else
117 fputs(oid_to_hex(&commit->object.oid), stdout);
118 if (revs->print_parents) {
119 struct commit_list *parents = commit->parents;
120 while (parents) {
121 printf(" %s", oid_to_hex(&parents->item->object.oid));
122 parents = parents->next;
123 }
124 }
125 if (revs->children.name) {
126 struct commit_list *children;
127
128 children = lookup_decoration(&revs->children, &commit->object);
129 while (children) {
130 printf(" %s", oid_to_hex(&children->item->object.oid));
131 children = children->next;
132 }
133 }
134 show_decorations(revs, commit);
135 if (revs->commit_format == CMIT_FMT_ONELINE)
136 putchar(' ');
137 else
138 putchar('\n');
139
140 if (revs->verbose_header) {
141 struct strbuf buf = STRBUF_INIT;
142 struct pretty_print_context ctx = {0};
143 ctx.abbrev = revs->abbrev;
144 ctx.date_mode = revs->date_mode;
145 ctx.date_mode_explicit = revs->date_mode_explicit;
146 ctx.fmt = revs->commit_format;
147 ctx.output_encoding = get_log_output_encoding();
148 ctx.color = revs->diffopt.use_color;
149 pretty_print_commit(&ctx, commit, &buf);
150 if (buf.len) {
151 if (revs->commit_format != CMIT_FMT_ONELINE)
152 graph_show_oneline(revs->graph);
153
154 graph_show_commit_msg(revs->graph, stdout, &buf);
155
156 /*
157 * Add a newline after the commit message.
158 *
159 * Usually, this newline produces a blank
160 * padding line between entries, in which case
161 * we need to add graph padding on this line.
162 *
163 * However, the commit message may not end in a
164 * newline. In this case the newline simply
165 * ends the last line of the commit message,
166 * and we don't need any graph output. (This
167 * always happens with CMIT_FMT_ONELINE, and it
168 * happens with CMIT_FMT_USERFORMAT when the
169 * format doesn't explicitly end in a newline.)
170 */
171 if (buf.len && buf.buf[buf.len - 1] == '\n')
172 graph_show_padding(revs->graph);
173 putchar(info->hdr_termination);
174 } else {
175 /*
176 * If the message buffer is empty, just show
177 * the rest of the graph output for this
178 * commit.
179 */
180 if (graph_show_remainder(revs->graph))
181 putchar('\n');
182 if (revs->commit_format == CMIT_FMT_ONELINE)
183 putchar('\n');
184 }
185 strbuf_release(&buf);
186 } else {
187 if (graph_show_remainder(revs->graph))
188 putchar('\n');
189 }
190 maybe_flush_or_die(stdout, "stdout");
191 finish_commit(commit, data);
192 }
193
194 static void finish_commit(struct commit *commit, void *data)
195 {
196 if (commit->parents) {
197 free_commit_list(commit->parents);
198 commit->parents = NULL;
199 }
200 free_commit_buffer(the_repository->parsed_objects,
201 commit);
202 }
203
204 static inline void finish_object__ma(struct object *obj)
205 {
206 /*
207 * Whether or not we try to dynamically fetch missing objects
208 * from the server, we currently DO NOT have the object. We
209 * can either print, allow (ignore), or conditionally allow
210 * (ignore) them.
211 */
212 switch (arg_missing_action) {
213 case MA_ERROR:
214 die("missing %s object '%s'",
215 type_name(obj->type), oid_to_hex(&obj->oid));
216 return;
217
218 case MA_ALLOW_ANY:
219 return;
220
221 case MA_PRINT:
222 oidset_insert(&missing_objects, &obj->oid);
223 return;
224
225 case MA_ALLOW_PROMISOR:
226 if (is_promisor_object(&obj->oid))
227 return;
228 die("unexpected missing %s object '%s'",
229 type_name(obj->type), oid_to_hex(&obj->oid));
230 return;
231
232 default:
233 BUG("unhandled missing_action");
234 return;
235 }
236 }
237
238 static int finish_object(struct object *obj, const char *name, void *cb_data)
239 {
240 struct rev_list_info *info = cb_data;
241 if (oid_object_info_extended(the_repository, &obj->oid, NULL, 0) < 0) {
242 finish_object__ma(obj);
243 return 1;
244 }
245 if (info->revs->verify_objects && !obj->parsed && obj->type != OBJ_COMMIT)
246 parse_object(the_repository, &obj->oid);
247 return 0;
248 }
249
250 static void show_object(struct object *obj, const char *name, void *cb_data)
251 {
252 struct rev_list_info *info = cb_data;
253 if (finish_object(obj, name, cb_data))
254 return;
255 display_progress(progress, ++progress_counter);
256 if (info->flags & REV_LIST_QUIET)
257 return;
258 show_object_with_name(stdout, obj, name);
259 }
260
261 static void show_edge(struct commit *commit)
262 {
263 printf("-%s\n", oid_to_hex(&commit->object.oid));
264 }
265
266 static void print_var_str(const char *var, const char *val)
267 {
268 printf("%s='%s'\n", var, val);
269 }
270
271 static void print_var_int(const char *var, int val)
272 {
273 printf("%s=%d\n", var, val);
274 }
275
276 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
277 {
278 int cnt, flags = info->flags;
279 char hex[GIT_MAX_HEXSZ + 1] = "";
280 struct commit_list *tried;
281 struct rev_info *revs = info->revs;
282
283 if (!revs->commits)
284 return 1;
285
286 revs->commits = filter_skipped(revs->commits, &tried,
287 flags & BISECT_SHOW_ALL,
288 NULL, NULL);
289
290 /*
291 * revs->commits can reach "reaches" commits among
292 * "all" commits. If it is good, then there are
293 * (all-reaches) commits left to be bisected.
294 * On the other hand, if it is bad, then the set
295 * to bisect is "reaches".
296 * A bisect set of size N has (N-1) commits further
297 * to test, as we already know one bad one.
298 */
299 cnt = all - reaches;
300 if (cnt < reaches)
301 cnt = reaches;
302
303 if (revs->commits)
304 oid_to_hex_r(hex, &revs->commits->item->object.oid);
305
306 if (flags & BISECT_SHOW_ALL) {
307 traverse_commit_list(revs, show_commit, show_object, info);
308 printf("------\n");
309 }
310
311 print_var_str("bisect_rev", hex);
312 print_var_int("bisect_nr", cnt - 1);
313 print_var_int("bisect_good", all - reaches - 1);
314 print_var_int("bisect_bad", reaches - 1);
315 print_var_int("bisect_all", all);
316 print_var_int("bisect_steps", estimate_bisect_steps(all));
317
318 return 0;
319 }
320
321 static int show_object_fast(
322 const struct object_id *oid,
323 enum object_type type,
324 int exclude,
325 uint32_t name_hash,
326 struct packed_git *found_pack,
327 off_t found_offset)
328 {
329 fprintf(stdout, "%s\n", oid_to_hex(oid));
330 return 1;
331 }
332
333 static inline int parse_missing_action_value(const char *value)
334 {
335 if (!strcmp(value, "error")) {
336 arg_missing_action = MA_ERROR;
337 return 1;
338 }
339
340 if (!strcmp(value, "allow-any")) {
341 arg_missing_action = MA_ALLOW_ANY;
342 fetch_if_missing = 0;
343 return 1;
344 }
345
346 if (!strcmp(value, "print")) {
347 arg_missing_action = MA_PRINT;
348 fetch_if_missing = 0;
349 return 1;
350 }
351
352 if (!strcmp(value, "allow-promisor")) {
353 arg_missing_action = MA_ALLOW_PROMISOR;
354 fetch_if_missing = 0;
355 return 1;
356 }
357
358 return 0;
359 }
360
361 int cmd_rev_list(int argc, const char **argv, const char *prefix)
362 {
363 struct rev_info revs;
364 struct rev_list_info info;
365 struct setup_revision_opt s_r_opt = {
366 .allow_exclude_promisor_objects = 1,
367 };
368 int i;
369 int bisect_list = 0;
370 int bisect_show_vars = 0;
371 int bisect_find_all = 0;
372 int use_bitmap_index = 0;
373 const char *show_progress = NULL;
374
375 if (argc == 2 && !strcmp(argv[1], "-h"))
376 usage(rev_list_usage);
377
378 git_config(git_default_config, NULL);
379 repo_init_revisions(the_repository, &revs, prefix);
380 revs.abbrev = DEFAULT_ABBREV;
381 revs.commit_format = CMIT_FMT_UNSPECIFIED;
382
383 /*
384 * Scan the argument list before invoking setup_revisions(), so that we
385 * know if fetch_if_missing needs to be set to 0.
386 *
387 * "--exclude-promisor-objects" acts as a pre-filter on missing objects
388 * by not crossing the boundary from realized objects to promisor
389 * objects.
390 *
391 * Let "--missing" to conditionally set fetch_if_missing.
392 */
393 for (i = 1; i < argc; i++) {
394 const char *arg = argv[i];
395 if (!strcmp(arg, "--exclude-promisor-objects")) {
396 fetch_if_missing = 0;
397 revs.exclude_promisor_objects = 1;
398 break;
399 }
400 }
401 for (i = 1; i < argc; i++) {
402 const char *arg = argv[i];
403 if (skip_prefix(arg, "--missing=", &arg)) {
404 if (revs.exclude_promisor_objects)
405 die(_("cannot combine --exclude-promisor-objects and --missing"));
406 if (parse_missing_action_value(arg))
407 break;
408 }
409 }
410
411 if (arg_missing_action)
412 revs.do_not_die_on_missing_tree = 1;
413
414 argc = setup_revisions(argc, argv, &revs, &s_r_opt);
415
416 memset(&info, 0, sizeof(info));
417 info.revs = &revs;
418 if (revs.bisect)
419 bisect_list = 1;
420
421 if (revs.diffopt.flags.quick)
422 info.flags |= REV_LIST_QUIET;
423 for (i = 1 ; i < argc; i++) {
424 const char *arg = argv[i];
425
426 if (!strcmp(arg, "--header")) {
427 revs.verbose_header = 1;
428 continue;
429 }
430 if (!strcmp(arg, "--timestamp")) {
431 info.show_timestamp = 1;
432 continue;
433 }
434 if (!strcmp(arg, "--bisect")) {
435 bisect_list = 1;
436 continue;
437 }
438 if (!strcmp(arg, "--bisect-all")) {
439 bisect_list = 1;
440 bisect_find_all = 1;
441 info.flags |= BISECT_SHOW_ALL;
442 revs.show_decorations = 1;
443 continue;
444 }
445 if (!strcmp(arg, "--bisect-vars")) {
446 bisect_list = 1;
447 bisect_show_vars = 1;
448 continue;
449 }
450 if (!strcmp(arg, "--use-bitmap-index")) {
451 use_bitmap_index = 1;
452 continue;
453 }
454 if (!strcmp(arg, "--test-bitmap")) {
455 test_bitmap_walk(&revs);
456 return 0;
457 }
458 if (skip_prefix(arg, "--progress=", &arg)) {
459 show_progress = arg;
460 continue;
461 }
462
463 if (skip_prefix(arg, ("--" CL_ARG__FILTER "="), &arg)) {
464 parse_list_objects_filter(&filter_options, arg);
465 if (filter_options.choice && !revs.blob_objects)
466 die(_("object filtering requires --objects"));
467 if (filter_options.choice == LOFC_SPARSE_OID &&
468 !filter_options.sparse_oid_value)
469 die(_("invalid sparse value '%s'"),
470 filter_options.filter_spec);
471 continue;
472 }
473 if (!strcmp(arg, ("--no-" CL_ARG__FILTER))) {
474 list_objects_filter_set_no_filter(&filter_options);
475 continue;
476 }
477 if (!strcmp(arg, "--filter-print-omitted")) {
478 arg_print_omitted = 1;
479 continue;
480 }
481
482 if (!strcmp(arg, "--exclude-promisor-objects"))
483 continue; /* already handled above */
484 if (skip_prefix(arg, "--missing=", &arg))
485 continue; /* already handled above */
486
487 usage(rev_list_usage);
488
489 }
490 if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
491 /* The command line has a --pretty */
492 info.hdr_termination = '\n';
493 if (revs.commit_format == CMIT_FMT_ONELINE)
494 info.header_prefix = "";
495 else
496 info.header_prefix = "commit ";
497 }
498 else if (revs.verbose_header)
499 /* Only --header was specified */
500 revs.commit_format = CMIT_FMT_RAW;
501
502 if ((!revs.commits && reflog_walk_empty(revs.reflog_info) &&
503 (!(revs.tag_objects || revs.tree_objects || revs.blob_objects) &&
504 !revs.pending.nr) &&
505 !revs.rev_input_given && !revs.read_from_stdin) ||
506 revs.diff)
507 usage(rev_list_usage);
508
509 if (revs.show_notes)
510 die(_("rev-list does not support display of notes"));
511
512 if (filter_options.choice && use_bitmap_index)
513 die(_("cannot combine --use-bitmap-index with object filtering"));
514
515 save_commit_buffer = (revs.verbose_header ||
516 revs.grep_filter.pattern_list ||
517 revs.grep_filter.header_list);
518 if (bisect_list)
519 revs.limited = 1;
520
521 if (show_progress)
522 progress = start_delayed_progress(show_progress, 0);
523
524 if (use_bitmap_index && !revs.prune) {
525 if (revs.count && !revs.left_right && !revs.cherry_mark) {
526 uint32_t commit_count;
527 int max_count = revs.max_count;
528 struct bitmap_index *bitmap_git;
529 if ((bitmap_git = prepare_bitmap_walk(&revs))) {
530 count_bitmap_commit_list(bitmap_git, &commit_count, NULL, NULL, NULL);
531 if (max_count >= 0 && max_count < commit_count)
532 commit_count = max_count;
533 printf("%d\n", commit_count);
534 free_bitmap_index(bitmap_git);
535 return 0;
536 }
537 } else if (revs.max_count < 0 &&
538 revs.tag_objects && revs.tree_objects && revs.blob_objects) {
539 struct bitmap_index *bitmap_git;
540 if ((bitmap_git = prepare_bitmap_walk(&revs))) {
541 traverse_bitmap_commit_list(bitmap_git, &show_object_fast);
542 free_bitmap_index(bitmap_git);
543 return 0;
544 }
545 }
546 }
547
548 if (prepare_revision_walk(&revs))
549 die("revision walk setup failed");
550 if (revs.tree_objects)
551 mark_edges_uninteresting(&revs, show_edge, 0);
552
553 if (bisect_list) {
554 int reaches, all;
555
556 find_bisection(&revs.commits, &reaches, &all, bisect_find_all);
557
558 if (bisect_show_vars)
559 return show_bisect_vars(&info, reaches, all);
560 }
561
562 if (arg_print_omitted)
563 oidset_init(&omitted_objects, DEFAULT_OIDSET_SIZE);
564 if (arg_missing_action == MA_PRINT)
565 oidset_init(&missing_objects, DEFAULT_OIDSET_SIZE);
566
567 traverse_commit_list_filtered(
568 &filter_options, &revs, show_commit, show_object, &info,
569 (arg_print_omitted ? &omitted_objects : NULL));
570
571 if (arg_print_omitted) {
572 struct oidset_iter iter;
573 struct object_id *oid;
574 oidset_iter_init(&omitted_objects, &iter);
575 while ((oid = oidset_iter_next(&iter)))
576 printf("~%s\n", oid_to_hex(oid));
577 oidset_clear(&omitted_objects);
578 }
579 if (arg_missing_action == MA_PRINT) {
580 struct oidset_iter iter;
581 struct object_id *oid;
582 oidset_iter_init(&missing_objects, &iter);
583 while ((oid = oidset_iter_next(&iter)))
584 printf("?%s\n", oid_to_hex(oid));
585 oidset_clear(&missing_objects);
586 }
587
588 stop_progress(&progress);
589
590 if (revs.count) {
591 if (revs.left_right && revs.cherry_mark)
592 printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
593 else if (revs.left_right)
594 printf("%d\t%d\n", revs.count_left, revs.count_right);
595 else if (revs.cherry_mark)
596 printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
597 else
598 printf("%d\n", revs.count_left + revs.count_right);
599 }
600
601 return 0;
602 }