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
  31/**
  32 * get_opt_value
  33 * @p: a pointer to the option name, delimited by commas
  34 * @value: a non-NULL pointer that will received the delimited options
  35 *
  36 * The @value char pointer will be allocated and filled with
  37 * the delimited options.
  38 *
  39 * Returns the position of the comma delimiter/zero byte after the
  40 * option name in @p.
  41 * The memory pointer in @value must be released with a call to g_free()
  42 * when no longer required.
  43 */
  44const char *get_opt_value(const char *p, char **value);
  45
  46bool parse_option_size(const char *name, const char *value,
  47                       uint64_t *ret, Error **errp);
  48bool has_help_option(const char *param);
  49
  50enum QemuOptType {
  51    QEMU_OPT_STRING = 0,  /* no parsing (use string as-is)                        */
  52    QEMU_OPT_BOOL,        /* on/off                                               */
  53    QEMU_OPT_NUMBER,      /* simple number                                        */
  54    QEMU_OPT_SIZE,        /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */
  55};
  56
  57typedef struct QemuOptDesc {
  58    const char *name;
  59    enum QemuOptType type;
  60    const char *help;
  61    const char *def_value_str;
  62} QemuOptDesc;
  63
  64struct QemuOptsList {
  65    const char *name;
  66    const char *implied_opt_name;
  67    bool merge_lists;  /* Merge multiple uses of option into a single list? */
  68    QTAILQ_HEAD(, QemuOpts) head;
  69    QemuOptDesc desc[];
  70};
  71
  72const char *qemu_opt_get(QemuOpts *opts, const char *name);
  73char *qemu_opt_get_del(QemuOpts *opts, const char *name);
  74/**
  75 * qemu_opt_has_help_opt:
  76 * @opts: options to search for a help request
  77 *
  78 * Check whether the options specified by @opts include one of the
  79 * standard strings which indicate that the user is asking for a
  80 * list of the valid values for a command line option (as defined
  81 * by is_help_option()).
  82 *
  83 * Returns: true if @opts includes 'help' or equivalent.
  84 */
  85bool qemu_opt_has_help_opt(QemuOpts *opts);
  86QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name);
  87bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval);
  88uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval);
  89uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval);
  90bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval);
  91uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name,
  92                                 uint64_t defval);
  93uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name,
  94                               uint64_t defval);
  95int qemu_opt_unset(QemuOpts *opts, const char *name);
  96bool qemu_opt_set(QemuOpts *opts, const char *name, const char *value,
  97                  Error **errp);
  98bool qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val,
  99                       Error **errp);
 100bool qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val,
 101                         Error **errp);
 102typedef int (*qemu_opt_loopfunc)(void *opaque,
 103                                 const char *name, const char *value,
 104                                 Error **errp);
 105int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
 106                     Error **errp);
 107
 108typedef struct {
 109    QemuOpts *opts;
 110    QemuOpt *opt;
 111    const char *name;
 112} QemuOptsIter;
 113
 114void qemu_opt_iter_init(QemuOptsIter *iter, QemuOpts *opts, const char *name);
 115const char *qemu_opt_iter_next(QemuOptsIter *iter);
 116
 117QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id);
 118QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
 119                           int fail_if_exists, Error **errp);
 120void qemu_opts_reset(QemuOptsList *list);
 121void qemu_opts_loc_restore(QemuOpts *opts);
 122const char *qemu_opts_id(QemuOpts *opts);
 123void qemu_opts_set_id(QemuOpts *opts, char *id);
 124void qemu_opts_del(QemuOpts *opts);
 125bool qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp);
 126bool qemu_opts_do_parse(QemuOpts *opts, const char *params,
 127                        const char *firstname, Error **errp);
 128QemuOpts *qemu_opts_parse_noisily(QemuOptsList *list, const char *params,
 129                                  bool permit_abbrev);
 130QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params,
 131                          bool permit_abbrev, Error **errp);
 132QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
 133                               Error **errp);
 134QDict *qemu_opts_to_qdict_filtered(QemuOpts *opts, QDict *qdict,
 135                                   QemuOptsList *list, bool del);
 136QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict);
 137bool qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp);
 138
 139typedef int (*qemu_opts_loopfunc)(void *opaque, QemuOpts *opts, Error **errp);
 140int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func,
 141                      void *opaque, Error **errp);
 142void qemu_opts_print(QemuOpts *opts, const char *sep);
 143void qemu_opts_print_help(QemuOptsList *list, bool print_caption);
 144void qemu_opts_free(QemuOptsList *list);
 145QemuOptsList *qemu_opts_append(QemuOptsList *dst, QemuOptsList *list);
 146
 147QDict *keyval_parse_into(QDict *qdict, const char *params, const char *implied_key,
 148                         bool *p_help, Error **errp);
 149QDict *keyval_parse(const char *params, const char *implied_key,
 150                    bool *help, Error **errp);
 151void keyval_merge(QDict *old, const QDict *new, Error **errp);
 152
 153#endif
 154