oneapi-src / oneapi-src/level-zero

zesDriverEventListen[Ex] timeout return code

Open
#63 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
335
Forks
140
Avg merge
12h 32m
Merged PRs (30d)
5

Description

I suggest adding an explicit timeout return code for zesDriverEventListen[Ex] calls. Right now, the user has to infer a timeout occurred when ze_result_t == ZE_SUCCESS and pNumDeviceEvents = 0. The specification isn't 100% clear that a timeout will result in the pNumDeviceEvents being cleared. An explicit error code leaves no doubt. The spec is also ambitious in stating that the timeout will only occur once the time expires. It seems like an -EINTR or similar type error could cause a timeout to occur before the time expires. Perhaps the spec should allow for a timeout to occur before the time expires?

https://spec.oneapi.com/level-zero/latest/sysman/api.html#zesdrivereventlistenex

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the zesDriverEventListen[Ex] specification section linked in the issue and review its current timeout and return-code wording. Determine whether an explicit timeout result and behavior before the requested time expires are intended, then document the agreed API semantics; done means the specification is unambiguous and the change has maintainer agreement.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.