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