fdo-mirrors/NetworkManager
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git synced 2026-01-02 21:40:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
NetworkManager/shared/nm-platform/nm-platform-utils.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

74 lines
3.3 KiB
C
Raw Normal View History

all: update deprecated SPDX license identifiers These SPDX license identifiers are deprecated ([1]). Update them. [1] https://spdx.org/licenses/ sed \ -e '1 s%^/\* SPDX-License-Identifier: \(GPL-2.0\|LGPL-2.1\)+ \*/$%/* SPDX-License-Identifier: \1-or-later */%' \ -e '1,2 s%^\(--\|#\|//\) SPDX-License-Identifier: \(GPL-2.0\|LGPL-2.1\)+$%\1 SPDX-License-Identifier: \2-or-later%' \ -i \ $(git grep -l SPDX-License-Identifier -- \ ':(exclude)shared/c-*/' \ ':(exclude)shared/n-*/' \ ':(exclude)shared/systemd/src' \ ':(exclude)src/systemd/src')
2020-12-23 22:21:36 +01:00
/* SPDX-License-Identifier: GPL-2.0-or-later */
all: manually drop code comments with file description
2019-09-25 13:13:40 +02:00
/*
platform: add nm-platform-utils.[ch] files There is no general purpose file for platform utilities. We only have nm-platform.h, which contains (mostly) functions that operate on a NMPlatform instance (and that can be mocked using NMFakePlatform). Add a new file for independent utility functions. nm-platform-utils.c should not call into functions having a NMPlatform instance, to have them independent from platform caching and the platform singleton.
2015-04-14 22:34:01 +02:00
* Copyright (C) 2015 Red Hat, Inc.
*/
#ifndef __NM_PLATFORM_UTILS_H__
#define __NM_PLATFORM_UTILS_H__
libnm: add "shared/nm-base/nm-base.h" Our dependencies are complicated. Currently "src/platform" uses parts of libnm-core and is relatively strongly entangled with core. It would be nice to have that part clearly independent from "src" and from "libnm-core". Also, "src/platform/nm-platform-utils.h" uses NMEthtoolID enum, which previously was defined in "libnm-core/nm-libnm-core-intern/nm-ethtool-utils.h". Move that to a new place "shared/nm-base/nm-base.h". Note that we have "libnm-core/nm-libnm-core-intern", which is libnm/core related code which uses and is used by libnm-core. There is a need for a library which is used by libnm-core, but does not depend on libnm-core itself. Here comes "shared/nm-base". Yes, many libraries. But the goal is to entangle the dependencies and have a clear hierarchy of includes. And to have "shared/nm-platform" independent of libnm-core.
2020-12-30 21:20:26 +01:00
#include "nm-base/nm-base.h"
platform: move types from "nm-platform-utils.h" to nmp-base.h" Thereby, also no longer include "nm-platform.h" and "nm-setting-wired.h" in "nm-platform-utils.h".
2021-01-08 18:39:27 +01:00
#include "nm-platform/nmp-base.h"
platform/ethtool: add code to get/set offload features via ethtool Also, add two more features "tx-tcp-segmentation" and "tx-tcp6-segmentation". There are two reasons for that: - systemd-networkd supports setting these two features, so lets support them too (apparently they are important enough for networkd). - these two features are already implicitly covered by "tso". Like for the "ethtool" program, "tso" is an alias for several actual features. By adding two features that are already also covered by an alias (which sets multiple kernel names at once), we showcase how aliases for the same feature can coexist. In particular, note how setting "tso on tx-tcp6-segmentation off" will behave as one would expect: all 4 tso features covered by the alias are enabled, except that particular one.
2018-07-16 15:42:07 +02:00
/*****************************************************************************/
platform: add nm-platform-utils.[ch] files There is no general purpose file for platform utilities. We only have nm-platform.h, which contains (mostly) functions that operate on a NMPlatform instance (and that can be mocked using NMFakePlatform). Add a new file for independent utility functions. nm-platform-utils.c should not call into functions having a NMPlatform instance, to have them independent from platform caching and the platform singleton.
2015-04-14 22:34:01 +02:00
platform: lookup ifname for ethtool/mii ioctl immediately before use The ioctl APIs ethtool/mii require an interface ifname. That is inherrently racy as interfaces can be renamed. This cannot be fixed, we can only minimize the time between verifying the ifname and calling ioctl. We already had problems with that when ethtool would access an interface by name that didn't exists. See commit ab41c13b0611c6cc967b055d328637a143b5c59b . Checking for an existing interface only helps avoiding races when an interface gets deleted. It does not help against renaming. Go one step further, and instead of checking whether such an ifname exists, try to get the ifname based on the ifindex immediately before we need it. This brings an additional overhead for each ethtool access.
2016-12-11 22:46:14 +01:00
const char *nmp_utils_ethtool_get_driver(int ifindex);
gboolean nmp_utils_ethtool_supports_carrier_detect(int ifindex);
gboolean nmp_utils_ethtool_supports_vlans(int ifindex);
int nmp_utils_ethtool_get_peer_ifindex(int ifindex);
gboolean nmp_utils_ethtool_get_wake_on_lan(int ifindex);
platform: add duplicate of NMSettingWiredWakeOnLan to nm-base for platform Currently src/platform depends on libnm-core. libnm-core is large optimally we have a better separation between our code. That means libnm-core does not depend on platform and vice versa. However, nm-platform re-uses some enums from libnm-core for internal code. To avoid that dependency, add _NMSettingWiredWakeOnLan as a duplicate to nm-base/nm-base.h. nm-base can both be used by libnm-core, nm-platform and src/platform. The only problem is that NMSettingWiredWakeOnLan is also part of public API of libnm. It means, we must duplicate the enum. But with several static assertions in unit tests I think that is not a problem to do.
2021-01-08 17:01:45 +01:00
gboolean nmp_utils_ethtool_set_wake_on_lan(int ifindex,
_NMSettingWiredWakeOnLan wol,
const char * wol_password);
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
platform: move nm_platform_link_duplex_type_to_string() to "nm-platform-utils.c" There should be a clear hierarchie of dependency. That is, "nm-platform.h" may use "nm-platform-utils.h", but not the other way around. Move nm_platform_link_duplex_type_to_string().
2021-01-08 20:24:36 +01:00
const char *nm_platform_link_duplex_type_to_string(NMPlatformLinkDuplexType duplex);
platform: lookup ifname for ethtool/mii ioctl immediately before use The ioctl APIs ethtool/mii require an interface ifname. That is inherrently racy as interfaces can be renamed. This cannot be fixed, we can only minimize the time between verifying the ifname and calling ioctl. We already had problems with that when ethtool would access an interface by name that didn't exists. See commit ab41c13b0611c6cc967b055d328637a143b5c59b . Checking for an existing interface only helps avoiding races when an interface gets deleted. It does not help against renaming. Go one step further, and instead of checking whether such an ifname exists, try to get the ifname based on the ifindex immediately before we need it. This brings an additional overhead for each ethtool access.
2016-12-11 22:46:14 +01:00
gboolean nmp_utils_ethtool_get_link_settings(int ifindex,
gboolean * out_autoneg,
guint32 * out_speed,
NMPlatformLinkDuplexType *out_duplex);
gboolean nmp_utils_ethtool_set_link_settings(int ifindex,
gboolean autoneg,
guint32 speed,
NMPlatformLinkDuplexType duplex);
all: reformat all with new clang-format style Run: ./contrib/scripts/nm-code-format.sh -i ./contrib/scripts/nm-code-format.sh -i Yes, it needs to run twice because the first run doesn't yet produce the final result. Signed-off-by: Antonio Cardace <acardace@redhat.com>
2020-09-28 16:03:33 +02:00
platform: lookup ifname for ethtool/mii ioctl immediately before use The ioctl APIs ethtool/mii require an interface ifname. That is inherrently racy as interfaces can be renamed. This cannot be fixed, we can only minimize the time between verifying the ifname and calling ioctl. We already had problems with that when ethtool would access an interface by name that didn't exists. See commit ab41c13b0611c6cc967b055d328637a143b5c59b . Checking for an existing interface only helps avoiding races when an interface gets deleted. It does not help against renaming. Go one step further, and instead of checking whether such an ifname exists, try to get the ifname based on the ifindex immediately before we need it. This brings an additional overhead for each ethtool access.
2016-12-11 22:46:14 +01:00
gboolean nmp_utils_ethtool_get_permanent_address(int ifindex, guint8 *buf, size_t *length);
platform/ethtool: add code to get/set offload features via ethtool Also, add two more features "tx-tcp-segmentation" and "tx-tcp6-segmentation". There are two reasons for that: - systemd-networkd supports setting these two features, so lets support them too (apparently they are important enough for networkd). - these two features are already implicitly covered by "tso". Like for the "ethtool" program, "tso" is an alias for several actual features. By adding two features that are already also covered by an alias (which sets multiple kernel names at once), we showcase how aliases for the same feature can coexist. In particular, note how setting "tso on tx-tcp6-segmentation off" will behave as one would expect: all 4 tso features covered by the alias are enabled, except that particular one.
2018-07-16 15:42:07 +02:00
platform: lookup ifname for ethtool/mii ioctl immediately before use The ioctl APIs ethtool/mii require an interface ifname. That is inherrently racy as interfaces can be renamed. This cannot be fixed, we can only minimize the time between verifying the ifname and calling ioctl. We already had problems with that when ethtool would access an interface by name that didn't exists. See commit ab41c13b0611c6cc967b055d328637a143b5c59b . Checking for an existing interface only helps avoiding races when an interface gets deleted. It does not help against renaming. Go one step further, and instead of checking whether such an ifname exists, try to get the ifname based on the ifindex immediately before we need it. This brings an additional overhead for each ethtool access.
2016-12-11 22:46:14 +01:00
gboolean nmp_utils_ethtool_get_driver_info(int ifindex, NMPUtilsEthtoolDriverInfo *data);
platform: move ethtool_*() to nmp_utils_ethtool_*()
2015-05-02 07:59:59 +02:00
platform/ethtool: add code to get/set offload features via ethtool Also, add two more features "tx-tcp-segmentation" and "tx-tcp6-segmentation". There are two reasons for that: - systemd-networkd supports setting these two features, so lets support them too (apparently they are important enough for networkd). - these two features are already implicitly covered by "tso". Like for the "ethtool" program, "tso" is an alias for several actual features. By adding two features that are already also covered by an alias (which sets multiple kernel names at once), we showcase how aliases for the same feature can coexist. In particular, note how setting "tso on tx-tcp6-segmentation off" will behave as one would expect: all 4 tso features covered by the alias are enabled, except that particular one.
2018-07-16 15:42:07 +02:00
NMEthtoolFeatureStates *nmp_utils_ethtool_get_features(int ifindex);
gboolean nmp_utils_ethtool_set_features(
int ifindex,
const NMEthtoolFeatureStates *features,
platform: use NMOptionBool instead of NMTernary NMTernary is a dependency for libnm-core. Avoid it.
2021-01-10 16:51:37 +01:00
const NMOptionBool *requested /* indexed by NMEthtoolID - _NM_ETHTOOL_ID_FEATURE_FIRST */,
gboolean do_set /* or reset */);
platform/ethtool: add code to get/set offload features via ethtool Also, add two more features "tx-tcp-segmentation" and "tx-tcp6-segmentation". There are two reasons for that: - systemd-networkd supports setting these two features, so lets support them too (apparently they are important enough for networkd). - these two features are already implicitly covered by "tso". Like for the "ethtool" program, "tso" is an alias for several actual features. By adding two features that are already also covered by an alias (which sets multiple kernel names at once), we showcase how aliases for the same feature can coexist. In particular, note how setting "tso on tx-tcp6-segmentation off" will behave as one would expect: all 4 tso features covered by the alias are enabled, except that particular one.
2018-07-16 15:42:07 +02:00
platform: simplify NMEthtoolCoalesceState to only track one state Only in one moment we need the old and requested settings together: during _ethtool_coalesce_set(). But for that we shouldn't track both states in "NMEthtoolCoalesceState". Simplify "NMEthtoolCoalesceState" to only contain one set of options. By tracking less state, the code becomes simpler, because you don't need to wonder where the old and requested state is used.
2020-05-14 09:16:30 +02:00
gboolean nmp_utils_ethtool_get_coalesce(int ifindex, NMEthtoolCoalesceState *coalesce);
platform: add support for coalesce settings using ioctl() https://bugzilla.redhat.com/show_bug.cgi?id=1614700
2020-05-07 17:11:34 +02:00
gboolean nmp_utils_ethtool_set_coalesce(int ifindex, const NMEthtoolCoalesceState *coalesce);
platform: add support for ring settings using ioctl() https://bugzilla.redhat.com/show_bug.cgi?id=1614700
2020-05-14 18:27:54 +02:00
gboolean nmp_utils_ethtool_get_ring(int ifindex, NMEthtoolRingState *ring);
gboolean nmp_utils_ethtool_set_ring(int ifindex, const NMEthtoolRingState *ring);
platform/ethtool: add code to get/set offload features via ethtool Also, add two more features "tx-tcp-segmentation" and "tx-tcp6-segmentation". There are two reasons for that: - systemd-networkd supports setting these two features, so lets support them too (apparently they are important enough for networkd). - these two features are already implicitly covered by "tso". Like for the "ethtool" program, "tso" is an alias for several actual features. By adding two features that are already also covered by an alias (which sets multiple kernel names at once), we showcase how aliases for the same feature can coexist. In particular, note how setting "tso on tx-tcp6-segmentation off" will behave as one would expect: all 4 tso features covered by the alias are enabled, except that particular one.
2018-07-16 15:42:07 +02:00
/*****************************************************************************/
platform: move ethtool_*() to nmp_utils_ethtool_*()
2015-05-02 07:59:59 +02:00
platform: lookup ifname for ethtool/mii ioctl immediately before use The ioctl APIs ethtool/mii require an interface ifname. That is inherrently racy as interfaces can be renamed. This cannot be fixed, we can only minimize the time between verifying the ifname and calling ioctl. We already had problems with that when ethtool would access an interface by name that didn't exists. See commit ab41c13b0611c6cc967b055d328637a143b5c59b . Checking for an existing interface only helps avoiding races when an interface gets deleted. It does not help against renaming. Go one step further, and instead of checking whether such an ifname exists, try to get the ifname based on the ifindex immediately before we need it. This brings an additional overhead for each ethtool access.
2016-12-11 22:46:14 +01:00
gboolean nmp_utils_mii_supports_carrier_detect(int ifindex);
platform: move supports_mii_carrier_detect() to nmp_utils_mii_supports_carrier_detect()
2015-05-03 12:49:46 +02:00
udev: drop libgudev in favor of libudev libgudev is just a wrapper around libudev. We can use libudev directly and drop the dependency for libgudev.
2017-03-12 15:54:02 +01:00
struct udev_device;
const char *nmp_utils_udev_get_driver(struct udev_device *udevice);
platform: move code udev_get_driver() to nmp_utils_udev_get_driver()
2015-05-02 07:59:59 +02:00
platform: declare nmp_utils_ip_config_source_*() functions as const
2016-05-16 13:16:49 +02:00
NMIPConfigSource nmp_utils_ip_config_source_from_rtprot(guint8 rtprot) _nm_const;
guint8 nmp_utils_ip_config_source_coerce_to_rtprot(NMIPConfigSource source) _nm_const;
NMIPConfigSource nmp_utils_ip_config_source_coerce_from_rtprot(NMIPConfigSource source) _nm_const;
NMIPConfigSource nmp_utils_ip_config_source_round_trip_rtprot(NMIPConfigSource source) _nm_const;
platform: extend NMIPConfigSource to preserve the rtm_protocol field For addresses (NMPlatformIPAddress) the @addr_source field is ignored on a platform level. That is, all addresses inside the platform cache have this value set to NM_IP_CONFIG_SOURCE_KERNEL. Maybe, for that reason, the source should not be a part of the NMPlatformIPAddress structure, but it is convenient for users to piggy back the source inside the platform address structure. For routes, the source is stored in NMPlatformIPRoute's @rt_source field. When adding a route to kernel, we set the @rtm_protocol of the route depending on the source. However, we want to map different source values to the same protocol value. On the other hand, when kernel sends us a route that gets put inside the cache, we must preserve the protocol value and must not map different protocol values to the same source. The reason is, that a user can add two routes that only differ by @rtm_protocol. In that sense, the @rtm_protocol fields is part of the unique ID of a kernel route, and thus different values must map to different sources. Fix this, by extending the range of NMIPConfigSource to contain a range of protocol fields.
2016-04-11 17:35:29 +02:00
const char *nmp_utils_ip_config_source_to_string(NMIPConfigSource source, char *buf, gsize len);
platform: expose nmp_utils_ip_config_source_to/from_rtprot() Will be used also from the tests.
2016-04-10 12:01:51 +02:00
platform: add wrappers for if_nametoindex() and if_indextoname()
2016-12-26 11:54:30 +01:00
const char *nmp_utils_if_indextoname(int ifindex, char *out_ifname /*IFNAMSIZ*/);
int nmp_utils_if_nametoindex(const char *ifname);
platform: refactor nmp_utils_sysctl_open_netdir() - use nm_auto_close cleanup attribute - optionally, return the found ifname - don't stat "phy80211". If such an entity can be opened, just assume it's a directory.
2016-12-08 13:55:17 +01:00
int nmp_utils_sysctl_open_netdir(int ifindex, const char *ifname_guess, char *out_ifname);
platform: add a new function nmp_utils_open_sysctl() A race condition may happen when NetworkManager opens sysfs and udev renames interface name at the same time. Thomas Haller provides a new function [1] which can avoid the race condition when opening sysfs. This patch is a direct copy from [1]. [1] https://mail.gnome.org/archives/networkmanager-list/2016-December/msg00004.html Signed-off-by: Kai-Heng Feng <kai.heng.feng@canonical.com>
2016-12-07 18:15:13 +08:00
platform: add nm-platform-utils.[ch] files There is no general purpose file for platform utilities. We only have nm-platform.h, which contains (mostly) functions that operate on a NMPlatform instance (and that can be mocked using NMFakePlatform). Add a new file for independent utility functions. nm-platform-utils.c should not call into functions having a NMPlatform instance, to have them independent from platform caching and the platform singleton.
2015-04-14 22:34:01 +02:00
#endif /* __NM_PLATFORM_UTILS_H__ */
Reference in a new issue Copy permalink