📦 rdma-core-doc

C

• check_lft_balance(8)check InfiniBand unicast forwarding tables balance✨
• cmtime(1)RDMA CM connection steps timing test.✨

D

• dump_fts(8)dump InfiniBand forwarding tables✨
• dump_lfts(8)dump InfiniBand forwarding tables✨
• dump_mfts(8)dump InfiniBand forwarding tables✨

E

• efadv(7)Direct verbs for efa devices This provides low level access to efa devices to perform direct opera‐ tions, without general branching performed by libibverbs.✨
• efadv_create_driver_qp(3)Create EFA specific Queue Pair # SYNOPSIS #include <infiniband/efadv.h> struct ibv_qp *efadv_create_driver_qp(struct ibv_pd *ibvpd, struct ibv_qp_init_attr *attr, uint32_t driver_qp_type);✨
• efadv_create_qp_ex(3)Create EFA specific extended Queue Pair✨
• efadv_query_ah(3)Query EFA specific Address Handle attributes✨
• efadv_query_cq(3)Query EFA specific Completion Queue attributes✨
• efadv_query_device(3)Query device capabilities✨
• efadv_query_mr(3)Query EFA specific Memory Region attributes✨
• efadv_query_qp_wqs(3)Query EFA specific Queue Pair work queue attributes✨

H

• hnsdv(7)Direct verbs for hns devices✨
• hnsdv_create_qp(3)creates a HNS specific queue pair (QP)✨
• hnsdv_is_supported(3)Check whether an RDMA device implemented by the hns provider✨
• hnsdv_query_device(3)Query hns device specific attributes✨

I

