memory leak fixes
[dyninst.git] / visi / h / visualization.h
1 #ifndef _visualization_h
2 #define _visualization_h
3 /*
4  * Copyright (c) 1993, 1994 Barton P. Miller, Jeff Hollingsworth,
5  *     Bruce Irvin, Jon Cargille, Krishna Kunchithapadam, Karen
6  *     Karavanic, Tia Newhall, Mark Callaghan.  All rights reserved.
7  * 
8  * This software is furnished under the condition that it may not be
9  * provided or otherwise made available to, or used by, any other
10  * person, except as provided for by the terms of applicable license
11  * agreements.  No title to or ownership of the software is hereby
12  * transferred.  The name of the principals may not be used in any
13  * advertising or publicity related to this software without specific,
14  * written prior authorization.  Any use of this software must include
15  * the above copyright notice.
16  *
17  */
18
19 /* $Log: visualization.h,v $
20 /* Revision 1.8  1994/10/13 15:38:52  newhall
21 /* QuitVisi added
22 /*
23  * Revision 1.7  1994/09/25  01:58:16  newhall
24  * changed interface definitions to work for new version of igen
25  * changed AddMetricsResources def. to take array of metric/focus pairs
26  *
27  * Revision 1.6  1994/08/13  20:34:07  newhall
28  * removed all code associated with class visi_MRList
29  *
30  * Revision 1.5  1994/05/23  20:55:21  newhall
31  * To visi_GridCellHisto class: added deleted flag, SumValue
32  * method function, and fixed AggregateValue method function
33  *
34  * Revision 1.4  1994/05/11  17:11:10  newhall
35  * changed data values from double to float
36  *
37  * Revision 1.3  1994/04/13  21:23:15  newhall
38  * added routines: GetMetsRes, StopMetRes, NamePhase
39  *
40  * Revision 1.2  1994/03/17  05:13:41  newhall
41  * change callback type
42  *
43  * Revision 1.1  1994/03/14  20:27:33  newhall
44  * changed visi subdirectory structure
45  *  */ 
46 /////////////////////////////////////////////////////////
47 //  This file should be included in all visualizations.
48 //  It contains definitions for all the Paradyn visi
49 //  interface routines.  
50 /////////////////////////////////////////////////////////
51
52 #include "datagrid.h"
53 #include "visiTypes.h"
54
55 #define FILETABLESIZE  64
56 #define EVENTSIZE      FOLD+1
57
58 //
59 // global variables assoc. with histo datagrid
60 //   dataGrid: use visi_DataGrid method functions to access current
61 //             data values and information about metrics and resources 
62 //   metricList, resourceList: use visi_MRList method functions to 
63 //             access current metric and resource lists (changes to this
64 //             list do not affect the datagrid) primarly, these are used
65 //             to obtain and modify the parameters to GetMetsRes()
66 //   
67 extern visi_DataGrid  dataGrid;   
68 extern int            lastBucketSent;
69
70 //
71 // file descriptor array: 1st file desc. is assoc. w/ Paradyn
72 // remaining file descriptors are assigned by user when user
73 // uses main routine provided by Paradyn
74 //
75 extern int fileDesc[FILETABLESIZE];
76
77 //
78 // array of callback routines assoc. with file descriptors when
79 // user uses main routine provided by Paradyn
80 //
81 extern int (*fileDescCallbacks[FILETABLESIZE])();
82
83 //
84 // array of procedure pointers for callback routines assoc.
85 // with paradyn events  (ex. DATAVALUES,INVALIDMETRICSRESOURCES...)
86 // events types are defined in visiTypes.h
87 //
88 extern int (*eventCallbacks[EVENTSIZE])(int);
89
90 //
91 // callback associated with paradyn-visualization interface routines
92 //
93 extern int visi_callback();
94
95 /////////////////////////////////////////////////////////////
96 // these functions invoke upcalls to a visi interface client
97 // (call from visualization process to paradyn)
98 /////////////////////////////////////////////////////////////
99 //
100 // get a new set of metrics and resources from Paradyn
101 //
102 extern void GetMetsRes(char *metres,  // predefined list met-res pairs 
103                        int numElements,  
104                        int type);      // 0-histogram, 1-scalar
105
106 //
107 // stop data collection for a metric/resource pair
108 // arguments are the datagrid indicies associated with the
109 // metric and resource to stop
110 //
111 extern void StopMetRes(int metricIndex,    // datagrid index of metric
112                        int resourceIndex); // datagrid index of resource
113
114 //
115 // define a new phase to paradyn
116 //
117 extern void NamePhase(timeType begin,  // start of phase in seconds
118                       timeType end,    // end of phase in seconds
119                       char *name);     // name of phase 
120
121
122 ////////////////////////////////////////////////////////////////
123 //   initialization routines 
124 ////////////////////////////////////////////////////////////////
125 //
126 // connects to parent socket and registers the mainLoop routine
127 // as a callback on events on fileDesc[0]
128 // This routine should be called before entering the visualization's
129 // main loop, and before calling any other visi-interface routines
130 //
131 extern int  VisiInit();
132 extern int  initDone;
133
134
135 //
136 //  Makes initial call to get Metrics and Resources.
137 //  For visualizations that do not provide an event that
138 //  invokes the GetMetsRes upcall this routine should be
139 //  called by the visualization before entrering the mainloop.
140 //  (this will be the only chance to get metrics and resources
141 //  for the visualization).
142 //  For other visualizaitons, calling this routine before
143 //  entering the mainloop is optional. 
144 //
145 extern int  StartVisi(int argc,char *argv[]);
146
147 //
148 // cleans up visi interface data structs
149 // Visualizations should call this routine before exiting 
150 extern void QuitVisi();
151
152
153 //
154 // registration callback routine for paradyn events
155 // sets eventCallbacks[event] to callback routine provided by user
156 //
157 extern int RegistrationCallback(msgTag event,int (*callBack)(int));
158
159 //
160 // main loop provided by paradyn (not currently supported)
161 //
162 extern void ParadynMain();
163
164 //
165 // fd registration and callback routine registration for user
166 // to register callback routines when they use the provided main routine
167 //
168 extern int RegFileDescriptors(int *fd, int (*callBack)()); 
169
170 #endif