fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-01-09 11:10:21 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
NetworkManager/src/libnm-core-impl/nm-setting-infiniband.c
Thomas Haller 5e3e38f291
ifcfg: better handle non-full-membership PKEY_ID with new PKEY_ID_NM variable 
Infiniband profiles can have a p-key set. Both in kernel API
("create_child" sysctl) and in NetworkManager API, that key can range
from 0x0001 to 0xFFFF (0x8000 excluded). NetworkManager does not support
renaming the interface, so kernel always assigns the interface name
"$PHYSDEV.$PKEY_ID" (with $PKEY_ID as 4 character hex digits).

Note that the highest bit in the p-key (0x8000) is the full-membership
flag. Internally, kernel only supports full-membership so when we create
for example "ib0.00c1" and "ib0.80c1" interfaces, their actually used
p-key is in both cases 0x80c1 and you can see it with `ip -d link`.
Nonetheless, kernel and NetworkManager allow to configure the p-key
without the highest bit set, and the result differs in the interface
name.

Note that initscripts' ifup-ib0 would always internally coerce the
PKEY_ID variable to have the high bit set ([1]). It also would require
that the `DEVICE=` variable is specified and matches the expected
interface name. So both these configurations are identical and valid:

  DEVICE=ib0.80c1
  PHYSDEV=ib0
  PKEY_ID=0x80c1

and

  DEVICE=ib0.80c1
  PHYSDEV=ib0
  PKEY_ID=0x00c1

Historically, NetworkManager would also implement the same restrictions
([2], [3], [4]). That meant, not all valid NetworkManager infiniband
profiles could be expressed as  ifcfg file. For example, NetworkManager
allows to have "connection.interface-name" (`DEVICE=`) unset (which
ifup-ib and ifcfg reader did not allow). Also, NetworkManager would
allow configuring a "infiniband.p-key" without full membership flag, and
the reader would mangle that.

This caused various problems to the point that when you configure an
infiniband.p-key with a non-full-membership key, the ifcfg-rh written by
NetworkManager was invalid. Either, you could leave
"connection.interface-name" unset, but then the reader would complain
about missing `DEVICE=`. Or, we could write `DEVICE=ib0.00c1;
PKEY_ID=0x00c1`, which was invalid as we expected `DEVICE=ib0.80c1`.

This was addressed by rhbz 2122703 ([5]). The fix was to

  - not require a `DEVICE=` ([6]).
  - don't mangle the `PKEY_ID=` in the reader ([7]).

which happened in 1.41.2 and 1.40.2 (rhel-8.8).

With this change, we could persist any valid infiniband profile to ifcfg
format. We also could read back any valid ifcfg file that NetworkManager
would have written in the past (note that it could not write valid ifcfg
files previously, if the p-key didn't have the full-membership key set).

The problem is, that users were used to edit ifcfg files by hand, and
users would have files with:

  DEVICE=ib0.80c1
  PHYSDEV=ib0
  PKEY_ID=0x00c1

This files had worked before, but now failed to verify as we would
expect `DEVICE=ib0.00c1`. Also, there was a change in behavior that
PKEY_ID is now interpreted without the high bit set. This is reported as
rhbz 2209164 ([8]).

We will do several things to fix that:

1) we now normalize the "connection.interface-name" to be valid. It was
  not useful to set it anyway, as it was redundant. Complaining about a
  redundant setting, which makes little sense to configure, is not useful.
  This is done by [9].

2) we now again treat PKEY_ID= as if it had 0x8000 flag set. This was done by
  [10].

With step 1) and 2), we are able to read any existing ifcfg files out
there in the way we did before 1.41.2.

There is however one piece missing. When we now create a profile using
nmcli/libnm/D-Bus, which has a non-full-membership p-key, then the
profile gets mangled in the process.

If the user uses NetworkManager API to configure an interface and
chooses a non-full-membership p-key, then this should work the same as
with keyfile plugin (or on rhel-9, where keyfile is the default). Note
that before 1.41.2 it didn't work at all, when the user used ifcfg-rh
backend. Likely(?) there are no users who rely on creating such a profile
with nmcli/libnm/D-Bus and expect to automatically have the p-key
normalized. That didn't work before 1.41.2 and didn't behave that way
between 1.41.2 and now.

