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.

5 files changed, 152 insertions, 130 deletions

diff --git a/Makefile.am b/Makefile.am
index 5b8f8bab39..f7024a0ee6 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -553,6 +553,10 @@ EXTRA_DIST += \
 
 ###############################################################################
 
+EXTRA_DIST += shared/nm-base/nm-base.h
+
+###############################################################################
+
 noinst_LTLIBRARIES += libnm-core/nm-libnm-core-intern/libnm-libnm-core-intern.la
 
 libnm_core_nm_libnm_core_intern_libnm_libnm_core_intern_la_CPPFLAGS = \
diff --git a/libnm-core/nm-libnm-core-intern/nm-ethtool-utils.h b/libnm-core/nm-libnm-core-intern/nm-ethtool-utils.h
index 7afffe1b31..af99cd14aa 100644
--- a/libnm-core/nm-libnm-core-intern/nm-ethtool-utils.h
+++ b/libnm-core/nm-libnm-core-intern/nm-ethtool-utils.h
@@ -6,118 +6,9 @@
 #ifndef __NM_ETHTOOL_UTILS_H__
 #define __NM_ETHTOOL_UTILS_H__
 
-/*****************************************************************************/
-
-typedef enum {
-    NM_ETHTOOL_ID_UNKNOWN = -1,
-
-    _NM_ETHTOOL_ID_FIRST = 0,
-
-    _NM_ETHTOOL_ID_COALESCE_FIRST      = _NM_ETHTOOL_ID_FIRST,
-    NM_ETHTOOL_ID_COALESCE_ADAPTIVE_RX = _NM_ETHTOOL_ID_COALESCE_FIRST,
-    NM_ETHTOOL_ID_COALESCE_ADAPTIVE_TX,
-    NM_ETHTOOL_ID_COALESCE_PKT_RATE_HIGH,
-    NM_ETHTOOL_ID_COALESCE_PKT_RATE_LOW,
-    NM_ETHTOOL_ID_COALESCE_RX_FRAMES,
-    NM_ETHTOOL_ID_COALESCE_RX_FRAMES_HIGH,
-    NM_ETHTOOL_ID_COALESCE_RX_FRAMES_IRQ,
-    NM_ETHTOOL_ID_COALESCE_RX_FRAMES_LOW,
-    NM_ETHTOOL_ID_COALESCE_RX_USECS,
-    NM_ETHTOOL_ID_COALESCE_RX_USECS_HIGH,
-    NM_ETHTOOL_ID_COALESCE_RX_USECS_IRQ,
-    NM_ETHTOOL_ID_COALESCE_RX_USECS_LOW,
-    NM_ETHTOOL_ID_COALESCE_SAMPLE_INTERVAL,
-    NM_ETHTOOL_ID_COALESCE_STATS_BLOCK_USECS,
-    NM_ETHTOOL_ID_COALESCE_TX_FRAMES,
-    NM_ETHTOOL_ID_COALESCE_TX_FRAMES_HIGH,
-    NM_ETHTOOL_ID_COALESCE_TX_FRAMES_IRQ,
-    NM_ETHTOOL_ID_COALESCE_TX_FRAMES_LOW,
-    NM_ETHTOOL_ID_COALESCE_TX_USECS,
-    NM_ETHTOOL_ID_COALESCE_TX_USECS_HIGH,
-    NM_ETHTOOL_ID_COALESCE_TX_USECS_IRQ,
-    NM_ETHTOOL_ID_COALESCE_TX_USECS_LOW,
-    _NM_ETHTOOL_ID_COALESCE_LAST = NM_ETHTOOL_ID_COALESCE_TX_USECS_LOW,
-
-    _NM_ETHTOOL_ID_FEATURE_FIRST         = _NM_ETHTOOL_ID_COALESCE_LAST + 1,
-    NM_ETHTOOL_ID_FEATURE_ESP_HW_OFFLOAD = _NM_ETHTOOL_ID_FEATURE_FIRST,
-    NM_ETHTOOL_ID_FEATURE_ESP_TX_CSUM_HW_OFFLOAD,
-    NM_ETHTOOL_ID_FEATURE_FCOE_MTU,
-    NM_ETHTOOL_ID_FEATURE_GRO,
-    NM_ETHTOOL_ID_FEATURE_GSO,
-    NM_ETHTOOL_ID_FEATURE_HIGHDMA,
-    NM_ETHTOOL_ID_FEATURE_HW_TC_OFFLOAD,
-    NM_ETHTOOL_ID_FEATURE_L2_FWD_OFFLOAD,
-    NM_ETHTOOL_ID_FEATURE_LOOPBACK,
-    NM_ETHTOOL_ID_FEATURE_LRO,
-    NM_ETHTOOL_ID_FEATURE_NTUPLE,
-    NM_ETHTOOL_ID_FEATURE_RX,
-    NM_ETHTOOL_ID_FEATURE_RXHASH,
-    NM_ETHTOOL_ID_FEATURE_RXVLAN,
-    NM_ETHTOOL_ID_FEATURE_RX_ALL,
-    NM_ETHTOOL_ID_FEATURE_RX_FCS,
-    NM_ETHTOOL_ID_FEATURE_RX_GRO_HW,
-    NM_ETHTOOL_ID_FEATURE_RX_UDP_TUNNEL_PORT_OFFLOAD,
-    NM_ETHTOOL_ID_FEATURE_RX_VLAN_FILTER,
-    NM_ETHTOOL_ID_FEATURE_RX_VLAN_STAG_FILTER,
-    NM_ETHTOOL_ID_FEATURE_RX_VLAN_STAG_HW_PARSE,
-    NM_ETHTOOL_ID_FEATURE_SG,
-    NM_ETHTOOL_ID_FEATURE_TLS_HW_RECORD,
-    NM_ETHTOOL_ID_FEATURE_TLS_HW_TX_OFFLOAD,
-    NM_ETHTOOL_ID_FEATURE_TSO,
-    NM_ETHTOOL_ID_FEATURE_TX,
-    NM_ETHTOOL_ID_FEATURE_TXVLAN,
-    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_FCOE_CRC,
-    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_IPV4,
-    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_IPV6,
-    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_IP_GENERIC,
-    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_SCTP,
-    NM_ETHTOOL_ID_FEATURE_TX_ESP_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_FCOE_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_GRE_CSUM_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_GRE_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_GSO_PARTIAL,
-    NM_ETHTOOL_ID_FEATURE_TX_GSO_ROBUST,
-    NM_ETHTOOL_ID_FEATURE_TX_IPXIP4_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_IPXIP6_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_NOCACHE_COPY,
-    NM_ETHTOOL_ID_FEATURE_TX_SCATTER_GATHER,
-    NM_ETHTOOL_ID_FEATURE_TX_SCATTER_GATHER_FRAGLIST,
-    NM_ETHTOOL_ID_FEATURE_TX_SCTP_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_TCP6_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_TCP_ECN_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_TCP_MANGLEID_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_TCP_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_UDP_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_UDP_TNL_CSUM_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_UDP_TNL_SEGMENTATION,
-    NM_ETHTOOL_ID_FEATURE_TX_VLAN_STAG_HW_INSERT,
-    _NM_ETHTOOL_ID_FEATURE_LAST = NM_ETHTOOL_ID_FEATURE_TX_VLAN_STAG_HW_INSERT,
+#include "nm-base/nm-base.h"
 
-    _NM_ETHTOOL_ID_RING_FIRST = _NM_ETHTOOL_ID_FEATURE_LAST + 1,
-    NM_ETHTOOL_ID_RING_RX     = _NM_ETHTOOL_ID_RING_FIRST,
-    NM_ETHTOOL_ID_RING_RX_JUMBO,
-    NM_ETHTOOL_ID_RING_RX_MINI,
-    NM_ETHTOOL_ID_RING_TX,
-    _NM_ETHTOOL_ID_RING_LAST = NM_ETHTOOL_ID_RING_TX,
-
-    _NM_ETHTOOL_ID_LAST = _NM_ETHTOOL_ID_RING_LAST,
-
-    _NM_ETHTOOL_ID_COALESCE_NUM =
-        (_NM_ETHTOOL_ID_COALESCE_LAST - _NM_ETHTOOL_ID_COALESCE_FIRST + 1),
-    _NM_ETHTOOL_ID_FEATURE_NUM = (_NM_ETHTOOL_ID_FEATURE_LAST - _NM_ETHTOOL_ID_FEATURE_FIRST + 1),
-    _NM_ETHTOOL_ID_RING_NUM    = (_NM_ETHTOOL_ID_RING_LAST - _NM_ETHTOOL_ID_RING_FIRST + 1),
-    _NM_ETHTOOL_ID_NUM         = (_NM_ETHTOOL_ID_LAST - _NM_ETHTOOL_ID_FIRST + 1),
-} NMEthtoolID;
-
-#define _NM_ETHTOOL_ID_FEATURE_AS_IDX(ethtool_id)  ((ethtool_id) -_NM_ETHTOOL_ID_FEATURE_FIRST)
-#define _NM_ETHTOOL_ID_COALESCE_AS_IDX(ethtool_id) ((ethtool_id) -_NM_ETHTOOL_ID_COALESCE_FIRST)
-
-typedef enum {
-    NM_ETHTOOL_TYPE_UNKNOWN,
-    NM_ETHTOOL_TYPE_COALESCE,
-    NM_ETHTOOL_TYPE_FEATURE,
-    NM_ETHTOOL_TYPE_RING,
-} NMEthtoolType;
+/*****************************************************************************/
 
 typedef struct {
     const char *optname;
@@ -141,24 +32,6 @@ nm_ethtool_id_get_by_name(const char *optname)
     return d ? d->id : NM_ETHTOOL_ID_UNKNOWN;
 }
 
