Optimize bgp and xmpp update generation

[Nischal Sheth]

Placeholder bug to track improvements to bgp and xmpp update generation.

1. UpdateQueue and RibOutUpdates classes are organized to pack BGP NLRI
that share the same attributes into a single message. An unnecessary side
effect is that the same also happens for XMPP. However, each XMPP item is
self-contained, so it should be fine to pack multiple items with different
attributes into the same XMPP message.

2. Sending a set of routes to multiple xmpp peers becomes quite expensive
if some of the peers get blocked. The same route has to be encoded in xml
string format multiple times - once per peer in theoretical worst case.
This can be alleviated by storing/caching the xml string representation
of the RibOutAttr.

3. We perform a bunch of string copies and concatenation when sending the
same message to multiple xmpp peers since the to attribute needs to be
updated. Should do this by selectively replacing the target peer name.

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21123
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21123
Committed: http://github.org/Juniper/contrail-controller/commit/4e63161781bb178e2268e13d240451235754054e
Submitter: Zuul
Branch: master

commit 4e63161781bb178e2268e13d240451235754054e
Author: Nischal Sheth <email address hidden>
Date: Sat Jun 11 22:59:13 2016 -0700

Allow xmpp items with different attributes in same message

UpdateQueue and RibOutUpdates classes are organized to pack BGP NLRI
that share the same attributes into a single message. An unnecessary
side effect is that the same also happens for XMPP. This results in
more messages, socket write operations and context switches than is
really necessary.

As each XMPP item is self-contained, items with different attributes
can and should be packed into the same XMPP message. This is achieved
by ignoring BgpAttr when comparing UpdateInfos while inserting into a
UpdateQueue and when traversing the UpdateQueue by Attr.

Change-Id: I63a7a7a1b56f31b9e365d27021a60f7a323a197c
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21190
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21233
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21234
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21033
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21233
Committed: http://github.org/Juniper/contrail-controller/commit/7e562d9038a9bf168d3eaf1866ef697ac01f1c8f
Submitter: Zuul
Branch: R3.0

commit 7e562d9038a9bf168d3eaf1866ef697ac01f1c8f
Author: Nischal Sheth <email address hidden>
Date: Sat Jun 11 22:59:13 2016 -0700

Allow xmpp items with different attributes in same message

UpdateQueue and RibOutUpdates classes are organized to pack BGP NLRI
that share the same attributes into a single message. An unnecessary
side effect is that the same also happens for XMPP. This results in
more messages, socket write operations and context switches than is
really necessary.

As each XMPP item is self-contained, items with different attributes
can and should be packed into the same XMPP message. This is achieved
by ignoring BgpAttr when comparing UpdateInfos while inserting into a
UpdateQueue and when traversing the UpdateQueue by Attr.

Change-Id: I63a7a7a1b56f31b9e365d27021a60f7a323a197c
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21283
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21190
Committed: http://github.org/Juniper/contrail-controller/commit/aa2246ffd95ad206e5ce8758cd9e49597571fe72
Submitter: Zuul
Branch: master

commit aa2246ffd95ad206e5ce8758cd9e49597571fe72
Author: Nischal Sheth <email address hidden>
Date: Wed Jun 15 09:17:10 2016 -0700

Ensure that reach and unreach items go in separate xmpp messages

Change-Id: Idb0d59df3bd7258b79bb5525c5e05560de60abd8
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21033
Committed: http://github.org/Juniper/contrail-controller/commit/1331357f86b8db158507d2759c9f5b421a7a32fa
Submitter: Zuul
Branch: master

commit 1331357f86b8db158507d2759c9f5b421a7a32fa
Author: Nischal Sheth <email address hidden>
Date: Tue Jun 7 15:29:49 2016 -0700

Optimize build of xmpp udpate messages

Sending a set of routes to multiple xmpp peers becomes quite expensive
if some of the peers get blocked. The same route has to be encoded in
xml string format multiple times. Alleviate this by caching the string
representation in the RibOutAttr and using it if available. The xml
string is cached only if there are one or more blocked peers in RibOut
i.e. only if it's going to be used later on when building another xmpp
message.

It's quite common to build an xmpp message and send to multiple peers.
String operations to build a new message with a different to attribute
are pretty expensive. Reuse the same message by selectively replacing
the first line.

Need to hand code xml generation for message, event and items to achieve
the above. However, those are pretty static - xml for each item is still
generated by building a document and calling pugi library print method.
Use a custom xml_writer to append to string representation of message.
This helps avoid unnecessary intermediate steps of writing to a stream
and converting the stream to a string.

