[qemu.git] / hw / char / terminal3270.c

/*
 * Terminal 3270 implementation
 *
 * Copyright 2017 IBM Corp.
 *
 * Authors: Yang Chen <[email protected]>
 *          Jing Liu <[email protected]>
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or (at
 * your option) any later version. See the COPYING file in the top-level
 * directory.
 */

#include "qemu/osdep.h"
#include "qapi/error.h"
#include "chardev/char-fe.h"
#include "hw/s390x/3270-ccw.h"

/* Enough spaces for different window sizes. */
#define INPUT_BUFFER_SIZE  1000
/*
 * 1 for header, 1024*2 for datastream, 2 for tail
 * Reserve enough spaces for telnet IAC escape.
 */
#define OUTPUT_BUFFER_SIZE 2051

typedef struct Terminal3270 {
    EmulatedCcw3270Device cdev;
    CharBackend chr;
    uint8_t inv[INPUT_BUFFER_SIZE];
    uint8_t outv[OUTPUT_BUFFER_SIZE];
    int in_len;
    bool handshake_done;
    guint timer_tag;
} Terminal3270;

#define TYPE_TERMINAL_3270 "x-terminal3270"
#define TERMINAL_3270(obj) \
        OBJECT_CHECK(Terminal3270, (obj), TYPE_TERMINAL_3270)

static int terminal_can_read(void *opaque)
{
    Terminal3270 *t = opaque;

    return INPUT_BUFFER_SIZE - t->in_len;
}

/*
 * Protocol handshake done,
 * signal guest by an unsolicited DE irq.
 */
static void TN3270_handshake_done(Terminal3270 *t)
{
    CcwDevice *ccw_dev = CCW_DEVICE(t);
    SubchDev *sch = ccw_dev->sch;

    t->handshake_done = true;
    sch->curr_status.scsw.dstat = SCSW_DSTAT_DEVICE_END;
    css_conditional_io_interrupt(sch);
}

/*
 * Called when the interval is timeout to detect
 * if the client is still alive by Timing Mark.
 */
static gboolean send_timing_mark_cb(gpointer opaque)
{
    Terminal3270 *t = opaque;
    const uint8_t timing[] = {0xff, 0xfd, 0x06};

    qemu_chr_fe_write_all(&t->chr, timing, sizeof(timing));
    return true;
}

/*
 * Receive inbound data from socket.
 * For data given to guest, drop the data boundary IAC, IAC_EOR.
 * TODO:
 * Using "Reset" key on x3270 may result multiple commands in one packet.
 * This usually happens when the user meets a poor traffic of the network.
 * As of now, for such case, we simply terminate the connection,
 * and we should come back here later with a better solution.
 */
static void terminal_read(void *opaque, const uint8_t *buf, int size)
{
    Terminal3270 *t = opaque;
    CcwDevice *ccw_dev = CCW_DEVICE(t);
    SubchDev *sch = ccw_dev->sch;
    int end;

    assert(size <= (INPUT_BUFFER_SIZE - t->in_len));

    if (t->timer_tag) {
        g_source_remove(t->timer_tag);
        t->timer_tag = 0;
    }
    t->timer_tag = g_timeout_add_seconds(600, send_timing_mark_cb, t);

    memcpy(&t->inv[t->in_len], buf, size);
    t->in_len += size;
    if (t->in_len < 2) {
        return;
    }

    if (!t->handshake_done) {
        /*
         * Receiving Terminal Type is the last step of handshake.
         * The data format: IAC SB Terminal-Type IS <terminal type> IAC SE
         * The code for Terminal-Type is 0x18, for IS is 0.
         * Simply check the data format and mark handshake_done.
         */
        if (t->in_len > 6 && t->inv[2] == 0x18 && t->inv[3] == 0x0 &&
            t->inv[t->in_len - 2] == IAC && t->inv[t->in_len - 1] == IAC_SE) {
            TN3270_handshake_done(t);
            t->in_len = 0;
        }
        return;
    }

    for (end = 0; end < t->in_len - 1; end++) {
        if (t->inv[end] == IAC && t->inv[end + 1] == IAC_EOR) {
            break;
        }
    }
    if (end == t->in_len - 2) {
        /* Data is valid for consuming. */
        t->in_len -= 2;
        sch->curr_status.scsw.dstat = SCSW_DSTAT_ATTENTION;
        css_conditional_io_interrupt(sch);
    } else if (end < t->in_len - 2) {
        /* "Reset" key is used. */
        qemu_chr_fe_disconnect(&t->chr);
    } else {
        /* Gathering data. */
        return;
    }
}

