virconf.c 40.6 KB
Newer Older
1 2
/*
 * virconf.c: parser for a subset of the Python encoded Xen configuration files
D
Daniel Veillard 已提交
3
 *
4
 * Copyright (C) 2006-2014 Red Hat, Inc.
D
Daniel Veillard 已提交
5
 *
O
Osier Yang 已提交
6 7 8 9 10 11 12 13 14 15 16
 * 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
17
 * License along with this library.  If not, see
O
Osier Yang 已提交
18
 * <http://www.gnu.org/licenses/>.
D
Daniel Veillard 已提交
19 20 21 22
 *
 * Daniel Veillard <veillard@redhat.com>
 */

23
#include <config.h>
24

D
Daniel Veillard 已提交
25 26 27 28 29 30 31
#include <string.h>
#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

32
#include "virerror.h"
33
#include "virbuffer.h"
34
#include "virconf.h"
35
#include "virutil.h"
J
Jim Meyering 已提交
36
#include "c-ctype.h"
37
#include "virlog.h"
38
#include "viralloc.h"
E
Eric Blake 已提交
39
#include "virfile.h"
40
#include "virstring.h"
41
#include "configmake.h"
D
Daniel Veillard 已提交
42

43 44
#define VIR_FROM_THIS VIR_FROM_CONF

45 46
VIR_LOG_INIT("util.conf");

D
Daniel Veillard 已提交
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
typedef struct _virConfParserCtxt virConfParserCtxt;
typedef virConfParserCtxt *virConfParserCtxtPtr;

struct _virConfParserCtxt {
    const char* filename;
    const char* base;
    const char* cur;
    const char *end;
    int line;

    virConfPtr conf;
};

#define CUR (*ctxt->cur)
#define NEXT if (ctxt->cur < ctxt->end) ctxt->cur++;
#define IS_EOL(c) (((c) == '\n') || ((c) == '\r'))
J
Jim Meyering 已提交
63

64
#define SKIP_BLANKS_AND_EOL \
J
Jim Meyering 已提交
65
  do { while ((ctxt->cur < ctxt->end) && (c_isblank(CUR) || IS_EOL(CUR))) { \
66
         if (CUR == '\n') ctxt->line++; \
67
         ctxt->cur++; } } while (0)
68 69
#define SKIP_BLANKS \
  do { while ((ctxt->cur < ctxt->end) && (c_isblank(CUR))) \
J
Jim Meyering 已提交
70
          ctxt->cur++; } while (0)
D
Daniel Veillard 已提交
71

72 73 74
VIR_ENUM_IMPL(virConf, VIR_CONF_LAST,
              "*unexpected*",
              "long",
75
              "unsigned long",
76 77 78
              "string",
              "list");

D
Daniel Veillard 已提交
79 80 81 82 83 84 85 86 87 88 89
typedef struct _virConfEntry virConfEntry;
typedef virConfEntry *virConfEntryPtr;

struct _virConfEntry {
    virConfEntryPtr next;
    char* name;
    char* comment;
    virConfValuePtr value;
};

struct _virConf {
90
    char *filename;
91
    unsigned int flags;
D
Daniel Veillard 已提交
92 93 94 95 96
    virConfEntryPtr entries;
};

/**
 * virConfError:
97
 * @ctxt: the parser context if available or NULL
D
Daniel Veillard 已提交
98 99 100 101 102
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the xend daemon interface
 */
103 104
#define virConfError(ctxt, error, info) \
    virConfErrorHelper(__FILE__, __FUNCTION__, __LINE__, ctxt, error, info)
D
Daniel Veillard 已提交
105
static void
106 107 108
virConfErrorHelper(const char *file, const char *func, size_t line,
                   virConfParserCtxtPtr ctxt,
                   virErrorNumber error, const char *info)
D
Daniel Veillard 已提交
109 110 111 112
{
    if (error == VIR_ERR_OK)
        return;

113 114
    /* Construct the string 'filename:line: info' if we have that. */
    if (ctxt && ctxt->filename) {
115 116
        virReportErrorHelper(VIR_FROM_CONF, error, file, func, line,
                             _("%s:%d: %s"), ctxt->filename, ctxt->line, info);
117
    } else {
118 119
        virReportErrorHelper(VIR_FROM_CONF, error, file, func, line,
                             "%s", info);
120
    }
D
Daniel Veillard 已提交
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
}


/**
 * virConfFreeList:
 * @list: the list to free
 *
 * Free a list
 */
static void
virConfFreeList(virConfValuePtr list)
{
    virConfValuePtr next;

    while (list != NULL) {
        next = list->next;
137 138 139
        list->next = NULL;
        virConfFreeValue(list);
        list = next;
D
Daniel Veillard 已提交
140 141 142 143 144 145 146 147 148
    }
}

/**
 * virConfFreeValue:
 * @val: the value to free
 *
 * Free a value
 */
149
void
D
Daniel P. Berrange 已提交
150
virConfFreeValue(virConfValuePtr val)
D
Daniel Veillard 已提交
151 152 153
{
    if (val == NULL)
        return;
154 155
    if (val->type == VIR_CONF_STRING &&
        val->str != NULL)
156
        VIR_FREE(val->str);
157 158
    if (val->type == VIR_CONF_LIST &&
        val->list != NULL)
D
Daniel Veillard 已提交
159
        virConfFreeList(val->list);
160
    VIR_FREE(val);
D
Daniel Veillard 已提交
161 162
}

163
virConfPtr
D
Daniel P. Berrange 已提交
164
virConfNew(void)
D
Daniel Veillard 已提交
165 166 167
{
    virConfPtr ret;

168
    if (VIR_ALLOC(ret) < 0)
169
        return NULL;
170
    ret->filename = NULL;
171
    ret->flags = 0;
172

173
    return ret;
174
}
D
Daniel Veillard 已提交
175

176 177 178
/**
 * virConfCreate:
 * @filename: the name to report errors
179
 * @flags: combination of virConfFlag(s)
180 181 182 183 184 185
 *
 * Create a configuration internal structure
 *
 * Returns a pointer or NULL in case of error.
 */
