-
Notifications
You must be signed in to change notification settings - Fork 94
/
CIRDialect.cpp
1990 lines (1712 loc) · 70.1 KB
/
CIRDialect.cpp
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
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//===- CIRDialect.cpp - MLIR CIR ops implementation -----------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file implements the CIR dialect and its operations.
//
//===----------------------------------------------------------------------===//
#include "clang/CIR/Dialect/IR/CIRDialect.h"
#include "clang/CIR/Dialect/IR/CIRAttrs.h"
#include "clang/CIR/Dialect/IR/CIRTypes.h"
#include "mlir/Dialect/Func/IR/FuncOps.h"
#include "mlir/Dialect/LLVMIR/LLVMTypes.h"
#include "mlir/IR/Builders.h"
#include "mlir/IR/DialectImplementation.h"
#include "mlir/IR/FunctionImplementation.h"
#include "mlir/IR/OpDefinition.h"
#include "mlir/IR/OpImplementation.h"
#include "mlir/IR/TypeUtilities.h"
#include "mlir/Interfaces/InferTypeOpInterface.h"
using namespace mlir;
using namespace mlir::cir;
#include "clang/CIR/Dialect/IR/CIROpsEnums.cpp.inc"
#include "clang/CIR/Dialect/IR/CIROpsStructs.cpp.inc"
#include "clang/CIR/Dialect/IR/CIROpsDialect.cpp.inc"
//===----------------------------------------------------------------------===//
// CIR Dialect
//===----------------------------------------------------------------------===//
namespace {
struct CIROpAsmDialectInterface : public OpAsmDialectInterface {
using OpAsmDialectInterface::OpAsmDialectInterface;
AliasResult getAlias(Type type, raw_ostream &os) const final {
if (auto structType = type.dyn_cast<StructType>()) {
os << "ty_" << structType.getTypeName();
return AliasResult::OverridableAlias;
}
return AliasResult::NoAlias;
}
};
} // namespace
/// Dialect initialization, the instance will be owned by the context. This is
/// the point of registration of types and operations for the dialect.
void cir::CIRDialect::initialize() {
registerTypes();
registerAttributes();
addOperations<
#define GET_OP_LIST
#include "clang/CIR/Dialect/IR/CIROps.cpp.inc"
>();
addInterfaces<CIROpAsmDialectInterface>();
}
//===----------------------------------------------------------------------===//
// Helpers
//===----------------------------------------------------------------------===//
// Parses one of the keywords provided in the list `keywords` and returns the
// position of the parsed keyword in the list. If none of the keywords from the
// list is parsed, returns -1.
static int parseOptionalKeywordAlternative(AsmParser &parser,
ArrayRef<StringRef> keywords) {
for (auto en : llvm::enumerate(keywords)) {
if (succeeded(parser.parseOptionalKeyword(en.value())))
return en.index();
}
return -1;
}
namespace {
template <typename Ty> struct EnumTraits {};
#define REGISTER_ENUM_TYPE(Ty) \
template <> struct EnumTraits<Ty> { \
static StringRef stringify(Ty value) { return stringify##Ty(value); } \
static unsigned getMaxEnumVal() { return getMaxEnumValFor##Ty(); } \
}
#define REGISTER_ENUM_TYPE_WITH_NS(NS, Ty) \
template <> struct EnumTraits<NS::Ty> { \
static StringRef stringify(NS::Ty value) { \
return NS::stringify##Ty(value); \
} \
static unsigned getMaxEnumVal() { return NS::getMaxEnumValFor##Ty(); } \
}
REGISTER_ENUM_TYPE(GlobalLinkageKind);
REGISTER_ENUM_TYPE_WITH_NS(sob, SignedOverflowBehavior);
} // namespace
/// Parse an enum from the keyword, or default to the provided default value.
/// The return type is the enum type by default, unless overriden with the
/// second template argument.
/// TODO: teach other places in this file to use this function.
template <typename EnumTy, typename RetTy = EnumTy>
static RetTy parseOptionalCIRKeyword(AsmParser &parser, EnumTy defaultValue) {
SmallVector<StringRef, 10> names;
for (unsigned i = 0, e = EnumTraits<EnumTy>::getMaxEnumVal(); i <= e; ++i)
names.push_back(EnumTraits<EnumTy>::stringify(static_cast<EnumTy>(i)));
int index = parseOptionalKeywordAlternative(parser, names);
if (index == -1)
return static_cast<RetTy>(defaultValue);
return static_cast<RetTy>(index);
}
//===----------------------------------------------------------------------===//
// AllocaOp
//===----------------------------------------------------------------------===//
void AllocaOp::build(::mlir::OpBuilder &odsBuilder,
::mlir::OperationState &odsState, ::mlir::Type addr,
::mlir::Type allocaType, ::llvm::StringRef name,
::mlir::IntegerAttr alignment) {
odsState.addAttribute(getAllocaTypeAttrName(odsState.name),
::mlir::TypeAttr::get(allocaType));
odsState.addAttribute(getNameAttrName(odsState.name),
odsBuilder.getStringAttr(name));
if (alignment) {
odsState.addAttribute(getAlignmentAttrName(odsState.name), alignment);
}
odsState.addTypes(addr);
}
//===----------------------------------------------------------------------===//
// ConstantOp
//===----------------------------------------------------------------------===//
static LogicalResult checkConstantTypes(mlir::Operation *op, mlir::Type opType,
mlir::Attribute attrType) {
if (attrType.isa<NullAttr>()) {
if (opType.isa<::mlir::cir::PointerType>())
return success();
return op->emitOpError("nullptr expects pointer type");
}
if (attrType.isa<ZeroAttr>()) {
// FIXME: should also support arrays / const_arrays.
if (opType.isa<::mlir::cir::StructType>())
return success();
return op->emitOpError("zero expects struct type");
}
if (attrType.isa<BoolAttr>()) {
if (!opType.isa<mlir::cir::BoolType>())
return op->emitOpError("result type (")
<< opType << ") must be '!cir.bool' for '" << attrType << "'";
return success();
}
if (attrType.isa<IntegerAttr, FloatAttr>()) {
auto at = attrType.cast<TypedAttr>();
if (at.getType() != opType) {
return op->emitOpError("result type (")
<< opType << ") does not match value type (" << at.getType()
<< ")";
}
return success();
}
if (attrType.isa<mlir::cir::ConstArrayAttr>()) {
// ConstArrayAttr is already verified to bing with cir.array type.
return success();
}
if (attrType.isa<SymbolRefAttr>()) {
if (opType.isa<::mlir::cir::PointerType>())
return success();
return op->emitOpError("symbolref expects pointer type");
}
if (attrType.isa<mlir::cir::GlobalViewAttr>() ||
attrType.isa<mlir::cir::TypeInfoAttr>() ||
attrType.isa<mlir::cir::ConstStructAttr>() ||
attrType.isa<mlir::cir::VTableAttr>())
return success();
assert(attrType.isa<TypedAttr>() && "What else could we be looking at here?");
return op->emitOpError("global with type ")
<< attrType.cast<TypedAttr>().getType() << " not supported";
}
LogicalResult ConstantOp::verify() {
// ODS already generates checks to make sure the result type is valid. We just
// need to additionally check that the value's attribute type is consistent
// with the result type.
return checkConstantTypes(getOperation(), getType(), getValue());
}
static ParseResult parseConstantValue(OpAsmParser &parser,
mlir::Attribute &valueAttr) {
NamedAttrList attr;
if (parser.parseAttribute(valueAttr, "value", attr).failed()) {
return parser.emitError(parser.getCurrentLocation(),
"expected constant attribute to match type");
}
return success();
}
// FIXME: create a CIRConstAttr and hide this away for both global
// initialization and cir.const operation.
static void printConstant(OpAsmPrinter &p, Attribute value) {
p.printAttribute(value);
}
static void printConstantValue(OpAsmPrinter &p, cir::ConstantOp op,
Attribute value) {
printConstant(p, value);
}
OpFoldResult ConstantOp::fold(FoldAdaptor /*adaptor*/) { return getValue(); }
//===----------------------------------------------------------------------===//
// CastOp
//===----------------------------------------------------------------------===//
LogicalResult CastOp::verify() {
auto resType = getResult().getType();
auto srcType = getSrc().getType();
switch (getKind()) {
case cir::CastKind::int_to_bool: {
if (!resType.isa<mlir::cir::BoolType>())
return emitOpError() << "requires !cir.bool type for result";
if (!(srcType.isInteger(32) || srcType.isInteger(64)))
return emitOpError() << "requires integral type for result";
return success();
}
case cir::CastKind::integral: {
if (!resType.isa<mlir::IntegerType>())
return emitOpError() << "requires !IntegerType for result";
if (!srcType.isa<mlir::IntegerType>())
return emitOpError() << "requires !IntegerType for source";
return success();
}
case cir::CastKind::array_to_ptrdecay: {
auto arrayPtrTy = srcType.dyn_cast<mlir::cir::PointerType>();
auto flatPtrTy = resType.dyn_cast<mlir::cir::PointerType>();
if (!arrayPtrTy || !flatPtrTy)
return emitOpError() << "requires !cir.ptr type for source and result";
auto arrayTy = arrayPtrTy.getPointee().dyn_cast<mlir::cir::ArrayType>();
if (!arrayTy)
return emitOpError() << "requires !cir.array pointee";
if (arrayTy.getEltType() != flatPtrTy.getPointee())
return emitOpError()
<< "requires same type for array element and pointee result";
return success();
}
case cir::CastKind::bitcast: {
if (!srcType.dyn_cast<mlir::cir::PointerType>() ||
!resType.dyn_cast<mlir::cir::PointerType>())
return emitOpError() << "requires !cir.ptr type for source and result";
return success();
}
case cir::CastKind::floating: {
if (!srcType.dyn_cast<mlir::FloatType>() ||
!resType.dyn_cast<mlir::FloatType>())
return emitOpError() << "requries floating for source and result";
return success();
}
}
llvm_unreachable("Unknown CastOp kind?");
}
//===----------------------------------------------------------------------===//
// ReturnOp
//===----------------------------------------------------------------------===//
static mlir::LogicalResult checkReturnAndFunction(ReturnOp op,
cir::FuncOp function) {
// ReturnOps currently only have a single optional operand.
if (op.getNumOperands() > 1)
return op.emitOpError() << "expects at most 1 return operand";
// The operand number and types must match the function signature.
const auto &results = function.getFunctionType().getResults();
if (op.getNumOperands() != results.size())
return op.emitOpError()
<< "does not return the same number of values ("
<< op.getNumOperands() << ") as the enclosing function ("
<< results.size() << ")";
// If the operation does not have an input, we are done.
if (!op.hasOperand())
return mlir::success();
auto inputType = *op.operand_type_begin();
auto resultType = results.front();
// Check that the result type of the function matches the operand type.
if (inputType == resultType)
return mlir::success();
return op.emitError() << "type of return operand (" << inputType
<< ") doesn't match function result type ("
<< resultType << ")";
}
mlir::LogicalResult ReturnOp::verify() {
// Returns can be present in multiple different scopes, get the
// wrapping function and start from there.
auto *fnOp = getOperation()->getParentOp();
while (!isa<cir::FuncOp>(fnOp))
fnOp = fnOp->getParentOp();
// Make sure return types match function return type.
if (checkReturnAndFunction(*this, cast<cir::FuncOp>(fnOp)).failed())
return failure();
return success();
}
//===----------------------------------------------------------------------===//
// IfOp
//===----------------------------------------------------------------------===//
static LogicalResult checkBlockTerminator(OpAsmParser &parser,
llvm::SMLoc parserLoc,
std::optional<Location> l, Region *r,
bool ensureTerm = true) {
mlir::Builder &builder = parser.getBuilder();
if (r->hasOneBlock()) {
if (ensureTerm) {
::mlir::impl::ensureRegionTerminator(
*r, builder, *l, [](OpBuilder &builder, Location loc) {
OperationState state(loc, YieldOp::getOperationName());
YieldOp::build(builder, state);
return Operation::create(state);
});
} else {
assert(r && "region must not be empty");
Block &block = r->back();
if (block.empty() || !block.back().hasTrait<OpTrait::IsTerminator>()) {
return parser.emitError(
parser.getCurrentLocation(),
"blocks are expected to be explicitly terminated");
}
}
return success();
}
// Empty regions don't need any handling.
auto &blocks = r->getBlocks();
if (blocks.empty())
return success();
// Test that at least one block has a yield/return terminator. We can
// probably make this a bit more strict.
for (Block &block : blocks) {
if (block.empty())
continue;
auto &op = block.back();
if (op.hasTrait<mlir::OpTrait::IsTerminator>() &&
isa<YieldOp, ReturnOp>(op)) {
return success();
}
}
parser.emitError(parserLoc,
"expected at least one block with cir.yield or cir.return");
return failure();
}
ParseResult cir::IfOp::parse(OpAsmParser &parser, OperationState &result) {
// Create the regions for 'then'.
result.regions.reserve(2);
Region *thenRegion = result.addRegion();
Region *elseRegion = result.addRegion();
auto &builder = parser.getBuilder();
OpAsmParser::UnresolvedOperand cond;
Type boolType = ::mlir::cir::BoolType::get(builder.getContext());
if (parser.parseOperand(cond) ||
parser.resolveOperand(cond, boolType, result.operands))
return failure();
// Parse the 'then' region.
auto parseThenLoc = parser.getCurrentLocation();
if (parser.parseRegion(*thenRegion, /*arguments=*/{},
/*argTypes=*/{}))
return failure();
if (checkBlockTerminator(parser, parseThenLoc, result.location, thenRegion)
.failed())
return failure();
// If we find an 'else' keyword, parse the 'else' region.
if (!parser.parseOptionalKeyword("else")) {
auto parseElseLoc = parser.getCurrentLocation();
if (parser.parseRegion(*elseRegion, /*arguments=*/{}, /*argTypes=*/{}))
return failure();
if (checkBlockTerminator(parser, parseElseLoc, result.location, elseRegion)
.failed())
return failure();
}
// Parse the optional attribute list.
if (parser.parseOptionalAttrDict(result.attributes))
return failure();
return success();
}
bool shouldPrintTerm(mlir::Region &r) {
if (!r.hasOneBlock())
return true;
auto *entryBlock = &r.front();
if (entryBlock->empty())
return false;
if (isa<ReturnOp>(entryBlock->back()))
return true;
YieldOp y = dyn_cast<YieldOp>(entryBlock->back());
if (y && (!y.isPlain() || !y.getArgs().empty()))
return true;
return false;
}
void cir::IfOp::print(OpAsmPrinter &p) {
p << " " << getCondition() << " ";
auto &thenRegion = this->getThenRegion();
p.printRegion(thenRegion,
/*printEntryBlockArgs=*/false,
/*printBlockTerminators=*/shouldPrintTerm(thenRegion));
// Print the 'else' regions if it exists and has a block.
auto &elseRegion = this->getElseRegion();
if (!elseRegion.empty()) {
p << " else ";
p.printRegion(elseRegion,
/*printEntryBlockArgs=*/false,
/*printBlockTerminators=*/shouldPrintTerm(elseRegion));
}
p.printOptionalAttrDict(getOperation()->getAttrs());
}
/// Default callback for IfOp builders. Inserts nothing for now.
void mlir::cir::buildTerminatedBody(OpBuilder &builder, Location loc) {}
/// Given the region at `index`, or the parent operation if `index` is None,
/// return the successor regions. These are the regions that may be selected
/// during the flow of control. `operands` is a set of optional attributes that
/// correspond to a constant value for each operand, or null if that operand is
/// not a constant.
void IfOp::getSuccessorRegions(std::optional<unsigned> index,
ArrayRef<Attribute> operands,
SmallVectorImpl<RegionSuccessor> ®ions) {
// The `then` and the `else` region branch back to the parent operation.
if (index.has_value()) {
regions.push_back(RegionSuccessor());
return;
}
// Don't consider the else region if it is empty.
Region *elseRegion = &this->getElseRegion();
if (elseRegion->empty())
elseRegion = nullptr;
// Otherwise, the successor is dependent on the condition.
// bool condition;
if (auto condAttr = operands.front().dyn_cast_or_null<IntegerAttr>()) {
assert(0 && "not implemented");
// condition = condAttr.getValue().isOneValue();
// Add the successor regions using the condition.
// regions.push_back(RegionSuccessor(condition ? &thenRegion() :
// elseRegion));
// return;
}
// If the condition isn't constant, both regions may be executed.
regions.push_back(RegionSuccessor(&getThenRegion()));
// If the else region does not exist, it is not a viable successor.
if (elseRegion)
regions.push_back(RegionSuccessor(elseRegion));
return;
}
void IfOp::build(OpBuilder &builder, OperationState &result, Value cond,
bool withElseRegion,
function_ref<void(OpBuilder &, Location)> thenBuilder,
function_ref<void(OpBuilder &, Location)> elseBuilder) {
assert(thenBuilder && "the builder callback for 'then' must be present");
result.addOperands(cond);
OpBuilder::InsertionGuard guard(builder);
Region *thenRegion = result.addRegion();
builder.createBlock(thenRegion);
thenBuilder(builder, result.location);
Region *elseRegion = result.addRegion();
if (!withElseRegion)
return;
builder.createBlock(elseRegion);
elseBuilder(builder, result.location);
}
LogicalResult IfOp::verify() { return success(); }
//===----------------------------------------------------------------------===//
// ScopeOp
//===----------------------------------------------------------------------===//
ParseResult cir::ScopeOp::parse(OpAsmParser &parser, OperationState &result) {
// Create one region within 'scope'.
result.regions.reserve(1);
Region *scopeRegion = result.addRegion();
auto loc = parser.getCurrentLocation();
// Parse the scope region.
if (parser.parseRegion(*scopeRegion, /*arguments=*/{}, /*argTypes=*/{}))
return failure();
if (checkBlockTerminator(parser, loc, result.location, scopeRegion).failed())
return failure();
// Parse the optional attribute list.
if (parser.parseOptionalAttrDict(result.attributes))
return failure();
return success();
}
void cir::ScopeOp::print(OpAsmPrinter &p) {
p << ' ';
auto &scopeRegion = this->getScopeRegion();
p.printRegion(scopeRegion,
/*printEntryBlockArgs=*/false,
/*printBlockTerminators=*/shouldPrintTerm(scopeRegion));
p.printOptionalAttrDict(getOperation()->getAttrs());
}
/// Given the region at `index`, or the parent operation if `index` is None,
/// return the successor regions. These are the regions that may be selected
/// during the flow of control. `operands` is a set of optional attributes that
/// correspond to a constant value for each operand, or null if that operand is
/// not a constant.
void ScopeOp::getSuccessorRegions(std::optional<unsigned> index,
ArrayRef<Attribute> operands,
SmallVectorImpl<RegionSuccessor> ®ions) {
// The only region always branch back to the parent operation.
if (index.has_value()) {
regions.push_back(RegionSuccessor(getResults()));
return;
}
// If the condition isn't constant, both regions may be executed.
regions.push_back(RegionSuccessor(&getScopeRegion()));
}
void ScopeOp::build(
OpBuilder &builder, OperationState &result,
function_ref<void(OpBuilder &, Type &, Location)> scopeBuilder) {
assert(scopeBuilder && "the builder callback for 'then' must be present");
OpBuilder::InsertionGuard guard(builder);
Region *scopeRegion = result.addRegion();
builder.createBlock(scopeRegion);
mlir::Type yieldTy;
scopeBuilder(builder, yieldTy, result.location);
if (yieldTy)
result.addTypes(TypeRange{yieldTy});
}
void ScopeOp::build(OpBuilder &builder, OperationState &result,
function_ref<void(OpBuilder &, Location)> scopeBuilder) {
assert(scopeBuilder && "the builder callback for 'then' must be present");
OpBuilder::InsertionGuard guard(builder);
Region *scopeRegion = result.addRegion();
builder.createBlock(scopeRegion);
scopeBuilder(builder, result.location);
}
LogicalResult ScopeOp::verify() { return success(); }
//===----------------------------------------------------------------------===//
// TernaryOp
//===----------------------------------------------------------------------===//
/// Given the region at `index`, or the parent operation if `index` is None,
/// return the successor regions. These are the regions that may be selected
/// during the flow of control. `operands` is a set of optional attributes that
/// correspond to a constant value for each operand, or null if that operand is
/// not a constant.
void TernaryOp::getSuccessorRegions(std::optional<unsigned> index,
ArrayRef<Attribute> operands,
SmallVectorImpl<RegionSuccessor> ®ions) {
// The `true` and the `false` region branch back to the parent operation.
if (index.has_value()) {
regions.push_back(RegionSuccessor(this->getODSResults(0)));
return;
}
// Try optimize if we have more information
if (auto condAttr = operands.front().dyn_cast_or_null<IntegerAttr>()) {
assert(0 && "not implemented");
}
// If the condition isn't constant, both regions may be executed.
regions.push_back(RegionSuccessor(&getTrueRegion()));
regions.push_back(RegionSuccessor(&getFalseRegion()));
return;
}
void TernaryOp::build(OpBuilder &builder, OperationState &result, Value cond,
function_ref<void(OpBuilder &, Location)> trueBuilder,
function_ref<void(OpBuilder &, Location)> falseBuilder) {
result.addOperands(cond);
OpBuilder::InsertionGuard guard(builder);
Region *trueRegion = result.addRegion();
auto *block = builder.createBlock(trueRegion);
trueBuilder(builder, result.location);
Region *falseRegion = result.addRegion();
builder.createBlock(falseRegion);
falseBuilder(builder, result.location);
auto yield = dyn_cast<YieldOp>(block->getTerminator());
assert((yield && yield.getNumOperands() == 1) &&
"expected cir.yield terminator with one operand");
result.addTypes(TypeRange{yield.getOperand(0).getType()});
}
//===----------------------------------------------------------------------===//
// YieldOp
//===----------------------------------------------------------------------===//
mlir::LogicalResult YieldOp::verify() {
auto isDominatedByLoopOrSwitch = [&](Operation *parentOp) {
while (!llvm::isa<cir::FuncOp>(parentOp)) {
if (llvm::isa<cir::SwitchOp, cir::LoopOp>(parentOp))
return true;
parentOp = parentOp->getParentOp();
}
emitOpError() << "shall be dominated by 'cir.loop' or 'cir.switch'";
return false;
};
auto isDominatedByProperAwaitRegion = [&](Operation *parentOp,
mlir::Region *currRegion) {
while (!llvm::isa<cir::FuncOp>(parentOp)) {
auto awaitOp = dyn_cast<cir::AwaitOp>(parentOp);
if (awaitOp) {
if (currRegion && currRegion == &awaitOp.getResume()) {
emitOpError() << "kind 'nosuspend' can only be used in 'ready' and "
"'suspend' regions";
return false;
}
return true;
}
currRegion = parentOp->getParentRegion();
parentOp = parentOp->getParentOp();
}
emitOpError() << "shall be dominated by 'cir.await'";
return false;
};
auto isDominatedByLoop = [](Operation *parentOp) {
while (!llvm::isa<cir::FuncOp>(parentOp)) {
if (llvm::isa<cir::LoopOp>(parentOp))
return true;
parentOp = parentOp->getParentOp();
}
return false;
};
if (isNoSuspend()) {
if (!isDominatedByProperAwaitRegion(getOperation()->getParentOp(),
getOperation()->getParentRegion()))
return mlir::failure();
return mlir::success();
}
if (isBreak()) {
if (!isDominatedByLoopOrSwitch(getOperation()->getParentOp()))
return mlir::failure();
return mlir::success();
}
if (isContinue()) {
if (!isDominatedByLoop(getOperation()->getParentOp()))
return emitOpError() << "shall be dominated by 'cir.loop'";
return mlir::success();
}
if (isFallthrough()) {
if (!llvm::isa<SwitchOp>(getOperation()->getParentOp()))
return emitOpError() << "fallthrough only expected within 'cir.switch'";
return mlir::success();
}
return mlir::success();
}
//===----------------------------------------------------------------------===//
// BrOp
//===----------------------------------------------------------------------===//
mlir::SuccessorOperands BrOp::getSuccessorOperands(unsigned index) {
assert(index == 0 && "invalid successor index");
// Current block targets do not have operands.
return mlir::SuccessorOperands(MutableOperandRange(getOperation(), 0, 0));
}
Block *BrOp::getSuccessorForOperands(ArrayRef<Attribute>) { return getDest(); }
//===----------------------------------------------------------------------===//
// BrCondOp
//===----------------------------------------------------------------------===//
mlir::SuccessorOperands BrCondOp::getSuccessorOperands(unsigned index) {
assert(index < getNumSuccessors() && "invalid successor index");
return SuccessorOperands(index == 0 ? getDestOperandsTrueMutable()
: getDestOperandsFalseMutable());
}
Block *BrCondOp::getSuccessorForOperands(ArrayRef<Attribute> operands) {
if (IntegerAttr condAttr = operands.front().dyn_cast_or_null<IntegerAttr>())
return condAttr.getValue().isOne() ? getDestTrue() : getDestFalse();
return nullptr;
}
//===----------------------------------------------------------------------===//
// SwitchOp
//===----------------------------------------------------------------------===//
ParseResult
parseSwitchOp(OpAsmParser &parser,
llvm::SmallVectorImpl<std::unique_ptr<::mlir::Region>> ®ions,
::mlir::ArrayAttr &casesAttr,
mlir::OpAsmParser::UnresolvedOperand &cond,
mlir::Type &condType) {
::mlir::IntegerType intCondType;
SmallVector<mlir::Attribute, 4> cases;
auto parseAndCheckRegion = [&]() -> ParseResult {
// Parse region attached to case
regions.emplace_back(new Region);
Region &currRegion = *regions.back().get();
auto parserLoc = parser.getCurrentLocation();
if (parser.parseRegion(currRegion, /*arguments=*/{}, /*argTypes=*/{})) {
regions.clear();
return failure();
}
if (currRegion.empty()) {
return parser.emitError(parser.getCurrentLocation(),
"case region shall not be empty");
}
if (checkBlockTerminator(parser, parserLoc, std::nullopt, &currRegion,
/*ensureTerm=*/false)
.failed())
return failure();
return success();
};
auto parseCase = [&]() -> ParseResult {
auto loc = parser.getCurrentLocation();
if (parser.parseKeyword("case").failed())
return parser.emitError(loc, "expected 'case' keyword here");
if (parser.parseLParen().failed())
return parser.emitError(parser.getCurrentLocation(), "expected '('");
::llvm::StringRef attrStr;
::mlir::NamedAttrList attrStorage;
// case (equal, 20) {
// ...
// 1. Get the case kind
// 2. Get the value (next in list)
// These needs to be in sync with CIROps.td
if (parser.parseOptionalKeyword(&attrStr, {"default", "equal", "anyof"})) {
::mlir::StringAttr attrVal;
::mlir::OptionalParseResult parseResult = parser.parseOptionalAttribute(
attrVal, parser.getBuilder().getNoneType(), "kind", attrStorage);
if (parseResult.has_value()) {
if (failed(*parseResult))
return ::mlir::failure();
attrStr = attrVal.getValue();
}
}
if (attrStr.empty()) {
return parser.emitError(
loc, "expected string or keyword containing one of the following "
"enum values for attribute 'kind' [default, equal, anyof]");
}
auto attrOptional = ::mlir::cir::symbolizeCaseOpKind(attrStr.str());
if (!attrOptional)
return parser.emitError(loc, "invalid ")
<< "kind attribute specification: \"" << attrStr << '"';
auto kindAttr = ::mlir::cir::CaseOpKindAttr::get(
parser.getBuilder().getContext(), attrOptional.value());
// `,` value or `,` [values,...]
SmallVector<mlir::Attribute, 4> caseEltValueListAttr;
mlir::ArrayAttr caseValueList;
switch (kindAttr.getValue()) {
case cir::CaseOpKind::Equal: {
if (parser.parseComma().failed())
return mlir::failure();
int64_t val = 0;
if (parser.parseInteger(val).failed())
return ::mlir::failure();
caseEltValueListAttr.push_back(mlir::IntegerAttr::get(intCondType, val));
break;
}
case cir::CaseOpKind::Anyof: {
if (parser.parseComma().failed())
return mlir::failure();
if (parser.parseLSquare().failed())
return mlir::failure();
if (parser.parseCommaSeparatedList([&]() {
int64_t val = 0;
if (parser.parseInteger(val).failed())
return ::mlir::failure();
caseEltValueListAttr.push_back(
mlir::IntegerAttr::get(intCondType, val));
return ::mlir::success();
}))
return mlir::failure();
if (parser.parseRSquare().failed())
return mlir::failure();
break;
}
case cir::CaseOpKind::Default: {
if (parser.parseRParen().failed())
return parser.emitError(parser.getCurrentLocation(), "expected ')'");
cases.push_back(cir::CaseAttr::get(parser.getBuilder().getArrayAttr({}),
kindAttr, parser.getContext()));
return parseAndCheckRegion();
}
}
caseValueList = parser.getBuilder().getArrayAttr(caseEltValueListAttr);
cases.push_back(
cir::CaseAttr::get(caseValueList, kindAttr, parser.getContext()));
if (succeeded(parser.parseOptionalColon())) {
Type caseIntTy;
if (parser.parseType(caseIntTy).failed())
return parser.emitError(parser.getCurrentLocation(), "expected type");
if (intCondType != caseIntTy)
return parser.emitError(parser.getCurrentLocation(),
"expected a match with the condition type");
}
if (parser.parseRParen().failed())
return parser.emitError(parser.getCurrentLocation(), "expected ')'");
return parseAndCheckRegion();
};
if (parser.parseLParen())
return ::mlir::failure();
if (parser.parseOperand(cond))
return ::mlir::failure();
if (parser.parseColon())
return ::mlir::failure();
if (parser.parseCustomTypeWithFallback(intCondType))
return ::mlir::failure();
condType = intCondType;
if (parser.parseRParen())
return ::mlir::failure();
if (parser
.parseCommaSeparatedList(OpAsmParser::Delimiter::Square, parseCase,
" in cases list")
.failed())
return failure();
casesAttr = parser.getBuilder().getArrayAttr(cases);
return ::mlir::success();
}
void printSwitchOp(OpAsmPrinter &p, SwitchOp op,
mlir::MutableArrayRef<::mlir::Region> regions,
mlir::ArrayAttr casesAttr, mlir::Value condition,
mlir::Type condType) {
int idx = 0, lastIdx = regions.size() - 1;
p << "(";
p << condition;
p << " : ";
p.printStrippedAttrOrType(condType);
p << ") [";
// FIXME: ideally we want some extra indentation for "cases" but too
// cumbersome to pull it out now, since most handling is private. Perhaps
// better improve overall mechanism.
p.printNewline();
for (auto &r : regions) {
p << "case (";
auto attr = casesAttr[idx].cast<CaseAttr>();
auto kind = attr.kind().getValue();
assert((kind == CaseOpKind::Default || kind == CaseOpKind::Equal ||
kind == CaseOpKind::Anyof) &&
"unknown case");
// Case kind
p << stringifyCaseOpKind(kind);
// Case value
switch (kind) {
case cir::CaseOpKind::Equal: {
p << ", ";
p.printStrippedAttrOrType(attr.value()[0]);
break;
}
case cir::CaseOpKind::Anyof: {
p << ", [";
llvm::interleaveComma(attr.value(), p, [&](const Attribute &a) {
p.printAttributeWithoutType(a);
});
p << "] : ";
auto typedAttr = attr.value()[0].dyn_cast<TypedAttr>();
assert(typedAttr && "this should never not have a type!");
p.printType(typedAttr.getType());
break;
}
case cir::CaseOpKind::Default:
break;
}
p << ") ";
p.printRegion(r, /*printEntryBLockArgs=*/false,
/*printBlockTerminators=*/true);
if (idx < lastIdx)
p << ",";
p.printNewline();
idx++;
}
p << "]";
}
/// Given the region at `index`, or the parent operation if `index` is None,
/// return the successor regions. These are the regions that may be selected
/// during the flow of control. `operands` is a set of optional attributes
/// that correspond to a constant value for each operand, or null if that
/// operand is not a constant.
void SwitchOp::getSuccessorRegions(std::optional<unsigned> index,
ArrayRef<Attribute> operands,
SmallVectorImpl<RegionSuccessor> ®ions) {
// If any index all the underlying regions branch back to the parent
// operation.
if (index.has_value()) {
regions.push_back(RegionSuccessor());
return;
}
for (auto &r : this->getRegions()) {
// If we can figure out the case stmt we are landing, this can be
// overly simplified.
// bool condition;
if (auto condAttr = operands.front().dyn_cast_or_null<IntegerAttr>()) {
assert(0 && "not implemented");
(void)r;
// condition = condAttr.getValue().isOneValue();
// Add the successor regions using the condition.
// regions.push_back(RegionSuccessor(condition ? &thenRegion() :
// elseRegion));
// return;
}
}
// If the condition isn't constant, all regions may be executed.
for (auto &r : this->getRegions())
regions.push_back(RegionSuccessor(&r));
}
LogicalResult SwitchOp::verify() { return success(); }
void SwitchOp::build(
OpBuilder &builder, OperationState &result, Value cond,
function_ref<void(OpBuilder &, Location, OperationState &)> switchBuilder) {
assert(switchBuilder && "the builder callback for regions must be present");
OpBuilder::InsertionGuard guardSwitch(builder);
result.addOperands({cond});