1 /* Support for connecting Guile's stdio to GDB's.
2 as well as r/w memory via ports.
4 Copyright (C) 2014-2017 Free Software Foundation, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 /* See README file in this directory for implementation notes, coding
22 conventions, et.al. */
25 #include "gdb_select.h"
28 #include "guile-internal.h"
31 #if defined (HAVE_POLL_H)
33 #elif defined (HAVE_SYS_POLL_H)
38 /* A ui-file for sending output to Guile. */
40 class ioscm_file_port
: public ui_file
43 /* Return a ui_file that writes to PORT. */
44 explicit ioscm_file_port (SCM port
);
46 void flush () override
;
47 void write (const char *buf
, long length_buf
) override
;
53 /* Data for a memory port. */
57 /* Bounds of memory range this port is allowed to access: [start, end).
58 This means that 0xff..ff is not accessible. I can live with that. */
61 /* (end - start), recorded for convenience. */
64 /* Think of this as the lseek value maintained by the kernel.
65 This value is always in the range [0, size]. */
68 /* The size of the internal r/w buffers.
69 Scheme ports aren't a straightforward mapping to memory r/w.
70 Generally the user specifies how much to r/w and all access is
71 unbuffered. We don't try to provide equivalent access, but we allow
72 the user to specify these values to help get something similar. */
73 unsigned read_buf_size
, write_buf_size
;
76 /* Copies of the original system input/output/error ports.
77 These are recorded for debugging purposes. */
78 static SCM orig_input_port_scm
;
79 static SCM orig_output_port_scm
;
80 static SCM orig_error_port_scm
;
82 /* This is the stdio port descriptor, scm_ptob_descriptor. */
83 static scm_t_bits stdio_port_desc
;
85 /* Note: scm_make_port_type takes a char * instead of a const char *. */
86 static /*const*/ char stdio_port_desc_name
[] = "gdb:stdio-port";
88 /* Names of each gdb port. */
89 static const char input_port_name
[] = "gdb:stdin";
90 static const char output_port_name
[] = "gdb:stdout";
91 static const char error_port_name
[] = "gdb:stderr";
93 /* This is the actual port used from Guile.
94 We don't expose these to the user though, to ensure they're not
96 static SCM input_port_scm
;
97 static SCM output_port_scm
;
98 static SCM error_port_scm
;
100 /* Magic number to identify port ui-files.
101 Actually, the address of this variable is the magic number. */
102 static int file_port_magic
;
104 /* Internal enum for specifying output port. */
105 enum oport
{ GDB_STDOUT
, GDB_STDERR
};
107 /* This is the memory port descriptor, scm_ptob_descriptor. */
108 static scm_t_bits memory_port_desc
;
110 /* Note: scm_make_port_type takes a char * instead of a const char *. */
111 static /*const*/ char memory_port_desc_name
[] = "gdb:memory-port";
113 /* The default amount of memory to fetch for each read/write request.
114 Scheme ports don't provide a way to specify the size of a read,
115 which is important to us to minimize the number of inferior interactions,
116 which over a remote link can be important. To compensate we augment the
117 port API with a new function that let's the user specify how much the next
118 read request should fetch. This is the initial value for each new port. */
119 static const unsigned default_read_buf_size
= 16;
120 static const unsigned default_write_buf_size
= 16;
122 /* Arbitrarily limit memory port buffers to 1 byte to 4K. */
123 static const unsigned min_memory_port_buf_size
= 1;
124 static const unsigned max_memory_port_buf_size
= 4096;
126 /* "out of range" error message for buf sizes. */
127 static char *out_of_range_buf_size
;
129 /* Keywords used by open-memory. */
130 static SCM mode_keyword
;
131 static SCM start_keyword
;
132 static SCM size_keyword
;
134 /* Helper to do the low level work of opening a port.
135 Newer versions of Guile (2.1.x) have scm_c_make_port. */
138 ioscm_open_port (scm_t_bits port_type
, long mode_bits
)
142 #if 0 /* TODO: Guile doesn't export this. What to do? */
143 scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex
);
146 port
= scm_new_port_table_entry (port_type
);
148 SCM_SET_CELL_TYPE (port
, port_type
| mode_bits
);
150 #if 0 /* TODO: Guile doesn't export this. What to do? */
151 scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex
);
157 /* Support for connecting Guile's stdio ports to GDB's stdio ports. */
159 /* The scm_t_ptob_descriptor.input_waiting "method".
160 Return a lower bound on the number of bytes available for input. */
163 ioscm_input_waiting (SCM port
)
167 if (! scm_is_eq (port
, input_port_scm
))
172 /* This is copied from libguile/fports.c. */
173 struct pollfd pollfd
= { fdes
, POLLIN
, 0 };
174 static int use_poll
= -1;
178 /* This is copied from event-loop.c: poll cannot be used for stdin on
179 m68k-motorola-sysv. */
180 struct pollfd test_pollfd
= { fdes
, POLLIN
, 0 };
182 if (poll (&test_pollfd
, 1, 0) == 1 && (test_pollfd
.revents
& POLLNVAL
))
190 /* Guile doesn't export SIGINT hooks like Python does.
191 For now pass EINTR to scm_syserror, that's what fports.c does. */
192 if (poll (&pollfd
, 1, 0) < 0)
193 scm_syserror (FUNC_NAME
);
195 return pollfd
.revents
& POLLIN
? 1 : 0;
202 struct timeval timeout
;
204 int num_fds
= fdes
+ 1;
207 memset (&timeout
, 0, sizeof (timeout
));
208 FD_ZERO (&input_fds
);
209 FD_SET (fdes
, &input_fds
);
211 num_found
= interruptible_select (num_fds
,
212 &input_fds
, NULL
, NULL
,
216 /* Guile doesn't export SIGINT hooks like Python does.
217 For now pass EINTR to scm_syserror, that's what fports.c does. */
218 scm_syserror (FUNC_NAME
);
220 return num_found
> 0 && FD_ISSET (fdes
, &input_fds
);
224 /* The scm_t_ptob_descriptor.fill_input "method". */
227 ioscm_fill_input (SCM port
)
229 /* Borrowed from libguile/fports.c. */
231 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
233 /* If we're called on stdout,stderr, punt. */
234 if (! scm_is_eq (port
, input_port_scm
))
235 return (scm_t_wchar
) EOF
; /* Set errno and return -1? */
237 gdb_flush (gdb_stdout
);
238 gdb_flush (gdb_stderr
);
240 count
= ui_file_read (gdb_stdin
, (char *) pt
->read_buf
, pt
->read_buf_size
);
242 scm_syserror (FUNC_NAME
);
244 return (scm_t_wchar
) EOF
;
246 pt
->read_pos
= pt
->read_buf
;
247 pt
->read_end
= pt
->read_buf
+ count
;
248 return *pt
->read_buf
;
251 /* Like fputstrn_filtered, but don't escape characters, except nul.
252 Also like fputs_filtered, but a length is specified. */
255 fputsn_filtered (const char *s
, size_t size
, struct ui_file
*stream
)
259 for (i
= 0; i
< size
; ++i
)
262 fputs_filtered ("\\000", stream
);
264 fputc_filtered (s
[i
], stream
);
268 /* Write to gdb's stdout or stderr. */
271 ioscm_write (SCM port
, const void *data
, size_t size
)
274 /* If we're called on stdin, punt. */
275 if (scm_is_eq (port
, input_port_scm
))
280 if (scm_is_eq (port
, error_port_scm
))
281 fputsn_filtered ((const char *) data
, size
, gdb_stderr
);
283 fputsn_filtered ((const char *) data
, size
, gdb_stdout
);
285 CATCH (except
, RETURN_MASK_ALL
)
287 GDBSCM_HANDLE_GDB_EXCEPTION (except
);
292 /* Flush gdb's stdout or stderr. */
295 ioscm_flush (SCM port
)
297 /* If we're called on stdin, punt. */
298 if (scm_is_eq (port
, input_port_scm
))
301 if (scm_is_eq (port
, error_port_scm
))
302 gdb_flush (gdb_stderr
);
304 gdb_flush (gdb_stdout
);
307 /* Initialize the gdb stdio port type.
309 N.B. isatty? will fail on these ports, it is only supported for file
310 ports. IWBN if we could "subclass" file ports. */
313 ioscm_init_gdb_stdio_port (void)
315 stdio_port_desc
= scm_make_port_type (stdio_port_desc_name
,
316 ioscm_fill_input
, ioscm_write
);
318 scm_set_port_input_waiting (stdio_port_desc
, ioscm_input_waiting
);
319 scm_set_port_flush (stdio_port_desc
, ioscm_flush
);
322 /* Subroutine of ioscm_make_gdb_stdio_port to simplify it.
323 Set up the buffers of port PORT.
324 MODE_BITS are the mode bits of PORT. */
327 ioscm_init_stdio_buffers (SCM port
, long mode_bits
)
329 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
330 #define GDB_STDIO_BUFFER_DEFAULT_SIZE 1024
331 int size
= mode_bits
& SCM_BUF0
? 0 : GDB_STDIO_BUFFER_DEFAULT_SIZE
;
332 int writing
= (mode_bits
& SCM_WRTNG
) != 0;
334 /* This is heavily copied from scm_fport_buffer_add. */
336 if (!writing
&& size
> 0)
339 = (unsigned char *) scm_gc_malloc_pointerless (size
, "port buffer");
340 pt
->read_pos
= pt
->read_end
= pt
->read_buf
;
341 pt
->read_buf_size
= size
;
345 pt
->read_pos
= pt
->read_buf
= pt
->read_end
= &pt
->shortbuf
;
346 pt
->read_buf_size
= 1;
349 if (writing
&& size
> 0)
352 = (unsigned char *) scm_gc_malloc_pointerless (size
, "port buffer");
353 pt
->write_pos
= pt
->write_buf
;
354 pt
->write_buf_size
= size
;
358 pt
->write_buf
= pt
->write_pos
= &pt
->shortbuf
;
359 pt
->write_buf_size
= 1;
361 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
364 /* Create a gdb stdio port. */
367 ioscm_make_gdb_stdio_port (int fd
)
369 int is_a_tty
= isatty (fd
);
371 const char *mode_str
;
378 name
= input_port_name
;
379 mode_str
= is_a_tty
? "r0" : "r";
382 name
= output_port_name
;
383 mode_str
= is_a_tty
? "w0" : "w";
386 name
= error_port_name
;
387 mode_str
= is_a_tty
? "w0" : "w";
390 gdb_assert_not_reached ("bad stdio file descriptor");
393 mode_bits
= scm_mode_bits ((char *) mode_str
);
394 port
= ioscm_open_port (stdio_port_desc
, mode_bits
);
396 scm_set_port_filename_x (port
, gdbscm_scm_from_c_string (name
));
398 ioscm_init_stdio_buffers (port
, mode_bits
);
403 /* (stdio-port? object) -> boolean */
406 gdbscm_stdio_port_p (SCM scm
)
408 /* This is copied from SCM_FPORTP. */
409 return scm_from_bool (!SCM_IMP (scm
)
410 && (SCM_TYP16 (scm
) == stdio_port_desc
));
413 /* GDB's ports are accessed via functions to keep them read-only. */
415 /* (input-port) -> port */
418 gdbscm_input_port (void)
420 return input_port_scm
;
423 /* (output-port) -> port */
426 gdbscm_output_port (void)
428 return output_port_scm
;
431 /* (error-port) -> port */
434 gdbscm_error_port (void)
436 return error_port_scm
;
439 /* Support for sending GDB I/O to Guile ports. */
441 ioscm_file_port::ioscm_file_port (SCM port
)
446 ioscm_file_port::flush ()
451 ioscm_file_port::write (const char *buffer
, long length_buffer
)
453 scm_c_write (m_port
, buffer
, length_buffer
);
457 /* Helper routine for with-{output,error}-to-port. */
460 ioscm_with_output_to_port_worker (SCM port
, SCM thunk
, enum oport oport
,
461 const char *func_name
)
463 struct cleanup
*cleanups
;
466 SCM_ASSERT_TYPE (gdbscm_is_true (scm_output_port_p (port
)), port
,
467 SCM_ARG1
, func_name
, _("output port"));
468 SCM_ASSERT_TYPE (gdbscm_is_true (scm_thunk_p (thunk
)), thunk
,
469 SCM_ARG2
, func_name
, _("thunk"));
471 cleanups
= set_batch_flag_and_make_cleanup_restore_page_info ();
473 scoped_restore restore_async
= make_scoped_restore (¤t_ui
->async
, 0);
475 ui_file_up
port_file (new ioscm_file_port (port
));
477 scoped_restore save_file
= make_scoped_restore (oport
== GDB_STDERR
478 ? &gdb_stderr
: &gdb_stdout
);
480 if (oport
== GDB_STDERR
)
481 gdb_stderr
= port_file
.get ();
484 current_uiout
->redirect (port_file
.get ());
485 make_cleanup_ui_out_redirect_pop (current_uiout
);
487 gdb_stdout
= port_file
.get ();
490 result
= gdbscm_safe_call_0 (thunk
, NULL
);
492 do_cleanups (cleanups
);
494 if (gdbscm_is_exception (result
))
495 gdbscm_throw (result
);
500 /* (%with-gdb-output-to-port port thunk) -> object
501 This function is experimental.
502 IWBN to not include "gdb" in the name, but it would collide with a standard
503 procedure, and it's common to import the gdb module without a prefix.
504 There are ways around this, but they're more cumbersome.
506 This has % in the name because it's experimental, and we want the
507 user-visible version to come from module (gdb experimental). */
510 gdbscm_percent_with_gdb_output_to_port (SCM port
, SCM thunk
)
512 return ioscm_with_output_to_port_worker (port
, thunk
, GDB_STDOUT
, FUNC_NAME
);
515 /* (%with-gdb-error-to-port port thunk) -> object
516 This function is experimental.
517 IWBN to not include "gdb" in the name, but it would collide with a standard
518 procedure, and it's common to import the gdb module without a prefix.
519 There are ways around this, but they're more cumbersome.
521 This has % in the name because it's experimental, and we want the
522 user-visible version to come from module (gdb experimental). */
525 gdbscm_percent_with_gdb_error_to_port (SCM port
, SCM thunk
)
527 return ioscm_with_output_to_port_worker (port
, thunk
, GDB_STDERR
, FUNC_NAME
);
530 /* Support for r/w memory via ports. */
532 /* Perform an "lseek" to OFFSET,WHENCE on memory port IOMEM.
533 OFFSET must be in the range [0,size].
534 The result is non-zero for success, zero for failure. */
537 ioscm_lseek_address (ioscm_memory_port
*iomem
, LONGEST offset
, int whence
)
539 CORE_ADDR new_current
;
541 gdb_assert (iomem
->current
<= iomem
->size
);
546 /* Catch over/underflow. */
547 if ((offset
< 0 && iomem
->current
+ offset
> iomem
->current
)
548 || (offset
> 0 && iomem
->current
+ offset
< iomem
->current
))
550 new_current
= iomem
->current
+ offset
;
553 new_current
= offset
;
558 new_current
= iomem
->size
;
561 /* TODO: Not supported yet. */
567 if (new_current
> iomem
->size
)
569 iomem
->current
= new_current
;
573 /* "fill_input" method for memory ports. */
576 gdbscm_memory_port_fill_input (SCM port
)
578 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
579 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
582 /* "current" is the offset of the first byte we want to read. */
583 gdb_assert (iomem
->current
<= iomem
->size
);
584 if (iomem
->current
== iomem
->size
)
587 /* Don't read outside the allowed memory range. */
588 to_read
= pt
->read_buf_size
;
589 if (to_read
> iomem
->size
- iomem
->current
)
590 to_read
= iomem
->size
- iomem
->current
;
592 if (target_read_memory (iomem
->start
+ iomem
->current
, pt
->read_buf
,
594 gdbscm_memory_error (FUNC_NAME
, _("error reading memory"), SCM_EOL
);
596 iomem
->current
+= to_read
;
597 pt
->read_pos
= pt
->read_buf
;
598 pt
->read_end
= pt
->read_buf
+ to_read
;
599 return *pt
->read_buf
;
602 /* "end_input" method for memory ports.
603 Clear the read buffer and adjust the file position for unread bytes. */
606 gdbscm_memory_port_end_input (SCM port
, int offset
)
608 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
609 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
610 size_t remaining
= pt
->read_end
- pt
->read_pos
;
612 /* Note: Use of "int offset" is specified by Guile ports API. */
613 if ((offset
< 0 && remaining
+ offset
> remaining
)
614 || (offset
> 0 && remaining
+ offset
< remaining
))
616 gdbscm_out_of_range_error (FUNC_NAME
, 0, scm_from_int (offset
),
617 _("overflow in offset calculation"));
623 pt
->read_pos
= pt
->read_end
;
624 /* Throw error if unread-char used at beginning of file
625 then attempting to write. Seems correct. */
626 if (!ioscm_lseek_address (iomem
, -offset
, SEEK_CUR
))
628 gdbscm_out_of_range_error (FUNC_NAME
, 0, scm_from_int (offset
),
633 pt
->rw_active
= SCM_PORT_NEITHER
;
636 /* "flush" method for memory ports. */
639 gdbscm_memory_port_flush (SCM port
)
641 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
642 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
643 size_t to_write
= pt
->write_pos
- pt
->write_buf
;
648 /* There's no way to indicate a short write, so if the request goes past
649 the end of the port's memory range, flag an error. */
650 if (to_write
> iomem
->size
- iomem
->current
)
652 gdbscm_out_of_range_error (FUNC_NAME
, 0,
653 gdbscm_scm_from_ulongest (to_write
),
654 _("writing beyond end of memory range"));
657 if (target_write_memory (iomem
->start
+ iomem
->current
, pt
->write_buf
,
659 gdbscm_memory_error (FUNC_NAME
, _("error writing memory"), SCM_EOL
);
661 iomem
->current
+= to_write
;
662 pt
->write_pos
= pt
->write_buf
;
663 pt
->rw_active
= SCM_PORT_NEITHER
;
666 /* "write" method for memory ports. */
669 gdbscm_memory_port_write (SCM port
, const void *void_data
, size_t size
)
671 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
672 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
673 const gdb_byte
*data
= (const gdb_byte
*) void_data
;
675 /* There's no way to indicate a short write, so if the request goes past
676 the end of the port's memory range, flag an error. */
677 if (size
> iomem
->size
- iomem
->current
)
679 gdbscm_out_of_range_error (FUNC_NAME
, 0, gdbscm_scm_from_ulongest (size
),
680 _("writing beyond end of memory range"));
683 if (pt
->write_buf
== &pt
->shortbuf
)
685 /* Unbuffered port. */
686 if (target_write_memory (iomem
->start
+ iomem
->current
, data
, size
) != 0)
687 gdbscm_memory_error (FUNC_NAME
, _("error writing memory"), SCM_EOL
);
688 iomem
->current
+= size
;
692 /* Note: The edge case of what to do when the buffer exactly fills is
693 debatable. Guile flushes when the buffer exactly fills up, so we
694 do too. It's counter-intuitive to my mind, but in case there's a
695 subtlety somewhere that depends on this, we do the same. */
698 size_t space
= pt
->write_end
- pt
->write_pos
;
702 /* Data fits in buffer, and does not fill it. */
703 memcpy (pt
->write_pos
, data
, size
);
704 pt
->write_pos
+= size
;
708 memcpy (pt
->write_pos
, data
, space
);
709 pt
->write_pos
= pt
->write_end
;
710 gdbscm_memory_port_flush (port
);
712 const gdb_byte
*ptr
= data
+ space
;
713 size_t remaining
= size
- space
;
715 if (remaining
>= pt
->write_buf_size
)
717 if (target_write_memory (iomem
->start
+ iomem
->current
, ptr
,
719 gdbscm_memory_error (FUNC_NAME
, _("error writing memory"),
721 iomem
->current
+= remaining
;
725 memcpy (pt
->write_pos
, ptr
, remaining
);
726 pt
->write_pos
+= remaining
;
733 /* "seek" method for memory ports. */
736 gdbscm_memory_port_seek (SCM port
, scm_t_off offset
, int whence
)
738 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
739 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
743 if (pt
->rw_active
== SCM_PORT_WRITE
)
745 if (offset
!= 0 || whence
!= SEEK_CUR
)
747 gdbscm_memory_port_flush (port
);
748 rc
= ioscm_lseek_address (iomem
, offset
, whence
);
749 result
= iomem
->current
;
753 /* Read current position without disturbing the buffer,
754 but flag an error if what's in the buffer goes outside the
756 CORE_ADDR current
= iomem
->current
;
757 size_t delta
= pt
->write_pos
- pt
->write_buf
;
759 if (current
+ delta
< current
760 || current
+ delta
> iomem
->size
)
764 result
= current
+ delta
;
769 else if (pt
->rw_active
== SCM_PORT_READ
)
771 if (offset
!= 0 || whence
!= SEEK_CUR
)
773 scm_end_input (port
);
774 rc
= ioscm_lseek_address (iomem
, offset
, whence
);
775 result
= iomem
->current
;
779 /* Read current position without disturbing the buffer
780 (particularly the unread-char buffer). */
781 CORE_ADDR current
= iomem
->current
;
782 size_t remaining
= pt
->read_end
- pt
->read_pos
;
784 if (current
- remaining
> current
785 || current
- remaining
< iomem
->start
)
789 result
= current
- remaining
;
793 if (rc
!= 0 && pt
->read_buf
== pt
->putback_buf
)
795 size_t saved_remaining
= pt
->saved_read_end
- pt
->saved_read_pos
;
797 if (result
- saved_remaining
> result
798 || result
- saved_remaining
< iomem
->start
)
801 result
-= saved_remaining
;
805 else /* SCM_PORT_NEITHER */
807 rc
= ioscm_lseek_address (iomem
, offset
, whence
);
808 result
= iomem
->current
;
813 gdbscm_out_of_range_error (FUNC_NAME
, 0,
814 gdbscm_scm_from_longest (offset
),
818 /* TODO: The Guile API doesn't support 32x64. We can't fix that here,
819 and there's no need to throw an error if the new address can't be
820 represented in a scm_t_off. But we could return something less
825 /* "close" method for memory ports. */
828 gdbscm_memory_port_close (SCM port
)
830 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
831 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
833 gdbscm_memory_port_flush (port
);
835 if (pt
->read_buf
== pt
->putback_buf
)
836 pt
->read_buf
= pt
->saved_read_buf
;
837 if (pt
->read_buf
!= &pt
->shortbuf
)
838 xfree (pt
->read_buf
);
839 if (pt
->write_buf
!= &pt
->shortbuf
)
840 xfree (pt
->write_buf
);
841 scm_gc_free (iomem
, sizeof (*iomem
), "memory port");
846 /* "free" method for memory ports. */
849 gdbscm_memory_port_free (SCM port
)
851 gdbscm_memory_port_close (port
);
856 /* "print" method for memory ports. */
859 gdbscm_memory_port_print (SCM exp
, SCM port
, scm_print_state
*pstate
)
861 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (exp
);
862 char *type
= SCM_PTOBNAME (SCM_PTOBNUM (exp
));
864 scm_puts ("#<", port
);
865 scm_print_port_mode (exp
, port
);
866 /* scm_print_port_mode includes a trailing space. */
867 gdbscm_printf (port
, "%s %s-%s", type
,
868 hex_string (iomem
->start
), hex_string (iomem
->end
));
869 scm_putc ('>', port
);
873 /* Create the port type used for memory. */
876 ioscm_init_memory_port_type (void)
878 memory_port_desc
= scm_make_port_type (memory_port_desc_name
,
879 gdbscm_memory_port_fill_input
,
880 gdbscm_memory_port_write
);
882 scm_set_port_end_input (memory_port_desc
, gdbscm_memory_port_end_input
);
883 scm_set_port_flush (memory_port_desc
, gdbscm_memory_port_flush
);
884 scm_set_port_seek (memory_port_desc
, gdbscm_memory_port_seek
);
885 scm_set_port_close (memory_port_desc
, gdbscm_memory_port_close
);
886 scm_set_port_free (memory_port_desc
, gdbscm_memory_port_free
);
887 scm_set_port_print (memory_port_desc
, gdbscm_memory_port_print
);
890 /* Helper for gdbscm_open_memory to parse the mode bits.
891 An exception is thrown if MODE is invalid. */
894 ioscm_parse_mode_bits (const char *func_name
, const char *mode
)
899 if (*mode
!= 'r' && *mode
!= 'w')
901 gdbscm_out_of_range_error (func_name
, 0,
902 gdbscm_scm_from_c_string (mode
),
903 _("bad mode string"));
905 for (p
= mode
+ 1; *p
!= '\0'; ++p
)
914 gdbscm_out_of_range_error (func_name
, 0,
915 gdbscm_scm_from_c_string (mode
),
916 _("bad mode string"));
920 /* Kinda awkward to convert the mode from SCM -> string only to have Guile
921 convert it back to SCM, but that's the API we have to work with. */
922 mode_bits
= scm_mode_bits ((char *) mode
);
927 /* Helper for gdbscm_open_memory to finish initializing the port.
928 The port has address range [start,end).
929 This means that address of 0xff..ff is not accessible.
930 I can live with that. */
933 ioscm_init_memory_port (SCM port
, CORE_ADDR start
, CORE_ADDR end
)
936 ioscm_memory_port
*iomem
;
937 int buffered
= (SCM_CELL_WORD_0 (port
) & SCM_BUF0
) == 0;
939 gdb_assert (start
<= end
);
941 iomem
= (ioscm_memory_port
*) scm_gc_malloc_pointerless (sizeof (*iomem
),
944 iomem
->start
= start
;
946 iomem
->size
= end
- start
;
950 iomem
->read_buf_size
= default_read_buf_size
;
951 iomem
->write_buf_size
= default_write_buf_size
;
955 iomem
->read_buf_size
= 1;
956 iomem
->write_buf_size
= 1;
959 pt
= SCM_PTAB_ENTRY (port
);
960 /* Match the expectation of `binary-port?'. */
963 pt
->read_buf_size
= iomem
->read_buf_size
;
964 pt
->write_buf_size
= iomem
->write_buf_size
;
967 pt
->read_buf
= (unsigned char *) xmalloc (pt
->read_buf_size
);
968 pt
->write_buf
= (unsigned char *) xmalloc (pt
->write_buf_size
);
972 pt
->read_buf
= &pt
->shortbuf
;
973 pt
->write_buf
= &pt
->shortbuf
;
975 pt
->read_pos
= pt
->read_end
= pt
->read_buf
;
976 pt
->write_pos
= pt
->write_buf
;
977 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
979 SCM_SETSTREAM (port
, iomem
);
982 /* Re-initialize a memory port, updating its read/write buffer sizes.
983 An exception is thrown if the port is unbuffered.
984 TODO: Allow switching buffered/unbuffered.
985 An exception is also thrown if data is still buffered, except in the case
986 where the buffer size isn't changing (since that's just a nop). */
989 ioscm_reinit_memory_port (SCM port
, size_t read_buf_size
,
990 size_t write_buf_size
, const char *func_name
)
992 scm_t_port
*pt
= SCM_PTAB_ENTRY (port
);
993 ioscm_memory_port
*iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
995 gdb_assert (read_buf_size
>= min_memory_port_buf_size
996 && read_buf_size
<= max_memory_port_buf_size
);
997 gdb_assert (write_buf_size
>= min_memory_port_buf_size
998 && write_buf_size
<= max_memory_port_buf_size
);
1000 /* First check if the port is unbuffered. */
1002 if (pt
->read_buf
== &pt
->shortbuf
)
1004 gdb_assert (pt
->write_buf
== &pt
->shortbuf
);
1005 scm_misc_error (func_name
, _("port is unbuffered: ~a"),
1009 /* Next check if anything is buffered. */
1011 if (read_buf_size
!= pt
->read_buf_size
1012 && pt
->read_end
!= pt
->read_buf
)
1014 scm_misc_error (func_name
, _("read buffer not empty: ~a"),
1018 if (write_buf_size
!= pt
->write_buf_size
1019 && pt
->write_pos
!= pt
->write_buf
)
1021 scm_misc_error (func_name
, _("write buffer not empty: ~a"),
1025 /* Now we can update the buffer sizes, but only if the size has changed. */
1027 if (read_buf_size
!= pt
->read_buf_size
)
1029 iomem
->read_buf_size
= read_buf_size
;
1030 pt
->read_buf_size
= read_buf_size
;
1031 xfree (pt
->read_buf
);
1032 pt
->read_buf
= (unsigned char *) xmalloc (pt
->read_buf_size
);
1033 pt
->read_pos
= pt
->read_end
= pt
->read_buf
;
1036 if (write_buf_size
!= pt
->write_buf_size
)
1038 iomem
->write_buf_size
= write_buf_size
;
1039 pt
->write_buf_size
= write_buf_size
;
1040 xfree (pt
->write_buf
);
1041 pt
->write_buf
= (unsigned char *) xmalloc (pt
->write_buf_size
);
1042 pt
->write_pos
= pt
->write_buf
;
1043 pt
->write_end
= pt
->write_buf
+ pt
->write_buf_size
;
1047 /* (open-memory [#:mode string] [#:start address] [#:size integer]) -> port
1048 Return a port that can be used for reading and writing memory.
1049 MODE is a string, and must be one of "r", "w", or "r+".
1050 "0" may be appended to MODE to mark the port as unbuffered.
1051 For compatibility "b" (binary) may also be appended, but we ignore it:
1052 memory ports are binary only.
1054 The chunk of memory that can be accessed can be bounded.
1055 If both START,SIZE are unspecified, all of memory can be accessed
1056 (except 0xff..ff). If only START is specified, all of memory from that
1057 point on can be accessed (except 0xff..ff). If only SIZE if specified,
1058 all memory in [0,SIZE) can be accessed. If both are specified, all memory
1059 in [START,START+SIZE) can be accessed.
1061 Note: If it becomes useful enough we can later add #:end as an alternative
1062 to #:size. For now it is left out.
1064 The result is a Scheme port, and its semantics are a bit odd for accessing
1065 memory (e.g., unget), but we don't try to hide this. It's a port.
1067 N.B. Seeks on the port must be in the range [0,size].
1068 This is for similarity with bytevector ports, and so that one can seek
1069 to the first byte. */
1072 gdbscm_open_memory (SCM rest
)
1074 const SCM keywords
[] = {
1075 mode_keyword
, start_keyword
, size_keyword
, SCM_BOOL_F
1078 CORE_ADDR start
= 0;
1080 int mode_arg_pos
= -1, start_arg_pos
= -1, size_arg_pos
= -1;
1085 gdbscm_parse_function_args (FUNC_NAME
, SCM_ARG1
, keywords
, "#sUU", rest
,
1086 &mode_arg_pos
, &mode
,
1087 &start_arg_pos
, &start
,
1088 &size_arg_pos
, &size
);
1090 scm_dynwind_begin ((scm_t_dynwind_flags
) 0);
1093 mode
= xstrdup ("r");
1094 scm_dynwind_free (mode
);
1096 if (size_arg_pos
> 0)
1098 /* For now be strict about start+size overflowing. If it becomes
1099 a nuisance we can relax things later. */
1100 if (start
+ size
< start
)
1102 gdbscm_out_of_range_error (FUNC_NAME
, 0,
1103 scm_list_2 (gdbscm_scm_from_ulongest (start
),
1104 gdbscm_scm_from_ulongest (size
)),
1105 _("start+size overflows"));
1110 end
= ~(CORE_ADDR
) 0;
1112 mode_bits
= ioscm_parse_mode_bits (FUNC_NAME
, mode
);
1114 port
= ioscm_open_port (memory_port_desc
, mode_bits
);
1116 ioscm_init_memory_port (port
, start
, end
);
1120 /* TODO: Set the file name as "memory-start-end"? */
1124 /* Return non-zero if OBJ is a memory port. */
1127 gdbscm_is_memory_port (SCM obj
)
1129 return !SCM_IMP (obj
) && (SCM_TYP16 (obj
) == memory_port_desc
);
1132 /* (memory-port? obj) -> boolean */
1135 gdbscm_memory_port_p (SCM obj
)
1137 return scm_from_bool (gdbscm_is_memory_port (obj
));
1140 /* (memory-port-range port) -> (start end) */
1143 gdbscm_memory_port_range (SCM port
)
1145 ioscm_memory_port
*iomem
;
1147 SCM_ASSERT_TYPE (gdbscm_is_memory_port (port
), port
, SCM_ARG1
, FUNC_NAME
,
1148 memory_port_desc_name
);
1150 iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
1151 return scm_list_2 (gdbscm_scm_from_ulongest (iomem
->start
),
1152 gdbscm_scm_from_ulongest (iomem
->end
));
1155 /* (memory-port-read-buffer-size port) -> integer */
1158 gdbscm_memory_port_read_buffer_size (SCM port
)
1160 ioscm_memory_port
*iomem
;
1162 SCM_ASSERT_TYPE (gdbscm_is_memory_port (port
), port
, SCM_ARG1
, FUNC_NAME
,
1163 memory_port_desc_name
);
1165 iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
1166 return scm_from_uint (iomem
->read_buf_size
);
1169 /* (set-memory-port-read-buffer-size! port size) -> unspecified
1170 An exception is thrown if read data is still buffered or if the port
1174 gdbscm_set_memory_port_read_buffer_size_x (SCM port
, SCM size
)
1176 ioscm_memory_port
*iomem
;
1178 SCM_ASSERT_TYPE (gdbscm_is_memory_port (port
), port
, SCM_ARG1
, FUNC_NAME
,
1179 memory_port_desc_name
);
1180 SCM_ASSERT_TYPE (scm_is_integer (size
), size
, SCM_ARG2
, FUNC_NAME
,
1183 if (!scm_is_unsigned_integer (size
, min_memory_port_buf_size
,
1184 max_memory_port_buf_size
))
1186 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, size
,
1187 out_of_range_buf_size
);
1190 iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
1191 ioscm_reinit_memory_port (port
, scm_to_uint (size
), iomem
->write_buf_size
,
1194 return SCM_UNSPECIFIED
;
1197 /* (memory-port-write-buffer-size port) -> integer */
1200 gdbscm_memory_port_write_buffer_size (SCM port
)
1202 ioscm_memory_port
*iomem
;
1204 SCM_ASSERT_TYPE (gdbscm_is_memory_port (port
), port
, SCM_ARG1
, FUNC_NAME
,
1205 memory_port_desc_name
);
1207 iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
1208 return scm_from_uint (iomem
->write_buf_size
);
1211 /* (set-memory-port-write-buffer-size! port size) -> unspecified
1212 An exception is thrown if write data is still buffered or if the port
1216 gdbscm_set_memory_port_write_buffer_size_x (SCM port
, SCM size
)
1218 ioscm_memory_port
*iomem
;
1220 SCM_ASSERT_TYPE (gdbscm_is_memory_port (port
), port
, SCM_ARG1
, FUNC_NAME
,
1221 memory_port_desc_name
);
1222 SCM_ASSERT_TYPE (scm_is_integer (size
), size
, SCM_ARG2
, FUNC_NAME
,
1225 if (!scm_is_unsigned_integer (size
, min_memory_port_buf_size
,
1226 max_memory_port_buf_size
))
1228 gdbscm_out_of_range_error (FUNC_NAME
, SCM_ARG2
, size
,
1229 out_of_range_buf_size
);
1232 iomem
= (ioscm_memory_port
*) SCM_STREAM (port
);
1233 ioscm_reinit_memory_port (port
, iomem
->read_buf_size
, scm_to_uint (size
),
1236 return SCM_UNSPECIFIED
;
1239 /* Initialize gdb ports. */
1241 static const scheme_function port_functions
[] =
1243 { "input-port", 0, 0, 0, as_a_scm_t_subr (gdbscm_input_port
),
1245 Return gdb's input port." },
1247 { "output-port", 0, 0, 0, as_a_scm_t_subr (gdbscm_output_port
),
1249 Return gdb's output port." },
1251 { "error-port", 0, 0, 0, as_a_scm_t_subr (gdbscm_error_port
),
1253 Return gdb's error port." },
1255 { "stdio-port?", 1, 0, 0, as_a_scm_t_subr (gdbscm_stdio_port_p
),
1257 Return #t if the object is a gdb:stdio-port." },
1259 { "open-memory", 0, 0, 1, as_a_scm_t_subr (gdbscm_open_memory
),
1261 Return a port that can be used for reading/writing inferior memory.\n\
1263 Arguments: [#:mode string] [#:start address] [#:size integer]\n\
1264 Returns: A port object." },
1266 { "memory-port?", 1, 0, 0, as_a_scm_t_subr (gdbscm_memory_port_p
),
1268 Return #t if the object is a memory port." },
1270 { "memory-port-range", 1, 0, 0, as_a_scm_t_subr (gdbscm_memory_port_range
),
1272 Return the memory range of the port as (start end)." },
1274 { "memory-port-read-buffer-size", 1, 0, 0,
1275 as_a_scm_t_subr (gdbscm_memory_port_read_buffer_size
),
1277 Return the size of the read buffer for the memory port." },
1279 { "set-memory-port-read-buffer-size!", 2, 0, 0,
1280 as_a_scm_t_subr (gdbscm_set_memory_port_read_buffer_size_x
),
1282 Set the size of the read buffer for the memory port.\n\
1284 Arguments: port integer\n\
1285 Returns: unspecified." },
1287 { "memory-port-write-buffer-size", 1, 0, 0,
1288 as_a_scm_t_subr (gdbscm_memory_port_write_buffer_size
),
1290 Return the size of the write buffer for the memory port." },
1292 { "set-memory-port-write-buffer-size!", 2, 0, 0,
1293 as_a_scm_t_subr (gdbscm_set_memory_port_write_buffer_size_x
),
1295 Set the size of the write buffer for the memory port.\n\
1297 Arguments: port integer\n\
1298 Returns: unspecified." },
1303 static const scheme_function private_port_functions
[] =
1306 { "%with-gdb-input-from-port", 2, 0, 0,
1307 as_a_scm_t_subr (gdbscm_percent_with_gdb_input_from_port
),
1309 Temporarily set GDB's input port to PORT and then invoke THUNK.\n\
1311 Arguments: port thunk\n\
1312 Returns: The result of calling THUNK.\n\
1314 This procedure is experimental." },
1317 { "%with-gdb-output-to-port", 2, 0, 0,
1318 as_a_scm_t_subr (gdbscm_percent_with_gdb_output_to_port
),
1320 Temporarily set GDB's output port to PORT and then invoke THUNK.\n\
1322 Arguments: port thunk\n\
1323 Returns: The result of calling THUNK.\n\
1325 This procedure is experimental." },
1327 { "%with-gdb-error-to-port", 2, 0, 0,
1328 as_a_scm_t_subr (gdbscm_percent_with_gdb_error_to_port
),
1330 Temporarily set GDB's error port to PORT and then invoke THUNK.\n\
1332 Arguments: port thunk\n\
1333 Returns: The result of calling THUNK.\n\
1335 This procedure is experimental." },
1341 gdbscm_initialize_ports (void)
1343 /* Save the original stdio ports for debugging purposes. */
1345 orig_input_port_scm
= scm_current_input_port ();
1346 orig_output_port_scm
= scm_current_output_port ();
1347 orig_error_port_scm
= scm_current_error_port ();
1349 /* Set up the stdio ports. */
1351 ioscm_init_gdb_stdio_port ();
1352 input_port_scm
= ioscm_make_gdb_stdio_port (0);
1353 output_port_scm
= ioscm_make_gdb_stdio_port (1);
1354 error_port_scm
= ioscm_make_gdb_stdio_port (2);
1356 /* Set up memory ports. */
1358 ioscm_init_memory_port_type ();
1360 /* Install the accessor functions. */
1362 gdbscm_define_functions (port_functions
, 1);
1363 gdbscm_define_functions (private_port_functions
, 0);
1365 /* Keyword args for open-memory. */
1367 mode_keyword
= scm_from_latin1_keyword ("mode");
1368 start_keyword
= scm_from_latin1_keyword ("start");
1369 size_keyword
= scm_from_latin1_keyword ("size");
1371 /* Error message text for "out of range" memory port buffer sizes. */
1373 out_of_range_buf_size
= xstrprintf ("size not between %u - %u",
1374 min_memory_port_buf_size
,
1375 max_memory_port_buf_size
);