src/amd/common/ac_binary.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 #pragma once
  28
  29 #include <stdint.h>
  30 #include <stdbool.h>
  31
  32 struct ac_shader_reloc {
  33         char name[32];
  34         uint64_t offset;
  35 };
  36
  37 struct ac_shader_binary {
  38         /** Shader code */
  39         unsigned char *code;
  40         unsigned code_size;
  41
  42         /** Config/Context register state that accompanies this shader.
  43          * This is a stream of dword pairs.  First dword contains the
  44          * register address, the second dword contains the value.*/
  45         unsigned char *config;
  46         unsigned config_size;
  47
  48         /** The number of bytes of config information for each global symbol.
  49          */
  50         unsigned config_size_per_symbol;
  51
  52         /** Constant data accessed by the shader.  This will be uploaded
  53          * into a constant buffer. */
  54         unsigned char *rodata;
  55         unsigned rodata_size;
  56
  57         /** List of symbol offsets for the shader */
  58         uint64_t *global_symbol_offsets;
  59         unsigned global_symbol_count;
  60
  61         struct ac_shader_reloc *relocs;
  62         unsigned reloc_count;
  63
  64         /** Disassembled shader in a string. */
  65         char *disasm_string;
  66         char *llvm_ir_string;
  67 };
  68
  69 struct ac_shader_config {
  70         unsigned num_sgprs;
  71         unsigned num_vgprs;
  72         unsigned spilled_sgprs;
  73         unsigned spilled_vgprs;
  74         unsigned lds_size;
  75         unsigned spi_ps_input_ena;
  76         unsigned spi_ps_input_addr;
  77         unsigned float_mode;
  78         unsigned scratch_bytes_per_wave;
  79 };
  80
  81 /*
  82  * Parse the elf binary stored in \p elf_data and create a
  83  * ac_shader_binary object.
  84  */
  85 void ac_elf_read(const char *elf_data, unsigned elf_size,
  86                  struct ac_shader_binary *binary);
  87
  88 /**
  89  * @returns A pointer to the start of the configuration information for
  90  * the function starting at \p symbol_offset of the binary.
  91  */
  92 const unsigned char *ac_shader_binary_config_start(
  93         const struct ac_shader_binary *binary,
  94         uint64_t symbol_offset);
  95
  96 void ac_shader_binary_read_config(struct ac_shader_binary *binary,
  97                                   struct ac_shader_config *conf,
  98                                   unsigned symbol_offset,
  99                                   bool supports_spill);