1 /* 2 * Copyright (c) 2003, 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. 8 * 9 * This code is distributed in the hope that it will be useful, but WITHOUT 10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 12 * version 2 for more details (a copy is included in the LICENSE file that 13 * accompanied this code). 14 * 15 * You should have received a copy of the GNU General Public License version 16 * 2 along with this work; if not, write to the Free Software Foundation, 17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 18 * 19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 20 * or visit www.oracle.com if you need additional information or have any 21 * questions. 22 * 23 */ 24 #ifndef _SALIBPROC_H_ 25 #define _SALIBPROC_H_ 26 27 /* 28 * The following definitions, prototypes are from Solaris libproc.h. 29 * We used to use the copy of it from Solaris 8.0. But there are 30 * problems with that approach in building this library across Solaris 31 * versions. Solaris 10 has libproc.h in /usr/include. And libproc.h 32 * varies slightly across Solaris versions. On Solaris 9, we get 33 * 'sysret_t multiply defined' error. This is common minimum subset we 34 * really need from libproc.h. The libproc.h in the current dir has 35 * been left for reference and not used in build. 36 */ 37 38 #include <dlfcn.h> 39 #include <gelf.h> 40 #include <procfs.h> 41 #include <proc_service.h> 42 #include <fcntl.h> 43 #include <unistd.h> 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 /* extended symbol table information */ 50 typedef struct { 51 const char *prs_object; /* object name */ 52 const char *prs_name; /* symbol name */ 53 Lmid_t prs_lmid; /* link map id */ 54 uint_t prs_id; /* symbol id */ 55 uint_t prs_table; /* symbol table id */ 56 } prsyminfo_t; 57 58 typedef struct ps_prochandle ps_prochandle_t; 59 60 /* 61 * 'object_name' is the name of a load object obtained from an 62 * iteration over the process's address space mappings (Pmapping_iter), 63 * or an iteration over the process's mapped objects (Pobject_iter), 64 * or else it is one of the special PR_OBJ_* values above. 65 */ 66 67 extern int Plookup_by_addr(ps_prochandle_t *, uintptr_t, char *, 68 size_t, GElf_Sym *, prsyminfo_t *); 69 extern ps_prochandle_t *proc_arg_grab(const char *, int, int, 70 int *, const char **); 71 72 typedef int proc_map_f(void *, const prmap_t *, const char *); 73 extern int Pobject_iter(struct ps_prochandle *, proc_map_f *, void *); 74 75 /* 76 * Utility functions for processing arguments which should be /proc files, 77 * pids, and/or core files. The returned error code can be passed to 78 * Pgrab_error() in order to convert it to an error string. 79 */ 80 #define PR_ARG_PIDS 0x1 /* Allow pid and /proc file arguments */ 81 #define PR_ARG_CORES 0x2 /* Allow core file arguments */ 82 #define PR_ARG_ANY (PR_ARG_PIDS | PR_ARG_CORES) 83 84 /* Flags accepted by Pgrab() (partial) */ 85 #define PGRAB_FORCE 0x02 /* Open the process w/o O_EXCL */ 86 87 /* Error codes from Pgrab(), Pfgrab_core(), and Pgrab_core() */ 88 #define G_STRANGE -1 /* Unanticipated error, errno is meaningful */ 89 #define G_NOPROC 1 /* No such process */ 90 #define G_NOCORE 2 /* No such core file */ 91 #define G_NOPROCORCORE 3 /* No such proc or core (for proc_arg_grab) */ 92 #define G_NOEXEC 4 /* Cannot locate executable file */ 93 #define G_ZOMB 5 /* Zombie process */ 94 #define G_PERM 6 /* No permission */ 95 #define G_BUSY 7 /* Another process has control */ 96 #define G_SYS 8 /* System process */ 97 #define G_SELF 9 /* Process is self */ 98 #define G_INTR 10 /* Interrupt received while grabbing */ 99 #define G_LP64 11 /* Process is _LP64, self is ILP32 */ 100 #define G_FORMAT 12 /* File is not an ELF format core file */ 101 #define G_ELF 13 /* Libelf error, elf_errno() is meaningful */ 102 #define G_NOTE 14 /* Required PT_NOTE Phdr not present in core */ 103 104 extern const pstatus_t *Pstatus(struct ps_prochandle *); 105 106 /* Flags accepted by Prelease (partial) */ 107 #define PRELEASE_CLEAR 0x10 /* Clear all tracing flags */ 108 109 extern void Prelease(struct ps_prochandle *, int); 110 extern int Psetrun(struct ps_prochandle *, int, int); 111 extern int Pstop(struct ps_prochandle *, uint_t); 112 113 /* 114 * Stack frame iteration interface. 115 */ 116 typedef int proc_stack_f( 117 void *, /* the cookie given to Pstack_iter() */ 118 const prgregset_t, /* the frame's registers */ 119 uint_t, /* argc for the frame's function */ 120 const long *, /* argv for the frame's function */ 121 int, /* bitwise flags describing the frame (see below) */ 122 int); /* a signal number */ 123 124 #define PR_SIGNAL_FRAME 1 /* called by a signal handler */ 125 #define PR_FOUND_SIGNAL 2 /* we found the corresponding signal number */ 126 127 extern int Pstack_iter(struct ps_prochandle *, 128 const prgregset_t, proc_stack_f *, void *); 129 130 #define PR_OBJ_EVERY ((const char *)-1) /* search every load object */ 131 132 133 #ifdef __cplusplus 134 } 135 #endif 136 137 #endif /* _SALIBPROC_H_ */ 138