9 #include <readline/readline.h>
15 * shell-like driver for dcpu16 core
16 * provides a basic interface to control a single emulation instance
18 * Justin Wind <justin.wind@gmail.com>
19 * 2012 04 10 - implementation started
20 * 2012 04 12 - cleanup, better shell loop
23 * handle quotes in shell command parsing
24 * use readline/history.h, since we're using readline anyhow
25 * ncurses windowing or something, for future display capabilities
28 static const char * const src_id_
= "$Id$";
30 /* global invocation options */
37 /* global run state, first sigint caught will drop out of run loop and back into shell */
38 static volatile unsigned int running_
= 0;
40 void sigint_handler_(int sig
) {
45 #define VERBOSE_PRINTF(...) do { if (opt_.verbose) printf(__VA_ARGS__); } while (0)
48 void usage_(char *prog
, unsigned int full
) {
49 FILE *f
= full
? stdout
: stderr
;
50 char *x
= strrchr(prog
, '/');
56 fprintf(f
, "%s -- dcpu16 emulator core shell\n\n",
59 fprintf(f
, "Usage: %s [-v] [file]\n",
63 fprintf(f
, "\nOptions:\n"
64 "\t [file] -- ram image to load initially\n"
65 "\t -v -- displays slightly more information\n"
66 "\t -h -- this screen\n");
68 fprintf(f
, "\n%78s\n", src_id_
);
73 /* flense a buffer into a newly-allocated argument list */
75 int buf_tok_vect_(char ***v
, int *c
, char *buf
) {
76 const char *sep
= " \t";
77 const char *quot
= "\"'`";
78 const size_t v_grow
= 32;
83 *v
= malloc(v_sz
* sizeof **v
);
85 fprintf(stderr
, "%s():%s\n", "malloc", strerror(errno
));
89 for ( (*v
)[*c
] = strqtok_r(buf
, sep
, '\\', quot
, &qt
, &st
);
91 (*v
)[*c
] = strqtok_r(NULL
, sep
, '\\', quot
, &qt
, &st
)
95 if ((size_t)(*c
) == v_sz
) {
96 void *tmp_ptr
= realloc(*v
, (v_sz
+ v_grow
) * sizeof **v
);
97 if (tmp_ptr
== NULL
) {
98 fprintf(stderr
, "%s():%s\n", "realloc", strerror(errno
));
111 resets the vm if addr is zero then
112 loads an image from filename into ram starting at addr
115 int file_load_(struct dcpu16
*vm
, char *filename
, DCPU16_WORD addr
) {
122 f
= fopen(filename
, "rb");
124 fprintf(stderr
, "%s('%s'):%s\n", "fopen", filename
, strerror(errno
));
128 r
= fread(vm
->ram
+ addr
, sizeof(DCPU16_WORD
), DCPU16_RAM
- addr
, f
);
129 VERBOSE_PRINTF("read %zu words", r
);
130 if (addr
) VERBOSE_PRINTF(" starting at 0x%04x", addr
);
131 VERBOSE_PRINTF("\n");
134 fprintf(stderr
, "%s('%s'):%s\n", "fread", filename
, strerror(errno
));
141 Here follows the various commands the shell can execute.
143 At invocation, a command function will have already had its
144 number of arguments vetted, but will need command-specific
145 argument verifications done.
147 The arg_vector contains the command as the first entry, and
148 as such, arg_count will always be at least 1.
149 However, the args_min and args_max entries in struct command_
150 only refer to the counts of arguments, not the entries in the
158 int (*func
)(struct dcpu16
*, int c
, char **v
);
159 void (*help
)(FILE *f
, unsigned int);
162 #define COMMAND_IMPL(x) static int command_##x##_(struct dcpu16 *vm, int arg_count, char **arg_vector)
163 #define COMMAND_HELP(x) static void command_##x##_help_(FILE *f, unsigned int summary)
164 #define COMMAND_ENTRY(x, y, z) { #x, y, z, command_##x##_, command_##x##_help_ }
168 (void)vm
, (void)arg_count
, (void)arg_vector
;
173 fprintf(f
, "\tquit\n");
176 fprintf(f
, "Exits the emulator.\n");
180 COMMAND_IMPL(reset
) {
181 (void)arg_count
, (void)arg_vector
;
184 printf("initialized\n");
187 COMMAND_HELP(reset
) {
188 fprintf(f
, "\treset\n");
191 fprintf(f
, "Clears and reinitializes emulator.\n");
199 addr
= str_to_word(arg_vector
[2]);
201 fprintf(stderr
, "address '%s' is not a valid word: %s\n", arg_vector
[2], strerror(errno
));
206 if (file_load_(vm
, arg_vector
[1], addr
)) {
207 fprintf(stderr
, "failed to load '%s'\n", arg_vector
[1]);
210 printf("loaded '%s'", arg_vector
[1]);
211 if (addr
) printf(" starting at 0x%04x", addr
);
217 fprintf(f
, "\tload file [addr]\n");
220 fprintf(f
, "Load binary image from 'file' into ram.\n");
228 for (i
= 1; i
< arg_count
; i
++) {
229 addr
[i
-1] = str_to_word(arg_vector
[i
]);
231 fprintf(stderr
, "address '%s' is not a valid word: %s\n", arg_vector
[i
], strerror(errno
));
235 if (arg_count
< 2) addr
[0] = vm
->pc
;
236 if (arg_count
< 3) addr
[1] = addr
[0];
238 if (addr
[1] < addr
[0]) {
239 fprintf(stderr
, "\t'addr_start' must be before addr_end\n");
243 dcpu16_dump_ram(vm
, addr
[0], addr
[1]);
248 fprintf(f
, "\tdump [addr_start [addr_end]]\n");
251 fprintf(f
, "Displays contents of ram from addr_start to addr_end.\n");
255 COMMAND_IMPL(disassemble
) {
259 for (i
= 1; i
< arg_count
; i
++) {
260 addr
[i
-1] = str_to_word(arg_vector
[i
]);
262 fprintf(stderr
, "address '%s' is not a valid word: %s\n", arg_vector
[i
], strerror(errno
));
266 if (arg_count
< 2) addr
[0] = vm
->pc
;
267 if (arg_count
< 3) addr
[1] = addr
[0];
269 if (addr
[1] < addr
[0]) {
270 fprintf(stderr
, "\t'addr_start' must be before addr_end\n");
274 for (i
= addr
[0]; i
<= addr
[1]; /* */ ) {
275 printf("0x%04x: ", i
);
276 i
+= dcpu16_disassemble_print(vm
, i
);
282 COMMAND_HELP(disassemble
) {
283 fprintf(f
, "\tdisassemble [addr_start [addr_end]]\n");
286 fprintf(f
, "Displays contents of ram parsed into instructions.\n");
291 unsigned long count
= 1;
294 if (arg_count
== 2) {
296 count
= strtoul(arg_vector
[1], &ep
, 0);
298 || !(*arg_vector
[0] && *ep
== '\0') ) {
299 fprintf(stderr
, "count '%s' is not a valid number: %s\n", arg_vector
[1], strerror(errno
));
304 fprintf(stderr
, "count must be positive\n");
310 dcpu16_disassemble_print(vm
, vm
->pc
);
314 if (count
> 1 && opt_
.verbose
)
315 dcpu16_state_print(vm
);
321 fprintf(f
, "\tstep [count]\n");
324 fprintf(f
, "Executes the next instruction, or the next count instructions.\n");
330 (void)arg_count
, (void)arg_vector
;
334 /* install our new interrupt signal handler */
335 if ( (osig
= signal(SIGINT
, sigint_handler_
)) == SIG_ERR
) {
336 fprintf(stderr
, "%s():%s\n", "signal", strerror(errno
));
342 if (opt_
.verbose
> 1)
343 dcpu16_state_print(vm
);
344 else if (opt_
.verbose
) {
345 dcpu16_disassemble_print(vm
, vm
->pc
);
350 /* restore the old interrupt signal handler */
351 if (signal(SIGINT
, osig
) == SIG_ERR
) {
352 fprintf(stderr
, "%s():%s\n", "signal", strerror(errno
));
356 printf("interrupted...\n");
361 fprintf(f
, "\trun\n");
364 fprintf(f
, "Begins executing continuously.\n"
365 "May be interrupted with SIGINT.\n");
368 /* gather all these together into a searchable table */
370 /* help command gets some assistance in declarations */
374 static struct command_ command_table_
[] = {
375 COMMAND_ENTRY(help
, 0, -1),
376 COMMAND_ENTRY(quit
, 0, -1),
377 COMMAND_ENTRY(load
, 1, 2),
378 COMMAND_ENTRY(dump
, 0, 2),
379 COMMAND_ENTRY(disassemble
, 0, 2),
380 COMMAND_ENTRY(step
, 0, 1),
381 COMMAND_ENTRY(run
, 0, 0),
382 COMMAND_ENTRY(reset
, 0, 0),
383 { NULL
, 0, 0, NULL
, NULL
}
390 if (arg_count
== 2) {
391 for (c
= command_table_
; c
->func
; c
++) {
392 if (strcasecmp(arg_vector
[1], c
->name
) == 0) {
401 for (c
= command_table_
; c
->func
; c
++) {
408 fprintf(f
, "\thelp [command]\n");
411 fprintf(f
, "Displays a list of available commands, or detailed help on a specific command.\n");
415 int main(int argc
, char **argv
) {
416 const char prompt_fmt
[] = "PC:%04x> ";
419 char *line
, *line_prev
;
420 char **tok_v
, **tok_v_prev
;
421 int tok_c
, tok_c_prev
;
424 while ( (c
= getopt(argc
, argv
, "hv")) != EOF
) {
439 if (opt_
.verbose
< 1) {
440 dcpu16_warn_cb_set(NULL
);
441 dcpu16_trace_cb_set(NULL
);
442 } else if (opt_
.verbose
< 2) {
443 dcpu16_trace_cb_set(NULL
);
448 if ((vm
= dcpu16_new()) == NULL
) {
449 fprintf(stderr
, "could not allocate new dcpu16 instance\n");
450 exit(EX_UNAVAILABLE
);
454 if (file_load_(vm
, *argv
, 0)) {
455 fprintf(stderr
, "couldn't load '%s'\n", *argv
);
460 /* show state, read commands */
461 for (line
= line_prev
= NULL
,
462 tok_v
= tok_v_prev
= NULL
,
463 tok_c
= tok_c_prev
= 0,
464 snprintf(prompt
, sizeof prompt
, prompt_fmt
, vm
->pc
),
465 dcpu16_state_print(vm
);
467 (line
= readline(prompt
));
470 snprintf(prompt
, sizeof prompt
, prompt_fmt
, vm
->pc
),
471 dcpu16_state_print(vm
)) {
472 const char whitespace
[] = " \t";
477 /* skip whitespaces */
478 line_start
= line
+ strspn(line
, whitespace
);
481 /* a new command, remember previous for possible repetition */
483 /* turn new line into new arg array */
484 if (buf_tok_vect_(&tok_v
, &tok_c
, line_start
)) {
485 fprintf(stderr
, "failed to process command\n");
489 /* and keep track if it all for the next time around */
490 if (line_prev
) free(line_prev
);
493 if (tok_v_prev
) free(tok_v_prev
);
497 /* blank new command, but no prior command to repeat? ask again */
498 if (tok_v_prev
== NULL
|| tok_v_prev
[0] == NULL
|| *(tok_v_prev
[0]) == '\0') {
503 /* otherwise discard new line and promote prior */
510 /* look up command */
511 for (c
= command_table_
; c
->name
; c
++) {
512 if (strcasecmp(tok_v
[0], c
->name
) == 0) {
513 if (c
->args_min
> tok_c
- 1) {
514 fprintf(stderr
, "%s: not enough arguments\n", c
->name
);
520 && tok_c
- 1 > c
->args_max
) {
521 fprintf(stderr
, "%s: too many arguments\n", c
->name
);
526 r
= c
->func(vm
, tok_c
, tok_v
);
534 fprintf(stderr
, "didn't recognize '%s'\n", tok_v
[0]);
537 printf("\nfinished\n");