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.

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

Jump to bottom

[VAN-424] Add lit tests for debug info generated by circom frontend #61

Merged
merged 8 commits into from
Oct 27, 2023
Merged

[VAN-424] Add lit tests for debug info generated by circom frontend #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
01590ee
add test for `assert` bucket
tim-hoffman Jul 25, 2023
6eecaa6
add test for `branch` bucket
tim-hoffman Jul 25, 2023
07ba7c0
add test for `call` bucket
tim-hoffman Jul 25, 2023
5490c0f
add test for `create_component` bucket
tim-hoffman Jul 26, 2023
148debf
give simpler names to existing tests
tim-hoffman Oct 26, 2023
180ca01
fix issue caused by load and add load test
tim-hoffman Oct 26, 2023
61c391a
add tests for remaining cases
tim-hoffman Oct 26, 2023
b17bfe5
simplify pattern matches
tim-hoffman Oct 26, 2023
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
46 changes: 46 additions & 0 deletions circom/tests/debuginfo/assert.circom
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
pragma circom 2.0.0;
// REQUIRES: circom
// RUN: rm -rf %t && mkdir %t && %circom --llvm -o %t %s | sed -n 's/.*Written successfully:.* \(.*\)/\1/p' | xargs cat | FileCheck --match-full-lines --enable-var-scope %s

template A(n) {
signal input in;
assert(in > 0);
}

component main = A(5);

//Variables are not used for the debug info numbering because a CHECK-LABEL directive
// cannot contain any variable uses or definitions and the "--match-full-lines" option
// is used so those lines cannot be split into two directives with a CHECK-SAME to
// define a variable. The only alternatives are to lose the extra check given by matching
// full lines or to remove the "--match-full-lines" option and surround each check with
// {{^}} and {{$}} but it gets messy.

//CHECK-LABEL: define{{.*}} void @A_0_build({ [0 x i256]*, i32 }* %{{[[:alnum:]_]+}}) !dbg !4 {
//CHECK-NEXT: [[L1:main]]:
//CHECK-COUNT-06: {{.*}}, !dbg !7
//CHECK-NEXT: ret void, !dbg !7
//CHECK-NEXT: }

//CHECK-LABEL: define{{.*}} void @A_0_run([0 x i256]* %{{[[:alnum:]_]+}}) !dbg !8 {
//CHECK-NEXT: [[L1:prelude]]:
//CHECK-COUNT-03: {{.*}}, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L2:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L1]]
//CHECK-COUNT-03: {{.*}}, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L3:assert[0-9]*]]:{{[[:space:]]}}; preds = %[[L2]]
//CHECK-COUNT-05: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L4:prologue]]:{{[[:space:]]}}; preds = %[[L3]]
//CHECK-NEXT: ret void, !dbg !10
//CHECK-NEXT: }

//CHECK-LABEL: !llvm.dbg.cu = !{!1}
//CHECK: !1 = distinct !DICompileUnit({{.*}}file: !2{{.*}})
//CHECK: !2 = !DIFile(filename:{{.*}}assert.circom{{.*}})
//CHECK: !4 = distinct !DISubprogram(name: "A", linkageName: "A_0_build", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !7 = !DILocation(line: 5, scope: !4)
//CHECK: !8 = distinct !DISubprogram(name: "A", linkageName: "A_0_run", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !9 = !DILocation(line: 5, scope: !8)
//CHECK: !10 = !DILocation(line: 7, scope: !8)
71 changes: 71 additions & 0 deletions circom/tests/debuginfo/branch.circom
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
pragma circom 2.0.0;
// REQUIRES: circom
// RUN: rm -rf %t && mkdir %t && %circom --llvm -o %t %s | sed -n 's/.*Written successfully:.* \(.*\)/\1/p' | xargs cat | FileCheck --match-full-lines --enable-var-scope %s

template B() {
signal input in1;
signal input in2;
signal output out;

var x;
if (in1 > 0) {
x = in1;
} else {
x = in2;
}
out <-- x;
}

