blob: 4436c2ee9e30bbae9b9784f5d825732e18620c2f [file] [log] [blame]
/* -*- Mode: C; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* SPDX-License-Identifier: LGPL-2.1-or-later */
/*
* libmbim-glib -- GLib/GIO based library to control MBIM devices
*
* Copyright (C) 2021 Aleksander Morgado <aleksander@aleksander.es>
*
* Based on the QmiNetPortManagerRmnet from libqmi:
* Copyright (C) 2020-2021 Eric Caruso <ejcaruso@chromium.org>
* Copyright (C) 2020-2021 Andrew Lassalle <andrewlassalle@chromium.org>
*/
#include <linux/if_link.h>
#include <linux/netlink.h>
#include <linux/rtnetlink.h>
#include <net/if.h>
#include <net/if_arp.h>
#include <sys/socket.h>
#include <sys/types.h>
#include <string.h>
#include "mbim-device.h"
#include "mbim-helpers.h"
#include "mbim-error-types.h"
#include "mbim-net-port-manager.h"
G_DEFINE_TYPE (MbimNetPortManager, mbim_net_port_manager, G_TYPE_OBJECT)
struct _MbimNetPortManagerPrivate {
gchar *iface;
/* Netlink socket */
GSocket *socket;
GSource *source;
/* Netlink state */
guint current_sequence_id;
GHashTable *transactions;
};
/* alternative VLAN for IP session 0 if not untagged */
#define MBIM_IPS0_VID 4094
#define VLAN_DATA_TYPE "vlan"
/*****************************************************************************/
static gchar *
session_id_to_ifname (const gchar *ifname_prefix,
guint session_id)
{
/*
* Link names are in the form <PREFIX>.<SESSION ID> */
return g_strdup_printf ("%s%u", ifname_prefix, session_id);
}
/*****************************************************************************/
/*
* 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_nested (NetlinkMessage *msg,
gushort type)
{
append_netlink_attribute (msg, type, NULL, 0);
}
static void
append_netlink_attribute_string (NetlinkMessage *msg,
gushort type,
const gchar *value)
{
append_netlink_attribute (msg, type, value, strlen (value));
}
static void
append_netlink_attribute_uint16 (NetlinkMessage *msg,
gushort type,
guint16 value)
{
append_netlink_attribute (msg, type, &value, sizeof (value));
}
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 (guint16 type,
guint16 extra_flags)
{
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 | extra_flags;
hdr->ifreq.ifi_family = AF_UNSPEC;
return msg;
}
static void
netlink_message_free (NetlinkMessage *msg)
{
g_byte_array_unref (msg);
}
/*****************************************************************************/
typedef struct {
MbimNetPortManager *manager;
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->manager->priv->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->manager->priv->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->manager->priv->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: %s",
sequence_id,
g_strerror (saved_errno));
}
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 (MbimNetPortManager *manager,
NetlinkMessage *msg,
guint timeout,
GTask *task)
{
Transaction *tr;
tr = g_slice_new0 (Transaction);
tr->manager = manager;
tr->sequence_id = ++manager->priv->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 (manager->priv->transactions,
GUINT_TO_POINTER (tr->sequence_id),
tr);
return tr;
}
/*****************************************************************************/
static guint
session_id_to_vlan_id (guint session_id)
{
/* VLAN ID 4094 is an alternative mapping of MBIM session 0. If you create
* a subinterface with this ID then it will take over the session 0 traffic
* and no packets go untagged anymore. */
return (session_id == 0 ? MBIM_IPS0_VID : session_id);
}
/*****************************************************************************/
static NetlinkMessage *
netlink_message_new_link (guint vlan_id,
gchar *ifname,
guint base_if_index)
{
NetlinkMessage *msg;
guint linkinfo_pos, datainfo_pos;
struct rtattr info;
msg = netlink_message_new (RTM_NEWLINK, NLM_F_CREATE | NLM_F_EXCL);
append_netlink_attribute_uint32 (msg, IFLA_LINK, base_if_index);
append_netlink_attribute_string (msg, IFLA_IFNAME, ifname);
/* Store the position of the next attribute to adjust its length later. */
linkinfo_pos = get_pos_of_next_attr (msg);
append_netlink_attribute_nested (msg, IFLA_LINKINFO);
append_netlink_attribute_string (msg, IFLA_INFO_KIND, VLAN_DATA_TYPE);
/* Store the position of the next attribute to adjust its length later. */
datainfo_pos = get_pos_of_next_attr (msg);
append_netlink_attribute_nested (msg, IFLA_INFO_DATA);
append_netlink_attribute_uint16 (msg, IFLA_VLAN_ID, vlan_id);
/* Use memcpy to preserve byte alignment */
memcpy (&info, (char *) msg->data + datainfo_pos, sizeof (struct rtattr));
info.rta_len = msg->len - datainfo_pos;
memcpy ((char *) msg->data + datainfo_pos, &info, sizeof (struct rtattr));
memcpy (&info, (char *) msg->data + linkinfo_pos, sizeof (struct rtattr));
info.rta_len = msg->len - linkinfo_pos;
memcpy ((char *) msg->data + linkinfo_pos, &info, sizeof (struct rtattr));
return msg;
}
static NetlinkMessage *
netlink_message_del_link (guint ifindex)
{
NetlinkMessage *msg;
g_assert (ifindex != 0);
msg = netlink_message_new (RTM_DELLINK, 0);
netlink_message_header (msg)->ifreq.ifi_index = ifindex;
return msg;
}
/*****************************************************************************/
static gboolean
netlink_message_cb (GSocket *socket,
GIOCondition condition,
MbimNetPortManager *self)
{
GError *error = NULL;
gchar buf[512];
int bytes_received;
unsigned int buffer_len;
struct nlmsghdr *hdr;
if (condition & G_IO_HUP || condition & G_IO_ERR) {
g_warning ("[netlink] socket connection closed.");
return G_SOURCE_REMOVE;
}
bytes_received = g_socket_receive (socket, buf, sizeof (buf), NULL, &error);
if (bytes_received < 0) {
g_warning ("[netlink] socket i/o failure: %s", error->message);
g_error_free (error);
return G_SOURCE_REMOVE;
}
buffer_len = (unsigned int ) 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->priv->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
get_first_free_session_id (MbimNetPortManager *self,
const gchar *ifname_prefix,
guint *session_id)
{
guint i;
/* The minimum session id is really 0 (MBIM_DEVICE_SESSION_ID_MIN), but
* when we have to automatically allocate a new session id we'll start at
* 1, because 0 is also used by the non-muxed setup. */
for (i = 1; i <= MBIM_DEVICE_SESSION_ID_MAX; i++) {
g_autofree gchar *ifname = NULL;
ifname = session_id_to_ifname (ifname_prefix, i);
if (!if_nametoindex (ifname)) {
*session_id = i;
return TRUE;
}
}
return FALSE;
}
/*****************************************************************************/
typedef struct {
guint session_id;
guint vlan_id;
gchar *ifname;
} AddLinkContext;
static void
add_link_context_free (AddLinkContext *ctx)
{
g_free (ctx->ifname);
g_free (ctx);
}
gchar *
mbim_net_port_manager_add_link_finish (MbimNetPortManager *self,
guint *session_id,
GAsyncResult *res,
GError **error)
{
AddLinkContext *ctx;
ctx = g_task_get_task_data (G_TASK (res));
if (!g_task_propagate_boolean (G_TASK (res), error)) {
g_prefix_error (error, "Failed to add link with session id %d: ",
ctx->session_id);
return NULL;
}
*session_id = ctx->session_id;
return g_steal_pointer (&ctx->ifname);
}
void
mbim_net_port_manager_add_link (MbimNetPortManager *self,
guint session_id,
const gchar *base_ifname,
const gchar *ifname_prefix,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
NetlinkMessage *msg;
Transaction *tr;
GTask *task;
GError *error = NULL;
gssize bytes_sent;
guint base_if_index;
AddLinkContext *ctx;
task = g_task_new (self, cancellable, callback, user_data);
ctx = g_new0 (AddLinkContext, 1);
ctx->session_id = session_id;
g_task_set_task_data (task, ctx, (GDestroyNotify) add_link_context_free);
if (ctx->session_id == MBIM_DEVICE_SESSION_ID_AUTOMATIC) {
if (!get_first_free_session_id (self, ifname_prefix, &ctx->session_id)) {
g_task_return_new_error (task, MBIM_CORE_ERROR, MBIM_CORE_ERROR_FAILED,
"Failed to find an available session ID");
g_object_unref (task);
return;
}
g_debug ("Using dynamic session ID %u", ctx->session_id);
} else
g_debug ("Using static session ID %u", ctx->session_id);
/* validate interface to use */
if (g_strcmp0 (self->priv->iface, base_ifname) != 0) {
g_task_return_new_error (task, MBIM_CORE_ERROR, MBIM_CORE_ERROR_FAILED,
"Invalid network interface %s: expected %s",
base_ifname, self->priv->iface);
g_object_unref (task);
return;
}
base_if_index = if_nametoindex (base_ifname);
if (!base_if_index) {
g_task_return_new_error (task, MBIM_CORE_ERROR, MBIM_CORE_ERROR_FAILED,
"%s interface is not available",
base_ifname);
g_object_unref (task);
return;
}
ctx->ifname = session_id_to_ifname (ifname_prefix, ctx->session_id);
ctx->vlan_id = session_id_to_vlan_id (ctx->session_id);
g_debug ("Using ifname '%s' and vlan id %u", ctx->ifname, ctx->vlan_id);
msg = netlink_message_new_link (ctx->vlan_id, ctx->ifname, base_if_index);
/* The task ownership is transferred to the transaction. */
tr = transaction_new (self, msg, timeout, task);
bytes_sent = g_socket_send (self->priv->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);
}
gboolean
mbim_net_port_manager_del_link_finish (MbimNetPortManager *self,
GAsyncResult *res,
GError **error)
{
return g_task_propagate_boolean (G_TASK (res), error);
}
void
mbim_net_port_manager_del_link (MbimNetPortManager *self,
const gchar *ifname,
guint timeout,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
guint ifindex;
NetlinkMessage *msg;
Transaction *tr;
GTask *task;
GError *error = NULL;
gssize bytes_sent;
task = g_task_new (self, cancellable, callback, user_data);
ifindex = if_nametoindex (ifname);
if (ifindex == 0) {
g_task_return_new_error (task, MBIM_CORE_ERROR, MBIM_CORE_ERROR_FAILED,
"Failed to retrieve interface index for interface %s",
ifname);
g_object_unref (task);
return;
}
msg = netlink_message_del_link (ifindex);
/* The task ownership is transferred to the transaction. */
tr = transaction_new (self, msg, timeout, task);
bytes_sent = g_socket_send (self->priv->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);
}
/*****************************************************************************/
gboolean
mbim_net_port_manager_list_links (MbimNetPortManager *self,
const gchar *base_ifname,
GPtrArray **out_links,
GError **error)
{
g_autoptr(GFile) sysfs_file = NULL;
g_autofree gchar *sysfs_path = NULL;
sysfs_path = g_strdup_printf ("/sys/class/net/%s", base_ifname);
sysfs_file = g_file_new_for_path (sysfs_path);
return mbim_helpers_list_links (sysfs_file, NULL, NULL, out_links, error);
}
/*****************************************************************************/
typedef struct {
GPtrArray *links;
guint link_i;
} DelAllLinksContext;
static void
del_all_links_context_free (DelAllLinksContext *ctx)
{
g_clear_pointer (&ctx->links, g_ptr_array_unref);
g_slice_free (DelAllLinksContext, ctx);
}
gboolean
mbim_net_port_manager_del_all_links_finish (MbimNetPortManager *self,
GAsyncResult *res,
GError **error)
{
return g_task_propagate_boolean (G_TASK (res), error);
}
static void delete_next_link (GTask *task);
static void
port_manager_del_link_ready (MbimNetPortManager *self,
GAsyncResult *res,
GTask *task)
{
DelAllLinksContext *ctx;
GError *error = NULL;
ctx = g_task_get_task_data (task);
if (!mbim_net_port_manager_del_link_finish (self, res, &error)) {
g_task_return_error (task, error);
g_object_unref (task);
return;
}
g_ptr_array_remove_index_fast (ctx->links, 0);
delete_next_link (task);
}
static void
delete_next_link (GTask *task)
{
MbimNetPortManager *self;
DelAllLinksContext *ctx;
self = g_task_get_source_object (task);
ctx = g_task_get_task_data (task);
if (!ctx->links || ctx->links->len == 0) {
g_task_return_boolean (task, TRUE);
g_object_unref (task);
return;
}
mbim_net_port_manager_del_link (self,
g_ptr_array_index (ctx->links, 0),
5,
g_task_get_cancellable (task),
(GAsyncReadyCallback)port_manager_del_link_ready,
task);
}
void
mbim_net_port_manager_del_all_links (MbimNetPortManager *self,
const gchar *base_ifname,
GCancellable *cancellable,
GAsyncReadyCallback callback,
gpointer user_data)
{
GTask *task;
DelAllLinksContext *ctx;
GError *error = NULL;
task = g_task_new (self, cancellable, callback, user_data);
ctx = g_slice_new0 (DelAllLinksContext);
g_task_set_task_data (task, ctx, (GDestroyNotify)del_all_links_context_free);
if (!mbim_net_port_manager_list_links (self, base_ifname, &ctx->links, &error)) {
g_task_return_error (task, error);
g_object_unref (task);
return;
}
delete_next_link (task);
}
/*****************************************************************************/
MbimNetPortManager *
mbim_net_port_manager_new (const gchar *iface,
GError **error)
{
MbimNetPortManager *self;
gint socket_fd;
GSocket *gsocket;
GError *inner_error = NULL;
socket_fd = socket (AF_NETLINK, SOCK_DGRAM, NETLINK_ROUTE);
if (socket_fd < 0) {
g_set_error (error, MBIM_CORE_ERROR, MBIM_CORE_ERROR_FAILED,
"Failed to create netlink socket");
return NULL;
}
gsocket = g_socket_new_from_fd (socket_fd, &inner_error);
if (inner_error) {
g_debug ("Could not create socket: %s", inner_error->message);
close (socket_fd);
g_propagate_error (error, inner_error);
return NULL;
}
self = g_object_new (MBIM_TYPE_NET_PORT_MANAGER, NULL);
self->priv->iface = g_strdup (iface);
self->priv->socket = gsocket;
self->priv->source = g_socket_create_source (self->priv->socket,
G_IO_IN | G_IO_ERR | G_IO_HUP,
NULL);
g_source_set_callback (self->priv->source,
(GSourceFunc) netlink_message_cb,
self,
NULL);
g_source_attach (self->priv->source, g_main_context_get_thread_default ());
self->priv->current_sequence_id = 0;
self->priv->transactions =
g_hash_table_new_full (g_direct_hash,
g_direct_equal,
NULL,
(GDestroyNotify) transaction_free);
return self;
}
static void
mbim_net_port_manager_init (MbimNetPortManager *self)
{
self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self, MBIM_TYPE_NET_PORT_MANAGER, MbimNetPortManagerPrivate);
}
static void
finalize (GObject *object)
{
MbimNetPortManager *self = MBIM_NET_PORT_MANAGER (object);
g_assert (g_hash_table_size (self->priv->transactions) == 0);
g_hash_table_unref (self->priv->transactions);
g_free (self->priv->iface);
G_OBJECT_CLASS (mbim_net_port_manager_parent_class)->finalize (object);
}
static void
mbim_net_port_manager_class_init (MbimNetPortManagerClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
g_type_class_add_private (object_class, sizeof (MbimNetPortManagerPrivate));
object_class->finalize = finalize;
}