doc/crypto/OPENSSL_LH_COMPFUNC.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 DECLARE_LHASH_OF,
   6 OPENSSL_LH_COMPFUNC, OPENSSL_LH_HASHFUNC, OPENSSL_LH_DOALL_FUNC,
   7 LHASH_DOALL_ARG_FN_TYPE,
   8 lh_TYPE_new, lh_TYPE_free,
   9 lh_TYPE_insert, lh_TYPE_delete, lh_TYPE_retrieve,
  10 lh_TYPE_doall, lh_TYPE_doall_arg, lh_TYPE_error - dynamic hash table
  11
  12 =for comment generic
  13
  14 =head1 SYNOPSIS
  15
  16  #include <openssl/lhash.h>
  17
  18  DECLARE_LHASH_OF(TYPE);
  19
  20  LHASH *lh_TYPE_new();
  21  void lh_TYPE_free(LHASH_OF(TYPE *table);
  22
  23  TYPE *lh_TYPE_insert(LHASH_OF(TYPE *table, TYPE *data);
  24  TYPE *lh_TYPE_delete(LHASH_OF(TYPE *table, TYPE *data);
  25  TYPE *lh_retrieve(LHASH_OFTYPE *table, TYPE *data);
  26
  27  void lh_TYPE_doall(LHASH_OF(TYPE *table, OPENSSL_LH_DOALL_FUNC func);
  28  void lh_TYPE_doall_arg(LHASH_OF(TYPE) *table, OPENSSL_LH_DOALL_FUNCARG func,
  29           TYPE, TYPE *arg);
  30
  31  int lh_TYPE_error(LHASH_OF(TYPE) *table);
  32
  33  typedef int (*OPENSSL_LH_COMPFUNC)(const void *, const void *);
  34  typedef unsigned long (*OPENSSL_LH_HASHFUNC)(const void *);
  35  typedef void (*OPENSSL_LH_DOALL_FUNC)(const void *);
  36  typedef void (*LHASH_DOALL_ARG_FN_TYPE)(const void *, const void *);
  37
  38 =head1 DESCRIPTION
  39
  40 This library implements type-checked dynamic hash tables. The hash
  41 table entries can be arbitrary structures. Usually they consist of key
  42 and value fields.  In the description here, I<TYPE> is used a placeholder
  43 for any of the OpenSSL datatypes, such as I<SSL_SESSION>.
  44
  45 lh_TYPE_new() creates a new B<LHASH_OF(TYPE)> structure to store
  46 arbitrary data entries, and provides the 'hash' and 'compare'
  47 callbacks to be used in organising the table's entries.  The B<hash>
  48 callback takes a pointer to a table entry as its argument and returns
  49 an unsigned long hash value for its key field.  The hash value is
  50 normally truncated to a power of 2, so make sure that your hash
  51 function returns well mixed low order bits.  The B<compare> callback
  52 takes two arguments (pointers to two hash table entries), and returns
  53 0 if their keys are equal, non-zero otherwise.  If your hash table
  54 will contain items of some particular type and the B<hash> and
  55 B<compare> callbacks hash/compare these types, then the
  56 B<DECLARE_LHASH_HASH_FN> and B<IMPLEMENT_LHASH_COMP_FN> macros can be
  57 used to create callback wrappers of the prototypes required by
  58 lh_TYPE_new().  These provide per-variable casts before calling the
  59 type-specific callbacks written by the application author.  These
  60 macros, as well as those used for the "doall" callbacks, are defined
  61 as;
  62
  63  #define DECLARE_LHASH_HASH_FN(name, o_type) \
  64          unsigned long name##_LHASH_HASH(const void *);
  65  #define IMPLEMENT_LHASH_HASH_FN(name, o_type) \
  66          unsigned long name##_LHASH_HASH(const void *arg) { \
  67                  const o_type *a = arg; \
  68                  return name##_hash(a); }
  69  #define LHASH_HASH_FN(name) name##_LHASH_HASH
  70
  71  #define DECLARE_LHASH_COMP_FN(name, o_type) \
  72          int name##_LHASH_COMP(const void *, const void *);
  73  #define IMPLEMENT_LHASH_COMP_FN(name, o_type) \
  74          int name##_LHASH_COMP(const void *arg1, const void *arg2) { \
  75                  const o_type *a = arg1;                    \
  76                  const o_type *b = arg2; \
  77                  return name##_cmp(a,b); }
  78  #define LHASH_COMP_FN(name) name##_LHASH_COMP
  79
  80  #define DECLARE_LHASH_DOALL_FN(name, o_type) \
  81          void name##_LHASH_DOALL(void *);
  82  #define IMPLEMENT_LHASH_DOALL_FN(name, o_type) \
  83          void name##_LHASH_DOALL(void *arg) { \
  84                  o_type *a = arg; \
  85                  name##_doall(a); }
  86  #define LHASH_DOALL_FN(name) name##_LHASH_DOALL
  87
  88  #define DECLARE_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
  89          void name##_LHASH_DOALL_ARG(void *, void *);
  90  #define IMPLEMENT_LHASH_DOALL_ARG_FN(name, o_type, a_type) \
  91          void name##_LHASH_DOALL_ARG(void *arg1, void *arg2) { \
  92                  o_type *a = arg1; \
  93                  a_type *b = arg2; \
  94                  name##_doall_arg(a, b); }
  95  #define LHASH_DOALL_ARG_FN(name) name##_LHASH_DOALL_ARG
  96
  97  An example of a hash table storing (pointers to) structures of type 'STUFF'
  98  could be defined as follows;
  99
 100  /* Calculates the hash value of 'tohash' (implemented elsewhere) */
 101  unsigned long STUFF_hash(const STUFF *tohash);
 102  /* Orders 'arg1' and 'arg2' (implemented elsewhere) */
 103  int stuff_cmp(const STUFF *arg1, const STUFF *arg2);
 104  /* Create the type-safe wrapper functions for use in the LHASH internals */
 105  static IMPLEMENT_LHASH_HASH_FN(stuff, STUFF);
 106  static IMPLEMENT_LHASH_COMP_FN(stuff, STUFF);
 107  /* ... */
 108  int main(int argc, char *argv[]) {
 109          /* Create the new hash table using the hash/compare wrappers */
 110          LHASH_OF(STUFF) *hashtable = lh_STUFF_new(LHASH_HASH_FN(STUFF_hash),
 111                                    LHASH_COMP_FN(STUFF_cmp));
 112          /* ... */
 113  }
 114
 115 lh_TYPE_free() frees the B<LHASH_OF(TYPE)> structure
 116 B<table>. Allocated hash table entries will not be freed; consider
 117 using lh_TYPE_doall() to deallocate any remaining entries in the
 118 hash table (see below).
 119
 120 lh_TYPE_insert() inserts the structure pointed to by B<data> into
 121 B<table>.  If there already is an entry with the same key, the old
 122 value is replaced. Note that lh_TYPE_insert() stores pointers, the
 123 data are not copied.
 124
 125 lh_TYPE_delete() deletes an entry from B<table>.
 126
 127 lh_TYPE_retrieve() looks up an entry in B<table>. Normally, B<data>
 128 is a structure with the key field(s) set; the function will return a
 129 pointer to a fully populated structure.
 130
 131 lh_TYPE_doall() will, for every entry in the hash table, call
 132 B<func> with the data item as its parameter.  For lh_TYPE_doall()
 133 and lh_TYPE_doall_arg(), function pointer casting should be avoided
 134 in the callbacks (see B<NOTE>) - instead use the declare/implement
 135 macros to create type-checked wrappers that cast variables prior to
 136 calling your type-specific callbacks.  An example of this is
 137 illustrated here where the callback is used to cleanup resources for
 138 items in the hash table prior to the hashtable itself being
 139 deallocated:
 140
 141  /* Cleans up resources belonging to 'a' (this is implemented elsewhere) */
 142  void STUFF_cleanup_doall(STUFF *a);
 143  /* Implement a prototype-compatible wrapper for "STUFF_cleanup" */
 144  IMPLEMENT_LHASH_DOALL_FN(STUFF_cleanup, STUFF)
 145          /* ... then later in the code ... */
 146  /* So to run "STUFF_cleanup" against all items in a hash table ... */
 147  lh_STUFF_doall(hashtable, LHASH_DOALL_FN(STUFF_cleanup));
 148  /* Then the hash table itself can be deallocated */
 149  lh_STUFF_free(hashtable);
 150
 151 When doing this, be careful if you delete entries from the hash table
 152 in your callbacks: the table may decrease in size, moving the item
 153 that you are currently on down lower in the hash table - this could
 154 cause some entries to be skipped during the iteration.  The second
 155 best solution to this problem is to set hash-E<gt>down_load=0 before
 156 you start (which will stop the hash table ever decreasing in size).
 157 The best solution is probably to avoid deleting items from the hash
 158 table inside a "doall" callback!
 159
 160 lh_TYPE_doall_arg() is the same as lh_TYPE_doall() except that
 161 B<func> will be called with B<arg> as the second argument and B<func>
 162 should be of type B<LHASH_DOALL_ARG_FN_TYPE> (a callback prototype
 163 that is passed both the table entry and an extra argument).  As with
 164 lh_doall(), you can instead choose to declare your callback with a
 165 prototype matching the types you are dealing with and use the
 166 declare/implement macros to create compatible wrappers that cast
 167 variables before calling your type-specific callbacks.  An example of
 168 this is demonstrated here (printing all hash table entries to a BIO
 169 that is provided by the caller):
 170
 171  /* Prints item 'a' to 'output_bio' (this is implemented elsewhere) */
 172  void STUFF_print_doall_arg(const STUFF *a, BIO *output_bio);
 173  /* Implement a prototype-compatible wrapper for "STUFF_print" */
 174  static IMPLEMENT_LHASH_DOALL_ARG_FN(STUFF, const STUFF, BIO)
 175          /* ... then later in the code ... */
 176  /* Print out the entire hashtable to a particular BIO */
 177  lh_STUFF_doall_arg(hashtable, LHASH_DOALL_ARG_FN(STUFF_print), BIO,
 178                     logging_bio);
 179
 180
 181 lh_TYPE_error() can be used to determine if an error occurred in the last
 182 operation.
 183
 184 =head1 RETURN VALUES
 185
 186 lh_TYPE_new() returns B<NULL> on error, otherwise a pointer to the new
 187 B<LHASH> structure.
 188
 189 When a hash table entry is replaced, lh_TYPE_insert() returns the value
 190 being replaced. B<NULL> is returned on normal operation and on error.
 191
 192 lh_TYPE_delete() returns the entry being deleted.  B<NULL> is returned if
 193 there is no such value in the hash table.
 194
 195 lh_TYPE_retrieve() returns the hash table entry if it has been found,
 196 B<NULL> otherwise.
 197
 198 lh_TYPE_error() returns 1 if an error occurred in the last operation, 0
 199 otherwise.
 200
 201 lh_TYPE_free(), lh_TYPE_doall() and lh_TYPE_doall_arg() return no values.
 202
 203 =head1 NOTE
 204
 205 The various LHASH macros and callback types exist to make it possible
 206 to write type-checked code without resorting to function-prototype
 207 casting - an evil that makes application code much harder to
 208 audit/verify and also opens the window of opportunity for stack
 209 corruption and other hard-to-find bugs.  It also, apparently, violates
 210 ANSI-C.
 211
 212 The LHASH code regards table entries as constant data.  As such, it
 213 internally represents lh_insert()'d items with a "const void *"
 214 pointer type.  This is why callbacks such as those used by lh_doall()
 215 and lh_doall_arg() declare their prototypes with "const", even for the
 216 parameters that pass back the table items' data pointers - for
 217 consistency, user-provided data is "const" at all times as far as the
 218 LHASH code is concerned.  However, as callers are themselves providing
 219 these pointers, they can choose whether they too should be treating
 220 all such parameters as constant.
 221
 222 As an example, a hash table may be maintained by code that, for
 223 reasons of encapsulation, has only "const" access to the data being
 224 indexed in the hash table (ie. it is returned as "const" from
 225 elsewhere in their code) - in this case the LHASH prototypes are
 226 appropriate as-is.  Conversely, if the caller is responsible for the
 227 life-time of the data in question, then they may well wish to make
 228 modifications to table item passed back in the lh_doall() or
 229 lh_doall_arg() callbacks (see the "STUFF_cleanup" example above).  If
 230 so, the caller can either cast the "const" away (if they're providing
 231 the raw callbacks themselves) or use the macros to declare/implement
 232 the wrapper functions without "const" types.
 233
 234 Callers that only have "const" access to data they're indexing in a
 235 table, yet declare callbacks without constant types (or cast the
 236 "const" away themselves), are therefore creating their own risks/bugs
 237 without being encouraged to do so by the API.  On a related note,
 238 those auditing code should pay special attention to any instances of
 239 DECLARE/IMPLEMENT_LHASH_DOALL_[ARG_]_FN macros that provide types
 240 without any "const" qualifiers.
 241
 242 =head1 BUGS
 243
 244 lh_TYPE_insert() returns B<NULL> both for success and error.
 245
 246 =head1 SEE ALSO
 247
 248 L<lh_stats(3)>
 249
 250 =head1 HISTORY
 251
 252 In OpenSSL 1.0.0, the lhash interface was revamped for better
 253 type checking.
 254
 255 =head1 COPYRIGHT
 256
 257 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 258
 259 Licensed under the OpenSSL license (the "License").  You may not use
 260 this file except in compliance with the License.  You can obtain a copy
 261 in the file LICENSE in the source distribution or at
 262 L<https://www.openssl.org/source/license.html>.
 263
 264 =cut