8b4ef8a8e075302d78dd649a687b74c1f4de2e3b
[dpdk.git] / lib / librte_ip_frag / rte_ipv6_reassembly.c
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 #include <stddef.h>
35
36 #include <rte_memcpy.h>
37
38 #include "ip_frag_common.h"
39
40 /**
41  * @file
42  * IPv6 reassemble
43  *
44  * Implementation of IPv6 reassembly.
45  *
46  */
47
48 static inline void
49 ip_frag_memmove(char *dst, char *src, int len)
50 {
51         int i;
52
53         /* go backwards to make sure we don't overwrite anything important */
54         for (i = len - 1; i >= 0; i--)
55                 dst[i] = src[i];
56 }
57
58 /*
59  * Reassemble fragments into one packet.
60  */
61 struct rte_mbuf *
62 ipv6_frag_reassemble(const struct ip_frag_pkt *fp)
63 {
64         struct ipv6_hdr *ip_hdr;
65         struct ipv6_extension_fragment *frag_hdr;
66         struct rte_mbuf *m, *prev;
67         uint32_t i, n, ofs, first_len;
68         uint32_t last_len, move_len, payload_len;
69
70         first_len = fp->frags[IP_FIRST_FRAG_IDX].len;
71         n = fp->last_idx - 1;
72
73         /*start from the last fragment. */
74         m = fp->frags[IP_LAST_FRAG_IDX].mb;
75         ofs = fp->frags[IP_LAST_FRAG_IDX].ofs;
76         last_len = fp->frags[IP_LAST_FRAG_IDX].len;
77
78         payload_len = ofs + last_len;
79
80         while (ofs != first_len) {
81
82                 prev = m;
83
84                 for (i = n; i != IP_FIRST_FRAG_IDX && ofs != first_len; i--) {
85
86                         /* previous fragment found. */
87                         if (fp->frags[i].ofs + fp->frags[i].len == ofs) {
88
89                                 ip_frag_chain(fp->frags[i].mb, m);
90
91                                 /* update our last fragment and offset. */
92                                 m = fp->frags[i].mb;
93                                 ofs = fp->frags[i].ofs;
94                         }
95                 }
96
97                 /* error - hole in the packet. */
98                 if (m == prev) {
99                         return NULL;
100                 }
101         }
102
103         /* chain with the first fragment. */
104         ip_frag_chain(fp->frags[IP_FIRST_FRAG_IDX].mb, m);
105         m = fp->frags[IP_FIRST_FRAG_IDX].mb;
106
107         /* update mbuf fields for reassembled packet. */
108         m->ol_flags |= PKT_TX_IP_CKSUM;
109
110         /* update ipv6 header for the reassembled datagram */
111         ip_hdr = rte_pktmbuf_mtod_offset(m, struct ipv6_hdr *, m->l2_len);
112
113         ip_hdr->payload_len = rte_cpu_to_be_16(payload_len);
114
115         /*
116          * remove fragmentation header. note that per RFC2460, we need to update
117          * the last non-fragmentable header with the "next header" field to contain
118          * type of the first fragmentable header, but we currently don't support
119          * other headers, so we assume there are no other headers and thus update
120          * the main IPv6 header instead.
121          */
122         move_len = m->l2_len + m->l3_len - sizeof(*frag_hdr);
123         frag_hdr = (struct ipv6_extension_fragment *) (ip_hdr + 1);
124         ip_hdr->proto = frag_hdr->next_header;
125
126         ip_frag_memmove(rte_pktmbuf_mtod_offset(m, char *, sizeof(*frag_hdr)),
127                         rte_pktmbuf_mtod(m, char*), move_len);
128
129         rte_pktmbuf_adj(m, sizeof(*frag_hdr));
130
131         return m;
132 }
133
134 /*
135  * Process new mbuf with fragment of IPV6 datagram.
136  * Incoming mbuf should have its l2_len/l3_len fields setup correctly.
137  * @param tbl
138  *   Table where to lookup/add the fragmented packet.
139  * @param mb
140  *   Incoming mbuf with IPV6 fragment.
141  * @param tms
142  *   Fragment arrival timestamp.
143  * @param ip_hdr
144  *   Pointer to the IPV6 header.
145  * @param frag_hdr
146  *   Pointer to the IPV6 fragment extension header.
147  * @return
148  *   Pointer to mbuf for reassembled packet, or NULL if:
149  *   - an error occured.
150  *   - not all fragments of the packet are collected yet.
151  */
152 #define MORE_FRAGS(x) (((x) & 0x100) >> 8)
153 #define FRAG_OFFSET(x) (rte_cpu_to_be_16(x) >> 3)
154 struct rte_mbuf *
155 rte_ipv6_frag_reassemble_packet(struct rte_ip_frag_tbl *tbl,
156                 struct rte_ip_frag_death_row *dr, struct rte_mbuf *mb, uint64_t tms,
157                 struct ipv6_hdr *ip_hdr, struct ipv6_extension_fragment *frag_hdr)
158 {
159         struct ip_frag_pkt *fp;
160         struct ip_frag_key key;
161         uint16_t ip_len, ip_ofs;
162
163         rte_memcpy(&key.src_dst[0], ip_hdr->src_addr, 16);
164         rte_memcpy(&key.src_dst[2], ip_hdr->dst_addr, 16);
165
166         key.id = frag_hdr->id;
167         key.key_len = IPV6_KEYLEN;
168
169         ip_ofs = FRAG_OFFSET(frag_hdr->frag_data) * 8;
170
171         /*
172          * as per RFC2460, payload length contains all extension headers as well.
173          * since we don't support anything but frag headers, this is what we remove
174          * from the payload len.
175          */
176         ip_len = rte_be_to_cpu_16(ip_hdr->payload_len) - sizeof(*frag_hdr);
177
178         IP_FRAG_LOG(DEBUG, "%s:%d:\n"
179                 "mbuf: %p, tms: %" PRIu64
180                 ", key: <" IPv6_KEY_BYTES_FMT ", %#x>, ofs: %u, len: %u, flags: %#x\n"
181                 "tbl: %p, max_cycles: %" PRIu64 ", entry_mask: %#x, "
182                 "max_entries: %u, use_entries: %u\n\n",
183                 __func__, __LINE__,
184                 mb, tms, IPv6_KEY_BYTES(key.src_dst), key.id, ip_ofs, ip_len,
185                 RTE_IPV6_GET_MF(frag_hdr->frag_data),
186                 tbl, tbl->max_cycles, tbl->entry_mask, tbl->max_entries,
187                 tbl->use_entries);
188
189         /* try to find/add entry into the fragment's table. */
190         fp = ip_frag_find(tbl, dr, &key, tms);
191         if (fp == NULL) {
192                 IP_FRAG_MBUF2DR(dr, mb);
193                 return NULL;
194         }
195
196         IP_FRAG_LOG(DEBUG, "%s:%d:\n"
197                 "tbl: %p, max_entries: %u, use_entries: %u\n"
198                 "ipv6_frag_pkt: %p, key: <" IPv6_KEY_BYTES_FMT ", %#x>, start: %" PRIu64
199                 ", total_size: %u, frag_size: %u, last_idx: %u\n\n",
200                 __func__, __LINE__,
201                 tbl, tbl->max_entries, tbl->use_entries,
202                 fp, IPv6_KEY_BYTES(fp->key.src_dst), fp->key.id, fp->start,
203                 fp->total_size, fp->frag_size, fp->last_idx);
204
205
206         /* process the fragmented packet. */
207         mb = ip_frag_process(fp, dr, mb, ip_ofs, ip_len,
208                         MORE_FRAGS(frag_hdr->frag_data));
209         ip_frag_inuse(tbl, fp);
210
211         IP_FRAG_LOG(DEBUG, "%s:%d:\n"
212                 "mbuf: %p\n"
213                 "tbl: %p, max_entries: %u, use_entries: %u\n"
214                 "ipv6_frag_pkt: %p, key: <" IPv6_KEY_BYTES_FMT ", %#x>, start: %" PRIu64
215                 ", total_size: %u, frag_size: %u, last_idx: %u\n\n",
216                 __func__, __LINE__, mb,
217                 tbl, tbl->max_entries, tbl->use_entries,
218                 fp, IPv6_KEY_BYTES(fp->key.src_dst), fp->key.id, fp->start,
219                 fp->total_size, fp->frag_size, fp->last_idx);
220
221         return mb;
222 }