Subversion Repositories HelenOS

Rev

Rev 4201 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
510 jermar 1
/*
2071 jermar 2
 * Copyright (c) 2003 Josef Cejka
3
 * Copyright (c) 2005 Jakub Jermar
510 jermar 4
 * All rights reserved.
5
 *
6
 * Redistribution and use in source and binary forms, with or without
7
 * modification, are permitted provided that the following conditions
8
 * are met:
9
 *
10
 * - Redistributions of source code must retain the above copyright
11
 *   notice, this list of conditions and the following disclaimer.
12
 * - Redistributions in binary form must reproduce the above copyright
13
 *   notice, this list of conditions and the following disclaimer in the
14
 *   documentation and/or other materials provided with the distribution.
15
 * - The name of the author may not be used to endorse or promote products
16
 *   derived from this software without specific prior written permission.
17
 *
18
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
19
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
 */
29
 
1888 jermar 30
/** @addtogroup genericconsole
1702 cejka 31
 * @{
32
 */
33
/** @file
34
 */
35
 
510 jermar 36
#include <console/console.h>
37
#include <console/chardev.h>
4055 trochtova 38
#include <sysinfo/sysinfo.h>
510 jermar 39
#include <synch/waitq.h>
40
#include <synch/spinlock.h>
41
#include <arch/types.h>
4055 trochtova 42
#include <ddi/irq.h>
43
#include <ddi/ddi.h>
4296 trochtova 44
#include <ipc/event.h>
4055 trochtova 45
#include <ipc/irq.h>
510 jermar 46
#include <arch.h>
607 palkovsky 47
#include <func.h>
48
#include <print.h>
4201 trochtova 49
#include <putchar.h>
1104 jermar 50
#include <atomic.h>
4156 trochtova 51
#include <syscall/copy.h>
52
#include <errno.h>
4296 trochtova 53
#include <string.h>
510 jermar 54
 
4296 trochtova 55
#define KLOG_PAGES    4
56
#define KLOG_LENGTH   (KLOG_PAGES * PAGE_SIZE / sizeof(wchar_t))
4201 trochtova 57
#define KLOG_LATENCY  8
4055 trochtova 58
 
59
/** Kernel log cyclic buffer */
4296 trochtova 60
static wchar_t klog[KLOG_LENGTH] __attribute__ ((aligned (PAGE_SIZE)));
4055 trochtova 61
 
62
/** Kernel log initialized */
63
static bool klog_inited = false;
64
/** First kernel log characters */
65
static index_t klog_start = 0;
66
/** Number of valid kernel log characters */
67
static size_t klog_len = 0;
68
/** Number of stored (not printed) kernel log characters */
69
static size_t klog_stored = 0;
70
/** Number of stored kernel log characters for uspace */
71
static size_t klog_uspace = 0;
72
 
73
/** Silence output */
74
bool silent = false;
75
 
76
/** Kernel log spinlock */
77
SPINLOCK_INITIALIZE(klog_lock);
78
 
79
/** Physical memory area used for klog buffer */
80
static parea_t klog_parea;
81
 
4156 trochtova 82
/** Standard input and output character devices */
83
indev_t *stdin = NULL;
84
outdev_t *stdout = NULL;
1050 palkovsky 85
 
4055 trochtova 86
/** Initialize kernel logging facility
87
 *
88
 * The shared area contains kernel cyclic buffer. Userspace application may
89
 * be notified on new data with indication of position and size
90
 * of the data within the circular buffer.
4156 trochtova 91
 *
4055 trochtova 92
 */
93
void klog_init(void)
94
{
95
    void *faddr = (void *) KA2PA(klog);
96
 
97
    ASSERT((uintptr_t) faddr % FRAME_SIZE == 0);
98
 
99
    klog_parea.pbase = (uintptr_t) faddr;
4201 trochtova 100
    klog_parea.frames = SIZE2FRAMES(sizeof(klog));
4055 trochtova 101
    ddi_parea_register(&klog_parea);
4156 trochtova 102
 
4055 trochtova 103
    sysinfo_set_item_val("klog.faddr", NULL, (unative_t) faddr);
4296 trochtova 104
    sysinfo_set_item_val("klog.pages", NULL, KLOG_PAGES);
4055 trochtova 105
 
106
    spinlock_lock(&klog_lock);
107
    klog_inited = true;
108
    spinlock_unlock(&klog_lock);
109
}
110
 
