ctf: Handle traces with unknown event attributes

[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.kernel.ui / src / org / eclipse / linuxtools / internal / lttng2 / kernel / ui / views / controlflow / ControlFlowEntry.java

/*******************************************************************************\r
 * Copyright (c) 2012 Ericsson\r
 *\r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 *\r
 * Contributors:\r
 *   Patrick Tasse - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.internal.lttng2.kernel.ui.views.controlflow;\r
\r
import java.util.ArrayList;\r
import java.util.Iterator;\r
import java.util.List;\r
\r
import org.eclipse.linuxtools.internal.lttng2.kernel.ui.views.common.EventIterator;\r
import org.eclipse.linuxtools.lttng2.kernel.core.trace.CtfKernelTrace;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeEvent;\r
import org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model.ITimeGraphEntry;\r
\r
/**\r
 * An entry in the Control Flow view\r
 */\r
public class ControlFlowEntry implements ITimeGraphEntry {\r
    private final int fThreadQuark;\r
    private final CtfKernelTrace fTrace;\r
    private ControlFlowEntry fParent = null;\r
    private final ArrayList<ControlFlowEntry> fChildren = new ArrayList<ControlFlowEntry>();\r
    private final String fName;\r
    private final int fThreadId;\r
    private final int fParentThreadId;\r
    private long fBirthTime = -1;\r
    private long fStartTime = -1;\r
    private long fEndTime = -1;\r
    private List<ITimeEvent> fEventList = new ArrayList<ITimeEvent>();\r
    private List<ITimeEvent> fZoomedEventList = null;\r
\r
    /**\r
     * Constructor\r
     *\r
     * @param threadQuark\r
     *            The attribute quark matching the thread\r
     * @param trace\r
     *            The trace on which we are working\r
     * @param execName\r
     *            The exec_name of this entry\r
     * @param threadId\r
     *            The TID of the thread\r
     * @param parentThreadId\r
     *            the Parent_TID of this thread\r
     * @param birthTime\r
     *            The birth time of this entry (this allows separating different\r
     *            process that could have the same TID)\r
     * @param startTime\r
     *            The start time of this process's lifetime\r
     * @param endTime\r
     *            The end time of this process\r
     */\r
    public ControlFlowEntry(int threadQuark, CtfKernelTrace trace, String execName, int threadId, int parentThreadId, long birthTime, long startTime, long endTime) {\r
        fThreadQuark = threadQuark;\r
        fTrace = trace;\r
        fName = execName;\r
        fThreadId = threadId;\r
        fParentThreadId = parentThreadId;\r
        fBirthTime = birthTime;\r
        fStartTime = startTime;\r
        fEndTime = endTime;\r
    }\r
\r
    @Override\r
    public ITimeGraphEntry getParent() {\r
        return fParent;\r
    }\r
\r
    @Override\r
    public boolean hasChildren() {\r
        return fChildren != null && fChildren.size() > 0;\r
    }\r
\r
    @Override\r
    public ControlFlowEntry[] getChildren() {\r
        return fChildren.toArray(new ControlFlowEntry[0]);\r
    }\r
\r
    @Override\r
    public String getName() {\r
        return fName;\r
    }\r
\r
    @Override\r
    public long getStartTime() {\r
        return fStartTime;\r
    }\r
\r
    @Override\r
    public long getEndTime() {\r
        return fEndTime;\r
    }\r
\r
    @Override\r
    public boolean hasTimeEvents() {\r
        return true;\r
    }\r
\r
    @Override\r
    public Iterator<ITimeEvent> getTimeEventsIterator() {\r
        return new EventIterator(fEventList, fZoomedEventList);\r
    }\r
\r
    @Override\r
    public Iterator<ITimeEvent> getTimeEventsIterator(long startTime, long stopTime, long visibleDuration) {\r
        return new EventIterator(fEventList, fZoomedEventList, startTime, stopTime);\r
    }\r
\r
    /**\r
     * Get the quark of the attribute matching this thread's TID\r
     *\r
     * @return The quark\r
     */\r
    public int getThreadQuark() {\r
        return fThreadQuark;\r
    }\r
\r
    /**\r
     * Get the CTF trace object\r
     *\r
     * @return The trace\r
     */\r
    public CtfKernelTrace getTrace() {\r
        return fTrace;\r
    }\r
\r
    /**\r
     * Get this entry's thread ID\r
     *\r
     * @return The TID\r
     */\r
    public int getThreadId() {\r
        return fThreadId;\r
    }\r
\r
    /**\r
     * Get this thread's parent TID\r
     *\r
     * @return The "PTID"\r
     */\r
    public int getParentThreadId() {\r
        return fParentThreadId;\r
    }\r
\r
    /**\r
     * Get the birth time of this entry/process\r
     *\r
     * @return The birth time\r
     */\r
    public long getBirthTime() {\r
        return fBirthTime;\r
    }\r
\r
    /**\r
     * Add an event to this process's timeline\r
     *\r
     * @param event\r
     *            The time event\r
     */\r
    public void addEvent(ITimeEvent event) {\r
        long start = event.getTime();\r
        long end = start + event.getDuration();\r
        synchronized (fEventList) {\r
            fEventList.add(event);\r
            if (fStartTime == -1 || start < fStartTime) {\r
                fStartTime = start;\r
            }\r
            if (fEndTime == -1 || end > fEndTime) {\r
                fEndTime = end;\r
            }\r
        }\r
    }\r
\r
    /**\r
     * Set the general event list of this entry\r
     *\r
     * @param eventList\r
     *            The list of time events\r
     */\r
    public void setEventList(List<ITimeEvent> eventList) {\r
        fEventList = eventList;\r
    }\r
\r
    /**\r
     * Set the zoomed event list of this entry\r
     *\r
     * @param eventList\r
     *            The list of time events\r
     */\r
    public void setZoomedEventList(List<ITimeEvent> eventList) {\r
        fZoomedEventList = eventList;\r
    }\r
\r
    /**\r
     * Add a child entry to this one (to show relationships between processes as\r
     * a tree)\r
     *\r
     * @param child\r
     *            The child entry\r
     */\r
    public void addChild(ControlFlowEntry child) {\r
        child.fParent = this;\r
        fChildren.add(child);\r
    }\r
}\r