source: mainline/kernel/generic/src/console/kconsole.c@ 7e15496

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 7e15496 was e16e0d59, checked in by Jiri Svoboda <jirik.svoboda@…>, 17 years ago

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