builtin/rebase.c

   1 /*
   2  * "git rebase" builtin command
   3  *
   4  * Copyright (c) 2018 Pratik Karki
   5  */
   6
   7 #include "builtin.h"
   8 #include "run-command.h"
   9 #include "exec-cmd.h"
  10 #include "argv-array.h"
  11 #include "dir.h"
  12 #include "packfile.h"
  13 #include "refs.h"
  14 #include "quote.h"
  15 #include "config.h"
  16 #include "cache-tree.h"
  17 #include "unpack-trees.h"
  18 #include "lockfile.h"
  19 #include "parse-options.h"
  20 #include "commit.h"
  21 #include "diff.h"
  22 #include "wt-status.h"
  23 #include "revision.h"
  24 #include "commit-reach.h"
  25 #include "rerere.h"
  26 #include "branch.h"
  27
  28 static char const * const builtin_rebase_usage[] = {
  29         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
  30                 "[<upstream>] [<branch>]"),
  31         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
  32                 "--root [<branch>]"),
  33         N_("git rebase --continue | --abort | --skip | --edit-todo"),
  34         NULL
  35 };
  36
  37 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
  38 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
  39
  40 enum rebase_type {
  41         REBASE_UNSPECIFIED = -1,
  42         REBASE_AM,
  43         REBASE_MERGE,
  44         REBASE_INTERACTIVE,
  45         REBASE_PRESERVE_MERGES
  46 };
  47
  48 static int use_builtin_rebase(void)
  49 {
  50         struct child_process cp = CHILD_PROCESS_INIT;
  51         struct strbuf out = STRBUF_INIT;
  52         int ret, env = git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1);
  53
  54         if (env != -1)
  55                 return env;
  56
  57         argv_array_pushl(&cp.args,
  58                          "config", "--bool", "rebase.usebuiltin", NULL);
  59         cp.git_cmd = 1;
  60         if (capture_command(&cp, &out, 6)) {
  61                 strbuf_release(&out);
  62                 return 1;
  63         }
  64
  65         strbuf_trim(&out);
  66         ret = !strcmp("true", out.buf);
  67         strbuf_release(&out);
  68         return ret;
  69 }
  70
  71 struct rebase_options {
  72         enum rebase_type type;
  73         const char *state_dir;
  74         struct commit *upstream;
  75         const char *upstream_name;
  76         const char *upstream_arg;
  77         char *head_name;
  78         struct object_id orig_head;
  79         struct commit *onto;
  80         const char *onto_name;
  81         const char *revisions;
  82         const char *switch_to;
  83         int root;
  84         struct object_id *squash_onto;
  85         struct commit *restrict_revision;
  86         int dont_finish_rebase;
  87         enum {
  88                 REBASE_NO_QUIET = 1<<0,
  89                 REBASE_VERBOSE = 1<<1,
  90                 REBASE_DIFFSTAT = 1<<2,
  91                 REBASE_FORCE = 1<<3,
  92                 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
  93         } flags;
  94         struct argv_array git_am_opts;
  95         const char *action;
  96         int signoff;
  97         int allow_rerere_autoupdate;
  98         int keep_empty;
  99         int autosquash;
 100         char *gpg_sign_opt;
 101         int autostash;
 102         char *cmd;
 103         int allow_empty_message;
 104         int rebase_merges, rebase_cousins;
 105         char *strategy, *strategy_opts;
 106         struct strbuf git_format_patch_opt;
 107 };
 108
 109 static int is_interactive(struct rebase_options *opts)
 110 {
 111         return opts->type == REBASE_INTERACTIVE ||
 112                 opts->type == REBASE_PRESERVE_MERGES;
 113 }
 114
 115 static void imply_interactive(struct rebase_options *opts, const char *option)
 116 {
 117         switch (opts->type) {
 118         case REBASE_AM:
 119                 die(_("%s requires an interactive rebase"), option);
 120                 break;
 121         case REBASE_INTERACTIVE:
 122         case REBASE_PRESERVE_MERGES:
 123                 break;
 124         case REBASE_MERGE:
 125                 /* we silently *upgrade* --merge to --interactive if needed */
 126         default:
 127                 opts->type = REBASE_INTERACTIVE; /* implied */
 128                 break;
 129         }
 130 }
 131
 132 /* Returns the filename prefixed by the state_dir */
 133 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
 134 {
 135         static struct strbuf path = STRBUF_INIT;
 136         static size_t prefix_len;
 137
 138         if (!prefix_len) {
 139                 strbuf_addf(&path, "%s/", opts->state_dir);
 140                 prefix_len = path.len;
 141         }
 142
 143         strbuf_setlen(&path, prefix_len);
 144         strbuf_addstr(&path, filename);
 145         return path.buf;
 146 }
 147
 148 /* Read one file, then strip line endings */
 149 static int read_one(const char *path, struct strbuf *buf)
 150 {
 151         if (strbuf_read_file(buf, path, 0) < 0)
 152                 return error_errno(_("could not read '%s'"), path);
 153         strbuf_trim_trailing_newline(buf);
 154         return 0;
 155 }
 156
 157 /* Initialize the rebase options from the state directory. */
 158 static int read_basic_state(struct rebase_options *opts)
 159 {
 160         struct strbuf head_name = STRBUF_INIT;
 161         struct strbuf buf = STRBUF_INIT;
 162         struct object_id oid;
 163
 164         if (read_one(state_dir_path("head-name", opts), &head_name) ||
 165             read_one(state_dir_path("onto", opts), &buf))
 166                 return -1;
 167         opts->head_name = starts_with(head_name.buf, "refs/") ?
 168                 xstrdup(head_name.buf) : NULL;
 169         strbuf_release(&head_name);
 170         if (get_oid(buf.buf, &oid))
 171                 return error(_("could not get 'onto': '%s'"), buf.buf);
 172         opts->onto = lookup_commit_or_die(&oid, buf.buf);
 173
 174         /*
 175          * We always write to orig-head, but interactive rebase used to write to
 176          * head. Fall back to reading from head to cover for the case that the
 177          * user upgraded git with an ongoing interactive rebase.
 178          */
 179         strbuf_reset(&buf);
 180         if (file_exists(state_dir_path("orig-head", opts))) {
 181                 if (read_one(state_dir_path("orig-head", opts), &buf))
 182                         return -1;
 183         } else if (read_one(state_dir_path("head", opts), &buf))
 184                 return -1;
 185         if (get_oid(buf.buf, &opts->orig_head))
 186                 return error(_("invalid orig-head: '%s'"), buf.buf);
 187
 188         strbuf_reset(&buf);
 189         if (read_one(state_dir_path("quiet", opts), &buf))
 190                 return -1;
 191         if (buf.len)
 192                 opts->flags &= ~REBASE_NO_QUIET;
 193         else
 194                 opts->flags |= REBASE_NO_QUIET;
 195
 196         if (file_exists(state_dir_path("verbose", opts)))
 197                 opts->flags |= REBASE_VERBOSE;
 198
 199         if (file_exists(state_dir_path("signoff", opts))) {
 200                 opts->signoff = 1;
 201                 opts->flags |= REBASE_FORCE;
 202         }
 203
 204         if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
 205                 strbuf_reset(&buf);
 206                 if (read_one(state_dir_path("allow_rerere_autoupdate", opts),
 207                             &buf))
 208                         return -1;
 209                 if (!strcmp(buf.buf, "--rerere-autoupdate"))
 210                         opts->allow_rerere_autoupdate = 1;
 211                 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
 212                         opts->allow_rerere_autoupdate = 0;
 213                 else
 214                         warning(_("ignoring invalid allow_rerere_autoupdate: "
 215                                   "'%s'"), buf.buf);
 216         } else
 217                 opts->allow_rerere_autoupdate = -1;
 218
 219         if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
 220                 strbuf_reset(&buf);
 221                 if (read_one(state_dir_path("gpg_sign_opt", opts),
 222                             &buf))
 223                         return -1;
 224                 free(opts->gpg_sign_opt);
 225                 opts->gpg_sign_opt = xstrdup(buf.buf);
 226         }
 227
 228         if (file_exists(state_dir_path("strategy", opts))) {
 229                 strbuf_reset(&buf);
 230                 if (read_one(state_dir_path("strategy", opts), &buf))
 231                         return -1;
 232                 free(opts->strategy);
 233                 opts->strategy = xstrdup(buf.buf);
 234         }
 235
 236         if (file_exists(state_dir_path("strategy_opts", opts))) {
 237                 strbuf_reset(&buf);
 238                 if (read_one(state_dir_path("strategy_opts", opts), &buf))
 239                         return -1;
 240                 free(opts->strategy_opts);
 241                 opts->strategy_opts = xstrdup(buf.buf);
 242         }
 243
 244         strbuf_release(&buf);
 245
 246         return 0;
 247 }
 248
 249 static int apply_autostash(struct rebase_options *opts)
 250 {
 251         const char *path = state_dir_path("autostash", opts);
 252         struct strbuf autostash = STRBUF_INIT;
 253         struct child_process stash_apply = CHILD_PROCESS_INIT;
 254
 255         if (!file_exists(path))
 256                 return 0;
 257
 258         if (read_one(path, &autostash))
 259                 return error(_("Could not read '%s'"), path);
 260         /* Ensure that the hash is not mistaken for a number */
 261         strbuf_addstr(&autostash, "^0");
 262         argv_array_pushl(&stash_apply.args,
 263                          "stash", "apply", autostash.buf, NULL);
 264         stash_apply.git_cmd = 1;
 265         stash_apply.no_stderr = stash_apply.no_stdout =
 266                 stash_apply.no_stdin = 1;
 267         if (!run_command(&stash_apply))
 268                 printf(_("Applied autostash.\n"));
 269         else {
 270                 struct argv_array args = ARGV_ARRAY_INIT;
 271                 int res = 0;
 272
 273                 argv_array_pushl(&args,
 274                                  "stash", "store", "-m", "autostash", "-q",
 275                                  autostash.buf, NULL);
 276                 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
 277                         res = error(_("Cannot store %s"), autostash.buf);
 278                 argv_array_clear(&args);
 279                 strbuf_release(&autostash);
 280                 if (res)
 281                         return res;
 282
 283                 fprintf(stderr,
 284                         _("Applying autostash resulted in conflicts.\n"
 285                           "Your changes are safe in the stash.\n"
 286                           "You can run \"git stash pop\" or \"git stash drop\" "
 287                           "at any time.\n"));
 288         }
 289
 290         strbuf_release(&autostash);
 291         return 0;
 292 }
 293
 294 static int finish_rebase(struct rebase_options *opts)
 295 {
 296         struct strbuf dir = STRBUF_INIT;
 297         const char *argv_gc_auto[] = { "gc", "--auto", NULL };
 298
 299         delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
 300         apply_autostash(opts);
 301         close_all_packs(the_repository->objects);
 302         /*
 303          * We ignore errors in 'gc --auto', since the
 304          * user should see them.
 305          */
 306         run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
 307         strbuf_addstr(&dir, opts->state_dir);
 308         remove_dir_recursively(&dir, 0);
 309         strbuf_release(&dir);
 310
 311         return 0;
 312 }
 313
 314 static struct commit *peel_committish(const char *name)
 315 {
 316         struct object *obj;
 317         struct object_id oid;
 318
 319         if (get_oid(name, &oid))
 320                 return NULL;
 321         obj = parse_object(the_repository, &oid);
 322         return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
 323 }
 324
 325 static void add_var(struct strbuf *buf, const char *name, const char *value)
 326 {
 327         if (!value)
 328                 strbuf_addf(buf, "unset %s; ", name);
 329         else {
 330                 strbuf_addf(buf, "%s=", name);
 331                 sq_quote_buf(buf, value);
 332                 strbuf_addstr(buf, "; ");
 333         }
 334 }
 335
 336 static const char *resolvemsg =
 337 N_("Resolve all conflicts manually, mark them as resolved with\n"
 338 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
 339 "You can instead skip this commit: run \"git rebase --skip\".\n"
 340 "To abort and get back to the state before \"git rebase\", run "
 341 "\"git rebase --abort\".");
 342
 343 static int run_specific_rebase(struct rebase_options *opts)
 344 {
 345         const char *argv[] = { NULL, NULL };
 346         struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
 347         int status;
 348         const char *backend, *backend_func;
 349
 350         if (opts->type == REBASE_INTERACTIVE) {
 351                 /* Run builtin interactive rebase */
 352                 struct child_process child = CHILD_PROCESS_INIT;
 353
 354                 argv_array_pushf(&child.env_array, "GIT_CHERRY_PICK_HELP=%s",
 355                                  resolvemsg);
 356                 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
 357                         argv_array_push(&child.env_array, "GIT_EDITOR=:");
 358                         opts->autosquash = 0;
 359                 }
 360
 361                 child.git_cmd = 1;
 362                 argv_array_push(&child.args, "rebase--interactive");
 363
 364                 if (opts->action)
 365                         argv_array_pushf(&child.args, "--%s", opts->action);
 366                 if (opts->keep_empty)
 367                         argv_array_push(&child.args, "--keep-empty");
 368                 if (opts->rebase_merges)
 369                         argv_array_push(&child.args, "--rebase-merges");
 370                 if (opts->rebase_cousins)
 371                         argv_array_push(&child.args, "--rebase-cousins");
 372                 if (opts->autosquash)
 373                         argv_array_push(&child.args, "--autosquash");
 374                 if (opts->flags & REBASE_VERBOSE)
 375                         argv_array_push(&child.args, "--verbose");
 376                 if (opts->flags & REBASE_FORCE)
 377                         argv_array_push(&child.args, "--no-ff");
 378                 if (opts->restrict_revision)
 379                         argv_array_pushf(&child.args,
 380                                          "--restrict-revision=^%s",
 381                                          oid_to_hex(&opts->restrict_revision->object.oid));
 382                 if (opts->upstream)
 383                         argv_array_pushf(&child.args, "--upstream=%s",
 384                                          oid_to_hex(&opts->upstream->object.oid));
 385                 if (opts->onto)
 386                         argv_array_pushf(&child.args, "--onto=%s",
 387                                          oid_to_hex(&opts->onto->object.oid));
 388                 if (opts->squash_onto)
 389                         argv_array_pushf(&child.args, "--squash-onto=%s",
 390                                          oid_to_hex(opts->squash_onto));
 391                 if (opts->onto_name)
 392                         argv_array_pushf(&child.args, "--onto-name=%s",
 393                                          opts->onto_name);
 394                 argv_array_pushf(&child.args, "--head-name=%s",
 395                                  opts->head_name ?
 396                                  opts->head_name : "detached HEAD");
 397                 if (opts->strategy)
 398                         argv_array_pushf(&child.args, "--strategy=%s",
 399                                          opts->strategy);
 400                 if (opts->strategy_opts)
 401                         argv_array_pushf(&child.args, "--strategy-opts=%s",
 402                                          opts->strategy_opts);
 403                 if (opts->switch_to)
 404                         argv_array_pushf(&child.args, "--switch-to=%s",
 405                                          opts->switch_to);
 406                 if (opts->cmd)
 407                         argv_array_pushf(&child.args, "--cmd=%s", opts->cmd);
 408                 if (opts->allow_empty_message)
 409                         argv_array_push(&child.args, "--allow-empty-message");
 410                 if (opts->allow_rerere_autoupdate > 0)
 411                         argv_array_push(&child.args, "--rerere-autoupdate");
 412                 else if (opts->allow_rerere_autoupdate == 0)
 413                         argv_array_push(&child.args, "--no-rerere-autoupdate");
 414                 if (opts->gpg_sign_opt)
 415                         argv_array_push(&child.args, opts->gpg_sign_opt);
 416                 if (opts->signoff)
 417                         argv_array_push(&child.args, "--signoff");
 418
 419                 status = run_command(&child);
 420                 goto finished_rebase;
 421         }
 422
 423         add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
 424         add_var(&script_snippet, "state_dir", opts->state_dir);
 425
 426         add_var(&script_snippet, "upstream_name", opts->upstream_name);
 427         add_var(&script_snippet, "upstream", opts->upstream ?
 428                 oid_to_hex(&opts->upstream->object.oid) : NULL);
 429         add_var(&script_snippet, "head_name",
 430                 opts->head_name ? opts->head_name : "detached HEAD");
 431         add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
 432         add_var(&script_snippet, "onto", opts->onto ?
 433                 oid_to_hex(&opts->onto->object.oid) : NULL);
 434         add_var(&script_snippet, "onto_name", opts->onto_name);
 435         add_var(&script_snippet, "revisions", opts->revisions);
 436         add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
 437                 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
 438         add_var(&script_snippet, "GIT_QUIET",
 439                 opts->flags & REBASE_NO_QUIET ? "" : "t");
 440         sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
 441         add_var(&script_snippet, "git_am_opt", buf.buf);
 442         strbuf_release(&buf);
 443         add_var(&script_snippet, "verbose",
 444                 opts->flags & REBASE_VERBOSE ? "t" : "");
 445         add_var(&script_snippet, "diffstat",
 446                 opts->flags & REBASE_DIFFSTAT ? "t" : "");
 447         add_var(&script_snippet, "force_rebase",
 448                 opts->flags & REBASE_FORCE ? "t" : "");
 449         if (opts->switch_to)
 450                 add_var(&script_snippet, "switch_to", opts->switch_to);
 451         add_var(&script_snippet, "action", opts->action ? opts->action : "");
 452         add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
 453         add_var(&script_snippet, "allow_rerere_autoupdate",
 454                 opts->allow_rerere_autoupdate < 0 ? "" :
 455                 opts->allow_rerere_autoupdate ?
 456                 "--rerere-autoupdate" : "--no-rerere-autoupdate");
 457         add_var(&script_snippet, "keep_empty", opts->keep_empty ? "yes" : "");
 458         add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
 459         add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
 460         add_var(&script_snippet, "cmd", opts->cmd);
 461         add_var(&script_snippet, "allow_empty_message",
 462                 opts->allow_empty_message ?  "--allow-empty-message" : "");
 463         add_var(&script_snippet, "rebase_merges",
 464                 opts->rebase_merges ? "t" : "");
 465         add_var(&script_snippet, "rebase_cousins",
 466                 opts->rebase_cousins ? "t" : "");
 467         add_var(&script_snippet, "strategy", opts->strategy);
 468         add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
 469         add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
 470         add_var(&script_snippet, "squash_onto",
 471                 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
 472         add_var(&script_snippet, "git_format_patch_opt",
 473                 opts->git_format_patch_opt.buf);
 474
 475         if (is_interactive(opts) &&
 476             !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
 477                 strbuf_addstr(&script_snippet,
 478                               "GIT_EDITOR=:; export GIT_EDITOR; ");
 479                 opts->autosquash = 0;
 480         }
 481
 482         switch (opts->type) {
 483         case REBASE_AM:
 484                 backend = "git-rebase--am";
 485                 backend_func = "git_rebase__am";
 486                 break;
 487         case REBASE_MERGE:
 488                 backend = "git-rebase--merge";
 489                 backend_func = "git_rebase__merge";
 490                 break;
 491         case REBASE_PRESERVE_MERGES:
 492                 backend = "git-rebase--preserve-merges";
 493                 backend_func = "git_rebase__preserve_merges";
 494                 break;
 495         default:
 496                 BUG("Unhandled rebase type %d", opts->type);
 497                 break;
 498         }
 499
 500         strbuf_addf(&script_snippet,
 501                     ". git-sh-setup && . git-rebase--common &&"
 502                     " . %s && %s", backend, backend_func);
 503         argv[0] = script_snippet.buf;
 504
 505         status = run_command_v_opt(argv, RUN_USING_SHELL);
 506 finished_rebase:
 507         if (opts->dont_finish_rebase)
 508                 ; /* do nothing */
 509         else if (opts->type == REBASE_INTERACTIVE)
 510                 ; /* interactive rebase cleans up after itself */
 511         else if (status == 0) {
 512                 if (!file_exists(state_dir_path("stopped-sha", opts)))
 513                         finish_rebase(opts);
 514         } else if (status == 2) {
 515                 struct strbuf dir = STRBUF_INIT;
 516
 517                 apply_autostash(opts);
 518                 strbuf_addstr(&dir, opts->state_dir);
 519                 remove_dir_recursively(&dir, 0);
 520                 strbuf_release(&dir);
 521                 die("Nothing to do");
 522         }
 523
 524         strbuf_release(&script_snippet);
 525
 526         return status ? -1 : 0;
 527 }
 528
 529 #define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
 530
 531 #define RESET_HEAD_DETACH (1<<0)
 532 #define RESET_HEAD_HARD (1<<1)
 533
 534 static int reset_head(struct object_id *oid, const char *action,
 535                       const char *switch_to_branch, unsigned flags,
 536                       const char *reflog_orig_head, const char *reflog_head)
 537 {
 538         unsigned detach_head = flags & RESET_HEAD_DETACH;
 539         unsigned reset_hard = flags & RESET_HEAD_HARD;
 540         struct object_id head_oid;
 541         struct tree_desc desc[2] = { { NULL }, { NULL } };
 542         struct lock_file lock = LOCK_INIT;
 543         struct unpack_trees_options unpack_tree_opts;
 544         struct tree *tree;
 545         const char *reflog_action;
 546         struct strbuf msg = STRBUF_INIT;
 547         size_t prefix_len;
 548         struct object_id *orig = NULL, oid_orig,
 549                 *old_orig = NULL, oid_old_orig;
 550         int ret = 0, nr = 0;
 551
 552         if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
 553                 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
 554
 555         if (hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
 556                 ret = -1;
 557                 goto leave_reset_head;
 558         }
 559
 560         if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
 561                 ret = error(_("could not determine HEAD revision"));
 562                 goto leave_reset_head;
 563         }
 564
 565         if (!oid)
 566                 oid = &head_oid;
 567
 568         memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
 569         setup_unpack_trees_porcelain(&unpack_tree_opts, action);
 570         unpack_tree_opts.head_idx = 1;
 571         unpack_tree_opts.src_index = the_repository->index;
 572         unpack_tree_opts.dst_index = the_repository->index;
 573         unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
 574         unpack_tree_opts.update = 1;
 575         unpack_tree_opts.merge = 1;
 576         if (!detach_head)
 577                 unpack_tree_opts.reset = 1;
 578
 579         if (read_index_unmerged(the_repository->index) < 0) {
 580                 ret = error(_("could not read index"));
 581                 goto leave_reset_head;
 582         }
 583
 584         if (!reset_hard && !fill_tree_descriptor(&desc[nr++], &head_oid)) {
 585                 ret = error(_("failed to find tree of %s"),
 586                             oid_to_hex(&head_oid));
 587                 goto leave_reset_head;
 588         }
 589
 590         if (!fill_tree_descriptor(&desc[nr++], oid)) {
 591                 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
 592                 goto leave_reset_head;
 593         }
 594
 595         if (unpack_trees(nr, desc, &unpack_tree_opts)) {
 596                 ret = -1;
 597                 goto leave_reset_head;
 598         }
 599
 600         tree = parse_tree_indirect(oid);
 601         prime_cache_tree(the_repository->index, tree);
 602
 603         if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
 604                 ret = error(_("could not write index"));
 605                 goto leave_reset_head;
 606         }
 607
 608         reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
 609         strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
 610         prefix_len = msg.len;
 611
 612         if (!get_oid("ORIG_HEAD", &oid_old_orig))
 613                 old_orig = &oid_old_orig;
 614         if (!get_oid("HEAD", &oid_orig)) {
 615                 orig = &oid_orig;
 616                 if (!reflog_orig_head) {
 617                         strbuf_addstr(&msg, "updating ORIG_HEAD");
 618                         reflog_orig_head = msg.buf;
 619                 }
 620                 update_ref(reflog_orig_head, "ORIG_HEAD", orig, old_orig, 0,
 621                            UPDATE_REFS_MSG_ON_ERR);
 622         } else if (old_orig)
 623                 delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
 624         if (!reflog_head) {
 625                 strbuf_setlen(&msg, prefix_len);
 626                 strbuf_addstr(&msg, "updating HEAD");
 627                 reflog_head = msg.buf;
 628         }
 629         if (!switch_to_branch)
 630                 ret = update_ref(reflog_head, "HEAD", oid, orig,
 631                                  detach_head ? REF_NO_DEREF : 0,
 632                                  UPDATE_REFS_MSG_ON_ERR);
 633         else {
 634                 ret = create_symref("HEAD", switch_to_branch, msg.buf);
 635                 if (!ret)
 636                         ret = update_ref(reflog_head, "HEAD", oid, NULL, 0,
 637                                          UPDATE_REFS_MSG_ON_ERR);
 638         }
 639
 640 leave_reset_head:
 641         strbuf_release(&msg);
 642         rollback_lock_file(&lock);
 643         while (nr)
 644                 free((void *)desc[--nr].buffer);
 645         return ret;
 646 }
 647
 648 static int rebase_config(const char *var, const char *value, void *data)
 649 {
 650         struct rebase_options *opts = data;
 651
 652         if (!strcmp(var, "rebase.stat")) {
 653                 if (git_config_bool(var, value))
 654                         opts->flags |= REBASE_DIFFSTAT;
 655                 else
 656                         opts->flags &= !REBASE_DIFFSTAT;
 657                 return 0;
 658         }
 659
 660         if (!strcmp(var, "rebase.autosquash")) {
 661                 opts->autosquash = git_config_bool(var, value);
 662                 return 0;
 663         }
 664
 665         if (!strcmp(var, "commit.gpgsign")) {
 666                 free(opts->gpg_sign_opt);
 667                 opts->gpg_sign_opt = git_config_bool(var, value) ?
 668                         xstrdup("-S") : NULL;
 669                 return 0;
 670         }
 671
 672         if (!strcmp(var, "rebase.autostash")) {
 673                 opts->autostash = git_config_bool(var, value);
 674                 return 0;
 675         }
 676
 677         return git_default_config(var, value, data);
 678 }
 679
 680 /*
 681  * Determines whether the commits in from..to are linear, i.e. contain
 682  * no merge commits. This function *expects* `from` to be an ancestor of
 683  * `to`.
 684  */
 685 static int is_linear_history(struct commit *from, struct commit *to)
 686 {
 687         while (to && to != from) {
 688                 parse_commit(to);
 689                 if (!to->parents)
 690                         return 1;
 691                 if (to->parents->next)
 692                         return 0;
 693                 to = to->parents->item;
 694         }
 695         return 1;
 696 }
 697
 698 static int can_fast_forward(struct commit *onto, struct object_id *head_oid,
 699                             struct object_id *merge_base)
 700 {
 701         struct commit *head = lookup_commit(the_repository, head_oid);
 702         struct commit_list *merge_bases;
 703         int res;
 704
 705         if (!head)
 706                 return 0;
 707
 708         merge_bases = get_merge_bases(onto, head);
 709         if (merge_bases && !merge_bases->next) {
 710                 oidcpy(merge_base, &merge_bases->item->object.oid);
 711                 res = oideq(merge_base, &onto->object.oid);
 712         } else {
 713                 oidcpy(merge_base, &null_oid);
 714                 res = 0;
 715         }
 716         free_commit_list(merge_bases);
 717         return res && is_linear_history(onto, head);
 718 }
 719
 720 /* -i followed by -m is still -i */
 721 static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
 722 {
 723         struct rebase_options *opts = opt->value;
 724
 725         BUG_ON_OPT_NEG(unset);
 726         BUG_ON_OPT_ARG(arg);
 727
 728         if (!is_interactive(opts))
 729                 opts->type = REBASE_MERGE;
 730
 731         return 0;
 732 }
 733
 734 /* -i followed by -p is still explicitly interactive, but -p alone is not */
 735 static int parse_opt_interactive(const struct option *opt, const char *arg,
 736                                  int unset)
 737 {
 738         struct rebase_options *opts = opt->value;
 739
 740         BUG_ON_OPT_NEG(unset);
 741         BUG_ON_OPT_ARG(arg);
 742
 743         opts->type = REBASE_INTERACTIVE;
 744         opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
 745
 746         return 0;
 747 }
 748
 749 static void NORETURN error_on_missing_default_upstream(void)
 750 {
 751         struct branch *current_branch = branch_get(NULL);
 752
 753         printf(_("%s\n"
 754                  "Please specify which branch you want to rebase against.\n"
 755                  "See git-rebase(1) for details.\n"
 756                  "\n"
 757                  "    git rebase '<branch>'\n"
 758                  "\n"),
 759                 current_branch ? _("There is no tracking information for "
 760                         "the current branch.") :
 761                         _("You are not currently on a branch."));
 762
 763         if (current_branch) {
 764                 const char *remote = current_branch->remote_name;
 765
 766                 if (!remote)
 767                         remote = _("<remote>");
 768
 769                 printf(_("If you wish to set tracking information for this "
 770                          "branch you can do so with:\n"
 771                          "\n"
 772                          "    git branch --set-upstream-to=%s/<branch> %s\n"
 773                          "\n"),
 774                        remote, current_branch->name);
 775         }
 776         exit(1);
 777 }
 778
 779 int cmd_rebase(int argc, const char **argv, const char *prefix)
 780 {
 781         struct rebase_options options = {
 782                 .type = REBASE_UNSPECIFIED,
 783                 .flags = REBASE_NO_QUIET,
 784                 .git_am_opts = ARGV_ARRAY_INIT,
 785                 .allow_rerere_autoupdate  = -1,
 786                 .allow_empty_message = 1,
 787                 .git_format_patch_opt = STRBUF_INIT,
 788         };
 789         const char *branch_name;
 790         int ret, flags, total_argc, in_progress = 0;
 791         int ok_to_skip_pre_rebase = 0;
 792         struct strbuf msg = STRBUF_INIT;
 793         struct strbuf revisions = STRBUF_INIT;
 794         struct strbuf buf = STRBUF_INIT;
 795         struct object_id merge_base;
 796         enum {
 797                 NO_ACTION,
 798                 ACTION_CONTINUE,
 799                 ACTION_SKIP,
 800                 ACTION_ABORT,
 801                 ACTION_QUIT,
 802                 ACTION_EDIT_TODO,
 803                 ACTION_SHOW_CURRENT_PATCH,
 804         } action = NO_ACTION;
 805         const char *gpg_sign = NULL;
 806         struct string_list exec = STRING_LIST_INIT_NODUP;
 807         const char *rebase_merges = NULL;
 808         int fork_point = -1;
 809         struct string_list strategy_options = STRING_LIST_INIT_NODUP;
 810         struct object_id squash_onto;
 811         char *squash_onto_name = NULL;
 812         struct option builtin_rebase_options[] = {
 813                 OPT_STRING(0, "onto", &options.onto_name,
 814                            N_("revision"),
 815                            N_("rebase onto given branch instead of upstream")),
 816                 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
 817                          N_("allow pre-rebase hook to run")),
 818                 OPT_NEGBIT('q', "quiet", &options.flags,
 819                            N_("be quiet. implies --no-stat"),
 820                            REBASE_NO_QUIET| REBASE_VERBOSE | REBASE_DIFFSTAT),
 821                 OPT_BIT('v', "verbose", &options.flags,
 822                         N_("display a diffstat of what changed upstream"),
 823                         REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
 824                 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
 825                         N_("do not show diffstat of what changed upstream"),
 826                         PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
 827                 OPT_BOOL(0, "signoff", &options.signoff,
 828                          N_("add a Signed-off-by: line to each commit")),
 829                 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
 830                                   NULL, N_("passed to 'git am'"),
 831                                   PARSE_OPT_NOARG),
 832                 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
 833                                   &options.git_am_opts, NULL,
 834                                   N_("passed to 'git am'"), PARSE_OPT_NOARG),
 835                 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
 836                                   N_("passed to 'git am'"), PARSE_OPT_NOARG),
 837                 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
 838                                   N_("passed to 'git apply'"), 0),
 839                 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
 840                                   N_("action"), N_("passed to 'git apply'"), 0),
 841                 OPT_BIT('f', "force-rebase", &options.flags,
 842                         N_("cherry-pick all commits, even if unchanged"),
 843                         REBASE_FORCE),
 844                 OPT_BIT(0, "no-ff", &options.flags,
 845                         N_("cherry-pick all commits, even if unchanged"),
 846                         REBASE_FORCE),
 847                 OPT_CMDMODE(0, "continue", &action, N_("continue"),
 848                             ACTION_CONTINUE),
 849                 OPT_CMDMODE(0, "skip", &action,
 850                             N_("skip current patch and continue"), ACTION_SKIP),
 851                 OPT_CMDMODE(0, "abort", &action,
 852                             N_("abort and check out the original branch"),
 853                             ACTION_ABORT),
 854                 OPT_CMDMODE(0, "quit", &action,
 855                             N_("abort but keep HEAD where it is"), ACTION_QUIT),
 856                 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
 857                             "during an interactive rebase"), ACTION_EDIT_TODO),
 858                 OPT_CMDMODE(0, "show-current-patch", &action,
 859                             N_("show the patch file being applied or merged"),
 860                             ACTION_SHOW_CURRENT_PATCH),
 861                 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
 862                         N_("use merging strategies to rebase"),
 863                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
 864                         parse_opt_merge },
 865                 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
 866                         N_("let the user edit the list of commits to rebase"),
 867                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
 868                         parse_opt_interactive },
 869                 OPT_SET_INT('p', "preserve-merges", &options.type,
 870                             N_("try to recreate merges instead of ignoring "
 871                                "them"), REBASE_PRESERVE_MERGES),
 872                 OPT_BOOL(0, "rerere-autoupdate",
 873                          &options.allow_rerere_autoupdate,
 874                          N_("allow rerere to update index  with resolved "
 875                             "conflict")),
 876                 OPT_BOOL('k', "keep-empty", &options.keep_empty,
 877                          N_("preserve empty commits during rebase")),
 878                 OPT_BOOL(0, "autosquash", &options.autosquash,
 879                          N_("move commits that begin with "
 880                             "squash!/fixup! under -i")),
 881                 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
 882                         N_("GPG-sign commits"),
 883                         PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
 884                 OPT_BOOL(0, "autostash", &options.autostash,
 885                          N_("automatically stash/stash pop before and after")),
 886                 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
 887                                 N_("add exec lines after each commit of the "
 888                                    "editable list")),
 889                 OPT_BOOL(0, "allow-empty-message",
 890                          &options.allow_empty_message,
 891                          N_("allow rebasing commits with empty messages")),
 892                 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
 893                         N_("mode"),
 894                         N_("try to rebase merges instead of skipping them"),
 895                         PARSE_OPT_OPTARG, NULL, (intptr_t)""},
 896                 OPT_BOOL(0, "fork-point", &fork_point,
 897                          N_("use 'merge-base --fork-point' to refine upstream")),
 898                 OPT_STRING('s', "strategy", &options.strategy,
 899                            N_("strategy"), N_("use the given merge strategy")),
 900                 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
 901                                 N_("option"),
 902                                 N_("pass the argument through to the merge "
 903                                    "strategy")),
 904                 OPT_BOOL(0, "root", &options.root,
 905                          N_("rebase all reachable commits up to the root(s)")),
 906                 OPT_END(),
 907         };
 908         int i;
 909
 910         /*
 911          * NEEDSWORK: Once the builtin rebase has been tested enough
 912          * and git-legacy-rebase.sh is retired to contrib/, this preamble
 913          * can be removed.
 914          */
 915
 916         if (!use_builtin_rebase()) {
 917                 const char *path = mkpath("%s/git-legacy-rebase",
 918                                           git_exec_path());
 919
 920                 if (sane_execvp(path, (char **)argv) < 0)
 921                         die_errno(_("could not exec %s"), path);
 922                 else
 923                         BUG("sane_execvp() returned???");
 924         }
 925
 926         if (argc == 2 && !strcmp(argv[1], "-h"))
 927                 usage_with_options(builtin_rebase_usage,
 928                                    builtin_rebase_options);
 929
 930         prefix = setup_git_directory();
 931         trace_repo_setup(prefix);
 932         setup_work_tree();
 933
 934         git_config(rebase_config, &options);
 935
 936         strbuf_reset(&buf);
 937         strbuf_addf(&buf, "%s/applying", apply_dir());
 938         if(file_exists(buf.buf))
 939                 die(_("It looks like 'git am' is in progress. Cannot rebase."));
 940
 941         if (is_directory(apply_dir())) {
 942                 options.type = REBASE_AM;
 943                 options.state_dir = apply_dir();
 944         } else if (is_directory(merge_dir())) {
 945                 strbuf_reset(&buf);
 946                 strbuf_addf(&buf, "%s/rewritten", merge_dir());
 947                 if (is_directory(buf.buf)) {
 948                         options.type = REBASE_PRESERVE_MERGES;
 949                         options.flags |= REBASE_INTERACTIVE_EXPLICIT;
 950                 } else {
 951                         strbuf_reset(&buf);
 952                         strbuf_addf(&buf, "%s/interactive", merge_dir());
 953                         if(file_exists(buf.buf)) {
 954                                 options.type = REBASE_INTERACTIVE;
 955                                 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
 956                         } else
 957                                 options.type = REBASE_MERGE;
 958                 }
 959                 options.state_dir = merge_dir();
 960         }
 961
 962         if (options.type != REBASE_UNSPECIFIED)
 963                 in_progress = 1;
 964
 965         total_argc = argc;
 966         argc = parse_options(argc, argv, prefix,
 967                              builtin_rebase_options,
 968                              builtin_rebase_usage, 0);
 969
 970         if (action != NO_ACTION && total_argc != 2) {
 971                 usage_with_options(builtin_rebase_usage,
 972                                    builtin_rebase_options);
 973         }
 974
 975         if (argc > 2)
 976                 usage_with_options(builtin_rebase_usage,
 977                                    builtin_rebase_options);
 978
 979         if (action != NO_ACTION && !in_progress)
 980                 die(_("No rebase in progress?"));
 981
 982         if (action == ACTION_EDIT_TODO && !is_interactive(&options))
 983                 die(_("The --edit-todo action can only be used during "
 984                       "interactive rebase."));
 985
 986         switch (action) {
 987         case ACTION_CONTINUE: {
 988                 struct object_id head;
 989                 struct lock_file lock_file = LOCK_INIT;
 990                 int fd;
 991
 992                 options.action = "continue";
 993
 994                 /* Sanity check */
 995                 if (get_oid("HEAD", &head))
 996                         die(_("Cannot read HEAD"));
 997
 998                 fd = hold_locked_index(&lock_file, 0);
 999                 if (read_index(the_repository->index) < 0)
1000                         die(_("could not read index"));
1001                 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1002                               NULL);
1003                 if (0 <= fd)
1004                         update_index_if_able(the_repository->index,
1005                                              &lock_file);
1006                 rollback_lock_file(&lock_file);
1007
1008                 if (has_unstaged_changes(1)) {
1009                         puts(_("You must edit all merge conflicts and then\n"
1010                                "mark them as resolved using git add"));
1011                         exit(1);
1012                 }
1013                 if (read_basic_state(&options))
1014                         exit(1);
1015                 goto run_rebase;
1016         }
1017         case ACTION_SKIP: {
1018                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1019
1020                 options.action = "skip";
1021
1022                 rerere_clear(&merge_rr);
1023                 string_list_clear(&merge_rr, 1);
1024
1025                 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1026                                NULL, NULL) < 0)
1027                         die(_("could not discard worktree changes"));
1028                 remove_branch_state();
1029                 if (read_basic_state(&options))
1030                         exit(1);
1031                 goto run_rebase;
1032         }
1033         case ACTION_ABORT: {
1034                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1035                 options.action = "abort";
1036
1037                 rerere_clear(&merge_rr);
1038                 string_list_clear(&merge_rr, 1);
1039
1040                 if (read_basic_state(&options))
1041                         exit(1);
1042                 if (reset_head(&options.orig_head, "reset",
1043                                options.head_name, RESET_HEAD_HARD,
1044                                NULL, NULL) < 0)
1045                         die(_("could not move back to %s"),
1046                             oid_to_hex(&options.orig_head));
1047                 remove_branch_state();
1048                 ret = finish_rebase(&options);
1049                 goto cleanup;
1050         }
1051         case ACTION_QUIT: {
1052                 strbuf_reset(&buf);
1053                 strbuf_addstr(&buf, options.state_dir);
1054                 ret = !!remove_dir_recursively(&buf, 0);
1055                 if (ret)
1056                         die(_("could not remove '%s'"), options.state_dir);
1057                 goto cleanup;
1058         }
1059         case ACTION_EDIT_TODO:
1060                 options.action = "edit-todo";
1061                 options.dont_finish_rebase = 1;
1062                 goto run_rebase;
1063         case ACTION_SHOW_CURRENT_PATCH:
1064                 options.action = "show-current-patch";
1065                 options.dont_finish_rebase = 1;
1066                 goto run_rebase;
1067         case NO_ACTION:
1068                 break;
1069         default:
1070                 BUG("action: %d", action);
1071         }
1072
1073         /* Make sure no rebase is in progress */
1074         if (in_progress) {
1075                 const char *last_slash = strrchr(options.state_dir, '/');
1076                 const char *state_dir_base =
1077                         last_slash ? last_slash + 1 : options.state_dir;
1078                 const char *cmd_live_rebase =
1079                         "git rebase (--continue | --abort | --skip)";
1080                 strbuf_reset(&buf);
1081                 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1082                 die(_("It seems that there is already a %s directory, and\n"
1083                       "I wonder if you are in the middle of another rebase.  "
1084                       "If that is the\n"
1085                       "case, please try\n\t%s\n"
1086                       "If that is not the case, please\n\t%s\n"
1087                       "and run me again.  I am stopping in case you still "
1088                       "have something\n"
1089                       "valuable there.\n"),
1090                     state_dir_base, cmd_live_rebase, buf.buf);
1091         }
1092
1093         for (i = 0; i < options.git_am_opts.argc; i++) {
1094                 const char *option = options.git_am_opts.argv[i], *p;
1095                 if (!strcmp(option, "--committer-date-is-author-date") ||
1096                     !strcmp(option, "--ignore-date") ||
1097                     !strcmp(option, "--whitespace=fix") ||
1098                     !strcmp(option, "--whitespace=strip"))
1099                         options.flags |= REBASE_FORCE;
1100                 else if (skip_prefix(option, "-C", &p)) {
1101                         while (*p)
1102                                 if (!isdigit(*(p++)))
1103                                         die(_("switch `C' expects a "
1104                                               "numerical value"));
1105                 } else if (skip_prefix(option, "--whitespace=", &p)) {
1106                         if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1107                             strcmp(p, "error") && strcmp(p, "error-all"))
1108                                 die("Invalid whitespace option: '%s'", p);
1109                 }
1110         }
1111
1112         if (!(options.flags & REBASE_NO_QUIET))
1113                 argv_array_push(&options.git_am_opts, "-q");
1114
1115         if (options.keep_empty)
1116                 imply_interactive(&options, "--keep-empty");
1117
1118         if (gpg_sign) {
1119                 free(options.gpg_sign_opt);
1120                 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1121         }
1122
1123         if (exec.nr) {
1124                 int i;
1125
1126                 imply_interactive(&options, "--exec");
1127
1128                 strbuf_reset(&buf);
1129                 for (i = 0; i < exec.nr; i++)
1130                         strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1131                 options.cmd = xstrdup(buf.buf);
1132         }
1133
1134         if (rebase_merges) {
1135                 if (!*rebase_merges)
1136                         ; /* default mode; do nothing */
1137                 else if (!strcmp("rebase-cousins", rebase_merges))
1138                         options.rebase_cousins = 1;
1139                 else if (strcmp("no-rebase-cousins", rebase_merges))
1140                         die(_("Unknown mode: %s"), rebase_merges);
1141                 options.rebase_merges = 1;
1142                 imply_interactive(&options, "--rebase-merges");
1143         }
1144
1145         if (strategy_options.nr) {
1146                 int i;
1147
1148                 if (!options.strategy)
1149                         options.strategy = "recursive";
1150
1151                 strbuf_reset(&buf);
1152                 for (i = 0; i < strategy_options.nr; i++)
1153                         strbuf_addf(&buf, " --%s",
1154                                     strategy_options.items[i].string);
1155                 options.strategy_opts = xstrdup(buf.buf);
1156         }
1157
1158         if (options.strategy) {
1159                 options.strategy = xstrdup(options.strategy);
1160                 switch (options.type) {
1161                 case REBASE_AM:
1162                         die(_("--strategy requires --merge or --interactive"));
1163                 case REBASE_MERGE:
1164                 case REBASE_INTERACTIVE:
1165                 case REBASE_PRESERVE_MERGES:
1166                         /* compatible */
1167                         break;
1168                 case REBASE_UNSPECIFIED:
1169                         options.type = REBASE_MERGE;
1170                         break;
1171                 default:
1172                         BUG("unhandled rebase type (%d)", options.type);
1173                 }
1174         }
1175
1176         if (options.root && !options.onto_name)
1177                 imply_interactive(&options, "--root without --onto");
1178
1179         if (isatty(2) && options.flags & REBASE_NO_QUIET)
1180                 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1181
1182         switch (options.type) {
1183         case REBASE_MERGE:
1184         case REBASE_INTERACTIVE:
1185         case REBASE_PRESERVE_MERGES:
1186                 options.state_dir = merge_dir();
1187                 break;
1188         case REBASE_AM:
1189                 options.state_dir = apply_dir();
1190                 break;
1191         default:
1192                 /* the default rebase backend is `--am` */
1193                 options.type = REBASE_AM;
1194                 options.state_dir = apply_dir();
1195                 break;
1196         }
1197
1198         if (options.git_am_opts.argc) {
1199                 /* all am options except -q are compatible only with --am */
1200                 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1201                         if (strcmp(options.git_am_opts.argv[i], "-q"))
1202                                 break;
1203
1204                 if (is_interactive(&options) && i >= 0)
1205                         die(_("error: cannot combine interactive options "
1206                               "(--interactive, --exec, --rebase-merges, "
1207                               "--preserve-merges, --keep-empty, --root + "
1208                               "--onto) with am options (%s)"), buf.buf);
1209                 if (options.type == REBASE_MERGE && i >= 0)
1210                         die(_("error: cannot combine merge options (--merge, "
1211                               "--strategy, --strategy-option) with am options "
1212                               "(%s)"), buf.buf);
1213         }
1214
1215         if (options.signoff) {
1216                 if (options.type == REBASE_PRESERVE_MERGES)
1217                         die("cannot combine '--signoff' with "
1218                             "'--preserve-merges'");
1219                 argv_array_push(&options.git_am_opts, "--signoff");
1220                 options.flags |= REBASE_FORCE;
1221         }
1222
1223         if (options.type == REBASE_PRESERVE_MERGES)
1224                 /*
1225                  * Note: incompatibility with --signoff handled in signoff block above
1226                  * Note: incompatibility with --interactive is just a strong warning;
1227                  *       git-rebase.txt caveats with "unless you know what you are doing"
1228                  */
1229                 if (options.rebase_merges)
1230                         die(_("error: cannot combine '--preserve-merges' with "
1231                               "'--rebase-merges'"));
1232
1233         if (options.rebase_merges) {
1234                 if (strategy_options.nr)
1235                         die(_("error: cannot combine '--rebase-merges' with "
1236                               "'--strategy-option'"));
1237                 if (options.strategy)
1238                         die(_("error: cannot combine '--rebase-merges' with "
1239                               "'--strategy'"));
1240         }
1241
1242         if (!options.root) {
1243                 if (argc < 1) {
1244                         struct branch *branch;
1245
1246                         branch = branch_get(NULL);
1247                         options.upstream_name = branch_get_upstream(branch,
1248                                                                     NULL);
1249                         if (!options.upstream_name)
1250                                 error_on_missing_default_upstream();
1251                         if (fork_point < 0)
1252                                 fork_point = 1;
1253                 } else {
1254                         options.upstream_name = argv[0];
1255                         argc--;
1256                         argv++;
1257                         if (!strcmp(options.upstream_name, "-"))
1258                                 options.upstream_name = "@{-1}";
1259                 }
1260                 options.upstream = peel_committish(options.upstream_name);
1261                 if (!options.upstream)
1262                         die(_("invalid upstream '%s'"), options.upstream_name);
1263                 options.upstream_arg = options.upstream_name;
1264         } else {
1265                 if (!options.onto_name) {
1266                         if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1267                                         &squash_onto, NULL, NULL) < 0)
1268                                 die(_("Could not create new root commit"));
1269                         options.squash_onto = &squash_onto;
1270                         options.onto_name = squash_onto_name =
1271                                 xstrdup(oid_to_hex(&squash_onto));
1272                 }
1273                 options.upstream_name = NULL;
1274                 options.upstream = NULL;
1275                 if (argc > 1)
1276                         usage_with_options(builtin_rebase_usage,
1277                                            builtin_rebase_options);
1278                 options.upstream_arg = "--root";
1279         }
1280
1281         /* Make sure the branch to rebase onto is valid. */
1282         if (!options.onto_name)
1283                 options.onto_name = options.upstream_name;
1284         if (strstr(options.onto_name, "...")) {
1285                 if (get_oid_mb(options.onto_name, &merge_base) < 0)
1286                         die(_("'%s': need exactly one merge base"),
1287                             options.onto_name);
1288                 options.onto = lookup_commit_or_die(&merge_base,
1289                                                     options.onto_name);
1290         } else {
1291                 options.onto = peel_committish(options.onto_name);
1292                 if (!options.onto)
1293                         die(_("Does not point to a valid commit '%s'"),
1294                                 options.onto_name);
1295         }
1296
1297         /*
1298          * If the branch to rebase is given, that is the branch we will rebase
1299          * branch_name -- branch/commit being rebased, or
1300          *                HEAD (already detached)
1301          * orig_head -- commit object name of tip of the branch before rebasing
1302          * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
1303          */
1304         if (argc == 1) {
1305                 /* Is it "rebase other branchname" or "rebase other commit"? */
1306                 branch_name = argv[0];
1307                 options.switch_to = argv[0];
1308
1309                 /* Is it a local branch? */
1310                 strbuf_reset(&buf);
1311                 strbuf_addf(&buf, "refs/heads/%s", branch_name);
1312                 if (!read_ref(buf.buf, &options.orig_head))
1313                         options.head_name = xstrdup(buf.buf);
1314                 /* If not is it a valid ref (branch or commit)? */
1315                 else if (!get_oid(branch_name, &options.orig_head))
1316                         options.head_name = NULL;
1317                 else
1318                         die(_("fatal: no such branch/commit '%s'"),
1319                             branch_name);
1320         } else if (argc == 0) {
1321                 /* Do not need to switch branches, we are already on it. */
1322                 options.head_name =
1323                         xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
1324                                          &flags));
1325                 if (!options.head_name)
1326                         die(_("No such ref: %s"), "HEAD");
1327                 if (flags & REF_ISSYMREF) {
1328                         if (!skip_prefix(options.head_name,
1329                                          "refs/heads/", &branch_name))
1330                                 branch_name = options.head_name;
1331
1332                 } else {
1333                         free(options.head_name);
1334                         options.head_name = NULL;
1335                         branch_name = "HEAD";
1336                 }
1337                 if (get_oid("HEAD", &options.orig_head))
1338                         die(_("Could not resolve HEAD to a revision"));
1339         } else
1340                 BUG("unexpected number of arguments left to parse");
1341
1342         if (fork_point > 0) {
1343                 struct commit *head =
1344                         lookup_commit_reference(the_repository,
1345                                                 &options.orig_head);
1346                 options.restrict_revision =
1347                         get_fork_point(options.upstream_name, head);
1348         }
1349
1350         if (read_index(the_repository->index) < 0)
1351                 die(_("could not read index"));
1352
1353         if (options.autostash) {
1354                 struct lock_file lock_file = LOCK_INIT;
1355                 int fd;
1356
1357                 fd = hold_locked_index(&lock_file, 0);
1358                 refresh_cache(REFRESH_QUIET);
1359                 if (0 <= fd)
1360                         update_index_if_able(&the_index, &lock_file);
1361                 rollback_lock_file(&lock_file);
1362
1363                 if (has_unstaged_changes(1) || has_uncommitted_changes(1)) {
1364                         const char *autostash =
1365                                 state_dir_path("autostash", &options);
1366                         struct child_process stash = CHILD_PROCESS_INIT;
1367                         struct object_id oid;
1368                         struct commit *head =
1369                                 lookup_commit_reference(the_repository,
1370                                                         &options.orig_head);
1371
1372                         argv_array_pushl(&stash.args,
1373                                          "stash", "create", "autostash", NULL);
1374                         stash.git_cmd = 1;
1375                         stash.no_stdin = 1;
1376                         strbuf_reset(&buf);
1377                         if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
1378                                 die(_("Cannot autostash"));
1379                         strbuf_trim_trailing_newline(&buf);
1380                         if (get_oid(buf.buf, &oid))
1381                                 die(_("Unexpected stash response: '%s'"),
1382                                     buf.buf);
1383                         strbuf_reset(&buf);
1384                         strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
1385
1386                         if (safe_create_leading_directories_const(autostash))
1387                                 die(_("Could not create directory for '%s'"),
1388                                     options.state_dir);
1389                         write_file(autostash, "%s", oid_to_hex(&oid));
1390                         printf(_("Created autostash: %s\n"), buf.buf);
1391                         if (reset_head(&head->object.oid, "reset --hard",
1392                                        NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
1393                                 die(_("could not reset --hard"));
1394                         printf(_("HEAD is now at %s"),
1395                                find_unique_abbrev(&head->object.oid,
1396                                                   DEFAULT_ABBREV));
1397                         strbuf_reset(&buf);
1398                         pp_commit_easy(CMIT_FMT_ONELINE, head, &buf);
1399                         if (buf.len > 0)
1400                                 printf(" %s", buf.buf);
1401                         putchar('\n');
1402
1403                         if (discard_index(the_repository->index) < 0 ||
1404                                 read_index(the_repository->index) < 0)
1405                                 die(_("could not read index"));
1406                 }
1407         }
1408
1409         if (require_clean_work_tree("rebase",
1410                                     _("Please commit or stash them."), 1, 1)) {
1411                 ret = 1;
1412                 goto cleanup;
1413         }
1414
1415         /*
1416          * Now we are rebasing commits upstream..orig_head (or with --root,
1417          * everything leading up to orig_head) on top of onto.
1418          */
1419
1420         /*
1421          * Check if we are already based on onto with linear history,
1422          * but this should be done only when upstream and onto are the same
1423          * and if this is not an interactive rebase.
1424          */
1425         if (can_fast_forward(options.onto, &options.orig_head, &merge_base) &&
1426             !is_interactive(&options) && !options.restrict_revision &&
1427             options.upstream &&
1428             !oidcmp(&options.upstream->object.oid, &options.onto->object.oid)) {
1429                 int flag;
1430
1431                 if (!(options.flags & REBASE_FORCE)) {
1432                         /* Lazily switch to the target branch if needed... */
1433                         if (options.switch_to) {
1434                                 struct object_id oid;
1435
1436                                 if (get_oid(options.switch_to, &oid) < 0) {
1437                                         ret = !!error(_("could not parse '%s'"),
1438                                                       options.switch_to);
1439                                         goto cleanup;
1440                                 }
1441
1442                                 strbuf_reset(&buf);
1443                                 strbuf_addf(&buf, "rebase: checkout %s",
1444                                             options.switch_to);
1445                                 if (reset_head(&oid, "checkout",
1446                                                options.head_name, 0,
1447                                                NULL, NULL) < 0) {
1448                                         ret = !!error(_("could not switch to "
1449                                                         "%s"),
1450                                                       options.switch_to);
1451                                         goto cleanup;
1452                                 }
1453                         }
1454
1455                         if (!(options.flags & REBASE_NO_QUIET))
1456                                 ; /* be quiet */
1457                         else if (!strcmp(branch_name, "HEAD") &&
1458                                  resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1459                                 puts(_("HEAD is up to date."));
1460                         else
1461                                 printf(_("Current branch %s is up to date.\n"),
1462                                        branch_name);
1463                         ret = !!finish_rebase(&options);
1464                         goto cleanup;
1465                 } else if (!(options.flags & REBASE_NO_QUIET))
1466                         ; /* be quiet */
1467                 else if (!strcmp(branch_name, "HEAD") &&
1468                          resolve_ref_unsafe("HEAD", 0, NULL, &flag))
1469                         puts(_("HEAD is up to date, rebase forced."));
1470                 else
1471                         printf(_("Current branch %s is up to date, rebase "
1472                                  "forced.\n"), branch_name);
1473         }
1474
1475         /* If a hook exists, give it a chance to interrupt*/
1476         if (!ok_to_skip_pre_rebase &&
1477             run_hook_le(NULL, "pre-rebase", options.upstream_arg,
1478                         argc ? argv[0] : NULL, NULL))
1479                 die(_("The pre-rebase hook refused to rebase."));
1480
1481         if (options.flags & REBASE_DIFFSTAT) {
1482                 struct diff_options opts;
1483
1484                 if (options.flags & REBASE_VERBOSE)
1485                         printf(_("Changes from %s to %s:\n"),
1486                                 oid_to_hex(&merge_base),
1487                                 oid_to_hex(&options.onto->object.oid));
1488
1489                 /* We want color (if set), but no pager */
1490                 diff_setup(&opts);
1491                 opts.stat_width = -1; /* use full terminal width */
1492                 opts.stat_graph_width = -1; /* respect statGraphWidth config */
1493                 opts.output_format |=
1494                         DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
1495                 opts.detect_rename = DIFF_DETECT_RENAME;
1496                 diff_setup_done(&opts);
1497                 diff_tree_oid(&merge_base, &options.onto->object.oid,
1498                               "", &opts);
1499                 diffcore_std(&opts);
1500                 diff_flush(&opts);
1501         }
1502
1503         if (is_interactive(&options))
1504                 goto run_rebase;
1505
1506         /* Detach HEAD and reset the tree */
1507         if (options.flags & REBASE_NO_QUIET)
1508                 printf(_("First, rewinding head to replay your work on top of "
1509                          "it...\n"));
1510
1511         strbuf_addf(&msg, "rebase: checkout %s", options.onto_name);
1512         if (reset_head(&options.onto->object.oid, "checkout", NULL,
1513                        RESET_HEAD_DETACH, NULL, msg.buf))
1514                 die(_("Could not detach HEAD"));
1515         strbuf_release(&msg);
1516
1517         /*
1518          * If the onto is a proper descendant of the tip of the branch, then
1519          * we just fast-forwarded.
1520          */
1521         strbuf_reset(&msg);
1522         if (!oidcmp(&merge_base, &options.orig_head)) {
1523                 printf(_("Fast-forwarded %s to %s. \n"),
1524                         branch_name, options.onto_name);
1525                 strbuf_addf(&msg, "rebase finished: %s onto %s",
1526                         options.head_name ? options.head_name : "detached HEAD",
1527                         oid_to_hex(&options.onto->object.oid));
1528                 reset_head(NULL, "Fast-forwarded", options.head_name, 0,
1529                            "HEAD", msg.buf);
1530                 strbuf_release(&msg);
1531                 ret = !!finish_rebase(&options);
1532                 goto cleanup;
1533         }
1534
1535         strbuf_addf(&revisions, "%s..%s",
1536                     options.root ? oid_to_hex(&options.onto->object.oid) :
1537                     (options.restrict_revision ?
1538                      oid_to_hex(&options.restrict_revision->object.oid) :
1539                      oid_to_hex(&options.upstream->object.oid)),
1540                     oid_to_hex(&options.orig_head));
1541
1542         options.revisions = revisions.buf;
1543
1544 run_rebase:
1545         ret = !!run_specific_rebase(&options);
1546
1547 cleanup:
1548         strbuf_release(&revisions);
1549         free(options.head_name);
1550         free(options.gpg_sign_opt);
1551         free(options.cmd);
1552         free(squash_onto_name);
1553         return ret;
1554 }