annotate agent/src/os/bsd/libproc.h @ 6810:a3fd4914ac81

Added tag jdk8-b59 for changeset 8a1a6b9b4f20
author katleman
date Thu, 04 Oct 2012 14:34:51 -0700
parents f08d439fab8c
children 39432a1cefdd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3960
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
1 /*
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
2 * Copyright (c) 2003, 2007, Oracle and/or its affiliates. All rights reserved.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
4 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
7 * published by the Free Software Foundation.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
8 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
13 * accompanied this code).
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
14 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
18 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
21 * questions.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
22 *
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
23 */
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
24
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
25 #ifndef _LIBPROC_H_
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
26 #define _LIBPROC_H_
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
27
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
28 #include <unistd.h>
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
29 #include <stdint.h>
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
30 #include <machine/reg.h>
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
31 #include <proc_service.h>
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
32
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
33 #if defined(sparc) || defined(sparcv9)
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
34 /*
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
35 If _LP64 is defined ptrace.h should be taken from /usr/include/asm-sparc64
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
36 otherwise it should be from /usr/include/asm-sparc
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
37 These two files define pt_regs structure differently
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
38 */
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
39 #ifdef _LP64
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
40 #include "asm-sparc64/ptrace.h"
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
41 #else
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
42 #include "asm-sparc/ptrace.h"
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
43 #endif
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
44
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
45 #endif //sparc or sparcv9
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
46
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
47 /************************************************************************************
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
48
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
49 0. This is very minimal subset of Solaris libproc just enough for current application.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
50 Please note that the bulk of the functionality is from proc_service interface. This
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
51 adds Pgrab__ and some missing stuff. We hide the difference b/w live process and core
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
52 file by this interface.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
53
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
54 1. pthread_id is unique. We store this in OSThread::_pthread_id in JVM code.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
55
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
56 2. All threads see the same pid when they call getpid().
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
57 We used to save the result of ::getpid() call in OSThread::_thread_id.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
58 Because gettid returns actual pid of thread (lwp id), this is
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
59 unique again. We therefore use OSThread::_thread_id as unique identifier.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
60
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
61 3. There is a unique LWP id under both thread libraries. libthread_db maps pthread_id
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
62 to its underlying lwp_id under both the thread libraries. thread_info.lwp_id stores
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
63 lwp_id of the thread. The lwp id is nothing but the actual pid of clone'd processes. But
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
64 unfortunately libthread_db does not work very well for core dumps. So, we get pthread_id
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
65 only for processes. For core dumps, we don't use libthread_db at all (like gdb).
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
66
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
67 4. ptrace operates on this LWP id under both the thread libraries. When we say 'pid' for
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
68 ptrace call, we refer to lwp_id of the thread.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
69
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
70 5. for core file, we parse ELF files and read data from them. For processes we use
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
71 combination of ptrace and /proc calls.
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
72
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
73 *************************************************************************************/
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
74
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
75 // This C bool type must be int for compatibility with BSD calls and
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
76 // it would be a mistake to equivalence it to C++ bool on many platforms
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
77
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
78 typedef int bool;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
79 #define true 1
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
80 #define false 0
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
81
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
82 struct ps_prochandle;
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
83
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
84 // attach to a process
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
85 struct ps_prochandle* Pgrab(pid_t pid);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
86
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
87 // attach to a core dump
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
88 struct ps_prochandle* Pgrab_core(const char* execfile, const char* corefile);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
89
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
90 // release a process or core
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
91 void Prelease(struct ps_prochandle* ph);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
92
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
93 // functions not directly available in Solaris libproc
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
94
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
95 // initialize libproc (call this only once per app)
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
96 // pass true to make library verbose
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
97 bool init_libproc(bool verbose);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
98
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
99 // get number of threads
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
100 int get_num_threads(struct ps_prochandle* ph);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
101
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
102 // get lwp_id of n'th thread
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
103 lwpid_t get_lwp_id(struct ps_prochandle* ph, int index);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
104
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
105 // get regs for a given lwp
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
106 bool get_lwp_regs(struct ps_prochandle* ph, lwpid_t lid, struct reg* regs);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
107
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
108 // get number of shared objects
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
109 int get_num_libs(struct ps_prochandle* ph);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
110
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
111 // get name of n'th lib
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
112 const char* get_lib_name(struct ps_prochandle* ph, int index);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
113
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
114 // get base of lib
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
115 uintptr_t get_lib_base(struct ps_prochandle* ph, int index);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
116
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
117 // returns true if given library is found in lib list
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
118 bool find_lib(struct ps_prochandle* ph, const char *lib_name);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
119
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
120 // symbol lookup
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
121 uintptr_t lookup_symbol(struct ps_prochandle* ph, const char* object_name,
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
122 const char* sym_name);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
123
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
124 // address->nearest symbol lookup. return NULL for no symbol
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
125 const char* symbol_for_pc(struct ps_prochandle* ph, uintptr_t addr, uintptr_t* poffset);
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
126
f08d439fab8c 7089790: integrate bsd-port changes
never
parents:
diff changeset
127 #endif //__LIBPROC_H_