blob: ca729862d57bf40804159ee197c7cdab4d80f5f5 [file] [log] [blame]
Kevin Wolfd3f24362009-05-18 16:42:09 +02001/*
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
Blue Swirl8756aa72009-09-20 07:51:06 +000029#include <stdint.h>
Blue Swirl72cf2d42009-09-12 07:36:22 +000030#include "qemu-queue.h"
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -030031#include "error.h"
Markus Armbruster01e7f182010-02-10 20:15:29 +010032#include "qdict.h"
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +020033
Kevin Wolfd3f24362009-05-18 16:42:09 +020034enum 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;
Kevin Wolfdb08adf2009-06-04 15:39:38 +020048 const char *help;
Kevin Wolfd3f24362009-05-18 16:42:09 +020049} 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);
Gerd Hoffmann62c58022009-07-22 16:43:00 +020054int 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);
Kevin Wolfd3f24362009-05-18 16:42:09 +020060
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);
MORITA Kazutakab50cbab2010-05-26 11:35:36 +090074QEMUOptionParameter *append_option_parameters(QEMUOptionParameter *dest,
75 QEMUOptionParameter *list);
Kevin Wolfd3f24362009-05-18 16:42:09 +020076QEMUOptionParameter *parse_option_parameters(const char *param,
77 QEMUOptionParameter *list, QEMUOptionParameter *dest);
78void free_option_parameters(QEMUOptionParameter *list);
79void print_option_parameters(QEMUOptionParameter *list);
Kevin Wolfdb08adf2009-06-04 15:39:38 +020080void print_option_help(QEMUOptionParameter *list);
Kevin Wolfd3f24362009-05-18 16:42:09 +020081
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +020082/* ------------------------------------------------------------------ */
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;
Markus Armbruster8212c642010-02-10 19:52:18 +0100103 const char *implied_opt_name;
Peter Maydellda933182012-02-08 05:41:37 +0000104 bool merge_lists; /* Merge multiple uses of option into a single list? */
Blue Swirl72cf2d42009-09-12 07:36:22 +0000105 QTAILQ_HEAD(, QemuOpts) head;
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200106 QemuOptDesc desc[];
107};
108
109const char *qemu_opt_get(QemuOpts *opts, const char *name);
Peter Maydellc8057f92012-08-02 13:45:54 +0100110/**
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);
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530122bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200123uint64_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);
Luiz Capitulino384f2132012-03-21 16:17:21 -0300126void qemu_opt_set_err(QemuOpts *opts, const char *name, const char *value,
127 Error **errp);
M. Mohan Kumarf02b77c2011-10-25 12:10:39 +0530128int qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val);
Gerd Hoffmann48026072009-07-31 12:25:32 +0200129typedef 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);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200132
133QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id);
Luiz Capitulino8be7e7e2012-03-20 15:51:57 -0300134QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id,
135 int fail_if_exists, Error **errp);
Markus Armbrusterbb67ab02010-06-01 10:47:34 +0200136void qemu_opts_reset(QemuOptsList *list);
Markus Armbruster94ac7262010-05-27 21:06:04 +0200137void qemu_opts_loc_restore(QemuOpts *opts);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200138int qemu_opts_set(QemuOptsList *list, const char *id,
139 const char *name, const char *value);
Gerd Hoffmann48026072009-07-31 12:25:32 +0200140const char *qemu_opts_id(QemuOpts *opts);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200141void qemu_opts_del(QemuOpts *opts);
Luiz Capitulino29952862012-04-12 11:58:57 -0300142void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp);
Gerd Hoffmann96729cb2009-09-10 10:58:33 +0200143int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname);
Markus Armbruster8212c642010-02-10 19:52:18 +0100144QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, int permit_abbrev);
Jan Kiszka4f6dd9a2012-01-27 19:54:54 +0100145void qemu_opts_set_defaults(QemuOptsList *list, const char *params,
146 int permit_abbrev);
Luiz Capitulino4e899782012-04-18 17:24:01 -0300147QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict,
148 Error **errp);
Markus Armbruster01e7f182010-02-10 20:15:29 +0100149QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict);
Gerd Hoffmanne27c88f2009-07-22 16:43:03 +0200150
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
Kevin Wolfd3f24362009-05-18 16:42:09 +0200156#endif