1 /*******************************************************************************
2 * Copyright (c) 2010 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 *******************************************************************************/
13 package org
.eclipse
.linuxtools
.lttng
.core
;
16 * <b><u>LttngConstants</u></b>
18 * Declaration of LTTng specific constants.
21 @SuppressWarnings("nls")
22 public class LttngConstants
{
25 * <h4>Number of bits of an integer to be used for statistic node identifier. </h4>
27 public static final int STATS_ID_SHIFT
= 28;
29 * <h4>Maximum number of trace ids to be created, before wrapping around to 0. </h4>
30 * Note that there is a tight coupling to STATS_ID_SHIFT, because the trace id is
31 * also used for statistics node identification.
33 public static final int MAX_NUMBER_OF_TRACES_ID
= (1 << STATS_ID_SHIFT
) - 1;
34 public static final int STATS_ID_MASK
= MAX_NUMBER_OF_TRACES_ID
;
37 * <h4>Statistic node identifier for unknown/none kernel submode. </h4>
39 public static final int STATS_NONE_ID
= 0x1 << STATS_ID_SHIFT
;
41 * <h4>Statistic node identifier for IRQ kernel submodes. </h4>
43 public static final int STATS_IRQ_NAME_ID
= 0x2 << STATS_ID_SHIFT
;
45 * <h4>Statistic node identifier for soft IRQ kernel submodes. </h4>
47 public static final int STATS_SOFT_IRQ_NAME_ID
= 0x3 << STATS_ID_SHIFT
;
49 * <h4>Statistic node identifier for sys_call kernel submodes.</h4>
51 public static final int STATS_SYS_CALL_NAME_ID
= 0x4 << STATS_ID_SHIFT
;
53 * <h4>Statistic node identifier for trab kernel submodes. </h4>
55 public static final int STATS_TRAP_NAME_ID
= 0x5 << STATS_ID_SHIFT
;
57 * <h4>Statistic node identifier for the trace. </h4>
59 public static final int STATS_TRACE_NAME_ID
= 0x6 << STATS_ID_SHIFT
;
61 * <h4>Statistic node identifier for the CPU IDs. </h4>
63 public static final int STATS_CPU_ID
= 0x7 << STATS_ID_SHIFT
;
65 * <h4>Statistic node identifier for the kernel modes. </h4>
67 public static final int STATS_MODE_ID
= 0x8 << STATS_ID_SHIFT
;
69 * <h4>Statistic node identifier for the kernel function IDs. </h4>
71 public static final int STATS_FUNCTION_ID
= 0x9 << STATS_ID_SHIFT
;
73 * <h4>Statistic node identifier for the process IDs. </h4>
75 public static final int STATS_PROCESS_ID
= 0xA << STATS_ID_SHIFT
;
77 * <h4>Statistic node identifier for the event types. </h4>
79 public static final int STATS_TYPE_ID
= 0xB << STATS_ID_SHIFT
;
81 * <h4>Statistic node identifier for the event types. </h4>
83 public static final int STATS_CATEGORY_ID
= 0xC << STATS_ID_SHIFT
;
85 * <h4>Background requests block size </h4>
87 public static final int DEFAULT_BLOCK_SIZE
= 50000;
90 * LTTng Trace Control Constants
94 * <h4>Kernel Provider name.</h4>
96 public static final String Lttng_Provider_Kernel
= "kernel";
98 * <h4>UST provider name.</h4>
100 public static final String Lttng_Provider_Ust
= "ust";
102 * <h4>LTTng trace control command name.</h4>
104 public static final String Lttng_Control_Command
= "ltt_control";
106 * <h4>LTTng trace control command to get providers.</h4>
108 public static final String Lttng_Control_GetProviders
= "getProviders";
110 * <h4>LTTng trace control command to get targets.</h4>
112 public static final String Lttng_Control_GetTargets
= "getTargets";
114 * <h4>LTTng trace control command to get markers.</h4>
116 public static final String Lttng_Control_GetMarkers
= "getMarkers";
118 * <h4>LTTng trace control command to get traces.</h4>
120 public static final String Lttng_Control_GetTraces
= "getTraces";
122 * <h4>LTTng trace control command to get active traces.</h4>
124 public static final String Lttng_Control_GetActiveTraces
= "getActiveTraces";
126 * <h4>LTTng trace control command to get information about a active trace.</h4>
128 public static final String Lttng_Control_GetActiveTraceInfo
= "getActiveTraceInfo";
130 * <h4>LTTng trace control command get all available channels.</h4>
132 public static final String Lttng_Control_GetChannels
= "getChannels";
134 * <h4>LTTng trace control command to setup a trace.</h4>
136 public static final String Lttng_Control_SetupTrace
= "setupTrace";
138 * <h4>LTTng trace control command to set the trace transport.</h4>
140 public static final String Lttng_Control_SetupTraceTransport
= "setTraceTransport";
142 * <h4>LTTng trace control command to get information about a marker.</h4>
144 public static final String Lttng_Control_GetMarkerInfo
= "getMarkerInfo";
146 * <h4>LTTng trace control command to enable/disable a marker.</h4>
148 public static final String Lttng_Control_SetMarkerEnable
= "setMarkerEnable";
150 * <h4>LTTng trace control command to enable/disable a channel.</h4>
152 public static final String Lttng_Control_SetChannelEnable
= "setChannelEnable";
154 * <h4>LTTng trace control command to enable/disable channel buffer overwrite.</h4>
156 public static final String Lttng_Control_SetChannelOverwrite
= "setChannelOverwrite";
158 * <h4>LTTng trace control command to the channel timer.</h4>
160 public static final String Lttng_Control_SetChannelTimer
= "setChannelTimer";
162 * <h4>LTTng trace control command to set the number of sub-buffers of a channel.</h4>
164 public static final String Lttng_Control_SetChannelSubbufNum
= "setChannelSubbufNum";
166 * <h4>LTTng trace control command to set the sub-buffer size of a channel.</h4>
168 public static final String Lttng_Control_SetChannelSubbufSize
= "setChannelSubbufSize";
170 * <h4>LTTng trace control command to allocate trace resources.</h4>
172 public static final String Lttng_Control_AllocTrace
= "allocTrace";
174 * <h4>LTTng trace control command to configure a trace local trace.</h4>
176 public static final String Lttng_Control_WriteTraceLocal
= "writeTraceLocal";
178 * <h4>LTTng trace control command to configure a network trace</h4>
180 public static final String Lttng_Control_WriteTraceNetwork
= "writeTraceNetwork";
182 * <h4>LTTng trace control command to stop a network trace transfer</h4>
184 public static final String Lttng_Control_StopWriteTraceNetwork
= "stopWriteTraceNetwork";
186 * <h4>LTTng trace control command to start tracing.</h4>
188 public static final String Lttng_Control_StartTrace
= "startTrace";
190 * <h4>LTTng trace control command to pause tracing.</h4>
192 public static final String Lttng_Control_PauseTrace
= "pauseTrace";
194 * <h4>LTTng trace control command to destroy a trace (i.e. deallocate trace resource)</h4>
196 public static final String Lttng_Control_DestroyTrace
= "destroyTrace";
198 * <h4>Separator in command replies.</h4>
200 public static final String Lttng_Control_Separator
= ",";
204 public static final String Lttng_Control_GetActiveTraceInfoSeparator
= "=";
206 * <h4>Action property indicating a enabled action.</h4>
208 public static final String Rse_Resource_Action_Enabled
= "yes";
211 * <h4>Action property indicating a disabled action.</h4>
213 public static final String Rse_Resource_Action_Disabled
= "no";