1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2018-2019 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. 4*5113495bSYour Name * 5*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 6*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 7*5113495bSYour Name * above copyright notice and this permission notice appear in all 8*5113495bSYour Name * copies. 9*5113495bSYour Name * 10*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 11*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 12*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 13*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 14*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 15*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 16*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 17*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 18*5113495bSYour Name */ 19*5113495bSYour Name 20*5113495bSYour Name /** 21*5113495bSYour Name * DOC: qdf_hashtable.h - Public APIs for a hashtable data structure 22*5113495bSYour Name */ 23*5113495bSYour Name 24*5113495bSYour Name #ifndef __QDF_HASHTABLE_H 25*5113495bSYour Name #define __QDF_HASHTABLE_H 26*5113495bSYour Name 27*5113495bSYour Name #include "i_qdf_hashtable.h" 28*5113495bSYour Name 29*5113495bSYour Name /* 30*5113495bSYour Name * qdf_ht - opaque hashtable data type 31*5113495bSYour Name */ 32*5113495bSYour Name #define qdf_ht __qdf_ht 33*5113495bSYour Name 34*5113495bSYour Name /* 35*5113495bSYour Name * qdf_ht_entry - opaque hashtable entry for membership in a qdf_ht 36*5113495bSYour Name */ 37*5113495bSYour Name #define qdf_ht_entry __qdf_ht_entry 38*5113495bSYour Name 39*5113495bSYour Name /** 40*5113495bSYour Name * qdf_ht_declare() - declare a new qdf_ht 41*5113495bSYour Name * @name: variable name of the hashtable to declare 42*5113495bSYour Name * @bits: number of hash bits to use; buckets=2^bits; Needs to be a compile 43*5113495bSYour Name * time constant 44*5113495bSYour Name * 45*5113495bSYour Name */ 46*5113495bSYour Name #define qdf_ht_declare(name, bits) __qdf_ht_declare(name, bits) 47*5113495bSYour Name 48*5113495bSYour Name /** 49*5113495bSYour Name * qdf_ht_init() - initialize a qdf_ht instance 50*5113495bSYour Name * @table: a non-pointer qdf_ht instance to initialize 51*5113495bSYour Name * 52*5113495bSYour Name * Return: none 53*5113495bSYour Name */ 54*5113495bSYour Name #define qdf_ht_init(table) __qdf_ht_init(table) 55*5113495bSYour Name 56*5113495bSYour Name /** 57*5113495bSYour Name * qdf_ht_deinit() - de-initialize a qdf_ht instance 58*5113495bSYour Name * @table: a non-pointer qdf_ht instance to de-initialize 59*5113495bSYour Name * 60*5113495bSYour Name * Return: none 61*5113495bSYour Name */ 62*5113495bSYour Name #define qdf_ht_deinit(table) __qdf_ht_deinit(table) 63*5113495bSYour Name 64*5113495bSYour Name /** 65*5113495bSYour Name * qdf_ht_empty() - check if a qdf_ht has any entries 66*5113495bSYour Name * @table: a non-pointer qdf_ht instance to check 67*5113495bSYour Name * 68*5113495bSYour Name * Return: true if the hashtable is empty 69*5113495bSYour Name */ 70*5113495bSYour Name #define qdf_ht_empty(table) __qdf_ht_empty(table) 71*5113495bSYour Name 72*5113495bSYour Name /** 73*5113495bSYour Name * qdf_ht_add() - add an entry to a qdf_ht instance 74*5113495bSYour Name * @table: a non-pointer qdf_ht instance to add an entry to 75*5113495bSYour Name * @entry: pointer to a qdf_ht_entry instance to add to @table 76*5113495bSYour Name * @key: the key to use for entry insertion and lookup 77*5113495bSYour Name * 78*5113495bSYour Name * Return: none 79*5113495bSYour Name */ 80*5113495bSYour Name #define qdf_ht_add(table, entry, key) __qdf_ht_add(table, entry, key) 81*5113495bSYour Name 82*5113495bSYour Name /** 83*5113495bSYour Name * qdf_ht_remove() - remove and entry from a qdf_ht instance 84*5113495bSYour Name * @entry: pointer to a qdf_ht_entry instance to remove 85*5113495bSYour Name * 86*5113495bSYour Name * Return: none 87*5113495bSYour Name */ 88*5113495bSYour Name #define qdf_ht_remove(entry) __qdf_ht_remove(entry) 89*5113495bSYour Name 90*5113495bSYour Name /** 91*5113495bSYour Name * qdf_ht_for_each() - iterate all entries in @table 92*5113495bSYour Name * @table: a non-pointer qdf_ht instance to iterate 93*5113495bSYour Name * @i: int type cursor populated with the bucket index 94*5113495bSYour Name * @cursor: container struct pointer populated with each iteration 95*5113495bSYour Name * @entry_field: name of the entry field in the entry container struct 96*5113495bSYour Name */ 97*5113495bSYour Name #define qdf_ht_for_each(table, i, cursor, entry_field) \ 98*5113495bSYour Name __qdf_ht_for_each(table, i, cursor, entry_field) 99*5113495bSYour Name 100*5113495bSYour Name /** 101*5113495bSYour Name * qdf_ht_for_each_safe() - iterate all entries in @table safe against removal 102*5113495bSYour Name * of hash entry. 103*5113495bSYour Name * @table: a non-pointer qdf_ht instance to iterate 104*5113495bSYour Name * @i: int type cursor populated with the bucket index 105*5113495bSYour Name * @tmp: a &struct used for temporary storage 106*5113495bSYour Name * @cursor: container struct pointer populated with each iteration 107*5113495bSYour Name * @entry_field: name of the entry field in the entry container struct 108*5113495bSYour Name */ 109*5113495bSYour Name #define qdf_ht_for_each_safe(table, i, tmp, cursor, entry_field) \ 110*5113495bSYour Name __qdf_ht_for_each_safe(table, i, tmp, cursor, entry_field) 111*5113495bSYour Name 112*5113495bSYour Name /** 113*5113495bSYour Name * qdf_ht_for_each_in_bucket() - iterate entries in the bucket for @key 114*5113495bSYour Name * @table: a non-pointer qdf_ht instance to iterate 115*5113495bSYour Name * @cursor: container struct pointer populated with each iteration 116*5113495bSYour Name * @entry_field: name of the entry field in the entry container struct 117*5113495bSYour Name * @key: key used to lookup the hashtable bucket 118*5113495bSYour Name */ 119*5113495bSYour Name #define qdf_ht_for_each_in_bucket(table, cursor, entry_field, key) \ 120*5113495bSYour Name __qdf_ht_for_each_in_bucket(table, cursor, entry_field, key) 121*5113495bSYour Name 122*5113495bSYour Name /** 123*5113495bSYour Name * qdf_ht_for_each_match() - iterates through each entry matching @key 124*5113495bSYour Name * @table: a non-pointer qdf_ht instance to iterate 125*5113495bSYour Name * @cursor: container struct pointer populated with each iteration 126*5113495bSYour Name * @entry_field: name of the entry field in the entry container struct 127*5113495bSYour Name * @key: key used to lookup the entries 128*5113495bSYour Name * @key_field: name of the key field in the entry container struct 129*5113495bSYour Name */ 130*5113495bSYour Name #define qdf_ht_for_each_match(table, cursor, entry_field, key, key_field) \ 131*5113495bSYour Name __qdf_ht_for_each_match(table, cursor, entry_field, key, key_field) 132*5113495bSYour Name 133*5113495bSYour Name /** 134*5113495bSYour Name * qdf_ht_get() - get the first entry with a key matching @key 135*5113495bSYour Name * @table: a non-pointer qdf_ht instance to look in 136*5113495bSYour Name * @cursor: container struct pointer populated with each iteration 137*5113495bSYour Name * @entry_field: name of the entry field in the entry container struct 138*5113495bSYour Name * @key: key used to lookup the entry 139*5113495bSYour Name * @key_field: name of the key field in the entry container struct 140*5113495bSYour Name */ 141*5113495bSYour Name #define qdf_ht_get(table, cursor, entry_field, key, key_field) \ 142*5113495bSYour Name __qdf_ht_get(table, cursor, entry_field, key, key_field) 143*5113495bSYour Name 144*5113495bSYour Name #endif /* __QDF_HASHTABLE_H */ 145