2 * replication.h : packet replication
4 * Copyright (c) 2013 Cisco and/or its affiliates.
5 * Licensed under the Apache License, Version 2.0 (the "License");
6 * you may not use this file except in compliance with the License.
7 * You may obtain a copy of the License at:
9 * http://www.apache.org/licenses/LICENSE-2.0
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
18 #ifndef included_replication_h
19 #define included_replication_h
22 #include <vlib/vlib.h>
23 #include <vnet/vnet.h>
24 #include <vnet/replication.h>
29 // The entire vnet buffer header restored for each replica
30 u8 vnet_buffer[32]; // 16B aligned to allow vector unit copy
31 u8 reserved[32]; // space for future expansion of vnet buffer header
33 // feature state used during this replication
34 u64 feature_replicas; // feature's id for its set of replicas
35 u32 feature_counter; // feature's current index into set of replicas
36 u32 recycle_node_index; // feature's recycle node index
38 // data saved from the start of replication and restored at the end of replication
39 u32 saved_free_list_index; // from vlib buffer
41 // data saved from the original packet and restored for each replica
42 u64 l2_header[3]; // 24B (must be at least 22B for l2 packets)
43 u16 ip_tos; // v4 and v6
44 u16 ip4_checksum; // needed for v4 only
46 // data saved from the vlib buffer header and restored for each replica
47 i16 current_data; // offset of first byte of packet in packet data
49 u8 l2_packet; // flag for l2 vs l3 packet data
51 } replication_context_t; // 128B
56 u32 recycle_list_index;
58 // per-thread pools of replication contexts
59 replication_context_t ** contexts;
61 vlib_main_t * vlib_main;
62 vnet_main_t * vnet_main;
67 extern replication_main_t replication_main;
70 // Return 1 if this buffer just came from the replication recycle handler.
72 replication_is_recycled (vlib_buffer_t * b0)
74 return b0->flags & VLIB_BUFFER_IS_RECYCLED;
77 // Clear the recycle flag. If buffer came from the replication recycle
78 // handler, this flag must be cleared before the packet is transmitted again.
80 replication_clear_recycled (vlib_buffer_t * b0)
82 b0->flags &= ~VLIB_BUFFER_IS_RECYCLED;
85 // Return the active replication context if this buffer has
86 // been recycled, otherwise return 0. (Note that this essentially
87 // restricts access to the replication context to the replication
88 // feature's prep and recycle nodes.)
89 always_inline replication_context_t *
90 replication_get_ctx (vlib_buffer_t * b0)
92 replication_main_t * rm = &replication_main;
94 return replication_is_recycled (b0) ?
95 pool_elt_at_index (rm->contexts[os_get_cpu_number()], b0->recycle_count) :
99 // Prefetch the replication context for this buffer, if it exists
101 replication_prefetch_ctx (vlib_buffer_t * b0)
103 replication_context_t *ctx = replication_get_ctx (b0);
106 CLIB_PREFETCH (ctx, (2*CLIB_CACHE_LINE_BYTES), STORE);
110 replication_context_t *
111 replication_prep (vlib_main_t * vm,
113 u32 recycle_node_index,
116 replication_context_t *
117 replication_recycle (vlib_main_t * vm,