ulut/ul_dqfifo.h

   1 /*******************************************************************
   2   uLan Utilities Library - C library of basic reusable constructions
   3
   4   ul_dqfifo.h   - data queue FIFO for filters and other computations
   5
   6   (C) Copyright 2006 by Pavel Pisa - Originator
   7
   8   The uLan utilities library can be used, copied and modified under
   9   next licenses
  10     - GPL - GNU General Public License
  11     - LGPL - GNU Lesser General Public License
  12     - MPL - Mozilla Public License
  13     - and other licenses added by project originators
  14   Code can be modified and re-distributed under any combination
  15   of the above listed licenses. If contributor does not agree with
  16   some of the licenses, he/she can delete appropriate line.
  17   Warning, if you delete all lines, you are not allowed to
  18   distribute source code and/or binaries utilizing code.
  19
  20   See files COPYING and README for details.
  21
  22  *******************************************************************/
  23
  24 #ifndef _UL_DQFIFO_H
  25 #define _UL_DQFIFO_H
  26
  27 typedef unsigned int ul_dqfifo_loc_t;
  28
  29 /**
  30  * struct ul_dqfifo_base_t - basic structure for data queues locations counting
  31  * @locin:      continuously increased location counter for data input position
  32  * @locout:     continuously increased location counter for data output position
  33  * @locmask:    number of allocated slots to hold actual data minus 1
  34  */
  35 typedef struct ul_dqfifo_base_t {
  36   ul_dqfifo_loc_t locin;
  37   ul_dqfifo_loc_t locout;
  38   ul_dqfifo_loc_t locmask;
  39 } ul_dqfifo_base_t;
  40
  41
  42 static inline unsigned int
  43 ul_dqfifo_base_loc2idx(ul_dqfifo_base_t *dqf, ul_dqfifo_loc_t loc)
  44 {
  45   return loc & dqf->locmask;
  46 }
  47
  48 static inline unsigned int
  49 ul_dqfifo_base_is_full(ul_dqfifo_base_t *dqf)
  50 {
  51   ul_dqfifo_loc_t locx = dqf->locin ^ dqf->locout;
  52   return (locx && !(locx & dqf->locmask));
  53 }
  54
  55 static inline unsigned int
  56 ul_dqfifo_base_is_empty(ul_dqfifo_base_t *dqf)
  57 {
  58   return (dqf->locin == dqf->locout);
  59 }
  60
  61 #define UL_DQFIFO_CUST_DEC(cust_prefix, cust_data_t, cust_barrier, cust_static_inline) \
  62 \
  63 typedef struct cust_prefix##_t { \
  64   ul_dqfifo_base_t dqf; \
  65   cust_data_t *buff; \
  66 } cust_prefix##_t; \
  67 \
  68 cust_static_inline unsigned int \
  69 cust_prefix##_loc2idx(cust_prefix##_t *cdqf, ul_dqfifo_loc_t loc) \
  70 { \
  71   return ul_dqfifo_base_loc2idx(&cdqf->dqf, loc); \
  72 } \
  73 \
  74 cust_static_inline unsigned int \
  75 cust_prefix##_is_full(cust_prefix##_t *cdqf) \
  76 { \
  77   return ul_dqfifo_base_is_full(&cdqf->dqf); \
  78 } \
  79 \
  80 cust_static_inline unsigned int \
  81 cust_prefix##_is_empty(cust_prefix##_t *cdqf) \
  82 { \
  83   return ul_dqfifo_base_is_empty(&cdqf->dqf); \
  84 } \
  85 \
  86 cust_static_inline int \
  87 cust_prefix##_put(cust_prefix##_t *cdqf, const cust_data_t *data) \
  88 { \
  89   ul_dqfifo_loc_t locin; \
  90   cust_barrier; \
  91   if(cust_prefix##_is_full(cdqf)) \
  92     return 0; \
  93   locin = cdqf->dqf.locin; \
  94   cdqf->buff[cust_prefix##_loc2idx(cdqf, locin)] = *data; \
  95   cust_barrier; \
  96   cdqf->dqf.locin = ++locin; \
  97   cust_barrier; \
  98   return 1; \
  99 } \
 100 \
 101 cust_static_inline int \
 102 cust_prefix##_get(cust_prefix##_t *cdqf, cust_data_t *data) \
 103 { \
 104   ul_dqfifo_loc_t locout; \
 105   cust_barrier; \
 106   if(cust_prefix##_is_empty(cdqf)) \
 107     return 0; \
 108   locout = cdqf->dqf.locout; \
 109   *data = cdqf->buff[cust_prefix##_loc2idx(cdqf, locout)]; \
 110   cust_barrier; \
 111   cdqf->dqf.locout = ++locout; \
 112   cust_barrier; \
 113   return 1; \
 114 } \
 115 \
 116 cust_static_inline ul_dqfifo_loc_t \
 117 cust_prefix##_skip(cust_prefix##_t *cdqf, ul_dqfifo_loc_t locinc) \
 118 { \
 119   ul_dqfifo_loc_t locout; \
 120   ul_dqfifo_loc_t locdiff; \
 121   cust_barrier; \
 122   locdiff = cdqf->dqf.locin - cdqf->dqf.locout; \
 123   if(locinc > locdiff) \
 124     locinc = locdiff; \
 125   locout = cdqf->dqf.locout + locinc; \
 126   cdqf->dqf.locout = locout; \
 127   cust_barrier; \
 128   return locdiff; \
 129 } \
 130 \
 131 cust_static_inline void \
 132 cust_prefix##_flush(cust_prefix##_t *cdqf) \
 133 { \
 134   cust_barrier; \
 135   cdqf->dqf.locout = cdqf->dqf.locin; \
 136 } \
 137 \
 138 cust_static_inline ul_dqfifo_loc_t \
 139 cust_prefix##_count(cust_prefix##_t *cdqf) \
 140 { ul_dqfifo_loc_t loccount; \
 141   cust_barrier; \
 142   loccount = cdqf->dqf.locin - cdqf->dqf.locout; \
 143   cust_barrier; \
 144   return loccount; \
 145 } \
 146 \
 147 cust_static_inline ul_dqfifo_loc_t \
 148 cust_prefix##_get_locin(cust_prefix##_t *cdqf) \
 149 { \
 150   ul_dqfifo_loc_t loc; \
 151   cust_barrier; \
 152   loc = cdqf->dqf.locin; \
 153   cust_barrier; \
 154   return loc; \
 155 } \
 156 \
 157 cust_static_inline ul_dqfifo_loc_t \
 158 cust_prefix##_get_locout(cust_prefix##_t *cdqf) \
 159 { \
 160   ul_dqfifo_loc_t loc; \
 161   cust_barrier; \
 162   loc = cdqf->dqf.locout; \
 163   cust_barrier; \
 164   return loc; \
 165 } \
 166 \
 167 cust_static_inline void \
 168 cust_prefix##_init(cust_prefix##_t *cdqf, cust_data_t *databuff, \
 169                         ul_dqfifo_loc_t locmask) \
 170 { \
 171   cdqf->buff = databuff; \
 172   cdqf->dqf.locmask = locmask; \
 173   cdqf->dqf.locout = cdqf->dqf.locin = 0; \
 174 }
 175
 176 #define ul_dqfifo_for_last_x(cdqf, limit, loc, data) \
 177   for((loc) = (cdqf)->dqf.locout; \
 178   (data) = (cdqf)->buff[ul_dqfifo_base_loc2idx(&(cdqf)->dqf, (loc))], \
 179   (((loc) != (cdqf)->dqf.locout + (limit)) && ((loc) != (cdqf)->dqf.locin)); (loc)++)
 180
 181 #define UL_DQFIFO_STATIC_INSTANCE(cust_instance, cust_prefix, slots) \
 182 \
 183 typeof(*((cust_prefix##_t*)0)->buff) cust_instance##_databuff[slots]; \
 184 cust_prefix##_t cust_instance = { \
 185   .dqf = {.locmask = slots - 1, .locout = 0, .locin = 0},  \
 186   .buff = cust_instance##_databuff,\
 187 };
 188
 189 #endif /*_UL_DQFIFO_H*/