annotate agent/src/os/solaris/proc/salibproc.h @ 0:a61af66fc99e jdk7-b24

Initial load
author duke
date Sat, 01 Dec 2007 00:00:00 +0000
parents
children c18cbe5936b8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
2 * Copyright 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
a61af66fc99e Initial load
duke
parents:
diff changeset
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
a61af66fc99e Initial load
duke
parents:
diff changeset
20 * CA 95054 USA or visit www.sun.com if you need additional information or
a61af66fc99e Initial load
duke
parents:
diff changeset
21 * have any questions.
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24 #ifndef _SALIBPROC_H_
a61af66fc99e Initial load
duke
parents:
diff changeset
25 #define _SALIBPROC_H_
a61af66fc99e Initial load
duke
parents:
diff changeset
26
a61af66fc99e Initial load
duke
parents:
diff changeset
27 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
28 * The following definitions, prototypes are from Solaris libproc.h.
a61af66fc99e Initial load
duke
parents:
diff changeset
29 * We used to use the copy of it from Solaris 8.0. But there are
a61af66fc99e Initial load
duke
parents:
diff changeset
30 * problems with that approach in building this library across Solaris
a61af66fc99e Initial load
duke
parents:
diff changeset
31 * versions. Solaris 10 has libproc.h in /usr/include. And libproc.h
a61af66fc99e Initial load
duke
parents:
diff changeset
32 * varies slightly across Solaris versions. On Solaris 9, we get
a61af66fc99e Initial load
duke
parents:
diff changeset
33 * 'sysret_t multiply defined' error. This is common minimum subset we
a61af66fc99e Initial load
duke
parents:
diff changeset
34 * really need from libproc.h. The libproc.h in the current dir has
a61af66fc99e Initial load
duke
parents:
diff changeset
35 * been left for reference and not used in build.
a61af66fc99e Initial load
duke
parents:
diff changeset
36 */
a61af66fc99e Initial load
duke
parents:
diff changeset
37
a61af66fc99e Initial load
duke
parents:
diff changeset
38 #include <dlfcn.h>
a61af66fc99e Initial load
duke
parents:
diff changeset
39 #include <gelf.h>
a61af66fc99e Initial load
duke
parents:
diff changeset
40 #include <procfs.h>
a61af66fc99e Initial load
duke
parents:
diff changeset
41 #include <proc_service.h>
a61af66fc99e Initial load
duke
parents:
diff changeset
42 #include <fcntl.h>
a61af66fc99e Initial load
duke
parents:
diff changeset
43 #include <unistd.h>
a61af66fc99e Initial load
duke
parents:
diff changeset
44
a61af66fc99e Initial load
duke
parents:
diff changeset
45 #ifdef __cplusplus
a61af66fc99e Initial load
duke
parents:
diff changeset
46 extern "C" {
a61af66fc99e Initial load
duke
parents:
diff changeset
47 #endif
a61af66fc99e Initial load
duke
parents:
diff changeset
48
a61af66fc99e Initial load
duke
parents:
diff changeset
49 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
50 * 'object_name' is the name of a load object obtained from an
a61af66fc99e Initial load
duke
parents:
diff changeset
51 * iteration over the process's address space mappings (Pmapping_iter),
a61af66fc99e Initial load
duke
parents:
diff changeset
52 * or an iteration over the process's mapped objects (Pobject_iter),
a61af66fc99e Initial load
duke
parents:
diff changeset
53 * or else it is one of the special PR_OBJ_* values above.
a61af66fc99e Initial load
duke
parents:
diff changeset
54 */
a61af66fc99e Initial load
duke
parents:
diff changeset
55
a61af66fc99e Initial load
duke
parents:
diff changeset
56 extern int Plookup_by_addr(struct ps_prochandle *,
a61af66fc99e Initial load
duke
parents:
diff changeset
57 uintptr_t, char *, size_t, GElf_Sym *);
a61af66fc99e Initial load
duke
parents:
diff changeset
58
a61af66fc99e Initial load
duke
parents:
diff changeset
59 typedef int proc_map_f(void *, const prmap_t *, const char *);
a61af66fc99e Initial load
duke
parents:
diff changeset
60 extern int Pobject_iter(struct ps_prochandle *, proc_map_f *, void *);
a61af66fc99e Initial load
duke
parents:
diff changeset
61
a61af66fc99e Initial load
duke
parents:
diff changeset
62 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
63 * Utility functions for processing arguments which should be /proc files,
a61af66fc99e Initial load
duke
parents:
diff changeset
64 * pids, and/or core files. The returned error code can be passed to
a61af66fc99e Initial load
duke
parents:
diff changeset
65 * Pgrab_error() in order to convert it to an error string.
a61af66fc99e Initial load
duke
parents:
diff changeset
66 */
a61af66fc99e Initial load
duke
parents:
diff changeset
67 #define PR_ARG_PIDS 0x1 /* Allow pid and /proc file arguments */
a61af66fc99e Initial load
duke
parents:
diff changeset
68 #define PR_ARG_CORES 0x2 /* Allow core file arguments */
a61af66fc99e Initial load
duke
parents:
diff changeset
69 #define PR_ARG_ANY (PR_ARG_PIDS | PR_ARG_CORES)
a61af66fc99e Initial load
duke
parents:
diff changeset
70
a61af66fc99e Initial load
duke
parents:
diff changeset
71 /* Flags accepted by Pgrab() (partial) */
a61af66fc99e Initial load
duke
parents:
diff changeset
72 #define PGRAB_FORCE 0x02 /* Open the process w/o O_EXCL */
a61af66fc99e Initial load
duke
parents:
diff changeset
73
a61af66fc99e Initial load
duke
parents:
diff changeset
74 /* Error codes from Pgrab(), Pfgrab_core(), and Pgrab_core() */
a61af66fc99e Initial load
duke
parents:
diff changeset
75 #define G_STRANGE -1 /* Unanticipated error, errno is meaningful */
a61af66fc99e Initial load
duke
parents:
diff changeset
76 #define G_NOPROC 1 /* No such process */
a61af66fc99e Initial load
duke
parents:
diff changeset
77 #define G_NOCORE 2 /* No such core file */
a61af66fc99e Initial load
duke
parents:
diff changeset
78 #define G_NOPROCORCORE 3 /* No such proc or core (for proc_arg_grab) */
a61af66fc99e Initial load
duke
parents:
diff changeset
79 #define G_NOEXEC 4 /* Cannot locate executable file */
a61af66fc99e Initial load
duke
parents:
diff changeset
80 #define G_ZOMB 5 /* Zombie process */
a61af66fc99e Initial load
duke
parents:
diff changeset
81 #define G_PERM 6 /* No permission */
a61af66fc99e Initial load
duke
parents:
diff changeset
82 #define G_BUSY 7 /* Another process has control */
a61af66fc99e Initial load
duke
parents:
diff changeset
83 #define G_SYS 8 /* System process */
a61af66fc99e Initial load
duke
parents:
diff changeset
84 #define G_SELF 9 /* Process is self */
a61af66fc99e Initial load
duke
parents:
diff changeset
85 #define G_INTR 10 /* Interrupt received while grabbing */
a61af66fc99e Initial load
duke
parents:
diff changeset
86 #define G_LP64 11 /* Process is _LP64, self is ILP32 */
a61af66fc99e Initial load
duke
parents:
diff changeset
87 #define G_FORMAT 12 /* File is not an ELF format core file */
a61af66fc99e Initial load
duke
parents:
diff changeset
88 #define G_ELF 13 /* Libelf error, elf_errno() is meaningful */
a61af66fc99e Initial load
duke
parents:
diff changeset
89 #define G_NOTE 14 /* Required PT_NOTE Phdr not present in core */
a61af66fc99e Initial load
duke
parents:
diff changeset
90
a61af66fc99e Initial load
duke
parents:
diff changeset
91 extern struct ps_prochandle *proc_arg_grab(const char *, int, int, int *);
a61af66fc99e Initial load
duke
parents:
diff changeset
92 extern const pstatus_t *Pstatus(struct ps_prochandle *);
a61af66fc99e Initial load
duke
parents:
diff changeset
93
a61af66fc99e Initial load
duke
parents:
diff changeset
94 /* Flags accepted by Prelease (partial) */
a61af66fc99e Initial load
duke
parents:
diff changeset
95 #define PRELEASE_CLEAR 0x10 /* Clear all tracing flags */
a61af66fc99e Initial load
duke
parents:
diff changeset
96
a61af66fc99e Initial load
duke
parents:
diff changeset
97 extern void Prelease(struct ps_prochandle *, int);
a61af66fc99e Initial load
duke
parents:
diff changeset
98 extern int Psetrun(struct ps_prochandle *, int, int);
a61af66fc99e Initial load
duke
parents:
diff changeset
99 extern int Pstop(struct ps_prochandle *, uint_t);
a61af66fc99e Initial load
duke
parents:
diff changeset
100
a61af66fc99e Initial load
duke
parents:
diff changeset
101 /*
a61af66fc99e Initial load
duke
parents:
diff changeset
102 * Stack frame iteration interface.
a61af66fc99e Initial load
duke
parents:
diff changeset
103 */
a61af66fc99e Initial load
duke
parents:
diff changeset
104 typedef int proc_stack_f(void *, const prgregset_t, uint_t, const long *);
a61af66fc99e Initial load
duke
parents:
diff changeset
105 extern int Pstack_iter(struct ps_prochandle *,
a61af66fc99e Initial load
duke
parents:
diff changeset
106 const prgregset_t, proc_stack_f *, void *);
a61af66fc99e Initial load
duke
parents:
diff changeset
107
a61af66fc99e Initial load
duke
parents:
diff changeset
108 #define PR_OBJ_EVERY ((const char *)-1) /* search every load object */
a61af66fc99e Initial load
duke
parents:
diff changeset
109
a61af66fc99e Initial load
duke
parents:
diff changeset
110
a61af66fc99e Initial load
duke
parents:
diff changeset
111 #ifdef __cplusplus
a61af66fc99e Initial load
duke
parents:
diff changeset
112 }
a61af66fc99e Initial load
duke
parents:
diff changeset
113 #endif
a61af66fc99e Initial load
duke
parents:
diff changeset
114
a61af66fc99e Initial load
duke
parents:
diff changeset
115 #endif /* _SALIBPROC_H_ */