source: mainline/generic/src/console/kconsole.c@ 0c8e692

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since 0c8e692 was 0c8e692, checked in by Ondrej Palkovsky <ondrap@…>, 20 years ago

Added some readline functionality to kconsole.
Arrows editing, history, tab completion.
  • Property mode set to 100644
File size: 13.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 <list.h>
38#include <arch.h>
39#include <macros.h>
40#include <debug.h>
41#include <func.h>
42#include <symtab.h>
43
44/** Simple kernel console.
45 *
46 * The console is realized by kernel thread kconsole.
47 * It doesn't understand any useful command on its own,
48 * but makes it possible for other kernel subsystems to
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
67spinlock_t cmd_lock; /**< Lock protecting command list. */
68link_t cmd_head; /**< Command list. */
69
70static cmd_info_t *parse_cmdline(char *cmdline, size_t len);
71static bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end);
72static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
73
74/** Initialize kconsole data structures. */
75void kconsole_init(void)
76{
77 int i;
78
79 spinlock_initialize(&cmd_lock, "kconsole_cmd");
80 list_initialize(&cmd_head);
81
82 cmd_init();
83 for (i=0; i<KCONSOLE_HISTORY; i++)
84 history[i][0] = '\0';
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 */
94int 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
124 if ((strncmp(hlp->name, cmd->name, strlen(cmd->name)) == 0)) {
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
145static void rdln_print_c(char ch, int count)
146{
147 int i;
148 for (i=0;i<count;i++)
149 putchar(ch);
150}
151
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
161static 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 */
195static 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
218 if (found > 1) {
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
233static 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;
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') {
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') {
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 if (found == 1) { /* One match */
290 for (i=position;i<curlen;i++)
291 putchar(current[i]);
292 position += strlen(tmp);
293 /* Add space to end */
294 if (position == curlen && curlen < MAX_CMDLINE) {
295 current[position] = ' ';
296 curlen++;
297 position++;
298 putchar(' ');
299 }
300 } else {
301 printf("%s> ", prompt);
302 for (i=0; i<curlen;i++)
303 putchar(current[i]);
304 position += strlen(tmp);
305 }
306 rdln_print_c('\b', curlen-position);
307 continue;
308 }
309 if (c == 0x1b) {
310 c = _getc(input);
311 if (c!= 0x5b)
312 continue;
313 c = _getc(input);
314 if (c == 0x44) { /* Left */
315 if (position > 0) {
316 putchar('\b');
317 position--;
318 }
319 continue;
320 }
321 if (c == 0x43) { /* Right */
322 if (position < curlen) {
323 putchar(current[position]);
324 position++;
325 }
326 continue;
327 }
328 if (c == 0x41 || c == 0x42) { /* Up,down */
329 rdln_print_c('\b',position);
330 rdln_print_c(' ',curlen);
331 rdln_print_c('\b',curlen);
332 if (c == 0x41)
333 histposition--;
334 else
335 histposition++;
336 if (histposition < 0)
337 histposition = KCONSOLE_HISTORY -1 ;
338 else
339 histposition = histposition % KCONSOLE_HISTORY;
340 current = history[histposition];
341 printf("%s", current);
342 curlen = strlen(current);
343 position = curlen;
344 continue;
345 }
346 continue;
347 }
348 if (curlen >= MAX_CMDLINE)
349 continue;
350
351 insert_char(current, c, position);
352
353 curlen++;
354 for (i=position;i<curlen;i++)
355 putchar(current[i]);
356 position++;
357 rdln_print_c('\b',curlen-position);
358 }
359 histposition++;
360 histposition = histposition % KCONSOLE_HISTORY;
361 current[curlen] = '\0';
362 return current;
363}
364
365/** Kernel console managing thread.
366 *
367 * @param arg Not used.
368 */
369void kconsole(void *arg)
370{
371 cmd_info_t *cmd_info;
372 count_t len;
373 char *cmdline;
374
375 if (!stdin) {
376 printf("%s: no stdin\n", __FUNCTION__);
377 return;
378 }
379
380 while (true) {
381 cmdline = clever_readline(__FUNCTION__, stdin);
382 len = strlen(cmdline);
383 if (!len)
384 continue;
385 cmd_info = parse_cmdline(cmdline, len);
386 if (!cmd_info)
387 continue;
388 (void) cmd_info->func(cmd_info->argv);
389 }
390}
391
392static int parse_int_arg(char *text, size_t len, __native *result)
393{
394 char symname[MAX_SYMBOL_NAME];
395 __address symaddr;
396 bool isaddr = false;
397 bool isptr = false;
398
399 /* If we get a name, try to find it in symbol table */
400 if (text[0] < '0' | text[0] > '9') {
401 if (text[0] == '&') {
402 isaddr = true;
403 text++;len--;
404 } else if (text[0] == '*') {
405 isptr = true;
406 text++;len--;
407 }
408 strncpy(symname, text, min(len+1, MAX_SYMBOL_NAME));
409 symaddr = get_symbol_addr(symname);
410 if (!symaddr) {
411 printf("Symbol %s not found.\n",symname);
412 return -1;
413 }
414 if (symaddr == (__address) -1) {
415 printf("Duplicate symbol %s.\n",symname);
416 symtab_print_search(symname);
417 return -1;
418 }
419 if (isaddr)
420 *result = (__native)symaddr;
421 else if (isptr)
422 *result = **((__native **)symaddr);
423 else
424 *result = *((__native *)symaddr);
425 } else /* It's a number - convert it */
426 *result = atoi(text);
427 return 0;
428}
429
430/** Parse command line.
431 *
432 * @param cmdline Command line as read from input device.
433 * @param len Command line length.
434 *
435 * @return Structure describing the command.
436 */
437cmd_info_t *parse_cmdline(char *cmdline, size_t len)
438{
439 index_t start = 0, end = 0;
440 cmd_info_t *cmd = NULL;
441 link_t *cur;
442 ipl_t ipl;
443 int i;
444
445 if (!parse_argument(cmdline, len, &start, &end)) {
446 /* Command line did not contain alphanumeric word. */
447 return NULL;
448 }
449
450 spinlock_lock(&cmd_lock);
451
452 for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
453 cmd_info_t *hlp;
454
455 hlp = list_get_instance(cur, cmd_info_t, link);
456 spinlock_lock(&hlp->lock);
457
458 if (strncmp(hlp->name, &cmdline[start], (end - start) + 1) == 0) {
459 cmd = hlp;
460 break;
461 }
462
463 spinlock_unlock(&hlp->lock);
464 }
465
466 spinlock_unlock(&cmd_lock);
467
468 if (!cmd) {
469 /* Unknown command. */
470 printf("Unknown command.\n");
471 return NULL;
472 }
473
474 /* cmd == hlp is locked */
475
476 /*
477 * The command line must be further analyzed and
478 * the parameters therefrom must be matched and
479 * converted to those specified in the cmd info
480 * structure.
481 */
482
483 for (i = 0; i < cmd->argc; i++) {
484 char *buf;
485 start = end + 1;
486 if (!parse_argument(cmdline, len, &start, &end)) {
487 printf("Too few arguments.\n");
488 spinlock_unlock(&cmd->lock);
489 return NULL;
490 }
491
492 switch (cmd->argv[i].type) {
493 case ARG_TYPE_STRING:
494 buf = cmd->argv[i].buffer;
495 strncpy(buf, (const char *) &cmdline[start], min((end - start) + 2, cmd->argv[i].len));
496 buf[min((end - start) + 1, cmd->argv[i].len - 1)] = '\0';
497 break;
498 case ARG_TYPE_INT:
499 if (parse_int_arg(cmdline+start, end-start+1,
500 &cmd->argv[i].intval))
501 return NULL;
502 break;
503 case ARG_TYPE_VAR:
504 if (start != end && cmdline[start] == '"' && cmdline[end] == '"') {
505 buf = cmd->argv[i].buffer;
506 strncpy(buf, (const char *) &cmdline[start+1],
507 min((end-start), cmd->argv[i].len));
508 buf[min((end - start), cmd->argv[i].len - 1)] = '\0';
509 cmd->argv[i].intval = (__native) buf;
510 cmd->argv[i].vartype = ARG_TYPE_STRING;
511 } else if (!parse_int_arg(cmdline+start, end-start+1,
512 &cmd->argv[i].intval))
513 cmd->argv[i].vartype = ARG_TYPE_INT;
514 else {
515 printf("Unrecognized variable argument.\n");
516 return NULL;
517 }
518 break;
519 case ARG_TYPE_INVALID:
520 default:
521 printf("invalid argument type\n");
522 return NULL;
523 break;
524 }
525 }
526
527 start = end + 1;
528 if (parse_argument(cmdline, len, &start, &end)) {
529 printf("Too many arguments.\n");
530 spinlock_unlock(&cmd->lock);
531 return NULL;
532 }
533
534 spinlock_unlock(&cmd->lock);
535 return cmd;
536}
537
538/** Parse argument.
539 *
540 * Find start and end positions of command line argument.
541 *
542 * @param cmdline Command line as read from the input device.
543 * @param len Number of characters in cmdline.
544 * @param start On entry, 'start' contains pointer to the index
545 * of first unprocessed character of cmdline.
546 * On successful exit, it marks beginning of the next argument.
547 * @param end Undefined on entry. On exit, 'end' points to the last character
548 * of the next argument.
549 *
550 * @return false on failure, true on success.
551 */
552bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end)
553{
554 int i;
555 bool found_start = false;
556
557 ASSERT(start != NULL);
558 ASSERT(end != NULL);
559
560 for (i = *start; i < len; i++) {
561 if (!found_start) {
562 if (is_white(cmdline[i]))
563 (*start)++;
564 else
565 found_start = true;
566 } else {
567 if (is_white(cmdline[i]))
568 break;
569 }
570 }
571 *end = i - 1;
572
573 return found_start;
574}
Note: See TracBrowser for help on using the repository browser.