NetworkManager/libnm-core/nm-setting-ovs-interface.c
Thomas Haller 23adc37377 libnm/trivial: cleanup variable names in settings' class-init functions
- Don't use @parent_class name. This local variable (and @object_class) is
  the class instance up-cast to the pointer types of the parents. The point
  here is not that it is the direct parent. The point is, that it's the
  NMSettingClass type.
  Also, it can only be used inconsistently, in face of NMSettingIP4Config,
  who's parent type is NMSettingIPConfig. Clearly, inside
  nm-setting-ip4-config.c we wouldn't want to use the "parent_class"
  name. Consistently rename @parent_class to @setting_class.

- Also rename the pointer to the own class to @klass. "setting_class" is also the
  wrong name for that, because the right name would be something like
  "setting_6lowpan_class".
  However, "klass" is preferred over the latter, because we commonly create new
  GObject implementations by copying an existing one. Generic names like "klass"
  and "self" inside a type implementation make that simpler.

- drop useless comments like

     /* virtual functions */
     /* Properties */

  It's better to logically and visually structure the code, and avoid trival
  remarks about that. They only end up being used inconsistently. If you
  even need a stronger visual separator, then an 80 char /****/ line
  should be preferred.
2018-08-10 10:38:19 +02:00

392 lines
12 KiB
C

