1 /* 2 * Copyright (c) 2003, 2020, 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 #include "libproc.h" 31 #include "symtab.h" 32 33 // data structures in this file mimic those of Solaris 8.0 - libproc's Pcontrol.h 34 35 #define BUF_SIZE (PATH_MAX + NAME_MAX + 1) 36 37 // .eh_frame data 38 typedef struct eh_frame_info { 39 uintptr_t library_base_addr; 40 uintptr_t v_addr; 41 unsigned char* data; 42 int size; 43 } eh_frame_info; 44 45 // list of shared objects 46 typedef struct lib_info { 47 char name[BUF_SIZE]; 48 uintptr_t base; 49 uintptr_t exec_start; 50 uintptr_t exec_end; 51 eh_frame_info eh_frame; 52 struct symtab* symtab; 53 int fd; // file descriptor for lib 54 struct lib_info* next; 55 } lib_info; 56 57 // list of threads 58 typedef struct thread_info { 59 lwpid_t lwp_id; 60 struct user_regs_struct regs; // not for process, core uses for caching regset 61 struct thread_info* next; 62 } thread_info; 63 64 // list of virtual memory maps 65 typedef struct map_info { 66 int fd; // file descriptor 67 off_t offset; // file offset of this mapping 68 uintptr_t vaddr; // starting virtual address 69 size_t memsz; // size of the mapping 70 struct map_info* next; 71 } map_info; 72 73 // vtable for ps_prochandle 74 typedef struct ps_prochandle_ops { 75 // "derived class" clean-up 76 void (*release)(struct ps_prochandle* ph); 77 // read from debuggee 78 bool (*p_pread)(struct ps_prochandle *ph, 79 uintptr_t addr, char *buf, size_t size); 80 // write into debuggee 81 bool (*p_pwrite)(struct ps_prochandle *ph, 82 uintptr_t addr, const char *buf , size_t size); 83 // get integer regset of a thread 84 bool (*get_lwp_regs)(struct ps_prochandle* ph, lwpid_t lwp_id, struct user_regs_struct* regs); 85 } ps_prochandle_ops; 86 87 // the ps_prochandle 88 89 struct core_data { 90 int core_fd; // file descriptor of core file 91 int exec_fd; // file descriptor of exec file 92 int interp_fd; // file descriptor of interpreter (ld-linux.so.2) 93 // part of the class sharing workaround 94 int classes_jsa_fd; // file descriptor of class share archive 95 uintptr_t dynamic_addr; // address of dynamic section of a.out 96 uintptr_t ld_base_addr; // base address of ld.so 97 size_t num_maps; // number of maps. 98 map_info* maps; // maps in a linked list 99 // part of the class sharing workaround 100 map_info* class_share_maps;// class share maps in a linked list 101 map_info** map_array; // sorted (by vaddr) array of map_info pointers 102 }; 103 104 struct ps_prochandle { 105 ps_prochandle_ops* ops; // vtable ptr 106 pid_t pid; 107 int num_libs; 108 lib_info* libs; // head of lib list 109 lib_info* lib_tail; // tail of lib list - to append at the end 110 int num_threads; 111 thread_info* threads; // head of thread list 112 struct core_data* core; // data only used for core dumps, NULL for process 113 }; 114 115 #ifdef __cplusplus 116 extern "C" { 117 #endif 118 119 int pathmap_open(const char* name); 120 121 void print_debug(const char* format,...); 122 void print_error(const char* format,...); 123 bool is_debug(); 124 125 // deletes a thread from the thread list 126 void delete_thread_info(struct ps_prochandle* ph, thread_info* thr); 127 128 // adds a new shared object to lib list, returns NULL on failure 129 lib_info* add_lib_info(struct ps_prochandle* ph, const char* libname, uintptr_t base); 130 131 // adds a new shared object to lib list, supply open lib file descriptor as well 132 lib_info* add_lib_info_fd(struct ps_prochandle* ph, const char* libname, int fd, 133 uintptr_t base); 134 135 // adds a new thread to threads list, returns NULL on failure 136 thread_info* add_thread_info(struct ps_prochandle* ph, lwpid_t lwp_id); 137 138 // a test for ELF signature without using libelf 139 bool is_elf_file(int fd); 140 141 #ifdef __cplusplus 142 } 143 #endif 144 145 #endif //_LIBPROC_IMPL_H_