static virConfPtr
186
virConfCreate(const char *filename, unsigned int flags)
187 188
{
    virConfPtr ret = virConfNew();
189 190 191 192 193 194
    if (!ret)
        return NULL;

    if (VIR_STRDUP(ret->filename, filename) < 0) {
        VIR_FREE(ret);
        return NULL;
195
    }
196 197

    ret->flags = flags;
198
    return ret;
D
Daniel Veillard 已提交
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218
}

/**
 * virConfAddEntry:
 * @conf: the conf structure
 * @name: name of the entry or NULL for comment
 * @value: the value if any
 * @comm: extra comment for that entry if any
 *
 * add one entry to the conf, the parameters are included in the conf
 * if successful and freed on virConfFree()
 *
 * Returns a pointer to the entry or NULL in case of failure
 */
static virConfEntryPtr
virConfAddEntry(virConfPtr conf, char *name, virConfValuePtr value, char *comm)
{
    virConfEntryPtr ret, prev;

    if (conf == NULL)
219
        return NULL;
D
Daniel Veillard 已提交
220
    if ((comm == NULL) && (name == NULL))
221
        return NULL;
222

223 224 225 226
    /* don't log fully commented out lines */
    if (name)
        VIR_DEBUG("Add entry %s %p", name, value);

227
    if (VIR_ALLOC(ret) < 0)
228
        return NULL;
229

D
Daniel Veillard 已提交
230 231 232 233 234 235 236 237
    ret->name = name;
    ret->value = value;
    ret->comment = comm;

    if (conf->entries == NULL) {
        conf->entries = ret;
    } else {
        prev = conf->entries;
238 239 240
        while (prev->next != NULL)
            prev = prev->next;
        prev->next = ret;
D
Daniel Veillard 已提交
241
    }
242
    return ret;
D
Daniel Veillard 已提交
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258
}


/**
 * virConfSaveValue:
 * @buf: output buffer
 * @val: a value
 *
 * Serialize the value to the buffer
 *
 * Returns 0 in case of success, -1 in case of error.
 */
static int
virConfSaveValue(virBufferPtr buf, virConfValuePtr val)
{
    if (val == NULL)
259
        return -1;
D
Daniel Veillard 已提交
260 261
    switch (val->type) {
        case VIR_CONF_NONE:
262
            return -1;
263
        case VIR_CONF_LLONG:
264 265
            virBufferAsprintf(buf, "%lld", val->l);
            break;
266
        case VIR_CONF_ULLONG:
267
            virBufferAsprintf(buf, "%llu", val->l);
268 269
            break;
        case VIR_CONF_STRING:
270 271 272 273 274 275 276 277 278 279
            if (val->str) {
                if (strchr(val->str, '\n') != NULL) {
                    virBufferAsprintf(buf, "\"\"\"%s\"\"\"", val->str);
                } else if (strchr(val->str, '"') == NULL) {
                    virBufferAsprintf(buf, "\"%s\"", val->str);
                } else if (strchr(val->str, '\'') == NULL) {
                    virBufferAsprintf(buf, "'%s'", val->str);
                } else {
                    virBufferAsprintf(buf, "\"\"\"%s\"\"\"", val->str);
                }
280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299
            }
            break;
        case VIR_CONF_LIST: {
            virConfValuePtr cur;

            cur = val->list;
            virBufferAddLit(buf, "[ ");
            if (cur != NULL) {
                virConfSaveValue(buf, cur);
                cur = cur->next;
                while (cur != NULL) {
                    virBufferAddLit(buf, ", ");
                    virConfSaveValue(buf, cur);
                    cur = cur->next;
                }
            }
            virBufferAddLit(buf, " ]");
            break;
        }
        default:
300
            return -1;
D
Daniel Veillard 已提交
301
    }
302
    return 0;
D
Daniel Veillard 已提交
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
}

/**
 * virConfSaveEntry:
 * @buf: output buffer
 * @cur: a conf entry
 *
 * Serialize the entry to the buffer
 *
 * Returns 0 in case of success, -1 in case of error.
 */
static int
virConfSaveEntry(virBufferPtr buf, virConfEntryPtr cur)
{
    if (cur->name != NULL) {
        virBufferAdd(buf, cur->name, -1);
319 320 321 322 323 324
        virBufferAddLit(buf, " = ");
        virConfSaveValue(buf, cur->value);
        if (cur->comment != NULL) {
            virBufferAddLit(buf, " #");
            virBufferAdd(buf, cur->comment, -1);
        }
D
Daniel Veillard 已提交
325
    } else if (cur->comment != NULL) {
326 327
        virBufferAddLit(buf, "#");
        virBufferAdd(buf, cur->comment, -1);
D
Daniel Veillard 已提交
328
    }
329
    virBufferAddLit(buf, "\n");
330
    return 0;
D
Daniel Veillard 已提交
331 332 333 334 335 336 337 338 339 340 341 342 343
}


/**
 * virConfParseLong:
 * @ctxt: the parsing context
 * @val: the result
 *
 * Parse one long int value
 *
 * Returns 0 in case of success and -1 in case of error
 */
static int
344
virConfParseLong(virConfParserCtxtPtr ctxt, long long *val)
D
Daniel Veillard 已提交
345
{
346
    long long l = 0;
D
Daniel Veillard 已提交
347 348 349 350
    int neg = 0;

    if (CUR == '-') {
        neg = 1;
351
        NEXT;
D
Daniel Veillard 已提交
352 353 354
    } else if (CUR == '+') {
        NEXT;
    }
J
Jim Meyering 已提交
355
    if ((ctxt->cur >= ctxt->end) || (!c_isdigit(CUR))) {
356
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("unterminated number"));
357
        return -1;
D
Daniel Veillard 已提交
358
    }
J
Jim Meyering 已提交
359
    while ((ctxt->cur < ctxt->end) && (c_isdigit(CUR))) {
D
Daniel Veillard 已提交
360
        l = l * 10 + (CUR - '0');
361
        NEXT;
D
Daniel Veillard 已提交
362
    }
363 364
    if (neg)
        l = -l;
D
Daniel Veillard 已提交
365
    *val = l;
366
    return 0;
D
Daniel Veillard 已提交
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
}

/**
 * virConfParseString:
 * @ctxt: the parsing context
 *
 * Parse one string
 *
 * Returns a pointer to the string or NULL in case of error
 */
