xref: /illumos-gate/usr/src/head/proc_service.h (revision dd72704bd9e794056c558153663c739e2012d721)
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_err_e;
61 
62 struct ps_prochandle;
63 
64 /*
65  * See <sys/procfs_isa.h> for possible values of data_model.
66  */
67 extern ps_err_e ps_pdmodel(struct ps_prochandle *, int *data_model);
68 
69 /*
70  * Special values for 'object_name' to refer to certain well-known objects.
71  */
72 #define	PS_OBJ_EXEC	((const char *)0x0)	/* the executable file */
73 #define	PS_OBJ_LDSO	((const char *)0x1)	/* the dynamic linker */
74 
75 extern ps_err_e ps_pglobal_lookup(struct ps_prochandle *,
76 	const char *object_name, const char *sym_name, psaddr_t *sym_addr);
77 
78 #ifdef _LP64
79 typedef	Elf64_Sym	ps_sym_t;
80 #else
81 typedef	Elf32_Sym	ps_sym_t;
82 #endif
83 extern ps_err_e ps_pglobal_sym(struct ps_prochandle *,
84 	const char *object_name, const char *sym_name, ps_sym_t *sym);
85 
86 /*
87  * To read and write the process's address space.
88  */
89 extern ps_err_e ps_pread(struct ps_prochandle *,
90 			psaddr_t, void *, size_t);
91 extern ps_err_e ps_pwrite(struct ps_prochandle *,
92 			psaddr_t, const void *, size_t);
93 /*
94  * The following four functions can be implemented as simple aliases for
95  * the corresponding primary two functions above (#pragma weak ...).
96  * They are artifacts of history that must be maintained.
97  */
98 extern ps_err_e ps_pdread(struct ps_prochandle *,
99 			psaddr_t, void *, size_t);
100 extern ps_err_e ps_pdwrite(struct ps_prochandle *,
101 			psaddr_t, const void *, size_t);
102 extern ps_err_e ps_ptread(struct ps_prochandle *,
103 			psaddr_t, void *, size_t);
104 extern ps_err_e ps_ptwrite(struct ps_prochandle *,
105 			psaddr_t, const void *, size_t);
106 
107 extern ps_err_e ps_pstop(struct ps_prochandle *);
108 extern ps_err_e ps_pcontinue(struct ps_prochandle *);
109 extern ps_err_e ps_lstop(struct ps_prochandle *, lwpid_t);
110 extern ps_err_e ps_lcontinue(struct ps_prochandle *, lwpid_t);
111 
112 extern ps_err_e ps_lgetregs(struct ps_prochandle *,
113 			lwpid_t, prgregset_t);
114 extern ps_err_e ps_lsetregs(struct ps_prochandle *,
115 			lwpid_t, const prgregset_t);
116 extern ps_err_e ps_lgetfpregs(struct ps_prochandle *,
117 			lwpid_t, prfpregset_t *);
118 extern ps_err_e ps_lsetfpregs(struct ps_prochandle *,
119 			lwpid_t, const prfpregset_t *);
120 
121 #if defined(__sparc) || defined(__sparcv9)
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 #endif
126 
127 #if defined(__i386) || defined(__amd64)
128 extern ps_err_e ps_lgetLDT(struct ps_prochandle *, lwpid_t, struct ssd *);
129 #endif
130 
131 extern ps_err_e ps_pauxv(struct ps_prochandle *, const auxv_t **);
132 extern ps_err_e ps_pbrandname(struct ps_prochandle *, char *, size_t);
133 
134 extern ps_err_e ps_kill(struct ps_prochandle *, int sig);
135 extern ps_err_e ps_lrolltoaddr(struct ps_prochandle *,
136 			lwpid_t, psaddr_t go_addr, psaddr_t stop_addr);
137 
138 extern void	ps_plog(const char *fmt, ...);
139 
140 #ifdef __cplusplus
141 }
142 #endif
143 
144 #endif	/* _PROC_SERVICE_H */
145