Skip to content

Commit 9199856

Browse files
RossBruntonmahesh-attarde
RossBrunton
authored and
mahesh-attarde
committed
[Offload] Rename olWaitEvent/Queue to olSyncEvent/Queue (llvm#150023)
This more closely matches the nomenclature used by CUDA, AMDGPU and the plugin interface.
1 parent 40e2bc7 commit 9199856

File tree

10 files changed

+42
-42
lines changed

10 files changed

+42
-42
lines changed

‎offload/liboffload/API/Event.td‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ def : Function {
2121
}
2222

2323
def : Function {
24-
let name = "olWaitEvent";
25-
let desc = "Wait for the event to be complete.";
24+
let name = "olSyncEvent";
25+
let desc = "Block the calling thread until the event is complete.";
2626
let details = [];
2727
let params = [
2828
Param<"ol_event_handle_t", "Event", "handle of the event", PARAM_IN>

‎offload/liboffload/API/Queue.td‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ def : Function {
3232
}
3333

3434
def : Function {
35-
let name = "olWaitQueue";
36-
let desc = "Wait for the enqueued work on a queue to complete.";
35+
let name = "olSyncQueue";
36+
let desc = "Block the calling thread until the enqueued work on a queue is complete.";
3737
let details = [];
3838
let params = [
3939
Param<"ol_queue_handle_t", "Queue", "handle of the queue", PARAM_IN>

‎offload/liboffload/src/OffloadImpl.cpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -483,7 +483,7 @@ Error olCreateQueue_impl(ol_device_handle_t Device, ol_queue_handle_t *Queue) {
483483

484484
Error olDestroyQueue_impl(ol_queue_handle_t Queue) { return olDestroy(Queue); }
485485

486-
Error olWaitQueue_impl(ol_queue_handle_t Queue) {
486+
Error olSyncQueue_impl(ol_queue_handle_t Queue) {
487487
// Host plugin doesn't have a queue set so it's not safe to call synchronize
488488
// on it, but we have nothing to synchronize in that situation anyway.
489489
if (Queue->AsyncInfo->Queue) {
@@ -527,7 +527,7 @@ Error olGetQueueInfoSize_impl(ol_queue_handle_t Queue, ol_queue_info_t PropName,
527527
return olGetQueueInfoImplDetail(Queue, PropName, 0, nullptr, PropSizeRet);
528528
}
529529

530-
Error olWaitEvent_impl(ol_event_handle_t Event) {
530+
Error olSyncEvent_impl(ol_event_handle_t Event) {
531531
if (auto Res = Event->Queue->Device->Device->syncEvent(Event->EventInfo))
532532
return Res;
533533

‎offload/unittests/OffloadAPI/CMakeLists.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ add_offload_unittest("device"
1010

1111
add_offload_unittest("event"
1212
event/olDestroyEvent.cpp
13-
event/olWaitEvent.cpp
13+
event/olSyncEvent.cpp
1414
event/olGetEventInfo.cpp
1515
event/olGetEventInfoSize.cpp)
1616

@@ -36,7 +36,7 @@ add_offload_unittest("program"
3636

3737
add_offload_unittest("queue"
3838
queue/olCreateQueue.cpp
39-
queue/olWaitQueue.cpp
39+
queue/olSyncQueue.cpp
4040
queue/olDestroyQueue.cpp
4141
queue/olGetQueueInfo.cpp
4242
queue/olGetQueueInfoSize.cpp)

‎offload/unittests/OffloadAPI/common/Fixtures.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ struct OffloadEventTest : OffloadQueueTest {
179179
olMemAlloc(Device, OL_ALLOC_TYPE_DEVICE, sizeof(Value), &Alloc));
180180
ASSERT_SUCCESS(
181181
olMemcpy(Queue, Alloc, Device, &Value, Host, sizeof(Value), &Event));
182-
ASSERT_SUCCESS(olWaitEvent(Event));
182+
ASSERT_SUCCESS(olSyncEvent(Event));
183183
ASSERT_SUCCESS(olMemFree(Alloc));
184184
}
185185

‎offload/unittests/OffloadAPI/event/olDestroyEvent.cpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ TEST_P(olDestroyEventTest, Success) {
2323
ASSERT_SUCCESS(
2424
olMemcpy(Queue, DstPtr, Device, &Src, Host, sizeof(Src), &Event));
2525
ASSERT_NE(Event, nullptr);
26-
ASSERT_SUCCESS(olWaitQueue(Queue));
26+
ASSERT_SUCCESS(olSyncQueue(Queue));
2727
ASSERT_SUCCESS(olDestroyEvent(Event));
2828
}
2929

‎offload/unittests/OffloadAPI/event/olWaitEvent.cpp‎ renamed to ‎offload/unittests/OffloadAPI/event/olSyncEvent.cpp‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//===------- Offload API tests - olWaitEvent -====-------------------------===//
1+
//===------- Offload API tests - olSyncEvent -====-------------------------===//
22
//
33
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
// See https://llvm.org/LICENSE.txt for license information.
@@ -10,10 +10,10 @@
1010
#include <OffloadAPI.h>
1111
#include <gtest/gtest.h>
1212

13-
using olWaitEventTest = OffloadQueueTest;
14-
OFFLOAD_TESTS_INSTANTIATE_DEVICE_FIXTURE(olWaitEventTest);
13+
using olSyncEventTest = OffloadQueueTest;
14+
OFFLOAD_TESTS_INSTANTIATE_DEVICE_FIXTURE(olSyncEventTest);
1515

16-
TEST_P(olWaitEventTest, Success) {
16+
TEST_P(olSyncEventTest, Success) {
1717
uint32_t Src = 42;
1818
void *DstPtr;
1919

@@ -23,15 +23,15 @@ TEST_P(olWaitEventTest, Success) {
2323
ASSERT_SUCCESS(
2424
olMemcpy(Queue, DstPtr, Device, &Src, Host, sizeof(Src), &Event));
2525
ASSERT_NE(Event, nullptr);
26-
ASSERT_SUCCESS(olWaitEvent(Event));
26+
ASSERT_SUCCESS(olSyncEvent(Event));
2727
ASSERT_SUCCESS(olDestroyEvent(Event));
2828
}
2929

30-
TEST_P(olWaitEventTest, InvalidNullEvent) {
31-
ASSERT_ERROR(OL_ERRC_INVALID_NULL_HANDLE, olWaitEvent(nullptr));
30+
TEST_P(olSyncEventTest, InvalidNullEvent) {
31+
ASSERT_ERROR(OL_ERRC_INVALID_NULL_HANDLE, olSyncEvent(nullptr));
3232
}
3333

34-
TEST_P(olWaitEventTest, SuccessMultipleWait) {
34+
TEST_P(olSyncEventTest, SuccessMultipleWait) {
3535
uint32_t Src = 42;
3636
void *DstPtr;
3737

@@ -43,7 +43,7 @@ TEST_P(olWaitEventTest, SuccessMultipleWait) {
4343
ASSERT_NE(Event, nullptr);
4444

4545
for (size_t I = 0; I < 10; I++)
46-
ASSERT_SUCCESS(olWaitEvent(Event));
46+
ASSERT_SUCCESS(olSyncEvent(Event));
4747

4848
ASSERT_SUCCESS(olDestroyEvent(Event));
4949
}

‎offload/unittests/OffloadAPI/kernel/olLaunchKernel.cpp‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ TEST_P(olLaunchKernelFooTest, Success) {
9494
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernel, &Args, sizeof(Args),
9595
&LaunchArgs, nullptr));
9696

97-
ASSERT_SUCCESS(olWaitQueue(Queue));
97+
ASSERT_SUCCESS(olSyncQueue(Queue));
9898

9999
uint32_t *Data = (uint32_t *)Mem;
100100
for (uint32_t i = 0; i < 64; i++) {
@@ -108,7 +108,7 @@ TEST_P(olLaunchKernelNoArgsTest, Success) {
108108
ASSERT_SUCCESS(
109109
olLaunchKernel(Queue, Device, Kernel, nullptr, 0, &LaunchArgs, nullptr));
110110

111-
ASSERT_SUCCESS(olWaitQueue(Queue));
111+
ASSERT_SUCCESS(olSyncQueue(Queue));
112112
}
113113

114114
TEST_P(olLaunchKernelFooTest, SuccessSynchronous) {
@@ -147,7 +147,7 @@ TEST_P(olLaunchKernelLocalMemTest, Success) {
147147
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernel, &Args, sizeof(Args),
148148
&LaunchArgs, nullptr));
149149

150-
ASSERT_SUCCESS(olWaitQueue(Queue));
150+
ASSERT_SUCCESS(olSyncQueue(Queue));
151151

152152
uint32_t *Data = (uint32_t *)Mem;
153153
for (uint32_t i = 0; i < LaunchArgs.GroupSize.x * LaunchArgs.NumGroups.x; i++)
@@ -170,7 +170,7 @@ TEST_P(olLaunchKernelLocalMemReductionTest, Success) {
170170
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernel, &Args, sizeof(Args),
171171
&LaunchArgs, nullptr));
172172

173-
ASSERT_SUCCESS(olWaitQueue(Queue));
173+
ASSERT_SUCCESS(olSyncQueue(Queue));
174174

175175
uint32_t *Data = (uint32_t *)Mem;
176176
for (uint32_t i = 0; i < LaunchArgs.NumGroups.x; i++)
@@ -193,7 +193,7 @@ TEST_P(olLaunchKernelLocalMemStaticTest, Success) {
193193
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernel, &Args, sizeof(Args),
194194
&LaunchArgs, nullptr));
195195

196-
ASSERT_SUCCESS(olWaitQueue(Queue));
196+
ASSERT_SUCCESS(olSyncQueue(Queue));
197197

198198
uint32_t *Data = (uint32_t *)Mem;
199199
for (uint32_t i = 0; i < LaunchArgs.NumGroups.x; i++)
@@ -212,10 +212,10 @@ TEST_P(olLaunchKernelGlobalTest, Success) {
212212

213213
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernels[0], nullptr, 0,
214214
&LaunchArgs, nullptr));
215-
ASSERT_SUCCESS(olWaitQueue(Queue));
215+
ASSERT_SUCCESS(olSyncQueue(Queue));
216216
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernels[1], &Args, sizeof(Args),
217217
&LaunchArgs, nullptr));
218-
ASSERT_SUCCESS(olWaitQueue(Queue));
218+
ASSERT_SUCCESS(olSyncQueue(Queue));
219219

220220
uint32_t *Data = (uint32_t *)Mem;
221221
for (uint32_t i = 0; i < 64; i++) {
@@ -244,7 +244,7 @@ TEST_P(olLaunchKernelGlobalCtorTest, Success) {
244244

245245
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, Kernel, &Args, sizeof(Args),
246246
&LaunchArgs, nullptr));
247-
ASSERT_SUCCESS(olWaitQueue(Queue));
247+
ASSERT_SUCCESS(olSyncQueue(Queue));
248248

249249
uint32_t *Data = (uint32_t *)Mem;
250250
for (uint32_t i = 0; i < 64; i++) {
@@ -260,5 +260,5 @@ TEST_P(olLaunchKernelGlobalDtorTest, Success) {
260260
// crashes
261261
ASSERT_SUCCESS(
262262
olLaunchKernel(Queue, Device, Kernel, nullptr, 0, &LaunchArgs, nullptr));
263-
ASSERT_SUCCESS(olWaitQueue(Queue));
263+
ASSERT_SUCCESS(olSyncQueue(Queue));
264264
}

‎offload/unittests/OffloadAPI/memory/olMemcpy.cpp‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ TEST_P(olMemcpyTest, SuccessHtoD) {
4646
std::vector<uint8_t> Input(Size, 42);
4747
ASSERT_SUCCESS(
4848
olMemcpy(Queue, Alloc, Device, Input.data(), Host, Size, nullptr));
49-
olWaitQueue(Queue);
49+
olSyncQueue(Queue);
5050
olMemFree(Alloc);
5151
}
5252

@@ -61,7 +61,7 @@ TEST_P(olMemcpyTest, SuccessDtoH) {
6161
olMemcpy(Queue, Alloc, Device, Input.data(), Host, Size, nullptr));
6262
ASSERT_SUCCESS(
6363
olMemcpy(Queue, Output.data(), Host, Alloc, Device, Size, nullptr));
64-
ASSERT_SUCCESS(olWaitQueue(Queue));
64+
ASSERT_SUCCESS(olSyncQueue(Queue));
6565
for (uint8_t Val : Output) {
6666
ASSERT_EQ(Val, 42);
6767
}
@@ -83,7 +83,7 @@ TEST_P(olMemcpyTest, SuccessDtoD) {
8383
olMemcpy(Queue, AllocB, Device, AllocA, Device, Size, nullptr));
8484
ASSERT_SUCCESS(
8585
olMemcpy(Queue, Output.data(), Host, AllocB, Device, Size, nullptr));
86-
ASSERT_SUCCESS(olWaitQueue(Queue));
86+
ASSERT_SUCCESS(olSyncQueue(Queue));
8787
for (uint8_t Val : Output) {
8888
ASSERT_EQ(Val, 42);
8989
}
@@ -146,10 +146,10 @@ TEST_P(olMemcpyGlobalTest, SuccessRoundTrip) {
146146

147147
ASSERT_SUCCESS(olMemcpy(Queue, Addr, Device, SourceMem, Host,
148148
64 * sizeof(uint32_t), nullptr));
149-
ASSERT_SUCCESS(olWaitQueue(Queue));
149+
ASSERT_SUCCESS(olSyncQueue(Queue));
150150
ASSERT_SUCCESS(olMemcpy(Queue, DestMem, Host, Addr, Device,
151151
64 * sizeof(uint32_t), nullptr));
152-
ASSERT_SUCCESS(olWaitQueue(Queue));
152+
ASSERT_SUCCESS(olSyncQueue(Queue));
153153

154154
uint32_t *DestData = (uint32_t *)DestMem;
155155
for (uint32_t I = 0; I < 64; I++)
@@ -178,10 +178,10 @@ TEST_P(olMemcpyGlobalTest, SuccessWrite) {
178178

179179
ASSERT_SUCCESS(olMemcpy(Queue, Addr, Device, SourceMem, Host,
180180
64 * sizeof(uint32_t), nullptr));
181-
ASSERT_SUCCESS(olWaitQueue(Queue));
181+
ASSERT_SUCCESS(olSyncQueue(Queue));
182182
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, ReadKernel, &Args, sizeof(Args),
183183
&LaunchArgs, nullptr));
184-
ASSERT_SUCCESS(olWaitQueue(Queue));
184+
ASSERT_SUCCESS(olSyncQueue(Queue));
185185

186186
uint32_t *DestData = (uint32_t *)DestMem;
187187
for (uint32_t I = 0; I < 64; I++)
@@ -199,10 +199,10 @@ TEST_P(olMemcpyGlobalTest, SuccessRead) {
199199

200200
ASSERT_SUCCESS(olLaunchKernel(Queue, Device, WriteKernel, nullptr, 0,
201201
&LaunchArgs, nullptr));
202-
ASSERT_SUCCESS(olWaitQueue(Queue));
202+
ASSERT_SUCCESS(olSyncQueue(Queue));
203203
ASSERT_SUCCESS(olMemcpy(Queue, DestMem, Host, Addr, Device,
204204
64 * sizeof(uint32_t), nullptr));
205-
ASSERT_SUCCESS(olWaitQueue(Queue));
205+
ASSERT_SUCCESS(olSyncQueue(Queue));
206206

207207
uint32_t *DestData = (uint32_t *)DestMem;
208208
for (uint32_t I = 0; I < 64; I++)

‎offload/unittests/OffloadAPI/queue/olWaitQueue.cpp‎ renamed to ‎offload/unittests/OffloadAPI/queue/olSyncQueue.cpp‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//===------- Offload API tests - olWaitQueue ------------------------------===//
1+
//===------- Offload API tests - olSyncQueue ------------------------------===//
22
//
33
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
44
// See https://llvm.org/LICENSE.txt for license information.
@@ -10,9 +10,9 @@
1010
#include <OffloadAPI.h>
1111
#include <gtest/gtest.h>
1212

13-
using olWaitQueueTest = OffloadQueueTest;
14-
OFFLOAD_TESTS_INSTANTIATE_DEVICE_FIXTURE(olWaitQueueTest);
13+
using olSyncQueueTest = OffloadQueueTest;
14+
OFFLOAD_TESTS_INSTANTIATE_DEVICE_FIXTURE(olSyncQueueTest);
1515

16-
TEST_P(olWaitQueueTest, SuccessEmptyQueue) {
17-
ASSERT_SUCCESS(olWaitQueue(Queue));
16+
TEST_P(olSyncQueueTest, SuccessEmptyQueue) {
17+
ASSERT_SUCCESS(olSyncQueue(Queue));
1818
}

0 commit comments

Comments
 (0)