/*
* 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 2017 Red Hat, Inc.
*/
#include "nm-default.h"
#include "nm-setting-ovs-interface.h"
#include "nm-connection-private.h"
#include "nm-setting-connection.h"
#include "nm-setting-private.h"
/**
* SECTION:nm-setting-ovs-interface
* @short_description: Describes connection properties for Open vSwitch interfaces.
*
* The #NMSettingOvsInterface object is a #NMSetting subclass that describes properties
* necessary for Open vSwitch interfaces.
**/
enum {
PROP_0,
PROP_TYPE,
LAST_PROP
};
/**
* NMSettingOvsInterface:
*
* Open vSwitch Interface Settings
*/
struct _NMSettingOvsInterface {
NMSetting parent;
char *type;
};
struct _NMSettingOvsInterfaceClass {
NMSettingClass parent;
};
G_DEFINE_TYPE_WITH_CODE (NMSettingOvsInterface, nm_setting_ovs_interface, NM_TYPE_SETTING,
_nm_register_setting (OVS_INTERFACE, NM_SETTING_PRIORITY_HW_BASE))
/*****************************************************************************/
/**
* nm_setting_ovs_interface_get_interface_type:
* @self: the #NMSettingOvsInterface
*
* Returns: the #NMSettingOvsInterface:type property of the setting
*
* Since: 1.10
**/
const char *
nm_setting_ovs_interface_get_interface_type (NMSettingOvsInterface *self)
{
g_return_val_if_fail (NM_IS_SETTING_OVS_INTERFACE (self), NULL);
return self->type;
}
/*****************************************************************************/
int
_nm_setting_ovs_interface_verify_interface_type (NMSettingOvsInterface *self,
NMConnection *connection,
gboolean normalize,
gboolean *out_modified,
GError **error)
{
gboolean has_patch;
const char *type;
const char *connection_type;
gboolean is_ovs_connection_type;
gboolean missing_patch_setting = FALSE;
g_return_val_if_fail (NM_IS_SETTING_OVS_INTERFACE (self), FALSE);
if (normalize) {
g_return_val_if_fail (NM_IS_CONNECTION (connection), FALSE);
nm_assert (self == nm_connection_get_setting_ovs_interface (connection));
} else
g_return_val_if_fail (!connection || NM_IS_CONNECTION (connection), FALSE);
NM_SET_OUT (out_modified, FALSE);
type = self ? self->type : NULL;
if ( type
&& !NM_IN_STRSET (type,
"internal",
"system",
"patch")) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("'%s' is not a valid interface type"),
type);
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
return FALSE;
}
if (!connection)
return TRUE;
connection_type = nm_connection_get_connection_type (connection);
if (!connection_type) {
/* if we have an ovs-interface, then the connection type must be either
* "ovs-interface" (for non "system" type) or anything else (for "system" type).
*
* The connection type usually can be normalized based on the presence of a
* base setting. However, in this case, if the connection type is missing,
* that is too complicate to guess what the user wanted.
*
* Require the use to be explicit and fail. */
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection with a '%s' setting needs connection.type explicitly set"),
NM_SETTING_OVS_INTERFACE_SETTING_NAME);
g_prefix_error (error, "%s.%s: ", NM_SETTING_CONNECTION_SETTING_NAME, NM_SETTING_CONNECTION_TYPE);
return FALSE;
}
if (nm_streq (connection_type, NM_SETTING_OVS_INTERFACE_SETTING_NAME)) {
if ( type
&& nm_streq (type, "system")) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection of type '%s' cannot have ovs-interface.type \"system\""),
NM_SETTING_OVS_INTERFACE_SETTING_NAME);
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
return FALSE;
}
is_ovs_connection_type = TRUE;
} else {
if ( type
&& !nm_streq (type, "system")) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection of type '%s' cannot have an ovs-interface.type \"%s\""),
connection_type,
type);
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
return FALSE;
}
is_ovs_connection_type = FALSE;
}
has_patch = !!nm_connection_get_setting_by_name (connection, NM_SETTING_OVS_PATCH_SETTING_NAME);
if (has_patch) {
if (!is_ovs_connection_type) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection with '%s' setting must be of connection.type \"ovs-interface\" but is \"%s\""),
NM_SETTING_OVS_PATCH_SETTING_NAME,
connection_type);
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
return FALSE;
}
if (type) {
if (!nm_streq (type, "patch")) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection with '%s' setting needs to be of 'patch' interface type, not '%s'"),
NM_SETTING_OVS_PATCH_SETTING_NAME,
type);
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
return FALSE;
}
return TRUE;
}
type = "patch";
goto normalize;
} else {
if (nm_streq0 (type, "patch")) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_MISSING_SETTING,
_("A connection with ovs-interface.type '%s' setting a 'ovs-patch' setting"),
type);
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
return FALSE;
}
}
if (type)
return TRUE;
if (is_ovs_connection_type)
type = "internal";
else
type = "system";
normalize:
if (!normalize) {
if (!self) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_MISSING_SETTING,
_("Missing ovs interface setting"));
g_prefix_error (error, "%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME);
} else {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_MISSING_PROPERTY,
_("Missing ovs interface type"));
g_prefix_error (error, "%s.%s: ", NM_SETTING_OVS_INTERFACE_SETTING_NAME, NM_SETTING_OVS_INTERFACE_TYPE);
}
if (missing_patch_setting) {
}
return NM_SETTING_VERIFY_NORMALIZABLE_ERROR;
}
if (!self) {
self = NM_SETTING_OVS_INTERFACE (nm_setting_ovs_interface_new ());
nm_connection_add_setting (connection, NM_SETTING (self));
}
g_object_set (self,
NM_SETTING_OVS_INTERFACE_TYPE, type,
NULL);
NM_SET_OUT (out_modified, TRUE);
return TRUE;
}
static int
verify (NMSetting *setting, NMConnection *connection, GError **error)
{
NMSettingOvsInterface *self = NM_SETTING_OVS_INTERFACE (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;
}
if (!nm_setting_connection_get_master (s_con)) {
g_set_error (error,
NM_CONNECTION_ERROR,
NM_CONNECTION_ERROR_INVALID_PROPERTY,
_("A connection with a '%s' setting must have a master."),
NM_SETTING_OVS_INTERFACE_SETTING_NAME);
g_prefix_error (error, "%s.%s: ", NM_SETTING_CONNECTION_SETTING_NAME, NM_SETTING_CONNECTION_MASTER);
return FALSE;
}
slave_type = nm_setting_connection_get_slave_type (s_con);
if ( slave_type
&& !nm_streq (slave_type, NM_SETTING_OVS_PORT_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_OVS_INTERFACE_SETTING_NAME,
NM_SETTING_OVS_PORT_SETTING_NAME,
slave_type);
g_prefix_error (error, "%s.%s: ", NM_SETTING_CONNECTION_SETTING_NAME, NM_SETTING_CONNECTION_SLAVE_TYPE);
return FALSE;
}
}
return _nm_setting_ovs_interface_verify_interface_type (self,
connection,
FALSE,
NULL,
error);
}
/*****************************************************************************/
static void
get_property (GObject *object, guint prop_id,
GValue *value, GParamSpec *pspec)
{
NMSettingOvsInterface *self = NM_SETTING_OVS_INTERFACE (object);
switch (prop_id) {
case PROP_TYPE:
g_value_set_string (value, self->type);
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)
{
NMSettingOvsInterface *self = NM_SETTING_OVS_INTERFACE (object);
switch (prop_id) {
case PROP_TYPE:
g_free (self->type);
self->type = g_value_dup_string (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/*****************************************************************************/
static void
nm_setting_ovs_interface_init (NMSettingOvsInterface *self)
{
}
/**
* nm_setting_ovs_interface_new:
*
* Creates a new #NMSettingOvsInterface object with default values.
*
* Returns: (transfer full): the new empty #NMSettingOvsInterface object
*
* Since: 1.10
**/
NMSetting *
nm_setting_ovs_interface_new (void)
{
return (NMSetting *) g_object_new (NM_TYPE_SETTING_OVS_INTERFACE, NULL);
}
static void
finalize (GObject *object)
{
NMSettingOvsInterface *self = NM_SETTING_OVS_INTERFACE (object);
g_free (self->type);
G_OBJECT_CLASS (nm_setting_ovs_interface_parent_class)->finalize (object);
}
static void
nm_setting_ovs_interface_class_init (NMSettingOvsInterfaceClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
NMSettingClass *setting_class = NM_SETTING_CLASS (klass);
object_class->set_property = set_property;
object_class->get_property = get_property;
object_class->finalize = finalize;
setting_class->verify = verify;
/**
* NMSettingOvsInterface:type:
*
* The interface type. Either "internal", or empty.
*
* Since: 1.10
**/
g_object_class_install_property
(object_class, PROP_TYPE,
g_param_spec_string (NM_SETTING_OVS_INTERFACE_TYPE, "", "",
NULL,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT |
NM_SETTING_PARAM_INFERRABLE |
G_PARAM_STATIC_STRINGS));
}