diff mbox

console: Add persistent scrollback buffers for all VGA consoles

Message ID 1401456425-15931-1-git-send-email-manuel.schoelling@gmx.de (mailing list archive)
State New, archived
Headers show

Commit Message

Manuel Schölling May 30, 2014, 1:27 p.m. UTC
Add a scrollback buffers for each VGA console. The benefit is that
the scrollback history is not flushed when switching between consoles
but is persistent.
The buffers are allocated on demand when a new console is opened.

Signed-off-by: Manuel Schölling <manuel.schoelling@gmx.de>
---
 drivers/video/console/Kconfig  |    6 +-
 drivers/video/console/vgacon.c |  124 ++++++++++++++++++++++++----------------
 2 files changed, 79 insertions(+), 51 deletions(-)

Comments

Geert Uytterhoeven May 30, 2014, 2:28 p.m. UTC | #1
Hi Manuel,

On Fri, May 30, 2014 at 3:27 PM, Manuel Schölling
<manuel.schoelling@gmx.de> wrote:
> Add a scrollback buffers for each VGA console. The benefit is that
> the scrollback history is not flushed when switching between consoles
> but is persistent.
> The buffers are allocated on demand when a new console is opened.

Thanks for your patch!

I see two issues with this feature:
  1. Before, the single (default 64 KiB) buffer was allocated at startup.
     Now you will allocate a buffer each time a new console is opened.
     Depending on memory fragmentation, this may fail.
  2. People with RAM-constrained systems may not like this.
     Can it be a config option?

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
--
To unsubscribe from this list: send the line "unsubscribe linux-fbdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Manuel Schölling May 30, 2014, 2:57 p.m. UTC | #2
Hi Geert,

On Fr, 2014-05-30 at 16:28 +0200, Geert Uytterhoeven wrote:
Hi Manuel,
> 
> On Fri, May 30, 2014 at 3:27 PM, Manuel Schölling
> <manuel.schoelling@gmx.de> wrote:
> > Add a scrollback buffers for each VGA console. The benefit is that
> > the scrollback history is not flushed when switching between
consoles
> > but is persistent.
> > The buffers are allocated on demand when a new console is opened.
> 
> Thanks for your patch!
> 
> I see two issues with this feature:
>   1. Before, the single (default 64 KiB) buffer was allocated at
startup.
>      Now you will allocate a buffer each time a new console is opened.
>      Depending on memory fragmentation, this may fail.
Indeed, if allocation fails, scrollbuffer[vc_num]->data will stay NULL
and scrolling will be disabled for that console. Is that ok or would you
prefer another behavior of the kernel?

>  2. People with RAM-constrained systems may not like this.
>      Can it be a config option?
Sure, I will add an option for that.

> 
> Gr{oetje,eeting}s,
> 
>                         Geert
> 
> --
> Geert Uytterhoeven -- There's lots of Linux beyond ia32 --
geert@linux-m68k.org
> 
> In personal conversations with technical people, I call myself a
hacker. But
> when I'm talking to journalists I just say "programmer" or something
like that.
>                                 -- Linus Torvalds
> 

--
To unsubscribe from this list: send the line "unsubscribe linux-fbdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Randy Dunlap May 30, 2014, 5:06 p.m. UTC | #3
On 05/30/2014 06:27 AM, Manuel Schölling wrote:
> ---
>  drivers/video/console/Kconfig  |    6 +-
>  drivers/video/console/vgacon.c |  124 ++++++++++++++++++++++++----------------
>  2 files changed, 79 insertions(+), 51 deletions(-)
> 
> diff --git a/drivers/video/console/Kconfig b/drivers/video/console/Kconfig
> index fe1cd01..d7ec96c 100644
> --- a/drivers/video/console/Kconfig
> +++ b/drivers/video/console/Kconfig
> @@ -38,14 +38,14 @@ config VGACON_SOFT_SCROLLBACK
>  	 RAM to allocate for this buffer.  If unsure, say 'N'.
>  
>  config VGACON_SOFT_SCROLLBACK_SIZE
> -       int "Scrollback Buffer Size (in KB)"
> +       int "Scrollback Buffer Size per console (in KB)"
>         depends on VGACON_SOFT_SCROLLBACK
>         range 1 1024
>         default "64"
>         help
>           Enter the amount of System RAM to allocate for the scrollback
> -	 buffer.  Each 64KB will give you approximately 16 80x25
> -	 screenfuls of scrollback buffer
> +	 buffer for each VGA console. Each 64KB will give you approximately
> +	 16 80x25 screenfuls of scrollback buffer.

