libdrm: NOTE! Default branch is now main
[libdrm.git] / intel / mm.h
blobbe3d90d4beb6370e88515f81711601772af1663b
1 /*
2 * GLX Hardware Device Driver common code
3 * Copyright (C) 1999 Wittawat Yamwong
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:
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Software.
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.
24 /**
25 * Memory manager code. Primarily used by device drivers to manage texture
26 * heaps, etc.
29 #ifndef MM_H
30 #define MM_H
32 #include "libdrm_macros.h"
34 struct mem_block {
35 struct mem_block *next, *prev;
36 struct mem_block *next_free, *prev_free;
37 struct mem_block *heap;
38 int ofs, size;
39 unsigned int free:1;
40 unsigned int reserved:1;
43 /**
44 * input: total size in bytes
45 * return: a heap pointer if OK, NULL if error
47 drm_private extern struct mem_block *mmInit(int ofs, int size);
49 /**
50 * Allocate 'size' bytes with 2^align2 bytes alignment,
51 * restrict the search to free memory after 'startSearch'
52 * depth and back buffers should be in different 4mb banks
53 * to get better page hits if possible
54 * input: size = size of block
55 * align2 = 2^align2 bytes alignment
56 * startSearch = linear offset from start of heap to begin search
57 * return: pointer to the allocated block, 0 if error
59 drm_private extern struct mem_block *mmAllocMem(struct mem_block *heap,
60 int size, int align2,
61 int startSearch);
63 /**
64 * Free block starts at offset
65 * input: pointer to a block
66 * return: 0 if OK, -1 if error
68 drm_private extern int mmFreeMem(struct mem_block *b);
70 /**
71 * destroy MM
73 drm_private extern void mmDestroy(struct mem_block *mmInit);
75 /**
76 * For debugging purpose.
78 drm_private extern void mmDumpMemInfo(const struct mem_block *mmInit);
80 #endif