1 // SPDX-License-Identifier: GPL-2.0
3 * This module exports the functions:
5 * 'int set_selection_user(struct tiocl_selection __user *,
6 * struct tty_struct *)'
7 * 'int set_selection_kernel(struct tiocl_selection *, struct tty_struct *)'
8 * 'void clear_selection(void)'
9 * 'int paste_selection(struct tty_struct *)'
10 * 'int sel_loadlut(char __user *)'
12 * Now that /dev/vcs exists, most of this can disappear again.
15 #include <linux/module.h>
16 #include <linux/tty.h>
17 #include <linux/sched.h>
19 #include <linux/mutex.h>
20 #include <linux/slab.h>
21 #include <linux/types.h>
23 #include <linux/uaccess.h>
25 #include <linux/kbd_kern.h>
26 #include <linux/vt_kern.h>
27 #include <linux/consolemap.h>
28 #include <linux/selection.h>
29 #include <linux/tiocl.h>
30 #include <linux/console.h>
31 #include <linux/tty_flip.h>
33 #include <linux/sched/signal.h>
35 /* Don't take this from <ctype.h>: 011-015 on the screen aren't spaces */
36 #define is_space_on_vt(c) ((c) == ' ')
38 /* FIXME: all this needs locking */
39 static struct vc_selection {
41 struct vc_data *cons; /* must not be deallocated */
44 volatile int start; /* cleared by clear_selection */
47 .lock = __MUTEX_INITIALIZER(vc_sel.lock),
51 /* clear_selection, highlight and highlight_pointer can be called
52 from interrupt (via scrollback/front) */
54 /* set reverse video on characters s-e of console with selection. */
55 static inline void highlight(const int s, const int e)
57 invert_screen(vc_sel.cons, s, e-s+2, true);
60 /* use complementary color to show the pointer */
61 static inline void highlight_pointer(const int where)
63 complement_pos(vc_sel.cons, where);
67 sel_pos(int n, bool unicode)
70 return screen_glyph_unicode(vc_sel.cons, n / 2);
71 return inverse_translate(vc_sel.cons, screen_glyph(vc_sel.cons, n), 0);
75 * clear_selection - remove current selection
77 * Remove the current selection highlight, if any from the console
78 * holding the selection. The caller must hold the console lock.
80 void clear_selection(void)
82 highlight_pointer(-1); /* hide the pointer */
83 if (vc_sel.start != -1) {
84 highlight(vc_sel.start, vc_sel.end);
88 EXPORT_SYMBOL_GPL(clear_selection);
90 bool vc_is_sel(struct vc_data *vc)
92 return vc == vc_sel.cons;
96 * User settable table: what characters are to be considered alphabetic?
97 * 128 bits. Locked by the console lock.
99 static u32 inwordLut[]={
100 0x00000000, /* control chars */
101 0x03FFE000, /* digits and "-./" */
102 0x87FFFFFE, /* uppercase and '_' */
103 0x07FFFFFE, /* lowercase */
106 static inline int inword(const u32 c)
108 return c > 0x7f || (( inwordLut[c>>5] >> (c & 0x1F) ) & 1);
112 * sel_loadlut() - load the LUT table
115 * Load the LUT table from user space. The caller must hold the console
116 * lock. Make a temporary copy so a partial update doesn't make a mess.
118 int sel_loadlut(char __user *p)
120 u32 tmplut[ARRAY_SIZE(inwordLut)];
121 if (copy_from_user(tmplut, (u32 __user *)(p+4), sizeof(inwordLut)))
123 memcpy(inwordLut, tmplut, sizeof(inwordLut));
127 /* does screen address p correspond to character at LH/RH edge of screen? */
128 static inline int atedge(const int p, int size_row)
130 return (!(p % size_row) || !((p + 2) % size_row));
133 /* stores the char in UTF8 and returns the number of bytes used (1-4) */
134 static int store_utf8(u32 c, char *p)
140 } else if (c < 0x800) {
141 /* 110***** 10****** */
142 p[0] = 0xc0 | (c >> 6);
143 p[1] = 0x80 | (c & 0x3f);
145 } else if (c < 0x10000) {
146 /* 1110**** 10****** 10****** */
147 p[0] = 0xe0 | (c >> 12);
148 p[1] = 0x80 | ((c >> 6) & 0x3f);
149 p[2] = 0x80 | (c & 0x3f);
151 } else if (c < 0x110000) {
152 /* 11110*** 10****** 10****** 10****** */
153 p[0] = 0xf0 | (c >> 18);
154 p[1] = 0x80 | ((c >> 12) & 0x3f);
155 p[2] = 0x80 | ((c >> 6) & 0x3f);
156 p[3] = 0x80 | (c & 0x3f);
159 /* outside Unicode, replace with U+FFFD */
168 * set_selection_user - set the current selection.
169 * @sel: user selection info
170 * @tty: the console tty
172 * Invoked by the ioctl handle for the vt layer.
174 * The entire selection process is managed under the console_lock. It's
175 * a lot under the lock but its hardly a performance path
177 int set_selection_user(const struct tiocl_selection __user *sel,
178 struct tty_struct *tty)
180 struct tiocl_selection v;
182 if (copy_from_user(&v, sel, sizeof(*sel)))
185 return set_selection_kernel(&v, tty);
188 static int vc_selection_store_chars(struct vc_data *vc, bool unicode)
193 /* Allocate a new buffer before freeing the old one ... */
194 /* chars can take up to 4 bytes with unicode */
195 bp = kmalloc_array((vc_sel.end - vc_sel.start) / 2 + 1, unicode ? 4 : 1,
196 GFP_KERNEL | __GFP_NOWARN);
198 printk(KERN_WARNING "selection: kmalloc() failed\n");
202 kfree(vc_sel.buffer);
206 for (i = vc_sel.start; i <= vc_sel.end; i += 2) {
207 u32 c = sel_pos(i, unicode);
209 bp += store_utf8(c, bp);
212 if (!is_space_on_vt(c))
214 if (!((i + 2) % vc->vc_size_row)) {
215 /* strip trailing blanks from line and add newline,
216 unless non-space at end of line. */
224 vc_sel.buf_len = bp - vc_sel.buffer;
229 static int vc_do_selection(struct vc_data *vc, unsigned short mode, int ps,
232 int new_sel_start, new_sel_end, spc;
233 bool unicode = vt_do_kdgkbmode(fg_console) == K_UNICODE;
236 case TIOCL_SELCHAR: /* character-by-character selection */
240 case TIOCL_SELWORD: /* word-by-word selection */
241 spc = is_space_on_vt(sel_pos(ps, unicode));
242 for (new_sel_start = ps; ; ps -= 2) {
243 if ((spc && !is_space_on_vt(sel_pos(ps, unicode))) ||
244 (!spc && !inword(sel_pos(ps, unicode))))
247 if (!(ps % vc->vc_size_row))
251 spc = is_space_on_vt(sel_pos(pe, unicode));
252 for (new_sel_end = pe; ; pe += 2) {
253 if ((spc && !is_space_on_vt(sel_pos(pe, unicode))) ||
254 (!spc && !inword(sel_pos(pe, unicode))))
257 if (!((pe + 2) % vc->vc_size_row))
261 case TIOCL_SELLINE: /* line-by-line selection */
262 new_sel_start = rounddown(ps, vc->vc_size_row);
263 new_sel_end = rounddown(pe, vc->vc_size_row) +
266 case TIOCL_SELPOINTER:
267 highlight_pointer(pe);
273 /* remove the pointer */
274 highlight_pointer(-1);
276 /* select to end of line if on trailing space */
277 if (new_sel_end > new_sel_start &&
278 !atedge(new_sel_end, vc->vc_size_row) &&
279 is_space_on_vt(sel_pos(new_sel_end, unicode))) {
280 for (pe = new_sel_end + 2; ; pe += 2)
281 if (!is_space_on_vt(sel_pos(pe, unicode)) ||
282 atedge(pe, vc->vc_size_row))
284 if (is_space_on_vt(sel_pos(pe, unicode)))
287 if (vc_sel.start == -1) /* no current selection */
288 highlight(new_sel_start, new_sel_end);
289 else if (new_sel_start == vc_sel.start)
291 if (new_sel_end == vc_sel.end) /* no action required */
293 else if (new_sel_end > vc_sel.end) /* extend to right */
294 highlight(vc_sel.end + 2, new_sel_end);
295 else /* contract from right */
296 highlight(new_sel_end + 2, vc_sel.end);
298 else if (new_sel_end == vc_sel.end)
300 if (new_sel_start < vc_sel.start) /* extend to left */
301 highlight(new_sel_start, vc_sel.start - 2);
302 else /* contract from left */
303 highlight(vc_sel.start, new_sel_start - 2);
305 else /* some other case; start selection from scratch */
308 highlight(new_sel_start, new_sel_end);
310 vc_sel.start = new_sel_start;
311 vc_sel.end = new_sel_end;
313 return vc_selection_store_chars(vc, unicode);
316 static int vc_selection(struct vc_data *vc, struct tiocl_selection *v,
317 struct tty_struct *tty)
321 poke_blanked_console();
323 if (v->sel_mode == TIOCL_SELCLEAR) {
324 /* useful for screendump without selection highlights */
329 v->xs = min_t(u16, v->xs - 1, vc->vc_cols - 1);
330 v->ys = min_t(u16, v->ys - 1, vc->vc_rows - 1);
331 v->xe = min_t(u16, v->xe - 1, vc->vc_cols - 1);
332 v->ye = min_t(u16, v->ye - 1, vc->vc_rows - 1);
334 if (mouse_reporting() && (v->sel_mode & TIOCL_SELMOUSEREPORT)) {
335 mouse_report(tty, v->sel_mode & TIOCL_SELBUTTONMASK, v->xs,
340 ps = v->ys * vc->vc_size_row + (v->xs << 1);
341 pe = v->ye * vc->vc_size_row + (v->xe << 1);
342 if (ps > pe) /* make vc_sel.start <= vc_sel.end */
345 if (vc_sel.cons != vc) {
350 return vc_do_selection(vc, v->sel_mode, ps, pe);
353 int set_selection_kernel(struct tiocl_selection *v, struct tty_struct *tty)
357 mutex_lock(&vc_sel.lock);
359 ret = vc_selection(vc_cons[fg_console].d, v, tty);
361 mutex_unlock(&vc_sel.lock);
365 EXPORT_SYMBOL_GPL(set_selection_kernel);
367 /* Insert the contents of the selection buffer into the
368 * queue of the tty associated with the current console.
369 * Invoked by ioctl().
371 * Locking: called without locks. Calls the ldisc wrongly with
374 int paste_selection(struct tty_struct *tty)
376 struct vc_data *vc = tty->driver_data;
379 struct tty_ldisc *ld;
380 DECLARE_WAITQUEUE(wait, current);
384 poke_blanked_console();
387 ld = tty_ldisc_ref_wait(tty);
389 return -EIO; /* ldisc was hung up */
390 tty_buffer_lock_exclusive(&vc->port);
392 add_wait_queue(&vc->paste_wait, &wait);
393 mutex_lock(&vc_sel.lock);
394 while (vc_sel.buffer && vc_sel.buf_len > pasted) {
395 set_current_state(TASK_INTERRUPTIBLE);
396 if (signal_pending(current)) {
400 if (tty_throttled(tty)) {
401 mutex_unlock(&vc_sel.lock);
403 mutex_lock(&vc_sel.lock);
406 __set_current_state(TASK_RUNNING);
407 count = vc_sel.buf_len - pasted;
408 count = tty_ldisc_receive_buf(ld, vc_sel.buffer + pasted, NULL,
412 mutex_unlock(&vc_sel.lock);
413 remove_wait_queue(&vc->paste_wait, &wait);
414 __set_current_state(TASK_RUNNING);
416 tty_buffer_unlock_exclusive(&vc->port);
420 EXPORT_SYMBOL_GPL(paste_selection);