1 /*
2 * Copyright (C) 2017-2019 Lyude Paul
3 * Copyright (C) 2017-2019 Alyssa Rosenzweig
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_DECODE_H__
27 #define __PAN_DECODE_H__
28
29 #include "wrap.h"
30 #include "util/list.h"
31
32 extern FILE *pandecode_dump_stream;
33
34 void pandecode_dump_file_open(void);
35
36 struct pandecode_mapped_memory {
37 size_t length;
38 void *addr;
39 uint64_t gpu_va;
40 bool ro;
41 char name[32];
42 };
43
44 char *pointer_as_memory_reference(uint64_t ptr);
45
46 struct pandecode_mapped_memory *pandecode_find_mapped_gpu_mem_containing(uint64_t addr);
47
48 void pandecode_map_read_write(void);
49
50 static inline void *
__pandecode_fetch_gpu_mem(const struct pandecode_mapped_memory * mem,uint64_t gpu_va,size_t size,int line,const char * filename)51 __pandecode_fetch_gpu_mem(const struct pandecode_mapped_memory *mem,
52 uint64_t gpu_va, size_t size,
53 int line, const char *filename)
54 {
55 if (!mem)
56 mem = pandecode_find_mapped_gpu_mem_containing(gpu_va);
57
58 if (!mem) {
59 fprintf(stderr, "Access to unknown memory %" PRIx64 " in %s:%d",
60 gpu_va, filename, line);
61 assert(0);
62 }
63
64 assert(mem);
65 assert(size + (gpu_va - mem->gpu_va) <= mem->length);
66
67 return mem->addr + gpu_va - mem->gpu_va;
68 }
69
70 #define pandecode_fetch_gpu_mem(mem, gpu_va, size) \
71 __pandecode_fetch_gpu_mem(mem, gpu_va, size, __LINE__, __FILE__)
72
73 /* Returns a validated pointer to mapped GPU memory with the given pointer type,
74 * size automatically determined from the pointer type
75 */
76 #define PANDECODE_PTR(mem, gpu_va, type) \
77 ((type*)(__pandecode_fetch_gpu_mem(mem, gpu_va, sizeof(type), \
78 __LINE__, __FILE__)))
79
80 /* Usage: <variable type> PANDECODE_PTR_VAR(name, mem, gpu_va) */
81 #define PANDECODE_PTR_VAR(name, mem, gpu_va) \
82 name = __pandecode_fetch_gpu_mem(mem, gpu_va, sizeof(*name), \
83 __LINE__, __FILE__)
84
85 #endif /* __MMAP_TRACE_H__ */
86