Movatterモバイル変換

mlx5dv_devx_get_event(3) — Linux manual page

mlx5dv_devx_get_event(3)mlx5dv_devx_get_event(3)

NAME        top

       mlx5dv_devx_get_event - Get an asynchronous event.

SYNOPSIS        top

              #include <infiniband/mlx5dv.h>              struct mlx5dv_devx_async_event_hdr {                  uint64_t    cookie;                  uint8_t     out_data[];              };              ssize_t mlx5dv_devx_get_event(struct mlx5dv_devx_event_channel *event_channel,                                            struct mlx5dv_devx_async_event_hdr *event_data,                                            size_t event_resp_len)

DESCRIPTION        top

       Get a device event on the givenevent_channel.  Post a successful       subscription over the event channel by calling to       mlx5dv_devx_subscribe_devx_event() the application should use this       API to get the response once an event has occurred.       Upon response thecookie that was supplied upon the subscription       is returned and theout_data includes the data itself.  Theout_data may be omitted in case the channel was created with the       omit data flag.       The application must supply a large enough buffer to hold the       event according to the device specification, the buffer size is       given by the inputevent_resp_len parameter.

ARGUMENTS        top

event_channel              The channel to get the event over.event_data              The output data from the asynchronous event.event_resp_len              The output buffer size to hold the response.

RETURN VALUE        top

       Upon successmlx5dv_devx_get_event will return the number of bytes       read, otherwise -1 will be returned and errno was set.

NOTES        top

       In case theevent_channel was created with the omit data flag,       events having the same type may be combined per subscription and       be reported once with the matchingcookie.  In that mode of work,       ordering is not preserved between those events to other on this       channel.       On the other hand, when each event should hold the device data       ordering is preserved, however, events might be loose as of lack       of kernel memory, in that case EOVERFLOW will be reported.

SEE ALSO        top

mlx5dv_open_device(3),mlx5dv_devx_subscribe_devx_event(3)       #AUTHOR       Yishai Hadas ⟨yishaih@mellanox.com⟩

COLOPHON        top

       This page is part of therdma-core (RDMA Core Userspace Libraries       and Daemons) project.  Information about the project can be found       at ⟨https://github.com/linux-rdma/rdma-core⟩.  If you have a bug       report for this manual page, send it to       linux-rdma@vger.kernel.org.  This page was obtained from the       project's upstream Git repository       ⟨https://github.com/linux-rdma/rdma-core.git⟩ on 2025-08-11.  (At       that time, the date of the most recent commit that was found in       the repository was 2025-08-04.)  If you discover any rendering       problems in this HTML version of the page, or you believe there is       a better or more up-to-date source for the page, or you have       corrections or improvements to the information in this COLOPHON       (which isnot part of the original manual page), send a mail to       man-pages@man7.orgmlx5dv_devx_get_event(3)

HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH.