updated test subdirectory, added visilib routine GetMetRes()
[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.11  1995/09/18 18:26:00  newhall
21 /* updated test subdirectory, added visilib routine GetMetRes()
22 /*
23  * Revision 1.10  1995/08/01  01:58:46  newhall
24  * changes relating to phase interface stuff
25  *
26  * Revision 1.9  1995/02/26  01:59:31  newhall
27  * added phase interface functions
28  *
29  * Revision 1.8  1994/10/13  15:38:52  newhall
30  * QuitVisi added
31  *
32  * Revision 1.7  1994/09/25  01:58:16  newhall
33  * changed interface definitions to work for new version of igen
34  * changed AddMetricsResources def. to take array of metric/focus pairs
35  *
36  * Revision 1.6  1994/08/13  20:34:07  newhall
37  * removed all code associated with class visi_MRList
38  *
39  * Revision 1.5  1994/05/23  20:55:21  newhall
40  * To visi_GridCellHisto class: added deleted flag, SumValue
41  * method function, and fixed AggregateValue method function
42  *
43  * Revision 1.4  1994/05/11  17:11:10  newhall
44  * changed data values from double to float
45  *
46  * Revision 1.3  1994/04/13  21:23:15  newhall
47  * added routines: GetMetsRes, StopMetRes, NamePhase
48  *
49  * Revision 1.2  1994/03/17  05:13:41  newhall
50  * change callback type
51  *
52  * Revision 1.1  1994/03/14  20:27:33  newhall
53  * changed visi subdirectory structure
54  *  */ 
55 /////////////////////////////////////////////////////////
56 //  This file should be included in all visualizations.
57 //  It contains definitions for all the Paradyn visi
58 //  interface routines.  
59 /////////////////////////////////////////////////////////
60
61 #include "datagrid.h"
62 #include "visiTypes.h"
63
64 #define FILETABLESIZE  64
65 #define EVENTSIZE      FOLD+1
66
67 //
68 // global variables assoc. with histo datagrid
69 //   dataGrid: use visi_DataGrid method functions to access current
70 //             data values and information about metrics and resources 
71 //   metricList, resourceList: use visi_MRList method functions to 
72 //             access current metric and resource lists (changes to this
73 //             list do not affect the datagrid) primarly, these are used
74 //             to obtain and modify the parameters to GetMetsRes()
75 //   
76 extern visi_DataGrid  dataGrid;   
77 extern int            lastBucketSent;
78
79 //
80 // file descriptor array: 1st file desc. is assoc. w/ Paradyn
81 // remaining file descriptors are assigned by user when user
82 // uses main routine provided by Paradyn
83 //
84 extern int fileDesc[FILETABLESIZE];
85
86 //
87 // array of callback routines assoc. with file descriptors when
88 // user uses main routine provided by Paradyn
89 //
90 extern int (*fileDescCallbacks[FILETABLESIZE])();
91
92 //
93 // array of procedure pointers for callback routines assoc.
94 // with paradyn events  (ex. DATAVALUES,INVALIDMETRICSRESOURCES...)
95 // events types are defined in visiTypes.h
96 //
97 extern int (*eventCallbacks[EVENTSIZE])(int);
98
99 //
100 // callback associated with paradyn-visualization interface routines
101 //
102 extern int visi_callback();
103
104 /////////////////////////////////////////////////////////////
105 // these functions invoke upcalls to a visi interface client
106 // (call from visualization process to paradyn)
107 /////////////////////////////////////////////////////////////
108 //
109 // get a new set of metrics and resources from Paradyn
110 //
111 extern void GetMetsRes(char *metres,  // predefined list met-res pairs 
112                        int numElements,  
113                        int type);      // 0-histogram, 1-scalar
114
115 //
116 // equivalent to a call to GetMetRes(0,0,0)
117 //
118 extern void GetMetsRes();
119
120 //
121 // stop data collection for a metric/resource pair
122 // arguments are the datagrid indicies associated with the
123 // metric and resource to stop
124 //
125 extern void StopMetRes(int metricIndex,    // datagrid index of metric
126                        int resourceIndex); // datagrid index of resource
127
128 //
129 // define a new phase to paradyn, can specify some time in the future
130 // for the phase to begin or a begin value of -1 means now
131 //
132 extern void DefinePhase(timeType begin,  // in seconds 
133                         char *name);     // name of phase 
134
135 ////////////////////////////////////////////////////////////////
136 //   initialization routines 
137 ////////////////////////////////////////////////////////////////
138 //
139 // connects to parent socket and registers the mainLoop routine
140 // as a callback on events on fileDesc[0]
141 // This routine should be called before entering the visualization's
142 // main loop, and before calling any other visi-interface routines
143 //
144 extern int  VisiInit();
145 extern int  initDone;
146
147
148 //
149 //  Makes initial call to get Metrics and Resources.
150 //  For visualizations that do not provide an event that
151 //  invokes the GetMetsRes upcall this routine should be
152 //  called by the visualization before entrering the mainloop.
153 //  (this will be the only chance to get metrics and resources
154 //  for the visualization).
155 //  For other visualizaitons, calling this routine before
156 //  entering the mainloop is optional. 
157 //
158 extern int  StartVisi(int argc,char *argv[]);
159
160 //
161 // cleans up visi interface data structs
162 // Visualizations should call this routine before exiting 
163 extern void QuitVisi();
164
165
166 //
167 // registration callback routine for paradyn events
168 // sets eventCallbacks[event] to callback routine provided by user
169 //
170 extern int RegistrationCallback(msgTag event,int (*callBack)(int));
171
172 //
173 // main loop provided by paradyn (not currently supported)
174 //
175 extern void ParadynMain();
176
177 //
178 // fd registration and callback routine registration for user
179 // to register callback routines when they use the provided main routine
180 //
181 extern int RegFileDescriptors(int *fd, int (*callBack)()); 
182
183 #endif