This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Back out 21533 because it broke Encode's build in really weird ways
[perl5.git] / hv.h
1 /*    hv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 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 /* hash structure: */
33 /* This structure must match the beginning of struct xpvmg in sv.h. */
34 struct xpvhv {
35     char *      xhv_array;      /* pointer to malloced string */
36     STRLEN      xhv_fill;       /* how full xhv_array currently is */
37     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
38     IV          xhv_keys;       /* how many elements in the array */
39     NV          xnv_nv;         /* numeric value, if any */
40 #define xhv_placeholders xnv_nv
41     MAGIC*      xmg_magic;      /* magic for scalar array */
42     HV*         xmg_stash;      /* class package */
43
44     I32         xhv_riter;      /* current root of iterator */
45     HE          *xhv_eiter;     /* current entry of iterator */
46     PMOP        *xhv_pmroot;    /* list of pm's for this package */
47     char        *xhv_name;      /* name, if a symbol table */
48 };
49
50 /* hash a key */
51 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
52  * from requirements by Colin Plumb.
53  * (http://burtleburtle.net/bob/hash/doobs.html) */
54 /* The use of a temporary pointer and the casting games
55  * is needed to serve the dual purposes of
56  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
57  *     a "char" can be either signed or signed, depending on the compiler)
58  * (b) catering for old code that uses a "char"
59  *
60  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
61  * to avoid "algorithmic complexity attacks".
62  *
63  * If USE_HASH_SEED is defined, hash randomisation is done by default
64  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
65  * only if the environment variable PERL_HASH_SEED is set.
66  * For maximal control, one can define PERL_HASH_SEED.
67  * (see also erl.c:perl_parse()).
68  */
69 #ifndef PERL_HASH_SEED
70 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
71 #       define PERL_HASH_SEED   PL_hash_seed
72 #   else
73 #       define PERL_HASH_SEED   0
74 #   endif
75 #endif
76 #define PERL_HASH(hash,str,len) \
77      STMT_START { \
78         register const char *s_PeRlHaSh_tmp = str; \
79         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
80         register I32 i_PeRlHaSh = len; \
81         register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
82         while (i_PeRlHaSh--) { \
83             hash_PeRlHaSh += *s_PeRlHaSh++; \
84             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
85             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
86         } \
87         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
88         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
89         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
90     } STMT_END
91
92 #ifdef PERL_IN_HV_C
93 #define PERL_HASH_INTERNAL(hash,str,len) \
94      STMT_START { \
95         register const char *s_PeRlHaSh_tmp = str; \
96         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
97         register I32 i_PeRlHaSh = len; \
98         register U32 hash_PeRlHaSh = PL_new_hash_seed; \
99         while (i_PeRlHaSh--) { \
100             hash_PeRlHaSh += *s_PeRlHaSh++; \
101             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
102             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
103         } \
104         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
105         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
106         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
107     } STMT_END
108 #endif
109
110 /*
111 =head1 Hash Manipulation Functions
112
113 =for apidoc AmU||HEf_SVKEY
114 This flag, used in the length slot of hash entries and magic structures,
115 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
116 is to be expected. (For information only--not to be used).
117
118 =head1 Handy Values
119
120 =for apidoc AmU||Nullhv
121 Null HV pointer.
122
123 =head1 Hash Manipulation Functions
124
125 =for apidoc Am|char*|HvNAME|HV* stash
126 Returns the package name of a stash.  See C<SvSTASH>, C<CvSTASH>.
127
128 =for apidoc Am|void*|HeKEY|HE* he
129 Returns the actual pointer stored in the key slot of the hash entry. The
130 pointer may be either C<char*> or C<SV*>, depending on the value of
131 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
132 usually preferable for finding the value of a key.
133
134 =for apidoc Am|STRLEN|HeKLEN|HE* he
135 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
136 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
137 be assigned to. The C<HePV()> macro is usually preferable for finding key
138 lengths.
139
140 =for apidoc Am|SV*|HeVAL|HE* he
141 Returns the value slot (type C<SV*>) stored in the hash entry.
142
143 =for apidoc Am|U32|HeHASH|HE* he
144 Returns the computed hash stored in the hash entry.
145
146 =for apidoc Am|char*|HePV|HE* he|STRLEN len
147 Returns the key slot of the hash entry as a C<char*> value, doing any
148 necessary dereferencing of possibly C<SV*> keys.  The length of the string
149 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
150 not care about what the length of the key is, you may use the global
151 variable C<PL_na>, though this is rather less efficient than using a local
152 variable.  Remember though, that hash keys in perl are free to contain
153 embedded nulls, so using C<strlen()> or similar is not a good way to find
154 the length of hash keys. This is very similar to the C<SvPV()> macro
155 described elsewhere in this document.
156
157 =for apidoc Am|SV*|HeSVKEY|HE* he
158 Returns the key as an C<SV*>, or C<Nullsv> if the hash entry does not
159 contain an C<SV*> key.
160
161 =for apidoc Am|SV*|HeSVKEY_force|HE* he
162 Returns the key as an C<SV*>.  Will create and return a temporary mortal
163 C<SV*> if the hash entry contains only a C<char*> key.
164
165 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
166 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
167 indicate the presence of an C<SV*> key, and returns the same
168 C<SV*>.
169
170 =cut
171 */
172
173 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
174 #define HEf_SVKEY       -2      /* hent_key is an SV* */
175
176
177 #define Nullhv Null(HV*)
178 #define HvARRAY(hv)     (*(HE***)&((XPVHV*)  SvANY(hv))->xhv_array)
179 #define HvFILL(hv)      ((XPVHV*)  SvANY(hv))->xhv_fill
180 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
181 #define HvRITER(hv)     ((XPVHV*)  SvANY(hv))->xhv_riter
182 #define HvEITER(hv)     ((XPVHV*)  SvANY(hv))->xhv_eiter
183 #define HvPMROOT(hv)    ((XPVHV*)  SvANY(hv))->xhv_pmroot
184 #define HvNAME(hv)      ((XPVHV*)  SvANY(hv))->xhv_name
185
186 /* the number of keys (including any placeholers) */
187 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
188
189 /* The number of placeholders in the enumerated-keys hash */
190 #define XHvPLACEHOLDERS(xhv)    ((xhv)->xhv_placeholders)
191
192 /* the number of keys that exist() (i.e. excluding placeholders) */
193 #define XHvUSEDKEYS(xhv)      (XHvTOTALKEYS(xhv) - (IV)XHvPLACEHOLDERS(xhv))
194
195 /*
196  * HvKEYS gets the number of keys that actually exist(), and is provided
197  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
198  * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
199  */
200 #define HvKEYS(hv)              XHvUSEDKEYS((XPVHV*)  SvANY(hv))
201 #define HvUSEDKEYS(hv)          XHvUSEDKEYS((XPVHV*)  SvANY(hv))
202 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
203 #define HvPLACEHOLDERS(hv)      XHvPLACEHOLDERS((XPVHV*)  SvANY(hv))
204
205 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
206 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
207 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
208
209 /* This is an optimisation flag. It won't be set if all hash keys have a 0
210  * flag. Currently the only flags relate to utf8.
211  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
212  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
213  * when retrieved during iteration. It may still be set when there are no longer
214  * any utf8 keys.
215  */
216 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
217 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
218 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
219
220 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
221 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
222 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
223
224 #define HvREHASH(hv)            (SvFLAGS(hv) & SVphv_REHASH)
225 #define HvREHASH_on(hv)         (SvFLAGS(hv) |= SVphv_REHASH)
226 #define HvREHASH_off(hv)        (SvFLAGS(hv) &= ~SVphv_REHASH)
227
228 /* Maybe amagical: */
229 /* #define HV_AMAGICmb(hv)      (SvFLAGS(hv) & (SVpgv_badAM | SVpgv_AM)) */
230
231 #define HV_AMAGIC(hv)        (SvFLAGS(hv) &   SVpgv_AM)
232 #define HV_AMAGIC_on(hv)     (SvFLAGS(hv) |=  SVpgv_AM)
233 #define HV_AMAGIC_off(hv)    (SvFLAGS(hv) &= ~SVpgv_AM)
234
235 /*
236 #define HV_AMAGICbad(hv)     (SvFLAGS(hv) & SVpgv_badAM)
237 #define HV_badAMAGIC_on(hv)  (SvFLAGS(hv) |= SVpgv_badAM)
238 #define HV_badAMAGIC_off(hv) (SvFLAGS(hv) &= ~SVpgv_badAM)
239 */
240
241 #define Nullhe Null(HE*)
242 #define HeNEXT(he)              (he)->hent_next
243 #define HeKEY_hek(he)           (he)->hent_hek
244 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
245 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
246 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
247 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
248 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
249 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
250 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
251 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
252 #define HeVAL(he)               (he)->hent_val
253 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
254 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
255                                  SvPV(HeKEY_sv(he),lp) :                \
256                                  (((lp = HeKLEN(he)) >= 0) ?            \
257                                   HeKEY(he) : Nullch))
258
259 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
260                                   HeKLEN(he) == HEf_SVKEY) ?            \
261                                  HeKEY_sv(he) : Nullsv)
262
263 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
264                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
265                                   HeKEY_sv(he) :                        \
266                                   sv_2mortal(newSVpvn(HeKEY(he),        \
267                                                      HeKLEN(he)))) :    \
268                                  &PL_sv_undef)
269 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
270
271 #define Nullhek Null(HEK*)
272 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
273 #define HEK_HASH(hek)           (hek)->hek_hash
274 #define HEK_LEN(hek)            (hek)->hek_len
275 #define HEK_KEY(hek)            (hek)->hek_key
276 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
277
278 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
279 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
280 #define HVhek_REHASH    0x04 /* This key is in an hv using a custom HASH . */
281 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
282 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
283                                * (may change, but Storable is a core module) */
284 #define HVhek_MASK      0xFF
285
286 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
287 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
288 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
289 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
290 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
291 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
292 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
293 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
294
295 /* calculate HV array allocation */
296 #if defined(STRANGE_MALLOC) || defined(MYMALLOC)
297 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
298 #else
299 #  define MALLOC_OVERHEAD 16
300 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
301                         (((size) < 64)                                  \
302                          ? (size) * sizeof(HE*)                         \
303                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
304 #endif
305
306 /* Flags for hv_iternext_flags.  */
307 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
308
309 /* available as a function in hv.c */
310 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
311 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)