libnm: add NMDeviceTun
authorBeniamino Galvani <bgalvani@redhat.com>
Fri, 4 Sep 2015 16:11:15 +0000 (18:11 +0200)
committerBeniamino Galvani <bgalvani@redhat.com>
Wed, 25 Nov 2015 10:39:57 +0000 (11:39 +0100)
libnm-core/nm-dbus-interface.h
libnm/Makefile.am
libnm/libnm.ver
libnm/nm-device-tun.c [new file with mode: 0644]
libnm/nm-device-tun.h [new file with mode: 0644]
libnm/nm-device.c
libnm/nm-types.h
po/POTFILES.in

index 68b0592..ddd6834 100644 (file)
@@ -148,6 +148,7 @@ typedef enum {
  * @NM_DEVICE_TYPE_ADSL: ADSL modem
  * @NM_DEVICE_TYPE_BRIDGE: a bridge master interface
  * @NM_DEVICE_TYPE_TEAM: a team master interface
+ * @NM_DEVICE_TYPE_TUN: a TUN or TAP interface
  *
  * #NMDeviceType values indicate the type of hardware represented by
  * an #NMDevice.
@@ -171,6 +172,7 @@ typedef enum {
        NM_DEVICE_TYPE_BRIDGE     = 13,
        NM_DEVICE_TYPE_GENERIC    = 14,
        NM_DEVICE_TYPE_TEAM       = 15,
+       NM_DEVICE_TYPE_TUN        = 16,
 } NMDeviceType;
 
 /**
index a08bd80..bf921ab 100644 (file)
@@ -41,6 +41,7 @@ libnminclude_hfiles =                 \
        nm-device-modem.h               \
        nm-device-olpc-mesh.h           \
        nm-device-team.h                \
+       nm-device-tun.h                 \
        nm-device-vlan.h                \
        nm-device-wifi.h                \
        nm-device-wimax.h               \
@@ -92,6 +93,7 @@ libnm_la_csources =                   \
        nm-device-modem.c               \
        nm-device-olpc-mesh.c           \
        nm-device-team.c                \
+       nm-device-tun.c                 \
        nm-device-vlan.c                \
        nm-device-wifi.c                \
        nm-device-wimax.c               \
index 06e7850..865cc32 100644 (file)
@@ -864,6 +864,14 @@ global:
        nm_device_get_metered;
        nm_device_get_nm_plugin_missing;
        nm_device_set_managed;
+       nm_device_tun_get_group;
+       nm_device_tun_get_hw_address;
+       nm_device_tun_get_mode;
+       nm_device_tun_get_multi_queue;
+       nm_device_tun_get_owner;
+       nm_device_tun_get_no_pi;
+       nm_device_tun_get_type;
+       nm_device_tun_get_vnet_hdr;
        nm_device_wifi_request_scan_options;
        nm_device_wifi_request_scan_options_async;
        nm_lldp_neighbor_get_attr_names;
diff --git a/libnm/nm-device-tun.c b/libnm/nm-device-tun.c
new file mode 100644 (file)
index 0000000..ce2558f
--- /dev/null
@@ -0,0 +1,439 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
+/*
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA.
+ *
+ * Copyright 2015 Red Hat, Inc.
+ */
+
+#include "config.h"
+
+#include <string.h>
+#include <arpa/inet.h>
+
+#include <nm-setting-connection.h>
+#include <nm-setting-tun.h>
+#include <nm-utils.h>
+
+#include "nm-default.h"
+#include "nm-device-tun.h"
+#include "nm-device-private.h"
+#include "nm-object-private.h"
+
+G_DEFINE_TYPE (NMDeviceTun, nm_device_tun, NM_TYPE_DEVICE)
+
+#define NM_DEVICE_TUN_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_DEVICE_TUN, NMDeviceTunPrivate))
+
+typedef struct {
+       char *hw_address;
+       char *mode;
+       gint64 owner;
+       gint64 group;
+       gboolean no_pi;
+       gboolean vnet_hdr;
+       gboolean multi_queue;
+} NMDeviceTunPrivate;
+
+enum {
+       PROP_0,
+       PROP_HW_ADDRESS,
+       PROP_MODE,
+       PROP_OWNER,
+       PROP_GROUP,
+       PROP_NO_PI,
+       PROP_VNET_HDR,
+       PROP_MULTI_QUEUE,
+
+       LAST_PROP
+};
+
+/**
+ * nm_device_tun_get_hw_address:
+ * @device: a #NMDeviceTun
+ *
+ * Gets the hardware (MAC) address of the #NMDeviceTun
+ *
+ * Returns: the hardware address. This is the internal string used by the
+ * device, and must not be modified.
+ *
+ * Since: 1.2
+ **/
+const char *
+nm_device_tun_get_hw_address (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), NULL);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->hw_address;
+}
+
+/**
+ * nm_device_tun_get_mode:
+ * @device: a #NMDeviceTun
+ *
+ * Returns the TUN/TAP mode for the device.
+ *
+ * Returns: 'tun' or 'tap'
+ *
+ * Since: 1.2
+ **/
+const char *
+nm_device_tun_get_mode (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), NULL);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->mode;
+}
+
+/**
+ * nm_device_tun_get_owner:
+ * @device: a #NMDeviceTun
+ *
+ * Gets the tunnel owner.
+ *
+ * Returns: the uid of the tunnel owner, or -1 if it has no owner.
+ *
+ * Since: 1.2
+ **/
+gint64
+nm_device_tun_get_owner (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), -1);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->owner;
+}
+
+/**
+ * nm_device_tun_get_group:
+ * @device: a #NMDeviceTun
+ *
+ * Gets the tunnel group.
+ *
+ * Returns: the gid of the tunnel group, or -1 if it has no owner.
+ *
+ * Since: 1.2
+ **/
+gint64
+nm_device_tun_get_group (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), -1);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->group;
+}
+
+/**
+ * nm_device_tun_get_pi:
+ * @device: a #NMDeviceTun
+ *
+ * Returns whether the #NMDeviceTun has the IFF_NO_PI flag.
+ *
+ * Returns: %TRUE if the device has the flag, %FALSE otherwise
+ *
+ * Since: 1.2
+ **/
+gboolean
+nm_device_tun_get_no_pi (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), FALSE);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->no_pi;
+}
+
+/**
+ * nm_device_tun_get_vnet_hdr:
+ * @device: a #NMDeviceTun
+ *
+ * Returns whether the #NMDeviceTun has the IFF_VNET_HDR flag.
+ *
+ * Returns: %TRUE if the device has the flag, %FALSE otherwise
+ *
+ * Since: 1.2
+ **/
+gboolean
+nm_device_tun_get_vnet_hdr (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), FALSE);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->vnet_hdr;
+}
+
+/**
+ * nm_device_tun_get_multi_queue:
+ * @device: a #NMDeviceTun
+ *
+ * Returns whether the #NMDeviceTun has the IFF_MULTI_QUEUE flag.
+ *
+ * Returns: %TRUE if the device doesn't have the flag, %FALSE otherwise
+ *
+ * Since: 1.2
+ **/
+gboolean
+nm_device_tun_get_multi_queue (NMDeviceTun *device)
+{
+       g_return_val_if_fail (NM_IS_DEVICE_TUN (device), FALSE);
+
+       return NM_DEVICE_TUN_GET_PRIVATE (device)->multi_queue;
+}
+
+static int
+tun_mode_from_string (const char *string)
+{
+       if (!g_strcmp0 (string, "tap"))
+               return NM_SETTING_TUN_MODE_TAP;
+       else
+               return NM_SETTING_TUN_MODE_TUN;
+}
+
+static gboolean
+connection_compatible (NMDevice *device, NMConnection *connection, GError **error)
+{
+       NMDeviceTunPrivate *priv = NM_DEVICE_TUN_GET_PRIVATE (device);
+       NMSettingTunMode mode;
+       NMSettingTun *s_tun;
+
+       if (!NM_DEVICE_CLASS (nm_device_tun_parent_class)->connection_compatible (device, connection, error))
+               return FALSE;
+
+       if (!nm_connection_is_type (connection, NM_SETTING_TUN_SETTING_NAME)) {
+               g_set_error_literal (error, NM_DEVICE_ERROR, NM_DEVICE_ERROR_INCOMPATIBLE_CONNECTION,
+                                    _("The connection was not a tun connection."));
+               return FALSE;
+       }
+
+       s_tun = nm_connection_get_setting_tun (connection);
+
+       mode = tun_mode_from_string (priv->mode);
+       if (s_tun && mode != nm_setting_tun_get_mode (s_tun)) {
+               g_set_error_literal (error, NM_DEVICE_ERROR, NM_DEVICE_ERROR_INCOMPATIBLE_CONNECTION,
+                                    _("The mode of the device and the connection didn't match"));
+               return FALSE;
+       }
+
+       return TRUE;
+}
+
+static GType
+get_setting_type (NMDevice *device)
+{
+       return NM_TYPE_SETTING_TUN;
+}
+
+static const char *
+get_hw_address (NMDevice *device)
+{
+       return nm_device_tun_get_hw_address (NM_DEVICE_TUN (device));
+}
+
+/***********************************************************/
+
+static void
+nm_device_tun_init (NMDeviceTun *device)
+{
+       _nm_device_set_device_type (NM_DEVICE (device), NM_DEVICE_TYPE_TUN);
+}
+
+static void
+init_dbus (NMObject *object)
+{
+       NMDeviceTunPrivate *priv = NM_DEVICE_TUN_GET_PRIVATE (object);
+       const NMPropertiesInfo property_info[] = {
+               { NM_DEVICE_TUN_HW_ADDRESS,  &priv->hw_address },
+               { NM_DEVICE_TUN_MODE,        &priv->mode },
+               { NM_DEVICE_TUN_OWNER,       &priv->owner },
+               { NM_DEVICE_TUN_GROUP,       &priv->group },
+               { NM_DEVICE_TUN_NO_PI,       &priv->no_pi },
+               { NM_DEVICE_TUN_VNET_HDR,    &priv->vnet_hdr },
+               { NM_DEVICE_TUN_MULTI_QUEUE, &priv->multi_queue },
+               { NULL },
+       };
+
+       NM_OBJECT_CLASS (nm_device_tun_parent_class)->init_dbus (object);
+
+       _nm_object_register_properties (object,
+                                       NM_DBUS_INTERFACE_DEVICE_TUN,
+                                       property_info);
+}
+
+static void
+finalize (GObject *object)
+{
+       NMDeviceTunPrivate *priv = NM_DEVICE_TUN_GET_PRIVATE (object);
+
+       g_free (priv->mode);
+
+       G_OBJECT_CLASS (nm_device_tun_parent_class)->finalize (object);
+}
+
+static void
+get_property (GObject *object,
+              guint prop_id,
+              GValue *value,
+              GParamSpec *pspec)
+{
+       NMDeviceTun *device = NM_DEVICE_TUN (object);
+
+       switch (prop_id) {
+       case PROP_HW_ADDRESS:
+               g_value_set_string (value, nm_device_tun_get_hw_address (device));
+               break;
+       case PROP_MODE:
+               g_value_set_string (value, nm_device_tun_get_mode (device));
+               break;
+       case PROP_OWNER:
+               g_value_set_int64 (value, nm_device_tun_get_owner (device));
+               break;
+       case PROP_GROUP:
+               g_value_set_int64 (value, nm_device_tun_get_group (device));
+               break;
+       case PROP_NO_PI:
+               g_value_set_boolean (value, nm_device_tun_get_no_pi (device));
+               break;
+       case PROP_VNET_HDR:
+               g_value_set_boolean (value, nm_device_tun_get_vnet_hdr (device));
+               break;
+       case PROP_MULTI_QUEUE:
+               g_value_set_boolean (value, nm_device_tun_get_multi_queue (device));
+               break;
+
+       default:
+               G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
+               break;
+       }
+}
+
+static void
+nm_device_tun_class_init (NMDeviceTunClass *gre_class)
+{
+       GObjectClass *object_class = G_OBJECT_CLASS (gre_class);
+       NMObjectClass *nm_object_class = NM_OBJECT_CLASS (gre_class);
+       NMDeviceClass *device_class = NM_DEVICE_CLASS (gre_class);
+
+       g_type_class_add_private (gre_class, sizeof (NMDeviceTunPrivate));
+
+       _nm_object_class_add_interface (nm_object_class, NM_DBUS_INTERFACE_DEVICE_TUN);
+
+       /* virtual methods */
+       object_class->finalize = finalize;
+       object_class->get_property = get_property;
+
+       nm_object_class->init_dbus = init_dbus;
+
+       device_class->connection_compatible = connection_compatible;
+       device_class->get_setting_type = get_setting_type;
+       device_class->get_hw_address = get_hw_address;
+
+       /* properties */
+
+       /**
+        * NMDeviceTun:hw-address:
+        *
+        * The hardware (MAC) address of the device.
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_HW_ADDRESS,
+                g_param_spec_string (NM_DEVICE_TUN_HW_ADDRESS, "", "",
+                                     NULL,
+                                     G_PARAM_READABLE |
+                                     G_PARAM_STATIC_STRINGS));
+
+       /**
+        * NMDeviceTun:mode:
+        *
+        * The tunnel mode, either "tun" or "tap".
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_MODE,
+                g_param_spec_string (NM_DEVICE_TUN_MODE, "", "",
+                                     NULL,
+                                     G_PARAM_READABLE |
+                                     G_PARAM_STATIC_STRINGS));
+
+       /**
+        * NMDeviceTun:owner:
+        *
+        * The uid of the tunnel owner, or -1 if it has no owner.
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_OWNER,
+                g_param_spec_int64 (NM_DEVICE_TUN_OWNER, "", "",
+                                    -1, G_MAXUINT32, -1,
+                                    G_PARAM_READABLE |
+                                    G_PARAM_STATIC_STRINGS));
+
+       /**
+        * NMDeviceTun:group:
+        *
+        * The gid of the tunnel group, or -1 if it has no owner.
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_GROUP,
+                g_param_spec_int64 (NM_DEVICE_TUN_GROUP, "", "",
+                                    -1, G_MAXUINT32, -1,
+                                    G_PARAM_READABLE |
+                                    G_PARAM_STATIC_STRINGS));
+
+       /**
+        * NMDeviceTun:no-pi:
+        *
+        * The tunnel's "TUN_NO_PI" flag; true if no protocol info is
+        * prepended to the tunnel packets.
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_NO_PI,
+                g_param_spec_boolean (NM_DEVICE_TUN_NO_PI, "", "",
+                                      FALSE,
+                                      G_PARAM_READABLE |
+                                      G_PARAM_STATIC_STRINGS));
+
+       /**
+        * NMDeviceTun:vnet-hdr:
+        *
+        * The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets
+        * include a virtio network header.
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_VNET_HDR,
+                g_param_spec_boolean (NM_DEVICE_TUN_VNET_HDR, "", "",
+                                      FALSE,
+                                      G_PARAM_READABLE |
+                                      G_PARAM_STATIC_STRINGS));
+
+       /**
+        * NMDeviceTun:multi-queue:
+        *
+        * The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to
+        * the tap device multiple times, for multiple send/receive
+        * queues.
+        *
+        * Since: 1.2
+        **/
+       g_object_class_install_property
+               (object_class, PROP_MULTI_QUEUE,
+                g_param_spec_boolean (NM_DEVICE_TUN_MULTI_QUEUE, "", "",
+                                      FALSE,
+                                      G_PARAM_READABLE |
+                                      G_PARAM_STATIC_STRINGS));
+}
diff --git a/libnm/nm-device-tun.h b/libnm/nm-device-tun.h
new file mode 100644 (file)
index 0000000..b83e2b3
--- /dev/null
@@ -0,0 +1,78 @@
+/* -*- Mode: C; tab-width: 4; indent-tabs-mode: t; c-basic-offset: 4 -*- */
+/*
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+ * Boston, MA 02110-1301 USA.
+ *
+ * Copyright 2015 Red Hat, Inc.
+ */
+
+#ifndef __NM_DEVICE_TUN_H__
+#define __NM_DEVICE_TUN_H__
+
+#if !defined (__NETWORKMANAGER_H_INSIDE__) && !defined(NETWORKMANAGER_COMPILATION)
+#error "Only <NetworkManager.h> can be included directly."
+#endif
+
+#include <nm-device.h>
+
+G_BEGIN_DECLS
+
+#define NM_TYPE_DEVICE_TUN            (nm_device_tun_get_type ())
+#define NM_DEVICE_TUN(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), NM_TYPE_DEVICE_TUN, NMDeviceTun))
+#define NM_DEVICE_TUN_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), NM_TYPE_DEVICE_TUN, NMDeviceTunClass))
+#define NM_IS_DEVICE_TUN(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), NM_TYPE_DEVICE_TUN))
+#define NM_IS_DEVICE_TUN_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), NM_TYPE_DEVICE_TUN))
+#define NM_DEVICE_TUN_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), NM_TYPE_DEVICE_TUN, NMDeviceTunClass))
+
+#define NM_DEVICE_TUN_HW_ADDRESS   "hw-address"
+#define NM_DEVICE_TUN_OWNER        "owner"
+#define NM_DEVICE_TUN_GROUP        "group"
+#define NM_DEVICE_TUN_MODE         "mode"
+#define NM_DEVICE_TUN_NO_PI        "no-pi"
+#define NM_DEVICE_TUN_VNET_HDR     "vnet-hdr"
+#define NM_DEVICE_TUN_MULTI_QUEUE  "multi-queue"
+
+struct _NMDeviceTun {
+       NMDevice parent;
+};
+
+typedef struct {
+       NMDeviceClass parent;
+
+       /*< private >*/
+       gpointer padding[4];
+} NMDeviceTunClass;
+
+NM_AVAILABLE_IN_1_2
+GType nm_device_tun_get_type (void);
+
+NM_AVAILABLE_IN_1_2
+const char * nm_device_tun_get_hw_address  (NMDeviceTun *device);
+NM_AVAILABLE_IN_1_2
+const char * nm_device_tun_get_mode        (NMDeviceTun *device);
+NM_AVAILABLE_IN_1_2
+gint64       nm_device_tun_get_owner       (NMDeviceTun *device);
+NM_AVAILABLE_IN_1_2
+gint64       nm_device_tun_get_group       (NMDeviceTun *device);
+NM_AVAILABLE_IN_1_2
+gboolean     nm_device_tun_get_no_pi       (NMDeviceTun *device);
+NM_AVAILABLE_IN_1_2
+gboolean     nm_device_tun_get_vnet_hdr    (NMDeviceTun *device);
+NM_AVAILABLE_IN_1_2
+gboolean     nm_device_tun_get_multi_queue (NMDeviceTun *device);
+
+G_END_DECLS
+
+#endif /* __NM_DEVICE_TUN_H__ */
index 2c354f2..e6e5126 100644 (file)
@@ -53,6 +53,7 @@
 #include "nm-core-internal.h"
 #include "nm-utils.h"
 #include "nm-dbus-helpers.h"
