1 /* Generic serial interface routines
3 Copyright (C) 1992-2018 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 (!startswith (name
, "unix:") && (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 (startswith (name
, "unix:") ||
222 (stat (name
, &sb
) == 0 && (sb
.st_mode
& S_IFMT
) == S_IFSOCK
))
223 ops
= serial_interface_lookup ("local");
226 ops
= serial_interface_lookup ("hardwire");
232 return serial_open_ops_1 (ops
, open_name
);
235 /* Open up a serial for OPS, passing OPEN_NAME to the open method. */
237 static struct serial
*
238 serial_open_ops_1 (const struct serial_ops
*ops
, const char *open_name
)
242 scb
= new_serial (ops
);
244 /* `...->open (...)' would get expanded by the open(2) syscall macro. */
245 if ((*scb
->ops
->open
) (scb
, open_name
))
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
);
295 scb
->next
= scb_base
;
298 if ((ops
->fdopen
) != NULL
)
299 (*ops
->fdopen
) (scb
, fd
);
307 serial_fdopen (const int fd
)
309 return serial_fdopen_ops (fd
, NULL
);
313 do_serial_close (struct serial
*scb
, int really_close
)
315 struct serial
*tmp_scb
;
319 fputs_unfiltered ("\nEnd of log\n", serial_logfp
);
320 serial_current_type
= 0;
322 /* XXX - What if serial_logfp == gdb_stdout or gdb_stderr? */
327 /* ensure that the FD has been taken out of async mode. */
328 if (scb
->async_handler
!= NULL
)
329 serial_async (scb
, NULL
, NULL
);
332 scb
->ops
->close (scb
);
334 /* For serial_is_open. */
338 scb_base
= scb_base
->next
;
340 for (tmp_scb
= scb_base
; tmp_scb
; tmp_scb
= tmp_scb
->next
)
342 if (tmp_scb
->next
!= scb
)
345 tmp_scb
->next
= tmp_scb
->next
->next
;
353 serial_close (struct serial
*scb
)
355 do_serial_close (scb
, 1);
359 serial_un_fdopen (struct serial
*scb
)
361 do_serial_close (scb
, 0);
365 serial_is_open (struct serial
*scb
)
367 return scb
->bufp
!= NULL
;
371 serial_ref (struct serial
*scb
)
377 serial_unref (struct serial
*scb
)
380 if (scb
->refcnt
== 0)
385 serial_readchar (struct serial
*scb
, int timeout
)
389 /* FIXME: cagney/1999-10-11: Don't enable this check until the ASYNC
391 if (0 && serial_is_async_p (scb
) && timeout
< 0)
392 internal_error (__FILE__
, __LINE__
,
393 _("serial_readchar: blocking read in async mode"));
395 ch
= scb
->ops
->readchar (scb
, timeout
);
396 if (serial_logfp
!= NULL
)
398 serial_logchar (serial_logfp
, 'r', ch
, timeout
);
400 /* Make sure that the log file is as up-to-date as possible,
401 in case we are getting ready to dump core or something. */
402 gdb_flush (serial_logfp
);
404 if (serial_debug_p (scb
))
406 fprintf_unfiltered (gdb_stdlog
, "[");
407 serial_logchar (gdb_stdlog
, 'r', ch
, timeout
);
408 fprintf_unfiltered (gdb_stdlog
, "]");
409 gdb_flush (gdb_stdlog
);
416 serial_write (struct serial
*scb
, const void *buf
, size_t count
)
418 if (serial_logfp
!= NULL
)
420 const char *str
= (const char *) buf
;
423 for (c
= 0; c
< count
; c
++)
424 serial_logchar (serial_logfp
, 'w', str
[c
] & 0xff, 0);
426 /* Make sure that the log file is as up-to-date as possible,
427 in case we are getting ready to dump core or something. */
428 gdb_flush (serial_logfp
);
430 if (serial_debug_p (scb
))
432 const char *str
= (const char *) buf
;
435 for (c
= 0; c
< count
; c
++)
437 fprintf_unfiltered (gdb_stdlog
, "[");
438 serial_logchar (gdb_stdlog
, 'w', str
[c
] & 0xff, 0);
439 fprintf_unfiltered (gdb_stdlog
, "]");
441 gdb_flush (gdb_stdlog
);
444 return (scb
->ops
->write (scb
, buf
, count
));
448 serial_printf (struct serial
*desc
, const char *format
, ...)
451 va_start (args
, format
);
453 std::string buf
= string_vprintf (format
, args
);
454 serial_write (desc
, buf
.c_str (), buf
.length ());
460 serial_drain_output (struct serial
*scb
)
462 return scb
->ops
->drain_output (scb
);
466 serial_flush_output (struct serial
*scb
)
468 return scb
->ops
->flush_output (scb
);
472 serial_flush_input (struct serial
*scb
)
474 return scb
->ops
->flush_input (scb
);
478 serial_send_break (struct serial
*scb
)
480 if (serial_logfp
!= NULL
)
481 serial_logchar (serial_logfp
, 'w', SERIAL_BREAK
, 0);
483 return (scb
->ops
->send_break (scb
));
487 serial_raw (struct serial
*scb
)
489 scb
->ops
->go_raw (scb
);
493 serial_get_tty_state (struct serial
*scb
)
495 return scb
->ops
->get_tty_state (scb
);
499 serial_copy_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
501 return scb
->ops
->copy_tty_state (scb
, ttystate
);
505 serial_set_tty_state (struct serial
*scb
, serial_ttystate ttystate
)
507 return scb
->ops
->set_tty_state (scb
, ttystate
);
511 serial_print_tty_state (struct serial
*scb
,
512 serial_ttystate ttystate
,
513 struct ui_file
*stream
)
515 scb
->ops
->print_tty_state (scb
, ttystate
, stream
);
519 serial_setbaudrate (struct serial
*scb
, int rate
)
521 return scb
->ops
->setbaudrate (scb
, rate
);
525 serial_setstopbits (struct serial
*scb
, int num
)
527 return scb
->ops
->setstopbits (scb
, num
);
533 serial_setparity (struct serial
*scb
, int parity
)
535 return scb
->ops
->setparity (scb
, parity
);
539 serial_can_async_p (struct serial
*scb
)
541 return (scb
->ops
->async
!= NULL
);
545 serial_is_async_p (struct serial
*scb
)
547 return (scb
->ops
->async
!= NULL
) && (scb
->async_handler
!= NULL
);
551 serial_async (struct serial
*scb
,
552 serial_event_ftype
*handler
,
555 int changed
= ((scb
->async_handler
== NULL
) != (handler
== NULL
));
557 scb
->async_handler
= handler
;
558 scb
->async_context
= context
;
559 /* Only change mode if there is a need. */
561 scb
->ops
->async (scb
, handler
!= NULL
);
565 serial_debug (struct serial
*scb
, int debug_p
)
567 scb
->debug_p
= debug_p
;
571 serial_debug_p (struct serial
*scb
)
573 return scb
->debug_p
|| global_serial_debug_p
;
578 serial_wait_handle (struct serial
*scb
, HANDLE
*read
, HANDLE
*except
)
580 if (scb
->ops
->wait_handle
)
581 scb
->ops
->wait_handle (scb
, read
, except
);
584 *read
= (HANDLE
) _get_osfhandle (scb
->fd
);
590 serial_done_wait_handle (struct serial
*scb
)
592 if (scb
->ops
->done_wait_handle
)
593 scb
->ops
->done_wait_handle (scb
);
598 serial_pipe (struct serial
*scbs
[2])
600 const struct serial_ops
*ops
;
603 ops
= serial_interface_lookup ("pipe");
610 if (gdb_pipe (fildes
) == -1)
613 scbs
[0] = serial_fdopen_ops (fildes
[0], ops
);
614 scbs
[1] = serial_fdopen_ops (fildes
[1], ops
);
618 /* Serial set/show framework. */
620 static struct cmd_list_element
*serial_set_cmdlist
;
621 static struct cmd_list_element
*serial_show_cmdlist
;
624 serial_set_cmd (const char *args
, int from_tty
)
626 printf_unfiltered ("\"set serial\" must be followed "
627 "by the name of a command.\n");
628 help_list (serial_set_cmdlist
, "set serial ", all_commands
, gdb_stdout
);
632 serial_show_cmd (const char *args
, int from_tty
)
634 cmd_show_list (serial_show_cmdlist
, from_tty
, "");
637 /* Baud rate specified for talking to serial target systems. Default
638 is left as -1, so targets can choose their own defaults. */
639 /* FIXME: This means that "show serial baud" and gr_files_info can
640 print -1 or (unsigned int)-1. This is a Bad User Interface. */
645 serial_baud_show_cmd (struct ui_file
*file
, int from_tty
,
646 struct cmd_list_element
*c
, const char *value
)
648 fprintf_filtered (file
, _("Baud rate for remote serial I/O is %s.\n"),
652 /* Parity for serial port. */
654 int serial_parity
= GDBPARITY_NONE
;
656 static const char parity_none
[] = "none";
657 static const char parity_odd
[] = "odd";
658 static const char parity_even
[] = "even";
659 static const char *const parity_enums
[] =
660 {parity_none
, parity_odd
, parity_even
, NULL
};
661 static const char *parity
= parity_none
;
663 /* Set serial_parity value. */
666 set_parity (const char *ignore_args
, int from_tty
, struct cmd_list_element
*c
)
668 if (parity
== parity_odd
)
669 serial_parity
= GDBPARITY_ODD
;
670 else if (parity
== parity_even
)
671 serial_parity
= GDBPARITY_EVEN
;
673 serial_parity
= GDBPARITY_NONE
;
677 _initialize_serial (void)
680 add_com ("connect", class_obscure
, connect_command
, _("\
681 Connect the terminal directly up to the command monitor.\n\
682 Use <CR>~. or <CR>~^D to break out."));
685 add_prefix_cmd ("serial", class_maintenance
, serial_set_cmd
, _("\
686 Set default serial/parallel port configuration."),
687 &serial_set_cmdlist
, "set serial ",
691 add_prefix_cmd ("serial", class_maintenance
, serial_show_cmd
, _("\
692 Show default serial/parallel port configuration."),
693 &serial_show_cmdlist
, "show serial ",
697 /* If target is open when baud changes, it doesn't take effect until
698 the next open (I think, not sure). */
699 add_setshow_zinteger_cmd ("baud", no_class
, &baud_rate
, _("\
700 Set baud rate for remote serial I/O."), _("\
701 Show baud rate for remote serial I/O."), _("\
702 This value is used to set the speed of the serial port when debugging\n\
703 using remote targets."),
705 serial_baud_show_cmd
,
706 &serial_set_cmdlist
, &serial_show_cmdlist
);
708 add_setshow_enum_cmd ("parity", no_class
, parity_enums
,
710 Set parity for remote serial I/O"), _("\
711 Show parity for remote serial I/O"), NULL
,
713 NULL
, /* FIXME: i18n: */
714 &serial_set_cmdlist
, &serial_show_cmdlist
);
716 add_setshow_filename_cmd ("remotelogfile", no_class
, &serial_logfile
, _("\
717 Set filename for remote session recording."), _("\
718 Show filename for remote session recording."), _("\
719 This file is used to record the remote session for future playback\n\
722 NULL
, /* FIXME: i18n: */
723 &setlist
, &showlist
);
725 add_setshow_enum_cmd ("remotelogbase", no_class
, logbase_enums
,
726 &serial_logbase
, _("\
727 Set numerical base for remote session logging"), _("\
728 Show numerical base for remote session logging"), NULL
,
730 NULL
, /* FIXME: i18n: */
731 &setlist
, &showlist
);
733 add_setshow_zuinteger_cmd ("serial", class_maintenance
,
734 &global_serial_debug_p
, _("\
735 Set serial debugging."), _("\
736 Show serial debugging."), _("\
737 When non-zero, serial port debugging is enabled."),
739 NULL
, /* FIXME: i18n: */
740 &setdebuglist
, &showdebuglist
);
This page took 0.050363 seconds and 5 git commands to generate.