已合并
fix: RT_ERROR_STREAM_UNJOINED 错误码整改及文档更新 #3916
yanmingxiang创建于 7月29日
fix: RT_ERROR_STREAM_UNJOINED 错误码整改及文档更新 #3916
已合并
共 6 个文件变更+44-23
| @@ -1,14 +1,14 @@ | |||
| 1 | # 跨流捕获 | 1 | # 跨流捕获 |
| 2 | 2 | ||
| 3 | -在捕获Stream上的任务时，aclmdlRICaptureBegin和aclmdlRICaptureEnd接口中指定的Stream只能是同一个Stream（我们将其称为“主流”），若要实现跨Stream的捕获任务，可调用aclrtRecordEvent接口在主流上下发Event Record任务、在其他Stream上调用aclrtStreamWaitEvent接口下发Event Wait任务，以建立主流与其他Stream的关联关系，从而将主流以及其他Stream上的任务捕获到同一个模型中。这时，该Event也会进入捕获状态，如果还有其他Stream等待该Event，那么，相应的Stream也会进入捕获状态。如下图所示，Stream2需等待主流上的task1任务完成，Stream3需等待Stream2上的task2任务完成，这种情况下，Stream2直接依赖主流，而Stream3相当于间接依赖主流，因此，Stream2、Stream3均会被纳入捕获状态，Stream2上的task2任务、Stream3上的task3任务也会被捕获到模型中。 | 3 | +在捕获Stream上的任务时，aclmdlRICaptureBegin和aclmdlRICaptureEnd接口中指定的Stream只能是同一个Stream，我们将其称为主流（origin stream），若要实现跨Stream的捕获任务，可调用aclrtRecordEvent接口在主流上下发Event Record任务、在子流（sub stream）上调用aclrtStreamWaitEvent接口下发Event Wait任务，以建立主流与子流的关联关系，从而将主流和子流上的任务捕获到同一个模型中。这时，该Event也会进入捕获状态，如果还有其他Stream等待该Event，那么相应的Stream也会进入捕获状态。如下图所示，Stream2和Stream3是子流，Stream2需等待主流上的task1任务完成，Stream3需等待Stream2上的task2任务完成，这种情况下，Stream2直接依赖主流，而Stream3相当于间接依赖主流，因此，Stream2、Stream3均会被纳入捕获状态，Stream2上的task2任务、Stream3上的task3任务也会被捕获到模型中。 |
| 4 | 4 | ||
| 5 | -通过Event加入捕获状态的Stream，最终还需要直接或间接地再通过Event返回到主流，否则会在结束捕获时触发报错。如下图所示，可调用aclrtRecordEvent接口在Stream2、Stream3上下发Event Record任务、在主流上调用aclrtStreamWaitEvent接口下发Event Wait任务，以实现Stream2、Stream3返回主流。另外，对于像Stream3这种间接依赖主流的情况，也可以在Stream3上下发Event Record任务、在Stream2上下发Event Wait任务，先将Stream3返回Stream2，然后再在Stream2上下发Event Record任务、在主流上下发Event Wait任务，最终返回到主流。返回主流之后，结束捕获前，不能再在Stream2、Stream3上下发task（例如下图中的task5），否则在结束捕获时会因为校验到有未被关联的task而触发报错。 | 5 | +通过Event加入捕获状态的子流，最终还需要直接或间接地再通过Event返回到主流，否则会在结束捕获时触发报错。如下图所示，可调用aclrtRecordEvent接口在Stream2、Stream3上下发Event Record任务、在主流上调用aclrtStreamWaitEvent接口下发Event Wait任务，以实现Stream2、Stream3返回主流。另外，对于像Stream3这种间接依赖主流的情况，也可以在Stream3上下发Event Record任务、在Stream2上下发Event Wait任务，先将Stream3返回Stream2，然后再在Stream2上下发Event Record任务、在主流上下发Event Wait任务，最终返回到主流。返回主流之后，结束捕获前，不能再在Stream2、Stream3上下发task（例如下图中的task5），否则在结束捕获时会因为校验到有未被关联的task而触发报错。 |
| 6 | 6 | ||
| 7 | 跨Stream的任务捕获流程如下图所示： | 7 | 跨Stream的任务捕获流程如下图所示： |
| 8 | 8 | ||
| 9 |  | 9 |  |
| 10 | 10 | ||
| 11 | -以下示例用两个stream为例演示跨流捕获，其中stream1是主流。 | 11 | +以下示例用两个stream为例演示跨流捕获，其中stream1是主流，stream2是子流。 |
| 12 | 12 | ||
| 13 | ``` | 13 | ``` |
| 14 | #include <stdio.h> | 14 | #include <stdio.h> |
| @@ -337,7 +337,7 @@ typedef int aclError; | |||
| 337 | | #define ACL_ERROR_RT_DEVICE_TASK_ABORT 107022 | Device上的任务丢弃操作与其它操作冲突。 | 该错误码是由于调用aclrtDeviceTaskAbort接口停止Device上的任务与其它接口操作冲突，用户需排查代码逻辑，等待aclrtDeviceTaskAbort接口执行完成后，才执行其它操作。 | | 337 | | #define ACL_ERROR_RT_DEVICE_TASK_ABORT 107022 | Device上的任务丢弃操作与其它操作冲突。 | 该错误码是由于调用aclrtDeviceTaskAbort接口停止Device上的任务与其它接口操作冲突，用户需排查代码逻辑，等待aclrtDeviceTaskAbort接口执行完成后，才执行其它操作。 | |
| 338 | | #define ACL_ERROR_RT_STREAM_ABORT 107023 | 正在清除Stream上的任务。 | 正在清除指定Stream上的任务，不支持同步等待该Stream上的任务执行。 | | 338 | | #define ACL_ERROR_RT_STREAM_ABORT 107023 | 正在清除Stream上的任务。 | 正在清除指定Stream上的任务，不支持同步等待该Stream上的任务执行。 | |
| 339 | | #define ACL_ERROR_RT_CAPTURE_DEPENDENCY 107024 | 基于捕获方式构建模型运行实例时，event wait任务没有对应的event record任务。 | 调用aclrtRecordEvent接口增加event record任务。 | | 339 | | #define ACL_ERROR_RT_CAPTURE_DEPENDENCY 107024 | 基于捕获方式构建模型运行实例时，event wait任务没有对应的event record任务。 | 调用aclrtRecordEvent接口增加event record任务。 | |
| 340 | -| #define ACL_ERROR_RT_STREAM_UNJOINED 107025 | 跨流依赖场景下，由于捕获模型包含未合并到原始Stream的其它Stream，导致其它Stream报错。 | - 报错的Stream中最后一个任务不是event record任务。在报错Stream的最后插入一个可以合并到原始Stream的event record任务（调用aclrtRecordEvent接口）。<br> - 最后一个event record任务没有对应的event wait任务。在非报错的Stream上插入一个event wait任务（调用aclrtStreamWaitEvent接口），确保该event wait任务可以使其它Stream合并到原始Stream上。 | | 340 | +| #define ACL_ERROR_RT_STREAM_UNJOINED 107025 | 跨流捕获场景下，子流的最后一个任务不是event record任务，或者子流的最后一个event record任务没有对应的event wait任务，或者子流没有返回到主流。 | - 子流的最后一个任务不是event record任务。在报错的子流最后下发一个event record任务（调用aclrtRecordEvent接口）。<br> - 子流的最后一个event record任务没有对应的event wait任务。在非报错的Stream上下发一个event wait任务（调用aclrtStreamWaitEvent接口）。<br> - 子流没有返回到主流。通过合理下发event record和event wait任务，使子流返回到主流。 | |
| 341 | | #define ACL_ERROR_RT_MODEL_CAPTURED 107026 | 模型已经处于捕获状态。 | 先调用aclmdlRICaptureEnd接口结束捕获，再执行对应的操作。 | | 341 | | #define ACL_ERROR_RT_MODEL_CAPTURED 107026 | 模型已经处于捕获状态。 | 先调用aclmdlRICaptureEnd接口结束捕获，再执行对应的操作。 | |
| 342 | | #define ACL_ERROR_RT_STREAM_CAPTURED 107027 | Stream已经处于捕获状态。 | 先调用aclmdlRICaptureEnd接口结束捕获，再执行对应的操作。 | | 342 | | #define ACL_ERROR_RT_STREAM_CAPTURED 107027 | Stream已经处于捕获状态。 | 先调用aclmdlRICaptureEnd接口结束捕获，再执行对应的操作。 | |
| 343 | | #define ACL_ERROR_RT_EVENT_CAPTURED 107028 | Event已经处于捕获状态。 | 先调用aclmdlRICaptureEnd接口结束捕获，再执行对应的操作。 | | 343 | | #define ACL_ERROR_RT_EVENT_CAPTURED 107028 | Event已经处于捕获状态。 | 先调用aclmdlRICaptureEnd接口结束捕获，再执行对应的操作。 | |
| @@ -242,7 +242,7 @@ void ErrorcodeManage::InitRtErrCodeMap() | |||
| 242 | rtErrMap_[RT_ERROR_MODULE_NULL] = {ACL_ERROR_RT_INTERNAL_ERROR, "module pointer null"}; | 242 | rtErrMap_[RT_ERROR_MODULE_NULL] = {ACL_ERROR_RT_INTERNAL_ERROR, "module pointer null"}; |
| 243 | rtErrMap_[RT_ERROR_MODULE_NEW] = {ACL_ERROR_RT_MEMORY_ALLOCATION, "Failed to create the module object. The host memory has been exhausted."}; | 243 | rtErrMap_[RT_ERROR_MODULE_NEW] = {ACL_ERROR_RT_MEMORY_ALLOCATION, "Failed to create the module object. The host memory has been exhausted."}; |
| 244 | rtErrMap_[RT_ERROR_STREAM_UNJOINED] = {ACL_ERROR_RT_STREAM_UNJOINED, | 244 | rtErrMap_[RT_ERROR_STREAM_UNJOINED] = {ACL_ERROR_RT_STREAM_UNJOINED, |
| 245 | - "capture model contains a stream that was not joined to the original stream"}; | 245 | + "capture model contains a stream that was not joined to the origin stream"}; |
| 246 | rtErrMap_[RT_ERROR_MODEL_CAPTURED] = {ACL_ERROR_RT_MODEL_CAPTURED, "model is captured"}; | 246 | rtErrMap_[RT_ERROR_MODEL_CAPTURED] = {ACL_ERROR_RT_MODEL_CAPTURED, "model is captured"}; |
| 247 | rtErrMap_[RT_ERROR_MODEL_CAPTURE_STATUS] = {ACL_ERROR_RT_INTERNAL_ERROR, "model status error"}; | 247 | rtErrMap_[RT_ERROR_MODEL_CAPTURE_STATUS] = {ACL_ERROR_RT_INTERNAL_ERROR, "model status error"}; |
| 248 | rtErrMap_[RT_ERROR_MODEL_RUNNING] = {ACL_ERROR_RT_MODEL_RUNNING, "model is running"}; | 248 | rtErrMap_[RT_ERROR_MODEL_RUNNING] = {ACL_ERROR_RT_MODEL_RUNNING, "model is running"}; |
| @@ -337,7 +337,11 @@ rtError_t Context::CheckCaptureModelValidity(Model * const captureMdl) const | |||
| 337 | 337 | ||
| 338 | bool isOnlyOrigStream = true; | 338 | bool isOnlyOrigStream = true; |
| 339 | bool hasRecordOrigStream = false; | 339 | bool hasRecordOrigStream = false; |
| 340 | + int32_t origStreamId = -1; | ||
| 340 | for (auto it = streams.begin(); it != streams.end(); it++) { | 341 | for (auto it = streams.begin(); it != streams.end(); it++) { |
| 342 | + if ((*it)->IsOrigCaptureStream()) { | ||
| 343 | + origStreamId = (*it)->Id_(); | ||
| 344 | + } | ||
| 341 | if (((*it)->IsOrigCaptureStream()) || | 345 | if (((*it)->IsOrigCaptureStream()) || |
| 342 | ((*it)->IsLastLevelCaptureStream() == false) || | 346 | ((*it)->IsLastLevelCaptureStream() == false) || |
| 343 | (mdl->IsAddStream(*it))) { | 347 | (mdl->IsAddStream(*it))) { |
| @@ -355,20 +359,29 @@ rtError_t Context::CheckCaptureModelValidity(Model * const captureMdl) const | |||
| 355 | RT_ERROR_EVENT_NULL, | 359 | RT_ERROR_EVENT_NULL, |
| 356 | "No event object, stream_id=%d, task_id=%u.", | 360 | "No event object, stream_id=%d, task_id=%u.", |
| 357 | streamId, taskId); | 361 | streamId, taskId); |
| 358 | - COND_RETURN_ERROR((event->GetEventFlag() == RT_EVENT_EXTERNAL), | 362 | + COND_RETURN_AND_MSG_OUTER((event->GetEventFlag() == RT_EVENT_EXTERNAL), |
| 359 | - RT_ERROR_STREAM_UNJOINED, | 363 | + RT_ERROR_STREAM_UNJOINED, ErrorCode::EE1017, |
| 360 | - "The event flag is external, stream_id=%d, task_id=%u, event_id=%d.", | 364 | + "Capture model validity check", "capture model", |
| 361 | - streamId, taskId, event->EventId_()); | 365 | + RtFmtMsg("In the cross-stream capture scenario, the last task (task_id=%u) on the sub stream " |
| 362 | - COND_RETURN_ERROR((event->IsCaptureStreamWaited() == false), | 366 | + "(stream_id=%d) is not an event record task. Call aclrtRecordEvent on the sub stream to " |
| 363 | - RT_ERROR_STREAM_UNJOINED, | 367 | + "deliver an event record task", |
| 364 | - "A free-state event record task was discovered, stream_id=%d, task_id=%u, event_id=%d.", | 368 | + taskId, streamId)); |
| 365 | - streamId, taskId, event->EventId_()); | 369 | + COND_RETURN_AND_MSG_OUTER((event->IsCaptureStreamWaited() == false), |
| 370 | + RT_ERROR_STREAM_UNJOINED, ErrorCode::EE1017, | ||
| 371 | + "Capture model validity check", "capture model", | ||
| 372 | + RtFmtMsg("In the cross-stream capture scenario, the last task (task_id=%u, event_id=%d) on the sub " | ||
| 373 | + "stream (stream_id=%d) lacks the corresponding event wait task", | ||
| 374 | + taskId, event->EventId_(), streamId)); | ||
| 366 | if (event->IsRecordOrigCaptureStream(*it)) { | 375 | if (event->IsRecordOrigCaptureStream(*it)) { |
| 367 | hasRecordOrigStream = true; | 376 | hasRecordOrigStream = true; |
| 368 | } | 377 | } |
| 369 | } | 378 | } |
| 370 | - COND_RETURN_ERROR(((isOnlyOrigStream == false) && (hasRecordOrigStream == false)), RT_ERROR_STREAM_UNJOINED, | 379 | + COND_RETURN_AND_MSG_OUTER(((isOnlyOrigStream == false) && (hasRecordOrigStream == false)), |
| 371 | - "capture model contains a stream that was not joined to the original stream."); | 380 | + RT_ERROR_STREAM_UNJOINED, ErrorCode::EE1017, |
| 381 | + "Capture model validity check", "capture model", | ||
| 382 | + RtFmtMsg("In the cross-stream capture scenario, the origin stream (stream_id=%u) has no event wait task, " | ||
| 383 | + "indicating that the sub stream is not joined back to the origin stream", | ||
| 384 | + static_cast<uint32_t>(origStreamId))); | ||
| 372 | return RT_ERROR_NONE; | 385 | return RT_ERROR_NONE; |
| 373 | } | 386 | } |
| 374 | 387 | ||
| @@ -12,6 +12,7 @@ | |||
| 12 | 12 | ||
| 13 | 13 | ||
| 14 | 14 | ||
| 15 | + | ||
| 15 | namespace cce { | 16 | namespace cce { |
| 16 | namespace runtime { | 17 | namespace runtime { |
| 17 | 18 | ||
| @@ -46,10 +47,13 @@ rtError_t GetCaptureEventFromTask(const Device * const dev, uint32_t streamId, u | |||
| 46 | COND_RETURN_ERROR((task == nullptr), | 47 | COND_RETURN_ERROR((task == nullptr), |
| 47 | RT_ERROR_TASK_NULL, | 48 | RT_ERROR_TASK_NULL, |
| 48 | "Get task failed, stream_id=%u, task_id=%u.", streamId, pos); | 49 | "Get task failed, stream_id=%u, task_id=%u.", streamId, pos); |
| 49 | - COND_RETURN_ERROR_MSG_INNER(!((task->type == TS_TASK_TYPE_EVENT_RECORD) || (task->type == TS_TASK_TYPE_CAPTURE_RECORD)), | 50 | + COND_RETURN_AND_MSG_OUTER(!((task->type == TS_TASK_TYPE_EVENT_RECORD) || (task->type == TS_TASK_TYPE_CAPTURE_RECORD)), |
| 50 | - RT_ERROR_STREAM_UNJOINED, | 51 | + RT_ERROR_STREAM_UNJOINED, ErrorCode::EE1017, |
| 51 | - "The type of the task is not event record nor capture record, stream_id=%u, task_id=%u, task_type=%d (%s).", | 52 | + "Capture model validity check", "capture model", |
| 52 | - streamId, pos, static_cast<int32_t>(task->type), task->typeName); | 53 | + RtFmtMsg("In the cross-stream capture scenario, the last task (task_id=%u) on the sub stream " |
| 54 | + "(stream_id=%u) is not an event record task. Call aclrtRecordEvent on the sub stream to " | ||
| 55 | + "deliver an event record task", | ||
| 56 | + pos, streamId)); | ||
| 53 | if (task->type == TS_TASK_TYPE_EVENT_RECORD) { | 57 | if (task->type == TS_TASK_TYPE_EVENT_RECORD) { |
| 54 | eventPtr = task->u.eventRecordTaskInfo.event; | 58 | eventPtr = task->u.eventRecordTaskInfo.event; |
| 55 | } else { | 59 | } else { |
| @@ -15,6 +15,7 @@ | |||
| 15 | 15 | ||
| 16 | 16 | ||
| 17 | 17 | ||
| 18 | + | ||
| 18 | 19 | ||
| 19 | namespace cce { | 20 | namespace cce { |
| 20 | namespace runtime { | 21 | namespace runtime { |
| @@ -44,10 +45,13 @@ rtError_t GetCaptureEventFromTask(const Device * const dev, uint32_t streamId, u | |||
| 44 | COND_RETURN_ERROR((taskInfo == nullptr), | 45 | COND_RETURN_ERROR((taskInfo == nullptr), |
| 45 | RT_ERROR_TASK_NULL, | 46 | RT_ERROR_TASK_NULL, |
| 46 | "Failed to get task, stream_id=%u, task_id=%u.", streamId, pos); | 47 | "Failed to get task, stream_id=%u, task_id=%u.", streamId, pos); |
| 47 | - COND_RETURN_ERROR(!((taskInfo->type == TS_TASK_TYPE_DAVID_EVENT_RECORD) || (taskInfo->type ==TS_TASK_TYPE_CAPTURE_RECORD)), | 48 | + COND_RETURN_AND_MSG_OUTER(!((taskInfo->type == TS_TASK_TYPE_DAVID_EVENT_RECORD) || (taskInfo->type ==TS_TASK_TYPE_CAPTURE_RECORD)), |
| 48 | - RT_ERROR_STREAM_UNJOINED, | 49 | + RT_ERROR_STREAM_UNJOINED, ErrorCode::EE1017, |
| 49 | - "Failed to get capture event from task, the last task type is not event record, stream_id=%u, task_id=%u.", | 50 | + "Capture model validity check", "capture model", |
| 50 | - streamId, pos); | 51 | + RtFmtMsg("In the cross-stream capture scenario, the last task (task_id=%u) on the sub stream " |
| 52 | + "(stream_id=%u) is not an event record task. Call aclrtRecordEvent on the sub stream to " | ||
| 53 | + "deliver an event record task", | ||
| 54 | + pos, streamId)); | ||
| 51 | if (taskInfo->type == TS_TASK_TYPE_DAVID_EVENT_RECORD) { | 55 | if (taskInfo->type == TS_TASK_TYPE_DAVID_EVENT_RECORD) { |
| 52 | eventPtr = taskInfo->u.davidEventRecordTaskInfo.event; | 56 | eventPtr = taskInfo->u.davidEventRecordTaskInfo.event; |
| 53 | } else { | 57 | } else { |