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