Commit | Line | Data |
---|---|---|
ed3ef339 DE |
1 | /* Support for connecting Guile's stdio to GDB's. |
2 | as well as r/w memory via ports. | |
3 | ||
32d0add0 | 4 | Copyright (C) 2014-2015 Free Software Foundation, Inc. |
ed3ef339 DE |
5 | |
6 | This file is part of GDB. | |
7 | ||
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. | |
12 | ||
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. | |
17 | ||
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/>. */ | |
20 | ||
21 | /* See README file in this directory for implementation notes, coding | |
22 | conventions, et.al. */ | |
23 | ||
24 | #include "defs.h" | |
25 | #include "gdb_select.h" | |
26 | #include "interps.h" | |
27 | #include "target.h" | |
28 | #include "guile-internal.h" | |
29 | ||
30 | #ifdef HAVE_POLL | |
31 | #if defined (HAVE_POLL_H) | |
32 | #include <poll.h> | |
33 | #elif defined (HAVE_SYS_POLL_H) | |
34 | #include <sys/poll.h> | |
35 | #endif | |
36 | #endif | |
37 | ||
38 | /* A ui-file for sending output to Guile. */ | |
39 | ||
40 | typedef struct | |
41 | { | |
42 | int *magic; | |
43 | SCM port; | |
44 | } ioscm_file_port; | |
45 | ||
46 | /* Data for a memory port. */ | |
47 | ||
48 | typedef struct | |
49 | { | |
37442ce1 DE |
50 | /* Bounds of memory range this port is allowed to access: [start, end). |
51 | This means that 0xff..ff is not accessible. I can live with that. */ | |
ed3ef339 DE |
52 | CORE_ADDR start, end; |
53 | ||
37442ce1 | 54 | /* (end - start), recorded for convenience. */ |
ed3ef339 DE |
55 | ULONGEST size; |
56 | ||
57 | /* Think of this as the lseek value maintained by the kernel. | |
58 | This value is always in the range [0, size]. */ | |
59 | ULONGEST current; | |
60 | ||
61 | /* The size of the internal r/w buffers. | |
62 | Scheme ports aren't a straightforward mapping to memory r/w. | |
63 | Generally the user specifies how much to r/w and all access is | |
64 | unbuffered. We don't try to provide equivalent access, but we allow | |
65 | the user to specify these values to help get something similar. */ | |
66 | unsigned read_buf_size, write_buf_size; | |
67 | } ioscm_memory_port; | |
68 | ||
69 | /* Copies of the original system input/output/error ports. | |
70 | These are recorded for debugging purposes. */ | |
71 | static SCM orig_input_port_scm; | |
72 | static SCM orig_output_port_scm; | |
73 | static SCM orig_error_port_scm; | |
74 | ||
75 | /* This is the stdio port descriptor, scm_ptob_descriptor. */ | |
76 | static scm_t_bits stdio_port_desc; | |
77 | ||
78 | /* Note: scm_make_port_type takes a char * instead of a const char *. */ | |
79 | static /*const*/ char stdio_port_desc_name[] = "gdb:stdio-port"; | |
80 | ||
81 | /* Names of each gdb port. */ | |
82 | static const char input_port_name[] = "gdb:stdin"; | |
83 | static const char output_port_name[] = "gdb:stdout"; | |
84 | static const char error_port_name[] = "gdb:stderr"; | |
85 | ||
86 | /* This is the actual port used from Guile. | |
87 | We don't expose these to the user though, to ensure they're not | |
88 | overwritten. */ | |
89 | static SCM input_port_scm; | |
90 | static SCM output_port_scm; | |
91 | static SCM error_port_scm; | |
92 | ||
93 | /* Magic number to identify port ui-files. | |
94 | Actually, the address of this variable is the magic number. */ | |
95 | static int file_port_magic; | |
96 | ||
97 | /* Internal enum for specifying output port. */ | |
98 | enum oport { GDB_STDOUT, GDB_STDERR }; | |
99 | ||
100 | /* This is the memory port descriptor, scm_ptob_descriptor. */ | |
101 | static scm_t_bits memory_port_desc; | |
102 | ||
103 | /* Note: scm_make_port_type takes a char * instead of a const char *. */ | |
104 | static /*const*/ char memory_port_desc_name[] = "gdb:memory-port"; | |
105 | ||
106 | /* The default amount of memory to fetch for each read/write request. | |
107 | Scheme ports don't provide a way to specify the size of a read, | |
108 | which is important to us to minimize the number of inferior interactions, | |
109 | which over a remote link can be important. To compensate we augment the | |
110 | port API with a new function that let's the user specify how much the next | |
111 | read request should fetch. This is the initial value for each new port. */ | |
112 | static const unsigned default_read_buf_size = 16; | |
113 | static const unsigned default_write_buf_size = 16; | |
114 | ||
115 | /* Arbitrarily limit memory port buffers to 1 byte to 4K. */ | |
116 | static const unsigned min_memory_port_buf_size = 1; | |
117 | static const unsigned max_memory_port_buf_size = 4096; | |
118 | ||
119 | /* "out of range" error message for buf sizes. */ | |
120 | static char *out_of_range_buf_size; | |
121 | ||
122 | /* Keywords used by open-memory. */ | |
123 | static SCM mode_keyword; | |
124 | static SCM start_keyword; | |
125 | static SCM size_keyword; | |
126 | \f | |
127 | /* Helper to do the low level work of opening a port. | |
128 | Newer versions of Guile (2.1.x) have scm_c_make_port. */ | |
129 | ||
130 | static SCM | |
131 | ioscm_open_port (scm_t_bits port_type, long mode_bits) | |
132 | { | |
133 | SCM port; | |
134 | ||
135 | #if 0 /* TODO: Guile doesn't export this. What to do? */ | |
136 | scm_i_scm_pthread_mutex_lock (&scm_i_port_table_mutex); | |
137 | #endif | |
138 | ||
139 | port = scm_new_port_table_entry (port_type); | |
140 | ||
141 | SCM_SET_CELL_TYPE (port, port_type | mode_bits); | |
142 | ||
143 | #if 0 /* TODO: Guile doesn't export this. What to do? */ | |
144 | scm_i_pthread_mutex_unlock (&scm_i_port_table_mutex); | |
145 | #endif | |
146 | ||
147 | return port; | |
148 | } | |
149 | \f | |
150 | /* Support for connecting Guile's stdio ports to GDB's stdio ports. */ | |
151 | ||
152 | /* The scm_t_ptob_descriptor.input_waiting "method". | |
153 | Return a lower bound on the number of bytes available for input. */ | |
154 | ||
155 | static int | |
156 | ioscm_input_waiting (SCM port) | |
157 | { | |
158 | int fdes = 0; | |
159 | ||
160 | if (! scm_is_eq (port, input_port_scm)) | |
161 | return 0; | |
162 | ||
163 | #ifdef HAVE_POLL | |
164 | { | |
165 | /* This is copied from libguile/fports.c. */ | |
166 | struct pollfd pollfd = { fdes, POLLIN, 0 }; | |
167 | static int use_poll = -1; | |
168 | ||
169 | if (use_poll < 0) | |
170 | { | |
171 | /* This is copied from event-loop.c: poll cannot be used for stdin on | |
172 | m68k-motorola-sysv. */ | |
173 | struct pollfd test_pollfd = { fdes, POLLIN, 0 }; | |
174 | ||
175 | if (poll (&test_pollfd, 1, 0) == 1 && (test_pollfd.revents & POLLNVAL)) | |
176 | use_poll = 0; | |
177 | else | |
178 | use_poll = 1; | |
179 | } | |
180 | ||
181 | if (use_poll) | |
182 | { | |
183 | /* Guile doesn't export SIGINT hooks like Python does. | |
184 | For now pass EINTR to scm_syserror, that's what fports.c does. */ | |
185 | if (poll (&pollfd, 1, 0) < 0) | |
186 | scm_syserror (FUNC_NAME); | |
187 | ||
188 | return pollfd.revents & POLLIN ? 1 : 0; | |
189 | } | |
190 | } | |
191 | /* Fall through. */ | |
192 | #endif | |
193 | ||
194 | { | |
195 | struct timeval timeout; | |
196 | fd_set input_fds; | |
197 | int num_fds = fdes + 1; | |
198 | int num_found; | |
199 | ||
200 | memset (&timeout, 0, sizeof (timeout)); | |
201 | FD_ZERO (&input_fds); | |
202 | FD_SET (fdes, &input_fds); | |
203 | ||
204 | num_found = gdb_select (num_fds, &input_fds, NULL, NULL, &timeout); | |
205 | if (num_found < 0) | |
206 | { | |
207 | /* Guile doesn't export SIGINT hooks like Python does. | |
208 | For now pass EINTR to scm_syserror, that's what fports.c does. */ | |
209 | scm_syserror (FUNC_NAME); | |
210 | } | |
211 | return num_found > 0 && FD_ISSET (fdes, &input_fds); | |
212 | } | |
213 | } | |
214 | ||
215 | /* The scm_t_ptob_descriptor.fill_input "method". */ | |
216 | ||
217 | static int | |
218 | ioscm_fill_input (SCM port) | |
219 | { | |
220 | /* Borrowed from libguile/fports.c. */ | |
221 | long count; | |
222 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
223 | ||
224 | /* If we're called on stdout,stderr, punt. */ | |
225 | if (! scm_is_eq (port, input_port_scm)) | |
226 | return (scm_t_wchar) EOF; /* Set errno and return -1? */ | |
227 | ||
228 | gdb_flush (gdb_stdout); | |
229 | gdb_flush (gdb_stderr); | |
230 | ||
231 | count = ui_file_read (gdb_stdin, (char *) pt->read_buf, pt->read_buf_size); | |
232 | if (count == -1) | |
233 | scm_syserror (FUNC_NAME); | |
234 | if (count == 0) | |
235 | return (scm_t_wchar) EOF; | |
236 | ||
237 | pt->read_pos = pt->read_buf; | |
238 | pt->read_end = pt->read_buf + count; | |
239 | return *pt->read_buf; | |
240 | } | |
241 | ||
242 | /* Like fputstrn_filtered, but don't escape characters, except nul. | |
243 | Also like fputs_filtered, but a length is specified. */ | |
244 | ||
245 | static void | |
246 | fputsn_filtered (const char *s, size_t size, struct ui_file *stream) | |
247 | { | |
248 | size_t i; | |
249 | ||
250 | for (i = 0; i < size; ++i) | |
251 | { | |
252 | if (s[i] == '\0') | |
253 | fputs_filtered ("\\000", stream); | |
254 | else | |
255 | fputc_filtered (s[i], stream); | |
256 | } | |
257 | } | |
258 | ||
259 | /* Write to gdb's stdout or stderr. */ | |
260 | ||
261 | static void | |
262 | ioscm_write (SCM port, const void *data, size_t size) | |
263 | { | |
ed3ef339 DE |
264 | |
265 | /* If we're called on stdin, punt. */ | |
266 | if (scm_is_eq (port, input_port_scm)) | |
267 | return; | |
268 | ||
492d29ea | 269 | TRY |
ed3ef339 DE |
270 | { |
271 | if (scm_is_eq (port, error_port_scm)) | |
9a3c8263 | 272 | fputsn_filtered ((const char *) data, size, gdb_stderr); |
ed3ef339 | 273 | else |
9a3c8263 | 274 | fputsn_filtered ((const char *) data, size, gdb_stdout); |
ed3ef339 | 275 | } |
492d29ea PA |
276 | CATCH (except, RETURN_MASK_ALL) |
277 | { | |
278 | GDBSCM_HANDLE_GDB_EXCEPTION (except); | |
279 | } | |
280 | END_CATCH | |
ed3ef339 DE |
281 | } |
282 | ||
283 | /* Flush gdb's stdout or stderr. */ | |
284 | ||
285 | static void | |
286 | ioscm_flush (SCM port) | |
287 | { | |
288 | /* If we're called on stdin, punt. */ | |
289 | if (scm_is_eq (port, input_port_scm)) | |
290 | return; | |
291 | ||
292 | if (scm_is_eq (port, error_port_scm)) | |
293 | gdb_flush (gdb_stderr); | |
294 | else | |
295 | gdb_flush (gdb_stdout); | |
296 | } | |
297 | ||
298 | /* Initialize the gdb stdio port type. | |
299 | ||
300 | N.B. isatty? will fail on these ports, it is only supported for file | |
301 | ports. IWBN if we could "subclass" file ports. */ | |
302 | ||
303 | static void | |
304 | ioscm_init_gdb_stdio_port (void) | |
305 | { | |
306 | stdio_port_desc = scm_make_port_type (stdio_port_desc_name, | |
307 | ioscm_fill_input, ioscm_write); | |
308 | ||
309 | scm_set_port_input_waiting (stdio_port_desc, ioscm_input_waiting); | |
310 | scm_set_port_flush (stdio_port_desc, ioscm_flush); | |
311 | } | |
312 | ||
313 | /* Subroutine of ioscm_make_gdb_stdio_port to simplify it. | |
314 | Set up the buffers of port PORT. | |
315 | MODE_BITS are the mode bits of PORT. */ | |
316 | ||
317 | static void | |
318 | ioscm_init_stdio_buffers (SCM port, long mode_bits) | |
319 | { | |
320 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
321 | #define GDB_STDIO_BUFFER_DEFAULT_SIZE 1024 | |
322 | int size = mode_bits & SCM_BUF0 ? 0 : GDB_STDIO_BUFFER_DEFAULT_SIZE; | |
323 | int writing = (mode_bits & SCM_WRTNG) != 0; | |
324 | ||
325 | /* This is heavily copied from scm_fport_buffer_add. */ | |
326 | ||
327 | if (!writing && size > 0) | |
328 | { | |
224c3ddb SM |
329 | pt->read_buf |
330 | = (unsigned char *) scm_gc_malloc_pointerless (size, "port buffer"); | |
ed3ef339 DE |
331 | pt->read_pos = pt->read_end = pt->read_buf; |
332 | pt->read_buf_size = size; | |
333 | } | |
334 | else | |
335 | { | |
336 | pt->read_pos = pt->read_buf = pt->read_end = &pt->shortbuf; | |
337 | pt->read_buf_size = 1; | |
338 | } | |
339 | ||
340 | if (writing && size > 0) | |
341 | { | |
224c3ddb SM |
342 | pt->write_buf |
343 | = (unsigned char *) scm_gc_malloc_pointerless (size, "port buffer"); | |
ed3ef339 DE |
344 | pt->write_pos = pt->write_buf; |
345 | pt->write_buf_size = size; | |
346 | } | |
347 | else | |
348 | { | |
349 | pt->write_buf = pt->write_pos = &pt->shortbuf; | |
350 | pt->write_buf_size = 1; | |
351 | } | |
352 | pt->write_end = pt->write_buf + pt->write_buf_size; | |
353 | } | |
354 | ||
355 | /* Create a gdb stdio port. */ | |
356 | ||
357 | static SCM | |
358 | ioscm_make_gdb_stdio_port (int fd) | |
359 | { | |
360 | int is_a_tty = isatty (fd); | |
361 | const char *name; | |
362 | long mode_bits; | |
363 | SCM port; | |
364 | ||
365 | switch (fd) | |
366 | { | |
367 | case 0: | |
368 | name = input_port_name; | |
369 | mode_bits = scm_mode_bits (is_a_tty ? "r0" : "r"); | |
370 | break; | |
371 | case 1: | |
372 | name = output_port_name; | |
373 | mode_bits = scm_mode_bits (is_a_tty ? "w0" : "w"); | |
374 | break; | |
375 | case 2: | |
376 | name = error_port_name; | |
377 | mode_bits = scm_mode_bits (is_a_tty ? "w0" : "w"); | |
378 | break; | |
379 | default: | |
380 | gdb_assert_not_reached ("bad stdio file descriptor"); | |
381 | } | |
382 | ||
383 | port = ioscm_open_port (stdio_port_desc, mode_bits); | |
384 | ||
385 | scm_set_port_filename_x (port, gdbscm_scm_from_c_string (name)); | |
386 | ||
387 | ioscm_init_stdio_buffers (port, mode_bits); | |
388 | ||
389 | return port; | |
390 | } | |
391 | ||
392 | /* (stdio-port? object) -> boolean */ | |
393 | ||
394 | static SCM | |
395 | gdbscm_stdio_port_p (SCM scm) | |
396 | { | |
397 | /* This is copied from SCM_FPORTP. */ | |
398 | return scm_from_bool (!SCM_IMP (scm) | |
399 | && (SCM_TYP16 (scm) == stdio_port_desc)); | |
400 | } | |
401 | \f | |
402 | /* GDB's ports are accessed via functions to keep them read-only. */ | |
403 | ||
404 | /* (input-port) -> port */ | |
405 | ||
406 | static SCM | |
407 | gdbscm_input_port (void) | |
408 | { | |
409 | return input_port_scm; | |
410 | } | |
411 | ||
412 | /* (output-port) -> port */ | |
413 | ||
414 | static SCM | |
415 | gdbscm_output_port (void) | |
416 | { | |
417 | return output_port_scm; | |
418 | } | |
419 | ||
420 | /* (error-port) -> port */ | |
421 | ||
422 | static SCM | |
423 | gdbscm_error_port (void) | |
424 | { | |
425 | return error_port_scm; | |
426 | } | |
427 | \f | |
428 | /* Support for sending GDB I/O to Guile ports. */ | |
429 | ||
430 | static void | |
431 | ioscm_file_port_delete (struct ui_file *file) | |
432 | { | |
9a3c8263 | 433 | ioscm_file_port *stream = (ioscm_file_port *) ui_file_data (file); |
ed3ef339 DE |
434 | |
435 | if (stream->magic != &file_port_magic) | |
436 | internal_error (__FILE__, __LINE__, | |
437 | _("ioscm_file_port_delete: bad magic number")); | |
438 | xfree (stream); | |
439 | } | |
440 | ||
441 | static void | |
442 | ioscm_file_port_rewind (struct ui_file *file) | |
443 | { | |
9a3c8263 | 444 | ioscm_file_port *stream = (ioscm_file_port *) ui_file_data (file); |
ed3ef339 DE |
445 | |
446 | if (stream->magic != &file_port_magic) | |
447 | internal_error (__FILE__, __LINE__, | |
448 | _("ioscm_file_port_rewind: bad magic number")); | |
449 | ||
450 | scm_truncate_file (stream->port, 0); | |
451 | } | |
452 | ||
453 | static void | |
454 | ioscm_file_port_put (struct ui_file *file, | |
455 | ui_file_put_method_ftype *write, | |
456 | void *dest) | |
457 | { | |
9a3c8263 | 458 | ioscm_file_port *stream = (ioscm_file_port *) ui_file_data (file); |
ed3ef339 DE |
459 | |
460 | if (stream->magic != &file_port_magic) | |
461 | internal_error (__FILE__, __LINE__, | |
462 | _("ioscm_file_port_put: bad magic number")); | |
463 | ||
464 | /* This function doesn't meld with ports very well. */ | |
465 | } | |
466 | ||
467 | static void | |
468 | ioscm_file_port_write (struct ui_file *file, | |
469 | const char *buffer, | |
470 | long length_buffer) | |
471 | { | |
9a3c8263 | 472 | ioscm_file_port *stream = (ioscm_file_port *) ui_file_data (file); |
ed3ef339 DE |
473 | |
474 | if (stream->magic != &file_port_magic) | |
475 | internal_error (__FILE__, __LINE__, | |
476 | _("ioscm_pot_file_write: bad magic number")); | |
477 | ||
478 | scm_c_write (stream->port, buffer, length_buffer); | |
479 | } | |
480 | ||
481 | /* Return a ui_file that writes to PORT. */ | |
482 | ||
483 | static struct ui_file * | |
484 | ioscm_file_port_new (SCM port) | |
485 | { | |
486 | ioscm_file_port *stream = XCNEW (ioscm_file_port); | |
487 | struct ui_file *file = ui_file_new (); | |
488 | ||
489 | set_ui_file_data (file, stream, ioscm_file_port_delete); | |
490 | set_ui_file_rewind (file, ioscm_file_port_rewind); | |
491 | set_ui_file_put (file, ioscm_file_port_put); | |
492 | set_ui_file_write (file, ioscm_file_port_write); | |
493 | stream->magic = &file_port_magic; | |
494 | stream->port = port; | |
495 | ||
496 | return file; | |
497 | } | |
498 | \f | |
499 | /* Helper routine for with-{output,error}-to-port. */ | |
500 | ||
501 | static SCM | |
502 | ioscm_with_output_to_port_worker (SCM port, SCM thunk, enum oport oport, | |
503 | const char *func_name) | |
504 | { | |
505 | struct ui_file *port_file; | |
506 | struct cleanup *cleanups; | |
507 | SCM result; | |
508 | ||
509 | SCM_ASSERT_TYPE (gdbscm_is_true (scm_output_port_p (port)), port, | |
510 | SCM_ARG1, func_name, _("output port")); | |
511 | SCM_ASSERT_TYPE (gdbscm_is_true (scm_thunk_p (thunk)), thunk, | |
512 | SCM_ARG2, func_name, _("thunk")); | |
513 | ||
514 | cleanups = set_batch_flag_and_make_cleanup_restore_page_info (); | |
515 | ||
516 | make_cleanup_restore_integer (&interpreter_async); | |
517 | interpreter_async = 0; | |
518 | ||
519 | port_file = ioscm_file_port_new (port); | |
520 | ||
521 | make_cleanup_ui_file_delete (port_file); | |
522 | ||
523 | if (oport == GDB_STDERR) | |
524 | { | |
525 | make_cleanup_restore_ui_file (&gdb_stderr); | |
526 | gdb_stderr = port_file; | |
527 | } | |
528 | else | |
529 | { | |
530 | make_cleanup_restore_ui_file (&gdb_stdout); | |
531 | ||
532 | if (ui_out_redirect (current_uiout, port_file) < 0) | |
533 | warning (_("Current output protocol does not support redirection")); | |
534 | else | |
535 | make_cleanup_ui_out_redirect_pop (current_uiout); | |
536 | ||
537 | gdb_stdout = port_file; | |
538 | } | |
539 | ||
540 | result = gdbscm_safe_call_0 (thunk, NULL); | |
541 | ||
542 | do_cleanups (cleanups); | |
543 | ||
544 | if (gdbscm_is_exception (result)) | |
545 | gdbscm_throw (result); | |
546 | ||
547 | return result; | |
548 | } | |
549 | ||
550 | /* (%with-gdb-output-to-port port thunk) -> object | |
551 | This function is experimental. | |
552 | IWBN to not include "gdb" in the name, but it would collide with a standard | |
553 | procedure, and it's common to import the gdb module without a prefix. | |
554 | There are ways around this, but they're more cumbersome. | |
555 | ||
556 | This has % in the name because it's experimental, and we want the | |
557 | user-visible version to come from module (gdb experimental). */ | |
558 | ||
559 | static SCM | |
560 | gdbscm_percent_with_gdb_output_to_port (SCM port, SCM thunk) | |
561 | { | |
562 | return ioscm_with_output_to_port_worker (port, thunk, GDB_STDOUT, FUNC_NAME); | |
563 | } | |
564 | ||
565 | /* (%with-gdb-error-to-port port thunk) -> object | |
566 | This function is experimental. | |
567 | IWBN to not include "gdb" in the name, but it would collide with a standard | |
568 | procedure, and it's common to import the gdb module without a prefix. | |
569 | There are ways around this, but they're more cumbersome. | |
570 | ||
571 | This has % in the name because it's experimental, and we want the | |
572 | user-visible version to come from module (gdb experimental). */ | |
573 | ||
574 | static SCM | |
575 | gdbscm_percent_with_gdb_error_to_port (SCM port, SCM thunk) | |
576 | { | |
577 | return ioscm_with_output_to_port_worker (port, thunk, GDB_STDERR, FUNC_NAME); | |
578 | } | |
579 | \f | |
580 | /* Support for r/w memory via ports. */ | |
581 | ||
582 | /* Perform an "lseek" to OFFSET,WHENCE on memory port IOMEM. | |
583 | OFFSET must be in the range [0,size]. | |
584 | The result is non-zero for success, zero for failure. */ | |
585 | ||
586 | static int | |
587 | ioscm_lseek_address (ioscm_memory_port *iomem, LONGEST offset, int whence) | |
588 | { | |
589 | CORE_ADDR new_current; | |
590 | ||
591 | gdb_assert (iomem->current <= iomem->size); | |
592 | ||
593 | switch (whence) | |
594 | { | |
595 | case SEEK_CUR: | |
596 | /* Catch over/underflow. */ | |
597 | if ((offset < 0 && iomem->current + offset > iomem->current) | |
37442ce1 | 598 | || (offset > 0 && iomem->current + offset < iomem->current)) |
ed3ef339 DE |
599 | return 0; |
600 | new_current = iomem->current + offset; | |
601 | break; | |
602 | case SEEK_SET: | |
603 | new_current = offset; | |
604 | break; | |
605 | case SEEK_END: | |
606 | if (offset == 0) | |
607 | { | |
608 | new_current = iomem->size; | |
609 | break; | |
610 | } | |
611 | /* TODO: Not supported yet. */ | |
612 | return 0; | |
613 | default: | |
614 | return 0; | |
615 | } | |
616 | ||
617 | if (new_current > iomem->size) | |
618 | return 0; | |
619 | iomem->current = new_current; | |
620 | return 1; | |
621 | } | |
622 | ||
623 | /* "fill_input" method for memory ports. */ | |
624 | ||
625 | static int | |
626 | gdbscm_memory_port_fill_input (SCM port) | |
627 | { | |
628 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
629 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
630 | size_t to_read; | |
631 | ||
632 | /* "current" is the offset of the first byte we want to read. */ | |
37442ce1 DE |
633 | gdb_assert (iomem->current <= iomem->size); |
634 | if (iomem->current == iomem->size) | |
ed3ef339 DE |
635 | return EOF; |
636 | ||
637 | /* Don't read outside the allowed memory range. */ | |
638 | to_read = pt->read_buf_size; | |
639 | if (to_read > iomem->size - iomem->current) | |
640 | to_read = iomem->size - iomem->current; | |
641 | ||
642 | if (target_read_memory (iomem->start + iomem->current, pt->read_buf, | |
643 | to_read) != 0) | |
644 | gdbscm_memory_error (FUNC_NAME, _("error reading memory"), SCM_EOL); | |
645 | ||
37442ce1 | 646 | iomem->current += to_read; |
ed3ef339 DE |
647 | pt->read_pos = pt->read_buf; |
648 | pt->read_end = pt->read_buf + to_read; | |
ed3ef339 DE |
649 | return *pt->read_buf; |
650 | } | |
651 | ||
652 | /* "end_input" method for memory ports. | |
653 | Clear the read buffer and adjust the file position for unread bytes. */ | |
654 | ||
655 | static void | |
656 | gdbscm_memory_port_end_input (SCM port, int offset) | |
657 | { | |
658 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
659 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
660 | size_t remaining = pt->read_end - pt->read_pos; | |
661 | ||
662 | /* Note: Use of "int offset" is specified by Guile ports API. */ | |
663 | if ((offset < 0 && remaining + offset > remaining) | |
664 | || (offset > 0 && remaining + offset < remaining)) | |
665 | { | |
666 | gdbscm_out_of_range_error (FUNC_NAME, 0, scm_from_int (offset), | |
667 | _("overflow in offset calculation")); | |
668 | } | |
669 | offset += remaining; | |
670 | ||
671 | if (offset > 0) | |
672 | { | |
673 | pt->read_pos = pt->read_end; | |
674 | /* Throw error if unread-char used at beginning of file | |
675 | then attempting to write. Seems correct. */ | |
676 | if (!ioscm_lseek_address (iomem, -offset, SEEK_CUR)) | |
677 | { | |
678 | gdbscm_out_of_range_error (FUNC_NAME, 0, scm_from_int (offset), | |
679 | _("bad offset")); | |
680 | } | |
681 | } | |
682 | ||
683 | pt->rw_active = SCM_PORT_NEITHER; | |
684 | } | |
685 | ||
686 | /* "flush" method for memory ports. */ | |
687 | ||
688 | static void | |
689 | gdbscm_memory_port_flush (SCM port) | |
690 | { | |
691 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
692 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
693 | size_t to_write = pt->write_pos - pt->write_buf; | |
694 | ||
695 | if (to_write == 0) | |
696 | return; | |
697 | ||
698 | /* There's no way to indicate a short write, so if the request goes past | |
699 | the end of the port's memory range, flag an error. */ | |
700 | if (to_write > iomem->size - iomem->current) | |
701 | { | |
702 | gdbscm_out_of_range_error (FUNC_NAME, 0, | |
703 | gdbscm_scm_from_ulongest (to_write), | |
704 | _("writing beyond end of memory range")); | |
705 | } | |
706 | ||
707 | if (target_write_memory (iomem->start + iomem->current, pt->write_buf, | |
708 | to_write) != 0) | |
709 | gdbscm_memory_error (FUNC_NAME, _("error writing memory"), SCM_EOL); | |
710 | ||
711 | iomem->current += to_write; | |
712 | pt->write_pos = pt->write_buf; | |
713 | pt->rw_active = SCM_PORT_NEITHER; | |
714 | } | |
715 | ||
716 | /* "write" method for memory ports. */ | |
717 | ||
718 | static void | |
719 | gdbscm_memory_port_write (SCM port, const void *data, size_t size) | |
720 | { | |
721 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
722 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
ed3ef339 DE |
723 | |
724 | /* There's no way to indicate a short write, so if the request goes past | |
725 | the end of the port's memory range, flag an error. */ | |
726 | if (size > iomem->size - iomem->current) | |
727 | { | |
728 | gdbscm_out_of_range_error (FUNC_NAME, 0, gdbscm_scm_from_ulongest (size), | |
729 | _("writing beyond end of memory range")); | |
730 | } | |
731 | ||
37442ce1 DE |
732 | if (pt->write_buf == &pt->shortbuf) |
733 | { | |
734 | /* Unbuffered port. */ | |
735 | if (target_write_memory (iomem->start + iomem->current, data, size) != 0) | |
736 | gdbscm_memory_error (FUNC_NAME, _("error writing memory"), SCM_EOL); | |
737 | iomem->current += size; | |
738 | return; | |
739 | } | |
740 | ||
741 | /* Note: The edge case of what to do when the buffer exactly fills is | |
742 | debatable. Guile flushes when the buffer exactly fills up, so we | |
743 | do too. It's counter-intuitive to my mind, but in case there's a | |
744 | subtlety somewhere that depends on this, we do the same. */ | |
745 | ||
746 | { | |
747 | size_t space = pt->write_end - pt->write_pos; | |
748 | ||
749 | if (size < space) | |
750 | { | |
751 | /* Data fits in buffer, and does not fill it. */ | |
752 | memcpy (pt->write_pos, data, size); | |
753 | pt->write_pos += size; | |
754 | } | |
755 | else | |
756 | { | |
757 | memcpy (pt->write_pos, data, space); | |
758 | pt->write_pos = pt->write_end; | |
759 | gdbscm_memory_port_flush (port); | |
760 | { | |
761 | const void *ptr = ((const char *) data) + space; | |
762 | size_t remaining = size - space; | |
ed3ef339 | 763 | |
37442ce1 DE |
764 | if (remaining >= pt->write_buf_size) |
765 | { | |
766 | if (target_write_memory (iomem->start + iomem->current, ptr, | |
767 | remaining) != 0) | |
768 | gdbscm_memory_error (FUNC_NAME, _("error writing memory"), | |
769 | SCM_EOL); | |
770 | iomem->current += remaining; | |
771 | } | |
772 | else | |
773 | { | |
774 | memcpy (pt->write_pos, ptr, remaining); | |
775 | pt->write_pos += remaining; | |
776 | } | |
777 | } | |
778 | } | |
779 | } | |
ed3ef339 DE |
780 | } |
781 | ||
782 | /* "seek" method for memory ports. */ | |
783 | ||
784 | static scm_t_off | |
785 | gdbscm_memory_port_seek (SCM port, scm_t_off offset, int whence) | |
786 | { | |
787 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
788 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
789 | CORE_ADDR result; | |
790 | int rc; | |
791 | ||
792 | if (pt->rw_active == SCM_PORT_WRITE) | |
793 | { | |
794 | if (offset != 0 || whence != SEEK_CUR) | |
795 | { | |
796 | gdbscm_memory_port_flush (port); | |
797 | rc = ioscm_lseek_address (iomem, offset, whence); | |
798 | result = iomem->current; | |
799 | } | |
800 | else | |
801 | { | |
802 | /* Read current position without disturbing the buffer, | |
803 | but flag an error if what's in the buffer goes outside the | |
804 | allowed range. */ | |
805 | CORE_ADDR current = iomem->current; | |
806 | size_t delta = pt->write_pos - pt->write_buf; | |
807 | ||
808 | if (current + delta < current | |
37442ce1 | 809 | || current + delta > iomem->size) |
ed3ef339 DE |
810 | rc = 0; |
811 | else | |
812 | { | |
813 | result = current + delta; | |
814 | rc = 1; | |
815 | } | |
816 | } | |
817 | } | |
818 | else if (pt->rw_active == SCM_PORT_READ) | |
819 | { | |
820 | if (offset != 0 || whence != SEEK_CUR) | |
821 | { | |
822 | scm_end_input (port); | |
823 | rc = ioscm_lseek_address (iomem, offset, whence); | |
824 | result = iomem->current; | |
825 | } | |
826 | else | |
827 | { | |
828 | /* Read current position without disturbing the buffer | |
829 | (particularly the unread-char buffer). */ | |
830 | CORE_ADDR current = iomem->current; | |
831 | size_t remaining = pt->read_end - pt->read_pos; | |
832 | ||
833 | if (current - remaining > current | |
834 | || current - remaining < iomem->start) | |
835 | rc = 0; | |
836 | else | |
837 | { | |
838 | result = current - remaining; | |
839 | rc = 1; | |
840 | } | |
841 | ||
842 | if (rc != 0 && pt->read_buf == pt->putback_buf) | |
843 | { | |
844 | size_t saved_remaining = pt->saved_read_end - pt->saved_read_pos; | |
845 | ||
846 | if (result - saved_remaining > result | |
847 | || result - saved_remaining < iomem->start) | |
848 | rc = 0; | |
849 | else | |
850 | result -= saved_remaining; | |
851 | } | |
852 | } | |
853 | } | |
854 | else /* SCM_PORT_NEITHER */ | |
855 | { | |
856 | rc = ioscm_lseek_address (iomem, offset, whence); | |
857 | result = iomem->current; | |
858 | } | |
859 | ||
860 | if (rc == 0) | |
861 | { | |
862 | gdbscm_out_of_range_error (FUNC_NAME, 0, | |
863 | gdbscm_scm_from_longest (offset), | |
864 | _("bad seek")); | |
865 | } | |
866 | ||
867 | /* TODO: The Guile API doesn't support 32x64. We can't fix that here, | |
868 | and there's no need to throw an error if the new address can't be | |
869 | represented in a scm_t_off. But we could return something less | |
870 | clumsy. */ | |
871 | return result; | |
872 | } | |
873 | ||
874 | /* "close" method for memory ports. */ | |
875 | ||
876 | static int | |
877 | gdbscm_memory_port_close (SCM port) | |
878 | { | |
879 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
880 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
881 | ||
882 | gdbscm_memory_port_flush (port); | |
883 | ||
884 | if (pt->read_buf == pt->putback_buf) | |
885 | pt->read_buf = pt->saved_read_buf; | |
37442ce1 DE |
886 | if (pt->read_buf != &pt->shortbuf) |
887 | xfree (pt->read_buf); | |
888 | if (pt->write_buf != &pt->shortbuf) | |
889 | xfree (pt->write_buf); | |
ed3ef339 DE |
890 | scm_gc_free (iomem, sizeof (*iomem), "memory port"); |
891 | ||
892 | return 0; | |
893 | } | |
894 | ||
895 | /* "free" method for memory ports. */ | |
896 | ||
897 | static size_t | |
898 | gdbscm_memory_port_free (SCM port) | |
899 | { | |
900 | gdbscm_memory_port_close (port); | |
901 | ||
902 | return 0; | |
903 | } | |
904 | ||
905 | /* "print" method for memory ports. */ | |
906 | ||
907 | static int | |
908 | gdbscm_memory_port_print (SCM exp, SCM port, scm_print_state *pstate) | |
909 | { | |
910 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (exp); | |
911 | char *type = SCM_PTOBNAME (SCM_PTOBNUM (exp)); | |
912 | ||
913 | scm_puts ("#<", port); | |
914 | scm_print_port_mode (exp, port); | |
915 | /* scm_print_port_mode includes a trailing space. */ | |
916 | gdbscm_printf (port, "%s %s-%s", type, | |
917 | hex_string (iomem->start), hex_string (iomem->end)); | |
918 | scm_putc ('>', port); | |
919 | return 1; | |
920 | } | |
921 | ||
922 | /* Create the port type used for memory. */ | |
923 | ||
924 | static void | |
925 | ioscm_init_memory_port_type (void) | |
926 | { | |
927 | memory_port_desc = scm_make_port_type (memory_port_desc_name, | |
928 | gdbscm_memory_port_fill_input, | |
929 | gdbscm_memory_port_write); | |
930 | ||
931 | scm_set_port_end_input (memory_port_desc, gdbscm_memory_port_end_input); | |
932 | scm_set_port_flush (memory_port_desc, gdbscm_memory_port_flush); | |
933 | scm_set_port_seek (memory_port_desc, gdbscm_memory_port_seek); | |
934 | scm_set_port_close (memory_port_desc, gdbscm_memory_port_close); | |
935 | scm_set_port_free (memory_port_desc, gdbscm_memory_port_free); | |
936 | scm_set_port_print (memory_port_desc, gdbscm_memory_port_print); | |
937 | } | |
938 | ||
939 | /* Helper for gdbscm_open_memory to parse the mode bits. | |
940 | An exception is thrown if MODE is invalid. */ | |
941 | ||
942 | static long | |
943 | ioscm_parse_mode_bits (const char *func_name, const char *mode) | |
944 | { | |
945 | const char *p; | |
946 | long mode_bits; | |
947 | ||
948 | if (*mode != 'r' && *mode != 'w') | |
949 | { | |
950 | gdbscm_out_of_range_error (func_name, 0, | |
951 | gdbscm_scm_from_c_string (mode), | |
952 | _("bad mode string")); | |
953 | } | |
954 | for (p = mode + 1; *p != '\0'; ++p) | |
955 | { | |
956 | switch (*p) | |
957 | { | |
37442ce1 | 958 | case '0': |
ed3ef339 DE |
959 | case 'b': |
960 | case '+': | |
961 | break; | |
962 | default: | |
963 | gdbscm_out_of_range_error (func_name, 0, | |
964 | gdbscm_scm_from_c_string (mode), | |
965 | _("bad mode string")); | |
966 | } | |
967 | } | |
968 | ||
969 | /* Kinda awkward to convert the mode from SCM -> string only to have Guile | |
970 | convert it back to SCM, but that's the API we have to work with. */ | |
971 | mode_bits = scm_mode_bits ((char *) mode); | |
972 | ||
973 | return mode_bits; | |
974 | } | |
975 | ||
976 | /* Helper for gdbscm_open_memory to finish initializing the port. | |
37442ce1 DE |
977 | The port has address range [start,end). |
978 | This means that address of 0xff..ff is not accessible. | |
ed3ef339 DE |
979 | I can live with that. */ |
980 | ||
981 | static void | |
982 | ioscm_init_memory_port (SCM port, CORE_ADDR start, CORE_ADDR end) | |
983 | { | |
984 | scm_t_port *pt; | |
985 | ioscm_memory_port *iomem; | |
37442ce1 | 986 | int buffered = (SCM_CELL_WORD_0 (port) & SCM_BUF0) == 0; |
ed3ef339 DE |
987 | |
988 | gdb_assert (start <= end); | |
ed3ef339 DE |
989 | |
990 | iomem = (ioscm_memory_port *) scm_gc_malloc_pointerless (sizeof (*iomem), | |
991 | "memory port"); | |
992 | ||
993 | iomem->start = start; | |
994 | iomem->end = end; | |
37442ce1 | 995 | iomem->size = end - start; |
ed3ef339 | 996 | iomem->current = 0; |
37442ce1 DE |
997 | if (buffered) |
998 | { | |
999 | iomem->read_buf_size = default_read_buf_size; | |
1000 | iomem->write_buf_size = default_write_buf_size; | |
1001 | } | |
1002 | else | |
1003 | { | |
1004 | iomem->read_buf_size = 1; | |
1005 | iomem->write_buf_size = 1; | |
1006 | } | |
ed3ef339 DE |
1007 | |
1008 | pt = SCM_PTAB_ENTRY (port); | |
1009 | /* Match the expectation of `binary-port?'. */ | |
1010 | pt->encoding = NULL; | |
1011 | pt->rw_random = 1; | |
1012 | pt->read_buf_size = iomem->read_buf_size; | |
ed3ef339 | 1013 | pt->write_buf_size = iomem->write_buf_size; |
37442ce1 DE |
1014 | if (buffered) |
1015 | { | |
224c3ddb SM |
1016 | pt->read_buf = (unsigned char *) xmalloc (pt->read_buf_size); |
1017 | pt->write_buf = (unsigned char *) xmalloc (pt->write_buf_size); | |
37442ce1 DE |
1018 | } |
1019 | else | |
1020 | { | |
1021 | pt->read_buf = &pt->shortbuf; | |
1022 | pt->write_buf = &pt->shortbuf; | |
1023 | } | |
1024 | pt->read_pos = pt->read_end = pt->read_buf; | |
ed3ef339 DE |
1025 | pt->write_pos = pt->write_buf; |
1026 | pt->write_end = pt->write_buf + pt->write_buf_size; | |
1027 | ||
1028 | SCM_SETSTREAM (port, iomem); | |
1029 | } | |
1030 | ||
1031 | /* Re-initialize a memory port, updating its read/write buffer sizes. | |
37442ce1 DE |
1032 | An exception is thrown if the port is unbuffered. |
1033 | TODO: Allow switching buffered/unbuffered. | |
1034 | An exception is also thrown if data is still buffered, except in the case | |
ed3ef339 DE |
1035 | where the buffer size isn't changing (since that's just a nop). */ |
1036 | ||
1037 | static void | |
1038 | ioscm_reinit_memory_port (SCM port, size_t read_buf_size, | |
1039 | size_t write_buf_size, const char *func_name) | |
1040 | { | |
1041 | scm_t_port *pt = SCM_PTAB_ENTRY (port); | |
1042 | ioscm_memory_port *iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
1043 | ||
1044 | gdb_assert (read_buf_size >= min_memory_port_buf_size | |
1045 | && read_buf_size <= max_memory_port_buf_size); | |
1046 | gdb_assert (write_buf_size >= min_memory_port_buf_size | |
1047 | && write_buf_size <= max_memory_port_buf_size); | |
1048 | ||
37442ce1 DE |
1049 | /* First check if the port is unbuffered. */ |
1050 | ||
1051 | if (pt->read_buf == &pt->shortbuf) | |
1052 | { | |
1053 | gdb_assert (pt->write_buf == &pt->shortbuf); | |
1054 | scm_misc_error (func_name, _("port is unbuffered: ~a"), | |
1055 | scm_list_1 (port)); | |
1056 | } | |
1057 | ||
1058 | /* Next check if anything is buffered. */ | |
ed3ef339 DE |
1059 | |
1060 | if (read_buf_size != pt->read_buf_size | |
1061 | && pt->read_end != pt->read_buf) | |
1062 | { | |
1063 | scm_misc_error (func_name, _("read buffer not empty: ~a"), | |
1064 | scm_list_1 (port)); | |
1065 | } | |
1066 | ||
1067 | if (write_buf_size != pt->write_buf_size | |
1068 | && pt->write_pos != pt->write_buf) | |
1069 | { | |
1070 | scm_misc_error (func_name, _("write buffer not empty: ~a"), | |
1071 | scm_list_1 (port)); | |
1072 | } | |
1073 | ||
1074 | /* Now we can update the buffer sizes, but only if the size has changed. */ | |
1075 | ||
1076 | if (read_buf_size != pt->read_buf_size) | |
1077 | { | |
1078 | iomem->read_buf_size = read_buf_size; | |
1079 | pt->read_buf_size = read_buf_size; | |
1080 | xfree (pt->read_buf); | |
224c3ddb | 1081 | pt->read_buf = (unsigned char *) xmalloc (pt->read_buf_size); |
ed3ef339 DE |
1082 | pt->read_pos = pt->read_end = pt->read_buf; |
1083 | } | |
1084 | ||
1085 | if (write_buf_size != pt->write_buf_size) | |
1086 | { | |
1087 | iomem->write_buf_size = write_buf_size; | |
1088 | pt->write_buf_size = write_buf_size; | |
1089 | xfree (pt->write_buf); | |
224c3ddb | 1090 | pt->write_buf = (unsigned char *) xmalloc (pt->write_buf_size); |
ed3ef339 DE |
1091 | pt->write_pos = pt->write_buf; |
1092 | pt->write_end = pt->write_buf + pt->write_buf_size; | |
1093 | } | |
1094 | } | |
1095 | ||
1096 | /* (open-memory [#:mode string] [#:start address] [#:size integer]) -> port | |
1097 | Return a port that can be used for reading and writing memory. | |
1098 | MODE is a string, and must be one of "r", "w", or "r+". | |
37442ce1 DE |
1099 | "0" may be appended to MODE to mark the port as unbuffered. |
1100 | For compatibility "b" (binary) may also be appended, but we ignore it: | |
ed3ef339 DE |
1101 | memory ports are binary only. |
1102 | ||
ed3ef339 | 1103 | The chunk of memory that can be accessed can be bounded. |
37442ce1 DE |
1104 | If both START,SIZE are unspecified, all of memory can be accessed |
1105 | (except 0xff..ff). If only START is specified, all of memory from that | |
1106 | point on can be accessed (except 0xff..ff). If only SIZE if specified, | |
1107 | all memory in [0,SIZE) can be accessed. If both are specified, all memory | |
1108 | in [START,START+SIZE) can be accessed. | |
ed3ef339 DE |
1109 | |
1110 | Note: If it becomes useful enough we can later add #:end as an alternative | |
1111 | to #:size. For now it is left out. | |
1112 | ||
1113 | The result is a Scheme port, and its semantics are a bit odd for accessing | |
1114 | memory (e.g., unget), but we don't try to hide this. It's a port. | |
1115 | ||
37442ce1 | 1116 | N.B. Seeks on the port must be in the range [0,size]. |
ed3ef339 DE |
1117 | This is for similarity with bytevector ports, and so that one can seek |
1118 | to the first byte. */ | |
1119 | ||
1120 | static SCM | |
1121 | gdbscm_open_memory (SCM rest) | |
1122 | { | |
1123 | const SCM keywords[] = { | |
1124 | mode_keyword, start_keyword, size_keyword, SCM_BOOL_F | |
1125 | }; | |
1126 | char *mode = NULL; | |
1127 | CORE_ADDR start = 0; | |
1128 | CORE_ADDR end; | |
1129 | int mode_arg_pos = -1, start_arg_pos = -1, size_arg_pos = -1; | |
1130 | ULONGEST size; | |
1131 | SCM port; | |
1132 | long mode_bits; | |
1133 | ||
1134 | gdbscm_parse_function_args (FUNC_NAME, SCM_ARG1, keywords, "#sUU", rest, | |
1135 | &mode_arg_pos, &mode, | |
1136 | &start_arg_pos, &start, | |
1137 | &size_arg_pos, &size); | |
1138 | ||
1139 | scm_dynwind_begin (0); | |
1140 | ||
1141 | if (mode == NULL) | |
1142 | mode = xstrdup ("r"); | |
1143 | scm_dynwind_free (mode); | |
1144 | ||
ed3ef339 DE |
1145 | if (size_arg_pos > 0) |
1146 | { | |
ed3ef339 DE |
1147 | /* For now be strict about start+size overflowing. If it becomes |
1148 | a nuisance we can relax things later. */ | |
1149 | if (start + size < start) | |
1150 | { | |
1151 | gdbscm_out_of_range_error (FUNC_NAME, 0, | |
1152 | scm_list_2 (gdbscm_scm_from_ulongest (start), | |
1153 | gdbscm_scm_from_ulongest (size)), | |
1154 | _("start+size overflows")); | |
1155 | } | |
37442ce1 | 1156 | end = start + size; |
ed3ef339 DE |
1157 | } |
1158 | else | |
37442ce1 | 1159 | end = ~(CORE_ADDR) 0; |
ed3ef339 DE |
1160 | |
1161 | mode_bits = ioscm_parse_mode_bits (FUNC_NAME, mode); | |
1162 | ||
1163 | port = ioscm_open_port (memory_port_desc, mode_bits); | |
1164 | ||
1165 | ioscm_init_memory_port (port, start, end); | |
1166 | ||
1167 | scm_dynwind_end (); | |
1168 | ||
1169 | /* TODO: Set the file name as "memory-start-end"? */ | |
1170 | return port; | |
1171 | } | |
1172 | ||
1173 | /* Return non-zero if OBJ is a memory port. */ | |
1174 | ||
1175 | static int | |
1176 | gdbscm_is_memory_port (SCM obj) | |
1177 | { | |
1178 | return !SCM_IMP (obj) && (SCM_TYP16 (obj) == memory_port_desc); | |
1179 | } | |
1180 | ||
1181 | /* (memory-port? obj) -> boolean */ | |
1182 | ||
1183 | static SCM | |
1184 | gdbscm_memory_port_p (SCM obj) | |
1185 | { | |
1186 | return scm_from_bool (gdbscm_is_memory_port (obj)); | |
1187 | } | |
1188 | ||
1189 | /* (memory-port-range port) -> (start end) */ | |
1190 | ||
1191 | static SCM | |
1192 | gdbscm_memory_port_range (SCM port) | |
1193 | { | |
1194 | ioscm_memory_port *iomem; | |
1195 | ||
1196 | SCM_ASSERT_TYPE (gdbscm_is_memory_port (port), port, SCM_ARG1, FUNC_NAME, | |
1197 | memory_port_desc_name); | |
1198 | ||
1199 | iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
1200 | return scm_list_2 (gdbscm_scm_from_ulongest (iomem->start), | |
1201 | gdbscm_scm_from_ulongest (iomem->end)); | |
1202 | } | |
1203 | ||
1204 | /* (memory-port-read-buffer-size port) -> integer */ | |
1205 | ||
1206 | static SCM | |
1207 | gdbscm_memory_port_read_buffer_size (SCM port) | |
1208 | { | |
1209 | ioscm_memory_port *iomem; | |
1210 | ||
1211 | SCM_ASSERT_TYPE (gdbscm_is_memory_port (port), port, SCM_ARG1, FUNC_NAME, | |
1212 | memory_port_desc_name); | |
1213 | ||
1214 | iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
1215 | return scm_from_uint (iomem->read_buf_size); | |
1216 | } | |
1217 | ||
1218 | /* (set-memory-port-read-buffer-size! port size) -> unspecified | |
37442ce1 DE |
1219 | An exception is thrown if read data is still buffered or if the port |
1220 | is unbuffered. */ | |
ed3ef339 DE |
1221 | |
1222 | static SCM | |
1223 | gdbscm_set_memory_port_read_buffer_size_x (SCM port, SCM size) | |
1224 | { | |
1225 | ioscm_memory_port *iomem; | |
1226 | ||
1227 | SCM_ASSERT_TYPE (gdbscm_is_memory_port (port), port, SCM_ARG1, FUNC_NAME, | |
1228 | memory_port_desc_name); | |
1229 | SCM_ASSERT_TYPE (scm_is_integer (size), size, SCM_ARG2, FUNC_NAME, | |
1230 | _("integer")); | |
1231 | ||
1232 | if (!scm_is_unsigned_integer (size, min_memory_port_buf_size, | |
1233 | max_memory_port_buf_size)) | |
1234 | { | |
1235 | gdbscm_out_of_range_error (FUNC_NAME, SCM_ARG2, size, | |
1236 | out_of_range_buf_size); | |
1237 | } | |
1238 | ||
1239 | iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
1240 | ioscm_reinit_memory_port (port, scm_to_uint (size), iomem->write_buf_size, | |
1241 | FUNC_NAME); | |
1242 | ||
1243 | return SCM_UNSPECIFIED; | |
1244 | } | |
1245 | ||
1246 | /* (memory-port-write-buffer-size port) -> integer */ | |
1247 | ||
1248 | static SCM | |
1249 | gdbscm_memory_port_write_buffer_size (SCM port) | |
1250 | { | |
1251 | ioscm_memory_port *iomem; | |
1252 | ||
1253 | SCM_ASSERT_TYPE (gdbscm_is_memory_port (port), port, SCM_ARG1, FUNC_NAME, | |
1254 | memory_port_desc_name); | |
1255 | ||
1256 | iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
1257 | return scm_from_uint (iomem->write_buf_size); | |
1258 | } | |
1259 | ||
1260 | /* (set-memory-port-write-buffer-size! port size) -> unspecified | |
37442ce1 DE |
1261 | An exception is thrown if write data is still buffered or if the port |
1262 | is unbuffered. */ | |
ed3ef339 DE |
1263 | |
1264 | static SCM | |
1265 | gdbscm_set_memory_port_write_buffer_size_x (SCM port, SCM size) | |
1266 | { | |
1267 | ioscm_memory_port *iomem; | |
1268 | ||
1269 | SCM_ASSERT_TYPE (gdbscm_is_memory_port (port), port, SCM_ARG1, FUNC_NAME, | |
1270 | memory_port_desc_name); | |
1271 | SCM_ASSERT_TYPE (scm_is_integer (size), size, SCM_ARG2, FUNC_NAME, | |
1272 | _("integer")); | |
1273 | ||
1274 | if (!scm_is_unsigned_integer (size, min_memory_port_buf_size, | |
1275 | max_memory_port_buf_size)) | |
1276 | { | |
1277 | gdbscm_out_of_range_error (FUNC_NAME, SCM_ARG2, size, | |
1278 | out_of_range_buf_size); | |
1279 | } | |
1280 | ||
1281 | iomem = (ioscm_memory_port *) SCM_STREAM (port); | |
1282 | ioscm_reinit_memory_port (port, iomem->read_buf_size, scm_to_uint (size), | |
1283 | FUNC_NAME); | |
1284 | ||
1285 | return SCM_UNSPECIFIED; | |
1286 | } | |
1287 | \f | |
1288 | /* Initialize gdb ports. */ | |
1289 | ||
1290 | static const scheme_function port_functions[] = | |
1291 | { | |
72e02483 | 1292 | { "input-port", 0, 0, 0, as_a_scm_t_subr (gdbscm_input_port), |
ed3ef339 DE |
1293 | "\ |
1294 | Return gdb's input port." }, | |
1295 | ||
72e02483 | 1296 | { "output-port", 0, 0, 0, as_a_scm_t_subr (gdbscm_output_port), |
ed3ef339 DE |
1297 | "\ |
1298 | Return gdb's output port." }, | |
1299 | ||
72e02483 | 1300 | { "error-port", 0, 0, 0, as_a_scm_t_subr (gdbscm_error_port), |
ed3ef339 DE |
1301 | "\ |
1302 | Return gdb's error port." }, | |
1303 | ||
72e02483 | 1304 | { "stdio-port?", 1, 0, 0, as_a_scm_t_subr (gdbscm_stdio_port_p), |
ed3ef339 DE |
1305 | "\ |
1306 | Return #t if the object is a gdb:stdio-port." }, | |
1307 | ||
72e02483 | 1308 | { "open-memory", 0, 0, 1, as_a_scm_t_subr (gdbscm_open_memory), |
ed3ef339 DE |
1309 | "\ |
1310 | Return a port that can be used for reading/writing inferior memory.\n\ | |
1311 | \n\ | |
1312 | Arguments: [#:mode string] [#:start address] [#:size integer]\n\ | |
1313 | Returns: A port object." }, | |
1314 | ||
72e02483 | 1315 | { "memory-port?", 1, 0, 0, as_a_scm_t_subr (gdbscm_memory_port_p), |
ed3ef339 DE |
1316 | "\ |
1317 | Return #t if the object is a memory port." }, | |
1318 | ||
72e02483 | 1319 | { "memory-port-range", 1, 0, 0, as_a_scm_t_subr (gdbscm_memory_port_range), |
ed3ef339 DE |
1320 | "\ |
1321 | Return the memory range of the port as (start end)." }, | |
1322 | ||
1323 | { "memory-port-read-buffer-size", 1, 0, 0, | |
72e02483 | 1324 | as_a_scm_t_subr (gdbscm_memory_port_read_buffer_size), |
ed3ef339 DE |
1325 | "\ |
1326 | Return the size of the read buffer for the memory port." }, | |
1327 | ||
1328 | { "set-memory-port-read-buffer-size!", 2, 0, 0, | |
72e02483 | 1329 | as_a_scm_t_subr (gdbscm_set_memory_port_read_buffer_size_x), |
ed3ef339 DE |
1330 | "\ |
1331 | Set the size of the read buffer for the memory port.\n\ | |
1332 | \n\ | |
1333 | Arguments: port integer\n\ | |
1334 | Returns: unspecified." }, | |
1335 | ||
1336 | { "memory-port-write-buffer-size", 1, 0, 0, | |
72e02483 | 1337 | as_a_scm_t_subr (gdbscm_memory_port_write_buffer_size), |
ed3ef339 DE |
1338 | "\ |
1339 | Return the size of the write buffer for the memory port." }, | |
1340 | ||
1341 | { "set-memory-port-write-buffer-size!", 2, 0, 0, | |
72e02483 | 1342 | as_a_scm_t_subr (gdbscm_set_memory_port_write_buffer_size_x), |
ed3ef339 DE |
1343 | "\ |
1344 | Set the size of the write buffer for the memory port.\n\ | |
1345 | \n\ | |
1346 | Arguments: port integer\n\ | |
1347 | Returns: unspecified." }, | |
1348 | ||
1349 | END_FUNCTIONS | |
1350 | }; | |
1351 | ||
1352 | static const scheme_function private_port_functions[] = | |
1353 | { | |
1354 | #if 0 /* TODO */ | |
1355 | { "%with-gdb-input-from-port", 2, 0, 0, | |
72e02483 | 1356 | as_a_scm_t_subr (gdbscm_percent_with_gdb_input_from_port), |
ed3ef339 DE |
1357 | "\ |
1358 | Temporarily set GDB's input port to PORT and then invoke THUNK.\n\ | |
1359 | \n\ | |
1360 | Arguments: port thunk\n\ | |
1361 | Returns: The result of calling THUNK.\n\ | |
1362 | \n\ | |
1363 | This procedure is experimental." }, | |
1364 | #endif | |
1365 | ||
1366 | { "%with-gdb-output-to-port", 2, 0, 0, | |
72e02483 | 1367 | as_a_scm_t_subr (gdbscm_percent_with_gdb_output_to_port), |
ed3ef339 DE |
1368 | "\ |
1369 | Temporarily set GDB's output port to PORT and then invoke THUNK.\n\ | |
1370 | \n\ | |
1371 | Arguments: port thunk\n\ | |
1372 | Returns: The result of calling THUNK.\n\ | |
1373 | \n\ | |
1374 | This procedure is experimental." }, | |
1375 | ||
1376 | { "%with-gdb-error-to-port", 2, 0, 0, | |
72e02483 | 1377 | as_a_scm_t_subr (gdbscm_percent_with_gdb_error_to_port), |
ed3ef339 DE |
1378 | "\ |
1379 | Temporarily set GDB's error port to PORT and then invoke THUNK.\n\ | |
1380 | \n\ | |
1381 | Arguments: port thunk\n\ | |
1382 | Returns: The result of calling THUNK.\n\ | |
1383 | \n\ | |
1384 | This procedure is experimental." }, | |
1385 | ||
1386 | END_FUNCTIONS | |
1387 | }; | |
1388 | ||
1389 | void | |
1390 | gdbscm_initialize_ports (void) | |
1391 | { | |
1392 | /* Save the original stdio ports for debugging purposes. */ | |
1393 | ||
1394 | orig_input_port_scm = scm_current_input_port (); | |
1395 | orig_output_port_scm = scm_current_output_port (); | |
1396 | orig_error_port_scm = scm_current_error_port (); | |
1397 | ||
1398 | /* Set up the stdio ports. */ | |
1399 | ||
1400 | ioscm_init_gdb_stdio_port (); | |
1401 | input_port_scm = ioscm_make_gdb_stdio_port (0); | |
1402 | output_port_scm = ioscm_make_gdb_stdio_port (1); | |
1403 | error_port_scm = ioscm_make_gdb_stdio_port (2); | |
1404 | ||
1405 | /* Set up memory ports. */ | |
1406 | ||
1407 | ioscm_init_memory_port_type (); | |
1408 | ||
1409 | /* Install the accessor functions. */ | |
1410 | ||
1411 | gdbscm_define_functions (port_functions, 1); | |
1412 | gdbscm_define_functions (private_port_functions, 0); | |
1413 | ||
1414 | /* Keyword args for open-memory. */ | |
1415 | ||
1416 | mode_keyword = scm_from_latin1_keyword ("mode"); | |
1417 | start_keyword = scm_from_latin1_keyword ("start"); | |
1418 | size_keyword = scm_from_latin1_keyword ("size"); | |
1419 | ||
1420 | /* Error message text for "out of range" memory port buffer sizes. */ | |
1421 | ||
1422 | out_of_range_buf_size = xstrprintf ("size not between %u - %u", | |
1423 | min_memory_port_buf_size, | |
1424 | max_memory_port_buf_size); | |
1425 | } |