2 * Copyright 2014-2019 Advanced Micro Devices, Inc.
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:
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
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
31 #include "util/u_dynarray.h"
32 #include "compiler/shader_enums.h"
35 struct ac_shader_config
;
38 struct ac_rtld_symbol
{
42 uint64_t offset
; /* filled in by ac_rtld_open */
43 unsigned part_idx
; /* shader part in which this symbol appears */
46 struct ac_rtld_options
{
47 /* Loader will insert an s_sethalt 1 instruction as the
48 * first instruction. */
52 /* Lightweight wrapper around underlying ELF objects. */
53 struct ac_rtld_binary
{
54 struct ac_rtld_options options
;
57 /* Required buffer sizes, currently read/executable only. */
60 uint64_t rx_end_markers
;
63 struct ac_rtld_part
*parts
;
65 struct util_dynarray lds_symbols
;
70 * Callback function type used during upload to resolve external symbols that
71 * are not defined in any of the ELF binaries available to the linker.
73 * \param cb_data caller-defined data
74 * \param symbol NUL-terminated symbol name
75 * \param value to be filled in by the callback
76 * \return whether the symbol was found successfully
78 typedef bool (*ac_rtld_get_external_symbol_cb
)(
79 void *cb_data
, const char *symbol
, uint64_t *value
);
82 * Lifetimes of \ref info, in-memory ELF objects, and the names of
83 * \ref shared_lds_symbols must extend until \ref ac_rtld_close is called on
86 struct ac_rtld_open_info
{
87 const struct radeon_info
*info
;
88 struct ac_rtld_options options
;
89 gl_shader_stage shader_type
;
93 const char * const *elf_ptrs
; /* in-memory ELF objects of each part */
94 const size_t *elf_sizes
; /* sizes of corresponding in-memory ELF objects in bytes */
96 /* Shared LDS symbols are layouted such that they are accessible from
97 * all shader parts. Non-shared (private) LDS symbols of one part may
98 * overlap private LDS symbols of another shader part.
100 unsigned num_shared_lds_symbols
;
101 const struct ac_rtld_symbol
*shared_lds_symbols
;
104 bool ac_rtld_open(struct ac_rtld_binary
*binary
,
105 struct ac_rtld_open_info i
);
107 void ac_rtld_close(struct ac_rtld_binary
*binary
);
109 bool ac_rtld_get_section_by_name(struct ac_rtld_binary
*binary
, const char *name
,
110 const char **data
, size_t *nbytes
);
112 bool ac_rtld_read_config(struct ac_rtld_binary
*binary
,
113 struct ac_shader_config
*config
);
115 struct ac_rtld_upload_info
{
116 struct ac_rtld_binary
*binary
;
118 /** GPU mapping of the read/executable buffer. */
121 /** CPU mapping of the read/executable buffer */
124 /** Optional callback function that will be queried for symbols not
125 * defined in any of the binary's parts. */
126 ac_rtld_get_external_symbol_cb get_external_symbol
;
128 /** Caller-defined data that will be passed to callback functions. */
132 bool ac_rtld_upload(struct ac_rtld_upload_info
*u
);
134 #endif /* AC_RTLD_H */