[MLIR:LLVM] Add UWTableKind attribute #135811

WillFroom · 2025-04-15T16:37:50Z

Add UWTableKind enum and corresponding attribute to llvm.func including translation to llvm::Function attribute.

llvmbot · 2025-04-15T16:38:29Z

@llvm/pr-subscribers-mlir-llvm

Author: Will Froom (WillFroom)

Changes

Add UWTableKind enum and corresponding attribute to llvm.func including translation to llvm::Function attribute.

Full diff: https://github.com/llvm/llvm-project/pull/135811.diff

5 Files Affected:

(modified) mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td (+10)
(modified) mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td (+23)
(modified) mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td (+2-1)
(modified) mlir/lib/Target/LLVMIR/ModuleTranslation.cpp (+2)
(added) mlir/test/Target/LLVMIR/uwtable.mlir (+8)

diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
index 690243525ede4..e2bea7f8d3d23 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
@@ -1365,4 +1365,14 @@ def LLVM_DependentLibrariesAttr
   let assemblyFormat = "`<` $libs `>`";
 }
 
+//===----------------------------------------------------------------------===//
+// UWTableKindAttr
+//===----------------------------------------------------------------------===//
+
+def UWTableKindAttr : LLVM_Attr<"UWTableKind", "uwtableKind"> {
+  let parameters = (ins "uwtable::UWTableKind":$uwtableKind);
+  let assemblyFormat = "`<` $uwtableKind `>`";
+}
+
+
 #endif // LLVMIR_ATTRDEFS
diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td
index 34a30a00790ea..52bce96c8a990 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td
@@ -855,4 +855,27 @@ def ModFlagBehaviorAttr : LLVM_EnumAttr<
   let cppNamespace = "::mlir::LLVM";
 }
 
+//===----------------------------------------------------------------------===//
+// UWTableKind
+//===----------------------------------------------------------------------===//
+
+def UWTableKindNone
+    : LLVM_EnumAttrCase<"None", "none", "None", 0>;
+def UWTableKindSync
+    : LLVM_EnumAttrCase<"Sync", "sync", "Sync", 1>;
+def UWTableKindAsync
+    : LLVM_EnumAttrCase<"Async", "async", "Async", 2>;
+def UWTableKindDefault
+    : LLVM_EnumAttrCase<"Default", "default", "Default", 2>;
+
+// UWTableKindDefault is unsupported as the llvm enum value is the same as async  
+// which the generated enum converters can't deal with.
+def UWTableKindEnum : LLVM_EnumAttr<
+    "UWTableKind",
+    "::llvm::UWTableKind",
+    "LLVM Unwind Behavior",
+    [UWTableKindNone, UWTableKindSync, UWTableKindAsync]> {
+  let cppNamespace = "::mlir::LLVM::uwtable";
+}
+
 #endif // LLVMIR_ENUMS
diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
index e89e78aec7147..76a2ec47b3a22 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
@@ -1842,7 +1842,8 @@ def LLVM_LLVMFuncOp : LLVM_Op<"func", [
     OptionalAttr<LLVM_VecTypeHintAttr>:$vec_type_hint,
     OptionalAttr<DenseI32ArrayAttr>:$work_group_size_hint,
     OptionalAttr<DenseI32ArrayAttr>:$reqd_work_group_size,
-    OptionalAttr<I32Attr>:$intel_reqd_sub_group_size
+    OptionalAttr<I32Attr>:$intel_reqd_sub_group_size,
+    OptionalAttr<UWTableKindAttr>:$uwtable_kind
   );
 
   let regions = (region AnyRegion:$body);
diff --git a/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp b/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
index ee7dc3a5231f4..6531b233b94a0 100644
--- a/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
+++ b/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
@@ -1602,6 +1602,8 @@ static void convertFunctionAttributes(LLVMFuncOp func,
   if (FramePointerKindAttr fpAttr = func.getFramePointerAttr())
     llvmFunc->addFnAttr("frame-pointer", stringifyFramePointerKind(
                                              fpAttr.getFramePointerKind()));
+  if (UWTableKindAttr uwTableKindAttr = func.getUwtableKindAttr())
+    llvmFunc->setUWTableKind(convertUWTableKindToLLVM(uwTableKindAttr.getUwtableKind()));
   convertFunctionMemoryAttributes(func, llvmFunc);
 }
 