Nitpick: CodingStyle says to indent help text 1 tab + 2 spaces.

>  
>  config MDA_CONSOLE
>  	depends on !M68K && !PARISC && ISA
Jakub Wilk May 30, 2014, 10:26 p.m. UTC | #4
* Manuel Schölling <manuel.schoelling@gmx.de>, 2014-05-30, 15:27:
>Add a scrollback buffers for each VGA console. The benefit is that the 
>scrollback history is not flushed when switching between consoles but 
>is persistent.

Some people rely on this scrollback flushing as a security feature. Is 
there even another way to clear the scrollback, than to switch to 
another vt and then back again?

Debian ships this:
http://manpages.debian.org/cgi-bin/man.cgi?query=clear_console
https://sources.debian.net/src/bash/4.2%2Bdfsg-0.1/debian/clear_console.c
Manuel Schölling May 31, 2014, 9:49 a.m. UTC | #5
On Sa, 2014-05-31 at 00:26 +0200, Jakub Wilk wrote:
> * Manuel Schölling <manuel.schoelling@gmx.de>, 2014-05-30, 15:27:
> >Add a scrollback buffers for each VGA console. The benefit is that the 
> >scrollback history is not flushed when switching between consoles but 
> >is persistent.
> 
> Some people rely on this scrollback flushing as a security feature. Is 
> there even another way to clear the scrollback, than to switch to 
> another vt and then back again?
Thanks for raising this security issue! Maybe we should add something
like VT_FLUSH_SCROLLBACK to vt_ioctl()? [1]
I'm open for better ways to flush the scrollback history.

[1] http://lxr.free-electrons.com/source/drivers/tty/vt/vt_ioctl.c#L334

> Debian ships this:
> http://manpages.debian.org/cgi-bin/man.cgi?query=clear_console
> https://sources.debian.net/src/bash/4.2%2Bdfsg-0.1/debian/clear_console.c
> 


--
To unsubscribe from this list: send the line "unsubscribe linux-fbdev" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/drivers/video/console/Kconfig b/drivers/video/console/Kconfig
index fe1cd01..d7ec96c 100644
--- a/drivers/video/console/Kconfig
+++ b/drivers/video/console/Kconfig
@@ -38,14 +38,14 @@  config VGACON_SOFT_SCROLLBACK
 	 RAM to allocate for this buffer.  If unsure, say 'N'.
 
 config VGACON_SOFT_SCROLLBACK_SIZE
-       int "Scrollback Buffer Size (in KB)"
+       int "Scrollback Buffer Size per console (in KB)"
        depends on VGACON_SOFT_SCROLLBACK
        range 1 1024
        default "64"
        help
          Enter the amount of System RAM to allocate for the scrollback
-	 buffer.  Each 64KB will give you approximately 16 80x25
-	 screenfuls of scrollback buffer
+	 buffer for each VGA console. Each 64KB will give you approximately
+	 16 80x25 screenfuls of scrollback buffer.
 
 config MDA_CONSOLE
 	depends on !M68K && !PARISC && ISA
diff --git a/drivers/video/console/vgacon.c b/drivers/video/console/vgacon.c
index 9d8feac..215eafb 100644
--- a/drivers/video/console/vgacon.c
+++ b/drivers/video/console/vgacon.c
@@ -181,75 +181,101 @@  static inline void vga_set_mem_top(struct vc_data *c)
 
 #ifdef CONFIG_VGACON_SOFT_SCROLLBACK
 /* software scrollback */
