]> git.tdb.fi Git - libs/gl.git/blobdiff - source/glsl/optimize.h
Support inlining GLSL functions with parameters
[libs/gl.git] / source / glsl / optimize.h
index 2d1b20c99e72d7b1361508cc9bdda14c2424952b..6d4b1bcb5d2c2e5d883d7ab640390481c8c7e84e 100644 (file)
 
 #include <map>
 #include <set>
-#include "evaluate.h"
 #include "visitor.h"
 
 namespace Msp {
 namespace GL {
 namespace SL {
 
+/** Finds functions which are candidates for inlining.  Currently this means
+functions which have no flow control statements, 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:
+       enum Pass
+       {
+               DEPENDS,
+               REFERENCED,
+               INLINE,
+               RENAME
+       };
+
+       FunctionDeclaration *source_func;
+       Block staging_block;
+       std::string remap_prefix;
+       Pass pass;
+       RefPtr<Statement> r_inlined_statement;
+       std::set<Node *> dependencies;
+       std::set<std::string> referenced_names;
+       std::string r_result_name;
+
+public:
+       InlineContentInjector();
+
+       const std::string &apply(Stage &, FunctionDeclaration &, Block &, const NodeList<Statement>::iterator &, FunctionCall &);
+
+private:
+       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;
+       bool r_inlined_here;
 
 public:
        FunctionInliner();
 
-       void apply(Stage &);
+       bool apply(Stage &);
 
 private:
-       void visit_and_inline(RefPtr<Expression> &);
+       virtual void visit(RefPtr<Expression> &);
+       virtual void visit(Block &);
+       virtual void visit(FunctionCall &);
+       virtual void visit(FunctionDeclaration &);
+       virtual void visit(Iteration &);
+};
+
+/** Inlines variables into expressions.  Variables with trivial values (those
+consisting of a single literal or variable reference) are always inlined.
+Variables which are only referenced once are also inlined. */
+class ExpressionInliner: private TraversingVisitor
+{
+private:
+       struct ExpressionInfo
+       {
+               Expression *expression;
+               Block *assign_scope;
+               RefPtr<Expression> *inline_point;
+               bool trivial;
+               bool available;
 
+               ExpressionInfo();
+       };
+
+       std::map<Assignment::Target, ExpressionInfo> expressions;
+       ExpressionInfo *r_ref_info;
+       bool r_any_inlined;
+       bool r_trivial;
+       bool mutating;
+       bool iteration_init;
+       Block *iteration_body;
+       const Operator *r_oper;
+
+public:
+       ExpressionInliner();
+
+       bool apply(Stage &);
+
+private:
+       void inline_expression(Expression &, RefPtr<Expression> &);
        virtual void visit(Block &);
+       virtual void visit(RefPtr<Expression> &);
+       virtual void visit(VariableReference &);
+       virtual void visit(MemberAccess &);
+       virtual void visit(Swizzle &);
        virtual void visit(UnaryExpression &);
        virtual void visit(BinaryExpression &);
-       virtual void visit(MemberAccess &);
+       virtual void visit(Assignment &);
+       virtual void visit(TernaryExpression &);
        virtual void visit(FunctionCall &);
        virtual void visit(VariableDeclaration &);
-       virtual void visit(Return &);
-       using TraversingVisitor::visit;
+       virtual void visit(Iteration &);
 };
 
-class ConstantConditionEliminator: private BlockModifier
+/** Replaces expressions consisting entirely of literals with the results of
+evaluating the expression.*/
+class ConstantFolder: private TraversingVisitor
 {
 private:
-       unsigned scope_level;
-       bool record_only;
-       ExpressionEvaluator::ValueMap variable_values;
+       VariableDeclaration *iteration_var;
+       Variant iter_init_value;
+       Variant r_constant_value;
+       bool iteration_init;
+       bool r_constant;
+       bool r_literal;
+       bool r_uses_iter_var;
+       bool r_any_folded;
 
 public:
-       ConstantConditionEliminator();
-
-       void apply(Stage &s) { visit(s.content); }
+       bool apply(Stage &s) { s.content.visit(*this); return r_any_folded; }
 
 private:
-       virtual void visit(Block &);
+       static BasicTypeDeclaration::Kind get_value_kind(const Variant &);
+       template<typename T>
+       static T evaluate_logical(char, T, T);
+       template<typename T>
+       static bool evaluate_relation(const char *, T, T);
+       template<typename T>
+       static T evaluate_arithmetic(char, T, T);
+       void set_result(const Variant &, bool = false);
+
+       virtual void visit(RefPtr<Expression> &);
+       virtual void visit(Literal &);
+       virtual void visit(VariableReference &);
+       virtual void visit(MemberAccess &);
+       virtual void visit(Swizzle &);
        virtual void visit(UnaryExpression &);
+       virtual void visit(BinaryExpression &);
        virtual void visit(Assignment &);
+       virtual void visit(TernaryExpression &);
+       virtual void visit(FunctionCall &);
        virtual void visit(VariableDeclaration &);
+       virtual void visit(Iteration &);
+};
+
+/** Removes conditional statements and loops where the condition can be
+determined as constant at compile time. */
+class ConstantConditionEliminator: private TraversingVisitor
+{
+private:
+       enum ConstantStatus
+       {
+               CONSTANT_FALSE,
+               CONSTANT_TRUE,
+               NOT_CONSTANT
+       };
+
+       NodeList<Statement>::iterator insert_point;
+       std::set<Node *> nodes_to_remove;
+       RefPtr<Expression> r_ternary_result;
+
+public:
+       void apply(Stage &);
+
+private:
+       ConstantStatus check_constant_condition(const Expression &);
+
+       virtual void visit(Block &);
+       virtual void visit(RefPtr<Expression> &);
+       virtual void visit(TernaryExpression &);
        virtual void visit(Conditional &);
        virtual void visit(Iteration &);
-       using BlockModifier::visit;
 };
 
+/** Removes types which are not used anywhere. */
+class UnusedTypeRemover: private TraversingVisitor
+{
+private:
+       std::set<Node *> unused_nodes;
+
+public:
+       bool apply(Stage &);
+
+private:
+       virtual void visit(Literal &);
+       virtual void visit(UnaryExpression &);
+       virtual void visit(BinaryExpression &);
+       virtual void visit(TernaryExpression &);
+       virtual void visit(FunctionCall &);
+       virtual void visit(BasicTypeDeclaration &);
+       virtual void visit(ImageTypeDeclaration &);
+       virtual void visit(StructDeclaration &);
+       virtual void visit(VariableDeclaration &);
+       virtual void visit(InterfaceBlock &);
+       virtual void visit(FunctionDeclaration &);
+};
+
+/** 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 AssignmentInfo
+       {
+               Node *node;
+               Assignment::Target target;
+               std::vector<Node *> used_by;
+
+               AssignmentInfo(): node(0) { }
+       };
+
        struct VariableInfo
        {
-               bool local;
-               std::vector<Node *> assignments;
-               bool conditionally_assigned;
+               InterfaceBlock *interface_block;
+               std::vector<AssignmentInfo *> assignments;
+               bool initialized;
+               bool output;
                bool referenced;
 
-               VariableInfo();
+               VariableInfo(): interface_block(0), initialized(false), output(false), referenced(false) { }
        };
 
-       typedef std::map<VariableDeclaration *, VariableInfo> BlockVariableMap;
+       typedef std::map<Statement *, VariableInfo> BlockVariableMap;
 
-       std::set<Node *> unused_nodes;
-       std::map<VariableDeclaration *, Node *> aggregates;
-       Node *aggregate;
-       std::vector<BlockVariableMap> variables;
-       Assignment *assignment;
+       Stage *stage;
+       BlockVariableMap variables;
+       std::list<AssignmentInfo> assignments;
+       InterfaceBlock *interface_block;
+       Assignment *r_assignment;
        bool assignment_target;
-       bool assign_to_subscript;
-       bool global_scope;
+       bool r_side_effects;
+       std::set<Node *> unused_nodes;
 
 public:
        UnusedVariableRemover();
@@ -105,23 +278,26 @@ public:
        bool apply(Stage &);
 
 private:
+       void referenced(const Assignment::Target &, Node &);
        virtual void visit(VariableReference &);
-       virtual void visit(MemberAccess &);
+       virtual void visit(InterfaceBlockReference &);
+       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 &);
+       void record_assignment(const Assignment::Target &, Node &);
        virtual void visit(ExpressionStatement &);
-       virtual void visit(StructDeclaration &);
+       // Ignore structs because their members can't be accessed directly.
+       virtual void visit(StructDeclaration &) { }
        virtual void visit(VariableDeclaration &);
        virtual void visit(InterfaceBlock &);
+       void merge_variables(const BlockVariableMap &);
        virtual void visit(FunctionDeclaration &);
-       void merge_down_variables();
        virtual void visit(Conditional &);
        virtual void visit(Iteration &);
-       using TraversingVisitor::visit;
 };
 
+/** Removes function declarations with no references to them. */
 class UnusedFunctionRemover: private TraversingVisitor
 {
 private:
@@ -134,7 +310,6 @@ public:
 private:
        virtual void visit(FunctionCall &);
        virtual void visit(FunctionDeclaration &);
-       using TraversingVisitor::visit;
 };
 
 } // namespace SL