static char *
virConfParseString(virConfParserCtxtPtr ctxt)
{
    const char *base;
    char *ret = NULL;

    if (CUR == '\'') {
        NEXT;
385 386 387 388
        base = ctxt->cur;
        while ((ctxt->cur < ctxt->end) && (CUR != '\'') && (!IS_EOL(CUR)))
            NEXT;
        if (CUR != '\'') {
389
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("unterminated string"));
390
            return NULL;
391
        }
392
        if (VIR_STRNDUP(ret, base, ctxt->cur - base) < 0)
393
            return NULL;
394
        NEXT;
395 396 397
    } else if ((ctxt->cur + 6 < ctxt->end) &&
               (STRPREFIX(ctxt->cur, "\"\"\""))) {
        /* String starts with python-style triple quotes """ */
398 399
        ctxt->cur += 3;
        base = ctxt->cur;
400

401
        /* Find the ending triple quotes */
402
        while ((ctxt->cur + 2 < ctxt->end) &&
403
               !(STRPREFIX(ctxt->cur, "\"\"\""))) {
404 405 406
            if (CUR == '\n')
                ctxt->line++;
            NEXT;
407
        }
408 409

        if (!STRPREFIX(ctxt->cur, "\"\"\"")) {
410
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("unterminated string"));
411
            return NULL;
412
        }
413
        if (VIR_STRNDUP(ret, base, ctxt->cur - base) < 0)
414
            return NULL;
415
        ctxt->cur += 3;
D
Daniel Veillard 已提交
416 417
    } else if (CUR == '"') {
        NEXT;
418 419 420 421
        base = ctxt->cur;
        while ((ctxt->cur < ctxt->end) && (CUR != '"') && (!IS_EOL(CUR)))
            NEXT;
        if (CUR != '"') {
422
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("unterminated string"));
423
            return NULL;
424
        }
425
        if (VIR_STRNDUP(ret, base, ctxt->cur - base) < 0)
426
            return NULL;
427
        NEXT;
428 429 430 431 432 433 434 435 436 437
    } else if (ctxt->conf->flags & VIR_CONF_FLAG_LXC_FORMAT) {
        base = ctxt->cur;
        /* LXC config format doesn't support comments after the value */
        while ((ctxt->cur < ctxt->end) && (!IS_EOL(CUR)))
            NEXT;
        /* Reverse to exclude the trailing blanks from the value */
        while ((ctxt->cur > base) && (c_isblank(CUR)))
            ctxt->cur--;
        if (VIR_STRNDUP(ret, base, ctxt->cur - base) < 0)
            return NULL;
D
Daniel Veillard 已提交
438
    }
439
    return ret;
D
Daniel Veillard 已提交
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
}

/**
 * virConfParseValue:
 * @ctxt: the parsing context
 *
 * Parse one value
 *
 * Returns a pointer to the value or NULL in case of error
 */
static virConfValuePtr
virConfParseValue(virConfParserCtxtPtr ctxt)
{
    virConfValuePtr ret, lst = NULL, tmp, prev;
    virConfType type = VIR_CONF_NONE;
    char *str = NULL;
456
    long long l = 0;
D
Daniel Veillard 已提交
457

J
Jim Meyering 已提交
458
    SKIP_BLANKS;
D
Daniel Veillard 已提交
459
    if (ctxt->cur >= ctxt->end) {
460
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("expecting a value"));
461
        return NULL;
D
Daniel Veillard 已提交
462
    }
463 464
    if ((CUR == '"') || (CUR == '\'') ||
         (ctxt->conf->flags & VIR_CONF_FLAG_LXC_FORMAT)) {
D
Daniel Veillard 已提交
465 466
        type = VIR_CONF_STRING;
        str = virConfParseString(ctxt);
467
        if (str == NULL)
468
            return NULL;
D
Daniel Veillard 已提交
469
    } else if (CUR == '[') {
470 471 472
        if (ctxt->conf->flags & VIR_CONF_FLAG_VMX_FORMAT) {
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX,
                         _("lists not allowed in VMX format"));
473
            return NULL;
474
        }
D
Daniel Veillard 已提交
475 476
        type = VIR_CONF_LIST;
        NEXT;
J
Jim Meyering 已提交
477
        SKIP_BLANKS_AND_EOL;
478
        if ((ctxt->cur < ctxt->end) && (CUR != ']')) {
479
            if ((lst = virConfParseValue(ctxt)) == NULL)
480
                return NULL;
J
Jim Meyering 已提交
481
            SKIP_BLANKS_AND_EOL;
482 483
        }
        while ((ctxt->cur < ctxt->end) && (CUR != ']')) {
484 485 486 487 488

            /* Tell Clang that when execution reaches this point
               "lst" is guaranteed to be non-NULL.  This stops it
               from issuing an invalid NULL-dereference warning about
               "prev = lst; while (prev->next..." below.  */
489
            sa_assert(lst);
490

491
            if (CUR != ',') {
492 493
                virConfError(ctxt, VIR_ERR_CONF_SYNTAX,
                             _("expecting a separator in list"));
494
                virConfFreeList(lst);
495
                return NULL;
496 497
            }
            NEXT;
J
Jim Meyering 已提交
498
            SKIP_BLANKS_AND_EOL;
499
            if (CUR == ']')
500 501 502 503
                break;
            tmp = virConfParseValue(ctxt);
            if (tmp == NULL) {
                virConfFreeList(lst);
504
                return NULL;
505 506 507 508
            }
            prev = lst;
            while (prev->next != NULL) prev = prev->next;
            prev->next = tmp;
J
Jim Meyering 已提交
509
            SKIP_BLANKS_AND_EOL;
510 511 512 513
        }
        if (CUR == ']') {
            NEXT;
        } else {
514 515
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX,
                         _("list is not closed with ]"));
516
            virConfFreeList(lst);
517
            return NULL;
518
        }
J
Jim Meyering 已提交
519
    } else if (c_isdigit(CUR) || (CUR == '-') || (CUR == '+')) {
520 521 522
        if (ctxt->conf->flags & VIR_CONF_FLAG_VMX_FORMAT) {
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX,
                         _("numbers not allowed in VMX format"));
523
            return NULL;
524
        }
