[MLIR][SPIRV] Rename `spv._module_end` to `spv.mlir.endmodule`

[ergawy]

Summary

This commit does the renaming mentioned in the title in order to bring
'spv' dialect closer to the MLIR naming conventions.

[antiagainst]

What about naming it as spv.mlir.endmodule so it's more akin to spv.mlir.addressof and others? :)

[ergawy]

• Rename to moduleend instead.

[ergawy]

In D91792#2405662, @antiagainst wrote:

What about naming it as spv.mlir.endmodule so it's more akin to spv.mlir.addressof and others? :)

I was a bit reluctant to do so tbh because of the 2 e's next to each other. But I guess this follows the convention closely. Done.

[ergawy]

Rename to endmodule.

mlir/docs/Dialects/SPIR-V.md

*   Ops that directly mirror instructions in the specification have `CamelCase`
     SPIR-V instruction.
 *   Ops with `snake_case` names are those that have different representation
     from corresponding instructions (or concepts) in the specification. These
     ops are mostly for defining the SPIR-V structure. For example, `spv.module`
     and `spv.constant`. They may correspond to one or more instructions during
     (de)serialization.
 *   Ops with `mlir.snake_case` names are those that have no corresponding
     instructions (or concepts) in the binary format. They are introduced to
-    satisfy MLIR structural requirements. For example, `spv.mlir.module_end` and
+    satisfy MLIR structural requirements. For example, `spv.mlir.endmodule` and
     `spv.mlir.merge`. They map to no instructions during (de)serialization.
 
 (TODO: consider merging the last two cases and adopting `spv.mlir.` prefix for
 them.)
 
 ## Module
 
 A SPIR-V module is defined via the `spv.module` op, which has one region that

mlir/docs/SPIRVToLLVMDialectConversion.md

 
 *   Addressing model
 *   Memory model
 *   Version-Capability-Extension attribute
 
 `spv.module` is converted into `ModuleOp`. This plays a role of enclosing scope
 to LLVM ops. At the moment, SPIR-V module attributes are ignored.
 
-`spv._module_end` is mapped to an equivalent terminator `ModuleTerminatorOp`.
+`spv.mlir.endmodule` is mapped to an equivalent terminator `ModuleTerminatorOp`.
 
 ## `mlir-spirv-cpu-runner`
 
 **Note: this is a section in progress, more information will appear soon**
 
 [LLVMFunctionAttributes]: https://llvm.org/docs/LangRef.html#function-attributes
 [SPIRVFunctionAttributes]: https://www.khronos.org/registry/spir-v/specs/unified1/SPIRV.html#_a_id_function_control_a_function_control
 [VulkanLayoutUtils]: https://github.com/llvm/llvm-project/blob/master/mlir/include/mlir/Dialect/SPIRV/LayoutUtils.h

mlir/include/mlir/Dialect/SPIRV/SPIRVStructureOps.td

let description = [{
     SPIR-V modules in other dialects in a clean manner: this op guarantees
     the validity and serializability of a SPIR-V module and thus serves as
     a clear-cut boundary.
 
     This op takes no operands and generates no results. This op should not
     implicitly capture values from the enclosing environment.
 
     This op has only one region, which only contains one block. The block
-    must be terminated via the `spv._module_end` op.
+    must be terminated via the `spv.mlir.endmodule` op.
 
     <!-- End of AutoGen section -->
 
     ```
     addressing-model ::= `Logical` | `Physical32` | `Physical64` | ...
     memory-model ::= `Simple` | `GLSL450` | `OpenCL` | `Vulkan` | ...
     spv-module-op ::= `spv.module` addressing-model memory-model
                       (requires  spirv-vce-attribute)?
let extraClassDeclaration = [{
     Block& getBlock() {
       return this->getOperation()->getRegion(0).front();
     }
   }];
 }
 
 // -----
 
-def SPV_ModuleEndOp : SPV_Op<"_module_end", [InModuleScope, Terminator]> {
+def SPV_ModuleEndOp : SPV_Op<"mlir.endmodule", [InModuleScope, Terminator]> {
   let summary = "The pseudo op that ends a SPIR-V module";
 
   let description = [{
     This op terminates the only block inside a `spv.module`'s only region.
     This op does not have a corresponding SPIR-V instruction and thus will
     not be serialized into the binary format; it is used solely to satisfy
     the structual requirement that an block must be ended with a terminator.
   }];

mlir/test/Conversion/SPIRVToLLVM/module-ops-to-llvm.mlir

 spv.module @foo Logical GLSL450 {}
 
 // CHECK: module
 spv.module Logical GLSL450 requires #spv.vce<v1.0, [Shader], [SPV_KHR_16bit_storage]> {}
 
 // CHECK: module
 spv.module Logical GLSL450 {
   // CHECK: }
-  spv._module_end
+  spv.mlir.endmodule
 }
 
 // CHECK: module
 spv.module Logical GLSL450 {
   // CHECK-LABEL: llvm.func @empty()
   spv.func @empty() -> () "None" {
     // CHECK: llvm.return
     spv.Return
   }
 }

mlir/test/Dialect/SPIRV/structure-ops.mlir

 spv.module Logical GLSL450 attributes {foo = "bar"} { }
 
 // Module with VCE triple and additional attributes
 // CHECK: spv.module Logical GLSL450 requires #spv.vce<v1.0, [Shader], [SPV_KHR_16bit_storage]> attributes {foo = "bar"}
 spv.module Logical GLSL450
   requires #spv.vce<v1.0, [Shader], [SPV_KHR_16bit_storage]>
   attributes {foo = "bar"} { }
 
-// Module with explicit spv._module_end
+// Module with explicit spv.mlir.endmodule
 // CHECK: spv.module
 spv.module Logical GLSL450 {
-  spv._module_end
+  spv.mlir.endmodule
 }
 
 // Module with function
 // CHECK: spv.module
 spv.module Logical GLSL450 {
   spv.func @do_nothing() -> () "None" {
     spv.Return
   }
^first:
   spv.Return
 ^second:
   spv.Return
 }
 
 // -----
 
 // Module with wrong terminator
-// expected-error@+2 {{expects regions to end with 'spv._module_end'}}
-// expected-note@+1 {{in custom textual format, the absence of terminator implies 'spv._module_end'}}
+// expected-error@+2 {{expects regions to end with 'spv.mlir.endmodule'}}
+// expected-note@+1 {{in custom textual format, the absence of terminator implies 'spv.mlir.endmodule'}}
 "spv.module"() ({
   %0 = spv.constant true
 }) {addressing_model = 0 : i32, memory_model = 1 : i32} : () -> ()
 
 // -----
 
 // Use non SPIR-V op inside module
 spv.module Logical GLSL450 {

 spv.module Logical GLSL450 {
   // expected-error @+1 {{'spv.module' cannot contain external functions}}
   spv.func @extern() -> () "None"
 }
 
 // -----
 
 //===----------------------------------------------------------------------===//
-// spv._module_end
+// spv.mlir.endmodule
 //===----------------------------------------------------------------------===//
 
 func @module_end_not_in_module() -> () {
   // expected-error @+1 {{op must appear in a module-like op's block}}
-  spv._module_end
+  spv.mlir.endmodule
 }
 
 // -----
 
 //===----------------------------------------------------------------------===//
 // spv.mlir.referenceof
 //===----------------------------------------------------------------------===//