summaryrefslogtreecommitdiffstats
path: root/userspace/sdks/nv570/nvalloc/unix/include/os-interface.h
diff options
context:
space:
mode:
authorArthur Hanson Rasmusson <arthur@vgpu.io>2026-09-13 18:36:21 -0400
committerArthur Hanson Rasmusson <arthur@vgpu.io>2026-09-13 18:36:21 -0400
commit00e54c13c7c9030c4d5f7151467f2d85a3730e29 (patch)
tree17a45239df8d2e4912ff3697ed06e85a10b969de /userspace/sdks/nv570/nvalloc/unix/include/os-interface.h
downloadopen-iov-00e54c13c7c9030c4d5f7151467f2d85a3730e29.tar.gz
open-iov-00e54c13c7c9030c4d5f7151467f2d85a3730e29.zip
Initial commit: Open-IOV vGPU-IO complete stack
- Firmware decompilation: GSP 570.144W (28.5MB ELF, RV64IMAC), 132 decompiled C files - Kernel modules: nvidia.ko (34MB, OpenRM), open-iov-vfio.ko (2.8MB, VFIO mdev), gsp-vgpu.ko (1.8MB, guest driver) - Userspace: libiov.so/libvgpu.so (76KB), example_vgpu (28KB), rpc_emulator.c - PCI config space emulation (256B with PM, MSI, MSI-X, PCIe caps) - 12 RPC types fully mapped from firmware decompilation - BAR trap, WPR, scheduling, notification, migration emulation - Helper scripts: load_vgpu_stack, create_mdev, launch_qemu_vgpu, test_vgpu_stack, setup_guest_driver, unload_vgpu_stack - Architecture documentation - Wiki: 10 technical documents - Git LFS for large binaries (.ko, .bin, .iso, .img, .o, ghidra repos) - nvidia-open-gpu-kernel-modules as submodule
Diffstat (limited to 'userspace/sdks/nv570/nvalloc/unix/include/os-interface.h')
-rw-r--r--userspace/sdks/nv570/nvalloc/unix/include/os-interface.h298
1 files changed, 298 insertions, 0 deletions
diff --git a/userspace/sdks/nv570/nvalloc/unix/include/os-interface.h b/userspace/sdks/nv570/nvalloc/unix/include/os-interface.h
new file mode 100644
index 0000000..2a80c50
--- /dev/null
+++ b/userspace/sdks/nv570/nvalloc/unix/include/os-interface.h
@@ -0,0 +1,298 @@
+/*
+ * SPDX-FileCopyrightText: Copyright (c) 1999-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+ * SPDX-License-Identifier: MIT
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a
+ * copy of this software and associated documentation files (the "Software"),
+ * to deal in the Software without restriction, including without limitation
+ * the rights to use, copy, modify, merge, publish, distribute, sublicense,
+ * and/or sell copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+ * DEALINGS IN THE SOFTWARE.
+ */
+
+
+/*
+ * Os interface definitions needed by os-interface.c
+ */
+
+#ifndef OS_INTERFACE_H
+#define OS_INTERFACE_H
+
+/******************* Operating System Interface Routines *******************\
+* *
+* Operating system wrapper functions used to abstract the OS. *
+* *
+\***************************************************************************/
+
+#include <nvtypes.h>
+#include <nvstatus.h>
+#include "nv_stdarg.h"
+#include <nv-kernel-interface-api.h>
+#include <os/nv_memory_type.h>
+#include <os/nv_memory_area.h>
+#include <nv-caps.h>
+
+#include "rs_access.h"
+
+
+
+typedef struct
+{
+ NvU32 os_major_version;
+ NvU32 os_minor_version;
+ NvU32 os_build_number;
+ const char * os_build_version_str;
+ const char * os_build_date_plus_str;
+}os_version_info;
+
+/* Each OS defines its own version of this opaque type */
+struct os_work_queue;
+
+/* Each OS defines its own version of this opaque type */
+typedef struct os_wait_queue os_wait_queue;
+
+/* Flags needed by os_get_current_proccess_flags */
+#define OS_CURRENT_PROCESS_FLAG_NONE 0x0
+#define OS_CURRENT_PROCESS_FLAG_KERNEL_THREAD 0x1
+#define OS_CURRENT_PROCESS_FLAG_EXITING 0x2
+
+/*
+ * ---------------------------------------------------------------------------
+ *
+ * Function prototypes for OS interface.
+ *
+ * ---------------------------------------------------------------------------
+ */
+
+NV_STATUS NV_API_CALL os_alloc_mem (void **, NvU64);
+void NV_API_CALL os_free_mem (void *);
+NV_STATUS NV_API_CALL os_get_system_time (NvU32 *, NvU32 *);
+NvU64 NV_API_CALL os_get_monotonic_time_ns (void);
+NvU64 NV_API_CALL os_get_monotonic_time_ns_hr (void);
+NvU64 NV_API_CALL os_get_monotonic_tick_resolution_ns (void);
+NV_STATUS NV_API_CALL os_delay (NvU32);
+NV_STATUS NV_API_CALL os_delay_us (NvU32);
+NvU64 NV_API_CALL os_get_cpu_frequency (void);
+NvU32 NV_API_CALL os_get_current_process (void);
+void NV_API_CALL os_get_current_process_name (char *, NvU32);
+NV_STATUS NV_API_CALL os_get_current_thread (NvU64 *);
+char* NV_API_CALL os_string_copy (char *, const char *);
+NvU32 NV_API_CALL os_string_length (const char *);
+NvU32 NV_API_CALL os_strtoul (const char *, char **, NvU32);
+NvS32 NV_API_CALL os_string_compare (const char *, const char *);
+NvS32 NV_API_CALL os_snprintf (char *, NvU32, const char *, ...);
+NvS32 NV_API_CALL os_vsnprintf (char *, NvU32, const char *, va_list);
+void NV_API_CALL os_log_error (const char *, va_list);
+void* NV_API_CALL os_mem_copy (void *, const void *, NvU32);
+NV_STATUS NV_API_CALL os_memcpy_from_user (void *, const void *, NvU32);
+NV_STATUS NV_API_CALL os_memcpy_to_user (void *, const void *, NvU32);
+void* NV_API_CALL os_mem_set (void *, NvU8, NvU32);
+NvS32 NV_API_CALL os_mem_cmp (const NvU8 *, const NvU8 *, NvU32);
+void* NV_API_CALL os_pci_init_handle (NvU32, NvU8, NvU8, NvU8, NvU16 *, NvU16 *);
+NV_STATUS NV_API_CALL os_pci_read_byte (void *, NvU32, NvU8 *);
+NV_STATUS NV_API_CALL os_pci_read_word (void *, NvU32, NvU16 *);
+NV_STATUS NV_API_CALL os_pci_read_dword (void *, NvU32, NvU32 *);
+NV_STATUS NV_API_CALL os_pci_write_byte (void *, NvU32, NvU8);
+NV_STATUS NV_API_CALL os_pci_write_word (void *, NvU32, NvU16);
+NV_STATUS NV_API_CALL os_pci_write_dword (void *, NvU32, NvU32);
+NvBool NV_API_CALL os_pci_remove_supported (void);
+void NV_API_CALL os_pci_remove (void *);
+void* NV_API_CALL os_map_kernel_space (NvU64, NvU64, NvU32);
+void NV_API_CALL os_unmap_kernel_space (void *, NvU64);
+NV_STATUS NV_API_CALL os_flush_cpu_cache_all (void);
+NV_STATUS NV_API_CALL os_flush_user_cache (void);
+void NV_API_CALL os_flush_cpu_write_combine_buffer(void);
+NvU8 NV_API_CALL os_io_read_byte (NvU32);
+NvU16 NV_API_CALL os_io_read_word (NvU32);
+NvU32 NV_API_CALL os_io_read_dword (NvU32);
+void NV_API_CALL os_io_write_byte (NvU32, NvU8);
+void NV_API_CALL os_io_write_word (NvU32, NvU16);
+void NV_API_CALL os_io_write_dword (NvU32, NvU32);
+NvBool NV_API_CALL os_is_administrator (void);
+NvBool NV_API_CALL os_check_access (RsAccessRight accessRight);
+void NV_API_CALL os_dbg_init (void);
+void NV_API_CALL os_dbg_breakpoint (void);
+void NV_API_CALL os_dbg_set_level (NvU32);
+NvU32 NV_API_CALL os_get_cpu_count (void);
+NvU32 NV_API_CALL os_get_cpu_number (void);
+void NV_API_CALL os_disable_console_access (void);
+void NV_API_CALL os_enable_console_access (void);
+NV_STATUS NV_API_CALL os_registry_init (void);
+NvU64 NV_API_CALL os_get_max_user_va (void);
+NV_STATUS NV_API_CALL os_schedule (void);
+NV_STATUS NV_API_CALL os_alloc_spinlock (void **);
+void NV_API_CALL os_free_spinlock (void *);
+NvU64 NV_API_CALL os_acquire_spinlock (void *);
+void NV_API_CALL os_release_spinlock (void *, NvU64);
+NV_STATUS NV_API_CALL os_queue_work_item (struct os_work_queue *, void *);
+NV_STATUS NV_API_CALL os_flush_work_queue (struct os_work_queue *, NvBool);
+NvBool NV_API_CALL os_is_queue_flush_ongoing (struct os_work_queue *);
+NV_STATUS NV_API_CALL os_alloc_mutex (void **);
+void NV_API_CALL os_free_mutex (void *);
+NV_STATUS NV_API_CALL os_acquire_mutex (void *);
+NV_STATUS NV_API_CALL os_cond_acquire_mutex (void *);
+void NV_API_CALL os_release_mutex (void *);
+void* NV_API_CALL os_alloc_semaphore (NvU32);
+void NV_API_CALL os_free_semaphore (void *);
+NV_STATUS NV_API_CALL os_acquire_semaphore (void *);
+NV_STATUS NV_API_CALL os_cond_acquire_semaphore (void *);
+NV_STATUS NV_API_CALL os_release_semaphore (void *);
+void* NV_API_CALL os_alloc_rwlock (void);
+void NV_API_CALL os_free_rwlock (void *);
+NV_STATUS NV_API_CALL os_acquire_rwlock_read (void *);
+NV_STATUS NV_API_CALL os_acquire_rwlock_write (void *);
+NV_STATUS NV_API_CALL os_cond_acquire_rwlock_read (void *);
+NV_STATUS NV_API_CALL os_cond_acquire_rwlock_write (void *);
+void NV_API_CALL os_release_rwlock_read (void *);
+void NV_API_CALL os_release_rwlock_write (void *);
+NvBool NV_API_CALL os_semaphore_may_sleep (void);
+NV_STATUS NV_API_CALL os_get_version_info (os_version_info*);
+NV_STATUS NV_API_CALL os_get_is_openrm (NvBool *);
+NvBool NV_API_CALL os_is_bif_reset_supported (void *);
+NvBool NV_API_CALL os_is_isr (void);
+void NV_API_CALL os_dump_stack (void);
+NvBool NV_API_CALL os_is_efi_enabled (void);
+NvBool NV_API_CALL os_is_xen_dom0 (void);
+NvBool NV_API_CALL os_is_vgx_hyper (void);
+NV_STATUS NV_API_CALL os_inject_vgx_msi (NvU16, NvU64, NvU32);
+NvBool NV_API_CALL os_is_grid_supported (void);
+NvU32 NV_API_CALL os_get_grid_csp_support (void);
+void NV_API_CALL os_bug_check (NvU32, const char *);
+NV_STATUS NV_API_CALL os_lock_user_pages (void *, NvU64, void **, NvU32);
+NV_STATUS NV_API_CALL os_lookup_user_io_memory (void *, NvU64, NvU64 **);
+NV_STATUS NV_API_CALL os_unlock_user_pages (NvU64, void *, NvU32);
+NV_STATUS NV_API_CALL os_match_mmap_offset (void *, NvU64, NvU64 *);
+NV_STATUS NV_API_CALL os_get_euid (NvU32 *);
+NV_STATUS NV_API_CALL os_get_smbios_header (NvU64 *pSmbsAddr);
+NV_STATUS NV_API_CALL os_get_acpi_rsdp_from_uefi (NvU32 *);
+void NV_API_CALL os_add_record_for_crashLog (void *, NvU32);
+void NV_API_CALL os_delete_record_for_crashLog (void *);
+NV_STATUS NV_API_CALL os_call_vgpu_vfio (void *, NvU32);
+NV_STATUS NV_API_CALL os_device_vm_present (void);
+NV_STATUS NV_API_CALL os_numa_memblock_size (NvU64 *);
+NV_STATUS NV_API_CALL os_alloc_pages_node (NvS32, NvU32, NvU32, NvU64 *);
+NV_STATUS NV_API_CALL os_get_page (NvU64 address);
+NV_STATUS NV_API_CALL os_put_page (NvU64 address);
+NvU32 NV_API_CALL os_get_page_refcount (NvU64 address);
+NvU32 NV_API_CALL os_count_tail_pages (NvU64 address);
+void NV_API_CALL os_free_pages_phys (NvU64, NvU32);
+NV_STATUS NV_API_CALL os_open_temporary_file (void **);
+void NV_API_CALL os_close_file (void *);
+NV_STATUS NV_API_CALL os_write_file (void *, NvU8 *, NvU64, NvU64);
+NV_STATUS NV_API_CALL os_read_file (void *, NvU8 *, NvU64, NvU64);
+NV_STATUS NV_API_CALL os_open_readonly_file (const char *, void **);
+NV_STATUS NV_API_CALL os_open_and_read_file (const char *, NvU8 *, NvU64);
+NvBool NV_API_CALL os_is_nvswitch_present (void);
+NV_STATUS NV_API_CALL os_get_random_bytes (NvU8 *, NvU16);
+NvU32 NV_API_CALL os_get_current_process_flags (void);
+NV_STATUS NV_API_CALL os_alloc_wait_queue (os_wait_queue **);
+void NV_API_CALL os_free_wait_queue (os_wait_queue *);
+void NV_API_CALL os_wait_uninterruptible (os_wait_queue *);
+void NV_API_CALL os_wait_interruptible (os_wait_queue *);
+void NV_API_CALL os_wake_up (os_wait_queue *);
+nv_cap_t* NV_API_CALL os_nv_cap_init (const char *);
+nv_cap_t* NV_API_CALL os_nv_cap_create_dir_entry (nv_cap_t *, const char *, int);
+nv_cap_t* NV_API_CALL os_nv_cap_create_file_entry (nv_cap_t *, const char *, int);
+void NV_API_CALL os_nv_cap_destroy_entry (nv_cap_t *);
+int NV_API_CALL os_nv_cap_validate_and_dup_fd (const nv_cap_t *, int);
+void NV_API_CALL os_nv_cap_close_fd (int);
+NvS32 NV_API_CALL os_imex_channel_get (NvU64);
+NvS32 NV_API_CALL os_imex_channel_count (void);
+NV_STATUS NV_API_CALL os_tegra_igpu_perf_boost (void *, NvBool, NvU32);
+
+NV_STATUS NV_API_CALL os_get_tegra_platform (NvU32 *);
+enum os_pci_req_atomics_type {
+ OS_INTF_PCIE_REQ_ATOMICS_32BIT,
+ OS_INTF_PCIE_REQ_ATOMICS_64BIT,
+ OS_INTF_PCIE_REQ_ATOMICS_128BIT
+};
+NV_STATUS NV_API_CALL os_enable_pci_req_atomics (void *, enum os_pci_req_atomics_type);
+void NV_API_CALL os_pci_trigger_flr(void *handle);
+NV_STATUS NV_API_CALL os_get_numa_node_memory_usage (NvS32, NvU64 *, NvU64 *);
+NV_STATUS NV_API_CALL os_numa_add_gpu_memory (void *, NvU64, NvU64, NvU32 *);
+NV_STATUS NV_API_CALL os_numa_remove_gpu_memory (void *, NvU64, NvU64, NvU32);
+NV_STATUS NV_API_CALL os_offline_page_at_address(NvU64 address);
+void* NV_API_CALL os_get_pid_info(void);
+void NV_API_CALL os_put_pid_info(void *pid_info);
+NV_STATUS NV_API_CALL os_find_ns_pid(void *pid_info, NvU32 *ns_pid);
+NvBool NV_API_CALL os_is_init_ns(void);
+NV_STATUS NV_API_CALL os_iommu_sva_bind(void *arg, void **handle, NvU32 *pasid);
+void NV_API_CALL os_iommu_sva_unbind(void *handle);
+NvBool NV_API_CALL os_supports_kernel_suspend_notifiers(void);
+
+extern NvU64 os_page_size;
+extern NvU64 os_max_page_size;
+extern NvU64 os_page_mask;
+extern NvU8 os_page_shift;
+extern NvBool os_cc_enabled;
+extern NvBool os_cc_sev_snp_enabled;
+extern NvBool os_cc_sme_enabled;
+extern NvBool os_cc_snp_vtom_enabled;
+extern NvBool os_cc_tdx_enabled;
+extern NvBool os_dma_buf_enabled;
+extern NvBool os_imex_channel_is_supported;
+
+/*
+ * ---------------------------------------------------------------------------
+ *
+ * Debug macros.
+ *
+ * ---------------------------------------------------------------------------
+ */
+
+#define NV_DBG_INFO 0x0
+#define NV_DBG_SETUP 0x1
+#define NV_DBG_USERERRORS 0x2
+#define NV_DBG_WARNINGS 0x3
+#define NV_DBG_ERRORS 0x4
+
+
+void NV_API_CALL out_string(const char *str);
+int NV_API_CALL nv_printf(NvU32 debuglevel, const char *printf_format, ...);
+
+#define NV_DEV_PRINTF(debuglevel, nv, format, ... ) \
+ nv_printf(debuglevel, "NVRM: GPU " NV_PCI_DEV_FMT ": " format, NV_PCI_DEV_FMT_ARGS(nv), ## __VA_ARGS__)
+
+#define NV_DEV_PRINTF_STATUS(debuglevel, nv, status, format, ... ) \
+ nv_printf(debuglevel, "NVRM: GPU " NV_PCI_DEV_FMT ": " format " (0x%x)\n", NV_PCI_DEV_FMT_ARGS(nv), ## __VA_ARGS__, status)
+
+/*
+ * Fields for os_lock_user_pages flags parameter
+ */
+#define NV_LOCK_USER_PAGES_FLAGS_WRITE 0:0
+#define NV_LOCK_USER_PAGES_FLAGS_WRITE_NO 0x00000000
+#define NV_LOCK_USER_PAGES_FLAGS_WRITE_YES 0x00000001
+
+// NV OS Tegra platform type defines
+#define NV_OS_TEGRA_PLATFORM_SIM 0
+#define NV_OS_TEGRA_PLATFORM_FPGA 1
+#define NV_OS_TEGRA_PLATFORM_SILICON 2
+
+/*
+ * Plumbing through cgroup dmem api
+ */
+#define OS_CGROUP_IMPL_NONE 0
+#define OS_CGROUP_IMPL_MISC 1
+#define OS_CGROUP_IMPL_DMEM 2
+NvU32 NV_API_CALL os_cgroup_implementation(void);
+void* NV_API_CALL os_dmem_cgroup_register_region(NvU64 size, const char *name);
+void NV_API_CALL os_dmem_cgroup_unregister_region(void *region);
+NV_STATUS NV_API_CALL os_dmem_cgroup_try_charge(void *region, NvU64 size, void **ret_pool, void **ret_limit_pool);
+void NV_API_CALL os_dmem_cgroup_uncharge(void *pool, NvU64 size);
+
+void* NV_API_CALL os_cgroup_for_pid(int pid, void *pidInfo);
+void* NV_API_CALL os_cgroup_get_from_fd(NvU32 fd);
+void NV_API_CALL os_cgroup_put(void *cgroup);
+
+#endif /* OS_INTERFACE_H */