Print this page
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/lib/libproc/common/Pcontrol.h
+++ new/usr/src/lib/libproc/common/Pcontrol.h
1 1 /*
2 2 * CDDL HEADER START
3 3 *
4 4 * The contents of this file are subject to the terms of the
5 5 * Common Development and Distribution License (the "License").
6 6 * You may not use this file except in compliance with the License.
7 7 *
8 8 * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9 9 * or http://www.opensolaris.org/os/licensing.
10 10 * See the License for the specific language governing permissions
11 11 * and limitations under the License.
12 12 *
13 13 * When distributing Covered Code, include this CDDL HEADER in each
14 14 * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15 15 * If applicable, add the following below this CDDL HEADER, with the
16 16 * fields enclosed by brackets "[]" replaced with your own identifying
17 17 * information: Portions Copyright [yyyy] [name of copyright owner]
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21 /*
22 22 * Copyright 2008 Sun Microsystems, Inc. All rights reserved.
23 23 * Use is subject to license terms.
24 24 */
25 25 /*
26 26 * Copyright 2012 DEY Storage Systems, Inc. All rights reserved.
27 27 * Copyright (c) 2015, Joyent, Inc. All rights reserved.
28 28 * Copyright (c) 2013 by Delphix. All rights reserved.
29 29 */
30 30
31 31 #ifndef _PCONTROL_H
32 32 #define _PCONTROL_H
33 33
34 34 /*
35 35 * Implemention-specific include file for libproc process management.
36 36 * This is not to be seen by the clients of libproc.
37 37 */
38 38
39 39 #include <stdio.h>
40 40 #include <gelf.h>
41 41 #include <synch.h>
42 42 #include <procfs.h>
43 43 #include <rtld_db.h>
44 44 #include <libproc.h>
45 45 #include <libctf.h>
46 46 #include <limits.h>
47 47 #include <libproc.h>
48 48
49 49 #ifdef __cplusplus
50 50 extern "C" {
51 51 #endif
52 52
53 53 #include "Putil.h"
54 54
55 55 /*
56 56 * Definitions of the process control structures, internal to libproc.
57 57 * These may change without affecting clients of libproc.
58 58 */
59 59
60 60 /*
61 61 * sym_tbl_t contains a primary and an (optional) auxiliary symbol table, which
62 62 * we wish to treat as a single logical symbol table. In this logical table,
63 63 * the data from the auxiliary table preceeds that from the primary. Symbol
64 64 * indices start at [0], which is the first item in the auxiliary table
65 65 * if there is one. The sole purpose for this is so that we can treat the
66 66 * combination of .SUNW_ldynsym and .dynsym sections as a logically single
67 67 * entity without having to violate the public interface to libelf.
68 68 *
69 69 * Both tables must share the same string table section.
70 70 *
71 71 * The symtab_getsym() function serves as a gelf_getsym() replacement
72 72 * that is aware of the two tables and makes them look like a single table
73 73 * to the caller.
74 74 *
75 75 */
76 76 typedef struct sym_tbl { /* symbol table */
77 77 Elf_Data *sym_data_pri; /* primary table */
78 78 Elf_Data *sym_data_aux; /* auxiliary table */
79 79 size_t sym_symn_aux; /* number of entries in auxiliary table */
80 80 size_t sym_symn; /* total number of entries in both tables */
81 81 char *sym_strs; /* ptr to strings */
82 82 size_t sym_strsz; /* size of string table */
83 83 GElf_Shdr sym_hdr_pri; /* primary symbol table section header */
84 84 GElf_Shdr sym_hdr_aux; /* auxiliary symbol table section header */
85 85 GElf_Shdr sym_strhdr; /* string table section header */
86 86 Elf *sym_elf; /* faked-up ELF handle from core file */
87 87 void *sym_elfmem; /* data for faked-up ELF handle */
88 88 uint_t *sym_byname; /* symbols sorted by name */
89 89 uint_t *sym_byaddr; /* symbols sorted by addr */
90 90 size_t sym_count; /* number of symbols in each sorted list */
91 91 } sym_tbl_t;
92 92
93 93 typedef struct file_info { /* symbol information for a mapped file */
94 94 plist_t file_list; /* linked list */
95 95 char file_pname[PATH_MAX]; /* name from prmap_t */
96 96 struct map_info *file_map; /* primary (text) mapping */
97 97 int file_ref; /* references from map_info_t structures */
98 98 int file_fd; /* file descriptor for the mapped file */
99 99 int file_dbgfile; /* file descriptor for the debug file */
100 100 int file_init; /* 0: initialization yet to be performed */
101 101 GElf_Half file_etype; /* ELF e_type from ehdr */
102 102 GElf_Half file_class; /* ELF e_ident[EI_CLASS] from ehdr */
103 103 rd_loadobj_t *file_lo; /* load object structure from rtld_db */
104 104 char *file_lname; /* load object name from rtld_db */
105 105 char *file_lbase; /* pointer to basename of file_lname */
106 106 char *file_rname; /* resolved on-disk object pathname */
107 107 char *file_rbase; /* pointer to basename of file_rname */
108 108 Elf *file_elf; /* ELF handle so we can close */
109 109 Elf *file_dbgelf; /* Debug ELF handle so we can close */
110 110 void *file_elfmem; /* data for faked-up ELF handle */
111 111 sym_tbl_t file_symtab; /* symbol table */
112 112 sym_tbl_t file_dynsym; /* dynamic symbol table */
113 113 uintptr_t file_dyn_base; /* load address for ET_DYN files */
114 114 uintptr_t file_plt_base; /* base address for PLT */
115 115 size_t file_plt_size; /* size of PLT region */
|
↓ open down ↓ |
115 lines elided |
↑ open up ↑ |
116 116 uintptr_t file_jmp_rel; /* base address of PLT relocations */
117 117 uintptr_t file_ctf_off; /* offset of CTF data in object file */
118 118 size_t file_ctf_size; /* size of CTF data in object file */
119 119 int file_ctf_dyn; /* does the CTF data reference the dynsym */
120 120 void *file_ctf_buf; /* CTF data for this file */
121 121 ctf_file_t *file_ctfp; /* CTF container for this file */
122 122 char *file_shstrs; /* section header string table */
123 123 size_t file_shstrsz; /* section header string table size */
124 124 uintptr_t *file_saddrs; /* section header addresses */
125 125 uint_t file_nsaddrs; /* number of section header addresses */
126 - boolean_t file_cvt; /* Have we tried to convert this? */
127 126 } file_info_t;
128 127
129 128 typedef struct map_info { /* description of an address space mapping */
130 129 prmap_t map_pmap; /* /proc description of this mapping */
131 130 file_info_t *map_file; /* pointer into list of mapped files */
132 131 off64_t map_offset; /* offset into core file (if core) */
133 132 int map_relocate; /* associated file_map needs to be relocated */
134 133 } map_info_t;
135 134
136 135 typedef struct lwp_info { /* per-lwp information from core file */
137 136 plist_t lwp_list; /* linked list */
138 137 lwpid_t lwp_id; /* lwp identifier */
139 138 lwpsinfo_t lwp_psinfo; /* /proc/<pid>/lwp/<lwpid>/lwpsinfo data */
140 139 lwpstatus_t lwp_status; /* /proc/<pid>/lwp/<lwpid>/lwpstatus data */
141 140 #if defined(sparc) || defined(__sparc)
142 141 gwindows_t *lwp_gwins; /* /proc/<pid>/lwp/<lwpid>/gwindows data */
143 142 prxregset_t *lwp_xregs; /* /proc/<pid>/lwp/<lwpid>/xregs data */
144 143 int64_t *lwp_asrs; /* /proc/<pid>/lwp/<lwpid>/asrs data */
145 144 #endif
146 145 } lwp_info_t;
147 146
148 147 typedef struct fd_info {
149 148 plist_t fd_list; /* linked list */
150 149 prfdinfo_t fd_info; /* fd info */
151 150 } fd_info_t;
152 151
153 152 typedef struct core_info { /* information specific to core files */
154 153 char core_dmodel; /* data model for core file */
155 154 char core_osabi; /* ELF OS ABI */
156 155 int core_errno; /* error during initialization if != 0 */
157 156 plist_t core_lwp_head; /* head of list of lwp info */
158 157 lwp_info_t *core_lwp; /* current lwp information */
159 158 uint_t core_nlwp; /* number of lwp's in list */
160 159 off64_t core_size; /* size of core file in bytes */
161 160 char *core_platform; /* platform string from core file */
162 161 struct utsname *core_uts; /* uname(2) data from core file */
163 162 prcred_t *core_cred; /* process credential from core file */
164 163 core_content_t core_content; /* content dumped to core file */
165 164 prpriv_t *core_priv; /* process privileges from core file */
166 165 size_t core_priv_size; /* size of the privileges */
167 166 void *core_privinfo; /* system privileges info from core file */
168 167 priv_impl_info_t *core_ppii; /* NOTE entry for core_privinfo */
169 168 char *core_zonename; /* zone name from core file */
170 169 #if defined(__i386) || defined(__amd64)
171 170 struct ssd *core_ldt; /* LDT entries from core file */
172 171 uint_t core_nldt; /* number of LDT entries in core file */
173 172 #endif
174 173 } core_info_t;
175 174
176 175 typedef struct elf_file_header { /* extended ELF header */
177 176 unsigned char e_ident[EI_NIDENT];
178 177 Elf64_Half e_type;
179 178 Elf64_Half e_machine;
180 179 Elf64_Word e_version;
181 180 Elf64_Addr e_entry;
182 181 Elf64_Off e_phoff;
183 182 Elf64_Off e_shoff;
184 183 Elf64_Word e_flags;
185 184 Elf64_Half e_ehsize;
186 185 Elf64_Half e_phentsize;
187 186 Elf64_Half e_shentsize;
188 187 Elf64_Word e_phnum; /* phdr count extended to 32 bits */
189 188 Elf64_Word e_shnum; /* shdr count extended to 32 bits */
190 189 Elf64_Word e_shstrndx; /* shdr string index extended to 32 bits */
191 190 } elf_file_header_t;
192 191
193 192 typedef struct elf_file { /* convenience for managing ELF files */
194 193 elf_file_header_t e_hdr; /* Extended ELF header */
195 194 Elf *e_elf; /* ELF library handle */
196 195 int e_fd; /* file descriptor */
197 196 } elf_file_t;
198 197
199 198 #define HASHSIZE 1024 /* hash table size, power of 2 */
200 199
201 200 struct ps_prochandle {
202 201 struct ps_lwphandle **hashtab; /* hash table for LWPs (Lgrab()) */
203 202 mutex_t proc_lock; /* protects hash table; serializes Lgrab() */
204 203 pstatus_t orig_status; /* remembered status on Pgrab() */
205 204 pstatus_t status; /* status when stopped */
206 205 psinfo_t psinfo; /* psinfo_t from last Ppsinfo() request */
207 206 uintptr_t sysaddr; /* address of most recent syscall instruction */
208 207 pid_t pid; /* process-ID */
209 208 int state; /* state of the process, see "libproc.h" */
210 209 uint_t flags; /* see defines below */
211 210 uint_t agentcnt; /* Pcreate_agent()/Pdestroy_agent() ref count */
212 211 int asfd; /* /proc/<pid>/as filedescriptor */
213 212 int ctlfd; /* /proc/<pid>/ctl filedescriptor */
214 213 int statfd; /* /proc/<pid>/status filedescriptor */
215 214 int agentctlfd; /* /proc/<pid>/lwp/agent/ctl */
216 215 int agentstatfd; /* /proc/<pid>/lwp/agent/status */
217 216 int info_valid; /* if zero, map and file info need updating */
218 217 map_info_t *mappings; /* cached process mappings */
219 218 size_t map_count; /* number of mappings */
220 219 size_t map_alloc; /* number of mappings allocated */
221 220 uint_t num_files; /* number of file elements in file_info */
222 221 plist_t file_head; /* head of mapped files w/ symbol table info */
223 222 char *execname; /* name of the executable file */
224 223 auxv_t *auxv; /* the process's aux vector */
225 224 int nauxv; /* number of aux vector entries */
226 225 rd_agent_t *rap; /* cookie for rtld_db */
227 226 map_info_t *map_exec; /* the mapping for the executable file */
228 227 map_info_t *map_ldso; /* the mapping for ld.so.1 */
229 228 ps_ops_t ops; /* ops-vector */
230 229 uintptr_t *ucaddrs; /* ucontext-list addresses */
231 230 uint_t ucnelems; /* number of elements in the ucaddrs list */
232 231 char *zoneroot; /* cached path to zone root */
233 232 plist_t fd_head; /* head of file desc info list */
234 233 int num_fd; /* number of file descs in list */
235 234 uintptr_t map_missing; /* first missing mapping in core due to sig */
236 235 siginfo_t killinfo; /* signal that interrupted core dump */
237 236 psinfo_t spymaster; /* agent LWP's spymaster, if any */
238 237 void *data; /* private data */
239 238 };
240 239
241 240 /* flags */
242 241 #define CREATED 0x01 /* process was created by Pcreate() */
243 242 #define SETSIG 0x02 /* set signal trace mask before continuing */
244 243 #define SETFAULT 0x04 /* set fault trace mask before continuing */
245 244 #define SETENTRY 0x08 /* set sysentry trace mask before continuing */
246 245 #define SETEXIT 0x10 /* set sysexit trace mask before continuing */
247 246 #define SETHOLD 0x20 /* set signal hold mask before continuing */
248 247 #define SETREGS 0x40 /* set registers before continuing */
249 248 #define INCORE 0x80 /* use in-core data to build symbol tables */
250 249
251 250 struct ps_lwphandle {
252 251 struct ps_prochandle *lwp_proc; /* process to which this lwp belongs */
253 252 struct ps_lwphandle *lwp_hash; /* hash table linked list */
254 253 lwpstatus_t lwp_status; /* status when stopped */
255 254 lwpsinfo_t lwp_psinfo; /* lwpsinfo_t from last Lpsinfo() */
256 255 lwpid_t lwp_id; /* lwp identifier */
257 256 int lwp_state; /* state of the lwp, see "libproc.h" */
258 257 uint_t lwp_flags; /* SETHOLD and/or SETREGS */
259 258 int lwp_ctlfd; /* /proc/<pid>/lwp/<lwpid>/lwpctl */
260 259 int lwp_statfd; /* /proc/<pid>/lwp/<lwpid>/lwpstatus */
261 260 };
262 261
263 262 /*
264 263 * Implementation functions in the process control library.
265 264 * These are not exported to clients of the library.
266 265 */
267 266 extern void prldump(const char *, lwpstatus_t *);
268 267 extern int dupfd(int, int);
269 268 extern int set_minfd(void);
270 269 extern int Pscantext(struct ps_prochandle *);
271 270 extern void Pinitsym(struct ps_prochandle *);
272 271 extern void Preadauxvec(struct ps_prochandle *);
273 272 extern void optimize_symtab(sym_tbl_t *);
274 273 extern void Pbuild_file_symtab(struct ps_prochandle *, file_info_t *);
275 274 extern ctf_file_t *Pbuild_file_ctf(struct ps_prochandle *, file_info_t *);
276 275 extern map_info_t *Paddr2mptr(struct ps_prochandle *, uintptr_t);
277 276 extern char *Pfindexec(struct ps_prochandle *, const char *,
278 277 int (*)(const char *, void *), void *);
279 278 extern int getlwpstatus(struct ps_prochandle *, lwpid_t, lwpstatus_t *);
280 279 int Pstopstatus(struct ps_prochandle *, long, uint32_t);
281 280 extern file_info_t *file_info_new(struct ps_prochandle *, map_info_t *);
282 281 extern char *Plofspath(const char *, char *, size_t);
283 282 extern char *Pzoneroot(struct ps_prochandle *, char *, size_t);
284 283 extern char *Pzonepath(struct ps_prochandle *, const char *, char *,
285 284 size_t);
286 285 extern fd_info_t *Pfd2info(struct ps_prochandle *, int);
287 286
288 287 extern char *Pfindmap(struct ps_prochandle *, map_info_t *, char *,
289 288 size_t);
290 289
291 290 extern int Padd_mapping(struct ps_prochandle *, off64_t, file_info_t *,
292 291 prmap_t *);
293 292 extern void Psort_mappings(struct ps_prochandle *);
294 293
295 294 extern char procfs_path[PATH_MAX];
296 295
297 296 /*
298 297 * Architecture-dependent definition of the breakpoint instruction.
299 298 */
300 299 #if defined(sparc) || defined(__sparc)
301 300 #define BPT ((instr_t)0x91d02001)
302 301 #elif defined(__i386) || defined(__amd64)
303 302 #define BPT ((instr_t)0xcc)
304 303 #endif
305 304
306 305 /*
307 306 * Simple convenience.
308 307 */
309 308 #define TRUE 1
310 309 #define FALSE 0
311 310
312 311 #ifdef __cplusplus
313 312 }
314 313 #endif
315 314
316 315 #endif /* _PCONTROL_H */
|
↓ open down ↓ |
180 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX