API Documentation

Here is a list of all topics with brief descriptions:

[detail level 12]

Basic Concepts	This section describes basic concepts in LCI
▼Setup and Teardown	This section describes setup and teardown API
alloc_runtime	Allocate a new runtime object
free_runtime	Free a new runtime object
g_runtime_init	Initialize the global default runtime object
g_runtime_fina	Finalize the global default runtime object
get_g_runtime	Get the global default runtime object
RESOURCE runtime	The runtime object
▼Resource Management	This section describes the LCI API for resource management
alloc_packet_pool	Allocate a new packet_pool object
free_packet_pool	Free a new packet_pool object
register_packet_pool	Register a packet pool to a device
deregister_packet_pool	Deregister a packet pool from a device
get_upacket	Get a packet for writing user payload from the packet pool
put_upacket	Return a packet to the packet pool
alloc_matching_engine	Allocate a new matching_engine object
free_matching_engine	Free a new matching_engine object
matching_engine_insert	Insert an entry into the matching engine
set_allocator	Set the message allocator for the runtime
get_allocator	Get the message allocator for the runtime
get_default_net_context	Get the default net context of the runtime
get_default_device	Get the default net device of the runtime
get_default_endpoint	Get the default net endpoint of the runtime
get_default_packet_pool	Get the default packet pool of the runtime
get_default_matching_engine	Get the default matching engine of the runtime
alloc_net_context	Allocate a new net_context object
free_net_context	Free a new net_context object
alloc_device	Allocate a new device object
free_device	Free a new device object
alloc_endpoint	Allocate a new endpoint object
free_endpoint	Free a new endpoint object
RESOURCE packet_pool	The packet pool resource
RESOURCE matching_engine	The matching engine resource
RESOURCE net_context	The network context resource
RESOURCE device	The device resource
RESOURCE endpoint	The endpoint resource
▼Memory Registration	This section describes the LCI API for memory registration
register_memory	Register a memory region to a device
deregister_memory	Deregister a memory region from a device
get_rmr	Get the remote memory region handle
RESOURCE mr	The memory region resource
▼Network-Layer Communication	This section describes the LCI API for network-layer communication
net_poll_cq	Poll the network completion queue
net_post_recv	Post a network receive operation
net_post_sends	Post a network short send operation
net_post_send	Post a network send operation
net_post_puts	Post a network short put operation
net_post_put	Post a network put operation
net_post_putImms	Post a network short put with immediate data operation
net_post_putImm	Post a network put with immediate data operation
net_post_get	Post a network get operation
▼Communication Posting	This section describes the LCI API for posting communication
get_max_bcopy_size	Get the maximum message size for the buffer-copy protocol
post_comm	Post a generic communication operation
post_am	Post an active message communication operation
post_send	Post a send communication operation
post_recv	Post a receive communication operation
post_put	Post a put (one-sided write) communication operation
post_get	Post a get (one-sided read) communication operation
progress	Perform background work to advance the state of the pending communication
test_drained	Test for the completion of all locally posted communication operations
wait_drained	Test for the completion of all locally posted communication operations
▼Completion Checking	This section describes the LCI API for checking the completion status of posted communications
free_comp	Free a new comp object
comp_signal	Signal a completion object
reserve_rcomps	Reserve spaces for n remote completion handlers
register_rcomp	Register a completion object into a remote completion handler
deregister_rcomp	Deregister a remote completion handler
alloc_sync	Allocate a synchronizer
sync_test	Test a synchronizer
sync_wait	Wait for a synchronizer to be ready
alloc_counter	Allocate a counter (initialized to 0)
counter_get	Get the current value of a counter
counter_set	Set the value of a counter
alloc_cq	Allocate a completion queue
cq_pop	Pop a status from a completion queue
alloc_handler	Allocate a completion handler
alloc_graph	Allocate a completion handler
graph_add_node	Add a node to a graph
graph_add_edge	Add a edge to a graph
graph_node_mark_complete	Mark a node complete
graph_start	Start a graph
graph_test	Test a graph
RESOURCE comp	The completion object resource
▼Collective Communication	This section describes the LCI API for collective communication
barrier	A barrier operation
broadcast	A broadcast operation
reduce	A blocking reduce operation
reduce_scatter	A reduce scatter operation
allreduce	An allreduce operation
allgather	An allgather operation
alltoall	A blocking alltoall operation