static void chr_event(void *opaque, int event)
{
    Terminal3270 *t = opaque;
    CcwDevice *ccw_dev = CCW_DEVICE(t);
    SubchDev *sch = ccw_dev->sch;

    /* Ensure the initial status correct, always reset them. */
    t->in_len = 0;
    t->handshake_done = false;
    if (t->timer_tag) {
        g_source_remove(t->timer_tag);
        t->timer_tag = 0;
    }

    switch (event) {
    case CHR_EVENT_OPENED:
        /*
         * 3270 does handshake firstly by the negotiate options in
         * char-socket.c. Once qemu receives the terminal-type of the
         * client, mark handshake done and trigger everything rolling again.
         */
        t->timer_tag = g_timeout_add_seconds(600, send_timing_mark_cb, t);
        break;
    case CHR_EVENT_CLOSED:
        sch->curr_status.scsw.dstat = SCSW_DSTAT_DEVICE_END;
        css_conditional_io_interrupt(sch);
        break;
    }
}

static void terminal_init(EmulatedCcw3270Device *dev, Error **errp)
{
    Terminal3270 *t = TERMINAL_3270(dev);
    static bool terminal_available;

    if (terminal_available) {
        error_setg(errp, "Multiple 3270 terminals are not supported.");
        return;
    }
    terminal_available = true;
    qemu_chr_fe_set_handlers(&t->chr, terminal_can_read,
                             terminal_read, chr_event, NULL, t, NULL, true);
}

static inline CcwDataStream *get_cds(Terminal3270 *t)
{
    return &(CCW_DEVICE(&t->cdev)->sch->cds);
}

static int read_payload_3270(EmulatedCcw3270Device *dev)
{
    Terminal3270 *t = TERMINAL_3270(dev);
    int len;

    len = MIN(ccw_dstream_avail(get_cds(t)), t->in_len);
    ccw_dstream_write_buf(get_cds(t), t->inv, len);
    t->in_len -= len;

    return len;
}

/* TN3270 uses binary transmission, which needs escape IAC to IAC IAC */
static int insert_IAC_escape_char(uint8_t *outv, int out_len)
{
    int IAC_num = 0, new_out_len, i, j;

    for (i = 0; i < out_len; i++) {
        if (outv[i] == IAC) {
            IAC_num++;
        }
    }
    if (IAC_num == 0) {
        return out_len;
    }
    new_out_len = out_len + IAC_num;
    for (i = out_len - 1, j = new_out_len - 1; j > i && i >= 0; i--, j--) {
        outv[j] = outv[i];
        if (outv[i] == IAC) {
            outv[--j] = IAC;
        }
    }
    return new_out_len;
}

/*
 * Write 3270 outbound to socket.
 * Return the count of 3270 data field if succeeded, zero if failed.
 */
static int write_payload_3270(EmulatedCcw3270Device *dev, uint8_t cmd)
{
    Terminal3270 *t = TERMINAL_3270(dev);
    int retval = 0;
    int count = ccw_dstream_avail(get_cds(t));
    int bound = (OUTPUT_BUFFER_SIZE - 3) / 2;
    int len = MIN(count, bound);
    int out_len = 0;

    if (!t->handshake_done) {
        if (!(t->outv[0] == IAC && t->outv[1] != IAC)) {
            /*
             * Before having finished 3270 negotiation,
             * sending outbound data except protocol options is prohibited.
             */
            return 0;
        }
    }
    if (!qemu_chr_fe_backend_connected(&t->chr)) {
        /* We just say we consumed all data if there's no backend. */
        return count;
    }

    t->outv[out_len++] = cmd;
    do {
        ccw_dstream_read_buf(get_cds(t), &t->outv[out_len], len);
        count = ccw_dstream_avail(get_cds(t));
        out_len += len;

        out_len = insert_IAC_escape_char(t->outv, out_len);
        if (!count) {
            t->outv[out_len++] = IAC;
            t->outv[out_len++] = IAC_EOR;
        }
        retval = qemu_chr_fe_write_all(&t->chr, t->outv, out_len);
        len = MIN(count, bound);
        out_len = 0;
    } while (len && retval >= 0);
    return (retval <= 0) ? 0 : get_cds(t)->count;
}

static Property terminal_properties[] = {
    DEFINE_PROP_CHR("chardev", Terminal3270, chr),
    DEFINE_PROP_END_OF_LIST(),
};

static const VMStateDescription terminal3270_vmstate = {
    .name = TYPE_TERMINAL_3270,
    .unmigratable = 1,
};

