Go to file
Han-Wen Nienhuys e60b9e1879 FileSnapshot: fix bug with timestamp thresholding
Increase the safety factor to 2.5x for extra safety if max of measured
timestamp resolution and measured minimal racy threshold is < 100ms, use
1.25 otherwise since for large filesystem resolution values the
influence of finite resolution of the system clock should be negligible.

Before, not yet using the newly introduced minRacyThreshold measurement,
the threshold was 1.1x FS resolution, and we could issue the
following sequence of events,

  start
  create-file
  read-file (currentTime)
  end

which had the following timestamps:

  create-file 1564589081998
  start 1564589082002
  read 1564589082003
  end 1564589082004

In this case, the difference between create-file and read is 5ms,
which exceeded the 4ms FS resolution, even though the events together
took just 2ms of runtime.

Reproduce with:
  bazel test --runs_per_test=100 \
    //org.eclipse.jgit.test:org_eclipse_jgit_internal_storage_file_FileSnapshotTest

The file system timestamp resolution is 4ms in this case.

This code assumes that the kernel and the JVM use the same clock that
is synchronized with the file system clock. This seems plausible,
given the resolution of System.currentTimeMillis() and the latency for
a gettimeofday system call (typically ~1us), but it would be good to
justify this with specifications.

Also cover a source of flakiness: if the test runs under extreme load,
then we could have

  start
  create-file
  <long delay>
  read
  end

which would register as an unmodified file. Avoid this by skipping the
test if end-start is too big.

[msohn]:
- downported from master to stable-5.1
- skip test if resolution is below 10ms
- adjust safety factor to 1.25 for resolutions above 100ms

Change-Id: I87d2cf035e01c44b7ba8364c410a860aa8e312ef
Signed-off-by: Han-Wen Nienhuys <hanwen@google.com>
Signed-off-by: Matthias Sohn <matthias.sohn@sap.com>
2019-08-07 13:56:08 +02:00
.mvn Configure max heap size for Maven build 2016-12-09 11:02:10 +01:00
Documentation/technical reftable: explicitly store update_index per ref 2017-08-21 15:39:08 -07:00
lib Bazel: Add missing dependencies for ArchiveCommandTest 2019-07-16 12:10:31 +09:00
org.eclipse.jgit FileSnapshot: fix bug with timestamp thresholding 2019-08-07 13:56:08 +02:00
org.eclipse.jgit.ant Prepare 5.1.9-SNAPSHOT builds 2019-06-05 15:23:56 +02:00
org.eclipse.jgit.ant.test Persist minimal racy threshold and allow manual configuration 2019-08-06 14:54:39 +02:00
org.eclipse.jgit.archive Deprecate Constants.CHARACTER_ENCODING in favor of StandardCharsets.UTF_8 2019-06-19 10:43:01 +02:00
org.eclipse.jgit.http.apache Prepare 5.1.9-SNAPSHOT builds 2019-06-05 15:23:56 +02:00
org.eclipse.jgit.http.server Use Instant instead of milliseconds for filesystem timestamp handling 2019-07-18 03:27:52 +02:00
org.eclipse.jgit.http.test Deprecate Constants.CHARACTER_ENCODING in favor of StandardCharsets.UTF_8 2019-06-19 10:43:01 +02:00
org.eclipse.jgit.junit Persist minimal racy threshold and allow manual configuration 2019-08-06 14:54:39 +02:00
org.eclipse.jgit.junit.http Prepare 5.1.9-SNAPSHOT builds 2019-06-05 15:23:56 +02:00
org.eclipse.jgit.lfs Prepare 5.1.9-SNAPSHOT builds 2019-06-05 15:23:56 +02:00
org.eclipse.jgit.lfs.server Fix API problem filters 2019-06-17 00:35:10 +02:00
org.eclipse.jgit.lfs.server.test Persist minimal racy threshold and allow manual configuration 2019-08-06 14:54:39 +02:00
org.eclipse.jgit.lfs.test Deprecate Constants.CHARACTER_ENCODING in favor of StandardCharsets.UTF_8 2019-06-19 10:43:01 +02:00
org.eclipse.jgit.packaging Update Maven plugins and cleanup Maven warnings 2019-06-18 16:55:44 +02:00
org.eclipse.jgit.pgm Use Instant instead of milliseconds for filesystem timestamp handling 2019-07-18 03:27:52 +02:00
org.eclipse.jgit.pgm.test Deprecate Constants.CHARACTER_ENCODING in favor of StandardCharsets.UTF_8 2019-06-19 10:43:01 +02:00
org.eclipse.jgit.test FileSnapshot: fix bug with timestamp thresholding 2019-08-07 13:56:08 +02:00
org.eclipse.jgit.ui Prepare 5.1.9-SNAPSHOT builds 2019-06-05 15:23:56 +02:00
tools Bazel: Stop using native.git_repository 2019-03-03 13:15:19 +09:00
.gitattributes Initial JGit contribution to eclipse.org 2009-09-29 16:47:03 -07:00
.gitignore git ignore .DS_Store 2017-07-28 11:09:47 +01:00
.mailmap Update .mailmap 2018-06-27 13:42:29 +09:00
BUILD Bazel: Support building with Java 9 2018-02-07 17:51:35 -05:00
CONTRIBUTING.md Update SUBMITTING_PATCHES 2014-07-20 17:44:53 -04:00
LICENSE Clean up LICENSE file 2010-07-02 14:52:49 -07:00
README.md Update minimum JDK version in README 2017-02-10 18:47:39 -04:00
WORKSPACE Update bazlets to latest version 2019-07-16 12:10:31 +09:00
pom.xml Update Maven plugins ecj, plexus, error-prone 2019-06-19 10:41:52 +02:00

