staging: speakup: factor out selection code
Subsystems (2)
cover staging: speakup: factor out selection code
Hi,
Speakup's selection functionality parallels that of drivers/tty/vt/selection.c. This patch set replaces speakup's implementation with calls to vt's selection code. This is one of the remaining items in our TODO file and it's needed for moving speakup out of staging.
Please note that in speakup selection is set inside interrupt context of keyboard handler. Set selection code in vt happens in process context and hence expects ability to sleep. To address this, there were two
options: farm out speakup's set selection into a work_struct thread, or create atomic version of vt's set_selection. These patches implement the former option.
Here's a summary:
Patch 1 re-arranges code in vt and exports some functions. Patch 2 replaces speakup's selection code with calls to vt's functions exported in patch 1.
Thanks,
Okash
PATCH 1/2 vt: selection: allow functions to be called from inside kernel
This patch breaks set_selection() into two functions so that when called from kernel, copy_from_user() can be avoided. It also exports set_selection() and paste_selection().
These changes are used the following patch where speakup's selection functionality calls into the above functions, thereby doing away with parallel implementation.
--- drivers/tty/vt/selection.c | 37 ++++++++++++++++++++++++------------- include/linux/selection.h | 3 +-- 2 files changed, 25 insertions(+), 15 deletions(-)
drivers/tty/vt/selection.c +24 -13
@@ -80,6 +80,7 @@ void clear_selection(void) sel_start =-1 ; } } +EXPORT_SYMBOL_GPL (clear_selection);/* * User settable table: what characters are to be considered alphabetic?
@@ -164,34 +165,42 @@ static int store_utf8(u32 c, char *p)* a lot under the lock but its hardly a performance path */ int set_selection (const struct tiocl_selection __user *sel,struct tty_struct *tty) +{ +struct tiocl_selection v; + +if (copy_from_user (&v, sel,sizeof (*sel))) +return -EFAULT ; + +return do_set_selection (&v, tty); +} + +int do_set_selection (struct tiocl_selection *v,struct tty_struct *tty) {struct vc_data *vc = vc_cons[fg_console].d;int new_sel_start, new_sel_end, spc; -struct tiocl_selection v;char *bp, *obp;int i, ps, pe, multiplier;u32 c;int mode;poke_blanked_console (); -if (copy_from_user (&v, sel,sizeof (*sel))) -return -EFAULT ; - v.xs =min_t (u16, v.xs -1 , vc->vc_cols -1 ); - v.ys =min_t (u16, v.ys -1 , vc->vc_rows -1 ); - v.xe =min_t (u16, v.xe -1 , vc->vc_cols -1 ); - v.ye =min_t (u16, v.ye -1 , vc->vc_rows -1 ); - ps = v.ys * vc->vc_size_row + (v.xs <<1 ); - pe = v.ye * vc->vc_size_row + (v.xe <<1 ); + v->xs =min_t (u16, v->xs -1 , vc->vc_cols -1 ); + v->ys =min_t (u16, v->ys -1 , vc->vc_rows -1 ); + v->xe =min_t (u16, v->xe -1 , vc->vc_cols -1 ); + v->ye =min_t (u16, v->ye -1 , vc->vc_rows -1 ); + ps = v->ys * vc->vc_size_row + (v->xs <<1 ); + pe = v->ye * vc->vc_size_row + (v->xe <<1 ); -if (v.sel_mode ==TIOCL_SELCLEAR ) { +if (v->sel_mode ==TIOCL_SELCLEAR ) {/* useful for screendump without selection highlights */ clear_selection ();return 0 ; } -if (mouse_reporting () && (v.sel_mode &TIOCL_SELMOUSEREPORT )) { -mouse_report (tty, v.sel_mode &TIOCL_SELBUTTONMASK , v.xs, v.ys); +if (mouse_reporting () && (v->sel_mode &TIOCL_SELMOUSEREPORT )) { +mouse_report (tty, v->sel_mode &TIOCL_SELBUTTONMASK , v->xs, + v->ys);return 0 ; }
@@ -208,7 +217,7 @@ int set_selection(const struct tiocl_selection __user *sel, struct tty_struct *telse use_unicode =0 ; -switch (v.sel_mode) +switch (v->sel_mode) {case TIOCL_SELCHAR :/* character-by-character selection */ new_sel_start = ps;
@@ -322,6 +331,7 @@ int set_selection(const struct tiocl_selection __user *sel, struct tty_struct *t sel_buffer_lth = bp - sel_buffer;return 0 ; } +EXPORT_SYMBOL_GPL (do_set_selection);/* Insert the contents of the selection buffer into the * queue of the tty associated with the current console.
@@ -367,3 +377,4 @@ int paste_selection(struct tty_struct *tty)tty_ldisc_deref (ld);return 0 ; } +EXPORT_SYMBOL_GPL (paste_selection);
include/linux/selection.h +1 -2
@@ -11,13 +11,12 @@#include <linux/tiocl.h> #include <linux/vt_buffer.h> -struct tty_struct ; -extern struct vc_data *sel_cons;struct tty_struct ;extern void clear_selection (void );extern int set_selection (const struct tiocl_selection __user *sel,struct tty_struct *tty); +extern int do_set_selection (struct tiocl_selection *v,struct tty_struct *tty);extern int paste_selection (struct tty_struct *tty);extern int sel_loadlut (char __user *p);extern int mouse_reporting (void );
Signature · 1 line
2.21.0
Greg Kroah-Hartman
maintainerRe: [PATCH 1/2] vt: selection: allow functions to be called from inside kernel
include/linux/selection.h line 15
Quoted 10 lines · Okash Khawaja
include/linux/selection.h +0
-2@@ -11,13 +11,12 @@#include <linux/tiocl.h> #include <linux/vt_buffer.h> -struct tty_struct ; -
Nit, why remove these lines?
thanks,
greg k-h
Re: [PATCH 1/2] vt: selection: allow functions to be called from inside kernel
Greg KH, le jeu. 04 avril 2019 22:35:49 +0200, a ecrit:
Quoted 9 lines · Okash Khawaja
Quoted 8 lines
include/linux/selection.h +0
-0@@ -11,13 +11,12 @@#include <linux/tiocl.h> #include <linux/vt_buffer.h>
Quoted 4 lines
include/linux/selection.h line 15
Quoted 2 lines
include/linux/selection.h +0
-2-struct tty_struct ; -Nit, why remove these lines?
The same line shows up already just a couple of lines below, so it's just a clean-up along the way.
Samuel
Greg Kroah-Hartman
maintainerRe: [PATCH 1/2] vt: selection: allow functions to be called from inside kernel
In reply to Okash KhawajaQuoted 32 lines · Okash Khawaja
This patch breaks
set_selection()into two functions so that when called from kernel,copy_from_user()can be avoided. It also exportsset_selection()andpaste_selection().These changes are used the following patch where speakup's selection functionality calls into the above functions, thereby doing away with parallel implementation.
Signed-off-by Okash Khawaja <[email protected]>Reviewed-by Samuel Thibault <[email protected]>Tested-by Gregory Nowak <[email protected]>--- drivers/tty/vt/selection.c | 37 ++++++++++++++++++++++++------------- include/linux/selection.h | 3 +-- 2 files changed, 25 insertions(+), 15 deletions(-)drivers/tty/vt/selection.c +1
-0@@ -80,6 +80,7 @@ void clear_selection(void) sel_start =-1 ; } } +EXPORT_SYMBOL_GPL (clear_selection);/* * User settable table: what characters are to be considered alphabetic? @@ -164,34 +165,42 @@ static int store_utf8(u32 c, char *p)* a lot under the lock but its hardly a performance path */ int set_selection (const struct tiocl_selection __user *sel,struct tty_struct *tty)
drivers/tty/vt/selection.c static int store_utf8(u32 c, char *p) · line 177
Quoted 10 lines
drivers/tty/vt/selection.c +10
-0+{ +struct tiocl_selection v; + +if (copy_from_user (&v, sel,sizeof (*sel))) +return -EFAULT ; + +return do_set_selection (&v, tty); +} + +int do_set_selection (struct tiocl_selection *v,struct tty_struct *tty)
I have no idea what the difference is between set_selection() and do_set_selection() is now. Naming is hard, I know :(
How about set_selection_kernel()? set_selection_tiocl()?
Something to show that one takes a userspace pointer, and the other a kernel pointer, how about:
set_selection_user()
set_selection_kernel()
making it more obvious?
thanks,
greg k-h
PATCH 2/2 staging: speakup: refactor to use existing code in vt
In reply to Okash KhawajaThis patch replaces speakup's implementations with calls to functions in tty/vt/selection.c. Those functions are:
cancel_selection()do_set_selection()paste_selection()
Currently setting selection is done in interrupt context. However, do_set_selection() can sleep - for instance, it requires console_lock which can sleep. Therefore we offload that work to a work_struct thread, following the same pattern which was already set for paste_selection(). When setting selection, we also get a reference to tty and make sure to release the reference before returning.
struct speakup_paste_work has been renamed to the more generic speakup_selection_work because it is now used for both pasting as well as setting selection. When paste work is cancelled, the code wasn't setting tty to NULL. This patch also fixes that by setting tty to NULL so that in case of failure we don't get EBUSY forever.
--- drivers/staging/speakup/main.c | 1 + drivers/staging/speakup/selection.c | 212 +++++++++++----------------- drivers/staging/speakup/speakup.h | 1 + 3 files changed, 88 insertions(+), 126 deletions(-)
drivers/staging/speakup/main.c +1 -0
@@ -2319,6 +2319,7 @@ static void __exit speakup_exit(void)unregister_keyboard_notifier (&keyboard_notifier_block);unregister_vt_notifier (&vt_notifier_block);speakup_unregister_devsynth (); +speakup_cancel_selection ();speakup_cancel_paste ();del_timer_sync (&cursor_timer);kthread_stop (speakup_task);
drivers/staging/speakup/selection.c +86 -126
264 lines not on this page · raw message
drivers/staging/speakup/speakup.h +1 -0
@@ -72,6 +72,7 @@ void synth_buffer_add(u16 ch);void synth_buffer_clear (void );void speakup_clear_selection (void );int speakup_set_selection (struct tty_struct *tty); +void speakup_cancel_selection (void );int speakup_paste_selection (struct tty_struct *tty);void speakup_cancel_paste (void );void speakup_register_devsynth (void );
Signature · 1 line
2.21.0
v2 cover staging: speakup: factor out selection code
In reply to Okash KhawajaHi,
The v2 renames set_selection() and do_set_selection() to following more explicit names:
set_selection_user() /* includes copying data from user space */ set_selection_kernel() /* no copying from user space */
The patches also update references to set_selection() to be set_selection_user().
Original intro:
Speakup's selection functionality parallels that of drivers/tty/vt/selection.c. This patch set replaces speakup's implementation with calls to vt's selection code. This is one of the remaining items in our TODO file and it's needed for moving speakup out of staging.
Please note that in speakup selection is set inside interrupt context of keyboard handler. Set selection code in vt happens in process context and hence expects ability to sleep. To address this, there were two
options: farm out speakup's set selection into a work_struct thread, or create atomic version of vt's set_selection. These patches implement the former option.
Here's a summary:
Patch 1 re-arranges code in vt and exports some functions. Patch 2 replaces speakup's selection code with calls to vt's functions exported in patch 1.
Thanks,
Okash
PATCH v2 1/2 vt: selection: allow functions to be called from inside kernel
This patch breaks set_selection() into two functions so that when called from kernel, copy_from_user() can be avoided. The two functions are called set_selection_user() and set_selection_kernel() in order to be explicit about their purposes. This also means updating any references to set_selection() and fixing for name change. It also exports set_selection_kernel() and paste_selection().
These changes are used the following patch where speakup's selection functionality calls into the above functions, thereby doing away with parallel implementation.
--- drivers/tty/vt/selection.c | 46 ++++++++++++++++++++++++++++++---------------- drivers/tty/vt/vt.c | 7 ++++--- include/linux/selection.h | 7 ++++--- 3 files changed, 38 insertions(+), 22 deletions(-)
drivers/tty/vt/selection.c +30 -16
@@ -2,7 +2,9 @@/* * This module exports the functions: * -* 'int set_selection(struct tiocl_selection __user *, struct tty_struct *)' +* 'int set_selection_user(struct tiocl_selection __user *, +* struct tty_struct *)' +* 'int set_selection_kernel(struct tiocl_selection *, struct tty_struct *)' * 'void clear_selection(void)' * 'int paste_selection(struct tty_struct *)' * 'int sel_loadlut(char __user *)'
@@ -80,6 +82,7 @@ void clear_selection(void) sel_start =-1 ; } } +EXPORT_SYMBOL_GPL (clear_selection);/* * User settable table: what characters are to be considered alphabetic?
@@ -154,7 +157,7 @@ static int store_utf8(u32 c, char *p) }/** -* set_selection - set the current selection. +* set_selection_user - set the current selection. * @sel: user selection info * @tty: the console tty *
@@ -163,35 +166,44 @@ static int store_utf8(u32 c, char *p)* The entire selection process is managed under the console_lock. It's * a lot under the lock but its hardly a performance path */ -int set_selection (const struct tiocl_selection __user *sel,struct tty_struct *tty) +int set_selection_user (const struct tiocl_selection __user *sel, +struct tty_struct *tty) +{ +struct tiocl_selection v; + +if (copy_from_user (&v, sel,sizeof (*sel))) +return -EFAULT ; + +return set_selection_kernel (&v, tty); +} + +int set_selection_kernel (struct tiocl_selection *v,struct tty_struct *tty) {struct vc_data *vc = vc_cons[fg_console].d;int new_sel_start, new_sel_end, spc; -struct tiocl_selection v;char *bp, *obp;int i, ps, pe, multiplier;u32 c;int mode;poke_blanked_console (); -if (copy_from_user (&v, sel,sizeof (*sel))) -return -EFAULT ; - v.xs =min_t (u16, v.xs -1 , vc->vc_cols -1 ); - v.ys =min_t (u16, v.ys -1 , vc->vc_rows -1 ); - v.xe =min_t (u16, v.xe -1 , vc->vc_cols -1 ); - v.ye =min_t (u16, v.ye -1 , vc->vc_rows -1 ); - ps = v.ys * vc->vc_size_row + (v.xs <<1 ); - pe = v.ye * vc->vc_size_row + (v.xe <<1 ); + v->xs =min_t (u16, v->xs -1 , vc->vc_cols -1 ); + v->ys =min_t (u16, v->ys -1 , vc->vc_rows -1 ); + v->xe =min_t (u16, v->xe -1 , vc->vc_cols -1 ); + v->ye =min_t (u16, v->ye -1 , vc->vc_rows -1 ); + ps = v->ys * vc->vc_size_row + (v->xs <<1 ); + pe = v->ye * vc->vc_size_row + (v->xe <<1 ); -if (v.sel_mode ==TIOCL_SELCLEAR ) { +if (v->sel_mode ==TIOCL_SELCLEAR ) {/* useful for screendump without selection highlights */ clear_selection ();return 0 ; } -if (mouse_reporting () && (v.sel_mode &TIOCL_SELMOUSEREPORT )) { -mouse_report (tty, v.sel_mode &TIOCL_SELBUTTONMASK , v.xs, v.ys); +if (mouse_reporting () && (v->sel_mode &TIOCL_SELMOUSEREPORT )) { +mouse_report (tty, v->sel_mode &TIOCL_SELBUTTONMASK , v->xs, + v->ys);return 0 ; }
@@ -208,7 +220,7 @@ int set_selection(const struct tiocl_selection __user *sel, struct tty_struct *telse use_unicode =0 ; -switch (v.sel_mode) +switch (v->sel_mode) {case TIOCL_SELCHAR :/* character-by-character selection */ new_sel_start = ps;
@@ -322,6 +334,7 @@ int set_selection(const struct tiocl_selection __user *sel, struct tty_struct *t sel_buffer_lth = bp - sel_buffer;return 0 ; } +EXPORT_SYMBOL_GPL (set_selection_kernel);/* Insert the contents of the selection buffer into the * queue of the tty associated with the current console.
@@ -367,3 +380,4 @@ int paste_selection(struct tty_struct *tty)tty_ldisc_deref (ld);return 0 ; } +EXPORT_SYMBOL_GPL (paste_selection);
drivers/tty/vt/vt.c +4 -3
@@ -1804,7 +1804,7 @@ void mouse_report(struct tty_struct *tty, int butt, int mrx, int mry)respond_string (buf, tty->port); } -/* invoked via ioctl(TIOCLINUX) and through set_selection */ +/* invoked via ioctl(TIOCLINUX) and through set_selection_user */ int mouse_reporting (void ) {return vc_cons[fg_console].d->vc_report_mouse;
@@ -3008,7 +3008,7 @@ static struct tty_driver *vt_console_device(struct console *c, int *index)* There are some functions which can sleep for arbitrary periods * (paste_selection) but we don't need the lock there anyway. * -* set_selection has locking, and definitely needs it +* set_selection_user has locking, and definitely needs it */ int tioclinux (struct tty_struct *tty,unsigned long arg)
@@ -3028,7 +3028,8 @@ int tioclinux(struct tty_struct *tty, unsigned long arg) {case TIOCL_SETSEL :console_lock (); - ret =set_selection ((struct tiocl_selection __user *)(p+1 ), tty); + ret =set_selection_user ((struct tiocl_selection +__user *)(p+1 ), tty);console_unlock ();break ;case TIOCL_PASTESEL :
include/linux/selection.h +4 -3
@@ -11,13 +11,14 @@#include <linux/tiocl.h> #include <linux/vt_buffer.h> -struct tty_struct ; -extern struct vc_data *sel_cons;struct tty_struct ;extern void clear_selection (void ); -extern int set_selection (const struct tiocl_selection __user *sel,struct tty_struct *tty); +extern int set_selection_user (const struct tiocl_selection __user *sel, +struct tty_struct *tty); +extern int set_selection_kernel (struct tiocl_selection *v, +struct tty_struct *tty);extern int paste_selection (struct tty_struct *tty);extern int sel_loadlut (char __user *p);extern int mouse_reporting (void );
Signature · 1 line
1.8.3.1
PATCH v2 2/2 staging: speakup: refactor to use existing code in vt
In reply to Okash KhawajaThis patch replaces speakup's implementations with calls to functions in tty/vt/selection.c. Those functions are:
cancel_selection()set_selection_kernel()paste_selection()
Currently setting selection is done in interrupt context. However, set_selection_kernel() can sleep - for instance, it requires console_lock which can sleep. Therefore we offload that work to a work_struct thread, following the same pattern which was already set for paste_selection(). When setting selection, we also get a reference to tty and make sure to release the reference before returning.
struct speakup_paste_work has been renamed to the more generic speakup_selection_work because it is now used for both pasting as well as setting selection. When paste work is cancelled, the code wasn't setting tty to NULL. This patch also fixes that by setting tty to NULL so that in case of failure we don't get EBUSY forever.
--- drivers/staging/speakup/main.c | 1 + drivers/staging/speakup/selection.c | 212 +++++++++++++++--------------------- drivers/staging/speakup/speakup.h | 1 + 3 files changed, 88 insertions(+), 126 deletions(-)
drivers/staging/speakup/main.c +1 -0
@@ -2319,6 +2319,7 @@ static void __exit speakup_exit(void)unregister_keyboard_notifier (&keyboard_notifier_block);unregister_vt_notifier (&vt_notifier_block);speakup_unregister_devsynth (); +speakup_cancel_selection ();speakup_cancel_paste ();del_timer_sync (&cursor_timer);kthread_stop (speakup_task);
drivers/staging/speakup/selection.c +86 -126
264 lines not on this page · raw message
drivers/staging/speakup/speakup.h +1 -0
@@ -72,6 +72,7 @@void synth_buffer_clear (void );void speakup_clear_selection (void );int speakup_set_selection (struct tty_struct *tty); +void speakup_cancel_selection (void );int speakup_paste_selection (struct tty_struct *tty);void speakup_cancel_paste (void );void speakup_register_devsynth (void );
Signature · 1 line
1.8.3.1
Greg Kroah-Hartman
maintainerQuoted 19 lines · Okash Khawaja
Hi,
The v2 renames
set_selection()anddo_set_selection()to following more explicit names:
set_selection_user()/* includes copying data from user space */set_selection_kernel()/* no copying from user space */The patches also update references to
set_selection()to beset_selection_user().Original intro:
Speakup's selection functionality parallels that of
drivers/tty/vt/selection.c. This patch set replaces speakup's implementation with calls to vt's selection code. This is one of the remaining items in our TODO file and it's needed for moving speakup out of staging.
Quoted 6 lines
Please note that in speakup selection is set inside interrupt context of keyboard handler. Set selection code in vt happens in process context and hence expects ability to sleep. To address this, there were two
options: farm out speakup's set selection into awork_structthread, or create atomic version of vt'sset_selection. These patches implement the former option.
Very nice, both now queued up!
thanks,
greg k-h