Home | History | Annotate | Line # | Download | only in common 
      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 /*
     23  * Copyright 2007 Sun Microsystems, Inc.  All rights reserved.
     24  * Use is subject to license terms.
     25  */
     26 
     27 #ifndef	_DT_PROC_H
     28 #define	_DT_PROC_H
     29 
     30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
     31 
     32 #include <libproc.h>
     33 #include <dtrace.h>
     34 #include <pthread.h>
     35 #include <dt_list.h>
     36 
     37 #ifdef	__cplusplus
     38 extern "C" {
     39 #endif
     40 
     41 typedef struct dt_proc {
     42 	dt_list_t dpr_list;		/* prev/next pointers for lru chain */
     43 	struct dt_proc *dpr_hash;	/* next pointer for pid hash chain */
     44 	dtrace_hdl_t *dpr_hdl;		/* back pointer to libdtrace handle */
     45 	struct ps_prochandle *dpr_proc;	/* proc handle for libproc calls */
     46 	char dpr_errmsg[BUFSIZ];	/* error message */
     47 	rd_agent_t *dpr_rtld;		/* rtld handle for librtld_db calls */
     48 	pthread_mutex_t dpr_lock;	/* lock for manipulating dpr_hdl */
     49 	pthread_cond_t dpr_cv;		/* cond for dpr_stop/quit/done */
     50 	pid_t dpr_pid;			/* pid of process */
     51 	uint_t dpr_refs;		/* reference count */
     52 	uint8_t dpr_cacheable;		/* cache handle using lru list */
     53 	uint8_t dpr_stop;		/* stop mask: see flag bits below */
     54 	uint8_t dpr_quit;		/* quit flag: ctl thread should quit */
     55 	uint8_t dpr_done;		/* done flag: ctl thread has exited */
     56 	uint8_t dpr_usdt;		/* usdt flag: usdt initialized */
     57 	uint8_t dpr_stale;		/* proc flag: been deprecated */
     58 	uint8_t dpr_rdonly;		/* proc flag: opened read-only */
     59 	pthread_t dpr_tid;		/* control thread (or zero if none) */
     60 	dt_list_t dpr_bps;		/* list of dt_bkpt_t structures */
     61 } dt_proc_t;
     62 
     63 typedef struct dt_proc_notify {
     64 	dt_proc_t *dprn_dpr;		/* process associated with the event */
     65 	char dprn_errmsg[BUFSIZ];	/* error message */
     66 	struct dt_proc_notify *dprn_next; /* next pointer */
     67 } dt_proc_notify_t;
     68 
     69 #define	DT_PROC_STOP_IDLE	0x01	/* idle on owner's stop request */
     70 #define	DT_PROC_STOP_CREATE	0x02	/* wait on dpr_cv at process exec */
     71 #define	DT_PROC_STOP_GRAB	0x04	/* wait on dpr_cv at process grab */
     72 #define	DT_PROC_STOP_PREINIT	0x08	/* wait on dpr_cv at rtld preinit */
     73 #define	DT_PROC_STOP_POSTINIT	0x10	/* wait on dpr_cv at rtld postinit */
     74 #define	DT_PROC_STOP_MAIN	0x20	/* wait on dpr_cv at a.out`main() */
     75 
     76 typedef void dt_bkpt_f(dtrace_hdl_t *, dt_proc_t *, void *);
     77 
     78 typedef struct dt_bkpt {
     79 	dt_list_t dbp_list;		/* prev/next pointers for bkpt list */
     80 	dt_bkpt_f *dbp_func;		/* callback function to execute */
     81 	void *dbp_data;			/* callback function private data */
     82 	uintptr_t dbp_addr;		/* virtual address of breakpoint */
     83 #ifdef __NetBSD__
     84 	proc_breakpoint_t dbp_instr;	/* saved instruction from breakpoint */
     85 #else
     86 	ulong_t dbp_instr;		/* saved instruction from breakpoint */
     87 #endif
     88 	ulong_t dbp_hits;		/* count of breakpoint hits for debug */
     89 	int dbp_active;			/* flag indicating breakpoint is on */
     90 } dt_bkpt_t;
     91 
     92 typedef struct dt_proc_hash {
     93 	pthread_mutex_t dph_lock;	/* lock protecting dph_notify list */
     94 	pthread_cond_t dph_cv;		/* cond for waiting for dph_notify */
     95 	dt_proc_notify_t *dph_notify;	/* list of pending proc notifications */
     96 	dt_list_t dph_lrulist;		/* list of dt_proc_t's in lru order */
     97 	uint_t dph_lrulim;		/* limit on number of procs to hold */
     98 	uint_t dph_lrucnt;		/* count of cached process handles */
     99 	uint_t dph_hashlen;		/* size of hash chains array */
    100 	dt_proc_t *dph_hash[1];		/* hash chains array */
    101 } dt_proc_hash_t;
    102 
    103 extern struct ps_prochandle *dt_proc_create(dtrace_hdl_t *,
    104     const char *, char *const *, proc_child_func *, void *);
    105 
    106 extern struct ps_prochandle *dt_proc_grab(dtrace_hdl_t *, pid_t, int, int);
    107 extern void dt_proc_release(dtrace_hdl_t *, struct ps_prochandle *);
    108 extern void dt_proc_continue(dtrace_hdl_t *, struct ps_prochandle *);
    109 extern void dt_proc_lock(dtrace_hdl_t *, struct ps_prochandle *);
    110 extern void dt_proc_unlock(dtrace_hdl_t *, struct ps_prochandle *);
    111 extern dt_proc_t *dt_proc_lookup(dtrace_hdl_t *, struct ps_prochandle *, int);
    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