1 /**********************************************************************
2 * Copyright (c) 2012, 2014 Ericsson
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
10 * Bernd Hufmann - Initial API and implementation
11 * Bernd Hufmann - Updated for support of LTTng Tools 2.1
12 **********************************************************************/
13 package org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.impl
;
15 import java
.util
.ArrayList
;
16 import java
.util
.List
;
18 import org
.eclipse
.core
.commands
.ExecutionException
;
19 import org
.eclipse
.core
.runtime
.IProgressMonitor
;
20 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.IChannelInfo
;
21 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.IEventInfo
;
22 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.LogLevelType
;
23 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.TraceEnablement
;
24 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.TraceLogLevel
;
25 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.impl
.ChannelInfo
;
26 import org
.eclipse
.linuxtools
.internal
.lttng2
.core
.control
.model
.impl
.ProbeEventInfo
;
27 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.Activator
;
28 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.messages
.Messages
;
29 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.model
.ITraceControlComponent
;
30 import org
.eclipse
.linuxtools
.internal
.lttng2
.ui
.views
.control
.property
.TraceChannelPropertySource
;
31 import org
.eclipse
.swt
.graphics
.Image
;
32 import org
.eclipse
.ui
.views
.properties
.IPropertySource
;
37 * Implementation of the trace channel component.
40 * @author Bernd Hufmann
42 public class TraceChannelComponent
extends TraceControlComponent
{
44 // ------------------------------------------------------------------------
46 // ------------------------------------------------------------------------
49 * Path to icon file for this component (state enabled).
51 public static final String TRACE_CHANNEL_ICON_FILE_ENABLED
= "icons/obj16/channel.gif"; //$NON-NLS-1$
53 * Path to icon file for this component (state disabled).
55 public static final String TRACE_CHANNEL_ICON_FILE_DISABLED
= "icons/obj16/channel_disabled.gif"; //$NON-NLS-1$
57 // ------------------------------------------------------------------------
59 // ------------------------------------------------------------------------
62 * The channel information.
64 private IChannelInfo fChannelInfo
= null;
66 * The image to be displayed in disabled state.
68 private Image fDisabledImage
= null;
70 // ------------------------------------------------------------------------
72 // ------------------------------------------------------------------------
76 * @param name - the name of the component.
77 * @param parent - the parent of this component.
79 public TraceChannelComponent(String name
, ITraceControlComponent parent
) {
81 setImage(TRACE_CHANNEL_ICON_FILE_ENABLED
);
82 setToolTip(Messages
.TraceControl_ChannelDisplayName
);
83 fChannelInfo
= new ChannelInfo(name
);
84 fDisabledImage
= Activator
.getDefault().loadIcon(TRACE_CHANNEL_ICON_FILE_DISABLED
);
87 // ------------------------------------------------------------------------
89 // ------------------------------------------------------------------------
92 public Image
getImage() {
93 if (fChannelInfo
.getState() == TraceEnablement
.DISABLED
) {
94 return fDisabledImage
;
96 return super.getImage();
100 * Sets the channel information.
103 * The channel info to assign to this component
105 public void setChannelInfo(IChannelInfo channelInfo
) {
106 fChannelInfo
= channelInfo
;
107 IEventInfo
[] events
= fChannelInfo
.getEvents();
108 List
<ITraceControlComponent
> eventComponents
= new ArrayList
<>();
109 for (int i
= 0; i
< events
.length
; i
++) {
110 TraceEventComponent event
= null;
111 if (events
[i
].getClass() == ProbeEventInfo
.class) {
112 event
= new TraceProbeEventComponent(events
[i
].getName(), this);
114 event
= new TraceEventComponent(events
[i
].getName(), this);
117 eventComponents
.add(event
);
118 event
.setEventInfo(events
[i
]);
120 if (!eventComponents
.isEmpty()) {
121 setChildren(eventComponents
);
126 * @return the overwrite mode value.
128 public boolean isOverwriteMode() {
129 return fChannelInfo
.isOverwriteMode();
132 * Sets the overwrite mode value to the given mode.
133 * @param mode - mode to set.
135 public void setOverwriteMode(boolean mode
){
136 fChannelInfo
.setOverwriteMode(mode
);
139 * @return the sub-buffer size.
141 public long getSubBufferSize() {
142 return fChannelInfo
.getSubBufferSize();
145 * Sets the sub-buffer size to the given value.
146 * @param bufferSize - size to set to set.
148 public void setSubBufferSize(long bufferSize
) {
149 fChannelInfo
.setSubBufferSize(bufferSize
);
152 * @return the number of sub-buffers.
154 public int getNumberOfSubBuffers() {
155 return fChannelInfo
.getNumberOfSubBuffers();
158 * Sets the number of sub-buffers to the given value.
159 * @param numberOfSubBuffers - value to set.
161 public void setNumberOfSubBuffers(int numberOfSubBuffers
) {
162 fChannelInfo
.setNumberOfSubBuffers(numberOfSubBuffers
);
165 * @return the switch timer interval.
167 public long getSwitchTimer() {
168 return fChannelInfo
.getSwitchTimer();
171 * Sets the switch timer interval to the given value.
172 * @param timer - timer value to set.
174 public void setSwitchTimer(long timer
) {
175 fChannelInfo
.setSwitchTimer(timer
);
178 * @return the read timer interval.
180 public long getReadTimer() {
181 return fChannelInfo
.getReadTimer();
184 * Sets the read timer interval to the given value.
185 * @param timer - timer value to set..
187 public void setReadTimer(long timer
) {
188 fChannelInfo
.setReadTimer(timer
);
191 * @return the output type.
193 public String
getOutputType() {
194 return fChannelInfo
.getOutputType();
197 * Sets the output type to the given value.
198 * @param type - type to set.
200 public void setOutputType(String type
) {
201 fChannelInfo
.setOutputType(type
);
204 * @return the channel state (enabled or disabled).
206 public TraceEnablement
getState() {
207 return fChannelInfo
.getState();
210 * Sets the channel state (enablement) to the given value.
211 * @param state - state to set.
213 public void setState(TraceEnablement state
) {
214 fChannelInfo
.setState(state
);
217 * Sets the channel state (enablement) to the value specified by the given name.
218 * @param stateName - state to set.
220 public void setState(String stateName
) {
221 fChannelInfo
.setState(stateName
);
225 public Object
getAdapter(Class adapter
) {
226 if (adapter
== IPropertySource
.class) {
227 return new TraceChannelPropertySource(this);
233 * @return session name from parent
235 public String
getSessionName() {
236 return ((TraceDomainComponent
)getParent()).getSessionName();
240 * @return session from parent
242 public TraceSessionComponent
getSession() {
243 return ((TraceDomainComponent
)getParent()).getSession();
247 * @return if domain is kernel or UST
249 public boolean isKernel() {
250 return ((TraceDomainComponent
)getParent()).isKernel();
254 * @return the parent target node
256 public TargetNodeComponent
getTargetNode() {
257 return ((TraceDomainComponent
)getParent()).getTargetNode();
260 // ------------------------------------------------------------------------
262 // ------------------------------------------------------------------------
265 * Enables a list of events with no additional parameters.
268 * - a list of event names to enabled.
270 * - a progress monitor
271 * @throws ExecutionException
272 * If the command fails
274 public void enableEvents(List
<String
> eventNames
, IProgressMonitor monitor
) throws ExecutionException
{
275 enableEvents(eventNames
, null, monitor
);
279 * Enables a list of events with no additional parameters.
282 * - a list of event names to enabled.
283 * @param filterExpression
284 * - a filter expression
286 * - a progress monitor
287 * @throws ExecutionException
288 * If the command fails
290 public void enableEvents(List
<String
> eventNames
, String filterExpression
, IProgressMonitor monitor
) throws ExecutionException
{
291 getControlService().enableEvents(getSessionName(), getName(), eventNames
, isKernel(), filterExpression
, monitor
);
295 * Enables all syscalls (for kernel domain)
298 * - a progress monitor
299 * @throws ExecutionException
300 * If the command fails
302 public void enableSyscalls(IProgressMonitor monitor
) throws ExecutionException
{
303 getControlService().enableSyscalls(getSessionName(), getName(), monitor
);
307 * Enables a dynamic probe (for kernel domain)
310 * - event name for probe
312 * - true for dynamic function entry/return probe else false
316 * - a progress monitor
317 * @throws ExecutionException
318 * If the command fails
320 public void enableProbe(String eventName
, boolean isFunction
, String probe
,
321 IProgressMonitor monitor
) throws ExecutionException
{
322 getControlService().enableProbe(getSessionName(), getName(), eventName
, isFunction
, probe
, monitor
);
326 * Enables events using log level.
330 * @param logLevelType
334 * @param filterExpression
335 * - a filter expression
337 * - a progress monitor
338 * @throws ExecutionException
339 * If the command fails
341 public void enableLogLevel(String eventName
, LogLevelType logLevelType
,
342 TraceLogLevel level
, String filterExpression
, IProgressMonitor monitor
)
343 throws ExecutionException
{
344 getControlService().enableLogLevel(getSessionName(), getName(), eventName
, logLevelType
, level
, filterExpression
, monitor
);
348 * Enables a list of events with no additional parameters.
351 * - a list of event names to enabled.
353 * - a progress monitor
354 * @throws ExecutionException
355 * If the command fails
357 public void disableEvent(List
<String
> eventNames
, IProgressMonitor monitor
)
358 throws ExecutionException
{
359 getControlService().disableEvent(getParent().getParent().getName(),
360 getName(), eventNames
, isKernel(), monitor
);
364 * Add contexts to given channels and or events
367 * - a list of contexts to add
369 * - a progress monitor
370 * @throws ExecutionException
371 * If the command fails
373 public void addContexts(List
<String
> contexts
, IProgressMonitor monitor
)
374 throws ExecutionException
{
375 getControlService().addContexts(getSessionName(), getName(), null,
376 isKernel(), contexts
, monitor
);