Subversion Repositories HelenOS-historic

Rev

Rev 603 | Rev 607 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
510 jermar 1
/*
2
 * Copyright (C) 2005 Jakub Jermar
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
13
 *   documentation and/or other materials provided with the distribution.
14
 * - The name of the author may not be used to endorse or promote products
15
 *   derived from this software without specific prior written permission.
16
 *
17
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
518 jermar 29
#include <console/kconsole.h>
510 jermar 30
#include <console/console.h>
31
#include <console/chardev.h>
596 jermar 32
#include <console/cmd.h>
510 jermar 33
#include <print.h>
517 jermar 34
#include <panic.h>
510 jermar 35
#include <typedefs.h>
36
#include <arch/types.h>
517 jermar 37
#include <list.h>
38
#include <arch.h>
39
#include <macros.h>
518 jermar 40
#include <debug.h>
596 jermar 41
#include <func.h>
582 palkovsky 42
#include <symtab.h>
510 jermar 43
 
517 jermar 44
/** Simple kernel console.
45
 *
46
 * The console is realized by kernel thread kconsole.
518 jermar 47
 * It doesn't understand any useful command on its own,
48
 * but makes it possible for other kernel subsystems to
517 jermar 49
 * register their own commands.
50
 */
51
 
52
/** Locking.
53
 *
54
 * There is a list of cmd_info_t structures. This list
55
 * is protected by cmd_lock spinlock. Note that specially
56
 * the link elements of cmd_info_t are protected by
57
 * this lock.
58
 *
59
 * Each cmd_info_t also has its own lock, which protects
60
 * all elements thereof except the link element.
61
 *
62
 * cmd_lock must be acquired before any cmd_info lock.
63
 * When locking two cmd info structures, structure with
64
 * lower address must be locked first.
65
 */
66
 
67
spinlock_t cmd_lock;	/**< Lock protecting command list. */
68
link_t cmd_head;	/**< Command list. */
69
 
70
static cmd_info_t *parse_cmdline(char *cmdline, size_t len);
518 jermar 71
static bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end);
601 palkovsky 72
static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
517 jermar 73
 
74
/** Initialize kconsole data structures. */
75
void kconsole_init(void)
76
{
601 palkovsky 77
	int i;
78
 
552 palkovsky 79
	spinlock_initialize(&cmd_lock, "kconsole_cmd");
517 jermar 80
	list_initialize(&cmd_head);
518 jermar 81
 
596 jermar 82
	cmd_init();
601 palkovsky 83
	for (i=0; i<KCONSOLE_HISTORY; i++)
84
		history[i][0] = '\0';
517 jermar 85
}
86
 
87
 
88
/** Register kconsole command.
89
 *
90
 * @param cmd Structure describing the command.
91
 *
92
 * @return 0 on failure, 1 on success.
93
 */
94
int cmd_register(cmd_info_t *cmd)
95
{
96
	ipl_t ipl;
97
	link_t *cur;
98
 
99
	spinlock_lock(&cmd_lock);
100
 
101
	/*
102
	 * Make sure the command is not already listed.
103
	 */
104
	for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
105
		cmd_info_t *hlp;
106
 
107
		hlp = list_get_instance(cur, cmd_info_t, link);
108
 
109
		if (hlp == cmd) {
110
			/* The command is already there. */
111
			spinlock_unlock(&cmd_lock);
112
			return 0;
113
		}
114
 
115
		/* Avoid deadlock. */
116
		if (hlp < cmd) {
117
			spinlock_lock(&hlp->lock);
118
			spinlock_lock(&cmd->lock);
119
		} else {
120
			spinlock_lock(&cmd->lock);
121
			spinlock_lock(&hlp->lock);
122
		}
123
 
518 jermar 124
		if ((strncmp(hlp->name, cmd->name, strlen(cmd->name)) == 0)) {
517 jermar 125
			/* The command is already there. */
126
			spinlock_unlock(&hlp->lock);
127
			spinlock_unlock(&cmd->lock);
128
			spinlock_unlock(&cmd_lock);
129
			return 0;
130
		}
131
 
132
		spinlock_unlock(&hlp->lock);
133
		spinlock_unlock(&cmd->lock);
134
	}
