Add a new crate 'iommufd-ioctls'

Signed-off-by: Bo Chen <bchen@crusoe.ai>

Author: likebreath

Cargo.toml

@@ -1,3 +1,3 @@
 [workspace]
-members = ["iommufd-bindings"]
+members = ["iommufd-bindings", "iommufd-ioctls"]
 resolver = "2"

iommufd-ioctls/Cargo.toml

@@ -0,0 +1,15 @@
+[package]
+name = "iommufd-ioctls"
+version = "0.1.0"
+authors = ["The Cloud Hypervisor Authors"]
+license = "Apache-2.0"
+description = "Safe wrappers over IOMMUFD uAPIs"
+repository = "https://github.com/cloud-hypervisor/iommufd"
+readme = "README.md"
+edition = "2024"
+keywords = ["iommufd"]
+
+[dependencies]
+iommufd-bindings = { version = "0.1.0", path = "../iommufd-bindings" }
+thiserror = "2.0.17"
+vmm-sys-util = { version = "0.14.0" }

iommufd-ioctls/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

iommufd-ioctls/README.md

@@ -0,0 +1,7 @@
+# iommufd-ioctls
+
+The iommufd-ioctls crate provides safe wrappers over the
+[IOMMUFD uAPIs](https://docs.kernel.org/userspace-api/iommufd.html#iommufd-user-api), a set
+of ioctls used to control the IOMMU subsystem as it relates to managing
+IO page tables from userspace. The ioctls are accessible through
+structure `IommuFd`.

iommufd-ioctls/src/iommufd_ioctls.rs

@@ -0,0 +1,122 @@
+// Copyright © 2025 Crusoe Energy Systems LLC
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+use std::fs::{File, OpenOptions};
+use std::os::unix::io::{AsRawFd, RawFd};
+
+use iommufd_bindings::iommufd::*;
+use vmm_sys_util::errno::Error as SysError;
+
+use crate::{IommufdError, Result};
+
+pub struct IommuFd {
+    iommufd: File,
+}
+
+impl IommuFd {
+    pub fn new() -> Result<Self> {
+        let iommufd = OpenOptions::new()
+            .read(true)
+            .write(true)
+            .open("/dev/iommu")
+            .map_err(IommufdError::OpenIommufd)?;
+
+        Ok(IommuFd { iommufd })
+    }
+
+    pub fn alloc_iommu_ioas(&self, alloc_data: &mut iommu_ioas_alloc) -> Result<()> {
+        iommufd_syscall::alloc_iommu_ioas(self, alloc_data)
+    }
+
+    pub fn map_iommu_ioas(&self, map: &iommu_ioas_map) -> Result<()> {
+        iommufd_syscall::map_iommu_ioas(self, map)
+    }
+    pub fn unmap_iommu_ioas(&self, unmap: &mut iommu_ioas_unmap) -> Result<()> {
+        iommufd_syscall::unmap_iommu_ioas(self, unmap)
+    }
+}
+
+impl AsRawFd for IommuFd {
+    fn as_raw_fd(&self) -> RawFd {
+        self.iommufd.as_raw_fd()
+    }
+}
+
+ioctl_io_nr!(
+    IOMMU_IOAS_ALLOC,
+    IOMMUFD_TYPE as u32,
+    IOMMUFD_CMD_IOAS_ALLOC
+);
+ioctl_io_nr!(IOMMU_IOAS_MAP, IOMMUFD_TYPE as u32, IOMMUFD_CMD_IOAS_MAP);
+ioctl_io_nr!(
+    IOMMU_IOAS_UNMAP,
+    IOMMUFD_TYPE as u32,
+    IOMMUFD_CMD_IOAS_UNMAP
+);
+
+// Safety:
+// - absolutely trust the underlying kernel
+// - absolutely trust data returned by the underlying kernel
+// - assume kernel will return error if caller passes in invalid file handle, parameter or buffer.
+pub(crate) mod iommufd_syscall {
+    use super::*;
+    use vmm_sys_util::ioctl::{ioctl_with_mut_ref, ioctl_with_ref};
+
+    pub(crate) fn alloc_iommu_ioas(
+        iommufd: &IommuFd,
+        alloc_data: &mut iommu_ioas_alloc,
+    ) -> Result<()> {
+        // SAFETY:
+        // 1. The file descriptor provided by 'iommufd' is valid and open.
+        // 2. The 'alloc_data' points to initialized memory with expected data structure,
+        // and remains valid for the duration of syscall.
+        // 3. The return value is checked.
+        let ret = unsafe { ioctl_with_mut_ref(iommufd, IOMMU_IOAS_ALLOC(), alloc_data) };
+        if ret < 0 {
+            Err(IommufdError::IommuIoasAlloc(SysError::last()))
+        } else {
+            Ok(())
+        }
+    }
+
+    pub(crate) fn map_iommu_ioas(iommufd: &IommuFd, map: &iommu_ioas_map) -> Result<()> {
+        // SAFETY:
+        // 1. The file descriptor provided by 'iommufd' is valid and open.
+        // 2. The 'map' points to initialized memory with expected data structure,
+        // and remains valid for the duration of syscall.
+        // 3. The return value is checked.
+        let ret = unsafe { ioctl_with_ref(iommufd, IOMMU_IOAS_MAP(), map) };
+        if ret < 0 {
+            Err(IommufdError::IommuIoasMap(SysError::last()))
+        } else {
+            Ok(())
+        }
+    }
+    pub(crate) fn unmap_iommu_ioas(iommufd: &IommuFd, unmap: &mut iommu_ioas_unmap) -> Result<()> {
+        // SAFETY:
+        // 1. The file descriptor provided by 'iommufd' is valid and open.
+        // 2. The 'unmap' points to initialized memory with expected data structure,
+        // and remains valid for the duration of syscall.
+        // 3. The return value is checked.
+        let ret = unsafe { ioctl_with_ref(iommufd, IOMMU_IOAS_UNMAP(), unmap) };
+        if ret < 0 {
+            Err(IommufdError::IommuIoasUnmap(SysError::last()))
+        } else {
+            Ok(())
+        }
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn test_iommufd_ioctl_code() {
+        assert_eq!(IOMMU_IOAS_ALLOC(), 15233);
+        assert_eq!(IOMMU_IOAS_MAP(), 15237);
+        assert_eq!(IOMMU_IOAS_UNMAP(), 15238);
+    }
+}

iommufd-ioctls/src/lib.rs

@@ -0,0 +1,29 @@
+// Copyright © 2025 Crusoe Energy Systems LLC
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+
+#[macro_use]
+extern crate vmm_sys_util;
+
+use std::io;
+use thiserror::Error;
+use vmm_sys_util::errno::Error as SysError;
+
+pub mod iommufd_ioctls;
+
+pub use iommufd_ioctls::*;
+
+#[derive(Debug, Error)]
+pub enum IommufdError {
+    #[error("failed to open /dev/iommufd: {0}")]
+    OpenIommufd(#[source] io::Error),
+    #[error("failed to allocate IOAS: {0}")]
+    IommuIoasAlloc(#[source] SysError),
+    #[error("failed to map an IOVA range to the IOAS: {0}")]
+    IommuIoasMap(#[source] SysError),
+    #[error("failed to unmap an IOVA range from the IOAS: {0}")]
+    IommuIoasUnmap(#[source] SysError),
+}
+
+pub type Result<T> = std::result::Result<T, IommufdError>;