This patch fixes that by introducing a new key PKEY_ID_NM= for holding
the real p-key. Now ifcfg backend is consistent with handling infiniband
profiles, and old, hand-written ifcfg files still work as before.

There is of course change in behavior, that ifcfg files between 1.41.2
and now were interpreted differently. But that is bug 2209164 ([8]) and
what we fix here.

For now strong reasons, we keep writing the PKEY_ID to file too. It's
redundant, but that is what a human might expect there.

[1]  05333c3602/f/rdma.ifup-ib (_75)
[2]  https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/blob/1.40.0/src/core/settings/plugins/ifcfg-rh/nms-ifcfg-rh-reader.c#L5386
[3]  cb5606cf1c (a7a78fccb2c8c945fd09038656ae734c1b0349ab_3493_3532)
[4]  cb5606cf1c (a7a78fccb2c8c945fd09038656ae734c1b0349ab_3493_3506)
[5]  https://bugzilla.redhat.com/show_bug.cgi?id=2122703
[6]  4c32dd9d25
[7]  a4fe16a426
[8]  https://bugzilla.redhat.com/show_bug.cgi?id=2209164
[9]  4610fd67e6
[10] f8e5e07355
2023-06-05 10:38:01 +02:00

496 lines
18 KiB
C
Raw Blame History

