glsl: Add a file argument to the IR printer.

While we want to be able to print to stdout for glsl_compiler, for
debugging drivers we want to be able to dump to stderr because that's
where other driver debug (like LIBGL_DEBUG) tends to go, and because some
apps actually close stdout to shut up their own messages (such as the X
Server, or NWN).

Reviewed-by: Ian Romanick <ian.d.romanick@intel.com>
Reviewed-by: Kenneth Graunke <kenneth@whitecape.org>
Reviewed-by: Matt Turner <mattst88@gmail.com>

src/glsl/glsl_parser_extras.cpp

@@ -1434,7 +1434,7 @@ _mesa_glsl_compile_shader(struct gl_context *ctx, struct gl_shader *shader,
 
       /* Print out the unoptimized IR. */
       if (dump_hir) {
-         _mesa_print_ir(shader->ir, state);
+         _mesa_print_ir(stdout, shader->ir, state);
       }
    }
 

src/glsl/ir.h

@@ -106,6 +106,7 @@ public:
 
    /** ir_print_visitor helper for debugging. */
    void print(void) const;
+   void fprint(FILE *f) const;
 
    virtual void accept(ir_visitor *) = 0;
    virtual ir_visitor_status accept(ir_hierarchical_visitor *) = 0;
@@ -2353,7 +2354,7 @@ mode_string(const ir_variable *var);
 extern "C" {
 #endif /* __cplusplus */
 
-extern void _mesa_print_ir(struct exec_list *instructions,
+extern void _mesa_print_ir(FILE *f, struct exec_list *instructions,
                            struct _mesa_glsl_parse_state *state);
 
 #ifdef __cplusplus

src/glsl/ir_print_visitor.cpp

@@ -27,52 +27,59 @@
 #include "main/macros.h"
 #include "program/hash_table.h"
 
-static void print_type(const glsl_type *t);
+static void print_type(FILE *f, const glsl_type *t);
 
 void
 ir_instruction::print(void) const
+{
+   this->fprint(stdout);
+}
+
+void
+ir_instruction::fprint(FILE *f) const
 {
    ir_instruction *deconsted = const_cast<ir_instruction *>(this);
 
-   ir_print_visitor v;
+   ir_print_visitor v(f);
    deconsted->accept(&v);
 }
 
 extern "C" {
 void
-_mesa_print_ir(exec_list *instructions,
+_mesa_print_ir(FILE *f, exec_list *instructions,
 	       struct _mesa_glsl_parse_state *state)
 {
    if (state) {
       for (unsigned i = 0; i < state->num_user_structures; i++) {
 	 const glsl_type *const s = state->user_structures[i];
 
-	 printf("(structure (%s) (%s@%p) (%u) (\n",
-		s->name, s->name, (void *) s, s->length);
+	 fprintf(f, "(structure (%s) (%s@%p) (%u) (\n",
+                 s->name, s->name, (void *) s, s->length);
 
 	 for (unsigned j = 0; j < s->length; j++) {
-	    printf("\t((");
-	    print_type(s->fields.structure[j].type);
-	    printf(")(%s))\n", s->fields.structure[j].name);
+	    fprintf(f, "\t((");
+	    print_type(f, s->fields.structure[j].type);
+	    fprintf(f, ")(%s))\n", s->fields.structure[j].name);
 	 }
 
-	 printf(")\n");
+	 fprintf(f, ")\n");
       }
    }
 
-   printf("(\n");
+   fprintf(f, "(\n");
    foreach_list(n, instructions) {
       ir_instruction *ir = (ir_instruction *) n;
-      ir->print();
+      ir->fprint(f);
       if (ir->ir_type != ir_type_function)
-	 printf("\n");
+	 fprintf(f, "\n");
    }
-   printf("\n)");
+   fprintf(f, "\n)");
 }
 
 } /* extern "C" */
 
-ir_print_visitor::ir_print_visitor()
+ir_print_visitor::ir_print_visitor(FILE *f)
+   : f(f)
 {
    indentation = 0;
    printable_names =
@@ -91,7 +98,7 @@ ir_print_visitor::~ir_print_visitor()
 void ir_print_visitor::indent(void)
 {
    for (int i = 0; i < indentation; i++)
-      printf("  ");
+      fprintf(f, "  ");
 }
 
 const char *
@@ -125,28 +132,28 @@ ir_print_visitor::unique_name(ir_variable *var)
 }
 
 static void
-print_type(const glsl_type *t)
+print_type(FILE *f, const glsl_type *t)
 {
    if (t->base_type == GLSL_TYPE_ARRAY) {
-      printf("(array ");
-      print_type(t->fields.array);
-      printf(" %u)", t->length);
+      fprintf(f, "(array ");
+      print_type(f, t->fields.array);
+      fprintf(f, " %u)", t->length);
    } else if ((t->base_type == GLSL_TYPE_STRUCT)
 	      && (strncmp("gl_", t->name, 3) != 0)) {
-      printf("%s@%p", t->name, (void *) t);
+      fprintf(f, "%s@%p", t->name, (void *) t);
    } else {
-      printf("%s", t->name);
+      fprintf(f, "%s", t->name);
    }
 }
 
 void ir_print_visitor::visit(ir_rvalue *ir)
 {
-   printf("error");
+   fprintf(f, "error");
 }
 
 void ir_print_visitor::visit(ir_variable *ir)
 {
-   printf("(declare ");
+   fprintf(f, "(declare ");
 
    const char *const cent = (ir->data.centroid) ? "centroid " : "";
    const char *const samp = (ir->data.sample) ? "sample " : "";
@@ -158,25 +165,25 @@ void ir_print_visitor::visit(ir_variable *ir)
    const char *const interp[] = { "", "smooth", "flat", "noperspective" };
    STATIC_ASSERT(ARRAY_SIZE(interp) == INTERP_QUALIFIER_COUNT);
 
-   printf("(%s%s%s%s%s) ",
+   fprintf(f, "(%s%s%s%s%s) ",
 	  cent, samp, inv, mode[ir->data.mode], interp[ir->data.interpolation]);
 
-   print_type(ir->type);
-   printf(" %s)", unique_name(ir));
+   print_type(f, ir->type);
+   fprintf(f, " %s)", unique_name(ir));
 }
 
 
 void ir_print_visitor::visit(ir_function_signature *ir)
 {
    _mesa_symbol_table_push_scope(symbols);
-   printf("(signature ");
+   fprintf(f, "(signature ");
    indentation++;
 
-   print_type(ir->return_type);
-   printf("\n");
+   print_type(f, ir->return_type);
+   fprintf(f, "\n");
    indent();
 
-   printf("(parameters\n");
+   fprintf(f, "(parameters\n");
    indentation++;
 
    foreach_list(n, &ir->parameters) {
@@ -184,16 +191,16 @@ void ir_print_visitor::visit(ir_function_signature *ir)
 
       indent();
       inst->accept(this);
-      printf("\n");
+      fprintf(f, "\n");
    }
    indentation--;
 
    indent();
-   printf(")\n");
+   fprintf(f, ")\n");
 
    indent();
 
-   printf("(\n");
+   fprintf(f, "(\n");
    indentation++;
 
    foreach_list(n, &ir->body) {
@@ -201,11 +208,11 @@ void ir_print_visitor::visit(ir_function_signature *ir)
 
       indent();
       inst->accept(this);
-      printf("\n");
+      fprintf(f, "\n");
    }
    indentation--;
    indent();
-   printf("))\n");
+   fprintf(f, "))\n");
    indentation--;
    _mesa_symbol_table_pop_scope(symbols);
 }
@@ -213,58 +220,58 @@ void ir_print_visitor::visit(ir_function_signature *ir)
 
 void ir_print_visitor::visit(ir_function *ir)
 {
-   printf("(function %s\n", ir->name);
+   fprintf(f, "(function %s\n", ir->name);
    indentation++;
    foreach_list(n, &ir->signatures) {
       ir_function_signature *const sig = (ir_function_signature *) n;
       indent();
       sig->accept(this);
-      printf("\n");
+      fprintf(f, "\n");
    }
    indentation--;
    indent();
-   printf(")\n\n");
+   fprintf(f, ")\n\n");
 }
 
 
 void ir_print_visitor::visit(ir_expression *ir)
 {
-   printf("(expression ");
+   fprintf(f, "(expression ");
 
-   print_type(ir->type);
+   print_type(f, ir->type);
 
-   printf(" %s ", ir->operator_string());
+   fprintf(f, " %s ", ir->operator_string());
 
    for (unsigned i = 0; i < ir->get_num_operands(); i++) {
       ir->operands[i]->accept(this);
    }
 
-   printf(") ");
+   fprintf(f, ") ");
 }
 
 
 void ir_print_visitor::visit(ir_texture *ir)
 {
-   printf("(%s ", ir->opcode_string());
+   fprintf(f, "(%s ", ir->opcode_string());
 
-   print_type(ir->type);
-   printf(" ");
+   print_type(f, ir->type);
+   fprintf(f, " ");
 
    ir->sampler->accept(this);
-   printf(" ");
+   fprintf(f, " ");
 
    if (ir->op != ir_txs && ir->op != ir_query_levels) {
       ir->coordinate->accept(this);
 
-      printf(" ");
+      fprintf(f, " ");
 
       if (ir->offset != NULL) {
 	 ir->offset->accept(this);
       } else {
-	 printf("0");
+	 fprintf(f, "0");
       }
 
-      printf(" ");
+      fprintf(f, " ");
    }
 
    if (ir->op != ir_txf && ir->op != ir_txf_ms &&
@@ -273,17 +280,17 @@ void ir_print_visitor::visit(ir_texture *ir)
       if (ir->projector)
 	 ir->projector->accept(this);
       else
-	 printf("1");
+	 fprintf(f, "1");
 
       if (ir->shadow_comparitor) {
-	 printf(" ");
+	 fprintf(f, " ");
 	 ir->shadow_comparitor->accept(this);
       } else {
-	 printf(" ()");
+	 fprintf(f, " ()");
       }
    }
 
-   printf(" ");
+   fprintf(f, " ");
    switch (ir->op)
    {
    case ir_tex:
@@ -302,17 +309,17 @@ void ir_print_visitor::visit(ir_texture *ir)
       ir->lod_info.sample_index->accept(this);
       break;
    case ir_txd:
-      printf("(");
+      fprintf(f, "(");
       ir->lod_info.grad.dPdx->accept(this);
-      printf(" ");
+      fprintf(f, " ");
       ir->lod_info.grad.dPdy->accept(this);
-      printf(")");
+      fprintf(f, ")");
       break;
    case ir_tg4:
       ir->lod_info.component->accept(this);
       break;
    };
-   printf(")");
+   fprintf(f, ")");
 }
 
 
@@ -325,43 +332,43 @@ void ir_print_visitor::visit(ir_swizzle *ir)
       ir->mask.w,
    };
 
-   printf("(swiz ");
+   fprintf(f, "(swiz ");
    for (unsigned i = 0; i < ir->mask.num_components; i++) {
-      printf("%c", "xyzw"[swiz[i]]);
+      fprintf(f, "%c", "xyzw"[swiz[i]]);
    }
-   printf(" ");
+   fprintf(f, " ");
    ir->val->accept(this);
-   printf(")");
+   fprintf(f, ")");
 }
 
 
 void ir_print_visitor::visit(ir_dereference_variable *ir)
 {
    ir_variable *var = ir->variable_referenced();
-   printf("(var_ref %s) ", unique_name(var));
+   fprintf(f, "(var_ref %s) ", unique_name(var));
 }
 
 
 void ir_print_visitor::visit(ir_dereference_array *ir)
 {
-   printf("(array_ref ");
+   fprintf(f, "(array_ref ");
    ir->array->accept(this);
    ir->array_index->accept(this);
-   printf(") ");
+   fprintf(f, ") ");
 }
 
 
 void ir_print_visitor::visit(ir_dereference_record *ir)
 {
-   printf("(record_ref ");
+   fprintf(f, "(record_ref ");
    ir->record->accept(this);
-   printf(" %s) ", ir->field);
+   fprintf(f, " %s) ", ir->field);
 }
 
 
 void ir_print_visitor::visit(ir_assignment *ir)
 {
-   printf("(assign ");
+   fprintf(f, "(assign ");
 
    if (ir->condition)
       ir->condition->accept(this);
@@ -377,22 +384,22 @@ void ir_print_visitor::visit(ir_assignment *ir)
    }
    mask[j] = '\0';
 
-   printf(" (%s) ", mask);
+   fprintf(f, " (%s) ", mask);
 
    ir->lhs->accept(this);
 
-   printf(" ");
+   fprintf(f, " ");
 
    ir->rhs->accept(this);
-   printf(") ");
+   fprintf(f, ") ");
 }
 
 
 void ir_print_visitor::visit(ir_constant *ir)
 {
-   printf("(constant ");
-   print_type(ir->type);
-   printf(" (");
+   fprintf(f, "(constant ");
+   print_type(f, ir->type);
+   fprintf(f, " (");
 
    if (ir->type->is_array()) {
       for (unsigned i = 0; i < ir->type->length; i++)
@@ -400,91 +407,91 @@ void ir_print_visitor::visit(ir_constant *ir)
    } else if (ir->type->is_record()) {
       ir_constant *value = (ir_constant *) ir->components.get_head();
       for (unsigned i = 0; i < ir->type->length; i++) {
-	 printf("(%s ", ir->type->fields.structure[i].name);
+	 fprintf(f, "(%s ", ir->type->fields.structure[i].name);
 	 value->accept(this);
-	 printf(")");
+	 fprintf(f, ")");
 
 	 value = (ir_constant *) value->next;
       }
    } else {
       for (unsigned i = 0; i < ir->type->components(); i++) {
 	 if (i != 0)
-	    printf(" ");
+	    fprintf(f, " ");
 	 switch (ir->type->base_type) {
-	 case GLSL_TYPE_UINT:  printf("%u", ir->value.u[i]); break;
-	 case GLSL_TYPE_INT:   printf("%d", ir->value.i[i]); break;
+	 case GLSL_TYPE_UINT:  fprintf(f, "%u", ir->value.u[i]); break;
+	 case GLSL_TYPE_INT:   fprintf(f, "%d", ir->value.i[i]); break;
 	 case GLSL_TYPE_FLOAT:
             if (ir->value.f[i] == 0.0f)
                /* 0.0 == -0.0, so print with %f to get the proper sign. */
-               printf("%.1f", ir->value.f[i]);
+               fprintf(f, "%.1f", ir->value.f[i]);
             else if (fabs(ir->value.f[i]) < 0.000001f)
-               printf("%a", ir->value.f[i]);
+               fprintf(f, "%a", ir->value.f[i]);
             else if (fabs(ir->value.f[i]) > 1000000.0f)
-               printf("%e", ir->value.f[i]);
+               fprintf(f, "%e", ir->value.f[i]);
             else
-               printf("%f", ir->value.f[i]);
+               fprintf(f, "%f", ir->value.f[i]);
             break;
-	 case GLSL_TYPE_BOOL:  printf("%d", ir->value.b[i]); break;
+	 case GLSL_TYPE_BOOL:  fprintf(f, "%d", ir->value.b[i]); break;
 	 default: assert(0);
 	 }
       }
    }
-   printf(")) ");
+   fprintf(f, ")) ");
 }
 
 
 void
 ir_print_visitor::visit(ir_call *ir)
 {
-   printf("(call %s ", ir->callee_name());
+   fprintf(f, "(call %s ", ir->callee_name());
    if (ir->return_deref)
       ir->return_deref->accept(this);
-   printf(" (");
+   fprintf(f, " (");
    foreach_list(n, &ir->actual_parameters) {
       ir_rvalue *const param = (ir_rvalue *) n;
 
       param->accept(this);
    }
-   printf("))\n");
+   fprintf(f, "))\n");
 }
 
 
 void
 ir_print_visitor::visit(ir_return *ir)
 {
-   printf("(return");
+   fprintf(f, "(return");
 
    ir_rvalue *const value = ir->get_value();
    if (value) {
-      printf(" ");
+      fprintf(f, " ");
       value->accept(this);
    }
 
-   printf(")");
+   fprintf(f, ")");
 }
 
 
 void
 ir_print_visitor::visit(ir_discard *ir)
 {
-   printf("(discard ");
+   fprintf(f, "(discard ");
 
    if (ir->condition != NULL) {
-      printf(" ");
+      fprintf(f, " ");
       ir->condition->accept(this);
    }
 
-   printf(")");
+   fprintf(f, ")");
 }
 
 
 void
 ir_print_visitor::visit(ir_if *ir)
 {
-   printf("(if ");
+   fprintf(f, "(if ");
    ir->condition->accept(this);
 
-   printf("(\n");
+   fprintf(f, "(\n");
    indentation++;
 
    foreach_list(n, &ir->then_instructions) {
@@ -492,16 +499,16 @@ ir_print_visitor::visit(ir_if *ir)
 
       indent();
       inst->accept(this);
-      printf("\n");
+      fprintf(f, "\n");
    }
 
    indentation--;
    indent();
-   printf(")\n");
+   fprintf(f, ")\n");
 
    indent();
    if (!ir->else_instructions.is_empty()) {
-      printf("(\n");
+      fprintf(f, "(\n");
       indentation++;
 
       foreach_list(n, &ir->else_instructions) {
@@ -509,13 +516,13 @@ ir_print_visitor::visit(ir_if *ir)
 
 	 indent();
 	 inst->accept(this);
-	 printf("\n");
+	 fprintf(f, "\n");
       }
       indentation--;
       indent();
-      printf("))\n");
+      fprintf(f, "))\n");
    } else {
-      printf("())\n");
+      fprintf(f, "())\n");
    }
 }
 
@@ -523,7 +530,7 @@ ir_print_visitor::visit(ir_if *ir)
 void
 ir_print_visitor::visit(ir_loop *ir)
 {
-   printf("(loop (\n");
+   fprintf(f, "(loop (\n");
    indentation++;
 
    foreach_list(n, &ir->body_instructions) {
@@ -531,28 +538,28 @@ ir_print_visitor::visit(ir_loop *ir)
 
       indent();
       inst->accept(this);
-      printf("\n");
+      fprintf(f, "\n");
    }
    indentation--;
    indent();
-   printf("))\n");
+   fprintf(f, "))\n");
 }
 
 
 void
 ir_print_visitor::visit(ir_loop_jump *ir)
 {
-   printf("%s", ir->is_break() ? "break" : "continue");
+   fprintf(f, "%s", ir->is_break() ? "break" : "continue");
 }
 
 void
 ir_print_visitor::visit(ir_emit_vertex *ir)
 {
-   printf("(emit-vertex)");
+   fprintf(f, "(emit-vertex)");
 }
 
 void
 ir_print_visitor::visit(ir_end_primitive *ir)
 {
-   printf("(end-primitive)");
+   fprintf(f, "(end-primitive)");
 }

src/glsl/ir_print_visitor.h

@@ -38,7 +38,7 @@ extern "C" {
  */
 class ir_print_visitor : public ir_visitor {
 public:
-   ir_print_visitor();
+   ir_print_visitor(FILE *f);
    virtual ~ir_print_visitor();
 
    void indent(void);
@@ -87,6 +87,7 @@ private:
    _mesa_symbol_table *symbols;
 
    void *mem_ctx;
+   FILE *f;
 
    int indentation;
 };

src/glsl/main.cpp

@@ -294,7 +294,7 @@ compile_shader(struct gl_context *ctx, struct gl_shader *shader)
 
    /* Print out the resulting IR */
    if (!state->error && dump_lir) {
-      _mesa_print_ir(shader->ir, state);
+      _mesa_print_ir(stdout, shader->ir, state);
    }
 
    return;

src/glsl/opt_array_splitting.cpp

@@ -400,7 +400,7 @@ optimize_split_arrays(exec_list *instructions, bool linked)
    visit_list_elements(&split, instructions);
 
    if (debug)
-      _mesa_print_ir(instructions, NULL);
+      _mesa_print_ir(stdout, instructions, NULL);
 
    ralloc_free(mem_ctx);
 

src/glsl/test_optpass.cpp

@@ -235,7 +235,7 @@ int test_optpass(int argc, char **argv)
    /* Print out the initial IR */
    if (!state->error && !quiet) {
       printf("*** pre-optimization IR:\n");
-      _mesa_print_ir(shader->ir, state);
+      _mesa_print_ir(stdout, shader->ir, state);
       printf("\n--\n");
    }
 
@@ -255,7 +255,7 @@ int test_optpass(int argc, char **argv)
       if (!quiet) {
          printf("*** resulting IR:\n");
       }
-      _mesa_print_ir(shader->ir, state);
+      _mesa_print_ir(stdout, shader->ir, state);
       if (!quiet) {
          printf("\n--\n");
       }

src/mesa/drivers/dri/i965/brw_program.c

@@ -593,7 +593,7 @@ brw_dump_ir(struct brw_context *brw, const char *stage,
 {
    if (shader_prog) {
       printf("GLSL IR for native %s shader %d:\n", stage, shader_prog->Name);
-      _mesa_print_ir(shader->ir, NULL);
+      _mesa_print_ir(stdout, shader->ir, NULL);
       printf("\n\n");
    } else {
       printf("ARB_%s_program %d ir for native %s shader\n",

src/mesa/drivers/dri/i965/brw_shader.cpp

@@ -255,7 +255,7 @@ brw_link_shader(struct gl_context *ctx, struct gl_shader_program *shProg)
          printf("GLSL IR for linked %s program %d:\n",
                 _mesa_shader_stage_to_string(shader->base.Stage),
                 shProg->Name);
-         _mesa_print_ir(shader->base.ir, NULL);
+         _mesa_print_ir(stdout, shader->base.ir, NULL);
          printf("\n");
       }
    }

src/mesa/main/shaderapi.c

@@ -855,7 +855,7 @@ compile_shader(struct gl_context *ctx, GLuint shaderObj)
       if (ctx->Shader.Flags & GLSL_DUMP) {
          if (sh->CompileStatus) {
             printf("GLSL IR for shader %d:\n", sh->Name);
-            _mesa_print_ir(sh->ir, NULL);
+            _mesa_print_ir(stdout, sh->ir, NULL);
             printf("\n\n");
          } else {
             printf("GLSL shader %d failed to compile.\n", sh->Name);

src/mesa/program/ir_to_mesa.cpp

@@ -2921,7 +2921,7 @@ get_mesa_program(struct gl_context *ctx,
       printf("\n");
       printf("GLSL IR for linked %s program %d:\n", target_string,
 	     shader_program->Name);
-      _mesa_print_ir(shader->ir, NULL);
+      _mesa_print_ir(stdout, shader->ir, NULL);
       printf("\n");
       printf("\n");
       printf("Mesa IR for linked %s program %d:\n", target_string,