[deliverable/tracecompass.git] / org.eclipse.linuxtools.lttng2.ui / src / org / eclipse / linuxtools / internal / lttng2 / ui / views / control / service / ILttngControlService.java

/**********************************************************************
 * Copyright (c) 2012 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Bernd Hufmann - Initial API and implementation
 **********************************************************************/
package org.eclipse.linuxtools.internal.lttng2.ui.views.control.service;

import java.util.List;

import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.linuxtools.internal.lttng2.core.control.model.IBaseEventInfo;
import org.eclipse.linuxtools.internal.lttng2.core.control.model.IChannelInfo;
import org.eclipse.linuxtools.internal.lttng2.core.control.model.ISessionInfo;
import org.eclipse.linuxtools.internal.lttng2.core.control.model.IUstProviderInfo;
import org.eclipse.linuxtools.internal.lttng2.core.control.model.LogLevelType;
import org.eclipse.linuxtools.internal.lttng2.core.control.model.TraceLogLevel;


/**
* <p>
* Interface for LTTng trace control command service.
* </p>
*
* @author Bernd Hufmann
*/
public interface ILttngControlService {

    /**
     * @return the version string.
     */
    public String getVersion();

    /**
     * Retrieves the existing sessions names from the node.
     *
     * @param monitor
     *            - a progress monitor
     * @return an array with session names.
     * @throws ExecutionException
     *             If the command fails
     */
    public String[] getSessionNames(IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Retrieves the session information with the given name the node.
     *
     * @param sessionName
     *            - the session name
     * @param monitor
     *            - a progress monitor
     * @return session information
     * @throws ExecutionException
     *             If the command fails
     */
    public ISessionInfo getSession(String sessionName, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Retrieves the kernel provider information (i.e. the kernel events)
     *
     * @param monitor
     *            - a progress monitor
     * @return the list of existing kernel events.
     * @throws ExecutionException
     *             If the command fails
     */
    public List<IBaseEventInfo> getKernelProvider(IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Retrieves the UST provider information from the node.
     *
     * @return - the UST provider information.
     * @throws ExecutionException
     *             If the command fails
     */
    public List<IUstProviderInfo> getUstProvider() throws ExecutionException;

    /**
     * Retrieves the UST provider information from the node.
     *
     * @param monitor
     *            - a progress monitor
     * @return the UST provider information.
     * @throws ExecutionException
     *             If the command fails
     */
    public List<IUstProviderInfo> getUstProvider(IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Creates a session with given session name and location.
     *
     * @param sessionName
     *            - a session name to create
     * @param sessionPath
     *            - a path for storing the traces (use null for default)
     * @param monitor
     *            - a progress monitor
     * @return the session information
     * @throws ExecutionException
     *             If the command fails
     */
    public ISessionInfo createSession(String sessionName, String sessionPath,
            IProgressMonitor monitor) throws ExecutionException;

    /**
     * Destroys a session with given session name.
     *
     * @param sessionName
     *            - a session name to destroy
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void destroySession(String sessionName, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Starts a session with given session name.
     *
     * @param sessionName
     *            - a session name to start
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void startSession(String sessionName, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Stops a session with given session name.
     *
     * @param sessionName
     *            - a session name to stop
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void stopSession(String sessionName, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Enables a list of channels for given session and given channel
     * information (configuration).
     *
     * @param sessionName
     *            - a session name to create
     * @param channelNames
     *            - a list of channel names to be enabled
     * @param isKernel
     *            - a flag to indicate Kernel or UST (true for Kernel, false for
     *            UST)
     * @param info
     *            - channel information used for creation of a channel (or null
     *            for default)
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void enableChannels(String sessionName, List<String> channelNames,
            boolean isKernel, IChannelInfo info, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Disables a list of channels for given session and given channel
     * information (configuration).
     *
     * @param sessionName
     *            - a session name to create
     * @param channelNames
     *            - a list of channel names to be enabled
     * @param isKernel
     *            - a flag to indicate Kernel or UST (true for Kernel, false for
     *            UST)
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void disableChannels(String sessionName, List<String> channelNames,
            boolean isKernel, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Enables a list of events with no additional parameters.
     *
     * @param sessionName
     *            - a session name
     * @param channelName
     *            - a channel name or null for default channel
     * @param eventNames
     *            - a list of event names to be enabled, or null (list of size =
     *            0)for all events .
     * @param isKernel
     *            - a flag for indicating kernel or UST.
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void enableEvents(String sessionName, String channelName,
            List<String> eventNames, boolean isKernel, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Enables all syscall events.
     *
     * @param sessionName
     *            - a session name
     * @param channelName
     *            - a channel name or null for default channel
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void enableSyscalls(String sessionName, String channelName,
            IProgressMonitor monitor) throws ExecutionException;

    /**
     * Enables a dynamic probe or dynamic function entry/return probe.
     *
     * @param sessionName
     *            - a session name
     * @param channelName
     *            - a channel name or null for default channel
     * @param eventName
     *            - a event name
     * @param isFunction
     *            - true for dynamic function entry/return probe else false
     * @param probe
     *            - a dynamic probe information
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void enableProbe(String sessionName, String channelName,
            String eventName, boolean isFunction, String probe,
            IProgressMonitor monitor) throws ExecutionException;

    /**
     * Enables events using log level
     *
     * @param sessionName
     *            - a session name
     * @param channelName
     *            - a channel name (null for default channel)
     * @param eventName
     *            - a event name
     * @param logLevelType
     *            - a log level type
     * @param level
     *            - a log level
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void enableLogLevel(String sessionName, String channelName,
            String eventName, LogLevelType logLevelType, TraceLogLevel level,
            IProgressMonitor monitor) throws ExecutionException;

    /**
     * Disables a list of events with no additional parameters.
     *
     * @param sessionName
     *            - a session name
     * @param channelName
     *            - a channel name (null for default channel)
     * @param eventNames
     *            - a list of event names to enabled.
     * @param isKernel
     *            - a flag for indicating kernel or UST.
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void disableEvent(String sessionName, String channelName,
            List<String> eventNames, boolean isKernel, IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Gets all available context names to be added to channels/events.
     *
     * @param monitor
     *            The progress monitor
     * @return the list of available contexts
     * @throws ExecutionException
     *             If the command fails
     */
    public List<String> getContextList(IProgressMonitor monitor)
            throws ExecutionException;

    /**
     * Add contexts to given channels and or events
     *
     * @param sessionName
     *            - a session name
     * @param channelName
     *            - a channel name (null for all channels)
     * @param eventName
     *            - a event name (null for all events)
     * @param isKernel
     *            - a flag for indicating kernel or UST.
     * @param contexts
     *            - a list of name of contexts to add
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void addContexts(String sessionName, String channelName,
            String eventName, boolean isKernel, List<String> contexts,
            IProgressMonitor monitor) throws ExecutionException;

    /**
     * Executes calibrate command to quantify LTTng overhead.
     *
     * @param isKernel
     *            - a flag for indicating kernel or UST.
     * @param monitor
     *            - a progress monitor
     * @throws ExecutionException
     *             If the command fails
     */
    public void calibrate(boolean isKernel, IProgressMonitor monitor)
            throws ExecutionException;
}
Commit	Line	Data
	1	/**********************************************************************
	2	* Copyright (c) 2012 Ericsson
	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	* Bernd Hufmann - Initial API and implementation
	11	**********************************************************************/
	12	package org.eclipse.linuxtools.internal.lttng2.ui.views.control.service;
	13
	14	import java.util.List;
	15
	16	import org.eclipse.core.commands.ExecutionException;
	17	import org.eclipse.core.runtime.IProgressMonitor;
	18	import org.eclipse.linuxtools.internal.lttng2.core.control.model.IBaseEventInfo;
	19	import org.eclipse.linuxtools.internal.lttng2.core.control.model.IChannelInfo;
	20	import org.eclipse.linuxtools.internal.lttng2.core.control.model.ISessionInfo;
	21	import org.eclipse.linuxtools.internal.lttng2.core.control.model.IUstProviderInfo;
	22	import org.eclipse.linuxtools.internal.lttng2.core.control.model.LogLevelType;
	23	import org.eclipse.linuxtools.internal.lttng2.core.control.model.TraceLogLevel;
	24
	25
	26	/**
	27	* <p>
	28	* Interface for LTTng trace control command service.
	29	* </p>
	30	*
	31	* @author Bernd Hufmann
	32	*/
	33	public interface ILttngControlService {
	34
	35	/**
	36	* @return the version string.
	37	*/
	38	public String getVersion();
	39
	40	/**
	41	* Retrieves the existing sessions names from the node.
	42	*
	43	* @param monitor
	44	* - a progress monitor
	45	* @return an array with session names.
	46	* @throws ExecutionException
	47	* If the command fails
	48	*/
	49	public String[] getSessionNames(IProgressMonitor monitor)
	50	throws ExecutionException;
	51
	52	/**
	53	* Retrieves the session information with the given name the node.
	54	*
	55	* @param sessionName
	56	* - the session name
	57	* @param monitor
	58	* - a progress monitor
	59	* @return session information
	60	* @throws ExecutionException
	61	* If the command fails
	62	*/
	63	public ISessionInfo getSession(String sessionName, IProgressMonitor monitor)
	64	throws ExecutionException;
	65
	66	/**
	67	* Retrieves the kernel provider information (i.e. the kernel events)
	68	*
	69	* @param monitor
	70	* - a progress monitor
	71	* @return the list of existing kernel events.
	72	* @throws ExecutionException
	73	* If the command fails
	74	*/
	75	public List<IBaseEventInfo> getKernelProvider(IProgressMonitor monitor)
	76	throws ExecutionException;
	77
	78	/**
	79	* Retrieves the UST provider information from the node.
	80	*
	81	* @return - the UST provider information.
	82	* @throws ExecutionException
	83	* If the command fails
	84	*/
	85	public List<IUstProviderInfo> getUstProvider() throws ExecutionException;
	86
	87	/**
	88	* Retrieves the UST provider information from the node.
	89	*
	90	* @param monitor
	91	* - a progress monitor
	92	* @return the UST provider information.
	93	* @throws ExecutionException
	94	* If the command fails
	95	*/
	96	public List<IUstProviderInfo> getUstProvider(IProgressMonitor monitor)
	97	throws ExecutionException;
	98
	99	/**
	100	* Creates a session with given session name and location.
	101	*
	102	* @param sessionName
	103	* - a session name to create
	104	* @param sessionPath
	105	* - a path for storing the traces (use null for default)
	106	* @param monitor
	107	* - a progress monitor
	108	* @return the session information
	109	* @throws ExecutionException
	110	* If the command fails
	111	*/
	112	public ISessionInfo createSession(String sessionName, String sessionPath,
	113	IProgressMonitor monitor) throws ExecutionException;
	114
	115	/**
	116	* Destroys a session with given session name.
	117	*
	118	* @param sessionName
	119	* - a session name to destroy
	120	* @param monitor
	121	* - a progress monitor
	122	* @throws ExecutionException
	123	* If the command fails
	124	*/
	125	public void destroySession(String sessionName, IProgressMonitor monitor)
	126	throws ExecutionException;
	127
	128	/**
	129	* Starts a session with given session name.
	130	*
	131	* @param sessionName
	132	* - a session name to start
	133	* @param monitor
	134	* - a progress monitor
	135	* @throws ExecutionException
	136	* If the command fails
	137	*/
	138	public void startSession(String sessionName, IProgressMonitor monitor)
	139	throws ExecutionException;
	140
	141	/**
	142	* Stops a session with given session name.
	143	*
	144	* @param sessionName
	145	* - a session name to stop
	146	* @param monitor
	147	* - a progress monitor
	148	* @throws ExecutionException
	149	* If the command fails
	150	*/
	151	public void stopSession(String sessionName, IProgressMonitor monitor)
	152	throws ExecutionException;
	153
	154	/**
	155	* Enables a list of channels for given session and given channel
	156	* information (configuration).
	157	*
	158	* @param sessionName
	159	* - a session name to create
	160	* @param channelNames
	161	* - a list of channel names to be enabled
	162	* @param isKernel
	163	* - a flag to indicate Kernel or UST (true for Kernel, false for
	164	* UST)
	165	* @param info
	166	* - channel information used for creation of a channel (or null
	167	* for default)
	168	* @param monitor
	169	* - a progress monitor
	170	* @throws ExecutionException
	171	* If the command fails
	172	*/
	173	public void enableChannels(String sessionName, List<String> channelNames,
	174	boolean isKernel, IChannelInfo info, IProgressMonitor monitor)
	175	throws ExecutionException;
	176
	177	/**
	178	* Disables a list of channels for given session and given channel
	179	* information (configuration).
	180	*
	181	* @param sessionName
	182	* - a session name to create
	183	* @param channelNames
	184	* - a list of channel names to be enabled
	185	* @param isKernel
	186	* - a flag to indicate Kernel or UST (true for Kernel, false for
	187	* UST)
	188	* @param monitor
	189	* - a progress monitor
	190	* @throws ExecutionException
	191	* If the command fails
	192	*/
	193	public void disableChannels(String sessionName, List<String> channelNames,
	194	boolean isKernel, IProgressMonitor monitor)
	195	throws ExecutionException;
	196
	197	/**
	198	* Enables a list of events with no additional parameters.
	199	*
	200	* @param sessionName
	201	* - a session name
	202	* @param channelName
	203	* - a channel name or null for default channel
	204	* @param eventNames
	205	* - a list of event names to be enabled, or null (list of size =
	206	* 0)for all events .
	207	* @param isKernel
	208	* - a flag for indicating kernel or UST.
	209	* @param monitor
	210	* - a progress monitor
	211	* @throws ExecutionException
	212	* If the command fails
	213	*/
	214	public void enableEvents(String sessionName, String channelName,
	215	List<String> eventNames, boolean isKernel, IProgressMonitor monitor)
	216	throws ExecutionException;
	217
	218	/**
	219	* Enables all syscall events.
	220	*
	221	* @param sessionName
	222	* - a session name
	223	* @param channelName
	224	* - a channel name or null for default channel
	225	* @param monitor
	226	* - a progress monitor
	227	* @throws ExecutionException
	228	* If the command fails
	229	*/
	230	public void enableSyscalls(String sessionName, String channelName,
	231	IProgressMonitor monitor) throws ExecutionException;
	232
	233	/**
	234	* Enables a dynamic probe or dynamic function entry/return probe.
	235	*
	236	* @param sessionName
	237	* - a session name
	238	* @param channelName
	239	* - a channel name or null for default channel
	240	* @param eventName
	241	* - a event name
	242	* @param isFunction
	243	* - true for dynamic function entry/return probe else false
	244	* @param probe
	245	* - a dynamic probe information
	246	* @param monitor
	247	* - a progress monitor
	248	* @throws ExecutionException
	249	* If the command fails
	250	*/
	251	public void enableProbe(String sessionName, String channelName,
	252	String eventName, boolean isFunction, String probe,
	253	IProgressMonitor monitor) throws ExecutionException;
	254
	255	/**
	256	* Enables events using log level
	257	*
	258	* @param sessionName
	259	* - a session name
	260	* @param channelName
	261	* - a channel name (null for default channel)
	262	* @param eventName
	263	* - a event name
	264	* @param logLevelType
	265	* - a log level type
	266	* @param level
	267	* - a log level
	268	* @param monitor
	269	* - a progress monitor
	270	* @throws ExecutionException
	271	* If the command fails
	272	*/
	273	public void enableLogLevel(String sessionName, String channelName,
	274	String eventName, LogLevelType logLevelType, TraceLogLevel level,
	275	IProgressMonitor monitor) throws ExecutionException;
	276
	277	/**
	278	* Disables a list of events with no additional parameters.
	279	*
	280	* @param sessionName
	281	* - a session name
	282	* @param channelName
	283	* - a channel name (null for default channel)
	284	* @param eventNames
	285	* - a list of event names to enabled.
	286	* @param isKernel
	287	* - a flag for indicating kernel or UST.
	288	* @param monitor
	289	* - a progress monitor
	290	* @throws ExecutionException
	291	* If the command fails
	292	*/
	293	public void disableEvent(String sessionName, String channelName,
	294	List<String> eventNames, boolean isKernel, IProgressMonitor monitor)
	295	throws ExecutionException;
	296
	297	/**
	298	* Gets all available context names to be added to channels/events.
	299	*
	300	* @param monitor
	301	* The progress monitor
	302	* @return the list of available contexts
	303	* @throws ExecutionException
	304	* If the command fails
	305	*/
	306	public List<String> getContextList(IProgressMonitor monitor)
	307	throws ExecutionException;
	308
	309	/**
	310	* Add contexts to given channels and or events
	311	*
	312	* @param sessionName
	313	* - a session name
	314	* @param channelName
	315	* - a channel name (null for all channels)
	316	* @param eventName
	317	* - a event name (null for all events)
	318	* @param isKernel
	319	* - a flag for indicating kernel or UST.
	320	* @param contexts
	321	* - a list of name of contexts to add
	322	* @param monitor
	323	* - a progress monitor
	324	* @throws ExecutionException
	325	* If the command fails
	326	*/
	327	public void addContexts(String sessionName, String channelName,
	328	String eventName, boolean isKernel, List<String> contexts,
	329	IProgressMonitor monitor) throws ExecutionException;
	330
	331	/**
	332	* Executes calibrate command to quantify LTTng overhead.
	333	*
	334	* @param isKernel
	335	* - a flag for indicating kernel or UST.
	336	* @param monitor
	337	* - a progress monitor
	338	* @throws ExecutionException
	339	* If the command fails
	340	*/
	341	public void calibrate(boolean isKernel, IProgressMonitor monitor)
	342	throws ExecutionException;
	343	}