525
        type = (CUR == '-') ? VIR_CONF_LLONG : VIR_CONF_ULLONG;
526
        if (virConfParseLong(ctxt, &l) < 0)
527
            return NULL;
D
Daniel Veillard 已提交
528
    } else {
529
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("expecting a value"));
530
        return NULL;
D
Daniel Veillard 已提交
531
    }
532 533 534
    if (VIR_ALLOC(ret) < 0) {
        virConfFreeList(lst);
        VIR_FREE(str);
535
        return NULL;
D
Daniel Veillard 已提交
536 537 538 539 540
    }
    ret->type = type;
    ret->l = l;
    ret->str = str;
    ret->list = lst;
541
    return ret;
D
Daniel Veillard 已提交
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
}

/**
 * virConfParseName:
 * @ctxt: the parsing context
 *
 * Parse one name
 *
 * Returns a copy of the new string, NULL in case of error
 */
static char *
virConfParseName(virConfParserCtxtPtr ctxt)
{
    const char *base;
    char *ret;

J
Jim Meyering 已提交
558
    SKIP_BLANKS;
D
Daniel Veillard 已提交
559 560
    base = ctxt->cur;
    /* TODO: probably need encoding support and UTF-8 parsing ! */
561 562
    if (!c_isalpha(CUR) &&
        !((ctxt->conf->flags & VIR_CONF_FLAG_VMX_FORMAT) && (CUR == '.'))) {
563
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("expecting a name"));
564
        return NULL;
D
Daniel Veillard 已提交
565
    }
566 567
    while ((ctxt->cur < ctxt->end) &&
           (c_isalnum(CUR) || (CUR == '_') ||
568
            ((ctxt->conf->flags & VIR_CONF_FLAG_VMX_FORMAT) &&
569 570 571
             ((CUR == ':') || (CUR == '.') || (CUR == '-'))) ||
            ((ctxt->conf->flags & VIR_CONF_FLAG_LXC_FORMAT) &&
             (CUR == '.'))))
D
Daniel Veillard 已提交
572
        NEXT;
573
    if (VIR_STRNDUP(ret, base, ctxt->cur - base) < 0)
574 575
        return NULL;
    return ret;
D
Daniel Veillard 已提交
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592
}

/**
 * virConfParseComment:
 * @ctxt: the parsing context
 *
 * Parse one standalone comment in the configuration file
 *
 * Returns 0 in case of success and -1 in case of error
 */
static int
virConfParseComment(virConfParserCtxtPtr ctxt)
{
    const char *base;
    char *comm;

    if (CUR != '#')
593
        return -1;
D
Daniel Veillard 已提交
594 595 596
    NEXT;
    base = ctxt->cur;
    while ((ctxt->cur < ctxt->end) && (!IS_EOL(CUR))) NEXT;
597
    if (VIR_STRNDUP(comm, base, ctxt->cur - base) < 0)
598
        return -1;
599 600 601 602
    if (virConfAddEntry(ctxt->conf, NULL, NULL, comm) == NULL) {
        VIR_FREE(comm);
        return -1;
    }
603
    return 0;
D
Daniel Veillard 已提交
604 605 606 607 608 609 610 611 612 613 614 615 616
}

/**
 * virConfParseSeparator:
 * @ctxt: the parsing context
 *
 * Parse one separator between statement if not at the end.
 *
 * Returns 0 in case of success and -1 in case of error
 */
static int
virConfParseSeparator(virConfParserCtxtPtr ctxt)
{
J
Jim Meyering 已提交
617
    SKIP_BLANKS;
D
Daniel Veillard 已提交
618
    if (ctxt->cur >= ctxt->end)
619
        return 0;
D
Daniel Veillard 已提交
620
    if (IS_EOL(CUR)) {
J
Jim Meyering 已提交
621
        SKIP_BLANKS_AND_EOL;
D
Daniel Veillard 已提交
622
    } else if (CUR == ';') {
623
        NEXT;
J
Jim Meyering 已提交
624
        SKIP_BLANKS_AND_EOL;
D
Daniel Veillard 已提交
625
    } else {
626
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("expecting a separator"));
627
        return -1;
D
Daniel Veillard 已提交
628
    }
629
    return 0;
D
Daniel Veillard 已提交
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
}

/**
 * virConfParseStatement:
 * @ctxt: the parsing context
 *
 * Parse one statement in the conf file
 *
 * Returns 0 in case of success and -1 in case of error
 */
static int
virConfParseStatement(virConfParserCtxtPtr ctxt)
{
    const char *base;
    char *name;
    virConfValuePtr value;
    char *comm = NULL;

J
Jim Meyering 已提交
648
    SKIP_BLANKS_AND_EOL;
649
    if (CUR == '#')
P
Phil Petty 已提交
650
        return virConfParseComment(ctxt);
D
Daniel Veillard 已提交
651 652
    name = virConfParseName(ctxt);
    if (name == NULL)
P
Phil Petty 已提交
653
        return -1;
J
Jim Meyering 已提交
654
    SKIP_BLANKS;
D
Daniel Veillard 已提交
655
    if (CUR != '=') {
656
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("expecting an assignment"));
P
Phil Petty 已提交
657 658
        VIR_FREE(name);
        return -1;
D
Daniel Veillard 已提交
659 660
    }
    NEXT;
J
Jim Meyering 已提交
661
    SKIP_BLANKS;
D
Daniel Veillard 已提交
662 663
    value = virConfParseValue(ctxt);
    if (value == NULL) {
664
        VIR_FREE(name);
P
Phil Petty 已提交
665
        return -1;
D
Daniel Veillard 已提交
666
    }
J
Jim Meyering 已提交
667
    SKIP_BLANKS;
D
Daniel Veillard 已提交
668
    if (CUR == '#') {
669 670 671
        NEXT;
        base = ctxt->cur;
        while ((ctxt->cur < ctxt->end) && (!IS_EOL(CUR))) NEXT;
672
        if (VIR_STRNDUP(comm, base, ctxt->cur - base) < 0) {
673
            VIR_FREE(name);
674
            virConfFreeValue(value);
P
Phil Petty 已提交
675
            return -1;
676
        }
D
Daniel Veillard 已提交
677 678
    }
    if (virConfAddEntry(ctxt->conf, name, value, comm) == NULL) {
679
        VIR_FREE(name);
680
        virConfFreeValue(value);
681
        VIR_FREE(comm);
P
Phil Petty 已提交
682
        return -1;
D
Daniel Veillard 已提交
683
    }
