1 /* SPU native-dependent code for GDB, the GNU debugger.
2 Copyright (C) 2006-2017 Free Software Foundation, Inc.
4 Contributed by Ulrich Weigand <uweigand@de.ibm.com>.
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/>. */
25 #include "inf-child.h"
26 #include "inf-ptrace.h"
30 #include "gdbthread.h"
33 #include "nat/gdb_ptrace.h"
34 #include <asm/ptrace.h>
35 #include <sys/types.h>
39 /* PPU side system calls. */
40 #define INSTR_SC 0x44000002
41 #define NR_spu_run 0x0116
44 /* Fetch PPU register REGNO. */
46 fetch_ppc_register (int regno)
50 int tid = ptid_get_lwp (inferior_ptid);
52 tid = ptid_get_pid (inferior_ptid);
55 /* If running as a 32-bit process on a 64-bit system, we attempt
56 to get the full 64-bit register content of the target process.
57 If the PPC special ptrace call fails, we're on a 32-bit system;
58 just fall through to the regular ptrace call in that case. */
63 ptrace (PPC_PTRACE_PEEKUSR_3264, tid,
64 (PTRACE_TYPE_ARG3) (regno * 8), buf);
66 ptrace (PPC_PTRACE_PEEKUSR_3264, tid,
67 (PTRACE_TYPE_ARG3) (regno * 8 + 4), buf + 4);
69 return (ULONGEST) *(uint64_t *)buf;
74 res = ptrace (PT_READ_U, tid,
75 (PTRACE_TYPE_ARG3) (regno * sizeof (PTRACE_TYPE_RET)), 0);
79 xsnprintf (mess, sizeof mess, "reading PPC register #%d", regno);
80 perror_with_name (_(mess));
83 return (ULONGEST) (unsigned long) res;
86 /* Fetch WORD from PPU memory at (aligned) MEMADDR in thread TID. */
88 fetch_ppc_memory_1 (int tid, ULONGEST memaddr, PTRACE_TYPE_RET *word)
95 uint64_t addr_8 = (uint64_t) memaddr;
96 ptrace (PPC_PTRACE_PEEKTEXT_3264, tid, (PTRACE_TYPE_ARG3) &addr_8, word);
100 *word = ptrace (PT_READ_I, tid, (PTRACE_TYPE_ARG3) (size_t) memaddr, 0);
105 /* Store WORD into PPU memory at (aligned) MEMADDR in thread TID. */
107 store_ppc_memory_1 (int tid, ULONGEST memaddr, PTRACE_TYPE_RET word)
111 #ifndef __powerpc64__
114 uint64_t addr_8 = (uint64_t) memaddr;
115 ptrace (PPC_PTRACE_POKEDATA_3264, tid, (PTRACE_TYPE_ARG3) &addr_8, word);
119 ptrace (PT_WRITE_D, tid, (PTRACE_TYPE_ARG3) (size_t) memaddr, word);
124 /* Fetch LEN bytes of PPU memory at MEMADDR to MYADDR. */
126 fetch_ppc_memory (ULONGEST memaddr, gdb_byte *myaddr, int len)
130 ULONGEST addr = memaddr & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
131 int count = ((((memaddr + len) - addr) + sizeof (PTRACE_TYPE_RET) - 1)
132 / sizeof (PTRACE_TYPE_RET));
133 PTRACE_TYPE_RET *buffer;
135 int tid = ptid_get_lwp (inferior_ptid);
137 tid = ptid_get_pid (inferior_ptid);
139 buffer = (PTRACE_TYPE_RET *) alloca (count * sizeof (PTRACE_TYPE_RET));
140 for (i = 0; i < count; i++, addr += sizeof (PTRACE_TYPE_RET))
142 ret = fetch_ppc_memory_1 (tid, addr, &buffer[i]);
148 (char *) buffer + (memaddr & (sizeof (PTRACE_TYPE_RET) - 1)),
154 /* Store LEN bytes from MYADDR to PPU memory at MEMADDR. */
156 store_ppc_memory (ULONGEST memaddr, const gdb_byte *myaddr, int len)
160 ULONGEST addr = memaddr & -(ULONGEST) sizeof (PTRACE_TYPE_RET);
161 int count = ((((memaddr + len) - addr) + sizeof (PTRACE_TYPE_RET) - 1)
162 / sizeof (PTRACE_TYPE_RET));
163 PTRACE_TYPE_RET *buffer;
165 int tid = ptid_get_lwp (inferior_ptid);
167 tid = ptid_get_pid (inferior_ptid);
169 buffer = (PTRACE_TYPE_RET *) alloca (count * sizeof (PTRACE_TYPE_RET));
171 if (addr != memaddr || len < (int) sizeof (PTRACE_TYPE_RET))
173 ret = fetch_ppc_memory_1 (tid, addr, &buffer[0]);
180 ret = fetch_ppc_memory_1 (tid, addr + (count - 1)
181 * sizeof (PTRACE_TYPE_RET),
187 memcpy ((char *) buffer + (memaddr & (sizeof (PTRACE_TYPE_RET) - 1)),
190 for (i = 0; i < count; i++, addr += sizeof (PTRACE_TYPE_RET))
192 ret = store_ppc_memory_1 (tid, addr, buffer[i]);
201 /* If the PPU thread is currently stopped on a spu_run system call,
202 return to FD and ADDR the file handle and NPC parameter address
203 used with the system call. Return non-zero if successful. */
205 parse_spufs_run (int *fd, ULONGEST *addr)
207 enum bfd_endian byte_order = gdbarch_byte_order (target_gdbarch ());
209 ULONGEST pc = fetch_ppc_register (32); /* nip */
211 /* Fetch instruction preceding current NIP. */
212 if (fetch_ppc_memory (pc-4, buf, 4) != 0)
214 /* It should be a "sc" instruction. */
215 if (extract_unsigned_integer (buf, 4, byte_order) != INSTR_SC)
217 /* System call number should be NR_spu_run. */
218 if (fetch_ppc_register (0) != NR_spu_run)
221 /* Register 3 contains fd, register 4 the NPC param pointer. */
222 *fd = fetch_ppc_register (34); /* orig_gpr3 */
223 *addr = fetch_ppc_register (4);
228 /* Implement the to_xfer_partial target_ops method for TARGET_OBJECT_SPU.
229 Copy LEN bytes at OFFSET in spufs file ANNEX into/from READBUF or WRITEBUF,
230 using the /proc file system. */
232 static enum target_xfer_status
233 spu_proc_xfer_spu (const char *annex, gdb_byte *readbuf,
234 const gdb_byte *writebuf,
235 ULONGEST offset, ULONGEST len, ULONGEST *xfered_len)
240 int pid = ptid_get_pid (inferior_ptid);
243 return TARGET_XFER_EOF;
245 xsnprintf (buf, sizeof buf, "/proc/%d/fd/%s", pid, annex);
246 fd = open (buf, writebuf? O_WRONLY : O_RDONLY);
248 return TARGET_XFER_E_IO;
251 && lseek (fd, (off_t) offset, SEEK_SET) != (off_t) offset)
254 return TARGET_XFER_EOF;
258 ret = write (fd, writebuf, (size_t) len);
260 ret = read (fd, readbuf, (size_t) len);
264 return TARGET_XFER_E_IO;
266 return TARGET_XFER_EOF;
269 *xfered_len = (ULONGEST) ret;
270 return TARGET_XFER_OK;
275 /* Inferior memory should contain an SPE executable image at location ADDR.
276 Allocate a BFD representing that executable. Return NULL on error. */
279 spu_bfd_iovec_open (struct bfd *nbfd, void *open_closure)
285 spu_bfd_iovec_close (struct bfd *nbfd, void *stream)
289 /* Zero means success. */
294 spu_bfd_iovec_pread (struct bfd *abfd, void *stream, void *buf,
295 file_ptr nbytes, file_ptr offset)
297 ULONGEST addr = *(ULONGEST *)stream;
299 if (fetch_ppc_memory (addr + offset, (gdb_byte *)buf, nbytes) != 0)
301 bfd_set_error (bfd_error_invalid_operation);
309 spu_bfd_iovec_stat (struct bfd *abfd, void *stream, struct stat *sb)
311 /* We don't have an easy way of finding the size of embedded spu
312 images. We could parse the in-memory ELF header and section
313 table to find the extent of the last section but that seems
314 pointless when the size is needed only for checks of other
315 parsed values in dbxread.c. */
316 memset (sb, 0, sizeof (struct stat));
317 sb->st_size = INT_MAX;
321 static gdb_bfd_ref_ptr
322 spu_bfd_open (ULONGEST addr)
326 ULONGEST *open_closure = XNEW (ULONGEST);
327 *open_closure = addr;
329 gdb_bfd_ref_ptr nbfd (gdb_bfd_openr_iovec ("<in-memory>", "elf32-spu",
330 spu_bfd_iovec_open, open_closure,
333 spu_bfd_iovec_stat));
337 if (!bfd_check_format (nbfd.get (), bfd_object))
340 /* Retrieve SPU name note and update BFD name. */
341 spu_name = bfd_get_section_by_name (nbfd.get (), ".note.spu_name");
344 int sect_size = bfd_section_size (nbfd.get (), spu_name);
347 char *buf = (char *)alloca (sect_size - 20 + 1);
348 bfd_get_section_contents (nbfd.get (), spu_name, buf, 20,
350 buf[sect_size - 20] = '\0';
352 xfree ((char *)nbfd->filename);
353 nbfd->filename = xstrdup (buf);
360 /* INFERIOR_FD is a file handle passed by the inferior to the
361 spu_run system call. Assuming the SPE context was allocated
362 by the libspe library, try to retrieve the main SPE executable
363 file from its copy within the target process. */
365 spu_symbol_file_add_from_memory (int inferior_fd)
372 enum target_xfer_status status;
374 /* Read object ID. */
375 xsnprintf (annex, sizeof annex, "%d/object-id", inferior_fd);
376 status = spu_proc_xfer_spu (annex, id, NULL, 0, sizeof id, &len);
377 if (status != TARGET_XFER_OK || len >= sizeof id)
380 addr = strtoulst ((const char *) id, NULL, 16);
384 /* Open BFD representing SPE executable and read its symbols. */
385 gdb_bfd_ref_ptr nbfd (spu_bfd_open (addr));
388 symbol_file_add_from_bfd (nbfd.get (), bfd_get_filename (nbfd),
389 SYMFILE_VERBOSE | SYMFILE_MAINLINE,
395 /* Override the post_startup_inferior routine to continue running
396 the inferior until the first spu_run system call. */
398 spu_child_post_startup_inferior (struct target_ops *self, ptid_t ptid)
403 int tid = ptid_get_lwp (ptid);
405 tid = ptid_get_pid (ptid);
407 while (!parse_spufs_run (&fd, &addr))
409 ptrace (PT_SYSCALL, tid, (PTRACE_TYPE_ARG3) 0, 0);
410 waitpid (tid, NULL, __WALL | __WNOTHREAD);
414 /* Override the post_attach routine to try load the SPE executable
415 file image from its copy inside the target process. */
417 spu_child_post_attach (struct target_ops *self, int pid)
422 /* Like child_post_startup_inferior, if we happened to attach to
423 the inferior while it wasn't currently in spu_run, continue
424 running it until we get back there. */
425 while (!parse_spufs_run (&fd, &addr))
427 ptrace (PT_SYSCALL, pid, (PTRACE_TYPE_ARG3) 0, 0);
428 waitpid (pid, NULL, __WALL | __WNOTHREAD);
431 /* If the user has not provided an executable file, try to extract
432 the image from inside the target process. */
433 if (!get_exec_file (0))
434 spu_symbol_file_add_from_memory (fd);
437 /* Wait for child PTID to do something. Return id of the child,
438 minus_one_ptid in case of error; store status into *OURSTATUS. */
440 spu_child_wait (struct target_ops *ops,
441 ptid_t ptid, struct target_waitstatus *ourstatus, int options)
449 set_sigint_trap (); /* Causes SIGINT to be passed on to the
452 pid = waitpid (ptid_get_pid (ptid), &status, 0);
453 if (pid == -1 && errno == ECHILD)
454 /* Try again with __WCLONE to check cloned processes. */
455 pid = waitpid (ptid_get_pid (ptid), &status, __WCLONE);
459 /* Make sure we don't report an event for the exit of the
460 original program, if we've detached from it. */
461 if (pid != -1 && !WIFSTOPPED (status)
462 && pid != ptid_get_pid (inferior_ptid))
468 clear_sigint_trap ();
470 while (pid == -1 && save_errno == EINTR);
474 warning (_("Child process unexpectedly missing: %s"),
475 safe_strerror (save_errno));
477 /* Claim it exited with unknown signal. */
478 ourstatus->kind = TARGET_WAITKIND_SIGNALLED;
479 ourstatus->value.sig = GDB_SIGNAL_UNKNOWN;
480 return inferior_ptid;
483 store_waitstatus (ourstatus, status);
484 return pid_to_ptid (pid);
487 /* Override the fetch_inferior_register routine. */
489 spu_fetch_inferior_registers (struct target_ops *ops,
490 struct regcache *regcache, int regno)
495 /* Since we use functions that rely on inferior_ptid, we need to set and
497 scoped_restore save_ptid
498 = make_scoped_restore (&inferior_ptid, regcache_get_ptid (regcache));
500 /* We must be stopped on a spu_run system call. */
501 if (!parse_spufs_run (&fd, &addr))
504 /* The ID register holds the spufs file handle. */
505 if (regno == -1 || regno == SPU_ID_REGNUM)
507 struct gdbarch *gdbarch = get_regcache_arch (regcache);
508 enum bfd_endian byte_order = gdbarch_byte_order (gdbarch);
510 store_unsigned_integer (buf, 4, byte_order, fd);
511 regcache_raw_supply (regcache, SPU_ID_REGNUM, buf);
514 /* The NPC register is found at ADDR. */
515 if (regno == -1 || regno == SPU_PC_REGNUM)
518 if (fetch_ppc_memory (addr, buf, 4) == 0)
519 regcache_raw_supply (regcache, SPU_PC_REGNUM, buf);
522 /* The GPRs are found in the "regs" spufs file. */
523 if (regno == -1 || (regno >= 0 && regno < SPU_NUM_GPRS))
525 gdb_byte buf[16 * SPU_NUM_GPRS];
530 xsnprintf (annex, sizeof annex, "%d/regs", fd);
531 if ((spu_proc_xfer_spu (annex, buf, NULL, 0, sizeof buf, &len)
533 && len == sizeof buf)
534 for (i = 0; i < SPU_NUM_GPRS; i++)
535 regcache_raw_supply (regcache, i, buf + i*16);
539 /* Override the store_inferior_register routine. */
541 spu_store_inferior_registers (struct target_ops *ops,
542 struct regcache *regcache, int regno)
547 /* Since we use functions that rely on inferior_ptid, we need to set and
549 scoped_restore save_ptid
550 = make_scoped_restore (&inferior_ptid, regcache_get_ptid (regcache));
552 /* We must be stopped on a spu_run system call. */
553 if (!parse_spufs_run (&fd, &addr))
556 /* The NPC register is found at ADDR. */
557 if (regno == -1 || regno == SPU_PC_REGNUM)
560 regcache_raw_collect (regcache, SPU_PC_REGNUM, buf);
561 store_ppc_memory (addr, buf, 4);
564 /* The GPRs are found in the "regs" spufs file. */
565 if (regno == -1 || (regno >= 0 && regno < SPU_NUM_GPRS))
567 gdb_byte buf[16 * SPU_NUM_GPRS];
572 for (i = 0; i < SPU_NUM_GPRS; i++)
573 regcache_raw_collect (regcache, i, buf + i*16);
575 xsnprintf (annex, sizeof annex, "%d/regs", fd);
576 spu_proc_xfer_spu (annex, NULL, buf, 0, sizeof buf, &len);
580 /* Override the to_xfer_partial routine. */
581 static enum target_xfer_status
582 spu_xfer_partial (struct target_ops *ops,
583 enum target_object object, const char *annex,
584 gdb_byte *readbuf, const gdb_byte *writebuf,
585 ULONGEST offset, ULONGEST len, ULONGEST *xfered_len)
587 if (object == TARGET_OBJECT_SPU)
588 return spu_proc_xfer_spu (annex, readbuf, writebuf, offset, len,
591 if (object == TARGET_OBJECT_MEMORY)
595 char mem_annex[32], lslr_annex[32];
598 enum target_xfer_status ret;
600 /* We must be stopped on a spu_run system call. */
601 if (!parse_spufs_run (&fd, &addr))
602 return TARGET_XFER_EOF;
604 /* Use the "mem" spufs file to access SPU local store. */
605 xsnprintf (mem_annex, sizeof mem_annex, "%d/mem", fd);
606 ret = spu_proc_xfer_spu (mem_annex, readbuf, writebuf, offset, len,
608 if (ret == TARGET_XFER_OK)
611 /* SPU local store access wraps the address around at the
612 local store limit. We emulate this here. To avoid needing
613 an extra access to retrieve the LSLR, we only do that after
614 trying the original address first, and getting end-of-file. */
615 xsnprintf (lslr_annex, sizeof lslr_annex, "%d/lslr", fd);
616 memset (buf, 0, sizeof buf);
617 if (spu_proc_xfer_spu (lslr_annex, buf, NULL, 0, sizeof buf, xfered_len)
621 lslr = strtoulst ((const char *) buf, NULL, 16);
622 return spu_proc_xfer_spu (mem_annex, readbuf, writebuf,
623 offset & lslr, len, xfered_len);
626 return TARGET_XFER_E_IO;
629 /* Override the to_can_use_hw_breakpoint routine. */
631 spu_can_use_hw_breakpoint (struct target_ops *self,
632 enum bptype type, int cnt, int othertype)
637 /* -Wmissing-prototypes */
638 extern initialize_file_ftype _initialize_spu_nat;
640 /* Initialize SPU native target. */
642 _initialize_spu_nat (void)
644 /* Generic ptrace methods. */
645 struct target_ops *t;
646 t = inf_ptrace_target ();
648 /* Add SPU methods. */
649 t->to_post_attach = spu_child_post_attach;
650 t->to_post_startup_inferior = spu_child_post_startup_inferior;
651 t->to_wait = spu_child_wait;
652 t->to_fetch_registers = spu_fetch_inferior_registers;
653 t->to_store_registers = spu_store_inferior_registers;
654 t->to_xfer_partial = spu_xfer_partial;
655 t->to_can_use_hw_breakpoint = spu_can_use_hw_breakpoint;
657 /* Register SPU target. */