From 8f9ee150cba713a690e1d51214f837e8e9bad151 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Piotr=20Da=C5=82ek?= Date: Tue, 22 Nov 2016 12:04:27 +0100 Subject: [PATCH] doc/rados/configuration/ms-ref.rst: document a few async msgr options MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Documentation of a few of Async Messenger configuration options. Signed-off-by: Piotr Dałek --- doc/rados/configuration/ms-ref.rst | 71 ++++++++++++++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/doc/rados/configuration/ms-ref.rst b/doc/rados/configuration/ms-ref.rst index d0b1b172d7fb0..ef367e61316c4 100644 --- a/doc/rados/configuration/ms-ref.rst +++ b/doc/rados/configuration/ms-ref.rst @@ -2,6 +2,8 @@ Messaging =========== +General Settings +================ ``ms tcp nodelay`` @@ -81,3 +83,72 @@ :Type: 64-bit Unsigned Integer :Required: No :Default: ``0`` + +Async messenger options +======================= + + +``ms async transport type`` + +:Description: Transport type used by Async Messenger. Can be ``posix``, ``dpdk`` + or ``rdma``. Posix uses standard TCP/IP networking and is default. + Other transports may be experimental and support may be limited. +:Type: String +:Required: No +:Default: ``posix`` + + +``ms async op threads`` + +:Description: Initial number of worker threads used by each Async Messenger instance. + Should be at least equal to highest number of replicas, but you can + decrease it if you're low on CPU core count and/or you host a lot of + OSDs on single server. +:Type: 64-bit Unsigned Integer +:Required: No +:Default: ``3`` + + +``ms async max op threads`` + +:Description: Maximum number of worker threads used by each Async Messenger instance. + Set to lower values when your machine has limited CPU count, and increase + when your CPUs are underutilized (i. e. one or more of CPUs are + constantly on 100% load during I/O operations). +:Type: 64-bit Unsigned Integer +:Required: No +:Default: ``5`` + + +``ms async set affinity`` + +:Description: Set to true to bind Async Messenger workers to particular CPU cores. +:Type: Boolean +:Required: No +:Default: ``true`` + + +``ms async affinity cores`` + +:Description: When ``ms async set affinity`` is true, this string specifies how Async + Messenger workers are bound to CPU cores. For example, "0,2" will bind + workers #1 and #2 to CPU cores #0 and #2, respectively. + NOTE: when manually setting affinity, make sure to not assign workers to + processors that are virtual CPUs created as an effect of Hyperthreading + or similar technology, because they're slower than regular CPU cores. +:Type: String +:Required: No +:Default: ``(empty)`` + + +``ms async send inline`` + +:Description: Send messages directly from the thread that generated them instead of + queuing and sending from Async Messenger thread. This option is known + to decrease performance on systems with a lot of CPU cores, so it's + disabled by default. +:Type: Boolean +:Required: No +:Default: ``false`` + + -- 2.39.5