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 * Returns size for VC carried by inode.
187 * Must be called with console_lock.
190 vcs_size(struct inode
*inode
)
195 WARN_CONSOLE_UNLOCKED();
197 vc
= vcs_vc(inode
, NULL
);
201 size
= vc
->vc_rows
* vc
->vc_cols
;
203 if (use_attributes(inode
)) {
204 if (use_unicode(inode
))
206 size
= 2*size
+ HEADER_SIZE
;
207 } else if (use_unicode(inode
))
212 static loff_t
vcs_lseek(struct file
*file
, loff_t offset
, int orig
)
217 size
= vcs_size(file_inode(file
));
221 return fixed_size_llseek(file
, offset
, orig
, size
);
226 vcs_read(struct file
*file
, char __user
*buf
, size_t count
, loff_t
*ppos
)
228 struct inode
*inode
= file_inode(file
);
230 struct vcs_poll_data
*poll
;
232 int attr
, uni_mode
, row
, col
, maxcol
, viewed
;
233 unsigned short *org
= NULL
;
237 con_buf
= (char *) __get_free_page(GFP_KERNEL
);
243 /* Select the proper current console and verify
244 * sanity of the situation under the console lock.
248 uni_mode
= use_unicode(inode
);
249 attr
= use_attributes(inode
);
251 vc
= vcs_vc(inode
, &viewed
);
258 /* we enforce 32-bit alignment for pos and count in unicode mode */
259 if (uni_mode
&& (pos
| count
) & 3)
262 poll
= file
->private_data
;
264 poll
->seen_last_update
= true;
268 char *con_buf0
, *con_buf_start
;
269 long this_round
, size
;
273 /* Check whether we are above size each round,
274 * as copy_to_user at the end of this loop
277 size
= vcs_size(inode
);
286 if (count
> size
- pos
)
290 if (this_round
> CON_BUF_SIZE
)
291 this_round
= CON_BUF_SIZE
;
293 /* Perform the whole read into the local con_buf.
294 * Then we can drop the console spinlock and safely
295 * attempt to move it to userspace.
298 con_buf_start
= con_buf0
= con_buf
;
299 orig_count
= this_round
;
300 maxcol
= vc
->vc_cols
;
304 ret
= vc_uniscr_check(vc
);
308 row
= p
/ vc
->vc_cols
;
312 if (nr
> this_round
/4)
314 vc_uniscr_copy_line(vc
, con_buf0
, viewed
,
317 this_round
-= nr
* 4;
321 } while (this_round
);
323 org
= screen_pos(vc
, p
, viewed
);
326 while (this_round
-- > 0) {
327 *con_buf0
++ = (vcs_scr_readw(vc
, org
++) & 0xff);
328 if (++col
== maxcol
) {
329 org
= screen_pos(vc
, p
, viewed
);
335 if (p
< HEADER_SIZE
) {
338 con_buf0
[0] = (char)vc
->vc_rows
;
339 con_buf0
[1] = (char)vc
->vc_cols
;
340 getconsxy(vc
, con_buf0
+ 2);
344 if (this_round
> CON_BUF_SIZE
) {
345 this_round
= CON_BUF_SIZE
;
346 orig_count
= this_round
- p
;
349 tmp_count
= HEADER_SIZE
;
350 if (tmp_count
> this_round
)
351 tmp_count
= this_round
;
353 /* Advance state pointers and move on. */
354 this_round
-= tmp_count
;
356 con_buf0
= con_buf
+ HEADER_SIZE
;
357 /* If this_round >= 0, then p is even... */
359 /* Skip first byte for output if start address is odd
360 * Update region sizes up/down depending on free
364 if (this_round
< CON_BUF_SIZE
)
369 if (this_round
> 0) {
370 unsigned short *tmp_buf
= (unsigned short *)con_buf0
;
376 org
= screen_pos(vc
, p
, viewed
);
379 /* Buffer has even length, so we can always copy
380 * character + attribute. We do not copy last byte
381 * to userspace if this_round is odd.
383 this_round
= (this_round
+ 1) >> 1;
386 *tmp_buf
++ = vcs_scr_readw(vc
, org
++);
388 if (++col
== maxcol
) {
389 org
= screen_pos(vc
, p
, viewed
);
397 /* Finally, release the console semaphore while we push
398 * all the data to userspace from our temporary buffer.
400 * AKPM: Even though it's a semaphore, we should drop it because
401 * the pagefault handling code may want to call printk().
405 ret
= copy_to_user(buf
, con_buf_start
, orig_count
);
409 read
+= (orig_count
- ret
);
423 free_page((unsigned long) con_buf
);
428 vcs_write(struct file
*file
, const char __user
*buf
, size_t count
, loff_t
*ppos
)
430 struct inode
*inode
= file_inode(file
);
433 long attr
, size
, written
;
435 int col
, maxcol
, viewed
;
436 u16
*org0
= NULL
, *org
= NULL
;
440 con_buf
= (char *) __get_free_page(GFP_KERNEL
);
446 /* Select the proper current console and verify
447 * sanity of the situation under the console lock.
451 attr
= use_attributes(inode
);
453 vc
= vcs_vc(inode
, &viewed
);
457 size
= vcs_size(inode
);
459 if (pos
< 0 || pos
> size
)
461 if (count
> size
- pos
)
465 long this_round
= count
;
469 if (this_round
> CON_BUF_SIZE
)
470 this_round
= CON_BUF_SIZE
;
472 /* Temporarily drop the console lock so that we can read
473 * in the write data from userspace safely.
476 ret
= copy_from_user(con_buf
, buf
, this_round
);
482 /* Abort loop if no data were copied. Otherwise
492 /* The vcs_size might have changed while we slept to grab
493 * the user buffer, so recheck.
494 * Return data written up to now on failure.
496 size
= vcs_size(inode
);
505 if (this_round
> size
- pos
)
506 this_round
= size
- pos
;
508 /* OK, now actually push the write to the console
509 * under the lock using the local kernel buffer.
513 orig_count
= this_round
;
514 maxcol
= vc
->vc_cols
;
517 org0
= org
= screen_pos(vc
, p
, viewed
);
521 while (this_round
> 0) {
522 unsigned char c
= *con_buf0
++;
526 (vcs_scr_readw(vc
, org
) & 0xff00) | c
, org
);
528 if (++col
== maxcol
) {
529 org
= screen_pos(vc
, p
, viewed
);
535 if (p
< HEADER_SIZE
) {
536 char header
[HEADER_SIZE
];
538 getconsxy(vc
, header
+ 2);
539 while (p
< HEADER_SIZE
&& this_round
> 0) {
541 header
[p
++] = *con_buf0
++;
544 putconsxy(vc
, header
+ 2);
547 col
= (p
/2) % maxcol
;
548 if (this_round
> 0) {
549 org0
= org
= screen_pos(vc
, p
/2, viewed
);
550 if ((p
& 1) && this_round
> 0) {
556 vcs_scr_writew(vc
, c
|
557 (vcs_scr_readw(vc
, org
) & 0xff00), org
);
559 vcs_scr_writew(vc
, (c
<< 8) |
560 (vcs_scr_readw(vc
, org
) & 0xff), org
);
564 if (++col
== maxcol
) {
565 org
= screen_pos(vc
, p
/2, viewed
);
572 while (this_round
> 1) {
575 w
= get_unaligned(((unsigned short *)con_buf0
));
576 vcs_scr_writew(vc
, w
, org
++);
579 if (++col
== maxcol
) {
580 org
= screen_pos(vc
, p
, viewed
);
585 if (this_round
> 0) {
590 vcs_scr_writew(vc
, (vcs_scr_readw(vc
, org
) & 0xff) | (c
<< 8), org
);
592 vcs_scr_writew(vc
, (vcs_scr_readw(vc
, org
) & 0xff00) | c
, org
);
597 written
+= orig_count
;
601 update_region(vc
, (unsigned long)(org0
), org
- org0
);
610 free_page((unsigned long) con_buf
);
615 vcs_poll(struct file
*file
, poll_table
*wait
)
617 struct vcs_poll_data
*poll
= vcs_poll_data_get(file
);
618 __poll_t ret
= DEFAULT_POLLMASK
|EPOLLERR
|EPOLLPRI
;
621 poll_wait(file
, &poll
->waitq
, wait
);
622 if (poll
->seen_last_update
)
623 ret
= DEFAULT_POLLMASK
;
629 vcs_fasync(int fd
, struct file
*file
, int on
)
631 struct vcs_poll_data
*poll
= file
->private_data
;
634 /* don't allocate anything if all we want is disable fasync */
637 poll
= vcs_poll_data_get(file
);
642 return fasync_helper(fd
, file
, on
, &poll
->fasync
);
646 vcs_open(struct inode
*inode
, struct file
*filp
)
648 unsigned int currcons
= console(inode
);
649 bool attr
= use_attributes(inode
);
650 bool uni_mode
= use_unicode(inode
);
653 /* we currently don't support attributes in unicode mode */
654 if (attr
&& uni_mode
)
658 if(currcons
&& !vc_cons_allocated(currcons
-1))
664 static int vcs_release(struct inode
*inode
, struct file
*file
)
666 struct vcs_poll_data
*poll
= file
->private_data
;
669 vcs_poll_data_free(poll
);
673 static const struct file_operations vcs_fops
= {
678 .fasync
= vcs_fasync
,
680 .release
= vcs_release
,
683 static struct class *vc_class
;
685 void vcs_make_sysfs(int index
)
687 device_create(vc_class
, NULL
, MKDEV(VCS_MAJOR
, index
+ 1), NULL
,
689 device_create(vc_class
, NULL
, MKDEV(VCS_MAJOR
, index
+ 65), NULL
,
690 "vcsu%u", index
+ 1);
691 device_create(vc_class
, NULL
, MKDEV(VCS_MAJOR
, index
+ 129), NULL
,
692 "vcsa%u", index
+ 1);
695 void vcs_remove_sysfs(int index
)
697 device_destroy(vc_class
, MKDEV(VCS_MAJOR
, index
+ 1));
698 device_destroy(vc_class
, MKDEV(VCS_MAJOR
, index
+ 65));
699 device_destroy(vc_class
, MKDEV(VCS_MAJOR
, index
+ 129));
702 int __init
vcs_init(void)
706 if (register_chrdev(VCS_MAJOR
, "vcs", &vcs_fops
))
707 panic("unable to get major %d for vcs device", VCS_MAJOR
);
708 vc_class
= class_create(THIS_MODULE
, "vc");
710 device_create(vc_class
, NULL
, MKDEV(VCS_MAJOR
, 0), NULL
, "vcs");
711 device_create(vc_class
, NULL
, MKDEV(VCS_MAJOR
, 64), NULL
, "vcsu");
712 device_create(vc_class
, NULL
, MKDEV(VCS_MAJOR
, 128), NULL
, "vcsa");
713 for (i
= 0; i
< MIN_NR_CONSOLES
; i
++)