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