Skip to content

Commit 97035ae

Browse files
jbjjbj
authored
Merge pull request #2848 from geoffw0/model-sideeffects
C++: Disambiguate SideEffectFunction QLDoc.
2 parents de66841 + 4f1a23e commit 97035ae

File tree

6 files changed

+43
-48
lines changed

6 files changed

+43
-48
lines changed

‎cpp/ql/src/semmle/code/cpp/models/implementations/Pure.qll‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ class PureStrFunction extends AliasFunction, ArrayFunction, TaintFunction, SideE
8080

8181
override predicate parameterIsAlwaysReturned(int i) { none() }
8282

83-
override predicate hasOnlySpecificReadSideEffects() { none() }
83+
override predicate hasOnlySpecificReadSideEffects() { any() }
8484

8585
override predicate hasOnlySpecificWriteSideEffects() { any() }
8686

‎cpp/ql/src/semmle/code/cpp/models/interfaces/SideEffect.qll‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,18 @@ abstract class SideEffectFunction extends Function {
1818
/**
1919
* Holds if the function never reads from memory that was defined before entry to the function.
2020
* This memory could be from global variables, or from other memory that was reachable from a
21-
* pointer that was passed into the function.
21+
* pointer that was passed into the function. Input side-effects, and reads from memory that
22+
* cannot be visible to the caller (for example a buffer inside an I/O library) are not modeled
23+
* here.
2224
*/
2325
abstract predicate hasOnlySpecificReadSideEffects();
2426

2527
/**
2628
* Holds if the function never writes to memory that remains allocated after the function
2729
* returns. This memory could be from global variables, or from other memory that was reachable
28-
* from a pointer that was passed into the function.
30+
* from a pointer that was passed into the function. Output side-effects, and writes to memory
31+
* that cannot be visible to the caller (for example a buffer inside an I/O library) are not
32+
* modeled here.
2933
*/
3034
abstract predicate hasOnlySpecificWriteSideEffects();
3135

@@ -43,7 +47,6 @@ abstract class SideEffectFunction extends Function {
4347
*/
4448
predicate hasSpecificReadSideEffect(ParameterIndex i, boolean buffer) { none() }
4549

46-
// TODO: name?
4750
/**
4851
* Gets the index of the parameter that indicates the size of the buffer pointed to by the
4952
* parameter at index `i`.

‎cpp/ql/test/library-tests/ir/ssa/aliased_ssa_ir.expected‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -886,27 +886,25 @@ ssa.cpp:
886886
# 199| r199_7(char *) = Load : &:r199_6, m198_11
887887
# 199| r199_8(char *) = Convert : r199_7
888888
# 199| r199_9(int) = Call : func:r199_2, 0:r199_5, 1:r199_8
889-
# 199| v199_10(void) = ^CallReadSideEffect : ~m198_4
890-
# 199| v199_11(void) = ^BufferReadSideEffect[0] : &:r199_5, ~m198_9
891-
# 199| v199_12(void) = ^BufferReadSideEffect[1] : &:r199_8, ~m198_13
892-
# 199| m199_13(int) = Store : &:r199_1, r199_9
889+
# 199| v199_10(void) = ^BufferReadSideEffect[0] : &:r199_5, ~m198_9
890+
# 199| v199_11(void) = ^BufferReadSideEffect[1] : &:r199_8, ~m198_13
891+
# 199| m199_12(int) = Store : &:r199_1, r199_9
893892
# 200| r200_1(glval<unknown>) = FunctionAddress[strlen] :
894893
# 200| r200_2(glval<char *>) = VariableAddress[str1] :
895894
# 200| r200_3(char *) = Load : &:r200_2, m198_7
896895
# 200| r200_4(char *) = Convert : r200_3
897896
# 200| r200_5(int) = Call : func:r200_1, 0:r200_4
898-
# 200| v200_6(void) = ^CallReadSideEffect : ~m198_4
899-
# 200| v200_7(void) = ^BufferReadSideEffect[0] : &:r200_4, ~m198_9
900-
# 200| r200_8(glval<int>) = VariableAddress[ret] :
901-
# 200| r200_9(int) = Load : &:r200_8, m199_13
902-
# 200| r200_10(int) = Add : r200_9, r200_5
903-
# 200| m200_11(int) = Store : &:r200_8, r200_10
897+
# 200| v200_6(void) = ^BufferReadSideEffect[0] : &:r200_4, ~m198_9
898+
# 200| r200_7(glval<int>) = VariableAddress[ret] :
899+
# 200| r200_8(int) = Load : &:r200_7, m199_12
900+
# 200| r200_9(int) = Add : r200_8, r200_5
901+
# 200| m200_10(int) = Store : &:r200_7, r200_9
904902
# 201| r201_1(glval<unknown>) = FunctionAddress[abs] :
905903
# 201| r201_2(glval<int>) = VariableAddress[x] :
906904
# 201| r201_3(int) = Load : &:r201_2, m198_15
907905
# 201| r201_4(int) = Call : func:r201_1, 0:r201_3
908906
# 201| r201_5(glval<int>) = VariableAddress[ret] :
909-
# 201| r201_6(int) = Load : &:r201_5, m200_11
907+
# 201| r201_6(int) = Load : &:r201_5, m200_10
910908
# 201| r201_7(int) = Add : r201_6, r201_4
911909
# 201| m201_8(int) = Store : &:r201_5, r201_7
912910
# 202| r202_1(glval<int>) = VariableAddress[#return] :

‎cpp/ql/test/library-tests/ir/ssa/aliased_ssa_ir_unsound.expected‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -883,27 +883,25 @@ ssa.cpp:
883883
# 199| r199_7(char *) = Load : &:r199_6, m198_11
884884
# 199| r199_8(char *) = Convert : r199_7
885885
# 199| r199_9(int) = Call : func:r199_2, 0:r199_5, 1:r199_8
886-
# 199| v199_10(void) = ^CallReadSideEffect : ~m198_4
887-
# 199| v199_11(void) = ^BufferReadSideEffect[0] : &:r199_5, ~m198_9
888-
# 199| v199_12(void) = ^BufferReadSideEffect[1] : &:r199_8, ~m198_13
889-
# 199| m199_13(int) = Store : &:r199_1, r199_9
886+
# 199| v199_10(void) = ^BufferReadSideEffect[0] : &:r199_5, ~m198_9
887+
# 199| v199_11(void) = ^BufferReadSideEffect[1] : &:r199_8, ~m198_13
888+
# 199| m199_12(int) = Store : &:r199_1, r199_9
890889
# 200| r200_1(glval<unknown>) = FunctionAddress[strlen] :
891890
# 200| r200_2(glval<char *>) = VariableAddress[str1] :
892891
# 200| r200_3(char *) = Load : &:r200_2, m198_7
893892
# 200| r200_4(char *) = Convert : r200_3
894893
# 200| r200_5(int) = Call : func:r200_1, 0:r200_4
895-
# 200| v200_6(void) = ^CallReadSideEffect : ~m198_4
896-
# 200| v200_7(void) = ^BufferReadSideEffect[0] : &:r200_4, ~m198_9
897-
# 200| r200_8(glval<int>) = VariableAddress[ret] :
898-
# 200| r200_9(int) = Load : &:r200_8, m199_13
899-
# 200| r200_10(int) = Add : r200_9, r200_5
900-
# 200| m200_11(int) = Store : &:r200_8, r200_10
894+
# 200| v200_6(void) = ^BufferReadSideEffect[0] : &:r200_4, ~m198_9
895+
# 200| r200_7(glval<int>) = VariableAddress[ret] :
896+
# 200| r200_8(int) = Load : &:r200_7, m199_12
897+
# 200| r200_9(int) = Add : r200_8, r200_5
898+
# 200| m200_10(int) = Store : &:r200_7, r200_9
901899
# 201| r201_1(glval<unknown>) = FunctionAddress[abs] :
902900
# 201| r201_2(glval<int>) = VariableAddress[x] :
903901
# 201| r201_3(int) = Load : &:r201_2, m198_15
904902
# 201| r201_4(int) = Call : func:r201_1, 0:r201_3
905903
# 201| r201_5(glval<int>) = VariableAddress[ret] :
906-
# 201| r201_6(int) = Load : &:r201_5, m200_11
904+
# 201| r201_6(int) = Load : &:r201_5, m200_10
907905
# 201| r201_7(int) = Add : r201_6, r201_4
908906
# 201| m201_8(int) = Store : &:r201_5, r201_7
909907
# 202| r202_1(glval<int>) = VariableAddress[#return] :

‎cpp/ql/test/library-tests/ir/ssa/unaliased_ssa_ir.expected‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -829,27 +829,25 @@ ssa.cpp:
829829
# 199| r199_7(char *) = Load : &:r199_6, m198_10
830830
# 199| r199_8(char *) = Convert : r199_7
831831
# 199| r199_9(int) = Call : func:r199_2, 0:r199_5, 1:r199_8
832-
# 199| v199_10(void) = ^CallReadSideEffect : ~mu198_4
833-
# 199| v199_11(void) = ^BufferReadSideEffect[0] : &:r199_5, ~mu198_4
834-
# 199| v199_12(void) = ^BufferReadSideEffect[1] : &:r199_8, ~mu198_4
835-
# 199| m199_13(int) = Store : &:r199_1, r199_9
832+
# 199| v199_10(void) = ^BufferReadSideEffect[0] : &:r199_5, ~mu198_4
833+
# 199| v199_11(void) = ^BufferReadSideEffect[1] : &:r199_8, ~mu198_4
834+
# 199| m199_12(int) = Store : &:r199_1, r199_9
836835
# 200| r200_1(glval<unknown>) = FunctionAddress[strlen] :
837836
# 200| r200_2(glval<char *>) = VariableAddress[str1] :
838837
# 200| r200_3(char *) = Load : &:r200_2, m198_6
839838
# 200| r200_4(char *) = Convert : r200_3
840839
# 200| r200_5(int) = Call : func:r200_1, 0:r200_4
841-
# 200| v200_6(void) = ^CallReadSideEffect : ~mu198_4
842-
# 200| v200_7(void) = ^BufferReadSideEffect[0] : &:r200_4, ~mu198_4
843-
# 200| r200_8(glval<int>) = VariableAddress[ret] :
844-
# 200| r200_9(int) = Load : &:r200_8, m199_13
845-
# 200| r200_10(int) = Add : r200_9, r200_5
846-
# 200| m200_11(int) = Store : &:r200_8, r200_10
840+
# 200| v200_6(void) = ^BufferReadSideEffect[0] : &:r200_4, ~mu198_4
841+
# 200| r200_7(glval<int>) = VariableAddress[ret] :
842+
# 200| r200_8(int) = Load : &:r200_7, m199_12
843+
# 200| r200_9(int) = Add : r200_8, r200_5
844+
# 200| m200_10(int) = Store : &:r200_7, r200_9
847845
# 201| r201_1(glval<unknown>) = FunctionAddress[abs] :
848846
# 201| r201_2(glval<int>) = VariableAddress[x] :
849847
# 201| r201_3(int) = Load : &:r201_2, m198_14
850848
# 201| r201_4(int) = Call : func:r201_1, 0:r201_3
851849
# 201| r201_5(glval<int>) = VariableAddress[ret] :
852-
# 201| r201_6(int) = Load : &:r201_5, m200_11
850+
# 201| r201_6(int) = Load : &:r201_5, m200_10
853851
# 201| r201_7(int) = Add : r201_6, r201_4
854852
# 201| m201_8(int) = Store : &:r201_5, r201_7
855853
# 202| r202_1(glval<int>) = VariableAddress[#return] :

‎cpp/ql/test/library-tests/ir/ssa/unaliased_ssa_ir_unsound.expected‎

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -829,27 +829,25 @@ ssa.cpp:
829829
# 199| r199_7(char *) = Load : &:r199_6, m198_10
830830
# 199| r199_8(char *) = Convert : r199_7
831831
# 199| r199_9(int) = Call : func:r199_2, 0:r199_5, 1:r199_8
832-
# 199| v199_10(void) = ^CallReadSideEffect : ~mu198_4
833-
# 199| v199_11(void) = ^BufferReadSideEffect[0] : &:r199_5, ~mu198_4
834-
# 199| v199_12(void) = ^BufferReadSideEffect[1] : &:r199_8, ~mu198_4
835-
# 199| m199_13(int) = Store : &:r199_1, r199_9
832+
# 199| v199_10(void) = ^BufferReadSideEffect[0] : &:r199_5, ~mu198_4
833+
# 199| v199_11(void) = ^BufferReadSideEffect[1] : &:r199_8, ~mu198_4
834+
# 199| m199_12(int) = Store : &:r199_1, r199_9
836835
# 200| r200_1(glval<unknown>) = FunctionAddress[strlen] :
837836
# 200| r200_2(glval<char *>) = VariableAddress[str1] :
838837
# 200| r200_3(char *) = Load : &:r200_2, m198_6
839838
# 200| r200_4(char *) = Convert : r200_3
840839
# 200| r200_5(int) = Call : func:r200_1, 0:r200_4
841-
# 200| v200_6(void) = ^CallReadSideEffect : ~mu198_4
842-
# 200| v200_7(void) = ^BufferReadSideEffect[0] : &:r200_4, ~mu198_4
843-
# 200| r200_8(glval<int>) = VariableAddress[ret] :
844-
# 200| r200_9(int) = Load : &:r200_8, m199_13
845-
# 200| r200_10(int) = Add : r200_9, r200_5
846-
# 200| m200_11(int) = Store : &:r200_8, r200_10
840+
# 200| v200_6(void) = ^BufferReadSideEffect[0] : &:r200_4, ~mu198_4
841+
# 200| r200_7(glval<int>) = VariableAddress[ret] :
842+
# 200| r200_8(int) = Load : &:r200_7, m199_12
843+
# 200| r200_9(int) = Add : r200_8, r200_5
844+
# 200| m200_10(int) = Store : &:r200_7, r200_9
847845
# 201| r201_1(glval<unknown>) = FunctionAddress[abs] :
848846
# 201| r201_2(glval<int>) = VariableAddress[x] :
849847
# 201| r201_3(int) = Load : &:r201_2, m198_14
850848
# 201| r201_4(int) = Call : func:r201_1, 0:r201_3
851849
# 201| r201_5(glval<int>) = VariableAddress[ret] :
852-
# 201| r201_6(int) = Load : &:r201_5, m200_11
850+
# 201| r201_6(int) = Load : &:r201_5, m200_10
853851
# 201| r201_7(int) = Add : r201_6, r201_4
854852
# 201| m201_8(int) = Store : &:r201_5, r201_7
855853
# 202| r202_1(glval<int>) = VariableAddress[#return] :

0 commit comments

Comments
 (0)