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