+#include "nm-device-tun.h"
 #include "nm-setting-connection.h"
 #include "nm-macros-internal.h"
 
@@ -362,6 +363,8 @@ _nm_device_gtype_from_dtype (NMDeviceType dtype)
                return NM_TYPE_DEVICE_VLAN;
        case NM_DEVICE_TYPE_GENERIC:
                return NM_TYPE_DEVICE_GENERIC;
+       case NM_DEVICE_TYPE_TUN:
+               return NM_TYPE_DEVICE_TUN;
        default:
                g_warning ("Unknown device type %d", dtype);
                return G_TYPE_INVALID;
index ee1ed64..334e4a1 100644 (file)
@@ -40,6 +40,7 @@ typedef struct _NMDeviceInfiniband  NMDeviceInfiniband;
 typedef struct _NMDeviceModem       NMDeviceModem;
 typedef struct _NMDeviceOlpcMesh    NMDeviceOlpcMesh;
 typedef struct _NMDeviceTeam        NMDeviceTeam;
+typedef struct _NMDeviceTun         NMDeviceTun;
 typedef struct _NMDeviceVlan        NMDeviceVlan;
 typedef struct _NMDeviceWifi        NMDeviceWifi;
 typedef struct _NMDeviceWimax       NMDeviceWimax;
index af5ccb2..ca4b76a 100644 (file)
@@ -117,6 +117,7 @@ libnm/nm-device-bridge.c
 libnm/nm-device-bt.c
 libnm/nm-device-ethernet.c
 libnm/nm-device-generic.c
+libnm/nm-device-tun.c
 libnm/nm-device-infiniband.c
 libnm/nm-device-modem.c
 libnm/nm-device-olpc-mesh.c