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