Print this page
8158 Want named threads API
9857 proc manpages should have LIBRARY section
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/lib/libproc/common/libproc.h
+++ new/usr/src/lib/libproc/common/libproc.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]
|
↓ open down ↓ |
17 lines elided |
↑ open up ↑ |
18 18 *
19 19 * CDDL HEADER END
20 20 */
21 21
22 22 /*
23 23 * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
24 24 * Use is subject to license terms.
25 25 *
26 26 * Portions Copyright 2007 Chad Mynhier
27 27 * Copyright 2012 DEY Storage Systems, Inc. All rights reserved.
28 - * Copyright 2015, Joyent, Inc.
28 + * Copyright 2018, Joyent, Inc.
29 29 * Copyright (c) 2013 by Delphix. All rights reserved.
30 30 */
31 31
32 32 /*
33 33 * Interfaces available from the process control library, libproc.
34 34 */
35 35
36 36 #ifndef _LIBPROC_H
37 37 #define _LIBPROC_H
38 38
39 39 #include <stdlib.h>
40 40 #include <unistd.h>
41 41 #include <fcntl.h>
42 42 #include <nlist.h>
43 43 #include <door.h>
44 44 #include <gelf.h>
45 45 #include <proc_service.h>
46 46 #include <rtld_db.h>
47 47 #include <procfs.h>
48 48 #include <ucred.h>
49 49 #include <rctl.h>
50 50 #include <libctf.h>
51 51 #include <sys/stat.h>
52 52 #include <sys/statvfs.h>
53 53 #include <sys/auxv.h>
54 54 #include <sys/resource.h>
55 55 #include <sys/socket.h>
56 56 #include <sys/utsname.h>
57 57 #include <sys/corectl.h>
58 58 #include <sys/secflags.h>
59 59 #if defined(__i386) || defined(__amd64)
60 60 #include <sys/sysi86.h>
61 61 #endif
62 62
63 63 #ifdef __cplusplus
64 64 extern "C" {
65 65 #endif
66 66
67 67 /*
68 68 * Opaque structure tag reference to a process control structure.
69 69 * Clients of libproc cannot look inside the process control structure.
70 70 * The implementation of struct ps_prochandle can change w/o affecting clients.
71 71 */
72 72 struct ps_prochandle;
73 73
74 74 /*
75 75 * Opaque structure tag reference to an lwp control structure.
76 76 */
77 77 struct ps_lwphandle;
78 78
79 79 extern int _libproc_debug; /* set non-zero to enable debugging fprintfs */
80 80 extern int _libproc_no_qsort; /* set non-zero to inhibit sorting */
81 81 /* of symbol tables */
82 82 extern int _libproc_incore_elf; /* only use in-core elf data */
83 83
84 84 #if defined(__sparc)
85 85 #define R_RVAL1 R_O0 /* register holding a function return value */
86 86 #define R_RVAL2 R_O1 /* 32 more bits for a 64-bit return value */
87 87 #endif /* __sparc */
88 88
89 89 #if defined(__amd64)
90 90 #define R_PC REG_RIP
91 91 #define R_SP REG_RSP
92 92 #define R_RVAL1 REG_RAX /* register holding a function return value */
93 93 #define R_RVAL2 REG_RDX /* 32 more bits for a 64-bit return value */
94 94 #elif defined(__i386)
95 95 #define R_PC EIP
96 96 #define R_SP UESP
97 97 #define R_RVAL1 EAX /* register holding a function return value */
98 98 #define R_RVAL2 EDX /* 32 more bits for a 64-bit return value */
99 99 #endif /* __amd64 || __i386 */
100 100
101 101 #define R_RVAL R_RVAL1 /* simple function return value register */
102 102
103 103 /* maximum sizes of things */
104 104 #define PRMAXSIG (32 * sizeof (sigset_t) / sizeof (uint32_t))
105 105 #define PRMAXFAULT (32 * sizeof (fltset_t) / sizeof (uint32_t))
106 106 #define PRMAXSYS (32 * sizeof (sysset_t) / sizeof (uint32_t))
107 107
108 108 /* State values returned by Pstate() */
109 109 #define PS_RUN 1 /* process is running */
110 110 #define PS_STOP 2 /* process is stopped */
111 111 #define PS_LOST 3 /* process is lost to control (EAGAIN) */
112 112 #define PS_UNDEAD 4 /* process is terminated (zombie) */
113 113 #define PS_DEAD 5 /* process is terminated (core file) */
114 114 #define PS_IDLE 6 /* process has not been run */
115 115
116 116 /* Flags accepted by Pgrab() */
117 117 #define PGRAB_RETAIN 0x01 /* Retain tracing flags, else clear flags */
118 118 #define PGRAB_FORCE 0x02 /* Open the process w/o O_EXCL */
119 119 #define PGRAB_RDONLY 0x04 /* Open the process or core w/ O_RDONLY */
120 120 #define PGRAB_NOSTOP 0x08 /* Open the process but do not stop it */
121 121 #define PGRAB_INCORE 0x10 /* Use in-core data to build symbol tables */
122 122
123 123 /* Error codes from Pcreate() */
124 124 #define C_STRANGE -1 /* Unanticipated error, errno is meaningful */
125 125 #define C_FORK 1 /* Unable to fork */
126 126 #define C_PERM 2 /* No permission (file set-id or unreadable) */
127 127 #define C_NOEXEC 3 /* Cannot execute file */
128 128 #define C_INTR 4 /* Interrupt received while creating */
129 129 #define C_LP64 5 /* Program is _LP64, self is _ILP32 */
130 130 #define C_NOENT 6 /* Cannot find executable file */
131 131
132 132 /* Error codes from Pgrab(), Pfgrab_core(), and Pgrab_core() */
133 133 #define G_STRANGE -1 /* Unanticipated error, errno is meaningful */
134 134 #define G_NOPROC 1 /* No such process */
135 135 #define G_NOCORE 2 /* No such core file */
136 136 #define G_NOPROCORCORE 3 /* No such proc or core (for proc_arg_grab) */
137 137 #define G_NOEXEC 4 /* Cannot locate executable file */
138 138 #define G_ZOMB 5 /* Zombie process */
139 139 #define G_PERM 6 /* No permission */
140 140 #define G_BUSY 7 /* Another process has control */
141 141 #define G_SYS 8 /* System process */
142 142 #define G_SELF 9 /* Process is self */
143 143 #define G_INTR 10 /* Interrupt received while grabbing */
144 144 #define G_LP64 11 /* Process is _LP64, self is ILP32 */
145 145 #define G_FORMAT 12 /* File is not an ELF format core file */
146 146 #define G_ELF 13 /* Libelf error, elf_errno() is meaningful */
147 147 #define G_NOTE 14 /* Required PT_NOTE Phdr not present in core */
148 148 #define G_ISAINVAL 15 /* Wrong ELF machine type */
149 149 #define G_BADLWPS 16 /* Bad '/lwps' specification */
150 150 #define G_NOFD 17 /* No more file descriptors */
151 151
152 152
153 153 /* Flags accepted by Prelease */
154 154 #define PRELEASE_CLEAR 0x10 /* Clear all tracing flags */
155 155 #define PRELEASE_RETAIN 0x20 /* Retain final tracing flags */
156 156 #define PRELEASE_HANG 0x40 /* Leave the process stopped */
157 157 #define PRELEASE_KILL 0x80 /* Terminate the process */
158 158
159 159 typedef struct { /* argument descriptor for system call (Psyscall) */
160 160 long arg_value; /* value of argument given to system call */
161 161 void *arg_object; /* pointer to object in controlling process */
162 162 char arg_type; /* AT_BYVAL, AT_BYREF */
163 163 char arg_inout; /* AI_INPUT, AI_OUTPUT, AI_INOUT */
164 164 ushort_t arg_size; /* if AT_BYREF, size of object in bytes */
165 165 } argdes_t;
166 166
167 167 /* values for type */
168 168 #define AT_BYVAL 1
169 169 #define AT_BYREF 2
170 170
171 171 /* values for inout */
172 172 #define AI_INPUT 1
173 173 #define AI_OUTPUT 2
174 174 #define AI_INOUT 3
175 175
176 176 /* maximum number of syscall arguments */
177 177 #define MAXARGS 8
178 178
179 179 /* maximum size in bytes of a BYREF argument */
180 180 #define MAXARGL (4*1024)
181 181
182 182 /*
183 183 * Ops vector definition for the Pgrab_ops().
184 184 */
185 185 typedef ssize_t (*pop_pread_t)(struct ps_prochandle *, void *, size_t,
186 186 uintptr_t, void *);
187 187 typedef ssize_t (*pop_pwrite_t)(struct ps_prochandle *, const void *, size_t,
188 188 uintptr_t, void *);
189 189 typedef int (*pop_read_maps_t)(struct ps_prochandle *, prmap_t **, ssize_t *,
190 190 void *);
191 191 typedef void (*pop_read_aux_t)(struct ps_prochandle *, auxv_t **, int *,
192 192 void *);
193 193 typedef int (*pop_cred_t)(struct ps_prochandle *, prcred_t *, int,
194 194 void *);
195 195 typedef int (*pop_priv_t)(struct ps_prochandle *, prpriv_t **, void *);
196 196 typedef int (*pop_secflags_t)(struct ps_prochandle *, prsecflags_t **, void *);
197 197 typedef const psinfo_t *(*pop_psinfo_t)(struct ps_prochandle *, psinfo_t *,
198 198 void *);
199 199 typedef void (*pop_status_t)(struct ps_prochandle *, pstatus_t *, void *);
200 200 typedef prheader_t *(*pop_lstatus_t)(struct ps_prochandle *, void *);
201 201 typedef prheader_t *(*pop_lpsinfo_t)(struct ps_prochandle *, void *);
202 202 typedef void (*pop_fini_t)(struct ps_prochandle *, void *);
203 203 typedef char *(*pop_platform_t)(struct ps_prochandle *, char *, size_t, void *);
204 204 typedef int (*pop_uname_t)(struct ps_prochandle *, struct utsname *, void *);
205 205 typedef char *(*pop_zonename_t)(struct ps_prochandle *, char *, size_t, void *);
206 206 typedef char *(*pop_execname_t)(struct ps_prochandle *, char *, size_t, void *);
207 207 #if defined(__i386) || defined(__amd64)
208 208 typedef int (*pop_ldt_t)(struct ps_prochandle *, struct ssd *, int, void *);
209 209 #endif
210 210
211 211 typedef struct ps_ops {
212 212 pop_pread_t pop_pread;
213 213 pop_pwrite_t pop_pwrite;
214 214 pop_read_maps_t pop_read_maps;
215 215 pop_read_aux_t pop_read_aux;
216 216 pop_cred_t pop_cred;
217 217 pop_priv_t pop_priv;
218 218 pop_psinfo_t pop_psinfo;
219 219 pop_status_t pop_status;
220 220 pop_lstatus_t pop_lstatus;
221 221 pop_lpsinfo_t pop_lpsinfo;
222 222 pop_fini_t pop_fini;
223 223 pop_platform_t pop_platform;
224 224 pop_uname_t pop_uname;
225 225 pop_zonename_t pop_zonename;
226 226 pop_execname_t pop_execname;
227 227 pop_secflags_t pop_secflags;
228 228 #if defined(__i386) || defined(__amd64)
229 229 pop_ldt_t pop_ldt;
230 230 #endif
231 231 } ps_ops_t;
232 232
233 233 /*
234 234 * Function prototypes for routines in the process control package.
235 235 */
236 236 extern struct ps_prochandle *Pcreate(const char *, char *const *,
237 237 int *, char *, size_t);
238 238 extern struct ps_prochandle *Pxcreate(const char *, char *const *,
239 239 char *const *, int *, char *, size_t);
240 240
241 241 extern const char *Pcreate_error(int);
242 242
243 243 extern struct ps_prochandle *Pgrab(pid_t, int, int *);
244 244 extern struct ps_prochandle *Pgrab_core(const char *, const char *, int, int *);
245 245 extern struct ps_prochandle *Pfgrab_core(int, const char *, int *);
246 246 extern struct ps_prochandle *Pgrab_file(const char *, int *);
247 247 extern struct ps_prochandle *Pgrab_ops(pid_t, void *, const ps_ops_t *, int);
248 248 extern const char *Pgrab_error(int);
249 249
250 250 extern int Preopen(struct ps_prochandle *);
251 251 extern void Prelease(struct ps_prochandle *, int);
252 252 extern void Pfree(struct ps_prochandle *);
253 253
254 254 extern int Pasfd(struct ps_prochandle *);
255 255 extern char *Pbrandname(struct ps_prochandle *, char *, size_t);
256 256 extern int Pctlfd(struct ps_prochandle *);
257 257 extern int Pcreate_agent(struct ps_prochandle *);
258 258 extern void Pdestroy_agent(struct ps_prochandle *);
259 259 extern int Pstopstatus(struct ps_prochandle *, long, uint_t);
260 260 extern int Pwait(struct ps_prochandle *, uint_t);
261 261 extern int Pstop(struct ps_prochandle *, uint_t);
262 262 extern int Pdstop(struct ps_prochandle *);
263 263 extern int Pstate(struct ps_prochandle *);
264 264 extern const psinfo_t *Ppsinfo(struct ps_prochandle *);
265 265 extern const pstatus_t *Pstatus(struct ps_prochandle *);
266 266 extern int Pcred(struct ps_prochandle *, prcred_t *, int);
267 267 extern int Psetcred(struct ps_prochandle *, const prcred_t *);
268 268 extern int Ppriv(struct ps_prochandle *, prpriv_t **);
269 269 extern void Ppriv_free(struct ps_prochandle *, prpriv_t *);
270 270 extern int Psetpriv(struct ps_prochandle *, prpriv_t *);
271 271 extern void *Pprivinfo(struct ps_prochandle *);
272 272 extern int Psetzoneid(struct ps_prochandle *, zoneid_t);
273 273 extern int Pgetareg(struct ps_prochandle *, int, prgreg_t *);
274 274 extern int Pputareg(struct ps_prochandle *, int, prgreg_t);
275 275 extern int Psetrun(struct ps_prochandle *, int, int);
276 276 extern int Psecflags(struct ps_prochandle *, prsecflags_t **);
277 277 extern void Psecflags_free(prsecflags_t *);
278 278 extern ssize_t Pread(struct ps_prochandle *, void *, size_t, uintptr_t);
279 279 extern ssize_t Pread_string(struct ps_prochandle *, char *, size_t, uintptr_t);
280 280 extern ssize_t Pwrite(struct ps_prochandle *, const void *, size_t, uintptr_t);
281 281 extern int Pclearsig(struct ps_prochandle *);
282 282 extern int Pclearfault(struct ps_prochandle *);
283 283 extern int Psetbkpt(struct ps_prochandle *, uintptr_t, ulong_t *);
284 284 extern int Pdelbkpt(struct ps_prochandle *, uintptr_t, ulong_t);
285 285 extern int Pxecbkpt(struct ps_prochandle *, ulong_t);
286 286 extern int Psetwapt(struct ps_prochandle *, const prwatch_t *);
287 287 extern int Pdelwapt(struct ps_prochandle *, const prwatch_t *);
288 288 extern int Pxecwapt(struct ps_prochandle *, const prwatch_t *);
289 289 extern int Psetflags(struct ps_prochandle *, long);
290 290 extern int Punsetflags(struct ps_prochandle *, long);
291 291 extern int Psignal(struct ps_prochandle *, int, int);
292 292 extern int Pfault(struct ps_prochandle *, int, int);
293 293 extern int Psysentry(struct ps_prochandle *, int, int);
294 294 extern int Psysexit(struct ps_prochandle *, int, int);
295 295 extern void Psetsignal(struct ps_prochandle *, const sigset_t *);
296 296 extern void Psetfault(struct ps_prochandle *, const fltset_t *);
297 297 extern void Psetsysentry(struct ps_prochandle *, const sysset_t *);
298 298 extern void Psetsysexit(struct ps_prochandle *, const sysset_t *);
299 299
300 300 extern void Psync(struct ps_prochandle *);
301 301 extern int Psyscall(struct ps_prochandle *, sysret_t *,
302 302 int, uint_t, argdes_t *);
303 303 extern int Pisprocdir(struct ps_prochandle *, const char *);
304 304
305 305 /*
306 306 * Function prototypes for lwp-specific operations.
307 307 */
308 308 extern struct ps_lwphandle *Lgrab(struct ps_prochandle *, lwpid_t, int *);
309 309 extern const char *Lgrab_error(int);
310 310
311 311 extern struct ps_prochandle *Lprochandle(struct ps_lwphandle *);
312 312 extern void Lfree(struct ps_lwphandle *);
313 313
314 314 extern int Lctlfd(struct ps_lwphandle *);
315 315 extern int Lwait(struct ps_lwphandle *, uint_t);
316 316 extern int Lstop(struct ps_lwphandle *, uint_t);
317 317 extern int Ldstop(struct ps_lwphandle *);
318 318 extern int Lstate(struct ps_lwphandle *);
319 319 extern const lwpsinfo_t *Lpsinfo(struct ps_lwphandle *);
320 320 extern const lwpstatus_t *Lstatus(struct ps_lwphandle *);
321 321 extern int Lgetareg(struct ps_lwphandle *, int, prgreg_t *);
322 322 extern int Lputareg(struct ps_lwphandle *, int, prgreg_t);
323 323 extern int Lsetrun(struct ps_lwphandle *, int, int);
324 324 extern int Lclearsig(struct ps_lwphandle *);
325 325 extern int Lclearfault(struct ps_lwphandle *);
326 326 extern int Lxecbkpt(struct ps_lwphandle *, ulong_t);
327 327 extern int Lxecwapt(struct ps_lwphandle *, const prwatch_t *);
328 328 extern void Lsync(struct ps_lwphandle *);
329 329
330 330 extern int Lstack(struct ps_lwphandle *, stack_t *);
331 331 extern int Lmain_stack(struct ps_lwphandle *, stack_t *);
332 332 extern int Lalt_stack(struct ps_lwphandle *, stack_t *);
333 333
334 334 /*
335 335 * Function prototypes for system calls forced on the victim process.
336 336 */
337 337 extern int pr_open(struct ps_prochandle *, const char *, int, mode_t);
338 338 extern int pr_creat(struct ps_prochandle *, const char *, mode_t);
339 339 extern int pr_close(struct ps_prochandle *, int);
340 340 extern int pr_access(struct ps_prochandle *, const char *, int);
341 341 extern int pr_door_info(struct ps_prochandle *, int, struct door_info *);
342 342 extern void *pr_mmap(struct ps_prochandle *,
343 343 void *, size_t, int, int, int, off_t);
344 344 extern void *pr_zmap(struct ps_prochandle *,
345 345 void *, size_t, int, int);
346 346 extern int pr_munmap(struct ps_prochandle *, void *, size_t);
347 347 extern int pr_memcntl(struct ps_prochandle *,
348 348 caddr_t, size_t, int, caddr_t, int, int);
349 349 extern int pr_meminfo(struct ps_prochandle *, const uint64_t *addrs,
350 350 int addr_count, const uint_t *info, int info_count,
351 351 uint64_t *outdata, uint_t *validity);
352 352 extern int pr_sigaction(struct ps_prochandle *,
353 353 int, const struct sigaction *, struct sigaction *);
354 354 extern int pr_getitimer(struct ps_prochandle *,
355 355 int, struct itimerval *);
356 356 extern int pr_setitimer(struct ps_prochandle *,
357 357 int, const struct itimerval *, struct itimerval *);
358 358 extern int pr_ioctl(struct ps_prochandle *, int, int, void *, size_t);
359 359 extern int pr_fcntl(struct ps_prochandle *, int, int, void *);
360 360 extern int pr_stat(struct ps_prochandle *, const char *, struct stat *);
361 361 extern int pr_lstat(struct ps_prochandle *, const char *, struct stat *);
362 362 extern int pr_fstat(struct ps_prochandle *, int, struct stat *);
363 363 extern int pr_stat64(struct ps_prochandle *, const char *,
364 364 struct stat64 *);
365 365 extern int pr_lstat64(struct ps_prochandle *, const char *,
366 366 struct stat64 *);
367 367 extern int pr_fstat64(struct ps_prochandle *, int, struct stat64 *);
368 368 extern int pr_statvfs(struct ps_prochandle *, const char *, statvfs_t *);
369 369 extern int pr_fstatvfs(struct ps_prochandle *, int, statvfs_t *);
370 370 extern projid_t pr_getprojid(struct ps_prochandle *Pr);
371 371 extern taskid_t pr_gettaskid(struct ps_prochandle *Pr);
372 372 extern taskid_t pr_settaskid(struct ps_prochandle *Pr, projid_t project,
373 373 int flags);
374 374 extern zoneid_t pr_getzoneid(struct ps_prochandle *Pr);
375 375 extern int pr_getrctl(struct ps_prochandle *,
376 376 const char *, rctlblk_t *, rctlblk_t *, int);
377 377 extern int pr_setrctl(struct ps_prochandle *,
378 378 const char *, rctlblk_t *, rctlblk_t *, int);
379 379 extern int pr_getrlimit(struct ps_prochandle *,
380 380 int, struct rlimit *);
381 381 extern int pr_setrlimit(struct ps_prochandle *,
382 382 int, const struct rlimit *);
383 383 extern int pr_setprojrctl(struct ps_prochandle *, const char *,
384 384 rctlblk_t *, size_t, int);
385 385 #if defined(_LARGEFILE64_SOURCE)
386 386 extern int pr_getrlimit64(struct ps_prochandle *,
387 387 int, struct rlimit64 *);
388 388 extern int pr_setrlimit64(struct ps_prochandle *,
389 389 int, const struct rlimit64 *);
390 390 #endif /* _LARGEFILE64_SOURCE */
391 391 extern int pr_lwp_exit(struct ps_prochandle *);
392 392 extern int pr_exit(struct ps_prochandle *, int);
393 393 extern int pr_waitid(struct ps_prochandle *,
394 394 idtype_t, id_t, siginfo_t *, int);
395 395 extern off_t pr_lseek(struct ps_prochandle *, int, off_t, int);
396 396 extern offset_t pr_llseek(struct ps_prochandle *, int, offset_t, int);
397 397 extern int pr_rename(struct ps_prochandle *, const char *, const char *);
398 398 extern int pr_link(struct ps_prochandle *, const char *, const char *);
399 399 extern int pr_unlink(struct ps_prochandle *, const char *);
400 400 extern int pr_getpeerucred(struct ps_prochandle *, int, ucred_t **);
401 401 extern int pr_getpeername(struct ps_prochandle *,
402 402 int, struct sockaddr *, socklen_t *);
403 403 extern int pr_getsockname(struct ps_prochandle *,
404 404 int, struct sockaddr *, socklen_t *);
405 405 extern int pr_getsockopt(struct ps_prochandle *,
406 406 int, int, int, void *, int *);
407 407 extern int pr_processor_bind(struct ps_prochandle *,
408 408 idtype_t, id_t, int, int *);
409 409
410 410 /*
411 411 * Function prototypes for accessing per-LWP register information.
412 412 */
413 413 extern int Plwp_getregs(struct ps_prochandle *, lwpid_t, prgregset_t);
414 414 extern int Plwp_setregs(struct ps_prochandle *, lwpid_t, const prgregset_t);
415 415
416 416 extern int Plwp_getfpregs(struct ps_prochandle *, lwpid_t, prfpregset_t *);
417 417 extern int Plwp_setfpregs(struct ps_prochandle *, lwpid_t,
418 418 const prfpregset_t *);
419 419
420 420 #if defined(__sparc)
421 421
422 422 extern int Plwp_getxregs(struct ps_prochandle *, lwpid_t, prxregset_t *);
423 423 extern int Plwp_setxregs(struct ps_prochandle *, lwpid_t, const prxregset_t *);
424 424
425 425 extern int Plwp_getgwindows(struct ps_prochandle *, lwpid_t, gwindows_t *);
426 426
427 427 #if defined(__sparcv9)
428 428 extern int Plwp_getasrs(struct ps_prochandle *, lwpid_t, asrset_t);
|
↓ open down ↓ |
390 lines elided |
↑ open up ↑ |
429 429 extern int Plwp_setasrs(struct ps_prochandle *, lwpid_t, const asrset_t);
430 430 #endif /* __sparcv9 */
431 431
432 432 #endif /* __sparc */
433 433
434 434 #if defined(__i386) || defined(__amd64)
435 435 extern int Pldt(struct ps_prochandle *, struct ssd *, int);
436 436 extern int proc_get_ldt(pid_t, struct ssd *, int);
437 437 #endif /* __i386 || __amd64 */
438 438
439 +extern int Plwp_getname(struct ps_prochandle *, lwpid_t, char *, size_t);
439 440 extern int Plwp_getpsinfo(struct ps_prochandle *, lwpid_t, lwpsinfo_t *);
440 441 extern int Plwp_getspymaster(struct ps_prochandle *, lwpid_t, psinfo_t *);
441 442
442 443 extern int Plwp_stack(struct ps_prochandle *, lwpid_t, stack_t *);
443 444 extern int Plwp_main_stack(struct ps_prochandle *, lwpid_t, stack_t *);
444 445 extern int Plwp_alt_stack(struct ps_prochandle *, lwpid_t, stack_t *);
445 446
446 447 /*
447 448 * LWP iteration interface; iterate over all active LWPs.
448 449 */
449 450 typedef int proc_lwp_f(void *, const lwpstatus_t *);
450 451 extern int Plwp_iter(struct ps_prochandle *, proc_lwp_f *, void *);
451 452
452 453 /*
453 454 * LWP iteration interface; iterate over all LWPs, active and zombie.
454 455 */
455 456 typedef int proc_lwp_all_f(void *, const lwpstatus_t *, const lwpsinfo_t *);
456 457 extern int Plwp_iter_all(struct ps_prochandle *, proc_lwp_all_f *, void *);
457 458
458 459 /*
459 460 * Process iteration interface; iterate over all non-system processes.
460 461 */
461 462 typedef int proc_walk_f(psinfo_t *, lwpsinfo_t *, void *);
462 463 extern int proc_walk(proc_walk_f *, void *, int);
463 464
464 465 #define PR_WALK_PROC 0 /* walk processes only */
465 466 #define PR_WALK_LWP 1 /* walk all lwps */
466 467
467 468 /*
468 469 * Determine if an lwp is in a set as returned from proc_arg_xgrab().
469 470 */
470 471 extern int proc_lwp_in_set(const char *, lwpid_t);
471 472 extern int proc_lwp_range_valid(const char *);
472 473
473 474 /*
474 475 * Symbol table interfaces.
475 476 */
476 477
477 478 /*
478 479 * Pseudo-names passed to Plookup_by_name() for well-known load objects.
479 480 * NOTE: It is required that PR_OBJ_EXEC and PR_OBJ_LDSO exactly match
480 481 * the definitions of PS_OBJ_EXEC and PS_OBJ_LDSO from <proc_service.h>.
481 482 */
482 483 #define PR_OBJ_EXEC ((const char *)0) /* search the executable file */
483 484 #define PR_OBJ_LDSO ((const char *)1) /* search ld.so.1 */
484 485 #define PR_OBJ_EVERY ((const char *)-1) /* search every load object */
485 486
486 487 /*
487 488 * Special Lmid_t passed to Plookup_by_lmid() to search all link maps. The
488 489 * special values LM_ID_BASE and LM_ID_LDSO from <link.h> may also be used.
489 490 * If PR_OBJ_EXEC is used as the object name, the lmid must be PR_LMID_EVERY
490 491 * or LM_ID_BASE in order to return a match. If PR_OBJ_LDSO is used as the
491 492 * object name, the lmid must be PR_LMID_EVERY or LM_ID_LDSO to return a match.
492 493 */
493 494 #define PR_LMID_EVERY ((Lmid_t)-1UL) /* search every link map */
494 495
495 496 /*
496 497 * 'object_name' is the name of a load object obtained from an
497 498 * iteration over the process's address space mappings (Pmapping_iter),
498 499 * or an iteration over the process's mapped objects (Pobject_iter),
499 500 * or else it is one of the special PR_OBJ_* values above.
500 501 */
501 502 extern int Plookup_by_name(struct ps_prochandle *,
502 503 const char *, const char *, GElf_Sym *);
503 504
504 505 extern int Plookup_by_addr(struct ps_prochandle *,
505 506 uintptr_t, char *, size_t, GElf_Sym *);
506 507
507 508 typedef struct prsyminfo {
508 509 const char *prs_object; /* object name */
509 510 const char *prs_name; /* symbol name */
510 511 Lmid_t prs_lmid; /* link map id */
511 512 uint_t prs_id; /* symbol id */
512 513 uint_t prs_table; /* symbol table id */
513 514 } prsyminfo_t;
514 515
515 516 extern int Pxlookup_by_name(struct ps_prochandle *,
516 517 Lmid_t, const char *, const char *, GElf_Sym *, prsyminfo_t *);
517 518
518 519 extern int Pxlookup_by_addr(struct ps_prochandle *,
519 520 uintptr_t, char *, size_t, GElf_Sym *, prsyminfo_t *);
520 521 extern int Pxlookup_by_addr_resolved(struct ps_prochandle *,
521 522 uintptr_t, char *, size_t, GElf_Sym *, prsyminfo_t *);
522 523
523 524 typedef int proc_map_f(void *, const prmap_t *, const char *);
524 525
525 526 extern int Pmapping_iter(struct ps_prochandle *, proc_map_f *, void *);
526 527 extern int Pmapping_iter_resolved(struct ps_prochandle *, proc_map_f *, void *);
527 528 extern int Pobject_iter(struct ps_prochandle *, proc_map_f *, void *);
528 529 extern int Pobject_iter_resolved(struct ps_prochandle *, proc_map_f *, void *);
529 530
530 531 extern const prmap_t *Paddr_to_map(struct ps_prochandle *, uintptr_t);
531 532 extern const prmap_t *Paddr_to_text_map(struct ps_prochandle *, uintptr_t);
532 533 extern const prmap_t *Pname_to_map(struct ps_prochandle *, const char *);
533 534 extern const prmap_t *Plmid_to_map(struct ps_prochandle *,
534 535 Lmid_t, const char *);
535 536
536 537 extern const rd_loadobj_t *Paddr_to_loadobj(struct ps_prochandle *, uintptr_t);
537 538 extern const rd_loadobj_t *Pname_to_loadobj(struct ps_prochandle *,
538 539 const char *);
539 540 extern const rd_loadobj_t *Plmid_to_loadobj(struct ps_prochandle *,
540 541 Lmid_t, const char *);
541 542
542 543 extern ctf_file_t *Paddr_to_ctf(struct ps_prochandle *, uintptr_t);
543 544 extern ctf_file_t *Pname_to_ctf(struct ps_prochandle *, const char *);
544 545
545 546 extern char *Pplatform(struct ps_prochandle *, char *, size_t);
546 547 extern int Puname(struct ps_prochandle *, struct utsname *);
547 548 extern char *Pzonename(struct ps_prochandle *, char *, size_t);
548 549 extern char *Pfindobj(struct ps_prochandle *, const char *, char *, size_t);
549 550
550 551 extern char *Pexecname(struct ps_prochandle *, char *, size_t);
551 552 extern char *Pobjname(struct ps_prochandle *, uintptr_t, char *, size_t);
552 553 extern char *Pobjname_resolved(struct ps_prochandle *, uintptr_t, char *,
553 554 size_t);
554 555 extern int Plmid(struct ps_prochandle *, uintptr_t, Lmid_t *);
555 556
556 557 typedef int proc_env_f(void *, struct ps_prochandle *, uintptr_t, const char *);
557 558 extern int Penv_iter(struct ps_prochandle *, proc_env_f *, void *);
558 559 extern char *Pgetenv(struct ps_prochandle *, const char *, char *, size_t);
559 560 extern long Pgetauxval(struct ps_prochandle *, int);
560 561 extern const auxv_t *Pgetauxvec(struct ps_prochandle *);
561 562
562 563 extern void Pset_procfs_path(const char *);
563 564
564 565 /*
565 566 * Symbol table iteration interface. The special lmid constants LM_ID_BASE,
566 567 * LM_ID_LDSO, and PR_LMID_EVERY may be used with Psymbol_iter_by_lmid.
567 568 */
568 569 typedef int proc_sym_f(void *, const GElf_Sym *, const char *);
569 570 typedef int proc_xsym_f(void *, const GElf_Sym *, const char *,
570 571 const prsyminfo_t *);
571 572
572 573 extern int Psymbol_iter(struct ps_prochandle *,
573 574 const char *, int, int, proc_sym_f *, void *);
574 575 extern int Psymbol_iter_by_addr(struct ps_prochandle *,
575 576 const char *, int, int, proc_sym_f *, void *);
576 577 extern int Psymbol_iter_by_name(struct ps_prochandle *,
577 578 const char *, int, int, proc_sym_f *, void *);
578 579
579 580 extern int Psymbol_iter_by_lmid(struct ps_prochandle *,
580 581 Lmid_t, const char *, int, int, proc_sym_f *, void *);
581 582
582 583 extern int Pxsymbol_iter(struct ps_prochandle *,
583 584 Lmid_t, const char *, int, int, proc_xsym_f *, void *);
584 585
585 586 /*
586 587 * 'which' selects which symbol table and can be one of the following.
587 588 */
588 589 #define PR_SYMTAB 1
589 590 #define PR_DYNSYM 2
590 591 /*
591 592 * 'type' selects the symbols of interest by binding and type. It is a bit-
592 593 * mask of one or more of the following flags, whose order MUST match the
593 594 * order of STB and STT constants in <sys/elf.h>.
594 595 */
595 596 #define BIND_LOCAL 0x0001
596 597 #define BIND_GLOBAL 0x0002
597 598 #define BIND_WEAK 0x0004
598 599 #define BIND_ANY (BIND_LOCAL|BIND_GLOBAL|BIND_WEAK)
599 600 #define TYPE_NOTYPE 0x0100
600 601 #define TYPE_OBJECT 0x0200
601 602 #define TYPE_FUNC 0x0400
602 603 #define TYPE_SECTION 0x0800
603 604 #define TYPE_FILE 0x1000
604 605 #define TYPE_ANY (TYPE_NOTYPE|TYPE_OBJECT|TYPE_FUNC|TYPE_SECTION|TYPE_FILE)
605 606
606 607 /*
607 608 * This returns the rtld_db agent handle for the process.
608 609 * The handle will become invalid at the next successful exec() and
609 610 * must not be used beyond that point (see Preset_maps(), below).
610 611 */
611 612 extern rd_agent_t *Prd_agent(struct ps_prochandle *);
612 613
613 614 /*
614 615 * This should be called when an RD_DLACTIVITY event with the
615 616 * RD_CONSISTENT state occurs via librtld_db's event mechanism.
616 617 * This makes libproc's address space mappings and symbol tables current.
617 618 * The variant Pupdate_syms() can be used to preload all symbol tables as well.
618 619 */
619 620 extern void Pupdate_maps(struct ps_prochandle *);
620 621 extern void Pupdate_syms(struct ps_prochandle *);
621 622
622 623 /*
623 624 * This must be called after the victim process performs a successful
624 625 * exec() if any of the symbol table interface functions have been called
625 626 * prior to that point. This is essential because an exec() invalidates
626 627 * all previous symbol table and address space mapping information.
627 628 * It is always safe to call, but if it is called other than after an
628 629 * exec() by the victim process it just causes unnecessary overhead.
629 630 *
630 631 * The rtld_db agent handle obtained from a previous call to Prd_agent() is
631 632 * made invalid by Preset_maps() and Prd_agent() must be called again to get
632 633 * the new handle.
633 634 */
634 635 extern void Preset_maps(struct ps_prochandle *);
635 636
636 637 /*
637 638 * Given an address, Ppltdest() determines if this is part of a PLT, and if
638 639 * so returns a pointer to the symbol name that will be used for resolution.
639 640 * If the specified address is not part of a PLT, the function returns NULL.
640 641 */
641 642 extern const char *Ppltdest(struct ps_prochandle *, uintptr_t);
642 643
643 644 /*
644 645 * See comments for Pissyscall(), in Pisadep.h
645 646 */
646 647 extern int Pissyscall_prev(struct ps_prochandle *, uintptr_t, uintptr_t *);
647 648
648 649 /*
649 650 * Stack frame iteration interface.
650 651 */
651 652 typedef int proc_stack_f(void *, prgregset_t, uint_t, const long *);
652 653
653 654 extern int Pstack_iter(struct ps_prochandle *,
654 655 const prgregset_t, proc_stack_f *, void *);
655 656
656 657 /*
657 658 * The following functions define a set of passive interfaces: libproc provides
658 659 * default, empty definitions that are called internally. If a client wishes
659 660 * to override these definitions, it can simply provide its own version with
660 661 * the same signature that interposes on the libproc definition.
661 662 *
662 663 * If the client program wishes to report additional error information, it
663 664 * can provide its own version of Perror_printf.
664 665 *
665 666 * If the client program wishes to receive a callback after Pcreate forks
666 667 * but before it execs, it can provide its own version of Pcreate_callback.
667 668 */
668 669 extern void Perror_printf(struct ps_prochandle *P, const char *format, ...);
669 670 extern void Pcreate_callback(struct ps_prochandle *);
670 671
671 672 /*
672 673 * Remove unprintable characters from psinfo.pr_psargs and replace with
673 674 * whitespace characters so it is safe for printing.
674 675 */
675 676 extern void proc_unctrl_psinfo(psinfo_t *);
676 677
677 678 /*
678 679 * Utility functions for processing arguments which should be /proc files,
679 680 * pids, and/or core files. The returned error code can be passed to
680 681 * Pgrab_error() in order to convert it to an error string.
681 682 */
682 683 #define PR_ARG_PIDS 0x1 /* Allow pid and /proc file arguments */
683 684 #define PR_ARG_CORES 0x2 /* Allow core file arguments */
684 685
685 686 #define PR_ARG_ANY (PR_ARG_PIDS | PR_ARG_CORES)
686 687
687 688 extern struct ps_prochandle *proc_arg_grab(const char *, int, int, int *);
688 689 extern struct ps_prochandle *proc_arg_xgrab(const char *, const char *, int,
689 690 int, int *, const char **);
690 691 extern pid_t proc_arg_psinfo(const char *, int, psinfo_t *, int *);
691 692 extern pid_t proc_arg_xpsinfo(const char *, int, psinfo_t *, int *,
692 693 const char **);
693 694
694 695 /*
695 696 * Utility functions for obtaining information via /proc without actually
696 697 * performing a Pcreate() or Pgrab():
697 698 */
698 699 extern int proc_get_auxv(pid_t, auxv_t *, int);
699 700 extern int proc_get_cred(pid_t, prcred_t *, int);
700 701 extern prpriv_t *proc_get_priv(pid_t);
701 702 extern void proc_free_priv(prpriv_t *);
702 703 extern int proc_get_psinfo(pid_t, psinfo_t *);
703 704 extern int proc_get_status(pid_t, pstatus_t *);
704 705 extern int proc_get_secflags(pid_t, prsecflags_t **);
705 706
706 707 /*
707 708 * Utility functions for debugging tools to convert numeric fault,
708 709 * signal, and system call numbers to symbolic names:
709 710 */
710 711 #define FLT2STR_MAX 32 /* max. string length of faults (like SIG2STR_MAX) */
711 712 #define SYS2STR_MAX 32 /* max. string length of syscalls (like SIG2STR_MAX) */
712 713
713 714 extern char *proc_fltname(int, char *, size_t);
714 715 extern char *proc_signame(int, char *, size_t);
715 716 extern char *proc_sysname(int, char *, size_t);
716 717
717 718 /*
718 719 * Utility functions for debugging tools to convert fault, signal, and system
719 720 * call names back to the numeric constants:
720 721 */
721 722 extern int proc_str2flt(const char *, int *);
722 723 extern int proc_str2sig(const char *, int *);
723 724 extern int proc_str2sys(const char *, int *);
724 725
725 726 /*
726 727 * Utility functions for debugging tools to convert a fault, signal or system
727 728 * call set to a string representation (e.g. "BUS,SEGV" or "open,close,read").
728 729 */
729 730 #define PRSIGBUFSZ 1024 /* buffer size for proc_sigset2str() */
730 731
731 732 extern char *proc_fltset2str(const fltset_t *, const char *, int,
732 733 char *, size_t);
733 734 extern char *proc_sigset2str(const sigset_t *, const char *, int,
734 735 char *, size_t);
735 736 extern char *proc_sysset2str(const sysset_t *, const char *, int,
736 737 char *, size_t);
737 738
738 739 extern int Pgcore(struct ps_prochandle *, const char *, core_content_t);
739 740 extern int Pfgcore(struct ps_prochandle *, int, core_content_t);
740 741 extern core_content_t Pcontent(struct ps_prochandle *);
741 742
742 743 /*
743 744 * Utility functions for debugging tools to convert a string representation of
744 745 * a fault, signal or system call set back to the numeric value of the
745 746 * corresponding set type.
746 747 */
747 748 extern char *proc_str2fltset(const char *, const char *, int, fltset_t *);
748 749 extern char *proc_str2sigset(const char *, const char *, int, sigset_t *);
749 750 extern char *proc_str2sysset(const char *, const char *, int, sysset_t *);
750 751
751 752 /*
752 753 * Utility functions for converting between strings and core_content_t.
753 754 */
754 755 #define PRCONTENTBUFSZ 80 /* buffer size for proc_content2str() */
755 756
756 757 extern int proc_str2content(const char *, core_content_t *);
757 758 extern int proc_content2str(core_content_t, char *, size_t);
758 759
759 760 /*
760 761 * Utility functions for buffering output to stdout, stderr while
761 762 * process is grabbed. Prevents deadlocks due to pfiles `pgrep xterm`
762 763 * and other varients.
763 764 */
764 765 extern int proc_initstdio(void);
765 766 extern int proc_flushstdio(void);
766 767 extern int proc_finistdio(void);
767 768
768 769 /*
769 770 * Iterate over all open files.
770 771 */
771 772 typedef int proc_fdinfo_f(void *, prfdinfo_t *);
772 773 extern int Pfdinfo_iter(struct ps_prochandle *, proc_fdinfo_f *, void *);
773 774
774 775 #ifdef __cplusplus
775 776 }
776 777 #endif
777 778
778 779 #endif /* _LIBPROC_H */
|
↓ open down ↓ |
330 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX