WAIT_GROUP_EVENTS(3clc)

✨ WAIT_GROUP_EVENTS ✨

okay so bestie, welcome to WAIT_GROUP_EVENTS(3clc), straight out of the OpenCL Manual 💖 this one's a little three-parter in the man page family and it's giving "short but VERY serious" energy, so pay attention fr fr 👑

---

💫 NAME 💫

wait_group_events — the way you sit there and wait for the events that identify the async_work_group_copy operations to complete 🕰️✨

void wait_group_events(int num_events, event_t *event_list);

like. that's the whole signature. cute, right? 🎀

---

🌸 DESCRIPTION 🌸

So here's the tea ☕: you're waiting on the events that identify the async_work_group_copy(3clc) operations to complete. That's it, that's the job.

And the event objects specified in event_list will be released after the wait is performed — so once you've waited, they're gone, periodt 💅 don't go touching them after.

⚠️ THE BIG ONE, no cap: this function must be encountered by all work-items in a work-group executing the kernel with the same num_events and event objects specified in event_list — otherwise the results are undefined. everybody in the group has to show up to this party with the exact same guest list, or it's chaos 😭👯♀️

---

🦋 NOTES 🦋

The kernel must wait for the completion of all async copies using the wait_group_events built-in function before exiting — otherwise the behavior is undefined 🫣

like literally do not leave the function early, the async copies are still out there and they will NOT be chill about it 💀

---

🌈 SPECIFICATION 🌈

OpenCL Specification[1] — see the footnote bestie, it's right there at the bottom 🧚

---

⭐ SEE ALSO ⭐

• asyncCopyFunctions(3clc) — go read that one too, they're besties, iykyk 🫶

---

👑 AUTHORS 👑

The Khronos Group 💜 iconic of them honestly

---

🎀 COPYRIGHT 🎀

Copyright © 2007-2011 The Khronos Group Inc.

and here's the legal bit, verbatim, because we do not paraphrase legal text in this group chat 🫡

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and/or associated documentation files (the
"Materials"), to deal in the Materials without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Materials, and to
permit persons to whom the Materials are furnished to do so, subject to
the condition that this copyright notice and permission notice shall be
included in all copies or substantial portions of the Materials.

---

🌸 NOTES (the footnote one, not the other one) 🌸

1. OpenCL Specification page 276, section 6.12.10 - Async Copies from Global to Local Memory... 📖✨

---

and that's the whole page bestie!! 💖 written by The Khronos Group, dated 01/14/2021, and it lives in section 3clc of the OpenCL Manual 🦋 now go forth and wait on your events, responsibly, with the whole work-group, or else 🔥👑 mwah 💅