15d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner/* 25d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * Commandline option parsing functions 35d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * 45d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * Copyright (c) 2003-2008 Fabrice Bellard 55d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * Copyright (c) 2009 Kevin Wolf <kwolf@redhat.com> 65d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * 75d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * Permission is hereby granted, free of charge, to any person obtaining a copy 85d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * of this software and associated documentation files (the "Software"), to deal 95d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * in the Software without restriction, including without limitation the rights 105d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 115d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * copies of the Software, and to permit persons to whom the Software is 125d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * furnished to do so, subject to the following conditions: 135d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * 145d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * The above copyright notice and this permission notice shall be included in 155d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * all copies or substantial portions of the Software. 165d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * 175d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 185d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 195d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 205d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 215d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 225d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 235d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * THE SOFTWARE. 245d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner */ 255d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 265d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner#ifndef QEMU_OPTIONS_H 275d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner#define QEMU_OPTIONS_H 285d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 292910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner#include <stdint.h> 302910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner#include "qemu-queue.h" 312abe02c0511b2278af9386e7ac5e266d890a38b1David Turner#include "qdict.h" 322910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 335d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnerenum QEMUOptionParType { 345d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner OPT_FLAG, 355d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner OPT_NUMBER, 365d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner OPT_SIZE, 375d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner OPT_STRING, 385d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner}; 395d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 405d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnertypedef struct QEMUOptionParameter { 415d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner const char *name; 425d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner enum QEMUOptionParType type; 435d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner union { 445d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner uint64_t n; 455d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner char* s; 465d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner } value; 475d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner const char *help; 485d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner} QEMUOptionParameter; 495d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 505d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 515d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnerconst char *get_opt_name(char *buf, int buf_size, const char *p, char delim); 525d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnerconst char *get_opt_value(char *buf, int buf_size, const char *p); 532910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint get_next_param_value(char *buf, int buf_size, 542910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char *tag, const char **pstr); 552910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint get_param_value(char *buf, int buf_size, 562910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char *tag, const char *str); 572910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint check_params(char *buf, int buf_size, 582910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char * const *params, const char *str); 595d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 605d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 615d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner/* 625d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * The following functions take a parameter list as input. This is a pointer to 635d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * the first element of a QEMUOptionParameter array which is terminated by an 645d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner * entry with entry->name == NULL. 655d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner */ 665d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 675d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' TurnerQEMUOptionParameter *get_option_parameter(QEMUOptionParameter *list, 685d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner const char *name); 695d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnerint set_option_parameter(QEMUOptionParameter *list, const char *name, 705d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner const char *value); 715d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnerint set_option_parameter_int(QEMUOptionParameter *list, const char *name, 725d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner uint64_t value); 732abe02c0511b2278af9386e7ac5e266d890a38b1David TurnerQEMUOptionParameter *append_option_parameters(QEMUOptionParameter *dest, 742abe02c0511b2278af9386e7ac5e266d890a38b1David Turner QEMUOptionParameter *list); 755d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' TurnerQEMUOptionParameter *parse_option_parameters(const char *param, 765d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner QEMUOptionParameter *list, QEMUOptionParameter *dest); 775d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnervoid free_option_parameters(QEMUOptionParameter *list); 785d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnervoid print_option_parameters(QEMUOptionParameter *list); 795d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turnervoid print_option_help(QEMUOptionParameter *list); 805d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner 812910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner/* ------------------------------------------------------------------ */ 822910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 832910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnertypedef struct QemuOpt QemuOpt; 842910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnertypedef struct QemuOpts QemuOpts; 852910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnertypedef struct QemuOptsList QemuOptsList; 862910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 872910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerenum QemuOptType { 882910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner QEMU_OPT_STRING = 0, /* no parsing (use string as-is) */ 892910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner QEMU_OPT_BOOL, /* on/off */ 902910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner QEMU_OPT_NUMBER, /* simple number */ 912910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner QEMU_OPT_SIZE, /* size, accepts (K)ilo, (M)ega, (G)iga, (T)era postfix */ 922910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner}; 932910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 942910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnertypedef struct QemuOptDesc { 952910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char *name; 962910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner enum QemuOptType type; 972910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char *help; 982910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner} QemuOptDesc; 992910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 1002910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerstruct QemuOptsList { 1012910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char *name; 1022abe02c0511b2278af9386e7ac5e266d890a38b1David Turner const char *implied_opt_name; 1032910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner QTAILQ_HEAD(, QemuOpts) head; 1042910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner QemuOptDesc desc[]; 1052910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner}; 1062910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 1072910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerconst char *qemu_opt_get(QemuOpts *opts, const char *name); 1082910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opt_get_bool(QemuOpts *opts, const char *name, int defval); 1092910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turneruint64_t qemu_opt_get_number(QemuOpts *opts, const char *name, uint64_t defval); 1102910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turneruint64_t qemu_opt_get_size(QemuOpts *opts, const char *name, uint64_t defval); 1112910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opt_set(QemuOpts *opts, const char *name, const char *value); 1122910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnertypedef int (*qemu_opt_loopfunc)(const char *name, const char *value, void *opaque); 1132910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opt_foreach(QemuOpts *opts, qemu_opt_loopfunc func, void *opaque, 1142910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner int abort_on_failure); 1152910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 1162910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' TurnerQemuOpts *qemu_opts_find(QemuOptsList *list, const char *id); 1172910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' TurnerQemuOpts *qemu_opts_create(QemuOptsList *list, const char *id, int fail_if_exists); 1182abe02c0511b2278af9386e7ac5e266d890a38b1David Turnervoid qemu_opts_reset(QemuOptsList *list); 1192abe02c0511b2278af9386e7ac5e266d890a38b1David Turnervoid qemu_opts_loc_restore(QemuOpts *opts); 1202910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opts_set(QemuOptsList *list, const char *id, 1212910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner const char *name, const char *value); 1222910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerconst char *qemu_opts_id(QemuOpts *opts); 1232910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnervoid qemu_opts_del(QemuOpts *opts); 1249251866320b5f8329a043bb56b3a794f78d12849David 'Digit' Turnerint qemu_opts_validate(QemuOpts *opts, const QemuOptDesc *desc); 1252910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opts_do_parse(QemuOpts *opts, const char *params, const char *firstname); 1262abe02c0511b2278af9386e7ac5e266d890a38b1David TurnerQemuOpts *qemu_opts_parse(QemuOptsList *list, const char *params, int permit_abbrev); 1272abe02c0511b2278af9386e7ac5e266d890a38b1David TurnerQemuOpts *qemu_opts_from_qdict(QemuOptsList *list, const QDict *qdict); 1282abe02c0511b2278af9386e7ac5e266d890a38b1David TurnerQDict *qemu_opts_to_qdict(QemuOpts *opts, QDict *qdict); 1292910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 1302910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnertypedef int (*qemu_opts_loopfunc)(QemuOpts *opts, void *opaque); 1312910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opts_print(QemuOpts *opts, void *dummy); 1322910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turnerint qemu_opts_foreach(QemuOptsList *list, qemu_opts_loopfunc func, void *opaque, 1332910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner int abort_on_failure); 1342910f183ddd5286911bc1e3499ea93cb57de8b75David 'Digit' Turner 1355d8f37ad78fc66901af50c762029a501561f3b23David 'Digit' Turner#endif 136