Subversion Repositories HelenOS

Rev

Rev 4323 | 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>
3097 decky 38
#include <sysinfo/sysinfo.h>
510 jermar 39
#include <synch/waitq.h>
40
#include <synch/spinlock.h>
41
#include <arch/types.h>
3097 decky 42
#include <ddi/irq.h>
43
#include <ddi/ddi.h>
4252 decky 44
#include <ipc/event.h>
3097 decky 45
#include <ipc/irq.h>
510 jermar 46
#include <arch.h>
607 palkovsky 47
#include <print.h>
4180 decky 48
#include <putchar.h>
1104 jermar 49
#include <atomic.h>
4146 decky 50
#include <syscall/copy.h>
51
#include <errno.h>
4218 decky 52
#include <string.h>
510 jermar 53
 
4252 decky 54
#define KLOG_PAGES    4
55
#define KLOG_LENGTH   (KLOG_PAGES * PAGE_SIZE / sizeof(wchar_t))
4180 decky 56
#define KLOG_LATENCY  8
1050 palkovsky 57
 
3965 svoboda 58
/** Kernel log cyclic buffer */
4226 svoboda 59
static wchar_t klog[KLOG_LENGTH] __attribute__ ((aligned (PAGE_SIZE)));
3065 decky 60
 
3965 svoboda 61
/** Kernel log initialized */
3097 decky 62
static bool klog_inited = false;
3965 svoboda 63
/** First kernel log characters */
4490 decky 64
static size_t klog_start = 0;
3965 svoboda 65
/** Number of valid kernel log characters */
3065 decky 66
static size_t klog_len = 0;
3965 svoboda 67
/** Number of stored (not printed) kernel log characters */
3065 decky 68
static size_t klog_stored = 0;
3965 svoboda 69
/** Number of stored kernel log characters for uspace */
3097 decky 70
static size_t klog_uspace = 0;
3065 decky 71
 
3965 svoboda 72
/** Kernel log spinlock */
3097 decky 73
SPINLOCK_INITIALIZE(klog_lock);
74
 
75
/** Physical memory area used for klog buffer */
76
static parea_t klog_parea;
3844 decky 77
 
4310 decky 78
static indev_operations_t stdin_ops = {
79
    .poll = NULL
80
};
81
 
82
/** Silence output */
83
bool silent = false;
84
 
4087 decky 85
/** Standard input and output character devices */
86
indev_t *stdin = NULL;
87
outdev_t *stdout = NULL;
3097 decky 88
 
4310 decky 89
indev_t *stdin_wire(void)
90
{
91
    if (stdin == NULL) {
92
        stdin = malloc(sizeof(indev_t), FRAME_ATOMIC);
93
        if (stdin != NULL)
94
            indev_initialize("stdin", stdin, &stdin_ops);
95
    }
96
 
97
    return stdin;
98
}
99
 
3097 decky 100
/** Initialize kernel logging facility
101
 *
102
 * The shared area contains kernel cyclic buffer. Userspace application may
103
 * be notified on new data with indication of position and size
104
 * of the data within the circular buffer.
4087 decky 105
 *
3097 decky 106
 */
107
void klog_init(void)
108
{
109
    void *faddr = (void *) KA2PA(klog);
110
 
111
    ASSERT((uintptr_t) faddr % FRAME_SIZE == 0);
112
 
113
    klog_parea.pbase = (uintptr_t) faddr;
4180 decky 114
    klog_parea.frames = SIZE2FRAMES(sizeof(klog));
3097 decky 115
    ddi_parea_register(&klog_parea);
4087 decky 116
 
3097 decky 117
    sysinfo_set_item_val("klog.faddr", NULL, (unative_t) faddr);
4252 decky 118
    sysinfo_set_item_val("klog.pages", NULL, KLOG_PAGES);
3097 decky 119
 
120
    spinlock_lock(&klog_lock);
121
    klog_inited = true;
122
    spinlock_unlock(&klog_lock);
123
}
124
 
3844 decky 125
void grab_console(void)
126
{
4323 decky 127
    bool prev = silent;
128
 
3844 decky 129
    silent = false;
130
    arch_grab_console();
4318 decky 131
 
132
    /* Force the console to print the prompt */
4323 decky 133
    if ((stdin) && (prev))
4318 decky 134
        indev_push_character(stdin, '\n');
3844 decky 135
}
136
 
137
void release_console(void)
138
{
139
    silent = true;
140
    arch_release_console();
141
}
142
 
4146 decky 143
/** Tell kernel to get keyboard/console access again */
144
unative_t sys_debug_enable_console(void)
145
{
146
#ifdef CONFIG_KCONSOLE
147
    grab_console();
148
    return true;
149
#else
150
    return false;
151
#endif
152
}
153
 
154
/** Tell kernel to relinquish keyboard/console access */
155
unative_t sys_debug_disable_console(void)
156
{
157
    release_console();
158
    return true;
159
}
160
 
4087 decky 161
/** Get string from input character device.
510 jermar 162
 *
4087 decky 163
 * Read characters from input character device until first occurrence
510 jermar 164
 * of newline character.
165
 *
4087 decky 166
 * @param indev  Input character device.
4218 decky 167
 * @param buf    Buffer where to store string terminated by NULL.
1708 jermar 168
 * @param buflen Size of the buffer.
517 jermar 169
 *
170
 * @return Number of characters read.
4087 decky 171
 *
510 jermar 172
 */
