Go to main content

man pages section 3: Library Interfaces and Headers

Exit Print View

Updated: Thursday, June 13, 2019
 
 

ibv_reg_mr (3)

Name

ibv_reg_mr - register or deregister a memory region (MR)

Synopsis

#include <infiniband/verbs.h>

struct ibv_mr *ibv_reg_mr(struct ibv_pd *pd, void *addr,
size_t length, int access);

int ibv_dereg_mr(struct ibv_mr *mr);

Description

Libibverbs Programmer's Manual                                   IBV_REG_MR(3)



NAME
       ibv_reg_mr, ibv_dereg_mr - register or deregister a memory region (MR)

SYNOPSIS
       #include <infiniband/verbs.h>

       struct ibv_mr *ibv_reg_mr(struct ibv_pd *pd, void *addr,
                                 size_t length, int access);

       int ibv_dereg_mr(struct ibv_mr *mr);

DESCRIPTION
       ibv_reg_mr() registers a memory region (MR) associated with the protec-
       tion domain pd.  The MR's starting address is  addr  and  its  size  is
       length.   The  argument  access describes the desired memory protection
       attributes; it is either 0 or the bitwise OR of one or more of the fol-
       lowing flags:

       IBV_ACCESS_LOCAL_WRITE  Enable Local Write Access

       IBV_ACCESS_REMOTE_WRITE  Enable Remote Write Access

       IBV_ACCESS_REMOTE_READ Enable Remote Read Access

       IBV_ACCESS_REMOTE_ATOMIC Enable Remote Atomic Operation Access (if sup-
       ported)

       IBV_ACCESS_MW_BIND Enable Memory Window Binding

       If IBV_ACCESS_REMOTE_WRITE or  IBV_ACCESS_REMOTE_ATOMIC  is  set,  then
       IBV_ACCESS_LOCAL_WRITE must be set too.

       Local read access is always enabled for the MR.

       ibv_dereg_mr() deregisters the MR mr.

RETURN VALUE
       ibv_reg_mr()  returns  a  pointer  to the registered MR, or NULL if the
       request fails.  The local key (L_Key) field lkey is used  as  the  lkey
       field of struct ibv_sge when posting buffers with ibv_post_* verbs, and
       the the remote key (R_Key) field rkey is used by  remote  processes  to
       perform  Atomic  and  RDMA  operations.  The remote process places this
       rkey  as  the  rkey  field  of  struct  ibv_send_wr   passed   to   the
       ibv_post_send function.

       ibv_dereg_mr()  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 |
       +---------------+-----------------------+
NOTES
       ibv_dereg_mr() fails if any memory window is still bound to this MR.

SEE ALSO
       ibv_alloc_pd(3),          ibv_post_send(3),           ibv_post_recv(3),
       ibv_post_srq_recv(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_REG_MR(3)