Debug attributes get only parsed, if debug attribute cache was set.

ethereum · Sep 4, 2024 · b05c686 · b05c686
1 parent 95547c2
commit b05c686
Show file tree

Hide file tree

Showing 15 changed files with 70 additions and 35 deletions.
diff --git a/libyul/AsmParser.cpp b/libyul/AsmParser.cpp
@@ -62,35 +62,34 @@ std::optional<int> toInt(std::string const& _value)
 
 langutil::DebugData::ConstPtr Parser::createDebugData() const
 {
- solAssert(m_debugAttributeCache);
  switch (m_useSourceLocationFrom)
  {
  case UseSourceLocationFrom::Scanner:
  return DebugData::create(
  ParserBase::currentLocation(),
  ParserBase::currentLocation(),
  {},
- m_currentDebugAttributes.has_value()
- ? DebugData::Attributes({m_debugAttributeCache->set(*m_currentDebugAttributes)})
- : DebugData::Attributes({})
+ m_debugAttributeCache
+ ? m_currentDebugAttributes.has_value() ? DebugData::Attributes({m_debugAttributeCache->set(*m_currentDebugAttributes)}) : DebugData::Attributes({})
+ : std::nullopt
  );
  case UseSourceLocationFrom::LocationOverride:
  return DebugData::create(
  m_locationOverride,
  m_locationOverride,
  {},
- m_currentDebugAttributes.has_value()
- ? DebugData::Attributes({m_debugAttributeCache->set(*m_currentDebugAttributes)})
- : DebugData::Attributes({})
+ m_debugAttributeCache
+ ? m_currentDebugAttributes.has_value() ? DebugData::Attributes({m_debugAttributeCache->set(*m_currentDebugAttributes)}) : DebugData::Attributes({})
+ : std::nullopt
  );
  case UseSourceLocationFrom::Comments:
  return DebugData::create(
  ParserBase::currentLocation(),
  m_locationFromComment,
  m_astIDFromComment,
- m_currentDebugAttributes.has_value()
- ? DebugData::Attributes({m_debugAttributeCache->set(*m_currentDebugAttributes)})
- : DebugData::Attributes({})
+ m_debugAttributeCache
+ ? m_currentDebugAttributes.has_value() ? DebugData::Attributes({m_debugAttributeCache->set(*m_currentDebugAttributes)}) : DebugData::Attributes({})
+ : std::nullopt
  );
  }
  solAssert(false, "");
@@ -200,7 +199,7 @@ void Parser::fetchDebugDataFromComment()
  else
  break;
  }