diff --git a/mlir/test/Target/LLVMIR/uwtable.mlir b/mlir/test/Target/LLVMIR/uwtable.mlir
new file mode 100644
index 0000000000000..3e1d5b566f01b
--- /dev/null
+++ b/mlir/test/Target/LLVMIR/uwtable.mlir
@@ -0,0 +1,8 @@
+// RUN: mlir-translate -mlir-to-llvmir %s | FileCheck %s
+
+// CHECK-LABEL: define void @uwtable_func() 
+// CHECK-SAME: #[[ATTRS:[0-9]+]]
+llvm.func @uwtable_func() attributes {uwtable_kind = #llvm.uwtableKind<"sync">}  {
+  llvm.return
+}
+// CHECK: attributes #[[ATTRS]] = { uwtable(sync) }

llvmbot · 2025-04-15T16:38:29Z

@llvm/pr-subscribers-mlir

Author: Will Froom (WillFroom)

Changes

Add UWTableKind enum and corresponding attribute to llvm.func including translation to llvm::Function attribute.

Full diff: https://github.com/llvm/llvm-project/pull/135811.diff

5 Files Affected:

(modified) mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td (+10)
(modified) mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td (+23)
(modified) mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td (+2-1)
(modified) mlir/lib/Target/LLVMIR/ModuleTranslation.cpp (+2)
(added) mlir/test/Target/LLVMIR/uwtable.mlir (+8)

diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
index 690243525ede4..e2bea7f8d3d23 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td
@@ -1365,4 +1365,14 @@ def LLVM_DependentLibrariesAttr
   let assemblyFormat = "`<` $libs `>`";
 }
 
+//===----------------------------------------------------------------------===//
+// UWTableKindAttr
+//===----------------------------------------------------------------------===//
+
+def UWTableKindAttr : LLVM_Attr<"UWTableKind", "uwtableKind"> {
+  let parameters = (ins "uwtable::UWTableKind":$uwtableKind);
+  let assemblyFormat = "`<` $uwtableKind `>`";
+}
+
+
 #endif // LLVMIR_ATTRDEFS
diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td
index 34a30a00790ea..52bce96c8a990 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td
@@ -855,4 +855,27 @@ def ModFlagBehaviorAttr : LLVM_EnumAttr<
   let cppNamespace = "::mlir::LLVM";
 }
 
+//===----------------------------------------------------------------------===//
+// UWTableKind
+//===----------------------------------------------------------------------===//
+
+def UWTableKindNone
+    : LLVM_EnumAttrCase<"None", "none", "None", 0>;
+def UWTableKindSync
+    : LLVM_EnumAttrCase<"Sync", "sync", "Sync", 1>;
+def UWTableKindAsync
+    : LLVM_EnumAttrCase<"Async", "async", "Async", 2>;
+def UWTableKindDefault
+    : LLVM_EnumAttrCase<"Default", "default", "Default", 2>;
+
+// UWTableKindDefault is unsupported as the llvm enum value is the same as async  
+// which the generated enum converters can't deal with.
+def UWTableKindEnum : LLVM_EnumAttr<
+    "UWTableKind",
+    "::llvm::UWTableKind",
+    "LLVM Unwind Behavior",
+    [UWTableKindNone, UWTableKindSync, UWTableKindAsync]> {
+  let cppNamespace = "::mlir::LLVM::uwtable";
+}
+
 #endif // LLVMIR_ENUMS
diff --git a/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td b/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
index e89e78aec7147..76a2ec47b3a22 100644
--- a/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
+++ b/mlir/include/mlir/Dialect/LLVMIR/LLVMOps.td
@@ -1842,7 +1842,8 @@ def LLVM_LLVMFuncOp : LLVM_Op<"func", [
     OptionalAttr<LLVM_VecTypeHintAttr>:$vec_type_hint,
     OptionalAttr<DenseI32ArrayAttr>:$work_group_size_hint,
     OptionalAttr<DenseI32ArrayAttr>:$reqd_work_group_size,
-    OptionalAttr<I32Attr>:$intel_reqd_sub_group_size
+    OptionalAttr<I32Attr>:$intel_reqd_sub_group_size,
+    OptionalAttr<UWTableKindAttr>:$uwtable_kind
   );
 
   let regions = (region AnyRegion:$body);
