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