]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/validate.cpp
Use default member initializers for simple types
[libs/gl.git] / source / glsl / validate.cpp
index 154189aa2bc8c353398b9b92a6a521c47c5afe59..0c4b98cbb2c8fd9de87ec21b553d911febde227a 100644 (file)
@@ -3,6 +3,7 @@
 #include <msp/core/raii.h>
 #include <msp/strings/format.h>
 #include <msp/strings/utils.h>
+#include "reflect.h"
 #include "validate.h"
 
 using namespace std;
@@ -11,11 +12,6 @@ namespace Msp {
 namespace GL {
 namespace SL {
 
-Validator::Validator():
-       stage(0),
-       last_provoker(0)
-{ }
-
 void Validator::diagnose(Node &node, Node &provoking_node, Diagnostic::Severity severity, const string &message)
 {
        Diagnostic diag;
@@ -38,13 +34,6 @@ void Validator::add_info(Node &node, const string &message)
 }
 
 
-DeclarationValidator::DeclarationValidator():
-       scope(GLOBAL),
-       iface_layout(0),
-       iface_block(0),
-       variable(0)
-{ }
-
 const char *DeclarationValidator::describe_variable(ScopeType scope)
 {
        switch(scope)
@@ -60,27 +49,37 @@ const char *DeclarationValidator::describe_variable(ScopeType scope)
 
 void DeclarationValidator::visit(Layout &layout)
 {
-       for(vector<Layout::Qualifier>::const_iterator i=layout.qualifiers.begin(); i!=layout.qualifiers.end(); ++i)
+       for(const Layout::Qualifier &q: layout.qualifiers)
        {
                bool allowed = false;
                string err_descr;
                bool value = true;
-               if(i->name=="location")
+               if(q.name=="location")
                        allowed = (variable && scope==GLOBAL);
-               else if(i->name=="binding" || i->name=="set")
+               else if(q.name=="binding" || q.name=="set")
                {
+                       if(q.name=="set")
+                       {
+                               error(layout, "Layout qualifier 'set' not allowed when targeting OpenGL");
+                               continue;
+                       }
+
                        if(variable)
                        {
                                TypeDeclaration *type = variable->type_declaration;
                                while(BasicTypeDeclaration *basic = dynamic_cast<BasicTypeDeclaration *>(type))
                                        type = basic->base_type;
-                               allowed = (scope==GLOBAL && dynamic_cast<ImageTypeDeclaration *>(type));
-                               err_descr = "variable of non-opaque type";
+                               bool uniform = (variable->interface=="uniform");
+                               allowed = (scope==GLOBAL && uniform && dynamic_cast<ImageTypeDeclaration *>(type));
+                               err_descr = (uniform ? "variable of non-opaque type" : "non-uniform variable");
                        }
                        else if(iface_block)
-                               allowed = true;
+                       {
+                               allowed = (iface_block->interface=="uniform");
+                               err_descr = "non-uniform interface block";
+                       }
                }
-               else if(i->name=="constant_id")
+               else if(q.name=="constant_id")
                {
                        allowed = (variable && scope==GLOBAL);
                        if(allowed)
@@ -102,32 +101,46 @@ void DeclarationValidator::visit(Layout &layout)
                                }
                        }
                }
-               else if(i->name=="offset")
-                       allowed = (variable && scope==INTERFACE_BLOCK);
-               else if(i->name=="points")
+               else if(q.name=="offset")
+                       allowed = (variable && scope==INTERFACE_BLOCK && iface_block->interface=="uniform");
+               else if(q.name=="align")
+                       allowed = (scope==INTERFACE_BLOCK && iface_block->interface=="uniform");
+               else if(q.name=="points")
                {
                        allowed = (stage->type==Stage::GEOMETRY && iface_layout && (iface_layout->interface=="in" || iface_layout->interface=="out"));
                        value = false;
                }
-               else if(i->name=="lines" || i->name=="lines_adjacency" || i->name=="triangles" || i->name=="triangles_adjacency")
+               else if(q.name=="lines" || q.name=="lines_adjacency" || q.name=="triangles" || q.name=="triangles_adjacency")
                {
                        allowed = (stage->type==Stage::GEOMETRY && iface_layout && iface_layout->interface=="in");
                        value = false;
                }
-               else if(i->name=="line_strip" || i->name=="triangle_strip")
+               else if(q.name=="line_strip" || q.name=="triangle_strip")
                {
                        allowed = (stage->type==Stage::GEOMETRY && iface_layout && iface_layout->interface=="out");
                        value = false;
                }
-               else if(i->name=="invocations")
+               else if(q.name=="invocations")
                        allowed = (stage->type==Stage::GEOMETRY && iface_layout && iface_layout->interface=="in");
-               else if(i->name=="max_vertices")
+               else if(q.name=="max_vertices")
                        allowed = (stage->type==Stage::GEOMETRY && iface_layout && iface_layout->interface=="out");
-               else if(i->name=="std140" || i->name=="std430")
+               else if(q.name=="std140" || q.name=="std430")
                {
                        allowed = (iface_block && !variable && iface_block->interface=="uniform");
                        value = false;
                }
+               else if(q.name=="column_major" || q.name=="row_major")
+               {
+                       allowed = (variable && scope==INTERFACE_BLOCK);
+                       if(allowed)
+                       {
+                               BasicTypeDeclaration *basic = dynamic_cast<BasicTypeDeclaration *>(variable->type_declaration);
+                               while(basic && basic->kind==BasicTypeDeclaration::ARRAY)
+                                       basic = dynamic_cast<BasicTypeDeclaration *>(basic->base_type);
+                               allowed = (basic && basic->kind==BasicTypeDeclaration::MATRIX);
+                               err_descr = "non-matrix variable";
+                       }
+               }
 
                if(!allowed)
                {
@@ -142,12 +155,12 @@ void DeclarationValidator::visit(Layout &layout)
                                else
                                        err_descr = "unknown declaration";
                        }
-                       error(layout, format("Layout qualifier '%s' not allowed on %s", i->name, err_descr));
+                       error(layout, format("Layout qualifier '%s' not allowed on %s", q.name, err_descr));
                }
-               else if(value && !i->has_value)
-                       error(layout, format("Layout qualifier '%s' requires a value", i->name));
-               else if(!value && i->has_value)
-                       error(layout, format("Layout qualifier '%s' does not allow a value", i->name));
+               else if(value && !q.has_value)
+                       error(layout, format("Layout qualifier '%s' requires a value", q.name));
+               else if(!value && q.has_value)
+                       error(layout, format("Layout qualifier '%s' does not allow a value", q.name));
        }
 }
 
@@ -203,6 +216,8 @@ void DeclarationValidator::visit(VariableDeclaration &var)
        {
                if(scope==STRUCT || scope==INTERFACE_BLOCK)
                        error(var, format("Constant qualifier not allowed on %s", descr));
+               if(!var.init_expression)
+                       error(var, "Constant variable must have an initializer");
        }
 
        if(!var.interpolation.empty() || !var.sampling.empty())
@@ -224,8 +239,12 @@ void DeclarationValidator::visit(VariableDeclaration &var)
        }
 
        TypeDeclaration *type = var.type_declaration;
