File | /usr/local/lib/perl5/5.8.8/AutoLoader.pm |
Statements Executed | 189 |
Statement Execution Time | 5.91ms |
Calls | P | F | Exclusive Time |
Inclusive Time |
Subroutine |
---|---|---|---|---|---|
3 | 3 | 3 | 1.16ms | 1.40ms | import | AutoLoader::
5 | 2 | 2 | 185µs | 185µs | CORE:regcomp (opcode) | AutoLoader::
12 | 5 | 2 | 132µs | 132µs | CORE:subst (opcode) | AutoLoader::
2 | 1 | 2 | 75µs | 75µs | CORE:fteread (opcode) | AutoLoader::
10 | 2 | 2 | 66µs | 66µs | CORE:substcont (opcode) | AutoLoader::
2 | 1 | 2 | 42µs | 42µs | CORE:match (opcode) | AutoLoader::
1 | 1 | 1 | 16µs | 16µs | __ANON__[:96] | AutoLoader::
0 | 0 | 0 | 0s | 0s | AUTOLOAD | AutoLoader::
0 | 0 | 0 | 0s | 0s | BEGIN | AutoLoader::
0 | 0 | 0 | 0s | 0s | unimport | AutoLoader::
Line | State ments |
Time on line |
Calls | Time in subs |
Code |
---|---|---|---|---|---|
1 | package AutoLoader; | ||||
2 | |||||
3 | 3 | 92µs | 1 | 27µs | use strict; # spent 27µs making 1 call to strict::import |
4 | 3 | 193µs | use 5.006_001; | ||
5 | |||||
6 | 1 | 5µs | our($VERSION, $AUTOLOAD); | ||
7 | |||||
8 | 1 | 5µs | my $is_dosish; | ||
9 | 1 | 4µs | my $is_epoc; | ||
10 | 1 | 5µs | my $is_vms; | ||
11 | 1 | 4µs | my $is_macos; | ||
12 | |||||
13 | BEGIN { | ||||
14 | 1 | 11µs | $is_dosish = $^O eq 'dos' || $^O eq 'os2' || $^O eq 'MSWin32' || $^O eq 'NetWare'; | ||
15 | 1 | 5µs | $is_epoc = $^O eq 'epoc'; | ||
16 | 1 | 5µs | $is_vms = $^O eq 'VMS'; | ||
17 | 1 | 5µs | $is_macos = $^O eq 'MacOS'; | ||
18 | 1 | 6µs | $VERSION = '5.60'; | ||
19 | 1 | 713µs | } | ||
20 | |||||
21 | AUTOLOAD { | ||||
22 | 2 | 13µs | my $sub = $AUTOLOAD; | ||
23 | 2 | 8µs | my $filename; | ||
24 | # Braces used to preserve $1 et al. | ||||
25 | { | ||||
26 | # Try to find the autoloaded file from the package-qualified | ||||
27 | # name of the sub. e.g., if the sub needed is | ||||
28 | # Getopt::Long::GetOptions(), then $INC{Getopt/Long.pm} is | ||||
29 | # something like '/usr/lib/perl5/Getopt/Long.pm', and the | ||||
30 | # autoload file is '/usr/lib/perl5/auto/Getopt/Long/GetOptions.al'. | ||||
31 | # | ||||
32 | # However, if @INC is a relative path, this might not work. If, | ||||
33 | # for example, @INC = ('lib'), then $INC{Getopt/Long.pm} is | ||||
34 | # 'lib/Getopt/Long.pm', and we want to require | ||||
35 | # 'auto/Getopt/Long/GetOptions.al' (without the leading 'lib'). | ||||
36 | # In this case, we simple prepend the 'auto/' and let the | ||||
37 | # C<require> take care of the searching for us. | ||||
38 | |||||
39 | 4 | 106µs | 2 | 42µs | my ($pkg,$func) = ($sub =~ /(.*)::([^:]+)$/); # spent 42µs making 2 calls to AutoLoader::CORE:match, avg 21µs/call |
40 | 2 | 45µs | 2 | 15µs | $pkg =~ s#::#/#g; # spent 15µs making 2 calls to AutoLoader::CORE:subst, avg 8µs/call |
41 | 2 | 28µs | if (defined($filename = $INC{"$pkg.pm"})) { | ||
42 | 2 | 19µs | if ($is_macos) { | ||
43 | $pkg =~ tr#/#:#; | ||||
44 | $filename =~ s#^(.*)$pkg\.pm\z#$1auto:$pkg:$func.al#s; | ||||
45 | } else { | ||||
46 | 2 | 220µs | 8 | 108µs | $filename =~ s#^(.*)$pkg\.pm\z#$1auto/$pkg/$func.al#s; # spent 62µs making 2 calls to AutoLoader::CORE:regcomp, avg 31µs/call
# spent 28µs making 4 calls to AutoLoader::CORE:substcont, avg 7µs/call
# spent 18µs making 2 calls to AutoLoader::CORE:subst, avg 9µs/call |
47 | } | ||||
48 | |||||
49 | # if the file exists, then make sure that it is a | ||||
50 | # a fully anchored path (i.e either '/usr/lib/auto/foo/bar.al', | ||||
51 | # or './lib/auto/foo/bar.al'. This avoids C<require> searching | ||||
52 | # (and failing) to find the 'lib/auto/foo/bar.al' because it | ||||
53 | # looked for 'lib/lib/auto/foo/bar.al', given @INC = ('lib'). | ||||
54 | |||||
55 | 2 | 132µs | 2 | 75µs | if (-r $filename) { # spent 75µs making 2 calls to AutoLoader::CORE:fteread, avg 38µs/call |
56 | unless ($filename =~ m|^/|s) { | ||||
57 | if ($is_dosish) { | ||||
58 | unless ($filename =~ m{^([a-z]:)?[\\/]}is) { | ||||
59 | if ($^O ne 'NetWare') { | ||||
60 | $filename = "./$filename"; | ||||
61 | } else { | ||||
62 | $filename = "$filename"; | ||||
63 | } | ||||
64 | } | ||||
65 | } | ||||
66 | elsif ($is_epoc) { | ||||
67 | unless ($filename =~ m{^([a-z?]:)?[\\/]}is) { | ||||
68 | $filename = "./$filename"; | ||||
69 | } | ||||
70 | } | ||||
71 | elsif ($is_vms) { | ||||
72 | # XXX todo by VMSmiths | ||||
73 | $filename = "./$filename"; | ||||
74 | } | ||||
75 | elsif (!$is_macos) { | ||||
76 | $filename = "./$filename"; | ||||
77 | } | ||||
78 | } | ||||
79 | } | ||||
80 | else { | ||||
81 | 2 | 11µs | $filename = undef; | ||
82 | } | ||||
83 | } | ||||
84 | 2 | 20µs | unless (defined $filename) { | ||
85 | # let C<require> do the searching | ||||
86 | 2 | 14µs | $filename = "auto/$sub.al"; | ||
87 | 2 | 71µs | 2 | 21µs | $filename =~ s#::#/#g; # spent 21µs making 2 calls to AutoLoader::CORE:subst, avg 11µs/call |
88 | } | ||||
89 | } | ||||
90 | 2 | 10µs | my $save = $@; | ||
91 | 2 | 680µs | local $!; # Do not munge the value. | ||
92 | 6 | 304µs | eval { local $SIG{__DIE__}; require $filename }; | ||
93 | 2 | 20µs | if ($@) { | ||
94 | 2 | 25µs | if (substr($sub,-9) eq '::DESTROY') { | ||
95 | 3 | 517µs | 1 | 100µs | no strict 'refs'; # spent 100µs making 1 call to strict::unimport |
96 | 75 | 404µs | # spent 16µs within AutoLoader::__ANON__[/usr/local/lib/perl5/5.8.8/AutoLoader.pm:96] which was called
# once (16µs+0s) by Wiki::DB::Wiki::BEGIN at line 116 | ||
97 | 2 | 10µs | $@ = undef; | ||
98 | } elsif ($@ =~ /^Can't locate/) { | ||||
99 | # The load might just have failed because the filename was too | ||||
100 | # long for some old SVR3 systems which treat long names as errors. | ||||
101 | # If we can successfully truncate a long name then it's worth a go. | ||||
102 | # There is a slight risk that we could pick up the wrong file here | ||||
103 | # but autosplit should have warned about that when splitting. | ||||
104 | if ($filename =~ s/(\w{12,})\.al$/substr($1,0,11).".al"/e){ | ||||
105 | eval { local $SIG{__DIE__}; require $filename }; | ||||
106 | } | ||||
107 | } | ||||
108 | 2 | 9µs | if ($@){ | ||
109 | $@ =~ s/ at .*\n//; | ||||
110 | my $error = $@; | ||||
111 | require Carp; | ||||
112 | Carp::croak($error); | ||||
113 | } | ||||
114 | } | ||||
115 | 2 | 9µs | $@ = $save; | ||
116 | 2 | 36µs | 1 | 16µs | goto &$sub; # spent 16µs making 1 call to AutoLoader::__ANON__[AutoLoader.pm:96] |
117 | } | ||||
118 | |||||
119 | # spent 1.40ms (1.16+239µs) within AutoLoader::import which was called 3 times, avg 468µs/call:
# once (528µs+67µs) by base::import at line 22 of Storable.pm
# once (318µs+97µs) by Net::HTTP::Methods::zlib_ok at line 6 of Compress/Zlib.pm
# once (318µs+75µs) by Net::HTTP::Methods::zlib_ok at line 6 of Compress/Raw/Zlib.pm | ||||
120 | 3 | 19µs | my $pkg = shift; | ||
121 | 3 | 19µs | my $callpkg = caller; | ||
122 | |||||
123 | # | ||||
124 | # Export symbols, but not by accident of inheritance. | ||||
125 | # | ||||
126 | |||||
127 | 3 | 33µs | if ($pkg eq 'AutoLoader') { | ||
128 | 3 | 561µs | 1 | 103µs | no strict 'refs'; # spent 103µs making 1 call to strict::unimport |
129 | 3 | 16µs | *{ $callpkg . '::AUTOLOAD' } = \&AUTOLOAD | ||
130 | if @_ and $_[0] =~ /^&?AUTOLOAD$/; | ||||
131 | } | ||||
132 | |||||
133 | # | ||||
134 | # Try to find the autosplit index file. Eg., if the call package | ||||
135 | # is POSIX, then $INC{POSIX.pm} is something like | ||||
136 | # '/usr/local/lib/perl5/POSIX.pm', and the autosplit index file is in | ||||
137 | # '/usr/local/lib/perl5/auto/POSIX/autosplit.ix', so we require that. | ||||
138 | # | ||||
139 | # However, if @INC is a relative path, this might not work. If, | ||||
140 | # for example, @INC = ('lib'), then | ||||
141 | # $INC{POSIX.pm} is 'lib/POSIX.pm', and we want to require | ||||
142 | # 'auto/POSIX/autosplit.ix' (without the leading 'lib'). | ||||
143 | # | ||||
144 | |||||
145 | 3 | 121µs | 3 | 37µs | (my $calldir = $callpkg) =~ s#::#/#g; # spent 37µs making 3 calls to AutoLoader::CORE:subst, avg 12µs/call |
146 | 3 | 26µs | my $path = $INC{$calldir . '.pm'}; | ||
147 | 3 | 93µs | if (defined($path)) { | ||
148 | # Try absolute path name. | ||||
149 | 3 | 28µs | if ($is_macos) { | ||
150 | (my $malldir = $calldir) =~ tr#/#:#; | ||||
151 | $path =~ s#^(.*)$malldir\.pm\z#$1auto:$malldir:autosplit.ix#s; | ||||
152 | } else { | ||||
153 | 3 | 365µs | 12 | 202µs | $path =~ s#^(.*)$calldir\.pm\z#$1auto/$calldir/autosplit.ix#; # spent 123µs making 3 calls to AutoLoader::CORE:regcomp, avg 41µs/call
# spent 41µs making 3 calls to AutoLoader::CORE:subst, avg 14µs/call
# spent 38µs making 6 calls to AutoLoader::CORE:substcont, avg 6µs/call |
154 | } | ||||
155 | |||||
156 | 6 | 634µs | eval { require $path; }; | ||
157 | # If that failed, try relative path with normal @INC searching. | ||||
158 | 3 | 12µs | if ($@) { | ||
159 | $path ="auto/$calldir/autosplit.ix"; | ||||
160 | eval { require $path; }; | ||||
161 | } | ||||
162 | 3 | 15µs | if ($@) { | ||
163 | my $error = $@; | ||||
164 | require Carp; | ||||
165 | Carp::carp($error); | ||||
166 | } | ||||
167 | } | ||||
168 | } | ||||
169 | |||||
170 | sub unimport { | ||||
171 | my $callpkg = caller; | ||||
172 | |||||
173 | 3 | 194µs | 1 | 95µs | no strict 'refs'; # spent 95µs making 1 call to strict::unimport |
174 | my $symname = $callpkg . '::AUTOLOAD'; | ||||
175 | undef *{ $symname } if \&{ $symname } == \&AUTOLOAD; | ||||
176 | *{ $symname } = \&{ $symname }; | ||||
177 | } | ||||
178 | |||||
179 | 1 | 15µs | 1; | ||
180 | |||||
181 | __END__ | ||||
182 | |||||
183 | =head1 NAME | ||||
184 | |||||
185 | AutoLoader - load subroutines only on demand | ||||
186 | |||||
187 | =head1 SYNOPSIS | ||||
188 | |||||
189 | package Foo; | ||||
190 | use AutoLoader 'AUTOLOAD'; # import the default AUTOLOAD subroutine | ||||
191 | |||||
192 | package Bar; | ||||
193 | use AutoLoader; # don't import AUTOLOAD, define our own | ||||
194 | sub AUTOLOAD { | ||||
195 | ... | ||||
196 | $AutoLoader::AUTOLOAD = "..."; | ||||
197 | goto &AutoLoader::AUTOLOAD; | ||||
198 | } | ||||
199 | |||||
200 | =head1 DESCRIPTION | ||||
201 | |||||
202 | The B<AutoLoader> module works with the B<AutoSplit> module and the | ||||
203 | C<__END__> token to defer the loading of some subroutines until they are | ||||
204 | used rather than loading them all at once. | ||||
205 | |||||
206 | To use B<AutoLoader>, the author of a module has to place the | ||||
207 | definitions of subroutines to be autoloaded after an C<__END__> token. | ||||
208 | (See L<perldata>.) The B<AutoSplit> module can then be run manually to | ||||
209 | extract the definitions into individual files F<auto/funcname.al>. | ||||
210 | |||||
211 | B<AutoLoader> implements an AUTOLOAD subroutine. When an undefined | ||||
212 | subroutine in is called in a client module of B<AutoLoader>, | ||||
213 | B<AutoLoader>'s AUTOLOAD subroutine attempts to locate the subroutine in a | ||||
214 | file with a name related to the location of the file from which the | ||||
215 | client module was read. As an example, if F<POSIX.pm> is located in | ||||
216 | F</usr/local/lib/perl5/POSIX.pm>, B<AutoLoader> will look for perl | ||||
217 | subroutines B<POSIX> in F</usr/local/lib/perl5/auto/POSIX/*.al>, where | ||||
218 | the C<.al> file has the same name as the subroutine, sans package. If | ||||
219 | such a file exists, AUTOLOAD will read and evaluate it, | ||||
220 | thus (presumably) defining the needed subroutine. AUTOLOAD will then | ||||
221 | C<goto> the newly defined subroutine. | ||||
222 | |||||
223 | Once this process completes for a given function, it is defined, so | ||||
224 | future calls to the subroutine will bypass the AUTOLOAD mechanism. | ||||
225 | |||||
226 | =head2 Subroutine Stubs | ||||
227 | |||||
228 | In order for object method lookup and/or prototype checking to operate | ||||
229 | correctly even when methods have not yet been defined it is necessary to | ||||
230 | "forward declare" each subroutine (as in C<sub NAME;>). See | ||||
231 | L<perlsub/"SYNOPSIS">. Such forward declaration creates "subroutine | ||||
232 | stubs", which are place holders with no code. | ||||
233 | |||||
234 | The AutoSplit and B<AutoLoader> modules automate the creation of forward | ||||
235 | declarations. The AutoSplit module creates an 'index' file containing | ||||
236 | forward declarations of all the AutoSplit subroutines. When the | ||||
237 | AutoLoader module is 'use'd it loads these declarations into its callers | ||||
238 | package. | ||||
239 | |||||
240 | Because of this mechanism it is important that B<AutoLoader> is always | ||||
241 | C<use>d and not C<require>d. | ||||
242 | |||||
243 | =head2 Using B<AutoLoader>'s AUTOLOAD Subroutine | ||||
244 | |||||
245 | In order to use B<AutoLoader>'s AUTOLOAD subroutine you I<must> | ||||
246 | explicitly import it: | ||||
247 | |||||
248 | use AutoLoader 'AUTOLOAD'; | ||||
249 | |||||
250 | =head2 Overriding B<AutoLoader>'s AUTOLOAD Subroutine | ||||
251 | |||||
252 | Some modules, mainly extensions, provide their own AUTOLOAD subroutines. | ||||
253 | They typically need to check for some special cases (such as constants) | ||||
254 | and then fallback to B<AutoLoader>'s AUTOLOAD for the rest. | ||||
255 | |||||
256 | Such modules should I<not> import B<AutoLoader>'s AUTOLOAD subroutine. | ||||
257 | Instead, they should define their own AUTOLOAD subroutines along these | ||||
258 | lines: | ||||
259 | |||||
260 | use AutoLoader; | ||||
261 | use Carp; | ||||
262 | |||||
263 | sub AUTOLOAD { | ||||
264 | my $sub = $AUTOLOAD; | ||||
265 | (my $constname = $sub) =~ s/.*:://; | ||||
266 | my $val = constant($constname, @_ ? $_[0] : 0); | ||||
267 | if ($! != 0) { | ||||
268 | if ($! =~ /Invalid/ || $!{EINVAL}) { | ||||
269 | $AutoLoader::AUTOLOAD = $sub; | ||||
270 | goto &AutoLoader::AUTOLOAD; | ||||
271 | } | ||||
272 | else { | ||||
273 | croak "Your vendor has not defined constant $constname"; | ||||
274 | } | ||||
275 | } | ||||
276 | *$sub = sub { $val }; # same as: eval "sub $sub { $val }"; | ||||
277 | goto &$sub; | ||||
278 | } | ||||
279 | |||||
280 | If any module's own AUTOLOAD subroutine has no need to fallback to the | ||||
281 | AutoLoader's AUTOLOAD subroutine (because it doesn't have any AutoSplit | ||||
282 | subroutines), then that module should not use B<AutoLoader> at all. | ||||
283 | |||||
284 | =head2 Package Lexicals | ||||
285 | |||||
286 | Package lexicals declared with C<my> in the main block of a package | ||||
287 | using B<AutoLoader> will not be visible to auto-loaded subroutines, due to | ||||
288 | the fact that the given scope ends at the C<__END__> marker. A module | ||||
289 | using such variables as package globals will not work properly under the | ||||
290 | B<AutoLoader>. | ||||
291 | |||||
292 | The C<vars> pragma (see L<perlmod/"vars">) may be used in such | ||||
293 | situations as an alternative to explicitly qualifying all globals with | ||||
294 | the package namespace. Variables pre-declared with this pragma will be | ||||
295 | visible to any autoloaded routines (but will not be invisible outside | ||||
296 | the package, unfortunately). | ||||
297 | |||||
298 | =head2 Not Using AutoLoader | ||||
299 | |||||
300 | You can stop using AutoLoader by simply | ||||
301 | |||||
302 | no AutoLoader; | ||||
303 | |||||
304 | =head2 B<AutoLoader> vs. B<SelfLoader> | ||||
305 | |||||
306 | The B<AutoLoader> is similar in purpose to B<SelfLoader>: both delay the | ||||
307 | loading of subroutines. | ||||
308 | |||||
309 | B<SelfLoader> uses the C<__DATA__> marker rather than C<__END__>. | ||||
310 | While this avoids the use of a hierarchy of disk files and the | ||||
311 | associated open/close for each routine loaded, B<SelfLoader> suffers a | ||||
312 | startup speed disadvantage in the one-time parsing of the lines after | ||||
313 | C<__DATA__>, after which routines are cached. B<SelfLoader> can also | ||||
314 | handle multiple packages in a file. | ||||
315 | |||||
316 | B<AutoLoader> only reads code as it is requested, and in many cases | ||||
317 | should be faster, but requires a mechanism like B<AutoSplit> be used to | ||||
318 | create the individual files. L<ExtUtils::MakeMaker> will invoke | ||||
319 | B<AutoSplit> automatically if B<AutoLoader> is used in a module source | ||||
320 | file. | ||||
321 | |||||
322 | =head1 CAVEATS | ||||
323 | |||||
324 | AutoLoaders prior to Perl 5.002 had a slightly different interface. Any | ||||
325 | old modules which use B<AutoLoader> should be changed to the new calling | ||||
326 | style. Typically this just means changing a require to a use, adding | ||||
327 | the explicit C<'AUTOLOAD'> import if needed, and removing B<AutoLoader> | ||||
328 | from C<@ISA>. | ||||
329 | |||||
330 | On systems with restrictions on file name length, the file corresponding | ||||
331 | to a subroutine may have a shorter name that the routine itself. This | ||||
332 | can lead to conflicting file names. The I<AutoSplit> package warns of | ||||
333 | these potential conflicts when used to split a module. | ||||
334 | |||||
335 | AutoLoader may fail to find the autosplit files (or even find the wrong | ||||
336 | ones) in cases where C<@INC> contains relative paths, B<and> the program | ||||
337 | does C<chdir>. | ||||
338 | |||||
339 | =head1 SEE ALSO | ||||
340 | |||||
341 | L<SelfLoader> - an autoloader that doesn't use external files. | ||||
342 | |||||
343 | =cut | ||||
# spent 75µs within AutoLoader::CORE:fteread which was called 2 times, avg 38µs/call:
# 2 times (75µs+0s) by AutoLoader::AUTOLOAD or base::import at line 55 of AutoLoader.pm, avg 38µs/call | |||||
# spent 42µs within AutoLoader::CORE:match which was called 2 times, avg 21µs/call:
# 2 times (42µs+0s) by AutoLoader::AUTOLOAD or base::import at line 39 of AutoLoader.pm, avg 21µs/call | |||||
# spent 185µs within AutoLoader::CORE:regcomp which was called 5 times, avg 37µs/call:
# 3 times (123µs+0s) by AutoLoader::import at line 153 of AutoLoader.pm, avg 41µs/call
# 2 times (62µs+0s) by AutoLoader::AUTOLOAD or base::import at line 46 of AutoLoader.pm, avg 31µs/call | |||||
# spent 132µs within AutoLoader::CORE:subst which was called 12 times, avg 11µs/call:
# 3 times (41µs+0s) by AutoLoader::import at line 153 of AutoLoader.pm, avg 14µs/call
# 3 times (37µs+0s) by AutoLoader::import at line 145 of AutoLoader.pm, avg 12µs/call
# 2 times (21µs+0s) by AutoLoader::AUTOLOAD or base::import at line 87 of AutoLoader.pm, avg 11µs/call
# 2 times (18µs+0s) by AutoLoader::AUTOLOAD or base::import at line 46 of AutoLoader.pm, avg 9µs/call
# 2 times (15µs+0s) by AutoLoader::AUTOLOAD or base::import at line 40 of AutoLoader.pm, avg 8µs/call | |||||
# spent 66µs within AutoLoader::CORE:substcont which was called 10 times, avg 7µs/call:
# 6 times (38µs+0s) by AutoLoader::import at line 153 of AutoLoader.pm, avg 6µs/call
# 4 times (28µs+0s) by AutoLoader::AUTOLOAD or base::import at line 46 of AutoLoader.pm, avg 7µs/call |