pan/decode: Trace to stderr with PANDECODE_DUMP_FILE=stderr
[mesa.git] / src / panfrost / pandecode / common.c
1 /*
2 * Copyright (C) 2019 Alyssa Rosenzweig
3 * Copyright (C) 2017-2018 Lyude Paul
4 * Copyright (C) 2019 Collabora, Ltd.
5 *
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
12 *
13 * The above copyright notice and this permission notice (including the next
14 * paragraph) shall be included in all copies or substantial portions of the
15 * Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
24 */
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <assert.h>
29 #include <stdint.h>
30 #include <string.h>
31
32 #include "decode.h"
33 #include "util/macros.h"
34 #include "util/u_debug.h"
35
36 /* Memory handling */
37
38 static struct pandecode_mapped_memory mmaps;
39
40 struct pandecode_mapped_memory *
41 pandecode_find_mapped_gpu_mem_containing(uint64_t addr)
42 {
43 list_for_each_entry(struct pandecode_mapped_memory, pos, &mmaps.node, node) {
44 if (addr >= pos->gpu_va && addr < pos->gpu_va + pos->length)
45 return pos;
46 }
47
48 return NULL;
49 }
50
51 static void
52 pandecode_add_name(struct pandecode_mapped_memory *mem, uint64_t gpu_va, const char *name)
53 {
54 if (!name) {
55 /* If we don't have a name, assign one */
56
57 snprintf(mem->name, ARRAY_SIZE(mem->name) - 1,
58 "memory_%" PRIx64, gpu_va);
59 } else {
60 assert((strlen(name) + 1) < ARRAY_SIZE(mem->name));
61 memcpy(mem->name, name, strlen(name) + 1);
62 }
63 }
64
65 void
66 pandecode_inject_mmap(uint64_t gpu_va, void *cpu, unsigned sz, const char *name)
67 {
68 /* First, search if we already mapped this and are just updating an address */
69
70 list_for_each_entry(struct pandecode_mapped_memory, pos, &mmaps.node, node) {
71 if (pos->gpu_va == gpu_va) {
72 /* TODO: Resizing weirdness. Only applies to tracing
73 * the legacy driver, not for native traces */
74
75 pos->length = sz;
76 pos->addr = cpu;
77 pandecode_add_name(pos, gpu_va, name);
78
79 return;
80 }
81 }
82
83 /* Otherwise, add a fresh mapping */
84 struct pandecode_mapped_memory *mapped_mem = NULL;
85
86 mapped_mem = malloc(sizeof(*mapped_mem));
87 list_inithead(&mapped_mem->node);
88
89 mapped_mem->gpu_va = gpu_va;
90 mapped_mem->length = sz;
91 mapped_mem->addr = cpu;
92 pandecode_add_name(mapped_mem, gpu_va, name);
93
94 list_add(&mapped_mem->node, &mmaps.node);
95 }
96
97 char *
98 pointer_as_memory_reference(uint64_t ptr)
99 {
100 struct pandecode_mapped_memory *mapped;
101 char *out = malloc(128);
102
103 /* Try to find the corresponding mapped zone */
104
105 mapped = pandecode_find_mapped_gpu_mem_containing(ptr);
106
107 if (mapped) {
108 snprintf(out, 128, "%s + %d", mapped->name, (int) (ptr - mapped->gpu_va));
109 return out;
110 }
111
112 /* Just use the raw address if other options are exhausted */
113
114 snprintf(out, 128, "0x%" PRIx64, ptr);
115 return out;
116
117 }
118
119 static int pandecode_dump_frame_count = 0;
120
121 static void
122 pandecode_dump_file_open(bool force_stderr)
123 {
124 if (pandecode_dump_stream)
125 return;
126
127 /* This does a getenv every frame, so it is possible to use
128 * setenv to change the base at runtime.
129 */
130 const char *dump_file_base = debug_get_option("PANDECODE_DUMP_FILE", "pandecode.dump");
131 if (force_stderr || !strcmp(dump_file_base, "stderr"))
132 pandecode_dump_stream = stderr;
133 else {
134 char buffer[1024];
135 snprintf(buffer, sizeof(buffer), "%s.%04d", dump_file_base, pandecode_dump_frame_count);
136 printf("pandecode: dump command stream to file %s\n", buffer);
137 pandecode_dump_stream = fopen(buffer, "w");
138 if (!pandecode_dump_stream)
139 fprintf(stderr,
140 "pandecode: failed to open command stream log file %s\n",
141 buffer);
142 }
143 }
144
145 static void
146 pandecode_dump_file_close(void)
147 {
148 if (pandecode_dump_stream && pandecode_dump_stream != stderr) {
149 fclose(pandecode_dump_stream);
150 pandecode_dump_stream = NULL;
151 }
152 }
153
154 void
155 pandecode_initialize(bool to_stderr)
156 {
157 list_inithead(&mmaps.node);
158 pandecode_dump_file_open(to_stderr);
159 }
160
161 void
162 pandecode_next_frame(void)
163 {
164 pandecode_dump_file_close();
165 pandecode_dump_frame_count++;
166 pandecode_dump_file_open(false);
167 }
168
169 void
170 pandecode_close(void)
171 {
172 pandecode_dump_file_close();
173 }