Applied the review comments

AndreiDiaconu1 · AndreiDiaconu1 · commit 49777636aaf4 · 2019-08-28T12:25:13.000+01:00
diff --git a/csharp/ql/src/semmle/code/csharp/ir/IR.qll b/csharp/ql/src/semmle/code/csharp/ir/IR.qll
@@ -1,4 +1,5 @@
-// Most queries should operate on the aliased SSA IR, so that's what we expose
-// publically as the "IR".
-//import implementation.aliased_ssa.IR
+/**
+ * Most queries should operate on the aliased SSA IR, so that's what we expose
+ * publicly as the "IR".
+ */
 import implementation.raw.IR
diff --git a/csharp/ql/src/semmle/code/csharp/ir/IRConfiguration.qll b/csharp/ql/src/semmle/code/csharp/ir/IRConfiguration.qll
@@ -1,3 +1,7 @@
+/**
+ * Module used to configure the IR generation process.
+ */
+
 import csharp
 
 private newtype TIRConfiguration = MkIRConfiguration()
diff --git a/csharp/ql/src/semmle/code/csharp/ir/Util.qll b/csharp/ql/src/semmle/code/csharp/ir/Util.qll
@@ -7,7 +7,6 @@ import csharp
 class ArrayInitWithMod extends ArrayInitializer {
   predicate isInitialized(int entry) { entry in [0 .. this.getNumberOfElements() - 1] }
 
-  pragma[inline]
   predicate isValueInitialized(int elementIndex) {
     isInitialized(elementIndex) and
     not exists(this.getElement(elementIndex))
@@ -20,7 +19,6 @@ class ObjectInitializerMod extends ObjectInitializer {
     this.getAMemberInitializer().getTargetVariable() = field
   }
 
-  pragma[inline]
   predicate isValueInitialized(Field field) {
     this.isInitialized(field) and
     not field = this.getAMemberInitializer().getInitializedMember()
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/IRConfiguration.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/IRConfiguration.qll
@@ -1,3 +1,7 @@
+/**
+ * Module used to configure the IR generation process.
+ */
+
 private import internal.IRConfigurationInternal
 
 private newtype TIRConfiguration = MkIRConfiguration()
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/SSA.md b/csharp/ql/src/semmle/code/csharp/ir/implementation/SSA.md
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/IRConstruction.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/IRConstruction.qll
@@ -55,14 +55,10 @@ cached private module Cached {
     )
   }
   
-  // TODO: Conversion? Cast?
   cached Expr getInstructionUnconvertedResultExpression(Instruction instruction) {
     exists(Expr converted, TranslatedExpr translatedExpr |
-      result = converted.(Cast).getExpr+()
-      or
-      result = converted
+      result = converted.stripCasts()
       |
-      not result instanceof Cast and
       translatedExpr = getTranslatedExpr(converted) and
       instruction = translatedExpr.getResult()
     )
@@ -73,21 +69,19 @@ cached private module Cached {
       getInstructionTag(instruction), tag)
   }
 
-  cached Instruction getMemoryOperandDefinition(Instruction instruction, MemoryOperandTag tag, Overlap overlap) {
+  cached Instruction getMemoryOperandDefinition(Instruction instruction, MemoryOperandTag tag, MustTotallyOverlap overlap) {
     result = getInstructionTranslatedElement(instruction).getInstructionOperand(
-      getInstructionTag(instruction), tag) and
-    overlap instanceof MustTotallyOverlap
+      getInstructionTag(instruction), tag)
   }
 
   cached Type getInstructionOperandType(Instruction instruction, TypedOperandTag tag) {
     // For all `LoadInstruction`s, the operand type of the `LoadOperand` is the same as
     // the result type of the load.
-    result = instruction.(LoadInstruction).getResultType() or
-    (
-      not instruction instanceof LoadInstruction and 
+    if instruction instanceof LoadInstruction then
+      result = instruction.(LoadInstruction).getResultType()
+    else
       result = getInstructionTranslatedElement(instruction).getInstructionOperandType(
         getInstructionTag(instruction), tag)
-    )
   }
 
   cached int getInstructionOperandSize(Instruction instruction, SideEffectOperandTag tag) {
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/InstructionTag.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/InstructionTag.qll
@@ -2,14 +2,8 @@ import csharp
 import semmle.code.csharp.ir.Util
 
 
-// TODO: Both exists needed?
 private predicate fieldIsInitialized(Field field) {
-  exists(ObjectInitializer initList | 
-  	exists(int i | field = initList.getMemberInitializer(i).getInitializedMember())
-  ) or
-  exists(MemberInitializer init |
-    field = init.getInitializedMember()
-  )
+  exists(field.getInitializer())
 }
 
 private predicate elementIsInitialized(int elementIndex) {
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedCall.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedCall.qll
@@ -5,6 +5,7 @@ private import InstructionTag
 private import TranslatedElement
 private import TranslatedExpr
 private import semmle.code.csharp.ir.Util
+private import semmle.code.csharp.ir.internal.IRCSharpLanguage as Language
 
 /**
  * The IR translation of a call to a function. The call may be from an actual
@@ -45,12 +46,11 @@ abstract class TranslatedCall extends TranslatedExpr {
       (
         if hasWriteSideEffect() then (
           opcode instanceof Opcode::CallSideEffect and
-          // Was UnknownType, fix after comp layer
-          resultType instanceof VoidType
+          resultType instanceof Language::UnknownType
         )
         else (
           opcode instanceof Opcode::CallReadSideEffect and
-          resultType instanceof VoidType
+          resultType instanceof Language::UnknownType
         )
       ) and
       isLValue = false
@@ -126,8 +126,7 @@ abstract class TranslatedCall extends TranslatedExpr {
     tag = CallSideEffectTag() and
     hasSideEffect() and
     operandTag instanceof SideEffectOperandTag and
-    // TODO: Was UnknownType, fix after comp layer
-    result instanceof VoidType
+    result instanceof Language::UnknownType
   }
 
   override final Instruction getResult() {
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedCondition.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedCondition.qll
@@ -152,6 +152,11 @@ abstract class TranslatedBinaryLogicalOperation extends
   final TranslatedCondition getRightOperand() {
     result = getTranslatedCondition(expr.getRightOperand())
   }
+  
+  final TranslatedCondition getAnOperand() {
+    result = getLeftOperand() or 
+    result = getRightOperand()
+  }
 }
 
 class TranslatedLogicalAndExpr extends TranslatedBinaryLogicalOperation {
@@ -171,7 +176,7 @@ class TranslatedLogicalAndExpr extends TranslatedBinaryLogicalOperation {
   }
 
   override Instruction getChildFalseSuccessor(TranslatedCondition child) {
-    (child = getLeftOperand() or child = getRightOperand()) and
+    child = getAnOperand() and
     result = getConditionContext().getChildFalseSuccessor(this)
   }
 }
@@ -180,7 +185,7 @@ class TranslatedLogicalOrExpr extends TranslatedBinaryLogicalOperation {
   override LogicalOrExpr expr;
 
   override Instruction getChildTrueSuccessor(TranslatedCondition child) {
-    (child = getLeftOperand() or child = getRightOperand()) and
+    child = getAnOperand() and
     result = getConditionContext().getChildTrueSuccessor(this)
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedDeclarationEntry.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedDeclarationEntry.qll
@@ -60,7 +60,7 @@ class TranslatedNonVariableDeclarationEntry extends TranslatedDeclarationEntry {
       Type resultType, boolean isLValue) {
     opcode instanceof Opcode::NoOp and
     tag = OnlyInstructionTag() and
-    resultType instanceof VoidType and
+    resultType instanceof Language::UnknownType and
     isLValue = false
   }
 
diff --git a/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedFunction.qll b/csharp/ql/src/semmle/code/csharp/ir/implementation/raw/internal/TranslatedFunction.qll
@@ -11,8 +11,6 @@ private import TranslatedInitialization
 private import TranslatedStmt
 private import semmle.code.csharp.ir.internal.IRCSharpLanguage as Language
 
-//TODO: Reason about constructors and destructors
-
 /**
  * Gets the `TranslatedFunction` that represents function `callable`.
  */
@@ -157,17 +155,13 @@ class TranslatedFunction extends TranslatedElement,
       (
         tag = UnmodeledDefinitionTag() and
         opcode instanceof Opcode::UnmodeledDefinition and
-        // TODO: UnknownType seems to break it.
-        //       For now, in the context of C#, ObjectType seems sensible.
-        resultType instanceof ObjectType and
+        resultType instanceof Language::UnknownType and
         isLValue = false
       ) or
       (
         tag = AliasedDefinitionTag() and
         opcode instanceof Opcode::AliasedDefinition and
-        // TODO: UnknownType seems to break it.
-        //       For now, in the context of C#, ObjectType seems sensible.
-        resultType instanceof ObjectType and
+        resultType instanceof Language::UnknownType and
         isLValue = false
       ) or
       (
diff --git a/csharp/ql/src/semmle/code/csharp/ir/internal/IRCSharpLanguage.qll b/csharp/ql/src/semmle/code/csharp/ir/internal/IRCSharpLanguage.qll
@@ -6,7 +6,7 @@ class AST = CSharp::Element;
 
 class Type = CSharp::Type;
 //REVIEW: This might not exist in the database. 
-class UnknownType = CSharp::UnknownType;
+class UnknownType = CSharp::NullType;
 class VoidType = CSharp::VoidType;
 class IntegralType = CSharp::IntegralType;
 class FloatingPointType = CSharp::FloatingPointType;
diff --git a/csharp/ql/test/library-tests/ir/ir/raw_ir.expected b/csharp/ql/test/library-tests/ir/ir/raw_ir.expected

Original file line number	Diff line number	Diff line change
`@@ -55,14 +55,10 @@ cached private module Cached {`
`55`	`55`	`)`
`56`	`56`	`}`
`57`	`57`
`58`		`- // TODO: Conversion? Cast?`
`59`	`58`	`cached Expr getInstructionUnconvertedResultExpression(Instruction instruction) {`
`60`	`59`	`exists(Expr converted, TranslatedExpr translatedExpr \|`
`61`		`- result = converted.(Cast).getExpr+()`
`62`		`- or`
`63`		`- result = converted`
	`60`	`+ result = converted.stripCasts()`
`64`	`61`	`\|`
`65`		`- not result instanceof Cast and`
`66`	`62`	`translatedExpr = getTranslatedExpr(converted) and`
`67`	`63`	`instruction = translatedExpr.getResult()`
`68`	`64`	`)`
`@@ -73,21 +69,19 @@ cached private module Cached {`
`73`	`69`	`getInstructionTag(instruction), tag)`
`74`	`70`	`}`
`75`	`71`
`76`		`- cached Instruction getMemoryOperandDefinition(Instruction instruction, MemoryOperandTag tag, Overlap overlap) {`
	`72`	`+ cached Instruction getMemoryOperandDefinition(Instruction instruction, MemoryOperandTag tag, MustTotallyOverlap overlap) {`
`77`	`73`	`result = getInstructionTranslatedElement(instruction).getInstructionOperand(`
`78`		`- getInstructionTag(instruction), tag) and`
`79`		`- overlap instanceof MustTotallyOverlap`
	`74`	`+ getInstructionTag(instruction), tag)`
`80`	`75`	`}`
`81`	`76`
`82`	`77`	`cached Type getInstructionOperandType(Instruction instruction, TypedOperandTag tag) {`
`83`	`78`	// For all `LoadInstruction`s, the operand type of the `LoadOperand` is the same as
`84`	`79`	`// the result type of the load.`
`85`		`- result = instruction.(LoadInstruction).getResultType() or`
`86`		`- (`
`87`		`- not instruction instanceof LoadInstruction and`
	`80`	`+ if instruction instanceof LoadInstruction then`
	`81`	`+ result = instruction.(LoadInstruction).getResultType()`
	`82`	`+ else`
`88`	`83`	`result = getInstructionTranslatedElement(instruction).getInstructionOperandType(`
`89`	`84`	`getInstructionTag(instruction), tag)`
`90`		`- )`
`91`	`85`	`}`
`92`	`86`
`93`	`87`	`cached int getInstructionOperandSize(Instruction instruction, SideEffectOperandTag tag) {`
Original file line number	Diff line number	Diff line change
`@@ -152,6 +152,11 @@ abstract class TranslatedBinaryLogicalOperation extends`
`152`	`152`	`final TranslatedCondition getRightOperand() {`
`153`	`153`	`result = getTranslatedCondition(expr.getRightOperand())`
`154`	`154`	`}`
	`155`	`+`
	`156`	`+ final TranslatedCondition getAnOperand() {`
	`157`	`+ result = getLeftOperand() or`
	`158`	`+ result = getRightOperand()`
	`159`	`+ }`
`155`	`160`	`}`
`156`	`161`
`157`	`162`	`class TranslatedLogicalAndExpr extends TranslatedBinaryLogicalOperation {`
`@@ -171,7 +176,7 @@ class TranslatedLogicalAndExpr extends TranslatedBinaryLogicalOperation {`
`171`	`176`	`}`
`172`	`177`
`173`	`178`	`override Instruction getChildFalseSuccessor(TranslatedCondition child) {`
`174`		`- (child = getLeftOperand() or child = getRightOperand()) and`
	`179`	`+ child = getAnOperand() and`
`175`	`180`	`result = getConditionContext().getChildFalseSuccessor(this)`
`176`	`181`	`}`
`177`	`182`	`}`
`@@ -180,7 +185,7 @@ class TranslatedLogicalOrExpr extends TranslatedBinaryLogicalOperation {`
`180`	`185`	`override LogicalOrExpr expr;`
`181`	`186`
`182`	`187`	`override Instruction getChildTrueSuccessor(TranslatedCondition child) {`
`183`		`- (child = getLeftOperand() or child = getRightOperand()) and`
	`188`	`+ child = getAnOperand() and`
`184`	`189`	`result = getConditionContext().getChildTrueSuccessor(this)`
`185`	`190`	`}`
`186`	`191`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ class TranslatedNonVariableDeclarationEntry extends TranslatedDeclarationEntry {`
`60`	`60`	`Type resultType, boolean isLValue) {`
`61`	`61`	`opcode instanceof Opcode::NoOp and`
`62`	`62`	`tag = OnlyInstructionTag() and`
`63`		`- resultType instanceof VoidType and`
	`63`	`+ resultType instanceof Language::UnknownType and`
`64`	`64`	`isLValue = false`
`65`	`65`	`}`
`66`	`66`