- else if (match[1] == "@debug.set")
+ else if (match[1] == "@debug.set" && m_debugAttributeCache)
  {
  if (auto parseResult = parseDebugDataAttributeOperationComment(match[1], commentLiteral, m_scanner->currentCommentLocation()))
  {
@@ -211,7 +210,7 @@ void Parser::fetchDebugDataFromComment()
  else
  break;
  }
- else if (match[1] == "@debug.merge")
+ else if (match[1] == "@debug.merge" && m_debugAttributeCache)
  {
  if (auto parseResult = parseDebugDataAttributeOperationComment(match[1], commentLiteral, m_scanner->currentCommentLocation()))
  {
@@ -226,7 +225,7 @@ void Parser::fetchDebugDataFromComment()
  else
  break;
  }
- else if (match[1] == "@debug.patch")
+ else if (match[1] == "@debug.patch" && m_debugAttributeCache)
  {
  if (auto parseResult = parseDebugDataAttributeOperationComment(match[1], commentLiteral, m_scanner->currentCommentLocation()))
  {
@@ -251,6 +250,7 @@ std::optional<std::pair<std::string_view, std::optional<Json>>> Parser::parseDeb
  langutil::SourceLocation const& _location
 )
 {
+ solAssert(m_debugAttributeCache, "debug attributes can only be used with valid debug attribute cache");
  std::optional<Json> jsonData;
  try
  {
@@ -278,6 +278,7 @@ std::optional<std::pair<std::string_view, std::optional<Json>>> Parser::parseDeb
 
 void Parser::applyDebugDataAttributePatch(Json const& _jsonPatch, langutil::SourceLocation const& _location)
 {
+ solAssert(m_debugAttributeCache, "debug attributes can only be used with valid debug attribute cache");
  try
  {
  if (!m_currentDebugAttributes.has_value())

diff --git a/libyul/AsmParser.h b/libyul/AsmParser.h
@@ -35,6 +35,7 @@
 
 #include <map>
 #include <memory>
+#include <utility>
 #include <variant>
 #include <string_view>
 
@@ -60,7 +61,7 @@ class Parser: public langutil::ParserBase
  langutil::ErrorReporter& _errorReporter,
  Dialect const& _dialect,
  std::optional<langutil::SourceLocation> _locationOverride = {},
- DebugAttributeCache::Ptr debugAttributesCache = {}
+ DebugAttributeCache::Ptr _debugAttributesCache = {}
  ):
  ParserBase(_errorReporter),
  m_dialect(_dialect),
@@ -70,7 +71,7 @@ class Parser: public langutil::ParserBase
  UseSourceLocationFrom::LocationOverride :
  UseSourceLocationFrom::Scanner
  },
- m_debugAttributeCache(debugAttributesCache == nullptr ? std::make_shared<DebugAttributeCache>() : debugAttributesCache)
+ m_debugAttributeCache(std::move(_debugAttributesCache))
  {}
 
  /// Constructs a Yul parser that is using the debug data
@@ -89,7 +90,7 @@ class Parser: public langutil::ParserBase
  UseSourceLocationFrom::Comments :
  UseSourceLocationFrom::Scanner
  },
- m_debugAttributeCache(debugAttributesCache == nullptr ? std::make_shared<DebugAttributeCache>() : debugAttributesCache)
+ m_debugAttributeCache(std::move(debugAttributesCache))
  {}
 
  /// Parses an inline assembly block starting with `{` and ending with `}`.

diff --git a/libyul/ObjectParser.cpp b/libyul/ObjectParser.cpp
@@ -171,7 +171,7 @@ std::optional<SourceNameMap> ObjectParser::tryParseSourceNameMapping() const
 
 std::shared_ptr<AST> ObjectParser::parseBlock(std::optional<SourceNameMap> _sourceNames)
 {
- Parser parser(m_errorReporter, m_dialect, std::move(_sourceNames));
+ Parser parser(m_errorReporter, m_dialect, std::move(_sourceNames), m_cache);
  auto ast = parser.parseInline(m_scanner);
  yulAssert(ast || m_errorReporter.hasErrors(), "Invalid block but no error!");
  return ast;

diff --git a/libyul/ObjectParser.h b/libyul/ObjectParser.h
@@ -21,8 +21,9 @@
 
 #pragma once
 
-#include <libyul/Object.h>
 #include <libyul/Dialect.h>
+#include <libyul/AsmParser.h>
+#include <libyul/Object.h>
 
 #include <liblangutil/ErrorReporter.h>
 #include <liblangutil/ParserBase.h>
@@ -45,8 +46,8 @@ namespace solidity::yul
 class ObjectParser: public langutil::ParserBase
 {
 public:
- explicit ObjectParser(langutil::ErrorReporter& _errorReporter, Dialect const& _dialect):
- ParserBase(_errorReporter), m_dialect(_dialect) {}
+ explicit ObjectParser(langutil::ErrorReporter& _errorReporter, Dialect const& _dialect, Parser::DebugAttributeCache::Ptr _cache = {}):
+ ParserBase(_errorReporter), m_dialect(_dialect), m_cache(std::move(_cache)) {}
 
  /// Parses a Yul object.
  /// Falls back to code-only parsing if the source starts with `{`.
@@ -66,6 +67,7 @@ class ObjectParser: public langutil::ParserBase
  void addNamedSubObject(Object& _container, std::string_view _name, std::shared_ptr<ObjectNode> _subObject);
 
  Dialect const& m_dialect;
+ Parser::DebugAttributeCache::Ptr m_cache;
 };
 
 }
diff --git a/libyul/YulStack.cpp b/libyul/YulStack.cpp
@@ -55,7 +55,7 @@ bool YulStack::parse(std::string const& _sourceName, std::string const& _source)
  {
  m_charStream = std::make_unique<CharStream>(_source, _sourceName);
  std::shared_ptr<Scanner> scanner = std::make_shared<Scanner>(*m_charStream);
- m_parserResult = ObjectParser(m_errorReporter, languageToDialect(m_language, m_evmVersion)).parse(scanner, false);
+ m_parserResult = ObjectParser(m_errorReporter, languageToDialect(m_language, m_evmVersion), m_cache).parse(scanner, false);
  }
  catch (UnimplementedFeatureError const& _error)
  {

diff --git a/libyul/YulStack.h b/libyul/YulStack.h
@@ -37,6 +37,7 @@
 
 #include <memory>
 #include <string>
+#include <utility>
 
 namespace solidity::evmasm
 {
@@ -91,15 +92,17 @@ class YulStack: public langutil::CharStreamProvider
  Language _language,
  solidity::frontend::OptimiserSettings _optimiserSettings,
  langutil::DebugInfoSelection const& _debugInfoSelection,
- std::shared_ptr<ObjectOptimizer> _objectOptimizer = nullptr
+ std::shared_ptr<ObjectOptimizer> _objectOptimizer = nullptr,
+ Parser::DebugAttributeCache::Ptr _cache = {}
  ):
  m_language(_language),
  m_evmVersion(_evmVersion),
  m_eofVersion(_eofVersion),
  m_optimiserSettings(std::move(_optimiserSettings)),
  m_debugInfoSelection(_debugInfoSelection),
  m_errorReporter(m_errors),
- m_objectOptimizer(_objectOptimizer ? std::move(_objectOptimizer) : std::make_shared<ObjectOptimizer>())
+ m_objectOptimizer(_objectOptimizer ? std::move(_objectOptimizer) : std::make_shared<ObjectOptimizer>()),
+ m_cache(std::move(_cache))
  {}
 
  /// @returns the char stream used during parsing
@@ -177,6 +180,7 @@ class YulStack: public langutil::CharStreamProvider
  langutil::ErrorReporter m_errorReporter;
 
  std::shared_ptr<ObjectOptimizer> m_objectOptimizer;
+ Parser::DebugAttributeCache::Ptr m_cache;
 };
 
 }
diff --git a/test/libyul/Common.cpp b/test/libyul/Common.cpp
@@ -19,6 +19,9 @@
  * Common functions the Yul tests.
  */
 
+#include "libyul/AsmParser.h"
+
+
 #include <test/libyul/Common.h>
 
 #include <test/Common.h>
@@ -36,6 +39,7 @@
 
 #include <boost/test/unit_test.hpp>
 
+#include <utility>
 #include <variant>
 
 using namespace solidity;
@@ -50,7 +54,7 @@ Dialect const& defaultDialect()
 }
 }
 
-std::pair<std::shared_ptr<AST const>, std::shared_ptr<yul::AsmAnalysisInfo>> yul::test::parse(std::string const& _source)
+std::pair<std::shared_ptr<AST const>, std::shared_ptr<yul::AsmAnalysisInfo>> yul::test::parse(std::string const& _source, Parser::DebugAttributeCache::Ptr _cache)
 {
  YulStack stack(
  solidity::test::CommonOptions::get().evmVersion(),
@@ -59,7 +63,9 @@ std::pair<std::shared_ptr<AST const>, std::shared_ptr<yul::AsmAnalysisInfo>> yul
  solidity::test::CommonOptions::get().optimize ?
  solidity::frontend::OptimiserSettings::standard() :
  solidity::frontend::OptimiserSettings::minimal(),
- DebugInfoSelection::ExceptExperimental()
+ DebugInfoSelection::ExceptExperimental(),
+ nullptr,
+ std::move(_cache)
  );
  if (!stack.parseAndAnalyze("", _source) || !stack.errors().empty())
  BOOST_FAIL("Invalid source.");
@@ -69,13 +75,14 @@ std::pair<std::shared_ptr<AST const>, std::shared_ptr<yul::AsmAnalysisInfo>> yul
 std::pair<std::shared_ptr<Object>, std::shared_ptr<yul::AsmAnalysisInfo>> yul::test::parse(
  std::string const& _source,
  Dialect const& _dialect,
- ErrorList& _errors
+ ErrorList& _errors,
+ Parser::DebugAttributeCache::Ptr _cache
 )
 {
  ErrorReporter errorReporter(_errors);
  CharStream stream(_source, "");
  std::shared_ptr<Scanner> scanner = std::make_shared<Scanner>(stream);
- std::shared_ptr<Object> parserResult = yul::ObjectParser(errorReporter, _dialect).parse(scanner, false);
+ std::shared_ptr<Object> parserResult = yul::ObjectParser(errorReporter, _dialect, std::move(_cache)).parse(scanner, false);
  if (!parserResult)
  return {};
  if (!parserResult->hasCode() || errorReporter.hasErrors())

diff --git a/test/libyul/Common.h b/test/libyul/Common.h
@@ -23,6 +23,8 @@
 
 #include <liblangutil/EVMVersion.h>
 
+#include <libyul/AsmParser.h>
+
 #include <string>
 #include <vector>
 #include <memory>
@@ -46,10 +48,10 @@ namespace solidity::yul::test
 {
 
 std::pair<std::shared_ptr<AST const>, std::shared_ptr<AsmAnalysisInfo>>
-parse(std::string const& _source);
+parse(std::string const& _source, Parser::DebugAttributeCache::Ptr _cache = {});
 
 std::pair<std::shared_ptr<Object>, std::shared_ptr<AsmAnalysisInfo>>
-parse(std::string const& _source, Dialect const& _dialect, langutil::ErrorList& _errors);
+parse(std::string const& _source, Dialect const& _dialect, langutil::ErrorList& _errors, Parser::DebugAttributeCache::Ptr _cache = {});
 
 Block disambiguate(std::string const& _source);
 std::string format(std::string const& _source);

diff --git a/test/libyul/Parser.cpp b/test/libyul/Parser.cpp
@@ -1007,7 +1007,8 @@ BOOST_AUTO_TEST_CASE(ethdebug_debug_attributes_empty)
  auto const sourceText = R"(
  {}
  )";
- EVMDialectTyped const& dialect = EVMDialectTyped::instance(EVMVersion{});
+ auto const& dialect = EVMDialect::strictAssemblyForEVM(EVMVersion{});
+ BOOST_REQUIRE(cache->cache().size() == 0);
  std::shared_ptr<AST> result = parse(sourceText, dialect, reporter, cache);
  BOOST_REQUIRE(cache->cache().size() == 0);
 }
@@ -1021,7 +1022,7 @@ BOOST_AUTO_TEST_CASE(ethdebug_debug_attributes_set_empty)
  /// @debug.set {}
  {}
  )";
- EVMDialectTyped const& dialect = EVMDialectTyped::instance(EVMVersion{});
+ auto const& dialect = EVMDialect::strictAssemblyForEVM(EVMVersion{});
  std::shared_ptr<AST> result = parse(sourceText, dialect, reporter, cache);
  BOOST_REQUIRE(cache->cache().size() == 1);
 }
