xref: /onnv-gate/usr/src/lib/libpctx/common/libpctx.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	_LIBPCTX_H
28*0Sstevel@tonic-gate #define	_LIBPCTX_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #include <sys/types.h>
33*0Sstevel@tonic-gate #include <fcntl.h>
34*0Sstevel@tonic-gate #include <stdarg.h>
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * The process context library allows callers to use the facilities
38*0Sstevel@tonic-gate  * of /proc to control processes in a simplified way by managing
39*0Sstevel@tonic-gate  * the process via an event loop.  The controlling process expresses
40*0Sstevel@tonic-gate  * interest in various events which are handled as callbacks by the
41*0Sstevel@tonic-gate  * library.
42*0Sstevel@tonic-gate  */
43*0Sstevel@tonic-gate 
44*0Sstevel@tonic-gate #ifdef	__cplusplus
45*0Sstevel@tonic-gate extern "C" {
46*0Sstevel@tonic-gate #endif
47*0Sstevel@tonic-gate 
48*0Sstevel@tonic-gate typedef struct __pctx pctx_t;
49*0Sstevel@tonic-gate 
50*0Sstevel@tonic-gate /*
51*0Sstevel@tonic-gate  * A vprintf-like error handling routine can be passed in for use
52*0Sstevel@tonic-gate  * by more sophisticated callers.  If specified as NULL, errors
53*0Sstevel@tonic-gate  * are written to stderr.
54*0Sstevel@tonic-gate  */
55*0Sstevel@tonic-gate typedef void (pctx_errfn_t)(const char *fn, const char *fmt, va_list ap);
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate extern pctx_t *pctx_create(const char *filename, char *const *argv,
58*0Sstevel@tonic-gate     void *arg, int verbose, pctx_errfn_t *errfn);
59*0Sstevel@tonic-gate extern pctx_t *pctx_capture(pid_t pid,
60*0Sstevel@tonic-gate     void *arg, int verbose, pctx_errfn_t *errfn);
61*0Sstevel@tonic-gate 
62*0Sstevel@tonic-gate typedef int pctx_sysc_execfn_t(pctx_t *, pid_t, id_t, char *, void *);
63*0Sstevel@tonic-gate typedef void pctx_sysc_forkfn_t(pctx_t *, pid_t, id_t, pid_t, void *);
64*0Sstevel@tonic-gate typedef void pctx_sysc_exitfn_t(pctx_t *, pid_t, id_t, int, void *);
65*0Sstevel@tonic-gate typedef int pctx_sysc_lwp_createfn_t(pctx_t *, pid_t, id_t, void *);
66*0Sstevel@tonic-gate typedef int pctx_init_lwpfn_t(pctx_t *, pid_t, id_t, void *);
67*0Sstevel@tonic-gate typedef int pctx_fini_lwpfn_t(pctx_t *, pid_t, id_t, void *);
68*0Sstevel@tonic-gate typedef int pctx_sysc_lwp_exitfn_t(pctx_t *, pid_t, id_t, void *);
69*0Sstevel@tonic-gate 
70*0Sstevel@tonic-gate typedef	enum {
71*0Sstevel@tonic-gate 	PCTX_NULL_EVENT = 0,
72*0Sstevel@tonic-gate 	PCTX_SYSC_EXEC_EVENT,
73*0Sstevel@tonic-gate 	PCTX_SYSC_FORK_EVENT,
74*0Sstevel@tonic-gate 	PCTX_SYSC_EXIT_EVENT,
75*0Sstevel@tonic-gate 	PCTX_SYSC_LWP_CREATE_EVENT,
76*0Sstevel@tonic-gate 	PCTX_INIT_LWP_EVENT,
77*0Sstevel@tonic-gate 	PCTX_FINI_LWP_EVENT,
78*0Sstevel@tonic-gate 	PCTX_SYSC_LWP_EXIT_EVENT
79*0Sstevel@tonic-gate } pctx_event_t;
80*0Sstevel@tonic-gate 
81*0Sstevel@tonic-gate extern int pctx_set_events(pctx_t *pctx, ...);
82*0Sstevel@tonic-gate 
83*0Sstevel@tonic-gate extern int pctx_run(pctx_t *pctx, uint_t msec, uint_t nsamples,
84*0Sstevel@tonic-gate     int (*tick)(pctx_t *, pid_t, id_t, void *));
85*0Sstevel@tonic-gate 
86*0Sstevel@tonic-gate extern void pctx_release(pctx_t *pctx);
87*0Sstevel@tonic-gate 
88*0Sstevel@tonic-gate /*
89*0Sstevel@tonic-gate  * Implementation-private interfaces used by libcpc.
90*0Sstevel@tonic-gate  */
91*0Sstevel@tonic-gate struct __cpc;
92*0Sstevel@tonic-gate extern int __pctx_cpc(pctx_t *, struct __cpc *, int, id_t,
93*0Sstevel@tonic-gate 	void *, void *, void *, int);
94*0Sstevel@tonic-gate extern void __pctx_cpc_register_callback(void (*)(struct __cpc *,
95*0Sstevel@tonic-gate 	struct __pctx *));
96*0Sstevel@tonic-gate 
97*0Sstevel@tonic-gate #ifdef	__cplusplus
98*0Sstevel@tonic-gate }
99*0Sstevel@tonic-gate #endif
100*0Sstevel@tonic-gate 
101*0Sstevel@tonic-gate #endif	/* _LIBPCTX_H */
102