RETIRED, Gerrit as used by OpenStack
Go to file
Hugo Arès 00fc15ac00 Reduce chance of deadlock in account cache
This deadlock is not the typical deadlock where 2 threads locked a
resource and each one is waiting to lock a second resource already
locked by the other thread. The thread owning the account cache lock is
parked, which tell us that the locked was not released. I could not
determine the exact sequence of events leading to this deadlock making
it really hard to report/fix the problem.

While investigating, I realized that there quite a few reported issues
in Guava that could be major for Gerrit:

  Our deadlock happening in account cache
  https://bugs.chromium.org/p/gerrit/issues/detail?id=7645

  Other deadlock
  https://github.com/google/guava/issues/2976
  https://github.com/google/guava/issues/2863

  Performance
  https://github.com/google/guava/issues/2063

  Race condition
  https://github.com/google/guava/issues/2971

Because I could not reproduce the deadlock in a dev environment or in
a unit test making it almost impossible to fix, I considered other
options such as replacing Guava by something else.

The maintainer of Caffeine[1] cache claims that Caffeine is a high
performance[2], near optimal caching library designed/implemented base
on the experience of designing Guava's cache and ConcurrentLinkedHashMap.
I also did some benchmarks about spawning a lot of threads reading/writing
values from the caches. I ran those benchmarks on both Guava and Caffeine
and Guava was always taking at least double the time than Caffeine to
complete all operations.

Migrating to Caffeine is almost a drop-in replacement. Caffeine
interface are very similar to Guava cache and there is an adapter to
migrate to Caffeine and keep using Guava's interfaces. After migrating
to Caffeine, we saw that deadlock occurrence was reduced from once a day
to once every 2 weeks in our production server.

The maintainer of Caffeine, Ben Manes pointed us to the possible
cause[3] of this issue, a bug[4] in the kernel and its fix[5]. Our
kernel version is supposed to have the fix but we will try another OS
and kernel version.

Replacing Guava caches by Caffeine brings 2 things, it reduces the
chances of having the deadlock most likely caused by a kernel bug and
improve the cache performance.

[1]https://github.com/ben-manes/caffeine
[2]https://github.com/ben-manes/caffeine/wiki/Benchmarks
[3]https://groups.google.com/forum/#!topic/mechanical-sympathy/QbmpZxp6C64
[4]b0c29f79ec
[5]76835b0ebf

