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

EssentialType: Implement correct essential types for bitwise binary operators &, ^ and |. #787

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

lcartey
Copy link
Collaborator

@lcartey lcartey commented Oct 28, 2024

Description

Fixes #786.

Implements correct behaviour for binary bitwise operators.

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 number here
  • Queries have been modified for the following rules:
    • RULE-10-1
    • RULE-10-3
    • RULE-10-4
    • RULE-10-5
    • RULE-10-6
    • RULE-10-7
    • RULE-10-8
    • RULE-12-2

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!)

if exists(getValue())
then result = stlr(this)
else (
if leftEssentialType.getSize() > rightEssentialType.getSize()
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems we should have a predicate Type maxRank(Type a, Type b) to simplify this repetition

leftEssentialTypeCategory = getEssentialTypeCategory(leftEssentialType) and
rightEssentialTypeCategory = getEssentialTypeCategory(rightEssentialType)
|
if
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this is now the third occurrence of this pattern, may be worth creating some kind of predicate to deduplicate this/reduce the bloat. Perhaps something like coalesce<stlr>(this, leftEssentialType, rightEssentialType, EssentiallySignedType()), even just bothSigned(leftEssentialType, rightEssentialType) could reduce the boilerplate. And it might be worthy of a bigger hammer such as Type standardCombine(Expr e, Expr operandA, Expr operandB)

s32 ^ s16; // Essentially signed, int
s16 ^ s32; // Essentially signed, int

u32 & s32; // Essentially signed, int
Copy link
Contributor

Choose a reason for hiding this comment

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

These are essentially unsigned ints in the .expected file, which I think is correct based on c11 spec

if the operand that has unsigned integer type has rank greater or
equal to the rank of the type of the other operand, then the operand with
signed integer type is converted to the type of the operand with unsigned
integer type.

class EssentialBinaryBitwiseExpr extends EssentialExpr, BinaryBitwiseOperation {
EssentialBinaryBitwiseExpr() {
not this instanceof LShiftExpr and
not this instanceof RShiftExpr
Copy link
Contributor

Choose a reason for hiding this comment

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

Any concern here about future updates to the characteristic predicate of EssentialShiftOperationExpr that aren't matched here (and vice versa)? In theory we could not find certain expressions to analyze, or worse, return two results from the overriden member predicates.

It may be better to entangle them here, eg, not this instanceof EssentialBinaryBitwiseOperationExpr

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RULE-10-3: Essential type of binary bitwise operations is incorrect
2 participants