command.c 17.1 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
/***************************************************************************
 *   Copyright (C) 2005 by Dominic Rath                                    *
 *   Dominic.Rath@gmx.de                                                   *
 *                                                                         *
 *   part of this file is taken from libcli (libcli.sourceforge.net)       *
 *   Copyright (C) David Parrish (david@dparrish.com)                      *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include "replacements.h"
28
#include "target.h"
29
#include "command.h"
30
#include "configuration.h"
31
32
33
34
35
36
37
38
39
40

#include "log.h"
#include "time_support.h"

#include <stdlib.h>
#include <string.h>
#include <ctype.h>
#include <stdarg.h>
#include <stdio.h>
#include <unistd.h>
41
#include <errno.h>
oharboe's avatar
oharboe committed
42

oharboe's avatar
oharboe committed
43
int fast_and_dangerous = 0;
44
Jim_Interp *interp = NULL;
oharboe's avatar
oharboe committed
45

46
int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
oharboe's avatar
oharboe committed
47
int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc);
48
49
50

int run_command(command_context_t *context, command_t *c, char *words[], int num_words);

51
52
53
static void tcl_output(void *privData, const char *file, int line, const char *function, const char *string)
{		
	Jim_Obj *tclOutput=(Jim_Obj *)privData;
54

55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
	Jim_AppendString(interp, tclOutput, string, strlen(string));
}

static int script_command(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
	/* the private data is stashed in the interp structure */
	command_t *c;
	command_context_t *context;
	int *retval;
	int i;
	int nwords;
	char **words;

	target_call_timer_callbacks_now();
	LOG_USER_N("%s", ""); /* Keep GDB connection alive*/ 
	
	c = interp->cmdPrivData;
	LOG_DEBUG("script_command - %s", c->name);

	nwords = argc;
	words = malloc(sizeof(char *) * nwords);
	for (i = 0; i < nwords; i++)
	{
		int len;

		words[i] = strdup(Jim_GetString(argv[i], &len));
		if (words[i] == NULL) 
		{
			return JIM_ERR;
		}
		LOG_DEBUG("script_command - %s, argv[%u]=%s", c->name, i, words[i]);
	}

	/* grab the command context from the associated data */
	context = Jim_GetAssocData(interp, "context");
	retval = Jim_GetAssocData(interp, "retval"); 
	if (context != NULL && retval != NULL)
	{
		/* capture log output and return it */
		Jim_Obj *tclOutput = Jim_NewStringObj(interp, "", 0);
		log_add_callback(tcl_output, tclOutput);
		
		*retval = run_command(context, c, words, nwords);
		
		log_remove_callback(tcl_output, tclOutput);
		
101
102
		/* We dump output into this local variable */
		Jim_SetVariableStr(interp, "openocd_output", tclOutput);
103
	}
ntfreak's avatar
ntfreak committed
104

105
106
107
	for (i = 0; i < nwords; i++)
		free(words[i]);
	free(words);
108

109
110
	return (*retval==ERROR_OK)?JIM_OK:JIM_ERR;
}
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

