Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_get_device_list (3)

Name

ibv_get_device_list - get and release list of available RDMA devices

Synopsis

#include <infiniband/verbs.h>

struct ibv_device **ibv_get_device_list(int *num_devices);

void ibv_free_device_list(struct ibv_device **list);

Description

Libibverbs Programmer's Manual                          IBV_GET_DEVICE_LIST(3)



NAME
       ibv_get_device_list,  ibv_free_device_list  -  get  and release list of
       available RDMA devices

SYNOPSIS
       #include <infiniband/verbs.h>

       struct ibv_device **ibv_get_device_list(int *num_devices);

       void ibv_free_device_list(struct ibv_device **list);

DESCRIPTION
       ibv_get_device_list() returns a NULL-terminated array of  RDMA  devices
       currently  available.   The  argument  num_devices  is optional; if not
       NULL, it is set to the number of devices returned in the array.

       ibv_free_device_list() frees the array  of  devices  list  returned  by
       ibv_get_device_list().

RETURN VALUE
       ibv_get_device_list()  returns  the array of available RDMA devices, or
       sets errno and returns NULL if the request fails.  If  no  devices  are
       found then num_devices is set to 0, and non-NULL is returned.

       ibv_free_device_list() returns no value.

ERRORS
       EPERM  Permission denied.

       ENOSYS No kernel support for RDMA.

       ENOMEM Insufficient memory to complete the operation.


ATTRIBUTES
       See attributes(7) for descriptions of the following attributes:


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
NOTES
       Client  code  should  open  all  the  devices  it  intends  to use with
       ibv_open_device() before calling ibv_free_device_list().  Once it frees
       the  array with ibv_free_device_list(), it will be able to use only the
       open devices; pointers to unopened devices will no longer be valid.

SEE ALSO
       ibv_fork_init(3),    ibv_get_device_name(3),    ibv_get_device_guid(3),
       ibv_open_device(3)

AUTHORS
       Dotan Barak <dotanba@gmail.com>


              This    software    was   built   from   source   available   at
              https://github.com/oracle/solaris-userland.  The original commu-
              nity   source   was   downloaded   from   ['https://www.openfab-
              rics.org/downloads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz',
              'https://www.openfabrics.org/downloads/libibverbs/libib-
              verbs-1.1.8.tar.gz',          'https://www.openfabrics.org/down-
              loads/libmlx4/libmlx4-1.0.6.tar.gz',       'https://www.openfab-
              rics.org/downloads/libsdp/libsdp-1.1.108-0.15.gd7fdb72.tar.gz',
              'https://www.openfabrics.org/downloads/management/infiniband-
              diags-1.6.5.tar.gz', 'https://www.openfabrics.org/downloads/man-
              agement/libibmad-1.3.12.tar.gz',           'https://www.openfab-
              rics.org/downloads/management/libibumad-1.3.10.2.tar.gz',
              'https://www.openfabrics.org/downloads/manage-
              ment/opensm-3.3.19.tar.gz',   'https://www.openfabrics.org/down-
              loads/perftest/perftest-1.3.0-0.42.gf350d3d.tar.gz',
              'https://www.openfabrics.org/down-
              loads/qperf/qperf-0.4.9.tar.gz',           'https://www.openfab-
              rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',
              'https://www.openfabrics.org/downloads/rds-tools/rds-
              tools-2.0.4.tar.gz']

              Further information about this software can be found on the open
              source community website at http://www.openfabrics.org/.



libibverbs                        2006-10-31            IBV_GET_DEVICE_LIST(3)