/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2011 - 2013 Red Hat, Inc.
*/
#include "libnm-core-impl/nm-default-libnm-core.h"
#include "nm-setting-infiniband.h"
#include <stdlib.h>
#include <linux/if_infiniband.h>
#include "libnm-platform/nmp-base.h"
#include "nm-utils.h"
#include "nm-utils-private.h"
#include "nm-setting-private.h"
#include "nm-setting-connection.h"
/**
* SECTION:nm-setting-infiniband
* @short_description: Describes connection properties for IP-over-InfiniBand networks
*
* The #NMSettingInfiniband object is a #NMSetting subclass that describes properties
* necessary for connection to IP-over-InfiniBand networks.
**/
/*****************************************************************************/
NM_GOBJECT_PROPERTIES_DEFINE_BASE(PROP_MAC_ADDRESS,
PROP_MTU,
PROP_TRANSPORT_MODE,
PROP_P_KEY,
PROP_PARENT, );
typedef struct {
char *mac_address;
char *transport_mode;
char *parent;
char virtual_iface_name[NM_IFNAMSIZ];
gint32 p_key;
guint32 mtu;
} NMSettingInfinibandPrivate;
/**
* NMSettingInfiniband:
*
* Infiniband Settings
*/
struct _NMSettingInfiniband {
NMSetting parent;
/* In the past, this struct was public API. Preserve ABI! */
};
struct _NMSettingInfinibandClass {
NMSettingClass parent;
/* In the past, this struct was public API. Preserve ABI! */
gpointer padding[4];
};
G_DEFINE_TYPE(NMSettingInfiniband, nm_setting_infiniband, NM_TYPE_SETTING)
#define NM_SETTING_INFINIBAND_GET_PRIVATE(o) \
(G_TYPE_INSTANCE_GET_PRIVATE((o), NM_TYPE_SETTING_INFINIBAND, NMSettingInfinibandPrivate))
/*****************************************************************************/
/**
* nm_setting_infiniband_get_mac_address:
* @setting: the #NMSettingInfiniband
*
* Returns: the #NMSettingInfiniband:mac-address property of the setting
**/
const char *
nm_setting_infiniband_get_mac_address(NMSettingInfiniband *setting)
{
g_return_val_if_fail(NM_IS_SETTING_INFINIBAND(setting), NULL);
return NM_SETTING_INFINIBAND_GET_PRIVATE(setting)->mac_address;
}
/**
* nm_setting_infiniband_get_mtu:
* @setting: the #NMSettingInfiniband
*
* Returns: the #NMSettingInfiniband:mtu property of the setting
**/
guint32
nm_setting_infiniband_get_mtu(NMSettingInfiniband *setting)
{
g_return_val_if_fail(NM_IS_SETTING_INFINIBAND(setting), 0);
return NM_SETTING_INFINIBAND_GET_PRIVATE(setting)->mtu;
}
/**
* nm_setting_infiniband_get_transport_mode:
* @setting: the #NMSettingInfiniband
*
* Returns the transport mode for this device. Either 'datagram' or
* 'connected'.
*
* Returns: the IPoIB transport mode
**/
const char *
nm_setting_infiniband_get_transport_mode(NMSettingInfiniband *setting)
{
g_return_val_if_fail(NM_IS_SETTING_INFINIBAND(setting), NULL);
return NM_SETTING_INFINIBAND_GET_PRIVATE(setting)->transport_mode;
}
/**
* nm_setting_infiniband_get_p_key:
* @setting: the #NMSettingInfiniband
*
* Returns the 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.
*
* Returns: the IPoIB P_Key
**/
int
nm_setting_infiniband_get_p_key(NMSettingInfiniband *setting)
{
g_return_val_if_fail(NM_IS_SETTING_INFINIBAND(setting), -1);
return NM_SETTING_INFINIBAND_GET_PRIVATE(setting)->p_key;
}
/**
* nm_setting_infiniband_get_parent:
* @setting: the #NMSettingInfiniband
*
* Returns the parent interface name for this device, if set.
*
* Returns: the parent interface name
**/
const char *
nm_setting_infiniband_get_parent(NMSettingInfiniband *setting)
{
g_return_val_if_fail(NM_IS_SETTING_INFINIBAND(setting), NULL);
return NM_SETTING_INFINIBAND_GET_PRIVATE(setting)->parent;
}
/**
* nm_setting_infiniband_get_virtual_interface_name:
* @setting: the #NMSettingInfiniband
*
* Returns the interface name created by combining #NMSettingInfiniband:parent
* and #NMSettingInfiniband:p-key. (If either property is unset, this will
* return %NULL.)
*
* Returns: the interface name, or %NULL
**/
const char *
nm_setting_infiniband_get_virtual_interface_name(NMSettingInfiniband *setting)
{
NMSettingInfinibandPrivate *priv = NM_SETTING_INFINIBAND_GET_PRIVATE(setting);
if (priv->p_key == -1 || !priv->parent)
return NULL;
return nm_net_devname_infiniband(priv->virtual_iface_name, priv->parent, priv->p_key);
}
static gboolean
verify(NMSetting *setting, NMConnection *connection, GError **error)
{
NMSettingConnection *s_con;
NMSettingInfinibandPrivate *priv = NM_SETTING_INFINIBAND_GET_PRIVATE(setting);
if (priv->mac_address && !nm_utils_hwaddr_valid(priv->mac_address, INFINIBAND_ALEN)) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("property is invalid"));
g_prefix_error(error,
"%s.%s: ",
NM_SETTING_INFINIBAND_SETTING_NAME,
NM_SETTING_INFINIBAND_MAC_ADDRESS);
return FALSE;
}
if (!NM_IN_STRSET(priv->transport_mode, "datagram", "connected")) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("property is invalid"));
g_prefix_error(error,
"%s.%s: ",
NM_SETTING_INFINIBAND_SETTING_NAME,
NM_SETTING_INFINIBAND_TRANSPORT_MODE);
return FALSE;
}
if (priv->parent) {
GError *tmp_error = NULL;
if (!nm_utils_ifname_valid_kernel(priv->parent, &tmp_error)) {
g_set_error(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
"'%s': %s",
priv->parent,
tmp_error->message);
g_prefix_error(error, "%s: ", NM_SETTING_INFINIBAND_PARENT);
g_error_free(tmp_error);
return FALSE;
}
if (priv->p_key == -1) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("Must specify a P_Key if specifying parent"));
g_prefix_error(error, "%s: ", NM_SETTING_INFINIBAND_PARENT);
}
}
if (priv->p_key != -1) {
if (!priv->mac_address && !priv->parent) {
g_set_error_literal(
error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_MISSING_PROPERTY,
_("InfiniBand P_Key connection did not specify parent interface name"));
g_prefix_error(error, "%s: ", NM_SETTING_INFINIBAND_PARENT);
return FALSE;
}
if (NM_IN_SET(priv->p_key, 0, 0x8000)) {
g_set_error_literal(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("the values 0 and 0x8000 are not allowed"));
g_prefix_error(error, "%s: ", NM_SETTING_INFINIBAND_P_KEY);
return FALSE;
}
}
/* *** errors above here should be always fatal, below NORMALIZABLE_ERROR *** */
s_con = connection ? nm_connection_get_setting_connection(connection) : NULL;
if (s_con) {
const char *interface_name = nm_setting_connection_get_interface_name(s_con);
if (interface_name && priv->p_key != -1) {
const char *virtual_iface_name;
virtual_iface_name =
nm_setting_infiniband_get_virtual_interface_name(NM_SETTING_INFINIBAND(setting));
if (!nm_streq0(interface_name, virtual_iface_name)) {
/* We don't support renaming software infiniband devices. Later we might, but
* for now just reject such connections.
**/
if (virtual_iface_name) {
g_set_error(
error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("interface name of software infiniband device must be '%s' or unset "
"(instead it is '%s')"),
virtual_iface_name,
interface_name);
} else {
g_set_error(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("interface name of software infiniband device with MAC address "
"must be unset (instead it is '%s')"),
interface_name);
}
g_prefix_error(error,
"%s.%s: ",
NM_SETTING_CONNECTION_SETTING_NAME,
NM_SETTING_CONNECTION_INTERFACE_NAME);
return NM_SETTING_VERIFY_NORMALIZABLE_ERROR;
}
}
}
if (priv->mtu > NM_INFINIBAND_MAX_MTU) {
/* Traditionally, MTU for "datagram" mode was limited to 2044
* and for "connected" mode it was 65520.
*
* This is no longer the case, and both transport modes use the same
* maximum of 65520 (NM_INFINIBAND_MAX_MTU).
*
* Note that this is the MTU in the connection profile. Whether
* we will be able to configure large MTUs later (during activation)
* is unknown at this point. */
g_set_error(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("mtu can be at most %u but it is %u"),
NM_INFINIBAND_MAX_MTU,
priv->mtu);
g_prefix_error(error,
"%s.%s: ",
NM_SETTING_INFINIBAND_SETTING_NAME,
NM_SETTING_INFINIBAND_MTU);
return NM_SETTING_VERIFY_NORMALIZABLE_ERROR;
}
return TRUE;
}
/*****************************************************************************/
static void
nm_setting_infiniband_init(NMSettingInfiniband *self)
{}
/**
* nm_setting_infiniband_new:
*
* Creates a new #NMSettingInfiniband object with default values.
*
* Returns: (transfer full): the new empty #NMSettingInfiniband object
**/
NMSetting *
nm_setting_infiniband_new(void)
{
return g_object_new(NM_TYPE_SETTING_INFINIBAND, NULL);
}
static void
nm_setting_infiniband_class_init(NMSettingInfinibandClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS(klass);
NMSettingClass *setting_class = NM_SETTING_CLASS(klass);
GArray *properties_override = _nm_sett_info_property_override_create_array();
g_type_class_add_private(klass, sizeof(NMSettingInfinibandPrivate));
object_class->get_property = _nm_setting_property_get_property_direct;
object_class->set_property = _nm_setting_property_set_property_direct;
setting_class->verify = verify;
/**
* NMSettingInfiniband:mac-address:
*
* 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).
**/
/* ---keyfile---
* property: mac-address
* format: usual hex-digits-and-colons notation
* description: MAC address in traditional hex-digits-and-colons notation, or
* or semicolon separated list of 20 decimal bytes (obsolete)
* example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
* ---end---
*/
/* ---ifcfg-rh---
* property: mac-address
* variable: HWADDR
* description: IBoIP 20-byte hardware address of the device (in traditional
* hex-digits-and-colons notation).
* Note that for initscripts this is the current MAC address of the device as found
* during ifup. For NetworkManager this is the permanent MAC address. Or in case no
* permanent MAC address exists, the MAC address initially configured on the device.
* example: HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11
* ---end---
*/
_nm_setting_property_define_direct_mac_address(properties_override,
obj_properties,
NM_SETTING_INFINIBAND_MAC_ADDRESS,
PROP_MAC_ADDRESS,
NM_SETTING_PARAM_INFERRABLE,
NMSettingInfinibandPrivate,
mac_address,
.direct_set_string_mac_address_len =
INFINIBAND_ALEN);
/**
* NMSettingInfiniband:mtu:
*
* If non-zero, only transmit packets of the specified size or smaller,
* breaking larger packets up into multiple frames.
**/
/* ---ifcfg-rh---
* property: mtu
* variable: MTU
* description: MTU of the interface.
* ---end---
*/
_nm_setting_property_define_direct_uint32(properties_override,
obj_properties,
NM_SETTING_INFINIBAND_MTU,
PROP_MTU,
0,
G_MAXUINT32,
0,
NM_SETTING_PARAM_FUZZY_IGNORE,
NMSettingInfinibandPrivate,
mtu);
/**
* NMSettingInfiniband:transport-mode:
*
* The IP-over-InfiniBand transport mode. Either "datagram" or
* "connected".
**/
/* ---ifcfg-rh---
* property: transport-mode
* variable: CONNECTED_MODE
* default: CONNECTED_MODE=no
* description: CONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for
* "datagram" mode
* ---end---
*/
_nm_setting_property_define_direct_string(properties_override,
obj_properties,
NM_SETTING_INFINIBAND_TRANSPORT_MODE,
PROP_TRANSPORT_MODE,
NM_SETTING_PARAM_INFERRABLE,
NMSettingInfinibandPrivate,
transport_mode);
/**
* 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 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. Usually the user
* would want to configure a full membership p-key with 0x8000 flag set.
**/
/* ---ifcfg-rh---
* property: p-key
* variable: PKEY_ID or PKEY_ID_NM(*) (requires PKEY=yes)
* default: PKEY=no
* description: InfiniBand P_Key. The value can be a hex number prefixed with "0x"
* or a decimal number.
* When PKEY_ID is specified, PHYSDEV must be specified.
* Note that ifcfg-rh format will always automatically set the full membership
* flag 0x8000 for the PKEY_ID variable. To express IDs without the full membership
* flag, use PKEY_ID_NM. Note that kernel internally treats the interface as
* having the full membership flag set, this mainly affects the interface name.
* For the ifcfg file to be supported by initscripts' ifup-ib, the DEVICE=
* must always be set. NetworkManager does not require that.
* example: PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002
* ---end---
*/
_nm_setting_property_define_direct_int32(properties_override,
obj_properties,
NM_SETTING_INFINIBAND_P_KEY,
PROP_P_KEY,
-1,
0xFFFF,
-1,
NM_SETTING_PARAM_INFERRABLE,
NMSettingInfinibandPrivate,
p_key);
/**
* NMSettingInfiniband:parent:
*
* The interface name of the parent device of this device. Normally %NULL,
* but if the #NMSettingInfiniband:p_key property is set, then you must
* specify the base device by setting either this property or
* #NMSettingInfiniband:mac-address.
**/
/* ---ifcfg-rh---
* property: parent
* variable: PHYSDEV (PKEY=yes)
* default: PKEY=no
* description: InfiniBand parent device.
* example: PHYSDEV=ib0
* ---end---
*/
_nm_setting_property_define_direct_string(properties_override,
obj_properties,
NM_SETTING_INFINIBAND_PARENT,
PROP_PARENT,
NM_SETTING_PARAM_INFERRABLE,
NMSettingInfinibandPrivate,
parent);
g_object_class_install_properties(object_class, _PROPERTY_ENUMS_LAST, obj_properties);
_nm_setting_class_commit(setting_class,
NM_META_SETTING_TYPE_INFINIBAND,
NULL,
properties_override,
NM_SETT_INFO_PRIVATE_OFFSET_FROM_CLASS);
}
Reference in a new issue View git blame Copy permalink