1 /* 2 * nghttp2 - HTTP/2 C Library 3 * 4 * Copyright (c) 2017 ngtcp2 contributors 5 * Copyright (c) 2012 nghttp2 contributors 6 * 7 * Permission is hereby granted, free of charge, to any person obtaining 8 * a copy of this software and associated documentation files (the 9 * "Software"), to deal in the Software without restriction, including 10 * without limitation the rights to use, copy, modify, merge, publish, 11 * distribute, sublicense, and/or sell copies of the Software, and to 12 * permit persons to whom the Software is furnished to do so, subject to 13 * the following conditions: 14 * 15 * The above copyright notice and this permission notice shall be 16 * included in all copies or substantial portions of the Software. 17 * 18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 19 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF 20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 21 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE 22 * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION 23 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION 24 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 25 */ 26 #ifndef NGHTTP2_MAP_H 27 #define NGHTTP2_MAP_H 28 29 #ifdef HAVE_CONFIG_H 30 # include <config.h> 31 #endif /* HAVE_CONFIG_H */ 32 33 #include <nghttp2/nghttp2.h> 34 35 #include "nghttp2_mem.h" 36 37 /* Implementation of unordered map */ 38 39 typedef int32_t nghttp2_map_key_type; 40 41 typedef struct nghttp2_map_bucket { 42 uint32_t hash; 43 nghttp2_map_key_type key; 44 void *data; 45 } nghttp2_map_bucket; 46 47 typedef struct nghttp2_map { 48 nghttp2_map_bucket *table; 49 nghttp2_mem *mem; 50 size_t size; 51 uint32_t tablelen; 52 uint32_t tablelenbits; 53 } nghttp2_map; 54 55 /* 56 * Initializes the map |map|. 57 */ 58 void nghttp2_map_init(nghttp2_map *map, nghttp2_mem *mem); 59 60 /* 61 * Deallocates any resources allocated for |map|. The stored entries 62 * are not freed by this function. Use nghttp2_map_each_free() to free 63 * each entries. 64 */ 65 void nghttp2_map_free(nghttp2_map *map); 66 67 /* 68 * Deallocates each entries using |func| function and any resources 69 * allocated for |map|. The |func| function is responsible for freeing 70 * given the |data| object. The |ptr| will be passed to the |func| as 71 * send argument. The return value of the |func| will be ignored. 72 */ 73 void nghttp2_map_each_free(nghttp2_map *map, int (*func)(void *data, void *ptr), 74 void *ptr); 75 76 /* 77 * Inserts the new |data| with the |key| to the map |map|. 78 * 79 * This function returns 0 if it succeeds, or one of the following 80 * negative error codes: 81 * 82 * NGHTTP2_ERR_INVALID_ARGUMENT 83 * The item associated by |key| already exists. 84 * NGHTTP2_ERR_NOMEM 85 * Out of memory 86 */ 87 int nghttp2_map_insert(nghttp2_map *map, nghttp2_map_key_type key, void *data); 88 89 /* 90 * Returns the data associated by the key |key|. If there is no such 91 * data, this function returns NULL. 92 */ 93 void *nghttp2_map_find(nghttp2_map *map, nghttp2_map_key_type key); 94 95 /* 96 * Removes the data associated by the key |key| from the |map|. The 97 * removed data is not freed by this function. 98 * 99 * This function returns 0 if it succeeds, or one of the following 100 * negative error codes: 101 * 102 * NGHTTP2_ERR_INVALID_ARGUMENT 103 * The data associated by |key| does not exist. 104 */ 105 int nghttp2_map_remove(nghttp2_map *map, nghttp2_map_key_type key); 106 107 /* 108 * Removes all entries from |map|. 109 */ 110 void nghttp2_map_clear(nghttp2_map *map); 111 112 /* 113 * Returns the number of items stored in the map |map|. 114 */ 115 size_t nghttp2_map_size(nghttp2_map *map); 116 117 /* 118 * Applies the function |func| to each data in the |map| with the 119 * optional user supplied pointer |ptr|. 120 * 121 * If the |func| returns 0, this function calls the |func| with the 122 * next data. If the |func| returns nonzero, it will not call the 123 * |func| for further entries and return the return value of the 124 * |func| immediately. Thus, this function returns 0 if all the 125 * invocations of the |func| return 0, or nonzero value which the last 126 * invocation of |func| returns. 127 * 128 * Don't use this function to free each data. Use 129 * nghttp2_map_each_free() instead. 130 */ 131 int nghttp2_map_each(nghttp2_map *map, int (*func)(void *data, void *ptr), 132 void *ptr); 133 134 void nghttp2_map_print_distance(nghttp2_map *map); 135 136 #endif /* NGHTTP2_MAP_H */ 137