4490 decky 173
size_t gets(indev_t *indev, char *buf, size_t buflen)
510 jermar 174
{
4218 decky 175
    size_t offset = 0;
4490 decky 176
    size_t count = 0;
4218 decky 177
    buf[offset] = 0;
3844 decky 178
 
4218 decky 179
    wchar_t ch;
4310 decky 180
    while ((ch = indev_pop_character(indev)) != '\n') {
588 palkovsky 181
        if (ch == '\b') {
4218 decky 182
            if (count > 0) {
183
                /* Space, backspace, space */
588 palkovsky 184
                putchar('\b');
185
                putchar(' ');
186
                putchar('\b');
4218 decky 187
 
188
                count--;
189
                offset = str_lsize(buf, count);
190
                buf[offset] = 0;
588 palkovsky 191
            }
510 jermar 192
        }
4218 decky 193
        if (chr_encode(ch, buf, &offset, buflen - 1) == EOK) {
194
            putchar(ch);
195
            count++;
196
            buf[offset] = 0;
197
        }
510 jermar 198
    }
4087 decky 199
 
4218 decky 200
    return count;
510 jermar 201
}
202
 
4087 decky 203
/** Get character from input device & echo it to screen */
4218 decky 204
wchar_t getc(indev_t *indev)
510 jermar 205
{
4310 decky 206
    wchar_t ch = indev_pop_character(indev);
588 palkovsky 207
    putchar(ch);
510 jermar 208
    return ch;
209
}
575 palkovsky 210
 
3097 decky 211
void klog_update(void)
212
{
213
    spinlock_lock(&klog_lock);
214
 
4194 decky 215
    if ((klog_inited) && (event_is_subscribed(EVENT_KLOG)) && (klog_uspace > 0)) {
4173 jermar 216
        event_notify_3(EVENT_KLOG, klog_start, klog_len, klog_uspace);
217
        klog_uspace = 0;
218
    }
3097 decky 219
 
220
    spinlock_unlock(&klog_lock);
221
}
222
 
4180 decky 223
void putchar(const wchar_t ch)
575 palkovsky 224
{
3097 decky 225
    spinlock_lock(&klog_lock);
226
 
4087 decky 227
    if ((klog_stored > 0) && (stdout) && (stdout->op->write)) {
3065 decky 228
        /* Print charaters stored in kernel log */
4490 decky 229
        size_t i;
3065 decky 230
        for (i = klog_len - klog_stored; i < klog_len; i++)
4226 svoboda 231
            stdout->op->write(stdout, klog[(klog_start + i) % KLOG_LENGTH], silent);
3065 decky 232
        klog_stored = 0;
233
    }
234
 
235
    /* Store character in the cyclic kernel log */
4226 svoboda 236
    klog[(klog_start + klog_len) % KLOG_LENGTH] = ch;
237
    if (klog_len < KLOG_LENGTH)
3065 decky 238
        klog_len++;
239
    else
4226 svoboda 240
        klog_start = (klog_start + 1) % KLOG_LENGTH;
3065 decky 241
 
4087 decky 242
    if ((stdout) && (stdout->op->write))
4180 decky 243
        stdout->op->write(stdout, ch, silent);
3065 decky 244
    else {
245
        /* The character is just in the kernel log */
246
        if (klog_stored < klog_len)
247
            klog_stored++;
248
    }
3097 decky 249
 
250
    /* The character is stored for uspace */
251
    if (klog_uspace < klog_len)
252
        klog_uspace++;
253
 
3113 decky 254
    /* Check notify uspace to update */
255
    bool update;
4180 decky 256
    if ((klog_uspace > KLOG_LATENCY) || (ch == '\n'))
3113 decky 257
        update = true;
258
    else
259
        update = false;
260
 
3097 decky 261
    spinlock_unlock(&klog_lock);
262
 
3113 decky 263
    if (update)
264
        klog_update();
575 palkovsky 265
}
1702 cejka 266
 
4146 decky 267
/** Print using kernel facility
268
 *
269
 * Print to kernel log.
270
 *
271
 */
4218 decky 272
unative_t sys_klog(int fd, const void *buf, size_t size)
4146 decky 273
{
274
    char *data;
275
    int rc;
4180 decky 276
 
4218 decky 277
    if (size > PAGE_SIZE)
4146 decky 278
        return ELIMIT;
279
 
4218 decky 280
    if (size > 0) {
281
        data = (char *) malloc(size + 1, 0);
4146 decky 282
        if (!data)
283
            return ENOMEM;
284
 
4218 decky 285
        rc = copy_from_uspace(data, buf, size);
4146 decky 286
        if (rc) {
287
            free(data);
288
            return rc;
289
        }
4218 decky 290
        data[size] = 0;
4146 decky 291
 
292
        printf("%s", data);
293
        free(data);
294
    } else
295
        klog_update();
296
 
4218 decky 297
    return size;
4146 decky 298
}
299
 
1888 jermar 300
/** @}
1702 cejka 301
 */