2 *------------------------------------------------------------------
3 * Copyright (c) 2020 Cisco and/or its affiliates.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 *------------------------------------------------------------------
18 #ifndef _VNET_DEVICES_VIRTIO_VIRTIO_BUFFERING_H_
19 #define _VNET_DEVICES_VIRTIO_VIRTIO_BUFFERING_H_
21 #define VIRTIO_BUFFERING_DEFAULT_SIZE 1024
22 #define VIRTIO_BUFFERING_TIMEOUT 1e-5
34 } virtio_vring_buffering_t;
36 static_always_inline clib_error_t *
37 virtio_vring_buffering_init (virtio_vring_buffering_t ** buffering,
38 u32 node_index, u16 size)
41 return clib_error_return (0, "buffering: already initialized");
44 return clib_error_return (0, "buffering: size must be power of 2");
47 return clib_error_return (0, "buffering: size must be 32768 or lower");
50 size = VIRTIO_BUFFERING_DEFAULT_SIZE;
52 virtio_vring_buffering_t *b_temp = 0;
54 (virtio_vring_buffering_t *)
55 clib_mem_alloc (sizeof (virtio_vring_buffering_t));
57 return clib_error_return (0, "buffering: memory allocation failed");
59 clib_memset (b_temp, 0, sizeof (virtio_vring_buffering_t));
61 b_temp->node_index = node_index;
62 b_temp->free_size = size;
65 vec_validate_aligned (b_temp->buffers, size, CLIB_CACHE_LINE_BYTES);
66 b_temp->is_enable = 1;
72 static_always_inline void
73 virtio_vring_buffering_buffers_free (vlib_main_t * vm,
74 virtio_vring_buffering_t * buffering)
76 u16 n_buffers = buffering->size - buffering->free_size;
79 vlib_buffer_free_from_ring (vm, buffering->buffers, buffering->front,
80 buffering->size, n_buffers);
81 buffering->free_size += n_buffers;
85 static_always_inline void
86 virtio_vring_buffering_free (vlib_main_t * vm,
87 virtio_vring_buffering_t * buffering)
91 virtio_vring_buffering_buffers_free (vm, buffering);
92 vec_free (buffering->buffers);
93 clib_mem_free (buffering);
97 static_always_inline u8
98 virtio_vring_buffering_is_enable (virtio_vring_buffering_t * buffering)
101 return buffering->is_enable;
106 static_always_inline void
107 virtio_vring_buffering_set_is_enable (virtio_vring_buffering_t * buffering,
111 buffering->is_enable = is_enable;
114 static_always_inline void
115 virtio_vring_buffering_set_timeout (vlib_main_t * vm,
116 virtio_vring_buffering_t * buffering,
120 buffering->timeout_ts = vlib_time_now (vm) + timeout_expire;
123 static_always_inline u8
124 virtio_vring_buffering_is_timeout (vlib_main_t * vm,
125 virtio_vring_buffering_t * buffering)
127 if (buffering && (buffering->timeout_ts < vlib_time_now (vm)))
132 static_always_inline u8
133 virtio_vring_buffering_is_empty (virtio_vring_buffering_t * buffering)
135 if (buffering->size == buffering->free_size)
140 static_always_inline u8
141 virtio_vring_buffering_is_full (virtio_vring_buffering_t * buffering)
143 if (buffering->free_size == 0)
148 static_always_inline u16
149 virtio_vring_n_buffers (virtio_vring_buffering_t * buffering)
151 return (buffering->size - buffering->free_size);
154 static_always_inline u16
155 virtio_vring_buffering_store_packets (virtio_vring_buffering_t * buffering,
156 u32 * bi, u16 n_store)
158 u16 mask, n_s = 0, i = 0;
160 if (!virtio_vring_buffering_is_enable (buffering)
161 || virtio_vring_buffering_is_full (buffering))
164 mask = buffering->size - 1;
165 n_s = clib_min (n_store, buffering->free_size);
169 buffering->buffers[buffering->back] = bi[i];
170 buffering->back = (buffering->back + 1) & mask;
171 buffering->free_size--;
177 static_always_inline u32
178 virtio_vring_buffering_read_from_front (virtio_vring_buffering_t * buffering)
181 u16 mask = buffering->size - 1;
182 if (virtio_vring_buffering_is_empty (buffering))
185 bi = buffering->buffers[buffering->front];
186 buffering->buffers[buffering->front] = ~0;
187 buffering->front = (buffering->front + 1) & mask;
188 buffering->free_size++;
192 static_always_inline u32
193 virtio_vring_buffering_read_from_back (virtio_vring_buffering_t * buffering)
196 u16 mask = buffering->size - 1;
197 if (virtio_vring_buffering_is_empty (buffering))
200 buffering->back = (buffering->back - 1) & mask;
201 bi = buffering->buffers[buffering->back];
202 buffering->buffers[buffering->back] = ~0;
203 buffering->free_size++;
207 static_always_inline void
208 virtio_vring_buffering_schedule_node_on_dispatcher (vlib_main_t * vm,
209 virtio_vring_buffering_t *
212 if (buffering && virtio_vring_buffering_is_timeout (vm, buffering)
213 && virtio_vring_n_buffers (buffering))
215 vlib_frame_t *f = vlib_get_frame_to_node (vm, buffering->node_index);
216 u32 *f_to = vlib_frame_vector_args (f);
217 f_to[f->n_vectors] = virtio_vring_buffering_read_from_back (buffering);
219 vlib_put_frame_to_node (vm, buffering->node_index, f);
220 virtio_vring_buffering_set_timeout (vm, buffering,
221 VIRTIO_BUFFERING_TIMEOUT);
225 static_always_inline u8 *
226 virtio_vring_buffering_format (u8 * s, va_list * args)
228 virtio_vring_buffering_t *buffering =
229 va_arg (*args, virtio_vring_buffering_t *);
230 u32 indent = format_get_indent (s);
237 if (buffering->is_enable)
238 s = format (s, "packet-buffering: enable\n");
240 s = format (s, "packet-buffering: disable\n");
243 "%Usize %u n_buffers %u front %u back %u",
244 format_white_space, indent, buffering->size,
245 virtio_vring_n_buffers (buffering), buffering->front,
251 #endif /* _VNET_DEVICES_VIRTIO_VIRTIO_BUFFERING_H_ */
254 * fd.io coding-style-patch-verification: ON
257 * eval: (c-set-style "gnu")