P
Phil Petty 已提交
684
    return 0;
D
Daniel Veillard 已提交
685 686 687 688 689 690 691
}

/**
 * virConfParse:
 * @filename: the name to report errors
 * @content: the configuration content in memory
 * @len: the length in bytes
692
 * @flags: combination of virConfFlag(s)
D
Daniel Veillard 已提交
693 694 695 696
 *
 * Parse the subset of the Python language needed to handle simple
 * Xen configuration files.
 *
E
Eric Blake 已提交
697
 * Returns a handle to lookup settings or NULL if it failed to
D
Daniel Veillard 已提交
698 699 700
 *         read or parse the file, use virConfFree() to free the data.
 */
static virConfPtr
701
virConfParse(const char *filename, const char *content, int len,
702 703
             unsigned int flags)
{
D
Daniel Veillard 已提交
704 705 706 707
    virConfParserCtxt ctxt;

    ctxt.filename = filename;
    ctxt.base = ctxt.cur = content;
708
    ctxt.end = content + len;
D
Daniel Veillard 已提交
709 710
    ctxt.line = 1;

711
    ctxt.conf = virConfCreate(filename, flags);
D
Daniel Veillard 已提交
712
    if (ctxt.conf == NULL)
713
        return NULL;
D
Daniel Veillard 已提交
714 715 716

    while (ctxt.cur < ctxt.end) {
        if (virConfParseStatement(&ctxt) < 0)
717 718 719
            goto error;
        if (virConfParseSeparator(&ctxt) < 0)
            goto error;
D
Daniel Veillard 已提交
720 721
    }

722
    return ctxt.conf;
D
Daniel Veillard 已提交
723

724
 error:
D
Daniel Veillard 已提交
725
    virConfFree(ctxt.conf);
726
    return NULL;
D
Daniel Veillard 已提交
727 728 729
}


730 731 732
/* 10 MB limit on config file size as a sanity check */
#define MAX_CONFIG_FILE_SIZE (1024*1024*10)

D
Daniel Veillard 已提交
733
/**
D
Daniel P. Berrange 已提交
734
 * virConfReadFile:
D
Daniel Veillard 已提交
735
 * @filename: the path to the configuration file.
736
 * @flags: combination of virConfFlag(s)
D
Daniel Veillard 已提交
737 738 739
 *
 * Reads a configuration file.
 *
E
Eric Blake 已提交
740
 * Returns a handle to lookup settings or NULL if it failed to
D
Daniel Veillard 已提交
741 742 743
 *         read or parse the file, use virConfFree() to free the data.
 */
virConfPtr
744
virConfReadFile(const char *filename, unsigned int flags)
D
Daniel Veillard 已提交
745
{
746
    char *content;
D
Daniel Veillard 已提交
747
    int len;
748
    virConfPtr conf;
D
Daniel Veillard 已提交
749

750 751
    VIR_DEBUG("filename=%s", NULLSTR(filename));

D
Daniel Veillard 已提交
752
    if (filename == NULL) {
753
        virConfError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
754
        return NULL;
D
Daniel Veillard 已提交
755
    }
756

757
    if ((len = virFileReadAll(filename, MAX_CONFIG_FILE_SIZE, &content)) < 0)
758 759
        return NULL;

760
    conf = virConfParse(filename, content, len, flags);
761

762
    VIR_FREE(content);
763 764

    return conf;
D
Daniel Veillard 已提交
765 766 767
}

/**
J
Ján Tomko 已提交
768
 * virConfReadString:
D
Daniel Veillard 已提交
769
 * @memory: pointer to the content of the configuration file
770
 * @flags: combination of virConfFlag(s)
D
Daniel Veillard 已提交
771
 *
J
Ján Tomko 已提交
772 773
 * Reads a configuration file loaded in memory. The string must be
 * zero terminated.
D
Daniel Veillard 已提交
774
 *
E
Eric Blake 已提交
775
 * Returns a handle to lookup settings or NULL if it failed to
D
Daniel Veillard 已提交
776 777 778
 *         parse the content, use virConfFree() to free the data.
 */
virConfPtr
J
Ján Tomko 已提交
779
virConfReadString(const char *memory, unsigned int flags)
D
Daniel Veillard 已提交
780
{
J
Ján Tomko 已提交
781 782 783
    size_t len;

    if (memory == NULL) {
784
        virConfError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
785
        return NULL;
D
Daniel Veillard 已提交
786 787
    }

J
Ján Tomko 已提交
788
    len = strlen(memory);
789
    return virConfParse("memory conf", memory, len, flags);
D
Daniel Veillard 已提交
790 791 792
}

/**
D
Daniel P. Berrange 已提交
793
 * virConfFree:
D
Daniel Veillard 已提交
794 795 796 797 798 799 800
 * @conf: a configuration file handle
 *
 * Frees all data associated to the handle
 *
 * Returns 0 in case of success, -1 in case of error.
 */
int
D
Daniel P. Berrange 已提交
801
virConfFree(virConfPtr conf)
D
Daniel Veillard 已提交
802
{
803
    virConfEntryPtr tmp;
804 805
    if (conf == NULL)
        return 0;
806 807 808 809

    tmp = conf->entries;
    while (tmp) {
        virConfEntryPtr next;
810
        VIR_FREE(tmp->name);
811
        virConfFreeValue(tmp->value);
812
        VIR_FREE(tmp->comment);
813
        next = tmp->next;
814
        VIR_FREE(tmp);
815
        tmp = next;
D
Daniel Veillard 已提交
816
    }
817
    VIR_FREE(conf->filename);
818
    VIR_FREE(conf);
819
    return 0;
D
Daniel Veillard 已提交
820 821 822
}

