LXR qemu/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_OPTIONS_H
  27#define QEMU_OPTIONS_H
  28
  29#include <stdint.h>
  30#include "qemu-queue.h"
  31#include "error.h"
  32#include "qdict.h"
  33
  34enum QEMUOptionParType {
  35    OPT_FLAG,
  36    OPT_NUMBER,
  37    OPT_SIZE,
  38    OPT_STRING,
  39};
  40
  41typedef struct QEMUOptionParameter {
  42    const char *name;
  43    enum QEMUOptionParType type;
  44    union {
  45        uint64_t n;
  46        char* s;
  47    } value;
  48    const char *help;
  49} QEMUOptionParameter;
  50
  51
  52const char *get_opt_name(char *buf, int buf_size, const char *p, char delim);
  53const char *get_opt_value(char *buf, int buf_size, const char *p);
  54int get_next_param_value(char *buf, int buf_size,
  55                         const char *tag, const char **pstr);
  56int get_param_value(char *buf, int buf_size,
  57                    const char *tag, const char *str);
  58int check_params(char *buf, int buf_size,
  59                 const char * const *params, const char *str);
  60
  61
  62/*
  63 * The following functions take a parameter list as input. This is a pointer to
  64 * the first element of a QEMUOptionParameter array which is terminated by an
  65 * entry with entry->name == NULL.
  66 */
  67
  68QEMUOptionParameter *get_option_parameter(QEMUOptionParameter *list,
  69    const char *name);
  70int set_option_parameter(QEMUOptionParameter *list, const char *name,
  71    const char *value);
  72int set_option_parameter_int(QEMUOptionParameter *list, const char *name,
  73    uint64_t value);
  74QEMUOptionParameter *append_option_parameters(QEMUOptionParameter *dest,
  75    QEMUOptionParameter *list);
  76QEMUOptionParameter *parse_option_parameters(const char *param,
  77    QEMUOptionParameter *list, QEMUOptionParameter *dest);
  78void free_option_parameters(QEMUOptionParameter *list);
  79void print_option_parameters(QEMUOptionParameter *list);
  80void print_option_help(QEMUOptionParameter *list);
  81
  82/* ------------------------------------------------------------------ */
  83
  84typedef struct QemuOpt QemuOpt;
  85typedef struct QemuOpts QemuOpts;
  86typedef struct QemuOptsList QemuOptsList;
  87
  88enum QemuOptType {
  89    QEMU_OPT_STRING = 0,  /* no parsing (use string as-is)                        */
  90    QEMU_OPT_BOOL,        /* on/off                                               */
  91    QEMU_OPT_NUMBER,      /* simple number                                        */
  92    QEMU_OPT_SIZE,        /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */
  93};
  94
  95typedef struct QemuOptDesc {
  96    const char *name;
  97    enum QemuOptType type;
  98    const char *help;
  99} QemuOptDesc;
 100
 101struct QemuOptsList {
 102    const char *name;
 103    const char *implied_opt_name;
 104    bool merge_lists;  /* Merge multiple uses of option into a single list? */
 105    QTAILQ_HEAD(, QemuOpts) head;
 106    QemuOptDesc desc[];
 107};
 108
 109const char *qemu_opt_get(QemuOpts *opts, const char *name);
 110/**
 111 * qemu_opt_has_help_opt:
 112 * @opts: options to search for a help request
 113 *
 114 * Check whether the options specified by @opts include one of the
 115 * standard strings which indicate that the user is asking for a
 116 * list of the valid values for a command line option (as defined
 117 * by is_help_option()).
 118 *
 119 * Returns: true if @opts includes 'help' or equivalent.
 120 */
 121bool qemu_opt_has_help_opt(QemuOpts *opts);
 122bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval);
 123uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval);
 124uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval);
 125int qemu_opt_set(QemuOpts *opts, const char *name, const char *value);
 126void qemu_opt_set_err(QemuOpts *opts, const char *name, const char *value,
 127                      Error **errp);
 128int qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val);
 129typedef int (*qemu_opt_loopfunc)(const char *name, const char *value, void *opaque);
 130int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque,
 131                     int abort_on_failure);
 132
 133QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id);
 134QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
 135                           int fail_if_exists, Error **errp);
 136void qemu_opts_reset(QemuOptsList *list);
 137void qemu_opts_loc_restore(QemuOpts *opts);
 138int qemu_opts_set(QemuOptsList *list, const char *id,
 139                  const char *name, const char *value);
 140const char *qemu_opts_id(QemuOpts *opts);
 141void qemu_opts_del(QemuOpts *opts);
 142void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp);
 143int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname);
 144QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, int permit_abbrev);
 145void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
 146                            int permit_abbrev);
 147QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
 148                               Error **errp);
 149QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict);
 150
 151typedef int (*qemu_opts_loopfunc)(QemuOpts *opts, void *opaque);
 152int qemu_opts_print(QemuOpts *opts, void *dummy);
 153int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque,
 154                      int abort_on_failure);
 155
 156#endif
 157