1 /*
2  * © Copyright 2017-2018 Alyssa Rosenzweig
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 FROM,
20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21  * SOFTWARE.
22  *
23  */
24 
25 #ifndef __PAN_POOL_H__
26 #define __PAN_POOL_H__
27 
28 #include <stddef.h>
29 #include <midgard_pack.h>
30 #include "pan_bo.h"
31 
32 #include "util/u_dynarray.h"
33 
34 /* Represents a pool of memory that can only grow, used to allocate objects
35  * with the same lifetime as the pool itself. In OpenGL, a pool is owned by the
36  * batch for transient structures. In Vulkan, it may be owned by e.g. the
37  * command pool */
38 
39 struct pan_pool {
40         /* Parent device for allocation */
41         struct panfrost_device *dev;
42 
43         /* BOs allocated by this pool */
44         struct util_dynarray bos;
45 
46         /* Current transient BO */
47         struct panfrost_bo *transient_bo;
48 
49         /* Within the topmost transient BO, how much has been used? */
50         unsigned transient_offset;
51 
52         /* BO flags to use in the pool */
53         unsigned create_flags;
54 };
55 
56 void
57 panfrost_pool_init(struct pan_pool *pool, void *memctx,
58                    struct panfrost_device *dev, unsigned create_flags,
59                    bool prealloc);
60 
61 void
62 panfrost_pool_cleanup(struct pan_pool *pool);
63 
64 static inline unsigned
panfrost_pool_num_bos(struct pan_pool * pool)65 panfrost_pool_num_bos(struct pan_pool *pool)
66 {
67         return util_dynarray_num_elements(&pool->bos, struct panfrost_bo *);
68 }
69 
70 void
71 panfrost_pool_get_bo_handles(struct pan_pool *pool, uint32_t *handles);
72 
73 /* Represents a fat pointer for GPU-mapped memory, returned from the transient
74  * allocator and not used for much else */
75 
76 struct panfrost_ptr
77 panfrost_pool_alloc_aligned(struct pan_pool *pool, size_t sz, unsigned alignment);
78 
79 /* Default to self-alignment */
80 
81 static inline struct panfrost_ptr
panfrost_pool_alloc(struct pan_pool * pool,size_t sz)82 panfrost_pool_alloc(struct pan_pool *pool, size_t sz)
83 {
84         assert(sz == util_next_power_of_two(sz));
85         return panfrost_pool_alloc_aligned(pool, sz, sz);
86 }
87 
88 struct panfrost_ptr
89 panfrost_pool_alloc(struct pan_pool *pool, size_t sz);
90 
91 mali_ptr
92 panfrost_pool_upload(struct pan_pool *pool, const void *data, size_t sz);
93 
94 mali_ptr
95 panfrost_pool_upload_aligned(struct pan_pool *pool, const void *data, size_t sz, unsigned alignment);
96 
97 #endif
98