Compare commits

...

45 Commits

Author SHA1 Message Date
Agathe Porte c3c8af9a66 doc: quick-start: rework flag description (#1496)
Add a link to the manual install procedure, use a
quote to make the manual install path more visible
and mention the --default-access-key option.

Closes: #1446

Rendered output:

![image](/attachments/84bbe650-daff-40d1-b4bd-629abece27b0)

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1496
2026-07-25 14:48:53 +00:00
Alex Auvolat ad78b9ee5c CI: revert spurrious changed introduced in #1487 that broke CI for main-v2 (#1499)
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1499
2026-07-25 13:25:17 +00:00
Alex b8e844612d Merge pull request 'Admin API: correctly return aliased buckets for keys even if they have no permissions' (#1498) from fix-aliases-no-perms into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1498
2026-07-25 12:38:23 +00:00
Alex Auvolat aa4e4656b1 GetKeyInfo: properly list locally-aliased buckets even if they have no permissions 2026-07-25 14:24:58 +02:00
Alex Auvolat 5549077d6f GetBucketInfo: properly return keys that have local aliases even if they have no permissions 2026-07-25 14:24:49 +02:00
smattymatty 663fc5ae48 fix(s3): allow UTF-8 in PostObject form field values (fix #1489) (#1492)
PostObject (presigned POST) returns `400 InvalidHeaderValue` when the upload involves a non-ASCII filename. The same key uploads fine vie PUT, as the issue #1489 noted.

The problem was that `handle_post_object` stores the form field values in an `http::HeaderMap`. values go in through `HeaderValue::from_str` but are read back with the strict `HeaderValue::to_str()` (ASCII-only) which fails on any UTF-8 value.

This is the same problem fixed in eab2b81b for `x-amz-meta-*` headers, and the fix is the same:
`std::str::from_utf8(value.as_bytes())` instead of `to_str()`. The `key` field in `post_object.rs` and the standard headers (`content-disposition` etc.) in `extract_metadata_headers`.

Added integration tests for PostObject (there were none): UTF-8 key, `${filename}` substitution, and UTF-8 `Content-Disposition` metadata. The substitution test passes even without the fix, proving that the filename path was never broken, only the form-params round-trip.

Co-authored-by: Mathew Storm <mathew@stormdevelopments.ca>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1492
Reviewed-by: trinity-1686a <trinity-1686a@noreply.localhost>
2026-07-20 18:12:39 +00:00
Agathe Porte 0f89923d2d doc: websites: explain global aliases required (#1494)
Add a note explaining that a globally aliased bucket is
required for successfully exposing it as a website.

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1494
2026-07-20 18:11:15 +00:00
Antonin Delpeuch a1f9c52563 docs: add GOVERNANCE.md (#1493)
Documenting the structure of a team can be helpful to integrate newcomers, avoid some conflicts and to accompany the evolution of that structure as a FOSS project grows.

This is an attempt to do that for garage, after discussions with multiple maintainers. The aim of this text is to document the status quo, offering a start for further incremental updates.
I propose to put it as `GOVERNANCE.md` file because this naming has emerged as a sort of standard in FOSS projects.

I would be happy to help facilitate such updates if there is interest (while being aware that project members have other things on their plates and that governance work can be taxing).

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1493
2026-07-20 18:10:30 +00:00
Agathe Porte ceade99cd7 doc: fix dead link to WinSCP wiki page (#1495)
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1495
2026-07-20 18:08:59 +00:00
Agathe Porte d1333c1729 doc: multi-hdd: refer to rebalance op (#1491)
The rebalance op links to the multi-hdd page, but the multi-hdd page
does not refer to the rebalance op description and only states that an
operator can launch a repair procedure without stating which procedure.

Add a link to the rebalance repair procedure in the multi-hdd page to
make it easier to find what procedure to run for rebalance.

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1491
2026-07-14 21:12:45 +00:00
Andreas Schneider 7e246b20e9 fix: avoid rewriting peer list file when unchanged (#1488)
save_peer_list() ran unconditionally every 60s from the discovery
loop, writing the same data to disk even when the peer set hadn't
changed. Compare the newly encoded peer list against the bytes
already on disk and skip the write when they match.

Fixes #1457

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1488
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-07-14 10:54:33 +00:00
deanqx 936e53fe2f docs: update old "key new" to new "key create" command (#1487)
Fix invalid references to the `garage key new` commands. Mainly on documentation side except one script: `script/dev-bucket.sh`.

This is my first pull request ever. I'm open for feedback, let me know if I should change anything about this PR.

Co-authored-by: deanqx <110404616+deanqx@users.noreply.github.com>
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1487
2026-07-07 10:34:42 +00:00
Alex bbc1dc3d6f Merge pull request 'TypedTree' (#1456) from krtab/garage:typed_tree into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1456
Reviewed-by: Armael <armael@noreply.localhost>
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-06-30 21:04:06 +00:00
Arthur Carcano 7cdcaa8ebe Panic on (reoccuring) decode error 2026-06-30 21:04:06 +00:00
Arthur Carcano 4133476ec9 Add TODO comment for migration to typedtree 2026-06-30 21:04:06 +00:00
Arthur Carcano b277d49ad6 Add more type invariants to RcEntry and new RcState 2026-06-30 21:04:06 +00:00
Arthur Carcano 5a4da29f92 Migrate BlockRc and BlockResyncManager to TypedTree 2026-06-30 21:04:06 +00:00
Arthur Carcano eb91f463f5 Add TypedTree 2026-06-30 21:04:06 +00:00
Alex 22e003f0d0 Merge pull request 'k2v-client: misc fixes' (#1463) from k2v-client-clonable into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1463
2026-06-30 21:02:44 +00:00
Armaël Guéneau 0ebf60f709 k2v-client: re-export crates hyper_rustls and hyper_util 2026-06-30 21:02:44 +00:00
Armaël Guéneau d588a96125 k2v-client: implement Debug for K2vClient 2026-06-30 21:02:44 +00:00
Armaël Guéneau e665a3432c k2v-client: derive Clone for the K2vClient type 2026-06-30 21:02:44 +00:00
Armaël Guéneau 5884b4e9c7 k2v-client: repair build; serializers depend on the serde "std" features 2026-06-30 21:02:44 +00:00
Alex a32621c8fd Merge pull request 'fix(s3): report non-existent keys as deleted in bulk DeleteObjects (fix #1460)' (#1469) from smattymatty/garage:main-v2 into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1469
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-06-17 14:05:14 +00:00
Mathew Storm 8eb7628bf4 test(s3): cover bulk DeleteObjects of a non-existent key 2026-06-17 14:05:14 +00:00
Mathew Storm cd26594673 fix(s3): treat NoSuchKey as success in bulk DeleteObjects 2026-06-17 14:05:14 +00:00
Alex 1b28094f20 Merge pull request 'K2V: provide monotonic reads by default, with a flag to opt-out' (#1452) from Armael/garage:read_repair into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1452
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-06-17 14:00:13 +00:00
Armaël Guéneau 4f9faeb282 minor fixes 2026-06-17 14:00:13 +00:00
Armaël Guéneau 3c7990027a K2V: update docs to add read monotonicity guarantees & flags 2026-06-17 14:00:13 +00:00
Armaël Guéneau a159c1c483 add missing repair-on-read for k2v range reads 2026-06-17 14:00:13 +00:00
Armaël Guéneau 555e0826a2 define a separate enum for the monotonic/non-monotonic read flag 2026-06-17 14:00:13 +00:00
Armaël Guéneau d0f89068c6 repair_on_read: send multiple items to update in a single RPC 2026-06-17 14:00:13 +00:00
Armaël Guéneau 3e25914210 K2V: provide monotonic reads by default, with a flag to opt-out
This performs synchronous repair-on-read for K2V reads:
- uses the new get_*_monotonic operations in the table module
- implements repair-on-read for the K2V-specific poll operations
2026-06-17 14:00:13 +00:00
Armaël Guéneau 5500f1c412 table: disable asynchronous repair-on-read; add get_*_monotonic functions for synchronous repair-on-read 2026-06-17 14:00:13 +00:00
Armaël Guéneau 2d7c0a6087 table: also apply repair-on-read the first time a value is set 2026-06-17 14:00:13 +00:00
Wesley Hershberger 76aae3cb96 Drop parse_duration for fundu-systemd (#1246) (#1468)
`parse_duration` is no longer maintained upstream; `fundu-system` seems like the best option to provide most of the functionality provided by parse_duration and minimize deps.

Fixes #1246

Dep diffstat: +3 -6

## Caveats
- I've done basically no testing of this PR beyond `cargo test`
- See my comment in #1246 for regression risk; this is a breaking change. Is there a document I should update to make note of this? Should I rebase this for `next-v3` instead?
- In theory CVE-2021-29932 is fixed by this PR as `fundu-systemd` doesn't support exponents, but I've done no verification that this is really the case beyond the info in #1246

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1468
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-06-17 13:57:21 +00:00
jo 1d1456f1d6 Add details to read file errors (#1475)
If the files configured in `api_token_file` or `rpc_secret_file` are not found, garage exits with no details (at least not enough) of what went wrong:

    2026-06-14T23:40:34.517429Z  INFO garage::server: Loading configuration from tmp/config1.toml...
    Error: IO error: No such file or directory (os error 2)

This add the kind of file and the file path being read, to the returned error message:

    2026-06-14T23:41:41.136213Z  INFO garage::server: Loading configuration from tmp/config1.toml...
    Error: Failed to read secret file /run/secrets/rpc_secret: No such file or directory (os error 2)

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1475
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-06-17 13:53:43 +00:00
maximilien a379406522 Merge pull request 'fix reflected xss when returning errors on web endpoint' (#1471) from escape-errors into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1471
2026-06-11 06:50:52 +00:00
trinity-1686a da568cf56f fix reflected xss when returning errors on web endpoint
Reported by Filippo Decortes from ares-cyber.ai
2026-06-10 19:44:27 +02:00
Dave St.Germain 2bde733e09 fix: enable compilation on OpenBSD by removing keepalive interval (fix #1413) (#1453)
This fixes #1413 by conditionally compiling the section that sets a keepalive interval, which isn't supported on OpenBSD.

Tested on OpenBSD 7.8

Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1453
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-05-14 15:17:20 +00:00
Alex 91573eb028 Merge pull request 'replace Crdt impl on Option by explicit CancelingOption and MergingOption types' (#1451) from option-crdt into main-v2
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1451
2026-05-13 09:56:29 +00:00
Alex Auvolat a646180d7e fix fuzz targets 2026-05-13 11:47:57 +02:00
Alex Auvolat bacc6c98b2 replace expiration field with custom type that merges to min value 2026-05-13 11:20:10 +02:00
Alex Auvolat bf0a24ea69 replace Option CRDT by explicit CancelingOption and MergingOption types 2026-05-13 11:20:06 +02:00
Arthur Carcano eb37a3e11a Fuzzing for K2VItem Crdt (#1438)
Reviewed-on: https://git.deuxfleurs.fr/Deuxfleurs/garage/pulls/1438
Reviewed-by: Alex <lx@deuxfleurs.fr>
2026-05-12 14:44:54 +00:00
85 changed files with 1898 additions and 789 deletions
Generated
+43 -71
View File
@@ -1399,6 +1399,30 @@ dependencies = [
name = "format_table" name = "format_table"
version = "0.1.1" version = "0.1.1"
[[package]]
name = "fundu"
version = "2.0.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2ce12752fc64f35be3d53e0a57017cd30970f0cffd73f62c791837d8845badbd"
dependencies = [
"fundu-core",
]
[[package]]
name = "fundu-core"
version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e463452e2d8b7600d38dcea1ed819773a57f0d710691bfc78db3961bd3f4c3ba"
[[package]]
name = "fundu-systemd"
version = "0.3.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b8641ae8f534f853a552beb3a9f12cc72fd1343260964af82cf09fda66e3d94e"
dependencies = [
"fundu",
]
[[package]] [[package]]
name = "futures" name = "futures"
version = "0.3.32" version = "0.3.32"
@@ -1502,6 +1526,7 @@ dependencies = [
"chrono", "chrono",
"crc-fast", "crc-fast",
"format_table", "format_table",
"fundu-systemd",
"futures", "futures",
"garage_api_admin", "garage_api_admin",
"garage_api_common", "garage_api_common",
@@ -1528,7 +1553,6 @@ dependencies = [
"opentelemetry", "opentelemetry",
"opentelemetry-otlp", "opentelemetry-otlp",
"opentelemetry-prometheus", "opentelemetry-prometheus",
"parse_duration",
"serde_json", "serde_json",
"sha1 0.10.6", "sha1 0.10.6",
"sha2 0.10.9", "sha2 0.10.9",
@@ -1749,7 +1773,6 @@ dependencies = [
"garage_util", "garage_util",
"hex", "hex",
"http 1.4.0", "http 1.4.0",
"parse_duration",
"rand 0.9.4", "rand 0.9.4",
"serde", "serde",
"serde_bytes", "serde_bytes",
@@ -1849,6 +1872,8 @@ dependencies = [
"blake2", "blake2",
"bytesize", "bytesize",
"chrono", "chrono",
"fundu",
"fundu-systemd",
"futures", "futures",
"garage_db", "garage_db",
"garage_net", "garage_net",
@@ -1881,6 +1906,7 @@ dependencies = [
"garage_model", "garage_model",
"garage_table", "garage_table",
"garage_util", "garage_util",
"html-escape",
"http 1.4.0", "http 1.4.0",
"http-body-util", "http-body-util",
"hyper 1.9.0", "hyper 1.9.0",
@@ -2194,6 +2220,15 @@ dependencies = [
"windows-link", "windows-link",
] ]
[[package]]
name = "html-escape"
version = "0.2.13"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "6d1ad449764d627e22bfd7cd5e8868264fc9236e07c752972b4080cd351cb476"
dependencies = [
"utf8-width",
]
[[package]] [[package]]
name = "http" name = "http"
version = "0.2.12" version = "0.2.12"
@@ -3213,41 +3248,6 @@ dependencies = [
"windows-sys 0.61.2", "windows-sys 0.61.2",
] ]
[[package]]
name = "num"
version = "0.2.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b8536030f9fea7127f841b45bb6243b27255787fb4eb83958aa1ef9d2fdc0c36"
dependencies = [
"num-bigint",
"num-complex",
"num-integer",
"num-iter",
"num-rational",
"num-traits",
]
[[package]]
name = "num-bigint"
version = "0.2.6"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "090c7f9998ee0ff65aa5b723e4009f7b217707f1fb5ea551329cc4d6231fb304"
dependencies = [
"autocfg",
"num-integer",
"num-traits",
]
[[package]]
name = "num-complex"
version = "0.2.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "b6b19411a9719e753aff12e5187b74d60d3dc449ec3f4dc21e3989c3f554bc95"
dependencies = [
"autocfg",
"num-traits",
]
[[package]] [[package]]
name = "num-conv" name = "num-conv"
version = "0.2.1" version = "0.2.1"
@@ -3263,29 +3263,6 @@ dependencies = [
"num-traits", "num-traits",
] ]
[[package]]
name = "num-iter"
version = "0.1.45"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1429034a0490724d0075ebb2bc9e875d6503c3cf69e235a8941aa757d83ef5bf"
dependencies = [
"autocfg",
"num-integer",
"num-traits",
]
[[package]]
name = "num-rational"
version = "0.2.4"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "5c000134b5dbf44adc5cb772486d335293351644b801551abe8f75c84cfa4aef"
dependencies = [
"autocfg",
"num-bigint",
"num-integer",
"num-traits",
]
[[package]] [[package]]
name = "num-traits" name = "num-traits"
version = "0.2.19" version = "0.2.19"
@@ -3454,17 +3431,6 @@ dependencies = [
"windows-link", "windows-link",
] ]
[[package]]
name = "parse_duration"
version = "2.1.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "7037e5e93e0172a5a96874380bf73bc6ecef022e26fa25f2be26864d6b3ba95d"
dependencies = [
"lazy_static",
"num",
"regex",
]
[[package]] [[package]]
name = "password-hash" name = "password-hash"
version = "0.5.0" version = "0.5.0"
@@ -5328,6 +5294,12 @@ dependencies = [
"serde", "serde",
] ]
[[package]]
name = "utf8-width"
version = "0.1.8"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "1292c0d970b54115d14f2492fe0170adf21d68a1de108eebc51c1df4f346a091"
[[package]] [[package]]
name = "utf8_iter" name = "utf8_iter"
version = "1.0.4" version = "1.0.4"
+3 -1
View File
@@ -53,10 +53,13 @@ cfg-if = "1.0"
chrono = { version = "0.4", features = ["serde"] } chrono = { version = "0.4", features = ["serde"] }
crc-fast = "1.9" crc-fast = "1.9"
crypto-common = "0.1" crypto-common = "0.1"
fundu = "2.0"
fundu-systemd = "0.3"
gethostname = "1.1" gethostname = "1.1"
git-version = "0.3" git-version = "0.3"
hex = "0.4" hex = "0.4"
hexdump = "0.1" hexdump = "0.1"
html-escape = "0.2.13"
hmac = "0.12" hmac = "0.12"
itertools = "0.14" itertools = "0.14"
ipnet = "2.11" ipnet = "2.11"
@@ -67,7 +70,6 @@ mktemp = "0.5"
nix = { version = "0.31", default-features = false, features = ["fs"] } nix = { version = "0.31", default-features = false, features = ["fs"] }
nom = "8.0" nom = "8.0"
parking_lot = "0.12" parking_lot = "0.12"
parse_duration = "2.1"
paste = "1.0" paste = "1.0"
pin-project = "1.1" pin-project = "1.1"
pnet_datalink = "0.35" pnet_datalink = "0.35"
+45
View File
@@ -0,0 +1,45 @@
# Governance of Gararge
This documents how the Garage project operates. It reflects the state of the project as of July 2026 and is not optimal. The team is interested to improve it in the future.
## Team organization
* **Contributors**: anyone can contribute by proposing changes in issues and pull requests.
* **Maintainers**: they are responsible for reviewing, merging pull requests, publishing releases and triaging issues.
The current maintainers are:
* Alex (handle `lx`)
* Trinity (handle `trinity-1686a`)
* Quentin (handle `quentin`)
* Maximilien (handle `halfa`), who is in particular responsible for coordinating effort on the Kubernetes integration / Helm chart.
They are added to a white-list of the branch protection rule of the repository to enable them to merge pull requests.
To become a maintainer, you need to be a long-term contributor and earn the personal trust of Alex.
There is no set process for leaving the maintainer role.
* **Lead developer**: Alex (handle `lx`) is the lead developer and is responsible of ensuring the
correctness of Garage and stability between version upgrades. He may transfer this role to someone else as he sees fit.
## Communication channels
The team coordinates in the following channels:
* The issue tracker and pull requests of the official repository.
* The `#garage:deuxfleurs.fr` matrix channel (in English), open to anyone.
On this channel, users may ask for support and discussions about development also happen.
* The `#garage-dev:deuxfleurs.fr` matrix channel (in French), not advertised to contributors but de facto accessible to anyone.
Discussions about development and project coordination happen there.
The moderators for those discussion channels are the Garage maintainers.
## Decision procedures
Decisions are taken by lazy consensus, with the lead developer settling discussions when a consensus cannot be reached.
## Governance changes
There is no set process for changing the governance of garage.
## See also
* [Project goals](https://garagehq.deuxfleurs.fr/documentation/design/goals/)
* [Contributing instructions](https://git.deuxfleurs.fr/Deuxfleurs/garage/src/branch/main-v2/CONTRIBUTING.md)
+3 -3
View File
@@ -547,7 +547,7 @@ ejabberdctl module_install mod_s3_upload
Create the required key and bucket with: Create the required key and bucket with:
```bash ```bash
garage key new --name ejabberd garage key create ejabberd
garage bucket create objects.xmpp-server.fr garage bucket create objects.xmpp-server.fr
garage bucket allow objects.xmpp-server.fr --read --write --key ejabberd garage bucket allow objects.xmpp-server.fr --read --write --key ejabberd
garage bucket website --allow objects.xmpp-server.fr garage bucket website --allow objects.xmpp-server.fr
@@ -678,7 +678,7 @@ For more information on deployment you can check the [ente documentation](https:
This is the usual Garage setup: This is the usual Garage setup:
```bash ```bash
garage key new --name pleroma-key garage key create pleroma-key
garage bucket create pleroma garage bucket create pleroma
garage bucket allow pleroma --read --write --owner --key pleroma-key garage bucket allow pleroma --read --write --owner --key pleroma-key
``` ```
@@ -759,7 +759,7 @@ This feature requires `pict-rs >= 4.0.0`.
This is the usual Garage setup: This is the usual Garage setup:
```bash ```bash
garage key new --name pictrs-key garage key create pictrs-key
garage bucket create pictrs-data garage bucket create pictrs-data
garage bucket allow pictrs-data --read --write --key pictrs-key garage bucket allow pictrs-data --read --write --key pictrs-key
``` ```
+1 -1
View File
@@ -22,7 +22,7 @@ Note that `git-annex` requires to be compiled with Haskell package version
`aws-0.24` to work with Garage. `aws-0.24` to work with Garage.
```bash ```bash
garage key new --name my-key garage key create my-key
garage bucket create my-git-annex garage bucket create my-git-annex
garage bucket allow my-git-annex --read --write --key my-key garage bucket allow my-git-annex --read --write --key my-key
``` ```
+1 -1
View File
@@ -268,7 +268,7 @@ duck --delete garage:/my-files/an-object.txt
## WinSCP (libs3) {#winscp} ## WinSCP (libs3) {#winscp}
*You can find instructions on how to use the GUI in french [in our wiki](https://guide.deuxfleurs.fr/prise_en_main/winscp/).* *You can find instructions on how to use the GUI in french [in our wiki](https://guide.deuxfleurs.fr/services/winscp/).*
How to use `winscp.com`, the CLI interface of WinSCP: How to use `winscp.com`, the CLI interface of WinSCP:
+1 -1
View File
@@ -27,7 +27,7 @@ which support storing metrics in an object store:
This can be configured with Garage with the following: This can be configured with Garage with the following:
```bash ```bash
garage key new --name vector-system-logs garage key create vector-system-logs
garage bucket create system-logs garage bucket create system-logs
garage bucket allow system-logs --read --write --key vector-system-logs garage bucket allow system-logs --read --write --key vector-system-logs
``` ```
+7
View File
@@ -25,6 +25,13 @@ garage bucket website --allow my-website
Now it will be **publicly** exposed on the web endpoint (by default listening on port 3902). Now it will be **publicly** exposed on the web endpoint (by default listening on port 3902).
> The bucket needs to have a *global alias* to be exposed as a website. If the
> bucket was created with `garage bucket create` it will have an alias;
> if created via the S3 API [you will have to manually add the alias
> ](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/742) first.
> Creating globally aliased buckets from the S3 API is [currently under
> discussion](https://git.deuxfleurs.fr/Deuxfleurs/garage/issues/649).
## How exposed websites work ## How exposed websites work
Our website serving logic is as follow: Our website serving logic is as follow:
+1 -1
View File
@@ -91,7 +91,7 @@ is definitely lost, then there is no other choice than to declare your S3 object
as unrecoverable, and to delete them properly from the data store. This can be done as unrecoverable, and to delete them properly from the data store. This can be done
using the `garage block purge` command. using the `garage block purge` command.
## Rebalancing data directories ## Rebalancing data directories {#rebalance}
In [multi-HDD setups](@/documentation/operations/multi-hdd.md), to ensure that In [multi-HDD setups](@/documentation/operations/multi-hdd.md), to ensure that
data blocks are well balanced between storage locations, you may run a data blocks are well balanced between storage locations, you may run a
+5 -4
View File
@@ -68,10 +68,11 @@ To rebalance data, two strategies can be used:
secondary directory. This might never end up rebalancing everything if there secondary directory. This might never end up rebalancing everything if there
are data blocks that are only read and never written. are data blocks that are only read and never written.
- Active rebalancing: an operator of a Garage node can explicitly launch a repair - Active rebalancing: an operator of a Garage node can [explicitly launch a
procedure that rebalances the data directories, moving all blocks to their repair procedure](@/documentation/operations/durability-repairs.md#rebalance)
primary location. Once done, all secondary locations for all hash slices are that rebalances the data directories, moving all blocks to their primary
removed so that they won't be checked anymore when looking for a data block. location. Once done, all secondary locations for all hash slices are removed
so that they won't be checked anymore when looking for a data block.
## Read-only storage locations ## Read-only storage locations
+11 -6
View File
@@ -133,12 +133,17 @@ Use the following command to launch the Garage server:
garage server --single-node --default-bucket garage server --single-node --default-bucket
``` ```
The `--single-node` flag instructs Garage to automatically configure a single-node cluster without data replication. - the `--single-node` flag instructs Garage to automatically configure a
The `--default-bucket` flag instructs Garage to create a default access key and a default bucket using the environment variables we defined above. single-node cluster without data replication;
Both flags are optional and can be omitted, in which case you will have to follow manual configuration steps described below. - the `--default-bucket` flag instructs Garage to create a default access key
and a default bucket using the environment variables we defined above (it
implies `--default-access-key`).
**For older versions of Garage (before v2.3.0):** automatic configuration using `--single-node` and `--default-bucket` is not available, > You can refer to the [manual configuration
you must follow the manual configuration steps. > steps](#manual-configuration) if:
>
> - you decide to no use these optional flags;
> - you are running an **older version of Garage (before v2.3.0)**.
Alternatively, if you cannot or do not wish to run the Garage binary directly, Alternatively, if you cannot or do not wish to run the Garage binary directly,
you may use Docker to run Garage in a container using the following command: you may use Docker to run Garage in a container using the following command:
@@ -292,7 +297,7 @@ An exhaustive list is maintained in the ["Integrations" > "Browsing tools" secti
## Manual configuration ## Manual configuration {#manual-configuration}
This section provides instructions that are equivalent to using the This section provides instructions that are equivalent to using the
`--single-node` and `--default-bucket` flags for automatic configuration. If `--single-node` and `--default-bucket` flags for automatic configuration. If
+1 -1
View File
@@ -448,7 +448,7 @@ If this value is set, Garage will automatically take a snapshot of the metadata
DB file at a regular interval and save it in the metadata directory, DB file at a regular interval and save it in the metadata directory,
or in [`metadata_snapshots_dir`](#metadata_snapshots_dir) if it is set. or in [`metadata_snapshots_dir`](#metadata_snapshots_dir) if it is set.
This parameter can take any duration string that can be parsed by This parameter can take any duration string that can be parsed by
the [`parse_duration`](https://docs.rs/parse_duration/latest/parse_duration/#syntax) crate. the [`fundu_systemd`](https://docs.rs/fundu-systemd) crate.
Snapshots can allow to recover from situations where the metadata DB file is Snapshots can allow to recover from situations where the metadata DB file is
corrupted, for instance after an unclean shutdown. See [this corrupted, for instance after an unclean shutdown. See [this
+47
View File
@@ -166,6 +166,25 @@ that map to zeroes. Note that we need to filter out values from nodes that are
no longer part of the cluster layout, as when nodes are removed they won't no longer part of the cluster layout, as when nodes are removed they won't
necessarily have had the time to set their counters to zero. necessarily have had the time to set their counters to zero.
### Consistency guarantees
K2V provides the following consistency guarantees:
**Read after Write**. After a write has been acknowledged (the request returned
successfully), a subsequent read is guaranteed to contain the value that was
written.
**Monotonic Reads**. Two sequential reads will return values in an order that is
consistent with the order in which they are written (e.g. by concurrent writes).
For example, consider a scenario where a value is set initially set to 0 and a
request writing 1 is performed. Doing two subsequent reads concurrently with the
write is guaranteed to return either `0`, `0` or `0`,`1` or `1`,`1`, but not
`1`,`0`.
It is also possible to perform non-monotonic reads (allowing this last
behavior), which are slightly faster than monotonic reads. This is done by
passing a dedicated flag to read operations (see the endpoints documentation).
## Important details ## Important details
**THIS SECTION CONTAINS A FEW WARNINGS ON THE K2V API WHICH ARE IMPORTANT **THIS SECTION CONTAINS A FEW WARNINGS ON THE K2V API WHICH ARE IMPORTANT
@@ -210,6 +229,12 @@ Query parameters:
|------------|---------------|----------------------------------| |------------|---------------|----------------------------------|
| `sort_key` | **mandatory** | The sort key of the item to read | | `sort_key` | **mandatory** | The sort key of the item to read |
Headers:
| name | default value | meaning |
|-------------------------------|---------------|------------------------------------------|
| `X-Garage-Non-Monotonic-Read` | `false` | Whether to allow for non-monotonic reads |
Returns the item with specified partition key and sort key. Values can be Returns the item with specified partition key and sort key. Values can be
returned in either of two ways: returned in either of two ways:
@@ -325,6 +350,12 @@ Query parameters:
The timeout can be set to any number of seconds, with a maximum of 600 seconds (10 minutes). The timeout can be set to any number of seconds, with a maximum of 600 seconds (10 minutes).
Headers:
| name | default value | meaning |
|-------------------------------|---------------|------------------------------------------|
| `X-Garage-Non-Monotonic-Read` | `false` | Whether to allow for non-monotonic reads |
**InsertItem: `PUT /<bucket>/<partition key>?sort_key=<sort_key>`** **InsertItem: `PUT /<bucket>/<partition key>?sort_key=<sort_key>`**
@@ -521,6 +552,14 @@ HTTP/1.1 204 NO CONTENT
Batch read of triplets in a bucket. Batch read of triplets in a bucket.
Headers:
| name | default value | meaning |
|-------------------------------|---------------|------------------------------------------|
| `X-Garage-Non-Monotonic-Read` | `false` | Whether to allow for non-monotonic reads |
Body:
The request body is a JSON list of searches, that each specify a range of The request body is a JSON list of searches, that each specify a range of
items to get (to get single items, set `singleItem` to `true`). A search is a items to get (to get single items, set `singleItem` to `true`). A search is a
JSON struct with the following fields: JSON struct with the following fields:
@@ -711,6 +750,14 @@ HTTP/1.1 200 OK
Polls a range of items for changes. Polls a range of items for changes.
Headers:
| name | default value | meaning |
|-------------------------------|---------------|------------------------------------------|
| `X-Garage-Non-Monotonic-Read` | `false` | Whether to allow for non-monotonic reads |
Body:
The query body is a JSON object consisting of the following fields: The query body is a JSON object consisting of the following fields:
| name | default value | meaning | | name | default value | meaning |
+8 -1
View File
@@ -14,7 +14,7 @@ libfuzzer-sys = { workspace = true }
garage_db.workspace = true garage_db.workspace = true
garage_table.workspace = true garage_table.workspace = true
garage_util.workspace = true garage_util.workspace = true
garage_model = { workspace = true, default-features = false, features = ["arbitrary"] } garage_model = { workspace = true, default-features = false, features = ["arbitrary", "k2v"] }
[[bin]] [[bin]]
name = "version_crdt" name = "version_crdt"
@@ -64,3 +64,10 @@ path = "fuzz_targets/bucket_alias_crdt.rs"
test = false test = false
doc = false doc = false
bench = false bench = false
[[bin]]
name = "k2v_item_crdt"
path = "fuzz_targets/k2v_item_crdt.rs"
test = false
doc = false
bench = false
+2 -1
View File
@@ -2,13 +2,14 @@
use garage_fuzz::check_crdt_laws; use garage_fuzz::check_crdt_laws;
use garage_model::admin_token_table::{AdminApiToken, AdminApiTokenParams, AdminApiTokenScope}; use garage_model::admin_token_table::{AdminApiToken, AdminApiTokenParams, AdminApiTokenScope};
use garage_model::permission::ExpirationTime;
use garage_util::crdt; use garage_util::crdt;
use libfuzzer_sys::fuzz_target; use libfuzzer_sys::fuzz_target;
type Input = ( type Input = (
bool, bool,
crdt::Lww<String>, crdt::Lww<String>,
crdt::Lww<Option<u64>>, crdt::Lww<crdt::MergingOption<ExpirationTime>>,
crdt::Lww<AdminApiTokenScope>, crdt::Lww<AdminApiTokenScope>,
); );
+36
View File
@@ -0,0 +1,36 @@
#![no_main]
use std::collections::BTreeMap;
use garage_fuzz::check_crdt_laws;
use garage_model::k2v::item_table::{DvvsEntry, DvvsValue, K2VItem};
use libfuzzer_sys::fuzz_target;
// Timestamps are encoded as `(ts << 32) | shift` so that items built with different
// shifts (0, 1, 2) have disjoint timestamp spaces that still interleave in the sorted merge.
fn make(raw: BTreeMap<u64, (u32, BTreeMap<u32, DvvsValue>)>, shift: u32) -> K2VItem {
let shift = shift as u64;
let items = raw
.into_iter()
.map(|(node, (t_discard, values))| {
let entry = DvvsEntry::from_raw(
(t_discard as u64) << 32 | shift,
values
.into_iter()
.map(|(ts, v)| ((ts as u64) << 32 | shift, v))
.collect(),
);
(node, entry)
})
.collect();
K2VItem::with_raw_items(items)
}
fuzz_target!(|inputs: (
BTreeMap<u64, (u32, BTreeMap<u32, DvvsValue>)>,
BTreeMap<u64, (u32, BTreeMap<u32, DvvsValue>)>,
BTreeMap<u64, (u32, BTreeMap<u32, DvvsValue>)>,
)| {
let (a, b, c) = inputs;
check_crdt_laws(make(a, 0), make(b, 1), make(c, 2));
});
+3 -3
View File
@@ -2,7 +2,7 @@
use garage_fuzz::check_crdt_laws; use garage_fuzz::check_crdt_laws;
use garage_model::key_table::{Key, KeyParams}; use garage_model::key_table::{Key, KeyParams};
use garage_model::permission::BucketKeyPerm; use garage_model::permission::{BucketKeyPerm, ExpirationTime};
use garage_util::crdt; use garage_util::crdt;
use garage_util::data::Uuid; use garage_util::data::Uuid;
use libfuzzer_sys::fuzz_target; use libfuzzer_sys::fuzz_target;
@@ -10,10 +10,10 @@ use libfuzzer_sys::fuzz_target;
type Input = ( type Input = (
bool, bool,
crdt::Lww<String>, crdt::Lww<String>,
crdt::Lww<Option<u64>>, crdt::Lww<crdt::MergingOption<ExpirationTime>>,
crdt::Lww<bool>, crdt::Lww<bool>,
crdt::Map<Uuid, BucketKeyPerm>, crdt::Map<Uuid, BucketKeyPerm>,
crdt::LwwMap<String, Option<Uuid>>, crdt::LwwMap<String, crdt::CancelingOption<Uuid>>,
); );
fn make(input: Input) -> Key { fn make(input: Input) -> Key {
+5 -4
View File
@@ -7,6 +7,7 @@ use garage_util::time::now_msec;
use garage_model::admin_token_table::*; use garage_model::admin_token_table::*;
use garage_model::garage::Garage; use garage_model::garage::Garage;
use garage_model::permission::ExpirationTime;
use crate::api::*; use crate::api::*;
use crate::error::*; use crate::error::*;
@@ -244,8 +245,8 @@ fn admin_token_info_results(token: &AdminApiToken, now: u64) -> GetAdminTokenInf
.expect("invalid timestamp stored in db"), .expect("invalid timestamp stored in db"),
), ),
name: params.name.get().to_string(), name: params.name.get().to_string(),
expiration: params.expiration.get().map(|x| { expiration: params.expiration.get().inner().map(|x| {
DateTime::from_timestamp_millis(x as i64).expect("invalid timestamp stored in db") DateTime::from_timestamp_millis(x.0 as i64).expect("invalid timestamp stored in db")
}), }),
expired: params.is_expired(now), expired: params.is_expired(now),
scope: params.scope.get().0.clone(), scope: params.scope.get().0.clone(),
@@ -279,10 +280,10 @@ fn apply_token_updates(
if let Some(expiration) = updates.expiration { if let Some(expiration) = updates.expiration {
params params
.expiration .expiration
.update(Some(expiration.timestamp_millis() as u64)); .update(Some(ExpirationTime(expiration.timestamp_millis() as u64)).into());
} }
if updates.never_expires { if updates.never_expires {
params.expiration.update(None); params.expiration.update(None.into());
} }
if let Some(scope) = updates.scope { if let Some(scope) = updates.scope {
params.scope.update(AdminApiTokenScope(scope)); params.scope.update(AdminApiTokenScope(scope));
+50 -55
View File
@@ -90,7 +90,7 @@ impl RequestHandler for GetBucketInfoRequest {
.bucket_alias_table .bucket_alias_table
.get(&EmptyKey, &ga) .get(&EmptyKey, &ga)
.await? .await?
.and_then(|x| *x.state.get()) .and_then(|x| x.state.get().into_inner())
.ok_or_else(|| HelperError::NoSuchBucket(ga.to_string()))?, .ok_or_else(|| HelperError::NoSuchBucket(ga.to_string()))?,
(None, None, Some(search)) => { (None, None, Some(search)) => {
let helper = garage.bucket_helper(); let helper = garage.bucket_helper();
@@ -168,7 +168,7 @@ impl RequestHandler for CreateBucketRequest {
} }
if let Some(alias) = garage.bucket_alias_table.get(&EmptyKey, ga).await? { if let Some(alias) = garage.bucket_alias_table.get(&EmptyKey, ga).await? {
if alias.state.get().is_some() { if alias.state.get().inner().is_some() {
return Err(CommonError::BucketAlreadyExists.into()); return Err(CommonError::BucketAlreadyExists.into());
} }
} }
@@ -297,7 +297,7 @@ impl RequestHandler for UpdateBucketRequest {
let redirect_all = state let redirect_all = state
.website_config .website_config
.get() .get()
.as_ref() .inner()
.and_then(|wc| wc.redirect_all.clone()); .and_then(|wc| wc.redirect_all.clone());
let routing_rules = if let Some(rr) = wa.routing_rules { let routing_rules = if let Some(rr) = wa.routing_rules {
@@ -311,26 +311,29 @@ impl RequestHandler for UpdateBucketRequest {
state state
.website_config .website_config
.get() .get()
.as_ref() .inner()
.map(|wc| wc.routing_rules.clone()) .map(|wc| wc.routing_rules.clone())
.unwrap_or_default() .unwrap_or_default()
}; };
state.website_config.update(Some(WebsiteConfig { state.website_config.update(
Some(WebsiteConfig {
index_document: wa.index_document.ok_or_bad_request( index_document: wa.index_document.ok_or_bad_request(
"Please specify indexDocument when enabling website access.", "Please specify indexDocument when enabling website access.",
)?, )?,
error_document: wa.error_document, error_document: wa.error_document,
redirect_all, redirect_all,
routing_rules, routing_rules,
})); })
.into(),
);
} else { } else {
if wa.index_document.is_some() || wa.error_document.is_some() { if wa.index_document.is_some() || wa.error_document.is_some() {
return Err(Error::bad_request( return Err(Error::bad_request(
"Cannot specify indexDocument or errorDocument when disabling website access.", "Cannot specify indexDocument or errorDocument when disabling website access.",
)); ));
} }
state.website_config.update(None); state.website_config.update(None.into());
} }
} }
@@ -353,7 +356,7 @@ impl RequestHandler for UpdateBucketRequest {
Some(cc.into_garage_cors_config()?) Some(cc.into_garage_cors_config()?)
}; };
state.cors_config.update(cors_config); state.cors_config.update(cors_config.into());
} }
if let Some(lr) = self.body.lifecycle_rules { if let Some(lr) = self.body.lifecycle_rules {
@@ -370,7 +373,7 @@ impl RequestHandler for UpdateBucketRequest {
) )
}; };
state.lifecycle_config.update(lifecycle_config); state.lifecycle_config.update(lifecycle_config.into());
} }
garage.bucket_table.insert(&bucket).await?; garage.bucket_table.insert(&bucket).await?;
@@ -687,45 +690,36 @@ async fn bucket_info_results(
.map(|x| x.filtered_values(&garage.system.cluster_layout())) .map(|x| x.filtered_values(&garage.system.cluster_layout()))
.unwrap_or_default(); .unwrap_or_default();
let mut relevant_keys = HashMap::new(); let state = bucket.state.as_option().unwrap();
for (k, _) in bucket
.state let keys1 = state
.as_option()
.unwrap()
.authorized_keys .authorized_keys
.items() .items()
.iter() .iter()
{ .filter(|(_, p)| p.is_any())
if let Some(key) = garage .map(|(k, _)| k);
.key_table let keys2 = state
.get(&EmptyKey, k)
.await?
.filter(|k| !k.is_deleted())
{
if !key.state.is_deleted() {
relevant_keys.insert(k.clone(), key);
}
}
}
for ((k, _), _, _) in bucket
.state
.as_option()
.unwrap()
.local_aliases .local_aliases
.items() .items()
.iter() .iter()
{ .filter(|(_, _, p)| *p)
if relevant_keys.contains_key(k) { .map(|((k, _), _, _)| k);
let mut relevant_keys = HashMap::new();
for key_id in keys1.chain(keys2) {
if relevant_keys.contains_key(key_id) {
continue; continue;
} }
if let Some(key) = garage.key_table.get(&EmptyKey, k).await? { if let Some(key) = garage.key_table.get(&EmptyKey, key_id).await? {
if !key.state.is_deleted() { relevant_keys.insert(key_id.clone(), key);
relevant_keys.insert(k.clone(), key); } else {
warn!(
"Bucket {:?} references non-existent key {}",
bucket.id, key_id
);
} }
} }
} relevant_keys.retain(|_, k| !k.is_deleted());
let state = bucket.state.as_option().unwrap();
let quotas = state.quotas.get(); let quotas = state.quotas.get();
let res = GetBucketInfoResponse { let res = GetBucketInfoResponse {
@@ -739,8 +733,8 @@ async fn bucket_info_results(
.filter(|(_, _, a)| *a) .filter(|(_, _, a)| *a)
.map(|(n, _, _)| n.to_string()) .map(|(n, _, _)| n.to_string())
.collect::<Vec<_>>(), .collect::<Vec<_>>(),
website_access: state.website_config.get().is_some(), website_access: state.website_config.get().inner().is_some(),
website_config: state.website_config.get().clone().map(|wsc| { website_config: state.website_config.get().inner().cloned().map(|wsc| {
GetBucketInfoWebsiteResponse { GetBucketInfoWebsiteResponse {
index_document: wsc.index_document, index_document: wsc.index_document,
error_document: wsc.error_document, error_document: wsc.error_document,
@@ -752,42 +746,43 @@ async fn bucket_info_results(
), ),
} }
}), }),
cors_rules: state.cors_config.get().as_ref().map(|rules| { cors_rules: state.cors_config.get().inner().map(|rules| {
rules rules
.iter() .iter()
.map(xml::cors::CorsRule::from_garage_cors_rule) .map(xml::cors::CorsRule::from_garage_cors_rule)
.collect::<Vec<_>>() .collect::<Vec<_>>()
}), }),
lifecycle_rules: state.lifecycle_config.get().as_ref().map(|lc| { lifecycle_rules: state.lifecycle_config.get().inner().map(|lc| {
lc.iter() lc.iter()
.map(xml::lifecycle::LifecycleRule::from_garage_lifecycle_rule) .map(xml::lifecycle::LifecycleRule::from_garage_lifecycle_rule)
.collect::<Vec<_>>() .collect::<Vec<_>>()
}), }),
keys: relevant_keys keys: relevant_keys
.into_values() .into_values()
.filter_map(|key| { .map(|key| {
let p = key.state.as_option().unwrap(); let st = key.state.as_option().unwrap();
let permissions = p let permissions = st
.authorized_buckets .authorized_buckets
.get(&bucket.id) .get(&bucket.id)
.filter(|p| p.is_any())
.map(|p| ApiBucketKeyPerm { .map(|p| ApiBucketKeyPerm {
read: p.allow_read, read: p.allow_read,
write: p.allow_write, write: p.allow_write,
owner: p.allow_owner, owner: p.allow_owner,
})?; })
Some(GetBucketInfoKey { .unwrap_or_default();
access_key_id: key.key_id, let bucket_local_aliases = st
name: p.name.get().to_string(),
permissions,
bucket_local_aliases: p
.local_aliases .local_aliases
.items() .items()
.iter() .iter()
.filter(|(_, _, b)| *b == Some(bucket.id)) .filter(|(_, _, b)| b.into_inner() == Some(bucket.id))
.map(|(n, _, _)| n.to_string()) .map(|(n, _, _)| n.to_string())
.collect::<Vec<_>>(), .collect::<Vec<_>>();
}) GetBucketInfoKey {
access_key_id: key.key_id,
name: st.name.get().to_string(),
permissions,
bucket_local_aliases,
}
}) })
.collect::<Vec<_>>(), .collect::<Vec<_>>(),
objects: *counters.get(OBJECTS).unwrap_or(&0), objects: *counters.get(OBJECTS).unwrap_or(&0),
+29 -23
View File
@@ -8,6 +8,7 @@ use garage_util::time::now_msec;
use garage_model::garage::Garage; use garage_model::garage::Garage;
use garage_model::key_table::*; use garage_model::key_table::*;
use garage_model::permission::ExpirationTime;
use crate::api::*; use crate::api::*;
use crate::error::*; use crate::error::*;
@@ -40,8 +41,8 @@ impl RequestHandler for ListKeysRequest {
DateTime::from_timestamp_millis(x as i64) DateTime::from_timestamp_millis(x as i64)
.expect("invalid timestamp stored in db") .expect("invalid timestamp stored in db")
}), }),
expiration: p.expiration.get().map(|x| { expiration: p.expiration.get().inner().map(|x| {
DateTime::from_timestamp_millis(x as i64) DateTime::from_timestamp_millis(x.0 as i64)
.expect("invalid timestamp stored in db") .expect("invalid timestamp stored in db")
}), }),
expired: p.is_expired(now), expired: p.is_expired(now),
@@ -187,38 +188,42 @@ async fn key_info_results(
key: Key, key: Key,
show_secret: bool, show_secret: bool,
) -> Result<GetKeyInfoResponse, Error> { ) -> Result<GetKeyInfoResponse, Error> {
let mut relevant_buckets = HashMap::new();
let key_state = key.state.as_option().unwrap(); let key_state = key.state.as_option().unwrap();
for id in key_state let buckets1 = key_state
.authorized_buckets .authorized_buckets
.items() .items()
.iter() .iter()
.map(|(id, _)| id) .filter(|(_, p)| p.is_any())
.chain( .map(|(id, _)| id);
key_state let buckets2 = key_state
.local_aliases .local_aliases
.items() .items()
.iter() .iter()
.filter_map(|(_, _, v)| v.as_ref()), .filter_map(|(_, _, v)| v.inner());
) {
if !relevant_buckets.contains_key(id) { let mut relevant_buckets = HashMap::new();
if let Some(b) = garage.bucket_table.get(&EmptyKey, id).await? { for bucket_id in buckets1.chain(buckets2) {
if b.state.as_option().is_some() { if !relevant_buckets.contains_key(bucket_id) {
relevant_buckets.insert(*id, b); if let Some(b) = garage.bucket_table.get(&EmptyKey, bucket_id).await? {
} relevant_buckets.insert(*bucket_id, b);
} else {
warn!(
"Key {} references non-existent bucket {:?}",
key.key_id, bucket_id
);
} }
} }
} }
relevant_buckets.retain(|_, b| !b.is_deleted());
let res = GetKeyInfoResponse { let res = GetKeyInfoResponse {
name: key_state.name.get().clone(), name: key_state.name.get().clone(),
created: key_state.created.map(|x| { created: key_state.created.map(|x| {
DateTime::from_timestamp_millis(x as i64).expect("invalid timestamp stored in db") DateTime::from_timestamp_millis(x as i64).expect("invalid timestamp stored in db")
}), }),
expiration: key_state.expiration.get().map(|x| { expiration: key_state.expiration.get().inner().map(|x| {
DateTime::from_timestamp_millis(x as i64).expect("invalid timestamp stored in db") DateTime::from_timestamp_millis(x.0 as i64).expect("invalid timestamp stored in db")
}), }),
expired: key_state.is_expired(now_msec()), expired: key_state.is_expired(now_msec()),
access_key_id: key.key_id.clone(), access_key_id: key.key_id.clone(),
@@ -232,7 +237,7 @@ async fn key_info_results(
}, },
buckets: relevant_buckets buckets: relevant_buckets
.into_values() .into_values()
.filter_map(|bucket| { .map(|bucket| {
let state = bucket.state.as_option().unwrap(); let state = bucket.state.as_option().unwrap();
let permissions = key_state let permissions = key_state
.authorized_buckets .authorized_buckets
@@ -242,8 +247,9 @@ async fn key_info_results(
read: p.allow_read, read: p.allow_read,
write: p.allow_write, write: p.allow_write,
owner: p.allow_owner, owner: p.allow_owner,
})?; })
Some(KeyInfoBucketResponse { .unwrap_or_default();
KeyInfoBucketResponse {
id: hex::encode(bucket.id), id: hex::encode(bucket.id),
global_aliases: state global_aliases: state
.aliases .aliases
@@ -260,7 +266,7 @@ async fn key_info_results(
.map(|((_, n), _, _)| n.to_string()) .map(|((_, n), _, _)| n.to_string())
.collect::<Vec<_>>(), .collect::<Vec<_>>(),
permissions, permissions,
}) }
}) })
.collect::<Vec<_>>(), .collect::<Vec<_>>(),
}; };
@@ -283,10 +289,10 @@ fn apply_key_updates(key: &mut Key, updates: UpdateKeyRequestBody) -> Result<(),
if let Some(expiration) = updates.expiration { if let Some(expiration) = updates.expiration {
key_state key_state
.expiration .expiration
.update(Some(expiration.timestamp_millis() as u64)); .update(Some(ExpirationTime(expiration.timestamp_millis() as u64)).into());
} }
if updates.never_expires { if updates.never_expires {
key_state.expiration.update(None); key_state.expiration.update(None.into());
} }
if let Some(allow) = updates.allow { if let Some(allow) = updates.allow {
if allow.create_bucket { if allow.create_bucket {
+1 -8
View File
@@ -360,14 +360,7 @@ impl Worker for BlockRcRepair {
_must_exit: &mut watch::Receiver<bool>, _must_exit: &mut watch::Receiver<bool>,
) -> Result<WorkerState, GarageError> { ) -> Result<WorkerState, GarageError> {
for _i in 0..RC_REPAIR_ITER_COUNT { for _i in 0..RC_REPAIR_ITER_COUNT {
let next1 = self let next1 = self.block_manager.rc.get_first_hash_from(self.cursor)?;
.block_manager
.rc
.rc_table
.range(self.cursor.as_slice()..)?
.next()
.transpose()?
.map(|(k, _)| Hash::try_from(k.as_slice()).unwrap());
let next2 = self let next2 = self
.block_ref_table .block_ref_table
.data .data
+1 -1
View File
@@ -164,7 +164,7 @@ async fn check_domain(garage: &Arc<Garage>, domain: &str) -> Result<bool, Error>
} }
let bucket_state = bucket.state.as_option().unwrap(); let bucket_state = bucket.state.as_option().unwrap();
let bucket_website_config = bucket_state.website_config.get(); let bucket_website_config = bucket_state.website_config.get().inner();
match bucket_website_config { match bucket_website_config {
Some(_v) => Ok(true), Some(_v) => Ok(true),
+7 -4
View File
@@ -19,7 +19,7 @@ pub fn find_matching_cors_rule<'a, B>(
bucket_params: &'a BucketParams, bucket_params: &'a BucketParams,
req: &'a Request<B>, req: &'a Request<B>,
) -> Result<Option<(&'a GarageCorsRule, &'a str)>, CommonError> { ) -> Result<Option<(&'a GarageCorsRule, &'a str)>, CommonError> {
if let Some(cors_config) = bucket_params.cors_config.get() { if let Some(cors_config) = bucket_params.cors_config.get().inner() {
if let Some(origin) = req.headers().get("Origin") { if let Some(origin) = req.headers().get("Origin") {
let origin = origin.to_str()?; let origin = origin.to_str()?;
let request_headers = match req.headers().get(ACCESS_CONTROL_REQUEST_HEADERS) { let request_headers = match req.headers().get(ACCESS_CONTROL_REQUEST_HEADERS) {
@@ -158,7 +158,7 @@ pub fn handle_options_for_bucket<B>(
None => vec![], None => vec![],
}; };
if let Some(cors_config) = bucket_params.cors_config.get() { if let Some(cors_config) = bucket_params.cors_config.get().inner() {
let matching_rule = cors_config let matching_rule = cors_config
.iter() .iter()
.find(|rule| cors_rule_matches(rule, origin, request_method, request_headers.iter())); .find(|rule| cors_rule_matches(rule, origin, request_method, request_headers.iter()));
@@ -192,14 +192,17 @@ mod tests {
fn bucket_params_with_rule(allow_origins: Vec<&str>) -> BucketParams { fn bucket_params_with_rule(allow_origins: Vec<&str>) -> BucketParams {
let mut bucket_params = BucketParams::default(); let mut bucket_params = BucketParams::default();
bucket_params.cors_config.update(Some(vec![GarageCorsRule { bucket_params.cors_config.update(
Some(vec![GarageCorsRule {
id: Some("cors-test".into()), id: Some("cors-test".into()),
max_age_seconds: None, max_age_seconds: None,
allow_origins: allow_origins.into_iter().map(str::to_string).collect(), allow_origins: allow_origins.into_iter().map(str::to_string).collect(),
allow_methods: vec!["GET".into(), "PUT".into()], allow_methods: vec!["GET".into(), "PUT".into()],
allow_headers: vec!["*".into()], allow_headers: vec!["*".into()],
expose_headers: vec![], expose_headers: vec![],
}])); }])
.into(),
);
bucket_params bucket_params
} }
+15 -7
View File
@@ -5,12 +5,13 @@ use serde::{Deserialize, Serialize};
use garage_table::{EnumerationOrder, TableSchema}; use garage_table::{EnumerationOrder, TableSchema};
use garage_model::k2v::item_table::*; use garage_model::k2v::item_table::*;
use garage_model::k2v::rpc::K2VMonotonicRead;
use garage_api_common::helpers::*; use garage_api_common::helpers::*;
use crate::api_server::{ReqBody, ResBody}; use crate::api_server::{ReqBody, ResBody};
use crate::error::*; use crate::error::*;
use crate::item::parse_causality_token; use crate::item::{is_monotonic_read, parse_causality_token};
use crate::range::read_range; use crate::range::read_range;
pub async fn handle_insert_batch( pub async fn handle_insert_batch(
@@ -47,12 +48,13 @@ pub async fn handle_read_batch(
ctx: ReqCtx, ctx: ReqCtx,
req: Request<ReqBody>, req: Request<ReqBody>,
) -> Result<Response<ResBody>, Error> { ) -> Result<Response<ResBody>, Error> {
let monotonic_read = is_monotonic_read(&req)?;
let queries = req.into_body().json::<Vec<ReadBatchQuery>>().await?; let queries = req.into_body().json::<Vec<ReadBatchQuery>>().await?;
let resp_results = futures::future::join_all( let resp_results = futures::future::join_all(
queries queries
.into_iter() .into_iter()
.map(|q| handle_read_batch_query(&ctx, q)), .map(|q| handle_read_batch_query(&ctx, q, monotonic_read)),
) )
.await; .await;
@@ -67,6 +69,7 @@ pub async fn handle_read_batch(
async fn handle_read_batch_query( async fn handle_read_batch_query(
ctx: &ReqCtx, ctx: &ReqCtx,
query: ReadBatchQuery, query: ReadBatchQuery,
monotonic_read: K2VMonotonicRead,
) -> Result<ReadBatchResponse, Error> { ) -> Result<ReadBatchResponse, Error> {
let ReqCtx { let ReqCtx {
garage, bucket_id, .. garage, bucket_id, ..
@@ -90,11 +93,12 @@ async fn handle_read_batch_query(
.start .start
.as_ref() .as_ref()
.ok_or_bad_request("start should be specified if single_item is set")?; .ok_or_bad_request("start should be specified if single_item is set")?;
let item = garage let item = match monotonic_read {
.k2v K2VMonotonicRead::Monotonic => {
.item_table garage.k2v.item_table.get_monotonic(&partition, sk).await?
.get(&partition, sk) }
.await? K2VMonotonicRead::NonMonotonic => garage.k2v.item_table.get(&partition, sk).await?,
}
.filter(|e| K2VItemTable::matches_filter(e, &filter)); .filter(|e| K2VItemTable::matches_filter(e, &filter));
match item { match item {
Some(i) => (vec![ReadBatchResponseItem::from(i)], false, None), Some(i) => (vec![ReadBatchResponseItem::from(i)], false, None),
@@ -110,6 +114,7 @@ async fn handle_read_batch_query(
query.limit, query.limit,
Some(filter), Some(filter),
EnumerationOrder::from_reverse(query.reverse), EnumerationOrder::from_reverse(query.reverse),
monotonic_read,
) )
.await?; .await?;
@@ -218,6 +223,7 @@ async fn handle_delete_batch_query(
None, None,
Some(filter), Some(filter),
EnumerationOrder::Forward, EnumerationOrder::Forward,
K2VMonotonicRead::NonMonotonic,
) )
.await?; .await?;
assert!(!more); assert!(!more);
@@ -260,6 +266,7 @@ pub(crate) async fn handle_poll_range(
let ReqCtx { let ReqCtx {
garage, bucket_id, .. garage, bucket_id, ..
} = ctx; } = ctx;
let monotonic_read = is_monotonic_read(&req)?;
use garage_model::k2v::sub::PollRange; use garage_model::k2v::sub::PollRange;
let query = req.into_body().json::<PollRangeQuery>().await?; let query = req.into_body().json::<PollRangeQuery>().await?;
@@ -281,6 +288,7 @@ pub(crate) async fn handle_poll_range(
}, },
query.seen_marker, query.seen_marker,
timeout_msec, timeout_msec,
monotonic_read,
) )
.await .await
.map_err(pass_helper_error)?; .map_err(pass_helper_error)?;
+7 -1
View File
@@ -44,6 +44,10 @@ pub enum Error {
#[error("Invalid causality token")] #[error("Invalid causality token")]
InvalidCausalityToken, InvalidCausalityToken,
/// Invalid parameter for x-garage-non-monotonic-read
#[error("Invalid X-Garage-Non-Monotonic-Read value: {0}")]
InvalidNonMonotonicRead(String),
/// The client asked for an invalid return format (invalid Accept header) /// The client asked for an invalid return format (invalid Accept header)
#[error("Not acceptable: {0}")] #[error("Not acceptable: {0}")]
NotAcceptable(String), NotAcceptable(String),
@@ -85,6 +89,7 @@ impl Error {
Error::InvalidBase64(_) => "InvalidBase64", Error::InvalidBase64(_) => "InvalidBase64",
Error::InvalidUtf8Str(_) => "InvalidUtf8String", Error::InvalidUtf8Str(_) => "InvalidUtf8String",
Error::InvalidCausalityToken => "CausalityToken", Error::InvalidCausalityToken => "CausalityToken",
Error::InvalidNonMonotonicRead(_) => "InvalidNonMonotonicRead",
Error::InvalidDigest(_) => "InvalidDigest", Error::InvalidDigest(_) => "InvalidDigest",
} }
} }
@@ -101,7 +106,8 @@ impl ApiError for Error {
| Error::InvalidBase64(_) | Error::InvalidBase64(_)
| Error::InvalidUtf8Str(_) | Error::InvalidUtf8Str(_)
| Error::InvalidDigest(_) | Error::InvalidDigest(_)
| Error::InvalidCausalityToken => StatusCode::BAD_REQUEST, | Error::InvalidCausalityToken
| Error::InvalidNonMonotonicRead(_) => StatusCode::BAD_REQUEST,
} }
} }
+2
View File
@@ -4,6 +4,7 @@ use serde::Serialize;
use garage_table::util::*; use garage_table::util::*;
use garage_model::k2v::item_table::{BYTES, CONFLICTS, ENTRIES, VALUES}; use garage_model::k2v::item_table::{BYTES, CONFLICTS, ENTRIES, VALUES};
use garage_model::k2v::rpc::K2VMonotonicRead;
use garage_api_common::helpers::*; use garage_api_common::helpers::*;
@@ -40,6 +41,7 @@ pub async fn handle_read_index(
limit, limit,
Some((DeletedFilter::NotDeleted, node_id_vec)), Some((DeletedFilter::NotDeleted, node_id_vec)),
EnumerationOrder::from_reverse(reverse), EnumerationOrder::from_reverse(reverse),
K2VMonotonicRead::NonMonotonic,
) )
.await?; .await?;
+34 -10
View File
@@ -5,6 +5,7 @@ use hyper::{Request, Response, StatusCode};
use garage_model::k2v::causality::*; use garage_model::k2v::causality::*;
use garage_model::k2v::item_table::*; use garage_model::k2v::item_table::*;
use garage_model::k2v::rpc::K2VMonotonicRead;
use garage_api_common::helpers::*; use garage_api_common::helpers::*;
@@ -12,6 +13,7 @@ use crate::api_server::{ReqBody, ResBody};
use crate::error::*; use crate::error::*;
pub const X_GARAGE_CAUSALITY_TOKEN: &str = "X-Garage-Causality-Token"; pub const X_GARAGE_CAUSALITY_TOKEN: &str = "X-Garage-Causality-Token";
pub const X_GARAGE_NON_MONOTONIC_READ: &str = "X-Garage-Non-Monotonic-Read";
pub enum ReturnFormat { pub enum ReturnFormat {
Json, Json,
@@ -23,6 +25,21 @@ pub(crate) fn parse_causality_token(s: &str) -> Result<CausalContext, Error> {
CausalContext::parse(s).ok_or(Error::InvalidCausalityToken) CausalContext::parse(s).ok_or(Error::InvalidCausalityToken)
} }
pub(crate) fn is_monotonic_read(req: &Request<ReqBody>) -> Result<K2VMonotonicRead, Error> {
let v_opt = req
.headers()
.get(X_GARAGE_NON_MONOTONIC_READ)
.map(|s| s.to_str())
.transpose()?;
match v_opt {
Some("true") => Ok(K2VMonotonicRead::NonMonotonic),
// Reads are monotonic by default
Some("false") | None => Ok(K2VMonotonicRead::Monotonic),
Some(s) => Err(Error::InvalidNonMonotonicRead(s.to_string())),
}
}
impl ReturnFormat { impl ReturnFormat {
pub fn from(req: &Request<ReqBody>) -> Result<Self, Error> { pub fn from(req: &Request<ReqBody>) -> Result<Self, Error> {
let accept = match req.headers().get(header::ACCEPT) { let accept = match req.headers().get(header::ACCEPT) {
@@ -108,20 +125,25 @@ pub async fn handle_read_item(
let ReqCtx { let ReqCtx {
garage, bucket_id, .. garage, bucket_id, ..
} = &ctx; } = &ctx;
let monotonic_read = is_monotonic_read(req)?;
let format = ReturnFormat::from(req)?; let format = ReturnFormat::from(req)?;
let partition_key = K2VItemPartition {
let item = garage
.k2v
.item_table
.get(
&K2VItemPartition {
bucket_id: *bucket_id, bucket_id: *bucket_id,
partition_key: partition_key.to_string(), partition_key: partition_key.to_string(),
}, };
sort_key,
) let item = match monotonic_read {
K2VMonotonicRead::Monotonic => {
garage
.k2v
.item_table
.get_monotonic(&partition_key, sort_key)
.await? .await?
}
K2VMonotonicRead::NonMonotonic => {
garage.k2v.item_table.get(&partition_key, sort_key).await?
}
}
.ok_or(Error::NoSuchKey)?; .ok_or(Error::NoSuchKey)?;
format.make_response(&item) format.make_response(&item)
@@ -214,6 +236,7 @@ pub async fn handle_poll_item(
let ReqCtx { let ReqCtx {
garage, bucket_id, .. garage, bucket_id, ..
} = &ctx; } = &ctx;
let monotonic_read = is_monotonic_read(req)?;
let format = ReturnFormat::from(req)?; let format = ReturnFormat::from(req)?;
let causal_context = let causal_context =
@@ -230,6 +253,7 @@ pub async fn handle_poll_item(
sort_key, sort_key,
causal_context, causal_context,
timeout_msec, timeout_msec,
monotonic_read,
) )
.await?; .await?;
+20 -2
View File
@@ -4,6 +4,8 @@
use std::sync::Arc; use std::sync::Arc;
use garage_model::k2v::rpc::K2VMonotonicRead;
use garage_table::replication::TableShardedReplication; use garage_table::replication::TableShardedReplication;
use garage_table::*; use garage_table::*;
@@ -23,6 +25,7 @@ pub(crate) async fn read_range<F>(
limit: Option<u64>, limit: Option<u64>,
filter: Option<F::Filter>, filter: Option<F::Filter>,
enumeration_order: EnumerationOrder, enumeration_order: EnumerationOrder,
monotonic_read: K2VMonotonicRead,
) -> Result<(Vec<F::E>, bool, Option<String>), Error> ) -> Result<(Vec<F::E>, bool, Option<String>), Error>
where where
F: TableSchema<S = String> + 'static, F: TableSchema<S = String> + 'static,
@@ -53,7 +56,20 @@ where
1000, 1000,
limit.map(|x| x as usize).unwrap_or(usize::MAX - 10) - entries.len() + 2, limit.map(|x| x as usize).unwrap_or(usize::MAX - 10) - entries.len() + 2,
); );
let get_ret = table let get_ret = match monotonic_read {
K2VMonotonicRead::Monotonic => {
table
.get_range_monotonic(
partition_key,
start.clone(),
filter.clone(),
n_get,
enumeration_order,
)
.await?
}
K2VMonotonicRead::NonMonotonic => {
table
.get_range( .get_range(
partition_key, partition_key,
start.clone(), start.clone(),
@@ -61,7 +77,9 @@ where
n_get, n_get,
enumeration_order, enumeration_order,
) )
.await?; .await?
}
};
let get_ret_len = get_ret.len(); let get_ret_len = get_ret.len();
+6 -3
View File
@@ -122,7 +122,7 @@ pub async fn handle_list_buckets(
for (alias, _, _active) in bucket.aliases().iter().filter(|(_, _, active)| *active) { for (alias, _, _active) in bucket.aliases().iter().filter(|(_, _, active)| *active) {
let alias_opt = garage.bucket_alias_table.get(&EmptyKey, alias).await?; let alias_opt = garage.bucket_alias_table.get(&EmptyKey, alias).await?;
if let Some(alias_ent) = alias_opt { if let Some(alias_ent) = alias_opt {
if *alias_ent.state.get() == Some(*bucket_id) { if alias_ent.state.get().inner() == Some(bucket_id) {
aliases.insert(alias_ent.name().to_string(), *bucket_id); aliases.insert(alias_ent.name().to_string(), *bucket_id);
} }
} }
@@ -134,7 +134,7 @@ pub async fn handle_list_buckets(
} }
for (alias, _, id_opt) in key_p.local_aliases.items() { for (alias, _, id_opt) in key_p.local_aliases.items() {
if let Some(id) = id_opt { if let Some(id) = id_opt.inner() {
aliases.insert(alias.clone(), *id); aliases.insert(alias.clone(), *id);
} }
} }
@@ -256,7 +256,10 @@ pub async fn handle_delete_bucket(ctx: ReqCtx) -> Result<Response<ResBody>, Erro
let key_params = api_key.params().unwrap(); let key_params = api_key.params().unwrap();
let is_local_alias = matches!(key_params.local_aliases.get(bucket_name), Some(Some(_))); let is_local_alias = matches!(
key_params.local_aliases.get(bucket_name).map(|x| x.inner()),
Some(Some(_))
);
// If the bucket has no other aliases, this is a true deletion. // If the bucket has no other aliases, this is a true deletion.
// Otherwise, it is just an alias removal. // Otherwise, it is just an alias removal.
+3 -3
View File
@@ -13,7 +13,7 @@ use crate::xml::to_xml_with_header;
pub async fn handle_get_cors(ctx: ReqCtx) -> Result<Response<ResBody>, Error> { pub async fn handle_get_cors(ctx: ReqCtx) -> Result<Response<ResBody>, Error> {
let ReqCtx { bucket_params, .. } = ctx; let ReqCtx { bucket_params, .. } = ctx;
if let Some(cors) = bucket_params.cors_config.get() { if let Some(cors) = bucket_params.cors_config.get().inner() {
let wc = CorsConfiguration { let wc = CorsConfiguration {
xmlns: (), xmlns: (),
cors_rules: cors cors_rules: cors
@@ -38,7 +38,7 @@ pub async fn handle_delete_cors(ctx: ReqCtx) -> Result<Response<ResBody>, Error>
mut bucket_params, mut bucket_params,
.. ..
} = ctx; } = ctx;
bucket_params.cors_config.update(None); bucket_params.cors_config.update(None.into());
garage garage
.bucket_table .bucket_table
.insert(&Bucket::present(bucket_id, bucket_params)) .insert(&Bucket::present(bucket_id, bucket_params))
@@ -67,7 +67,7 @@ pub async fn handle_put_cors(
bucket_params bucket_params
.cors_config .cors_config
.update(Some(conf.into_garage_cors_config()?)); .update(Some(conf.into_garage_cors_config()?).into());
garage garage
.bucket_table .bucket_table
.insert(&Bucket::present(bucket_id, bucket_params)) .insert(&Bucket::present(bucket_id, bucket_params))
+15 -2
View File
@@ -83,8 +83,21 @@ pub async fn handle_delete_objects(
} }
ret_deleted.push(s3_xml::Deleted { ret_deleted.push(s3_xml::Deleted {
key: s3_xml::Value(obj.key.clone()), key: s3_xml::Value(obj.key.clone()),
version_id: s3_xml::Value(hex::encode(deleted_version)), version_id: Some(s3_xml::Value(hex::encode(deleted_version))),
delete_marker_version_id: s3_xml::Value(hex::encode(delete_marker_version)), delete_marker_version_id: Some(s3_xml::Value(hex::encode(
delete_marker_version,
))),
});
}
Err(Error::NoSuchKey) => {
if cmd.quiet {
continue;
}
// Deleting a non-existent key is a success in S3
ret_deleted.push(s3_xml::Deleted {
key: s3_xml::Value(obj.key.clone()),
version_id: None,
delete_marker_version_id: None,
}); });
} }
Err(e) => { Err(e) => {
+3 -3
View File
@@ -14,7 +14,7 @@ use garage_model::bucket_table::Bucket;
pub async fn handle_get_lifecycle(ctx: ReqCtx) -> Result<Response<ResBody>, Error> { pub async fn handle_get_lifecycle(ctx: ReqCtx) -> Result<Response<ResBody>, Error> {
let ReqCtx { bucket_params, .. } = ctx; let ReqCtx { bucket_params, .. } = ctx;
if let Some(lifecycle) = bucket_params.lifecycle_config.get() { if let Some(lifecycle) = bucket_params.lifecycle_config.get().inner() {
let wc = LifecycleConfiguration::from_garage_lifecycle_config(lifecycle); let wc = LifecycleConfiguration::from_garage_lifecycle_config(lifecycle);
let xml = to_xml_with_header(&wc)?; let xml = to_xml_with_header(&wc)?;
Ok(Response::builder() Ok(Response::builder()
@@ -33,7 +33,7 @@ pub async fn handle_delete_lifecycle(ctx: ReqCtx) -> Result<Response<ResBody>, E
mut bucket_params, mut bucket_params,
.. ..
} = ctx; } = ctx;
bucket_params.lifecycle_config.update(None); bucket_params.lifecycle_config.update(None.into());
garage garage
.bucket_table .bucket_table
.insert(&Bucket::present(bucket_id, bucket_params)) .insert(&Bucket::present(bucket_id, bucket_params))
@@ -62,7 +62,7 @@ pub async fn handle_put_lifecycle(
.validate_into_garage_lifecycle_config() .validate_into_garage_lifecycle_config()
.ok_or_bad_request("Invalid lifecycle configuration")?; .ok_or_bad_request("Invalid lifecycle configuration")?;
bucket_params.lifecycle_config.update(Some(config)); bucket_params.lifecycle_config.update(Some(config).into());
garage garage
.bucket_table .bucket_table
.insert(&Bucket::present(bucket_id, bucket_params)) .insert(&Bucket::present(bucket_id, bucket_params))
+4 -2
View File
@@ -83,10 +83,12 @@ pub async fn handle_post_object(
}; };
// Current part is file. Do some checks before handling to PutObject code // Current part is file. Do some checks before handling to PutObject code
let key = params let key = std::str::from_utf8(
params
.get("key") .get("key")
.ok_or_bad_request("No key was provided")? .ok_or_bad_request("No key was provided")?
.to_str()?; .as_bytes(),
)?;
let policy = params let policy = params
.get("policy") .get("policy")
.ok_or_bad_request("No policy was provided")? .ok_or_bad_request("No policy was provided")?
+4 -1
View File
@@ -679,7 +679,10 @@ pub(crate) fn extract_metadata_headers(
]; ];
for name in standard_header.iter() { for name in standard_header.iter() {
if let Some(value) = headers.get(name) { if let Some(value) = headers.get(name) {
ret.push((name.to_string(), value.to_str()?.to_string())); ret.push((
name.to_string(),
std::str::from_utf8(value.as_bytes())?.to_string(),
));
} }
} }
+3 -3
View File
@@ -16,7 +16,7 @@ pub const X_AMZ_WEBSITE_REDIRECT_LOCATION: HeaderName =
pub async fn handle_get_website(ctx: ReqCtx) -> Result<Response<ResBody>, Error> { pub async fn handle_get_website(ctx: ReqCtx) -> Result<Response<ResBody>, Error> {
let ReqCtx { bucket_params, .. } = ctx; let ReqCtx { bucket_params, .. } = ctx;
if let Some(website) = bucket_params.website_config.get() { if let Some(website) = bucket_params.website_config.get().inner() {
let wc = WebsiteConfiguration { let wc = WebsiteConfiguration {
xmlns: (), xmlns: (),
error_document: website.error_document.as_ref().map(|v| Key { error_document: website.error_document.as_ref().map(|v| Key {
@@ -54,7 +54,7 @@ pub async fn handle_delete_website(ctx: ReqCtx) -> Result<Response<ResBody>, Err
mut bucket_params, mut bucket_params,
.. ..
} = ctx; } = ctx;
bucket_params.website_config.update(None); bucket_params.website_config.update(None.into());
garage garage
.bucket_table .bucket_table
.insert(&Bucket::present(bucket_id, bucket_params)) .insert(&Bucket::present(bucket_id, bucket_params))
@@ -83,7 +83,7 @@ pub async fn handle_put_website(
bucket_params bucket_params
.website_config .website_config
.update(Some(conf.into_garage_website_config()?)); .update(Some(conf.into_garage_website_config()?).into());
garage garage
.bucket_table .bucket_table
.insert(&Bucket::present(bucket_id, bucket_params)) .insert(&Bucket::present(bucket_id, bucket_params))
+11 -8
View File
@@ -44,10 +44,13 @@ pub struct LocationConstraint {
pub struct Deleted { pub struct Deleted {
#[serde(rename = "Key")] #[serde(rename = "Key")]
pub key: Value, pub key: Value,
#[serde(rename = "VersionId")] #[serde(rename = "VersionId", skip_serializing_if = "Option::is_none")]
pub version_id: Value, pub version_id: Option<Value>,
#[serde(rename = "DeleteMarkerVersionId")] #[serde(
pub delete_marker_version_id: Value, rename = "DeleteMarkerVersionId",
skip_serializing_if = "Option::is_none"
)]
pub delete_marker_version_id: Option<Value>,
} }
#[derive(Debug, Serialize, PartialEq, Eq)] #[derive(Debug, Serialize, PartialEq, Eq)]
@@ -497,13 +500,13 @@ mod tests {
deleted: vec![ deleted: vec![
Deleted { Deleted {
key: Value("a/plop".to_string()), key: Value("a/plop".to_string()),
version_id: Value("qsdfjklm".to_string()), version_id: Some(Value("qsdfjklm".to_string())),
delete_marker_version_id: Value("wxcvbn".to_string()), delete_marker_version_id: Some(Value("wxcvbn".to_string())),
}, },
Deleted { Deleted {
key: Value("b/plip".to_string()), key: Value("b/plip".to_string()),
version_id: Value("1234".to_string()), version_id: Some(Value("1234".to_string())),
delete_marker_version_id: Value("4321".to_string()), delete_marker_version_id: Some(Value("4321".to_string())),
}, },
], ],
errors: vec![ errors: vec![
+5 -6
View File
@@ -144,7 +144,7 @@ impl BlockManager {
// Open metadata tables // Open metadata tables
let rc = db let rc = db
.open_tree("block_local_rc") .open_typed_tree("block_local_rc")
.expect("Unable to open block_local_rc tree"); .expect("Unable to open block_local_rc tree");
let rc = BlockRc::new(rc); let rc = BlockRc::new(rc);
@@ -158,9 +158,9 @@ impl BlockManager {
let metrics = BlockManagerMetrics::new( let metrics = BlockManagerMetrics::new(
config.compression_level, config.compression_level,
rc.rc_table.clone(), rc.rc_table.untyped().clone(),
resync.queue.clone(), resync.queue.untyped().clone(),
resync.errors.clone(), resync.errors.untyped().clone(),
buffer_kb_semaphore.clone(), buffer_kb_semaphore.clone(),
); );
@@ -449,9 +449,8 @@ impl BlockManager {
let mut blocks = Vec::with_capacity(self.resync.errors.approximate_len()?); let mut blocks = Vec::with_capacity(self.resync.errors.approximate_len()?);
for ent in self.resync.errors.iter()? { for ent in self.resync.errors.iter()? {
let (hash, cnt) = ent?; let (hash, cnt) = ent?;
let cnt = ErrorCounter::decode(&cnt);
blocks.push(BlockResyncErrorInfo { blocks.push(BlockResyncErrorInfo {
hash: Hash::try_from(&hash).unwrap(), hash,
refcount: 0, refcount: 0,
error_count: cnt.errors, error_count: cnt.errors,
last_try: cnt.last_try, last_try: cnt.last_try,
+102 -97
View File
@@ -1,4 +1,5 @@
use std::convert::TryInto; use std::convert::TryInto;
use std::num::NonZeroU64;
use arc_swap::ArcSwapOption; use arc_swap::ArcSwapOption;
@@ -14,12 +15,12 @@ pub type CalculateRefcount =
Box<dyn Fn(&db::Transaction, &Hash) -> db::TxResult<usize, Error> + Send + Sync>; Box<dyn Fn(&db::Transaction, &Hash) -> db::TxResult<usize, Error> + Send + Sync>;
pub struct BlockRc { pub struct BlockRc {
pub rc_table: db::Tree, pub(crate) rc_table: db::TypedTree<Hash, RcEntry>,
pub(crate) recalc_rc: ArcSwapOption<Vec<CalculateRefcount>>, pub(crate) recalc_rc: ArcSwapOption<Vec<CalculateRefcount>>,
} }
impl BlockRc { impl BlockRc {
pub(crate) fn new(rc: db::Tree) -> Self { pub(crate) fn new(rc: db::TypedTree<Hash, RcEntry>) -> Self {
Self { Self {
rc_table: rc, rc_table: rc,
recalc_rc: ArcSwapOption::new(None), recalc_rc: ArcSwapOption::new(None),
@@ -33,11 +34,8 @@ impl BlockRc {
tx: &mut db::Transaction, tx: &mut db::Transaction,
hash: &Hash, hash: &Hash,
) -> db::TxOpResult<bool> { ) -> db::TxOpResult<bool> {
let old_rc = RcEntry::parse_opt(tx.get(&self.rc_table, hash)?); let old_rc = RcState(self.rc_table.tx_get(tx, hash)?);
match old_rc.increment().serialize() { self.rc_table.tx_insert(tx, hash, &old_rc.increment())?;
Some(x) => tx.insert(&self.rc_table, hash, x)?,
None => unreachable!(),
}
Ok(old_rc.is_zero()) Ok(old_rc.is_zero())
} }
@@ -48,17 +46,27 @@ impl BlockRc {
tx: &mut db::Transaction, tx: &mut db::Transaction,
hash: &Hash, hash: &Hash,
) -> db::TxOpResult<bool> { ) -> db::TxOpResult<bool> {
let new_rc = RcEntry::parse_opt(tx.get(&self.rc_table, hash)?).decrement(); let new_rc = RcState(self.rc_table.tx_get(tx, hash)?).decrement();
match new_rc.serialize() { match &new_rc.0 {
Some(x) => tx.insert(&self.rc_table, hash, x)?, None => self.rc_table.tx_remove(tx, hash)?,
None => tx.remove(&self.rc_table, hash)?, Some(rc) => self.rc_table.tx_insert(tx, hash, rc)?,
} }
Ok(matches!(new_rc, RcEntry::Deletable { .. })) Ok(matches!(new_rc.0, Some(RcEntry::Deletable { .. })))
} }
/// Read a block's reference count /// Read a block's reference counting state
pub(crate) fn get_block_rc(&self, hash: &Hash) -> Result<RcEntry, Error> { pub(crate) fn get_block_rc(&self, hash: &Hash) -> Result<RcState, Error> {
Ok(RcEntry::parse_opt(self.rc_table.get(hash.as_ref())?)) Ok(RcState(self.rc_table.get(hash)?))
}
/// Return the first hash stored in the RC table at or after `cursor`
pub fn get_first_hash_from(&self, cursor: Hash) -> Result<Option<Hash>, Error> {
Ok(self
.rc_table
.range(cursor..)?
.next()
.transpose()?
.map(|(k, _)| k))
} }
/// Delete an entry in the RC table if it is deletable and the /// Delete an entry in the RC table if it is deletable and the
@@ -66,12 +74,11 @@ impl BlockRc {
pub(crate) fn clear_deleted_block_rc(&self, hash: &Hash) -> Result<(), Error> { pub(crate) fn clear_deleted_block_rc(&self, hash: &Hash) -> Result<(), Error> {
let now = now_msec(); let now = now_msec();
self.rc_table.db().transaction(|tx| { self.rc_table.db().transaction(|tx| {
let rcval = RcEntry::parse_opt(tx.get(&self.rc_table, hash)?); let rcval = self.rc_table.tx_get(tx, hash)?;
match rcval { if let Some(RcEntry::Deletable { at_time }) = rcval {
RcEntry::Deletable { at_time } if now > at_time => { if now > at_time {
tx.remove(&self.rc_table, hash)?; self.rc_table.tx_remove(tx, hash)?;
} }
_ => (),
} }
Ok(()) Ok(())
})?; })?;
@@ -91,28 +98,25 @@ impl BlockRc {
for f in recalc_fns.iter() { for f in recalc_fns.iter() {
cnt += f(tx, hash)?; cnt += f(tx, hash)?;
} }
let old_rc = RcEntry::parse_opt(tx.get(&self.rc_table, hash)?); let old_count = RcState(self.rc_table.tx_get(tx, hash)?).as_u64();
trace!( trace!(
"Block RC for {:?}: stored={}, calculated={}", "Block RC for {:?}: stored={}, calculated={}",
hash, hash,
old_rc.as_u64(), old_count,
cnt cnt
); );
if cnt as u64 != old_rc.as_u64() { if cnt as u64 != old_count {
warn!( warn!(
"Fixing inconsistent block RC for {:?}: was {}, should be {}", "Fixing inconsistent block RC for {:?}: was {}, should be {}",
hash, hash, old_count, cnt
old_rc.as_u64(),
cnt
); );
let new_rc = if cnt > 0 { let new_rc = match NonZeroU64::new(cnt as u64) {
RcEntry::Present { count: cnt as u64 } Some(count) => RcEntry::Present { count },
} else { None => RcEntry::Deletable {
RcEntry::Deletable {
at_time: now_msec() + BLOCK_GC_DELAY.as_millis() as u64, at_time: now_msec() + BLOCK_GC_DELAY.as_millis() as u64,
} },
}; };
tx.insert(&self.rc_table, hash, new_rc.serialize().unwrap())?; self.rc_table.tx_insert(tx, hash, &new_rc)?;
Ok((cnt, true)) Ok((cnt, true))
} else { } else {
Ok((cnt, false)) Ok((cnt, false))
@@ -131,13 +135,47 @@ impl BlockRc {
} }
} }
/// Describes the state of the reference counter for a block impl db::DbBytes for RcEntry {
fn encode(&self) -> Vec<u8> {
match self {
RcEntry::Present { count } => u64::to_be_bytes(count.get()).to_vec(),
RcEntry::Deletable { at_time } => {
[u64::to_be_bytes(0), u64::to_be_bytes(*at_time)].concat()
}
}
}
fn decode(bytes: &[u8]) -> std::result::Result<Self, db::DecodeError> {
if bytes.len() == 8 {
let count = NonZeroU64::new(u64::from_be_bytes(bytes.try_into().unwrap()))
.ok_or(db::DecodeError("invalid RC entry: zero count".into()))?;
Ok(RcEntry::Present { count })
} else if bytes.len() == 16 {
Ok(RcEntry::Deletable {
at_time: u64::from_be_bytes(bytes[8..16].try_into().unwrap()),
})
} else {
Err(db::DecodeError(
format!(
"invalid RC entry: expected 8 or 16 bytes, got {}",
bytes.len()
)
.into(),
))
}
}
}
/// A block's entry in the RC table.
///
/// A block with zero references and no pending deletion has no entry
/// in the RC table at all: see [`RcState`].
#[derive(Clone, Copy, Debug)] #[derive(Clone, Copy, Debug)]
pub(crate) enum RcEntry { pub(crate) enum RcEntry {
/// Present: the block has `count` references, with `count` > 0. /// Present: the block has `count` references.
/// ///
/// This is stored as `u64::to_be_bytes(count)` /// This is stored as `u64::to_be_bytes(count)`
Present { count: u64 }, Present { count: NonZeroU64 },
/// Deletable: the block has zero references, and can be deleted /// Deletable: the block has zero references, and can be deleted
/// once time (returned by `now_msec`) is larger than `at_time` /// once time (returned by `now_msec`) is larger than `at_time`
@@ -147,72 +185,39 @@ pub(crate) enum RcEntry {
/// (this allows for the data format to be backwards compatible with /// (this allows for the data format to be backwards compatible with
/// previous Garage versions that didn't have this intermediate state) /// previous Garage versions that didn't have this intermediate state)
Deletable { at_time: u64 }, Deletable { at_time: u64 },
/// Absent: the block has zero references, and can be deleted
/// immediately
Absent,
} }
impl RcEntry { /// Describes the state of the reference counter for a block: the block's
fn parse(bytes: &[u8]) -> Self { /// entry in the RC table, or `None` if it has none, meaning the block has
if bytes.len() == 8 { /// zero references and can be deleted immediately.
RcEntry::Present { #[derive(Clone, Copy, Debug)]
count: u64::from_be_bytes(bytes.try_into().unwrap()), pub(crate) struct RcState(Option<RcEntry>);
}
} else if bytes.len() == 16 {
RcEntry::Deletable {
at_time: u64::from_be_bytes(bytes[8..16].try_into().unwrap()),
}
} else {
panic!("Invalid RC entry: {:?}, database is corrupted. This is an error Garage is currently unable to recover from. Sorry, and also please report a bug.",
bytes
)
}
}
fn parse_opt<V: AsRef<[u8]>>(bytes: Option<V>) -> Self { impl RcState {
bytes /// The new RC table entry after a reference is taken on the block
.map(|b| Self::parse(b.as_ref())) fn increment(&self) -> RcEntry {
.unwrap_or(Self::Absent) let count = match self.0 {
} Some(RcEntry::Present { count }) => count.saturating_add(1),
_ => NonZeroU64::new(1).unwrap(),
fn serialize(self) -> Option<Vec<u8>> {
match self {
RcEntry::Present { count } => Some(u64::to_be_bytes(count).to_vec()),
RcEntry::Deletable { at_time } => {
Some([u64::to_be_bytes(0), u64::to_be_bytes(at_time)].concat())
}
RcEntry::Absent => None,
}
}
fn increment(self) -> Self {
let old_count = match self {
RcEntry::Present { count } => count,
_ => 0,
}; };
RcEntry::Present { RcEntry::Present { count }
count: old_count + 1,
}
} }
fn decrement(self) -> Self { /// The new state after a reference to the block is dropped
match self { fn decrement(&self) -> Self {
RcEntry::Present { count } => { RcState(match self.0 {
if count > 1 { Some(RcEntry::Present { count }) => Some(match NonZeroU64::new(count.get() - 1) {
RcEntry::Present { count: count - 1 } Some(count) => RcEntry::Present { count },
} else { None => RcEntry::Deletable {
RcEntry::Deletable {
at_time: now_msec() + BLOCK_GC_DELAY.as_millis() as u64, at_time: now_msec() + BLOCK_GC_DELAY.as_millis() as u64,
} },
} }),
} unchanged => unchanged,
del => del, })
}
} }
pub(crate) fn is_zero(&self) -> bool { pub(crate) fn is_zero(&self) -> bool {
matches!(self, RcEntry::Deletable { .. } | RcEntry::Absent) matches!(self.0, None | Some(RcEntry::Deletable { .. }))
} }
pub(crate) fn is_nonzero(&self) -> bool { pub(crate) fn is_nonzero(&self) -> bool {
@@ -220,10 +225,10 @@ impl RcEntry {
} }
pub(crate) fn is_deletable(&self) -> bool { pub(crate) fn is_deletable(&self) -> bool {
match self { match self.0 {
RcEntry::Present { .. } => false, Some(RcEntry::Present { .. }) => false,
RcEntry::Deletable { at_time } => now_msec() > *at_time, Some(RcEntry::Deletable { at_time }) => now_msec() > at_time,
RcEntry::Absent => true, None => true,
} }
} }
@@ -232,8 +237,8 @@ impl RcEntry {
} }
pub(crate) fn as_u64(&self) -> u64 { pub(crate) fn as_u64(&self) -> u64 {
match self { match self.0 {
RcEntry::Present { count } => *count, Some(RcEntry::Present { count }) => count.get(),
_ => 0, _ => 0,
} }
} }
+2 -3
View File
@@ -102,16 +102,15 @@ impl Worker for RepairWorker {
let mut batch_of_hashes = vec![]; let mut batch_of_hashes = vec![];
let start_bound = match self.next_start.as_ref() { let start_bound = match self.next_start.as_ref() {
None => Bound::Unbounded, None => Bound::Unbounded,
Some(x) => Bound::Excluded(x.as_slice()), Some(x) => Bound::Excluded(*x),
}; };
for entry in self for entry in self
.manager .manager
.rc .rc
.rc_table .rc_table
.range::<&[u8], _>((start_bound, Bound::Unbounded))? .range((start_bound, Bound::Unbounded))?
{ {
let (hash, _) = entry?; let (hash, _) = entry?;
let hash = Hash::try_from(&hash[..]).unwrap();
batch_of_hashes.push(hash); batch_of_hashes.push(hash);
if batch_of_hashes.len() >= 1000 { if batch_of_hashes.len() >= 1000 {
break; break;
+106 -45
View File
@@ -44,15 +44,58 @@ pub(crate) const MAX_RESYNC_WORKERS: usize = 8;
const INITIAL_RESYNC_TRANQUILITY: u32 = 2; const INITIAL_RESYNC_TRANQUILITY: u32 = 2;
pub struct BlockResyncManager { pub struct BlockResyncManager {
pub(crate) queue: db::Tree, pub(crate) queue: db::TypedTree<ResyncQueueKey, Hash>,
pub(crate) notify: Arc<Notify>, pub(crate) notify: Arc<Notify>,
pub(crate) errors: db::Tree, pub(crate) errors: db::TypedTree<Hash, ErrorCounter>,
busy_set: BusySet, busy_set: BusySet,
persister: PersisterShared<ResyncPersistedConfig>, persister: PersisterShared<ResyncPersistedConfig>,
} }
/// Key of the resync queue tree: blocks are resynced in order of increasing
/// `when` (msec timestamp of the next try), with the block hash as tie-breaker.
///
// CAREFUL: this type implements `DbOrdKey`, so its byte encoding must be
// order-preserving.
// The derived `Ord` compares fields in declaration order, which must match
// the order in which `encode()` writes them; and `when` must remain an
// *unsigned* integer, as the big-endian encoding is only order-preserving
// for unsigned types.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub(crate) struct ResyncQueueKey {
pub(crate) when: u64,
pub(crate) hash: Hash,
}
impl db::DbBytes for ResyncQueueKey {
fn encode(&self) -> Vec<u8> {
let mut v = Vec::with_capacity(40);
v.extend_from_slice(&u64::to_be_bytes(self.when));
v.extend_from_slice(self.hash.as_slice());
v
}
fn decode(bytes: &[u8]) -> std::result::Result<Self, db::DecodeError> {
if bytes.len() != 40 {
return Err(db::DecodeError(
format!(
"invalid resync queue key: expected 40 bytes, got {}",
bytes.len()
)
.into(),
));
}
Ok(ResyncQueueKey {
when: u64::from_be_bytes(bytes[..8].try_into().unwrap()),
hash: Hash::try_from(&bytes[8..])
.ok_or_else(|| db::DecodeError("invalid resync queue key: bad hash".into()))?,
})
}
}
impl db::DbOrdKey for ResyncQueueKey {}
#[derive(Serialize, Deserialize, Clone, Copy)] #[derive(Serialize, Deserialize, Clone, Copy)]
struct ResyncPersistedConfig { struct ResyncPersistedConfig {
n_workers: usize, n_workers: usize,
@@ -74,22 +117,21 @@ enum ResyncIterResult {
IdleFor(Duration), IdleFor(Duration),
} }
type BusySet = Arc<Mutex<HashSet<Vec<u8>>>>; type BusySet = Arc<Mutex<HashSet<ResyncQueueKey>>>;
struct BusyBlock { struct BusyBlock {
time_bytes: Vec<u8>, key: ResyncQueueKey,
hash_bytes: Vec<u8>,
busy_set: BusySet, busy_set: BusySet,
} }
impl BlockResyncManager { impl BlockResyncManager {
pub(crate) fn new(db: &db::Db, system: &System) -> Self { pub(crate) fn new(db: &db::Db, system: &System) -> Self {
let queue = db let queue = db
.open_tree("block_local_resync_queue") .open_typed_tree("block_local_resync_queue")
.expect("Unable to open block_local_resync_queue tree"); .expect("Unable to open block_local_resync_queue tree");
let errors = db let errors = db
.open_tree("block_local_resync_errors") .open_typed_tree("block_local_resync_errors")
.expect("Unable to open block_local_resync_errors tree"); .expect("Unable to open block_local_resync_errors tree");
let persister = PersisterShared::new(&system.metadata_dir, "resync_cfg"); let persister = PersisterShared::new(&system.metadata_dir, "resync_cfg");
@@ -116,11 +158,10 @@ impl BlockResyncManager {
/// Clear the error counter for a block and put it in queue immediately /// Clear the error counter for a block and put it in queue immediately
pub fn clear_backoff(&self, hash: &Hash) -> Result<(), Error> { pub fn clear_backoff(&self, hash: &Hash) -> Result<(), Error> {
let now = now_msec(); let now = now_msec();
if let Some(ec) = self.errors.get(hash)? { if let Some(mut ec) = self.errors.get(hash)? {
let mut ec = ErrorCounter::decode(&ec);
if ec.errors > 0 { if ec.errors > 0 {
ec.last_try = now - ec.delay_msec(); ec.last_try = now - ec.delay_msec();
self.errors.insert(hash, ec.encode())?; self.errors.insert(hash, &ec)?;
self.put_to_resync_at(hash, now)?; self.put_to_resync_at(hash, now)?;
return Ok(()); return Ok(());
} }
@@ -251,23 +292,21 @@ impl BlockResyncManager {
pub(crate) fn put_to_resync_at(&self, hash: &Hash, when: u64) -> db::Result<()> { pub(crate) fn put_to_resync_at(&self, hash: &Hash, when: u64) -> db::Result<()> {
trace!("Put resync_queue: {} {:?}", when, hash); trace!("Put resync_queue: {} {:?}", when, hash);
let mut key = u64::to_be_bytes(when).to_vec(); let qkey = ResyncQueueKey { when, hash: *hash };
key.extend(hash.as_ref()); self.queue.insert(&qkey, hash)?;
self.queue.insert(key, hash.as_ref())?;
self.notify.notify_waiters(); self.notify.notify_waiters();
Ok(()) Ok(())
} }
async fn resync_iter(&self, manager: &BlockManager) -> Result<ResyncIterResult, db::Error> { async fn resync_iter(&self, manager: &BlockManager) -> Result<ResyncIterResult, db::Error> {
if let Some(block) = self.get_block_to_resync()? { if let Some(block) = self.get_block_to_resync()? {
let time_msec = u64::from_be_bytes(block.time_bytes[0..8].try_into().unwrap()); let time_msec = block.key.when;
let now = now_msec(); let now = now_msec();
if now >= time_msec { if now >= time_msec {
let hash = Hash::try_from(&block.hash_bytes[..]).unwrap(); let hash = block.key.hash;
if let Some(ec) = self.errors.get(hash.as_slice())? { if let Some(ec) = self.errors.get(&hash)? {
let ec = ErrorCounter::decode(&ec);
if now < ec.next_try() { if now < ec.next_try() {
// if next retry after an error is not yet, // if next retry after an error is not yet,
// don't do resync and return early, but still // don't do resync and return early, but still
@@ -277,7 +316,7 @@ impl BlockResyncManager {
// is not removing the one we added just above // is not removing the one we added just above
// (we want to do the remove after the insert to ensure // (we want to do the remove after the insert to ensure
// that the item is not lost if we crash in-between) // that the item is not lost if we crash in-between)
self.queue.remove(&block.time_bytes)?; self.queue.remove(&block.key)?;
return Ok(ResyncIterResult::BusyDidNothing); return Ok(ResyncIterResult::BusyDidNothing);
} }
} }
@@ -307,21 +346,21 @@ impl BlockResyncManager {
manager.metrics.resync_error_counter.add(1); manager.metrics.resync_error_counter.add(1);
error!("Error when resyncing {:?}: {}", hash, e); error!("Error when resyncing {:?}: {}", hash, e);
let err_counter = match self.errors.get(hash.as_slice())? { let err_counter = match self.errors.get(&hash)? {
Some(ec) => ErrorCounter::decode(&ec).add1(now + 1), Some(ec) => ec.add1(now + 1),
None => ErrorCounter::new(now + 1), None => ErrorCounter::new(now + 1),
}; };
self.errors.insert(hash.as_slice(), err_counter.encode())?; self.errors.insert(&hash, &err_counter)?;
self.put_to_resync_at(&hash, err_counter.next_try())?; self.put_to_resync_at(&hash, err_counter.next_try())?;
// err_counter.next_try() >= now + 1 > now, // err_counter.next_try() >= now + 1 > now,
// the entry we remove from the queue is not // the entry we remove from the queue is not
// the entry we inserted with put_to_resync_at // the entry we inserted with put_to_resync_at
self.queue.remove(&block.time_bytes)?; self.queue.remove(&block.key)?;
} else { } else {
self.errors.remove(hash.as_slice())?; self.errors.remove(&hash)?;
self.queue.remove(&block.time_bytes)?; self.queue.remove(&block.key)?;
} }
Ok(ResyncIterResult::BusyDidSomething) Ok(ResyncIterResult::BusyDidSomething)
@@ -344,12 +383,11 @@ impl BlockResyncManager {
fn get_block_to_resync(&self) -> Result<Option<BusyBlock>, db::Error> { fn get_block_to_resync(&self) -> Result<Option<BusyBlock>, db::Error> {
let mut busy = self.busy_set.lock().unwrap(); let mut busy = self.busy_set.lock().unwrap();
for it in self.queue.iter()? { for it in self.queue.iter()? {
let (time_bytes, hash_bytes) = it?; let (key, _) = it?;
if !busy.contains(&time_bytes) { if !busy.contains(&key) {
busy.insert(time_bytes.clone()); busy.insert(key);
return Ok(Some(BusyBlock { return Ok(Some(BusyBlock {
time_bytes, key,
hash_bytes,
busy_set: self.busy_set.clone(), busy_set: self.busy_set.clone(),
})); }));
} }
@@ -506,7 +544,7 @@ impl BlockResyncManager {
impl Drop for BusyBlock { impl Drop for BusyBlock {
fn drop(&mut self) { fn drop(&mut self) {
let mut busy = self.busy_set.lock().unwrap(); let mut busy = self.busy_set.lock().unwrap();
busy.remove(&self.time_bytes); busy.remove(&self.key);
} }
} }
@@ -516,6 +554,7 @@ pub(crate) struct ResyncWorker {
tranquilizer: Tranquilizer, tranquilizer: Tranquilizer,
next_delay: Duration, next_delay: Duration,
persister: PersisterShared<ResyncPersistedConfig>, persister: PersisterShared<ResyncPersistedConfig>,
had_decode_error: bool,
} }
impl ResyncWorker { impl ResyncWorker {
@@ -527,6 +566,7 @@ impl ResyncWorker {
tranquilizer: Tranquilizer::new(30), tranquilizer: Tranquilizer::new(30),
next_delay: Duration::from_secs(10), next_delay: Duration::from_secs(10),
persister, persister,
had_decode_error: false,
} }
} }
} }
@@ -574,6 +614,15 @@ impl Worker for ResyncWorker {
self.next_delay = delay; self.next_delay = delay;
Ok(WorkerState::Idle) Ok(WorkerState::Idle)
} }
Err(db::Error::Decode(e)) => {
// We give it one second chance in the very unlikely case that the bytes would somehow
// have been corrupted during read and that a new read would lead to a correct decoding.
if self.had_decode_error {
panic!("An error has happened when decoding something stored in the local k/v store: {}.", e);
}
self.had_decode_error = true;
Ok(WorkerState::Busy)
}
Err(e) => { Err(e) => {
// The errors that we have here are only db errors // The errors that we have here are only db errors
// We don't really know how to handle them so just ¯\_(ツ)_/¯ // We don't really know how to handle them so just ¯\_(ツ)_/¯
@@ -581,6 +630,7 @@ impl Worker for ResyncWorker {
// if it does there is not much we can do -- TODO should we just panic?) // if it does there is not much we can do -- TODO should we just panic?)
// Here we just give the error to the worker manager, // Here we just give the error to the worker manager,
// it will print it to the logs and increment a counter // it will print it to the logs and increment a counter
self.had_decode_error = false;
Err(e.into()) Err(e.into())
} }
} }
@@ -602,6 +652,7 @@ impl Worker for ResyncWorker {
/// Counts the number of errors when resyncing a block, /// Counts the number of errors when resyncing a block,
/// and the time of the last try. /// and the time of the last try.
///
/// Used to implement exponential backoff. /// Used to implement exponential backoff.
#[derive(Clone, Copy, Debug)] #[derive(Clone, Copy, Debug)]
pub(crate) struct ErrorCounter { pub(crate) struct ErrorCounter {
@@ -609,6 +660,31 @@ pub(crate) struct ErrorCounter {
pub(crate) last_try: u64, pub(crate) last_try: u64,
} }
impl db::DbBytes for ErrorCounter {
fn encode(&self) -> Vec<u8> {
let mut v = Vec::with_capacity(16);
v.extend_from_slice(&u64::to_be_bytes(self.errors));
v.extend_from_slice(&u64::to_be_bytes(self.last_try));
v
}
fn decode(bytes: &[u8]) -> std::result::Result<Self, db::DecodeError> {
if bytes.len() != 16 {
return Err(db::DecodeError(
format!(
"invalid error counter: expected 16 bytes, got {}",
bytes.len()
)
.into(),
));
}
Ok(Self {
errors: u64::from_be_bytes(bytes[..8].try_into().unwrap()),
last_try: u64::from_be_bytes(bytes[8..].try_into().unwrap()),
})
}
}
impl ErrorCounter { impl ErrorCounter {
fn new(now: u64) -> Self { fn new(now: u64) -> Self {
Self { Self {
@@ -617,21 +693,6 @@ impl ErrorCounter {
} }
} }
pub(crate) fn decode(data: &[u8]) -> Self {
Self {
errors: u64::from_be_bytes(data[0..8].try_into().unwrap()),
last_try: u64::from_be_bytes(data[8..16].try_into().unwrap()),
}
}
fn encode(&self) -> Vec<u8> {
[
u64::to_be_bytes(self.errors),
u64::to_be_bytes(self.last_try),
]
.concat()
}
fn add1(self, now: u64) -> Self { fn add1(self, now: u64) -> Self {
Self { Self {
errors: self.errors + 1, errors: self.errors + 1,
+56 -50
View File
@@ -12,7 +12,7 @@ use fjall::{
use crate::{ use crate::{
open::{Engine, OpenOpt}, open::{Engine, OpenOpt},
Db, Error, IDb, ITx, ITxFn, OnCommit, Result, TxError, TxFnResult, TxOpError, TxOpResult, Db, DbError, DbResult, Error, IDb, ITx, ITxFn, OnCommit, TxError, TxFnResult, TxOpError,
TxResult, TxValueIter, Value, ValueIter, TxResult, TxValueIter, Value, ValueIter,
}; };
@@ -20,10 +20,10 @@ pub use fjall;
// -- // --
pub(crate) fn open_db(path: &Path, opt: &OpenOpt) -> Result<Db> { pub(crate) fn open_db(path: &Path, opt: &OpenOpt) -> DbResult<Db> {
info!("Opening Fjall database at: {}", path.display()); info!("Opening Fjall database at: {}", path.display());
if opt.fsync { if opt.fsync {
return Err(Error( return Err(DbError(
"metadata_fsync is not supported with the Fjall database engine".into(), "metadata_fsync is not supported with the Fjall database engine".into(),
)); ));
} }
@@ -37,21 +37,27 @@ pub(crate) fn open_db(path: &Path, opt: &OpenOpt) -> Result<Db> {
// -- err // -- err
impl From<fjall::Error> for Error { impl From<fjall::Error> for DbError {
fn from(e: fjall::Error) -> Error { fn from(e: fjall::Error) -> DbError {
Error(format!("fjall: {}", e).into()) DbError(format!("fjall: {}", e).into())
} }
} }
impl From<fjall::LsmError> for Error { impl From<fjall::LsmError> for DbError {
fn from(e: fjall::LsmError) -> Error { fn from(e: fjall::LsmError) -> DbError {
Error(format!("fjall lsm_tree: {}", e).into()) DbError(format!("fjall lsm_tree: {}", e).into())
}
}
impl From<fjall::Error> for Error {
fn from(e: fjall::Error) -> Error {
Error::Db(DbError::from(e))
} }
} }
impl From<fjall::Error> for TxOpError { impl From<fjall::Error> for TxOpError {
fn from(e: fjall::Error) -> TxOpError { fn from(e: fjall::Error) -> TxOpError {
TxOpError(e.into()) DbError::from(e).into()
} }
} }
@@ -76,11 +82,11 @@ impl FjallDb {
fn get_tree( fn get_tree(
&self, &self,
i: usize, i: usize,
) -> Result<MappedRwLockReadGuard<'_, TransactionalPartitionHandle>> { ) -> DbResult<MappedRwLockReadGuard<'_, TransactionalPartitionHandle>> {
RwLockReadGuard::try_map(self.trees.read(), |trees: &Vec<_>| { RwLockReadGuard::try_map(self.trees.read(), |trees: &Vec<_>| {
trees.get(i).map(|tup| &tup.1) trees.get(i).map(|tup| &tup.1)
}) })
.map_err(|_| Error("invalid tree id".into())) .map_err(|_| DbError("invalid tree id".into()))
} }
} }
@@ -89,7 +95,7 @@ impl IDb for FjallDb {
"Fjall (EXPERIMENTAL!)".into() "Fjall (EXPERIMENTAL!)".into()
} }
fn open_tree(&self, name: &str) -> Result<usize> { fn open_tree(&self, name: &str) -> DbResult<usize> {
let mut trees = self.trees.write(); let mut trees = self.trees.write();
let safe_name = encode_name(name)?; let safe_name = encode_name(name)?;
if let Some(i) = trees.iter().position(|(name, _)| *name == safe_name) { if let Some(i) = trees.iter().position(|(name, _)| *name == safe_name) {
@@ -104,15 +110,15 @@ impl IDb for FjallDb {
} }
} }
fn list_trees(&self) -> Result<Vec<String>> { fn list_trees(&self) -> DbResult<Vec<String>> {
self.keyspace self.keyspace
.list_partitions() .list_partitions()
.iter() .iter()
.map(|n| decode_name(n)) .map(|n| decode_name(n))
.collect::<Result<Vec<_>>>() .collect::<DbResult<Vec<_>>>()
} }
fn snapshot(&self, base_path: &Path) -> Result<()> { fn snapshot(&self, base_path: &Path) -> DbResult<()> {
std::fs::create_dir_all(base_path)?; std::fs::create_dir_all(base_path)?;
let path = Engine::Fjall.db_path(base_path); let path = Engine::Fjall.db_path(base_path);
@@ -138,7 +144,7 @@ impl IDb for FjallDb {
// ---- // ----
fn get(&self, tree_idx: usize, key: &[u8]) -> Result<Option<Value>> { fn get(&self, tree_idx: usize, key: &[u8]) -> DbResult<Option<Value>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let tx = self.keyspace.read_tx(); let tx = self.keyspace.read_tx();
let val = tx.get(&tree, key)?; let val = tx.get(&tree, key)?;
@@ -148,17 +154,17 @@ impl IDb for FjallDb {
} }
} }
fn approximate_len(&self, tree_idx: usize) -> Result<usize> { fn approximate_len(&self, tree_idx: usize) -> DbResult<usize> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
Ok(tree.approximate_len()) Ok(tree.approximate_len())
} }
fn is_empty(&self, tree_idx: usize) -> Result<bool> { fn is_empty(&self, tree_idx: usize) -> DbResult<bool> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let tx = self.keyspace.read_tx(); let tx = self.keyspace.read_tx();
Ok(tx.is_empty(&tree)?) Ok(tx.is_empty(&tree)?)
} }
fn insert(&self, tree_idx: usize, key: &[u8], value: &[u8]) -> Result<()> { fn insert(&self, tree_idx: usize, key: &[u8], value: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let mut tx = self.keyspace.write_tx(); let mut tx = self.keyspace.write_tx();
tx.insert(&tree, key, value); tx.insert(&tree, key, value);
@@ -166,7 +172,7 @@ impl IDb for FjallDb {
Ok(()) Ok(())
} }
fn remove(&self, tree_idx: usize, key: &[u8]) -> Result<()> { fn remove(&self, tree_idx: usize, key: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let mut tx = self.keyspace.write_tx(); let mut tx = self.keyspace.write_tx();
tx.remove(&tree, key); tx.remove(&tree, key);
@@ -174,11 +180,11 @@ impl IDb for FjallDb {
Ok(()) Ok(())
} }
fn clear(&self, tree_idx: usize) -> Result<()> { fn clear(&self, tree_idx: usize) -> DbResult<()> {
let mut trees = self.trees.write(); let mut trees = self.trees.write();
if tree_idx >= trees.len() { if tree_idx >= trees.len() {
return Err(Error("invalid tree id".into())); return Err(DbError("invalid tree id".into()));
} }
let (name, tree) = trees.remove(tree_idx); let (name, tree) = trees.remove(tree_idx);
@@ -191,13 +197,13 @@ impl IDb for FjallDb {
Ok(()) Ok(())
} }
fn iter(&self, tree_idx: usize) -> Result<ValueIter<'_>> { fn iter(&self, tree_idx: usize) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let tx = self.keyspace.read_tx(); let tx = self.keyspace.read_tx();
Ok(Box::new(tx.iter(&tree).map(iterator_remap))) Ok(Box::new(tx.iter(&tree).map(iterator_remap)))
} }
fn iter_rev(&self, tree_idx: usize) -> Result<ValueIter<'_>> { fn iter_rev(&self, tree_idx: usize) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let tx = self.keyspace.read_tx(); let tx = self.keyspace.read_tx();
Ok(Box::new(tx.iter(&tree).rev().map(iterator_remap))) Ok(Box::new(tx.iter(&tree).rev().map(iterator_remap)))
@@ -208,7 +214,7 @@ impl IDb for FjallDb {
tree_idx: usize, tree_idx: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>> { ) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let tx = self.keyspace.read_tx(); let tx = self.keyspace.read_tx();
Ok(Box::new( Ok(Box::new(
@@ -221,7 +227,7 @@ impl IDb for FjallDb {
tree_idx: usize, tree_idx: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>> { ) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let tx = self.keyspace.read_tx(); let tx = self.keyspace.read_tx();
Ok(Box::new( Ok(Box::new(
@@ -252,9 +258,9 @@ impl IDb for FjallDb {
} }
TxFnResult::DbErr => { TxFnResult::DbErr => {
tx.tx.rollback(); tx.tx.rollback();
Err(TxError::Db(Error( Err(TxError::Db(
"(this message will be discarded)".into(), DbError("(this message will be discarded)".into()).into(),
))) ))
} }
} }
} }
@@ -268,47 +274,47 @@ struct FjallTx<'a> {
} }
impl<'a> FjallTx<'a> { impl<'a> FjallTx<'a> {
fn get_tree(&self, i: usize) -> TxOpResult<&TransactionalPartitionHandle> { fn get_tree(&self, i: usize) -> DbResult<&TransactionalPartitionHandle> {
self.trees.get(i).map(|tup| &tup.1).ok_or_else(|| { self.trees.get(i).map(|tup| &tup.1).ok_or_else(|| {
TxOpError(Error( DbError(
"invalid tree id (it might have been opened after the transaction started)".into(), "invalid tree id (it might have been opened after the transaction started)".into(),
)) )
}) })
} }
} }
impl<'a> ITx for FjallTx<'a> { impl<'a> ITx for FjallTx<'a> {
fn get(&self, tree_idx: usize, key: &[u8]) -> TxOpResult<Option<Value>> { fn get(&self, tree_idx: usize, key: &[u8]) -> DbResult<Option<Value>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
match self.tx.get(tree, key)? { match self.tx.get(tree, key)? {
Some(v) => Ok(Some(v.to_vec())), Some(v) => Ok(Some(v.to_vec())),
None => Ok(None), None => Ok(None),
} }
} }
fn len(&self, tree_idx: usize) -> TxOpResult<usize> { fn len(&self, tree_idx: usize) -> DbResult<usize> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
Ok(self.tx.len(tree)?) Ok(self.tx.len(tree)?)
} }
fn insert(&mut self, tree_idx: usize, key: &[u8], value: &[u8]) -> TxOpResult<()> { fn insert(&mut self, tree_idx: usize, key: &[u8], value: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree_idx)?.clone(); let tree = self.get_tree(tree_idx)?.clone();
self.tx.insert(&tree, key, value); self.tx.insert(&tree, key, value);
Ok(()) Ok(())
} }
fn remove(&mut self, tree_idx: usize, key: &[u8]) -> TxOpResult<()> { fn remove(&mut self, tree_idx: usize, key: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree_idx)?.clone(); let tree = self.get_tree(tree_idx)?.clone();
self.tx.remove(&tree, key); self.tx.remove(&tree, key);
Ok(()) Ok(())
} }
fn clear(&mut self, _tree_idx: usize) -> TxOpResult<()> { fn clear(&mut self, _tree_idx: usize) -> DbResult<()> {
unimplemented!("LSM tree clearing in cross-partition transaction is not supported") unimplemented!("LSM tree clearing in cross-partition transaction is not supported")
} }
fn iter(&self, tree_idx: usize) -> TxOpResult<TxValueIter<'_>> { fn iter(&self, tree_idx: usize) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree_idx)?.clone(); let tree = self.get_tree(tree_idx)?.clone();
Ok(Box::new(self.tx.iter(&tree).map(iterator_remap_tx))) Ok(Box::new(self.tx.iter(&tree).map(iterator_remap_tx)))
} }
fn iter_rev(&self, tree_idx: usize) -> TxOpResult<TxValueIter<'_>> { fn iter_rev(&self, tree_idx: usize) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree_idx)?.clone(); let tree = self.get_tree(tree_idx)?.clone();
Ok(Box::new(self.tx.iter(&tree).rev().map(iterator_remap_tx))) Ok(Box::new(self.tx.iter(&tree).rev().map(iterator_remap_tx)))
} }
@@ -318,7 +324,7 @@ impl<'a> ITx for FjallTx<'a> {
tree_idx: usize, tree_idx: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>> { ) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let low = clone_bound(low); let low = clone_bound(low);
let high = clone_bound(high); let high = clone_bound(high);
@@ -333,7 +339,7 @@ impl<'a> ITx for FjallTx<'a> {
tree_idx: usize, tree_idx: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>> { ) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree_idx)?; let tree = self.get_tree(tree_idx)?;
let low = clone_bound(low); let low = clone_bound(low);
let high = clone_bound(high); let high = clone_bound(high);
@@ -348,14 +354,14 @@ impl<'a> ITx for FjallTx<'a> {
// -- maps fjall's (k, v) to ours // -- maps fjall's (k, v) to ours
fn iterator_remap(r: fjall::Result<(fjall::Slice, fjall::Slice)>) -> Result<(Value, Value)> { fn iterator_remap(r: fjall::Result<(fjall::Slice, fjall::Slice)>) -> DbResult<(Value, Value)> {
r.map(|(k, v)| (k.to_vec(), v.to_vec())) r.map(|(k, v)| (k.to_vec(), v.to_vec()))
.map_err(|e| e.into()) .map_err(DbError::from)
} }
fn iterator_remap_tx(r: fjall::Result<(fjall::Slice, fjall::Slice)>) -> TxOpResult<(Value, Value)> { fn iterator_remap_tx(r: fjall::Result<(fjall::Slice, fjall::Slice)>) -> DbResult<(Value, Value)> {
r.map(|(k, v)| (k.to_vec(), v.to_vec())) r.map(|(k, v)| (k.to_vec(), v.to_vec()))
.map_err(|e| e.into()) .map_err(DbError::from)
} }
// -- utils to deal with Garage's tightness on Bound lifetimes // -- utils to deal with Garage's tightness on Bound lifetimes
@@ -378,7 +384,7 @@ fn clone_bound(bound: Bound<&[u8]>) -> ByteVecBound {
// -- utils to encode table names -- // -- utils to encode table names --
fn encode_name(s: &str) -> Result<String> { fn encode_name(s: &str) -> DbResult<String> {
let base = 'A' as u32; let base = 'A' as u32;
let mut ret = String::with_capacity(s.len() + 10); let mut ret = String::with_capacity(s.len() + 10);
@@ -392,7 +398,7 @@ fn encode_name(s: &str) -> Result<String> {
ret.push(char::from_u32(base + c_hi).unwrap()); ret.push(char::from_u32(base + c_hi).unwrap());
ret.push(char::from_u32(base + c_lo).unwrap()); ret.push(char::from_u32(base + c_lo).unwrap());
} else { } else {
return Err(Error( return Err(DbError(
format!("table name {} could not be safely encoded", s).into(), format!("table name {} could not be safely encoded", s).into(),
)); ));
} }
@@ -400,10 +406,10 @@ fn encode_name(s: &str) -> Result<String> {
Ok(ret) Ok(ret)
} }
fn decode_name(s: &str) -> Result<String> { fn decode_name(s: &str) -> DbResult<String> {
use std::convert::TryFrom; use std::convert::TryFrom;
let errfn = || Error(format!("encoded table name {} is invalid", s).into()); let errfn = || DbError(format!("encoded table name {} is invalid", s).into());
let c_map = |c: char| { let c_map = |c: char| {
let c = c as u32; let c = c as u32;
let base = 'A' as u32; let base = 'A' as u32;
+97 -57
View File
@@ -9,6 +9,7 @@ pub mod lmdb_adapter;
pub mod sqlite_adapter; pub mod sqlite_adapter;
pub mod open; pub mod open;
pub mod typed;
#[cfg(test)] #[cfg(test)]
pub mod test; pub mod test;
@@ -23,6 +24,7 @@ use std::sync::Arc;
use thiserror::Error; use thiserror::Error;
pub use open::*; pub use open::*;
pub use typed::{DbBytes, DbOrdKey, TypedIter, TypedTree, TypedTxIter};
pub(crate) type OnCommit = Vec<Box<dyn FnOnce()>>; pub(crate) type OnCommit = Vec<Box<dyn FnOnce()>>;
@@ -38,21 +40,34 @@ pub struct Transaction<'a> {
pub struct Tree(Arc<dyn IDb>, usize); pub struct Tree(Arc<dyn IDb>, usize);
pub type Value = Vec<u8>; pub type Value = Vec<u8>;
pub type ValueIter<'a> = Box<dyn std::iter::Iterator<Item = Result<(Value, Value)>> + 'a>; pub type ValueIter<'a> = Box<dyn std::iter::Iterator<Item = DbResult<(Value, Value)>> + 'a>;
pub type TxValueIter<'a> = Box<dyn std::iter::Iterator<Item = TxOpResult<(Value, Value)>> + 'a>; pub type TxValueIter<'a> = Box<dyn std::iter::Iterator<Item = DbResult<(Value, Value)>> + 'a>;
// ---- // ----
#[derive(Debug, Error)] #[derive(Debug, Error)]
#[error("{0}")] #[error("database error: {0}")]
pub struct Error(pub Cow<'static, str>); pub struct DbError(pub Cow<'static, str>);
impl From<std::io::Error> for Error { #[derive(Debug, Error)]
fn from(e: std::io::Error) -> Error { #[error("decode error: {0}")]
Error(format!("IO: {}", e).into()) pub struct DecodeError(pub Cow<'static, str>);
#[derive(Debug, Error)]
pub enum Error {
#[error(transparent)]
Db(#[from] DbError),
#[error(transparent)]
Decode(#[from] DecodeError),
}
impl From<std::io::Error> for DbError {
fn from(e: std::io::Error) -> DbError {
DbError(format!("IO: {}", e).into())
} }
} }
pub type DbResult<T> = std::result::Result<T, DbError>;
pub type Result<T> = std::result::Result<T, Error>; pub type Result<T> = std::result::Result<T, Error>;
#[derive(Debug, Error)] #[derive(Debug, Error)]
@@ -60,6 +75,18 @@ pub type Result<T> = std::result::Result<T, Error>;
pub struct TxOpError(pub(crate) Error); pub struct TxOpError(pub(crate) Error);
pub type TxOpResult<T> = std::result::Result<T, TxOpError>; pub type TxOpResult<T> = std::result::Result<T, TxOpError>;
impl From<DbError> for TxOpError {
fn from(e: DbError) -> TxOpError {
TxOpError(e.into())
}
}
impl From<DecodeError> for TxOpError {
fn from(e: DecodeError) -> TxOpError {
TxOpError(e.into())
}
}
#[derive(Debug)] #[derive(Debug)]
pub enum TxError<E> { pub enum TxError<E> {
Abort(E), Abort(E),
@@ -73,6 +100,12 @@ impl<E> From<TxOpError> for TxError<E> {
} }
} }
impl<E> From<DbError> for TxError<E> {
fn from(e: DbError) -> TxError<E> {
TxError::Db(e.into())
}
}
pub fn unabort<R, E>(res: TxResult<R, E>) -> TxOpResult<std::result::Result<R, E>> { pub fn unabort<R, E>(res: TxResult<R, E>) -> TxOpResult<std::result::Result<R, E>> {
match res { match res {
Ok(v) => Ok(Ok(v)), Ok(v) => Ok(Ok(v)),
@@ -88,12 +121,12 @@ impl Db {
self.0.engine() self.0.engine()
} }
pub fn open_tree<S: AsRef<str>>(&self, name: S) -> Result<Tree> { pub fn open_tree<S: AsRef<str>>(&self, name: S) -> DbResult<Tree> {
let tree_id = self.0.open_tree(name.as_ref())?; let tree_id = self.0.open_tree(name.as_ref())?;
Ok(Tree(self.0.clone(), tree_id)) Ok(Tree(self.0.clone(), tree_id))
} }
pub fn list_trees(&self) -> Result<Vec<String>> { pub fn list_trees(&self) -> DbResult<Vec<String>> {
self.0.list_trees() self.0.list_trees()
} }
@@ -147,27 +180,28 @@ impl Db {
} }
} }
pub fn snapshot(&self, path: &Path) -> Result<()> { pub fn snapshot(&self, path: &Path) -> DbResult<()> {
self.0.snapshot(path) self.0.snapshot(path)
} }
pub fn import(&self, other: &Db) -> Result<()> { pub fn import(&self, other: &Db) -> Result<()> {
let existing_trees = self.list_trees()?; let existing_trees = self.list_trees()?;
if !existing_trees.is_empty() { if !existing_trees.is_empty() {
return Err(Error( return Err(DbError(
format!( format!(
"destination database already contains data: {:?}", "destination database already contains data: {:?}",
existing_trees existing_trees
) )
.into(), .into(),
)); )
.into());
} }
let tree_names = other.list_trees()?; let tree_names = other.list_trees()?;
for name in tree_names { for name in tree_names {
let tree = self.open_tree(&name)?; let tree = self.open_tree(&name)?;
if !tree.is_empty()? { if !tree.is_empty()? {
return Err(Error(format!("tree {} already contains data", name).into())); return Err(DbError(format!("tree {} already contains data", name).into()).into());
} }
let ex_tree = other.open_tree(&name)?; let ex_tree = other.open_tree(&name)?;
@@ -186,7 +220,7 @@ impl Db {
}); });
let total = match tx_res { let total = match tx_res {
Err(TxError::Db(e)) => return Err(e), Err(TxError::Db(e)) => return Err(e),
Err(TxError::Abort(e)) => return Err(e), Err(TxError::Abort(e)) => return Err(e.into()),
Ok(x) => x, Ok(x) => x,
}; };
@@ -204,24 +238,24 @@ impl Tree {
} }
#[inline] #[inline]
pub fn get<T: AsRef<[u8]>>(&self, key: T) -> Result<Option<Value>> { pub fn get<T: AsRef<[u8]>>(&self, key: T) -> DbResult<Option<Value>> {
self.0.get(self.1, key.as_ref()) self.0.get(self.1, key.as_ref())
} }
#[inline] #[inline]
pub fn approximate_len(&self) -> Result<usize> { pub fn approximate_len(&self) -> DbResult<usize> {
self.0.approximate_len(self.1) self.0.approximate_len(self.1)
} }
#[inline] #[inline]
pub fn is_empty(&self) -> Result<bool> { pub fn is_empty(&self) -> DbResult<bool> {
self.0.is_empty(self.1) self.0.is_empty(self.1)
} }
#[inline] #[inline]
pub fn first(&self) -> Result<Option<(Value, Value)>> { pub fn first(&self) -> DbResult<Option<(Value, Value)>> {
self.iter()?.next().transpose() self.iter()?.next().transpose()
} }
#[inline] #[inline]
pub fn get_gt<T: AsRef<[u8]>>(&self, from: T) -> Result<Option<(Value, Value)>> { pub fn get_gt<T: AsRef<[u8]>>(&self, from: T) -> DbResult<Option<(Value, Value)>> {
if from.as_ref().is_empty() { if from.as_ref().is_empty() {
self.iter()?.next().transpose() self.iter()?.next().transpose()
} else { } else {
@@ -233,31 +267,31 @@ impl Tree {
/// Returns the old value if there was one /// Returns the old value if there was one
#[inline] #[inline]
pub fn insert<T: AsRef<[u8]>, U: AsRef<[u8]>>(&self, key: T, value: U) -> Result<()> { pub fn insert<T: AsRef<[u8]>, U: AsRef<[u8]>>(&self, key: T, value: U) -> DbResult<()> {
self.0.insert(self.1, key.as_ref(), value.as_ref()) self.0.insert(self.1, key.as_ref(), value.as_ref())
} }
/// Returns the old value if there was one /// Returns the old value if there was one
#[inline] #[inline]
pub fn remove<T: AsRef<[u8]>>(&self, key: T) -> Result<()> { pub fn remove<T: AsRef<[u8]>>(&self, key: T) -> DbResult<()> {
self.0.remove(self.1, key.as_ref()) self.0.remove(self.1, key.as_ref())
} }
/// Clears all values from the tree /// Clears all values from the tree
#[inline] #[inline]
pub fn clear(&self) -> Result<()> { pub fn clear(&self) -> DbResult<()> {
self.0.clear(self.1) self.0.clear(self.1)
} }
#[inline] #[inline]
pub fn iter(&self) -> Result<ValueIter<'_>> { pub fn iter(&self) -> DbResult<ValueIter<'_>> {
self.0.iter(self.1) self.0.iter(self.1)
} }
#[inline] #[inline]
pub fn iter_rev(&self) -> Result<ValueIter<'_>> { pub fn iter_rev(&self) -> DbResult<ValueIter<'_>> {
self.0.iter_rev(self.1) self.0.iter_rev(self.1)
} }
#[inline] #[inline]
pub fn range<K, R>(&self, range: R) -> Result<ValueIter<'_>> pub fn range<K, R>(&self, range: R) -> DbResult<ValueIter<'_>>
where where
K: AsRef<[u8]>, K: AsRef<[u8]>,
R: RangeBounds<K>, R: RangeBounds<K>,
@@ -267,7 +301,7 @@ impl Tree {
self.0.range(self.1, get_bound(sb), get_bound(eb)) self.0.range(self.1, get_bound(sb), get_bound(eb))
} }
#[inline] #[inline]
pub fn range_rev<K, R>(&self, range: R) -> Result<ValueIter<'_>> pub fn range_rev<K, R>(&self, range: R) -> DbResult<ValueIter<'_>>
where where
K: AsRef<[u8]>, K: AsRef<[u8]>,
R: RangeBounds<K>, R: RangeBounds<K>,
@@ -282,11 +316,11 @@ impl Tree {
impl<'a> Transaction<'a> { impl<'a> Transaction<'a> {
#[inline] #[inline]
pub fn get<T: AsRef<[u8]>>(&self, tree: &Tree, key: T) -> TxOpResult<Option<Value>> { pub fn get<T: AsRef<[u8]>>(&self, tree: &Tree, key: T) -> TxOpResult<Option<Value>> {
self.tx.get(tree.1, key.as_ref()) self.tx.get(tree.1, key.as_ref()).map_err(Into::into)
} }
#[inline] #[inline]
pub fn len(&self, tree: &Tree) -> TxOpResult<usize> { pub fn len(&self, tree: &Tree) -> TxOpResult<usize> {
self.tx.len(tree.1) self.tx.len(tree.1).map_err(Into::into)
} }
/// Returns the old value if there was one /// Returns the old value if there was one
@@ -297,26 +331,28 @@ impl<'a> Transaction<'a> {
key: T, key: T,
value: U, value: U,
) -> TxOpResult<()> { ) -> TxOpResult<()> {
self.tx.insert(tree.1, key.as_ref(), value.as_ref()) self.tx
.insert(tree.1, key.as_ref(), value.as_ref())
.map_err(Into::into)
} }
/// Returns the old value if there was one /// Returns the old value if there was one
#[inline] #[inline]
pub fn remove<T: AsRef<[u8]>>(&mut self, tree: &Tree, key: T) -> TxOpResult<()> { pub fn remove<T: AsRef<[u8]>>(&mut self, tree: &Tree, key: T) -> TxOpResult<()> {
self.tx.remove(tree.1, key.as_ref()) self.tx.remove(tree.1, key.as_ref()).map_err(Into::into)
} }
/// Clears all values in a tree /// Clears all values in a tree
#[inline] #[inline]
pub fn clear(&mut self, tree: &Tree) -> TxOpResult<()> { pub fn clear(&mut self, tree: &Tree) -> TxOpResult<()> {
self.tx.clear(tree.1) self.tx.clear(tree.1).map_err(Into::into)
} }
#[inline] #[inline]
pub fn iter(&self, tree: &Tree) -> TxOpResult<TxValueIter<'_>> { pub fn iter(&self, tree: &Tree) -> TxOpResult<TxValueIter<'_>> {
self.tx.iter(tree.1) self.tx.iter(tree.1).map_err(Into::into)
} }
#[inline] #[inline]
pub fn iter_rev(&self, tree: &Tree) -> TxOpResult<TxValueIter<'_>> { pub fn iter_rev(&self, tree: &Tree) -> TxOpResult<TxValueIter<'_>> {
self.tx.iter_rev(tree.1) self.tx.iter_rev(tree.1).map_err(Into::into)
} }
#[inline] #[inline]
@@ -327,7 +363,9 @@ impl<'a> Transaction<'a> {
{ {
let sb = range.start_bound(); let sb = range.start_bound();
let eb = range.end_bound(); let eb = range.end_bound();
self.tx.range(tree.1, get_bound(sb), get_bound(eb)) self.tx
.range(tree.1, get_bound(sb), get_bound(eb))
.map_err(Into::into)
} }
#[inline] #[inline]
pub fn range_rev<K, R>(&self, tree: &Tree, range: R) -> TxOpResult<TxValueIter<'_>> pub fn range_rev<K, R>(&self, tree: &Tree, range: R) -> TxOpResult<TxValueIter<'_>>
@@ -337,7 +375,9 @@ impl<'a> Transaction<'a> {
{ {
let sb = range.start_bound(); let sb = range.start_bound();
let eb = range.end_bound(); let eb = range.end_bound();
self.tx.range_rev(tree.1, get_bound(sb), get_bound(eb)) self.tx
.range_rev(tree.1, get_bound(sb), get_bound(eb))
.map_err(Into::into)
} }
#[inline] #[inline]
@@ -350,60 +390,60 @@ impl<'a> Transaction<'a> {
pub(crate) trait IDb: Send + Sync { pub(crate) trait IDb: Send + Sync {
fn engine(&self) -> String; fn engine(&self) -> String;
fn open_tree(&self, name: &str) -> Result<usize>; fn open_tree(&self, name: &str) -> DbResult<usize>;
fn list_trees(&self) -> Result<Vec<String>>; fn list_trees(&self) -> DbResult<Vec<String>>;
fn snapshot(&self, path: &Path) -> Result<()>; fn snapshot(&self, path: &Path) -> DbResult<()>;
fn get(&self, tree: usize, key: &[u8]) -> Result<Option<Value>>; fn get(&self, tree: usize, key: &[u8]) -> DbResult<Option<Value>>;
fn approximate_len(&self, tree: usize) -> Result<usize>; fn approximate_len(&self, tree: usize) -> DbResult<usize>;
fn is_empty(&self, tree: usize) -> Result<bool>; fn is_empty(&self, tree: usize) -> DbResult<bool>;
fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> Result<()>; fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> DbResult<()>;
fn remove(&self, tree: usize, key: &[u8]) -> Result<()>; fn remove(&self, tree: usize, key: &[u8]) -> DbResult<()>;
fn clear(&self, tree: usize) -> Result<()>; fn clear(&self, tree: usize) -> DbResult<()>;
fn iter(&self, tree: usize) -> Result<ValueIter<'_>>; fn iter(&self, tree: usize) -> DbResult<ValueIter<'_>>;
fn iter_rev(&self, tree: usize) -> Result<ValueIter<'_>>; fn iter_rev(&self, tree: usize) -> DbResult<ValueIter<'_>>;
fn range<'r>( fn range<'r>(
&self, &self,
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>>; ) -> DbResult<ValueIter<'_>>;
fn range_rev<'r>( fn range_rev<'r>(
&self, &self,
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>>; ) -> DbResult<ValueIter<'_>>;
fn transaction(&self, f: &dyn ITxFn) -> TxResult<OnCommit, ()>; fn transaction(&self, f: &dyn ITxFn) -> TxResult<OnCommit, ()>;
} }
pub(crate) trait ITx { pub(crate) trait ITx {
fn get(&self, tree: usize, key: &[u8]) -> TxOpResult<Option<Value>>; fn get(&self, tree: usize, key: &[u8]) -> DbResult<Option<Value>>;
fn len(&self, tree: usize) -> TxOpResult<usize>; fn len(&self, tree: usize) -> DbResult<usize>;
fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> TxOpResult<()>; fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> DbResult<()>;
fn remove(&mut self, tree: usize, key: &[u8]) -> TxOpResult<()>; fn remove(&mut self, tree: usize, key: &[u8]) -> DbResult<()>;
fn clear(&mut self, tree: usize) -> TxOpResult<()>; fn clear(&mut self, tree: usize) -> DbResult<()>;
fn iter(&self, tree: usize) -> TxOpResult<TxValueIter<'_>>; fn iter(&self, tree: usize) -> DbResult<TxValueIter<'_>>;
fn iter_rev(&self, tree: usize) -> TxOpResult<TxValueIter<'_>>; fn iter_rev(&self, tree: usize) -> DbResult<TxValueIter<'_>>;
fn range<'r>( fn range<'r>(
&self, &self,
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>>; ) -> DbResult<TxValueIter<'_>>;
fn range_rev<'r>( fn range_rev<'r>(
&self, &self,
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>>; ) -> DbResult<TxValueIter<'_>>;
} }
pub(crate) trait ITxFn { pub(crate) trait ITxFn {
+49 -43
View File
@@ -14,7 +14,7 @@ type Database = heed::Database<Bytes, Bytes>;
use crate::{ use crate::{
open::{Engine, OpenOpt}, open::{Engine, OpenOpt},
Db, Error, IDb, ITx, ITxFn, OnCommit, Result, TxError, TxFnResult, TxOpError, TxOpResult, Db, DbError, DbResult, Error, IDb, ITx, ITxFn, OnCommit, TxError, TxFnResult, TxOpError,
TxResult, TxValueIter, Value, ValueIter, TxResult, TxValueIter, Value, ValueIter,
}; };
@@ -22,10 +22,10 @@ pub use heed;
// ---- top-level open function // ---- top-level open function
pub(crate) fn open_db(path: &PathBuf, opt: &OpenOpt) -> Result<Db> { pub(crate) fn open_db(path: &PathBuf, opt: &OpenOpt) -> DbResult<Db> {
info!("Opening LMDB database at: {}", path.display()); info!("Opening LMDB database at: {}", path.display());
if let Err(e) = std::fs::create_dir_all(path) { if let Err(e) = std::fs::create_dir_all(path) {
return Err(Error( return Err(DbError(
format!("Unable to create LMDB data directory: {}", e).into(), format!("Unable to create LMDB data directory: {}", e).into(),
)); ));
} }
@@ -48,7 +48,7 @@ pub(crate) fn open_db(path: &PathBuf, opt: &OpenOpt) -> Result<Db> {
env_builder.open(path) env_builder.open(path)
}; };
match open_res { match open_res {
Err(heed::Error::Io(e)) if e.kind() == std::io::ErrorKind::OutOfMemory => Err(Error( Err(heed::Error::Io(e)) if e.kind() == std::io::ErrorKind::OutOfMemory => Err(DbError(
"OutOfMemory error while trying to open LMDB database. This can happen \ "OutOfMemory error while trying to open LMDB database. This can happen \
if your operating system is not allowing you to use sufficient virtual \ if your operating system is not allowing you to use sufficient virtual \
memory address space. Please check that no limit is set (ulimit -v). \ memory address space. Please check that no limit is set (ulimit -v). \
@@ -56,22 +56,28 @@ pub(crate) fn open_db(path: &PathBuf, opt: &OpenOpt) -> Result<Db> {
On 32-bit machines, you should probably switch to another database engine." On 32-bit machines, you should probably switch to another database engine."
.into(), .into(),
)), )),
Err(e) => Err(Error(format!("Cannot open LMDB database: {}", e).into())), Err(e) => Err(DbError(format!("Cannot open LMDB database: {}", e).into())),
Ok(db) => Ok(LmdbDb::init(db)), Ok(db) => Ok(LmdbDb::init(db)),
} }
} }
// -- err // -- err
impl From<heed::Error> for DbError {
fn from(e: heed::Error) -> DbError {
DbError(format!("LMDB: {}", e).into())
}
}
impl From<heed::Error> for Error { impl From<heed::Error> for Error {
fn from(e: heed::Error) -> Error { fn from(e: heed::Error) -> Error {
Error(format!("LMDB: {}", e).into()) DbError::from(e).into()
} }
} }
impl From<heed::Error> for TxOpError { impl From<heed::Error> for TxOpError {
fn from(e: heed::Error) -> TxOpError { fn from(e: heed::Error) -> TxOpError {
TxOpError(e.into()) DbError::from(e).into()
} }
} }
@@ -91,14 +97,14 @@ impl LmdbDb {
Db(Arc::new(s)) Db(Arc::new(s))
} }
fn get_tree(&self, i: usize) -> Result<Database> { fn get_tree(&self, i: usize) -> DbResult<Database> {
self.trees self.trees
.read() .read()
.unwrap() .unwrap()
.0 .0
.get(i) .get(i)
.cloned() .cloned()
.ok_or_else(|| Error("invalid tree id".into())) .ok_or_else(|| DbError("invalid tree id".into()))
} }
} }
@@ -107,7 +113,7 @@ impl IDb for LmdbDb {
"LMDB (using Heed crate)".into() "LMDB (using Heed crate)".into()
} }
fn open_tree(&self, name: &str) -> Result<usize> { fn open_tree(&self, name: &str) -> DbResult<usize> {
let mut trees = self.trees.write().unwrap(); let mut trees = self.trees.write().unwrap();
if let Some(i) = trees.1.get(name) { if let Some(i) = trees.1.get(name) {
Ok(*i) Ok(*i)
@@ -122,7 +128,7 @@ impl IDb for LmdbDb {
} }
} }
fn list_trees(&self) -> Result<Vec<String>> { fn list_trees(&self) -> DbResult<Vec<String>> {
let rtxn = self.db.read_txn()?; let rtxn = self.db.read_txn()?;
let tree0 = match self let tree0 = match self
.db .db
@@ -153,7 +159,7 @@ impl IDb for LmdbDb {
Ok(ret2) Ok(ret2)
} }
fn snapshot(&self, base_path: &Path) -> Result<()> { fn snapshot(&self, base_path: &Path) -> DbResult<()> {
std::fs::create_dir_all(base_path)?; std::fs::create_dir_all(base_path)?;
let path = Engine::Lmdb.db_path(base_path); let path = Engine::Lmdb.db_path(base_path);
self.db self.db
@@ -163,7 +169,7 @@ impl IDb for LmdbDb {
// ---- // ----
fn get(&self, tree: usize, key: &[u8]) -> Result<Option<Value>> { fn get(&self, tree: usize, key: &[u8]) -> DbResult<Option<Value>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
@@ -174,18 +180,18 @@ impl IDb for LmdbDb {
} }
} }
fn approximate_len(&self, tree: usize) -> Result<usize> { fn approximate_len(&self, tree: usize) -> DbResult<usize> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
Ok(tree.len(&tx)?.try_into().unwrap()) Ok(tree.len(&tx)?.try_into().unwrap())
} }
fn is_empty(&self, tree: usize) -> Result<bool> { fn is_empty(&self, tree: usize) -> DbResult<bool> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
Ok(tree.is_empty(&tx)?) Ok(tree.is_empty(&tx)?)
} }
fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> Result<()> { fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let mut tx = self.db.write_txn()?; let mut tx = self.db.write_txn()?;
tree.put(&mut tx, key, value)?; tree.put(&mut tx, key, value)?;
@@ -193,7 +199,7 @@ impl IDb for LmdbDb {
Ok(()) Ok(())
} }
fn remove(&self, tree: usize, key: &[u8]) -> Result<()> { fn remove(&self, tree: usize, key: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let mut tx = self.db.write_txn()?; let mut tx = self.db.write_txn()?;
tree.delete(&mut tx, key)?; tree.delete(&mut tx, key)?;
@@ -201,7 +207,7 @@ impl IDb for LmdbDb {
Ok(()) Ok(())
} }
fn clear(&self, tree: usize) -> Result<()> { fn clear(&self, tree: usize) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let mut tx = self.db.write_txn()?; let mut tx = self.db.write_txn()?;
tree.clear(&mut tx)?; tree.clear(&mut tx)?;
@@ -209,14 +215,14 @@ impl IDb for LmdbDb {
Ok(()) Ok(())
} }
fn iter(&self, tree: usize) -> Result<ValueIter<'_>> { fn iter(&self, tree: usize) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
// Safety: the cloture does not store its argument anywhere, // Safety: the cloture does not store its argument anywhere,
unsafe { TxAndIterator::make(tx, |tx| Ok(tree.iter(tx)?)) } unsafe { TxAndIterator::make(tx, |tx| Ok(tree.iter(tx)?)) }
} }
fn iter_rev(&self, tree: usize) -> Result<ValueIter<'_>> { fn iter_rev(&self, tree: usize) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
// Safety: the cloture does not store its argument anywhere, // Safety: the cloture does not store its argument anywhere,
@@ -228,7 +234,7 @@ impl IDb for LmdbDb {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>> { ) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
// Safety: the cloture does not store its argument anywhere, // Safety: the cloture does not store its argument anywhere,
@@ -239,7 +245,7 @@ impl IDb for LmdbDb {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>> { ) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let tx = self.db.read_txn()?; let tx = self.db.read_txn()?;
// Safety: the cloture does not store its argument anywhere, // Safety: the cloture does not store its argument anywhere,
@@ -271,9 +277,9 @@ impl IDb for LmdbDb {
} }
TxFnResult::DbErr => { TxFnResult::DbErr => {
tx.tx.abort(); tx.tx.abort();
Err(TxError::Db(Error( Err(TxError::Db(
"(this message will be discarded)".into(), DbError("(this message will be discarded)".into()).into(),
))) ))
} }
} }
} }
@@ -287,49 +293,49 @@ struct LmdbTx<'a> {
} }
impl<'a> LmdbTx<'a> { impl<'a> LmdbTx<'a> {
fn get_tree(&self, i: usize) -> TxOpResult<&Database> { fn get_tree(&self, i: usize) -> DbResult<&Database> {
self.trees.get(i).ok_or_else(|| { self.trees.get(i).ok_or_else(|| {
TxOpError(Error( DbError(
"invalid tree id (it might have been opened after the transaction started)".into(), "invalid tree id (it might have been opened after the transaction started)".into(),
)) )
}) })
} }
} }
impl<'a> ITx for LmdbTx<'a> { impl<'a> ITx for LmdbTx<'a> {
fn get(&self, tree: usize, key: &[u8]) -> TxOpResult<Option<Value>> { fn get(&self, tree: usize, key: &[u8]) -> DbResult<Option<Value>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
match tree.get(&self.tx, key)? { match tree.get(&self.tx, key)? {
Some(v) => Ok(Some(v.to_vec())), Some(v) => Ok(Some(v.to_vec())),
None => Ok(None), None => Ok(None),
} }
} }
fn len(&self, tree: usize) -> TxOpResult<usize> { fn len(&self, tree: usize) -> DbResult<usize> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
Ok(tree.len(&self.tx)? as usize) Ok(tree.len(&self.tx)? as usize)
} }
fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> TxOpResult<()> { fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> DbResult<()> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
tree.put(&mut self.tx, key, value)?; tree.put(&mut self.tx, key, value)?;
Ok(()) Ok(())
} }
fn remove(&mut self, tree: usize, key: &[u8]) -> TxOpResult<()> { fn remove(&mut self, tree: usize, key: &[u8]) -> DbResult<()> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
tree.delete(&mut self.tx, key)?; tree.delete(&mut self.tx, key)?;
Ok(()) Ok(())
} }
fn clear(&mut self, tree: usize) -> TxOpResult<()> { fn clear(&mut self, tree: usize) -> DbResult<()> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
tree.clear(&mut self.tx)?; tree.clear(&mut self.tx)?;
Ok(()) Ok(())
} }
fn iter(&self, tree: usize) -> TxOpResult<TxValueIter<'_>> { fn iter(&self, tree: usize) -> DbResult<TxValueIter<'_>> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
Ok(Box::new(tree.iter(&self.tx)?.map(tx_iter_item))) Ok(Box::new(tree.iter(&self.tx)?.map(tx_iter_item)))
} }
fn iter_rev(&self, tree: usize) -> TxOpResult<TxValueIter<'_>> { fn iter_rev(&self, tree: usize) -> DbResult<TxValueIter<'_>> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
Ok(Box::new(tree.rev_iter(&self.tx)?.map(tx_iter_item))) Ok(Box::new(tree.rev_iter(&self.tx)?.map(tx_iter_item)))
} }
@@ -339,7 +345,7 @@ impl<'a> ITx for LmdbTx<'a> {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>> { ) -> DbResult<TxValueIter<'_>> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
Ok(Box::new( Ok(Box::new(
tree.range(&self.tx, &(low, high))?.map(tx_iter_item), tree.range(&self.tx, &(low, high))?.map(tx_iter_item),
@@ -350,7 +356,7 @@ impl<'a> ITx for LmdbTx<'a> {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>> { ) -> DbResult<TxValueIter<'_>> {
let tree = *self.get_tree(tree)?; let tree = *self.get_tree(tree)?;
Ok(Box::new( Ok(Box::new(
tree.rev_range(&self.tx, &(low, high))?.map(tx_iter_item), tree.rev_range(&self.tx, &(low, high))?.map(tx_iter_item),
@@ -386,9 +392,9 @@ where
} }
/// Safety: iterfun must not store its argument anywhere but in its result. /// Safety: iterfun must not store its argument anywhere but in its result.
unsafe fn make<F>(tx: RoTxn<'a, WithTls>, iterfun: F) -> Result<ValueIter<'a>> unsafe fn make<F>(tx: RoTxn<'a, WithTls>, iterfun: F) -> DbResult<ValueIter<'a>>
where where
F: FnOnce(&'a RoTxn<'a>) -> Result<I>, F: FnOnce(&'a RoTxn<'a>) -> DbResult<I>,
{ {
let res = TxAndIterator { let res = TxAndIterator {
tx, tx,
@@ -436,13 +442,13 @@ impl<'a, I> Iterator for TxAndIteratorPin<'a, I>
where where
I: Iterator<Item = IteratorItem<'a>> + 'a, I: Iterator<Item = IteratorItem<'a>> + 'a,
{ {
type Item = Result<(Value, Value)>; type Item = DbResult<(Value, Value)>;
fn next(&mut self) -> Option<Self::Item> { fn next(&mut self) -> Option<Self::Item> {
let mut_ref = Pin::as_mut(&mut self.0); let mut_ref = Pin::as_mut(&mut self.0);
let next = mut_ref.iter().as_mut()?.next()?; let next = mut_ref.iter().as_mut()?.next()?;
let res = match next { let res = match next {
Err(e) => Err(e.into()), Err(e) => Err(DbError::from(e)),
Ok((k, v)) => Ok((k.to_vec(), v.to_vec())), Ok((k, v)) => Ok((k.to_vec(), v.to_vec())),
}; };
Some(res) Some(res)
@@ -453,9 +459,9 @@ where
fn tx_iter_item<'a>( fn tx_iter_item<'a>(
item: std::result::Result<(&'a [u8], &'a [u8]), heed::Error>, item: std::result::Result<(&'a [u8], &'a [u8]), heed::Error>,
) -> TxOpResult<(Vec<u8>, Vec<u8>)> { ) -> DbResult<(Vec<u8>, Vec<u8>)> {
item.map(|(k, v)| (k.to_vec(), v.to_vec())) item.map(|(k, v)| (k.to_vec(), v.to_vec()))
.map_err(|e| TxOpError(Error::from(e))) .map_err(DbError::from)
} }
// ---- utility ---- // ---- utility ----
+10 -9
View File
@@ -1,6 +1,6 @@
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
use crate::{Db, Error, Result}; use crate::{Db, DbError, Error, Result};
/// List of supported database engine types /// List of supported database engine types
/// ///
@@ -49,14 +49,14 @@ impl std::str::FromStr for Engine {
"lmdb" | "heed" => Ok(Self::Lmdb), "lmdb" | "heed" => Ok(Self::Lmdb),
"sqlite" | "sqlite3" | "rusqlite" => Ok(Self::Sqlite), "sqlite" | "sqlite3" | "rusqlite" => Ok(Self::Sqlite),
"fjall" => Ok(Self::Fjall), "fjall" => Ok(Self::Fjall),
"sled" => Err(Error("Sled is no longer supported as a database engine. Converting your old metadata db can be done using an older Garage binary (e.g. v0.9.4).".into())), "sled" => Err(DbError("Sled is no longer supported as a database engine. Converting your old metadata db can be done using an older Garage binary (e.g. v0.9.4).".into()).into()),
kind => Err(Error( kind => Err(DbError(
format!( format!(
"Invalid DB engine: {} (options are: lmdb, sqlite, fjall)", "Invalid DB engine: {} (options are: lmdb, sqlite, fjall)",
kind kind
) )
.into(), .into(),
)), ).into()),
} }
} }
} }
@@ -72,22 +72,23 @@ pub fn open_db(path: &PathBuf, engine: Engine, opt: &OpenOpt) -> Result<Db> {
match engine { match engine {
// ---- Sqlite DB ---- // ---- Sqlite DB ----
#[cfg(feature = "sqlite")] #[cfg(feature = "sqlite")]
Engine::Sqlite => crate::sqlite_adapter::open_db(path, opt), Engine::Sqlite => Ok(crate::sqlite_adapter::open_db(path, opt)?),
// ---- LMDB DB ---- // ---- LMDB DB ----
#[cfg(feature = "lmdb")] #[cfg(feature = "lmdb")]
Engine::Lmdb => crate::lmdb_adapter::open_db(path, opt), Engine::Lmdb => Ok(crate::lmdb_adapter::open_db(path, opt)?),
// ---- Fjall DB ---- // ---- Fjall DB ----
#[cfg(feature = "fjall")] #[cfg(feature = "fjall")]
Engine::Fjall => crate::fjall_adapter::open_db(path, opt), Engine::Fjall => Ok(crate::fjall_adapter::open_db(path, opt)?),
// Pattern is unreachable when all supported DB engines are compiled into binary. The allow // Pattern is unreachable when all supported DB engines are compiled into binary. The allow
// attribute is added so that we won't have to change this match in case stop building // attribute is added so that we won't have to change this match in case stop building
// support for one or more engines by default. // support for one or more engines by default.
#[allow(unreachable_patterns)] #[allow(unreachable_patterns)]
engine => Err(Error( engine => Err(DbError(
format!("DB engine support not available in this build: {}", engine).into(), format!("DB engine support not available in this build: {}", engine).into(),
)), )
.into()),
} }
} }
+55 -43
View File
@@ -12,7 +12,7 @@ use rusqlite::{params, Rows, Statement, Transaction};
use crate::{ use crate::{
open::{Engine, OpenOpt}, open::{Engine, OpenOpt},
Db, Error, IDb, ITx, ITxFn, OnCommit, Result, TxError, TxFnResult, TxOpError, TxOpResult, Db, DbError, DbResult, Error, IDb, ITx, ITxFn, OnCommit, TxError, TxFnResult, TxOpError,
TxResult, TxValueIter, Value, ValueIter, TxResult, TxValueIter, Value, ValueIter,
}; };
@@ -20,7 +20,7 @@ pub use rusqlite;
// ---- top-level open function // ---- top-level open function
pub(crate) fn open_db(path: &PathBuf, opt: &OpenOpt) -> Result<Db> { pub(crate) fn open_db(path: &PathBuf, opt: &OpenOpt) -> DbResult<Db> {
info!("Opening Sqlite database at: {}", path.display()); info!("Opening Sqlite database at: {}", path.display());
let manager = r2d2_sqlite::SqliteConnectionManager::file(path); let manager = r2d2_sqlite::SqliteConnectionManager::file(path);
SqliteDb::open(manager, opt.fsync) SqliteDb::open(manager, opt.fsync)
@@ -32,21 +32,33 @@ type Connection = r2d2::PooledConnection<SqliteConnectionManager>;
// --- err // --- err
impl From<rusqlite::Error> for DbError {
fn from(e: rusqlite::Error) -> DbError {
DbError(format!("Sqlite: {}", e).into())
}
}
impl From<rusqlite::Error> for Error { impl From<rusqlite::Error> for Error {
fn from(e: rusqlite::Error) -> Error { fn from(e: rusqlite::Error) -> Error {
Error(format!("Sqlite: {}", e).into()) DbError::from(e).into()
}
}
impl From<r2d2::Error> for DbError {
fn from(e: r2d2::Error) -> DbError {
DbError(format!("Sqlite: {}", e).into())
} }
} }
impl From<r2d2::Error> for Error { impl From<r2d2::Error> for Error {
fn from(e: r2d2::Error) -> Error { fn from(e: r2d2::Error) -> Error {
Error(format!("Sqlite: {}", e).into()) DbError::from(e).into()
} }
} }
impl From<rusqlite::Error> for TxOpError { impl From<rusqlite::Error> for TxOpError {
fn from(e: rusqlite::Error) -> TxOpError { fn from(e: rusqlite::Error) -> TxOpError {
TxOpError(e.into()) DbError::from(e).into()
} }
} }
@@ -62,7 +74,7 @@ pub struct SqliteDb {
} }
impl SqliteDb { impl SqliteDb {
pub fn open(manager: SqliteConnectionManager, sync_mode: bool) -> Result<Db> { pub fn open(manager: SqliteConnectionManager, sync_mode: bool) -> DbResult<Db> {
let manager = manager.with_init(move |db| { let manager = manager.with_init(move |db| {
db.pragma_update(None, "journal_mode", "WAL")?; db.pragma_update(None, "journal_mode", "WAL")?;
if sync_mode { if sync_mode {
@@ -82,16 +94,16 @@ impl SqliteDb {
} }
impl SqliteDb { impl SqliteDb {
fn get_tree(&self, i: usize) -> Result<Arc<str>> { fn get_tree(&self, i: usize) -> DbResult<Arc<str>> {
self.trees self.trees
.read() .read()
.unwrap() .unwrap()
.get(i) .get(i)
.cloned() .cloned()
.ok_or_else(|| Error("invalid tree id".into())) .ok_or_else(|| DbError("invalid tree id".into()))
} }
fn internal_get(&self, db: &Connection, tree: &str, key: &[u8]) -> Result<Option<Value>> { fn internal_get(&self, db: &Connection, tree: &str, key: &[u8]) -> DbResult<Option<Value>> {
let mut stmt = db.prepare(&format!("SELECT v FROM {} WHERE k = ?1", tree))?; let mut stmt = db.prepare(&format!("SELECT v FROM {} WHERE k = ?1", tree))?;
let mut res_iter = stmt.query([key])?; let mut res_iter = stmt.query([key])?;
match res_iter.next()? { match res_iter.next()? {
@@ -106,7 +118,7 @@ impl IDb for SqliteDb {
format!("sqlite3 v{} (using rusqlite crate)", rusqlite::version()) format!("sqlite3 v{} (using rusqlite crate)", rusqlite::version())
} }
fn open_tree(&self, name: &str) -> Result<usize> { fn open_tree(&self, name: &str) -> DbResult<usize> {
let name = format!("tree_{}", name.replace(':', "_COLON_")); let name = format!("tree_{}", name.replace(':', "_COLON_"));
let mut trees = self.trees.write().unwrap(); let mut trees = self.trees.write().unwrap();
@@ -133,7 +145,7 @@ impl IDb for SqliteDb {
} }
} }
fn list_trees(&self) -> Result<Vec<String>> { fn list_trees(&self) -> DbResult<Vec<String>> {
let mut trees = vec![]; let mut trees = vec![];
let db = self.db.get()?; let db = self.db.get()?;
@@ -150,13 +162,13 @@ impl IDb for SqliteDb {
Ok(trees) Ok(trees)
} }
fn snapshot(&self, base_path: &Path) -> Result<()> { fn snapshot(&self, base_path: &Path) -> DbResult<()> {
std::fs::create_dir_all(base_path)?; std::fs::create_dir_all(base_path)?;
let path = Engine::Sqlite let path = Engine::Sqlite
.db_path(base_path) .db_path(base_path)
.into_os_string() .into_os_string()
.into_string() .into_string()
.map_err(|_| Error("invalid sqlite path string".into()))?; .map_err(|_| DbError("invalid sqlite path string".into()))?;
info!("Start sqlite VACUUM INTO `{}`", path); info!("Start sqlite VACUUM INTO `{}`", path);
self.db.get()?.execute("VACUUM INTO ?1", params![path])?; self.db.get()?.execute("VACUUM INTO ?1", params![path])?;
@@ -167,12 +179,12 @@ impl IDb for SqliteDb {
// ---- // ----
fn get(&self, tree: usize, key: &[u8]) -> Result<Option<Value>> { fn get(&self, tree: usize, key: &[u8]) -> DbResult<Option<Value>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
self.internal_get(&self.db.get()?, &tree, key) self.internal_get(&self.db.get()?, &tree, key)
} }
fn approximate_len(&self, tree: usize) -> Result<usize> { fn approximate_len(&self, tree: usize) -> DbResult<usize> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let db = self.db.get()?; let db = self.db.get()?;
@@ -184,11 +196,11 @@ impl IDb for SqliteDb {
} }
} }
fn is_empty(&self, tree: usize) -> Result<bool> { fn is_empty(&self, tree: usize) -> DbResult<bool> {
Ok(self.approximate_len(tree)? == 0) Ok(self.approximate_len(tree)? == 0)
} }
fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> Result<()> { fn insert(&self, tree: usize, key: &[u8], value: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let db = self.db.get()?; let db = self.db.get()?;
let lock = self.write_lock.lock(); let lock = self.write_lock.lock();
@@ -206,7 +218,7 @@ impl IDb for SqliteDb {
Ok(()) Ok(())
} }
fn remove(&self, tree: usize, key: &[u8]) -> Result<()> { fn remove(&self, tree: usize, key: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let db = self.db.get()?; let db = self.db.get()?;
let lock = self.write_lock.lock(); let lock = self.write_lock.lock();
@@ -217,7 +229,7 @@ impl IDb for SqliteDb {
Ok(()) Ok(())
} }
fn clear(&self, tree: usize) -> Result<()> { fn clear(&self, tree: usize) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let db = self.db.get()?; let db = self.db.get()?;
let lock = self.write_lock.lock(); let lock = self.write_lock.lock();
@@ -228,13 +240,13 @@ impl IDb for SqliteDb {
Ok(()) Ok(())
} }
fn iter(&self, tree: usize) -> Result<ValueIter<'_>> { fn iter(&self, tree: usize) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let sql = format!("SELECT k, v FROM {} ORDER BY k ASC", tree); let sql = format!("SELECT k, v FROM {} ORDER BY k ASC", tree);
DbValueIterator::make(self.db.get()?, &sql, []) DbValueIterator::make(self.db.get()?, &sql, [])
} }
fn iter_rev(&self, tree: usize) -> Result<ValueIter<'_>> { fn iter_rev(&self, tree: usize) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let sql = format!("SELECT k, v FROM {} ORDER BY k DESC", tree); let sql = format!("SELECT k, v FROM {} ORDER BY k DESC", tree);
DbValueIterator::make(self.db.get()?, &sql, []) DbValueIterator::make(self.db.get()?, &sql, [])
@@ -245,7 +257,7 @@ impl IDb for SqliteDb {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>> { ) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let (bounds_sql, params) = bounds_sql(low, high); let (bounds_sql, params) = bounds_sql(low, high);
@@ -263,7 +275,7 @@ impl IDb for SqliteDb {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> Result<ValueIter<'_>> { ) -> DbResult<ValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let (bounds_sql, params) = bounds_sql(low, high); let (bounds_sql, params) = bounds_sql(low, high);
@@ -300,9 +312,9 @@ impl IDb for SqliteDb {
} }
TxFnResult::DbErr => { TxFnResult::DbErr => {
tx.tx.rollback().map_err(Error::from).map_err(TxError::Db)?; tx.tx.rollback().map_err(Error::from).map_err(TxError::Db)?;
Err(TxError::Db(Error( Err(TxError::Db(
"(this message will be discarded)".into(), DbError("(this message will be discarded)".into()).into(),
))) ))
} }
}; };
@@ -320,15 +332,15 @@ struct SqliteTx<'a> {
} }
impl<'a> SqliteTx<'a> { impl<'a> SqliteTx<'a> {
fn get_tree(&self, i: usize) -> TxOpResult<&'_ str> { fn get_tree(&self, i: usize) -> DbResult<&'_ str> {
self.trees.get(i).map(Arc::as_ref).ok_or_else(|| { self.trees.get(i).map(Arc::as_ref).ok_or_else(|| {
TxOpError(Error( DbError(
"invalid tree id (it might have been opened after the transaction started)".into(), "invalid tree id (it might have been opened after the transaction started)".into(),
)) )
}) })
} }
fn internal_get(&self, tree: &str, key: &[u8]) -> TxOpResult<Option<Value>> { fn internal_get(&self, tree: &str, key: &[u8]) -> DbResult<Option<Value>> {
let mut stmt = self let mut stmt = self
.tx .tx
.prepare(&format!("SELECT v FROM {} WHERE k = ?1", tree))?; .prepare(&format!("SELECT v FROM {} WHERE k = ?1", tree))?;
@@ -341,11 +353,11 @@ impl<'a> SqliteTx<'a> {
} }
impl<'a> ITx for SqliteTx<'a> { impl<'a> ITx for SqliteTx<'a> {
fn get(&self, tree: usize, key: &[u8]) -> TxOpResult<Option<Value>> { fn get(&self, tree: usize, key: &[u8]) -> DbResult<Option<Value>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
self.internal_get(tree, key) self.internal_get(tree, key)
} }
fn len(&self, tree: usize) -> TxOpResult<usize> { fn len(&self, tree: usize) -> DbResult<usize> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let mut stmt = self.tx.prepare(&format!("SELECT COUNT(*) FROM {}", tree))?; let mut stmt = self.tx.prepare(&format!("SELECT COUNT(*) FROM {}", tree))?;
let mut res_iter = stmt.query([])?; let mut res_iter = stmt.query([])?;
@@ -355,30 +367,30 @@ impl<'a> ITx for SqliteTx<'a> {
} }
} }
fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> TxOpResult<()> { fn insert(&mut self, tree: usize, key: &[u8], value: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let sql = format!("INSERT OR REPLACE INTO {} (k, v) VALUES (?1, ?2)", tree); let sql = format!("INSERT OR REPLACE INTO {} (k, v) VALUES (?1, ?2)", tree);
self.tx.execute(&sql, params![key, value])?; self.tx.execute(&sql, params![key, value])?;
Ok(()) Ok(())
} }
fn remove(&mut self, tree: usize, key: &[u8]) -> TxOpResult<()> { fn remove(&mut self, tree: usize, key: &[u8]) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
self.tx self.tx
.execute(&format!("DELETE FROM {} WHERE k = ?1", tree), params![key])?; .execute(&format!("DELETE FROM {} WHERE k = ?1", tree), params![key])?;
Ok(()) Ok(())
} }
fn clear(&mut self, tree: usize) -> TxOpResult<()> { fn clear(&mut self, tree: usize) -> DbResult<()> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
self.tx.execute(&format!("DELETE FROM {}", tree), [])?; self.tx.execute(&format!("DELETE FROM {}", tree), [])?;
Ok(()) Ok(())
} }
fn iter(&self, tree: usize) -> TxOpResult<TxValueIter<'_>> { fn iter(&self, tree: usize) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let sql = format!("SELECT k, v FROM {} ORDER BY k ASC", tree); let sql = format!("SELECT k, v FROM {} ORDER BY k ASC", tree);
TxValueIterator::make(self, &sql, []) TxValueIterator::make(self, &sql, [])
} }
fn iter_rev(&self, tree: usize) -> TxOpResult<TxValueIter<'_>> { fn iter_rev(&self, tree: usize) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let sql = format!("SELECT k, v FROM {} ORDER BY k DESC", tree); let sql = format!("SELECT k, v FROM {} ORDER BY k DESC", tree);
TxValueIterator::make(self, &sql, []) TxValueIterator::make(self, &sql, [])
@@ -389,7 +401,7 @@ impl<'a> ITx for SqliteTx<'a> {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>> { ) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let (bounds_sql, params) = bounds_sql(low, high); let (bounds_sql, params) = bounds_sql(low, high);
@@ -407,7 +419,7 @@ impl<'a> ITx for SqliteTx<'a> {
tree: usize, tree: usize,
low: Bound<&'r [u8]>, low: Bound<&'r [u8]>,
high: Bound<&'r [u8]>, high: Bound<&'r [u8]>,
) -> TxOpResult<TxValueIter<'_>> { ) -> DbResult<TxValueIter<'_>> {
let tree = self.get_tree(tree)?; let tree = self.get_tree(tree)?;
let (bounds_sql, params) = bounds_sql(low, high); let (bounds_sql, params) = bounds_sql(low, high);
@@ -439,7 +451,7 @@ impl DbValueIterator {
db: Connection, db: Connection,
sql: &str, sql: &str,
args: P, args: P,
) -> Result<ValueIter<'res>> { ) -> DbResult<ValueIter<'res>> {
let res = DbValueIterator { let res = DbValueIterator {
db, db,
stmt: None, stmt: None,
@@ -484,7 +496,7 @@ impl Drop for DbValueIterator {
struct DbValueIteratorPin(Pin<Box<DbValueIterator>>); struct DbValueIteratorPin(Pin<Box<DbValueIterator>>);
impl Iterator for DbValueIteratorPin { impl Iterator for DbValueIteratorPin {
type Item = Result<(Value, Value)>; type Item = DbResult<(Value, Value)>;
fn next(&mut self) -> Option<Self::Item> { fn next(&mut self) -> Option<Self::Item> {
let mut_ref = Pin::as_mut(&mut self.0); let mut_ref = Pin::as_mut(&mut self.0);
@@ -509,7 +521,7 @@ impl<'a> TxValueIterator<'a> {
tx: &'a SqliteTx<'a>, tx: &'a SqliteTx<'a>,
sql: &str, sql: &str,
args: P, args: P,
) -> TxOpResult<TxValueIter<'a>> { ) -> DbResult<TxValueIter<'a>> {
let stmt = tx.tx.prepare(sql)?; let stmt = tx.tx.prepare(sql)?;
let res = TxValueIterator { let res = TxValueIterator {
stmt, stmt,
@@ -543,7 +555,7 @@ impl<'a> Drop for TxValueIterator<'a> {
struct TxValueIteratorPin<'a>(Pin<Box<TxValueIterator<'a>>>); struct TxValueIteratorPin<'a>(Pin<Box<TxValueIterator<'a>>>);
impl<'a> Iterator for TxValueIteratorPin<'a> { impl<'a> Iterator for TxValueIteratorPin<'a> {
type Item = TxOpResult<(Value, Value)>; type Item = DbResult<(Value, Value)>;
fn next(&mut self) -> Option<Self::Item> { fn next(&mut self) -> Option<Self::Item> {
let mut_ref = Pin::as_mut(&mut self.0); let mut_ref = Pin::as_mut(&mut self.0);
+241
View File
@@ -0,0 +1,241 @@
use std::marker::PhantomData;
use std::ops::{Bound, RangeBounds};
// Todo: some parts of this code, notably around ranges are never used but are here to prepare
// the migration of the parts of the codebase that still use untyped trees. At one point, this
// migration should be done or these functions deleted.
use super::{
DbResult, DecodeError, Error, Result, Transaction, Tree, TxOpError, TxOpResult, TxValueIter,
ValueIter,
};
pub use super::Db;
pub trait DbBytes: Sized {
fn encode(&self) -> Vec<u8>;
fn decode(bytes: &[u8]) -> std::result::Result<Self, DecodeError>;
}
/// Subtrait of [`DbBytes`] for types used as tree keys with operations where order matters
/// (`get_gt`, range, etc...).
///
/// Implementors must guarantee that the byte encoding is order-preserving:
/// for any `a, b: Self`, `a.cmp(&b) == a.encode().cmp(&b.encode())`.
pub trait DbOrdKey: DbBytes + Ord {}
#[derive(Clone)]
pub struct TypedTree<K, V> {
inner: Tree,
_phantom: PhantomData<[(K, V)]>,
}
impl<K: DbBytes, V: DbBytes> TypedTree<K, V> {
pub fn new(tree: Tree) -> Self {
Self {
inner: tree,
_phantom: PhantomData,
}
}
pub fn db(&self) -> Db {
self.inner.db()
}
pub fn untyped(&self) -> &Tree {
&self.inner
}
pub fn get(&self, key: &K) -> Result<Option<V>> {
self.inner
.get(key.encode())?
.map(|v| V::decode(&v).map_err(Error::from))
.transpose()
}
pub fn approximate_len(&self) -> DbResult<usize> {
self.inner.approximate_len()
}
pub fn is_empty(&self) -> DbResult<bool> {
self.inner.is_empty()
}
pub fn insert(&self, key: &K, value: &V) -> DbResult<()> {
self.inner.insert(key.encode(), value.encode())
}
pub fn remove(&self, key: &K) -> DbResult<()> {
self.inner.remove(key.encode())
}
pub fn clear(&self) -> DbResult<()> {
self.inner.clear()
}
pub fn tx_get(&self, tx: &Transaction<'_>, key: &K) -> TxOpResult<Option<V>> {
tx.get(&self.inner, key.encode())?
.map(|v| V::decode(&v).map_err(TxOpError::from))
.transpose()
}
pub fn tx_insert(&self, tx: &mut Transaction<'_>, key: &K, value: &V) -> TxOpResult<()> {
tx.insert(&self.inner, key.encode(), value.encode())
}
pub fn tx_remove(&self, tx: &mut Transaction<'_>, key: &K) -> TxOpResult<()> {
tx.remove(&self.inner, key.encode())
}
pub fn tx_clear(&self, tx: &mut Transaction<'_>) -> TxOpResult<()> {
tx.clear(&self.inner)
}
}
impl<K: DbOrdKey, V: DbBytes> TypedTree<K, V> {
pub fn first(&self) -> Result<Option<(K, V)>> {
self.iter()?.next().transpose()
}
pub fn get_gt(&self, from: &K) -> Result<Option<(K, V)>> {
self.inner
.get_gt(from.encode())?
.map(|(k, v)| {
Ok((
K::decode(&k).map_err(Error::from)?,
V::decode(&v).map_err(Error::from)?,
))
})
.transpose()
}
pub fn iter(&self) -> Result<TypedIter<'_, K, V>> {
Ok(TypedIter::new(self.inner.iter()?))
}
pub fn iter_rev(&self) -> Result<TypedIter<'_, K, V>> {
Ok(TypedIter::new(self.inner.iter_rev()?))
}
pub fn range<R: RangeBounds<K>>(&self, range: R) -> Result<TypedIter<'_, K, V>> {
Ok(TypedIter::new(self.inner.range(encode_range(range))?))
}
pub fn range_rev<R: RangeBounds<K>>(&self, range: R) -> Result<TypedIter<'_, K, V>> {
Ok(TypedIter::new(self.inner.range_rev(encode_range(range))?))
}
pub fn tx_iter<'t>(&self, tx: &'t Transaction<'_>) -> TxOpResult<TypedTxIter<'t, K, V>> {
Ok(TypedTxIter::new(tx.iter(&self.inner)?))
}
pub fn tx_iter_rev<'t>(&self, tx: &'t Transaction<'_>) -> TxOpResult<TypedTxIter<'t, K, V>> {
Ok(TypedTxIter::new(tx.iter_rev(&self.inner)?))
}
pub fn tx_range<'t, R: RangeBounds<K>>(
&self,
tx: &'t Transaction<'_>,
range: R,
) -> TxOpResult<TypedTxIter<'t, K, V>> {
Ok(TypedTxIter::new(
tx.range(&self.inner, encode_range(range))?,
))
}
pub fn tx_range_rev<'t, R: RangeBounds<K>>(
&self,
tx: &'t Transaction<'_>,
range: R,
) -> TxOpResult<TypedTxIter<'t, K, V>> {
Ok(TypedTxIter::new(
tx.range_rev(&self.inner, encode_range(range))?,
))
}
}
impl<K: DbBytes, V: DbBytes> From<Tree> for TypedTree<K, V> {
fn from(tree: Tree) -> Self {
Self::new(tree)
}
}
impl Db {
pub fn open_typed_tree<K: DbBytes, V: DbBytes, S: AsRef<str>>(
&self,
name: S,
) -> DbResult<TypedTree<K, V>> {
Ok(TypedTree::new(self.open_tree(name)?))
}
}
pub struct TypedIter<'a, K, V> {
inner: ValueIter<'a>,
_phantom: PhantomData<(K, V)>,
}
impl<'a, K, V> TypedIter<'a, K, V> {
fn new(inner: ValueIter<'a>) -> Self {
Self {
inner,
_phantom: PhantomData,
}
}
}
impl<K: DbOrdKey, V: DbBytes> Iterator for TypedIter<'_, K, V> {
type Item = Result<(K, V)>;
fn next(&mut self) -> Option<Self::Item> {
self.inner.next().map(|res| {
let (k, v) = res?;
Ok((
K::decode(&k).map_err(Error::from)?,
V::decode(&v).map_err(Error::from)?,
))
})
}
}
pub struct TypedTxIter<'a, K, V> {
inner: TxValueIter<'a>,
_phantom: PhantomData<(K, V)>,
}
impl<'a, K, V> TypedTxIter<'a, K, V> {
fn new(inner: TxValueIter<'a>) -> Self {
Self {
inner,
_phantom: PhantomData,
}
}
}
impl<K: DbOrdKey, V: DbBytes> Iterator for TypedTxIter<'_, K, V> {
type Item = TxOpResult<(K, V)>;
fn next(&mut self) -> Option<Self::Item> {
self.inner.next().map(|res| {
let (k, v) = res?;
Ok((
K::decode(&k).map_err(TxOpError::from)?,
V::decode(&v).map_err(TxOpError::from)?,
))
})
}
}
fn encode_range<K: DbOrdKey, R: RangeBounds<K>>(range: R) -> (Bound<Vec<u8>>, Bound<Vec<u8>>) {
(
encode_bound(range.start_bound()),
encode_bound(range.end_bound()),
)
}
fn encode_bound<K: DbOrdKey>(bound: Bound<&K>) -> Bound<Vec<u8>> {
match bound {
Bound::Included(k) => Bound::Included(k.encode()),
Bound::Excluded(k) => Bound::Excluded(k.encode()),
Bound::Unbounded => Bound::Unbounded,
}
}
+1 -1
View File
@@ -39,8 +39,8 @@ backtrace.workspace = true
bytes.workspace = true bytes.workspace = true
bytesize.workspace = true bytesize.workspace = true
chrono.workspace = true chrono.workspace = true
fundu-systemd.workspace = true
timeago.workspace = true timeago.workspace = true
parse_duration.workspace = true
hex.workspace = true hex.workspace = true
tracing.workspace = true tracing.workspace = true
tracing-subscriber.workspace = true tracing-subscriber.workspace = true
+1 -1
View File
@@ -49,7 +49,7 @@ pub struct OpenLmdbOpt {
pub(crate) fn do_conversion(args: ConvertDbOpt) -> Result<()> { pub(crate) fn do_conversion(args: ConvertDbOpt) -> Result<()> {
if args.input_engine == args.output_engine { if args.input_engine == args.output_engine {
return Err(Error("input and output database engine must differ".into())); return Err(DbError("input and output database engine must differ".into()).into());
} }
let opt = OpenOpt { let opt = OpenOpt {
+1 -1
View File
@@ -393,7 +393,7 @@ impl Cli {
&self, &self,
opt: CleanupIncompleteUploadsOpt, opt: CleanupIncompleteUploadsOpt,
) -> Result<(), Error> { ) -> Result<(), Error> {
let older_than = parse_duration::parse::parse(&opt.older_than) let older_than = garage_util::time::parse_duration(&opt.older_than)
.ok_or_message("Invalid duration passed for --older-than parameter")?; .ok_or_message("Invalid duration passed for --older-than parameter")?;
for b in opt.buckets.iter() { for b in opt.buckets.iter() {
+1 -1
View File
@@ -226,7 +226,7 @@ impl Cli {
pub async fn cmd_import_key(&self, opt: KeyImportOpt) -> Result<(), Error> { pub async fn cmd_import_key(&self, opt: KeyImportOpt) -> Result<(), Error> {
if !opt.yes { if !opt.yes {
return Err(Error::Message("This command is intended to re-import keys that were previously generated by Garage. If you want to create a new key, use `garage key new` instead. Add the --yes flag if you really want to re-import a key.".to_string())); return Err(Error::Message("This command is intended to re-import keys that were previously generated by Garage. If you want to create a new key, use `garage key create` instead. Add the --yes flag if you really want to re-import a key.".to_string()));
} }
let new_key = self let new_key = self
+1 -1
View File
@@ -169,7 +169,7 @@ pub fn table_list_abbr<T: IntoIterator<Item = S>, S: AsRef<str>>(values: T) -> S
pub fn parse_expires_in(expires_in: &Option<String>) -> Result<Option<DateTime<Utc>>, Error> { pub fn parse_expires_in(expires_in: &Option<String>) -> Result<Option<DateTime<Utc>>, Error> {
expires_in expires_in
.as_ref() .as_ref()
.map(|x| parse_duration::parse::parse(x).map(|dur| Utc::now() + dur)) .map(|x| garage_util::time::parse_duration(x).map(|dur| Utc::now() + dur))
.transpose() .transpose()
.ok_or_message("Invalid duration passed for --expires-in parameter") .ok_or_message("Invalid duration passed for --expires-in parameter")
} }
+4 -4
View File
@@ -494,7 +494,7 @@ pub struct KeyNewOpt {
#[structopt(default_value = "Unnamed key")] #[structopt(default_value = "Unnamed key")]
pub name: String, pub name: String,
/// Set an expiration time for the access key /// Set an expiration time for the access key
/// (see `docs.rs/parse_duration` for date format) /// (see `docs.rs/fundu-systemd` for date format)
#[structopt(long = "expires-in")] #[structopt(long = "expires-in")]
pub expires_in: Option<String>, pub expires_in: Option<String>,
} }
@@ -505,7 +505,7 @@ pub struct KeySetOpt {
pub key_pattern: String, pub key_pattern: String,
/// Set an expiration time for the access key /// Set an expiration time for the access key
/// (see `docs.rs/parse_duration` for date format) /// (see `docs.rs/fundu-systemd` for date format)
#[structopt(long = "expires-in")] #[structopt(long = "expires-in")]
pub expires_in: Option<String>, pub expires_in: Option<String>,
/// Set the access key to never expire /// Set the access key to never expire
@@ -616,7 +616,7 @@ pub enum AdminTokenOperation {
pub struct AdminTokenCreateOp { pub struct AdminTokenCreateOp {
/// Set a name for the token /// Set a name for the token
pub name: Option<String>, pub name: Option<String>,
/// Set an expiration time for the token (see `docs.rs/parse_duration` for date /// Set an expiration time for the token (see `docs.rs/fundu-systemd` for date
/// format) /// format)
#[structopt(long = "expires-in")] #[structopt(long = "expires-in")]
pub expires_in: Option<String>, pub expires_in: Option<String>,
@@ -638,7 +638,7 @@ pub struct AdminTokenSetOp {
/// Name or prefix of the ID of the token to modify /// Name or prefix of the ID of the token to modify
pub api_token: String, pub api_token: String,
/// Set an expiration time for the token (see `docs.rs/parse_duration` for date /// Set an expiration time for the token (see `docs.rs/fundu-systemd` for date
/// format) /// format)
#[structopt(long = "expires-in")] #[structopt(long = "expires-in")]
pub expires_in: Option<String>, pub expires_in: Option<String>,
+6 -2
View File
@@ -137,14 +137,18 @@ fn read_secret_file(file_path: &PathBuf, allow_world_readable: bool) -> Result<S
#[cfg(unix)] #[cfg(unix)]
{ {
use std::os::unix::fs::MetadataExt; use std::os::unix::fs::MetadataExt;
let metadata = std::fs::metadata(file_path)?; let metadata = std::fs::metadata(file_path).map_err(|e| {
format!("Failed to read secret file {}: {}", file_path.display(), e)
})?;
if metadata.mode() & 0o077 != 0 { if metadata.mode() & 0o077 != 0 {
return Err(format!("File {} is world-readable! (mode: 0{:o}, expected 0600)\nRefusing to start until this is fixed, or environment variable GARAGE_ALLOW_WORLD_READABLE_SECRETS is set to true.", file_path.display(), metadata.mode()).into()); return Err(format!("File {} is world-readable! (mode: 0{:o}, expected 0600)\nRefusing to start until this is fixed, or environment variable GARAGE_ALLOW_WORLD_READABLE_SECRETS is set to true.", file_path.display(), metadata.mode()).into());
} }
} }
} }
let secret_buf = std::fs::read_to_string(file_path)?; let secret_buf = std::fs::read_to_string(file_path)
.map_err(|e| format!("Failed to read secret file {}: {}", file_path.display(), e))?;
// trim_end: allows for use case such as `echo "$(openssl rand -hex 32)" > somefile`. // trim_end: allows for use case such as `echo "$(openssl rand -hex 32)" > somefile`.
// also editors sometimes add a trailing newline // also editors sometimes add a trailing newline
+1
View File
@@ -2,6 +2,7 @@ mod cors;
mod list; mod list;
mod multipart; mod multipart;
mod objects; mod objects;
mod postobject;
mod presigned; mod presigned;
mod signature_encoding; mod signature_encoding;
mod simple; mod simple;
+24 -1
View File
@@ -554,7 +554,7 @@ async fn test_deleteobject() {
assert!(l.contents.is_none()); assert!(l.contents.is_none());
// Deleting a non-existing object shouldn't be a problem // Deleting a non-existing object shouldn't be a problem...
ctx.client ctx.client
.delete_object() .delete_object()
.bucket(&bucket) .bucket(&bucket)
@@ -562,4 +562,27 @@ async fn test_deleteobject() {
.send() .send()
.await .await
.unwrap(); .unwrap();
// ...and bulk-deleting a non-existing object shouldn't be either
let r = ctx
.client
.delete_objects()
.bucket(&bucket)
.delete(
Delete::builder()
.objects(
ObjectIdentifier::builder()
.key("does-not-exist")
.build()
.unwrap(),
)
.build()
.unwrap(),
)
.send()
.await
.unwrap();
assert_eq!(r.deleted.unwrap().len(), 1); // reported as deleted...
assert!(r.errors.unwrap_or_default().is_empty()); // ...not as an error
} }
+166
View File
@@ -0,0 +1,166 @@
use base64::prelude::*;
use bytes::Bytes;
use chrono::{Duration, Utc};
use hmac::Mac;
use http_body_util::Full;
use hyper::body::Incoming;
use hyper::{header, Method, Request, Response, StatusCode};
use garage_api_common::signature;
use crate::common;
const UTF8_KEY: &str = "uploads/test/копия файла.jpg";
const UTF8_FILENAME: &str = "café-日本語.txt";
const UTF8_CONTENT_DISPOSITION: &str = "attachment; filename=\"копия файла.jpg\"";
const REGION: &str = "garage-integ-test";
const BOUNDARY: &str = "boundary-garage-integ-test";
async fn send_post_object(
ctx: &common::Context,
bucket: &str,
key_field: &str,
filename: &str,
extra_fields: &[(&str, &str)],
file_body: &str,
) -> Response<Incoming> {
let now = Utc::now();
let scope = signature::compute_scope(&now, REGION, "s3");
let credential = format!("{}/{}", ctx.key.id, scope);
let date = now.format(signature::LONG_DATETIME).to_string();
let expiration = (now + Duration::hours(1)).to_rfc3339();
let mut conditions = vec![
serde_json::json!({ "bucket": bucket }),
serde_json::json!(["starts-with", "$key", ""]),
serde_json::json!({ "x-amz-algorithm": "AWS4-HMAC-SHA256" }),
serde_json::json!({ "x-amz-credential": &credential }),
serde_json::json!({ "x-amz-date": &date }),
];
for (name, value) in extra_fields {
conditions.push(serde_json::json!(["eq", format!("${}", name), value]));
}
let policy = serde_json::json!({
"expiration": expiration,
"conditions": conditions,
})
.to_string();
let policy_b64 = BASE64_STANDARD.encode(policy.as_bytes());
let mut signer = signature::signing_hmac(&now, &ctx.key.secret, REGION, "s3").unwrap();
signer.update(policy_b64.as_bytes());
let x_amz_signature = hex::encode(signer.finalize().into_bytes());
let mut fields = vec![
("key".to_string(), key_field.to_string()),
("x-amz-algorithm".into(), "AWS4-HMAC-SHA256".into()),
("x-amz-credential".into(), credential),
("x-amz-date".into(), date),
("policy".into(), policy_b64),
("x-amz-signature".into(), x_amz_signature),
];
for (name, value) in extra_fields {
fields.push((name.to_string(), value.to_string()));
}
let mut body = String::new();
for (name, value) in &fields {
body.push_str(&format!(
"--{BOUNDARY}\r\nContent-Disposition: form-data; name=\"{name}\"\r\n\r\n{value}\r\n"
));
}
body.push_str(&format!(
"--{BOUNDARY}\r\nContent-Disposition: form-data; name=\"file\"; filename=\"{filename}\"\r\nContent-Type: text/plain\r\n\r\n{file_body}\r\n--{BOUNDARY}--\r\n"
));
let req = Request::builder()
.method(Method::POST)
.uri(format!("{}{}", ctx.garage.s3_uri(), bucket))
.header(header::HOST, "s3.garage")
.header(
header::CONTENT_TYPE,
format!("multipart/form-data; boundary={BOUNDARY}"),
)
.body(Full::new(Bytes::from(body.into_bytes())))
.unwrap();
ctx.custom_request.client().request(req).await.unwrap()
}
#[tokio::test]
async fn test_post_object_utf8_key() {
let ctx = common::context();
let bucket = ctx.create_bucket("post-object-utf8-key");
let res = send_post_object(&ctx, &bucket, UTF8_KEY, "копия файла.jpg", &[], "hello").await;
assert_eq!(res.status(), StatusCode::NO_CONTENT);
let obj = ctx
.client
.get_object()
.bucket(&bucket)
.key(UTF8_KEY)
.send()
.await
.unwrap();
assert_bytes_eq!(obj.body, b"hello");
}
#[tokio::test]
async fn test_post_object_utf8_filename_substitution() {
let ctx = common::context();
let bucket = ctx.create_bucket("post-object-utf8-filename");
let res = send_post_object(
&ctx,
&bucket,
"uploads/${filename}",
UTF8_FILENAME,
&[],
"bonjour",
)
.await;
assert_eq!(res.status(), StatusCode::NO_CONTENT);
let obj = ctx
.client
.get_object()
.bucket(&bucket)
.key(format!("uploads/{}", UTF8_FILENAME))
.send()
.await
.unwrap();
assert_bytes_eq!(obj.body, b"bonjour");
}
#[tokio::test]
async fn test_post_object_utf8_content_disposition_metadata() {
let ctx = common::context();
let bucket = ctx.create_bucket("post-object-utf8-contdisp");
let res = send_post_object(
&ctx,
&bucket,
"ascii-key.jpg",
"file.jpg",
&[("content-disposition", UTF8_CONTENT_DISPOSITION)],
"data",
)
.await;
assert_eq!(res.status(), StatusCode::NO_CONTENT);
let obj = ctx
.client
.get_object()
.bucket(&bucket)
.key("ascii-key.jpg")
.send()
.await
.unwrap();
assert_eq!(
obj.content_disposition.as_deref(),
Some(UTF8_CONTENT_DISPOSITION)
);
}
+1 -1
View File
@@ -24,7 +24,7 @@ percent-encoding.workspace = true
hyper = { workspace = true, default-features = false, features = ["http1", "http2"] } hyper = { workspace = true, default-features = false, features = ["http1", "http2"] }
hyper-util.workspace = true hyper-util.workspace = true
hyper-rustls.workspace = true hyper-rustls.workspace = true
serde.workspace = true serde = { workspace = true, default-features = false, features = ["derive", "std"] }
serde_json.workspace = true serde_json.workspace = true
thiserror.workspace = true thiserror.workspace = true
tokio.workspace = true tokio.workspace = true
+6
View File
@@ -26,6 +26,10 @@ mod error;
pub use error::Error; pub use error::Error;
// Re-export these crates: values from these are passed to K2vClient::new_with_client
pub use hyper_rustls;
pub use hyper_util;
pub type Body = FullBody<Bytes>; pub type Body = FullBody<Bytes>;
const DEFAULT_TIMEOUT: Duration = Duration::from_secs(5); const DEFAULT_TIMEOUT: Duration = Duration::from_secs(5);
@@ -46,6 +50,7 @@ const PATH_ENCODE_SET: AsciiSet = NON_ALPHANUMERIC
.remove(b'.') .remove(b'.')
.remove(b'~'); .remove(b'~');
#[derive(Debug, Clone)]
pub struct K2vClientConfig { pub struct K2vClientConfig {
pub endpoint: String, pub endpoint: String,
pub region: String, pub region: String,
@@ -56,6 +61,7 @@ pub struct K2vClientConfig {
} }
/// Client used to query a K2V server. /// Client used to query a K2V server.
#[derive(Debug, Clone)]
pub struct K2vClient { pub struct K2vClient {
config: K2vClientConfig, config: K2vClientConfig,
user_agent: HeaderValue, user_agent: HeaderValue,
-1
View File
@@ -30,7 +30,6 @@ thiserror.workspace = true
hex.workspace = true hex.workspace = true
http.workspace = true http.workspace = true
base64.workspace = true base64.workspace = true
parse_duration.workspace = true
tracing.workspace = true tracing.workspace = true
rand.workspace = true rand.workspace = true
zstd.workspace = true zstd.workspace = true
+5 -4
View File
@@ -8,6 +8,7 @@ use garage_table::{EmptyKey, Entry, TableSchema};
pub use crate::key_table::KeyFilter; pub use crate::key_table::KeyFilter;
mod v2 { mod v2 {
use crate::permission::ExpirationTime;
use garage_util::crdt; use garage_util::crdt;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
@@ -35,7 +36,7 @@ mod v2 {
pub name: crdt::Lww<String>, pub name: crdt::Lww<String>,
/// The optional time of expiration of the token /// The optional time of expiration of the token
pub expiration: crdt::Lww<Option<u64>>, pub expiration: crdt::Lww<crdt::MergingOption<ExpirationTime>>,
/// The scope of the token, i.e. list of authorized admin API calls /// The scope of the token, i.e. list of authorized admin API calls
pub scope: crdt::Lww<AdminApiTokenScope>, pub scope: crdt::Lww<AdminApiTokenScope>,
@@ -106,7 +107,7 @@ impl AdminApiToken {
created: now_msec(), created: now_msec(),
token_hash: hashed_token, token_hash: hashed_token,
name: crdt::Lww::new(name.to_string()), name: crdt::Lww::new(name.to_string()),
expiration: crdt::Lww::new(None), expiration: crdt::Lww::new(None.into()),
scope: crdt::Lww::new(AdminApiTokenScope(vec!["*".to_string()])), scope: crdt::Lww::new(AdminApiTokenScope(vec!["*".to_string()])),
}), }),
}; };
@@ -147,9 +148,9 @@ impl AdminApiToken {
impl AdminApiTokenParams { impl AdminApiTokenParams {
pub fn is_expired(&self, ts_now: u64) -> bool { pub fn is_expired(&self, ts_now: u64) -> bool {
match *self.expiration.get() { match self.expiration.get().inner() {
None => false, None => false,
Some(exp) => ts_now >= exp, Some(exp) => ts_now >= exp.0,
} }
} }
+3 -3
View File
@@ -13,7 +13,7 @@ mod v08 {
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)] #[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
pub struct BucketAlias { pub struct BucketAlias {
pub(super) name: String, pub(super) name: String,
pub state: crdt::Lww<Option<Uuid>>, pub state: crdt::Lww<crdt::CancelingOption<Uuid>>,
} }
impl garage_util::migrate::InitialFormat for BucketAlias {} impl garage_util::migrate::InitialFormat for BucketAlias {}
@@ -25,12 +25,12 @@ impl BucketAlias {
pub fn new(name: String, ts: u64, bucket_id: Option<Uuid>) -> Self { pub fn new(name: String, ts: u64, bucket_id: Option<Uuid>) -> Self {
BucketAlias { BucketAlias {
name, name,
state: crdt::Lww::raw(ts, bucket_id), state: crdt::Lww::raw(ts, CancelingOption(bucket_id)),
} }
} }
pub fn is_deleted(&self) -> bool { pub fn is_deleted(&self) -> bool {
self.state.get().is_none() self.state.get().inner().is_none()
} }
pub fn name(&self) -> &str { pub fn name(&self) -> &str {
&self.name &self.name
+9 -9
View File
@@ -45,12 +45,12 @@ mod v08 {
/// Whether this bucket is allowed for website access /// Whether this bucket is allowed for website access
/// (under all of its global alias names), /// (under all of its global alias names),
/// and if so, the website configuration XML document /// and if so, the website configuration XML document
pub website_config: crdt::Lww<Option<WebsiteConfig>>, pub website_config: crdt::Lww<crdt::CancelingOption<WebsiteConfig>>,
/// CORS rules /// CORS rules
pub cors_config: crdt::Lww<Option<Vec<CorsRule>>>, pub cors_config: crdt::Lww<crdt::CancelingOption<Vec<CorsRule>>>,
/// Lifecycle configuration /// Lifecycle configuration
#[serde(default)] #[serde(default)]
pub lifecycle_config: crdt::Lww<Option<Vec<LifecycleRule>>>, pub lifecycle_config: crdt::Lww<crdt::CancelingOption<Vec<LifecycleRule>>>,
/// Bucket quotas /// Bucket quotas
#[serde(default)] #[serde(default)]
pub quotas: crdt::Lww<BucketQuotas>, pub quotas: crdt::Lww<BucketQuotas>,
@@ -164,11 +164,11 @@ mod v2 {
/// Whether this bucket is allowed for website access /// Whether this bucket is allowed for website access
/// (under all of its global alias names), /// (under all of its global alias names),
/// and if so, the website configuration XML document /// and if so, the website configuration XML document
pub website_config: crdt::Lww<Option<WebsiteConfig>>, pub website_config: crdt::Lww<crdt::CancelingOption<WebsiteConfig>>,
/// CORS rules /// CORS rules
pub cors_config: crdt::Lww<Option<Vec<CorsRule>>>, pub cors_config: crdt::Lww<crdt::CancelingOption<Vec<CorsRule>>>,
/// Lifecycle configuration /// Lifecycle configuration
pub lifecycle_config: crdt::Lww<Option<Vec<LifecycleRule>>>, pub lifecycle_config: crdt::Lww<crdt::CancelingOption<Vec<LifecycleRule>>>,
/// Bucket quotas /// Bucket quotas
pub quotas: crdt::Lww<BucketQuotas>, pub quotas: crdt::Lww<BucketQuotas>,
} }
@@ -259,9 +259,9 @@ impl BucketParams {
authorized_keys: crdt::Map::new(), authorized_keys: crdt::Map::new(),
aliases: crdt::LwwMap::new(), aliases: crdt::LwwMap::new(),
local_aliases: crdt::LwwMap::new(), local_aliases: crdt::LwwMap::new(),
website_config: crdt::Lww::new(None), website_config: crdt::Lww::new(None.into()),
cors_config: crdt::Lww::new(None), cors_config: crdt::Lww::new(None.into()),
lifecycle_config: crdt::Lww::new(None), lifecycle_config: crdt::Lww::new(None.into()),
quotas: crdt::Lww::new(BucketQuotas::default()), quotas: crdt::Lww::new(BucketQuotas::default()),
} }
} }
+1 -1
View File
@@ -304,7 +304,7 @@ impl Garage {
self.k2v.spawn_workers(bg); self.k2v.spawn_workers(bg);
if let Some(itv) = self.config.metadata_auto_snapshot_interval.as_deref() { if let Some(itv) = self.config.metadata_auto_snapshot_interval.as_deref() {
let interval = parse_duration::parse(itv) let interval = garage_util::time::parse_duration(itv)
.ok_or_message("Invalid `metadata_auto_snapshot_interval`")?; .ok_or_message("Invalid `metadata_auto_snapshot_interval`")?;
if interval < std::time::Duration::from_secs(600) { if interval < std::time::Duration::from_secs(600) {
return Err(Error::Message( return Err(Error::Message(
+8 -6
View File
@@ -52,7 +52,7 @@ impl<'a> BucketHelper<'a> {
.0 .0
.bucket_alias_table .bucket_alias_table
.get_local(&EmptyKey, bucket_name)? .get_local(&EmptyKey, bucket_name)?
.and_then(|x| *x.state.get()); .and_then(|x| x.state.get().into_inner());
match alias { match alias {
Some(id) => id, Some(id) => id,
None => return Ok(None), None => return Ok(None),
@@ -91,8 +91,11 @@ impl<'a> BucketHelper<'a> {
.as_option() .as_option()
.ok_or_message("Key should not be deleted at this point")?; .ok_or_message("Key should not be deleted at this point")?;
let bucket_opt = let bucket_opt = if let Some(bucket_id) = api_key_params
if let Some(Some(bucket_id)) = api_key_params.local_aliases.get(bucket_name) { .local_aliases
.get(bucket_name)
.and_then(|x| x.inner())
{
self.0 self.0
.bucket_table .bucket_table
.get_local(&EmptyKey, bucket_id)? .get_local(&EmptyKey, bucket_id)?
@@ -125,7 +128,7 @@ impl<'a> BucketHelper<'a> {
.bucket_alias_table .bucket_alias_table
.get(&EmptyKey, bucket_name) .get(&EmptyKey, bucket_name)
.await? .await?
.and_then(|x| *x.state.get()); .and_then(|x| x.state.get().into_inner());
match alias { match alias {
Some(id) => id, Some(id) => id,
None => return Ok(None), None => return Ok(None),
@@ -163,8 +166,7 @@ impl<'a> BucketHelper<'a> {
.ok_or_else(|| GarageError::Message(format!("access key {} has been deleted", key_id)))? .ok_or_else(|| GarageError::Message(format!("access key {} has been deleted", key_id)))?
.local_aliases .local_aliases
.get(bucket_name) .get(bucket_name)
.copied() .and_then(|x| x.inner().copied());
.flatten();
if let Some(bucket_id) = local_alias { if let Some(bucket_id) = local_alias {
Ok(self Ok(self
+34 -18
View File
@@ -74,8 +74,8 @@ impl<'a> LockedHelper<'a> {
let alias = self.0.bucket_alias_table.get(&EmptyKey, alias_name).await?; let alias = self.0.bucket_alias_table.get(&EmptyKey, alias_name).await?;
if let Some(existing_alias) = alias.as_ref() { if let Some(existing_alias) = alias.as_ref() {
if let Some(p_bucket) = existing_alias.state.get() { if let Some(p_bucket) = existing_alias.state.get().into_inner() {
if *p_bucket != bucket_id { if p_bucket != bucket_id {
return Err(Error::BadRequest(format!( return Err(Error::BadRequest(format!(
"Alias {} already exists and points to different bucket: {:?}", "Alias {} already exists and points to different bucket: {:?}",
alias_name, p_bucket alias_name, p_bucket
@@ -98,7 +98,7 @@ impl<'a> LockedHelper<'a> {
let alias = match alias { let alias = match alias {
None => BucketAlias::new(alias_name.clone(), alias_ts, Some(bucket_id)), None => BucketAlias::new(alias_name.clone(), alias_ts, Some(bucket_id)),
Some(mut a) => { Some(mut a) => {
a.state = Lww::raw(alias_ts, Some(bucket_id)); a.state = Lww::raw(alias_ts, Some(bucket_id).into());
a a
} }
}; };
@@ -128,7 +128,13 @@ impl<'a> LockedHelper<'a> {
.bucket_alias_table .bucket_alias_table
.get(&EmptyKey, alias_name) .get(&EmptyKey, alias_name)
.await? .await?
.filter(|a| a.state.get().map(|x| x == bucket_id).unwrap_or(false)) .filter(|a| {
a.state
.get()
.into_inner()
.map(|x| x == bucket_id)
.unwrap_or(false)
})
.ok_or_message(format!( .ok_or_message(format!(
"Internal error: alias not found or does not point to bucket {:?}", "Internal error: alias not found or does not point to bucket {:?}",
bucket_id bucket_id
@@ -157,7 +163,7 @@ impl<'a> LockedHelper<'a> {
// ---- timestamp-ensured causality barrier ---- // ---- timestamp-ensured causality barrier ----
// writes are now done and all writes use timestamp alias_ts // writes are now done and all writes use timestamp alias_ts
alias.state = Lww::raw(alias_ts, None); alias.state = Lww::raw(alias_ts, None.into());
self.0.bucket_alias_table.insert(&alias).await?; self.0.bucket_alias_table.insert(&alias).await?;
bucket_state.aliases = LwwMap::raw_item(alias_name.clone(), alias_ts, false); bucket_state.aliases = LwwMap::raw_item(alias_name.clone(), alias_ts, false);
@@ -199,8 +205,8 @@ impl<'a> LockedHelper<'a> {
// ---- timestamp-ensured causality barrier ---- // ---- timestamp-ensured causality barrier ----
// writes are now done and all writes use timestamp alias_ts // writes are now done and all writes use timestamp alias_ts
if alias.state.get() == &Some(bucket_id) { if alias.state.get().inner() == Some(&bucket_id) {
alias.state = Lww::raw(alias_ts, None); alias.state = Lww::raw(alias_ts, None.into());
self.0.bucket_alias_table.insert(&alias).await?; self.0.bucket_alias_table.insert(&alias).await?;
} }
@@ -237,7 +243,11 @@ impl<'a> LockedHelper<'a> {
let key_param = key.state.as_option_mut().unwrap(); let key_param = key.state.as_option_mut().unwrap();
if let Some(Some(existing_alias)) = key_param.local_aliases.get(alias_name) { if let Some(Some(existing_alias)) = key_param
.local_aliases
.get(alias_name)
.map(CancelingOption::inner)
{
if *existing_alias != bucket_id { if *existing_alias != bucket_id {
return Err(Error::BadRequest(format!("Alias {} already exists in namespace of key {} and points to different bucket: {:?}", alias_name, key.key_id, existing_alias))); return Err(Error::BadRequest(format!("Alias {} already exists in namespace of key {} and points to different bucket: {:?}", alias_name, key.key_id, existing_alias)));
} }
@@ -261,7 +271,8 @@ impl<'a> LockedHelper<'a> {
// ---- timestamp-ensured causality barrier ---- // ---- timestamp-ensured causality barrier ----
// writes are now done and all writes use timestamp alias_ts // writes are now done and all writes use timestamp alias_ts
key_param.local_aliases = LwwMap::raw_item(alias_name.clone(), alias_ts, Some(bucket_id)); key_param.local_aliases =
LwwMap::raw_item(alias_name.clone(), alias_ts, Some(bucket_id).into());
self.0.key_table.insert(&key).await?; self.0.key_table.insert(&key).await?;
bucket_p.local_aliases = LwwMap::raw_item(bucket_p_local_alias_key, alias_ts, true); bucket_p.local_aliases = LwwMap::raw_item(bucket_p_local_alias_key, alias_ts, true);
@@ -288,7 +299,12 @@ impl<'a> LockedHelper<'a> {
let key_p = key.state.as_option().unwrap(); let key_p = key.state.as_option().unwrap();
let bucket_p = bucket.state.as_option_mut().unwrap(); let bucket_p = bucket.state.as_option_mut().unwrap();
if key_p.local_aliases.get(alias_name).cloned().flatten() != Some(bucket_id) { if key_p
.local_aliases
.get(alias_name)
.and_then(CancelingOption::inner)
!= Some(&bucket_id)
{
return Err(GarageError::Message(format!( return Err(GarageError::Message(format!(
"Bucket {:?} does not have alias {} in namespace of key {}", "Bucket {:?} does not have alias {} in namespace of key {}",
bucket_id, alias_name, key_id bucket_id, alias_name, key_id
@@ -325,7 +341,7 @@ impl<'a> LockedHelper<'a> {
// writes are now done and all writes use timestamp alias_ts // writes are now done and all writes use timestamp alias_ts
key.state.as_option_mut().unwrap().local_aliases = key.state.as_option_mut().unwrap().local_aliases =
LwwMap::raw_item(alias_name.clone(), alias_ts, None); LwwMap::raw_item(alias_name.clone(), alias_ts, None.into());
self.0.key_table.insert(&key).await?; self.0.key_table.insert(&key).await?;
bucket_p.local_aliases = LwwMap::raw_item(bucket_p_local_alias_key, alias_ts, false); bucket_p.local_aliases = LwwMap::raw_item(bucket_p_local_alias_key, alias_ts, false);
@@ -367,7 +383,7 @@ impl<'a> LockedHelper<'a> {
// writes are now done and all writes use timestamp alias_ts // writes are now done and all writes use timestamp alias_ts
if let Some(kp) = key.state.as_option_mut() { if let Some(kp) = key.state.as_option_mut() {
kp.local_aliases = LwwMap::raw_item(alias_name.clone(), alias_ts, None); kp.local_aliases = LwwMap::raw_item(alias_name.clone(), alias_ts, None.into());
self.0.key_table.insert(&key).await?; self.0.key_table.insert(&key).await?;
} }
@@ -444,8 +460,8 @@ impl<'a> LockedHelper<'a> {
// 1. Delete local aliases // 1. Delete local aliases
for (alias, _, to) in state.local_aliases.items().iter() { for (alias, _, to) in state.local_aliases.items().iter() {
if let Some(bucket_id) = to { if let Some(bucket_id) = to.into_inner() {
self.purge_local_bucket_alias(*bucket_id, &key.key_id, alias) self.purge_local_bucket_alias(bucket_id, &key.key_id, alias)
.await?; .await?;
} }
} }
@@ -501,7 +517,7 @@ impl<'a> LockedHelper<'a> {
.data .data
.decode_entry(&(item?.1)) .decode_entry(&(item?.1))
.map_err(db::TxError::Abort)?; .map_err(db::TxError::Abort)?;
if let Some(id) = alias.state.get() { if let Some(id) = alias.state.get().inner() {
if all_buckets.contains(id) { if all_buckets.contains(id) {
// keep aliases // keep aliases
global_aliases.insert(alias.name().to_string(), *id); global_aliases.insert(alias.name().to_string(), *id);
@@ -512,7 +528,7 @@ impl<'a> LockedHelper<'a> {
alias.name(), alias.name(),
id id
); );
alias.state.update(None); alias.state.update(None.into());
delete_global.push(alias); delete_global.push(alias);
} }
} }
@@ -544,7 +560,7 @@ impl<'a> LockedHelper<'a> {
}; };
let mut has_changes = false; let mut has_changes = false;
for (name, _, to) in p.local_aliases.items().to_vec() { for (name, _, to) in p.local_aliases.items().to_vec() {
if let Some(id) = to { if let Some(id) = to.into_inner() {
if all_buckets.contains(&id) { if all_buckets.contains(&id) {
local_aliases.insert((key.key_id.clone(), name), id); local_aliases.insert((key.key_id.clone(), name), id);
} else { } else {
@@ -552,7 +568,7 @@ impl<'a> LockedHelper<'a> {
"local alias: remove ({}, {}) -> {:?} (bucket is deleted)", "local alias: remove ({}, {}) -> {:?} (bucket is deleted)",
key.key_id, name, id key.key_id, name, id
); );
p.local_aliases.update_in_place(name, None); p.local_aliases.update_in_place(name, None.into());
has_changes = true; has_changes = true;
} }
} }
+1
View File
@@ -163,6 +163,7 @@ impl<T: CountedItem> TableSchema for CounterTable<T> {
pub struct IndexCounter<T: CountedItem> { pub struct IndexCounter<T: CountedItem> {
this_node: Uuid, this_node: Uuid,
// TODO: migrate to TypedTree
local_counter: db::Tree, local_counter: db::Tree,
pub table: Arc<Table<CounterTable<T>, TableShardedReplication>>, pub table: Arc<Table<CounterTable<T>, TableShardedReplication>>,
} }
+36 -7
View File
@@ -45,6 +45,7 @@ mod v08 {
} }
#[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)] #[derive(PartialEq, Eq, Clone, Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
pub enum DvvsValue { pub enum DvvsValue {
Value(#[serde(with = "serde_bytes")] Vec<u8>), Value(#[serde(with = "serde_bytes")] Vec<u8>),
Deleted, Deleted,
@@ -131,9 +132,26 @@ impl K2VItem {
ent.discard(); ent.discard();
} }
} }
pub fn with_raw_items(items: BTreeMap<K2VNodeId, DvvsEntry>) -> Self {
let mut item = K2VItem {
partition: K2VItemPartition {
bucket_id: [0u8; 32].into(),
partition_key: String::new(),
},
sort_key: String::new(),
items,
};
item.discard();
item
}
} }
impl DvvsEntry { impl DvvsEntry {
pub fn from_raw(t_discard: u64, values: Vec<(u64, DvvsValue)>) -> Self {
DvvsEntry { t_discard, values }
}
fn max_time(&self) -> u64 { fn max_time(&self) -> u64 {
self.values self.values
.iter() .iter()
@@ -162,15 +180,26 @@ impl Crdt for K2VItem {
impl Crdt for DvvsEntry { impl Crdt for DvvsEntry {
fn merge(&mut self, other: &Self) { fn merge(&mut self, other: &Self) {
let mut slf = std::mem::take(&mut self.values).into_iter().peekable();
let mut otr = other.values.iter().peekable();
while let (Some((slf_t, _)), Some((otr_t, _))) = (slf.peek(), otr.peek()) {
match slf_t.cmp(otr_t) {
std::cmp::Ordering::Less => {
self.values.push(slf.next().unwrap());
}
std::cmp::Ordering::Equal => {
self.values.push(slf.next().unwrap());
otr.next();
}
std::cmp::Ordering::Greater => {
self.values.push(otr.next().unwrap().clone());
}
}
}
self.values.extend(slf);
self.values.extend(otr.cloned());
self.t_discard = std::cmp::max(self.t_discard, other.t_discard); self.t_discard = std::cmp::max(self.t_discard, other.t_discard);
self.discard(); self.discard();
let t_max = self.max_time();
for (vt, vv) in other.values.iter() {
if *vt > t_max {
self.values.push((*vt, vv.clone()));
}
}
} }
} }
+59 -3
View File
@@ -5,7 +5,7 @@
//! node does not process the entry directly, as this would //! node does not process the entry directly, as this would
//! mean the vector clock gets much larger than needed). //! mean the vector clock gets much larger than needed).
use std::collections::{BTreeMap, HashMap}; use std::collections::{BTreeMap, BTreeSet, HashMap};
use std::convert::TryInto; use std::convert::TryInto;
use std::sync::{Arc, Mutex, MutexGuard}; use std::sync::{Arc, Mutex, MutexGuard};
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
@@ -38,6 +38,12 @@ const POLL_RANGE_EXTRA_DELAY: Duration = Duration::from_millis(200);
const TIMESTAMP_KEY: &[u8] = b"timestamp"; const TIMESTAMP_KEY: &[u8] = b"timestamp";
#[derive(Debug, Clone, Copy, PartialEq)]
pub enum K2VMonotonicRead {
Monotonic,
NonMonotonic,
}
/// RPC messages for K2V /// RPC messages for K2V
#[derive(Debug, Serialize, Deserialize)] #[derive(Debug, Serialize, Deserialize)]
enum K2VRpc { enum K2VRpc {
@@ -78,6 +84,7 @@ pub struct K2VRpcHandler {
// Using a mutex on the local_timestamp_tree is not strictly necessary, // Using a mutex on the local_timestamp_tree is not strictly necessary,
// but it helps to not try to do several inserts at the same time, // but it helps to not try to do several inserts at the same time,
// which would create transaction conflicts and force many useless retries. // which would create transaction conflicts and force many useless retries.
// TODO: migrate to TypedTree
local_timestamp_tree: Mutex<db::Tree>, local_timestamp_tree: Mutex<db::Tree>,
endpoint: Arc<Endpoint<K2VRpc, Self>>, endpoint: Arc<Endpoint<K2VRpc, Self>>,
@@ -210,6 +217,7 @@ impl K2VRpcHandler {
sort_key: String, sort_key: String,
causal_context: CausalContext, causal_context: CausalContext,
timeout_msec: u64, timeout_msec: u64,
monotonic_read: K2VMonotonicRead,
) -> Result<Option<K2VItem>, Error> { ) -> Result<Option<K2VItem>, Error> {
let poll_key = PollKey { let poll_key = PollKey {
partition: K2VItemPartition { partition: K2VItemPartition {
@@ -244,11 +252,19 @@ impl K2VRpcHandler {
}; };
let mut resp: Option<K2VItem> = None; let mut resp: Option<K2VItem> = None;
let mut not_all_same = false;
{
let mut vals_nb = 0;
let resps_nb = resps.len();
for v in resps { for v in resps {
match v { match v {
K2VRpc::PollItemResponse(Some(x)) => { K2VRpc::PollItemResponse(Some(x)) => {
vals_nb += 1;
if let Some(y) = &mut resp { if let Some(y) = &mut resp {
if *y != x {
not_all_same = true;
y.merge(&x); y.merge(&x);
}
} else { } else {
resp = Some(x); resp = Some(x);
} }
@@ -257,6 +273,16 @@ impl K2VRpcHandler {
v => return Err(Error::unexpected_rpc_message(v)), v => return Err(Error::unexpected_rpc_message(v)),
} }
} }
if vals_nb < resps_nb {
not_all_same = true;
}
}
if let Some(v) = &resp {
if monotonic_read == K2VMonotonicRead::Monotonic && not_all_same {
self.item_table.repair_on_read(&nodes, &[v]).await?;
}
}
Ok(resp) Ok(resp)
} }
@@ -266,6 +292,7 @@ impl K2VRpcHandler {
range: PollRange, range: PollRange,
seen_str: Option<String>, seen_str: Option<String>,
timeout_msec: u64, timeout_msec: u64,
monotonic_read: K2VMonotonicRead,
) -> Result<Option<(BTreeMap<String, K2VItem>, String)>, HelperError> { ) -> Result<Option<(BTreeMap<String, K2VItem>, String)>, HelperError> {
let has_seen_marker = seen_str.is_some(); let has_seen_marker = seen_str.is_some();
@@ -343,24 +370,53 @@ impl K2VRpcHandler {
// Take all returned items into account to produce the response. // Take all returned items into account to produce the response.
let mut new_items = BTreeMap::<String, K2VItem>::new(); let mut new_items = BTreeMap::<String, K2VItem>::new();
let mut to_repair = BTreeSet::new();
{
let mut all_items: BTreeMap<_, Vec<_>> = BTreeMap::new();
let resps_nb = resps.len();
for v in resps { for v in resps {
if let K2VRpc::PollRangeResponse(node, items) = v { if let K2VRpc::PollRangeResponse(node, items) = v {
seen.mark_seen_node_items(node, items.iter()); seen.mark_seen_node_items(node, items.iter());
for item in items.into_iter() {
all_items
.entry(item.sort_key.clone())
.or_default()
.push(item);
}
} else {
return Err(Error::unexpected_rpc_message(v).into());
}
}
for (item_key, items) in all_items {
// Only some nodes store this item; we must propagate it during repair
if items.len() < resps_nb {
to_repair.insert(item_key.clone());
}
// Merge all items for this key together
for item in items.into_iter() { for item in items.into_iter() {
match new_items.get_mut(&item.sort_key) { match new_items.get_mut(&item.sort_key) {
Some(ent) => { Some(ent) => {
if *ent != item {
ent.merge(&item); ent.merge(&item);
to_repair.insert(item.sort_key.clone());
}
} }
None => { None => {
new_items.insert(item.sort_key.clone(), item); new_items.insert(item.sort_key.clone(), item);
} }
} }
} }
} else {
return Err(Error::unexpected_rpc_message(v).into());
} }
} }
if monotonic_read == K2VMonotonicRead::Monotonic && !to_repair.is_empty() {
let to_repair: Vec<_> = to_repair
.into_iter()
.map(|k| new_items.get(&k).unwrap())
.collect();
self.item_table.repair_on_read(&nodes, &to_repair).await?;
}
if new_items.is_empty() && has_seen_marker { if new_items.is_empty() && has_seen_marker {
Ok(None) Ok(None)
} else { } else {
+8 -7
View File
@@ -43,7 +43,7 @@ mod v08 {
/// A key can have a local view of buckets names it is /// A key can have a local view of buckets names it is
/// the only one to see, this is the namespace for these aliases /// the only one to see, this is the namespace for these aliases
pub local_aliases: crdt::LwwMap<String, Option<Uuid>>, pub local_aliases: crdt::LwwMap<String, crdt::CancelingOption<Uuid>>,
} }
impl garage_util::migrate::InitialFormat for Key {} impl garage_util::migrate::InitialFormat for Key {}
@@ -51,6 +51,7 @@ mod v08 {
mod v2 { mod v2 {
use crate::permission::BucketKeyPerm; use crate::permission::BucketKeyPerm;
use crate::permission::ExpirationTime;
use garage_util::crdt; use garage_util::crdt;
use garage_util::data::Uuid; use garage_util::data::Uuid;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
@@ -79,7 +80,7 @@ mod v2 {
/// Name for the key /// Name for the key
pub name: crdt::Lww<String>, pub name: crdt::Lww<String>,
/// The optional time of expiration of the key /// The optional time of expiration of the key
pub expiration: crdt::Lww<Option<u64>>, pub expiration: crdt::Lww<crdt::MergingOption<ExpirationTime>>,
/// Flag to allow users having this key to create buckets /// Flag to allow users having this key to create buckets
pub allow_create_bucket: crdt::Lww<bool>, pub allow_create_bucket: crdt::Lww<bool>,
@@ -91,7 +92,7 @@ mod v2 {
/// A key can have a local view of buckets names it is /// A key can have a local view of buckets names it is
/// the only one to see, this is the namespace for these aliases /// the only one to see, this is the namespace for these aliases
pub local_aliases: crdt::LwwMap<String, Option<Uuid>>, pub local_aliases: crdt::LwwMap<String, crdt::CancelingOption<Uuid>>,
} }
impl garage_util::migrate::Migrate for Key { impl garage_util::migrate::Migrate for Key {
@@ -106,7 +107,7 @@ mod v2 {
created: None, created: None,
secret_key: x.secret_key, secret_key: x.secret_key,
name: x.name, name: x.name,
expiration: crdt::Lww::raw(0, None), expiration: crdt::Lww::raw(0, None.into()),
allow_create_bucket: x.allow_create_bucket, allow_create_bucket: x.allow_create_bucket,
authorized_buckets: x.authorized_buckets, authorized_buckets: x.authorized_buckets,
local_aliases: x.local_aliases, local_aliases: x.local_aliases,
@@ -124,7 +125,7 @@ impl KeyParams {
created: Some(now_msec()), created: Some(now_msec()),
secret_key: secret_key.to_string(), secret_key: secret_key.to_string(),
name: crdt::Lww::new(name.to_string()), name: crdt::Lww::new(name.to_string()),
expiration: crdt::Lww::new(None), expiration: crdt::Lww::new(None.into()),
allow_create_bucket: crdt::Lww::new(false), allow_create_bucket: crdt::Lww::new(false),
authorized_buckets: crdt::Map::new(), authorized_buckets: crdt::Map::new(),
local_aliases: crdt::LwwMap::new(), local_aliases: crdt::LwwMap::new(),
@@ -229,9 +230,9 @@ impl Key {
impl KeyParams { impl KeyParams {
pub fn is_expired(&self, ts_now: u64) -> bool { pub fn is_expired(&self, ts_now: u64) -> bool {
match *self.expiration.get() { match self.expiration.get().inner() {
None => false, None => false,
Some(exp) => ts_now >= exp, Some(exp) => ts_now >= exp.0,
} }
} }
} }
+12
View File
@@ -63,3 +63,15 @@ impl Crdt for BucketKeyPerm {
} }
} }
} }
/// Expiration date for a key or token
#[derive(PartialOrd, Ord, PartialEq, Eq, Clone, Copy, Debug, Serialize, Deserialize)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[serde(transparent)]
pub struct ExpirationTime(pub u64);
impl Crdt for ExpirationTime {
fn merge(&mut self, other: &Self) {
self.0 = std::cmp::min(self.0, other.0);
}
}
+1 -1
View File
@@ -271,7 +271,7 @@ async fn process_object(
let lifecycle_policy: &[LifecycleRule] = bucket let lifecycle_policy: &[LifecycleRule] = bucket
.state .state
.as_option() .as_option()
.and_then(|s| s.lifecycle_config.get().as_deref()) .and_then(|s| s.lifecycle_config.get().inner().map(|x| &x[..]))
.unwrap_or_default(); .unwrap_or_default();
if lifecycle_policy.iter().all(|x| !x.enabled) { if lifecycle_policy.iter().all(|x| !x.enabled) {
+7
View File
@@ -43,6 +43,7 @@ pub(crate) const NETAPP_VERSION_TAG: u64 = 0x6772676e65740010; // grgnet 0x0010
/// Time a connection must be idle before the first keepalive probe is sent. /// Time a connection must be idle before the first keepalive probe is sent.
const TCP_KEEPALIVE_TIME: Duration = Duration::from_secs(30); const TCP_KEEPALIVE_TIME: Duration = Duration::from_secs(30);
/// Interval between keepalive probes after the first. /// Interval between keepalive probes after the first.
#[cfg(not(target_os = "openbsd"))]
const TCP_KEEPALIVE_INTERVAL: Duration = Duration::from_secs(10); const TCP_KEEPALIVE_INTERVAL: Duration = Duration::from_secs(10);
/// Timeout for outgoing TCP connection attempts. /// Timeout for outgoing TCP connection attempts.
@@ -52,9 +53,15 @@ const CONNECT_TIMEOUT: Duration = Duration::from_secs(10);
fn set_keepalive(stream: &TcpStream) -> Result<(), std::io::Error> { fn set_keepalive(stream: &TcpStream) -> Result<(), std::io::Error> {
let sock_ref = socket2::SockRef::from(stream); let sock_ref = socket2::SockRef::from(stream);
// OpenBSD does not support with_interval method
#[cfg(not(target_os = "openbsd"))]
let keepalive = socket2::TcpKeepalive::new() let keepalive = socket2::TcpKeepalive::new()
.with_time(TCP_KEEPALIVE_TIME) .with_time(TCP_KEEPALIVE_TIME)
.with_interval(TCP_KEEPALIVE_INTERVAL); .with_interval(TCP_KEEPALIVE_INTERVAL);
#[cfg(target_os = "openbsd")]
let keepalive = socket2::TcpKeepalive::new().with_time(TCP_KEEPALIVE_TIME);
sock_ref.set_tcp_keepalive(&keepalive) sock_ref.set_tcp_keepalive(&keepalive)
} }
+23 -5
View File
@@ -3,7 +3,7 @@ use std::collections::{HashMap, HashSet};
use std::io::{Read, Write}; use std::io::{Read, Write};
use std::net::{IpAddr, SocketAddr}; use std::net::{IpAddr, SocketAddr};
use std::path::{Path, PathBuf}; use std::path::{Path, PathBuf};
use std::sync::{Arc, RwLock, RwLockReadGuard}; use std::sync::{Arc, Mutex, RwLock, RwLockReadGuard};
use std::time::{Duration, Instant}; use std::time::{Duration, Instant};
use arc_swap::ArcSwapOption; use arc_swap::ArcSwapOption;
@@ -24,6 +24,7 @@ use garage_util::config::KubernetesDiscoveryConfig;
use garage_util::config::{Config, DataDirEnum}; use garage_util::config::{Config, DataDirEnum};
use garage_util::data::*; use garage_util::data::*;
use garage_util::error::*; use garage_util::error::*;
use garage_util::migrate::Migrate;
use garage_util::persister::Persister; use garage_util::persister::Persister;
use garage_util::time::*; use garage_util::time::*;
@@ -89,6 +90,9 @@ pub struct System {
pub id: Uuid, pub id: Uuid,
persist_peer_list: Persister<PeerList>, persist_peer_list: Persister<PeerList>,
// Cache of the bytes last read from / written to the peer list file,
// to avoid waking up the disk with a read on every save_peer_list() call.
cached_peer_list_bytes: Mutex<Option<Vec<u8>>>,
pub(crate) local_status: RwLock<NodeStatus>, pub(crate) local_status: RwLock<NodeStatus>,
node_status: RwLock<HashMap<Uuid, (u64, NodeStatus)>>, node_status: RwLock<HashMap<Uuid, (u64, NodeStatus)>>,
@@ -311,6 +315,7 @@ impl System {
let sys = Arc::new(System { let sys = Arc::new(System {
id: netapp.id.into(), id: netapp.id.into(),
persist_peer_list, persist_peer_list,
cached_peer_list_bytes: Mutex::new(None),
local_status: RwLock::new(local_status), local_status: RwLock::new(local_status),
node_status: RwLock::new(HashMap::new()), node_status: RwLock::new(HashMap::new()),
netapp: netapp.clone(), netapp: netapp.clone(),
@@ -779,10 +784,23 @@ impl System {
peer_list.extend(prev_peer_list.0); peer_list.extend(prev_peer_list.0);
} }
// Save new peer list to file // Sort for a deterministic encoding, so that we can detect below
self.persist_peer_list // whether the peer list actually changed since last time.
.save_async(&PeerList(peer_list)) peer_list.sort_by_key(|(id, _)| *id);
.await
let new_peer_list = PeerList(peer_list);
let new_peer_list_bytes = new_peer_list.encode()?;
// Skip writing to disk if nothing changed since the last save,
// but still cache the bytes so we don't have to read the file again.
let cached_peer_list_bytes = self.cached_peer_list_bytes.lock().unwrap().clone();
if cached_peer_list_bytes.as_deref() == Some(&new_peer_list_bytes[..]) {
return Ok(());
}
self.persist_peer_list.save_async(&new_peer_list).await?;
*self.cached_peer_list_bytes.lock().unwrap() = Some(new_peer_list_bytes);
Ok(())
} }
} }
+5
View File
@@ -26,15 +26,20 @@ pub struct TableData<F: TableSchema, R: TableReplication> {
pub instance: F, pub instance: F,
pub replication: R, pub replication: R,
// TODO: migrate to TypedTree
pub store: db::Tree, pub store: db::Tree,
// TODO: migrate to TypedTree
pub(crate) merkle_tree: db::Tree, pub(crate) merkle_tree: db::Tree,
// TODO: migrate to TypedTree
pub(crate) merkle_todo: db::Tree, pub(crate) merkle_todo: db::Tree,
pub(crate) merkle_todo_notify: Notify, pub(crate) merkle_todo_notify: Notify,
// TODO: migrate to TypedTree
pub(crate) insert_queue: db::Tree, pub(crate) insert_queue: db::Tree,
pub(crate) insert_queue_notify: Arc<Notify>, pub(crate) insert_queue_notify: Arc<Notify>,
// TODO: migrate to TypedTree
pub(crate) gc_todo: db::Tree, pub(crate) gc_todo: db::Tree,
pub(crate) metrics: TableMetrics, pub(crate) metrics: TableMetrics,
+92 -29
View File
@@ -293,7 +293,26 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
let span = tracer.start(format!("{} get", F::TABLE_NAME)); let span = tracer.start(format!("{} get", F::TABLE_NAME));
let res = self let res = self
.get_internal(partition_key, sort_key) .get_internal(partition_key, sort_key, false)
.bound_record_duration(&self.data.metrics.get_request_duration)
.with_context(Context::current_with_span(span))
.await?;
self.data.metrics.get_request_counter.add(1);
Ok(res)
}
pub async fn get_monotonic(
self: &Arc<Self>,
partition_key: &F::P,
sort_key: &F::S,
) -> Result<Option<F::E>, Error> {
let tracer = opentelemetry::global::tracer("garage_table");
let span = tracer.start(format!("{} get_monotonic", F::TABLE_NAME));
let res = self
.get_internal(partition_key, sort_key, true)
.bound_record_duration(&self.data.metrics.get_request_duration) .bound_record_duration(&self.data.metrics.get_request_duration)
.with_context(Context::current_with_span(span)) .with_context(Context::current_with_span(span))
.await?; .await?;
@@ -307,6 +326,7 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
self: &Arc<Self>, self: &Arc<Self>,
partition_key: &F::P, partition_key: &F::P,
sort_key: &F::S, sort_key: &F::S,
monotonic_read: bool,
) -> Result<Option<F::E>, Error> { ) -> Result<Option<F::E>, Error> {
let hash = partition_key.hash(); let hash = partition_key.hash();
let who = self.data.replication.read_nodes(&hash)?; let who = self.data.replication.read_nodes(&hash)?;
@@ -326,9 +346,12 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
let mut ret = None; let mut ret = None;
let mut not_all_same = false; let mut not_all_same = false;
for resp in resps { {
let mut vals_nb = 0;
for resp in &resps {
if let TableRpc::ReadEntryResponse(value) = resp { if let TableRpc::ReadEntryResponse(value) = resp {
if let Some(v_bytes) = value { if let Some(v_bytes) = value {
vals_nb += 1;
let v = self.data.decode_entry(v_bytes.as_slice())?; let v = self.data.decode_entry(v_bytes.as_slice())?;
ret = match ret { ret = match ret {
None => Some(v), None => Some(v),
@@ -345,15 +368,15 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
return Err(Error::Message("Invalid return value to read".to_string())); return Err(Error::Message("Invalid return value to read".to_string()));
} }
} }
if let Some(ret_entry) = &ret { // Only some nodes store this value; we must propagate it during repair
if not_all_same { if vals_nb < resps.len() {
let self2 = self.clone(); not_all_same = true;
let ent2 = ret_entry.clone();
tokio::spawn(async move {
if let Err(e) = self2.repair_on_read(&who[..], ent2).await {
warn!("Error doing repair on read: {}", e);
} }
}); }
if let Some(ret_entry) = &ret {
if monotonic_read && not_all_same {
self.repair_on_read(&who, &[ret_entry]).await?;
} }
} }
@@ -378,6 +401,36 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
filter, filter,
limit, limit,
enumeration_order, enumeration_order,
false,
)
.bound_record_duration(&self.data.metrics.get_request_duration)
.with_context(Context::current_with_span(span))
.await?;
self.data.metrics.get_request_counter.add(1);
Ok(res)
}
pub async fn get_range_monotonic(
self: &Arc<Self>,
partition_key: &F::P,
begin_sort_key: Option<F::S>,
filter: Option<F::Filter>,
limit: usize,
enumeration_order: EnumerationOrder,
) -> Result<Vec<F::E>, Error> {
let tracer = opentelemetry::global::tracer("garage_table");
let span = tracer.start(format!("{} get_range_monotonic", F::TABLE_NAME));
let res = self
.get_range_internal(
partition_key,
begin_sort_key,
filter,
limit,
enumeration_order,
true,
) )
.bound_record_duration(&self.data.metrics.get_request_duration) .bound_record_duration(&self.data.metrics.get_request_duration)
.with_context(Context::current_with_span(span)) .with_context(Context::current_with_span(span))
@@ -395,6 +448,7 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
filter: Option<F::Filter>, filter: Option<F::Filter>,
limit: usize, limit: usize,
enumeration_order: EnumerationOrder, enumeration_order: EnumerationOrder,
monotonic_read: bool,
) -> Result<Vec<F::E>, Error> { ) -> Result<Vec<F::E>, Error> {
let hash = partition_key.hash(); let hash = partition_key.hash();
let who = self.data.replication.read_nodes(&hash)?; let who = self.data.replication.read_nodes(&hash)?;
@@ -421,11 +475,26 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
let mut ret: BTreeMap<Vec<u8>, F::E> = BTreeMap::new(); let mut ret: BTreeMap<Vec<u8>, F::E> = BTreeMap::new();
let mut to_repair = BTreeSet::new(); let mut to_repair = BTreeSet::new();
for resp in resps { {
let mut all_entries: BTreeMap<Vec<u8>, Vec<F::E>> = BTreeMap::new();
for resp in &resps {
if let TableRpc::Update(entries) = resp { if let TableRpc::Update(entries) = resp {
for entry_bytes in entries.iter() { for entry_bytes in entries.iter() {
let entry = self.data.decode_entry(entry_bytes.as_slice())?; let entry = self.data.decode_entry(entry_bytes.as_slice())?;
let entry_key = self.data.tree_key(entry.partition_key(), entry.sort_key()); let entry_key = self.data.tree_key(entry.partition_key(), entry.sort_key());
all_entries.entry(entry_key).or_default().push(entry);
}
} else {
return Err(Error::unexpected_rpc_message(resp));
}
}
for (entry_key, entries) in all_entries {
// Only some nodes store this entry; we must propagate it during repair
if entries.len() < resps.len() {
to_repair.insert(entry_key.clone());
}
// Merge all entries for this key together
for entry in entries {
match ret.get_mut(&entry_key) { match ret.get_mut(&entry_key) {
Some(e) => { Some(e) => {
if *e != entry { if *e != entry {
@@ -434,28 +503,19 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
} }
} }
None => { None => {
ret.insert(entry_key, entry); ret.insert(entry_key.clone(), entry);
} }
} }
} }
} else {
return Err(Error::unexpected_rpc_message(resp));
} }
} }
if !to_repair.is_empty() { if monotonic_read && !to_repair.is_empty() {
let self2 = self.clone(); let to_repair: Vec<_> = to_repair
let to_repair = to_repair
.into_iter() .into_iter()
.map(|k| ret.get(&k).unwrap().clone()) .map(|k| ret.get(&k).unwrap())
.collect::<Vec<_>>(); .collect();
tokio::spawn(async move { self.repair_on_read(&who, &to_repair).await?;
for v in to_repair {
if let Err(e) = self2.repair_on_read(&who[..], v).await {
warn!("Error doing repair on read: {}", e);
}
}
});
} }
// At this point, the `ret` btreemap might contain more than `limit` // At this point, the `ret` btreemap might contain more than `limit`
@@ -493,14 +553,17 @@ impl<F: TableSchema, R: TableReplication> Table<F, R> {
// =============== UTILITY FUNCTION FOR CLIENT OPERATIONS =============== // =============== UTILITY FUNCTION FOR CLIENT OPERATIONS ===============
async fn repair_on_read(&self, who: &[Uuid], what: F::E) -> Result<(), Error> { pub async fn repair_on_read(&self, who: &[Uuid], what: &[&F::E]) -> Result<(), Error> {
let what_enc = Arc::new(ByteBuf::from(what.encode()?)); let what_enc = what
.iter()
.map(|v| Ok(Arc::new(ByteBuf::from(v.encode()?))))
.collect::<Result<Vec<_>, Error>>()?;
self.system self.system
.rpc_helper() .rpc_helper()
.try_call_many( .try_call_many(
&self.endpoint, &self.endpoint,
who, who,
TableRpc::<F>::Update(vec![what_enc]), TableRpc::<F>::Update(what_enc),
RequestStrategy::with_priority(PRIO_NORMAL).with_quorum(who.len()), RequestStrategy::with_priority(PRIO_NORMAL).with_quorum(who.len()),
) )
.await?; .await?;
+2
View File
@@ -22,6 +22,8 @@ arc-swap.workspace = true
async-trait.workspace = true async-trait.workspace = true
blake2.workspace = true blake2.workspace = true
bytesize.workspace = true bytesize.workspace = true
fundu.workspace = true
fundu-systemd.workspace = true
thiserror.workspace = true thiserror.workspace = true
hexdump.workspace = true hexdump.workspace = true
xxhash-rust.workspace = true xxhash-rust.workspace = true
+7 -1
View File
@@ -282,7 +282,13 @@ pub fn default_block_max_concurrent_writes_per_request() -> usize {
} }
/// Read and parse configuration /// Read and parse configuration
pub fn read_config(config_file: PathBuf) -> Result<Config, Error> { pub fn read_config(config_file: PathBuf) -> Result<Config, Error> {
let config = std::fs::read_to_string(config_file)?; let config = std::fs::read_to_string(&config_file).map_err(|e| {
format!(
"Failed to read config file {}: {}",
config_file.display(),
e
)
})?;
Ok(toml::from_str(&config)?) Ok(toml::from_str(&config)?)
} }
-22
View File
@@ -26,28 +26,6 @@ pub trait Crdt {
fn merge(&mut self, other: &Self); fn merge(&mut self, other: &Self);
} }
/// `Option<T>` implements Crdt for any type T, even if T doesn't implement CRDT itself: when
/// different values are detected, they are always merged to None. This can be used for value
/// types which shoulnd't be merged, instead of trying to merge things when we know we don't want
/// to merge them (which is what the `AutoCrdt` trait is used for most of the time). This cases
/// arises very often, for example with a Lww or a `LwwMap`: the value type has to be a CRDT so that
/// we have a rule for what to do when timestamps aren't enough to disambiguate (in a distributed
/// system, anything can happen!), and with `AutoCrdt` the rule is to make an arbitrary (but
/// deterministic) choice between the two. When using an `Option<T>` instead with this impl, ambiguity
/// cases are explicitly stored as None, which allows us to detect the ambiguity and handle it in
/// the way we want. (this can only work if we are happy with losing the value when an ambiguity
/// arises)
impl<T> Crdt for Option<T>
where
T: Eq,
{
fn merge(&mut self, other: &Self) {
if self != other {
*self = None;
}
}
}
/// All types that implement `Ord` (a total order) can also implement a trivial CRDT /// All types that implement `Ord` (a total order) can also implement a trivial CRDT
/// defined by the merge rule: `a ⊔ b = max(a, b)`. Implement this trait for your type /// defined by the merge rule: `a ⊔ b = max(a, b)`. Implement this trait for your type
/// to enable this behavior. /// to enable this behavior.
+2
View File
@@ -16,6 +16,7 @@ mod deletable;
mod lww; mod lww;
mod lww_map; mod lww_map;
mod map; mod map;
mod option;
pub use self::bool::*; pub use self::bool::*;
pub use crdt::*; pub use crdt::*;
@@ -23,3 +24,4 @@ pub use deletable::*;
pub use lww::*; pub use lww::*;
pub use lww_map::*; pub use lww_map::*;
pub use map::*; pub use map::*;
pub use option::*;
+97
View File
@@ -0,0 +1,97 @@
use serde::{Deserialize, Serialize};
use crate::crdt::Crdt;
#[derive(Serialize, Deserialize, Clone, Default, Copy, PartialEq, Eq, Debug)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[serde(transparent)]
pub struct CancelingOption<T>(pub Option<T>);
/// `CancelingOption<T>` implements Crdt for any type T, even if T doesn't implement CRDT itself: when
/// different values are detected, they are always merged to None. This can be used for value
/// types which shoulnd't be merged, instead of trying to merge things when we know we don't want
/// to merge them (which is what the `AutoCrdt` trait is used for most of the time). This cases
/// arises very often, for example with a Lww or a `LwwMap`: the value type has to be a CRDT so that
/// we have a rule for what to do when timestamps aren't enough to disambiguate (in a distributed
/// system, anything can happen!), and with `AutoCrdt` the rule is to make an arbitrary (but
/// deterministic) choice between the two. When using an `CancelingOption<T>` instead with this impl, ambiguity
/// cases are explicitly stored as None, which allows us to detect the ambiguity and handle it in
/// the way we want. (this can only work if we are happy with losing the value when an ambiguity
/// arises)
impl<T> Crdt for CancelingOption<T>
where
T: Eq + Clone,
{
fn merge(&mut self, other: &Self) {
match (self.0.as_ref(), other.0.as_ref()) {
(Some(a), Some(b)) if a != b => {
self.0 = None;
}
(None, Some(b)) => {
self.0 = Some(b.clone());
}
_ => {}
}
}
}
impl<T> CancelingOption<T> {
pub fn inner(&self) -> Option<&T> {
self.0.as_ref()
}
pub fn into_inner(self) -> Option<T> {
self.0
}
pub fn map<U>(self, f: impl FnOnce(T) -> U) -> CancelingOption<U> {
CancelingOption(self.0.map(f))
}
}
impl<T> From<Option<T>> for CancelingOption<T> {
fn from(x: Option<T>) -> Self {
Self(x)
}
}
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq, Copy, Default)]
#[cfg_attr(feature = "arbitrary", derive(arbitrary::Arbitrary))]
#[serde(transparent)]
pub struct MergingOption<T>(pub Option<T>);
/// `MergingOption<T>` implements `Crdt` when `T` implements `Crdt`:
/// None is a bottom value, and different Some values get merged according
/// to their Crdt operator.
impl<T> Crdt for MergingOption<T>
where
T: Crdt + Clone,
{
fn merge(&mut self, other: &Self) {
if let (Some(a), Some(b)) = (self.0.as_mut(), other.0.as_ref()) {
a.merge(b);
} else {
self.0 = self.0.take().or_else(|| other.0.clone());
}
}
}
impl<T> MergingOption<T> {
pub fn inner(&self) -> Option<&T> {
self.0.as_ref()
}
pub fn into_inner(self) -> Option<T> {
self.0
}
pub fn map<U>(self, f: impl FnOnce(T) -> U) -> MergingOption<U> {
MergingOption(self.0.map(f))
}
}
impl<T> From<Option<T>> for MergingOption<T> {
fn from(x: Option<T>) -> Self {
Self(x)
}
}
+15
View File
@@ -155,6 +155,21 @@ pub fn gen_uuid() -> Uuid {
rand::rng().random::<[u8; 32]>().into() rand::rng().random::<[u8; 32]>().into()
} }
impl garage_db::DbBytes for FixedBytes32 {
fn encode(&self) -> Vec<u8> {
self.0.into()
}
fn decode(bytes: &[u8]) -> std::result::Result<Self, garage_db::DecodeError> {
Self::try_from(bytes).ok_or_else(|| {
garage_db::DecodeError(
format!("invalid hash: expected 32 bytes, got {}", bytes.len()).into(),
)
})
}
}
impl garage_db::DbOrdKey for FixedBytes32 {}
#[cfg(test)] #[cfg(test)]
mod test { mod test {
use super::*; use super::*;
+12
View File
@@ -79,6 +79,18 @@ impl Error {
} }
} }
impl From<garage_db::DbError> for Error {
fn from(e: garage_db::DbError) -> Error {
Error::Db(e.into())
}
}
impl From<garage_db::DecodeError> for Error {
fn from(e: garage_db::DecodeError) -> Error {
Error::Db(e.into())
}
}
impl From<garage_db::TxError<Error>> for Error { impl From<garage_db::TxError<Error>> for Error {
fn from(e: garage_db::TxError<Error>) -> Error { fn from(e: garage_db::TxError<Error>) -> Error {
match e { match e {
+14 -1
View File
@@ -1,6 +1,9 @@
//! Module containing helper functions to manipulate time //! Module containing helper functions to manipulate time
use chrono::{SecondsFormat, TimeZone, Utc}; use chrono::{SecondsFormat, TimeZone, Utc};
use std::time::{SystemTime, UNIX_EPOCH}; use std::convert::TryInto;
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use crate::error::Error;
/// Returns milliseconds since UNIX Epoch /// Returns milliseconds since UNIX Epoch
pub fn now_msec() -> u64 { pub fn now_msec() -> u64 {
@@ -28,3 +31,13 @@ pub fn msec_to_rfc3339(msecs: u64) -> String {
let timestamp = Utc.timestamp_opt(secs, nanos).unwrap(); let timestamp = Utc.timestamp_opt(secs, nanos).unwrap();
timestamp.to_rfc3339_opts(SecondsFormat::Millis, true) timestamp.to_rfc3339_opts(SecondsFormat::Millis, true)
} }
/// Parse a systemd-style duration using fundu
pub fn parse_duration(s: &str) -> Result<Duration, Error> {
fundu_systemd::parse(s, Some(fundu::TimeUnit::Second), None)
.map_err(|err| Error::Message(err.to_string()))
.and_then(|dur| {
dur.try_into()
.map_err(|err: fundu::TryFromDurationError| Error::Message(err.to_string()))
})
}
+1
View File
@@ -20,6 +20,7 @@ garage_model.workspace = true
garage_util.workspace = true garage_util.workspace = true
garage_table.workspace = true garage_table.workspace = true
html-escape.workspace = true
thiserror.workspace = true thiserror.workspace = true
tracing.workspace = true tracing.workspace = true
percent-encoding.workspace = true percent-encoding.workspace = true
+3 -3
View File
@@ -241,7 +241,7 @@ impl WebServer {
.bucket_alias_table .bucket_alias_table
.get(&EmptyKey, &bucket_name.to_string()) .get(&EmptyKey, &bucket_name.to_string())
.await? .await?
.and_then(|x| x.state.take()) .and_then(|x| x.state.get().into_inner())
.ok_or(Error::NotFound)?; .ok_or(Error::NotFound)?;
// Check bucket isn't deleted and has website access enabled // Check bucket isn't deleted and has website access enabled
@@ -256,7 +256,7 @@ impl WebServer {
let website_config = bucket_params let website_config = bucket_params
.website_config .website_config
.get() .get()
.as_ref() .inner()
.ok_or(Error::NotFound)?; .ok_or(Error::NotFound)?;
// Get path // Get path
@@ -483,7 +483,7 @@ fn error_to_res(e: Error) -> Response<BoxBody<Error>> {
<li>Message: {s3_message}.</li> <li>Message: {s3_message}.</li>
</ul>", </ul>",
s3_code = err.aws_code(), s3_code = err.aws_code(),
s3_message = err, s3_message = html_escape::encode_text(&err.to_string()),
)); ));
} }
let mut http_error = Response::new(string_body(body_str)); let mut http_error = Response::new(string_body(body_str));