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