@@ -1036,7 +1037,7 @@ BOOST_AUTO_TEST_CASE(ethdebug_debug_attributes_set)
  /// @debug.set {"hello": "world"}
  {}
  )";
- EVMDialectTyped const& dialect = EVMDialectTyped::instance(EVMVersion{});
+ auto const& dialect = EVMDialect::strictAssemblyForEVM(EVMVersion{});
  std::shared_ptr<AST> result = parse(sourceText, dialect, reporter, cache);
  BOOST_REQUIRE(cache->cache().size() == 1);
 }
@@ -1055,7 +1056,7 @@ BOOST_AUTO_TEST_CASE(ethdebug_debug_attributes_multiple_set)
  {}
  }
  )";
- EVMDialectTyped const& dialect = EVMDialectTyped::instance(EVMVersion{});
+ auto const& dialect = EVMDialect::strictAssemblyForEVM(EVMVersion{});
  std::shared_ptr<AST> result = parse(sourceText, dialect, reporter, cache);
  BOOST_REQUIRE(cache->cache().size() == 2);
 }

diff --git a/test/libyul/SyntaxTest.cpp b/test/libyul/SyntaxTest.cpp
@@ -46,8 +46,10 @@ void SyntaxTest::parseAndAnalyze()
 
  ErrorList errorList{};
  soltestAssert(m_dialect, "");