-static inline gboolean
-nm_ethtool_id_is_feature(NMEthtoolID id)
-{
-    return id >= _NM_ETHTOOL_ID_FEATURE_FIRST && id <= _NM_ETHTOOL_ID_FEATURE_LAST;
-}
-
-static inline gboolean
-nm_ethtool_id_is_coalesce(NMEthtoolID id)
-{
-    return id >= _NM_ETHTOOL_ID_COALESCE_FIRST && id <= _NM_ETHTOOL_ID_COALESCE_LAST;
-}
-
-static inline gboolean
-nm_ethtool_id_is_ring(NMEthtoolID id)
-{
-    return id >= _NM_ETHTOOL_ID_RING_FIRST && id <= _NM_ETHTOOL_ID_RING_LAST;
-}
-
 /****************************************************************************/
 
 #endif /* __NM_ETHTOOL_UTILS_H__ */
diff --git a/shared/nm-base/nm-base.h b/shared/nm-base/nm-base.h
new file mode 100644
index 0000000000..b3e7134b61
--- /dev/null
+++ b/shared/nm-base/nm-base.h
@@ -0,0 +1,144 @@
+/* SPDX-License-Identifier: LGPL-2.1-or-later */
+/*
+ * Copyright (C) 2018 Red Hat, Inc.
+ */
+
+#ifndef __NM_LIBNM_BASE_H__
+#define __NM_LIBNM_BASE_H__
+
+/*****************************************************************************/
+
+typedef enum {
+    NM_ETHTOOL_ID_UNKNOWN = -1,
+
+    _NM_ETHTOOL_ID_FIRST = 0,
+
+    _NM_ETHTOOL_ID_COALESCE_FIRST      = _NM_ETHTOOL_ID_FIRST,
+    NM_ETHTOOL_ID_COALESCE_ADAPTIVE_RX = _NM_ETHTOOL_ID_COALESCE_FIRST,
+    NM_ETHTOOL_ID_COALESCE_ADAPTIVE_TX,
+    NM_ETHTOOL_ID_COALESCE_PKT_RATE_HIGH,
+    NM_ETHTOOL_ID_COALESCE_PKT_RATE_LOW,
+    NM_ETHTOOL_ID_COALESCE_RX_FRAMES,
+    NM_ETHTOOL_ID_COALESCE_RX_FRAMES_HIGH,
+    NM_ETHTOOL_ID_COALESCE_RX_FRAMES_IRQ,
+    NM_ETHTOOL_ID_COALESCE_RX_FRAMES_LOW,
+    NM_ETHTOOL_ID_COALESCE_RX_USECS,
+    NM_ETHTOOL_ID_COALESCE_RX_USECS_HIGH,
+    NM_ETHTOOL_ID_COALESCE_RX_USECS_IRQ,
+    NM_ETHTOOL_ID_COALESCE_RX_USECS_LOW,
+    NM_ETHTOOL_ID_COALESCE_SAMPLE_INTERVAL,
+    NM_ETHTOOL_ID_COALESCE_STATS_BLOCK_USECS,
+    NM_ETHTOOL_ID_COALESCE_TX_FRAMES,
+    NM_ETHTOOL_ID_COALESCE_TX_FRAMES_HIGH,
+    NM_ETHTOOL_ID_COALESCE_TX_FRAMES_IRQ,
+    NM_ETHTOOL_ID_COALESCE_TX_FRAMES_LOW,
+    NM_ETHTOOL_ID_COALESCE_TX_USECS,
+    NM_ETHTOOL_ID_COALESCE_TX_USECS_HIGH,
+    NM_ETHTOOL_ID_COALESCE_TX_USECS_IRQ,
+    NM_ETHTOOL_ID_COALESCE_TX_USECS_LOW,
+    _NM_ETHTOOL_ID_COALESCE_LAST = NM_ETHTOOL_ID_COALESCE_TX_USECS_LOW,
+
+    _NM_ETHTOOL_ID_FEATURE_FIRST         = _NM_ETHTOOL_ID_COALESCE_LAST + 1,
+    NM_ETHTOOL_ID_FEATURE_ESP_HW_OFFLOAD = _NM_ETHTOOL_ID_FEATURE_FIRST,
+    NM_ETHTOOL_ID_FEATURE_ESP_TX_CSUM_HW_OFFLOAD,
+    NM_ETHTOOL_ID_FEATURE_FCOE_MTU,
+    NM_ETHTOOL_ID_FEATURE_GRO,
+    NM_ETHTOOL_ID_FEATURE_GSO,
+    NM_ETHTOOL_ID_FEATURE_HIGHDMA,
+    NM_ETHTOOL_ID_FEATURE_HW_TC_OFFLOAD,
+    NM_ETHTOOL_ID_FEATURE_L2_FWD_OFFLOAD,
+    NM_ETHTOOL_ID_FEATURE_LOOPBACK,
+    NM_ETHTOOL_ID_FEATURE_LRO,
+    NM_ETHTOOL_ID_FEATURE_NTUPLE,
+    NM_ETHTOOL_ID_FEATURE_RX,
+    NM_ETHTOOL_ID_FEATURE_RXHASH,
+    NM_ETHTOOL_ID_FEATURE_RXVLAN,
+    NM_ETHTOOL_ID_FEATURE_RX_ALL,
+    NM_ETHTOOL_ID_FEATURE_RX_FCS,
+    NM_ETHTOOL_ID_FEATURE_RX_GRO_HW,
+    NM_ETHTOOL_ID_FEATURE_RX_UDP_TUNNEL_PORT_OFFLOAD,
+    NM_ETHTOOL_ID_FEATURE_RX_VLAN_FILTER,
+    NM_ETHTOOL_ID_FEATURE_RX_VLAN_STAG_FILTER,
+    NM_ETHTOOL_ID_FEATURE_RX_VLAN_STAG_HW_PARSE,
+    NM_ETHTOOL_ID_FEATURE_SG,
+    NM_ETHTOOL_ID_FEATURE_TLS_HW_RECORD,
+    NM_ETHTOOL_ID_FEATURE_TLS_HW_TX_OFFLOAD,
+    NM_ETHTOOL_ID_FEATURE_TSO,
+    NM_ETHTOOL_ID_FEATURE_TX,
+    NM_ETHTOOL_ID_FEATURE_TXVLAN,
+    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_FCOE_CRC,
+    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_IPV4,
+    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_IPV6,
+    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_IP_GENERIC,
+    NM_ETHTOOL_ID_FEATURE_TX_CHECKSUM_SCTP,
+    NM_ETHTOOL_ID_FEATURE_TX_ESP_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_FCOE_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_GRE_CSUM_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_GRE_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_GSO_PARTIAL,
+    NM_ETHTOOL_ID_FEATURE_TX_GSO_ROBUST,
+    NM_ETHTOOL_ID_FEATURE_TX_IPXIP4_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_IPXIP6_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_NOCACHE_COPY,
+    NM_ETHTOOL_ID_FEATURE_TX_SCATTER_GATHER,
+    NM_ETHTOOL_ID_FEATURE_TX_SCATTER_GATHER_FRAGLIST,
+    NM_ETHTOOL_ID_FEATURE_TX_SCTP_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_TCP6_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_TCP_ECN_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_TCP_MANGLEID_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_TCP_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_UDP_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_UDP_TNL_CSUM_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_UDP_TNL_SEGMENTATION,
+    NM_ETHTOOL_ID_FEATURE_TX_VLAN_STAG_HW_INSERT,
+    _NM_ETHTOOL_ID_FEATURE_LAST = NM_ETHTOOL_ID_FEATURE_TX_VLAN_STAG_HW_INSERT,
+
+    _NM_ETHTOOL_ID_RING_FIRST = _NM_ETHTOOL_ID_FEATURE_LAST + 1,
+    NM_ETHTOOL_ID_RING_RX     = _NM_ETHTOOL_ID_RING_FIRST,
+    NM_ETHTOOL_ID_RING_RX_JUMBO,
+    NM_ETHTOOL_ID_RING_RX_MINI,
+    NM_ETHTOOL_ID_RING_TX,
+    _NM_ETHTOOL_ID_RING_LAST = NM_ETHTOOL_ID_RING_TX,
+
+    _NM_ETHTOOL_ID_LAST = _NM_ETHTOOL_ID_RING_LAST,
+
+    _NM_ETHTOOL_ID_COALESCE_NUM =
+        (_NM_ETHTOOL_ID_COALESCE_LAST - _NM_ETHTOOL_ID_COALESCE_FIRST + 1),
+    _NM_ETHTOOL_ID_FEATURE_NUM = (_NM_ETHTOOL_ID_FEATURE_LAST - _NM_ETHTOOL_ID_FEATURE_FIRST + 1),
+    _NM_ETHTOOL_ID_RING_NUM    = (_NM_ETHTOOL_ID_RING_LAST - _NM_ETHTOOL_ID_RING_FIRST + 1),
+    _NM_ETHTOOL_ID_NUM         = (_NM_ETHTOOL_ID_LAST - _NM_ETHTOOL_ID_FIRST + 1),
+} NMEthtoolID;
+
+#define _NM_ETHTOOL_ID_FEATURE_AS_IDX(ethtool_id)  ((ethtool_id) -_NM_ETHTOOL_ID_FEATURE_FIRST)
+#define _NM_ETHTOOL_ID_COALESCE_AS_IDX(ethtool_id) ((ethtool_id) -_NM_ETHTOOL_ID_COALESCE_FIRST)
+
+typedef enum {
+    NM_ETHTOOL_TYPE_UNKNOWN,
+    NM_ETHTOOL_TYPE_COALESCE,
+    NM_ETHTOOL_TYPE_FEATURE,
+    NM_ETHTOOL_TYPE_RING,
+} NMEthtoolType;
+
+/****************************************************************************/
+
+static inline gboolean
+nm_ethtool_id_is_feature(NMEthtoolID id)
+{
+    return id >= _NM_ETHTOOL_ID_FEATURE_FIRST && id <= _NM_ETHTOOL_ID_FEATURE_LAST;
+}
+
+static inline gboolean
+nm_ethtool_id_is_coalesce(NMEthtoolID id)
+{
+    return id >= _NM_ETHTOOL_ID_COALESCE_FIRST && id <= _NM_ETHTOOL_ID_COALESCE_LAST;
+}
+
+static inline gboolean
+nm_ethtool_id_is_ring(NMEthtoolID id)
+{
+    return id >= _NM_ETHTOOL_ID_RING_FIRST && id <= _NM_ETHTOOL_ID_RING_LAST;
+}
+
+/****************************************************************************/
+
+#endif /* __NM_LIBNM_BASE_H__ */
diff --git a/src/platform/nm-platform-utils.h b/src/platform/nm-platform-utils.h
index 4e778f0768..5f209208c3 100644
--- a/src/platform/nm-platform-utils.h
+++ b/src/platform/nm-platform-utils.h
@@ -8,7 +8,7 @@
 
 #include "nm-platform.h"
 #include "nm-setting-wired.h"
-#include "nm-libnm-core-intern/nm-ethtool-utils.h"
+#include "nm-base/nm-base.h"
 
 /*****************************************************************************/
 
diff --git a/src/platform/tests/test-link.c b/src/platform/tests/test-link.c
index 7deca0e074..c50a66f7a8 100644
--- a/src/platform/tests/test-link.c
+++ b/src/platform/tests/test-link.c
@@ -12,6 +12,7 @@
 #include <linux/if_tun.h>
 
 #include "nm-glib-aux/nm-io-utils.h"
+#include "nm-libnm-core-intern/nm-ethtool-utils.h"
 #include "platform/nmp-object.h"
 #include "nm-platform/nmp-netns.h"
 #include "platform/nm-platform-utils.h"