README file has design details for Projector.
[charm.git] / src / conv-perf / README
1 #########################################################################################
2 MODULES PER LANGUAGE
3 #########################################################################################
4
5 TRACER
6 ------
7 LanguageID RegisterLanguage(Language)
8         - could be done at runtime or manually
9
10 EventID RegisterEvent(LanguageID, EventNameString, EventDataPrototype)
11         - EventNameString is a string identifying the event 
12         - EventDataPrototype could be a string in language specific format
13           OR variable number of arguments identifying the data structure for that event
14
15 void LogEvent(LanguageID, EventID, EventData)
16         - EventData could be a string in language specific format
17           OR variable number of arguments specifying the value of attributes of EventDataPrototype
18
19
20 INTERPRETOR
21 -----------
22 void RegisterEventInterpretor(Language/ID, EventInterpretor)
23         - Language/ID is Language or LanguageID depending upon whether it was runtime 
24           registered or manually registered
25         - EventInterpretor could be a function pointer [Single Per Lanuage]
26
27 ANALYSER
28 --------
29 void RegisterTraceAnalyser(Language/ID, TraceAnalyser)
30         - Language/ID is Language or LanguageID depending upon whether it was runtime 
31           registered or manually registered
32         - TraceAnalyser could be a function pointer [Multiple Per Lanuage]
33
34
35 VIZUALIZER
36 ----------
37 void RegisterTraceVizualizer(Language/ID, TraceVisualizer)
38         - Language/ID is Language or LanguageID depending upon whether it was runtime 
39           registered or manually registered
40         - TraceVisualizer could be a function pointer [Multiple Per Lanuage]
41
42
43
44