Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

ibv_query_port (3)

Name

ibv_query_port - query an RDMA port's attributes

Synopsis

#include <infiniband/verbs.h>

int ibv_query_port(struct ibv_context *context, uint8_t port_num,
struct ibv_port_attr *port_attr);

Description

Libibverbs Programmer's Manual                               IBV_QUERY_PORT(3)



NAME
       ibv_query_port - query an RDMA port's attributes

SYNOPSIS
       #include <infiniband/verbs.h>

       int ibv_query_port(struct ibv_context *context, uint8_t port_num,
                          struct ibv_port_attr *port_attr);

DESCRIPTION
       ibv_query_port()  returns  the  attributes  of port port_num for device
       context context through the pointer port_attr.  The argument  port_attr
       is an ibv_port_attr struct, as defined in <infiniband/verbs.h>.

       struct ibv_port_attr {
               enum ibv_port_state     state;          /* Logical port state */
               enum ibv_mtu            max_mtu;        /* Max MTU supported by port */
               enum ibv_mtu            active_mtu;     /* Actual MTU */
               int                     gid_tbl_len;    /* Length of source GID table */
               uint32_t                port_cap_flags; /* Port capabilities */
               uint32_t                max_msg_sz;     /* Maximum message size */
               uint32_t                bad_pkey_cntr;  /* Bad P_Key counter */
               uint32_t                qkey_viol_cntr; /* Q_Key violation counter */
               uint16_t                pkey_tbl_len;   /* Length of partition table */
               uint16_t                lid;            /* Base port LID */
               uint16_t                sm_lid;         /* SM LID */
               uint8_t                 lmc;            /* LMC of LID */
               uint8_t                 max_vl_num;     /* Maximum number of VLs */
               uint8_t                 sm_sl;          /* SM service level */
               uint8_t                 subnet_timeout; /* Subnet propagation delay */
               uint8_t                 init_type_reply;/* Type of initialization performed by SM */
               uint8_t                 active_width;   /* Currently active link width */
               uint8_t                 active_speed;   /* Currently active link speed */
               uint8_t                 phys_state;     /* Physical port state */
               uint8_t                 link_layer;     /* link layer protocol of the port */
       };

       possible values for the link layer field are IBV_LINK_LAYER_INFINIBAND,
       IBV_LINK_LAYER_ETHERNET, or IBV_LINK_LAYER_UNSPECIFIED.


RETURN VALUE
       ibv_query_port() returns 0 on success, or the value of errno on failure
       (which indicates the failure reason).


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


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+

SEE ALSO
       ibv_create_qp(3), ibv_destroy_qp(3), ibv_query_qp(3), ibv_create_ah(3)

AUTHORS
       Dotan Barak <dotanba@gmail.com>



NOTES
       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-
       code-downloads.html.

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source   was   downloaded   from    ['https://www.openfabrics.org/down-
       loads/ibutils/ibutils-1.5.7-0.2.gbd7e502.tar.gz', 'https://www.openfab-
       rics.org/downloads/libibverbs/libibverbs-1.1.8.tar.gz',
       'https://www.openfabrics.org/downloads/libmlx4/libmlx4-1.0.6.tar.gz',
       'https://www.openfabrics.org/downloads/libsdp/lib-
       sdp-1.1.108-0.15.gd7fdb72.tar.gz',   'https://www.openfabrics.org/down-
       loads/management/infiniband-diags-1.6.5.tar.gz',  'https://www.openfab-
       rics.org/downloads/management/libibmad-1.3.12.tar.gz',
       'https://www.openfabrics.org/downloads/management/libibu-
       mad-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.open-
       fabrics.org/downloads/qperf/qperf-0.4.9.tar.gz',  'https://www.openfab-
       rics.org/downloads/rdmacm/librdmacm-1.0.21.tar.gz',  'https://www.open-
       fabrics.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_QUERY_PORT(3)