src/vppinfra/ring.h

   1 /*
   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:
   6  *
   7  *     http://www.apache.org/licenses/LICENSE-2.0
   8  *
   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.
  14  */
  15
  16 #ifndef included_ring_h
  17 #define included_ring_h
  18
  19 #include <vppinfra/error.h>
  20 #include <vppinfra/format.h>
  21 #include <vppinfra/vec.h>
  22 #include <vppinfra/vector.h>
  23
  24 typedef struct
  25 {
  26   u32 next, n_enq;
  27 } clib_ring_header_t;
  28
  29 always_inline clib_ring_header_t *
  30 clib_ring_header (void *v)
  31 {
  32   return vec_header (v);
  33 }
  34
  35 always_inline void
  36 clib_ring_reset (void *v)
  37 {
  38   clib_ring_header_t *h = clib_ring_header (v);
  39   h->next = 0;
  40   h->n_enq = 0;
  41 }
  42
  43 always_inline void
  44 clib_ring_new_inline (void **p, u32 elt_bytes, u32 size, u32 align)
  45 {
  46   void *v;
  47   vec_attr_t va = { .elt_sz = elt_bytes,
  48                     .hdr_sz = sizeof (clib_ring_header_t),
  49                     .align = align };
  50
  51   v = _vec_alloc_internal (size, &va);
  52
  53   clib_ring_reset (v);
  54   p[0] = v;
  55 }
  56
  57 #define clib_ring_new_aligned(ring, size, align) \
  58 { clib_ring_new_inline ((void **)&(ring), sizeof(ring[0]), size, align); }
  59
  60 #define clib_ring_new(ring, size) \
  61 { clib_ring_new_inline ((void **)&(ring), sizeof(ring[0]), size, 0);}
  62
  63 #define clib_ring_free(f) vec_free ((f))
  64
  65 always_inline u32
  66 clib_ring_n_enq (void *v)
  67 {
  68   clib_ring_header_t *h = clib_ring_header (v);
  69   return h->n_enq;
  70 }
  71
  72 always_inline void *
  73 clib_ring_get_last_inline (void *v, u32 elt_bytes, int enqueue)
  74 {
  75   clib_ring_header_t *h = clib_ring_header (v);
  76   u32 slot;
  77
  78   if (enqueue)
  79     {
  80       if (h->n_enq == _vec_len (v))
  81         return 0;
  82       slot = h->next;
  83       h->n_enq++;
  84       h->next++;
  85       if (h->next == _vec_len (v))
  86         h->next = 0;
  87     }
  88   else
  89     {
  90       if (h->n_enq == 0)
  91         return 0;
  92       slot = h->next == 0 ? _vec_len (v) - 1 : h->next - 1;
  93     }
  94
  95   return (void *) ((u8 *) v + elt_bytes * slot);
  96 }
  97
  98 #define clib_ring_enq(ring) \
  99 clib_ring_get_last_inline (ring, sizeof(ring[0]), 1)
 100
 101 #define clib_ring_get_last(ring) \
 102 clib_ring_get_last_inline (ring, sizeof(ring[0]), 0)
 103
 104 always_inline void *
 105 clib_ring_get_first_inline (void *v, u32 elt_bytes, int dequeue)
 106 {
 107   clib_ring_header_t *h = clib_ring_header (v);
 108   u32 slot;
 109
 110   if (h->n_enq == 0)
 111     return 0;
 112
 113   if (h->n_enq > h->next)
 114     slot = _vec_len (v) + h->next - h->n_enq;
 115   else
 116     slot = h->next - h->n_enq;
 117
 118   if (dequeue)
 119     h->n_enq--;
 120
 121   return (void *) ((u8 *) v + elt_bytes * slot);
 122 }
 123
 124 #define clib_ring_deq(ring) \
 125 clib_ring_get_first_inline (ring, sizeof(ring[0]), 1)
 126
 127 #define clib_ring_get_first(ring) \
 128 clib_ring_get_first_inline (ring, sizeof(ring[0]), 0)
 129
 130 #endif /* included_ring_h */
 131
 132 /*
 133  * fd.io coding-style-patch-verification: ON
 134  *
 135  * Local Variables:
 136  * eval: (c-set-style "gnu")
 137  * End:
 138  */