Skip to contentSkip to conversation

xdiff: improve trimming preprocessing

PATCH In review Jun Wu 4 participants 7 messages Mar 6, 2018 – Mar 7, 2018

lore
Share & tools
lore

Jun Wu

author
#0 lore raw

PATCH 1/1 xdiff: improve trimming preprocessing

xdiff-interface trims common suffix if ctxlen is 0. Teach it to also trim common prefix, and trim less lines if ctxlen > 0. So it can benefit the default diff command, as seen by profiling:

  $ GIT_PERF_REPEAT_COUNT=10 ./run origin/master . -- p4000-diff-algorithms.sh
  [...]
  Test                                  origin/master     this tree
  ------------------------------------------------------------------------------
  4000.1: log -3000 (baseline)          0.07(0.06+0.01)   0.06(0.05+0.01) -14.3%
  4000.2: log --raw -3000 (tree-only)   0.31(0.28+0.02)   0.31(0.27+0.02) +0.0%
  4000.3: log -p -3000 (Myers)          2.25(2.05+0.17)   1.66(1.52+0.11) -26.2%
  4000.4: log -p -3000 --histogram      2.51(2.36+0.10)   1.90(1.79+0.09) -24.3%
  4000.5: log -p -3000 --patience       2.63(2.44+0.16)   1.70(1.56+0.12) -35.4%

Diff shifting behaviors (hunk merging, indent heuristic, shift towards the end for repetitive content) are preserved as a best effort by:

1. Reserve extra 100 lines to not be trimmed. Leave room for shifting.
2. Calculate common prefix first. Disallow suffix overlap with prefix in the smaller file. So diff hunk tends to be shifted down.

Add tests for those. Make sure they fail on the old code.

Backported from a Mercurial patch [1]. Adjusted to git's existing xdiff-interface.c (which isn't ported to Mercurial).

Note: xdl_trim_ends does a similar job. But too late - it's after line splitting, hashing, correcting hash values. Those steps have visible overhead.

[1]: https://phab.mercurial-scm.org/D2686

---
 t/t4066-diff-trimming.sh | 49 +++++++++++++++++++++++++++++++++++++++
 xdiff-interface.c        | 60 +++++++++++++++++++++++++++++++++---------------
 xdiff/xdiff.h            |  3 +++
 xdiff/xdiffi.c           |  5 ++--
 xdiff/xemit.c            |  3 ++-
 5 files changed, 98 insertions(+), 22 deletions(-)
 create mode 100755 t/t4066-diff-trimming.sh
t/t4066-diff-trimming.sh new file +49 -0
new file mode 100755
index 000000000..3d90175ac
@@ -0,0 +1,49 @@
+#!/bin/sh
+
+test_description='diff trimming optimization'
+
+. ./test-lib.sh
+
+test_expect_success 'setup' '
+  printf "x\n%.0s" {1..1000} >a &&
+  printf "x\n%.0s" {1..1001} >b &&
+  cat >c <<EOF1 && cat >d <<EOF2 &&\
+  printf "x%.0s" {1..934} >>c &&\
+  printf "x%.0s" {1..934} >>d # pad common suffix to 1024 bytes
+  try:
+      import foo
+  except ImportError:
+      pass
+  try:
+      import bar
+  except ImportError:
+      pass
+EOF1
+  try:
+      import foo
+  except ImportError:
+      pass
+  try:
+      import baz
+  except ImportError:
+      pass
+  try:
+      import bar
+  except ImportError:
+      pass
+EOF2
+'
+
+test_expect_success 'git diff -U0 shifts hunk towards the end' '
+	test_expect_code 1 git diff -U0 --no-index a b |\
+    fgrep "@@ -1000,0 +1001 @@" &&
+	test_expect_code 1 git diff -U0 --no-index b a |\
+    fgrep "@@ -1001 +1000,0 @@"
+'
+
+test_expect_success 'git diff -U0 --indent-heuristic' '
+	test_expect_code 1 git diff -U0 --no-index --indent-heuristic c d |\
+    fgrep "@@ -4,0 +5,4 @@"
+'
+
+test_done
xdiff-interface.c +41 -19

83 lines not on this page · raw message

xdiff/xdiff.h +3 -0
index c1937a291..737d96607 100644
@@ -110,6 +110,9 @@ typedef struct s_xdemitconf {
 	find_func_t find_func;
 	void *find_func_priv;
 	xdl_emit_hunk_consume_func_t hunk_func;
+
+	/* prefix lines trimmed */
+	long ptrimmed;
 } xdemitconf_t;
 
 typedef struct s_bdiffparam {
xdiff/xdiffi.c +3 -2
index 0de1ef463..d62c5769e 100644
@@ -981,13 +981,14 @@ static int xdl_call_hunk_func(xdfenv_t *xe, xdchange_t *xscr, xdemitcb_t *ecb,
 			      xdemitconf_t const *xecfg)
 {
 	xdchange_t *xch, *xche;
+	long p = xecfg->ptrimmed;
 
 	for (xch = xscr; xch; xch = xche->next) {
 		xche = xdl_get_hunk(&xch, xecfg);
 		if (!xch)
 			break;
-		if (xecfg->hunk_func(xch->i1, xche->i1 + xche->chg1 - xch->i1,
-				     xch->i2, xche->i2 + xche->chg2 - xch->i2,
+		if (xecfg->hunk_func(xch->i1 + p, xche->i1 + xche->chg1 - xch->i1,
+				     xch->i2 + p, xche->i2 + xche->chg2 - xch->i2,
 				     ecb->priv) < 0)
 			return -1;
 	}
xdiff/xemit.c +2 -1
index 7778dc2b1..45d4ab073 100644
@@ -167,6 +167,7 @@ static int is_empty_rec(xdfile_t *xdf, long ri)
 int xdl_emit_diff(xdfenv_t *xe, xdchange_t *xscr, xdemitcb_t *ecb,
 		  xdemitconf_t const *xecfg) {
 	long s1, s2, e1, e2, lctx;
+	long p = xecfg->ptrimmed + 1;
 	xdchange_t *xch, *xche;
 	long funclineprev = -1;
 	struct func_line func_line = { 0 };
@@ -261,7 +262,7 @@ int xdl_emit_diff(xdfenv_t *xe, xdchange_t *xscr, xdemitcb_t *ecb,
 				      s1 - 1, funclineprev);
 			funclineprev = s1 - 1;
 		}
-		if (xdl_emit_hunk_hdr(s1 + 1, e1 - s1, s2 + 1, e2 - s2,
+		if (xdl_emit_hunk_hdr(s1 + p, e1 - s1, s2 + p, e2 - s2,
 				      func_line.buf, func_line.len, ecb) < 0)
 			return -1;
 
Signature · 1 line
2.16.2
#1 lore raw
Quoted 3 lines · Jun Wu

xdiff-interface trims common suffix if ctxlen is 0. Teach it to also trim common prefix, and trim less lines if ctxlen > 0. So it can benefit the default diff command, as seen by profiling: [...]

A few comments (below) based upon a quick scan of the patch...

t/t4066-diff-trimming.sh line 6

Quoted 10 lines

---

t/t4066-diff-trimming.sh +6 -0
@@ -0,0 +1,49 @@
+test_expect_success 'setup' '
+  printf "x\n%.0s" {1..1000} >a &&
+  printf "x\n%.0s" {1..1001} >b &&
+  cat >c <<EOF1 && cat >d <<EOF2 &&\
+  printf "x%.0s" {1..934} >>c &&\
+  printf "x%.0s" {1..934} >>d # pad common suffix to 1024 bytes

The expression {x..y} is not portable to non-POSIX shells.

t/t4066-diff-trimming.sh line 42

Quoted 6 lines
t/t4066-diff-trimming.sh +6 -0
+test_expect_success 'git diff -U0 shifts hunk towards the end' '
+       test_expect_code 1 git diff -U0 --no-index a b |\
+    fgrep "@@ -1000,0 +1001 @@" &&
+       test_expect_code 1 git diff -U0 --no-index b a |\
+    fgrep "@@ -1001 +1000,0 @@"
+'

Style: Mix of tabs and spaces for indentation. Please indent only with tabs throughout the patch.

xdiff-interface.c static int xdiff_outf(void *priv_, mmbuffer_t *mb, int nbuf) · line 107

Quoted 9 lines
xdiff-interface.c +6 -0
@@ -101,42 +101,64 @@ static int xdiff_outf(void *priv_, mmbuffer_t *mb, int nbuf)
+static void trim_common(mmfile_t *a, mmfile_t *b, long reserved,
+                       xdemitconf_t *xecfg)
 {
+       /* prefix - need line count for xecfg->ptrimmed */
+       for (i = 0; ++i < smaller && *ap == *bp;) {
+               lines += (*ap == '\n');
+               ap++, bp++;

Is there a good reason for not placing 'ap++, bp++' directly in the 'for'?

    for (i = 0; ++i < smaller && *ap == *bp; ap++, bp++)
#2 lore raw
Quoted 4 lines · Eric Sunshine
Quoted 3 lines · Jun Wu

xdiff-interface trims common suffix if ctxlen is 0. Teach it to also trim common prefix, and trim less lines if ctxlen > 0. So it can benefit the default diff command, as seen by profiling: [...]

I vaguely recall that we have tried this in the distant past, found that it produced incorrect result, and that is why we limit the optimization for no-context case.

Does anybody have an archive reference?

author
#3 lore raw

Excerpts from Junio C Hamano's message of 2018-03-06 11:29:44 -0800:

Quoted 7 lines
Quoted 4 lines · Eric Sunshine
Quoted 3 lines · Jun Wu

xdiff-interface trims common suffix if ctxlen is 0. Teach it to also trim common prefix, and trim less lines if ctxlen > 0. So it can benefit the default diff command, as seen by profiling: [...]

Quoted 5 lines

I vaguely recall that we have tried this in the distant past, found that it produced incorrect result, and that is why we limit the optimization for no-context case.

Does anybody have an archive reference?

I think it's d2f8295 ("Re(-re)*fix trim_common_tail()", 2007-12-20).

Yeah, this is more complex than I thought. In Mercurial's use-case, ctxlen is 0 and context are added in a higher layer so it's fine.

It's clearly hunk shifting causing problems. I'll send a V2 to forbid hunk shifting if it can possibly lose context lines. That implies counting suffix lines, which adds some overhead but the overall perf win still seems worthwhile.

author
#4 lore raw
In reply to Eric Sunshine

Excerpts from Eric Sunshine's message of 2018-03-06 14:23:46 -0500:

Quoted 4 lines · Jun Wu
Quoted 1 line

+ printf "x%.0s" {1..934} >>d # pad common suffix to 1024 bytes

The expression {x..y} is not portable to non-POSIX shells.

Is there a recommended way to generate a repetitive string? Maybe seq 1000 | sed 's/.*/x/' ?

Quoted 5 lines
Quoted 2 lines

+ fgrep "@@ -1001 +1000,0 @@"
+'

Style: Mix of tabs and spaces for indentation. Please indent only with tabs throughout the patch.

Sorry. Will fix in V2.

Quoted 6 lines

xdiff-interface.c static int xdiff_outf(void *priv_, mmbuffer_t *mb, int nbuf) · line 123

Quoted 4 lines
xdiff-interface.c +4 -0
+       /* prefix - need line count for xecfg->ptrimmed */
+       for (i = 0; ++i < smaller && *ap == *bp;) {
+               lines += (*ap == '\n');
+               ap++, bp++;

Is there a good reason for not placing 'ap++, bp++' directly in the 'for'?

"lines += (*ap == '\n');" needs the "ap" before adding. Alternatives are

    for (i = 0; ++i < smaller && *ap == *bp; ) /* 1 */
        lines += (*ap++, *bp++) == '\n';

    for (i = 0; ++i < smaller && *ap == *bp; ap++, bp++) /* 2 */
        lines += (*(ap - 1) == '\n');

Maybe will pick /* 1 */ to make the code shorter.

#5 lore raw
Quoted 8 lines · Jun Wu

Excerpts from Eric Sunshine's message of 2018-03-06 14:23:46 -0500:

Quoted 4 lines · Jun Wu
Quoted 1 line

+ printf "x%.0s" {1..934} >>d # pad common suffix to 1024 bytes

The expression {x..y} is not portable to non-POSIX shells.

Is there a recommended way to generate a repetitive string? Maybe seq 1000 | sed 's/.*/x/' ?

That seems reasonable, although you'd want to use the test suite's more portable test_seq rather than seq.

Quoted 9 lines
Quoted 6 lines

xdiff-interface.c static int xdiff_outf(void *priv_, mmbuffer_t *mb, int nbuf) · line 123

Quoted 4 lines
xdiff-interface.c +4 -0
+       /* prefix - need line count for xecfg->ptrimmed */
+       for (i = 0; ++i < smaller && *ap == *bp;) {
+               lines += (*ap == '\n');
+               ap++, bp++;

Is there a good reason for not placing 'ap++, bp++' directly in the 'for'?

"lines += (*ap == '\n');" needs the "ap" before adding. Alternatives are

Quoted 7 lines
    for (i = 0; ++i < smaller && *ap == *bp; ) /* 1 */
        lines += (*ap++, *bp++) == '\n';

    for (i = 0; ++i < smaller && *ap == *bp; ap++, bp++) /* 2 */
        lines += (*(ap - 1) == '\n');

Maybe will pick /* 1 */ to make the code shorter.

I was thinking specifically about #2 when asking the question. The reason I asked is that, as one reading the code, the not-quite-idiomatic loop made me stop and wonder if something special was going on which wasn't obvious at a glance.

And, apparently, I'm still wondering since I'm not groking what you mean by:

    "lines += (*ap == '\n');" needs the "ap" before adding

It's quite possible that I'm being dense and overlooking something blindingly obvious.

#6 lore raw

Am 07.03.2018 um 10:36 schrieb Eric Sunshine:

Quoted 5 lines · Jun Wu
Quoted 4 lines

Excerpts from Eric Sunshine's message of 2018-03-06 14:23:46 -0500:

Quoted 3 lines · Jun Wu
Quoted 1 line

+ printf "x%.0s" {1..934} >>d # pad common suffix to 1024 bytes

Quoted 7 lines
Quoted 4 lines
Quoted 1 line

The expression {x..y} is not portable to non-POSIX shells.

Is there a recommended way to generate a repetitive string? Maybe seq 1000 | sed 's/.*/x/' ?

That seems reasonable, although you'd want to use the test suite's more portable test_seq rather than seq.

You could also use Perl's repetition operator (x):

	perl -e "print \"x\" x 934" >>d

It is a single command (only one fork()/exec()), simple, produces no extra newline characters and it's already used e.g. in t5300-pack-object.sh.

René