3rd_gen_viewer: continue
[lttv.git] / trunk / masters-pmf / 3rd_gen_viewer / 3rd_gen_viewer_arch.lyx
CommitLineData
1fde1b39 1#LyX 1.5.5 created this file. For more info see http://www.lyx.org/
2\lyxformat 276
3\begin_document
4\begin_header
5\textclass article
6\language english
7\inputencoding auto
8\font_roman default
9\font_sans default
10\font_typewriter default
11\font_default_family default
12\font_sc false
13\font_osf false
14\font_sf_scale 100
15\font_tt_scale 100
16\graphics default
17\paperfontsize default
18\spacing single
19\papersize default
20\use_geometry false
21\use_amsmath 1
22\use_esint 1
23\cite_engine basic
24\use_bibtopic false
25\paperorientation portrait
26\secnumdepth 3
27\tocdepth 3
28\paragraph_separation skip
29\defskip medskip
30\quotes_language english
31\papercolumns 1
32\papersides 1
33\paperpagestyle default
34\tracking_changes false
35\output_changes false
36\author ""
37\author ""
38\end_header
39
40\begin_body
41
42\begin_layout Title
43A Set of APIs for a Third-Generation Trace Viewer
44\end_layout
45
46\begin_layout Author
47\noindent
48Pierre-Marc Fournier, Michel Dagenais, Mathieu Desnoyers
49\newline
50
51\family typewriter
52\size footnotesize
53<pierre-marc.fournier _at_ polymtl.ca>
54\family default
55\size default
56
57\newline
58
59\newline
60CASI Lab
61\newline
62École Polytechnique de Montréal
63\newline
64
65\newline
66WORK IN PROGRESS
67\end_layout
68
1fde1b39 69\begin_layout Standard
70This document proposes some APIs for a trace viewing and analysis infrastructure.
71\end_layout
72
73\begin_layout Standard
74Design choices were made based on the experience acquired by the design,
75 development and use of two previous generations of trace viewers, respectively
76 the Trace Visualizer from the Linux Trace Toolkit and its successor, the
77 LTTV from the LTTng tracing toolkit.
78\end_layout
79
80\begin_layout Section
81Goals
82\end_layout
83
84\begin_layout Itemize
85Provide an infrastructure for fast, interactive visualization and analysis
86 of huge traces (>10 GB) on standard workstations
87\begin_inset Foot
88status open
89
90\begin_layout Standard
91Efficiency is of great importance.
92 It is tempting to think that as computers get faster, it will be possible
93 to run more complex analyses on traces in a shorter time.
94 In fact, the size of the traces grows as computers get more powerful, because
95 they do more operations than before in the same amount of time and therefore
96 generate more events.
97 The current tendency to parallelize systems is another factor that results
98 in bigger traces.
99\end_layout
100
101\end_inset
102
103
104\end_layout
105
106\begin_layout Itemize
b71d449a 107Allow efficient manipulation of traces that are larger than the system memory
108\end_layout
109
110\begin_layout Itemize
111Support processing of live traces
1fde1b39 112\end_layout
113
114\begin_layout Itemize
115Allow merging of traces of different formats
116\end_layout
117
1fde1b39 118\begin_layout Itemize
119Design with both command line utilities (C language) and graphical interfaces
120 (Java and others) in mind, sharing code and standardizing interfaces as
121 much as possible
122\end_layout
123
124\begin_deeper
125\begin_layout Standard
126Both command-line interfaces and graphical interfaces have an important
127 role to play in trace analysis.
128 While graphical interfaces allow for complex views, command-line utilities
129 can be used quickly in more environments; they can also be more convenient
130 in some circumstances.
131 A good design should be such that they can share code and APIs.
132\end_layout
133
134\end_deeper
135\begin_layout Section
136General aspects
137\end_layout
138
139\begin_layout Itemize
140All data structures must be accessed through API methods, in order to allow
141 for internal change without breaking compatibility.
142\end_layout
143
1fde1b39 144\begin_layout Itemize
4414440b 145The APIs in this document are described as C functions and datatypes.
b71d449a 146 When an operation applies to an abstraction that could be an object in
4414440b 147 an object-oriented language, it is specified as the first argument of the
148 function.
1fde1b39 149\end_layout
150
151\begin_layout Subsection
4414440b 152Time
1fde1b39 153\end_layout
154
1fde1b39 155\begin_layout Standard
4414440b 156The framework needs to represent points in the time line and time ranges.
157 This is done by two data structures, respectively:
1fde1b39 158\end_layout
159
160\begin_layout Itemize
4414440b 161struct trace_time
1fde1b39 162\end_layout
163
164\begin_layout Itemize
4414440b 165struct trace_time_range
1fde1b39 166\end_layout
167
1fde1b39 168\begin_layout Standard
4414440b 169The preferred representation for times is seconds.
1fde1b39 170\end_layout
171
4414440b 172\begin_layout Standard
173Ranges are a span between two points in time.
174 They are represented as these two points.
175 One or both of them can have the special value
176\emph on
177infinity
178\emph default
179.
1fde1b39 180\end_layout
181
b71d449a 182\begin_layout Standard
183Each time is accompanied by an uncertainty value.
184\end_layout
185
aed623d7 186\begin_layout Subsection
187Modules
188\end_layout
189
190\begin_layout Standard
191The following modules should be part of the framework.
192 This list does not include modules related to the GUI, the controlling
193 of traces and the transfer of traces.
194\end_layout
195
196\begin_layout Description
197Trace Has one instance per open trace.
198 Allows the access to a trace by exporting the Low-level Trace Reading API.
199 The underlying implementation may change from one trace to another to adapt
200 to the specific format of each trace.
201\end_layout
202
203\begin_layout Description
204Traceset Receives data from several Traces using their Low-Level Trace Reading
205 API and merge them in a single stream.
206 May also receive data from other instances of Traceset.
207 Exports the High-level Trace Reading API and the Low-level Trace Reading
208 API.
209 Handles time offsetting if necessary to align traces.
210 Handles filtering.
211\end_layout
212
213\begin_layout Description
214State\InsetSpace ~
215providers They receive the stream of events from the Traceset, using
216 the High-level Trace Reading API.
217 They detect state changes.
218 Each one is designed to detect states of a particular level (kernel, applicatio
219n-level, UML states).
220 It pushes the detected states to the State module using the State Setting
221 API.
222\end_layout
223
224\begin_layout Description
225State Records changes in the system state received from State providers
226 by the State Setting API.
227 It implements an efficient state searching engine.
228 Exports the State Accessing API to allow plugins to access the information.
229\end_layout
230
231\begin_layout Description
232Event\InsetSpace ~
233description Receives the stream of events from the Traceset using the
234 High-level Trace Reading API.
235 It reads the events that describe other events and stores the information
3f188151 236 they contain, possibly using the State module.
237 Other components can access this information through an exported API.
aed623d7 238\end_layout
239
240\begin_layout Description
241Plugins...
242 These are the graphical views, analyses and other components that need
243 access to the events.
244 They receive data from a traceset using the High-level Trace Reading API.
245 They use the services they need (State, Event Description, and/or others).
246 They may export a special API if other components need to access their
247 data.
248\end_layout
249
1fde1b39 250\begin_layout Section
b71d449a 251Low level reading of traces
1fde1b39 252\end_layout
253
254\begin_layout Subsection
255Overview
256\end_layout
257
b71d449a 258\begin_layout Standard
259This API presents a uniform way of accessing traces at a low level, that
260 is to access randomly the events of the trace in an physical-encoding-independa
261nt way.
262\end_layout
263
264\begin_layout Standard
265\begin_inset Note Note
266status open
267
1fde1b39 268\begin_layout Subsubsection
269Timestamps
270\end_layout
271
272\begin_layout Standard
273Timestamps, at the framework level, should be in an architecture-independent
274 format.
275 One possibility would be to have them stored in seconds (with decimals).
276 Offsetting, if necessary, could be handled by the traceset (trace merging)
277 level.
278 An uncertainty value should accompany the timestamp.
279 Timestamps in cycles should be available if they are provided by the tracer.
280\end_layout
281
b71d449a 282\end_inset
283
284
1fde1b39 285\end_layout
286
287\begin_layout Standard
b71d449a 288\begin_inset Note Note
289status open
1fde1b39 290
291\begin_layout Subsubsection
292Factory methods
293\end_layout
294
295\begin_layout Itemize
6e3755ba 296void get_supported_formats(void)
1fde1b39 297\end_layout
298
299\begin_deeper
300\begin_layout Standard
301Arguments: none
302\end_layout
303
304\begin_layout Standard
305Return:
306\end_layout
307
308\begin_layout Itemize
309a list of supported formats
310\end_layout
311
312\end_deeper
313\begin_layout Itemize
314open_trace()
315\end_layout
316
317\begin_deeper
318\begin_layout Standard
319Arguments:
320\end_layout
321
322\begin_layout Itemize
323trace URL
324\end_layout
325
326\begin_deeper
327\begin_layout Itemize
328local file name
329\end_layout
330
331\begin_layout Itemize
332other special url to establish a network connection
333\end_layout
334
335\begin_layout Itemize
336etc...
337\end_layout
338
339\end_deeper
340\begin_layout Itemize
341trace format (optional, for cases where auto detection would not work or
342 be ambiguous)
343\end_layout
344
345\begin_layout Standard
346Return:
347\end_layout
348
349\begin_layout Itemize
350a trace handle
351\end_layout
352
b71d449a 353\end_inset
354
355
356\end_layout
357
358\begin_layout Subsection
359Methods of the Low Level Trace Reading API
1fde1b39 360\end_layout
361
362\begin_layout Itemize
b71d449a 363void close(struct trace *tr)
1fde1b39 364\end_layout
365
b71d449a 366\begin_deeper
367\begin_layout Standard
368Close the trace and unallocate all resources associated to this struct trace
369 including the handle.
370 After this call, tr is invalid and its memory is freed.
371\end_layout
372
9e22a509 373\begin_layout Standard
374Arguments:
375\end_layout
376
377\begin_layout Itemize
378tr: the trace
379\end_layout
380
381\begin_layout Standard
382Return value: none
383\end_layout
384
b71d449a 385\end_deeper
1fde1b39 386\begin_layout Itemize
9e22a509 387struct event *current_event(struct trace *tr, struct cursor *cur)
1fde1b39 388\end_layout
389
390\begin_deeper
391\begin_layout Standard
9e22a509 392Return the event pointed by the cursor cur.
1fde1b39 393\end_layout
394
395\begin_layout Standard
9e22a509 396Arguments:
397\end_layout
398
399\begin_layout Itemize
400tr: the trace
401\end_layout
402
403\begin_layout Itemize
404cur: the cursor indicating the position of the wanted event
405\end_layout
406
407\begin_layout Standard
408Return value:
1fde1b39 409\end_layout
410
411\begin_layout Itemize
412the event currently pointed by the position pointer
413\end_layout
414
b71d449a 415\begin_layout Itemize
416NULL, if current_event is called on a new cursor that is positioned before
417 the beginning of the trace
418\end_layout
419
1fde1b39 420\end_deeper
421\begin_layout Itemize
b71d449a 422int advance(struct trace *tr, struct trace_cursor *cur)
1fde1b39 423\end_layout
424
425\begin_deeper
426\begin_layout Standard
b71d449a 427Advance the cursor to the next event in the trace.
1fde1b39 428\end_layout
429
430\begin_layout Standard
b71d449a 431Arguments:
432\end_layout
433
434\begin_layout Itemize
435tr: the trace
436\end_layout
437
438\begin_layout Itemize
439cur: the cursor that should be advanced
1fde1b39 440\end_layout
441
442\begin_layout Standard
b71d449a 443Return value:
1fde1b39 444\end_layout
445
446\begin_layout Itemize
447The result:
448\end_layout
449
450\begin_deeper
451\begin_layout Itemize
b71d449a 452Success (TRACE_ADVANCE_OK)
1fde1b39 453\end_layout
454
455\begin_layout Itemize
b71d449a 456The cursor was not advanced because the end of trace is reached (end of
457 a non-live trace or of a completed live trace) (TRACE_ADVANCE_END)
1fde1b39 458\end_layout
459
460\begin_layout Itemize
b71d449a 461The cursor was not advanced because no new events are available at this
462 time (with a live trace that is still running) (TRACE_ADVANCE_TRY_AGAIN)
1fde1b39 463\end_layout
464
465\end_deeper
466\end_deeper
467\begin_layout Itemize
b71d449a 468int seek_time(struct trace *tr, struct trace_cursor *cur, struct trace_time
469 time)
1fde1b39 470\end_layout
471
472\begin_deeper
9e22a509 473\begin_layout Standard
474Place a cursor at a particular time index in a trace.
475\end_layout
476
1fde1b39 477\begin_layout Standard
478Arguments:
479\end_layout
480
481\begin_layout Itemize
b71d449a 482tr: the trace that should be seeked
483\end_layout
484
485\begin_layout Itemize
486cur: the cursor to seek
487\end_layout
488
489\begin_layout Itemize
490time: the time to seek to
1fde1b39 491\end_layout
492
493\begin_layout Standard
b71d449a 494Return:
495\end_layout
496
497\begin_layout Itemize
4980: success
499\end_layout
500
501\begin_layout Itemize
502!= 0: time out of range
1fde1b39 503\end_layout
504
505\end_deeper
506\begin_layout Itemize
b71d449a 507struct trace_cursor *trace_new_cursor(struct trace *tr)
1fde1b39 508\end_layout
509
6e3755ba 510\begin_deeper
511\begin_layout Standard
b71d449a 512Return a new cursor associated to the trace.
513 The position of this new cursor is just before the first event, therefore
514 advance() must be called before reading the first event.
6e3755ba 515\end_layout
516
9e22a509 517\begin_layout Standard
518Arguments:
519\end_layout
520
521\begin_layout Itemize
522tr: the trace
523\end_layout
524
525\begin_layout Standard
526Return value:
527\end_layout
528
529\begin_layout Itemize
530the new cursor
531\end_layout
532
6e3755ba 533\end_deeper
1fde1b39 534\begin_layout Itemize
6e3755ba 535struct trace_cursor *trace_cursor_copy(struct trace_cursor *cur)
1fde1b39 536\end_layout
537
b71d449a 538\begin_deeper
539\begin_layout Standard
540Copy a cursor.
541\end_layout
542
543\begin_layout Standard
544Arguments:
545\end_layout
546
547\begin_layout Itemize
548cur: the cursor to copy
549\end_layout
550
551\begin_layout Standard
552Return value:
553\end_layout
554
555\begin_layout Itemize
556a new cursor that is at the same location as cur
557\end_layout
558
559\end_deeper
560\begin_layout Itemize
561void trace_cursor_destroy(struct trace_cursor *cur)
562\end_layout
563
564\begin_deeper
565\begin_layout Standard
566Free all resources associated to a cursor.
567 After this call, cur is invalid.
568\end_layout
569
570\begin_layout Standard
571Arguments:
572\end_layout
573
1fde1b39 574\begin_layout Itemize
b71d449a 575cur: the cursor to destroy
1fde1b39 576\end_layout
577
9e22a509 578\begin_layout Standard
579Return value: none
580\end_layout
581
b71d449a 582\end_deeper
1fde1b39 583\begin_layout Itemize
6e3755ba 584struct trace_time get_time_start(struct trace *tr)
1fde1b39 585\end_layout
586
587\begin_deeper
588\begin_layout Standard
b71d449a 589Arguments:
590\end_layout
591
592\begin_layout Itemize
593tr: the trace
1fde1b39 594\end_layout
595
596\begin_layout Standard
9e22a509 597Return value:
1fde1b39 598\end_layout
599
600\begin_layout Itemize
601the timestamp of the first event in the trace
602\end_layout
603
604\end_deeper
605\begin_layout Itemize
6e3755ba 606struct trace_time get_time_end(struct trace *tr)
1fde1b39 607\end_layout
608
609\begin_deeper
610\begin_layout Standard
611Arguments: none
612\end_layout
613
614\begin_layout Standard
615Return:
616\end_layout
617
618\begin_layout Itemize
619the timestamp of the last event in the trace
620\end_layout
621
622\end_deeper
623\begin_layout Itemize
6e3755ba 624register_callback_new_event(struct trace *tr, struct trace_time after, void
9e22a509 625 (*cb)(struct trace *, void *priv), void *private)
1fde1b39 626\end_layout
627
628\begin_deeper
629\begin_layout Standard
630Register a callback that is called when a new event becomes available in
631 a live trace.
632 It is also called when the live trace ends.
633\end_layout
634
635\begin_layout Standard
636Arguments:
637\end_layout
638
639\begin_layout Itemize
b71d449a 640after (timestamp) : call only if the timestamp of the event is later than
641
1fde1b39 642\emph on
643after
644\end_layout
645
646\begin_layout Itemize
6e3755ba 647cb: the callback function
1fde1b39 648\begin_inset Note Note
649status open
650
651\begin_layout Standard
652specify its args and return val
653\end_layout
654
655\end_inset
656
657
658\end_layout
659
660\begin_layout Standard
661Return:
662\end_layout
663
664\begin_layout Itemize
665Result (success or failure)
666\end_layout
667
668\end_deeper
b71d449a 669\begin_layout Section
670High level reading of traces
671\end_layout
672
3f188151 673\begin_layout Subsection
674Overview
675\end_layout
676
b71d449a 677\begin_layout Standard
678When reading/analyzing/viewing several traces of heterogenous types, these
679 traces are read by translator modules, which export the Low Level Trace
680 Reading API.
681 The traceset service then uses this API to read each of these traces individual
9e22a509 682ly, merging them along the way.
b71d449a 683 It may apply timestamp offsetting or other synchronization techniques.
684 To allow views and analyses to access events, it in turn exports the High
685 Level Trace Reading API.
1fde1b39 686\end_layout
687
688\begin_layout Standard
689The goal of this API is to provide a uniform way for analyses and views
b71d449a 690 to obtain large sets of trace events from a traceset (merge of many traces
691 or a single trace).
692\end_layout
693
694\begin_layout Subsection
695Methods of the high-level trace reading API
1fde1b39 696\end_layout
697
698\begin_layout Itemize
4414440b 699struct request_handle *traceset_new_event_request(struct traceset *tr, struct
700 trace_time t1, struct trace_time t2, struct event_filter *filter, void
9e22a509 701 (*cb)(void *priv, ), void *private)
1fde1b39 702\end_layout
703
704\begin_deeper
705\begin_layout Standard
9e22a509 706Request a range of events from a traceset
1fde1b39 707\end_layout
708
4414440b 709\begin_layout Standard
710Arguments:
1fde1b39 711\end_layout
712
713\begin_layout Itemize
4414440b 714tr: the traceset
1fde1b39 715\end_layout
716
717\begin_layout Itemize
4414440b 718t1: start timestamp
1fde1b39 719\end_layout
720
721\begin_layout Itemize
4414440b 722t2: stop timestamp (special value for infinity, for live traces)
1fde1b39 723\end_layout
724
725\begin_layout Itemize
4414440b 726filter: filter with complex expressions
1fde1b39 727\end_layout
728
729\begin_layout Itemize
9e22a509 730private: private pointer to be passed to the callback
1fde1b39 731\end_layout
732
733\begin_layout Standard
9e22a509 734Return value:
1fde1b39 735\end_layout
736
737\begin_layout Itemize
738handle to the request for cancelling it
739\end_layout
740
741\end_deeper
742\begin_layout Itemize
4414440b 743void event_request_cancel(struct request_handle *req)
1fde1b39 744\end_layout
745
746\begin_deeper
b71d449a 747\begin_layout Standard
748Cancel a request.
749\end_layout
750
1fde1b39 751\begin_layout Standard
752Arguments:
753\end_layout
754
755\begin_layout Itemize
4414440b 756req: the handle to the request
1fde1b39 757\end_layout
758
759\end_deeper
3f188151 760\begin_layout Section
1fde1b39 761State management
762\end_layout
763
4414440b 764\begin_layout Standard
765States are key/value pairs associated with a time range.
766 Keys can be (and generally are) duplicated as long as they do not apply
767 to overlapping ranges.
768\end_layout
769
770\begin_layout Standard
771Keys are character strings.
3f188151 772 They are organized in a filesystem-like hierarchy.
773\end_layout
774
775\begin_layout Standard
776Each key/value pair is associated either to a specific trace or to the traceset.
777\end_layout
778
779\begin_layout Standard
780State can persist between runs of the program.
781 This is useful both to reduce pre-calculation times when re-opening a trace,
782 and also to keep general parameters like bookmarks.
783\end_layout
784
785\begin_layout Standard
786It is possible to assign a state to the time range -infinity..infinity to
787 indicate that it is global to the trace.
4414440b 788\end_layout
789
790\begin_layout Standard
791Values may be of various types:
792\end_layout
793
794\begin_layout Itemize
795string
796\end_layout
797
798\begin_layout Itemize
799uint32
800\end_layout
801
802\begin_layout Itemize
803int32
804\end_layout
805
806\begin_layout Itemize
3f188151 807uint64
4414440b 808\end_layout
809
810\begin_layout Itemize
3f188151 811int64
4414440b 812\end_layout
813
814\begin_layout Itemize
3f188151 815blob (binary block of arbitrary length)
4414440b 816\end_layout
817
3f188151 818\begin_layout Itemize
819float32
4414440b 820\end_layout
821
3f188151 822\begin_layout Itemize
823float64
4414440b 824\end_layout
825
3f188151 826\begin_layout Itemize
827others?
4414440b 828\end_layout
829
3f188151 830\begin_layout Subsection
aed623d7 831Methods of the State Accessing API
1fde1b39 832\end_layout
833
834\begin_layout Itemize
4414440b 835struct state_value *state_get_value_at_time(char *key, struct trace_time
836 time)
1fde1b39 837\end_layout
838
839\begin_deeper
4414440b 840\begin_layout Standard
841Request the value of a given key at a point in time
842\end_layout
843
1fde1b39 844\begin_layout Standard
845Arguments:
846\end_layout
847
848\begin_layout Itemize
4414440b 849var: the state variables (string)
850\end_layout
851
852\begin_layout Itemize
853time: the timestamp
854\end_layout
855
856\begin_layout Standard
857Return value:
1fde1b39 858\end_layout
859
860\begin_layout Itemize
3f188151 861The state value.
862 A struct state_value contains the value and the time interval that applies
863 to it.
1fde1b39 864\end_layout
865
866\end_deeper
867\begin_layout Itemize
4414440b 868struct state_value_range **state_get_values_in_range(char *key, struct state_val
869ue *val, struct trace_time_range range)
870\end_layout
871
872\begin_deeper
873\begin_layout Standard
3f188151 874Request all the state changes of a given set of state variables between
1fde1b39 875 two time indexes
876\end_layout
877
1fde1b39 878\begin_layout Standard
879Arguments:
880\end_layout
881
882\begin_layout Itemize
4414440b 883key: the key
1fde1b39 884\end_layout
885
886\begin_layout Itemize
4414440b 887range: the time range
1fde1b39 888\end_layout
889
3f188151 890\begin_layout Standard
891Return value:
892\end_layout
893
894\begin_layout Itemize
895The values
896\end_layout
897
4414440b 898\end_deeper
1fde1b39 899\begin_layout Itemize
4414440b 900Other functions for getting values for a set of keys at once?
1fde1b39 901\end_layout
902
3f188151 903\begin_layout Subsection
aed623d7 904Methods of the State Setting API
1fde1b39 905\end_layout
906
4414440b 907\begin_layout Itemize
908set a particular state
909\end_layout
910
911\begin_layout Itemize
912delete some states
913\end_layout
914
1fde1b39 915\begin_layout Section
916Describing event types
917\end_layout
918
919\begin_layout Subsection
920Overview
921\end_layout
922
923\begin_layout Standard
924Because tracepoints may be created dynamically, information about the descriptio
925n of events is just as dynamic.
926 In this context, one simple way to communicate the event description informatio
927n to upper layers would be to send them as events, as it is done in recent
928 versions of LTTV.
929 The core events used to describe other events are the only ones whose descripti
930on is hardcoded in the framework.
931\end_layout
932
933\begin_layout Standard
934These event-type-describing events could then be received and interpreted
4414440b 935 by the Event Description Service, which would be a client to the high-level
936 tracing API at the same level as normal views and analyses.
1fde1b39 937 It would store the information and allow the other views and analyses to
938 access it via this API.
939\end_layout
940
4414440b 941\begin_layout Standard
942Each event has a timestamp, a name and arguments of various types.
943 The framework should support the following types:
944\end_layout
945
946\begin_layout Itemize
947uint32
948\end_layout
949
950\begin_layout Itemize
951uint64
952\end_layout
953
954\begin_layout Itemize
955int32
956\end_layout
957
958\begin_layout Itemize
959int64
960\end_layout
961
962\begin_layout Itemize
963string
964\end_layout
965
1fde1b39 966\begin_layout Subsection
967Events-describing events
968\end_layout
969
970\begin_layout Itemize
971Event type declaration event
972\end_layout
973
974\begin_deeper
975\begin_layout Standard
976Announce the existence of an event type
977\end_layout
978
979\begin_layout Itemize
980event type name
981\end_layout
982
983\end_deeper
984\begin_layout Itemize
985Argument declaration event
986\end_layout
987
988\begin_deeper
989\begin_layout Standard
990Announce the existence of an event argument
991\end_layout
992
993\begin_layout Itemize
994event type name
995\end_layout
996
997\begin_layout Itemize
998name
999\end_layout
1000
1001\begin_layout Itemize
1002type
1003\end_layout
1004
1005\end_deeper
1006\begin_layout Itemize
1007Event destruction
1008\end_layout
1009
1010\begin_deeper
1011\begin_layout Standard
1012Announce that an event type ceased to exist
1013\end_layout
1014
1015\begin_layout Itemize
1016event type name
1017\end_layout
1018
1019\end_deeper
1020\begin_layout Subsection
aed623d7 1021Methods of the Event Type Description API
1fde1b39 1022\end_layout
1023
4414440b 1024\begin_layout Standard
1025The event type description service provides the following functions.
1026\end_layout
1027
1fde1b39 1028\begin_layout Itemize
4414440b 1029GArray<struct event_type *> *traceset_get_all_event_types(struct traceset
1030 *ts)
1031\end_layout
1032
1033\begin_deeper
1034\begin_layout Standard
1fde1b39 1035Get the list of all the event types
1036\end_layout
1037
4414440b 1038\begin_layout Standard
1039Arguments:
1040\end_layout
1041
1fde1b39 1042\begin_layout Itemize
4414440b 1043ts: the traceset of which we want the event types
1044\end_layout
1045
1046\begin_layout Standard
1047Return value:
1048\end_layout
1049
1050\begin_layout Itemize
1051A GArray of of struct event_type.
1052 The GArray must be gfree()'d by the caller when it is done reading it.
1053\end_layout
1054
1055\end_deeper
1056\begin_layout Itemize
1057struct event_type *traceset_get_event_type_by_name(struct traceset *ts,
1058 char *name)
1059\end_layout
1060
1061\begin_deeper
1062\begin_layout Standard
1fde1b39 1063Find an event type by name
1064\end_layout
1065
4414440b 1066\begin_layout Standard
1067Arguments:
1068\end_layout
1069
1fde1b39 1070\begin_layout Itemize
4414440b 1071ts: the traceset of which we want the event type
1fde1b39 1072\end_layout
1073
1074\begin_layout Itemize
4414440b 1075name: the name of the of the event type we are looking for
1076\end_layout
1077
1078\begin_layout Standard
1079Return value:
1fde1b39 1080\end_layout
1081
1082\begin_layout Itemize
4414440b 1083A pointer to the event type (must not be free'd) or NULL if not found
1084\end_layout
1085
1086\end_deeper
1087\begin_layout Itemize
1088GArray<struct event arg *> *event_type_get_all_args(struct event_type *evtype)
1089\end_layout
1090
1091\begin_deeper
1092\begin_layout Standard
1093Get the list of arguments of an event
1094\end_layout
1095
1096\begin_layout Standard
1097Arguments:
1fde1b39 1098\end_layout
1099
1100\begin_layout Itemize
4414440b 1101eventype: the event type of which we want the arguments
1102\end_layout
1103
1104\begin_layout Standard
1105Return value:
1fde1b39 1106\end_layout
1107
1108\begin_layout Itemize
4414440b 1109A GArray of struct event_args.
1110 The GArray must be gfree()'d by the caller when it is done reading it.
1fde1b39 1111\end_layout
1112
4414440b 1113\end_deeper
1fde1b39 1114\begin_layout Itemize
4414440b 1115struct event_arg *event_type_get_arg_by_name(struct event_type *evtype)
1fde1b39 1116\end_layout
1117
4414440b 1118\begin_deeper
1119\begin_layout Standard
1120Find an argument by name
1121\end_layout
1122
1123\end_deeper
1fde1b39 1124\begin_layout Itemize
4414440b 1125Functions for accessing struct event_arg fields
1fde1b39 1126\end_layout
1127
1128\begin_layout Section
1129Inspecting events
1130\end_layout
1131
1132\begin_layout Subsection
1133Overview
1134\end_layout
1135
1136\begin_layout Standard
1137Events contain the following information.
1138\end_layout
1139
1140\begin_layout Itemize
1141Timestamp
1142\end_layout
1143
1144\begin_layout Itemize
4414440b 1145Event type identifier - an event id (integer) - hidden to the API users,
1146 manipulated as pointers/references to struct event_type
1147\end_layout
1148
1149\begin_layout Itemize
1150A reference to the trace it was in
1151\end_layout
1152
1153\begin_layout Subsection
aed623d7 1154Methods of the Event inspecting API
4414440b 1155\end_layout
1156
1157\begin_layout Itemize
1158struct event_type *event_get_type(struct traceset *ts, struct event *ev)
1fde1b39 1159\end_layout
1160
1161\begin_deeper
1162\begin_layout Standard
4414440b 1163get the event type corresponding to an event
1fde1b39 1164\end_layout
1165
4414440b 1166\begin_layout Standard
1167Arguments:
1fde1b39 1168\end_layout
1169
1170\begin_layout Itemize
4414440b 1171ts:
1fde1b39 1172\end_layout
1173
1fde1b39 1174\begin_layout Itemize
4414440b 1175ev:
1fde1b39 1176\end_layout
1177
4414440b 1178\begin_layout Standard
1179Return value:
1fde1b39 1180\end_layout
1181
1182\begin_layout Itemize
4414440b 1183The event type or NULL if no information
1184\end_layout
1185
1186\end_deeper
1187\begin_layout Itemize
1188struct trace_time event_get_time(struct event *ev)
1189\end_layout
1190
1191\begin_deeper
1192\begin_layout Standard
1193get the event time
1fde1b39 1194\end_layout
1195
4414440b 1196\end_deeper
1fde1b39 1197\begin_layout Itemize
4414440b 1198struct trace *event_get_trace(struct event *ev)
1fde1b39 1199\end_layout
1200
1201\begin_layout Itemize
4414440b 1202get the name of the machine on which the event occured or other location
1203 information
1fde1b39 1204\end_layout
1205
1206\begin_layout Itemize
1207get information on the type of tracing technology that was used
1208\end_layout
1209
1210\begin_layout Itemize
1211get the corresponding tracepoint (machine/tracing technology/name/location
1212 in code(if available))
1213\end_layout
1214
4414440b 1215\begin_layout Itemize
1216uint32 event_read_arg_uint32(struct event *ev, struct event_arg *arg)
1217\end_layout
1218
1219\begin_layout Itemize
1220int32 event_read_arg_int32(struct event *ev, struct event_arg *arg)
1221\end_layout
1222
1223\begin_layout Itemize
1224uint64 event_read_arg_uint64(struct event *ev, struct event_arg *arg)
1225\end_layout
1226
1227\begin_layout Itemize
1228int64 event_read_arg_int64(struct event *ev, struct event_arg *arg)
1229\end_layout
1230
1231\begin_layout Itemize
1232float32 event_read_arg_float32(struct event *ev, struct event_arg *arg)
1233\end_layout
1234
1235\begin_layout Itemize
1236float64 event_read_arg_float64(struct event *ev, struct event_arg *arg)
1237\end_layout
1238
1239\begin_layout Section
1240Filtering events
1241\end_layout
1242
1243\begin_layout Standard
1244A filtering API is proposed.
1245\end_layout
1246
1247\begin_layout Section
1248Controlling the tracing of a system
1249\end_layout
1250
1251\begin_layout Subsection
1252Overview
1253\end_layout
1254
1255\begin_layout Standard
1256The goal of this API is to provide a portable way of controlling tracing
1257 of heterogenous systems.
1258\end_layout
1259
1260\begin_layout Standard
1261It should enable to do the following actions.
1262\end_layout
1263
1264\begin_layout Itemize
1265Set the parameters of a trace (channels, buffering, destination of data
1266 (file, network, process)...)
1267\end_layout
1268
1269\begin_layout Itemize
1270Control the recording of events (start, stop, pause the trace)
1271\end_layout
1272
1273\begin_layout Itemize
1274Create tracepoints (on dynamic tracers) and control which tracepoints are
1275 activated (some may be at trace level, others might only permit system
1276 level)
1277\end_layout
1278
1279\begin_layout Subsection
aed623d7 1280Methods of the Trace Control API
4414440b 1281\end_layout
1282
1283\begin_layout Itemize
1284List the static tracepoints available on a system
1285\end_layout
1286
1287\begin_deeper
1288\begin_layout Standard
1289These may be static tracepoints (active or inactive) or dynamic tracepoints
1290 (active or proposed).
1291\end_layout
1292
1293\end_deeper
1294\begin_layout Itemize
1295Add a new dynamic tracepoint
1296\end_layout
1297
1298\begin_layout Itemize
1299Activate a tracepoint
1300\end_layout
1301
1302\begin_layout Itemize
1303Deactivate a tracepoint
1304\end_layout
1305
1306\begin_layout Itemize
1307List available probes
1308\end_layout
1309
1310\begin_layout Itemize
1311Connect a probe to a tracepoint
1312\end_layout
1313
1314\begin_layout Itemize
1315Start tracing
1316\end_layout
1317
1318\begin_layout Itemize
1319Stop tracing
1320\end_layout
1321
1322\begin_layout Itemize
1323\begin_inset Note Greyedout
1324status open
1325
1326\begin_layout Standard
1327others missing...
1328\end_layout
1329
1330\end_inset
1331
1332
1333\end_layout
1334
1fde1b39 1335\end_body
1336\end_document
This page took 0.076572 seconds and 4 git commands to generate.