git.oblomov.eu Git - git/blob - builtin/rebase.c

   1 /*
   2  * "git rebase" builtin command
   3  *
   4  * Copyright (c) 2018 Pratik Karki
   5  */
   6
   7 #define USE_THE_INDEX_COMPATIBILITY_MACROS
   8 #include "builtin.h"
   9 #include "run-command.h"
  10 #include "exec-cmd.h"
  11 #include "argv-array.h"
  12 #include "dir.h"
  13 #include "packfile.h"
  14 #include "refs.h"
  15 #include "quote.h"
  16 #include "config.h"
  17 #include "cache-tree.h"
  18 #include "unpack-trees.h"
  19 #include "lockfile.h"
  20 #include "parse-options.h"
  21 #include "commit.h"
  22 #include "diff.h"
  23 #include "wt-status.h"
  24 #include "revision.h"
  25 #include "commit-reach.h"
  26 #include "rerere.h"
  27 #include "branch.h"
  28 #include "sequencer.h"
  29 #include "rebase-interactive.h"
  30
  31 static char const * const builtin_rebase_usage[] = {
  32         N_("git rebase [-i] [options] [--exec <cmd>] "
  33                 "[--onto <newbase> | --keep-base] [<upstream> [<branch>]]"),
  34         N_("git rebase [-i] [options] [--exec <cmd>] [--onto <newbase>] "
  35                 "--root [<branch>]"),
  36         N_("git rebase --continue | --abort | --skip | --edit-todo"),
  37         NULL
  38 };
  39
  40 static GIT_PATH_FUNC(path_squash_onto, "rebase-merge/squash-onto")
  41 static GIT_PATH_FUNC(path_interactive, "rebase-merge/interactive")
  42 static GIT_PATH_FUNC(apply_dir, "rebase-apply")
  43 static GIT_PATH_FUNC(merge_dir, "rebase-merge")
  44
  45 enum rebase_type {
  46         REBASE_UNSPECIFIED = -1,
  47         REBASE_APPLY,
  48         REBASE_MERGE,
  49         REBASE_PRESERVE_MERGES
  50 };
  51
  52 enum empty_type {
  53         EMPTY_UNSPECIFIED = -1,
  54         EMPTY_DROP,
  55         EMPTY_KEEP,
  56         EMPTY_ASK
  57 };
  58
  59 struct rebase_options {
  60         enum rebase_type type;
  61         enum empty_type empty;
  62         const char *default_backend;
  63         const char *state_dir;
  64         struct commit *upstream;
  65         const char *upstream_name;
  66         const char *upstream_arg;
  67         char *head_name;
  68         struct object_id orig_head;
  69         struct commit *onto;
  70         const char *onto_name;
  71         const char *revisions;
  72         const char *switch_to;
  73         int root, root_with_onto;
  74         struct object_id *squash_onto;
  75         struct commit *restrict_revision;
  76         int dont_finish_rebase;
  77         enum {
  78                 REBASE_NO_QUIET = 1<<0,
  79                 REBASE_VERBOSE = 1<<1,
  80                 REBASE_DIFFSTAT = 1<<2,
  81                 REBASE_FORCE = 1<<3,
  82                 REBASE_INTERACTIVE_EXPLICIT = 1<<4,
  83         } flags;
  84         struct argv_array git_am_opts;
  85         const char *action;
  86         int signoff;
  87         int allow_rerere_autoupdate;
  88         int autosquash;
  89         char *gpg_sign_opt;
  90         int autostash;
  91         char *cmd;
  92         int allow_empty_message;
  93         int rebase_merges, rebase_cousins;
  94         char *strategy, *strategy_opts;
  95         struct strbuf git_format_patch_opt;
  96         int reschedule_failed_exec;
  97         int use_legacy_rebase;
  98 };
  99
 100 #define REBASE_OPTIONS_INIT {                           \
 101                 .type = REBASE_UNSPECIFIED,             \
 102                 .empty = EMPTY_UNSPECIFIED,             \
 103                 .default_backend = "merge",             \
 104                 .flags = REBASE_NO_QUIET,               \
 105                 .git_am_opts = ARGV_ARRAY_INIT,         \
 106                 .git_format_patch_opt = STRBUF_INIT     \
 107         }
 108
 109 static struct replay_opts get_replay_opts(const struct rebase_options *opts)
 110 {
 111         struct replay_opts replay = REPLAY_OPTS_INIT;
 112
 113         replay.action = REPLAY_INTERACTIVE_REBASE;
 114         sequencer_init_config(&replay);
 115
 116         replay.signoff = opts->signoff;
 117         replay.allow_ff = !(opts->flags & REBASE_FORCE);
 118         if (opts->allow_rerere_autoupdate)
 119                 replay.allow_rerere_auto = opts->allow_rerere_autoupdate;
 120         replay.allow_empty = 1;
 121         replay.allow_empty_message = opts->allow_empty_message;
 122         replay.drop_redundant_commits = (opts->empty == EMPTY_DROP);
 123         replay.keep_redundant_commits = (opts->empty == EMPTY_KEEP);
 124         replay.quiet = !(opts->flags & REBASE_NO_QUIET);
 125         replay.verbose = opts->flags & REBASE_VERBOSE;
 126         replay.reschedule_failed_exec = opts->reschedule_failed_exec;
 127         replay.gpg_sign = xstrdup_or_null(opts->gpg_sign_opt);
 128         replay.strategy = opts->strategy;
 129         if (opts->strategy_opts)
 130                 parse_strategy_opts(&replay, opts->strategy_opts);
 131
 132         if (opts->squash_onto) {
 133                 oidcpy(&replay.squash_onto, opts->squash_onto);
 134                 replay.have_squash_onto = 1;
 135         }
 136
 137         return replay;
 138 }
 139
 140 enum action {
 141         ACTION_NONE = 0,
 142         ACTION_CONTINUE,
 143         ACTION_SKIP,
 144         ACTION_ABORT,
 145         ACTION_QUIT,
 146         ACTION_EDIT_TODO,
 147         ACTION_SHOW_CURRENT_PATCH,
 148         ACTION_SHORTEN_OIDS,
 149         ACTION_EXPAND_OIDS,
 150         ACTION_CHECK_TODO_LIST,
 151         ACTION_REARRANGE_SQUASH,
 152         ACTION_ADD_EXEC
 153 };
 154
 155 static const char *action_names[] = { "undefined",
 156                                       "continue",
 157                                       "skip",
 158                                       "abort",
 159                                       "quit",
 160                                       "edit_todo",
 161                                       "show_current_patch" };
 162
 163 static int add_exec_commands(struct string_list *commands)
 164 {
 165         const char *todo_file = rebase_path_todo();
 166         struct todo_list todo_list = TODO_LIST_INIT;
 167         int res;
 168
 169         if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 170                 return error_errno(_("could not read '%s'."), todo_file);
 171
 172         if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
 173                                         &todo_list)) {
 174                 todo_list_release(&todo_list);
 175                 return error(_("unusable todo list: '%s'"), todo_file);
 176         }
 177
 178         todo_list_add_exec_commands(&todo_list, commands);
 179         res = todo_list_write_to_file(the_repository, &todo_list,
 180                                       todo_file, NULL, NULL, -1, 0);
 181         todo_list_release(&todo_list);
 182
 183         if (res)
 184                 return error_errno(_("could not write '%s'."), todo_file);
 185         return 0;
 186 }
 187
 188 static int rearrange_squash_in_todo_file(void)
 189 {
 190         const char *todo_file = rebase_path_todo();
 191         struct todo_list todo_list = TODO_LIST_INIT;
 192         int res = 0;
 193
 194         if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 195                 return error_errno(_("could not read '%s'."), todo_file);
 196         if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
 197                                         &todo_list)) {
 198                 todo_list_release(&todo_list);
 199                 return error(_("unusable todo list: '%s'"), todo_file);
 200         }
 201
 202         res = todo_list_rearrange_squash(&todo_list);
 203         if (!res)
 204                 res = todo_list_write_to_file(the_repository, &todo_list,
 205                                               todo_file, NULL, NULL, -1, 0);
 206
 207         todo_list_release(&todo_list);
 208
 209         if (res)
 210                 return error_errno(_("could not write '%s'."), todo_file);
 211         return 0;
 212 }
 213
 214 static int transform_todo_file(unsigned flags)
 215 {
 216         const char *todo_file = rebase_path_todo();
 217         struct todo_list todo_list = TODO_LIST_INIT;
 218         int res;
 219
 220         if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 221                 return error_errno(_("could not read '%s'."), todo_file);
 222
 223         if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
 224                                         &todo_list)) {
 225                 todo_list_release(&todo_list);
 226                 return error(_("unusable todo list: '%s'"), todo_file);
 227         }
 228
 229         res = todo_list_write_to_file(the_repository, &todo_list, todo_file,
 230                                       NULL, NULL, -1, flags);
 231         todo_list_release(&todo_list);
 232
 233         if (res)
 234                 return error_errno(_("could not write '%s'."), todo_file);
 235         return 0;
 236 }
 237
 238 static int edit_todo_file(unsigned flags)
 239 {
 240         const char *todo_file = rebase_path_todo();
 241         struct todo_list todo_list = TODO_LIST_INIT,
 242                 new_todo = TODO_LIST_INIT;
 243         int res = 0;
 244
 245         if (strbuf_read_file(&todo_list.buf, todo_file, 0) < 0)
 246                 return error_errno(_("could not read '%s'."), todo_file);
 247
 248         strbuf_stripspace(&todo_list.buf, 1);
 249         res = edit_todo_list(the_repository, &todo_list, &new_todo, NULL, NULL, flags);
 250         if (!res && todo_list_write_to_file(the_repository, &new_todo, todo_file,
 251                                             NULL, NULL, -1, flags & ~(TODO_LIST_SHORTEN_IDS)))
 252                 res = error_errno(_("could not write '%s'"), todo_file);
 253
 254         todo_list_release(&todo_list);
 255         todo_list_release(&new_todo);
 256
 257         return res;
 258 }
 259
 260 static int get_revision_ranges(struct commit *upstream, struct commit *onto,
 261                                struct object_id *orig_head, const char **head_hash,
 262                                char **revisions, char **shortrevisions)
 263 {
 264         struct commit *base_rev = upstream ? upstream : onto;
 265         const char *shorthead;
 266
 267         *head_hash = find_unique_abbrev(orig_head, GIT_MAX_HEXSZ);
 268         *revisions = xstrfmt("%s...%s", oid_to_hex(&base_rev->object.oid),
 269                                                    *head_hash);
 270
 271         shorthead = find_unique_abbrev(orig_head, DEFAULT_ABBREV);
 272
 273         if (upstream) {
 274                 const char *shortrev;
 275
 276                 shortrev = find_unique_abbrev(&base_rev->object.oid,
 277                                               DEFAULT_ABBREV);
 278
 279                 *shortrevisions = xstrfmt("%s..%s", shortrev, shorthead);
 280         } else
 281                 *shortrevisions = xstrdup(shorthead);
 282
 283         return 0;
 284 }
 285
 286 static int init_basic_state(struct replay_opts *opts, const char *head_name,
 287                             struct commit *onto, const char *orig_head)
 288 {
 289         FILE *interactive;
 290
 291         if (!is_directory(merge_dir()) && mkdir_in_gitdir(merge_dir()))
 292                 return error_errno(_("could not create temporary %s"), merge_dir());
 293
 294         delete_reflog("REBASE_HEAD");
 295
 296         interactive = fopen(path_interactive(), "w");
 297         if (!interactive)
 298                 return error_errno(_("could not mark as interactive"));
 299         fclose(interactive);
 300
 301         return write_basic_state(opts, head_name, onto, orig_head);
 302 }
 303
 304 static void split_exec_commands(const char *cmd, struct string_list *commands)
 305 {
 306         if (cmd && *cmd) {
 307                 string_list_split(commands, cmd, '\n', -1);
 308
 309                 /* rebase.c adds a new line to cmd after every command,
 310                  * so here the last command is always empty */
 311                 string_list_remove_empty_items(commands, 0);
 312         }
 313 }
 314
 315 static int do_interactive_rebase(struct rebase_options *opts, unsigned flags)
 316 {
 317         int ret;
 318         const char *head_hash = NULL;
 319         char *revisions = NULL, *shortrevisions = NULL;
 320         struct argv_array make_script_args = ARGV_ARRAY_INIT;
 321         struct todo_list todo_list = TODO_LIST_INIT;
 322         struct replay_opts replay = get_replay_opts(opts);
 323         struct string_list commands = STRING_LIST_INIT_DUP;
 324
 325         if (get_revision_ranges(opts->upstream, opts->onto, &opts->orig_head,
 326                                 &head_hash, &revisions, &shortrevisions))
 327                 return -1;
 328
 329         if (init_basic_state(&replay,
 330                              opts->head_name ? opts->head_name : "detached HEAD",
 331                              opts->onto, head_hash)) {
 332                 free(revisions);
 333                 free(shortrevisions);
 334
 335                 return -1;
 336         }
 337
 338         if (!opts->upstream && opts->squash_onto)
 339                 write_file(path_squash_onto(), "%s\n",
 340                            oid_to_hex(opts->squash_onto));
 341
 342         argv_array_pushl(&make_script_args, "", revisions, NULL);
 343         if (opts->restrict_revision)
 344                 argv_array_pushf(&make_script_args, "^%s",
 345                                  oid_to_hex(&opts->restrict_revision->object.oid));
 346
 347         ret = sequencer_make_script(the_repository, &todo_list.buf,
 348                                     make_script_args.argc, make_script_args.argv,
 349                                     flags);
 350
 351         if (ret)
 352                 error(_("could not generate todo list"));
 353         else {
 354                 discard_cache();
 355                 if (todo_list_parse_insn_buffer(the_repository, todo_list.buf.buf,
 356                                                 &todo_list))
 357                         BUG("unusable todo list");
 358
 359                 split_exec_commands(opts->cmd, &commands);
 360                 ret = complete_action(the_repository, &replay, flags,
 361                         shortrevisions, opts->onto_name, opts->onto, head_hash,
 362                         &commands, opts->autosquash, &todo_list);
 363         }
 364
 365         string_list_clear(&commands, 0);
 366         free(revisions);
 367         free(shortrevisions);
 368         todo_list_release(&todo_list);
 369         argv_array_clear(&make_script_args);
 370
 371         return ret;
 372 }
 373
 374 static int run_sequencer_rebase(struct rebase_options *opts,
 375                                   enum action command)
 376 {
 377         unsigned flags = 0;
 378         int abbreviate_commands = 0, ret = 0;
 379
 380         git_config_get_bool("rebase.abbreviatecommands", &abbreviate_commands);
 381
 382         flags |= abbreviate_commands ? TODO_LIST_ABBREVIATE_CMDS : 0;
 383         flags |= opts->rebase_merges ? TODO_LIST_REBASE_MERGES : 0;
 384         flags |= opts->rebase_cousins > 0 ? TODO_LIST_REBASE_COUSINS : 0;
 385         flags |= opts->root_with_onto ? TODO_LIST_ROOT_WITH_ONTO : 0;
 386         flags |= command == ACTION_SHORTEN_OIDS ? TODO_LIST_SHORTEN_IDS : 0;
 387
 388         switch (command) {
 389         case ACTION_NONE: {
 390                 if (!opts->onto && !opts->upstream)
 391                         die(_("a base commit must be provided with --upstream or --onto"));
 392
 393                 ret = do_interactive_rebase(opts, flags);
 394                 break;
 395         }
 396         case ACTION_SKIP: {
 397                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
 398
 399                 rerere_clear(the_repository, &merge_rr);
 400         }
 401                 /* fallthrough */
 402         case ACTION_CONTINUE: {
 403                 struct replay_opts replay_opts = get_replay_opts(opts);
 404
 405                 ret = sequencer_continue(the_repository, &replay_opts);
 406                 break;
 407         }
 408         case ACTION_EDIT_TODO:
 409                 ret = edit_todo_file(flags);
 410                 break;
 411         case ACTION_SHOW_CURRENT_PATCH: {
 412                 struct child_process cmd = CHILD_PROCESS_INIT;
 413
 414                 cmd.git_cmd = 1;
 415                 argv_array_pushl(&cmd.args, "show", "REBASE_HEAD", "--", NULL);
 416                 ret = run_command(&cmd);
 417
 418                 break;
 419         }
 420         case ACTION_SHORTEN_OIDS:
 421         case ACTION_EXPAND_OIDS:
 422                 ret = transform_todo_file(flags);
 423                 break;
 424         case ACTION_CHECK_TODO_LIST:
 425                 ret = check_todo_list_from_file(the_repository);
 426                 break;
 427         case ACTION_REARRANGE_SQUASH:
 428                 ret = rearrange_squash_in_todo_file();
 429                 break;
 430         case ACTION_ADD_EXEC: {
 431                 struct string_list commands = STRING_LIST_INIT_DUP;
 432
 433                 split_exec_commands(opts->cmd, &commands);
 434                 ret = add_exec_commands(&commands);
 435                 string_list_clear(&commands, 0);
 436                 break;
 437         }
 438         default:
 439                 BUG("invalid command '%d'", command);
 440         }
 441
 442         return ret;
 443 }
 444
 445 static int parse_opt_keep_empty(const struct option *opt, const char *arg,
 446                                 int unset)
 447 {
 448         struct rebase_options *opts = opt->value;
 449
 450         BUG_ON_OPT_ARG(arg);
 451
 452         /*
 453          * If we ever want to remap --keep-empty to --empty=keep, insert:
 454          *      opts->empty = unset ? EMPTY_UNSPECIFIED : EMPTY_KEEP;
 455          */
 456         opts->type = REBASE_MERGE;
 457         return 0;
 458 }
 459
 460 static const char * const builtin_rebase_interactive_usage[] = {
 461         N_("git rebase--interactive [<options>]"),
 462         NULL
 463 };
 464
 465 int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
 466 {
 467         struct rebase_options opts = REBASE_OPTIONS_INIT;
 468         struct object_id squash_onto = null_oid;
 469         enum action command = ACTION_NONE;
 470         struct option options[] = {
 471                 OPT_NEGBIT(0, "ff", &opts.flags, N_("allow fast-forward"),
 472                            REBASE_FORCE),
 473                 { OPTION_CALLBACK, 'k', "keep-empty", &options, NULL,
 474                         N_("(DEPRECATED) keep empty commits"),
 475                         PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
 476                         parse_opt_keep_empty },
 477                 OPT_BOOL_F(0, "allow-empty-message", &opts.allow_empty_message,
 478                            N_("allow commits with empty messages"),
 479                            PARSE_OPT_HIDDEN),
 480                 OPT_BOOL(0, "rebase-merges", &opts.rebase_merges, N_("rebase merge commits")),
 481                 OPT_BOOL(0, "rebase-cousins", &opts.rebase_cousins,
 482                          N_("keep original branch points of cousins")),
 483                 OPT_BOOL(0, "autosquash", &opts.autosquash,
 484                          N_("move commits that begin with squash!/fixup!")),
 485                 OPT_BOOL(0, "signoff", &opts.signoff, N_("sign commits")),
 486                 OPT_BIT('v', "verbose", &opts.flags,
 487                         N_("display a diffstat of what changed upstream"),
 488                         REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
 489                 OPT_CMDMODE(0, "continue", &command, N_("continue rebase"),
 490                             ACTION_CONTINUE),
 491                 OPT_CMDMODE(0, "skip", &command, N_("skip commit"), ACTION_SKIP),
 492                 OPT_CMDMODE(0, "edit-todo", &command, N_("edit the todo list"),
 493                             ACTION_EDIT_TODO),
 494                 OPT_CMDMODE(0, "show-current-patch", &command, N_("show the current patch"),
 495                             ACTION_SHOW_CURRENT_PATCH),
 496                 OPT_CMDMODE(0, "shorten-ids", &command,
 497                         N_("shorten commit ids in the todo list"), ACTION_SHORTEN_OIDS),
 498                 OPT_CMDMODE(0, "expand-ids", &command,
 499                         N_("expand commit ids in the todo list"), ACTION_EXPAND_OIDS),
 500                 OPT_CMDMODE(0, "check-todo-list", &command,
 501                         N_("check the todo list"), ACTION_CHECK_TODO_LIST),
 502                 OPT_CMDMODE(0, "rearrange-squash", &command,
 503                         N_("rearrange fixup/squash lines"), ACTION_REARRANGE_SQUASH),
 504                 OPT_CMDMODE(0, "add-exec-commands", &command,
 505                         N_("insert exec commands in todo list"), ACTION_ADD_EXEC),
 506                 { OPTION_CALLBACK, 0, "onto", &opts.onto, N_("onto"), N_("onto"),
 507                   PARSE_OPT_NONEG, parse_opt_commit, 0 },
 508                 { OPTION_CALLBACK, 0, "restrict-revision", &opts.restrict_revision,
 509                   N_("restrict-revision"), N_("restrict revision"),
 510                   PARSE_OPT_NONEG, parse_opt_commit, 0 },
 511                 { OPTION_CALLBACK, 0, "squash-onto", &squash_onto, N_("squash-onto"),
 512                   N_("squash onto"), PARSE_OPT_NONEG, parse_opt_object_id, 0 },
 513                 { OPTION_CALLBACK, 0, "upstream", &opts.upstream, N_("upstream"),
 514                   N_("the upstream commit"), PARSE_OPT_NONEG, parse_opt_commit,
 515                   0 },
 516                 OPT_STRING(0, "head-name", &opts.head_name, N_("head-name"), N_("head name")),
 517                 { OPTION_STRING, 'S', "gpg-sign", &opts.gpg_sign_opt, N_("key-id"),
 518                         N_("GPG-sign commits"),
 519                         PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
 520                 OPT_STRING(0, "strategy", &opts.strategy, N_("strategy"),
 521                            N_("rebase strategy")),
 522                 OPT_STRING(0, "strategy-opts", &opts.strategy_opts, N_("strategy-opts"),
 523                            N_("strategy options")),
 524                 OPT_STRING(0, "switch-to", &opts.switch_to, N_("switch-to"),
 525                            N_("the branch or commit to checkout")),
 526                 OPT_STRING(0, "onto-name", &opts.onto_name, N_("onto-name"), N_("onto name")),
 527                 OPT_STRING(0, "cmd", &opts.cmd, N_("cmd"), N_("the command to run")),
 528                 OPT_RERERE_AUTOUPDATE(&opts.allow_rerere_autoupdate),
 529                 OPT_BOOL(0, "reschedule-failed-exec", &opts.reschedule_failed_exec,
 530                          N_("automatically re-schedule any `exec` that fails")),
 531                 OPT_END()
 532         };
 533
 534         opts.rebase_cousins = -1;
 535
 536         if (argc == 1)
 537                 usage_with_options(builtin_rebase_interactive_usage, options);
 538
 539         argc = parse_options(argc, argv, prefix, options,
 540                         builtin_rebase_interactive_usage, PARSE_OPT_KEEP_ARGV0);
 541
 542         if (!is_null_oid(&squash_onto))
 543                 opts.squash_onto = &squash_onto;
 544
 545         if (opts.rebase_cousins >= 0 && !opts.rebase_merges)
 546                 warning(_("--[no-]rebase-cousins has no effect without "
 547                           "--rebase-merges"));
 548
 549         return !!run_sequencer_rebase(&opts, command);
 550 }
 551
 552 static int is_merge(struct rebase_options *opts)
 553 {
 554         return opts->type == REBASE_MERGE ||
 555                 opts->type == REBASE_PRESERVE_MERGES;
 556 }
 557
 558 static void imply_merge(struct rebase_options *opts, const char *option)
 559 {
 560         switch (opts->type) {
 561         case REBASE_APPLY:
 562                 die(_("%s requires an interactive rebase"), option);
 563                 break;
 564         case REBASE_MERGE:
 565         case REBASE_PRESERVE_MERGES:
 566                 break;
 567         default:
 568                 opts->type = REBASE_MERGE; /* implied */
 569                 break;
 570         }
 571 }
 572
 573 /* Returns the filename prefixed by the state_dir */
 574 static const char *state_dir_path(const char *filename, struct rebase_options *opts)
 575 {
 576         static struct strbuf path = STRBUF_INIT;
 577         static size_t prefix_len;
 578
 579         if (!prefix_len) {
 580                 strbuf_addf(&path, "%s/", opts->state_dir);
 581                 prefix_len = path.len;
 582         }
 583
 584         strbuf_setlen(&path, prefix_len);
 585         strbuf_addstr(&path, filename);
 586         return path.buf;
 587 }
 588
 589 /* Initialize the rebase options from the state directory. */
 590 static int read_basic_state(struct rebase_options *opts)
 591 {
 592         struct strbuf head_name = STRBUF_INIT;
 593         struct strbuf buf = STRBUF_INIT;
 594         struct object_id oid;
 595
 596         if (!read_oneliner(&head_name, state_dir_path("head-name", opts),
 597                            READ_ONELINER_WARN_MISSING) ||
 598             !read_oneliner(&buf, state_dir_path("onto", opts),
 599                            READ_ONELINER_WARN_MISSING))
 600                 return -1;
 601         opts->head_name = starts_with(head_name.buf, "refs/") ?
 602                 xstrdup(head_name.buf) : NULL;
 603         strbuf_release(&head_name);
 604         if (get_oid(buf.buf, &oid))
 605                 return error(_("could not get 'onto': '%s'"), buf.buf);
 606         opts->onto = lookup_commit_or_die(&oid, buf.buf);
 607
 608         /*
 609          * We always write to orig-head, but interactive rebase used to write to
 610          * head. Fall back to reading from head to cover for the case that the
 611          * user upgraded git with an ongoing interactive rebase.
 612          */
 613         strbuf_reset(&buf);
 614         if (file_exists(state_dir_path("orig-head", opts))) {
 615                 if (!read_oneliner(&buf, state_dir_path("orig-head", opts),
 616                                    READ_ONELINER_WARN_MISSING))
 617                         return -1;
 618         } else if (!read_oneliner(&buf, state_dir_path("head", opts),
 619                                   READ_ONELINER_WARN_MISSING))
 620                 return -1;
 621         if (get_oid(buf.buf, &opts->orig_head))
 622                 return error(_("invalid orig-head: '%s'"), buf.buf);
 623
 624         if (file_exists(state_dir_path("quiet", opts)))
 625                 opts->flags &= ~REBASE_NO_QUIET;
 626         else
 627                 opts->flags |= REBASE_NO_QUIET;
 628
 629         if (file_exists(state_dir_path("verbose", opts)))
 630                 opts->flags |= REBASE_VERBOSE;
 631
 632         if (file_exists(state_dir_path("signoff", opts))) {
 633                 opts->signoff = 1;
 634                 opts->flags |= REBASE_FORCE;
 635         }
 636
 637         if (file_exists(state_dir_path("allow_rerere_autoupdate", opts))) {
 638                 strbuf_reset(&buf);
 639                 if (!read_oneliner(&buf, state_dir_path("allow_rerere_autoupdate", opts),
 640                                    READ_ONELINER_WARN_MISSING))
 641                         return -1;
 642                 if (!strcmp(buf.buf, "--rerere-autoupdate"))
 643                         opts->allow_rerere_autoupdate = RERERE_AUTOUPDATE;
 644                 else if (!strcmp(buf.buf, "--no-rerere-autoupdate"))
 645                         opts->allow_rerere_autoupdate = RERERE_NOAUTOUPDATE;
 646                 else
 647                         warning(_("ignoring invalid allow_rerere_autoupdate: "
 648                                   "'%s'"), buf.buf);
 649         }
 650
 651         if (file_exists(state_dir_path("gpg_sign_opt", opts))) {
 652                 strbuf_reset(&buf);
 653                 if (!read_oneliner(&buf, state_dir_path("gpg_sign_opt", opts),
 654                                    READ_ONELINER_WARN_MISSING))
 655                         return -1;
 656                 free(opts->gpg_sign_opt);
 657                 opts->gpg_sign_opt = xstrdup(buf.buf);
 658         }
 659
 660         if (file_exists(state_dir_path("strategy", opts))) {
 661                 strbuf_reset(&buf);
 662                 if (!read_oneliner(&buf, state_dir_path("strategy", opts),
 663                                    READ_ONELINER_WARN_MISSING))
 664                         return -1;
 665                 free(opts->strategy);
 666                 opts->strategy = xstrdup(buf.buf);
 667         }
 668
 669         if (file_exists(state_dir_path("strategy_opts", opts))) {
 670                 strbuf_reset(&buf);
 671                 if (!read_oneliner(&buf, state_dir_path("strategy_opts", opts),
 672                                    READ_ONELINER_WARN_MISSING))
 673                         return -1;
 674                 free(opts->strategy_opts);
 675                 opts->strategy_opts = xstrdup(buf.buf);
 676         }
 677
 678         strbuf_release(&buf);
 679
 680         return 0;
 681 }
 682
 683 static int rebase_write_basic_state(struct rebase_options *opts)
 684 {
 685         write_file(state_dir_path("head-name", opts), "%s",
 686                    opts->head_name ? opts->head_name : "detached HEAD");
 687         write_file(state_dir_path("onto", opts), "%s",
 688                    opts->onto ? oid_to_hex(&opts->onto->object.oid) : "");
 689         write_file(state_dir_path("orig-head", opts), "%s",
 690                    oid_to_hex(&opts->orig_head));
 691         if (!(opts->flags & REBASE_NO_QUIET))
 692                 write_file(state_dir_path("quiet", opts), "%s", "");
 693         if (opts->flags & REBASE_VERBOSE)
 694                 write_file(state_dir_path("verbose", opts), "%s", "");
 695         if (opts->strategy)
 696                 write_file(state_dir_path("strategy", opts), "%s",
 697                            opts->strategy);
 698         if (opts->strategy_opts)
 699                 write_file(state_dir_path("strategy_opts", opts), "%s",
 700                            opts->strategy_opts);
 701         if (opts->allow_rerere_autoupdate > 0)
 702                 write_file(state_dir_path("allow_rerere_autoupdate", opts),
 703                            "-%s-rerere-autoupdate",
 704                            opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
 705                                 "" : "-no");
 706         if (opts->gpg_sign_opt)
 707                 write_file(state_dir_path("gpg_sign_opt", opts), "%s",
 708                            opts->gpg_sign_opt);
 709         if (opts->signoff)
 710                 write_file(state_dir_path("signoff", opts), "--signoff");
 711
 712         return 0;
 713 }
 714
 715 static int apply_autostash(struct rebase_options *opts)
 716 {
 717         const char *path = state_dir_path("autostash", opts);
 718         struct strbuf autostash = STRBUF_INIT;
 719         struct child_process stash_apply = CHILD_PROCESS_INIT;
 720
 721         if (!file_exists(path))
 722                 return 0;
 723
 724         if (!read_oneliner(&autostash, path, READ_ONELINER_WARN_MISSING))
 725                 return error(_("Could not read '%s'"), path);
 726         /* Ensure that the hash is not mistaken for a number */
 727         strbuf_addstr(&autostash, "^0");
 728         argv_array_pushl(&stash_apply.args,
 729                          "stash", "apply", autostash.buf, NULL);
 730         stash_apply.git_cmd = 1;
 731         stash_apply.no_stderr = stash_apply.no_stdout =
 732                 stash_apply.no_stdin = 1;
 733         if (!run_command(&stash_apply))
 734                 printf(_("Applied autostash.\n"));
 735         else {
 736                 struct argv_array args = ARGV_ARRAY_INIT;
 737                 int res = 0;
 738
 739                 argv_array_pushl(&args,
 740                                  "stash", "store", "-m", "autostash", "-q",
 741                                  autostash.buf, NULL);
 742                 if (run_command_v_opt(args.argv, RUN_GIT_CMD))
 743                         res = error(_("Cannot store %s"), autostash.buf);
 744                 argv_array_clear(&args);
 745                 strbuf_release(&autostash);
 746                 if (res)
 747                         return res;
 748
 749                 fprintf(stderr,
 750                         _("Applying autostash resulted in conflicts.\n"
 751                           "Your changes are safe in the stash.\n"
 752                           "You can run \"git stash pop\" or \"git stash drop\" "
 753                           "at any time.\n"));
 754         }
 755
 756         strbuf_release(&autostash);
 757         return 0;
 758 }
 759
 760 static int finish_rebase(struct rebase_options *opts)
 761 {
 762         struct strbuf dir = STRBUF_INIT;
 763         const char *argv_gc_auto[] = { "gc", "--auto", NULL };
 764         int ret = 0;
 765
 766         delete_ref(NULL, "REBASE_HEAD", NULL, REF_NO_DEREF);
 767         apply_autostash(opts);
 768         close_object_store(the_repository->objects);
 769         /*
 770          * We ignore errors in 'gc --auto', since the
 771          * user should see them.
 772          */
 773         run_command_v_opt(argv_gc_auto, RUN_GIT_CMD);
 774         if (opts->type == REBASE_MERGE) {
 775                 struct replay_opts replay = REPLAY_OPTS_INIT;
 776
 777                 replay.action = REPLAY_INTERACTIVE_REBASE;
 778                 ret = sequencer_remove_state(&replay);
 779         } else {
 780                 strbuf_addstr(&dir, opts->state_dir);
 781                 if (remove_dir_recursively(&dir, 0))
 782                         ret = error(_("could not remove '%s'"),
 783                                     opts->state_dir);
 784                 strbuf_release(&dir);
 785         }
 786
 787         return ret;
 788 }
 789
 790 static struct commit *peel_committish(const char *name)
 791 {
 792         struct object *obj;
 793         struct object_id oid;
 794
 795         if (get_oid(name, &oid))
 796                 return NULL;
 797         obj = parse_object(the_repository, &oid);
 798         return (struct commit *)peel_to_type(name, 0, obj, OBJ_COMMIT);
 799 }
 800
 801 static void add_var(struct strbuf *buf, const char *name, const char *value)
 802 {
 803         if (!value)
 804                 strbuf_addf(buf, "unset %s; ", name);
 805         else {
 806                 strbuf_addf(buf, "%s=", name);
 807                 sq_quote_buf(buf, value);
 808                 strbuf_addstr(buf, "; ");
 809         }
 810 }
 811
 812 #define GIT_REFLOG_ACTION_ENVIRONMENT "GIT_REFLOG_ACTION"
 813
 814 #define RESET_HEAD_DETACH (1<<0)
 815 #define RESET_HEAD_HARD (1<<1)
 816 #define RESET_HEAD_RUN_POST_CHECKOUT_HOOK (1<<2)
 817 #define RESET_HEAD_REFS_ONLY (1<<3)
 818 #define RESET_ORIG_HEAD (1<<4)
 819
 820 static int reset_head(struct object_id *oid, const char *action,
 821                       const char *switch_to_branch, unsigned flags,
 822                       const char *reflog_orig_head, const char *reflog_head)
 823 {
 824         unsigned detach_head = flags & RESET_HEAD_DETACH;
 825         unsigned reset_hard = flags & RESET_HEAD_HARD;
 826         unsigned run_hook = flags & RESET_HEAD_RUN_POST_CHECKOUT_HOOK;
 827         unsigned refs_only = flags & RESET_HEAD_REFS_ONLY;
 828         unsigned update_orig_head = flags & RESET_ORIG_HEAD;
 829         struct object_id head_oid;
 830         struct tree_desc desc[2] = { { NULL }, { NULL } };
 831         struct lock_file lock = LOCK_INIT;
 832         struct unpack_trees_options unpack_tree_opts;
 833         struct tree *tree;
 834         const char *reflog_action;
 835         struct strbuf msg = STRBUF_INIT;
 836         size_t prefix_len;
 837         struct object_id *orig = NULL, oid_orig,
 838                 *old_orig = NULL, oid_old_orig;
 839         int ret = 0, nr = 0;
 840
 841         if (switch_to_branch && !starts_with(switch_to_branch, "refs/"))
 842                 BUG("Not a fully qualified branch: '%s'", switch_to_branch);
 843
 844         if (!refs_only && hold_locked_index(&lock, LOCK_REPORT_ON_ERROR) < 0) {
 845                 ret = -1;
 846                 goto leave_reset_head;
 847         }
 848
 849         if ((!oid || !reset_hard) && get_oid("HEAD", &head_oid)) {
 850                 ret = error(_("could not determine HEAD revision"));
 851                 goto leave_reset_head;
 852         }
 853
 854         if (!oid)
 855                 oid = &head_oid;
 856
 857         if (refs_only)
 858                 goto reset_head_refs;
 859
 860         memset(&unpack_tree_opts, 0, sizeof(unpack_tree_opts));
 861         setup_unpack_trees_porcelain(&unpack_tree_opts, action);
 862         unpack_tree_opts.head_idx = 1;
 863         unpack_tree_opts.src_index = the_repository->index;
 864         unpack_tree_opts.dst_index = the_repository->index;
 865         unpack_tree_opts.fn = reset_hard ? oneway_merge : twoway_merge;
 866         unpack_tree_opts.update = 1;
 867         unpack_tree_opts.merge = 1;
 868         if (!detach_head)
 869                 unpack_tree_opts.reset = 1;
 870
 871         if (repo_read_index_unmerged(the_repository) < 0) {
 872                 ret = error(_("could not read index"));
 873                 goto leave_reset_head;
 874         }
 875
 876         if (!reset_hard && !fill_tree_descriptor(the_repository, &desc[nr++], &head_oid)) {
 877                 ret = error(_("failed to find tree of %s"),
 878                             oid_to_hex(&head_oid));
 879                 goto leave_reset_head;
 880         }
 881
 882         if (!fill_tree_descriptor(the_repository, &desc[nr++], oid)) {
 883                 ret = error(_("failed to find tree of %s"), oid_to_hex(oid));
 884                 goto leave_reset_head;
 885         }
 886
 887         if (unpack_trees(nr, desc, &unpack_tree_opts)) {
 888                 ret = -1;
 889                 goto leave_reset_head;
 890         }
 891
 892         tree = parse_tree_indirect(oid);
 893         prime_cache_tree(the_repository, the_repository->index, tree);
 894
 895         if (write_locked_index(the_repository->index, &lock, COMMIT_LOCK) < 0) {
 896                 ret = error(_("could not write index"));
 897                 goto leave_reset_head;
 898         }
 899
 900 reset_head_refs:
 901         reflog_action = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
 902         strbuf_addf(&msg, "%s: ", reflog_action ? reflog_action : "rebase");
 903         prefix_len = msg.len;
 904
 905         if (update_orig_head) {
 906                 if (!get_oid("ORIG_HEAD", &oid_old_orig))
 907                         old_orig = &oid_old_orig;
 908                 if (!get_oid("HEAD", &oid_orig)) {
 909                         orig = &oid_orig;
 910                         if (!reflog_orig_head) {
 911                                 strbuf_addstr(&msg, "updating ORIG_HEAD");
 912                                 reflog_orig_head = msg.buf;
 913                         }
 914                         update_ref(reflog_orig_head, "ORIG_HEAD", orig,
 915                                    old_orig, 0, UPDATE_REFS_MSG_ON_ERR);
 916                 } else if (old_orig)
 917                         delete_ref(NULL, "ORIG_HEAD", old_orig, 0);
 918         }
 919
 920         if (!reflog_head) {
 921                 strbuf_setlen(&msg, prefix_len);
 922                 strbuf_addstr(&msg, "updating HEAD");
 923                 reflog_head = msg.buf;
 924         }
 925         if (!switch_to_branch)
 926                 ret = update_ref(reflog_head, "HEAD", oid, orig,
 927                                  detach_head ? REF_NO_DEREF : 0,
 928                                  UPDATE_REFS_MSG_ON_ERR);
 929         else {
 930                 ret = update_ref(reflog_head, switch_to_branch, oid,
 931                                  NULL, 0, UPDATE_REFS_MSG_ON_ERR);
 932                 if (!ret)
 933                         ret = create_symref("HEAD", switch_to_branch,
 934                                             reflog_head);
 935         }
 936         if (run_hook)
 937                 run_hook_le(NULL, "post-checkout",
 938                             oid_to_hex(orig ? orig : &null_oid),
 939                             oid_to_hex(oid), "1", NULL);
 940
 941 leave_reset_head:
 942         strbuf_release(&msg);
 943         rollback_lock_file(&lock);
 944         while (nr)
 945                 free((void *)desc[--nr].buffer);
 946         return ret;
 947 }
 948
 949 static int move_to_original_branch(struct rebase_options *opts)
 950 {
 951         struct strbuf orig_head_reflog = STRBUF_INIT, head_reflog = STRBUF_INIT;
 952         int ret;
 953
 954         if (!opts->head_name)
 955                 return 0; /* nothing to move back to */
 956
 957         if (!opts->onto)
 958                 BUG("move_to_original_branch without onto");
 959
 960         strbuf_addf(&orig_head_reflog, "rebase finished: %s onto %s",
 961                     opts->head_name, oid_to_hex(&opts->onto->object.oid));
 962         strbuf_addf(&head_reflog, "rebase finished: returning to %s",
 963                     opts->head_name);
 964         ret = reset_head(NULL, "", opts->head_name, RESET_HEAD_REFS_ONLY,
 965                          orig_head_reflog.buf, head_reflog.buf);
 966
 967         strbuf_release(&orig_head_reflog);
 968         strbuf_release(&head_reflog);
 969         return ret;
 970 }
 971
 972 static const char *resolvemsg =
 973 N_("Resolve all conflicts manually, mark them as resolved with\n"
 974 "\"git add/rm <conflicted_files>\", then run \"git rebase --continue\".\n"
 975 "You can instead skip this commit: run \"git rebase --skip\".\n"
 976 "To abort and get back to the state before \"git rebase\", run "
 977 "\"git rebase --abort\".");
 978
 979 static int run_am(struct rebase_options *opts)
 980 {
 981         struct child_process am = CHILD_PROCESS_INIT;
 982         struct child_process format_patch = CHILD_PROCESS_INIT;
 983         struct strbuf revisions = STRBUF_INIT;
 984         int status;
 985         char *rebased_patches;
 986
 987         am.git_cmd = 1;
 988         argv_array_push(&am.args, "am");
 989
 990         if (opts->action && !strcmp("continue", opts->action)) {
 991                 argv_array_push(&am.args, "--resolved");
 992                 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
 993                 if (opts->gpg_sign_opt)
 994                         argv_array_push(&am.args, opts->gpg_sign_opt);
 995                 status = run_command(&am);
 996                 if (status)
 997                         return status;
 998
 999                 return move_to_original_branch(opts);
1000         }
1001         if (opts->action && !strcmp("skip", opts->action)) {
1002                 argv_array_push(&am.args, "--skip");
1003                 argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
1004                 status = run_command(&am);
1005                 if (status)
1006                         return status;
1007
1008                 return move_to_original_branch(opts);
1009         }
1010         if (opts->action && !strcmp("show-current-patch", opts->action)) {
1011                 argv_array_push(&am.args, "--show-current-patch");
1012                 return run_command(&am);
1013         }
1014
1015         strbuf_addf(&revisions, "%s...%s",
1016                     oid_to_hex(opts->root ?
1017                                /* this is now equivalent to !opts->upstream */
1018                                &opts->onto->object.oid :
1019                                &opts->upstream->object.oid),
1020                     oid_to_hex(&opts->orig_head));
1021
1022         rebased_patches = xstrdup(git_path("rebased-patches"));
1023         format_patch.out = open(rebased_patches,
1024                                 O_WRONLY | O_CREAT | O_TRUNC, 0666);
1025         if (format_patch.out < 0) {
1026                 status = error_errno(_("could not open '%s' for writing"),
1027                                      rebased_patches);
1028                 free(rebased_patches);
1029                 argv_array_clear(&am.args);
1030                 return status;
1031         }
1032
1033         format_patch.git_cmd = 1;
1034         argv_array_pushl(&format_patch.args, "format-patch", "-k", "--stdout",
1035                          "--full-index", "--cherry-pick", "--right-only",
1036                          "--src-prefix=a/", "--dst-prefix=b/", "--no-renames",
1037                          "--no-cover-letter", "--pretty=mboxrd", "--topo-order",
1038                          "--no-base", NULL);
1039         if (opts->git_format_patch_opt.len)
1040                 argv_array_split(&format_patch.args,
1041                                  opts->git_format_patch_opt.buf);
1042         argv_array_push(&format_patch.args, revisions.buf);
1043         if (opts->restrict_revision)
1044                 argv_array_pushf(&format_patch.args, "^%s",
1045                                  oid_to_hex(&opts->restrict_revision->object.oid));
1046
1047         status = run_command(&format_patch);
1048         if (status) {
1049                 unlink(rebased_patches);
1050                 free(rebased_patches);
1051                 argv_array_clear(&am.args);
1052
1053                 reset_head(&opts->orig_head, "checkout", opts->head_name, 0,
1054                            "HEAD", NULL);
1055                 error(_("\ngit encountered an error while preparing the "
1056                         "patches to replay\n"
1057                         "these revisions:\n"
1058                         "\n    %s\n\n"
1059                         "As a result, git cannot rebase them."),
1060                       opts->revisions);
1061
1062                 strbuf_release(&revisions);
1063                 return status;
1064         }
1065         strbuf_release(&revisions);
1066
1067         am.in = open(rebased_patches, O_RDONLY);
1068         if (am.in < 0) {
1069                 status = error_errno(_("could not open '%s' for reading"),
1070                                      rebased_patches);
1071                 free(rebased_patches);
1072                 argv_array_clear(&am.args);
1073                 return status;
1074         }
1075
1076         argv_array_pushv(&am.args, opts->git_am_opts.argv);
1077         argv_array_push(&am.args, "--rebasing");
1078         argv_array_pushf(&am.args, "--resolvemsg=%s", resolvemsg);
1079         argv_array_push(&am.args, "--patch-format=mboxrd");
1080         if (opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE)
1081                 argv_array_push(&am.args, "--rerere-autoupdate");
1082         else if (opts->allow_rerere_autoupdate == RERERE_NOAUTOUPDATE)
1083                 argv_array_push(&am.args, "--no-rerere-autoupdate");
1084         if (opts->gpg_sign_opt)
1085                 argv_array_push(&am.args, opts->gpg_sign_opt);
1086         status = run_command(&am);
1087         unlink(rebased_patches);
1088         free(rebased_patches);
1089
1090         if (!status) {
1091                 return move_to_original_branch(opts);
1092         }
1093
1094         if (is_directory(opts->state_dir))
1095                 rebase_write_basic_state(opts);
1096
1097         return status;
1098 }
1099
1100 static int run_specific_rebase(struct rebase_options *opts, enum action action)
1101 {
1102         const char *argv[] = { NULL, NULL };
1103         struct strbuf script_snippet = STRBUF_INIT, buf = STRBUF_INIT;
1104         int status;
1105         const char *backend, *backend_func;
1106
1107         if (opts->type == REBASE_MERGE) {
1108                 /* Run sequencer-based rebase */
1109                 setenv("GIT_CHERRY_PICK_HELP", resolvemsg, 1);
1110                 if (!(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
1111                         setenv("GIT_SEQUENCE_EDITOR", ":", 1);
1112                         opts->autosquash = 0;
1113                 }
1114                 if (opts->gpg_sign_opt) {
1115                         /* remove the leading "-S" */
1116                         char *tmp = xstrdup(opts->gpg_sign_opt + 2);
1117                         free(opts->gpg_sign_opt);
1118                         opts->gpg_sign_opt = tmp;
1119                 }
1120
1121                 status = run_sequencer_rebase(opts, action);
1122                 goto finished_rebase;
1123         }
1124
1125         if (opts->type == REBASE_APPLY) {
1126                 status = run_am(opts);
1127                 goto finished_rebase;
1128         }
1129
1130         add_var(&script_snippet, "GIT_DIR", absolute_path(get_git_dir()));
1131         add_var(&script_snippet, "state_dir", opts->state_dir);
1132
1133         add_var(&script_snippet, "upstream_name", opts->upstream_name);
1134         add_var(&script_snippet, "upstream", opts->upstream ?
1135                 oid_to_hex(&opts->upstream->object.oid) : NULL);
1136         add_var(&script_snippet, "head_name",
1137                 opts->head_name ? opts->head_name : "detached HEAD");
1138         add_var(&script_snippet, "orig_head", oid_to_hex(&opts->orig_head));
1139         add_var(&script_snippet, "onto", opts->onto ?
1140                 oid_to_hex(&opts->onto->object.oid) : NULL);
1141         add_var(&script_snippet, "onto_name", opts->onto_name);
1142         add_var(&script_snippet, "revisions", opts->revisions);
1143         add_var(&script_snippet, "restrict_revision", opts->restrict_revision ?
1144                 oid_to_hex(&opts->restrict_revision->object.oid) : NULL);
1145         sq_quote_argv_pretty(&buf, opts->git_am_opts.argv);
1146         add_var(&script_snippet, "git_am_opt", buf.buf);
1147         strbuf_release(&buf);
1148         add_var(&script_snippet, "verbose",
1149                 opts->flags & REBASE_VERBOSE ? "t" : "");
1150         add_var(&script_snippet, "diffstat",
1151                 opts->flags & REBASE_DIFFSTAT ? "t" : "");
1152         add_var(&script_snippet, "force_rebase",
1153                 opts->flags & REBASE_FORCE ? "t" : "");
1154         if (opts->switch_to)
1155                 add_var(&script_snippet, "switch_to", opts->switch_to);
1156         add_var(&script_snippet, "action", opts->action ? opts->action : "");
1157         add_var(&script_snippet, "signoff", opts->signoff ? "--signoff" : "");
1158         add_var(&script_snippet, "allow_rerere_autoupdate",
1159                 opts->allow_rerere_autoupdate ?
1160                         opts->allow_rerere_autoupdate == RERERE_AUTOUPDATE ?
1161                         "--rerere-autoupdate" : "--no-rerere-autoupdate" : "");
1162         add_var(&script_snippet, "autosquash", opts->autosquash ? "t" : "");
1163         add_var(&script_snippet, "gpg_sign_opt", opts->gpg_sign_opt);
1164         add_var(&script_snippet, "cmd", opts->cmd);
1165         add_var(&script_snippet, "allow_empty_message",
1166                 opts->allow_empty_message ?  "--allow-empty-message" : "");
1167         add_var(&script_snippet, "rebase_merges",
1168                 opts->rebase_merges ? "t" : "");
1169         add_var(&script_snippet, "rebase_cousins",
1170                 opts->rebase_cousins ? "t" : "");
1171         add_var(&script_snippet, "strategy", opts->strategy);
1172         add_var(&script_snippet, "strategy_opts", opts->strategy_opts);
1173         add_var(&script_snippet, "rebase_root", opts->root ? "t" : "");
1174         add_var(&script_snippet, "squash_onto",
1175                 opts->squash_onto ? oid_to_hex(opts->squash_onto) : "");
1176         add_var(&script_snippet, "git_format_patch_opt",
1177                 opts->git_format_patch_opt.buf);
1178
1179         if (is_merge(opts) &&
1180             !(opts->flags & REBASE_INTERACTIVE_EXPLICIT)) {
1181                 strbuf_addstr(&script_snippet,
1182                               "GIT_SEQUENCE_EDITOR=:; export GIT_SEQUENCE_EDITOR; ");
1183                 opts->autosquash = 0;
1184         }
1185
1186         switch (opts->type) {
1187         case REBASE_PRESERVE_MERGES:
1188                 backend = "git-rebase--preserve-merges";
1189                 backend_func = "git_rebase__preserve_merges";
1190                 break;
1191         default:
1192                 BUG("Unhandled rebase type %d", opts->type);
1193                 break;
1194         }
1195
1196         strbuf_addf(&script_snippet,
1197                     ". git-sh-setup && . %s && %s", backend, backend_func);
1198         argv[0] = script_snippet.buf;
1199
1200         status = run_command_v_opt(argv, RUN_USING_SHELL);
1201 finished_rebase:
1202         if (opts->dont_finish_rebase)
1203                 ; /* do nothing */
1204         else if (opts->type == REBASE_MERGE)
1205                 ; /* merge backend cleans up after itself */
1206         else if (status == 0) {
1207                 if (!file_exists(state_dir_path("stopped-sha", opts)))
1208                         finish_rebase(opts);
1209         } else if (status == 2) {
1210                 struct strbuf dir = STRBUF_INIT;
1211
1212                 apply_autostash(opts);
1213                 strbuf_addstr(&dir, opts->state_dir);
1214                 remove_dir_recursively(&dir, 0);
1215                 strbuf_release(&dir);
1216                 die("Nothing to do");
1217         }
1218
1219         strbuf_release(&script_snippet);
1220
1221         return status ? -1 : 0;
1222 }
1223
1224 static int rebase_config(const char *var, const char *value, void *data)
1225 {
1226         struct rebase_options *opts = data;
1227
1228         if (!strcmp(var, "rebase.stat")) {
1229                 if (git_config_bool(var, value))
1230                         opts->flags |= REBASE_DIFFSTAT;
1231                 else
1232                         opts->flags &= ~REBASE_DIFFSTAT;
1233                 return 0;
1234         }
1235
1236         if (!strcmp(var, "rebase.autosquash")) {
1237                 opts->autosquash = git_config_bool(var, value);
1238                 return 0;
1239         }
1240
1241         if (!strcmp(var, "commit.gpgsign")) {
1242                 free(opts->gpg_sign_opt);
1243                 opts->gpg_sign_opt = git_config_bool(var, value) ?
1244                         xstrdup("-S") : NULL;
1245                 return 0;
1246         }
1247
1248         if (!strcmp(var, "rebase.autostash")) {
1249                 opts->autostash = git_config_bool(var, value);
1250                 return 0;
1251         }
1252
1253         if (!strcmp(var, "rebase.reschedulefailedexec")) {
1254                 opts->reschedule_failed_exec = git_config_bool(var, value);
1255                 return 0;
1256         }
1257
1258         if (!strcmp(var, "rebase.usebuiltin")) {
1259                 opts->use_legacy_rebase = !git_config_bool(var, value);
1260                 return 0;
1261         }
1262
1263         if (!strcmp(var, "rebase.backend")) {
1264                 return git_config_string(&opts->default_backend, var, value);
1265         }
1266
1267         return git_default_config(var, value, data);
1268 }
1269
1270 /*
1271  * Determines whether the commits in from..to are linear, i.e. contain
1272  * no merge commits. This function *expects* `from` to be an ancestor of
1273  * `to`.
1274  */
1275 static int is_linear_history(struct commit *from, struct commit *to)
1276 {
1277         while (to && to != from) {
1278                 parse_commit(to);
1279                 if (!to->parents)
1280                         return 1;
1281                 if (to->parents->next)
1282                         return 0;
1283                 to = to->parents->item;
1284         }
1285         return 1;
1286 }
1287
1288 static int can_fast_forward(struct commit *onto, struct commit *upstream,
1289                             struct commit *restrict_revision,
1290                             struct object_id *head_oid, struct object_id *merge_base)
1291 {
1292         struct commit *head = lookup_commit(the_repository, head_oid);
1293         struct commit_list *merge_bases = NULL;
1294         int res = 0;
1295
1296         if (!head)
1297                 goto done;
1298
1299         merge_bases = get_merge_bases(onto, head);
1300         if (!merge_bases || merge_bases->next) {
1301                 oidcpy(merge_base, &null_oid);
1302                 goto done;
1303         }
1304
1305         oidcpy(merge_base, &merge_bases->item->object.oid);
1306         if (!oideq(merge_base, &onto->object.oid))
1307                 goto done;
1308
1309         if (restrict_revision && !oideq(&restrict_revision->object.oid, merge_base))
1310                 goto done;
1311
1312         if (!upstream)
1313                 goto done;
1314
1315         free_commit_list(merge_bases);
1316         merge_bases = get_merge_bases(upstream, head);
1317         if (!merge_bases || merge_bases->next)
1318                 goto done;
1319
1320         if (!oideq(&onto->object.oid, &merge_bases->item->object.oid))
1321                 goto done;
1322
1323         res = 1;
1324
1325 done:
1326         free_commit_list(merge_bases);
1327         return res && is_linear_history(onto, head);
1328 }
1329
1330 static int parse_opt_am(const struct option *opt, const char *arg, int unset)
1331 {
1332         struct rebase_options *opts = opt->value;
1333
1334         BUG_ON_OPT_NEG(unset);
1335         BUG_ON_OPT_ARG(arg);
1336
1337         opts->type = REBASE_APPLY;
1338
1339         return 0;
1340 }
1341
1342 /* -i followed by -m is still -i */
1343 static int parse_opt_merge(const struct option *opt, const char *arg, int unset)
1344 {
1345         struct rebase_options *opts = opt->value;
1346
1347         BUG_ON_OPT_NEG(unset);
1348         BUG_ON_OPT_ARG(arg);
1349
1350         if (!is_merge(opts))
1351                 opts->type = REBASE_MERGE;
1352
1353         return 0;
1354 }
1355
1356 /* -i followed by -p is still explicitly interactive, but -p alone is not */
1357 static int parse_opt_interactive(const struct option *opt, const char *arg,
1358                                  int unset)
1359 {
1360         struct rebase_options *opts = opt->value;
1361
1362         BUG_ON_OPT_NEG(unset);
1363         BUG_ON_OPT_ARG(arg);
1364
1365         opts->type = REBASE_MERGE;
1366         opts->flags |= REBASE_INTERACTIVE_EXPLICIT;
1367
1368         return 0;
1369 }
1370
1371 static enum empty_type parse_empty_value(const char *value)
1372 {
1373         if (!strcasecmp(value, "drop"))
1374                 return EMPTY_DROP;
1375         else if (!strcasecmp(value, "keep"))
1376                 return EMPTY_KEEP;
1377         else if (!strcasecmp(value, "ask"))
1378                 return EMPTY_ASK;
1379
1380         die(_("unrecognized empty type '%s'; valid values are \"drop\", \"keep\", and \"ask\"."), value);
1381 }
1382
1383 static int parse_opt_empty(const struct option *opt, const char *arg, int unset)
1384 {
1385         struct rebase_options *options = opt->value;
1386         enum empty_type value = parse_empty_value(arg);
1387
1388         BUG_ON_OPT_NEG(unset);
1389
1390         options->empty = value;
1391         return 0;
1392 }
1393
1394 static void NORETURN error_on_missing_default_upstream(void)
1395 {
1396         struct branch *current_branch = branch_get(NULL);
1397
1398         printf(_("%s\n"
1399                  "Please specify which branch you want to rebase against.\n"
1400                  "See git-rebase(1) for details.\n"
1401                  "\n"
1402                  "    git rebase '<branch>'\n"
1403                  "\n"),
1404                 current_branch ? _("There is no tracking information for "
1405                         "the current branch.") :
1406                         _("You are not currently on a branch."));
1407
1408         if (current_branch) {
1409                 const char *remote = current_branch->remote_name;
1410
1411                 if (!remote)
1412                         remote = _("<remote>");
1413
1414                 printf(_("If you wish to set tracking information for this "
1415                          "branch you can do so with:\n"
1416                          "\n"
1417                          "    git branch --set-upstream-to=%s/<branch> %s\n"
1418                          "\n"),
1419                        remote, current_branch->name);
1420         }
1421         exit(1);
1422 }
1423
1424 static void set_reflog_action(struct rebase_options *options)
1425 {
1426         const char *env;
1427         struct strbuf buf = STRBUF_INIT;
1428
1429         if (!is_merge(options))
1430                 return;
1431
1432         env = getenv(GIT_REFLOG_ACTION_ENVIRONMENT);
1433         if (env && strcmp("rebase", env))
1434                 return; /* only override it if it is "rebase" */
1435
1436         strbuf_addf(&buf, "rebase (%s)", options->action);
1437         setenv(GIT_REFLOG_ACTION_ENVIRONMENT, buf.buf, 1);
1438         strbuf_release(&buf);
1439 }
1440
1441 static int check_exec_cmd(const char *cmd)
1442 {
1443         if (strchr(cmd, '\n'))
1444                 return error(_("exec commands cannot contain newlines"));
1445
1446         /* Does the command consist purely of whitespace? */
1447         if (!cmd[strspn(cmd, " \t\r\f\v")])
1448                 return error(_("empty exec command"));
1449
1450         return 0;
1451 }
1452
1453
1454 int cmd_rebase(int argc, const char **argv, const char *prefix)
1455 {
1456         struct rebase_options options = REBASE_OPTIONS_INIT;
1457         const char *branch_name;
1458         int ret, flags, total_argc, in_progress = 0;
1459         int keep_base = 0;
1460         int ok_to_skip_pre_rebase = 0;
1461         struct strbuf msg = STRBUF_INIT;
1462         struct strbuf revisions = STRBUF_INIT;
1463         struct strbuf buf = STRBUF_INIT;
1464         struct object_id merge_base;
1465         enum action action = ACTION_NONE;
1466         const char *gpg_sign = NULL;
1467         struct string_list exec = STRING_LIST_INIT_NODUP;
1468         const char *rebase_merges = NULL;
1469         int fork_point = -1;
1470         struct string_list strategy_options = STRING_LIST_INIT_NODUP;
1471         struct object_id squash_onto;
1472         char *squash_onto_name = NULL;
1473         int reschedule_failed_exec = -1;
1474         int allow_preemptive_ff = 1;
1475         struct option builtin_rebase_options[] = {
1476                 OPT_STRING(0, "onto", &options.onto_name,
1477                            N_("revision"),
1478                            N_("rebase onto given branch instead of upstream")),
1479                 OPT_BOOL(0, "keep-base", &keep_base,
1480                          N_("use the merge-base of upstream and branch as the current base")),
1481                 OPT_BOOL(0, "no-verify", &ok_to_skip_pre_rebase,
1482                          N_("allow pre-rebase hook to run")),
1483                 OPT_NEGBIT('q', "quiet", &options.flags,
1484                            N_("be quiet. implies --no-stat"),
1485                            REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1486                 OPT_BIT('v', "verbose", &options.flags,
1487                         N_("display a diffstat of what changed upstream"),
1488                         REBASE_NO_QUIET | REBASE_VERBOSE | REBASE_DIFFSTAT),
1489                 {OPTION_NEGBIT, 'n', "no-stat", &options.flags, NULL,
1490                         N_("do not show diffstat of what changed upstream"),
1491                         PARSE_OPT_NOARG, NULL, REBASE_DIFFSTAT },
1492                 OPT_BOOL(0, "signoff", &options.signoff,
1493                          N_("add a Signed-off-by: line to each commit")),
1494                 OPT_PASSTHRU_ARGV(0, "ignore-whitespace", &options.git_am_opts,
1495                                   NULL, N_("passed to 'git am'"),
1496                                   PARSE_OPT_NOARG),
1497                 OPT_PASSTHRU_ARGV(0, "committer-date-is-author-date",
1498                                   &options.git_am_opts, NULL,
1499                                   N_("passed to 'git am'"), PARSE_OPT_NOARG),
1500                 OPT_PASSTHRU_ARGV(0, "ignore-date", &options.git_am_opts, NULL,
1501                                   N_("passed to 'git am'"), PARSE_OPT_NOARG),
1502                 OPT_PASSTHRU_ARGV('C', NULL, &options.git_am_opts, N_("n"),
1503                                   N_("passed to 'git apply'"), 0),
1504                 OPT_PASSTHRU_ARGV(0, "whitespace", &options.git_am_opts,
1505                                   N_("action"), N_("passed to 'git apply'"), 0),
1506                 OPT_BIT('f', "force-rebase", &options.flags,
1507                         N_("cherry-pick all commits, even if unchanged"),
1508                         REBASE_FORCE),
1509                 OPT_BIT(0, "no-ff", &options.flags,
1510                         N_("cherry-pick all commits, even if unchanged"),
1511                         REBASE_FORCE),
1512                 OPT_CMDMODE(0, "continue", &action, N_("continue"),
1513                             ACTION_CONTINUE),
1514                 OPT_CMDMODE(0, "skip", &action,
1515                             N_("skip current patch and continue"), ACTION_SKIP),
1516                 OPT_CMDMODE(0, "abort", &action,
1517                             N_("abort and check out the original branch"),
1518                             ACTION_ABORT),
1519                 OPT_CMDMODE(0, "quit", &action,
1520                             N_("abort but keep HEAD where it is"), ACTION_QUIT),
1521                 OPT_CMDMODE(0, "edit-todo", &action, N_("edit the todo list "
1522                             "during an interactive rebase"), ACTION_EDIT_TODO),
1523                 OPT_CMDMODE(0, "show-current-patch", &action,
1524                             N_("show the patch file being applied or merged"),
1525                             ACTION_SHOW_CURRENT_PATCH),
1526                 { OPTION_CALLBACK, 0, "apply", &options, NULL,
1527                         N_("use apply strategies to rebase"),
1528                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1529                         parse_opt_am },
1530                 { OPTION_CALLBACK, 'm', "merge", &options, NULL,
1531                         N_("use merging strategies to rebase"),
1532                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1533                         parse_opt_merge },
1534                 { OPTION_CALLBACK, 'i', "interactive", &options, NULL,
1535                         N_("let the user edit the list of commits to rebase"),
1536                         PARSE_OPT_NOARG | PARSE_OPT_NONEG,
1537                         parse_opt_interactive },
1538                 OPT_SET_INT_F('p', "preserve-merges", &options.type,
1539                               N_("(DEPRECATED) try to recreate merges instead of "
1540                                  "ignoring them"),
1541                               REBASE_PRESERVE_MERGES, PARSE_OPT_HIDDEN),
1542                 OPT_RERERE_AUTOUPDATE(&options.allow_rerere_autoupdate),
1543                 OPT_CALLBACK_F(0, "empty", &options, "{drop,keep,ask}",
1544                                N_("how to handle commits that become empty"),
1545                                PARSE_OPT_NONEG, parse_opt_empty),
1546                 { OPTION_CALLBACK, 'k', "keep-empty", &options, NULL,
1547                         N_("(DEPRECATED) keep empty commits"),
1548                         PARSE_OPT_NOARG | PARSE_OPT_HIDDEN,
1549                         parse_opt_keep_empty },
1550                 OPT_BOOL(0, "autosquash", &options.autosquash,
1551                          N_("move commits that begin with "
1552                             "squash!/fixup! under -i")),
1553                 { OPTION_STRING, 'S', "gpg-sign", &gpg_sign, N_("key-id"),
1554                         N_("GPG-sign commits"),
1555                         PARSE_OPT_OPTARG, NULL, (intptr_t) "" },
1556                 OPT_BOOL(0, "autostash", &options.autostash,
1557                          N_("automatically stash/stash pop before and after")),
1558                 OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
1559                                 N_("add exec lines after each commit of the "
1560                                    "editable list")),
1561                 OPT_BOOL_F(0, "allow-empty-message",
1562                            &options.allow_empty_message,
1563                            N_("allow rebasing commits with empty messages"),
1564                            PARSE_OPT_HIDDEN),
1565                 {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
1566                         N_("mode"),
1567                         N_("try to rebase merges instead of skipping them"),
1568                         PARSE_OPT_OPTARG, NULL, (intptr_t)""},
1569                 OPT_BOOL(0, "fork-point", &fork_point,
1570                          N_("use 'merge-base --fork-point' to refine upstream")),
1571                 OPT_STRING('s', "strategy", &options.strategy,
1572                            N_("strategy"), N_("use the given merge strategy")),
1573                 OPT_STRING_LIST('X', "strategy-option", &strategy_options,
1574                                 N_("option"),
1575                                 N_("pass the argument through to the merge "
1576                                    "strategy")),
1577                 OPT_BOOL(0, "root", &options.root,
1578                          N_("rebase all reachable commits up to the root(s)")),
1579                 OPT_BOOL(0, "reschedule-failed-exec",
1580                          &reschedule_failed_exec,
1581                          N_("automatically re-schedule any `exec` that fails")),
1582                 OPT_END(),
1583         };
1584         int i;
1585
1586         if (argc == 2 && !strcmp(argv[1], "-h"))
1587                 usage_with_options(builtin_rebase_usage,
1588                                    builtin_rebase_options);
1589
1590         options.allow_empty_message = 1;
1591         git_config(rebase_config, &options);
1592
1593         if (options.use_legacy_rebase ||
1594             !git_env_bool("GIT_TEST_REBASE_USE_BUILTIN", -1))
1595                 warning(_("the rebase.useBuiltin support has been removed!\n"
1596                           "See its entry in 'git help config' for details."));
1597
1598         strbuf_reset(&buf);
1599         strbuf_addf(&buf, "%s/applying", apply_dir());
1600         if(file_exists(buf.buf))
1601                 die(_("It looks like 'git am' is in progress. Cannot rebase."));
1602
1603         if (is_directory(apply_dir())) {
1604                 options.type = REBASE_APPLY;
1605                 options.state_dir = apply_dir();
1606         } else if (is_directory(merge_dir())) {
1607                 strbuf_reset(&buf);
1608                 strbuf_addf(&buf, "%s/rewritten", merge_dir());
1609                 if (is_directory(buf.buf)) {
1610                         options.type = REBASE_PRESERVE_MERGES;
1611                         options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1612                 } else {
1613                         strbuf_reset(&buf);
1614                         strbuf_addf(&buf, "%s/interactive", merge_dir());
1615                         if(file_exists(buf.buf)) {
1616                                 options.type = REBASE_MERGE;
1617                                 options.flags |= REBASE_INTERACTIVE_EXPLICIT;
1618                         } else
1619                                 options.type = REBASE_MERGE;
1620                 }
1621                 options.state_dir = merge_dir();
1622         }
1623
1624         if (options.type != REBASE_UNSPECIFIED)
1625                 in_progress = 1;
1626
1627         total_argc = argc;
1628         argc = parse_options(argc, argv, prefix,
1629                              builtin_rebase_options,
1630                              builtin_rebase_usage, 0);
1631
1632         if (action != ACTION_NONE && total_argc != 2) {
1633                 usage_with_options(builtin_rebase_usage,
1634                                    builtin_rebase_options);
1635         }
1636
1637         if (argc > 2)
1638                 usage_with_options(builtin_rebase_usage,
1639                                    builtin_rebase_options);
1640
1641         if (options.type == REBASE_PRESERVE_MERGES)
1642                 warning(_("git rebase --preserve-merges is deprecated. "
1643                           "Use --rebase-merges instead."));
1644
1645         if (keep_base) {
1646                 if (options.onto_name)
1647                         die(_("cannot combine '--keep-base' with '--onto'"));
1648                 if (options.root)
1649                         die(_("cannot combine '--keep-base' with '--root'"));
1650         }
1651
1652         if (action != ACTION_NONE && !in_progress)
1653                 die(_("No rebase in progress?"));
1654         setenv(GIT_REFLOG_ACTION_ENVIRONMENT, "rebase", 0);
1655
1656         if (action == ACTION_EDIT_TODO && !is_merge(&options))
1657                 die(_("The --edit-todo action can only be used during "
1658                       "interactive rebase."));
1659
1660         if (trace2_is_enabled()) {
1661                 if (is_merge(&options))
1662                         trace2_cmd_mode("interactive");
1663                 else if (exec.nr)
1664                         trace2_cmd_mode("interactive-exec");
1665                 else
1666                         trace2_cmd_mode(action_names[action]);
1667         }
1668
1669         switch (action) {
1670         case ACTION_CONTINUE: {
1671                 struct object_id head;
1672                 struct lock_file lock_file = LOCK_INIT;
1673                 int fd;
1674
1675                 options.action = "continue";
1676                 set_reflog_action(&options);
1677
1678                 /* Sanity check */
1679                 if (get_oid("HEAD", &head))
1680                         die(_("Cannot read HEAD"));
1681
1682                 fd = hold_locked_index(&lock_file, 0);
1683                 if (repo_read_index(the_repository) < 0)
1684                         die(_("could not read index"));
1685                 refresh_index(the_repository->index, REFRESH_QUIET, NULL, NULL,
1686                               NULL);
1687                 if (0 <= fd)
1688                         repo_update_index_if_able(the_repository, &lock_file);
1689                 rollback_lock_file(&lock_file);
1690
1691                 if (has_unstaged_changes(the_repository, 1)) {
1692                         puts(_("You must edit all merge conflicts and then\n"
1693                                "mark them as resolved using git add"));
1694                         exit(1);
1695                 }
1696                 if (read_basic_state(&options))
1697                         exit(1);
1698                 goto run_rebase;
1699         }
1700         case ACTION_SKIP: {
1701                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1702
1703                 options.action = "skip";
1704                 set_reflog_action(&options);
1705
1706                 rerere_clear(the_repository, &merge_rr);
1707                 string_list_clear(&merge_rr, 1);
1708
1709                 if (reset_head(NULL, "reset", NULL, RESET_HEAD_HARD,
1710                                NULL, NULL) < 0)
1711                         die(_("could not discard worktree changes"));
1712                 remove_branch_state(the_repository, 0);
1713                 if (read_basic_state(&options))
1714                         exit(1);
1715                 goto run_rebase;
1716         }
1717         case ACTION_ABORT: {
1718                 struct string_list merge_rr = STRING_LIST_INIT_DUP;
1719                 options.action = "abort";
1720                 set_reflog_action(&options);
1721
1722                 rerere_clear(the_repository, &merge_rr);
1723                 string_list_clear(&merge_rr, 1);
1724
1725                 if (read_basic_state(&options))
1726                         exit(1);
1727                 if (reset_head(&options.orig_head, "reset",
1728                                options.head_name, RESET_HEAD_HARD,
1729                                NULL, NULL) < 0)
1730                         die(_("could not move back to %s"),
1731                             oid_to_hex(&options.orig_head));
1732                 remove_branch_state(the_repository, 0);
1733                 ret = !!finish_rebase(&options);
1734                 goto cleanup;
1735         }
1736         case ACTION_QUIT: {
1737                 if (options.type == REBASE_MERGE) {
1738                         struct replay_opts replay = REPLAY_OPTS_INIT;
1739
1740                         replay.action = REPLAY_INTERACTIVE_REBASE;
1741                         ret = !!sequencer_remove_state(&replay);
1742                 } else {
1743                         strbuf_reset(&buf);
1744                         strbuf_addstr(&buf, options.state_dir);
1745                         ret = !!remove_dir_recursively(&buf, 0);
1746                         if (ret)
1747                                 error(_("could not remove '%s'"),
1748                                        options.state_dir);
1749                 }
1750                 goto cleanup;
1751         }
1752         case ACTION_EDIT_TODO:
1753                 options.action = "edit-todo";
1754                 options.dont_finish_rebase = 1;
1755                 goto run_rebase;
1756         case ACTION_SHOW_CURRENT_PATCH:
1757                 options.action = "show-current-patch";
1758                 options.dont_finish_rebase = 1;
1759                 goto run_rebase;
1760         case ACTION_NONE:
1761                 break;
1762         default:
1763                 BUG("action: %d", action);
1764         }
1765
1766         /* Make sure no rebase is in progress */
1767         if (in_progress) {
1768                 const char *last_slash = strrchr(options.state_dir, '/');
1769                 const char *state_dir_base =
1770                         last_slash ? last_slash + 1 : options.state_dir;
1771                 const char *cmd_live_rebase =
1772                         "git rebase (--continue | --abort | --skip)";
1773                 strbuf_reset(&buf);
1774                 strbuf_addf(&buf, "rm -fr \"%s\"", options.state_dir);
1775                 die(_("It seems that there is already a %s directory, and\n"
1776                       "I wonder if you are in the middle of another rebase.  "
1777                       "If that is the\n"
1778                       "case, please try\n\t%s\n"
1779                       "If that is not the case, please\n\t%s\n"
1780                       "and run me again.  I am stopping in case you still "
1781                       "have something\n"
1782                       "valuable there.\n"),
1783                     state_dir_base, cmd_live_rebase, buf.buf);
1784         }
1785
1786         if ((options.flags & REBASE_INTERACTIVE_EXPLICIT) ||
1787             (action != ACTION_NONE) ||
1788             (exec.nr > 0) ||
1789             options.autosquash) {
1790                 allow_preemptive_ff = 0;
1791         }
1792
1793         for (i = 0; i < options.git_am_opts.argc; i++) {
1794                 const char *option = options.git_am_opts.argv[i], *p;
1795                 if (!strcmp(option, "--committer-date-is-author-date") ||
1796                     !strcmp(option, "--ignore-date") ||
1797                     !strcmp(option, "--whitespace=fix") ||
1798                     !strcmp(option, "--whitespace=strip"))
1799                         allow_preemptive_ff = 0;
1800                 else if (skip_prefix(option, "-C", &p)) {
1801                         while (*p)
1802                                 if (!isdigit(*(p++)))
1803                                         die(_("switch `C' expects a "
1804                                               "numerical value"));
1805                 } else if (skip_prefix(option, "--whitespace=", &p)) {
1806                         if (*p && strcmp(p, "warn") && strcmp(p, "nowarn") &&
1807                             strcmp(p, "error") && strcmp(p, "error-all"))
1808                                 die("Invalid whitespace option: '%s'", p);
1809                 }
1810         }
1811
1812         for (i = 0; i < exec.nr; i++)
1813                 if (check_exec_cmd(exec.items[i].string))
1814                         exit(1);
1815
1816         if (!(options.flags & REBASE_NO_QUIET))
1817                 argv_array_push(&options.git_am_opts, "-q");
1818
1819         if (options.empty != EMPTY_UNSPECIFIED)
1820                 imply_merge(&options, "--empty");
1821
1822         if (gpg_sign) {
1823                 free(options.gpg_sign_opt);
1824                 options.gpg_sign_opt = xstrfmt("-S%s", gpg_sign);
1825         }
1826
1827         if (exec.nr) {
1828                 int i;
1829
1830                 imply_merge(&options, "--exec");
1831
1832                 strbuf_reset(&buf);
1833                 for (i = 0; i < exec.nr; i++)
1834                         strbuf_addf(&buf, "exec %s\n", exec.items[i].string);
1835                 options.cmd = xstrdup(buf.buf);
1836         }
1837
1838         if (rebase_merges) {
1839                 if (!*rebase_merges)
1840                         ; /* default mode; do nothing */
1841                 else if (!strcmp("rebase-cousins", rebase_merges))
1842                         options.rebase_cousins = 1;
1843                 else if (strcmp("no-rebase-cousins", rebase_merges))
1844                         die(_("Unknown mode: %s"), rebase_merges);
1845                 options.rebase_merges = 1;
1846                 imply_merge(&options, "--rebase-merges");
1847         }
1848
1849         if (strategy_options.nr) {
1850                 int i;
1851
1852                 if (!options.strategy)
1853                         options.strategy = "recursive";
1854
1855                 strbuf_reset(&buf);
1856                 for (i = 0; i < strategy_options.nr; i++)
1857                         strbuf_addf(&buf, " --%s",
1858                                     strategy_options.items[i].string);
1859                 options.strategy_opts = xstrdup(buf.buf);
1860         }
1861
1862         if (options.strategy) {
1863                 options.strategy = xstrdup(options.strategy);
1864                 switch (options.type) {
1865                 case REBASE_APPLY:
1866                         die(_("--strategy requires --merge or --interactive"));
1867                 case REBASE_MERGE:
1868                 case REBASE_PRESERVE_MERGES:
1869                         /* compatible */
1870                         break;
1871                 case REBASE_UNSPECIFIED:
1872                         options.type = REBASE_MERGE;
1873                         break;
1874                 default:
1875                         BUG("unhandled rebase type (%d)", options.type);
1876                 }
1877         }
1878
1879         if (options.type == REBASE_MERGE)
1880                 imply_merge(&options, "--merge");
1881
1882         if (options.root && !options.onto_name)
1883                 imply_merge(&options, "--root without --onto");
1884
1885         if (isatty(2) && options.flags & REBASE_NO_QUIET)
1886                 strbuf_addstr(&options.git_format_patch_opt, " --progress");
1887
1888         if (options.git_am_opts.argc || options.type == REBASE_APPLY) {
1889                 /* all am options except -q are compatible only with --apply */
1890                 for (i = options.git_am_opts.argc - 1; i >= 0; i--)
1891                         if (strcmp(options.git_am_opts.argv[i], "-q"))
1892                                 break;
1893
1894                 if (i >= 0) {
1895                         if (is_merge(&options))
1896                                 die(_("cannot combine apply options with "
1897                                       "merge options"));
1898                         else
1899                                 options.type = REBASE_APPLY;
1900                 }
1901         }
1902
1903         if (options.type == REBASE_UNSPECIFIED) {
1904                 if (!strcmp(options.default_backend, "merge"))
1905                         imply_merge(&options, "--merge");
1906                 else if (!strcmp(options.default_backend, "apply"))
1907                         options.type = REBASE_APPLY;
1908                 else
1909                         die(_("Unknown rebase backend: %s"),
1910                             options.default_backend);
1911         }
1912
1913         switch (options.type) {
1914         case REBASE_MERGE:
1915         case REBASE_PRESERVE_MERGES:
1916                 options.state_dir = merge_dir();
1917                 break;
1918         case REBASE_APPLY:
1919                 options.state_dir = apply_dir();
1920                 break;
1921         default:
1922                 BUG("options.type was just set above; should be unreachable.");
1923         }
1924
1925         if (options.empty == EMPTY_UNSPECIFIED) {
1926                 if (options.flags & REBASE_INTERACTIVE_EXPLICIT)
1927                         options.empty = EMPTY_ASK;
1928                 else if (exec.nr > 0)
1929                         options.empty = EMPTY_KEEP;
1930                 else
1931                         options.empty = EMPTY_DROP;
1932         }
1933         if (reschedule_failed_exec > 0 && !is_merge(&options))
1934                 die(_("--reschedule-failed-exec requires "
1935                       "--exec or --interactive"));
1936         if (reschedule_failed_exec >= 0)
1937                 options.reschedule_failed_exec = reschedule_failed_exec;
1938
1939         if (options.signoff) {
1940                 if (options.type == REBASE_PRESERVE_MERGES)
1941                         die("cannot combine '--signoff' with "
1942                             "'--preserve-merges'");
1943                 argv_array_push(&options.git_am_opts, "--signoff");
1944                 options.flags |= REBASE_FORCE;
1945         }
1946
1947         if (options.type == REBASE_PRESERVE_MERGES) {
1948                 /*
1949                  * Note: incompatibility with --signoff handled in signoff block above
1950                  * Note: incompatibility with --interactive is just a strong warning;
1951                  *       git-rebase.txt caveats with "unless you know what you are doing"
1952                  */
1953                 if (options.rebase_merges)
1954                         die(_("cannot combine '--preserve-merges' with "
1955                               "'--rebase-merges'"));
1956
1957                 if (options.reschedule_failed_exec)
1958                         die(_("error: cannot combine '--preserve-merges' with "
1959                               "'--reschedule-failed-exec'"));
1960         }
1961
1962         if (!options.root) {
1963                 if (argc < 1) {
1964                         struct branch *branch;
1965
1966                         branch = branch_get(NULL);
1967                         options.upstream_name = branch_get_upstream(branch,
1968                                                                     NULL);
1969                         if (!options.upstream_name)
1970                                 error_on_missing_default_upstream();
1971                         if (fork_point < 0)
1972                                 fork_point = 1;
1973                 } else {
1974                         options.upstream_name = argv[0];
1975                         argc--;
1976                         argv++;
1977                         if (!strcmp(options.upstream_name, "-"))
1978                                 options.upstream_name = "@{-1}";
1979                 }
1980                 options.upstream = peel_committish(options.upstream_name);
1981                 if (!options.upstream)
1982                         die(_("invalid upstream '%s'"), options.upstream_name);
1983                 options.upstream_arg = options.upstream_name;
1984         } else {
1985                 if (!options.onto_name) {
1986                         if (commit_tree("", 0, the_hash_algo->empty_tree, NULL,
1987                                         &squash_onto, NULL, NULL) < 0)
1988                                 die(_("Could not create new root commit"));
1989                         options.squash_onto = &squash_onto;
1990                         options.onto_name = squash_onto_name =
1991                                 xstrdup(oid_to_hex(&squash_onto));
1992                 } else
1993                         options.root_with_onto = 1;
1994
1995                 options.upstream_name = NULL;
1996                 options.upstream = NULL;
1997                 if (argc > 1)
1998                         usage_with_options(builtin_rebase_usage,
1999                                            builtin_rebase_options);
2000                 options.upstream_arg = "--root";
2001         }
2002
2003         /* Make sure the branch to rebase onto is valid. */
2004         if (keep_base) {
2005                 strbuf_reset(&buf);
2006                 strbuf_addstr(&buf, options.upstream_name);
2007                 strbuf_addstr(&buf, "...");
2008                 options.onto_name = xstrdup(buf.buf);
2009         } else if (!options.onto_name)
2010                 options.onto_name = options.upstream_name;
2011         if (strstr(options.onto_name, "...")) {
2012                 if (get_oid_mb(options.onto_name, &merge_base) < 0) {
2013                         if (keep_base)
2014                                 die(_("'%s': need exactly one merge base with branch"),
2015                                     options.upstream_name);
2016                         else
2017                                 die(_("'%s': need exactly one merge base"),
2018                                     options.onto_name);
2019                 }
2020                 options.onto = lookup_commit_or_die(&merge_base,
2021                                                     options.onto_name);
2022         } else {
2023                 options.onto = peel_committish(options.onto_name);
2024                 if (!options.onto)
2025                         die(_("Does not point to a valid commit '%s'"),
2026                                 options.onto_name);
2027         }
2028
2029         /*
2030          * If the branch to rebase is given, that is the branch we will rebase
2031          * branch_name -- branch/commit being rebased, or
2032          *                HEAD (already detached)
2033          * orig_head -- commit object name of tip of the branch before rebasing
2034          * head_name -- refs/heads/<that-branch> or NULL (detached HEAD)
2035          */
2036         if (argc == 1) {
2037                 /* Is it "rebase other branchname" or "rebase other commit"? */
2038                 branch_name = argv[0];
2039                 options.switch_to = argv[0];
2040
2041                 /* Is it a local branch? */
2042                 strbuf_reset(&buf);
2043                 strbuf_addf(&buf, "refs/heads/%s", branch_name);
2044                 if (!read_ref(buf.buf, &options.orig_head)) {
2045                         die_if_checked_out(buf.buf, 1);
2046                         options.head_name = xstrdup(buf.buf);
2047                 /* If not is it a valid ref (branch or commit)? */
2048                 } else if (!get_oid(branch_name, &options.orig_head))
2049                         options.head_name = NULL;
2050                 else
2051                         die(_("fatal: no such branch/commit '%s'"),
2052                             branch_name);
2053         } else if (argc == 0) {
2054                 /* Do not need to switch branches, we are already on it. */
2055                 options.head_name =
2056                         xstrdup_or_null(resolve_ref_unsafe("HEAD", 0, NULL,
2057                                          &flags));
2058                 if (!options.head_name)
2059                         die(_("No such ref: %s"), "HEAD");
2060                 if (flags & REF_ISSYMREF) {
2061                         if (!skip_prefix(options.head_name,
2062                                          "refs/heads/", &branch_name))
2063                                 branch_name = options.head_name;
2064
2065                 } else {
2066                         FREE_AND_NULL(options.head_name);
2067                         branch_name = "HEAD";
2068                 }
2069                 if (get_oid("HEAD", &options.orig_head))
2070                         die(_("Could not resolve HEAD to a revision"));
2071         } else
2072                 BUG("unexpected number of arguments left to parse");
2073
2074         if (fork_point > 0) {
2075                 struct commit *head =
2076                         lookup_commit_reference(the_repository,
2077                                                 &options.orig_head);
2078                 options.restrict_revision =
2079                         get_fork_point(options.upstream_name, head);
2080         }
2081
2082         if (repo_read_index(the_repository) < 0)
2083                 die(_("could not read index"));
2084
2085         if (options.autostash) {
2086                 struct lock_file lock_file = LOCK_INIT;
2087                 int fd;
2088
2089                 fd = hold_locked_index(&lock_file, 0);
2090                 refresh_cache(REFRESH_QUIET);
2091                 if (0 <= fd)
2092                         repo_update_index_if_able(the_repository, &lock_file);
2093                 rollback_lock_file(&lock_file);
2094
2095                 if (has_unstaged_changes(the_repository, 1) ||
2096                     has_uncommitted_changes(the_repository, 1)) {
2097                         const char *autostash =
2098                                 state_dir_path("autostash", &options);
2099                         struct child_process stash = CHILD_PROCESS_INIT;
2100                         struct object_id oid;
2101
2102                         argv_array_pushl(&stash.args,
2103                                          "stash", "create", "autostash", NULL);
2104                         stash.git_cmd = 1;
2105                         stash.no_stdin = 1;
2106                         strbuf_reset(&buf);
2107                         if (capture_command(&stash, &buf, GIT_MAX_HEXSZ))
2108                                 die(_("Cannot autostash"));
2109                         strbuf_trim_trailing_newline(&buf);
2110                         if (get_oid(buf.buf, &oid))
2111                                 die(_("Unexpected stash response: '%s'"),
2112                                     buf.buf);
2113                         strbuf_reset(&buf);
2114                         strbuf_add_unique_abbrev(&buf, &oid, DEFAULT_ABBREV);
2115
2116                         if (safe_create_leading_directories_const(autostash))
2117                                 die(_("Could not create directory for '%s'"),
2118                                     options.state_dir);
2119                         write_file(autostash, "%s", oid_to_hex(&oid));
2120                         printf(_("Created autostash: %s\n"), buf.buf);
2121                         if (reset_head(NULL, "reset --hard",
2122                                        NULL, RESET_HEAD_HARD, NULL, NULL) < 0)
2123                                 die(_("could not reset --hard"));
2124
2125                         if (discard_index(the_repository->index) < 0 ||
2126                                 repo_read_index(the_repository) < 0)
2127                                 die(_("could not read index"));
2128                 }
2129         }
2130
2131         if (require_clean_work_tree(the_repository, "rebase",
2132                                     _("Please commit or stash them."), 1, 1)) {
2133                 ret = 1;
2134                 goto cleanup;
2135         }
2136
2137         /*
2138          * Now we are rebasing commits upstream..orig_head (or with --root,
2139          * everything leading up to orig_head) on top of onto.
2140          */
2141
2142         /*
2143          * Check if we are already based on onto with linear history,
2144          * in which case we could fast-forward without replacing the commits
2145          * with new commits recreated by replaying their changes.
2146          *
2147          * Note that can_fast_forward() initializes merge_base, so we have to
2148          * call it before checking allow_preemptive_ff.
2149          */
2150         if (can_fast_forward(options.onto, options.upstream, options.restrict_revision,
2151                     &options.orig_head, &merge_base) &&
2152             allow_preemptive_ff) {
2153                 int flag;
2154
2155                 if (!(options.flags & REBASE_FORCE)) {
2156                         /* Lazily switch to the target branch if needed... */
2157                         if (options.switch_to) {
2158                                 strbuf_reset(&buf);
2159                                 strbuf_addf(&buf, "%s: checkout %s",
2160                                             getenv(GIT_REFLOG_ACTION_ENVIRONMENT),
2161                                             options.switch_to);
2162                                 if (reset_head(&options.orig_head, "checkout",
2163                                                options.head_name,
2164                                                RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
2165                                                NULL, buf.buf) < 0) {
2166                                         ret = !!error(_("could not switch to "
2167                                                         "%s"),
2168                                                       options.switch_to);
2169                                         goto cleanup;
2170                                 }
2171                         }
2172
2173                         if (!(options.flags & REBASE_NO_QUIET))
2174                                 ; /* be quiet */
2175                         else if (!strcmp(branch_name, "HEAD") &&
2176                                  resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2177                                 puts(_("HEAD is up to date."));
2178                         else
2179                                 printf(_("Current branch %s is up to date.\n"),
2180                                        branch_name);
2181                         ret = !!finish_rebase(&options);
2182                         goto cleanup;
2183                 } else if (!(options.flags & REBASE_NO_QUIET))
2184                         ; /* be quiet */
2185                 else if (!strcmp(branch_name, "HEAD") &&
2186                          resolve_ref_unsafe("HEAD", 0, NULL, &flag))
2187                         puts(_("HEAD is up to date, rebase forced."));
2188                 else
2189                         printf(_("Current branch %s is up to date, rebase "
2190                                  "forced.\n"), branch_name);
2191         }
2192
2193         /* If a hook exists, give it a chance to interrupt*/
2194         if (!ok_to_skip_pre_rebase &&
2195             run_hook_le(NULL, "pre-rebase", options.upstream_arg,
2196                         argc ? argv[0] : NULL, NULL))
2197                 die(_("The pre-rebase hook refused to rebase."));
2198
2199         if (options.flags & REBASE_DIFFSTAT) {
2200                 struct diff_options opts;
2201
2202                 if (options.flags & REBASE_VERBOSE) {
2203                         if (is_null_oid(&merge_base))
2204                                 printf(_("Changes to %s:\n"),
2205                                        oid_to_hex(&options.onto->object.oid));
2206                         else
2207                                 printf(_("Changes from %s to %s:\n"),
2208                                        oid_to_hex(&merge_base),
2209                                        oid_to_hex(&options.onto->object.oid));
2210                 }
2211
2212                 /* We want color (if set), but no pager */
2213                 diff_setup(&opts);
2214                 opts.stat_width = -1; /* use full terminal width */
2215                 opts.stat_graph_width = -1; /* respect statGraphWidth config */
2216                 opts.output_format |=
2217                         DIFF_FORMAT_SUMMARY | DIFF_FORMAT_DIFFSTAT;
2218                 opts.detect_rename = DIFF_DETECT_RENAME;
2219                 diff_setup_done(&opts);
2220                 diff_tree_oid(is_null_oid(&merge_base) ?
2221                               the_hash_algo->empty_tree : &merge_base,
2222                               &options.onto->object.oid, "", &opts);
2223                 diffcore_std(&opts);
2224                 diff_flush(&opts);
2225         }
2226
2227         if (is_merge(&options))
2228                 goto run_rebase;
2229
2230         /* Detach HEAD and reset the tree */
2231         if (options.flags & REBASE_NO_QUIET)
2232                 printf(_("First, rewinding head to replay your work on top of "
2233                          "it...\n"));
2234
2235         strbuf_addf(&msg, "%s: checkout %s",
2236                     getenv(GIT_REFLOG_ACTION_ENVIRONMENT), options.onto_name);
2237         if (reset_head(&options.onto->object.oid, "checkout", NULL,
2238                        RESET_HEAD_DETACH | RESET_ORIG_HEAD |
2239                        RESET_HEAD_RUN_POST_CHECKOUT_HOOK,
2240                        NULL, msg.buf))
2241                 die(_("Could not detach HEAD"));
2242         strbuf_release(&msg);
2243
2244         /*
2245          * If the onto is a proper descendant of the tip of the branch, then
2246          * we just fast-forwarded.
2247          */
2248         strbuf_reset(&msg);
2249         if (oideq(&merge_base, &options.orig_head)) {
2250                 printf(_("Fast-forwarded %s to %s.\n"),
2251                         branch_name, options.onto_name);
2252                 strbuf_addf(&msg, "rebase finished: %s onto %s",
2253                         options.head_name ? options.head_name : "detached HEAD",
2254                         oid_to_hex(&options.onto->object.oid));
2255                 reset_head(NULL, "Fast-forwarded", options.head_name,
2256                            RESET_HEAD_REFS_ONLY, "HEAD", msg.buf);
2257                 strbuf_release(&msg);
2258                 ret = !!finish_rebase(&options);
2259                 goto cleanup;
2260         }
2261
2262         strbuf_addf(&revisions, "%s..%s",
2263                     options.root ? oid_to_hex(&options.onto->object.oid) :
2264                     (options.restrict_revision ?
2265                      oid_to_hex(&options.restrict_revision->object.oid) :
2266                      oid_to_hex(&options.upstream->object.oid)),
2267                     oid_to_hex(&options.orig_head));
2268
2269         options.revisions = revisions.buf;
2270
2271 run_rebase:
2272         ret = !!run_specific_rebase(&options, action);
2273
2274 cleanup:
2275         strbuf_release(&buf);
2276         strbuf_release(&revisions);
2277         free(options.head_name);
2278         free(options.gpg_sign_opt);
2279         free(options.cmd);
2280         free(squash_onto_name);
2281         return ret;
2282 }