ubuntu/vbox/r0drv/alloc-r0drv.h

   1 /* $Id: alloc-r0drv.h $ */
   2 /** @file
   3  * IPRT - Memory Allocation, Ring-0 Driver.
   4  */
   5
   6 /*
   7  * Copyright (C) 2006-2016 Oracle Corporation
   8  *
   9  * This file is part of VirtualBox Open Source Edition (OSE), as
  10  * available from http://www.virtualbox.org. This file is free software;
  11  * you can redistribute it and/or modify it under the terms of the GNU
  12  * General Public License (GPL) as published by the Free Software
  13  * Foundation, in version 2 as it comes in the "COPYING" file of the
  14  * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
  15  * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
  16  *
  17  * The contents of this file may alternatively be used under the terms
  18  * of the Common Development and Distribution License Version 1.0
  19  * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
  20  * VirtualBox OSE distribution, in which case the provisions of the
  21  * CDDL are applicable instead of those of the GPL.
  22  *
  23  * You may elect to license modified versions of this file under the
  24  * terms and conditions of either the GPL or the CDDL or both.
  25  */
  26
  27 #ifndef ___r0drv_alloc_r0drv_h
  28 #define ___r0drv_alloc_r0drv_h
  29
  30 #include <iprt/cdefs.h>
  31 #include <iprt/types.h>
  32 #include <iprt/mem.h>
  33 #include "internal/magics.h"
  34
  35 RT_C_DECLS_BEGIN
  36
  37 /**
  38  * Header which heading all memory blocks.
  39  */
  40 typedef struct RTMEMHDR
  41 {
  42     /** Magic (RTMEMHDR_MAGIC). */
  43     uint32_t    u32Magic;
  44     /** Block flags (RTMEMHDR_FLAG_*). */
  45     uint32_t    fFlags;
  46     /** The actual size of the block, header not included. */
  47     uint32_t    cb;
  48     /** The requested allocation size. */
  49     uint32_t    cbReq;
  50 } RTMEMHDR, *PRTMEMHDR;
  51
  52
  53 /** @name RTMEMHDR::fFlags.
  54  * @{ */
  55 /** Clear the allocated memory. */
  56 #define RTMEMHDR_FLAG_ZEROED        RT_BIT(0)
  57 /** Executable flag. */
  58 #define RTMEMHDR_FLAG_EXEC          RT_BIT(1)
  59 /** Use allocation method suitable for any context. */
  60 #define RTMEMHDR_FLAG_ANY_CTX_ALLOC RT_BIT(2)
  61 /** Use allocation method which allow for freeing in any context. */
  62 #define RTMEMHDR_FLAG_ANY_CTX_FREE  RT_BIT(3)
  63 /** Both alloc and free in any context (or we're just darn lazy). */
  64 #define RTMEMHDR_FLAG_ANY_CTX       (RTMEMHDR_FLAG_ANY_CTX_ALLOC | RTMEMHDR_FLAG_ANY_CTX_FREE)
  65 /** Indicate that it was allocated by rtR0MemAllocExTag. */
  66 #define RTMEMHDR_FLAG_ALLOC_EX      RT_BIT(4)
  67 #ifdef RT_OS_LINUX
  68 /** Linux: Allocated using vm_area hacks. */
  69 # define RTMEMHDR_FLAG_EXEC_VM_AREA RT_BIT(29)
  70 /** Linux: Allocated from the special heap for executable memory. */
  71 # define RTMEMHDR_FLAG_EXEC_HEAP    RT_BIT(30)
  72 /** Linux: Allocated by kmalloc() instead of vmalloc(). */
  73 # define RTMEMHDR_FLAG_KMALLOC      RT_BIT(31)
  74 #endif
  75 /** @} */
  76
  77
  78 /**
  79  * Heap allocation back end for ring-0.
  80  *
  81  * @returns IPRT status code.  VERR_NO_MEMORY suffices for RTMEMHDR_FLAG_EXEC,
  82  *          the caller will change it to VERR_NO_EXEC_MEMORY when appropriate.
  83  *
  84  * @param   cb          The amount of memory requested by the user.  This does
  85  *                      not include the header.
  86  * @param   fFlags      The allocation flags and more.  These should be
  87  *                      assigned to RTMEMHDR::fFlags together with any flags
  88  *                      the backend might be using.
  89  * @param   ppHdr       Where to return the memory header on success.
  90  */
  91 DECLHIDDEN(int)     rtR0MemAllocEx(size_t cb, uint32_t fFlags, PRTMEMHDR *ppHdr);
  92
  93 /**
  94  * Free memory allocated by rtR0MemAllocEx.
  95  * @param   pHdr        The memory block to free.  (Never NULL.)
  96  */
  97 DECLHIDDEN(void)    rtR0MemFree(PRTMEMHDR pHdr);
  98
  99 RT_C_DECLS_END
 100 #endif
 101