Skip to content
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

evalengine: Internal cleanup and consistency fixes #14854

Merged
merged 5 commits into from
Dec 27, 2023

Conversation

dbussink
Copy link
Contributor

While working on #14841 and running some tests, I ran into some other issues / consistency problems in the evalengine that we can clean up and fix.

First we use time.Duration for intervals, which already provides constants and we don't have to deal with nanoseconds then separately but they are part of durations.

We clean up the tinyweight function which does a bunch of casting which works but isn't as clear and would actually break on 32 bit (but we don't support that anyway). It now also returns 0, 1 or -1 which is more how other Go Cmp functions work.

We remove int from dataOutOfRangeError since the evalengine only works with int64 or uint64 anyway, so any usage of int would really be a bug (and we didn't deal with uint either so it was inconsistent anyway).

The bit shift operations also need to operate on int64 explicitly, since that's what the inputs are in the evalengine. So we should keep the types consistent.

Next, we were missing a now possible optimization which is that we have size for temporal times at compile time. This means we know if we need to convert to integer or decimal. We don't hit the deoptimize path anymore, and now also error hard if that happens since compilation is broken in that case.

Lastly we were not dealing with underflow / overflow checks correctly in FROM_UNIXTIME between the evaluator and compiler. We need to check before conversions, because specifically float64 to int64 conversions have badly defined behavior for large float64 values. It behaves differently on amd64 vs arm64 vs i386 for example already. Some convert large values to negative ints, others positive or even other values. By checking before casting we avoid this and can behave consistently.

Related Issue(s)

Found when working on #14841

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

While working on vitessio#14841 and
running some tests, I ran into some other issues / consistency problems
in the evalengine that we can clean up and fix.

First we use `time.Duration` for intervals, which already provides
constants and we don't have to deal with nanoseconds then separately but
they are part of durations.

We clean up the tinyweight function which does a bunch of casting which
works but isn't as clear and would actually break on 32 bit (but we
don't support that anyway). It now also returns 0, 1 or -1 which is more
how other Go `Cmp` functions work.

We remove `int` from `dataOutOfRangeError` since the `evalengine` only
works with `int64` or `uint64` anyway, so any usage of `int` would
really be a bug (and we didn't deal with `uint` either so it was
inconsistent anyway).

The bit shift operations also need to operate on int64 explicitly, since
that's what the inputs are in the `evalengine`. So we should keep the
types consistent.

Next, we were missing a now possible optimization which is that we
have size for temporal times at compile time. This means we know if we
need to convert to integer or decimal. We don't hit the deoptimize path
anymore, and now also error hard if that happens since compilation is
broken in that case.

Lastly we were not dealing with underflow / overflow checks correctly in
`FROM_UNIXTIME` between the evaluator and compiler. We need to check
before conversions, because specifically float64 to int64 conversions
have badly defined behavior for large float64 values. It behaves
differently on amd64 vs arm64 vs i386 for example already. Some convert
large values to negative ints, others positive or even other values. By
checking before casting we avoid this and can behave consistently.

Signed-off-by: Dirkjan Bussink <[email protected]>
Copy link
Contributor

vitess-bot bot commented Dec 22, 2023

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Dec 22, 2023
@github-actions github-actions bot added this to the v19.0.0 milestone Dec 22, 2023
@@ -559,52 +559,81 @@ func (b *builtinFromUnixtime) eval(env *ExpressionEnv) (eval, error) {

switch ts := ts.(type) {
case *evalInt64:
if ts.i < 0 || ts.i >= maxUnixtime {
return nil, nil
}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's repetitive, but we have to check up front here. Some fun things:

amd64

Large float turns into negative int64.

int64(1.2345678912345678e300)
-9223372036854775808

arm64

Large float64 turns into max int64.

int64(1.2345678912345678e+300)

9223372036854775807

This means we can't convert before checking overflow / underflow since it won't be consistent.

length = len(num)
bits = int64(shift % 8)
bytes = int64(shift / 8)
length = int64(len(num))
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bit shifting operates on int64 so we should use that consistently.

@dbussink dbussink added Type: Internal Cleanup Component: Evalengine changes to the evaluation engine and removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Dec 22, 2023
Signed-off-by: Dirkjan Bussink <[email protected]>
return (dt.Date.Day()-1)*secondsPerDay + dt.Time.toSeconds()
func (dt DateTime) toDuration() time.Duration {
dur := dt.Time.toDuration()
if !dt.Date.IsZero() {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When we have a zero date (and thus we're a Time type), we don't include the day bit to have a correct duration.

dur := dt.toDuration()
dur += itv.toDuration()
days := time.Duration(0)
if !dt.Date.IsZero() {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rounding shouldn't move days if we're a Time instance. We then can have more than 24 hours.

Signed-off-by: Dirkjan Bussink <[email protected]>
@dbussink dbussink requested a review from deepthi as a code owner December 23, 2023 07:25
@dbussink dbussink merged commit d62a5c5 into vitessio:main Dec 27, 2023
104 checks passed
@dbussink dbussink deleted the dbussink/evalengine-cleanup branch December 27, 2023 07:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Evalengine changes to the evaluation engine Type: Internal Cleanup
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants