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