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