Blame libvirt-gobject/libvirt-gobject-network.c

Packit a07778
/*
Packit a07778
 * libvirt-gobject-network.c: libvirt glib integration
Packit a07778
 *
Packit a07778
 * Copyright (C) 2008 Daniel P. Berrange
Packit a07778
 * Copyright (C) 2010-2011 Red Hat, Inc.
Packit a07778
 *
Packit a07778
 * This library is free software; you can redistribute it and/or
Packit a07778
 * modify it under the terms of the GNU Lesser General Public
Packit a07778
 * License as published by the Free Software Foundation; either
Packit a07778
 * version 2.1 of the License, or (at your option) any later version.
Packit a07778
 *
Packit a07778
 * This library is distributed in the hope that it will be useful,
Packit a07778
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit a07778
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit a07778
 * Lesser General Public License for more details.
Packit a07778
 *
Packit a07778
 * You should have received a copy of the GNU Lesser General Public
Packit a07778
 * License along with this library. If not, see
Packit a07778
 * <http://www.gnu.org/licenses/>.
Packit a07778
 *
Packit a07778
 * Author: Daniel P. Berrange <berrange@redhat.com>
Packit a07778
 */
Packit a07778
Packit a07778
#include <config.h>
Packit a07778
Packit a07778
#include <libvirt/virterror.h>
Packit a07778
#include <string.h>
Packit a07778
Packit a07778
#include "libvirt-glib/libvirt-glib.h"
Packit a07778
#include "libvirt-gobject/libvirt-gobject.h"
Packit a07778
#include "libvirt-gobject-compat.h"
Packit a07778
#ifdef HAVE_VIR_NETWORK_GET_DHCP_LEASES
Packit a07778
#include "libvirt-gobject/libvirt-gobject-network-dhcp-lease-private.h"
Packit a07778
#endif /* HAVE_VIR_NETWORK_GET_DHCP_LEASES */
Packit a07778
Packit a07778
#define GVIR_NETWORK_GET_PRIVATE(obj)                         \
Packit a07778
        (G_TYPE_INSTANCE_GET_PRIVATE((obj), GVIR_TYPE_NETWORK, GVirNetworkPrivate))
Packit a07778
Packit a07778
struct _GVirNetworkPrivate
Packit a07778
{
Packit a07778
    virNetworkPtr handle;
Packit a07778
    gchar uuid[VIR_UUID_STRING_BUFLEN];
Packit a07778
};
Packit a07778
Packit a07778
G_DEFINE_TYPE_WITH_PRIVATE(GVirNetwork, gvir_network, G_TYPE_OBJECT);
Packit a07778
Packit a07778
Packit a07778
enum {
Packit a07778
    PROP_0,
Packit a07778
    PROP_HANDLE,
Packit a07778
};
Packit a07778
Packit a07778
Packit a07778
#define GVIR_NETWORK_ERROR gvir_network_error_quark()
Packit a07778
Packit a07778
Packit a07778
static GQuark
Packit a07778
gvir_network_error_quark(void)
Packit a07778
{
Packit a07778
    return g_quark_from_static_string("gvir-network");
Packit a07778
}
Packit a07778
Packit a07778
static void gvir_network_get_property(GObject *object,
Packit a07778
                                      guint prop_id,
Packit a07778
                                      GValue *value,
Packit a07778
                                      GParamSpec *pspec)
Packit a07778
{
Packit a07778
    GVirNetwork *network = GVIR_NETWORK(object);
Packit a07778
    GVirNetworkPrivate *priv = network->priv;
Packit a07778
Packit a07778
    switch (prop_id) {
Packit a07778
    case PROP_HANDLE:
Packit a07778
        g_value_set_boxed(value, priv->handle);
Packit a07778
        break;
Packit a07778
Packit a07778
    default:
Packit a07778
        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
Packit a07778
    }
Packit a07778
}
Packit a07778
Packit a07778
Packit a07778
static void gvir_network_set_property(GObject *object,
Packit a07778
                                      guint prop_id,
Packit a07778
                                      const GValue *value,
Packit a07778
                                      GParamSpec *pspec)
