conf.c 25.1 KB
Newer Older
D
Daniel Veillard 已提交
1 2 3
/**
 * conf.c: parser for a subset of the Python encoded Xen configuration files
 *
P
Phil Petty 已提交
4
 * Copyright (C) 2006-2011 Red Hat, Inc.
D
Daniel Veillard 已提交
5 6 7 8 9 10
 *
 * See COPYING.LIB for the License of this software
 *
 * Daniel Veillard <veillard@redhat.com>
 */

11
#include <config.h>
12

D
Daniel Veillard 已提交
13 14 15 16 17 18 19 20
#include <string.h>

#include <stdio.h>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

21
#include "virterror_internal.h"
22
#include "buf.h"
D
Daniel Veillard 已提交
23
#include "conf.h"
24
#include "util.h"
J
Jim Meyering 已提交
25
#include "c-ctype.h"
26
#include "memory.h"
E
Eric Blake 已提交
27
#include "virfile.h"
D
Daniel Veillard 已提交
28

29 30
#define VIR_FROM_THIS VIR_FROM_CONF

D
Daniel Veillard 已提交
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/************************************************************************
 *									*
 *	Structures and macros used by the mini parser			*
 *									*
 ************************************************************************/

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 已提交
53 54 55 56 57 58 59 60

#define SKIP_BLANKS_AND_EOL                                             \
  do { while ((ctxt->cur < ctxt->end) && (c_isblank(CUR) || IS_EOL(CUR))) { \
         if (CUR == '\n') ctxt->line++;	                                \
         ctxt->cur++;}} while (0)
#define SKIP_BLANKS                                                     \
  do { while ((ctxt->cur < ctxt->end) && (c_isblank(CUR)))              \
          ctxt->cur++; } while (0)
D
Daniel Veillard 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79

/************************************************************************
 *									*
 *		Structures used by configuration data			*
 *									*
 ************************************************************************/

typedef struct _virConfEntry virConfEntry;
typedef virConfEntry *virConfEntryPtr;

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

struct _virConf {
    const char* filename;
80
    unsigned int flags;
D
Daniel Veillard 已提交
81 82 83 84 85
    virConfEntryPtr entries;
};

/**
 * virConfError:
86
 * @ctxt: the parser context if available or NULL
D
Daniel Veillard 已提交
87 88 89 90 91 92
 * @error: the error number
 * @info: extra information string
 *
 * Handle an error at the xend daemon interface
 */
static void
93 94
virConfError(virConfParserCtxtPtr ctxt,
             virErrorNumber error, const char *info)
D
Daniel Veillard 已提交
95
{
96
    const char *format;
D
Daniel Veillard 已提交
97 98 99 100

    if (error == VIR_ERR_OK)
        return;

101 102
    /* Construct the string 'filename:line: info' if we have that. */
    if (ctxt && ctxt->filename) {
103
        virRaiseError(NULL, NULL, VIR_FROM_CONF, error, VIR_ERR_ERROR,
104 105 106 107
                        info, ctxt->filename, NULL,
                        ctxt->line, 0,
                        "%s:%d: %s", ctxt->filename, ctxt->line, info);
    } else {
108
        format = virErrorMsg(error, info);
109
        virRaiseError(NULL, NULL, VIR_FROM_CONF, error, VIR_ERR_ERROR,
110 111 112 113
                        info, NULL, NULL,
                        ctxt ? ctxt->line : 0, 0,
                        format, info);
    }
D
Daniel Veillard 已提交
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
}


/************************************************************************
 *									*
 *		Structures allocations and deallocations		*
 *									*
 ************************************************************************/

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

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

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

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

167
    if (VIR_ALLOC(ret) < 0) {
168
        virReportOOMError();
D
Daniel Veillard 已提交
169 170
        return(NULL);
    }
171
    ret->filename = NULL;
172
    ret->flags = 0;
173 174 175

    return(ret);
}
D
Daniel Veillard 已提交
176