-static void *vgacon_scrollback;
-static int vgacon_scrollback_tail;
-static int vgacon_scrollback_size;
-static int vgacon_scrollback_rows;
-static int vgacon_scrollback_cnt;
-static int vgacon_scrollback_cur;
-static int vgacon_scrollback_save;
-static int vgacon_scrollback_restore;
-
-static void vgacon_scrollback_init(int pitch)
+struct vgacon_scrollback_info {
+	void *data;
+	int tail;
+	int size;
+	int rows;
+	int cnt;
+	int cur;
+	int save;
+	int restore;
+} vgacon_scrollbacks[MAX_NR_CONSOLES];
+
+static void vgacon_scrollback_init(int vc_num)
 {
+	int pitch = vga_video_num_columns * 2;
 	int rows = CONFIG_VGACON_SOFT_SCROLLBACK_SIZE * 1024/pitch;
+	void *data;
 
-	if (vgacon_scrollback) {
-		vgacon_scrollback_cnt  = 0;
-		vgacon_scrollback_tail = 0;
-		vgacon_scrollback_cur  = 0;
-		vgacon_scrollback_rows = rows - 1;
-		vgacon_scrollback_size = rows * pitch;
+	data = kcalloc(CONFIG_VGACON_SOFT_SCROLLBACK_SIZE, 1024, GFP_NOWAIT);
+	if (!data) {
+		pr_warn("VGAcon: failed to allocate memory for scrollback.\n");
+		vgacon_scrollbacks[vc_num].data = NULL;
+		return;
 	}
+
+	vgacon_scrollbacks[vc_num].data = data;
+	vgacon_scrollbacks[vc_num].cnt  = 0;
+	vgacon_scrollbacks[vc_num].tail = 0;
+	vgacon_scrollbacks[vc_num].cur  = 0;
+	vgacon_scrollbacks[vc_num].rows = rows - 1;
+	vgacon_scrollbacks[vc_num].size = rows * pitch;
+}
+
+static void vgacon_switch_scrollback(int vc_num)
+{
+	if (!vgacon_scrollbacks[vc_num].data)
+		vgacon_scrollback_init(vc_num);
 }
 
 static void vgacon_scrollback_startup(void)
 {
-	vgacon_scrollback = kcalloc(CONFIG_VGACON_SOFT_SCROLLBACK_SIZE, 1024, GFP_NOWAIT);
-	vgacon_scrollback_init(vga_video_num_columns * 2);
+	int i;
+
+	for (i = 0; i < MAX_NR_CONSOLES; ++i)
+		vgacon_scrollbacks[i].data = NULL;
+
+	vgacon_scrollback_init(0);
 }
 
 static void vgacon_scrollback_update(struct vc_data *c, int t, int count)
 {
+	struct vgacon_scrollback_info *scrollback;
 	void *p;
 
-	if (!vgacon_scrollback_size || c->vc_num != fg_console)
+	scrollback = &vgacon_scrollbacks[c->vc_num];
+	if (!scrollback->data || !scrollback->size)
 		return;
 
 	p = (void *) (c->vc_origin + t * c->vc_size_row);
 
 	while (count--) {
-		scr_memcpyw(vgacon_scrollback + vgacon_scrollback_tail,
+		scr_memcpyw(scrollback->data + scrollback->tail,
 			    p, c->vc_size_row);
-		vgacon_scrollback_cnt++;
+		scrollback->cnt++;
 		p += c->vc_size_row;
-		vgacon_scrollback_tail += c->vc_size_row;
+		scrollback->tail += c->vc_size_row;
 
-		if (vgacon_scrollback_tail >= vgacon_scrollback_size)
-			vgacon_scrollback_tail = 0;
+		if (scrollback->tail >= scrollback->size)
+			scrollback->tail = 0;
 
-		if (vgacon_scrollback_cnt > vgacon_scrollback_rows)
-			vgacon_scrollback_cnt = vgacon_scrollback_rows;
+		if (scrollback->cnt > scrollback->rows)
+			scrollback->cnt = scrollback->rows;
 
-		vgacon_scrollback_cur = vgacon_scrollback_cnt;
+		scrollback->cur = scrollback->cnt;
 	}
 }
 
 static void vgacon_restore_screen(struct vc_data *c)
 {
-	vgacon_scrollback_save = 0;
+	struct vgacon_scrollback_info *scrollback;
+
+	scrollback = &vgacon_scrollbacks[c->vc_num];
+	scrollback->save = 0;
 
-	if (!vga_is_gfx && !vgacon_scrollback_restore) {
+	if (!vga_is_gfx && !scrollback->restore) {
 		scr_memcpyw((u16 *) c->vc_origin, (u16 *) c->vc_screenbuf,
 			    c->vc_screenbuf_size > vga_vram_size ?
 			    vga_vram_size : c->vc_screenbuf_size);
-		vgacon_scrollback_restore = 1;
-		vgacon_scrollback_cur = vgacon_scrollback_cnt;
+		scrollback->restore = 1;
+		scrollback->cur = scrollback->cnt;
 	}
 }
 
 static int vgacon_scrolldelta(struct vc_data *c, int lines)
 {
+	struct vgacon_scrollback_info *scrollback;
 	int start, end, count, soff;
 
 	if (!lines) {
@@ -258,41 +284,42 @@  static int vgacon_scrolldelta(struct vc_data *c, int lines)
 		return 1;
 	}
 
-	if (!vgacon_scrollback)
+	scrollback = &vgacon_scrollbacks[c->vc_num];
+	if (!scrollback->data)
 		return 1;
 
-	if (!vgacon_scrollback_save) {
+	if (!scrollback->save) {
 		vgacon_cursor(c, CM_ERASE);
 		vgacon_save_screen(c);
-		vgacon_scrollback_save = 1;
+		scrollback->save = 1;
 	}
 
-	vgacon_scrollback_restore = 0;
-	start = vgacon_scrollback_cur + lines;
+	scrollback->restore = 0;
+	start = scrollback->cur + lines;
 	end = start + abs(lines);
 
 	if (start < 0)
 		start = 0;
 
-	if (start > vgacon_scrollback_cnt)
-		start = vgacon_scrollback_cnt;
+	if (start > scrollback->cnt)
+		start = scrollback->cnt;
 
 	if (end < 0)
 		end = 0;
 
-	if (end > vgacon_scrollback_cnt)
-		end = vgacon_scrollback_cnt;
+	if (end > scrollback->cnt)
+		end = scrollback->cnt;
 
-	vgacon_scrollback_cur = start;
+	scrollback->cur = start;
 	count = end - start;
-	soff = vgacon_scrollback_tail - ((vgacon_scrollback_cnt - end) *
+	soff = scrollback->tail - ((scrollback->cnt - end) *
 					 c->vc_size_row);
 	soff -= count * c->vc_size_row;
 
 	if (soff < 0)
-		soff += vgacon_scrollback_size;
+		soff += scrollback->size;
 
-	count = vgacon_scrollback_cnt - start;
+	count = scrollback->cnt - start;
 
 	if (count > c->vc_rows)
 		count = c->vc_rows;
@@ -306,13 +333,13 @@  static int vgacon_scrolldelta(struct vc_data *c, int lines)
 
 		count *= c->vc_size_row;
 		/* how much memory to end of buffer left? */
-		copysize = min(count, vgacon_scrollback_size - soff);
-		scr_memcpyw(d, vgacon_scrollback + soff, copysize);
+		copysize = min(count, scrollback->size - soff);
+		scr_memcpyw(d, scrollback->data + soff, copysize);
 		d += copysize;
 		count -= copysize;
 
 		if (count) {
-			scr_memcpyw(d, vgacon_scrollback, count);
+			scr_memcpyw(d, scrollback->data, count);
 			d += count;
 		}
 
@@ -327,6 +354,7 @@  static int vgacon_scrolldelta(struct vc_data *c, int lines)
 #define vgacon_scrollback_startup(...) do { } while (0)
 #define vgacon_scrollback_init(...)    do { } while (0)
 #define vgacon_scrollback_update(...)  do { } while (0)
+#define vgacon_switch_scrollback(...)  do { } while (0)
 
 static void vgacon_restore_screen(struct vc_data *c)
 {
@@ -842,7 +870,7 @@  static int vgacon_switch(struct vc_data *c)
 			vgacon_doresize(c, c->vc_cols, c->vc_rows);
 	}
 
-	vgacon_scrollback_init(c->vc_size_row);
+	vgacon_switch_scrollback(c->vc_num);
 	return 0;		/* Redrawing not needed */
 }