1 /*
2  * ngtcp2
3  *
4  * Copyright (c) 2017 ngtcp2 contributors
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining
7  * a copy of this software and associated documentation files (the
8  * "Software"), to deal in the Software without restriction, including
9  * without limitation the rights to use, copy, modify, merge, publish,
10  * distribute, sublicense, and/or sell copies of the Software, and to
11  * permit persons to whom the Software is furnished to do so, subject to
12  * the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be
15  * included in all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
18  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
20  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
21  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
22  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
23  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24  */
25 #include "ngtcp2_rob.h"
26 
27 #include <string.h>
28 #include <assert.h>
29 
30 #include "ngtcp2_macro.h"
31 
ngtcp2_rob_gap_new(ngtcp2_rob_gap ** pg,uint64_t begin,uint64_t end,const ngtcp2_mem * mem)32 int ngtcp2_rob_gap_new(ngtcp2_rob_gap **pg, uint64_t begin, uint64_t end,
33                        const ngtcp2_mem *mem) {
34   *pg = ngtcp2_mem_malloc(mem, sizeof(ngtcp2_rob_gap));
35   if (*pg == NULL) {
36     return NGTCP2_ERR_NOMEM;
37   }
38 
39   (*pg)->range.begin = begin;
40   (*pg)->range.end = end;
41 
42   return 0;
43 }
44 
ngtcp2_rob_gap_del(ngtcp2_rob_gap * g,const ngtcp2_mem * mem)45 void ngtcp2_rob_gap_del(ngtcp2_rob_gap *g, const ngtcp2_mem *mem) {
46   ngtcp2_mem_free(mem, g);
47 }
48 
ngtcp2_rob_data_new(ngtcp2_rob_data ** pd,uint64_t offset,size_t chunk,const ngtcp2_mem * mem)49 int ngtcp2_rob_data_new(ngtcp2_rob_data **pd, uint64_t offset, size_t chunk,
50                         const ngtcp2_mem *mem) {
51   *pd = ngtcp2_mem_malloc(mem, sizeof(ngtcp2_rob_data) + chunk);
52   if (*pd == NULL) {
53     return NGTCP2_ERR_NOMEM;
54   }
55 
56   (*pd)->range.begin = offset;
57   (*pd)->range.end = offset + chunk;
58   (*pd)->begin = (uint8_t *)(*pd) + sizeof(ngtcp2_rob_data);
59   (*pd)->end = (*pd)->begin + chunk;
60 
61   return 0;
62 }
63 
ngtcp2_rob_data_del(ngtcp2_rob_data * d,const ngtcp2_mem * mem)64 void ngtcp2_rob_data_del(ngtcp2_rob_data *d, const ngtcp2_mem *mem) {
65   ngtcp2_mem_free(mem, d);
66 }
67 
ngtcp2_rob_init(ngtcp2_rob * rob,size_t chunk,const ngtcp2_mem * mem)68 int ngtcp2_rob_init(ngtcp2_rob *rob, size_t chunk, const ngtcp2_mem *mem) {
69   int rv;
70   ngtcp2_rob_gap *g;
71 
72   rv = ngtcp2_ksl_init(&rob->gapksl, ngtcp2_ksl_range_compar,
73                        sizeof(ngtcp2_range), mem);
74   if (rv != 0) {
75     goto fail_gapksl_ksl_init;
76   }
77 
78   rv = ngtcp2_rob_gap_new(&g, 0, UINT64_MAX, mem);
79   if (rv != 0) {
80     goto fail_rob_gap_new;
81   }
82 
83   rv = ngtcp2_ksl_insert(&rob->gapksl, NULL, &g->range, g);
84   if (rv != 0) {
85     goto fail_gapksl_ksl_insert;
86   }
87 
88   rv = ngtcp2_ksl_init(&rob->dataksl, ngtcp2_ksl_range_compar,
89                        sizeof(ngtcp2_range), mem);
90   if (rv != 0) {
91     goto fail_dataksl_ksl_init;
92   }
93 
94   rob->chunk = chunk;
95   rob->mem = mem;
96 
97   return 0;
98 
99 fail_dataksl_ksl_init:
100 fail_gapksl_ksl_insert:
101   ngtcp2_rob_gap_del(g, mem);
102 fail_rob_gap_new:
103   ngtcp2_ksl_free(&rob->gapksl);
104 fail_gapksl_ksl_init:
105   return rv;
106 }
107 
ngtcp2_rob_free(ngtcp2_rob * rob)108 void ngtcp2_rob_free(ngtcp2_rob *rob) {
109   ngtcp2_ksl_it it;
110 
111   if (rob == NULL) {
112     return;
113   }
114 
115   for (it = ngtcp2_ksl_begin(&rob->dataksl); !ngtcp2_ksl_it_end(&it);
116        ngtcp2_ksl_it_next(&it)) {
117     ngtcp2_rob_data_del(ngtcp2_ksl_it_get(&it), rob->mem);
118   }
119 
120   for (it = ngtcp2_ksl_begin(&rob->gapksl); !ngtcp2_ksl_it_end(&it);
121        ngtcp2_ksl_it_next(&it)) {
122     ngtcp2_rob_gap_del(ngtcp2_ksl_it_get(&it), rob->mem);
123   }
124 
125   ngtcp2_ksl_free(&rob->dataksl);
126   ngtcp2_ksl_free(&rob->gapksl);
127 }
128 
rob_write_data(ngtcp2_rob * rob,uint64_t offset,const uint8_t * data,size_t len)129 static int rob_write_data(ngtcp2_rob *rob, uint64_t offset, const uint8_t *data,
130                           size_t len) {
131   size_t n;
132   int rv;
133   ngtcp2_rob_data *d;
134   ngtcp2_range range = {offset, offset + len};
135   ngtcp2_ksl_it it;
136 
137   for (it = ngtcp2_ksl_lower_bound_compar(&rob->dataksl, &range,
138                                           ngtcp2_ksl_range_exclusive_compar);
139        len; ngtcp2_ksl_it_next(&it)) {
140     if (ngtcp2_ksl_it_end(&it)) {
141       d = NULL;
142     } else {
143       d = ngtcp2_ksl_it_get(&it);
144     }
145 
146     if (d == NULL || offset < d->range.begin) {
147       rv = ngtcp2_rob_data_new(&d, (offset / rob->chunk) * rob->chunk,
148                                rob->chunk, rob->mem);
149       if (rv != 0) {
150         return rv;
151       }
152 
153       rv = ngtcp2_ksl_insert(&rob->dataksl, &it, &d->range, d);
154       if (rv != 0) {
155         ngtcp2_rob_data_del(d, rob->mem);
156         return rv;
157       }
158     }
159 
160     n = (size_t)ngtcp2_min((uint64_t)len, d->range.begin + rob->chunk - offset);
161     memcpy(d->begin + (offset - d->range.begin), data, n);
162     offset += n;
163     data += n;
164     len -= n;
165   }
166 
167   return 0;
168 }
169 
ngtcp2_rob_push(ngtcp2_rob * rob,uint64_t offset,const uint8_t * data,size_t datalen)170 int ngtcp2_rob_push(ngtcp2_rob *rob, uint64_t offset, const uint8_t *data,
171                     size_t datalen) {
172   int rv;
173   ngtcp2_rob_gap *g;
174   ngtcp2_range m, l, r, q = {offset, offset + datalen};
175   ngtcp2_ksl_it it;
176 
177   it = ngtcp2_ksl_lower_bound_compar(&rob->gapksl, &q,
178                                      ngtcp2_ksl_range_exclusive_compar);
179 
180   for (; !ngtcp2_ksl_it_end(&it);) {
181     g = ngtcp2_ksl_it_get(&it);
182 
183     m = ngtcp2_range_intersect(&q, &g->range);
184     if (!ngtcp2_range_len(&m)) {
185       break;
186     }
187     if (ngtcp2_range_eq(&g->range, &m)) {
188       ngtcp2_ksl_remove_hint(&rob->gapksl, &it, &it, &g->range);
189       ngtcp2_rob_gap_del(g, rob->mem);
190       rv = rob_write_data(rob, m.begin, data + (m.begin - offset),
191                           (size_t)ngtcp2_range_len(&m));
192       if (rv != 0) {
193         return rv;
194       }
195 
196       continue;
197     }
198     ngtcp2_range_cut(&l, &r, &g->range, &m);
199     if (ngtcp2_range_len(&l)) {
200       ngtcp2_ksl_update_key(&rob->gapksl, &g->range, &l);
201       g->range = l;
202 
203       if (ngtcp2_range_len(&r)) {
204         ngtcp2_rob_gap *ng;
205         rv = ngtcp2_rob_gap_new(&ng, r.begin, r.end, rob->mem);
206         if (rv != 0) {
207           return rv;
208         }
209         rv = ngtcp2_ksl_insert(&rob->gapksl, &it, &ng->range, ng);
210         if (rv != 0) {
211           ngtcp2_rob_gap_del(ng, rob->mem);
212           return rv;
213         }
214       }
215     } else if (ngtcp2_range_len(&r)) {
216       ngtcp2_ksl_update_key(&rob->gapksl, &g->range, &r);
217       g->range = r;
218     }
219     rv = rob_write_data(rob, m.begin, data + (m.begin - offset),
220                         (size_t)ngtcp2_range_len(&m));
221     if (rv != 0) {
222       return rv;
223     }
224     ngtcp2_ksl_it_next(&it);
225   }
226   return 0;
227 }
228 
ngtcp2_rob_remove_prefix(ngtcp2_rob * rob,uint64_t offset)229 int ngtcp2_rob_remove_prefix(ngtcp2_rob *rob, uint64_t offset) {
230   ngtcp2_rob_gap *g;
231   ngtcp2_rob_data *d;
232   ngtcp2_ksl_it it;
233 
234   it = ngtcp2_ksl_begin(&rob->gapksl);
235 
236   for (; !ngtcp2_ksl_it_end(&it);) {
237     g = ngtcp2_ksl_it_get(&it);
238     if (offset <= g->range.begin) {
239       break;
240     }
241     if (offset < g->range.end) {
242       ngtcp2_range r = {offset, g->range.end};
243       ngtcp2_ksl_update_key(&rob->gapksl, &g->range, &r);
244       g->range.begin = offset;
245       break;
246     }
247     ngtcp2_ksl_remove_hint(&rob->gapksl, &it, &it, &g->range);
248     ngtcp2_rob_gap_del(g, rob->mem);
249   }
250 
251   it = ngtcp2_ksl_begin(&rob->dataksl);
252 
253   for (; !ngtcp2_ksl_it_end(&it);) {
254     d = ngtcp2_ksl_it_get(&it);
255     if (offset < d->range.begin + rob->chunk) {
256       return 0;
257     }
258     ngtcp2_ksl_remove_hint(&rob->dataksl, &it, &it, &d->range);
259     ngtcp2_rob_data_del(d, rob->mem);
260   }
261 
262   return 0;
263 }
264 
ngtcp2_rob_data_at(ngtcp2_rob * rob,const uint8_t ** pdest,uint64_t offset)265 size_t ngtcp2_rob_data_at(ngtcp2_rob *rob, const uint8_t **pdest,
266                           uint64_t offset) {
267   ngtcp2_rob_gap *g;
268   ngtcp2_rob_data *d;
269   ngtcp2_ksl_it it;
270 
271   it = ngtcp2_ksl_begin(&rob->gapksl);
272   if (ngtcp2_ksl_it_end(&it)) {
273     return 0;
274   }
275 
276   g = ngtcp2_ksl_it_get(&it);
277 
278   if (g->range.begin <= offset) {
279     return 0;
280   }
281 
282   it = ngtcp2_ksl_begin(&rob->dataksl);
283   d = ngtcp2_ksl_it_get(&it);
284 
285   assert(d);
286   assert(d->range.begin <= offset);
287   assert(offset < d->range.begin + rob->chunk);
288 
289   *pdest = d->begin + (offset - d->range.begin);
290 
291   return (size_t)(ngtcp2_min(g->range.begin, d->range.begin + rob->chunk) -
292                   offset);
293 }
294 
ngtcp2_rob_pop(ngtcp2_rob * rob,uint64_t offset,size_t len)295 void ngtcp2_rob_pop(ngtcp2_rob *rob, uint64_t offset, size_t len) {
296   ngtcp2_ksl_it it;
297   ngtcp2_rob_data *d;
298 
299   it = ngtcp2_ksl_begin(&rob->dataksl);
300   d = ngtcp2_ksl_it_get(&it);
301 
302   assert(d);
303 
304   if (offset + len < d->range.begin + rob->chunk) {
305     return;
306   }
307 
308   ngtcp2_ksl_remove_hint(&rob->dataksl, NULL, &it, &d->range);
309   ngtcp2_rob_data_del(d, rob->mem);
310 }
311 
ngtcp2_rob_first_gap_offset(ngtcp2_rob * rob)312 uint64_t ngtcp2_rob_first_gap_offset(ngtcp2_rob *rob) {
313   ngtcp2_ksl_it it = ngtcp2_ksl_begin(&rob->gapksl);
314   ngtcp2_rob_gap *g;
315 
316   if (ngtcp2_ksl_it_end(&it)) {
317     return UINT64_MAX;
318   }
319 
320   g = ngtcp2_ksl_it_get(&it);
321 
322   return g->range.begin;
323 }
324 
ngtcp2_rob_data_buffered(ngtcp2_rob * rob)325 int ngtcp2_rob_data_buffered(ngtcp2_rob *rob) {
326   return ngtcp2_ksl_len(&rob->dataksl) != 0;
327 }
328