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