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