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