Spaces:
Build error
Build error
File size: 41,417 Bytes
84d2a97 |
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 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 |
mod resharding;
use std::collections::{HashMap, HashSet};
use std::fs::File;
use std::ops::Deref as _;
use std::path::{Path, PathBuf};
use std::sync::Arc;
use std::time::Duration;
use common::cpu::CpuBudget;
use common::tar_ext::BuilderExt;
use futures::{Future, TryStreamExt as _};
use itertools::Itertools;
use segment::common::validate_snapshot_archive::open_snapshot_archive_with_validation;
use segment::types::{ShardKey, SnapshotFormat};
use tokio::runtime::Handle;
use tokio::sync::{broadcast, OwnedRwLockReadGuard, RwLock};
use tokio_util::codec::{BytesCodec, FramedRead};
use tokio_util::io::SyncIoBridge;
use super::replica_set::{AbortShardTransfer, ChangePeerFromState};
use super::resharding::tasks_pool::ReshardTasksPool;
use super::resharding::{ReshardStage, ReshardState};
use super::transfer::transfer_tasks_pool::TransferTasksPool;
use crate::collection::payload_index_schema::PayloadIndexSchema;
use crate::common::snapshot_stream::SnapshotStream;
use crate::config::{CollectionConfigInternal, ShardingMethod};
use crate::hash_ring::HashRingRouter;
use crate::operations::cluster_ops::ReshardingDirection;
use crate::operations::shard_selector_internal::ShardSelectorInternal;
use crate::operations::shared_storage_config::SharedStorageConfig;
use crate::operations::snapshot_ops::SnapshotDescription;
use crate::operations::types::{
CollectionError, CollectionResult, ReshardingInfo, ShardTransferInfo,
};
use crate::operations::{OperationToShard, SplitByShard};
use crate::optimizers_builder::OptimizersConfig;
use crate::save_on_disk::SaveOnDisk;
use crate::shards::channel_service::ChannelService;
use crate::shards::local_shard::LocalShard;
use crate::shards::replica_set::{ReplicaState, ShardReplicaSet};
use crate::shards::shard::{PeerId, ShardId};
use crate::shards::shard_config::{ShardConfig, ShardType};
use crate::shards::shard_versioning::latest_shard_paths;
use crate::shards::transfer::{ShardTransfer, ShardTransferKey};
use crate::shards::CollectionId;
const SHARD_TRANSFERS_FILE: &str = "shard_transfers";
const RESHARDING_STATE_FILE: &str = "resharding_state.json";
pub const SHARD_KEY_MAPPING_FILE: &str = "shard_key_mapping.json";
pub type ShardKeyMapping = HashMap<ShardKey, HashSet<ShardId>>;
pub struct ShardHolder {
shards: HashMap<ShardId, ShardReplicaSet>,
pub(crate) shard_transfers: SaveOnDisk<HashSet<ShardTransfer>>,
pub(crate) shard_transfer_changes: broadcast::Sender<ShardTransferChange>,
pub(crate) resharding_state: SaveOnDisk<Option<ReshardState>>,
pub(crate) rings: HashMap<Option<ShardKey>, HashRingRouter>,
key_mapping: SaveOnDisk<ShardKeyMapping>,
// Duplicates the information from `key_mapping` for faster access
// Do not require locking
shard_id_to_key_mapping: HashMap<ShardId, ShardKey>,
}
pub type LockedShardHolder = RwLock<ShardHolder>;
impl ShardHolder {
pub async fn trigger_optimizers(&self) {
for shard in self.shards.values() {
shard.trigger_optimizers().await;
}
}
pub fn new(collection_path: &Path) -> CollectionResult<Self> {
let shard_transfers =
SaveOnDisk::load_or_init_default(collection_path.join(SHARD_TRANSFERS_FILE))?;
let resharding_state: SaveOnDisk<Option<ReshardState>> =
SaveOnDisk::load_or_init_default(collection_path.join(RESHARDING_STATE_FILE))?;
let key_mapping: SaveOnDisk<ShardKeyMapping> =
SaveOnDisk::load_or_init_default(collection_path.join(SHARD_KEY_MAPPING_FILE))?;
let mut shard_id_to_key_mapping = HashMap::new();
for (shard_key, shard_ids) in key_mapping.read().iter() {
for shard_id in shard_ids {
shard_id_to_key_mapping.insert(*shard_id, shard_key.clone());
}
}
let rings = HashMap::from([(None, HashRingRouter::single())]);
let (shard_transfer_changes, _) = broadcast::channel(64);
Ok(Self {
shards: HashMap::new(),
shard_transfers,
shard_transfer_changes,
resharding_state,
rings,
key_mapping,
shard_id_to_key_mapping,
})
}
pub async fn save_key_mapping_to_tar(
&self,
tar: &common::tar_ext::BuilderExt,
) -> CollectionResult<()> {
self.key_mapping
.save_to_tar(tar, Path::new(SHARD_KEY_MAPPING_FILE))
.await?;
Ok(())
}
pub fn get_shard_id_to_key_mapping(&self) -> &HashMap<ShardId, ShardKey> {
&self.shard_id_to_key_mapping
}
pub fn get_shard_key_to_ids_mapping(&self) -> ShardKeyMapping {
self.key_mapping.read().clone()
}
pub async fn drop_and_remove_shard(
&mut self,
shard_id: ShardId,
) -> Result<(), CollectionError> {
if let Some(replica_set) = self.shards.remove(&shard_id) {
let shard_path = replica_set.shard_path.clone();
drop(replica_set);
// Explicitly drop shard config file first
// If removing all shard files at once, it may be possible for the shard configuration
// file to be left behind if the process is killed in the middle. We must avoid this so
// we don't attempt to load this shard anymore on restart.
let shard_config_path = ShardConfig::get_config_path(&shard_path);
if let Err(err) = tokio::fs::remove_file(shard_config_path).await {
log::error!("Failed to remove shard config file before removing the rest of the files: {err}");
}
tokio::fs::remove_dir_all(shard_path).await?;
}
Ok(())
}
pub fn remove_shard_from_key_mapping(
&mut self,
shard_id: ShardId,
shard_key: &ShardKey,
) -> Result<(), CollectionError> {
self.key_mapping.write_optional(|key_mapping| {
if !key_mapping.contains_key(shard_key) {
return None;
}
let mut key_mapping = key_mapping.clone();
key_mapping.get_mut(shard_key).unwrap().remove(&shard_id);
Some(key_mapping)
})?;
self.shard_id_to_key_mapping.remove(&shard_id);
Ok(())
}
pub fn add_shard(
&mut self,
shard_id: ShardId,
shard: ShardReplicaSet,
shard_key: Option<ShardKey>,
) -> Result<(), CollectionError> {
self.shards.insert(shard_id, shard);
self.rings
.entry(shard_key.clone())
.or_insert_with(HashRingRouter::single)
.add(shard_id);
if let Some(shard_key) = shard_key {
self.key_mapping.write_optional(|key_mapping| {
let has_id = key_mapping
.get(&shard_key)
.map(|shard_ids| shard_ids.contains(&shard_id))
.unwrap_or(false);
if has_id {
return None;
}
let mut copy_of_mapping = key_mapping.clone();
let shard_ids = copy_of_mapping.entry(shard_key.clone()).or_default();
shard_ids.insert(shard_id);
Some(copy_of_mapping)
})?;
self.shard_id_to_key_mapping.insert(shard_id, shard_key);
}
Ok(())
}
pub async fn remove_shard_key(&mut self, shard_key: &ShardKey) -> Result<(), CollectionError> {
let mut remove_shard_ids = Vec::new();
self.key_mapping.write_optional(|key_mapping| {
if key_mapping.contains_key(shard_key) {
let mut new_key_mapping = key_mapping.clone();
if let Some(shard_ids) = new_key_mapping.remove(shard_key) {
for shard_id in shard_ids {
remove_shard_ids.push(shard_id);
}
}
Some(new_key_mapping)
} else {
None
}
})?;
self.rings.remove(&shard_key.clone().into());
for shard_id in remove_shard_ids {
self.drop_and_remove_shard(shard_id).await?;
self.shard_id_to_key_mapping.remove(&shard_id);
}
Ok(())
}
fn rebuild_rings(&mut self) {
let mut rings = HashMap::from([(None, HashRingRouter::single())]);
let ids_to_key = self.get_shard_id_to_key_mapping();
for shard_id in self.shards.keys() {
let shard_key = ids_to_key.get(shard_id).cloned();
rings
.entry(shard_key)
.or_insert_with(HashRingRouter::single)
.add(*shard_id);
}
// Restore resharding hash ring if resharding is active and haven't reached
// `WriteHashRingCommitted` stage yet
if let Some(state) = self.resharding_state.read().deref() {
let ring = rings
.get_mut(&state.shard_key)
.expect("must have hash ring for current resharding shard key");
ring.start_resharding(state.shard_id, state.direction);
if state.stage >= ReshardStage::WriteHashRingCommitted {
ring.commit_resharding();
}
}
self.rings = rings;
}
pub async fn apply_shards_state(
&mut self,
shard_ids: HashSet<ShardId>,
shard_key_mapping: ShardKeyMapping,
extra_shards: HashMap<ShardId, ShardReplicaSet>,
) -> Result<(), CollectionError> {
self.shards.extend(extra_shards.into_iter());
let all_shard_ids = self.shards.keys().cloned().collect::<HashSet<_>>();
self.key_mapping
.write_optional(|_key_mapping| Some(shard_key_mapping))?;
for shard_id in all_shard_ids {
if !shard_ids.contains(&shard_id) {
self.drop_and_remove_shard(shard_id).await?;
}
}
self.rebuild_rings();
Ok(())
}
pub fn contains_shard(&self, shard_id: ShardId) -> bool {
self.shards.contains_key(&shard_id)
}
pub fn get_shard(&self, shard_id: ShardId) -> Option<&ShardReplicaSet> {
self.shards.get(&shard_id)
}
pub fn get_shards(&self) -> impl Iterator<Item = (ShardId, &ShardReplicaSet)> {
self.shards.iter().map(|(id, shard)| (*id, shard))
}
pub fn all_shards(&self) -> impl Iterator<Item = &ShardReplicaSet> {
self.shards.values()
}
pub fn split_by_shard<O: SplitByShard + Clone>(
&self,
operation: O,
shard_keys_selection: &Option<ShardKey>,
) -> CollectionResult<Vec<(&ShardReplicaSet, O)>> {
let Some(hashring) = self.rings.get(&shard_keys_selection.clone()) else {
return if let Some(shard_key) = shard_keys_selection {
Err(CollectionError::bad_input(format!(
"Shard key {shard_key} not found"
)))
} else {
Err(CollectionError::bad_input(
"Shard key not specified".to_string(),
))
};
};
if hashring.is_empty() {
return Err(CollectionError::bad_input(
"No shards found for shard key".to_string(),
));
}
let operation_to_shard = operation.split_by_shard(hashring);
let shard_ops: Vec<_> = match operation_to_shard {
OperationToShard::ByShard(by_shard) => by_shard
.into_iter()
.map(|(shard_id, operation)| (self.shards.get(&shard_id).unwrap(), operation))
.collect(),
OperationToShard::ToAll(operation) => {
if let Some(shard_key) = shard_keys_selection {
let shard_ids = self
.key_mapping
.read()
.get(shard_key)
.cloned()
.unwrap_or_default();
shard_ids
.into_iter()
.map(|shard_id| (self.shards.get(&shard_id).unwrap(), operation.clone()))
.collect()
} else {
self.all_shards()
.map(|shard| (shard, operation.clone()))
.collect()
}
}
};
Ok(shard_ops)
}
pub fn register_start_shard_transfer(&self, transfer: ShardTransfer) -> CollectionResult<bool> {
let changed = self
.shard_transfers
.write(|transfers| transfers.insert(transfer.clone()))?;
let _ = self
.shard_transfer_changes
.send(ShardTransferChange::Start(transfer));
Ok(changed)
}
pub fn register_finish_transfer(&self, key: &ShardTransferKey) -> CollectionResult<bool> {
let any_removed = self.shard_transfers.write(|transfers| {
let before_remove = transfers.len();
transfers.retain(|transfer| !key.check(transfer));
before_remove != transfers.len()
})?;
let _ = self
.shard_transfer_changes
.send(ShardTransferChange::Finish(*key));
Ok(any_removed)
}
pub fn register_abort_transfer(&self, key: &ShardTransferKey) -> CollectionResult<bool> {
let any_removed = self.shard_transfers.write(|transfers| {
let before_remove = transfers.len();
transfers.retain(|transfer| !key.check(transfer));
before_remove != transfers.len()
})?;
let _ = self
.shard_transfer_changes
.send(ShardTransferChange::Abort(*key));
Ok(any_removed)
}
/// Await for a given shard transfer to complete.
///
/// The returned inner result defines whether it successfully finished or whether it was
/// aborted/cancelled.
pub fn await_shard_transfer_end(
&self,
transfer: ShardTransferKey,
timeout: Duration,
) -> impl Future<Output = CollectionResult<Result<(), ()>>> {
let mut subscriber = self.shard_transfer_changes.subscribe();
let receiver = async move {
loop {
match subscriber.recv().await {
Err(tokio::sync::broadcast::error::RecvError::Closed) => return Err(CollectionError::service_error(
"Failed to await shard transfer end: failed to listen for shard transfer changes, channel closed"
)),
Err(err @ tokio::sync::broadcast::error::RecvError::Lagged(_)) => return Err(CollectionError::service_error(format!(
"Failed to await shard transfer end: failed to listen for shard transfer changes, channel lagged behind: {err}"
))),
Ok(ShardTransferChange::Finish(key)) if key == transfer => return Ok(Ok(())),
Ok(ShardTransferChange::Abort(key)) if key == transfer => return Ok(Err(())),
Ok(_) => {},
}
}
};
async move {
match tokio::time::timeout(timeout, receiver).await {
Ok(operation) => Ok(operation?),
// Timeout
Err(err) => Err(CollectionError::service_error(format!(
"Awaiting for shard transfer end timed out: {err}"
))),
}
}
}
/// The count of incoming and outgoing shard transfers on the given peer
///
/// This only includes shard transfers that are in consensus for the current collection. A
/// shard transfer that has just been proposed may not be included yet.
pub fn count_shard_transfer_io(&self, peer_id: PeerId) -> (usize, usize) {
let (mut incoming, mut outgoing) = (0, 0);
for transfer in self.shard_transfers.read().iter() {
incoming += usize::from(transfer.to == peer_id);
outgoing += usize::from(transfer.from == peer_id);
}
(incoming, outgoing)
}
pub fn get_shard_transfer_info(
&self,
tasks_pool: &TransferTasksPool,
) -> Vec<ShardTransferInfo> {
let mut shard_transfers = vec![];
for shard_transfer in self.shard_transfers.read().iter() {
let shard_id = shard_transfer.shard_id;
let to_shard_id = shard_transfer.to_shard_id;
let to = shard_transfer.to;
let from = shard_transfer.from;
let sync = shard_transfer.sync;
let method = shard_transfer.method;
let status = tasks_pool.get_task_status(&shard_transfer.key());
shard_transfers.push(ShardTransferInfo {
shard_id,
to_shard_id,
from,
to,
sync,
method,
comment: status.map(|p| p.comment),
})
}
shard_transfers.sort_by_key(|k| k.shard_id);
shard_transfers
}
pub fn get_resharding_operations_info(
&self,
tasks_pool: &ReshardTasksPool,
) -> Option<Vec<ReshardingInfo>> {
let mut resharding_operations = vec![];
// We eventually expect to extend this to multiple concurrent operations, which is why
// we're using a list here
let Some(resharding_state) = &*self.resharding_state.read() else {
return None;
};
let status = tasks_pool.get_task_status(&resharding_state.key());
resharding_operations.push(ReshardingInfo {
shard_id: resharding_state.shard_id,
peer_id: resharding_state.peer_id,
direction: resharding_state.direction,
shard_key: resharding_state.shard_key.clone(),
comment: status.map(|p| p.comment),
});
resharding_operations.sort_by_key(|k| k.shard_id);
Some(resharding_operations)
}
pub fn get_related_transfers(&self, shard_id: ShardId, peer_id: PeerId) -> Vec<ShardTransfer> {
self.get_transfers(|transfer| {
transfer.shard_id == shard_id && (transfer.from == peer_id || transfer.to == peer_id)
})
}
fn get_shard_ids_by_key(&self, shard_key: &ShardKey) -> CollectionResult<HashSet<ShardId>> {
match self.key_mapping.read().get(shard_key).cloned() {
None => Err(CollectionError::bad_request(format!(
"Shard key {shard_key} not found"
))),
Some(ids) => Ok(ids),
}
}
pub fn select_shards<'a>(
&'a self,
shard_selector: &'a ShardSelectorInternal,
) -> CollectionResult<Vec<(&ShardReplicaSet, Option<&ShardKey>)>> {
let mut res = Vec::new();
match shard_selector {
ShardSelectorInternal::Empty => {
debug_assert!(false, "Do not expect empty shard selector")
}
ShardSelectorInternal::All => {
for (&shard_id, shard) in self.shards.iter() {
// Ignore a new resharding shard until it completed point migration
// The shard will be marked as active at the end of the migration stage
let resharding_migrating_up =
self.resharding_state.read().clone().map_or(false, |state| {
state.direction == ReshardingDirection::Up
&& state.shard_id == shard_id
&& state.stage < ReshardStage::ReadHashRingCommitted
});
if resharding_migrating_up {
continue;
}
let shard_key = self.shard_id_to_key_mapping.get(&shard_id);
res.push((shard, shard_key));
}
}
ShardSelectorInternal::ShardKey(shard_key) => {
for shard_id in self.get_shard_ids_by_key(shard_key)? {
if let Some(replica_set) = self.shards.get(&shard_id) {
res.push((replica_set, Some(shard_key)));
} else {
debug_assert!(false, "Shard id {shard_id} not found")
}
}
}
ShardSelectorInternal::ShardKeys(shard_keys) => {
for shard_key in shard_keys {
for shard_id in self.get_shard_ids_by_key(shard_key)? {
if let Some(replica_set) = self.shards.get(&shard_id) {
res.push((replica_set, Some(shard_key)));
} else {
debug_assert!(false, "Shard id {shard_id} not found")
}
}
}
}
ShardSelectorInternal::ShardId(shard_id) => {
if let Some(replica_set) = self.shards.get(shard_id) {
res.push((replica_set, self.shard_id_to_key_mapping.get(shard_id)));
} else {
return Err(shard_not_found_error(*shard_id));
}
}
}
Ok(res)
}
pub fn len(&self) -> usize {
self.shards.len()
}
pub fn is_empty(&self) -> bool {
self.shards.is_empty()
}
#[allow(clippy::too_many_arguments)]
pub async fn load_shards(
&mut self,
collection_path: &Path,
collection_id: &CollectionId,
collection_config: Arc<RwLock<CollectionConfigInternal>>,
effective_optimizers_config: OptimizersConfig,
shared_storage_config: Arc<SharedStorageConfig>,
payload_index_schema: Arc<SaveOnDisk<PayloadIndexSchema>>,
channel_service: ChannelService,
on_peer_failure: ChangePeerFromState,
abort_shard_transfer: AbortShardTransfer,
this_peer_id: PeerId,
update_runtime: Handle,
search_runtime: Handle,
optimizer_cpu_budget: CpuBudget,
) {
let shard_number = collection_config.read().await.params.shard_number.get();
let (shard_ids_list, shard_id_to_key_mapping) = match collection_config
.read()
.await
.params
.sharding_method
.unwrap_or_default()
{
ShardingMethod::Auto => {
let ids_list = (0..shard_number).collect::<Vec<_>>();
let shard_id_to_key_mapping = HashMap::new();
(ids_list, shard_id_to_key_mapping)
}
ShardingMethod::Custom => {
let shard_id_to_key_mapping = self.get_shard_id_to_key_mapping();
let ids_list = shard_id_to_key_mapping
.keys()
.cloned()
.sorted()
.collect::<Vec<_>>();
(ids_list, shard_id_to_key_mapping.clone())
}
};
// ToDo: remove after version 0.11.0
for shard_id in shard_ids_list {
for (path, _shard_version, shard_type) in
latest_shard_paths(collection_path, shard_id).await.unwrap()
{
let replica_set = ShardReplicaSet::load(
shard_id,
collection_id.clone(),
&path,
collection_config.clone(),
effective_optimizers_config.clone(),
shared_storage_config.clone(),
payload_index_schema.clone(),
channel_service.clone(),
on_peer_failure.clone(),
abort_shard_transfer.clone(),
this_peer_id,
update_runtime.clone(),
search_runtime.clone(),
optimizer_cpu_budget.clone(),
)
.await;
let mut require_migration = true;
match shard_type {
ShardType::Local => {
// deprecated
let local_shard = LocalShard::load(
shard_id,
collection_id.clone(),
&path,
collection_config.clone(),
effective_optimizers_config.clone(),
shared_storage_config.clone(),
payload_index_schema.clone(),
update_runtime.clone(),
search_runtime.clone(),
optimizer_cpu_budget.clone(),
)
.await
.unwrap();
replica_set
.set_local(local_shard, Some(ReplicaState::Active))
.await
.unwrap();
}
ShardType::Remote { peer_id } => {
// deprecated
replica_set
.add_remote(peer_id, ReplicaState::Active)
.await
.unwrap();
}
ShardType::Temporary => {
// deprecated
let temp_shard = LocalShard::load(
shard_id,
collection_id.clone(),
&path,
collection_config.clone(),
effective_optimizers_config.clone(),
shared_storage_config.clone(),
payload_index_schema.clone(),
update_runtime.clone(),
search_runtime.clone(),
optimizer_cpu_budget.clone(),
)
.await
.unwrap();
replica_set
.set_local(temp_shard, Some(ReplicaState::Partial))
.await
.unwrap();
}
ShardType::ReplicaSet => {
require_migration = false;
// nothing to do, replicate set should be loaded already
}
}
// Migrate shard config to replica set
// Override existing shard configuration
if require_migration {
ShardConfig::new_replica_set()
.save(&path)
.map_err(|e| panic!("Failed to save shard config {path:?}: {e}"))
.unwrap();
}
// Change local shards stuck in Initializing state to Active
let local_peer_id = replica_set.this_peer_id();
let not_distributed = !shared_storage_config.is_distributed;
let is_local =
replica_set.this_peer_id() == local_peer_id && replica_set.is_local().await;
let is_initializing =
replica_set.peer_state(local_peer_id) == Some(ReplicaState::Initializing);
if not_distributed && is_local && is_initializing {
log::warn!("Local shard {collection_id}:{} stuck in Initializing state, changing to Active", replica_set.shard_id);
replica_set
.set_replica_state(local_peer_id, ReplicaState::Active)
.expect("Failed to set local shard state");
}
let shard_key = shard_id_to_key_mapping.get(&shard_id).cloned();
self.add_shard(shard_id, replica_set, shard_key).unwrap();
}
}
// If resharding, rebuild the hash rings because they'll be messed up
if self.resharding_state.read().is_some() {
self.rebuild_rings();
}
}
pub fn assert_shard_exists(&self, shard_id: ShardId) -> CollectionResult<()> {
match self.get_shard(shard_id) {
Some(_) => Ok(()),
None => Err(shard_not_found_error(shard_id)),
}
}
async fn assert_shard_is_local(&self, shard_id: ShardId) -> CollectionResult<()> {
let is_local_shard = self
.is_shard_local(shard_id)
.await
.ok_or_else(|| shard_not_found_error(shard_id))?;
if is_local_shard {
Ok(())
} else {
Err(CollectionError::bad_input(format!(
"Shard {shard_id} is not a local shard"
)))
}
}
async fn assert_shard_is_local_or_queue_proxy(
&self,
shard_id: ShardId,
) -> CollectionResult<()> {
let is_local_shard = self
.is_shard_local_or_queue_proxy(shard_id)
.await
.ok_or_else(|| shard_not_found_error(shard_id))?;
if is_local_shard {
Ok(())
} else {
Err(CollectionError::bad_input(format!(
"Shard {shard_id} is not a local or queue proxy shard"
)))
}
}
/// Returns true if shard is explicitly local, false otherwise.
pub async fn is_shard_local(&self, shard_id: ShardId) -> Option<bool> {
match self.get_shard(shard_id) {
Some(shard) => Some(shard.is_local().await),
None => None,
}
}
/// Returns true if shard is explicitly local or is queue proxy shard, false otherwise.
pub async fn is_shard_local_or_queue_proxy(&self, shard_id: ShardId) -> Option<bool> {
match self.get_shard(shard_id) {
Some(shard) => Some(shard.is_local().await || shard.is_queue_proxy().await),
None => None,
}
}
/// Return a list of local shards, present on this peer
pub async fn get_local_shards(&self) -> Vec<ShardId> {
let mut res = Vec::with_capacity(1);
for (shard_id, replica_set) in self.get_shards() {
if replica_set.has_local_shard().await {
res.push(shard_id);
}
}
res
}
/// Count how many shard replicas are on the given peer.
pub fn count_peer_shards(&self, peer_id: PeerId) -> usize {
self.get_shards()
.filter(|(_, replica_set)| replica_set.peer_state(peer_id).is_some())
.count()
}
pub fn check_transfer_exists(&self, transfer_key: &ShardTransferKey) -> bool {
self.shard_transfers
.read()
.iter()
.any(|transfer| transfer_key.check(transfer))
}
pub fn get_transfer(&self, transfer_key: &ShardTransferKey) -> Option<ShardTransfer> {
self.shard_transfers
.read()
.iter()
.find(|transfer| transfer_key.check(transfer))
.cloned()
}
pub fn get_transfers<F>(&self, mut predicate: F) -> Vec<ShardTransfer>
where
F: FnMut(&ShardTransfer) -> bool,
{
self.shard_transfers
.read()
.iter()
.filter(|&transfer| predicate(transfer))
.cloned()
.collect()
}
pub fn get_outgoing_transfers(&self, current_peer_id: PeerId) -> Vec<ShardTransfer> {
self.get_transfers(|transfer| transfer.from == current_peer_id)
}
/// # Cancel safety
///
/// This method is cancel safe.
pub async fn list_shard_snapshots(
&self,
snapshots_path: &Path,
shard_id: ShardId,
) -> CollectionResult<Vec<SnapshotDescription>> {
self.assert_shard_is_local(shard_id).await?;
let snapshots_path = Self::snapshots_path_for_shard_unchecked(snapshots_path, shard_id);
let shard = self
.get_shard(shard_id)
.ok_or_else(|| shard_not_found_error(shard_id))?;
let snapshot_manager = shard.get_snapshots_storage_manager()?;
snapshot_manager.list_snapshots(&snapshots_path).await
}
/// # Cancel safety
///
/// This method is cancel safe.
pub async fn create_shard_snapshot(
&self,
snapshots_path: &Path,
collection_name: &str,
shard_id: ShardId,
temp_dir: &Path,
) -> CollectionResult<SnapshotDescription> {
// - `snapshot_temp_dir` and `temp_file` are handled by `tempfile`
// and would be deleted, if future is cancelled
let shard = self
.get_shard(shard_id)
.ok_or_else(|| shard_not_found_error(shard_id))?;
if !shard.is_local().await && !shard.is_queue_proxy().await {
return Err(CollectionError::bad_input(format!(
"Shard {shard_id} is not a local or queue proxy shard"
)));
}
let snapshot_file_name = format!(
"{collection_name}-shard-{shard_id}-{}.snapshot",
chrono::Utc::now().format("%Y-%m-%d-%H-%M-%S"),
);
let snapshot_temp_dir = tempfile::Builder::new()
.prefix(&format!("{snapshot_file_name}-temp-"))
.tempdir_in(temp_dir)?;
let temp_file = tempfile::Builder::new()
.prefix(&format!("{snapshot_file_name}-"))
.suffix(".tar")
.tempfile_in(temp_dir)?;
let tar = BuilderExt::new_seekable_owned(File::create(temp_file.path())?);
shard
.create_snapshot(
snapshot_temp_dir.path(),
&tar,
SnapshotFormat::Regular,
false,
)
.await?;
let snapshot_temp_dir_path = snapshot_temp_dir.path().to_path_buf();
if let Err(err) = snapshot_temp_dir.close() {
log::error!(
"Failed to remove temporary directory {}: {err}",
snapshot_temp_dir_path.display(),
);
}
tar.finish().await?;
let snapshot_path =
Self::shard_snapshot_path_unchecked(snapshots_path, shard_id, snapshot_file_name)?;
let snapshot_manager = shard.get_snapshots_storage_manager()?;
let snapshot_description = snapshot_manager
.store_file(temp_file.path(), &snapshot_path)
.await;
if snapshot_description.is_ok() {
let _ = temp_file.keep();
}
snapshot_description
}
/// # Cancel safety
///
/// This method is cancel safe.
pub async fn stream_shard_snapshot(
shard: OwnedRwLockReadGuard<ShardHolder, ShardReplicaSet>,
collection_name: &str,
shard_id: ShardId,
temp_dir: &Path,
) -> CollectionResult<SnapshotStream> {
// - `snapshot_temp_dir` and `temp_file` are handled by `tempfile`
// and would be deleted, if future is cancelled
if !shard.is_local().await && !shard.is_queue_proxy().await {
return Err(CollectionError::bad_input(format!(
"Shard {shard_id} is not a local or queue proxy shard"
)));
}
let snapshot_file_name = format!(
"{collection_name}-shard-{shard_id}-{}.snapshot",
chrono::Utc::now().format("%Y-%m-%d-%H-%M-%S"),
);
let snapshot_temp_dir = tempfile::Builder::new()
.prefix(&format!("{snapshot_file_name}-temp-"))
.tempdir_in(temp_dir)?;
let (read_half, write_half) = tokio::io::duplex(4096);
tokio::spawn(async move {
let tar = BuilderExt::new_streaming_owned(SyncIoBridge::new(write_half));
shard
.create_snapshot(
snapshot_temp_dir.path(),
&tar,
SnapshotFormat::Streamable,
false,
)
.await?;
let snapshot_temp_dir_path = snapshot_temp_dir.path().to_path_buf();
if let Err(err) = snapshot_temp_dir.close() {
log::error!(
"Failed to remove temporary directory {}: {err}",
snapshot_temp_dir_path.display(),
);
}
tar.finish().await?;
CollectionResult::Ok(())
});
Ok(SnapshotStream::new_stream(
FramedRead::new(read_half, BytesCodec::new()).map_ok(|bytes| bytes.freeze()),
Some(snapshot_file_name),
))
}
/// # Cancel safety
///
/// This method is *not* cancel safe.
#[allow(clippy::too_many_arguments)]
pub async fn restore_shard_snapshot(
&self,
snapshot_path: &Path,
collection_name: &str,
shard_id: ShardId,
this_peer_id: PeerId,
is_distributed: bool,
temp_dir: &Path,
cancel: cancel::CancellationToken,
) -> CollectionResult<()> {
if !self.contains_shard(shard_id) {
return Err(shard_not_found_error(shard_id));
}
if !temp_dir.exists() {
std::fs::create_dir_all(temp_dir)?;
}
let snapshot_file_name = snapshot_path.file_name().unwrap().to_string_lossy();
let snapshot_path = snapshot_path.to_path_buf();
let snapshot_temp_dir = tempfile::Builder::new()
.prefix(&format!(
"{collection_name}-shard-{shard_id}-{snapshot_file_name}"
))
.tempdir_in(temp_dir)?;
let task = {
let snapshot_temp_dir = snapshot_temp_dir.path().to_path_buf();
cancel::blocking::spawn_cancel_on_token(
cancel.child_token(),
move |cancel| -> CollectionResult<_> {
let mut tar = open_snapshot_archive_with_validation(&snapshot_path)?;
if cancel.is_cancelled() {
return Err(cancel::Error::Cancelled.into());
}
tar.unpack(&snapshot_temp_dir)?;
drop(tar);
if cancel.is_cancelled() {
return Err(cancel::Error::Cancelled.into());
}
ShardReplicaSet::restore_snapshot(
&snapshot_temp_dir,
this_peer_id,
is_distributed,
)?;
Ok(())
},
)
};
task.await??;
// `ShardHolder::recover_local_shard_from` is *not* cancel safe
// (see `ShardReplicaSet::restore_local_replica_from`)
let recovered = self
.recover_local_shard_from(snapshot_temp_dir.path(), shard_id, cancel)
.await?;
if !recovered {
return Err(CollectionError::bad_request(format!(
"Invalid snapshot {snapshot_file_name}"
)));
}
Ok(())
}
/// # Cancel safety
///
/// This method is *not* cancel safe.
pub async fn recover_local_shard_from(
&self,
snapshot_shard_path: &Path,
shard_id: ShardId,
cancel: cancel::CancellationToken,
) -> CollectionResult<bool> {
// TODO:
// Check that shard snapshot is compatible with the collection
// (see `VectorsConfig::check_compatible_with_segment_config`)
let replica_set = self
.get_shard(shard_id)
.ok_or_else(|| shard_not_found_error(shard_id))?;
// `ShardReplicaSet::restore_local_replica_from` is *not* cancel safe
replica_set
.restore_local_replica_from(snapshot_shard_path, cancel)
.await
}
/// # Cancel safety
///
/// This method is cancel safe.
pub async fn get_shard_snapshot_path(
&self,
snapshots_path: &Path,
shard_id: ShardId,
snapshot_file_name: impl AsRef<Path>,
) -> CollectionResult<PathBuf> {
self.assert_shard_is_local_or_queue_proxy(shard_id).await?;
Self::shard_snapshot_path_unchecked(snapshots_path, shard_id, snapshot_file_name)
}
fn snapshots_path_for_shard_unchecked(snapshots_path: &Path, shard_id: ShardId) -> PathBuf {
snapshots_path.join(format!("shards/{shard_id}"))
}
fn shard_snapshot_path_unchecked(
snapshots_path: &Path,
shard_id: ShardId,
snapshot_file_name: impl AsRef<Path>,
) -> CollectionResult<PathBuf> {
let snapshots_path = Self::snapshots_path_for_shard_unchecked(snapshots_path, shard_id);
let snapshot_file_name = snapshot_file_name.as_ref();
if snapshot_file_name.file_name() != Some(snapshot_file_name.as_os_str()) {
return Err(CollectionError::not_found(format!(
"Snapshot {}",
snapshot_file_name.display(),
)));
}
let snapshot_path = snapshots_path.join(snapshot_file_name);
Ok(snapshot_path)
}
pub async fn remove_shards_at_peer(&self, peer_id: PeerId) -> CollectionResult<()> {
for (_shard_id, replica_set) in self.get_shards() {
replica_set.remove_peer(peer_id).await?;
}
Ok(())
}
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) enum ShardTransferChange {
Start(ShardTransfer),
Finish(ShardTransferKey),
Abort(ShardTransferKey),
}
pub(crate) fn shard_not_found_error(shard_id: ShardId) -> CollectionError {
CollectionError::NotFound {
what: format!("shard {shard_id}"),
}
}
|