1 /* This file is part of the Linux Trace Toolkit Graphic User Interface
2 * Copyright (C) 2003-2004 Mathieu Desnoyers
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License Version 2 as
6 * published by the Free Software Foundation;
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
19 /* This file is the API used to launch any background computation on a trace */
23 * This API consists in two main parts. The first one is for the background
24 * computation provider and the second is for the viewer which needs this
27 * A computation provider, i.e. a statistics computation module or a state
28 * computation module, have two things in common : they append data to a trace
29 * in an extensible container (LttvAttributes). This extended information, once
30 * computed, can be kept all along with the trace and does not need to be
31 * recomputed : a computation done on a trace must result in a identical result
32 * each time it is done.
34 * This API provides functions for computation provider to register their
35 * computation functions (or computation functions insertion and removal
36 * functions). Once the computation provider is registered with its module name,
37 * extended computation for a trace can be requested by any viewer by specifying
38 * the module name, as we will describe in a moment.
40 * A viewer which needs extended information about a trace must ask for it to be
41 * computed by doing a background computation request. It may also ask to be
42 * notified of the completion of its request by doing a notify request.
44 * Before asking for the computation, it must check for its readiness. If it is
45 * ready, the information has already been computed, so it is ready to use. If
46 * the information is not ready, in must check whether or not the processing of
47 * this task is in progress. If it is, it must not do any background computation
48 * request. It must only do a background notification request of the current
49 * processing to be informed of its completion. If the information is not ready
50 * and not being processed, then the viewer may do a background computation
51 * request and add a notify request to the notify queue.
53 * When a context takes control of a trace, it must lock the trace. This is a
54 * way of ensuring that not conflict will occur between two traceset contexts
55 * and shared traces. It will generate an error if a context try to get a lock
56 * on a trace what is not unlocked. Upon every trace locking,
57 * lttv_process_traceset_synchronize_tracefiles should be used to resynchronize
58 * the traces with the trace context information.
60 * The usefulness of the lock in this framework can be questionable in a
61 * single threaded environment, but can be great in the eventuality of
68 #ifndef LTTVWINDOWTRACES_H
69 #define LTTVWINDOWTRACES_H
74 typedef GQuark LttvTraceInfo
;
76 extern LttvTraceInfo LTTV_TRACES
,
79 LTTV_REQUESTS_CURRENT
,
82 LTTV_COMPUTATION_TRACESET
,
83 LTTV_COMPUTATION_TRACESET_CONTEXT
,
84 LTTV_COMPUTATION_SYNC_POSITION
,
85 LTTV_BEFORE_CHUNK_TRACESET
,
86 LTTV_BEFORE_CHUNK_TRACE
,
87 LTTV_BEFORE_CHUNK_TRACEFILE
,
88 LTTV_AFTER_CHUNK_TRACESET
,
89 LTTV_AFTER_CHUNK_TRACE
,
90 LTTV_AFTER_CHUNK_TRACEFILE
,
94 LTTV_EVENT_HOOK_BY_ID
,
103 /* Get a trace by its path name.
105 * @param path path of the trace on the virtual file system.
106 * @return Pointer to trace if found
107 * NULL is returned if the trace is not present
110 LttvTrace
*lttvwindowtraces_get_trace_by_name(gchar
*path
);
112 /* Get a trace by its number identifier */
114 LttvTrace
*lttvwindowtraces_get_trace(guint num
);
116 /* Total number of traces */
118 guint
lttvwindowtraces_get_number();
120 /* Add a trace to the global attributes */
122 void lttvwindowtraces_add_trace(LttvTrace
*trace
);
124 /* Remove a trace from the global attributes */
126 void lttvwindowtraces_remove_trace(LttvTrace
*trace
);
130 * Function to request data from a specific trace
132 * The memory allocated for the request will be managed by the API.
134 * @param trace the trace to compute
135 * @param module_name the name of the module which registered global computation
139 void lttvwindowtraces_background_request_queue
140 (LttvTrace
*trace
, gchar
*module_name
);
143 * Remove a background request from a trace.
145 * This should ONLY be used by the modules which registered the global hooks
146 * (module_name). If this is called by the viewers, it may lead to incomplete
147 * and incoherent background processing information.
149 * Even if the module which deals with the hooks removes the background
150 * requests, it may cause a problem if the module gets loaded again in the
151 * session : the data will be partially calculated. The calculation function
152 * must deal with this case correctly.
154 * @param trace the trace to compute
155 * @param module_name the name of the module which registered global computation
159 void lttvwindowtraces_background_request_remove
160 (LttvTrace
*trace
, gchar
*module_name
);
163 * Register a callback to be called when requested data is passed in the next
164 * queued background processing.
166 * @param owner owner of the background notification
167 * @param trace the trace computed
168 * @param notify_time time when notification hooks must be called
169 * @param notify_position position when notification hooks must be called
170 * @param notify Hook to call when the notify position is passed
173 void lttvwindowtraces_background_notify_queue
177 const LttvTracesetContextPosition
*notify_position
,
178 const LttvHooks
*notify
);
181 * Register a callback to be called when requested data is passed in the current
182 * background processing.
184 * @param owner owner of the background notification
185 * @param trace the trace computed
186 * @param notify_time time when notification hooks must be called
187 * @param notify_position position when notification hooks must be called
188 * @param notify Hook to call when the notify position is passed
191 void lttvwindowtraces_background_notify_current
195 const LttvTracesetContextPosition
*notify_position
,
196 const LttvHooks
*notify
);
199 * Removes all the notifications requests from a specific viewer.
201 * @param owner owner of the background notification
204 void lttvwindowtraces_background_notify_remove(gpointer owner
);
208 * Tells if the information computed by a module for a trace is ready.
210 * Must be checked before a background processing request.
212 * @param module_name A GQuark : the name of the module which computes the
214 * @param trace The trace for which the information is verified.
217 gboolean
lttvwindowtraces_get_ready(LttvAttributeName module_name
,
221 * Tells if the information computed by a module for a trace is being processed.
223 * Must be checked before a background processing request.
225 * If it is effectively processed, the typical thing to do is to call
226 * lttvwindowtraces_background_notify_current to be notified when the current
227 * processing will be over.
229 * @param module_name A GQuark : the name of the module which computes the
231 * @param trace The trace for which the information is verified.
234 gboolean
lttvwindowtraces_get_in_progress(LttvAttributeName module_name
,
238 * Register the background computation hooks for a specific module. It adds the
239 * computation hooks to the global attrubutes, under "computation/module name"
241 * @param module_name A GQuark : the name of the module which computes the
244 void lttvwindowtraces_register_computation_hooks(LttvAttributeName module_name
,
245 LttvHooks
*before_chunk_traceset
,
246 LttvHooks
*before_chunk_trace
,
247 LttvHooks
*before_chunk_tracefile
,
248 LttvHooks
*after_chunk_traceset
,
249 LttvHooks
*after_chunk_trace
,
250 LttvHooks
*after_chunk_tracefile
,
251 LttvHooks
*before_request
,
252 LttvHooks
*after_request
,
253 LttvHooks
*event_hook
,
254 LttvHooksById
*event_hook_by_id
,
255 LttvHooks
*hook_adder
,
256 LttvHooks
*hook_remover
);
258 * Unregister the background computation hooks for a specific module.
260 * It also removes all the requests than can be currently processed by the
261 * background computation algorithm for all the traces (list_in and list_out).
263 * @param module_name A GQuark : the name of the module which computes the
267 void lttvwindowtraces_unregister_computation_hooks
268 (LttvAttributeName module_name
);
272 * It removes all the requests than can be currently processed by the
273 * background computation algorithm for all the traces (list_in and list_out).
275 * Leaves the flag to in_progress or none.. depending if current or queue
277 * @param module_name A GQuark : the name of the module which computes the
280 void lttvwindowtraces_unregister_requests(LttvAttributeName module_name
);
284 * Lock a trace so no other instance can use it.
286 * @param trace The trace to lock.
287 * @return 0 on success, -1 if cannot get lock.
289 gint
lttvwindowtraces_lock(LttvTrace
*trace
);
295 * @param trace The trace to unlock.
296 * @return 0 on success, -1 if cannot unlock (not locked ?).
298 gint
lttvwindowtraces_unlock(LttvTrace
*trace
);
301 * Verify if a trace is locked.
303 * @param trace The trace to verify.
304 * @return TRUE if locked, FALSE is unlocked.
306 gint
lttvwindowtraces_get_lock_state(LttvTrace
*trace
);
309 #endif //LTTVWINDOWTRACES_H