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 const char *get_opt_name(char *buf, int buf_size, const char *p, char delim); 35 const char *get_opt_value(char *buf, int buf_size, const char *p); 36 int get_next_param_value(char *buf, int buf_size, 37 const char *tag, const char **pstr); 38 int get_param_value(char *buf, int buf_size, 39 const char *tag, const char *str); 40 41 42 void parse_option_size(const char *name, const char *value, 43 uint64_t *ret, Error **errp); 44 bool has_help_option(const char *param); 45 bool is_valid_option_list(const char *param); 46 47 typedef struct QemuOpt QemuOpt; 48 typedef struct QemuOpts QemuOpts; 49 typedef struct QemuOptsList QemuOptsList; 50 51 enum QemuOptType { 52 QEMU_OPT_STRING = 0, /* no parsing (use string as-is) */ 53 QEMU_OPT_BOOL, /* on/off */ 54 QEMU_OPT_NUMBER, /* simple number */ 55 QEMU_OPT_SIZE, /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */ 56 }; 57 58 typedef struct QemuOptDesc { 59 const char *name; 60 enum QemuOptType type; 61 const char *help; 62 const char *def_value_str; 63 } QemuOptDesc; 64 65 struct QemuOptsList { 66 const char *name; 67 const char *implied_opt_name; 68 bool merge_lists; /* Merge multiple uses of option into a single list? */ 69 QTAILQ_HEAD(, QemuOpts) head; 70 QemuOptDesc desc[]; 71 }; 72 73 const char *qemu_opt_get(QemuOpts *opts, const char *name); 74 char *qemu_opt_get_del(QemuOpts *opts, const char *name); 75 /** 76 * qemu_opt_has_help_opt: 77 * @opts: options to search for a help request 78 * 79 * Check whether the options specified by @opts include one of the 80 * standard strings which indicate that the user is asking for a 81 * list of the valid values for a command line option (as defined 82 * by is_help_option()). 83 * 84 * Returns: true if @opts includes 'help' or equivalent. 85 */ 86 bool qemu_opt_has_help_opt(QemuOpts *opts); 87 QemuOpt *qemu_opt_find(QemuOpts *opts, const char *name); 88 bool qemu_opt_get_bool(QemuOpts *opts, const char *name, bool defval); 89 uint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval); 90 uint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval); 91 bool qemu_opt_get_bool_del(QemuOpts *opts, const char *name, bool defval); 92 uint64_t qemu_opt_get_number_del(QemuOpts *opts, const char *name, 93 uint64_t defval); 94 uint64_t qemu_opt_get_size_del(QemuOpts *opts, const char *name, 95 uint64_t defval); 96 int qemu_opt_unset(QemuOpts *opts, const char *name); 97 void qemu_opt_set(QemuOpts *opts, const char *name, const char *value, 98 Error **errp); 99 void qemu_opt_set_bool(QemuOpts *opts, const char *name, bool val, 100 Error **errp); 101 void qemu_opt_set_number(QemuOpts *opts, const char *name, int64_t val, 102 Error **errp); 103 typedef int (*qemu_opt_loopfunc)(void *opaque, 104 const char *name, const char *value, 105 Error **errp); 106 int qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque, 107 Error **errp); 108 109 QemuOpts *qemu_opts_find(QemuOptsList *list, const char *id); 110 QemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, 111 int fail_if_exists, Error **errp); 112 void qemu_opts_reset(QemuOptsList *list); 113 void qemu_opts_loc_restore(QemuOpts *opts); 114 void qemu_opts_set(QemuOptsList *list, const char *id, 115 const char *name, const char *value, Error **errp); 116 const char *qemu_opts_id(QemuOpts *opts); 117 void qemu_opts_set_id(QemuOpts *opts, char *id); 118 void qemu_opts_del(QemuOpts *opts); 119 void qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc, Error **errp); 120 void qemu_opts_do_parse(QemuOpts *opts, const char *params, 121 const char *firstname, Error **errp); 122 QemuOpts *qemu_opts_parse_noisily(QemuOptsList *list, const char *params, 123 bool permit_abbrev); 124 QemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, 125 bool permit_abbrev, Error **errp); 126 void qemu_opts_set_defaults(QemuOptsList *list, const char *params, 127 int permit_abbrev); 128 QemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict, 129 Error **errp); 130 QDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict); 131 void qemu_opts_absorb_qdict(QemuOpts *opts, QDict *qdict, Error **errp); 132 133 typedef int (*qemu_opts_loopfunc)(void *opaque, QemuOpts *opts, Error **errp); 134 int qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, 135 void *opaque, Error **errp); 136 void qemu_opts_print(QemuOpts *opts, const char *sep); 137 void qemu_opts_print_help(QemuOptsList *list); 138 void qemu_opts_free(QemuOptsList *list); 139 QemuOptsList *qemu_opts_append(QemuOptsList *dst, QemuOptsList *list); 140 141 #endif 142