aboutsummaryrefslogtreecommitdiffstats
path: root/libyul/AsmAnalysis.h
diff options
context:
space:
mode:
Diffstat (limited to 'libyul/AsmAnalysis.h')
-rw-r--r--libyul/AsmAnalysis.h128
1 files changed, 128 insertions, 0 deletions
diff --git a/libyul/AsmAnalysis.h b/libyul/AsmAnalysis.h
new file mode 100644
index 00000000..194f736e
--- /dev/null
+++ b/libyul/AsmAnalysis.h
@@ -0,0 +1,128 @@
+/*
+ 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/>.
+*/
+/**
+ * Analysis part of inline assembly.
+ */
+
+#pragma once
+
+#include <liblangutil/Exceptions.h>
+#include <liblangutil/EVMVersion.h>
+
+#include <libsolidity/inlineasm/AsmScope.h>
+
+#include <libyul/backends/evm/AbstractAssembly.h>
+
+#include <libsolidity/inlineasm/AsmDataForward.h>
+
+#include <boost/variant.hpp>
+#include <boost/optional.hpp>
+
+#include <functional>
+#include <memory>
+
+namespace langutil
+{
+class ErrorReporter;
+struct SourceLocation;
+}
+
+namespace dev
+{
+namespace solidity
+{
+namespace assembly
+{
+
+struct AsmAnalysisInfo;
+
+/**
+ * Performs the full analysis stage, calls the ScopeFiller internally, then resolves
+ * references and performs other checks.
+ * If all these checks pass, code generation should not throw errors.
+ */
+class AsmAnalyzer: public boost::static_visitor<bool>
+{
+public:
+ explicit AsmAnalyzer(
+ AsmAnalysisInfo& _analysisInfo,
+ langutil::ErrorReporter& _errorReporter,
+ EVMVersion _evmVersion,
+ boost::optional<langutil::Error::Type> _errorTypeForLoose,
+ AsmFlavour _flavour = AsmFlavour::Loose,
+ yul::ExternalIdentifierAccess::Resolver const& _resolver = yul::ExternalIdentifierAccess::Resolver()
+ ):
+ m_resolver(_resolver),
+ m_info(_analysisInfo),
+ m_errorReporter(_errorReporter),
+ m_evmVersion(_evmVersion),
+ m_flavour(_flavour),
+ m_errorTypeForLoose(_errorTypeForLoose)
+ {}
+
+ bool analyze(assembly::Block const& _block);
+
+ bool operator()(assembly::Instruction const&);
+ bool operator()(assembly::Literal const& _literal);
+ bool operator()(assembly::Identifier const&);
+ bool operator()(assembly::FunctionalInstruction const& _functionalInstruction);
+ bool operator()(assembly::Label const& _label);
+ bool operator()(assembly::ExpressionStatement const&);
+ bool operator()(assembly::StackAssignment const&);
+ bool operator()(assembly::Assignment const& _assignment);
+ bool operator()(assembly::VariableDeclaration const& _variableDeclaration);
+ bool operator()(assembly::FunctionDefinition const& _functionDefinition);
+ bool operator()(assembly::FunctionCall const& _functionCall);
+ bool operator()(assembly::If const& _if);
+ bool operator()(assembly::Switch const& _switch);
+ bool operator()(assembly::ForLoop const& _forLoop);
+ bool operator()(assembly::Block const& _block);
+
+private:
+ /// Visits the statement and expects it to deposit one item onto the stack.
+ bool expectExpression(Expression const& _expr);
+ bool expectDeposit(int _deposit, int _oldHeight, langutil::SourceLocation const& _location);
+
+ /// Verifies that a variable to be assigned to exists and has the same size
+ /// as the value, @a _valueSize, unless that is equal to -1.
+ bool checkAssignment(assembly::Identifier const& _assignment, size_t _valueSize = size_t(-1));
+
+ Scope& scope(assembly::Block const* _block);
+ void expectValidType(std::string const& type, langutil::SourceLocation const& _location);
+ void warnOnInstructions(solidity::Instruction _instr, langutil::SourceLocation const& _location);
+
+ /// Depending on @a m_flavour and @a m_errorTypeForLoose, throws an internal compiler
+ /// exception (if the flavour is not Loose), reports an error/warning
+ /// (if m_errorTypeForLoose is set) or does nothing.
+ void checkLooseFeature(langutil::SourceLocation const& _location, std::string const& _description);
+
+ int m_stackHeight = 0;
+ yul::ExternalIdentifierAccess::Resolver m_resolver;
+ Scope* m_currentScope = nullptr;
+ /// Variables that are active at the current point in assembly (as opposed to
+ /// "part of the scope but not yet declared")
+ std::set<Scope::Variable const*> m_activeVariables;
+ AsmAnalysisInfo& m_info;
+ langutil::ErrorReporter& m_errorReporter;
+ EVMVersion m_evmVersion;
+ AsmFlavour m_flavour = AsmFlavour::Loose;
+ boost::optional<langutil::Error::Type> m_errorTypeForLoose;
+};
+
+}
+}
+}