Commit | Line | Data |
---|---|---|
a6b151f1 | 1 | /* Host file transfer support for gdbserver. |
32d0add0 | 2 | Copyright (C) 2007-2015 Free Software Foundation, Inc. |
a6b151f1 DJ |
3 | |
4 | Contributed by CodeSourcery. | |
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 | |
32de4b9d | 10 | the Free Software Foundation; either version 3 of the License, or |
a6b151f1 DJ |
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 | |
32de4b9d | 19 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
a6b151f1 DJ |
20 | |
21 | #include "server.h" | |
22 | #include "gdb/fileio.h" | |
533b0600 | 23 | #include "hostio.h" |
a6b151f1 | 24 | |
a6b151f1 DJ |
25 | #include <fcntl.h> |
26 | #include <limits.h> | |
27 | #include <unistd.h> | |
aa9e327f GB |
28 | #include <sys/types.h> |
29 | #include <sys/stat.h> | |
7823a941 | 30 | #include "fileio.h" |
a6b151f1 DJ |
31 | |
32 | extern int remote_debug; | |
33 | ||
34 | struct fd_list | |
35 | { | |
36 | int fd; | |
37 | struct fd_list *next; | |
38 | }; | |
39 | ||
40 | static struct fd_list *open_fds; | |
41 | ||
42 | static int | |
43 | safe_fromhex (char a, int *nibble) | |
44 | { | |
45 | if (a >= '0' && a <= '9') | |
46 | *nibble = a - '0'; | |
47 | else if (a >= 'a' && a <= 'f') | |
48 | *nibble = a - 'a' + 10; | |
49 | else if (a >= 'A' && a <= 'F') | |
50 | *nibble = a - 'A' + 10; | |
51 | else | |
52 | return -1; | |
53 | ||
54 | return 0; | |
55 | } | |
56 | ||
d5749ee7 PA |
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) | |
61 | #else | |
62 | # define HOSTIO_PATH_MAX PATH_MAX | |
63 | #endif | |
64 | ||
a6b151f1 DJ |
65 | static int |
66 | require_filename (char **pp, char *filename) | |
67 | { | |
68 | int count; | |
69 | char *p; | |
70 | ||
71 | p = *pp; | |
72 | count = 0; | |
73 | ||
74 | while (*p && *p != ',') | |
75 | { | |
76 | int nib1, nib2; | |
77 | ||
78 | /* Don't allow overflow. */ | |
d5749ee7 | 79 | if (count >= HOSTIO_PATH_MAX - 1) |
a6b151f1 DJ |
80 | return -1; |
81 | ||
82 | if (safe_fromhex (p[0], &nib1) | |
83 | || safe_fromhex (p[1], &nib2)) | |
84 | return -1; | |
85 | ||
86 | filename[count++] = nib1 * 16 + nib2; | |
87 | p += 2; | |
88 | } | |
89 | ||
90 | filename[count] = '\0'; | |
91 | *pp = p; | |
92 | return 0; | |
93 | } | |
94 | ||
95 | static int | |
96 | require_int (char **pp, int *value) | |
97 | { | |
98 | char *p; | |
99 | int count; | |
100 | ||
101 | p = *pp; | |
102 | *value = 0; | |
103 | count = 0; | |
104 | ||
105 | while (*p && *p != ',') | |
106 | { | |
107 | int nib; | |
108 | ||
109 | /* Don't allow overflow. */ | |
110 | if (count >= 7) | |
111 | return -1; | |
112 | ||
113 | if (safe_fromhex (p[0], &nib)) | |
114 | return -1; | |
115 | *value = *value * 16 + nib; | |
116 | p++; | |
117 | count++; | |
118 | } | |
119 | ||
120 | *pp = p; | |
121 | return 0; | |
122 | } | |
123 | ||
124 | static int | |
125 | require_data (char *p, int p_len, char **data, int *data_len) | |
126 | { | |
127 | int input_index, output_index, escaped; | |
128 | ||
bca929d3 | 129 | *data = xmalloc (p_len); |
a6b151f1 DJ |
130 | |
131 | output_index = 0; | |
132 | escaped = 0; | |
133 | for (input_index = 0; input_index < p_len; input_index++) | |
134 | { | |
135 | char b = p[input_index]; | |
136 | ||
137 | if (escaped) | |
138 | { | |
139 | (*data)[output_index++] = b ^ 0x20; | |
140 | escaped = 0; | |
141 | } | |
142 | else if (b == '}') | |
143 | escaped = 1; | |
144 | else | |
145 | (*data)[output_index++] = b; | |
146 | } | |
147 | ||
148 | if (escaped) | |
9130f83e | 149 | { |
8040bd49 | 150 | free (*data); |
9130f83e MS |
151 | return -1; |
152 | } | |
a6b151f1 DJ |
153 | |
154 | *data_len = output_index; | |
155 | return 0; | |
156 | } | |
157 | ||
158 | static int | |
159 | require_comma (char **pp) | |
160 | { | |
161 | if (**pp == ',') | |
162 | { | |
163 | (*pp)++; | |
164 | return 0; | |
165 | } | |
166 | else | |
167 | return -1; | |
168 | } | |
169 | ||
170 | static int | |
171 | require_end (char *p) | |
172 | { | |
173 | if (*p == '\0') | |
174 | return 0; | |
175 | else | |
176 | return -1; | |
177 | } | |
178 | ||
179 | static int | |
180 | require_valid_fd (int fd) | |
181 | { | |
182 | struct fd_list *fd_ptr; | |
183 | ||
184 | for (fd_ptr = open_fds; fd_ptr != NULL; fd_ptr = fd_ptr->next) | |
185 | if (fd_ptr->fd == fd) | |
186 | return 0; | |
187 | ||
188 | return -1; | |
189 | } | |
190 | ||
59a016f0 PA |
191 | /* Fill in own_buf with the last hostio error packet, however it |
192 | suitable for the target. */ | |
a6b151f1 | 193 | static void |
59a016f0 | 194 | hostio_error (char *own_buf) |
a6b151f1 | 195 | { |
59a016f0 | 196 | the_target->hostio_last_error (own_buf); |
a6b151f1 DJ |
197 | } |
198 | ||
199 | static void | |
200 | hostio_packet_error (char *own_buf) | |
201 | { | |
59a016f0 | 202 | sprintf (own_buf, "F-1,%x", FILEIO_EINVAL); |
a6b151f1 DJ |
203 | } |
204 | ||
205 | static void | |
206 | hostio_reply (char *own_buf, int result) | |
207 | { | |
208 | sprintf (own_buf, "F%x", result); | |
209 | } | |
210 | ||
211 | static int | |
212 | hostio_reply_with_data (char *own_buf, char *buffer, int len, | |
213 | int *new_packet_len) | |
214 | { | |
215 | int input_index, output_index, out_maxlen; | |
216 | ||
217 | sprintf (own_buf, "F%x;", len); | |
218 | output_index = strlen (own_buf); | |
219 | ||
220 | out_maxlen = PBUFSIZ; | |
221 | ||
222 | for (input_index = 0; input_index < len; input_index++) | |
223 | { | |
224 | char b = buffer[input_index]; | |
225 | ||
226 | if (b == '$' || b == '#' || b == '}' || b == '*') | |
227 | { | |
228 | /* These must be escaped. */ | |
229 | if (output_index + 2 > out_maxlen) | |
230 | break; | |
231 | own_buf[output_index++] = '}'; | |
232 | own_buf[output_index++] = b ^ 0x20; | |
233 | } | |
234 | else | |
235 | { | |
236 | if (output_index + 1 > out_maxlen) | |
237 | break; | |
238 | own_buf[output_index++] = b; | |
239 | } | |
240 | } | |
241 | ||
242 | *new_packet_len = output_index; | |
243 | return input_index; | |
244 | } | |
245 | ||
14d2069a GB |
246 | /* Process ID of inferior whose filesystem hostio functions |
247 | that take FILENAME arguments will use. Zero means to use | |
248 | our own filesystem. */ | |
249 | ||
250 | static int hostio_fs_pid; | |
251 | ||
252 | /* See hostio.h. */ | |
253 | ||
254 | void | |
255 | hostio_handle_new_gdb_connection (void) | |
256 | { | |
257 | hostio_fs_pid = 0; | |
258 | } | |
259 | ||
260 | /* Handle a "vFile:setfs:" packet. */ | |
261 | ||
262 | static void | |
263 | handle_setfs (char *own_buf) | |
264 | { | |
265 | char *p; | |
266 | int pid; | |
267 | ||
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) | |
275 | { | |
276 | own_buf[0] = '\0'; | |
277 | return; | |
278 | } | |
279 | ||
280 | p = own_buf + strlen ("vFile:setfs:"); | |
281 | ||
282 | if (require_int (&p, &pid) | |
283 | || pid < 0 | |
284 | || require_end (p)) | |
285 | { | |
286 | hostio_packet_error (own_buf); | |
287 | return; | |
288 | } | |
289 | ||
290 | hostio_fs_pid = pid; | |
291 | ||
292 | hostio_reply (own_buf, 0); | |
293 | } | |
294 | ||
a6b151f1 DJ |
295 | static void |
296 | handle_open (char *own_buf) | |
297 | { | |
d5749ee7 | 298 | char filename[HOSTIO_PATH_MAX]; |
a6b151f1 | 299 | char *p; |
3ac2e371 GB |
300 | int fileio_flags, fileio_mode, flags, fd; |
301 | mode_t mode; | |
a6b151f1 DJ |
302 | struct fd_list *new_fd; |
303 | ||
304 | p = own_buf + strlen ("vFile:open:"); | |
305 | ||
306 | if (require_filename (&p, filename) | |
307 | || require_comma (&p) | |
308 | || require_int (&p, &fileio_flags) | |
309 | || require_comma (&p) | |
3ac2e371 | 310 | || require_int (&p, &fileio_mode) |
a6b151f1 | 311 | || require_end (p) |
3ac2e371 GB |
312 | || fileio_to_host_openflags (fileio_flags, &flags) |
313 | || fileio_to_host_mode (fileio_mode, &mode)) | |
a6b151f1 DJ |
314 | { |
315 | hostio_packet_error (own_buf); | |
316 | return; | |
317 | } | |
318 | ||
319 | /* We do not need to convert MODE, since the fileio protocol | |
320 | uses the standard values. */ | |
14d2069a GB |
321 | if (hostio_fs_pid != 0 && the_target->multifs_open != NULL) |
322 | fd = the_target->multifs_open (hostio_fs_pid, filename, | |
323 | flags, mode); | |
324 | else | |
325 | fd = open (filename, flags, mode); | |
a6b151f1 DJ |
326 | |
327 | if (fd == -1) | |
328 | { | |
59a016f0 | 329 | hostio_error (own_buf); |
a6b151f1 DJ |
330 | return; |
331 | } | |
332 | ||
333 | /* Record the new file descriptor. */ | |
bca929d3 | 334 | new_fd = xmalloc (sizeof (struct fd_list)); |
a6b151f1 DJ |
335 | new_fd->fd = fd; |
336 | new_fd->next = open_fds; | |
337 | open_fds = new_fd; | |
338 | ||
339 | hostio_reply (own_buf, fd); | |
340 | } | |
341 | ||
342 | static void | |
343 | handle_pread (char *own_buf, int *new_packet_len) | |
344 | { | |
345 | int fd, ret, len, offset, bytes_sent; | |
346 | char *p, *data; | |
347 | ||
348 | p = own_buf + strlen ("vFile:pread:"); | |
349 | ||
350 | if (require_int (&p, &fd) | |
351 | || require_comma (&p) | |
352 | || require_valid_fd (fd) | |
353 | || require_int (&p, &len) | |
354 | || require_comma (&p) | |
355 | || require_int (&p, &offset) | |
356 | || require_end (p)) | |
357 | { | |
358 | hostio_packet_error (own_buf); | |
359 | return; | |
360 | } | |
361 | ||
bca929d3 | 362 | data = xmalloc (len); |
4e799345 | 363 | #ifdef HAVE_PREAD |
a6b151f1 | 364 | ret = pread (fd, data, len, offset); |
4e799345 | 365 | #else |
7c3270ae | 366 | ret = -1; |
4e799345 | 367 | #endif |
7c3270ae UW |
368 | /* If we have no pread or it failed for this file, use lseek/read. */ |
369 | if (ret == -1) | |
370 | { | |
371 | ret = lseek (fd, offset, SEEK_SET); | |
372 | if (ret != -1) | |
373 | ret = read (fd, data, len); | |
374 | } | |
a6b151f1 DJ |
375 | |
376 | if (ret == -1) | |
377 | { | |
59a016f0 | 378 | hostio_error (own_buf); |
a6b151f1 DJ |
379 | free (data); |
380 | return; | |
381 | } | |
382 | ||
383 | bytes_sent = hostio_reply_with_data (own_buf, data, ret, new_packet_len); | |
384 | ||
385 | /* If we were using read, and the data did not all fit in the reply, | |
386 | we would have to back up using lseek here. With pread it does | |
387 | not matter. But we still have a problem; the return value in the | |
388 | packet might be wrong, so we must fix it. This time it will | |
389 | definitely fit. */ | |
390 | if (bytes_sent < ret) | |
391 | bytes_sent = hostio_reply_with_data (own_buf, data, bytes_sent, | |
392 | new_packet_len); | |
393 | ||
394 | free (data); | |
395 | } | |
396 | ||
397 | static void | |
398 | handle_pwrite (char *own_buf, int packet_len) | |
399 | { | |
400 | int fd, ret, len, offset; | |
401 | char *p, *data; | |
402 | ||
403 | p = own_buf + strlen ("vFile:pwrite:"); | |
404 | ||
405 | if (require_int (&p, &fd) | |
406 | || require_comma (&p) | |
407 | || require_valid_fd (fd) | |
408 | || require_int (&p, &offset) | |
409 | || require_comma (&p) | |
410 | || require_data (p, packet_len - (p - own_buf), &data, &len)) | |
411 | { | |
412 | hostio_packet_error (own_buf); | |
413 | return; | |
414 | } | |
415 | ||
4e799345 | 416 | #ifdef HAVE_PWRITE |
a6b151f1 | 417 | ret = pwrite (fd, data, len, offset); |
4e799345 | 418 | #else |
7c3270ae | 419 | ret = -1; |
4e799345 | 420 | #endif |
7c3270ae UW |
421 | /* If we have no pwrite or it failed for this file, use lseek/write. */ |
422 | if (ret == -1) | |
423 | { | |
424 | ret = lseek (fd, offset, SEEK_SET); | |
425 | if (ret != -1) | |
426 | ret = write (fd, data, len); | |
427 | } | |
a6b151f1 DJ |
428 | |
429 | if (ret == -1) | |
430 | { | |
59a016f0 | 431 | hostio_error (own_buf); |
a6b151f1 DJ |
432 | free (data); |
433 | return; | |
434 | } | |
435 | ||
436 | hostio_reply (own_buf, ret); | |
437 | free (data); | |
438 | } | |
439 | ||
aa9e327f GB |
440 | static void |
441 | handle_fstat (char *own_buf, int *new_packet_len) | |
442 | { | |
443 | int fd, bytes_sent; | |
444 | char *p; | |
445 | struct stat st; | |
446 | struct fio_stat fst; | |
447 | ||
448 | p = own_buf + strlen ("vFile:fstat:"); | |
449 | ||
450 | if (require_int (&p, &fd) | |
451 | || require_valid_fd (fd) | |
452 | || require_end (p)) | |
453 | { | |
454 | hostio_packet_error (own_buf); | |
455 | return; | |
456 | } | |
457 | ||
458 | if (fstat (fd, &st) == -1) | |
459 | { | |
460 | hostio_error (own_buf); | |
461 | return; | |
462 | } | |
463 | ||
7823a941 | 464 | host_to_fileio_stat (&st, &fst); |
aa9e327f GB |
465 | |
466 | bytes_sent = hostio_reply_with_data (own_buf, | |
467 | (char *) &fst, sizeof (fst), | |
468 | new_packet_len); | |
469 | ||
470 | /* If the response does not fit into a single packet, do not attempt | |
471 | to return a partial response, but simply fail. */ | |
472 | if (bytes_sent < sizeof (fst)) | |
473 | write_enn (own_buf); | |
474 | } | |
475 | ||
a6b151f1 DJ |
476 | static void |
477 | handle_close (char *own_buf) | |
478 | { | |
479 | int fd, ret; | |
480 | char *p; | |
481 | struct fd_list **open_fd_p, *old_fd; | |
482 | ||
483 | p = own_buf + strlen ("vFile:close:"); | |
484 | ||
485 | if (require_int (&p, &fd) | |
486 | || require_valid_fd (fd) | |
487 | || require_end (p)) | |
488 | { | |
489 | hostio_packet_error (own_buf); | |
490 | return; | |
491 | } | |
492 | ||
493 | ret = close (fd); | |
494 | ||
495 | if (ret == -1) | |
496 | { | |
59a016f0 | 497 | hostio_error (own_buf); |
a6b151f1 DJ |
498 | return; |
499 | } | |
500 | ||
501 | open_fd_p = &open_fds; | |
588eebee MS |
502 | /* We know that fd is in the list, thanks to require_valid_fd. */ |
503 | while ((*open_fd_p)->fd != fd) | |
a6b151f1 DJ |
504 | open_fd_p = &(*open_fd_p)->next; |
505 | ||
506 | old_fd = *open_fd_p; | |
507 | *open_fd_p = (*open_fd_p)->next; | |
508 | free (old_fd); | |
509 | ||
510 | hostio_reply (own_buf, ret); | |
511 | } | |
512 | ||
513 | static void | |
514 | handle_unlink (char *own_buf) | |
515 | { | |
d5749ee7 | 516 | char filename[HOSTIO_PATH_MAX]; |
a6b151f1 DJ |
517 | char *p; |
518 | int ret; | |
519 | ||
520 | p = own_buf + strlen ("vFile:unlink:"); | |
521 | ||
522 | if (require_filename (&p, filename) | |
523 | || require_end (p)) | |
524 | { | |
525 | hostio_packet_error (own_buf); | |
526 | return; | |
527 | } | |
528 | ||
14d2069a GB |
529 | if (hostio_fs_pid != 0 && the_target->multifs_unlink != NULL) |
530 | ret = the_target->multifs_unlink (hostio_fs_pid, filename); | |
531 | else | |
532 | ret = unlink (filename); | |
a6b151f1 DJ |
533 | |
534 | if (ret == -1) | |
535 | { | |
59a016f0 | 536 | hostio_error (own_buf); |
a6b151f1 DJ |
537 | return; |
538 | } | |
539 | ||
540 | hostio_reply (own_buf, ret); | |
541 | } | |
542 | ||
b9e7b9c3 UW |
543 | static void |
544 | handle_readlink (char *own_buf, int *new_packet_len) | |
545 | { | |
d5749ee7 | 546 | char filename[HOSTIO_PATH_MAX], linkname[HOSTIO_PATH_MAX]; |
b9e7b9c3 UW |
547 | char *p; |
548 | int ret, bytes_sent; | |
549 | ||
550 | p = own_buf + strlen ("vFile:readlink:"); | |
551 | ||
552 | if (require_filename (&p, filename) | |
553 | || require_end (p)) | |
554 | { | |
555 | hostio_packet_error (own_buf); | |
556 | return; | |
557 | } | |
558 | ||
14d2069a GB |
559 | if (hostio_fs_pid != 0 && the_target->multifs_readlink != NULL) |
560 | ret = the_target->multifs_readlink (hostio_fs_pid, filename, | |
561 | linkname, | |
562 | sizeof (linkname) - 1); | |
563 | else | |
564 | ret = readlink (filename, linkname, sizeof (linkname) - 1); | |
565 | ||
b9e7b9c3 UW |
566 | if (ret == -1) |
567 | { | |
568 | hostio_error (own_buf); | |
569 | return; | |
570 | } | |
571 | ||
572 | bytes_sent = hostio_reply_with_data (own_buf, linkname, ret, new_packet_len); | |
573 | ||
574 | /* If the response does not fit into a single packet, do not attempt | |
575 | to return a partial response, but simply fail. */ | |
576 | if (bytes_sent < ret) | |
577 | sprintf (own_buf, "F-1,%x", FILEIO_ENAMETOOLONG); | |
578 | } | |
579 | ||
a6b151f1 DJ |
580 | /* Handle all the 'F' file transfer packets. */ |
581 | ||
582 | int | |
583 | handle_vFile (char *own_buf, int packet_len, int *new_packet_len) | |
584 | { | |
61012eef | 585 | if (startswith (own_buf, "vFile:open:")) |
a6b151f1 | 586 | handle_open (own_buf); |
61012eef | 587 | else if (startswith (own_buf, "vFile:pread:")) |
a6b151f1 | 588 | handle_pread (own_buf, new_packet_len); |
61012eef | 589 | else if (startswith (own_buf, "vFile:pwrite:")) |
a6b151f1 | 590 | handle_pwrite (own_buf, packet_len); |
aa9e327f GB |
591 | else if (startswith (own_buf, "vFile:fstat:")) |
592 | handle_fstat (own_buf, new_packet_len); | |
61012eef | 593 | else if (startswith (own_buf, "vFile:close:")) |
a6b151f1 | 594 | handle_close (own_buf); |
61012eef | 595 | else if (startswith (own_buf, "vFile:unlink:")) |
a6b151f1 | 596 | handle_unlink (own_buf); |
61012eef | 597 | else if (startswith (own_buf, "vFile:readlink:")) |
b9e7b9c3 | 598 | handle_readlink (own_buf, new_packet_len); |
14d2069a GB |
599 | else if (startswith (own_buf, "vFile:setfs:")) |
600 | handle_setfs (own_buf); | |
a6b151f1 DJ |
601 | else |
602 | return 0; | |
603 | ||
604 | return 1; | |
605 | } |