Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 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 | |
Blue Swirl | 8756aa7 | 2009-09-20 07:51:06 +0000 | [diff] [blame] | 29 | #include <stdint.h> |
Blue Swirl | 72cf2d4 | 2009-09-12 07:36:22 +0000 | [diff] [blame] | 30 | #include "qemu-queue.h" |
Luiz Capitulino | 8be7e7e | 2012-03-20 15:51:57 -0300 | [diff] [blame] | 31 | #include "error.h" |
Markus Armbruster | 01e7f18 | 2010-02-10 20:15:29 +0100 | [diff] [blame] | 32 | #include "qdict.h" |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 33 | |
Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 34 | enum QEMUOptionParType { |
| 35 | OPT_FLAG, |
| 36 | OPT_NUMBER, |
| 37 | OPT_SIZE, |
| 38 | OPT_STRING, |
| 39 | }; |
| 40 | |
| 41 | typedef struct QEMUOptionParameter { |
| 42 | const char *name; |
| 43 | enum QEMUOptionParType type; |
| 44 | union { |
| 45 | uint64_t n; |
| 46 | char* s; |
| 47 | } value; |
Kevin Wolf | db08adf | 2009-06-04 15:39:38 +0200 | [diff] [blame] | 48 | const char *help; |
Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 49 | } QEMUOptionParameter; |
| 50 | |
| 51 | |
| 52 | const char *get_opt_name(char *buf, int buf_size, const char *p, char delim); |
| 53 | const char *get_opt_value(char *buf, int buf_size, const char *p); |
Gerd Hoffmann | 62c5802 | 2009-07-22 16:43:00 +0200 | [diff] [blame] | 54 | int get_next_param_value(char *buf, int buf_size, |
| 55 | const char *tag, const char **pstr); |
| 56 | int get_param_value(char *buf, int buf_size, |
| 57 | const char *tag, const char *str); |
| 58 | int check_params(char *buf, int buf_size, |
| 59 | const char * const *params, const char *str); |
Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 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 | |
| 68 | QEMUOptionParameter *get_option_parameter(QEMUOptionParameter *list, |
| 69 | const char *name); |
| 70 | int set_option_parameter(QEMUOptionParameter *list, const char *name, |
| 71 | const char *value); |
| 72 | int set_option_parameter_int(QEMUOptionParameter *list, const char *name, |
| 73 | uint64_t value); |
MORITA Kazutaka | b50cbab | 2010-05-26 11:35:36 +0900 | [diff] [blame] | 74 | QEMUOptionParameter *append_option_parameters(QEMUOptionParameter *dest, |
| 75 | QEMUOptionParameter *list); |
Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 76 | QEMUOptionParameter *parse_option_parameters(const char *param, |
| 77 | QEMUOptionParameter *list, QEMUOptionParameter *dest); |
| 78 | void free_option_parameters(QEMUOptionParameter *list); |
| 79 | void print_option_parameters(QEMUOptionParameter *list); |
Kevin Wolf | db08adf | 2009-06-04 15:39:38 +0200 | [diff] [blame] | 80 | void print_option_help(QEMUOptionParameter *list); |
Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 81 | |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 82 | /* ------------------------------------------------------------------ */ |
| 83 | |
| 84 | typedef struct QemuOpt QemuOpt; |
| 85 | typedef struct QemuOpts QemuOpts; |
| 86 | typedef struct QemuOptsList QemuOptsList; |
| 87 | |
| 88 | enum 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 | |
| 95 | typedef struct QemuOptDesc { |
| 96 | const char *name; |
| 97 | enum QemuOptType type; |
| 98 | const char *help; |
| 99 | } QemuOptDesc; |
| 100 | |
| 101 | struct QemuOptsList { |
| 102 | const char *name; |
Markus Armbruster | 8212c64 | 2010-02-10 19:52:18 +0100 | [diff] [blame] | 103 | const char *implied_opt_name; |
Peter Maydell | da93318 | 2012-02-08 05:41:37 +0000 | [diff] [blame] | 104 | bool merge_lists; /* Merge multiple uses of option into a single list? */ |
Blue Swirl | 72cf2d4 | 2009-09-12 07:36:22 +0000 | [diff] [blame] | 105 | QTAILQ_HEAD(, QemuOpts) head; |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 106 | QemuOptDesc desc[]; |
| 107 | }; |
| 108 | |
| 109 | const char *qemu_opt_get(QemuOpts *opts, const char *name); |
Peter Maydell | c8057f9 | 2012-08-02 13:45:54 +0100 | [diff] [blame] | 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 | */ |
| 121 | bool qemu_opt_has_help_opt(QemuOpts *opts); |
M. Mohan Kumar | f02b77c | 2011-10-25 12:10:39 +0530 | [diff] [blame] | 122 | bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval); |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 123 | uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval); |
| 124 | uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval); |
| 125 | int qemu_opt_set(QemuOpts *opts, const char *name, const char *value); |
Luiz Capitulino | 384f213 | 2012-03-21 16:17:21 -0300 | [diff] [blame] | 126 | void qemu_opt_set_err(QemuOpts *opts, const char *name, const char *value, |
| 127 | Error **errp); |
M. Mohan Kumar | f02b77c | 2011-10-25 12:10:39 +0530 | [diff] [blame] | 128 | int qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val); |
Gerd Hoffmann | 4802607 | 2009-07-31 12:25:32 +0200 | [diff] [blame] | 129 | typedef int (*qemu_opt_loopfunc)(const char *name, const char *value, void *opaque); |
| 130 | int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque, |
| 131 | int abort_on_failure); |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 132 | |
| 133 | QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id); |
Luiz Capitulino | 8be7e7e | 2012-03-20 15:51:57 -0300 | [diff] [blame] | 134 | QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, |
| 135 | int fail_if_exists, Error **errp); |
Markus Armbruster | bb67ab0 | 2010-06-01 10:47:34 +0200 | [diff] [blame] | 136 | void qemu_opts_reset(QemuOptsList *list); |
Markus Armbruster | 94ac726 | 2010-05-27 21:06:04 +0200 | [diff] [blame] | 137 | void qemu_opts_loc_restore(QemuOpts *opts); |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 138 | int qemu_opts_set(QemuOptsList *list, const char *id, |
| 139 | const char *name, const char *value); |
Gerd Hoffmann | 4802607 | 2009-07-31 12:25:32 +0200 | [diff] [blame] | 140 | const char *qemu_opts_id(QemuOpts *opts); |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 141 | void qemu_opts_del(QemuOpts *opts); |
Luiz Capitulino | 2995286 | 2012-04-12 11:58:57 -0300 | [diff] [blame] | 142 | void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp); |
Gerd Hoffmann | 96729cb | 2009-09-10 10:58:33 +0200 | [diff] [blame] | 143 | int qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname); |
Markus Armbruster | 8212c64 | 2010-02-10 19:52:18 +0100 | [diff] [blame] | 144 | QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, int permit_abbrev); |
Jan Kiszka | 4f6dd9a | 2012-01-27 19:54:54 +0100 | [diff] [blame] | 145 | void qemu_opts_set_defaults(QemuOptsList *list, const char *params, |
| 146 | int permit_abbrev); |
Luiz Capitulino | 4e89978 | 2012-04-18 17:24:01 -0300 | [diff] [blame] | 147 | QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict, |
| 148 | Error **errp); |
Markus Armbruster | 01e7f18 | 2010-02-10 20:15:29 +0100 | [diff] [blame] | 149 | QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict); |
Gerd Hoffmann | e27c88f | 2009-07-22 16:43:03 +0200 | [diff] [blame] | 150 | |
| 151 | typedef int (*qemu_opts_loopfunc)(QemuOpts *opts, void *opaque); |
| 152 | int qemu_opts_print(QemuOpts *opts, void *dummy); |
| 153 | int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque, |
| 154 | int abort_on_failure); |
| 155 | |
Kevin Wolf | d3f2436 | 2009-05-18 16:42:09 +0200 | [diff] [blame] | 156 | #endif |