/**
D
Daniel P. Berrange 已提交
823
 * virConfGetValue:
D
Daniel Veillard 已提交
824
 * @conf: a configuration file handle
C
Cao jin 已提交
825
 * @setting: the name of the entry
D
Daniel Veillard 已提交
826 827 828
 *
 * Lookup the value associated to this entry in the configuration file
 *
829
 * Returns a pointer to the value or NULL if the lookup failed, the data
D
Daniel Veillard 已提交
830 831 832
 *         associated will be freed when virConfFree() is called
 */
virConfValuePtr
D
Daniel P. Berrange 已提交
833
virConfGetValue(virConfPtr conf, const char *setting)
D
Daniel Veillard 已提交
834
{
835 836
    virConfEntryPtr cur;

837 838 839
    if (conf == NULL)
        return NULL;

840 841
    cur = conf->entries;
    while (cur != NULL) {
842 843 844 845
        if ((cur->name != NULL) &&
            ((conf->flags & VIR_CONF_FLAG_VMX_FORMAT &&
              STRCASEEQ(cur->name, setting)) ||
             STREQ(cur->name, setting)))
846
            return cur->value;
847 848
        cur = cur->next;
    }
849
    return NULL;
D
Daniel Veillard 已提交
850 851
}

852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 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 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948

/**
 * virConfGetValueType:
 * @conf: the config object
 * @setting: the config entry name
 *
 * Query the type of the configuration entry @setting.
 *
 * Returns: the entry type, or VIR_CONF_NONE if not set.
 */
virConfType virConfGetValueType(virConfPtr conf,
                                const char *setting)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);
    if (!cval)
        return VIR_CONF_NONE;

    return cval->type;
}


/**
 * virConfGetValueString:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold string value
 *
 * Get the string value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type.
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueString(virConfPtr conf,
                          const char *setting,
                          char **value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value string %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

    if (cval->type != VIR_CONF_STRING) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected a string for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

    VIR_FREE(*value);
    if (VIR_STRDUP(*value, cval->str) < 0)
        return -1;

    return 1;
}


/**
 * virConfGetValueStringList:
 * @conf: the config object
 * @setting: the config entry name
 * @compatString: true to treat string entry as a 1 element list
 * @value: pointer to hold NULL terminated string list
 *
 * Get the string list value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified. If @compatString is set to true
 * and the value is present as a string, this will be turned into
 * a 1 element list. The returned @value will be NULL terminated
 * if set.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type.
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueStringList(virConfPtr conf,
                              const char *setting,
                              bool compatString,
                              char ***values)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);
    size_t len;
    virConfValuePtr eval;

    VIR_DEBUG("Get value string list %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

949
    virStringListFree(*values);
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968
    *values = NULL;

    switch (cval->type) {
    case VIR_CONF_LIST:
        /* Calc length and check items */
        for (len = 0, eval = cval->list; eval; len++, eval = eval->next) {
            if (eval->type != VIR_CONF_STRING) {
                virReportError(VIR_ERR_CONF_SYNTAX,
                               _("%s: expected a string list for '%s' parameter"),
                               conf->filename, setting);
                return -1;
            }
        }

        if (VIR_ALLOC_N(*values, len + 1) < 0)
            return -1;

        for (len = 0, eval = cval->list; eval; len++, eval = eval->next) {
            if (VIR_STRDUP((*values)[len], eval->str) < 0) {
969
                virStringListFree(*values);
970 971 972 973 974 975 976 977 978 979 980 981
                *values = NULL;
                return -1;
            }
        }
        break;

    case VIR_CONF_STRING:
        if (compatString) {
            if (VIR_ALLOC_N(*values, cval->str ? 2 : 1) < 0)
                return -1;
            if (cval->str &&
                VIR_STRDUP((*values)[0], cval->str) < 0) {
982
                VIR_FREE(*values);
983 984 985 986
                return -1;
            }
            break;
        }
M
Marc Hartmayer 已提交
987
        ATTRIBUTE_FALLTHROUGH;
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028

    default:
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       compatString ?
                       _("%s: expected a string or string list for '%s' parameter") :
                       _("%s: expected a string list for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

    return 1;
}


