aboutsummaryrefslogtreecommitdiffstats
path: root/libyul/optimiser/Rematerialiser.h
blob: c34353de8ca74b9bbe1e297c34075c3b0c25eb29 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/*
    This file is part of solidity.

    solidity is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    solidity is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with solidity.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * Optimisation stage that replaces variables by their most recently assigned expressions.
 */

#pragma once

#include <libyul/optimiser/DataFlowAnalyzer.h>

namespace yul
{

/**
 * Optimisation stage that replaces variables by their most recently assigned expressions,
 * but only if the expression is movable and one of the following holds:
 *  - the variable is referenced exactly once
 *  - the value is extremely cheap ("cost" of zero like ``caller()``)
 *  - the variable is referenced at most 5 times and the value is rather cheap
 *    ("cost" of at most 1 like a constant up to 0xff)
 *
 * Prerequisite: Disambiguator
 */
class Rematerialiser: public DataFlowAnalyzer
{
public:
    static void run(Block& _ast);

protected:
    Rematerialiser(Block& _ast);

    using ASTModifier::visit;
    void visit(Expression& _e) override;

    std::map<YulString, size_t> m_referenceCounts;
};

}