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