Skip to content

Emit spec compliant QIR #2590

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
merged 10 commits into from
Oct 2, 2025
+6,496 −5,432
Merged

Emit spec compliant QIR #2590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
dc49e3f
Switch to `i64` return type from entry point
swernli Jul 2, 2025
a403fb1
Update Adaptive module flags
swernli Jul 3, 2025
5bd1715
Output tagging unconditionally included
swernli Jul 3, 2025
52b9707
Rename read result to use `__rt__` pattern
swernli Jul 10, 2025
cd0b520
Unconditionally use initialize function
swernli Jul 10, 2025
9c14156
Fix unit new tests from main
swernli Jul 18, 2025
d809c3a
Fix more new unit tests
swernli Sep 3, 2025
17bc90d
Add comment for metadata flags.
swernli Sep 3, 2025
2ba4899
Fix newer tests
swernli Oct 2, 2025
24cbaf4
Remove dead code, update "f64" flag to "double"
swernli Oct 2, 2025
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
493 changes: 339 additions & 154 deletions source/compiler/qsc/src/codegen/tests.rs
View file
Open in desktop

Large diffs are not rendered by default.

114 changes: 82 additions & 32 deletions source/compiler/qsc/src/interpret/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,14 +993,20 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_r\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__cx__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Qubit* inttoptr (i64 1 to %Qubit*))
call void @__quantum__qis__m__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
ret void
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__m__body(%Qubit*, %Result*) #1

declare void @__quantum__rt__result_record_output(%Result*, i8*)
Expand Down Expand Up @@ -1054,16 +1060,22 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_r\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__rz__body(double 2.0, %Qubit* inttoptr (i64 0 to %Qubit*))
call void @__quantum__qis__rz__body(double 0.0, %Qubit* inttoptr (i64 0 to %Qubit*))
call void @__quantum__qis__rz__body(double 1.0, %Qubit* inttoptr (i64 0 to %Qubit*))
call void @__quantum__qis__mresetz__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
ret void
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__rz__body(double, %Qubit*)

declare void @__quantum__qis__mresetz__body(%Qubit*, %Result*) #1
Expand All @@ -1081,7 +1093,7 @@ mod given_interpreter {
!1 = !{i32 7, !"qir_minor_version", i32 0}
!2 = !{i32 1, !"dynamic_qubit_management", i1 false}
!3 = !{i32 1, !"dynamic_result_management", i1 false}
!4 = !{i32 1, !"int_computations", !"i64"}
!4 = !{i32 5, !"int_computations", !{!"i64"}}
"#]]
.assert_eq(&res);
}
Expand Down Expand Up @@ -1111,23 +1123,31 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [6 x i8] c"0_t0r\00"
@1 = internal constant [8 x i8] c"1_t1t0b\00"
@2 = internal constant [8 x i8] c"2_t1t1b\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__mresetz__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
%var_0 = call i1 @__quantum__qis__read_result__body(%Result* inttoptr (i64 0 to %Result*))
%var_2 = call i1 @__quantum__qis__read_result__body(%Result* inttoptr (i64 0 to %Result*))
%var_0 = call i1 @__quantum__rt__read_result(%Result* inttoptr (i64 0 to %Result*))
%var_2 = call i1 @__quantum__rt__read_result(%Result* inttoptr (i64 0 to %Result*))
%var_3 = icmp eq i1 %var_2, false
call void @__quantum__rt__tuple_record_output(i64 2, i8* null)
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
call void @__quantum__rt__tuple_record_output(i64 2, i8* null)
call void @__quantum__rt__bool_record_output(i1 %var_0, i8* null)
call void @__quantum__rt__bool_record_output(i1 %var_3, i8* null)
ret void
call void @__quantum__rt__tuple_record_output(i64 2, i8* getelementptr inbounds ([1 x i8], [1 x i8]* @empty_tag, i64 0, i64 0))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([6 x i8], [6 x i8]* @0, i64 0, i64 0))
call void @__quantum__rt__tuple_record_output(i64 2, i8* getelementptr inbounds ([1 x i8], [1 x i8]* @empty_tag, i64 0, i64 0))
call void @__quantum__rt__bool_record_output(i1 %var_0, i8* getelementptr inbounds ([8 x i8], [8 x i8]* @1, i64 0, i64 0))
call void @__quantum__rt__bool_record_output(i1 %var_3, i8* getelementptr inbounds ([8 x i8], [8 x i8]* @2, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__mresetz__body(%Qubit*, %Result*) #1

declare i1 @__quantum__qis__read_result__body(%Result*)
declare i1 @__quantum__rt__read_result(%Result*)

declare void @__quantum__rt__tuple_record_output(i64, i8*)

Expand Down Expand Up @@ -1188,14 +1208,20 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_r\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__cx__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Qubit* inttoptr (i64 1 to %Qubit*))
call void @__quantum__qis__m__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
ret void
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__m__body(%Qubit*, %Result*) #1

declare void @__quantum__rt__result_record_output(%Result*, i8*)
Expand Down Expand Up @@ -1232,14 +1258,20 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_r\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__cx__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Qubit* inttoptr (i64 1 to %Qubit*))
call void @__quantum__qis__m__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
ret void
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__m__body(%Qubit*, %Result*) #1