static void terminal_class_init(ObjectClass *klass, void *data)
{
    DeviceClass *dc = DEVICE_CLASS(klass);
    EmulatedCcw3270Class *ck = EMULATED_CCW_3270_CLASS(klass);

    dc->props = terminal_properties;
    dc->vmsd = &terminal3270_vmstate;
    ck->init = terminal_init;
    ck->read_payload_3270 = read_payload_3270;
    ck->write_payload_3270 = write_payload_3270;
}

static const TypeInfo ccw_terminal_info = {
    .name = TYPE_TERMINAL_3270,
    .parent = TYPE_EMULATED_CCW_3270,
    .instance_size = sizeof(Terminal3270),
    .class_init = terminal_class_init,
    .class_size = sizeof(EmulatedCcw3270Class),
};

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

type_init(register_types)
Commit	Line	Data
b8476205 YC	1	/*
	2	* Terminal 3270 implementation
	3	*
	4	* Copyright 2017 IBM Corp.
	5	*
	6	* Authors: Yang Chen <[email protected]>
	7	* Jing Liu <[email protected]>
	8	*
	9	* This work is licensed under the terms of the GNU GPL, version 2 or (at
	10	* your option) any later version. See the COPYING file in the top-level
	11	* directory.
	12	*/
	13
	14	#include "qemu/osdep.h"
2dc95b4c	15	#include "qapi/error.h"
4d43a603	16	#include "chardev/char-fe.h"
b8476205 YC	17	#include "hw/s390x/3270-ccw.h"
b8476205 YC	18
2dc95b4c JL	19	/* Enough spaces for different window sizes. */
	20	#define INPUT_BUFFER_SIZE 1000
	21	/*
	22	* 1 for header, 1024*2 for datastream, 2 for tail
	23	* Reserve enough spaces for telnet IAC escape.
	24	*/
	25	#define OUTPUT_BUFFER_SIZE 2051
	26
b8476205 YC	27	typedef struct Terminal3270 {
b8476205 YC	28	EmulatedCcw3270Device cdev;
2dc95b4c JL	29	CharBackend chr;
	30	uint8_t inv[INPUT_BUFFER_SIZE];
	31	uint8_t outv[OUTPUT_BUFFER_SIZE];
	32	int in_len;
2dc95b4c	33	bool handshake_done;
e65a2720	34	guint timer_tag;
b8476205 YC	35	} Terminal3270;
	36
	37	#define TYPE_TERMINAL_3270 "x-terminal3270"
2dc95b4c JL	38	#define TERMINAL_3270(obj) \
	39	OBJECT_CHECK(Terminal3270, (obj), TYPE_TERMINAL_3270)
	40
	41	static int terminal_can_read(void *opaque)
	42	{
	43	Terminal3270 *t = opaque;
	44
	45	return INPUT_BUFFER_SIZE - t->in_len;
	46	}
	47
	48	/*
	49	* Protocol handshake done,
	50	* signal guest by an unsolicited DE irq.
	51	*/
	52	static void TN3270_handshake_done(Terminal3270 *t)
	53	{
	54	CcwDevice *ccw_dev = CCW_DEVICE(t);
	55	SubchDev *sch = ccw_dev->sch;
	56
	57	t->handshake_done = true;
	58	sch->curr_status.scsw.dstat = SCSW_DSTAT_DEVICE_END;
	59	css_conditional_io_interrupt(sch);
	60	}
	61
e65a2720 JL	62	/*
	63	* Called when the interval is timeout to detect
	64	* if the client is still alive by Timing Mark.
	65	*/
	66	static gboolean send_timing_mark_cb(gpointer opaque)
	67	{
	68	Terminal3270 *t = opaque;
	69	const uint8_t timing[] = {0xff, 0xfd, 0x06};
	70
	71	qemu_chr_fe_write_all(&t->chr, timing, sizeof(timing));
	72	return true;
	73	}
	74
