1 /* Generic serial interface routines
3 Copyright (C) 1992-2020 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 #include "cli/cli-utils.h"
26 /* Is serial being debugged? */
28 static unsigned int global_serial_debug_p
;
30 /* Serial I/O handlers. */
32 static std::vector
<const struct serial_ops
*> serial_ops_list
;
34 /* Pointer to list of scb's. */
36 static struct serial
*scb_base
;
38 /* Non-NULL gives filename which contains a recording of the remote session,
39 suitable for playback by gdbserver. */
41 static char *serial_logfile
= NULL
;
42 static struct ui_file
*serial_logfp
= NULL
;
44 static const struct serial_ops
*serial_interface_lookup (const char *);
45 static void serial_logchar (struct ui_file
*stream
,
46 int ch_type
, int ch
, int timeout
);
47 static const char logbase_hex
[] = "hex";
48 static const char logbase_octal
[] = "octal";
49 static const char logbase_ascii
[] = "ascii";
50 static const char *const logbase_enums
[] =
51 {logbase_hex
, logbase_octal
, logbase_ascii
, NULL
};
52 static const char *serial_logbase
= logbase_ascii
;
55 static int serial_current_type
= 0;
57 /* Log char CH of type CHTYPE, with TIMEOUT. */
59 /* Define bogus char to represent a BREAK. Should be careful to choose a value
60 that can't be confused with a normal char, or an error code. */
61 #define SERIAL_BREAK 1235
64 serial_logchar (struct ui_file
*stream
, int ch_type
, int ch
, int timeout
)
66 if (ch_type
!= serial_current_type
)
68 fprintf_unfiltered (stream
, "\n%c ", ch_type
);
69 serial_current_type
= ch_type
;
72 if (serial_logbase
!= logbase_ascii
)
73 fputc_unfiltered (' ', stream
);
78 fprintf_unfiltered (stream
, "<Timeout: %d seconds>", timeout
);
81 fprintf_unfiltered (stream
, "<Error: %s>", safe_strerror (errno
));
84 fputs_unfiltered ("<Eof>", stream
);
87 fputs_unfiltered ("<Break>", stream
);
90 if (serial_logbase
== logbase_hex
)
91 fprintf_unfiltered (stream
, "%02x", ch
& 0xff);
92 else if (serial_logbase
== logbase_octal
)
93 fprintf_unfiltered (stream
, "%03o", ch
& 0xff);
98 fputs_unfiltered ("\\\\", stream
);
101 fputs_unfiltered ("\\b", stream
);
104 fputs_unfiltered ("\\f", stream
);
107 fputs_unfiltered ("\\n", stream
);
110 fputs_unfiltered ("\\r", stream
);
113 fputs_unfiltered ("\\t", stream
);
116 fputs_unfiltered ("\\v", stream
);
119 fprintf_unfiltered (stream
,
120 isprint (ch
) ? "%c" : "\\x%02x", ch
& 0xFF);
127 serial_log_command (struct target_ops
*self
, const char *cmd
)
132 serial_current_type
= 'c';
134 fputs_unfiltered ("\nc ", serial_logfp
);
135 fputs_unfiltered (cmd
, serial_logfp
);
137 /* Make sure that the log file is as up-to-date as possible,
138 in case we are getting ready to dump core or something. */
139 gdb_flush (serial_logfp
);
143 static const struct serial_ops
*
144 serial_interface_lookup (const char *name
)
146 for (const serial_ops
*ops
: serial_ops_list
)
147 if (strcmp (name
, ops
->name
) == 0)
154 serial_add_interface (const struct serial_ops
*optable
)
156 serial_ops_list
.push_back (optable
);
159 /* Return the open serial device for FD, if found, or NULL if FD is
160 not already opened. */
163 serial_for_fd (int fd
)
167 for (scb
= scb_base
; scb
; scb
= scb
->next
)
174 /* Create a new serial for OPS. */
176 static struct serial
*
177 new_serial (const struct serial_ops
*ops
)
181 scb
= XCNEW (struct serial
);
185 scb
->bufp
= scb
->buf
;
192 static struct serial
*serial_open_ops_1 (const struct serial_ops
*ops
,
193 const char *open_name
);
195 /* Open up a device or a network socket, depending upon the syntax of NAME. */
198 serial_open (const char *name
)
200 const struct serial_ops
*ops
;
201 const char *open_name
= name
;
203 if (startswith (name
, "|"))
205 ops
= serial_interface_lookup ("pipe");
206 /* Discard ``|'' and any space before the command itself. */
208 open_name
= skip_spaces (open_name
);
210 /* Check for a colon, suggesting an IP address/port pair.
211 Do this *after* checking for all the interesting prefixes. We
212 don't want to constrain the syntax of what can follow them. */
213 else if (strchr (name
, ':'))
214 ops
= serial_interface_lookup ("tcp");
218 /* Check to see if name is a socket. If it is, then treat it
219 as such. Otherwise assume that it's a character device. */
221 if (stat (name
, &sb
) == 0 && (sb
.st_mode
& S_IFMT
) == S_IFSOCK
)
222 ops
= serial_interface_lookup ("local");
225 ops
= serial_interface_lookup ("hardwire");
231 return serial_open_ops_1 (ops
, open_name
);
234 /* Open up a serial for OPS, passing OPEN_NAME to the open method. */
236 static struct serial
*
237 serial_open_ops_1 (const struct serial_ops
*ops
, const char *open_name
)
241 scb
= new_serial (ops
);
243 /* `...->open (...)' would get expanded by the open(2) syscall macro. */
244 if ((*scb
->ops
->open
) (scb
, open_name
))
250 scb
->name
= open_name
!= NULL
? xstrdup (open_name
) : NULL
;
251 scb
->next
= scb_base
;
254 if (serial_logfile
!= NULL
)
256 stdio_file_up
file (new stdio_file ());
258 if (!file
->open (serial_logfile
, "w"))
259 perror_with_name (serial_logfile
);
261 serial_logfp
= file
.release ();
270 serial_open_ops (const struct serial_ops
*ops
)
272 return serial_open_ops_1 (ops
, NULL
);
275 /* Open a new serial stream using a file handle, using serial
276 interface ops OPS. */
278 static struct serial
*
279 serial_fdopen_ops (const int fd
, const struct serial_ops
*ops
)
285 ops
= serial_interface_lookup ("terminal");
287 ops
= serial_interface_lookup ("hardwire");
293 scb
= new_serial (ops
);
296 scb
->next
= scb_base
;
299 if ((ops
->fdopen
) != NULL
)
300 (*ops
->fdopen
) (scb
, fd
);
308 serial_fdopen (const int fd
)
310 return serial_fdopen_ops (fd
, NULL
);
314 do_serial_close (struct serial
*scb
, int really_close
)
316 struct serial
*tmp_scb
;
320 fputs_unfiltered ("\nEnd of log\n", serial_logfp
);
321 serial_current_type
= 0;
323 /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */
328 /* ensure that the FD has been taken out of async mode. */
329 if (scb
->async_handler
!= NULL
)
330 serial_async (scb
, NULL
, NULL
);
333 scb
->ops
->close (scb
);
337 /* For serial_is_open. */
341 scb_base
= scb_base
->next
;
343 for (tmp_scb
= scb_base
; tmp_scb
; tmp_scb
= tmp_scb
->next
)
345 if (tmp_scb
->next
!= scb
)
348 tmp_scb
->next
= tmp_scb
->next
->next
;
356 serial_close (struct serial
*scb
)
358 do_serial_close (scb
, 1);
362 serial_un_fdopen (struct serial
*scb
)
364 do_serial_close (scb
, 0);
368 serial_is_open (struct serial
*scb
)
370 return scb
->bufp
!= NULL
;
374 serial_ref (struct serial
*scb
)
380 serial_unref (struct serial
*scb
)
383 if (scb
->refcnt
== 0)
388 serial_readchar (struct serial
*scb
, int timeout
)
392 /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
394 if (0 && serial_is_async_p (scb
) && timeout
< 0)
395 internal_error (__FILE__
, __LINE__
,
396 _("serial_readchar: blocking read in async mode"));
398 ch
= scb
->ops
->readchar (scb
, timeout
);
399 if (serial_logfp
!= NULL
)
401 serial_logchar (serial_logfp
, 'r', ch
, timeout
);
403 /* Make sure that the log file is as up-to-date as possible,
404 in case we are getting ready to dump core or something. */
405 gdb_flush (serial_logfp
);
407 if (serial_debug_p (scb
))
409 fprintf_unfiltered (gdb_stdlog
, "[");
410 serial_logchar (gdb_stdlog
, 'r', ch
, timeout
);
411 fprintf_unfiltered (gdb_stdlog
, "]");
412 gdb_flush (gdb_stdlog
);
419 serial_write (struct serial
*scb
, const void *buf
, size_t count
)
421 if (serial_logfp
!= NULL
)
423 const char *str
= (const char *) buf
;
426 for (c
= 0; c
< count
; c
++)
427 serial_logchar (serial_logfp
, 'w', str
[c
] & 0xff, 0);
429 /* Make sure that the log file is as up-to-date as possible,
430 in case we are getting ready to dump core or something. */
431 gdb_flush (serial_logfp
);
433 if (serial_debug_p (scb
))
435 const char *str
= (const char *) buf
;
438 for (c
= 0; c
< count
; c
++)
440 fprintf_unfiltered (gdb_stdlog
, "[");
441 serial_logchar (gdb_stdlog
, 'w', str
[c
] & 0xff, 0);
442 fprintf_unfiltered (gdb_stdlog
, "]");
444 gdb_flush (gdb_stdlog
);
447 return (scb
->ops
->write (scb
, buf
, count
));
451 serial_printf (struct serial
*desc
, const char *format
, ...)
454 va_start (args
, format
);
456 std::string buf
= string_vprintf (format
, args
);
457 serial_write (desc
, buf
.c_str (), buf
.length ());
463 serial_drain_output (struct serial
*scb
)
465 return scb
->ops
->drain_output (scb
);
469 serial_flush_output (struct serial
*scb
)
471 return scb
->ops
->flush_output (scb
);
475 serial_flush_input (struct serial
*scb
)
477 return scb
->ops
->flush_input (scb
);
481 serial_send_break (struct serial
*scb
)
483 if (serial_logfp
!= NULL
)
484 serial_logchar (serial_logfp
, 'w', SERIAL_BREAK
, 0);
486 return (scb
->ops
->send_break (scb
));
490 serial_raw (struct serial
*scb
)
492 scb
->ops
->go_raw (scb
);
496 serial_get_tty_state (struct serial
*scb
)
498 return scb
->ops
->get_tty_state (scb
);
502 serial_copy_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
504 return scb
->ops
->copy_tty_state (scb
, ttystate
);
508 serial_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
510 return scb
->ops
->set_tty_state (scb
, ttystate
);
514 serial_print_tty_state (struct serial
*scb
,
515 serial_ttystate ttystate
,
516 struct ui_file
*stream
)
518 scb
->ops
->print_tty_state (scb
, ttystate
, stream
);
522 serial_setbaudrate (struct serial
*scb
, int rate
)
524 return scb
->ops
->setbaudrate (scb
, rate
);
528 serial_setstopbits (struct serial
*scb
, int num
)
530 return scb
->ops
->setstopbits (scb
, num
);
536 serial_setparity (struct serial
*scb
, int parity
)
538 return scb
->ops
->setparity (scb
, parity
);
542 serial_can_async_p (struct serial
*scb
)
544 return (scb
->ops
->async
!= NULL
);
548 serial_is_async_p (struct serial
*scb
)
550 return (scb
->ops
->async
!= NULL
) && (scb
->async_handler
!= NULL
);
554 serial_async (struct serial
*scb
,
555 serial_event_ftype
*handler
,
558 int changed
= ((scb
->async_handler
== NULL
) != (handler
== NULL
));
560 scb
->async_handler
= handler
;
561 scb
->async_context
= context
;
562 /* Only change mode if there is a need. */
564 scb
->ops
->async (scb
, handler
!= NULL
);
568 serial_debug (struct serial
*scb
, int debug_p
)
570 scb
->debug_p
= debug_p
;
574 serial_debug_p (struct serial
*scb
)
576 return scb
->debug_p
|| global_serial_debug_p
;
581 serial_wait_handle (struct serial
*scb
, HANDLE
*read
, HANDLE
*except
)
583 if (scb
->ops
->wait_handle
)
584 scb
->ops
->wait_handle (scb
, read
, except
);
587 *read
= (HANDLE
) _get_osfhandle (scb
->fd
);
593 serial_done_wait_handle (struct serial
*scb
)
595 if (scb
->ops
->done_wait_handle
)
596 scb
->ops
->done_wait_handle (scb
);
601 serial_pipe (struct serial
*scbs
[2])
603 const struct serial_ops
*ops
;
606 ops
= serial_interface_lookup ("pipe");
613 if (gdb_pipe (fildes
) == -1)
616 scbs
[0] = serial_fdopen_ops (fildes
[0], ops
);
617 scbs
[1] = serial_fdopen_ops (fildes
[1], ops
);
621 /* Serial set/show framework. */
623 static struct cmd_list_element
*serial_set_cmdlist
;
624 static struct cmd_list_element
*serial_show_cmdlist
;
627 serial_set_cmd (const char *args
, int from_tty
)
629 printf_unfiltered ("\"set serial\" must be followed "
630 "by the name of a command.\n");
631 help_list (serial_set_cmdlist
, "set serial ", all_commands
, gdb_stdout
);
635 serial_show_cmd (const char *args
, int from_tty
)
637 cmd_show_list (serial_show_cmdlist
, from_tty
, "");
640 /* Baud rate specified for talking to serial target systems. Default
641 is left as -1, so targets can choose their own defaults. */
642 /* FIXME: This means that "show serial baud" and gr_files_info can
643 print -1 or (unsigned int)-1. This is a Bad User Interface. */
648 serial_baud_show_cmd (struct ui_file
*file
, int from_tty
,
649 struct cmd_list_element
*c
, const char *value
)
651 fprintf_filtered (file
, _("Baud rate for remote serial I/O is %s.\n"),
655 /* Parity for serial port. */
657 int serial_parity
= GDBPARITY_NONE
;
659 static const char parity_none
[] = "none";
660 static const char parity_odd
[] = "odd";
661 static const char parity_even
[] = "even";
662 static const char *const parity_enums
[] =
663 {parity_none
, parity_odd
, parity_even
, NULL
};
664 static const char *parity
= parity_none
;
666 /* Set serial_parity value. */
669 set_parity (const char *ignore_args
, int from_tty
, struct cmd_list_element
*c
)
671 if (parity
== parity_odd
)
672 serial_parity
= GDBPARITY_ODD
;
673 else if (parity
== parity_even
)
674 serial_parity
= GDBPARITY_EVEN
;
676 serial_parity
= GDBPARITY_NONE
;
679 void _initialize_serial ();
681 _initialize_serial ()
684 add_com ("connect", class_obscure
, connect_command
, _("\
685 Connect the terminal directly up to the command monitor.\n\
686 Use <CR>~. or <CR>~^D to break out."));
689 add_prefix_cmd ("serial", class_maintenance
, serial_set_cmd
, _("\
690 Set default serial/parallel port configuration."),
691 &serial_set_cmdlist
, "set serial ",
695 add_prefix_cmd ("serial", class_maintenance
, serial_show_cmd
, _("\
696 Show default serial/parallel port configuration."),
697 &serial_show_cmdlist
, "show serial ",
701 /* If target is open when baud changes, it doesn't take effect until
702 the next open (I think, not sure). */
703 add_setshow_zinteger_cmd ("baud", no_class
, &baud_rate
, _("\
704 Set baud rate for remote serial I/O."), _("\
705 Show baud rate for remote serial I/O."), _("\
706 This value is used to set the speed of the serial port when debugging\n\
707 using remote targets."),
709 serial_baud_show_cmd
,
710 &serial_set_cmdlist
, &serial_show_cmdlist
);
712 add_setshow_enum_cmd ("parity", no_class
, parity_enums
,
714 Set parity for remote serial I/O."), _("\
715 Show parity for remote serial I/O."), NULL
,
717 NULL
, /* FIXME: i18n: */
718 &serial_set_cmdlist
, &serial_show_cmdlist
);
720 add_setshow_filename_cmd ("remotelogfile", no_class
, &serial_logfile
, _("\
721 Set filename for remote session recording."), _("\
722 Show filename for remote session recording."), _("\
723 This file is used to record the remote session for future playback\n\
726 NULL
, /* FIXME: i18n: */
727 &setlist
, &showlist
);
729 add_setshow_enum_cmd ("remotelogbase", no_class
, logbase_enums
,
730 &serial_logbase
, _("\
731 Set numerical base for remote session logging."), _("\
732 Show numerical base for remote session logging."), NULL
,
734 NULL
, /* FIXME: i18n: */
735 &setlist
, &showlist
);
737 add_setshow_zuinteger_cmd ("serial", class_maintenance
,
738 &global_serial_debug_p
, _("\
739 Set serial debugging."), _("\
740 Show serial debugging."), _("\
741 When non-zero, serial port debugging is enabled."),
743 NULL
, /* FIXME: i18n: */
744 &setdebuglist
, &showdebuglist
);