mirror of
https://gitlab.freedesktop.org/NetworkManager/NetworkManager.git
synced 2026-01-28 13:00:34 +01:00
bd8d49495b
Historically, the NMSetting types were in public headers. Theoretically,
that allowed users to subtype our classes. However in practice that was
impossible because they lacked required access to internal functions to
fully create an NMSetting class outside of libnm. And it also was not
useful, because you simply cannot extend libnm by subtyping a libnm
class. And supporting such a use case would be hard and limit what we can
do in libnm.
Having GObject structs in public headers also require that we don't
change it's layout. The ABI of those structs must not change, if anybody
out there was actually subclassing our GObjects.
In libnm 1.34 (commit e46d484fae ('libnm: hide NMSetting types from
public headers')) we moved the structs from headers to internal.
This would have caused a compiler error if anybody was using those
struct definitions. However, we still didn't change the ABI/layout so
that we didn't break users who relied on it (for whatever reason).
It doesn't seem there were any affected user. We waited long enough.
Change internal ABI.
No longer use g_type_class_add_private(). Instead, embed the private
structs directly (_NM_GET_PRIVATE()) or indirectly
(_NM_GET_PRIVATE_PTR()) in the object.
The main benefit is for debugging in the debugger, where we can now
easily find the private data. Previously that was so cumbersome to be
effectively impossible.
It's also the fastest possible way, since NM_SETTING_*_GET_PRIVATE()
literally resolves to "&self->_priv" (plus static asserts and
nm_assert() for type checking).
_NM_GET_PRIVATE() also propagates constness and requires that the
argument is a compatible pointer type (at compile time).
Note that g_type_class_add_private() is also deprecated in glib 2.58 and
replaced by G_ADD_PRIVATE(). For one, we still don't rely on 2.58. Also,
G_ADD_PRIVATE() is a worse solution as it supports a usecase that we
don't care for (public structs in headers). _NM_GET_PRIVATE() is still
faster, works with older glib and most importantly: is better for
debugging as you can find the private data from an object pointer.
For NMSettingIPConfig this is rather awkward, because all direct
properties require a common "klass->private_offset". This was however
the case before this change. Nothing new here. And if you ever touch
this and do something wrong, many unit tests will fail. It's almost
impossible to get wrong, albeit it can be confusing to understand.
https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/merge_requests/1773
295 lines
10 KiB
C
295 lines
10 KiB
C
/* SPDX-License-Identifier: LGPL-2.1-or-later */
|
|
/*
|
|
* Copyright (C) 2007 - 2013 Red Hat, Inc.
|
|
* Copyright (C) 2007 - 2008 Novell, Inc.
|
|
*/
|
|
|
|
#include "libnm-core-impl/nm-default-libnm-core.h"
|
|
|
|
#include "nm-setting-bluetooth.h"
|
|
|
|
#include <net/ethernet.h>
|
|
|
|
#include "nm-connection-private.h"
|
|
#include "nm-setting-cdma.h"
|
|
#include "nm-setting-gsm.h"
|
|
#include "nm-setting-private.h"
|
|
#include "nm-utils.h"
|
|
#include "nm-utils-private.h"
|
|
|
|
/**
|
|
* SECTION:nm-setting-bluetooth
|
|
* @short_description: Describes Bluetooth connection properties
|
|
*
|
|
* The #NMSettingBluetooth object is a #NMSetting subclass that describes
|
|
* properties necessary for connection to devices that provide network
|
|
* connections via the Bluetooth Dial-Up Networking (DUN) and Network Access
|
|
* Point (NAP) profiles.
|
|
**/
|
|
|
|
/*****************************************************************************/
|
|
|
|
NM_GOBJECT_PROPERTIES_DEFINE_BASE(PROP_BDADDR, PROP_TYPE, );
|
|
|
|
typedef struct {
|
|
char *bdaddr;
|
|
char *type;
|
|
} NMSettingBluetoothPrivate;
|
|
|
|
/**
|
|
* NMSettingBluetooth:
|
|
*
|
|
* Bluetooth Settings
|
|
*/
|
|
struct _NMSettingBluetooth {
|
|
NMSetting parent;
|
|
NMSettingBluetoothPrivate _priv;
|
|
};
|
|
|
|
struct _NMSettingBluetoothClass {
|
|
NMSettingClass parent;
|
|
};
|
|
|
|
G_DEFINE_TYPE(NMSettingBluetooth, nm_setting_bluetooth, NM_TYPE_SETTING)
|
|
|
|
#define NM_SETTING_BLUETOOTH_GET_PRIVATE(o) \
|
|
_NM_GET_PRIVATE(o, NMSettingBluetooth, NM_IS_SETTING_BLUETOOTH, NMSetting)
|
|
|
|
/*****************************************************************************/
|
|
|
|
/**
|
|
* nm_setting_bluetooth_get_connection_type:
|
|
* @setting: the #NMSettingBluetooth
|
|
*
|
|
* Returns the connection method for communicating with the remote device (i.e.
|
|
* either DUN to a DUN-capable device or PANU to a NAP-capable device).
|
|
*
|
|
* Returns: the type, either %NM_SETTING_BLUETOOTH_TYPE_PANU,
|
|
* %NM_SETTING_BLUETOOTH_TYPE_NAP or %NM_SETTING_BLUETOOTH_TYPE_DUN
|
|
**/
|
|
const char *
|
|
nm_setting_bluetooth_get_connection_type(NMSettingBluetooth *setting)
|
|
{
|
|
g_return_val_if_fail(NM_IS_SETTING_BLUETOOTH(setting), NULL);
|
|
|
|
return NM_SETTING_BLUETOOTH_GET_PRIVATE(setting)->type;
|
|
}
|
|
|
|
/**
|
|
* nm_setting_bluetooth_get_bdaddr:
|
|
* @setting: the #NMSettingBluetooth
|
|
*
|
|
* Gets the Bluetooth address of the remote device which this setting
|
|
* describes a connection to.
|
|
*
|
|
* Returns: the Bluetooth address
|
|
**/
|
|
const char *
|
|
nm_setting_bluetooth_get_bdaddr(NMSettingBluetooth *setting)
|
|
{
|
|
g_return_val_if_fail(NM_IS_SETTING_BLUETOOTH(setting), NULL);
|
|
|
|
return NM_SETTING_BLUETOOTH_GET_PRIVATE(setting)->bdaddr;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
static gboolean
|
|
verify(NMSetting *setting, NMConnection *connection, GError **error)
|
|
{
|
|
NMSettingBluetoothPrivate *priv = NM_SETTING_BLUETOOTH_GET_PRIVATE(setting);
|
|
const char *type;
|
|
gboolean missing_nap_bridge = FALSE;
|
|
|
|
if (priv->bdaddr && !nm_utils_hwaddr_valid(priv->bdaddr, ETH_ALEN)) {
|
|
g_set_error_literal(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_INVALID_PROPERTY,
|
|
_("property is invalid"));
|
|
g_prefix_error(error,
|
|
"%s.%s: ",
|
|
NM_SETTING_BLUETOOTH_SETTING_NAME,
|
|
NM_SETTING_BLUETOOTH_BDADDR);
|
|
return FALSE;
|
|
}
|
|
|
|
type = priv->type;
|
|
if (!type) {
|
|
if (connection) {
|
|
/* We may infer the type from the (non-)existence of gsm/cdma/bridge settings. */
|
|
type = _nm_connection_detect_bluetooth_type(connection);
|
|
}
|
|
if (!type) {
|
|
g_set_error_literal(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_MISSING_PROPERTY,
|
|
_("property is missing"));
|
|
g_prefix_error(error,
|
|
"%s.%s: ",
|
|
NM_SETTING_BLUETOOTH_SETTING_NAME,
|
|
NM_SETTING_BLUETOOTH_TYPE);
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
if (!NM_IN_STRSET(type,
|
|
NM_SETTING_BLUETOOTH_TYPE_DUN,
|
|
NM_SETTING_BLUETOOTH_TYPE_NAP,
|
|
NM_SETTING_BLUETOOTH_TYPE_PANU)) {
|
|
nm_assert(priv->type == type);
|
|
g_set_error(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_INVALID_PROPERTY,
|
|
_("'%s' is not a valid value for the property"),
|
|
type);
|
|
g_prefix_error(error,
|
|
"%s.%s: ",
|
|
NM_SETTING_BLUETOOTH_SETTING_NAME,
|
|
NM_SETTING_BLUETOOTH_TYPE);
|
|
return FALSE;
|
|
}
|
|
|
|
/* Make sure the corresponding 'type' setting is present */
|
|
if (connection && nm_streq(type, NM_SETTING_BLUETOOTH_TYPE_DUN)) {
|
|
gboolean gsm = FALSE, cdma = FALSE;
|
|
|
|
gsm = !!nm_connection_get_setting_gsm(connection);
|
|
cdma = !!nm_connection_get_setting_cdma(connection);
|
|
|
|
if (!gsm && !cdma) {
|
|
/* We can't return MISSING_SETTING here, because we don't know
|
|
* whether to prefix the message with NM_SETTING_GSM_SETTING_NAME or
|
|
* NM_SETTING_CDMA_SETTING_NAME.
|
|
*/
|
|
g_set_error(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_INVALID_SETTING,
|
|
_("'%s' connection requires '%s' or '%s' setting"),
|
|
NM_SETTING_BLUETOOTH_TYPE_DUN,
|
|
NM_SETTING_GSM_SETTING_NAME,
|
|
NM_SETTING_CDMA_SETTING_NAME);
|
|
g_prefix_error(error, "%s: ", NM_SETTING_BLUETOOTH_SETTING_NAME);
|
|
return FALSE;
|
|
}
|
|
}
|
|
/* PANU doesn't need a 'type' setting since no further configuration
|
|
* is required at the interface level.
|
|
*/
|
|
|
|
/* NAP mode needs a bridge setting, and a bridge needs a name. */
|
|
if (nm_streq(type, NM_SETTING_BLUETOOTH_TYPE_NAP)) {
|
|
if (!_nm_connection_verify_required_interface_name(connection, error))
|
|
return FALSE;
|
|
if (connection && !nm_connection_get_setting_bridge(connection))
|
|
missing_nap_bridge = TRUE;
|
|
} else {
|
|
if (!priv->bdaddr) {
|
|
g_set_error_literal(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_MISSING_PROPERTY,
|
|
_("property is missing"));
|
|
g_prefix_error(error,
|
|
"%s.%s: ",
|
|
NM_SETTING_BLUETOOTH_SETTING_NAME,
|
|
NM_SETTING_BLUETOOTH_BDADDR);
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
/* errors form here are normalizable. */
|
|
|
|
if (!priv->type) {
|
|
/* as determined above, we can detect the bluetooth type. */
|
|
nm_assert(!missing_nap_bridge);
|
|
g_set_error_literal(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_MISSING_PROPERTY,
|
|
_("property is missing"));
|
|
g_prefix_error(error,
|
|
"%s.%s: ",
|
|
NM_SETTING_BLUETOOTH_SETTING_NAME,
|
|
NM_SETTING_BLUETOOTH_TYPE);
|
|
return NM_SETTING_VERIFY_NORMALIZABLE;
|
|
}
|
|
|
|
if (missing_nap_bridge) {
|
|
g_set_error(error,
|
|
NM_CONNECTION_ERROR,
|
|
NM_CONNECTION_ERROR_INVALID_SETTING,
|
|
_("'%s' connection requires '%s' setting"),
|
|
NM_SETTING_BLUETOOTH_TYPE_NAP,
|
|
NM_SETTING_BRIDGE_SETTING_NAME);
|
|
g_prefix_error(error, "%s: ", NM_SETTING_BLUETOOTH_SETTING_NAME);
|
|
return NM_SETTING_VERIFY_NORMALIZABLE_ERROR;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/*****************************************************************************/
|
|
|
|
static void
|
|
nm_setting_bluetooth_init(NMSettingBluetooth *setting)
|
|
{}
|
|
|
|
/**
|
|
* nm_setting_bluetooth_new:
|
|
*
|
|
* Creates a new #NMSettingBluetooth object with default values.
|
|
*
|
|
* Returns: (transfer full): the new empty #NMSettingBluetooth object
|
|
**/
|
|
NMSetting *
|
|
nm_setting_bluetooth_new(void)
|
|
{
|
|
return g_object_new(NM_TYPE_SETTING_BLUETOOTH, NULL);
|
|
}
|
|
|
|
static void
|
|
nm_setting_bluetooth_class_init(NMSettingBluetoothClass *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();
|
|
|
|
object_class->get_property = _nm_setting_property_get_property_direct;
|
|
object_class->set_property = _nm_setting_property_set_property_direct;
|
|
|
|
setting_class->verify = verify;
|
|
|
|
/**
|
|
* NMSettingBluetooth:bdaddr:
|
|
*
|
|
* The Bluetooth address of the device.
|
|
**/
|
|
_nm_setting_property_define_direct_mac_address(properties_override,
|
|
obj_properties,
|
|
NM_SETTING_BLUETOOTH_BDADDR,
|
|
PROP_BDADDR,
|
|
NM_SETTING_PARAM_INFERRABLE,
|
|
NMSettingBluetoothPrivate,
|
|
bdaddr,
|
|
.direct_set_string_mac_address_len = ETH_ALEN);
|
|
|
|
/**
|
|
* NMSettingBluetooth:type:
|
|
*
|
|
* Either "dun" for Dial-Up Networking connections or "panu" for Personal
|
|
* Area Networking connections to devices supporting the NAP profile.
|
|
**/
|
|
_nm_setting_property_define_direct_string(properties_override,
|
|
obj_properties,
|
|
NM_SETTING_BLUETOOTH_TYPE,
|
|
PROP_TYPE,
|
|
NM_SETTING_PARAM_INFERRABLE,
|
|
NMSettingBluetoothPrivate,
|
|
type);
|
|
|
|
g_object_class_install_properties(object_class, _PROPERTY_ENUMS_LAST, obj_properties);
|
|
|
|
_nm_setting_class_commit(setting_class,
|
|
NM_META_SETTING_TYPE_BLUETOOTH,
|
|
NULL,
|
|
properties_override,
|
|
G_STRUCT_OFFSET(NMSettingBluetooth, _priv));
|
|
}
|