/**
 * virConfGetValueBool:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold boolean value
 *
 * Get the boolean value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type, or if the value set is not 1 or 0.
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueBool(virConfPtr conf,
                        const char *setting,
                        bool *value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value bool %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1029
    if (cval->type != VIR_CONF_ULLONG) {
1030 1031 1032 1033 1034 1035
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected a bool for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

1036
    if (((unsigned long long)cval->l) > 1) {
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: value for '%s' parameter must be 0 or 1"),
                       conf->filename, setting);
        return -1;
    }

    *value = cval->l == 1;

    return 1;
}


/**
 * virConfGetValueInt:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold integer value
 *
 * Get the integer value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type, or if the value is outside the
 * range that can be stored in an 'int'
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueInt(virConfPtr conf,
                       const char *setting,
                       int *value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value int %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1077 1078
    if (cval->type != VIR_CONF_LLONG &&
        cval->type != VIR_CONF_ULLONG) {
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected a signed integer for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

    if (cval->l > INT_MAX || cval->l < INT_MIN) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: value for '%s' parameter must be in range %d:%d"),
                       conf->filename, setting, INT_MIN, INT_MAX);
        return -1;
    }

A
Andrea Bolognani 已提交
1092
    *value = (int)cval->l;
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125

    return 1;
}


/**
 * virConfGetValueUInt:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold integer value
 *
 * Get the unsigned integer value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type, or if the value is outside the
 * range that can be stored in an 'unsigned int'
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueUInt(virConfPtr conf,
                        const char *setting,
                        unsigned int *value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value uint %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1126
    if (cval->type != VIR_CONF_ULLONG) {
1127 1128 1129 1130 1131 1132
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected an unsigned integer for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

1133
    if (((unsigned long long)cval->l) > UINT_MAX) {
1134 1135 1136 1137 1138 1139
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: value for '%s' parameter must be in range 0:%u"),
                       conf->filename, setting, UINT_MAX);
        return -1;
    }

A
Andrea Bolognani 已提交
1140
    *value = (unsigned int)cval->l;
1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173

    return 1;
}


/**
 * virConfGetValueSizeT:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold integer value
 *
 * Get the integer value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type, or if the value is outside the
 * range that can be stored in a 'size_t'
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueSizeT(virConfPtr conf,
                         const char *setting,
                         size_t *value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value size_t %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1174
    if (cval->type != VIR_CONF_ULLONG) {
1175 1176 1177 1178 1179 1180
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected an unsigned integer for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

1181 1182 1183 1184 1185 1186 1187 1188 1189
#if ULLONG_MAX > SIZE_MAX
    if (((unsigned long long)cval->l) > SIZE_MAX) {
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: value for '%s' parameter must be in range 0:%zu"),
                       conf->filename, setting, SIZE_MAX);
        return -1;
    }
#endif

1190
    *value = (size_t)cval->l;
1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223

    return 1;
}


/**
 * virConfGetValueSSizeT:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold integer value
 *
 * Get the integer value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type, or if the value is outside the
 * range that can be stored in an 'ssize_t'
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueSSizeT(virConfPtr conf,
                          const char *setting,
                          ssize_t *value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value ssize_t %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1224
    if (cval->type == VIR_CONF_ULLONG) {
1225 1226 1227 1228 1229 1230
        if (((unsigned long long)cval->l) > SSIZE_MAX) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("%s: value for '%s' parameter must be in range %zd:%zd"),
                           conf->filename, setting, (ssize_t)-SSIZE_MAX - 1, (ssize_t)SSIZE_MAX);
            return -1;
        }
1231
    } else if (cval->type == VIR_CONF_LLONG) {
1232
#if SSIZE_MAX < LLONG_MAX
1233 1234 1235 1236 1237 1238
        if (cval->l < (-SSIZE_MAX - 1) || cval->l > SSIZE_MAX) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
                           _("%s: value for '%s' parameter must be in range %zd:%zd"),
                           conf->filename, setting, (ssize_t)-SSIZE_MAX - 1, (ssize_t)SSIZE_MAX);
            return -1;
        }
1239
#endif
1240
    } else {
1241 1242 1243 1244 1245 1246
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected a signed integer for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

1247
    *value = (ssize_t)cval->l;
1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269

    return 1;
}


/**
 * virConfGetValueLLong:
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold integer value
 *
 * Get the integer value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type, or if the value is outside the
 * range that can be stored in an 'long long'
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueLLong(virConfPtr conf,
1270 1271
                         const char *setting,
                         long long *value)
1272 1273 1274 1275 1276 1277 1278 1279 1280
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value long long %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1281
    if (cval->type == VIR_CONF_ULLONG) {
1282 1283
        if (((unsigned long long)cval->l) > LLONG_MAX) {
            virReportError(VIR_ERR_INTERNAL_ERROR,
1284 1285
                           _("%s: value for '%s' parameter must be in range %lld:%lld"),
                           conf->filename, setting, LLONG_MIN, LLONG_MAX);
1286 1287
            return -1;
        }
1288
    } else if (cval->type != VIR_CONF_LLONG) {
1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected a signed integer for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

    *value = cval->l;

    return 1;
}


/**
1302
 * virConfGetValueULLong:
1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327
 * @conf: the config object
 * @setting: the config entry name
 * @value: pointer to hold integer value
 *
 * Get the integer value of the config name @setting, storing
 * it in @value. If the config entry is not present, then
 * @value will be unmodified.
 *
 * Reports an error if the config entry is set but has
 * an unexpected type.
 *
 * Returns: 1 if the value was present, 0 if missing, -1 on error
 */
int virConfGetValueULLong(virConfPtr conf,
                          const char *setting,
                          unsigned long long *value)
{
    virConfValuePtr cval = virConfGetValue(conf, setting);

    VIR_DEBUG("Get value unsigned long long %p %d",
              cval, cval ? cval->type : VIR_CONF_NONE);

    if (!cval)
        return 0;

1328
    if (cval->type != VIR_CONF_ULLONG) {
1329 1330 1331 1332 1333 1334
        virReportError(VIR_ERR_INTERNAL_ERROR,
                       _("%s: expected an unsigned integer for '%s' parameter"),
                       conf->filename, setting);
        return -1;
    }

1335
    *value = (unsigned long long)cval->l;
1336 1337 1338 1339

    return 1;
}

1340
/**
D
Daniel P. Berrange 已提交
1341
 * virConfSetValue:
1342
 * @conf: a configuration file handle
C
Cao jin 已提交
1343
 * @setting: the name of the entry
1344 1345 1346 1347 1348 1349 1350 1351 1352
 * @value: the new configuration value
 *
 * Set (or replace) the value associated to this entry in the configuration
 * file. The passed in 'value' will be owned by the conf object upon return
 * of this method, even in case of error. It should not be referenced again
 * by the caller.
 *
 * Returns 0 on success, or -1 on failure.
 */
1353
int
1354 1355 1356
virConfSetValue(virConfPtr conf,
                const char *setting,
                virConfValuePtr value)
1357
{
1358 1359
    virConfEntryPtr cur, prev = NULL;

1360 1361
    if (value && value->type == VIR_CONF_STRING && value->str == NULL) {
        virConfFreeValue(value);
1362
        return -1;
1363
    }
1364

1365 1366
    cur = conf->entries;
    while (cur != NULL) {
1367
        if (STREQ_NULLABLE(cur->name, setting))
1368 1369 1370 1371
            break;
        prev = cur;
        cur = cur->next;
    }
1372

1373
    if (!cur) {
1374
        if (VIR_ALLOC(cur) < 0) {
1375
            virConfFreeValue(value);
1376
            return -1;
1377 1378
        }
        cur->comment = NULL;
1379
        if (VIR_STRDUP(cur->name, setting) < 0) {
1380
            virConfFreeValue(value);
1381
            VIR_FREE(cur);
1382
            return -1;
1383 1384 1385
        }
        cur->value = value;
        if (prev) {
1386
            cur->next = prev->next;
1387 1388
            prev->next = cur;
        } else {
1389
            cur->next = conf->entries;
1390 1391 1392
            conf->entries = cur;
        }
    } else {
1393
        virConfFreeValue(cur->value);
1394 1395
        cur->value = value;
    }
1396
    return 0;
1397 1398
}

