1 /* hv.h 2 * 3 * Copyright (C) 1991, 1992, 1993, 1996, 1997, 1998, 1999, 4 * 2000, 2001, 2002, 2003, 2005, 2006, 2007, 2008, 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 /* These control hash traversal randomization and the environment variable PERL_PERTURB_KEYS. 12 * Currently disabling this functionality will break a few tests, but should otherwise work fine. 13 * See perlrun for more details. */ 14 15 #if defined(PERL_PERTURB_KEYS_DISABLED) 16 # define PL_HASH_RAND_BITS_ENABLED 0 17 # define PERL_HASH_ITER_BUCKET(iter) ((iter)->xhv_riter) 18 #else 19 # define PERL_HASH_RANDOMIZE_KEYS 1 20 # if defined(PERL_PERTURB_KEYS_RANDOM) 21 # define PL_HASH_RAND_BITS_ENABLED 1 22 # elif defined(PERL_PERTURB_KEYS_DETERMINISTIC) 23 # define PL_HASH_RAND_BITS_ENABLED 2 24 # else 25 # define USE_PERL_PERTURB_KEYS 1 26 # define PL_HASH_RAND_BITS_ENABLED PL_hash_rand_bits_enabled 27 # endif 28 # define PERL_HASH_ITER_BUCKET(iter) (((iter)->xhv_riter) ^ ((iter)->xhv_rand)) 29 #endif 30 31 /* entry in hash value chain */ 32 struct he { 33 /* Keep hent_next first in this structure, because sv_free_arenas take 34 advantage of this to share code between the he arenas and the SV 35 body arenas */ 36 HE *hent_next; /* next entry in chain */ 37 HEK *hent_hek; /* hash key */ 38 union { 39 SV *hent_val; /* scalar value that was hashed */ 40 Size_t hent_refcount; /* references for this shared hash key */ 41 } he_valu; 42 }; 43 44 /* hash key -- defined separately for use as shared pointer */ 45 struct hek { 46 U32 hek_hash; /* computed hash of key */ 47 I32 hek_len; /* length of the hash key */ 48 /* Be careful! Sometimes we store a pointer in the hek_key 49 * buffer, which means it must be 8 byte aligned or things 50 * dont work on aligned platforms like HPUX 51 * Also beware, the last byte of the hek_key buffer is a 52 * hidden flags byte about the key. */ 53 char hek_key[1]; /* variable-length hash key */ 54 /* the hash-key is \0-terminated */ 55 /* after the \0 there is a byte for flags, such as whether the key 56 is UTF-8 or WAS-UTF-8, or an SV */ 57 }; 58 59 struct shared_he { 60 struct he shared_he_he; 61 struct hek shared_he_hek; 62 }; 63 64 /* Subject to change. 65 Don't access this directly. 66 Use the funcs in mro_core.c 67 */ 68 69 struct mro_alg { 70 AV *(*resolve)(pTHX_ HV* stash, U32 level); 71 const char *name; 72 U16 length; 73 U16 kflags; /* For the hash API - set HVhek_UTF8 if name is UTF-8 */ 74 U32 hash; /* or 0 */ 75 }; 76 77 struct mro_meta { 78 /* a hash holding the different MROs private data. */ 79 HV *mro_linear_all; 80 /* a pointer directly to the current MROs private data. If mro_linear_all 81 is NULL, this owns the SV reference, else it is just a pointer to a 82 value stored in and owned by mro_linear_all. */ 83 SV *mro_linear_current; 84 HV *mro_nextmethod; /* next::method caching */ 85 U32 cache_gen; /* Bumping this invalidates our method cache */ 86 U32 pkg_gen; /* Bumps when local methods/@ISA change */ 87 const struct mro_alg *mro_which; /* which mro alg is in use? */ 88 HV *isa; /* Everything this class @ISA */ 89 HV *super; /* SUPER method cache */ 90 CV *destroy; /* DESTROY method if destroy_gen non-zero */ 91 U32 destroy_gen; /* Generation number of DESTROY cache */ 92 }; 93 94 #define MRO_GET_PRIVATE_DATA(smeta, which) \ 95 (((smeta)->mro_which && (which) == (smeta)->mro_which) \ 96 ? (smeta)->mro_linear_current \ 97 : Perl_mro_get_private_data(aTHX_ (smeta), (which))) 98 99 /* Subject to change. 100 Don't access this directly. 101 */ 102 103 union _xhvnameu { 104 HEK *xhvnameu_name; /* When xhv_name_count is 0 */ 105 HEK **xhvnameu_names; /* When xhv_name_count is non-0 */ 106 }; 107 108 struct xpvhv_aux { 109 union _xhvnameu xhv_name_u; /* name, if a symbol table */ 110 AV *xhv_backreferences; /* back references for weak references */ 111 HE *xhv_eiter; /* current entry of iterator */ 112 I32 xhv_riter; /* current root of iterator */ 113 114 /* Concerning xhv_name_count: When non-zero, xhv_name_u contains a pointer 115 * to an array of HEK pointers, this being the length. The first element is 116 * the name of the stash, which may be NULL. If xhv_name_count is positive, 117 * then *xhv_name is one of the effective names. If xhv_name_count is nega- 118 * tive, then xhv_name_u.xhvnameu_names[1] is the first effective name. 119 */ 120 I32 xhv_name_count; 121 struct mro_meta *xhv_mro_meta; 122 #ifdef PERL_HASH_RANDOMIZE_KEYS 123 U32 xhv_rand; /* random value for hash traversal */ 124 U32 xhv_last_rand; /* last random value for hash traversal, 125 used to detect each() after insert for warnings */ 126 #endif 127 U32 xhv_aux_flags; /* assorted extra flags */ 128 }; 129 130 #define HvAUXf_SCAN_STASH 0x1 /* stash is being scanned by gv_check */ 131 #define HvAUXf_NO_DEREF 0x2 /* @{}, %{} etc (and nomethod) not present */ 132 133 /* hash structure: */ 134 /* This structure must match the beginning of struct xpvmg in sv.h. */ 135 struct xpvhv { 136 HV* xmg_stash; /* class package */ 137 union _xmgu xmg_u; 138 STRLEN xhv_keys; /* total keys, including placeholders */ 139 STRLEN xhv_max; /* subscript of last element of xhv_array */ 140 }; 141 142 /* 143 =head1 Hash Manipulation Functions 144 145 =for apidoc AmnU||HEf_SVKEY 146 This flag, used in the length slot of hash entries and magic structures, 147 specifies the structure contains an C<SV*> pointer where a C<char*> pointer 148 is to be expected. (For information only--not to be used). 149 150 =head1 Handy Values 151 152 =for apidoc ADmnU||Nullhv 153 Null HV pointer. 154 155 (deprecated - use C<(HV *)NULL> instead) 156 157 =head1 Hash Manipulation Functions 158 159 =for apidoc Am|char*|HvNAME|HV* stash 160 Returns the package name of a stash, or C<NULL> if C<stash> isn't a stash. 161 See C<L</SvSTASH>>, C<L</CvSTASH>>. 162 163 =for apidoc Am|STRLEN|HvNAMELEN|HV *stash 164 Returns the length of the stash's name. 165 166 =for apidoc Am|unsigned char|HvNAMEUTF8|HV *stash 167 Returns true if the name is in UTF-8 encoding. 168 169 =for apidoc Am|char*|HvENAME|HV* stash 170 Returns the effective name of a stash, or NULL if there is none. The 171 effective name represents a location in the symbol table where this stash 172 resides. It is updated automatically when packages are aliased or deleted. 173 A stash that is no longer in the symbol table has no effective name. This 174 name is preferable to C<HvNAME> for use in MRO linearisations and isa 175 caches. 176 177 =for apidoc Am|STRLEN|HvENAMELEN|HV *stash 178 Returns the length of the stash's effective name. 179 180 =for apidoc Am|unsigned char|HvENAMEUTF8|HV *stash 181 Returns true if the effective name is in UTF-8 encoding. 182 183 =for apidoc Am|void*|HeKEY|HE* he 184 Returns the actual pointer stored in the key slot of the hash entry. The 185 pointer may be either C<char*> or C<SV*>, depending on the value of 186 C<HeKLEN()>. Can be assigned to. The C<HePV()> or C<HeSVKEY()> macros are 187 usually preferable for finding the value of a key. 188 189 =for apidoc Am|STRLEN|HeKLEN|HE* he 190 If this is negative, and amounts to C<HEf_SVKEY>, it indicates the entry 191 holds an C<SV*> key. Otherwise, holds the actual length of the key. Can 192 be assigned to. The C<HePV()> macro is usually preferable for finding key 193 lengths. 194 195 =for apidoc Am|SV*|HeVAL|HE* he 196 Returns the value slot (type C<SV*>) 197 stored in the hash entry. Can be assigned 198 to. 199 200 SV *foo= HeVAL(hv); 201 HeVAL(hv)= sv; 202 203 204 =for apidoc Am|U32|HeHASH|HE* he 205 Returns the computed hash stored in the hash entry. 206 207 =for apidoc Am|char*|HePV|HE* he|STRLEN len 208 Returns the key slot of the hash entry as a C<char*> value, doing any 209 necessary dereferencing of possibly C<SV*> keys. The length of the string 210 is placed in C<len> (this is a macro, so do I<not> use C<&len>). If you do 211 not care about what the length of the key is, you may use the global 212 variable C<PL_na>, though this is rather less efficient than using a local 213 variable. Remember though, that hash keys in perl are free to contain 214 embedded nulls, so using C<strlen()> or similar is not a good way to find 215 the length of hash keys. This is very similar to the C<SvPV()> macro 216 described elsewhere in this document. See also C<L</HeUTF8>>. 217 218 If you are using C<HePV> to get values to pass to C<newSVpvn()> to create a 219 new SV, you should consider using C<newSVhek(HeKEY_hek(he))> as it is more 220 efficient. 221 222 =for apidoc Am|U32|HeUTF8|HE* he 223 Returns whether the C<char *> value returned by C<HePV> is encoded in UTF-8, 224 doing any necessary dereferencing of possibly C<SV*> keys. The value returned 225 will be 0 or non-0, not necessarily 1 (or even a value with any low bits set), 226 so B<do not> blindly assign this to a C<bool> variable, as C<bool> may be a 227 typedef for C<char>. 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 #define PERL_HASH_DEFAULT_HvMAX 7 246 247 /* During hsplit(), if HvMAX(hv)+1 (the new bucket count) is >= this value, 248 * we preallocate the HvAUX() struct. 249 * The assumption being that we are using so much space anyway we might 250 * as well allocate the extra bytes and speed up later keys() 251 * or each() operations. We don't do this to small hashes as we assume 252 * that a) it will be easy/fast to resize them to add the iterator, and b) that 253 * many of them will be objects which won't be traversed. Larger hashes however 254 * will take longer to extend, and the size of the aux struct is swamped by the 255 * overall length of the bucket array. 256 * */ 257 #define PERL_HV_ALLOC_AUX_SIZE (1 << 9) 258 259 /* these hash entry flags ride on hent_klen (for use only in magic/tied HVs) */ 260 #define HEf_SVKEY -2 /* hent_key is an SV* */ 261 262 #ifndef PERL_CORE 263 # define Nullhv Null(HV*) 264 #endif 265 #define HvARRAY(hv) ((hv)->sv_u.svu_hash) 266 267 /* 268 269 =for apidoc Am|STRLEN|HvFILL|HV *const hv 270 271 See L</hv_fill>. 272 273 =cut 274 275 */ 276 #define HvFILL(hv) Perl_hv_fill(aTHX_ MUTABLE_HV(hv)) 277 #define HvMAX(hv) ((XPVHV*) SvANY(hv))->xhv_max 278 /* This quite intentionally does no flag checking first. That's your 279 responsibility. */ 280 #define HvAUX(hv) ((struct xpvhv_aux*)&(HvARRAY(hv)[HvMAX(hv)+1])) 281 #define HvRITER(hv) (*Perl_hv_riter_p(aTHX_ MUTABLE_HV(hv))) 282 #define HvEITER(hv) (*Perl_hv_eiter_p(aTHX_ MUTABLE_HV(hv))) 283 #define HvRITER_set(hv,r) Perl_hv_riter_set(aTHX_ MUTABLE_HV(hv), r) 284 #define HvEITER_set(hv,e) Perl_hv_eiter_set(aTHX_ MUTABLE_HV(hv), e) 285 #define HvRITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_riter : -1) 286 #define HvEITER_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_eiter : NULL) 287 #define HvRAND_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_rand : 0) 288 #define HvLASTRAND_get(hv) (SvOOK(hv) ? HvAUX(hv)->xhv_last_rand : 0) 289 290 #define HvNAME(hv) HvNAME_get(hv) 291 #define HvNAMELEN(hv) HvNAMELEN_get(hv) 292 #define HvENAME(hv) HvENAME_get(hv) 293 #define HvENAMELEN(hv) HvENAMELEN_get(hv) 294 295 /* Checking that hv is a valid package stash is the 296 caller's responsibility */ 297 #define HvMROMETA(hv) (HvAUX(hv)->xhv_mro_meta \ 298 ? HvAUX(hv)->xhv_mro_meta \ 299 : Perl_mro_meta_init(aTHX_ hv)) 300 301 #define HvNAME_HEK_NN(hv) \ 302 ( \ 303 HvAUX(hv)->xhv_name_count \ 304 ? *HvAUX(hv)->xhv_name_u.xhvnameu_names \ 305 : HvAUX(hv)->xhv_name_u.xhvnameu_name \ 306 ) 307 /* This macro may go away without notice. */ 308 #define HvNAME_HEK(hv) \ 309 (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvNAME_HEK_NN(hv) : NULL) 310 #define HvNAME_get(hv) \ 311 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \ 312 ? HEK_KEY(HvNAME_HEK_NN(hv)) : NULL) 313 #define HvNAMELEN_get(hv) \ 314 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \ 315 ? HEK_LEN(HvNAME_HEK_NN(hv)) : 0) 316 #define HvNAMEUTF8(hv) \ 317 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvNAME_HEK_NN(hv)) \ 318 ? HEK_UTF8(HvNAME_HEK_NN(hv)) : 0) 319 #define HvENAME_HEK_NN(hv) \ 320 ( \ 321 HvAUX(hv)->xhv_name_count > 0 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[0] : \ 322 HvAUX(hv)->xhv_name_count < -1 ? HvAUX(hv)->xhv_name_u.xhvnameu_names[1] : \ 323 HvAUX(hv)->xhv_name_count == -1 ? NULL : \ 324 HvAUX(hv)->xhv_name_u.xhvnameu_name \ 325 ) 326 #define HvENAME_HEK(hv) \ 327 (SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name ? HvENAME_HEK_NN(hv) : NULL) 328 #define HvENAME_get(hv) \ 329 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \ 330 ? HEK_KEY(HvENAME_HEK_NN(hv)) : NULL) 331 #define HvENAMELEN_get(hv) \ 332 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \ 333 ? HEK_LEN(HvENAME_HEK_NN(hv)) : 0) 334 #define HvENAMEUTF8(hv) \ 335 ((SvOOK(hv) && HvAUX(hv)->xhv_name_u.xhvnameu_name && HvAUX(hv)->xhv_name_count != -1) \ 336 ? HEK_UTF8(HvENAME_HEK_NN(hv)) : 0) 337 338 /* the number of keys (including any placeholders) - NOT PART OF THE API */ 339 #define XHvTOTALKEYS(xhv) ((xhv)->xhv_keys) 340 341 /* 342 * HvKEYS gets the number of keys that actually exist(), and is provided 343 * for backwards compatibility with old XS code. The core uses HvUSEDKEYS 344 * (keys, excluding placeholders) and HvTOTALKEYS (including placeholders) 345 */ 346 #define HvKEYS(hv) HvUSEDKEYS(hv) 347 #define HvUSEDKEYS(hv) (HvTOTALKEYS(hv) - HvPLACEHOLDERS_get(hv)) 348 #define HvTOTALKEYS(hv) XHvTOTALKEYS((XPVHV*) SvANY(hv)) 349 #define HvPLACEHOLDERS(hv) (*Perl_hv_placeholders_p(aTHX_ MUTABLE_HV(hv))) 350 #define HvPLACEHOLDERS_get(hv) (SvMAGIC(hv) ? Perl_hv_placeholders_get(aTHX_ (const HV *)hv) : 0) 351 #define HvPLACEHOLDERS_set(hv,p) Perl_hv_placeholders_set(aTHX_ MUTABLE_HV(hv), p) 352 353 #define HvSHAREKEYS(hv) (SvFLAGS(hv) & SVphv_SHAREKEYS) 354 #define HvSHAREKEYS_on(hv) (SvFLAGS(hv) |= SVphv_SHAREKEYS) 355 #define HvSHAREKEYS_off(hv) (SvFLAGS(hv) &= ~SVphv_SHAREKEYS) 356 357 /* This is an optimisation flag. It won't be set if all hash keys have a 0 358 * flag. Currently the only flags relate to utf8. 359 * Hence it won't be set if all keys are 8 bit only. It will be set if any key 360 * is utf8 (including 8 bit keys that were entered as utf8, and need upgrading 361 * when retrieved during iteration. It may still be set when there are no longer 362 * any utf8 keys. 363 * See HVhek_ENABLEHVKFLAGS for the trigger. 364 */ 365 #define HvHASKFLAGS(hv) (SvFLAGS(hv) & SVphv_HASKFLAGS) 366 #define HvHASKFLAGS_on(hv) (SvFLAGS(hv) |= SVphv_HASKFLAGS) 367 #define HvHASKFLAGS_off(hv) (SvFLAGS(hv) &= ~SVphv_HASKFLAGS) 368 369 #define HvLAZYDEL(hv) (SvFLAGS(hv) & SVphv_LAZYDEL) 370 #define HvLAZYDEL_on(hv) (SvFLAGS(hv) |= SVphv_LAZYDEL) 371 #define HvLAZYDEL_off(hv) (SvFLAGS(hv) &= ~SVphv_LAZYDEL) 372 373 #ifndef PERL_CORE 374 # define Nullhe Null(HE*) 375 #endif 376 #define HeNEXT(he) (he)->hent_next 377 #define HeKEY_hek(he) (he)->hent_hek 378 #define HeKEY(he) HEK_KEY(HeKEY_hek(he)) 379 #define HeKEY_sv(he) (*(SV**)HeKEY(he)) 380 #define HeKLEN(he) HEK_LEN(HeKEY_hek(he)) 381 #define HeKUTF8(he) HEK_UTF8(HeKEY_hek(he)) 382 #define HeKWASUTF8(he) HEK_WASUTF8(HeKEY_hek(he)) 383 #define HeKLEN_UTF8(he) (HeKUTF8(he) ? -HeKLEN(he) : HeKLEN(he)) 384 #define HeKFLAGS(he) HEK_FLAGS(HeKEY_hek(he)) 385 #define HeVAL(he) (he)->he_valu.hent_val 386 #define HeHASH(he) HEK_HASH(HeKEY_hek(he)) 387 #define HePV(he,lp) ((HeKLEN(he) == HEf_SVKEY) ? \ 388 SvPV(HeKEY_sv(he),lp) : \ 389 ((lp = HeKLEN(he)), HeKEY(he))) 390 #define HeUTF8(he) ((HeKLEN(he) == HEf_SVKEY) ? \ 391 SvUTF8(HeKEY_sv(he)) : \ 392 (U32)HeKUTF8(he)) 393 394 #define HeSVKEY(he) ((HeKEY(he) && \ 395 HeKLEN(he) == HEf_SVKEY) ? \ 396 HeKEY_sv(he) : NULL) 397 398 #define HeSVKEY_force(he) (HeKEY(he) ? \ 399 ((HeKLEN(he) == HEf_SVKEY) ? \ 400 HeKEY_sv(he) : \ 401 newSVpvn_flags(HeKEY(he), \ 402 HeKLEN(he), \ 403 SVs_TEMP | \ 404 ( HeKUTF8(he) ? SVf_UTF8 : 0 ))) : \ 405 &PL_sv_undef) 406 #define HeSVKEY_set(he,sv) ((HeKLEN(he) = HEf_SVKEY), (HeKEY_sv(he) = sv)) 407 408 #ifndef PERL_CORE 409 # define Nullhek Null(HEK*) 410 #endif 411 #define HEK_BASESIZE STRUCT_OFFSET(HEK, hek_key[0]) 412 #define HEK_HASH(hek) (hek)->hek_hash 413 #define HEK_LEN(hek) (hek)->hek_len 414 #define HEK_KEY(hek) (hek)->hek_key 415 #define HEK_FLAGS(hek) (*((unsigned char *)(HEK_KEY(hek))+HEK_LEN(hek)+1)) 416 417 #define HVhek_UTF8 0x01 /* Key is utf8 encoded. */ 418 #define HVhek_WASUTF8 0x02 /* Key is bytes here, but was supplied as utf8. */ 419 #define HVhek_UNSHARED 0x08 /* This key isn't a shared hash key. */ 420 /* the following flags are options for functions, they are not stored in heks */ 421 #define HVhek_FREEKEY 0x100 /* Internal flag to say key is Newx()ed. */ 422 #define HVhek_PLACEHOLD 0x200 /* Internal flag to create placeholder. 423 * (may change, but Storable is a core module) */ 424 #define HVhek_KEYCANONICAL 0x400 /* Internal flag - key is in canonical form. 425 If the string is UTF-8, it cannot be 426 converted to bytes. */ 427 #define HVhek_MASK 0xFF 428 429 #define HVhek_ENABLEHVKFLAGS (HVhek_MASK & ~(HVhek_UNSHARED)) 430 431 #define HEK_UTF8(hek) (HEK_FLAGS(hek) & HVhek_UTF8) 432 #define HEK_UTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_UTF8) 433 #define HEK_UTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_UTF8) 434 #define HEK_WASUTF8(hek) (HEK_FLAGS(hek) & HVhek_WASUTF8) 435 #define HEK_WASUTF8_on(hek) (HEK_FLAGS(hek) |= HVhek_WASUTF8) 436 #define HEK_WASUTF8_off(hek) (HEK_FLAGS(hek) &= ~HVhek_WASUTF8) 437 438 /* calculate HV array allocation */ 439 #ifndef PERL_USE_LARGE_HV_ALLOC 440 /* Default to allocating the correct size - default to assuming that malloc() 441 is not broken and is efficient at allocating blocks sized at powers-of-two. 442 */ 443 # define PERL_HV_ARRAY_ALLOC_BYTES(size) ((size) * sizeof(HE*)) 444 #else 445 # define MALLOC_OVERHEAD 16 446 # define PERL_HV_ARRAY_ALLOC_BYTES(size) \ 447 (((size) < 64) \ 448 ? (size) * sizeof(HE*) \ 449 : (size) * sizeof(HE*) * 2 - MALLOC_OVERHEAD) 450 #endif 451 452 /* Flags for hv_iternext_flags. */ 453 #define HV_ITERNEXT_WANTPLACEHOLDERS 0x01 /* Don't skip placeholders. */ 454 455 #define hv_iternext(hv) hv_iternext_flags(hv, 0) 456 #define hv_magic(hv, gv, how) sv_magic(MUTABLE_SV(hv), MUTABLE_SV(gv), how, NULL, 0) 457 #define hv_undef(hv) Perl_hv_undef_flags(aTHX_ hv, 0) 458 459 #define Perl_sharepvn(pv, len, hash) HEK_KEY(share_hek(pv, len, hash)) 460 #define sharepvn(pv, len, hash) Perl_sharepvn(pv, len, hash) 461 462 #define share_hek_hek(hek) \ 463 (++(((struct shared_he *)(((char *)hek) \ 464 - STRUCT_OFFSET(struct shared_he, \ 465 shared_he_hek))) \ 466 ->shared_he_he.he_valu.hent_refcount), \ 467 hek) 468 469 #define hv_store_ent(hv, keysv, val, hash) \ 470 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISSTORE, \ 471 (val), (hash))) 472 473 #define hv_exists_ent(hv, keysv, hash) \ 474 cBOOL(hv_common((hv), (keysv), NULL, 0, 0, HV_FETCH_ISEXISTS, 0, (hash))) 475 #define hv_fetch_ent(hv, keysv, lval, hash) \ 476 ((HE *) hv_common((hv), (keysv), NULL, 0, 0, \ 477 ((lval) ? HV_FETCH_LVALUE : 0), NULL, (hash))) 478 #define hv_delete_ent(hv, key, flags, hash) \ 479 (MUTABLE_SV(hv_common((hv), (key), NULL, 0, 0, (flags) | HV_DELETE, \ 480 NULL, (hash)))) 481 482 #define hv_store_flags(hv, key, klen, val, hash, flags) \ 483 ((SV**) hv_common((hv), NULL, (key), (klen), (flags), \ 484 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), (val), \ 485 (hash))) 486 487 #define hv_store(hv, key, klen, val, hash) \ 488 ((SV**) hv_common_key_len((hv), (key), (klen), \ 489 (HV_FETCH_ISSTORE|HV_FETCH_JUST_SV), \ 490 (val), (hash))) 491 492 493 494 #define hv_exists(hv, key, klen) \ 495 cBOOL(hv_common_key_len((hv), (key), (klen), HV_FETCH_ISEXISTS, NULL, 0)) 496 497 #define hv_fetch(hv, key, klen, lval) \ 498 ((SV**) hv_common_key_len((hv), (key), (klen), (lval) \ 499 ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \ 500 : HV_FETCH_JUST_SV, NULL, 0)) 501 502 #define hv_delete(hv, key, klen, flags) \ 503 (MUTABLE_SV(hv_common_key_len((hv), (key), (klen), \ 504 (flags) | HV_DELETE, NULL, 0))) 505 506 /* Provide 's' suffix subs for constant strings (and avoid needing to count 507 * chars). See STR_WITH_LEN in handy.h - because these are macros we cant use 508 * STR_WITH_LEN to do the work, we have to unroll it. */ 509 #define hv_existss(hv, key) \ 510 hv_exists((hv), ("" key ""), (sizeof(key)-1)) 511 512 #define hv_fetchs(hv, key, lval) \ 513 hv_fetch((hv), ("" key ""), (sizeof(key)-1), (lval)) 514 515 #define hv_deletes(hv, key, flags) \ 516 hv_delete((hv), ("" key ""), (sizeof(key)-1), (flags)) 517 518 #define hv_name_sets(hv, name, flags) \ 519 hv_name_set((hv),("" name ""),(sizeof(name)-1), flags) 520 521 #define hv_stores(hv, key, val) \ 522 hv_store((hv), ("" key ""), (sizeof(key)-1), (val), 0) 523 524 #ifdef PERL_CORE 525 # define hv_storehek(hv, hek, val) \ 526 hv_common((hv), NULL, HEK_KEY(hek), HEK_LEN(hek), HEK_UTF8(hek), \ 527 HV_FETCH_ISSTORE|HV_FETCH_JUST_SV, (val), HEK_HASH(hek)) 528 # define hv_fetchhek(hv, hek, lval) \ 529 ((SV **) \ 530 hv_common((hv), NULL, HEK_KEY(hek), HEK_LEN(hek), HEK_UTF8(hek), \ 531 (lval) \ 532 ? (HV_FETCH_JUST_SV | HV_FETCH_LVALUE) \ 533 : HV_FETCH_JUST_SV, \ 534 NULL, HEK_HASH(hek))) 535 # define hv_deletehek(hv, hek, flags) \ 536 hv_common((hv), NULL, HEK_KEY(hek), HEK_LEN(hek), HEK_UTF8(hek), \ 537 (flags)|HV_DELETE, NULL, HEK_HASH(hek)) 538 #endif 539 540 /* This refcounted he structure is used for storing the hints used for lexical 541 pragmas. Without threads, it's basically struct he + refcount. 542 With threads, life gets more complex as the structure needs to be shared 543 between threads (because it hangs from OPs, which are shared), hence the 544 alternate definition and mutex. */ 545 546 struct refcounted_he; 547 548 /* flags for the refcounted_he API */ 549 #define REFCOUNTED_HE_KEY_UTF8 0x00000001 550 #ifdef PERL_CORE 551 # define REFCOUNTED_HE_EXISTS 0x00000002 552 #endif 553 554 #ifdef PERL_CORE 555 556 /* Gosh. This really isn't a good name any longer. */ 557 struct refcounted_he { 558 struct refcounted_he *refcounted_he_next; /* next entry in chain */ 559 #ifdef USE_ITHREADS 560 U32 refcounted_he_hash; 561 U32 refcounted_he_keylen; 562 #else 563 HEK *refcounted_he_hek; /* hint key */ 564 #endif 565 union { 566 IV refcounted_he_u_iv; 567 UV refcounted_he_u_uv; 568 STRLEN refcounted_he_u_len; 569 void *refcounted_he_u_ptr; /* Might be useful in future */ 570 } refcounted_he_val; 571 U32 refcounted_he_refcnt; /* reference count */ 572 /* First byte is flags. Then NUL-terminated value. Then for ithreads, 573 non-NUL terminated key. */ 574 char refcounted_he_data[1]; 575 }; 576 577 /* 578 =for apidoc m|SV *|refcounted_he_fetch_pvs|const struct refcounted_he *chain|"key"|U32 flags 579 580 Like L</refcounted_he_fetch_pvn>, but takes a literal string 581 instead of a string/length pair, and no precomputed hash. 582 583 =cut 584 */ 585 586 #define refcounted_he_fetch_pvs(chain, key, flags) \ 587 Perl_refcounted_he_fetch_pvn(aTHX_ chain, STR_WITH_LEN(key), 0, flags) 588 589 /* 590 =for apidoc m|struct refcounted_he *|refcounted_he_new_pvs|struct refcounted_he *parent|"key"|SV *value|U32 flags 591 592 Like L</refcounted_he_new_pvn>, but takes a literal string 593 instead of a string/length pair, and no precomputed hash. 594 595 =cut 596 */ 597 598 #define refcounted_he_new_pvs(parent, key, value, flags) \ 599 Perl_refcounted_he_new_pvn(aTHX_ parent, STR_WITH_LEN(key), 0, value, flags) 600 601 /* Flag bits are HVhek_UTF8, HVhek_WASUTF8, then */ 602 #define HVrhek_undef 0x00 /* Value is undef. */ 603 #define HVrhek_delete 0x10 /* Value is placeholder - signifies delete. */ 604 #define HVrhek_IV 0x20 /* Value is IV. */ 605 #define HVrhek_UV 0x30 /* Value is UV. */ 606 #define HVrhek_PV 0x40 /* Value is a (byte) string. */ 607 #define HVrhek_PV_UTF8 0x50 /* Value is a (utf8) string. */ 608 /* Two spare. As these have to live in the optree, you can't store anything 609 interpreter specific, such as SVs. :-( */ 610 #define HVrhek_typemask 0x70 611 612 #ifdef USE_ITHREADS 613 /* A big expression to find the key offset */ 614 #define REF_HE_KEY(chain) \ 615 ((((chain->refcounted_he_data[0] & 0x60) == 0x40) \ 616 ? chain->refcounted_he_val.refcounted_he_u_len + 1 : 0) \ 617 + 1 + chain->refcounted_he_data) 618 #endif 619 620 # ifdef USE_ITHREADS 621 # define HINTS_REFCNT_LOCK MUTEX_LOCK(&PL_hints_mutex) 622 # define HINTS_REFCNT_UNLOCK MUTEX_UNLOCK(&PL_hints_mutex) 623 # else 624 # define HINTS_REFCNT_LOCK NOOP 625 # define HINTS_REFCNT_UNLOCK NOOP 626 # endif 627 #endif 628 629 #ifdef USE_ITHREADS 630 # define HINTS_REFCNT_INIT MUTEX_INIT(&PL_hints_mutex) 631 # define HINTS_REFCNT_TERM MUTEX_DESTROY(&PL_hints_mutex) 632 #else 633 # define HINTS_REFCNT_INIT NOOP 634 # define HINTS_REFCNT_TERM NOOP 635 #endif 636 637 /* Hash actions 638 * Passed in PERL_MAGIC_uvar calls 639 */ 640 #define HV_DISABLE_UVAR_XKEY 0x01 641 /* We need to ensure that these don't clash with G_DISCARD, which is 2, as it 642 is documented as being passed to hv_delete(). */ 643 #define HV_FETCH_ISSTORE 0x04 644 #define HV_FETCH_ISEXISTS 0x08 645 #define HV_FETCH_LVALUE 0x10 646 #define HV_FETCH_JUST_SV 0x20 647 #define HV_DELETE 0x40 648 #define HV_FETCH_EMPTY_HE 0x80 /* Leave HeVAL null. */ 649 650 /* Must not conflict with HVhek_UTF8 */ 651 #define HV_NAME_SETALL 0x02 652 653 /* 654 =for apidoc newHV 655 656 Creates a new HV. The reference count is set to 1. 657 658 =cut 659 */ 660 661 #define newHV() MUTABLE_HV(newSV_type(SVt_PVHV)) 662 663 #include "hv_func.h" 664 665 /* 666 * ex: set ts=8 sts=4 sw=4 et: 667 */ 668