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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Package SideEffects3 with added performance fixes #282

Merged
merged 22 commits into from
Mar 30, 2023

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented Mar 30, 2023

Description

#272 implements the SideEffects3 package. This PR includes that PR and makes the following changes:

  • Updates the metadata files for this package.
  • Improves performance.

@knewbury01 @mbaluda @jsinglet I'm putting this up so that we can merge the SideEffects3 PR without needing to wait for Remco to wake up 馃槾 . I've approved the original PR, but I think we should merge this instead, if one of you can review the new commits I've added on this branch.

Change request type

  • Release or process automation (GitHub workflows, internal scripts)
  • Internal documentation
  • External documentation
  • Query files (.ql, .qll, .qls or unit tests)
  • External scripts (analysis report or other code shipped as part of a release)

Rules with added or modified queries

  • No rules added
  • Queries have been added for the following rules:
    • Rule 13.2
  • Queries have been modified for the following rules:
    • rule number here

Release change checklist

A change note (development_handbook.md#change-notes) is required for any pull request which modifies:

  • The structure or layout of the release artifacts.
  • The evaluation performance (memory, execution time) of an existing query.
  • The results of an existing query in any circumstance.

If you are only adding new rule queries, a change note is not required.

Author: Is a change note required?

  • Yes
  • No

馃毃馃毃馃毃
Reviewer: Confirm that format of shared queries (not the .qll file, the
.ql file that imports it) is valid by running them within VS Code.

  • Confirmed

Reviewer: Confirm that either a change note is not required or the change note is required and has been added.

  • Confirmed

Query development review checklist

For PRs that add new queries or modify existing queries, the following checklist should be completed by both the author and reviewer:

Author

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

Reviewer

  • Have all the relevant rule package description files been checked in?
  • Have you verified that the metadata properties of each new query is set appropriately?
  • Do all the unit tests contain both "COMPLIANT" and "NON_COMPLIANT" cases?
  • Are the alert messages properly formatted and consistent with the style guide?
  • Have you run the queries on OpenPilot and verified that the performance and results are acceptable?
    As a rule of thumb, predicates specific to the query should take no more than 1 minute, and for simple queries be under 10 seconds. If this is not the case, this should be highlighted and agreed in the code review process.
  • Does the query have an appropriate level of in-query comments/documentation?
  • Have you considered/identified possible edge cases?
  • Does the query not reinvent features in the standard library?
  • Can the query be simplified further (not golfed!)

rvermeulen and others added 20 commits March 27, 2023 21:57
- Only consider unsequenced side effects to the same objects, unless
- the two unsequenced side effects target two different volatile
  objects.
- Don't allow unsequenced modification and reading of the same object,
  unless the reading is part of establishing the value of the
  modification.
Avoid expensive cross-products on the ConditionalExpr case, and filter
by partial expressions earlier in the predicate set.
Extract out the main computation from the exclusion mechanism, otherwise
the exclusion mechanism runs on a potentially very large intermediate
step (sameFullExpr).
@mbaluda mbaluda self-requested a review March 30, 2023 11:01
Copy link
Contributor

@mbaluda mbaluda left a comment

Choose a reason for hiding this comment

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

馃殌

@lcartey lcartey enabled auto-merge March 30, 2023 11:07
@lcartey lcartey added this pull request to the merge queue Mar 30, 2023
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to a conflict with the base branch Mar 30, 2023
@lcartey lcartey enabled auto-merge March 30, 2023 13:27
@lcartey lcartey added this pull request to the merge queue Mar 30, 2023
@lcartey lcartey merged commit 90b4bda into main Mar 30, 2023
@lcartey lcartey deleted the lcartey/side-effects3-perf branch March 30, 2023 14:52
@lcartey lcartey mentioned this pull request Mar 30, 2023
30 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants