1 /* 2 * Copyright (c) 2003, 2017, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 25 #ifndef _LIBPROC_IMPL_H_ 26 #define _LIBPROC_IMPL_H_ 27 28 #include <unistd.h> 29 #include <limits.h> 30 31 struct ps_prochandle; 32 33 #include "libproc.h" 34 #include "symtab.h" 35 36 // data structures in this file mimic those of Solaris 8.0 - libproc's Pcontrol.h 37 38 #define BUF_SIZE (PATH_MAX + NAME_MAX + 1) 39 40 // list of shared objects 41 typedef struct lib_info { 42 char name[BUF_SIZE]; 43 uintptr_t base; 44 struct symtab* symtab; 45 int fd; // file descriptor for lib 46 struct lib_info* next; 47 } lib_info; 48 49 // list of threads 50 typedef struct thread_info { 51 lwpid_t lwp_id; 52 pthread_t pthread_id; // not used cores, always -1 53 struct user_regs_struct regs; // not for process, core uses for caching regset 54 struct thread_info* next; 55 } thread_info; 56 57 // list of virtual memory maps 58 typedef struct map_info { 59 int fd; // file descriptor 60 off_t offset; // file offset of this mapping 61 uintptr_t vaddr; // starting virtual address 62 size_t memsz; // size of the mapping 63 struct map_info* next; 64 } map_info; 65 66 // vtable for ps_prochandle 67 typedef struct ps_prochandle_ops { 68 // "derived class" clean-up 69 void (*release)(struct ps_prochandle* ph); 70 // read from debuggee 71 bool (*p_pread)(struct ps_prochandle *ph, 72 uintptr_t addr, char *buf, size_t size); 73 // write into debuggee 74 bool (*p_pwrite)(struct ps_prochandle *ph, 75 uintptr_t addr, const char *buf , size_t size); 76 // get integer regset of a thread 77 bool (*get_lwp_regs)(struct ps_prochandle* ph, lwpid_t lwp_id, struct user_regs_struct* regs); 78 } ps_prochandle_ops; 79 80 // the ps_prochandle 81 82 struct core_data { 83 int core_fd; // file descriptor of core file 84 int exec_fd; // file descriptor of exec file 85 int interp_fd; // file descriptor of interpreter (ld-linux.so.2) 86 // part of the class sharing workaround 87 int classes_jsa_fd; // file descriptor of class share archive 88 uintptr_t dynamic_addr; // address of dynamic section of a.out 89 uintptr_t ld_base_addr; // base address of ld.so 90 size_t num_maps; // number of maps. 91 map_info* maps; // maps in a linked list 92 // part of the class sharing workaround 93 map_info* class_share_maps;// class share maps in a linked list 94 map_info** map_array; // sorted (by vaddr) array of map_info pointers 95 }; 96 97 struct ps_prochandle { 98 ps_prochandle_ops* ops; // vtable ptr 99 pid_t pid; 100 int num_libs; 101 lib_info* libs; // head of lib list 102 lib_info* lib_tail; // tail of lib list - to append at the end 103 int num_threads; 104 thread_info* threads; // head of thread list 105 struct core_data* core; // data only used for core dumps, NULL for process 106 }; 107 108 int pathmap_open(const char* name); 109 110 void print_debug(const char* format,...); 111 void print_error(const char* format,...); 112 bool is_debug(); 113 114 typedef bool (*thread_info_callback)(struct ps_prochandle* ph, pthread_t pid, lwpid_t lwpid); 115 116 // reads thread info using libthread_db and calls above callback for each thread 117 bool read_thread_info(struct ps_prochandle* ph, thread_info_callback cb); 118 119 // adds a new shared object to lib list, returns NULL on failure 120 lib_info* add_lib_info(struct ps_prochandle* ph, const char* libname, uintptr_t base); 121 122 // adds a new shared object to lib list, supply open lib file descriptor as well 123 lib_info* add_lib_info_fd(struct ps_prochandle* ph, const char* libname, int fd, 124 uintptr_t base); 125 126 // adds a new thread to threads list, returns NULL on failure 127 thread_info* add_thread_info(struct ps_prochandle* ph, pthread_t pthread_id, lwpid_t lwp_id); 128 129 // a test for ELF signature without using libelf 130 bool is_elf_file(int fd); 131 132 // ps_getpid() is only defined on Linux to return a thread's process ID 133 pid_t ps_getpid(struct ps_prochandle *ph); 134 135 // ps_pglobal_lookup() looks up the symbol sym_name in the symbol table 136 // of the load object object_name in the target process identified by ph. 137 // It returns the symbol's value as an address in the target process in 138 // *sym_addr. 139 140 ps_err_e ps_pglobal_lookup(struct ps_prochandle *ph, const char *object_name, 141 const char *sym_name, psaddr_t *sym_addr); 142 // read "size" bytes of data from debuggee at address "addr" 143 ps_err_e ps_pdread(struct ps_prochandle *ph, psaddr_t addr, 144 void *buf, size_t size); 145 146 // write "size" bytes of data to debuggee at address "addr" 147 ps_err_e ps_pdwrite(struct ps_prochandle *ph, psaddr_t addr, 148 const void *buf, size_t size); 149 150 ps_err_e ps_lsetfpregs(struct ps_prochandle *ph, lwpid_t lid, const prfpregset_t *fpregs); 151 152 ps_err_e ps_lsetregs(struct ps_prochandle *ph, lwpid_t lid, const prgregset_t gregset); 153 154 ps_err_e ps_lgetfpregs(struct ps_prochandle *ph, lwpid_t lid, prfpregset_t *fpregs); 155 156 ps_err_e ps_lgetregs(struct ps_prochandle *ph, lwpid_t lid, prgregset_t gregset); 157 158 // new libthread_db of NPTL seem to require this symbol 159 ps_err_e ps_get_thread_area(); 160 #endif //_LIBPROC_IMPL_H_