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