Commit | Line | Data |
---|---|---|
70407e86 | 1 | /* This file is part of the Linux Trace Toolkit viewer |
277e5b53 | 2 | * Copyright (C) 2009, 2010 Benjamin Poirier <benjamin.poirier@polymtl.ca> |
70407e86 | 3 | * |
277e5b53 BP |
4 | * This program is free software: you can redistribute it and/or modify it |
5 | * under the terms of the GNU Lesser General Public License as published by | |
6 | * the Free Software Foundation, either version 2.1 of the License, or (at | |
7 | * your option) any later version. | |
70407e86 | 8 | * |
277e5b53 BP |
9 | * This program is distributed in the hope that it will be useful, but WITHOUT |
10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public | |
12 | * License for more details. | |
70407e86 | 13 | * |
277e5b53 BP |
14 | * You should have received a copy of the GNU Lesser General Public License |
15 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
70407e86 BP |
16 | */ |
17 | ||
18 | #ifndef EVENT_ANALYSIS_H | |
19 | #define EVENT_ANALYSIS_H | |
20 | ||
21 | #include <glib.h> | |
08365995 | 22 | #include <stdio.h> |
70407e86 | 23 | |
10341d26 | 24 | #include "data_structures.h" |
467066ee | 25 | #include "graph_functions.h" |
70407e86 BP |
26 | |
27 | ||
28 | struct _SyncState; | |
29 | ||
30 | typedef struct | |
31 | { | |
32 | char* name; | |
33 | ||
eb8e0e6f BP |
34 | /* |
35 | * This function is called at the beginning of a synchronization run for a set | |
36 | * of traces. Allocate analysis specific data structures. | |
37 | */ | |
70407e86 | 38 | void (*initAnalysis)(struct _SyncState* const syncState); |
eb8e0e6f BP |
39 | |
40 | /* | |
41 | * Free the analysis specific data structures. | |
42 | */ | |
70407e86 BP |
43 | void (*destroyAnalysis)(struct _SyncState* const syncState); |
44 | ||
eb8e0e6f BP |
45 | /* |
46 | * Perform analysis on an event pair. | |
47 | */ | |
10341d26 BP |
48 | void (*analyzeMessage)(struct _SyncState* const syncState, Message* const |
49 | message); | |
eb8e0e6f BP |
50 | |
51 | /* | |
52 | * Perform analysis on multiple messages. | |
53 | */ | |
10341d26 BP |
54 | void (*analyzeExchange)(struct _SyncState* const syncState, Exchange* const |
55 | exchange); | |
eb8e0e6f BP |
56 | |
57 | /* | |
58 | * Perform analysis on muliple events. | |
59 | */ | |
10341d26 BP |
60 | void (*analyzeBroadcast)(struct _SyncState* const syncState, Broadcast* const |
61 | broadcast); | |
eb8e0e6f BP |
62 | |
63 | /* | |
64 | * Finalize the factor calculations. Return synchronization factors | |
65 | * between trace pairs. | |
66 | */ | |
0a87ec9a | 67 | AllFactors* (*finalizeAnalysis)(struct _SyncState* const syncState); |
467066ee | 68 | |
eb8e0e6f BP |
69 | /* |
70 | * Print statistics related to analysis. Is always called after | |
71 | * finalizeAnalysis. | |
72 | */ | |
70407e86 | 73 | void (*printAnalysisStats)(struct _SyncState* const syncState); |
eb8e0e6f BP |
74 | |
75 | /* | |
76 | * Write the analysis-specific options and graph commands in the gnuplot | |
77 | * script. Is always called after finalizeAnalysis. | |
78 | */ | |
467066ee | 79 | GraphFunctions graphFunctions; |
70407e86 BP |
80 | } AnalysisModule; |
81 | ||
82 | #endif |