aboutsummaryrefslogtreecommitdiffstats
path: root/tests/suites/vxlan
diff options
context:
space:
mode:
authorMaciek Konstantynowicz <mkonstan@cisco.com>2016-06-15 21:33:16 +0100
committerJan Gelety <jgelety@cisco.com>2016-06-21 18:23:03 +0000
commit705bd0718ee4181b75664b30338b333e8ec2a0c6 (patch)
tree731fcb17f75d436bef9615b539ae548741bec87e /tests/suites/vxlan
parent2e8c182a71cceb2ae8a9b785c46b62eb1932c72e (diff)
Suite: vxlan.
Files: vxlan_xconnect_untagged.robot, vxlan_bd_untagged.robot, vxlan_bd_dot1q.robot. Updated test cases names and test cases documentation. Change-Id: Ic1729b694466c5f4e703d2d799aca364e0962be0 Signed-off-by: Maciek Konstantynowicz <mkonstan@cisco.com>
Diffstat (limited to 'tests/suites/vxlan')
-rw-r--r--tests/suites/vxlan/vxlan_bd_dot1q.robot25
-rw-r--r--tests/suites/vxlan/vxlan_bd_untagged.robot127
-rw-r--r--tests/suites/vxlan/vxlan_xconnect_untagged.robot24
3 files changed, 129 insertions, 47 deletions
diff --git a/tests/suites/vxlan/vxlan_bd_dot1q.robot b/tests/suites/vxlan/vxlan_bd_dot1q.robot
index 7f4dc8a9fd..d8253f2dec 100644
--- a/tests/suites/vxlan/vxlan_bd_dot1q.robot
+++ b/tests/suites/vxlan/vxlan_bd_dot1q.robot
@@ -12,7 +12,6 @@
# limitations under the License.
*** Settings ***
-| Documentation | VXLAN tunnel over Dot1Q tagged IPv4 traffic tests using bridge domain.
| Resource | resources/libraries/robot/default.robot
| Resource | resources/libraries/robot/testing_path.robot
| Resource | resources/libraries/robot/vxlan.robot
@@ -22,6 +21,21 @@
| Test Setup | Run Keywords | Setup all DUTs before test
| ... | AND | Setup all TGs before traffic script
| Test Teardown | Show Packet Trace on All DUTs | ${nodes}
+| Documentation | *RFC7348 VXLAN: Bridge-domain with VXLAN over VLAN test cases*
+| ...
+| ... | *[Top] Network topologies:* TG-DUT1-DUT2-TG 3-node circular topology with
+| ... | single links between nodes.
+| ... | *[Enc] Packet encapsulations:* Eth-dot1q-IPv4-VXLAN-Eth-IPv4-ICMPv4 on
+| ... | DUT1-DUT2, Eth-dot1q-IPv4-ICMPv4 on TG-DUTn for L2 switching of IPv4.
+| ... | *[Cfg] DUT configuration:* DUT1 and DUT2 are configured with L2
+| ... | bridge-domain (L2BD) switching combined with static MACs, MAC learning
+| ... | enabled and Split Horizon Groups (SHG) depending on test case; VXLAN
+| ... | tunnels are configured between L2BDs on DUT1 and DUT2.
+| ... | *[Ver] TG verification:* Test ICMPv4 Echo Request packets are
+| ... | sent in both directions by TG on links to DUT1 and DUT2; on receive TG
+| ... | verifies packets for correctness and their IPv4 src-addr, dst-addr and
+| ... | MAC addresses.
+| ... | *[Ref] Applicable standard specifications:* RFC7348.
*** Variables ***
| ${VNI}= | 23
@@ -29,7 +43,14 @@
| ${VLAN}= | 10
*** Test Cases ***
-| VPP can encapsulate L2 in VXLAN over IPv4 over Dot1Q
+| TC01: DUT1 and DUT2 with L2BD and VXLANoIPv4oVLAN tunnels switch ICMPv4 between TG links
+| | [Documentation]
+| | ... | [Top] TG-DUT1-DUT2-TG. [Enc] Eth-dot1q-IPv4-VXLAN-Eth-IPv4-ICMPv4 on\
+| | ... | DUT1-DUT2; Eth-IPv4-ICMPv4 on TG-DUTn. [Cfg] On DUT1 and DUT2
+| | ... | configure L2 bridge-domain (MAC learning enabled), each with one
+| | ... | interface to TG and one VXLAN tunnel interface towards the other DUT
+| | ... | over VLAN sub-interface. [Ver] Make TG send ICMPv4 Echo Req between
+| | ... | two of its interfaces, verify all packets are received. [Ref] RFC7348.
| | Given Path for 3-node testing is set
| | ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['DUT2']} | ${nodes['TG']}
| | And Interfaces in 3-node path are up
diff --git a/tests/suites/vxlan/vxlan_bd_untagged.robot b/tests/suites/vxlan/vxlan_bd_untagged.robot
index 63328b3e01..ec857adb38 100644
--- a/tests/suites/vxlan/vxlan_bd_untagged.robot
+++ b/tests/suites/vxlan/vxlan_bd_untagged.robot
@@ -12,7 +12,6 @@
# limitations under the License.
*** Settings ***
-| Documentation | VXLAN tunnel over untagged IPv4 traffic tests using bridge domain.
| Resource | resources/libraries/robot/default.robot
| Resource | resources/libraries/robot/testing_path.robot
| Resource | resources/libraries/robot/vxlan.robot
@@ -22,6 +21,24 @@
| Test Setup | Run Keywords | Setup all DUTs before test
| ... | AND | Setup all TGs before traffic script
| Test Teardown | Show Packet Trace on All DUTs | ${nodes}
+| Documentation | *RFC7348 VXLAN: Bridge-domain with VXLAN test cases*
+| ...
+| ... | *[Top] Network topologies:* TG-DUT1-DUT2-TG 3-node circular topology
+| ... | with single links between nodes; TG=DUT1=DUT2=TG 3-node circular
+| ... | topology with double parallel links.
+| ... | *[Enc] Packet encapsulations:* Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on
+| ... | DUT1-DUT2, Eth-IPv4-ICMPv4 on TG-DUTn for L2 switching of IPv4;
+| ... | Eth-IPv6-VXLAN-Eth-IPv6-ICMPv6 on DUT1-DUT2, Eth-IPv6-ICMPv6 on
+| ... | TG-DUTn for L2 switching of IPv6.
+| ... | *[Cfg] DUT configuration:* DUT1 and DUT2 are configured with L2
+| ... | bridge-domain (L2BD) switching combined with static MACs, MAC learning
+| ... | enabled and Split Horizon Groups (SHG) depending on test case; VXLAN
+| ... | tunnels are configured between L2BDs on DUT1 and DUT2.
+| ... | *[Ver] TG verification:* Test ICMPv4 (or ICMPv6) Echo Request packets
+| ... | are sent in both directions by TG on links to DUT1 and DUT2; on receive
+| ... | TG verifies packets for correctness and their IPv4 (IPv6) src-addr,
+| ... | dst-addr and MAC addresses.
+| ... | *[Ref] Applicable standard specifications:* RFC7348.
*** Variables ***
| ${vni_1}= | 23
@@ -42,11 +59,13 @@
| ${ip6_prefix}= | 64
*** Test Cases ***
-| VPP can pass IPv4 bidirectionally through VXLAN using bridge domain
-| | [Documentation] | Create VXLAN interface on both VPP nodes. Create one
-| | ... | bridge domain (learning enabled) on both VPP nodes, add
-| | ... | VXLAN interface and interface toward TG to bridge domains
-| | ... | and check traffic bidirectionally.
+| TC01: DUT1 and DUT2 with L2BD and VXLANoIPv4 tunnels switch ICMPv4 between TG links
+| | [Documentation]
+| | ... | [Top] TG-DUT1-DUT2-TG. [Enc] Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on \
+| | ... | DUT1-DUT2; Eth-IPv4-ICMPv4 on TG-DUTn. [Cfg] On DUT1 and DUT2
+| | ... | configure two i/fs into L2BD with MAC learning. [Ver] Make TG
+| | ... | verify ICMPv4 Echo Req pkts are switched thru DUT1 and DUT2 in
+| | ... | both directions and are correct on receive. [Ref] RFC7348.
| | Given Path for 3-node testing is set
| | ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['DUT2']} | ${nodes['TG']}
| | And Interfaces in 3-node path are up
@@ -63,14 +82,19 @@
| | Then Send and receive ICMPv4 bidirectionally
| | ... | ${tg_node} | ${tg_to_dut1} | ${tg_to_dut2}
-| Vpp forwards ICMPv4 packets through VXLAN tunnels in the same split-horizon group of one L2 bridge domain
-| | [Documentation] | Create two VXLAN interfaces on both VPP nodes. Create one
-| | ... | bridge domain (learning enabled) on the first VPP node,
-| | ... | add VXLAN interfaces to the same split-horizon group of
-| | ... | the bridge domain where interfaces toward TG are added to.
-| | ... | Create two bridge domains (learning enabled) on the second
-| | ... | VPP node and add one VXLAN interface and one interface
-| | ... | toward TG to each of them. Check traffic bidirectionally.
+| TC02: DUT1 and DUT2 with L2BD and VXLANoIPv4 tunnels in SHG switch ICMPv4 between TG links
+| | [Documentation]
+| | ... | [Top] TG=DUT1=DUT2=TG. [Enc] Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on \
+| | ... | DUT1-DUT2; Eth-IPv4-ICMPv4 on TG-DUTn. [Cfg] On DUT1 configure L2
+| | ... | bridge-domain (MAC learning enabled) with two untagged interfaces
+| | ... | to TG and two VXLAN interfaces towards the DUT2 and put both VXLAN
+| | ... | interfaces into the same Split-Horizon-Group (SHG). On DUT2 configure
+| | ... | two L2 bridge-domain (MAC learning enabled), each with one untagged
+| | ... | interface to TG and one VXLAN interface towards the DUT1. [Ver] Make
+| | ... | TG send ICMPv4 Echo Reqs between all four of its interfaces to be
+| | ... | switched by DUT1 and DUT2; verify packets are not switched between
+| | ... | TG interfaces connected to DUT2 that are isolated by SHG on DUT1.
+| | ... | [Ref] RFC7348.
| | [Tags] | 3_NODE_DOUBLE_LINK_TOPO
| | Given Path for 3-node BD-SHG testing is set | ${nodes['TG']}
| | ... | ${nodes['DUT1']}
@@ -132,14 +156,18 @@
| | | ... | ${tg_node} | ${tg_to_dut2_if1}
| | | ... | ${tg_to_dut2_if2}
-| Vpp forwards ICMPv4 packets through VXLAN tunnels in different split-horizon groups of one L2 bridge domain
-| | [Documentation] | Create two VXLAN interfaces on both VPP nodes. Create one
-| | ... | bridge domain (learning enabled) on the first VPP node,
-| | ... | add VXLAN interfaces to different split-horizon groups of
-| | ... | the bridge domain where interfaces toward TG are added to.
-| | ... | Create two bridge domains (learning enabled) on the second
-| | ... | VPP node and add one VXLAN interface and one interface
-| | ... | toward TG to each of them. Check traffic bidirectionally.
+| TC03: DUT1 and DUT2 with L2BD and VXLANoIPv4 tunnels in different SHGs switch ICMPv4 between TG links
+| | [Documentation]
+| | ... | [Top] TG=DUT1=DUT2=TG.[Enc] Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on \
+| | ... | DUT1-DUT2; Eth-IPv4-ICMPv4 on TG-DUTn. [Cfg] On DUT1 configure L2
+| | ... | bridge-domain (MAC learning enabled) with two untagged interfaces
+| | ... | to TG and two VXLAN interfaces towards the DUT2 and put both VXLAN
+| | ... | interfaces into the different Split-Horizon-Group (SHGs). On DUT2
+| | ... | configure two L2 bridge-domain (MAC learning enabled), each with one
+| | ... | untagged interface to TG and one VXLAN interface towards the DUT1.
+| | ... | [Ver] Make TG send ICMPv4 Echo Req between all four of its interfaces
+| | ... | to be switched by DUT1 and DUT2; verify packets are switched between
+| | ... | all TG interfaces. [Ref] RFC7348.
| | [Tags] | 3_NODE_DOUBLE_LINK_TOPO
| | Given Path for 3-node BD-SHG testing is set | ${nodes['TG']}
| | ... | ${nodes['DUT1']}
@@ -200,11 +228,15 @@
| | ... | ${tg_to_dut2_if1}
| | ... | ${tg_to_dut2_if2}
-| VPP can pass IPv6 bidirectionally through VXLAN using bridge domain
-| | [Documentation] | Create VXLAN interface on both VPP nodes. Create one
-| | ... | bridge domain (learning enabled) on both VPP nodes, add
-| | ... | VXLAN interface and interface toward TG to bridge domains
-| | ... | and check traffic bidirectionally.
+| TC04: DUT1 and DUT2 with L2BD and VXLANoIPv6 tunnels switch ICMPv6 between TG links
+| | [Documentation]
+| | ... | [Top] TG=DUT1=DUT2=TG.[Enc] Eth-IPv6-VXLAN-Eth-IPv6-ICMPv6 on \
+| | ... | DUT1-DUT2, Eth-IPv6-ICMPv6 on TG-DUTn. [Cfg] On DUT1 and DUT2
+| | ... | configure L2 bridge-domain (MAC learning enabled), each with one
+| | ... | interface to TG and one VXLAN tunnel interface towards the other
+| | ... | DUT. [Ver] Make TG send ICMPv6 Echo Req between two of its
+| | ... | interfaces to be switched by DUT1 and DUT2; verify all packets
+| | ... | are received. [Ref] RFC7348.
| | [Tags] | 3_NODE_DOUBLE_LINK_TOPO
| | Given Path for 3-node testing is set
| | ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['DUT2']} | ${nodes['TG']}
@@ -226,14 +258,19 @@
| | Then Send and receive ICMPv6 bidirectionally
| | ... | ${tg_node} | ${tg_to_dut1} | ${tg_to_dut2}
-| Vpp forwards ICMPv6 packets through VXLAN tunnels in the same split-horizon group of one L2 bridge domain
-| | [Documentation] | Create two VXLAN interfaces on both VPP nodes. Create one
-| | ... | bridge domain (learning enabled) on the first VPP node,
-| | ... | add VXLAN interfaces to the same split-horizon group of
-| | ... | the bridge domain where interfaces toward TG are added to.
-| | ... | Create two bridge domains (learning enabled) on the second
-| | ... | VPP node and add one VXLAN interface and one interface
-| | ... | toward TG to each of them. Check traffic bidirectionally.
+| TC05: DUT1 and DUT2 with L2BD and VXLANoIPv6 tunnels in SHG switch ICMPv6 between TG links
+| | [Documentation]
+| | ... | [Top] TG=DUT1=DUT2=TG. [Enc] Eth-IPv6-VXLAN-Eth-IPv6-ICMPv6 on \
+| | ... | DUT1-DUT2; Eth-IPv6-ICMPv6 on TG-DUTn. [Cfg] On DUT1 configure L2
+| | ... | bridge-domain (MAC learning enabled) with two untagged interfaces
+| | ... | to TG and two VXLAN interfaces towards the DUT2 and put both VXLAN
+| | ... | interfaces into the same Split-Horizon-Group (SHG). On DUT2 configure
+| | ... | two L2 bridge-domain (MAC learning enabled), each with one untagged
+| | ... | interface to TG and one VXLAN interface towards the DUT1. [Ver] Make
+| | ... | TG send ICMPv6 Echo Reqs between all four of its interfaces to be
+| | ... | switched by DUT1 and DUT2; verify packets are not switched between
+| | ... | TG interfaces connected to DUT2 that are isolated by SHG on DUT1.
+| | ... | [Ref] RFC7348.
| | [Tags] | 3_NODE_DOUBLE_LINK_TOPO
| | Given Path for 3-node BD-SHG testing is set | ${nodes['TG']}
| | ... | ${nodes['DUT1']}
@@ -295,14 +332,18 @@
| | | ... | ${tg_node} | ${tg_to_dut2_if1}
| | | ... | ${tg_to_dut2_if2}
-| Vpp forwards ICMPv6 packets through VXLAN tunnels in different split-horizon groups of one L2 bridge domain
-| | [Documentation] | Create two VXLAN interfaces on both VPP nodes. Create one
-| | ... | bridge domain (learning enabled) on the first VPP node,
-| | ... | add VXLAN interfaces to different split-horizon groups of
-| | ... | the bridge domain where interfaces toward TG are added to.
-| | ... | Create two bridge domains (learning enabled) on the second
-| | ... | VPP node and add one VXLAN interface and one interface
-| | ... | toward TG to each of them. Check traffic bidirectionally.
+| TC06: DUT1 and DUT2 with L2BD and VXLANoIPv6 tunnels in different SHGs switch ICMPv6 between TG links
+| | [Documentation]
+| | ... | [Top] TG=DUT1=DUT2=TG.[Enc] Eth-IPv6-VXLAN-Eth-IPv6-ICMPv6 on \
+| | ... | DUT1-DUT2; Eth-IPv6-ICMPv6 on TG-DUTn. [Cfg] On DUT1 configure L2
+| | ... | bridge-domain (MAC learning enabled) with two untagged interfaces
+| | ... | to TG and two VXLAN interfaces towards the DUT2 and put both VXLAN
+| | ... | interfaces into the different Split-Horizon-Group (SHGs). On DUT2
+| | ... | configure two L2 bridge-domain (MAC learning enabled), each with one
+| | ... | untagged interface to TG and one VXLAN interface towards the DUT1.
+| | ... | [Ver] Make TG send ICMPv6 Echo Req between all four of its interfaces
+| | ... | to be switched by DUT1 and DUT2; verify packets are switched between
+| | ... | all TG interfaces. [Ref] RFC7348.
| | [Tags] | 3_NODE_DOUBLE_LINK_TOPO
| | Given Path for 3-node BD-SHG testing is set | ${nodes['TG']}
| | ... | ${nodes['DUT1']}
diff --git a/tests/suites/vxlan/vxlan_xconnect_untagged.robot b/tests/suites/vxlan/vxlan_xconnect_untagged.robot
index 5c52664c1c..a4aa0610cf 100644
--- a/tests/suites/vxlan/vxlan_xconnect_untagged.robot
+++ b/tests/suites/vxlan/vxlan_xconnect_untagged.robot
@@ -12,7 +12,6 @@
# limitations under the License.
*** Settings ***
-| Documentation | VXLAN tunnel over untagged IPv4 traffic tests using xconnect.
| Resource | resources/libraries/robot/default.robot
| Resource | resources/libraries/robot/testing_path.robot
| Resource | resources/libraries/robot/vxlan.robot
@@ -22,12 +21,33 @@
| Test Setup | Run Keywords | Setup all DUTs before test
| ... | AND | Setup all TGs before traffic script
| Test Teardown | Show Packet Trace on All DUTs | ${nodes}
+| Documentation | *RFC7348 VXLAN: L2 cross-connect with VXLAN test cases*
+| ...
+| ... | *[Top] Network topologies:* TG-DUT1-DUT2-TG 3-node circular topology
+| ... | with single links between nodes.
+| ... | *[Enc] Packet encapsulations:* Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on
+| ... | DUT1-DUT2, Eth-IPv4-ICMPv4 on TG-DUTn for L2 switching of IPv4.
+| ... | *[Cfg] DUT configuration:* DUT1 and DUT2 are configured with L2
+| ... | cross-connect (L2XC) switching; VXLAN tunnels are configured between
+| ... | L2XCs on DUT1 and DUT2.
+| ... | *[Ver] TG verification:* Test ICMPv4 Echo Request packets
+| ... | are sent in both directions by TG on links to DUT1 and DUT2; on receive
+| ... | TG verifies packets for correctness and their IPv4 src-addr, dst-addr
+| ... | and MAC addresses.
+| ... | *[Ref] Applicable standard specifications:* RFC7348.
*** Variables ***
| ${VNI}= | 24
*** Test Cases ***
-| VPP can pass IPv4 bidirectionally through VXLAN
+| TC01: DUT1 and DUT2 with L2XC and VXLANoIPv4 tunnels switch ICMPv4 between TG links
+| | [Documentation]
+| | ... | [Top] TG-DUT1-DUT2-TG. [Enc] Eth-IPv4-VXLAN-Eth-IPv4-ICMPv4 on \
+| | ... | [Ref] RFC7348.DUT1-DUT2, Eth-IPv4-ICMPv4 on TG-DUTn. [Cfg] On
+| | ... | DUT1 and DUT2 configure L2 cross-connect (L2XC), each with one
+| | ... | interface to TG and one VXLAN tunnel interface towards the other
+| | ... | DUT. [Ver] Make TG send ICMPv4 Echo Req between two of its
+| | ... | interfaces; verify all packets are received. [Ref] RFC7348.
| | Given Path for 3-node testing is set
| | ... | ${nodes['TG']} | ${nodes['DUT1']} | ${nodes['DUT2']} | ${nodes['TG']}
| | And Interfaces in 3-node path are up
an class="mi">1); } always_inline void pool_header_validate_index (void *v, uword index) { pool_header_t *p = pool_header (v); if (v) vec_validate (p->free_bitmap, index / BITS (uword)); } #define pool_validate_index(v,i) \ do { \ uword __pool_validate_index = (i); \ vec_validate_ha ((v), __pool_validate_index, \ pool_aligned_header_bytes, /* align */ 0); \ pool_header_validate_index ((v), __pool_validate_index); \ } while (0) /** Number of active elements in a pool. * @return Number of active elements in a pool */ always_inline uword pool_elts (void *v) { uword ret = vec_len (v); if (v) ret -= vec_len (pool_header (v)->free_indices); return ret; } /** Number of elements in pool vector. @note You probably want to call pool_elts() instead. */ #define pool_len(p) vec_len(p) /** Number of elements in pool vector (usable as an lvalue) @note You probably don't want to use this macro. */ #define _pool_len(p) _vec_len(p) /** Memory usage of pool header. */ always_inline uword pool_header_bytes (void *v) { pool_header_t *p = pool_header (v); if (!v) return 0; return vec_bytes (p->free_bitmap) + vec_bytes (p->free_indices); } /** Memory usage of pool. */ #define pool_bytes(P) (vec_bytes (P) + pool_header_bytes (P)) /** Local variable naming macro. */ #define _pool_var(v) _pool_##v /** Queries whether pool has at least N_FREE free elements. */ always_inline uword pool_free_elts (void *v) { pool_header_t *p = pool_header (v); uword n_free = 0; if (v) { n_free += vec_len (p->free_indices); /* Space left at end of vector? */ n_free += vec_capacity (v, sizeof (p[0])) - vec_len (v); } return n_free; } /** Allocate an object E from a pool P (general version). First search free list. If nothing is free extend vector of objects. */ #define pool_get_aligned(P,E,A) \ do { \ pool_header_t * _pool_var (p) = pool_header (P); \ uword _pool_var (l); \ \ _pool_var (l) = 0; \ if (P) \ _pool_var (l) = vec_len (_pool_var (p)->free_indices); \ \ if (_pool_var (l) > 0) \ { \ /* Return free element from free list. */ \ uword _pool_var (i) = _pool_var (p)->free_indices[_pool_var (l) - 1]; \ (E) = (P) + _pool_var (i); \ _pool_var (p)->free_bitmap = \ clib_bitmap_andnoti (_pool_var (p)->free_bitmap, _pool_var (i)); \ _vec_len (_pool_var (p)->free_indices) = _pool_var (l) - 1; \ } \ else \ { \ /* fixed-size, preallocated pools cannot expand */ \ if ((P) && _pool_var(p)->max_elts) \ { \ clib_warning ("can't expand fixed-size pool"); \ os_out_of_memory(); \ } \ /* Nothing on free list, make a new element and return it. */ \ P = _vec_resize (P, \ /* length_increment */ 1, \ /* new size */ (vec_len (P) + 1) * sizeof (P[0]), \ pool_aligned_header_bytes, \ /* align */ (A)); \ E = vec_end (P) - 1; \ } \ } while (0) /** Allocate an object E from a pool P (unspecified alignment). */ #define pool_get(P,E) pool_get_aligned(P,E,0) /** See if pool_get will expand the pool or not */ #define pool_get_aligned_will_expand(P,YESNO,A) \ do { \ pool_header_t * _pool_var (p) = pool_header (P); \ uword _pool_var (l); \ \ _pool_var (l) = 0; \ if (P) \ { \ if (_pool_var (p)->max_elts) \ return 0; \ _pool_var (l) = vec_len (_pool_var (p)->free_indices); \ } \ \ /* Free elements, certainly won't expand */ \ if (_pool_var (l) > 0) \ YESNO=0; \ else \ { \ /* Nothing on free list, make a new element and return it. */ \ YESNO = _vec_resize_will_expand \ (P, \ /* length_increment */ 1, \ /* new size */ (vec_len (P) + 1) * sizeof (P[0]), \ pool_aligned_header_bytes, \ /* align */ (A)); \ } \ } while (0) #define pool_get_will_expand(P,YESNO) pool_get_aligned_will_expand(P,YESNO,0) /** Use free bitmap to query whether given element is free. */ #define pool_is_free(P,E) \ ({ \ pool_header_t * _pool_var (p) = pool_header (P); \ uword _pool_var (i) = (E) - (P); \ (_pool_var (i) < vec_len (P)) ? clib_bitmap_get (_pool_var (p)->free_bitmap, _pool_i) : 1; \ }) /** Use free bitmap to query whether given index is free */ #define pool_is_free_index(P,I) pool_is_free((P),(P)+(I)) /** Free an object E in pool P. */ #define pool_put(P,E) \ do { \ pool_header_t * _pool_var (p) = pool_header (P); \ uword _pool_var (l) = (E) - (P); \ ASSERT (vec_is_member (P, E)); \ ASSERT (! pool_is_free (P, E)); \ \ /* Add element to free bitmap and to free list. */ \ _pool_var (p)->free_bitmap = \ clib_bitmap_ori (_pool_var (p)->free_bitmap, _pool_var (l)); \ /* Preallocated pool? */ \ if (_pool_var (p)->max_elts) \ { \ ASSERT(_pool_var(l) < _pool_var (p)->max_elts); \ _pool_var(p)->free_indices[_vec_len(_pool_var(p)->free_indices)] = \ _pool_var(l); \ _vec_len(_pool_var(p)->free_indices) += 1; \ } \ else \ vec_add1 (_pool_var (p)->free_indices, _pool_var (l)); \ } while (0) /** Free pool element with given index. */ #define pool_put_index(p,i) \ do { \ typeof (p) _e = (p) + (i); \ pool_put (p, _e); \ } while (0) /** Allocate N more free elements to pool (general version). */ #define pool_alloc_aligned(P,N,A) \ do { \ pool_header_t * _p; \ \ if ((P)) \ { \ _p = pool_header (P); \ if (_p->max_elts) \ { \ clib_warning ("Can't expand fixed-size pool"); \ os_out_of_memory(); \ } \ } \ \ (P) = _vec_resize ((P), 0, (vec_len (P) + (N)) * sizeof (P[0]), \ pool_aligned_header_bytes, \ (A)); \ _p = pool_header (P); \ vec_resize (_p->free_indices, (N)); \ _vec_len (_p->free_indices) -= (N); \ } while (0) /** Allocate N more free elements to pool (unspecified alignment). */ #define pool_alloc(P,N) pool_alloc_aligned(P,N,0) /** Low-level free pool operator (do not call directly). */ always_inline void * _pool_free (void *v) { pool_header_t *p = pool_header (v); if (!v) return v; clib_bitmap_free (p->free_bitmap); if (p->max_elts) { int rv; rv = munmap (p->mmap_base, p->mmap_size); if (rv) clib_unix_warning ("munmap"); } else { vec_free (p->free_indices); vec_free_h (v, pool_aligned_header_bytes); } return 0; } /** Free a pool. */ #define pool_free(p) (p) = _pool_free(p) /** Optimized iteration through pool. @param LO pointer to first element in chunk @param HI pointer to last element in chunk @param POOL pool to iterate across @param BODY operation to perform Optimized version which assumes that BODY is smart enough to process multiple (LOW,HI) chunks. See also pool_foreach(). */ #define pool_foreach_region(LO,HI,POOL,BODY) \ do { \ uword _pool_var (i), _pool_var (lo), _pool_var (hi), _pool_var (len); \ uword _pool_var (bl), * _pool_var (b); \ pool_header_t * _pool_var (p); \ \ _pool_var (p) = pool_header (POOL); \ _pool_var (b) = (POOL) ? _pool_var (p)->free_bitmap : 0; \ _pool_var (bl) = vec_len (_pool_var (b)); \ _pool_var (len) = vec_len (POOL); \ _pool_var (lo) = 0; \ \ for (_pool_var (i) = 0; \ _pool_var (i) <= _pool_var (bl); \ _pool_var (i)++) \ { \ uword _pool_var (m), _pool_var (f); \ _pool_var (m) = (_pool_var (i) < _pool_var (bl) \ ? _pool_var (b) [_pool_var (i)] \ : 1); \ while (_pool_var (m) != 0) \ { \ _pool_var (f) = first_set (_pool_var (m)); \ _pool_var (hi) = (_pool_var (i) * BITS (_pool_var (b)[0]) \ + min_log2 (_pool_var (f))); \ _pool_var (hi) = (_pool_var (i) < _pool_var (bl) \ ? _pool_var (hi) : _pool_var (len)); \ _pool_var (m) ^= _pool_var (f); \ if (_pool_var (hi) > _pool_var (lo)) \ { \ (LO) = _pool_var (lo); \ (HI) = _pool_var (hi); \ do { BODY; } while (0); \ } \ _pool_var (lo) = _pool_var (hi) + 1; \ } \ } \ } while (0) /** Iterate through pool. @param VAR A variable of same type as pool vector to be used as an iterator. @param POOL The pool to iterate across. @param BODY The operation to perform, typically a code block. See the example below. This macro will call @c BODY with each active pool element. It is a bad idea to allocate or free pool element from within @c pool_foreach. Build a vector of indices and dispose of them later. Or call pool_flush. @par Example @code{.c} proc_t *procs; // a pool of processes. proc_t *proc; // pointer to one process; used as the iterator. pool_foreach (proc, procs, ({ if (proc->state != PROC_STATE_RUNNING) continue; // check a running proc in some way ... })); @endcode @warning Because @c pool_foreach is a macro, syntax errors can be difficult to find inside @c BODY, let alone actual code bugs. One can temporarily split a complex @c pool_foreach into a trivial @c pool_foreach which builds a vector of active indices, and a vec_foreach() (or plain for-loop) to walk the active index vector. */ #define pool_foreach(VAR,POOL,BODY) \ do { \ uword _pool_foreach_lo, _pool_foreach_hi; \ pool_foreach_region (_pool_foreach_lo, _pool_foreach_hi, (POOL), \ ({ \ for ((VAR) = (POOL) + _pool_foreach_lo; \ (VAR) < (POOL) + _pool_foreach_hi; \ (VAR)++) \ do { BODY; } while (0); \ })); \ } while (0) /** Returns pointer to element at given index. ASSERTs that the supplied index is valid. Even though one can write correct code of the form @code p = pool_base + index; @endcode use of @c pool_elt_at_index is strongly suggested. */ #define pool_elt_at_index(p,i) \ ({ \ typeof (p) _e = (p) + (i); \ ASSERT (! pool_is_free (p, _e)); \ _e; \ }) /** Return next occupied pool index after @c i, useful for safe iteration. */ #define pool_next_index(P,I) \ ({ \ pool_header_t * _pool_var (p) = pool_header (P); \ uword _pool_var (rv) = (I) + 1; \ \ _pool_var(rv) = \ (_pool_var (rv) < vec_len (P) ? \ clib_bitmap_next_clear (_pool_var (p)->free_bitmap, _pool_var(rv)) \ : ~0); \ _pool_var(rv); \ }) /** Iterate pool by index. */ #define pool_foreach_index(i,v,body) \ for ((i) = 0; (i) < vec_len (v); (i)++) \ { \ if (! pool_is_free_index ((v), (i))) \ do { body; } while (0); \ } /** * @brief Remove all elemenets from a pool in a safe way * * @param VAR each element in the pool * @param POOL The pool to flush * @param BODY The actions to perform on each element before it is returned to * the pool. i.e. before it is 'freed' */ #define pool_flush(VAR, POOL, BODY) \ { \ uword *_pool_var(ii), *_pool_var(dv) = NULL; \ \ pool_foreach((VAR), (POOL), \ ({ \ vec_add1(_pool_var(dv), (VAR) - (POOL)); \ })); \ vec_foreach(_pool_var(ii), _pool_var(dv)) \ { \ (VAR) = pool_elt_at_index((POOL), *_pool_var(ii)); \ do { BODY; } while (0); \ pool_put((POOL), (VAR)); \ } \ vec_free(_pool_var(dv)); \ } #endif /* included_pool_h */ /* * fd.io coding-style-patch-verification: ON * * Local Variables: * eval: (c-set-style "gnu") * End: */