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 #ifndef _PROC_SERVICE_H
27 #define _PROC_SERVICE_H
28
29 /*
30 * Description:
31 * Types, global variables, and function definitions for provider
32 * of import functions for users of libc_db and librtld_db.
33 */
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include <sys/types.h>
40 #include <sys/procfs_isa.h>
41 #include <sys/lwp.h>
42 #include <sys/auxv.h>
43 #include <elf.h>
44 #if defined(__i386) || defined(__amd64) /* for struct ssd */
45 #include <sys/segments.h>
46 #include <sys/sysi86.h>
47 #endif
48
49
50 typedef unsigned long psaddr_t;
51
52 typedef enum {
53 PS_OK, /* generic "call succeeded" */
54 PS_ERR, /* generic error */
55 PS_BADPID, /* bad process handle */
56 PS_BADLID, /* bad lwp identifier */
57 PS_BADADDR, /* bad address */
58 PS_NOSYM, /* p_lookup() could not find given symbol */
59 PS_NOFREGS, /* FPU register set not available for given lwp */
60 PS_NOXREGS /* extended register set not available for given lwp */
61 } ps_err_e;
62
63 struct ps_prochandle;
64
65 /*
66 * See <sys/procfs_isa.h> for possible values of data_model.
67 */
68 extern ps_err_e ps_pdmodel(struct ps_prochandle *, int *data_model);
69
70 /*
71 * Special values for 'object_name' to refer to certain well-known objects.
72 */
73 #define PS_OBJ_EXEC ((const char *)0x0) /* the executable file */
74 #define PS_OBJ_LDSO ((const char *)0x1) /* the dynamic linker */
75
76 extern ps_err_e ps_pglobal_lookup(struct ps_prochandle *,
77 const char *object_name, const char *sym_name, psaddr_t *sym_addr);
78
79 #ifdef _LP64
80 typedef Elf64_Sym ps_sym_t;
81 #else
82 typedef Elf32_Sym ps_sym_t;
83 #endif
84 extern ps_err_e ps_pglobal_sym(struct ps_prochandle *,
85 const char *object_name, const char *sym_name, ps_sym_t *sym);
86
87 /*
88 * To read and write the process's address space.
89 */
90 extern ps_err_e ps_pread(struct ps_prochandle *,
91 psaddr_t, void *, size_t);
92 extern ps_err_e ps_pwrite(struct ps_prochandle *,
93 psaddr_t, const void *, size_t);
94 /*
95 * The following four functions can be implemented as simple aliases for
96 * the corresponding primary two functions above (#pragma weak ...).
97 * They are artifacts of history that must be maintained.
98 */
99 extern ps_err_e ps_pdread(struct ps_prochandle *,
100 psaddr_t, void *, size_t);
101 extern ps_err_e ps_pdwrite(struct ps_prochandle *,
102 psaddr_t, const void *, size_t);
103 extern ps_err_e ps_ptread(struct ps_prochandle *,
104 psaddr_t, void *, size_t);
105 extern ps_err_e ps_ptwrite(struct ps_prochandle *,
106 psaddr_t, const void *, size_t);
107
108 extern ps_err_e ps_pstop(struct ps_prochandle *);
109 extern ps_err_e ps_pcontinue(struct ps_prochandle *);
110 extern ps_err_e ps_lstop(struct ps_prochandle *, lwpid_t);
111 extern ps_err_e ps_lcontinue(struct ps_prochandle *, lwpid_t);
112
113 extern ps_err_e ps_lgetregs(struct ps_prochandle *,
114 lwpid_t, prgregset_t);
115 extern ps_err_e ps_lsetregs(struct ps_prochandle *,
116 lwpid_t, const prgregset_t);
117 extern ps_err_e ps_lgetfpregs(struct ps_prochandle *,
118 lwpid_t, prfpregset_t *);
119 extern ps_err_e ps_lsetfpregs(struct ps_prochandle *,
120 lwpid_t, const prfpregset_t *);
121
122 extern ps_err_e ps_lgetxregsize(struct ps_prochandle *, lwpid_t, int *);
123 extern ps_err_e ps_lgetxregs(struct ps_prochandle *, lwpid_t, caddr_t);
124 extern ps_err_e ps_lsetxregs(struct ps_prochandle *, lwpid_t, caddr_t);
125
126 #if defined(__i386) || defined(__amd64)
127 extern ps_err_e ps_lgetLDT(struct ps_prochandle *, lwpid_t, struct ssd *);
128 #endif
129
130 extern ps_err_e ps_pauxv(struct ps_prochandle *, const auxv_t **);
131 extern ps_err_e ps_pbrandname(struct ps_prochandle *, char *, size_t);
132
133 extern ps_err_e ps_kill(struct ps_prochandle *, int sig);
134 extern ps_err_e ps_lrolltoaddr(struct ps_prochandle *,
135 lwpid_t, psaddr_t go_addr, psaddr_t stop_addr);
136
137 extern void ps_plog(const char *fmt, ...);
138
139 #ifdef __cplusplus
140 }
141 #endif
142
143 #endif /* _PROC_SERVICE_H */