radeon: Teach radeon_elf_read() how to parse reloc information v3
[mesa.git] / src / gallium / drivers / radeon / radeon_elf_util.h
1 /*
2 * Copyright 2014 Advanced Micro Devices, Inc.
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 * Authors: Tom Stellard <thomas.stellard@amd.com>
24 *
25 */
26
27 #ifndef RADEON_ELF_UTIL_H
28 #define RADEON_ELF_UTIL_H
29
30 #include <stdint.h>
31
32 struct radeon_shader_binary;
33 struct radeon_shader_reloc;
34
35 /*
36 * Parse the elf binary stored in \p elf_data and create a
37 * radeon_shader_binary object.
38 */
39 void radeon_elf_read(const char *elf_data, unsigned elf_size,
40 struct radeon_shader_binary *binary, unsigned debug);
41
42 /**
43 * @returns A pointer to the start of the configuration information for
44 * the function starting at \p symbol_offset of the binary.
45 */
46 const unsigned char *radeon_shader_binary_config_start(
47 const struct radeon_shader_binary *binary,
48 uint64_t symbol_offset);
49
50 /**
51 * Free all memory allocated for members of \p binary. This function does
52 * not free \p binary.
53 *
54 * @param free_relocs If false, reolc information will not be freed.
55 */
56 void radeon_shader_binary_free_members(struct radeon_shader_binary *binary,
57 unsigned free_relocs);
58
59 /**
60 * Free \p relocs and all member data.
61 */
62 void radeon_shader_binary_free_relocs(struct radeon_shader_reloc *relocs,
63 unsigned reloc_count);
64 #endif /* RADEON_ELF_UTIL_H */