command_t* register_command(command_context_t *context, command_t *parent, char *name, int (*handler)(struct command_context_s *context, char* name, char** args, int argc), enum command_mode mode, char *help)
{
	command_t *c, *p;
	
	if (!context || !name)
		return NULL;
				
	c = malloc(sizeof(command_t));
	
	c->name = strdup(name);
	c->parent = parent;
	c->children = NULL;
	c->handler = handler;
	c->mode = mode;
oharboe's avatar
oharboe committed
126
127
	if (!help)
		help="";
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
	c->next = NULL;
	
	/* place command in tree */
	if (parent)
	{
		if (parent->children)
		{
			/* find last child */
			for (p = parent->children; p && p->next; p = p->next);
			if (p)
				p->next = c;
		}
		else
		{
			parent->children = c;
		}
	}
	else
	{
		if (context->commands)
		{
			/* find last command */
			for (p = context->commands; p && p->next; p = p->next);
			if (p)
				p->next = c;
		}
		else
		{
			context->commands = c;
		}
	}
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
	
	/* just a placeholder, no handler */
	if (c->handler==NULL)
		return c;

	/* If this is a two level command, e.g. "flash banks", then the
	 * "unknown" proc in startup.tcl must redirect to  this command.
	 * 
	 * "flash banks" is translated by "unknown" to "flash_banks"
	 * if such a proc exists
	 */
	/* Print help for command */
	const char *t1="";
	const char *t2="";
	const char *t3="";
	/* maximum of two levels :-) */
	if (c->parent!=NULL)
	{
		t1=c->parent->name;
		t2="_";
	}
	t3=c->name;
	const char *full_name=alloc_printf("%s%s%s", t1, t2, t3);
	Jim_CreateCommand(interp, full_name, script_command, c, NULL);
	free((void *)full_name);
	
oharboe's avatar
oharboe committed
185
186
	/* accumulate help text in Tcl helptext list.  */
    Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
187
188
    if (Jim_IsShared(helptext))
        helptext = Jim_DuplicateObj(interp, helptext);
oharboe's avatar
oharboe committed
189
190
191
192
193
194
195
196
197
198
	Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
	
	Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);

	/* maximum of two levels :-) */
	if (c->parent!=NULL)
	{
		Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->parent->name, -1));
	} 
	Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, c->name, -1));
199
	
oharboe's avatar
oharboe committed
200
	Jim_ListAppendElement(interp, cmd_entry, cmd_list);
201
	Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
oharboe's avatar
oharboe committed
202
	Jim_ListAppendElement(interp, helptext, cmd_entry);
203
204
205
	return c;
}

206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
int unregister_all_commands(command_context_t *context)
{
	command_t *c, *c2;
	
	if (context == NULL)
		return ERROR_OK;
	
	while(NULL != context->commands)
	{
		c = context->commands;
		
		while(NULL != c->children)
		{
			c2 = c->children;
			c->children = c->children->next;
			free(c2->name);
			c2->name = NULL;
			free(c2);
			c2 = NULL;
		}
		
		context->commands = context->commands->next;
		
		free(c->name);
		c->name = NULL;
		free(c);
		c = NULL;		
	}
	
	return ERROR_OK;
}

238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
int unregister_command(command_context_t *context, char *name)
{
	command_t *c, *p = NULL, *c2;
	
	if ((!context) || (!name))
		return ERROR_INVALID_ARGUMENTS;
	
	/* find command */
	for (c = context->commands; c; c = c->next)
	{
		if (strcmp(name, c->name) == 0)
		{
			/* unlink command */
			if (p)
			{
				p->next = c->next;
			}
			else
			{
				context->commands = c->next;
			}
			
			/* unregister children */
			if (c->children)
			{
				for (c2 = c->children; c2; c2 = c2->next)
				{
					free(c2->name);
					free(c2);
				}
			}
			
			/* delete command */
			free(c->name);
			free(c);
		}
		
		/* remember the last command for unlinking */
		p = c;
	}
	
	return ERROR_OK;
}

ntfreak's avatar
ntfreak committed
282
void command_output_text(command_context_t *context, const char *data)
oharboe's avatar
oharboe committed
283
284
285
286
287
288
{
	if( context && context->output_handler && data  ){
		context->output_handler( context, data );
	}
}

289
void command_print_n(command_context_t *context, char *format, ...)
290
{
291
	char *string;
292
	
293
294
295
	va_list ap;
	va_start(ap, format);

oharboe's avatar
oharboe committed
296
	string = alloc_vprintf(format, ap);
297
	if (string != NULL)
298
	{
299
300
301
302
303
304
305
306
		/* we want this collected in the log + we also want to pick it up as a tcl return
		 * value.
		 * 
		 * The latter bit isn't precisely neat, but will do for now.
		 */
		LOG_USER_N("%s", string);
		// We already printed it above
		//command_output_text(context, string);
307
		free(string);
308
309
	}

310
311
	va_end(ap);
}
312