+ if (m_debugAttributesEnabled && m_debugAttributesCache == nullptr)
+ m_debugAttributesCache = std::make_shared<Parser::DebugAttributeCache>();
  // Silently ignoring the results.
- yul::test::parse(source, *m_dialect, errorList);
+ yul::test::parse(source, *m_dialect, errorList, m_debugAttributesCache);
  for (auto const& error: errorList)
  {
  int locationStart = -1;
@@ -75,5 +77,6 @@ SyntaxTest::SyntaxTest(std::string const& _filename, langutil::EVMVersion _evmVe
  CommonSyntaxTest(_filename, _evmVersion)
 {
  std::string dialectName = m_reader.stringSetting("dialect", "evm");
+ m_debugAttributesEnabled = m_reader.boolSetting("enableDebugAttributes", false);
  m_dialect = &dialect(dialectName, solidity::test::CommonOptions::get().evmVersion());
 }
diff --git a/test/libyul/SyntaxTest.h b/test/libyul/SyntaxTest.h
@@ -18,8 +18,12 @@
 
 #pragma once
 
-#include <test/CommonSyntaxTest.h>
+#include "libyul/AsmParser.h"
+#include "libyul/optimiser/SimplificationRules.h"
+
+
 #include <libyul/Dialect.h>
+#include <test/CommonSyntaxTest.h>
 
 namespace solidity::yul::test
 {
@@ -40,6 +44,8 @@ class SyntaxTest: public solidity::test::CommonSyntaxTest
 
 private:
  Dialect const* m_dialect = nullptr;
+ bool m_debugAttributesEnabled = false;
+ Parser::DebugAttributeCache::Ptr m_debugAttributesCache;
 };
 
 }
diff --git a/test/libyul/yulSyntaxTests/invalid/invalid_debug_merge.yul b/test/libyul/yulSyntaxTests/invalid/invalid_debug_merge.yul
@@ -3,5 +3,7 @@ object "object" {
  /// @debug.merge {"HELLO": 2
  }
 }
