Uploaded image for project: 'Lucene - Core'
  1. Lucene - Core
  2. LUCENE-1383

Work around ThreadLocal's "leak"

Details

    • Bug
    • Status: Reopened
    • Major
    • Resolution: Fixed
    • 1.9, 2.0.0, 2.1, 2.2, 2.3, 2.3.1, 2.3.2
    • 2.4
    • core/index
    • None
    • New

    Description

      Java's ThreadLocal is dangerous to use because it is able to take a
      surprisingly very long time to release references to the values you
      store in it. Even when a ThreadLocal instance itself is GC'd, hard
      references to the values you had stored in it are easily kept for
      quite some time later.

      While this is not technically a "memory leak", because eventually
      (when the underlying Map that stores the values cleans up its "stale"
      references) the hard reference will be cleared, and GC can proceed,
      its end behavior is not different from a memory leak in that under the
      right situation you can easily tie up far more memory than you'd
      expect, and then hit unexpected OOM error despite allocating an
      extremely large heap to your JVM.

      Lucene users have hit this many times. Here's the most recent thread:

      http://mail-archives.apache.org/mod_mbox/lucene-java-dev/200809.mbox/%3C6e3ae6310809091157j7a9fe46bxcc31f6e63305fcdc%40mail.gmail.com%3E

      And here's another:

      http://mail-archives.apache.org/mod_mbox/lucene-java-dev/200807.mbox/%3CF5FC94B2-E5C7-40C0-8B73-E12245B91CEE%40mikemccandless.com%3E

      And then there's LUCENE-436 and LUCENE-529 at least.

      A google search for "ThreadLocal leak" yields many compelling hits.

      Sun does this for performance reasons, but I think it's a terrible
      trap and we should work around it with Lucene.

      Attachments

        1. ScreenHunter_07 Sep. 13 19.13.jpg
          17 kB
          Chris Lu
        2. ScreenHunter_03 Sep. 13 08.43.jpg
          16 kB
          Chris Lu
        3. ScreenHunter_02 Sep. 13 08.42.jpg
          16 kB
          Chris Lu
        4. ScreenHunter_01 Sep. 13 08.40.jpg
          15 kB
          Chris Lu
        5. LUCENE-1383.patch
          7 kB
          Michael McCandless

        Activity

          People

            mikemccand Michael McCandless
            mikemccand Michael McCandless
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: