/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* Copyright (C) 2012 - 2013 Red Hat, Inc.
*/
#include "libnm-core/nm-default-libnm-core.h"
#include "nm-setting-bridge-port.h"
#include <ctype.h>
#include <stdlib.h>
#include "nm-utils.h"
#include "nm-utils-private.h"
#include "nm-connection-private.h"
#include "nm-setting-connection.h"
#include "nm-setting-bridge.h"
/**
* SECTION:nm-setting-bridge-port
* @short_description: Describes connection properties for bridge ports
*
* The #NMSettingBridgePort object is a #NMSetting subclass that describes
* optional properties that apply to bridge ports.
**/
/*****************************************************************************/
NM_GOBJECT_PROPERTIES_DEFINE(NMSettingBridgePort,
PROP_PRIORITY,
PROP_PATH_COST,
PROP_HAIRPIN_MODE,
PROP_VLANS, );
typedef struct {
GPtrArray *vlans;
guint16 priority;
guint16 path_cost;
bool hairpin_mode : 1;
} NMSettingBridgePortPrivate;
G_DEFINE_TYPE(NMSettingBridgePort, nm_setting_bridge_port, NM_TYPE_SETTING)
#define NM_SETTING_BRIDGE_PORT_GET_PRIVATE(o) \
(G_TYPE_INSTANCE_GET_PRIVATE((o), NM_TYPE_SETTING_BRIDGE_PORT, NMSettingBridgePortPrivate))
static int
vlan_ptr_cmp(gconstpointer a, gconstpointer b)
{
const NMBridgeVlan *vlan_a = *(const NMBridgeVlan **) a;
const NMBridgeVlan *vlan_b = *(const NMBridgeVlan **) b;
return nm_bridge_vlan_cmp(vlan_a, vlan_b);
}
gboolean
_nm_setting_bridge_port_sort_vlans(NMSettingBridgePort *setting)
{
NMSettingBridgePortPrivate *priv;
gboolean need_sort = FALSE;
guint i;
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
for (i = 1; i < priv->vlans->len; i++) {
NMBridgeVlan *vlan_prev = priv->vlans->pdata[i - 1];
NMBridgeVlan *vlan = priv->vlans->pdata[i];
if (nm_bridge_vlan_cmp(vlan_prev, vlan) > 0) {
need_sort = TRUE;
break;
}
}
if (need_sort) {
g_ptr_array_sort(priv->vlans, vlan_ptr_cmp);
_notify(setting, PROP_VLANS);
}
return need_sort;
}
/*****************************************************************************/
/**
* nm_setting_bridge_port_get_priority:
* @setting: the #NMSettingBridgePort
*
* Returns: the #NMSettingBridgePort:priority property of the setting
**/
guint16
nm_setting_bridge_port_get_priority(NMSettingBridgePort *setting)
{
g_return_val_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting), 0);
return NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting)->priority;
}
/**
* nm_setting_bridge_port_get_path_cost:
* @setting: the #NMSettingBridgePort
*
* Returns: the #NMSettingBridgePort:path-cost property of the setting
**/
guint16
nm_setting_bridge_port_get_path_cost(NMSettingBridgePort *setting)
{
g_return_val_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting), 0);
return NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting)->path_cost;
}
/**
* nm_setting_bridge_port_get_hairpin_mode:
* @setting: the #NMSettingBridgePort
*
* Returns: the #NMSettingBridgePort:hairpin-mode property of the setting
**/
gboolean
nm_setting_bridge_port_get_hairpin_mode(NMSettingBridgePort *setting)
{
g_return_val_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting), FALSE);
return NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting)->hairpin_mode;
}
/**
* nm_setting_bridge_port_add_vlan:
* @setting: the #NMSettingBridgePort
* @vlan: the vlan to add
*
* Appends a new vlan and associated information to the setting. The
* given vlan gets sealed and a reference to it is added.
*
* Since: 1.18
**/
void
nm_setting_bridge_port_add_vlan(NMSettingBridgePort *setting, NMBridgeVlan *vlan)
{
NMSettingBridgePortPrivate *priv;
g_return_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting));
g_return_if_fail(vlan);
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
nm_bridge_vlan_seal(vlan);
nm_bridge_vlan_ref(vlan);
g_ptr_array_add(priv->vlans, vlan);
_notify(setting, PROP_VLANS);
}
/**
* nm_setting_bridge_port_get_num_vlans:
* @setting: the #NMSettingBridgePort
*
* Returns: the number of VLANs
*
* Since: 1.18
**/
guint
nm_setting_bridge_port_get_num_vlans(NMSettingBridgePort *setting)
{
NMSettingBridgePortPrivate *priv;
g_return_val_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting), 0);
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
return priv->vlans->len;
}
/**
* nm_setting_bridge_port_get_vlan:
* @setting: the #NMSettingBridgePort
* @idx: index number of the VLAN to return
*
* Returns: (transfer none): the VLAN at index @idx
*
* Since: 1.18
**/
NMBridgeVlan *
nm_setting_bridge_port_get_vlan(NMSettingBridgePort *setting, guint idx)
{
NMSettingBridgePortPrivate *priv;
g_return_val_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting), NULL);
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
g_return_val_if_fail(idx < priv->vlans->len, NULL);
return priv->vlans->pdata[idx];
}
/**
* nm_setting_bridge_port_remove_vlan:
* @setting: the #NMSettingBridgePort
* @idx: index number of the VLAN.
*
* Removes the vlan at index @idx.
*
* Since: 1.18
**/
void
nm_setting_bridge_port_remove_vlan(NMSettingBridgePort *setting, guint idx)
{
NMSettingBridgePortPrivate *priv;
g_return_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting));
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
g_return_if_fail(idx < priv->vlans->len);
g_ptr_array_remove_index(priv->vlans, idx);
_notify(setting, PROP_VLANS);
}
/**
* nm_setting_bridge_port_remove_vlan_by_vid:
* @setting: the #NMSettingBridgePort
* @vid_start: the vlan start index
* @vid_end: the vlan end index
*
* Remove the VLAN with range @vid_start to @vid_end.
* If @vid_end is zero, it is assumed to be equal to @vid_start
* and so the single-id VLAN with id @vid_start is removed.
*
* Returns: %TRUE if the vlan was found and removed; %FALSE otherwise
*
* Since: 1.18
**/
gboolean
nm_setting_bridge_port_remove_vlan_by_vid(NMSettingBridgePort *setting,
guint16 vid_start,
guint16 vid_end)
{
NMSettingBridgePortPrivate *priv;
guint i;
if (vid_end == 0)
vid_end = vid_start;
g_return_val_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting), FALSE);
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
for (i = 0; i < priv->vlans->len; i++) {
NMBridgeVlan *vlan = priv->vlans->pdata[i];
guint16 v_start = 0;
guint16 v_end = 0;
nm_bridge_vlan_get_vid_range(vlan, &v_start, &v_end);
if (v_start == vid_start && v_end == vid_end) {
g_ptr_array_remove_index(priv->vlans, i);
_notify(setting, PROP_VLANS);
return TRUE;
}
}
return FALSE;
}
/**
* nm_setting_bridge_port_clear_vlans:
* @setting: the #NMSettingBridgePort
*
* Removes all configured VLANs.
*
* Since: 1.18
**/
void
nm_setting_bridge_port_clear_vlans(NMSettingBridgePort *setting)
{
NMSettingBridgePortPrivate *priv;
g_return_if_fail(NM_IS_SETTING_BRIDGE_PORT(setting));
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
if (priv->vlans->len != 0) {
g_ptr_array_set_size(priv->vlans, 0);
_notify(setting, PROP_VLANS);
}
}
/*****************************************************************************/
static gboolean
verify(NMSetting *setting, NMConnection *connection, GError **error)
{
NMSettingBridgePortPrivate *priv;
priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
if (connection) {
NMSettingConnection *s_con;
const char * slave_type;
s_con = nm_connection_get_setting_connection(connection);
if (!s_con) {
g_set_error(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_MISSING_SETTING,
_("missing setting"));
g_prefix_error(error, "%s: ", NM_SETTING_CONNECTION_SETTING_NAME);
return FALSE;
}
slave_type = nm_setting_connection_get_slave_type(s_con);
if (slave_type && strcmp(slave_type, NM_SETTING_BRIDGE_SETTING_NAME)) {
g_set_error(error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection with a '%s' setting must have the slave-type set to '%s'. "
"Instead it is '%s'"),
NM_SETTING_BRIDGE_PORT_SETTING_NAME,
NM_SETTING_BRIDGE_SETTING_NAME,
slave_type);
g_prefix_error(error,
"%s.%s: ",
NM_SETTING_CONNECTION_SETTING_NAME,
NM_SETTING_CONNECTION_SLAVE_TYPE);
return FALSE;
}
}
if (!_nm_utils_bridge_vlan_verify_list(priv->vlans,
FALSE,
error,
NM_SETTING_BRIDGE_PORT_SETTING_NAME,
NM_SETTING_BRIDGE_PORT_VLANS))
return FALSE;
/* Failures from here on are NORMALIZABLE... */
if (!_nm_utils_bridge_vlan_verify_list(priv->vlans,
TRUE,
error,
NM_SETTING_BRIDGE_PORT_SETTING_NAME,
NM_SETTING_BRIDGE_PORT_VLANS))
return NM_SETTING_VERIFY_NORMALIZABLE;
return TRUE;
}
static NMTernary
compare_property(const NMSettInfoSetting *sett_info,
guint property_idx,
NMConnection * con_a,
NMSetting * set_a,
NMConnection * con_b,
NMSetting * set_b,
NMSettingCompareFlags flags)
{
NMSettingBridgePortPrivate *priv_a;
NMSettingBridgePortPrivate *priv_b;
guint i;
if (nm_streq(sett_info->property_infos[property_idx].name, NM_SETTING_BRIDGE_PORT_VLANS)) {
if (set_b) {
priv_a = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(set_a);
priv_b = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(set_b);
if (priv_a->vlans->len != priv_b->vlans->len)
return FALSE;
for (i = 0; i < priv_a->vlans->len; i++) {
if (nm_bridge_vlan_cmp(priv_a->vlans->pdata[i], priv_b->vlans->pdata[i]))
return FALSE;
}
}
return TRUE;
}
return NM_SETTING_CLASS(nm_setting_bridge_port_parent_class)
->compare_property(sett_info, property_idx, con_a, set_a, con_b, set_b, flags);
}
/*****************************************************************************/
static void
get_property(GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
{
NMSettingBridgePortPrivate *priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(object);
switch (prop_id) {
case PROP_PRIORITY:
g_value_set_uint(value, priv->priority);
break;
case PROP_PATH_COST:
g_value_set_uint(value, priv->path_cost);
break;
case PROP_HAIRPIN_MODE:
g_value_set_boolean(value, priv->hairpin_mode);
break;
case PROP_VLANS:
g_value_take_boxed(value,
_nm_utils_copy_array(priv->vlans,
(NMUtilsCopyFunc) nm_bridge_vlan_ref,
(GDestroyNotify) nm_bridge_vlan_unref));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
static void
set_property(GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
{
NMSettingBridgePortPrivate *priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(object);
switch (prop_id) {
case PROP_PRIORITY:
priv->priority = g_value_get_uint(value);
break;
case PROP_PATH_COST:
priv->path_cost = g_value_get_uint(value);
break;
case PROP_HAIRPIN_MODE:
priv->hairpin_mode = g_value_get_boolean(value);
break;
case PROP_VLANS:
g_ptr_array_unref(priv->vlans);
priv->vlans = _nm_utils_copy_array(g_value_get_boxed(value),
(NMUtilsCopyFunc) _nm_bridge_vlan_dup_and_seal,
(GDestroyNotify) nm_bridge_vlan_unref);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
break;
}
}
/*****************************************************************************/
static void
nm_setting_bridge_port_init(NMSettingBridgePort *setting)
{
NMSettingBridgePortPrivate *priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(setting);
priv->vlans = g_ptr_array_new_with_free_func((GDestroyNotify) nm_bridge_vlan_unref);
priv->priority = NM_BRIDGE_PORT_PRIORITY_DEF;
priv->path_cost = NM_BRIDGE_PORT_PATH_COST_DEF;
}
/**
* nm_setting_bridge_port_new:
*
* Creates a new #NMSettingBridgePort object with default values.
*
* Returns: (transfer full): the new empty #NMSettingBridgePort object
**/
NMSetting *
nm_setting_bridge_port_new(void)
{
return g_object_new(NM_TYPE_SETTING_BRIDGE_PORT, NULL);
}
static void
finalize(GObject *object)
{
NMSettingBridgePortPrivate *priv = NM_SETTING_BRIDGE_PORT_GET_PRIVATE(object);
g_ptr_array_unref(priv->vlans);
G_OBJECT_CLASS(nm_setting_bridge_port_parent_class)->finalize(object);
}
static void
nm_setting_bridge_port_class_init(NMSettingBridgePortClass *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(NMSettingBridgePortPrivate));
object_class->finalize = finalize;
object_class->get_property = get_property;
object_class->set_property = set_property;
setting_class->compare_property = compare_property;
setting_class->verify = verify;
/**
* NMSettingBridgePort:priority:
*
* The Spanning Tree Protocol (STP) priority of this bridge port.
**/
/* ---ifcfg-rh---
* property: priority
* variable: BRIDGING_OPTS: priority=
* values: 0 - 63
* default: 32
* description: STP priority.
* ---end---
*/
obj_properties[PROP_PRIORITY] =
g_param_spec_uint(NM_SETTING_BRIDGE_PORT_PRIORITY,
"",
"",
NM_BRIDGE_PORT_PRIORITY_MIN,
NM_BRIDGE_PORT_PRIORITY_MAX,
NM_BRIDGE_PORT_PRIORITY_DEF,
G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | G_PARAM_STATIC_STRINGS);
/**
* NMSettingBridgePort:path-cost:
*
* The Spanning Tree Protocol (STP) port cost for destinations via this
* port.
**/
/* ---ifcfg-rh---
* property: path-cost
* variable: BRIDGING_OPTS: path_cost=
* values: 1 - 65535
* default: 100
* description: STP cost.
* ---end---
*/
obj_properties[PROP_PATH_COST] = g_param_spec_uint(NM_SETTING_BRIDGE_PORT_PATH_COST,
"",
"",
NM_BRIDGE_PORT_PATH_COST_MIN,
NM_BRIDGE_PORT_PATH_COST_MAX,
NM_BRIDGE_PORT_PATH_COST_DEF,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
/**
* NMSettingBridgePort:hairpin-mode:
*
* Enables or disables "hairpin mode" for the port, which allows frames to
* be sent back out through the port the frame was received on.
**/
/* ---ifcfg-rh---
* property: hairpin-mode
* variable: BRIDGING_OPTS: hairpin_mode=
* default: yes
* description: Hairpin mode of the bridge port.
* ---end---
*/
obj_properties[PROP_HAIRPIN_MODE] = g_param_spec_boolean(
NM_SETTING_BRIDGE_PORT_HAIRPIN_MODE,
"",
"",
FALSE,
G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE | G_PARAM_STATIC_STRINGS);
/**
* NMSettingBridgePort:vlans: (type GPtrArray(NMBridgeVlan))
*
* Array of bridge VLAN objects. In addition to the VLANs
* specified here, the port will also have the default-pvid
* VLAN configured on the bridge by the bridge.vlan-default-pvid
* property.
*
* In nmcli the VLAN list can be specified with the following
* syntax:
*
* $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...
*
* where $vid is either a single id between 1 and 4094 or a
* range, represented as a couple of ids separated by a dash.
*
* Since: 1.18
**/
/* ---ifcfg-rh---
* property: vlans
* variable: BRIDGE_PORT_VLANS
* description: List of VLANs on the bridge port
* example: BRIDGE_PORT_VLANS="1 pvid untagged,20,300-400 untagged"
* ---end---
*/
obj_properties[PROP_VLANS] = g_param_spec_boxed(NM_SETTING_BRIDGE_PORT_VLANS,
"",
"",
G_TYPE_PTR_ARRAY,
G_PARAM_READWRITE | NM_SETTING_PARAM_INFERRABLE
| G_PARAM_STATIC_STRINGS);
_nm_properties_override_gobj(properties_override,
obj_properties[PROP_VLANS],
&nm_sett_info_propert_type_bridge_vlans);
g_object_class_install_properties(object_class, _PROPERTY_ENUMS_LAST, obj_properties);
_nm_setting_class_commit_full(setting_class,
NM_META_SETTING_TYPE_BRIDGE_PORT,
NULL,
properties_override);
}