5 # When testing total_size(), always remember that it dereferences things, so
6 # total_size([]) will NOT return the size of the ref + the array, it will only
7 # return the size of the array alone!
11 use Devel::Size ':all';
19 PVIV => do { my $a = 1; $a = "One"; $a },
20 PVNV => do { my $a = 3.14; $a = "Mmm, pi"; $a },
21 PVMG => do { my $a = $!; $a = "Bang!"; $a },
24 plan(tests => 20 + 4 * 12 + 2 * scalar keys %types);
26 #############################################################################
27 # verify that pointer sizes in array slots are sensible:
28 # create an array with 4 slots, 2 of them used
29 my $array = [ 1,2,3,4 ]; pop @$array; pop @$array;
31 # the total size minus the array itself minus two scalars is 4 slots
32 my $ptr_size = total_size($array) - total_size( [] ) - total_size(1) * 2;
34 is ($ptr_size % 4, 0, '4 pointers are dividable by 4');
35 isnt ($ptr_size, 0, '4 pointers are not zero');
37 # size of one slot ptr
40 #############################################################################
41 # assert hash and hash key size
43 # Note, undef puts PL_sv_undef on perl's stack. Assigning to a hash or array
44 # value is always copying, so { a => undef } has a value which is a fresh
45 # (allocated) SVt_NULL. Nowever, total_size(undef) isn't a copy, so total_size()
46 # sees PL_sv_undef, which is a singleton, interpreter wide, so isn't counted as
47 # part of the size. So we need to use an unassigned scalar to get the correct
48 # size for a SVt_NULL:
53 is (total_size($hash),
54 total_size( { a => undef } ) + total_size(1) - total_size($undef),
55 'assert hash and hash key size');
57 #############################################################################
58 # #24846 (Does not correctly recurse into references in a PVNV-type scalar)
60 # run the following tests with different sizes
62 for my $size (2, 3, 7, 100)
64 my $hash = { a => 1 };
66 # hash + key minus the value
67 my $hash_size = total_size($hash) - total_size(1);
72 my $pvnv_size = total_size(\$hash->{a}) - total_size([]);
74 my $ref_size = total_size(\\1) - total_size(1);
76 # $hash->{a} is now a PVNV, e.g. a scalar NV and a ref to an array:
77 # SV = PVNV(0x81ff9a8) at 0x8170d48
83 # SV = PVAV(0x8175d6c) at 0x81717bc
97 # Compare this to a plain array ref
98 #SV = RV(0x81a2834) at 0x8207a2c
102 # SV = PVAV(0x8175d98) at 0x8170b44
112 # Get the size of the PVNV and the contained array
113 my $element_size = total_size(\$hash->{a});
115 cmp_ok($element_size, '<', total_size($hash), "element < hash with one element");
116 cmp_ok($element_size, '>', total_size(\[]), "PVNV + [] > [] alone");
118 # Dereferencing the PVNV (the argument to total_size) leaves us with
119 # just the array, and this should be equal to a dereferenced array:
120 is (total_size($hash->{a}), total_size([]), '[] vs. []');
122 # the hash with one key
123 # the PVNV in the hash
124 # the RV inside the PVNV
125 # the contents of the array (array size)
127 my $full_hash = total_size($hash);
128 my $array_size = total_size([]);
129 is ($full_hash, $element_size + $hash_size, 'properly recurses into PVNV');
130 is ($full_hash, $array_size + $pvnv_size + $hash_size, 'properly recurses into PVNV');
132 $hash->{a} = [0..$size];
134 # the outer references stripped away, so they should be the same
135 is (total_size([0..$size]), total_size( $hash->{a} ), "hash element vs. array");
137 # the outer references included, one is just a normal ref, while the other
138 # is a PVNV, so they shouldn't be the same:
139 isnt (total_size(\[0..$size]), total_size( \$hash->{a} ), "[0..size] vs PVNV");
140 # and the plain ref should be smaller
141 cmp_ok(total_size(\[0..$size]), '<', total_size( \$hash->{a} ), "[0..size] vs. PVNV");
143 $full_hash = total_size($hash);
144 $element_size = total_size(\$hash->{a});
145 $array_size = total_size(\[0..$size]);
147 print "# full_hash = $full_hash\n";
148 print "# hash_size = $hash_size\n";
149 print "# array size: $array_size\n";
150 print "# element size: $element_size\n";
151 print "# ref_size = $ref_size\n";
152 print "# pvnv_size: $pvnv_size\n";
156 # the hash with one key
157 # the PVNV in the hash
158 # the RV inside the PVNV
159 # the contents of the array (array size)
161 is ($full_hash, $element_size + $hash_size, 'properly recurses into PVNV');
162 # is ($full_hash, $array_size + $pvnv_size + $hash_size, 'properly recurses into PVNV');
164 #############################################################################
165 # repeat the former test, but mix in some undef elements
167 $array_size = total_size(\[0..$size, undef, undef]);
169 $hash->{a} = [0..$size, undef, undef];
170 $element_size = total_size(\$hash->{a});
171 $full_hash = total_size($hash);
173 print "# full_hash = $full_hash\n";
174 print "# hash_size = $hash_size\n";
175 print "# array size: $array_size\n";
176 print "# element size: $element_size\n";
177 print "# ref_size = $ref_size\n";
178 print "# pvnv_size: $pvnv_size\n";
180 is ($full_hash, $element_size + $hash_size, 'properly recurses into PVNV');
182 #############################################################################
183 # repeat the former test, but use a pre-extended array
185 $array = [ 0..$size, undef, undef ]; pop @$array;
187 $array_size = total_size($array);
188 my $scalar_size = total_size(1) * (1+$size) + total_size($undef) * 1 + $ptr_size
189 + $ptr_size * ($size + 2) + total_size([]);
190 is ($scalar_size, $array_size, "computed right size if full array");
192 $hash->{a} = [0..$size, undef, undef]; pop @{$hash->{a}};
193 $full_hash = total_size($hash);
194 $element_size = total_size(\$hash->{a});
195 $array_size = total_size(\$array);
197 print "# full_hash = $full_hash\n";
198 print "# hash_size = $hash_size\n";
199 print "# array size: $array_size\n";
200 print "# element size: $element_size\n";
201 print "# ref_size = $ref_size\n";
202 print "# pvnv_size: $pvnv_size\n";
204 is ($full_hash, $element_size + $hash_size, 'properly handles undef/non-undef inside arrays');
206 } # end for different sizes
209 my($got, $want, $desc) = @_;
210 local $Test::Builder::Level = $Test::Builder::Level + 1;
211 is(@$got, @$want, "$desc (same element count)");
214 is($got->[$i], $want->[$i], "$desc (element $i)");
220 my $undef_size = total_size($undef);
221 cmp_ok($undef_size, '>', 0, 'non-zero size for NULL');
223 my $iv_size = total_size(1);
224 cmp_ok($iv_size, '>', 0, 'non-zero size for IV');
226 # Force the array to allocate storage for elements.
227 # This avoids making the assumption that just because it doesn't happen
228 # initially now, it won't stay that way forever.
230 my $array_1_size = total_size(\@array);
231 cmp_ok($array_1_size, '>', 0, 'non-zero size for array with 1 element');
237 # This might be making too many assumptions about the current implementation
238 my $array_2_size = total_size(\@array);
239 is($array_2_size, $array_1_size + $iv_size,
240 "gaps in arrays don't allocate scalars");
242 # Avoid using is_deeply() as that will read $#array, which is a write
243 # action prior to 5.12. (Different writes on 5.10 and 5.8-and-earlier, but
244 # a write either way, allocating memory.
245 cmp_array_ro(\@array, \@copy, 'two arrays compare the same');
250 is(total_size(\@array), $array_2_size + $undef_size,
251 "assigning undef to a gap in an array allocates a scalar");
253 cmp_array_ro(\@array, \@copy, 'two arrays compare the same');
258 # reverse sort ensures that PVIV, PVNV and RV are processed before
259 # IV, NULL, or NV :-)
260 foreach my $type (reverse sort keys %types) {
261 # Need to make sure this goes in a new scalar every time. Putting it
262 # directly in a lexical means that it's in the pad, and the pad recycles
263 # scalars, a side effect of which is that they get upgraded in ways we
266 $a->[0] = $types{$type};
269 my $expect = $sizes{$type} = size(\$a->[0]);
271 $a->[0] = \('x' x 1024);
273 $expect = $sizes{RV} if $type eq 'NULL';
274 $expect = $sizes{PVNV} if $type eq 'NV';
275 $expect = $sizes{PVIV} if $type eq 'IV' && $] < 5.012;
277 # Remember, size() removes a level of referencing if present. So add
278 # one, so that we get the size of our reference:
279 is(size(\$a->[0]), $expect,
280 "Type $type containing a reference, size() does not recurse to the referent");
281 cmp_ok(total_size(\$a->[0]), '>', 1024,
282 "Type $type, total_size() recurses to the referent");
287 my $sub_size = total_size(\&cmp_array_ro);
288 cmp_ok($sub_size, '>=', 5120, 'subroutine is at least 5K');
289 cmp_ok($sub_size, '<=', 51200, 'subroutine is no more than 50K')
290 or diag 'Is total_size() dragging in the entire symbol table?';
291 cmp_ok(total_size(\%::), '>=', 10240, 'symbol table is at least 100K');
294 cmp_ok(total_size(\%Exporter::), '>', total_size(\%Exporter::Heavy::));