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