1 // SPDX-License-Identifier: GPL-2.0
3 * Provide access to virtual console memory.
4 * /dev/vcs: the screen as it is being viewed right now (possibly scrolled)
5 * /dev/vcsN: the screen of /dev/ttyN (1 <= N <= 63)
8 * /dev/vcsaN: idem, but including attributes, and prefixed with
9 * the 4 bytes lines,columns,x,y (as screendump used to give).
10 * Attribute/character pair is in native endianity.
13 * /dev/vcsuN: similar to /dev/vcsaN but using 4-byte unicode values
14 * instead of 1-byte screen glyph values.
17 * /dev/vcsuaN: same idea as /dev/vcsaN for unicode (not yet implemented).
19 * This replaces screendump and part of selection, so that the system
20 * administrator can control access using file system permissions.
25 * - fixed some fatal off-by-one bugs (0-- no longer == -1 -> looping and looping and looping...)
26 * - making it shorter - scr_readw are macros which expand in PRETTY long code
29 #include <linux/kernel.h>
30 #include <linux/major.h>
31 #include <linux/errno.h>
32 #include <linux/export.h>
33 #include <linux/tty.h>
34 #include <linux/interrupt.h>
36 #include <linux/init.h>
37 #include <linux/vt_kern.h>
38 #include <linux/selection.h>
39 #include <linux/kbd_kern.h>
40 #include <linux/console.h>
41 #include <linux/device.h>
42 #include <linux/sched.h>
44 #include <linux/poll.h>
45 #include <linux/signal.h>
46 #include <linux/slab.h>
47 #include <linux/notifier.h>
49 #include <linux/uaccess.h>
50 #include <asm/byteorder.h>
51 #include <asm/unaligned.h>
58 #define CON_BUF_SIZE (CONFIG_BASE_SMALL ? 256 : PAGE_SIZE)
63 * 0 ... 63 glyph mode without attributes
64 * 64 ... 127 unicode mode without attributes
65 * 128 ... 191 glyph mode with attributes
66 * 192 ... 255 unused (reserved for unicode with attributes)
68 * This relies on MAX_NR_CONSOLES being <= 63, meaning 63 actual consoles
69 * with minors 0, 64, 128 and 192 being proxies for the foreground console.
71 #if MAX_NR_CONSOLES > 63
72 #warning "/dev/vcs* devices may not accommodate more than 63 consoles"
75 #define console(inode) (iminor(inode) & 63)
76 #define use_unicode(inode) (iminor(inode) & 64)
77 #define use_attributes(inode) (iminor(inode) & 128)
80 struct vcs_poll_data {
81 struct notifier_block notifier;
82 unsigned int cons_num;
84 wait_queue_head_t waitq;
85 struct fasync_struct *fasync;
89 vcs_notifier(struct notifier_block *nb, unsigned long code, void *_param)
91 struct vt_notifier_param *param = _param;
92 struct vc_data *vc = param->vc;
93 struct vcs_poll_data *poll =
94 container_of(nb, struct vcs_poll_data, notifier);
95 int currcons = poll->cons_num;
110 currcons = fg_console;
113 if (currcons != vc->vc_num)
117 wake_up_interruptible(&poll->waitq);
118 kill_fasync(&poll->fasync, SIGIO, fa_band);
123 vcs_poll_data_free(struct vcs_poll_data *poll)
125 unregister_vt_notifier(&poll->notifier);
129 static struct vcs_poll_data *
130 vcs_poll_data_get(struct file *file)
132 struct vcs_poll_data *poll = file->private_data, *kill = NULL;
137 poll = kzalloc(sizeof(*poll), GFP_KERNEL);
140 poll->cons_num = console(file_inode(file));
141 init_waitqueue_head(&poll->waitq);
142 poll->notifier.notifier_call = vcs_notifier;
144 * In order not to lose any update event, we must pretend one might
145 * have occurred before we have a chance to register our notifier.
146 * This is also how user space has come to detect which kernels
147 * support POLLPRI on /dev/vcs* devices i.e. using poll() with
148 * POLLPRI and a zero timeout.
150 poll->event = VT_UPDATE;
152 if (register_vt_notifier(&poll->notifier) != 0) {
158 * This code may be called either through ->poll() or ->fasync().
159 * If we have two threads using the same file descriptor, they could
160 * both enter this function, both notice that the structure hasn't
161 * been allocated yet and go ahead allocating it in parallel, but
162 * only one of them must survive and be shared otherwise we'd leak
163 * memory with a dangling notifier callback.
165 spin_lock(&file->f_lock);
166 if (!file->private_data) {
167 file->private_data = poll;
169 /* someone else raced ahead of us */
171 poll = file->private_data;
173 spin_unlock(&file->f_lock);
175 vcs_poll_data_free(kill);
181 * Returns VC for inode.
182 * Must be called with console_lock.
184 static struct vc_data*
185 vcs_vc(struct inode *inode, int *viewed)
187 unsigned int currcons = console(inode);
189 WARN_CONSOLE_UNLOCKED();
192 currcons = fg_console;
200 return vc_cons[currcons].d;
204 * Returns size for VC carried by inode.
205 * Must be called with console_lock.
208 vcs_size(struct inode *inode)
213 WARN_CONSOLE_UNLOCKED();
215 vc = vcs_vc(inode, NULL);
219 size = vc->vc_rows * vc->vc_cols;
221 if (use_attributes(inode)) {
222 if (use_unicode(inode))
224 size = 2*size + HEADER_SIZE;
225 } else if (use_unicode(inode))
230 static loff_t vcs_lseek(struct file *file, loff_t offset, int orig)
235 size = vcs_size(file_inode(file));
239 return fixed_size_llseek(file, offset, orig, size);
244 vcs_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
246 struct inode *inode = file_inode(file);
248 struct vcs_poll_data *poll;
250 int attr, uni_mode, row, col, maxcol, viewed;
251 unsigned short *org = NULL;
255 con_buf = (char *) __get_free_page(GFP_KERNEL);
261 /* Select the proper current console and verify
262 * sanity of the situation under the console lock.
266 uni_mode = use_unicode(inode);
267 attr = use_attributes(inode);
269 vc = vcs_vc(inode, &viewed);
276 /* we enforce 32-bit alignment for pos and count in unicode mode */
277 if (uni_mode && (pos | count) & 3)
280 poll = file->private_data;
286 char *con_buf0, *con_buf_start;
287 long this_round, size;
291 /* Check whether we are above size each round,
292 * as copy_to_user at the end of this loop
295 size = vcs_size(inode);
304 if (count > size - pos)
308 if (this_round > CON_BUF_SIZE)
309 this_round = CON_BUF_SIZE;
311 /* Perform the whole read into the local con_buf.
312 * Then we can drop the console spinlock and safely
313 * attempt to move it to userspace.
316 con_buf_start = con_buf0 = con_buf;
317 orig_count = this_round;
318 maxcol = vc->vc_cols;
322 ret = vc_uniscr_check(vc);
326 row = p / vc->vc_cols;
330 if (nr > this_round/4)
332 vc_uniscr_copy_line(vc, con_buf0, viewed,
335 this_round -= nr * 4;
339 } while (this_round);
341 org = screen_pos(vc, p, viewed);
344 while (this_round-- > 0) {
345 *con_buf0++ = (vcs_scr_readw(vc, org++) & 0xff);
346 if (++col == maxcol) {
347 org = screen_pos(vc, p, viewed);
353 if (p < HEADER_SIZE) {
356 /* clamp header values if they don't fit */
357 con_buf0[0] = min(vc->vc_rows, 0xFFu);
358 con_buf0[1] = min(vc->vc_cols, 0xFFu);
359 getconsxy(vc, con_buf0 + 2);
363 if (this_round > CON_BUF_SIZE) {
364 this_round = CON_BUF_SIZE;
365 orig_count = this_round - p;
368 tmp_count = HEADER_SIZE;
369 if (tmp_count > this_round)
370 tmp_count = this_round;
372 /* Advance state pointers and move on. */
373 this_round -= tmp_count;
375 con_buf0 = con_buf + HEADER_SIZE;
376 /* If this_round >= 0, then p is even... */
378 /* Skip first byte for output if start address is odd
379 * Update region sizes up/down depending on free
383 if (this_round < CON_BUF_SIZE)
388 if (this_round > 0) {
389 unsigned short *tmp_buf = (unsigned short *)con_buf0;
395 org = screen_pos(vc, p, viewed);
398 /* Buffer has even length, so we can always copy
399 * character + attribute. We do not copy last byte
400 * to userspace if this_round is odd.
402 this_round = (this_round + 1) >> 1;
405 *tmp_buf++ = vcs_scr_readw(vc, org++);
407 if (++col == maxcol) {
408 org = screen_pos(vc, p, viewed);
416 /* Finally, release the console semaphore while we push
417 * all the data to userspace from our temporary buffer.
419 * AKPM: Even though it's a semaphore, we should drop it because
420 * the pagefault handling code may want to call printk().
424 ret = copy_to_user(buf, con_buf_start, orig_count);
428 read += (orig_count - ret);
442 free_page((unsigned long) con_buf);
447 vcs_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
449 struct inode *inode = file_inode(file);
452 long attr, size, written;
454 int col, maxcol, viewed;
455 u16 *org0 = NULL, *org = NULL;
459 con_buf = (char *) __get_free_page(GFP_KERNEL);
465 /* Select the proper current console and verify
466 * sanity of the situation under the console lock.
470 attr = use_attributes(inode);
472 vc = vcs_vc(inode, &viewed);
476 size = vcs_size(inode);
478 if (pos < 0 || pos > size)
480 if (count > size - pos)
484 long this_round = count;
488 if (this_round > CON_BUF_SIZE)
489 this_round = CON_BUF_SIZE;
491 /* Temporarily drop the console lock so that we can read
492 * in the write data from userspace safely.
495 ret = copy_from_user(con_buf, buf, this_round);
501 /* Abort loop if no data were copied. Otherwise
511 /* The vcs_size might have changed while we slept to grab
512 * the user buffer, so recheck.
513 * Return data written up to now on failure.
515 size = vcs_size(inode);
524 if (this_round > size - pos)
525 this_round = size - pos;
527 /* OK, now actually push the write to the console
528 * under the lock using the local kernel buffer.
532 orig_count = this_round;
533 maxcol = vc->vc_cols;
536 org0 = org = screen_pos(vc, p, viewed);
540 while (this_round > 0) {
541 unsigned char c = *con_buf0++;
545 (vcs_scr_readw(vc, org) & 0xff00) | c, org);
547 if (++col == maxcol) {
548 org = screen_pos(vc, p, viewed);
554 if (p < HEADER_SIZE) {
555 char header[HEADER_SIZE];
557 getconsxy(vc, header + 2);
558 while (p < HEADER_SIZE && this_round > 0) {
560 header[p++] = *con_buf0++;
563 putconsxy(vc, header + 2);
566 col = (p/2) % maxcol;
567 if (this_round > 0) {
568 org0 = org = screen_pos(vc, p/2, viewed);
569 if ((p & 1) && this_round > 0) {
575 vcs_scr_writew(vc, c |
576 (vcs_scr_readw(vc, org) & 0xff00), org);
578 vcs_scr_writew(vc, (c << 8) |
579 (vcs_scr_readw(vc, org) & 0xff), org);
583 if (++col == maxcol) {
584 org = screen_pos(vc, p/2, viewed);
591 while (this_round > 1) {
594 w = get_unaligned(((unsigned short *)con_buf0));
595 vcs_scr_writew(vc, w, org++);
598 if (++col == maxcol) {
599 org = screen_pos(vc, p, viewed);
604 if (this_round > 0) {
609 vcs_scr_writew(vc, (vcs_scr_readw(vc, org) & 0xff) | (c << 8), org);
611 vcs_scr_writew(vc, (vcs_scr_readw(vc, org) & 0xff00) | c, org);
616 written += orig_count;
620 update_region(vc, (unsigned long)(org0), org - org0);
629 free_page((unsigned long) con_buf);
634 vcs_poll(struct file *file, poll_table *wait)
636 struct vcs_poll_data *poll = vcs_poll_data_get(file);
637 __poll_t ret = DEFAULT_POLLMASK|EPOLLERR;
640 poll_wait(file, &poll->waitq, wait);
641 switch (poll->event) {
643 ret = DEFAULT_POLLMASK|EPOLLPRI;
646 ret = DEFAULT_POLLMASK|EPOLLHUP|EPOLLERR;
649 ret = DEFAULT_POLLMASK;
657 vcs_fasync(int fd, struct file *file, int on)
659 struct vcs_poll_data *poll = file->private_data;
662 /* don't allocate anything if all we want is disable fasync */
665 poll = vcs_poll_data_get(file);
670 return fasync_helper(fd, file, on, &poll->fasync);
674 vcs_open(struct inode *inode, struct file *filp)
676 unsigned int currcons = console(inode);
677 bool attr = use_attributes(inode);
678 bool uni_mode = use_unicode(inode);
681 /* we currently don't support attributes in unicode mode */
682 if (attr && uni_mode)
686 if(currcons && !vc_cons_allocated(currcons-1))
692 static int vcs_release(struct inode *inode, struct file *file)
694 struct vcs_poll_data *poll = file->private_data;
697 vcs_poll_data_free(poll);
701 static const struct file_operations vcs_fops = {
706 .fasync = vcs_fasync,
708 .release = vcs_release,
711 static struct class *vc_class;
713 void vcs_make_sysfs(int index)
715 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, index + 1), NULL,
717 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, index + 65), NULL,
718 "vcsu%u", index + 1);
719 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, index + 129), NULL,
720 "vcsa%u", index + 1);
723 void vcs_remove_sysfs(int index)
725 device_destroy(vc_class, MKDEV(VCS_MAJOR, index + 1));
726 device_destroy(vc_class, MKDEV(VCS_MAJOR, index + 65));
727 device_destroy(vc_class, MKDEV(VCS_MAJOR, index + 129));
730 int __init vcs_init(void)
734 if (register_chrdev(VCS_MAJOR, "vcs", &vcs_fops))
735 panic("unable to get major %d for vcs device", VCS_MAJOR);
736 vc_class = class_create(THIS_MODULE, "vc");
738 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, 0), NULL, "vcs");
739 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, 64), NULL, "vcsu");
740 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, 128), NULL, "vcsa");
741 for (i = 0; i < MIN_NR_CONSOLES; i++)