Generate MTL and MPS structs and enums with Clang.jl (#492)

* Add Docs and wrapping readme Co-authored-by: Tim Besard <[email protected]> --------- Co-authored-by: Tim Besard <[email protected]>
JuliaGPU · Dec 20, 2024 · ea1d6ad · ea1d6ad
1 parent 84447c4
commit ea1d6ad
Show file tree

Hide file tree

Showing 31 changed files with 2,347 additions and 705 deletions.
diff --git a/docs/src/faq/contributing.md b/docs/src/faq/contributing.md
@@ -38,6 +38,10 @@ skip the first two steps.
 2. Create high-level Julia structures and functionality
 3. Create tests for added functionality
 
+`struct`s and `enums` for Objective-C interfaces are automatically generated (see res/wrap/),
+so you should not have to define them. If using a struct for the first time in a higher-level
+interface, remember to add tests! You may need to define more functions around the structs.
+
 ## Mapping to Metal Intrinsics
 
 Some Metal functions map directly to Apple intermediate representation intrinsics. In this
@@ -134,4 +138,4 @@ their free time helping out. Most anything you're able to do is helpful, but if
 stuck, seek guidance from Slack or Discourse. Don't feel like your contribution has to be
 perfect. If you put in effort and make progress, there will likely be some senior developer
 willing to polish your code before merging. Open-source software is a team effort...welcome
-to the team!
+to the team!
diff --git a/lib/mps/MPS.jl b/lib/mps/MPS.jl
@@ -23,6 +23,9 @@ Base.convert(::Type{MPSShape}, tuple::Union{Vector{N},NTuple{N, <:Integer}}) whe
 
 is_supported(dev::MTLDevice) = ccall(:MPSSupportsMTLDevice, Bool, (id{MTLDevice},), dev)
 
+# Load in generated enums and structs
+include("libmps.jl")
+
 include("size.jl")
 
 # high-level wrappers

diff --git a/lib/mps/copy.jl b/lib/mps/copy.jl
@@ -2,13 +2,6 @@
 
 export MPSMatrixCopyDescriptor
 
-struct MPSMatrixCopyOffsets
-    sourceRowOffset::Cuint
-    sourceColumnOffset::Cuint
-    destinationRowOffset::Cuint
-    destinationColumnOffset::Cuint
-end
-
 @objcwrapper MPSMatrixCopyDescriptor <: NSObject
 
 function MPSMatrixCopyDescriptor(sourceMatrix, destinationMatrix, offsets = MPSMatrixCopyOffsets(Cuint(0), Cuint(0), Cuint(0), Cuint(0)))

diff --git a/lib/mps/decomposition.jl b/lib/mps/decomposition.jl
@@ -1,11 +1,3 @@
-@cenum MPSMatrixDecompositionStatus::Cint begin
-    MPSMatrixDecompositionStatusSuccess =  0
-    MPSMatrixDecompositionStatusFailure = -1
-    MPSMatrixDecompositionStatusSingular = -2
-    MPSMatrixDecompositionStatusNonPositiveDefinite = -3
-end
-
-
 ## lu
 
 export MPSMatrixDecompositionLU, encode!

diff --git a/lib/mps/images.jl b/lib/mps/images.jl
@@ -1,13 +1,5 @@
 ## kernels
 
-@cenum MPSImageEdgeMode::NSUInteger begin
-    MPSImageEdgeModeZero           = 0
-    MPSImageEdgeModeClamp          = 1
-    MPSImageEdgeModeMirror         = 2
-    MPSImageEdgeModeMirrorWithEdge = 3
-    MPSImageEdgeModeConstant       = 4
-end
-
 @objcwrapper immutable=false MPSUnaryImageKernel <: MPSKernel
 
 @objcproperties MPSUnaryImageKernel begin

diff --git a/lib/mps/kernel.jl b/lib/mps/kernel.jl
@@ -2,16 +2,6 @@
 # kernels
 #
 
-@cenum MPSKernelOptions::NSUInteger begin
-    MPSKernelOptionsNone = 0
-    MPSKernelOptionsSkipAPIValidation = 1 << 0
-    MPSKernelOptionsAllowReducedPrecision = 1 << 1
-    MPSKernelOptionsDisableInternalTiling = 1 << 2
-    MPSKernelOptionsInsertDebugGroups = 1 << 3
-    MPSKernelOptionsVerbose = 1 << 4
-end
-
-
 @objcwrapper MPSKernel <: NSObject
 
 @objcproperties MPSKernel begin