313
314
void command_print(command_context_t *context, char *format, ...)
{
315
316
	char *string;

317
318
	va_list ap;
	va_start(ap, format);
319

oharboe's avatar
oharboe committed
320
	string = alloc_vprintf(format, ap);
321
322
	if (string != NULL)
	{
oharboe's avatar
oharboe committed
323
		strcat(string, "\n"); /* alloc_vprintf guaranteed the buffer to be at least one char longer */
324
325
326
327
328
329
330
331
		/* we want this collected in the log + we also want to pick it up as a tcl return
		 * value.
		 * 
		 * The latter bit isn't precisely neat, but will do for now.
		 */
		LOG_USER_N("%s", string);
		// We already printed it above
		//command_output_text(context, string);
332
333
334
		free(string);
	}

335
	va_end(ap);
336
337
}

338
int run_command(command_context_t *context, command_t *c, char *words[], int num_words)
339
340
{
	int start_word=0;
341
	if (!((context->mode == COMMAND_CONFIG) || (c->mode == COMMAND_ANY) || (c->mode == context->mode) ))
342
	{
343
344
		/* Config commands can not run after the config stage */
		return ERROR_FAIL;
345
	}
346
	
347
348
349
	int retval = c->handler(context, c->name, words + start_word + 1, num_words - start_word - 1);
	if (retval == ERROR_COMMAND_SYNTAX_ERROR)
	{
350
351
352
353
354
355
356
357
358
359
360
361
		/* Print help for command */
		const char *t1="";
		const char *t2="";
		const char *t3="";
		/* maximum of two levels :-) */
		if (c->parent!=NULL)
		{
			t1=c->parent->name;
			t2=" ";
		}
		t3=c->name;
		command_run_linef(context, "help {%s%s%s}", t1, t2, t3);
362
363
364
365
366
367
368
369
370
371
372
373
	}
	else if (retval == ERROR_COMMAND_CLOSE_CONNECTION)
	{
		/* just fall through for a shutdown request */
	}
	else if (retval != ERROR_OK)
	{
		/* we do not print out an error message because the command *should*
		 * have printed out an error
		 */
		LOG_DEBUG("Command failed with error code %d", retval); 
	}
374
	
375
	return retval; 
376
377
}

378
int command_run_line(command_context_t *context, char *line)
379
{
380
381
382
383
384
	/* all the parent commands have been registered with the interpreter
	 * so, can just evaluate the line as a script and check for
	 * results
	 */
	/* run the line thru a script engine */
385
	int retval;
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
	int retcode;
	Jim_DeleteAssocData(interp, "context"); /* remove existing */
	retcode = Jim_SetAssocData(interp, "context", NULL, context);
	if (retcode != JIM_OK)
		return ERROR_FAIL;

	/* associated the return value */
	retval = ERROR_OK;
	Jim_DeleteAssocData(interp, "retval"); /* remove existing */
	retcode = Jim_SetAssocData(interp, "retval", NULL, &retval);
	if (retcode != JIM_OK)
		return ERROR_FAIL;

	retcode = Jim_Eval(interp, line);	
	if (retcode == JIM_ERR) {
401
402
403
404
405
406
407
408
409
410
411
		if (retval!=ERROR_COMMAND_CLOSE_CONNECTION)
		{
			/* We do not print the connection closed error message */
			Jim_PrintErrorMessage(interp);
		}
		if (retval==ERROR_OK)
		{
			/* It wasn't a low level OpenOCD command that failed */
			return ERROR_FAIL; 
		}
		return retval;
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
	} else if (retcode == JIM_EXIT) {
		/* ignore. */
		/* exit(Jim_GetExitCode(interp)); */
	} else {
		const char *result;
		int reslen;

		result = Jim_GetString(Jim_GetResult(interp), &reslen);
		if (reslen) {
			int i;
			char buff[256+1];
			for (i = 0; i < reslen; i += 256)
			{
				int chunk;
				chunk = reslen - i;
				if (chunk > 256)
					chunk = 256;
				strncpy(buff, result+i, chunk);
				buff[chunk] = 0; 
				LOG_USER_N("%s", buff);
			}
			LOG_USER_N("%s", "\n");
		}
ntfreak's avatar
ntfreak committed
435
	}
436
437
438
	return retval;
}

