examples: Hoti examples msg, rdm_tagged, rdm_rma, tcp_socket

examples/Makefile

@@ -5,7 +5,7 @@ CFLAGS		= -g -O0 $(INCLUDES) $(LIBS)
 LDFLAGS		= -lfabric
 EXEC_PREFIX	= fi_example_
 
-PROGRAMS = rdm
+PROGRAMS = rdm msg rdm_tagged rdm_rma tcp_socket
 
 EXECUTABLES = $(addprefix $(EXEC_PREFIX), $(PROGRAMS))
 

examples/README.md

@@ -28,3 +28,67 @@ FI_PROVIDER=<prov> ./fi_example_rdm <server_addr>
 address provided to the client must match the provider/interface being used.
 Specifying `FI_PROVIDER` is optional; libfabric will select the fastest
 interface available.
+
+### fi_example_msg (msg.c)
+
+This example uses `FI_EP_MSG` (reliable, connected) with a simple server and
+client to execute send and receive.
+
+#### Server
+```bash
+FI_PROVIDER=<prov> ./fi_example_msg
+```
+
+#### Client
+```bash
+FI_PROVIDER=<prov> ./fi_example_msg <server_addr>
+```
+
+> **Note:** The server and client must use the same provider.  The server
+address provided to the client must match the provider/interface being used.
+Specifying `FI_PROVIDER` is optional; libfabric will select the interface
+that is expected to be the most performant. Test only supports providers that
+use FI_SOCKADDR_IN (tcp, verbs)
+
+### fi_example_rdm_tagged (rdm_tagged.c)
+
+This example uses `FI_EP_RDM` (reliable, unconnected) with a simple server and
+client to showcase tagged messages.
+
+#### Server
+```bash
+FI_PROVIDER=<prov> ./fi_example_rdm_tagged
+```
+
+#### Client
+```bash
+FI_PROVIDER=<prov> ./fi_example_rdm_tagged <server_addr>
+```
+### fi_example_rdm_rma (rdm_rma.c)
+
+This example uses `FI_EP_RDM` (reliable, unconnected) with a simple server and
+client to showcase remote memory access.
+
+#### Server
+```bash
+FI_PROVIDER=<prov> ./fi_example_rdm_rma
+```
+
+#### Client
+```bash
+FI_PROVIDER=<prov> ./fi_example_rdm_rma <server_addr>
+```
+
+### fi_example_tcp_socket (tcp_socket.c)
+
+This example uses tcp sockets with a simple server and client to showcase send and receive messages.
+
+#### Server
+```bash
+./fi_example_tcp_socket -s <server_addr>
+```
+
+#### Client
+```bash
+./fi_example_tcp_socket -s <server_addr> -c
+```