[MLIR] Print function name when ReturnOp verification fails

[jurahul]

Summary

• Print function name when ReturnOp verification fails
• This helps easily finding the invalid ReturnOp in an IR dump.

[rriddle]

Can you provide justification in your description as to why this change makes sense?

[jurahul]

Fix test

[rriddle]

mlir/lib/Dialect/StandardOps/IR/Ops.cpp

2027

nit: Use a @ before the function names.

[jurahul]

Prefix function names with @

mlir/lib/Dialect/StandardOps/IR/Ops.cpp

 
 static LogicalResult verify(ReturnOp op) {
   auto function = cast<FuncOp>(op.getParentOp());
 
   // The operand number and types must match the function signature.
   const auto &results = function.getType().getResults();
   if (op.getNumOperands() != results.size())
     return op.emitOpError("has ")
-           << op.getNumOperands()
-           << " operands, but enclosing function returns " << results.size();
+           << op.getNumOperands() << " operands, but enclosing function (@"
+           << function.getName() << ") returns " << results.size();
 
   for (unsigned i = 0, e = results.size(); i != e; ++i)
     if (op.getOperand(i).getType() != results[i])
       return op.emitError()
              << "type of return operand " << i << " ("
              << op.getOperand(i).getType()
-             << ") doesn't match function result type (" << results[i] << ")";
+             << ") doesn't match function result type (" << results[i] << ")"
+             << " in function @" << function.getName();
 
   return success();
 }
 
 //===----------------------------------------------------------------------===//
 // SelectOp
 //===----------------------------------------------------------------------===//
 

mlir/test/IR/invalid.mlir

 
 func @malformed_type(%a : intt) { // expected-error {{expected non-function type}}
 }
 
 // -----
 
 func @resulterror() -> i32 {
 ^bb42:
-  return    // expected-error {{'std.return' op has 0 operands, but enclosing function returns 1}}
+  return    // expected-error {{'std.return' op has 0 operands, but enclosing function (@resulterror) returns 1}}
 }
 
 // -----
 
 func @func_resulterror() -> i32 {
-  return // expected-error {{'std.return' op has 0 operands, but enclosing function returns 1}}
+  return // expected-error {{'std.return' op has 0 operands, but enclosing function (@func_resulterror) returns 1}}
 }
 
 // -----
 
 func @argError() {
 ^bb1(%a: i64):  // expected-note {{previously defined here}}
   br ^bb2
 ^bb2(%a: i64):  // expected-error{{redefinition of SSA value '%a'}}
^bb1:
   %x = "bar"() : () -> i32    // expected-note {{operand defined here}}
   return
 }
 
 // -----
 
 func @return_type_mismatch() -> i32 {
   %0 = "foo"() : ()->f32
-  return %0 : f32  // expected-error {{type of return operand 0 ('f32') doesn't match function result type ('i32')}}
+  return %0 : f32  // expected-error {{type of return operand 0 ('f32') doesn't match function result type ('i32') in function @return_type_mismatch}}
 }
 
 // -----
 
 func @return_inside_loop() {
   affine.for %i = 1 to 100 {
     // expected-error@-1 {{op expects regions to end with 'affine.terminator', found 'std.return'}}
     // expected-note@-2 {{in custom textual format, the absence of terminator implies}}