|
1 /* |
|
2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * |
|
16 * Instrumentation manager groups traces that were instrumented within a single run |
|
17 * |
|
18 */ |
|
19 package com.nokia.tracebuilder.engine.propertydialog; |
|
20 |
|
21 import java.text.SimpleDateFormat; |
|
22 import java.util.ArrayList; |
|
23 import java.util.Calendar; |
|
24 import java.util.Collections; |
|
25 import java.util.HashMap; |
|
26 import java.util.Iterator; |
|
27 import java.util.List; |
|
28 import java.util.Set; |
|
29 |
|
30 import com.nokia.tracebuilder.engine.TraceBuilderErrorCodes.TraceBuilderErrorCode; |
|
31 import com.nokia.tracebuilder.engine.source.SourceEngine; |
|
32 import com.nokia.tracebuilder.engine.source.SourceProperties; |
|
33 import com.nokia.tracebuilder.model.Trace; |
|
34 import com.nokia.tracebuilder.model.TraceBuilderException; |
|
35 import com.nokia.tracebuilder.model.TraceGroup; |
|
36 import com.nokia.tracebuilder.model.TraceModel; |
|
37 import com.nokia.tracebuilder.model.TraceModelExtension; |
|
38 import com.nokia.tracebuilder.model.TraceModelExtensionListener; |
|
39 import com.nokia.tracebuilder.model.TraceModelListener; |
|
40 import com.nokia.tracebuilder.model.TraceModelResetListener; |
|
41 import com.nokia.tracebuilder.model.TraceObject; |
|
42 import com.nokia.tracebuilder.source.SourceContext; |
|
43 |
|
44 /** |
|
45 * Instrumentation engine groups traces that were instrumented within a single |
|
46 * run. |
|
47 * |
|
48 */ |
|
49 public final class InstrumentationEngine { |
|
50 |
|
51 /** |
|
52 * Model listener for instrumenter |
|
53 * |
|
54 */ |
|
55 private final class InstrumenterModelListener implements TraceModelListener { |
|
56 |
|
57 /* |
|
58 * (non-Javadoc) |
|
59 * |
|
60 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
61 * objectAdded(com.nokia.tracebuilder.model.TraceObject, |
|
62 * com.nokia.tracebuilder.model.TraceObject) |
|
63 */ |
|
64 public void objectAdded(TraceObject owner, TraceObject object) { |
|
65 } |
|
66 |
|
67 /* |
|
68 * (non-Javadoc) |
|
69 * |
|
70 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
71 * objectCreationComplete(com.nokia.tracebuilder.model.TraceObject) |
|
72 */ |
|
73 public void objectCreationComplete(TraceObject object) { |
|
74 } |
|
75 |
|
76 /* |
|
77 * (non-Javadoc) |
|
78 * |
|
79 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
80 * objectRemoved(com.nokia.tracebuilder.model.TraceObject, |
|
81 * com.nokia.tracebuilder.model.TraceObject) |
|
82 */ |
|
83 public void objectRemoved(TraceObject owner, TraceObject object) { |
|
84 if (object instanceof Trace) { |
|
85 removeInstrumentedTrace(object); |
|
86 } else if (object instanceof TraceGroup) { |
|
87 Iterator<Trace> itr = ((TraceGroup) object).getTraces(); |
|
88 while (itr.hasNext()) { |
|
89 removeInstrumentedTrace(itr.next()); |
|
90 } |
|
91 } |
|
92 } |
|
93 |
|
94 /* |
|
95 * (non-Javadoc) |
|
96 * |
|
97 * @see com.nokia.tracebuilder.model.TraceModelListener# |
|
98 * propertyUpdated(com.nokia.tracebuilder.model.TraceObject, int) |
|
99 */ |
|
100 public void propertyUpdated(TraceObject object, int property) { |
|
101 } |
|
102 |
|
103 } |
|
104 |
|
105 /** |
|
106 * Extension listener for instrumenter |
|
107 * |
|
108 */ |
|
109 private final class InstrumenterExtensionListener implements |
|
110 TraceModelExtensionListener { |
|
111 |
|
112 /* |
|
113 * (non-Javadoc) |
|
114 * |
|
115 * @see com.nokia.tracebuilder.model.TraceModelExtensionListener# |
|
116 * extensionAdded(com.nokia.tracebuilder.model.TraceObject, |
|
117 * com.nokia.tracebuilder.model.TraceModelExtension) |
|
118 */ |
|
119 public void extensionAdded(TraceObject object, |
|
120 TraceModelExtension extension) { |
|
121 if (extension instanceof InstrumentedTraceRule) { |
|
122 addInstrumentedTrace((InstrumentedTraceRule) extension); |
|
123 } |
|
124 } |
|
125 |
|
126 /* |
|
127 * (non-Javadoc) |
|
128 * |
|
129 * @see com.nokia.tracebuilder.model.TraceModelExtensionListener# |
|
130 * extensionRemoved(com.nokia.tracebuilder.model.TraceObject, |
|
131 * com.nokia.tracebuilder.model.TraceModelExtension) |
|
132 */ |
|
133 public void extensionRemoved(TraceObject object, |
|
134 TraceModelExtension extension) { |
|
135 if (extension instanceof InstrumentedTraceRule) { |
|
136 removeInstrumentedTrace((InstrumentedTraceRule) extension); |
|
137 } |
|
138 } |
|
139 |
|
140 } |
|
141 |
|
142 /** |
|
143 * Clears the instrumenter IDs when model is reset |
|
144 * |
|
145 */ |
|
146 private final class InstrumenterModelResetListener implements |
|
147 TraceModelResetListener { |
|
148 |
|
149 /* |
|
150 * (non-Javadoc) |
|
151 * |
|
152 * @see com.nokia.tracebuilder.model.TraceModelResetListener#modelReset() |
|
153 */ |
|
154 public void modelReset() { |
|
155 clearInstrumentation(); |
|
156 } |
|
157 |
|
158 /* |
|
159 * (non-Javadoc) |
|
160 * |
|
161 * @see com.nokia.tracebuilder.model.TraceModelResetListener#modelResetting() |
|
162 */ |
|
163 public void modelResetting() { |
|
164 } |
|
165 |
|
166 /* |
|
167 * (non-Javadoc) |
|
168 * |
|
169 * @see com.nokia.tracebuilder.model.TraceModelResetListener#modelValid(boolean) |
|
170 */ |
|
171 public void modelValid(boolean valid) { |
|
172 } |
|
173 } |
|
174 |
|
175 /** |
|
176 * List of instrumented traces |
|
177 */ |
|
178 private HashMap<String, List<InstrumentedTraceRule>> instrumentedTraces; |
|
179 |
|
180 /** |
|
181 * Constructor |
|
182 * |
|
183 * @param model |
|
184 * the trace model |
|
185 */ |
|
186 public InstrumentationEngine(TraceModel model) { |
|
187 model.addResetListener(new InstrumenterModelResetListener()); |
|
188 model.addModelListener(new InstrumenterModelListener()); |
|
189 model.addExtensionListener(new InstrumenterExtensionListener()); |
|
190 } |
|
191 |
|
192 /** |
|
193 * Gets a unique ID for instrumentation |
|
194 * |
|
195 * @return instrumenter ID |
|
196 */ |
|
197 public String getNewInstrumenterID() { |
|
198 SimpleDateFormat format = new SimpleDateFormat("yy-MMM-dd, hh:mm:ss"); //$NON-NLS-1$ |
|
199 return format.format(Calendar.getInstance().getTime()); |
|
200 } |
|
201 |
|
202 /** |
|
203 * Checks that there are source files that can be instrumented |
|
204 * |
|
205 * @param sourceEngine |
|
206 * the source engine |
|
207 * @throws TraceBuilderException |
|
208 * if sources are not valid |
|
209 */ |
|
210 public void checkSourceFunctions(SourceEngine sourceEngine) |
|
211 throws TraceBuilderException { |
|
212 Iterator<SourceProperties> sources = sourceEngine.getSources(); |
|
213 if (sources.hasNext()) { |
|
214 boolean hasFunctions = false; |
|
215 while (!hasFunctions && sources.hasNext()) { |
|
216 SourceProperties source = sources.next(); |
|
217 Iterator<SourceContext> contexts = source.getSourceEditor() |
|
218 .getContexts(); |
|
219 if (contexts.hasNext()) { |
|
220 hasFunctions = true; |
|
221 } |
|
222 } |
|
223 if (!hasFunctions) { |
|
224 throw new TraceBuilderException( |
|
225 TraceBuilderErrorCode.NO_FUNCTIONS_TO_INSTRUMENT); |
|
226 } |
|
227 } else { |
|
228 throw new TraceBuilderException( |
|
229 TraceBuilderErrorCode.SOURCE_NOT_OPEN); |
|
230 } |
|
231 } |
|
232 |
|
233 /** |
|
234 * Instrumented trace was added to the model |
|
235 * |
|
236 * @param rule |
|
237 * the trace rule |
|
238 */ |
|
239 private void addInstrumentedTrace(InstrumentedTraceRule rule) { |
|
240 if (instrumentedTraces == null) { |
|
241 instrumentedTraces = new HashMap<String, List<InstrumentedTraceRule>>(); |
|
242 } |
|
243 List<InstrumentedTraceRule> list = instrumentedTraces.get(rule |
|
244 .getInstrumenterID()); |
|
245 if (list == null) { |
|
246 list = new ArrayList<InstrumentedTraceRule>(); |
|
247 instrumentedTraces.put(rule.getInstrumenterID(), list); |
|
248 } |
|
249 list.add(rule); |
|
250 } |
|
251 |
|
252 /** |
|
253 * Instrumented trace was removed |
|
254 * |
|
255 * @param rule |
|
256 * the trace rule |
|
257 */ |
|
258 private void removeInstrumentedTrace(InstrumentedTraceRule rule) { |
|
259 if (instrumentedTraces != null) { |
|
260 List<InstrumentedTraceRule> list = instrumentedTraces.get(rule |
|
261 .getInstrumenterID()); |
|
262 if (list != null) { |
|
263 list.remove(rule); |
|
264 if (list.isEmpty()) { |
|
265 instrumentedTraces.remove(rule.getInstrumenterID()); |
|
266 } |
|
267 } |
|
268 } |
|
269 } |
|
270 |
|
271 /** |
|
272 * Checks if a trace contains the InstrumentedTraceRule extension and |
|
273 * removes it from the list if it does |
|
274 * |
|
275 * @param trace |
|
276 * the trace |
|
277 */ |
|
278 private void removeInstrumentedTrace(TraceObject trace) { |
|
279 InstrumentedTraceRule rule = trace |
|
280 .getExtension(InstrumentedTraceRule.class); |
|
281 if (rule != null) { |
|
282 removeInstrumentedTrace(rule); |
|
283 } |
|
284 } |
|
285 |
|
286 /** |
|
287 * Removes all instrumented traces from the list |
|
288 */ |
|
289 private void clearInstrumentation() { |
|
290 if (instrumentedTraces != null) { |
|
291 instrumentedTraces.clear(); |
|
292 } |
|
293 } |
|
294 |
|
295 /** |
|
296 * Gets the instrumentation ID list |
|
297 * |
|
298 * @return the instrumentation IDs |
|
299 */ |
|
300 Iterator<String> getInstrumenterIDs() { |
|
301 Set<String> set; |
|
302 if (instrumentedTraces != null) { |
|
303 set = instrumentedTraces.keySet(); |
|
304 } else { |
|
305 set = Collections.emptySet(); |
|
306 } |
|
307 return set.iterator(); |
|
308 } |
|
309 |
|
310 /** |
|
311 * Gets the instrumented traces for given ID |
|
312 * |
|
313 * @param instrumenterID |
|
314 * the instrumenter ID |
|
315 * @return instrumented trace list |
|
316 */ |
|
317 Iterator<InstrumentedTraceRule> getInstrumentedTraces(String instrumenterID) { |
|
318 List<InstrumentedTraceRule> list; |
|
319 if (instrumentedTraces != null) { |
|
320 list = instrumentedTraces.get(instrumenterID); |
|
321 } else { |
|
322 list = Collections.emptyList(); |
|
323 } |
|
324 return list.iterator(); |
|
325 } |
|
326 } |