mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager
synced 2024-07-23 11:14:29 +00:00
40bb402898
Simplify the use of _nm_register_setting() by having it splice together various symbol names itself rather than requiring them to be specified explicitly, and extend it to also ensure that the type's corresponding error type is registered (allowing one to find it via g_type_from_name() if necessary).
525 lines
15 KiB
C
525 lines
15 KiB
C
/* -*- 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 2011 - 2013 Red Hat, Inc.
|
|
*/
|
|
|
|
#include <string.h>
|
|
#include <ctype.h>
|
|
#include <stdlib.h>
|
|
#include <dbus/dbus-glib.h>
|
|
#include <glib/gi18n.h>
|
|
|
|
#include "nm-setting-bridge.h"
|
|
#include "nm-param-spec-specialized.h"
|
|
#include "nm-setting-private.h"
|
|
#include "nm-utils.h"
|
|
#include "nm-utils-private.h"
|
|
#include "nm-dbus-glib-types.h"
|
|
|
|
/**
|
|
* SECTION:nm-setting-bridge
|
|
* @short_description: Describes connection properties for bridges
|
|
*
|
|
* The #NMSettingBridge object is a #NMSetting subclass that describes properties
|
|
* necessary for bridging connections.
|
|
**/
|
|
|
|
/**
|
|
* nm_setting_bridge_error_quark:
|
|
*
|
|
* Registers an error quark for #NMSettingBridge if necessary.
|
|
*
|
|
* Returns: the error quark used for #NMSettingBridge errors.
|
|
**/
|
|
GQuark
|
|
nm_setting_bridge_error_quark (void)
|
|
{
|
|
static GQuark quark;
|
|
|
|
if (G_UNLIKELY (!quark))
|
|
quark = g_quark_from_static_string ("nm-setting-bridge-error-quark");
|
|
return quark;
|
|
}
|
|
|
|
|
|
G_DEFINE_TYPE_WITH_CODE (NMSettingBridge, nm_setting_bridge, NM_TYPE_SETTING,
|
|
_nm_register_setting (BRIDGE, 1))
|
|
NM_SETTING_REGISTER_TYPE (NM_TYPE_SETTING_BRIDGE)
|
|
|
|
#define NM_SETTING_BRIDGE_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_SETTING_BRIDGE, NMSettingBridgePrivate))
|
|
|
|
typedef struct {
|
|
char * interface_name;
|
|
GByteArray *mac_address;
|
|
gboolean stp;
|
|
guint16 priority;
|
|
guint16 forward_delay;
|
|
guint16 hello_time;
|
|
guint16 max_age;
|
|
guint32 ageing_time;
|
|
} NMSettingBridgePrivate;
|
|
|
|
enum {
|
|
PROP_0,
|
|
PROP_INTERFACE_NAME,
|
|
PROP_MAC_ADDRESS,
|
|
PROP_STP,
|
|
PROP_PRIORITY,
|
|
PROP_FORWARD_DELAY,
|
|
PROP_HELLO_TIME,
|
|
PROP_MAX_AGE,
|
|
PROP_AGEING_TIME,
|
|
LAST_PROP
|
|
};
|
|
|
|
/**
|
|
* nm_setting_bridge_new:
|
|
*
|
|
* Creates a new #NMSettingBridge object with default values.
|
|
*
|
|
* Returns: (transfer full): the new empty #NMSettingBridge object
|
|
**/
|
|
NMSetting *
|
|
nm_setting_bridge_new (void)
|
|
{
|
|
return (NMSetting *) g_object_new (NM_TYPE_SETTING_BRIDGE, NULL);
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_interface_name:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:interface-name property of the setting
|
|
**/
|
|
const char *
|
|
nm_setting_bridge_get_interface_name (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), 0);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->interface_name;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_mac_address:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:mac-address property of the setting
|
|
**/
|
|
const GByteArray *
|
|
nm_setting_bridge_get_mac_address (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), NULL);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->mac_address;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_stp:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:stp property of the setting
|
|
**/
|
|
gboolean
|
|
nm_setting_bridge_get_stp (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), FALSE);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->stp;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_priority:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:priority property of the setting
|
|
**/
|
|
guint16
|
|
nm_setting_bridge_get_priority (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), 0);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->priority;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_forward_delay:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:forward-delay property of the setting
|
|
**/
|
|
guint16
|
|
nm_setting_bridge_get_forward_delay (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), 0);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->forward_delay;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_hello_time:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:hello-time property of the setting
|
|
**/
|
|
guint16
|
|
nm_setting_bridge_get_hello_time (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), 0);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->hello_time;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_max_age:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:max-age property of the setting
|
|
**/
|
|
guint16
|
|
nm_setting_bridge_get_max_age (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), 0);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->max_age;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bridge_get_ageing_time:
|
|
* @setting: the #NMSettingBridge
|
|
*
|
|
* Returns: the #NMSettingBridge:ageing-time property of the setting
|
|
**/
|
|
guint
|
|
nm_setting_bridge_get_ageing_time (NMSettingBridge *setting)
|
|
{
|
|
g_return_val_if_fail (NM_IS_SETTING_BRIDGE (setting), 0);
|
|
|
|
return NM_SETTING_BRIDGE_GET_PRIVATE (setting)->ageing_time;
|
|
}
|
|
|
|
/* IEEE 802.1D-1998 timer values */
|
|
#define BR_MIN_HELLO_TIME 1
|
|
#define BR_MAX_HELLO_TIME 10
|
|
|
|
#define BR_MIN_FORWARD_DELAY 2
|
|
#define BR_MAX_FORWARD_DELAY 30
|
|
|
|
#define BR_MIN_MAX_AGE 6
|
|
#define BR_MAX_MAX_AGE 40
|
|
|
|
/* IEEE 802.1D-1998 Table 7.4 */
|
|
#define BR_MIN_AGEING_TIME 0
|
|
#define BR_MAX_AGEING_TIME 1000000
|
|
|
|
static inline gboolean
|
|
check_range (guint32 val,
|
|
guint32 min,
|
|
guint32 max,
|
|
const char *prop,
|
|
GError **error)
|
|
{
|
|
if ((val != 0) && (val < min || val > max)) {
|
|
g_set_error (error,
|
|
NM_SETTING_BRIDGE_ERROR,
|
|
NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY,
|
|
_("value '%d' is out of range <%d-%d>"),
|
|
val, min, max);
|
|
g_prefix_error (error, "%s.%s: ", NM_SETTING_BRIDGE_SETTING_NAME, prop);
|
|
return FALSE;
|
|
}
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
verify (NMSetting *setting, GSList *all_settings, GError **error)
|
|
{
|
|
NMSettingBridgePrivate *priv = NM_SETTING_BRIDGE_GET_PRIVATE (setting);
|
|
|
|
if (priv->mac_address && priv->mac_address->len != ETH_ALEN) {
|
|
g_set_error_literal (error,
|
|
NM_SETTING_BRIDGE_ERROR,
|
|
NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY,
|
|
_("is not a valid MAC address"));
|
|
g_prefix_error (error, "%s.%s: ", NM_SETTING_BRIDGE_SETTING_NAME, NM_SETTING_BRIDGE_MAC_ADDRESS);
|
|
return FALSE;
|
|
}
|
|
|
|
if (!check_range (priv->forward_delay,
|
|
BR_MIN_FORWARD_DELAY,
|
|
BR_MAX_FORWARD_DELAY,
|
|
NM_SETTING_BRIDGE_FORWARD_DELAY,
|
|
error))
|
|
return FALSE;
|
|
|
|
if (!check_range (priv->hello_time,
|
|
BR_MIN_HELLO_TIME,
|
|
BR_MAX_HELLO_TIME,
|
|
NM_SETTING_BRIDGE_HELLO_TIME,
|
|
error))
|
|
return FALSE;
|
|
|
|
if (!check_range (priv->max_age,
|
|
BR_MIN_MAX_AGE,
|
|
BR_MAX_MAX_AGE,
|
|
NM_SETTING_BRIDGE_MAX_AGE,
|
|
error))
|
|
return FALSE;
|
|
|
|
if (!check_range (priv->ageing_time,
|
|
BR_MIN_AGEING_TIME,
|
|
BR_MAX_AGEING_TIME,
|
|
NM_SETTING_BRIDGE_AGEING_TIME,
|
|
error))
|
|
return FALSE;
|
|
|
|
return _nm_setting_verify_deprecated_virtual_iface_name (
|
|
priv->interface_name, FALSE,
|
|
NM_SETTING_BRIDGE_SETTING_NAME, NM_SETTING_BRIDGE_INTERFACE_NAME,
|
|
NM_SETTING_BRIDGE_ERROR,
|
|
NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY,
|
|
NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY,
|
|
all_settings, error);
|
|
}
|
|
|
|
static void
|
|
nm_setting_bridge_init (NMSettingBridge *setting)
|
|
{
|
|
}
|
|
|
|
static void
|
|
finalize (GObject *object)
|
|
{
|
|
NMSettingBridgePrivate *priv = NM_SETTING_BRIDGE_GET_PRIVATE (object);
|
|
|
|
g_free (priv->interface_name);
|
|
|
|
if (priv->mac_address)
|
|
g_byte_array_free (priv->mac_address, TRUE);
|
|
|
|
G_OBJECT_CLASS (nm_setting_bridge_parent_class)->finalize (object);
|
|
}
|
|
|
|
static void
|
|
set_property (GObject *object, guint prop_id,
|
|
const GValue *value, GParamSpec *pspec)
|
|
{
|
|
NMSettingBridgePrivate *priv = NM_SETTING_BRIDGE_GET_PRIVATE (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_INTERFACE_NAME:
|
|
g_free (priv->interface_name);
|
|
priv->interface_name = g_value_dup_string (value);
|
|
break;
|
|
case PROP_MAC_ADDRESS:
|
|
if (priv->mac_address)
|
|
g_byte_array_free (priv->mac_address, TRUE);
|
|
priv->mac_address = g_value_dup_boxed (value);
|
|
break;
|
|
case PROP_STP:
|
|
priv->stp = g_value_get_boolean (value);
|
|
break;
|
|
case PROP_PRIORITY:
|
|
priv->priority = (guint16) g_value_get_uint (value);
|
|
break;
|
|
case PROP_FORWARD_DELAY:
|
|
priv->forward_delay = (guint16) g_value_get_uint (value);
|
|
break;
|
|
case PROP_HELLO_TIME:
|
|
priv->hello_time = (guint16) g_value_get_uint (value);
|
|
break;
|
|
case PROP_MAX_AGE:
|
|
priv->max_age = (guint16) g_value_get_uint (value);
|
|
break;
|
|
case PROP_AGEING_TIME:
|
|
priv->ageing_time = g_value_get_uint (value);
|
|
break;
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
get_property (GObject *object, guint prop_id,
|
|
GValue *value, GParamSpec *pspec)
|
|
{
|
|
NMSettingBridgePrivate *priv = NM_SETTING_BRIDGE_GET_PRIVATE (object);
|
|
NMSettingBridge *setting = NM_SETTING_BRIDGE (object);
|
|
|
|
switch (prop_id) {
|
|
case PROP_INTERFACE_NAME:
|
|
g_value_set_string (value, nm_setting_bridge_get_interface_name (setting));
|
|
break;
|
|
case PROP_MAC_ADDRESS:
|
|
g_value_set_boxed (value, nm_setting_bridge_get_mac_address (setting));
|
|
break;
|
|
case PROP_STP:
|
|
g_value_set_boolean (value, priv->stp);
|
|
break;
|
|
case PROP_PRIORITY:
|
|
g_value_set_uint (value, priv->priority);
|
|
break;
|
|
case PROP_FORWARD_DELAY:
|
|
g_value_set_uint (value, priv->forward_delay);
|
|
break;
|
|
case PROP_HELLO_TIME:
|
|
g_value_set_uint (value, priv->hello_time);
|
|
break;
|
|
case PROP_MAX_AGE:
|
|
g_value_set_uint (value, priv->max_age);
|
|
break;
|
|
case PROP_AGEING_TIME:
|
|
g_value_set_uint (value, priv->ageing_time);
|
|
break;
|
|
default:
|
|
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
|
|
break;
|
|
}
|
|
}
|
|
|
|
static void
|
|
nm_setting_bridge_class_init (NMSettingBridgeClass *setting_class)
|
|
{
|
|
GObjectClass *object_class = G_OBJECT_CLASS (setting_class);
|
|
NMSettingClass *parent_class = NM_SETTING_CLASS (setting_class);
|
|
|
|
g_type_class_add_private (setting_class, sizeof (NMSettingBridgePrivate));
|
|
|
|
/* virtual methods */
|
|
object_class->set_property = set_property;
|
|
object_class->get_property = get_property;
|
|
object_class->finalize = finalize;
|
|
parent_class->verify = verify;
|
|
|
|
/* Properties */
|
|
/**
|
|
* NMSettingBridge:interface-name:
|
|
*
|
|
* The name of the virtual in-kernel bridging network interface
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_INTERFACE_NAME,
|
|
g_param_spec_string (NM_SETTING_BRIDGE_INTERFACE_NAME, "", "",
|
|
NULL,
|
|
G_PARAM_READWRITE |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:mac-address:
|
|
*
|
|
* If specified, the MAC address of bridge. When creating a new bridge, this
|
|
* MAC address will be set. When matching an existing (outside
|
|
* NetworkManager created) bridge, this MAC address must match.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_MAC_ADDRESS,
|
|
_nm_param_spec_specialized (NM_SETTING_BRIDGE_MAC_ADDRESS, "", "",
|
|
DBUS_TYPE_G_UCHAR_ARRAY,
|
|
G_PARAM_READWRITE |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:stp:
|
|
*
|
|
* Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_STP,
|
|
g_param_spec_boolean (NM_SETTING_BRIDGE_STP, "", "",
|
|
TRUE,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:priority:
|
|
*
|
|
* Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower
|
|
* values are "better"; the lowest priority bridge will be elected the root
|
|
* bridge.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_PRIORITY,
|
|
g_param_spec_uint (NM_SETTING_BRIDGE_PRIORITY, "", "",
|
|
0, G_MAXUINT16, 0x8000,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:forward-delay:
|
|
*
|
|
* The Spanning Tree Protocol (STP) forwarding delay, in seconds.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_FORWARD_DELAY,
|
|
g_param_spec_uint (NM_SETTING_BRIDGE_FORWARD_DELAY, "", "",
|
|
0, BR_MAX_FORWARD_DELAY, 15,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:hello-time:
|
|
*
|
|
* The Spanning Tree Protocol (STP) hello time, in seconds.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_HELLO_TIME,
|
|
g_param_spec_uint (NM_SETTING_BRIDGE_HELLO_TIME, "", "",
|
|
0, BR_MAX_HELLO_TIME, 2,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:max-age:
|
|
*
|
|
* The Spanning Tree Protocol (STP) maximum message age, in seconds.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_MAX_AGE,
|
|
g_param_spec_uint (NM_SETTING_BRIDGE_MAX_AGE, "", "",
|
|
0, BR_MAX_MAX_AGE, 20,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
|
|
/**
|
|
* NMSettingBridge:ageing-time:
|
|
*
|
|
* The Ethernet MAC address aging time, in seconds.
|
|
**/
|
|
g_object_class_install_property
|
|
(object_class, PROP_AGEING_TIME,
|
|
g_param_spec_uint (NM_SETTING_BRIDGE_AGEING_TIME, "", "",
|
|
0, BR_MAX_AGEING_TIME, 300,
|
|
G_PARAM_READWRITE |
|
|
G_PARAM_CONSTRUCT |
|
|
NM_SETTING_PARAM_INFERRABLE |
|
|
G_PARAM_STATIC_STRINGS));
|
|
}
|