Packit a07778
{
Packit a07778
    GVirNetwork *network = GVIR_NETWORK(object);
Packit a07778
    GVirNetworkPrivate *priv = network->priv;
Packit a07778
Packit a07778
    switch (prop_id) {
Packit a07778
    case PROP_HANDLE:
Packit a07778
        if (priv->handle)
Packit a07778
            virNetworkFree(priv->handle);
Packit a07778
        priv->handle = g_value_dup_boxed(value);
Packit a07778
        break;
Packit a07778
Packit a07778
    default:
Packit a07778
        G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
Packit a07778
    }
Packit a07778
}
Packit a07778
Packit a07778
Packit a07778
static void gvir_network_finalize(GObject *object)
Packit a07778
{
Packit a07778
    GVirNetwork *network = GVIR_NETWORK(object);
Packit a07778
    GVirNetworkPrivate *priv = network->priv;
Packit a07778
Packit a07778
    virNetworkFree(priv->handle);
Packit a07778
Packit a07778
    G_OBJECT_CLASS(gvir_network_parent_class)->finalize(object);
Packit a07778
}
Packit a07778
Packit a07778
static void gvir_network_constructed(GObject *object)
Packit a07778
{
Packit a07778
    GVirNetwork *net = GVIR_NETWORK(object);
Packit a07778
    GVirNetworkPrivate *priv = net->priv;
Packit a07778
Packit a07778
    G_OBJECT_CLASS(gvir_network_parent_class)->constructed(object);
Packit a07778
Packit a07778
    /* xxx we may want to turn this into an initable */
Packit a07778
    if (virNetworkGetUUIDString(priv->handle, priv->uuid) < 0)
Packit a07778
        gvir_warning("Failed to get network UUID on %p", priv->handle);
Packit a07778
}
Packit a07778
Packit a07778
static void gvir_network_class_init(GVirNetworkClass *klass)
Packit a07778
{
Packit a07778
    GObjectClass *object_class = G_OBJECT_CLASS (klass);
Packit a07778
Packit a07778
    object_class->finalize = gvir_network_finalize;
Packit a07778
    object_class->get_property = gvir_network_get_property;
Packit a07778
    object_class->set_property = gvir_network_set_property;
Packit a07778
    object_class->constructed = gvir_network_constructed;
Packit a07778
Packit a07778
    g_object_class_install_property(object_class,
Packit a07778
                                    PROP_HANDLE,
Packit a07778
                                    g_param_spec_boxed("handle",
Packit a07778
                                                       "Handle",
Packit a07778
                                                       "The network handle",
Packit a07778
                                                       GVIR_TYPE_NETWORK_HANDLE,
Packit a07778
                                                       G_PARAM_READABLE |
Packit a07778
                                                       G_PARAM_WRITABLE |
Packit a07778
                                                       G_PARAM_CONSTRUCT_ONLY |
Packit a07778
                                                       G_PARAM_STATIC_STRINGS));
Packit a07778
}
Packit a07778
Packit a07778
Packit a07778
static void gvir_network_init(GVirNetwork *network)
Packit a07778
{
Packit a07778
    network->priv = GVIR_NETWORK_GET_PRIVATE(network);
Packit a07778
}
Packit a07778
Packit a07778
typedef struct virNetwork GVirNetworkHandle;
Packit a07778
Packit a07778
static GVirNetworkHandle*
Packit a07778
gvir_network_handle_copy(GVirNetworkHandle *src)
Packit a07778
{
Packit a07778
    virNetworkRef((virNetworkPtr)src);
Packit a07778
    return src;
Packit a07778
}
Packit a07778
Packit a07778
static void
Packit a07778
gvir_network_handle_free(GVirNetworkHandle *src)
Packit a07778
{
Packit a07778
    virNetworkFree((virNetworkPtr)src);
Packit a07778
}
Packit a07778
Packit a07778
G_DEFINE_BOXED_TYPE(GVirNetworkHandle, gvir_network_handle,
Packit a07778
                    gvir_network_handle_copy, gvir_network_handle_free)
Packit a07778
Packit a07778
const gchar *gvir_network_get_name(GVirNetwork *network)
Packit a07778
{
Packit a07778
    const char *name;
Packit a07778
Packit a07778
    g_return_val_if_fail(GVIR_IS_NETWORK(network), NULL);
Packit a07778
Packit a07778
    if (!(name = virNetworkGetName(network->priv->handle))) {
Packit a07778
        gvir_warning("Failed to get network name on %p", network->priv->handle);
Packit a07778
        return NULL;
Packit a07778
    }
Packit a07778
Packit a07778
    return name;
Packit a07778
}
Packit a07778
Packit a07778
Packit a07778
const gchar *gvir_network_get_uuid(GVirNetwork *network)
Packit a07778
{
Packit a07778
    g_return_val_if_fail(GVIR_IS_NETWORK(network), NULL);
Packit a07778
Packit a07778
    return network->priv->uuid;
Packit a07778
}
Packit a07778
Packit a07778
/**
Packit a07778
 * gvir_network_get_config:
Packit a07778
 * @network: the network
Packit a07778
 * @flags: the flags
Packit a07778
 * @err: Place-holder for possible errors
Packit a07778
 *
Packit a07778
 * Returns: (transfer full): the config. The returned object should be
Packit a07778
 * unreffed with g_object_unref() when no longer needed.
Packit a07778
 */