135
 
136
	/*
137
	 * Now the command can be added.
138
	 */
139
	list_append(&cmd->link, &cmd_head);
140
 
141
	spinlock_unlock(&cmd_lock);
142
	return 1;
143
}
144
 
601 palkovsky 145
static void rdln_print_c(char ch, int count)
146
{
147
	int i;
148
	for (i=0;i<count;i++)
149
		putchar(ch);
150
}
151
 
152
static void insert_char(char *str, char ch, int pos)
153
{
154
	int i;
155
 
156
	for (i=strlen(str);i > pos; i--)
157
		str[i] = str[i-1];
158
	str[pos] = ch;
159
}
160
 
161
static const char * cmdtab_search_one(const char *name,link_t **startpos)
162
{
163
	int namelen = strlen(name);
164
	const char *curname;
165
	char *foundsym = NULL;
166
	int foundpos = 0;
167
 
168
	spinlock_lock(&cmd_lock);
169
 
170
	if (!*startpos)
171
		*startpos = cmd_head.next;
172
 
173
	for (;*startpos != &cmd_head;*startpos = (*startpos)->next) {
174
		cmd_info_t *hlp;
175
		hlp = list_get_instance(*startpos, cmd_info_t, link);
176
 
177
		curname = hlp->name;
178
		if (strlen(curname) < namelen)
179
			continue;
180
		if (strncmp(curname, name, namelen) == 0) {
181
			spinlock_unlock(&cmd_lock);	
182
			return curname+namelen;
183
		}
184
	}
185
	spinlock_unlock(&cmd_lock);	
186
	return NULL;
187
}
188
 
189
 
190
/** Command completion of the commands 
191
 *
192
 * @param name - string to match, changed to hint on exit
193
 * @return number of found matches
194
 */
195
static int cmdtab_compl(char *name)
196
{
197
	char output[MAX_SYMBOL_NAME+1];
198
	link_t *startpos = NULL;
199
	const char *foundtxt;
200
	int found = 0;
201
	int i;
202
 
203
	output[0] = '\0';
204
	while ((foundtxt = cmdtab_search_one(name, &startpos))) {
205
		startpos = startpos->next;
206
		if (!found)
207
			strncpy(output, foundtxt, strlen(foundtxt)+1);
208
		else {
209
			for (i=0; output[i] && foundtxt[i] && output[i]==foundtxt[i]; i++)
210
				;
211
			output[i] = '\0';
212
		}
213
		found++;
214
	}
215
	if (!found)
216
		return 0;
217
 
602 palkovsky 218
	if (found > 1 && !strlen(output)) {
601 palkovsky 219
		printf("\n");
220
		startpos = NULL;
221
		while ((foundtxt = cmdtab_search_one(name, &startpos))) {
222
			cmd_info_t *hlp;
223
			hlp = list_get_instance(startpos, cmd_info_t, link);
224
			printf("%s - %s\n", hlp->name, hlp->description);
225
			startpos = startpos->next;
226
		}
227
	}
228
	strncpy(name, output, MAX_SYMBOL_NAME);
229
	return found;
230
 
231
}
232
 
233
static char * clever_readline(const char *prompt, chardev_t *input)
234
{
235
	static int histposition = 0;
236
 
237
	char tmp[MAX_CMDLINE+1];
238
	int curlen = 0, position = 0;
239
	char *current = history[histposition];
240
	int i;
606 palkovsky 241
	char mod; /* Command Modifier */
601 palkovsky 242
	char c;
243
 
244
	printf("%s> ", prompt);
245
	while (1) {
246
		c = _getc(input);
247
		if (c == '\n') {
248
			putchar(c);
249
			break;
250
		} if (c == '\b') {
251
			if (position == 0)
252
				continue;
253
			for (i=position; i<curlen;i++)
254
				current[i-1] = current[i];
255
			curlen--;
256
			position--;
257
			putchar('\b');
258
			for (i=position;i<curlen;i++)
259
				putchar(current[i]);
260
			putchar(' ');
261
			rdln_print_c('\b',curlen-position+1);
262
			continue;
263
		}
264
		if (c == '\t') {
265
			int found;
266
 
267
			/* Move to the end of the word */
268
			for (;position<curlen && current[position]!=' ';position++)
269
				putchar(current[position]);
270
			/* Copy to tmp last word */
271
			for (i=position-1;i >= 0 && current[i]!=' ' ;i--)
272
				;
273
			/* If word begins with * or &, skip it */
274
			if (tmp[0] == '*' || tmp[0] == '&')
275
				for (i=1;tmp[i];i++)
276
					tmp[i-1] = tmp[i];
277
			i++; /* I is at the start of the word */
278
			strncpy(tmp, current+i, position-i+1);
279
 
280
			if (i==0) { /* Command completion */
281
				found = cmdtab_compl(tmp);
282
			} else { /* Symtab completion */
283
				found = symtab_compl(tmp);
284
			}
285
 
286
			if (found == 0) 
287
				continue;
288
			for (i=0;tmp[i] && curlen < MAX_CMDLINE;i++,curlen++)
289
				insert_char(current, tmp[i], i+position);
602 palkovsky 290
 
291
			if (strlen(tmp) || found==1) { /* If we have a hint */
292
				for (i=position;i<curlen;i++) 
601 palkovsky 293
					putchar(current[i]);
294
				position += strlen(tmp);
295
				/* Add space to end */
602 palkovsky 296
				if (found == 1 && position == curlen && \
297
				    curlen < MAX_CMDLINE) {
601 palkovsky 298
					current[position] = ' ';
299
					curlen++;
300
					position++;
301
					putchar(' ');
302
				}
602 palkovsky 303
			} else { /* No hint, table was printed */
601 palkovsky 304
				printf("%s> ", prompt);
305
				for (i=0; i<curlen;i++)
306
					putchar(current[i]);
307
				position += strlen(tmp);
308
			}
309
			rdln_print_c('\b', curlen-position);
310
			continue;
311
		}
312
		if (c == 0x1b) {
606 palkovsky 313
			mod = _getc(input);
601 palkovsky 314
			c = _getc(input);
606 palkovsky 315
 
316
			if (mod != 0x5b && mod != 0x4f)
601 palkovsky 317
				continue;
606 palkovsky 318
 
319
			if (c == 0x33 && _getc(input) == 0x7e) {
320
				if (position == curlen)
321
					continue;
322
				for (i=position+1; i<curlen;i++) {
323
					putchar(current[i]);
324
					current[i-1] = current[i];
325
				}
326
				putchar(' ');
327
				rdln_print_c('\b',curlen-position);
328
				curlen--;
329
			}
330
			else if (c == 0x48) { /* Home */
331
				rdln_print_c('\b',position);
332
				position = 0;
333
			} 
334
			else if (c == 0x46) {
335
				for (i=position;i<curlen;i++)
336
					putchar(current[i]);
337
				position = curlen;
338
			}
339
			else if (c == 0x44) { /* Left */
601 palkovsky 340
				if (position > 0) {
341
					putchar('\b');
342
					position--;
343
				}
344
				continue;
345
			}
606 palkovsky 346
			else if (c == 0x43) { /* Right */
601 palkovsky 347
				if (position < curlen) {
348
					putchar(current[position]);
349
					position++;
350
				}
351
				continue;
352
			}
606 palkovsky 353
			else if (c == 0x41 || c == 0x42) { 
354
                                /* Up,down */
601 palkovsky 355
				rdln_print_c('\b',position);
356
				rdln_print_c(' ',curlen);
357
				rdln_print_c('\b',curlen);
358
				if (c == 0x41)
359
					histposition--;
360
				else
361
					histposition++;
362
				if (histposition < 0)
363
					histposition = KCONSOLE_HISTORY -1 ;
364
				else
365
					histposition =  histposition % KCONSOLE_HISTORY;
366
				current = history[histposition];
367
				printf("%s", current);
368
				curlen = strlen(current);
369
				position = curlen;
370
				continue;
371
			}
372
			continue;
373
		}
374
		if (curlen >= MAX_CMDLINE)
375
			continue;
376
 
377
		insert_char(current, c, position);
378
 
379
		curlen++;
380
		for (i=position;i<curlen;i++)
381
			putchar(current[i]);
382
		position++;
383
		rdln_print_c('\b',curlen-position);
384
	} 
603 palkovsky 385
	if (curlen) {
386
		histposition++;
387
		histposition = histposition % KCONSOLE_HISTORY;
388
	}
601 palkovsky 389
	current[curlen] = '\0';
390
	return current;
391
}
392
 