Add test code that was used to characterize behavior and identify some
of the bottlenecks.

Pending:

- Handle corner case where the peer name is very long
- Tweak code to avoid trailing whitespace on the first line

Change-Id: I29eb55561d969fc9807cafa894a7fc64658d17d4
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21317
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21317
Committed: http://github.org/Juniper/contrail-controller/commit/632919a28c7563ffb55f570c529b5bdc7217a9d9
Submitter: Zuul
Branch: master

commit 632919a28c7563ffb55f570c529b5bdc7217a9d9
Author: Nischal Sheth <email address hidden>
Date: Mon Jun 20 09:18:19 2016 -0700

Minor changes to xmpp update message build code

Following changes are implemented:

- Handle corner case where the peer name is very long
- Avoid trailing whitespace on the first line

Change-Id: Ie09e597abd79ad0cf9fc629b63211922520c59b2
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21365
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21283
Committed: http://github.org/Juniper/contrail-controller/commit/162b8d871574a1c76562a8d872dec31bfb03cdf3
Submitter: Zuul
Branch: R3.0

commit 162b8d871574a1c76562a8d872dec31bfb03cdf3
Author: Nischal Sheth <email address hidden>
Date: Tue Jun 7 15:29:49 2016 -0700

Optimize build of xmpp udpate messages

Sending a set of routes to multiple xmpp peers becomes quite expensive
if some of the peers get blocked. The same route has to be encoded in
xml string format multiple times. Alleviate this by caching the string
representation in the RibOutAttr and using it if available. The xml
string is cached only if there are one or more blocked peers in RibOut
i.e. only if it's going to be used later on when building another xmpp
message.

It's quite common to build an xmpp message and send to multiple peers.
String operations to build a new message with a different to attribute
are pretty expensive. Reuse the same message by selectively replacing
the first line.

Need to hand code xml generation for message, event and items to achieve
the above. However, those are pretty static - xml for each item is still
generated by building a document and calling pugi library print method.
Use a custom xml_writer to append to string representation of message.
This helps avoid unnecessary intermediate steps of writing to a stream
and converting the stream to a string.

Add test code that was used to characterize behavior and identify some
of the bottlenecks.

Pending:

- Handle corner case where the peer name is very long
- Tweak code to avoid trailing whitespace on the first line

Change-Id: I29eb55561d969fc9807cafa894a7fc64658d17d4
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21234
Committed: http://github.org/Juniper/contrail-controller/commit/4cc1ba5b3e80def08f08b8be27eaea015a105f57
Submitter: Zuul
Branch: R3.0

commit 4cc1ba5b3e80def08f08b8be27eaea015a105f57
Author: Nischal Sheth <email address hidden>
Date: Wed Jun 15 09:17:10 2016 -0700

Ensure that reach and unreach items go in separate xmpp messages

Change-Id: Idb0d59df3bd7258b79bb5525c5e05560de60abd8
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21445
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21445
Committed: http://github.org/Juniper/contrail-controller/commit/e445d59bb712a5af6a6e12787f4c2deebc8cd700
Submitter: Zuul
Branch: R3.0

commit e445d59bb712a5af6a6e12787f4c2deebc8cd700
Author: Nischal Sheth <email address hidden>
Date: Mon Jun 20 09:18:19 2016 -0700

Minor changes to xmpp update message build code

Following changes are implemented:

- Handle corner case where the peer name is very long
- Avoid trailing whitespace on the first line

Change-Id: Ie09e597abd79ad0cf9fc629b63211922520c59b2
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21365
Committed: http://github.org/Juniper/contrail-controller/commit/a740ee39b54c164b6f19c0323c36f5a01a431e65
Submitter: Zuul
Branch: master

commit a740ee39b54c164b6f19c0323c36f5a01a431e65
Author: Nischal Sheth <email address hidden>
Date: Mon Jun 20 16:55:16 2016 -0700

Coalesce multiple bgp updates into fewer socket writes

Change-Id: Ia746a0eb8789b944542adce40d0783595892d648
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21737
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21746
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21747
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21737
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21748
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21747
Committed: http://github.org/Juniper/contrail-controller/commit/68b8d2816c57db6ccf2daeac0ddd8bde88e0fdad
Submitter: Zuul
Branch: master

commit 68b8d2816c57db6ccf2daeac0ddd8bde88e0fdad
Author: Nischal Sheth <email address hidden>
Date: Thu Jul 7 21:09:27 2016 -0700

Build xmpp message string once instead of twice

