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