Subversion Repositories HelenOS

Rev

Rev 4180 | Rev 4218 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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