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