510 jermar 393
/** Kernel console managing thread.
394
 *
395
 * @param arg Not used.
396
 */
397
void kconsole(void *arg)
398
{
517 jermar 399
	cmd_info_t *cmd_info;
400
	count_t len;
601 palkovsky 401
	char *cmdline;
510 jermar 402
 
403
	if (!stdin) {
404
		printf("%s: no stdin\n", __FUNCTION__);
405
		return;
406
	}
407
 
408
	while (true) {
601 palkovsky 409
		cmdline = clever_readline(__FUNCTION__, stdin);
410
		len = strlen(cmdline);
411
		if (!len)
518 jermar 412
			continue;
517 jermar 413
		cmd_info = parse_cmdline(cmdline, len);
518 jermar 414
		if (!cmd_info)
517 jermar 415
			continue;
416
		(void) cmd_info->func(cmd_info->argv);
510 jermar 417
	}
418
}
517 jermar 419
 
585 palkovsky 420
static int parse_int_arg(char *text, size_t len, __native *result)
421
{
422
	char symname[MAX_SYMBOL_NAME];
423
	__address symaddr;
424
	bool isaddr = false;
589 palkovsky 425
	bool isptr = false;
585 palkovsky 426
 
427
	/* If we get a name, try to find it in symbol table */
428
	if (text[0] < '0' | text[0] > '9') {
429
		if (text[0] == '&') {
430
			isaddr = true;
431
			text++;len--;
589 palkovsky 432
		} else if (text[0] == '*') {
433
			isptr = true;
434
			text++;len--;
585 palkovsky 435
		}
436
		strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));
437
		symaddr = get_symbol_addr(symname);
438
		if (!symaddr) {
439
			printf("Symbol %s not found.\n",symname);
440
			return -1;
441
		}
442
		if (symaddr == (__address) -1) {
443
			printf("Duplicate symbol %s.\n",symname);
444
			symtab_print_search(symname);
445
			return -1;
446
		}
447
		if (isaddr)
448
			*result = (__native)symaddr;
589 palkovsky 449
		else if (isptr)
450
			*result = **((__native **)symaddr);
585 palkovsky 451
		else
452
			*result = *((__native *)symaddr);
453
	} else /* It's a number - convert it */
454
		*result = atoi(text);
455
	return 0;
456
}
457
 
517 jermar 458
/** Parse command line.
459
 *
460
 * @param cmdline Command line as read from input device.
461
 * @param len Command line length.
462
 *
463
 * @return Structure describing the command.
464
 */
465
cmd_info_t *parse_cmdline(char *cmdline, size_t len)
466
{
467
	index_t start = 0, end = 0;
468
	cmd_info_t *cmd = NULL;
469
	link_t *cur;
470
	ipl_t ipl;
471
	int i;
472
 
518 jermar 473
	if (!parse_argument(cmdline, len, &start, &end)) {
517 jermar 474
		/* Command line did not contain alphanumeric word. */
475
		return NULL;
476
	}
477
 
478
	spinlock_lock(&cmd_lock);
479
 
480
	for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
481
		cmd_info_t *hlp;
482
 
483
		hlp = list_get_instance(cur, cmd_info_t, link);
484
		spinlock_lock(&hlp->lock);
485
 
518 jermar 486
		if (strncmp(hlp->name, &cmdline[start], (end - start) + 1) == 0) {
517 jermar 487
			cmd = hlp;
488
			break;
489
		}
490
 
491
		spinlock_unlock(&hlp->lock);
492
	}
493
 
