subr_terminal.c revision 257252 
1/*-
2 * Copyright (c) 2009 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Ed Schouten under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: user/ed/newcons/sys/kern/subr_terminal.c 257252 2013-10-28 14:00:06Z ray $");
32
33#include <sys/param.h>
34#include <sys/cons.h>
35#include <sys/consio.h>
36#include <sys/kernel.h>
37#include <sys/lock.h>
38#include <sys/malloc.h>
39#include <sys/mutex.h>
40#include <sys/systm.h>
41#include <sys/terminal.h>
42#include <sys/tty.h>
43
44#include <machine/stdarg.h>
45
46static MALLOC_DEFINE(M_TERMINAL, "terminal", "terminal device");
47
48/*
49 * Locking.
50 *
51 * Normally we don't need to lock down the terminal emulator, because
52 * the TTY lock is already held when calling teken_input().
53 * Unfortunately this is not the case when the terminal acts as a
54 * console device, because cnputc() can be called at the same time.
55 * This means terminals may need to be locked down using a spin lock.
56 */
57#define	TERMINAL_LOCK(tm)	do {					\
58	if ((tm)->tm_flags & TF_CONS)					\
59		mtx_lock_spin(&(tm)->tm_mtx);				\
60	else if ((tm)->tm_tty != NULL)					\
61		tty_lock((tm)->tm_tty);					\
62} while (0)
63#define	TERMINAL_UNLOCK(tm)	do {					\
64	if ((tm)->tm_flags & TF_CONS)					\
65		mtx_unlock_spin(&(tm)->tm_mtx);				\
66	else if ((tm)->tm_tty != NULL)					\
67		tty_unlock((tm)->tm_tty);				\
68} while (0)
69#define	TERMINAL_LOCK_TTY(tm)	do {					\
70	if ((tm)->tm_flags & TF_CONS)					\
71		mtx_lock_spin(&(tm)->tm_mtx);				\
72} while (0)
73#define	TERMINAL_UNLOCK_TTY(tm)	do {					\
74	if ((tm)->tm_flags & TF_CONS)					\
75		mtx_unlock_spin(&(tm)->tm_mtx);				\
76} while (0)
77#define	TERMINAL_LOCK_CONS(tm)		mtx_lock_spin(&(tm)->tm_mtx)
78#define	TERMINAL_UNLOCK_CONS(tm)	mtx_unlock_spin(&(tm)->tm_mtx)
79
80/*
81 * TTY routines.
82 */
83
84static tsw_open_t	termtty_open;
85static tsw_close_t	termtty_close;
86static tsw_outwakeup_t	termtty_outwakeup;
87static tsw_ioctl_t	termtty_ioctl;
88
89static struct ttydevsw terminal_tty_class = {
90	.tsw_open	= termtty_open,
91	.tsw_close	= termtty_close,
92	.tsw_outwakeup	= termtty_outwakeup,
93	.tsw_ioctl	= termtty_ioctl,
94};
95
96/*
97 * Terminal emulator routines.
98 */
99
100static tf_bell_t	termteken_bell;
101static tf_cursor_t	termteken_cursor;
102static tf_putchar_t	termteken_putchar;
103static tf_fill_t	termteken_fill;
104static tf_copy_t	termteken_copy;
105static tf_param_t	termteken_param;
106static tf_respond_t	termteken_respond;
107
108static teken_funcs_t terminal_drawmethods = {
109	.tf_bell	= termteken_bell,
110	.tf_cursor	= termteken_cursor,
111	.tf_putchar	= termteken_putchar,
112	.tf_fill	= termteken_fill,
113	.tf_copy	= termteken_copy,
114	.tf_param	= termteken_param,
115	.tf_respond	= termteken_respond,
116};
117
118/* Kernel message formatting. */
119static const teken_attr_t kernel_message = {
120	.ta_fgcolor	= TC_WHITE,
121	.ta_bgcolor	= TC_BLACK,
122	.ta_format	= TF_BOLD,
123};
124
125static const teken_attr_t default_message = {
126	.ta_fgcolor	= TC_WHITE,
127	.ta_bgcolor	= TC_BLACK,
128};
129
130#define	TCHAR_CREATE(c, a)	((c) | \
131	(a)->ta_format << 22 | \
132	teken_256to8((a)->ta_fgcolor) << 26 | \
133	teken_256to8((a)->ta_bgcolor) << 29)
134
135static void
136terminal_init(struct terminal *tm)
137{
138
139	if (tm->tm_flags & TF_CONS)
140		mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
141	teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
142	teken_set_defattr(&tm->tm_emulator, &default_message);
143}
144
145struct terminal *
146terminal_alloc(const struct terminal_class *tc, void *softc)
147{
148	struct terminal *tm;
149
150	tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
151	terminal_init(tm);
152
153	tm->tm_class = tc;
154	tm->tm_softc = softc;
155
156	return (tm);
157}
158
159static void
160terminal_sync_ttysize(struct terminal *tm)
161{
162	struct tty *tp;
163
164	tp = tm->tm_tty;
165	if (tp == NULL)
166		return;
167
168	tty_lock(tp);
169	tty_set_winsize(tp, &tm->tm_winsize);
170	tty_unlock(tp);
171}
172
173void
174terminal_maketty(struct terminal *tm, const char *fmt, ...)
175{
176	struct tty *tp;
177	char name[8];
178	va_list ap;
179
180	va_start(ap, fmt);
181	vsnrprintf(name, sizeof name, 32, fmt, ap);
182	va_end(ap);
183
184	tp = tty_alloc(&terminal_tty_class, tm);
185	tty_makedev(tp, NULL, "%s", name);
186	tm->tm_tty = tp;
187	terminal_sync_ttysize(tm);
188}
189
190void
191terminal_set_winsize_blank(struct terminal *tm, const struct winsize *size,
192    int blank)
193{
194	term_rect_t r;
195
196	tm->tm_winsize = *size;
197
198	r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
199	r.tr_end.tp_row = size->ws_row;
200	r.tr_end.tp_col = size->ws_col;
201
202	TERMINAL_LOCK(tm);
203	if (blank == 0)
204		/*
205		 * Assigned directly, to avoid terminal reset in the
206		 * teken_set_winsize.
207		 */
208		tm->tm_emulator.t_winsize = r.tr_end;
209	else
210		teken_set_winsize(&tm->tm_emulator, &r.tr_end);
211	TERMINAL_UNLOCK(tm);
212
213	if (blank != 0)
214		tm->tm_class->tc_fill(tm, &r, TCHAR_CREATE((teken_char_t)' ',
215		    &default_message));
216
217	terminal_sync_ttysize(tm);
218}
219
220void
221terminal_set_winsize(struct terminal *tm, const struct winsize *size)
222{
223
224	terminal_set_winsize_blank(tm, size, 1);
225}
226
227/*
228 * XXX: This function is a kludge.  Drivers like vt(4) need to
229 * temporarily stop input when resizing, etc.  This should ideally be
230 * handled within the driver.
231 */
232
233void
234terminal_mute(struct terminal *tm, int yes)
235{
236
237	TERMINAL_LOCK(tm);
238	if (yes)
239		tm->tm_flags |= TF_MUTE;
240	else
241		tm->tm_flags &= ~TF_MUTE;
242	TERMINAL_UNLOCK(tm);
243}
244
245void
246terminal_input_char(struct terminal *tm, term_char_t c)
247{
248	struct tty *tp;
249
250	tp = tm->tm_tty;
251	if (tp == NULL)
252		return;
253
254	/* Strip off any attributes. */
255	c = TCHAR_CHARACTER(c);
256
257	tty_lock(tp);
258	/*
259	 * Conversion to UTF-8.
260	 */
261	if (c < 0x80) {
262		ttydisc_rint(tp, c, 0);
263	} else if (c < 0x800) {
264		char str[2] = {
265			0xc0 | (c >> 6),
266			0x80 | (c & 0x3f)
267		};
268
269		ttydisc_rint_simple(tp, str, sizeof str);
270	} else if (c < 0x10000) {
271		char str[3] = {
272			0xe0 | (c >> 12),
273			0x80 | ((c >> 6) & 0x3f),
274			0x80 | (c & 0x3f)
275		};
276
277		ttydisc_rint_simple(tp, str, sizeof str);
278	} else {
279		char str[4] = {
280			0xf0 | (c >> 18),
281			0x80 | ((c >> 12) & 0x3f),
282			0x80 | ((c >> 6) & 0x3f),
283			0x80 | (c & 0x3f)
284		};
285
286		ttydisc_rint_simple(tp, str, sizeof str);
287	}
288	ttydisc_rint_done(tp);
289	tty_unlock(tp);
290}
291
292void
293terminal_input_raw(struct terminal *tm, char c)
294{
295	struct tty *tp;
296
297	tp = tm->tm_tty;
298	if (tp == NULL)
299		return;
300
301	tty_lock(tp);
302	ttydisc_rint(tp, c, 0);
303	ttydisc_rint_done(tp);
304	tty_unlock(tp);
305}
306
307void
308terminal_input_special(struct terminal *tm, unsigned int k)
309{
310	struct tty *tp;
311	const char *str;
312
313	tp = tm->tm_tty;
314	if (tp == NULL)
315		return;
316
317	str = teken_get_sequence(&tm->tm_emulator, k);
318	if (str == NULL)
319		return;
320
321	tty_lock(tp);
322	ttydisc_rint_simple(tp, str, strlen(str));
323	ttydisc_rint_done(tp);
324	tty_unlock(tp);
325}
326
327/*
328 * Binding with the TTY layer.
329 */
330
331static int
332termtty_open(struct tty *tp)
333{
334	struct terminal *tm = tty_softc(tp);
335
336	tm->tm_class->tc_opened(tm, 1);
337	return (0);
338}
339
340static void
341termtty_close(struct tty *tp)
342{
343	struct terminal *tm = tty_softc(tp);
344
345	tm->tm_class->tc_opened(tm, 0);
346}
347
348static void
349termtty_outwakeup(struct tty *tp)
350{
351	struct terminal *tm = tty_softc(tp);
352	char obuf[128];
353	size_t olen;
354	unsigned int flags = 0;
355
356	while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
357		TERMINAL_LOCK_TTY(tm);
358		if (!(tm->tm_flags & TF_MUTE)) {
359			tm->tm_flags &= ~TF_BELL;
360			teken_input(&tm->tm_emulator, obuf, olen);
361			flags |= tm->tm_flags;
362		}
363		TERMINAL_UNLOCK_TTY(tm);
364	}
365
366	tm->tm_class->tc_done(tm);
367	if (flags & TF_BELL)
368		tm->tm_class->tc_bell(tm);
369}
370
371static int
372termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
373{
374	struct terminal *tm = tty_softc(tp);
375	int error;
376
377	switch (cmd) {
378	case CONS_GETINFO: {
379		vid_info_t *vi = (vid_info_t *)data;
380		const teken_pos_t *p;
381		int fg, bg;
382
383		if (vi->size != sizeof(vid_info_t))
384			return (EINVAL);
385
386		/* Already help the console driver by filling in some data. */
387		p = teken_get_cursor(&tm->tm_emulator);
388		vi->mv_row = p->tp_row;
389		vi->mv_col = p->tp_col;
390
391		p = teken_get_winsize(&tm->tm_emulator);
392		vi->mv_rsz = p->tp_row;
393		vi->mv_csz = p->tp_col;
394
395		teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
396		vi->mv_norm.fore = fg;
397		vi->mv_norm.back = bg;
398		/* XXX: keep vidcontrol happy; bold backgrounds. */
399		vi->mv_rev.fore = bg;
400		vi->mv_rev.back = fg & 0x7;
401		break;
402	}
403	}
404
405	/*
406	 * Unlike various other drivers, this driver will never
407	 * deallocate TTYs.  This means it's safe to temporarily unlock
408	 * the TTY when handling ioctls.
409	 */
410	tty_unlock(tp);
411	error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
412	tty_lock(tp);
413	return (error);
414}
415
416/*
417 * Binding with the kernel and debug console.
418 */
419
420static cn_probe_t	termcn_cnprobe;
421static cn_init_t	termcn_cninit;
422static cn_term_t	termcn_cnterm;
423static cn_getc_t	termcn_cngetc;
424static cn_putc_t	termcn_cnputc;
425static cn_grab_t	termcn_cngrab;
426static cn_ungrab_t	termcn_cnungrab;
427
428const struct consdev_ops termcn_cnops = {
429	.cn_probe	= termcn_cnprobe,
430	.cn_init	= termcn_cninit,
431	.cn_term	= termcn_cnterm,
432	.cn_getc	= termcn_cngetc,
433	.cn_putc	= termcn_cnputc,
434	.cn_grab	= termcn_cngrab,
435	.cn_ungrab	= termcn_cnungrab,
436};
437
438void
439termcn_cnregister(struct terminal *tm)
440{
441	struct consdev *cp;
442
443	cp = tm->consdev;
444	if (cp == NULL) {
445		cp = malloc(sizeof(struct consdev), M_TERMINAL,
446		    M_WAITOK|M_ZERO);
447		cp->cn_ops = &termcn_cnops;
448		cp->cn_arg = tm;
449		cp->cn_pri = CN_INTERNAL;
450		sprintf(cp->cn_name, "ttyv0");
451
452		tm->tm_flags = TF_CONS;
453		tm->consdev = cp;
454
455		terminal_init(tm);
456	}
457
458	/* Attach terminal as console. */
459	cnadd(cp);
460}
461
462static void
463termcn_cngrab(struct consdev *cp)
464{
465
466}
467
468static void
469termcn_cnungrab(struct consdev *cp)
470{
471
472}
473
474static void
475termcn_cnprobe(struct consdev *cp)
476{
477	struct terminal *tm = cp->cn_arg;
478
479	if (tm == NULL) {
480		cp->cn_pri = CN_DEAD;
481		return;
482	}
483
484	tm->consdev = cp;
485	terminal_init(tm);
486
487	tm->tm_class->tc_cnprobe(tm, cp);
488}
489
490static void
491termcn_cninit(struct consdev *cp)
492{
493
494}
495
496static void
497termcn_cnterm(struct consdev *cp)
498{
499
500}
501
502static int
503termcn_cngetc(struct consdev *cp)
504{
505	struct terminal *tm = cp->cn_arg;
506
507	return (tm->tm_class->tc_cngetc(tm));
508}
509
510static void
511termcn_cnputc(struct consdev *cp, int c)
512{
513	struct terminal *tm = cp->cn_arg;
514	teken_attr_t backup;
515	char cv = c;
516
517	TERMINAL_LOCK_CONS(tm);
518	if (!(tm->tm_flags & TF_MUTE)) {
519		backup = *teken_get_curattr(&tm->tm_emulator);
520		teken_set_curattr(&tm->tm_emulator, &kernel_message);
521		teken_input(&tm->tm_emulator, &cv, 1);
522		teken_set_curattr(&tm->tm_emulator, &backup);
523	}
524	TERMINAL_UNLOCK_CONS(tm);
525
526	tm->tm_class->tc_done(tm);
527}
528
529/*
530 * Binding with the terminal emulator.
531 */
532
533static void
534termteken_bell(void *softc)
535{
536	struct terminal *tm = softc;
537
538	tm->tm_flags |= TF_BELL;
539}
540
541static void
542termteken_cursor(void *softc, const teken_pos_t *p)
543{
544	struct terminal *tm = softc;
545
546	tm->tm_class->tc_cursor(tm, p);
547}
548
549static void
550termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
551    const teken_attr_t *a)
552{
553	struct terminal *tm = softc;
554
555	tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
556}
557
558static void
559termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
560    const teken_attr_t *a)
561{
562	struct terminal *tm = softc;
563
564	tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
565}
566
567static void
568termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
569{
570	struct terminal *tm = softc;
571
572	tm->tm_class->tc_copy(tm, r, p);
573}
574
575static void
576termteken_param(void *softc, int cmd, unsigned int arg)
577{
578	struct terminal *tm = softc;
579
580	tm->tm_class->tc_param(tm, cmd, arg);
581}
582
583static void
584termteken_respond(void *softc, const void *buf, size_t len)
585{
586#if 0
587	struct terminal *tm = softc;
588	struct tty *tp;
589
590	/*
591	 * Only inject a response into the TTY if the data actually
592	 * originated from the TTY.
593	 *
594	 * XXX: This cannot be done right now.  The TTY could pick up
595	 * other locks.  It could also in theory cause loops, when the
596	 * TTY performs echoing of a command that generates even more
597	 * input.
598	 */
599	tp = tm->tm_tty;
600	if (tp == NULL)
601		return;
602
603	ttydisc_rint_simple(tp, buf, len);
604	ttydisc_rint_done(tp);
605#endif
606}
607