| 1 | //===- EmitC.cpp - EmitC Dialect ------------------------------------------===// |
| 2 | // |
| 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | |
| 9 | #include "mlir/Dialect/EmitC/IR/EmitC.h" |
| 10 | #include "mlir/Dialect/EmitC/IR/EmitCInterfaces.h" |
| 11 | #include "mlir/IR/Builders.h" |
| 12 | #include "mlir/IR/BuiltinAttributes.h" |
| 13 | #include "mlir/IR/BuiltinTypes.h" |
| 14 | #include "mlir/IR/IRMapping.h" |
| 15 | #include "mlir/IR/Types.h" |
| 16 | #include "mlir/Interfaces/FunctionImplementation.h" |
| 17 | #include "mlir/Support/LLVM.h" |
| 18 | #include "llvm/ADT/STLExtras.h" |
| 19 | #include "llvm/ADT/SmallVector.h" |
| 20 | #include "llvm/Support/Casting.h" |
| 21 | |
| 22 | using namespace mlir; |
| 23 | using namespace mlir::emitc; |
| 24 | |
| 25 | #include "mlir/Dialect/EmitC/IR/EmitCDialect.cpp.inc" |
| 26 | |
| 27 | //===----------------------------------------------------------------------===// |
| 28 | // EmitCDialect |
| 29 | //===----------------------------------------------------------------------===// |
| 30 | |
| 31 | void EmitCDialect::initialize() { |
| 32 | addOperations< |
| 33 | #define GET_OP_LIST |
| 34 | #include "mlir/Dialect/EmitC/IR/EmitC.cpp.inc" |
| 35 | >(); |
| 36 | addTypes< |
| 37 | #define GET_TYPEDEF_LIST |
| 38 | #include "mlir/Dialect/EmitC/IR/EmitCTypes.cpp.inc" |
| 39 | >(); |
| 40 | addAttributes< |
| 41 | #define GET_ATTRDEF_LIST |
| 42 | #include "mlir/Dialect/EmitC/IR/EmitCAttributes.cpp.inc" |
| 43 | >(); |
| 44 | } |
| 45 | |
| 46 | /// Materialize a single constant operation from a given attribute value with |
| 47 | /// the desired resultant type. |
| 48 | Operation *EmitCDialect::materializeConstant(OpBuilder &builder, |
| 49 | Attribute value, Type type, |
| 50 | Location loc) { |
| 51 | return emitc::ConstantOp::create(builder, location: loc, resultType0: type, value); |
| 52 | } |
| 53 | |
| 54 | /// Default callback for builders of ops carrying a region. Inserts a yield |
| 55 | /// without arguments. |
| 56 | void mlir::emitc::buildTerminatedBody(OpBuilder &builder, Location loc) { |
| 57 | emitc::YieldOp::create(builder, location: loc); |
| 58 | } |
| 59 | |
| 60 | bool mlir::emitc::isSupportedEmitCType(Type type) { |
| 61 | if (llvm::isa<emitc::OpaqueType>(Val: type)) |
| 62 | return true; |
| 63 | if (auto ptrType = llvm::dyn_cast<emitc::PointerType>(Val&: type)) |
| 64 | return isSupportedEmitCType(type: ptrType.getPointee()); |
| 65 | if (auto arrayType = llvm::dyn_cast<emitc::ArrayType>(Val&: type)) { |
| 66 | auto elemType = arrayType.getElementType(); |
| 67 | return !llvm::isa<emitc::ArrayType>(Val: elemType) && |
| 68 | isSupportedEmitCType(type: elemType); |
| 69 | } |
| 70 | if (type.isIndex() || emitc::isPointerWideType(type)) |
| 71 | return true; |
| 72 | if (llvm::isa<IntegerType>(Val: type)) |
| 73 | return isSupportedIntegerType(type); |
| 74 | if (llvm::isa<FloatType>(Val: type)) |
| 75 | return isSupportedFloatType(type); |
| 76 | if (auto tensorType = llvm::dyn_cast<TensorType>(Val&: type)) { |
| 77 | if (!tensorType.hasStaticShape()) { |
| 78 | return false; |
| 79 | } |
| 80 | auto elemType = tensorType.getElementType(); |
| 81 | if (llvm::isa<emitc::ArrayType>(Val: elemType)) { |
| 82 | return false; |
| 83 | } |
| 84 | return isSupportedEmitCType(type: elemType); |
| 85 | } |
| 86 | if (auto tupleType = llvm::dyn_cast<TupleType>(Val&: type)) { |
| 87 | return llvm::all_of(Range: tupleType.getTypes(), P: [](Type type) { |
| 88 | return !llvm::isa<emitc::ArrayType>(Val: type) && isSupportedEmitCType(type); |
| 89 | }); |
| 90 | } |
| 91 | return false; |
| 92 | } |
| 93 | |
| 94 | bool mlir::emitc::isSupportedIntegerType(Type type) { |
| 95 | if (auto intType = llvm::dyn_cast<IntegerType>(Val&: type)) { |
| 96 | switch (intType.getWidth()) { |
| 97 | case 1: |
| 98 | case 8: |
| 99 | case 16: |
| 100 | case 32: |
| 101 | case 64: |
| 102 | return true; |
| 103 | default: |
| 104 | return false; |
| 105 | } |
| 106 | } |
| 107 | return false; |
| 108 | } |
| 109 | |
| 110 | bool mlir::emitc::isIntegerIndexOrOpaqueType(Type type) { |
| 111 | return llvm::isa<IndexType, emitc::OpaqueType>(Val: type) || |
| 112 | isSupportedIntegerType(type) || isPointerWideType(type); |
| 113 | } |
| 114 | |
| 115 | bool mlir::emitc::isSupportedFloatType(Type type) { |
| 116 | if (auto floatType = llvm::dyn_cast<FloatType>(Val&: type)) { |
| 117 | switch (floatType.getWidth()) { |
| 118 | case 16: |
| 119 | return llvm::isa<Float16Type, BFloat16Type>(Val: type); |
| 120 | case 32: |
| 121 | case 64: |
| 122 | return true; |
| 123 | default: |
| 124 | return false; |
| 125 | } |
| 126 | } |
| 127 | return false; |
| 128 | } |
| 129 | |
| 130 | bool mlir::emitc::isPointerWideType(Type type) { |
| 131 | return isa<emitc::SignedSizeTType, emitc::SizeTType, emitc::PtrDiffTType>( |
| 132 | Val: type); |
| 133 | } |
| 134 | |
| 135 | bool mlir::emitc::isFundamentalType(Type type) { |
| 136 | return llvm::isa<IndexType>(Val: type) || isPointerWideType(type) || |
| 137 | isSupportedIntegerType(type) || isSupportedFloatType(type) || |
| 138 | isa<emitc::PointerType>(Val: type); |
| 139 | } |
| 140 | |
| 141 | /// Check that the type of the initial value is compatible with the operations |
| 142 | /// result type. |
| 143 | static LogicalResult verifyInitializationAttribute(Operation *op, |
| 144 | Attribute value) { |
| 145 | assert(op->getNumResults() == 1 && "operation must have 1 result" ); |
| 146 | |
| 147 | if (llvm::isa<emitc::OpaqueAttr>(Val: value)) |
| 148 | return success(); |
| 149 | |
| 150 | if (llvm::isa<StringAttr>(Val: value)) |
| 151 | return op->emitOpError() |
| 152 | << "string attributes are not supported, use #emitc.opaque instead" ; |
| 153 | |
| 154 | Type resultType = op->getResult(idx: 0).getType(); |
| 155 | if (auto lType = dyn_cast<LValueType>(Val&: resultType)) |
| 156 | resultType = lType.getValueType(); |
| 157 | Type attrType = cast<TypedAttr>(Val&: value).getType(); |
| 158 | |
| 159 | if (isPointerWideType(type: resultType) && attrType.isIndex()) |
| 160 | return success(); |
| 161 | |
| 162 | if (resultType != attrType) |
| 163 | return op->emitOpError() |
| 164 | << "requires attribute to either be an #emitc.opaque attribute or " |
| 165 | "it's type (" |
| 166 | << attrType << ") to match the op's result type (" << resultType |
| 167 | << ")" ; |
| 168 | |
| 169 | return success(); |
| 170 | } |
| 171 | |
| 172 | /// Parse a format string and return a list of its parts. |
| 173 | /// A part is either a StringRef that has to be printed as-is, or |
| 174 | /// a Placeholder which requires printing the next operand of the VerbatimOp. |
| 175 | /// In the format string, all `{}` are replaced by Placeholders, except if the |
| 176 | /// `{` is escaped by `{{` - then it doesn't start a placeholder. |
| 177 | template <class ArgType> |
| 178 | FailureOr<SmallVector<ReplacementItem>> parseFormatString( |
| 179 | StringRef toParse, ArgType fmtArgs, |
| 180 | llvm::function_ref<mlir::InFlightDiagnostic()> emitError = {}) { |
| 181 | SmallVector<ReplacementItem> items; |
| 182 | |
| 183 | // If there are not operands, the format string is not interpreted. |
| 184 | if (fmtArgs.empty()) { |
| 185 | items.push_back(Elt: toParse); |
| 186 | return items; |
| 187 | } |
| 188 | |
| 189 | while (!toParse.empty()) { |
| 190 | size_t idx = toParse.find(C: '{'); |
| 191 | if (idx == StringRef::npos) { |
| 192 | // No '{' |
| 193 | items.push_back(Elt: toParse); |
| 194 | break; |
| 195 | } |
| 196 | if (idx > 0) { |
| 197 | // Take all chars excluding the '{'. |
| 198 | items.push_back(Elt: toParse.take_front(N: idx)); |
| 199 | toParse = toParse.drop_front(N: idx); |
| 200 | continue; |
| 201 | } |
| 202 | if (toParse.size() < 2) { |
| 203 | return emitError() << "expected '}' after unescaped '{' at end of string" ; |
| 204 | } |
| 205 | // toParse contains at least two characters and starts with `{`. |
| 206 | char nextChar = toParse[1]; |
| 207 | if (nextChar == '{') { |
| 208 | // Double '{{' -> '{' (escaping). |
| 209 | items.push_back(Elt: toParse.take_front(N: 1)); |
| 210 | toParse = toParse.drop_front(N: 2); |
| 211 | continue; |
| 212 | } |
| 213 | if (nextChar == '}') { |
| 214 | items.push_back(Elt: Placeholder{}); |
| 215 | toParse = toParse.drop_front(N: 2); |
| 216 | continue; |
| 217 | } |
| 218 | |
| 219 | if (emitError) { |
| 220 | return emitError() << "expected '}' after unescaped '{'" ; |
| 221 | } |
| 222 | return failure(); |
| 223 | } |
| 224 | return items; |
| 225 | } |
| 226 | |
| 227 | //===----------------------------------------------------------------------===// |
| 228 | // AddressOfOp |
| 229 | //===----------------------------------------------------------------------===// |
| 230 | |
| 231 | LogicalResult AddressOfOp::verify() { |
| 232 | emitc::LValueType referenceType = getReference().getType(); |
| 233 | emitc::PointerType resultType = getResult().getType(); |
| 234 | |
| 235 | if (referenceType.getValueType() != resultType.getPointee()) |
| 236 | return emitOpError(message: "requires result to be a pointer to the type " |
| 237 | "referenced by operand" ); |
| 238 | |
| 239 | return success(); |
| 240 | } |
| 241 | |
| 242 | //===----------------------------------------------------------------------===// |
| 243 | // AddOp |
| 244 | //===----------------------------------------------------------------------===// |
| 245 | |
| 246 | LogicalResult AddOp::verify() { |
| 247 | Type lhsType = getLhs().getType(); |
| 248 | Type rhsType = getRhs().getType(); |
| 249 | |
| 250 | if (isa<emitc::PointerType>(Val: lhsType) && isa<emitc::PointerType>(Val: rhsType)) |
| 251 | return emitOpError(message: "requires that at most one operand is a pointer" ); |
| 252 | |
| 253 | if ((isa<emitc::PointerType>(Val: lhsType) && |
| 254 | !isa<IntegerType, emitc::OpaqueType>(Val: rhsType)) || |
| 255 | (isa<emitc::PointerType>(Val: rhsType) && |
| 256 | !isa<IntegerType, emitc::OpaqueType>(Val: lhsType))) |
| 257 | return emitOpError(message: "requires that one operand is an integer or of opaque " |
| 258 | "type if the other is a pointer" ); |
| 259 | |
| 260 | return success(); |
| 261 | } |
| 262 | |
| 263 | //===----------------------------------------------------------------------===// |
| 264 | // Assignment operations |
| 265 | //===----------------------------------------------------------------------===// |
| 266 | |
| 267 | template <typename AssignmentOp> |
| 268 | static LogicalResult verifyAssignmentOp(AssignmentOp op) { |
| 269 | TypedValue<emitc::LValueType> variable = op.getVar(); |
| 270 | |
| 271 | if (!variable.getDefiningOp()) |
| 272 | return op.emitOpError() << "cannot assign to block argument" ; |
| 273 | |
| 274 | Type valueType = op.getValue().getType(); |
| 275 | Type variableType = variable.getType().getValueType(); |
| 276 | if (variableType != valueType) |
| 277 | return op.emitOpError() << "requires value's type (" << valueType |
| 278 | << ") to match variable's type (" << variableType |
| 279 | << ")\n variable: " << variable |
| 280 | << "\n value: " << op.getValue() << "\n" ; |
| 281 | return success(); |
| 282 | } |
| 283 | |
| 284 | LogicalResult emitc::AssignOp::verify() { return verifyAssignmentOp(op: *this); } |
| 285 | |
| 286 | LogicalResult emitc::AddAssignOp::verify() { return verifyAssignmentOp(op: *this); } |
| 287 | |
| 288 | LogicalResult emitc::SubAssignOp::verify() { return verifyAssignmentOp(op: *this); } |
| 289 | |
| 290 | LogicalResult emitc::MulAssignOp::verify() { return verifyAssignmentOp(op: *this); } |
| 291 | |
| 292 | LogicalResult emitc::DivAssignOp::verify() { return verifyAssignmentOp(op: *this); } |
| 293 | |
| 294 | LogicalResult emitc::RemAssignOp::verify() { return verifyAssignmentOp(op: *this); } |
| 295 | |
| 296 | //===----------------------------------------------------------------------===// |
| 297 | // CastOp |
| 298 | //===----------------------------------------------------------------------===// |
| 299 | |
| 300 | bool CastOp::areCastCompatible(TypeRange inputs, TypeRange outputs) { |
| 301 | Type input = inputs.front(), output = outputs.front(); |
| 302 | |
| 303 | if (auto arrayType = dyn_cast<emitc::ArrayType>(Val&: input)) { |
| 304 | if (auto pointerType = dyn_cast<emitc::PointerType>(Val&: output)) { |
| 305 | return (arrayType.getElementType() == pointerType.getPointee()) && |
| 306 | arrayType.getShape().size() == 1 && arrayType.getShape()[0] >= 1; |
| 307 | } |
| 308 | return false; |
| 309 | } |
| 310 | |
| 311 | return ( |
| 312 | (emitc::isIntegerIndexOrOpaqueType(type: input) || |
| 313 | emitc::isSupportedFloatType(type: input) || isa<emitc::PointerType>(Val: input)) && |
| 314 | (emitc::isIntegerIndexOrOpaqueType(type: output) || |
| 315 | emitc::isSupportedFloatType(type: output) || isa<emitc::PointerType>(Val: output))); |
| 316 | } |
| 317 | |
| 318 | Speculation::Speculatability emitc::CastOp::getSpeculatability() { |
| 319 | return getPure() ? Speculation::Speculatable : Speculation::NotSpeculatable; |
| 320 | } |
| 321 | |
| 322 | void emitc::CastOp::getEffects( |
| 323 | SmallVectorImpl<MemoryEffects::EffectInstance> &effects) { |
| 324 | if (getPure()) |
| 325 | return; |
| 326 | |
| 327 | effects.emplace_back(Args: MemoryEffects::Read::get()); |
| 328 | effects.emplace_back(Args: MemoryEffects::Write::get()); |
| 329 | } |
| 330 | |
| 331 | //===----------------------------------------------------------------------===// |
| 332 | // CallOpaqueOp |
| 333 | //===----------------------------------------------------------------------===// |
| 334 | |
| 335 | static LogicalResult |
| 336 | verifyOpaqueCallCommon(Operation *op, StringRef callee, |
| 337 | std::optional<ArrayAttr> args, |
| 338 | std::optional<ArrayAttr> templateArgs, |
| 339 | TypeRange resultTypes, size_t numArgsOperands) { |
| 340 | // Callee must not be empty. |
| 341 | if (callee.empty()) |
| 342 | return op->emitOpError(message: "callee must not be empty" ); |
| 343 | |
| 344 | if (args) { |
| 345 | for (Attribute arg : *args) { |
| 346 | auto intAttr = llvm::dyn_cast<IntegerAttr>(Val&: arg); |
| 347 | if (intAttr && llvm::isa<IndexType>(Val: intAttr.getType())) { |
| 348 | int64_t index = intAttr.getInt(); |
| 349 | // Args with elements of type index must be in range |
| 350 | // [0..numArgsOperands). |
| 351 | if ((index < 0) || (index >= static_cast<int64_t>(numArgsOperands))) |
| 352 | return op->emitOpError(message: "index argument is out of range" ); |
| 353 | |
| 354 | } else if (llvm::isa<ArrayAttr>(Val: arg)) { |
| 355 | return op->emitOpError(message: "array argument has no type" ); |
| 356 | } |
| 357 | } |
| 358 | } |
| 359 | |
| 360 | if (templateArgs) { |
| 361 | for (Attribute tArg : *templateArgs) { |
| 362 | if (!llvm::isa<TypeAttr, IntegerAttr, FloatAttr, emitc::OpaqueAttr>(Val: tArg)) |
| 363 | return op->emitOpError(message: "template argument has invalid type" ); |
| 364 | } |
| 365 | } |
| 366 | |
| 367 | if (llvm::any_of(Range&: resultTypes, P: llvm::IsaPred<ArrayType>)) { |
| 368 | return op->emitOpError() << "cannot return array type" ; |
| 369 | } |
| 370 | |
| 371 | return success(); |
| 372 | } |
| 373 | |
| 374 | LogicalResult emitc::CallOpaqueOp::verify() { |
| 375 | return verifyOpaqueCallCommon(op: getOperation(), callee: getCallee(), args: getArgs(), |
| 376 | templateArgs: getTemplateArgs(), resultTypes: getResultTypes(), |
| 377 | numArgsOperands: getNumOperands()); |
| 378 | } |
| 379 | |
| 380 | LogicalResult emitc::MemberCallOpaqueOp::verify() { |
| 381 | return verifyOpaqueCallCommon(op: getOperation(), callee: getCallee(), args: getArgs(), |
| 382 | templateArgs: getTemplateArgs(), resultTypes: getResultTypes(), |
| 383 | numArgsOperands: getArgOperands().size()); |
| 384 | } |
| 385 | |
| 386 | //===----------------------------------------------------------------------===// |
| 387 | // ConstantOp |
| 388 | //===----------------------------------------------------------------------===// |
| 389 | |
| 390 | LogicalResult emitc::ConstantOp::verify() { |
| 391 | Attribute value = getValueAttr(); |
| 392 | if (failed(Result: verifyInitializationAttribute(op: getOperation(), value))) |
| 393 | return failure(); |
| 394 | if (auto opaqueValue = llvm::dyn_cast<emitc::OpaqueAttr>(Val&: value)) { |
| 395 | if (opaqueValue.getValue().empty()) |
| 396 | return emitOpError() << "value must not be empty" ; |
| 397 | } |
| 398 | return success(); |
| 399 | } |
| 400 | |
| 401 | OpFoldResult emitc::ConstantOp::fold(FoldAdaptor adaptor) { return getValue(); } |
| 402 | |
| 403 | //===----------------------------------------------------------------------===// |
| 404 | // DereferenceOp |
| 405 | //===----------------------------------------------------------------------===// |
| 406 | |
| 407 | LogicalResult DereferenceOp::verify() { |
| 408 | emitc::PointerType pointerType = getPointer().getType(); |
| 409 | |
| 410 | if (pointerType.getPointee() != getResult().getType().getValueType()) |
| 411 | return emitOpError(message: "requires result to be an lvalue of the type " |
| 412 | "pointed to by operand" ); |
| 413 | |
| 414 | return success(); |
| 415 | } |
| 416 | |
| 417 | //===----------------------------------------------------------------------===// |
| 418 | // ExpressionOp |
| 419 | //===----------------------------------------------------------------------===// |
| 420 | |
| 421 | namespace { |
| 422 | |
| 423 | struct RemoveRecurringExpressionOperands |
| 424 | : public OpRewritePattern<ExpressionOp> { |
| 425 | using OpRewritePattern<ExpressionOp>::OpRewritePattern; |
| 426 | LogicalResult matchAndRewrite(ExpressionOp expressionOp, |
| 427 | PatternRewriter &rewriter) const override { |
| 428 | SetVector<Value> uniqueOperands; |
| 429 | DenseMap<Value, int> firstIndexOf; |
| 430 | |
| 431 | // Collect duplicate operands and prepare to remove excessive copies. |
| 432 | for (auto [i, operand] : llvm::enumerate(First: expressionOp.getDefs())) { |
| 433 | if (uniqueOperands.contains(key: operand)) |
| 434 | continue; |
| 435 | uniqueOperands.insert(X: operand); |
| 436 | firstIndexOf[operand] = i; |
| 437 | } |
| 438 | |
| 439 | // If every operand is unique, bail out. |
| 440 | if (uniqueOperands.size() == expressionOp.getDefs().size()) |
| 441 | return failure(); |
| 442 | |
| 443 | // Create a new expression with unique operands. |
| 444 | rewriter.setInsertionPointAfter(expressionOp); |
| 445 | auto uniqueExpression = emitc::ExpressionOp::create( |
| 446 | builder&: rewriter, location: expressionOp.getLoc(), result: expressionOp.getResult().getType(), |
| 447 | defs: uniqueOperands.getArrayRef(), do_not_inline: expressionOp.getDoNotInline()); |
| 448 | Block &uniqueExpressionBody = uniqueExpression.createBody(); |
| 449 | |
| 450 | // Map each original block arguments to the unique block argument taking |
| 451 | // the same operand. |
| 452 | IRMapping mapper; |
| 453 | Block *expressionBody = expressionOp.getBody(); |
| 454 | for (auto [operand, arg] : |
| 455 | llvm::zip(t: expressionOp.getOperands(), u: expressionBody->getArguments())) |
| 456 | mapper.map(from: arg, to: uniqueExpressionBody.getArgument(i: firstIndexOf[operand])); |
| 457 | |
| 458 | rewriter.setInsertionPointToStart(&uniqueExpressionBody); |
| 459 | for (Operation &opToClone : *expressionOp.getBody()) |
| 460 | rewriter.clone(op&: opToClone, mapper); |
| 461 | |
| 462 | // Complete the rewrite. |
| 463 | rewriter.replaceOp(op: expressionOp, newOp: uniqueExpression); |
| 464 | |
| 465 | return success(); |
| 466 | } |
| 467 | }; |
| 468 | |
| 469 | /// If an ExpressionOp body yields a block argument directly (no root op), |
| 470 | /// this means a contained op was folded away (e.g., an identity cast whose |
| 471 | /// in/out types match). Canonicalize by replacing the expression with the |
| 472 | /// corresponding operand value. |
| 473 | struct FoldTrivialExpressionOp : public OpRewritePattern<ExpressionOp> { |
| 474 | using OpRewritePattern<ExpressionOp>::OpRewritePattern; |
| 475 | LogicalResult matchAndRewrite(ExpressionOp expressionOp, |
| 476 | PatternRewriter &rewriter) const override { |
| 477 | auto yieldOp = cast<YieldOp>(Val: expressionOp.getBody()->getTerminator()); |
| 478 | Value yieldedValue = yieldOp.getResult(); |
| 479 | auto blockArg = dyn_cast_if_present<BlockArgument>(Val&: yieldedValue); |
| 480 | if (!blockArg) |
| 481 | return failure(); |
| 482 | rewriter.replaceOp(op: expressionOp, |
| 483 | newValues: expressionOp.getOperand(i: blockArg.getArgNumber())); |
| 484 | return success(); |
| 485 | } |
| 486 | }; |
| 487 | |
| 488 | } // namespace |
| 489 | |
| 490 | void ExpressionOp::getCanonicalizationPatterns(RewritePatternSet &results, |
| 491 | MLIRContext *context) { |
| 492 | results.add<RemoveRecurringExpressionOperands, FoldTrivialExpressionOp>( |
| 493 | arg&: context); |
| 494 | } |
| 495 | |
| 496 | ParseResult ExpressionOp::parse(OpAsmParser &parser, OperationState &result) { |
| 497 | SmallVector<OpAsmParser::UnresolvedOperand> operands; |
| 498 | if (parser.parseOperandList(result&: operands)) |
| 499 | return parser.emitError(loc: parser.getCurrentLocation()) << "expected operands" ; |
| 500 | if (succeeded(Result: parser.parseOptionalKeyword(keyword: "noinline" ))) |
| 501 | result.addAttribute(name: ExpressionOp::getDoNotInlineAttrName(name: result.name), |
| 502 | attr: parser.getBuilder().getUnitAttr()); |
| 503 | Type type; |
| 504 | if (parser.parseColonType(result&: type)) |
| 505 | return parser.emitError(loc: parser.getCurrentLocation(), |
| 506 | message: "expected function type" ); |
| 507 | auto fnType = llvm::dyn_cast<FunctionType>(Val&: type); |
| 508 | if (!fnType) |
| 509 | return parser.emitError(loc: parser.getCurrentLocation(), |
| 510 | message: "expected function type" ); |
| 511 | if (parser.resolveOperands(operands, types: fnType.getInputs(), |
| 512 | loc: parser.getCurrentLocation(), result&: result.operands)) |
| 513 | return failure(); |
| 514 | if (fnType.getNumResults() != 1) |
| 515 | return parser.emitError(loc: parser.getCurrentLocation(), |
| 516 | message: "expected single return type" ); |
| 517 | result.addTypes(newTypes: fnType.getResults()); |
| 518 | Region *body = result.addRegion(); |
| 519 | DenseSet<Value> uniqueOperands(result.operands.begin(), |
| 520 | result.operands.end()); |
| 521 | bool enableNameShadowing = uniqueOperands.size() == result.operands.size(); |
| 522 | SmallVector<OpAsmParser::Argument> argsInfo; |
| 523 | if (enableNameShadowing) { |
| 524 | for (auto [unresolvedOperand, operandType] : |
| 525 | llvm::zip(t&: operands, u: fnType.getInputs())) { |
| 526 | OpAsmParser::Argument argInfo; |
| 527 | argInfo.ssaName = unresolvedOperand; |
| 528 | argInfo.type = operandType; |
| 529 | argsInfo.push_back(Elt: argInfo); |
| 530 | } |
| 531 | } |
| 532 | SMLoc beforeRegionLoc = parser.getCurrentLocation(); |
| 533 | if (parser.parseRegion(region&: *body, arguments: argsInfo, enableNameShadowing)) |
| 534 | return failure(); |
| 535 | if (!enableNameShadowing) { |
| 536 | if (body->front().getArguments().size() < result.operands.size()) { |
| 537 | return parser.emitError( |
| 538 | loc: beforeRegionLoc, message: "with recurring operands expected block arguments" ); |
| 539 | } |
| 540 | } |
| 541 | return success(); |
| 542 | } |
| 543 | |
| 544 | void emitc::ExpressionOp::print(OpAsmPrinter &p) { |
| 545 | p << ' '; |
| 546 | auto operands = getDefs(); |
| 547 | p.printOperands(operands); |
| 548 | p << " : " ; |
| 549 | p.printFunctionalType(op: getOperation()); |
| 550 | DenseSet<Value> uniqueOperands(operands.begin(), operands.end()); |
| 551 | bool printEntryBlockArgs = true; |
| 552 | if (uniqueOperands.size() == operands.size()) { |
| 553 | p.shadowRegionArgs(region&: getRegion(), namesToUse: getDefs()); |
| 554 | printEntryBlockArgs = false; |
| 555 | } |
| 556 | p << ' '; |
| 557 | p.printRegion(blocks&: getRegion(), printEntryBlockArgs); |
| 558 | } |
| 559 | |
| 560 | Operation *ExpressionOp::getRootOp() { |
| 561 | auto yieldOp = cast<YieldOp>(Val: getBody()->getTerminator()); |
| 562 | Value yieldedValue = yieldOp.getResult(); |
| 563 | return yieldedValue.getDefiningOp(); |
| 564 | } |
| 565 | |
| 566 | LogicalResult ExpressionOp::verify() { |
| 567 | Type resultType = getResult().getType(); |
| 568 | Region ®ion = getRegion(); |
| 569 | |
| 570 | Block &body = region.front(); |
| 571 | |
| 572 | if (!body.mightHaveTerminator()) |
| 573 | return emitOpError(message: "must yield a value at termination" ); |
| 574 | |
| 575 | auto yield = cast<YieldOp>(Val: body.getTerminator()); |
| 576 | Value yieldResult = yield.getResult(); |
| 577 | |
| 578 | if (!yieldResult) |
| 579 | return emitOpError(message: "must yield a value at termination" ); |
| 580 | |
| 581 | Operation *rootOp = yieldResult.getDefiningOp(); |
| 582 | |
| 583 | if (!rootOp) |
| 584 | return emitOpError(message: "yielded value has no defining op" ); |
| 585 | |
| 586 | if (rootOp->getParentOp() != getOperation()) |
| 587 | return emitOpError(message: "yielded value not defined within expression" ); |
| 588 | |
| 589 | Type yieldType = yieldResult.getType(); |
| 590 | |
| 591 | if (resultType != yieldType) |
| 592 | return emitOpError(message: "requires yielded type to match return type" ); |
| 593 | |
| 594 | for (Operation &op : region.front().without_terminator()) { |
| 595 | auto expressionInterface = dyn_cast<emitc::CExpressionInterface>(Val&: op); |
| 596 | if (!expressionInterface) |
| 597 | return emitOpError(message: "contains an unsupported operation" ); |
| 598 | if (op.getNumResults() != 1) |
| 599 | return emitOpError(message: "requires exactly one result for each operation" ); |
| 600 | Value result = op.getResult(idx: 0); |
| 601 | if (result.use_empty()) |
| 602 | return emitOpError(message: "contains an unused operation" ); |
| 603 | } |
| 604 | |
| 605 | // Make sure any operation with side effect is only reachable once from |
| 606 | // the root op, otherwise emission will be replicating side effects. |
| 607 | SmallPtrSet<Operation *, 16> visited; |
| 608 | SmallVector<Operation *> worklist; |
| 609 | worklist.push_back(Elt: rootOp); |
| 610 | while (!worklist.empty()) { |
| 611 | Operation *op = worklist.back(); |
| 612 | worklist.pop_back(); |
| 613 | if (visited.contains(Ptr: op)) { |
| 614 | auto cExpr = cast<CExpressionInterface>(Val: op); |
| 615 | if (!cExpr.alwaysInline() && cExpr.hasSideEffects()) |
| 616 | return emitOpError( |
| 617 | message: "requires exactly one use for operations with side effects" ); |
| 618 | } |
| 619 | visited.insert(Ptr: op); |
| 620 | for (Value operand : op->getOperands()) |
| 621 | if (Operation *def = operand.getDefiningOp()) { |
| 622 | worklist.push_back(Elt: def); |
| 623 | } |
| 624 | } |
| 625 | |
| 626 | // It is illegal to forbid inlining of expressions whose root operation must |
| 627 | // be inlined. |
| 628 | if (getDoNotInline() && |
| 629 | cast<emitc::CExpressionInterface>(Val: rootOp).alwaysInline()) { |
| 630 | return emitOpError(message: "root operation must be inlined but expression is marked" |
| 631 | " do-not-inline" ); |
| 632 | } |
| 633 | |
| 634 | return success(); |
| 635 | } |
| 636 | |
| 637 | //===----------------------------------------------------------------------===// |
| 638 | // ForOp |
| 639 | //===----------------------------------------------------------------------===// |
| 640 | |
| 641 | void ForOp::build(OpBuilder &builder, OperationState &result, Value lb, |
| 642 | Value ub, Value step, BodyBuilderFn bodyBuilder) { |
| 643 | OpBuilder::InsertionGuard g(builder); |
| 644 | result.addOperands(newOperands: {lb, ub, step}); |
| 645 | Type t = lb.getType(); |
| 646 | Region *bodyRegion = result.addRegion(); |
| 647 | Block *bodyBlock = builder.createBlock(parent: bodyRegion); |
| 648 | bodyBlock->addArgument(type: t, loc: result.location); |
| 649 | |
| 650 | // Create the default terminator if the builder is not provided. |
| 651 | if (!bodyBuilder) { |
| 652 | ForOp::ensureTerminator(region&: *bodyRegion, builder, loc: result.location); |
| 653 | } else { |
| 654 | OpBuilder::InsertionGuard guard(builder); |
| 655 | builder.setInsertionPointToStart(bodyBlock); |
| 656 | bodyBuilder(builder, result.location, bodyBlock->getArgument(i: 0)); |
| 657 | } |
| 658 | } |
| 659 | |
| 660 | void ForOp::getCanonicalizationPatterns(RewritePatternSet &, MLIRContext *) {} |
| 661 | |
| 662 | ParseResult ForOp::parse(OpAsmParser &parser, OperationState &result) { |
| 663 | Builder &builder = parser.getBuilder(); |
| 664 | Type type; |
| 665 | |
| 666 | OpAsmParser::Argument inductionVariable; |
| 667 | OpAsmParser::UnresolvedOperand lb, ub, step; |
| 668 | |
| 669 | // Parse the induction variable followed by '='. |
| 670 | if (parser.parseOperand(result&: inductionVariable.ssaName) || parser.parseEqual() || |
| 671 | // Parse loop bounds. |
| 672 | parser.parseOperand(result&: lb) || parser.parseKeyword(keyword: "to" ) || |
| 673 | parser.parseOperand(result&: ub) || parser.parseKeyword(keyword: "step" ) || |
| 674 | parser.parseOperand(result&: step)) |
| 675 | return failure(); |
| 676 | |
| 677 | // Parse the optional initial iteration arguments. |
| 678 | SmallVector<OpAsmParser::Argument, 4> regionArgs; |
| 679 | regionArgs.push_back(Elt: inductionVariable); |
| 680 | |
| 681 | // Parse optional type, else assume Index. |
| 682 | if (parser.parseOptionalColon()) |
| 683 | type = builder.getIndexType(); |
| 684 | else if (parser.parseType(result&: type)) |
| 685 | return failure(); |
| 686 | |
| 687 | // Resolve input operands. |
| 688 | regionArgs.front().type = type; |
| 689 | if (parser.resolveOperand(operand: lb, type, result&: result.operands) || |
| 690 | parser.resolveOperand(operand: ub, type, result&: result.operands) || |
| 691 | parser.resolveOperand(operand: step, type, result&: result.operands)) |
| 692 | return failure(); |
| 693 | |
| 694 | // Parse the body region. |
| 695 | Region *body = result.addRegion(); |
| 696 | if (parser.parseRegion(region&: *body, arguments: regionArgs)) |
| 697 | return failure(); |
| 698 | |
| 699 | ForOp::ensureTerminator(region&: *body, builder, loc: result.location); |
| 700 | |
| 701 | // Parse the optional attribute list. |
| 702 | if (parser.parseOptionalAttrDict(result&: result.attributes)) |
| 703 | return failure(); |
| 704 | |
| 705 | return success(); |
| 706 | } |
| 707 | |
| 708 | void ForOp::print(OpAsmPrinter &p) { |
| 709 | p << " " << getInductionVar() << " = " << getLowerBound() << " to " |
| 710 | << getUpperBound() << " step " << getStep(); |
| 711 | |
| 712 | p << ' '; |
| 713 | if (Type t = getInductionVar().getType(); !t.isIndex()) |
| 714 | p << " : " << t << ' '; |
| 715 | p.printRegion(blocks&: getRegion(), |
| 716 | /*printEntryBlockArgs=*/false, |
| 717 | /*printBlockTerminators=*/false); |
| 718 | p.printOptionalAttrDict(attrs: (*this)->getDiscardableAttrDictionary().getValue()); |
| 719 | } |
| 720 | |
| 721 | LogicalResult ForOp::verifyRegions() { |
| 722 | // Check that the body defines as single block argument for the induction |
| 723 | // variable. |
| 724 | if (getBody()->getNumArguments() != 1) |
| 725 | return emitOpError(message: "expected body to have a single block argument for the " |
| 726 | "induction variable" ); |
| 727 | |
| 728 | if (getInductionVar().getType() != getLowerBound().getType()) |
| 729 | return emitOpError( |
| 730 | message: "expected induction variable to be same type as bounds and step" ); |
| 731 | |
| 732 | return success(); |
| 733 | } |
| 734 | |
| 735 | //===----------------------------------------------------------------------===// |
| 736 | // CallOp |
| 737 | //===----------------------------------------------------------------------===// |
| 738 | |
| 739 | LogicalResult CallOp::verifySymbolUses(SymbolTableCollection &symbolTable) { |
| 740 | // Check that the callee attribute was specified. |
| 741 | auto fnAttr = getCalleeAttr(); |
| 742 | if (!fnAttr) |
| 743 | return emitOpError(message: "requires a 'callee' symbol reference attribute" ); |
| 744 | FuncOp fn = symbolTable.lookupNearestSymbolFrom<FuncOp>(from: *this, symbol: fnAttr); |
| 745 | if (!fn) |
| 746 | return emitOpError() << "'" << fnAttr.getValue() |
| 747 | << "' does not reference a valid function" ; |
| 748 | |
| 749 | // Verify that the operand and result types match the callee. |
| 750 | return call_interface_impl::verifyCallOpInterface(call: *this, callable: fn); |
| 751 | } |
| 752 | |
| 753 | FunctionType CallOp::getCalleeType() { |
| 754 | return FunctionType::get(context: getContext(), inputs: getOperandTypes(), results: getResultTypes()); |
| 755 | } |
| 756 | |
| 757 | //===----------------------------------------------------------------------===// |
| 758 | // DeclareFuncOp |
| 759 | //===----------------------------------------------------------------------===// |
| 760 | |
| 761 | LogicalResult |
| 762 | DeclareFuncOp::verifySymbolUses(SymbolTableCollection &symbolTable) { |
| 763 | // Check that the sym_name attribute was specified. |
| 764 | auto fnAttr = getSymNameAttr(); |
| 765 | if (!fnAttr) |
| 766 | return emitOpError(message: "requires a 'sym_name' symbol reference attribute" ); |
| 767 | FuncOp fn = symbolTable.lookupNearestSymbolFrom<FuncOp>(from: *this, symbol: fnAttr); |
| 768 | if (!fn) |
| 769 | return emitOpError() << "'" << fnAttr.getValue() |
| 770 | << "' does not reference a valid function" ; |
| 771 | |
| 772 | return success(); |
| 773 | } |
| 774 | |
| 775 | //===----------------------------------------------------------------------===// |
| 776 | // FuncOp |
| 777 | //===----------------------------------------------------------------------===// |
| 778 | |
| 779 | void FuncOp::build(OpBuilder &builder, OperationState &state, StringRef name, |
| 780 | FunctionType type, ArrayRef<NamedAttribute> attrs, |
| 781 | ArrayRef<DictionaryAttr> argAttrs) { |
| 782 | state.addAttribute(name: getSymNameAttrName(name: state.name), |
| 783 | attr: builder.getStringAttr(bytes: name)); |
| 784 | state.addAttribute(name: getFunctionTypeAttrName(name: state.name), attr: TypeAttr::get(type)); |
| 785 | state.attributes.append(inStart: attrs.begin(), inEnd: attrs.end()); |
| 786 | state.addRegion(); |
| 787 | |
| 788 | if (argAttrs.empty()) |
| 789 | return; |
| 790 | assert(type.getNumInputs() == argAttrs.size()); |
| 791 | call_interface_impl::addArgAndResultAttrs( |
| 792 | builder, result&: state, argAttrs, /*resultAttrs=*/{}, |
| 793 | argAttrsName: getArgAttrsAttrName(name: state.name), resAttrsName: getResAttrsAttrName(name: state.name)); |
| 794 | } |
| 795 | |
| 796 | ParseResult FuncOp::parse(OpAsmParser &parser, OperationState &result) { |
| 797 | auto buildFuncType = |
| 798 | [](Builder &builder, ArrayRef<Type> argTypes, ArrayRef<Type> results, |
| 799 | function_interface_impl::VariadicFlag, |
| 800 | std::string &) { return builder.getFunctionType(inputs: argTypes, results); }; |
| 801 | |
| 802 | return function_interface_impl::parseFunctionOp( |
| 803 | parser, result, /*allowVariadic=*/false, |
| 804 | typeAttrName: getFunctionTypeAttrName(name: result.name), funcTypeBuilder: buildFuncType, |
| 805 | argAttrsName: getArgAttrsAttrName(name: result.name), resAttrsName: getResAttrsAttrName(name: result.name)); |
| 806 | } |
| 807 | |
| 808 | void FuncOp::print(OpAsmPrinter &p) { |
| 809 | function_interface_impl::printFunctionOp( |
| 810 | p, op: *this, /*isVariadic=*/false, typeAttrName: getFunctionTypeAttrName(), |
| 811 | argAttrsName: getArgAttrsAttrName(), resAttrsName: getResAttrsAttrName()); |
| 812 | } |
| 813 | |
| 814 | LogicalResult FuncOp::verify() { |
| 815 | if (llvm::any_of(Range: getArgumentTypes(), P: llvm::IsaPred<LValueType>)) { |
| 816 | return emitOpError(message: "cannot have lvalue type as argument" ); |
| 817 | } |
| 818 | |
| 819 | if (getNumResults() > 1) |
| 820 | return emitOpError(message: "requires zero or exactly one result, but has " ) |
| 821 | << getNumResults(); |
| 822 | |
| 823 | if (getNumResults() == 1 && isa<ArrayType>(Val: getResultTypes()[0])) |
| 824 | return emitOpError(message: "cannot return array type" ); |
| 825 | |
| 826 | return success(); |
| 827 | } |
| 828 | |
| 829 | //===----------------------------------------------------------------------===// |
| 830 | // ReturnOp |
| 831 | //===----------------------------------------------------------------------===// |
| 832 | |
| 833 | LogicalResult ReturnOp::verify() { |
| 834 | auto function = cast<FuncOp>(Val: (*this)->getParentOp()); |
| 835 | |
| 836 | // The operand number and types must match the function signature. |
| 837 | if (getNumOperands() != function.getNumResults()) |
| 838 | return emitOpError(message: "has " ) |
| 839 | << getNumOperands() << " operands, but enclosing function (@" |
| 840 | << function.getName() << ") returns " << function.getNumResults(); |
| 841 | |
| 842 | if (function.getNumResults() == 1) |
| 843 | if (getOperand().getType() != function.getResultTypes()[0]) |
| 844 | return emitError() << "type of the return operand (" |
| 845 | << getOperand().getType() |
| 846 | << ") doesn't match function result type (" |
| 847 | << function.getResultTypes()[0] << ")" |
| 848 | << " in function @" << function.getName(); |
| 849 | return success(); |
| 850 | } |
| 851 | |
| 852 | //===----------------------------------------------------------------------===// |
| 853 | // IfOp |
| 854 | //===----------------------------------------------------------------------===// |
| 855 | |
| 856 | void IfOp::build(OpBuilder &builder, OperationState &result, Value cond, |
| 857 | bool addThenBlock, bool addElseBlock) { |
| 858 | assert((!addElseBlock || addThenBlock) && |
| 859 | "must not create else block w/o then block" ); |
| 860 | result.addOperands(newOperands: cond); |
| 861 | |
| 862 | // Add regions and blocks. |
| 863 | OpBuilder::InsertionGuard guard(builder); |
| 864 | Region *thenRegion = result.addRegion(); |
| 865 | if (addThenBlock) |
| 866 | builder.createBlock(parent: thenRegion); |
| 867 | Region *elseRegion = result.addRegion(); |
| 868 | if (addElseBlock) |
| 869 | builder.createBlock(parent: elseRegion); |
| 870 | } |
| 871 | |
| 872 | void IfOp::build(OpBuilder &builder, OperationState &result, Value cond, |
| 873 | bool withElseRegion) { |
| 874 | result.addOperands(newOperands: cond); |
| 875 | |
| 876 | // Build then region. |
| 877 | OpBuilder::InsertionGuard guard(builder); |
| 878 | Region *thenRegion = result.addRegion(); |
| 879 | builder.createBlock(parent: thenRegion); |
| 880 | |
| 881 | // Build else region. |
| 882 | Region *elseRegion = result.addRegion(); |
| 883 | if (withElseRegion) { |
| 884 | builder.createBlock(parent: elseRegion); |
| 885 | } |
| 886 | } |
| 887 | |
| 888 | void IfOp::build(OpBuilder &builder, OperationState &result, Value cond, |
| 889 | function_ref<void(OpBuilder &, Location)> thenBuilder, |
| 890 | function_ref<void(OpBuilder &, Location)> elseBuilder) { |
| 891 | assert(thenBuilder && "the builder callback for 'then' must be present" ); |
| 892 | result.addOperands(newOperands: cond); |
| 893 | |
| 894 | // Build then region. |
| 895 | OpBuilder::InsertionGuard guard(builder); |
| 896 | Region *thenRegion = result.addRegion(); |
| 897 | builder.createBlock(parent: thenRegion); |
| 898 | thenBuilder(builder, result.location); |
| 899 | |
| 900 | // Build else region. |
| 901 | Region *elseRegion = result.addRegion(); |
| 902 | if (elseBuilder) { |
| 903 | builder.createBlock(parent: elseRegion); |
| 904 | elseBuilder(builder, result.location); |
| 905 | } |
| 906 | } |
| 907 | |
| 908 | ParseResult IfOp::parse(OpAsmParser &parser, OperationState &result) { |
| 909 | // Create the regions for 'then'. |
| 910 | result.regions.reserve(N: 2); |
| 911 | Region *thenRegion = result.addRegion(); |
| 912 | Region *elseRegion = result.addRegion(); |
| 913 | |
| 914 | Builder &builder = parser.getBuilder(); |
| 915 | OpAsmParser::UnresolvedOperand cond; |
| 916 | Type i1Type = builder.getIntegerType(width: 1); |
| 917 | if (parser.parseOperand(result&: cond) || |
| 918 | parser.resolveOperand(operand: cond, type: i1Type, result&: result.operands)) |
| 919 | return failure(); |
| 920 | // Parse the 'then' region. |
| 921 | if (parser.parseRegion(region&: *thenRegion, /*arguments=*/{}, /*argTypes=*/enableNameShadowing: {})) |
| 922 | return failure(); |
| 923 | IfOp::ensureTerminator(region&: *thenRegion, builder&: parser.getBuilder(), loc: result.location); |
| 924 | |
| 925 | // If we find an 'else' keyword then parse the 'else' region. |
| 926 | if (!parser.parseOptionalKeyword(keyword: "else" )) { |
| 927 | if (parser.parseRegion(region&: *elseRegion, /*arguments=*/{}, /*argTypes=*/enableNameShadowing: {})) |
| 928 | return failure(); |
| 929 | IfOp::ensureTerminator(region&: *elseRegion, builder&: parser.getBuilder(), loc: result.location); |
| 930 | } |
| 931 | |
| 932 | // Parse the optional attribute list. |
| 933 | if (parser.parseOptionalAttrDict(result&: result.attributes)) |
| 934 | return failure(); |
| 935 | return success(); |
| 936 | } |
| 937 | |
| 938 | void IfOp::print(OpAsmPrinter &p) { |
| 939 | bool printBlockTerminators = false; |
| 940 | |
| 941 | p << " " << getCondition(); |
| 942 | p << ' '; |
| 943 | p.printRegion(blocks&: getThenRegion(), |
| 944 | /*printEntryBlockArgs=*/false, |
| 945 | /*printBlockTerminators=*/printBlockTerminators); |
| 946 | |
| 947 | // Print the 'else' regions if it exists and has a block. |
| 948 | Region &elseRegion = getElseRegion(); |
| 949 | if (!elseRegion.empty()) { |
| 950 | p << " else " ; |
| 951 | p.printRegion(blocks&: elseRegion, |
| 952 | /*printEntryBlockArgs=*/false, |
| 953 | /*printBlockTerminators=*/printBlockTerminators); |
| 954 | } |
| 955 | |
| 956 | p.printOptionalAttrDict(attrs: (*this)->getDiscardableAttrDictionary().getValue()); |
| 957 | } |
| 958 | |
| 959 | /// Given the region at `index`, or the parent operation if `index` is None, |
| 960 | /// return the successor regions. These are the regions that may be selected |
| 961 | /// during the flow of control. `operands` is a set of optional attributes |
| 962 | /// that correspond to a constant value for each operand, or null if that |
| 963 | /// operand is not a constant. |
| 964 | void IfOp::getSuccessorRegions(RegionBranchPoint point, |
| 965 | SmallVectorImpl<RegionSuccessor> ®ions) { |
| 966 | // The `then` and the `else` region branch back to the parent operation. |
| 967 | if (!point.isParent()) { |
| 968 | regions.push_back(Elt: RegionSuccessor(getOperation())); |
| 969 | return; |
| 970 | } |
| 971 | |
| 972 | regions.push_back(Elt: RegionSuccessor(&getThenRegion())); |
| 973 | |
| 974 | // Don't consider the else region if it is empty. |
| 975 | Region *elseRegion = &this->getElseRegion(); |
| 976 | if (elseRegion->empty()) |
| 977 | regions.push_back(Elt: RegionSuccessor(getOperation())); |
| 978 | else |
| 979 | regions.push_back(Elt: RegionSuccessor(elseRegion)); |
| 980 | } |
| 981 | |
| 982 | ValueRange IfOp::getSuccessorInputs(RegionSuccessor successor) { |
| 983 | return successor.isOperation() ? ValueRange(getOperation()->getResults()) |
| 984 | : ValueRange(); |
| 985 | } |
| 986 | |
| 987 | void IfOp::getEntrySuccessorRegions(ArrayRef<Attribute> operands, |
| 988 | SmallVectorImpl<RegionSuccessor> ®ions) { |
| 989 | FoldAdaptor adaptor(operands, *this); |
| 990 | auto boolAttr = dyn_cast_or_null<BoolAttr>(Val: adaptor.getCondition()); |
| 991 | if (!boolAttr || boolAttr.getValue()) |
| 992 | regions.emplace_back(Args: &getThenRegion()); |
| 993 | |
| 994 | // If the else region is empty, execution continues after the parent op. |
| 995 | if (!boolAttr || !boolAttr.getValue()) { |
| 996 | if (!getElseRegion().empty()) |
| 997 | regions.emplace_back(Args: &getElseRegion()); |
| 998 | else |
| 999 | regions.emplace_back(Args: RegionSuccessor(getOperation())); |
| 1000 | } |
| 1001 | } |
| 1002 | |
| 1003 | void IfOp::getRegionInvocationBounds( |
| 1004 | ArrayRef<Attribute> operands, |
| 1005 | SmallVectorImpl<InvocationBounds> &invocationBounds) { |
| 1006 | if (auto cond = llvm::dyn_cast_or_null<BoolAttr>(Val: operands[0])) { |
| 1007 | // If the condition is known, then one region is known to be executed once |
| 1008 | // and the other zero times. |
| 1009 | invocationBounds.emplace_back(Args: 0, Args: cond.getValue() ? 1 : 0); |
| 1010 | invocationBounds.emplace_back(Args: 0, Args: cond.getValue() ? 0 : 1); |
| 1011 | } else { |
| 1012 | // Non-constant condition. Each region may be executed 0 or 1 times. |
| 1013 | invocationBounds.assign(NumElts: 2, Elt: {0, 1}); |
| 1014 | } |
| 1015 | } |
| 1016 | |
| 1017 | //===----------------------------------------------------------------------===// |
| 1018 | // IncludeOp |
| 1019 | //===----------------------------------------------------------------------===// |
| 1020 | |
| 1021 | void IncludeOp::print(OpAsmPrinter &p) { |
| 1022 | bool standardInclude = getIsStandardInclude(); |
| 1023 | |
| 1024 | p << " " ; |
| 1025 | if (standardInclude) |
| 1026 | p << "<" ; |
| 1027 | p << "\"" << getInclude() << "\"" ; |
| 1028 | if (standardInclude) |
| 1029 | p << ">" ; |
| 1030 | } |
| 1031 | |
| 1032 | ParseResult IncludeOp::parse(OpAsmParser &parser, OperationState &result) { |
| 1033 | bool standardInclude = !parser.parseOptionalLess(); |
| 1034 | |
| 1035 | StringAttr include; |
| 1036 | OptionalParseResult includeParseResult = |
| 1037 | parser.parseOptionalAttribute(result&: include, attrName: "include" , attrs&: result.attributes); |
| 1038 | if (!includeParseResult.has_value()) |
| 1039 | return parser.emitError(loc: parser.getNameLoc()) << "expected string attribute" ; |
| 1040 | |
| 1041 | if (standardInclude && parser.parseOptionalGreater()) |
| 1042 | return parser.emitError(loc: parser.getNameLoc()) |
| 1043 | << "expected trailing '>' for standard include" ; |
| 1044 | |
| 1045 | if (standardInclude) |
| 1046 | result.addAttribute(name: "is_standard_include" , |
| 1047 | attr: UnitAttr::get(context: parser.getContext())); |
| 1048 | |
| 1049 | return success(); |
| 1050 | } |
| 1051 | |
| 1052 | //===----------------------------------------------------------------------===// |
| 1053 | // LiteralOp |
| 1054 | //===----------------------------------------------------------------------===// |
| 1055 | |
| 1056 | /// The literal op requires a non-empty value. |
| 1057 | LogicalResult emitc::LiteralOp::verify() { |
| 1058 | if (getValue().empty()) |
| 1059 | return emitOpError() << "value must not be empty" ; |
| 1060 | return success(); |
| 1061 | } |
| 1062 | |
| 1063 | //===----------------------------------------------------------------------===// |
| 1064 | // MemberOp |
| 1065 | //===----------------------------------------------------------------------===// |
| 1066 | |
| 1067 | LogicalResult MemberOp::verify() { |
| 1068 | Type operandType = getOperand().getType(); |
| 1069 | Type resultType = getResult().getType(); |
| 1070 | bool resultIsWritable = isa<emitc::LValueType, emitc::ArrayType>(Val: resultType); |
| 1071 | |
| 1072 | // Make sure the operand and return type agree on value/memory semantics: |
| 1073 | // If the operand is an lvalue it models a memory location and as such its |
| 1074 | // elements are also memory locations: They require a load operation to use |
| 1075 | // their value and they can be assigned new values. |
| 1076 | // If the operand isn't an lvalue it models an aggregate SSA value and as |
| 1077 | // such its elements are also SSA values: Their value can be used directly |
| 1078 | // but they cannot be assigned to. |
| 1079 | |
| 1080 | if (isa<emitc::LValueType>(Val: operandType) && !resultIsWritable) |
| 1081 | return emitOpError(message: "lvalues must return lvalues or arrays" ); |
| 1082 | |
| 1083 | if (!isa<emitc::LValueType>(Val: operandType) && resultIsWritable) |
| 1084 | return emitOpError(message: "non-lvalues cannot return lvalues or arrays" ); |
| 1085 | |
| 1086 | return success(); |
| 1087 | } |
| 1088 | |
| 1089 | //===----------------------------------------------------------------------===// |
| 1090 | // SubOp |
| 1091 | //===----------------------------------------------------------------------===// |
| 1092 | |
| 1093 | LogicalResult SubOp::verify() { |
| 1094 | Type lhsType = getLhs().getType(); |
| 1095 | Type rhsType = getRhs().getType(); |
| 1096 | Type resultType = getResult().getType(); |
| 1097 | |
| 1098 | if (isa<emitc::PointerType>(Val: rhsType) && !isa<emitc::PointerType>(Val: lhsType)) |
| 1099 | return emitOpError(message: "rhs can only be a pointer if lhs is a pointer" ); |
| 1100 | |
| 1101 | if (isa<emitc::PointerType>(Val: lhsType) && |
| 1102 | !isa<IntegerType, emitc::OpaqueType, emitc::PointerType>(Val: rhsType)) |
| 1103 | return emitOpError(message: "requires that rhs is an integer, pointer or of opaque " |
| 1104 | "type if lhs is a pointer" ); |
| 1105 | |
| 1106 | if (isa<emitc::PointerType>(Val: lhsType) && isa<emitc::PointerType>(Val: rhsType) && |
| 1107 | !isa<IntegerType, emitc::PtrDiffTType, emitc::OpaqueType>(Val: resultType)) |
| 1108 | return emitOpError(message: "requires that the result is an integer, ptrdiff_t or " |
| 1109 | "of opaque type if lhs and rhs are pointers" ); |
| 1110 | return success(); |
| 1111 | } |
| 1112 | |
| 1113 | //===----------------------------------------------------------------------===// |
| 1114 | // VariableOp |
| 1115 | //===----------------------------------------------------------------------===// |
| 1116 | |
| 1117 | LogicalResult emitc::VariableOp::verify() { |
| 1118 | return verifyInitializationAttribute(op: getOperation(), value: getValueAttr()); |
| 1119 | } |
| 1120 | |
| 1121 | //===----------------------------------------------------------------------===// |
| 1122 | // YieldOp |
| 1123 | //===----------------------------------------------------------------------===// |
| 1124 | |
| 1125 | LogicalResult emitc::YieldOp::verify() { |
| 1126 | Value result = getResult(); |
| 1127 | Operation *containingOp = getOperation()->getParentOp(); |
| 1128 | |
| 1129 | if (!isa<DoOp>(Val: containingOp) && result && containingOp->getNumResults() != 1) |
| 1130 | return emitOpError() << "yields a value not returned by parent" ; |
| 1131 | |
| 1132 | if (!isa<DoOp>(Val: containingOp) && !result && containingOp->getNumResults() != 0) |
| 1133 | return emitOpError() << "does not yield a value to be returned by parent" ; |
| 1134 | |
| 1135 | if (result && isa<emitc::LValueType>(Val: result.getType()) && |
| 1136 | !isa<ExpressionOp>(Val: containingOp)) |
| 1137 | return emitOpError() << "yielding lvalues is not supported for this op" ; |
| 1138 | |
| 1139 | return success(); |
| 1140 | } |
| 1141 | |
| 1142 | //===----------------------------------------------------------------------===// |
| 1143 | // SubscriptOp |
| 1144 | //===----------------------------------------------------------------------===// |
| 1145 | |
| 1146 | LogicalResult emitc::SubscriptOp::verify() { |
| 1147 | // Checks for array operand. |
| 1148 | if (auto arrayType = llvm::dyn_cast<emitc::ArrayType>(Val: getValue().getType())) { |
| 1149 | // Check number of indices. |
| 1150 | if (getIndices().size() != (size_t)arrayType.getRank()) { |
| 1151 | return emitOpError() << "on array operand requires number of indices (" |
| 1152 | << getIndices().size() |
| 1153 | << ") to match the rank of the array type (" |
| 1154 | << arrayType.getRank() << ")" ; |
| 1155 | } |
| 1156 | // Check types of index operands. |
| 1157 | for (unsigned i = 0, e = getIndices().size(); i != e; ++i) { |
| 1158 | Type type = getIndices()[i].getType(); |
| 1159 | if (!isIntegerIndexOrOpaqueType(type)) { |
| 1160 | return emitOpError() << "on array operand requires index operand " << i |
| 1161 | << " to be integer-like, but got " << type; |
| 1162 | } |
| 1163 | } |
| 1164 | // Check element type. |
| 1165 | Type elementType = arrayType.getElementType(); |
| 1166 | Type resultType = getType().getValueType(); |
| 1167 | if (elementType != resultType) { |
| 1168 | return emitOpError() << "on array operand requires element type (" |
| 1169 | << elementType << ") and result type (" << resultType |
| 1170 | << ") to match" ; |
| 1171 | } |
| 1172 | return success(); |
| 1173 | } |
| 1174 | |
| 1175 | // Checks for pointer operand. |
| 1176 | if (auto pointerType = |
| 1177 | llvm::dyn_cast<emitc::PointerType>(Val: getValue().getType())) { |
| 1178 | // Check number of indices. |
| 1179 | if (getIndices().size() != 1) { |
| 1180 | return emitOpError() |
| 1181 | << "on pointer operand requires one index operand, but got " |
| 1182 | << getIndices().size(); |
| 1183 | } |
| 1184 | // Check types of index operand. |
| 1185 | Type type = getIndices()[0].getType(); |
| 1186 | if (!isIntegerIndexOrOpaqueType(type)) { |
| 1187 | return emitOpError() << "on pointer operand requires index operand to be " |
| 1188 | "integer-like, but got " |
| 1189 | << type; |
| 1190 | } |
| 1191 | // Check pointee type. |
| 1192 | Type pointeeType = pointerType.getPointee(); |
| 1193 | Type resultType = getType().getValueType(); |
| 1194 | if (pointeeType != resultType) { |
| 1195 | return emitOpError() << "on pointer operand requires pointee type (" |
| 1196 | << pointeeType << ") and result type (" << resultType |
| 1197 | << ") to match" ; |
| 1198 | } |
| 1199 | return success(); |
| 1200 | } |
| 1201 | |
| 1202 | // The operand has opaque type, so we can't assume anything about the number |
| 1203 | // or types of index operands. |
| 1204 | return success(); |
| 1205 | } |
| 1206 | |
| 1207 | //===----------------------------------------------------------------------===// |
| 1208 | // VerbatimOp |
| 1209 | //===----------------------------------------------------------------------===// |
| 1210 | |
| 1211 | LogicalResult emitc::VerbatimOp::verify() { |
| 1212 | auto errorCallback = [&]() -> InFlightDiagnostic { |
| 1213 | return this->emitOpError(); |
| 1214 | }; |
| 1215 | FailureOr<SmallVector<ReplacementItem>> fmt = |
| 1216 | ::parseFormatString(toParse: getValue(), fmtArgs: getFmtArgs(), emitError: errorCallback); |
| 1217 | if (failed(Result: fmt)) |
| 1218 | return failure(); |
| 1219 | |
| 1220 | size_t numPlaceholders = llvm::count_if(Range&: *fmt, P: [](ReplacementItem &item) { |
| 1221 | return std::holds_alternative<Placeholder>(v: item); |
| 1222 | }); |
| 1223 | |
| 1224 | if (numPlaceholders != getFmtArgs().size()) { |
| 1225 | return emitOpError() |
| 1226 | << "requires operands for each placeholder in the format string" ; |
| 1227 | } |
| 1228 | return success(); |
| 1229 | } |
| 1230 | |
| 1231 | FailureOr<SmallVector<ReplacementItem>> emitc::VerbatimOp::parseFormatString() { |
| 1232 | // Error checking is done in verify. |
| 1233 | return ::parseFormatString(toParse: getValue(), fmtArgs: getFmtArgs()); |
| 1234 | } |
| 1235 | |
| 1236 | //===----------------------------------------------------------------------===// |
| 1237 | // EmitC Enums |
| 1238 | //===----------------------------------------------------------------------===// |
| 1239 | |
| 1240 | #include "mlir/Dialect/EmitC/IR/EmitCEnums.cpp.inc" |
| 1241 | |
| 1242 | //===----------------------------------------------------------------------===// |
| 1243 | // EmitC Attributes |
| 1244 | //===----------------------------------------------------------------------===// |
| 1245 | |
| 1246 | #define GET_ATTRDEF_CLASSES |
| 1247 | #include "mlir/Dialect/EmitC/IR/EmitCAttributes.cpp.inc" |
| 1248 | |
| 1249 | //===----------------------------------------------------------------------===// |
| 1250 | // EmitC Types |
| 1251 | //===----------------------------------------------------------------------===// |
| 1252 | |
| 1253 | #define GET_TYPEDEF_CLASSES |
| 1254 | #include "mlir/Dialect/EmitC/IR/EmitCTypes.cpp.inc" |
| 1255 | |
| 1256 | //===----------------------------------------------------------------------===// |
| 1257 | // ArrayType |
| 1258 | //===----------------------------------------------------------------------===// |
| 1259 | |
| 1260 | Type emitc::ArrayType::parse(AsmParser &parser) { |
| 1261 | if (parser.parseLess()) |
| 1262 | return Type(); |
| 1263 | |
| 1264 | SmallVector<int64_t, 4> dimensions; |
| 1265 | if (parser.parseDimensionList(dimensions, /*allowDynamic=*/false, |
| 1266 | /*withTrailingX=*/true)) |
| 1267 | return Type(); |
| 1268 | // Parse the element type. |
| 1269 | auto typeLoc = parser.getCurrentLocation(); |
| 1270 | Type elementType; |
| 1271 | if (parser.parseType(result&: elementType)) |
| 1272 | return Type(); |
| 1273 | |
| 1274 | // Check that array is formed from allowed types. |
| 1275 | if (!isValidElementType(type: elementType)) |
| 1276 | return parser.emitError(loc: typeLoc, message: "invalid array element type '" ) |
| 1277 | << elementType << "'" , |
| 1278 | Type(); |
| 1279 | if (parser.parseGreater()) |
| 1280 | return Type(); |
| 1281 | return parser.getChecked<ArrayType>(params&: dimensions, params&: elementType); |
| 1282 | } |
| 1283 | |
| 1284 | void emitc::ArrayType::print(AsmPrinter &printer) const { |
| 1285 | printer << "<" ; |
| 1286 | for (int64_t dim : getShape()) { |
| 1287 | printer << dim << 'x'; |
| 1288 | } |
| 1289 | printer.printType(type: getElementType()); |
| 1290 | printer << ">" ; |
| 1291 | } |
| 1292 | |
| 1293 | LogicalResult emitc::ArrayType::verify( |
| 1294 | ::llvm::function_ref<::mlir::InFlightDiagnostic()> emitError, |
| 1295 | ::llvm::ArrayRef<int64_t> shape, Type elementType) { |
| 1296 | if (shape.empty()) |
| 1297 | return emitError() << "shape must not be empty" ; |
| 1298 | |
| 1299 | for (int64_t dim : shape) { |
| 1300 | if (dim < 0) |
| 1301 | return emitError() << "dimensions must have non-negative size" ; |
| 1302 | } |
| 1303 | |
| 1304 | if (!elementType) |
| 1305 | return emitError() << "element type must not be none" ; |
| 1306 | |
| 1307 | if (!isValidElementType(type: elementType)) |
| 1308 | return emitError() << "invalid array element type" ; |
| 1309 | |
| 1310 | return success(); |
| 1311 | } |
| 1312 | |
| 1313 | emitc::ArrayType |
| 1314 | emitc::ArrayType::cloneWith(std::optional<ArrayRef<int64_t>> shape, |
| 1315 | Type elementType) const { |
| 1316 | if (!shape) |
| 1317 | return emitc::ArrayType::get(shape: getShape(), elementType); |
| 1318 | return emitc::ArrayType::get(shape: *shape, elementType); |
| 1319 | } |
| 1320 | |
| 1321 | //===----------------------------------------------------------------------===// |
| 1322 | // LValueType |
| 1323 | //===----------------------------------------------------------------------===// |
| 1324 | |
| 1325 | LogicalResult mlir::emitc::LValueType::verify( |
| 1326 | llvm::function_ref<mlir::InFlightDiagnostic()> emitError, |
| 1327 | mlir::Type value) { |
| 1328 | // Check that the wrapped type is valid. This especially forbids nested |
| 1329 | // lvalue types. |
| 1330 | if (!isSupportedEmitCType(type: value)) |
| 1331 | return emitError() |
| 1332 | << "!emitc.lvalue must wrap supported emitc type, but got " << value; |
| 1333 | |
| 1334 | if (llvm::isa<emitc::ArrayType>(Val: value)) |
| 1335 | return emitError() << "!emitc.lvalue cannot wrap !emitc.array type" ; |
| 1336 | |
| 1337 | return success(); |
| 1338 | } |
| 1339 | |
| 1340 | //===----------------------------------------------------------------------===// |
| 1341 | // OpaqueType |
| 1342 | //===----------------------------------------------------------------------===// |
| 1343 | |
| 1344 | LogicalResult mlir::emitc::OpaqueType::verify( |
| 1345 | llvm::function_ref<mlir::InFlightDiagnostic()> emitError, |
| 1346 | llvm::StringRef value) { |
| 1347 | if (value.empty()) { |
| 1348 | return emitError() << "expected non empty string in !emitc.opaque type" ; |
| 1349 | } |
| 1350 | if (value.back() == '*') { |
| 1351 | return emitError() << "pointer not allowed as outer type with " |
| 1352 | "!emitc.opaque, use !emitc.ptr instead" ; |
| 1353 | } |
| 1354 | return success(); |
| 1355 | } |
| 1356 | |
| 1357 | //===----------------------------------------------------------------------===// |
| 1358 | // PointerType |
| 1359 | //===----------------------------------------------------------------------===// |
| 1360 | |
| 1361 | LogicalResult mlir::emitc::PointerType::verify( |
| 1362 | llvm::function_ref<mlir::InFlightDiagnostic()> emitError, Type value) { |
| 1363 | if (llvm::isa<emitc::LValueType>(Val: value)) |
| 1364 | return emitError() << "pointers to lvalues are not allowed" ; |
| 1365 | |
| 1366 | return success(); |
| 1367 | } |
| 1368 | |
| 1369 | //===----------------------------------------------------------------------===// |
| 1370 | // GlobalOp |
| 1371 | //===----------------------------------------------------------------------===// |
| 1372 | static void printEmitCGlobalOpTypeAndInitialValue(OpAsmPrinter &p, GlobalOp op, |
| 1373 | TypeAttr type, |
| 1374 | Attribute initialValue) { |
| 1375 | p << type; |
| 1376 | if (initialValue) { |
| 1377 | p << " = " ; |
| 1378 | p.printAttributeWithoutType(attr: initialValue); |
| 1379 | } |
| 1380 | } |
| 1381 | |
| 1382 | static Type getInitializerTypeForGlobal(Type type) { |
| 1383 | if (auto array = llvm::dyn_cast<ArrayType>(Val&: type)) |
| 1384 | return RankedTensorType::get(shape: array.getShape(), elementType: array.getElementType()); |
| 1385 | return type; |
| 1386 | } |
| 1387 | |
| 1388 | static ParseResult |
| 1389 | parseEmitCGlobalOpTypeAndInitialValue(OpAsmParser &parser, TypeAttr &typeAttr, |
| 1390 | Attribute &initialValue) { |
| 1391 | Type type; |
| 1392 | if (parser.parseType(result&: type)) |
| 1393 | return failure(); |
| 1394 | |
| 1395 | typeAttr = TypeAttr::get(type); |
| 1396 | |
| 1397 | if (parser.parseOptionalEqual()) |
| 1398 | return success(); |
| 1399 | |
| 1400 | if (parser.parseAttribute(result&: initialValue, type: getInitializerTypeForGlobal(type))) |
| 1401 | return failure(); |
| 1402 | |
| 1403 | if (!llvm::isa<ElementsAttr, IntegerAttr, FloatAttr, emitc::OpaqueAttr>( |
| 1404 | Val: initialValue)) |
| 1405 | return parser.emitError(loc: parser.getNameLoc()) |
| 1406 | << "initial value should be a integer, float, elements or opaque " |
| 1407 | "attribute" ; |
| 1408 | return success(); |
| 1409 | } |
| 1410 | |
| 1411 | LogicalResult GlobalOp::verify() { |
| 1412 | if (!isSupportedEmitCType(type: getType())) { |
| 1413 | return emitOpError(message: "expected valid emitc type" ); |
| 1414 | } |
| 1415 | if (getInitialValue().has_value()) { |
| 1416 | Attribute initValue = getInitialValue().value(); |
| 1417 | // Check that the type of the initial value is compatible with the type of |
| 1418 | // the global variable. |
| 1419 | if (auto elementsAttr = llvm::dyn_cast<ElementsAttr>(Val&: initValue)) { |
| 1420 | auto arrayType = llvm::dyn_cast<ArrayType>(Val: getType()); |
| 1421 | if (!arrayType) |
| 1422 | return emitOpError(message: "expected array type, but got " ) << getType(); |
| 1423 | |
| 1424 | Type initType = elementsAttr.getType(); |
| 1425 | Type tensorType = getInitializerTypeForGlobal(type: getType()); |
| 1426 | if (initType != tensorType) { |
| 1427 | return emitOpError(message: "initial value expected to be of type " ) |
| 1428 | << getType() << ", but was of type " << initType; |
| 1429 | } |
| 1430 | } else if (auto intAttr = dyn_cast<IntegerAttr>(Val&: initValue)) { |
| 1431 | if (intAttr.getType() != getType()) { |
| 1432 | return emitOpError(message: "initial value expected to be of type " ) |
| 1433 | << getType() << ", but was of type " << intAttr.getType(); |
| 1434 | } |
| 1435 | } else if (auto floatAttr = dyn_cast<FloatAttr>(Val&: initValue)) { |
| 1436 | if (floatAttr.getType() != getType()) { |
| 1437 | return emitOpError(message: "initial value expected to be of type " ) |
| 1438 | << getType() << ", but was of type " << floatAttr.getType(); |
| 1439 | } |
| 1440 | } else if (!isa<emitc::OpaqueAttr>(Val: initValue)) { |
| 1441 | return emitOpError(message: "initial value should be a integer, float, elements " |
| 1442 | "or opaque attribute, but got " ) |
| 1443 | << initValue; |
| 1444 | } |
| 1445 | } |
| 1446 | if (getStaticSpecifier() && getExternSpecifier()) { |
| 1447 | return emitOpError(message: "cannot have both static and extern specifiers" ); |
| 1448 | } |
| 1449 | return success(); |
| 1450 | } |
| 1451 | |
| 1452 | //===----------------------------------------------------------------------===// |
| 1453 | // GetGlobalOp |
| 1454 | //===----------------------------------------------------------------------===// |
| 1455 | |
| 1456 | LogicalResult |
| 1457 | GetGlobalOp::verifySymbolUses(SymbolTableCollection &symbolTable) { |
| 1458 | // Verify that the type matches the type of the global variable. |
| 1459 | auto global = |
| 1460 | symbolTable.lookupNearestSymbolFrom<GlobalOp>(from: *this, symbol: getNameAttr()); |
| 1461 | if (!global) |
| 1462 | return emitOpError(message: "'" ) |
| 1463 | << getName() << "' does not reference a valid emitc.global" ; |
| 1464 | |
| 1465 | Type resultType = getResult().getType(); |
| 1466 | Type globalType = global.getType(); |
| 1467 | |
| 1468 | // global has array type |
| 1469 | if (llvm::isa<ArrayType>(Val: globalType)) { |
| 1470 | if (globalType != resultType) |
| 1471 | return emitOpError(message: "on array type expects result type " ) |
| 1472 | << resultType << " to match type " << globalType |
| 1473 | << " of the global @" << getName(); |
| 1474 | return success(); |
| 1475 | } |
| 1476 | |
| 1477 | // global has non-array type |
| 1478 | auto lvalueType = dyn_cast<LValueType>(Val&: resultType); |
| 1479 | if (!lvalueType) |
| 1480 | return emitOpError(message: "on non-array type expects result type to be an " |
| 1481 | "lvalue type for the global @" ) |
| 1482 | << getName(); |
| 1483 | if (lvalueType.getValueType() != globalType) |
| 1484 | return emitOpError(message: "on non-array type expects result inner type " ) |
| 1485 | << lvalueType.getValueType() << " to match type " << globalType |
| 1486 | << " of the global @" << getName(); |
| 1487 | return success(); |
| 1488 | } |
| 1489 | |
| 1490 | //===----------------------------------------------------------------------===// |
| 1491 | // SwitchOp |
| 1492 | //===----------------------------------------------------------------------===// |
| 1493 | |
| 1494 | /// Parse the case regions and values. |
| 1495 | static ParseResult |
| 1496 | parseSwitchCases(OpAsmParser &parser, DenseI64ArrayAttr &cases, |
| 1497 | SmallVectorImpl<std::unique_ptr<Region>> &caseRegions) { |
| 1498 | SmallVector<int64_t> caseValues; |
| 1499 | while (succeeded(Result: parser.parseOptionalKeyword(keyword: "case" ))) { |
| 1500 | int64_t value; |
| 1501 | Region ®ion = *caseRegions.emplace_back(Args: std::make_unique<Region>()); |
| 1502 | if (parser.parseInteger(result&: value) || |
| 1503 | parser.parseRegion(region, /*arguments=*/{})) |
| 1504 | return failure(); |
| 1505 | caseValues.push_back(Elt: value); |
| 1506 | } |
| 1507 | cases = parser.getBuilder().getDenseI64ArrayAttr(values: caseValues); |
| 1508 | return success(); |
| 1509 | } |
| 1510 | |
| 1511 | /// Print the case regions and values. |
| 1512 | static void printSwitchCases(OpAsmPrinter &p, Operation *op, |
| 1513 | DenseI64ArrayAttr cases, RegionRange caseRegions) { |
| 1514 | for (auto [value, region] : llvm::zip(t: cases.asArrayRef(), u&: caseRegions)) { |
| 1515 | p.printNewline(); |
| 1516 | p << "case " << value << ' '; |
| 1517 | p.printRegion(blocks&: *region, /*printEntryBlockArgs=*/false); |
| 1518 | } |
| 1519 | } |
| 1520 | |
| 1521 | static LogicalResult verifyRegion(emitc::SwitchOp op, Region ®ion, |
| 1522 | const Twine &name) { |
| 1523 | auto yield = dyn_cast<emitc::YieldOp>(Val&: region.front().back()); |
| 1524 | if (!yield) |
| 1525 | return op.emitOpError(message: "expected region to end with emitc.yield, but got " ) |
| 1526 | << region.front().back().getName(); |
| 1527 | |
| 1528 | if (yield.getNumOperands() != 0) { |
| 1529 | return (op.emitOpError(message: "expected each region to return " ) |
| 1530 | << "0 values, but " << name << " returns " |
| 1531 | << yield.getNumOperands()) |
| 1532 | .attachNote(noteLoc: yield.getLoc()) |
| 1533 | << "see yield operation here" ; |
| 1534 | } |
| 1535 | |
| 1536 | return success(); |
| 1537 | } |
| 1538 | |
| 1539 | LogicalResult emitc::SwitchOp::verify() { |
| 1540 | if (!isIntegerIndexOrOpaqueType(type: getArg().getType())) |
| 1541 | return emitOpError(message: "unsupported type " ) << getArg().getType(); |
| 1542 | |
| 1543 | if (getCases().size() != getCaseRegions().size()) { |
| 1544 | return emitOpError(message: "has " ) |
| 1545 | << getCaseRegions().size() << " case regions but " |
| 1546 | << getCases().size() << " case values" ; |
| 1547 | } |
| 1548 | |
| 1549 | DenseSet<int64_t> valueSet; |
| 1550 | for (int64_t value : getCases()) |
| 1551 | if (!valueSet.insert(V: value).second) |
| 1552 | return emitOpError(message: "has duplicate case value: " ) << value; |
| 1553 | |
| 1554 | if (failed(Result: verifyRegion(op: *this, region&: getDefaultRegion(), name: "default region" ))) |
| 1555 | return failure(); |
| 1556 | |
| 1557 | for (auto [idx, caseRegion] : llvm::enumerate(First: getCaseRegions())) |
| 1558 | if (failed(Result: verifyRegion(op: *this, region&: caseRegion, name: "case region #" + Twine(idx)))) |
| 1559 | return failure(); |
| 1560 | |
| 1561 | return success(); |
| 1562 | } |
| 1563 | |
| 1564 | unsigned emitc::SwitchOp::getNumCases() { return getCases().size(); } |
| 1565 | |
| 1566 | Block &emitc::SwitchOp::getDefaultBlock() { return getDefaultRegion().front(); } |
| 1567 | |
| 1568 | Block &emitc::SwitchOp::getCaseBlock(unsigned idx) { |
| 1569 | assert(idx < getNumCases() && "case index out-of-bounds" ); |
| 1570 | return getCaseRegions()[idx].front(); |
| 1571 | } |
| 1572 | |
| 1573 | void SwitchOp::getSuccessorRegions( |
| 1574 | RegionBranchPoint point, SmallVectorImpl<RegionSuccessor> &successors) { |
| 1575 | llvm::append_range(C&: successors, R: getRegions()); |
| 1576 | } |
| 1577 | |
| 1578 | /// Returns the int64_t value of an IntegerAttr regardless of whether its type |
| 1579 | /// is signless, signed, or unsigned. Returns std::nullopt for unknown types. |
| 1580 | static std::optional<int64_t> getIntAttrValue(IntegerAttr attr) { |
| 1581 | Type type = attr.getType(); |
| 1582 | if (type.isIndex() || type.isSignlessInteger()) |
| 1583 | return attr.getInt(); |
| 1584 | if (type.isSignedInteger()) |
| 1585 | return attr.getSInt(); |
| 1586 | if (type.isUnsignedInteger()) |
| 1587 | return static_cast<int64_t>(attr.getUInt()); |
| 1588 | return std::nullopt; |
| 1589 | } |
| 1590 | |
| 1591 | void SwitchOp::getEntrySuccessorRegions( |
| 1592 | ArrayRef<Attribute> operands, |
| 1593 | SmallVectorImpl<RegionSuccessor> &successors) { |
| 1594 | FoldAdaptor adaptor(operands, *this); |
| 1595 | |
| 1596 | // If a constant was not provided, all regions are possible successors. |
| 1597 | auto arg = dyn_cast_or_null<IntegerAttr>(Val: adaptor.getArg()); |
| 1598 | if (!arg) { |
| 1599 | llvm::append_range(C&: successors, R: getRegions()); |
| 1600 | return; |
| 1601 | } |
| 1602 | |
| 1603 | std::optional<int64_t> argValue = getIntAttrValue(attr: arg); |
| 1604 | if (!argValue) { |
| 1605 | // Unknown type; conservatively treat all regions as possible. |
| 1606 | llvm::append_range(C&: successors, R: getRegions()); |
| 1607 | return; |
| 1608 | } |
| 1609 | |
| 1610 | // Otherwise, try to find a case with a matching value. If not, the |
| 1611 | // default region is the only successor. |
| 1612 | for (auto [caseValue, caseRegion] : llvm::zip(t: getCases(), u: getCaseRegions())) { |
| 1613 | if (caseValue == *argValue) { |
| 1614 | successors.emplace_back(Args: &caseRegion); |
| 1615 | return; |
| 1616 | } |
| 1617 | } |
| 1618 | successors.emplace_back(Args: &getDefaultRegion()); |
| 1619 | } |
| 1620 | |
| 1621 | void SwitchOp::getRegionInvocationBounds( |
| 1622 | ArrayRef<Attribute> operands, SmallVectorImpl<InvocationBounds> &bounds) { |
| 1623 | auto operandValue = llvm::dyn_cast_or_null<IntegerAttr>(Val: operands.front()); |
| 1624 | if (!operandValue) { |
| 1625 | // All regions are invoked at most once. |
| 1626 | bounds.append(NumInputs: getNumRegions(), Elt: InvocationBounds(/*lb=*/0, /*ub=*/1)); |
| 1627 | return; |
| 1628 | } |
| 1629 | |
| 1630 | std::optional<int64_t> maybeIntValue = getIntAttrValue(attr: operandValue); |
| 1631 | if (!maybeIntValue) { |
| 1632 | // Unknown type; conservatively treat all regions as possible. |
| 1633 | bounds.append(NumInputs: getNumRegions(), Elt: InvocationBounds(/*lb=*/0, /*ub=*/1)); |
| 1634 | return; |
| 1635 | } |
| 1636 | |
| 1637 | unsigned liveIndex = getNumRegions() - 1; |
| 1638 | const auto *iteratorToInt = llvm::find(Range: getCases(), Val: *maybeIntValue); |
| 1639 | |
| 1640 | liveIndex = iteratorToInt != getCases().end() |
| 1641 | ? std::distance(first: getCases().begin(), last: iteratorToInt) |
| 1642 | : liveIndex; |
| 1643 | |
| 1644 | for (unsigned regIndex = 0, regNum = getNumRegions(); regIndex < regNum; |
| 1645 | ++regIndex) |
| 1646 | bounds.emplace_back(/*lb=*/Args: 0, /*ub=*/Args: regIndex == liveIndex); |
| 1647 | } |
| 1648 | |
| 1649 | //===----------------------------------------------------------------------===// |
| 1650 | // FileOp |
| 1651 | //===----------------------------------------------------------------------===// |
| 1652 | void FileOp::build(OpBuilder &builder, OperationState &state, StringRef id) { |
| 1653 | state.addRegion()->emplaceBlock(); |
| 1654 | state.attributes.push_back( |
| 1655 | newAttribute: builder.getNamedAttr(name: "id" , val: builder.getStringAttr(bytes: id))); |
| 1656 | } |
| 1657 | |
| 1658 | //===----------------------------------------------------------------------===// |
| 1659 | // FieldOp |
| 1660 | //===----------------------------------------------------------------------===// |
| 1661 | |
| 1662 | static void printEmitCFieldOpTypeAndInitialValue(OpAsmPrinter &p, FieldOp op, |
| 1663 | TypeAttr type, |
| 1664 | Attribute initialValue) { |
| 1665 | p << type; |
| 1666 | if (initialValue) { |
| 1667 | p << " = " ; |
| 1668 | p.printAttributeWithoutType(attr: initialValue); |
| 1669 | } |
| 1670 | } |
| 1671 | |
| 1672 | static Type getInitializerTypeForField(Type type) { |
| 1673 | if (auto array = llvm::dyn_cast<ArrayType>(Val&: type)) |
| 1674 | return RankedTensorType::get(shape: array.getShape(), elementType: array.getElementType()); |
| 1675 | return type; |
| 1676 | } |
| 1677 | |
| 1678 | static ParseResult |
| 1679 | parseEmitCFieldOpTypeAndInitialValue(OpAsmParser &parser, TypeAttr &typeAttr, |
| 1680 | Attribute &initialValue) { |
| 1681 | Type type; |
| 1682 | if (parser.parseType(result&: type)) |
| 1683 | return failure(); |
| 1684 | |
| 1685 | typeAttr = TypeAttr::get(type); |
| 1686 | |
| 1687 | if (parser.parseOptionalEqual()) |
| 1688 | return success(); |
| 1689 | |
| 1690 | if (parser.parseAttribute(result&: initialValue, type: getInitializerTypeForField(type))) |
| 1691 | return failure(); |
| 1692 | |
| 1693 | if (!llvm::isa<ElementsAttr, IntegerAttr, FloatAttr, emitc::OpaqueAttr>( |
| 1694 | Val: initialValue)) |
| 1695 | return parser.emitError(loc: parser.getNameLoc()) |
| 1696 | << "initial value should be a integer, float, elements or opaque " |
| 1697 | "attribute" ; |
| 1698 | return success(); |
| 1699 | } |
| 1700 | |
| 1701 | LogicalResult FieldOp::verify() { |
| 1702 | if (!isSupportedEmitCType(type: getType())) |
| 1703 | return emitOpError(message: "expected valid emitc type" ); |
| 1704 | |
| 1705 | Operation *parentOp = getOperation()->getParentOp(); |
| 1706 | if (!parentOp || !isa<emitc::ClassOp>(Val: parentOp)) |
| 1707 | return emitOpError(message: "field must be nested within an emitc.class operation" ); |
| 1708 | |
| 1709 | StringAttr symName = getSymNameAttr(); |
| 1710 | if (!symName || symName.getValue().empty()) |
| 1711 | return emitOpError(message: "field must have a non-empty symbol name" ); |
| 1712 | |
| 1713 | return success(); |
| 1714 | } |
| 1715 | |
| 1716 | //===----------------------------------------------------------------------===// |
| 1717 | // GetFieldOp |
| 1718 | //===----------------------------------------------------------------------===// |
| 1719 | |
| 1720 | LogicalResult GetFieldOp::verifySymbolUses(SymbolTableCollection &symbolTable) { |
| 1721 | mlir::FlatSymbolRefAttr fieldNameAttr = getFieldNameAttr(); |
| 1722 | FieldOp fieldOp = |
| 1723 | symbolTable.lookupNearestSymbolFrom<FieldOp>(from: *this, symbol: fieldNameAttr); |
| 1724 | if (!fieldOp) |
| 1725 | return emitOpError(message: "field '" ) |
| 1726 | << fieldNameAttr << "' not found in the class" ; |
| 1727 | |
| 1728 | Type getFieldResultType = getResult().getType(); |
| 1729 | Type fieldType = fieldOp.getType(); |
| 1730 | |
| 1731 | if (fieldType != getFieldResultType) |
| 1732 | return emitOpError(message: "result type " ) |
| 1733 | << getFieldResultType << " does not match field '" << fieldNameAttr |
| 1734 | << "' type " << fieldType; |
| 1735 | |
| 1736 | return success(); |
| 1737 | } |
| 1738 | |
| 1739 | //===----------------------------------------------------------------------===// |
| 1740 | // DoOp |
| 1741 | //===----------------------------------------------------------------------===// |
| 1742 | |
| 1743 | void DoOp::print(OpAsmPrinter &p) { |
| 1744 | p << ' '; |
| 1745 | p.printRegion(blocks&: getBodyRegion(), /*printEntryBlockArgs=*/false); |
| 1746 | p << " while " ; |
| 1747 | p.printRegion(blocks&: getConditionRegion()); |
| 1748 | p.printOptionalAttrDictWithKeyword( |
| 1749 | attrs: getOperation()->getDiscardableAttrDictionary().getValue()); |
| 1750 | } |
| 1751 | |
| 1752 | LogicalResult emitc::DoOp::verify() { |
| 1753 | Block &condBlock = getConditionRegion().front(); |
| 1754 | |
| 1755 | if (condBlock.getOperations().size() != 2) |
| 1756 | return emitOpError( |
| 1757 | message: "condition region must contain exactly two operations: " |
| 1758 | "'emitc.expression' followed by 'emitc.yield', but found " ) |
| 1759 | << condBlock.getOperations().size() << " operations" ; |
| 1760 | |
| 1761 | Operation &first = condBlock.front(); |
| 1762 | auto exprOp = dyn_cast<emitc::ExpressionOp>(Val&: first); |
| 1763 | if (!exprOp) |
| 1764 | return emitOpError(message: "expected first op in condition region to be " |
| 1765 | "'emitc.expression', but got " ) |
| 1766 | << first.getName(); |
| 1767 | |
| 1768 | if (!exprOp.getResult().getType().isInteger(width: 1)) |
| 1769 | return emitOpError(message: "emitc.expression in condition region must return " |
| 1770 | "'i1', but returns " ) |
| 1771 | << exprOp.getResult().getType(); |
| 1772 | |
| 1773 | Operation &last = condBlock.back(); |
| 1774 | auto condYield = dyn_cast<emitc::YieldOp>(Val&: last); |
| 1775 | if (!condYield) |
| 1776 | return emitOpError(message: "expected last op in condition region to be " |
| 1777 | "'emitc.yield', but got " ) |
| 1778 | << last.getName(); |
| 1779 | |
| 1780 | if (condYield.getNumOperands() != 1) |
| 1781 | return emitOpError(message: "expected condition region to return 1 value, but " |
| 1782 | "it returns " ) |
| 1783 | << condYield.getNumOperands() << " values" ; |
| 1784 | |
| 1785 | if (condYield.getOperand(i: 0) != exprOp.getResult()) |
| 1786 | return emitError(message: "'emitc.yield' must return result of " |
| 1787 | "'emitc.expression' from this condition region" ); |
| 1788 | |
| 1789 | Block &bodyBlock = getBodyRegion().front(); |
| 1790 | if (bodyBlock.mightHaveTerminator()) |
| 1791 | return emitOpError(message: "body region must not contain terminator" ); |
| 1792 | |
| 1793 | return success(); |
| 1794 | } |
| 1795 | |
| 1796 | ParseResult DoOp::parse(OpAsmParser &parser, OperationState &result) { |
| 1797 | Region *bodyRegion = result.addRegion(); |
| 1798 | Region *condRegion = result.addRegion(); |
| 1799 | |
| 1800 | if (parser.parseRegion(region&: *bodyRegion) || parser.parseKeyword(keyword: "while" ) || |
| 1801 | parser.parseRegion(region&: *condRegion)) |
| 1802 | return failure(); |
| 1803 | |
| 1804 | if (bodyRegion->empty()) |
| 1805 | bodyRegion->emplaceBlock(); |
| 1806 | |
| 1807 | return parser.parseOptionalAttrDictWithKeyword(result&: result.attributes); |
| 1808 | } |
| 1809 | |
| 1810 | //===----------------------------------------------------------------------===// |
| 1811 | // TableGen'd op method definitions |
| 1812 | //===----------------------------------------------------------------------===// |
| 1813 | |
| 1814 | #include "mlir/Dialect/EmitC/IR/EmitCInterfaces.cpp.inc" |
| 1815 | |
| 1816 | #define GET_OP_CLASSES |
| 1817 | #include "mlir/Dialect/EmitC/IR/EmitC.cpp.inc" |
| 1818 | |