Implement MMapDirectory with Java 21 Project Panama Preview API #12294

uschindler · 2023-05-15T17:09:14Z

This is the Java 21 version of MemorySegments following JEP 442.

There are not many changes:

Update scriptDepVersion's ASM to 9.5 and extract the preview API to a separate APIJAR file
make a clone of MemorySegmentIndexInput (no changes needed)
make a clone of MemorySegmentIndexInputProvider and adapt allocating a shared Arena. Also adapt FileChannel's map API to use Arenadirectly (scope is gone there).

I will make this PR a draft until JDK 21 is in final phase (RC).

…nput)

uschindler · 2023-05-15T17:12:33Z

I will setup testing on Policeman Jenkins soon!

uschindler · 2023-05-15T17:20:02Z

Hi @mcimadamore,
maybe also have a quick look.
Thanks, Uwe

dweiss

LGTM.

uschindler · 2023-05-15T19:29:09Z

Policeman Jenkins looks fine: https://jenkins.thetaphi.de/job/Lucene-MMAPv2-Linux/845/console

ChrisHegarty

LGTM

mcimadamore · 2023-05-18T13:05:45Z

Looks good!

# Conflicts: # gradle/generation/extract-jdk-apis.gradle

# Conflicts: # gradle/generation/extract-jdk-apis/ExtractJdkApis.java

…anges from bitAlignMent->byteAlignment ( openjdk/jdk@5fc9b57)

uschindler · 2023-06-09T23:09:27Z

I plan to get this in Lucene 9.7 (in addition to vector API for jdk21). The latest commit updated the apijar file to the version jdk-21-ea+26. There were minor changes (except javadoc changes, mainly openjdk/jdk@5fc9b57, not used by Lucene), so source code stayed.

JDK 21 is now feature complete, incompatible API changes are unlikely. In the worst case we have to add a bugfix release 9.7.1 to restore working Java 21.

uschindler · 2023-06-12T15:31:58Z

I talked with @mcimadamore in the meantime. At least for the Panama Foreign API (FFI) there are no changes planned anymore, so this is safe to merge into main branch.

Keep in mind: It could always happen that there is a major API bug that requires a change, but this sounds very unlikely to me. There is still a PR to update FFI Javadocs, but the API is final.

For the vector API (which will be a separate PR), I see no problem. The vector part is uncritical, as users have to "opt in". If the API changes till JDK 21 release, it won't hurt anybody. We can update the impl in a followup release so it works.

@ChrisHegarty, are you fine with merging this now, so we can port the vector part?

ChrisHegarty

LGTM

Backport incl JDK21 apijar file with java.util.Objects regenerated

uschindler · 2023-06-12T19:17:15Z