oharboe's avatar
oharboe committed
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
int command_run_linef(command_context_t *context, char *format, ...)
{
	int retval=ERROR_FAIL;
	char *string;
	va_list ap;
	va_start(ap, format);
	string = alloc_vprintf(format, ap);
	if (string!=NULL)
	{
		retval=command_run_line(context, string);
	}
	va_end(ap);
	return retval;
}

oharboe's avatar
oharboe committed
454
void command_set_output_handler(command_context_t* context, int (*output_handler)(struct command_context_s *context, const char* line), void *priv)
455
456
457
458
459
460
461
462
463
464
{
	context->output_handler = output_handler;
	context->output_handler_priv = priv;
}

command_context_t* copy_command_context(command_context_t* context)
{
	command_context_t* copy_context = malloc(sizeof(command_context_t));

	*copy_context = *context;
465

466
467
468
469
470
471
472
473
474
475
476
	return copy_context;
}

int command_done(command_context_t *context)
{
	free(context);
	context = NULL;
	
	return ERROR_OK;
}

477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
/* find full path to file */
static int jim_find(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
	if (argc != 2)
		return JIM_ERR;
	const char *file = Jim_GetString(argv[1], NULL);
	char *full_path = find_file(file);
	if (full_path == NULL)
		return JIM_ERR;
	Jim_Obj *result = Jim_NewStringObj(interp, full_path, strlen(full_path));
	free(full_path);
	
	Jim_SetResult(interp, result);
	return JIM_OK;
}

static int jim_echo(Jim_Interp *interp, int argc, Jim_Obj *const *argv)
{
	if (argc != 2)
		return JIM_ERR;
	const char *str = Jim_GetString(argv[1], NULL);
	LOG_USER("%s", str);
	return JIM_OK;
}

static size_t openocd_jim_fwrite(const void *_ptr, size_t size, size_t n, void *cookie)
{
	size_t nbytes;
	const char *ptr;
	Jim_Interp *interp;
	command_context_t *context;

	/* make it a char easier to read code */
	ptr = _ptr;
	interp = cookie;
	nbytes = size * n;
	if (ptr == NULL || interp == NULL || nbytes == 0) {
		return 0;
	}

	context = Jim_GetAssocData(interp, "context");
	if (context == NULL)
	{
		LOG_ERROR("openocd_jim_fwrite: no command context");
		/* TODO: Where should this go? */		
		return n;
	}

	/* do we have to chunk it? */
	if (ptr[nbytes] == 0)
	{
		/* no it is a C style string */
		command_output_text(context, ptr);
		return strlen(ptr);
	}
	/* GRR we must chunk - not null terminated */
	while (nbytes) {
		char chunk[128+1];
		int x;

		x = nbytes;
		if (x > 128) {
			x = 128;
		}
		/* copy it */
		memcpy(chunk, ptr, x);
		/* terminate it */
		chunk[n] = 0;
		/* output it */
		command_output_text(context, chunk);
		ptr += x;
		nbytes -= x;
	}
	
	return n;
}

static size_t openocd_jim_fread(void *ptr, size_t size, size_t n, void *cookie)
{
	/* TCL wants to read... tell him no */
	return 0;
}

static int openocd_jim_vfprintf(void *cookie, const char *fmt, va_list ap)
{
	char *cp;
	int n;
	Jim_Interp *interp;
	command_context_t *context;

	n = -1;
	interp = cookie;
	if (interp == NULL)
		return n;

	context = Jim_GetAssocData(interp, "context");
	if (context == NULL)
	{
		LOG_ERROR("openocd_jim_vfprintf: no command context");
		return n;
	}

	cp = alloc_vprintf(fmt, ap);
	if (cp)
	{
		command_output_text(context, cp);
		n = strlen(cp);
		free(cp);
	}
	return n;
}

static int openocd_jim_fflush(void *cookie)
{
	/* nothing to flush */
	return 0;
}

static char* openocd_jim_fgets(char *s, int size, void *cookie)
{
	/* not supported */
	errno = ENOTSUP;
	return NULL;
}