component main = B();

//Variables are not used for the debug info numbering because a CHECK-LABEL directive
// cannot contain any variable uses or definitions and the "--match-full-lines" option
// is used so those lines cannot be split into two directives with a CHECK-SAME to
// define a variable. The only alternatives are to lose the extra check given by matching
// full lines or to remove the "--match-full-lines" option and surround each check with
// {{^}} and {{$}} but it gets messy.

//CHECK-LABEL: define{{.*}} void @B_0_build({ [0 x i256]*, i32 }* %{{[[:alnum:]_]+}}) !dbg !4 {
//CHECK-NEXT: [[L1:main]]:
//CHECK-COUNT-06: {{.*}}, !dbg !7
//CHECK-NEXT: ret void, !dbg !7
//CHECK-NEXT: }

//CHECK-LABEL: define{{.*}} void @B_0_run([0 x i256]* %{{[[:alnum:]_]+}}) !dbg !8 {
//CHECK-NEXT: [[L1:prelude]]:
//CHECK-COUNT-03: {{.*}}, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L2:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L1]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L3:branch[0-9]*]]:{{[[:space:]]}}; preds = %[[L2]]
//CHECK-COUNT-04: {{.*}}, !dbg !11
//CHECK-EMPTY:
//CHECK-NEXT: [[L4:if.then[0-9]*]]:{{[[:space:]]}}; preds = %[[L3]]
//CHECK-COUNT-05: {{.*}}, !dbg !12
//CHECK-EMPTY:
//CHECK-NEXT: [[L5:if.else[0-9]*]]:{{[[:space:]]}}; preds = %[[L3]]
//CHECK-COUNT-05: {{.*}}, !dbg !13
//CHECK-EMPTY:
//CHECK-NEXT: [[L6:if.merge[0-9]*]]:{{[[:space:]]}}; preds = %[[L5]], %[[L4]]
//CHECK-COUNT-01: {{.*}}, !dbg !13
//CHECK-EMPTY:
//CHECK-NEXT: [[L7:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L6]]
//CHECK-COUNT-05: {{.*}}, !dbg !14
//CHECK-EMPTY:
//CHECK-NEXT: [[L8:prologue]]:{{[[:space:]]}}; preds = %[[L7]]
//CHECK-NEXT: ret void, !dbg !14
//CHECK-NEXT: }

//CHECK-LABEL: !llvm.dbg.cu = !{!1}
//CHECK: !1 = distinct !DICompileUnit({{.*}}file: !2{{.*}})
//CHECK: !2 = !DIFile(filename:{{.*}}branch.circom{{.*}})
//CHECK: !4 = distinct !DISubprogram(name: "B", linkageName: "B_0_build", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !7 = !DILocation(line: 5, scope: !4)
//CHECK: !8 = distinct !DISubprogram(name: "B", linkageName: "B_0_run", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !9 = !DILocation(line: 5, scope: !8)
//CHECK: !10 = !DILocation(line: 10, scope: !8)
//CHECK: !11 = !DILocation(line: 11, scope: !8)
//CHECK: !12 = !DILocation(line: 12, scope: !8)
//CHECK: !13 = !DILocation(line: 14, scope: !8)
//CHECK: !14 = !DILocation(line: 16, scope: !8)
74 changes: 74 additions & 0 deletions circom/tests/debuginfo/call_and_return.circom
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
pragma circom 2.0.0;
// REQUIRES: circom
// RUN: rm -rf %t && mkdir %t && %circom --llvm -o %t %s | sed -n 's/.*Written successfully:.* \(.*\)/\1/p' | xargs cat | FileCheck --match-full-lines --enable-var-scope %s

template C() {
signal input in;
signal output out;
out <-- negative(in);
}

function negative(n){
if (n < 0) {
return 1;
} else {
return 0;
}
}

component main = C();