494
	spinlock_unlock(&cmd_lock);	
495
 
496
	if (!cmd) {
497
		/* Unknown command. */
518 jermar 498
		printf("Unknown command.\n");
517 jermar 499
		return NULL;
500
	}
501
 
502
	/* cmd == hlp is locked */
503
 
504
	/*
505
	 * The command line must be further analyzed and
506
	 * the parameters therefrom must be matched and
507
	 * converted to those specified in the cmd info
508
	 * structure.
509
	 */
518 jermar 510
 
511
	for (i = 0; i < cmd->argc; i++) {
512
		char *buf;
513
		start = end + 1;
514
		if (!parse_argument(cmdline, len, &start, &end)) {
515
			printf("Too few arguments.\n");
516
			spinlock_unlock(&cmd->lock);
517
			return NULL;
518
		}
519
 
520
		switch (cmd->argv[i].type) {
582 palkovsky 521
		case ARG_TYPE_STRING:
518 jermar 522
		    	buf = cmd->argv[i].buffer;
585 palkovsky 523
		    	strncpy(buf, (const char *) &cmdline[start], min((end - start) + 2, cmd->argv[i].len));
518 jermar 524
			buf[min((end - start) + 1, cmd->argv[i].len - 1)] = '\0';
525
			break;
585 palkovsky 526
		case ARG_TYPE_INT: 
527
			if (parse_int_arg(cmdline+start, end-start+1, 
528
					  &cmd->argv[i].intval))
529
				return NULL;
518 jermar 530
			break;
585 palkovsky 531
		case ARG_TYPE_VAR:
532
			if (start != end && cmdline[start] == '"' && cmdline[end] == '"') {
533
				buf = cmd->argv[i].buffer;
534
				strncpy(buf, (const char *) &cmdline[start+1], 
535
					min((end-start), cmd->argv[i].len));
536
				buf[min((end - start), cmd->argv[i].len - 1)] = '\0';
537
				cmd->argv[i].intval = (__native) buf;
538
				cmd->argv[i].vartype = ARG_TYPE_STRING;
539
			} else if (!parse_int_arg(cmdline+start, end-start+1, 
540
						 &cmd->argv[i].intval))
541
				cmd->argv[i].vartype = ARG_TYPE_INT;
542
			else {
543
				printf("Unrecognized variable argument.\n");
544
				return NULL;
582 palkovsky 545
			}
585 palkovsky 546
			break;
582 palkovsky 547
		case ARG_TYPE_INVALID:
548
		default:
549
			printf("invalid argument type\n");
550
			return NULL;
551
			break;
518 jermar 552
		}
553
	}
517 jermar 554
 
518 jermar 555
	start = end + 1;
556
	if (parse_argument(cmdline, len, &start, &end)) {
557
		printf("Too many arguments.\n");
558
		spinlock_unlock(&cmd->lock);
559
		return NULL;
560
	}
561
 
517 jermar 562
	spinlock_unlock(&cmd->lock);
563
	return cmd;
564
}
565
 
518 jermar 566
/** Parse argument.
567
 *
568
 * Find start and end positions of command line argument.
569
 *
570
 * @param cmdline Command line as read from the input device.
571
 * @param len Number of characters in cmdline.
572
 * @param start On entry, 'start' contains pointer to the index 
573
 *        of first unprocessed character of cmdline.
574
 *        On successful exit, it marks beginning of the next argument.
575
 * @param end Undefined on entry. On exit, 'end' points to the last character
576
 *        of the next argument.
577
 *
578
 * @return false on failure, true on success.
579
 */
580
bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end)
581
{
582
	int i;
583
	bool found_start = false;
584
 
585
	ASSERT(start != NULL);
586
	ASSERT(end != NULL);
587
 
588
	for (i = *start; i < len; i++) {
589
		if (!found_start) {
590
			if (is_white(cmdline[i]))
591
				(*start)++;
592
			else
593
				found_start = true;
594
		} else {
595
			if (is_white(cmdline[i]))
596
				break;
597
		}
598
	}
599
	*end = i - 1;
600
 
601
	return found_start;
602
}