1/*
2 * Copyright © 2011 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
21 * DEALINGS IN THE SOFTWARE.
22 */
23
24/**
25 * \file test_optpass.cpp
26 *
27 * Standalone test for optimization passes.
28 *
29 * This file provides the "optpass" command for the standalone
30 * glsl_test app.  It accepts either GLSL or high-level IR as input,
31 * and performs the optimiation passes specified on the command line.
32 * It outputs the IR, both before and after optimiations.
33 */
34
35#include <string>
36#include <iostream>
37#include <sstream>
38#include <getopt.h>
39
40#include "ast.h"
41#include "ir_optimization.h"
42#include "program.h"
43#include "ir_reader.h"
44#include "standalone_scaffolding.h"
45#include "main/mtypes.h"
46
47using namespace std;
48
49static string read_stdin_to_eof()
50{
51   stringbuf sb;
52   cin.get(sb, '\0');
53   return sb.str();
54}
55
56static GLboolean
57do_optimization(struct exec_list *ir, const char *optimization,
58                const struct gl_shader_compiler_options *options)
59{
60   int int_0;
61   int int_1;
62   int int_2;
63   int int_3;
64   int int_4;
65
66   if (sscanf(optimization, "do_common_optimization ( %d ) ", &int_0) == 1) {
67      return do_common_optimization(ir, int_0 != 0, false, options, true);
68   } else if (strcmp(optimization, "do_algebraic") == 0) {
69      return do_algebraic(ir, true, options);
70   } else if (strcmp(optimization, "do_constant_folding") == 0) {
71      return do_constant_folding(ir);
72   } else if (strcmp(optimization, "do_constant_variable") == 0) {
73      return do_constant_variable(ir);
74   } else if (strcmp(optimization, "do_constant_variable_unlinked") == 0) {
75      return do_constant_variable_unlinked(ir);
76   } else if (strcmp(optimization, "do_copy_propagation_elements") == 0) {
77      return do_copy_propagation_elements(ir);
78   } else if (strcmp(optimization, "do_constant_propagation") == 0) {
79      return do_constant_propagation(ir);
80   } else if (strcmp(optimization, "do_dead_code") == 0) {
81      return do_dead_code(ir, false);
82   } else if (strcmp(optimization, "do_dead_code_local") == 0) {
83      return do_dead_code_local(ir);
84   } else if (strcmp(optimization, "do_dead_code_unlinked") == 0) {
85      return do_dead_code_unlinked(ir);
86   } else if (strcmp(optimization, "do_dead_functions") == 0) {
87      return do_dead_functions(ir);
88   } else if (strcmp(optimization, "do_function_inlining") == 0) {
89      return do_function_inlining(ir);
90   } else if (sscanf(optimization,
91                     "do_lower_jumps ( %d , %d , %d , %d , %d ) ",
92                     &int_0, &int_1, &int_2, &int_3, &int_4) == 5) {
93      return do_lower_jumps(ir, int_0 != 0, int_1 != 0, int_2 != 0,
94                            int_3 != 0, int_4 != 0);
95   } else if (strcmp(optimization, "do_lower_texture_projection") == 0) {
96      return do_lower_texture_projection(ir);
97   } else if (strcmp(optimization, "do_if_simplification") == 0) {
98      return do_if_simplification(ir);
99   } else if (sscanf(optimization, "lower_if_to_cond_assign ( %d ) ",
100                     &int_0) == 1) {
101      return lower_if_to_cond_assign(MESA_SHADER_VERTEX, ir, int_0);
102   } else if (strcmp(optimization, "do_mat_op_to_vec") == 0) {
103      return do_mat_op_to_vec(ir);
104   } else if (strcmp(optimization, "optimize_swizzles") == 0) {
105      return optimize_swizzles(ir);
106   } else if (strcmp(optimization, "do_structure_splitting") == 0) {
107      return do_structure_splitting(ir);
108   } else if (strcmp(optimization, "do_tree_grafting") == 0) {
109      return do_tree_grafting(ir);
110   } else if (strcmp(optimization, "do_vec_index_to_cond_assign") == 0) {
111      return do_vec_index_to_cond_assign(ir);
112   } else if (strcmp(optimization, "do_vec_index_to_swizzle") == 0) {
113      return do_vec_index_to_swizzle(ir);
114   } else if (strcmp(optimization, "lower_discard") == 0) {
115      return lower_discard(ir);
116   } else if (sscanf(optimization, "lower_instructions ( %d ) ",
117                     &int_0) == 1) {
118      return lower_instructions(ir, int_0);
119   } else if (strcmp(optimization, "lower_noise") == 0) {
120      return lower_noise(ir);
121   } else if (sscanf(optimization, "lower_variable_index_to_cond_assign "
122                     "( %d , %d , %d , %d ) ", &int_0, &int_1, &int_2,
123                     &int_3) == 4) {
124      return lower_variable_index_to_cond_assign(MESA_SHADER_VERTEX, ir,
125                                                 int_0 != 0, int_1 != 0,
126                                                 int_2 != 0, int_3 != 0);
127   } else if (sscanf(optimization, "lower_quadop_vector ( %d ) ",
128                     &int_0) == 1) {
129      return lower_quadop_vector(ir, int_0 != 0);
130   } else if (strcmp(optimization, "optimize_redundant_jumps") == 0) {
131      return optimize_redundant_jumps(ir);
132   } else {
133      printf("Unrecognized optimization %s\n", optimization);
134      exit(EXIT_FAILURE);
135      return false;
136   }
137}
138
139static GLboolean
140do_optimization_passes(struct exec_list *ir, char **optimizations,
141                       int num_optimizations, bool quiet,
142                       const struct gl_shader_compiler_options *options)
143{
144   GLboolean overall_progress = false;
145
146   for (int i = 0; i < num_optimizations; ++i) {
147      const char *optimization = optimizations[i];
148      if (!quiet) {
149         printf("*** Running optimization %s...", optimization);
150      }
151      GLboolean progress = do_optimization(ir, optimization, options);
152      if (!quiet) {
153         printf("%s\n", progress ? "progress" : "no progress");
154      }
155      validate_ir_tree(ir);
156
157      overall_progress = overall_progress || progress;
158   }
159
160   return overall_progress;
161}
162
163int test_optpass(int argc, char **argv)
164{
165   int input_format_ir = 0; /* 0=glsl, 1=ir */
166   int loop = 0;
167   int shader_type = GL_VERTEX_SHADER;
168   int quiet = 0;
169   int error;
170
171   const struct option optpass_opts[] = {
172      { "input-ir", no_argument, &input_format_ir, 1 },
173      { "input-glsl", no_argument, &input_format_ir, 0 },
174      { "loop", no_argument, &loop, 1 },
175      { "vertex-shader", no_argument, &shader_type, GL_VERTEX_SHADER },
176      { "fragment-shader", no_argument, &shader_type, GL_FRAGMENT_SHADER },
177      { "quiet", no_argument, &quiet, 1 },
178      { NULL, 0, NULL, 0 }
179   };
180
181   int idx = 0;
182   int c;
183   while ((c = getopt_long(argc, argv, "", optpass_opts, &idx)) != -1) {
184      if (c != 0) {
185         printf("*** usage: %s optpass <optimizations> <options>\n", argv[0]);
186         printf("\n");
187         printf("Possible options are:\n");
188         printf("  --input-ir: input format is IR\n");
189         printf("  --input-glsl: input format is GLSL (the default)\n");
190         printf("  --loop: run optimizations repeatedly until no progress\n");
191         printf("  --vertex-shader: test with a vertex shader (the default)\n");
192         printf("  --fragment-shader: test with a fragment shader\n");
193         exit(EXIT_FAILURE);
194      }
195   }
196
197   struct gl_context local_ctx;
198   struct gl_context *ctx = &local_ctx;
199   initialize_context_to_defaults(ctx, API_OPENGL_COMPAT);
200
201   ir_variable::temporaries_allocate_names = true;
202
203   struct gl_shader *shader = rzalloc(NULL, struct gl_shader);
204   shader->Type = shader_type;
205   shader->Stage = _mesa_shader_enum_to_shader_stage(shader_type);
206
207   string input = read_stdin_to_eof();
208
209   struct _mesa_glsl_parse_state *state
210      = new(shader) _mesa_glsl_parse_state(ctx, shader->Stage, shader);
211
212   if (input_format_ir) {
213      shader->ir = new(shader) exec_list;
214      _mesa_glsl_initialize_types(state);
215      _mesa_glsl_read_ir(state, shader->ir, input.c_str(), true);
216   } else {
217      shader->Source = input.c_str();
218      const char *source = shader->Source;
219      state->error = glcpp_preprocess(state, &source, &state->info_log,
220                                      NULL, NULL, ctx) != 0;
221
222      if (!state->error) {
223         _mesa_glsl_lexer_ctor(state, source);
224         _mesa_glsl_parse(state);
225         _mesa_glsl_lexer_dtor(state);
226      }
227
228      shader->ir = new(shader) exec_list;
229      if (!state->error && !state->translation_unit.is_empty())
230         _mesa_ast_to_hir(shader->ir, state);
231   }
232
233   /* Print out the initial IR */
234   if (!state->error && !quiet) {
235      printf("*** pre-optimization IR:\n");
236      _mesa_print_ir(stdout, shader->ir, state);
237      printf("\n--\n");
238   }
239
240   /* Optimization passes */
241   if (!state->error) {
242      GLboolean progress;
243      const struct gl_shader_compiler_options *options =
244         &ctx->Const.ShaderCompilerOptions[_mesa_shader_enum_to_shader_stage(shader_type)];
245      do {
246         progress = do_optimization_passes(shader->ir, &argv[optind],
247                                           argc - optind, quiet != 0, options);
248      } while (loop && progress);
249   }
250
251   /* Print out the resulting IR */
252   if (!state->error) {
253      if (!quiet) {
254         printf("*** resulting IR:\n");
255      }
256      _mesa_print_ir(stdout, shader->ir, state);
257      if (!quiet) {
258         printf("\n--\n");
259      }
260   }
261
262   if (state->error) {
263      printf("*** error(s) occurred:\n");
264      printf("%s\n", state->info_log);
265      printf("--\n");
266   }
267
268   error = state->error;
269
270   ralloc_free(state);
271   ralloc_free(shader);
272
273   return error;
274}
275
276