Statistics
| Branch: | Revision:

root / ide / sequencechart / README.txt @ c4ee3ff8

History | View | Annotate | Download (3.66 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
- Build Horizon. Read "INSTALL" in the root directory of Horizon for more
11
  information on compile time options and build prerequisites.
12
    $> cd <horizon-root>
13
    $> ./configure; make
14
  
15
- Download stock OMNeT++ 4.1 from www.omnetpp.org and un-tar it.
16
  NOTE: The extended sequencechart has only been tested with OMNeT++ 4.1.
17

    
18
- Copy "ide" directory from stock OMNeT++ to root directory of Horizon.
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: Currently, we only provide a binary build of libopplibs.so for Linux64.
31
        If you use Linux32, please build from source (first two 
32
        steps in the next section). Horizon currently does neither support
33
        Windows nor MacOS.
34

    
35

    
36
Building from source
37
====================
38

    
39
1. Build and install C++ nativelibs:
40
------------------------------------
41

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

    
52

    
53
2. Build and install Java nativelibs wrapper
54
--------------------------------------------
55

    
56
- Compile previously created Java files and create jar archive
57
  NOTE: We don't provide a makefile for this. Consider using Eclipse.
58

    
59
- Replace stock org.omnetpp.ide.nativelibs_<version-string>.jar file in 
60
  "ide/plugins" with the previously built jar
61

    
62

    
63
3. Build and install new sequence chart 
64
---------------------------------------
65

    
66
- Create Eclipse plugin project with the code of the sequencechart provided in
67
  "ide/sequencechart/src"
68
  
69
- Build sequencechart.jar as Eclipse plugin
70

    
71
- Replace stock org.omnetpp.sequencechart_<version-string>.jar file in 
72
  "ide/plugins/" with previously build jar-file
73

    
74

    
75
Starting the extended sequencechart
76
===================================
77

    
78
- Create a trace by running Horizon with tracing enabled (record-eventlog=true)
79
  OR
80
  use the sample trace provided in "horizon/ide/sequencechart/sample"
81
  
82
- Start the IDE
83

    
84
- Load trace file in the IDE to open the sequencechart plugin
85

    
86

    
87
Using the extended sequencechart
88
================================
89

    
90
- Use new toolbar button "Event Length Mode" for switching event length mode
91
  between duration and complexity. The corresponding other time domain is
92
  represented by a gradual color coding ranging from green to red.
93

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

    
99
- Use new toolbar buttons "Jump to next Bottleneck" or "Jump to previous Bottleneck"
100
  to search and highlight either the next or the previous performance bottleneck,
101
  i.e. region where only few events overlap (can be processed in parallel). Use
102
  the button "Bottleneck Preferences" to set the detection threshold in terms of
103
  the minimum number of overlapping events.
104