177 178 179
/**
 * virConfCreate:
 * @filename: the name to report errors
180
 * @flags: combination of virConfFlag(s)
181 182 183 184 185 186
 *
 * Create a configuration internal structure
 *
 * Returns a pointer or NULL in case of error.
 */
static virConfPtr
187
virConfCreate(const char *filename, unsigned int flags)
188 189
{
    virConfPtr ret = virConfNew();
190
    if (ret) {
191
        ret->filename = filename;
192 193
        ret->flags = flags;
    }
D
Daniel Veillard 已提交
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
    return(ret);
}

/**
 * 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)
        return(NULL);
    if ((comm == NULL) && (name == NULL))
        return(NULL);
218

219
    if (VIR_ALLOC(ret) < 0) {
220
        virReportOOMError();
D
Daniel Veillard 已提交
221 222
        return(NULL);
    }
223

D
Daniel Veillard 已提交
224 225 226 227 228 229 230 231
    ret->name = name;
    ret->value = value;
    ret->comment = comm;

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

/************************************************************************
 *									*
 *			Serialization					*
 *									*
 ************************************************************************/

/**
 * 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)
        return(-1);
    switch (val->type) {
        case VIR_CONF_NONE:
261 262
            return(-1);
        case VIR_CONF_LONG:
263
            virBufferAsprintf(buf, "%ld", val->l);
264 265 266
            break;
        case VIR_CONF_STRING:
            if (strchr(val->str, '\n') != NULL) {
267
                virBufferAsprintf(buf, "\"\"\"%s\"\"\"", val->str);
268
            } else if (strchr(val->str, '"') == NULL) {
269
                virBufferAsprintf(buf, "\"%s\"", val->str);
270
            } else if (strchr(val->str, '\'') == NULL) {
271
                virBufferAsprintf(buf, "'%s'", val->str);
272
            } else {
273
                virBufferAsprintf(buf, "\"\"\"%s\"\"\"", val->str);
274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294
            }
            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:
            return(-1);
D
Daniel Veillard 已提交
295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
    }
    return(0);
}

/**
 * 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);
313 314 315 316 317 318
        virBufferAddLit(buf, " = ");
        virConfSaveValue(buf, cur->value);
        if (cur->comment != NULL) {
            virBufferAddLit(buf, " #");
            virBufferAdd(buf, cur->comment, -1);
        }
D
Daniel Veillard 已提交
319
    } else if (cur->comment != NULL) {
320 321
        virBufferAddLit(buf, "#");
        virBufferAdd(buf, cur->comment, -1);
D
Daniel Veillard 已提交
322
    }
323
    virBufferAddLit(buf, "\n");
D
Daniel Veillard 已提交
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349
    return(0);
}

/************************************************************************
 *									*
 *			The parser core					*
 *									*
 ************************************************************************/

/**
 * 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
virConfParseLong(virConfParserCtxtPtr ctxt, long *val)
{
    long l = 0;
    int neg = 0;

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

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

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

        if (!STRPREFIX(ctxt->cur, "\"\"\"")) {
412
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("unterminated string"));
413 414 415
            return(NULL);
        }
        ret = strndup(base, ctxt->cur - base);
416
        if (ret == NULL) {
417
            virReportOOMError();
418 419
            return NULL;
        }
420
        ctxt->cur += 3;
D
Daniel Veillard 已提交
421 422
    } else if (CUR == '"') {
        NEXT;
423 424 425 426
        base = ctxt->cur;
        while ((ctxt->cur < ctxt->end) && (CUR != '"') && (!IS_EOL(CUR)))
            NEXT;
        if (CUR != '"') {
427
            virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("unterminated string"));
428 429 430
            return(NULL);
        }
        ret = strndup(base, ctxt->cur - base);
431
        if (ret == NULL) {
432
            virReportOOMError();
433 434
            return NULL;
        }
435
        NEXT;
D
Daniel Veillard 已提交
436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
    }
    return(ret);
}

/**
 * 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;
    long  l = 0;

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

            /* 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.  */
            sa_assert (lst);

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

