src/amd/common/ac_rtld.h

   1 /*
   2  * Copyright 2014-2019 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
  24 #ifndef AC_RTLD_H
  25 #define AC_RTLD_H
  26
  27 #include <stdbool.h>
  28 #include <stdint.h>
  29 #include <stddef.h>
  30
  31 #include "util/u_dynarray.h"
  32 #include "compiler/shader_enums.h"
  33
  34 struct ac_rtld_part;
  35 struct ac_shader_config;
  36 struct radeon_info;
  37
  38 struct ac_rtld_symbol {
  39         const char *name;
  40         uint32_t size;
  41         uint32_t align;
  42         uint64_t offset; /* filled in by ac_rtld_open */
  43         unsigned part_idx; /* shader part in which this symbol appears */
  44 };
  45
  46 struct ac_rtld_options {
  47         /* Loader will insert an s_sethalt 1 instruction as the
  48          * first instruction. */
  49         bool halt_at_entry:1;
  50 };
  51
  52 /* Lightweight wrapper around underlying ELF objects. */
  53 struct ac_rtld_binary {
  54         struct ac_rtld_options options;
  55
  56         /* Required buffer sizes, currently read/executable only. */
  57         uint64_t rx_size;
  58
  59         uint64_t rx_end_markers;
  60
  61         unsigned num_parts;
  62         struct ac_rtld_part *parts;
  63
  64         struct util_dynarray lds_symbols;
  65         uint32_t lds_size;
  66 };
  67
  68 /**
  69  * Callback function type used during upload to resolve external symbols that
  70  * are not defined in any of the ELF binaries available to the linker.
  71  *
  72  * \param cb_data caller-defined data
  73  * \param symbol NUL-terminated symbol name
  74  * \param value to be filled in by the callback
  75  * \return whether the symbol was found successfully
  76  */
  77 typedef bool (*ac_rtld_get_external_symbol_cb)(
  78         void *cb_data, const char *symbol, uint64_t *value);
  79
  80 /**
  81  * Lifetimes of \ref info, in-memory ELF objects, and the names of
  82  * \ref shared_lds_symbols must extend until \ref ac_rtld_close is called on
  83  * the opened binary.
  84  */
  85 struct ac_rtld_open_info {
  86         const struct radeon_info *info;
  87         struct ac_rtld_options options;
  88         gl_shader_stage shader_type;
  89
  90         unsigned num_parts;
  91         const char * const *elf_ptrs; /* in-memory ELF objects of each part */
  92         const size_t *elf_sizes; /* sizes of corresponding in-memory ELF objects in bytes */
  93
  94         /* Shared LDS symbols are layouted such that they are accessible from
  95          * all shader parts. Non-shared (private) LDS symbols of one part may
  96          * overlap private LDS symbols of another shader part.
  97          */
  98         unsigned num_shared_lds_symbols;
  99         const struct ac_rtld_symbol *shared_lds_symbols;
 100 };
 101
 102 bool ac_rtld_open(struct ac_rtld_binary *binary,
 103                   struct ac_rtld_open_info i);
 104
 105 void ac_rtld_close(struct ac_rtld_binary *binary);
 106
 107 bool ac_rtld_get_section_by_name(struct ac_rtld_binary *binary, const char *name,
 108                                  const char **data, size_t *nbytes);
 109
 110 bool ac_rtld_read_config(struct ac_rtld_binary *binary,
 111                          struct ac_shader_config *config);
 112
 113 struct ac_rtld_upload_info {
 114         struct ac_rtld_binary *binary;
 115
 116         /** GPU mapping of the read/executable buffer. */
 117         uint64_t rx_va;
 118
 119         /** CPU mapping of the read/executable buffer */
 120         char *rx_ptr;
 121
 122         /** Optional callback function that will be queried for symbols not
 123          * defined in any of the binary's parts. */
 124         ac_rtld_get_external_symbol_cb get_external_symbol;
 125
 126         /** Caller-defined data that will be passed to callback functions. */
 127         void *cb_data;
 128 };
 129
 130 bool ac_rtld_upload(struct ac_rtld_upload_info *u);
 131
 132 #endif /* AC_RTLD_H */