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