Skip to content

C++: take IR Operand locations from definitions #7188

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.

Sign up for GitHub

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

Merged
MathiasVP merged 17 commits into from
Nov 23, 2021
Merged

C++: take IR Operand locations from definitions #7188

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
74c0197
C++: take IR Operand locations from definitions
redsun82 Nov 19, 2021
5202f96
C++: sync Operand source
redsun82 Nov 19, 2021
b5165e3
C++: more fine-grained Operand location change
redsun82 Nov 19, 2021
0ff9520
...and syncing files again
redsun82 Nov 19, 2021
6072ccd
auto-format
redsun82 Nov 22, 2021
28806fe
update test results after operand location changes
redsun82 Nov 22, 2021
4498657
Apply suggestions from code review
redsun82 Nov 22, 2021
d4e80c6
replace shouldDump -> shouldDumpLocation
redsun82 Nov 22, 2021
0547e4c
update further test with new locations
redsun82 Nov 22, 2021
0bb11fa
fix PrintAST test run
redsun82 Nov 22, 2021
9b818a0
sync
redsun82 Nov 22, 2021
30805d9
add `ThisArgumentOperand` special case
redsun82 Nov 23, 2021
8b44d5c
sync files
redsun82 Nov 23, 2021
e99a040
implement review suggestions
redsun82 Nov 23, 2021
d626745
fix `ThisArgumentOperand` location
redsun82 Nov 23, 2021
9538ac7
account for non-existing locations
redsun82 Nov 23, 2021
055017d
fix how non existing locations are accounted for
redsun82 Nov 23, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 24 additions & 2 deletions cpp/ql/lib/semmle/code/cpp/ir/implementation/aliased_ssa/Operand.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ private import internal.OperandInternal
private class TStageOperand =
TRegisterOperand or TNonSSAMemoryOperand or TPhiOperand or TChiOperand;

/**
* A known location. Testing `loc instanceof KnownLocation` will account for non existing locations, as
* opposed to testing `not loc isntanceof UnknownLocation`
*/
private class KnownLocation extends Language::Location {
KnownLocation() { not this instanceof Language::UnknownLocation }
}

/**
* An operand of an `Instruction`. The operand represents a use of the result of one instruction
* (the defining instruction) in another instruction (the use instruction)
Expand All @@ -45,8 +53,10 @@ class Operand extends TStageOperand {

/**
* Gets the location of the source code for this operand.
* By default this is where the operand is used, but some subclasses may override this
* using `getAnyDef()` if it makes more sense.
*/
final Language::Location getLocation() { result = this.getUse().getLocation() }
Language::Location getLocation() { result = this.getUse().getLocation() }

/**
* Gets the function that contains this operand.
Expand Down Expand Up @@ -269,6 +279,10 @@ class RegisterOperand extends NonPhiOperand, TRegisterOperand {

final override string toString() { result = tag.toString() }

// most `RegisterOperands` have a more meaningful location at the definition
// the only exception are specific cases of `ThisArgumentOperand`
override Language::Location getLocation() { result = this.getAnyDef().getLocation() }

final override Instruction getAnyDef() { result = defInstr }

final override Overlap getDefinitionOverlap() {
Expand Down Expand Up @@ -401,11 +415,19 @@ class ArgumentOperand extends RegisterOperand {
}

/**
* An operand representing the implicit 'this' argument to a member function
* An operand representing the implicit `this` argument to a member function
* call.
*/
class ThisArgumentOperand extends ArgumentOperand {
override ThisArgumentOperandTag tag;

// in most cases the def location makes more sense, but in some corner cases it
// has an unknown location: in those cases we fall back to the use location
override Language::Location getLocation() {
if this.getAnyDef().getLocation() instanceof KnownLocation
then result = this.getAnyDef().getLocation()
else result = this.getUse().getLocation()
}
}

/**
Expand Down
26 changes: 24 additions & 2 deletions cpp/ql/lib/semmle/code/cpp/ir/implementation/raw/Operand.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ private import internal.OperandInternal
private class TStageOperand =
TRegisterOperand or TNonSSAMemoryOperand or TPhiOperand or TChiOperand;

/**
* A known location. Testing `loc instanceof KnownLocation` will account for non existing locations, as
* opposed to testing `not loc isntanceof UnknownLocation`
*/
private class KnownLocation extends Language::Location {
KnownLocation() { not this instanceof Language::UnknownLocation }
}

