[qemu.git] / chardev / char-mux.c

/*
 * QEMU System Emulator
 *
 * Copyright (c) 2003-2008 Fabrice Bellard
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#include "qemu/osdep.h"
#include "qapi/error.h"
#include "qemu-common.h"
#include "sysemu/char.h"
#include "sysemu/block-backend.h"
#include "char-mux.h"

/* MUX driver for serial I/O splitting */

/* Called with chr_write_lock held.  */
static int mux_chr_write(Chardev *chr, const uint8_t *buf, int len)
{
    MuxChardev *d = MUX_CHARDEV(chr);
    int ret;
    if (!d->timestamps) {
        ret = qemu_chr_fe_write(&d->chr, buf, len);
    } else {
        int i;

        ret = 0;
        for (i = 0; i < len; i++) {
            if (d->linestart) {
                char buf1[64];
                int64_t ti;
                int secs;

                ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
                if (d->timestamps_start == -1) {
                    d->timestamps_start = ti;
                }
                ti -= d->timestamps_start;
                secs = ti / 1000;
                snprintf(buf1, sizeof(buf1),
                         "[%02d:%02d:%02d.%03d] ",
                         secs / 3600,
                         (secs / 60) % 60,
                         secs % 60,
                         (int)(ti % 1000));
                /* XXX this blocks entire thread. Rewrite to use
                 * qemu_chr_fe_write and background I/O callbacks */
                qemu_chr_fe_write_all(&d->chr,
                                      (uint8_t *)buf1, strlen(buf1));
                d->linestart = 0;
            }
            ret += qemu_chr_fe_write(&d->chr, buf + i, 1);
            if (buf[i] == '\n') {
                d->linestart = 1;
            }
        }
    }
    return ret;
}

static const char * const mux_help[] = {
    "% h    print this help\n\r",
    "% x    exit emulator\n\r",
    "% s    save disk data back to file (if -snapshot)\n\r",
    "% t    toggle console timestamps\n\r",
    "% b    send break (magic sysrq)\n\r",
    "% c    switch between console and monitor\n\r",
    "% %  sends %\n\r",
    NULL
};

int term_escape_char = 0x01; /* ctrl-a is used for escape */
static void mux_print_help(Chardev *chr)
{
    int i, j;
    char ebuf[15] = "Escape-Char";
    char cbuf[50] = "\n\r";

    if (term_escape_char > 0 && term_escape_char < 26) {
        snprintf(cbuf, sizeof(cbuf), "\n\r");
        snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
    } else {
        snprintf(cbuf, sizeof(cbuf),
                 "\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
                 term_escape_char);
    }
    /* XXX this blocks entire thread. Rewrite to use
     * qemu_chr_fe_write and background I/O callbacks */
    qemu_chr_write_all(chr, (uint8_t *)cbuf, strlen(cbuf));
    for (i = 0; mux_help[i] != NULL; i++) {
        for (j = 0; mux_help[i][j] != '\0'; j++) {
            if (mux_help[i][j] == '%') {
                qemu_chr_write_all(chr, (uint8_t *)ebuf, strlen(ebuf));
            } else {
                qemu_chr_write_all(chr, (uint8_t *)&mux_help[i][j], 1);
            }
        }
    }
}

void mux_chr_send_event(MuxChardev *d, int mux_nr, int event)
{
    CharBackend *be = d->backends[mux_nr];

    if (be && be->chr_event) {
        be->chr_event(be->opaque, event);
    }
}

static int mux_proc_byte(Chardev *chr, MuxChardev *d, int ch)
{
    if (d->term_got_escape) {
        d->term_got_escape = 0;
        if (ch == term_escape_char) {
            goto send_char;
        }
        switch (ch) {
        case '?':
        case 'h':
            mux_print_help(chr);
            break;
        case 'x':
            {
                 const char *term =  "QEMU: Terminated\n\r";
                 qemu_chr_write_all(chr, (uint8_t *)term, strlen(term));
                 exit(0);
                 break;
            }
        case 's':
            blk_commit_all();
            break;
        case 'b':
            qemu_chr_be_event(chr, CHR_EVENT_BREAK);
            break;
        case 'c':
            assert(d->mux_cnt > 0); /* handler registered with first fe */
            /* Switch to the next registered device */
            mux_set_focus(chr, (d->focus + 1) % d->mux_cnt);
            break;
        case 't':
            d->timestamps = !d->timestamps;
            d->timestamps_start = -1;
            d->linestart = 0;
            break;
        }
    } else if (ch == term_escape_char) {
        d->term_got_escape = 1;
    } else {
    send_char:
        return 1;
    }
    return 0;
}

