Skip to content

Add opt-in single-node multi-tenant SPANN with pluggable postings - #475

Draft
Baotong Lu (baotonglu) wants to merge 1 commit into
microsoft:users/qiazh/pre-merge-tikv-bugfixfrom
baotonglu:feature/single-node-multitenant-spann
Draft

Baotong Lu (baotonglu) wants to merge 1 commit into
microsoft:users/qiazh/pre-merge-tikv-bugfixfrom
baotonglu:feature/single-node-multitenant-spann

Conversation

@baotonglu

@baotonglu Baotong Lu (baotonglu) commented Nov 16, 2026 •

Copy link
Copy Markdown

Summary

Add opt-in, single-node multi-tenant SPANN with tenant-isolated indexes, shared
posting storage, node-owned RocksDB recovery/state, checkpoint/replay, and
epoch-protected residency/eviction.

  • Support RocksDB, FILEIO and TiKV postings through a common posting interface.
  • Add server/socket and Python client tenant create, insert, search and deletion APIs,
    plus offline tenanttool administration and reproducible workload harnesses.
  • Repair TiKV per-RPC timeout semantics, bounded batch retries, routing reuse and
    request-buffer/completion ownership.
  • Add configurable automatic checkpoints and pressure-based write admission.
  • Include a standalone multi-tenant quick start
    and configuration/recovery design.

MULTITENANT defaults to OFF; enabling it automatically enables the RocksDB
build dependency even for FILEIO/TiKV postings. TiKV remains separately optional.
Client-only builds can address a remote tenant-enabled server without a local manager.

Automatic checkpoints default to 1 GiB of retained recovery-record key/value bytes,
a 300-second minimum interval, and a 4 GiB pressure trigger that bypasses the
cooldown and holds new insert/delete admission. Covered logs are deleted only
after checkpoint publication; failures fence the node and wake waiting writers.

A directly coupled native STATIC save/reload null-checkpoint dereference is also
fixed. Optional generic heap/worker/buffer tuning and large benchmark artifacts
are deliberately excluded.

Validation

Configuration / check Result
MULTITENANT=ON, TIKV=ON: real RocksDB/FILEIO/TiKV tenant/backend suite 65 cases, 8,793 assertions passed
TiKV client regressions 7 cases, 144 assertions passed
MULTITENANT=ON, TIKV=OFF: selected local suite 48 cases, 5,841 assertions passed
Real CLI/Python/socket/configuration/ownership/crash-recovery smoke Passed
Feature-OFF Python SDK/examples 8 tests passed
Feature-OFF native FILEIO postings with RocksDB WAL, save/load/search Passed
Standalone quick-start runtime blocks with RocksDB and FILEIO Passed, including insertion/deletion persistence after server restart
Documentation, whitespace and checkpoint C++ formatting Passed

Feature-OFF builds were checked both with and without RocksDB. Live TiKV tests
used a dedicated temporary cluster; owned processes and temporary data were retired.

Known limitations / review notes

  • The untouched target baseline has three failing ConcurrentHashMapTest cases
    with FOLLY=OFF, TBB=ON: overwrite return values, iterator snapshots after clear,
    and concurrent conditional updates. The same failures were independently
    reproduced using only the unmodified upstream header/tests. They are not fixed
    or suppressed here; this PR does not claim the complete baseline suite or CI is green.
  • Recovery-log thresholds are logical byte counts, not physical disk quotas.
    Already-admitted writes can overshoot; SST/WAL overhead and snapshots require
    separate disk monitoring/headroom. No forced full compaction is added.
  • Tenant identifiers are trusted-caller namespaces, not authentication or authorization.
    TiKV provides distributed posting storage, not distributed tenant ownership or failover.
  • Managed FILEIO/TiKV behavior was validated on Linux; Windows backend behavior
    has not been validated.
  • No new large-scale performance campaign was run for this final PR binary.
    Historical RocksDB layout diagnostics are documented without presenting their
    numbers as measurements of this revision.

Prepared against users/qiazh/pre-merge-tikv-bugfix at
3cf47fdfc4995a254b17c12657bdd7c0abdc7396.

Add tenant-isolated shared posting backends, recovery/state, automatic checkpoints, server/client APIs, offline administration and a runnable quick start. Include FILEIO/TiKV support and TiKV deadline repair; exclude unrelated generic tuning.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
There may be pipelines that require an authorized user to comment /azp run to run.

@microsoft-github-policy-service

Copy link
Copy Markdown
Contributor

Baotong Lu (@baotonglu) 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