111
void grab_console(void)
112
{
113
    silent = false;
114
    arch_grab_console();
115
}
116
 
117
void release_console(void)
118
{
119
    silent = true;
120
    arch_release_console();
121
}
122
 
4156 trochtova 123
/** Tell kernel to get keyboard/console access again */
124
unative_t sys_debug_enable_console(void)
125
{
126
#ifdef CONFIG_KCONSOLE
127
    grab_console();
128
    return true;
129
#else
130
    return false;
131
#endif
132
}
133
 
134
/** Tell kernel to relinquish keyboard/console access */
135
unative_t sys_debug_disable_console(void)
136
{
137
    release_console();
138
    return true;
139
}
140
 
141
bool check_poll(indev_t *indev)
142
{
143
    if (indev == NULL)
144
        return false;
145
 
146
    if (indev->op == NULL)
147
        return false;
148
 
149
    return (indev->op->poll != NULL);
150
}
151
 
152
/** Get character from input character device. Do not echo character.
588 palkovsky 153
 *
4156 trochtova 154
 * @param indev Input character device.
155
 * @return Character read.
588 palkovsky 156
 *
157
 */
4296 trochtova 158
wchar_t _getc(indev_t *indev)
588 palkovsky 159
{
631 palkovsky 160
    if (atomic_get(&haltstate)) {
4156 trochtova 161
        /* If we are here, we are hopefully on the processor that
607 palkovsky 162
         * issued the 'halt' command, so proceed to read the character
163
         * directly from input
164
         */
4156 trochtova 165
        if (check_poll(indev))
166
            return indev->op->poll(indev);
167
 
168
        /* No other way of interacting with user */
169
        interrupts_disable();
170
 
631 palkovsky 171
        if (CPU)
4055 trochtova 172
            printf("cpu%u: ", CPU->id);
631 palkovsky 173
        else
174
            printf("cpu: ");
4156 trochtova 175
        printf("halted (no polling input)\n");
607 palkovsky 176
        cpu_halt();
177
    }
4156 trochtova 178
 
179
    waitq_sleep(&indev->wq);
180
    ipl_t ipl = interrupts_disable();
181
    spinlock_lock(&indev->lock);
4296 trochtova 182
    wchar_t ch = indev->buffer[(indev->index - indev->counter) % INDEV_BUFLEN];
4156 trochtova 183
    indev->counter--;
184
    spinlock_unlock(&indev->lock);
588 palkovsky 185
    interrupts_restore(ipl);
4156 trochtova 186
 
588 palkovsky 187
    return ch;
188
}
189
 
4156 trochtova 190
/** Get string from input character device.
510 jermar 191
 *
4156 trochtova 192
 * Read characters from input character device until first occurrence
510 jermar 193
 * of newline character.
194
 *
4156 trochtova 195
 * @param indev  Input character device.
4296 trochtova 196
 * @param buf    Buffer where to store string terminated by NULL.
1708 jermar 197
 * @param buflen Size of the buffer.
517 jermar 198
 *
199
 * @return Number of characters read.
4156 trochtova 200
 *
510 jermar 201
 */
4156 trochtova 202
count_t gets(indev_t *indev, char *buf, size_t buflen)
510 jermar 203
{
4296 trochtova 204
    size_t offset = 0;
205
    count_t count = 0;
206
    buf[offset] = 0;
4055 trochtova 207
 
4296 trochtova 208
    wchar_t ch;
209
    while ((ch = _getc(indev)) != '\n') {
588 palkovsky 210
        if (ch == '\b') {
4296 trochtova 211
            if (count > 0) {
212
                /* Space, backspace, space */
588 palkovsky 213
                putchar('\b');
214
                putchar(' ');
215
                putchar('\b');
4296 trochtova 216
 
217
                count--;
218
                offset = str_lsize(buf, count);
219
                buf[offset] = 0;
588 palkovsky 220
            }
510 jermar 221
        }
4296 trochtova 222
        if (chr_encode(ch, buf, &offset, buflen - 1) == EOK) {
223
            putchar(ch);
224
            count++;
225
            buf[offset] = 0;
226
        }
510 jermar 227
    }
4156 trochtova 228
 
4296 trochtova 229
    return count;
510 jermar 230
}
231
 
