aboutsummaryrefslogtreecommitdiffstats
path: root/libyul/optimiser/UnusedPruner.h
blob: 2dd749404d679877a9dc8fd4f7892f0b788b4cdf (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
/*
    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 removes unused variables and functions.
 */

#pragma once

#include <libyul/optimiser/ASTWalker.h>
#include <libyul/YulString.h>

#include <map>
#include <set>

namespace dev
{
namespace yul
{

/**
 * Optimisation stage that removes unused variables and functions.
 *
 * TODO: Also remove intermediate variable assignments from movable expressions
 * which are not referenced until after the next assignment to the same variable.
 *
 * Note that this does not remove circular references.
 *
 * Prerequisite: Disambiguator
 */
class UnusedPruner: public ASTModifier
{
public:
    explicit UnusedPruner(Block& _ast, std::set<YulString> const& _externallyUsedFunctions = {});

    using ASTModifier::operator();
    virtual void operator()(Block& _block) override;

    // @returns true iff the code changed in the previous run.
    bool shouldRunAgain() const { return m_shouldRunAgain; }

    // Run the pruner until the code does not change anymore.
    static void runUntilStabilised(Block& _ast, std::set<YulString> const& _externallyUsedFunctions = {});

private:
    bool used(YulString _name) const;
    void subtractReferences(std::map<YulString, size_t> const& _subtrahend);

    bool m_shouldRunAgain = false;
    std::map<YulString, size_t> m_references;
};

}
}