/**
 * 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
             ((CUR == ':') || (CUR == '.') || (CUR == '-')))))
D
Daniel Veillard 已提交
570 571 572
        NEXT;
    ret = strndup(base, ctxt->cur - base);
    if (ret == NULL) {
573
        virReportOOMError();
D
Daniel Veillard 已提交
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
        return(NULL);
    }
    return(ret);
}

/**
 * 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 != '#')
        return(-1);
    NEXT;
    base = ctxt->cur;
    while ((ctxt->cur < ctxt->end) && (!IS_EOL(CUR))) NEXT;
    comm = strndup(base, ctxt->cur - base);
    if (comm == NULL) {
600
        virReportOOMError();
D
Daniel Veillard 已提交
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617
        return(-1);
    }
    virConfAddEntry(ctxt->conf, NULL, NULL, comm);
    return(0);
}

/**
 * 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 已提交
618
    SKIP_BLANKS;
D
Daniel Veillard 已提交
619
    if (ctxt->cur >= ctxt->end)
620
        return(0);
D
Daniel Veillard 已提交
621
    if (IS_EOL(CUR)) {
J
Jim Meyering 已提交
622
        SKIP_BLANKS_AND_EOL;
D
Daniel Veillard 已提交
623
    } else if (CUR == ';') {
624
        NEXT;
J
Jim Meyering 已提交
625
        SKIP_BLANKS_AND_EOL;
D
Daniel Veillard 已提交
626
    } else {
627
        virConfError(ctxt, VIR_ERR_CONF_SYNTAX, _("expecting a separator"));
628
        return(-1);
D
Daniel Veillard 已提交
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648
    }
    return(0);
}

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

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

    ctxt.filename = filename;
    ctxt.base = ctxt.cur = content;
    ctxt.end = content + len - 1;
    ctxt.line = 1;

714
    ctxt.conf = virConfCreate(filename, flags);
D
Daniel Veillard 已提交
715 716 717 718 719
    if (ctxt.conf == NULL)
        return(NULL);

    while (ctxt.cur < ctxt.end) {
        if (virConfParseStatement(&ctxt) < 0)
720 721 722
            goto error;
        if (virConfParseSeparator(&ctxt) < 0)
            goto error;
D
Daniel Veillard 已提交
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
    }

    return(ctxt.conf);

error:
    virConfFree(ctxt.conf);
    return(NULL);
}

/************************************************************************
 *									*
 *			The module entry points				*
 *									*
 ************************************************************************/

738 739 740
/* 10 MB limit on config file size as a sanity check */
#define MAX_CONFIG_FILE_SIZE (1024*1024*10)

D
Daniel Veillard 已提交
741
/**
D
Daniel P. Berrange 已提交
742
 * virConfReadFile:
D
Daniel Veillard 已提交
743
 * @filename: the path to the configuration file.
744
 * @flags: combination of virConfFlag(s)
D
Daniel Veillard 已提交
745 746 747 748 749 750 751
 *
 * Reads a configuration file.
 *
 * Returns an handle to lookup settings or NULL if it failed to
 *         read or parse the file, use virConfFree() to free the data.
 */
virConfPtr
752
virConfReadFile(const char *filename, unsigned int flags)
D
Daniel Veillard 已提交
753
{
754
    char *content;
D
Daniel Veillard 已提交
755
    int len;
756
    virConfPtr conf;
D
Daniel Veillard 已提交
757 758

    if (filename == NULL) {
759
        virConfError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
760 761
        return(NULL);
    }
762 763 764

    if ((len = virFileReadAll(filename, MAX_CONFIG_FILE_SIZE, &content)) < 0) {
        return NULL;
D
Daniel Veillard 已提交
765
    }
766

767
    conf = virConfParse(filename, content, len, flags);
768

769
    VIR_FREE(content);
770 771

    return conf;
D
Daniel Veillard 已提交
772 773 774
}

