mlx5dv_dump(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| RETURN VALUE \| AUTHOR \| COLOPHON

MLX5DV_DUMP API(3)       mlx5 Programmer’s Manual      MLX5DV_DUMP API(3)

NAME top

       mlx5dv_dump_dr_domain - Dump DR Domain

       mlx5dv_dump_dr_table - Dump DR Table

       mlx5dv_dump_dr_matcher - Dump DR Matcher

       mlx5dv_dump_dr_rule - Dump DR Rule

SYNOPSIS top

              #include <infiniband/mlx5dv.h>

              int mlx5dv_dump_dr_domain(FILE *fout, struct mlx5dv_dr_domain *domain);
              int mlx5dv_dump_dr_table(FILE *fout, struct mlx5dv_dr_table *table);
              int mlx5dv_dump_dr_matcher(FILE *fout, struct mlx5dv_dr_matcher *matcher);
              int mlx5dv_dump_dr_rule(FILE *fout, struct mlx5dv_dr_rule *rule);

DESCRIPTION top

       The Dump API (mlx5dv_dump_*) allows the dumping of the existing
       rdma-core resources to the provided file.  The output file format
       is vendor specific.

       mlx5dv_dump_dr_domain() dumps a DR Domain object properties to a
       specified file.

       mlx5dv_dump_dr_table() dumps a DR Table object properties to a
       specified file.

       mlx5dv_dump_dr_matcher() dumps a DR Matcher object properties to a
       specified file.

       mlx5dv_dump_dr_rule() dumps a DR Rule object properties to a
       specified file.

RETURN VALUE top

       The API calls returns 0 on success, or the value of errno on
       failure (which indicates the failure reason).  The calls are
       blocking - function returns only when all related resources info
       is written to the file.

AUTHOR top

       Yevgeny Kliteynik ⟨kliteyn@mellanox.com⟩ Muhammad Sammar
       ⟨muhammads@mellanox.com⟩

COLOPHON top

       This page is part of the rdma-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 is not part of the original manual page), send a mail to
       man-pages@man7.org

mlx5                            2019-11-18             MLX5DV_DUMP API(3)