2dc95b4c JL	75	/*
	76	* Receive inbound data from socket.
	77	* For data given to guest, drop the data boundary IAC, IAC_EOR.
	78	* TODO:
	79	* Using "Reset" key on x3270 may result multiple commands in one packet.
	80	* This usually happens when the user meets a poor traffic of the network.
	81	* As of now, for such case, we simply terminate the connection,
	82	* and we should come back here later with a better solution.
	83	*/
	84	static void terminal_read(void opaque, const uint8_t buf, int size)
	85	{
	86	Terminal3270 *t = opaque;
	87	CcwDevice *ccw_dev = CCW_DEVICE(t);
	88	SubchDev *sch = ccw_dev->sch;
	89	int end;
	90
	91	assert(size <= (INPUT_BUFFER_SIZE - t->in_len));
	92
e65a2720 JL	93	if (t->timer_tag) {
	94	g_source_remove(t->timer_tag);
	95	t->timer_tag = 0;
	96	}
	97	t->timer_tag = g_timeout_add_seconds(600, send_timing_mark_cb, t);
	98
2dc95b4c JL	99	memcpy(&t->inv[t->in_len], buf, size);
	100	t->in_len += size;
	101	if (t->in_len < 2) {
	102	return;
	103	}
	104
	105	if (!t->handshake_done) {
	106	/*
	107	* Receiving Terminal Type is the last step of handshake.
	108	* The data format: IAC SB Terminal-Type IS <terminal type> IAC SE
	109	* The code for Terminal-Type is 0x18, for IS is 0.
	110	* Simply check the data format and mark handshake_done.
	111	*/
	112	if (t->in_len > 6 && t->inv[2] == 0x18 && t->inv[3] == 0x0 &&
	113	t->inv[t->in_len - 2] == IAC && t->inv[t->in_len - 1] == IAC_SE) {
	114	TN3270_handshake_done(t);
	115	t->in_len = 0;
	116	}
	117	return;
	118	}
	119
	120	for (end = 0; end < t->in_len - 1; end++) {
	121	if (t->inv[end] == IAC && t->inv[end + 1] == IAC_EOR) {
	122	break;
	123	}
	124	}
	125	if (end == t->in_len - 2) {
	126	/* Data is valid for consuming. */
	127	t->in_len -= 2;
	128	sch->curr_status.scsw.dstat = SCSW_DSTAT_ATTENTION;
	129	css_conditional_io_interrupt(sch);
	130	} else if (end < t->in_len - 2) {
	131	/* "Reset" key is used. */
	132	qemu_chr_fe_disconnect(&t->chr);
	133	} else {
	134	/* Gathering data. */
	135	return;
	136	}
	137	}
b8476205	138
4996241a JL	139	static void chr_event(void *opaque, int event)
	140	{
	141	Terminal3270 *t = opaque;
	142	CcwDevice *ccw_dev = CCW_DEVICE(t);
	143	SubchDev *sch = ccw_dev->sch;
	144
	145	/* Ensure the initial status correct, always reset them. */
	146	t->in_len = 0;
4996241a	147	t->handshake_done = false;
e65a2720 JL	148	if (t->timer_tag) {
	149	g_source_remove(t->timer_tag);
	150	t->timer_tag = 0;
	151	}
4996241a JL	152
	153	switch (event) {
	154	case CHR_EVENT_OPENED:
	155	/*
	156	* 3270 does handshake firstly by the negotiate options in
	157	* char-socket.c. Once qemu receives the terminal-type of the
	158	* client, mark handshake done and trigger everything rolling again.
	159	*/
e65a2720	160	t->timer_tag = g_timeout_add_seconds(600, send_timing_mark_cb, t);
4996241a JL	161	break;
	162	case CHR_EVENT_CLOSED:
	163	sch->curr_status.scsw.dstat = SCSW_DSTAT_DEVICE_END;
	164	css_conditional_io_interrupt(sch);
	165	break;
	166	}
	167	}
	168
b8476205 YC	169	static void terminal_init(EmulatedCcw3270Device dev, Error *errp)
b8476205 YC	170	{
2dc95b4c	171	Terminal3270 *t = TERMINAL_3270(dev);
b8476205 YC	172	static bool terminal_available;
	173
	174	if (terminal_available) {
	175	error_setg(errp, "Multiple 3270 terminals are not supported.");
	176	return;
	177	}
	178	terminal_available = true;
2dc95b4c	179	qemu_chr_fe_set_handlers(&t->chr, terminal_can_read,
81517ba3	180	terminal_read, chr_event, NULL, t, NULL, true);
2dc95b4c JL	181	}
2dc95b4c JL	182
1baa2eb0 HP	183	static inline CcwDataStream get_cds(Terminal3270 t)
	184	{
	185	return &(CCW_DEVICE(&t->cdev)->sch->cds);
	186	}
	187
	188	static int read_payload_3270(EmulatedCcw3270Device *dev)
