mirrors/Bochs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
aeaf51d33a
Bochs/bochs/gui/siminterface.cc
Volker Ruppert 3a470c9d11 - names of bx_list_c members are now compared case insensitive 
- added configure check and osdep code for the stricmp function
- minor changes in siminterface
2009-02-02 13:03:28 +00:00

2133 lines
60 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/////////////////////////////////////////////////////////////////////////
// $Id: siminterface.cc,v 1.191 2009-02-02 13:02:48 vruppert Exp $
/////////////////////////////////////////////////////////////////////////
//
// Copyright (C) 2009 The Bochs Project
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
//
/////////////////////////////////////////////////////////////////////////
//
// See siminterface.h for description of the siminterface concept.
// Basically, the siminterface is visible from both the simulator and
// the configuration user interface, and allows them to talk to each other.
#include "iodev.h"
bx_simulator_interface_c *SIM = NULL;
logfunctions *siminterface_log = NULL;
bx_list_c *root_param = NULL;
#define LOG_THIS siminterface_log->
// bx_simulator_interface just defines the interface that the Bochs simulator
// and the gui will use to talk to each other. None of the methods of
// bx_simulator_interface are implemented; they are all virtual. The
// bx_real_sim_c class is a child of bx_simulator_interface_c, and it
// implements all the methods. The idea is that a gui needs to know only
// definition of bx_simulator_interface to talk to Bochs. The gui should
// not need to include bochs.h.
//
// I made this separation to ensure that all guis use the siminterface to do
// access bochs internals, instead of accessing things like
// bx_keyboard.s.internal_buffer[4] (or whatever) directly. -Bryce
//
typedef struct _user_option_t {
const char *name;
user_option_parser_t parser;
user_option_save_t savefn;
struct _user_option_t *next;
} user_option_t;
class bx_real_sim_c : public bx_simulator_interface_c {
bxevent_handler bxevent_callback;
void *bxevent_callback_data;
const char *registered_ci_name;
config_interface_callback_t ci_callback;
void *ci_callback_data;
user_option_t *user_options;
int init_done;
int enabled;
// save context to jump to if we must quit unexpectedly
jmp_buf *quit_context;
int exit_code;
unsigned param_id;
public:
bx_real_sim_c();
virtual ~bx_real_sim_c() {}
virtual void set_quit_context(jmp_buf *context) { quit_context = context; }
virtual int get_init_done() { return init_done; }
virtual int set_init_done(int n) { init_done = n; return 0;}
virtual void reset_all_param();
// new param methods
virtual bx_param_c *get_param(const char *pname, bx_param_c *base=NULL);
virtual bx_param_num_c *get_param_num(const char *pname, bx_param_c *base=NULL);
virtual bx_param_string_c *get_param_string(const char *pname, bx_param_c *base=NULL);
virtual bx_param_bool_c *get_param_bool(const char *pname, bx_param_c *base=NULL);
virtual bx_param_enum_c *get_param_enum(const char *pname, bx_param_c *base=NULL);
virtual Bit32u gen_param_id() { return param_id++; }
virtual int get_n_log_modules();
virtual char *get_prefix(int mod);
virtual int get_log_action(int mod, int level);
virtual void set_log_action(int mod, int level, int action);
virtual char *get_action_name(int action);
virtual int get_default_log_action(int level) {
return logfunctions::get_default_action(level);
}
virtual void set_default_log_action(int level, int action) {
logfunctions::set_default_action(level, action);
}
virtual const char *get_log_level_name(int level);
virtual int get_max_log_level() { return N_LOGLEV; }
virtual void quit_sim(int code);
virtual int get_exit_code() { return exit_code; }
virtual int get_default_rc(char *path, int len);
virtual int read_rc(const char *path);
virtual int write_rc(const char *path, int overwrite);
virtual int get_log_file(char *path, int len);
virtual int set_log_file(char *path);
virtual int get_log_prefix(char *prefix, int len);
virtual int set_log_prefix(char *prefix);
virtual int get_debugger_log_file(char *path, int len);
virtual int set_debugger_log_file(char *path);
virtual int get_cdrom_options(int drive, bx_list_c **out, int *device = NULL);
virtual void set_notify_callback(bxevent_handler func, void *arg);
virtual void get_notify_callback(bxevent_handler *func, void **arg);
virtual BxEvent* sim_to_ci_event(BxEvent *event);
virtual int log_msg(const char *prefix, int level, const char *msg);
virtual int ask_param(bx_param_c *param);
virtual int ask_param(const char *pname);
// ask the user for a pathname
virtual int ask_filename(const char *filename, int maxlen, const char *prompt, const char *the_default, int flags);
// yes/no dialog
virtual int ask_yes_no(const char *title, const char *prompt, bx_bool the_default);
// called at a regular interval, currently by the keyboard handler.
virtual void periodic();
virtual int create_disk_image(const char *filename, int sectors, bx_bool overwrite);
virtual void refresh_ci();
virtual void refresh_vga() {
// maybe need to check if something has been initialized yet?
DEV_vga_refresh();
}
virtual void handle_events() {
// maybe need to check if something has been initialized yet?
bx_gui->handle_events();
}
// find first hard drive or cdrom
bx_param_c *get_first_atadevice(Bit32u search_type);
bx_param_c *get_first_cdrom() {
return get_first_atadevice(BX_ATA_DEVICE_CDROM);
}
bx_param_c *get_first_hd() {
return get_first_atadevice(BX_ATA_DEVICE_DISK);
}
#if BX_DEBUGGER
virtual void debug_break();
virtual void debug_interpret_cmd (char *cmd);
virtual char *debug_get_next_command ();
virtual void debug_puts(const char *cmd);
#endif
virtual void register_configuration_interface (
const char* name,
config_interface_callback_t callback,
void *userdata);
virtual int configuration_interface(const char* name, ci_command_t command);
virtual int begin_simulation(int argc, char *argv[]);
virtual void set_sim_thread_func(is_sim_thread_func_t func) {}
virtual bx_bool is_sim_thread();
bx_bool debug_gui;
virtual void set_debug_gui(bx_bool val) { debug_gui = val; }
virtual bx_bool has_debug_gui() { return debug_gui; }
// provide interface to bx_gui->set_display_mode() method for config
// interfaces to use.
virtual void set_display_mode(disp_mode_t newmode) {
if (bx_gui != NULL)
bx_gui->set_display_mode(newmode);
}
virtual bx_bool test_for_text_console();
// user-defined option support
virtual bx_bool register_user_option(const char *keyword, user_option_parser_t parser, user_option_save_t save_func);
virtual bx_bool unregister_user_option(const char *keyword);
virtual bx_bool is_user_option(const char *keyword);
virtual Bit32s parse_user_option(const char *context, int num_params, char *params []);
virtual Bit32s save_user_options(FILE *fp);
// save/restore support
virtual void init_save_restore();
virtual bx_bool save_state(const char *checkpoint_path);
virtual bx_bool restore_config();
virtual bx_bool restore_logopts();
virtual bx_bool restore_hardware();
virtual bx_list_c *get_bochs_root() {
return (bx_list_c*)get_param("bochs", NULL);
}
virtual bx_bool restore_bochs_param(bx_list_c *root, const char *sr_path, const char *restore_name);
private:
bx_bool save_sr_param(FILE *fp, bx_param_c *node, const char *sr_path, int level);
};
#if BX_DEBUGGER && BX_DEBUGGER_GUI
// FIXME: these probably belong inside the bx_simulator_interface_c structure
char *debug_cmd = NULL;
bx_bool debug_cmd_ready = 0;
bx_bool vgaw_refresh = 0;
#endif
// recursive function to find parameters from the path
static bx_param_c *find_param(const char *full_pname, const char *rest_of_pname, bx_param_c *base)
{
const char *from = rest_of_pname;
char component[BX_PATHNAME_LEN];
char *to = component;
// copy the first piece of pname into component, stopping at first separator
// or at the end of the string
while (*from != 0 && *from != '.') {
*to = *from;
to++;
from++;
}
*to = 0;
if (!component[0]) {
BX_PANIC(("find_param: found empty component in parameter name '%s'", full_pname));
// or does that mean that we're done?
}
if (base->get_type() != BXT_LIST) {
BX_PANIC(("find_param: base was not a list!"));
}
BX_DEBUG(("searching for component '%s' in list '%s'", component, base->get_name()));
// find the component in the list.
bx_list_c *list = (bx_list_c *)base;
bx_param_c *child = list->get_by_name(component);
// if child not found, there is nothing else that can be done. return NULL.
if (child == NULL) return NULL;
if (from[0] == 0) {
// that was the end of the path, we're done
return child;
}
// continue parsing the path
BX_ASSERT(from[0] == '.');
from++; // skip over the separator
return find_param(full_pname, from, child);
}
bx_param_c *bx_real_sim_c::get_param(const char *pname, bx_param_c *base)
{
if (base == NULL)
base = root_param;
// to access top level object, look for parameter "."
if (pname[0] == '.' && pname[1] == 0)
return base;
return find_param(pname, pname, base);
}
bx_param_num_c *bx_real_sim_c::get_param_num(const char *pname, bx_param_c *base)
{
bx_param_c *generic = get_param(pname, base);
if (generic==NULL) {
BX_ERROR(("get_param_num(%s) could not find a parameter", pname));
return NULL;
}
int type = generic->get_type();
if (type == BXT_PARAM_NUM || type == BXT_PARAM_BOOL || type == BXT_PARAM_ENUM)
return (bx_param_num_c *)generic;
BX_ERROR(("get_param_num(%s) could not find an integer parameter with that name", pname));
return NULL;
}
bx_param_string_c *bx_real_sim_c::get_param_string(const char *pname, bx_param_c *base)
{
bx_param_c *generic = get_param(pname, base);
if (generic==NULL) {
BX_ERROR(("get_param_string(%s) could not find a parameter", pname));
return NULL;
}
if (generic->get_type() == BXT_PARAM_STRING)
return (bx_param_string_c *)generic;
BX_ERROR(("get_param_string(%s) could not find an integer parameter with that name", pname));
return NULL;
}
bx_param_bool_c *bx_real_sim_c::get_param_bool(const char *pname, bx_param_c *base)
{
bx_param_c *generic = get_param(pname, base);
if (generic==NULL) {
BX_ERROR(("get_param_bool(%s) could not find a parameter", pname));
return NULL;
}
if (generic->get_type () == BXT_PARAM_BOOL)
return (bx_param_bool_c *)generic;
BX_ERROR(("get_param_bool(%s) could not find a bool parameter with that name", pname));
return NULL;
}
bx_param_enum_c *bx_real_sim_c::get_param_enum(const char *pname, bx_param_c *base)
{
bx_param_c *generic = get_param(pname, base);
if (generic==NULL) {
BX_ERROR(("get_param_enum(%s) could not find a parameter", pname));
return NULL;
}
if (generic->get_type() == BXT_PARAM_ENUM)
return (bx_param_enum_c *)generic;
BX_ERROR(("get_param_enum(%s) could not find a enum parameter with that name", pname));
return NULL;
}
void bx_init_siminterface()
{
siminterface_log = new logfunctions();
siminterface_log->put("CTRL");
if (SIM == NULL)
SIM = new bx_real_sim_c();
if (root_param == NULL) {
root_param = new bx_list_c(NULL,
"bochs",
"list of top level bochs parameters",
30);
}
}
bx_real_sim_c::bx_real_sim_c()
{
bxevent_callback = NULL;
bxevent_callback_data = NULL;
ci_callback = NULL;
ci_callback_data = NULL;
is_sim_thread_func = NULL;
debug_gui = 0;
enabled = 1;
init_done = 0;
quit_context = NULL;
exit_code = 0;
param_id = BXP_NEW_PARAM_ID;
user_options = NULL;
}
void bx_real_sim_c::reset_all_param()
{
bx_reset_options();
}
int bx_real_sim_c::get_n_log_modules()
{
return io->get_n_logfns();
}
char *bx_real_sim_c::get_prefix(int mod)
{
logfunc_t *logfn = io->get_logfn(mod);
return logfn->getprefix();
}
int bx_real_sim_c::get_log_action(int mod, int level)
{
logfunc_t *logfn = io->get_logfn(mod);
return logfn->getonoff(level);
}
void bx_real_sim_c::set_log_action(int mod, int level, int action)
{
// normal
if (mod >= 0) {
logfunc_t *logfn = io->get_logfn(mod);
logfn->setonoff(level, action);
return;
}
// if called with mod<0 loop over all
int nmod = get_n_log_modules ();
for (mod=0; mod<nmod; mod++)
set_log_action(mod, level, action);
}
char *bx_real_sim_c::get_action_name(int action)
{
return io->getaction(action);
}
const char *bx_real_sim_c::get_log_level_name(int level)
{
return io->getlevel(level);
}
void bx_real_sim_c::quit_sim(int code)
{
BX_INFO(("quit_sim called with exit code %d", code));
exit_code = code;
io->exit_log();
// use longjmp to quit cleanly, no matter where in the stack we are.
if (quit_context != NULL) {
longjmp(*quit_context, 1);
BX_PANIC(("in bx_real_sim_c::quit_sim, longjmp should never return"));
} else {
// use exit() to stop the application.
if (!code)
BX_PANIC(("Quit simulation command"));
::exit(exit_code);
}
}
int bx_real_sim_c::get_default_rc(char *path, int len)
{
char *rc = bx_find_bochsrc();
if (rc == NULL) return -1;
strncpy(path, rc, len);
path[len-1] = 0;
return 0;
}
int bx_real_sim_c::read_rc(const char *rc)
{
return bx_read_configuration(rc);
}
// return values:
// 0: written ok
// -1: failed
// -2: already exists, and overwrite was off
int bx_real_sim_c::write_rc(const char *rc, int overwrite)
{
return bx_write_configuration(rc, overwrite);
}
int bx_real_sim_c::get_log_file(char *path, int len)
{
strncpy(path, SIM->get_param_string(BXPN_LOG_FILENAME)->getptr(), len);
return 0;
}
int bx_real_sim_c::set_log_file(char *path)
{
SIM->get_param_string(BXPN_LOG_FILENAME)->set(path);
return 0;
}
int bx_real_sim_c::get_log_prefix(char *prefix, int len)
{
strncpy(prefix, SIM->get_param_string(BXPN_LOG_PREFIX)->getptr(), len);
return 0;
}
int bx_real_sim_c::set_log_prefix(char *prefix)
{
SIM->get_param_string(BXPN_LOG_PREFIX)->set(prefix);
return 0;
}
int bx_real_sim_c::get_debugger_log_file(char *path, int len)
{
strncpy(path, SIM->get_param_string(BXPN_DEBUGGER_LOG_FILENAME)->getptr(), len);
return 0;
}
int bx_real_sim_c::set_debugger_log_file(char *path)
{
SIM->get_param_string(BXPN_DEBUGGER_LOG_FILENAME)->set(path);
return 0;
}
int bx_real_sim_c::get_cdrom_options(int level, bx_list_c **out, int *where)
{
char pname[80];
for (Bit8u channel=0; channel<BX_MAX_ATA_CHANNEL; channel++) {
for (Bit8u device=0; device<2; device++) {
sprintf(pname, "ata.%d.%s", channel, (device==0)?"master":"slave");
bx_list_c *devlist = (bx_list_c*) SIM->get_param(pname);
if (SIM->get_param_enum("type", devlist)->get() == BX_ATA_DEVICE_CDROM) {
if (level==0) {
*out = devlist;
if (where != NULL) *where = (channel * 2) + device;
return 1;
} else {
level--;
}
}
}
}
return 0;
}
const char *bochs_start_names[] = { "quick", "load", "edit", "run" };
const char *floppy_type_names[] = { "none", "1.2M", "1.44M", "2.88M", "720K", "360K", "160K", "180K", "320K", "auto", NULL };
int floppy_type_n_sectors[] = { -1, 80*2*15, 80*2*18, 80*2*36, 80*2*9, 40*2*9, 40*1*8, 40*1*9, 40*2*8, -1 };
const char *floppy_status_names[] = { "ejected", "inserted", NULL };
const char *bochs_bootdisk_names[] = { "none", "floppy", "disk","cdrom", "network", NULL };
const char *loader_os_names[] = { "none", "linux", "nullkernel", NULL };
const char *keyboard_type_names[] = { "xt", "at", "mf", NULL };
const char *atadevice_type_names[] = { "disk", "cdrom", NULL };
//const char *atadevice_mode_names[] = { "flat", "concat", "external", "dll", "sparse", "vmware3", "vmware4", "undoable", "growing", "volatile", "z-undoable", "z-volatile", NULL };
const char *atadevice_mode_names[] = { "flat", "concat", "external", "dll", "sparse", "vmware3", "vmware4", "undoable", "growing", "volatile", NULL };
const char *atadevice_status_names[] = { "ejected", "inserted", NULL };
const char *atadevice_biosdetect_names[] = { "none", "auto", "cmos", NULL };
const char *atadevice_translation_names[] = { "none", "lba", "large", "rechs", "auto", NULL };
const char *clock_sync_names[] = { "none", "realtime", "slowdown", "both", NULL };
void bx_real_sim_c::set_notify_callback(bxevent_handler func, void *arg)
{
bxevent_callback = func;
bxevent_callback_data = arg;
}
void bx_real_sim_c::get_notify_callback(bxevent_handler *func, void **arg)
{
*func = bxevent_callback;
*arg = bxevent_callback_data;
}
BxEvent *bx_real_sim_c::sim_to_ci_event(BxEvent *event)
{
if (bxevent_callback == NULL) {
BX_ERROR(("notify called, but no bxevent_callback function is registered"));
return NULL;
} else {
return (*bxevent_callback)(bxevent_callback_data, event);
}
}
// returns 0 for continue, 1 for alwayscontinue, 2 for die.
int bx_real_sim_c::log_msg(const char *prefix, int level, const char *msg)
{
BxEvent be;
be.type = BX_SYNC_EVT_LOG_ASK;
be.u.logmsg.prefix = prefix;
be.u.logmsg.level = level;
be.u.logmsg.msg = msg;
// default return value in case something goes wrong.
be.retcode = BX_LOG_NOTIFY_FAILED;
// calling notify
sim_to_ci_event (&be);
return be.retcode;
}
// Called by simulator whenever it needs the user to choose a new value
// for a registered parameter. Create a synchronous ASK_PARAM event,
// send it to the CI, and wait for the response. The CI will call the
// set() method on the parameter if the user changes the value.
int bx_real_sim_c::ask_param(bx_param_c *param)
{
BX_ASSERT(param != NULL);
// create appropriate event
BxEvent event;
event.type = BX_SYNC_EVT_ASK_PARAM;
event.u.param.param = param;
sim_to_ci_event(&event);
return event.retcode;
}
int bx_real_sim_c::ask_param(const char *pname)
{
bx_param_c *paramptr = SIM->get_param(pname);
BX_ASSERT(paramptr != NULL);
// create appropriate event
BxEvent event;
event.type = BX_SYNC_EVT_ASK_PARAM;
event.u.param.param = paramptr;
sim_to_ci_event(&event);
return event.retcode;
}
int bx_real_sim_c::ask_filename(const char *filename, int maxlen, const char *prompt, const char *the_default, int flags)
{
BxEvent event;
bx_param_string_c param(NULL, "filename", prompt, "", the_default, maxlen);
flags |= param.IS_FILENAME;
param.get_options()->set(flags);
event.type = BX_SYNC_EVT_ASK_PARAM;
event.u.param.param = &param;
sim_to_ci_event(&event);
if (event.retcode >= 0)
memcpy((char *)filename, param.getptr(), maxlen);
return event.retcode;
}
int bx_real_sim_c::ask_yes_no(const char *title, const char *prompt, bx_bool the_default)
{
BxEvent event;
char format[512];
bx_param_bool_c param(NULL, "yes_no", title, prompt, the_default);
sprintf(format, "%s\n\n%s [%%s] ", title, prompt);
param.set_ask_format(format);
event.type = BX_SYNC_EVT_ASK_PARAM;
event.u.param.param = &param;
sim_to_ci_event(&event);
if (event.retcode >= 0) {
return param.get();
}
else {
return event.retcode;
}
}
void bx_real_sim_c::periodic()
{
// give the GUI a chance to do periodic things on the bochs thread. in
// particular, notice if the thread has been asked to die.
BxEvent tick;
tick.type = BX_SYNC_EVT_TICK;
sim_to_ci_event (&tick);
if (tick.retcode < 0) {
BX_INFO(("Bochs thread has been asked to quit."));
#if !BX_DEBUGGER
bx_atexit();
quit_sim(0);
#else
bx_dbg_exit(0);
#endif
}
static int refresh_counter = 0;
if (++refresh_counter == 50) {
// only ask the CI to refresh every 50 times periodic() is called.
// This should obviously be configurable because system speeds and
// user preferences vary.
refresh_ci();
refresh_counter = 0;
}
}
// create a disk image file called filename, size=512 bytes * sectors.
// If overwrite is 0 and the file exists, returns -1 without changing it.
// Otherwise, opens up the image and starts writing. Returns -2 if
// the image could not be opened, or -3 if there are failures during
// write, e.g. disk full.
//
// wxWidgets: This may be called from the gui thread.
int bx_real_sim_c::create_disk_image(const char *filename, int sectors, bx_bool overwrite)
{
FILE *fp;
if (!overwrite) {
// check for existence first
fp = fopen(filename, "r");
if (fp) {
// yes it exists
fclose(fp);
return -1;
}
}
fp = fopen(filename, "w");
if (fp == NULL) {
#ifdef HAVE_PERROR
char buffer[1024];
sprintf(buffer, "while opening '%s' for writing", filename);
perror(buffer);
// not sure how to get this back into the CI
#endif
return -2;
}
int sec = sectors;
/*
* seek to sec*512-1 and write a single character.
* can't just do: fseek(fp, 512*sec-1, SEEK_SET)
* because 512*sec may be too large for signed int.
*/
while (sec > 0)
{
/* temp <-- min(sec, 4194303)
* 4194303 is (int)(0x7FFFFFFF/512)
*/
int temp = ((sec < 4194303) ? sec : 4194303);
fseek(fp, 512*temp, SEEK_CUR);
sec -= temp;
}
fseek(fp, -1, SEEK_CUR);
if (fputc('\0', fp) == EOF)
{
fclose(fp);
return -3;
}
fclose(fp);
return 0;
}
void bx_real_sim_c::refresh_ci()
{
if (SIM->has_debug_gui()) {
// presently, only wxWidgets interface uses these events
// It's an async event, so allocate a pointer and send it.
// The event will be freed by the recipient.
BxEvent *event = new BxEvent();
event->type = BX_ASYNC_EVT_REFRESH;
sim_to_ci_event(event);
}
}
bx_param_c *bx_real_sim_c::get_first_atadevice(Bit32u search_type)
{
char pname[80];
for (int channel=0; channel<BX_MAX_ATA_CHANNEL; channel++) {
sprintf(pname, "ata.%d.resources.enabled", channel);
if (!SIM->get_param_bool(pname)->get())
continue;
for (int slave=0; slave<2; slave++) {
sprintf(pname, "ata.%d.%s.present", channel, (slave==0)?"master":"slave");
Bit32u present = SIM->get_param_bool(pname)->get();
sprintf(pname, "ata.%d.%s.type", channel, (slave==0)?"master":"slave");
Bit32u type = SIM->get_param_enum(pname)->get();
if (present && (type == search_type)) {
sprintf(pname, "ata.%d.%s", channel, (slave==0)?"master":"slave");
return SIM->get_param(pname);
}
}
}
return NULL;
}
#if BX_DEBUGGER
// this can be safely called from either thread.
void bx_real_sim_c::debug_break()
{
bx_debug_break();
}
// this should only be called from the sim_thread.
void bx_real_sim_c::debug_interpret_cmd(char *cmd)
{
if (!is_sim_thread()) {
fprintf(stderr, "ERROR: debug_interpret_cmd called but not from sim_thread\n");
return;
}
bx_dbg_interpret_line(cmd);
}
char *bx_real_sim_c::debug_get_next_command()
{
BxEvent event;
event.type = BX_SYNC_EVT_GET_DBG_COMMAND;
BX_DEBUG(("asking for next debug command"));
sim_to_ci_event (&event);
BX_DEBUG(("received next debug command: '%s'", event.u.debugcmd.command));
if (event.retcode >= 0)
return event.u.debugcmd.command;
return NULL;
}
void bx_real_sim_c::debug_puts(const char *text)
{
if (SIM->has_debug_gui()) {
// send message to the wxWidgets debugger
BxEvent *event = new BxEvent();
event->type = BX_ASYNC_EVT_DBG_MSG;
event->u.logmsg.msg = text;
sim_to_ci_event(event);
// the event will be freed by the recipient
} else {
// text mode debugger: just write to console
fputs(text, stderr);
delete [] (char *)text;
}
}
#endif
void bx_real_sim_c::register_configuration_interface(
const char* name,
config_interface_callback_t callback,
void *userdata)
{
ci_callback = callback;
ci_callback_data = userdata;
registered_ci_name = name;
}
int bx_real_sim_c::configuration_interface(const char *ignore, ci_command_t command)
{
bx_param_enum_c *ci_param = SIM->get_param_enum(BXPN_SEL_CONFIG_INTERFACE);
const char *name = ci_param->get_selected();
if (!ci_callback) {
BX_PANIC(("no configuration interface was loaded"));
return -1;
}
if (strcmp(name, registered_ci_name) != 0) {
BX_PANIC(("siminterface does not support loading one configuration interface and then calling another"));
return -1;
}
if (!strcmp(name, "wx"))
debug_gui = 1;
else
debug_gui = 0;
// enter configuration mode, just while running the configuration interface
set_display_mode(DISP_MODE_CONFIG);
int retval = (*ci_callback)(ci_callback_data, command);
set_display_mode(DISP_MODE_SIM);
return retval;
}
int bx_real_sim_c::begin_simulation(int argc, char *argv[])
{
return bx_begin_simulation(argc, argv);
}
bx_bool bx_real_sim_c::is_sim_thread()
{
if (is_sim_thread_func == NULL) return 1;
return (*is_sim_thread_func)();
}
// check if the text console exists. On some platforms, if Bochs is
// started from the "Start Menu" or by double clicking on it on a Mac,
// there may be nothing attached to stdin/stdout/stderr. This function
// tests if stdin/stdout/stderr are usable and returns 0 if not.
bx_bool bx_real_sim_c::test_for_text_console()
{
#if BX_WITH_CARBON
// In a Carbon application, you have a text console if you run the app from
// the command line, but if you start it from the finder you don't.
if(!isatty(STDIN_FILENO)) return 0;
#endif
// default: yes
return 1;
}
bx_bool bx_real_sim_c::is_user_option(const char *keyword)
{
user_option_t *user_option;
for (user_option = user_options; user_option; user_option = user_option->next) {
if (!strcmp(user_option->name, keyword)) return 1;
}
return 0;
}
bx_bool bx_real_sim_c::register_user_option(const char *keyword, user_option_parser_t parser,
user_option_save_t save_func)
{
user_option_t *user_option;
user_option = (user_option_t *)malloc(sizeof(user_option_t));
if (user_option == NULL) {
BX_PANIC(("can't allocate user_option_t"));
return 0;
}
user_option->name = keyword;
user_option->parser = parser;
user_option->savefn = save_func;
user_option->next = NULL;
if (user_options == NULL) {
user_options = user_option;
} else {
user_option_t *temp = user_options;
while (temp->next) {
if (!strcmp(temp->name, keyword)) {
free(user_option);
return 0;
}
temp = temp->next;
}
temp->next = user_option;
}
return 1;
}
bx_bool bx_real_sim_c::unregister_user_option(const char *keyword)
{
user_option_t *user_option, *prev = NULL;
for (user_option = user_options; user_option; user_option = user_option->next) {
if (!strcmp(user_option->name, keyword)) {
if (prev == NULL) {
user_options = user_option->next;
} else {
prev->next = user_option->next;
}
free(user_option);
return 1;
} else {
prev = user_option;
}
}
return 0;
}
Bit32s bx_real_sim_c::parse_user_option(const char *context, int num_params, char *params [])
{
user_option_t *user_option;
for (user_option = user_options; user_option; user_option = user_option->next) {
if ((!strcmp(user_option->name, params[0])) &&
(user_option->parser != NULL)) {
return (*user_option->parser)(context, num_params, params);
}
}
return -1;
}
Bit32s bx_real_sim_c::save_user_options(FILE *fp)
{
user_option_t *user_option;
for (user_option = user_options; user_option; user_option = user_option->next) {
if (user_option->savefn != NULL) {
(*user_option->savefn)(fp);
}
}
return 0;
}
void bx_real_sim_c::init_save_restore()
{
bx_list_c *list;
if ((list = get_bochs_root()) != NULL) {
list->clear();
} else {
list = new bx_list_c(root_param,
"bochs",
"subtree for save/restore",
30 + BX_MAX_SMP_THREADS_SUPPORTED);
}
}
bx_bool bx_real_sim_c::save_state(const char *checkpoint_path)
{
char sr_file[BX_PATHNAME_LEN];
char prefix[8];
int i, dev, ndev = SIM->get_n_log_modules();
int type, ntype = SIM->get_max_log_level();
sprintf(sr_file, "%s/config", checkpoint_path);
if (write_rc(sr_file, 1) < 0)
return 0;
sprintf(sr_file, "%s/logopts", checkpoint_path);
FILE *fp = fopen(sr_file, "w");
if (fp != NULL) {
for (dev=0; dev<ndev; dev++) {
strcpy(prefix, get_prefix(dev));
strcpy(prefix, prefix+1);
prefix[strlen(prefix) - 1] = 0;
i = strlen(prefix) - 1;
while ((i >= 0) && (prefix[i] == ' ')) prefix[i--] = 0;
if (strlen(prefix) > 0) {
fprintf(fp, "%s: ", prefix);
for (type=0; type<ntype; type++) {
if (type > 0) fprintf(fp, ", ");
fprintf(fp, "%s=%s", get_log_level_name(type), get_action_name(get_log_action(dev, type)));
}
fprintf(fp, "\n");
}
}
fclose(fp);
} else {
return 0;
}
bx_list_c *sr_list = get_bochs_root();
ndev = sr_list->get_size();
for (dev=0; dev<ndev; dev++) {
sprintf(sr_file, "%s/%s", checkpoint_path, sr_list->get(dev)->get_name());
fp = fopen(sr_file, "w");
if (fp != NULL) {
save_sr_param(fp, sr_list->get(dev), checkpoint_path, 0);
fclose(fp);
} else {
return 0;
}
}
return 1;
}
bx_bool bx_real_sim_c::restore_config()
{
char config[BX_PATHNAME_LEN];
sprintf(config, "%s/config", get_param_string(BXPN_RESTORE_PATH)->getptr());
BX_INFO(("restoring '%s'", config));
return (read_rc(config) >= 0);
}
bx_bool bx_real_sim_c::restore_logopts()
{
char logopts[BX_PATHNAME_LEN];
char line[512], string[512], prefix[8];
char *ret, *ptr;
int d, i, j, dev = 0, type = 0, action = 0;
int ndev = SIM->get_n_log_modules();
FILE *fp;
sprintf(logopts, "%s/logopts", get_param_string(BXPN_RESTORE_PATH)->getptr());
BX_INFO(("restoring '%s'", logopts));
fp = fopen(logopts, "r");
if (fp != NULL) {
do {
ret = fgets(line, sizeof(line)-1, fp);
line[sizeof(line) - 1] = '\0';
int len = strlen(line);
if ((len>0) && (line[len-1] < ' '))
line[len-1] = '\0';
i = 0;
if ((ret != NULL) && strlen(line)) {
ptr = strtok(line, ":");
while (ptr) {
strcpy(string, ptr);
while (isspace(string[0])) strcpy(string, string+1);
while (isspace(string[strlen(string)-1])) string[strlen(string)-1] = 0;
if (i == 0) {
sprintf(prefix, "[%-5s]", string);
dev = -1;
for (d = 0; d < ndev; d++) {
if (!strcmp(prefix, get_prefix(d))) {
dev = d;
}
}
} else if (dev >= 0) {
j = 6;
if (!strncmp(string, "DEBUG=", 6)) {
type = LOGLEV_DEBUG;
} else if (!strncmp(string, "INFO=", 5)) {
type = LOGLEV_INFO;
j = 5;
} else if (!strncmp(string, "ERROR=", 6)) {
type = LOGLEV_ERROR;
} else if (!strncmp(string, "PANIC=", 6)) {
type = LOGLEV_PANIC;
} else if (!strncmp(string, "PASS=", 5)) {
type = LOGLEV_PASS;
j = 5;
}
if (!strcmp(string+j, "ignore")) {
action = ACT_IGNORE;
} else if (!strcmp(string+j, "report")) {
action = ACT_REPORT;
} else if (!strcmp(string+j, "ask")) {
action = ACT_ASK;
} else if (!strcmp(string+j, "fatal")) {
action = ACT_FATAL;
}
set_log_action(dev, type, action);
} else {
if (i == 1) {
BX_ERROR(("restore_logopts(): log module '%s' not found", prefix));
}
}
i++;
ptr = strtok(NULL, ",");
}
}
} while (!feof(fp));
fclose(fp);
} else {
return 0;
}
return 1;
}
bx_bool bx_real_sim_c::restore_bochs_param(bx_list_c *root, const char *sr_path, const char *restore_name)
{
char devstate[BX_PATHNAME_LEN], devdata[BX_PATHNAME_LEN];
char line[512], buf[512], pname[80];
char *ret, *ptr;
int i, j, p;
unsigned n;
bx_param_c *param = NULL;
FILE *fp, *fp2;
if (root->get_by_name(restore_name) == NULL) {
BX_ERROR(("restore_bochs_param(): unknown parameter to restore"));
return 0;
}
sprintf(devstate, "%s/%s", sr_path, restore_name);
BX_INFO(("restoring '%s'", devstate));
bx_list_c *base = root;
fp = fopen(devstate, "r");
if (fp != NULL) {
do {
ret = fgets(line, sizeof(line)-1, fp);
line[sizeof(line) - 1] = '\0';
int len = strlen(line);
if ((len>0) && (line[len-1] < ' '))
line[len-1] = '\0';
i = 0;
if ((ret != NULL) && strlen(line)) {
ptr = strtok(line, " ");
while (ptr) {
if (i == 0) {
if (!strcmp(ptr, "}")) {
base = (bx_list_c*)base->get_parent();
break;
} else {
param = get_param(ptr, base);
}
} else if (i == 2) {
if (param == NULL) {
BX_PANIC(("cannot find param!"));
}
else {
if (param->get_type() != BXT_LIST) {
param->get_param_path(pname, 80);
BX_DEBUG(("restoring parameter '%s'", pname));
}
switch (param->get_type()) {
case BXT_PARAM_NUM:
if ((ptr[0] == '0') && (ptr[1] == 'x')) {
((bx_param_num_c*)param)->set(strtoull(ptr, NULL, 16));
} else {
((bx_param_num_c*)param)->set(strtoull(ptr, NULL, 10));
}
break;
case BXT_PARAM_BOOL:
((bx_param_bool_c*)param)->set(!strcmp(ptr, "true"));
break;
case BXT_PARAM_ENUM:
((bx_param_enum_c*)param)->set_by_name(ptr);
break;
case BXT_PARAM_STRING:
if (((bx_param_string_c*)param)->get_options()->get() & bx_param_string_c::RAW_BYTES) {
p = 0;
for (j = 0; j < ((bx_param_string_c*)param)->get_maxsize(); j++) {
if (ptr[p] == ((bx_param_string_c*)param)->get_separator()) {
p++;
}
if (sscanf(ptr+p, "%02x", &n) == 1) {
buf[j] = n;
p += 2;
}
}
((bx_param_string_c*)param)->set(buf);
} else {
((bx_param_string_c*)param)->set(ptr);
}
break;
case BXT_PARAM_DATA:
sprintf(devdata, "%s/%s", sr_path, ptr);
fp2 = fopen(devdata, "rb");
if (fp2 != NULL) {
fread(((bx_shadow_data_c*)param)->getptr(), 1, ((bx_shadow_data_c*)param)->get_size(), fp2);
fclose(fp2);
}
break;
case BXT_LIST:
base = (bx_list_c*)param;
break;
default:
BX_ERROR(("restore_sr_param(): unknown parameter type"));
}
}
}
i++;
ptr = strtok(NULL, " ");
}
}
} while (!feof(fp));
fclose(fp);
} else {
BX_ERROR(("restore_bochs_param(): error in file open"));
return 0;
}
return 1;
}
bx_bool bx_real_sim_c::restore_hardware()
{
bx_list_c *sr_list = get_bochs_root();
int ndev = sr_list->get_size();
for (int dev=0; dev<ndev; dev++) {
if (!restore_bochs_param(sr_list, get_param_string(BXPN_RESTORE_PATH)->getptr(), sr_list->get(dev)->get_name()))
return 0;
}
return 1;
}
bx_bool bx_real_sim_c::save_sr_param(FILE *fp, bx_param_c *node, const char *sr_path, int level)
{
int i;
Bit64s value;
char tmpstr[BX_PATHNAME_LEN], tmpbyte[4];
FILE *fp2;
for (i=0; i<level; i++)
fprintf(fp, " ");
if (node == NULL) {
BX_ERROR(("NULL pointer"));
return 0;
}
fprintf(fp, "%s = ", node->get_name());
switch (node->get_type()) {
case BXT_PARAM_NUM:
value = ((bx_param_num_c*)node)->get64();
if (((bx_param_num_c*)node)->get_base() == BASE_DEC) {
if (((bx_param_num_c*)node)->get_min() >= BX_MIN_BIT64U) {
if ((Bit64u)((bx_param_num_c*)node)->get_max() > BX_MAX_BIT32U) {
fprintf(fp, FMT_LL"u\n", value);
} else {
fprintf(fp, "%u\n", (Bit32u) value);
}
} else {
fprintf(fp, "%d\n", (Bit32s) value);
}
} else {
if (node->get_format()) {
fprintf(fp, node->get_format(), value);
} else {
if ((Bit64u)((bx_param_num_c*)node)->get_max() > BX_MAX_BIT32U) {
fprintf(fp, "0x"FMT_LL"x", (Bit64u) value);
} else {
fprintf(fp, "0x%x", (Bit32u) value);
}
}
fprintf(fp, "\n");
}
break;
case BXT_PARAM_BOOL:
fprintf(fp, "%s\n", ((bx_param_bool_c*)node)->get()?"true":"false");
break;
case BXT_PARAM_ENUM:
fprintf(fp, "%s\n", ((bx_param_enum_c*)node)->get_selected());
break;
case BXT_PARAM_STRING:
if (((bx_param_string_c*)node)->get_options()->get() & bx_param_string_c::RAW_BYTES) {
tmpstr[0] = 0;
for (i = 0; i < ((bx_param_string_c*)node)->get_maxsize(); i++) {
if (i > 0) {
tmpbyte[0] = ((bx_param_string_c*)node)->get_separator();
tmpbyte[1] = 0;
strcat(tmpstr, tmpbyte);
}
sprintf(tmpbyte, "%02x", (Bit8u)((bx_param_string_c*)node)->getptr()[i]);
strcat(tmpstr, tmpbyte);
}
fprintf(fp, "%s\n", tmpstr);
} else {
fprintf(fp, "%s\n", ((bx_param_string_c*)node)->getptr());
}
break;
case BXT_PARAM_DATA:
fprintf(fp, "%s.%s\n", node->get_parent()->get_name(), node->get_name());
if (sr_path)
sprintf(tmpstr, "%s/%s.%s", sr_path, node->get_parent()->get_name(), node->get_name());
else
sprintf(tmpstr, "%s.%s", node->get_parent()->get_name(), node->get_name());
fp2 = fopen(tmpstr, "wb");
if (fp2 != NULL) {
fwrite(((bx_shadow_data_c*)node)->getptr(), 1, ((bx_shadow_data_c*)node)->get_size(), fp2);
fclose(fp2);
}
break;
case BXT_LIST:
{
fprintf(fp, "{\n");
bx_list_c *list = (bx_list_c*)node;
for (i=0; i < list->get_size(); i++) {
save_sr_param(fp, list->get(i), sr_path, level+1);
}
for (i=0; i<level; i++)
fprintf(fp, " ");
fprintf(fp, "}\n");
break;
}
default:
BX_ERROR(("save_sr_param(): unknown parameter type"));
return 0;
}
return 1;
}
/////////////////////////////////////////////////////////////////////////
// define methods of bx_param_* and family
/////////////////////////////////////////////////////////////////////////
const char* bx_param_c::default_text_format = NULL;
bx_param_c::bx_param_c(Bit32u id, const char *param_name, const char *param_desc)
: bx_object_c(id),
parent(NULL),
description(NULL),
label(NULL),
ask_format(NULL),
group_name(NULL)
{
set_type(BXT_PARAM);
this->name = new char[strlen(param_name)+1];
strcpy(this->name, param_name);
set_description(param_desc);
this->text_format = default_text_format;
this->long_text_format = default_text_format;
this->runtime_param = 0;
this->enabled = 1;
}
bx_param_c::bx_param_c(Bit32u id, const char *param_name, const char *param_label, const char *param_desc)
: bx_object_c(id),
parent(NULL),
description(NULL),
label(NULL),
ask_format(NULL),
group_name(NULL)
{
set_type(BXT_PARAM);
this->name = new char[strlen(param_name)+1];
strcpy(this->name, param_name);
set_description(param_desc);
set_label(param_label);
this->text_format = default_text_format;
this->long_text_format = default_text_format;
this->runtime_param = 0;
this->enabled = 1;
}
bx_param_c::~bx_param_c()
{
delete [] name;
delete [] label;
delete [] description;
delete [] ask_format;
delete [] group_name;
}
void bx_param_c::set_description(const char *text)
{
delete [] this->description;
if (text) {
this->description = new char[strlen(text)+1];
strcpy(this->description, text);
} else {
this->description = NULL;
}
}
void bx_param_c::set_label(const char *text)
{
delete [] this->label;
if (text) {
this->label = new char[strlen(text)+1];
strcpy(this->label, text);
} else {
this->label = NULL;
}
}
void bx_param_c::set_ask_format(const char *format)
{
delete [] this->ask_format;
if (format) {
this->ask_format = new char[strlen(format)+1];
strcpy(this->ask_format, format);
} else {
this->ask_format = NULL;
}
}
void bx_param_c::set_group(const char *group)
{
delete [] this->group_name;
if (group) {
this->group_name = new char[strlen(group)+1];
strcpy(this->group_name, group);
} else {
this->group_name = NULL;
}
}
int bx_param_c::get_param_path(char *path_out, int maxlen)
{
if ((get_parent() == NULL) || (get_parent() == root_param)) {
// Start with an empty string.
// Never print the name of the root param.
path_out[0] = 0;
} else {
// build path of the parent, add a period, add path of this node
if (get_parent()->get_param_path(path_out, maxlen) > 0) {
strncat(path_out, ".", maxlen);
}
}
strncat(path_out, name, maxlen);
return strlen(path_out);
}
const char* bx_param_c::set_default_format(const char *f)
{
const char *old = default_text_format;
default_text_format = f;
return old;
}
bx_param_num_c::bx_param_num_c(bx_param_c *parent,
const char *name,
const char *label,
const char *description,
Bit64s min, Bit64s max, Bit64s initial_val,
bx_bool is_shadow)
: bx_param_c(SIM->gen_param_id(), name, label, description)
{
set_type(BXT_PARAM_NUM);
this->min = min;
this->max = max;
this->initial_val = initial_val;
this->val.number = initial_val;
this->handler = NULL;
this->save_handler = NULL;
this->restore_handler = NULL;
this->enable_handler = NULL;
this->base = default_base;
this->is_shadow = is_shadow;
// dependent_list must be initialized before the set(),
// because set calls update_dependents().
dependent_list = NULL;
if (!is_shadow) {
set(initial_val);
}
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
}
Bit32u bx_param_num_c::default_base = BASE_DEC;
Bit32u bx_param_num_c::set_default_base(Bit32u val)
{
Bit32u old = default_base;
default_base = val;
return old;
}
void bx_param_num_c::set_handler(param_event_handler handler)
{
this->handler = handler;
// now that there's a handler, call set once to run the handler immediately
//set (get ());
}
void bx_param_num_c::set_sr_handlers(void *devptr, param_sr_handler save, param_sr_handler restore)
{
this->sr_devptr = devptr;
this->save_handler = save;
this->restore_handler = restore;
}
void bx_param_num_c::set_dependent_list(bx_list_c *l)
{
dependent_list = l;
update_dependents();
}
Bit64s bx_param_num_c::get64()
{
if (save_handler) {
return (*save_handler)(sr_devptr, this, val.number);
}
if (handler) {
// the handler can decide what value to return and/or do some side effect
return (*handler)(this, 0, val.number);
} else {
// just return the value
return val.number;
}
}
void bx_param_num_c::set(Bit64s newval)
{
if (handler) {
// the handler can override the new value and/or perform some side effect
val.number = newval;
(*handler)(this, 1, newval);
} else {
// just set the value. This code does not check max/min.
val.number = newval;
}
if (restore_handler) {
val.number = newval;
(*restore_handler)(sr_devptr, this, newval);
}
if ((val.number < min || val.number > max) && (Bit64u)max != BX_MAX_BIT64U)
BX_PANIC(("numerical parameter '%s' was set to " FMT_LL "d, which is out of range " FMT_LL "d to " FMT_LL "d", get_name (), val.number, min, max));
if (dependent_list != NULL) update_dependents();
}
void bx_param_num_c::set_range(Bit64u min, Bit64u max)
{
this->min = min;
this->max = max;
}
void bx_param_num_c::set_initial_val(Bit64s initial_val)
{
this->val.number = this->initial_val = initial_val;
}
void bx_param_num_c::update_dependents()
{
if (dependent_list) {
int en = val.number && enabled;
for (int i=0; i<dependent_list->get_size(); i++) {
bx_param_c *param = dependent_list->get(i);
if (param != this)
param->set_enabled(en);
}
}
}
void bx_param_num_c::set_enabled(int en)
{
// The enable handler may wish to allow/disallow the action
if (enable_handler) {
en = (*enable_handler)(this, en);
}
bx_param_c::set_enabled(en);
update_dependents();
}
// Signed 64 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit64s *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT64S, BX_MAX_BIT64S, *ptr_to_real_val, 1)
{
this->varsize = 64;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT64S >> (63 - (highbit - lowbit))) << lowbit);
val.p64bit = ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x"FMT_LL"x";
}
}
// Unsigned 64 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit64u *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT64U, BX_MAX_BIT64U, *ptr_to_real_val, 1)
{
this->varsize = 64;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT64U >> (63 - (highbit - lowbit))) << lowbit);
val.p64bit = (Bit64s*) ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x"FMT_LL"x";
}
}
// Signed 32 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit32s *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT32S, BX_MAX_BIT32S, *ptr_to_real_val, 1)
{
this->varsize = 32;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT32S >> (31 - (highbit - lowbit))) << lowbit);
val.p32bit = ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x%08x";
}
}
// Unsigned 32 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit32u *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT32U, BX_MAX_BIT32U, *ptr_to_real_val, 1)
{
this->varsize = 32;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT32U >> (31 - (highbit - lowbit))) << lowbit);
val.p32bit = (Bit32s*) ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x%08x";
}
}
// Signed 16 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit16s *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT16S, BX_MAX_BIT16S, *ptr_to_real_val, 1)
{
this->varsize = 16;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT16S >> (15 - (highbit - lowbit))) << lowbit);
val.p16bit = ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x%04x";
}
}
// Unsigned 16 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit16u *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT16U, BX_MAX_BIT16U, *ptr_to_real_val, 1)
{
this->varsize = 16;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT16U >> (15 - (highbit - lowbit))) << lowbit);
val.p16bit = (Bit16s*) ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x%04x";
}
}
// Signed 8 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit8s *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT8S, BX_MAX_BIT8S, *ptr_to_real_val, 1)
{
this->varsize = 8;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT8S >> (7 - (highbit - lowbit))) << lowbit);
this->mask = (1 << (highbit - lowbit)) - 1;
val.p8bit = ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x%02x";
}
}
// Unsigned 8 bit
bx_shadow_num_c::bx_shadow_num_c(bx_param_c *parent,
const char *name,
Bit8u *ptr_to_real_val,
int base,
Bit8u highbit,
Bit8u lowbit)
: bx_param_num_c(parent, name, NULL, NULL, BX_MIN_BIT8U, BX_MAX_BIT8U, *ptr_to_real_val, 1)
{
this->varsize = 8;
this->lowbit = lowbit;
this->mask = ((BX_MAX_BIT8U >> (7 - (highbit - lowbit))) << lowbit);
val.p8bit = (Bit8s*) ptr_to_real_val;
if (base == BASE_HEX) {
this->base = base;
this->text_format = "0x%02x";
}
}
Bit64s bx_shadow_num_c::get64()
{
Bit64u current = 0;
switch (varsize) {
case 8: current = *(val.p8bit); break;
case 16: current = *(val.p16bit); break;
case 32: current = *(val.p32bit); break;
case 64: current = *(val.p64bit); break;
default: BX_PANIC(("unsupported varsize %d", varsize));
}
current = (current >> lowbit) & mask;
if (handler) {
// the handler can decide what value to return and/or do some side effect
return (*handler)(this, 0, current) & mask;
} else {
// just return the value
return current;
}
}
void bx_shadow_num_c::set(Bit64s newval)
{
Bit64u tmp = 0;
if (((newval < min) || (newval > max)) && (min != BX_MIN_BIT64S) && ((Bit64u)max != BX_MAX_BIT64U))
BX_PANIC(("numerical parameter %s was set to " FMT_LL "d, which is out of range " FMT_LL "d to " FMT_LL "d", get_name (), newval, min, max));
switch (varsize) {
case 8:
tmp = *(val.p8bit) & ~(mask << lowbit);
tmp |= (newval & mask) << lowbit;
*(val.p8bit) = (Bit8s)tmp;
break;
case 16:
tmp = *(val.p16bit) & ~(mask << lowbit);
tmp |= (newval & mask) << lowbit;
*(val.p16bit) = (Bit16s)tmp;
break;
case 32:
tmp = *(val.p32bit) & ~(mask << lowbit);
tmp |= (newval & mask) << lowbit;
*(val.p32bit) = (Bit32s)tmp;
break;
case 64:
tmp = *(val.p64bit) & ~(mask << lowbit);
tmp |= (newval & mask) << lowbit;
*(val.p64bit) = (Bit64s)tmp;
break;
default:
BX_PANIC(("unsupported varsize %d", varsize));
}
if (handler) {
// the handler can override the new value and/or perform some side effect
(*handler)(this, 1, tmp);
}
}
void bx_shadow_num_c::reset()
{
BX_PANIC(("reset not supported on bx_shadow_num_c yet"));
}
bx_param_bool_c::bx_param_bool_c(bx_param_c *parent,
const char *name,
const char *label,
const char *description,
Bit64s initial_val,
bx_bool is_shadow)
: bx_param_num_c(parent, name, label, description, 0, 1, initial_val, is_shadow)
{
set_type(BXT_PARAM_BOOL);
}
bx_shadow_bool_c::bx_shadow_bool_c(bx_param_c *parent,
const char *name,
const char *label,
bx_bool *ptr_to_real_val,
Bit8u bitnum)
: bx_param_bool_c(parent, name, label, NULL, (Bit64s) *ptr_to_real_val, 1)
{
val.pbool = ptr_to_real_val;
this->bitnum = bitnum;
}
bx_shadow_bool_c::bx_shadow_bool_c(bx_param_c *parent,
const char *name,
bx_bool *ptr_to_real_val,
Bit8u bitnum)
: bx_param_bool_c(parent, name, NULL, NULL, (Bit64s) *ptr_to_real_val, 1)
{
val.pbool = ptr_to_real_val;
this->bitnum = bitnum;
}
Bit64s bx_shadow_bool_c::get64()
{
if (handler) {
// the handler can decide what value to return and/or do some side effect
Bit64s ret = (*handler)(this, 0, (Bit64s) *(val.pbool));
return (ret>>bitnum) & 1;
} else {
// just return the value
return (*(val.pbool)) & 1;
}
}
void bx_shadow_bool_c::set(Bit64s newval)
{
// only change the bitnum bit
Bit64s tmp = (newval&1) << bitnum;
*(val.pbool) &= ~tmp;
*(val.pbool) |= tmp;
if (handler) {
// the handler can override the new value and/or perform some side effect
(*handler)(this, 1, newval&1);
}
}
bx_param_enum_c::bx_param_enum_c(bx_param_c *parent,
const char *name,
const char *label,
const char *description,
const char **choices,
Bit64s initial_val,
Bit64s value_base)
: bx_param_num_c(parent, name, label, description, value_base, BX_MAX_BIT64S, initial_val)
{
set_type(BXT_PARAM_ENUM);
this->choices = choices;
// count number of choices, set max
const char **p = choices;
while (*p != NULL) p++;
this->min = value_base;
// now that the max is known, replace the BX_MAX_BIT64S sent to the parent
// class constructor with the real max.
this->max = value_base + (p - choices - 1);
set(initial_val);
}
int bx_param_enum_c::find_by_name(const char *string)
{
const char **p;
for (p=&choices[0]; *p; p++) {
if (!strcmp(string, *p))
return p-choices;
}
return -1;
}
bx_bool bx_param_enum_c::set_by_name(const char *string)
{
int n = find_by_name(string);
if (n<0) return 0;
set(n + min);
return 1;
}
bx_param_string_c::bx_param_string_c(bx_param_c *parent,
const char *name,
const char *label,
const char *description,
const char *initial_val,
int maxsize)
: bx_param_c(SIM->gen_param_id(), name, label, description)
{
set_type(BXT_PARAM_STRING);
int initial_val_size = strlen(initial_val) + 1;
if (maxsize < 0) {
maxsize = initial_val_size;
} else if (initial_val_size > maxsize) {
initial_val_size = maxsize;
}
this->val = new char[maxsize];
this->initial_val = new char[maxsize];
this->handler = NULL;
this->enable_handler = NULL;
this->maxsize = maxsize;
strncpy(this->val, initial_val, initial_val_size);
if (maxsize > initial_val_size)
memset(this->val + initial_val_size, 0, maxsize - initial_val_size);
strncpy(this->initial_val, initial_val, maxsize);
this->options = new bx_param_num_c(NULL,
"stringoptions", NULL, NULL, 0, BX_MAX_BIT64S, 0);
set(initial_val);
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
}
bx_param_filename_c::bx_param_filename_c(bx_param_c *parent,
const char *name,
const char *label,
const char *description,
const char *initial_val,
int maxsize)
: bx_param_string_c(parent, name, label, description, initial_val, maxsize)
{
get_options()->set(IS_FILENAME);
}
bx_param_string_c::~bx_param_string_c()
{
if (val != NULL) delete [] val;
if (initial_val != NULL) delete [] initial_val;
if (options != NULL) delete options;
}
void bx_param_string_c::reset()
{
set(initial_val);
}
void bx_param_string_c::set_handler(param_string_event_handler handler)
{
this->handler = handler;
}
void bx_param_string_c::set_enable_handler(param_enable_handler handler)
{
this->enable_handler = handler;
}
void bx_param_string_c::set_enabled(int en)
{
// The enable handler may wish to allow/disallow the action
if (enable_handler) {
en = (*enable_handler)(this, en);
}
bx_param_c::set_enabled(en);
}
Bit32s bx_param_string_c::get(char *buf, int len)
{
if (options->get() & RAW_BYTES)
memcpy(buf, val, len);
else
strncpy(buf, val, len);
if (handler) {
// the handler can choose to replace the value in val/len. Also its
// return value is passed back as the return value of get.
(*handler)(this, 0, buf, buf, len);
}
return 0;
}
void bx_param_string_c::set(const char *buf)
{
char *oldval = new char[maxsize];
if (options->get() & RAW_BYTES) {
memcpy(oldval, val, maxsize);
memcpy(val, buf, maxsize);
} else {
strncpy(oldval, val, maxsize);
oldval[maxsize - 1] = 0;
strncpy(val, buf, maxsize);
val[maxsize - 1] = 0;
}
if (handler) {
// the handler can return a different char* to be copied into the value
buf = (*handler)(this, 1, oldval, buf, -1);
}
delete [] oldval;
}
bx_bool bx_param_string_c::equals(const char *buf)
{
if (options->get() & RAW_BYTES)
return (memcmp(val, buf, maxsize) == 0);
else
return (strncmp(val, buf, maxsize) == 0);
}
void bx_param_string_c::set_initial_val(const char *buf)
{
if (options->get() & RAW_BYTES)
memcpy(initial_val, buf, maxsize);
else
strncpy(initial_val, buf, maxsize);
set(initial_val);
}
bx_shadow_data_c::bx_shadow_data_c(bx_param_c *parent,
const char *name,
Bit8u *ptr_to_data,
Bit32u data_size)
: bx_param_c(SIM->gen_param_id(), name, "")
{
set_type(BXT_PARAM_DATA);
this->data_ptr = ptr_to_data;
this->data_size = data_size;
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
}
bx_list_c::bx_list_c(bx_param_c *parent, int maxsize)
: bx_param_c(SIM->gen_param_id(), "list", "")
{
set_type(BXT_LIST);
this->size = 0;
this->maxsize = maxsize;
this->list = new bx_param_c* [maxsize];
this->parent = NULL;
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
init("");
}
bx_list_c::bx_list_c(bx_param_c *parent, const char *name, int maxsize)
: bx_param_c(SIM->gen_param_id(), name, "")
{
set_type (BXT_LIST);
this->size = 0;
this->maxsize = maxsize;
this->list = new bx_param_c* [maxsize];
this->parent = NULL;
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
init("");
}
bx_list_c::bx_list_c(bx_param_c *parent, const char *name, const char *title,
int maxsize)
: bx_param_c(SIM->gen_param_id(), name, "")
{
set_type (BXT_LIST);
this->size = 0;
this->maxsize = maxsize;
this->list = new bx_param_c* [maxsize];
this->parent = NULL;
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
init(title);
}
bx_list_c::bx_list_c(bx_param_c *parent, const char *name, const char *title, bx_param_c **init_list)
: bx_param_c(SIM->gen_param_id(), name, "")
{
set_type(BXT_LIST);
this->size = 0;
while (init_list[this->size] != NULL)
this->size++;
this->maxsize = this->size;
this->list = new bx_param_c* [maxsize];
for (int i=0; i<this->size; i++)
this->list[i] = init_list[i];
this->parent = NULL;
if (parent) {
BX_ASSERT(parent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)parent;
this->parent->add(this);
}
init(title);
}
bx_list_c::~bx_list_c()
{
if (list != NULL) {
for (int i=0; i<this->size; i++) {
delete list[i];
}
delete [] list;
}
if (title != NULL) delete title;
if (options != NULL) delete options;
if (choice != NULL) delete choice;
}
void bx_list_c::init(const char *list_title)
{
// the title defaults to the name
this->title = new bx_param_string_c(NULL,
"list_title",
"", "",
get_name(), 80);
if ((list_title != NULL) && (strlen(list_title) > 0)) {
this->title->set((char *)list_title);
}
this->options = new bx_param_num_c(NULL,
"list_option", "", "", 0, BX_MAX_BIT64S, 0);
this->choice = new bx_param_num_c(NULL,
"list_choice", "", "", 0, BX_MAX_BIT64S, 1);
}
void bx_list_c::set_parent(bx_param_c *newparent)
{
if (parent) {
// if this object already had a parent, the correct thing
// to do would be to remove this object from the parent's
// list of children. Deleting children is currently
// not supported.
BX_PANIC(("bx_list_c::set_parent: changing from one parent to another is not supported"));
}
if (newparent) {
BX_ASSERT(newparent->get_type() == BXT_LIST);
this->parent = (bx_list_c *)newparent;
this->parent->add(this);
}
}
bx_list_c* bx_list_c::clone()
{
bx_list_c *newlist = new bx_list_c(NULL, name, title->getptr(), maxsize);
for (int i=0; i<get_size(); i++)
newlist->add(get(i));
newlist->get_options()->set(options->get());
return newlist;
}
void bx_list_c::add(bx_param_c *param)
{
if (size >= maxsize) {
BX_PANIC(("add param '%s' to bx_list_c '%s': list capacity exceeded",
param->get_name(), get_name()));
return;
}
list[size] = param;
size++;
}
bx_param_c* bx_list_c::get(int index)
{
BX_ASSERT(index >= 0 && index < size);
return list[index];
}
bx_param_c* bx_list_c::get_by_name(const char *name)
{
int imax = get_size();
for (int i=0; i<imax; i++) {
bx_param_c *p = get(i);
if (!stricmp(name, p->get_name())) {
return p;
}
}
return NULL;
}
void bx_list_c::reset()
{
int imax = get_size();
for (int i=0; i<imax; i++) {
get(i)->reset();
}
}
void bx_list_c::clear()
{
int imax = get_size();
for (int i=0; i<imax; i++) {
bx_param_c *param = get(i);
delete param;
}
size = 0;
}
void bx_list_c::remove(const char *name)
{
int imax = get_size();
int found = 0;
for (int i=0; i<imax; i++) {
bx_param_c *p = get(i);
if (!found && !stricmp(name, p->get_name())) {
delete p;
found = 1;
}
if (found) {
list[i] = list[i+1];
}
}
if (found) {
size--;
}
}
Reference in New Issue View Git Blame Copy Permalink