Remove outdated src/site documentation 42/60242/1
authorLorand Jakab <lojakab@cisco.com>
Wed, 12 Jul 2017 10:53:18 +0000 (13:53 +0300)
committerLorand Jakab <lojakab@cisco.com>
Wed, 12 Jul 2017 10:53:18 +0000 (13:53 +0300)
https://lists.opendaylight.org/pipermail/odlparent-dev/2017-July/001218.html

Content moved to the wiki:
https://wiki.opendaylight.org/view/Southbound_Performance_Cache

Change-Id: I9867417f6f0a9f30cb3166371f4cfe4c5f3cbe14
Signed-off-by: Lorand Jakab <lojakab@cisco.com>
mappingservice/southbound/src/site/markdown/map-register_cache.md [deleted file]
mappingservice/southbound/src/site/site.xml [deleted file]
src/site/site.xml [deleted file]

diff --git a/mappingservice/southbound/src/site/markdown/map-register_cache.md b/mappingservice/southbound/src/site/markdown/map-register_cache.md
deleted file mode 100644 (file)
index f962069..0000000
+++ /dev/null
@@ -1,106 +0,0 @@
-#Performance - Use a local cache for Map-Registers in byte[] form in SB, and only update map-cache if necessary
-
-##Feature overview
-xTR devices sent periodical updates through map register message which are often the same
-
-Store incomming map register messages in local cache to avoid deserialization of the same message.
-
-##Implementation
-###Hash map
-
-Cache is implemented in class +MapRegisterCache+ as hash map. Key of this hash map is instance of *MapRegisterCacheKey* and value is instance of *MapRegisterCacheValue*.
-
-After receiving map register message it is firstly checked whether this message has been received before. If it so and is still valid (is in cache without refresh less then 90 seconds) then it isn't deserialized. Otherway it comletely deserialized.
-
-To be able to say that received map register message is the same as other previously received there is key (instance of +MapRegisterCacheKey+) which holds following values:
-
-###Key
-
-* **eidPrefix** - array of bytes which comes from first record in map register message. In [RFC 6830](https://tools.ietf.org/html/rfc6830#page-38) it is named *EID-Prefix*. If EID-Prefix-AFI (field just infront of EID-Prefix) has value 16387 then EID-Prefix contains also instance identifier.
-* **xTRId** - array of bytes (16 B) which comes from the end of map register message according to [Lisp-NAT-Traversal](https://tools.ietf.org/html/draft-ermagan-lisp-nat-traversal-10#page-10) draft,
-* **siteId** - arrays of bytes (8 B) which comes from the end of map register message according to [Lisp-NAT-Traversal](https://tools.ietf.org/html/draft-ermagan-lisp-nat-traversal-10#page-10) draft.
-
-Combination of this 3 values should be enough to uniquely identify each map register message.
-
-###Value
-
-Value part of hash map record is created in two phases:
-
-1. during partional deserialization:
- * **val** - byte array which contains map register in the same state as was received
- * **wantMapNotify** - boolean value which is set according to value of M bib (24th bit of map register message)
- * **mergeBit** - boolean value which is set according to value of 22th bit in map register message
-1. during full deserialization:
- * **list of EIDs** - all EIDS (transformed value of EID-Prefix) for all records,
- * **xTRId** - instance of +XtrId+ class,
- * **siteId** - instance of +SiteId+ class,
- * **timestamp** - when was this value object created o last refreshed.
-
-##New handling of map register message
-1. partial deserialization is done - result of this operation is map entry object which consists of pair - key and value
-1. if map entry key is in cache and is still valid
- * new type of notification mapping-keep-alive is sent (it is caught in +LispMappingService+)
- * if want-map-notify bit is set then also map-notify message is sent
- * map entry value is refreshed - timestamp is set to current time
- * done
-1. if map entry key is in cache but isn't valid - entry is removed from cache and continue with following step
-1. if map entry isn't in cache
- * message is processed as before (complete deserialization)
- * some data from deserialization are stored to map entry value
- * timestamp for map entry value is set to current time
- * done
-
-##Consideration
-* It isn't necessary to store mergeBit in value part of hash map record because only records which have merge bit set to value 0 are stored to hash map
-
-##Results comparison
-Performance test 010_Southbound_MapRequest.robot from integration-test/csit/suites/lispflowmapping/performance was
-ran 2 times with master build and 3 times with patch build. Results below:
-<table border="true">
-<tr>
-    <th>type of patch</th>
-    <th>run order</th>
-    <th>replies/s</th>
-    <th>notifies/s</th>
-    <th>store/s</th>
-</tr>
-<tr>
-    <td rowspan="3">master</td>
-    <td>1</td>
-    <td>25528.03</td>
-    <td>3207.33792662</td>
-    <td>335.244225418</td>
-</tr>
-<tr>
-    <td>2</td>
-    <td>26270.7</td>
-    <td>3427.32</td>
-    <td>323.070461668</td>
-</tr>
-<tr>
-    <td>3</td>
-    <td>26151.48</td>
-    <td>3373.95</td>
-    <td>321.998969603</td>
-</tr>
-<tr>
-    <td rowspan="3">patch</td>
-    <td>1</td>
-    <td>31635.4</td>
-    <td>24079.1</td>
-    <td>291.5026964</td>
-</tr>
-<tr>
-    <td>2</td>
-    <td>30541.91</td>
-    <td>25235.59</td>
-    <td>251.889168766</td>
-</tr>
-<tr>
-    <td>3</td>
-    <td>35747.1</td>
-    <td>24249.39</td>
-    <td>272.464715819</td>
-</tr>
-</table>
-
diff --git a/mappingservice/southbound/src/site/site.xml b/mappingservice/southbound/src/site/site.xml
deleted file mode 100644 (file)
index f7bf4b1..0000000
+++ /dev/null
@@ -1,25 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project name="lispflowmapping">
-    <bannerLeft>
-        <name>OpenDaylight</name>
-        <src>https://www.opendaylight.org/sites/all/themes/odl2/logo.png</src>
-        <href>https://www.opendaylight.org/</href>
-        <width>457</width>
-    </bannerLeft>
-
-    <body>
-        <menu name="Developer Documentation">
-            <item name="Map-Register Cache" href="map-register_cache.html" />
-        </menu>
-
-        <menu ref="parent" />
-        <menu ref="reports" />
-        <menu ref="modules" />
-    </body>
-
-    <skin>
-        <groupId>org.apache.maven.skins</groupId>
-        <artifactId>maven-fluido-skin</artifactId>
-        <version>1.4</version>
-    </skin>
-</project>
diff --git a/src/site/site.xml b/src/site/site.xml
deleted file mode 100644 (file)
index 3f2172a..0000000
+++ /dev/null
@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project name="lispflowmapping">
-    <body>
-        <menu name="Overview">
-            <item name="Javadocs" href="apidocs/index.html" />
-        </menu>
-    </body>
-</project>
-