• ib_acme(1)test and configuration utility for the IB ACM✨
• ibacm(7)InfiniBand communication management assistant✨
• ibacm(8)address and route resolution services for InfiniBand.✨
• ibacm_prov(7)InfiniBand communication management assistant provider interface✨
• ibaddr(8)query InfiniBand address(es)✨
• ibcacheedit(8)edit an ibnetdiscover cache✨
• ibccconfig(8)configure congestion control settings✨
• ibccquery(8)query congestion control settings/info✨
• ibfindnodesusing(8)find a list of end nodes which are routed through the specified switch and port✨
• ibhosts(8)show InfiniBand host nodes in topology✨
• ibidsverify(8)validate IB identifiers in subnet and report errors✨
• iblinkinfo(8)report link info for all links in the fabric✨
• ibnd_debug(3)initialize ibnetdiscover library.✨
• ibnd_destroy_fabric(3)initialize ibnetdiscover library.✨
• ibnd_discover_fabric(3)initialize ibnetdiscover library.✨
• ibnd_find_node_dr(3)given a fabric object find the node object within it which matches the guid or directed route specified.✨
• ibnd_find_node_guid(3)given a fabric object find the node object within it which matches the guid or directed route specified.✨
• ibnd_iter_nodes(3)given a fabric object and a function itterate over the nodes in the fabric.✨
• ibnd_iter_nodes_type(3)given a fabric object and a function itterate over the nodes in the fabric.✨
• ibnd_set_max_smps_on_wire(3)initialize ibnetdiscover library.✨
• ibnd_show_progress(3)initialize ibnetdiscover library.✨
• ibnetdiscover(8)discover InfiniBand topology✨
• ibnodes(8)show InfiniBand nodes in topology✨
• ibping(8)ping an InfiniBand address✨
• ibportstate(8)handle port (physical) state and link speed of an InfiniBand port✨
• ibqueryerrors(8)query and report IB port counters✨
• ibroute(8)query InfiniBand switch forwarding tables✨
• ibrouters(8)show InfiniBand router nodes in topology✨
• ibsrpdm(8)Discover SRP targets on an InfiniBand Fabric✨
• ibstat(8)query basic status of InfiniBand device(s)✨
• ibstatus(8)query basic status of InfiniBand device(s)✨
• ibswitches(8)show InfiniBand switch nodes in topology✨
• ibsysstat(8)system status on an InfiniBand address✨
• ibtracert(8)trace InfiniBand path✨
• ibv_ack_async_event(3)get or acknowledge asynchronous events✨
• ibv_ack_cq_events(3)get and acknowledge completion queue (CQ) events✨
• ibv_advise_mr(3)Gives advice or directions to the kernel about an ad‐ dress range belongs to a memory region (MR).✨
• ibv_alloc_dm(3)allocate or free a device memory buffer (DMs) and perform memory copy to or from it✨
• ibv_alloc_dmah(3)allocate a dma handle✨
• ibv_alloc_mw(3)allocate or deallocate a memory window (MW)✨
• ibv_alloc_null_mr(3)allocate a null memory region (MR)✨
• ibv_alloc_parent_domain(3)allocate and deallocate the parent domain object✨
• ibv_alloc_pd(3)allocate or deallocate a protection domain (PDs)✨
• ibv_alloc_td(3)allocate and deallocate thread domain object✨
• ibv_asyncwatch(1)display asynchronous events✨
• ibv_attach_counters_point_flow(3)attach individual counter definition to a flow object✨
• ibv_attach_mcast(3)attach and detach a queue pair (QPs) to/from a multicast group✨
• ibv_bind_mw(3)post a request to bind a type 1 memory window to a memory region✨
• ibv_close_device(3)open and close an RDMA device context✨
• ibv_close_xrcd(3)open or close an XRC protection domain (XRCDs)✨
• ibv_create_ah(3)create or destroy an address handle (AH)✨
• ibv_create_ah_from_wc(3)initialize or create an address handle (AH) from a work completion✨
• ibv_create_comp_channel(3)create or destroy a completion event channel✨
• ibv_create_counters(3)Create or destroy a counters handle✨
• ibv_create_cq(3)create or destroy a completion queue (CQ)✨
• ibv_create_cq_ex(3)create a completion queue (CQ)✨
• ibv_create_flow(3)create or destroy flow steering rules✨
• ibv_create_flow_action(3)Flow action esp for verbs✨
• ibv_create_qp(3)create or destroy a queue pair (QP)✨
• ibv_create_qp_ex(3)create or destroy a queue pair (QP)✨
• ibv_create_rwq_ind_table(3)create or destroy a Receive Work Queue Indirection Table (RWQ IND TBL).✨
• ibv_create_srq(3)create or destroy a shared receive queue (SRQ)✨
• ibv_create_srq_ex(3)create or destroy a shared receive queue (SRQ)✨
• ibv_create_wq(3)create or destroy a Work Queue (WQ).✨
• ibv_dealloc_dmah(3)allocate a dma handle✨
• ibv_dealloc_mw(3)allocate or deallocate a memory window (MW)✨
• ibv_dealloc_pd(3)allocate or deallocate a protection domain (PDs)✨
• ibv_dealloc_td(3)allocate and deallocate thread domain object✨
• ibv_dereg_mr(3)register or deregister a memory region (MR)✨
• ibv_destroy_ah(3)create or destroy an address handle (AH)✨
• ibv_destroy_comp_channel(3)create or destroy a completion event channel✨
• ibv_destroy_counters(3)Create or destroy a counters handle✨
• ibv_destroy_cq(3)create or destroy a completion queue (CQ)✨
• ibv_destroy_flow(3)create or destroy flow steering rules✨
• ibv_destroy_flow_action(3)Flow action esp for verbs✨
• ibv_destroy_qp(3)create or destroy a queue pair (QP)✨
• ibv_destroy_rwq_ind_table(3)create or destroy a Receive Work Queue Indirection Table (RWQ IND TBL).✨
• ibv_destroy_srq(3)create or destroy a shared receive queue (SRQ)✨
• ibv_destroy_wq(3)create or destroy a Work Queue (WQ).✨
• ibv_detach_mcast(3)attach and detach a queue pair (QPs) to/from a multicast group✨
• ibv_devices(1)list RDMA devices✨
• ibv_devinfo(1)query RDMA devices✨
• ibv_event_type_str(3)Return string describing event_type enum value ibv_node_type_str - Return string describing node_type enum value ibv_port_state_str - Return string describing port_state enum value✨
• ibv_fork_init(3)initialize libibverbs to support fork()✨
• ibv_free_device_list(3)get and release list of available RDMA devices✨
• ibv_free_dm(3)allocate or free a device memory buffer (DMs) and perform memory copy to or from it✨
• ibv_get_async_event(3)get or acknowledge asynchronous events✨
• ibv_get_cq_event(3)get and acknowledge completion queue (CQ) events✨
• ibv_get_device_guid(3)get an RDMA device’s GUID✨
• ibv_get_device_index(3)get an RDMA device index✨
• ibv_get_device_list(3)get and release list of available RDMA devices✨
• ibv_get_device_name(3)get an RDMA device’s name✨
• ibv_get_pkey_index(3)obtain the index in the P_Key table of a P_Key✨
• ibv_get_srq_num(3)return srq number associated with the given shared re‐ ceive queue (SRQ)✨
• ibv_import_device(3)import a device from a given command FD✨
• ibv_import_dm(3)import an DM from a given ibv_context ibv_unimport_dm - unimport an DM✨
• ibv_import_mr(3)import an MR from a given ibv_pd ibv_unimport_mr - unimport an MR✨
• ibv_import_pd(3)import a PD from a given ibv_context ibv_unimport_pd - unimport a PD✨
• ibv_inc_rkey(3)creates a new rkey from the given one✨
• ibv_init_ah_from_wc(3)initialize or create an address handle (AH) from a work completion✨
• ibv_is_fork_initialized(3)check if fork support (ibv_fork_init) is en‐ abled✨
• ibv_memcpy_from_dm(3)allocate or free a device memory buffer (DMs) and perform memory copy to or from it✨
• ibv_memcpy_to_dm(3)allocate or free a device memory buffer (DMs) and perform memory copy to or from it✨
• ibv_modify_cq(3)modify a completion queue (CQ)✨
• ibv_modify_flow_action(3)Flow action esp for verbs✨
• ibv_modify_qp(3)modify the attributes of a queue pair (QP)✨
• ibv_modify_qp_rate_limit(3)modify the send rate limits attributes of a queue pair (QP)✨
• ibv_modify_srq(3)modify attributes of a shared receive queue (SRQ)✨
• ibv_modify_wq(3)Modify a Work Queue (WQ).✨
• ibv_node_type_str(3)Return string describing event_type enum value ibv_node_type_str - Return string describing node_type enum value ibv_port_state_str - Return string describing port_state enum value✨
• ibv_open_device(3)open and close an RDMA device context✨
• ibv_open_qp(3)open a shareable queue pair (QP)✨
• ibv_open_xrcd(3)open or close an XRC protection domain (XRCDs)✨
• ibv_poll_cq(3)poll a completion queue (CQ)✨
• ibv_port_state_str(3)Return string describing event_type enum value ibv_node_type_str - Return string describing node_type enum value ibv_port_state_str - Return string describing port_state enum value✨
• ibv_post_recv(3)post a list of work requests (WRs) to a receive queue✨
• ibv_post_send(3)post a list of work requests (WRs) to a send queue✨
• ibv_post_srq_ops(3)perform on a special shared receive queue (SRQ) configuration manipulations✨
• ibv_post_srq_recv(3)post a list of work requests (WRs) to a shared receive queue (SRQ)✨
• ibv_query_device(3)query an RDMA device's attributes✨
• ibv_query_device_ex(3)query an RDMA device's attributes including extended device properties.✨
• ibv_query_ece(3)query ECE options.✨
• ibv_query_gid(3)query an InfiniBand port’s GID table✨
• ibv_query_gid_ex(3)Query an InfiniBand port’s GID table entry✨
• ibv_query_gid_table(3)query an InfiniBand device’s GID table✨
• ibv_query_pkey(3)query an InfiniBand port’s P_Key table✨
• ibv_query_port(3)query an RDMA port's attributes✨
• ibv_query_qp(3)get the attributes of a queue pair (QP)✨
• ibv_query_qp_data_in_order(3)check if qp data is guaranteed to be in or‐ der.✨
• ibv_query_rt_values_ex(3)query an RDMA device for some real time values✨
• ibv_query_srq(3)get the attributes of a shared receive queue (SRQ)✨
• ibv_rate_to_mbps(3)convert IB rate enumeration to Mbit/sec mbps_to_ibv_rate - convert Mbit/sec to an IB rate enumeration✨
• ibv_rate_to_mult(3)convert IB rate enumeration to multiplier of 2.5 Gbit/sec mult_to_ibv_rate - convert multiplier of 2.5 Gbit/sec to an IB rate enu‐ meration✨
• ibv_rc_pingpong(1)simple InfiniBand RC transport test✨
• ibv_read_counters(3)Read counter values✨
• ibv_reg_dm_mr(3)allocate or free a device memory buffer (DMs) and perform memory copy to or from it✨
• ibv_reg_mr(3)register or deregister a memory region (MR)✨
• ibv_reg_mr_ex(3)register or deregister a memory region (MR)✨
• ibv_req_notify_cq(3)request completion notification on a completion queue (CQ)✨
• ibv_rereg_mr(3)re-register a memory region (MR)✨
• ibv_resize_cq(3)resize a completion queue (CQ)✨
• ibv_set_ece(3)set ECE options and use them for QP configuration stage.✨
• ibv_srq_pingpong(1)simple InfiniBand shared receive queue test✨
• ibv_uc_pingpong(1)simple InfiniBand UC transport test✨
• ibv_ud_pingpong(1)simple InfiniBand UD transport test✨
• ibv_unimport_dm(3)import an DM from a given ibv_context ibv_unimport_dm - unimport an DM✨
• ibv_unimport_mr(3)import an MR from a given ibv_pd ibv_unimport_mr - unimport an MR✨
• ibv_unimport_pd(3)import a PD from a given ibv_context ibv_unimport_pd - unimport a PD✨
• ibv_wr_abort(3)Manage regions allowed to post work✨
• ibv_wr_atomic_cmp_swp(3)Manage regions allowed to post work✨
• ibv_wr_atomic_fetch_add(3)Manage regions allowed to post work✨
• ibv_wr_bind_mw(3)Manage regions allowed to post work✨
• ibv_wr_complete(3)Manage regions allowed to post work✨
• ibv_wr_flush(3)Manage regions allowed to post work✨
• ibv_wr_local_inv(3)Manage regions allowed to post work✨
• ibv_wr_post(3)Manage regions allowed to post work✨
• ibv_wr_rdma_read(3)Manage regions allowed to post work✨
• ibv_wr_rdma_write(3)Manage regions allowed to post work✨
• ibv_wr_rdma_write_imm(3)Manage regions allowed to post work✨
• ibv_wr_send(3)Manage regions allowed to post work✨
• ibv_wr_send_imm(3)Manage regions allowed to post work✨
• ibv_wr_send_inv(3)Manage regions allowed to post work✨
• ibv_wr_send_tso(3)Manage regions allowed to post work✨
• ibv_wr_set_inline_data(3)Manage regions allowed to post work✨
• ibv_wr_set_inline_data_list(3)Manage regions allowed to post work✨
• ibv_wr_set_sge(3)Manage regions allowed to post work✨
• ibv_wr_set_sge_list(3)Manage regions allowed to post work✨
• ibv_wr_set_ud_addr(3)Manage regions allowed to post work✨
• ibv_wr_set_xrc_srqn(3)Manage regions allowed to post work✨
• ibv_wr_start(3)Manage regions allowed to post work✨
• ibv_xsrq_pingpong(1)simple InfiniBand shared receive queue test✨
• infiniband-diags(8)Diagnostics for InfiniBand Fabrics✨
• iwpmd(8)port mapping services for iWARP.✨
• iwpmd.conf(5)iWARP port mapper config file.✨

M

• manadv(7)Direct verbs for mana devices✨
• manadv_init_obj(3)Initialize mana direct verbs object from ibv_xxx structures✨
• manadv_set_context_attr(3)Set context attributes✨
• mbps_to_ibv_rate(3)convert IB rate enumeration to Mbit/sec mbps_to_ibv_rate - convert Mbit/sec to an IB rate enumeration✨
• mckey(1)RDMA CM multicast setup and simple data transfer test.✨
• mlx4dv(7)Direct verbs for mlx4 devices This is low level access to mlx4 devices to perform data path operations, without general branching performed by ibv_post_send(3).✨
• mlx4dv_init_obj(3)Initialize mlx4 direct verbs object from ibv_xxx structures✨
• mlx4dv_query_device(3)Query device capabilities specific to mlx4✨
• mlx4dv_set_context_attr(3)Set context attributes✨