declare void @__quantum__rt__result_record_output(%Result*, i8*)
Expand Down Expand Up @@ -1308,14 +1340,20 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_r\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__cx__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Qubit* inttoptr (i64 1 to %Qubit*))
call void @__quantum__qis__m__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
ret void
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__m__body(%Qubit*, %Result*) #1

declare void @__quantum__rt__result_record_output(%Result*, i8*)
Expand Down Expand Up @@ -1364,14 +1402,20 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_r\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__cx__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Qubit* inttoptr (i64 1 to %Qubit*))
call void @__quantum__qis__m__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* null)
ret void
call void @__quantum__rt__result_record_output(%Result* inttoptr (i64 0 to %Result*), i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__m__body(%Qubit*, %Result*) #1

declare void @__quantum__rt__result_record_output(%Result*, i8*)
Expand Down Expand Up @@ -1419,14 +1463,20 @@ mod given_interpreter {
%Result = type opaque
%Qubit = type opaque

define void @ENTRYPOINT__main() #0 {
@empty_tag = internal constant [1 x i8] c"\00"
@0 = internal constant [4 x i8] c"0_b\00"

define i64 @ENTRYPOINT__main() #0 {
block_0:
call void @__quantum__rt__initialize(i8* null)
call void @__quantum__qis__mresetz__body(%Qubit* inttoptr (i64 0 to %Qubit*), %Result* inttoptr (i64 0 to %Result*))
%var_0 = call i1 @check_result(%Result* inttoptr (i64 0 to %Result*))
call void @__quantum__rt__bool_record_output(i1 %var_0, i8* null)
ret void
call void @__quantum__rt__bool_record_output(i1 %var_0, i8* getelementptr inbounds ([4 x i8], [4 x i8]* @0, i64 0, i64 0))
ret i64 0
}

declare void @__quantum__rt__initialize(i8*)

declare void @__quantum__qis__mresetz__body(%Qubit*, %Result*) #1

declare i1 @check_result(%Result*)
Expand Down
39 changes: 30 additions & 9 deletions source/compiler/qsc_codegen/src/qir.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,16 @@ impl ToQir<String> for rir::Literal {
rir::Literal::Pointer => "i8* null".to_string(),
rir::Literal::Qubit(q) => format!("%Qubit* inttoptr (i64 {q} to %Qubit*)"),
rir::Literal::Result(r) => format!("%Result* inttoptr (i64 {r} to %Result*)"),
rir::Literal::Tag(idx, len) => {
let len = len + 1; // +1 for the null terminator
format!(
"i8* getelementptr inbounds ([{len} x i8], [{len} x i8]* @{idx}, i64 0, i64 0)"
)
}
rir::Literal::EmptyTag => {
"i8* getelementptr inbounds ([1 x i8], [1 x i8]* @empty_tag, i64 0, i64 0)"
.to_string()
}
}
}
}
Expand Down Expand Up @@ -273,7 +283,7 @@ impl ToQir<String> for rir::Instruction {
format!(" br label %{}", ToQir::<String>::to_qir(block_id, program))
}
rir::Instruction::Phi(args, variable) => phi_to_qir(args, *variable, program),
rir::Instruction::Return => " ret void".to_string(),
rir::Instruction::Return => " ret i64 0".to_string(),
rir::Instruction::Sdiv(lhs, rhs, variable) => {
binop_to_qir("sdiv", lhs, rhs, *variable, program)
}
Expand Down Expand Up @@ -571,6 +581,9 @@ fn get_value_as_str(value: &rir::Operand, program: &rir::Program) -> String {
rir::Literal::Pointer => "null".to_string(),
rir::Literal::Qubit(q) => format!("{q}"),
rir::Literal::Result(r) => format!("{r}"),
rir::Literal::Tag(..) | rir::Literal::EmptyTag => panic!(
"tag literals should not be used as string values outside of output recording"
),
},
rir::Operand::Variable(var) => ToQir::<String>::to_qir(&var.variable_id, program),
}
Expand All @@ -584,7 +597,7 @@ fn get_value_ty(lhs: &rir::Operand) -> &str {
rir::Literal::Double(_) => get_f64_ty(),
rir::Literal::Qubit(_) => "%Qubit*",
rir::Literal::Result(_) => "%Result*",
rir::Literal::Pointer => "i8*",
rir::Literal::Pointer | rir::Literal::Tag(..) | rir::Literal::EmptyTag => "i8*",
},
rir::Operand::Variable(var) => get_variable_ty(*var),
}
Expand Down Expand Up @@ -690,9 +703,19 @@ impl ToQir<String> for rir::Program {
} else {
"adaptive_profile"
};
let mut constants = String::default();
for (idx, tag) in self.tags.iter().enumerate() {
// We need to add the tag as a global constant.
writeln!(
constants,
"@{idx} = internal constant [{} x i8] c\"{tag}\\00\"",
tag.len() + 1
)
.expect("writing to string should succeed");
}
let body = format!(
include_str!("./qir/template.ll"),
callables, profile, self.num_qubits, self.num_results
constants, callables, profile, self.num_qubits, self.num_results
);
let flags = get_module_metadata(self);
body + "\n" + &flags
Expand Down Expand Up @@ -725,21 +748,19 @@ fn get_module_metadata(program: &rir::Program) -> String {
for cap in program.config.capabilities.iter() {
match cap {
TargetCapabilityFlags::IntegerComputations => {
let name = "int_computations";
// Use `5` as the flag to signify "Append" mode. See https://llvm.org/docs/LangRef.html#module-flags-metadata
writeln!(
flags,
"!{} = !{{i32 {}, !\"{}\", !\"i{}\"}}",
index, 1, name, 64
"!{index} = !{{i32 5, !\"int_computations\", !{{!\"i64\"}}}}",
)
.expect("writing to string should succeed");
index += 1;
}
TargetCapabilityFlags::FloatingPointComputations => {
let name = "float_computations";
// Use `5` as the flag to signify "Append" mode. See https://llvm.org/docs/LangRef.html#module-flags-metadata
writeln!(
flags,
"!{} = !{{i32 {}, !\"{}\", !\"f{}\"}}",
index, 1, name, 64
"!{index} = !{{i32 5, !\"float_computations\", !{{!\"double\"}}}}",
)
.expect("writing to string should succeed");
index += 1;
Expand Down
2 changes: 2 additions & 0 deletions source/compiler/qsc_codegen/src/qir/template.ll
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
%Result = type opaque
%Qubit = type opaque

@empty_tag = internal constant [1 x i8] c"\00"
{}
{}

attributes #0 = {{ "entry_point" "output_labeling_schema" "qir_profiles"="{}" "required_num_qubits"="{}" "required_num_results"="{}" }}
Expand Down
Loading