rpc_peeraddr2str(9)

🌸 NAME 🌸

okay bestie, welcome to the Kernel API Manual page for rpc_peeraddr2str(9) — the function whose whole glow is literally return remote peer address in printable format. It’s giving “make the peer address readable” and honestly? iconic. 💅

✨ SYNOPSIS ✨

const char * rpc_peeraddr2str (struct rpc_clnt *clnt , enum
       rpc_display_format_t format );

🎀 ARGUMENTS 🎀

• clnt — RPC client structure. That’s the main-character struct you’re handing over.
• format — address format. This tells it which printable format situation we’re in, no cap.

🦋 DESCRIPTION 🦋

Big caution, bestie: NB: the lifetime of the memory referenced by the returned pointer is the same as the rpc_xprt itself. As long as the caller uses this pointer, it must hold the RCU read lock. That is not a vibe suggestion — that is the rule. Do not let that pointer wander off outside its RCU-safe era. 😭

TL;DR: returned-pointer memory lives exactly as long as the rpc_xprt itself, and while you’re using it you must hold the RCU read lock. periodt.

🌈 SEE ALSO 🌈

Kernel file ./net/sunrpc/clnt.c — and here’s the full bestie roll call, no skips:

• rpc_create(9)
• rpc_clone_client(9)
• rpc_clone_client_set_auth(9)
• rpc_switch_client_transport(9)
• rpc_clnt_iterate_for_each_xprt(9)
• rpc_cancel_tasks(9)
• rpc_hold_client(9)
• rpc_release_client(9)
• rpc_bind_new_program(9)
• rpc_run_task(9)
• rpc_call_sync(9)
• rpc_call_async(9)
• rpc_run_bc_task(9)
• rpc_prepare_reply_pages(9)
• rpc_peeraddr(9)
• rpc_localaddr(9)
• rpc_net_ns(9)
• rpc_max_payload(9)
• rpc_max_bc_payload(9)
• rpc_force_rebind(9)
• rpc_clnt_test_and_add_xprt(9)
• rpc_clnt_setup_test_and_add_xprt(9)
• rpc_clnt_add_xprt(9)

source/version: ./net/sunrpc • date: October 2026 — mwah, go hold that RCU read lock responsibly 💋