| 1 | /** @file
|
|---|
| 2 | * IPRT - Memory Objects (Ring-0).
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2010 Oracle Corporation
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License (GPL) as published by the Free Software
|
|---|
| 12 | * Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 13 | * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 14 | * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * The contents of this file may alternatively be used under the terms
|
|---|
| 17 | * of the Common Development and Distribution License Version 1.0
|
|---|
| 18 | * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
|
|---|
| 19 | * VirtualBox OSE distribution, in which case the provisions of the
|
|---|
| 20 | * CDDL are applicable instead of those of the GPL.
|
|---|
| 21 | *
|
|---|
| 22 | * You may elect to license modified versions of this file under the
|
|---|
| 23 | * terms and conditions of either the GPL or the CDDL or both.
|
|---|
| 24 | */
|
|---|
| 25 |
|
|---|
| 26 | #ifndef ___iprt_memobj_h
|
|---|
| 27 | #define ___iprt_memobj_h
|
|---|
| 28 |
|
|---|
| 29 | #include <iprt/cdefs.h>
|
|---|
| 30 | #include <iprt/types.h>
|
|---|
| 31 |
|
|---|
| 32 | RT_C_DECLS_BEGIN
|
|---|
| 33 |
|
|---|
| 34 | /** @defgroup grp_rt_memobj RTMemObj - Memory Object Manipulation (Ring-0)
|
|---|
| 35 | * @ingroup grp_rt
|
|---|
| 36 | * @{
|
|---|
| 37 | */
|
|---|
| 38 |
|
|---|
| 39 | /** @def RTMEM_TAG
|
|---|
| 40 | * The default allocation tag used by the RTMem allocation APIs.
|
|---|
| 41 | *
|
|---|
| 42 | * When not defined before the inclusion of iprt/memobj.h or iprt/mem.h, this
|
|---|
| 43 | * will default to the pointer to the current file name. The memory API will
|
|---|
| 44 | * make of use of this as pointer to a volatile but read-only string.
|
|---|
| 45 | */
|
|---|
| 46 | #ifndef RTMEM_TAG
|
|---|
| 47 | # define RTMEM_TAG (__FILE__)
|
|---|
| 48 | #endif
|
|---|
| 49 |
|
|---|
| 50 | #ifdef IN_RING0
|
|---|
| 51 |
|
|---|
| 52 | /**
|
|---|
| 53 | * Checks if this is mapping or not.
|
|---|
| 54 | *
|
|---|
| 55 | * @returns true if it's a mapping, otherwise false.
|
|---|
| 56 | * @param MemObj The ring-0 memory object handle.
|
|---|
| 57 | */
|
|---|
| 58 | RTR0DECL(bool) RTR0MemObjIsMapping(RTR0MEMOBJ MemObj);
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Gets the address of a ring-0 memory object.
|
|---|
| 62 | *
|
|---|
| 63 | * @returns The address of the memory object.
|
|---|
| 64 | * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
|
|---|
| 65 | * @param MemObj The ring-0 memory object handle.
|
|---|
| 66 | */
|
|---|
| 67 | RTR0DECL(void *) RTR0MemObjAddress(RTR0MEMOBJ MemObj);
|
|---|
| 68 |
|
|---|
| 69 | /**
|
|---|
| 70 | * Gets the ring-3 address of a ring-0 memory object.
|
|---|
| 71 | *
|
|---|
| 72 | * This only applies to ring-0 memory object with ring-3 mappings of some kind, i.e.
|
|---|
| 73 | * locked user memory, reserved user address space and user mappings. This API should
|
|---|
| 74 | * not be used on any other objects.
|
|---|
| 75 | *
|
|---|
| 76 | * @returns The address of the memory object.
|
|---|
| 77 | * @returns NIL_RTR3PTR if the handle is invalid or if it's not an object with a ring-3 mapping.
|
|---|
| 78 | * Strict builds will assert in both cases.
|
|---|
| 79 | * @param MemObj The ring-0 memory object handle.
|
|---|
| 80 | */
|
|---|
| 81 | RTR0DECL(RTR3PTR) RTR0MemObjAddressR3(RTR0MEMOBJ MemObj);
|
|---|
| 82 |
|
|---|
| 83 | /**
|
|---|
| 84 | * Gets the size of a ring-0 memory object.
|
|---|
| 85 | *
|
|---|
| 86 | * @returns The address of the memory object.
|
|---|
| 87 | * @returns NULL if the handle is invalid (asserts in strict builds) or if there isn't any mapping.
|
|---|
| 88 | * @param MemObj The ring-0 memory object handle.
|
|---|
| 89 | */
|
|---|
| 90 | RTR0DECL(size_t) RTR0MemObjSize(RTR0MEMOBJ MemObj);
|
|---|
| 91 |
|
|---|
| 92 | /**
|
|---|
| 93 | * Get the physical address of an page in the memory object.
|
|---|
| 94 | *
|
|---|
| 95 | * @returns The physical address.
|
|---|
| 96 | * @returns NIL_RTHCPHYS if the object doesn't contain fixed physical pages.
|
|---|
| 97 | * @returns NIL_RTHCPHYS if the iPage is out of range.
|
|---|
| 98 | * @returns NIL_RTHCPHYS if the object handle isn't valid.
|
|---|
| 99 | * @param MemObj The ring-0 memory object handle.
|
|---|
| 100 | * @param iPage The page number within the object.
|
|---|
| 101 | */
|
|---|
| 102 | RTR0DECL(RTHCPHYS) RTR0MemObjGetPagePhysAddr(RTR0MEMOBJ MemObj, size_t iPage);
|
|---|
| 103 |
|
|---|
| 104 | /**
|
|---|
| 105 | * Frees a ring-0 memory object.
|
|---|
| 106 | *
|
|---|
| 107 | * @returns IPRT status code.
|
|---|
| 108 | * @retval VERR_INVALID_HANDLE if
|
|---|
| 109 | * @param MemObj The ring-0 memory object to be freed. NULL is accepted.
|
|---|
| 110 | * @param fFreeMappings Whether or not to free mappings of the object.
|
|---|
| 111 | */
|
|---|
| 112 | RTR0DECL(int) RTR0MemObjFree(RTR0MEMOBJ MemObj, bool fFreeMappings);
|
|---|
| 113 |
|
|---|
| 114 | /**
|
|---|
| 115 | * Allocates page aligned virtual kernel memory (default tag).
|
|---|
| 116 | *
|
|---|
| 117 | * The memory is taken from a non paged (= fixed physical memory backing) pool.
|
|---|
| 118 | *
|
|---|
| 119 | * @returns IPRT status code.
|
|---|
| 120 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 121 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 122 | * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
|
|---|
| 123 | */
|
|---|
| 124 | #define RTR0MemObjAllocPage(pMemObj, cb, fExecutable) \
|
|---|
| 125 | RTR0MemObjAllocPageTag((pMemObj), (cb), (fExecutable), RTMEM_TAG)
|
|---|
| 126 |
|
|---|
| 127 | /**
|
|---|
| 128 | * Allocates page aligned virtual kernel memory (custom tag).
|
|---|
| 129 | *
|
|---|
| 130 | * The memory is taken from a non paged (= fixed physical memory backing) pool.
|
|---|
| 131 | *
|
|---|
| 132 | * @returns IPRT status code.
|
|---|
| 133 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 134 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 135 | * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
|
|---|
| 136 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 137 | */
|
|---|
| 138 | RTR0DECL(int) RTR0MemObjAllocPageTag(PRTR0MEMOBJ pMemObj, size_t cb, bool fExecutable, const char *pszTag);
|
|---|
| 139 |
|
|---|
| 140 | /**
|
|---|
| 141 | * Allocates page aligned virtual kernel memory with physical backing below 4GB
|
|---|
| 142 | * (default tag).
|
|---|
| 143 | *
|
|---|
| 144 | * The physical memory backing the allocation is fixed.
|
|---|
| 145 | *
|
|---|
| 146 | * @returns IPRT status code.
|
|---|
| 147 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 148 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 149 | * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
|
|---|
| 150 | */
|
|---|
| 151 | #define RTR0MemObjAllocLow(pMemObj, cb, fExecutable) \
|
|---|
| 152 | RTR0MemObjAllocLowTag((pMemObj), (cb), (fExecutable), RTMEM_TAG)
|
|---|
| 153 |
|
|---|
| 154 | /**
|
|---|
| 155 | * Allocates page aligned virtual kernel memory with physical backing below 4GB
|
|---|
| 156 | * (custom tag).
|
|---|
| 157 | *
|
|---|
| 158 | * The physical memory backing the allocation is fixed.
|
|---|
| 159 | *
|
|---|
| 160 | * @returns IPRT status code.
|
|---|
| 161 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 162 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 163 | * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
|
|---|
| 164 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 165 | */
|
|---|
| 166 | RTR0DECL(int) RTR0MemObjAllocLowTag(PRTR0MEMOBJ pMemObj, size_t cb, bool fExecutable, const char *pszTag);
|
|---|
| 167 |
|
|---|
| 168 | /**
|
|---|
| 169 | * Allocates page aligned virtual kernel memory with contiguous physical backing
|
|---|
| 170 | * below 4GB (default tag).
|
|---|
| 171 | *
|
|---|
| 172 | * The physical memory backing the allocation is fixed.
|
|---|
| 173 | *
|
|---|
| 174 | * @returns IPRT status code.
|
|---|
| 175 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 176 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 177 | * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
|
|---|
| 178 | */
|
|---|
| 179 | #define RTR0MemObjAllocCont(pMemObj, cb, fExecutable) \
|
|---|
| 180 | RTR0MemObjAllocContTag((pMemObj), (cb), (fExecutable), RTMEM_TAG)
|
|---|
| 181 |
|
|---|
| 182 | /**
|
|---|
| 183 | * Allocates page aligned virtual kernel memory with contiguous physical backing
|
|---|
| 184 | * below 4GB (custom tag).
|
|---|
| 185 | *
|
|---|
| 186 | * The physical memory backing the allocation is fixed.
|
|---|
| 187 | *
|
|---|
| 188 | * @returns IPRT status code.
|
|---|
| 189 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 190 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 191 | * @param fExecutable Flag indicating whether it should be permitted to executed code in the memory object.
|
|---|
| 192 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 193 | */
|
|---|
| 194 | RTR0DECL(int) RTR0MemObjAllocContTag(PRTR0MEMOBJ pMemObj, size_t cb, bool fExecutable, const char *pszTag);
|
|---|
| 195 |
|
|---|
| 196 | /**
|
|---|
| 197 | * Locks a range of user virtual memory (default tag).
|
|---|
| 198 | *
|
|---|
| 199 | * @returns IPRT status code.
|
|---|
| 200 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 201 | * @param R3Ptr User virtual address. This is rounded down to a page
|
|---|
| 202 | * boundary.
|
|---|
| 203 | * @param cb Number of bytes to lock. This is rounded up to
|
|---|
| 204 | * nearest page boundary.
|
|---|
| 205 | * @param fAccess The desired access, a combination of RTMEM_PROT_READ
|
|---|
| 206 | * and RTMEM_PROT_WRITE.
|
|---|
| 207 | * @param R0Process The process to lock pages in. NIL_R0PROCESS is an
|
|---|
| 208 | * alias for the current one.
|
|---|
| 209 | *
|
|---|
| 210 | * @remarks RTR0MemGetAddressR3() and RTR0MemGetAddress() will return therounded
|
|---|
| 211 | * down address.
|
|---|
| 212 | *
|
|---|
| 213 | * @remarks Linux: This API requires that the memory begin locked is in a memory
|
|---|
| 214 | * mapping that is not required in any forked off child process. This
|
|---|
| 215 | * is not intented as permanent restriction, feel free to help out
|
|---|
| 216 | * lifting it.
|
|---|
| 217 | */
|
|---|
| 218 | #define RTR0MemObjLockUser(pMemObj, R3Ptr, cb, fAccess, R0Process) \
|
|---|
| 219 | RTR0MemObjLockUserTag((pMemObj), (R3Ptr), (cb), (fAccess), (R0Process), RTMEM_TAG)
|
|---|
| 220 |
|
|---|
| 221 | /**
|
|---|
| 222 | * Locks a range of user virtual memory (custom tag).
|
|---|
| 223 | *
|
|---|
| 224 | * @returns IPRT status code.
|
|---|
| 225 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 226 | * @param R3Ptr User virtual address. This is rounded down to a page
|
|---|
| 227 | * boundary.
|
|---|
| 228 | * @param cb Number of bytes to lock. This is rounded up to
|
|---|
| 229 | * nearest page boundary.
|
|---|
| 230 | * @param fAccess The desired access, a combination of RTMEM_PROT_READ
|
|---|
| 231 | * and RTMEM_PROT_WRITE.
|
|---|
| 232 | * @param R0Process The process to lock pages in. NIL_R0PROCESS is an
|
|---|
| 233 | * alias for the current one.
|
|---|
| 234 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 235 | *
|
|---|
| 236 | * @remarks RTR0MemGetAddressR3() and RTR0MemGetAddress() will return therounded
|
|---|
| 237 | * down address.
|
|---|
| 238 | *
|
|---|
| 239 | * @remarks Linux: This API requires that the memory begin locked is in a memory
|
|---|
| 240 | * mapping that is not required in any forked off child process. This
|
|---|
| 241 | * is not intented as permanent restriction, feel free to help out
|
|---|
| 242 | * lifting it.
|
|---|
| 243 | */
|
|---|
| 244 | RTR0DECL(int) RTR0MemObjLockUserTag(PRTR0MEMOBJ pMemObj, RTR3PTR R3Ptr, size_t cb, uint32_t fAccess,
|
|---|
| 245 | RTR0PROCESS R0Process, const char *pszTag);
|
|---|
| 246 |
|
|---|
| 247 | /**
|
|---|
| 248 | * Locks a range of kernel virtual memory (default tag).
|
|---|
| 249 | *
|
|---|
| 250 | * @returns IPRT status code.
|
|---|
| 251 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 252 | * @param pv Kernel virtual address. This is rounded down to a page boundary.
|
|---|
| 253 | * @param cb Number of bytes to lock. This is rounded up to nearest page boundary.
|
|---|
| 254 | * @param fAccess The desired access, a combination of RTMEM_PROT_READ
|
|---|
| 255 | * and RTMEM_PROT_WRITE.
|
|---|
| 256 | *
|
|---|
| 257 | * @remark RTR0MemGetAddress() will return the rounded down address.
|
|---|
| 258 | */
|
|---|
| 259 | #define RTR0MemObjLockKernel(pMemObj, pv, cb, fAccess) \
|
|---|
| 260 | RTR0MemObjLockKernelTag((pMemObj), (pv), (cb), (fAccess), RTMEM_TAG)
|
|---|
| 261 |
|
|---|
| 262 | /**
|
|---|
| 263 | * Locks a range of kernel virtual memory (custom tag).
|
|---|
| 264 | *
|
|---|
| 265 | * @returns IPRT status code.
|
|---|
| 266 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 267 | * @param pv Kernel virtual address. This is rounded down to a page boundary.
|
|---|
| 268 | * @param cb Number of bytes to lock. This is rounded up to nearest page boundary.
|
|---|
| 269 | * @param fAccess The desired access, a combination of RTMEM_PROT_READ
|
|---|
| 270 | * and RTMEM_PROT_WRITE.
|
|---|
| 271 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 272 | *
|
|---|
| 273 | * @remark RTR0MemGetAddress() will return the rounded down address.
|
|---|
| 274 | */
|
|---|
| 275 | RTR0DECL(int) RTR0MemObjLockKernelTag(PRTR0MEMOBJ pMemObj, void *pv, size_t cb, uint32_t fAccess, const char *pszTag);
|
|---|
| 276 |
|
|---|
| 277 | /**
|
|---|
| 278 | * Allocates contiguous page aligned physical memory without (necessarily) any
|
|---|
| 279 | * kernel mapping (default tag).
|
|---|
| 280 | *
|
|---|
| 281 | * @returns IPRT status code.
|
|---|
| 282 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 283 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 284 | * @param PhysHighest The highest permitable address (inclusive).
|
|---|
| 285 | * Pass NIL_RTHCPHYS if any address is acceptable.
|
|---|
| 286 | */
|
|---|
| 287 | #define RTR0MemObjAllocPhys(pMemObj, cb, PhysHighest) \
|
|---|
| 288 | RTR0MemObjAllocPhysTag((pMemObj), (cb), (PhysHighest), RTMEM_TAG)
|
|---|
| 289 |
|
|---|
| 290 | /**
|
|---|
| 291 | * Allocates contiguous page aligned physical memory without (necessarily) any
|
|---|
| 292 | * kernel mapping (custom tag).
|
|---|
| 293 | *
|
|---|
| 294 | * @returns IPRT status code.
|
|---|
| 295 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 296 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 297 | * @param PhysHighest The highest permitable address (inclusive).
|
|---|
| 298 | * Pass NIL_RTHCPHYS if any address is acceptable.
|
|---|
| 299 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 300 | */
|
|---|
| 301 | RTR0DECL(int) RTR0MemObjAllocPhysTag(PRTR0MEMOBJ pMemObj, size_t cb, RTHCPHYS PhysHighest, const char *pszTag);
|
|---|
| 302 |
|
|---|
| 303 | /**
|
|---|
| 304 | * Allocates contiguous physical memory without (necessarily) any kernel mapping
|
|---|
| 305 | * (default tag).
|
|---|
| 306 | *
|
|---|
| 307 | * @returns IPRT status code.
|
|---|
| 308 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 309 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 310 | * @param PhysHighest The highest permitable address (inclusive).
|
|---|
| 311 | * Pass NIL_RTHCPHYS if any address is acceptable.
|
|---|
| 312 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 313 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M, _4M and _1G.
|
|---|
| 314 | */
|
|---|
| 315 | #define RTR0MemObjAllocPhysEx(pMemObj, cb, PhysHighest, uAlignment) \
|
|---|
| 316 | RTR0MemObjAllocPhysExTag((pMemObj), (cb), (PhysHighest), (uAlignment), RTMEM_TAG)
|
|---|
| 317 |
|
|---|
| 318 | /**
|
|---|
| 319 | * Allocates contiguous physical memory without (necessarily) any kernel mapping
|
|---|
| 320 | * (custom tag).
|
|---|
| 321 | *
|
|---|
| 322 | * @returns IPRT status code.
|
|---|
| 323 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 324 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 325 | * @param PhysHighest The highest permitable address (inclusive).
|
|---|
| 326 | * Pass NIL_RTHCPHYS if any address is acceptable.
|
|---|
| 327 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 328 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M, _4M and _1G.
|
|---|
| 329 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 330 | */
|
|---|
| 331 | RTR0DECL(int) RTR0MemObjAllocPhysExTag(PRTR0MEMOBJ pMemObj, size_t cb, RTHCPHYS PhysHighest, size_t uAlignment, const char *pszTag);
|
|---|
| 332 |
|
|---|
| 333 | /**
|
|---|
| 334 | * Allocates non-contiguous page aligned physical memory without (necessarily)
|
|---|
| 335 | * any kernel mapping (default tag).
|
|---|
| 336 | *
|
|---|
| 337 | * This API is for allocating huge amounts of pages and will return
|
|---|
| 338 | * VERR_NOT_SUPPORTED if this cannot be implemented in a satisfactory
|
|---|
| 339 | * manner.
|
|---|
| 340 | *
|
|---|
| 341 | * @returns IPRT status code.
|
|---|
| 342 | * @retval VERR_NOT_SUPPORTED if it's not possible to allocated unmapped
|
|---|
| 343 | * physical memory on this platform. The caller should expect
|
|---|
| 344 | * this error and have a fallback strategy for it.
|
|---|
| 345 | *
|
|---|
| 346 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 347 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 348 | * @param PhysHighest The highest permitable address (inclusive).
|
|---|
| 349 | * Pass NIL_RTHCPHYS if any address is acceptable.
|
|---|
| 350 | */
|
|---|
| 351 | #define RTR0MemObjAllocPhysNC(pMemObj, cb, PhysHighest) \
|
|---|
| 352 | RTR0MemObjAllocPhysNCTag((pMemObj), (cb), (PhysHighest), RTMEM_TAG)
|
|---|
| 353 |
|
|---|
| 354 | /**
|
|---|
| 355 | * Allocates non-contiguous page aligned physical memory without (necessarily)
|
|---|
| 356 | * any kernel mapping (custom tag).
|
|---|
| 357 | *
|
|---|
| 358 | * This API is for allocating huge amounts of pages and will return
|
|---|
| 359 | * VERR_NOT_SUPPORTED if this cannot be implemented in a satisfactory
|
|---|
| 360 | * manner.
|
|---|
| 361 | *
|
|---|
| 362 | * @returns IPRT status code.
|
|---|
| 363 | * @retval VERR_NOT_SUPPORTED if it's not possible to allocated unmapped
|
|---|
| 364 | * physical memory on this platform. The caller should expect
|
|---|
| 365 | * this error and have a fallback strategy for it.
|
|---|
| 366 | *
|
|---|
| 367 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 368 | * @param cb Number of bytes to allocate. This is rounded up to nearest page.
|
|---|
| 369 | * @param PhysHighest The highest permitable address (inclusive).
|
|---|
| 370 | * Pass NIL_RTHCPHYS if any address is acceptable.
|
|---|
| 371 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 372 | */
|
|---|
| 373 | RTR0DECL(int) RTR0MemObjAllocPhysNCTag(PRTR0MEMOBJ pMemObj, size_t cb, RTHCPHYS PhysHighest, const char *pszTag);
|
|---|
| 374 |
|
|---|
| 375 | /** Memory cache policy for RTR0MemObjEnterPhys.
|
|---|
| 376 | * @{
|
|---|
| 377 | */
|
|---|
| 378 | /** Default caching policy -- don't care. */
|
|---|
| 379 | #define RTMEM_CACHE_POLICY_DONT_CARE UINT32_C(0)
|
|---|
| 380 | /** MMIO caching policy -- uncachable. */
|
|---|
| 381 | #define RTMEM_CACHE_POLICY_MMIO UINT32_C(1)
|
|---|
| 382 | /** @} */
|
|---|
| 383 |
|
|---|
| 384 | /**
|
|---|
| 385 | * Creates a page aligned, contiguous, physical memory object (default tag).
|
|---|
| 386 | *
|
|---|
| 387 | * No physical memory is allocated, we trust you do know what you're doing.
|
|---|
| 388 | *
|
|---|
| 389 | * @returns IPRT status code.
|
|---|
| 390 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 391 | * @param Phys The physical address to start at. This is rounded down to the
|
|---|
| 392 | * nearest page boundary.
|
|---|
| 393 | * @param cb The size of the object in bytes. This is rounded up to nearest page boundary.
|
|---|
| 394 | * @param uCachePolicy One of the RTMEM_CACHE_XXX modes.
|
|---|
| 395 | */
|
|---|
| 396 | #define RTR0MemObjEnterPhys(pMemObj, Phys, cb, uCachePolicy) \
|
|---|
| 397 | RTR0MemObjEnterPhysTag((pMemObj), (Phys), (cb), (uCachePolicy), RTMEM_TAG)
|
|---|
| 398 |
|
|---|
| 399 | /**
|
|---|
| 400 | * Creates a page aligned, contiguous, physical memory object (custom tag).
|
|---|
| 401 | *
|
|---|
| 402 | * No physical memory is allocated, we trust you do know what you're doing.
|
|---|
| 403 | *
|
|---|
| 404 | * @returns IPRT status code.
|
|---|
| 405 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 406 | * @param Phys The physical address to start at. This is rounded down to the
|
|---|
| 407 | * nearest page boundary.
|
|---|
| 408 | * @param cb The size of the object in bytes. This is rounded up to nearest page boundary.
|
|---|
| 409 | * @param uCachePolicy One of the RTMEM_CACHE_XXX modes.
|
|---|
| 410 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 411 | */
|
|---|
| 412 | RTR0DECL(int) RTR0MemObjEnterPhysTag(PRTR0MEMOBJ pMemObj, RTHCPHYS Phys, size_t cb, uint32_t uCachePolicy, const char *pszTag);
|
|---|
| 413 |
|
|---|
| 414 | /**
|
|---|
| 415 | * Reserves kernel virtual address space (default tag).
|
|---|
| 416 | *
|
|---|
| 417 | * If this function fails with VERR_NOT_SUPPORTED, the idea is that you
|
|---|
| 418 | * can use RTR0MemObjEnterPhys() + RTR0MemObjMapKernel() as a fallback if
|
|---|
| 419 | * you have a safe physical address range to make use of...
|
|---|
| 420 | *
|
|---|
| 421 | * @returns IPRT status code.
|
|---|
| 422 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 423 | * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
|
|---|
| 424 | * @param cb The number of bytes to reserve. This is rounded up to nearest page.
|
|---|
| 425 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 426 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 427 | */
|
|---|
| 428 | #define RTR0MemObjReserveKernel(pMemObj, pvFixed, cb, uAlignment) \
|
|---|
| 429 | RTR0MemObjReserveKernelTag((pMemObj), (pvFixed), (cb), (uAlignment), RTMEM_TAG)
|
|---|
| 430 |
|
|---|
| 431 | /**
|
|---|
| 432 | * Reserves kernel virtual address space (custom tag).
|
|---|
| 433 | *
|
|---|
| 434 | * If this function fails with VERR_NOT_SUPPORTED, the idea is that you
|
|---|
| 435 | * can use RTR0MemObjEnterPhys() + RTR0MemObjMapKernel() as a fallback if
|
|---|
| 436 | * you have a safe physical address range to make use of...
|
|---|
| 437 | *
|
|---|
| 438 | * @returns IPRT status code.
|
|---|
| 439 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 440 | * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
|
|---|
| 441 | * @param cb The number of bytes to reserve. This is rounded up to nearest page.
|
|---|
| 442 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 443 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 444 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 445 | */
|
|---|
| 446 | RTR0DECL(int) RTR0MemObjReserveKernelTag(PRTR0MEMOBJ pMemObj, void *pvFixed, size_t cb, size_t uAlignment, const char *pszTag);
|
|---|
| 447 |
|
|---|
| 448 | /**
|
|---|
| 449 | * Reserves user virtual address space in the current process (default tag).
|
|---|
| 450 | *
|
|---|
| 451 | * @returns IPRT status code.
|
|---|
| 452 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 453 | * @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This must match the alignment.
|
|---|
| 454 | * @param cb The number of bytes to reserve. This is rounded up to nearest PAGE_SIZE.
|
|---|
| 455 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 456 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 457 | * @param R0Process The process to reserve the memory in. NIL_R0PROCESS is an alias for the current one.
|
|---|
| 458 | */
|
|---|
| 459 | #define RTR0MemObjReserveUser(pMemObj, R3PtrFixed, cb, uAlignment, R0Process) \
|
|---|
| 460 | RTR0MemObjReserveUserTag((pMemObj), (R3PtrFixed), (cb), (uAlignment), (R0Process), RTMEM_TAG)
|
|---|
| 461 |
|
|---|
| 462 | /**
|
|---|
| 463 | * Reserves user virtual address space in the current process (custom tag).
|
|---|
| 464 | *
|
|---|
| 465 | * @returns IPRT status code.
|
|---|
| 466 | * @param pMemObj Where to store the ring-0 memory object handle.
|
|---|
| 467 | * @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This must match the alignment.
|
|---|
| 468 | * @param cb The number of bytes to reserve. This is rounded up to nearest PAGE_SIZE.
|
|---|
| 469 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 470 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 471 | * @param R0Process The process to reserve the memory in. NIL_R0PROCESS is an alias for the current one.
|
|---|
| 472 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 473 | */
|
|---|
| 474 | RTR0DECL(int) RTR0MemObjReserveUserTag(PRTR0MEMOBJ pMemObj, RTR3PTR R3PtrFixed, size_t cb, size_t uAlignment,
|
|---|
| 475 | RTR0PROCESS R0Process, const char *pszTag);
|
|---|
| 476 |
|
|---|
| 477 | /**
|
|---|
| 478 | * Maps a memory object into kernel virtual address space (default tag).
|
|---|
| 479 | *
|
|---|
| 480 | * This is the same as calling RTR0MemObjMapKernelEx with cbSub and offSub set
|
|---|
| 481 | * to zero.
|
|---|
| 482 | *
|
|---|
| 483 | * @returns IPRT status code.
|
|---|
| 484 | * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
|
|---|
| 485 | * @param MemObjToMap The object to be map.
|
|---|
| 486 | * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
|
|---|
| 487 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 488 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 489 | * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
|
|---|
| 490 | */
|
|---|
| 491 | #define RTR0MemObjMapKernel(pMemObj, MemObjToMap, pvFixed, uAlignment, fProt) \
|
|---|
| 492 | RTR0MemObjMapKernelTag((pMemObj), (MemObjToMap), (pvFixed), (uAlignment), (fProt), RTMEM_TAG)
|
|---|
| 493 |
|
|---|
| 494 | /**
|
|---|
| 495 | * Maps a memory object into kernel virtual address space (custom tag).
|
|---|
| 496 | *
|
|---|
| 497 | * This is the same as calling RTR0MemObjMapKernelEx with cbSub and offSub set
|
|---|
| 498 | * to zero.
|
|---|
| 499 | *
|
|---|
| 500 | * @returns IPRT status code.
|
|---|
| 501 | * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
|
|---|
| 502 | * @param MemObjToMap The object to be map.
|
|---|
| 503 | * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
|
|---|
| 504 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 505 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 506 | * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
|
|---|
| 507 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 508 | */
|
|---|
| 509 | RTR0DECL(int) RTR0MemObjMapKernelTag(PRTR0MEMOBJ pMemObj, RTR0MEMOBJ MemObjToMap, void *pvFixed,
|
|---|
| 510 | size_t uAlignment, unsigned fProt, const char *pszTag);
|
|---|
| 511 |
|
|---|
| 512 | /**
|
|---|
| 513 | * Maps a memory object into kernel virtual address space (default tag).
|
|---|
| 514 | *
|
|---|
| 515 | * The ability to map subsections of the object into kernel space is currently
|
|---|
| 516 | * not implemented on all platforms. All/Most of platforms supports mapping the
|
|---|
| 517 | * whole object into kernel space.
|
|---|
| 518 | *
|
|---|
| 519 | * @returns IPRT status code.
|
|---|
| 520 | * @retval VERR_NOT_SUPPORTED if it's not possible to map a subsection of a
|
|---|
| 521 | * memory object on this platform. When you hit this, try implement it.
|
|---|
| 522 | *
|
|---|
| 523 | * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
|
|---|
| 524 | * @param MemObjToMap The object to be map.
|
|---|
| 525 | * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
|
|---|
| 526 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 527 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 528 | * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
|
|---|
| 529 | * @param offSub Where in the object to start mapping. If non-zero
|
|---|
| 530 | * the value must be page aligned and cbSub must be
|
|---|
| 531 | * non-zero as well.
|
|---|
| 532 | * @param cbSub The size of the part of the object to be mapped. If
|
|---|
| 533 | * zero the entire object is mapped. The value must be
|
|---|
| 534 | * page aligned.
|
|---|
| 535 | */
|
|---|
| 536 | #define RTR0MemObjMapKernelEx(pMemObj, MemObjToMap, pvFixed, uAlignment, fProt, offSub, cbSub) \
|
|---|
| 537 | RTR0MemObjMapKernelExTag((pMemObj), (MemObjToMap), (pvFixed), (uAlignment), (fProt), (offSub), (cbSub), RTMEM_TAG)
|
|---|
| 538 |
|
|---|
| 539 | /**
|
|---|
| 540 | * Maps a memory object into kernel virtual address space (custom tag).
|
|---|
| 541 | *
|
|---|
| 542 | * The ability to map subsections of the object into kernel space is currently
|
|---|
| 543 | * not implemented on all platforms. All/Most of platforms supports mapping the
|
|---|
| 544 | * whole object into kernel space.
|
|---|
| 545 | *
|
|---|
| 546 | * @returns IPRT status code.
|
|---|
| 547 | * @retval VERR_NOT_SUPPORTED if it's not possible to map a subsection of a
|
|---|
| 548 | * memory object on this platform. When you hit this, try implement it.
|
|---|
| 549 | *
|
|---|
| 550 | * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
|
|---|
| 551 | * @param MemObjToMap The object to be map.
|
|---|
| 552 | * @param pvFixed Requested address. (void *)-1 means any address. This must match the alignment.
|
|---|
| 553 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 554 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 555 | * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
|
|---|
| 556 | * @param offSub Where in the object to start mapping. If non-zero
|
|---|
| 557 | * the value must be page aligned and cbSub must be
|
|---|
| 558 | * non-zero as well.
|
|---|
| 559 | * @param cbSub The size of the part of the object to be mapped. If
|
|---|
| 560 | * zero the entire object is mapped. The value must be
|
|---|
| 561 | * page aligned.
|
|---|
| 562 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 563 | */
|
|---|
| 564 | RTR0DECL(int) RTR0MemObjMapKernelExTag(PRTR0MEMOBJ pMemObj, RTR0MEMOBJ MemObjToMap, void *pvFixed, size_t uAlignment,
|
|---|
| 565 | unsigned fProt, size_t offSub, size_t cbSub, const char *pszTag);
|
|---|
| 566 |
|
|---|
| 567 | /**
|
|---|
| 568 | * Maps a memory object into user virtual address space in the current process
|
|---|
| 569 | * (default tag).
|
|---|
| 570 | *
|
|---|
| 571 | * @returns IPRT status code.
|
|---|
| 572 | * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
|
|---|
| 573 | * @param MemObjToMap The object to be map.
|
|---|
| 574 | * @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This must match the alignment.
|
|---|
| 575 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 576 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 577 | * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
|
|---|
| 578 | * @param R0Process The process to map the memory into. NIL_R0PROCESS is an alias for the current one.
|
|---|
| 579 | */
|
|---|
| 580 | #define RTR0MemObjMapUser(pMemObj, MemObjToMap, R3PtrFixed, uAlignment, fProt, R0Process) \
|
|---|
| 581 | RTR0MemObjMapUserTag((pMemObj), (MemObjToMap), (R3PtrFixed), (uAlignment), (fProt), (R0Process), RTMEM_TAG)
|
|---|
| 582 |
|
|---|
| 583 | /**
|
|---|
| 584 | * Maps a memory object into user virtual address space in the current process
|
|---|
| 585 | * (custom tag).
|
|---|
| 586 | *
|
|---|
| 587 | * @returns IPRT status code.
|
|---|
| 588 | * @param pMemObj Where to store the ring-0 memory object handle of the mapping object.
|
|---|
| 589 | * @param MemObjToMap The object to be map.
|
|---|
| 590 | * @param R3PtrFixed Requested address. (RTR3PTR)-1 means any address. This must match the alignment.
|
|---|
| 591 | * @param uAlignment The alignment of the reserved memory.
|
|---|
| 592 | * Supported values are 0 (alias for PAGE_SIZE), PAGE_SIZE, _2M and _4M.
|
|---|
| 593 | * @param fProt Combination of RTMEM_PROT_* flags (except RTMEM_PROT_NONE).
|
|---|
| 594 | * @param R0Process The process to map the memory into. NIL_R0PROCESS is an alias for the current one.
|
|---|
| 595 | * @param pszTag Allocation tag used for statistics and such.
|
|---|
| 596 | */
|
|---|
| 597 | RTR0DECL(int) RTR0MemObjMapUserTag(PRTR0MEMOBJ pMemObj, RTR0MEMOBJ MemObjToMap, RTR3PTR R3PtrFixed,
|
|---|
| 598 | size_t uAlignment, unsigned fProt, RTR0PROCESS R0Process, const char *pszTag);
|
|---|
| 599 |
|
|---|
| 600 | /**
|
|---|
| 601 | * Change the page level protection of one or more pages in a memory object.
|
|---|
| 602 | *
|
|---|
| 603 | * @returns IPRT status code.
|
|---|
| 604 | * @retval VERR_NOT_SUPPORTED if the OS doesn't provide any way to manipulate
|
|---|
| 605 | * page level protection. The caller must handle this status code
|
|---|
| 606 | * gracefully. (Note that it may also occur if the implementation is
|
|---|
| 607 | * missing, in which case just go ahead and implement it.)
|
|---|
| 608 | *
|
|---|
| 609 | * @param hMemObj Memory object handle.
|
|---|
| 610 | * @param offSub Offset into the memory object. Must be page aligned.
|
|---|
| 611 | * @param cbSub Number of bytes to change the protection of. Must be
|
|---|
| 612 | * page aligned.
|
|---|
| 613 | * @param fProt Combination of RTMEM_PROT_* flags.
|
|---|
| 614 | */
|
|---|
| 615 | RTR0DECL(int) RTR0MemObjProtect(RTR0MEMOBJ hMemObj, size_t offSub, size_t cbSub, uint32_t fProt);
|
|---|
| 616 |
|
|---|
| 617 | #endif /* IN_RING0 */
|
|---|
| 618 |
|
|---|
| 619 | /** @} */
|
|---|
| 620 |
|
|---|
| 621 | RT_C_DECLS_END
|
|---|
| 622 |
|
|---|
| 623 | #endif
|
|---|
| 624 |
|
|---|