//Variables are not used for the debug info numbering because a CHECK-LABEL directive
// cannot contain any variable uses or definitions and the "--match-full-lines" option
// is used so those lines cannot be split into two directives with a CHECK-SAME to
// define a variable. The only alternatives are to lose the extra check given by matching
// full lines or to remove the "--match-full-lines" option and surround each check with
// {{^}} and {{$}} but it gets messy.

//CHECK-LABEL: define{{.*}} i256 @negative_0(i256* %{{[[:alnum:]_]+}}) !dbg !4 {
//CHECK-NEXT: [[L1:[[:alnum:]_]+]]:
//CHECK-COUNT-01: {{.*}}, !dbg !7
//CHECK-EMPTY:
//CHECK-NEXT: [[L2:branch[0-9]*]]:{{[[:space:]]}}; preds = %[[L1]]
//CHECK-COUNT-04: {{.*}}, !dbg !8
//CHECK-EMPTY:
//CHECK-NEXT: [[L3:if.then[0-9]*]]:{{[[:space:]]}}; preds = %[[L2]]
//CHECK-NEXT: ret i256 1, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L4:if.else[0-9]*]]:{{[[:space:]]}}; preds = %[[L2]]
//CHECK-NEXT: ret i256 0, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L5:if.merge[0-9]*]]:{{[[:space:]]}}; No predecessors!
//CHECK-NEXT: unreachable, !dbg !10
//CHECK-NEXT: }

//CHECK-LABEL: define{{.*}} void @C_0_build({ [0 x i256]*, i32 }* %{{[[:alnum:]_]+}}) !dbg !11 {
//CHECK-NEXT: [[L1:main]]:
//CHECK-COUNT-06: {{.*}}, !dbg !12
//CHECK-NEXT: ret void, !dbg !12
//CHECK-NEXT: }

//CHECK-LABEL: define{{.*}} void @C_0_run([0 x i256]* %{{[[:alnum:]_]+}}) !dbg !13 {
//CHECK-NEXT: [[L1:prelude]]:
//CHECK-COUNT-03: {{.*}}, !dbg !14
//CHECK-EMPTY:
//CHECK-NEXT: [[L2:call[0-9]*]]:{{[[:space:]]}}; preds = %[[L1]]
//CHECK-COUNT-10: {{.*}}, !dbg !15
//CHECK-EMPTY:
//CHECK-NEXT: [[L3:prologue]]:{{[[:space:]]}}; preds = %[[L2]]
//CHECK-NEXT: ret void, !dbg !15
//CHECK-NEXT: }

//CHECK-LABEL: !llvm.dbg.cu = !{!1}
//CHECK: !1 = distinct !DICompileUnit({{.*}}file: !2{{.*}})
//CHECK: !2 = !DIFile(filename:{{.*}}call_and_return.circom{{.*}})
//CHECK: !4 = distinct !DISubprogram(name: "negative", linkageName: "negative_0", scope: null, file: !2, line: 11, {{.*}}unit: !1{{.*}})
//CHECK: !7 = !DILocation(line: 11, scope: !4)
//CHECK: !8 = !DILocation(line: 12, scope: !4)
//CHECK: !9 = !DILocation(line: 13, scope: !4)
//CHECK: !10 = !DILocation(line: 15, scope: !4)
//CHECK: !11 = distinct !DISubprogram(name: "C", linkageName: "C_0_build", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !12 = !DILocation(line: 5, scope: !11)
//CHECK: !13 = distinct !DISubprogram(name: "C", linkageName: "C_0_run", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !14 = !DILocation(line: 5, scope: !13)
//CHECK: !15 = !DILocation(line: 8, scope: !13)
126 changes: 126 additions & 0 deletions circom/tests/debuginfo/compute.circom
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
pragma circom 2.0.0;
// REQUIRES: circom
// RUN: rm -rf %t && mkdir %t && %circom --llvm -o %t %s | sed -n 's/.*Written successfully:.* \(.*\)/\1/p' | xargs cat | FileCheck --match-full-lines --enable-var-scope %s