/**
* An operand of an `Instruction`. The operand represents a use of the result of one instruction
* (the defining instruction) in another instruction (the use instruction)
Expand All @@ -45,8 +53,10 @@ class Operand extends TStageOperand {

/**
* Gets the location of the source code for this operand.
* By default this is where the operand is used, but some subclasses may override this
* using `getAnyDef()` if it makes more sense.
*/
final Language::Location getLocation() { result = this.getUse().getLocation() }
Language::Location getLocation() { result = this.getUse().getLocation() }

/**
* Gets the function that contains this operand.
Expand Down Expand Up @@ -269,6 +279,10 @@ class RegisterOperand extends NonPhiOperand, TRegisterOperand {

final override string toString() { result = tag.toString() }

// most `RegisterOperands` have a more meaningful location at the definition
// the only exception are specific cases of `ThisArgumentOperand`
override Language::Location getLocation() { result = this.getAnyDef().getLocation() }

final override Instruction getAnyDef() { result = defInstr }

final override Overlap getDefinitionOverlap() {
Expand Down Expand Up @@ -401,11 +415,19 @@ class ArgumentOperand extends RegisterOperand {
}

/**
* An operand representing the implicit 'this' argument to a member function
* An operand representing the implicit `this` argument to a member function
Copy link
Contributor

@MathiasVP MathiasVP Nov 23, 2021

Choose a reason for hiding this comment

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

Well spotted!

* call.
*/
class ThisArgumentOperand extends ArgumentOperand {
override ThisArgumentOperandTag tag;

// in most cases the def location makes more sense, but in some corner cases it
// has an unknown location: in those cases we fall back to the use location
override Language::Location getLocation() {
if this.getAnyDef().getLocation() instanceof KnownLocation
then result = this.getAnyDef().getLocation()
else result = this.getUse().getLocation()
}
}

/**
Expand Down
26 changes: 24 additions & 2 deletions cpp/ql/lib/semmle/code/cpp/ir/implementation/unaliased_ssa/Operand.qll
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ private import internal.OperandInternal
private class TStageOperand =
TRegisterOperand or TNonSSAMemoryOperand or TPhiOperand or TChiOperand;

/**
* A known location. Testing `loc instanceof KnownLocation` will account for non existing locations, as
* opposed to testing `not loc isntanceof UnknownLocation`
*/
private class KnownLocation extends Language::Location {
KnownLocation() { not this instanceof Language::UnknownLocation }
}

/**
* An operand of an `Instruction`. The operand represents a use of the result of one instruction
* (the defining instruction) in another instruction (the use instruction)
Expand All @@ -45,8 +53,10 @@ class Operand extends TStageOperand {

/**
* Gets the location of the source code for this operand.
* By default this is where the operand is used, but some subclasses may override this
* using `getAnyDef()` if it makes more sense.
*/
final Language::Location getLocation() { result = this.getUse().getLocation() }
Language::Location getLocation() { result = this.getUse().getLocation() }

/**
* Gets the function that contains this operand.
Expand Down Expand Up @@ -269,6 +279,10 @@ class RegisterOperand extends NonPhiOperand, TRegisterOperand {

final override string toString() { result = tag.toString() }

// most `RegisterOperands` have a more meaningful location at the definition
// the only exception are specific cases of `ThisArgumentOperand`
override Language::Location getLocation() { result = this.getAnyDef().getLocation() }

final override Instruction getAnyDef() { result = defInstr }

final override Overlap getDefinitionOverlap() {
Expand Down Expand Up @@ -401,11 +415,19 @@ class ArgumentOperand extends RegisterOperand {
}

/**
* An operand representing the implicit 'this' argument to a member function
* An operand representing the implicit `this` argument to a member function
* call.
*/
class ThisArgumentOperand extends ArgumentOperand {
override ThisArgumentOperandTag tag;

// in most cases the def location makes more sense, but in some corner cases it
// has an unknown location: in those cases we fall back to the use location
override Language::Location getLocation() {
if this.getAnyDef().getLocation() instanceof KnownLocation
then result = this.getAnyDef().getLocation()
else result = this.getUse().getLocation()
}
}

/**
Expand Down
Loading