src/compiler/spirv/spirv2nir.c

   1 /*
   2  * Copyright © 2015 Intel Corporation
   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
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  *
  23  * Authors:
  24  *    Jason Ekstrand (jason@jlekstrand.net)
  25  *
  26  */
  27
  28 /*
  29  * A simple executable that opens a SPIR-V shader, converts it to NIR, and
  30  * dumps out the result.  This should be useful for testing the
  31  * spirv_to_nir code.
  32  */
  33
  34 #include "spirv/nir_spirv.h"
  35
  36 #include <sys/mman.h>
  37 #include <sys/types.h>
  38 #include <fcntl.h>
  39 #include <unistd.h>
  40 #include <stdio.h>
  41 #include <errno.h>
  42 #include <string.h>
  43 #include <getopt.h>
  44
  45 #define WORD_SIZE 4
  46
  47 static gl_shader_stage
  48 stage_to_enum(char *stage)
  49 {
  50    if (!strcmp(stage, "vertex"))
  51       return MESA_SHADER_VERTEX;
  52    else if (!strcmp(stage, "tess-ctrl"))
  53       return MESA_SHADER_TESS_CTRL;
  54    else if (!strcmp(stage, "tess-eval"))
  55       return MESA_SHADER_TESS_EVAL;
  56    else if (!strcmp(stage, "geometry"))
  57       return MESA_SHADER_GEOMETRY;
  58    else if (!strcmp(stage, "fragment"))
  59       return MESA_SHADER_FRAGMENT;
  60    else if (!strcmp(stage, "compute"))
  61       return MESA_SHADER_COMPUTE;
  62    else if (!strcmp(stage, "kernel"))
  63       return MESA_SHADER_KERNEL;
  64    else
  65       return MESA_SHADER_NONE;
  66 }
  67
  68 static void
  69 print_usage(char *exec_name, FILE *f)
  70 {
  71    fprintf(f,
  72 "Usage: %s [options] file\n"
  73 "Options:\n"
  74 "  -h  --help              Print this help.\n"
  75 "  -s, --stage <stage>     Specify the shader stage.  Valid stages are:\n"
  76 "                          vertex, tess-ctrl, tess-eval, geometry, fragment,\n"
  77 "                          compute, and kernel (OpenCL-style compute).\n"
  78 "  -e, --entry <name>      Specify the entry-point name.\n"
  79    , exec_name);
  80 }
  81
  82 int main(int argc, char **argv)
  83 {
  84    gl_shader_stage shader_stage = MESA_SHADER_FRAGMENT;
  85    char *entry_point = "main";
  86    int ch;
  87
  88    static struct option long_options[] =
  89      {
  90        {"help",         no_argument, 0, 'h'},
  91        {"stage",  required_argument, 0, 's'},
  92        {"entry",  required_argument, 0, 'e'},
  93        {0, 0, 0, 0}
  94      };
  95
  96    while ((ch = getopt_long(argc, argv, "hs:e:", long_options, NULL)) != -1)
  97    {
  98       switch (ch)
  99       {
 100       case 'h':
 101          print_usage(argv[0], stdout);
 102          return 0;
 103       case 's':
 104          shader_stage = stage_to_enum(optarg);
 105          if (shader_stage == MESA_SHADER_NONE)
 106          {
 107             fprintf(stderr, "Unknown stage \"%s\"\n", optarg);
 108             print_usage(argv[0], stderr);
 109             return 1;
 110          }
 111          break;
 112       case 'e':
 113          entry_point = optarg;
 114          break;
 115       default:
 116          fprintf(stderr, "Unrecognized option \"%s\".\n", optarg);
 117          print_usage(argv[0], stderr);
 118          return 1;
 119       }
 120    }
 121
 122    const char *filename = argv[optind];
 123    int fd = open(filename, O_RDONLY);
 124    if (fd < 0)
 125    {
 126       fprintf(stderr, "Failed to open %s\n", filename);
 127       return 1;
 128    }
 129
 130    off_t len = lseek(fd, 0, SEEK_END);
 131    if (len % WORD_SIZE != 0)
 132    {
 133       fprintf(stderr, "File length isn't a multiple of the word size\n");
 134       fprintf(stderr, "Are you sure this is a valid SPIR-V shader?\n");
 135       close(fd);
 136       return 1;
 137    }
 138
 139    size_t word_count = len / WORD_SIZE;
 140
 141    const void *map = mmap(NULL, len, PROT_READ, MAP_PRIVATE, fd, 0);
 142    if (map == MAP_FAILED)
 143    {
 144       fprintf(stderr, "Failed to mmap the file: errno=%d, %s\n",
 145               errno, strerror(errno));
 146       close(fd);
 147       return 1;
 148    }
 149
 150    glsl_type_singleton_init_or_ref();
 151
 152    struct spirv_to_nir_options spirv_opts = {0};
 153    if (shader_stage == MESA_SHADER_KERNEL) {
 154       spirv_opts.environment = NIR_SPIRV_OPENCL;
 155       spirv_opts.caps.address = true;
 156       spirv_opts.caps.float64 = true;
 157       spirv_opts.caps.int8 = true;
 158       spirv_opts.caps.int16 = true;
 159       spirv_opts.caps.int64 = true;
 160       spirv_opts.caps.kernel = true;
 161    }
 162
 163    nir_shader *nir = spirv_to_nir(map, word_count, NULL, 0,
 164                                   shader_stage, entry_point,
 165                                   &spirv_opts, NULL);
 166
 167    if (nir)
 168       nir_print_shader(nir, stderr);
 169    else
 170       fprintf(stderr, "SPIRV to NIR compilation failed\n");
 171
 172    glsl_type_singleton_decref();
 173
 174    return 0;
 175 }