root/trunk/contrib/pg_stat_mem/libproc.h

Revision 2, 27.6 kB (checked in by jesus, 7 years ago)

pgsol10 extension to give postgres insight into the memory usage of its backends

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