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
// Copyright 2021 The ChromiumOS Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//! MemoryMapper trait and basic impl for virtio-iommu implementation
//!
//! All the addr/range ends in this file are exclusive.
use std::any::Any;
use std::collections::BTreeMap;
use std::sync::atomic::AtomicU32;
use std::sync::atomic::Ordering;
use anyhow::anyhow;
use anyhow::bail;
use anyhow::Context;
use anyhow::Result;
use base::warn;
use base::AsRawDescriptors;
use base::Event;
use base::Protection;
use base::RawDescriptor;
use cros_async::EventAsync;
use cros_async::Executor;
use resources::AddressRange;
use serde::Deserialize;
use serde::Serialize;
use vm_memory::GuestAddress;
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct MemRegion {
pub gpa: GuestAddress,
pub len: u64,
pub prot: Protection,
}
/// Manages the mapping from a guest IO virtual address space to the guest physical address space
#[derive(Debug)]
pub struct MappingInfo {
pub iova: u64,
pub gpa: GuestAddress,
pub size: u64,
pub prot: Protection,
}
impl MappingInfo {
#[allow(dead_code)]
fn new(iova: u64, gpa: GuestAddress, size: u64, prot: Protection) -> Result<Self> {
if size == 0 {
bail!("can't create 0 sized region");
}
iova.checked_add(size).context("iova overflow")?;
gpa.checked_add(size).context("gpa overflow")?;
Ok(Self {
iova,
gpa,
size,
prot,
})
}
}
struct ExportState {
// List of exported regions. Exported regions can overlap.
exported: Vec<AddressRange>,
// Event used to signal the client device when there is a fault.
fault_event: Event,
// Event used to signal virtio-iommu when the fault is resolved.
fault_resolved_event_internal: Event,
// Clone of the above event returned to virtio-iommu when a fault occurs.
fault_resolved_event_external: Option<EventAsync>,
}
impl ExportState {
fn new(ex: &Executor) -> Result<(Self, Event)> {
let fault_event = Event::new().context("failed to create fault_event")?;
let fault_resolved_event = Event::new().context("failed to create resolve event")?;
Ok((
Self {
exported: Vec::new(),
fault_event: fault_event
.try_clone()
.context("failed to clone fault event")?,
fault_resolved_event_internal: fault_resolved_event
.try_clone()
.context("failed to clone resolve event")?,
fault_resolved_event_external: Some(
EventAsync::new(fault_resolved_event, ex)
.context("failed to create async resolve event")?,
),
},
fault_event,
))
}
fn on_fault(&mut self) -> Option<EventAsync> {
let ret = self.fault_resolved_event_external.take();
if ret.is_some() {
self.fault_event.signal().expect("failed to signal fault");
}
ret
}
fn can_export(&self) -> bool {
self.fault_resolved_event_external.is_some()
}
}
// A basic iommu. It is designed as a building block for virtio-iommu.
pub struct BasicMemoryMapper {
maps: BTreeMap<u64, MappingInfo>, // key = MappingInfo.iova
mask: u64,
id: u32,
export_state: Option<ExportState>,
}
pub enum RemoveMapResult {
// The removal was successful. If the event is Some, it must be waited on before
// informing the guest that the unmapping completed.
Success(Option<EventAsync>),
// The removal failed because the range partially overlapped a mapping.
OverlapFailure,
}
#[derive(PartialEq, Eq, Debug)]
pub enum AddMapResult {
Ok,
OverlapFailure,
}
/// A generic interface for vfio and other iommu backends
///
/// This interface includes APIs to supports allowing clients within crosvm (e.g.
/// the VVU proxy) which are configured to sit behind a virtio-iommu device to
/// access memory via IO virtual address (IOVA). This is done by exporting mapped
/// memory to the client. The virtio-iommu device can manage many mappers
/// simultaneously. The current implementation has a 1-to-1 relationship between
/// mappers and clients, although this may be extended to 1-to-N to fully support
/// the virtio-iommu API.
///
/// Clients must only access memory while it is mapped into the virtio-iommu device.
/// As such, this interface has a concept of an "IOMMU fault". An IOMMU fault is
/// triggered when the guest removes a mapping that includes memory that is exported
/// but not yet released. This includes if |reset_domain| is called while any memory
/// is exported. When an IOMMU fault occurs, the event returned by
/// |start_export_session| is signaled, and the client must immediately release any
/// exported memory.
///
/// From the virtio-iommu's perspective, if |remove_map| or |reset_domain| triggers
/// an IOMMU fault, then an eventfd will be returned. It must wait on that event
/// until all exported regions have been released, at which point it can complete
/// the virtio request that triggered the fault.
///
/// As such, the flow of a fault is:
/// 1) The guest sends an virtio-iommu message that triggers a fault. Faults can be triggered by
/// unmap or detach messages, or by attach messages if such messages are re-attaching an
/// endpoint to a new domain. One example of a guest event that can trigger such a message is a
/// userspace VVU device process crashing and triggering the guest kernel to re-attach the VVU
/// device to the null endpoint.
/// 2) The viommu device removes an exported mapping from the mapper.
/// 3) The mapper signals the IOMMU fault eventfd and returns the fault resolution event to the
/// viommu device.
/// 4) The viommu device starts waiting on the fault resolution event. Note that although the
/// viommu device and mapper are both running on the same executor, this wait is async. This
/// means that although further processing of virtio-iommu requests is paused, the mapper
/// continues to run.
/// 5) The client receives the IOMMU fault.
/// 6) The client releases all exported regions.
/// 7) Once the mapper receives the final release message from the client, it signals the fault
/// resolution event that the viommu device is waiting on.
/// 8) The viommu device finishes processing the original virtio iommu request and sends a reply to
/// the guest.
pub trait MemoryMapper: Send {
/// Creates a new mapping. If the mapping overlaps with an existing
/// mapping, return Ok(false).
fn add_map(&mut self, new_map: MappingInfo) -> Result<AddMapResult>;
/// Removes all mappings within the specified range.
fn remove_map(&mut self, iova_start: u64, size: u64) -> Result<RemoveMapResult>;
fn get_mask(&self) -> Result<u64>;
/// Whether or not endpoints can be safely detached from this mapper.
fn supports_detach(&self) -> bool;
/// Resets the mapper's domain back into its initial state. Only necessary
/// if |supports_detach| returns true.
fn reset_domain(&mut self) -> Option<EventAsync> {
None
}
/// Gets an identifier for the MemoryMapper instance. Must be unique among
/// instances of the same trait implementation.
fn id(&self) -> u32;
/// Starts an export session with the mapper.
///
/// Returns an event which is signaled if exported memory is unmapped (i.e. if
/// a fault occurs). Once a fault occurs, no new regions may be exported for
/// that session. The client must watch for this event and immediately release
/// all exported regions.
///
/// Only one session can be active at a time. A new session can only be created if
/// the previous session has no remaining exported regions.
fn start_export_session(&mut self, _ex: &Executor) -> Result<Event> {
bail!("not supported");
}
/// Exports the specified IO region.
///
/// # Safety
///
/// The memory in the region specified by hva and size must be
/// memory external to rust.
unsafe fn vfio_dma_map(
&mut self,
_iova: u64,
_hva: u64,
_size: u64,
_prot: Protection,
) -> Result<AddMapResult> {
bail!("not supported");
}
/// Multiple MemRegions should be returned when the gpa is discontiguous or perms are different.
fn export(&mut self, _iova: u64, _size: u64) -> Result<Vec<MemRegion>> {
bail!("not supported");
}
/// Releases a previously exported region.
///
/// If a given IO region is exported multiple times, it must be released multiple times.
fn release(&mut self, _iova: u64, _size: u64) -> Result<()> {
bail!("not supported");
}
}
pub trait MemoryMapperTrait: MemoryMapper + AsRawDescriptors + Any {}
impl<T: MemoryMapper + AsRawDescriptors + Any> MemoryMapperTrait for T {}
impl BasicMemoryMapper {
pub fn new(mask: u64) -> BasicMemoryMapper {
static NEXT_ID: AtomicU32 = AtomicU32::new(0);
BasicMemoryMapper {
maps: BTreeMap::new(),
mask,
id: NEXT_ID.fetch_add(1, Ordering::Relaxed),
export_state: None,
}
}
#[cfg(test)]
pub fn len(&self) -> usize {
self.maps.len()
}
#[cfg(test)]
pub fn is_empty(&self) -> bool {
self.maps.is_empty()
}
}
impl MemoryMapper for BasicMemoryMapper {
fn add_map(&mut self, new_map: MappingInfo) -> Result<AddMapResult> {
if new_map.size == 0 {
bail!("can't map 0 sized region");
}
let new_iova_end = new_map
.iova
.checked_add(new_map.size)
.context("iova overflow")?;
new_map
.gpa
.checked_add(new_map.size)
.context("gpa overflow")?;
let mut iter = self.maps.range(..new_iova_end);
if let Some((_, map)) = iter.next_back() {
if map.iova + map.size > new_map.iova {
return Ok(AddMapResult::OverlapFailure);
}
}
self.maps.insert(new_map.iova, new_map);
Ok(AddMapResult::Ok)
}
fn remove_map(&mut self, iova_start: u64, size: u64) -> Result<RemoveMapResult> {
if size == 0 {
bail!("can't unmap 0 sized region");
}
let iova_end = iova_start.checked_add(size).context("iova overflow")?;
// So that we invalid requests can be rejected w/o modifying things, check
// for partial overlap before removing the maps.
let mut to_be_removed = Vec::new();
for (key, map) in self.maps.range(..iova_end).rev() {
let map_iova_end = map.iova + map.size;
if map_iova_end <= iova_start {
// no overlap
break;
}
if iova_start <= map.iova && map_iova_end <= iova_end {
to_be_removed.push(*key);
} else {
return Ok(RemoveMapResult::OverlapFailure);
}
}
for key in to_be_removed {
self.maps.remove(&key).expect("map should contain key");
}
if let Some(export_state) = self.export_state.as_mut() {
let removed = AddressRange::from_start_and_size(iova_start, size).unwrap();
for export in &export_state.exported {
if export.overlaps(removed) {
return Ok(RemoveMapResult::Success(export_state.on_fault()));
}
}
}
Ok(RemoveMapResult::Success(None))
}
fn get_mask(&self) -> Result<u64> {
Ok(self.mask)
}
fn supports_detach(&self) -> bool {
true
}
fn reset_domain(&mut self) -> Option<EventAsync> {
self.maps.clear();
if let Some(export_state) = self.export_state.as_mut() {
if !export_state.exported.is_empty() {
return export_state.on_fault();
}
}
None
}
fn id(&self) -> u32 {
self.id
}
fn start_export_session(&mut self, ex: &Executor) -> Result<Event> {
if let Some(export_state) = self.export_state.as_ref() {
if !export_state.exported.is_empty() {
bail!("previous export session still active");
}
}
let (export_state, fault_event) = ExportState::new(ex)?;
self.export_state = Some(export_state);
Ok(fault_event)
}
fn export(&mut self, iova: u64, size: u64) -> Result<Vec<MemRegion>> {
let export_state = self.export_state.as_mut().context("no export state")?;
if !export_state.can_export() {
bail!("broken export state");
}
if size == 0 {
bail!("can't translate 0 sized region");
}
// Regions of contiguous iovas and gpas, and identical permission are merged
let iova_end = iova.checked_add(size).context("iova overflow")?;
let mut iter = self.maps.range(..iova_end);
let mut last_iova = iova_end;
let mut regions: Vec<MemRegion> = Vec::new();
while let Some((_, map)) = iter.next_back() {
if last_iova > map.iova + map.size {
break;
}
let mut new_region = true;
// This is the last region to be inserted / first to be returned when iova >= map.iova
let region_len = last_iova - std::cmp::max::<u64>(map.iova, iova);
if let Some(last) = regions.last_mut() {
if map.gpa.unchecked_add(map.size) == last.gpa && map.prot == last.prot {
last.gpa = map.gpa;
last.len += region_len;
new_region = false;
}
}
if new_region {
// If this is the only region to be returned, region_len == size (arg of this
// function)
// iova_end = iova + size
// last_iova = iova_end
// region_len = last_iova - max(map.iova, iova)
// = iova + size - iova
// = size
regions.push(MemRegion {
gpa: map.gpa,
len: region_len,
prot: map.prot,
});
}
if iova >= map.iova {
regions.reverse();
// The gpa of the first region has to be offseted
regions[0].gpa = map
.gpa
.checked_add(iova - map.iova)
.context("gpa overflow")?;
export_state
.exported
.push(AddressRange::from_start_and_end(iova, iova_end - 1));
return Ok(regions);
}
last_iova = map.iova;
}
Err(anyhow!("invalid iova {:x} {:x}", iova, size))
}
fn release(&mut self, iova: u64, size: u64) -> Result<()> {
let to_remove = AddressRange::from_start_and_size(iova, size).context("iova overflow")?;
let state = self.export_state.as_mut().context("no export state")?;
match state.exported.iter().position(|r| r == &to_remove) {
Some(idx) => {
state.exported.swap_remove(idx);
}
None => {
warn!("tried to release unknown range: {:?}", to_remove);
return Ok(());
}
}
if state.exported.is_empty() && state.fault_resolved_event_external.is_none() {
state
.fault_resolved_event_internal
.signal()
.expect("failed to resolve fault");
}
Ok(())
}
}
impl AsRawDescriptors for BasicMemoryMapper {
fn as_raw_descriptors(&self) -> Vec<RawDescriptor> {
Vec::new()
}
}
#[cfg(test)]
mod tests {
use std::fmt::Debug;
use super::*;
fn assert_overlap_failure(val: RemoveMapResult) {
match val {
RemoveMapResult::OverlapFailure => (),
_ => unreachable!(),
}
}
#[test]
fn test_mapping_info() {
// Overflow
MappingInfo::new(u64::MAX - 1, GuestAddress(1), 2, Protection::read()).unwrap_err();
MappingInfo::new(1, GuestAddress(u64::MAX - 1), 2, Protection::read()).unwrap_err();
MappingInfo::new(u64::MAX, GuestAddress(1), 2, Protection::read()).unwrap_err();
MappingInfo::new(1, GuestAddress(u64::MAX), 2, Protection::read()).unwrap_err();
MappingInfo::new(5, GuestAddress(5), u64::MAX, Protection::read()).unwrap_err();
// size = 0
MappingInfo::new(1, GuestAddress(5), 0, Protection::read()).unwrap_err();
}
#[test]
fn test_map_overlap() {
let mut mapper = BasicMemoryMapper::new(u64::MAX);
mapper
.add_map(
MappingInfo::new(10, GuestAddress(1000), 10, Protection::read_write()).unwrap(),
)
.unwrap();
assert_eq!(
mapper
.add_map(
MappingInfo::new(14, GuestAddress(1000), 1, Protection::read_write()).unwrap()
)
.unwrap(),
AddMapResult::OverlapFailure
);
assert_eq!(
mapper
.add_map(
MappingInfo::new(0, GuestAddress(1000), 12, Protection::read_write()).unwrap()
)
.unwrap(),
AddMapResult::OverlapFailure
);
assert_eq!(
mapper
.add_map(
MappingInfo::new(16, GuestAddress(1000), 6, Protection::read_write()).unwrap()
)
.unwrap(),
AddMapResult::OverlapFailure
);
assert_eq!(
mapper
.add_map(
MappingInfo::new(5, GuestAddress(1000), 20, Protection::read_write()).unwrap()
)
.unwrap(),
AddMapResult::OverlapFailure
);
}
#[test]
// This test is taken from the virtio_iommu spec with translate() calls added
fn test_map_unmap() {
let ex = Executor::new().expect("Failed to create an executor");
// #1
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
mapper.remove_map(0, 4).unwrap();
}
// #2
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let _ = mapper.start_export_session(&ex);
mapper
.add_map(
MappingInfo::new(0, GuestAddress(1000), 9, Protection::read_write()).unwrap(),
)
.unwrap();
assert_eq!(
mapper.export(0, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read_write()
}
);
assert_eq!(
mapper.export(8, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1008),
len: 1,
prot: Protection::read_write()
}
);
mapper.export(9, 1).unwrap_err();
mapper.remove_map(0, 9).unwrap();
mapper.export(0, 1).unwrap_err();
}
// #3
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let _ = mapper.start_export_session(&ex);
mapper
.add_map(
MappingInfo::new(0, GuestAddress(1000), 4, Protection::read_write()).unwrap(),
)
.unwrap();
mapper
.add_map(
MappingInfo::new(5, GuestAddress(50), 4, Protection::read_write()).unwrap(),
)
.unwrap();
assert_eq!(
mapper.export(0, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read_write()
}
);
assert_eq!(
mapper.export(6, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(51),
len: 1,
prot: Protection::read_write()
}
);
mapper.remove_map(0, 9).unwrap();
mapper.export(0, 1).unwrap_err();
mapper.export(6, 1).unwrap_err();
}
// #4
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let _ = mapper.start_export_session(&ex);
mapper
.add_map(
MappingInfo::new(0, GuestAddress(1000), 9, Protection::read_write()).unwrap(),
)
.unwrap();
assert_overlap_failure(mapper.remove_map(0, 4).unwrap());
assert_eq!(
mapper.export(5, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1005),
len: 1,
prot: Protection::read_write()
}
);
}
// #5
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let _ = mapper.start_export_session(&ex);
mapper
.add_map(
MappingInfo::new(0, GuestAddress(1000), 4, Protection::read_write()).unwrap(),
)
.unwrap();
mapper
.add_map(
MappingInfo::new(5, GuestAddress(50), 4, Protection::read_write()).unwrap(),
)
.unwrap();
assert_eq!(
mapper.export(0, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read_write()
}
);
assert_eq!(
mapper.export(5, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(50),
len: 1,
prot: Protection::read_write()
}
);
mapper.remove_map(0, 4).unwrap();
mapper.export(0, 1).unwrap_err();
mapper.export(4, 1).unwrap_err();
mapper.export(5, 1).unwrap_err();
}
// #6
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let _ = mapper.start_export_session(&ex);
mapper
.add_map(
MappingInfo::new(0, GuestAddress(1000), 4, Protection::read_write()).unwrap(),
)
.unwrap();
assert_eq!(
mapper.export(0, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read_write()
}
);
mapper.export(9, 1).unwrap_err();
mapper.remove_map(0, 9).unwrap();
mapper.export(0, 1).unwrap_err();
mapper.export(9, 1).unwrap_err();
}
// #7
{
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let _ = mapper.start_export_session(&ex);
mapper
.add_map(MappingInfo::new(0, GuestAddress(1000), 4, Protection::read()).unwrap())
.unwrap();
mapper
.add_map(
MappingInfo::new(10, GuestAddress(50), 4, Protection::read_write()).unwrap(),
)
.unwrap();
assert_eq!(
mapper.export(0, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(3, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1003),
len: 1,
prot: Protection::read()
}
);
mapper.export(4, 1).unwrap_err();
assert_eq!(
mapper.export(10, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(50),
len: 1,
prot: Protection::read_write()
}
);
assert_eq!(
mapper.export(13, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(53),
len: 1,
prot: Protection::read_write()
}
);
mapper.remove_map(0, 14).unwrap();
mapper.export(0, 1).unwrap_err();
mapper.export(3, 1).unwrap_err();
mapper.export(4, 1).unwrap_err();
mapper.export(10, 1).unwrap_err();
mapper.export(13, 1).unwrap_err();
}
}
#[test]
fn test_remove_map() {
let mut mapper = BasicMemoryMapper::new(u64::MAX);
mapper
.add_map(MappingInfo::new(1, GuestAddress(1000), 4, Protection::read()).unwrap())
.unwrap();
mapper
.add_map(MappingInfo::new(5, GuestAddress(50), 4, Protection::read_write()).unwrap())
.unwrap();
mapper
.add_map(MappingInfo::new(9, GuestAddress(50), 4, Protection::read_write()).unwrap())
.unwrap();
assert_eq!(mapper.len(), 3);
assert_overlap_failure(mapper.remove_map(0, 6).unwrap());
assert_eq!(mapper.len(), 3);
assert_overlap_failure(mapper.remove_map(1, 5).unwrap());
assert_eq!(mapper.len(), 3);
assert_overlap_failure(mapper.remove_map(1, 9).unwrap());
assert_eq!(mapper.len(), 3);
assert_overlap_failure(mapper.remove_map(6, 4).unwrap());
assert_eq!(mapper.len(), 3);
assert_overlap_failure(mapper.remove_map(6, 14).unwrap());
assert_eq!(mapper.len(), 3);
mapper.remove_map(5, 4).unwrap();
assert_eq!(mapper.len(), 2);
assert_overlap_failure(mapper.remove_map(1, 9).unwrap());
assert_eq!(mapper.len(), 2);
mapper.remove_map(0, 15).unwrap();
assert_eq!(mapper.len(), 0);
}
fn assert_vec_eq<T: std::cmp::PartialEq + Debug>(a: Vec<T>, b: Vec<T>) {
assert_eq!(a.len(), b.len());
for (x, y) in a.into_iter().zip(b.into_iter()) {
assert_eq!(x, y);
}
}
#[test]
fn test_translate_len() {
let mut mapper = BasicMemoryMapper::new(u64::MAX);
let ex = Executor::new().expect("Failed to create an executor");
let _ = mapper.start_export_session(&ex);
// [1, 5) -> [1000, 1004)
mapper
.add_map(MappingInfo::new(1, GuestAddress(1000), 4, Protection::read()).unwrap())
.unwrap();
mapper.export(1, 0).unwrap_err();
assert_eq!(
mapper.export(1, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(1, 2).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 2,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(1, 3).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 3,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(2, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(1001),
len: 1,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(2, 2).unwrap()[0],
MemRegion {
gpa: GuestAddress(1001),
len: 2,
prot: Protection::read()
}
);
mapper.export(1, 5).unwrap_err();
// [1, 9) -> [1000, 1008)
mapper
.add_map(MappingInfo::new(5, GuestAddress(1004), 4, Protection::read()).unwrap())
.unwrap();
// Spanned across 2 maps
assert_eq!(
mapper.export(2, 5).unwrap()[0],
MemRegion {
gpa: GuestAddress(1001),
len: 5,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(2, 6).unwrap()[0],
MemRegion {
gpa: GuestAddress(1001),
len: 6,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(2, 7).unwrap()[0],
MemRegion {
gpa: GuestAddress(1001),
len: 7,
prot: Protection::read()
}
);
mapper.export(2, 8).unwrap_err();
mapper.export(3, 10).unwrap_err();
// [1, 9) -> [1000, 1008), [11, 17) -> [1010, 1016)
mapper
.add_map(MappingInfo::new(11, GuestAddress(1010), 6, Protection::read()).unwrap())
.unwrap();
// Discontiguous iova
mapper.export(3, 10).unwrap_err();
// [1, 17) -> [1000, 1016)
mapper
.add_map(MappingInfo::new(9, GuestAddress(1008), 2, Protection::read()).unwrap())
.unwrap();
// Spanned across 4 maps
assert_eq!(
mapper.export(3, 10).unwrap()[0],
MemRegion {
gpa: GuestAddress(1002),
len: 10,
prot: Protection::read()
}
);
assert_eq!(
mapper.export(1, 16).unwrap()[0],
MemRegion {
gpa: GuestAddress(1000),
len: 16,
prot: Protection::read()
}
);
mapper.export(1, 17).unwrap_err();
mapper.export(0, 16).unwrap_err();
// [0, 1) -> [5, 6), [1, 17) -> [1000, 1016)
mapper
.add_map(MappingInfo::new(0, GuestAddress(5), 1, Protection::read()).unwrap())
.unwrap();
assert_eq!(
mapper.export(0, 1).unwrap()[0],
MemRegion {
gpa: GuestAddress(5),
len: 1,
prot: Protection::read()
}
);
// Discontiguous gpa
assert_vec_eq(
mapper.export(0, 2).unwrap(),
vec![
MemRegion {
gpa: GuestAddress(5),
len: 1,
prot: Protection::read(),
},
MemRegion {
gpa: GuestAddress(1000),
len: 1,
prot: Protection::read(),
},
],
);
assert_vec_eq(
mapper.export(0, 16).unwrap(),
vec![
MemRegion {
gpa: GuestAddress(5),
len: 1,
prot: Protection::read(),
},
MemRegion {
gpa: GuestAddress(1000),
len: 15,
prot: Protection::read(),
},
],
);
// [0, 1) -> [5, 6), [1, 17) -> [1000, 1016), [17, 18) -> [1016, 1017) <RW>
mapper
.add_map(MappingInfo::new(17, GuestAddress(1016), 2, Protection::read_write()).unwrap())
.unwrap();
// Contiguous iova and gpa, but different perm
assert_vec_eq(
mapper.export(1, 17).unwrap(),
vec![
MemRegion {
gpa: GuestAddress(1000),
len: 16,
prot: Protection::read(),
},
MemRegion {
gpa: GuestAddress(1016),
len: 1,
prot: Protection::read_write(),
},
],
);
// Contiguous iova and gpa, but different perm
assert_vec_eq(
mapper.export(2, 16).unwrap(),
vec![
MemRegion {
gpa: GuestAddress(1001),
len: 15,
prot: Protection::read(),
},
MemRegion {
gpa: GuestAddress(1016),
len: 1,
prot: Protection::read_write(),
},
],
);
assert_vec_eq(
mapper.export(2, 17).unwrap(),
vec![
MemRegion {
gpa: GuestAddress(1001),
len: 15,
prot: Protection::read(),
},
MemRegion {
gpa: GuestAddress(1016),
len: 2,
prot: Protection::read_write(),
},
],
);
mapper.export(2, 500).unwrap_err();
mapper.export(500, 5).unwrap_err();
}
}