From 598a15c814f66d8bbaec47fa71d54de3566504b5 Mon Sep 17 00:00:00 2001 From: Alex Chi Date: Fri, 23 Dec 2022 15:52:09 -0500 Subject: [PATCH] add contents for mdbook Signed-off-by: Alex Chi --- .github/workflows/main.yml | 37 +++++ .github/workflows/pr.yml | 20 +++ LICENSE | 201 ++++++++++++++++++++++++ README.md | 11 ++ mini-lsm-book/src/00-overview.md | 7 + mini-lsm-book/src/01-block.md | 2 + mini-lsm-book/src/02-sst.md | 1 + mini-lsm-book/src/03-engine.md | 1 + mini-lsm-book/src/04-block-cache.md | 1 + mini-lsm-book/src/05-compaction.md | 1 + mini-lsm-book/src/06-recovery.md | 1 + mini-lsm-book/src/07-bloom-filter.md | 1 + mini-lsm-book/src/08-key-compression.md | 1 + mini-lsm-book/src/09-whats-next.md | 1 + mini-lsm-book/src/SUMMARY.md | 16 +- mini-lsm-book/src/chapter_1.md | 1 - rust-toolchain | 1 - rust-toolchain.toml | 4 + xtask/src/main.rs | 72 +++++++-- 19 files changed, 366 insertions(+), 14 deletions(-) create mode 100644 .github/workflows/main.yml create mode 100644 .github/workflows/pr.yml create mode 100644 LICENSE create mode 100644 README.md create mode 100644 mini-lsm-book/src/00-overview.md create mode 100644 mini-lsm-book/src/01-block.md create mode 100644 mini-lsm-book/src/02-sst.md create mode 100644 mini-lsm-book/src/03-engine.md create mode 100644 mini-lsm-book/src/04-block-cache.md create mode 100644 mini-lsm-book/src/05-compaction.md create mode 100644 mini-lsm-book/src/06-recovery.md create mode 100644 mini-lsm-book/src/07-bloom-filter.md create mode 100644 mini-lsm-book/src/08-key-compression.md create mode 100644 mini-lsm-book/src/09-whats-next.md delete mode 100644 mini-lsm-book/src/chapter_1.md delete mode 100644 rust-toolchain create mode 100644 rust-toolchain.toml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..ffcb39e --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,37 @@ +name: CI (Pull Request) + +on: + push: + branches: + - main + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v2 + - uses: actions-rs/toolchain@v1 + - uses: taiki-e/install-action@nextest + - uses: taiki-e/install-action@mdbook + - name: check and build + run: cargo x ci + - uses: actions/upload-pages-artifact@v1 + with: + path: mini-lsm-book/book + + deploy: + needs: build + permissions: + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-22.04 + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v1 diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml new file mode 100644 index 0000000..0a43b8f --- /dev/null +++ b/.github/workflows/pr.yml @@ -0,0 +1,20 @@ +name: CI (Pull Request) + +on: + pull_request: + branches: + - main + +env: + CARGO_TERM_COLOR: always + +jobs: + build: + runs-on: ubuntu-22.04 + steps: + - uses: actions/checkout@v2 + - uses: actions-rs/toolchain@v1 + - uses: taiki-e/install-action@nextest + - uses: taiki-e/install-action@mdbook + - name: check and build + run: cargo x ci diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, 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 + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..87cf70b --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# LSM in a Week + +Build a simple key-value storage engine in a week! + +## Development + +``` +cargo x install-tools +cargo x check +cargo x book +``` diff --git a/mini-lsm-book/src/00-overview.md b/mini-lsm-book/src/00-overview.md new file mode 100644 index 0000000..56a407f --- /dev/null +++ b/mini-lsm-book/src/00-overview.md @@ -0,0 +1,7 @@ +# Overview + +In this tutorial, you will learn how to build a simple LSM-Tree storage engine in the Rust programming language. + +## What is LSM, and Why LSM? + +## Roadmap diff --git a/mini-lsm-book/src/01-block.md b/mini-lsm-book/src/01-block.md new file mode 100644 index 0000000..a629280 --- /dev/null +++ b/mini-lsm-book/src/01-block.md @@ -0,0 +1,2 @@ +# Block Builder and Block Iterator + diff --git a/mini-lsm-book/src/02-sst.md b/mini-lsm-book/src/02-sst.md new file mode 100644 index 0000000..6d6e1de --- /dev/null +++ b/mini-lsm-book/src/02-sst.md @@ -0,0 +1 @@ +# SST Builder and SST Iterator diff --git a/mini-lsm-book/src/03-engine.md b/mini-lsm-book/src/03-engine.md new file mode 100644 index 0000000..ad43513 --- /dev/null +++ b/mini-lsm-book/src/03-engine.md @@ -0,0 +1 @@ +# Mem Table and Storage Engine diff --git a/mini-lsm-book/src/04-block-cache.md b/mini-lsm-book/src/04-block-cache.md new file mode 100644 index 0000000..a47c9bf --- /dev/null +++ b/mini-lsm-book/src/04-block-cache.md @@ -0,0 +1 @@ +# Block Cache diff --git a/mini-lsm-book/src/05-compaction.md b/mini-lsm-book/src/05-compaction.md new file mode 100644 index 0000000..6e6892f --- /dev/null +++ b/mini-lsm-book/src/05-compaction.md @@ -0,0 +1 @@ +# Leveled Compaction diff --git a/mini-lsm-book/src/06-recovery.md b/mini-lsm-book/src/06-recovery.md new file mode 100644 index 0000000..af085ec --- /dev/null +++ b/mini-lsm-book/src/06-recovery.md @@ -0,0 +1 @@ +# Write-Ahead Log for Recovery diff --git a/mini-lsm-book/src/07-bloom-filter.md b/mini-lsm-book/src/07-bloom-filter.md new file mode 100644 index 0000000..c48ca57 --- /dev/null +++ b/mini-lsm-book/src/07-bloom-filter.md @@ -0,0 +1 @@ +# Bloom Filters diff --git a/mini-lsm-book/src/08-key-compression.md b/mini-lsm-book/src/08-key-compression.md new file mode 100644 index 0000000..65b3f02 --- /dev/null +++ b/mini-lsm-book/src/08-key-compression.md @@ -0,0 +1 @@ +# Key Compression diff --git a/mini-lsm-book/src/09-whats-next.md b/mini-lsm-book/src/09-whats-next.md new file mode 100644 index 0000000..6e3eb22 --- /dev/null +++ b/mini-lsm-book/src/09-whats-next.md @@ -0,0 +1 @@ +# What's Next diff --git a/mini-lsm-book/src/SUMMARY.md b/mini-lsm-book/src/SUMMARY.md index 7390c82..73e25be 100644 --- a/mini-lsm-book/src/SUMMARY.md +++ b/mini-lsm-book/src/SUMMARY.md @@ -1,3 +1,15 @@ -# Summary +# LSM in a Week -- [Chapter 1](./chapter_1.md) +[Overview](./00-overview.md) + +--- + +- [Store key-value pairs in little blocks](./01-block.md) +- [And make them into an SST](./02-sst.md) +- [Now it's time for a storage engine](./03-engine.md) +- [Block cache, the good way](./04-block-cache.md) +- [Let's do something in the background](./05-compaction.md) +- [Be careful when the system crashes](./06-recovery.md) +- [A good bloom filter makes life easier](./07-bloom-filter.md) +- [Save some space, hopefully](./08-key-compression.md) +- [What's next](./09-whats-next.md) diff --git a/mini-lsm-book/src/chapter_1.md b/mini-lsm-book/src/chapter_1.md deleted file mode 100644 index b743fda..0000000 --- a/mini-lsm-book/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/rust-toolchain b/rust-toolchain deleted file mode 100644 index 8483d9f..0000000 --- a/rust-toolchain +++ /dev/null @@ -1 +0,0 @@ -nightly-2022-11-11 diff --git a/rust-toolchain.toml b/rust-toolchain.toml new file mode 100644 index 0000000..f9af1a4 --- /dev/null +++ b/rust-toolchain.toml @@ -0,0 +1,4 @@ +[toolchain] +channel = "1.66" +components = [ "rustfmt", "clippy" ] +profile = "minimal" diff --git a/xtask/src/main.rs b/xtask/src/main.rs index 1e6808a..ad53f8f 100644 --- a/xtask/src/main.rs +++ b/xtask/src/main.rs @@ -9,10 +9,14 @@ use duct::cmd; enum Action { /// Check. Check, + /// Build and serve book. + Book, /// Install necessary tools for development. InstallTools, /// Show environment variables. Show, + /// Run CI jobs + Ci, } /// Simple program to greet a person @@ -32,6 +36,48 @@ fn switch_to_workspace_root() -> Result<()> { Ok(()) } +fn fmt() -> Result<()> { + println!("{}", style("cargo fmt").bold()); + cmd!("cargo", "fmt").run()?; + Ok(()) +} + +fn check_fmt() -> Result<()> { + println!("{}", style("cargo fmt --check").bold()); + cmd!("cargo", "fmt", "--check").run()?; + Ok(()) +} + +fn check() -> Result<()> { + println!("{}", style("cargo check").bold()); + cmd!("cargo", "check", "--all-targets").run()?; + Ok(()) +} + +fn test() -> Result<()> { + println!("{}", style("cargo nextest run").bold()); + cmd!("cargo", "nextest", "run").run()?; + Ok(()) +} + +fn clippy() -> Result<()> { + println!("{}", style("cargo clippy").bold()); + cmd!("cargo", "clippy", "--all-targets").run()?; + Ok(()) +} + +fn build_book() -> Result<()> { + println!("{}", style("mdbook build").bold()); + cmd!("mdbook", "build").dir("mini-lsm-book").run()?; + Ok(()) +} + +fn serve_book() -> Result<()> { + println!("{}", style("mdbook serve").bold()); + cmd!("mdbook", "serve").dir("mini-lsm-book").run()?; + Ok(()) +} + fn main() -> Result<()> { let args = Args::parse(); @@ -44,16 +90,22 @@ fn main() -> Result<()> { } Action::Check => { switch_to_workspace_root()?; - println!("{}", style("cargo fmt").bold()); - cmd!("cargo", "fmt").run()?; - println!("{}", style("cargo check").bold()); - cmd!("cargo", "check", "--all-targets").run()?; - println!("{}", style("cargo nextest run").bold()); - cmd!("cargo", "nextest", "run").run()?; - println!("{}", style("cargo clippy").bold()); - cmd!("cargo", "clippy", "--all-targets").run()?; - println!("{}", style("mdbook build").bold()); - cmd!("mdbook", "build").dir("mini-lsm-book").run()?; + fmt()?; + check()?; + test()?; + clippy()?; + } + Action::Book => { + switch_to_workspace_root()?; + serve_book()?; + } + Action::Ci => { + switch_to_workspace_root()?; + check_fmt()?; + check()?; + test()?; + clippy()?; + build_book()?; } Action::Show => { println!("CARGO_MANIFEST_DIR={}", env!("CARGO_MANIFEST_DIR"));