template A(n) {
signal input in1;
signal input in2;
signal input in3[2];
var outs[10];

outs[0] = in1 + in2;
outs[1] = in1 >> in2;
outs[2] = in1 < in2;
outs[3] = in1 == in2;
outs[4] = in1 && in2;
outs[5] = in1 & in2;
outs[6] = -in2;
outs[7] = ~in2;
outs[8] = !in2;
outs[9] = in3[n];
}

component main = A(1);

//Variables are not used for the debug info numbering because a CHECK-LABEL directive
// cannot contain any variable uses or definitions and the "--match-full-lines" option
// is used so those lines cannot be split into two directives with a CHECK-SAME to
// define a variable. The only alternatives are to lose the extra check given by matching
// full lines or to remove the "--match-full-lines" option and surround each check with
// {{^}} and {{$}} but it gets messy.

//CHECK-LABEL: define{{.*}} void @A_0_build({ [0 x i256]*, i32 }* %{{[[:alnum:]_]+}}) !dbg !4 {
//CHECK-NEXT: [[L1:main]]:
//CHECK-COUNT-06: {{.*}}, !dbg !7
//CHECK-NEXT: ret void, !dbg !7
//CHECK-NEXT: }

//CHECK-LABEL: define{{.*}} void @A_0_run([0 x i256]* %{{[[:alnum:]_]+}}) !dbg !8 {
//CHECK-NEXT: [[L01:prelude]]:
//CHECK-COUNT-03: {{.*}}, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L02:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L01]]
//CHECK-COUNT-03: {{.*}}, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L03:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L02]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L04:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L03]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L05:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L04]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L06:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L05]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L07:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L06]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L08:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L07]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L09:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L08]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L10:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L09]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L11:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L10]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L12:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L11]]
//CHECK-COUNT-03: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L13:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L12]]
//CHECK-COUNT-08: {{.*}}, !dbg !11
//CHECK-EMPTY:
//CHECK-NEXT: [[L14:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L13]]
//CHECK-COUNT-08: {{.*}}, !dbg !12
//CHECK-EMPTY:
//CHECK-NEXT: [[L15:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L14]]
//CHECK-COUNT-09: {{.*}}, !dbg !13
//CHECK-EMPTY:
//CHECK-NEXT: [[L16:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L15]]
//CHECK-COUNT-09: {{.*}}, !dbg !14
//CHECK-EMPTY:
//CHECK-NEXT: [[L17:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L16]]
//CHECK-COUNT-11: {{.*}}, !dbg !15
//CHECK-EMPTY:
//CHECK-NEXT: [[L18:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L17]]
//CHECK-COUNT-08: {{.*}}, !dbg !16
//CHECK-EMPTY:
//CHECK-NEXT: [[L19:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L18]]
//CHECK-COUNT-06: {{.*}}, !dbg !17
//CHECK-EMPTY:
//CHECK-NEXT: [[L20:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L19]]
//CHECK-COUNT-06: {{.*}}, !dbg !18
//CHECK-EMPTY:
//CHECK-NEXT: [[L21:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L20]]
//CHECK-COUNT-08: {{.*}}, !dbg !19
//CHECK-EMPTY:
//CHECK-NEXT: [[L22:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L21]]
//CHECK-COUNT-05: {{.*}}, !dbg !20
//CHECK-EMPTY:
//CHECK-NEXT: [[L23:prologue]]:{{[[:space:]]}}; preds = %[[L22]]
//CHECK-NEXT: ret void, !dbg !20
//CHECK-NEXT: }

