1 /*******************************************************************************
2 * Copyright (c) 2012, 2013 Ericsson
3 * Copyright (c) 2010, 2011 École Polytechnique de Montréal
4 * Copyright (c) 2010, 2011 Alexandre Montplaisir <alexandre.montplaisir@gmail.com>
6 * All rights reserved. This program and the accompanying materials are
7 * made available under the terms of the Eclipse Public License v1.0 which
8 * accompanies this distribution, and is available at
9 * http://www.eclipse.org/legal/epl-v10.html
11 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.internal
.tmf
.core
.statesystem
;
15 import java
.io
.PrintWriter
;
16 import java
.util
.ArrayList
;
17 import java
.util
.List
;
19 import org
.eclipse
.linuxtools
.internal
.tmf
.core
.statesystem
.backends
.IStateHistoryBackend
;
20 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.AttributeNotFoundException
;
21 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.StateValueTypeException
;
22 import org
.eclipse
.linuxtools
.tmf
.core
.exceptions
.TimeRangeException
;
23 import org
.eclipse
.linuxtools
.tmf
.core
.interval
.ITmfStateInterval
;
24 import org
.eclipse
.linuxtools
.tmf
.core
.interval
.TmfStateInterval
;
25 import org
.eclipse
.linuxtools
.tmf
.core
.statevalue
.ITmfStateValue
;
26 import org
.eclipse
.linuxtools
.tmf
.core
.statevalue
.TmfStateValue
;
29 * The Transient State is used to build intervals from punctual state changes. It
30 * contains a "state info" vector similar to the "current state", except here we
31 * also record the start time of every state stored in it.
33 * We can then build StateInterval's, to be inserted in the State History when
34 * we detect state changes : the "start time" of the interval will be the
35 * recorded time we have here, and the "end time" will be the timestamp of the
36 * new state-changing event we just read.
41 class TransientState
{
43 /* Indicates where to insert state changes that we generate */
44 private final IStateHistoryBackend backend
;
46 private boolean isActive
;
47 private long latestTime
;
49 private ArrayList
<ITmfStateValue
> ongoingStateInfo
;
50 private final ArrayList
<Long
> ongoingStateStartTimes
;
51 private final ArrayList
<Byte
> stateValueTypes
;
53 TransientState(IStateHistoryBackend backend
) {
54 this.backend
= backend
;
56 ongoingStateInfo
= new ArrayList
<ITmfStateValue
>();
57 ongoingStateStartTimes
= new ArrayList
<Long
>();
58 stateValueTypes
= new ArrayList
<Byte
>();
60 if (backend
!= null) {
61 latestTime
= backend
.getStartTime();
67 long getLatestTime() {
71 ITmfStateValue
getOngoingStateValue(int index
) throws AttributeNotFoundException
{
72 checkValidAttribute(index
);
73 return ongoingStateInfo
.get(index
);
76 long getOngoingStartTime(int index
) throws AttributeNotFoundException
{
77 checkValidAttribute(index
);
78 return ongoingStateStartTimes
.get(index
);
81 void changeOngoingStateValue(int index
, ITmfStateValue newValue
)
82 throws AttributeNotFoundException
{
83 checkValidAttribute(index
);
84 ongoingStateInfo
.set(index
, newValue
);
88 * Return the "ongoing" value for a given attribute as a dummy interval
89 * whose end time = -1 (since we don't know its real end time yet).
92 * @throws AttributeNotFoundException
94 ITmfStateInterval
getOngoingInterval(int quark
) throws AttributeNotFoundException
{
95 checkValidAttribute(quark
);
96 return new TmfStateInterval(ongoingStateStartTimes
.get(quark
), -1, quark
,
97 ongoingStateInfo
.get(quark
));
100 private void checkValidAttribute(int quark
) throws AttributeNotFoundException
{
101 if (quark
> ongoingStateInfo
.size() - 1 || quark
< 0) {
102 throw new AttributeNotFoundException();
107 * Batch method of changeOngoingStateValue(), updates the complete
108 * ongoingStateInfo in one go. BE VERY CAREFUL WITH THIS! Especially with
109 * the sizes of both arrays.
111 * Note that the new ongoingStateInfo will be a shallow copy of
112 * newStateInfo, so that last one must be already instantiated and all.
114 * @param newStateInfo
115 * The List of StateValues to replace the old ongoingStateInfo
118 void changeOngoingStateInfo(ArrayList
<ITmfStateValue
> newStateInfo
) {
119 this.ongoingStateInfo
= newStateInfo
;
123 * Add an "empty line" to both "ongoing..." vectors. This is needed so the
124 * Ongoing... tables can stay in sync with the number of attributes in the
125 * attribute tree, namely when we add sub-path attributes.
127 synchronized void addEmptyEntry() {
129 * Since this is a new attribute, we suppose it was in the "null state"
130 * since the beginning (so we can have intervals covering for all
131 * timestamps). A null interval will then get added at the first state
134 ongoingStateInfo
.add(TmfStateValue
.nullValue());
135 stateValueTypes
.add((byte) -1);
137 if (backend
== null) {
138 ongoingStateStartTimes
.add(0L);
140 ongoingStateStartTimes
.add(backend
.getStartTime());
145 * Ask if the state information about attribute 'quark' at time 'time' is
146 * present in the Builder as it is right now. If it's not, it's either in
147 * the History Tree, or not in the system at all.
149 * Note that this method does not return the value itself (we don't even
150 * look for it, we can know by just looking at the timestamp)
153 * The timestamp to look for
155 * The quark of the attribute to look for
156 * @return True if the value is present in the Transient State at this
157 * moment in time, false if it's not
159 boolean hasInfoAboutStateOf(long time
, int quark
) {
160 return (this.isActive() && time
>= ongoingStateStartTimes
.get(quark
));
164 * This is the lower-level method that will be called by the
165 * StateHistorySystem (with already-built StateValues and timestamps)
168 * The index in the vectors (== the quark of the attribute)
170 * The new StateValue associated to this attribute
172 * The timestamp associated with this state change
173 * @throws TimeRangeException
174 * @throws AttributeNotFoundException
175 * @throws StateValueTypeException
177 synchronized void processStateChange(long eventTime
,
178 ITmfStateValue value
, int index
) throws TimeRangeException
,
179 AttributeNotFoundException
, StateValueTypeException
{
180 assert (this.isActive
);
182 byte expectedSvType
= stateValueTypes
.get(index
);
183 checkValidAttribute(index
);
186 * Make sure the state value type we're inserting is the same as the
187 * one registered for this attribute.
189 if (expectedSvType
== -1) {
191 * The value hasn't been used yet, set it to the value
192 * we're currently inserting (which might be null/-1 again).
194 stateValueTypes
.set(index
, value
.getType());
195 } else if ((value
.getType() != -1) && (value
.getType() != expectedSvType
)) {
197 * We authorize inserting null values in any type of attribute,
198 * but for every other types, it needs to match our expectations!
200 throw new StateValueTypeException();
203 /* Update the Transient State's lastestTime, if needed */
204 if (latestTime
< eventTime
) {
205 latestTime
= eventTime
;
208 if (ongoingStateInfo
.get(index
).equals(value
)) {
210 * This is the case where the new value and the one already present
211 * in the Builder are the same. We do not need to create an
212 * interval, we'll just keep the current one going.
217 if (backend
!= null && ongoingStateStartTimes
.get(index
) < eventTime
) {
219 * These two conditions are necessary to create an interval and
220 * update ongoingStateInfo.
222 backend
.insertPastState(ongoingStateStartTimes
.get(index
),
223 eventTime
- 1, /* End Time */
224 index
, /* attribute quark */
225 ongoingStateInfo
.get(index
)); /* StateValue */
227 ongoingStateStartTimes
.set(index
, eventTime
);
229 ongoingStateInfo
.set(index
, value
);
234 * Run a "get state at time" query on the Transient State only.
237 * The stateInfo object in which we will put our relevant
240 * The requested timestamp
242 void doQuery(List
<ITmfStateInterval
> stateInfo
, long t
) {
243 ITmfStateInterval interval
;
245 if (!this.isActive
) {
248 assert (stateInfo
.size() == ongoingStateInfo
.size());
250 for (int i
= 0; i
< ongoingStateInfo
.size(); i
++) {
252 * We build a dummy interval with end time = -1 to put in the answer
255 if (this.hasInfoAboutStateOf(t
, i
)) {
256 interval
= new TmfStateInterval(ongoingStateStartTimes
.get(i
), -1,
257 i
, ongoingStateInfo
.get(i
));
258 stateInfo
.set(i
, interval
);
264 * Close off the Transient State, used for example when we are done reading a
265 * static trace file. All the information currently contained in it will be
266 * converted to intervals and "flushed" to the State History.
268 void closeTransientState(long endTime
) {
269 assert (this.isActive
);
271 for (int i
= 0; i
< ongoingStateInfo
.size(); i
++) {
272 if (ongoingStateStartTimes
.get(i
) > endTime
) {
274 * Handle the cases where trace end > timestamp of last state
275 * change. This can happen when inserting "future" changes.
280 backend
.insertPastState(ongoingStateStartTimes
.get(i
),
281 endTime
, /* End Time */
282 i
, /* attribute quark */
283 ongoingStateInfo
.get(i
)); /* StateValue */
285 } catch (TimeRangeException e
) {
287 * This shouldn't happen, since we control where the interval's
288 * start time comes from
294 ongoingStateInfo
.clear();
295 ongoingStateStartTimes
.clear();
296 this.isActive
= false;
301 * Simply returns if this Transient State is currently being used or not
306 return this.isActive
;
314 * Debugging method that prints the contents of both 'ongoing...' vectors
318 void debugPrint(PrintWriter writer
) {
319 /* Only used for debugging, shouldn't be externalized */
320 writer
.println("------------------------------"); //$NON-NLS-1$
321 writer
.println("Info stored in the Builder:"); //$NON-NLS-1$
322 if (!this.isActive
) {
323 writer
.println("Builder is currently inactive"); //$NON-NLS-1$
324 writer
.println('\n');
327 writer
.println("\nAttribute\tStateValue\tValid since time"); //$NON-NLS-1$
328 for (int i
= 0; i
< ongoingStateInfo
.size(); i
++) {
329 writer
.format("%d\t\t", i
); //$NON-NLS-1$
330 writer
.print(ongoingStateInfo
.get(i
).toString() + "\t\t"); //$NON-NLS-1$
331 writer
.println(ongoingStateStartTimes
.get(i
).toString());
333 writer
.println('\n');