hv.h

   1 /*    hv.h
   2  *
   3  *    Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
   4  *    2000, 2001, 2002, 2005, by Larry Wall and others
   5  *
   6  *    You may distribute under the terms of either the GNU General Public
   7  *    License or the Artistic License, as specified in the README file.
   8  *
   9  */
  10
  11 /* typedefs to eliminate some typing */
  12 typedef struct he HE;
  13 typedef struct hek HEK;
  14
  15 /* entry in hash value chain */
  16 struct he {
  17     HE          *hent_next;     /* next entry in chain */
  18     HEK         *hent_hek;      /* hash key */
  19     SV          *hent_val;      /* scalar value that was hashed */
  20 };
  21
  22 /* hash key -- defined separately for use as shared pointer */
  23 struct hek {
  24     U32         hek_hash;       /* hash of key */
  25     I32         hek_len;        /* length of hash key */
  26     char        hek_key[1];     /* variable-length hash key */
  27     /* the hash-key is \0-terminated */
  28     /* after the \0 there is a byte for flags, such as whether the key
  29        is UTF-8 */
  30 };
  31
  32
  33 /* Subject to change.
  34    Don't access this directly.
  35 */
  36 struct xpvhv_aux {
  37     HEK         *xhv_name;      /* name, if a symbol table */
  38     HE          *xhv_eiter;     /* current entry of iterator */
  39     I32         xhv_riter;      /* current root of iterator */
  40 };
  41
  42 /* hash structure: */
  43 /* This structure must match the beginning of struct xpvmg in sv.h. */
  44 struct xpvhv {
  45     NV          xnv_nv;         /* numeric value, if any */
  46     STRLEN      xhv_fill;       /* how full xhv_array currently is */
  47     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
  48     union {
  49         IV      xivu_iv;        /* integer value or pv offset */
  50         UV      xivu_uv;
  51         void *  xivu_p1;
  52     }           xiv_u;
  53     MAGIC*      xmg_magic;      /* magic for scalar array */
  54     HV*         xmg_stash;      /* class package */
  55 };
  56
  57 #define xhv_keys xiv_u.xivu_iv
  58
  59 #if 0
  60 typedef struct xpvhv xpvhv_allocated;
  61 #else
  62 typedef struct {
  63     STRLEN      xhv_fill;       /* how full xhv_array currently is */
  64     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
  65     union {
  66         IV      xivu_iv;        /* integer value or pv offset */
  67         UV      xivu_uv;
  68         void *  xivu_p1;
  69     }           xiv_u;
  70     MAGIC*      xmg_magic;      /* magic for scalar array */
  71     HV*         xmg_stash;      /* class package */
  72 } xpvhv_allocated;
  73 #endif
  74
  75 /* hash a key */
  76 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
  77  * from requirements by Colin Plumb.
  78  * (http://burtleburtle.net/bob/hash/doobs.html) */
  79 /* The use of a temporary pointer and the casting games
  80  * is needed to serve the dual purposes of
  81  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
  82  *     a "char" can be either signed or signed, depending on the compiler)
  83  * (b) catering for old code that uses a "char"
  84  *
  85  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
  86  * to avoid "algorithmic complexity attacks".
  87  *
  88  * If USE_HASH_SEED is defined, hash randomisation is done by default
  89  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
  90  * only if the environment variable PERL_HASH_SEED is set.
  91  * For maximal control, one can define PERL_HASH_SEED.
  92  * (see also perl.c:perl_parse()).
  93  */
  94 #ifndef PERL_HASH_SEED
  95 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
  96 #       define PERL_HASH_SEED   PL_hash_seed
  97 #   else
  98 #       define PERL_HASH_SEED   0
  99 #   endif
 100 #endif
 101 #define PERL_HASH(hash,str,len) \
 102      STMT_START { \
 103         register const char *s_PeRlHaSh_tmp = str; \
 104         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 105         register I32 i_PeRlHaSh = len; \
 106         register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
 107         while (i_PeRlHaSh--) { \
 108             hash_PeRlHaSh += *s_PeRlHaSh++; \
 109             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 110             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 111         } \
 112         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 113         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 114         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 115     } STMT_END
 116
 117 /* Only hv.c and mod_perl should be doing this.  */
 118 #ifdef PERL_HASH_INTERNAL_ACCESS
 119 #define PERL_HASH_INTERNAL(hash,str,len) \
 120      STMT_START { \
 121         register const char *s_PeRlHaSh_tmp = str; \
 122         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
 123         register I32 i_PeRlHaSh = len; \
 124         register U32 hash_PeRlHaSh = PL_rehash_seed; \
 125         while (i_PeRlHaSh--) { \
 126             hash_PeRlHaSh += *s_PeRlHaSh++; \
 127             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
 128             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
 129         } \
 130         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
 131         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
 132         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
 133     } STMT_END
 134 #endif
 135
 136 /*
 137 =head1 Hash Manipulation Functions
 138
 139 =for apidoc AmU||HEf_SVKEY
 140 This flag, used in the length slot of hash entries and magic structures,
 141 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
 142 is to be expected. (For information only--not to be used).
 143
 144 =head1 Handy Values
 145
 146 =for apidoc AmU||Nullhv
 147 Null HV pointer.
 148
 149 =head1 Hash Manipulation Functions
 150
 151 =for apidoc Am|char*|HvNAME|HV* stash
 152 Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.
 153
 154 =for apidoc Am|void*|HeKEY|HE* he
 155 Returns the actual pointer stored in the key slot of the hash entry. The
 156 pointer may be either C<char*> or C<SV*>, depending on the value of
 157 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
 158 usually preferable for finding the value of a key.
 159
 160 =for apidoc Am|STRLEN|HeKLEN|HE* he
 161 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
 162 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
 163 be assigned to. The C<HePV()> macro is usually preferable for finding key
 164 lengths.
 165
 166 =for apidoc Am|SV*|HeVAL|HE* he
 167 Returns the value slot (type C<SV*>) stored in the hash entry.
 168
 169 =for apidoc Am|U32|HeHASH|HE* he
 170 Returns the computed hash stored in the hash entry.
 171
 172 =for apidoc Am|char*|HePV|HE* he|STRLEN len
 173 Returns the key slot of the hash entry as a C<char*> value, doing any
 174 necessary dereferencing of possibly C<SV*> keys.  The length of the string
 175 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
 176 not care about what the length of the key is, you may use the global
 177 variable C<PL_na>, though this is rather less efficient than using a local
 178 variable.  Remember though, that hash keys in perl are free to contain
 179 embedded nulls, so using C<strlen()> or similar is not a good way to find
 180 the length of hash keys. This is very similar to the C<SvPV()> macro
 181 described elsewhere in this document.
 182
 183 =for apidoc Am|SV*|HeSVKEY|HE* he
 184 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
 185 contain an C<SV*> key.
 186
 187 =for apidoc Am|SV*|HeSVKEY_force|HE* he
 188 Returns the key as an C<SV*>.  Will create and return a temporary mortal
 189 C<SV*> if the hash entry contains only a C<char*> key.
 190
 191 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
 192 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
 193 indicate the presence of an C<SV*> key, and returns the same
 194 C<SV*>.
 195
 196 =cut
 197 */
 198
 199 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
 200 #define HEf_SVKEY       -2      /* hent_key is an SV* */
 201
 202
 203 #define Nullhv Null(HV*)
 204 #define HvARRAY(hv)     (*(HE***)&((hv)->sv_u.svu_array))
 205 #define HvFILL(hv)      ((XPVHV*)  SvANY(hv))->xhv_fill
 206 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
 207 /* This quite intentionally does no flag checking first. That's your
 208    responsibility.  */
 209 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
 210 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ (HV*)(hv)))
 211 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ (HV*)(hv)))
 212 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ (HV*)(hv), r)
 213 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ (HV*)(hv), e)
 214 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
 215 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : 0)
 216 #define HvNAME(hv)      HvNAME_get(hv)
 217 /* FIXME - all of these should use a UTF8 aware API, which should also involve
 218    getting the length. */
 219 /* This macro may go away without notice.  */
 220 #define HvNAME_HEK(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_name : 0)
 221 #define HvNAME_get(hv)  ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 222                          ? HEK_KEY(HvAUX(hv)->xhv_name) : 0)
 223 #define HvNAMELEN_get(hv)       ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
 224                                  ? HEK_LEN(HvAUX(hv)->xhv_name) : 0)
 225
 226 /* the number of keys (including any placeholers) */
 227 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
 228
 229 /*
 230  * HvKEYS gets the number of keys that actually exist(), and is provided
 231  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
 232  * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
 233  */
 234 #define HvKEYS(hv)              HvUSEDKEYS(hv)
 235 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
 236 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
 237 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ (HV*)hv))
 238 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (HV*)hv) : 0)
 239 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ (HV*)hv, p)
 240
 241 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
 242 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
 243 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
 244
 245 /* This is an optimisation flag. It won't be set if all hash keys have a 0
 246  * flag. Currently the only flags relate to utf8.
 247  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
 248  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
 249  * when retrieved during iteration. It may still be set when there are no longer
 250  * any utf8 keys.
 251  * See HVhek_ENABLEHVKFLAGS for the trigger.
 252  */
 253 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
 254 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
 255 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
 256
 257 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
 258 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
 259 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
 260
 261 #define HvREHASH(hv)            (SvFLAGS(hv) & SVphv_REHASH)
 262 #define HvREHASH_on(hv)         (SvFLAGS(hv) |= SVphv_REHASH)
 263 #define HvREHASH_off(hv)        (SvFLAGS(hv) &= ~SVphv_REHASH)
 264
 265 /* Maybe amagical: */
 266 /* #define HV_AMAGICmb(hv)      (SvFLAGS(hv) & (SVpgv_badAM | SVpgv_AM)) */
 267
 268 #define HV_AMAGIC(hv)        (SvFLAGS(hv) &   SVpgv_AM)
 269 #define HV_AMAGIC_on(hv)     (SvFLAGS(hv) |=  SVpgv_AM)
 270 #define HV_AMAGIC_off(hv)    (SvFLAGS(hv) &= ~SVpgv_AM)
 271
 272 /*
 273 #define HV_AMAGICbad(hv)     (SvFLAGS(hv) & SVpgv_badAM)
 274 #define HV_badAMAGIC_on(hv)  (SvFLAGS(hv) |= SVpgv_badAM)
 275 #define HV_badAMAGIC_off(hv) (SvFLAGS(hv) &= ~SVpgv_badAM)
 276 */
 277
 278 #define Nullhe Null(HE*)
 279 #define HeNEXT(he)              (he)->hent_next
 280 #define HeKEY_hek(he)           (he)->hent_hek
 281 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
 282 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
 283 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
 284 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
 285 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
 286 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
 287 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
 288 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
 289 #define HeVAL(he)               (he)->hent_val
 290 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
 291 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
 292                                  SvPV(HeKEY_sv(he),lp) :                \
 293                                  (((lp = HeKLEN(he)) >= 0) ?            \
 294                                   HeKEY(he) : Nullch))
 295
 296 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
 297                                   HeKLEN(he) == HEf_SVKEY) ?            \
 298                                  HeKEY_sv(he) : Nullsv)
 299
 300 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
 301                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
 302                                   HeKEY_sv(he) :                        \
 303                                   sv_2mortal(newSVpvn(HeKEY(he),        \
 304                                                      HeKLEN(he)))) :    \
 305                                  &PL_sv_undef)
 306 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
 307
 308 #define Nullhek Null(HEK*)
 309 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
 310 #define HEK_HASH(hek)           (hek)->hek_hash
 311 #define HEK_LEN(hek)            (hek)->hek_len
 312 #define HEK_KEY(hek)            (hek)->hek_key
 313 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
 314
 315 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
 316 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
 317 #define HVhek_REHASH    0x04 /* This key is in an hv using a custom HASH . */
 318 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
 319 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
 320                                * (may change, but Storable is a core module) */
 321 #define HVhek_MASK      0xFF
 322
 323 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
 324    HVhek_REHASH is only needed because the rehash flag has to be duplicated
 325    into all keys as hv_iternext has no access to the hash flags. At this
 326    point Storable's tests get upset, because sometimes hashes are "keyed"
 327    and sometimes not, depending on the order of data insertion, and whether
 328    it triggered rehashing. So currently HVhek_REHAS is exempt.
 329 */
 330
 331 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK - HVhek_REHASH)
 332
 333 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
 334 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
 335 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
 336 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
 337 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
 338 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
 339 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
 340 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
 341
 342 /* calculate HV array allocation */
 343 #ifndef PERL_USE_LARGE_HV_ALLOC
 344 /* Default to allocating the correct size - default to assuming that malloc()
 345    is not broken and is efficient at allocating blocks sized at powers-of-two.
 346 */
 347 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
 348 #else
 349 #  define MALLOC_OVERHEAD 16
 350 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
 351                         (((size) < 64)                                  \
 352                          ? (size) * sizeof(HE*)                         \
 353                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
 354 #endif
 355
 356 /* Flags for hv_iternext_flags.  */
 357 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
 358
 359 /* available as a function in hv.c */
 360 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
 361 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)
 362
 363 /*
 364  * Local variables:
 365  * c-indentation-style: bsd
 366  * c-basic-offset: 4
 367  * indent-tabs-mode: t
 368  * End:
 369  *
 370  * ex: set ts=8 sts=4 sw=4 noet:
 371  */