Subversion Repositories HelenOS

Rev

Rev 625 | Rev 640 | 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>
609 palkovsky 43
#include <macros.h>
510 jermar 44
 
517 jermar 45
/** Simple kernel console.
46
 *
47
 * The console is realized by kernel thread kconsole.
518 jermar 48
 * It doesn't understand any useful command on its own,
49
 * but makes it possible for other kernel subsystems to
517 jermar 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
 
623 jermar 68
SPINLOCK_INITIALIZE(cmd_lock);  /**< Lock protecting command list. */
624 jermar 69
LIST_INITIALIZE(cmd_head);  /**< Command list. */
517 jermar 70
 
71
static cmd_info_t *parse_cmdline(char *cmdline, size_t len);
518 jermar 72
static bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end);
601 palkovsky 73
static char history[KCONSOLE_HISTORY][MAX_CMDLINE] = {};
517 jermar 74
 
75
/** Initialize kconsole data structures. */
76
void kconsole_init(void)
77
{
601 palkovsky 78
    int i;
79
 
596 jermar 80
    cmd_init();
601 palkovsky 81
    for (i=0; i<KCONSOLE_HISTORY; i++)
82
        history[i][0] = '\0';
517 jermar 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
 */
92
int 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
        }
635 palkovsky 120
        if ((strncmp(hlp->name,
121
                 cmd->name, max(strlen(cmd->name),
122
                        strlen(hlp->name))) == 0)) {
517 jermar 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
 
635 palkovsky 143
/** Print count times a character */
601 palkovsky 144
static void rdln_print_c(char ch, int count)
145
{
146
    int i;
147
    for (i=0;i<count;i++)
148
        putchar(ch);
149
}
150
 
635 palkovsky 151
/** Insert character to string */
601 palkovsky 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
 
635 palkovsky 161
/** Try to find a command begenning with prefix */
601 palkovsky 162
static 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
 */
194
static 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
 
602 palkovsky 217
    if (found > 1 && !strlen(output)) {
601 palkovsky 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
 
232
static 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;
606 palkovsky 240
    char mod; /* Command Modifier */
601 palkovsky 241
    char c;
242
 
243
    printf("%s> ", prompt);
244
    while (1) {
245
        c = _getc(input);
246
        if (c == '\n') {
247
            putchar(c);
248
            break;
607 palkovsky 249
        } if (c == '\b') { /* Backspace */
601 palkovsky 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
        }
607 palkovsky 263
        if (c == '\t') { /* Tabulator */
601 palkovsky 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);
602 palkovsky 289
 
290
            if (strlen(tmp) || found==1) { /* If we have a hint */
291
                for (i=position;i<curlen;i++)
601 palkovsky 292
                    putchar(current[i]);
293
                position += strlen(tmp);
294
                /* Add space to end */
602 palkovsky 295
                if (found == 1 && position == curlen && \
296
                    curlen < MAX_CMDLINE) {
601 palkovsky 297
                    current[position] = ' ';
298
                    curlen++;
299
                    position++;
300
                    putchar(' ');
301
                }
602 palkovsky 302
            } else { /* No hint, table was printed */
601 palkovsky 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
        }
607 palkovsky 311
        if (c == 0x1b) { /* Special command */
606 palkovsky 312
            mod = _getc(input);
601 palkovsky 313
            c = _getc(input);
606 palkovsky 314
 
315
            if (mod != 0x5b && mod != 0x4f)
601 palkovsky 316
                continue;
606 palkovsky 317
 
318
            if (c == 0x33 && _getc(input) == 0x7e) {
607 palkovsky 319
                /* Delete */
606 palkovsky 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
            }
607 palkovsky 334
            else if (c == 0x46) {  /* End */
606 palkovsky 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);
607 palkovsky 358
                if (c == 0x41) /* Up */
601 palkovsky 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
 */
609 palkovsky 397
void kconsole(void *prompt)
510 jermar 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) {
609 palkovsky 409
        cmdline = clever_readline(prompt, stdin);
601 palkovsky 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;
609 palkovsky 416
        if (strncmp(cmd_info->name,"exit", \
417
                min(strlen(cmd_info->name),5)) == 0)
418
            break;
517 jermar 419
        (void) cmd_info->func(cmd_info->argv);
510 jermar 420
    }
421
}
517 jermar 422
 
585 palkovsky 423
static 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;
589 palkovsky 428
    bool isptr = false;
585 palkovsky 429
 
430
    /* If we get a name, try to find it in symbol table */
614 palkovsky 431
    if (text[0] < '0' || text[0] > '9') {
585 palkovsky 432
        if (text[0] == '&') {
433
            isaddr = true;
434
            text++;len--;
589 palkovsky 435
        } else if (text[0] == '*') {
436
            isptr = true;
437
            text++;len--;
585 palkovsky 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;
589 palkovsky 452
        else if (isptr)
453
            *result = **((__native **)symaddr);
585 palkovsky 454
        else
455
            *result = *((__native *)symaddr);
456
    } else /* It's a number - convert it */
457
        *result = atoi(text);
458
    return 0;
459
}
460
 
517 jermar 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
 */
468
cmd_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
 
518 jermar 475
    if (!parse_argument(cmdline, len, &start, &end)) {
517 jermar 476
        /* Command line did not contain alphanumeric word. */
477
        return NULL;
478
    }
479
 
480
    spinlock_lock(&cmd_lock);
481
 
482
    for (cur = cmd_head.next; cur != &cmd_head; cur = cur->next) {
483
        cmd_info_t *hlp;
484
 
485
        hlp = list_get_instance(cur, cmd_info_t, link);
486
        spinlock_lock(&hlp->lock);
487
 
635 palkovsky 488
        if (strncmp(hlp->name, &cmdline[start], max(strlen(hlp->name),
489
                                end-start+1)) == 0) {
517 jermar 490
            cmd = hlp;
491
            break;
492
        }
493
 
494
        spinlock_unlock(&hlp->lock);
495
    }
496
 
497
    spinlock_unlock(&cmd_lock);
498
 
499
    if (!cmd) {
500
        /* Unknown command. */
518 jermar 501
        printf("Unknown command.\n");
517 jermar 502
        return NULL;
503
    }
504
 
505
    /* cmd == hlp is locked */
506
 
507
    /*
508
     * The command line must be further analyzed and
509
     * the parameters therefrom must be matched and
510
     * converted to those specified in the cmd info
511
     * structure.
512
     */
518 jermar 513
 
514
    for (i = 0; i < cmd->argc; i++) {
515
        char *buf;
516
        start = end + 1;
517
        if (!parse_argument(cmdline, len, &start, &end)) {
518
            printf("Too few arguments.\n");
519
            spinlock_unlock(&cmd->lock);
520
            return NULL;
521
        }
522
 
523
        switch (cmd->argv[i].type) {
582 palkovsky 524
        case ARG_TYPE_STRING:
518 jermar 525
                buf = cmd->argv[i].buffer;
585 palkovsky 526
                strncpy(buf, (const char *) &cmdline[start], min((end - start) + 2, cmd->argv[i].len));
518 jermar 527
            buf[min((end - start) + 1, cmd->argv[i].len - 1)] = '\0';
528
            break;
585 palkovsky 529
        case ARG_TYPE_INT:
530
            if (parse_int_arg(cmdline+start, end-start+1,
531
                      &cmd->argv[i].intval))
532
                return NULL;
518 jermar 533
            break;
585 palkovsky 534
        case ARG_TYPE_VAR:
535
            if (start != end && cmdline[start] == '"' && cmdline[end] == '"') {
536
                buf = cmd->argv[i].buffer;
537
                strncpy(buf, (const char *) &cmdline[start+1],
538
                    min((end-start), cmd->argv[i].len));
539
                buf[min((end - start), cmd->argv[i].len - 1)] = '\0';
540
                cmd->argv[i].intval = (__native) buf;
541
                cmd->argv[i].vartype = ARG_TYPE_STRING;
542
            } else if (!parse_int_arg(cmdline+start, end-start+1,
543
                         &cmd->argv[i].intval))
544
                cmd->argv[i].vartype = ARG_TYPE_INT;
545
            else {
546
                printf("Unrecognized variable argument.\n");
547
                return NULL;
582 palkovsky 548
            }
585 palkovsky 549
            break;
582 palkovsky 550
        case ARG_TYPE_INVALID:
551
        default:
552
            printf("invalid argument type\n");
553
            return NULL;
554
            break;
518 jermar 555
        }
556
    }
517 jermar 557
 
518 jermar 558
    start = end + 1;
559
    if (parse_argument(cmdline, len, &start, &end)) {
560
        printf("Too many arguments.\n");
561
        spinlock_unlock(&cmd->lock);
562
        return NULL;
563
    }
564
 
517 jermar 565
    spinlock_unlock(&cmd->lock);
566
    return cmd;
567
}
568
 
518 jermar 569
/** Parse argument.
570
 *
571
 * Find start and end positions of command line argument.
572
 *
573
 * @param cmdline Command line as read from the input device.
574
 * @param len Number of characters in cmdline.
575
 * @param start On entry, 'start' contains pointer to the index
576
 *        of first unprocessed character of cmdline.
577
 *        On successful exit, it marks beginning of the next argument.
578
 * @param end Undefined on entry. On exit, 'end' points to the last character
579
 *        of the next argument.
580
 *
581
 * @return false on failure, true on success.
582
 */
583
bool parse_argument(char *cmdline, size_t len, index_t *start, index_t *end)
584
{
585
    int i;
586
    bool found_start = false;
587
 
588
    ASSERT(start != NULL);
589
    ASSERT(end != NULL);
590
 
591
    for (i = *start; i < len; i++) {
592
        if (!found_start) {
593
            if (is_white(cmdline[i]))
594
                (*start)++;
595
            else
596
                found_start = true;
597
        } else {
598
            if (is_white(cmdline[i]))
599
                break;
600
        }
601
    }
602
    *end = i - 1;
603
 
604
    return found_start;
605
}