diff --git a/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp b/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
index ee7dc3a5231f4..6531b233b94a0 100644
--- a/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
+++ b/mlir/lib/Target/LLVMIR/ModuleTranslation.cpp
@@ -1602,6 +1602,8 @@ static void convertFunctionAttributes(LLVMFuncOp func,
   if (FramePointerKindAttr fpAttr = func.getFramePointerAttr())
     llvmFunc->addFnAttr("frame-pointer", stringifyFramePointerKind(
                                              fpAttr.getFramePointerKind()));
+  if (UWTableKindAttr uwTableKindAttr = func.getUwtableKindAttr())
+    llvmFunc->setUWTableKind(convertUWTableKindToLLVM(uwTableKindAttr.getUwtableKind()));
   convertFunctionMemoryAttributes(func, llvmFunc);
 }
 
diff --git a/mlir/test/Target/LLVMIR/uwtable.mlir b/mlir/test/Target/LLVMIR/uwtable.mlir
new file mode 100644
index 0000000000000..3e1d5b566f01b
--- /dev/null
+++ b/mlir/test/Target/LLVMIR/uwtable.mlir
@@ -0,0 +1,8 @@
+// RUN: mlir-translate -mlir-to-llvmir %s | FileCheck %s
+
+// CHECK-LABEL: define void @uwtable_func() 
+// CHECK-SAME: #[[ATTRS:[0-9]+]]
+llvm.func @uwtable_func() attributes {uwtable_kind = #llvm.uwtableKind<"sync">}  {
+  llvm.return
+}
+// CHECK: attributes #[[ATTRS]] = { uwtable(sync) }

github-actions · 2025-04-15T16:40:02Z

✅ With the latest revision this PR passed the C/C++ code formatter.

WillFroom · 2025-04-15T16:40:04Z

mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td

+// UWTableKindDefault is unsupported as the llvm enum value is the same as async  
+// which the generated enum converters can't deal with.


Not sure what the best way of dealing with this is, or if we are happy with this behavior (the issue is duplicate cases in the switch in the generated converter)

Yeah lets drop the default kind above then?

gysit

Thanks!

Can you add the attribute to ModuleImport.cpp as well so that we can import it from LLVM IR. The easiest way is to search for frame-pointer in ModuleImport.cpp and perform the same changes for the new attribute. A small import test makes sense as well.

gysit · 2025-04-15T16:47:43Z

mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td

+    : LLVM_EnumAttrCase<"Sync", "sync", "Sync", 1>;
+def UWTableKindAsync
+    : LLVM_EnumAttrCase<"Async", "async", "Async", 2>;
+def UWTableKindDefault


Can you delete UWTableKindDefault since it seems to be unused?

gysit · 2025-04-15T16:48:32Z

mlir/include/mlir/Dialect/LLVMIR/LLVMEnums.td

+// UWTableKindDefault is unsupported as the llvm enum value is the same as async  
+// which the generated enum converters can't deal with.


Yeah lets drop the default kind above then?

WillFroom · 2025-04-16T09:13:55Z

Thanks!

Can you add the attribute to ModuleImport.cpp as well so that we can import it from LLVM IR. The easiest way is to search for frame-pointer in ModuleImport.cpp and perform the same changes for the new attribute. A small import test makes sense as well.

Done & added test

WillFroom · 2025-04-16T09:14:27Z

Thanks for the review @gysit, feel free to merge if you are happy

gysit

Nice!

LGTM modulo some last nits.

Especially, keeping kExplicitAttributes sorted would be great. I am happy to land the PR once the last nits have been addressed.

gysit · 2025-04-16T17:12:47Z

mlir/include/mlir/Dialect/LLVMIR/LLVMAttrDefs.td

+
+

Suggested change

ultra nit: drop extra newline.

