-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Support constants in custom storage layout expression #15944
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Changes from all commits
721cef3
54c4b91
484148d
6b8a352
d1dbd2e
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -23,6 +23,7 @@ | |
#include <libsolidity/analysis/PostTypeContractLevelChecker.h> | ||
|
||
#include <fmt/format.h> | ||
#include <libsolidity/analysis/ConstantEvaluator.h> | ||
#include <libsolidity/ast/AST.h> | ||
#include <libsolidity/ast/ASTUtils.h> | ||
#include <libsolidity/ast/TypeProvider.h> | ||
|
@@ -101,29 +102,61 @@ void PostTypeContractLevelChecker::checkStorageLayoutSpecifier(ContractDefinitio | |
} | ||
|
||
auto const* baseSlotExpressionType = type(baseSlotExpression); | ||
auto const* rationalType = dynamic_cast<RationalNumberType const*>(baseSlotExpressionType); | ||
if (!rationalType) | ||
if ( | ||
!dynamic_cast<IntegerType const*>(baseSlotExpressionType) && | ||
!dynamic_cast<RationalNumberType const*>(baseSlotExpressionType) | ||
) | ||
{ | ||
m_errorReporter.typeError( | ||
6396_error, | ||
baseSlotExpression.location(), | ||
"The base slot of the storage layout must evaluate to a rational number." | ||
"The base slot of the storage layout must evaluate to a rational integer number." | ||
); | ||
return; | ||
} | ||
|
||
if (rationalType->isFractional()) | ||
rational baseSlotRationalValue; | ||
if (auto const integerType = dynamic_cast<IntegerType const*>(baseSlotExpressionType)) | ||
{ | ||
m_errorReporter.typeError( | ||
1763_error, | ||
baseSlotExpression.location(), | ||
"The base slot of the storage layout must evaluate to an integer." | ||
); | ||
return; | ||
if (integerType->isSigned()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This could also be removed from here and then replace the assert in line There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Depends. The range check should catch it anyway and it provides a message that will be clearer to the user so I'd rather not check it. Removing this and adding an assert would be a better choice. But I'm not sure if we will actually reach that check with constants. What happens in this case if you remove the int constant X = -1;
contract C layout at X {} |
||
{ | ||
m_errorReporter.typeError( | ||
1481_error, | ||
baseSlotExpression.location(), | ||
"The base slot expression must have an unsigned integer type." | ||
); | ||
return; | ||
} | ||
std::optional<ConstantEvaluator::TypedRational> typedRational = ConstantEvaluator::evaluate(m_errorReporter, baseSlotExpression); | ||
if (!typedRational) | ||
{ | ||
m_errorReporter.typeError( | ||
1505_error, | ||
baseSlotExpression.location(), | ||
"The base slot expression cannot be evaluated during compilation." | ||
); | ||
return; | ||
} | ||
baseSlotRationalValue = typedRational->value; | ||
} | ||
else | ||
{ | ||
auto const* rationalType = dynamic_cast<RationalNumberType const*>(baseSlotExpressionType); | ||
solAssert(rationalType); | ||
if (rationalType->isFractional()) | ||
{ | ||
m_errorReporter.typeError( | ||
1763_error, | ||
baseSlotExpression.location(), | ||
"The base slot of the storage layout must evaluate to an integer." | ||
); | ||
return; | ||
} | ||
baseSlotRationalValue = rationalType->value(); | ||
} | ||
solAssert(rationalType->value().denominator() == 1); | ||
|
||
bigint baseSlot = rationalType->value().numerator(); | ||
solAssert(baseSlotRationalValue.denominator() == 1); | ||
bigint baseSlot = baseSlotRationalValue.numerator(); | ||
if (!(0 <= baseSlot && baseSlot <= std::numeric_limits<u256>::max())) | ||
{ | ||
m_errorReporter.typeError( | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at abi.decode(abi.encode(42), (uint)) {} | ||
// ---- | ||
// TypeError 6396: (21-55): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (21-55): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at address(0x1234) {} | ||
// ---- | ||
// TypeError 6396: (21-36): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-36): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
address constant x = 0xdCad3a6d3569DF655070DEd06cb7A1b2Ccd1D3AF; | ||
contract C layout at x { | ||
|
||
} | ||
// ---- | ||
// TypeError 6396: (86-87): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at [1, 2, 3] {} | ||
// ---- | ||
// TypeError 6396: (21-30): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-30): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -1,3 +1,3 @@ | ||||||
contract C layout at ~uint(0xFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF) {} | ||||||
// ---- | ||||||
// TypeError 6396: (21-94): The base slot of the storage layout must evaluate to a rational number. | ||||||
// TypeError 1505: (21-94): The base slot expression cannot be evaluated during compilation. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think that users will be confused about why we can't evaluate this, because fundamentally it should be possible. It's documented, but maybe it would not hurt to just say that the constant evaluator is just too limited for this?
Suggested change
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
bool constant x = false; | ||
contract C layout at x {} | ||
// ---- | ||
// TypeError 6396: (46-47): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at true {} | ||
// ---- | ||
// TypeError 6396: (21-25): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-25): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
bytes32 constant x = "ABC"; | ||
contract A layout at x {} | ||
contract C layout at x[1] {} | ||
// ---- | ||
// TypeError 6396: (49-50): The base slot of the storage layout must evaluate to a rational integer number. | ||
// TypeError 6396: (75-79): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
uint constant N = 100; | ||
contract C layout at N / ~N {} | ||
// ---- | ||
// TypeError 6396: (44-50): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 3667: (48-50): Arithmetic error when computing constant value. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
uint constant N = 100; | ||
contract C layout at N / 0 {} | ||
// ---- | ||
// TypeError 6396: (44-49): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (44-49): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,4 +4,4 @@ contract A { | |
|
||
contract C is A layout at A.x { } | ||
// ---- | ||
// TypeError 6396: (68-71): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (68-71): The base slot expression cannot be evaluated during compilation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one is weird. Why are we getting this and not something like:
Is |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
==== Source: A ==== | ||
uint constant x = 77; | ||
|
||
==== Source: B ==== | ||
import "A" as M; | ||
contract C layout at M.x{ } | ||
// ---- | ||
// TypeError 1505: (B:38-41): The base slot expression cannot be evaluated during compilation. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one should work without errors. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same for |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
uint constant x = addmod(10, 2, 8); | ||
uint constant y = mulmod(10, 2, 8); | ||
contract C layout at x {} | ||
contract D layout at y {} | ||
// ---- | ||
// TypeError 1505: (93-94): The base slot expression cannot be evaluated during compilation. | ||
// TypeError 1505: (119-120): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
uint constant x = uint(42); | ||
contract C layout at x {} | ||
// ---- | ||
// TypeError 1505: (49-50): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
uint constant x = 42; | ||
uint constant y = x * 2; | ||
contract C layout at y {} | ||
// ---- |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
uint constant x = ((2**5 + 2**5) * (2 ** 10 + 1 << 1)) % 2**256 - 1; | ||
contract C layout at x {} | ||
// ---- |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at 0xdCad3a6d3569DF655070DEd06cb7A1b2Ccd1D3AF {} | ||
// ---- | ||
// TypeError 6396: (21-63): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-63): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at hex"616263" {} | ||
// ---- | ||
// TypeError 6396: (21-32): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-32): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract at layout at uint40(bytes5(hex"0011223344")) { } | ||
// ---- | ||
// TypeError 6396: (22-53): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (22-53): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
contract A { | ||
address immutable a = 0x0000000000000000000000000000000000000001; | ||
uint immutable x = 1; | ||
Comment on lines
+2
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please also add an immutable that's not pure (i.e. one that's not initialized with a literal) since that's a separate case. Also a comment explaining how they differ. |
||
} | ||
|
||
contract B is A layout at A.a { } | ||
contract C is A layout at A.x { } | ||
// ---- | ||
// TypeError 1139: (138-141): The base slot of the storage layout must be a compile-time constant expression. | ||
// TypeError 1139: (172-175): The base slot of the storage layout must be a compile-time constant expression. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
int constant x = -42; | ||
contract C layout at x {} | ||
// ---- | ||
// TypeError 1481: (43-44): The base slot expression must have an unsigned integer type. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
bytes32 constant b = "bytes"; | ||
contract A layout at b[1] {} | ||
// ---- | ||
// TypeError 6396: (51-55): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (51-55): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,3 @@ | ||
uint constant X = 42; | ||
contract C layout at 0xffff * (50 - X) { } | ||
// ---- | ||
// TypeError 6396: (43-60): The base slot of the storage layout must evaluate to a rational number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
contract A {} | ||
contract C layout at A(address(0x1234)) {} | ||
// ---- | ||
// TypeError 6396: (35-53): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (35-53): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract A layout at uint {} | ||
// ---- | ||
// TypeError 6396: (21-25): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-25): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract at layout at uint(42) { } | ||
// ---- | ||
// TypeError 6396: (22-30): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (22-30): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
contract A layout at addmod(1, 2, 3) {} | ||
contract B layout at mulmod(3, 2, 1) {} | ||
// ---- | ||
// TypeError 6396: (21-36): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (61-76): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (21-36): The base slot expression cannot be evaluated during compilation. | ||
// TypeError 1505: (61-76): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at "MyLayoutBase" {} | ||
// ---- | ||
// TypeError 6396: (21-35): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-35): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
contract A layout at true ? 42 : 94 {} | ||
contract B layout at 255 + (true ? 1 : 0) {} | ||
// ---- | ||
// TypeError 6396: (21-35): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (60-80): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (21-35): The base slot expression cannot be evaluated during compilation. | ||
// TypeError 1505: (60-80): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract C layout at (1, 2, 3) {} | ||
// ---- | ||
// TypeError 6396: (21-30): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (21-30): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,3 @@ | ||
contract at layout at type(uint).max { } | ||
// ---- | ||
// TypeError 6396: (22-36): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (22-36): The base slot expression cannot be evaluated during compilation. | ||
Comment on lines
1
to
+3
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was hoping this would work already in this PR, but apparently it's another thing that requires proper compile-time evaluation... #11183 (comment) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
type MyUint is uint128; | ||
contract C layout at MyUint.wrap(42) {} | ||
// ---- | ||
// TypeError 6396: (45-60): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (45-60): The base slot of the storage layout must evaluate to a rational integer number. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
contract A layout at [1, 2, 3][0] {} | ||
contract B layout at 255 + [1, 2, 3][0] {} | ||
// ---- | ||
// TypeError 6396: (21-33): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 6396: (58-76): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (21-33): The base slot expression cannot be evaluated during compilation. | ||
// TypeError 1505: (58-76): The base slot expression cannot be evaluated during compilation. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
bytes32 constant b = "Solidity"; | ||
contract C layout at uint8(b[1]) {} | ||
// ---- | ||
// TypeError 6396: (54-65): The base slot of the storage layout must evaluate to a rational number. | ||
// TypeError 1505: (54-65): The base slot expression cannot be evaluated during compilation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We could also say
a rational number or an integer
, but not sure if the user will get the distinction. Unfortunately, out terminology here is a bit ambiguous.