1 /* Remote debugging interface for Tandem ST2000 phone switch, for GDB.
2 Copyright 1990, 1991, 1992 Free Software Foundation, Inc.
3 Contributed by Cygnus Support. Written by Jim Kingdon for Cygnus.
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 2 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, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* This file was derived from remote-eb.c, which did a similar job, but for
23 an AMD-29K running EBMON. That file was in turn derived from remote.c
24 as mentioned in the following comment (left in for comic relief):
26 "This is like remote.c but is for an esoteric situation--
27 having an a29k board in a PC hooked up to a unix machine with
28 a serial line, and running ctty com1 on the PC, through which
29 the unix machine can run ebmon. Not to mention that the PC
30 has PC/NFS, so it can access the same executables that gdb can,
31 over the net in real time."
33 In reality, this module talks to a debug monitor called 'STDEBUG', which
34 runs in a phone switch. We communicate with STDEBUG via either a direct
35 serial line, or a TCP (or possibly TELNET) stream to a terminal multiplexor,
36 which in turn talks to the phone switch. */
43 #include "gdb_string.h"
44 #include <sys/types.h>
47 extern struct target_ops st2000_ops; /* Forward declaration */
49 static void st2000_close ();
50 static void st2000_fetch_register ();
51 static void st2000_store_register ();
53 #define LOG_FILE "st2000.log"
54 #if defined (LOG_FILE)
58 static int timeout = 24;
60 /* Descriptor for I/O to remote machine. Initialize it to -1 so that
61 st2000_open knows that we don't have a file open when the program
64 static serial_t st2000_desc;
66 /* Send data to stdebug. Works just like printf. */
69 printf_stdebug (char *pattern,...)
74 va_start (args, pattern);
76 vsprintf (buf, pattern, args);
79 if (SERIAL_WRITE (st2000_desc, buf, strlen (buf)))
80 fprintf (stderr, "SERIAL_WRITE failed: %s\n", safe_strerror (errno));
83 /* Read a character from the remote system, doing all the fancy timeout
92 c = SERIAL_READCHAR (st2000_desc, timeout);
95 putc (c & 0x7f, log_file);
101 if (c == SERIAL_TIMEOUT)
104 return c; /* Polls shouldn't generate timeout errors */
106 error ("Timeout reading from remote system.");
109 perror_with_name ("remote-st2000");
112 /* Scan input from the remote system, until STRING is found. If DISCARD is
113 non-zero, then discard non-matching input, else print it out.
114 Let the user break out immediately. */
116 expect (string, discard)
126 c = readchar (timeout);
139 fwrite (string, 1, (p - 1) - string, stdout);
148 /* Keep discarding input until we see the STDEBUG prompt.
150 The convention for dealing with the prompt is that you
152 o *then* wait for the prompt.
154 Thus the last thing that a procedure does with the serial line
155 will be an expect_prompt(). Exception: st2000_resume does not
156 wait for the prompt, because the terminal is being handed over
157 to the inferior. However, the next thing which happens after that
158 is a st2000_wait which does wait for the prompt.
159 Note that this includes abnormal exit, e.g. error(). This is
160 necessary to prevent getting into states from which we can't
163 expect_prompt (discard)
166 #if defined (LOG_FILE)
167 /* This is a convenient place to do this. The idea is to do it often
168 enough that we never lose much data if we terminate abnormally. */
171 expect ("dbug> ", discard);
174 /* Get a hex digit from the remote system & return its value.
175 If ignore_space is nonzero, ignore spaces (not newline, tab, etc). */
177 get_hex_digit (ignore_space)
183 ch = readchar (timeout);
184 if (ch >= '0' && ch <= '9')
186 else if (ch >= 'A' && ch <= 'F')
187 return ch - 'A' + 10;
188 else if (ch >= 'a' && ch <= 'f')
189 return ch - 'a' + 10;
190 else if (ch == ' ' && ignore_space)
195 error ("Invalid hex digit from remote system.");
200 /* Get a byte from stdebug and put it in *BYT. Accept any number
208 val = get_hex_digit (1) << 4;
209 val |= get_hex_digit (0);
213 /* Get N 32-bit words from remote, each preceded by a space,
214 and put them in registers starting at REGNO. */
216 get_hex_regs (n, regno)
223 for (i = 0; i < n; i++)
228 for (j = 0; j < 8; j++)
229 val = (val << 4) + get_hex_digit (j == 0);
230 supply_register (regno++, (char *) &val);
234 /* This is called not only when we first attach, but also when the
235 user types "run" after having attached. */
237 st2000_create_inferior (execfile, args, env)
245 error ("Can't pass arguments to remote STDEBUG process");
247 if (execfile == 0 || exec_bfd == 0)
248 error ("No executable file specified");
250 entry_pt = (int) bfd_get_start_address (exec_bfd);
252 /* The "process" (board) is already stopped awaiting our commands, and
253 the program is already downloaded. We just set its PC and go. */
255 clear_proceed_status ();
257 /* Tell wait_for_inferior that we've started a new process. */
258 init_wait_for_inferior ();
260 /* Set up the "saved terminal modes" of the inferior
261 based on what modes we are starting it with. */
262 target_terminal_init ();
264 /* Install inferior's terminal modes. */
265 target_terminal_inferior ();
267 /* insert_step_breakpoint (); FIXME, do we need this? */
269 proceed ((CORE_ADDR) entry_pt, TARGET_SIGNAL_DEFAULT, 0);
272 /* Open a connection to a remote debugger.
273 NAME is the filename used for communication. */
275 static int baudrate = 9600;
276 static char dev_name[100];
279 st2000_open (args, from_tty)
286 target_preopen (from_tty);
288 n = sscanf (args, " %s %d %s", dev_name, &baudrate, junk);
291 error ("Bad arguments. Usage: target st2000 <device> <speed>\n\
292 or target st2000 <host> <port>\n");
296 st2000_desc = SERIAL_OPEN (dev_name);
299 perror_with_name (dev_name);
301 SERIAL_SETBAUDRATE (st2000_desc, baudrate);
303 SERIAL_RAW (st2000_desc);
305 push_target (&st2000_ops);
307 #if defined (LOG_FILE)
308 log_file = fopen (LOG_FILE, "w");
309 if (log_file == NULL)
310 perror_with_name (LOG_FILE);
313 /* Hello? Are you there? */
314 printf_stdebug ("\003"); /* ^C wakes up dbug */
319 printf ("Remote %s connected to %s\n", target_shortname,
323 /* Close out all files and local state before this target loses control. */
326 st2000_close (quitting)
329 SERIAL_CLOSE (st2000_desc);
331 #if defined (LOG_FILE)
334 if (ferror (log_file))
335 fprintf (stderr, "Error writing log file.\n");
336 if (fclose (log_file) != 0)
337 fprintf (stderr, "Error closing log file.\n");
342 /* Terminate the open connection to the remote debugger.
343 Use this when you want to detach and do something else
346 st2000_detach (from_tty)
349 pop_target (); /* calls st2000_close to do the real work */
351 printf ("Ending remote %s debugging\n", target_shortname);
354 /* Tell the remote machine to resume. */
357 st2000_resume (pid, step, sig)
359 enum target_signal sig;
363 printf_stdebug ("ST\r");
364 /* Wait for the echo. */
369 printf_stdebug ("GO\r");
370 /* Swallow the echo. */
375 /* Wait until the remote machine stops, then return,
376 storing status in STATUS just as `wait' would. */
380 struct target_waitstatus *status;
382 int old_timeout = timeout;
384 status->kind = TARGET_WAITKIND_EXITED;
385 status->value.integer = 0;
387 timeout = 0; /* Don't time out -- user program is running. */
389 expect_prompt (0); /* Wait for prompt, outputting extraneous text */
391 status->kind = TARGET_WAITKIND_STOPPED;
392 status->value.sig = TARGET_SIGNAL_TRAP;
394 timeout = old_timeout;
399 /* Return the name of register number REGNO in the form input and output by
400 STDEBUG. Currently, REGISTER_NAMES just happens to contain exactly what
401 STDEBUG wants. Lets take advantage of that just as long as possible! */
413 for (p = REGISTER_NAME (regno); *p; p++)
420 /* Read the remote registers into the block REGS. */
423 st2000_fetch_registers ()
427 /* Yeah yeah, I know this is horribly inefficient. But it isn't done
428 very often... I'll clean it up later. */
430 for (regno = 0; regno <= PC_REGNUM; regno++)
431 st2000_fetch_register (regno);
434 /* Fetch register REGNO, or all registers if REGNO is -1.
435 Returns errno value. */
437 st2000_fetch_register (regno)
441 st2000_fetch_registers ();
444 char *name = get_reg_name (regno);
445 printf_stdebug ("DR %s\r", name);
448 get_hex_regs (1, regno);
454 /* Store the remote registers from the contents of the block REGS. */
457 st2000_store_registers ()
461 for (regno = 0; regno <= PC_REGNUM; regno++)
462 st2000_store_register (regno);
464 registers_changed ();
467 /* Store register REGNO, or all if REGNO == 0.
468 Return errno value. */
470 st2000_store_register (regno)
474 st2000_store_registers ();
477 printf_stdebug ("PR %s %x\r", get_reg_name (regno),
478 read_register (regno));
484 /* Get ready to modify the registers array. On machines which store
485 individual registers, this doesn't need to do anything. On machines
486 which store all the registers in one fell swoop, this makes sure
487 that registers contains all the registers from the program being
491 st2000_prepare_to_store ()
493 /* Do nothing, since we can store individual regs */
499 printf ("\tAttached to %s at %d baud.\n",
503 /* Copy LEN bytes of data from debugger memory at MYADDR
504 to inferior's memory at MEMADDR. Returns length moved. */
506 st2000_write_inferior_memory (memaddr, myaddr, len)
508 unsigned char *myaddr;
513 for (i = 0; i < len; i++)
515 printf_stdebug ("PM.B %x %x\r", memaddr + i, myaddr[i]);
521 /* Read LEN bytes from inferior memory at MEMADDR. Put the result
522 at debugger address MYADDR. Returns length moved. */
524 st2000_read_inferior_memory (memaddr, myaddr, len)
531 /* Number of bytes read so far. */
534 /* Starting address of this pass. */
535 unsigned long startaddr;
537 /* Number of bytes to read in this pass. */
540 /* Note that this code works correctly if startaddr is just less
541 than UINT_MAX (well, really CORE_ADDR_MAX if there was such a
542 thing). That is, something like
543 st2000_read_bytes (CORE_ADDR_MAX - 4, foo, 4)
544 works--it never adds len to memaddr and gets 0. */
545 /* However, something like
546 st2000_read_bytes (CORE_ADDR_MAX - 3, foo, 4)
547 doesn't need to work. Detect it and give up if there's an attempt
549 if (((memaddr - 1) + len) < memaddr)
560 if ((startaddr % 16) != 0)
561 len_this_pass -= startaddr % 16;
562 if (len_this_pass > (len - count))
563 len_this_pass = (len - count);
565 printf_stdebug ("DI.L %x %x\r", startaddr, len_this_pass);
568 for (i = 0; i < len_this_pass; i++)
569 get_hex_byte (&myaddr[count++]);
573 startaddr += len_this_pass;
578 /* FIXME-someday! Merge these two. */
580 st2000_xfer_inferior_memory (memaddr, myaddr, len, write, target)
585 struct target_ops *target; /* ignored */
588 return st2000_write_inferior_memory (memaddr, myaddr, len);
590 return st2000_read_inferior_memory (memaddr, myaddr, len);
594 st2000_kill (args, from_tty)
598 return; /* Ignore attempts to kill target system */
601 /* Clean up when a program exits.
603 The program actually lives on in the remote processor's RAM, and may be
604 run again without a download. Don't leave it full of breakpoint
608 st2000_mourn_inferior ()
610 remove_breakpoints ();
611 unpush_target (&st2000_ops);
612 generic_mourn_inferior (); /* Do all the proper things now */
615 #define MAX_STDEBUG_BREAKPOINTS 16
617 static CORE_ADDR breakaddr[MAX_STDEBUG_BREAKPOINTS] =
621 st2000_insert_breakpoint (addr, shadow)
626 CORE_ADDR bp_addr = addr;
629 BREAKPOINT_FROM_PC (&bp_addr, &bp_size);
631 for (i = 0; i <= MAX_STDEBUG_BREAKPOINTS; i++)
632 if (breakaddr[i] == 0)
636 st2000_read_inferior_memory (bp_addr, shadow, bp_size);
637 printf_stdebug ("BR %x H\r", addr);
642 fprintf (stderr, "Too many breakpoints (> 16) for STDBUG\n");
647 st2000_remove_breakpoint (addr, shadow)
653 for (i = 0; i < MAX_STDEBUG_BREAKPOINTS; i++)
654 if (breakaddr[i] == addr)
658 printf_stdebug ("CB %d\r", i);
663 fprintf (stderr, "Can't find breakpoint associated with 0x%x\n", addr);
668 /* Put a command string, in args, out to STDBUG. Output from STDBUG is placed
669 on the users terminal until the prompt is seen. */
672 st2000_command (args, fromtty)
677 error ("st2000 target not open.");
680 error ("Missing command.");
682 printf_stdebug ("%s\r", args);
686 /* Connect the user directly to STDBUG. This command acts just like the
687 'cu' or 'tip' command. Use <CR>~. or <CR>~^D to break out. */
689 /*static struct ttystate ttystate; */
694 printf ("\r\n[Exiting connect mode]\r\n");
695 /* SERIAL_RESTORE(0, &ttystate); */
699 /* This all should now be in serial.c */
702 connect_command (args, fromtty)
714 error ("st2000 target not open.");
717 fprintf ("This command takes no args. They have been ignored.\n");
719 printf ("[Entering connect mode. Use ~. or ~^D to escape]\n");
721 serial_raw (0, &ttystate);
723 make_cleanup (cleanup_tty, 0);
731 FD_SET (0, &readfds);
732 FD_SET (DEPRECATED_SERIAL_FD (st2000_desc), &readfds);
733 numfds = select (sizeof (readfds) * 8, &readfds, 0, 0, 0);
738 perror_with_name ("select");
740 if (FD_ISSET (0, &readfds))
741 { /* tty input, send to stdebug */
744 perror_with_name ("connect");
746 printf_stdebug ("%c", c);
760 if (c == '.' || c == '\004')
767 if (FD_ISSET (DEPRECATED_SERIAL_FD (st2000_desc), &readfds))
782 /* Define the target subroutine names */
784 struct target_ops st2000_ops;
787 init_st2000_ops (void)
789 st2000_ops.to_shortname = "st2000";
790 st2000_ops.to_longname = "Remote serial Tandem ST2000 target";
791 st2000_ops.to_doc = "Use a remote computer running STDEBUG connected by a serial line;\n\
792 or a network connection.\n\
793 Arguments are the name of the device for the serial line,\n\
794 the speed to connect at in bits per second.";
795 st2000_ops.to_open = st2000_open;
796 st2000_ops.to_close = st2000_close;
797 st2000_ops.to_attach = 0;
798 st2000_run_ops.to_post_attach = NULL;
799 st2000_ops.to_require_attach = NULL;
800 st2000_ops.to_detach = st2000_detach;
801 st2000_ops.to_require_detach = NULL;
802 st2000_ops.to_resume = st2000_resume;
803 st2000_ops.to_wait = st2000_wait;
804 st2000_ops.to_post_wait = NULL;
805 st2000_ops.to_fetch_registers = st2000_fetch_register;
806 st2000_ops.to_store_registers = st2000_store_register;
807 st2000_ops.to_prepare_to_store = st2000_prepare_to_store;
808 st2000_ops.to_xfer_memory = st2000_xfer_inferior_memory;
809 st2000_ops.to_files_info = st2000_files_info;
810 st2000_ops.to_insert_breakpoint = st2000_insert_breakpoint;
811 st2000_ops.to_remove_breakpoint = st2000_remove_breakpoint; /* Breakpoints */
812 st2000_ops.to_terminal_init = 0;
813 st2000_ops.to_terminal_inferior = 0;
814 st2000_ops.to_terminal_ours_for_output = 0;
815 st2000_ops.to_terminal_ours = 0;
816 st2000_ops.to_terminal_info = 0; /* Terminal handling */
817 st2000_ops.to_kill = st2000_kill;
818 st2000_ops.to_load = 0; /* load */
819 st2000_ops.to_lookup_symbol = 0; /* lookup_symbol */
820 st2000_ops.to_create_inferior = st2000_create_inferior;
821 st2000_ops.to_post_startup_inferior = NULL;
822 st2000_ops.to_acknowledge_created_inferior = NULL;
823 st2000_ops.to_clone_and_follow_inferior = NULL;
824 st2000_ops.to_post_follow_inferior_by_clone = NULL;
825 st2000_run_ops.to_insert_fork_catchpoint = NULL;
826 st2000_run_ops.to_remove_fork_catchpoint = NULL;
827 st2000_run_ops.to_insert_vfork_catchpoint = NULL;
828 st2000_run_ops.to_remove_vfork_catchpoint = NULL;
829 st2000_ops.to_has_forked = NULL;
830 st2000_ops.to_has_vforked = NULL;
831 st2000_run_ops.to_can_follow_vfork_prior_to_exec = NULL;
832 st2000_ops.to_post_follow_vfork = NULL;
833 st2000_run_ops.to_insert_exec_catchpoint = NULL;
834 st2000_run_ops.to_remove_exec_catchpoint = NULL;
835 st2000_run_ops.to_has_execd = NULL;
836 st2000_run_ops.to_reported_exec_events_per_exec_call = NULL;
837 st2000_run_ops.to_has_exited = NULL;
838 st2000_ops.to_mourn_inferior = st2000_mourn_inferior;
839 st2000_ops.to_can_run = 0; /* can_run */
840 st2000_ops.to_notice_signals = 0; /* notice_signals */
841 st2000_ops.to_thread_alive = 0; /* thread alive */
842 st2000_ops.to_stop = 0; /* to_stop */
843 st2000_ops.to_pid_to_exec_file = NULL;
844 st2000_run_ops.to_core_file_to_sym_file = NULL;
845 st2000_ops.to_stratum = process_stratum;
846 st2000_ops.DONT_USE = 0; /* next */
847 st2000_ops.to_has_all_memory = 1;
848 st2000_ops.to_has_memory = 1;
849 st2000_ops.to_has_stack = 1;
850 st2000_ops.to_has_registers = 1;
851 st2000_ops.to_has_execution = 1; /* all mem, mem, stack, regs, exec */
852 st2000_ops.to_sections = 0;
853 st2000_ops.to_sections_end = 0; /* Section pointers */
854 st2000_ops.to_magic = OPS_MAGIC; /* Always the last thing */
858 _initialize_remote_st2000 ()
861 add_target (&st2000_ops);
862 add_com ("st2000 <command>", class_obscure, st2000_command,
863 "Send a command to the STDBUG monitor.");
864 add_com ("connect", class_obscure, connect_command,
865 "Connect the terminal directly up to the STDBUG command monitor.\n\
866 Use <CR>~. or <CR>~^D to break out.");