This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
9fd15dee64aa955209796e6145a41a33f539cd90
[perl5.git] / mro.c
1 /*    mro.c
2  *
3  *    Copyright (c) 2007 Brandon L Black
4  *    Copyright (c) 2007, 2008 Larry Wall and others
5  *
6  *    You may distribute under the terms of either the GNU General Public
7  *    License or the Artistic License, as specified in the README file.
8  *
9  */
10
11 /*
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"]
16  */
17
18 /*
19 =head1 MRO Functions
20
21 These functions are related to the method resolution order of perl classes
22
23 =cut
24 */
25
26 #include "EXTERN.h"
27 #define PERL_IN_MRO_C
28 #include "perl.h"
29
30 static const struct mro_alg dfs_alg =
31     {S_mro_get_linear_isa_dfs, "dfs", 3, 0, 0};
32
33 SV *
34 Perl_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
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);
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)
49         smeta->mro_linear_current = *data;
50
51     return *data;
52 }
53
54 SV *
55 Perl_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
60     if (!smeta->mro_linear_all) {
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.  */
65             smeta->mro_linear_current = data;
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;      
71             smeta->mro_linear_all = hv;
72
73             if (smeta->mro_linear_current) {
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, 
77                                           smeta->mro_linear_current);
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.  */
88         smeta->mro_linear_current = data;
89     }
90
91     if (!Perl_hv_common(aTHX_ smeta->mro_linear_all, NULL,
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
102 const struct mro_alg *
103 Perl_mro_get_from_name(pTHX_ SV *name) {
104     SV **data;
105
106     PERL_ARGS_ASSERT_MRO_GET_FROM_NAME;
107
108     data = (SV **)Perl_hv_common(aTHX_ PL_registered_mros, name, NULL, 0, 0,
109                                  HV_FETCH_JUST_SV, NULL, 0);
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
117 void
118 Perl_mro_register(pTHX_ const struct mro_alg *mro) {
119     SV *wrapper = newSVuv(PTR2UV(mro));
120
121     PERL_ARGS_ASSERT_MRO_REGISTER;
122
123     
124     if (!Perl_hv_common(aTHX_ PL_registered_mros, NULL,
125                         mro->name, mro->length, mro->kflags,
126                         HV_FETCH_ISSTORE, wrapper, mro->hash)) {
127         SvREFCNT_dec(wrapper);
128         Perl_croak(aTHX_ "panic: hv_store() failed in mro_register() "
129                    "for '%.*s' %d", (int) mro->length, mro->name, mro->kflags);
130     }
131 }
132
133 struct mro_meta*
134 Perl_mro_meta_init(pTHX_ HV* stash)
135 {
136     struct mro_meta* newmeta;
137
138     PERL_ARGS_ASSERT_MRO_META_INIT;
139     assert(HvAUX(stash));
140     assert(!(HvAUX(stash)->xhv_mro_meta));
141     Newxz(newmeta, 1, struct mro_meta);
142     HvAUX(stash)->xhv_mro_meta = newmeta;
143     newmeta->cache_gen = 1;
144     newmeta->pkg_gen = 1;
145     newmeta->mro_which = &dfs_alg;
146
147     return newmeta;
148 }
149
150 #if defined(USE_ITHREADS)
151
152 /* for sv_dup on new threads */
153 struct mro_meta*
154 Perl_mro_meta_dup(pTHX_ struct mro_meta* smeta, CLONE_PARAMS* param)
155 {
156     struct mro_meta* newmeta;
157
158     PERL_ARGS_ASSERT_MRO_META_DUP;
159
160     Newx(newmeta, 1, struct mro_meta);
161     Copy(smeta, newmeta, 1, struct mro_meta);
162
163     if (newmeta->mro_linear_all) {
164         newmeta->mro_linear_all
165             = MUTABLE_HV(sv_dup_inc((const SV *)newmeta->mro_linear_all, param));
166         /* This is just acting as a shortcut pointer, and will be automatically
167            updated on the first get.  */
168         newmeta->mro_linear_current = NULL;
169     } else if (newmeta->mro_linear_current) {
170         /* Only the current MRO is stored, so this owns the data.  */
171         newmeta->mro_linear_current
172             = sv_dup_inc((const SV *)newmeta->mro_linear_current, param);
173     }
174
175     if (newmeta->mro_nextmethod)
176         newmeta->mro_nextmethod
177             = MUTABLE_HV(sv_dup_inc((const SV *)newmeta->mro_nextmethod, param));
178     if (newmeta->isa)
179         newmeta->isa
180             = MUTABLE_HV(sv_dup_inc((const SV *)newmeta->isa, param));
181
182     return newmeta;
183 }
184
185 #endif /* USE_ITHREADS */
186
187 /*
188 =for apidoc mro_get_linear_isa_dfs
189
190 Returns the Depth-First Search linearization of @ISA
191 the given stash.  The return value is a read-only AV*.
192 C<level> should be 0 (it is used internally in this
193 function's recursion).
194
195 You are responsible for C<SvREFCNT_inc()> on the
196 return value if you plan to store it anywhere
197 semi-permanently (otherwise it might be deleted
198 out from under you the next time the cache is
199 invalidated).
200
201 =cut
202 */
203 static AV*
204 S_mro_get_linear_isa_dfs(pTHX_ HV *stash, U32 level)
205 {
206     AV* retval;
207     GV** gvp;
208     GV* gv;
209     AV* av;
210     const HEK* stashhek;
211     struct mro_meta* meta;
212     SV *our_name;
213     HV *stored = NULL;
214
215     PERL_ARGS_ASSERT_MRO_GET_LINEAR_ISA_DFS;
216     assert(HvAUX(stash));
217
218     stashhek
219      = HvAUX(stash)->xhv_name && HvENAME_HEK_NN(stash)
220         ? HvENAME_HEK_NN(stash)
221         : HvNAME_HEK(stash);
222
223     if (!stashhek)
224       Perl_croak(aTHX_ "Can't linearize anonymous symbol table");
225
226     if (level > 100)
227         Perl_croak(aTHX_ "Recursive inheritance detected in package '%s'",
228                    HEK_KEY(stashhek));
229
230     meta = HvMROMETA(stash);
231
232     /* return cache if valid */
233     if((retval = MUTABLE_AV(MRO_GET_PRIVATE_DATA(meta, &dfs_alg)))) {
234         return retval;
235     }
236
237     /* not in cache, make a new one */
238
239     retval = MUTABLE_AV(sv_2mortal(MUTABLE_SV(newAV())));
240     /* We use this later in this function, but don't need a reference to it
241        beyond the end of this function, so reference count is fine.  */
242     our_name = newSVhek(stashhek);
243     av_push(retval, our_name); /* add ourselves at the top */
244
245     /* fetch our @ISA */
246     gvp = (GV**)hv_fetchs(stash, "ISA", FALSE);
247     av = (gvp && (gv = *gvp) && isGV_with_GP(gv)) ? GvAV(gv) : NULL;
248
249     /* "stored" is used to keep track of all of the classnames we have added to
250        the MRO so far, so we can do a quick exists check and avoid adding
251        duplicate classnames to the MRO as we go.
252        It's then retained to be re-used as a fast lookup for ->isa(), by adding
253        our own name and "UNIVERSAL" to it.  */
254
255     if(av && AvFILLp(av) >= 0) {
256
257         SV **svp = AvARRAY(av);
258         I32 items = AvFILLp(av) + 1;
259
260         /* foreach(@ISA) */
261         while (items--) {
262             SV* const sv = *svp++;
263             HV* const basestash = gv_stashsv(sv, 0);
264             SV *const *subrv_p;
265             I32 subrv_items;
266
267             if (!basestash) {
268                 /* if no stash exists for this @ISA member,
269                    simply add it to the MRO and move on */
270                 subrv_p = &sv;
271                 subrv_items = 1;
272             }
273             else {
274                 /* otherwise, recurse into ourselves for the MRO
275                    of this @ISA member, and append their MRO to ours.
276                    The recursive call could throw an exception, which
277                    has memory management implications here, hence the use of
278                    the mortal.  */
279                 const AV *const subrv
280                     = mro_get_linear_isa_dfs(basestash, level + 1);
281
282                 subrv_p = AvARRAY(subrv);
283                 subrv_items = AvFILLp(subrv) + 1;
284             }
285             if (stored) {
286                 while(subrv_items--) {
287                     SV *const subsv = *subrv_p++;
288                     /* LVALUE fetch will create a new undefined SV if necessary
289                      */
290                     HE *const he = hv_fetch_ent(stored, subsv, 1, 0);
291                     assert(he);
292                     if(HeVAL(he) != &PL_sv_undef) {
293                         /* It was newly created.  Steal it for our new SV, and
294                            replace it in the hash with the "real" thing.  */
295                         SV *const val = HeVAL(he);
296                         HEK *const key = HeKEY_hek(he);
297
298                         HeVAL(he) = &PL_sv_undef;
299                         /* Save copying by making a shared hash key scalar. We
300                            inline this here rather than calling
301                            Perl_newSVpvn_share because we already have the
302                            scalar, and we already have the hash key.  */
303                         assert(SvTYPE(val) == SVt_NULL);
304                         sv_upgrade(val, SVt_PV);
305                         SvPV_set(val, HEK_KEY(share_hek_hek(key)));
306                         SvCUR_set(val, HEK_LEN(key));
307                         SvREADONLY_on(val);
308                         SvFAKE_on(val);
309                         SvPOK_on(val);
310                         if (HEK_UTF8(key))
311                             SvUTF8_on(val);
312
313                         av_push(retval, val);
314                     }
315                 }
316             } else {
317                 /* We are the first (or only) parent. We can short cut the
318                    complexity above, because our @ISA is simply us prepended
319                    to our parent's @ISA, and our ->isa cache is simply our
320                    parent's, with our name added.  */
321                 /* newSVsv() is slow. This code is only faster if we can avoid
322                    it by ensuring that SVs in the arrays are shared hash key
323                    scalar SVs, because we can "copy" them very efficiently.
324                    Although to be fair, we can't *ensure* this, as a reference
325                    to the internal array is returned by mro::get_linear_isa(),
326                    so we'll have to be defensive just in case someone faffed
327                    with it.  */
328                 if (basestash) {
329                     SV **svp;
330                     stored = MUTABLE_HV(sv_2mortal((SV*)newHVhv(HvMROMETA(basestash)->isa)));
331                     av_extend(retval, subrv_items);
332                     AvFILLp(retval) = subrv_items;
333                     svp = AvARRAY(retval);
334                     while(subrv_items--) {
335                         SV *const val = *subrv_p++;
336                         *++svp = SvIsCOW_shared_hash(val)
337                             ? newSVhek(SvSHARED_HEK_FROM_PV(SvPVX(val)))
338                             : newSVsv(val);
339                     }
340                 } else {
341                     /* They have no stash.  So create ourselves an ->isa cache
342                        as if we'd copied it from what theirs should be.  */
343                     stored = MUTABLE_HV(sv_2mortal(MUTABLE_SV(newHV())));
344                     (void) hv_store(stored, "UNIVERSAL", 9, &PL_sv_undef, 0);
345                     av_push(retval,
346                             newSVhek(HeKEY_hek(hv_store_ent(stored, sv,
347                                                             &PL_sv_undef, 0))));
348                 }
349             }
350         }
351     } else {
352         /* We have no parents.  */
353         stored = MUTABLE_HV(sv_2mortal(MUTABLE_SV(newHV())));
354         (void) hv_store(stored, "UNIVERSAL", 9, &PL_sv_undef, 0);
355     }
356
357     (void) hv_store_ent(stored, our_name, &PL_sv_undef, 0);
358
359     SvREFCNT_inc_simple_void_NN(stored);
360     SvTEMP_off(stored);
361     SvREADONLY_on(stored);
362
363     meta->isa = stored;
364
365     /* now that we're past the exception dangers, grab our own reference to
366        the AV we're about to use for the result. The reference owned by the
367        mortals' stack will be released soon, so everything will balance.  */
368     SvREFCNT_inc_simple_void_NN(retval);
369     SvTEMP_off(retval);
370
371     /* we don't want anyone modifying the cache entry but us,
372        and we do so by replacing it completely */
373     SvREADONLY_on(retval);
374
375     return MUTABLE_AV(Perl_mro_set_private_data(aTHX_ meta, &dfs_alg,
376                                                 MUTABLE_SV(retval)));
377 }
378
379 /*
380 =for apidoc mro_get_linear_isa
381
382 Returns either C<mro_get_linear_isa_c3> or
383 C<mro_get_linear_isa_dfs> for the given stash,
384 dependant upon which MRO is in effect
385 for that stash.  The return value is a
386 read-only AV*.
387
388 You are responsible for C<SvREFCNT_inc()> on the
389 return value if you plan to store it anywhere
390 semi-permanently (otherwise it might be deleted
391 out from under you the next time the cache is
392 invalidated).
393
394 =cut
395 */
396 AV*
397 Perl_mro_get_linear_isa(pTHX_ HV *stash)
398 {
399     struct mro_meta* meta;
400     AV *isa;
401
402     PERL_ARGS_ASSERT_MRO_GET_LINEAR_ISA;
403     if(!SvOOK(stash))
404         Perl_croak(aTHX_ "Can't linearize anonymous symbol table");
405
406     meta = HvMROMETA(stash);
407     if (!meta->mro_which)
408         Perl_croak(aTHX_ "panic: invalid MRO!");
409     isa = meta->mro_which->resolve(aTHX_ stash, 0);
410
411     if (!meta->isa) {
412             HV *const isa_hash = newHV();
413             /* Linearisation didn't build it for us, so do it here.  */
414             SV *const *svp = AvARRAY(isa);
415             SV *const *const svp_end = svp + AvFILLp(isa) + 1;
416             const HEK *canon_name = HvENAME_HEK(stash);
417             if (!canon_name) canon_name = HvNAME_HEK(stash);
418
419             while (svp < svp_end) {
420                 (void) hv_store_ent(isa_hash, *svp++, &PL_sv_undef, 0);
421             }
422
423             (void) hv_common(isa_hash, NULL, HEK_KEY(canon_name),
424                              HEK_LEN(canon_name), HEK_FLAGS(canon_name),
425                              HV_FETCH_ISSTORE, &PL_sv_undef,
426                              HEK_HASH(canon_name));
427             (void) hv_store(isa_hash, "UNIVERSAL", 9, &PL_sv_undef, 0);
428
429             SvREADONLY_on(isa_hash);
430
431             meta->isa = isa_hash;
432     }
433
434     return isa;
435 }
436
437 /*
438 =for apidoc mro_isa_changed_in
439
440 Takes the necessary steps (cache invalidations, mostly)
441 when the @ISA of the given package has changed.  Invoked
442 by the C<setisa> magic, should not need to invoke directly.
443
444 =cut
445 */
446
447 /* Macro to avoid repeating the code five times. */
448 #define CLEAR_LINEAR(mEta)                                     \
449     if (mEta->mro_linear_all) {                                 \
450         SvREFCNT_dec(MUTABLE_SV(mEta->mro_linear_all));          \
451         mEta->mro_linear_all = NULL;                              \
452         /* This is just acting as a shortcut pointer.  */          \
453         mEta->mro_linear_current = NULL;                            \
454     } else if (mEta->mro_linear_current) {                           \
455         /* Only the current MRO is stored, so this owns the data.  */ \
456         SvREFCNT_dec(mEta->mro_linear_current);                        \
457         mEta->mro_linear_current = NULL;                                \
458     }
459
460 void
461 Perl_mro_isa_changed_in(pTHX_ HV* stash)
462 {
463     dVAR;
464     HV* isarev;
465     AV* linear_mro;
466     HE* iter;
467     SV** svp;
468     I32 items;
469     bool is_universal;
470     struct mro_meta * meta;
471     HV *isa = NULL;
472
473     const char * const stashname = HvENAME_get(stash);
474     const STRLEN stashname_len = HvENAMELEN_get(stash);
475
476     PERL_ARGS_ASSERT_MRO_ISA_CHANGED_IN;
477
478     if(!stashname)
479         Perl_croak(aTHX_ "Can't call mro_isa_changed_in() on anonymous symbol table");
480
481
482     /* wipe out the cached linearizations for this stash */
483     meta = HvMROMETA(stash);
484     CLEAR_LINEAR(meta);
485     if (meta->isa) {
486         /* Steal it for our own purposes. */
487         isa = (HV *)sv_2mortal((SV *)meta->isa);
488         meta->isa = NULL;
489     }
490
491     /* Inc the package generation, since our @ISA changed */
492     meta->pkg_gen++;
493
494     /* Wipe the global method cache if this package
495        is UNIVERSAL or one of its parents */
496
497     svp = hv_fetch(PL_isarev, stashname, stashname_len, 0);
498     isarev = svp ? MUTABLE_HV(*svp) : NULL;
499
500     if((stashname_len == 9 && strEQ(stashname, "UNIVERSAL"))
501         || (isarev && hv_exists(isarev, "UNIVERSAL", 9))) {
502         PL_sub_generation++;
503         is_universal = TRUE;
504     }
505     else { /* Wipe the local method cache otherwise */
506         meta->cache_gen++;
507         is_universal = FALSE;
508     }
509
510     /* wipe next::method cache too */
511     if(meta->mro_nextmethod) hv_clear(meta->mro_nextmethod);
512
513     /* Iterate the isarev (classes that are our children),
514        wiping out their linearization, method and isa caches
515        and upating PL_isarev. */
516     if(isarev) {
517         HV *isa_hashes = NULL;
518
519        /* We have to iterate through isarev twice to avoid a chicken and
520         * egg problem: if A inherits from B and both are in isarev, A might
521         * be processed before B and use B’s previous linearisation.
522         */
523
524        /* First iteration: Wipe everything, but stash away the isa hashes
525         * since we still need them for updating PL_isarev.
526         */
527
528         if(hv_iterinit(isarev)) {
529             /* Only create the hash if we need it; i.e., if isarev has
530                any elements. */
531             isa_hashes = (HV *)sv_2mortal((SV *)newHV());
532         }
533         while((iter = hv_iternext(isarev))) {
534             I32 len;
535             const char* const revkey = hv_iterkey(iter, &len);
536             HV* revstash = gv_stashpvn(revkey, len, 0);
537             struct mro_meta* revmeta;
538
539             if(!revstash) continue;
540             revmeta = HvMROMETA(revstash);
541             CLEAR_LINEAR(revmeta);
542             if(!is_universal)
543                 revmeta->cache_gen++;
544             if(revmeta->mro_nextmethod)
545                 hv_clear(revmeta->mro_nextmethod);
546
547             (void)
548               hv_store(
549                isa_hashes, (const char*)&revstash, sizeof(HV *),
550                revmeta->isa ? (SV *)revmeta->isa : &PL_sv_undef, 0
551               );
552             revmeta->isa = NULL;
553         }
554
555        /* Second pass: Update PL_isarev. We can just use isa_hashes to
556         * avoid another round of stash lookups. */
557
558        /* isarev might be deleted from PL_isarev during this loop, so hang
559         * on to it. */
560         SvREFCNT_inc_simple_void_NN(sv_2mortal((SV *)isarev));
561
562         if(isa_hashes) {
563             hv_iterinit(isa_hashes);
564             while((iter = hv_iternext(isa_hashes))) {
565                 HV* const revstash = *(HV **)HEK_KEY(HeKEY_hek(iter));
566                 HV * const isa = (HV *)HeVAL(iter);
567                 const HEK *namehek;
568
569                 /* We're starting at the 2nd element, skipping revstash */
570                 linear_mro = mro_get_linear_isa(revstash);
571                 svp = AvARRAY(linear_mro) + 1;
572                 items = AvFILLp(linear_mro);
573
574                 namehek = HvENAME_HEK(revstash);
575                 if (!namehek) namehek = HvNAME_HEK(revstash);
576
577                 while (items--) {
578                     SV* const sv = *svp++;
579                     HV* mroisarev;
580
581                     HE *he = hv_fetch_ent(PL_isarev, sv, TRUE, 0);
582
583                     /* That fetch should not fail.  But if it had to create
584                        a new SV for us, then will need to upgrade it to an
585                        HV (which sv_upgrade() can now do for us). */
586
587                     mroisarev = MUTABLE_HV(HeVAL(he));
588
589                     SvUPGRADE(MUTABLE_SV(mroisarev), SVt_PVHV);
590
591                     /* This hash only ever contains PL_sv_yes. Storing it
592                        over itself is almost as cheap as calling hv_exists,
593                        so on aggregate we expect to save time by not making
594                        two calls to the common HV code for the case where
595                        it doesn't exist.  */
596            
597                     (void)
598                       hv_store(
599                        mroisarev, HEK_KEY(namehek), HEK_LEN(namehek),
600                        &PL_sv_yes, 0
601                       );
602                 }
603
604                 if((SV *)isa != &PL_sv_undef)
605                     mro_clean_isarev(
606                      isa, HEK_KEY(namehek), HEK_LEN(namehek),
607                      HvMROMETA(revstash)->isa
608                     );
609             }
610         }
611     }
612
613     /* Now iterate our MRO (parents), adding ourselves and everything from
614        our isarev to their isarev.
615     */
616
617     /* We're starting at the 2nd element, skipping ourselves here */
618     linear_mro = mro_get_linear_isa(stash);
619     svp = AvARRAY(linear_mro) + 1;
620     items = AvFILLp(linear_mro);
621
622     while (items--) {
623         SV* const sv = *svp++;
624         HV* mroisarev;
625
626         HE *he = hv_fetch_ent(PL_isarev, sv, TRUE, 0);
627
628         /* That fetch should not fail.  But if it had to create a new SV for
629            us, then will need to upgrade it to an HV (which sv_upgrade() can
630            now do for us. */
631
632         mroisarev = MUTABLE_HV(HeVAL(he));
633
634         SvUPGRADE(MUTABLE_SV(mroisarev), SVt_PVHV);
635
636         /* This hash only ever contains PL_sv_yes. Storing it over itself is
637            almost as cheap as calling hv_exists, so on aggregate we expect to
638            save time by not making two calls to the common HV code for the
639            case where it doesn't exist.  */
640            
641         (void)hv_store(mroisarev, stashname, stashname_len, &PL_sv_yes, 0);
642     }
643
644     /* Delete our name from our former parents’ isarevs. */
645     if(isa && HvARRAY(isa))
646         mro_clean_isarev(isa, stashname, stashname_len, meta->isa);
647 }
648
649 /* Deletes name from all the isarev entries listed in isa */
650 STATIC void
651 S_mro_clean_isarev(pTHX_ HV * const isa, const char * const name,
652                          const STRLEN len, HV * const exceptions)
653 {
654     HE* iter;
655
656     PERL_ARGS_ASSERT_MRO_CLEAN_ISAREV;
657
658     /* Delete our name from our former parents’ isarevs. */
659     if(isa && HvARRAY(isa) && hv_iterinit(isa)) {
660         SV **svp;
661         while((iter = hv_iternext(isa))) {
662             I32 klen;
663             const char * const key = hv_iterkey(iter, &klen);
664             if(exceptions && hv_exists(exceptions, key, klen)) continue;
665             svp = hv_fetch(PL_isarev, key, klen, 0);
666             if(svp) {
667                 HV * const isarev = (HV *)*svp;
668                 (void)hv_delete(isarev, name, len, G_DISCARD);
669                 if(!HvARRAY(isarev) || !HvKEYS(isarev))
670                     (void)hv_delete(PL_isarev, key, klen, G_DISCARD);
671             }
672         }
673     }
674 }
675
676 /*
677 =for apidoc mro_package_moved
678
679 Call this function to signal to a stash that it has been assigned to
680 another spot in the stash hierarchy. C<stash> is the stash that has been
681 assigned. C<oldstash> is the stash it replaces, if any. C<gv> is the glob
682 that is actually being assigned to.
683
684 This can also be called with a null first argument to
685 indicate that C<oldstash> has been deleted.
686
687 This function invalidates isa caches on the old stash, on all subpackages
688 nested inside it, and on the subclasses of all those, including
689 non-existent packages that have corresponding entries in C<stash>.
690
691 It also sets the effective names (C<HvENAME>) on all the stashes as
692 appropriate.
693
694 If the C<gv> is present and is not in the symbol table, then this function
695 simply returns. This checked will be skipped if C<flags & 1>.
696
697 =cut
698 */
699 void
700 Perl_mro_package_moved(pTHX_ HV * const stash, HV * const oldstash,
701                        const GV * const gv, U32 flags)
702 {
703     SV * const namesv = sv_newmortal();
704     const char * newname;
705     STRLEN newname_len;
706     HV *stashes;
707     HE* iter;
708
709     PERL_ARGS_ASSERT_MRO_PACKAGE_MOVED;
710     assert(stash || oldstash);
711
712     /* Determine the name of the location that stash was assigned to
713      * or from which oldstash was removed.
714      *
715      * We cannot reliably use the name in oldstash, because it may have
716      * been deleted from the location in the symbol table that its name
717      * suggests, as in this case:
718      *
719      *   $globref = \*foo::bar::;
720      *   Symbol::delete_package("foo");
721      *   *$globref = \%baz::;
722      *   *$globref = *frelp::;
723      *      # calls mro_package_moved(%frelp::, %baz::, *$globref, NULL, 0)
724      *
725      * So we get it from the gv. But if the gv is not
726      * in the symbol table, then we just return. We skip that check,
727      * however, if flags & 1.
728      */
729     gv_fullname4(namesv, gv, NULL, 0);
730     if( !(flags & 1)
731          && gv_fetchsv(namesv, GV_NOADD_NOINIT, SVt_PVGV) != gv ) return;
732     newname = SvPV_const(namesv, newname_len);
733     newname_len -= 2; /* skip trailing :: */
734
735     /* Get a list of all the affected classes. */
736     /* We cannot simply pass them all to mro_isa_changed_in to avoid
737        the list, as that function assumes that only one package has
738        changed. It does not work with:
739
740           @foo::ISA = qw( B B::B );
741           *B:: = delete $::{"A::"};
742
743        as neither B nor B::B can be updated before the other, since they
744        will reset caches on foo, which will see either B or B::B with the
745        wrong name. The names must be set on *all* affected stashes before
746        we do anything else. (And linearisations must be cleared, too.)
747      */
748     stashes = (HV *) sv_2mortal((SV *)newHV());
749     mro_gather_and_rename(
750      stashes, (HV *) sv_2mortal((SV *)newHV()),
751      stash, oldstash, newname, newname_len
752     );
753
754     /* Once the caches have been wiped on all the classes, call
755        mro_isa_changed_in on each. */
756     hv_iterinit(stashes);
757     while((iter = hv_iternext(stashes))) {
758         HV * const stash = *(HV **)HEK_KEY(HeKEY_hek(iter));
759         if(HvENAME(stash)) {
760             /* We have to restore the original meta->isa (that
761                mro_gather_and_rename set aside for us) this way, in case
762                one class in this list is a superclass of a another class
763                that we have already encountered. In such a case, meta->isa
764                will have been overwritten without old entries being deleted 
765                from PL_isarev. */
766             struct mro_meta * const meta = HvMROMETA(stash);
767             if(meta->isa != (HV *)HeVAL(iter)){
768                 SvREFCNT_dec(meta->isa);
769                 meta->isa
770                  = HeVAL(iter) == &PL_sv_yes
771                     ? NULL
772                     : (HV *)HeVAL(iter);
773                 HeVAL(iter) = NULL; /* We donated our reference count. */
774             }
775             mro_isa_changed_in(stash);
776         }
777     }
778 }
779
780 void
781 S_mro_gather_and_rename(pTHX_ HV * const stashes, HV * const seen_stashes,
782                               HV *stash, HV *oldstash, const char *name,
783                               I32 namlen)
784 {
785     register XPVHV* xhv;
786     register HE *entry;
787     I32 riter = -1;
788     const bool stash_had_name = stash && HvENAME(stash);
789     HV *seen = NULL;
790     HV *isarev = NULL;
791     SV **svp;
792
793     PERL_ARGS_ASSERT_MRO_GATHER_AND_RENAME;
794
795     /* We use the seen_stashes hash to keep track of which packages have
796        been encountered so far. This must be separate from the main list of
797        stashes, as we need to distinguish between stashes being assigned
798        and stashes being replaced/deleted. (A nested stash can be on both
799        sides of an assignment. We cannot simply skip iterating through a
800        stash on the right if we have seen it on the left, as it will not
801        get its ename assigned to it.)
802
803        To avoid allocating extra SVs, instead of a bitfield we can make
804        bizarre use of immortals:
805
806         &PL_sv_undef:  seen on the left  (oldstash)
807         &PL_sv_no   :  seen on the right (stash)
808         &PL_sv_yes  :  seen on both sides
809
810      */
811
812     if(oldstash) {
813         /* Add to the big list. */
814         struct mro_meta * meta;
815         HE * const entry
816          = (HE *)
817              hv_common(
818               seen_stashes, NULL, (const char *)&oldstash, sizeof(HV *), 0,
819               HV_FETCH_LVALUE|HV_FETCH_EMPTY_HE, NULL, 0
820              );
821         if(HeVAL(entry) == &PL_sv_undef || HeVAL(entry) == &PL_sv_yes) {
822             oldstash = NULL;
823             goto check_stash;
824         }
825         HeVAL(entry)
826          = HeVAL(entry) == &PL_sv_no ? &PL_sv_yes : &PL_sv_undef;
827         meta = HvMROMETA(oldstash);
828         (void)
829           hv_store(
830            stashes, (const char *)&oldstash, sizeof(HV *),
831            meta->isa
832             ? SvREFCNT_inc_simple_NN((SV *)meta->isa)
833             : &PL_sv_yes,
834            0
835           );
836         CLEAR_LINEAR(meta);
837
838         /* Update the effective name. */
839         if(HvENAME_get(oldstash)) {
840           const HEK * const enamehek = HvENAME_HEK(oldstash);
841           if(PL_stashcache)
842             (void)
843              hv_delete(PL_stashcache, name, namlen, G_DISCARD);
844           hv_ename_delete(oldstash, name, namlen, 0);
845
846          /* If the name deletion caused a name change, then we are not
847           * going to call mro_isa_changed_in with this name (and not at all
848           * if it has become anonymous) so we need to delete old isarev
849           * entries here, both those in the superclasses and this class’s
850           * own list of subclasses. We simply delete the latter from
851           * from PL_isarev, since we still need it. hv_delete mortifies it
852           * for us, so sv_2mortal is not necessary. */
853           if(HvENAME_HEK(oldstash) != enamehek) {
854             if(meta->isa && HvARRAY(meta->isa))
855                 mro_clean_isarev(meta->isa, name, namlen, NULL);
856             isarev = (HV *)hv_delete(PL_isarev, name, namlen, 0);
857           }
858         }
859     }
860    check_stash:
861     if(stash) {
862         hv_ename_add(stash, name, namlen, 0);
863
864        /* Add it to the big list if it needs
865         * mro_isa_changed_in called on it. That happens if it was
866         * detached from the symbol table (so it had no HvENAME) before
867         * being assigned to the spot named by the ‘name’ variable, because
868         * its cached isa linerisation is now stale (the effective name
869         * having changed), and subclasses will then use that cache when
870         * mro_package_moved calls mro_isa_changed_in. (See
871         * [perl #77358].)
872         *
873         * If it did have a name, then its previous name is still
874         * used in isa caches, and there is no need for
875         * mro_package_moved to call mro_isa_changed_in.
876         */
877
878         entry
879          = (HE *)
880              hv_common(
881               seen_stashes, NULL, (const char *)&stash, sizeof(HV *), 0,
882               HV_FETCH_LVALUE|HV_FETCH_EMPTY_HE, NULL, 0
883              );
884         if(HeVAL(entry) == &PL_sv_yes || HeVAL(entry) == &PL_sv_no)
885             stash = NULL;
886         else {
887             HeVAL(entry)
888              = HeVAL(entry) == &PL_sv_undef ? &PL_sv_yes : &PL_sv_no;
889             if(!stash_had_name)
890             {
891                 struct mro_meta * const meta = HvMROMETA(stash);
892                 (void)
893                   hv_store(
894                    stashes, (const char *)&stash, sizeof(HV *),
895                    meta->isa
896                     ? SvREFCNT_inc_simple_NN((SV *)meta->isa)
897                     : &PL_sv_yes,
898                    0
899                   );
900                 CLEAR_LINEAR(meta);
901             }
902         }
903     }
904
905     if(!stash && !oldstash)
906         /* Both stashes have been encountered already. */
907         return;
908
909     /* Add all the subclasses to the big list. */
910     if(
911         isarev
912      || (
913            (svp = hv_fetch(PL_isarev, name, namlen, 0))
914         && (isarev = MUTABLE_HV(*svp))
915         )
916     ) {
917         HE *iter;
918         hv_iterinit(isarev);
919         while((iter = hv_iternext(isarev))) {
920             I32 len;
921             const char* const revkey = hv_iterkey(iter, &len);
922             HV* revstash = gv_stashpvn(revkey, len, 0);
923             struct mro_meta * meta;
924
925             if(!revstash) continue;
926             meta = HvMROMETA(revstash);
927             (void)
928               hv_store(
929                stashes, (const char *)&revstash, sizeof(HV *),
930                meta->isa
931                 ? SvREFCNT_inc_simple_NN((SV *)meta->isa)
932                 : &PL_sv_yes,
933                0
934               );
935             CLEAR_LINEAR(meta);
936         }
937     }
938
939     if(
940      (!stash || !HvARRAY(stash)) && (!oldstash || !HvARRAY(oldstash))
941     ) return;
942
943     /* This is partly based on code in hv_iternext_flags. We are not call-
944        ing that here, as we want to avoid resetting the hash iterator. */
945
946     /* Skip the entire loop if the hash is empty.   */
947     if(oldstash && HvUSEDKEYS(oldstash)) { 
948         xhv = (XPVHV*)SvANY(oldstash);
949         seen = (HV *) sv_2mortal((SV *)newHV());
950
951         /* Iterate through entries in the oldstash, adding them to the
952            list, meanwhile doing the equivalent of $seen{$key} = 1.
953          */
954
955         while (++riter <= (I32)xhv->xhv_max) {
956             entry = (HvARRAY(oldstash))[riter];
957
958             /* Iterate through the entries in this list */
959             for(; entry; entry = HeNEXT(entry)) {
960                 const char* key;
961                 I32 len;
962
963                 /* If this entry is not a glob, ignore it.
964                    Try the next.  */
965                 if (!isGV(HeVAL(entry))) continue;
966
967                 key = hv_iterkey(entry, &len);
968                 if(len > 1 && key[len-2] == ':' && key[len-1] == ':') {
969                     HV * const oldsubstash = GvHV(HeVAL(entry));
970                     SV ** const stashentry
971                      = stash ? hv_fetch(stash, key, len, 0) : NULL;
972                     HV *substash = NULL;
973
974                     /* Avoid main::main::main::... */
975                     if(oldsubstash == oldstash) continue;
976
977                     if(
978                         (
979                             stashentry && *stashentry
980                          && (substash = GvHV(*stashentry))
981                         )
982                      || (oldsubstash && HvENAME_get(oldsubstash))
983                     )
984                     {
985                         /* Add :: and the key (minus the trailing ::)
986                            to newname. */
987                         SV *namesv
988                          = newSVpvn_flags(name, namlen, SVs_TEMP);
989                         {
990                             const char *name;
991                             STRLEN namlen;
992                             sv_catpvs(namesv, "::");
993                             sv_catpvn(namesv, key, len-2);
994                             name = SvPV_const(namesv, namlen);
995                             mro_gather_and_rename(
996                              stashes, seen_stashes,
997                              substash, oldsubstash, name, namlen
998                             );
999                         }
1000                     }
1001
1002                     (void)hv_store(seen, key, len, &PL_sv_yes, 0);
1003                 }
1004             }
1005         }
1006     }
1007
1008     /* Skip the entire loop if the hash is empty.   */
1009     if (stash && HvUSEDKEYS(stash)) {
1010         xhv = (XPVHV*)SvANY(stash);
1011         riter = -1;
1012
1013         /* Iterate through the new stash, skipping $seen{$key} items,
1014            calling mro_gather_and_rename(stashes,seen,entry,NULL, ...). */
1015         while (++riter <= (I32)xhv->xhv_max) {
1016             entry = (HvARRAY(stash))[riter];
1017
1018             /* Iterate through the entries in this list */
1019             for(; entry; entry = HeNEXT(entry)) {
1020                 const char* key;
1021                 I32 len;
1022
1023                 /* If this entry is not a glob, ignore it.
1024                    Try the next.  */
1025                 if (!isGV(HeVAL(entry))) continue;
1026
1027                 key = hv_iterkey(entry, &len);
1028                 if(len > 1 && key[len-2] == ':' && key[len-1] == ':') {
1029                     HV *substash;
1030
1031                     /* If this entry was seen when we iterated through the
1032                        oldstash, skip it. */
1033                     if(seen && hv_exists(seen, key, len)) continue;
1034
1035                     /* We get here only if this stash has no corresponding
1036                        entry in the stash being replaced. */
1037
1038                     substash = GvHV(HeVAL(entry));
1039                     if(substash) {
1040                         SV *namesv;
1041                         const char *subname;
1042                         STRLEN subnamlen;
1043
1044                         /* Avoid checking main::main::main::... */
1045                         if(substash == stash) continue;
1046
1047                         /* Add :: and the key (minus the trailing ::)
1048                            to newname. */
1049                         namesv
1050                          = newSVpvn_flags(name, namlen, SVs_TEMP);
1051                         sv_catpvs(namesv, "::");
1052                         sv_catpvn(namesv, key, len-2);
1053                         subname = SvPV_const(namesv, subnamlen);
1054                         mro_gather_and_rename(
1055                           stashes, seen_stashes,
1056                           substash, NULL, subname, subnamlen
1057                         );
1058                     }
1059                 }
1060             }
1061         }
1062     }
1063 }
1064
1065 /*
1066 =for apidoc mro_method_changed_in
1067
1068 Invalidates method caching on any child classes
1069 of the given stash, so that they might notice
1070 the changes in this one.
1071
1072 Ideally, all instances of C<PL_sub_generation++> in
1073 perl source outside of C<mro.c> should be
1074 replaced by calls to this.
1075
1076 Perl automatically handles most of the common
1077 ways a method might be redefined.  However, there
1078 are a few ways you could change a method in a stash
1079 without the cache code noticing, in which case you
1080 need to call this method afterwards:
1081
1082 1) Directly manipulating the stash HV entries from
1083 XS code.
1084
1085 2) Assigning a reference to a readonly scalar
1086 constant into a stash entry in order to create
1087 a constant subroutine (like constant.pm
1088 does).
1089
1090 This same method is available from pure perl
1091 via, C<mro::method_changed_in(classname)>.
1092
1093 =cut
1094 */
1095 void
1096 Perl_mro_method_changed_in(pTHX_ HV *stash)
1097 {
1098     const char * const stashname = HvENAME_get(stash);
1099     const STRLEN stashname_len = HvENAMELEN_get(stash);
1100
1101     SV ** const svp = hv_fetch(PL_isarev, stashname, stashname_len, 0);
1102     HV * const isarev = svp ? MUTABLE_HV(*svp) : NULL;
1103
1104     PERL_ARGS_ASSERT_MRO_METHOD_CHANGED_IN;
1105
1106     if(!stashname)
1107         Perl_croak(aTHX_ "Can't call mro_method_changed_in() on anonymous symbol table");
1108
1109     /* Inc the package generation, since a local method changed */
1110     HvMROMETA(stash)->pkg_gen++;
1111
1112     /* If stash is UNIVERSAL, or one of UNIVERSAL's parents,
1113        invalidate all method caches globally */
1114     if((stashname_len == 9 && strEQ(stashname, "UNIVERSAL"))
1115         || (isarev && hv_exists(isarev, "UNIVERSAL", 9))) {
1116         PL_sub_generation++;
1117         return;
1118     }
1119
1120     /* else, invalidate the method caches of all child classes,
1121        but not itself */
1122     if(isarev) {
1123         HE* iter;
1124
1125         hv_iterinit(isarev);
1126         while((iter = hv_iternext(isarev))) {
1127             I32 len;
1128             const char* const revkey = hv_iterkey(iter, &len);
1129             HV* const revstash = gv_stashpvn(revkey, len, 0);
1130             struct mro_meta* mrometa;
1131
1132             if(!revstash) continue;
1133             mrometa = HvMROMETA(revstash);
1134             mrometa->cache_gen++;
1135             if(mrometa->mro_nextmethod)
1136                 hv_clear(mrometa->mro_nextmethod);
1137         }
1138     }
1139 }
1140
1141 void
1142 Perl_mro_set_mro(pTHX_ struct mro_meta *const meta, SV *const name)
1143 {
1144     const struct mro_alg *const which = Perl_mro_get_from_name(aTHX_ name);
1145  
1146     PERL_ARGS_ASSERT_MRO_SET_MRO;
1147
1148     if (!which)
1149         Perl_croak(aTHX_ "Invalid mro name: '%"SVf"'", name);
1150
1151     if(meta->mro_which != which) {
1152         if (meta->mro_linear_current && !meta->mro_linear_all) {
1153             /* If we were storing something directly, put it in the hash before
1154                we lose it. */
1155             Perl_mro_set_private_data(aTHX_ meta, meta->mro_which, 
1156                                       MUTABLE_SV(meta->mro_linear_current));
1157         }
1158         meta->mro_which = which;
1159         /* Scrub our cached pointer to the private data.  */
1160         meta->mro_linear_current = NULL;
1161         /* Only affects local method cache, not
1162            even child classes */
1163         meta->cache_gen++;
1164         if(meta->mro_nextmethod)
1165             hv_clear(meta->mro_nextmethod);
1166     }
1167 }
1168
1169 #include "XSUB.h"
1170
1171 XS(XS_mro_method_changed_in);
1172
1173 void
1174 Perl_boot_core_mro(pTHX)
1175 {
1176     dVAR;
1177     static const char file[] = __FILE__;
1178
1179     Perl_mro_register(aTHX_ &dfs_alg);
1180
1181     newXSproto("mro::method_changed_in", XS_mro_method_changed_in, file, "$");
1182 }
1183
1184 XS(XS_mro_method_changed_in)
1185 {
1186     dVAR;
1187     dXSARGS;
1188     SV* classname;
1189     HV* class_stash;
1190
1191     if(items != 1)
1192         croak_xs_usage(cv, "classname");
1193     
1194     classname = ST(0);
1195
1196     class_stash = gv_stashsv(classname, 0);
1197     if(!class_stash) Perl_croak(aTHX_ "No such class: '%"SVf"'!", SVfARG(classname));
1198
1199     mro_method_changed_in(class_stash);
1200
1201     XSRETURN_EMPTY;
1202 }
1203
1204 /*
1205  * Local variables:
1206  * c-indentation-style: bsd
1207  * c-basic-offset: 4
1208  * indent-tabs-mode: t
1209  * End:
1210  *
1211  * ex: set ts=8 sts=4 sw=4 noet:
1212  */