External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-11-02 19:31:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
631f72fc7b
libvirt/src/conf/networkcommon_conf.c
Daniel P. Berrangé 600462834f Remove all Author(s): lines from source file headers 
In many files there are header comments that contain an Author:
statement, supposedly reflecting who originally wrote the code.
In a large collaborative project like libvirt, any non-trivial
file will have been modified by a large number of different
contributors. IOW, the Author: comments are quickly out of date,
omitting people who have made significant contribitions.

In some places Author: lines have been added despite the person
merely being responsible for creating the file by moving existing
code out of another file. IOW, the Author: lines give an incorrect
record of authorship.

With this all in mind, the comments are useless as a means to identify
who to talk to about code in a particular file. Contributors will always
be better off using 'git log' and 'git blame' if they need to  find the
author of a particular bit of code.

This commit thus deletes all Author: comments from the source and adds
a rule to prevent them reappearing.

The Copyright headers are similarly misleading and inaccurate, however,
we cannot delete these as they have legal meaning, despite being largely
inaccurate. In addition only the copyright holder is permitted to change
their respective copyright statement.

Reviewed-by: Erik Skultety <eskultet@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
2018-12-13 16:08:38 +00:00

329 lines
11 KiB
C
Raw Blame History

/*
* networkcommon_conf.c: network XML handling
*
* Copyright (C) 2006-2014 Red Hat, Inc.
* Copyright (C) 2006-2008 Daniel P. Berrange
*
* 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.1 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, see
* <http://www.gnu.org/licenses/>.
*/
#include <config.h>
#include "virerror.h"
#include "datatypes.h"
#include "networkcommon_conf.h"
#include "viralloc.h"
#include "virstring.h"
#include "virxml.h"
#define VIR_FROM_THIS VIR_FROM_NETWORK
virNetDevIPRoutePtr
virNetDevIPRouteCreate(const char *errorDetail,
const char *family,
const char *address,
const char *netmask,
const char *gateway,
unsigned int prefix,
bool hasPrefix,
unsigned int metric,
bool hasMetric)
{
virNetDevIPRoutePtr def = NULL;
virSocketAddr testAddr;
if (VIR_ALLOC(def) < 0)
return NULL;
if (VIR_STRDUP(def->family, family) < 0)
goto error;
def->prefix = prefix;
def->has_prefix = hasPrefix;
def->metric = metric;
def->has_metric = hasMetric;
/* Note: both network and gateway addresses must be specified */
if (!address) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Missing required address attribute "
"in route definition"),
errorDetail);
goto error;
}
if (!gateway) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Missing required gateway attribute "
"in route definition"),
errorDetail);
goto error;
}
if (virSocketAddrParse(&def->address, address, AF_UNSPEC) < 0) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Bad network address '%s' "
"in route definition"),
errorDetail, address);
goto error;
}
if (virSocketAddrParse(&def->gateway, gateway, AF_UNSPEC) < 0) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Bad gateway address '%s' "
"in route definition"),
errorDetail, gateway);
goto error;
}
/* validate network address, etc. for each family */
if ((def->family == NULL) || (STREQ(def->family, "ipv4"))) {
if (!(VIR_SOCKET_ADDR_IS_FAMILY(&def->address, AF_INET) ||
VIR_SOCKET_ADDR_IS_FAMILY(&def->address, AF_UNSPEC))) {
virReportError(VIR_ERR_XML_ERROR,
def->family == NULL ?
_("%s: No family specified for non-IPv4 address '%s' "
"in route definition") :
_("%s: IPv4 family specified for non-IPv4 address '%s' "
"in route definition"),
errorDetail, address);
goto error;
}
if (!VIR_SOCKET_ADDR_IS_FAMILY(&def->gateway, AF_INET)) {
virReportError(VIR_ERR_XML_ERROR,
def->family == NULL ?
_("%s: No family specified for non-IPv4 gateway '%s' "
"in route definition") :
_("%s: IPv4 family specified for non-IPv4 gateway '%s' "
"in route definition"),
errorDetail, address);
goto error;
}
if (netmask) {
if (virSocketAddrParse(&def->netmask, netmask, AF_UNSPEC) < 0) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Bad netmask address '%s' "
"in route definition"),
errorDetail, netmask);
goto error;
}
if (!VIR_SOCKET_ADDR_IS_FAMILY(&def->netmask, AF_INET)) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Invalid netmask '%s' "
"for address '%s' (both must be IPv4)"),
errorDetail, netmask, address);
goto error;
}
if (def->has_prefix) {
/* can't have both netmask and prefix at the same time */
virReportError(VIR_ERR_XML_ERROR,
_("%s: Route definition cannot have both "
"a prefix and a netmask"),
errorDetail);
goto error;
}
}
if (def->prefix > 32) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Invalid prefix %u specified "
"in route definition, "
"must be 0 - 32"),
errorDetail, def->prefix);
goto error;
}
} else if (STREQ(def->family, "ipv6")) {
if (!VIR_SOCKET_ADDR_IS_FAMILY(&def->address, AF_INET6)) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: ipv6 family specified for non-IPv6 address '%s' "
"in route definition"),
errorDetail, address);
goto error;
}
if (netmask) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Specifying netmask invalid for IPv6 address '%s' "
"in route definition"),
errorDetail, address);
goto error;
}
if (!VIR_SOCKET_ADDR_IS_FAMILY(&def->gateway, AF_INET6)) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: ipv6 specified for non-IPv6 gateway address '%s' "
"in route definition"),
errorDetail, gateway);
goto error;
}
if (def->prefix > 128) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Invalid prefix %u specified "
"in route definition, "
"must be 0 - 128"),
errorDetail, def->prefix);
goto error;
}
} else {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Unrecognized family '%s' "
"in route definition"),
errorDetail, def->family);
goto error;
}
/* make sure the address is a network address */
if (netmask) {
if (virSocketAddrMask(&def->address, &def->netmask, &testAddr) < 0) {
virReportError(VIR_ERR_INTERNAL_ERROR,
_("%s: Error converting address '%s' with netmask '%s' "
"to network-address "
"in route definition"),
errorDetail, address, netmask);
goto error;
}
} else {
if (virSocketAddrMaskByPrefix(&def->address,
def->prefix, &testAddr) < 0) {
virReportError(VIR_ERR_INTERNAL_ERROR,
_("%s: Error converting address '%s' with prefix %u "
"to network-address "
"in route definition"),
errorDetail, address, def->prefix);
goto error;
}
}
if (!virSocketAddrEqual(&def->address, &testAddr)) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Address '%s' in route definition "
"is not a network address"),
errorDetail, address);
goto error;
}
return def;
error:
virNetDevIPRouteFree(def);
return NULL;
}
virNetDevIPRoutePtr
virNetDevIPRouteParseXML(const char *errorDetail,
xmlNodePtr node,
xmlXPathContextPtr ctxt)
{
/*
* virNetDevIPRoute object is already allocated as part
* of an array. On failure clear: it out, but don't free it.
*/
virNetDevIPRoutePtr def = NULL;
xmlNodePtr save;
char *family = NULL;
char *address = NULL, *netmask = NULL;
char *gateway = NULL;
unsigned long prefix = 0, metric = 0;
int prefixRc, metricRc;
bool hasPrefix = false;
bool hasMetric = false;
save = ctxt->node;
ctxt->node = node;
/* grab raw data from XML */
family = virXPathString("string(./@family)", ctxt);
address = virXPathString("string(./@address)", ctxt);
netmask = virXPathString("string(./@netmask)", ctxt);
gateway = virXPathString("string(./@gateway)", ctxt);
prefixRc = virXPathULong("string(./@prefix)", ctxt, &prefix);
if (prefixRc == -2) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Invalid prefix specified "
"in route definition"),
errorDetail);
goto cleanup;
}
hasPrefix = (prefixRc == 0);
metricRc = virXPathULong("string(./@metric)", ctxt, &metric);
if (metricRc == -2) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Invalid metric specified "
"in route definition"),
errorDetail);
goto cleanup;
}
if (metricRc == 0) {
hasMetric = true;
if (metric == 0) {
virReportError(VIR_ERR_XML_ERROR,
_("%s: Invalid metric value, must be > 0 "
"in route definition"),
errorDetail);
goto cleanup;
}
}
def = virNetDevIPRouteCreate(errorDetail, family, address, netmask,
gateway, prefix, hasPrefix, metric,
hasMetric);
cleanup:
ctxt->node = save;
VIR_FREE(family);
VIR_FREE(address);
VIR_FREE(netmask);
VIR_FREE(gateway);
return def;
}
int
virNetDevIPRouteFormat(virBufferPtr buf,
const virNetDevIPRoute *def)
{
int result = -1;
char *addr = NULL;
virBufferAddLit(buf, "<route");
if (def->family)
virBufferAsprintf(buf, " family='%s'", def->family);
if (!(addr = virSocketAddrFormat(&def->address)))
goto cleanup;
virBufferAsprintf(buf, " address='%s'", addr);
VIR_FREE(addr);
if (VIR_SOCKET_ADDR_VALID(&def->netmask)) {
if (!(addr = virSocketAddrFormat(&def->netmask)))
goto cleanup;
virBufferAsprintf(buf, " netmask='%s'", addr);
VIR_FREE(addr);
}
if (def->has_prefix)
virBufferAsprintf(buf, " prefix='%u'", def->prefix);
if (!(addr = virSocketAddrFormat(&def->gateway)))
goto cleanup;
virBufferAsprintf(buf, " gateway='%s'", addr);
VIR_FREE(addr);
if (def->has_metric && def->metric > 0)
virBufferAsprintf(buf, " metric='%u'", def->metric);
virBufferAddLit(buf, "/>\n");
result = 0;
cleanup:
return result;
}
Reference in New Issue View Git Blame Copy Permalink