gcc/hashtable.h

   1 /* Hash tables.
   2    Copyright (C) 2000, 2001 Free Software Foundation, Inc.
   3
   4 This program is free software; you can redistribute it and/or modify it
   5 under the terms of the GNU General Public License as published by the
   6 Free Software Foundation; either version 2, or (at your option) any
   7 later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 #ifndef GCC_HASHTABLE_H
  19 #define GCC_HASHTABLE_H
  20
  21 #include "obstack.h"
  22
  23 /* This is what each hash table entry points to.  It may be embedded
  24    deeply within another object.  */
  25 typedef struct ht_identifier ht_identifier;
  26 struct ht_identifier GTY(())
  27 {
  28   const unsigned char *str;
  29   unsigned int len;
  30   unsigned int hash_value;
  31 };
  32
  33 #define HT_LEN(NODE) ((NODE)->len)
  34 #define HT_STR(NODE) ((NODE)->str)
  35
  36 /* We want code outside cpplib, such as the compiler front-ends, to be
  37    able to include this header, and to be able to link with
  38    cpphashtbl.o without pulling in any other parts of cpplib.  */
  39
  40 struct cpp_reader;
  41 typedef struct ht hash_table;
  42 typedef struct ht_identifier *hashnode;
  43
  44 enum ht_lookup_option {HT_NO_INSERT = 0, HT_ALLOC, HT_ALLOCED};
  45
  46 /* An identifier hash table for cpplib and the front ends.  */
  47 struct ht
  48 {
  49   /* Identifiers are allocated from here.  */
  50   struct obstack stack;
  51
  52   hashnode *entries;
  53   /* Call back.  */
  54   hashnode (*alloc_node) PARAMS ((hash_table *));
  55
  56   unsigned int nslots;          /* Total slots in the entries array.  */
  57   unsigned int nelements;       /* Number of live elements.  */
  58
  59   /* Link to reader, if any.  For the benefit of cpplib.  */
  60   struct cpp_reader *pfile;
  61
  62   /* Table usage statistics.  */
  63   unsigned int searches;
  64   unsigned int collisions;
  65 };
  66
  67 extern void gcc_obstack_init PARAMS ((struct obstack *));
  68
  69 /* Initialize the hashtable with 2 ^ order entries.  */
  70 extern hash_table *ht_create PARAMS ((unsigned int order));
  71
  72 /* Frees all memory associated with a hash table.  */
  73 extern void ht_destroy PARAMS ((hash_table *));
  74
  75 extern hashnode ht_lookup PARAMS ((hash_table *, const unsigned char *,
  76                                    unsigned int, enum ht_lookup_option));
  77
  78 /* For all nodes in TABLE, make a callback.  The callback takes
  79    TABLE->PFILE, the node, and a PTR, and the callback sequence stops
  80    if the callback returns zero.  */
  81 typedef int (*ht_cb) PARAMS ((struct cpp_reader *, hashnode, const void *));
  82 extern void ht_forall PARAMS ((hash_table *, ht_cb, const void *));
  83
  84 /* Dump allocation statistics to stderr.  */
  85 extern void ht_dump_statistics PARAMS ((hash_table *));
  86
  87 /* Approximate positive square root of a host double.  This is for
  88    statistical reports, not code generation.  */
  89 extern double approx_sqrt PARAMS ((double));
  90
  91 #endif /* GCC_HASHTABLE_H */