This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
[perl #119351] fix regression in B::CV::GV
[perl5.git] / mro.c
CommitLineData
e1a479c5
BB
1/* mro.c
2 *
3 * Copyright (c) 2007 Brandon L Black
2eee27d7 4 * Copyright (c) 2007, 2008, 2009, 2010, 2011 Larry Wall and others
e1a479c5
BB
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/*
4ac71550
TC
12 * 'Which order shall we go in?' said Frodo. 'Eldest first, or quickest first?
13 * You'll be last either way, Master Peregrin.'
14 *
15 * [p.101 of _The Lord of the Rings_, I/iii: "A Conspiracy Unmasked"]
cac98860
RGS
16 */
17
18/*
e1a479c5
BB
19=head1 MRO Functions
20
21These functions are related to the method resolution order of perl classes
22
23=cut
24*/
25
26#include "EXTERN.h"
4befac30 27#define PERL_IN_MRO_C
e1a479c5
BB
28#include "perl.h"
29
a3e6e81e
NC
30static const struct mro_alg dfs_alg =
31 {S_mro_get_linear_isa_dfs, "dfs", 3, 0, 0};
3d76853f 32
fa60396f
NC
33SV *
34Perl_mro_get_private_data(pTHX_ struct mro_meta *const smeta,
35 const struct mro_alg *const which)
36{
37 SV **data;
38 PERL_ARGS_ASSERT_MRO_GET_PRIVATE_DATA;
39
5844ac76
NC
40 data = (SV **)Perl_hv_common(aTHX_ smeta->mro_linear_all, NULL,
41 which->name, which->length, which->kflags,
42 HV_FETCH_JUST_SV, NULL, which->hash);
fa60396f
NC
43 if (!data)
44 return NULL;
45
46 /* If we've been asked to look up the private data for the current MRO, then
47 cache it. */
48 if (smeta->mro_which == which)
3a6fa573 49 smeta->mro_linear_current = *data;
fa60396f
NC
50
51 return *data;
52}
53
54SV *
55Perl_mro_set_private_data(pTHX_ struct mro_meta *const smeta,
56 const struct mro_alg *const which, SV *const data)
57{
58 PERL_ARGS_ASSERT_MRO_SET_PRIVATE_DATA;
59
9953ff72 60 if (!smeta->mro_linear_all) {
553e831a
NC
61 if (smeta->mro_which == which) {
62 /* If all we need to store is the current MRO's data, then don't use
63 memory on a hash with 1 element - store it direct, and signal
64 this by leaving the would-be-hash NULL. */
3a6fa573 65 smeta->mro_linear_current = data;
553e831a
NC
66 return data;
67 } else {
68 HV *const hv = newHV();
69 /* Start with 2 buckets. It's unlikely we'll need more. */
70 HvMAX(hv) = 1;
9953ff72 71 smeta->mro_linear_all = hv;
553e831a 72
3a6fa573 73 if (smeta->mro_linear_current) {
553e831a
NC
74 /* If we were storing something directly, put it in the hash
75 before we lose it. */
76 Perl_mro_set_private_data(aTHX_ smeta, smeta->mro_which,
3a6fa573 77 smeta->mro_linear_current);
553e831a
NC
78 }
79 }
80 }
81
82 /* We get here if we're storing more than one linearisation for this stash,
83 or the linearisation we are storing is not that if its current MRO. */
84
85 if (smeta->mro_which == which) {
86 /* If we've been asked to store the private data for the current MRO,
87 then cache it. */
3a6fa573 88 smeta->mro_linear_current = data;
fa60396f
NC
89 }
90
9953ff72 91 if (!Perl_hv_common(aTHX_ smeta->mro_linear_all, NULL,
fa60396f
NC
92 which->name, which->length, which->kflags,
93 HV_FETCH_ISSTORE, data, which->hash)) {
94 Perl_croak(aTHX_ "panic: hv_store() failed in set_mro_private_data() "
95 "for '%.*s' %d", (int) which->length, which->name,
96 which->kflags);
97 }
98
99 return data;
100}
101
a3e6e81e
NC
102const struct mro_alg *
103Perl_mro_get_from_name(pTHX_ SV *name) {
104 SV **data;
105
106 PERL_ARGS_ASSERT_MRO_GET_FROM_NAME;
107
5844ac76
NC
108 data = (SV **)Perl_hv_common(aTHX_ PL_registered_mros, name, NULL, 0, 0,
109 HV_FETCH_JUST_SV, NULL, 0);
a3e6e81e
NC
110 if (!data)
111 return NULL;
112 assert(SvTYPE(*data) == SVt_IV);
113 assert(SvIOK(*data));
114 return INT2PTR(const struct mro_alg *, SvUVX(*data));
115}
116
c145ee24
FC
117/*
118=for apidoc mro_register
119Registers a custom mro plugin. See L<perlmroapi> for details.
164df45a
FC
120
121=cut
c145ee24
FC
122*/
123
a3e6e81e
NC
124void
125Perl_mro_register(pTHX_ const struct mro_alg *mro) {
126 SV *wrapper = newSVuv(PTR2UV(mro));
127
128 PERL_ARGS_ASSERT_MRO_REGISTER;
129
130
131 if (!Perl_hv_common(aTHX_ PL_registered_mros, NULL,
132 mro->name, mro->length, mro->kflags,
133 HV_FETCH_ISSTORE, wrapper, mro->hash)) {
06059157 134 SvREFCNT_dec_NN(wrapper);
a3e6e81e
NC
135 Perl_croak(aTHX_ "panic: hv_store() failed in mro_register() "
136 "for '%.*s' %d", (int) mro->length, mro->name, mro->kflags);
3d76853f 137 }
3d76853f
NC
138}
139
e1a479c5
BB
140struct mro_meta*
141Perl_mro_meta_init(pTHX_ HV* stash)
142{
9fe4aecf 143 struct mro_meta* newmeta;
e1a479c5 144
7918f24d 145 PERL_ARGS_ASSERT_MRO_META_INIT;
e1a479c5
BB
146 assert(HvAUX(stash));
147 assert(!(HvAUX(stash)->xhv_mro_meta));
183086be 148 Newxz(newmeta, 1, struct mro_meta);
9fe4aecf 149 HvAUX(stash)->xhv_mro_meta = newmeta;
dd69841b 150 newmeta->cache_gen = 1;
70cd14a1 151 newmeta->pkg_gen = 1;
a3e6e81e 152 newmeta->mro_which = &dfs_alg;
e1a479c5
BB
153
154 return newmeta;
155}
156
157#if defined(USE_ITHREADS)
158
159/* for sv_dup on new threads */
160struct mro_meta*
161Perl_mro_meta_dup(pTHX_ struct mro_meta* smeta, CLONE_PARAMS* param)
162{
e1a479c5
BB
163 struct mro_meta* newmeta;
164
7918f24d 165 PERL_ARGS_ASSERT_MRO_META_DUP;
e1a479c5 166
33e12d9d
NC
167 Newx(newmeta, 1, struct mro_meta);
168 Copy(smeta, newmeta, 1, struct mro_meta);
169
9953ff72
NC
170 if (newmeta->mro_linear_all) {
171 newmeta->mro_linear_all
a09252eb 172 = MUTABLE_HV(sv_dup_inc((const SV *)newmeta->mro_linear_all, param));
553e831a
NC
173 /* This is just acting as a shortcut pointer, and will be automatically
174 updated on the first get. */
3a6fa573
NC
175 newmeta->mro_linear_current = NULL;
176 } else if (newmeta->mro_linear_current) {
553e831a 177 /* Only the current MRO is stored, so this owns the data. */
3a6fa573 178 newmeta->mro_linear_current
a09252eb 179 = sv_dup_inc((const SV *)newmeta->mro_linear_current, param);
553e831a
NC
180 }
181
33e12d9d
NC
182 if (newmeta->mro_nextmethod)
183 newmeta->mro_nextmethod
a09252eb 184 = MUTABLE_HV(sv_dup_inc((const SV *)newmeta->mro_nextmethod, param));
a49ba3fc
NC
185 if (newmeta->isa)
186 newmeta->isa
a09252eb 187 = MUTABLE_HV(sv_dup_inc((const SV *)newmeta->isa, param));
e1a479c5 188
1a33a059
FC
189 newmeta->super = NULL;
190
e1a479c5
BB
191 return newmeta;
192}
193
194#endif /* USE_ITHREADS */
195
196/*
197=for apidoc mro_get_linear_isa_dfs
198
199Returns the Depth-First Search linearization of @ISA
200the given stash. The return value is a read-only AV*.
201C<level> should be 0 (it is used internally in this
202function's recursion).
203
1c908217
RGS
204You are responsible for C<SvREFCNT_inc()> on the
205return value if you plan to store it anywhere
206semi-permanently (otherwise it might be deleted
207out from under you the next time the cache is
208invalidated).
209
e1a479c5
BB
210=cut
211*/
4befac30 212static AV*
94d1e706 213S_mro_get_linear_isa_dfs(pTHX_ HV *stash, U32 level)
e1a479c5
BB
214{
215 AV* retval;
216 GV** gvp;
217 GV* gv;
218 AV* av;
190d0b22 219 const HEK* stashhek;
e1a479c5 220 struct mro_meta* meta;
a49ba3fc 221 SV *our_name;
73519bd0 222 HV *stored = NULL;
e1a479c5 223
7918f24d 224 PERL_ARGS_ASSERT_MRO_GET_LINEAR_ISA_DFS;
e1a479c5
BB
225 assert(HvAUX(stash));
226
00169e2c 227 stashhek
15d9236d 228 = HvAUX(stash)->xhv_name_u.xhvnameu_name && HvENAME_HEK_NN(stash)
00169e2c
FC
229 ? HvENAME_HEK_NN(stash)
230 : HvNAME_HEK(stash);
231
190d0b22 232 if (!stashhek)
1e05feb3 233 Perl_croak(aTHX_ "Can't linearize anonymous symbol table");
e1a479c5
BB
234
235 if (level > 100)
d0c0e7dd
FC
236 Perl_croak(aTHX_
237 "Recursive inheritance detected in package '%"HEKf"'",
238 HEKfARG(stashhek));
e1a479c5
BB
239
240 meta = HvMROMETA(stash);
1c908217
RGS
241
242 /* return cache if valid */
a3e6e81e 243 if((retval = MUTABLE_AV(MRO_GET_PRIVATE_DATA(meta, &dfs_alg)))) {
e1a479c5
BB
244 return retval;
245 }
246
247 /* not in cache, make a new one */
1c908217 248
ad64d0ec 249 retval = MUTABLE_AV(sv_2mortal(MUTABLE_SV(newAV())));
a49ba3fc
NC
250 /* We use this later in this function, but don't need a reference to it
251 beyond the end of this function, so reference count is fine. */
252 our_name = newSVhek(stashhek);
253 av_push(retval, our_name); /* add ourselves at the top */
e1a479c5 254
1c908217 255 /* fetch our @ISA */
e1a479c5
BB
256 gvp = (GV**)hv_fetchs(stash, "ISA", FALSE);
257 av = (gvp && (gv = *gvp) && isGV_with_GP(gv)) ? GvAV(gv) : NULL;
258
a49ba3fc
NC
259 /* "stored" is used to keep track of all of the classnames we have added to
260 the MRO so far, so we can do a quick exists check and avoid adding
261 duplicate classnames to the MRO as we go.
262 It's then retained to be re-used as a fast lookup for ->isa(), by adding
263 our own name and "UNIVERSAL" to it. */
264
a49ba3fc 265 if(av && AvFILLp(av) >= 0) {
1c908217 266
ffd8da72
NC
267 SV **svp = AvARRAY(av);
268 I32 items = AvFILLp(av) + 1;
1c908217
RGS
269
270 /* foreach(@ISA) */
e1a479c5
BB
271 while (items--) {
272 SV* const sv = *svp++;
273 HV* const basestash = gv_stashsv(sv, 0);
ffd8da72
NC
274 SV *const *subrv_p;
275 I32 subrv_items;
e1a479c5
BB
276
277 if (!basestash) {
1c908217
RGS
278 /* if no stash exists for this @ISA member,
279 simply add it to the MRO and move on */
ffd8da72
NC
280 subrv_p = &sv;
281 subrv_items = 1;
e1a479c5
BB
282 }
283 else {
1c908217 284 /* otherwise, recurse into ourselves for the MRO
b1d0c68a
NC
285 of this @ISA member, and append their MRO to ours.
286 The recursive call could throw an exception, which
287 has memory management implications here, hence the use of
288 the mortal. */
ffd8da72
NC
289 const AV *const subrv
290 = mro_get_linear_isa_dfs(basestash, level + 1);
291
292 subrv_p = AvARRAY(subrv);
293 subrv_items = AvFILLp(subrv) + 1;
294 }
73519bd0
NC
295 if (stored) {
296 while(subrv_items--) {
297 SV *const subsv = *subrv_p++;
298 /* LVALUE fetch will create a new undefined SV if necessary
299 */
300 HE *const he = hv_fetch_ent(stored, subsv, 1, 0);
301 assert(he);
302 if(HeVAL(he) != &PL_sv_undef) {
303 /* It was newly created. Steal it for our new SV, and
304 replace it in the hash with the "real" thing. */
305 SV *const val = HeVAL(he);
306 HEK *const key = HeKEY_hek(he);
307
308 HeVAL(he) = &PL_sv_undef;
309 /* Save copying by making a shared hash key scalar. We
310 inline this here rather than calling
311 Perl_newSVpvn_share because we already have the
312 scalar, and we already have the hash key. */
313 assert(SvTYPE(val) == SVt_NULL);
314 sv_upgrade(val, SVt_PV);
315 SvPV_set(val, HEK_KEY(share_hek_hek(key)));
316 SvCUR_set(val, HEK_LEN(key));
e3918bb7 317 SvIsCOW_on(val);
73519bd0
NC
318 SvPOK_on(val);
319 if (HEK_UTF8(key))
320 SvUTF8_on(val);
321
322 av_push(retval, val);
323 }
ffd8da72 324 }
73519bd0
NC
325 } else {
326 /* We are the first (or only) parent. We can short cut the
327 complexity above, because our @ISA is simply us prepended
328 to our parent's @ISA, and our ->isa cache is simply our
329 parent's, with our name added. */
330 /* newSVsv() is slow. This code is only faster if we can avoid
331 it by ensuring that SVs in the arrays are shared hash key
332 scalar SVs, because we can "copy" them very efficiently.
333 Although to be fair, we can't *ensure* this, as a reference
334 to the internal array is returned by mro::get_linear_isa(),
335 so we'll have to be defensive just in case someone faffed
336 with it. */
337 if (basestash) {
338 SV **svp;
17eef65c 339 stored = MUTABLE_HV(sv_2mortal((SV*)newHVhv(HvMROMETA(basestash)->isa)));
73519bd0
NC
340 av_extend(retval, subrv_items);
341 AvFILLp(retval) = subrv_items;
342 svp = AvARRAY(retval);
343 while(subrv_items--) {
344 SV *const val = *subrv_p++;
345 *++svp = SvIsCOW_shared_hash(val)
346 ? newSVhek(SvSHARED_HEK_FROM_PV(SvPVX(val)))
347 : newSVsv(val);
348 }
349 } else {
350 /* They have no stash. So create ourselves an ->isa cache
351 as if we'd copied it from what theirs should be. */
352 stored = MUTABLE_HV(sv_2mortal(MUTABLE_SV(newHV())));
353 (void) hv_store(stored, "UNIVERSAL", 9, &PL_sv_undef, 0);
354 av_push(retval,
355 newSVhek(HeKEY_hek(hv_store_ent(stored, sv,
356 &PL_sv_undef, 0))));
357 }
358 }
e1a479c5 359 }
73519bd0
NC
360 } else {
361 /* We have no parents. */
362 stored = MUTABLE_HV(sv_2mortal(MUTABLE_SV(newHV())));
363 (void) hv_store(stored, "UNIVERSAL", 9, &PL_sv_undef, 0);
e1a479c5
BB
364 }
365
ed09b296 366 (void) hv_store_ent(stored, our_name, &PL_sv_undef, 0);
ed09b296
NC
367
368 SvREFCNT_inc_simple_void_NN(stored);
369 SvTEMP_off(stored);
370 SvREADONLY_on(stored);
371
372 meta->isa = stored;
373
0fd7ece8
NC
374 /* now that we're past the exception dangers, grab our own reference to
375 the AV we're about to use for the result. The reference owned by the
376 mortals' stack will be released soon, so everything will balance. */
377 SvREFCNT_inc_simple_void_NN(retval);
378 SvTEMP_off(retval);
fdef73f9 379
1c908217
RGS
380 /* we don't want anyone modifying the cache entry but us,
381 and we do so by replacing it completely */
e1a479c5 382 SvREADONLY_on(retval);
1c908217 383
a3e6e81e 384 return MUTABLE_AV(Perl_mro_set_private_data(aTHX_ meta, &dfs_alg,
fa60396f 385 MUTABLE_SV(retval)));
e1a479c5
BB
386}
387
388/*
e1a479c5
BB
389=for apidoc mro_get_linear_isa
390
0b31f535 391Returns the mro linearisation for the given stash. By default, this
006d9e7b
FC
392will be whatever C<mro_get_linear_isa_dfs> returns unless some
393other MRO is in effect for the stash. The return value is a
e1a479c5
BB
394read-only AV*.
395
1c908217
RGS
396You are responsible for C<SvREFCNT_inc()> on the
397return value if you plan to store it anywhere
398semi-permanently (otherwise it might be deleted
399out from under you the next time the cache is
400invalidated).
401
e1a479c5
BB
402=cut
403*/
404AV*
405Perl_mro_get_linear_isa(pTHX_ HV *stash)
406{
407 struct mro_meta* meta;
7311f41d 408 AV *isa;
2c7f4b87 409
7918f24d 410 PERL_ARGS_ASSERT_MRO_GET_LINEAR_ISA;
2c7f4b87
BB
411 if(!SvOOK(stash))
412 Perl_croak(aTHX_ "Can't linearize anonymous symbol table");
e1a479c5
BB
413
414 meta = HvMROMETA(stash);
3d76853f 415 if (!meta->mro_which)
14f97ce6 416 Perl_croak(aTHX_ "panic: invalid MRO!");
7311f41d
FC
417 isa = meta->mro_which->resolve(aTHX_ stash, 0);
418
02cab674
FC
419 if (meta->mro_which != &dfs_alg) { /* skip for dfs, for speed */
420 SV * const namesv =
421 (HvENAME(stash)||HvNAME(stash))
422 ? newSVhek(HvENAME_HEK(stash)
423 ? HvENAME_HEK(stash)
424 : HvNAME_HEK(stash))
425 : NULL;
426
427 if(namesv && (AvFILLp(isa) == -1 || !sv_eq(*AvARRAY(isa), namesv)))
428 {
429 AV * const old = isa;
430 SV **svp;
431 SV **ovp = AvARRAY(old);
432 SV * const * const oend = ovp + AvFILLp(old) + 1;
433 isa = (AV *)sv_2mortal((SV *)newAV());
434 av_extend(isa, AvFILLp(isa) = AvFILLp(old)+1);
435 *AvARRAY(isa) = namesv;
436 svp = AvARRAY(isa)+1;
437 while (ovp < oend) *svp++ = SvREFCNT_inc(*ovp++);
438 }
439 else SvREFCNT_dec(namesv);
440 }
441
7311f41d
FC
442 if (!meta->isa) {
443 HV *const isa_hash = newHV();
444 /* Linearisation didn't build it for us, so do it here. */
445 SV *const *svp = AvARRAY(isa);
446 SV *const *const svp_end = svp + AvFILLp(isa) + 1;
447 const HEK *canon_name = HvENAME_HEK(stash);
448 if (!canon_name) canon_name = HvNAME_HEK(stash);
449
450 while (svp < svp_end) {
451 (void) hv_store_ent(isa_hash, *svp++, &PL_sv_undef, 0);
452 }
453
454 (void) hv_common(isa_hash, NULL, HEK_KEY(canon_name),
455 HEK_LEN(canon_name), HEK_FLAGS(canon_name),
456 HV_FETCH_ISSTORE, &PL_sv_undef,
457 HEK_HASH(canon_name));
458 (void) hv_store(isa_hash, "UNIVERSAL", 9, &PL_sv_undef, 0);
459
460 SvREADONLY_on(isa_hash);
461
462 meta->isa = isa_hash;
463 }
464
465 return isa;
e1a479c5
BB
466}
467
468/*
469=for apidoc mro_isa_changed_in
470
1c908217 471Takes the necessary steps (cache invalidations, mostly)
e1a479c5
BB
472when the @ISA of the given package has changed. Invoked
473by the C<setisa> magic, should not need to invoke directly.
474
475=cut
476*/
f7afb547 477
beeda143 478/* Macro to avoid repeating the code five times. */
f7afb547
FC
479#define CLEAR_LINEAR(mEta) \
480 if (mEta->mro_linear_all) { \
481 SvREFCNT_dec(MUTABLE_SV(mEta->mro_linear_all)); \
482 mEta->mro_linear_all = NULL; \
483 /* This is just acting as a shortcut pointer. */ \
484 mEta->mro_linear_current = NULL; \
485 } else if (mEta->mro_linear_current) { \
486 /* Only the current MRO is stored, so this owns the data. */ \
487 SvREFCNT_dec(mEta->mro_linear_current); \
488 mEta->mro_linear_current = NULL; \
489 }
490
e1a479c5 491void
4df35a07 492Perl_mro_isa_changed_in(pTHX_ HV* stash)
e1a479c5
BB
493{
494 dVAR;
495 HV* isarev;
496 AV* linear_mro;
497 HE* iter;
498 SV** svp;
499 I32 items;
1e05feb3 500 bool is_universal;
4df35a07 501 struct mro_meta * meta;
80ebaca2 502 HV *isa = NULL;
e1a479c5 503
4df35a07
FC
504 const char * const stashname = HvENAME_get(stash);
505 const STRLEN stashname_len = HvENAMELEN_get(stash);
204e6232 506 const bool stashname_utf8 = HvENAMEUTF8(stash) ? 1 : 0;
4df35a07
FC
507
508 PERL_ARGS_ASSERT_MRO_ISA_CHANGED_IN;
7918f24d 509
2c7f4b87
BB
510 if(!stashname)
511 Perl_croak(aTHX_ "Can't call mro_isa_changed_in() on anonymous symbol table");
512
4df35a07
FC
513
514 /* wipe out the cached linearizations for this stash */
515 meta = HvMROMETA(stash);
f7afb547 516 CLEAR_LINEAR(meta);
4df35a07 517 if (meta->isa) {
80ebaca2
FC
518 /* Steal it for our own purposes. */
519 isa = (HV *)sv_2mortal((SV *)meta->isa);
5782d502 520 meta->isa = NULL;
6f86b615 521 }
70cd14a1 522
4df35a07
FC
523 /* Inc the package generation, since our @ISA changed */
524 meta->pkg_gen++;
525
e1a479c5
BB
526 /* Wipe the global method cache if this package
527 is UNIVERSAL or one of its parents */
dd69841b 528
204e6232 529 svp = hv_fetch(PL_isarev, stashname,
c60dbbc3 530 stashname_utf8 ? -(I32)stashname_len : (I32)stashname_len, 0);
85fbaab2 531 isarev = svp ? MUTABLE_HV(*svp) : NULL;
dd69841b
BB
532
533 if((stashname_len == 9 && strEQ(stashname, "UNIVERSAL"))
534 || (isarev && hv_exists(isarev, "UNIVERSAL", 9))) {
e1a479c5 535 PL_sub_generation++;
dd69841b
BB
536 is_universal = TRUE;
537 }
1e05feb3 538 else { /* Wipe the local method cache otherwise */
4df35a07 539 meta->cache_gen++;
1e05feb3
AL
540 is_universal = FALSE;
541 }
e1a479c5
BB
542
543 /* wipe next::method cache too */
4df35a07 544 if(meta->mro_nextmethod) hv_clear(meta->mro_nextmethod);
1e05feb3 545
9cbd5ca3
FC
546 /* Changes to @ISA might turn overloading on */
547 HvAMAGIC_on(stash);
548
8c34e50d
FC
549 /* DESTROY can be cached in SvSTASH. */
550 if (!SvOBJECT(stash)) SvSTASH(stash) = NULL;
551
e1a479c5 552 /* Iterate the isarev (classes that are our children),
80ebaca2
FC
553 wiping out their linearization, method and isa caches
554 and upating PL_isarev. */
dd69841b 555 if(isarev) {
80ebaca2
FC
556 HV *isa_hashes = NULL;
557
558 /* We have to iterate through isarev twice to avoid a chicken and
559 * egg problem: if A inherits from B and both are in isarev, A might
e1fa07e3 560 * be processed before B and use B's previous linearisation.
80ebaca2
FC
561 */
562
563 /* First iteration: Wipe everything, but stash away the isa hashes
564 * since we still need them for updating PL_isarev.
565 */
566
567 if(hv_iterinit(isarev)) {
568 /* Only create the hash if we need it; i.e., if isarev has
569 any elements. */
570 isa_hashes = (HV *)sv_2mortal((SV *)newHV());
571 }
e1a479c5 572 while((iter = hv_iternext(isarev))) {
204e6232 573 HV* revstash = gv_stashsv(hv_iterkeysv(iter), 0);
bc2cbbac
BB
574 struct mro_meta* revmeta;
575
576 if(!revstash) continue;
577 revmeta = HvMROMETA(revstash);
f7afb547 578 CLEAR_LINEAR(revmeta);
dd69841b
BB
579 if(!is_universal)
580 revmeta->cache_gen++;
e1a479c5
BB
581 if(revmeta->mro_nextmethod)
582 hv_clear(revmeta->mro_nextmethod);
c07f9fb2 583 if (!SvOBJECT(revstash)) SvSTASH(revstash) = NULL;
80ebaca2
FC
584
585 (void)
586 hv_store(
587 isa_hashes, (const char*)&revstash, sizeof(HV *),
588 revmeta->isa ? (SV *)revmeta->isa : &PL_sv_undef, 0
589 );
590 revmeta->isa = NULL;
591 }
592
593 /* Second pass: Update PL_isarev. We can just use isa_hashes to
594 * avoid another round of stash lookups. */
595
596 /* isarev might be deleted from PL_isarev during this loop, so hang
597 * on to it. */
598 SvREFCNT_inc_simple_void_NN(sv_2mortal((SV *)isarev));
599
600 if(isa_hashes) {
601 hv_iterinit(isa_hashes);
602 while((iter = hv_iternext(isa_hashes))) {
603 HV* const revstash = *(HV **)HEK_KEY(HeKEY_hek(iter));
604 HV * const isa = (HV *)HeVAL(iter);
605 const HEK *namehek;
606
80ebaca2
FC
607 /* We're starting at the 2nd element, skipping revstash */
608 linear_mro = mro_get_linear_isa(revstash);
609 svp = AvARRAY(linear_mro) + 1;
610 items = AvFILLp(linear_mro);
611
612 namehek = HvENAME_HEK(revstash);
613 if (!namehek) namehek = HvNAME_HEK(revstash);
614
615 while (items--) {
616 SV* const sv = *svp++;
617 HV* mroisarev;
618
619 HE *he = hv_fetch_ent(PL_isarev, sv, TRUE, 0);
620
621 /* That fetch should not fail. But if it had to create
622 a new SV for us, then will need to upgrade it to an
623 HV (which sv_upgrade() can now do for us). */
624
625 mroisarev = MUTABLE_HV(HeVAL(he));
626
627 SvUPGRADE(MUTABLE_SV(mroisarev), SVt_PVHV);
628
629 /* This hash only ever contains PL_sv_yes. Storing it
630 over itself is almost as cheap as calling hv_exists,
631 so on aggregate we expect to save time by not making
632 two calls to the common HV code for the case where
633 it doesn't exist. */
634
635 (void)
636 hv_store(
204e6232
BF
637 mroisarev, HEK_KEY(namehek),
638 HEK_UTF8(namehek) ? -HEK_LEN(namehek) : HEK_LEN(namehek),
80ebaca2
FC
639 &PL_sv_yes, 0
640 );
641 }
642
643 if((SV *)isa != &PL_sv_undef)
644 mro_clean_isarev(
645 isa, HEK_KEY(namehek), HEK_LEN(namehek),
204e6232 646 HvMROMETA(revstash)->isa, (HEK_UTF8(namehek) ? SVf_UTF8 : 0)
80ebaca2
FC
647 );
648 }
e1a479c5
BB
649 }
650 }
651
c9143745
FC
652 /* Now iterate our MRO (parents), adding ourselves and everything from
653 our isarev to their isarev.
1c908217
RGS
654 */
655
656 /* We're starting at the 2nd element, skipping ourselves here */
e1a479c5
BB
657 linear_mro = mro_get_linear_isa(stash);
658 svp = AvARRAY(linear_mro) + 1;
659 items = AvFILLp(linear_mro);
1c908217 660
e1a479c5
BB
661 while (items--) {
662 SV* const sv = *svp++;
e1a479c5
BB
663 HV* mroisarev;
664
117b69ca
NC
665 HE *he = hv_fetch_ent(PL_isarev, sv, TRUE, 0);
666
667 /* That fetch should not fail. But if it had to create a new SV for
4ea50411
NC
668 us, then will need to upgrade it to an HV (which sv_upgrade() can
669 now do for us. */
117b69ca 670
85fbaab2 671 mroisarev = MUTABLE_HV(HeVAL(he));
e1a479c5 672
ad64d0ec 673 SvUPGRADE(MUTABLE_SV(mroisarev), SVt_PVHV);
117b69ca 674
25270bc0
NC
675 /* This hash only ever contains PL_sv_yes. Storing it over itself is
676 almost as cheap as calling hv_exists, so on aggregate we expect to
677 save time by not making two calls to the common HV code for the
678 case where it doesn't exist. */
679
204e6232 680 (void)hv_store(mroisarev, stashname,
c60dbbc3 681 stashname_utf8 ? -(I32)stashname_len : (I32)stashname_len, &PL_sv_yes, 0);
80ebaca2
FC
682 }
683
e1fa07e3 684 /* Delete our name from our former parents' isarevs. */
80ebaca2 685 if(isa && HvARRAY(isa))
204e6232
BF
686 mro_clean_isarev(isa, stashname, stashname_len, meta->isa,
687 (stashname_utf8 ? SVf_UTF8 : 0) );
80ebaca2
FC
688}
689
690/* Deletes name from all the isarev entries listed in isa */
691STATIC void
692S_mro_clean_isarev(pTHX_ HV * const isa, const char * const name,
204e6232 693 const STRLEN len, HV * const exceptions, U32 flags)
80ebaca2
FC
694{
695 HE* iter;
e1a479c5 696
80ebaca2
FC
697 PERL_ARGS_ASSERT_MRO_CLEAN_ISAREV;
698
e1fa07e3 699 /* Delete our name from our former parents' isarevs. */
80ebaca2
FC
700 if(isa && HvARRAY(isa) && hv_iterinit(isa)) {
701 SV **svp;
702 while((iter = hv_iternext(isa))) {
703 I32 klen;
704 const char * const key = hv_iterkey(iter, &klen);
204e6232
BF
705 if(exceptions && hv_exists(exceptions, key, HeKUTF8(iter) ? -klen : klen))
706 continue;
707 svp = hv_fetch(PL_isarev, key, HeKUTF8(iter) ? -klen : klen, 0);
80ebaca2
FC
708 if(svp) {
709 HV * const isarev = (HV *)*svp;
c60dbbc3 710 (void)hv_delete(isarev, name, (flags & SVf_UTF8) ? -(I32)len : (I32)len, G_DISCARD);
1b95d04f 711 if(!HvARRAY(isarev) || !HvUSEDKEYS(isarev))
204e6232
BF
712 (void)hv_delete(PL_isarev, key,
713 HeKUTF8(iter) ? -klen : klen, G_DISCARD);
e1a479c5
BB
714 }
715 }
716 }
717}
718
719/*
c8bbf675
FC
720=for apidoc mro_package_moved
721
d056e33c 722Call this function to signal to a stash that it has been assigned to
61daec80
FC
723another spot in the stash hierarchy. C<stash> is the stash that has been
724assigned. C<oldstash> is the stash it replaces, if any. C<gv> is the glob
afdbe55d 725that is actually being assigned to.
d056e33c 726
35759254 727This can also be called with a null first argument to
d056e33c
FC
728indicate that C<oldstash> has been deleted.
729
730This function invalidates isa caches on the old stash, on all subpackages
731nested inside it, and on the subclasses of all those, including
732non-existent packages that have corresponding entries in C<stash>.
c8bbf675 733
80ebaca2
FC
734It also sets the effective names (C<HvENAME>) on all the stashes as
735appropriate.
736
0290c710 737If the C<gv> is present and is not in the symbol table, then this function
61daec80 738simply returns. This checked will be skipped if C<flags & 1>.
0290c710 739
c8bbf675
FC
740=cut
741*/
742void
35759254 743Perl_mro_package_moved(pTHX_ HV * const stash, HV * const oldstash,
afdbe55d 744 const GV * const gv, U32 flags)
c8bbf675 745{
d7879cf0
FC
746 SV *namesv;
747 HEK **namep;
748 I32 name_count;
80ebaca2
FC
749 HV *stashes;
750 HE* iter;
62c1e33f 751
afdbe55d 752 PERL_ARGS_ASSERT_MRO_PACKAGE_MOVED;
35759254 753 assert(stash || oldstash);
35759254 754
d7879cf0 755 /* Determine the name(s) of the location that stash was assigned to
35759254
FC
756 * or from which oldstash was removed.
757 *
928eb066 758 * We cannot reliably use the name in oldstash, because it may have
35759254
FC
759 * been deleted from the location in the symbol table that its name
760 * suggests, as in this case:
761 *
762 * $globref = \*foo::bar::;
763 * Symbol::delete_package("foo");
764 * *$globref = \%baz::;
765 * *$globref = *frelp::;
766 * # calls mro_package_moved(%frelp::, %baz::, *$globref, NULL, 0)
767 *
d7879cf0
FC
768 * So we get it from the gv. But, since the gv may no longer be in the
769 * symbol table, we check that first. The only reliable way to tell is
770 * to see whether its stash has an effective name and whether the gv
771 * resides in that stash under its name. That effective name may be
772 * different from what gv_fullname4 would use.
773 * If flags & 1, the caller has asked us to skip the check.
35759254 774 */
d7879cf0
FC
775 if(!(flags & 1)) {
776 SV **svp;
777 if(
778 !GvSTASH(gv) || !HvENAME(GvSTASH(gv)) ||
204e6232
BF
779 !(svp = hv_fetch(GvSTASH(gv), GvNAME(gv),
780 GvNAMEUTF8(gv) ? -GvNAMELEN(gv) : GvNAMELEN(gv), 0)) ||
d7879cf0
FC
781 *svp != (SV *)gv
782 ) return;
783 }
784 assert(SvOOK(GvSTASH(gv)));
1f656fcf 785 assert(GvNAMELEN(gv));
d7879cf0 786 assert(GvNAME(gv)[GvNAMELEN(gv) - 1] == ':');
1f656fcf 787 assert(GvNAMELEN(gv) == 1 || GvNAME(gv)[GvNAMELEN(gv) - 2] == ':');
d7879cf0
FC
788 name_count = HvAUX(GvSTASH(gv))->xhv_name_count;
789 if (!name_count) {
790 name_count = 1;
15d9236d 791 namep = &HvAUX(GvSTASH(gv))->xhv_name_u.xhvnameu_name;
d7879cf0
FC
792 }
793 else {
15d9236d 794 namep = HvAUX(GvSTASH(gv))->xhv_name_u.xhvnameu_names;
d7879cf0
FC
795 if (name_count < 0) ++namep, name_count = -name_count - 1;
796 }
797 if (name_count == 1) {
798 if (HEK_LEN(*namep) == 4 && strnEQ(HEK_KEY(*namep), "main", 4)) {
1f656fcf
FC
799 namesv = GvNAMELEN(gv) == 1
800 ? newSVpvs_flags(":", SVs_TEMP)
801 : newSVpvs_flags("", SVs_TEMP);
d7879cf0
FC
802 }
803 else {
804 namesv = sv_2mortal(newSVhek(*namep));
1f656fcf
FC
805 if (GvNAMELEN(gv) == 1) sv_catpvs(namesv, ":");
806 else sv_catpvs(namesv, "::");
d7879cf0 807 }
204e6232 808 if (GvNAMELEN(gv) != 1) {
c682ebef
FC
809 sv_catpvn_flags(
810 namesv, GvNAME(gv), GvNAMELEN(gv) - 2,
d7879cf0 811 /* skip trailing :: */
c682ebef
FC
812 GvNAMEUTF8(gv) ? SV_CATUTF8 : SV_CATBYTES
813 );
204e6232 814 }
d7879cf0
FC
815 }
816 else {
817 SV *aname;
818 namesv = sv_2mortal((SV *)newAV());
819 while (name_count--) {
820 if(HEK_LEN(*namep) == 4 && strnEQ(HEK_KEY(*namep), "main", 4)){
1f656fcf
FC
821 aname = GvNAMELEN(gv) == 1
822 ? newSVpvs(":")
823 : newSVpvs("");
824 namep++;
d7879cf0
FC
825 }
826 else {
827 aname = newSVhek(*namep++);
1f656fcf
FC
828 if (GvNAMELEN(gv) == 1) sv_catpvs(aname, ":");
829 else sv_catpvs(aname, "::");
d7879cf0 830 }
204e6232 831 if (GvNAMELEN(gv) != 1) {
c682ebef
FC
832 sv_catpvn_flags(
833 aname, GvNAME(gv), GvNAMELEN(gv) - 2,
d7879cf0 834 /* skip trailing :: */
c682ebef
FC
835 GvNAMEUTF8(gv) ? SV_CATUTF8 : SV_CATBYTES
836 );
204e6232 837 }
d7879cf0
FC
838 av_push((AV *)namesv, aname);
839 }
840 }
c8bbf675 841
80ebaca2
FC
842 /* Get a list of all the affected classes. */
843 /* We cannot simply pass them all to mro_isa_changed_in to avoid
844 the list, as that function assumes that only one package has
845 changed. It does not work with:
846
847 @foo::ISA = qw( B B::B );
848 *B:: = delete $::{"A::"};
849
850 as neither B nor B::B can be updated before the other, since they
851 will reset caches on foo, which will see either B or B::B with the
852 wrong name. The names must be set on *all* affected stashes before
beeda143 853 we do anything else. (And linearisations must be cleared, too.)
80ebaca2
FC
854 */
855 stashes = (HV *) sv_2mortal((SV *)newHV());
b89cdb22
FC
856 mro_gather_and_rename(
857 stashes, (HV *) sv_2mortal((SV *)newHV()),
d7879cf0 858 stash, oldstash, namesv
b89cdb22 859 );
80ebaca2 860
80ebaca2
FC
861 /* Once the caches have been wiped on all the classes, call
862 mro_isa_changed_in on each. */
863 hv_iterinit(stashes);
864 while((iter = hv_iternext(stashes))) {
90ba1f34
FC
865 HV * const stash = *(HV **)HEK_KEY(HeKEY_hek(iter));
866 if(HvENAME(stash)) {
867 /* We have to restore the original meta->isa (that
868 mro_gather_and_rename set aside for us) this way, in case
869 one class in this list is a superclass of a another class
870 that we have already encountered. In such a case, meta->isa
871 will have been overwritten without old entries being deleted
872 from PL_isarev. */
873 struct mro_meta * const meta = HvMROMETA(stash);
874 if(meta->isa != (HV *)HeVAL(iter)){
875 SvREFCNT_dec(meta->isa);
876 meta->isa
877 = HeVAL(iter) == &PL_sv_yes
878 ? NULL
879 : (HV *)HeVAL(iter);
880 HeVAL(iter) = NULL; /* We donated our reference count. */
881 }
882 mro_isa_changed_in(stash);
883 }
80ebaca2
FC
884 }
885}
886
aeba7c97 887STATIC void
b89cdb22 888S_mro_gather_and_rename(pTHX_ HV * const stashes, HV * const seen_stashes,
d7879cf0 889 HV *stash, HV *oldstash, SV *namesv)
80ebaca2 890{
eb578fdb
KW
891 XPVHV* xhv;
892 HE *entry;
80ebaca2 893 I32 riter = -1;
4c916935 894 I32 items = 0;
80ebaca2 895 const bool stash_had_name = stash && HvENAME(stash);
d7879cf0 896 bool fetched_isarev = FALSE;
80ebaca2
FC
897 HV *seen = NULL;
898 HV *isarev = NULL;
d7879cf0 899 SV **svp = NULL;
80ebaca2
FC
900
901 PERL_ARGS_ASSERT_MRO_GATHER_AND_RENAME;
902
b89cdb22
FC
903 /* We use the seen_stashes hash to keep track of which packages have
904 been encountered so far. This must be separate from the main list of
905 stashes, as we need to distinguish between stashes being assigned
906 and stashes being replaced/deleted. (A nested stash can be on both
907 sides of an assignment. We cannot simply skip iterating through a
908 stash on the right if we have seen it on the left, as it will not
909 get its ename assigned to it.)
910
911 To avoid allocating extra SVs, instead of a bitfield we can make
912 bizarre use of immortals:
913
914 &PL_sv_undef: seen on the left (oldstash)
915 &PL_sv_no : seen on the right (stash)
916 &PL_sv_yes : seen on both sides
917
918 */
919
80ebaca2
FC
920 if(oldstash) {
921 /* Add to the big list. */
90ba1f34 922 struct mro_meta * meta;
80ebaca2
FC
923 HE * const entry
924 = (HE *)
925 hv_common(
b89cdb22 926 seen_stashes, NULL, (const char *)&oldstash, sizeof(HV *), 0,
df5f182b 927 HV_FETCH_LVALUE|HV_FETCH_EMPTY_HE, NULL, 0
80ebaca2 928 );
b89cdb22 929 if(HeVAL(entry) == &PL_sv_undef || HeVAL(entry) == &PL_sv_yes) {
80ebaca2
FC
930 oldstash = NULL;
931 goto check_stash;
932 }
b89cdb22
FC
933 HeVAL(entry)
934 = HeVAL(entry) == &PL_sv_no ? &PL_sv_yes : &PL_sv_undef;
90ba1f34 935 meta = HvMROMETA(oldstash);
b89cdb22
FC
936 (void)
937 hv_store(
938 stashes, (const char *)&oldstash, sizeof(HV *),
90ba1f34
FC
939 meta->isa
940 ? SvREFCNT_inc_simple_NN((SV *)meta->isa)
941 : &PL_sv_yes,
942 0
b89cdb22 943 );
beeda143 944 CLEAR_LINEAR(meta);
80ebaca2
FC
945
946 /* Update the effective name. */
947 if(HvENAME_get(oldstash)) {
d7879cf0
FC
948 const HEK * const enamehek = HvENAME_HEK(oldstash);
949 if(SvTYPE(namesv) == SVt_PVAV) {
950 items = AvFILLp((AV *)namesv) + 1;
951 svp = AvARRAY((AV *)namesv);
952 }
953 else {
954 items = 1;
955 svp = &namesv;
956 }
957 while (items--) {
204e6232 958 const U32 name_utf8 = SvUTF8(*svp);
d7879cf0 959 STRLEN len;
103f5a36
NC
960 const char *name = SvPVx_const(*svp, len);
961 if(PL_stashcache) {
962 DEBUG_o(Perl_deb(aTHX_ "mro_gather_and_rename clearing PL_stashcache for '%"SVf"'\n",
963 *svp));
c60dbbc3 964 (void)hv_delete(PL_stashcache, name, name_utf8 ? -(I32)len : (I32)len, G_DISCARD);
103f5a36
NC
965 }
966 ++svp;
204e6232 967 hv_ename_delete(oldstash, name, len, name_utf8);
d7879cf0
FC
968
969 if (!fetched_isarev) {
970 /* If the name deletion caused a name change, then we
971 * are not going to call mro_isa_changed_in with this
972 * name (and not at all if it has become anonymous) so
973 * we need to delete old isarev entries here, both
e1fa07e3 974 * those in the superclasses and this class's own list
d7879cf0
FC
975 * of subclasses. We simply delete the latter from
976 * PL_isarev, since we still need it. hv_delete morti-
977 * fies it for us, so sv_2mortal is not necessary. */
978 if(HvENAME_HEK(oldstash) != enamehek) {
979 if(meta->isa && HvARRAY(meta->isa))
204e6232
BF
980 mro_clean_isarev(meta->isa, name, len, 0, name_utf8);
981 isarev = (HV *)hv_delete(PL_isarev, name,
c60dbbc3 982 name_utf8 ? -(I32)len : (I32)len, 0);
d7879cf0
FC
983 fetched_isarev=TRUE;
984 }
985 }
986 }
80ebaca2 987 }
d7fbb1de 988 }
80ebaca2 989 check_stash:
8b9e80a3 990 if(stash) {
d7879cf0
FC
991 if(SvTYPE(namesv) == SVt_PVAV) {
992 items = AvFILLp((AV *)namesv) + 1;
993 svp = AvARRAY((AV *)namesv);
994 }
995 else {
996 items = 1;
997 svp = &namesv;
998 }
999 while (items--) {
204e6232 1000 const U32 name_utf8 = SvUTF8(*svp);
d7879cf0
FC
1001 STRLEN len;
1002 const char *name = SvPVx_const(*svp++, len);
204e6232 1003 hv_ename_add(stash, name, len, name_utf8);
d7879cf0 1004 }
80ebaca2 1005
b89cdb22
FC
1006 /* Add it to the big list if it needs
1007 * mro_isa_changed_in called on it. That happens if it was
80ebaca2 1008 * detached from the symbol table (so it had no HvENAME) before
9404893f 1009 * being assigned to the spot named by the 'name' variable, because
486ec47a 1010 * its cached isa linearisation is now stale (the effective name
80ebaca2
FC
1011 * having changed), and subclasses will then use that cache when
1012 * mro_package_moved calls mro_isa_changed_in. (See
8b9e80a3 1013 * [perl #77358].)
80ebaca2 1014 *
8b9e80a3 1015 * If it did have a name, then its previous name is still
80ebaca2
FC
1016 * used in isa caches, and there is no need for
1017 * mro_package_moved to call mro_isa_changed_in.
8b9e80a3 1018 */
80ebaca2
FC
1019
1020 entry
1021 = (HE *)
1022 hv_common(
b89cdb22 1023 seen_stashes, NULL, (const char *)&stash, sizeof(HV *), 0,
df5f182b 1024 HV_FETCH_LVALUE|HV_FETCH_EMPTY_HE, NULL, 0
80ebaca2 1025 );
b89cdb22 1026 if(HeVAL(entry) == &PL_sv_yes || HeVAL(entry) == &PL_sv_no)
80ebaca2 1027 stash = NULL;
b89cdb22
FC
1028 else {
1029 HeVAL(entry)
1030 = HeVAL(entry) == &PL_sv_undef ? &PL_sv_yes : &PL_sv_no;
1031 if(!stash_had_name)
90ba1f34
FC
1032 {
1033 struct mro_meta * const meta = HvMROMETA(stash);
b89cdb22
FC
1034 (void)
1035 hv_store(
1036 stashes, (const char *)&stash, sizeof(HV *),
90ba1f34
FC
1037 meta->isa
1038 ? SvREFCNT_inc_simple_NN((SV *)meta->isa)
1039 : &PL_sv_yes,
1040 0
b89cdb22 1041 );
beeda143 1042 CLEAR_LINEAR(meta);
90ba1f34 1043 }
b89cdb22 1044 }
8b9e80a3 1045 }
d7fbb1de 1046
80ebaca2
FC
1047 if(!stash && !oldstash)
1048 /* Both stashes have been encountered already. */
1049 return;
1050
1051 /* Add all the subclasses to the big list. */
d7879cf0
FC
1052 if(!fetched_isarev) {
1053 /* If oldstash is not null, then we can use its HvENAME to look up
1054 the isarev hash, since all its subclasses will be listed there.
06f3ce86
FC
1055 It will always have an HvENAME. It the HvENAME was removed
1056 above, then fetch_isarev will be true, and this code will not be
1057 reached.
1058
1059 If oldstash is null, then this is an empty spot with no stash in
1060 it, so subclasses could be listed in isarev hashes belonging to
1061 any of the names, so we have to check all of them.
1062 */
e0aa2606 1063 assert(!oldstash || HvENAME(oldstash));
06f3ce86
FC
1064 if (oldstash) {
1065 /* Extra variable to avoid a compiler warning */
1066 char * const hvename = HvENAME(oldstash);
d7879cf0 1067 fetched_isarev = TRUE;
204e6232
BF
1068 svp = hv_fetch(PL_isarev, hvename,
1069 HvENAMEUTF8(oldstash)
1070 ? -HvENAMELEN_get(oldstash)
1071 : HvENAMELEN_get(oldstash), 0);
d7879cf0
FC
1072 if (svp) isarev = MUTABLE_HV(*svp);
1073 }
1074 else if(SvTYPE(namesv) == SVt_PVAV) {
1075 items = AvFILLp((AV *)namesv) + 1;
1076 svp = AvARRAY((AV *)namesv);
1077 }
1078 else {
1079 items = 1;
1080 svp = &namesv;
1081 }
1082 }
80ebaca2 1083 if(
d7879cf0 1084 isarev || !fetched_isarev
80ebaca2 1085 ) {
d7879cf0 1086 while (fetched_isarev || items--) {
80ebaca2 1087 HE *iter;
d7879cf0
FC
1088
1089 if (!fetched_isarev) {
1090 HE * const he = hv_fetch_ent(PL_isarev, *svp++, 0, 0);
1091 if (!he || !(isarev = MUTABLE_HV(HeVAL(he)))) continue;
1092 }
1093
80ebaca2
FC
1094 hv_iterinit(isarev);
1095 while((iter = hv_iternext(isarev))) {
204e6232 1096 HV* revstash = gv_stashsv(hv_iterkeysv(iter), 0);
90ba1f34 1097 struct mro_meta * meta;
80ebaca2
FC
1098
1099 if(!revstash) continue;
90ba1f34 1100 meta = HvMROMETA(revstash);
b89cdb22
FC
1101 (void)
1102 hv_store(
1103 stashes, (const char *)&revstash, sizeof(HV *),
90ba1f34
FC
1104 meta->isa
1105 ? SvREFCNT_inc_simple_NN((SV *)meta->isa)
1106 : &PL_sv_yes,
1107 0
b89cdb22 1108 );
beeda143 1109 CLEAR_LINEAR(meta);
80ebaca2 1110 }
d7879cf0
FC
1111
1112 if (fetched_isarev) break;
1113 }
80ebaca2 1114 }
d056e33c 1115
c8bbf675
FC
1116 /* This is partly based on code in hv_iternext_flags. We are not call-
1117 ing that here, as we want to avoid resetting the hash iterator. */
1118
d056e33c
FC
1119 /* Skip the entire loop if the hash is empty. */
1120 if(oldstash && HvUSEDKEYS(oldstash)) {
1121 xhv = (XPVHV*)SvANY(oldstash);
dbe2fffc 1122 seen = (HV *) sv_2mortal((SV *)newHV());
d056e33c 1123
80ebaca2
FC
1124 /* Iterate through entries in the oldstash, adding them to the
1125 list, meanwhile doing the equivalent of $seen{$key} = 1.
d056e33c
FC
1126 */
1127
1128 while (++riter <= (I32)xhv->xhv_max) {
1129 entry = (HvARRAY(oldstash))[riter];
1130
1131 /* Iterate through the entries in this list */
1132 for(; entry; entry = HeNEXT(entry)) {
1133 const char* key;
090c3c37 1134 I32 len;
d056e33c
FC
1135
1136 /* If this entry is not a glob, ignore it.
1137 Try the next. */
1138 if (!isGV(HeVAL(entry))) continue;
1139
090c3c37 1140 key = hv_iterkey(entry, &len);
1f656fcf
FC
1141 if ((len > 1 && key[len-2] == ':' && key[len-1] == ':')
1142 || (len == 1 && key[0] == ':')) {
d056e33c
FC
1143 HV * const oldsubstash = GvHV(HeVAL(entry));
1144 SV ** const stashentry
090c3c37 1145 = stash ? hv_fetch(stash, key, HeUTF8(entry) ? -(I32)len : (I32)len, 0) : NULL;
35759254 1146 HV *substash = NULL;
62c1e33f
FC
1147
1148 /* Avoid main::main::main::... */
1149 if(oldsubstash == oldstash) continue;
1150
d056e33c 1151 if(
35759254
FC
1152 (
1153 stashentry && *stashentry
1154 && (substash = GvHV(*stashentry))
1155 )
00169e2c 1156 || (oldsubstash && HvENAME_get(oldsubstash))
d056e33c 1157 )
35759254
FC
1158 {
1159 /* Add :: and the key (minus the trailing ::)
d7879cf0
FC
1160 to each name. */
1161 SV *subname;
1162 if(SvTYPE(namesv) == SVt_PVAV) {
1163 SV *aname;
1164 items = AvFILLp((AV *)namesv) + 1;
1165 svp = AvARRAY((AV *)namesv);
1166 subname = sv_2mortal((SV *)newAV());
1167 while (items--) {
1168 aname = newSVsv(*svp++);
1f656fcf
FC
1169 if (len == 1)
1170 sv_catpvs(aname, ":");
1171 else {
1172 sv_catpvs(aname, "::");
c682ebef
FC
1173 sv_catpvn_flags(
1174 aname, key, len-2,
090c3c37 1175 HeUTF8(entry)
c682ebef
FC
1176 ? SV_CATUTF8 : SV_CATBYTES
1177 );
1f656fcf 1178 }
d7879cf0
FC
1179 av_push((AV *)subname, aname);
1180 }
80ebaca2 1181 }
d7879cf0
FC
1182 else {
1183 subname = sv_2mortal(newSVsv(namesv));
1f656fcf
FC
1184 if (len == 1) sv_catpvs(subname, ":");
1185 else {
1186 sv_catpvs(subname, "::");
c682ebef
FC
1187 sv_catpvn_flags(
1188 subname, key, len-2,
090c3c37 1189 HeUTF8(entry) ? SV_CATUTF8 : SV_CATBYTES
c682ebef 1190 );
1f656fcf 1191 }
d7879cf0
FC
1192 }
1193 mro_gather_and_rename(
1194 stashes, seen_stashes,
1195 substash, oldsubstash, subname
1196 );
35759254 1197 }
d056e33c 1198
090c3c37 1199 (void)hv_store(seen, key, HeUTF8(entry) ? -(I32)len : (I32)len, &PL_sv_yes, 0);
d056e33c
FC
1200 }
1201 }
1202 }
1203 }
c8bbf675
FC
1204
1205 /* Skip the entire loop if the hash is empty. */
d056e33c
FC
1206 if (stash && HvUSEDKEYS(stash)) {
1207 xhv = (XPVHV*)SvANY(stash);
b89cdb22 1208 riter = -1;
d056e33c
FC
1209
1210 /* Iterate through the new stash, skipping $seen{$key} items,
b89cdb22 1211 calling mro_gather_and_rename(stashes,seen,entry,NULL, ...). */
c8bbf675
FC
1212 while (++riter <= (I32)xhv->xhv_max) {
1213 entry = (HvARRAY(stash))[riter];
1214
1215 /* Iterate through the entries in this list */
1216 for(; entry; entry = HeNEXT(entry)) {
1217 const char* key;
090c3c37 1218 I32 len;
c8bbf675
FC
1219
1220 /* If this entry is not a glob, ignore it.
1221 Try the next. */
1222 if (!isGV(HeVAL(entry))) continue;
1223
090c3c37 1224 key = hv_iterkey(entry, &len);
1f656fcf
FC
1225 if ((len > 1 && key[len-2] == ':' && key[len-1] == ':')
1226 || (len == 1 && key[0] == ':')) {
d056e33c
FC
1227 HV *substash;
1228
1229 /* If this entry was seen when we iterated through the
1230 oldstash, skip it. */
090c3c37 1231 if(seen && hv_exists(seen, key, HeUTF8(entry) ? -(I32)len : (I32)len)) continue;
d056e33c
FC
1232
1233 /* We get here only if this stash has no corresponding
1234 entry in the stash being replaced. */
1235
1236 substash = GvHV(HeVAL(entry));
35759254 1237 if(substash) {
d7879cf0 1238 SV *subname;
62c1e33f
FC
1239
1240 /* Avoid checking main::main::main::... */
1241 if(substash == stash) continue;
1242
d056e33c 1243 /* Add :: and the key (minus the trailing ::)
d7879cf0
FC
1244 to each name. */
1245 if(SvTYPE(namesv) == SVt_PVAV) {
1246 SV *aname;
1247 items = AvFILLp((AV *)namesv) + 1;
1248 svp = AvARRAY((AV *)namesv);
1249 subname = sv_2mortal((SV *)newAV());
1250 while (items--) {
1251 aname = newSVsv(*svp++);
1f656fcf
FC
1252 if (len == 1)
1253 sv_catpvs(aname, ":");
1254 else {
1255 sv_catpvs(aname, "::");
c682ebef
FC
1256 sv_catpvn_flags(
1257 aname, key, len-2,
090c3c37 1258 HeUTF8(entry)
c682ebef
FC
1259 ? SV_CATUTF8 : SV_CATBYTES
1260 );
1f656fcf 1261 }
d7879cf0
FC
1262 av_push((AV *)subname, aname);
1263 }
1264 }
1265 else {
1266 subname = sv_2mortal(newSVsv(namesv));
1f656fcf
FC
1267 if (len == 1) sv_catpvs(subname, ":");
1268 else {
1269 sv_catpvs(subname, "::");
c682ebef
FC
1270 sv_catpvn_flags(
1271 subname, key, len-2,
090c3c37 1272 HeUTF8(entry) ? SV_CATUTF8 : SV_CATBYTES
c682ebef 1273 );
1f656fcf 1274 }
d7879cf0 1275 }
80ebaca2 1276 mro_gather_and_rename(
b89cdb22 1277 stashes, seen_stashes,
d7879cf0 1278 substash, NULL, subname
d056e33c
FC
1279 );
1280 }
c8bbf675
FC
1281 }
1282 }
1283 }
1284 }
1285}
1286
1287/*
e1a479c5
BB
1288=for apidoc mro_method_changed_in
1289
47c9dd14
BB
1290Invalidates method caching on any child classes
1291of the given stash, so that they might notice
1292the changes in this one.
e1a479c5
BB
1293
1294Ideally, all instances of C<PL_sub_generation++> in
25d585df 1295perl source outside of F<mro.c> should be
dd69841b
BB
1296replaced by calls to this.
1297
1298Perl automatically handles most of the common
1299ways a method might be redefined. However, there
1300are a few ways you could change a method in a stash
1301without the cache code noticing, in which case you
1302need to call this method afterwards:
e1a479c5 1303
dd69841b
BB
13041) Directly manipulating the stash HV entries from
1305XS code.
e1a479c5 1306
dd69841b
BB
13072) Assigning a reference to a readonly scalar
1308constant into a stash entry in order to create
1309a constant subroutine (like constant.pm
1310does).
1311
1312This same method is available from pure perl
1313via, C<mro::method_changed_in(classname)>.
e1a479c5
BB
1314
1315=cut
1316*/
1317void
1318Perl_mro_method_changed_in(pTHX_ HV *stash)
1319{
00169e2c
FC
1320 const char * const stashname = HvENAME_get(stash);
1321 const STRLEN stashname_len = HvENAMELEN_get(stash);
204e6232 1322 const bool stashname_utf8 = HvENAMEUTF8(stash) ? 1 : 0;
dd69841b 1323
204e6232 1324 SV ** const svp = hv_fetch(PL_isarev, stashname,
c60dbbc3 1325 stashname_utf8 ? -(I32)stashname_len : (I32)stashname_len, 0);
85fbaab2 1326 HV * const isarev = svp ? MUTABLE_HV(*svp) : NULL;
e1a479c5 1327
7918f24d
NC
1328 PERL_ARGS_ASSERT_MRO_METHOD_CHANGED_IN;
1329
2c7f4b87
BB
1330 if(!stashname)
1331 Perl_croak(aTHX_ "Can't call mro_method_changed_in() on anonymous symbol table");
1332
70cd14a1
CB
1333 /* Inc the package generation, since a local method changed */
1334 HvMROMETA(stash)->pkg_gen++;
1335
8c34e50d
FC
1336 /* DESTROY can be cached in SvSTASH. */
1337 if (!SvOBJECT(stash)) SvSTASH(stash) = NULL;
1338
e1a479c5
BB
1339 /* If stash is UNIVERSAL, or one of UNIVERSAL's parents,
1340 invalidate all method caches globally */
dd69841b
BB
1341 if((stashname_len == 9 && strEQ(stashname, "UNIVERSAL"))
1342 || (isarev && hv_exists(isarev, "UNIVERSAL", 9))) {
e1a479c5
BB
1343 PL_sub_generation++;
1344 return;
1345 }
1346
1347 /* else, invalidate the method caches of all child classes,
1348 but not itself */
dd69841b 1349 if(isarev) {
1e05feb3
AL
1350 HE* iter;
1351
e1a479c5
BB
1352 hv_iterinit(isarev);
1353 while((iter = hv_iternext(isarev))) {
204e6232 1354 HV* const revstash = gv_stashsv(hv_iterkeysv(iter), 0);
bc2cbbac
BB
1355 struct mro_meta* mrometa;
1356
1357 if(!revstash) continue;
1358 mrometa = HvMROMETA(revstash);
dd69841b 1359 mrometa->cache_gen++;
e1a479c5
BB
1360 if(mrometa->mro_nextmethod)
1361 hv_clear(mrometa->mro_nextmethod);
c07f9fb2 1362 if (!SvOBJECT(revstash)) SvSTASH(revstash) = NULL;
e1a479c5
BB
1363 }
1364 }
234df27b
FC
1365
1366 /* The method change may be due to *{$package . "::()"} = \&nil; in
1367 overload.pm. */
1368 HvAMAGIC_on(stash);
e1a479c5
BB
1369}
1370
31b9005d
NC
1371void
1372Perl_mro_set_mro(pTHX_ struct mro_meta *const meta, SV *const name)
1373{
1374 const struct mro_alg *const which = Perl_mro_get_from_name(aTHX_ name);
1375
1376 PERL_ARGS_ASSERT_MRO_SET_MRO;
1377
1378 if (!which)
1379 Perl_croak(aTHX_ "Invalid mro name: '%"SVf"'", name);
1380
1381 if(meta->mro_which != which) {
9953ff72 1382 if (meta->mro_linear_current && !meta->mro_linear_all) {
31b9005d
NC
1383 /* If we were storing something directly, put it in the hash before
1384 we lose it. */
1385 Perl_mro_set_private_data(aTHX_ meta, meta->mro_which,
3a6fa573 1386 MUTABLE_SV(meta->mro_linear_current));
31b9005d
NC
1387 }
1388 meta->mro_which = which;
1389 /* Scrub our cached pointer to the private data. */
3a6fa573 1390 meta->mro_linear_current = NULL;
31b9005d
NC
1391 /* Only affects local method cache, not
1392 even child classes */
1393 meta->cache_gen++;
1394 if(meta->mro_nextmethod)
1395 hv_clear(meta->mro_nextmethod);
1396 }
1397}
1398
e1a479c5
BB
1399#include "XSUB.h"
1400
e1a479c5 1401XS(XS_mro_method_changed_in);
e1a479c5
BB
1402
1403void
1404Perl_boot_core_mro(pTHX)
1405{
1406 dVAR;
1407 static const char file[] = __FILE__;
1408
a3e6e81e 1409 Perl_mro_register(aTHX_ &dfs_alg);
a3e6e81e 1410
e1a479c5 1411 newXSproto("mro::method_changed_in", XS_mro_method_changed_in, file, "$");
e1a479c5
BB
1412}
1413
e1a479c5
BB
1414XS(XS_mro_method_changed_in)
1415{
1416 dVAR;
1417 dXSARGS;
1418 SV* classname;
1419 HV* class_stash;
1420
e1a479c5 1421 if(items != 1)
afa74d42 1422 croak_xs_usage(cv, "classname");
e1a479c5
BB
1423
1424 classname = ST(0);
1425
1426 class_stash = gv_stashsv(classname, 0);
1427 if(!class_stash) Perl_croak(aTHX_ "No such class: '%"SVf"'!", SVfARG(classname));
1428
1429 mro_method_changed_in(class_stash);
1430
1431 XSRETURN_EMPTY;
1432}
1433
e1a479c5
BB
1434/*
1435 * Local variables:
1436 * c-indentation-style: bsd
1437 * c-basic-offset: 4
14d04a33 1438 * indent-tabs-mode: nil
e1a479c5
BB
1439 * End:
1440 *
14d04a33 1441 * ex: set ts=8 sts=4 sw=4 et:
e1a479c5 1442 */