UCMATOSE(1)

💖 UCMATOSE 💖

okay bestie, gather round, because this is the ucmatose page from librdmacm and it's literally the cutest little RDMA test tool you'll ever meet 🦋

✨ NAME ✨

ucmatose — RDMA CM connection and simple ping-pong test. that's it, that's the whole vibe. no cap.

✨ SYNOPSIS ✨

ucmatose [-s server_address] [-b bind_address]
          [-f address_format] [-P port_space]
          [-c connections] [-C message_count] [-S message_size] [-a ack_timeout]
ucmatose -s server_address [-b bind_address]
          [-f address_format] [-P port_space]
          [-c connections] [-C message_count] [-S message_size] [-t tos] [-a ack_timeout]

two whole forms, bestie — the second one is giving -s is mandatory energy 💅

✨ DESCRIPTION ✨

okay so what does this actually do? ucmatose establishes a set of reliable RDMA connections between two nodes using the librdmacm, optionally transfers data between the nodes, and then disconnects. that's the whole arc — meet, vibe, send data (maybe), say bye. main character energy from start to finish 👑

✨ OPTIONS ✨

• -s server_address — the network name or IP address of the server system that's out here listening for connections 👂. the name or address you use must route over an RDMA device, fr fr. and heads up: this one is required by the client — no -s, no connection, sorry bestie 😭
• -b bind_address — the local network address to bind to. wanna bind to any address with IPv6? use -b ::0 ✨
• -f address_format — tells it what format the server and bind addresses are in. by default the format is figured out by getaddrinfo() as either a hostname, an IPv4 address, or an IPv6 address. this option is for when you wanna say "yes I know which format I gave you". the supported address_format values are: name, ip, ipv6, and gid 💅
• -P port_space — the port space for the connection. by default it's the RDMA TCP port space. (lowkey important: the RDMA port space may be separate from the one used for IP 👀). supported port_space values are: tcp and ib
• -c connections — how many connections to establish between the client and server. (default 1)
• -C message_count — how many messages to transfer over each connection. (default 10)
• -S message_size — the size of each message transferred, in bytes. (default 100)
• -t tos — indicates the type of service used for the communication. type of service is implementation dependent based on subnet configuration, so don't come for me if your subnet has opinions 🙈
• -a ack_timeout — the QP ACK timeout value that should be used. the value is calculated according to the formula 4.096 * 2^(ack_timeout) usec 🧮
• -m — tests event channel migration. it migrates all communication identifiers to a different event channel for disconnect events. iconic behaviour honestly 🌈

✨ NOTES ✨

basic usage, the classic routine: start ucmatose on a server system, then run ucmatose -s server_name on a client system. that's the whole group chat, one on each end 🫶

because this test maps RDMA resources to userspace, users must make sure they have available system resources and permissions. see the libibverbs README file for additional details — seriously, go read it, it's not optional 💀

✨ SEE ALSO ✨

rdma_cm(7), udaddy(1), mckey(1), rping(1)

go read those too, they're all in the same friend group 🎀

and that's the page!! this little cutie is brought to you by librdmacm, dated 2007-05-15, and it will forever be UCMATOSE(1) in our hearts. slay, stay connected, and please check your permissions before you map anything to userspace 💖✨🦋