gysit · 2025-04-16T17:13:59Z

mlir/lib/Target/LLVMIR/ModuleImport.cpp

@@ -2077,6 +2077,7 @@ static constexpr std::array kExplicitAttributes{
    StringLiteral("unsafe-fp-math"),
    StringLiteral("vscale_range"),
    StringLiteral("willreturn"),
+    StringLiteral("uwtable"),


nit: Can you sort in alphabetical order?

gysit · 2025-04-16T17:14:24Z

mlir/test/Target/LLVMIR/Import/uwtable.ll

+
+; CHECK-LABEL: llvm.func @uwtable_func
+; CHECK-SAME: attributes {uwtable_kind = #llvm.uwtableKind<sync>}
+


Suggested change

ultra nit: drop extra newline

WillFroom · 2025-04-17T08:46:29Z

Thanks again @gysit for the review, I had @basioli-k land it, hope that's ok

gysit · 2025-04-17T09:10:57Z

I had @basioli-k land it, hope that's ok

of course no problem!

Add `UWTableKind` enum and corresponding attribute to `llvm.func` including translation to `llvm::Function` attribute.

llvmbot added mlir:llvm mlir labels Apr 15, 2025

WillFroom commented Apr 15, 2025

View reviewed changes

WillFroom force-pushed the mlir_add_uwtable_attr branch from 882829b to 0359620 Compare April 15, 2025 16:42

gysit reviewed Apr 15, 2025

View reviewed changes

WillFroom force-pushed the mlir_add_uwtable_attr branch 3 times, most recently from 0a2695d to d157475 Compare April 16, 2025 09:12

gysit reviewed Apr 16, 2025

View reviewed changes

gysit approved these changes Apr 16, 2025

View reviewed changes

[MLIR:LLVM] Add UWTableKind attribute

30bd5a3

WillFroom force-pushed the mlir_add_uwtable_attr branch from d157475 to 30bd5a3 Compare April 17, 2025 08:43

basioli-k merged commit 046a1e6 into llvm:main Apr 17, 2025
6 of 11 checks passed

var-const pushed a commit to ldionne/llvm-project that referenced this pull request Apr 17, 2025

[MLIR:LLVM] Add UWTableKind attribute (llvm#135811)

094a62b

Add `UWTableKind` enum and corresponding attribute to `llvm.func` including translation to `llvm::Function` attribute.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[MLIR:LLVM] Add UWTableKind attribute #135811

[MLIR:LLVM] Add UWTableKind attribute #135811

WillFroom commented Apr 15, 2025

llvmbot commented Apr 15, 2025

llvmbot commented Apr 15, 2025

github-actions bot commented Apr 15, 2025 •

edited

Loading

WillFroom Apr 15, 2025

gysit Apr 15, 2025

WillFroom Apr 16, 2025

gysit left a comment

gysit Apr 15, 2025

WillFroom Apr 16, 2025

gysit Apr 15, 2025

WillFroom commented Apr 16, 2025

WillFroom commented Apr 16, 2025

gysit left a comment

gysit Apr 16, 2025

WillFroom Apr 17, 2025

gysit Apr 16, 2025

WillFroom Apr 17, 2025

gysit Apr 16, 2025

WillFroom Apr 17, 2025

WillFroom commented Apr 17, 2025

gysit commented Apr 17, 2025

		// UWTableKindDefault is unsupported as the llvm enum value is the same as async
		// which the generated enum converters can't deal with.


		; CHECK-LABEL: llvm.func @uwtable_func
		; CHECK-SAME: attributes {uwtable_kind = #llvm.uwtableKind<sync>}

[MLIR:LLVM] Add UWTableKind attribute #135811

[MLIR:LLVM] Add UWTableKind attribute #135811

Conversation

WillFroom commented Apr 15, 2025

llvmbot commented Apr 15, 2025

llvmbot commented Apr 15, 2025

github-actions bot commented Apr 15, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gysit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WillFroom commented Apr 16, 2025

WillFroom commented Apr 16, 2025

gysit left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WillFroom commented Apr 17, 2025

gysit commented Apr 17, 2025

github-actions bot commented Apr 15, 2025 •

edited

Loading