src/gallium/auxiliary/util/u_mm.h

   1 /**************************************************************************
   2  *
   3  * Copyright (C) 1999 Wittawat Yamwong
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining a
   6  * copy of this software and associated documentation files (the "Software"),
   7  * to deal in the Software without restriction, including without limitation
   8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   9  * and/or sell copies of the Software, and to permit persons to whom the
  10  * Software is furnished to do so, subject to the following conditions:
  11  *
  12  * The above copyright notice and this permission notice shall be included
  13  * in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * KEITH WHITWELL, OR ANY OTHER CONTRIBUTORS BE LIABLE FOR ANY CLAIM,
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
  21  * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  *
  23  **************************************************************************/
  24
  25
  26 /**
  27  * @file
  28  * Memory manager code.  Primarily used by device drivers to manage texture
  29  * heaps, etc.
  30  */
  31
  32
  33 #ifndef _U_MM_H_
  34 #define _U_MM_H_
  35
  36
  37 struct mem_block {
  38    struct mem_block *next, *prev;
  39    struct mem_block *next_free, *prev_free;
  40    struct mem_block *heap;
  41    int ofs,size;
  42    unsigned int free:1;
  43    unsigned int reserved:1;
  44 };
  45
  46
  47
  48 /**
  49  * input: total size in bytes
  50  * return: a heap pointer if OK, NULL if error
  51  */
  52 extern struct mem_block *u_mmInit(int ofs, int size);
  53
  54 /**
  55  * Allocate 'size' bytes with 2^align2 bytes alignment,
  56  * restrict the search to free memory after 'startSearch'
  57  * depth and back buffers should be in different 4mb banks
  58  * to get better page hits if possible
  59  * input:       size = size of block
  60  *              align2 = 2^align2 bytes alignment
  61  *              startSearch = linear offset from start of heap to begin search
  62  * return: pointer to the allocated block, 0 if error
  63  */
  64 extern struct mem_block *u_mmAllocMem(struct mem_block *heap, int size, int align2,
  65                             int startSearch);
  66
  67 /**
  68  * Free block starts at offset
  69  * input: pointer to a block
  70  * return: 0 if OK, -1 if error
  71  */
  72 extern int u_mmFreeMem(struct mem_block *b);
  73
  74 /**
  75  * Free block starts at offset
  76  * input: pointer to a heap, start offset
  77  * return: pointer to a block
  78  */
  79 extern struct mem_block *u_mmFindBlock(struct mem_block *heap, int start);
  80
  81 /**
  82  * destroy MM
  83  */
  84 extern void u_mmDestroy(struct mem_block *mmInit);
  85
  86 /**
  87  * For debugging purposes.
  88  */
  89 extern void u_mmDumpMemInfo(const struct mem_block *mmInit);
  90
  91 #endif