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 s
  91 # git-debrebase without start, if already started, is willing
  92 # to strip pseudomerges provided that they overwrite (xxx exactly ???)
  93 # the previous HEAD
  94
  95 use strict;
  96
  97 use Memoize;
  98 use Data::Dumper;
  99
 100 use Debian::Dgit qw(:DEFAULT $wa);
 101
 102 sub cfg ($) {
 103     my ($k) = @_;
 104     $/ = "\0";
 105     my @cmd = qw(git config -z);
 106     push @cmd, qw(--get-all) if wantarray;
 107     push @cmd, $k;
 108     my $out = cmdoutput @cmd;
 109     return split /\0/, $out;
 110 }
 111
 112 memoize('cfg');
 113
 114 sub get_commit ($) {
 115     my ($objid) = @_;
 116     my ($type,$data) = git_cat_file $objid;
 117     die unless $type eq 'commit';
 118     $data =~ m/(?<=\n)\n/;
 119     return ($`,$');
 120 }
 121
 122 sub D_DEB ()     { return 0x1; } # debian/ (not including debian/patches/)
 123 sub D_UPS ()     { return 0x2; } # upstream files
 124 sub D_PAT_ADD () { return 0x4; } # debian/patches/ extra patches at end
 125 sub D_PAT_OTH () { return 0x8; } # debian/patches other changes
 126
 127 our $rd = ".git/git-debrebase";
 128 our $ud = "$rd/work";
 129
 130 sub commit_pr_info ($) {
 131     my ($r) = @_;
 132     return Data::Dumper->dump([$r], [qw(commit)]);
 133 }
 134
 135 sub calculate_committer_authline () {
 136     my $c = cmdoutput @git, qw(commit-tree --no-gpg-sign -m),
 137         'DUMMY COMMIT (git-debrebase)', "$basis:";
 138     my ($h,$m) = get_commit $c;
 139     $h =~ m/^committer .*$/m or confess "($h) ?";
 140     return $&;
 141 }
 142
 143 # classify returns an info hash like this
 144 #   CommitId => $objid
 145 #   Hdr => # commit headers, including 1 final newline
 146 #   Msg => # commit message (so one newline is dropped)
 147 #   Tree => $treeobjid
 148 #   Type => (see below)
 149 #   Parents = [ {
 150 #       Ix => $index # ie 0, 1, 2, ...
 151 #       CommitId
 152 #       Differs => return value from get_differs
 153 #       IsOrigin
 154 #       IsDggitImport => 'orig' 'tarball' 'unpatched' 'package' (as from dgit)
 155 #     } ...]
 156 #   NewMsg => # commit message, but with any [dgit import ...] edited
 157 #             # to say "[was: ...]"
 158 #
 159 # Types:
 160 #   Packaging
 161 #   Upstream
 162 #   AddPatches
 163 #   Mixed
 164 #   Unknown
 165 #
 166 #   Pseudomerge
 167 #     has additional entres in classification result
 168 #       Overwritten = [ subset of Parents ]
 169 #       Contributor = $the_remaining_Parent
 170 #
 171 #   DgitImportUnpatched
 172 #     has additional entry in classification result
 173 #       OrigParents = [ subset of Parents ]
 174 #
 175 #   BreakwaterUpstreamMerge
 176 #     has additional entry in classification result
 177 #       OrigParents = [ subset of Parents ]
 178
 179 sub classify ($) {
 180     my ($objid) = @_;
 181
 182     my ($h,$m) = get_commit $objid;
 183
 184     my ($t) = $h =~ m/^tree (\w+)$/m or die $cur;
 185     my (@ph) = $h =~ m/^parent (\w+)$/m;
 186     my @p;
 187
 188     my $r = {
 189         CommitId => $objid,
 190         Hdr => $hdr,
 191         Msg => $m,
 192         Tree => $t,
 193         Parents => \@p,
 194     };
 195
 196     foreach my $ph (@ph) {
 197         push @p, {
 198             Ix => $#p,
 199             CommitId => $ph,
 200             Differs => (get_differs $t, $ph),
 201         };
 202     }
 203
 204     my $classify = sub {
 205         my ($type, @rest) = @_;
 206         $r = { %r, Type => $type, @rest };
 207         return $r;
 208     };
 209     my $unknown = sub {
 210         my ($why) = @_;
 211         $r = { %r, Type => Unknown };
 212         return $r;
 213     }
 214
 215     if (@p == 1) {
 216         my $d = $r->{Parents}[0]{Differs};
 217         if ($d == D_DPAT_ADD) {
 218             return $classify->(qw(AddPatches));
 219         } elsif ($d & (D_DPAT_ADD|D_DPAT_OTH)) {
 220             return $unknown->("edits debian/patches");
 221         } elsif ($d == D_DEB) {
 222             return $classify->(qw(Packaging));
 223         } elsif ($d == D_UPS) {
 224             return $classify->(qw(Upstream));
 225         } elsif ($d == D_DEB|D_UPS) {
 226             return $classify->(qw(Mixed));
 227         } elsif ($d == 0) {
 228             return $unknown->("no changes");
 229         } else {
 230             confess "internal error $objid ?";
 231         }
 232     }
 233     if (!@p) {
 234         return $unknown->("origin commit");
 235     }
 236
 237     my @identical = grep { !$_->{Differs} } @p;
 238     if (@p == 2 && @identical == 1) {
 239         my @overwritten = grep { $_->{Differs} } @p;
 240         confess "internal error $objid ?" unless @overwritten==1;
 241         return $classify->(qw(Pseudomerge),
 242                            Overwritten => $overwritten[0],
 243                            Contributor => $identical[0]);
 244     }
 245     if (@p == 2 && @identical == 2) {
 246         my @bytime = nsort_by {
 247             my ($ph,$pm) = get_commit $_->{CommitId};
 248             $ph =~ m/^committer .* (\d+) [-+]\d+$/m or die "$_->{CommitId} ?";
 249             $1;
 250         } @p;
 251         return $classify->(qw(Pseudomerge),
 252                            SubType => qw(Ambiguous),
 253                            Overwritten => $bytime[0],
 254                            Contributor => $bytime[1]);
 255     }!
 256     foreach my $p (@p) {
 257         my ($p_h, $p_m) = get_commit $p;
 258         $p->{IsOrigin} = $p_h !~ m/^parent \w+$/m;
 259         ($p->{IsDgitImport},) = $p_m =~ m/^\[dgit import ([0-9a-z]+) .*\]$/m;
 260     }
 261     my @orig_ps = grep { ($_->{IsDgitImport}//'X') eq 'orig' };
 262     my $m2 = $m;
 263     if (!(grep { !$_->{IsOrigin} } @p) and
 264         (@origs >= @p - 1) and
 265         $m2 =~ s{^\[(dgit import unpatched .*)\]$}{[was: $1]}m) {
 266         $r->{NewMsg} = $m2;
 267         return $classify->(qw(DgitImportUnpatched),
 268                            OrigParents => \@orig_ps);
 269     }
 270
 271     my ($stype, $series) = git_cat_file "$t:debian/patches/series";
 272     my $haspatches = $stype ne 'missing' && $series =~ m/^\s*[^#\n\t ]/m;
 273
 274     # How to decide about l/r ordering of breakwater merges ?  git
 275     # --topo-order prefers to expand 2nd parent first.  There's
 276     # already an easy rune to look for debian/ history anyway (git log
 277     # debian/) so debian breakwater branch should be 1st parent; that
 278     # way also there's also an easy rune to look for the upstream
 279     # patches (--topo-order).
 280     if (@p == 2 &&
 281         !$haspatches &&
 282         !$p[0]{IsOrigin} && # breakwater merge never starts with an origin
 283         !($p[0]{Differs} & ~D_DEB) &&
 284         !($p[1]{Differs} & ~D_UPS)) {
 285         return $classify->(qw(BreakwaterUpstreamMerge),
 286                            OrigParents => [ $p[1] ]);
 287     }
 288     # xxx multi-.orig upstreams
 289
 290     return $unknown->("complex merge");
 291 }
 292
 293 sub walk ($$$;$$$) {
 294     my ($input, $pseudos_must_overwrite_this, $wantdebonly,
 295         $report, $depth, $report_anomaly, $report_only) = @_;
 296     # go through commits backwards
 297     # we generate two lists of commits to apply
 298     # => ($tip, $breakwater_tip)
 299     my (@deb_cl, @ups_cl, @processed);
 300     my %found;
 301     my @pseudomerges;
 302
 303     $report //= sub { };
 304     $report_anomaly //= sub {
 305         my ($cl, $msg) = @_;
 306         die "commit $cl: $msg\n";
 307     };
 308     $depth //= 0;
 309
 310     my $cl;
 311     my $xmsg = sub {
 312         my ($appendinfo) = @_;
 313         my $ms = $cl->{Msg};
 314         chomp $ms;
 315         $ms .= "\n\n[git-debrebase $appendinfo]\n";
 316         return (Msg => $ms);
 317     };
 318     my $rewrite_from_here = sub {
 319         push @processed, { SpecialMethod => 'StartRewrite' };
 320     };
 321
 322     my $cur = $input;
 323
 324     for (;;) {
 325         $cl = classify $cur;
 326         my $ty = $cl->{Type};
 327         my $st = $cl->{SubType};
 328         $report->($cl);
 329         $found{$ty. ( defined($st) ? "-$st" : '' )}++;
 330         push @processed, $cl;
 331         my $p0 = $cl->{Parents}[0]{CommitId};
 332         if ($ty eq 'AddPatches') {
 333             $cur = $p0;
 334             $rewrite_from_here->();
 335             next;
 336         } elsif ($ty eq 'Packaging') {
 337             push @deb_cl, $cl;
 338             $cur = $p0;
 339             next;
 340         } elsif ($ty eq 'Upstream') {
 341             push @ups_cl, $cl;
 342             $cur = $p0;
 343             next;
 344         } elsif ($ty eq 'Mixed') {
 345             my $queue = sub {
 346                 my ($q, $wh) = @_;
 347                 my $cls = { $cl, $xmsg->("split mixed commit: $wh part") };
 348                 push @$q, $cls;
 349             };
 350             $queue->(\@deb_cl, "debian");
 351             $queue->(\@ups_cl, "upstream");
 352             $rewrite_from_here->();
 353             next;
 354         } elsif ($ty eq 'Pseudomerge') {
 355             if (defined $pseudos_must_overwrite_this &&
 356                 !grep {
 357                     is_fast_fwd $pseudos_must_overwrite_this, $_->{CommitId}
 358                 },
 359                 @{ $cl->{Overwritten} }) {
 360                 $report_anomaly->($cl,
 361                                   "Pseudomerge should overwrite".
 362                                   " $pseudos_must_overwrite_this".
 363                                   " but does not do so");
 364             }
 365             push @pseudomerges, $cl;
 366             $rewrite_from_here->();
 367             $cur = $ty->{Contributor};
 368             next;
 369         } elsif ($ty eq 'BreakwaterUpstreamMerge') {
 370             $basis = $cur;
 371             last;
 372         } elsif ($ty eq 'DgitImportUnpatched' &&
 373                  @pseudomerges == 1) {
 374             # This import has a tree which is just like a breakwater
 375             # tree, but it has the wrong history.  Its ought to have
 376             # the previous breakwater (which dgit ought to have
 377             # generated a pseudomerge to overwrite) as an ancestor.
 378             # That will make the history of the debian/ files correct.
 379             # As for the upstream version: either it's the same upstream
 380             # as the previous breakwater, in which case that history is
 381             # precisely right.  Otherwise, it was a non-gitish upload
 382             # of a new upstream version.  We can tell these apart
 383             # by looking at the tree of the supposed upstream.
 384             my $differs = get_differs $previous_breakwater, $cl->{Tree};
 385             if ($differs & D_UPS) {
 386                 push @deb_cl, {
 387                     %r,
 388                     SpecialMethod => 'DgitImportUpstreamUpdate',
 389                     $xmsg->("convert dgit import: debian changes")
 390                 };
 391             }
 392             push @deb_cl, {
 393                 %r,
 394                 SpecialMethod => 'DgitImportDebianUpdate',
 395                 $xmsg->("convert dgit import: upstream changes")
 396             };
 397             $basis = launder $pseudomerges[0]{Overwritten}, undef, 1,
 398                 $report, $depth+1, $nogenerate;
 399             $rewrite_from_here->();
 400             last;
 401         } else {
 402             $report_anomaly->($cl, "Cannot cope with this commit");
 403         }
 404     }
 405     # Now we build it back up again
 406
 407     if ($nogenerate) {
 408         return (undef, $basis);
 409     }
 410
 411     workarea_fresh();
 412
 413     my $rewriting = 0;
 414
 415     my $build = $basis;
 416
 417     my $rm_tree_cached = sub {
 418         my ($subdir) = @_;
 419         runcmd @git, qw(rm --quiet -rf --cached), $subdir;
 420     };
 421     my $read_tree_debian = sub {
 422         my ($treeish) = @_;
 423         $rm_tree_cached->(qw(debian));
 424         runcmd @git, qw(read-tree --prefix=debian/), "$treeish:debian";
 425     };
 426     my $read_tree_upstream = sub {
 427         my ($treeish) = @_;
 428         runcmd @git, qw(read-tree), $treeish;
 429         $read_tree_debian->($build);
 430     };
 431
 432     my $committer_authline = calculate_committer_authline();
 433
 434     in_workarea sub {
 435         mkdir $rd or $!==EEXIST or die $!;
 436         my $current_method;
 437         foreach my $cl (qw(Debian), (reverse @deb_cl),
 438                         { SpecialMethod => 'RecordBreakwaterTip' },
 439                         qw(Upstream), (reverse @ups_cl)) {
 440             if (!ref $cl) {
 441                 $current_method = $cl;
 442                 next;
 443             }
 444             $method = $cl->{SpecialMethod} // $current_method;
 445             my @parents = ($build);
 446             my $cltree = $cl->{CommitId}
 447             if ($method eq 'Debian') {
 448                 $read_tree_debian->($cltree);
 449             } elsif ($method eq 'Upstream') {
 450                 $read_tree_upstream->($cltree);
 451             } elsif ($method eq 'StartRewrite') {
 452                 $rewriting = 1;
 453                 next;
 454             } elsif ($method eq 'RecordBreakwaterTip') {
 455                 last if $wantdebonly;
 456                 $breakwater = $build;
 457                 next;
 458             } elsif ($method eq 'DgitImportDebianUpdate') {
 459                 $read_tree_debian->($cltree);
 460                 $rm_tree_cached(qw(debian/patches));
 461             } elsif ($method eq 'DgitImportUpstreamUpdate') {
 462                 $read_tree_upstream->($cltree);
 463                 push @parents, map { $_->{CommitId} } @{ $cl->{OrigParents} };
 464             } else {
 465                 confess "$method ?";
 466             }
 467             $rewriting ||= $cl ne pop @processed;
 468             my $newtree = cmdoutput @git, qw(write-tree);
 469             my $ch = $cl->{Hdr};
 470             $ch =~ s{^tree .*}{tree $newtree}m or confess "$ch ?";
 471             $ch =~ s{^parent .*\n}{}m;
 472             $ch =~ s{(?=^author}{
 473                 map { "parent $_\n" } @parents
 474             }me or confess "$ch ?";
 475             if ($rewrite) {
 476                 $ch =~ s{^committer .*$}{$committer_authline}m
 477                     or confess "$ch ?";
 478             }
 479             my $cf = "$rd/m$rewrite"
 480                 open CD, ">", $cf or die $!;
 481             print CD $ch, "\n", $cl->{Msg}; or die $!;
 482             close CD or die $!;
 483             my @cmd = (@git, qw(hash-object));
 484             push @cmd, qw(-w) if $rewrite;
 485             push @cmd, qw(-t commit), $cf;
 486             my $newcommit = cmdoutput @cmd;
 487             confess "$ch ?" unless $rewrite or $newcommit eq $cl->{CommitId};
 488             $build = $newcommit;
 489         }
 490     };
 491
 492     runcmd @git, qw(diff-tree --quiet),
 493         map { $wantdebonly ? "$_:debian" : $_ },
 494         $input, $build;
 495
 496     return ($build, $breakwater);
 497 }
 498
 499 sub get_head () { return git_rev_parse qw(HEAD); }
 500
 501 sub update_head ($$) {
 502     my ($old, $new, $mrest) = @_;
 503     runcmd @git, qw(update-ref -m), "git-debrebase $mrest", $new, $old;
 504 }
 505
 506 sub cmd_analyse () {
 507
 508
 509 sub cmd_launder () {
 510     my $old = get_head();
 511     my ($tip,$breakwater) = launder $old, 0, undef, 0;
 512     update_head $old, $tip, 'launder';
 513     # no tree changes except debian/patches
 514     runcmd @git, qw(rm --quiet -rf debian/patches);
 515     printf "# breakwater tip:\n%s\n", $breakwater;
 516 }
 517
 518 my $toplevel = runcmd @git, qw(rev-parse --show-toplevel);
 519 chdir $toplevel or die "chdir $toplevel: $!";
 520
 521 my $cmd = shift @ARGV;
 522 my $cmdfn = $cmd;
 523 $cmdfn =~ y/-/_/;
 524 $cmdfn = ${*::}{"cmd_$cmdfn"};
 525
 526 $cmdfn or badusage "unknown git-debrebase sub-operation $cmd";
 527 $cmdfn->();