79 lines
7.0 KiB
Diff
79 lines
7.0 KiB
Diff
From 1e014d466a7008725e0b2c7cb41b1e00cb7868de Mon Sep 17 00:00:00 2001
|
|
From: Thomas Haller <thaller@redhat.com>
|
|
Date: Wed, 24 May 2023 10:44:58 +0200
|
|
Subject: [PATCH 2/2] libnm/docs: clarify behavior of infiniband.p-key property
|
|
|
|
(cherry picked from commit ea18e66ef657b55eca941dca3de4949b950e656b)
|
|
---
|
|
src/libnm-core-impl/nm-setting-infiniband.c | 19 ++++++++++++++++---
|
|
src/libnmc-setting/settings-docs.h.in | 2 +-
|
|
.../generate-docs-nm-settings-nmcli.xml.in | 2 +-
|
|
3 files changed, 18 insertions(+), 5 deletions(-)
|
|
|
|
diff --git a/src/libnm-core-impl/nm-setting-infiniband.c b/src/libnm-core-impl/nm-setting-infiniband.c
|
|
index 787b838b76..df296becba 100644
|
|
--- a/src/libnm-core-impl/nm-setting-infiniband.c
|
|
+++ b/src/libnm-core-impl/nm-setting-infiniband.c
|
|
@@ -448,9 +448,20 @@ nm_setting_infiniband_class_init(NMSettingInfinibandClass *klass)
|
|
* NMSettingInfiniband:p-key:
|
|
*
|
|
* The InfiniBand P_Key to use for this device. A value of -1 means to use
|
|
- * the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit
|
|
- * unsigned integer, whose high bit is set if it is a "full membership"
|
|
- * P_Key.
|
|
+ * the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a
|
|
+ * 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full
|
|
+ * membership" P_Key. The values 0 and 0x8000 are not allowed.
|
|
+ *
|
|
+ * With the p-key set, the interface name is always "$parent.$p_key".
|
|
+ * Setting "connection.interface-name" to another name is not supported.
|
|
+ *
|
|
+ * Note that kernel will internally always set the full membership bit,
|
|
+ * although the interface name does not reflect that. Thus, not setting
|
|
+ * the high bit is probably not useful.
|
|
+ *
|
|
+ * If the profile is stored in ifcfg-rh format, then the full membership
|
|
+ * bit is automatically added. To get consistent behavior, it is
|
|
+ * best to only use p-key values with the full membership bit set.
|
|
**/
|
|
/* ---ifcfg-rh---
|
|
* property: p-key
|
|
@@ -459,6 +470,8 @@ nm_setting_infiniband_class_init(NMSettingInfinibandClass *klass)
|
|
* description: InfiniBand P_Key. The value can be a hex number prefixed with "0x"
|
|
* or a decimal number.
|
|
* When PKEY_ID is specified, PHYSDEV and DEVICE also must be specified.
|
|
+ * Note that ifcfg-rh format will always automatically set the full membership
|
|
+ * bit 0x8000. Other p-key cannot be stored.
|
|
* example: PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002
|
|
* ---end---
|
|
*/
|
|
diff --git a/src/libnmc-setting/settings-docs.h.in b/src/libnmc-setting/settings-docs.h.in
|
|
index 49bddb237f..01629a71f7 100644
|
|
--- a/src/libnmc-setting/settings-docs.h.in
|
|
+++ b/src/libnmc-setting/settings-docs.h.in
|
|
@@ -153,7 +153,7 @@
|
|
#define DESCRIBE_DOC_NM_SETTING_GSM_USERNAME N_("The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.")
|
|
#define DESCRIBE_DOC_NM_SETTING_INFINIBAND_MAC_ADDRESS N_("If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).")
|
|
#define DESCRIBE_DOC_NM_SETTING_INFINIBAND_MTU N_("If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.")
|
|
-#define DESCRIBE_DOC_NM_SETTING_INFINIBAND_P_KEY N_("The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka \"the P_Key at index 0\"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a \"full membership\" P_Key.")
|
|
+#define DESCRIBE_DOC_NM_SETTING_INFINIBAND_P_KEY N_("The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka \"the P_Key at index 0\"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a \"full membership\" P_Key. The values 0 and 0x8000 are not allowed. With the p-key set, the interface name is always \"$parent.$p_key\". Setting \"connection.interface-name\" to another name is not supported. Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Thus, not setting the high bit is probably not useful. If the profile is stored in ifcfg-rh format, then the full membership bit is automatically added. To get consistent behavior, it is best to only use p-key values with the full membership bit set.")
|
|
#define DESCRIBE_DOC_NM_SETTING_INFINIBAND_PARENT N_("The interface name of the parent device of this device. Normally NULL, but if the \"p_key\" property is set, then you must specify the base device by setting either this property or \"mac-address\".")
|
|
#define DESCRIBE_DOC_NM_SETTING_INFINIBAND_TRANSPORT_MODE N_("The IP-over-InfiniBand transport mode. Either \"datagram\" or \"connected\".")
|
|
#define DESCRIBE_DOC_NM_SETTING_IP4_CONFIG_ADDRESSES N_("A list of IPv4 addresses and their prefix length. Multiple addresses can be separated by comma. For example \"192.168.1.5/24, 10.1.0.5/24\". The addresses are listed in decreasing priority, meaning the first address will be the primary address.")
|
|
diff --git a/src/nmcli/generate-docs-nm-settings-nmcli.xml.in b/src/nmcli/generate-docs-nm-settings-nmcli.xml.in
|
|
index de20c60718..0a69c926e4 100644
|
|
--- a/src/nmcli/generate-docs-nm-settings-nmcli.xml.in
|
|
+++ b/src/nmcli/generate-docs-nm-settings-nmcli.xml.in
|
|
@@ -614,7 +614,7 @@
|
|
description="The IP-over-InfiniBand transport mode. Either "datagram" or "connected"." />
|
|
<property name="p-key"
|
|
alias="p-key"
|
|
- description="The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key." />
|
|
+ description="The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" P_Key. The values 0 and 0x8000 are not allowed. With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported. Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Thus, not setting the high bit is probably not useful. If the profile is stored in ifcfg-rh format, then the full membership bit is automatically added. To get consistent behavior, it is best to only use p-key values with the full membership bit set." />
|
|
<property name="parent"
|
|
alias="parent"
|
|
description="The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address"." />
|
|
--
|
|
2.39.3
|
|
|