Project

General

Profile

Statistics
| Branch: | Revision:

root / ide / org.omnetpp.sequencechart / README.txt @ master

History | View | Annotate | Download (4.29 KB)

1 a1b71af8 Georg Kunz
This manual briefly explains how to INSTALL and USE the extended sequence chart.
2 c4ee3ff8 Georg Kunz
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 1e6cf02d Georg Kunz
15 a1b71af8 Georg Kunz
- 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 1e6cf02d Georg Kunz
20 c4ee3ff8 Georg Kunz
21
Installing from binaries
22
========================
23
24 8f424055 Georg Kunz
- Install binary files
25
    $> cd <horizon-root>
26
    $> make install-plugins
27
28 a1b71af8 Georg Kunz
  NOTE: Horizon currently does neither support Windows nor MacOS.
29 c4ee3ff8 Georg Kunz
30
31
Building from source
32
====================
33
34 a1b71af8 Georg Kunz
1. Build and install C++ nativelibs:
35 c4ee3ff8 Georg Kunz
------------------------------------
36
37 63d0f40e Georg Kunz
- Make sure that SWIG 1.x is correctly installed
38
39 c4ee3ff8 Georg Kunz
- Build libopplibs.so and create Java wrappers
40 63d0f40e Georg Kunz
    $> cd <horizon-root>
41
    $> make nativelibs
42
43
  This creates Java JNI wrapper files in ide/org.omnetpp.ide.nativelibs/src and
44
  installs the C++ counterpart in 
45
  ide/plugins/org.omnetpp.ide.nativelibs.<YOUR_PLATFORM>-<VERSION_STRING>/libopplibs.so
46 c4ee3ff8 Georg Kunz
47
48 a1b71af8 Georg Kunz
2. Build and install Java nativelibs wrapper
49 c4ee3ff8 Georg Kunz
--------------------------------------------
50
51
- Compile previously created Java files and create jar archive
52 a1b71af8 Georg Kunz
  NOTE: - We don't provide a makefile for this.
53
  
54
        - Consider using a Java project in Eclipse for building the code. You
55
          may also use a plugin-development project.
56
          
57
        - Use the existing jar-files from the plugins-directory of the IDE to
58
          resolve compile time dependencies.
59
          
60
        - Export the built code as jar-file using the "export jar" feature of
61
          Eclipse. Important: Use the provided MANIFEST.MF file.  
62
        
63 c4ee3ff8 Georg Kunz
- Replace stock org.omnetpp.ide.nativelibs_<version-string>.jar file in 
64
  "ide/plugins" with the previously built jar
65
66
67 a1b71af8 Georg Kunz
3. Build and install new sequence chart 
68 c4ee3ff8 Georg Kunz
---------------------------------------
69
70
- Create Eclipse plugin project with the code of the sequencechart provided in
71 30ed7b7b Georg Kunz
  "ide/org.omnetpp.sequencechart/src"
72 c4ee3ff8 Georg Kunz
  
73
- Build sequencechart.jar as Eclipse plugin
74
75 a1b71af8 Georg Kunz
  NOTE: - We don't provide a makefile for this.
76
  
77
        - Consider using a Java project in Eclipse for building the code. You
78
          may also use a plugin-development project.
79
          
80
        - Use the existing jar-files from the plugins-directory of the IDE to
81
          resolve compile time dependencies.
82
          
83
        - Export the built code as jar-file using the "export jar" feature of
84
          Eclipse. Important: Use the provided MANIFEST.MF file and include
85
          the plugin.xml file in the jar.
86
87 c4ee3ff8 Georg Kunz
- Replace stock org.omnetpp.sequencechart_<version-string>.jar file in 
88
  "ide/plugins/" with previously build jar-file
89
90
91
Starting the extended sequencechart
92
===================================
93
94
- Create a trace by running Horizon with tracing enabled (record-eventlog=true)
95
  OR
96 30ed7b7b Georg Kunz
  use the sample trace provided in "horizon/ide/org.omnetpp.sequencechart/sample"
97 c4ee3ff8 Georg Kunz
  
98
- Start the IDE
99
100
- Load trace file in the IDE to open the sequencechart plugin
101
102
103
Using the extended sequencechart
104
================================
105
106 937a8abd Georg Kunz
- Use the new toolbar button "Event Length Mode" for switching event length mode
107 c4ee3ff8 Georg Kunz
  between duration and complexity. The corresponding other time domain is
108
  represented by a gradual color coding ranging from green to red.
109 a1b71af8 Georg Kunz
  
110
  NOTE: Please use "Timeline Mode: Linear" (toggle via toolbar button) as the
111
        other timeline modes introduce an artifical spacing between events.
112 c4ee3ff8 Georg Kunz
113 937a8abd Georg Kunz
- Use the new toolbar button "Show Event Overlapping" for enabling and disabling the
114 c4ee3ff8 Georg Kunz
  highlighting of parallel events. Once enabled, select one event in the sequence
115
  chart to highlight all event which can be offloaded in parallel to the
116
  selected event. This disables the gradual color coding.
117
118 937a8abd Georg Kunz
- Use the new toolbar buttons "Jump to next Bottleneck" or "Jump to previous Bottleneck"
119 c4ee3ff8 Georg Kunz
  to search and highlight either the next or the previous performance bottleneck,
120
  i.e. region where only few events overlap (can be processed in parallel). Use
121
  the button "Bottleneck Preferences" to set the detection threshold in terms of
122
  the minimum number of overlapping events.
123