source: mainline/generic/src/console/kconsole.c@ 8e1ea655

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 8e1ea655 was 5c9a08b, checked in by Jakub Jermar <jakub@…>, 19 years ago

Move list and fifo data types to adt/.
  • Property mode set to 100644
File size: 14.5 KB
Line 
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
29#include <console/kconsole.h>
30#include <console/console.h>
31#include <console/chardev.h>
32#include <console/cmd.h>
33#include <print.h>
34#include <panic.h>
35#include <typedefs.h>
36#include <arch/types.h>
37#include <adt/list.h>
38#include <arch.h>
39#include <macros.h>
40#include <debug.h>
41#include <func.h>
42#include <symtab.h>
43#include <macros.h>
44
45/** Simple kernel console.
46 *
47 * The console is realized by kernel thread kconsole.
48 * It doesn't understand any useful command on its own,
49 * but makes it possible for other kernel subsystems to
50 * register their own commands.
51 */
52
53/** Locking.
54 *
55 * There is a list of cmd_info_t structures. This list
56 * is protected by cmd_lock spinlock. Note that specially
57 * the link elements of cmd_info_t are protected by
58 * this lock.
59 *
60 * Each cmd_info_t also has its own lock, which protects
61 * all elements thereof except the link element.
62 *
63 * cmd_lock must be acquired before any cmd_info lock.
64 * When locking two cmd info structures, structure with
65 * lower address must be locked first.
66 */
67
68SPINLOCK_INITIALIZE(cmd_lock); /**< Lock protecting command list. */
69LIST_INITIALIZE(cmd_head); /**< Command list. */
70
71static cmd_info_t *parse_cmdline(char *cmdline, size_t len);
72static bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end);
73static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
74
75/** Initialize kconsole data structures. */
76void kconsole_init(void)
77{
78 int i;
79
80 cmd_init();
81 for (i=0; i<KCONSOLE_HISTORY; i++)
82 history[i][0] = '\0';
83}
84
85
86/** Register kconsole command.
87 *
88 * @param cmd Structure describing the command.
89 *
90 * @return 0 on failure, 1 on success.
91 */
92int cmd_register(cmd_info_t *cmd)
93{
94 link_t *cur;
95
96 spinlock_lock(&cmd_lock);
97
98 /*
99 * Make sure the command is not already listed.
100 */
101 for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
102 cmd_info_t *hlp;
103
104 hlp = list_get_instance(cur, cmd_info_t, link);
105
106 if (hlp == cmd) {
107 /* The command is already there. */
108 spinlock_unlock(&cmd_lock);
109 return 0;
110 }
111
112 /* Avoid deadlock. */
113 if (hlp < cmd) {
114 spinlock_lock(&hlp->lock);
115 spinlock_lock(&cmd->lock);
116 } else {
117 spinlock_lock(&cmd->lock);
118 spinlock_lock(&hlp->lock);
119 }
120 if ((strncmp(hlp->name,
121 cmd->name, max(strlen(cmd->name),
122 strlen(hlp->name))) == 0)) {
123 /* The command is already there. */
124 spinlock_unlock(&hlp->lock);
125 spinlock_unlock(&cmd->lock);
126 spinlock_unlock(&cmd_lock);
127 return 0;
128 }
129
130 spinlock_unlock(&hlp->lock);
131 spinlock_unlock(&cmd->lock);
132 }
133
134 /*
135 * Now the command can be added.
136 */
137 list_append(&cmd->link, &cmd_head);
138
139 spinlock_unlock(&cmd_lock);
140 return 1;
141}
142
143/** Print count times a character */
144static void rdln_print_c(char ch, int count)
145{
146 int i;
147 for (i=0;i<count;i++)
148 putchar(ch);
149}
150
151/** Insert character to string */
152static 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/** Try to find a command beginning with prefix */
162static const char * cmdtab_search_one(const char *name,link_t **startpos)
163{
164 int namelen = strlen(name);
165 const char *curname;
166
167 spinlock_lock(&cmd_lock);
168
169 if (!*startpos)
170 *startpos = cmd_head.next;
171
172 for (;*startpos != &cmd_head;*startpos = (*startpos)->next) {
173 cmd_info_t *hlp;
174 hlp = list_get_instance(*startpos, cmd_info_t, link);
175
176 curname = hlp->name;
177 if (strlen(curname) < namelen)
178 continue;
179 if (strncmp(curname, name, namelen) == 0) {
180 spinlock_unlock(&cmd_lock);
181 return curname+namelen;
182 }
183 }
184 spinlock_unlock(&cmd_lock);
185 return NULL;
186}
187
188
189/** Command completion of the commands
190 *
191 * @param name - string to match, changed to hint on exit
192 * @return number of found matches
193 */
194static int cmdtab_compl(char *name)
195{
196 char output[MAX_SYMBOL_NAME+1];
197 link_t *startpos = NULL;
198 const char *foundtxt;
199 int found = 0;
200 int i;
201
202 output[0] = '\0';
203 while ((foundtxt = cmdtab_search_one(name, &startpos))) {
204 startpos = startpos->next;
205 if (!found)
206 strncpy(output, foundtxt, strlen(foundtxt)+1);
207 else {
208 for (i=0; output[i] && foundtxt[i] && output[i]==foundtxt[i]; i++)
209 ;
210 output[i] = '\0';
211 }
212 found++;
213 }
214 if (!found)
215 return 0;
216
217 if (found > 1 && !strlen(output)) {
218 printf("\n");
219 startpos = NULL;
220 while ((foundtxt = cmdtab_search_one(name, &startpos))) {
221 cmd_info_t *hlp;
222 hlp = list_get_instance(startpos, cmd_info_t, link);
223 printf("%s - %s\n", hlp->name, hlp->description);
224 startpos = startpos->next;
225 }
226 }
227 strncpy(name, output, MAX_SYMBOL_NAME);
228 return found;
229
230}
231
232static char * clever_readline(const char *prompt, chardev_t *input)
233{
234 static int histposition = 0;
235
236 char tmp[MAX_CMDLINE+1];
237 int curlen = 0, position = 0;
238 char *current = history[histposition];
239 int i;
240 char mod; /* Command Modifier */
241 char c;
242
243 printf("%s> ", prompt);
244 while (1) {
245 c = _getc(input);
246 if (c == '\n') {
247 putchar(c);
248 break;
249 } if (c == '\b') { /* Backspace */
250 if (position == 0)
251 continue;
252 for (i=position; i<curlen;i++)
253 current[i-1] = current[i];
254 curlen--;
255 position--;
256 putchar('\b');
257 for (i=position;i<curlen;i++)
258 putchar(current[i]);
259 putchar(' ');
260 rdln_print_c('\b',curlen-position+1);
261 continue;
262 }
263 if (c == '\t') { /* Tabulator */
264 int found;
265
266 /* Move to the end of the word */
267 for (;position<curlen && current[position]!=' ';position++)
268 putchar(current[position]);
269 /* Copy to tmp last word */
270 for (i=position-1;i >= 0 && current[i]!=' ' ;i--)
271 ;
272 /* If word begins with * or &, skip it */
273 if (tmp[0] == '*' || tmp[0] == '&')
274 for (i=1;tmp[i];i++)
275 tmp[i-1] = tmp[i];
276 i++; /* I is at the start of the word */
277 strncpy(tmp, current+i, position-i+1);
278
279 if (i==0) { /* Command completion */
280 found = cmdtab_compl(tmp);
281 } else { /* Symtab completion */
282 found = symtab_compl(tmp);
283 }
284
285 if (found == 0)
286 continue;
287 for (i=0;tmp[i] && curlen < MAX_CMDLINE;i++,curlen++)
288 insert_char(current, tmp[i], i+position);
289
290 if (strlen(tmp) || found==1) { /* If we have a hint */
291 for (i=position;i<curlen;i++)
292 putchar(current[i]);
293 position += strlen(tmp);
294 /* Add space to end */
295 if (found == 1 && position == curlen && \
296 curlen < MAX_CMDLINE) {
297 current[position] = ' ';
298 curlen++;
299 position++;
300 putchar(' ');
301 }
302 } else { /* No hint, table was printed */
303 printf("%s> ", prompt);
304 for (i=0; i<curlen;i++)
305 putchar(current[i]);
306 position += strlen(tmp);
307 }
308 rdln_print_c('\b', curlen-position);
309 continue;
310 }
311 if (c == 0x1b) { /* Special command */
312 mod = _getc(input);
313 c = _getc(input);
314
315 if (mod != 0x5b && mod != 0x4f)
316 continue;
317
318 if (c == 0x33 && _getc(input) == 0x7e) {
319 /* Delete */
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) { /* End */
335 for (i=position;i<curlen;i++)
336 putchar(current[i]);
337 position = curlen;
338 }
339 else if (c == 0x44) { /* Left */
340 if (position > 0) {
341 putchar('\b');
342 position--;
343 }
344 continue;
345 }
346 else if (c == 0x43) { /* Right */
347 if (position < curlen) {
348 putchar(current[position]);
349 position++;
350 }
351 continue;
352 }
353 else if (c == 0x41 || c == 0x42) {
354 /* Up,down */
355 rdln_print_c('\b',position);
356 rdln_print_c(' ',curlen);
357 rdln_print_c('\b',curlen);
358 if (c == 0x41) /* Up */
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 }
385 if (curlen) {
386 histposition++;
387 histposition = histposition % KCONSOLE_HISTORY;
388 }
389 current[curlen] = '\0';
390 return current;
391}
392
393/** Kernel console managing thread.
394 *
395 * @param arg Not used.
396 */
397void kconsole(void *prompt)
398{
399 cmd_info_t *cmd_info;
400 count_t len;
401 char *cmdline;
402
403 if (!stdin) {
404 printf("%s: no stdin\n", __FUNCTION__);
405 return;
406 }
407
408 while (true) {
409 cmdline = clever_readline(prompt, stdin);
410 len = strlen(cmdline);
411 if (!len)
412 continue;
413 cmd_info = parse_cmdline(cmdline, len);
414 if (!cmd_info)
415 continue;
416 if (strncmp(cmd_info->name,"exit", \
417 min(strlen(cmd_info->name),5)) == 0)
418 break;
419 (void) cmd_info->func(cmd_info->argv);
420 }
421}
422
423static int parse_int_arg(char *text, size_t len, __native *result)
424{
425 char symname[MAX_SYMBOL_NAME];
426 __address symaddr;
427 bool isaddr = false;
428 bool isptr = false;
429
430 /* If we get a name, try to find it in symbol table */
431 if (text[0] < '0' || text[0] > '9') {
432 if (text[0] == '&') {
433 isaddr = true;
434 text++;len--;
435 } else if (text[0] == '*') {
436 isptr = true;
437 text++;len--;
438 }
439 strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));
440 symaddr = get_symbol_addr(symname);
441 if (!symaddr) {
442 printf("Symbol %s not found.\n",symname);
443 return -1;
444 }
445 if (symaddr == (__address) -1) {
446 printf("Duplicate symbol %s.\n",symname);
447 symtab_print_search(symname);
448 return -1;
449 }
450 if (isaddr)
451 *result = (__native)symaddr;
452 else if (isptr)
453 *result = **((__native **)symaddr);
454 else
455 *result = *((__native *)symaddr);
456 } else /* It's a number - convert it */
457 *result = atoi(text);
458 return 0;
459}
460
461/** Parse command line.
462 *
463 * @param cmdline Command line as read from input device.
464 * @param len Command line length.
465 *
466 * @return Structure describing the command.
467 */
468cmd_info_t *parse_cmdline(char *cmdline, size_t len)
469{
470 index_t start = 0, end = 0;
471 cmd_info_t *cmd = NULL;
472 link_t *cur;
473 int i;
474 int error = 0;
475
476 if (!parse_argument(cmdline, len, &start, &end)) {
477 /* Command line did not contain alphanumeric word. */
478 return NULL;
479 }
480
481 spinlock_lock(&cmd_lock);
482
483 for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
484 cmd_info_t *hlp;
485
486 hlp = list_get_instance(cur, cmd_info_t, link);
487 spinlock_lock(&hlp->lock);
488
489 if (strncmp(hlp->name, &cmdline[start], max(strlen(hlp->name),
490 end-start+1)) == 0) {
491 cmd = hlp;
492 break;
493 }
494
495 spinlock_unlock(&hlp->lock);
496 }
497
498 spinlock_unlock(&cmd_lock);
499
500 if (!cmd) {
501 /* Unknown command. */
502 printf("Unknown command.\n");
503 return NULL;
504 }
505
506 /* cmd == hlp is locked */
507
508 /*
509 * The command line must be further analyzed and
510 * the parameters therefrom must be matched and
511 * converted to those specified in the cmd info
512 * structure.
513 */
514
515 for (i = 0; i < cmd->argc; i++) {
516 char *buf;
517 start = end + 1;
518 if (!parse_argument(cmdline, len, &start, &end)) {
519 printf("Too few arguments.\n");
520 spinlock_unlock(&cmd->lock);
521 return NULL;
522 }
523
524 error = 0;
525 switch (cmd->argv[i].type) {
526 case ARG_TYPE_STRING:
527 buf = cmd->argv[i].buffer;
528 strncpy(buf, (const char *) &cmdline[start], min((end - start) + 2, cmd->argv[i].len));
529 buf[min((end - start) + 1, cmd->argv[i].len - 1)] = '\0';
530 break;
531 case ARG_TYPE_INT:
532 if (parse_int_arg(cmdline+start, end-start+1,
533 &cmd->argv[i].intval))
534 error = 1;
535 break;
536 case ARG_TYPE_VAR:
537 if (start != end && cmdline[start] == '"' && cmdline[end] == '"') {
538 buf = cmd->argv[i].buffer;
539 strncpy(buf, (const char *) &cmdline[start+1],
540 min((end-start), cmd->argv[i].len));
541 buf[min((end - start), cmd->argv[i].len - 1)] = '\0';
542 cmd->argv[i].intval = (__native) buf;
543 cmd->argv[i].vartype = ARG_TYPE_STRING;
544 } else if (!parse_int_arg(cmdline+start, end-start+1,
545 &cmd->argv[i].intval))
546 cmd->argv[i].vartype = ARG_TYPE_INT;
547 else {
548 printf("Unrecognized variable argument.\n");
549 error = 1;
550 }
551 break;
552 case ARG_TYPE_INVALID:
553 default:
554 printf("invalid argument type\n");
555 error = 1;
556 break;
557 }
558 }
559
560 if (error) {
561 spinlock_unlock(&cmd->lock);
562 return NULL;
563 }
564
565 start = end + 1;
566 if (parse_argument(cmdline, len, &start, &end)) {
567 printf("Too many arguments.\n");
568 spinlock_unlock(&cmd->lock);
569 return NULL;
570 }
571
572 spinlock_unlock(&cmd->lock);
573 return cmd;
574}
575
576/** Parse argument.
577 *
578 * Find start and end positions of command line argument.
579 *
580 * @param cmdline Command line as read from the input device.
581 * @param len Number of characters in cmdline.
582 * @param start On entry, 'start' contains pointer to the index
583 * of first unprocessed character of cmdline.
584 * On successful exit, it marks beginning of the next argument.
585 * @param end Undefined on entry. On exit, 'end' points to the last character
586 * of the next argument.
587 *
588 * @return false on failure, true on success.
589 */
590bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end)
591{
592 int i;
593 bool found_start = false;
594
595 ASSERT(start != NULL);
596 ASSERT(end != NULL);
597
598 for (i = *start; i < len; i++) {
599 if (!found_start) {
600 if (is_white(cmdline[i]))
601 (*start)++;
602 else
603 found_start = true;
604 } else {
605 if (is_white(cmdline[i]))
606 break;
607 }
608 }
609 *end = i - 1;
610
611 return found_start;
612}
Note: See TracBrowser for help on using the repository browser.