util.c:report_evil_fh: Report name w/initial null
[perl.git] / hv.h
1 /*    hv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 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    Use the funcs in mro.c
42 */
43
44 struct mro_alg {
45     AV *(*resolve)(pTHX_ HV* stash, U32 level);
46     const char *name;
47     U16 length;
48     U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */
49     U32 hash; /* or 0 */
50 };
51
52 struct mro_meta {
53     /* a hash holding the different MROs private data.  */
54     HV      *mro_linear_all;
55     /* a pointer directly to the current MROs private data.  If mro_linear_all
56        is NULL, this owns the SV reference, else it is just a pointer to a
57        value stored in and owned by mro_linear_all.  */
58     SV      *mro_linear_current;
59     HV      *mro_nextmethod; /* next::method caching */
60     U32     cache_gen;       /* Bumping this invalidates our method cache */
61     U32     pkg_gen;         /* Bumps when local methods/@ISA change */
62     const struct mro_alg *mro_which; /* which mro alg is in use? */
63     HV      *isa;            /* Everything this class @ISA */
64 };
65
66 #define MRO_GET_PRIVATE_DATA(smeta, which)                 \
67     (((smeta)->mro_which && (which) == (smeta)->mro_which) \
68      ? (smeta)->mro_linear_current                         \
69      : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
70
71 /* Subject to change.
72    Don't access this directly.
73 */
74
75 union _xhvnameu {
76     HEK *xhvnameu_name;         /* When xhv_name_count is 0 */
77     HEK **xhvnameu_names;       /* When xhv_name_count is non-0 */
78 };
79
80 struct xpvhv_aux {
81     union _xhvnameu xhv_name_u; /* name, if a symbol table */
82     AV          *xhv_backreferences; /* back references for weak references */
83     HE          *xhv_eiter;     /* current entry of iterator */
84     I32         xhv_riter;      /* current root of iterator */
85 /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer 
86  * to an array of HEK pointers, this being the length. The first element is
87  * the name of the stash, which may be NULL. If xhv_name_count is positive,
88  * then *xhv_name is one of the effective names. If xhv_name_count is nega-
89  * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name.
90  */
91     I32         xhv_name_count;
92     struct mro_meta *xhv_mro_meta;
93 };
94
95 /* hash structure: */
96 /* This structure must match the beginning of struct xpvmg in sv.h. */
97 struct xpvhv {
98     HV*         xmg_stash;      /* class package */
99     union _xmgu xmg_u;
100     STRLEN      xhv_keys;       /* total keys, including placeholders */
101     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
102 };
103
104 /* hash a key */
105 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
106  * from requirements by Colin Plumb.
107  * (http://burtleburtle.net/bob/hash/doobs.html) */
108 /* The use of a temporary pointer and the casting games
109  * is needed to serve the dual purposes of
110  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
111  *     a "char" can be either signed or unsigned, depending on the compiler)
112  * (b) catering for old code that uses a "char"
113  *
114  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
115  * to avoid "algorithmic complexity attacks".
116  *
117  * If USE_HASH_SEED is defined, hash randomisation is done by default
118  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
119  * only if the environment variable PERL_HASH_SEED is set.
120  * For maximal control, one can define PERL_HASH_SEED.
121  * (see also perl.c:perl_parse()).
122  */
123 #ifndef PERL_HASH_SEED
124 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
125 #       define PERL_HASH_SEED   PL_hash_seed
126 #   else
127 #       define PERL_HASH_SEED   0
128 #   endif
129 #endif
130
131 #define PERL_HASH(hash,str,len) PERL_HASH_INTERNAL_(hash,str,len,0)
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) PERL_HASH_INTERNAL_(hash,str,len,1)
136 #endif
137
138 /* Common base for PERL_HASH and PERL_HASH_INTERNAL that parameterises
139  * the source of the seed. Not for direct use outside of hv.c. */
140
141 #define PERL_HASH_INTERNAL_(hash,str,len,internal) \
142      STMT_START { \
143         register const char * const s_PeRlHaSh_tmp = str; \
144         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
145         register I32 i_PeRlHaSh = len; \
146         register U32 hash_PeRlHaSh = (internal ? PL_rehash_seed : PERL_HASH_SEED); \
147         while (i_PeRlHaSh--) { \
148             hash_PeRlHaSh += *s_PeRlHaSh++; \
149             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
150             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
151         } \
152         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
153         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
154         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
155     } STMT_END
156
157 /*
158 =head1 Hash Manipulation Functions
159
160 =for apidoc AmU||HEf_SVKEY
161 This flag, used in the length slot of hash entries and magic structures,
162 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
163 is to be expected. (For information only--not to be used).
164
165 =head1 Handy Values
166
167 =for apidoc AmU||Nullhv
168 Null HV pointer.
169
170 (deprecated - use C<(HV *)NULL> instead)
171
172 =head1 Hash Manipulation Functions
173
174 =for apidoc Am|char*|HvNAME|HV* stash
175 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
176 See C<SvSTASH>, C<CvSTASH>.
177
178 =for apidoc Am|STRLEN|HvNAMELEN|HV *stash
179 Returns the length of the stash's name.
180
181 =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash
182 Returns true if the name is in UTF8 encoding.
183
184 =for apidoc Am|char*|HvENAME|HV* stash
185 Returns the effective name of a stash, or NULL if there is none. The
186 effective name represents a location in the symbol table where this stash
187 resides. It is updated automatically when packages are aliased or deleted.
188 A stash that is no longer in the symbol table has no effective name. This
189 name is preferable to C<HvNAME> for use in MRO linearisations and isa
190 caches.
191
192 =for apidoc Am|STRLEN|HvENAMELEN|HV *stash
193 Returns the length of the stash's effective name.
194
195 =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash
196 Returns true if the effective name is in UTF8 encoding.
197
198 =for apidoc Am|void*|HeKEY|HE* he
199 Returns the actual pointer stored in the key slot of the hash entry. The
200 pointer may be either C<char*> or C<SV*>, depending on the value of
201 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
202 usually preferable for finding the value of a key.
203
204 =for apidoc Am|STRLEN|HeKLEN|HE* he
205 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
206 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
207 be assigned to. The C<HePV()> macro is usually preferable for finding key
208 lengths.
209
210 =for apidoc Am|SV*|HeVAL|HE* he
211 Returns the value slot (type C<SV*>) stored in the hash entry.
212
213 =for apidoc Am|U32|HeHASH|HE* he
214 Returns the computed hash stored in the hash entry.
215
216 =for apidoc Am|char*|HePV|HE* he|STRLEN len
217 Returns the key slot of the hash entry as a C<char*> value, doing any
218 necessary dereferencing of possibly C<SV*> keys.  The length of the string
219 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
220 not care about what the length of the key is, you may use the global
221 variable C<PL_na>, though this is rather less efficient than using a local
222 variable.  Remember though, that hash keys in perl are free to contain
223 embedded nulls, so using C<strlen()> or similar is not a good way to find
224 the length of hash keys. This is very similar to the C<SvPV()> macro
225 described elsewhere in this document. See also C<HeUTF8>.
226
227 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
228 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
229 efficient.
230
231 =for apidoc Am|char*|HeUTF8|HE* he
232 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
233 doing any necessary dereferencing of possibly C<SV*> keys.  The value returned
234 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
235 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
236 typedef for C<char>.
237
238 =for apidoc Am|SV*|HeSVKEY|HE* he
239 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
240 contain an C<SV*> key.
241
242 =for apidoc Am|SV*|HeSVKEY_force|HE* he
243 Returns the key as an C<SV*>.  Will create and return a temporary mortal
244 C<SV*> if the hash entry contains only a C<char*> key.
245
246 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
247 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
248 indicate the presence of an C<SV*> key, and returns the same
249 C<SV*>.
250
251 =cut
252 */
253
254 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
255 #define HEf_SVKEY       -2      /* hent_key is an SV* */
256
257 #ifndef PERL_CORE
258 #  define Nullhv Null(HV*)
259 #endif
260 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
261 #define HvFILL(hv)      Perl_hv_fill(aTHX_ (const HV *)(hv))
262 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
263 /* This quite intentionally does no flag checking first. That's your
264    responsibility.  */
265 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
266 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
267 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
268 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
269 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
270 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
271 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
272 #define HvNAME(hv)      HvNAME_get(hv)
273 #define HvNAMELEN(hv)   HvNAMELEN_get(hv)
274 #define HvENAME(hv)     HvENAME_get(hv)
275 #define HvENAMELEN(hv)  HvENAMELEN_get(hv)
276
277 /* Checking that hv is a valid package stash is the
278    caller's responsibility */
279 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
280                        ? HvAUX(hv)->xhv_mro_meta \
281                        : Perl_mro_meta_init(aTHX_ hv))
282
283 #define HvNAME_HEK_NN(hv)                         \
284  (                                                \
285   HvAUX(hv)->xhv_name_count                       \
286   ? *HvAUX(hv)->xhv_name_u.xhvnameu_names         \
287   : HvAUX(hv)->xhv_name_u.xhvnameu_name           \
288  )
289 /* This macro may go away without notice.  */
290 #define HvNAME_HEK(hv) \
291         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL)
292 #define HvNAME_get(hv) \
293         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
294                          ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL)
295 #define HvNAMELEN_get(hv) \
296         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
297                                  ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0)
298 #define HvNAMEUTF8(hv) \
299         ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \
300                                  ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0)
301 #define HvENAME_HEK_NN(hv)                                             \
302  (                                                                      \
303   HvAUX(hv)->xhv_name_count > 0   ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \
304   HvAUX(hv)->xhv_name_count < -1  ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \
305   HvAUX(hv)->xhv_name_count == -1 ? NULL                              : \
306                                     HvAUX(hv)->xhv_name_u.xhvnameu_name \
307  )
308 #define HvENAME_HEK(hv) \
309         (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL)
310 #define HvENAME_get(hv) \
311    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
312                          ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL)
313 #define HvENAMELEN_get(hv) \
314    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
315                                  ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0)
316 #define HvENAMEUTF8(hv) \
317    ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \
318                                  ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0)
319
320 /* the number of keys (including any placeholders) */
321 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
322
323 /*
324  * HvKEYS gets the number of keys that actually exist(), and is provided
325  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
326  * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders)
327  */
328 #define HvKEYS(hv)              HvUSEDKEYS(hv)
329 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
330 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
331 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
332 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
333 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
334
335 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
336 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
337 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
338
339 /* This is an optimisation flag. It won't be set if all hash keys have a 0
340  * flag. Currently the only flags relate to utf8.
341  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
342  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
343  * when retrieved during iteration. It may still be set when there are no longer
344  * any utf8 keys.
345  * See HVhek_ENABLEHVKFLAGS for the trigger.
346  */
347 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
348 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
349 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
350
351 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
352 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
353 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
354
355 #define HvREHASH(hv)            (SvFLAGS(hv) & SVphv_REHASH)
356 #define HvREHASH_on(hv)         (SvFLAGS(hv) |= SVphv_REHASH)
357 #define HvREHASH_off(hv)        (SvFLAGS(hv) &= ~SVphv_REHASH)
358
359 #ifndef PERL_CORE
360 #  define Nullhe Null(HE*)
361 #endif
362 #define HeNEXT(he)              (he)->hent_next
363 #define HeKEY_hek(he)           (he)->hent_hek
364 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
365 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
366 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
367 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
368 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
369 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
370 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
371 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
372 #define HeVAL(he)               (he)->he_valu.hent_val
373 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
374 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
375                                  SvPV(HeKEY_sv(he),lp) :                \
376                                  ((lp = HeKLEN(he)), HeKEY(he)))
377 #define HeUTF8(he)              ((HeKLEN(he) == HEf_SVKEY) ?            \
378                                  SvUTF8(HeKEY_sv(he)) :                 \
379                                  (U32)HeKUTF8(he))
380
381 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
382                                   HeKLEN(he) == HEf_SVKEY) ?            \
383                                  HeKEY_sv(he) : NULL)
384
385 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
386                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
387                                   HeKEY_sv(he) :                        \
388                                   newSVpvn_flags(HeKEY(he),             \
389                                                  HeKLEN(he), SVs_TEMP)) : \
390                                  &PL_sv_undef)
391 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
392
393 #ifndef PERL_CORE
394 #  define Nullhek Null(HEK*)
395 #endif
396 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
397 #define HEK_HASH(hek)           (hek)->hek_hash
398 #define HEK_LEN(hek)            (hek)->hek_len
399 #define HEK_KEY(hek)            (hek)->hek_key
400 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
401
402 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
403 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
404 #define HVhek_REHASH    0x04 /* This key is in an hv using a custom HASH . */
405 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
406 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
407 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
408                                * (may change, but Storable is a core module) */
409 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
410                                     If the string is UTF-8, it cannot be
411                                     converted to bytes. */
412 #define HVhek_MASK      0xFF
413
414 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
415    HVhek_REHASH is only needed because the rehash flag has to be duplicated
416    into all keys as hv_iternext has no access to the hash flags. At this
417    point Storable's tests get upset, because sometimes hashes are "keyed"
418    and sometimes not, depending on the order of data insertion, and whether
419    it triggered rehashing. So currently HVhek_REHASH is exempt.
420    Similarly UNSHARED
421 */
422    
423 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
424
425 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
426 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
427 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
428 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
429 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
430 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
431 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
432 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
433
434 /* calculate HV array allocation */
435 #ifndef PERL_USE_LARGE_HV_ALLOC
436 /* Default to allocating the correct size - default to assuming that malloc()
437    is not broken and is efficient at allocating blocks sized at powers-of-two.
438 */   
439 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
440 #else
441 #  define MALLOC_OVERHEAD 16
442 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
443                         (((size) < 64)                                  \
444                          ? (size) * sizeof(HE*)                         \
445                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
446 #endif
447
448 /* Flags for hv_iternext_flags.  */
449 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
450
451 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
452 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
453 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0)
454
455 #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash))
456 #define sharepvn(pv, len, hash)      Perl_sharepvn(pv, len, hash)
457
458 #define share_hek_hek(hek)                                              \
459     (++(((struct shared_he *)(((char *)hek)                             \
460                               - STRUCT_OFFSET(struct shared_he,         \
461                                               shared_he_hek)))          \
462         ->shared_he_he.he_valu.hent_refcount),                          \
463      hek)
464
465 #define hv_store_ent(hv, keysv, val, hash)                              \
466     ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE,      \
467                       (val), (hash)))
468
469 #define hv_exists_ent(hv, keysv, hash)                                  \
470     (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
471      ? TRUE : FALSE)
472 #define hv_fetch_ent(hv, keysv, lval, hash)                             \
473     ((HE *) hv_common((hv), (keysv), NULL, 0, 0,                        \
474                       ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
475 #define hv_delete_ent(hv, key, flags, hash)                             \
476     (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
477                           NULL, (hash))))
478
479 #define hv_store_flags(hv, key, klen, val, hash, flags)                 \
480     ((SV**) hv_common((hv), NULL, (key), (klen), (flags),               \
481                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val),       \
482                       (hash)))
483
484 #define hv_store(hv, key, klen, val, hash)                              \
485     ((SV**) hv_common_key_len((hv), (key), (klen),                      \
486                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
487                               (val), (hash)))
488
489 #define hv_exists(hv, key, klen)                                        \
490     (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
491      ? TRUE : FALSE)
492
493 #define hv_fetch(hv, key, klen, lval)                                   \
494     ((SV**) hv_common_key_len((hv), (key), (klen), (lval)               \
495                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
496                               : HV_FETCH_JUST_SV, NULL, 0))
497
498 #define hv_delete(hv, key, klen, flags)                                 \
499     (MUTABLE_SV(hv_common_key_len((hv), (key), (klen),                  \
500                                   (flags) | HV_DELETE, NULL, 0)))
501
502 /* This refcounted he structure is used for storing the hints used for lexical
503    pragmas. Without threads, it's basically struct he + refcount.
504    With threads, life gets more complex as the structure needs to be shared
505    between threads (because it hangs from OPs, which are shared), hence the
506    alternate definition and mutex.  */
507
508 struct refcounted_he;
509
510 /* flags for the refcounted_he API */
511 #define REFCOUNTED_HE_KEY_UTF8          0x00000001
512 #ifdef PERL_CORE
513 # define REFCOUNTED_HE_EXISTS           0x00000002
514 #endif
515
516 #ifdef PERL_CORE
517
518 /* Gosh. This really isn't a good name any longer.  */
519 struct refcounted_he {
520     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
521 #ifdef USE_ITHREADS
522     U32                   refcounted_he_hash;
523     U32                   refcounted_he_keylen;
524 #else
525     HEK                  *refcounted_he_hek;    /* hint key */
526 #endif
527     union {
528         IV                refcounted_he_u_iv;
529         UV                refcounted_he_u_uv;
530         STRLEN            refcounted_he_u_len;
531         void             *refcounted_he_u_ptr;  /* Might be useful in future */
532     } refcounted_he_val;
533     U32                   refcounted_he_refcnt; /* reference count */
534     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
535        non-NUL terminated key.  */
536     char                  refcounted_he_data[1];
537 };
538
539 /*
540 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|const char *key|U32 flags
541
542 Like L</refcounted_he_fetch_pvn>, but takes a literal string instead of
543 a string/length pair, and no precomputed hash.
544
545 =cut
546 */
547
548 #define refcounted_he_fetch_pvs(chain, key, flags) \
549     Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags)
550
551 /*
552 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|const char *key|SV *value|U32 flags
553
554 Like L</refcounted_he_new_pvn>, but takes a literal string instead of
555 a string/length pair, and no precomputed hash.
556
557 =cut
558 */
559
560 #define refcounted_he_new_pvs(parent, key, value, flags) \
561     Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags)
562
563 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
564 #define HVrhek_undef    0x00 /* Value is undef. */
565 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
566 #define HVrhek_IV       0x20 /* Value is IV. */
567 #define HVrhek_UV       0x30 /* Value is UV. */
568 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
569 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
570 /* Two spare. As these have to live in the optree, you can't store anything
571    interpreter specific, such as SVs. :-( */
572 #define HVrhek_typemask 0x70
573
574 #ifdef USE_ITHREADS
575 /* A big expression to find the key offset */
576 #define REF_HE_KEY(chain)                                               \
577         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
578             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
579          + 1 + chain->refcounted_he_data)
580 #endif
581
582 #  ifdef USE_ITHREADS
583 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
584 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
585 #  else
586 #    define HINTS_REFCNT_LOCK           NOOP
587 #    define HINTS_REFCNT_UNLOCK         NOOP
588 #  endif
589 #endif
590
591 #ifdef USE_ITHREADS
592 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
593 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
594 #else
595 #  define HINTS_REFCNT_INIT             NOOP
596 #  define HINTS_REFCNT_TERM             NOOP
597 #endif
598
599 /* Hash actions
600  * Passed in PERL_MAGIC_uvar calls
601  */
602 #define HV_DISABLE_UVAR_XKEY    0x01
603 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
604    is documented as being passed to hv_delete().  */
605 #define HV_FETCH_ISSTORE        0x04
606 #define HV_FETCH_ISEXISTS       0x08
607 #define HV_FETCH_LVALUE         0x10
608 #define HV_FETCH_JUST_SV        0x20
609 #define HV_DELETE               0x40
610 #define HV_FETCH_EMPTY_HE       0x80 /* Leave HeVAL null. */
611
612 /* Must not conflict with HVhek_UTF8 */
613 #define HV_NAME_SETALL          0x02
614
615 /*
616 =for apidoc newHV
617
618 Creates a new HV.  The reference count is set to 1.
619
620 =cut
621 */
622
623 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
624
625 /*
626  * Local variables:
627  * c-indentation-style: bsd
628  * c-basic-offset: 4
629  * indent-tabs-mode: nil
630  * End:
631  *
632  * ex: set ts=8 sts=4 sw=4 et:
633  */