1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
use self::error::WtmError;
use core::{borrow::Borrow, future::Future};
use super::*;
mod blocking;
/// AsyncWtm is used to perform writes to the database. It is created by
/// calling [`AsyncTm::write`].
pub struct AsyncWtm<K, V, C, P, S> {
pub(super) read_ts: u64,
pub(super) size: u64,
pub(super) count: u64,
pub(super) orc: Arc<Oracle<C, S>>,
pub(super) conflict_manager: Option<C>,
// buffer stores any writes done by txn.
pub(super) pending_writes: Option<P>,
// Used in managed mode to store duplicate entries.
pub(super) duplicate_writes: OneOrMore<Entry<K, V>>,
pub(super) discarded: bool,
pub(super) done_read: bool,
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S> {
/// Returns the version of this read transaction.
#[inline]
pub const fn version(&self) -> u64 {
self.read_ts
}
/// Sets the current read version of the transaction manager.
// This should be used only for testing purposes.
#[doc(hidden)]
#[inline]
pub fn __set_read_version(&mut self, version: u64) {
self.read_ts = version;
}
/// Returns the pending writes manager.
///
/// `None` means the transaction has already been discarded.
#[inline]
pub fn pwm(&self) -> Option<&P> {
self.pending_writes.as_ref()
}
/// Returns the conflict manager.
///
/// `None` means the transaction has already been discarded.
#[inline]
pub fn cm(&self) -> Option<&C> {
self.conflict_manager.as_ref()
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCm<Key = K>,
{
/// This method is used to create a marker for the keys that are operated.
/// It must be used to mark keys when end user is implementing iterators to
/// make sure the transaction manager works correctly.
///
/// `None` means the transaction has already been discarded.
///
/// e.g.
///
/// ```ignore, rust
/// let mut txn = custom_database.write(conflict_manger_opts, pending_manager_opts).unwrap();
/// let mut marker = txn.marker();
/// custom_database.iter().map(|k, v| marker.mark(&k));
/// ```
pub fn marker(&mut self) -> Option<AsyncMarker<'_, C>> {
self.conflict_manager.as_mut().map(AsyncMarker::new)
}
/// Returns a marker for the keys that are operated and the pending writes manager.
///
/// `None` means the transaction has already been discarded.
///
/// As Rust's borrow checker does not allow to borrow mutable marker and the immutable pending writes manager at the same
/// time, this method is used to solve this problem.
pub fn marker_with_pm(&mut self) -> Option<(AsyncMarker<'_, C>, &P)> {
self.conflict_manager.as_mut().map(|marker| {
(
AsyncMarker::new(marker),
self.pending_writes.as_ref().unwrap(),
)
})
}
/// Marks a key is read.
pub async fn mark_read(&mut self, k: &K) {
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read(k).await;
}
}
/// Marks a key is conflict.
pub async fn mark_conflict(&mut self, k: &K) {
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_conflict(k).await;
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCm<Key = K>,
P: AsyncPwm<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Rolls back the transaction.
#[inline]
pub async fn rollback(&mut self) -> Result<(), TransactionError<C::Error, P::Error>> {
if self.discarded {
return Err(TransactionError::Discard);
}
self
.pending_writes
.as_mut()
.unwrap()
.rollback()
.await
.map_err(TransactionError::Pwm)?;
self
.conflict_manager
.as_mut()
.unwrap()
.rollback()
.await
.map_err(TransactionError::Cm)?;
Ok(())
}
/// Insert a key-value pair to the transaction.
pub async fn insert(
&mut self,
key: K,
value: V,
) -> Result<(), TransactionError<C::Error, P::Error>> {
self.insert_with_in(key, value).await
}
/// Removes a key.
///
/// This is done by adding a delete marker for the key at commit timestamp. Any
/// reads happening before this timestamp would be unaffected. Any reads after
/// this commit would see the deletion.
pub async fn remove(&mut self, key: K) -> Result<(), TransactionError<C::Error, P::Error>> {
self
.modify(Entry {
data: EntryData::Remove(key),
version: 0,
})
.await
}
/// Returns `true` if the pending writes contains the key.
pub async fn contains_key(
&mut self,
key: &K,
) -> Result<Option<bool>, TransactionError<C::Error, P::Error>> {
if self.discarded {
return Err(TransactionError::Discard);
}
match self
.pending_writes
.as_ref()
.unwrap()
.get(key)
.await
.map_err(TransactionError::pending)?
{
Some(ent) => {
// If the value is None, it means that the key is removed.
if ent.value.is_none() {
return Ok(Some(false));
}
// Fulfill from buffer.
Ok(Some(true))
}
None => {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read(key).await;
}
Ok(None)
}
}
}
/// Looks for the key in the pending writes, if such key is not in the pending writes,
/// the end user can read the key from the database.
pub async fn get<'a, 'b: 'a>(
&'a mut self,
key: &'b K,
) -> Result<Option<EntryRef<'a, K, V>>, TransactionError<C::Error, P::Error>> {
if self.discarded {
return Err(TransactionError::Discard);
}
if let Some(e) = self
.pending_writes
.as_ref()
.unwrap()
.get(key)
.await
.map_err(TransactionError::Pwm)?
{
// If the value is None, it means that the key is removed.
if e.value.is_none() {
return Ok(None);
}
// Fulfill from buffer.
Ok(Some(EntryRef {
data: match &e.value {
Some(value) => EntryDataRef::Insert { key, value },
None => EntryDataRef::Remove(key),
},
version: e.version,
}))
} else {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read(key).await;
}
Ok(None)
}
}
/// Commits the transaction, following these steps:
///
/// 1. If there are no writes, return immediately.
///
/// 2. Check if read rows were updated since txn started. If so, return `TransactionError::Conflict`.
///
/// 3. If no conflict, generate a commit timestamp and update written rows' commit ts.
///
/// 4. Batch up all writes, write them to database.
///
/// 5. If callback is provided, Badger will return immediately after checking
/// for conflicts. Writes to the database will happen in the background. If
/// there is a conflict, an error will be returned and the callback will not
/// run. If there are no conflicts, the callback will be called in the
/// background upon successful completion of writes or any error during write.
pub async fn commit<F, Fut, O, E>(
&mut self,
apply: F,
) -> Result<O, WtmError<C::Error, P::Error, E>>
where
Fut: Future<Output = Result<O, E>>,
F: FnOnce(OneOrMore<Entry<K, V>>) -> Fut,
E: std::error::Error,
{
if self.pending_writes.as_ref().unwrap().is_empty().await {
// Nothing to commit
self.discard().await;
return apply(Default::default()).await.map_err(WtmError::commit);
}
match self.commit_entries().await {
Ok((commit_ts, entries)) => match apply(entries).await {
Ok(output) => {
self.orc.done_commit(commit_ts).await;
self.discard().await;
Ok(output)
}
Err(e) => {
self.orc.done_commit(commit_ts).await;
self.discard().await;
Err(WtmError::commit(e))
}
},
Err(e) => {
self.discard().await;
Err(WtmError::transaction(e))
}
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCmEquivalent<Key = K>,
P: AsyncPwm<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Marks a key is read.
pub async fn mark_read_equivalent<Q>(&mut self, k: &Q)
where
K: Borrow<Q>,
Q: ?Sized + Eq + core::hash::Hash + Sync,
{
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_equivalent(k).await;
}
}
/// Marks a key is conflict.
pub async fn mark_conflict_equivalent<Q>(&mut self, k: &Q)
where
K: Borrow<Q>,
Q: ?Sized + Eq + core::hash::Hash + Sync,
{
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_conflict_equivalent(k).await;
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCmEquivalent<Key = K>,
P: AsyncPwmEquivalent<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Returns `true` if the pending writes contains the key.
///
/// - `Ok(None)`: means the key is not in the pending writes, the end user can read the key from the database.
/// - `Ok(Some(true))`: means the key is in the pending writes.
/// - `Ok(Some(false))`: means the key is in the pending writes and but is a remove entry.
pub async fn contains_key_equivalent<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<bool>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Eq + core::hash::Hash + Sync,
{
if self.discarded {
return Err(TransactionError::Discard);
}
match self
.pending_writes
.as_ref()
.unwrap()
.get_equivalent(key)
.await
.map_err(TransactionError::pending)?
{
Some(ent) => {
// If the value is None, it means that the key is removed.
if ent.value.is_none() {
return Ok(Some(false));
}
// Fulfill from buffer.
Ok(Some(true))
}
None => {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_equivalent(key).await;
}
Ok(None)
}
}
}
/// Looks for the key in the pending writes, if such key is not in the pending writes,
/// the end user can read the key from the database.
pub async fn get_equivalent<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<EntryRef<'a, K, V>>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Eq + core::hash::Hash + Sync,
{
if self.discarded {
return Err(TransactionError::Discard);
}
if let Some((k, e)) = self
.pending_writes
.as_ref()
.unwrap()
.get_entry_equivalent(key)
.await
.map_err(TransactionError::Pwm)?
{
// If the value is None, it means that the key is removed.
if e.value.is_none() {
return Ok(None);
}
// Fulfill from buffer.
Ok(Some(EntryRef {
data: match &e.value {
Some(value) => EntryDataRef::Insert { key: k, value },
None => EntryDataRef::Remove(k),
},
version: e.version,
}))
} else {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_equivalent(key).await;
}
Ok(None)
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCmComparable<Key = K>,
P: AsyncPwmEquivalent<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Returns `true` if the pending writes contains the key.
///
/// - `Ok(None)`: means the key is not in the pending writes, the end user can read the key from the database.
/// - `Ok(Some(true))`: means the key is in the pending writes.
/// - `Ok(Some(false))`: means the key is in the pending writes and but is a remove entry.
pub async fn contains_key_comparable_cm_equivalent_pm<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<bool>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Eq + Ord + core::hash::Hash + Sync,
{
match self
.pending_writes
.as_ref()
.unwrap()
.get_equivalent(key)
.await
.map_err(TransactionError::pending)?
{
Some(ent) => {
// If the value is None, it means that the key is removed.
if ent.value.is_none() {
return Ok(Some(false));
}
// Fulfill from buffer.
Ok(Some(true))
}
None => {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_comparable(key).await;
}
Ok(None)
}
}
}
/// Looks for the key in the pending writes, if such key is not in the pending writes,
/// the end user can read the key from the database.
pub async fn get_comparable_cm_equivalent_pm<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<EntryRef<'a, K, V>>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Eq + Ord + core::hash::Hash + Sync,
{
if let Some((k, e)) = self
.pending_writes
.as_ref()
.unwrap()
.get_entry_equivalent(key)
.await
.map_err(TransactionError::Pwm)?
{
// If the value is None, it means that the key is removed.
if e.value.is_none() {
return Ok(None);
}
// Fulfill from buffer.
Ok(Some(EntryRef {
data: match &e.value {
Some(value) => EntryDataRef::Insert { key: k, value },
None => EntryDataRef::Remove(k),
},
version: e.version,
}))
} else {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_comparable(key).await;
}
Ok(None)
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCmComparable<Key = K>,
P: AsyncPwm<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Marks a key is read.
pub async fn mark_read_comparable<Q>(&mut self, k: &Q)
where
K: Borrow<Q>,
Q: ?Sized + Ord + Sync,
{
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_comparable(k).await;
}
}
/// Marks a key is conflict.
pub async fn mark_conflict_comparable<Q>(&mut self, k: &Q)
where
K: Borrow<Q>,
Q: ?Sized + Ord + Sync,
{
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_conflict_comparable(k).await;
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCmComparable<Key = K>,
P: AsyncPwmComparable<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Returns `true` if the pending writes contains the key.
///
/// - `Ok(None)`: means the key is not in the pending writes, the end user can read the key from the database.
/// - `Ok(Some(true))`: means the key is in the pending writes.
/// - `Ok(Some(false))`: means the key is in the pending writes and but is a remove entry.
pub async fn contains_key_comparable<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<bool>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Ord + Sync,
{
match self
.pending_writes
.as_ref()
.unwrap()
.get_comparable(key)
.await
.map_err(TransactionError::pending)?
{
Some(ent) => {
// If the value is None, it means that the key is removed.
if ent.value.is_none() {
return Ok(Some(false));
}
// Fulfill from buffer.
Ok(Some(true))
}
None => {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_comparable(key).await;
}
Ok(None)
}
}
}
/// Looks for the key in the pending writes, if such key is not in the pending writes,
/// the end user can read the key from the database.
pub async fn get_comparable<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<EntryRef<'a, K, V>>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Ord + Sync,
{
if let Some((k, e)) = self
.pending_writes
.as_ref()
.unwrap()
.get_entry_comparable(key)
.await
.map_err(TransactionError::Pwm)?
{
// If the value is None, it means that the key is removed.
if e.value.is_none() {
return Ok(None);
}
// Fulfill from buffer.
Ok(Some(EntryRef {
data: match &e.value {
Some(value) => EntryDataRef::Insert { key: k, value },
None => EntryDataRef::Remove(k),
},
version: e.version,
}))
} else {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_comparable(key).await;
}
Ok(None)
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCmEquivalent<Key = K>,
P: AsyncPwmComparable<Key = K, Value = V>,
S: AsyncSpawner,
{
/// Returns `true` if the pending writes contains the key.
///
/// - `Ok(None)`: means the key is not in the pending writes, the end user can read the key from the database.
/// - `Ok(Some(true))`: means the key is in the pending writes.
/// - `Ok(Some(false))`: means the key is in the pending writes and but is a remove entry.
pub async fn contains_key_equivalent_cm_comparable_pm<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<bool>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Eq + Ord + core::hash::Hash + Sync,
{
match self
.pending_writes
.as_ref()
.unwrap()
.get_comparable(key)
.await
.map_err(TransactionError::pending)?
{
Some(ent) => {
// If the value is None, it means that the key is removed.
if ent.value.is_none() {
return Ok(Some(false));
}
// Fulfill from buffer.
Ok(Some(true))
}
None => {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_equivalent(key).await;
}
Ok(None)
}
}
}
/// Looks for the key in the pending writes, if such key is not in the pending writes,
/// the end user can read the key from the database.
pub async fn get_equivalent_cm_comparable_pm<'a, 'b: 'a, Q>(
&'a mut self,
key: &'b Q,
) -> Result<Option<EntryRef<'a, K, V>>, TransactionError<C::Error, P::Error>>
where
K: Borrow<Q>,
Q: ?Sized + Eq + Ord + core::hash::Hash + Sync,
{
if let Some((k, e)) = self
.pending_writes
.as_ref()
.unwrap()
.get_entry_comparable(key)
.await
.map_err(TransactionError::Pwm)?
{
// If the value is None, it means that the key is removed.
if e.value.is_none() {
return Ok(None);
}
// Fulfill from buffer.
Ok(Some(EntryRef {
data: match &e.value {
Some(value) => EntryDataRef::Insert { key: k, value },
None => EntryDataRef::Remove(k),
},
version: e.version,
}))
} else {
// track reads. No need to track read if txn serviced it
// internally.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_read_equivalent(key).await;
}
Ok(None)
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCm<Key = K> + Send,
P: AsyncPwm<Key = K, Value = V> + Send,
S: AsyncSpawner,
{
/// Acts like [`commit`](AsyncWtm::commit), but takes a future and a spawner, which gets run via a
/// task to avoid blocking this function. Following these steps:
///
/// 1. If there are no writes, return immediately, a new task will be spawned, and future will be invoked.
///
/// 2. Check if read rows were updated since txn started. If so, return `TransactionError::Conflict`.
///
/// 3. If no conflict, generate a commit timestamp and update written rows' commit ts.
///
/// 4. Batch up all writes, write them to database.
///
/// 5. Return immediately after checking for conflicts.
/// If there is a conflict, an error will be returned immediately and the no task will be spawned
/// run. If there are no conflicts, a task will be spawned and the future will be called in the
/// background upon successful completion of writes or any error during write.
pub async fn commit_with_task<F, Fut, CFut, E, R>(
&mut self,
apply: F,
fut: impl FnOnce(Result<(), E>) -> CFut + Send + 'static,
) -> Result<<S as AsyncSpawner>::JoinHandle<R>, WtmError<C::Error, P::Error, E>>
where
K: Send + 'static,
V: Send + 'static,
Fut: Future<Output = Result<(), E>> + Send,
F: FnOnce(OneOrMore<Entry<K, V>>) -> Fut + Send + 'static,
CFut: Future<Output = R> + Send + 'static,
E: std::error::Error + Send,
C: 'static,
R: Send + 'static,
{
if self.pending_writes.as_ref().unwrap().is_empty().await {
// Nothing to commit
self.discard().await;
return Ok(S::spawn(async move { fut(Ok(())).await }));
}
match self.commit_entries().await {
Ok((commit_ts, entries)) => {
let orc = self.orc.clone();
let ts = self.read_ts;
Ok(S::spawn(async move {
match apply(entries).await {
Ok(_) => {
orc.done_commit(commit_ts).await;
orc.read_mark.done_unchecked(ts).await;
fut(Ok(())).await
}
Err(e) => {
orc.done_commit(commit_ts).await;
orc.read_mark.done_unchecked(ts).await;
fut(Err(e)).await
}
}
}))
}
Err(e) => {
self.discard().await;
Err(WtmError::transaction(e))
}
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S>
where
C: AsyncCm<Key = K>,
P: AsyncPwm<Key = K, Value = V>,
S: AsyncSpawner,
{
async fn insert_with_in(
&mut self,
key: K,
value: V,
) -> Result<(), TransactionError<C::Error, P::Error>> {
let ent = Entry {
data: EntryData::Insert { key, value },
version: self.read_ts,
};
self.modify(ent).await
}
async fn modify(&mut self, ent: Entry<K, V>) -> Result<(), TransactionError<C::Error, P::Error>> {
if self.discarded {
return Err(TransactionError::Discard);
}
let pending_writes = self.pending_writes.as_mut().unwrap();
pending_writes
.validate_entry(&ent)
.await
.map_err(TransactionError::Pwm)?;
let cnt = self.count + 1;
// Extra bytes for the version in key.
let size = self.size + pending_writes.estimate_size(&ent);
if cnt >= pending_writes.max_batch_entries() || size >= pending_writes.max_batch_size() {
return Err(TransactionError::LargeTxn);
}
self.count = cnt;
self.size = size;
// The conflict_manager is used for conflict detection. If conflict detection
// is disabled, we don't need to store key hashes in the conflict_manager.
if let Some(ref mut conflict_manager) = self.conflict_manager {
conflict_manager.mark_conflict(ent.key()).await;
}
// If a duplicate entry was inserted in managed mode, move it to the duplicate writes slice.
// Add the entry to duplicateWrites only if both the entries have different versions. For
// same versions, we will overwrite the existing entry.
let eversion = ent.version;
let (ek, ev) = ent.split();
if let Some((old_key, old_value)) = pending_writes
.remove_entry(&ek)
.await
.map_err(TransactionError::Pwm)?
{
if old_value.version != eversion {
self
.duplicate_writes
.push(Entry::unsplit(old_key, old_value));
}
}
pending_writes
.insert(ek, ev)
.await
.map_err(TransactionError::Pwm)?;
Ok(())
}
async fn commit_entries(
&mut self,
) -> Result<(u64, OneOrMore<Entry<K, V>>), TransactionError<C::Error, P::Error>> {
// Ensure that the order in which we get the commit timestamp is the same as
// the order in which we push these updates to the write channel. So, we
// acquire a writeChLock before getting a commit timestamp, and only release
// it after pushing the entries to it.
let _write_lock = self.orc.write_serialize_lock.lock().await;
let conflict_manager = if self.conflict_manager.is_none() {
None
} else {
mem::take(&mut self.conflict_manager)
};
match self
.orc
.new_commit_ts(&mut self.done_read, self.read_ts, conflict_manager)
.await
{
CreateCommitTimestampResult::Conflict(conflict_manager) => {
// If there is a conflict, we should not send the updates to the write channel.
// Instead, we should return the conflict error to the user.
self.conflict_manager = conflict_manager;
Err(TransactionError::Conflict)
}
CreateCommitTimestampResult::Timestamp(commit_ts) => {
let pending_writes = mem::take(&mut self.pending_writes).unwrap();
let duplicate_writes = mem::take(&mut self.duplicate_writes);
let mut entries =
OneOrMore::with_capacity(pending_writes.len().await + self.duplicate_writes.len());
let process_entry = |entries: &mut OneOrMore<Entry<K, V>>, mut ent: Entry<K, V>| {
ent.version = commit_ts;
entries.push(ent);
};
pending_writes
.into_iter()
.await
.for_each(|(k, v)| process_entry(&mut entries, Entry::unsplit(k, v)));
duplicate_writes
.into_iter()
.for_each(|ent| process_entry(&mut entries, ent));
// CommitTs should not be zero if we're inserting transaction markers.
assert_ne!(commit_ts, 0);
Ok((commit_ts, entries))
}
}
}
}
impl<K, V, C, P, S> AsyncWtm<K, V, C, P, S> {
async fn done_read(&mut self) {
if !self.done_read {
self.done_read = true;
self.orc().read_mark.done_unchecked(self.read_ts).await;
}
}
fn done_read_blocking(&mut self) {
if !self.done_read {
self.done_read = true;
self.orc().read_mark.done_unchecked_blocking(self.read_ts);
}
}
#[inline]
fn orc(&self) -> &Oracle<C, S> {
&self.orc
}
/// Discards a created transaction. This method is very important and must be called. `commit*`
/// methods calls this internally.
///
/// NOTE: If any operations are run on a discarded transaction, [`TransactionError::Discard`] is returned.
pub async fn discard(&mut self) {
if self.discarded {
return;
}
self.discarded = true;
self.done_read().await;
}
/// Discards a created transaction. This method is very important and must be called. `commit*`
/// methods calls this internally.
///
/// NOTE: If any operations are run on a discarded transaction, [`TransactionError::Discard`] is returned.
pub fn discard_blocking(&mut self) {
if self.discarded {
return;
}
self.discarded = true;
self.done_read_blocking();
}
/// Returns true if the transaction is discarded.
#[inline]
pub const fn is_discard(&self) -> bool {
self.discarded
}
}
impl<K, V, C, P, S> Drop for AsyncWtm<K, V, C, P, S> {
fn drop(&mut self) {
if !self.discarded {
self.discard_blocking();
}
}
}