+// ====
+// enableDebugAttributes: true
 // ----
 // SyntaxError 5721: (37-65): @debug.merge: Could not parse debug data: parse error at line 1, column 12: syntax error while parsing object - unexpected end of input; expected '}'
diff --git a/test/libyul/yulSyntaxTests/invalid/invalid_debug_patch.yul b/test/libyul/yulSyntaxTests/invalid/invalid_debug_patch.yul
@@ -3,5 +3,7 @@ object "object" {
  /// @debug.patch {"HELLO": invalid
  }
 }
+// ====
+// enableDebugAttributes: true
 // ----
 // SyntaxError 5721: (37-71): @debug.patch: Could not parse debug data: parse error at line 1, column 11: syntax error while parsing value - unexpected end of input; expected '[', '{', or a literal
diff --git a/test/libyul/yulSyntaxTests/invalid/invalid_debug_patch_patch_object.yul b/test/libyul/yulSyntaxTests/invalid/invalid_debug_patch_patch_object.yul
@@ -3,5 +3,7 @@ object "object" {
  /// @debug.patch { "op": "unknown_operation", "path": "/variable_a", "value": ["test"] }
  }
 }
+// ====
+// enableDebugAttributes: true
 // ----
 // SyntaxError 9426: (37-125): @debug.patch: Could not patch debug data: parse error: operation value 'unknown_operation' is invalid
diff --git a/test/libyul/yulSyntaxTests/invalid/invalid_debug_set.yul b/test/libyul/yulSyntaxTests/invalid/invalid_debug_set.yul
@@ -3,5 +3,7 @@ object "object" {
  /// @debug.set {"HELLO": "WORLD
  }
 }
+// ====
+// enableDebugAttributes: true
 // ----
 // SyntaxError 5721: (37-68): @debug.set: Could not parse debug data: parse error at line 1, column 17: syntax error while parsing value - invalid string: missing closing quote; last read: '"WORLD'