//CHECK-LABEL: !llvm.dbg.cu = !{!1}
//CHECK: !1 = distinct !DICompileUnit({{.*}}file: !2{{.*}})
//CHECK: !2 = !DIFile(filename:{{.*}}compute.circom{{.*}})
//CHECK: !4 = distinct !DISubprogram(name: "A", linkageName: "A_0_build", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !7 = !DILocation(line: 5, scope: !4)
//CHECK: !8 = distinct !DISubprogram(name: "A", linkageName: "A_0_run", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !9 = !DILocation(line: 5, scope: !8)
//CHECK: !10 = !DILocation(line: 9, scope: !8)
//CHECK: !11 = !DILocation(line: 11, scope: !8)
//CHECK: !12 = !DILocation(line: 12, scope: !8)
//CHECK: !13 = !DILocation(line: 13, scope: !8)
//CHECK: !14 = !DILocation(line: 14, scope: !8)
//CHECK: !15 = !DILocation(line: 15, scope: !8)
//CHECK: !16 = !DILocation(line: 16, scope: !8)
//CHECK: !17 = !DILocation(line: 17, scope: !8)
//CHECK: !18 = !DILocation(line: 18, scope: !8)
//CHECK: !19 = !DILocation(line: 19, scope: !8)
//CHECK: !20 = !DILocation(line: 20, scope: !8)
46 changes: 46 additions & 0 deletions circom/tests/debuginfo/constraint.circom
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
pragma circom 2.0.0;
// REQUIRES: circom
// RUN: rm -rf %t && mkdir %t && %circom --llvm -o %t %s | sed -n 's/.*Written successfully:.* \(.*\)/\1/p' | xargs cat | FileCheck --match-full-lines --enable-var-scope %s

template A() {
signal input in;
signal output out;
out <== in;
}

component main = A();

//Variables are not used for the debug info numbering because a CHECK-LABEL directive
// cannot contain any variable uses or definitions and the "--match-full-lines" option
// is used so those lines cannot be split into two directives with a CHECK-SAME to
// define a variable. The only alternatives are to lose the extra check given by matching
// full lines or to remove the "--match-full-lines" option and surround each check with
// {{^}} and {{$}} but it gets messy.

//CHECK-LABEL: define{{.*}} void @A_0_build({ [0 x i256]*, i32 }* %{{[[:alnum:]_]+}}) !dbg !4 {
//CHECK-NEXT: [[L1:main]]:
//CHECK-COUNT-06: {{.*}}, !dbg !7
//CHECK-NEXT: ret void, !dbg !7
//CHECK-NEXT: }

//CHECK-LABEL: define{{.*}} void @A_0_run([0 x i256]* %{{[[:alnum:]_]+}}) !dbg !8 {
//CHECK-NEXT: [[L1:prelude]]:
//CHECK-COUNT-03: {{.*}}, !dbg !9
//CHECK-EMPTY:
//CHECK-NEXT: [[L2:store[0-9]*]]:{{[[:space:]]}}; preds = %[[L1]]
//CHECK-COUNT-05: {{.*}}, !dbg !10
//CHECK-NEXT: {{.*}}, !dbg !10, !constraint !11
//CHECK-COUNT-02: {{.*}}, !dbg !10
//CHECK-EMPTY:
//CHECK-NEXT: [[L3:prologue]]:{{[[:space:]]}}; preds = %[[L2]]
//CHECK-NEXT: ret void, !dbg !10
//CHECK-NEXT: }

//CHECK-LABEL: !llvm.dbg.cu = !{!1}
//CHECK: !1 = distinct !DICompileUnit({{.*}}file: !2{{.*}})
//CHECK: !2 = !DIFile(filename:{{.*}}constraint.circom{{.*}})
//CHECK: !4 = distinct !DISubprogram(name: "A", linkageName: "A_0_build", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !7 = !DILocation(line: 5, scope: !4)
//CHECK: !8 = distinct !DISubprogram(name: "A", linkageName: "A_0_run", scope: null, file: !2, line: 5, {{.*}}unit: !1{{.*}})
//CHECK: !9 = !DILocation(line: 5, scope: !8)
//CHECK: !10 = !DILocation(line: 8, scope: !8)
Loading
Loading