builtin/rev-list.c

   1 #include "cache.h"
   2 #include "commit.h"
   3 #include "diff.h"
   4 #include "revision.h"
   5 #include "list-objects.h"
   6 #include "builtin.h"
   7 #include "log-tree.h"
   8 #include "graph.h"
   9 #include "bisect.h"
  10
  11 static const char rev_list_usage[] =
  12 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
  13 "  limiting output:\n"
  14 "    --max-count=<n>\n"
  15 "    --max-age=<epoch>\n"
  16 "    --min-age=<epoch>\n"
  17 "    --sparse\n"
  18 "    --no-merges\n"
  19 "    --min-parents=<n>\n"
  20 "    --no-min-parents\n"
  21 "    --max-parents=<n>\n"
  22 "    --no-max-parents\n"
  23 "    --remove-empty\n"
  24 "    --all\n"
  25 "    --branches\n"
  26 "    --tags\n"
  27 "    --remotes\n"
  28 "    --stdin\n"
  29 "    --quiet\n"
  30 "  ordering output:\n"
  31 "    --topo-order\n"
  32 "    --date-order\n"
  33 "    --reverse\n"
  34 "  formatting output:\n"
  35 "    --parents\n"
  36 "    --children\n"
  37 "    --objects | --objects-edge\n"
  38 "    --unpacked\n"
  39 "    --header | --pretty\n"
  40 "    --abbrev=<n> | --no-abbrev\n"
  41 "    --abbrev-commit\n"
  42 "    --left-right\n"
  43 "  special purpose:\n"
  44 "    --bisect\n"
  45 "    --bisect-vars\n"
  46 "    --bisect-all"
  47 ;
  48
  49 static void finish_commit(struct commit *commit, void *data);
  50 static void show_commit(struct commit *commit, void *data)
  51 {
  52         struct rev_list_info *info = data;
  53         struct rev_info *revs = info->revs;
  54
  55         graph_show_commit(revs->graph);
  56
  57         if (revs->count) {
  58                 if (commit->object.flags & PATCHSAME)
  59                         revs->count_same++;
  60                 else if (commit->object.flags & SYMMETRIC_LEFT)
  61                         revs->count_left++;
  62                 else
  63                         revs->count_right++;
  64                 finish_commit(commit, data);
  65                 return;
  66         }
  67
  68         if (info->show_timestamp)
  69                 printf("%lu ", commit->date);
  70         if (info->header_prefix)
  71                 fputs(info->header_prefix, stdout);
  72
  73         if (!revs->graph)
  74                 fputs(get_revision_mark(revs, commit), stdout);
  75         if (revs->abbrev_commit && revs->abbrev)
  76                 fputs(find_unique_abbrev(commit->object.sha1, revs->abbrev),
  77                       stdout);
  78         else
  79                 fputs(sha1_to_hex(commit->object.sha1), stdout);
  80         if (revs->print_parents) {
  81                 struct commit_list *parents = commit->parents;
  82                 while (parents) {
  83                         printf(" %s", sha1_to_hex(parents->item->object.sha1));
  84                         parents = parents->next;
  85                 }
  86         }
  87         if (revs->children.name) {
  88                 struct commit_list *children;
  89
  90                 children = lookup_decoration(&revs->children, &commit->object);
  91                 while (children) {
  92                         printf(" %s", sha1_to_hex(children->item->object.sha1));
  93                         children = children->next;
  94                 }
  95         }
  96         show_decorations(revs, commit);
  97         if (revs->commit_format == CMIT_FMT_ONELINE)
  98                 putchar(' ');
  99         else
 100                 putchar('\n');
 101
 102         if (revs->verbose_header && commit->buffer) {
 103                 struct strbuf buf = STRBUF_INIT;
 104                 struct pretty_print_context ctx = {0};
 105                 ctx.abbrev = revs->abbrev;
 106                 ctx.date_mode = revs->date_mode;
 107                 ctx.fmt = revs->commit_format;
 108                 pretty_print_commit(&ctx, commit, &buf);
 109                 if (revs->graph) {
 110                         if (buf.len) {
 111                                 if (revs->commit_format != CMIT_FMT_ONELINE)
 112                                         graph_show_oneline(revs->graph);
 113
 114                                 graph_show_commit_msg(revs->graph, &buf);
 115
 116                                 /*
 117                                  * Add a newline after the commit message.
 118                                  *
 119                                  * Usually, this newline produces a blank
 120                                  * padding line between entries, in which case
 121                                  * we need to add graph padding on this line.
 122                                  *
 123                                  * However, the commit message may not end in a
 124                                  * newline.  In this case the newline simply
 125                                  * ends the last line of the commit message,
 126                                  * and we don't need any graph output.  (This
 127                                  * always happens with CMIT_FMT_ONELINE, and it
 128                                  * happens with CMIT_FMT_USERFORMAT when the
 129                                  * format doesn't explicitly end in a newline.)
 130                                  */
 131                                 if (buf.len && buf.buf[buf.len - 1] == '\n')
 132                                         graph_show_padding(revs->graph);
 133                                 putchar('\n');
 134                         } else {
 135                                 /*
 136                                  * If the message buffer is empty, just show
 137                                  * the rest of the graph output for this
 138                                  * commit.
 139                                  */
 140                                 if (graph_show_remainder(revs->graph))
 141                                         putchar('\n');
 142                                 if (revs->commit_format == CMIT_FMT_ONELINE)
 143                                         putchar('\n');
 144                         }
 145                 } else {
 146                         if (revs->commit_format != CMIT_FMT_USERFORMAT ||
 147                             buf.len) {
 148                                 fwrite(buf.buf, 1, buf.len, stdout);
 149                                 putchar(info->hdr_termination);
 150                         }
 151                 }
 152                 strbuf_release(&buf);
 153         } else {
 154                 if (graph_show_remainder(revs->graph))
 155                         putchar('\n');
 156         }
 157         maybe_flush_or_die(stdout, "stdout");
 158         finish_commit(commit, data);
 159 }
 160
 161 static void finish_commit(struct commit *commit, void *data)
 162 {
 163         if (commit->parents) {
 164                 free_commit_list(commit->parents);
 165                 commit->parents = NULL;
 166         }
 167         free(commit->buffer);
 168         commit->buffer = NULL;
 169 }
 170
 171 static void finish_object(struct object *obj,
 172                           const struct name_path *path, const char *name,
 173                           void *cb_data)
 174 {
 175         if (obj->type == OBJ_BLOB && !has_sha1_file(obj->sha1))
 176                 die("missing blob object '%s'", sha1_to_hex(obj->sha1));
 177 }
 178
 179 static void show_object(struct object *obj,
 180                         const struct name_path *path, const char *component,
 181                         void *cb_data)
 182 {
 183         struct rev_info *info = cb_data;
 184
 185         finish_object(obj, path, component, cb_data);
 186         if (info->verify_objects && !obj->parsed && obj->type != OBJ_COMMIT)
 187                 parse_object(obj->sha1);
 188         show_object_with_name(stdout, obj, path, component);
 189 }
 190
 191 static void show_edge(struct commit *commit)
 192 {
 193         printf("-%s\n", sha1_to_hex(commit->object.sha1));
 194 }
 195
 196 static inline int log2i(int n)
 197 {
 198         int log2 = 0;
 199
 200         for (; n > 1; n >>= 1)
 201                 log2++;
 202
 203         return log2;
 204 }
 205
 206 static inline int exp2i(int n)
 207 {
 208         return 1 << n;
 209 }
 210
 211 /*
 212  * Estimate the number of bisect steps left (after the current step)
 213  *
 214  * For any x between 0 included and 2^n excluded, the probability for
 215  * n - 1 steps left looks like:
 216  *
 217  * P(2^n + x) == (2^n - x) / (2^n + x)
 218  *
 219  * and P(2^n + x) < 0.5 means 2^n < 3x
 220  */
 221 int estimate_bisect_steps(int all)
 222 {
 223         int n, x, e;
 224
 225         if (all < 3)
 226                 return 0;
 227
 228         n = log2i(all);
 229         e = exp2i(n);
 230         x = all - e;
 231
 232         return (e < 3 * x) ? n : n - 1;
 233 }
 234
 235 void print_commit_list(struct commit_list *list,
 236                        const char *format_cur,
 237                        const char *format_last)
 238 {
 239         for ( ; list; list = list->next) {
 240                 const char *format = list->next ? format_cur : format_last;
 241                 printf(format, sha1_to_hex(list->item->object.sha1));
 242         }
 243 }
 244
 245 static void show_tried_revs(struct commit_list *tried)
 246 {
 247         printf("bisect_tried='");
 248         print_commit_list(tried, "%s|", "%s");
 249         printf("'\n");
 250 }
 251
 252 static void print_var_str(const char *var, const char *val)
 253 {
 254         printf("%s='%s'\n", var, val);
 255 }
 256
 257 static void print_var_int(const char *var, int val)
 258 {
 259         printf("%s=%d\n", var, val);
 260 }
 261
 262 static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
 263 {
 264         int cnt, flags = info->bisect_show_flags;
 265         char hex[41] = "";
 266         struct commit_list *tried;
 267         struct rev_info *revs = info->revs;
 268
 269         if (!revs->commits && !(flags & BISECT_SHOW_TRIED))
 270                 return 1;
 271
 272         revs->commits = filter_skipped(revs->commits, &tried,
 273                                        flags & BISECT_SHOW_ALL,
 274                                        NULL, NULL);
 275
 276         /*
 277          * revs->commits can reach "reaches" commits among
 278          * "all" commits.  If it is good, then there are
 279          * (all-reaches) commits left to be bisected.
 280          * On the other hand, if it is bad, then the set
 281          * to bisect is "reaches".
 282          * A bisect set of size N has (N-1) commits further
 283          * to test, as we already know one bad one.
 284          */
 285         cnt = all - reaches;
 286         if (cnt < reaches)
 287                 cnt = reaches;
 288
 289         if (revs->commits)
 290                 strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
 291
 292         if (flags & BISECT_SHOW_ALL) {
 293                 traverse_commit_list(revs, show_commit, show_object, info);
 294                 printf("------\n");
 295         }
 296
 297         if (flags & BISECT_SHOW_TRIED)
 298                 show_tried_revs(tried);
 299
 300         print_var_str("bisect_rev", hex);
 301         print_var_int("bisect_nr", cnt - 1);
 302         print_var_int("bisect_good", all - reaches - 1);
 303         print_var_int("bisect_bad", reaches - 1);
 304         print_var_int("bisect_all", all);
 305         print_var_int("bisect_steps", estimate_bisect_steps(all));
 306
 307         return 0;
 308 }
 309
 310 int cmd_rev_list(int argc, const char **argv, const char *prefix)
 311 {
 312         struct rev_info revs;
 313         struct rev_list_info info;
 314         int i;
 315         int bisect_list = 0;
 316         int bisect_show_vars = 0;
 317         int bisect_find_all = 0;
 318         int quiet = 0;
 319
 320         git_config(git_default_config, NULL);
 321         init_revisions(&revs, prefix);
 322         revs.abbrev = DEFAULT_ABBREV;
 323         revs.commit_format = CMIT_FMT_UNSPECIFIED;
 324         argc = setup_revisions(argc, argv, &revs, NULL);
 325
 326         memset(&info, 0, sizeof(info));
 327         info.revs = &revs;
 328         if (revs.bisect)
 329                 bisect_list = 1;
 330
 331         quiet = DIFF_OPT_TST(&revs.diffopt, QUICK);
 332         for (i = 1 ; i < argc; i++) {
 333                 const char *arg = argv[i];
 334
 335                 if (!strcmp(arg, "--header")) {
 336                         revs.verbose_header = 1;
 337                         continue;
 338                 }
 339                 if (!strcmp(arg, "--timestamp")) {
 340                         info.show_timestamp = 1;
 341                         continue;
 342                 }
 343                 if (!strcmp(arg, "--bisect")) {
 344                         bisect_list = 1;
 345                         continue;
 346                 }
 347                 if (!strcmp(arg, "--bisect-all")) {
 348                         bisect_list = 1;
 349                         bisect_find_all = 1;
 350                         info.bisect_show_flags = BISECT_SHOW_ALL;
 351                         revs.show_decorations = 1;
 352                         continue;
 353                 }
 354                 if (!strcmp(arg, "--bisect-vars")) {
 355                         bisect_list = 1;
 356                         bisect_show_vars = 1;
 357                         continue;
 358                 }
 359                 usage(rev_list_usage);
 360
 361         }
 362         if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
 363                 /* The command line has a --pretty  */
 364                 info.hdr_termination = '\n';
 365                 if (revs.commit_format == CMIT_FMT_ONELINE)
 366                         info.header_prefix = "";
 367                 else
 368                         info.header_prefix = "commit ";
 369         }
 370         else if (revs.verbose_header)
 371                 /* Only --header was specified */
 372                 revs.commit_format = CMIT_FMT_RAW;
 373
 374         if ((!revs.commits &&
 375              (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
 376               !revs.pending.nr)) ||
 377             revs.diff)
 378                 usage(rev_list_usage);
 379
 380         save_commit_buffer = (revs.verbose_header ||
 381                               revs.grep_filter.pattern_list ||
 382                               revs.grep_filter.header_list);
 383         if (bisect_list)
 384                 revs.limited = 1;
 385
 386         if (prepare_revision_walk(&revs))
 387                 die("revision walk setup failed");
 388         if (revs.tree_objects)
 389                 mark_edges_uninteresting(revs.commits, &revs, show_edge);
 390
 391         if (bisect_list) {
 392                 int reaches = reaches, all = all;
 393
 394                 revs.commits = find_bisection(revs.commits, &reaches, &all,
 395                                               bisect_find_all);
 396
 397                 if (bisect_show_vars)
 398                         return show_bisect_vars(&info, reaches, all);
 399         }
 400
 401         traverse_commit_list(&revs,
 402                              quiet ? finish_commit : show_commit,
 403                              quiet ? finish_object : show_object,
 404                              &info);
 405
 406         if (revs.count) {
 407                 if (revs.left_right && revs.cherry_mark)
 408                         printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
 409                 else if (revs.left_right)
 410                         printf("%d\t%d\n", revs.count_left, revs.count_right);
 411                 else if (revs.cherry_mark)
 412                         printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
 413                 else
 414                         printf("%d\n", revs.count_left + revs.count_right);
 415         }
 416
 417         return 0;
 418 }