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