xref: /onnv-gate/usr/src/lib/libtnfctl/prb_proc_int.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 2004 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef _PRB_PROC_INT_H
28*0Sstevel@tonic-gate #define	_PRB_PROC_INT_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef __cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * Interfaces private to proc layer
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #include <sys/types.h>
41*0Sstevel@tonic-gate #include <sys/syscall.h>
42*0Sstevel@tonic-gate 
43*0Sstevel@tonic-gate #include <tnf/probe.h>
44*0Sstevel@tonic-gate #include <note.h>
45*0Sstevel@tonic-gate 
46*0Sstevel@tonic-gate #include "prb_proc.h"
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate /*
49*0Sstevel@tonic-gate  * size of breakpoint instruction
50*0Sstevel@tonic-gate  */
51*0Sstevel@tonic-gate #if defined(__sparc)
52*0Sstevel@tonic-gate typedef unsigned int bptsave_t;
53*0Sstevel@tonic-gate #elif defined(__i386) || defined(__amd64)
54*0Sstevel@tonic-gate typedef unsigned char bptsave_t;
55*0Sstevel@tonic-gate #endif
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate /*
58*0Sstevel@tonic-gate  * memory shared between parent and child when exec'ing a child.
59*0Sstevel@tonic-gate  * child spins on "spin" member waiting for parent to set it free
60*0Sstevel@tonic-gate  */
61*0Sstevel@tonic-gate typedef struct shmem_msg {
62*0Sstevel@tonic-gate 	boolean_t	spin;
63*0Sstevel@tonic-gate } shmem_msg_t;
64*0Sstevel@tonic-gate NOTE(SCHEME_PROTECTS_DATA("parent writes; child reads", shmem_msg))
65*0Sstevel@tonic-gate 
66*0Sstevel@tonic-gate /*
67*0Sstevel@tonic-gate  * per /proc handle state
68*0Sstevel@tonic-gate  */
69*0Sstevel@tonic-gate struct prb_proc_ctl {
70*0Sstevel@tonic-gate 	int 		procfd;
71*0Sstevel@tonic-gate 	int		pid;
72*0Sstevel@tonic-gate 	uintptr_t	bptaddr;
73*0Sstevel@tonic-gate 	bptsave_t	saveinstr;	/* instruction that bpt replaced */
74*0Sstevel@tonic-gate 	boolean_t	bpt_inserted;	/* is bpt inserted ? */
75*0Sstevel@tonic-gate 	uintptr_t	dbgaddr;
76*0Sstevel@tonic-gate };
77*0Sstevel@tonic-gate NOTE(SCHEME_PROTECTS_DATA("one thread per handle", prb_proc_ctl))
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate /*
80*0Sstevel@tonic-gate  * Declarations
81*0Sstevel@tonic-gate  */
82*0Sstevel@tonic-gate prb_status_t	prb_status_map(int);
83*0Sstevel@tonic-gate prb_status_t	find_executable(const char *name, char *ret_path);
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate /* shared memory lock interfaces */
86*0Sstevel@tonic-gate prb_status_t	prb_shmem_init(volatile shmem_msg_t **);
87*0Sstevel@tonic-gate prb_status_t	prb_shmem_wait(volatile shmem_msg_t *);
88*0Sstevel@tonic-gate prb_status_t	prb_shmem_clear(volatile shmem_msg_t *);
89*0Sstevel@tonic-gate prb_status_t	prb_shmem_free(volatile shmem_msg_t *smp);
90*0Sstevel@tonic-gate 
91*0Sstevel@tonic-gate /* runs and stops the process to clear it out of system call */
92*0Sstevel@tonic-gate prb_status_t	prb_proc_prstop(prb_proc_ctl_t *proc_p);
93*0Sstevel@tonic-gate 
94*0Sstevel@tonic-gate /* break point interfaces */
95*0Sstevel@tonic-gate prb_status_t	prb_proc_tracebpt(prb_proc_ctl_t *proc_p, boolean_t bpt);
96*0Sstevel@tonic-gate prb_status_t	prb_proc_istepbpt(prb_proc_ctl_t *proc_p);
97*0Sstevel@tonic-gate prb_status_t	prb_proc_clrbptflt(prb_proc_ctl_t *proc_p);
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate /* read a string from target process */
100*0Sstevel@tonic-gate prb_status_t	prb_proc_readstr(prb_proc_ctl_t *proc_p, uintptr_t addr,
101*0Sstevel@tonic-gate 			const char **outstr_pp);
102*0Sstevel@tonic-gate 
103*0Sstevel@tonic-gate #ifdef __cplusplus
104*0Sstevel@tonic-gate }
105*0Sstevel@tonic-gate #endif
106*0Sstevel@tonic-gate 
107*0Sstevel@tonic-gate #endif	/* _PRB_PROC_INT_H */
108