Add macOS/DriverKit through MacVFN

.github/workflows/build.yml

@@ -189,6 +189,33 @@ jobs:
           name: meson test log
           path: build/meson-logs/testlog.txt
 
+  macos-build:
+    name: "macOS build"
+    needs: [sanity]
+    runs-on: macos-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+        with:
+          repository: samsungds/macvfn
+          ref: libvfn4 # TODO: 'master' once merged
+
+      - name: Configure PR branch as submodule
+        run: |
+          SUBMODULE_PATH="MacVFN/libvfn"
+          BRANCH_NAME=${GITHUB_HEAD_REF#refs/heads/}
+          git config -f .gitmodules submodule.$SUBMODULE_PATH.url ${GITHUB_SERVER_URL}/${{github.event.pull_request.head.repo.full_name}}
+          git config -f .gitmodules submodule.$SUBMODULE_PATH.branch "$BRANCH_NAME"
+          cat .gitmodules
+          git submodule update --remote --init $SUBMODULE_PATH
+
+      - name: Install dependencies
+        run: brew install meson
+
+      - name: Xcode build
+        run: make build
+
   device-test:
     name: "run emulated nvme device tests"
 

.gitignore

@@ -1 +1,3 @@
 tags
+crc64table.h
+config.h

docs/api/support/log.rst

@@ -3,4 +3,4 @@
 Logging
 =======
 
-.. kernel-doc:: include/vfn/support/log.h
+.. kernel-doc:: include/vfn/support/platform/linux/log.h

docs/api/support/mem.rst

@@ -3,4 +3,4 @@
 Memory Allocation Helpers
 =========================
 
-.. kernel-doc:: include/vfn/support/mem.h
+.. kernel-doc:: include/vfn/support/platform/linux/mem.h

docs/api/support/mmio.rst

@@ -6,4 +6,4 @@ Memory-mapped I/O
 These helpers expect and return little endian types (i.e. ``leint32_t``) which
 may help with locating endianness related bugs using the sparse static analyzer.
 
-.. kernel-doc:: include/vfn/support/mmio.h
+.. kernel-doc:: include/vfn/support/platform/linux/mmio.h

docs/api/support/mutex.rst

@@ -3,4 +3,4 @@
 Autolockable Mutex
 ==================
 
-.. kernel-doc:: include/vfn/support/mutex.h
+.. kernel-doc:: include/vfn/support/platform/linux/mutex.h

examples/cmb-p2p.c

@@ -59,13 +59,13 @@ static void *nvme_configure_cmb(struct nvme_ctrl *ctrl, uint64_t *hwaddr, uint64
 	struct iommu_iova_range *iova_ranges;
 	int num_iova_ranges;
 
-	cap = le64_to_cpu(mmio_read64(ctrl->regs + NVME_REG_CAP));
+	cap = le64_to_cpu(mmio_read64(ctrl->regs, NVME_REG_CAP));
 
 	if (NVME_GET(cap, CAP_CMBS))
-		mmio_hl_write64(ctrl->regs + NVME_REG_CMBMSC, cpu_to_le64(0x1));
+		mmio_hl_write64(ctrl->regs, NVME_REG_CMBMSC, cpu_to_le64(0x1));
 
-	cmbsz = le32_to_cpu(mmio_read32(ctrl->regs + NVME_REG_CMBSZ));
-	cmbloc = le32_to_cpu(mmio_read32(ctrl->regs + NVME_REG_CMBLOC));
+	cmbsz = le32_to_cpu(mmio_read32(ctrl->regs, NVME_REG_CMBSZ));
+	cmbloc = le32_to_cpu(mmio_read32(ctrl->regs, NVME_REG_CMBLOC));
 
 	szu = 1 << (12 + 4 * NVME_GET(cmbsz, CMBSZ_SZU));
 	len = szu * NVME_GET(cmbsz, CMBSZ_SZ);
@@ -103,7 +103,7 @@ static void *nvme_configure_cmb(struct nvme_ctrl *ctrl, uint64_t *hwaddr, uint64
 	printf("assigned cmb base address is 0x%lx\n", *cba);
 
 	/* set the base address and enable the memory space */
-	mmio_hl_write64(ctrl->regs + NVME_REG_CMBMSC, cpu_to_le64(*cba | 0x3));
+	mmio_hl_write64(ctrl->regs, NVME_REG_CMBMSC, cpu_to_le64(*cba | 0x3));
 
 	return cmb;
 }

examples/cmb.c

@@ -68,19 +68,19 @@ int main(int argc, char **argv)
 	if (nvme_init(&ctrl, bdf, NULL))
 		err(1, "failed to init nvme controller");
 
-	vs = le32_to_cpu(mmio_read32(ctrl.regs + NVME_REG_VS));
+	vs = le32_to_cpu(mmio_read32(ctrl.regs, NVME_REG_VS));
 	if (vs < NVME_VERSION(1, 4, 0))
 		errx(1, "controller must be compliant with at least nvme v1.4.0");
 
-	cap = le64_to_cpu(mmio_read64(ctrl.regs + NVME_REG_CAP));
+	cap = le64_to_cpu(mmio_read64(ctrl.regs, NVME_REG_CAP));
 	if (!NVME_GET(cap, CAP_CMBS))
 		errx(1, "controller memory buffer not supported (cap 0x%lx)", cap);
 
 	/* enable the CMBSZ and CMBLOC registers */
-	mmio_hl_write64(ctrl.regs + NVME_REG_CMBMSC, cpu_to_le64(0x1));
+	mmio_hl_write64(ctrl.regs, NVME_REG_CMBMSC, cpu_to_le64(0x1));
 
-	cmbsz = le32_to_cpu(mmio_read32(ctrl.regs + NVME_REG_CMBSZ));
-	cmbloc = le32_to_cpu(mmio_read32(ctrl.regs + NVME_REG_CMBLOC));
+	cmbsz = le32_to_cpu(mmio_read32(ctrl.regs, NVME_REG_CMBSZ));
+	cmbloc = le32_to_cpu(mmio_read32(ctrl.regs, NVME_REG_CMBLOC));
 
 	szu = 1 << (12 + 4 * NVME_GET(cmbsz, CMBSZ_SZU));
 	len = szu * NVME_GET(cmbsz, CMBSZ_SZ);
@@ -113,7 +113,7 @@ int main(int argc, char **argv)
 	printf("assigned cmb base address is 0x%lx\n", cba);
 
 	/* set the base address and enable the memory space */
-	mmio_hl_write64(ctrl.regs + NVME_REG_CMBMSC, cpu_to_le64(cba | 0x3));
+	mmio_hl_write64(ctrl.regs, NVME_REG_CMBMSC, cpu_to_le64(cba | 0x3));
 
 	cmd = (union nvme_cmd) {
 		.opcode = nvme_admin_identify,

examples/regs.c

@@ -66,30 +66,30 @@ int main(int argc, char **argv)
 
 	regs = ctrl.regs;
 
-	cap = le64_to_cpu(mmio_read64(regs + NVME_REG_CAP));
-	vs = le32_to_cpu(mmio_read32(regs + NVME_REG_VS));
-	intms = le32_to_cpu(mmio_read32(regs + NVME_REG_INTMS));
-	intmc = le32_to_cpu(mmio_read32(regs + NVME_REG_INTMC));
-	cc = le32_to_cpu(mmio_read32(regs + NVME_REG_CC));
-	csts = le32_to_cpu(mmio_read32(regs + NVME_REG_CSTS));
-	nssr = le32_to_cpu(mmio_read32(regs + NVME_REG_NSSR));
-	aqa = le32_to_cpu(mmio_read32(regs + NVME_REG_AQA));
-	asq = le64_to_cpu(mmio_read64(regs + NVME_REG_ASQ));
-	acq = le64_to_cpu(mmio_read64(regs + NVME_REG_ACQ));
-	cmbloc = le32_to_cpu(mmio_read32(regs + NVME_REG_CMBLOC));
-	cmbsz = le32_to_cpu(mmio_read32(regs + NVME_REG_CMBSZ));
-	bpinfo = le32_to_cpu(mmio_read32(regs + NVME_REG_BPINFO));
-	bprsel = le32_to_cpu(mmio_read32(regs + NVME_REG_BPRSEL));
-	bpmbl = le64_to_cpu(mmio_read64(regs + NVME_REG_BPMBL));
-	cmbmsc = le64_to_cpu(mmio_read64(regs + NVME_REG_CMBMSC));
-	cmbsts = le32_to_cpu(mmio_read32(regs + NVME_REG_CMBSTS));
-	pmrcap = le32_to_cpu(mmio_read32(regs + NVME_REG_PMRCAP));
-	pmrctl = le32_to_cpu(mmio_read32(regs + NVME_REG_PMRCTL));
-	pmrsts = le32_to_cpu(mmio_read32(regs + NVME_REG_PMRSTS));
-	pmrebs = le32_to_cpu(mmio_read32(regs + NVME_REG_PMREBS));
-	pmrswtp = le32_to_cpu(mmio_read32(regs + NVME_REG_PMRSWTP));
-	pmrmsc = le32_to_cpu(mmio_read32(regs + NVME_REG_PMRMSCL)) |
-		(uint64_t)le32_to_cpu(mmio_read32(regs + NVME_REG_PMRMSCU)) << 32;
+	cap = le64_to_cpu(mmio_read64(regs, NVME_REG_CAP));
+	vs = le32_to_cpu(mmio_read32(regs, NVME_REG_VS));
+	intms = le32_to_cpu(mmio_read32(regs, NVME_REG_INTMS));
+	intmc = le32_to_cpu(mmio_read32(regs, NVME_REG_INTMC));
+	cc = le32_to_cpu(mmio_read32(regs, NVME_REG_CC));
+	csts = le32_to_cpu(mmio_read32(regs, NVME_REG_CSTS));
+	nssr = le32_to_cpu(mmio_read32(regs, NVME_REG_NSSR));
+	aqa = le32_to_cpu(mmio_read32(regs, NVME_REG_AQA));
+	asq = le64_to_cpu(mmio_read64(regs, NVME_REG_ASQ));
+	acq = le64_to_cpu(mmio_read64(regs, NVME_REG_ACQ));
+	cmbloc = le32_to_cpu(mmio_read32(regs, NVME_REG_CMBLOC));
+	cmbsz = le32_to_cpu(mmio_read32(regs, NVME_REG_CMBSZ));
+	bpinfo = le32_to_cpu(mmio_read32(regs, NVME_REG_BPINFO));
+	bprsel = le32_to_cpu(mmio_read32(regs, NVME_REG_BPRSEL));
+	bpmbl = le64_to_cpu(mmio_read64(regs, NVME_REG_BPMBL));
+	cmbmsc = le64_to_cpu(mmio_read64(regs, NVME_REG_CMBMSC));
+	cmbsts = le32_to_cpu(mmio_read32(regs, NVME_REG_CMBSTS));
+	pmrcap = le32_to_cpu(mmio_read32(regs, NVME_REG_PMRCAP));
+	pmrctl = le32_to_cpu(mmio_read32(regs, NVME_REG_PMRCTL));
+	pmrsts = le32_to_cpu(mmio_read32(regs, NVME_REG_PMRSTS));
+	pmrebs = le32_to_cpu(mmio_read32(regs, NVME_REG_PMREBS));
+	pmrswtp = le32_to_cpu(mmio_read32(regs, NVME_REG_PMRSWTP));
+	pmrmsc = le32_to_cpu(mmio_read32(regs, NVME_REG_PMRMSCL)) |
+		(uint64_t)le32_to_cpu(mmio_read32(regs, NVME_REG_PMRMSCU)) << 32;
 
 	printf("%-16s %lx\n",  "CAP", cap);
 	printf("%-16s %lx\n",  "CAP.MQES", NVME_CAP_MQES(cap));

include/vfn/driverkit.h

@@ -0,0 +1,28 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later or MIT */
+
+/*
+ * This file is part of libvfn.
+ *
+ * Copyright (C) 2022 The libvfn Authors. All Rights Reserved.
+ *
+ * This library (libvfn) is dual licensed under the GNU Lesser General
+ * Public License version 2.1 or later or the MIT license. See the
+ * COPYING and LICENSE files for more information.
+ */
+
+#ifndef LIBVFN_VFIO_H
+#define LIBVFN_VFIO_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include <vfn/driverkit/device.h>
+#include <vfn/driverkit/pci.h>
+#include <vfn/iommu/dma.h>
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* LIBVFN_VFIO_H */

include/vfn/driverkit/device.h

@@ -0,0 +1,37 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later or MIT */
+
+/*
+ * This file is part of libvfn.
+ *
+ * Copyright (C) 2022 The libvfn Authors. All Rights Reserved.
+ *
+ * This library (libvfn) is dual licensed under the GNU Lesser General
+ * Public License version 2.1 or later or the MIT license. See the
+ * COPYING and LICENSE files for more information.
+ */
+
+#ifndef LIBVFN_DRIVERKIT_DEVICE_H
+#define LIBVFN_DRIVERKIT_DEVICE_H
+
+#include <DriverKit/OSCollection.h>
+#include <PCIDriverKit/PCIDriverKit.h>
+#include "iommu/context.h"
+
+struct driverkit_bar_info {
+	uint8_t type;
+	uint8_t memory_index;
+	uint64_t size;
+};
+
+struct driverkit_pci_device {
+	IOPCIDevice *dev;
+	struct iommu_ctx ctx;
+	OSDictionary *iommu_mappings;
+	const char *bdf;
+
+	struct driverkit_bar_info bar_region_info[6];
+};
+
+#define __iommu_ctx(x) (&((struct driverkit_pci_device *)(x))->ctx)
+
+#endif /* LIBVFN_DRIVERKIT_DEVICE_H */

include/vfn/driverkit/pci.h

@@ -0,0 +1,47 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later or MIT */
+
+#ifndef LIBVFN_VFIO_PCI_H
+#define LIBVFN_VFIO_PCI_H
+
+#define off_t int
+
+// NOTE: Dummy PROT to satisfy Linux code
+enum {
+	PROT_READ = 0,
+	PROT_WRITE = 1,
+};
+
+// NOTE: Faux open for macOS
+int vfio_pci_open(struct driverkit_pci_device *pci, const char *bdf);
+
+/**
+ * vfio_pci_map_bar - faux mapping in DriverKit
+ * @pci: &struct driverkit_pci_device
+ * @idx: the vfio region index to map
+ * @len: number of bytes to map
+ * @offset: offset at which to start mapping
+ * @prot: what accesses to permit to the mapped area (see ``man mmap``).
+ *
+ * Used in place of VFIO map device memory region identified by @idx into virtual memory.
+ *
+ * Return: On success, returns the virtual memory address mapped. On error,
+ * returns ``NULL`` and sets ``errno``.
+ */
+void *vfio_pci_map_bar(struct driverkit_pci_device *pci, int idx, size_t len, uint64_t offset,
+			   int prot);
+
+/**
+ * vfio_pci_unmap_bar - faux unmap a region in virtual memory for DriverKit
+ * @pci: &struct driverkit_pci_device
+ * @idx: the vfio region index to unmap
+ * @mem: virtual memory address to unmap
+ * @len: number of bytes to unmap
+ * @offset: offset at which to start unmapping
+ *
+ * Used in place of VFIO to unmap the virtual memory address, previously mapped
+ * to the vfio device memory region identified by @idx.
+ */
+void vfio_pci_unmap_bar(struct driverkit_pci_device *pci, int idx, void *mem, size_t len,
+			uint64_t offset);
+
+#endif /* LIBVFN_VFIO_PCI_H */

include/vfn/iommu.h

@@ -13,21 +13,15 @@
 #ifndef LIBVFN_IOMMU_H
 #define LIBVFN_IOMMU_H
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #include <stdbool.h>
 #include <stddef.h>
 #include <stdint.h>
 
+#ifndef __APPLE__
 #include <linux/types.h>
+#endif
 
 #include <vfn/iommu/context.h>
 #include <vfn/iommu/dma.h>
 
-#ifdef __cplusplus
-}
-#endif
-
 #endif /* LIBVFN_IOMMU_H */

include/vfn/iommu/dma.h

@@ -31,6 +31,7 @@ enum iommu_map_flags {
 	IOMMU_MAP_NOREAD	= 1 << 3,
 };
 
+#ifndef __APPLE__
 /**
  * iommu_map_vaddr - Map a virtual memory address to an I/O virtual address
  * @ctx: &struct iommu_ctx
@@ -53,6 +54,9 @@ enum iommu_map_flags {
  */
 int iommu_map_vaddr(struct iommu_ctx *ctx, void *vaddr, size_t len, uint64_t *iova,
 		    unsigned long flags);
+#endif
+int _iommu_map_vaddr(struct iommu_ctx *ctx, void *vaddr, size_t len, uint64_t *iova,
+		    unsigned long flags, void *opaque);
 
 /**
  * iommu_unmap_vaddr - Unmap a virtual memory address in the IOMMU
@@ -78,12 +82,14 @@ int iommu_unmap_vaddr(struct iommu_ctx *ctx, void *vaddr, size_t *len);
  */
 int iommu_unmap_all(struct iommu_ctx *ctx);
 
+#ifndef __APPLE__
 #ifndef IOMMU_IOAS_IOVA_RANGES
 struct iommu_iova_range {
 	__aligned_u64 start;
 	__aligned_u64 last;
 };
 #endif
+#endif
 
 /**
  * iommu_translate_vaddr - Translate a virtual address into an iova
@@ -98,6 +104,7 @@ struct iommu_iova_range {
  */
 bool iommu_translate_vaddr(struct iommu_ctx *ctx, void *vaddr, uint64_t *iova);
 
+#ifndef __APPLE__
 /**
  * iommu_get_iova_ranges - Get iova ranges
  * @ctx: &struct iommu_ctx
@@ -108,5 +115,6 @@ bool iommu_translate_vaddr(struct iommu_ctx *ctx, void *vaddr, uint64_t *iova);
  * Return: the number of elements in the array pointed to.
  */
 int iommu_get_iova_ranges(struct iommu_ctx *ctx, struct iommu_iova_range **ranges);
+#endif
 
 #endif /* LIBVFN_IOMMU_DMA_H */