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