port-net: new 'MMPortNet' object with netlink capabilities

Right now just with the support to setup link properties like up/down
state or the link mtu.

This features are required when using QMAP based multiplexing with the
qmi_wwan kernel driver.
This commit is contained in:
Aleksander Morgado
2021-02-17 14:20:08 +01:00
parent b45948a20d
commit 032a86915a
7 changed files with 710 additions and 6 deletions

View File

@@ -199,6 +199,8 @@ mm-port-enums-types.c: Makefile.am $(top_srcdir)/build-aux/mm-enums-template.c m
libport_la_SOURCES = \
mm-port.c \
mm-port.h \
mm-port-net.c \
mm-port-net.h \
mm-port-serial.c \
mm-port-serial.h \
mm-port-serial-at.c \
@@ -209,6 +211,8 @@ libport_la_SOURCES = \
mm-port-serial-gps.h \
mm-serial-parsers.c \
mm-serial-parsers.h \
mm-netlink.h \
mm-netlink.c \
$(NULL)
nodist_libport_la_SOURCES = $(PORT_ENUMS_GENERATED)

View File

@@ -164,11 +164,7 @@ static MMPort *
base_modem_create_net_port (MMBaseModem *self,
const gchar *name)
{
return MM_PORT (g_object_new (MM_TYPE_PORT,
MM_PORT_DEVICE, name,
MM_PORT_SUBSYS, MM_PORT_SUBSYS_NET,
MM_PORT_TYPE, MM_PORT_TYPE_NET,
NULL));
return MM_PORT (mm_port_net_new (name));
}
static MMPort *

View File

@@ -29,8 +29,9 @@
#include <mm-gdbus-modem.h>
#include "mm-auth-provider.h"
#include "mm-port.h"
#include "mm-kernel-device.h"
#include "mm-port.h"
#include "mm-port-net.h"
#include "mm-port-serial-at.h"
#include "mm-port-serial-qcdm.h"
#include "mm-port-serial-gps.h"

464
src/mm-netlink.c Normal file
View File

