LXR qemu/include/qemu/option.h

   1/*
   2 * Commandline option parsing functions
   3 *
   4 * Copyright (c) 2003-2008 Fabrice Bellard
   5 * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com>
   6 *
   7 * Permission is hereby granted, free of charge, to any person obtaining a copy
   8 * of this software and associated documentation files (the "Software"), to deal
   9 * in the Software without restriction, including without limitation the rights
  10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11 * copies of the Software, and to permit persons to whom the Software is
  12 * furnished to do so, subject to the following conditions:
  13 *
  14 * The above copyright notice and this permission notice shall be included in
  15 * all copies or substantial portions of the Software.
  16 *
  17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23 * THE SOFTWARE.
  24 */
  25
  26#ifndef QEMU_OPTION_H
  27#define QEMU_OPTION_H
  28
  29#include "qemu/queue.h"
  30
  31const char *get_opt_name(char *buf, int buf_size, const char *p, char delim);
  32const char *get_opt_value(char *buf, int buf_size, const char *p);
  33
  34void parse_option_size(const char *name, const char *value,
  35                       uint64_t *ret, Error **errp);
  36bool has_help_option(const char *param);
  37bool is_valid_option_list(const char *param);
  38
  39enum QemuOptType {
  40    QEMU_OPT_STRING = 0,  /* no parsing (use string as-is)                        */
  41    QEMU_OPT_BOOL,        /* on/off                                               */
  42    QEMU_OPT_NUMBER,      /* simple number                                        */
  43    QEMU_OPT_SIZE,        /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */
  44};
  45
  46typedef struct QemuOptDesc {
  47    const char *name;
  48    enum QemuOptType type;
  49    const char *help;
  50    const char *def_value_str;
  51} QemuOptDesc;
  52
  53struct QemuOptsList {
  54    const char *name;
  55    const char *implied_opt_name;
  56    bool merge_lists;  /* Merge multiple uses of option into a single list? */
  57    QTAILQ_HEAD(, QemuOpts) head;
  58    QemuOptDesc desc[];
  59};
  60
  61const char *qemu_opt_get(QemuOpts *opts, const char *name);
  62char *qemu_opt_get_del(QemuOpts *opts, const char *name);
  63/**
  64 * qemu_opt_has_help_opt:
  65 * @opts: options to search for a help request
  66 *
  67 * Check whether the options specified by @opts include one of the
  68 * standard strings which indicate that the user is asking for a
  69 * list of the valid values for a command line option (as defined
  70 * by is_help_option()).
  71 *
  72 * Returns: true if @opts includes 'help' or equivalent.
  73 */
  74bool qemu_opt_has_help_opt(QemuOpts *opts);
  75QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name);
  76bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval);
  77uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval);
  78uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval);
  79bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval);
  80uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name,
  81                                 uint64_t defval);
  82uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name,
  83                               uint64_t defval);
  84int qemu_opt_unset(QemuOpts *opts, const char *name);
  85void qemu_opt_set(QemuOpts *opts, const char *name, const char *value,
  86                  Error **errp);
  87void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
  88                       Error **errp);
  89void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
  90                         Error **errp);
  91typedef int (*qemu_opt_loopfunc)(void *opaque,
  92                                 const char *name, const char *value,
  93                                 Error **errp);
  94int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
  95                     Error **errp);
  96
  97typedef struct {
  98    QemuOpts *opts;
  99    QemuOpt *opt;
 100    const char *name;
 101} QemuOptsIter;
 102
 103void qemu_opt_iter_init(QemuOptsIter *iter, QemuOpts *opts, const char *name);
 104const char *qemu_opt_iter_next(QemuOptsIter *iter);
 105
 106QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id);
 107QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
 108                           int fail_if_exists, Error **errp);
 109void qemu_opts_reset(QemuOptsList *list);
 110void qemu_opts_loc_restore(QemuOpts *opts);
 111void qemu_opts_set(QemuOptsList *list, const char *id,
 112                   const char *name, const char *value, Error **errp);
 113const char *qemu_opts_id(QemuOpts *opts);
 114void qemu_opts_set_id(QemuOpts *opts, char *id);
 115void qemu_opts_del(QemuOpts *opts);
 116void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp);
 117void qemu_opts_do_parse(QemuOpts *opts, const char *params,
 118                        const char *firstname, Error **errp);
 119QemuOpts *qemu_opts_parse_noisily(QemuOptsList *list, const char *params,
 120                                  bool permit_abbrev);
 121QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params,
 122                          bool permit_abbrev, Error **errp);
 123void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
 124                            int permit_abbrev);
 125QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
 126                               Error **errp);
 127QDict *qemu_opts_to_qdict_filtered(QemuOpts *opts, QDict *qdict,
 128                                   QemuOptsList *list, bool del);
 129QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict);
 130void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp);
 131
 132typedef int (*qemu_opts_loopfunc)(void *opaque, QemuOpts *opts, Error **errp);
 133int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func,
 134                      void *opaque, Error **errp);
 135void qemu_opts_print(QemuOpts *opts, const char *sep);
 136void qemu_opts_print_help(QemuOptsList *list);
 137void qemu_opts_free(QemuOptsList *list);
 138QemuOptsList *qemu_opts_append(QemuOptsList *dst, QemuOptsList *list);
 139
 140QDict *keyval_parse(const char *params, const char *implied_key,
 141                    Error **errp);
 142
 143#endif
 144