Statistics
| Branch: | Revision:

root / ide / sequencechart / README.txt @ 1e6cf02d

History | View | Annotate | Download (3.72 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
- Run configure to setup the IDE
16
    $> ./configure
17

    
18

    
19
Installing from binaries
20
========================
21

    
22
- Replace the following files in the "ide/plugin" directory of Horizon
23
  with the corresponding ones from the "ide/sequencechart/bin" directory: 
24
  - org.omnetpp.ide.nativelibs_<version-string>.jar
25
  - org.omnetpp.sequencechart_<version-string>.jar
26
  - org.omnetpp.ide.nativelibs.linux.x86_64_<version-string>/libopplibs.so  
27
  
28
  NOTE: Currently, we only provide a binary build of libopplibs.so for Linux64.
29
        If you use Linux32, please build from source (first two 
30
        steps in the next section). Horizon currently does neither support
31
        Windows nor MacOS.
32

    
33

    
34
Building from source
35
====================
36

    
37
1. Build Horizon
38
---------------- 
39
- Read "INSTALL" in the root directory of Horizon for more
40
  information on compile time options and build prerequisites.
41
    $> ./configure; make
42

    
43

    
44
2. Build and install C++ nativelibs:
45
------------------------------------
46

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

    
57

    
58
3. Build and install Java nativelibs wrapper
59
--------------------------------------------
60

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

    
64
- Replace stock org.omnetpp.ide.nativelibs_<version-string>.jar file in 
65
  "ide/plugins" with the previously built jar
66

    
67

    
68
4. Build and install new sequence chart 
69
---------------------------------------
70

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

    
76
- Replace stock org.omnetpp.sequencechart_<version-string>.jar file in 
77
  "ide/plugins/" with previously build jar-file
78

    
79

    
80
Starting the extended sequencechart
81
===================================
82

    
83
- Create a trace by running Horizon with tracing enabled (record-eventlog=true)
84
  OR
85
  use the sample trace provided in "horizon/ide/sequencechart/sample"
86
  
87
- Start the IDE
88

    
89
- Load trace file in the IDE to open the sequencechart plugin
90

    
91

    
92
Using the extended sequencechart
93
================================
94

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

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

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