@@ -0,0 +1,464 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details:
*
* Basic netlink support based on the QmiNetPortManagerRmnet from libqmi:
* Copyright (C) 2020 Eric Caruso <ejcaruso@chromium.org>
* Copyright (C) 2020 Andrew Lassalle <andrewlassalle@chromium.org>
*
* Copyright (C) 2021 Aleksander Morgado <aleksander@aleksander.es>
*/
#include <linux/netlink.h>
#include <linux/rtnetlink.h>
#include <net/if.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <config.h>
#include <ModemManager.h>
#include <mm-errors-types.h>
#include "mm-log-object.h"
#include "mm-utils.h"
#include "mm-netlink.h"
struct _MMNetlink {
GObject parent;
/* Netlink socket */
GSocket *socket;
GSource *source;
/* Netlink state */
guint current_sequence_id;
GHashTable *transactions;
};
struct _MMNetlinkClass {
GObjectClass parent_class;
};
static void log_object_iface_init (MMLogObjectInterface *iface);
G_DEFINE_TYPE_EXTENDED (MMNetlink, mm_netlink, G_TYPE_OBJECT, 0,
G_IMPLEMENT_INTERFACE (MM_TYPE_LOG_OBJECT, log_object_iface_init))
/*****************************************************************************/
/*
* Netlink message construction functions
*/
typedef GByteArray NetlinkMessage;
typedef struct {
struct nlmsghdr msghdr;
struct ifinfomsg ifreq;
} NetlinkHeader;
static NetlinkHeader *
netlink_message_header (NetlinkMessage *msg)
{
return (NetlinkHeader *) (msg->data);
}
static guint
get_pos_of_next_attr (NetlinkMessage *msg)
{
return NLMSG_ALIGN (msg->len);
}
static void
append_netlink_attribute (NetlinkMessage *msg,
gushort type,
gconstpointer value,
gushort len)
{
guint attr_len;
guint old_len;
guint next_attr_rel_pos;
char *next_attr_abs_pos;
struct rtattr new_attr;
/* Expand the buffer to hold the new attribute */
attr_len = RTA_ALIGN (RTA_LENGTH (len));
old_len = msg->len;
next_attr_rel_pos = get_pos_of_next_attr (msg);
g_byte_array_set_size (msg, next_attr_rel_pos + attr_len);
/* fill new bytes with zero, since some padding is added between attributes. */
memset ((char *) msg->data + old_len, 0, msg->len - old_len);
new_attr.rta_type = type;
new_attr.rta_len = attr_len;
next_attr_abs_pos = (char *) msg->data + next_attr_rel_pos;
memcpy (next_attr_abs_pos, &new_attr, sizeof (struct rtattr));
if (value)
memcpy (RTA_DATA (next_attr_abs_pos), value, len);
/* Update the total netlink message length */
netlink_message_header (msg)->msghdr.nlmsg_len = msg->len;
}
static void
append_netlink_attribute_uint32 (NetlinkMessage *msg,
gushort type,
guint32 value)
{
append_netlink_attribute (msg, type, &value, sizeof (value));
}
static NetlinkMessage *
netlink_message_new (guint ifindex,
guint16 type)
{
NetlinkMessage *msg;
NetlinkHeader *hdr;
int size = sizeof (NetlinkHeader);
msg = g_byte_array_new ();
g_byte_array_set_size (msg, size);
memset ((char *) msg->data, 0, size);
hdr = netlink_message_header (msg);
hdr->msghdr.nlmsg_len = msg->len;
hdr->msghdr.nlmsg_type = type;
hdr->msghdr.nlmsg_flags = NLM_F_REQUEST | NLM_F_ACK;
hdr->ifreq.ifi_family = AF_UNSPEC;
hdr->ifreq.ifi_index = ifindex;
hdr->ifreq.ifi_flags = 0;
hdr->ifreq.ifi_change = 0xFFFFFFFF;
return msg;
}
static NetlinkMessage *
netlink_message_new_setlink (guint ifindex,
gboolean up,
guint mtu)
{
NetlinkMessage *msg;
NetlinkHeader *hdr;
msg = netlink_message_new (ifindex, RTM_SETLINK);
hdr = netlink_message_header (msg);
hdr->ifreq.ifi_flags = up ? IFF_UP : 0;
hdr->ifreq.ifi_change = 0xFFFFFFFF;
if (mtu)
append_netlink_attribute_uint32 (msg, IFLA_MTU, mtu);
return msg;
}
static void
netlink_message_free (NetlinkMessage *msg)
{
g_byte_array_unref (msg);
}
/*****************************************************************************/
/* Netlink transactions */
typedef struct {
MMNetlink *self;
guint32 sequence_id;
GSource *timeout_source;
GTask *completion_task;
} Transaction;
static gboolean
transaction_timed_out (Transaction *tr)
{
GTask *task;
guint32 sequence_id;
task = g_steal_pointer (&tr->completion_task);
sequence_id = tr->sequence_id;
g_hash_table_remove (tr->self->transactions,
GUINT_TO_POINTER (tr->sequence_id));
g_task_return_new_error (task, G_IO_ERROR, G_IO_ERROR_TIMED_OUT,
"Netlink message with sequence ID %u timed out",
sequence_id);
g_object_unref (task);
return G_SOURCE_REMOVE;
}
static void
transaction_complete_with_error (Transaction *tr,
GError *error)
{
GTask *task;
task = g_steal_pointer (&tr->completion_task);
g_hash_table_remove (tr->self->transactions,
GUINT_TO_POINTER (tr->sequence_id));
g_task_return_error (task, error);
g_object_unref (task);
}
static void
transaction_complete (Transaction *tr,
gint saved_errno)
{
GTask *task;
guint32 sequence_id;
task = g_steal_pointer (&tr->completion_task);
sequence_id = tr->sequence_id;
g_hash_table_remove (tr->self->transactions,
GUINT_TO_POINTER (tr->sequence_id));
if (!saved_errno) {
g_task_return_boolean (task, TRUE);
} else {
g_task_return_new_error (task, G_IO_ERROR, g_io_error_from_errno (saved_errno),
"Netlink message with transaction %u failed",
sequence_id);
}
g_object_unref (task);
}
static void
transaction_free (Transaction *tr)
{
g_assert (tr->completion_task == NULL);
g_source_destroy (tr->timeout_source);
g_source_unref (tr->timeout_source);
g_slice_free (Transaction, tr);
}
static Transaction *
transaction_new (MMNetlink *self,
NetlinkMessage *msg,
guint timeout,
GTask *task)
{
Transaction *tr;
tr = g_slice_new0 (Transaction);
tr->self = self;
tr->sequence_id = ++self->current_sequence_id;
netlink_message_header (msg)->msghdr.nlmsg_seq = tr->sequence_id;
if (timeout) {
tr->timeout_source = g_timeout_source_new_seconds (timeout);
g_source_set_callback (tr->timeout_source,
(GSourceFunc) transaction_timed_out,
tr,
NULL);
g_source_attach (tr->timeout_source,
g_main_context_get_thread_default ());
}
tr->completion_task = g_object_ref (task);
g_hash_table_insert (self->transactions,
GUINT_TO_POINTER (tr->sequence_id),
tr);
return tr;
}
/*****************************************************************************/
gboolean
mm_netlink_setlink_finish (MMNetlink *self,
GAsyncResult *res,
GError **error)
{
return g_task_propagate_boolean (G_TASK (res), error);
}
void
mm_netlink_setlink (MMNetlink *self,
guint ifindex,
gboolean up,
guint mtu,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GTask *task;
NetlinkMessage *msg;
Transaction *tr;
gssize bytes_sent;
GError *error = NULL;
task = g_task_new (self, cancellable, callback, user_data);
if (!self->socket) {
g_task_return_new_error (task, MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
"netlink support not available");
g_object_unref (task);
return;
}
msg = netlink_message_new_setlink (ifindex, up, mtu);
/* The task ownership is transferred to the transaction. */
tr = transaction_new (self, msg, 5, task);
bytes_sent = g_socket_send (self->socket,
(const gchar *) msg->data,
msg->len,
cancellable,
&error);
netlink_message_free (msg);
if (bytes_sent < 0)
transaction_complete_with_error (tr, error);
g_object_unref (task);
}
/*****************************************************************************/
static gboolean
netlink_message_cb (GSocket *socket,
GIOCondition condition,
MMNetlink *self)
{
g_autoptr(GError) error = NULL;
gchar buf[512];
gssize bytes_received;
guint buffer_len;
struct nlmsghdr *hdr;
if (condition & G_IO_HUP || condition & G_IO_ERR) {
mm_obj_warn (self, "socket connection closed");
return G_SOURCE_REMOVE;
}
bytes_received = g_socket_receive (socket, buf, sizeof (buf), NULL, &error);
if (bytes_received < 0) {
mm_obj_warn (self, "socket i/o failure: %s", error->message);
return G_SOURCE_REMOVE;
}
buffer_len = (guint) bytes_received;
for (hdr = (struct nlmsghdr *) buf; NLMSG_OK (hdr, buffer_len);
NLMSG_NEXT (hdr, buffer_len)) {
Transaction *tr;
struct nlmsgerr *err;
if (hdr->nlmsg_type != NLMSG_ERROR)
continue;
tr = g_hash_table_lookup (self->transactions,
GUINT_TO_POINTER (hdr->nlmsg_seq));
if (!tr)
continue;
err = NLMSG_DATA (buf);
transaction_complete (tr, err->error);
}
return G_SOURCE_CONTINUE;
}
static gboolean
setup_netlink_socket (MMNetlink *self,
GError **error)
{
gint socket_fd;
socket_fd = socket (AF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
if (socket_fd < 0) {
g_set_error (error, MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
"Failed to create netlink socket");
return FALSE;
}
self->socket = g_socket_new_from_fd (socket_fd, error);
if (!self->socket) {
close (socket_fd);
return FALSE;
}
self->source = g_socket_create_source (self->socket,
G_IO_IN | G_IO_ERR | G_IO_HUP,
NULL);
g_source_set_callback (self->source,
(GSourceFunc) netlink_message_cb,
self,
NULL);
g_source_attach (self->source, NULL);
return TRUE;
}
/*****************************************************************************/
static gchar *
log_object_build_id (MMLogObject *_self)
{
return g_strdup ("netlink");
}
/********************************************************************/
static void
mm_netlink_init (MMNetlink *self)
{
g_autoptr(GError) error = NULL;
if (!setup_netlink_socket (self, &error)) {
mm_obj_warn (self, "couldn't setup netlink socket: %s", error->message);
return;
}
self->current_sequence_id = 0;
self->transactions = g_hash_table_new_full (g_direct_hash,
g_direct_equal,
NULL,
(GDestroyNotify) transaction_free);
}
static void
dispose (GObject *object)
{
MMNetlink *self = MM_NETLINK (object);
g_assert (g_hash_table_size (self->transactions) == 0);
g_clear_pointer (&self->transactions, g_hash_table_unref);
if (self->source)
g_source_destroy (self->source);
g_clear_pointer (&self->source, g_source_unref);
g_clear_object (&self->socket);
G_OBJECT_CLASS (mm_netlink_parent_class)->dispose (object);
}
static void
log_object_iface_init (MMLogObjectInterface *iface)
{
iface->build_id = log_object_build_id;
}
static void
mm_netlink_class_init (MMNetlinkClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->dispose = dispose;
}
MM_DEFINE_SINGLETON_GETTER (MMNetlink, mm_netlink_get, MM_TYPE_NETLINK);
/* ---------------------------------------------------------------------------------------------------- */

54
src/mm-netlink.h Normal file
View File

@@ -0,0 +1,54 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details:
*
* Basic netlink support from libqmi:
* Copyright (C) 2020 Eric Caruso <ejcaruso@chromium.org>
* Copyright (C) 2020 Andrew Lassalle <andrewlassalle@chromium.org>
*
* Copyright (C) 2021 Aleksander Morgado <aleksander@aleksander.es>
*/
#ifndef MM_NETLINK_H
#define MM_NETLINK_H
#include <glib-object.h>
#include <gio/gio.h>
G_BEGIN_DECLS
#define MM_TYPE_NETLINK (mm_netlink_get_type ())
#define MM_NETLINK(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), MM_TYPE_NETLINK, MMNetlink))
#define MM_NETLINK_CLASS(k) (G_TYPE_CHECK_CLASS_CAST ((k), MM_TYPE_NETLINK, MMNetlinkClass))
#define MM_NETLINK_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), MM_TYPE_NETLINK, MMNetlinkClass))
#define MM_IS_NETLINK(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), MM_TYPE_NETLINK))
#define MM_IS_NETLINK_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), MM_TYPE_NETLINK))
typedef struct _MMNetlink MMNetlink;
typedef struct _MMNetlinkClass MMNetlinkClass;
GType mm_netlink_get_type (void) G_GNUC_CONST;
MMNetlink *mm_netlink_get (void);
void mm_netlink_setlink (MMNetlink *self,
guint ifindex,
gboolean up,
guint mtu,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_netlink_setlink_finish (MMNetlink *self,
GAsyncResult *res,
GError **error);
G_END_DECLS
#endif /* MM_MODEM_HELPERS_NETLINK_H */

122
src/mm-port-net.c Normal file
View File

@@ -0,0 +1,122 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details:
*
* Copyright (C) 2021 - Aleksander Morgado <aleksander@aleksander.es>
*/
#include <net/if.h>
#include <ModemManager.h>
#include <mm-errors-types.h>
#include "mm-port-net.h"
#include "mm-log-object.h"
#include "mm-netlink.h"
G_DEFINE_TYPE (MMPortNet, mm_port_net, MM_TYPE_PORT)
struct _MMPortNetPrivate {
guint ifindex;
};
static void
ensure_ifindex (MMPortNet *self)
{
if (!self->priv->ifindex) {
self->priv->ifindex = if_nametoindex (mm_port_get_device (MM_PORT (self)));
if (!self->priv->ifindex)
mm_obj_warn (self, "couldn't get interface index");
else
mm_obj_dbg (self, "interface index: %u", self->priv->ifindex);
}
}
/*****************************************************************************/
gboolean
mm_port_net_link_setup_finish (MMPortNet *self,
GAsyncResult *res,
GError **error)
{
return g_task_propagate_boolean (G_TASK (res), error);
}
static void
netlink_setlink_ready (MMNetlink *netlink,
GAsyncResult *res,
GTask *task)
{
GError *error = NULL;
if (!mm_netlink_setlink_finish (netlink, res, &error)) {
g_prefix_error (&error, "netlink operation failed: ");
g_task_return_error (task, error);
} else
g_task_return_boolean (task, TRUE);
g_object_unref (task);
}
void
mm_port_net_link_setup (MMPortNet *self,
gboolean up,
guint mtu,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GTask *task;
task = g_task_new (self, cancellable, callback, user_data);
ensure_ifindex (self);
if (!self->priv->ifindex) {
g_task_return_new_error (task, MM_CORE_ERROR, MM_CORE_ERROR_FAILED,
"no valid interface index found for %s",
mm_port_get_device (MM_PORT (self)));
g_object_unref (task);
return;
}
mm_netlink_setlink (mm_netlink_get (), /* singleton */
self->priv->ifindex,
up,
mtu,
cancellable,
(GAsyncReadyCallback) netlink_setlink_ready,
task);
}
/*****************************************************************************/
MMPortNet *
mm_port_net_new (const gchar *name)
{
return MM_PORT_NET (g_object_new (MM_TYPE_PORT_NET,
MM_PORT_DEVICE, name,
MM_PORT_SUBSYS, MM_PORT_SUBSYS_NET,
MM_PORT_TYPE, MM_PORT_TYPE_NET,
NULL));
}
static void
mm_port_net_init (MMPortNet *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MM_TYPE_PORT_NET, MMPortNetPrivate);
}
static void
mm_port_net_class_init (MMPortNetClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
g_type_class_add_private (object_class, sizeof (MMPortNetPrivate));
}

63
src/mm-port-net.h Normal file
View File

@@ -0,0 +1,63 @@
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program 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 General Public License for more details:
*
* Copyright (C) 2021 Aleksander Morgado <aleksander@aleksander.es>
*/
#ifndef MM_PORT_NET_H
#define MM_PORT_NET_H
#include <glib.h>
#include <glib-object.h>
#include <gio/gio.h>
#include "mm-port.h"
/* Default MTU expected in a wwan interface */
#define MM_PORT_NET_MTU_DEFAULT 1500
#define MM_TYPE_PORT_NET (mm_port_net_get_type ())
#define MM_PORT_NET(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), MM_TYPE_PORT_NET, MMPortNet))
#define MM_PORT_NET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), MM_TYPE_PORT_NET, MMPortNetClass))
#define MM_IS_PORT_NET(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), MM_TYPE_PORT_NET))
#define MM_IS_PORT_NET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), MM_TYPE_PORT_NET))
#define MM_PORT_NET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), MM_TYPE_PORT_NET, MMPortNetClass))
typedef struct _MMPortNet MMPortNet;
typedef struct _MMPortNetClass MMPortNetClass;
typedef struct _MMPortNetPrivate MMPortNetPrivate;
struct _MMPortNet {
MMPort parent;
MMPortNetPrivate *priv;
};
struct _MMPortNetClass {
MMPortClass parent;
};
GType mm_port_net_get_type (void);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (MMPortNet, g_object_unref)
MMPortNet *mm_port_net_new (const gchar *name);
void mm_port_net_link_setup (MMPortNet *self,
gboolean up,
guint mtu,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data);
gboolean mm_port_net_link_setup_finish (MMPortNet *self,
GAsyncResult *res,
GError **error);
#endif /* MM_PORT_NET_H */