Hi @ChrisHegarty, i think we can start with a JDK 21 branch for Panama Vectors, the directories are there. Of course, you need to regenerate the apijars with vector classes (that's not included here).
Backport to 9.x was done, so we can release this with Lucene 9.7.

I will do a crosscheck shortly before release to verify that apijar is uptodate.

uschindler · 2023-06-12T19:27:49Z

I also removed a relic of the old filename of the apijar in the 9.x folder. It was not deleted while cherry-picking when we integrated vector API.

ChrisHegarty · 2023-06-12T19:45:03Z

Hi @ChrisHegarty, i think we can start with a JDK 21 branch for Panama Vectors, the directories are there. Of course, you need to regenerate the apijars with vector classes (that's not included here).

I'll start on this, and hopefully put up a PR by tomorrow.

…dc8ca633e8bcf`) (#20) * Add next minor version 9.7.0 * Fix SynonymQuery equals implementation (apache#12260) The term member of TermAndBoost used to be a Term instance and became a BytesRef with apache#11941, which means its equals impl won't take the field name into account. The SynonymQuery equals impl needs to be updated accordingly to take the field into account as well, otherwise synonym queries with same term and boost across different fields are equal which is a bug. * Fix MMapDirectory documentation for Java 20 (apache#12265) * Don't generate stacktrace in CollectionTerminatedException (apache#12270) CollectionTerminatedException is always caught and never exposed to users so there's no point in filling in a stack-trace for it. * add missing changelog entry for apache#12260 * Add missing author to changelog entry for apache#12220 * Make query timeout members final in ExitableDirectoryReader (apache#12274) There's a couple of places in the Exitable wrapper classes where queryTimeout is set within the constructor and never modified. This commit makes such members final. * Update javadocs for QueryTimeout (apache#12272) QueryTimeout was introduced together with ExitableDirectoryReader but is now also optionally set to the IndexSearcher to wrap the bulk scorer with a TimeLimitingBulkScorer. Its javadocs needs updating. * Make TimeExceededException members final (apache#12271) TimeExceededException has three members that are set within its constructor and never modified. They can be made final. * DOAP changes for release 9.6.0 * Add back-compat indices for 9.6.0 * `ToParentBlockJoinQuery` Explain Support Score Mode (apache#12245) (apache#12283) * `ToParentBlockJoinQuery` Explain Support Score Mode --------- Co-authored-by: Marcus <marcuseagan@gmail.com> * Simplify SliceExecutor and QueueSizeBasedExecutor (apache#12285) The only behaviour that QueueSizeBasedExecutor overrides from SliceExecutor is when to execute on the caller thread. There is no need to override the whole invokeAll method for that. Instead, this commit introduces a shouldExecuteOnCallerThread method that can be overridden. * [Backport] GITHUB-11838 Add api to allow concurrent query rewrite (apache#12197) * GITHUB-11838 Change API to allow concurrent query rewrite (apache#11840) Replace Query#rewrite(IndexReader) with Query#rewrite(IndexSearcher) Co-authored-by: Patrick Zhai <zhaih@users.noreply.github.com> Co-authored-by: Adrien Grand <jpountz@gmail.com> Backport of apache#11840 Changes from original: - Query keeps `rewrite(IndexReader)`, but it is now deprecated - VirtualMethod is used to correct delegate to the overridden methods - The changes to `RewriteMethod` type classes are reverted, this increased the backwards compatibility impact. ------------------------------ ### Description Issue: apache#11838 #### Updated Proposal * Change signature of rewrite to `rewrite(IndexSearcher)` * How did I migrate the usage: * Use Intellij to do preliminary refactoring for me * For test usage, use searcher whenever is available, otherwise create one using `newSearcher(reader)` * For very few non-test classes which doesn't have IndexSearcher available but called rewrite, create a searcher using `new IndexSearcher(reader)`, tried my best to avoid creating it recurrently (Especially in `FieldQuery`) * For queries who have implemented the rewrite and uses some part of reader's functionality, use shortcut method when possible, otherwise pull out the reader from indexSearcher. * Backport: Concurrent rewrite for KnnVectorQuery (apache#12160) (apache#12288) * Concurrent rewrite for KnnVectorQuery (apache#12160) - Reduce overhead of non-concurrent search by preserving original execution - Improve readability by factoring into separate functions --------- Co-authored-by: Kaival Parikh <kaivalp2000@gmail.com> * adjusting for backport --------- Co-authored-by: Kaival Parikh <46070017+kaivalnp@users.noreply.github.com> Co-authored-by: Kaival Parikh <kaivalp2000@gmail.com> * toposort use iterator to avoid stackoverflow (apache#12286) Co-authored-by: tangdonghai <tangdonghai@meituan.com> # Conflicts: # lucene/CHANGES.txt * Fix test to compile with Java 11 after backport of apache#12286 * Update Javadoc for topoSortStates method after apache#12286 (apache#12292) * Optimize HNSW diversity calculation (apache#12235) * Minor cleanup and improvements to DaciukMihovAutomatonBuilder (apache#12305) * GITHUB-12291: Skip blank lines from stopwords list. (apache#12299) * Wrap Query rewrite backwards layer with AccessController (apache#12308) * Make sure APIJAR reproduces with different timezone (unfortunately java encodes the date using local timezone) (apache#12315) * Add multi-thread searchability to OnHeapHnswGraph (apache#12257) * Fix backport error * [MINOR] Update javadoc in Query class (apache#12233) - add a few missing full stops - update wording in the description of Query#equals method * [Backport] Integrate the Incubating Panama Vector API apache#12311 (apache#12327) Leverage accelerated vector hardware instructions in Vector Search. Lucene already has a mechanism that enables the use of non-final JDK APIs, currently used for the Previewing Pamana Foreign API. This change expands this mechanism to include the Incubating Pamana Vector API. When the jdk.incubator.vector module is present at run time the Panamaized version of the low-level primitives used by Vector Search is enabled. If not present, the default scalar version of these low-level primitives is used (as it was previously). Currently, we're only targeting support for JDK 20. A subsequent PR should evaluate JDK 21. --------- Co-authored-by: Uwe Schindler <uschindler@apache.org> Co-authored-by: Robert Muir <rmuir@apache.org> * Parallelize knn query rewrite across slices rather than segments (apache#12325) The concurrent query rewrite for knn vectory query introduced with apache#12160 requests one thread per segment to the executor. To align this with the IndexSearcher parallel behaviour, we should rather parallelize across slices. Also, we can reuse the same slice executor instance that the index searcher already holds, in that way we are using a QueueSizeBasedExecutor when a thread pool executor is provided. * Optimize ConjunctionDISI.createConjunction (apache#12328) This method is showing up as a little hot when profiling some queries. Almost all the time spent in this method is just burnt on ceremony around stream indirections that don't inline. Moving this to iterators, simplifying the check for same doc id and also saving one iteration (for the min cost) makes this method far cheaper and easier to read. * Update changes to be correct with ARM (it is called NEON there) * GH#12321: Marked DaciukMihovAutomatonBuilder as deprecated (apache#12332) Preparing to reduce visibility of this class in a future release * add BitSet.clear() (apache#12268) # Conflicts: # lucene/CHANGES.txt * Clenaup and update changes and synchronize with 9.x * Update TestVectorUtilProviders.java (apache#12338) * Don't generate stacktrace for TimeExceededException (apache#12335) The exception is package private and never rethrown, we can avoid generating a stacktrace for it. * Introduced the Word2VecSynonymFilter (apache#12169) Co-authored-by: Alessandro Benedetti <a.benedetti@sease.io> * Word2VecSynonymFilter constructor null check (apache#12169) * Use thread-safe search version of HnswGraphSearcher (apache#12246) Addressing comment received in the PR apache#12246 * Word2VecSynonymProvider to use standard Integer max value for hnsw searches (apache#12235) We observed this change was not ported previously from main in an old cherry-pick * Fix searchafter high latency when after value is out of range for segment (apache#12334) * Make memory fence in `ByteBufferGuard` explicit (apache#12290) * Add "direct to binary" option for DaciukMihovAutomatonBuilder and use it in TermInSetQuery#visit (apache#12320) * Add updateDocuments API which accept a query (reopen) (apache#12346) * GITHUB#11350: Handle backward compatibility when merging segments with different FieldInfo This commits restores Lucene 9's ability to handle indices created with Lucene 8 where there are discrepancies in FieldInfos, such as different IndexOptions * [Tessellator] Improve the checks that validate the diagonal between two polygon nodes (apache#12353) # Conflicts: # lucene/CHANGES.txt * feat: soft delete optimize (apache#12339) * Better paging when random reads go backwards (apache#12357) When reading data from outside the buffer, BufferedIndexInput always resets its buffer to start at the new read position. If we are reading backwards (for example, using an OffHeapFSTStore for a terms dictionary) then this can have the effect of re-reading the same data over and over again. This commit changes BufferedIndexInput to use paging when reading backwards, so that if we ask for a byte that is before the current buffer, we read a block of data of bufferSize that ends at the previous buffer start. Fixes apache#12356 * Work around SecurityManager issues during initialization of vector api (JDK-8309727) (apache#12362) * Restrict GraphTokenStreamFiniteStrings#articulationPointsRecurse recursion depth (apache#12249) * Implement MMapDirectory with Java 21 Project Panama Preview API (apache#12294) Backport incl JDK21 apijar file with java.util.Objects regenerated * remove relic in apijar folder caused by vector additions * Speed up IndexedDISI Sparse #AdvanceExactWithinBlock for tiny step advance (apache#12324) * Add checks in KNNVectorField / KNNVectorQuery to only allow non-null, non-empty and finite vectors (apache#12281) --------- Co-authored-by: Uwe Schindler <uschindler@apache.org> * Implement VectorUtilProvider with Java 21 Project Panama Vector API (apache#12363) (apache#12365) This commit enables the Panama Vector API for Java 21. The version of VectorUtilPanamaProvider for Java 21 is identical to that of Java 20. As such, there is no specific 21 version - the Java 20 version will be loaded from the MRJAR. * Add CHANGES.txt for apache#12334 Honor after value for skipping documents even if queue is not full for PagingFieldCollector (apache#12368) Signed-off-by: gashutos <gashutos@amazon.com> * Move TermAndBoost back to its original location. (apache#12366) PR apache#12169 accidentally moved the `TermAndBoost` class to a different location, which would break custom sub-classes of `QueryBuilder`. This commit moves it back to its original location. * GITHUB-12252: Add function queries for computing similarity scores between knn vectors (apache#12253) Co-authored-by: Alessandro Benedetti <a.benedetti@sease.io> * hunspell (minor): reduce allocations when processing compound rules (apache#12316) (cherry picked from commit a454388) * hunspell (minor): reduce allocations when reading the dictionary's morphological data (apache#12323) there can be many entries with morph data, so we'd better avoid compiling and matching regexes and even stream allocation (cherry picked from commit 4bf1b94) * TestHunspell: reduce the flakiness probability (apache#12351) * TestHunspell: reduce the flakiness probability We need to check how the timeout interacts with custom exception-throwing checkCanceled. The default timeout seems not enough for some CI agents, so let's increase it. Co-authored-by: Dawid Weiss <dawid.weiss@gmail.com> (cherry picked from commit 5b63a18) * This allows VectorUtilProvider tests to be executed although hardware may not fully support vectorization or if C2 is not enabled (apache#12376) --------- Signed-off-by: gashutos <gashutos@amazon.com> Co-authored-by: Alan Woodward <romseygeek@apache.org> Co-authored-by: Luca Cavanna <javanna@apache.org> Co-authored-by: Uwe Schindler <uschindler@apache.org> Co-authored-by: Armin Braun <me@obrown.io> Co-authored-by: Mikhail Khludnev <mkhludnev@users.noreply.github.com> Co-authored-by: Marcus <marcuseagan@gmail.com> Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com> Co-authored-by: Kaival Parikh <46070017+kaivalnp@users.noreply.github.com> Co-authored-by: Kaival Parikh <kaivalp2000@gmail.com> Co-authored-by: tang donghai <tangdhcs@gmail.com> Co-authored-by: Patrick Zhai <zhaih@users.noreply.github.com> Co-authored-by: Greg Miller <gsmiller@gmail.com> Co-authored-by: Jerry Chin <metrxqin@gmail.com> Co-authored-by: Patrick Zhai <zhai7631@gmail.com> Co-authored-by: Andrey Bozhko <andybozhko@gmail.com> Co-authored-by: Chris Hegarty <62058229+ChrisHegarty@users.noreply.github.com> Co-authored-by: Robert Muir <rmuir@apache.org> Co-authored-by: Jonathan Ellis <jbellis@datastax.com> Co-authored-by: Daniele Antuzi <daniele.antuzi@gmail.com> Co-authored-by: Alessandro Benedetti <a.benedetti@sease.io> Co-authored-by: Chaitanya Gohel <104654647+gashutos@users.noreply.github.com> Co-authored-by: Petr Portnov | PROgrm_JARvis <pportnov@ozon.ru> Co-authored-by: Tomas Eduardo Fernandez Lobbe <tflobbe@apache.org> Co-authored-by: Ignacio Vera <ivera@apache.org> Co-authored-by: fudongying <30896830+fudongyingluck@users.noreply.github.com> Co-authored-by: Chris Fournier <chris.fournier@shopify.com> Co-authored-by: gf2121 <52390227+gf2121@users.noreply.github.com> Co-authored-by: Adrien Grand <jpountz@gmail.com> Co-authored-by: Elia Porciani <e.porciani@sease.io> Co-authored-by: Peter Gromov <peter@jetbrains.com>

Implement Java 21 version of MMapDirectory (using MemorySegmentIndexI…

ec55da5

…nput)

uschindler added the type:enhancement label May 15, 2023

uschindler self-assigned this May 15, 2023

uschindler marked this pull request as draft May 15, 2023 17:09

uschindler requested a review from rmuir May 15, 2023 17:10

uschindler added this to the 9.7.0 milestone May 15, 2023

uschindler requested a review from dweiss May 15, 2023 17:20

dweiss approved these changes May 15, 2023

View reviewed changes

rmuir approved these changes May 15, 2023

View reviewed changes

uschindler mentioned this pull request May 16, 2023

Make memory fence in ByteBufferGuard explicit #12290

Merged

rmuir mentioned this pull request May 18, 2023

vector API integration, plan B #12302

Closed

ChrisHegarty approved these changes May 18, 2023

View reviewed changes

mcimadamore approved these changes May 18, 2023

View reviewed changes

uschindler added 5 commits May 19, 2023 18:51

Merge branch 'main' into dev/java21-panama-mmap

4cb342f

update java 21 jar after merge

b920e1f

Merge branch 'main' into dev/java21-panama-mmap

9e984dd

# Conflicts: # gradle/generation/extract-jdk-apis.gradle

Add new version to extractor

79d9ee5

Prepare for Java 22

6a227f2

uschindler mentioned this pull request May 25, 2023

Integrate the Incubating Panama Vector API #12311

Merged

uschindler added 3 commits May 25, 2023 17:26

Merge branch 'main' into dev/java21-panama-mmap

fb52fd8

# Conflicts: # gradle/generation/extract-jdk-apis/ExtractJdkApis.java

Merge branch 'main' into dev/java21-panama-mmap

e598fba

Update to latest APIJAR version (JDK 21-ea+26): This is mainly the ch…

4372a91

…anges from bitAlignMent->byteAlignment ( openjdk/jdk@5fc9b57)

uschindler added the legacy-jira-priority:Blocker label Jun 9, 2023

uschindler marked this pull request as ready for review June 9, 2023 23:07

uschindler requested a review from ChrisHegarty June 9, 2023 23:09

ChrisHegarty approved these changes Jun 12, 2023

View reviewed changes

uschindler added 2 commits June 12, 2023 21:03

Merge branch 'main' into dev/java21-panama-mmap

57bf78a

Add CHANGES.txt

67e315a

uschindler merged commit c8e05c8 into apache:main Jun 12, 2023

uschindler deleted the dev/java21-panama-mmap branch June 12, 2023 19:07

asfgit pushed a commit that referenced this pull request Jun 12, 2023

Implement MMapDirectory with Java 21 Project Panama Preview API (#12294)

adc3740

Backport incl JDK21 apijar file with java.util.Objects regenerated

austintlee mentioned this pull request Oct 11, 2023

Try out new MMapDirectory implementation in Lucene using Panama (FFM) opensearch-project/OpenSearch#10552

Open

steveblackburn mentioned this pull request Apr 22, 2024

JDK 21, lusearch, and Lucene "regression" dacapobench/dacapobench#264

Closed

Bukhtawar mentioned this pull request Oct 3, 2024

[BUG] Segrep replication gets stuck in MemorySegmentIndexInput close opensearch-project/OpenSearch#16180

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement MMapDirectory with Java 21 Project Panama Preview API #12294

Implement MMapDirectory with Java 21 Project Panama Preview API #12294

uschindler commented May 15, 2023

uschindler commented May 15, 2023

uschindler commented May 15, 2023

dweiss left a comment

uschindler commented May 15, 2023

ChrisHegarty left a comment

mcimadamore commented May 18, 2023

uschindler commented Jun 9, 2023 •

edited

Loading

uschindler commented Jun 12, 2023

ChrisHegarty left a comment

uschindler commented Jun 12, 2023

uschindler commented Jun 12, 2023

ChrisHegarty commented Jun 12, 2023

Implement MMapDirectory with Java 21 Project Panama Preview API #12294

Implement MMapDirectory with Java 21 Project Panama Preview API #12294

Conversation

uschindler commented May 15, 2023

uschindler commented May 15, 2023

uschindler commented May 15, 2023

dweiss left a comment

Choose a reason for hiding this comment

uschindler commented May 15, 2023

ChrisHegarty left a comment

Choose a reason for hiding this comment

mcimadamore commented May 18, 2023

uschindler commented Jun 9, 2023 • edited Loading

uschindler commented Jun 12, 2023

ChrisHegarty left a comment

Choose a reason for hiding this comment

uschindler commented Jun 12, 2023

uschindler commented Jun 12, 2023

ChrisHegarty commented Jun 12, 2023

uschindler commented Jun 9, 2023 •

edited

Loading