4156 trochtova 232
/** Get character from input device & echo it to screen */
4296 trochtova 233
wchar_t getc(indev_t *indev)
510 jermar 234
{
4296 trochtova 235
    wchar_t ch = _getc(indev);
588 palkovsky 236
    putchar(ch);
510 jermar 237
    return ch;
238
}
575 palkovsky 239
 
4055 trochtova 240
void klog_update(void)
241
{
242
    spinlock_lock(&klog_lock);
243
 
4201 trochtova 244
    if ((klog_inited) && (event_is_subscribed(EVENT_KLOG)) && (klog_uspace > 0)) {
245
        event_notify_3(EVENT_KLOG, klog_start, klog_len, klog_uspace);
246
        klog_uspace = 0;
247
    }
4055 trochtova 248
 
249
    spinlock_unlock(&klog_lock);
250
}
251
 
4201 trochtova 252
void putchar(const wchar_t ch)
575 palkovsky 253
{
4055 trochtova 254
    spinlock_lock(&klog_lock);
255
 
4156 trochtova 256
    if ((klog_stored > 0) && (stdout) && (stdout->op->write)) {
4055 trochtova 257
        /* Print charaters stored in kernel log */
258
        index_t i;
259
        for (i = klog_len - klog_stored; i < klog_len; i++)
4296 trochtova 260
            stdout->op->write(stdout, klog[(klog_start + i) % KLOG_LENGTH], silent);
4055 trochtova 261
        klog_stored = 0;
262
    }
263
 
264
    /* Store character in the cyclic kernel log */
4296 trochtova 265
    klog[(klog_start + klog_len) % KLOG_LENGTH] = ch;
266
    if (klog_len < KLOG_LENGTH)
4055 trochtova 267
        klog_len++;
268
    else
4296 trochtova 269
        klog_start = (klog_start + 1) % KLOG_LENGTH;
4055 trochtova 270
 
4156 trochtova 271
    if ((stdout) && (stdout->op->write))
4201 trochtova 272
        stdout->op->write(stdout, ch, silent);
4055 trochtova 273
    else {
274
        /* The character is just in the kernel log */
275
        if (klog_stored < klog_len)
276
            klog_stored++;
277
    }
278
 
279
    /* The character is stored for uspace */
280
    if (klog_uspace < klog_len)
281
        klog_uspace++;
282
 
283
    /* Check notify uspace to update */
284
    bool update;
4201 trochtova 285
    if ((klog_uspace > KLOG_LATENCY) || (ch == '\n'))
4055 trochtova 286
        update = true;
287
    else
288
        update = false;
289
 
290
    spinlock_unlock(&klog_lock);
291
 
292
    if (update)
293
        klog_update();
575 palkovsky 294
}
1702 cejka 295
 
4156 trochtova 296
/** Print using kernel facility
297
 *
298
 * Print to kernel log.
299
 *
300
 */
4296 trochtova 301
unative_t sys_klog(int fd, const void *buf, size_t size)
4156 trochtova 302
{
303
    char *data;
304
    int rc;
4201 trochtova 305
 
4296 trochtova 306
    if (size > PAGE_SIZE)
4156 trochtova 307
        return ELIMIT;
308
 
4296 trochtova 309
    if (size > 0) {
310
        data = (char *) malloc(size + 1, 0);
4156 trochtova 311
        if (!data)
312
            return ENOMEM;
313
 
4296 trochtova 314
        rc = copy_from_uspace(data, buf, size);
4156 trochtova 315
        if (rc) {
316
            free(data);
317
            return rc;
318
        }
4296 trochtova 319
        data[size] = 0;
4156 trochtova 320
 
321
        printf("%s", data);
322
        free(data);
323
    } else
324
        klog_update();
325
 
4296 trochtova 326
    return size;
4156 trochtova 327
}
328
 
1888 jermar 329
/** @}
1702 cejka 330
 */