Change-Id: I8539fe04f3c1ceeef2d892cc423d9fee6d0ca570
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21748
Committed: http://github.org/Juniper/contrail-controller/commit/442ebe557d00f5978ffa6159bd4b7c5d73a733fe
Submitter: Zuul
Branch: master

commit 442ebe557d00f5978ffa6159bd4b7c5d73a733fe
Author: Nischal Sheth <email address hidden>
Date: Thu Jul 7 22:34:31 2016 -0700

Make bgp_xmpp_inetvpn_test more robust

Change-Id: I33a4cf65446d77db442c43922f1fb8f2a3ad59b6
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21774
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21775
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21774
Committed: http://github.org/Juniper/contrail-controller/commit/ed1e575393518d5be03fb019de9ed205bb830fbd
Submitter: Zuul
Branch: master

commit ed1e575393518d5be03fb019de9ed205bb830fbd
Author: Nischal Sheth <email address hidden>
Date: Fri Jul 8 15:55:37 2016 -0700

Cache xmpp string representation of routes

Change-Id: Ia50aeda2fcb00b7248c871fbf088e60a325aae2b
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21775
Committed: http://github.org/Juniper/contrail-controller/commit/61b9568bbf590fd2c1896115e027a822c5a7ee6a
Submitter: Zuul
Branch: R3.0

commit 61b9568bbf590fd2c1896115e027a822c5a7ee6a
Author: Nischal Sheth <email address hidden>
Date: Fri Jul 8 15:55:37 2016 -0700

Cache xmpp string representation of routes

Change-Id: Ia50aeda2fcb00b7248c871fbf088e60a325aae2b
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21737
Committed: http://github.org/Juniper/contrail-controller/commit/1fd68637deaf38cee28292b294ee7ade8f044ffb
Submitter: Zuul
Branch: R3.0

commit 1fd68637deaf38cee28292b294ee7ade8f044ffb
Author: Nischal Sheth <email address hidden>
Date: Mon Jun 20 16:55:16 2016 -0700

Coalesce multiple bgp updates into fewer socket writes

Change-Id: Ia746a0eb8789b944542adce40d0783595892d648
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21746
Committed: http://github.org/Juniper/contrail-controller/commit/84fedba5acbe6945af003192c0557182e4c6e93d
Submitter: Zuul
Branch: R3.0

commit 84fedba5acbe6945af003192c0557182e4c6e93d
Author: Nischal Sheth <email address hidden>
Date: Thu Jul 7 21:09:27 2016 -0700

Build xmpp message string once instead of twice

Change-Id: I8539fe04f3c1ceeef2d892cc423d9fee6d0ca570
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21828
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21830
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21847
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21848
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21879
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/21880
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21880
Committed: http://github.org/Juniper/contrail-controller/commit/2994dc1512a9ba644515a722c0241f296bc4ab38
Submitter: Zuul
Branch: R3.1

commit 2994dc1512a9ba644515a722c0241f296bc4ab38
Author: Nischal Sheth <email address hidden>
Date: Fri Jul 1 09:46:30 2016 -0700

Reduce number of XmppPeer UVE updates

Change-Id: I5d1047b28d37cbcdd258d3ceee0f2f6dc7853ab8
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21879
Committed: http://github.org/Juniper/contrail-controller/commit/a3d31316526c25391c1305c34c0c6f406d5a1d45
Submitter: Zuul
Branch: R3.1

commit a3d31316526c25391c1305c34c0c6f406d5a1d45
Author: Nischal Sheth <email address hidden>
Date: Mon Jul 11 11:18:05 2016 -0700

Minor optimizations to speed up bgp and xmpp updates

Following changes are implemented:

- Cache string representation for BgpPeer ToString and ToUVEKey
- Cache string representation for InetRoute and Inet6Route ToString
- Cache string representation for XmppConnection ToUVEKey
- Implement MacAddress::ToString more efficiently

Change-Id: I3ccbe47e77ab303c7744636415a89b4b8d0763e1
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21828
Committed: http://github.org/Juniper/contrail-controller/commit/be832b008262765158945958434de34115af6a13
Submitter: Zuul
Branch: master

commit be832b008262765158945958434de34115af6a13
Author: Nischal Sheth <email address hidden>
Date: Mon Jul 11 11:18:05 2016 -0700

Minor optimizations to speed up bgp and xmpp updates

Following changes are implemented:

- Cache string representation for BgpPeer ToString and ToUVEKey
- Cache string representation for InetRoute and Inet6Route ToString
- Cache string representation for XmppConnection ToUVEKey
- Implement MacAddress::ToString more efficiently

Change-Id: I3ccbe47e77ab303c7744636415a89b4b8d0763e1
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21847
Committed: http://github.org/Juniper/contrail-controller/commit/6bc25ad8be3e03eb830658d936265163be237a5b
Submitter: Zuul
Branch: master

commit 6bc25ad8be3e03eb830658d936265163be237a5b
Author: Nischal Sheth <email address hidden>
Date: Fri Jul 1 09:46:30 2016 -0700

Reduce number of XmppPeer UVE updates

Change-Id: I5d1047b28d37cbcdd258d3ceee0f2f6dc7853ab8
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21830
Committed: http://github.org/Juniper/contrail-controller/commit/944f05d329b093c18810d3c5e6828d5efee0f3f9
Submitter: Zuul
Branch: R3.0

commit 944f05d329b093c18810d3c5e6828d5efee0f3f9
Author: Nischal Sheth <email address hidden>
Date: Mon Jul 11 11:18:05 2016 -0700

Minor optimizations to speed up bgp and xmpp updates

Following changes are implemented:

- Cache string representation for BgpPeer ToString and ToUVEKey
- Cache string representation for InetRoute and Inet6Route ToString
- Cache string representation for XmppConnection ToUVEKey
- Implement MacAddress::ToString more efficiently

Change-Id: I3ccbe47e77ab303c7744636415a89b4b8d0763e1
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/21848
Committed: http://github.org/Juniper/contrail-controller/commit/650d5351f48bc6c8025a681956c3c428d1090256
Submitter: Zuul
Branch: R3.0

commit 650d5351f48bc6c8025a681956c3c428d1090256
Author: Nischal Sheth <email address hidden>
Date: Fri Jul 1 09:46:30 2016 -0700

Reduce number of XmppPeer UVE updates

Change-Id: I5d1047b28d37cbcdd258d3ceee0f2f6dc7853ab8
Partial-Bug: 1591399

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/23266
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/23267
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Review in progress for https://review.opencontrail.org/23268
Submitter: Nischal Sheth (<email address hidden>)

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/23267
Committed: http://github.org/Juniper/contrail-controller/commit/11de0f74b8e08f969188a05764ec53f1ebf2adf9
Submitter: Zuul
Branch: R3.1

commit 11de0f74b8e08f969188a05764ec53f1ebf2adf9
Author: Nischal Sheth <email address hidden>
Date: Fri Aug 12 12:06:44 2016 -0700

Retain unique route attributes when packing into a xmpp message

This bug is a regression introduced by changes made for bug 1591399.

Since an xmpp message now contains routes with different attributes,
Community and ExtCommunity need to processed for each route that is
added to the message. Otherwise, all routes that get packed into a
message will accidentally be advertised with some of the attributes
of the first route in the message.

Change-Id: Id34e32e3ff106e97c2536b1d0a72772387ca6a76
Closes-Bug: 1612766

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/23268
Committed: http://github.org/Juniper/contrail-controller/commit/9d0df2907eae554b0b778241580a1bd0476eff9c
Submitter: Zuul
Branch: R3.0

commit 9d0df2907eae554b0b778241580a1bd0476eff9c
Author: Nischal Sheth <email address hidden>
Date: Fri Aug 12 12:06:44 2016 -0700

Retain unique route attributes when packing into a xmpp message

This bug is a regression introduced by changes made for bug 1591399.

Since an xmpp message now contains routes with different attributes,
Community and ExtCommunity need to processed for each route that is
added to the message. Otherwise, all routes that get packed into a
message will accidentally be advertised with some of the attributes
of the first route in the message.

Change-Id: Id34e32e3ff106e97c2536b1d0a72772387ca6a76
Closes-Bug: 1612766

[OpenContrail Admin (ci-admin-f)]

Reviewed: https://review.opencontrail.org/23266
Committed: http://github.org/Juniper/contrail-controller/commit/0699c839b2fdde08246792c820eef186bce7f98b
Submitter: Zuul
Branch: master

commit 0699c839b2fdde08246792c820eef186bce7f98b
Author: Nischal Sheth <email address hidden>
Date: Fri Aug 12 12:06:44 2016 -0700

Retain unique route attributes when packing into a xmpp message

This bug is a regression introduced by changes made for bug 1591399.

Since an xmpp message now contains routes with different attributes,
Community and ExtCommunity need to processed for each route that is
added to the message. Otherwise, all routes that get packed into a
message will accidentally be advertised with some of the attributes
of the first route in the message.

Change-Id: Id34e32e3ff106e97c2536b1d0a72772387ca6a76
Closes-Bug: 1612766