Skip to content

Error when attempting to launch kernels with an invalid grid size #751

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
christiangnrd merged 1 commit into from
Apr 11, 2026
Merged

Error when attempting to launch kernels with an invalid grid size #751

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions src/compiler/execution.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,15 +265,22 @@ end

@autoreleasepool function (kernel::HostKernel)(args...; groups=1, threads=1,
queue=global_queue(device()))
threadgroupsPerGrid = MTLSize(groups)
threadsPerThreadgroup = MTLSize(threads)
(threadgroupsPerGrid.width>0 && threadgroupsPerGrid.height>0 && threadgroupsPerGrid.depth>0) ||
gs = MTLSize(groups)
ts = MTLSize(threads)
(gs.width>0 && gs.height>0 && gs.depth>0) ||
throw(ArgumentError("All group dimensions should be non-zero"))
(threadsPerThreadgroup.width>0 && threadsPerThreadgroup.height>0 && threadsPerThreadgroup.depth>0) ||
(ts.width>0 && ts.height>0 && ts.depth>0) ||
throw(ArgumentError("All thread dimensions should be non-zero"))

(threadsPerThreadgroup.width * threadsPerThreadgroup.height * threadsPerThreadgroup.depth) > kernel.pipeline.maxTotalThreadsPerThreadgroup &&
throw(ArgumentError("Number of threads in group ($(threadsPerThreadgroup.width * threadsPerThreadgroup.height * threadsPerThreadgroup.depth)) should not exceed $(kernel.pipeline.maxTotalThreadsPerThreadgroup)"))
(ts.width * ts.height * ts.depth) > kernel.pipeline.maxTotalThreadsPerThreadgroup &&
throw(ArgumentError("Number of threads in group ($(ts.width * ts.height * ts.depth)) should not exceed $(kernel.pipeline.maxTotalThreadsPerThreadgroup)"))

(gs.width * ts.width) > typemax(UInt32) &&
throw(ArgumentError("Total threads per grid in a dimension (threads.width($(gs.width)) * groups.width($(ts.width)) = $(gs.width * ts.width)) must not exceed $(typemax(UInt32))"))
(gs.height * ts.height) > typemax(UInt32) &&
throw(ArgumentError("Total threads per grid in a dimension (threads.height($(gs.height)) * groups.height($(ts.height)) = $(gs.height * ts.height)) must not exceed $(typemax(UInt32))"))
(gs.depth * ts.depth) > typemax(UInt32) &&
throw(ArgumentError("Total threads per grid in a dimension (threads.depth($(gs.depth)) * groups.depth($(ts.depth)) = $(gs.depth * ts.depth)) must not exceed $(typemax(UInt32))"))

kernel_state = KernelState(Random.rand(UInt32))

Expand All @@ -283,7 +290,7 @@ end
argument_buffers = try
MTL.set_function!(cce, kernel.pipeline)
bufs = encode_arguments!(cce, kernel, kernel_state, kernel.f, args...)
MTL.append_current_function!(cce, threadgroupsPerGrid, threadsPerThreadgroup)
MTL.append_current_function!(cce, gs, ts)
bufs
finally
close(cce)
Expand Down
4 changes: 4 additions & 0 deletions test/execution.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,10 @@ end
@test_throws InexactError @metal groups=(-2) tester(bufferA)
@test_throws ArgumentError @metal threads=(1025) tester(bufferA)
@test_throws ArgumentError @metal threads=(1000,2) tester(bufferA)

@test_throws ArgumentError @metal threads=(1024,1,1) groups=(4194304,1,1) tester(bufferA)
@test_throws ArgumentError @metal threads=(1,1024,1) groups=(1,4194304,1) tester(bufferA)
@test_throws ArgumentError @metal threads=(1,1,1024) groups=(1,1,4194304) tester(bufferA)
end

############################################################################################
Expand Down
Loading