src/util/vma.h

   1 /*
   2  * Copyright © 2018 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #ifndef _UTIL_VMA_H
  25 #define _UTIL_VMA_H
  26
  27 #include <stdint.h>
  28 #include <stdio.h>
  29
  30 #include "list.h"
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 struct util_vma_heap {
  37    struct list_head holes;
  38
  39    /** If true, util_vma_heap_alloc will prefer high addresses
  40     *
  41     * Default is true.
  42     */
  43    bool alloc_high;
  44 };
  45
  46 void util_vma_heap_init(struct util_vma_heap *heap,
  47                         uint64_t start, uint64_t size);
  48 void util_vma_heap_finish(struct util_vma_heap *heap);
  49
  50 uint64_t util_vma_heap_alloc(struct util_vma_heap *heap,
  51                              uint64_t size, uint64_t alignment);
  52
  53 bool util_vma_heap_alloc_addr(struct util_vma_heap *heap,
  54                               uint64_t addr, uint64_t size);
  55
  56 void util_vma_heap_free(struct util_vma_heap *heap,
  57                         uint64_t offset, uint64_t size);
  58
  59 void util_vma_heap_print(struct util_vma_heap *heap, FILE *fp,
  60                          const char *tab, uint64_t total_size);
  61
  62 #ifdef __cplusplus
  63 } /* extern C */
  64 #endif
  65
  66 #endif /* _UTIL_DEBUG_H */