Statistics
| Branch: | Revision:

root / ide / org.omnetpp.sequencechart / README.txt @ 9d023582

History | View | Annotate | Download (4.54 KB)

1
This manual briefly explains how to INSTALL and USE the extended sequence chart.
2

    
3
NOTE: The extended sequencechart has only been tested with OMNeT++ 4.1.
4
      Horizon currently does neither support Windows nor MacOS.
5

    
6

    
7
Prerequisites
8
=============
9

    
10
- Download stock OMNeT++ 4.1 from www.omnetpp.org and un-tar it.
11
  NOTE: The extended sequencechart has only been tested with OMNeT++ 4.1.
12

    
13
- Copy "ide" directory from stock OMNeT++ to root directory of Horizon.
14

    
15
- Build Horizon
16
  Read "INSTALL" in the root directory of Horizon for more
17
  information on compile time options and build prerequisites.
18
    $> ./configure; make
19

    
20

    
21
Installing from binaries
22
========================
23

    
24
- Replace the following files in the "ide/plugin" directory of Horizon
25
  with the corresponding ones from the "ide/sequencechart/bin" directory: 
26
  - org.omnetpp.ide.nativelibs_<version-string>.jar
27
  - org.omnetpp.sequencechart_<version-string>.jar
28
  - org.omnetpp.ide.nativelibs.linux.x86_64_<version-string>/libopplibs.so  
29
  
30
  NOTE: Horizon currently does neither support Windows nor MacOS.
31

    
32

    
33
Building from source
34
====================
35

    
36
1. Build and install C++ nativelibs:
37
------------------------------------
38

    
39
- Build libopplibs.so and create Java wrappers
40
    $> cd src/org.omnetpp.ide.nativelibs
41
    $> make
42
  This creates the file "horizon/out/gcc-<mode>/ui/libopplibs.so" and Java 
43
  files in "src/org.omnetpp.ide.nativelibs/src"
44
  
45
- Replace the stock libopplibs.so file in 
46
  "ide/org.omnetpp.ide.nativelibs.<YOUR-PLATFORM>_<version-string>" with the 
47
  previously built libopplibs.so
48

    
49

    
50
2. Build and install Java nativelibs wrapper
51
--------------------------------------------
52

    
53
- Compile previously created Java files and create jar archive
54
  NOTE: - We don't provide a makefile for this.
55
  
56
        - Consider using a Java project in Eclipse for building the code. You
57
          may also use a plugin-development project.
58
          
59
        - Use the existing jar-files from the plugins-directory of the IDE to
60
          resolve compile time dependencies.
61
          
62
        - Export the built code as jar-file using the "export jar" feature of
63
          Eclipse. Important: Use the provided MANIFEST.MF file.  
64
        
65
- Replace stock org.omnetpp.ide.nativelibs_<version-string>.jar file in 
66
  "ide/plugins" with the previously built jar
67

    
68

    
69
3. Build and install new sequence chart 
70
---------------------------------------
71

    
72
- Create Eclipse plugin project with the code of the sequencechart provided in
73
  "ide/sequencechart/src"
74
  
75
- Build sequencechart.jar as Eclipse plugin
76

    
77
  NOTE: - We don't provide a makefile for this.
78
  
79
        - Consider using a Java project in Eclipse for building the code. You
80
          may also use a plugin-development project.
81
          
82
        - Use the existing jar-files from the plugins-directory of the IDE to
83
          resolve compile time dependencies.
84
          
85
        - Export the built code as jar-file using the "export jar" feature of
86
          Eclipse. Important: Use the provided MANIFEST.MF file and include
87
          the plugin.xml file in the jar.
88

    
89
- Replace stock org.omnetpp.sequencechart_<version-string>.jar file in 
90
  "ide/plugins/" with previously build jar-file
91

    
92

    
93
Starting the extended sequencechart
94
===================================
95

    
96
- Create a trace by running Horizon with tracing enabled (record-eventlog=true)
97
  OR
98
  use the sample trace provided in "horizon/ide/sequencechart/sample"
99
  
100
- Start the IDE
101

    
102
- Load trace file in the IDE to open the sequencechart plugin
103

    
104

    
105
Using the extended sequencechart
106
================================
107

    
108
- Use the new toolbar button "Event Length Mode" for switching event length mode
109
  between duration and complexity. The corresponding other time domain is
110
  represented by a gradual color coding ranging from green to red.
111
  
112
  NOTE: Please use "Timeline Mode: Linear" (toggle via toolbar button) as the
113
        other timeline modes introduce an artifical spacing between events.
114

    
115
- Use the new toolbar button "Show Event Overlapping" for enabling and disabling the
116
  highlighting of parallel events. Once enabled, select one event in the sequence
117
  chart to highlight all event which can be offloaded in parallel to the
118
  selected event. This disables the gradual color coding.
119

    
120
- Use the new toolbar buttons "Jump to next Bottleneck" or "Jump to previous Bottleneck"
121
  to search and highlight either the next or the previous performance bottleneck,
122
  i.e. region where only few events overlap (can be processed in parallel). Use
123
  the button "Bottleneck Preferences" to set the detection threshold in terms of
124
  the minimum number of overlapping events.
125