pintos-os.org Git - pspp/blob - src/libpspp/intern.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 2010, 2011, 2012 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any 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, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include "libpspp/intern.h"
  20
  21 #include <assert.h>
  22 #include <string.h>
  23
  24 #include "libpspp/assertion.h"
  25 #include "libpspp/cast.h"
  26 #include "libpspp/hash-functions.h"
  27 #include "libpspp/hmap.h"
  28
  29 #include "gl/xalloc.h"
  30
  31 /* A single interned string. */
  32 struct interned_string
  33   {
  34     struct hmap_node node;      /* Node in hash table. */
  35     size_t ref_cnt;             /* Reference count. */
  36     size_t length;              /* strlen(string).  */
  37     char string[1];             /* Null-terminated string. */
  38   };
  39
  40 /* All interned strings. */
  41 static struct hmap interns = HMAP_INITIALIZER (interns);
  42
  43 /* Searches the table of interned strings for one equal to S, which has length
  44    LENGTH and hash value HASH. */
  45 static struct interned_string *
  46 intern_lookup__ (const char *s, size_t length, unsigned int hash)
  47 {
  48   struct interned_string *is;
  49
  50   HMAP_FOR_EACH_WITH_HASH (is, struct interned_string, node, hash, &interns)
  51     if (is->length == length && !memcmp (s, is->string, length))
  52       return is;
  53
  54   return NULL;
  55 }
  56
  57 /* Returns an interned version of string S.  Pass the returned string to
  58    intern_unref() to release it. */
  59 const char *
  60 intern_new (const char *s)
  61 {
  62   return intern_buffer (s, strlen (s));
  63 }
  64
  65 const char *
  66 intern_buffer (const char *s, size_t length)
  67 {
  68   unsigned int hash = hash_bytes (s, length, 0);
  69   struct interned_string *is;
  70
  71   is = intern_lookup__ (s, length, hash);
  72   if (is != NULL)
  73     is->ref_cnt++;
  74   else
  75     {
  76       is = xmalloc (length + sizeof *is);
  77       hmap_insert (&interns, &is->node, hash);
  78       is->ref_cnt = 1;
  79       is->length = length;
  80       memcpy (is->string, s, length + 1);
  81     }
  82   return is->string;
  83 }
  84
  85 static struct interned_string *
  86 interned_string_from_string (const char *s_)
  87 {
  88   char (*s)[1] = (char (*)[1]) s_;
  89   struct interned_string *is = UP_CAST (s, struct interned_string, string);
  90   assert (is->ref_cnt > 0);
  91   return is;
  92 }
  93
  94 /* Increases the reference count on S, which must be an interned string
  95    returned by intern_new(). */
  96 const char *
  97 intern_ref (const char *s)
  98 {
  99   struct interned_string *is = interned_string_from_string (s);
 100   is->ref_cnt++;
 101   return s;
 102 }
 103
 104 /* Decreases the reference count on S, which must be an interned string
 105    returned by intern_new().  If the reference count reaches 0, frees the
 106    interned string. */
 107 void
 108 intern_unref (const char *s)
 109 {
 110   struct interned_string *is = interned_string_from_string (s);
 111   if (--is->ref_cnt == 0)
 112     {
 113       hmap_delete (&interns, &is->node);
 114       free (is);
 115     }
 116 }
 117
 118 /* Returns the length of interned string S. */
 119 size_t
 120 intern_strlen (const char *s)
 121 {
 122   return interned_string_from_string (s)->length;
 123 }
 124
 125 /* Given null-terminated string S, returns true if S is an interned string
 126    returned by intern_string_new(), false otherwise.
 127
 128    This is appropriate for use in debug assertions, e.g.:
 129        assert (is_interned_string (s));
 130 */
 131 bool
 132 is_interned_string (const char *s)
 133 {
 134   size_t length = strlen (s);
 135   unsigned int hash = hash_bytes (s, length, 0);
 136   return intern_lookup__ (s, length, hash) != NULL;
 137 }