Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_register_sm_events (3)

Name

ibv_register_sm_events - isters the specified subnet events for the specified GID(s).

Synopsis

#include <infiniband/verbs.h>

int ibv_register_sm_events(struct ibv_context *context,
ibv_sm_event_type_t event, int gid_num, union ibv_gid *gids)

int ibv_unregister_sm_events(struct ibv_context *context,
ibv_sm_event_type_t event, int gid_num, union ibv_gid *gids)
context: Device context

event: Logical OR of events to register for, valid values are:

IBV_SM_EVENT_MGID
Request notification of Multicast GID events

IBV_SM_EVENT_UGID
Request notification of Unicast GID events

IBV_SM_EVENT_UGID_ALL
Request notification of ALL Unicast GID events

IBV_SM_EVENT_MGID_ALL
Request notification of ALL Multicast GID events

IBV_SM_EVENT_ALL
Request notification of ALL Multicast and Unicast GID events

gid_num:
0 or the number of gids in the array of gids pointed to by gids.

gids:  NULL, or an array of GIDS.

Description

Libibverbs Programmer's Manual                       IBV_REGISTER_SM_EVENTS(3)



NAME
       ibv_register_sm_events,  ibv_unregister_sm_events - registers or unreg-
       isters the specified subnet events for the specified GID(s).


SYNOPSIS
       #include <infiniband/verbs.h>

       int ibv_register_sm_events(struct ibv_context *context,
       ibv_sm_event_type_t event, int gid_num, union ibv_gid *gids)

       int ibv_unregister_sm_events(struct ibv_context *context,
       ibv_sm_event_type_t event, int gid_num, union ibv_gid *gids)
       context: Device context

       event: Logical OR of events to register for, valid values are:

            IBV_SM_EVENT_MGID
                        Request notification of Multicast GID events

            IBV_SM_EVENT_UGID
                        Request notification of Unicast GID events

            IBV_SM_EVENT_UGID_ALL
                        Request notification of ALL Unicast GID events

            IBV_SM_EVENT_MGID_ALL
                        Request notification of ALL Multicast GID events

            IBV_SM_EVENT_ALL
                        Request notification of ALL Multicast and Unicast GID events

       gid_num:
              0 or the number of gids in the array of gids pointed to by gids.

       gids:  NULL, or an array of GIDS.


DESCRIPTION
       ibv_register_sm_events() registers for the specified subnet events  for
       the  specified  GID(s).  ibv_unregister_sm_events() unregisters for the
       specified subnet events for the  specified  GID(s).  These  events  are
       delivered  on  the async fd (see ibv_get_async_event(3)), from a previ-
       ously opened device (see ibv_open_device()). It is  only  necessary  to
       call  ibv_register_sm_events()  on  a  single  device connected to each
       unique fabric, partition. For example, if a node has 4 HCAs attached to
       the  same fabric, with all ports in the same partition, then it is only
       necessary to call ibv_register_sm_events() on one of them.


       The following ibv_event_type events can be passed to
              ibv_register_sm_events():

            IBV_EVENT_MCG_CREATED
                     An  MCG  specified  by  the  new  "gid"  member  of   the
                     ibv_async_event struct has been created.

            IBV_EVENT_MCG_DELETED
                     The   MCG   specified   by   the   "gid"  member  of  the
                     ibv_async_event struct has been deleted.

            IBV_EVENT_GID_AVAIL
                     The  GID  specified  by   the   "gid"   member   of   the
                     ibv_async_event struct is available on this subnet.

            IBV_EVENT_GID_UNAVAIL
                     The   GID   specified   by   the   "gid"  member  of  the
                     ibv_async_event struct is no  longer  available  on  this
                     subnet.


RETURN VALUE
       ibv_register_sm_events(),  ibv_unregister_sm_events() returns 0 on suc-
       cess, and -1 on error.


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


       +---------------+-----------------------+
       |ATTRIBUTE TYPE |   ATTRIBUTE VALUE     |
       +---------------+-----------------------+
       |Availability   | network/open-fabrics  |
       +---------------+-----------------------+
       |Stability      | Pass-through volatile |
       +---------------+-----------------------+
NOTES
       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                        2012-08-08         IBV_REGISTER_SM_EVENTS(3)