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 #ifndef NGTCP2_GAPTR_H 26 #define NGTCP2_GAPTR_H 27 28 #ifdef HAVE_CONFIG_H 29 # include <config.h> 30 #endif /* HAVE_CONFIG_H */ 31 32 #include <ngtcp2/ngtcp2.h> 33 34 #include "ngtcp2_mem.h" 35 #include "ngtcp2_ksl.h" 36 #include "ngtcp2_range.h" 37 38 /* 39 * ngtcp2_gaptr maintains the gap in the range [0, UINT64_MAX). 40 */ 41 typedef struct ngtcp2_gaptr { 42 /* gap maintains the range of offset which is not received 43 yet. Initially, its range is [0, UINT64_MAX). */ 44 ngtcp2_ksl gap; 45 /* mem is custom memory allocator */ 46 const ngtcp2_mem *mem; 47 } ngtcp2_gaptr; 48 49 /* 50 * ngtcp2_gaptr_init initializes |gaptr|. 51 */ 52 void ngtcp2_gaptr_init(ngtcp2_gaptr *gaptr, const ngtcp2_mem *mem); 53 54 /* 55 * ngtcp2_gaptr_free frees resources allocated for |gaptr|. 56 */ 57 void ngtcp2_gaptr_free(ngtcp2_gaptr *gaptr); 58 59 /* 60 * ngtcp2_gaptr_push adds new data of length |datalen| at the stream 61 * offset |offset|. 62 * 63 * This function returns 0 if it succeeds, or one of the following 64 * negative error codes: 65 * 66 * NGTCP2_ERR_NOMEM 67 * Out of memory 68 */ 69 int ngtcp2_gaptr_push(ngtcp2_gaptr *gaptr, uint64_t offset, uint64_t datalen); 70 71 /* 72 * ngtcp2_gaptr_first_gap_offset returns the offset to the first gap. 73 * If there is no gap, it returns UINT64_MAX. 74 */ 75 uint64_t ngtcp2_gaptr_first_gap_offset(ngtcp2_gaptr *gaptr); 76 77 /* 78 * ngtcp2_gaptr_get_first_gap_after returns the first gap which 79 * overlaps or comes after |offset|. 80 */ 81 ngtcp2_range ngtcp2_gaptr_get_first_gap_after(ngtcp2_gaptr *gaptr, 82 uint64_t offset); 83 84 /* 85 * ngtcp2_gaptr_is_pushed returns nonzero if range [offset, offset + 86 * datalen) is completely pushed into this object. 87 */ 88 int ngtcp2_gaptr_is_pushed(ngtcp2_gaptr *gaptr, uint64_t offset, 89 uint64_t datalen); 90 91 /* 92 * ngtcp2_gaptr_drop_first_gap deletes the first gap entirely as if 93 * the range is pushed. This function assumes that at least one gap 94 * exists. 95 */ 96 void ngtcp2_gaptr_drop_first_gap(ngtcp2_gaptr *gaptr); 97 98 #endif /* NGTCP2_GAPTR_H */ 99