1 /* Host file transfer support for gdbserver.
2 Copyright (C) 2007-2015 Free Software Foundation, Inc.
4 Contributed by CodeSourcery.
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/>. */
22 #include "gdb/fileio.h"
28 #include <sys/types.h>
32 extern int remote_debug
;
40 static struct fd_list
*open_fds
;
43 safe_fromhex (char a
, int *nibble
)
45 if (a
>= '0' && a
<= '9')
47 else if (a
>= 'a' && a
<= 'f')
48 *nibble
= a
- 'a' + 10;
49 else if (a
>= 'A' && a
<= 'F')
50 *nibble
= a
- 'A' + 10;
57 /* Filenames are hex encoded, so the maximum we can handle is half the
58 packet buffer size. Cap to PATH_MAX, if it is shorter. */
59 #if !defined (PATH_MAX) || (PATH_MAX > (PBUFSIZ / 2 + 1))
60 # define HOSTIO_PATH_MAX (PBUFSIZ / 2 + 1)
62 # define HOSTIO_PATH_MAX PATH_MAX
66 require_filename (char **pp
, char *filename
)
74 while (*p
&& *p
!= ',')
78 /* Don't allow overflow. */
79 if (count
>= HOSTIO_PATH_MAX
- 1)
82 if (safe_fromhex (p
[0], &nib1
)
83 || safe_fromhex (p
[1], &nib2
))
86 filename
[count
++] = nib1
* 16 + nib2
;
90 filename
[count
] = '\0';
96 require_int (char **pp
, int *value
)
105 while (*p
&& *p
!= ',')
109 /* Don't allow overflow. */
113 if (safe_fromhex (p
[0], &nib
))
115 *value
= *value
* 16 + nib
;
125 require_data (char *p
, int p_len
, char **data
, int *data_len
)
127 int input_index
, output_index
, escaped
;
129 *data
= xmalloc (p_len
);
133 for (input_index
= 0; input_index
< p_len
; input_index
++)
135 char b
= p
[input_index
];
139 (*data
)[output_index
++] = b
^ 0x20;
145 (*data
)[output_index
++] = b
;
154 *data_len
= output_index
;
159 require_comma (char **pp
)
171 require_end (char *p
)
180 require_valid_fd (int fd
)
182 struct fd_list
*fd_ptr
;
184 for (fd_ptr
= open_fds
; fd_ptr
!= NULL
; fd_ptr
= fd_ptr
->next
)
185 if (fd_ptr
->fd
== fd
)
191 /* Fill in own_buf with the last hostio error packet, however it
192 suitable for the target. */
194 hostio_error (char *own_buf
)
196 the_target
->hostio_last_error (own_buf
);
200 hostio_packet_error (char *own_buf
)
202 sprintf (own_buf
, "F-1,%x", FILEIO_EINVAL
);
206 hostio_reply (char *own_buf
, int result
)
208 sprintf (own_buf
, "F%x", result
);
212 hostio_reply_with_data (char *own_buf
, char *buffer
, int len
,
215 int input_index
, output_index
, out_maxlen
;
217 sprintf (own_buf
, "F%x;", len
);
218 output_index
= strlen (own_buf
);
220 out_maxlen
= PBUFSIZ
;
222 for (input_index
= 0; input_index
< len
; input_index
++)
224 char b
= buffer
[input_index
];
226 if (b
== '$' || b
== '#' || b
== '}' || b
== '*')
228 /* These must be escaped. */
229 if (output_index
+ 2 > out_maxlen
)
231 own_buf
[output_index
++] = '}';
232 own_buf
[output_index
++] = b
^ 0x20;
236 if (output_index
+ 1 > out_maxlen
)
238 own_buf
[output_index
++] = b
;
242 *new_packet_len
= output_index
;
246 /* Process ID of inferior whose filesystem hostio functions
247 that take FILENAME arguments will use. Zero means to use
248 our own filesystem. */
250 static int hostio_fs_pid
;
255 hostio_handle_new_gdb_connection (void)
260 /* Handle a "vFile:setfs:" packet. */
263 handle_setfs (char *own_buf
)
268 /* If the target doesn't have any of the in-filesystem-of methods
269 then there's no point in GDB sending "vFile:setfs:" packets. We
270 reply with an empty packet (i.e. we pretend we don't understand
271 "vFile:setfs:") and that should stop GDB sending any more. */
272 if (the_target
->multifs_open
== NULL
273 && the_target
->multifs_unlink
== NULL
274 && the_target
->multifs_readlink
== NULL
)
280 p
= own_buf
+ strlen ("vFile:setfs:");
282 if (require_int (&p
, &pid
)
286 hostio_packet_error (own_buf
);
292 hostio_reply (own_buf
, 0);
296 handle_open (char *own_buf
)
298 char filename
[HOSTIO_PATH_MAX
];
300 int fileio_flags
, fileio_mode
, flags
, fd
;
302 struct fd_list
*new_fd
;
304 p
= own_buf
+ strlen ("vFile:open:");
306 if (require_filename (&p
, filename
)
307 || require_comma (&p
)
308 || require_int (&p
, &fileio_flags
)
309 || require_comma (&p
)
310 || require_int (&p
, &fileio_mode
)
312 || fileio_to_host_openflags (fileio_flags
, &flags
)
313 || fileio_to_host_mode (fileio_mode
, &mode
))
315 hostio_packet_error (own_buf
);
319 /* We do not need to convert MODE, since the fileio protocol
320 uses the standard values. */
321 if (hostio_fs_pid
!= 0 && the_target
->multifs_open
!= NULL
)
322 fd
= the_target
->multifs_open (hostio_fs_pid
, filename
,
325 fd
= open (filename
, flags
, mode
);
329 hostio_error (own_buf
);
333 /* Record the new file descriptor. */
334 new_fd
= xmalloc (sizeof (struct fd_list
));
336 new_fd
->next
= open_fds
;
339 hostio_reply (own_buf
, fd
);
343 handle_pread (char *own_buf
, int *new_packet_len
)
345 int fd
, ret
, len
, offset
, bytes_sent
;
347 static int max_reply_size
= -1;
349 p
= own_buf
+ strlen ("vFile:pread:");
351 if (require_int (&p
, &fd
)
352 || require_comma (&p
)
353 || require_valid_fd (fd
)
354 || require_int (&p
, &len
)
355 || require_comma (&p
)
356 || require_int (&p
, &offset
)
359 hostio_packet_error (own_buf
);
363 /* Do not attempt to read more than the maximum number of bytes
364 hostio_reply_with_data can fit in a packet. We may still read
365 too much because of escaping, but this is handled below. */
366 if (max_reply_size
== -1)
368 sprintf (own_buf
, "F%x;", PBUFSIZ
);
369 max_reply_size
= PBUFSIZ
- strlen (own_buf
);
371 if (len
> max_reply_size
)
372 len
= max_reply_size
;
374 data
= xmalloc (len
);
376 ret
= pread (fd
, data
, len
, offset
);
380 /* If we have no pread or it failed for this file, use lseek/read. */
383 ret
= lseek (fd
, offset
, SEEK_SET
);
385 ret
= read (fd
, data
, len
);
390 hostio_error (own_buf
);
395 bytes_sent
= hostio_reply_with_data (own_buf
, data
, ret
, new_packet_len
);
397 /* If we were using read, and the data did not all fit in the reply,
398 we would have to back up using lseek here. With pread it does
399 not matter. But we still have a problem; the return value in the
400 packet might be wrong, so we must fix it. This time it will
402 if (bytes_sent
< ret
)
403 bytes_sent
= hostio_reply_with_data (own_buf
, data
, bytes_sent
,
410 handle_pwrite (char *own_buf
, int packet_len
)
412 int fd
, ret
, len
, offset
;
415 p
= own_buf
+ strlen ("vFile:pwrite:");
417 if (require_int (&p
, &fd
)
418 || require_comma (&p
)
419 || require_valid_fd (fd
)
420 || require_int (&p
, &offset
)
421 || require_comma (&p
)
422 || require_data (p
, packet_len
- (p
- own_buf
), &data
, &len
))
424 hostio_packet_error (own_buf
);
429 ret
= pwrite (fd
, data
, len
, offset
);
433 /* If we have no pwrite or it failed for this file, use lseek/write. */
436 ret
= lseek (fd
, offset
, SEEK_SET
);
438 ret
= write (fd
, data
, len
);
443 hostio_error (own_buf
);
448 hostio_reply (own_buf
, ret
);
453 handle_fstat (char *own_buf
, int *new_packet_len
)
460 p
= own_buf
+ strlen ("vFile:fstat:");
462 if (require_int (&p
, &fd
)
463 || require_valid_fd (fd
)
466 hostio_packet_error (own_buf
);
470 if (fstat (fd
, &st
) == -1)
472 hostio_error (own_buf
);
476 host_to_fileio_stat (&st
, &fst
);
478 bytes_sent
= hostio_reply_with_data (own_buf
,
479 (char *) &fst
, sizeof (fst
),
482 /* If the response does not fit into a single packet, do not attempt
483 to return a partial response, but simply fail. */
484 if (bytes_sent
< sizeof (fst
))
489 handle_close (char *own_buf
)
493 struct fd_list
**open_fd_p
, *old_fd
;
495 p
= own_buf
+ strlen ("vFile:close:");
497 if (require_int (&p
, &fd
)
498 || require_valid_fd (fd
)
501 hostio_packet_error (own_buf
);
509 hostio_error (own_buf
);
513 open_fd_p
= &open_fds
;
514 /* We know that fd is in the list, thanks to require_valid_fd. */
515 while ((*open_fd_p
)->fd
!= fd
)
516 open_fd_p
= &(*open_fd_p
)->next
;
519 *open_fd_p
= (*open_fd_p
)->next
;
522 hostio_reply (own_buf
, ret
);
526 handle_unlink (char *own_buf
)
528 char filename
[HOSTIO_PATH_MAX
];
532 p
= own_buf
+ strlen ("vFile:unlink:");
534 if (require_filename (&p
, filename
)
537 hostio_packet_error (own_buf
);
541 if (hostio_fs_pid
!= 0 && the_target
->multifs_unlink
!= NULL
)
542 ret
= the_target
->multifs_unlink (hostio_fs_pid
, filename
);
544 ret
= unlink (filename
);
548 hostio_error (own_buf
);
552 hostio_reply (own_buf
, ret
);
556 handle_readlink (char *own_buf
, int *new_packet_len
)
558 char filename
[HOSTIO_PATH_MAX
], linkname
[HOSTIO_PATH_MAX
];
562 p
= own_buf
+ strlen ("vFile:readlink:");
564 if (require_filename (&p
, filename
)
567 hostio_packet_error (own_buf
);
571 if (hostio_fs_pid
!= 0 && the_target
->multifs_readlink
!= NULL
)
572 ret
= the_target
->multifs_readlink (hostio_fs_pid
, filename
,
574 sizeof (linkname
) - 1);
576 ret
= readlink (filename
, linkname
, sizeof (linkname
) - 1);
580 hostio_error (own_buf
);
584 bytes_sent
= hostio_reply_with_data (own_buf
, linkname
, ret
, new_packet_len
);
586 /* If the response does not fit into a single packet, do not attempt
587 to return a partial response, but simply fail. */
588 if (bytes_sent
< ret
)
589 sprintf (own_buf
, "F-1,%x", FILEIO_ENAMETOOLONG
);
592 /* Handle all the 'F' file transfer packets. */
595 handle_vFile (char *own_buf
, int packet_len
, int *new_packet_len
)
597 if (startswith (own_buf
, "vFile:open:"))
598 handle_open (own_buf
);
599 else if (startswith (own_buf
, "vFile:pread:"))
600 handle_pread (own_buf
, new_packet_len
);
601 else if (startswith (own_buf
, "vFile:pwrite:"))
602 handle_pwrite (own_buf
, packet_len
);
603 else if (startswith (own_buf
, "vFile:fstat:"))
604 handle_fstat (own_buf
, new_packet_len
);
605 else if (startswith (own_buf
, "vFile:close:"))
606 handle_close (own_buf
);
607 else if (startswith (own_buf
, "vFile:unlink:"))
608 handle_unlink (own_buf
);
609 else if (startswith (own_buf
, "vFile:readlink:"))
610 handle_readlink (own_buf
, new_packet_len
);
611 else if (startswith (own_buf
, "vFile:setfs:"))
612 handle_setfs (own_buf
);
This page took 0.041406 seconds and 4 git commands to generate.