git-debrebase

   1 #!/usr/bin/perl -w
   2 # git-debrebase
   3 # Script helping make fast-forwarding histories while still rebasing
   4 # upstream deltas when working on Debian packaging
   5 #
   6 # Copyright (C)2017 Ian Jackson
   7 #
   8 # This program is free software: you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation, either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 # usages:
  22 #    git-debrebase status
  23 #    git-debrebase start       # like ffqrebase start + debrebase launder
  24 #    git-debrebase new-upstream [stuff]  # see below
  25 #    git-debrebase <git-rebase options>  # does debrebase start if necessary
  26 #
  27 #    git-debrebase analyse
  28 #    git-debrebase launder     # prints breakwater tip
  29 #    git-debrebase create-new-upstream-breakwater [-f] <upstreaminfo>...
  30 #
  31 # <upstreaminfo> is
  32 #    [,][<subdir>:][+]<commitid>[,...]
  33 #
  34 # if initial comma is supplied, entries are not positional.  Unspecified
  35 # <subdir> means root (and there may be only one).
  36 # xxx want auto branch names
  37 # xxx too complicated
  38 # how about for now
  39 #    [+]<commit> [<subdir/> [+]<commit>...]
  40 # ?  plus options
  41 #     --new-upstream-different-subtrees
  42 #
  43 #  automatic case
  44 #       git-debrebase new-upstream
  45 #             - previous breakwater merge must be gdr-generated
  46 #             - orig set is the same as before
  47 #             - implicitly uses upstream branches according to orig set
  48 #             - not all upstream branches need be updated
  49 #             - insists on fast-forward of each branch, unless
  50 #                  --force (or --force=<subdir>[/])
  51 #  branch set adjustments
  52 #       git-debrebase new-upstream --add <subdir>/
  53 #       git-debrebase new-upstream --rm <subdir>/
  54 #       git-debrebase new-upstream / [<subdir>/ ...]
  55 #             - orig set is adjusted
  56 #             - otherwise like auto (--add is not checked for ffness, obv)
  57 #             - multiple --add and --rm may be specified
  58 #             - --add makes new upstream the last contributor
  59 #  explicit
  60 #       git-debrebase / [<rootcommitid>] [<subdir>/ [<commitid>] ...]
  61 #             - orig set is precisely as specified now
  62 #             - previous breakwater merge is irrelevant
  63 #             - no fast forward checks
  64 #  for now only explicit with commitids
  65
  66 #         implicitly uses `upstream'
  67 #                                     # (or multiple other branches)
  68 #       git-debrebase new-upstream \
  69 #             [<subdir>/]=<commitid>
  70
  71 #    UPSTREAM[,[[SUBDIR:]SUBUPSTREAM]
  72 #    default for SUBDIR: is from previous upstream merge[xxx terminology]
  73 #
  74 #
  75 #xxx
  76 # when starting must record original start (for ff)
  77 # and new rebase basis
  78 #
  79 #    git-ffqrebase start [BASE]
  80 #                # records previous HEAD so it can be overwritten
  81 #                # records base for future git-ffqrebase
  82 #    git-ffqrebase set-base BASE
  83 #    git-ffqrebase <git-rebase options>
  84 #    git-ffqrebase finish
  85 #    git-ffqrebase status [BRANCH]
  86 #
  87 #  refs/ffqrebase-prev/BRANCH    BRANCH may be refs/...; if not it means
  88 #  refs/ffqrebase-base/BRANCH      refs/heads/BRANCH
  89 #                               zero, one, or both of these may exist
  90 #
  91 # git-debrebase without start, if already started, is willing
  92 # to strip pseudomerges provided that they overwrite exactly
  93 # the previous HEAD
  94 #  xxxx is this right ?  what matters is have we pushed
  95 #    I think in fact the right answer is:
  96 #       git-debrebase always strips out pseudomerges from its branch
  97 #       a pseudomerge is put in at the time we want to push
  98 #       at that time, we make a pseudomerge of the remote tracking
  99 #           branch (if raw git) or the dgit view (if dgit)
 100 #       for raw git git-ffqrebase, do want preciseley to record
 101 #           value of remote tracking branch or our branch, on start, so we
 102 #           overwrite only things we intend to
 103 #  the previous pseudomerge    check for tags and remote branches ?
 104
 105 use strict;
 106
 107 use Memoize;
 108 use Carp;
 109 use Data::Dumper;
 110
 111 use Debian::Dgit qw(:DEFAULT $wa);
 112
 113 sub cfg ($) {
 114     my ($k) = @_;
 115     $/ = "\0";
 116     my @cmd = qw(git config -z);
 117     push @cmd, qw(--get-all) if wantarray;
 118     push @cmd, $k;
 119     my $out = cmdoutput @cmd;
 120     return split /\0/, $out;
 121 }
 122
 123 memoize('cfg');
 124
 125 sub get_commit ($) {
 126     my ($objid) = @_;
 127     my ($type,$data) = git_cat_file $objid;
 128     die unless $type eq 'commit';
 129     $data =~ m/(?<=\n)\n/;
 130     return ($`,$');
 131 }
 132
 133 sub D_DEB ()     { return 0x1; } # debian/ (not including debian/patches/)
 134 sub D_UPS ()     { return 0x2; } # upstream files
 135 sub D_PAT_ADD () { return 0x4; } # debian/patches/ extra patches at end
 136 sub D_PAT_OTH () { return 0x8; } # debian/patches other changes
 137
 138 our $rd = ".git/git-debrebase";
 139 our $ud = "$rd/work";
 140 our @git = qw(git);
 141
 142 sub commit_pr_info ($) {
 143     my ($r) = @_;
 144     return Data::Dumper->dump([$r], [qw(commit)]);
 145 }
 146
 147 sub calculate_committer_authline () {
 148     my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
 149         'DUMMY COMMIT (git-debrebase)', "HEAD:";
 150     my ($h,$m) = get_commit $c;
 151     $h =~ m/^committer .*$/m or confess "($h) ?";
 152     return $&;
 153 }
 154
 155 # classify returns an info hash like this
 156 #   CommitId => $objid
 157 #   Hdr => # commit headers, including 1 final newline
 158 #   Msg => # commit message (so one newline is dropped)
 159 #   Tree => $treeobjid
 160 #   Type => (see below)
 161 #   Parents = [ {
 162 #       Ix => $index # ie 0, 1, 2, ...
 163 #       CommitId
 164 #       Differs => return value from get_differs
 165 #       IsOrigin
 166 #       IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
 167 #     } ...]
 168 #   NewMsg => # commit message, but with any [dgit import ...] edited
 169 #             # to say "[was: ...]"
 170 #
 171 # Types:
 172 #   Packaging
 173 #   Upstream
 174 #   AddPatches
 175 #   Mixed
 176 #   Unknown
 177 #
 178 #   Pseudomerge
 179 #     has additional entres in classification result
 180 #       Overwritten = [ subset of Parents ]
 181 #       Contributor = $the_remaining_Parent
 182 #
 183 #   DgitImportUnpatched
 184 #     has additional entry in classification result
 185 #       OrigParents = [ subset of Parents ]
 186 #
 187 #   BreakwaterUpstreamMerge
 188 #     has additional entry in classification result
 189 #       OrigParents = [ subset of Parents ]
 190
 191 sub classify ($) {
 192     my ($objid) = @_;
 193
 194     my ($h,$m) = get_commit $objid;
 195
 196     my ($t) = $h =~ m/^tree (\w+)$/m or die $objid;
 197     my (@ph) = $h =~ m/^parent (\w+)$/m;
 198     my @p;
 199
 200     my $r = {
 201         CommitId => $objid,
 202         Hdr => $h,
 203         Msg => $m,
 204         Tree => $t,
 205         Parents => \@p,
 206     };
 207
 208     foreach my $ph (@ph) {
 209         push @p, {
 210             Ix => $#p,
 211             CommitId => $ph,
 212             Differs => (get_differs $t, $ph),
 213         };
 214     }
 215
 216     my $classify = sub {
 217         my ($type, @rest) = @_;
 218         $r = { %$r, Type => $type, @rest };
 219         return $r;
 220     };
 221     my $unknown = sub {
 222         my ($why) = @_;
 223         $r = { %$r, Type => qw(Unknown) };
 224         return $r;
 225     };
 226
 227     if (@p == 1) {
 228         my $d = $r->{Parents}[0]{Differs};
 229         if ($d == D_PAT_ADD) {
 230             return $classify->(qw(AddPatches));
 231         } elsif ($d & (D_PAT_ADD|D_PAT_OTH)) {
 232             return $unknown->("edits debian/patches");
 233         } elsif ($d == D_DEB) {
 234             return $classify->(qw(Packaging));
 235         } elsif ($d == D_UPS) {
 236             return $classify->(qw(Upstream));
 237         } elsif ($d == (D_DEB|D_UPS)) {
 238             return $classify->(qw(Mixed));
 239         } elsif ($d == 0) {
 240             return $unknown->("no changes");
 241         } else {
 242             confess "internal error $objid ?";
 243         }
 244     }
 245     if (!@p) {
 246         return $unknown->("origin commit");
 247     }
 248
 249     my @identical = grep { !$_->{Differs} } @p;
 250     if (@p == 2 && @identical == 1) {
 251         my @overwritten = grep { $_->{Differs} } @p;
 252         confess "internal error $objid ?" unless @overwritten==1;
 253         return $classify->(qw(Pseudomerge),
 254                            Overwritten => $overwritten[0],
 255                            Contributor => $identical[0]);
 256     }
 257     if (@p == 2 && @identical == 2) {
 258         my @bytime = nsort_by {
 259             my ($ph,$pm) = get_commit $_->{CommitId};
 260             $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
 261             $1;
 262         } @p;
 263         return $classify->(qw(Pseudomerge),
 264                            SubType => qw(Ambiguous),
 265                            Overwritten => $bytime[0],
 266                            Contributor => $bytime[1]);
 267     }
 268     foreach my $p (@p) {
 269         my ($p_h, $p_m) = get_commit $p;
 270         $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
 271         ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
 272     }
 273     my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' } @p;
 274     my $m2 = $m;
 275     if (!(grep { !$_->{IsOrigin} } @p) and
 276         (@orig_ps >= @p - 1) and
 277         $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
 278         $r->{NewMsg} = $m2;
 279         return $classify->(qw(DgitImportUnpatched),
 280                            OrigParents => \@orig_ps);
 281     }
 282
 283     my ($stype, $series) = git_cat_file "$t:debian/patches/series";
 284     my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
 285
 286     # How to decide about l/r ordering of breakwater merges ?  git
 287     # --topo-order prefers to expand 2nd parent first.  There's
 288     # already an easy rune to look for debian/ history anyway (git log
 289     # debian/) so debian breakwater branch should be 1st parent; that
 290     # way also there's also an easy rune to look for the upstream
 291     # patches (--topo-order).
 292     if (@p == 2 &&
 293         !$haspatches &&
 294         !$p[0]{IsOrigin} && # breakwater merge never starts with an origin
 295         !($p[0]{Differs} & ~D_DEB) &&
 296         !($p[1]{Differs} & ~D_UPS)) {
 297         return $classify->(qw(BreakwaterUpstreamMerge),
 298                            OrigParents => [ $p[1] ]);
 299     }
 300     # xxx multi-.orig upstreams
 301
 302     return $unknown->("complex merge");
 303 }
 304
 305 sub walk ($;$$$$);
 306 sub walk {
 307     my ($input,
 308         $nogenerate,$report,
 309         $wantdebonly,$depth) = @_;
 310     # go through commits backwards
 311     # we generate two lists of commits to apply
 312     # => ($tip, $breakwater_tip)
 313     my (@deb_cl, @ups_cl, @processed);
 314     my %found;
 315     my @pseudomerges;
 316
 317     $depth //= 0;
 318
 319     my $cl;
 320     my $xmsg = sub {
 321         my ($appendinfo) = @_;
 322         my $ms = $cl->{Msg};
 323         chomp $ms;
 324         $ms .= "\n\n[git-debrebase $appendinfo]\n";
 325         return (Msg => $ms);
 326     };
 327     my $rewrite_from_here = sub {
 328         push @processed, { SpecialMethod => 'StartRewrite' };
 329     };
 330
 331     my $cur = $input;
 332     my $basis;
 333
 334     my $prdelim = "";
 335     my $prprdelim = sub { print $report $prdelim if $report; $prdelim=""; };
 336
 337     for (;;) {
 338         $cl = classify $cur;
 339         my $ty = $cl->{Type};
 340         my $st = $cl->{SubType};
 341         if ($report) {
 342             print $report $prdelim, "$cl->{CommitId} $cl->{Type}";
 343             $prdelim = "\n";
 344         }
 345         $found{$ty. ( defined($st) ? "-$st" : '' )}++;
 346         push @processed, $cl;
 347         my $p0 = $cl->{Parents}[0]{CommitId};
 348         if ($ty eq 'AddPatches') {
 349             $cur = $p0;
 350             $rewrite_from_here->();
 351             next;
 352         } elsif ($ty eq 'Packaging') {
 353             push @deb_cl, $cl;
 354             $cur = $p0;
 355             next;
 356         } elsif ($ty eq 'Upstream') {
 357             push @ups_cl, $cl;
 358             $cur = $p0;
 359             next;
 360         } elsif ($ty eq 'Mixed') {
 361             my $queue = sub {
 362                 my ($q, $wh) = @_;
 363                 my $cls = { $cl, $xmsg->("split mixed commit: $wh part") };
 364                 push @$q, $cls;
 365             };
 366             $queue->(\@deb_cl, "debian");
 367             $queue->(\@ups_cl, "upstream");
 368             $rewrite_from_here->();
 369             next;
 370         } elsif ($ty eq 'Pseudomerge') {
 371             print $report " Contributor=$ty->{Contributor}" if $report;
 372             push @pseudomerges, $cl;
 373             $rewrite_from_here->();
 374             $cur = $ty->{Contributor};
 375             next;
 376         } elsif ($ty eq 'BreakwaterUpstreamMerge') {
 377             $basis = $cur;
 378             last;
 379         } elsif ($ty eq 'DgitImportUnpatched' &&
 380                  @pseudomerges == 1) {
 381             # This import has a tree which is just like a breakwater
 382             # tree, but it has the wrong history.  Its ought to have
 383             # the previous breakwater (which dgit ought to have
 384             # generated a pseudomerge to overwrite) as an ancestor.
 385             # That will make the history of the debian/ files correct.
 386             # As for the upstream version: either it's the same upstream
 387             # as the previous breakwater, in which case that history is
 388             # precisely right.  Otherwise, it was a non-gitish upload
 389             # of a new upstream version.  We can tell these apart
 390             # by looking at the tree of the supposed upstream.
 391             my $differs = get_differs $previous_breakwater, $cl->{Tree};
 392             printf $report " Differs=%#x", $differs if $report;
 393             if ($differs & D_UPS) {
 394                 printf $report " D_UPS" if $report;
 395                 push @deb_cl, {
 396                     %$cl,
 397                     SpecialMethod => 'DgitImportUpstreamUpdate',
 398                     $xmsg->("convert dgit import: debian changes")
 399                 };
 400             }
 401             push @deb_cl, {
 402                 %$cl,
 403                 SpecialMethod => 'DgitImportDebianUpdate',
 404                 $xmsg->("convert dgit import: upstream changes")
 405             };
 406             $prprdelim->();
 407             $basis = walk
 408                 $pseudomerges[0]{Overwritten},
 409                 $nogenerate, $report,
 410                 1, $depth+1;
 411             $rewrite_from_here->();
 412             last;
 413         } else {
 414             print $report " Unprocessable" if $report;
 415             $prprdelim->();
 416             if ($nogenerate) {
 417                 return (undef,undef);
 418             }
 419             die "commit $cur: Cannot cope with this commit";
 420         }
 421     }
 422     $prprdelim->();
 423     if ($nogenerate) {
 424         return (undef, $basis);
 425     }
 426
 427     # Now we build it back up again
 428
 429     workarea_fresh();
 430
 431     my $rewriting = 0;
 432
 433     my $build = $basis;
 434
 435     my $rm_tree_cached = sub {
 436         my ($subdir) = @_;
 437         runcmd @git, qw(rm --quiet -rf --cached), $subdir;
 438     };
 439     my $read_tree_debian = sub {
 440         my ($treeish) = @_;
 441         $rm_tree_cached->(qw(debian));
 442         runcmd @git, qw(read-tree --prefix=debian/), "$treeish:debian";
 443     };
 444     my $read_tree_upstream = sub {
 445         my ($treeish) = @_;
 446         runcmd @git, qw(read-tree), $treeish;
 447         $read_tree_debian->($build);
 448     };
 449
 450     my $committer_authline = calculate_committer_authline();
 451
 452     in_workarea sub {
 453         mkdir $rd or $!==EEXIST or die $!;
 454         my $current_method;
 455         foreach my $cl (qw(Debian), (reverse @deb_cl),
 456                         { SpecialMethod => 'RecordBreakwaterTip' },
 457                         qw(Upstream), (reverse @ups_cl)) {
 458             if (!ref $cl) {
 459                 $current_method = $cl;
 460                 next;
 461             }
 462             my $method = $cl->{SpecialMethod} // $current_method;
 463             my @parents = ($build);
 464             my $cltree = $cl->{CommitId};
 465             if ($method eq 'Debian') {
 466                 $read_tree_debian->($cltree);
 467             } elsif ($method eq 'Upstream') {
 468                 $read_tree_upstream->($cltree);
 469             } elsif ($method eq 'StartRewrite') {
 470                 $rewriting = 1;
 471                 next;
 472             } elsif ($method eq 'RecordBreakwaterTip') {
 473                 last if $wantdebonly;
 474                 $breakwater = $build;
 475                 next;
 476             } elsif ($method eq 'DgitImportDebianUpdate') {
 477                 $read_tree_debian->($cltree);
 478                 $rm_tree_cached->(qw(debian/patches));
 479             } elsif ($method eq 'DgitImportUpstreamUpdate') {
 480                 $read_tree_upstream->($cltree);
 481                 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
 482             } else {
 483                 confess "$method ?";
 484             }
 485             $rewriting ||= $cl ne pop @processed;
 486             my $newtree = cmdoutput @git, qw(write-tree);
 487             my $ch = $cl->{Hdr};
 488             $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
 489             $ch =~ s{^parent .*\n}{}m;
 490             $ch =~ s{(?=^author}{
 491                 map { "parent $_\n" } @parents
 492             }me or confess "$ch ?";
 493             if ($rewrite) {
 494                 $ch =~ s{^committer .*$}{$committer_authline}m
 495                     or confess "$ch ?";
 496             }
 497             my $cf = "$rd/m$rewrite"
 498                 open CD, ">", $cf or die $!;
 499             print CD $ch, "\n", $cl->{Msg}; or die $!;
 500             close CD or die $!;
 501             my @cmd = (@git, qw(hash-object));
 502             push @cmd, qw(-w) if $rewrite;
 503             push @cmd, qw(-t commit), $cf;
 504             my $newcommit = cmdoutput @cmd;
 505             confess "$ch ?" unless $rewrite or $newcommit eq $cl->{CommitId};
 506             $build = $newcommit;
 507         }
 508     };
 509
 510     runcmd @git, qw(diff-tree --quiet),
 511         map { $wantdebonly ? "$_:debian" : $_ },
 512         $input, $build;
 513
 514     return ($build, $breakwater);
 515 }
 516
 517 sub get_head () { return git_rev_parse qw(HEAD); }
 518
 519 sub update_head ($$) {
 520     my ($old, $new, $mrest) = @_;
 521     runcmd @git, qw(update-ref -m), "git-debrebase $mrest", $new, $old;
 522 }
 523
 524 sub cmd_launder () {
 525     badusage "no arguments to launder allowed";
 526     my $old = get_head();
 527     my ($tip,$breakwater) = walk $old;
 528     update_head $old, $tip, 'launder';
 529     # no tree changes except debian/patches
 530     runcmd @git, qw(rm --quiet -rf debian/patches);
 531     printf "# breakwater tip\n%s\n", $breakwater;
 532 }
 533
 534 sub cmd_analyse () {
 535     die if ($ARGV[0]//'') =~ m/^-/;
 536     badusage "too many arguments to analyse" if @ARGV>1;
 537     my ($old) = @ARGV;
 538     if (defined $old) {
 539         $old = git_rev_parse $old;
 540     } else {
 541         $old = get_head();
 542     }
 543     my ($dummy,$breakwater) = walk $old, 1,*STDOUT;
 544     print "$breakwater BREAKWATER\n";
 545     STDOUT->error and die $!;
 546 }
 547
 548 my $toplevel = runcmd @git, qw(rev-parse --show-toplevel);
 549 chdir $toplevel or die "chdir $toplevel: $!";
 550
 551 my $cmd = shift @ARGV;
 552 my $cmdfn = $cmd;
 553 $cmdfn =~ y/-/_/;
 554 $cmdfn = ${*::}{"cmd_$cmdfn"};
 555
 556 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";
 557 $cmdfn->();