1399 1400 1401 1402
/**
 * virConfWalk:
 * @conf: a configuration file handle
 * @callback: the function to call to process each entry
C
Cao jin 已提交
1403
 * @opaque: obscure data passed to callback
1404 1405 1406 1407 1408 1409 1410
 *
 * Walk over all entries of the configuration file and run the callback
 * for each with entry name, value and the obscure data.
 *
 * Returns 0 on success, or -1 on failure.
 */
int virConfWalk(virConfPtr conf,
C
Cao jin 已提交
1411 1412
                virConfWalkCallback callback,
                void *opaque)
1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427
{
    virConfEntryPtr cur;

    if (!conf)
        return 0;

    cur = conf->entries;
    while (cur != NULL) {
        if (cur->name && cur->value &&
                callback(cur->name, cur->value, opaque) < 0)
            return -1;
        cur = cur->next;
    }
    return 0;
}
1428

D
Daniel Veillard 已提交
1429
/**
D
Daniel P. Berrange 已提交
1430
 * virConfWriteFile:
D
Daniel Veillard 已提交
1431 1432 1433 1434 1435 1436 1437 1438
 * @filename: the path to the configuration file.
 * @conf: the conf
 *
 * Writes a configuration file back to a file.
 *
 * Returns the number of bytes written or -1 in case of error.
 */
int
D
Daniel P. Berrange 已提交
1439
virConfWriteFile(const char *filename, virConfPtr conf)
D
Daniel Veillard 已提交
1440
{
1441
    virBuffer buf = VIR_BUFFER_INITIALIZER;
D
Daniel Veillard 已提交
1442 1443 1444
    virConfEntryPtr cur;
    int ret;
    int fd;
1445 1446
    char *content;
    unsigned int use;
D
Daniel Veillard 已提交
1447 1448

    if (conf == NULL)
1449
        return -1;
D
Daniel Veillard 已提交
1450 1451 1452

    cur = conf->entries;
    while (cur != NULL) {
1453
        virConfSaveEntry(&buf, cur);
1454
        cur = cur->next;
D
Daniel Veillard 已提交
1455
    }
1456

1457
    if (virBufferCheckError(&buf) < 0)
1458 1459
        return -1;

1460
    fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR);
D
Daniel Veillard 已提交
1461
    if (fd < 0) {
1462
        virBufferFreeAndReset(&buf);
1463
        virConfError(NULL, VIR_ERR_WRITE_FAILED, _("failed to open file"));
1464
        return -1;
D
Daniel Veillard 已提交
1465 1466
    }

1467 1468 1469
    use = virBufferUse(&buf);
    content = virBufferContentAndReset(&buf);
    ret = safewrite(fd, content, use);
1470
    VIR_FREE(content);
1471
    VIR_FORCE_CLOSE(fd);
1472
    if (ret != (int)use) {
1473
        virConfError(NULL, VIR_ERR_WRITE_FAILED, _("failed to save content"));
1474
        return -1;
D
Daniel Veillard 已提交
1475
    }
1476 1477

    return ret;
D
Daniel Veillard 已提交
1478 1479 1480
}

/**
D
Daniel P. Berrange 已提交
1481
 * virConfWriteMem:
D
Daniel Veillard 已提交
1482
 * @memory: pointer to the memory to store the config file
1483
 * @len: pointer to the length in bytes of the store, on output the size
D
Daniel Veillard 已提交
1484 1485 1486 1487 1488 1489 1490 1491 1492 1493
 * @conf: the conf
 *
 * Writes a configuration file back to a memory area. @len is an IN/OUT
 * parameter, it indicates the size available in bytes, and on output the
 * size required for the configuration file (even if the call fails due to
 * insufficient space).
 *
 * Returns the number of bytes written or -1 in case of error.
 */
int
D
Daniel P. Berrange 已提交
1494
virConfWriteMem(char *memory, int *len, virConfPtr conf)
D
Daniel Veillard 已提交
1495
{
1496
    virBuffer buf = VIR_BUFFER_INITIALIZER;
D
Daniel Veillard 已提交
1497
    virConfEntryPtr cur;
1498 1499
    char *content;
    unsigned int use;
D
Daniel Veillard 已提交
1500 1501

    if ((memory == NULL) || (len == NULL) || (*len <= 0) || (conf == NULL))
1502
        return -1;
D
Daniel Veillard 已提交
1503 1504 1505

    cur = conf->entries;
    while (cur != NULL) {
1506
        virConfSaveEntry(&buf, cur);
1507
        cur = cur->next;
D
Daniel Veillard 已提交
1508
    }
1509

1510
    if (virBufferCheckError(&buf) < 0)
1511 1512 1513 1514 1515 1516 1517
        return -1;

    use = virBufferUse(&buf);
    content = virBufferContentAndReset(&buf);

    if ((int)use >= *len) {
        *len = (int)use;
1518
        VIR_FREE(content);
1519 1520 1521
        return -1;
    }
    memcpy(memory, content, use);
1522
    VIR_FREE(content);
1523 1524
    *len = use;
    return use;
D
Daniel Veillard 已提交
1525
}
1526 1527 1528 1529 1530 1531

static char *
virConfLoadConfigPath(const char *name)
{
    char *path;
    if (geteuid() == 0) {
1532 1533
        if (virAsprintf(&path, "%s/libvirt/%s",
                        SYSCONFDIR, name) < 0)
1534 1535 1536 1537 1538 1539
            return NULL;
    } else {
        char *userdir = virGetUserConfigDirectory();
        if (!userdir)
            return NULL;

1540 1541
        if (virAsprintf(&path, "%s/%s",
                        userdir, name) < 0) {
1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576
            VIR_FREE(userdir);
            return NULL;
        }
        VIR_FREE(userdir);
    }

    return path;
}

int
virConfLoadConfig(virConfPtr *conf, const char *name)
{
    char *path = NULL;
    int ret = -1;

    *conf = NULL;

    if (!(path = virConfLoadConfigPath(name)))
        goto cleanup;

    if (!virFileExists(path)) {
        ret = 0;
        goto cleanup;
    }

    VIR_DEBUG("Loading config file '%s'", path);
    if (!(*conf = virConfReadFile(path, 0)))
        goto cleanup;

    ret = 0;

 cleanup:
    VIR_FREE(path);
    return ret;
}