Packit a07778
GVirConfigNetwork *gvir_network_get_config(GVirNetwork *network,
Packit a07778
                                           guint flags,
Packit a07778
                                           GError **err)
Packit a07778
{
Packit a07778
    GVirNetworkPrivate *priv;
Packit a07778
    gchar *xml;
Packit a07778
Packit a07778
    g_return_val_if_fail(GVIR_IS_NETWORK(network), NULL);
Packit a07778
    g_return_val_if_fail(err == NULL || *err == NULL, NULL);
Packit a07778
Packit a07778
    priv = network->priv;
Packit a07778
    if (!(xml = virNetworkGetXMLDesc(priv->handle, flags))) {
Packit a07778
        gvir_set_error_literal(err, GVIR_NETWORK_ERROR,
Packit a07778
                               0,
Packit a07778
                               "Unable to get network XML config");
Packit a07778
        return NULL;
Packit a07778
    }
Packit a07778
Packit a07778
    GVirConfigNetwork *conf = gvir_config_network_new_from_xml(xml, err);
Packit a07778
Packit a07778
    free(xml);
Packit a07778
    return conf;
Packit a07778
}
Packit a07778
Packit a07778
/**
Packit a07778
 * gvir_network_get_dhcp_leases:
Packit a07778
 * @network: the network
Packit a07778
 * @mac: (allow-none): The optional ASCII formatted MAC address of an interface
Packit a07778
 * @flags: placeholder for flags, must be 0
Packit a07778
 * @err: Place-holder for possible errors
Packit a07778
 *
Packit a07778
 * This function fetches leases info of guests in the specified network. If the
Packit a07778
 * optional parameter @mac is specified, the returned list will contain only
Packit a07778
 * lease info about a specific guest interface with @mac. There can be multiple
Packit a07778
 * leases for a single @mac because this API supports DHCPv6 too.
Packit a07778
 *
Packit a07778
 * Returns:  (element-type LibvirtGObject.NetworkDHCPLease) (transfer full): the
Packit a07778
 * list of network leases. Each object in the returned list should be unreffed
Packit a07778
 * with g_object_unref() and the list itself using g_list_free, when no longer
Packit a07778
 * needed.
Packit a07778
 */
Packit a07778
GList *gvir_network_get_dhcp_leases(GVirNetwork *network,
Packit a07778
                                    const char *mac G_GNUC_UNUSED,
Packit a07778
                                    guint flags,
Packit a07778
                                    GError **err)
Packit a07778
{
Packit a07778
#ifdef HAVE_VIR_NETWORK_GET_DHCP_LEASES
Packit a07778
    virNetworkDHCPLeasePtr *leases;
Packit a07778
    GList *ret = NULL;
Packit a07778
    int num_leases, i;
Packit a07778
#endif /* HAVE_VIR_NETWORK_GET_DHCP_LEASES */
Packit a07778
Packit a07778
    g_return_val_if_fail(GVIR_IS_NETWORK(network), NULL);
Packit a07778
    g_return_val_if_fail(err == NULL || *err == NULL, NULL);
Packit a07778
    g_return_val_if_fail(flags == 0, NULL);
Packit a07778
Packit a07778
#ifdef HAVE_VIR_NETWORK_GET_DHCP_LEASES
Packit a07778
    num_leases = virNetworkGetDHCPLeases(network->priv->handle, mac, &leases, flags);
Packit a07778
    if (num_leases < 0) {
Packit a07778
        gvir_set_error_literal(err, GVIR_NETWORK_ERROR,
Packit a07778
                               0,
Packit a07778
                               "Unable to get network DHCP leases");
Packit a07778
        return NULL;
Packit a07778
    }
Packit a07778
Packit a07778
    if (num_leases == 0)
Packit a07778
        return NULL;
Packit a07778
Packit a07778
    for (i = 0; i < num_leases; i++) {
Packit a07778
        GVirNetworkDHCPLease *lease;
Packit a07778
Packit a07778
        lease = gvir_network_dhcp_lease_new(leases[i]);
Packit a07778
        ret = g_list_prepend(ret, lease);
Packit a07778
    }
Packit a07778
    free(leases);
Packit a07778
Packit a07778
    return g_list_reverse(ret);
Packit a07778
#else /* HAVE_VIR_NETWORK_GET_DHCP_LEASES */
Packit a07778
    g_set_error_literal(err, GVIR_NETWORK_ERROR,
Packit a07778
                        0,
Packit a07778
                        "Unable to get network DHCP leases");
Packit a07778
    return NULL;
Packit a07778
#endif /* HAVE_VIR_NETWORK_GET_DHCP_LEASES */
Packit a07778
}