forked from NVIDIA/cuda-quantum
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathCCToLLVM.cpp
More file actions
849 lines (771 loc) · 35 KB
/
Copy pathCCToLLVM.cpp
File metadata and controls
849 lines (771 loc) · 35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
/*******************************************************************************
* Copyright (c) 2022 - 2026 NVIDIA Corporation & Affiliates. *
* All rights reserved. *
* *
* This source code and the accompanying materials are made available under *
* the terms of the Apache License 2.0 which accompanies this distribution. *
******************************************************************************/
#include "cudaq/Optimizer/CodeGen/CCToLLVM.h"
#include "CodeGenOps.h"
#include "cudaq/Optimizer/Builder/Intrinsics.h"
#include "cudaq/Optimizer/Builder/Runtime.h"
#include "cudaq/Optimizer/CodeGen/Passes.h"
#include "cudaq/Optimizer/Dialect/CC/CCOps.h"
#include "cudaq/Optimizer/Dialect/Quake/QuakeTypes.h"
#include "llvm/ADT/TypeSwitch.h"
#include "mlir/Conversion/LLVMCommon/ConversionTarget.h"
#include "mlir/Conversion/LLVMCommon/Pattern.h"
#include "mlir/Conversion/LLVMCommon/TypeConverter.h"
#define DEBUG_TYPE "cc-to-llvm"
using namespace mlir;
namespace {
//===----------------------------------------------------------------------===//
// Conversion patterns for CC dialect ops.
//===----------------------------------------------------------------------===//
class AddressOfOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::AddressOfOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// One-to-one conversion to llvm.addressof op.
LogicalResult
matchAndRewrite(cudaq::cc::AddressOfOp addr, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
Type type = getTypeConverter()->convertType(addr.getType());
auto name = addr.getGlobalName();
rewriter.replaceOpWithNewOp<LLVM::AddressOfOp>(addr, type, name);
return success();
}
};
class AllocaOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::AllocaOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// Convert each cc::AllocaOp to an LLVM::AllocaOp.
LogicalResult
matchAndRewrite(cudaq::cc::AllocaOp alloc, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
Type type = getTypeConverter()->convertType(alloc.getElementType());
Value size = adaptor.getSeqSize();
if (!size)
size =
cudaq::opt::factory::genLlvmI32Constant(alloc.getLoc(), rewriter, 1);
#ifdef __APPLE__
if (alloc.getElementType().isInteger(8) && adaptor.getSeqSize()) {
auto loc = alloc.getLoc();
auto i64Ty = rewriter.getI64Type();
Value sized = size;
if (sized.getType() != i64Ty)
sized = LLVM::ZExtOp::create(rewriter, loc, i64Ty, sized);
auto seven = LLVM::ConstantOp::create(rewriter, loc, i64Ty,
rewriter.getI64IntegerAttr(7));
auto mask = LLVM::ConstantOp::create(
rewriter, loc, i64Ty,
rewriter.getI64IntegerAttr(static_cast<std::int64_t>(~7ULL)));
auto bumped = LLVM::AddOp::create(rewriter, loc, i64Ty, sized, seven);
size = LLVM::AndOp::create(rewriter, loc, i64Ty, bumped, mask);
}
#endif
rewriter.replaceOpWithNewOp<LLVM::AllocaOp>(
alloc, cudaq::opt::factory::getPointerType(rewriter.getContext()), type,
size);
return success();
}
};
class CallableClosureOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::CallableClosureOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::CallableClosureOp callable, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = callable.getLoc();
auto operands = adaptor.getOperands();
SmallVector<Type> resTy;
for (std::size_t i = 0, N = callable.getResults().size(); i < N; ++i)
resTy.push_back(getTypeConverter()->convertType(callable.getType(i)));
auto *ctx = rewriter.getContext();
auto tupleTy = LLVM::LLVMStructType::getLiteral(ctx, resTy);
auto tuplePtrTy = cudaq::opt::factory::getPointerType(ctx);
auto structTy = dyn_cast<LLVM::LLVMStructType>(operands[0].getType());
if (!structTy)
return failure();
auto one = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{1});
auto extract = LLVM::ExtractValueOp::create(
rewriter, loc, structTy.getBody()[1], operands[0], one);
auto tupleVal = LLVM::BitcastOp::create(rewriter, loc, tuplePtrTy, extract);
auto loadOp = LLVM::LoadOp::create(rewriter, loc, tupleTy, tupleVal);
// In LLVM 22, replaceOp strictly requires the same number of results.
// The LoadOp returns a single struct value; extract each field to match
// the multiple results of CallableClosureOp.
SmallVector<Value> results;
for (std::size_t i = 0, N = callable.getResults().size(); i < N; ++i) {
auto idx = DenseI64ArrayAttr::get(
ctx, ArrayRef<std::int64_t>{static_cast<int64_t>(i)});
results.push_back(LLVM::ExtractValueOp::create(rewriter, loc, resTy[i],
loadOp.getResult(), idx));
}
rewriter.replaceOp(callable, results);
return success();
}
};
class CallableFuncOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::CallableFuncOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::CallableFuncOp callable, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = callable.getLoc();
auto operands = adaptor.getOperands();
auto resTy = getTypeConverter()->convertType(callable.getType());
auto structTy = dyn_cast<LLVM::LLVMStructType>(operands[0].getType());
if (!structTy)
return failure();
auto *ctx = rewriter.getContext();
auto zero = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{0});
auto extract = LLVM::ExtractValueOp::create(
rewriter, loc, structTy.getBody()[0], operands[0], zero);
rewriter.replaceOpWithNewOp<LLVM::BitcastOp>(callable, resTy, extract);
return success();
}
};
class CallCallableOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::CallCallableOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::CallCallableOp call, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = call.getLoc();
// Get the mlir::FunctionType signature from the callable
auto calleeFuncTy =
cast<cudaq::cc::CallableType>(call.getCallee().getType())
.getSignature();
auto operands = adaptor.getOperands();
auto *ctx = rewriter.getContext();
auto structTy = dyn_cast<LLVM::LLVMStructType>(operands[0].getType());
if (!structTy)
return failure();
// Extract raw function pointer (first element of callable struct)
auto ptr0Ty = structTy.getBody()[0];
auto zero = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{0});
auto rawFuncPtr =
LLVM::ExtractValueOp::create(rewriter, loc, ptr0Ty, operands[0], zero);
// Extract raw tuple pointer (second element of callable struct)
auto ptr1Ty = structTy.getBody()[1];
auto one = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{1});
auto rawTuplePtr =
LLVM::ExtractValueOp::create(rewriter, loc, ptr1Ty, operands[0], one);
// Build the LLVM function type by converting the signature's types
// individually (since convertType on FunctionType returns ptr with opaque
// pointers)
SmallVector<Type> llvmArgTys;
for (Type argTy : calleeFuncTy.getInputs())
llvmArgTys.push_back(getTypeConverter()->convertType(argTy));
Type llvmRetTy;
if (calleeFuncTy.getNumResults() == 0)
llvmRetTy = LLVM::LLVMVoidType::get(ctx);
else if (calleeFuncTy.getNumResults() == 1)
llvmRetTy = getTypeConverter()->convertType(calleeFuncTy.getResult(0));
else {
// Multiple results - pack into a struct
SmallVector<Type> llvmResultTys;
for (Type resTy : calleeFuncTy.getResults())
llvmResultTys.push_back(getTypeConverter()->convertType(resTy));
llvmRetTy = LLVM::LLVMStructType::getLiteral(ctx, llvmResultTys);
}
auto llvmFuncTy = LLVM::LLVMFunctionType::get(llvmRetTy, llvmArgTys);
// Check if tuple pointer is null (determines direct vs closure call)
auto i64Ty = rewriter.getI64Type();
auto zeroI64 = cudaq::opt::factory::genLlvmI64Constant(loc, rewriter, 0);
auto rawTupleVal =
LLVM::PtrToIntOp::create(rewriter, loc, i64Ty, rawTuplePtr);
auto isNullptr = LLVM::ICmpOp::create(
rewriter, loc, LLVM::ICmpPredicate::eq, rawTupleVal, zeroI64);
// Create control flow blocks
auto *initBlock = rewriter.getInsertionBlock();
auto initPos = rewriter.getInsertionPoint();
auto *endBlock = rewriter.splitBlock(initBlock, initPos);
auto *thenBlock = rewriter.createBlock(endBlock);
auto *elseBlock = rewriter.createBlock(endBlock);
SmallVector<Type> resultTy;
if (!isa<LLVM::LLVMVoidType>(llvmFuncTy.getReturnType())) {
resultTy.push_back(llvmFuncTy.getReturnType());
endBlock->addArgument(resultTy[0], loc);
}
rewriter.setInsertionPointToEnd(initBlock);
LLVM::CondBrOp::create(rewriter, loc, isNullptr, thenBlock, elseBlock);
// Then block: tuple is null, call function directly with remaining operands
rewriter.setInsertionPointToEnd(thenBlock);
SmallVector<Value> calleeOps1 = {rawFuncPtr};
calleeOps1.append(operands.begin() + 1, operands.end());
auto call1 = LLVM::CallOp::create(rewriter, loc, llvmFuncTy, calleeOps1);
LLVM::BrOp::create(rewriter, loc, call1.getResults(), endBlock);
// Else block: tuple is not null, call with callable struct as first arg
rewriter.setInsertionPointToEnd(elseBlock);
SmallVector<Value> calleeOps2 = {rawFuncPtr};
calleeOps2.append(operands.begin(), operands.end());
SmallVector<Type> closureArgTys;
closureArgTys.push_back(operands[0].getType());
closureArgTys.append(llvmArgTys.begin(), llvmArgTys.end());
auto closureFuncTy = LLVM::LLVMFunctionType::get(llvmRetTy, closureArgTys);
auto call2 = LLVM::CallOp::create(rewriter, loc, closureFuncTy, calleeOps2);
LLVM::BrOp::create(rewriter, loc, call2.getResults(), endBlock);
rewriter.replaceOp(call, endBlock->getArguments());
return success();
}
};
class CallIndirectCallableOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::CallIndirectCallableOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::CallIndirectCallableOp call, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = call.getLoc();
auto *ctx = rewriter.getContext();
auto parentModule = call->getParentOfType<ModuleOp>();
auto indirectTy =
cast<cudaq::cc::IndirectCallableType>(call.getCallee().getType());
mlir::FunctionType calleeFuncTy = indirectTy.getSignature();
auto funcPtrTy = getTypeConverter()->convertType(calleeFuncTy);
auto ptrTy = cudaq::opt::factory::getPointerType(ctx);
SmallVector<Type> llvmArgTys;
for (Type argTy : calleeFuncTy.getInputs())
llvmArgTys.push_back(getTypeConverter()->convertType(argTy));
Type llvmRetTy;
if (calleeFuncTy.getNumResults() == 0)
llvmRetTy = LLVM::LLVMVoidType::get(ctx);
else if (calleeFuncTy.getNumResults() == 1)
llvmRetTy = getTypeConverter()->convertType(calleeFuncTy.getResult(0));
else {
SmallVector<Type> llvmResultTys;
for (Type resTy : calleeFuncTy.getResults())
llvmResultTys.push_back(getTypeConverter()->convertType(resTy));
llvmRetTy = LLVM::LLVMStructType::getLiteral(ctx, llvmResultTys);
}
LLVM::LLVMFunctionType funcTy =
LLVM::LLVMFunctionType::get(llvmRetTy, llvmArgTys);
auto i64Ty = rewriter.getI64Type(); // intptr_t
FlatSymbolRefAttr funSymbol = cudaq::opt::factory::createLLVMFunctionSymbol(
cudaq::runtime::getLinkableKernelDeviceSide, ptrTy, {i64Ty},
parentModule);
// Use the runtime helper function to convert the key to a pointer to the
// function that was intended to be called. This can only be functional if
// the runtime support has been linked into the executable and the
// device-side functions are located in the same address space as well. None
// of these functions should be expected to reside on remote hardware.
// Therefore, this will likely only be useful in a simulation target.
auto lookee = LLVM::CallOp::create(rewriter, loc, ptrTy, funSymbol,
ValueRange{adaptor.getCallee()});
auto lookup =
LLVM::BitcastOp::create(rewriter, loc, funcPtrTy, lookee.getResult());
// Use create() so operandSegmentSizes is set (LLVM 22
// AttrSizedOperandSegments).
SmallVector<Value> args = {lookup.getResult()};
args.append(adaptor.getArgs().begin(), adaptor.getArgs().end());
auto newCall = LLVM::CallOp::create(rewriter, loc, funcTy, args);
rewriter.replaceOp(call, newCall.getResults());
return success();
}
};
class CastOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::CastOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// Convert each cc::CastOp to one of the flavors of LLVM casts.
LogicalResult
matchAndRewrite(cudaq::cc::CastOp cast, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
auto fromTy = operands[0].getType();
auto toTy = getTypeConverter()->convertType(cast.getType());
auto boilerplate = [&]<typename A>(A *) {
rewriter.replaceOpWithNewOp<A>(cast, toTy, operands);
};
TypeSwitch<Type>(toTy)
.Case([&](IntegerType toIntTy) {
TypeSwitch<Type>(fromTy)
.Case([&](IntegerType fromIntTy) {
if (fromIntTy.getWidth() < toIntTy.getWidth()) {
if (cast.getSint())
boilerplate((LLVM::SExtOp *)nullptr);
else
boilerplate((LLVM::ZExtOp *)nullptr);
} else {
boilerplate((LLVM::TruncOp *)nullptr);
}
})
.Case([&](FloatType) {
if (cast.getSint())
boilerplate((LLVM::FPToSIOp *)nullptr);
else if (cast.getZint())
boilerplate((LLVM::FPToUIOp *)nullptr);
else
boilerplate((LLVM::BitcastOp *)nullptr);
})
.Case([&](LLVM::LLVMPointerType) {
boilerplate((LLVM::PtrToIntOp *)nullptr);
});
})
.Case([&](FloatType toFloatTy) {
TypeSwitch<Type>(fromTy)
.Case([&](FloatType fromFloatTy) {
if (fromFloatTy.getWidth() < toFloatTy.getWidth())
boilerplate((LLVM::FPExtOp *)nullptr);
else
boilerplate((LLVM::FPTruncOp *)nullptr);
})
.Case([&](IntegerType) {
if (cast.getSint())
boilerplate((LLVM::SIToFPOp *)nullptr);
else if (cast.getZint())
boilerplate((LLVM::UIToFPOp *)nullptr);
else
boilerplate((LLVM::BitcastOp *)nullptr);
});
})
.Case([&](LLVM::LLVMPointerType toPtrTy) {
TypeSwitch<Type>(fromTy)
.Case([&](LLVM::LLVMPointerType) {
boilerplate((LLVM::BitcastOp *)nullptr);
})
.Case([&](LLVM::LLVMFunctionType) {
boilerplate((LLVM::BitcastOp *)nullptr);
})
.Case([&](IntegerType) {
boilerplate((LLVM::IntToPtrOp *)nullptr);
});
});
return success();
}
};
class ComputePtrOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::ComputePtrOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::ComputePtrOp cpOp, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
// Get the CC element type before conversion
auto ccPtrTy = cast<cudaq::cc::PointerType>(cpOp.getBase().getType());
Type ccEleTy = ccPtrTy.getElementType();
// The first operand is the base pointer.
if (cpOp.llvmNormalForm()) {
// In this case, the `cc.compute_ptr` has already been converted such that
// it corresponds 1:1 with the C-like semantics of LLVM's getelementptr
// operation. Specifically, a pointer to a scalar type is overloaded to
// possibly be the same as a pointer to an array with unknown bound.
// All operands except the first are indices.
// Extract inner element type from CC array type before conversion
ccEleTy = cast<cudaq::cc::ArrayType>(ccEleTy).getElementType();
auto newOpnds = interleaveConstantsAndOperands(
adaptor.getDynamicIndices(), cpOp.getRawConstantIndices());
// Convert to LLVM type after extracting the element type
Type eleTy = getTypeConverter()->convertType(ccEleTy);
// Rewrite the ComputePtrOp as a LLVM::GEPOp.
rewriter.replaceOpWithNewOp<LLVM::GEPOp>(
cpOp, cudaq::opt::factory::getPointerType(rewriter.getContext()),
eleTy, adaptor.getBase(), newOpnds);
} else {
// If the `cc.compute_ptr` operation has a base argument that is not in
// LLVM normal form, we implicitly assume that pointer's element type
// should have been an `cc.array<T x ?>` instead of `T`. We therefore add
// an explicit `0` as the first index. This converts the strong semantics
// of `cc.compute_ptr` (which does not allow indexing out of bounds in
// objects) to the weaker semantics of C/LLVM, which do implicitly allow
// freely indexing out of bounds.
SmallVector<std::int32_t> constIndices = {0};
constIndices.append(cpOp.getRawConstantIndices().begin(),
cpOp.getRawConstantIndices().end());
auto newOpnds = interleaveConstantsAndOperands(
adaptor.getDynamicIndices(), constIndices);
// Convert to LLVM type
Type eleTy = getTypeConverter()->convertType(ccEleTy);
rewriter.replaceOpWithNewOp<LLVM::GEPOp>(
cpOp, cudaq::opt::factory::getPointerType(rewriter.getContext()),
eleTy, adaptor.getBase(), newOpnds);
}
return success();
}
static SmallVector<LLVM::GEPArg>
interleaveConstantsAndOperands(ValueRange values,
ArrayRef<std::int32_t> rawConsts) {
SmallVector<LLVM::GEPArg> result;
auto valIter = values.begin();
for (auto rc : rawConsts) {
if (rc == cudaq::cc::ComputePtrOp::kDynamicIndex)
result.push_back(*valIter++);
else
result.push_back(rc);
}
return result;
}
};
class ExtractValueOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::ExtractValueOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::ExtractValueOp extract, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
if (extract.indicesAreConstant()) {
auto toTy = getTypeConverter()->convertType(extract.getType());
SmallVector<std::int64_t> position{
adaptor.getRawConstantIndices().begin(),
adaptor.getRawConstantIndices().end()};
rewriter.replaceOpWithNewOp<LLVM::ExtractValueOp>(
extract, toTy, adaptor.getAggregate(), position);
} else {
extract.emitOpError(
"nyi: conversion of extract_value with dynamic indices");
}
return success();
}
};
class FuncToPtrOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::FuncToPtrOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// This becomes a bitcast op.
LogicalResult
matchAndRewrite(cudaq::cc::FuncToPtrOp ftp, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
auto toTy = getTypeConverter()->convertType(ftp.getType());
rewriter.replaceOpWithNewOp<LLVM::BitcastOp>(ftp, toTy, operands);
return success();
}
};
class GlobalOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::GlobalOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// Replace the cc.global with an llvm.global, updating the types, etc.
LogicalResult
matchAndRewrite(cudaq::cc::GlobalOp global, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = global.getLoc();
auto ptrTy = cast<cudaq::cc::PointerType>(global.getType());
auto eleTy = ptrTy.getElementType();
Type type = getTypeConverter()->convertType(eleTy);
auto name = global.getSymName();
bool isReadOnly = global.getConstant();
Attribute initializer = global.getValue().value_or(Attribute{});
mlir::LLVM::GlobalOp::create(rewriter, loc, type, isReadOnly,
LLVM::Linkage::Private, name, initializer,
/*alignment=*/0);
rewriter.eraseOp(global);
return success();
}
};
class InsertValueOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::InsertValueOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::InsertValueOp insert, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto toTy = getTypeConverter()->convertType(insert.getType());
rewriter.replaceOpWithNewOp<LLVM::InsertValueOp>(
insert, toTy, adaptor.getContainer(), adaptor.getValue(),
adaptor.getPosition());
return success();
}
};
class InstantiateCallableOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::InstantiateCallableOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::InstantiateCallableOp callable, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = callable.getLoc();
auto operands = adaptor.getOperands();
auto *ctx = rewriter.getContext();
SmallVector<Type> tupleMemTys(adaptor.getOperands().getTypes().begin(),
adaptor.getOperands().getTypes().end());
auto tupleTy = LLVM::LLVMStructType::getLiteral(ctx, tupleMemTys);
Value tmp;
auto tupleArgTy = cudaq::opt::lambdaAsPairOfPointers(ctx);
if (callable.getNoCapture()) {
Value zero = cudaq::opt::factory::genLlvmI64Constant(loc, rewriter, 0);
tmp = LLVM::IntToPtrOp::create(rewriter, loc, tupleArgTy.getBody()[1],
zero);
} else {
Value tupleVal = LLVM::UndefOp::create(rewriter, loc, tupleTy);
std::int64_t offsetVal = 0;
for (auto op : operands) {
auto offset =
DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{offsetVal});
tupleVal = LLVM::InsertValueOp::create(rewriter, loc, tupleTy, tupleVal,
op, offset);
offsetVal++;
}
tmp = cudaq::opt::factory::createLLVMTemporary(loc, rewriter, tupleTy);
LLVM::StoreOp::create(rewriter, loc, tupleVal, tmp);
}
Value tupleArg = LLVM::UndefOp::create(rewriter, loc, tupleArgTy);
auto sigTy = cudaq::opt::factory::getPointerType(ctx);
auto tramp = LLVM::AddressOfOp::create(
rewriter, loc, sigTy, cast<FlatSymbolRefAttr>(callable.getCallee()));
auto trampoline =
LLVM::BitcastOp::create(rewriter, loc, tupleArgTy.getBody()[0], tramp);
auto zeroA = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{0});
tupleArg = LLVM::InsertValueOp::create(rewriter, loc, tupleArgTy, tupleArg,
trampoline, zeroA);
auto castTmp =
LLVM::BitcastOp::create(rewriter, loc, tupleArgTy.getBody()[1], tmp);
rewriter.replaceOpWithNewOp<LLVM::InsertValueOp>(
callable, tupleArgTy, tupleArg, castTmp,
DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{1}));
return success();
}
};
class LoadOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::LoadOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// Convert each cc::LoadOp to an LLVM::LoadOp.
LogicalResult
matchAndRewrite(cudaq::cc::LoadOp load, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
Type toTy = getTypeConverter()->convertType(load.getType());
rewriter.replaceOpWithNewOp<LLVM::LoadOp>(load, toTy, operands);
return success();
}
};
class SizeOfOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::SizeOfOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::SizeOfOp sizeOfOp, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto inputTy = sizeOfOp.getInputType();
auto resultTy = sizeOfOp.getType();
if (cudaq::quake::isQuakeType(inputTy) ||
cudaq::cc::isDynamicallySizedType(inputTy)) {
// Types that cannot be reified produce the poison op.
rewriter.replaceOpWithNewOp<cudaq::cc::PoisonOp>(sizeOfOp, resultTy);
return success();
}
auto loc = sizeOfOp.getLoc();
// We rely on MLIR here, they are using the GEP approach for now. LLVM is
// planning to remove support for this at some point.
// See: https://github.com/llvm/llvm-project/issues/71507 and
// https://github.com/llvm/llvm-project/issues/96047
auto sizeOp = getSizeInBytes(loc, inputTy, rewriter);
rewriter.replaceOp(sizeOfOp, sizeOp);
return success();
}
};
class OffsetOfOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::OffsetOfOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// Use the GEP approach for now. LLVM is planning to remove support for this
// at some point. See: https://github.com/llvm/llvm-project/issues/71507
LogicalResult
matchAndRewrite(cudaq::cc::OffsetOfOp offsetOp, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto inputTy = offsetOp.getInputType();
SmallVector<cudaq::cc::ComputePtrArg> args;
for (std::int32_t i : offsetOp.getConstantIndices())
args.push_back(i);
auto resultTy = offsetOp.getType();
auto loc = offsetOp.getLoc();
// TODO: replace this with some target-specific memory layout computation
// when we upgrade to a newer MLIR.
auto zero = arith::ConstantIntOp::create(rewriter, loc, 0, 64);
auto ptrTy = cudaq::cc::PointerType::get(inputTy);
auto nul = cudaq::cc::CastOp::create(rewriter, loc, ptrTy, zero);
Value nextPtr =
cudaq::cc::ComputePtrOp::create(rewriter, loc, ptrTy, nul, args);
rewriter.replaceOpWithNewOp<cudaq::cc::CastOp>(offsetOp, resultTy, nextPtr);
return success();
}
};
class StdvecDataOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::StdvecDataOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::StdvecDataOp data, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
auto resTy = getTypeConverter()->convertType(data.getType());
auto ctx = data.getContext();
auto zero = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{0});
auto structTy = dyn_cast<LLVM::LLVMStructType>(operands[0].getType());
if (!structTy)
return data.emitError("stdvec_data must have a struct as argument.");
auto extract = LLVM::ExtractValueOp::create(
rewriter, data.getLoc(), structTy.getBody()[0], operands[0], zero);
rewriter.replaceOpWithNewOp<LLVM::BitcastOp>(data, resTy, extract);
return success();
}
};
class StdvecInitOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::StdvecInitOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::StdvecInitOp init, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
auto resTy = getTypeConverter()->convertType(init.getType());
auto ctx = init.getContext();
auto zero = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{0});
auto loc = init.getLoc();
Value val = LLVM::UndefOp::create(rewriter, loc, resTy);
auto structTy = dyn_cast<LLVM::LLVMStructType>(resTy);
if (!structTy)
return init.emitError("stdvec_init must have a struct as argument.");
auto yolo = LLVM::BitcastOp::create(rewriter, loc, structTy.getBody()[0],
operands[0]);
val = LLVM::InsertValueOp::create(rewriter, loc, val, yolo, zero);
auto one = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{1});
if (operands.size() == 2) {
rewriter.replaceOpWithNewOp<LLVM::InsertValueOp>(init, val, operands[1],
one);
} else {
std::int64_t arrSize =
cast<cudaq::cc::ArrayType>(
cast<cudaq::cc::PointerType>(init.getBuffer().getType())
.getElementType())
.getSize();
auto i64Ty = rewriter.getI64Type();
Value len = LLVM::ConstantOp::create(rewriter, loc, i64Ty,
IntegerAttr::get(i64Ty, arrSize));
rewriter.replaceOpWithNewOp<LLVM::InsertValueOp>(init, val, len, one);
}
return success();
}
};
class StdvecSizeOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::StdvecSizeOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::StdvecSizeOp size, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
auto resTy = getTypeConverter()->convertType(size.getType());
auto ctx = size.getContext();
auto one = DenseI64ArrayAttr::get(ctx, ArrayRef<std::int64_t>{1});
rewriter.replaceOpWithNewOp<LLVM::ExtractValueOp>(size, resTy, operands[0],
one);
return success();
}
};
class CreateStringLiteralOpPattern
: public ConvertOpToLLVMPattern<cudaq::cc::CreateStringLiteralOp> {
public:
using Base = ConvertOpToLLVMPattern<cudaq::cc::CreateStringLiteralOp>;
using Base::Base;
LogicalResult
matchAndRewrite(cudaq::cc::CreateStringLiteralOp stringLiteralOp,
OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto loc = stringLiteralOp.getLoc();
auto parentModule = stringLiteralOp->getParentOfType<ModuleOp>();
StringRef stringLiteral = stringLiteralOp.getStringLiteral();
// Write to the module body
auto insertPoint = rewriter.saveInsertionPoint();
rewriter.setInsertionPointToStart(parentModule.getBody());
// Create the register name global
auto builder = cudaq::IRBuilder::atBlockEnd(parentModule.getBody());
auto slGlobal =
builder.genCStringLiteralAppendNul(loc, parentModule, stringLiteral);
// Shift back to the function
rewriter.restoreInsertionPoint(insertPoint);
// Get the string address
rewriter.replaceOpWithNewOp<LLVM::AddressOfOp>(
stringLiteralOp,
cudaq::opt::factory::getPointerType(rewriter.getContext()),
slGlobal.getSymName());
return success();
}
};
class StoreOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::StoreOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
// Convert each cc::StoreOp to an LLVM::StoreOp.
LogicalResult
matchAndRewrite(cudaq::cc::StoreOp store, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto operands = adaptor.getOperands();
rewriter.replaceOpWithNewOp<LLVM::StoreOp>(store, operands[0], operands[1]);
return success();
}
};
class PoisonOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::PoisonOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::PoisonOp poison, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto resTy = getTypeConverter()->convertType(poison.getType());
// FIXME: This should use PoisonOp, obviously, when we upgrade MLIR.
rewriter.replaceOpWithNewOp<LLVM::UndefOp>(poison, resTy);
return success();
}
};
class UndefOpPattern : public ConvertOpToLLVMPattern<cudaq::cc::UndefOp> {
public:
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::UndefOp undef, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
auto resTy = getTypeConverter()->convertType(undef.getType());
rewriter.replaceOpWithNewOp<LLVM::UndefOp>(undef, resTy);
return success();
}
};
class VarargCallPattern
: public ConvertOpToLLVMPattern<cudaq::cc::VarargCallOp> {
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::VarargCallOp vcall, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
SmallVector<Type> types;
for (auto ty : vcall.getResultTypes())
types.push_back(getTypeConverter()->convertType(ty));
// For vararg calls, we need to set the var_callee_type attribute. Look up
// the callee function to get its type.
auto calleeName = vcall.getCalleeAttr();
TypeAttr varCalleeType;
if (auto func = SymbolTable::lookupNearestSymbolFrom<LLVM::LLVMFuncOp>(
vcall, calleeName))
varCalleeType = TypeAttr::get(func.getFunctionType());
auto callOp = rewriter.replaceOpWithNewOp<LLVM::CallOp>(
vcall, types, calleeName, adaptor.getArgs());
if (varCalleeType)
callOp.setVarCalleeTypeAttr(varCalleeType);
return success();
}
};
class NoInlineCallPattern
: public ConvertOpToLLVMPattern<cudaq::cc::NoInlineCallOp> {
using ConvertOpToLLVMPattern::ConvertOpToLLVMPattern;
LogicalResult
matchAndRewrite(cudaq::cc::NoInlineCallOp nicall, OpAdaptor adaptor,
ConversionPatternRewriter &rewriter) const override {
SmallVector<Type> types;
for (auto ty : nicall.getResultTypes())
types.push_back(getTypeConverter()->convertType(ty));
rewriter.replaceOpWithNewOp<func::CallOp>(nicall, types, nicall.getCallee(),
adaptor.getArgs());
return success();
}
};
} // namespace
void cudaq::opt::populateCCToLLVMPatterns(LLVMTypeConverter &typeConverter,
RewritePatternSet &patterns) {
patterns
.insert<AddressOfOpPattern, AllocaOpPattern, CallableClosureOpPattern,
CallableFuncOpPattern, CallCallableOpPattern,
CallIndirectCallableOpPattern, CastOpPattern, ComputePtrOpPattern,
CreateStringLiteralOpPattern, ExtractValueOpPattern,
FuncToPtrOpPattern, GlobalOpPattern, InsertValueOpPattern,
InstantiateCallableOpPattern, LoadOpPattern, NoInlineCallPattern,
OffsetOfOpPattern, PoisonOpPattern, SizeOfOpPattern,
StdvecDataOpPattern, StdvecInitOpPattern, StdvecSizeOpPattern,
StoreOpPattern, UndefOpPattern, VarargCallPattern>(typeConverter);
}