1 /* vi: set sw=4 ts=4: */
3 * A text-mode VNC like program for Linux virtual terminals.
5 * pascal.bellard@ads-lu.com
7 * Based on Russell Stuart's conspy.c
8 * http://ace-host.stuart.id.au/russell/files/conspy.c
10 * Licensed under GPLv2 or later, see file License in this tarball for details.
13 //applet:IF_CONSPY(APPLET(conspy, _BB_DIR_BIN, _BB_SUID_DROP))
15 //kbuild:lib-$(CONFIG_CONSPY) += conspy.o
17 //config:config CONSPY
18 //config: bool "conspy"
21 //config: A text-mode VNC like program for Linux virtual terminals.
22 //config: example: conspy NUM shared access to console num
23 //config: or conspy -nd NUM screenshot of console num
24 //config: or conspy -cs NUM poor man's GNU screen like
26 //usage:#define conspy_trivial_usage
27 //usage: "[-vcsndf] [-x COL] [-y LINE] [CONSOLE_NO]"
28 //usage:#define conspy_full_usage "\n\n"
29 //usage: "A text-mode VNC like program for Linux virtual consoles."
30 //usage: "\nTo exit, quickly press ESC 3 times."
33 //usage: "\n -v Don't send keystrokes to the console"
34 //usage: "\n -c Create missing devices in /dev"
35 //usage: "\n -s Open a SHELL session"
36 //usage: "\n -n Black & white"
37 //usage: "\n -d Dump console to stdout"
38 //usage: "\n -f Follow cursor"
39 //usage: "\n -x COL Starting column"
40 //usage: "\n -y LINE Starting line"
46 unsigned char lines, cols, cursor_x, cursor_y;
49 #define CHAR(x) (*(uint8_t*)(x))
50 #define ATTR(x) (((uint8_t*)(x))[1])
51 #define NEXT(x) ((x) += 2)
52 #define DATA(x) (*(uint16_t*)(x))
64 int first_line_offset;
66 // cached local tty parameters
71 smallint curoff; // unknown:0 cursor on:-1 cursor off:1
72 char attrbuf[sizeof("\033[0;1;5;30;40m")];
74 struct screen_info remote;
75 // saved local tty terminfo
76 struct termios term_orig;
77 char vcsa_name[sizeof("/dev/vcsaNN")];
80 #define G (*ptr_to_globals)
81 #define INIT_G() do { \
82 SET_PTR_TO_GLOBALS(xzalloc(sizeof(G))); \
83 G.attrbuf[0] = '\033'; \
85 G.width = G.height = UINT_MAX; \
91 FLAG_c, // create device if need
94 FLAG_d, // dump screen
95 FLAG_f, // follow cursor
97 #define FLAG(x) (1 << FLAG_##x)
98 #define BW (option_mask32 & FLAG(n))
100 static void clrscr(void)
102 // Home, clear till end of screen
103 fputs("\033[1;1H" "\033[J", stdout);
107 static void set_cursor(int state)
109 if (G.curoff != state) {
111 fputs("\033[?25", stdout);
112 bb_putchar("h?l"[1 + state]);
116 static void gotoxy(int col, int line)
118 if (G.col != col || G.line != line) {
121 printf("\033[%u;%uH", line + 1, col + 1);
125 static void cleanup(int code)
127 set_cursor(-1); // cursor on
128 tcsetattr(G.kbd_fd, TCSANOW, &G.term_orig);
129 if (ENABLE_FEATURE_CLEAN_UP) {
134 fputs("\033[0m", stdout);
137 kill_myself_with_sig(code);
141 static void screen_read_close(void)
147 // Close & re-open vcsa in case they have swapped virtual consoles
148 vcsa_fd = xopen(G.vcsa_name, O_RDONLY);
149 xread(vcsa_fd, &G.remote, 4);
150 i = G.remote.cols * 2;
151 G.first_line_offset = G.y * i;
153 if (G.data == NULL) {
155 G.data = xzalloc(2 * i);
157 else if (G.size != i) {
160 data = G.data + G.current;
161 xread(vcsa_fd, data, G.size);
163 for (i = 0; i < G.remote.lines; i++) {
164 for (j = 0; j < G.remote.cols; j++, NEXT(data)) {
165 unsigned x = j - G.x; // if will catch j < G.x too
166 unsigned y = i - G.y; // if will catch i < G.y too
168 if (CHAR(data) < ' ')
170 if (y >= G.height || x >= G.width)
176 static void screen_char(char *data)
179 uint8_t attr = ATTR(data);
180 //uint8_t attr = ATTR(data) >> 1; // for framebuffer console
181 uint8_t attr_diff = G.last_attr ^ attr;
184 // Attribute layout for VGA compatible text videobuffer:
190 // 00000000 <- lsb bit on the right
191 // bold text / text 8th bit
195 // TODO: apparently framebuffer-based console uses different layout
196 // (bug? attempt to get 8th text bit in better position?)
201 // 00000000 <- lsb bit on the right
207 // converting RGB color bit triad to BGR:
208 static const char color[8] = "04261537";
209 const uint8_t fg_mask = 0x07, bold_mask = 0x08;
210 const uint8_t bg_mask = 0x70, blink_mask = 0x80;
213 ptr = G.attrbuf + 2; // skip "ESC ["
215 // (G.last_attr & ~attr) has 1 only where
216 // G.last_attr has 1 but attr has 0.
217 // Here we check whether we have transition
218 // bold->non-bold or blink->non-blink:
219 if (G.last_attr < 0 // initial value
220 || ((G.last_attr & ~attr) & (bold_mask | blink_mask)) != 0
222 *ptr++ = '0'; // "reset all attrs"
224 // must set fg & bg, maybe need to set bold or blink:
225 attr_diff = attr | ~(bold_mask | blink_mask);
228 if (attr_diff & bold_mask) {
232 if (attr_diff & blink_mask) {
236 if (attr_diff & fg_mask) {
238 *ptr++ = color[attr & fg_mask];
241 if (attr_diff & bg_mask) {
243 *ptr++ = color[(attr & bg_mask) >> 4];
246 if (ptr != G.attrbuf + 2) {
249 fputs(G.attrbuf, stdout);
257 static void screen_dump(void)
261 int linecnt = G.remote.lines - G.y;
262 char *data = G.data + G.current + G.first_line_offset;
265 for (line = 0; line < linecnt && line < G.height; line++) {
267 for (col = 0; col < G.remote.cols; col++, NEXT(data)) {
268 unsigned tty_col = col - G.x; // if will catch col < G.x too
270 if (tty_col >= G.width)
273 if (BW && CHAR(data) == ' ')
275 while (linefeed_cnt != 0) {
276 //bb_putchar('\r'); - tty driver does it for us
288 static void curmove(void)
290 unsigned cx = G.remote.cursor_x - G.x;
291 unsigned cy = G.remote.cursor_y - G.y;
294 if (cx < G.width && cy < G.height) {
301 static void create_cdev_if_doesnt_exist(const char* name, dev_t dev)
303 int fd = open(name, O_RDONLY);
306 else if (errno == ENOENT)
307 mknod(name, S_IFCHR | 0660, dev);
310 static NOINLINE void start_shell_in_child(const char* tty_name)
314 struct termios termchild;
315 char *shell = getenv("SHELL");
318 shell = (char *) DEFAULT_SHELL;
319 signal(SIGHUP, SIG_IGN);
320 // set tty as a controlling tty
322 // make tty to be input, output, error
324 xopen(tty_name, O_RDWR); // uses fd 0
327 ioctl(0, TIOCSCTTY, 1);
328 tcsetpgrp(0, getpid());
329 tcgetattr(0, &termchild);
330 termchild.c_lflag |= ECHO;
331 termchild.c_oflag |= ONLCR | XTABS;
332 termchild.c_iflag |= ICRNL;
333 termchild.c_iflag &= ~IXOFF;
334 tcsetattr_stdin_TCSANOW(&termchild);
335 execl(shell, shell, "-i", (char *) NULL);
336 bb_simple_perror_msg_and_die(shell);
340 int conspy_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
341 int conspy_main(int argc UNUSED_PARAM, char **argv)
343 char tty_name[sizeof("/dev/ttyNN")];
344 #define keybuf bb_common_bufsiz1
345 struct termios termbuf;
350 static const char getopt_longopts[] ALIGN1 =
351 "viewonly\0" No_argument "v"
352 "createdevice\0" No_argument "c"
353 "session\0" No_argument "s"
354 "nocolors\0" No_argument "n"
355 "dump\0" No_argument "d"
356 "follow\0" No_argument "f"
359 applet_long_options = getopt_longopts;
362 strcpy(G.vcsa_name, "/dev/vcsa");
364 opt_complementary = "x+:y+"; // numeric params
365 opts = getopt32(argv, "vcsndfx:y:", &G.x, &G.y);
369 ttynum = xatou_range(argv[0], 0, 63);
370 sprintf(G.vcsa_name + sizeof("/dev/vcsa")-1, "%u", ttynum);
372 sprintf(tty_name, "%s%u", "/dev/tty", ttynum);
373 if (opts & FLAG(c)) {
374 if ((opts & (FLAG(s)|FLAG(v))) != FLAG(v))
375 create_cdev_if_doesnt_exist(tty_name, makedev(4, ttynum));
376 create_cdev_if_doesnt_exist(G.vcsa_name, makedev(7, 128 + ttynum));
378 if ((opts & FLAG(s)) && ttynum) {
379 start_shell_in_child(tty_name);
383 if (opts & FLAG(d)) {
389 bb_signals(BB_FATAL_SIGS, cleanup);
391 // All characters must be passed through to us unaltered
392 G.kbd_fd = xopen(CURRENT_TTY, O_RDONLY);
393 tcgetattr(G.kbd_fd, &G.term_orig);
394 termbuf = G.term_orig;
395 termbuf.c_iflag &= ~(BRKINT|INLCR|ICRNL|IXON|IXOFF|IUCLC|IXANY|IMAXBEL);
396 //termbuf.c_oflag &= ~(OPOST); - no, we still want \n -> \r\n
397 termbuf.c_lflag &= ~(ISIG|ICANON|ECHO);
398 termbuf.c_cc[VMIN] = 1;
399 termbuf.c_cc[VTIME] = 0;
400 tcsetattr(G.kbd_fd, TCSANOW, &termbuf);
402 poll_timeout_ms = 250;
409 // in the first loop G.width = G.height = 0: refresh
412 get_terminal_width_height(G.kbd_fd, &G.width, &G.height);
413 if (option_mask32 & FLAG(f)) {
414 int nx = G.remote.cursor_x - G.width + 1;
415 int ny = G.remote.cursor_y - G.height + 1;
417 if (G.remote.cursor_x < G.x) {
418 G.x = G.remote.cursor_x;
419 i = 0; // force refresh
423 i = 0; // force refresh
425 if (G.remote.cursor_y < G.y) {
426 G.y = G.remote.cursor_y;
427 i = 0; // force refresh
431 i = 0; // force refresh
435 // Scan console data and redraw our tty where needed
436 old = G.data + G.current;
437 G.current = G.size - G.current;
438 data = G.data + G.current;
440 if (i != G.width || j != G.height) {
444 // For each remote line
445 old += G.first_line_offset;
446 data += G.first_line_offset;
447 for (i = G.y; i < G.remote.lines; i++) {
448 char *first = NULL; // first char which needs updating
449 char *last = last; // last char which needs updating
450 unsigned iy = i - G.y;
454 for (j = 0; j < G.remote.cols; j++, NEXT(old), NEXT(data)) {
455 unsigned jx = j - G.x; // if will catch j >= G.x too
457 if (jx < G.width && DATA(data) != DATA(old)) {
466 // Rewrite updated data on the local screen
467 for (; first <= last; NEXT(first))
474 // Wait for local user keypresses
479 switch (poll(&pfd, 1, poll_timeout_ms)) {
487 G.nokeys = G.escape_count = 0;
490 // Read the keys pressed
491 k = keybuf + G.key_count;
492 bytes_read = read(G.kbd_fd, k, sizeof(keybuf) - G.key_count);
496 // Do exit processing
497 for (i = 0; i < bytes_read; i++) {
500 else if (++G.escape_count >= 3)
504 poll_timeout_ms = 250;
506 // Insert all keys pressed into the virtual console's input
507 // buffer. Don't do this if the virtual console is in scan
508 // code mode - giving ASCII characters to a program expecting
509 // scan codes will confuse it.
510 if (!(option_mask32 & FLAG(v)) && G.escape_count == 0) {
514 G.key_count += bytes_read;
515 handle = xopen(tty_name, O_WRONLY);
516 result = ioctl(handle, KDGKBMODE, &kbd_mode);
520 if (kbd_mode != K_XLATE && kbd_mode != K_UNICODE) {
521 G.key_count = 0; // scan code mode
523 for (; G.key_count != 0; p++, G.key_count--) {
524 result = ioctl(handle, TIOCSTI, p);
526 memmove(keybuf, p, G.key_count);
529 // If there is an application on console which reacts
530 // to keypresses, we need to make our first sleep
531 // shorter to quickly redraw whatever it printed there.
532 poll_timeout_ms = 20;
535 // Close & re-open tty in case they have
536 // swapped virtual consoles
539 // We sometimes get spurious IO errors on the TTY
540 // as programs close and re-open it
543 else if (errno != EIO || ++G.ioerror_count > 4)