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