static void mux_chr_accept_input(Chardev *chr)
{
    MuxChardev *d = MUX_CHARDEV(chr);
    int m = d->focus;
    CharBackend *be = d->backends[m];

    while (be && d->prod[m] != d->cons[m] &&
           be->chr_can_read && be->chr_can_read(be->opaque)) {
        be->chr_read(be->opaque,
                     &d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
    }
}

static int mux_chr_can_read(void *opaque)
{
    MuxChardev *d = MUX_CHARDEV(opaque);
    int m = d->focus;
    CharBackend *be = d->backends[m];

    if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE) {
        return 1;
    }

    if (be && be->chr_can_read) {
        return be->chr_can_read(be->opaque);
    }

    return 0;
}

static void mux_chr_read(void *opaque, const uint8_t *buf, int size)
{
    Chardev *chr = CHARDEV(opaque);
    MuxChardev *d = MUX_CHARDEV(opaque);
    int m = d->focus;
    CharBackend *be = d->backends[m];
    int i;

    mux_chr_accept_input(opaque);

    for (i = 0; i < size; i++)
        if (mux_proc_byte(chr, d, buf[i])) {
            if (d->prod[m] == d->cons[m] &&
                be && be->chr_can_read &&
                be->chr_can_read(be->opaque)) {
                be->chr_read(be->opaque, &buf[i], 1);
            } else {
                d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
            }
        }
}

bool muxes_realized;

static void mux_chr_event(void *opaque, int event)
{
    MuxChardev *d = MUX_CHARDEV(opaque);
    int i;

    if (!muxes_realized) {
        return;
    }

    /* Send the event to all registered listeners */
    for (i = 0; i < d->mux_cnt; i++) {
        mux_chr_send_event(d, i, event);
    }
}

static GSource *mux_chr_add_watch(Chardev *s, GIOCondition cond)
{
    MuxChardev *d = MUX_CHARDEV(s);
    Chardev *chr = qemu_chr_fe_get_driver(&d->chr);
    ChardevClass *cc = CHARDEV_GET_CLASS(chr);

    if (!cc->chr_add_watch) {
        return NULL;
    }

    return cc->chr_add_watch(chr, cond);
}

static void char_mux_finalize(Object *obj)
{
    MuxChardev *d = MUX_CHARDEV(obj);
    int i;

    for (i = 0; i < d->mux_cnt; i++) {
        CharBackend *be = d->backends[i];
        if (be) {
            be->chr = NULL;
        }
    }
    qemu_chr_fe_deinit(&d->chr);
}

void mux_chr_set_handlers(Chardev *chr, GMainContext *context)
{
    MuxChardev *d = MUX_CHARDEV(chr);

    /* Fix up the real driver with mux routines */
    qemu_chr_fe_set_handlers(&d->chr,
                             mux_chr_can_read,
                             mux_chr_read,
                             mux_chr_event,
                             chr,
                             context, true);
}

void mux_set_focus(Chardev *chr, int focus)
{
    MuxChardev *d = MUX_CHARDEV(chr);

    assert(focus >= 0);
    assert(focus < d->mux_cnt);

    if (d->focus != -1) {
        mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
    }

    d->focus = focus;
    mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
}

static void qemu_chr_open_mux(Chardev *chr,
                              ChardevBackend *backend,
                              bool *be_opened,
                              Error **errp)
{
    ChardevMux *mux = backend->u.mux.data;
    Chardev *drv;
    MuxChardev *d = MUX_CHARDEV(chr);

    drv = qemu_chr_find(mux->chardev);
    if (drv == NULL) {
        error_setg(errp, "mux: base chardev %s not found", mux->chardev);
        return;
    }

    d->focus = -1;
    /* only default to opened state if we've realized the initial
     * set of muxes
     */
    *be_opened = muxes_realized;
    qemu_chr_fe_init(&d->chr, drv, errp);
}

static void qemu_chr_parse_mux(QemuOpts *opts, ChardevBackend *backend,
                               Error **errp)
{
    const char *chardev = qemu_opt_get(opts, "chardev");
    ChardevMux *mux;

    if (chardev == NULL) {
        error_setg(errp, "chardev: mux: no chardev given");
        return;
    }
    backend->type = CHARDEV_BACKEND_KIND_MUX;
    mux = backend->u.mux.data = g_new0(ChardevMux, 1);
    qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
    mux->chardev = g_strdup(chardev);
}

