Thu, 30 Aug 2012 11:20:01 -0400
7154641: Servicability agent should work on platforms other than x86, sparc
Summary: Added capability to load support classes for other cpus
Reviewed-by: coleenp, bobv, sla
Contributed-by: Bill Pittore <bill.pittore@oracle.com>
1 /*
2 * Copyright (c) 2003, 2012, 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 */
25 #ifndef _LIBPROC_H_
26 #define _LIBPROC_H_
28 #include <jni.h>
29 #include <unistd.h>
30 #include <stdint.h>
31 #include "proc_service.h"
33 #if defined(arm) || defined(ppc)
34 #include "libproc_md.h"
35 #endif
37 #if defined(sparc) || defined(sparcv9)
38 /*
39 If _LP64 is defined ptrace.h should be taken from /usr/include/asm-sparc64
40 otherwise it should be from /usr/include/asm-sparc
41 These two files define pt_regs structure differently
42 */
43 #ifdef _LP64
44 #include "asm-sparc64/ptrace.h"
45 #else
46 #include "asm-sparc/ptrace.h"
47 #endif
49 #endif //sparc or sparcv9
51 /************************************************************************************
53 0. This is very minimal subset of Solaris libproc just enough for current application.
54 Please note that the bulk of the functionality is from proc_service interface. This
55 adds Pgrab__ and some missing stuff. We hide the difference b/w live process and core
56 file by this interface.
58 1. pthread_id unique in both NPTL & LinuxThreads. We store this in
59 OSThread::_pthread_id in JVM code.
61 2. All threads see the same pid when they call getpid() under NPTL.
62 Threads receive different pid under LinuxThreads. We used to save the result of
63 ::getpid() call in OSThread::_thread_id. This way uniqueness of OSThread::_thread_id
64 was lost under NPTL. Now, we store the result of ::gettid() call in
65 OSThread::_thread_id. Because gettid returns actual pid of thread (lwp id), this is
66 unique again. We therefore use OSThread::_thread_id as unique identifier.
68 3. There is a unique LWP id under both thread libraries. libthread_db maps pthread_id
69 to its underlying lwp_id under both the thread libraries. thread_info.lwp_id stores
70 lwp_id of the thread. The lwp id is nothing but the actual pid of clone'd processes. But
71 unfortunately libthread_db does not work very well for core dumps. So, we get pthread_id
72 only for processes. For core dumps, we don't use libthread_db at all (like gdb).
74 4. ptrace operates on this LWP id under both the thread libraries. When we say 'pid' for
75 ptrace call, we refer to lwp_id of the thread.
77 5. for core file, we parse ELF files and read data from them. For processes we use
78 combination of ptrace and /proc calls.
80 *************************************************************************************/
82 #ifdef ia64
83 struct user_regs_struct {
84 /* copied from user.h which doesn't define this in a struct */
86 #define IA64_REG_COUNT (EF_SIZE/8+32) /* integer and fp regs */
87 unsigned long regs[IA64_REG_COUNT]; /* integer and fp regs */
88 };
89 #endif
91 #if defined(sparc) || defined(sparcv9)
92 #define user_regs_struct pt_regs
93 #endif
95 // This C bool type must be int for compatibility with Linux calls and
96 // it would be a mistake to equivalence it to C++ bool on many platforms
98 typedef int bool;
99 #define true 1
100 #define false 0
102 struct ps_prochandle;
104 // attach to a process
105 struct ps_prochandle* Pgrab(pid_t pid);
107 // attach to a core dump
108 struct ps_prochandle* Pgrab_core(const char* execfile, const char* corefile);
110 // release a process or core
111 void Prelease(struct ps_prochandle* ph);
113 // functions not directly available in Solaris libproc
115 // initialize libproc (call this only once per app)
116 // pass true to make library verbose
117 bool init_libproc(bool verbose);
119 // get number of threads
120 int get_num_threads(struct ps_prochandle* ph);
122 // get lwp_id of n'th thread
123 lwpid_t get_lwp_id(struct ps_prochandle* ph, int index);
125 // get regs for a given lwp
126 bool get_lwp_regs(struct ps_prochandle* ph, lwpid_t lid, struct user_regs_struct* regs);
128 // get number of shared objects
129 int get_num_libs(struct ps_prochandle* ph);
131 // get name of n'th lib
132 const char* get_lib_name(struct ps_prochandle* ph, int index);
134 // get base of lib
135 uintptr_t get_lib_base(struct ps_prochandle* ph, int index);
137 // returns true if given library is found in lib list
138 bool find_lib(struct ps_prochandle* ph, const char *lib_name);
140 // symbol lookup
141 uintptr_t lookup_symbol(struct ps_prochandle* ph, const char* object_name,
142 const char* sym_name);
144 // address->nearest symbol lookup. return NULL for no symbol
145 const char* symbol_for_pc(struct ps_prochandle* ph, uintptr_t addr, uintptr_t* poffset);
147 struct ps_prochandle* get_proc_handle(JNIEnv* env, jobject this_obj);
149 void throw_new_debugger_exception(JNIEnv* env, const char* errMsg);
151 #endif //__LIBPROC_H_