Repository : ssh://git@open-mesh.org/doc

On branches: batman-adv-doc,master

commit 3c39bd4919c0a663694b90647fd6cfdadf399ec9 Author: Simon Wunderlich siwu@hrz.tu-chemnitz.de Date: Tue Sep 2 16:29:28 2008 +0200

add most of the proposed illustrations

3c39bd4919c0a663694b90647fd6cfdadf399ec9 batman_iv.docbook | 69 +++++++++++++++++++++++++++++++++++++++++------- images/Makefile | 16 ++++++++--- images/asym_link1.dia | Bin 0 -> 1359 bytes images/asym_link2.dia | Bin 0 -> 1385 bytes images/asym_penalty.gp | 19 +++++++++++++ images/eq.dia | Bin 0 -> 1219 bytes images/hop_penalty1.dia | Bin 0 -> 1841 bytes images/hop_penalty2.dia | Bin 0 -> 1865 bytes images/rq.dia | Bin 0 -> 1143 bytes images/tq.dia | Bin 0 -> 1161 bytes 10 files changed, 90 insertions(+), 14 deletions(-)

diff --git a/batman_iv.docbook b/batman_iv.docbook index 68838ce3..565fe797 100644 --- a/batman_iv.docbook +++ b/batman_iv.docbook @@ -89,7 +89,7 @@ TODO Explain multiple interfaces, which interface sends which OGM by which TTL, <para> Example: OGMs from Node A propagate to B. The link is asymetric, therefore B receives all packets from A in contrast to A which receives almost nothing from B. As all the packets from A get to B the packet count at B's side goes up. B will assume that it has a perfect link towards A which is not the case. <inlinemediaobject> - <imageobject> <imagedata fileref="images/asymetry.pdf" format="EPS" /> </imageobject> + <imageobject> <imagedata fileref="images/asymetry.pdf" format="EPS" scale="50"/> </imageobject> <imageobject> <imagedata fileref="images/asymetry.png" format="PNG" /> </imageobject> <textobject> <phrase>asymetry illustration</phrase> </textobject> </inlinemediaobject> @@ -106,14 +106,38 @@ TODO Explain multiple interfaces, which interface sends which OGM by which TTL, As explained in the previous section the packet counting floods the network with receiving link quality rather than transmit link quality. On the link-local level the transmit link quality can be derived from the receiving link quality by applying some calculations on the packet count.

<orderedlist> - <listitem><para>B.A.T.M.A.N. knows the receiving link quality (RQ) by counting the packets of its neighbors.</para></listitem> - <listitem><para>B.A.T.M.A.N. knows the echo link quality (EQ) by counting rebroadcasts of its own OGMs from his neighbors.</para></listitem> - <listitem><para>B.A.T.M.A.N. can calculate the transmit link quality (TQ) by dividing the echo link quality by the receiving link quality.</para></listitem> + <listitem> + <para>B.A.T.M.A.N. knows the receiving link quality (RQ) by counting the packets of its neighbors.</para> + <para> + <inlinemediaobject> + <imageobject> <imagedata fileref="images/rq.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/rq.png" format="PNG" /> </imageobject> + <textobject> <phrase>Receive Quality (RQ)</phrase> </textobject> + </inlinemediaobject></para> + </listitem> + <listitem> + <para>B.A.T.M.A.N. knows the echo link quality (EQ) by counting rebroadcasts of its own OGMs from his neighbors.</para> + <para> + <inlinemediaobject> + <imageobject> <imagedata fileref="images/eq.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/eq.png" format="PNG" /> </imageobject> + <textobject> <phrase>Echo Link Quality (EQ)</phrase> </textobject> + </inlinemediaobject></para> + </listitem> + <listitem> + <para>B.A.T.M.A.N. can calculate the transmit link quality (TQ) by dividing the echo link quality by the receiving link quality.</para> + <para> + <inlinemediaobject> + <imageobject> <imagedata fileref="images/tq.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/tq.png" format="PNG" /> </imageobject> + <textobject> <phrase>Transmit Link Quality (TQ)</phrase> </textobject> + </inlinemediaobject></para> + </listitem> </orderedlist>

As shown above B.A.T.M.A.N. IV is able to retrieve the local transmit quality by using the same mechanisms as B.A.T.M.A.N. III without adding further overhead. - [4 illustrations needed (for each list item and one for the tq alone)] +[??? what kind of 4th illustration? put the formular in a picture, or in the text?] </para> </sect2> <sect2 id="batman4_tq_prop"> @@ -151,10 +175,25 @@ TODO Explain multiple interfaces, which interface sends which OGM by which TTL, <para> TODO Only transmit quality is not enough - nothing worth if the receive direction is too bad to receive WIFI acks. -[ illustration: bad situation :) ] + <inlinemediaobject> + <imageobject> <imagedata fileref="images/asym_link1.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/asym_link1.png" format="PNG" /> </imageobject> + <textobject> <phrase>Asymetry situation without asymetry penalty</phrase> </textobject> + </inlinemediaobject> + + TODO Also calculate the receive direction - but weight it. -[ illustration: how to weight (graph of 1 - (1-x) **3)] -[ illustration: bad situation after using asym penalty ] + <inlinemediaobject> + <imageobject> <imagedata fileref="images/asym_penalty.pdf" format="EPS" /> </imageobject> + <imageobject> <imagedata fileref="images/asym_penalty.png" format="PNG" /> </imageobject> + <textobject> <phrase>graph for asymetry penalty</phrase> </textobject> + </inlinemediaobject> + + <inlinemediaobject> + <imageobject> <imagedata fileref="images/asym_link2.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/asym_link2.png" format="PNG" /> </imageobject> + <textobject> <phrase>Asymetry situation with applied asymetry penalty</phrase> </textobject> + </inlinemediaobject> </para> </sect2>

@@ -162,9 +201,19 @@ TODO Also calculate the receive direction - but weight it. <title>Hop penalty</title> <para> TODO There would be loops in "perfect" networks without loss, e.g. ethernet. - [ illustration: triangle A,B,C with perfect links ] + <inlinemediaobject> + <imageobject> <imagedata fileref="images/hop_penalty1.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/hop_penalty1.png" format="PNG" /> </imageobject> + <textobject> <phrase>no hop penalty</phrase> </textobject> + </inlinemediaobject> + Explain hop penalty. - [ illustration: triangle A,B,C after hop penalty ] + <inlinemediaobject> + <imageobject> <imagedata fileref="images/hop_penalty2.pdf" format="EPS" scale="50" /> </imageobject> + <imageobject> <imagedata fileref="images/hop_penalty2.png" format="PNG" /> </imageobject> + <textobject> <phrase>hop penalty applied</phrase> </textobject> + </inlinemediaobject> + </para> </sect2>

diff --git a/images/Makefile b/images/Makefile index ace4a975..ae167d56 100644 --- a/images/Makefile +++ b/images/Makefile @@ -1,13 +1,21 @@ -DIA_IMAGES=asymetry.dia -PNG_IMAGES=$(DIA_IMAGES:.dia=.png) -PDF_IMAGES=$(DIA_IMAGES:.dia=.pdf) +GP_IMAGES=asym_penalty.gp +DIA_IMAGES=asymetry.dia tq.dia eq.dia rq.dia hop_penalty1.dia hop_penalty2.dia asym_link1.dia asym_link2.dia +PNG_IMAGES= $(DIA_IMAGES:.dia=.png) +PNG_IMAGES+=$(GP_IMAGES:.gp=.png) +PDF_IMAGES= $(DIA_IMAGES:.dia=.pdf) +PDF_IMAGES+=$(GP_IMAGES:.gp=.pdf)

.PHONY: clean -.SUFFIXES: .dia .png .eps .pdf +.SUFFIXES: .dia .png .eps .pdf .gp

default: all all: $(PDF_IMAGES) $(PNG_IMAGES)

+.gp.png: + gnuplot $< +.gp.eps: + gnuplot $< + .dia.png: /usr/bin/dia -e $@ $< .dia.eps: diff --git a/images/asym_link1.dia b/images/asym_link1.dia new file mode 100644 index 00000000..497b785d Binary files /dev/null and b/images/asym_link1.dia differ diff --git a/images/asym_link2.dia b/images/asym_link2.dia new file mode 100644 index 00000000..ce1953c1 Binary files /dev/null and b/images/asym_link2.dia differ diff --git a/images/asym_penalty.gp b/images/asym_penalty.gp new file mode 100644 index 00000000..8ed0e6b0 --- /dev/null +++ b/images/asym_penalty.gp @@ -0,0 +1,19 @@ +#!/usr/bin/gnuplot +set title "Asymetry Penalty illustration" +set xlabel "Receive Quality (RQ)" +set ylabel "applied Asymetry Penalty" +set xrange [0:1] +set yrange [0:1] +set grid + +set terminal png +set output "asym_penalty.png" + +plot (1 - (1-x) ** 3) title "asymetry penalty 1 - (1-x)^3",\ + x title "receive quality" + +set terminal postscript eps enhanced color solid +set output "asym_penalty.eps" + +plot (1 - (1-x) ** 3) title "asymetry penalty 1 - (1-x)^3",\ + x title "receive quality" diff --git a/images/eq.dia b/images/eq.dia new file mode 100644 index 00000000..2a694864 Binary files /dev/null and b/images/eq.dia differ diff --git a/images/hop_penalty1.dia b/images/hop_penalty1.dia new file mode 100644 index 00000000..ce0d584c Binary files /dev/null and b/images/hop_penalty1.dia differ diff --git a/images/hop_penalty2.dia b/images/hop_penalty2.dia new file mode 100644 index 00000000..0a926e44 Binary files /dev/null and b/images/hop_penalty2.dia differ diff --git a/images/rq.dia b/images/rq.dia new file mode 100644 index 00000000..99ba6c97 Binary files /dev/null and b/images/rq.dia differ diff --git a/images/tq.dia b/images/tq.dia new file mode 100644 index 00000000..1ee4c056 Binary files /dev/null and b/images/tq.dia differ