RIOSTREAM(1)

💖 RIOSTREAM(1) 💖

okay bestie, so this is a page from the librdmacm manual, and today we're talking about riostream ✨ — literally zero-copy streaming over RDMA, ping-pong style. no cap, it's giving network test main character energy 👑

🌸 NAME 🌸

riostream — zero-copy streaming over RDMA ping-pong test. periodt. 💅

🎀 SYNOPSIS 🎀

riostream [-s server_address] [-b bind_address] [-B buffer_size]
               [-I iterations] [-C transfer_count]
               [-S transfer_size] [-p server_port] [-T test_option]

🦋 DESCRIPTION 🦋

So the way this works is: it uses the streaming over RDMA protocol (aka rsocket, iykyk) to connect a client and a server application, and then they exchange data. that's it, that's the whole vibe 🌈

✨ 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. this one is required if you're the client, bestie — you gotta specify it 💖
• -b bind_address — the local network address to bind to 🎀
• -B buffer_size — tells you the size of the send and receive network buffers 🫶
• -I iterations — how many times that specified number of messages gets exchanged between the client and the server. default is 1000 ⭐
• -C transfer_count — the number of messages transferred from client → server → back again on each and every iteration. default is 1 💅
• -S transfer_size — the size of each send transfer, in bytes. default is 1000 ✨ and if you pass all, rstream will run a whole series of tests at various sizes 👑
• -p server_port — the server's port number 🌸
• -T test_option — specifies the test parameters. the available options are:
  • a | async — uses asynchronous operation (e.g. select / poll) 🧚
  • b | blocking — uses blocking calls 😴
  • n | nonblocking — uses non-blocking calls 🏃
  • v | verify — verifies data transfers 🔍

📝 NOTES 📝

the basic usage bestie is: start riostream on a server system first, then run riostream -s server_name on a client system 💖 by default, riostream will run a series of latency and bandwidth performance tests 🔥 and if you specify a different iterations, transfer_count, or transfer_size, it'll run a user-customized test, using the default values wherever you didn't specify anything 🎀

okay important one, listen up 🚨 because this test maps RDMA resources into userspace, users must make sure they have available system resources and permissions. see the libibverbs README file for the additional deets. don't skip this, it's not a vibe check you wanna fail 💀

👀 SEE ALSO 👀

rdma_cm(7) rstream(1)

and that's the whole page, bestie 🫶 this was librdmacm, dated 2012-10-24 — iconic, timeless, slay 💜 bye bye, go run your tests 🦋