source: mainline/kernel/generic/src/console/kconsole.c@ 5d67baa

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

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