This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
charnames::viacode returning less correct name
[perl5.git] / hv.h
CommitLineData
a0d0e21e 1/* hv.h
79072805 2 *
4bb101f2 3 * Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
62a1a1ef 4 * 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, by Larry Wall and others
79072805
LW
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 *
79072805
LW
9 */
10
5cbe4eec 11/* entry in hash value chain */
79072805 12struct he {
6f51351d
NC
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 */
5cbe4eec
MF
16 HE *hent_next; /* next entry in chain */
17 HEK *hent_hek; /* hash key */
de616631
NC
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;
bbce6d69
PP
22};
23
5cbe4eec 24/* hash key -- defined separately for use as shared pointer */
ff68c719 25struct hek {
5cbe4eec
MF
26 U32 hek_hash; /* hash of key */
27 I32 hek_len; /* length of hash key */
28 char hek_key[1]; /* variable-length hash key */
e05949c7 29 /* the hash-key is \0-terminated */
1e54db1a
JH
30 /* after the \0 there is a byte for flags, such as whether the key
31 is UTF-8 */
79072805
LW
32};
33
cbae3960
NC
34struct shared_he {
35 struct he shared_he_he;
36 struct hek shared_he_hek;
37};
bfcb3514
NC
38
39/* Subject to change.
40 Don't access this directly.
e1a479c5 41 Use the funcs in mro.c
bfcb3514 42*/
e1a479c5 43
b2685f0c
NC
44struct 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};
e1a479c5
BB
51
52struct mro_meta {
9953ff72
NC
53 /* a hash holding the different MROs private data. */
54 HV *mro_linear_all;
3a6fa573
NC
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;
dd69841b
BB
59 HV *mro_nextmethod; /* next::method caching */
60 U32 cache_gen; /* Bumping this invalidates our method cache */
70cd14a1 61 U32 pkg_gen; /* Bumps when local methods/@ISA change */
3d76853f 62 const struct mro_alg *mro_which; /* which mro alg is in use? */
a49ba3fc 63 HV *isa; /* Everything this class @ISA */
e1a479c5
BB
64};
65
123892d9
NC
66#define MRO_GET_PRIVATE_DATA(smeta, which) \
67 (((smeta)->mro_which && (which) == (smeta)->mro_which) \
3a6fa573 68 ? (smeta)->mro_linear_current \
123892d9 69 : Perl_mro_get_private_data(aTHX_ (smeta), (which)))
6f86b615 70#define mro_isa_changed_in(stash) mro_isa_changed_in3(stash, NULL, 0)
123892d9 71
e1a479c5
BB
72/* Subject to change.
73 Don't access this directly.
74*/
75
bfcb3514 76struct xpvhv_aux {
7423f6db 77 HEK *xhv_name; /* name, if a symbol table */
86f55936 78 AV *xhv_backreferences; /* back references for weak references */
bfcb3514
NC
79 HE *xhv_eiter; /* current entry of iterator */
80 I32 xhv_riter; /* current root of iterator */
e1a479c5 81 struct mro_meta *xhv_mro_meta;
bfcb3514
NC
82};
83
5cbe4eec 84/* hash structure: */
6ee623d5 85/* This structure must match the beginning of struct xpvmg in sv.h. */
79072805 86struct xpvhv {
6e128786
NC
87 HV* xmg_stash; /* class package */
88 union _xmgu xmg_u;
359164a0 89 STRLEN xhv_keys; /* total keys, including placeholders */
c8e503bf 90 STRLEN xhv_max; /* subscript of last element of xhv_array */
79072805
LW
91};
92
5cbe4eec 93/* hash a key */
5afd6d42
JH
94/* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
95 * from requirements by Colin Plumb.
96 * (http://burtleburtle.net/bob/hash/doobs.html) */
97/* The use of a temporary pointer and the casting games
98 * is needed to serve the dual purposes of
99 * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
df805c3e 100 * a "char" can be either signed or unsigned, depending on the compiler)
5afd6d42 101 * (b) catering for old code that uses a "char"
830b38bd 102 *
504f80c1
JH
103 * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
104 * to avoid "algorithmic complexity attacks".
830b38bd
JH
105 *
106 * If USE_HASH_SEED is defined, hash randomisation is done by default
107 * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
108 * only if the environment variable PERL_HASH_SEED is set.
109 * For maximal control, one can define PERL_HASH_SEED.
90ce55a1 110 * (see also perl.c:perl_parse()).
5afd6d42 111 */
830b38bd
JH
112#ifndef PERL_HASH_SEED
113# if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
114# define PERL_HASH_SEED PL_hash_seed
115# else
116# define PERL_HASH_SEED 0
117# endif
504f80c1 118#endif
bf6bd887
PP
119#define PERL_HASH(hash,str,len) \
120 STMT_START { \
0bd48802 121 register const char * const s_PeRlHaSh_tmp = str; \
5afd6d42 122 register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
bf6bd887 123 register I32 i_PeRlHaSh = len; \
504f80c1 124 register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
a6fe520e
MF
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); \
4fee5c71 132 (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
bf6bd887
PP
133 } STMT_END
134
3d78eb94
NC
135/* Only hv.c and mod_perl should be doing this. */
136#ifdef PERL_HASH_INTERNAL_ACCESS
4b5190b5
NC
137#define PERL_HASH_INTERNAL(hash,str,len) \
138 STMT_START { \
0bd48802 139 register const char * const s_PeRlHaSh_tmp = str; \
4b5190b5
NC
140 register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
141 register I32 i_PeRlHaSh = len; \
008fb0c0 142 register U32 hash_PeRlHaSh = PL_rehash_seed; \
4b5190b5
NC
143 while (i_PeRlHaSh--) { \
144 hash_PeRlHaSh += *s_PeRlHaSh++; \
145 hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
146 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
147 } \
148 hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
149 hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
150 (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
151 } STMT_END
152#endif
153
954c1994 154/*
ccfc67b7
JH
155=head1 Hash Manipulation Functions
156
954c1994
GS
157=for apidoc AmU||HEf_SVKEY
158This flag, used in the length slot of hash entries and magic structures,
d1be9408 159specifies the structure contains an C<SV*> pointer where a C<char*> pointer
954c1994
GS
160is to be expected. (For information only--not to be used).
161
ccfc67b7
JH
162=head1 Handy Values
163
954c1994
GS
164=for apidoc AmU||Nullhv
165Null HV pointer.
166
3ae1b226
NC
167(deprecated - use C<(HV *)NULL> instead)
168
ccfc67b7
JH
169=head1 Hash Manipulation Functions
170
954c1994 171=for apidoc Am|char*|HvNAME|HV* stash
9282b5fd
SH
172Returns the package name of a stash, or NULL if C<stash> isn't a stash.
173See C<SvSTASH>, C<CvSTASH>.
954c1994
GS
174
175=for apidoc Am|void*|HeKEY|HE* he
176Returns the actual pointer stored in the key slot of the hash entry. The
177pointer may be either C<char*> or C<SV*>, depending on the value of
178C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are
179usually preferable for finding the value of a key.
180
181=for apidoc Am|STRLEN|HeKLEN|HE* he
182If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
183holds an C<SV*> key. Otherwise, holds the actual length of the key. Can
184be assigned to. The C<HePV()> macro is usually preferable for finding key
185lengths.
186
187=for apidoc Am|SV*|HeVAL|HE* he
188Returns the value slot (type C<SV*>) stored in the hash entry.
189
190=for apidoc Am|U32|HeHASH|HE* he
191Returns the computed hash stored in the hash entry.
192
193=for apidoc Am|char*|HePV|HE* he|STRLEN len
194Returns the key slot of the hash entry as a C<char*> value, doing any
195necessary dereferencing of possibly C<SV*> keys. The length of the string
196is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do
197not care about what the length of the key is, you may use the global
198variable C<PL_na>, though this is rather less efficient than using a local
199variable. Remember though, that hash keys in perl are free to contain
200embedded nulls, so using C<strlen()> or similar is not a good way to find
201the length of hash keys. This is very similar to the C<SvPV()> macro
289d3c6a
NC
202described elsewhere in this document. See also C<HeUTF8>.
203
204If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a
205new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more
206efficient.
207
cca4e9fa 208=for apidoc Am|char*|HeUTF8|HE* he
289d3c6a
NC
209Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8,
210doing any necessary dereferencing of possibly C<SV*> keys. The value returned
62a1a1ef 211will be 0 or non-0, not necessarily 1 (or even a value with any low bits set),
289d3c6a
NC
212so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a
213typedef for C<char>.
954c1994
GS
214
215=for apidoc Am|SV*|HeSVKEY|HE* he
a0714e2c 216Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
954c1994
GS
217contain an C<SV*> key.
218
219=for apidoc Am|SV*|HeSVKEY_force|HE* he
220Returns the key as an C<SV*>. Will create and return a temporary mortal
221C<SV*> if the hash entry contains only a C<char*> key.
222
223=for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
224Sets the key to a given C<SV*>, taking care to set the appropriate flags to
225indicate the presence of an C<SV*> key, and returns the same
226C<SV*>.
227
228=cut
229*/
bf6bd887 230
bf5b86ae 231/* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
d1be9408 232#define HEf_SVKEY -2 /* hent_key is an SV* */
bf6bd887 233
3ae1b226
NC
234#ifndef PERL_CORE
235# define Nullhv Null(HV*)
236#endif
43e6e717 237#define HvARRAY(hv) ((hv)->sv_u.svu_hash)
4d0fbddd 238#define HvFILL(hv) Perl_hv_fill(aTHX_ (const HV *)(hv))
463ee0b2 239#define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max
b79f7545
NC
240/* This quite intentionally does no flag checking first. That's your
241 responsibility. */
242#define HvAUX(hv) ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
dbebbdb4
NC
243#define HvRITER(hv) (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv)))
244#define HvEITER(hv) (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv)))
245#define HvRITER_set(hv,r) Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r)
246#define HvEITER_set(hv,e) Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e)
b79f7545 247#define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
cef6ea9d 248#define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
7423f6db 249#define HvNAME(hv) HvNAME_get(hv)
2c7f4b87
BB
250
251/* Checking that hv is a valid package stash is the
252 caller's responsibility */
253#define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
254 ? HvAUX(hv)->xhv_mro_meta \
c60bad7b 255 : Perl_mro_meta_init(aTHX_ hv))
2c7f4b87 256
bfcb3514
NC
257/* FIXME - all of these should use a UTF8 aware API, which should also involve
258 getting the length. */
9b9d0b15 259/* This macro may go away without notice. */
cef6ea9d 260#define HvNAME_HEK(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_name : NULL)
b79f7545 261#define HvNAME_get(hv) ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
cef6ea9d 262 ? HEK_KEY(HvAUX(hv)->xhv_name) : NULL)
b79f7545
NC
263#define HvNAMELEN_get(hv) ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
264 ? HEK_LEN(HvAUX(hv)->xhv_name) : 0)
a0d0e21e 265
8aacddc1
NIS
266/* the number of keys (including any placeholers) */
267#define XHvTOTALKEYS(xhv) ((xhv)->xhv_keys)
268
8aacddc1
NIS
269/*
270 * HvKEYS gets the number of keys that actually exist(), and is provided
271 * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
272 * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
273 */
ca732855
NC
274#define HvKEYS(hv) HvUSEDKEYS(hv)
275#define HvUSEDKEYS(hv) (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
8aacddc1 276#define HvTOTALKEYS(hv) XHvTOTALKEYS((XPVHV*) SvANY(hv))
dbebbdb4
NC
277#define HvPLACEHOLDERS(hv) (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv)))
278#define HvPLACEHOLDERS_get(hv) (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0)
279#define HvPLACEHOLDERS_set(hv,p) Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p)
8aacddc1 280
bf6bd887
PP
281#define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS)
282#define HvSHAREKEYS_on(hv) (SvFLAGS(hv) |= SVphv_SHAREKEYS)
283#define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
284
19692e8d
NC
285/* This is an optimisation flag. It won't be set if all hash keys have a 0
286 * flag. Currently the only flags relate to utf8.
287 * Hence it won't be set if all keys are 8 bit only. It will be set if any key
288 * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
289 * when retrieved during iteration. It may still be set when there are no longer
290 * any utf8 keys.
fdcd69b6 291 * See HVhek_ENABLEHVKFLAGS for the trigger.
19692e8d
NC
292 */
293#define HvHASKFLAGS(hv) (SvFLAGS(hv) & SVphv_HASKFLAGS)
294#define HvHASKFLAGS_on(hv) (SvFLAGS(hv) |= SVphv_HASKFLAGS)
295#define HvHASKFLAGS_off(hv) (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
574c8022 296
bf5b86ae
GS
297#define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL)
298#define HvLAZYDEL_on(hv) (SvFLAGS(hv) |= SVphv_LAZYDEL)
299#define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
300
4b5190b5
NC
301#define HvREHASH(hv) (SvFLAGS(hv) & SVphv_REHASH)
302#define HvREHASH_on(hv) (SvFLAGS(hv) |= SVphv_REHASH)
303#define HvREHASH_off(hv) (SvFLAGS(hv) &= ~SVphv_REHASH)
304
3ae1b226
NC
305#ifndef PERL_CORE
306# define Nullhe Null(HE*)
307#endif
bf6bd887 308#define HeNEXT(he) (he)->hent_next
ff68c719
PP
309#define HeKEY_hek(he) (he)->hent_hek
310#define HeKEY(he) HEK_KEY(HeKEY_hek(he))
bbce6d69 311#define HeKEY_sv(he) (*(SV**)HeKEY(he))
ff68c719 312#define HeKLEN(he) HEK_LEN(HeKEY_hek(he))
da58a35d 313#define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he))
19692e8d 314#define HeKWASUTF8(he) HEK_WASUTF8(HeKEY_hek(he))
4b5190b5 315#define HeKREHASH(he) HEK_REHASH(HeKEY_hek(he))
da58a35d 316#define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
19692e8d 317#define HeKFLAGS(he) HEK_FLAGS(HeKEY_hek(he))
de616631 318#define HeVAL(he) (he)->he_valu.hent_val
ff68c719 319#define HeHASH(he) HEK_HASH(HeKEY_hek(he))
1e422769
PP
320#define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \
321 SvPV(HeKEY_sv(he),lp) : \
402f0539 322 ((lp = HeKLEN(he)), HeKEY(he)))
289d3c6a
NC
323#define HeUTF8(he) ((HeKLEN(he) == HEf_SVKEY) ? \
324 SvUTF8(HeKEY_sv(he)) : \
325 (U32)HeKUTF8(he))
1e422769 326
bbce6d69
PP
327#define HeSVKEY(he) ((HeKEY(he) && \
328 HeKLEN(he) == HEf_SVKEY) ? \
a0714e2c 329 HeKEY_sv(he) : NULL)
bbce6d69
PP
330
331#define HeSVKEY_force(he) (HeKEY(he) ? \
332 ((HeKLEN(he) == HEf_SVKEY) ? \
333 HeKEY_sv(he) : \
ad25789c
NC
334 newSVpvn_flags(HeKEY(he), \
335 HeKLEN(he), SVs_TEMP)) : \
3280af22 336 &PL_sv_undef)
1e422769 337#define HeSVKEY_set(he,sv) ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
bbce6d69 338
3ae1b226
NC
339#ifndef PERL_CORE
340# define Nullhek Null(HEK*)
341#endif
71be2cbc 342#define HEK_BASESIZE STRUCT_OFFSET(HEK, hek_key[0])
ff68c719
PP
343#define HEK_HASH(hek) (hek)->hek_hash
344#define HEK_LEN(hek) (hek)->hek_len
345#define HEK_KEY(hek) (hek)->hek_key
19692e8d
NC
346#define HEK_FLAGS(hek) (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
347
348#define HVhek_UTF8 0x01 /* Key is utf8 encoded. */
349#define HVhek_WASUTF8 0x02 /* Key is bytes here, but was supplied as utf8. */
4b5190b5 350#define HVhek_REHASH 0x04 /* This key is in an hv using a custom HASH . */
45e34800 351#define HVhek_UNSHARED 0x08 /* This key isn't a shared hash key. */
19692e8d 352#define HVhek_FREEKEY 0x100 /* Internal flag to say key is malloc()ed. */
e16e2ff8
NC
353#define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
354 * (may change, but Storable is a core module) */
44b87b50
NC
355#define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form.
356 If the string is UTF-8, it cannot be
357 converted to bytes. */
19692e8d
NC
358#define HVhek_MASK 0xFF
359
fdcd69b6
NC
360/* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
361 HVhek_REHASH is only needed because the rehash flag has to be duplicated
362 into all keys as hv_iternext has no access to the hash flags. At this
363 point Storable's tests get upset, because sometimes hashes are "keyed"
364 and sometimes not, depending on the order of data insertion, and whether
45e34800
NC
365 it triggered rehashing. So currently HVhek_REHASH is exempt.
366 Similarly UNSHARED
fdcd69b6
NC
367*/
368
45e34800 369#define HVhek_ENABLEHVKFLAGS (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
fdcd69b6 370
19692e8d
NC
371#define HEK_UTF8(hek) (HEK_FLAGS(hek) & HVhek_UTF8)
372#define HEK_UTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_UTF8)
373#define HEK_UTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_UTF8)
374#define HEK_WASUTF8(hek) (HEK_FLAGS(hek) & HVhek_WASUTF8)
375#define HEK_WASUTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_WASUTF8)
376#define HEK_WASUTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
4b5190b5
NC
377#define HEK_REHASH(hek) (HEK_FLAGS(hek) & HVhek_REHASH)
378#define HEK_REHASH_on(hek) (HEK_FLAGS(hek) |= HVhek_REHASH)
d18c6117 379
5cbe4eec 380/* calculate HV array allocation */
36768cf4
NC
381#ifndef PERL_USE_LARGE_HV_ALLOC
382/* Default to allocating the correct size - default to assuming that malloc()
383 is not broken and is efficient at allocating blocks sized at powers-of-two.
384*/
d18c6117
GS
385# define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
386#else
387# define MALLOC_OVERHEAD 16
388# define PERL_HV_ARRAY_ALLOC_BYTES(size) \
389 (((size) < 64) \
390 ? (size) * sizeof(HE*) \
391 : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
392#endif
37d85e3a 393
e16e2ff8
NC
394/* Flags for hv_iternext_flags. */
395#define HV_ITERNEXT_WANTPLACEHOLDERS 0x01 /* Don't skip placeholders. */
396
7a7b9979 397#define hv_iternext(hv) hv_iternext_flags(hv, 0)
b1bc3f34 398#define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0)
7a7b9979 399
37d85e3a
JH
400/* available as a function in hv.c */
401#define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
402#define sharepvn(sv, len, hash) Perl_sharepvn(sv, len, hash)
bfcb3514 403
d1db91c6
NC
404#define share_hek_hek(hek) \
405 (++(((struct shared_he *)(((char *)hek) \
406 - STRUCT_OFFSET(struct shared_he, \
407 shared_he_hek))) \
de616631 408 ->shared_he_he.he_valu.hent_refcount), \
d1db91c6
NC
409 hek)
410
99978bb4
NC
411#define hv_store_ent(hv, keysv, val, hash) \
412 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE, \
413 (val), (hash)))
4c2df08c 414
99978bb4
NC
415#define hv_exists_ent(hv, keysv, hash) \
416 (hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash)) \
4c2df08c 417 ? TRUE : FALSE)
99978bb4
NC
418#define hv_fetch_ent(hv, keysv, lval, hash) \
419 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, \
420 ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash)))
421#define hv_delete_ent(hv, key, flags, hash) \
b1bc3f34
NC
422 (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \
423 NULL, (hash))))
99978bb4
NC
424
425#define hv_store_flags(hv, key, klen, val, hash, flags) \
426 ((SV**) hv_common((hv), NULL, (key), (klen), (flags), \
427 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), \
428 (hash)))
429
430#define hv_store(hv, key, klen, val, hash) \
431 ((SV**) hv_common_key_len((hv), (key), (klen), \
a038e571 432 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), \
99978bb4 433 (val), (hash)))
a038e571 434
99978bb4
NC
435#define hv_exists(hv, key, klen) \
436 (hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0) \
a038e571
NC
437 ? TRUE : FALSE)
438
99978bb4
NC
439#define hv_fetch(hv, key, klen, lval) \
440 ((SV**) hv_common_key_len((hv), (key), (klen), (lval) \
a038e571
NC
441 ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \
442 : HV_FETCH_JUST_SV, NULL, 0))
443
99978bb4 444#define hv_delete(hv, key, klen, flags) \
b1bc3f34
NC
445 (MUTABLE_SV(hv_common_key_len((hv), (key), (klen), \
446 (flags) | HV_DELETE, NULL, 0)))
a038e571 447
71ad1b0c
NC
448/* This refcounted he structure is used for storing the hints used for lexical
449 pragmas. Without threads, it's basically struct he + refcount.
450 With threads, life gets more complex as the structure needs to be shared
451 between threads (because it hangs from OPs, which are shared), hence the
452 alternate definition and mutex. */
453
8dff4fc5
BM
454#define cop_hints_fetchsv(cop, keysv, hash) \
455 Perl_cop_hints_fetchpvn(aTHX_ (cop), SvPV_nolen(keysv), SvCUR(keysv), \
456 (SvUTF8(keysv) ? HVhek_UTF8 : 0), (hash))
457
9dcc53ea
Z
458#define cop_hints_fetchpv(cop, key, flags, hash) \
459 Perl_cop_hints_fetchpvn(aTHX_ (cop), key, strlen(key), (flags), (hash))
460
8dff4fc5
BM
461#define cop_hints_fetchpvs(cop, key) \
462 Perl_cop_hints_fetchpvn(aTHX_ (cop), STR_WITH_LEN(key), 0, 0)
463
44ebaf21
NC
464struct refcounted_he;
465
71ad1b0c
NC
466#ifdef PERL_CORE
467
b6bbf3fa 468/* Gosh. This really isn't a good name any longer. */
71ad1b0c
NC
469struct refcounted_he {
470 struct refcounted_he *refcounted_he_next; /* next entry in chain */
cbb1fbea 471#ifdef USE_ITHREADS
b6bbf3fa
NC
472 U32 refcounted_he_hash;
473 U32 refcounted_he_keylen;
cbb1fbea 474#else
71ad1b0c 475 HEK *refcounted_he_hek; /* hint key */
cbb1fbea 476#endif
b6bbf3fa
NC
477 union {
478 IV refcounted_he_u_iv;
479 UV refcounted_he_u_uv;
480 STRLEN refcounted_he_u_len;
44ebaf21 481 void *refcounted_he_u_ptr; /* Might be useful in future */
b6bbf3fa 482 } refcounted_he_val;
9bd87817 483 U32 refcounted_he_refcnt; /* reference count */
b6bbf3fa
NC
484 /* First byte is flags. Then NUL-terminated value. Then for ithreads,
485 non-NUL terminated key. */
486 char refcounted_he_data[1];
71ad1b0c
NC
487};
488
b6bbf3fa
NC
489/* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
490#define HVrhek_undef 0x00 /* Value is undef. */
44ebaf21
NC
491#define HVrhek_delete 0x10 /* Value is placeholder - signifies delete. */
492#define HVrhek_IV 0x20 /* Value is IV. */
493#define HVrhek_UV 0x30 /* Value is UV. */
494#define HVrhek_PV 0x40 /* Value is a (byte) string. */
495#define HVrhek_PV_UTF8 0x50 /* Value is a (utf8) string. */
496/* Two spare. As these have to live in the optree, you can't store anything
497 interpreter specific, such as SVs. :-( */
498#define HVrhek_typemask 0x70
499
500#ifdef USE_ITHREADS
501/* A big expression to find the key offset */
502#define REF_HE_KEY(chain) \
503 ((((chain->refcounted_he_data[0] & 0x60) == 0x40) \
504 ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0) \
505 + 1 + chain->refcounted_he_data)
506#endif
b6bbf3fa 507
71ad1b0c
NC
508# ifdef USE_ITHREADS
509# define HINTS_REFCNT_LOCK MUTEX_LOCK(&PL_hints_mutex)
510# define HINTS_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_hints_mutex)
511# else
512# define HINTS_REFCNT_LOCK NOOP
513# define HINTS_REFCNT_UNLOCK NOOP
514# endif
515#endif
516
517#ifdef USE_ITHREADS
518# define HINTS_REFCNT_INIT MUTEX_INIT(&PL_hints_mutex)
519# define HINTS_REFCNT_TERM MUTEX_DESTROY(&PL_hints_mutex)
520#else
521# define HINTS_REFCNT_INIT NOOP
522# define HINTS_REFCNT_TERM NOOP
523#endif
524
324a0d18
JH
525/* Hash actions
526 * Passed in PERL_MAGIC_uvar calls
527 */
b54b4831
NC
528#define HV_DISABLE_UVAR_XKEY 0x01
529/* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
530 is documented as being passed to hv_delete(). */
531#define HV_FETCH_ISSTORE 0x04
532#define HV_FETCH_ISEXISTS 0x08
533#define HV_FETCH_LVALUE 0x10
534#define HV_FETCH_JUST_SV 0x20
9dbc5603 535#define HV_DELETE 0x40
324a0d18 536
bfcb3514 537/*
78ac7dd9
NC
538=for apidoc newHV
539
540Creates a new HV. The reference count is set to 1.
541
542=cut
543*/
544
dbebbdb4 545#define newHV() MUTABLE_HV(newSV_type(SVt_PVHV))
78ac7dd9
NC
546
547/*
bfcb3514
NC
548 * Local variables:
549 * c-indentation-style: bsd
550 * c-basic-offset: 4
551 * indent-tabs-mode: t
552 * End:
553 *
554 * ex: set ts=8 sts=4 sw=4 noet:
555 */