Fix an issue where member assignments were incorrectly optimized away

[libs/gl.git] / source / glsl / optimize.h

diff --git a/source/glsl/optimize.h b/source/glsl/optimize.h
index cfebf0f782c46aee0c2bbc0730baf555b0081b8a..28f5e87688629634f9e05734e61cdbc1c5995ad1 100644 (file)
--- a/source/glsl/optimize.h
+++ b/source/glsl/optimize.h
@@ -10,36 +10,77 @@ namespace Msp {
 namespace GL {
 namespace SL {
 
+/** Finds functions which are candidates for inlining.  Currently this means
+functions which have no parameters, contain no more than one return statement,
+and are only called once. */
 class InlineableFunctionLocator: private TraversingVisitor
 {
 private:
        std::map<FunctionDeclaration *, unsigned> refcounts;
        std::set<FunctionDeclaration *> inlineable;
-       FunctionDeclaration *in_function;
+       FunctionDeclaration *current_function;
+       unsigned return_count;
 
 public:
        InlineableFunctionLocator();
 
-       const std::set<FunctionDeclaration *> &apply(Stage &s) { visit(s.content); return inlineable; }
+       const std::set<FunctionDeclaration *> &apply(Stage &s) { s.content.visit(*this); return inlineable; }
 
 private:
        virtual void visit(FunctionCall &);
        virtual void visit(FunctionDeclaration &);
-       using TraversingVisitor::visit;
+       virtual void visit(Conditional &);
+       virtual void visit(Iteration &);
+       virtual void visit(Return &);
 };
 
+/** Injects statements from one function into another.  Local variables are
+renamed to avoid conflicts.  After inlining, uses NodeReorderer to cause
+dependencies of the inlined statements to appear before the target function. */
+class InlineContentInjector: private TraversingVisitor
+{
+private:
+       FunctionDeclaration *source_func;
+       Block *target_block;
+       std::map<std::string, VariableDeclaration *> variable_map;
+       bool remap_names;
+       bool deps_only;
+       RefPtr<Statement> r_inlined_statement;
+       std::set<Node *> dependencies;
+       std::string r_result_name;
+
+public:
+       InlineContentInjector();
+
+       const std::string &apply(Stage &, FunctionDeclaration &, Block &, const NodeList<Statement>::iterator &, FunctionDeclaration &);
+
+private:
+       std::string create_unused_name(const std::string &, bool);
+
+       virtual void visit(VariableReference &);
+       virtual void visit(InterfaceBlockReference &);
+       virtual void visit(FunctionCall &);
+       virtual void visit(VariableDeclaration &);
+       virtual void visit(Return &);
+};
+
+/** Inlines functions.  Internally uses InlineableFunctionLocator to find
+candidate functions.  Only functions which consist of a single return statement
+are inlined. */
 class FunctionInliner: private TraversingVisitor
 {
 private:
+       Stage *stage;
        std::set<FunctionDeclaration *> inlineable;
-       unsigned extract_result;
-       RefPtr<Expression> inline_result;
+       FunctionDeclaration *current_function;
+       NodeList<Statement>::iterator insert_point;
+       RefPtr<Expression> r_inline_result;
+       bool r_any_inlined;
 
 public:
        FunctionInliner();
-       FunctionInliner(const std::set<FunctionDeclaration *> &);
 
-       void apply(Stage &s) { visit(s.content); }
+       bool apply(Stage &);
 
 private:
        void visit_and_inline(RefPtr<Expression> &);
@@ -49,22 +90,28 @@ private:
        virtual void visit(BinaryExpression &);
        virtual void visit(MemberAccess &);
        virtual void visit(FunctionCall &);
+       virtual void visit(ExpressionStatement &);
        virtual void visit(VariableDeclaration &);
+       virtual void visit(FunctionDeclaration &);
+       virtual void visit(Conditional &);
+       virtual void visit(Iteration &);
        virtual void visit(Return &);
-       using TraversingVisitor::visit;
 };
 
-class ConstantConditionEliminator: private BlockModifier
+/** Removes conditional statements and loops where the condition can be
+determined as constant at compile time. */
+class ConstantConditionEliminator: private TraversingVisitor
 {
 private:
-       unsigned scope_level;
        bool record_only;
        ExpressionEvaluator::ValueMap variable_values;
+       NodeList<Statement>::iterator insert_point;
+       std::set<Node *> nodes_to_remove;
 
 public:
        ConstantConditionEliminator();
 
-       void apply(Stage &s) { visit(s.content); }
+       void apply(Stage &);
 
 private:
        virtual void visit(Block &);
@@ -73,10 +120,11 @@ private:
        virtual void visit(VariableDeclaration &);
        virtual void visit(Conditional &);
        virtual void visit(Iteration &);
-       using BlockModifier::visit;
 };
 
-class UnusedVariableLocator: private TraversingVisitor
+/** Removes variable declarations with no references to them.  Assignment
+statements where the result is not used are also removed. */
+class UnusedVariableRemover: private TraversingVisitor
 {
 private:
        struct VariableInfo
@@ -95,23 +143,26 @@ private:
        std::map<VariableDeclaration *, Node *> aggregates;
        Node *aggregate;
        std::vector<BlockVariableMap> variables;
-       Assignment *assignment;
+       Assignment *r_assignment;
        bool assignment_target;
-       bool assign_to_subscript;
-       bool global_scope;
+       bool r_assign_to_subfield;
+       bool r_side_effects;
 
 public:
-       UnusedVariableLocator();
+       UnusedVariableRemover();
 
-       const std::set<Node *> &apply(Stage &);
+       bool apply(Stage &);
 
 private:
        virtual void visit(VariableReference &);
+       virtual void visit(InterfaceBlockReference &);
        virtual void visit(MemberAccess &);
+       virtual void visit(UnaryExpression &);
        virtual void visit(BinaryExpression &);
        virtual void visit(Assignment &);
        void record_assignment(VariableDeclaration &, Node &, bool);
        void clear_assignments(VariableInfo &, bool);
+       virtual void visit(FunctionCall &);
        virtual void visit(ExpressionStatement &);
        virtual void visit(StructDeclaration &);
        virtual void visit(VariableDeclaration &);
@@ -120,22 +171,21 @@ private:
        void merge_down_variables();
        virtual void visit(Conditional &);
        virtual void visit(Iteration &);
-       using TraversingVisitor::visit;
 };
 
-class UnusedFunctionLocator: private TraversingVisitor
+/** Removes function declarations with no references to them. */
+class UnusedFunctionRemover: private TraversingVisitor
 {
 private:
        std::set<Node *> unused_nodes;
        std::set<FunctionDeclaration *> used_definitions;
 
 public:
-       const std::set<Node *> &apply(Stage &s) { visit(s.content); return unused_nodes; }
+       bool apply(Stage &s);
 
 private:
        virtual void visit(FunctionCall &);
        virtual void visit(FunctionDeclaration &);
-       using TraversingVisitor::visit;
 };
 
 } // namespace SL