+       BasicTypeDeclaration::Kind kind = BasicTypeDeclaration::ALIAS;
        while(BasicTypeDeclaration *basic = dynamic_cast<BasicTypeDeclaration *>(type))
+       {
+               kind = basic->kind;
                type = basic->base_type;
+       }
        if(dynamic_cast<ImageTypeDeclaration *>(type))
        {
                if(scope!=GLOBAL && scope!=FUNCTION_PARAM)
@@ -233,6 +252,10 @@ void DeclarationValidator::visit(VariableDeclaration &var)
                else if(scope==GLOBAL && var.interface!="uniform")
                        error(var, format("Type '%s' only allowed with uniform interface", type->name));
        }
+       else if(kind==BasicTypeDeclaration::VOID)
+               error(var, "Type 'void' not allowed on variable");
+       else if(kind==BasicTypeDeclaration::BOOL && !var.interface.empty() && var.source!=BUILTIN_SOURCE)
+               error(var, "Type 'bool' not allowed on interface variable");
 
        if(var.init_expression)
        {
@@ -263,17 +286,13 @@ void DeclarationValidator::visit(InterfaceBlock &iface)
 void DeclarationValidator::visit(FunctionDeclaration &func)
 {
        SetForScope<ScopeType> set_scope(scope, FUNCTION_PARAM);
-       for(NodeArray<VariableDeclaration>::const_iterator i=func.parameters.begin(); i!=func.parameters.end(); ++i)
-               (*i)->visit(*this);
+       for(const RefPtr<VariableDeclaration> &p: func.parameters)
+               p->visit(*this);
        scope = FUNCTION;
        func.body.visit(*this);
 }
 
 
-IdentifierValidator::IdentifierValidator():
-       anonymous_block(false)
-{ }
-
 void IdentifierValidator::multiple_definition(const string &name, Statement &statement, Statement &previous)
 {
        error(statement, format("Multiple definition of %s", name));
@@ -283,7 +302,7 @@ void IdentifierValidator::multiple_definition(const string &name, Statement &sta
 Statement *IdentifierValidator::find_definition(const string &name)
 {
        BlockDeclarationMap *decls = &declarations[current_block];
-       BlockDeclarationMap::const_iterator i = decls->find(name);
+       auto i = decls->find(name);
        if(i==decls->end() && anonymous_block)
        {
                decls = &declarations[current_block->parent];
@@ -326,8 +345,8 @@ void IdentifierValidator::visit(VariableDeclaration &var)
 
 void IdentifierValidator::visit(InterfaceBlock &iface)
 {
-       string key = iface.interface+iface.block_name;
-       map<string, InterfaceBlock *>::const_iterator i = interface_blocks.find(key);
+       string key = format("%s %s", iface.interface, iface.block_name);
+       auto i = interface_blocks.find(key);
        if(i!=interface_blocks.end())
                multiple_definition(format("interface block '%s %s'", iface.interface, iface.block_name), iface, *i->second);
        else
@@ -347,16 +366,15 @@ void IdentifierValidator::visit(InterfaceBlock &iface)
        if(iface.instance_name.empty() && iface.struct_declaration)
        {
                // Inject anonymous interface block members into the global scope
-               const map<string, VariableDeclaration *> &iface_vars = iface.struct_declaration->members.variables;
-               for(map<string, VariableDeclaration *>::const_iterator j=iface_vars.begin(); j!=iface_vars.end(); ++j)
-                       check_definition(j->first, *j->second);
+               for(const auto &kvp: iface.struct_declaration->members.variables)
+                       check_definition(kvp.first, *kvp.second);
        }
 }
 
 void IdentifierValidator::visit(FunctionDeclaration &func)
 {
        string key = func.name+func.signature;
-       map<string, FunctionDeclaration *>::const_iterator i = overloaded_functions.find(key);
+       auto i = overloaded_functions.find(key);
        if(i==overloaded_functions.end())
                overloaded_functions.insert(make_pair(key, &func));
        else if(func.return_type_declaration && i->second->return_type_declaration!=func.return_type_declaration)
@@ -425,7 +443,7 @@ void ReferenceValidator::visit(FunctionCall &call)
                bool have_declaration = call.constructor;
                if(!call.constructor)
                {
-                       map<string, FunctionDeclaration *>::iterator i = stage->functions.lower_bound(call.name);
+                       auto i = stage->functions.lower_bound(call.name);
                        have_declaration = (i!=stage->functions.end() && i->second->name==call.name);
                }
 
@@ -433,7 +451,7 @@ void ReferenceValidator::visit(FunctionCall &call)
                {
                        bool valid_types = true;
                        string signature;
-                       for(NodeArray<Expression>::const_iterator j=call.arguments.begin(); (valid_types && j!=call.arguments.end()); ++j)
+                       for(auto j=call.arguments.begin(); (valid_types && j!=call.arguments.end()); ++j)
                        {
                                if((*j)->type)
                                        append(signature, ", ", (*j)->type->name);
@@ -472,9 +490,17 @@ void ReferenceValidator::visit(FunctionDeclaration &func)
 }
 
 
-ExpressionValidator::ExpressionValidator():
-       current_function(0)
-{ }
+void ExpressionValidator::visit(VariableReference &var)
+{
+       if(var.declaration && constant_expression && !var.declaration->constant)
+               error(var, format("Reference to non-constant variable '%s' in a constant expression", var.name));
+}
+
+void ExpressionValidator::visit(InterfaceBlockReference &iface)
+{
+       if(constant_expression)
+               error(iface, format("Reference to interface block '%s' in a constant expression", iface.name));
+}
 
 void ExpressionValidator::visit(Swizzle &swizzle)
 {
@@ -520,8 +546,13 @@ void ExpressionValidator::visit(UnaryExpression &unary)
        {
                if(!unary.type)
                        error(unary, format("No matching operator '%s' found for '%s'", unary.oper->token, unary.expression->type->name));
-               else if((unary.oper->token[1]=='+' || unary.oper->token[1]=='-') && !unary.expression->lvalue)
-                       error(unary, format("Operand of '%s' is not an lvalue", unary.oper->token));
+               else if(unary.oper->token[1]=='+' || unary.oper->token[1]=='-')
+               {
+                       if(constant_expression)
+                               error(unary, format("Use of '%s' in a constant expression", unary.oper->token));
+                       else if(!unary.expression->lvalue)
+                               error(unary, format("Operand of '%s' is not an lvalue", unary.oper->token));
+               }
        }
        TraversingVisitor::visit(unary);
 }
@@ -544,7 +575,9 @@ void ExpressionValidator::visit(Assignment &assign)
 {
        if(assign.left->type)
        {
-               if(!assign.left->lvalue)
+               if(constant_expression)
+                       error(assign, "Assignment in constant expression");
+               else if(!assign.left->lvalue)
                        error(assign, "Target of assignment is not an lvalue");
                if(assign.right->type)
                {
@@ -581,7 +614,19 @@ void ExpressionValidator::visit(VariableDeclaration &var)
        if(var.init_expression && var.init_expression->type && var.type_declaration && var.init_expression->type!=var.type_declaration)
                error(var, format("Initializing a variable of type '%s' with an expression of incompatible type '%s'",
                        var.type_declaration->name, var.init_expression->type->name));
-       TraversingVisitor::visit(var);
+
+       if(var.layout)
+               var.layout->visit(*this);
+       if(var.init_expression)
+       {
+               SetFlag set_const(constant_expression, var.constant);
+               TraversingVisitor::visit(var.init_expression);
+       }
+       if(var.array_size)
+       {
+               SetFlag set_const(constant_expression);
+               TraversingVisitor::visit(var.array_size);
+       }
 }
 
 void ExpressionValidator::visit(FunctionDeclaration &func)
@@ -590,6 +635,28 @@ void ExpressionValidator::visit(FunctionDeclaration &func)
        TraversingVisitor::visit(func);
 }
 
+void ExpressionValidator::visit(Conditional &cond)
+{
+       if(cond.condition->type)
+       {
+               BasicTypeDeclaration *basic_cond = dynamic_cast<BasicTypeDeclaration *>(cond.condition->type);
+               if(!basic_cond || basic_cond->kind!=BasicTypeDeclaration::BOOL)
+                       error(cond, "Condition is not a boolean");
+       }
+       TraversingVisitor::visit(cond);
+}
+
+void ExpressionValidator::visit(Iteration &iter)
+{
+       if(iter.condition->type)
+       {
+               BasicTypeDeclaration *basic_cond = dynamic_cast<BasicTypeDeclaration *>(iter.condition->type);
+               if(!basic_cond || basic_cond->kind!=BasicTypeDeclaration::BOOL)
+                       error(iter, "Loop condition is not a boolean");
+       }
+       TraversingVisitor::visit(iter);
+}
+
 void ExpressionValidator::visit(Return &ret)
 {
        if(current_function && current_function->return_type_declaration)
@@ -609,6 +676,219 @@ void ExpressionValidator::visit(Return &ret)
        TraversingVisitor::visit(ret);
 }
 
+
+void FlowControlValidator::visit(Block &block)
+{
+       for(const RefPtr<Statement> &s: block.body)
+       {
+               if(!reachable)
+               {
+                       diagnose(*s, Diagnostic::WARN, "Unreachable code detected");
+                       break;
+               }
+               s->visit(*this);
+       }
+}
+
+void FlowControlValidator::visit(FunctionDeclaration &func)
+{
+       func.body.visit(*this);
+
+       if(func.definition==&func && func.return_type_declaration)
+       {
+               const BasicTypeDeclaration *basic_ret = dynamic_cast<const BasicTypeDeclaration *>(func.return_type_declaration);
+               if(reachable && (!basic_ret || basic_ret->kind!=BasicTypeDeclaration::VOID))
+                       error(func, "Missing return statement at the end of a function not returning 'void'");
+       }
+       reachable = true;
+}
+
+void FlowControlValidator::visit(Conditional &cond)
+{
+       cond.body.visit(*this);
+       bool reachable_if_true = reachable;
+       reachable = true;
+       cond.else_body.visit(*this);
+       reachable |= reachable_if_true;
+}
+
+void FlowControlValidator::visit(Iteration &iter)
+{
+       iter.body.visit(*this);
+       reachable = true;
+}
+
+
+int StageInterfaceValidator::get_location(const Layout &layout)
+{
+       return get_layout_value(layout, "location", -1);
+}
+
+void StageInterfaceValidator::visit(VariableDeclaration &var)
+{
+       int location = (var.layout ? get_location(*var.layout) : -1);
+       if(var.interface=="in" && var.linked_declaration)
+       {
+               const Layout *linked_layout = var.linked_declaration->layout.get();
+               int linked_location = (linked_layout ? get_location(*linked_layout) : -1);
+               if(linked_location!=location)
+               {
+                       error(var, format("Mismatched location %d for 'in %s'", location, var.name));
+                       add_info(*var.linked_declaration, format("Linked to 'out %s' with location %d",
+                               var.linked_declaration->name, linked_location));
+               }
+               if(var.type_declaration && var.linked_declaration->type_declaration)
+               {
+                       TypeDeclaration *type = var.type_declaration;
+                       if(stage->type==Stage::GEOMETRY)
+                       {
+                               if(const BasicTypeDeclaration *basic = dynamic_cast<const BasicTypeDeclaration *>(type))
+                                       if(basic->kind==BasicTypeDeclaration::ARRAY && basic->base_type)
+                                               type = basic->base_type;
+                       }
+                       if(!TypeComparer().apply(*type, *var.linked_declaration->type_declaration))
+                       {
+                               error(var, format("Mismatched type '%s' for 'in %s'", type->name, var.name));
+                               add_info(*var.linked_declaration, format("Linked to 'out %s' with type '%s'",
+                                       var.linked_declaration->name, var.linked_declaration->type_declaration->name));
+                       }
+               }
+       }
+
+       if(location>=0 && !var.interface.empty())
+       {
+               map<unsigned, VariableDeclaration *> &used = used_locations[var.interface];
+
+               unsigned loc_count = LocationCounter().apply(var);
+               for(unsigned i=0; i<loc_count; ++i)
+               {
+                       auto j = used.find(location+i);
+                       if(j!=used.end())
+                       {
+                               error(var, format("Overlapping location %d for '%s %s'", location+i, var.interface, var.name));
+                               add_info(*j->second, format("Previously used here for '%s %s'", j->second->interface, j->second->name));
+                       }
+                       else
+                               used[location+i] = &var;
+               }
+       }
+}
+
+
+void GlobalInterfaceValidator::apply(Module &module)
+{
+       for(Stage &s: module.stages)
+       {
+               stage = &s;
+               s.content.visit(*this);
+       }
+}
+
+void GlobalInterfaceValidator::check_uniform(const Uniform &uni)
+{
+       auto i = used_names.find(uni.name);
+       if(i!=used_names.end())
+       {
+               if(uni.location>=0 && i->second->location>=0 && i->second->location!=uni.location)
+               {
+                       error(*uni.node, format("Mismatched location %d for uniform '%s'", uni.location, uni.name));
+                       add_info(*i->second->node, format("Previously declared here with location %d", i->second->location));
+               }
+               if(uni.bind_point>=0 && i->second->bind_point>=0 && i->second->bind_point!=uni.bind_point)
+               {
+                       error(*uni.node, format("Mismatched binding %d for uniform '%s'", uni.bind_point, uni.name));
+                       add_info(*i->second->node, format("Previously declared here with binding %d", i->second->bind_point));
+               }
+               if(uni.type && i->second->type && !TypeComparer().apply(*uni.type, *i->second->type))
+               {
+                       string type_name = (dynamic_cast<const StructDeclaration *>(uni.type) ?
+                               "structure" : format("type '%s'", uni.type->name));
+                       error(*uni.node, format("Mismatched %s for uniform '%s'", type_name, uni.name));
+
+                       string message = "Previously declared here";
+                       if(!dynamic_cast<const StructDeclaration *>(i->second->type))
+                               message += format(" with type '%s'", i->second->type->name);
+                       add_info(*i->second->node, message);
+               }
+       }
+       else
+               used_names.insert(make_pair(uni.name, &uni));
+
+       if(uni.location>=0)
+       {
+               auto j = used_locations.find(uni.location);
+               if(j!=used_locations.end())
+               {
+                       if(j->second->name!=uni.name)
+                       {
+                               error(*uni.node, format("Overlapping location %d for '%s'", uni.location, uni.name));
+                               add_info(*j->second->node, format("Previously used here for '%s'", j->second->name));
+                       }
+               }
+               else
+               {
+                       for(unsigned k=0; k<uni.loc_count; ++k)
+                               used_locations.insert(make_pair(uni.location+k, &uni));
+               }
+       }
+
+       if(uni.bind_point>=0)
+       {
+               map<unsigned, const Uniform *> &used = used_bindings[uni.desc_set];
+               auto j = used.find(uni.bind_point);
+               if(j!=used.end())
+               {
+                       if(j->second->name!=uni.name)
+                       {
+                               error(*uni.node, format("Overlapping binding %d for '%s'", uni.bind_point, uni.name));
+                               add_info(*j->second->node, format("Previously used here for '%s'", j->second->name));
+                       }
+               }
+               else
+                       used.insert(make_pair(uni.bind_point, &uni));
+       }
+}
+
+void GlobalInterfaceValidator::visit(VariableDeclaration &var)
+{
+       if(var.interface=="uniform")
+       {
+               Uniform uni;
+               uni.node = &var;
+               uni.type = var.type_declaration;
+               uni.name = var.name;
+               if(var.layout)
+               {
+                       uni.location = get_layout_value(*var.layout, "location");
+                       uni.loc_count = LocationCounter().apply(var);
+                       uni.desc_set = get_layout_value(*var.layout, "set", 0);
+                       uni.bind_point = get_layout_value(*var.layout, "binding");
+               }
+
+               uniforms.push_back(uni);
+               check_uniform(uniforms.back());
+       }
+}
+
+void GlobalInterfaceValidator::visit(InterfaceBlock &iface)
+{
+       if(iface.interface=="uniform")
+       {
+               Uniform uni;
+               uni.node = &iface;
+               uni.type = iface.struct_declaration;
+               uni.name = iface.block_name;
+               if(iface.layout)
+               {
+                       uni.desc_set = get_layout_value(*iface.layout, "set", 0);
+                       uni.bind_point = get_layout_value(*iface.layout, "binding");
+               }
+
+               uniforms.push_back(uni);
+               check_uniform(uniforms.back());
+       }
+}
+
 } // namespace SL
 } // namespace GL
 } // namespace Msp