/**
D
Daniel P. Berrange 已提交
775
 * virConfReadMem:
D
Daniel Veillard 已提交
776
 * @memory: pointer to the content of the configuration file
D
Daniel Veillard 已提交
777
 * @len: length in byte
778
 * @flags: combination of virConfFlag(s)
D
Daniel Veillard 已提交
779 780 781 782 783 784 785 786
 *
 * Reads a configuration file loaded in memory. The string can be
 * zero terminated in which case @len can be 0
 *
 * Returns an handle to lookup settings or NULL if it failed to
 *         parse the content, use virConfFree() to free the data.
 */
virConfPtr
787
virConfReadMem(const char *memory, int len, unsigned int flags)
D
Daniel Veillard 已提交
788 789
{
    if ((memory == NULL) || (len < 0)) {
790
        virConfError(NULL, VIR_ERR_INVALID_ARG, __FUNCTION__);
D
Daniel Veillard 已提交
791 792 793 794 795
        return(NULL);
    }
    if (len == 0)
        len = strlen(memory);

796
    return(virConfParse("memory conf", memory, len, flags));
D
Daniel Veillard 已提交
797 798 799
}

/**
D
Daniel P. Berrange 已提交
800
 * virConfFree:
D
Daniel Veillard 已提交
801 802 803 804 805 806 807
 * @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 已提交
808
virConfFree(virConfPtr conf)
D
Daniel Veillard 已提交
809
{
810
    virConfEntryPtr tmp;
811 812
    if (conf == NULL)
        return 0;
813 814 815 816

    tmp = conf->entries;
    while (tmp) {
        virConfEntryPtr next;
817
        VIR_FREE(tmp->name);
818
        virConfFreeValue(tmp->value);
819
        VIR_FREE(tmp->comment);
820
        next = tmp->next;
821
        VIR_FREE(tmp);
822
        tmp = next;
D
Daniel Veillard 已提交
823
    }
824
    VIR_FREE(conf);
D
Daniel Veillard 已提交
825 826 827 828
    return(0);
}

/**
D
Daniel P. Berrange 已提交
829
 * virConfGetValue:
D
Daniel Veillard 已提交
830 831 832 833 834
 * @conf: a configuration file handle
 * @entry: the name of the entry
 *
 * Lookup the value associated to this entry in the configuration file
 *
835
 * Returns a pointer to the value or NULL if the lookup failed, the data
D
Daniel Veillard 已提交
836 837 838
 *         associated will be freed when virConfFree() is called
 */
