Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

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