Re: [perl #48769] [PATCH] SelfLoader.pm 1.0904 - Whitespace in subroutine
[perl.git] / hv.h
1 /*    hv.h
2  *
3  *    Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999,
4  *    2000, 2001, 2002, 2003, 2005, 2006, 2007, by Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /* entry in hash value chain */
12 struct he {
13     /* Keep hent_next first in this structure, because sv_free_arenas take
14        advantage of this to share code between the he arenas and the SV
15        body arenas  */
16     HE          *hent_next;     /* next entry in chain */
17     HEK         *hent_hek;      /* hash key */
18     union {
19         SV      *hent_val;      /* scalar value that was hashed */
20         Size_t  hent_refcount;  /* references for this shared hash key */
21     } he_valu;
22 };
23
24 /* hash key -- defined separately for use as shared pointer */
25 struct hek {
26     U32         hek_hash;       /* hash of key */
27     I32         hek_len;        /* length of hash key */
28     char        hek_key[1];     /* variable-length hash key */
29     /* the hash-key is \0-terminated */
30     /* after the \0 there is a byte for flags, such as whether the key
31        is UTF-8 */
32 };
33
34 struct shared_he {
35     struct he shared_he_he;
36     struct hek shared_he_hek;
37 };
38
39 /* Subject to change.
40    Don't access this directly.
41    Use the funcs in mro.c
42 */
43
44
45 /* structure may change, so not public yet */
46 struct mro_alg;
47
48 struct mro_meta {
49     AV      *mro_linear_dfs; /* cached dfs @ISA linearization */
50     AV      *mro_linear_c3;  /* cached c3 @ISA linearization */
51     HV      *mro_nextmethod; /* next::method caching */
52     U32     cache_gen;       /* Bumping this invalidates our method cache */
53     U32     pkg_gen;         /* Bumps when local methods/@ISA change */
54     const struct mro_alg *mro_which; /* which mro alg is in use? */
55 };
56
57 /* Subject to change.
58    Don't access this directly.
59 */
60
61 struct xpvhv_aux {
62     HEK         *xhv_name;      /* name, if a symbol table */
63     AV          *xhv_backreferences; /* back references for weak references */
64     HE          *xhv_eiter;     /* current entry of iterator */
65     I32         xhv_riter;      /* current root of iterator */
66     struct mro_meta *xhv_mro_meta;
67 };
68
69 /* hash structure: */
70 /* This structure must match the beginning of struct xpvmg in sv.h. */
71 struct xpvhv {
72     union {
73         NV      xnv_nv;         /* numeric value, if any */
74         HV *    xgv_stash;
75         struct {
76             U32 xlow;
77             U32 xhigh;
78         }       xpad_cop_seq;   /* used by pad.c for cop_sequence */
79         struct {
80             U32 xbm_previous;   /* how many characters in string before rare? */
81             U8  xbm_flags;
82             U8  xbm_rare;       /* rarest character in string */
83         }       xbm_s;          /* fields from PVBM */
84     }           xnv_u;
85     STRLEN      xhv_fill;       /* how full xhv_array currently is */
86     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
87     union {
88         IV      xivu_iv;        /* integer value or pv offset */
89         UV      xivu_uv;
90         void *  xivu_p1;
91         I32     xivu_i32;
92         HEK *   xivu_namehek;
93     }           xiv_u;
94     union {
95         MAGIC*  xmg_magic;      /* linked list of magicalness */
96         HV*     xmg_ourstash;   /* Stash for our (when SvPAD_OUR is true) */
97     } xmg_u;
98     HV*         xmg_stash;      /* class package */
99 };
100
101 #define xhv_keys xiv_u.xivu_iv
102
103 typedef struct {
104     STRLEN      xhv_fill;       /* how full xhv_array currently is */
105     STRLEN      xhv_max;        /* subscript of last element of xhv_array */
106     union {
107         IV      xivu_iv;        /* integer value or pv offset */
108         UV      xivu_uv;
109         void *  xivu_p1;
110         I32     xivu_i32;
111         HEK *   xivu_namehek;
112     }           xiv_u;
113     union {
114         MAGIC*  xmg_magic;      /* linked list of magicalness */
115         HV*     xmg_ourstash;   /* Stash for our (when SvPAD_OUR is true) */
116     } xmg_u;
117     HV*         xmg_stash;      /* class package */
118 } xpvhv_allocated;
119
120 /* hash a key */
121 /* FYI: This is the "One-at-a-Time" algorithm by Bob Jenkins
122  * from requirements by Colin Plumb.
123  * (http://burtleburtle.net/bob/hash/doobs.html) */
124 /* The use of a temporary pointer and the casting games
125  * is needed to serve the dual purposes of
126  * (a) the hashed data being interpreted as "unsigned char" (new since 5.8,
127  *     a "char" can be either signed or unsigned, depending on the compiler)
128  * (b) catering for old code that uses a "char"
129  *
130  * The "hash seed" feature was added in Perl 5.8.1 to perturb the results
131  * to avoid "algorithmic complexity attacks".
132  *
133  * If USE_HASH_SEED is defined, hash randomisation is done by default
134  * If USE_HASH_SEED_EXPLICIT is defined, hash randomisation is done
135  * only if the environment variable PERL_HASH_SEED is set.
136  * For maximal control, one can define PERL_HASH_SEED.
137  * (see also perl.c:perl_parse()).
138  */
139 #ifndef PERL_HASH_SEED
140 #   if defined(USE_HASH_SEED) || defined(USE_HASH_SEED_EXPLICIT)
141 #       define PERL_HASH_SEED   PL_hash_seed
142 #   else
143 #       define PERL_HASH_SEED   0
144 #   endif
145 #endif
146 #define PERL_HASH(hash,str,len) \
147      STMT_START { \
148         register const char * const s_PeRlHaSh_tmp = str; \
149         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
150         register I32 i_PeRlHaSh = len; \
151         register U32 hash_PeRlHaSh = PERL_HASH_SEED; \
152         while (i_PeRlHaSh--) { \
153             hash_PeRlHaSh += *s_PeRlHaSh++; \
154             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
155             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
156         } \
157         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
158         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
159         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
160     } STMT_END
161
162 /* Only hv.c and mod_perl should be doing this.  */
163 #ifdef PERL_HASH_INTERNAL_ACCESS
164 #define PERL_HASH_INTERNAL(hash,str,len) \
165      STMT_START { \
166         register const char * const s_PeRlHaSh_tmp = str; \
167         register const unsigned char *s_PeRlHaSh = (const unsigned char *)s_PeRlHaSh_tmp; \
168         register I32 i_PeRlHaSh = len; \
169         register U32 hash_PeRlHaSh = PL_rehash_seed; \
170         while (i_PeRlHaSh--) { \
171             hash_PeRlHaSh += *s_PeRlHaSh++; \
172             hash_PeRlHaSh += (hash_PeRlHaSh << 10); \
173             hash_PeRlHaSh ^= (hash_PeRlHaSh >> 6); \
174         } \
175         hash_PeRlHaSh += (hash_PeRlHaSh << 3); \
176         hash_PeRlHaSh ^= (hash_PeRlHaSh >> 11); \
177         (hash) = (hash_PeRlHaSh + (hash_PeRlHaSh << 15)); \
178     } STMT_END
179 #endif
180
181 /*
182 =head1 Hash Manipulation Functions
183
184 =for apidoc AmU||HEf_SVKEY
185 This flag, used in the length slot of hash entries and magic structures,
186 specifies the structure contains an C<SV*> pointer where a C<char*> pointer
187 is to be expected. (For information only--not to be used).
188
189 =head1 Handy Values
190
191 =for apidoc AmU||Nullhv
192 Null HV pointer.
193
194 =head1 Hash Manipulation Functions
195
196 =for apidoc Am|char*|HvNAME|HV* stash
197 Returns the package name of a stash, or NULL if C<stash> isn't a stash.
198 See C<SvSTASH>, C<CvSTASH>.
199
200 =for apidoc Am|void*|HeKEY|HE* he
201 Returns the actual pointer stored in the key slot of the hash entry. The
202 pointer may be either C<char*> or C<SV*>, depending on the value of
203 C<HeKLEN()>.  Can be assigned to.  The C<HePV()> or C<HeSVKEY()> macros are
204 usually preferable for finding the value of a key.
205
206 =for apidoc Am|STRLEN|HeKLEN|HE* he
207 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry
208 holds an C<SV*> key.  Otherwise, holds the actual length of the key.  Can
209 be assigned to. The C<HePV()> macro is usually preferable for finding key
210 lengths.
211
212 =for apidoc Am|SV*|HeVAL|HE* he
213 Returns the value slot (type C<SV*>) stored in the hash entry.
214
215 =for apidoc Am|U32|HeHASH|HE* he
216 Returns the computed hash stored in the hash entry.
217
218 =for apidoc Am|char*|HePV|HE* he|STRLEN len
219 Returns the key slot of the hash entry as a C<char*> value, doing any
220 necessary dereferencing of possibly C<SV*> keys.  The length of the string
221 is placed in C<len> (this is a macro, so do I<not> use C<&len>).  If you do
222 not care about what the length of the key is, you may use the global
223 variable C<PL_na>, though this is rather less efficient than using a local
224 variable.  Remember though, that hash keys in perl are free to contain
225 embedded nulls, so using C<strlen()> or similar is not a good way to find
226 the length of hash keys. This is very similar to the C<SvPV()> macro
227 described elsewhere in this document.
228
229 =for apidoc Am|SV*|HeSVKEY|HE* he
230 Returns the key as an C<SV*>, or C<NULL> if the hash entry does not
231 contain an C<SV*> key.
232
233 =for apidoc Am|SV*|HeSVKEY_force|HE* he
234 Returns the key as an C<SV*>.  Will create and return a temporary mortal
235 C<SV*> if the hash entry contains only a C<char*> key.
236
237 =for apidoc Am|SV*|HeSVKEY_set|HE* he|SV* sv
238 Sets the key to a given C<SV*>, taking care to set the appropriate flags to
239 indicate the presence of an C<SV*> key, and returns the same
240 C<SV*>.
241
242 =cut
243 */
244
245 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */
246 #define HEf_SVKEY       -2      /* hent_key is an SV* */
247
248
249 #define Nullhv Null(HV*)
250 #define HvARRAY(hv)     ((hv)->sv_u.svu_hash)
251 #define HvFILL(hv)      ((XPVHV*)  SvANY(hv))->xhv_fill
252 #define HvMAX(hv)       ((XPVHV*)  SvANY(hv))->xhv_max
253 /* This quite intentionally does no flag checking first. That's your
254    responsibility.  */
255 #define HvAUX(hv)       ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1]))
256 #define HvRITER(hv)     (*Perl_hv_riter_p(aTHX_ (HV*)(hv)))
257 #define HvEITER(hv)     (*Perl_hv_eiter_p(aTHX_ (HV*)(hv)))
258 #define HvRITER_set(hv,r)       Perl_hv_riter_set(aTHX_ (HV*)(hv), r)
259 #define HvEITER_set(hv,e)       Perl_hv_eiter_set(aTHX_ (HV*)(hv), e)
260 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1)
261 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL)
262 #define HvNAME(hv)      HvNAME_get(hv)
263
264 /* Checking that hv is a valid package stash is the
265    caller's responsibility */
266 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \
267                        ? HvAUX(hv)->xhv_mro_meta \
268                        : mro_meta_init(hv))
269
270 /* FIXME - all of these should use a UTF8 aware API, which should also involve
271    getting the length. */
272 /* This macro may go away without notice.  */
273 #define HvNAME_HEK(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_name : NULL)
274 #define HvNAME_get(hv)  ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
275                          ? HEK_KEY(HvAUX(hv)->xhv_name) : NULL)
276 #define HvNAMELEN_get(hv)       ((SvOOK(hv) && (HvAUX(hv)->xhv_name)) \
277                                  ? HEK_LEN(HvAUX(hv)->xhv_name) : 0)
278
279 /* the number of keys (including any placeholers) */
280 #define XHvTOTALKEYS(xhv)       ((xhv)->xhv_keys)
281
282 /*
283  * HvKEYS gets the number of keys that actually exist(), and is provided
284  * for backwards compatibility with old XS code. The core uses HvUSEDKEYS
285  * (keys, excluding placeholdes) and HvTOTALKEYS (including placeholders)
286  */
287 #define HvKEYS(hv)              HvUSEDKEYS(hv)
288 #define HvUSEDKEYS(hv)          (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv))
289 #define HvTOTALKEYS(hv)         XHvTOTALKEYS((XPVHV*)  SvANY(hv))
290 #define HvPLACEHOLDERS(hv)      (*Perl_hv_placeholders_p(aTHX_ (HV*)hv))
291 #define HvPLACEHOLDERS_get(hv)  (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (HV*)hv) : 0)
292 #define HvPLACEHOLDERS_set(hv,p)        Perl_hv_placeholders_set(aTHX_ (HV*)hv, p)
293
294 #define HvSHAREKEYS(hv)         (SvFLAGS(hv) & SVphv_SHAREKEYS)
295 #define HvSHAREKEYS_on(hv)      (SvFLAGS(hv) |= SVphv_SHAREKEYS)
296 #define HvSHAREKEYS_off(hv)     (SvFLAGS(hv) &= ~SVphv_SHAREKEYS)
297
298 /* This is an optimisation flag. It won't be set if all hash keys have a 0
299  * flag. Currently the only flags relate to utf8.
300  * Hence it won't be set if all keys are 8 bit only. It will be set if any key
301  * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading
302  * when retrieved during iteration. It may still be set when there are no longer
303  * any utf8 keys.
304  * See HVhek_ENABLEHVKFLAGS for the trigger.
305  */
306 #define HvHASKFLAGS(hv)         (SvFLAGS(hv) & SVphv_HASKFLAGS)
307 #define HvHASKFLAGS_on(hv)      (SvFLAGS(hv) |= SVphv_HASKFLAGS)
308 #define HvHASKFLAGS_off(hv)     (SvFLAGS(hv) &= ~SVphv_HASKFLAGS)
309
310 #define HvLAZYDEL(hv)           (SvFLAGS(hv) & SVphv_LAZYDEL)
311 #define HvLAZYDEL_on(hv)        (SvFLAGS(hv) |= SVphv_LAZYDEL)
312 #define HvLAZYDEL_off(hv)       (SvFLAGS(hv) &= ~SVphv_LAZYDEL)
313
314 #define HvREHASH(hv)            (SvFLAGS(hv) & SVphv_REHASH)
315 #define HvREHASH_on(hv)         (SvFLAGS(hv) |= SVphv_REHASH)
316 #define HvREHASH_off(hv)        (SvFLAGS(hv) &= ~SVphv_REHASH)
317
318 #define Nullhe Null(HE*)
319 #define HeNEXT(he)              (he)->hent_next
320 #define HeKEY_hek(he)           (he)->hent_hek
321 #define HeKEY(he)               HEK_KEY(HeKEY_hek(he))
322 #define HeKEY_sv(he)            (*(SV**)HeKEY(he))
323 #define HeKLEN(he)              HEK_LEN(HeKEY_hek(he))
324 #define HeKUTF8(he)  HEK_UTF8(HeKEY_hek(he))
325 #define HeKWASUTF8(he)  HEK_WASUTF8(HeKEY_hek(he))
326 #define HeKREHASH(he)  HEK_REHASH(HeKEY_hek(he))
327 #define HeKLEN_UTF8(he)  (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he))
328 #define HeKFLAGS(he)  HEK_FLAGS(HeKEY_hek(he))
329 #define HeVAL(he)               (he)->he_valu.hent_val
330 #define HeHASH(he)              HEK_HASH(HeKEY_hek(he))
331 #define HePV(he,lp)             ((HeKLEN(he) == HEf_SVKEY) ?            \
332                                  SvPV(HeKEY_sv(he),lp) :                \
333                                  ((lp = HeKLEN(he)), HeKEY(he)))
334
335 #define HeSVKEY(he)             ((HeKEY(he) &&                          \
336                                   HeKLEN(he) == HEf_SVKEY) ?            \
337                                  HeKEY_sv(he) : NULL)
338
339 #define HeSVKEY_force(he)       (HeKEY(he) ?                            \
340                                  ((HeKLEN(he) == HEf_SVKEY) ?           \
341                                   HeKEY_sv(he) :                        \
342                                   sv_2mortal(newSVpvn(HeKEY(he),        \
343                                                      HeKLEN(he)))) :    \
344                                  &PL_sv_undef)
345 #define HeSVKEY_set(he,sv)      ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv))
346
347 #define Nullhek Null(HEK*)
348 #define HEK_BASESIZE            STRUCT_OFFSET(HEK, hek_key[0])
349 #define HEK_HASH(hek)           (hek)->hek_hash
350 #define HEK_LEN(hek)            (hek)->hek_len
351 #define HEK_KEY(hek)            (hek)->hek_key
352 #define HEK_FLAGS(hek)  (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1))
353
354 #define HVhek_UTF8      0x01 /* Key is utf8 encoded. */
355 #define HVhek_WASUTF8   0x02 /* Key is bytes here, but was supplied as utf8. */
356 #define HVhek_REHASH    0x04 /* This key is in an hv using a custom HASH . */
357 #define HVhek_UNSHARED  0x08 /* This key isn't a shared hash key. */
358 #define HVhek_FREEKEY   0x100 /* Internal flag to say key is malloc()ed.  */
359 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder.
360                                * (may change, but Storable is a core module) */
361 #define HVhek_MASK      0xFF
362
363 /* Which flags enable HvHASKFLAGS? Somewhat a hack on a hack, as
364    HVhek_REHASH is only needed because the rehash flag has to be duplicated
365    into all keys as hv_iternext has no access to the hash flags. At this
366    point Storable's tests get upset, because sometimes hashes are "keyed"
367    and sometimes not, depending on the order of data insertion, and whether
368    it triggered rehashing. So currently HVhek_REHASH is exempt.
369    Similarly UNSHARED
370 */
371    
372 #define HVhek_ENABLEHVKFLAGS    (HVhek_MASK & ~(HVhek_REHASH|HVhek_UNSHARED))
373
374 #define HEK_UTF8(hek)           (HEK_FLAGS(hek) & HVhek_UTF8)
375 #define HEK_UTF8_on(hek)        (HEK_FLAGS(hek) |= HVhek_UTF8)
376 #define HEK_UTF8_off(hek)       (HEK_FLAGS(hek) &= ~HVhek_UTF8)
377 #define HEK_WASUTF8(hek)        (HEK_FLAGS(hek) & HVhek_WASUTF8)
378 #define HEK_WASUTF8_on(hek)     (HEK_FLAGS(hek) |= HVhek_WASUTF8)
379 #define HEK_WASUTF8_off(hek)    (HEK_FLAGS(hek) &= ~HVhek_WASUTF8)
380 #define HEK_REHASH(hek)         (HEK_FLAGS(hek) & HVhek_REHASH)
381 #define HEK_REHASH_on(hek)      (HEK_FLAGS(hek) |= HVhek_REHASH)
382
383 /* calculate HV array allocation */
384 #ifndef PERL_USE_LARGE_HV_ALLOC
385 /* Default to allocating the correct size - default to assuming that malloc()
386    is not broken and is efficient at allocating blocks sized at powers-of-two.
387 */   
388 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*))
389 #else
390 #  define MALLOC_OVERHEAD 16
391 #  define PERL_HV_ARRAY_ALLOC_BYTES(size) \
392                         (((size) < 64)                                  \
393                          ? (size) * sizeof(HE*)                         \
394                          : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD)
395 #endif
396
397 /* Flags for hv_iternext_flags.  */
398 #define HV_ITERNEXT_WANTPLACEHOLDERS    0x01    /* Don't skip placeholders.  */
399
400 #define hv_iternext(hv) hv_iternext_flags(hv, 0)
401 #define hv_magic(hv, gv, how) sv_magic((SV*)(hv), (SV*)(gv), how, NULL, 0)
402
403 /* available as a function in hv.c */
404 #define Perl_sharepvn(sv, len, hash) HEK_KEY(share_hek(sv, len, hash))
405 #define sharepvn(sv, len, hash)      Perl_sharepvn(sv, len, hash)
406
407 #define share_hek_hek(hek)                                              \
408     (++(((struct shared_he *)(((char *)hek)                             \
409                               - STRUCT_OFFSET(struct shared_he,         \
410                                               shared_he_hek)))          \
411         ->shared_he_he.he_valu.hent_refcount),                          \
412      hek)
413
414 #define hv_store_ent(zlonk, awk, touche, zgruppp)                       \
415     ((HE *) hv_common((zlonk), (awk), NULL, 0, 0, HV_FETCH_ISSTORE,     \
416                       (touche), (zgruppp)))
417
418 #define hv_exists_ent(zlonk, awk, zgruppp)                              \
419     (hv_common((zlonk), (awk), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (zgruppp))\
420      ? TRUE : FALSE)
421 #define hv_fetch_ent(zlonk, awk, touche, zgruppp)                       \
422     ((HE *) hv_common((zlonk), (awk), NULL, 0, 0,                       \
423                       ((touche) ? HV_FETCH_LVALUE : 0), NULL, (zgruppp)))
424 #define hv_delete_ent(zlonk, awk, touche, zgruppp)                      \
425     ((SV *) hv_common((zlonk), (awk), NULL, 0, 0, (touche) | HV_DELETE, \
426                       NULL, (zgruppp)))
427
428 #define hv_store_flags(urkk, zamm, clunk, thwape, sploosh, eee_yow)     \
429     ((SV**) hv_common((urkk), NULL, (zamm), (clunk), (eee_yow),         \
430                       (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (thwape),    \
431                       (sploosh)))
432
433 #define hv_store(urkk, zamm, clunk, thwape, sploosh)                    \
434     ((SV**) hv_common_key_len((urkk), (zamm), (clunk),                  \
435                               (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV),      \
436                               (thwape), (sploosh)))
437
438 #define hv_exists(urkk, zamm, clunk)                                    \
439     (hv_common_key_len((urkk), (zamm), (clunk), HV_FETCH_ISEXISTS, NULL, 0) \
440      ? TRUE : FALSE)
441
442 #define hv_fetch(urkk, zamm, clunk, pam)                                \
443     ((SV**) hv_common_key_len((urkk), (zamm), (clunk), (pam)            \
444                               ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE)    \
445                               : HV_FETCH_JUST_SV, NULL, 0))
446
447 #define hv_delete(urkk, zamm, clunk, pam)                               \
448     ((SV*) hv_common_key_len((urkk), (zamm), (clunk),                   \
449                              (pam) | HV_DELETE, NULL, 0))
450
451 /* This refcounted he structure is used for storing the hints used for lexical
452    pragmas. Without threads, it's basically struct he + refcount.
453    With threads, life gets more complex as the structure needs to be shared
454    between threads (because it hangs from OPs, which are shared), hence the
455    alternate definition and mutex.  */
456
457 struct refcounted_he;
458
459 #ifdef PERL_CORE
460
461 /* Gosh. This really isn't a good name any longer.  */
462 struct refcounted_he {
463     struct refcounted_he *refcounted_he_next;   /* next entry in chain */
464 #ifdef USE_ITHREADS
465     U32                   refcounted_he_hash;
466     U32                   refcounted_he_keylen;
467 #else
468     HEK                  *refcounted_he_hek;    /* hint key */
469 #endif
470     union {
471         IV                refcounted_he_u_iv;
472         UV                refcounted_he_u_uv;
473         STRLEN            refcounted_he_u_len;
474         void             *refcounted_he_u_ptr;  /* Might be useful in future */
475     } refcounted_he_val;
476     U32                   refcounted_he_refcnt; /* reference count */
477     /* First byte is flags. Then NUL-terminated value. Then for ithreads,
478        non-NUL terminated key.  */
479     char                  refcounted_he_data[1];
480 };
481
482 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */
483 #define HVrhek_undef    0x00 /* Value is undef. */
484 #define HVrhek_delete   0x10 /* Value is placeholder - signifies delete. */
485 #define HVrhek_IV       0x20 /* Value is IV. */
486 #define HVrhek_UV       0x30 /* Value is UV. */
487 #define HVrhek_PV       0x40 /* Value is a (byte) string. */
488 #define HVrhek_PV_UTF8  0x50 /* Value is a (utf8) string. */
489 /* Two spare. As these have to live in the optree, you can't store anything
490    interpreter specific, such as SVs. :-( */
491 #define HVrhek_typemask 0x70
492
493 #ifdef USE_ITHREADS
494 /* A big expression to find the key offset */
495 #define REF_HE_KEY(chain)                                               \
496         ((((chain->refcounted_he_data[0] & 0x60) == 0x40)               \
497             ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0)     \
498          + 1 + chain->refcounted_he_data)
499 #endif
500
501 #  ifdef USE_ITHREADS
502 #    define HINTS_REFCNT_LOCK           MUTEX_LOCK(&PL_hints_mutex)
503 #    define HINTS_REFCNT_UNLOCK         MUTEX_UNLOCK(&PL_hints_mutex)
504 #  else
505 #    define HINTS_REFCNT_LOCK           NOOP
506 #    define HINTS_REFCNT_UNLOCK         NOOP
507 #  endif
508 #endif
509
510 #ifdef USE_ITHREADS
511 #  define HINTS_REFCNT_INIT             MUTEX_INIT(&PL_hints_mutex)
512 #  define HINTS_REFCNT_TERM             MUTEX_DESTROY(&PL_hints_mutex)
513 #else
514 #  define HINTS_REFCNT_INIT             NOOP
515 #  define HINTS_REFCNT_TERM             NOOP
516 #endif
517
518 /* Hash actions
519  * Passed in PERL_MAGIC_uvar calls
520  */
521 #define HV_DISABLE_UVAR_XKEY    0x01
522 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it
523    is documented as being passed to hv_delete().  */
524 #define HV_FETCH_ISSTORE        0x04
525 #define HV_FETCH_ISEXISTS       0x08
526 #define HV_FETCH_LVALUE         0x10
527 #define HV_FETCH_JUST_SV        0x20
528 #define HV_DELETE               0x40
529
530 /*
531  * Local variables:
532  * c-indentation-style: bsd
533  * c-basic-offset: 4
534  * indent-tabs-mode: t
535  * End:
536  *
537  * ex: set ts=8 sts=4 sw=4 noet:
538  */