README.md

Java Git

An implementation of the Git version control system in pure Java.

This package is licensed under the EDL (Eclipse Distribution License).

JGit can be imported straight into Eclipse, built and tested from there, but the automated builds use Maven.

  • org.eclipse.jgit

    A pure Java library capable of being run standalone, with no additional support libraries. It provides classes to read and write a Git repository and operate on a working directory.

    All portions of JGit are covered by the EDL. Absolutely no GPL, LGPL or EPL contributions are accepted within this package.

  • org.eclipse.jgit.ant

    Ant tasks based on JGit.

  • org.eclipse.jgit.archive

    Support for exporting to various archive formats (zip etc).

  • org.eclipse.jgit.http.apache

    Apache httpclient support

  • org.eclipse.jgit.http.server

    Server for the smart and dumb Git HTTP protocol.

  • org.eclipse.jgit.pgm

    Command-line interface Git commands implemented using JGit ("pgm" stands for program).

  • org.eclipse.jgit.packaging

    Production of Eclipse features and p2 repository for JGit. See the JGit Wiki on why and how to use this module.

Tests

  • org.eclipse.jgit.junit

    Helpers for unit testing

  • org.eclipse.jgit.test

    Unit tests for org.eclipse.jgit

  • org.eclipse.jgit.ant.test

  • org.eclipse.jgit.pgm.test

  • org.eclipse.jgit.http.test

  • org.eclipse.jgit.junit.test

    No further description needed

Warnings/Caveats

  • Native smbolic links are supported, provided the file system supports them. For Windows you must have Windows Vista/Windows 2008 or newer, use a non-administrator account and have the SeCreateSymbolicLinkPrivilege.

  • Only the timestamp of the index is used by jgit if the index is dirty.

  • JGit requires at least a Java 8 JDK.

  • CRLF conversion is performed depending on the core.autocrlf setting, however Git for Windows by default stores that setting during installation in the "system wide" configuration file. If Git is not installed, use the global or repository configuration for the core.autocrlf setting.

  • The system wide configuration file is located relative to where C Git is installed. Make sure Git can be found via the PATH environment variable. When installing Git for Windows check the "Run Git from the Windows Command Prompt" option. There are other options like Eclipse settings that can be used for pointing out where C Git is installed. Modifying PATH is the recommended option if C Git is installed.

  • We try to use the same notation of $HOME as C Git does. On Windows this is often not the same value as the user.home system property.

Package Features

  • org.eclipse.jgit/

    • Read loose and packed commits, trees, blobs, including deltafied objects.

    • Read objects from shared repositories

    • Write loose commits, trees, blobs.

    • Write blobs from local files or Java InputStreams.

    • Read blobs as Java InputStreams.

    • Copy trees to local directory, or local directory to a tree.

    • Lazily loads objects as necessary.

    • Read and write .git/config files.

    • Create a new repository.

    • Read and write refs, including walking through symrefs.

    • Read, update and write the Git index.

    • Checkout in dirty working directory if trivial.

    • Walk the history from a given set of commits looking for commits introducing changes in files under a specified path.

    • Object transport Fetch via ssh, git, http, Amazon S3 and bundles. Push via ssh, git and Amazon S3. JGit does not yet deltify the pushed packs so they may be a lot larger than C Git packs.

    • Garbage collection

    • Merge

    • Rebase

    • And much more

  • org.eclipse.jgit.pgm/

    • Assorted set of command line utilities. Mostly for ad-hoc testing of jgit log, glog, fetch etc.
  • org.eclipse.jgit.ant/

    • Ant tasks
  • org.eclipse.jgit.archive/

    • Support for Zip/Tar and other formats
  • org.eclipse.http.*/

    • HTTP client and server support

Missing Features

There are some missing features:

  • gitattributes support

Support

Post question, comments or patches to the jgit-dev@eclipse.org mailing list. You need to be subscribed to post, see here:

https://dev.eclipse.org/mailman/listinfo/jgit-dev

Contributing

See the EGit Contributor Guide:

http://wiki.eclipse.org/EGit/Contributor_Guide

About Git

More information about Git, its repository format, and the canonical C based implementation can be obtained from the Git website:

http://git-scm.com/