Order yul subobjects by order of reference.

Author: ekpyron

Changelog.md

@@ -15,6 +15,7 @@ Compiler Features:
 
 
 Bugfixes:
+ * Yul IR Code Generation: Deterministic order of Yul subobjects.
  * SMTChecker: Fix error that reports invalid number of verified checks for BMC and CHC engines.
  * SMTChecker: Fix formatting of unary minus expressions in invariants.
  * SMTChecker: Fix internal compiler error when reporting proved targets for BMC engine.

libsolidity/codegen/ir/IRGenerationContext.h

@@ -143,7 +143,12 @@ class IRGenerationContext
 
 	RevertStrings revertStrings() const { return m_revertStrings; }
 
-	std::set<ContractDefinition const*, ASTNode::CompareByID>& subObjectsCreated() { return m_subObjects; }
+	std::vector<ContractDefinition const*> const& subObjectsCreated() { return m_subObjects; }
+	void addSubObject(ContractDefinition const* _contractDefinition)
+	{
+		if (!util::contains(m_subObjects, _contractDefinition))
+			m_subObjects.emplace_back(_contractDefinition);
+	}
 
 	bool memoryUnsafeInlineAssemblySeen() const { return m_memoryUnsafeInlineAssemblySeen; }
 	void setMemoryUnsafeInlineAssemblySeen() { m_memoryUnsafeInlineAssemblySeen = true; }
@@ -195,7 +200,7 @@ class IRGenerationContext
 	/// It will fail at runtime but the code must still compile.
 	InternalDispatchMap m_internalDispatchMap;
 
-	std::set<ContractDefinition const*, ASTNode::CompareByID> m_subObjects;
+	std::vector<ContractDefinition const*> m_subObjects;
 
 	langutil::DebugInfoSelection m_debugInfoSelection = {};
 	langutil::CharStreamProvider const* m_soliditySourceProvider = nullptr;

libsolidity/codegen/ir/IRGenerator.cpp

@@ -101,7 +101,7 @@ std::string IRGenerator::generate(
 	std::map<ContractDefinition const*, std::string_view const> const& _otherYulSources
 )
 {
-	auto subObjectSources = [&_otherYulSources](std::set<ContractDefinition const*, ASTNode::CompareByID> const& subObjects) -> std::string
+	auto subObjectSources = [&_otherYulSources](std::vector<ContractDefinition const*> const& subObjects) -> std::string
 	{
 		std::string subObjectsSources;
 		for (ContractDefinition const* subObject: subObjects)

libsolidity/codegen/ir/IRGeneratorForStatements.cpp

@@ -1559,7 +1559,7 @@ void IRGeneratorForStatements::endVisit(FunctionCall const& _functionCall)
 
 		ContractDefinition const* contract =
 			&dynamic_cast<ContractType const&>(*functionType->returnParameterTypes().front()).contractDefinition();
-		m_context.subObjectsCreated().insert(contract);
+		m_context.addSubObject(contract);
 
 		Whiskers t(R"(let <memPos> := <allocateUnbounded>()
 			let <memEnd> := add(<memPos>, datasize("<object>"))
@@ -1947,7 +1947,7 @@ void IRGeneratorForStatements::endVisit(MemberAccess const& _memberAccess)
 			auto const& contractType = dynamic_cast<ContractType const&>(*arg);
 			solAssert(!contractType.isSuper());
 			ContractDefinition const& contract = contractType.contractDefinition();
-			m_context.subObjectsCreated().insert(&contract);
+			m_context.addSubObject(&contract);
 			appendCode() << Whiskers(R"(
 				let <size> := datasize("<objectName>")
 				let <result> := <allocationFunction>(add(<size>, 32))