panfrost: Inline panfrost-misc.h into panfrost-job.h
[mesa.git] / src / panfrost / encoder / pan_bo.h
1 /*
2 * © Copyright 2019 Alyssa Rosenzweig
3 * © Copyright 2019 Collabora, Ltd.
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 (including the next
13 * paragraph) shall be included in all copies or substantial portions of the
14 * Software.
15 *
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 *
24 */
25
26 #ifndef __PAN_BO_H__
27 #define __PAN_BO_H__
28
29 #include "util/list.h"
30 #include "pan_device.h"
31 #include <time.h>
32
33 /* Flags for allocated memory */
34
35 /* This memory region is executable */
36 #define PAN_BO_EXECUTE (1 << 0)
37
38 /* This memory region should be lazily allocated and grow-on-page-fault. Must
39 * be used in conjunction with INVISIBLE */
40 #define PAN_BO_GROWABLE (1 << 1)
41
42 /* This memory region should not be mapped to the CPU */
43 #define PAN_BO_INVISIBLE (1 << 2)
44
45 /* This region may not be used immediately and will not mmap on allocate
46 * (semantically distinct from INVISIBLE, which cannot never be mmaped) */
47 #define PAN_BO_DELAY_MMAP (1 << 3)
48
49 /* BO is shared across processes (imported or exported) and therefore cannot be
50 * cached locally */
51 #define PAN_BO_SHARED (1 << 4)
52
53 /* GPU access flags */
54
55 /* BO is either shared (can be accessed by more than one GPU batch) or private
56 * (reserved by a specific GPU job). */
57 #define PAN_BO_ACCESS_PRIVATE (0 << 0)
58 #define PAN_BO_ACCESS_SHARED (1 << 0)
59
60 /* BO is being read/written by the GPU */
61 #define PAN_BO_ACCESS_READ (1 << 1)
62 #define PAN_BO_ACCESS_WRITE (1 << 2)
63 #define PAN_BO_ACCESS_RW (PAN_BO_ACCESS_READ | PAN_BO_ACCESS_WRITE)
64
65 /* BO is accessed by the vertex/tiler job. */
66 #define PAN_BO_ACCESS_VERTEX_TILER (1 << 3)
67
68 /* BO is accessed by the fragment job. */
69 #define PAN_BO_ACCESS_FRAGMENT (1 << 4)
70
71 struct panfrost_bo {
72 /* Must be first for casting */
73 struct list_head bucket_link;
74
75 /* Used to link the BO to the BO cache LRU list. */
76 struct list_head lru_link;
77
78 /* Store the time this BO was use last, so the BO cache logic can evict
79 * stale BOs.
80 */
81 time_t last_used;
82
83 /* Atomic reference count */
84 int32_t refcnt;
85
86 struct panfrost_device *dev;
87
88 /* Mapping for the entire object (all levels) */
89 uint8_t *cpu;
90
91 /* GPU address for the object */
92 mali_ptr gpu;
93
94 /* Size of all entire trees */
95 size_t size;
96
97 int gem_handle;
98
99 uint32_t flags;
100
101 /* Combination of PAN_BO_ACCESS_{READ,WRITE} flags encoding pending
102 * GPU accesses to this BO. Useful to avoid calling the WAIT_BO ioctl
103 * when the BO is idle.
104 */
105 uint32_t gpu_access;
106 };
107
108 bool
109 panfrost_bo_wait(struct panfrost_bo *bo, int64_t timeout_ns, bool wait_readers);
110 void
111 panfrost_bo_reference(struct panfrost_bo *bo);
112 void
113 panfrost_bo_unreference(struct panfrost_bo *bo);
114 struct panfrost_bo *
115 panfrost_bo_create(struct panfrost_device *dev, size_t size,
116 uint32_t flags);
117 void
118 panfrost_bo_mmap(struct panfrost_bo *bo);
119 struct panfrost_bo *
120 panfrost_bo_import(struct panfrost_device *dev, int fd);
121 int
122 panfrost_bo_export(struct panfrost_bo *bo);
123 void
124 panfrost_bo_cache_evict_all(struct panfrost_device *dev);
125
126 #endif /* __PAN_BO_H__ */