virConfValuePtr
D
Daniel P. Berrange 已提交
839
virConfGetValue(virConfPtr conf, const char *setting)
D
Daniel Veillard 已提交
840
{
841 842 843 844
    virConfEntryPtr cur;

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

855
/**
D
Daniel P. Berrange 已提交
856
 * virConfSetValue:
857 858 859 860 861 862 863 864 865 866 867
 * @conf: a configuration file handle
 * @entry: the name of the entry
 * @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.
 */
868
int
D
Daniel P. Berrange 已提交
869 870 871
virConfSetValue (virConfPtr conf,
                 const char *setting,
                 virConfValuePtr value)
872
{
873 874
    virConfEntryPtr cur, prev = NULL;

875 876 877
    if (value && value->type == VIR_CONF_STRING && value->str == NULL)
        return -1;

878 879
    cur = conf->entries;
    while (cur != NULL) {
880
        if ((cur->name != NULL) && (STREQ(cur->name, setting))) {
881 882 883 884 885
            break;
        }
        prev = cur;
        cur = cur->next;
    }
886

887
    if (!cur) {
888
        if (VIR_ALLOC(cur) < 0) {
889
            virReportOOMError();
890 891 892 893 894
            virConfFreeValue(value);
            return (-1);
        }
        cur->comment = NULL;
        if (!(cur->name = strdup(setting))) {
895
            virReportOOMError();
896
            virConfFreeValue(value);
897
            VIR_FREE(cur);
898 899 900 901
            return (-1);
        }
        cur->value = value;
        if (prev) {
902
            cur->next = prev->next;
903 904
            prev->next = cur;
        } else {
905
            cur->next = conf->entries;
906 907 908
            conf->entries = cur;
        }
    } else {
909
        virConfFreeValue(cur->value);
910 911 912 913 914 915
        cur->value = value;
    }
    return (0);
}


D
Daniel Veillard 已提交
916
/**
D
Daniel P. Berrange 已提交
917
 * virConfWriteFile:
D
Daniel Veillard 已提交
918 919 920 921 922 923 924 925
 * @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 已提交
926
virConfWriteFile(const char *filename, virConfPtr conf)
D
Daniel Veillard 已提交
927
{
928
    virBuffer buf = VIR_BUFFER_INITIALIZER;
D
Daniel Veillard 已提交
929 930 931
    virConfEntryPtr cur;
    int ret;
    int fd;
932 933
    char *content;
    unsigned int use;
D
Daniel Veillard 已提交
934 935 936 937 938 939

    if (conf == NULL)
        return(-1);

    cur = conf->entries;
    while (cur != NULL) {
940
        virConfSaveEntry(&buf, cur);
941
        cur = cur->next;
D
Daniel Veillard 已提交
942
    }
943

944
    if (virBufferError(&buf)) {
945
        virBufferFreeAndReset(&buf);
946
        virReportOOMError();
947 948 949
        return -1;
    }

D
Daniel Veillard 已提交
950 951
    fd = open(filename, O_WRONLY | O_CREAT | O_TRUNC, S_IRUSR | S_IWUSR );
    if (fd < 0) {
952
        virBufferFreeAndReset(&buf);
953
        virConfError(NULL, VIR_ERR_WRITE_FAILED, _("failed to open file"));
954
        return -1;
D
Daniel Veillard 已提交
955 956
    }

957 958 959
    use = virBufferUse(&buf);
    content = virBufferContentAndReset(&buf);
    ret = safewrite(fd, content, use);
960
    VIR_FREE(content);
961
    VIR_FORCE_CLOSE(fd);
962
    if (ret != (int)use) {
963
        virConfError(NULL, VIR_ERR_WRITE_FAILED, _("failed to save content"));
964
        return -1;
D
Daniel Veillard 已提交
965
    }
966 967

    return ret;
D
Daniel Veillard 已提交
968 969 970
}

/**
D
Daniel P. Berrange 已提交
971
 * virConfWriteMem:
D
Daniel Veillard 已提交
972
 * @memory: pointer to the memory to store the config file
973
 * @len: pointer to the length in bytes of the store, on output the size
D
Daniel Veillard 已提交
974 975 976 977 978 979 980 981 982 983
 * @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 已提交
984
virConfWriteMem(char *memory, int *len, virConfPtr conf)
D
Daniel Veillard 已提交
985
{
986
    virBuffer buf = VIR_BUFFER_INITIALIZER;
D
Daniel Veillard 已提交
987
    virConfEntryPtr cur;
988 989
    char *content;
    unsigned int use;
D
Daniel Veillard 已提交
990 991 992 993 994 995

    if ((memory == NULL) || (len == NULL) || (*len <= 0) || (conf == NULL))
        return(-1);

    cur = conf->entries;
    while (cur != NULL) {
996
        virConfSaveEntry(&buf, cur);
997
        cur = cur->next;
D
Daniel Veillard 已提交
998
    }
999

1000
    if (virBufferError(&buf)) {
1001
        virBufferFreeAndReset(&buf);
1002
        virReportOOMError();
1003
        return -1;
D
Daniel Veillard 已提交
1004
    }
1005 1006 1007 1008 1009 1010

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

    if ((int)use >= *len) {
        *len = (int)use;
1011
        VIR_FREE(content);
1012 1013 1014
        return -1;
    }
    memcpy(memory, content, use);
1015
    VIR_FREE(content);
1016 1017
    *len = use;
    return use;
D
Daniel Veillard 已提交
1018
}