1 /* 2 * Copyright (c) 2003, 2007, 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_H_ 26 #define _LIBPROC_H_ 27 28 #include <unistd.h> 29 #include <stdint.h> 30 #include <machine/reg.h> 31 #include <proc_service.h> 32 33 #if defined(sparc) || defined(sparcv9) 34 /* 35 If _LP64 is defined ptrace.h should be taken from /usr/include/asm-sparc64 36 otherwise it should be from /usr/include/asm-sparc 37 These two files define pt_regs structure differently 38 */ 39 #ifdef _LP64 40 #include "asm-sparc64/ptrace.h" 41 #else 42 #include "asm-sparc/ptrace.h" 43 #endif 44 45 #endif //sparc or sparcv9 46 47 /************************************************************************************ 48 49 0. This is very minimal subset of Solaris libproc just enough for current application. 50 Please note that the bulk of the functionality is from proc_service interface. This 51 adds Pgrab__ and some missing stuff. We hide the difference b/w live process and core 52 file by this interface. 53 54 1. pthread_id is unique. We store this in OSThread::_pthread_id in JVM code. 55 56 2. All threads see the same pid when they call getpid(). 57 We used to save the result of ::getpid() call in OSThread::_thread_id. 58 Because gettid returns actual pid of thread (lwp id), this is 59 unique again. We therefore use OSThread::_thread_id as unique identifier. 60 61 3. There is a unique LWP id under both thread libraries. libthread_db maps pthread_id 62 to its underlying lwp_id under both the thread libraries. thread_info.lwp_id stores 63 lwp_id of the thread. The lwp id is nothing but the actual pid of clone'd processes. But 64 unfortunately libthread_db does not work very well for core dumps. So, we get pthread_id 65 only for processes. For core dumps, we don't use libthread_db at all (like gdb). 66 67 4. ptrace operates on this LWP id under both the thread libraries. When we say 'pid' for 68 ptrace call, we refer to lwp_id of the thread. 69 70 5. for core file, we parse ELF files and read data from them. For processes we use 71 combination of ptrace and /proc calls. 72 73 *************************************************************************************/ 74 75 // This C bool type must be int for compatibility with BSD calls and 76 // it would be a mistake to equivalence it to C++ bool on many platforms 77 78 typedef int bool; 79 #define true 1 80 #define false 0 81 82 struct ps_prochandle; 83 84 // attach to a process 85 struct ps_prochandle* Pgrab(pid_t pid); 86 87 // attach to a core dump 88 struct ps_prochandle* Pgrab_core(const char* execfile, const char* corefile); 89 90 // release a process or core 91 void Prelease(struct ps_prochandle* ph); 92 93 // functions not directly available in Solaris libproc 94 95 // initialize libproc (call this only once per app) 96 // pass true to make library verbose 97 bool init_libproc(bool verbose); 98 99 // get number of threads 100 int get_num_threads(struct ps_prochandle* ph); 101 102 // get lwp_id of n'th thread 103 lwpid_t get_lwp_id(struct ps_prochandle* ph, int index); 104 105 // get regs for a given lwp 106 bool get_lwp_regs(struct ps_prochandle* ph, lwpid_t lid, struct reg* regs); 107 108 // get number of shared objects 109 int get_num_libs(struct ps_prochandle* ph); 110 111 // get name of n'th lib 112 const char* get_lib_name(struct ps_prochandle* ph, int index); 113 114 // get base of lib 115 uintptr_t get_lib_base(struct ps_prochandle* ph, int index); 116 117 // returns true if given library is found in lib list 118 bool find_lib(struct ps_prochandle* ph, const char *lib_name); 119 120 // symbol lookup 121 uintptr_t lookup_symbol(struct ps_prochandle* ph, const char* object_name, 122 const char* sym_name); 123 124 // address->nearest symbol lookup. return NULL for no symbol 125 const char* symbol_for_pc(struct ps_prochandle* ph, uintptr_t addr, uintptr_t* poffset); 126 127 #endif //__LIBPROC_H_