From: Etienne AUJAMES <etienne.aujames@cea.fr>
Date: Thu, 7 Oct 2021 08:12:55 +0000 (+0200)
Subject: LUDOC-496 nrs: Format of TBF rule name field is not defined
X-Git-Url: https://git.whamcloud.com/?a=commitdiff_plain;h=refs%2Fchanges%2F44%2F45144%2F3;p=doc%2Fmanual.git

LUDOC-496 nrs: Format of TBF rule name field is not defined

Lustre manual should define the format (alphanumeric + '_') and length
(15 characters) of a TBF rule name field.

This is important because there is buffer overflow for the TBF rule name
(LU-15059): the length is not checked by ptlrpc.

Change-Id: I29efb7e5891c0fba308b683bf92b26e4fefa7695
Signed-off-by: Etienne AUJAMES <eaujames@ddn.com>
Reviewed-on: https://review.whamcloud.com/45144
Tested-by: jenkins <devops@whamcloud.com>
Reviewed-by: Andreas Dilger <adilger@whamcloud.com>
---

diff --git a/LustreTuning.xml b/LustreTuning.xml
index a8bde00..9460749 100644
--- a/LustreTuning.xml
+++ b/LustreTuning.xml
@@ -1636,10 +1636,13 @@ $ lctl set_param ost.OSS.ost_io.nrs_policies="tbf gid"</screen>
 	<screen>lctl set_param x.x.x.nrs_tbf_rule=
 "[reg|hp] start <replaceable>rule_name</replaceable> <replaceable>arguments</replaceable>..."
 	</screen>
-	<para>'<replaceable>rule_name</replaceable>' is a string of the TBF
-	policy rule's name and '<replaceable>arguments</replaceable>' is a
-	string to specify the detailed rule according to the different types.
-	</para>
+        <para>'<replaceable>rule_name</replaceable>' is a string up to 15
+          characters which identifies the TBF policy rule's name. Alphanumeric
+          characters and underscores are accepted (e.g: "test_rule_A1").
+        </para>
+        <para>'<replaceable>arguments</replaceable>' is a string to specify the
+          detailed rule according to the different types.
+        </para>
 	<itemizedlist>
 	<para>Next, the different types of TBF policies will be described.</para>
 	  <listitem>