2dc95b4c JL	189	{
	190	Terminal3270 *t = TERMINAL_3270(dev);
	191	int len;
	192
1baa2eb0 HP	193	len = MIN(ccw_dstream_avail(get_cds(t)), t->in_len);
1baa2eb0 HP	194	ccw_dstream_write_buf(get_cds(t), t->inv, len);
2dc95b4c JL	195	t->in_len -= len;
	196
	197	return len;
	198	}
	199
	200	/* TN3270 uses binary transmission, which needs escape IAC to IAC IAC */
	201	static int insert_IAC_escape_char(uint8_t *outv, int out_len)
	202	{
	203	int IAC_num = 0, new_out_len, i, j;
	204
	205	for (i = 0; i < out_len; i++) {
	206	if (outv[i] == IAC) {
	207	IAC_num++;
	208	}
	209	}
	210	if (IAC_num == 0) {
	211	return out_len;
	212	}
	213	new_out_len = out_len + IAC_num;
	214	for (i = out_len - 1, j = new_out_len - 1; j > i && i >= 0; i--, j--) {
	215	outv[j] = outv[i];
	216	if (outv[i] == IAC) {
	217	outv[--j] = IAC;
	218	}
	219	}
	220	return new_out_len;
b8476205 YC	221	}
b8476205 YC	222
2dc95b4c JL	223	/*
	224	* Write 3270 outbound to socket.
	225	* Return the count of 3270 data field if succeeded, zero if failed.
	226	*/
1baa2eb0	227	static int write_payload_3270(EmulatedCcw3270Device *dev, uint8_t cmd)
2dc95b4c JL	228	{
	229	Terminal3270 *t = TERMINAL_3270(dev);
	230	int retval = 0;
1baa2eb0	231	int count = ccw_dstream_avail(get_cds(t));
17ec9921 HP	232	int bound = (OUTPUT_BUFFER_SIZE - 3) / 2;
	233	int len = MIN(count, bound);
	234	int out_len = 0;
2dc95b4c JL	235
2dc95b4c JL	236	if (!t->handshake_done) {
e65a2720 JL	237	if (!(t->outv[0] == IAC && t->outv[1] != IAC)) {
	238	/*
	239	* Before having finished 3270 negotiation,
	240	* sending outbound data except protocol options is prohibited.
	241	*/
	242	return 0;
	243	}
2dc95b4c	244	}
30650701	245	if (!qemu_chr_fe_backend_connected(&t->chr)) {
2dc95b4c JL	246	/* We just say we consumed all data if there's no backend. */
	247	return count;
	248	}
2dc95b4c	249
17ec9921 HP	250	t->outv[out_len++] = cmd;
	251	do {
	252	ccw_dstream_read_buf(get_cds(t), &t->outv[out_len], len);
	253	count = ccw_dstream_avail(get_cds(t));
	254	out_len += len;
2dc95b4c	255
17ec9921 HP	256	out_len = insert_IAC_escape_char(t->outv, out_len);
	257	if (!count) {
	258	t->outv[out_len++] = IAC;
	259	t->outv[out_len++] = IAC_EOR;
	260	}
	261	retval = qemu_chr_fe_write_all(&t->chr, t->outv, out_len);
	262	len = MIN(count, bound);
	263	out_len = 0;
	264	} while (len && retval >= 0);
	265	return (retval <= 0) ? 0 : get_cds(t)->count;
2dc95b4c JL	266	}
	267
	268	static Property terminal_properties[] = {
	269	DEFINE_PROP_CHR("chardev", Terminal3270, chr),
	270	DEFINE_PROP_END_OF_LIST(),
	271	};
	272
9e8b3009 JL	273	static const VMStateDescription terminal3270_vmstate = {
	274	.name = TYPE_TERMINAL_3270,
	275	.unmigratable = 1,
	276	};
	277
b8476205 YC	278	static void terminal_class_init(ObjectClass klass, void data)
b8476205 YC	279	{
2dc95b4c	280	DeviceClass *dc = DEVICE_CLASS(klass);
b8476205 YC	281	EmulatedCcw3270Class *ck = EMULATED_CCW_3270_CLASS(klass);
b8476205 YC	282
2dc95b4c	283	dc->props = terminal_properties;
9e8b3009	284	dc->vmsd = &terminal3270_vmstate;
b8476205	285	ck->init = terminal_init;
2dc95b4c JL	286	ck->read_payload_3270 = read_payload_3270;
2dc95b4c JL	287	ck->write_payload_3270 = write_payload_3270;
b8476205 YC	288	}
	289
	290	static const TypeInfo ccw_terminal_info = {
	291	.name = TYPE_TERMINAL_3270,
	292	.parent = TYPE_EMULATED_CCW_3270,
	293	.instance_size = sizeof(Terminal3270),
	294	.class_init = terminal_class_init,
	295	.class_size = sizeof(EmulatedCcw3270Class),
	296	};
	297
	298	static void register_types(void)
	299	{
	300	type_register_static(&ccw_terminal_info);
	301	}
	302
	303	type_init(register_types)