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