2 * Copyright (c) 2018 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 #ifndef included_ring_h
17 #define included_ring_h
19 #include <vppinfra/error.h>
20 #include <vppinfra/format.h>
21 #include <vppinfra/vec.h>
22 #include <vppinfra/vector.h>
29 always_inline clib_ring_header_t *
30 clib_ring_header (void *v)
32 return vec_aligned_header (v, sizeof (clib_ring_header_t), sizeof (void *));
36 clib_ring_new_inline (void **p, u32 elt_bytes, u32 size, u32 align)
39 clib_ring_header_t *h;
41 v = _vec_resize ((void *) 0,
42 /* length increment */ size,
43 /* data bytes */ elt_bytes * size,
44 /* header bytes */ sizeof (h[0]),
45 /* data align */ align);
47 h = clib_ring_header (v);
53 #define clib_ring_new_aligned(ring, size, align) \
54 { clib_ring_new_inline ((void **)&(ring), sizeof(ring[0]), size, align); }
56 #define clib_ring_new(ring, size) \
57 { clib_ring_new_inline ((void **)&(ring), sizeof(ring[0]), size, 0);}
59 #define clib_ring_free(f) vec_free_h((f), sizeof(clib_ring_header_t))
62 clib_ring_n_enq (void *v)
64 clib_ring_header_t *h = clib_ring_header (v);
69 clib_ring_get_last_inline (void *v, u32 elt_bytes, int enqueue)
71 clib_ring_header_t *h = clib_ring_header (v);
76 if (h->n_enq == _vec_len (v))
81 if (h->next == _vec_len (v))
88 slot = h->next == 0 ? _vec_len (v) - 1 : h->next - 1;
91 return (void *) ((u8 *) v + elt_bytes * slot);
94 #define clib_ring_enq(ring) \
95 clib_ring_get_last_inline (ring, sizeof(ring[0]), 1)
97 #define clib_ring_get_last(ring) \
98 clib_ring_get_last_inline (ring, sizeof(ring[0]), 0)
101 clib_ring_get_first_inline (void *v, u32 elt_bytes, int dequeue)
103 clib_ring_header_t *h = clib_ring_header (v);
109 if (h->n_enq > h->next)
110 slot = _vec_len (v) + h->next - h->n_enq;
112 slot = h->next - h->n_enq;
117 return (void *) ((u8 *) v + elt_bytes * slot);
120 #define clib_ring_deq(ring) \
121 clib_ring_get_first_inline (ring, sizeof(ring[0]), 1)
123 #define clib_ring_get_first(ring) \
124 clib_ring_get_first_inline (ring, sizeof(ring[0]), 0)
126 #endif /* included_ring_h */
129 * fd.io coding-style-patch-verification: ON
132 * eval: (c-set-style "gnu")