1 // SPDX-License-Identifier: GPL-2.0
3 * Provide access to virtual console memory.
4 * /dev/vcs0: 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.
22 * aeb@cwi.nl - efter Friedas begravelse - 950211
24 * machek@k332.feld.cvut.cz - modified not to send characters to wrong console
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;
83 bool seen_last_update;
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;
97 if (code != VT_UPDATE)
101 currcons = fg_console;
104 if (currcons != vc->vc_num)
107 poll->seen_last_update = false;
108 wake_up_interruptible(&poll->waitq);
109 kill_fasync(&poll->fasync, SIGIO, POLL_IN);
114 vcs_poll_data_free(struct vcs_poll_data *poll)
116 unregister_vt_notifier(&poll->notifier);
120 static struct vcs_poll_data *
121 vcs_poll_data_get(struct file *file)
123 struct vcs_poll_data *poll = file->private_data, *kill = NULL;
128 poll = kzalloc(sizeof(*poll), GFP_KERNEL);
131 poll->cons_num = console(file_inode(file));
132 init_waitqueue_head(&poll->waitq);
133 poll->notifier.notifier_call = vcs_notifier;
134 if (register_vt_notifier(&poll->notifier) != 0) {
140 * This code may be called either through ->poll() or ->fasync().
141 * If we have two threads using the same file descriptor, they could
142 * both enter this function, both notice that the structure hasn't
143 * been allocated yet and go ahead allocating it in parallel, but
144 * only one of them must survive and be shared otherwise we'd leak
145 * memory with a dangling notifier callback.
147 spin_lock(&file->f_lock);
148 if (!file->private_data) {
149 file->private_data = poll;
151 /* someone else raced ahead of us */
153 poll = file->private_data;
155 spin_unlock(&file->f_lock);
157 vcs_poll_data_free(kill);
163 * Returns VC for inode.
164 * Must be called with console_lock.
166 static struct vc_data*
167 vcs_vc(struct inode *inode, int *viewed)
169 unsigned int currcons = console(inode);
171 WARN_CONSOLE_UNLOCKED();
174 currcons = fg_console;
182 return vc_cons[currcons].d;
186 * vcs_size -- return size for a VC in @vc
188 * @attr: does it use attributes?
189 * @unicode: is it unicode?
191 * Must be called with console_lock.
193 static int vcs_size(const struct vc_data *vc, bool attr, bool unicode)
197 WARN_CONSOLE_UNLOCKED();
199 size = vc->vc_rows * vc->vc_cols;
205 size = 2 * size + HEADER_SIZE;
212 static loff_t vcs_lseek(struct file *file, loff_t offset, int orig)
214 struct inode *inode = file_inode(file);
219 vc = vcs_vc(inode, NULL);
225 size = vcs_size(vc, use_attributes(inode), use_unicode(inode));
229 return fixed_size_llseek(file, offset, orig, size);
234 vcs_read(struct file *file, char __user *buf, size_t count, loff_t *ppos)
236 struct inode *inode = file_inode(file);
238 struct vcs_poll_data *poll;
240 int attr, uni_mode, row, col, maxcol, viewed;
241 unsigned short *org = NULL;
245 con_buf = (char *) __get_free_page(GFP_KERNEL);
251 /* Select the proper current console and verify
252 * sanity of the situation under the console lock.
256 uni_mode = use_unicode(inode);
257 attr = use_attributes(inode);
262 /* we enforce 32-bit alignment for pos and count in unicode mode */
263 if (uni_mode && (pos | count) & 3)
266 poll = file->private_data;
268 poll->seen_last_update = true;
272 char *con_buf0, *con_buf_start;
273 long this_round, size;
277 vc = vcs_vc(inode, &viewed);
283 /* Check whether we are above size each round,
284 * as copy_to_user at the end of this loop
287 size = vcs_size(vc, attr, uni_mode);
294 if (count > size - pos)
298 if (this_round > CON_BUF_SIZE)
299 this_round = CON_BUF_SIZE;
301 /* Perform the whole read into the local con_buf.
302 * Then we can drop the console spinlock and safely
303 * attempt to move it to userspace.
306 con_buf_start = con_buf0 = con_buf;
307 orig_count = this_round;
308 maxcol = vc->vc_cols;
312 ret = vc_uniscr_check(vc);
316 row = p / vc->vc_cols;
320 if (nr > this_round/4)
322 vc_uniscr_copy_line(vc, con_buf0, viewed,
325 this_round -= nr * 4;
329 } while (this_round);
331 org = screen_pos(vc, p, viewed);
334 while (this_round-- > 0) {
335 *con_buf0++ = (vcs_scr_readw(vc, org++) & 0xff);
336 if (++col == maxcol) {
337 org = screen_pos(vc, p, viewed);
343 if (p < HEADER_SIZE) {
346 con_buf0[0] = (char)vc->vc_rows;
347 con_buf0[1] = (char)vc->vc_cols;
348 getconsxy(vc, con_buf0 + 2);
352 if (this_round > CON_BUF_SIZE) {
353 this_round = CON_BUF_SIZE;
354 orig_count = this_round - p;
357 tmp_count = HEADER_SIZE;
358 if (tmp_count > this_round)
359 tmp_count = this_round;
361 /* Advance state pointers and move on. */
362 this_round -= tmp_count;
364 con_buf0 = con_buf + HEADER_SIZE;
365 /* If this_round >= 0, then p is even... */
367 /* Skip first byte for output if start address is odd
368 * Update region sizes up/down depending on free
372 if (this_round < CON_BUF_SIZE)
377 if (this_round > 0) {
378 unsigned short *tmp_buf = (unsigned short *)con_buf0;
384 org = screen_pos(vc, p, viewed);
387 /* Buffer has even length, so we can always copy
388 * character + attribute. We do not copy last byte
389 * to userspace if this_round is odd.
391 this_round = (this_round + 1) >> 1;
394 *tmp_buf++ = vcs_scr_readw(vc, org++);
396 if (++col == maxcol) {
397 org = screen_pos(vc, p, viewed);
405 /* Finally, release the console semaphore while we push
406 * all the data to userspace from our temporary buffer.
408 * AKPM: Even though it's a semaphore, we should drop it because
409 * the pagefault handling code may want to call printk().
413 ret = copy_to_user(buf, con_buf_start, orig_count);
417 read += (orig_count - ret);
431 free_page((unsigned long) con_buf);
436 vcs_write(struct file *file, const char __user *buf, size_t count, loff_t *ppos)
438 struct inode *inode = file_inode(file);
441 long attr, size, written;
443 int col, maxcol, viewed;
444 u16 *org0 = NULL, *org = NULL;
448 if (use_unicode(inode))
451 con_buf = (char *) __get_free_page(GFP_KERNEL);
457 /* Select the proper current console and verify
458 * sanity of the situation under the console lock.
462 attr = use_attributes(inode);
464 vc = vcs_vc(inode, &viewed);
468 size = vcs_size(vc, attr, false);
474 if (pos < 0 || pos > size)
476 if (count > size - pos)
480 long this_round = count;
484 if (this_round > CON_BUF_SIZE)
485 this_round = CON_BUF_SIZE;
487 /* Temporarily drop the console lock so that we can read
488 * in the write data from userspace safely.
491 ret = copy_from_user(con_buf, buf, this_round);
497 /* Abort loop if no data were copied. Otherwise
507 /* The vc might have been freed or vcs_size might have changed
508 * while we slept to grab the user buffer, so recheck.
509 * Return data written up to now on failure.
511 vc = vcs_vc(inode, &viewed);
518 size = vcs_size(vc, attr, false);
527 if (this_round > size - pos)
528 this_round = size - pos;
530 /* OK, now actually push the write to the console
531 * under the lock using the local kernel buffer.
535 orig_count = this_round;
536 maxcol = vc->vc_cols;
539 org0 = org = screen_pos(vc, p, viewed);
543 while (this_round > 0) {
544 unsigned char c = *con_buf0++;
548 (vcs_scr_readw(vc, org) & 0xff00) | c, org);
550 if (++col == maxcol) {
551 org = screen_pos(vc, p, viewed);
557 if (p < HEADER_SIZE) {
558 char header[HEADER_SIZE];
560 getconsxy(vc, header + 2);
561 while (p < HEADER_SIZE && this_round > 0) {
563 header[p++] = *con_buf0++;
566 putconsxy(vc, header + 2);
569 col = (p/2) % maxcol;
570 if (this_round > 0) {
571 org0 = org = screen_pos(vc, p/2, viewed);
572 if ((p & 1) && this_round > 0) {
578 vcs_scr_writew(vc, c |
579 (vcs_scr_readw(vc, org) & 0xff00), org);
581 vcs_scr_writew(vc, (c << 8) |
582 (vcs_scr_readw(vc, org) & 0xff), org);
586 if (++col == maxcol) {
587 org = screen_pos(vc, p/2, viewed);
594 while (this_round > 1) {
597 w = get_unaligned(((unsigned short *)con_buf0));
598 vcs_scr_writew(vc, w, org++);
601 if (++col == maxcol) {
602 org = screen_pos(vc, p, viewed);
607 if (this_round > 0) {
612 vcs_scr_writew(vc, (vcs_scr_readw(vc, org) & 0xff) | (c << 8), org);
614 vcs_scr_writew(vc, (vcs_scr_readw(vc, org) & 0xff00) | c, org);
619 written += orig_count;
623 update_region(vc, (unsigned long)(org0), org - org0);
632 free_page((unsigned long) con_buf);
637 vcs_poll(struct file *file, poll_table *wait)
639 struct vcs_poll_data *poll = vcs_poll_data_get(file);
640 __poll_t ret = DEFAULT_POLLMASK|EPOLLERR|EPOLLPRI;
643 poll_wait(file, &poll->waitq, wait);
644 if (poll->seen_last_update)
645 ret = DEFAULT_POLLMASK;
651 vcs_fasync(int fd, struct file *file, int on)
653 struct vcs_poll_data *poll = file->private_data;
656 /* don't allocate anything if all we want is disable fasync */
659 poll = vcs_poll_data_get(file);
664 return fasync_helper(fd, file, on, &poll->fasync);
668 vcs_open(struct inode *inode, struct file *filp)
670 unsigned int currcons = console(inode);
671 bool attr = use_attributes(inode);
672 bool uni_mode = use_unicode(inode);
675 /* we currently don't support attributes in unicode mode */
676 if (attr && uni_mode)
680 if(currcons && !vc_cons_allocated(currcons-1))
686 static int vcs_release(struct inode *inode, struct file *file)
688 struct vcs_poll_data *poll = file->private_data;
691 vcs_poll_data_free(poll);
695 static const struct file_operations vcs_fops = {
700 .fasync = vcs_fasync,
702 .release = vcs_release,
705 static struct class *vc_class;
707 void vcs_make_sysfs(int index)
709 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, index + 1), NULL,
711 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, index + 65), NULL,
712 "vcsu%u", index + 1);
713 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, index + 129), NULL,
714 "vcsa%u", index + 1);
717 void vcs_remove_sysfs(int index)
719 device_destroy(vc_class, MKDEV(VCS_MAJOR, index + 1));
720 device_destroy(vc_class, MKDEV(VCS_MAJOR, index + 65));
721 device_destroy(vc_class, MKDEV(VCS_MAJOR, index + 129));
724 int __init vcs_init(void)
728 if (register_chrdev(VCS_MAJOR, "vcs", &vcs_fops))
729 panic("unable to get major %d for vcs device", VCS_MAJOR);
730 vc_class = class_create(THIS_MODULE, "vc");
732 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, 0), NULL, "vcs");
733 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, 64), NULL, "vcsu");
734 device_create(vc_class, NULL, MKDEV(VCS_MAJOR, 128), NULL, "vcsa");
735 for (i = 0; i < MIN_NR_CONSOLES; i++)