[LUCENE-8635] Lazy loading Lucene FST offheap using mmap

• Type: New Feature
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 8.0, 8.x, 9.0
• Component/s: core/FSTs

Environment

I used below setup for es_rally tests:

single node i3.xlarge running ES 6.5

es_rally was running on another i3.xlarge instance

• Lucene Fields: New, Patch Available
• Review Patch?: Yes
• Assignee: Unassigned
• Reporter: Ankit Jain
• Created: 11/Jan/19 18:58
• Updated: 28/Aug/22 15:40
• Resolved: 19/Feb/19 18:01

Description

Currently, FST loads all the terms into heap memory during index open. This causes frequent JVM OOM issues if the term size gets big. A better way of doing this will be to lazily load FST using mmap. That ensures only the required terms get loaded into memory.

 
Lucene can expose API for providing list of fields to load terms offheap. I'm planning to take following approach for this:

1. Add a boolean property fstOffHeap in FieldInfo
2. Pass list of offheap fields to lucene during index open (ALL can be special keyword for loading ALL fields offheap)
3. Initialize the fstOffHeap property during lucene index open
4. FieldReader invokes default FST constructor or OffHeap constructor based on fstOffHeap field

 
I created a patch (that loads all fields offheap), did some benchmarks using es_rally and results look good.

Issue Links

• is related to: LUCENE-8671 Add setting for moving FST offheap/onheap
• is related to: LUCENE-8887 CLONE - Add setting for moving FST offheap/onheap
• relates to: LUCENE-7826 Support to unload FST's .tip into memory,make load or unload configuable!.