Add a performance optimized variant of the ANY_DIFF filter
If a treewalk walks also over index and the workingtree then the IndexDiffFilter filter can be used which works much faster then the semantically equivalent ANY_DIFF filter. This is because this filter can better avoid computing SHA-1 ids over the content of working-tree files which is very costly. This fix will significantly improve the performance of e.g. EGit's commit dialog. Change-Id: I2a51816f4ed9df2900c6307a54cd09f50004266f Signed-off-by: Christian Halstrick <christian.halstrick@sap.com> Signed-off-by: Philipp Thun <philipp.thun@sap.com>
This commit is contained in:
parent
6bca46e168
commit
1783749e16
|
@ -0,0 +1,100 @@
|
|||
/*
|
||||
* Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>,
|
||||
* Copyright (C) 2010, Philipp Thun <philipp.thun@sap.com>
|
||||
* and other copyright owners as documented in the project's IP log.
|
||||
*
|
||||
* This program and the accompanying materials are made available
|
||||
* under the terms of the Eclipse Distribution License v1.0 which
|
||||
* accompanies this distribution, is reproduced below, and is
|
||||
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or
|
||||
* without modification, are permitted provided that the following
|
||||
* conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* - Redistributions in binary form must reproduce the above
|
||||
* copyright notice, this list of conditions and the following
|
||||
* disclaimer in the documentation and/or other materials provided
|
||||
* with the distribution.
|
||||
*
|
||||
* - Neither the name of the Eclipse Foundation, Inc. nor the
|
||||
* names of its contributors may be used to endorse or promote
|
||||
* products derived from this software without specific prior
|
||||
* written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||||
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
||||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||||
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
package org.eclipse.jgit.treewalk.filter;
|
||||
|
||||
import org.eclipse.jgit.api.Git;
|
||||
import org.eclipse.jgit.dircache.DirCacheIterator;
|
||||
import org.eclipse.jgit.lib.RepositoryTestCase;
|
||||
import org.eclipse.jgit.revwalk.RevCommit;
|
||||
import org.eclipse.jgit.treewalk.FileTreeIterator;
|
||||
import org.eclipse.jgit.treewalk.TreeWalk;
|
||||
|
||||
public class IndexDiffFilterTest extends RepositoryTestCase {
|
||||
private RevCommit commit;
|
||||
|
||||
public void setUp() throws Exception {
|
||||
super.setUp();
|
||||
|
||||
Git git = new Git(db);
|
||||
writeTrashFile("folder/file", "content");
|
||||
git.add().addFilepattern("folder/file").call();
|
||||
commit = git.commit().setMessage("commit").call();
|
||||
|
||||
deleteTrashFile("folder/file");
|
||||
deleteTrashFile("folder");
|
||||
writeTrashFile("folder", "content");
|
||||
}
|
||||
|
||||
public void testRecursiveTreeWalk() throws Exception {
|
||||
TreeWalk treeWalk = new TreeWalk(db);
|
||||
treeWalk.setRecursive(true);
|
||||
treeWalk.addTree(commit.getTree());
|
||||
treeWalk.addTree(new DirCacheIterator(db.readDirCache()));
|
||||
treeWalk.addTree(new FileTreeIterator(db));
|
||||
treeWalk.setFilter(new IndexDiffFilter(1, 2));
|
||||
assertTrue(treeWalk.next());
|
||||
assertEquals("folder", treeWalk.getPathString());
|
||||
assertTrue(treeWalk.next());
|
||||
assertEquals("folder/file", treeWalk.getPathString());
|
||||
assertFalse(treeWalk.next());
|
||||
}
|
||||
|
||||
public void testNonRecursiveTreeWalk() throws Exception {
|
||||
TreeWalk treeWalk = new TreeWalk(db);
|
||||
treeWalk.setRecursive(false);
|
||||
treeWalk.addTree(commit.getTree());
|
||||
treeWalk.addTree(new DirCacheIterator(db.readDirCache()));
|
||||
treeWalk.addTree(new FileTreeIterator(db));
|
||||
treeWalk.setFilter(new IndexDiffFilter(1, 2));
|
||||
assertTrue(treeWalk.next());
|
||||
assertEquals("folder", treeWalk.getPathString());
|
||||
assertTrue(treeWalk.next());
|
||||
assertEquals("folder", treeWalk.getPathString());
|
||||
assertTrue(treeWalk.isSubtree());
|
||||
treeWalk.enterSubtree();
|
||||
assertTrue(treeWalk.next());
|
||||
assertEquals("folder/file", treeWalk.getPathString());
|
||||
assertFalse(treeWalk.next());
|
||||
}
|
||||
}
|
|
@ -60,7 +60,7 @@
|
|||
import org.eclipse.jgit.treewalk.TreeWalk;
|
||||
import org.eclipse.jgit.treewalk.WorkingTreeIterator;
|
||||
import org.eclipse.jgit.treewalk.filter.AndTreeFilter;
|
||||
import org.eclipse.jgit.treewalk.filter.NotIgnoredFilter;
|
||||
import org.eclipse.jgit.treewalk.filter.IndexDiffFilter;
|
||||
import org.eclipse.jgit.treewalk.filter.SkipWorkTreeFilter;
|
||||
import org.eclipse.jgit.treewalk.filter.TreeFilter;
|
||||
|
||||
|
@ -182,9 +182,8 @@ public boolean diff() throws IOException {
|
|||
Collection<TreeFilter> filters = new ArrayList<TreeFilter>(4);
|
||||
if (filter != null)
|
||||
filters.add(filter);
|
||||
filters.add(new NotIgnoredFilter(WORKDIR));
|
||||
filters.add(new SkipWorkTreeFilter(INDEX));
|
||||
filters.add(TreeFilter.ANY_DIFF);
|
||||
filters.add(new IndexDiffFilter(INDEX, WORKDIR));
|
||||
treeWalk.setFilter(AndTreeFilter.create(filters));
|
||||
while (treeWalk.next()) {
|
||||
AbstractTreeIterator treeIterator = treeWalk.getTree(TREE,
|
||||
|
|
|
@ -0,0 +1,194 @@
|
|||
/*
|
||||
* Copyright (C) 2010, Christian Halstrick <christian.halstrick@sap.com>
|
||||
* and other copyright owners as documented in the project's IP log.
|
||||
*
|
||||
* This program and the accompanying materials are made available
|
||||
* under the terms of the Eclipse Distribution License v1.0 which
|
||||
* accompanies this distribution, is reproduced below, and is
|
||||
* available at http://www.eclipse.org/org/documents/edl-v10.php
|
||||
*
|
||||
* All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or
|
||||
* without modification, are permitted provided that the following
|
||||
* conditions are met:
|
||||
*
|
||||
* - Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
*
|
||||
* - Redistributions in binary form must reproduce the above
|
||||
* copyright notice, this list of conditions and the following
|
||||
* disclaimer in the documentation and/or other materials provided
|
||||
* with the distribution.
|
||||
*
|
||||
* - Neither the name of the Eclipse Foundation, Inc. nor the
|
||||
* names of its contributors may be used to endorse or promote
|
||||
* products derived from this software without specific prior
|
||||
* written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
|
||||
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
|
||||
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
||||
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
||||
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
|
||||
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
||||
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
||||
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
||||
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
|
||||
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
|
||||
* ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
package org.eclipse.jgit.treewalk.filter;
|
||||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.eclipse.jgit.dircache.DirCacheIterator;
|
||||
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
|
||||
import org.eclipse.jgit.errors.MissingObjectException;
|
||||
import org.eclipse.jgit.treewalk.TreeWalk;
|
||||
import org.eclipse.jgit.treewalk.WorkingTreeIterator;
|
||||
|
||||
/**
|
||||
* A performance optimized variant of {@link TreeFilter#ANY_DIFF} which should
|
||||
* be used when among the walked trees there is a {@link DirCacheIterator} and a
|
||||
* {@link WorkingTreeIterator}. Please see the documentation of
|
||||
* {@link TreeFilter#ANY_DIFF} for a basic description of the semantics.
|
||||
* <p>
|
||||
* This filter tries to avoid computing content ids of the files in the
|
||||
* working-tree. In contrast to {@link TreeFilter#ANY_DIFF} this filter takes
|
||||
* care to first compare the entry from the {@link DirCacheIterator} with the
|
||||
* entries from all other iterators besides the {@link WorkingTreeIterator}.
|
||||
* Since all those entries have fast access to content ids that is very fast. If
|
||||
* a difference is detected in this step this filter decides to include that
|
||||
* path before even looking at the working-tree entry.
|
||||
* <p>
|
||||
* If no difference is found then we have to compare index and working-tree as
|
||||
* the last step. By making use of
|
||||
* {@link WorkingTreeIterator#isModified(org.eclipse.jgit.dircache.DirCacheEntry, boolean)}
|
||||
* we can avoid the computation of the content id if the file is not dirty.
|
||||
* <p>
|
||||
* Instances of this filter should not be used for multiple {@link TreeWalk}s.
|
||||
* Always construct a new instance of this filter for each TreeWalk.
|
||||
*/
|
||||
public class IndexDiffFilter extends TreeFilter {
|
||||
private final int dirCache;
|
||||
|
||||
private final int workingTree;
|
||||
|
||||
private final boolean honorIgnores;
|
||||
|
||||
/**
|
||||
* Creates a new instance of this filter. Do not use an instance of this
|
||||
* filter in multiple treewalks.
|
||||
*
|
||||
* @param dirCacheIndex
|
||||
* the index of the {@link DirCacheIterator} in the associated
|
||||
* treewalk
|
||||
* @param workingTreeIndex
|
||||
* the index of the {@link WorkingTreeIterator} in the associated
|
||||
* treewalk
|
||||
*/
|
||||
public IndexDiffFilter(int dirCacheIndex, int workingTreeIndex) {
|
||||
this(dirCacheIndex, workingTreeIndex, true /* honor ignores */);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new instance of this filter. Do not use an instance of this
|
||||
* filter in multiple treewalks.
|
||||
*
|
||||
* @param dirCacheIndex
|
||||
* the index of the {@link DirCacheIterator} in the associated
|
||||
* treewalk
|
||||
* @param workingTreeIndex
|
||||
* the index of the {@link WorkingTreeIterator} in the associated
|
||||
* treewalk
|
||||
* @param honorIgnores
|
||||
* true if the filter should skip working tree files that are
|
||||
* declared as ignored by the standard exclude mechanisms..
|
||||
*/
|
||||
public IndexDiffFilter(int dirCacheIndex, int workingTreeIndex,
|
||||
boolean honorIgnores) {
|
||||
this.dirCache = dirCacheIndex;
|
||||
this.workingTree = workingTreeIndex;
|
||||
this.honorIgnores = honorIgnores;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean include(TreeWalk tw) throws MissingObjectException,
|
||||
IncorrectObjectTypeException, IOException {
|
||||
// If the working tree file doesn't exist, it does exist for at least
|
||||
// one other so include this difference.
|
||||
final int wm = tw.getRawMode(workingTree);
|
||||
if (wm == 0)
|
||||
return true;
|
||||
|
||||
// If the path does not appear in the DirCache and its ignored
|
||||
// we can avoid returning a result here, but only if its not in any
|
||||
// other tree.
|
||||
final int cnt = tw.getTreeCount();
|
||||
final int dm = tw.getRawMode(dirCache);
|
||||
if (dm == 0) {
|
||||
if (honorIgnores && workingTree(tw).isEntryIgnored()) {
|
||||
int i = 0;
|
||||
for (; i < cnt; i++) {
|
||||
if (i == dirCache || i == workingTree)
|
||||
continue;
|
||||
if (tw.getRawMode(i) != 0)
|
||||
break;
|
||||
}
|
||||
|
||||
// If i is cnt then the path does not appear in any other tree,
|
||||
// and this working tree entry can be safely ignored.
|
||||
return i == cnt ? false : true;
|
||||
} else {
|
||||
// In working tree and not ignored, and not in DirCache.
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
// Always include subtrees as WorkingTreeIterator cannot provide
|
||||
// efficient elimination of unmodified subtrees.
|
||||
if (tw.isSubtree())
|
||||
return true;
|
||||
|
||||
// Try the inexpensive comparisons between index and all real trees
|
||||
// first. Only if we don't find a diff here we have to bother with
|
||||
// the working tree
|
||||
for (int i = 0; i < cnt; i++) {
|
||||
if (i == dirCache || i == workingTree)
|
||||
continue;
|
||||
if (tw.getRawMode(i) != dm || !tw.idEqual(i, dirCache))
|
||||
return true;
|
||||
}
|
||||
|
||||
// Only one chance left to detect a diff: between index and working
|
||||
// tree. Make use of the WorkingTreeIterator#isModified() method to
|
||||
// avoid computing SHA1 on filesystem content if not really needed.
|
||||
WorkingTreeIterator wi = workingTree(tw);
|
||||
DirCacheIterator di = tw.getTree(dirCache, DirCacheIterator.class);
|
||||
return wi.isModified(di.getDirCacheEntry(), true);
|
||||
}
|
||||
|
||||
private WorkingTreeIterator workingTree(TreeWalk tw) {
|
||||
return tw.getTree(workingTree, WorkingTreeIterator.class);
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean shouldBeRecursive() {
|
||||
// We cannot compare subtrees in the working tree, so encourage
|
||||
// use of recursive walks where the subtrees are always dived into.
|
||||
return true;
|
||||
}
|
||||
|
||||
@Override
|
||||
public TreeFilter clone() {
|
||||
return this;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "INDEX_DIFF_FILTER";
|
||||
}
|
||||
}
|
|
@ -45,9 +45,11 @@
|
|||
|
||||
import java.io.IOException;
|
||||
|
||||
import org.eclipse.jgit.dircache.DirCacheIterator;
|
||||
import org.eclipse.jgit.errors.IncorrectObjectTypeException;
|
||||
import org.eclipse.jgit.errors.MissingObjectException;
|
||||
import org.eclipse.jgit.treewalk.TreeWalk;
|
||||
import org.eclipse.jgit.treewalk.WorkingTreeIterator;
|
||||
|
||||
/**
|
||||
* Selects interesting tree entries during walking.
|
||||
|
@ -120,6 +122,9 @@ public String toString() {
|
|||
* {@link #ALL}, or as though the walker was matching a virtual empty tree
|
||||
* against the single tree it was actually given. Applications may wish to
|
||||
* treat such a difference as "all names added".
|
||||
* <p>
|
||||
* When comparing {@link WorkingTreeIterator} and {@link DirCacheIterator}
|
||||
* applications should use {@link IndexDiffFilter}.
|
||||
*/
|
||||
public static final TreeFilter ANY_DIFF = new AnyDiffFilter();
|
||||
|
||||
|
|
Loading…
Reference in New Issue