subr_terminal.c revision 271769 
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: stable/10/sys/kern/subr_terminal.c 271769 2014-09-18 14:38:18Z dumbbell $");
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;
88static tsw_mmap_t	termtty_mmap;
89
90static struct ttydevsw terminal_tty_class = {
91	.tsw_open	= termtty_open,
92	.tsw_close	= termtty_close,
93	.tsw_outwakeup	= termtty_outwakeup,
94	.tsw_ioctl	= termtty_ioctl,
95	.tsw_mmap	= termtty_mmap,
96};
97
98/*
99 * Terminal emulator routines.
100 */
101
102static tf_bell_t	termteken_bell;
103static tf_cursor_t	termteken_cursor;
104static tf_putchar_t	termteken_putchar;
105static tf_fill_t	termteken_fill;
106static tf_copy_t	termteken_copy;
107static tf_param_t	termteken_param;
108static tf_respond_t	termteken_respond;
109
110static teken_funcs_t terminal_drawmethods = {
111	.tf_bell	= termteken_bell,
112	.tf_cursor	= termteken_cursor,
113	.tf_putchar	= termteken_putchar,
114	.tf_fill	= termteken_fill,
115	.tf_copy	= termteken_copy,
116	.tf_param	= termteken_param,
117	.tf_respond	= termteken_respond,
118};
119
120/* Kernel message formatting. */
121static const teken_attr_t kernel_message = {
122	.ta_fgcolor	= TCHAR_FGCOLOR(TERMINAL_KERN_ATTR),
123	.ta_bgcolor	= TCHAR_BGCOLOR(TERMINAL_KERN_ATTR),
124	.ta_format	= TCHAR_FORMAT(TERMINAL_KERN_ATTR)
125};
126
127static const teken_attr_t default_message = {
128	.ta_fgcolor	= TCHAR_FGCOLOR(TERMINAL_NORM_ATTR),
129	.ta_bgcolor	= TCHAR_BGCOLOR(TERMINAL_NORM_ATTR),
130	.ta_format	= TCHAR_FORMAT(TERMINAL_NORM_ATTR)
131};
132
133#define	TCHAR_CREATE(c, a)	((c) | TFORMAT((a)->ta_format) |	\
134	TCOLOR_FG(teken_256to8((a)->ta_fgcolor)) |			\
135	TCOLOR_BG(teken_256to8((a)->ta_bgcolor)))
136
137static void
138terminal_init(struct terminal *tm)
139{
140
141	if (tm->tm_flags & TF_CONS)
142		mtx_init(&tm->tm_mtx, "trmlck", NULL, MTX_SPIN);
143	teken_init(&tm->tm_emulator, &terminal_drawmethods, tm);
144	teken_set_defattr(&tm->tm_emulator, &default_message);
145}
146
147struct terminal *
148terminal_alloc(const struct terminal_class *tc, void *softc)
149{
150	struct terminal *tm;
151
152	tm = malloc(sizeof(struct terminal), M_TERMINAL, M_WAITOK|M_ZERO);
153	terminal_init(tm);
154
155	tm->tm_class = tc;
156	tm->tm_softc = softc;
157
158	return (tm);
159}
160
161static void
162terminal_sync_ttysize(struct terminal *tm)
163{
164	struct tty *tp;
165
166	tp = tm->tm_tty;
167	if (tp == NULL)
168		return;
169
170	tty_lock(tp);
171	tty_set_winsize(tp, &tm->tm_winsize);
172	tty_unlock(tp);
173}
174
175void
176terminal_maketty(struct terminal *tm, const char *fmt, ...)
177{
178	struct tty *tp;
179	char name[8];
180	va_list ap;
181
182	va_start(ap, fmt);
183	vsnrprintf(name, sizeof name, 32, fmt, ap);
184	va_end(ap);
185
186	tp = tty_alloc(&terminal_tty_class, tm);
187	tty_makedev(tp, NULL, "%s", name);
188	tm->tm_tty = tp;
189	terminal_sync_ttysize(tm);
190}
191
192void
193terminal_set_winsize_blank(struct terminal *tm, const struct winsize *size,
194    int blank, const term_attr_t *attr)
195{
196	term_rect_t r;
197
198	tm->tm_winsize = *size;
199
200	r.tr_begin.tp_row = r.tr_begin.tp_col = 0;
201	r.tr_end.tp_row = size->ws_row;
202	r.tr_end.tp_col = size->ws_col;
203
204	TERMINAL_LOCK(tm);
205	if (blank == 0)
206		teken_set_winsize_noreset(&tm->tm_emulator, &r.tr_end);
207	else
208		teken_set_winsize(&tm->tm_emulator, &r.tr_end);
209	TERMINAL_UNLOCK(tm);
210
211	if ((blank != 0) && !(tm->tm_flags & TF_MUTE))
212		tm->tm_class->tc_fill(tm, &r,
213		    TCHAR_CREATE((teken_char_t)' ', attr));
214
215	terminal_sync_ttysize(tm);
216}
217
218void
219terminal_set_winsize(struct terminal *tm, const struct winsize *size)
220{
221
222	terminal_set_winsize_blank(tm, size, 1,
223	    (const term_attr_t *)&default_message);
224}
225
226/*
227 * XXX: This function is a kludge.  Drivers like vt(4) need to
228 * temporarily stop input when resizing, etc.  This should ideally be
229 * handled within the driver.
230 */
231
232void
233terminal_mute(struct terminal *tm, int yes)
234{
235
236	TERMINAL_LOCK(tm);
237	if (yes)
238		tm->tm_flags |= TF_MUTE;
239	else
240		tm->tm_flags &= ~TF_MUTE;
241	TERMINAL_UNLOCK(tm);
242}
243
244void
245terminal_input_char(struct terminal *tm, term_char_t c)
246{
247	struct tty *tp;
248
249	tp = tm->tm_tty;
250	if (tp == NULL)
251		return;
252
253	/*
254	 * Strip off any attributes. Also ignore input of second part of
255	 * CJK fullwidth characters, as we don't want to return these
256	 * characters twice.
257	 */
258	if (TCHAR_FORMAT(c) & TF_CJK_RIGHT)
259		return;
260	c = TCHAR_CHARACTER(c);
261
262	tty_lock(tp);
263	/*
264	 * Conversion to UTF-8.
265	 */
266	if (c < 0x80) {
267		ttydisc_rint(tp, c, 0);
268	} else if (c < 0x800) {
269		char str[2] = {
270			0xc0 | (c >> 6),
271			0x80 | (c & 0x3f)
272		};
273
274		ttydisc_rint_simple(tp, str, sizeof str);
275	} else if (c < 0x10000) {
276		char str[3] = {
277			0xe0 | (c >> 12),
278			0x80 | ((c >> 6) & 0x3f),
279			0x80 | (c & 0x3f)
280		};
281
282		ttydisc_rint_simple(tp, str, sizeof str);
283	} else {
284		char str[4] = {
285			0xf0 | (c >> 18),
286			0x80 | ((c >> 12) & 0x3f),
287			0x80 | ((c >> 6) & 0x3f),
288			0x80 | (c & 0x3f)
289		};
290
291		ttydisc_rint_simple(tp, str, sizeof str);
292	}
293	ttydisc_rint_done(tp);
294	tty_unlock(tp);
295}
296
297void
298terminal_input_raw(struct terminal *tm, char c)
299{
300	struct tty *tp;
301
302	tp = tm->tm_tty;
303	if (tp == NULL)
304		return;
305
306	tty_lock(tp);
307	ttydisc_rint(tp, c, 0);
308	ttydisc_rint_done(tp);
309	tty_unlock(tp);
310}
311
312void
313terminal_input_special(struct terminal *tm, unsigned int k)
314{
315	struct tty *tp;
316	const char *str;
317
318	tp = tm->tm_tty;
319	if (tp == NULL)
320		return;
321
322	str = teken_get_sequence(&tm->tm_emulator, k);
323	if (str == NULL)
324		return;
325
326	tty_lock(tp);
327	ttydisc_rint_simple(tp, str, strlen(str));
328	ttydisc_rint_done(tp);
329	tty_unlock(tp);
330}
331
332/*
333 * Binding with the TTY layer.
334 */
335
336static int
337termtty_open(struct tty *tp)
338{
339	struct terminal *tm = tty_softc(tp);
340
341	tm->tm_class->tc_opened(tm, 1);
342	return (0);
343}
344
345static void
346termtty_close(struct tty *tp)
347{
348	struct terminal *tm = tty_softc(tp);
349
350	tm->tm_class->tc_opened(tm, 0);
351}
352
353static void
354termtty_outwakeup(struct tty *tp)
355{
356	struct terminal *tm = tty_softc(tp);
357	char obuf[128];
358	size_t olen;
359	unsigned int flags = 0;
360
361	while ((olen = ttydisc_getc(tp, obuf, sizeof obuf)) > 0) {
362		TERMINAL_LOCK_TTY(tm);
363		if (!(tm->tm_flags & TF_MUTE)) {
364			tm->tm_flags &= ~TF_BELL;
365			teken_input(&tm->tm_emulator, obuf, olen);
366			flags |= tm->tm_flags;
367		}
368		TERMINAL_UNLOCK_TTY(tm);
369	}
370
371	tm->tm_class->tc_done(tm);
372	if (flags & TF_BELL)
373		tm->tm_class->tc_bell(tm);
374}
375
376static int
377termtty_ioctl(struct tty *tp, u_long cmd, caddr_t data, struct thread *td)
378{
379	struct terminal *tm = tty_softc(tp);
380	int error;
381
382	switch (cmd) {
383	case CONS_GETINFO: {
384		vid_info_t *vi = (vid_info_t *)data;
385		const teken_pos_t *p;
386		int fg, bg;
387
388		if (vi->size != sizeof(vid_info_t))
389			return (EINVAL);
390
391		/* Already help the console driver by filling in some data. */
392		p = teken_get_cursor(&tm->tm_emulator);
393		vi->mv_row = p->tp_row;
394		vi->mv_col = p->tp_col;
395
396		p = teken_get_winsize(&tm->tm_emulator);
397		vi->mv_rsz = p->tp_row;
398		vi->mv_csz = p->tp_col;
399
400		teken_get_defattr_cons25(&tm->tm_emulator, &fg, &bg);
401		vi->mv_norm.fore = fg;
402		vi->mv_norm.back = bg;
403		/* XXX: keep vidcontrol happy; bold backgrounds. */
404		vi->mv_rev.fore = bg;
405		vi->mv_rev.back = fg & 0x7;
406		break;
407	}
408	}
409
410	/*
411	 * Unlike various other drivers, this driver will never
412	 * deallocate TTYs.  This means it's safe to temporarily unlock
413	 * the TTY when handling ioctls.
414	 */
415	tty_unlock(tp);
416	error = tm->tm_class->tc_ioctl(tm, cmd, data, td);
417	tty_lock(tp);
418	return (error);
419}
420
421static int
422termtty_mmap(struct tty *tp, vm_ooffset_t offset, vm_paddr_t * paddr,
423    int nprot, vm_memattr_t *memattr)
424{
425	struct terminal *tm = tty_softc(tp);
426
427	return (tm->tm_class->tc_mmap(tm, offset, paddr, nprot, memattr));
428}
429
430/*
431 * Binding with the kernel and debug console.
432 */
433
434static cn_probe_t	termcn_cnprobe;
435static cn_init_t	termcn_cninit;
436static cn_term_t	termcn_cnterm;
437static cn_getc_t	termcn_cngetc;
438static cn_putc_t	termcn_cnputc;
439static cn_grab_t	termcn_cngrab;
440static cn_ungrab_t	termcn_cnungrab;
441
442const struct consdev_ops termcn_cnops = {
443	.cn_probe	= termcn_cnprobe,
444	.cn_init	= termcn_cninit,
445	.cn_term	= termcn_cnterm,
446	.cn_getc	= termcn_cngetc,
447	.cn_putc	= termcn_cnputc,
448	.cn_grab	= termcn_cngrab,
449	.cn_ungrab	= termcn_cnungrab,
450};
451
452void
453termcn_cnregister(struct terminal *tm)
454{
455	struct consdev *cp;
456
457	cp = tm->consdev;
458	if (cp == NULL) {
459		cp = malloc(sizeof(struct consdev), M_TERMINAL,
460		    M_WAITOK|M_ZERO);
461		cp->cn_ops = &termcn_cnops;
462		cp->cn_arg = tm;
463		cp->cn_pri = CN_INTERNAL;
464		sprintf(cp->cn_name, "ttyv0");
465
466		tm->tm_flags = TF_CONS;
467		tm->consdev = cp;
468
469		terminal_init(tm);
470	}
471
472	/* Attach terminal as console. */
473	cnadd(cp);
474}
475
476static void
477termcn_cngrab(struct consdev *cp)
478{
479	struct terminal *tm = cp->cn_arg;
480
481	tm->tm_class->tc_cngrab(tm);
482}
483
484static void
485termcn_cnungrab(struct consdev *cp)
486{
487	struct terminal *tm = cp->cn_arg;
488
489	tm->tm_class->tc_cnungrab(tm);
490}
491
492static void
493termcn_cnprobe(struct consdev *cp)
494{
495	struct terminal *tm = cp->cn_arg;
496
497	if (tm == NULL) {
498		cp->cn_pri = CN_DEAD;
499		return;
500	}
501
502	tm->consdev = cp;
503	terminal_init(tm);
504
505	tm->tm_class->tc_cnprobe(tm, cp);
506}
507
508static void
509termcn_cninit(struct consdev *cp)
510{
511
512}
513
514static void
515termcn_cnterm(struct consdev *cp)
516{
517
518}
519
520static int
521termcn_cngetc(struct consdev *cp)
522{
523	struct terminal *tm = cp->cn_arg;
524
525	return (tm->tm_class->tc_cngetc(tm));
526}
527
528static void
529termcn_cnputc(struct consdev *cp, int c)
530{
531	struct terminal *tm = cp->cn_arg;
532	teken_attr_t backup;
533	char cv = c;
534
535	TERMINAL_LOCK_CONS(tm);
536	if (!(tm->tm_flags & TF_MUTE)) {
537		backup = *teken_get_curattr(&tm->tm_emulator);
538		teken_set_curattr(&tm->tm_emulator, &kernel_message);
539		teken_input(&tm->tm_emulator, &cv, 1);
540		teken_set_curattr(&tm->tm_emulator, &backup);
541	}
542	TERMINAL_UNLOCK_CONS(tm);
543
544	tm->tm_class->tc_done(tm);
545}
546
547/*
548 * Binding with the terminal emulator.
549 */
550
551static void
552termteken_bell(void *softc)
553{
554	struct terminal *tm = softc;
555
556	tm->tm_flags |= TF_BELL;
557}
558
559static void
560termteken_cursor(void *softc, const teken_pos_t *p)
561{
562	struct terminal *tm = softc;
563
564	tm->tm_class->tc_cursor(tm, p);
565}
566
567static void
568termteken_putchar(void *softc, const teken_pos_t *p, teken_char_t c,
569    const teken_attr_t *a)
570{
571	struct terminal *tm = softc;
572
573	tm->tm_class->tc_putchar(tm, p, TCHAR_CREATE(c, a));
574}
575
576static void
577termteken_fill(void *softc, const teken_rect_t *r, teken_char_t c,
578    const teken_attr_t *a)
579{
580	struct terminal *tm = softc;
581
582	tm->tm_class->tc_fill(tm, r, TCHAR_CREATE(c, a));
583}
584
585static void
586termteken_copy(void *softc, const teken_rect_t *r, const teken_pos_t *p)
587{
588	struct terminal *tm = softc;
589
590	tm->tm_class->tc_copy(tm, r, p);
591}
592
593static void
594termteken_param(void *softc, int cmd, unsigned int arg)
595{
596	struct terminal *tm = softc;
597
598	tm->tm_class->tc_param(tm, cmd, arg);
599}
600
601static void
602termteken_respond(void *softc, const void *buf, size_t len)
603{
604#if 0
605	struct terminal *tm = softc;
606	struct tty *tp;
607
608	/*
609	 * Only inject a response into the TTY if the data actually
610	 * originated from the TTY.
611	 *
612	 * XXX: This cannot be done right now.  The TTY could pick up
613	 * other locks.  It could also in theory cause loops, when the
614	 * TTY performs echoing of a command that generates even more
615	 * input.
616	 */
617	tp = tm->tm_tty;
618	if (tp == NULL)
619		return;
620
621	ttydisc_rint_simple(tp, buf, len);
622	ttydisc_rint_done(tp);
623#endif
624}
625