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