tmf/org.eclipse.tracecompass.tmf.analysis.xml.core/src/org/eclipse/tracecompass/internal/tmf/analysis/xml/core/model/TmfXmlStateAttribute.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014, 2015 Ecole Polytechnique de Montreal
   3  *
   4  * All rights reserved. This program and the accompanying materials are
   5  * made available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *   Florian Wininger - Initial API and implementation
  11  ******************************************************************************/
  12
  13 package org.eclipse.tracecompass.internal.tmf.analysis.xml.core.model;
  14
  15 import static org.eclipse.tracecompass.common.core.NonNullUtils.checkNotNull;
  16 import static org.eclipse.tracecompass.common.core.NonNullUtils.nullToEmptyString;
  17
  18 import java.util.LinkedList;
  19 import java.util.List;
  20
  21 import org.eclipse.jdt.annotation.Nullable;
  22 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.Activator;
  23 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.module.IXmlStateSystemContainer;
  24 import org.eclipse.tracecompass.internal.tmf.analysis.xml.core.module.XmlUtils;
  25 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
  26 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystemBuilder;
  27 import org.eclipse.tracecompass.statesystem.core.exceptions.AttributeNotFoundException;
  28 import org.eclipse.tracecompass.statesystem.core.exceptions.StateValueTypeException;
  29 import org.eclipse.tracecompass.statesystem.core.statevalue.ITmfStateValue;
  30 import org.eclipse.tracecompass.statesystem.core.statevalue.TmfStateValue;
  31 import org.eclipse.tracecompass.tmf.analysis.xml.core.module.TmfXmlStrings;
  32 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  33 import org.eclipse.tracecompass.tmf.core.event.ITmfEventField;
  34 import org.eclipse.tracecompass.tmf.core.event.aspect.TmfCpuAspect;
  35 import org.eclipse.tracecompass.tmf.core.trace.TmfTraceUtils;
  36 import org.w3c.dom.Element;
  37
  38 /**
  39  * This Class implements a single attribute value in the XML-defined state
  40  * system.
  41  *
  42  * <pre>
  43  * Examples:
  44  * <stateAttribute type="constant" value="Threads" />
  45  * <stateAttribute type="query" />
  46  *      <stateAttribute type="constant" value="CPUs" />
  47  *      <stateAttribute type="eventField" value="cpu" />
  48  *      <stateAttribute type="constant" value="Current_thread" />
  49  * </attribute>
  50  * </pre>
  51  *
  52  * @author Florian Wininger
  53  */
  54 public abstract class TmfXmlStateAttribute implements ITmfXmlStateAttribute {
  55
  56     private enum StateAttributeType {
  57         NONE,
  58         CONSTANT,
  59         EVENTFIELD,
  60         QUERY,
  61         LOCATION,
  62         SELF,
  63         EVENTNAME
  64     }
  65
  66     private final String CURRENT_STATE = "#currentState"; //$NON-NLS-1$
  67
  68     private final String CURRENT_SCENARIO = "#CurrentScenario"; //$NON-NLS-1$
  69
  70     /** Type of attribute */
  71     private final StateAttributeType fType;
  72
  73     /** Attribute's name */
  74     private final @Nullable String fName;
  75
  76     /** List of attributes for a query */
  77     private final List<ITmfXmlStateAttribute> fQueryList = new LinkedList<>();
  78
  79     private final IXmlStateSystemContainer fContainer;
  80
  81     /**
  82      * Constructor
  83      *
  84      * @param modelFactory
  85      *            The factory used to create XML model elements
  86      * @param attribute
  87      *            XML element of the attribute
  88      * @param container
  89      *            The state system container this state attribute belongs to
  90      */
  91     protected TmfXmlStateAttribute(ITmfXmlModelFactory modelFactory, Element attribute, IXmlStateSystemContainer container) {
  92         fContainer = container;
  93
  94         switch (attribute.getAttribute(TmfXmlStrings.TYPE)) {
  95         case TmfXmlStrings.TYPE_CONSTANT:
  96             fType = StateAttributeType.CONSTANT;
  97             fName = getAttributeName(attribute);
  98             break;
  99         case TmfXmlStrings.EVENT_FIELD:
 100             fType = StateAttributeType.EVENTFIELD;
 101             fName = getAttributeName(attribute);
 102             break;
 103         case TmfXmlStrings.TYPE_LOCATION:
 104             fType = StateAttributeType.LOCATION;
 105             fName = getAttributeName(attribute);
 106             break;
 107         case TmfXmlStrings.TYPE_QUERY:
 108             List<@Nullable Element> childElements = XmlUtils.getChildElements(attribute);
 109             for (Element subAttributeNode : childElements) {
 110                 if (subAttributeNode == null) {
 111                     continue;
 112                 }
 113                 ITmfXmlStateAttribute subAttribute = modelFactory.createStateAttribute(subAttributeNode, fContainer);
 114                 fQueryList.add(subAttribute);
 115             }
 116             fType = StateAttributeType.QUERY;
 117             fName = null;
 118             break;
 119         case TmfXmlStrings.TYPE_EVENT_NAME:
 120             fType = StateAttributeType.EVENTNAME;
 121             fName = getAttributeName(attribute);
 122             break;
 123         case TmfXmlStrings.NULL:
 124             fType = StateAttributeType.NONE;
 125             fName = null;
 126             break;
 127         case TmfXmlStrings.TYPE_SELF:
 128             fType = StateAttributeType.SELF;
 129             fName = null;
 130             break;
 131         default:
 132             throw new IllegalArgumentException("TmfXmlStateAttribute constructor: The XML element is not of the right type"); //$NON-NLS-1$
 133         }
 134     }
 135
 136     private String getAttributeName(Element attribute) {
 137         return fContainer.getAttributeValue(attribute.getAttribute(TmfXmlStrings.VALUE)).intern();
 138     }
 139
 140     @Override
 141     public int getAttributeQuark(int startQuark, @Nullable TmfXmlScenarioInfo scenarioInfo) {
 142         return getAttributeQuark(null, startQuark, scenarioInfo);
 143     }
 144
 145     /**
 146      * Basic quark-retrieving method. Pass an attribute in parameter as an array
 147      * of strings, the matching quark will be returned. If the attribute does
 148      * not exist, it will add the quark to the state system if the context
 149      * allows it.
 150      *
 151      * See {@link ITmfStateSystemBuilder#getQuarkAbsoluteAndAdd(String...)}
 152      *
 153      * @param path
 154      *            Full path to the attribute
 155      * @return The quark for this attribute
 156      * @throws AttributeNotFoundException
 157      *             The attribute does not exist and cannot be added
 158      */
 159     protected abstract int getQuarkAbsoluteAndAdd(String... path) throws AttributeNotFoundException;
 160
 161     /**
 162      * Quark-retrieving method, but the attribute is queried starting from the
 163      * startNodeQuark. If the attribute does not exist, it will add it to the
 164      * state system if the context allows it.
 165      *
 166      * See {@link ITmfStateSystemBuilder#getQuarkRelativeAndAdd(int, String...)}
 167      *
 168      * @param startNodeQuark
 169      *            The quark of the attribute from which 'path' originates.
 170      * @param path
 171      *            Relative path to the attribute
 172      * @return The quark for this attribute
 173      * @throws AttributeNotFoundException
 174      *             The attribute does not exist and cannot be added
 175      */
 176     protected abstract int getQuarkRelativeAndAdd(int startNodeQuark, String... path) throws AttributeNotFoundException;
 177
 178     /**
 179      * Get the state system associated with this attribute's container
 180      *
 181      * @return The state system associated with this state attribute
 182      */
 183     protected @Nullable ITmfStateSystem getStateSystem() {
 184         return fContainer.getStateSystem();
 185     }
 186
 187     @Override
 188     public int getAttributeQuark(@Nullable ITmfEvent event, int startQuark, @Nullable TmfXmlScenarioInfo scenarioInfo) {
 189         ITmfStateSystem ss = getStateSystem();
 190         if (ss == null) {
 191             throw new IllegalStateException("The state system hasn't been initialized yet"); //$NON-NLS-1$
 192         }
 193         String name = nullToEmptyString(fName);
 194         if (name.length() > 0 && name.charAt(0) == '#' && scenarioInfo == null) {
 195             throw new IllegalStateException("XML Attribute needs " + fName + " but the data is not available.");  //$NON-NLS-1$//$NON-NLS-2$
 196         }
 197         name = name.equals(CURRENT_STATE) ? checkNotNull(scenarioInfo).getActiveState()
 198                         : fName;
 199
 200         try {
 201             switch (fType) {
 202             case CONSTANT: {
 203                 int quark;
 204                 if (name == null) {
 205                     throw new IllegalStateException("Invalid attribute name"); //$NON-NLS-1$
 206                 }
 207                 if (name.equals(CURRENT_SCENARIO)) {
 208                     return checkNotNull(scenarioInfo).getQuark();
 209                 }
 210                 if (startQuark == IXmlStateSystemContainer.ROOT_QUARK) {
 211                     quark = getQuarkAbsoluteAndAdd(name);
 212                 } else {
 213                     quark = getQuarkRelativeAndAdd(startQuark, name);
 214                 }
 215                 return quark;
 216             }
 217             case EVENTFIELD: {
 218                 int quark = IXmlStateSystemContainer.ERROR_QUARK;
 219                 if (event == null) {
 220                     Activator.logWarning("XML State attribute: looking for an event field, but event is null"); //$NON-NLS-1$
 221                     return quark;
 222                 }
 223                 if (name == null) {
 224                     throw new IllegalStateException("Invalid attribute name"); //$NON-NLS-1$
 225                 }
 226
 227                 Object fieldValue = null;
 228                 /* First, look for a field with the given name */
 229                 ITmfEventField field = event.getContent().getField(name);
 230                 /* Field not found, see if it is a special case field */
 231                 if (field == null) {
 232                     if (name.equalsIgnoreCase(TmfXmlStrings.CPU)) {
 233                         /* See if the event advertises a CPU aspect */
 234                         Integer cpu = TmfTraceUtils.resolveIntEventAspectOfClassForEvent(
 235                                 event.getTrace(), TmfCpuAspect.class, event);
 236                         if (cpu != null) {
 237                             return getQuarkRelativeAndAdd(startQuark, cpu.toString());
 238                         }
 239                         return IXmlStateSystemContainer.ERROR_QUARK;
 240                     }
 241                     /* Search between the trace event aspects */
 242                     fieldValue = TmfTraceUtils.resolveAspectOfNameForEvent(event.getTrace(), name, event);
 243                 } else {
 244                     fieldValue = field.getValue();
 245                 }
 246
 247                 if (fieldValue instanceof String) {
 248                     String fieldString = (String) fieldValue;
 249                     quark = getQuarkRelativeAndAdd(startQuark, fieldString);
 250                 } else if (fieldValue instanceof Long) {
 251                     Long fieldLong = (Long) fieldValue;
 252                     quark = getQuarkRelativeAndAdd(startQuark, fieldLong.toString());
 253                 } else if (fieldValue instanceof Integer) {
 254                     Integer fieldInterger = (Integer) fieldValue;
 255                     quark = getQuarkRelativeAndAdd(startQuark, fieldInterger.toString());
 256                 }
 257
 258                 return quark;
 259             }
 260             case QUERY: {
 261                 int quark;
 262                 ITmfStateValue value = TmfStateValue.nullValue();
 263                 int quarkQuery = IXmlStateSystemContainer.ROOT_QUARK;
 264
 265                 for (ITmfXmlStateAttribute attrib : fQueryList) {
 266                     quarkQuery = attrib.getAttributeQuark(event, quarkQuery, scenarioInfo);
 267                     if (quarkQuery == IXmlStateSystemContainer.ERROR_QUARK) {
 268                         break;
 269                     }
 270                 }
 271
 272                 // the query may fail: for example CurrentThread if there
 273                 // has not been a sched_switch event
 274                 if (quarkQuery != IXmlStateSystemContainer.ERROR_QUARK) {
 275                     value = ss.queryOngoingState(quarkQuery);
 276                 }
 277
 278                 switch (value.getType()) {
 279                 case INTEGER: {
 280                     int result = value.unboxInt();
 281                     quark = getQuarkRelativeAndAdd(startQuark, String.valueOf(result));
 282                     break;
 283                 }
 284                 case LONG: {
 285                     long result = value.unboxLong();
 286                     quark = getQuarkRelativeAndAdd(startQuark, String.valueOf(result));
 287                     break;
 288                 }
 289                 case STRING: {
 290                     String result = value.unboxStr();
 291                     quark = getQuarkRelativeAndAdd(startQuark, result);
 292                     break;
 293                 }
 294                 case DOUBLE:
 295                 case NULL:
 296                 case CUSTOM:
 297                 default:
 298                     quark = IXmlStateSystemContainer.ERROR_QUARK; // error
 299                     break;
 300                 }
 301                 return quark;
 302             }
 303             case LOCATION: {
 304                 int quark = startQuark;
 305                 String idLocation = name;
 306
 307                 /* TODO: Add a fContainer.getLocation(id) method */
 308                 for (TmfXmlLocation location : fContainer.getLocations()) {
 309                     if (location.getId().equals(idLocation)) {
 310                         quark = location.getLocationQuark(event, quark, scenarioInfo);
 311                         if (quark == IXmlStateSystemContainer.ERROR_QUARK) {
 312                             break;
 313                         }
 314                     }
 315                 }
 316                 return quark;
 317             }
 318             case EVENTNAME: {
 319                 int quark = IXmlStateSystemContainer.ERROR_QUARK;
 320                 if (event == null) {
 321                     Activator.logWarning("XML State attribute: looking for an eventname, but event is null"); //$NON-NLS-1$
 322                     return quark;
 323                 }
 324                 quark = getQuarkRelativeAndAdd(startQuark, event.getName());
 325                 return quark;
 326             }
 327             case SELF:
 328                 return startQuark;
 329             case NONE:
 330             default:
 331                 return startQuark;
 332             }
 333         } catch (AttributeNotFoundException ae) {
 334             /*
 335              * This can be happen before the creation of the node for a query in
 336              * the state system. Example : current thread before a sched_switch
 337              */
 338             return IXmlStateSystemContainer.ERROR_QUARK;
 339         } catch (StateValueTypeException e) {
 340             /*
 341              * This would happen if we were trying to push/pop attributes not of
 342              * type integer. Which, once again, should never happen.
 343              */
 344             Activator.logError("StateValueTypeException", e); //$NON-NLS-1$
 345             return IXmlStateSystemContainer.ERROR_QUARK;
 346         }
 347     }
 348
 349     @Override
 350     public String toString() {
 351         return "TmfXmlStateAttribute " + fType + ": " + fName; //$NON-NLS-1$ //$NON-NLS-2$
 352     }
 353
 354 }