xref: /illumos-gate/usr/src/lib/libdtrace/common/dt_proc.h (revision a07094369b21309434206d9b3601d162693466fc)
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, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 
23 /*
24  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
25  * Use is subject to license terms.
26  */
27 
28 #ifndef	_DT_PROC_H
29 #define	_DT_PROC_H
30 
31 #pragma ident	"%Z%%M%	%I%	%E% SMI"
32 
33 #include <libproc.h>
34 #include <dtrace.h>
35 #include <pthread.h>
36 #include <dt_list.h>
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 typedef struct dt_proc {
43 	dt_list_t dpr_list;		/* prev/next pointers for lru chain */
44 	struct dt_proc *dpr_hash;	/* next pointer for pid hash chain */
45 	dtrace_hdl_t *dpr_hdl;		/* back pointer to libdtrace handle */
46 	struct ps_prochandle *dpr_proc;	/* proc handle for libproc calls */
47 	char dpr_errmsg[BUFSIZ];	/* error message */
48 	rd_agent_t *dpr_rtld;		/* rtld handle for librtld_db calls */
49 	pthread_mutex_t dpr_lock;	/* lock for manipulating dpr_hdl */
50 	pthread_cond_t dpr_cv;		/* cond for dpr_stop/quit/done */
51 	pid_t dpr_pid;			/* pid of process */
52 	uint_t dpr_refs;		/* reference count */
53 	uint8_t dpr_cacheable;		/* cache handle using lru list */
54 	uint8_t dpr_stop;		/* stop mask: see flag bits below */
55 	uint8_t dpr_quit;		/* quit flag: ctl thread should quit */
56 	uint8_t dpr_done;		/* done flag: ctl thread has exited */
57 	uint8_t dpr_usdt;		/* usdt flag: usdt initialized */
58 	uint8_t dpr_stale;		/* proc flag: been deprecated */
59 	uint8_t dpr_rdonly;		/* proc flag: opened read-only */
60 	pthread_t dpr_tid;		/* control thread (or zero if none) */
61 	dt_list_t dpr_bps;		/* list of dt_bkpt_t structures */
62 } dt_proc_t;
63 
64 typedef struct dt_proc_notify {
65 	dt_proc_t *dprn_dpr;		/* process associated with the event */
66 	char dprn_errmsg[BUFSIZ];	/* error message */
67 	struct dt_proc_notify *dprn_next; /* next pointer */
68 } dt_proc_notify_t;
69 
70 #define	DT_PROC_STOP_IDLE	0x01	/* idle on owner's stop request */
71 #define	DT_PROC_STOP_CREATE	0x02	/* wait on dpr_cv at process exec */
72 #define	DT_PROC_STOP_GRAB	0x04	/* wait on dpr_cv at process grab */
73 #define	DT_PROC_STOP_PREINIT	0x08	/* wait on dpr_cv at rtld preinit */
74 #define	DT_PROC_STOP_POSTINIT	0x10	/* wait on dpr_cv at rtld postinit */
75 #define	DT_PROC_STOP_MAIN	0x20	/* wait on dpr_cv at a.out`main() */
76 
77 typedef void dt_bkpt_f(dtrace_hdl_t *, dt_proc_t *, void *);
78 
79 typedef struct dt_bkpt {
80 	dt_list_t dbp_list;		/* prev/next pointers for bkpt list */
81 	dt_bkpt_f *dbp_func;		/* callback function to execute */
82 	void *dbp_data;			/* callback function private data */
83 	uintptr_t dbp_addr;		/* virtual address of breakpoint */
84 	ulong_t dbp_instr;		/* saved instruction from breakpoint */
85 	ulong_t dbp_hits;		/* count of breakpoint hits for debug */
86 	int dbp_active;			/* flag indicating breakpoint is on */
87 } dt_bkpt_t;
88 
89 typedef struct dt_proc_hash {
90 	pthread_mutex_t dph_lock;	/* lock protecting dph_notify list */
91 	pthread_cond_t dph_cv;		/* cond for waiting for dph_notify */
92 	dt_proc_notify_t *dph_notify;	/* list of pending proc notifications */
93 	dt_list_t dph_lrulist;		/* list of dt_proc_t's in lru order */
94 	uint_t dph_lrulim;		/* limit on number of procs to hold */
95 	uint_t dph_lrucnt;		/* count of cached process handles */
96 	uint_t dph_hashlen;		/* size of hash chains array */
97 	dt_proc_t *dph_hash[1];		/* hash chains array */
98 } dt_proc_hash_t;
99 
100 extern struct ps_prochandle *dt_proc_create(dtrace_hdl_t *,
101     const char *, char *const *);
102 
103 extern struct ps_prochandle *dt_proc_grab(dtrace_hdl_t *, pid_t, int, int);
104 extern void dt_proc_release(dtrace_hdl_t *, struct ps_prochandle *);
105 extern void dt_proc_continue(dtrace_hdl_t *, struct ps_prochandle *);
106 extern void dt_proc_lock(dtrace_hdl_t *, struct ps_prochandle *);
107 extern void dt_proc_unlock(dtrace_hdl_t *, struct ps_prochandle *);
108 extern dt_proc_t *dt_proc_lookup(dtrace_hdl_t *, struct ps_prochandle *, int);
109 
110 extern void dt_proc_bpenable(dt_proc_t *);
111 extern void dt_proc_bpdisable(dt_proc_t *);
112 
113 extern void dt_proc_hash_create(dtrace_hdl_t *);
114 extern void dt_proc_hash_destroy(dtrace_hdl_t *);
115 
116 #ifdef	__cplusplus
117 }
118 #endif
119 
120 #endif	/* _DT_PROC_H */
121