lib/librte_ip_frag/ip_frag_common.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright(c) 2010-2014 Intel Corporation. All rights reserved.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef _IP_FRAG_COMMON_H_
  35 #define _IP_FRAG_COMMON_H_
  36
  37 #include "rte_ip_frag.h"
  38
  39 /* logging macros. */
  40 #ifdef RTE_LIBRTE_IP_FRAG_DEBUG
  41 #define IP_FRAG_LOG(lvl, fmt, args...)  RTE_LOG(lvl, USER1, fmt, ##args)
  42 #else
  43 #define IP_FRAG_LOG(lvl, fmt, args...)  do {} while(0)
  44 #endif /* IP_FRAG_DEBUG */
  45
  46 #define IPV4_KEYLEN 1
  47 #define IPV6_KEYLEN 4
  48
  49 /* helper macros */
  50 #define IP_FRAG_MBUF2DR(dr, mb) ((dr)->row[(dr)->cnt++] = (mb))
  51
  52 #define IPv6_KEY_BYTES(key) \
  53         (key)[0], (key)[1], (key)[2], (key)[3]
  54 #define IPv6_KEY_BYTES_FMT \
  55         "%08" PRIx64 "%08" PRIx64 "%08" PRIx64 "%08" PRIx64
  56
  57 /* internal functions declarations */
  58 struct rte_mbuf * ip_frag_process(struct ip_frag_pkt *fp,
  59                 struct rte_ip_frag_death_row *dr, struct rte_mbuf *mb,
  60                 uint16_t ofs, uint16_t len, uint16_t more_frags);
  61
  62 struct ip_frag_pkt * ip_frag_find(struct rte_ip_frag_tbl *tbl,
  63                 struct rte_ip_frag_death_row *dr,
  64                 const struct ip_frag_key *key, uint64_t tms);
  65
  66 struct ip_frag_pkt * ip_frag_lookup(struct rte_ip_frag_tbl *tbl,
  67         const struct ip_frag_key *key, uint64_t tms,
  68         struct ip_frag_pkt **free, struct ip_frag_pkt **stale);
  69
  70 /* these functions need to be declared here as ip_frag_process relies on them */
  71 struct rte_mbuf *ipv4_frag_reassemble(struct ip_frag_pkt *fp);
  72 struct rte_mbuf *ipv6_frag_reassemble(struct ip_frag_pkt *fp);
  73
  74
  75
  76 /*
  77  * misc frag key functions
  78  */
  79
  80 /* check if key is empty */
  81 static inline int
  82 ip_frag_key_is_empty(const struct ip_frag_key * key)
  83 {
  84         uint32_t i;
  85         for (i = 0; i < RTE_MIN(key->key_len, RTE_DIM(key->src_dst)); i++)
  86                 if (key->src_dst[i] != 0)
  87                         return 0;
  88         return 1;
  89 }
  90
  91 /* empty the key */
  92 static inline void
  93 ip_frag_key_invalidate(struct ip_frag_key * key)
  94 {
  95         uint32_t i;
  96         for (i = 0; i < key->key_len; i++)
  97                 key->src_dst[i] = 0;
  98 }
  99
 100 /* compare two keys */
 101 static inline int
 102 ip_frag_key_cmp(const struct ip_frag_key * k1, const struct ip_frag_key * k2)
 103 {
 104         uint32_t i, val;
 105         val = k1->id ^ k2->id;
 106         for (i = 0; i < k1->key_len; i++)
 107                 val |= k1->src_dst[i] ^ k2->src_dst[i];
 108         return val;
 109 }
 110
 111 /*
 112  * misc fragment functions
 113  */
 114
 115 /* put fragment on death row */
 116 static inline void
 117 ip_frag_free(struct ip_frag_pkt *fp, struct rte_ip_frag_death_row *dr)
 118 {
 119         uint32_t i, k;
 120
 121         k = dr->cnt;
 122         for (i = 0; i != fp->last_idx; i++) {
 123                 if (fp->frags[i].mb != NULL) {
 124                         dr->row[k++] = fp->frags[i].mb;
 125                         fp->frags[i].mb = NULL;
 126                 }
 127         }
 128
 129         fp->last_idx = 0;
 130         dr->cnt = k;
 131 }
 132
 133 /* if key is empty, mark key as in use */
 134 static inline void
 135 ip_frag_inuse(struct rte_ip_frag_tbl *tbl, const struct  ip_frag_pkt *fp)
 136 {
 137         if (ip_frag_key_is_empty(&fp->key)) {
 138                 TAILQ_REMOVE(&tbl->lru, fp, lru);
 139                 tbl->use_entries--;
 140         }
 141 }
 142
 143 /* reset the fragment */
 144 static inline void
 145 ip_frag_reset(struct ip_frag_pkt *fp, uint64_t tms)
 146 {
 147         static const struct ip_frag zero_frag = {
 148                 .ofs = 0,
 149                 .len = 0,
 150                 .mb = NULL,
 151         };
 152
 153         fp->start = tms;
 154         fp->total_size = UINT32_MAX;
 155         fp->frag_size = 0;
 156         fp->last_idx = IP_MIN_FRAG_NUM;
 157         fp->frags[IP_LAST_FRAG_IDX] = zero_frag;
 158         fp->frags[IP_FIRST_FRAG_IDX] = zero_frag;
 159 }
 160
 161 #endif /* _IP_FRAG_COMMON_H_ */