Skip to content

SPANN SelectHead: opt-in parallel BKT build#450

Open
fastio wants to merge 2 commits into
microsoft:mainfrom
fastio:feat/parallel-bkt
Open

SPANN SelectHead: opt-in parallel BKT build#450
fastio wants to merge 2 commits into
microsoft:mainfrom
fastio:feat/parallel-bkt

Conversation

@fastio

@fastio fastio commented Jun 10, 2026

Copy link
Copy Markdown

Motivation

For billion-scale datasets, BKT construction in SelectHead dominates index
build time. The existing build is a serial node schedule where only
KmeansAssign inside a single node is data-parallel. That works well near the
root (few large nodes) but leaves most cores idle once the tree fans out into
many small subtrees.

Design

Two-phase parallel build, gated by a new [SelectHead] ParallelBuildBKT option
(default false, i.e. the existing serial path is untouched unless opted in):

  • Phase 1 (top of the tree): serial node schedule, each node clustered with
    the existing intra-node data-parallel KmeansAssign using all threads. The
    few large nodes near the root are exactly where data parallelism is
    effective.
  • Phase 2 (bottom of the tree): once a subtree's size drops below a cutoff
    (max(BKTLeafSize * 4, N / (threads * 16) + 1)), it is deferred and later
    built whole by a single worker. Workers pull deferred subtrees from a shared
    queue (fetch_add), each with its own KmeansArgs and _TH = 1, so the
    many small nodes are processed without per-node thread spawning.

All workers share the single N-sized label buffer: sibling nodes own disjoint
[first, last] ranges of localindices (including the center slot at last),
so writes never overlap.

Concurrency changes

  • Utils::rand now uses a thread_local std::mt19937. std::rand() shares
    hidden global state and races under concurrent clustering. Note this also
    affects the serial path:
    previously std::rand() without srand produced
    the same sequence on every run; builds are now seeded fro
    std::random_device and are no longer deterministic run-to-run. Quality is
    equivalent; verification should compare recall, not bits.
  • Structural writes to m_pTreeRoots are guarded by a mutex; writes to
    m_pSampleCenterMap by another. The clustering itself is
  • KmeansAssign gains a _TH == 1 serial fast path so Phase 2 workers do not
    spawn/join a thread per node.

Compatibility

  • Default off; with the option unset the build takes the or
  • Parallel builds are not bit-identical to serial ones (RNG, scheduling, and
    floating-point summation order differ); tree quality is e

Also included

A second commit with portability fixes needed to consume SP
under a strict libc++ toolchain at C++23:

  • The non-TBB ConcurrentQueue/ConcurrentSet/ConcurrentMap fallbacks now
    expose the TBB API surface that ExtraFileController/Ex already use (unsafe_size, empty, unsafe_begin/end, value_type`,
    range iteration), so the no-TBB configuration compiles ag
  • LoggerHolder always takes the std::atomic_load/std::atomic_store path:
    the C++20 std::atomic<std::shared_ptr<Logger>> speciali
    by libc++ and the pre-C++20 path is valid under both standards.
  • Pass .c_str() to a SPTAGLIB_LOG varargs call in Appr (passing std::stringthrough...` is undefined behavior).
  • Drop an unused <omp.h> include from TxtReader.cpp.

fastio added 2 commits June 9, 2026 17:51
Two-phase parallel BKTree build to speed up SelectHead on large data:
- Phase 1 (top): few large nodes use the existing intra-node data-parallel
  KmeansAssign (all threads).
- Phase 2 (bottom): many small subtrees (<= cutoff) built in parallel, one
  worker per subtree (per-worker KmeansArgs, _TH=1), sharing the single
  N-sized label buffer via disjoint [first,last) writes.

Concurrency hazards addressed:
- Utils::rand -> thread_local std::mt19937 (std::rand() was racy under threads).
- m_pTreeRoots structural writes guarded by m_treeLock; clustering is lock-free.
- m_pSampleCenterMap writes guarded by m_sampleMapLock.
- KmeansAssign gains a _TH==1 serial fast-path (no per-node thread spawn).

Gated by [SelectHead] ParallelBuildBKT (default false = original serial path).
Not bit-reproducible vs serial (RNG/scheduling/FP order); verify by recall + TSan.
Make the non-TBB ConcurrentQueue/Set/Map fallbacks expose the TBB API
surface used by ExtraFileController/ExtraDynamicSearcher (unsafe_size,
empty, unsafe_begin/end, value_type, range iteration). Force the
LoggerHolder pre-C++20 path so std::atomic<std::shared_ptr<Logger>>
never instantiates under libc++. Drop an unused omp.h include and pass
.c_str() to a SPTAGLIB_LOG variadic call.
@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

@fastio please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

  • (default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
  • (when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"
Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

  1. Definitions.
    “Code” means the computer software code, whether in human-readable or machine-executable form,
    that is delivered by You to Microsoft under this Agreement.
    “Project” means any of the projects owned or managed by Microsoft and offered under a license
    approved by the Open Source Initiative (www.opensource.org).
    “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
    Project, including but not limited to communication on electronic mailing lists, source code control
    systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
    discussing and improving that Project, but excluding communication that is conspicuously marked or
    otherwise designated in writing by You as “Not a Submission.”
    “Submission” means the Code and any other copyrightable material Submitted by You, including any
    associated comments and documentation.
  2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any
    Project. This Agreement covers any and all Submissions that You, now or in the future (except as
    described in Section 4 below), Submit to any Project.
  3. Originality of Work. You represent that each of Your Submissions is entirely Your original work.
    Should You wish to Submit materials that are not Your original work, You may Submit them separately
    to the Project if You (a) retain all copyright and license information that was in the materials as You
    received them, (b) in the description accompanying Your Submission, include the phrase “Submission
    containing materials of a third party:” followed by the names of the third party and any licenses or other
    restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
    guidelines concerning Submissions.
  4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else
    for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
    Submission is made in the course of Your work for an employer or Your employer has intellectual
    property rights in Your Submission by contract or applicable law, You must secure permission from Your
    employer to make the Submission before signing this Agreement. In that case, the term “You” in this
    Agreement will refer to You and the employer collectively. If You change employers in the future and
    desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
    and secure permission from the new employer before Submitting those Submissions.
  5. Licenses.
  • Copyright License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
    Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
    the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
    parties.
  • Patent License. You grant Microsoft, and those who receive the Submission directly or
    indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
    Your patent claims that are necessarily infringed by the Submission or the combination of the
    Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
    import or otherwise dispose of the Submission alone or with the Project.
  • Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
    No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
    granted by implication, exhaustion, estoppel or otherwise.
  1. Representations and Warranties. You represent that You are legally entitled to grant the above
    licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
    have disclosed under Section 3). You represent that You have secured permission from Your employer to
    make the Submission in cases where Your Submission is made in the course of Your work for Your
    employer or Your employer has intellectual property rights in Your Submission by contract or applicable
    law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
    have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
    You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
    REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
    EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
    PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
    NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
  2. Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
    You later become aware that would make Your representations in this Agreement inaccurate in any
    respect.
  3. Information about Submissions. You agree that contributions to Projects and information about
    contributions may be maintained indefinitely and disclosed publicly, including Your name and other
    information that You submit with Your Submission.
  4. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
    the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
    Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
    exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
    defenses of lack of personal jurisdiction and forum non-conveniens.
  5. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
    supersedes any and all prior agreements, understandings or communications, written or oral, between
    the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant