virnetworkobj.c 47.2 KB
Newer Older
J
John Ferlan 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36
/*
 * virnetworkobj.c: handle network objects
 *                  (derived from network_conf.c)
 *
 * 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 <dirent.h>

#include "datatypes.h"
#include "virnetworkobj.h"

#include "viralloc.h"
#include "virerror.h"
#include "virfile.h"
#include "virhash.h"
#include "virlog.h"
#include "virstring.h"

#define VIR_FROM_THIS VIR_FROM_NETWORK

VIR_LOG_INIT("conf.virnetworkobj");

37 38 39 40
/* Currently, /sbin/tc implementation allows up to 16 bits for
 * minor class size. But the initial bitmap doesn't have to be
 * that big. */
#define INIT_CLASS_ID_BITMAP_SIZE (1<<4)
J
John Ferlan 已提交
41

J
John Ferlan 已提交
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60
struct _virNetworkObj {
    virObjectLockable parent;

    pid_t dnsmasqPid;
    pid_t radvdPid;
    bool active;
    bool autostart;
    bool persistent;

    virNetworkDefPtr def; /* The current definition */
    virNetworkDefPtr newDef; /* New definition to activate at shutdown */

    virBitmapPtr classIdMap; /* bitmap of class IDs for QoS */
    unsigned long long floor_sum; /* sum of all 'floor'-s of attached NICs */

    unsigned int taint;

    /* Immutable pointer, self locking APIs */
    virMacMapPtr macmap;
61 62

    virHashTablePtr ports; /* uuid -> virNetworkPortDefPtr */
J
John Ferlan 已提交
63 64
};

J
John Ferlan 已提交
65
struct _virNetworkObjList {
66
    virObjectRWLockable parent;
J
John Ferlan 已提交
67 68 69 70 71 72 73 74 75

    virHashTablePtr objs;
};

static virClassPtr virNetworkObjClass;
static virClassPtr virNetworkObjListClass;
static void virNetworkObjDispose(void *obj);
static void virNetworkObjListDispose(void *obj);

76 77
static int
virNetworkObjOnceInit(void)
J
John Ferlan 已提交
78
{
79
    if (!VIR_CLASS_NEW(virNetworkObj, virClassForObjectLockable()))
J
John Ferlan 已提交
80 81
        return -1;

82
    if (!VIR_CLASS_NEW(virNetworkObjList, virClassForObjectRWLockable()))
J
John Ferlan 已提交
83
        return -1;
84

J
John Ferlan 已提交
85 86 87 88
    return 0;
}


89
VIR_ONCE_GLOBAL_INIT(virNetworkObj);
J
John Ferlan 已提交
90

91 92 93 94 95 96 97 98 99 100 101
static int
virNetworkObjLoadAllPorts(virNetworkObjPtr net,
                          const char *stateDir);


static void
virNetworkObjPortFree(void *val, const void *key ATTRIBUTE_UNUSED)
{
    virNetworkPortDefFree(val);
}

J
John Ferlan 已提交
102 103 104
virNetworkObjPtr
virNetworkObjNew(void)
{
105
    virNetworkObjPtr obj;
J
John Ferlan 已提交
106 107 108 109

    if (virNetworkObjInitialize() < 0)
        return NULL;

110
    if (!(obj = virObjectLockableNew(virNetworkObjClass)))
J
John Ferlan 已提交
111 112
        return NULL;

113
    if (!(obj->classIdMap = virBitmapNew(INIT_CLASS_ID_BITMAP_SIZE)))
J
John Ferlan 已提交
114 115 116
        goto error;

    /* The first three class IDs are already taken */
117 118 119 120
    if (virBitmapSetBitExpand(obj->classIdMap, 0) < 0 ||
        virBitmapSetBitExpand(obj->classIdMap, 1) < 0 ||
        virBitmapSetBitExpand(obj->classIdMap, 2) < 0)
        goto error;
J
John Ferlan 已提交
121

122 123 124 125
    if (!(obj->ports = virHashCreate(10,
                                     virNetworkObjPortFree)))
        goto error;

126 127
    virObjectLock(obj);

128
    return obj;
J
John Ferlan 已提交
129 130

 error:
131
    virObjectUnref(obj);
J
John Ferlan 已提交
132 133 134
    return NULL;
}

135

J
John Ferlan 已提交
136
void
137
virNetworkObjEndAPI(virNetworkObjPtr *obj)
J
John Ferlan 已提交
138
{
139
    if (!*obj)
J
John Ferlan 已提交
140 141
        return;

142 143 144
    virObjectUnlock(*obj);
    virObjectUnref(*obj);
    *obj = NULL;
J
John Ferlan 已提交
145 146
}

147

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
virNetworkDefPtr
virNetworkObjGetDef(virNetworkObjPtr obj)
{
    return obj->def;
}


void
virNetworkObjSetDef(virNetworkObjPtr obj,
                    virNetworkDefPtr def)
{
    obj->def = def;
}


virNetworkDefPtr
virNetworkObjGetNewDef(virNetworkObjPtr obj)
{
    return obj->newDef;
}


170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
bool
virNetworkObjIsActive(virNetworkObjPtr obj)
{
    return obj->active;
}


void
virNetworkObjSetActive(virNetworkObjPtr obj,
                       bool active)
{
    obj->active = active;
}


185 186 187 188 189 190 191
bool
virNetworkObjIsPersistent(virNetworkObjPtr obj)
{
    return obj->persistent;
}


192 193 194 195 196 197 198 199 200 201 202 203 204 205 206
bool
virNetworkObjIsAutostart(virNetworkObjPtr obj)
{
    return obj->autostart;
}


void
virNetworkObjSetAutostart(virNetworkObjPtr obj,
                          bool autostart)
{
    obj->autostart = autostart;
}


207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
pid_t
virNetworkObjGetDnsmasqPid(virNetworkObjPtr obj)
{
    return obj->dnsmasqPid;
}


void
virNetworkObjSetDnsmasqPid(virNetworkObjPtr obj,
                           pid_t dnsmasqPid)
{
    obj->dnsmasqPid = dnsmasqPid;
}


pid_t
virNetworkObjGetRadvdPid(virNetworkObjPtr obj)
{
    return obj->radvdPid;
}


void
virNetworkObjSetRadvdPid(virNetworkObjPtr obj,
                         pid_t radvdPid)
{
    obj->radvdPid = radvdPid;
}


237 238 239 240 241 242 243
virBitmapPtr
virNetworkObjGetClassIdMap(virNetworkObjPtr obj)
{
    return obj->classIdMap;
}


244 245 246 247 248 249 250
virMacMapPtr
virNetworkObjGetMacMap(virNetworkObjPtr obj)
{
    return obj->macmap;
}


251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
unsigned long long
virNetworkObjGetFloorSum(virNetworkObjPtr obj)
{
    return obj->floor_sum;
}


void
virNetworkObjSetFloorSum(virNetworkObjPtr obj,
                         unsigned long long floor_sum)
{
    obj->floor_sum = floor_sum;
}


266 267 268 269 270 271 272 273 274 275 276
void
virNetworkObjSetMacMap(virNetworkObjPtr obj,
                       virMacMapPtr macmap)
{
    obj->macmap = macmap;
}


void
virNetworkObjUnrefMacMap(virNetworkObjPtr obj)
{
277 278
    virObjectUnref(obj->macmap);
    obj->macmap = NULL;
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
}


int
virNetworkObjMacMgrAdd(virNetworkObjPtr obj,
                       const char *dnsmasqStateDir,
                       const char *domain,
                       const virMacAddr *mac)
{
    char macStr[VIR_MAC_STRING_BUFLEN];
    char *file = NULL;
    int ret = -1;

    if (!obj->macmap)
        return 0;

    virMacAddrFormat(mac, macStr);

    if (!(file = virMacMapFileName(dnsmasqStateDir, obj->def->bridge)))
        goto cleanup;

    if (virMacMapAdd(obj->macmap, domain, macStr) < 0)
        goto cleanup;

    if (virMacMapWriteFile(obj->macmap, file) < 0)
        goto cleanup;

    ret = 0;
 cleanup:
    VIR_FREE(file);
    return ret;
}


int
virNetworkObjMacMgrDel(virNetworkObjPtr obj,
                       const char *dnsmasqStateDir,
                       const char *domain,
                       const virMacAddr *mac)
{
    char macStr[VIR_MAC_STRING_BUFLEN];
    char *file = NULL;
    int ret = -1;

    if (!obj->macmap)
        return 0;

    virMacAddrFormat(mac, macStr);

    if (!(file = virMacMapFileName(dnsmasqStateDir, obj->def->bridge)))
        goto cleanup;

    if (virMacMapRemove(obj->macmap, domain, macStr) < 0)
        goto cleanup;

    if (virMacMapWriteFile(obj->macmap, file) < 0)
        goto cleanup;

    ret = 0;
 cleanup:
    VIR_FREE(file);
    return ret;
}


344 345
virNetworkObjListPtr
virNetworkObjListNew(void)
J
John Ferlan 已提交
346 347 348 349 350 351
{
    virNetworkObjListPtr nets;

    if (virNetworkObjInitialize() < 0)
        return NULL;

352
    if (!(nets = virObjectRWLockableNew(virNetworkObjListClass)))
J
John Ferlan 已提交
353 354 355 356 357 358 359 360 361 362
        return NULL;

    if (!(nets->objs = virHashCreate(50, virObjectFreeHashData))) {
        virObjectUnref(nets);
        return NULL;
    }

    return nets;
}

363

364
static virNetworkObjPtr
J
John Ferlan 已提交
365 366 367
virNetworkObjFindByUUIDLocked(virNetworkObjListPtr nets,
                              const unsigned char *uuid)
{
368
    virNetworkObjPtr obj = NULL;
J
John Ferlan 已提交
369 370 371 372
    char uuidstr[VIR_UUID_STRING_BUFLEN];

    virUUIDFormat(uuid, uuidstr);

373 374 375 376
    obj = virHashLookup(nets->objs, uuidstr);
    if (obj)
        virObjectRef(obj);
    return obj;
J
John Ferlan 已提交
377 378
}

379

J
John Ferlan 已提交
380 381 382 383 384 385 386 387 388 389 390 391 392 393
/**
 * virNetworkObjFindByUUID:
 * @nets: list of network objects
 * @uuid: network uuid to find
 *
 * This functions locks @nets and find network object which
 * corresponds to @uuid.
 *
 * Returns: locked and ref'd network object.
 */
virNetworkObjPtr
virNetworkObjFindByUUID(virNetworkObjListPtr nets,
                        const unsigned char *uuid)
{
394
    virNetworkObjPtr obj;
J
John Ferlan 已提交
395

396
    virObjectRWLockRead(nets);
397
    obj = virNetworkObjFindByUUIDLocked(nets, uuid);
398
    virObjectRWUnlock(nets);
399 400 401
    if (obj)
        virObjectLock(obj);
    return obj;
J
John Ferlan 已提交
402 403
}

404

J
John Ferlan 已提交
405 406 407 408 409
static int
virNetworkObjSearchName(const void *payload,
                        const void *name ATTRIBUTE_UNUSED,
                        const void *data)
{
410
    virNetworkObjPtr obj = (virNetworkObjPtr) payload;
J
John Ferlan 已提交
411 412
    int want = 0;

413 414
    virObjectLock(obj);
    if (STREQ(obj->def->name, (const char *)data))
J
John Ferlan 已提交
415
        want = 1;
416
    virObjectUnlock(obj);
J
John Ferlan 已提交
417 418 419
    return want;
}

420

421
static virNetworkObjPtr
J
John Ferlan 已提交
422 423 424
virNetworkObjFindByNameLocked(virNetworkObjListPtr nets,
                              const char *name)
{
425
    virNetworkObjPtr obj = NULL;
J
John Ferlan 已提交
426

427 428 429 430
    obj = virHashSearch(nets->objs, virNetworkObjSearchName, name, NULL);
    if (obj)
        virObjectRef(obj);
    return obj;
J
John Ferlan 已提交
431 432
}

433

J
John Ferlan 已提交
434 435 436 437 438 439 440 441 442 443 444 445 446 447
/**
 * virNetworkObjFindByName:
 * @nets: list of network objects
 * @name: network name to find
 *
 * This functions locks @nets and find network object which
 * corresponds to @name.
 *
 * Returns: locked and ref'd network object.
 */
virNetworkObjPtr
virNetworkObjFindByName(virNetworkObjListPtr nets,
                        const char *name)
{
448
    virNetworkObjPtr obj;
J
John Ferlan 已提交
449

450
    virObjectRWLockRead(nets);
451
    obj = virNetworkObjFindByNameLocked(nets, name);
452
    virObjectRWUnlock(nets);
453 454 455
    if (obj)
        virObjectLock(obj);
    return obj;
J
John Ferlan 已提交
456 457
}

458

J
John Ferlan 已提交
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
bool
virNetworkObjTaint(virNetworkObjPtr obj,
                   virNetworkTaintFlags taint)
{
    unsigned int flag = (1 << taint);

    if (obj->taint & flag)
        return false;

    obj->taint |= flag;
    return true;
}


static void
474
virNetworkObjDispose(void *opaque)
J
John Ferlan 已提交
475
{
476
    virNetworkObjPtr obj = opaque;
J
John Ferlan 已提交
477

478
    virHashFree(obj->ports);
479 480 481 482
    virNetworkDefFree(obj->def);
    virNetworkDefFree(obj->newDef);
    virBitmapFree(obj->classIdMap);
    virObjectUnref(obj->macmap);
J
John Ferlan 已提交
483 484
}

485

J
John Ferlan 已提交
486
static void
487
virNetworkObjListDispose(void *opaque)
J
John Ferlan 已提交
488
{
489
    virNetworkObjListPtr nets = opaque;
J
John Ferlan 已提交
490 491 492 493

    virHashFree(nets->objs);
}

494

J
John Ferlan 已提交
495
/*
496
 * virNetworkObjUpdateAssignDef:
J
John Ferlan 已提交
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511
 * @network: the network object to update
 * @def: the new NetworkDef (will be consumed by this function)
 * @live: is this new def the "live" version, or the "persistent" version
 *
 * Replace the appropriate copy of the given network's def or newDef
 * with def. Use "live" and current state of the network to determine
 * which to replace and what to do with the old defs. When a non-live
 * def is set, indicate that the network is now persistent.
 *
 * NB: a persistent network can be made transient by calling with:
 * virNetworkObjAssignDef(network, NULL, false) (i.e. set the
 * persistent def to NULL)
 *
 */
void
512
virNetworkObjUpdateAssignDef(virNetworkObjPtr obj,
513 514
                             virNetworkDefPtr def,
                             bool live)
J
John Ferlan 已提交
515 516 517 518 519 520
{
    if (live) {
        /* before setting new live def, save (into newDef) any
         * existing persistent (!live) def to be restored when the
         * network is destroyed, unless there is one already saved.
         */
521 522
        if (obj->persistent && !obj->newDef)
            obj->newDef = obj->def;
J
John Ferlan 已提交
523
        else
524 525
            virNetworkDefFree(obj->def);
        obj->def = def;
J
John Ferlan 已提交
526
    } else { /* !live */
527 528
        virNetworkDefFree(obj->newDef);
        if (virNetworkObjIsActive(obj)) {
J
John Ferlan 已提交
529 530 531
            /* save new configuration to be restored on network
             * shutdown, leaving current live def alone
             */
532
            obj->newDef = def;
J
John Ferlan 已提交
533
        } else { /* !live and !active */
534
            if (obj->def && !obj->persistent) {
J
John Ferlan 已提交
535 536 537 538 539 540
                /* network isn't (yet) marked active or persistent,
                 * but already has a "live" def set. This means we are
                 * currently setting the persistent def as a part of
                 * the process of starting the network, so we need to
                 * preserve the "not yet live" def in network->def.
                 */
541
                obj->newDef = def;
J
John Ferlan 已提交
542 543 544 545 546
            } else {
                /* either there is no live def set, or this network
                 * was already set as persistent, so the proper thing
                 * is to overwrite network->def.
                 */
547 548 549
                obj->newDef = NULL;
                virNetworkDefFree(obj->def);
                obj->def = def;
J
John Ferlan 已提交
550 551
            }
        }
552
        obj->persistent = !!def;
J
John Ferlan 已提交
553 554 555
    }
}

556

J
John Ferlan 已提交
557 558 559 560 561 562 563 564 565 566 567
/*
 * If flags & VIR_NETWORK_OBJ_LIST_ADD_CHECK_LIVE then this will
 * refuse updating an existing def if the current def is live
 *
 * If flags & VIR_NETWORK_OBJ_LIST_ADD_LIVE then the @def being
 * added is assumed to represent a live config, not a future
 * inactive config
 *
 * If flags is zero, network is considered as inactive and persistent.
 */
static virNetworkObjPtr
568 569 570
virNetworkObjAssignDefLocked(virNetworkObjListPtr nets,
                             virNetworkDefPtr def,
                             unsigned int flags)
J
John Ferlan 已提交
571
{
572
    virNetworkObjPtr obj;
J
John Ferlan 已提交
573 574 575 576
    virNetworkObjPtr ret = NULL;
    char uuidstr[VIR_UUID_STRING_BUFLEN];

    /* See if a network with matching UUID already exists */
577 578
    if ((obj = virNetworkObjFindByUUIDLocked(nets, def->uuid))) {
        virObjectLock(obj);
J
John Ferlan 已提交
579
        /* UUID matches, but if names don't match, refuse it */
580 581
        if (STRNEQ(obj->def->name, def->name)) {
            virUUIDFormat(obj->def->uuid, uuidstr);
J
John Ferlan 已提交
582 583
            virReportError(VIR_ERR_OPERATION_FAILED,
                           _("network '%s' is already defined with uuid %s"),
584
                           obj->def->name, uuidstr);
J
John Ferlan 已提交
585 586 587 588 589
            goto cleanup;
        }

        if (flags & VIR_NETWORK_OBJ_LIST_ADD_CHECK_LIVE) {
            /* UUID & name match, but if network is already active, refuse it */
590
            if (virNetworkObjIsActive(obj)) {
J
John Ferlan 已提交
591 592
                virReportError(VIR_ERR_OPERATION_INVALID,
                               _("network is already active as '%s'"),
593
                               obj->def->name);
J
John Ferlan 已提交
594 595 596 597
                goto cleanup;
            }
        }

598
        virNetworkObjUpdateAssignDef(obj, def,
599
                                     !!(flags & VIR_NETWORK_OBJ_LIST_ADD_LIVE));
J
John Ferlan 已提交
600 601
    } else {
        /* UUID does not match, but if a name matches, refuse it */
602 603 604
        if ((obj = virNetworkObjFindByNameLocked(nets, def->name))) {
            virObjectLock(obj);
            virUUIDFormat(obj->def->uuid, uuidstr);
J
John Ferlan 已提交
605 606 607 608 609 610
            virReportError(VIR_ERR_OPERATION_FAILED,
                           _("network '%s' already exists with uuid %s"),
                           def->name, uuidstr);
            goto cleanup;
        }

611
        if (!(obj = virNetworkObjNew()))
J
John Ferlan 已提交
612 613 614
              goto cleanup;

        virUUIDFormat(def->uuid, uuidstr);
615
        if (virHashAddEntry(nets->objs, uuidstr, obj) < 0)
J
John Ferlan 已提交
616
            goto cleanup;
617
        virObjectRef(obj);
J
John Ferlan 已提交
618

619 620
        obj->def = def;
        obj->persistent = !(flags & VIR_NETWORK_OBJ_LIST_ADD_LIVE);
J
John Ferlan 已提交
621 622
    }

623
    VIR_STEAL_PTR(ret, obj);
J
John Ferlan 已提交
624 625

 cleanup:
626
    virNetworkObjEndAPI(&obj);
J
John Ferlan 已提交
627 628 629
    return ret;
}

630

J
John Ferlan 已提交
631
/*
632
 * virNetworkObjAssignDef:
J
John Ferlan 已提交
633 634 635 636 637 638 639 640 641
 * @nets: list of all networks
 * @def: the new NetworkDef (will be consumed by this function iff successful)
 * @flags: bitwise-OR of VIR_NETWORK_OBJ_LIST_ADD_* flags
 *
 * Either replace the appropriate copy of the NetworkDef with name
 * matching def->name or, if not found, create a new NetworkObj with
 * def. For an existing network, use "live" and current state of the
 * network to determine which to replace.
 *
642
 * Look at virNetworkObjAssignDefLocked() for @flags description.
J
John Ferlan 已提交
643 644 645 646
 *
 * Returns NULL on error, virNetworkObjPtr on success.
 */
virNetworkObjPtr
647 648 649
virNetworkObjAssignDef(virNetworkObjListPtr nets,
                       virNetworkDefPtr def,
                       unsigned int flags)
J
John Ferlan 已提交
650
{
651
    virNetworkObjPtr obj;
J
John Ferlan 已提交
652

653
    virObjectRWLockWrite(nets);
654
    obj = virNetworkObjAssignDefLocked(nets, def, flags);
655
    virObjectRWUnlock(nets);
656
    return obj;
J
John Ferlan 已提交
657 658
}

659

J
John Ferlan 已提交
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
/*
 * virNetworkObjSetDefTransient:
 * @network: network object pointer
 * @live: if true, run this operation even for an inactive network.
 *   this allows freely updated network->def with runtime defaults
 *   before starting the network, which will be discarded on network
 *   shutdown. Any cleanup paths need to be sure to handle newDef if
 *   the network is never started.
 *
 * Mark the active network config as transient. Ensures live-only update
 * operations do not persist past network destroy.
 *
 * Returns 0 on success, -1 on failure
 */
int
675
virNetworkObjSetDefTransient(virNetworkObjPtr obj,
676
                             bool live)
J
John Ferlan 已提交
677
{
678
    if (!virNetworkObjIsActive(obj) && !live)
J
John Ferlan 已提交
679 680
        return 0;

681
    if (!obj->persistent || obj->newDef)
J
John Ferlan 已提交
682 683
        return 0;

684 685
    obj->newDef = virNetworkDefCopy(obj->def, VIR_NETWORK_XML_INACTIVE);
    return obj->newDef ? 0 : -1;
J
John Ferlan 已提交
686 687
}

688

J
John Ferlan 已提交
689 690 691 692 693
/* virNetworkObjUnsetDefTransient:
 *
 * This *undoes* what virNetworkObjSetDefTransient did.
 */
void
694
virNetworkObjUnsetDefTransient(virNetworkObjPtr obj)
J
John Ferlan 已提交
695
{
696 697 698 699
    if (obj->newDef) {
        virNetworkDefFree(obj->def);
        obj->def = obj->newDef;
        obj->newDef = NULL;
J
John Ferlan 已提交
700 701 702
    }
}

703

J
John Ferlan 已提交
704 705 706 707 708 709 710 711 712 713
/*
 * virNetworkObjGetPersistentDef:
 * @network: network object pointer
 *
 * Return the persistent network configuration. If network is transient,
 * return the running config.
 *
 * Returns NULL on error, virNetworkDefPtr on success.
 */
virNetworkDefPtr
714
virNetworkObjGetPersistentDef(virNetworkObjPtr obj)
J
John Ferlan 已提交
715
{
716 717
    if (obj->newDef)
        return obj->newDef;
J
John Ferlan 已提交
718
    else
719
        return obj->def;
J
John Ferlan 已提交
720 721
}

722

J
John Ferlan 已提交
723 724 725 726 727 728 729 730 731 732 733 734
/*
 * virNetworkObjReplacePersistentDef:
 * @network: network object pointer
 * @def: new virNetworkDef to replace current persistent config
 *
 * Replace the "persistent" network configuration with the given new
 * virNetworkDef. This pays attention to whether or not the network
 * is active.
 *
 * Returns -1 on error, 0 on success
 */
int
735
virNetworkObjReplacePersistentDef(virNetworkObjPtr obj,
J
John Ferlan 已提交
736 737
                                  virNetworkDefPtr def)
{
738 739 740
    if (virNetworkObjIsActive(obj)) {
        virNetworkDefFree(obj->newDef);
        obj->newDef = def;
J
John Ferlan 已提交
741
    } else {
742 743
        virNetworkDefFree(obj->def);
        obj->def = def;
J
John Ferlan 已提交
744 745 746 747
    }
    return 0;
}

748

J
John Ferlan 已提交
749
/*
750
 * virNetworkObjConfigChangeSetup:
J
John Ferlan 已提交
751 752 753 754 755 756 757 758 759
 *
 * 1) checks whether network state is consistent with the requested
 *    type of modification.
 *
 * 3) make sure there are separate "def" and "newDef" copies of
 *    networkDef if appropriate.
 *
 * Returns 0 on success, -1 on error.
 */
760
static int
761
virNetworkObjConfigChangeSetup(virNetworkObjPtr obj,
762
                               unsigned int flags)
J
John Ferlan 已提交
763 764 765 766
{
    bool isActive;
    int ret = -1;

767
    isActive = virNetworkObjIsActive(obj);
J
John Ferlan 已提交
768 769 770 771 772 773 774 775

    if (!isActive && (flags & VIR_NETWORK_UPDATE_AFFECT_LIVE)) {
        virReportError(VIR_ERR_OPERATION_INVALID, "%s",
                       _("network is not running"));
        goto cleanup;
    }

    if (flags & VIR_NETWORK_UPDATE_AFFECT_CONFIG) {
776
        if (!obj->persistent) {
J
John Ferlan 已提交
777 778 779 780 781 782 783 784
            virReportError(VIR_ERR_OPERATION_INVALID, "%s",
                           _("cannot change persistent config of a "
                             "transient network"));
            goto cleanup;
        }
        /* this should already have been done by the driver, but do it
         * anyway just in case.
         */
785
        if (isActive && (virNetworkObjSetDefTransient(obj, false) < 0))
J
John Ferlan 已提交
786 787 788 789 790 791 792 793
            goto cleanup;
    }

    ret = 0;
 cleanup:
    return ret;
}

794 795

void
796
virNetworkObjRemoveInactive(virNetworkObjListPtr nets,
797
                            virNetworkObjPtr obj)
J
John Ferlan 已提交
798 799 800
{
    char uuidstr[VIR_UUID_STRING_BUFLEN];

801 802 803
    virUUIDFormat(obj->def->uuid, uuidstr);
    virObjectRef(obj);
    virObjectUnlock(obj);
804
    virObjectRWLockWrite(nets);
805
    virObjectLock(obj);
J
John Ferlan 已提交
806
    virHashRemoveEntry(nets->objs, uuidstr);
807
    virObjectRWUnlock(nets);
808
    virObjectUnref(obj);
J
John Ferlan 已提交
809 810
}

811

J
John Ferlan 已提交
812
static char *
813
virNetworkObjFormat(virNetworkObjPtr obj,
J
John Ferlan 已提交
814 815 816
                    unsigned int flags)
{
    virBuffer buf = VIR_BUFFER_INITIALIZER;
817
    char *classIdStr = virBitmapFormat(obj->classIdMap);
J
John Ferlan 已提交
818 819
    size_t i;

820
    if (!classIdStr)
J
John Ferlan 已提交
821 822 823 824
        goto error;

    virBufferAddLit(&buf, "<networkstatus>\n");
    virBufferAdjustIndent(&buf, 2);
825
    virBufferAsprintf(&buf, "<class_id bitmap='%s'/>\n", classIdStr);
826
    virBufferAsprintf(&buf, "<floor sum='%llu'/>\n", obj->floor_sum);
827
    VIR_FREE(classIdStr);
J
John Ferlan 已提交
828 829

    for (i = 0; i < VIR_NETWORK_TAINT_LAST; i++) {
830
        if (obj->taint & (1 << i))
J
John Ferlan 已提交
831 832 833 834
            virBufferAsprintf(&buf, "<taint flag='%s'/>\n",
                              virNetworkTaintTypeToString(i));
    }

835
    if (virNetworkDefFormatBuf(&buf, obj->def, flags) < 0)
J
John Ferlan 已提交
836 837 838 839 840 841 842 843 844 845 846 847 848 849 850
        goto error;

    virBufferAdjustIndent(&buf, -2);
    virBufferAddLit(&buf, "</networkstatus>");

    if (virBufferCheckError(&buf) < 0)
        goto error;

    return virBufferContentAndReset(&buf);

 error:
    virBufferFreeAndReset(&buf);
    return NULL;
}

851 852

int
853
virNetworkObjSaveStatus(const char *statusDir,
854
                        virNetworkObjPtr obj)
J
John Ferlan 已提交
855 856 857 858 859
{
    int ret = -1;
    int flags = 0;
    char *xml;

860
    if (!(xml = virNetworkObjFormat(obj, flags)))
J
John Ferlan 已提交
861 862
        goto cleanup;

863
    if (virNetworkSaveXML(statusDir, obj->def, xml))
J
John Ferlan 已提交
864 865 866 867 868 869 870 871
        goto cleanup;

    ret = 0;
 cleanup:
    VIR_FREE(xml);
    return ret;
}

872

873
static virNetworkObjPtr
J
John Ferlan 已提交
874 875 876 877 878 879
virNetworkLoadState(virNetworkObjListPtr nets,
                    const char *stateDir,
                    const char *name)
{
    char *configFile = NULL;
    virNetworkDefPtr def = NULL;
880
    virNetworkObjPtr obj = NULL;
J
John Ferlan 已提交
881 882 883
    xmlDocPtr xml = NULL;
    xmlNodePtr node = NULL, *nodes = NULL;
    xmlXPathContextPtr ctxt = NULL;
884
    virBitmapPtr classIdMap = NULL;
J
John Ferlan 已提交
885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
    unsigned long long floor_sum_val = 0;
    unsigned int taint = 0;
    int n;
    size_t i;


    if ((configFile = virNetworkConfigFile(stateDir, name)) == NULL)
        goto error;

    if (!(xml = virXMLParseCtxt(configFile, NULL, _("(network status)"), &ctxt)))
        goto error;

    if (!(node = virXPathNode("//network", ctxt))) {
        virReportError(VIR_ERR_INTERNAL_ERROR, "%s",
                       _("Could not find any 'network' element in status file"));
        goto error;
    }

    /* parse the definition first */
    ctxt->node = node;
    if (!(def = virNetworkDefParseXML(ctxt)))
        goto error;

    if (STRNEQ(name, def->name)) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Network config filename '%s'"
                         " does not match network name '%s'"),
                       configFile, def->name);
        goto error;
    }

    /* now parse possible status data */
    node = xmlDocGetRootElement(xml);
918
    if (virXMLNodeNameEqual(node, "networkstatus")) {
J
John Ferlan 已提交
919 920
        /* Newer network status file. Contains useful
         * info which are not to be found in bare config XML */
921
        char *classIdStr = NULL;
J
John Ferlan 已提交
922 923 924
        char *floor_sum = NULL;

        ctxt->node = node;
925 926
        if ((classIdStr = virXPathString("string(./class_id[1]/@bitmap)",
                                         ctxt))) {
927
            if (!(classIdMap = virBitmapParseUnlimited(classIdStr))) {
928
                VIR_FREE(classIdStr);
J
John Ferlan 已提交
929 930 931
                goto error;
            }
        }
932
        VIR_FREE(classIdStr);
J
John Ferlan 已提交
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967

        floor_sum = virXPathString("string(./floor[1]/@sum)", ctxt);
        if (floor_sum &&
            virStrToLong_ull(floor_sum, NULL, 10, &floor_sum_val) < 0) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("Malformed 'floor_sum' attribute: %s"),
                           floor_sum);
            VIR_FREE(floor_sum);
            goto error;
        }
        VIR_FREE(floor_sum);

        if ((n = virXPathNodeSet("./taint", ctxt, &nodes)) < 0)
            goto error;

        for (i = 0; i < n; i++) {
            char *str = virXMLPropString(nodes[i], "flag");
            if (str) {
                int flag = virNetworkTaintTypeFromString(str);
                if (flag < 0) {
                    virReportError(VIR_ERR_CONFIG_UNSUPPORTED,
                                   _("Unknown taint flag %s"), str);
                    VIR_FREE(str);
                    goto error;
                }
                VIR_FREE(str);
                /* Compute taint mask here. The network object does not
                 * exist yet, so we can't use virNetworkObjtTaint. */
                taint |= (1 << flag);
            }
        }
        VIR_FREE(nodes);
    }

    /* create the object */
968
    if (!(obj = virNetworkObjAssignDef(nets, def,
969
                                       VIR_NETWORK_OBJ_LIST_ADD_LIVE)))
J
John Ferlan 已提交
970 971 972 973
        goto error;
    /* do not put any "goto error" below this comment */

    /* assign status data stored in the network object */
974
    if (classIdMap) {
975 976
        virBitmapFree(obj->classIdMap);
        obj->classIdMap = classIdMap;
J
John Ferlan 已提交
977 978 979
    }

    if (floor_sum_val > 0)
980
        obj->floor_sum = floor_sum_val;
J
John Ferlan 已提交
981

982 983
    obj->taint = taint;
    obj->active = true; /* network with a state file is by definition active */
J
John Ferlan 已提交
984 985 986 987 988

 cleanup:
    VIR_FREE(configFile);
    xmlFreeDoc(xml);
    xmlXPathFreeContext(ctxt);
989
    return obj;
J
John Ferlan 已提交
990 991 992

 error:
    VIR_FREE(nodes);
993
    virBitmapFree(classIdMap);
J
John Ferlan 已提交
994 995 996 997
    virNetworkDefFree(def);
    goto cleanup;
}

998

999
static virNetworkObjPtr
1000 1001 1002 1003
virNetworkLoadConfig(virNetworkObjListPtr nets,
                     const char *configDir,
                     const char *autostartDir,
                     const char *name)
J
John Ferlan 已提交
1004 1005 1006
{
    char *configFile = NULL, *autostartLink = NULL;
    virNetworkDefPtr def = NULL;
1007
    virNetworkObjPtr obj;
J
John Ferlan 已提交
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028
    int autostart;

    if ((configFile = virNetworkConfigFile(configDir, name)) == NULL)
        goto error;
    if ((autostartLink = virNetworkConfigFile(autostartDir, name)) == NULL)
        goto error;

    if ((autostart = virFileLinkPointsTo(autostartLink, configFile)) < 0)
        goto error;

    if (!(def = virNetworkDefParseFile(configFile)))
        goto error;

    if (STRNEQ(name, def->name)) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("Network config filename '%s'"
                         " does not match network name '%s'"),
                       configFile, def->name);
        goto error;
    }

1029 1030 1031 1032 1033
    switch ((virNetworkForwardType) def->forward.type) {
    case VIR_NETWORK_FORWARD_NONE:
    case VIR_NETWORK_FORWARD_NAT:
    case VIR_NETWORK_FORWARD_ROUTE:
    case VIR_NETWORK_FORWARD_OPEN:
J
John Ferlan 已提交
1034 1035 1036 1037
        if (!def->mac_specified) {
            virNetworkSetBridgeMacAddr(def);
            virNetworkSaveConfig(configDir, def);
        }
1038 1039 1040 1041 1042 1043 1044
        break;

    case VIR_NETWORK_FORWARD_BRIDGE:
    case VIR_NETWORK_FORWARD_PRIVATE:
    case VIR_NETWORK_FORWARD_VEPA:
    case VIR_NETWORK_FORWARD_PASSTHROUGH:
    case VIR_NETWORK_FORWARD_HOSTDEV:
J
John Ferlan 已提交
1045 1046 1047
        /* Throw away MAC address for other forward types,
         * which could have been generated by older libvirt RPMs */
        def->mac_specified = false;
1048 1049 1050 1051 1052 1053
        break;

    case VIR_NETWORK_FORWARD_LAST:
    default:
        virReportEnumRangeError(virNetworkForwardType, def->forward.type);
        goto error;
J
John Ferlan 已提交
1054 1055
    }

1056
    if (!(obj = virNetworkObjAssignDef(nets, def, 0)))
J
John Ferlan 已提交
1057 1058
        goto error;

1059
    obj->autostart = (autostart == 1);
J
John Ferlan 已提交
1060 1061 1062 1063

    VIR_FREE(configFile);
    VIR_FREE(autostartLink);

1064
    return obj;
J
John Ferlan 已提交
1065 1066 1067 1068 1069 1070 1071 1072 1073 1074

 error:
    VIR_FREE(configFile);
    VIR_FREE(autostartLink);
    virNetworkDefFree(def);
    return NULL;
}


int
1075 1076
virNetworkObjLoadAllState(virNetworkObjListPtr nets,
                          const char *stateDir)
J
John Ferlan 已提交
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086
{
    DIR *dir;
    struct dirent *entry;
    int ret = -1;
    int rc;

    if ((rc = virDirOpenIfExists(&dir, stateDir)) <= 0)
        return rc;

    while ((ret = virDirRead(dir, &entry, stateDir)) > 0) {
1087
        virNetworkObjPtr obj;
J
John Ferlan 已提交
1088

1089
        if (!virStringStripSuffix(entry->d_name, ".xml"))
J
John Ferlan 已提交
1090 1091
            continue;

1092
        obj = virNetworkLoadState(nets, stateDir, entry->d_name);
1093 1094 1095 1096 1097 1098

        if (obj &&
            virNetworkObjLoadAllPorts(obj, stateDir) < 0) {
            virNetworkObjEndAPI(&obj);
            goto cleanup;
        }
1099
        virNetworkObjEndAPI(&obj);
J
John Ferlan 已提交
1100 1101
    }

1102
 cleanup:
J
John Ferlan 已提交
1103 1104 1105 1106 1107
    VIR_DIR_CLOSE(dir);
    return ret;
}


1108
int
1109 1110 1111
virNetworkObjLoadAllConfigs(virNetworkObjListPtr nets,
                            const char *configDir,
                            const char *autostartDir)
J
John Ferlan 已提交
1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
{
    DIR *dir;
    struct dirent *entry;
    int ret = -1;
    int rc;

    if ((rc = virDirOpenIfExists(&dir, configDir)) <= 0)
        return rc;

    while ((ret = virDirRead(dir, &entry, configDir)) > 0) {
1122
        virNetworkObjPtr obj;
J
John Ferlan 已提交
1123

1124
        if (!virStringStripSuffix(entry->d_name, ".xml"))
J
John Ferlan 已提交
1125 1126 1127 1128
            continue;

        /* NB: ignoring errors, so one malformed config doesn't
           kill the whole process */
1129
        obj = virNetworkLoadConfig(nets,
J
John Ferlan 已提交
1130 1131 1132
                                   configDir,
                                   autostartDir,
                                   entry->d_name);
1133
        virNetworkObjEndAPI(&obj);
J
John Ferlan 已提交
1134 1135 1136 1137 1138 1139
    }

    VIR_DIR_CLOSE(dir);
    return ret;
}

1140 1141

int
1142 1143
virNetworkObjDeleteConfig(const char *configDir,
                          const char *autostartDir,
1144
                          virNetworkObjPtr obj)
J
John Ferlan 已提交
1145 1146 1147 1148 1149
{
    char *configFile = NULL;
    char *autostartLink = NULL;
    int ret = -1;

1150
    if (!(configFile = virNetworkConfigFile(configDir, obj->def->name)))
J
John Ferlan 已提交
1151
        goto error;
1152
    if (!(autostartLink = virNetworkConfigFile(autostartDir, obj->def->name)))
J
John Ferlan 已提交
1153 1154 1155 1156
        goto error;

    /* Not fatal if this doesn't work */
    unlink(autostartLink);
1157
    obj->autostart = false;
J
John Ferlan 已提交
1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173

    if (unlink(configFile) < 0) {
        virReportSystemError(errno,
                             _("cannot remove config file '%s'"),
                             configFile);
        goto error;
    }

    ret = 0;

 error:
    VIR_FREE(configFile);
    VIR_FREE(autostartLink);
    return ret;
}

1174

1175
struct virNetworkObjBridgeInUseHelperData {
J
John Ferlan 已提交
1176 1177 1178 1179 1180
    const char *bridge;
    const char *skipname;
};

static int
1181 1182 1183
virNetworkObjBridgeInUseHelper(const void *payload,
                               const void *name ATTRIBUTE_UNUSED,
                               const void *opaque)
J
John Ferlan 已提交
1184 1185
{
    int ret;
1186
    virNetworkObjPtr obj = (virNetworkObjPtr) payload;
1187
    const struct virNetworkObjBridgeInUseHelperData *data = opaque;
J
John Ferlan 已提交
1188

1189
    virObjectLock(obj);
J
John Ferlan 已提交
1190
    if (data->skipname &&
1191 1192
        ((obj->def && STREQ(obj->def->name, data->skipname)) ||
         (obj->newDef && STREQ(obj->newDef->name, data->skipname))))
J
John Ferlan 已提交
1193
        ret = 0;
1194 1195 1196 1197
    else if ((obj->def && obj->def->bridge &&
              STREQ(obj->def->bridge, data->bridge)) ||
             (obj->newDef && obj->newDef->bridge &&
              STREQ(obj->newDef->bridge, data->bridge)))
J
John Ferlan 已提交
1198 1199 1200
        ret = 1;
    else
        ret = 0;
1201
    virObjectUnlock(obj);
J
John Ferlan 已提交
1202 1203 1204
    return ret;
}

1205

1206
bool
1207 1208 1209
virNetworkObjBridgeInUse(virNetworkObjListPtr nets,
                         const char *bridge,
                         const char *skipname)
J
John Ferlan 已提交
1210 1211
{
    virNetworkObjPtr obj;
1212
    struct virNetworkObjBridgeInUseHelperData data = {bridge, skipname};
J
John Ferlan 已提交
1213

1214
    virObjectRWLockRead(nets);
1215
    obj = virHashSearch(nets->objs, virNetworkObjBridgeInUseHelper, &data, NULL);
1216
    virObjectRWUnlock(nets);
J
John Ferlan 已提交
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236

    return obj != NULL;
}


/*
 * virNetworkObjUpdate:
 *
 * Apply the supplied update to the given virNetworkObj. Except for
 * @network pointing to an actual network object rather than the
 * opaque virNetworkPtr, parameters are identical to the public API
 * virNetworkUpdate.
 *
 * The original virNetworkDefs are copied, and all modifications made
 * to these copies. The originals are replaced with the copies only
 * after success has been guaranteed.
 *
 * Returns: -1 on error, 0 on success.
 */
int
1237
virNetworkObjUpdate(virNetworkObjPtr obj,
J
John Ferlan 已提交
1238 1239 1240 1241 1242 1243 1244 1245 1246 1247
                    unsigned int command, /* virNetworkUpdateCommand */
                    unsigned int section, /* virNetworkUpdateSection */
                    int parentIndex,
                    const char *xml,
                    unsigned int flags)  /* virNetworkUpdateFlags */
{
    int ret = -1;
    virNetworkDefPtr livedef = NULL, configdef = NULL;

    /* normalize config data, and check for common invalid requests. */
1248
    if (virNetworkObjConfigChangeSetup(obj, flags) < 0)
J
John Ferlan 已提交
1249 1250 1251 1252 1253 1254
       goto cleanup;

    if (flags & VIR_NETWORK_UPDATE_AFFECT_LIVE) {
        virNetworkDefPtr checkdef;

        /* work on a copy of the def */
1255
        if (!(livedef = virNetworkDefCopy(obj->def, 0)))
J
John Ferlan 已提交
1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272
            goto cleanup;
        if (virNetworkDefUpdateSection(livedef, command, section,
                                       parentIndex, xml, flags) < 0) {
            goto cleanup;
        }
        /* run a final format/parse cycle to make sure we didn't
         * add anything illegal to the def
         */
        if (!(checkdef = virNetworkDefCopy(livedef, 0)))
            goto cleanup;
        virNetworkDefFree(checkdef);
    }

    if (flags & VIR_NETWORK_UPDATE_AFFECT_CONFIG) {
        virNetworkDefPtr checkdef;

        /* work on a copy of the def */
1273
        if (!(configdef = virNetworkDefCopy(virNetworkObjGetPersistentDef(obj),
J
John Ferlan 已提交
1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
                                            VIR_NETWORK_XML_INACTIVE))) {
            goto cleanup;
        }
        if (virNetworkDefUpdateSection(configdef, command, section,
                                       parentIndex, xml, flags) < 0) {
            goto cleanup;
        }
        if (!(checkdef = virNetworkDefCopy(configdef,
                                           VIR_NETWORK_XML_INACTIVE))) {
            goto cleanup;
        }
        virNetworkDefFree(checkdef);
    }

    if (configdef) {
        /* successfully modified copy, now replace original */
1290
        if (virNetworkObjReplacePersistentDef(obj, configdef) < 0)
J
John Ferlan 已提交
1291 1292 1293 1294 1295
           goto cleanup;
        configdef = NULL;
    }
    if (livedef) {
        /* successfully modified copy, now replace original */
1296 1297
        virNetworkDefFree(obj->def);
        obj->def = livedef;
J
John Ferlan 已提交
1298 1299 1300 1301 1302 1303 1304 1305 1306 1307
        livedef = NULL;
    }

    ret = 0;
 cleanup:
    virNetworkDefFree(livedef);
    virNetworkDefFree(configdef);
    return ret;
}

1308

J
John Ferlan 已提交
1309 1310
#define MATCH(FLAG) (flags & (FLAG))
static bool
A
Anya Harter 已提交
1311 1312
virNetworkObjMatch(virNetworkObjPtr obj,
                   unsigned int flags)
J
John Ferlan 已提交
1313 1314 1315 1316
{
    /* filter by active state */
    if (MATCH(VIR_CONNECT_LIST_NETWORKS_FILTERS_ACTIVE) &&
        !((MATCH(VIR_CONNECT_LIST_NETWORKS_ACTIVE) &&
1317
           virNetworkObjIsActive(obj)) ||
J
John Ferlan 已提交
1318
          (MATCH(VIR_CONNECT_LIST_NETWORKS_INACTIVE) &&
1319
           !virNetworkObjIsActive(obj))))
J
John Ferlan 已提交
1320 1321 1322 1323 1324
        return false;

    /* filter by persistence */
    if (MATCH(VIR_CONNECT_LIST_NETWORKS_FILTERS_PERSISTENT) &&
        !((MATCH(VIR_CONNECT_LIST_NETWORKS_PERSISTENT) &&
1325
           obj->persistent) ||
J
John Ferlan 已提交
1326
          (MATCH(VIR_CONNECT_LIST_NETWORKS_TRANSIENT) &&
1327
           !obj->persistent)))
J
John Ferlan 已提交
1328 1329 1330 1331 1332
        return false;

    /* filter by autostart option */
    if (MATCH(VIR_CONNECT_LIST_NETWORKS_FILTERS_AUTOSTART) &&
        !((MATCH(VIR_CONNECT_LIST_NETWORKS_AUTOSTART) &&
1333
           obj->autostart) ||
J
John Ferlan 已提交
1334
          (MATCH(VIR_CONNECT_LIST_NETWORKS_NO_AUTOSTART) &&
1335
           !obj->autostart)))
J
John Ferlan 已提交
1336 1337 1338 1339 1340 1341
        return false;

    return true;
}
#undef MATCH

1342

1343 1344 1345
typedef struct _virNetworkObjListExportData virNetworkObjListExportData;
typedef virNetworkObjListExportData *virNetworkObjListExportDataPtr;
struct _virNetworkObjListExportData {
J
John Ferlan 已提交
1346 1347 1348 1349 1350 1351 1352 1353 1354
    virConnectPtr conn;
    virNetworkPtr *nets;
    virNetworkObjListFilter filter;
    unsigned int flags;
    int nnets;
    bool error;
};

static int
1355 1356 1357
virNetworkObjListExportCallback(void *payload,
                                const void *name ATTRIBUTE_UNUSED,
                                void *opaque)
J
John Ferlan 已提交
1358
{
1359
    virNetworkObjListExportDataPtr data = opaque;
J
John Ferlan 已提交
1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371
    virNetworkObjPtr obj = payload;
    virNetworkPtr net = NULL;

    if (data->error)
        return 0;

    virObjectLock(obj);

    if (data->filter &&
        !data->filter(data->conn, obj->def))
        goto cleanup;

A
Anya Harter 已提交
1372
    if (!virNetworkObjMatch(obj, data->flags))
J
John Ferlan 已提交
1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391
        goto cleanup;

    if (!data->nets) {
        data->nnets++;
        goto cleanup;
    }

    if (!(net = virGetNetwork(data->conn, obj->def->name, obj->def->uuid))) {
        data->error = true;
        goto cleanup;
    }

    data->nets[data->nnets++] = net;

 cleanup:
    virObjectUnlock(obj);
    return 0;
}

1392

J
John Ferlan 已提交
1393 1394 1395 1396 1397 1398 1399 1400
int
virNetworkObjListExport(virConnectPtr conn,
                        virNetworkObjListPtr netobjs,
                        virNetworkPtr **nets,
                        virNetworkObjListFilter filter,
                        unsigned int flags)
{
    int ret = -1;
1401
    virNetworkObjListExportData data = {
1402 1403
        .conn = conn, .nets = NULL, .filter = filter, .flags = flags,
        .nnets = 0, .error = false };
J
John Ferlan 已提交
1404

1405
    virObjectRWLockRead(netobjs);
J
John Ferlan 已提交
1406 1407 1408
    if (nets && VIR_ALLOC_N(data.nets, virHashSize(netobjs->objs) + 1) < 0)
        goto cleanup;

1409
    virHashForEach(netobjs->objs, virNetworkObjListExportCallback, &data);
J
John Ferlan 已提交
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422

    if (data.error)
        goto cleanup;

    if (data.nets) {
        /* trim the array to the final size */
        ignore_value(VIR_REALLOC_N(data.nets, data.nnets + 1));
        *nets = data.nets;
        data.nets = NULL;
    }

    ret = data.nnets;
 cleanup:
1423
    virObjectRWUnlock(netobjs);
J
John Ferlan 已提交
1424 1425 1426 1427 1428 1429 1430
    while (data.nets && data.nnets)
        virObjectUnref(data.nets[--data.nnets]);

    VIR_FREE(data.nets);
    return ret;
}

1431

J
John Ferlan 已提交
1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449
struct virNetworkObjListForEachHelperData {
    virNetworkObjListIterator callback;
    void *opaque;
    int ret;
};

static int
virNetworkObjListForEachHelper(void *payload,
                               const void *name ATTRIBUTE_UNUSED,
                               void *opaque)
{
    struct virNetworkObjListForEachHelperData *data = opaque;

    if (data->callback(payload, data->opaque) < 0)
        data->ret = -1;
    return 0;
}

1450

J
John Ferlan 已提交
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468
/**
 * virNetworkObjListForEach:
 * @nets: a list of network objects
 * @callback: function to call over each of object in the list
 * @opaque: pointer to pass to the @callback
 *
 * Function iterates over the list of network objects and calls
 * passed callback over each one of them. You should avoid
 * calling those virNetworkObjList APIs, which lock the list
 * again in favor of their virNetworkObj*Locked variants.
 *
 * Returns: 0 on success, -1 otherwise.
 */
int
virNetworkObjListForEach(virNetworkObjListPtr nets,
                         virNetworkObjListIterator callback,
                         void *opaque)
{
1469 1470
    struct virNetworkObjListForEachHelperData data = {
        .callback = callback, .opaque = opaque, .ret = 0};
1471
    virObjectRWLockRead(nets);
J
John Ferlan 已提交
1472
    virHashForEach(nets->objs, virNetworkObjListForEachHelper, &data);
1473
    virObjectRWUnlock(nets);
J
John Ferlan 已提交
1474 1475 1476
    return data.ret;
}

1477

J
John Ferlan 已提交
1478 1479 1480 1481
struct virNetworkObjListGetHelperData {
    virConnectPtr conn;
    virNetworkObjListFilter filter;
    char **names;
1482
    int nnames;
1483
    int maxnames;
J
John Ferlan 已提交
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498
    bool active;
    bool error;
};

static int
virNetworkObjListGetHelper(void *payload,
                           const void *name ATTRIBUTE_UNUSED,
                           void *opaque)
{
    struct virNetworkObjListGetHelperData *data = opaque;
    virNetworkObjPtr obj = payload;

    if (data->error)
        return 0;

1499
    if (data->maxnames >= 0 &&
1500
        data->nnames == data->maxnames)
J
John Ferlan 已提交
1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511
        return 0;

    virObjectLock(obj);

    if (data->filter &&
        !data->filter(data->conn, obj->def))
        goto cleanup;

    if ((data->active && virNetworkObjIsActive(obj)) ||
        (!data->active && !virNetworkObjIsActive(obj))) {
        if (data->names &&
1512
            VIR_STRDUP(data->names[data->nnames], obj->def->name) < 0) {
J
John Ferlan 已提交
1513 1514 1515
            data->error = true;
            goto cleanup;
        }
1516
        data->nnames++;
J
John Ferlan 已提交
1517 1518 1519 1520 1521 1522 1523
    }

 cleanup:
    virObjectUnlock(obj);
    return 0;
}

1524

J
John Ferlan 已提交
1525 1526 1527 1528
int
virNetworkObjListGetNames(virNetworkObjListPtr nets,
                          bool active,
                          char **names,
1529
                          int maxnames,
J
John Ferlan 已提交
1530 1531 1532 1533 1534 1535
                          virNetworkObjListFilter filter,
                          virConnectPtr conn)
{
    int ret = -1;

    struct virNetworkObjListGetHelperData data = {
1536 1537
        .conn = conn, .filter = filter, .names = names, .nnames = 0,
        .maxnames = maxnames, .active = active, .error = false};
J
John Ferlan 已提交
1538

1539
    virObjectRWLockRead(nets);
J
John Ferlan 已提交
1540
    virHashForEach(nets->objs, virNetworkObjListGetHelper, &data);
1541
    virObjectRWUnlock(nets);
J
John Ferlan 已提交
1542 1543 1544 1545

    if (data.error)
        goto cleanup;

1546
    ret = data.nnames;
J
John Ferlan 已提交
1547 1548
 cleanup:
    if (ret < 0) {
1549 1550
        while (data.nnames)
            VIR_FREE(data.names[--data.nnames]);
J
John Ferlan 已提交
1551 1552 1553 1554
    }
    return ret;
}

1555

J
John Ferlan 已提交
1556 1557 1558 1559 1560 1561 1562
int
virNetworkObjListNumOfNetworks(virNetworkObjListPtr nets,
                               bool active,
                               virNetworkObjListFilter filter,
                               virConnectPtr conn)
{
    struct virNetworkObjListGetHelperData data = {
1563 1564
        .conn = conn, .filter = filter, .names = NULL, .nnames = 0,
        .maxnames = -1, .active = active, .error = false};
J
John Ferlan 已提交
1565

1566
    virObjectRWLockRead(nets);
J
John Ferlan 已提交
1567
    virHashForEach(nets->objs, virNetworkObjListGetHelper, &data);
1568
    virObjectRWUnlock(nets);
J
John Ferlan 已提交
1569

1570
    return data.nnames;
J
John Ferlan 已提交
1571 1572
}

1573

J
John Ferlan 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587
struct virNetworkObjListPruneHelperData {
    unsigned int flags;
};

static int
virNetworkObjListPruneHelper(const void *payload,
                             const void *name ATTRIBUTE_UNUSED,
                             const void *opaque)
{
    const struct virNetworkObjListPruneHelperData *data = opaque;
    virNetworkObjPtr obj = (virNetworkObjPtr) payload;
    int want = 0;

    virObjectLock(obj);
A
Anya Harter 已提交
1588
    want = virNetworkObjMatch(obj, data->flags);
J
John Ferlan 已提交
1589 1590 1591 1592
    virObjectUnlock(obj);
    return want;
}

1593

J
John Ferlan 已提交
1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607
/**
 * virNetworkObjListPrune:
 * @nets: a list of network objects
 * @flags: bitwise-OR of virConnectListAllNetworksFlags
 *
 * Iterate over list of network objects and remove the desired
 * ones from it.
 */
void
virNetworkObjListPrune(virNetworkObjListPtr nets,
                       unsigned int flags)
{
    struct virNetworkObjListPruneHelperData data = {flags};

1608
    virObjectRWLockWrite(nets);
J
John Ferlan 已提交
1609
    virHashRemoveSet(nets->objs, virNetworkObjListPruneHelper, &data);
1610
    virObjectRWUnlock(nets);
J
John Ferlan 已提交
1611
}
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628


char *
virNetworkObjGetPortStatusDir(virNetworkObjPtr net,
                              const char *stateDir)
{
    char *ret;
    ignore_value(virAsprintf(&ret, "%s/%s/ports", stateDir, net->def->name));
    return ret;
}

int
virNetworkObjAddPort(virNetworkObjPtr net,
                     virNetworkPortDefPtr portdef,
                     const char *stateDir)
{
    char uuidstr[VIR_UUID_STRING_BUFLEN];
1629
    VIR_AUTOFREE(char *) dir = NULL;
1630 1631 1632 1633 1634 1635 1636

    virUUIDFormat(portdef->uuid, uuidstr);

    if (virHashLookup(net->ports, uuidstr)) {
        virReportError(VIR_ERR_NETWORK_PORT_EXIST,
                       _("Network port with UUID %s already exists"),
                       uuidstr);
1637
        return -1;
1638 1639 1640
    }

    if (!(dir = virNetworkObjGetPortStatusDir(net, stateDir)))
1641
        return -1;
1642 1643

    if (virHashAddEntry(net->ports, uuidstr, portdef) < 0)
1644
        return -1;
1645 1646 1647

    if (virNetworkPortDefSaveStatus(portdef, dir) < 0) {
        virHashRemoveEntry(net->ports, uuidstr);
1648
        return -1;
1649 1650
    }

1651
    return 0;
1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715
}


virNetworkPortDefPtr
virNetworkObjLookupPort(virNetworkObjPtr net,
                        const unsigned char *uuid)
{
    virNetworkPortDefPtr ret = NULL;
    char uuidstr[VIR_UUID_STRING_BUFLEN];

    virUUIDFormat(uuid, uuidstr);

    if (!(ret = virHashLookup(net->ports, uuidstr))) {
        virReportError(VIR_ERR_NO_NETWORK_PORT,
                       _("Network port with UUID %s does not exist"),
                       uuidstr);
        goto cleanup;
    }

 cleanup:
    return ret;
}


int
virNetworkObjDeletePort(virNetworkObjPtr net,
                        const unsigned char *uuid,
                        const char *stateDir)
{
    int ret = -1;
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    char *dir = NULL;
    virNetworkPortDefPtr portdef;

    virUUIDFormat(uuid, uuidstr);

    if (!(portdef = virHashLookup(net->ports, uuidstr))) {
        virReportError(VIR_ERR_NO_NETWORK_PORT,
                       _("Network port with UUID %s does not exist"),
                       uuidstr);
        goto cleanup;
    }

    if (!(dir = virNetworkObjGetPortStatusDir(net, stateDir)))
        goto cleanup;

    if (virNetworkPortDefDeleteStatus(portdef, dir) < 0)
        goto cleanup;

    if (virHashRemoveEntry(net->ports, uuidstr) < 0)
        goto cleanup;

    ret = 0;

 cleanup:
    VIR_FREE(dir);
    return ret;
}


int
virNetworkObjDeleteAllPorts(virNetworkObjPtr net,
                            const char *stateDir)
{
1716
    VIR_AUTOFREE(char *) dir = NULL;
1717
    DIR *dh = NULL;
1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
    struct dirent *de;
    int rc;
    int ret = -1;

    if (!(dir = virNetworkObjGetPortStatusDir(net, stateDir)))
        goto cleanup;

    if ((rc = virDirOpenIfExists(&dh, dir)) <= 0) {
        ret = rc;
        goto cleanup;
    }

    while ((rc = virDirRead(dh, &de, dir)) > 0) {
        char *file = NULL;

        if (!virStringStripSuffix(de->d_name, ".xml"))
            continue;

        if (virAsprintf(&file, "%s/%s.xml", dir, de->d_name) < 0)
            goto cleanup;

        if (unlink(file) < 0 && errno != ENOENT)
            VIR_WARN("Unable to delete %s", file);

        VIR_FREE(file);
    }

    virHashRemoveAll(net->ports);

    ret = 0;
 cleanup:
1749
    VIR_DIR_CLOSE(dh);
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808
    return ret;
}


typedef struct _virNetworkObjPortListExportData virNetworkObjPortListExportData;
typedef virNetworkObjPortListExportData *virNetworkObjPortListExportDataPtr;
struct _virNetworkObjPortListExportData {
    virNetworkPtr net;
    virNetworkDefPtr def;
    virNetworkPortPtr *ports;
    virNetworkPortListFilter filter;
    int nports;
    bool error;
};

static int
virNetworkObjPortListExportCallback(void *payload,
                                    const void *name ATTRIBUTE_UNUSED,
                                    void *opaque)
{
    virNetworkObjPortListExportDataPtr data = opaque;
    virNetworkPortDefPtr def = payload;
    virNetworkPortPtr port;

    if (data->error)
        return 0;

    if (data->filter &&
        !data->filter(data->net->conn, data->def, def))
        goto cleanup;

    if (!data->ports) {
        data->nports++;
        goto cleanup;
    }

    if (!(port = virGetNetworkPort(data->net, def->uuid))) {
        data->error = true;
        goto cleanup;
    }

    data->ports[data->nports++] = port;

 cleanup:
    return 0;
}


int
virNetworkObjPortListExport(virNetworkPtr net,
                            virNetworkObjPtr obj,
                            virNetworkPortPtr **ports,
                            virNetworkPortListFilter filter)
{
    virNetworkObjPortListExportData data = {
        net, obj->def, NULL, filter, 0, false,
    };
    int ret = -1;

1809 1810
    if (ports) {
        *ports = NULL;
1811

1812 1813 1814
        if (VIR_ALLOC_N(data.ports, virHashSize(obj->ports) + 1) < 0)
            goto cleanup;
    }
1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841

    virHashForEach(obj->ports, virNetworkObjPortListExportCallback, &data);

    if (data.error)
        goto cleanup;

    if (data.ports) {
        /* trim the array to the final size */
        ignore_value(VIR_REALLOC_N(data.ports, data.nports + 1));
        *ports = data.ports;
        data.ports = NULL;
    }

    ret = data.nports;
 cleanup:
    while (data.ports && data.nports)
        virObjectUnref(data.ports[--data.nports]);

    VIR_FREE(data.ports);
    return ret;
}


static int
virNetworkObjLoadAllPorts(virNetworkObjPtr net,
                          const char *stateDir)
{
1842
    VIR_AUTOFREE(char *) dir = NULL;
1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888
    DIR *dh = NULL;
    struct dirent *de;
    int ret = -1;
    int rc;
    char uuidstr[VIR_UUID_STRING_BUFLEN];
    virNetworkPortDefPtr portdef = NULL;

    if (!(dir = virNetworkObjGetPortStatusDir(net, stateDir)))
        goto cleanup;

    if ((rc = virDirOpenIfExists(&dh, dir)) <= 0) {
        ret = rc;
        goto cleanup;
    }

    while ((rc = virDirRead(dh, &de, dir)) > 0) {
        char *file = NULL;

        if (!virStringStripSuffix(de->d_name, ".xml"))
            continue;

        if (virAsprintf(&file, "%s/%s.xml", dir, de->d_name) < 0)
            goto cleanup;

        portdef = virNetworkPortDefParseFile(file);
        VIR_FREE(file);
        file = NULL;

        if (!portdef) {
            VIR_WARN("Cannot parse port %s", file);
            continue;
        }

        virUUIDFormat(portdef->uuid, uuidstr);
        if (virHashAddEntry(net->ports, uuidstr, portdef) < 0)
            goto cleanup;

        portdef = NULL;
    }

    ret = 0;
 cleanup:
    VIR_DIR_CLOSE(dh);
    virNetworkPortDefFree(portdef);
    return ret;
}