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