contrib/ofed/librdmacm/man/rdma_resolve_addr.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_RESOLVE_ADDR" 3 "2007-10-31" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_resolve_addr \- Resolve destination and optional source addresses.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_resolve_addr
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "struct sockaddr *" src_addr ","
  11 .BI "struct sockaddr *" dst_addr ","
  12 .BI "int " timeout_ms ");"
  13 .SH ARGUMENTS
  14 .IP "id" 12
  15 RDMA identifier.
  16 .IP "src_addr" 12
  17 Source address information.  This parameter may be NULL.
  18 .IP "dst_addr" 12
  19 Destination address information.
  20 .IP "timeout_ms" 12
  21 Time to wait for resolution to complete.
  22 .SH "DESCRIPTION"
  23 Resolve destination and optional source addresses from IP addresses
  24 to an RDMA address.  If successful, the specified rdma_cm_id will
  25 be bound to a local device.
  26 .SH "RETURN VALUE"
  27 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  28 set to indicate the failure reason.
  29 .SH "NOTES"
  30 This call is used to map a given destination IP address to a usable RDMA
  31 address.  The IP to RDMA address mapping is done using the local routing
  32 tables, or via ARP.
  33 If a source address is given, the rdma_cm_id is bound to that
  34 address, the same as if rdma_bind_addr were called.  If no source
  35 address is given, and the rdma_cm_id has not yet been bound to a device,
  36 then the rdma_cm_id will be bound to a source address based on the
  37 local routing tables.  After this call, the rdma_cm_id will be bound to
  38 an RDMA device.  This call is typically made from the active side of a
  39 connection before calling rdma_resolve_route and rdma_connect.
  40 .SH "INFINIBAND SPECIFIC"
  41 This call maps the destination and, if given, source IP addresses to GIDs.
  42 In order to perform the mapping, IPoIB must be running on both the local
  43 and remote nodes.
  44 .SH "SEE ALSO"
  45 rdma_create_id(3), rdma_resolve_route(3), rdma_connect(3), rdma_create_qp(3),
  46 rdma_get_cm_event(3), rdma_bind_addr(3), rdma_get_src_port(3),
  47 rdma_get_dst_port(3), rdma_get_local_addr(3), rdma_get_peer_addr(3)