Bug: Issue 7645
Change-Id: I8d2b17a94d0e9daf9fa9cdda563316c5768b29ae
2018-02-22 18:53:47 +00:00
.settings Enable new Eclipse 4.7 "unlikely-arg-type" warning 2017-09-21 16:39:04 +09:00
contrib Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
Documentation Fix account_patch_reviews for mysql 2018-02-15 21:40:22 +00:00
gerrit-acceptance-framework Allow plugin IT test to get location of plugin data dir 2018-02-22 01:45:05 +00:00
gerrit-acceptance-tests Merge branch 'stable-2.13' into stable-2.14 2018-02-06 21:06:20 +09:00
gerrit-antlr Merge branch 'stable-2.13' into stable-2.14 2018-02-08 15:38:27 +09:00
gerrit-cache-h2 Reduce chance of deadlock in account cache 2018-02-22 18:53:47 +00:00
gerrit-common SiteLibraryLoaderUtil: Add debug log of the loaded libraries 2018-02-20 17:14:51 +09:00
gerrit-elasticsearch Remove 'flaky' tag from elasticsearch tests 2017-04-28 10:45:24 +02:00
gerrit-extension-api Set version to 2.14.7 2018-01-15 11:07:26 +09:00
gerrit-gpg PostGpgKeys: Gracefully handle malformed GPG keys input 2017-11-07 16:06:15 +09:00
gerrit-gwtdebug Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-gwtexpui Format java files with google-java-format 2017-02-17 13:21:04 +09:00
gerrit-gwtui Fix error dialog not honoring line breaks 2018-01-30 01:09:52 +00:00
gerrit-gwtui-common RelativeDateFormatter: Simplify rounding of years and months 2017-10-13 21:33:33 +09:00
gerrit-httpd Prevent concurrent login by disabling form submission 2018-01-05 13:43:11 +00:00
gerrit-launcher GerritLauncher: Remove unnecessary debug output 2017-10-02 13:01:22 +01:00
gerrit-lucene Merge branch stable-2.13' into stable-2.14 2018-02-08 13:19:57 -05:00
gerrit-main Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-oauth Trim leading slash from redirect after oauth login 2017-04-24 22:56:25 +00:00
gerrit-openid Fixing registration redirect for new OpenID users 2018-02-06 20:06:43 -08:00
gerrit-patch-commonsnet Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-patch-jgit Bazel: Allow to consume jgit from development tree 2017-03-22 22:27:12 +01:00
gerrit-pgm Extend MigrateAccountPatchReviewDb summary with stats 2017-12-05 14:01:59 +01:00
gerrit-plugin-api Reduce chance of deadlock in account cache 2018-02-22 18:53:47 +00:00
gerrit-plugin-gwtui Set version to 2.14.7 2018-01-15 11:07:26 +09:00
gerrit-prettify Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-reviewdb Suppress warnings about deprecated CheckedFuture 2017-11-21 10:24:26 +09:00
gerrit-server Don't treat MergeIdenticalTreeException as internal server error 2018-02-22 19:11:22 +09:00
gerrit-sshd Trim multi-line arguments for task name and ssh_log 2018-02-21 10:31:25 +00:00
gerrit-test-util SitePathsTest: Convert to use Google Truth 2017-03-01 14:03:12 +09:00
gerrit-util-cli Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-util-http Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-util-ssl Format all Java files with google-java-format 2017-02-07 10:04:39 +09:00
gerrit-war Set version to 2.14.7 2018-01-15 11:07:26 +09:00
lib Reduce chance of deadlock in account cache 2018-02-22 18:53:47 +00:00
plugins Update git submodules 2018-02-21 23:53:13 +00:00
polygerrit-ui Mark all "My" menu links as external 2018-02-14 20:03:07 +00:00
ReleaseNotes Remove Buck based build 2017-01-23 12:44:58 +00:00
tools Merge "Provide mvn command output when VERBOSE set" into stable-2.14 2018-02-07 23:20:24 +00:00
website/releases Fix Diffy logo on release page by encoding the image 2015-12-29 10:36:39 -08:00
.bazelproject Remove Buck based build 2017-01-23 12:44:58 +00:00
.editorconfig Added continuation indent to editorconfig 2016-04-26 14:42:58 +02:00
.git-blame-ignore-revs Update git hyper-blame configuration 2017-02-17 16:35:50 +09:00
.gitignore Add /plugins/cookbook-plugin/ to .gitignore 2017-11-06 11:41:05 +01:00
.gitmodules Remove the cookbook-plugin submodule 2017-04-06 20:13:02 +00:00
.mailmap Update .mailmap 2017-07-19 15:32:39 +09:00
.pydevproject Update PyDev project to use Python 2.7 2014-10-02 15:16:44 +09:00
BUILD Format BUILD and WORKSPACE files with buildifier 2017-02-28 17:32:44 +09:00
COPYING Initial project setup of Gerrit 2 2008-11-14 16:59:34 -08:00
INSTALL Remove Gerrit 1.x to 2.x import tools 2009-03-27 20:20:10 -07:00
README.md Remove Buck based build 2017-01-23 12:44:58 +00:00
SUBMITTING_PATCHES Update push URL in SUBMITTING_PATCHES 2012-03-29 00:57:14 -04:00
version.bzl Set version to 2.14.7 2018-01-15 11:07:26 +09:00
WORKSPACE Reduce chance of deadlock in account cache 2018-02-22 18:53:47 +00:00

Gerrit Code Review

Gerrit is a code review and project management tool for Git based projects.

Build Status

Objective

Gerrit makes reviews easier by showing changes in a side-by-side display, and allowing inline comments to be added by any reviewer.

Gerrit simplifies Git based project maintainership by permitting any authorized user to submit changes to the master Git repository, rather than requiring all approved changes to be merged in by hand by the project maintainer.

Documentation

For information about how to install and use Gerrit, refer to the documentation.

Source

Our canonical Git repository is located on googlesource.com. There is a mirror of the repository on Github.

Reporting bugs

Please report bugs on the issue tracker.

Contribute

Gerrit is the work of hundreds of contributors. We appreciate your help!

Please read the contribution guidelines.

Note that we do not accept Pull Requests via the Github mirror.

Getting in contact

The IRC channel on freenode is #gerrit. An archive is available at: echelog.com.

The Developer Mailing list is repo-discuss on Google Groups.

License

Gerrit is provided under the Apache License 2.0.

Build

Install Bazel and run the following:

    git clone --recursive https://gerrit.googlesource.com/gerrit
    cd gerrit && bazel build release

Install binary packages (Deb/Rpm)

The instruction how to configure GerritForge/BinTray repositories is here

On Debian/Ubuntu run:

    apt-get update & apt-get install gerrit=<version>-<release>

NOTE: release is a counter that starts with 1 and indicates the number of packages that have been released with the same version of the software.

On CentOS/RedHat run:

    yum clean all && yum install gerrit-<version>[-<release>]

On Fedora run:

    dnf clean all && dnf install gerrit-<version>[-<release>]

Use pre-built Gerrit images on Docker

Docker images of Gerrit are available on DockerHub

To run a CentOS 7 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-centos7[:version]

To run a Ubuntu 15.04 based Gerrit image:

    docker run -p 8080:8080 gerritforge/gerrit-ubuntu15.04[:version]

NOTE: release is optional. Last released package of the version is installed if the release number is omitted.