602
603
604
command_context_t* command_init()
{
	command_context_t* context = malloc(sizeof(command_context_t));
605
606
	extern unsigned const char startup_tcl[];

607
608
609
610
611
	context->mode = COMMAND_EXEC;
	context->commands = NULL;
	context->current_target = 0;
	context->output_handler = NULL;
	context->output_handler_priv = NULL;
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632

#ifdef JIM_EMBEDDED
	Jim_InitEmbedded();
	/* Create an interpreter */
	interp = Jim_CreateInterp();
	/* Add all the Jim core commands */
	Jim_RegisterCoreCommands(interp);
#endif

	Jim_CreateCommand(interp, "openocd_find", jim_find, NULL, NULL);
	Jim_CreateCommand(interp, "echo", jim_echo, NULL, NULL);

	/* Set Jim's STDIO */
	interp->cookie_stdin = interp;
	interp->cookie_stdout = interp;
	interp->cookie_stderr = interp;
	interp->cb_fwrite = openocd_jim_fwrite;
	interp->cb_fread = openocd_jim_fread ;
	interp->cb_vfprintf = openocd_jim_vfprintf;
	interp->cb_fflush = openocd_jim_fflush;
	interp->cb_fgets = openocd_jim_fgets;
633
	
634
635
636
637
638
639
640
641
642
	add_default_dirs();

	if (Jim_Eval(interp, startup_tcl)==JIM_ERR)
	{
		LOG_ERROR("Failed to run startup.tcl (embedded into OpenOCD compile time)");
		Jim_PrintErrorMessage(interp);
		exit(-1);
	}

643
644
645
	register_command(context, NULL, "sleep", handle_sleep_command,
					 COMMAND_ANY, "sleep for <n> milliseconds");
	
oharboe's avatar
oharboe committed
646
647
648
	register_command(context, NULL, "fast", handle_fast_command,
					 COMMAND_ANY, "fast <enable/disable> - place at beginning of config files. Sets defaults to fast and dangerous.");
	
649
650
651
	return context;
}

652
653
654
655
656
657
658
659
660
int command_context_mode(command_context_t *cmd_ctx, enum command_mode mode)
{
	if (!cmd_ctx)
		return ERROR_INVALID_ARGUMENTS;

	cmd_ctx->mode = mode;
	return ERROR_OK;
}

661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
/* sleep command sleeps for <n> miliseconds
 * this is useful in target startup scripts
 */
int handle_sleep_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	unsigned long duration = 0;
	
	if (argc == 1)
	{
		duration = strtoul(args[0], NULL, 0);
		usleep(duration * 1000);
	}

	return ERROR_OK;
}

oharboe's avatar
oharboe committed
677
678
679
680
681
682
683
684
685
int handle_fast_command(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc)
{
	if (argc!=1)
		return ERROR_COMMAND_SYNTAX_ERROR;
	
	fast_and_dangerous = strcmp("enable", args[0])==0;
	
	return ERROR_OK;
}
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705

void register_jim(struct command_context_s *cmd_ctx, const char *name, int (*cmd)(Jim_Interp *interp, int argc, Jim_Obj *const *argv), const char *help)
{
	Jim_CreateCommand(interp, name, cmd, NULL, NULL);

	/* FIX!!! it would be prettier to invoke add_help_text... 
	   accumulate help text in Tcl helptext list.  */
	Jim_Obj *helptext=Jim_GetGlobalVariableStr(interp, "ocd_helptext", JIM_ERRMSG);
	if (Jim_IsShared(helptext))
		helptext = Jim_DuplicateObj(interp, helptext);
    
	Jim_Obj *cmd_entry=Jim_NewListObj(interp, NULL, 0);
	
	Jim_Obj *cmd_list=Jim_NewListObj(interp, NULL, 0);
	Jim_ListAppendElement(interp, cmd_list, Jim_NewStringObj(interp, name, -1));
	
	Jim_ListAppendElement(interp, cmd_entry, cmd_list);
	Jim_ListAppendElement(interp, cmd_entry, Jim_NewStringObj(interp, help, -1));
	Jim_ListAppendElement(interp, helptext, cmd_entry);
}