static void char_mux_class_init(ObjectClass *oc, void *data)
{
    ChardevClass *cc = CHARDEV_CLASS(oc);

    cc->parse = qemu_chr_parse_mux;
    cc->open = qemu_chr_open_mux;
    cc->chr_write = mux_chr_write;
    cc->chr_accept_input = mux_chr_accept_input;
    cc->chr_add_watch = mux_chr_add_watch;
}

static const TypeInfo char_mux_type_info = {
    .name = TYPE_CHARDEV_MUX,
    .parent = TYPE_CHARDEV,
    .class_init = char_mux_class_init,
    .instance_size = sizeof(MuxChardev),
    .instance_finalize = char_mux_finalize,
};

static void register_types(void)
{
    type_register_static(&char_mux_type_info);
}

type_init(register_types);
Commit	Line	Data
df85a78b MAL	1	/*
	2	* QEMU System Emulator
	3	*
	4	* Copyright (c) 2003-2008 Fabrice Bellard
	5	*
	6	* Permission is hereby granted, free of charge, to any person obtaining a copy
	7	* of this software and associated documentation files (the "Software"), to deal
	8	* in the Software without restriction, including without limitation the rights
	9	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	10	* copies of the Software, and to permit persons to whom the Software is
	11	* furnished to do so, subject to the following conditions:
	12	*
	13	* The above copyright notice and this permission notice shall be included in
	14	* all copies or substantial portions of the Software.
	15	*
	16	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	17	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	18	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
	19	* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	20	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	21	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
	22	* THE SOFTWARE.
	23	*/
	24	#include "qemu/osdep.h"
	25	#include "qapi/error.h"
	26	#include "qemu-common.h"
	27	#include "sysemu/char.h"
	28	#include "sysemu/block-backend.h"
	29	#include "char-mux.h"
	30
	31	/* MUX driver for serial I/O splitting */
	32
	33	/* Called with chr_write_lock held. */
	34	static int mux_chr_write(Chardev chr, const uint8_t buf, int len)
	35	{
	36	MuxChardev *d = MUX_CHARDEV(chr);
	37	int ret;
	38	if (!d->timestamps) {
	39	ret = qemu_chr_fe_write(&d->chr, buf, len);
	40	} else {
	41	int i;
	42
	43	ret = 0;
	44	for (i = 0; i < len; i++) {
	45	if (d->linestart) {
	46	char buf1[64];
	47	int64_t ti;
	48	int secs;
	49
	50	ti = qemu_clock_get_ms(QEMU_CLOCK_REALTIME);
	51	if (d->timestamps_start == -1) {
	52	d->timestamps_start = ti;
	53	}
	54	ti -= d->timestamps_start;
	55	secs = ti / 1000;
	56	snprintf(buf1, sizeof(buf1),
	57	"[%02d:%02d:%02d.%03d] ",
	58	secs / 3600,
	59	(secs / 60) % 60,
	60	secs % 60,
	61	(int)(ti % 1000));
	62	/* XXX this blocks entire thread. Rewrite to use
	63	* qemu_chr_fe_write and background I/O callbacks */
	64	qemu_chr_fe_write_all(&d->chr,
65	(uint8_t *)buf1, strlen(buf1));
66	d->linestart = 0;
67	}
68	ret += qemu_chr_fe_write(&d->chr, buf + i, 1);
69	if (buf[i] == '\n') {
70	d->linestart = 1;
71	}
72	}
73	}
74	return ret;
75	}
76
77	static const char * const mux_help[] = {
78	"% h print this help\n\r",
79	"% x exit emulator\n\r",
80	"% s save disk data back to file (if -snapshot)\n\r",
81	"% t toggle console timestamps\n\r",
82	"% b send break (magic sysrq)\n\r",
83	"% c switch between console and monitor\n\r",
84	"% % sends %\n\r",
85	NULL
86	};
87
88	int term_escape_char = 0x01; /* ctrl-a is used for escape */
89	static void mux_print_help(Chardev *chr)
90	{
91	int i, j;
92	char ebuf[15] = "Escape-Char";
93	char cbuf[50] = "\n\r";
94
95	if (term_escape_char > 0 && term_escape_char < 26) {
96	snprintf(cbuf, sizeof(cbuf), "\n\r");
97	snprintf(ebuf, sizeof(ebuf), "C-%c", term_escape_char - 1 + 'a');
98	} else {
99	snprintf(cbuf, sizeof(cbuf),
100	"\n\rEscape-Char set to Ascii: 0x%02x\n\r\n\r",
101	term_escape_char);
102	}
103	/* XXX this blocks entire thread. Rewrite to use
104	* qemu_chr_fe_write and background I/O callbacks */
105	qemu_chr_write_all(chr, (uint8_t *)cbuf, strlen(cbuf));
106	for (i = 0; mux_help[i] != NULL; i++) {
107	for (j = 0; mux_help[i][j] != '\0'; j++) {
108	if (mux_help[i][j] == '%') {
109	qemu_chr_write_all(chr, (uint8_t *)ebuf, strlen(ebuf));
110	} else {
111	qemu_chr_write_all(chr, (uint8_t *)&mux_help[i][j], 1);
112	}
113	}
114	}
115	}
116
117	void mux_chr_send_event(MuxChardev *d, int mux_nr, int event)
118	{
119	CharBackend *be = d->backends[mux_nr];
120
121	if (be && be->chr_event) {
122	be->chr_event(be->opaque, event);
123	}
124	}
125
126	static int mux_proc_byte(Chardev chr, MuxChardev d, int ch)
127	{
128	if (d->term_got_escape) {
129	d->term_got_escape = 0;
130	if (ch == term_escape_char) {
131	goto send_char;
132	}
133	switch (ch) {
134	case '?':
135	case 'h':
136	mux_print_help(chr);
137	break;
138	case 'x':
139	{
140	const char *term = "QEMU: Terminated\n\r";
141	qemu_chr_write_all(chr, (uint8_t *)term, strlen(term));
142	exit(0);
143	break;
144	}
145	case 's':
146	blk_commit_all();
147	break;
148	case 'b':
149	qemu_chr_be_event(chr, CHR_EVENT_BREAK);
150	break;
151	case 'c':
152	assert(d->mux_cnt > 0); /* handler registered with first fe */
153	/* Switch to the next registered device */
154	mux_set_focus(chr, (d->focus + 1) % d->mux_cnt);
155	break;
156	case 't':
157	d->timestamps = !d->timestamps;
158	d->timestamps_start = -1;
159	d->linestart = 0;
160	break;
161	}
162	} else if (ch == term_escape_char) {
163	d->term_got_escape = 1;
164	} else {
165	send_char:
166	return 1;
167	}
168	return 0;
169	}
170
171	static void mux_chr_accept_input(Chardev *chr)
172	{
173	MuxChardev *d = MUX_CHARDEV(chr);
174	int m = d->focus;
175	CharBackend *be = d->backends[m];
176
177	while (be && d->prod[m] != d->cons[m] &&
178	be->chr_can_read && be->chr_can_read(be->opaque)) {
179	be->chr_read(be->opaque,
180	&d->buffer[m][d->cons[m]++ & MUX_BUFFER_MASK], 1);
181	}
182	}
183
184	static int mux_chr_can_read(void *opaque)
185	{
186	MuxChardev *d = MUX_CHARDEV(opaque);
187	int m = d->focus;
188	CharBackend *be = d->backends[m];
189
190	if ((d->prod[m] - d->cons[m]) < MUX_BUFFER_SIZE) {
191	return 1;
192	}
193
194	if (be && be->chr_can_read) {
195	return be->chr_can_read(be->opaque);
196	}
197
198	return 0;
199	}
200
201	static void mux_chr_read(void opaque, const uint8_t buf, int size)
202	{
203	Chardev *chr = CHARDEV(opaque);
204	MuxChardev *d = MUX_CHARDEV(opaque);
205	int m = d->focus;
206	CharBackend *be = d->backends[m];
207	int i;
208
209	mux_chr_accept_input(opaque);
210
211	for (i = 0; i < size; i++)
212	if (mux_proc_byte(chr, d, buf[i])) {
213	if (d->prod[m] == d->cons[m] &&
214	be && be->chr_can_read &&
215	be->chr_can_read(be->opaque)) {
216	be->chr_read(be->opaque, &buf[i], 1);
217	} else {
218	d->buffer[m][d->prod[m]++ & MUX_BUFFER_MASK] = buf[i];
219	}
220	}
221	}
222
223	bool muxes_realized;
224
225	static void mux_chr_event(void *opaque, int event)
226	{
227	MuxChardev *d = MUX_CHARDEV(opaque);
228	int i;
229
230	if (!muxes_realized) {
231	return;
232	}
233
234	/* Send the event to all registered listeners */
235	for (i = 0; i < d->mux_cnt; i++) {
236	mux_chr_send_event(d, i, event);
237	}
238	}
239
240	static GSource mux_chr_add_watch(Chardev s, GIOCondition cond)
241	{
242	MuxChardev *d = MUX_CHARDEV(s);
243	Chardev *chr = qemu_chr_fe_get_driver(&d->chr);
244	ChardevClass *cc = CHARDEV_GET_CLASS(chr);
245
246	if (!cc->chr_add_watch) {
247	return NULL;
248	}
249
250	return cc->chr_add_watch(chr, cond);
251	}
252
253	static void char_mux_finalize(Object *obj)
254	{
255	MuxChardev *d = MUX_CHARDEV(obj);
256	int i;
257
258	for (i = 0; i < d->mux_cnt; i++) {
259	CharBackend *be = d->backends[i];
260	if (be) {
261	be->chr = NULL;
262	}
263	}
264	qemu_chr_fe_deinit(&d->chr);
265	}
266
267	void mux_chr_set_handlers(Chardev chr, GMainContext context)
268	{
269	MuxChardev *d = MUX_CHARDEV(chr);
270
271	/* Fix up the real driver with mux routines */
272	qemu_chr_fe_set_handlers(&d->chr,
273	mux_chr_can_read,
274	mux_chr_read,
275	mux_chr_event,
276	chr,
277	context, true);
278	}
279
280	void mux_set_focus(Chardev *chr, int focus)
281	{
282	MuxChardev *d = MUX_CHARDEV(chr);
283
284	assert(focus >= 0);
285	assert(focus < d->mux_cnt);
286
287	if (d->focus != -1) {
288	mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_OUT);
289	}
290
291	d->focus = focus;
292	mux_chr_send_event(d, d->focus, CHR_EVENT_MUX_IN);
293	}
294
295	static void qemu_chr_open_mux(Chardev *chr,
296	ChardevBackend *backend,
297	bool *be_opened,
298	Error **errp)
299	{
300	ChardevMux *mux = backend->u.mux.data;
301	Chardev *drv;
302	MuxChardev *d = MUX_CHARDEV(chr);
303
304	drv = qemu_chr_find(mux->chardev);
305	if (drv == NULL) {
306	error_setg(errp, "mux: base chardev %s not found", mux->chardev);
307	return;
308	}
309
310	d->focus = -1;
311	/* only default to opened state if we've realized the initial
312	* set of muxes
313	*/
314	*be_opened = muxes_realized;
315	qemu_chr_fe_init(&d->chr, drv, errp);
316	}
317
318	static void qemu_chr_parse_mux(QemuOpts opts, ChardevBackend backend,
319	Error **errp)
320	{
321	const char *chardev = qemu_opt_get(opts, "chardev");
322	ChardevMux *mux;
323
324	if (chardev == NULL) {
325	error_setg(errp, "chardev: mux: no chardev given");
326	return;
327	}
328	backend->type = CHARDEV_BACKEND_KIND_MUX;
329	mux = backend->u.mux.data = g_new0(ChardevMux, 1);
330	qemu_chr_parse_common(opts, qapi_ChardevMux_base(mux));
331	mux->chardev = g_strdup(chardev);
332	}
333
334	static void char_mux_class_init(ObjectClass oc, void data)
335	{
336	ChardevClass *cc = CHARDEV_CLASS(oc);
337
338	cc->parse = qemu_chr_parse_mux;
339	cc->open = qemu_chr_open_mux;
340	cc->chr_write = mux_chr_write;
341	cc->chr_accept_input = mux_chr_accept_input;
342	cc->chr_add_watch = mux_chr_add_watch;
343	}
344
345	static const TypeInfo char_mux_type_info = {
346	.name = TYPE_CHARDEV_MUX,
347	.parent = TYPE_CHARDEV,
348	.class_init = char_mux_class_init,
349	.instance_size = sizeof(MuxChardev),
350	.instance_finalize = char_mux_finalize,
351	};
352
353	static void register_types(void)
354	{
355	type_register_static(&char_mux_type_info);
356	}
357
358	type_init(register_types);