1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
|
/*
* Store and retrieve mechanism.
*
* Copyright (c) 1995-2000, Raphael Manfredi
*
* You may redistribute only under the same terms as Perl 5, as specified
* in the README file that comes with the distribution.
*
*/
#define PERL_NO_GET_CONTEXT /* we want efficiency */
#include <EXTERN.h>
#include <perl.h>
#include <XSUB.h>
#ifndef PATCHLEVEL
#include <patchlevel.h> /* Perl's one, needed since 5.6 */
#endif
#if !defined(PERL_VERSION) || PERL_VERSION < 8
#include "ppport.h" /* handle old perls */
#endif
#if 0
#define DEBUGME /* Debug mode, turns assertions on as well */
#define DASSERT /* Assertion mode */
#endif
/*
* Pre PerlIO time when none of USE_PERLIO and PERLIO_IS_STDIO is defined
* Provide them with the necessary defines so they can build with pre-5.004.
*/
#ifndef USE_PERLIO
#ifndef PERLIO_IS_STDIO
#define PerlIO FILE
#define PerlIO_getc(x) getc(x)
#define PerlIO_putc(f,x) putc(x,f)
#define PerlIO_read(x,y,z) fread(y,1,z,x)
#define PerlIO_write(x,y,z) fwrite(y,1,z,x)
#define PerlIO_stdoutf printf
#endif /* PERLIO_IS_STDIO */
#endif /* USE_PERLIO */
/*
* Earlier versions of perl might be used, we can't assume they have the latest!
*/
#ifndef PERL_VERSION /* For perls < 5.6 */
#define PERL_VERSION PATCHLEVEL
#ifndef newRV_noinc
#define newRV_noinc(sv) ((Sv = newRV(sv)), --SvREFCNT(SvRV(Sv)), Sv)
#endif
#if (PATCHLEVEL <= 4) /* Older perls (<= 5.004) lack PL_ namespace */
#define PL_sv_yes sv_yes
#define PL_sv_no sv_no
#define PL_sv_undef sv_undef
#if (SUBVERSION <= 4) /* 5.004_04 has been reported to lack newSVpvn */
#define newSVpvn newSVpv
#endif
#endif /* PATCHLEVEL <= 4 */
#ifndef HvSHAREKEYS_off
#define HvSHAREKEYS_off(hv) /* Ignore */
#endif
#ifndef AvFILLp /* Older perls (<=5.003) lack AvFILLp */
#define AvFILLp AvFILL
#endif
typedef double NV; /* Older perls lack the NV type */
#define IVdf "ld" /* Various printf formats for Perl types */
#define UVuf "lu"
#define UVof "lo"
#define UVxf "lx"
#define INT2PTR(t,v) (t)(IV)(v)
#define PTR2UV(v) (unsigned long)(v)
#endif /* PERL_VERSION -- perls < 5.6 */
#ifndef NVef /* The following were not part of perl 5.6 */
#if defined(USE_LONG_DOUBLE) && \
defined(HAS_LONG_DOUBLE) && defined(PERL_PRIfldbl)
#define NVef PERL_PRIeldbl
#define NVff PERL_PRIfldbl
#define NVgf PERL_PRIgldbl
#else
#define NVef "e"
#define NVff "f"
#define NVgf "g"
#endif
#endif
#ifdef HASATTRIBUTE
# if (defined(__GNUC__) && defined(__cplusplus)) || defined(__INTEL_COMPILER)
# define PERL_UNUSED_DECL
# else
# define PERL_UNUSED_DECL __attribute__((unused))
# endif
#else
# define PERL_UNUSED_DECL
#endif
#ifndef dNOOP
#define dNOOP extern int Perl___notused PERL_UNUSED_DECL
#endif
#ifndef dVAR
#define dVAR dNOOP
#endif
#ifdef DEBUGME
#ifndef DASSERT
#define DASSERT
#endif
/*
* TRACEME() will only output things when the $Storable::DEBUGME is true.
*/
#define TRACEME(x) \
STMT_START { \
if (SvTRUE(perl_get_sv("Storable::DEBUGME", TRUE))) \
{ PerlIO_stdoutf x; PerlIO_stdoutf("\n"); } \
} STMT_END
#else
#define TRACEME(x)
#endif /* DEBUGME */
#ifdef DASSERT
#define ASSERT(x,y) \
STMT_START { \
if (!(x)) { \
PerlIO_stdoutf("ASSERT FAILED (\"%s\", line %d): ", \
__FILE__, __LINE__); \
PerlIO_stdoutf y; PerlIO_stdoutf("\n"); \
} \
} STMT_END
#else
#define ASSERT(x,y)
#endif
/*
* Type markers.
*/
#define C(x) ((char) (x)) /* For markers with dynamic retrieval handling */
#define SX_OBJECT C(0) /* Already stored object */
#define SX_LSCALAR C(1) /* Scalar (large binary) follows (length, data) */
#define SX_ARRAY C(2) /* Array forthcominng (size, item list) */
#define SX_HASH C(3) /* Hash forthcoming (size, key/value pair list) */
#define SX_REF C(4) /* Reference to object forthcoming */
#define SX_UNDEF C(5) /* Undefined scalar */
#define SX_INTEGER C(6) /* Integer forthcoming */
#define SX_DOUBLE C(7) /* Double forthcoming */
#define SX_BYTE C(8) /* (signed) byte forthcoming */
#define SX_NETINT C(9) /* Integer in network order forthcoming */
#define SX_SCALAR C(10) /* Scalar (binary, small) follows (length, data) */
#define SX_TIED_ARRAY C(11) /* Tied array forthcoming */
#define SX_TIED_HASH C(12) /* Tied hash forthcoming */
#define SX_TIED_SCALAR C(13) /* Tied scalar forthcoming */
#define SX_SV_UNDEF C(14) /* Perl's immortal PL_sv_undef */
#define SX_SV_YES C(15) /* Perl's immortal PL_sv_yes */
#define SX_SV_NO C(16) /* Perl's immortal PL_sv_no */
#define SX_BLESS C(17) /* Object is blessed */
#define SX_IX_BLESS C(18) /* Object is blessed, classname given by index */
#define SX_HOOK C(19) /* Stored via hook, user-defined */
#define SX_OVERLOAD C(20) /* Overloaded reference */
#define SX_TIED_KEY C(21) /* Tied magic key forthcoming */
#define SX_TIED_IDX C(22) /* Tied magic index forthcoming */
#define SX_UTF8STR C(23) /* UTF-8 string forthcoming (small) */
#define SX_LUTF8STR C(24) /* UTF-8 string forthcoming (large) */
#define SX_FLAG_HASH C(25) /* Hash with flags forthcoming (size, flags, key/flags/value triplet list) */
#define SX_CODE C(26) /* Code references as perl source code */
#define SX_WEAKREF C(27) /* Weak reference to object forthcoming */
#define SX_WEAKOVERLOAD C(28) /* Overloaded weak reference */
#define SX_ERROR C(29) /* Error */
/*
* Those are only used to retrieve "old" pre-0.6 binary images.
*/
#define SX_ITEM 'i' /* An array item introducer */
#define SX_IT_UNDEF 'I' /* Undefined array item */
#define SX_KEY 'k' /* A hash key introducer */
#define SX_VALUE 'v' /* A hash value introducer */
#define SX_VL_UNDEF 'V' /* Undefined hash value */
/*
* Those are only used to retrieve "old" pre-0.7 binary images
*/
#define SX_CLASS 'b' /* Object is blessed, class name length <255 */
#define SX_LG_CLASS 'B' /* Object is blessed, class name length >255 */
#define SX_STORED 'X' /* End of object */
/*
* Limits between short/long length representation.
*/
#define LG_SCALAR 255 /* Large scalar length limit */
#define LG_BLESS 127 /* Large classname bless limit */
/*
* Operation types
*/
#define ST_STORE 0x1 /* Store operation */
#define ST_RETRIEVE 0x2 /* Retrieval operation */
#define ST_CLONE 0x4 /* Deep cloning operation */
/*
* The following structure is used for hash table key retrieval. Since, when
* retrieving objects, we'll be facing blessed hash references, it's best
* to pre-allocate that buffer once and resize it as the need arises, never
* freeing it (keys will be saved away someplace else anyway, so even large
* keys are not enough a motivation to reclaim that space).
*
* This structure is also used for memory store/retrieve operations which
* happen in a fixed place before being malloc'ed elsewhere if persistency
* is required. Hence the aptr pointer.
*/
struct extendable {
char *arena; /* Will hold hash key strings, resized as needed */
STRLEN asiz; /* Size of aforementionned buffer */
char *aptr; /* Arena pointer, for in-place read/write ops */
char *aend; /* First invalid address */
};
/*
* At store time:
* A hash table records the objects which have already been stored.
* Those are referred to as SX_OBJECT in the file, and their "tag" (i.e.
* an arbitrary sequence number) is used to identify them.
*
* At retrieve time:
* An array table records the objects which have already been retrieved,
* as seen by the tag determind by counting the objects themselves. The
* reference to that retrieved object is kept in the table, and is returned
* when an SX_OBJECT is found bearing that same tag.
*
* The same processing is used to record "classname" for blessed objects:
* indexing by a hash at store time, and via an array at retrieve time.
*/
typedef unsigned long stag_t; /* Used by pre-0.6 binary format */
/*
* The following "thread-safe" related defines were contributed by
* Murray Nesbitt <murray@activestate.com> and integrated by RAM, who
* only renamed things a little bit to ensure consistency with surrounding
* code. -- RAM, 14/09/1999
*
* The original patch suffered from the fact that the stcxt_t structure
* was global. Murray tried to minimize the impact on the code as much as
* possible.
*
* Starting with 0.7, Storable can be re-entrant, via the STORABLE_xxx hooks
* on objects. Therefore, the notion of context needs to be generalized,
* threading or not.
*/
#define MY_VERSION "Storable(" XS_VERSION ")"
/*
* Conditional UTF8 support.
*
*/
#ifdef SvUTF8_on
#define STORE_UTF8STR(pv, len) STORE_PV_LEN(pv, len, SX_UTF8STR, SX_LUTF8STR)
#define HAS_UTF8_SCALARS
#ifdef HeKUTF8
#define HAS_UTF8_HASHES
#define HAS_UTF8_ALL
#else
/* 5.6 perl has utf8 scalars but not hashes */
#endif
#else
#define SvUTF8(sv) 0
#define STORE_UTF8STR(pv, len) CROAK(("panic: storing UTF8 in non-UTF8 perl"))
#endif
#ifndef HAS_UTF8_ALL
#define UTF8_CROAK() CROAK(("Cannot retrieve UTF8 data in non-UTF8 perl"))
#endif
#ifndef SvWEAKREF
#define WEAKREF_CROAK() CROAK(("Cannot retrieve weak references in this perl"))
#endif
#ifdef HvPLACEHOLDERS
#define HAS_RESTRICTED_HASHES
#else
#define HVhek_PLACEHOLD 0x200
#define RESTRICTED_HASH_CROAK() CROAK(("Cannot retrieve restricted hash"))
#endif
#ifdef HvHASKFLAGS
#define HAS_HASH_KEY_FLAGS
#endif
#ifdef ptr_table_new
#define USE_PTR_TABLE
#endif
/*
* Fields s_tainted and s_dirty are prefixed with s_ because Perl's include
* files remap tainted and dirty when threading is enabled. That's bad for
* perl to remap such common words. -- RAM, 29/09/00
*/
struct stcxt;
typedef struct stcxt {
int entry; /* flags recursion */
int optype; /* type of traversal operation */
/* which objects have been seen, store time.
tags are numbers, which are cast to (SV *) and stored directly */
#ifdef USE_PTR_TABLE
/* use pseen if we have ptr_tables. We have to store tag+1, because
tag numbers start at 0, and we can't store (SV *) 0 in a ptr_table
without it being confused for a fetch lookup failure. */
struct ptr_tbl *pseen;
/* Still need hseen for the 0.6 file format code. */
#endif
HV *hseen;
AV *hook_seen; /* which SVs were returned by STORABLE_freeze() */
AV *aseen; /* which objects have been seen, retrieve time */
IV where_is_undef; /* index in aseen of PL_sv_undef */
HV *hclass; /* which classnames have been seen, store time */
AV *aclass; /* which classnames have been seen, retrieve time */
HV *hook; /* cache for hook methods per class name */
IV tagnum; /* incremented at store time for each seen object */
IV classnum; /* incremented at store time for each seen classname */
int netorder; /* true if network order used */
int s_tainted; /* true if input source is tainted, at retrieve time */
int forgive_me; /* whether to be forgiving... */
int deparse; /* whether to deparse code refs */
SV *eval; /* whether to eval source code */
int canonical; /* whether to store hashes sorted by key */
#ifndef HAS_RESTRICTED_HASHES
int derestrict; /* whether to downgrade restrcted hashes */
#endif
#ifndef HAS_UTF8_ALL
int use_bytes; /* whether to bytes-ify utf8 */
#endif
int accept_future_minor; /* croak immediately on future minor versions? */
int s_dirty; /* context is dirty due to CROAK() -- can be cleaned */
int membuf_ro; /* true means membuf is read-only and msaved is rw */
struct extendable keybuf; /* for hash key retrieval */
struct extendable membuf; /* for memory store/retrieve operations */
struct extendable msaved; /* where potentially valid mbuf is saved */
PerlIO *fio; /* where I/O are performed, NULL for memory */
int ver_major; /* major of version for retrieved object */
int ver_minor; /* minor of version for retrieved object */
SV *(**retrieve_vtbl)(pTHX_ struct stcxt *, char *); /* retrieve dispatch table */
SV *prev; /* contexts chained backwards in real recursion */
SV *my_sv; /* the blessed scalar who's SvPVX() I am */
} stcxt_t;
#define NEW_STORABLE_CXT_OBJ(cxt) \
STMT_START { \
SV *self = newSV(sizeof(stcxt_t) - 1); \
SV *my_sv = newRV_noinc(self); \
sv_bless(my_sv, gv_stashpv("Storable::Cxt", TRUE)); \
cxt = (stcxt_t *)SvPVX(self); \
Zero(cxt, 1, stcxt_t); \
cxt->my_sv = my_sv; \
} STMT_END
#if defined(MULTIPLICITY) || defined(PERL_OBJECT) || defined(PERL_CAPI)
#if (PATCHLEVEL <= 4) && (SUBVERSION < 68)
#define dSTCXT_SV \
SV *perinterp_sv = perl_get_sv(MY_VERSION, FALSE)
#else /* >= perl5.004_68 */
#define dSTCXT_SV \
SV *perinterp_sv = *hv_fetch(PL_modglobal, \
MY_VERSION, sizeof(MY_VERSION)-1, TRUE)
#endif /* < perl5.004_68 */
#define dSTCXT_PTR(T,name) \
T name = ((perinterp_sv && SvIOK(perinterp_sv) && SvIVX(perinterp_sv) \
? (T)SvPVX(SvRV(INT2PTR(SV*,SvIVX(perinterp_sv)))) : (T) 0))
#define dSTCXT \
dSTCXT_SV; \
dSTCXT_PTR(stcxt_t *, cxt)
#define INIT_STCXT \
dSTCXT; \
NEW_STORABLE_CXT_OBJ(cxt); \
sv_setiv(perinterp_sv, PTR2IV(cxt->my_sv))
#define SET_STCXT(x) \
STMT_START { \
dSTCXT_SV; \
sv_setiv(perinterp_sv, PTR2IV(x->my_sv)); \
} STMT_END
#else /* !MULTIPLICITY && !PERL_OBJECT && !PERL_CAPI */
static stcxt_t *Context_ptr = NULL;
#define dSTCXT stcxt_t *cxt = Context_ptr
#define SET_STCXT(x) Context_ptr = x
#define INIT_STCXT \
dSTCXT; \
NEW_STORABLE_CXT_OBJ(cxt); \
SET_STCXT(cxt)
#endif /* MULTIPLICITY || PERL_OBJECT || PERL_CAPI */
/*
* KNOWN BUG:
* Croaking implies a memory leak, since we don't use setjmp/longjmp
* to catch the exit and free memory used during store or retrieve
* operations. This is not too difficult to fix, but I need to understand
* how Perl does it, and croaking is exceptional anyway, so I lack the
* motivation to do it.
*
* The current workaround is to mark the context as dirty when croaking,
* so that data structures can be freed whenever we renter Storable code
* (but only *then*: it's a workaround, not a fix).
*
* This is also imperfect, because we don't really know how far they trapped
* the croak(), and when we were recursing, we won't be able to clean anything
* but the topmost context stacked.
*/
#define CROAK(x) STMT_START { cxt->s_dirty = 1; croak x; } STMT_END
/*
* End of "thread-safe" related definitions.
*/
/*
* LOW_32BITS
*
* Keep only the low 32 bits of a pointer (used for tags, which are not
* really pointers).
*/
#if PTRSIZE <= 4
#define LOW_32BITS(x) ((I32) (x))
#else
#define LOW_32BITS(x) ((I32) ((unsigned long) (x) & 0xffffffffUL))
#endif
/*
* oI, oS, oC
*
* Hack for Crays, where sizeof(I32) == 8, and which are big-endians.
* Used in the WLEN and RLEN macros.
*/
#if INTSIZE > 4
#define oI(x) ((I32 *) ((char *) (x) + 4))
#define oS(x) ((x) - 4)
#define oC(x) (x = 0)
#define CRAY_HACK
#else
#define oI(x) (x)
#define oS(x) (x)
#define oC(x)
#endif
/*
* key buffer handling
*/
#define kbuf (cxt->keybuf).arena
#define ksiz (cxt->keybuf).asiz
#define KBUFINIT() \
STMT_START { \
if (!kbuf) { \
TRACEME(("** allocating kbuf of 128 bytes")); \
New(10003, kbuf, 128, char); \
ksiz = 128; \
} \
} STMT_END
#define KBUFCHK(x) \
STMT_START { \
if (x >= ksiz) { \
TRACEME(("** extending kbuf to %d bytes (had %d)", x+1, ksiz)); \
Renew(kbuf, x+1, char); \
ksiz = x+1; \
} \
} STMT_END
/*
* memory buffer handling
*/
#define mbase (cxt->membuf).arena
#define msiz (cxt->membuf).asiz
#define mptr (cxt->membuf).aptr
#define mend (cxt->membuf).aend
#define MGROW (1 << 13)
#define MMASK (MGROW - 1)
#define round_mgrow(x) \
((unsigned long) (((unsigned long) (x) + MMASK) & ~MMASK))
#define trunc_int(x) \
((unsigned long) ((unsigned long) (x) & ~(sizeof(int)-1)))
#define int_aligned(x) \
((unsigned long) (x) == trunc_int(x))
#define MBUF_INIT(x) \
STMT_START { \
if (!mbase) { \
TRACEME(("** allocating mbase of %d bytes", MGROW)); \
New(10003, mbase, MGROW, char); \
msiz = (STRLEN)MGROW; \
} \
mptr = mbase; \
if (x) \
mend = mbase + x; \
else \
mend = mbase + msiz; \
} STMT_END
#define MBUF_TRUNC(x) mptr = mbase + x
#define MBUF_SIZE() (mptr - mbase)
/*
* MBUF_SAVE_AND_LOAD
* MBUF_RESTORE
*
* Those macros are used in do_retrieve() to save the current memory
* buffer into cxt->msaved, before MBUF_LOAD() can be used to retrieve
* data from a string.
*/
#define MBUF_SAVE_AND_LOAD(in) \
STMT_START { \
ASSERT(!cxt->membuf_ro, ("mbase not already saved")); \
cxt->membuf_ro = 1; \
TRACEME(("saving mbuf")); \
StructCopy(&cxt->membuf, &cxt->msaved, struct extendable); \
MBUF_LOAD(in); \
} STMT_END
#define MBUF_RESTORE() \
STMT_START { \
ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
cxt->membuf_ro = 0; \
TRACEME(("restoring mbuf")); \
StructCopy(&cxt->msaved, &cxt->membuf, struct extendable); \
} STMT_END
/*
* Use SvPOKp(), because SvPOK() fails on tainted scalars.
* See store_scalar() for other usage of this workaround.
*/
#define MBUF_LOAD(v) \
STMT_START { \
ASSERT(cxt->membuf_ro, ("mbase is read-only")); \
if (!SvPOKp(v)) \
CROAK(("Not a scalar string")); \
mptr = mbase = SvPV(v, msiz); \
mend = mbase + msiz; \
} STMT_END
#define MBUF_XTEND(x) \
STMT_START { \
int nsz = (int) round_mgrow((x)+msiz); \
int offset = mptr - mbase; \
ASSERT(!cxt->membuf_ro, ("mbase is not read-only")); \
TRACEME(("** extending mbase from %d to %d bytes (wants %d new)", \
msiz, nsz, (x))); \
Renew(mbase, nsz, char); \
msiz = nsz; \
mptr = mbase + offset; \
mend = mbase + nsz; \
} STMT_END
#define MBUF_CHK(x) \
STMT_START { \
if ((mptr + (x)) > mend) \
MBUF_XTEND(x); \
} STMT_END
#define MBUF_GETC(x) \
STMT_START { \
if (mptr < mend) \
x = (int) (unsigned char) *mptr++; \
else \
return (SV *) 0; \
} STMT_END
#ifdef CRAY_HACK
#define MBUF_GETINT(x) \
STMT_START { \
oC(x); \
if ((mptr + 4) <= mend) { \
memcpy(oI(&x), mptr, 4); \
mptr += 4; \
} else \
return (SV *) 0; \
} STMT_END
#else
#define MBUF_GETINT(x) \
STMT_START { \
if ((mptr + sizeof(int)) <= mend) { \
if (int_aligned(mptr)) \
x = *(int *) mptr; \
else \
memcpy(&x, mptr, sizeof(int)); \
mptr += sizeof(int); \
} else \
return (SV *) 0; \
} STMT_END
#endif
#define MBUF_READ(x,s) \
STMT_START { \
if ((mptr + (s)) <= mend) { \
memcpy(x, mptr, s); \
mptr += s; \
} else \
return (SV *) 0; \
} STMT_END
#define MBUF_SAFEREAD(x,s,z) \
STMT_START { \
if ((mptr + (s)) <= mend) { \
memcpy(x, mptr, s); \
mptr += s; \
} else { \
sv_free(z); \
return (SV *) 0; \
} \
} STMT_END
#define MBUF_PUTC(c) \
STMT_START { \
if (mptr < mend) \
*mptr++ = (char) c; \
else { \
MBUF_XTEND(1); \
*mptr++ = (char) c; \
} \
} STMT_END
#ifdef CRAY_HACK
#define MBUF_PUTINT(i) \
STMT_START { \
MBUF_CHK(4); \
memcpy(mptr, oI(&i), 4); \
mptr += 4; \
} STMT_END
#else
#define MBUF_PUTINT(i) \
STMT_START { \
MBUF_CHK(sizeof(int)); \
if (int_aligned(mptr)) \
*(int *) mptr = i; \
else \
memcpy(mptr, &i, sizeof(int)); \
mptr += sizeof(int); \
} STMT_END
#endif
#define MBUF_WRITE(x,s) \
STMT_START { \
MBUF_CHK(s); \
memcpy(mptr, x, s); \
mptr += s; \
} STMT_END
/*
* Possible return values for sv_type().
*/
#define svis_REF 0
#define svis_SCALAR 1
#define svis_ARRAY 2
#define svis_HASH 3
#define svis_TIED 4
#define svis_TIED_ITEM 5
#define svis_CODE 6
#define svis_OTHER 7
/*
* Flags for SX_HOOK.
*/
#define SHF_TYPE_MASK 0x03
#define SHF_LARGE_CLASSLEN 0x04
#define SHF_LARGE_STRLEN 0x08
#define SHF_LARGE_LISTLEN 0x10
#define SHF_IDX_CLASSNAME 0x20
#define SHF_NEED_RECURSE 0x40
#define SHF_HAS_LIST 0x80
/*
* Types for SX_HOOK (last 2 bits in flags).
*/
#define SHT_SCALAR 0
#define SHT_ARRAY 1
#define SHT_HASH 2
#define SHT_EXTRA 3 /* Read extra byte for type */
/*
* The following are held in the "extra byte"...
*/
#define SHT_TSCALAR 4 /* 4 + 0 -- tied scalar */
#define SHT_TARRAY 5 /* 4 + 1 -- tied array */
#define SHT_THASH 6 /* 4 + 2 -- tied hash */
/*
* per hash flags for flagged hashes
*/
#define SHV_RESTRICTED 0x01
/*
* per key flags for flagged hashes
*/
#define SHV_K_UTF8 0x01
#define SHV_K_WASUTF8 0x02
#define SHV_K_LOCKED 0x04
#define SHV_K_ISSV 0x08
#define SHV_K_PLACEHOLDER 0x10
/*
* Before 0.6, the magic string was "perl-store" (binary version number 0).
*
* Since 0.6 introduced many binary incompatibilities, the magic string has
* been changed to "pst0" to allow an old image to be properly retrieved by
* a newer Storable, but ensure a newer image cannot be retrieved with an
* older version.
*
* At 0.7, objects are given the ability to serialize themselves, and the
* set of markers is extended, backward compatibility is not jeopardized,
* so the binary version number could have remained unchanged. To correctly
* spot errors if a file making use of 0.7-specific extensions is given to
* 0.6 for retrieval, the binary version was moved to "2". And I'm introducing
* a "minor" version, to better track this kind of evolution from now on.
*
*/
static const char old_magicstr[] = "perl-store"; /* Magic number before 0.6 */
static const char magicstr[] = "pst0"; /* Used as a magic number */
#define MAGICSTR_BYTES 'p','s','t','0'
#define OLDMAGICSTR_BYTES 'p','e','r','l','-','s','t','o','r','e'
/* 5.6.x introduced the ability to have IVs as long long.
However, Configure still defined BYTEORDER based on the size of a long.
Storable uses the BYTEORDER value as part of the header, but doesn't
explicity store sizeof(IV) anywhere in the header. Hence on 5.6.x built
with IV as long long on a platform that uses Configure (ie most things
except VMS and Windows) headers are identical for the different IV sizes,
despite the files containing some fields based on sizeof(IV)
Erk. Broken-ness.
5.8 is consistent - the following redifinition kludge is only needed on
5.6.x, but the interwork is needed on 5.8 while data survives in files
with the 5.6 header.
*/
#if defined (IVSIZE) && (IVSIZE == 8) && (LONGSIZE == 4)
#ifndef NO_56_INTERWORK_KLUDGE
#define USE_56_INTERWORK_KLUDGE
#endif
#if BYTEORDER == 0x1234
#undef BYTEORDER
#define BYTEORDER 0x12345678
#else
#if BYTEORDER == 0x4321
#undef BYTEORDER
#define BYTEORDER 0x87654321
#endif
#endif
#endif
#if BYTEORDER == 0x1234
#define BYTEORDER_BYTES '1','2','3','4'
#else
#if BYTEORDER == 0x12345678
#define BYTEORDER_BYTES '1','2','3','4','5','6','7','8'
#ifdef USE_56_INTERWORK_KLUDGE
#define BYTEORDER_BYTES_56 '1','2','3','4'
#endif
#else
#if BYTEORDER == 0x87654321
#define BYTEORDER_BYTES '8','7','6','5','4','3','2','1'
#ifdef USE_56_INTERWORK_KLUDGE
#define BYTEORDER_BYTES_56 '4','3','2','1'
#endif
#else
#if BYTEORDER == 0x4321
#define BYTEORDER_BYTES '4','3','2','1'
#else
#error Unknown byteorder. Please append your byteorder to Storable.xs
#endif
#endif
#endif
#endif
static const char byteorderstr[] = {BYTEORDER_BYTES, 0};
#ifdef USE_56_INTERWORK_KLUDGE
static const char byteorderstr_56[] = {BYTEORDER_BYTES_56, 0};
#endif
#define STORABLE_BIN_MAJOR 2 /* Binary major "version" */
#define STORABLE_BIN_MINOR 7 /* Binary minor "version" */
#if (PATCHLEVEL <= 5)
#define STORABLE_BIN_WRITE_MINOR 4
#else
/*
* Perl 5.6.0 onwards can do weak references.
*/
#define STORABLE_BIN_WRITE_MINOR 7
#endif /* (PATCHLEVEL <= 5) */
#if (PATCHLEVEL < 8 || (PATCHLEVEL == 8 && SUBVERSION < 1))
#define PL_sv_placeholder PL_sv_undef
#endif
/*
* Useful store shortcuts...
*/
/*
* Note that if you put more than one mark for storing a particular
* type of thing, *and* in the retrieve_foo() function you mark both
* the thingy's you get off with SEEN(), you *must* increase the
* tagnum with cxt->tagnum++ along with this macro!
* - samv 20Jan04
*/
#define PUTMARK(x) \
STMT_START { \
if (!cxt->fio) \
MBUF_PUTC(x); \
else if (PerlIO_putc(cxt->fio, x) == EOF) \
return -1; \
} STMT_END
#define WRITE_I32(x) \
STMT_START { \
ASSERT(sizeof(x) == sizeof(I32), ("writing an I32")); \
if (!cxt->fio) \
MBUF_PUTINT(x); \
else if (PerlIO_write(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
return -1; \
} STMT_END
#ifdef HAS_HTONL
#define WLEN(x) \
STMT_START { \
if (cxt->netorder) { \
int y = (int) htonl(x); \
if (!cxt->fio) \
MBUF_PUTINT(y); \
else if (PerlIO_write(cxt->fio,oI(&y),oS(sizeof(y))) != oS(sizeof(y))) \
return -1; \
} else { \
if (!cxt->fio) \
MBUF_PUTINT(x); \
else if (PerlIO_write(cxt->fio,oI(&x),oS(sizeof(x))) != oS(sizeof(x))) \
return -1; \
} \
} STMT_END
#else
#define WLEN(x) WRITE_I32(x)
#endif
#define WRITE(x,y) \
STMT_START { \
if (!cxt->fio) \
MBUF_WRITE(x,y); \
else if (PerlIO_write(cxt->fio, x, y) != y) \
return -1; \
} STMT_END
#define STORE_PV_LEN(pv, len, small, large) \
STMT_START { \
if (len <= LG_SCALAR) { \
unsigned char clen = (unsigned char) len; \
PUTMARK(small); \
PUTMARK(clen); \
if (len) \
WRITE(pv, len); \
} else { \
PUTMARK(large); \
WLEN(len); \
WRITE(pv, len); \
} \
} STMT_END
#define STORE_SCALAR(pv, len) STORE_PV_LEN(pv, len, SX_SCALAR, SX_LSCALAR)
/*
* Store &PL_sv_undef in arrays without recursing through store().
*/
#define STORE_SV_UNDEF() \
STMT_START { \
cxt->tagnum++; \
PUTMARK(SX_SV_UNDEF); \
} STMT_END
/*
* Useful retrieve shortcuts...
*/
#define GETCHAR() \
(cxt->fio ? PerlIO_getc(cxt->fio) : (mptr >= mend ? EOF : (int) *mptr++))
#define GETMARK(x) \
STMT_START { \
if (!cxt->fio) \
MBUF_GETC(x); \
else if ((int) (x = PerlIO_getc(cxt->fio)) == EOF) \
return (SV *) 0; \
} STMT_END
#define READ_I32(x) \
STMT_START { \
ASSERT(sizeof(x) == sizeof(I32), ("reading an I32")); \
oC(x); \
if (!cxt->fio) \
MBUF_GETINT(x); \
else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
return (SV *) 0; \
} STMT_END
#ifdef HAS_NTOHL
#define RLEN(x) \
STMT_START { \
oC(x); \
if (!cxt->fio) \
MBUF_GETINT(x); \
else if (PerlIO_read(cxt->fio, oI(&x), oS(sizeof(x))) != oS(sizeof(x))) \
return (SV *) 0; \
if (cxt->netorder) \
x = (int) ntohl(x); \
} STMT_END
#else
#define RLEN(x) READ_I32(x)
#endif
#define READ(x,y) \
STMT_START { \
if (!cxt->fio) \
MBUF_READ(x, y); \
else if (PerlIO_read(cxt->fio, x, y) != y) \
return (SV *) 0; \
} STMT_END
#define SAFEREAD(x,y,z) \
STMT_START { \
if (!cxt->fio) \
MBUF_SAFEREAD(x,y,z); \
else if (PerlIO_read(cxt->fio, x, y) != y) { \
sv_free(z); \
return (SV *) 0; \
} \
} STMT_END
/*
* This macro is used at retrieve time, to remember where object 'y', bearing a
* given tag 'tagnum', has been retrieved. Next time we see an SX_OBJECT marker,
* we'll therefore know where it has been retrieved and will be able to
* share the same reference, as in the original stored memory image.
*
* We also need to bless objects ASAP for hooks (which may compute "ref $x"
* on the objects given to STORABLE_thaw and expect that to be defined), and
* also for overloaded objects (for which we might not find the stash if the
* object is not blessed yet--this might occur for overloaded objects that
* refer to themselves indirectly: if we blessed upon return from a sub
* retrieve(), the SX_OBJECT marker we'd found could not have overloading
* restored on it because the underlying object would not be blessed yet!).
*
* To achieve that, the class name of the last retrieved object is passed down
* recursively, and the first SEEN() call for which the class name is not NULL
* will bless the object.
*
* i should be true iff sv is immortal (ie PL_sv_yes, PL_sv_no or PL_sv_undef)
*/
#define SEEN(y,c,i) \
STMT_START { \
if (!y) \
return (SV *) 0; \
if (av_store(cxt->aseen, cxt->tagnum++, i ? (SV*)(y) : SvREFCNT_inc(y)) == 0) \
return (SV *) 0; \
TRACEME(("aseen(#%d) = 0x%"UVxf" (refcnt=%d)", cxt->tagnum-1, \
PTR2UV(y), SvREFCNT(y)-1)); \
if (c) \
BLESS((SV *) (y), c); \
} STMT_END
/*
* Bless `s' in `p', via a temporary reference, required by sv_bless().
*/
#define BLESS(s,p) \
STMT_START { \
SV *ref; \
HV *stash; \
TRACEME(("blessing 0x%"UVxf" in %s", PTR2UV(s), (p))); \
stash = gv_stashpv((p), TRUE); \
ref = newRV_noinc(s); \
(void) sv_bless(ref, stash); \
SvRV_set(ref, NULL); \
SvREFCNT_dec(ref); \
} STMT_END
/*
* sort (used in store_hash) - conditionally use qsort when
* sortsv is not available ( <= 5.6.1 ).
*/
#if (PATCHLEVEL <= 6)
#if defined(USE_ITHREADS)
#define STORE_HASH_SORT \
ENTER; { \
PerlInterpreter *orig_perl = PERL_GET_CONTEXT; \
SAVESPTR(orig_perl); \
PERL_SET_CONTEXT(aTHX); \
qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp); \
} LEAVE;
#else /* ! USE_ITHREADS */
#define STORE_HASH_SORT \
qsort((char *) AvARRAY(av), len, sizeof(SV *), sortcmp);
#endif /* USE_ITHREADS */
#else /* PATCHLEVEL > 6 */
#define STORE_HASH_SORT \
sortsv(AvARRAY(av), len, Perl_sv_cmp);
#endif /* PATCHLEVEL <= 6 */
static int store(pTHX_ stcxt_t *cxt, SV *sv);
static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname);
/*
* Dynamic dispatching table for SV store.
*/
static int store_ref(pTHX_ stcxt_t *cxt, SV *sv);
static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv);
static int store_array(pTHX_ stcxt_t *cxt, AV *av);
static int store_hash(pTHX_ stcxt_t *cxt, HV *hv);
static int store_tied(pTHX_ stcxt_t *cxt, SV *sv);
static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv);
static int store_code(pTHX_ stcxt_t *cxt, CV *cv);
static int store_other(pTHX_ stcxt_t *cxt, SV *sv);
static int store_blessed(pTHX_ stcxt_t *cxt, SV *sv, int type, HV *pkg);
typedef int (*sv_store_t)(pTHX_ stcxt_t *cxt, SV *sv);
static const sv_store_t sv_store[] = {
(sv_store_t)store_ref, /* svis_REF */
(sv_store_t)store_scalar, /* svis_SCALAR */
(sv_store_t)store_array, /* svis_ARRAY */
(sv_store_t)store_hash, /* svis_HASH */
(sv_store_t)store_tied, /* svis_TIED */
(sv_store_t)store_tied_item, /* svis_TIED_ITEM */
(sv_store_t)store_code, /* svis_CODE */
(sv_store_t)store_other, /* svis_OTHER */
};
#define SV_STORE(x) (*sv_store[x])
/*
* Dynamic dispatching tables for SV retrieval.
*/
static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname);
static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname);
typedef SV* (*sv_retrieve_t)(pTHX_ stcxt_t *cxt, char *name);
static const sv_retrieve_t sv_old_retrieve[] = {
0, /* SX_OBJECT -- entry unused dynamically */
(sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
(sv_retrieve_t)old_retrieve_array, /* SX_ARRAY -- for pre-0.6 binaries */
(sv_retrieve_t)old_retrieve_hash, /* SX_HASH -- for pre-0.6 binaries */
(sv_retrieve_t)retrieve_ref, /* SX_REF */
(sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
(sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
(sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
(sv_retrieve_t)retrieve_byte, /* SX_BYTE */
(sv_retrieve_t)retrieve_netint, /* SX_NETINT */
(sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
(sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
(sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
(sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
(sv_retrieve_t)retrieve_other, /* SX_SV_UNDEF not supported */
(sv_retrieve_t)retrieve_other, /* SX_SV_YES not supported */
(sv_retrieve_t)retrieve_other, /* SX_SV_NO not supported */
(sv_retrieve_t)retrieve_other, /* SX_BLESS not supported */
(sv_retrieve_t)retrieve_other, /* SX_IX_BLESS not supported */
(sv_retrieve_t)retrieve_other, /* SX_HOOK not supported */
(sv_retrieve_t)retrieve_other, /* SX_OVERLOADED not supported */
(sv_retrieve_t)retrieve_other, /* SX_TIED_KEY not supported */
(sv_retrieve_t)retrieve_other, /* SX_TIED_IDX not supported */
(sv_retrieve_t)retrieve_other, /* SX_UTF8STR not supported */
(sv_retrieve_t)retrieve_other, /* SX_LUTF8STR not supported */
(sv_retrieve_t)retrieve_other, /* SX_FLAG_HASH not supported */
(sv_retrieve_t)retrieve_other, /* SX_CODE not supported */
(sv_retrieve_t)retrieve_other, /* SX_WEAKREF not supported */
(sv_retrieve_t)retrieve_other, /* SX_WEAKOVERLOAD not supported */
(sv_retrieve_t)retrieve_other, /* SX_ERROR */
};
static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname);
static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname);
static const sv_retrieve_t sv_retrieve[] = {
0, /* SX_OBJECT -- entry unused dynamically */
(sv_retrieve_t)retrieve_lscalar, /* SX_LSCALAR */
(sv_retrieve_t)retrieve_array, /* SX_ARRAY */
(sv_retrieve_t)retrieve_hash, /* SX_HASH */
(sv_retrieve_t)retrieve_ref, /* SX_REF */
(sv_retrieve_t)retrieve_undef, /* SX_UNDEF */
(sv_retrieve_t)retrieve_integer, /* SX_INTEGER */
(sv_retrieve_t)retrieve_double, /* SX_DOUBLE */
(sv_retrieve_t)retrieve_byte, /* SX_BYTE */
(sv_retrieve_t)retrieve_netint, /* SX_NETINT */
(sv_retrieve_t)retrieve_scalar, /* SX_SCALAR */
(sv_retrieve_t)retrieve_tied_array, /* SX_ARRAY */
(sv_retrieve_t)retrieve_tied_hash, /* SX_HASH */
(sv_retrieve_t)retrieve_tied_scalar, /* SX_SCALAR */
(sv_retrieve_t)retrieve_sv_undef, /* SX_SV_UNDEF */
(sv_retrieve_t)retrieve_sv_yes, /* SX_SV_YES */
(sv_retrieve_t)retrieve_sv_no, /* SX_SV_NO */
(sv_retrieve_t)retrieve_blessed, /* SX_BLESS */
(sv_retrieve_t)retrieve_idx_blessed, /* SX_IX_BLESS */
(sv_retrieve_t)retrieve_hook, /* SX_HOOK */
(sv_retrieve_t)retrieve_overloaded, /* SX_OVERLOAD */
(sv_retrieve_t)retrieve_tied_key, /* SX_TIED_KEY */
(sv_retrieve_t)retrieve_tied_idx, /* SX_TIED_IDX */
(sv_retrieve_t)retrieve_utf8str, /* SX_UTF8STR */
(sv_retrieve_t)retrieve_lutf8str, /* SX_LUTF8STR */
(sv_retrieve_t)retrieve_flag_hash, /* SX_HASH */
(sv_retrieve_t)retrieve_code, /* SX_CODE */
(sv_retrieve_t)retrieve_weakref, /* SX_WEAKREF */
(sv_retrieve_t)retrieve_weakoverloaded, /* SX_WEAKOVERLOAD */
(sv_retrieve_t)retrieve_other, /* SX_ERROR */
};
#define RETRIEVE(c,x) (*(c)->retrieve_vtbl[(x) >= SX_ERROR ? SX_ERROR : (x)])
static SV *mbuf2sv(pTHX);
/***
*** Context management.
***/
/*
* init_perinterp
*
* Called once per "thread" (interpreter) to initialize some global context.
*/
static void init_perinterp(pTHX)
{
INIT_STCXT;
cxt->netorder = 0; /* true if network order used */
cxt->forgive_me = -1; /* whether to be forgiving... */
cxt->accept_future_minor = -1; /* would otherwise occur too late */
}
/*
* reset_context
*
* Called at the end of every context cleaning, to perform common reset
* operations.
*/
static void reset_context(stcxt_t *cxt)
{
cxt->entry = 0;
cxt->s_dirty = 0;
cxt->optype &= ~(ST_STORE|ST_RETRIEVE); /* Leave ST_CLONE alone */
}
/*
* init_store_context
*
* Initialize a new store context for real recursion.
*/
static void init_store_context(
pTHX_
stcxt_t *cxt,
PerlIO *f,
int optype,
int network_order)
{
TRACEME(("init_store_context"));
cxt->netorder = network_order;
cxt->forgive_me = -1; /* Fetched from perl if needed */
cxt->deparse = -1; /* Idem */
cxt->eval = NULL; /* Idem */
cxt->canonical = -1; /* Idem */
cxt->tagnum = -1; /* Reset tag numbers */
cxt->classnum = -1; /* Reset class numbers */
cxt->fio = f; /* Where I/O are performed */
cxt->optype = optype; /* A store, or a deep clone */
cxt->entry = 1; /* No recursion yet */
/*
* The `hseen' table is used to keep track of each SV stored and their
* associated tag numbers is special. It is "abused" because the
* values stored are not real SV, just integers cast to (SV *),
* which explains the freeing below.
*
* It is also one possible bottlneck to achieve good storing speed,
* so the "shared keys" optimization is turned off (unlikely to be
* of any use here), and the hash table is "pre-extended". Together,
* those optimizations increase the throughput by 12%.
*/
#ifdef USE_PTR_TABLE
cxt->pseen = ptr_table_new();
cxt->hseen = 0;
#else
cxt->hseen = newHV(); /* Table where seen objects are stored */
HvSHAREKEYS_off(cxt->hseen);
#endif
/*
* The following does not work well with perl5.004_04, and causes
* a core dump later on, in a completely unrelated spot, which
* makes me think there is a memory corruption going on.
*
* Calling hv_ksplit(hseen, HBUCKETS) instead of manually hacking
* it below does not make any difference. It seems to work fine
* with perl5.004_68 but given the probable nature of the bug,
* that does not prove anything.
*
* It's a shame because increasing the amount of buckets raises
* store() throughput by 5%, but until I figure this out, I can't
* allow for this to go into production.
*
* It is reported fixed in 5.005, hence the #if.
*/
#if PERL_VERSION >= 5
#define HBUCKETS 4096 /* Buckets for %hseen */
#ifndef USE_PTR_TABLE
HvMAX(cxt->hseen) = HBUCKETS - 1; /* keys %hseen = $HBUCKETS; */
#endif
#endif
/*
* The `hclass' hash uses the same settings as `hseen' above, but it is
* used to assign sequential tags (numbers) to class names for blessed
* objects.
*
* We turn the shared key optimization on.
*/
cxt->hclass = newHV(); /* Where seen classnames are stored */
#if PERL_VERSION >= 5
HvMAX(cxt->hclass) = HBUCKETS - 1; /* keys %hclass = $HBUCKETS; */
#endif
/*
* The `hook' hash table is used to keep track of the references on
* the STORABLE_freeze hook routines, when found in some class name.
*
* It is assumed that the inheritance tree will not be changed during
* storing, and that no new method will be dynamically created by the
* hooks.
*/
cxt->hook = newHV(); /* Table where hooks are cached */
/*
* The `hook_seen' array keeps track of all the SVs returned by
* STORABLE_freeze hooks for us to serialize, so that they are not
* reclaimed until the end of the serialization process. Each SV is
* only stored once, the first time it is seen.
*/
cxt->hook_seen = newAV(); /* Lists SVs returned by STORABLE_freeze */
}
/*
* clean_store_context
*
* Clean store context by
*/
static void clean_store_context(pTHX_ stcxt_t *cxt)
{
HE *he;
TRACEME(("clean_store_context"));
ASSERT(cxt->optype & ST_STORE, ("was performing a store()"));
/*
* Insert real values into hashes where we stored faked pointers.
*/
#ifndef USE_PTR_TABLE
if (cxt->hseen) {
hv_iterinit(cxt->hseen);
while ((he = hv_iternext(cxt->hseen))) /* Extra () for -Wall, grr.. */
HeVAL(he) = &PL_sv_undef;
}
#endif
if (cxt->hclass) {
hv_iterinit(cxt->hclass);
while ((he = hv_iternext(cxt->hclass))) /* Extra () for -Wall, grr.. */
HeVAL(he) = &PL_sv_undef;
}
/*
* And now dispose of them...
*
* The surrounding if() protection has been added because there might be
* some cases where this routine is called more than once, during
* exceptionnal events. This was reported by Marc Lehmann when Storable
* is executed from mod_perl, and the fix was suggested by him.
* -- RAM, 20/12/2000
*/
#ifdef USE_PTR_TABLE
if (cxt->pseen) {
struct ptr_tbl *pseen = cxt->pseen;
cxt->pseen = 0;
ptr_table_free(pseen);
}
assert(!cxt->hseen);
#else
if (cxt->hseen) {
HV *hseen = cxt->hseen;
cxt->hseen = 0;
hv_undef(hseen);
sv_free((SV *) hseen);
}
#endif
if (cxt->hclass) {
HV *hclass = cxt->hclass;
cxt->hclass = 0;
hv_undef(hclass);
sv_free((SV *) hclass);
}
if (cxt->hook) {
HV *hook = cxt->hook;
cxt->hook = 0;
hv_undef(hook);
sv_free((SV *) hook);
}
if (cxt->hook_seen) {
AV *hook_seen = cxt->hook_seen;
cxt->hook_seen = 0;
av_undef(hook_seen);
sv_free((SV *) hook_seen);
}
cxt->forgive_me = -1; /* Fetched from perl if needed */
cxt->deparse = -1; /* Idem */
if (cxt->eval) {
SvREFCNT_dec(cxt->eval);
}
cxt->eval = NULL; /* Idem */
cxt->canonical = -1; /* Idem */
reset_context(cxt);
}
/*
* init_retrieve_context
*
* Initialize a new retrieve context for real recursion.
*/
static void init_retrieve_context(pTHX_ stcxt_t *cxt, int optype, int is_tainted)
{
TRACEME(("init_retrieve_context"));
/*
* The hook hash table is used to keep track of the references on
* the STORABLE_thaw hook routines, when found in some class name.
*
* It is assumed that the inheritance tree will not be changed during
* storing, and that no new method will be dynamically created by the
* hooks.
*/
cxt->hook = newHV(); /* Caches STORABLE_thaw */
#ifdef USE_PTR_TABLE
cxt->pseen = 0;
#endif
/*
* If retrieving an old binary version, the cxt->retrieve_vtbl variable
* was set to sv_old_retrieve. We'll need a hash table to keep track of
* the correspondance between the tags and the tag number used by the
* new retrieve routines.
*/
cxt->hseen = (((void*)cxt->retrieve_vtbl == (void*)sv_old_retrieve)
? newHV() : 0);
cxt->aseen = newAV(); /* Where retrieved objects are kept */
cxt->where_is_undef = -1; /* Special case for PL_sv_undef */
cxt->aclass = newAV(); /* Where seen classnames are kept */
cxt->tagnum = 0; /* Have to count objects... */
cxt->classnum = 0; /* ...and class names as well */
cxt->optype = optype;
cxt->s_tainted = is_tainted;
cxt->entry = 1; /* No recursion yet */
#ifndef HAS_RESTRICTED_HASHES
cxt->derestrict = -1; /* Fetched from perl if needed */
#endif
#ifndef HAS_UTF8_ALL
cxt->use_bytes = -1; /* Fetched from perl if needed */
#endif
cxt->accept_future_minor = -1; /* Fetched from perl if needed */
}
/*
* clean_retrieve_context
*
* Clean retrieve context by
*/
static void clean_retrieve_context(pTHX_ stcxt_t *cxt)
{
TRACEME(("clean_retrieve_context"));
ASSERT(cxt->optype & ST_RETRIEVE, ("was performing a retrieve()"));
if (cxt->aseen) {
AV *aseen = cxt->aseen;
cxt->aseen = 0;
av_undef(aseen);
sv_free((SV *) aseen);
}
cxt->where_is_undef = -1;
if (cxt->aclass) {
AV *aclass = cxt->aclass;
cxt->aclass = 0;
av_undef(aclass);
sv_free((SV *) aclass);
}
if (cxt->hook) {
HV *hook = cxt->hook;
cxt->hook = 0;
hv_undef(hook);
sv_free((SV *) hook);
}
if (cxt->hseen) {
HV *hseen = cxt->hseen;
cxt->hseen = 0;
hv_undef(hseen);
sv_free((SV *) hseen); /* optional HV, for backward compat. */
}
#ifndef HAS_RESTRICTED_HASHES
cxt->derestrict = -1; /* Fetched from perl if needed */
#endif
#ifndef HAS_UTF8_ALL
cxt->use_bytes = -1; /* Fetched from perl if needed */
#endif
cxt->accept_future_minor = -1; /* Fetched from perl if needed */
reset_context(cxt);
}
/*
* clean_context
*
* A workaround for the CROAK bug: cleanup the last context.
*/
static void clean_context(pTHX_ stcxt_t *cxt)
{
TRACEME(("clean_context"));
ASSERT(cxt->s_dirty, ("dirty context"));
if (cxt->membuf_ro)
MBUF_RESTORE();
ASSERT(!cxt->membuf_ro, ("mbase is not read-only"));
if (cxt->optype & ST_RETRIEVE)
clean_retrieve_context(aTHX_ cxt);
else if (cxt->optype & ST_STORE)
clean_store_context(aTHX_ cxt);
else
reset_context(cxt);
ASSERT(!cxt->s_dirty, ("context is clean"));
ASSERT(cxt->entry == 0, ("context is reset"));
}
/*
* allocate_context
*
* Allocate a new context and push it on top of the parent one.
* This new context is made globally visible via SET_STCXT().
*/
static stcxt_t *allocate_context(pTHX_ stcxt_t *parent_cxt)
{
stcxt_t *cxt;
TRACEME(("allocate_context"));
ASSERT(!parent_cxt->s_dirty, ("parent context clean"));
NEW_STORABLE_CXT_OBJ(cxt);
cxt->prev = parent_cxt->my_sv;
SET_STCXT(cxt);
ASSERT(!cxt->s_dirty, ("clean context"));
return cxt;
}
/*
* free_context
*
* Free current context, which cannot be the "root" one.
* Make the context underneath globally visible via SET_STCXT().
*/
static void free_context(pTHX_ stcxt_t *cxt)
{
stcxt_t *prev = (stcxt_t *)(cxt->prev ? SvPVX(SvRV(cxt->prev)) : 0);
TRACEME(("free_context"));
ASSERT(!cxt->s_dirty, ("clean context"));
ASSERT(prev, ("not freeing root context"));
SvREFCNT_dec(cxt->my_sv);
SET_STCXT(prev);
ASSERT(cxt, ("context not void"));
}
/***
*** Predicates.
***/
/*
* is_storing
*
* Tells whether we're in the middle of a store operation.
*/
int is_storing(pTHX)
{
dSTCXT;
return cxt->entry && (cxt->optype & ST_STORE);
}
/*
* is_retrieving
*
* Tells whether we're in the middle of a retrieve operation.
*/
int is_retrieving(pTHX)
{
dSTCXT;
return cxt->entry && (cxt->optype & ST_RETRIEVE);
}
/*
* last_op_in_netorder
*
* Returns whether last operation was made using network order.
*
* This is typically out-of-band information that might prove useful
* to people wishing to convert native to network order data when used.
*/
int last_op_in_netorder(pTHX)
{
dSTCXT;
return cxt->netorder;
}
/***
*** Hook lookup and calling routines.
***/
/*
* pkg_fetchmeth
*
* A wrapper on gv_fetchmethod_autoload() which caches results.
*
* Returns the routine reference as an SV*, or null if neither the package
* nor its ancestors know about the method.
*/
static SV *pkg_fetchmeth(
pTHX_
HV *cache,
HV *pkg,
char *method)
{
GV *gv;
SV *sv;
/*
* The following code is the same as the one performed by UNIVERSAL::can
* in the Perl core.
*/
gv = gv_fetchmethod_autoload(pkg, method, FALSE);
if (gv && isGV(gv)) {
sv = newRV((SV*) GvCV(gv));
TRACEME(("%s->%s: 0x%"UVxf, HvNAME(pkg), method, PTR2UV(sv)));
} else {
sv = newSVsv(&PL_sv_undef);
TRACEME(("%s->%s: not found", HvNAME(pkg), method));
}
/*
* Cache the result, ignoring failure: if we can't store the value,
* it just won't be cached.
*/
(void) hv_store(cache, HvNAME(pkg), strlen(HvNAME(pkg)), sv, 0);
return SvOK(sv) ? sv : (SV *) 0;
}
/*
* pkg_hide
*
* Force cached value to be undef: hook ignored even if present.
*/
static void pkg_hide(
pTHX_
HV *cache,
HV *pkg,
char *method)
{
(void) hv_store(cache,
HvNAME(pkg), strlen(HvNAME(pkg)), newSVsv(&PL_sv_undef), 0);
}
/*
* pkg_uncache
*
* Discard cached value: a whole fetch loop will be retried at next lookup.
*/
static void pkg_uncache(
pTHX_
HV *cache,
HV *pkg,
char *method)
{
(void) hv_delete(cache, HvNAME(pkg), strlen(HvNAME(pkg)), G_DISCARD);
}
/*
* pkg_can
*
* Our own "UNIVERSAL::can", which caches results.
*
* Returns the routine reference as an SV*, or null if the object does not
* know about the method.
*/
static SV *pkg_can(
pTHX_
HV *cache,
HV *pkg,
char *method)
{
SV **svh;
SV *sv;
TRACEME(("pkg_can for %s->%s", HvNAME(pkg), method));
/*
* Look into the cache to see whether we already have determined
* where the routine was, if any.
*
* NOTA BENE: we don't use `method' at all in our lookup, since we know
* that only one hook (i.e. always the same) is cached in a given cache.
*/
svh = hv_fetch(cache, HvNAME(pkg), strlen(HvNAME(pkg)), FALSE);
if (svh) {
sv = *svh;
if (!SvOK(sv)) {
TRACEME(("cached %s->%s: not found", HvNAME(pkg), method));
return (SV *) 0;
} else {
TRACEME(("cached %s->%s: 0x%"UVxf,
HvNAME(pkg), method, PTR2UV(sv)));
return sv;
}
}
TRACEME(("not cached yet"));
return pkg_fetchmeth(aTHX_ cache, pkg, method); /* Fetch and cache */
}
/*
* scalar_call
*
* Call routine as obj->hook(av) in scalar context.
* Propagates the single returned value if not called in void context.
*/
static SV *scalar_call(
pTHX_
SV *obj,
SV *hook,
int cloning,
AV *av,
I32 flags)
{
dSP;
int count;
SV *sv = 0;
TRACEME(("scalar_call (cloning=%d)", cloning));
ENTER;
SAVETMPS;
PUSHMARK(sp);
XPUSHs(obj);
XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
if (av) {
SV **ary = AvARRAY(av);
int cnt = AvFILLp(av) + 1;
int i;
XPUSHs(ary[0]); /* Frozen string */
for (i = 1; i < cnt; i++) {
TRACEME(("pushing arg #%d (0x%"UVxf")...",
i, PTR2UV(ary[i])));
XPUSHs(sv_2mortal(newRV(ary[i])));
}
}
PUTBACK;
TRACEME(("calling..."));
count = perl_call_sv(hook, flags); /* Go back to Perl code */
TRACEME(("count = %d", count));
SPAGAIN;
if (count) {
sv = POPs;
SvREFCNT_inc(sv); /* We're returning it, must stay alive! */
}
PUTBACK;
FREETMPS;
LEAVE;
return sv;
}
/*
* array_call
*
* Call routine obj->hook(cloning) in list context.
* Returns the list of returned values in an array.
*/
static AV *array_call(
pTHX_
SV *obj,
SV *hook,
int cloning)
{
dSP;
int count;
AV *av;
int i;
TRACEME(("array_call (cloning=%d)", cloning));
ENTER;
SAVETMPS;
PUSHMARK(sp);
XPUSHs(obj); /* Target object */
XPUSHs(sv_2mortal(newSViv(cloning))); /* Cloning flag */
PUTBACK;
count = perl_call_sv(hook, G_ARRAY); /* Go back to Perl code */
SPAGAIN;
av = newAV();
for (i = count - 1; i >= 0; i--) {
SV *sv = POPs;
av_store(av, i, SvREFCNT_inc(sv));
}
PUTBACK;
FREETMPS;
LEAVE;
return av;
}
/*
* known_class
*
* Lookup the class name in the `hclass' table and either assign it a new ID
* or return the existing one, by filling in `classnum'.
*
* Return true if the class was known, false if the ID was just generated.
*/
static int known_class(
pTHX_
stcxt_t *cxt,
char *name, /* Class name */
int len, /* Name length */
I32 *classnum)
{
SV **svh;
HV *hclass = cxt->hclass;
TRACEME(("known_class (%s)", name));
/*
* Recall that we don't store pointers in this hash table, but tags.
* Therefore, we need LOW_32BITS() to extract the relevant parts.
*/
svh = hv_fetch(hclass, name, len, FALSE);
if (svh) {
*classnum = LOW_32BITS(*svh);
return TRUE;
}
/*
* Unknown classname, we need to record it.
*/
cxt->classnum++;
if (!hv_store(hclass, name, len, INT2PTR(SV*, cxt->classnum), 0))
CROAK(("Unable to record new classname"));
*classnum = cxt->classnum;
return FALSE;
}
/***
*** Sepcific store routines.
***/
/*
* store_ref
*
* Store a reference.
* Layout is SX_REF <object> or SX_OVERLOAD <object>.
*/
static int store_ref(pTHX_ stcxt_t *cxt, SV *sv)
{
int is_weak = 0;
TRACEME(("store_ref (0x%"UVxf")", PTR2UV(sv)));
/*
* Follow reference, and check if target is overloaded.
*/
#ifdef SvWEAKREF
if (SvWEAKREF(sv))
is_weak = 1;
TRACEME(("ref (0x%"UVxf") is%s weak", PTR2UV(sv), is_weak ? "" : "n't"));
#endif
sv = SvRV(sv);
if (SvOBJECT(sv)) {
HV *stash = (HV *) SvSTASH(sv);
if (stash && Gv_AMG(stash)) {
TRACEME(("ref (0x%"UVxf") is overloaded", PTR2UV(sv)));
PUTMARK(is_weak ? SX_WEAKOVERLOAD : SX_OVERLOAD);
} else
PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
} else
PUTMARK(is_weak ? SX_WEAKREF : SX_REF);
return store(aTHX_ cxt, sv);
}
/*
* store_scalar
*
* Store a scalar.
*
* Layout is SX_LSCALAR <length> <data>, SX_SCALAR <length> <data> or SX_UNDEF.
* The <data> section is omitted if <length> is 0.
*
* If integer or double, the layout is SX_INTEGER <data> or SX_DOUBLE <data>.
* Small integers (within [-127, +127]) are stored as SX_BYTE <byte>.
*/
static int store_scalar(pTHX_ stcxt_t *cxt, SV *sv)
{
IV iv;
char *pv;
STRLEN len;
U32 flags = SvFLAGS(sv); /* "cc -O" may put it in register */
TRACEME(("store_scalar (0x%"UVxf")", PTR2UV(sv)));
/*
* For efficiency, break the SV encapsulation by peaking at the flags
* directly without using the Perl macros to avoid dereferencing
* sv->sv_flags each time we wish to check the flags.
*/
if (!(flags & SVf_OK)) { /* !SvOK(sv) */
if (sv == &PL_sv_undef) {
TRACEME(("immortal undef"));
PUTMARK(SX_SV_UNDEF);
} else {
TRACEME(("undef at 0x%"UVxf, PTR2UV(sv)));
PUTMARK(SX_UNDEF);
}
return 0;
}
/*
* Always store the string representation of a scalar if it exists.
* Gisle Aas provided me with this test case, better than a long speach:
*
* perl -MDevel::Peek -le '$a="abc"; $a+0; Dump($a)'
* SV = PVNV(0x80c8520)
* REFCNT = 1
* FLAGS = (NOK,POK,pNOK,pPOK)
* IV = 0
* NV = 0
* PV = 0x80c83d0 "abc"\0
* CUR = 3
* LEN = 4
*
* Write SX_SCALAR, length, followed by the actual data.
*
* Otherwise, write an SX_BYTE, SX_INTEGER or an SX_DOUBLE as
* appropriate, followed by the actual (binary) data. A double
* is written as a string if network order, for portability.
*
* NOTE: instead of using SvNOK(sv), we test for SvNOKp(sv).
* The reason is that when the scalar value is tainted, the SvNOK(sv)
* value is false.
*
* The test for a read-only scalar with both POK and NOK set is meant
* to quickly detect &PL_sv_yes and &PL_sv_no without having to pay the
* address comparison for each scalar we store.
*/
#define SV_MAYBE_IMMORTAL (SVf_READONLY|SVf_POK|SVf_NOK)
if ((flags & SV_MAYBE_IMMORTAL) == SV_MAYBE_IMMORTAL) {
if (sv == &PL_sv_yes) {
TRACEME(("immortal yes"));
PUTMARK(SX_SV_YES);
} else if (sv == &PL_sv_no) {
TRACEME(("immortal no"));
PUTMARK(SX_SV_NO);
} else {
pv = SvPV(sv, len); /* We know it's SvPOK */
goto string; /* Share code below */
}
} else if (flags & SVf_POK) {
/* public string - go direct to string read. */
goto string_readlen;
} else if (
#if (PATCHLEVEL <= 6)
/* For 5.6 and earlier NV flag trumps IV flag, so only use integer
direct if NV flag is off. */
(flags & (SVf_NOK | SVf_IOK)) == SVf_IOK
#else
/* 5.7 rules are that if IV public flag is set, IV value is as
good, if not better, than NV value. */
flags & SVf_IOK
#endif
) {
iv = SvIV(sv);
/*
* Will come here from below with iv set if double is an integer.
*/
integer:
/* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
#ifdef SVf_IVisUV
/* Need to do this out here, else 0xFFFFFFFF becomes iv of -1
* (for example) and that ends up in the optimised small integer
* case.
*/
if ((flags & SVf_IVisUV) && SvUV(sv) > IV_MAX) {
TRACEME(("large unsigned integer as string, value = %"UVuf, SvUV(sv)));
goto string_readlen;
}
#endif
/*
* Optimize small integers into a single byte, otherwise store as
* a real integer (converted into network order if they asked).
*/
if (iv >= -128 && iv <= 127) {
unsigned char siv = (unsigned char) (iv + 128); /* [0,255] */
PUTMARK(SX_BYTE);
PUTMARK(siv);
TRACEME(("small integer stored as %d", siv));
} else if (cxt->netorder) {
#ifndef HAS_HTONL
TRACEME(("no htonl, fall back to string for integer"));
goto string_readlen;
#else
I32 niv;
#if IVSIZE > 4
if (
#ifdef SVf_IVisUV
/* Sorry. This isn't in 5.005_56 (IIRC) or earlier. */
((flags & SVf_IVisUV) && SvUV(sv) > 0x7FFFFFFF) ||
#endif
(iv > 0x7FFFFFFF) || (iv < -0x80000000)) {
/* Bigger than 32 bits. */
TRACEME(("large network order integer as string, value = %"IVdf, iv));
goto string_readlen;
}
#endif
niv = (I32) htonl((I32) iv);
TRACEME(("using network order"));
PUTMARK(SX_NETINT);
WRITE_I32(niv);
#endif
} else {
PUTMARK(SX_INTEGER);
WRITE(&iv, sizeof(iv));
}
TRACEME(("ok (integer 0x%"UVxf", value = %"IVdf")", PTR2UV(sv), iv));
} else if (flags & SVf_NOK) {
NV nv;
#if (PATCHLEVEL <= 6)
nv = SvNV(sv);
/*
* Watch for number being an integer in disguise.
*/
if (nv == (NV) (iv = I_V(nv))) {
TRACEME(("double %"NVff" is actually integer %"IVdf, nv, iv));
goto integer; /* Share code above */
}
#else
SvIV_please(sv);
if (SvIOK_notUV(sv)) {
iv = SvIV(sv);
goto integer; /* Share code above */
}
nv = SvNV(sv);
#endif
if (cxt->netorder) {
TRACEME(("double %"NVff" stored as string", nv));
goto string_readlen; /* Share code below */
}
PUTMARK(SX_DOUBLE);
WRITE(&nv, sizeof(nv));
TRACEME(("ok (double 0x%"UVxf", value = %"NVff")", PTR2UV(sv), nv));
} else if (flags & (SVp_POK | SVp_NOK | SVp_IOK)) {
I32 wlen; /* For 64-bit machines */
string_readlen:
pv = SvPV(sv, len);
/*
* Will come here from above if it was readonly, POK and NOK but
* neither &PL_sv_yes nor &PL_sv_no.
*/
string:
wlen = (I32) len; /* WLEN via STORE_SCALAR expects I32 */
if (SvUTF8 (sv))
STORE_UTF8STR(pv, wlen);
else
STORE_SCALAR(pv, wlen);
TRACEME(("ok (scalar 0x%"UVxf" '%s', length = %"IVdf")",
PTR2UV(sv), SvPVX(sv), (IV)len));
} else
CROAK(("Can't determine type of %s(0x%"UVxf")",
sv_reftype(sv, FALSE),
PTR2UV(sv)));
return 0; /* Ok, no recursion on scalars */
}
/*
* store_array
*
* Store an array.
*
* Layout is SX_ARRAY <size> followed by each item, in increading index order.
* Each item is stored as <object>.
*/
static int store_array(pTHX_ stcxt_t *cxt, AV *av)
{
SV **sav;
I32 len = av_len(av) + 1;
I32 i;
int ret;
TRACEME(("store_array (0x%"UVxf")", PTR2UV(av)));
/*
* Signal array by emitting SX_ARRAY, followed by the array length.
*/
PUTMARK(SX_ARRAY);
WLEN(len);
TRACEME(("size = %d", len));
/*
* Now store each item recursively.
*/
for (i = 0; i < len; i++) {
sav = av_fetch(av, i, 0);
if (!sav) {
TRACEME(("(#%d) undef item", i));
STORE_SV_UNDEF();
continue;
}
TRACEME(("(#%d) item", i));
if ((ret = store(aTHX_ cxt, *sav))) /* Extra () for -Wall, grr... */
return ret;
}
TRACEME(("ok (array)"));
return 0;
}
#if (PATCHLEVEL <= 6)
/*
* sortcmp
*
* Sort two SVs
* Borrowed from perl source file pp_ctl.c, where it is used by pp_sort.
*/
static int
sortcmp(const void *a, const void *b)
{
#if defined(USE_ITHREADS)
dTHX;
#endif /* USE_ITHREADS */
return sv_cmp(*(SV * const *) a, *(SV * const *) b);
}
#endif /* PATCHLEVEL <= 6 */
/*
* store_hash
*
* Store a hash table.
*
* For a "normal" hash (not restricted, no utf8 keys):
*
* Layout is SX_HASH <size> followed by each key/value pair, in random order.
* Values are stored as <object>.
* Keys are stored as <length> <data>, the <data> section being omitted
* if length is 0.
*
* For a "fancy" hash (restricted or utf8 keys):
*
* Layout is SX_FLAG_HASH <size> <hash flags> followed by each key/value pair,
* in random order.
* Values are stored as <object>.
* Keys are stored as <flags> <length> <data>, the <data> section being omitted
* if length is 0.
* Currently the only hash flag is "restriced"
* Key flags are as for hv.h
*/
static int store_hash(pTHX_ stcxt_t *cxt, HV *hv)
{
dVAR;
I32 len =
#ifdef HAS_RESTRICTED_HASHES
HvTOTALKEYS(hv);
#else
HvKEYS(hv);
#endif
I32 i;
int ret = 0;
I32 riter;
HE *eiter;
int flagged_hash = ((SvREADONLY(hv)
#ifdef HAS_HASH_KEY_FLAGS
|| HvHASKFLAGS(hv)
#endif
) ? 1 : 0);
unsigned char hash_flags = (SvREADONLY(hv) ? SHV_RESTRICTED : 0);
if (flagged_hash) {
/* needs int cast for C++ compilers, doesn't it? */
TRACEME(("store_hash (0x%"UVxf") (flags %x)", PTR2UV(hv),
(int) hash_flags));
} else {
TRACEME(("store_hash (0x%"UVxf")", PTR2UV(hv)));
}
/*
* Signal hash by emitting SX_HASH, followed by the table length.
*/
if (flagged_hash) {
PUTMARK(SX_FLAG_HASH);
PUTMARK(hash_flags);
} else {
PUTMARK(SX_HASH);
}
WLEN(len);
TRACEME(("size = %d", len));
/*
* Save possible iteration state via each() on that table.
*/
riter = HvRITER(hv);
eiter = HvEITER(hv);
hv_iterinit(hv);
/*
* Now store each item recursively.
*
* If canonical is defined to some true value then store each
* key/value pair in sorted order otherwise the order is random.
* Canonical order is irrelevant when a deep clone operation is performed.
*
* Fetch the value from perl only once per store() operation, and only
* when needed.
*/
if (
!(cxt->optype & ST_CLONE) && (cxt->canonical == 1 ||
(cxt->canonical < 0 && (cxt->canonical =
(SvTRUE(perl_get_sv("Storable::canonical", TRUE)) ? 1 : 0))))
) {
/*
* Storing in order, sorted by key.
* Run through the hash, building up an array of keys in a
* mortal array, sort the array and then run through the
* array.
*/
AV *av = newAV();
/*av_extend (av, len);*/
TRACEME(("using canonical order"));
for (i = 0; i < len; i++) {
#ifdef HAS_RESTRICTED_HASHES
HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
#else
HE *he = hv_iternext(hv);
#endif
SV *key = hv_iterkeysv(he);
av_store(av, AvFILLp(av)+1, key); /* av_push(), really */
}
STORE_HASH_SORT;
for (i = 0; i < len; i++) {
#ifdef HAS_RESTRICTED_HASHES
int placeholders = (int)HvPLACEHOLDERS(hv);
#endif
unsigned char flags = 0;
char *keyval;
STRLEN keylen_tmp;
I32 keylen;
SV *key = av_shift(av);
/* This will fail if key is a placeholder.
Track how many placeholders we have, and error if we
"see" too many. */
HE *he = hv_fetch_ent(hv, key, 0, 0);
SV *val;
if (he) {
if (!(val = HeVAL(he))) {
/* Internal error, not I/O error */
return 1;
}
} else {
#ifdef HAS_RESTRICTED_HASHES
/* Should be a placeholder. */
if (placeholders-- < 0) {
/* This should not happen - number of
retrieves should be identical to
number of placeholders. */
return 1;
}
/* Value is never needed, and PL_sv_undef is
more space efficient to store. */
val = &PL_sv_undef;
ASSERT (flags == 0,
("Flags not 0 but %d", flags));
flags = SHV_K_PLACEHOLDER;
#else
return 1;
#endif
}
/*
* Store value first.
*/
TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
goto out;
/*
* Write key string.
* Keys are written after values to make sure retrieval
* can be optimal in terms of memory usage, where keys are
* read into a fixed unique buffer called kbuf.
* See retrieve_hash() for details.
*/
/* Implementation of restricted hashes isn't nicely
abstracted: */
if ((hash_flags & SHV_RESTRICTED) && SvREADONLY(val)) {
flags |= SHV_K_LOCKED;
}
keyval = SvPV(key, keylen_tmp);
keylen = keylen_tmp;
#ifdef HAS_UTF8_HASHES
/* If you build without optimisation on pre 5.6
then nothing spots that SvUTF8(key) is always 0,
so the block isn't optimised away, at which point
the linker dislikes the reference to
bytes_from_utf8. */
if (SvUTF8(key)) {
const char *keysave = keyval;
bool is_utf8 = TRUE;
/* Just casting the &klen to (STRLEN) won't work
well if STRLEN and I32 are of different widths.
--jhi */
keyval = (char*)bytes_from_utf8((U8*)keyval,
&keylen_tmp,
&is_utf8);
/* If we were able to downgrade here, then than
means that we have a key which only had chars
0-255, but was utf8 encoded. */
if (keyval != keysave) {
keylen = keylen_tmp;
flags |= SHV_K_WASUTF8;
} else {
/* keylen_tmp can't have changed, so no need
to assign back to keylen. */
flags |= SHV_K_UTF8;
}
}
#endif
if (flagged_hash) {
PUTMARK(flags);
TRACEME(("(#%d) key '%s' flags %x %u", i, keyval, flags, *keyval));
} else {
/* This is a workaround for a bug in 5.8.0
that causes the HEK_WASUTF8 flag to be
set on an HEK without the hash being
marked as having key flags. We just
cross our fingers and drop the flag.
AMS 20030901 */
assert (flags == 0 || flags == SHV_K_WASUTF8);
TRACEME(("(#%d) key '%s'", i, keyval));
}
WLEN(keylen);
if (keylen)
WRITE(keyval, keylen);
if (flags & SHV_K_WASUTF8)
Safefree (keyval);
}
/*
* Free up the temporary array
*/
av_undef(av);
sv_free((SV *) av);
} else {
/*
* Storing in "random" order (in the order the keys are stored
* within the hash). This is the default and will be faster!
*/
for (i = 0; i < len; i++) {
char *key;
I32 len;
unsigned char flags;
#ifdef HV_ITERNEXT_WANTPLACEHOLDERS
HE *he = hv_iternext_flags(hv, HV_ITERNEXT_WANTPLACEHOLDERS);
#else
HE *he = hv_iternext(hv);
#endif
SV *val = (he ? hv_iterval(hv, he) : 0);
SV *key_sv = NULL;
HEK *hek;
if (val == 0)
return 1; /* Internal error, not I/O error */
/* Implementation of restricted hashes isn't nicely
abstracted: */
flags
= (((hash_flags & SHV_RESTRICTED)
&& SvREADONLY(val))
? SHV_K_LOCKED : 0);
if (val == &PL_sv_placeholder) {
flags |= SHV_K_PLACEHOLDER;
val = &PL_sv_undef;
}
/*
* Store value first.
*/
TRACEME(("(#%d) value 0x%"UVxf, i, PTR2UV(val)));
if ((ret = store(aTHX_ cxt, val))) /* Extra () for -Wall, grr... */
goto out;
hek = HeKEY_hek(he);
len = HEK_LEN(hek);
if (len == HEf_SVKEY) {
/* This is somewhat sick, but the internal APIs are
* such that XS code could put one of these in in
* a regular hash.
* Maybe we should be capable of storing one if
* found.
*/
key_sv = HeKEY_sv(he);
flags |= SHV_K_ISSV;
} else {
/* Regular string key. */
#ifdef HAS_HASH_KEY_FLAGS
if (HEK_UTF8(hek))
flags |= SHV_K_UTF8;
if (HEK_WASUTF8(hek))
flags |= SHV_K_WASUTF8;
#endif
key = HEK_KEY(hek);
}
/*
* Write key string.
* Keys are written after values to make sure retrieval
* can be optimal in terms of memory usage, where keys are
* read into a fixed unique buffer called kbuf.
* See retrieve_hash() for details.
*/
if (flagged_hash) {
PUTMARK(flags);
TRACEME(("(#%d) key '%s' flags %x", i, key, flags));
} else {
/* This is a workaround for a bug in 5.8.0
that causes the HEK_WASUTF8 flag to be
set on an HEK without the hash being
marked as having key flags. We just
cross our fingers and drop the flag.
AMS 20030901 */
assert (flags == 0 || flags == SHV_K_WASUTF8);
TRACEME(("(#%d) key '%s'", i, key));
}
if (flags & SHV_K_ISSV) {
store(aTHX_ cxt, key_sv);
} else {
WLEN(len);
if (len)
WRITE(key, len);
}
}
}
TRACEME(("ok (hash 0x%"UVxf")", PTR2UV(hv)));
out:
HvRITER(hv) = riter; /* Restore hash iterator state */
HvEITER(hv) = eiter;
return ret;
}
/*
* store_code
*
* Store a code reference.
*
* Layout is SX_CODE <length> followed by a scalar containing the perl
* source code of the code reference.
*/
static int store_code(pTHX_ stcxt_t *cxt, CV *cv)
{
#if PERL_VERSION < 6
/*
* retrieve_code does not work with perl 5.005 or less
*/
return store_other(aTHX_ cxt, (SV*)cv);
#else
dSP;
I32 len;
int count, reallen;
SV *text, *bdeparse;
TRACEME(("store_code (0x%"UVxf")", PTR2UV(cv)));
if (
cxt->deparse == 0 ||
(cxt->deparse < 0 && !(cxt->deparse =
SvTRUE(perl_get_sv("Storable::Deparse", TRUE)) ? 1 : 0))
) {
return store_other(aTHX_ cxt, (SV*)cv);
}
/*
* Require B::Deparse. At least B::Deparse 0.61 is needed for
* blessed code references.
*/
/* Ownership of both SVs is passed to load_module, which frees them. */
load_module(PERL_LOADMOD_NOIMPORT, newSVpvn("B::Deparse",10), newSVnv(0.61));
ENTER;
SAVETMPS;
/*
* create the B::Deparse object
*/
PUSHMARK(sp);
XPUSHs(sv_2mortal(newSVpvn("B::Deparse",10)));
PUTBACK;
count = call_method("new", G_SCALAR);
SPAGAIN;
if (count != 1)
CROAK(("Unexpected return value from B::Deparse::new\n"));
bdeparse = POPs;
/*
* call the coderef2text method
*/
PUSHMARK(sp);
XPUSHs(bdeparse); /* XXX is this already mortal? */
XPUSHs(sv_2mortal(newRV_inc((SV*)cv)));
PUTBACK;
count = call_method("coderef2text", G_SCALAR);
SPAGAIN;
if (count != 1)
CROAK(("Unexpected return value from B::Deparse::coderef2text\n"));
text = POPs;
len = SvLEN(text);
reallen = strlen(SvPV_nolen(text));
/*
* Empty code references or XS functions are deparsed as
* "(prototype) ;" or ";".
*/
if (len == 0 || *(SvPV_nolen(text)+reallen-1) == ';') {
CROAK(("The result of B::Deparse::coderef2text was empty - maybe you're trying to serialize an XS function?\n"));
}
/*
* Signal code by emitting SX_CODE.
*/
PUTMARK(SX_CODE);
cxt->tagnum++; /* necessary, as SX_CODE is a SEEN() candidate */
TRACEME(("size = %d", len));
TRACEME(("code = %s", SvPV_nolen(text)));
/*
* Now store the source code.
*/
STORE_SCALAR(SvPV_nolen(text), len);
FREETMPS;
LEAVE;
TRACEME(("ok (code)"));
return 0;
#endif
}
/*
* store_tied
*
* When storing a tied object (be it a tied scalar, array or hash), we lay out
* a special mark, followed by the underlying tied object. For instance, when
* dealing with a tied hash, we store SX_TIED_HASH <hash object>, where
* <hash object> stands for the serialization of the tied hash.
*/
static int store_tied(pTHX_ stcxt_t *cxt, SV *sv)
{
MAGIC *mg;
SV *obj = NULL;
int ret = 0;
int svt = SvTYPE(sv);
char mtype = 'P';
TRACEME(("store_tied (0x%"UVxf")", PTR2UV(sv)));
/*
* We have a small run-time penalty here because we chose to factorise
* all tieds objects into the same routine, and not have a store_tied_hash,
* a store_tied_array, etc...
*
* Don't use a switch() statement, as most compilers don't optimize that
* well for 2/3 values. An if() else if() cascade is just fine. We put
* tied hashes first, as they are the most likely beasts.
*/
if (svt == SVt_PVHV) {
TRACEME(("tied hash"));
PUTMARK(SX_TIED_HASH); /* Introduces tied hash */
} else if (svt == SVt_PVAV) {
TRACEME(("tied array"));
PUTMARK(SX_TIED_ARRAY); /* Introduces tied array */
} else {
TRACEME(("tied scalar"));
PUTMARK(SX_TIED_SCALAR); /* Introduces tied scalar */
mtype = 'q';
}
if (!(mg = mg_find(sv, mtype)))
CROAK(("No magic '%c' found while storing tied %s", mtype,
(svt == SVt_PVHV) ? "hash" :
(svt == SVt_PVAV) ? "array" : "scalar"));
/*
* The mg->mg_obj found by mg_find() above actually points to the
* underlying tied Perl object implementation. For instance, if the
* original SV was that of a tied array, then mg->mg_obj is an AV.
*
* Note that we store the Perl object as-is. We don't call its FETCH
* method along the way. At retrieval time, we won't call its STORE
* method either, but the tieing magic will be re-installed. In itself,
* that ensures that the tieing semantics are preserved since futher
* accesses on the retrieved object will indeed call the magic methods...
*/
/* [#17040] mg_obj is NULL for scalar self-ties. AMS 20030416 */
obj = mg->mg_obj ? mg->mg_obj : newSV(0);
if ((ret = store(aTHX_ cxt, obj)))
return ret;
TRACEME(("ok (tied)"));
return 0;
}
/*
* store_tied_item
*
* Stores a reference to an item within a tied structure:
*
* . \$h{key}, stores both the (tied %h) object and 'key'.
* . \$a[idx], stores both the (tied @a) object and 'idx'.
*
* Layout is therefore either:
* SX_TIED_KEY <object> <key>
* SX_TIED_IDX <object> <index>
*/
static int store_tied_item(pTHX_ stcxt_t *cxt, SV *sv)
{
MAGIC *mg;
int ret;
TRACEME(("store_tied_item (0x%"UVxf")", PTR2UV(sv)));
if (!(mg = mg_find(sv, 'p')))
CROAK(("No magic 'p' found while storing reference to tied item"));
/*
* We discriminate between \$h{key} and \$a[idx] via mg_ptr.
*/
if (mg->mg_ptr) {
TRACEME(("store_tied_item: storing a ref to a tied hash item"));
PUTMARK(SX_TIED_KEY);
TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
return ret;
TRACEME(("store_tied_item: storing PTR 0x%"UVxf, PTR2UV(mg->mg_ptr)));
if ((ret = store(aTHX_ cxt, (SV *) mg->mg_ptr))) /* Idem, for -Wall */
return ret;
} else {
I32 idx = mg->mg_len;
TRACEME(("store_tied_item: storing a ref to a tied array item "));
PUTMARK(SX_TIED_IDX);
TRACEME(("store_tied_item: storing OBJ 0x%"UVxf, PTR2UV(mg->mg_obj)));
if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Idem, for -Wall */
return ret;
TRACEME(("store_tied_item: storing IDX %d", idx));
WLEN(idx);
}
TRACEME(("ok (tied item)"));
return 0;
}
/*
* store_hook -- dispatched manually, not via sv_store[]
*
* The blessed SV is serialized by a hook.
*
* Simple Layout is:
*
* SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
*
* where <flags> indicates how long <len>, <len2> and <len3> are, whether
* the trailing part [] is present, the type of object (scalar, array or hash).
* There is also a bit which says how the classname is stored between:
*
* <len> <classname>
* <index>
*
* and when the <index> form is used (classname already seen), the "large
* classname" bit in <flags> indicates how large the <index> is.
*
* The serialized string returned by the hook is of length <len2> and comes
* next. It is an opaque string for us.
*
* Those <len3> object IDs which are listed last represent the extra references
* not directly serialized by the hook, but which are linked to the object.
*
* When recursion is mandated to resolve object-IDs not yet seen, we have
* instead, with <header> being flags with bits set to indicate the object type
* and that recursion was indeed needed:
*
* SX_HOOK <header> <object> <header> <object> <flags>
*
* that same header being repeated between serialized objects obtained through
* recursion, until we reach flags indicating no recursion, at which point
* we know we've resynchronized with a single layout, after <flags>.
*
* When storing a blessed ref to a tied variable, the following format is
* used:
*
* SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
*
* The first <flags> indication carries an object of type SHT_EXTRA, and the
* real object type is held in the <extra> flag. At the very end of the
* serialization stream, the underlying magic object is serialized, just like
* any other tied variable.
*/
static int store_hook(
pTHX_
stcxt_t *cxt,
SV *sv,
int type,
HV *pkg,
SV *hook)
{
I32 len;
char *classname;
STRLEN len2;
SV *ref;
AV *av;
SV **ary;
int count; /* really len3 + 1 */
unsigned char flags;
char *pv;
int i;
int recursed = 0; /* counts recursion */
int obj_type; /* object type, on 2 bits */
I32 classnum;
int ret;
int clone = cxt->optype & ST_CLONE;
char mtype = '\0'; /* for blessed ref to tied structures */
unsigned char eflags = '\0'; /* used when object type is SHT_EXTRA */
TRACEME(("store_hook, classname \"%s\", tagged #%d", HvNAME(pkg), cxt->tagnum));
/*
* Determine object type on 2 bits.
*/
switch (type) {
case svis_SCALAR:
obj_type = SHT_SCALAR;
break;
case svis_ARRAY:
obj_type = SHT_ARRAY;
break;
case svis_HASH:
obj_type = SHT_HASH;
break;
case svis_TIED:
/*
* Produced by a blessed ref to a tied data structure, $o in the
* following Perl code.
*
* my %h;
* tie %h, 'FOO';
* my $o = bless \%h, 'BAR';
*
* Signal the tie-ing magic by setting the object type as SHT_EXTRA
* (since we have only 2 bits in <flags> to store the type), and an
* <extra> byte flag will be emitted after the FIRST <flags> in the
* stream, carrying what we put in `eflags'.
*/
obj_type = SHT_EXTRA;
switch (SvTYPE(sv)) {
case SVt_PVHV:
eflags = (unsigned char) SHT_THASH;
mtype = 'P';
break;
case SVt_PVAV:
eflags = (unsigned char) SHT_TARRAY;
mtype = 'P';
break;
default:
eflags = (unsigned char) SHT_TSCALAR;
mtype = 'q';
break;
}
break;
default:
CROAK(("Unexpected object type (%d) in store_hook()", type));
}
flags = SHF_NEED_RECURSE | obj_type;
classname = HvNAME(pkg);
len = strlen(classname);
/*
* To call the hook, we need to fake a call like:
*
* $object->STORABLE_freeze($cloning);
*
* but we don't have the $object here. For instance, if $object is
* a blessed array, what we have in `sv' is the array, and we can't
* call a method on those.
*
* Therefore, we need to create a temporary reference to the object and
* make the call on that reference.
*/
TRACEME(("about to call STORABLE_freeze on class %s", classname));
ref = newRV_noinc(sv); /* Temporary reference */
av = array_call(aTHX_ ref, hook, clone); /* @a = $object->STORABLE_freeze($c) */
SvRV_set(ref, NULL);
SvREFCNT_dec(ref); /* Reclaim temporary reference */
count = AvFILLp(av) + 1;
TRACEME(("store_hook, array holds %d items", count));
/*
* If they return an empty list, it means they wish to ignore the
* hook for this class (and not just this instance -- that's for them
* to handle if they so wish).
*
* Simply disable the cached entry for the hook (it won't be recomputed
* since it's present in the cache) and recurse to store_blessed().
*/
if (!count) {
/*
* They must not change their mind in the middle of a serialization.
*/
if (hv_fetch(cxt->hclass, classname, len, FALSE))
CROAK(("Too late to ignore hooks for %s class \"%s\"",
(cxt->optype & ST_CLONE) ? "cloning" : "storing", classname));
pkg_hide(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
ASSERT(!pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze"), ("hook invisible"));
TRACEME(("ignoring STORABLE_freeze in class \"%s\"", classname));
return store_blessed(aTHX_ cxt, sv, type, pkg);
}
/*
* Get frozen string.
*/
ary = AvARRAY(av);
pv = SvPV(ary[0], len2);
/* We can't use pkg_can here because it only caches one method per
* package */
{
GV* gv = gv_fetchmethod_autoload(pkg, "STORABLE_attach", FALSE);
if (gv && isGV(gv)) {
if (count > 1)
CROAK(("Freeze cannot return references if %s class is using STORABLE_attach", classname));
goto check_done;
}
}
/*
* If they returned more than one item, we need to serialize some
* extra references if not already done.
*
* Loop over the array, starting at position #1, and for each item,
* ensure it is a reference, serialize it if not already done, and
* replace the entry with the tag ID of the corresponding serialized
* object.
*
* We CHEAT by not calling av_fetch() and read directly within the
* array, for speed.
*/
for (i = 1; i < count; i++) {
#ifdef USE_PTR_TABLE
char *fake_tag;
#else
SV **svh;
#endif
SV *rsv = ary[i];
SV *xsv;
SV *tag;
AV *av_hook = cxt->hook_seen;
if (!SvROK(rsv))
CROAK(("Item #%d returned by STORABLE_freeze "
"for %s is not a reference", i, classname));
xsv = SvRV(rsv); /* Follow ref to know what to look for */
/*
* Look in hseen and see if we have a tag already.
* Serialize entry if not done already, and get its tag.
*/
#ifdef USE_PTR_TABLE
/* Fakery needed because ptr_table_fetch returns zero for a
failure, whereas the existing code assumes that it can
safely store a tag zero. So for ptr_tables we store tag+1
*/
if (fake_tag = ptr_table_fetch(cxt->pseen, xsv))
goto sv_seen; /* Avoid moving code too far to the right */
#else
if ((svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE)))
goto sv_seen; /* Avoid moving code too far to the right */
#endif
TRACEME(("listed object %d at 0x%"UVxf" is unknown", i-1, PTR2UV(xsv)));
/*
* We need to recurse to store that object and get it to be known
* so that we can resolve the list of object-IDs at retrieve time.
*
* The first time we do this, we need to emit the proper header
* indicating that we recursed, and what the type of object is (the
* object we're storing via a user-hook). Indeed, during retrieval,
* we'll have to create the object before recursing to retrieve the
* others, in case those would point back at that object.
*/
/* [SX_HOOK] <flags> [<extra>] <object>*/
if (!recursed++) {
PUTMARK(SX_HOOK);
PUTMARK(flags);
if (obj_type == SHT_EXTRA)
PUTMARK(eflags);
} else
PUTMARK(flags);
if ((ret = store(aTHX_ cxt, xsv))) /* Given by hook for us to store */
return ret;
#ifdef USE_PTR_TABLE
fake_tag = ptr_table_fetch(cxt->pseen, xsv);
if (!sv)
CROAK(("Could not serialize item #%d from hook in %s", i, classname));
#else
svh = hv_fetch(cxt->hseen, (char *) &xsv, sizeof(xsv), FALSE);
if (!svh)
CROAK(("Could not serialize item #%d from hook in %s", i, classname));
#endif
/*
* It was the first time we serialized `xsv'.
*
* Keep this SV alive until the end of the serialization: if we
* disposed of it right now by decrementing its refcount, and it was
* a temporary value, some next temporary value allocated during
* another STORABLE_freeze might take its place, and we'd wrongly
* assume that new SV was already serialized, based on its presence
* in cxt->hseen.
*
* Therefore, push it away in cxt->hook_seen.
*/
av_store(av_hook, AvFILLp(av_hook)+1, SvREFCNT_inc(xsv));
sv_seen:
/*
* Dispose of the REF they returned. If we saved the `xsv' away
* in the array of returned SVs, that will not cause the underlying
* referenced SV to be reclaimed.
*/
ASSERT(SvREFCNT(xsv) > 1, ("SV will survive disposal of its REF"));
SvREFCNT_dec(rsv); /* Dispose of reference */
/*
* Replace entry with its tag (not a real SV, so no refcnt increment)
*/
#ifdef USE_PTR_TABLE
tag = (SV *)--fake_tag;
#else
tag = *svh;
#endif
ary[i] = tag
TRACEME(("listed object %d at 0x%"UVxf" is tag #%"UVuf,
i-1, PTR2UV(xsv), PTR2UV(tag)));
}
/*
* Allocate a class ID if not already done.
*
* This needs to be done after the recursion above, since at retrieval
* time, we'll see the inner objects first. Many thanks to
* Salvador Ortiz Garcia <sog@msg.com.mx> who spot that bug and
* proposed the right fix. -- RAM, 15/09/2000
*/
check_done:
if (!known_class(aTHX_ cxt, classname, len, &classnum)) {
TRACEME(("first time we see class %s, ID = %d", classname, classnum));
classnum = -1; /* Mark: we must store classname */
} else {
TRACEME(("already seen class %s, ID = %d", classname, classnum));
}
/*
* Compute leading flags.
*/
flags = obj_type;
if (((classnum == -1) ? len : classnum) > LG_SCALAR)
flags |= SHF_LARGE_CLASSLEN;
if (classnum != -1)
flags |= SHF_IDX_CLASSNAME;
if (len2 > LG_SCALAR)
flags |= SHF_LARGE_STRLEN;
if (count > 1)
flags |= SHF_HAS_LIST;
if (count > (LG_SCALAR + 1))
flags |= SHF_LARGE_LISTLEN;
/*
* We're ready to emit either serialized form:
*
* SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
* SX_HOOK <flags> <index> <len2> <str> [<len3> <object-IDs>]
*
* If we recursed, the SX_HOOK has already been emitted.
*/
TRACEME(("SX_HOOK (recursed=%d) flags=0x%x "
"class=%"IVdf" len=%"IVdf" len2=%"IVdf" len3=%d",
recursed, flags, (IV)classnum, (IV)len, (IV)len2, count-1));
/* SX_HOOK <flags> [<extra>] */
if (!recursed) {
PUTMARK(SX_HOOK);
PUTMARK(flags);
if (obj_type == SHT_EXTRA)
PUTMARK(eflags);
} else
PUTMARK(flags);
/* <len> <classname> or <index> */
if (flags & SHF_IDX_CLASSNAME) {
if (flags & SHF_LARGE_CLASSLEN)
WLEN(classnum);
else {
unsigned char cnum = (unsigned char) classnum;
PUTMARK(cnum);
}
} else {
if (flags & SHF_LARGE_CLASSLEN)
WLEN(len);
else {
unsigned char clen = (unsigned char) len;
PUTMARK(clen);
}
WRITE(classname, len); /* Final \0 is omitted */
}
/* <len2> <frozen-str> */
if (flags & SHF_LARGE_STRLEN) {
I32 wlen2 = len2; /* STRLEN might be 8 bytes */
WLEN(wlen2); /* Must write an I32 for 64-bit machines */
} else {
unsigned char clen = (unsigned char) len2;
PUTMARK(clen);
}
if (len2)
WRITE(pv, (SSize_t)len2); /* Final \0 is omitted */
/* [<len3> <object-IDs>] */
if (flags & SHF_HAS_LIST) {
int len3 = count - 1;
if (flags & SHF_LARGE_LISTLEN)
WLEN(len3);
else {
unsigned char clen = (unsigned char) len3;
PUTMARK(clen);
}
/*
* NOTA BENE, for 64-bit machines: the ary[i] below does not yield a
* real pointer, rather a tag number, well under the 32-bit limit.
*/
for (i = 1; i < count; i++) {
I32 tagval = htonl(LOW_32BITS(ary[i]));
WRITE_I32(tagval);
TRACEME(("object %d, tag #%d", i-1, ntohl(tagval)));
}
}
/*
* Free the array. We need extra care for indices after 0, since they
* don't hold real SVs but integers cast.
*/
if (count > 1)
AvFILLp(av) = 0; /* Cheat, nothing after 0 interests us */
av_undef(av);
sv_free((SV *) av);
/*
* If object was tied, need to insert serialization of the magic object.
*/
if (obj_type == SHT_EXTRA) {
MAGIC *mg;
if (!(mg = mg_find(sv, mtype))) {
int svt = SvTYPE(sv);
CROAK(("No magic '%c' found while storing ref to tied %s with hook",
mtype, (svt == SVt_PVHV) ? "hash" :
(svt == SVt_PVAV) ? "array" : "scalar"));
}
TRACEME(("handling the magic object 0x%"UVxf" part of 0x%"UVxf,
PTR2UV(mg->mg_obj), PTR2UV(sv)));
/*
* [<magic object>]
*/
if ((ret = store(aTHX_ cxt, mg->mg_obj))) /* Extra () for -Wall, grr... */
return ret;
}
return 0;
}
/*
* store_blessed -- dispatched manually, not via sv_store[]
*
* Check whether there is a STORABLE_xxx hook defined in the class or in one
* of its ancestors. If there is, then redispatch to store_hook();
*
* Otherwise, the blessed SV is stored using the following layout:
*
* SX_BLESS <flag> <len> <classname> <object>
*
* where <flag> indicates whether <len> is stored on 0 or 4 bytes, depending
* on the high-order bit in flag: if 1, then length follows on 4 bytes.
* Otherwise, the low order bits give the length, thereby giving a compact
* representation for class names less than 127 chars long.
*
* Each <classname> seen is remembered and indexed, so that the next time
* an object in the blessed in the same <classname> is stored, the following
* will be emitted:
*
* SX_IX_BLESS <flag> <index> <object>
*
* where <index> is the classname index, stored on 0 or 4 bytes depending
* on the high-order bit in flag (same encoding as above for <len>).
*/
static int store_blessed(
pTHX_
stcxt_t *cxt,
SV *sv,
int type,
HV *pkg)
{
SV *hook;
I32 len;
char *classname;
I32 classnum;
TRACEME(("store_blessed, type %d, class \"%s\"", type, HvNAME(pkg)));
/*
* Look for a hook for this blessed SV and redirect to store_hook()
* if needed.
*/
hook = pkg_can(aTHX_ cxt->hook, pkg, "STORABLE_freeze");
if (hook)
return store_hook(aTHX_ cxt, sv, type, pkg, hook);
/*
* This is a blessed SV without any serialization hook.
*/
classname = HvNAME(pkg);
len = strlen(classname);
TRACEME(("blessed 0x%"UVxf" in %s, no hook: tagged #%d",
PTR2UV(sv), classname, cxt->tagnum));
/*
* Determine whether it is the first time we see that class name (in which
* case it will be stored in the SX_BLESS form), or whether we already
* saw that class name before (in which case the SX_IX_BLESS form will be
* used).
*/
if (known_class(aTHX_ cxt, classname, len, &classnum)) {
TRACEME(("already seen class %s, ID = %d", classname, classnum));
PUTMARK(SX_IX_BLESS);
if (classnum <= LG_BLESS) {
unsigned char cnum = (unsigned char) classnum;
PUTMARK(cnum);
} else {
unsigned char flag = (unsigned char) 0x80;
PUTMARK(flag);
WLEN(classnum);
}
} else {
TRACEME(("first time we see class %s, ID = %d", classname, classnum));
PUTMARK(SX_BLESS);
if (len <= LG_BLESS) {
unsigned char clen = (unsigned char) len;
PUTMARK(clen);
} else {
unsigned char flag = (unsigned char) 0x80;
PUTMARK(flag);
WLEN(len); /* Don't BER-encode, this should be rare */
}
WRITE(classname, len); /* Final \0 is omitted */
}
/*
* Now emit the <object> part.
*/
return SV_STORE(type)(aTHX_ cxt, sv);
}
/*
* store_other
*
* We don't know how to store the item we reached, so return an error condition.
* (it's probably a GLOB, some CODE reference, etc...)
*
* If they defined the `forgive_me' variable at the Perl level to some
* true value, then don't croak, just warn, and store a placeholder string
* instead.
*/
static int store_other(pTHX_ stcxt_t *cxt, SV *sv)
{
I32 len;
char buf[80];
TRACEME(("store_other"));
/*
* Fetch the value from perl only once per store() operation.
*/
if (
cxt->forgive_me == 0 ||
(cxt->forgive_me < 0 && !(cxt->forgive_me =
SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
)
CROAK(("Can't store %s items", sv_reftype(sv, FALSE)));
warn("Can't store item %s(0x%"UVxf")",
sv_reftype(sv, FALSE), PTR2UV(sv));
/*
* Store placeholder string as a scalar instead...
*/
(void) sprintf(buf, "You lost %s(0x%"UVxf")%c", sv_reftype(sv, FALSE),
PTR2UV(sv), (char) 0);
len = strlen(buf);
STORE_SCALAR(buf, len);
TRACEME(("ok (dummy \"%s\", length = %"IVdf")", buf, (IV) len));
return 0;
}
/***
*** Store driving routines
***/
/*
* sv_type
*
* WARNING: partially duplicates Perl's sv_reftype for speed.
*
* Returns the type of the SV, identified by an integer. That integer
* may then be used to index the dynamic routine dispatch table.
*/
static int sv_type(pTHX_ SV *sv)
{
switch (SvTYPE(sv)) {
case SVt_NULL:
case SVt_IV:
case SVt_NV:
/*
* No need to check for ROK, that can't be set here since there
* is no field capable of hodling the xrv_rv reference.
*/
return svis_SCALAR;
case SVt_PV:
case SVt_RV:
case SVt_PVIV:
case SVt_PVNV:
/*
* Starting from SVt_PV, it is possible to have the ROK flag
* set, the pointer to the other SV being either stored in
* the xrv_rv (in the case of a pure SVt_RV), or as the
* xpv_pv field of an SVt_PV and its heirs.
*
* However, those SV cannot be magical or they would be an
* SVt_PVMG at least.
*/
return SvROK(sv) ? svis_REF : svis_SCALAR;
case SVt_PVMG:
case SVt_PVLV: /* Workaround for perl5.004_04 "LVALUE" bug */
if (SvRMAGICAL(sv) && (mg_find(sv, 'p')))
return svis_TIED_ITEM;
/* FALL THROUGH */
case SVt_PVBM:
if (SvRMAGICAL(sv) && (mg_find(sv, 'q')))
return svis_TIED;
return SvROK(sv) ? svis_REF : svis_SCALAR;
case SVt_PVAV:
if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
return svis_TIED;
return svis_ARRAY;
case SVt_PVHV:
if (SvRMAGICAL(sv) && (mg_find(sv, 'P')))
return svis_TIED;
return svis_HASH;
case SVt_PVCV:
return svis_CODE;
default:
break;
}
return svis_OTHER;
}
/*
* store
*
* Recursively store objects pointed to by the sv to the specified file.
*
* Layout is <content> or SX_OBJECT <tagnum> if we reach an already stored
* object (one for which storage has started -- it may not be over if we have
* a self-referenced structure). This data set forms a stored <object>.
*/
static int store(pTHX_ stcxt_t *cxt, SV *sv)
{
SV **svh;
int ret;
int type;
#ifdef USE_PTR_TABLE
struct ptr_tbl *pseen = cxt->pseen;
#else
HV *hseen = cxt->hseen;
#endif
TRACEME(("store (0x%"UVxf")", PTR2UV(sv)));
/*
* If object has already been stored, do not duplicate data.
* Simply emit the SX_OBJECT marker followed by its tag data.
* The tag is always written in network order.
*
* NOTA BENE, for 64-bit machines: the "*svh" below does not yield a
* real pointer, rather a tag number (watch the insertion code below).
* That means it probably safe to assume it is well under the 32-bit limit,
* and makes the truncation safe.
* -- RAM, 14/09/1999
*/
#ifdef USE_PTR_TABLE
svh = ptr_table_fetch(pseen, sv);
#else
svh = hv_fetch(hseen, (char *) &sv, sizeof(sv), FALSE);
#endif
if (svh) {
I32 tagval;
if (sv == &PL_sv_undef) {
/* We have seen PL_sv_undef before, but fake it as
if we have not.
Not the simplest solution to making restricted
hashes work on 5.8.0, but it does mean that
repeated references to the one true undef will
take up less space in the output file.
*/
/* Need to jump past the next hv_store, because on the
second store of undef the old hash value will be
SvREFCNT_dec()ed, and as Storable cheats horribly
by storing non-SVs in the hash a SEGV will ensure.
Need to increase the tag number so that the
receiver has no idea what games we're up to. This
special casing doesn't affect hooks that store
undef, as the hook routine does its own lookup into
hseen. Also this means that any references back
to PL_sv_undef (from the pathological case of hooks
storing references to it) will find the seen hash
entry for the first time, as if we didn't have this
hackery here. (That hseen lookup works even on 5.8.0
because it's a key of &PL_sv_undef and a value
which is a tag number, not a value which is
PL_sv_undef.) */
cxt->tagnum++;
type = svis_SCALAR;
goto undef_special_case;
}
#ifdef USE_PTR_TABLE
tagval = htonl(LOW_32BITS(((char *)svh)-1));
#else
tagval = htonl(LOW_32BITS(*svh));
#endif
TRACEME(("object 0x%"UVxf" seen as #%d", PTR2UV(sv), ntohl(tagval)));
PUTMARK(SX_OBJECT);
WRITE_I32(tagval);
return 0;
}
/*
* Allocate a new tag and associate it with the address of the sv being
* stored, before recursing...
*
* In order to avoid creating new SvIVs to hold the tagnum we just
* cast the tagnum to an SV pointer and store that in the hash. This
* means that we must clean up the hash manually afterwards, but gives
* us a 15% throughput increase.
*
*/
cxt->tagnum++;
#ifdef USE_PTR_TABLE
ptr_table_store(pseen, sv, INT2PTR(SV*, 1 + cxt->tagnum));
#else
if (!hv_store(hseen,
(char *) &sv, sizeof(sv), INT2PTR(SV*, cxt->tagnum), 0))
return -1;
#endif
/*
* Store `sv' and everything beneath it, using appropriate routine.
* Abort immediately if we get a non-zero status back.
*/
type = sv_type(aTHX_ sv);
undef_special_case:
TRACEME(("storing 0x%"UVxf" tag #%d, type %d...",
PTR2UV(sv), cxt->tagnum, type));
if (SvOBJECT(sv)) {
HV *pkg = SvSTASH(sv);
ret = store_blessed(aTHX_ cxt, sv, type, pkg);
} else
ret = SV_STORE(type)(aTHX_ cxt, sv);
TRACEME(("%s (stored 0x%"UVxf", refcnt=%d, %s)",
ret ? "FAILED" : "ok", PTR2UV(sv),
SvREFCNT(sv), sv_reftype(sv, FALSE)));
return ret;
}
/*
* magic_write
*
* Write magic number and system information into the file.
* Layout is <magic> <network> [<len> <byteorder> <sizeof int> <sizeof long>
* <sizeof ptr>] where <len> is the length of the byteorder hexa string.
* All size and lenghts are written as single characters here.
*
* Note that no byte ordering info is emitted when <network> is true, since
* integers will be emitted in network order in that case.
*/
static int magic_write(pTHX_ stcxt_t *cxt)
{
/*
* Starting with 0.6, the "use_network_order" byte flag is also used to
* indicate the version number of the binary image, encoded in the upper
* bits. The bit 0 is always used to indicate network order.
*/
/*
* Starting with 0.7, a full byte is dedicated to the minor version of
* the binary format, which is incremented only when new markers are
* introduced, for instance, but when backward compatibility is preserved.
*/
/* Make these at compile time. The WRITE() macro is sufficiently complex
that it saves about 200 bytes doing it this way and only using it
once. */
static const unsigned char network_file_header[] = {
MAGICSTR_BYTES,
(STORABLE_BIN_MAJOR << 1) | 1,
STORABLE_BIN_WRITE_MINOR
};
static const unsigned char file_header[] = {
MAGICSTR_BYTES,
(STORABLE_BIN_MAJOR << 1) | 0,
STORABLE_BIN_WRITE_MINOR,
/* sizeof the array includes the 0 byte at the end: */
(char) sizeof (byteorderstr) - 1,
BYTEORDER_BYTES,
(unsigned char) sizeof(int),
(unsigned char) sizeof(long),
(unsigned char) sizeof(char *),
(unsigned char) sizeof(NV)
};
#ifdef USE_56_INTERWORK_KLUDGE
static const unsigned char file_header_56[] = {
MAGICSTR_BYTES,
(STORABLE_BIN_MAJOR << 1) | 0,
STORABLE_BIN_WRITE_MINOR,
/* sizeof the array includes the 0 byte at the end: */
(char) sizeof (byteorderstr_56) - 1,
BYTEORDER_BYTES_56,
(unsigned char) sizeof(int),
(unsigned char) sizeof(long),
(unsigned char) sizeof(char *),
(unsigned char) sizeof(NV)
};
#endif
const unsigned char *header;
SSize_t length;
TRACEME(("magic_write on fd=%d", cxt->fio ? PerlIO_fileno(cxt->fio) : -1));
if (cxt->netorder) {
header = network_file_header;
length = sizeof (network_file_header);
} else {
#ifdef USE_56_INTERWORK_KLUDGE
if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
header = file_header_56;
length = sizeof (file_header_56);
} else
#endif
{
header = file_header;
length = sizeof (file_header);
}
}
if (!cxt->fio) {
/* sizeof the array includes the 0 byte at the end. */
header += sizeof (magicstr) - 1;
length -= sizeof (magicstr) - 1;
}
WRITE( (unsigned char*) header, length);
if (!cxt->netorder) {
TRACEME(("ok (magic_write byteorder = 0x%lx [%d], I%d L%d P%d D%d)",
(unsigned long) BYTEORDER, (int) sizeof (byteorderstr) - 1,
(int) sizeof(int), (int) sizeof(long),
(int) sizeof(char *), (int) sizeof(NV)));
}
return 0;
}
/*
* do_store
*
* Common code for store operations.
*
* When memory store is requested (f = NULL) and a non null SV* is given in
* `res', it is filled with a new SV created out of the memory buffer.
*
* It is required to provide a non-null `res' when the operation type is not
* dclone() and store() is performed to memory.
*/
static int do_store(
pTHX_
PerlIO *f,
SV *sv,
int optype,
int network_order,
SV **res)
{
dSTCXT;
int status;
ASSERT(!(f == 0 && !(optype & ST_CLONE)) || res,
("must supply result SV pointer for real recursion to memory"));
TRACEME(("do_store (optype=%d, netorder=%d)",
optype, network_order));
optype |= ST_STORE;
/*
* Workaround for CROAK leak: if they enter with a "dirty" context,
* free up memory for them now.
*/
if (cxt->s_dirty)
clean_context(aTHX_ cxt);
/*
* Now that STORABLE_xxx hooks exist, it is possible that they try to
* re-enter store() via the hooks. We need to stack contexts.
*/
if (cxt->entry)
cxt = allocate_context(aTHX_ cxt);
cxt->entry++;
ASSERT(cxt->entry == 1, ("starting new recursion"));
ASSERT(!cxt->s_dirty, ("clean context"));
/*
* Ensure sv is actually a reference. From perl, we called something
* like:
* pstore(aTHX_ FILE, \@array);
* so we must get the scalar value behing that reference.
*/
if (!SvROK(sv))
CROAK(("Not a reference"));
sv = SvRV(sv); /* So follow it to know what to store */
/*
* If we're going to store to memory, reset the buffer.
*/
if (!f)
MBUF_INIT(0);
/*
* Prepare context and emit headers.
*/
init_store_context(aTHX_ cxt, f, optype, network_order);
if (-1 == magic_write(aTHX_ cxt)) /* Emit magic and ILP info */
return 0; /* Error */
/*
* Recursively store object...
*/
ASSERT(is_storing(aTHX), ("within store operation"));
status = store(aTHX_ cxt, sv); /* Just do it! */
/*
* If they asked for a memory store and they provided an SV pointer,
* make an SV string out of the buffer and fill their pointer.
*
* When asking for ST_REAL, it's MANDATORY for the caller to provide
* an SV, since context cleanup might free the buffer if we did recurse.
* (unless caller is dclone(), which is aware of that).
*/
if (!cxt->fio && res)
*res = mbuf2sv(aTHX);
/*
* Final cleanup.
*
* The "root" context is never freed, since it is meant to be always
* handy for the common case where no recursion occurs at all (i.e.
* we enter store() outside of any Storable code and leave it, period).
* We know it's the "root" context because there's nothing stacked
* underneath it.
*
* OPTIMIZATION:
*
* When deep cloning, we don't free the context: doing so would force
* us to copy the data in the memory buffer. Sicne we know we're
* about to enter do_retrieve...
*/
clean_store_context(aTHX_ cxt);
if (cxt->prev && !(cxt->optype & ST_CLONE))
free_context(aTHX_ cxt);
TRACEME(("do_store returns %d", status));
return status == 0;
}
/*
* pstore
*
* Store the transitive data closure of given object to disk.
* Returns 0 on error, a true value otherwise.
*/
int pstore(pTHX_ PerlIO *f, SV *sv)
{
TRACEME(("pstore"));
return do_store(aTHX_ f, sv, 0, FALSE, (SV**) 0);
}
/*
* net_pstore
*
* Same as pstore(), but network order is used for integers and doubles are
* emitted as strings.
*/
int net_pstore(pTHX_ PerlIO *f, SV *sv)
{
TRACEME(("net_pstore"));
return do_store(aTHX_ f, sv, 0, TRUE, (SV**) 0);
}
/***
*** Memory stores.
***/
/*
* mbuf2sv
*
* Build a new SV out of the content of the internal memory buffer.
*/
static SV *mbuf2sv(pTHX)
{
dSTCXT;
return newSVpv(mbase, MBUF_SIZE());
}
/*
* mstore
*
* Store the transitive data closure of given object to memory.
* Returns undef on error, a scalar value containing the data otherwise.
*/
SV *mstore(pTHX_ SV *sv)
{
SV *out;
TRACEME(("mstore"));
if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, FALSE, &out))
return &PL_sv_undef;
return out;
}
/*
* net_mstore
*
* Same as mstore(), but network order is used for integers and doubles are
* emitted as strings.
*/
SV *net_mstore(pTHX_ SV *sv)
{
SV *out;
TRACEME(("net_mstore"));
if (!do_store(aTHX_ (PerlIO*) 0, sv, 0, TRUE, &out))
return &PL_sv_undef;
return out;
}
/***
*** Specific retrieve callbacks.
***/
/*
* retrieve_other
*
* Return an error via croak, since it is not possible that we get here
* under normal conditions, when facing a file produced via pstore().
*/
static SV *retrieve_other(pTHX_ stcxt_t *cxt, char *cname)
{
if (
cxt->ver_major != STORABLE_BIN_MAJOR &&
cxt->ver_minor != STORABLE_BIN_MINOR
) {
CROAK(("Corrupted storable %s (binary v%d.%d), current is v%d.%d",
cxt->fio ? "file" : "string",
cxt->ver_major, cxt->ver_minor,
STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
} else {
CROAK(("Corrupted storable %s (binary v%d.%d)",
cxt->fio ? "file" : "string",
cxt->ver_major, cxt->ver_minor));
}
return (SV *) 0; /* Just in case */
}
/*
* retrieve_idx_blessed
*
* Layout is SX_IX_BLESS <index> <object> with SX_IX_BLESS already read.
* <index> can be coded on either 1 or 5 bytes.
*/
static SV *retrieve_idx_blessed(pTHX_ stcxt_t *cxt, char *cname)
{
I32 idx;
char *classname;
SV **sva;
SV *sv;
TRACEME(("retrieve_idx_blessed (#%d)", cxt->tagnum));
ASSERT(!cname, ("no bless-into class given here, got %s", cname));
GETMARK(idx); /* Index coded on a single char? */
if (idx & 0x80)
RLEN(idx);
/*
* Fetch classname in `aclass'
*/
sva = av_fetch(cxt->aclass, idx, FALSE);
if (!sva)
CROAK(("Class name #%"IVdf" should have been seen already", (IV) idx));
classname = SvPVX(*sva); /* We know it's a PV, by construction */
TRACEME(("class ID %d => %s", idx, classname));
/*
* Retrieve object and bless it.
*/
sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
return sv;
}
/*
* retrieve_blessed
*
* Layout is SX_BLESS <len> <classname> <object> with SX_BLESS already read.
* <len> can be coded on either 1 or 5 bytes.
*/
static SV *retrieve_blessed(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
SV *sv;
char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
char *classname = buf;
TRACEME(("retrieve_blessed (#%d)", cxt->tagnum));
ASSERT(!cname, ("no bless-into class given here, got %s", cname));
/*
* Decode class name length and read that name.
*
* Short classnames have two advantages: their length is stored on one
* single byte, and the string can be read on the stack.
*/
GETMARK(len); /* Length coded on a single char? */
if (len & 0x80) {
RLEN(len);
TRACEME(("** allocating %d bytes for class name", len+1));
New(10003, classname, len+1, char);
}
READ(classname, len);
classname[len] = '\0'; /* Mark string end */
/*
* It's a new classname, otherwise it would have been an SX_IX_BLESS.
*/
TRACEME(("new class name \"%s\" will bear ID = %d", classname, cxt->classnum));
if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
return (SV *) 0;
/*
* Retrieve object and bless it.
*/
sv = retrieve(aTHX_ cxt, classname); /* First SV which is SEEN will be blessed */
if (classname != buf)
Safefree(classname);
return sv;
}
/*
* retrieve_hook
*
* Layout: SX_HOOK <flags> <len> <classname> <len2> <str> [<len3> <object-IDs>]
* with leading mark already read, as usual.
*
* When recursion was involved during serialization of the object, there
* is an unknown amount of serialized objects after the SX_HOOK mark. Until
* we reach a <flags> marker with the recursion bit cleared.
*
* If the first <flags> byte contains a type of SHT_EXTRA, then the real type
* is held in the <extra> byte, and if the object is tied, the serialized
* magic object comes at the very end:
*
* SX_HOOK <flags> <extra> ... [<len3> <object-IDs>] <magic object>
*
* This means the STORABLE_thaw hook will NOT get a tied variable during its
* processing (since we won't have seen the magic object by the time the hook
* is called). See comments below for why it was done that way.
*/
static SV *retrieve_hook(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
char buf[LG_BLESS + 1]; /* Avoid malloc() if possible */
char *classname = buf;
unsigned int flags;
I32 len2;
SV *frozen;
I32 len3 = 0;
AV *av = 0;
SV *hook;
SV *sv;
SV *rv;
GV *attach;
int obj_type;
int clone = cxt->optype & ST_CLONE;
char mtype = '\0';
unsigned int extra_type = 0;
TRACEME(("retrieve_hook (#%d)", cxt->tagnum));
ASSERT(!cname, ("no bless-into class given here, got %s", cname));
/*
* Read flags, which tell us about the type, and whether we need to recurse.
*/
GETMARK(flags);
/*
* Create the (empty) object, and mark it as seen.
*
* This must be done now, because tags are incremented, and during
* serialization, the object tag was affected before recursion could
* take place.
*/
obj_type = flags & SHF_TYPE_MASK;
switch (obj_type) {
case SHT_SCALAR:
sv = newSV(0);
break;
case SHT_ARRAY:
sv = (SV *) newAV();
break;
case SHT_HASH:
sv = (SV *) newHV();
break;
case SHT_EXTRA:
/*
* Read <extra> flag to know the type of the object.
* Record associated magic type for later.
*/
GETMARK(extra_type);
switch (extra_type) {
case SHT_TSCALAR:
sv = newSV(0);
mtype = 'q';
break;
case SHT_TARRAY:
sv = (SV *) newAV();
mtype = 'P';
break;
case SHT_THASH:
sv = (SV *) newHV();
mtype = 'P';
break;
default:
return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
}
break;
default:
return retrieve_other(aTHX_ cxt, 0); /* Let it croak */
}
SEEN(sv, 0, 0); /* Don't bless yet */
/*
* Whilst flags tell us to recurse, do so.
*
* We don't need to remember the addresses returned by retrieval, because
* all the references will be obtained through indirection via the object
* tags in the object-ID list.
*
* We need to decrement the reference count for these objects
* because, if the user doesn't save a reference to them in the hook,
* they must be freed when this context is cleaned.
*/
while (flags & SHF_NEED_RECURSE) {
TRACEME(("retrieve_hook recursing..."));
rv = retrieve(aTHX_ cxt, 0);
if (!rv)
return (SV *) 0;
SvREFCNT_dec(rv);
TRACEME(("retrieve_hook back with rv=0x%"UVxf,
PTR2UV(rv)));
GETMARK(flags);
}
if (flags & SHF_IDX_CLASSNAME) {
SV **sva;
I32 idx;
/*
* Fetch index from `aclass'
*/
if (flags & SHF_LARGE_CLASSLEN)
RLEN(idx);
else
GETMARK(idx);
sva = av_fetch(cxt->aclass, idx, FALSE);
if (!sva)
CROAK(("Class name #%"IVdf" should have been seen already",
(IV) idx));
classname = SvPVX(*sva); /* We know it's a PV, by construction */
TRACEME(("class ID %d => %s", idx, classname));
} else {
/*
* Decode class name length and read that name.
*
* NOTA BENE: even if the length is stored on one byte, we don't read
* on the stack. Just like retrieve_blessed(), we limit the name to
* LG_BLESS bytes. This is an arbitrary decision.
*/
if (flags & SHF_LARGE_CLASSLEN)
RLEN(len);
else
GETMARK(len);
if (len > LG_BLESS) {
TRACEME(("** allocating %d bytes for class name", len+1));
New(10003, classname, len+1, char);
}
READ(classname, len);
classname[len] = '\0'; /* Mark string end */
/*
* Record new classname.
*/
if (!av_store(cxt->aclass, cxt->classnum++, newSVpvn(classname, len)))
return (SV *) 0;
}
TRACEME(("class name: %s", classname));
/*
* Decode user-frozen string length and read it in an SV.
*
* For efficiency reasons, we read data directly into the SV buffer.
* To understand that code, read retrieve_scalar()
*/
if (flags & SHF_LARGE_STRLEN)
RLEN(len2);
else
GETMARK(len2);
frozen = NEWSV(10002, len2);
if (len2) {
SAFEREAD(SvPVX(frozen), len2, frozen);
SvCUR_set(frozen, len2);
*SvEND(frozen) = '\0';
}
(void) SvPOK_only(frozen); /* Validates string pointer */
if (cxt->s_tainted) /* Is input source tainted? */
SvTAINT(frozen);
TRACEME(("frozen string: %d bytes", len2));
/*
* Decode object-ID list length, if present.
*/
if (flags & SHF_HAS_LIST) {
if (flags & SHF_LARGE_LISTLEN)
RLEN(len3);
else
GETMARK(len3);
if (len3) {
av = newAV();
av_extend(av, len3 + 1); /* Leave room for [0] */
AvFILLp(av) = len3; /* About to be filled anyway */
}
}
TRACEME(("has %d object IDs to link", len3));
/*
* Read object-ID list into array.
* Because we pre-extended it, we can cheat and fill it manually.
*
* We read object tags and we can convert them into SV* on the fly
* because we know all the references listed in there (as tags)
* have been already serialized, hence we have a valid correspondance
* between each of those tags and the recreated SV.
*/
if (av) {
SV **ary = AvARRAY(av);
int i;
for (i = 1; i <= len3; i++) { /* We leave [0] alone */
I32 tag;
SV **svh;
SV *xsv;
READ_I32(tag);
tag = ntohl(tag);
svh = av_fetch(cxt->aseen, tag, FALSE);
if (!svh) {
if (tag == cxt->where_is_undef) {
/* av_fetch uses PL_sv_undef internally, hence this
somewhat gruesome hack. */
xsv = &PL_sv_undef;
svh = &xsv;
} else {
CROAK(("Object #%"IVdf" should have been retrieved already",
(IV) tag));
}
}
xsv = *svh;
ary[i] = SvREFCNT_inc(xsv);
}
}
/*
* Bless the object and look up the STORABLE_thaw hook.
*/
BLESS(sv, classname);
/* Handle attach case; again can't use pkg_can because it only
* caches one method */
attach = gv_fetchmethod_autoload(SvSTASH(sv), "STORABLE_attach", FALSE);
if (attach && isGV(attach)) {
SV* attached;
SV* attach_hook = newRV((SV*) GvCV(attach));
if (av)
CROAK(("STORABLE_attach called with unexpected references"));
av = newAV();
av_extend(av, 1);
AvFILLp(av) = 0;
AvARRAY(av)[0] = SvREFCNT_inc(frozen);
rv = newSVpv(classname, 0);
attached = scalar_call(aTHX_ rv, attach_hook, clone, av, G_SCALAR);
if (attached &&
SvROK(attached) &&
sv_derived_from(attached, classname))
return SvRV(attached);
CROAK(("STORABLE_attach did not return a %s object", classname));
}
hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
if (!hook) {
/*
* Hook not found. Maybe they did not require the module where this
* hook is defined yet?
*
* If the require below succeeds, we'll be able to find the hook.
* Still, it only works reliably when each class is defined in a
* file of its own.
*/
SV *psv = newSVpvn("require ", 8);
sv_catpv(psv, classname);
TRACEME(("No STORABLE_thaw defined for objects of class %s", classname));
TRACEME(("Going to require module '%s' with '%s'", classname, SvPVX(psv)));
perl_eval_sv(psv, G_DISCARD);
sv_free(psv);
/*
* We cache results of pkg_can, so we need to uncache before attempting
* the lookup again.
*/
pkg_uncache(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
hook = pkg_can(aTHX_ cxt->hook, SvSTASH(sv), "STORABLE_thaw");
if (!hook)
CROAK(("No STORABLE_thaw defined for objects of class %s "
"(even after a \"require %s;\")", classname, classname));
}
/*
* If we don't have an `av' yet, prepare one.
* Then insert the frozen string as item [0].
*/
if (!av) {
av = newAV();
av_extend(av, 1);
AvFILLp(av) = 0;
}
AvARRAY(av)[0] = SvREFCNT_inc(frozen);
/*
* Call the hook as:
*
* $object->STORABLE_thaw($cloning, $frozen, @refs);
*
* where $object is our blessed (empty) object, $cloning is a boolean
* telling whether we're running a deep clone, $frozen is the frozen
* string the user gave us in his serializing hook, and @refs, which may
* be empty, is the list of extra references he returned along for us
* to serialize.
*
* In effect, the hook is an alternate creation routine for the class,
* the object itself being already created by the runtime.
*/
TRACEME(("calling STORABLE_thaw on %s at 0x%"UVxf" (%"IVdf" args)",
classname, PTR2UV(sv), (IV) AvFILLp(av) + 1));
rv = newRV(sv);
(void) scalar_call(aTHX_ rv, hook, clone, av, G_SCALAR|G_DISCARD);
SvREFCNT_dec(rv);
/*
* Final cleanup.
*/
SvREFCNT_dec(frozen);
av_undef(av);
sv_free((SV *) av);
if (!(flags & SHF_IDX_CLASSNAME) && classname != buf)
Safefree(classname);
/*
* If we had an <extra> type, then the object was not as simple, and
* we need to restore extra magic now.
*/
if (!extra_type)
return sv;
TRACEME(("retrieving magic object for 0x%"UVxf"...", PTR2UV(sv)));
rv = retrieve(aTHX_ cxt, 0); /* Retrieve <magic object> */
TRACEME(("restoring the magic object 0x%"UVxf" part of 0x%"UVxf,
PTR2UV(rv), PTR2UV(sv)));
switch (extra_type) {
case SHT_TSCALAR:
sv_upgrade(sv, SVt_PVMG);
break;
case SHT_TARRAY:
sv_upgrade(sv, SVt_PVAV);
AvREAL_off((AV *)sv);
break;
case SHT_THASH:
sv_upgrade(sv, SVt_PVHV);
break;
default:
CROAK(("Forgot to deal with extra type %d", extra_type));
break;
}
/*
* Adding the magic only now, well after the STORABLE_thaw hook was called
* means the hook cannot know it deals with an object whose variable is
* tied. But this is happening when retrieving $o in the following case:
*
* my %h;
* tie %h, 'FOO';
* my $o = bless \%h, 'BAR';
*
* The 'BAR' class is NOT the one where %h is tied into. Therefore, as
* far as the 'BAR' class is concerned, the fact that %h is not a REAL
* hash but a tied one should not matter at all, and remain transparent.
* This means the magic must be restored by Storable AFTER the hook is
* called.
*
* That looks very reasonable to me, but then I've come up with this
* after a bug report from David Nesting, who was trying to store such
* an object and caused Storable to fail. And unfortunately, it was
* also the easiest way to retrofit support for blessed ref to tied objects
* into the existing design. -- RAM, 17/02/2001
*/
sv_magic(sv, rv, mtype, Nullch, 0);
SvREFCNT_dec(rv); /* Undo refcnt inc from sv_magic() */
return sv;
}
/*
* retrieve_ref
*
* Retrieve reference to some other scalar.
* Layout is SX_REF <object>, with SX_REF already read.
*/
static SV *retrieve_ref(pTHX_ stcxt_t *cxt, char *cname)
{
SV *rv;
SV *sv;
TRACEME(("retrieve_ref (#%d)", cxt->tagnum));
/*
* We need to create the SV that holds the reference to the yet-to-retrieve
* object now, so that we may record the address in the seen table.
* Otherwise, if the object to retrieve references us, we won't be able
* to resolve the SX_OBJECT we'll see at that point! Hence we cannot
* do the retrieve first and use rv = newRV(sv) since it will be too late
* for SEEN() recording.
*/
rv = NEWSV(10002, 0);
SEEN(rv, cname, 0); /* Will return if rv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv)
return (SV *) 0; /* Failed */
/*
* WARNING: breaks RV encapsulation.
*
* Now for the tricky part. We have to upgrade our existing SV, so that
* it is now an RV on sv... Again, we cheat by duplicating the code
* held in newSVrv(), since we already got our SV from retrieve().
*
* We don't say:
*
* SvRV(rv) = SvREFCNT_inc(sv);
*
* here because the reference count we got from retrieve() above is
* already correct: if the object was retrieved from the file, then
* its reference count is one. Otherwise, if it was retrieved via
* an SX_OBJECT indication, a ref count increment was done.
*/
if (cname) {
/* No need to do anything, as rv will already be PVMG. */
assert (SvTYPE(rv) >= SVt_RV);
} else {
sv_upgrade(rv, SVt_RV);
}
SvRV_set(rv, sv); /* $rv = \$sv */
SvROK_on(rv);
TRACEME(("ok (retrieve_ref at 0x%"UVxf")", PTR2UV(rv)));
return rv;
}
/*
* retrieve_weakref
*
* Retrieve weak reference to some other scalar.
* Layout is SX_WEAKREF <object>, with SX_WEAKREF already read.
*/
static SV *retrieve_weakref(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
TRACEME(("retrieve_weakref (#%d)", cxt->tagnum));
sv = retrieve_ref(aTHX_ cxt, cname);
if (sv) {
#ifdef SvWEAKREF
sv_rvweaken(sv);
#else
WEAKREF_CROAK();
#endif
}
return sv;
}
/*
* retrieve_overloaded
*
* Retrieve reference to some other scalar with overloading.
* Layout is SX_OVERLOAD <object>, with SX_OVERLOAD already read.
*/
static SV *retrieve_overloaded(pTHX_ stcxt_t *cxt, char *cname)
{
SV *rv;
SV *sv;
HV *stash;
TRACEME(("retrieve_overloaded (#%d)", cxt->tagnum));
/*
* Same code as retrieve_ref(), duplicated to avoid extra call.
*/
rv = NEWSV(10002, 0);
SEEN(rv, cname, 0); /* Will return if rv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv)
return (SV *) 0; /* Failed */
/*
* WARNING: breaks RV encapsulation.
*/
sv_upgrade(rv, SVt_RV);
SvRV_set(rv, sv); /* $rv = \$sv */
SvROK_on(rv);
/*
* Restore overloading magic.
*/
stash = SvTYPE(sv) ? (HV *) SvSTASH (sv) : 0;
if (!stash) {
CROAK(("Cannot restore overloading on %s(0x%"UVxf
") (package <unknown>)",
sv_reftype(sv, FALSE),
PTR2UV(sv)));
}
if (!Gv_AMG(stash)) {
SV *psv = newSVpvn("require ", 8);
const char *package = HvNAME(stash);
sv_catpv(psv, package);
TRACEME(("No overloading defined for package %s", package));
TRACEME(("Going to require module '%s' with '%s'", package, SvPVX(psv)));
perl_eval_sv(psv, G_DISCARD);
sv_free(psv);
if (!Gv_AMG(stash)) {
CROAK(("Cannot restore overloading on %s(0x%"UVxf
") (package %s) (even after a \"require %s;\")",
sv_reftype(sv, FALSE),
PTR2UV(sv),
package, package));
}
}
SvAMAGIC_on(rv);
TRACEME(("ok (retrieve_overloaded at 0x%"UVxf")", PTR2UV(rv)));
return rv;
}
/*
* retrieve_weakoverloaded
*
* Retrieve weak overloaded reference to some other scalar.
* Layout is SX_WEAKOVERLOADED <object>, with SX_WEAKOVERLOADED already read.
*/
static SV *retrieve_weakoverloaded(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
TRACEME(("retrieve_weakoverloaded (#%d)", cxt->tagnum));
sv = retrieve_overloaded(aTHX_ cxt, cname);
if (sv) {
#ifdef SvWEAKREF
sv_rvweaken(sv);
#else
WEAKREF_CROAK();
#endif
}
return sv;
}
/*
* retrieve_tied_array
*
* Retrieve tied array
* Layout is SX_TIED_ARRAY <object>, with SX_TIED_ARRAY already read.
*/
static SV *retrieve_tied_array(pTHX_ stcxt_t *cxt, char *cname)
{
SV *tv;
SV *sv;
TRACEME(("retrieve_tied_array (#%d)", cxt->tagnum));
tv = NEWSV(10002, 0);
SEEN(tv, cname, 0); /* Will return if tv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv)
return (SV *) 0; /* Failed */
sv_upgrade(tv, SVt_PVAV);
AvREAL_off((AV *)tv);
sv_magic(tv, sv, 'P', Nullch, 0);
SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
TRACEME(("ok (retrieve_tied_array at 0x%"UVxf")", PTR2UV(tv)));
return tv;
}
/*
* retrieve_tied_hash
*
* Retrieve tied hash
* Layout is SX_TIED_HASH <object>, with SX_TIED_HASH already read.
*/
static SV *retrieve_tied_hash(pTHX_ stcxt_t *cxt, char *cname)
{
SV *tv;
SV *sv;
TRACEME(("retrieve_tied_hash (#%d)", cxt->tagnum));
tv = NEWSV(10002, 0);
SEEN(tv, cname, 0); /* Will return if tv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv)
return (SV *) 0; /* Failed */
sv_upgrade(tv, SVt_PVHV);
sv_magic(tv, sv, 'P', Nullch, 0);
SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
TRACEME(("ok (retrieve_tied_hash at 0x%"UVxf")", PTR2UV(tv)));
return tv;
}
/*
* retrieve_tied_scalar
*
* Retrieve tied scalar
* Layout is SX_TIED_SCALAR <object>, with SX_TIED_SCALAR already read.
*/
static SV *retrieve_tied_scalar(pTHX_ stcxt_t *cxt, char *cname)
{
SV *tv;
SV *sv, *obj = NULL;
TRACEME(("retrieve_tied_scalar (#%d)", cxt->tagnum));
tv = NEWSV(10002, 0);
SEEN(tv, cname, 0); /* Will return if rv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv) {
return (SV *) 0; /* Failed */
}
else if (SvTYPE(sv) != SVt_NULL) {
obj = sv;
}
sv_upgrade(tv, SVt_PVMG);
sv_magic(tv, obj, 'q', Nullch, 0);
if (obj) {
/* Undo refcnt inc from sv_magic() */
SvREFCNT_dec(obj);
}
TRACEME(("ok (retrieve_tied_scalar at 0x%"UVxf")", PTR2UV(tv)));
return tv;
}
/*
* retrieve_tied_key
*
* Retrieve reference to value in a tied hash.
* Layout is SX_TIED_KEY <object> <key>, with SX_TIED_KEY already read.
*/
static SV *retrieve_tied_key(pTHX_ stcxt_t *cxt, char *cname)
{
SV *tv;
SV *sv;
SV *key;
TRACEME(("retrieve_tied_key (#%d)", cxt->tagnum));
tv = NEWSV(10002, 0);
SEEN(tv, cname, 0); /* Will return if tv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv)
return (SV *) 0; /* Failed */
key = retrieve(aTHX_ cxt, 0); /* Retrieve <key> */
if (!key)
return (SV *) 0; /* Failed */
sv_upgrade(tv, SVt_PVMG);
sv_magic(tv, sv, 'p', (char *)key, HEf_SVKEY);
SvREFCNT_dec(key); /* Undo refcnt inc from sv_magic() */
SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
return tv;
}
/*
* retrieve_tied_idx
*
* Retrieve reference to value in a tied array.
* Layout is SX_TIED_IDX <object> <idx>, with SX_TIED_IDX already read.
*/
static SV *retrieve_tied_idx(pTHX_ stcxt_t *cxt, char *cname)
{
SV *tv;
SV *sv;
I32 idx;
TRACEME(("retrieve_tied_idx (#%d)", cxt->tagnum));
tv = NEWSV(10002, 0);
SEEN(tv, cname, 0); /* Will return if tv is null */
sv = retrieve(aTHX_ cxt, 0); /* Retrieve <object> */
if (!sv)
return (SV *) 0; /* Failed */
RLEN(idx); /* Retrieve <idx> */
sv_upgrade(tv, SVt_PVMG);
sv_magic(tv, sv, 'p', Nullch, idx);
SvREFCNT_dec(sv); /* Undo refcnt inc from sv_magic() */
return tv;
}
/*
* retrieve_lscalar
*
* Retrieve defined long (string) scalar.
*
* Layout is SX_LSCALAR <length> <data>, with SX_LSCALAR already read.
* The scalar is "long" in that <length> is larger than LG_SCALAR so it
* was not stored on a single byte.
*/
static SV *retrieve_lscalar(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
SV *sv;
RLEN(len);
TRACEME(("retrieve_lscalar (#%d), len = %"IVdf, cxt->tagnum, (IV) len));
/*
* Allocate an empty scalar of the suitable length.
*/
sv = NEWSV(10002, len);
SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
/*
* WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
*
* Now, for efficiency reasons, read data directly inside the SV buffer,
* and perform the SV final settings directly by duplicating the final
* work done by sv_setpv. Since we're going to allocate lots of scalars
* this way, it's worth the hassle and risk.
*/
SAFEREAD(SvPVX(sv), len, sv);
SvCUR_set(sv, len); /* Record C string length */
*SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
(void) SvPOK_only(sv); /* Validate string pointer */
if (cxt->s_tainted) /* Is input source tainted? */
SvTAINT(sv); /* External data cannot be trusted */
TRACEME(("large scalar len %"IVdf" '%s'", (IV) len, SvPVX(sv)));
TRACEME(("ok (retrieve_lscalar at 0x%"UVxf")", PTR2UV(sv)));
return sv;
}
/*
* retrieve_scalar
*
* Retrieve defined short (string) scalar.
*
* Layout is SX_SCALAR <length> <data>, with SX_SCALAR already read.
* The scalar is "short" so <length> is single byte. If it is 0, there
* is no <data> section.
*/
static SV *retrieve_scalar(pTHX_ stcxt_t *cxt, char *cname)
{
int len;
SV *sv;
GETMARK(len);
TRACEME(("retrieve_scalar (#%d), len = %d", cxt->tagnum, len));
/*
* Allocate an empty scalar of the suitable length.
*/
sv = NEWSV(10002, len);
SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
/*
* WARNING: duplicates parts of sv_setpv and breaks SV data encapsulation.
*/
if (len == 0) {
/*
* newSV did not upgrade to SVt_PV so the scalar is undefined.
* To make it defined with an empty length, upgrade it now...
* Don't upgrade to a PV if the original type contains more
* information than a scalar.
*/
if (SvTYPE(sv) <= SVt_PV) {
sv_upgrade(sv, SVt_PV);
}
SvGROW(sv, 1);
*SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
TRACEME(("ok (retrieve_scalar empty at 0x%"UVxf")", PTR2UV(sv)));
} else {
/*
* Now, for efficiency reasons, read data directly inside the SV buffer,
* and perform the SV final settings directly by duplicating the final
* work done by sv_setpv. Since we're going to allocate lots of scalars
* this way, it's worth the hassle and risk.
*/
SAFEREAD(SvPVX(sv), len, sv);
SvCUR_set(sv, len); /* Record C string length */
*SvEND(sv) = '\0'; /* Ensure it's null terminated anyway */
TRACEME(("small scalar len %d '%s'", len, SvPVX(sv)));
}
(void) SvPOK_only(sv); /* Validate string pointer */
if (cxt->s_tainted) /* Is input source tainted? */
SvTAINT(sv); /* External data cannot be trusted */
TRACEME(("ok (retrieve_scalar at 0x%"UVxf")", PTR2UV(sv)));
return sv;
}
/*
* retrieve_utf8str
*
* Like retrieve_scalar(), but tag result as utf8.
* If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
*/
static SV *retrieve_utf8str(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
TRACEME(("retrieve_utf8str"));
sv = retrieve_scalar(aTHX_ cxt, cname);
if (sv) {
#ifdef HAS_UTF8_SCALARS
SvUTF8_on(sv);
#else
if (cxt->use_bytes < 0)
cxt->use_bytes
= (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
? 1 : 0);
if (cxt->use_bytes == 0)
UTF8_CROAK();
#endif
}
return sv;
}
/*
* retrieve_lutf8str
*
* Like retrieve_lscalar(), but tag result as utf8.
* If we're retrieving UTF8 data in a non-UTF8 perl, croaks.
*/
static SV *retrieve_lutf8str(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
TRACEME(("retrieve_lutf8str"));
sv = retrieve_lscalar(aTHX_ cxt, cname);
if (sv) {
#ifdef HAS_UTF8_SCALARS
SvUTF8_on(sv);
#else
if (cxt->use_bytes < 0)
cxt->use_bytes
= (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
? 1 : 0);
if (cxt->use_bytes == 0)
UTF8_CROAK();
#endif
}
return sv;
}
/*
* retrieve_integer
*
* Retrieve defined integer.
* Layout is SX_INTEGER <data>, whith SX_INTEGER already read.
*/
static SV *retrieve_integer(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
IV iv;
TRACEME(("retrieve_integer (#%d)", cxt->tagnum));
READ(&iv, sizeof(iv));
sv = newSViv(iv);
SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
TRACEME(("integer %"IVdf, iv));
TRACEME(("ok (retrieve_integer at 0x%"UVxf")", PTR2UV(sv)));
return sv;
}
/*
* retrieve_netint
*
* Retrieve defined integer in network order.
* Layout is SX_NETINT <data>, whith SX_NETINT already read.
*/
static SV *retrieve_netint(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
I32 iv;
TRACEME(("retrieve_netint (#%d)", cxt->tagnum));
READ_I32(iv);
#ifdef HAS_NTOHL
sv = newSViv((int) ntohl(iv));
TRACEME(("network integer %d", (int) ntohl(iv)));
#else
sv = newSViv(iv);
TRACEME(("network integer (as-is) %d", iv));
#endif
SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
TRACEME(("ok (retrieve_netint at 0x%"UVxf")", PTR2UV(sv)));
return sv;
}
/*
* retrieve_double
*
* Retrieve defined double.
* Layout is SX_DOUBLE <data>, whith SX_DOUBLE already read.
*/
static SV *retrieve_double(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
NV nv;
TRACEME(("retrieve_double (#%d)", cxt->tagnum));
READ(&nv, sizeof(nv));
sv = newSVnv(nv);
SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
TRACEME(("double %"NVff, nv));
TRACEME(("ok (retrieve_double at 0x%"UVxf")", PTR2UV(sv)));
return sv;
}
/*
* retrieve_byte
*
* Retrieve defined byte (small integer within the [-128, +127] range).
* Layout is SX_BYTE <data>, whith SX_BYTE already read.
*/
static SV *retrieve_byte(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv;
int siv;
signed char tmp; /* Workaround for AIX cc bug --H.Merijn Brand */
TRACEME(("retrieve_byte (#%d)", cxt->tagnum));
GETMARK(siv);
TRACEME(("small integer read as %d", (unsigned char) siv));
tmp = (unsigned char) siv - 128;
sv = newSViv(tmp);
SEEN(sv, cname, 0); /* Associate this new scalar with tag "tagnum" */
TRACEME(("byte %d", tmp));
TRACEME(("ok (retrieve_byte at 0x%"UVxf")", PTR2UV(sv)));
return sv;
}
/*
* retrieve_undef
*
* Return the undefined value.
*/
static SV *retrieve_undef(pTHX_ stcxt_t *cxt, char *cname)
{
SV* sv;
TRACEME(("retrieve_undef"));
sv = newSV(0);
SEEN(sv, cname, 0);
return sv;
}
/*
* retrieve_sv_undef
*
* Return the immortal undefined value.
*/
static SV *retrieve_sv_undef(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv = &PL_sv_undef;
TRACEME(("retrieve_sv_undef"));
/* Special case PL_sv_undef, as av_fetch uses it internally to mark
deleted elements, and will return NULL (fetch failed) whenever it
is fetched. */
if (cxt->where_is_undef == -1) {
cxt->where_is_undef = cxt->tagnum;
}
SEEN(sv, cname, 1);
return sv;
}
/*
* retrieve_sv_yes
*
* Return the immortal yes value.
*/
static SV *retrieve_sv_yes(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv = &PL_sv_yes;
TRACEME(("retrieve_sv_yes"));
SEEN(sv, cname, 1);
return sv;
}
/*
* retrieve_sv_no
*
* Return the immortal no value.
*/
static SV *retrieve_sv_no(pTHX_ stcxt_t *cxt, char *cname)
{
SV *sv = &PL_sv_no;
TRACEME(("retrieve_sv_no"));
SEEN(sv, cname, 1);
return sv;
}
/*
* retrieve_array
*
* Retrieve a whole array.
* Layout is SX_ARRAY <size> followed by each item, in increading index order.
* Each item is stored as <object>.
*
* When we come here, SX_ARRAY has been read already.
*/
static SV *retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
I32 i;
AV *av;
SV *sv;
TRACEME(("retrieve_array (#%d)", cxt->tagnum));
/*
* Read length, and allocate array, then pre-extend it.
*/
RLEN(len);
TRACEME(("size = %d", len));
av = newAV();
SEEN(av, cname, 0); /* Will return if array not allocated nicely */
if (len)
av_extend(av, len);
else
return (SV *) av; /* No data follow if array is empty */
/*
* Now get each item in turn...
*/
for (i = 0; i < len; i++) {
TRACEME(("(#%d) item", i));
sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
if (!sv)
return (SV *) 0;
if (av_store(av, i, sv) == 0)
return (SV *) 0;
}
TRACEME(("ok (retrieve_array at 0x%"UVxf")", PTR2UV(av)));
return (SV *) av;
}
/*
* retrieve_hash
*
* Retrieve a whole hash table.
* Layout is SX_HASH <size> followed by each key/value pair, in random order.
* Keys are stored as <length> <data>, the <data> section being omitted
* if length is 0.
* Values are stored as <object>.
*
* When we come here, SX_HASH has been read already.
*/
static SV *retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
I32 size;
I32 i;
HV *hv;
SV *sv;
TRACEME(("retrieve_hash (#%d)", cxt->tagnum));
/*
* Read length, allocate table.
*/
RLEN(len);
TRACEME(("size = %d", len));
hv = newHV();
SEEN(hv, cname, 0); /* Will return if table not allocated properly */
if (len == 0)
return (SV *) hv; /* No data follow if table empty */
hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
/*
* Now get each key/value pair in turn...
*/
for (i = 0; i < len; i++) {
/*
* Get value first.
*/
TRACEME(("(#%d) value", i));
sv = retrieve(aTHX_ cxt, 0);
if (!sv)
return (SV *) 0;
/*
* Get key.
* Since we're reading into kbuf, we must ensure we're not
* recursing between the read and the hv_store() where it's used.
* Hence the key comes after the value.
*/
RLEN(size); /* Get key size */
KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
if (size)
READ(kbuf, size);
kbuf[size] = '\0'; /* Mark string end, just in case */
TRACEME(("(#%d) key '%s'", i, kbuf));
/*
* Enter key/value pair into hash table.
*/
if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
return (SV *) 0;
}
TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
return (SV *) hv;
}
/*
* retrieve_hash
*
* Retrieve a whole hash table.
* Layout is SX_HASH <size> followed by each key/value pair, in random order.
* Keys are stored as <length> <data>, the <data> section being omitted
* if length is 0.
* Values are stored as <object>.
*
* When we come here, SX_HASH has been read already.
*/
static SV *retrieve_flag_hash(pTHX_ stcxt_t *cxt, char *cname)
{
dVAR;
I32 len;
I32 size;
I32 i;
HV *hv;
SV *sv;
int hash_flags;
GETMARK(hash_flags);
TRACEME(("retrieve_flag_hash (#%d)", cxt->tagnum));
/*
* Read length, allocate table.
*/
#ifndef HAS_RESTRICTED_HASHES
if (hash_flags & SHV_RESTRICTED) {
if (cxt->derestrict < 0)
cxt->derestrict
= (SvTRUE(perl_get_sv("Storable::downgrade_restricted", TRUE))
? 1 : 0);
if (cxt->derestrict == 0)
RESTRICTED_HASH_CROAK();
}
#endif
RLEN(len);
TRACEME(("size = %d, flags = %d", len, hash_flags));
hv = newHV();
SEEN(hv, cname, 0); /* Will return if table not allocated properly */
if (len == 0)
return (SV *) hv; /* No data follow if table empty */
hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
/*
* Now get each key/value pair in turn...
*/
for (i = 0; i < len; i++) {
int flags;
int store_flags = 0;
/*
* Get value first.
*/
TRACEME(("(#%d) value", i));
sv = retrieve(aTHX_ cxt, 0);
if (!sv)
return (SV *) 0;
GETMARK(flags);
#ifdef HAS_RESTRICTED_HASHES
if ((hash_flags & SHV_RESTRICTED) && (flags & SHV_K_LOCKED))
SvREADONLY_on(sv);
#endif
if (flags & SHV_K_ISSV) {
/* XXX you can't set a placeholder with an SV key.
Then again, you can't get an SV key.
Without messing around beyond what the API is supposed to do.
*/
SV *keysv;
TRACEME(("(#%d) keysv, flags=%d", i, flags));
keysv = retrieve(aTHX_ cxt, 0);
if (!keysv)
return (SV *) 0;
if (!hv_store_ent(hv, keysv, sv, 0))
return (SV *) 0;
} else {
/*
* Get key.
* Since we're reading into kbuf, we must ensure we're not
* recursing between the read and the hv_store() where it's used.
* Hence the key comes after the value.
*/
if (flags & SHV_K_PLACEHOLDER) {
SvREFCNT_dec (sv);
sv = &PL_sv_placeholder;
store_flags |= HVhek_PLACEHOLD;
}
if (flags & SHV_K_UTF8) {
#ifdef HAS_UTF8_HASHES
store_flags |= HVhek_UTF8;
#else
if (cxt->use_bytes < 0)
cxt->use_bytes
= (SvTRUE(perl_get_sv("Storable::drop_utf8", TRUE))
? 1 : 0);
if (cxt->use_bytes == 0)
UTF8_CROAK();
#endif
}
#ifdef HAS_UTF8_HASHES
if (flags & SHV_K_WASUTF8)
store_flags |= HVhek_WASUTF8;
#endif
RLEN(size); /* Get key size */
KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
if (size)
READ(kbuf, size);
kbuf[size] = '\0'; /* Mark string end, just in case */
TRACEME(("(#%d) key '%s' flags %X store_flags %X", i, kbuf,
flags, store_flags));
/*
* Enter key/value pair into hash table.
*/
#ifdef HAS_RESTRICTED_HASHES
if (hv_store_flags(hv, kbuf, size, sv, 0, store_flags) == 0)
return (SV *) 0;
#else
if (!(store_flags & HVhek_PLACEHOLD))
if (hv_store(hv, kbuf, size, sv, 0) == 0)
return (SV *) 0;
#endif
}
}
#ifdef HAS_RESTRICTED_HASHES
if (hash_flags & SHV_RESTRICTED)
SvREADONLY_on(hv);
#endif
TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
return (SV *) hv;
}
/*
* retrieve_code
*
* Return a code reference.
*/
static SV *retrieve_code(pTHX_ stcxt_t *cxt, char *cname)
{
#if PERL_VERSION < 6
CROAK(("retrieve_code does not work with perl 5.005 or less\n"));
#else
dSP;
int type, count, tagnum;
SV *cv;
SV *sv, *text, *sub;
TRACEME(("retrieve_code (#%d)", cxt->tagnum));
/*
* Insert dummy SV in the aseen array so that we don't screw
* up the tag numbers. We would just make the internal
* scalar an untagged item in the stream, but
* retrieve_scalar() calls SEEN(). So we just increase the
* tag number.
*/
tagnum = cxt->tagnum;
sv = newSViv(0);
SEEN(sv, cname, 0);
/*
* Retrieve the source of the code reference
* as a small or large scalar
*/
GETMARK(type);
switch (type) {
case SX_SCALAR:
text = retrieve_scalar(aTHX_ cxt, cname);
break;
case SX_LSCALAR:
text = retrieve_lscalar(aTHX_ cxt, cname);
break;
default:
CROAK(("Unexpected type %d in retrieve_code\n", type));
}
/*
* prepend "sub " to the source
*/
sub = newSVpvn("sub ", 4);
sv_catpv(sub, SvPV_nolen(text)); /* XXX no sv_catsv! */
SvREFCNT_dec(text);
/*
* evaluate the source to a code reference and use the CV value
*/
if (cxt->eval == NULL) {
cxt->eval = perl_get_sv("Storable::Eval", TRUE);
SvREFCNT_inc(cxt->eval);
}
if (!SvTRUE(cxt->eval)) {
if (
cxt->forgive_me == 0 ||
(cxt->forgive_me < 0 && !(cxt->forgive_me =
SvTRUE(perl_get_sv("Storable::forgive_me", TRUE)) ? 1 : 0))
) {
CROAK(("Can't eval, please set $Storable::Eval to a true value"));
} else {
sv = newSVsv(sub);
/* fix up the dummy entry... */
av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
return sv;
}
}
ENTER;
SAVETMPS;
if (SvROK(cxt->eval) && SvTYPE(SvRV(cxt->eval)) == SVt_PVCV) {
SV* errsv = get_sv("@", TRUE);
sv_setpv(errsv, ""); /* clear $@ */
PUSHMARK(sp);
XPUSHs(sv_2mortal(newSVsv(sub)));
PUTBACK;
count = call_sv(cxt->eval, G_SCALAR);
SPAGAIN;
if (count != 1)
CROAK(("Unexpected return value from $Storable::Eval callback\n"));
cv = POPs;
if (SvTRUE(errsv)) {
CROAK(("code %s caused an error: %s",
SvPV_nolen(sub), SvPV_nolen(errsv)));
}
PUTBACK;
} else {
cv = eval_pv(SvPV_nolen(sub), TRUE);
}
if (cv && SvROK(cv) && SvTYPE(SvRV(cv)) == SVt_PVCV) {
sv = SvRV(cv);
} else {
CROAK(("code %s did not evaluate to a subroutine reference\n", SvPV_nolen(sub)));
}
SvREFCNT_inc(sv); /* XXX seems to be necessary */
SvREFCNT_dec(sub);
FREETMPS;
LEAVE;
/* fix up the dummy entry... */
av_store(cxt->aseen, tagnum, SvREFCNT_inc(sv));
return sv;
#endif
}
/*
* old_retrieve_array
*
* Retrieve a whole array in pre-0.6 binary format.
*
* Layout is SX_ARRAY <size> followed by each item, in increading index order.
* Each item is stored as SX_ITEM <object> or SX_IT_UNDEF for "holes".
*
* When we come here, SX_ARRAY has been read already.
*/
static SV *old_retrieve_array(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
I32 i;
AV *av;
SV *sv;
int c;
TRACEME(("old_retrieve_array (#%d)", cxt->tagnum));
/*
* Read length, and allocate array, then pre-extend it.
*/
RLEN(len);
TRACEME(("size = %d", len));
av = newAV();
SEEN(av, 0, 0); /* Will return if array not allocated nicely */
if (len)
av_extend(av, len);
else
return (SV *) av; /* No data follow if array is empty */
/*
* Now get each item in turn...
*/
for (i = 0; i < len; i++) {
GETMARK(c);
if (c == SX_IT_UNDEF) {
TRACEME(("(#%d) undef item", i));
continue; /* av_extend() already filled us with undef */
}
if (c != SX_ITEM)
(void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
TRACEME(("(#%d) item", i));
sv = retrieve(aTHX_ cxt, 0); /* Retrieve item */
if (!sv)
return (SV *) 0;
if (av_store(av, i, sv) == 0)
return (SV *) 0;
}
TRACEME(("ok (old_retrieve_array at 0x%"UVxf")", PTR2UV(av)));
return (SV *) av;
}
/*
* old_retrieve_hash
*
* Retrieve a whole hash table in pre-0.6 binary format.
*
* Layout is SX_HASH <size> followed by each key/value pair, in random order.
* Keys are stored as SX_KEY <length> <data>, the <data> section being omitted
* if length is 0.
* Values are stored as SX_VALUE <object> or SX_VL_UNDEF for "holes".
*
* When we come here, SX_HASH has been read already.
*/
static SV *old_retrieve_hash(pTHX_ stcxt_t *cxt, char *cname)
{
I32 len;
I32 size;
I32 i;
HV *hv;
SV *sv = (SV *) 0;
int c;
SV *sv_h_undef = (SV *) 0; /* hv_store() bug */
TRACEME(("old_retrieve_hash (#%d)", cxt->tagnum));
/*
* Read length, allocate table.
*/
RLEN(len);
TRACEME(("size = %d", len));
hv = newHV();
SEEN(hv, 0, 0); /* Will return if table not allocated properly */
if (len == 0)
return (SV *) hv; /* No data follow if table empty */
hv_ksplit(hv, len); /* pre-extend hash to save multiple splits */
/*
* Now get each key/value pair in turn...
*/
for (i = 0; i < len; i++) {
/*
* Get value first.
*/
GETMARK(c);
if (c == SX_VL_UNDEF) {
TRACEME(("(#%d) undef value", i));
/*
* Due to a bug in hv_store(), it's not possible to pass
* &PL_sv_undef to hv_store() as a value, otherwise the
* associated key will not be creatable any more. -- RAM, 14/01/97
*/
if (!sv_h_undef)
sv_h_undef = newSVsv(&PL_sv_undef);
sv = SvREFCNT_inc(sv_h_undef);
} else if (c == SX_VALUE) {
TRACEME(("(#%d) value", i));
sv = retrieve(aTHX_ cxt, 0);
if (!sv)
return (SV *) 0;
} else
(void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
/*
* Get key.
* Since we're reading into kbuf, we must ensure we're not
* recursing between the read and the hv_store() where it's used.
* Hence the key comes after the value.
*/
GETMARK(c);
if (c != SX_KEY)
(void) retrieve_other(aTHX_ (stcxt_t *) 0, 0); /* Will croak out */
RLEN(size); /* Get key size */
KBUFCHK((STRLEN)size); /* Grow hash key read pool if needed */
if (size)
READ(kbuf, size);
kbuf[size] = '\0'; /* Mark string end, just in case */
TRACEME(("(#%d) key '%s'", i, kbuf));
/*
* Enter key/value pair into hash table.
*/
if (hv_store(hv, kbuf, (U32) size, sv, 0) == 0)
return (SV *) 0;
}
TRACEME(("ok (retrieve_hash at 0x%"UVxf")", PTR2UV(hv)));
return (SV *) hv;
}
/***
*** Retrieval engine.
***/
/*
* magic_check
*
* Make sure the stored data we're trying to retrieve has been produced
* on an ILP compatible system with the same byteorder. It croaks out in
* case an error is detected. [ILP = integer-long-pointer sizes]
* Returns null if error is detected, &PL_sv_undef otherwise.
*
* Note that there's no byte ordering info emitted when network order was
* used at store time.
*/
static SV *magic_check(pTHX_ stcxt_t *cxt)
{
/* The worst case for a malicious header would be old magic (which is
longer), major, minor, byteorder length byte of 255, 255 bytes of
garbage, sizeof int, long, pointer, NV.
So the worse of that we can read is 255 bytes of garbage plus 4.
Err, I am assuming 8 bit bytes here. Please file a bug report if you're
compiling perl on a system with chars that are larger than 8 bits.
(Even Crays aren't *that* perverse).
*/
unsigned char buf[4 + 255];
unsigned char *current;
int c;
int length;
int use_network_order;
int use_NV_size;
int version_major;
int version_minor = 0;
TRACEME(("magic_check"));
/*
* The "magic number" is only for files, not when freezing in memory.
*/
if (cxt->fio) {
/* This includes the '\0' at the end. I want to read the extra byte,
which is usually going to be the major version number. */
STRLEN len = sizeof(magicstr);
STRLEN old_len;
READ(buf, (SSize_t)(len)); /* Not null-terminated */
/* Point at the byte after the byte we read. */
current = buf + --len; /* Do the -- outside of macros. */
if (memNE(buf, magicstr, len)) {
/*
* Try to read more bytes to check for the old magic number, which
* was longer.
*/
TRACEME(("trying for old magic number"));
old_len = sizeof(old_magicstr) - 1;
READ(current + 1, (SSize_t)(old_len - len));
if (memNE(buf, old_magicstr, old_len))
CROAK(("File is not a perl storable"));
current = buf + old_len;
}
use_network_order = *current;
} else
GETMARK(use_network_order);
/*
* Starting with 0.6, the "use_network_order" byte flag is also used to
* indicate the version number of the binary, and therefore governs the
* setting of sv_retrieve_vtbl. See magic_write().
*/
version_major = use_network_order >> 1;
cxt->retrieve_vtbl = (SV*(**)(pTHX_ stcxt_t *cxt, char *cname)) (version_major ? sv_retrieve : sv_old_retrieve);
TRACEME(("magic_check: netorder = 0x%x", use_network_order));
/*
* Starting with 0.7 (binary major 2), a full byte is dedicated to the
* minor version of the protocol. See magic_write().
*/
if (version_major > 1)
GETMARK(version_minor);
cxt->ver_major = version_major;
cxt->ver_minor = version_minor;
TRACEME(("binary image version is %d.%d", version_major, version_minor));
/*
* Inter-operability sanity check: we can't retrieve something stored
* using a format more recent than ours, because we have no way to
* know what has changed, and letting retrieval go would mean a probable
* failure reporting a "corrupted" storable file.
*/
if (
version_major > STORABLE_BIN_MAJOR ||
(version_major == STORABLE_BIN_MAJOR &&
version_minor > STORABLE_BIN_MINOR)
) {
int croak_now = 1;
TRACEME(("but I am version is %d.%d", STORABLE_BIN_MAJOR,
STORABLE_BIN_MINOR));
if (version_major == STORABLE_BIN_MAJOR) {
TRACEME(("cxt->accept_future_minor is %d",
cxt->accept_future_minor));
if (cxt->accept_future_minor < 0)
cxt->accept_future_minor
= (SvTRUE(perl_get_sv("Storable::accept_future_minor",
TRUE))
? 1 : 0);
if (cxt->accept_future_minor == 1)
croak_now = 0; /* Don't croak yet. */
}
if (croak_now) {
CROAK(("Storable binary image v%d.%d more recent than I am (v%d.%d)",
version_major, version_minor,
STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR));
}
}
/*
* If they stored using network order, there's no byte ordering
* information to check.
*/
if ((cxt->netorder = (use_network_order & 0x1))) /* Extra () for -Wall */
return &PL_sv_undef; /* No byte ordering info */
/* In C truth is 1, falsehood is 0. Very convienient. */
use_NV_size = version_major >= 2 && version_minor >= 2;
GETMARK(c);
length = c + 3 + use_NV_size;
READ(buf, length); /* Not null-terminated */
TRACEME(("byte order '%.*s' %d", c, buf, c));
#ifdef USE_56_INTERWORK_KLUDGE
/* No point in caching this in the context as we only need it once per
retrieve, and we need to recheck it each read. */
if (SvTRUE(perl_get_sv("Storable::interwork_56_64bit", TRUE))) {
if ((c != (sizeof (byteorderstr_56) - 1))
|| memNE(buf, byteorderstr_56, c))
CROAK(("Byte order is not compatible"));
} else
#endif
{
if ((c != (sizeof (byteorderstr) - 1)) || memNE(buf, byteorderstr, c))
CROAK(("Byte order is not compatible"));
}
current = buf + c;
/* sizeof(int) */
if ((int) *current++ != sizeof(int))
CROAK(("Integer size is not compatible"));
/* sizeof(long) */
if ((int) *current++ != sizeof(long))
CROAK(("Long integer size is not compatible"));
/* sizeof(char *) */
if ((int) *current != sizeof(char *))
CROAK(("Pointer size is not compatible"));
if (use_NV_size) {
/* sizeof(NV) */
if ((int) *++current != sizeof(NV))
CROAK(("Double size is not compatible"));
}
return &PL_sv_undef; /* OK */
}
/*
* retrieve
*
* Recursively retrieve objects from the specified file and return their
* root SV (which may be an AV or an HV for what we care).
* Returns null if there is a problem.
*/
static SV *retrieve(pTHX_ stcxt_t *cxt, char *cname)
{
int type;
SV **svh;
SV *sv;
TRACEME(("retrieve"));
/*
* Grab address tag which identifies the object if we are retrieving
* an older format. Since the new binary format counts objects and no
* longer explicitely tags them, we must keep track of the correspondance
* ourselves.
*
* The following section will disappear one day when the old format is
* no longer supported, hence the final "goto" in the "if" block.
*/
if (cxt->hseen) { /* Retrieving old binary */
stag_t tag;
if (cxt->netorder) {
I32 nettag;
READ(&nettag, sizeof(I32)); /* Ordered sequence of I32 */
tag = (stag_t) nettag;
} else
READ(&tag, sizeof(stag_t)); /* Original address of the SV */
GETMARK(type);
if (type == SX_OBJECT) {
I32 tagn;
svh = hv_fetch(cxt->hseen, (char *) &tag, sizeof(tag), FALSE);
if (!svh)
CROAK(("Old tag 0x%"UVxf" should have been mapped already",
(UV) tag));
tagn = SvIV(*svh); /* Mapped tag number computed earlier below */
/*
* The following code is common with the SX_OBJECT case below.
*/
svh = av_fetch(cxt->aseen, tagn, FALSE);
if (!svh)
CROAK(("Object #%"IVdf" should have been retrieved already",
(IV) tagn));
sv = *svh;
TRACEME(("has retrieved #%d at 0x%"UVxf, tagn, PTR2UV(sv)));
SvREFCNT_inc(sv); /* One more reference to this same sv */
return sv; /* The SV pointer where object was retrieved */
}
/*
* Map new object, but don't increase tagnum. This will be done
* by each of the retrieve_* functions when they call SEEN().
*
* The mapping associates the "tag" initially present with a unique
* tag number. See test for SX_OBJECT above to see how this is perused.
*/
if (!hv_store(cxt->hseen, (char *) &tag, sizeof(tag),
newSViv(cxt->tagnum), 0))
return (SV *) 0;
goto first_time;
}
/*
* Regular post-0.6 binary format.
*/
GETMARK(type);
TRACEME(("retrieve type = %d", type));
/*
* Are we dealing with an object we should have already retrieved?
*/
if (type == SX_OBJECT) {
I32 tag;
READ_I32(tag);
tag = ntohl(tag);
svh = av_fetch(cxt->aseen, tag, FALSE);
if (!svh)
CROAK(("Object #%"IVdf" should have been retrieved already",
(IV) tag));
sv = *svh;
TRACEME(("had retrieved #%d at 0x%"UVxf, tag, PTR2UV(sv)));
SvREFCNT_inc(sv); /* One more reference to this same sv */
return sv; /* The SV pointer where object was retrieved */
} else if (type >= SX_ERROR && cxt->ver_minor > STORABLE_BIN_MINOR) {
if (cxt->accept_future_minor < 0)
cxt->accept_future_minor
= (SvTRUE(perl_get_sv("Storable::accept_future_minor",
TRUE))
? 1 : 0);
if (cxt->accept_future_minor == 1) {
CROAK(("Storable binary image v%d.%d contains data of type %d. "
"This Storable is v%d.%d and can only handle data types up to %d",
cxt->ver_major, cxt->ver_minor, type,
STORABLE_BIN_MAJOR, STORABLE_BIN_MINOR, SX_ERROR - 1));
}
}
first_time: /* Will disappear when support for old format is dropped */
/*
* Okay, first time through for this one.
*/
sv = RETRIEVE(cxt, type)(aTHX_ cxt, cname);
if (!sv)
return (SV *) 0; /* Failed */
/*
* Old binary formats (pre-0.7).
*
* Final notifications, ended by SX_STORED may now follow.
* Currently, the only pertinent notification to apply on the
* freshly retrieved object is either:
* SX_CLASS <char-len> <classname> for short classnames.
* SX_LG_CLASS <int-len> <classname> for larger one (rare!).
* Class name is then read into the key buffer pool used by
* hash table key retrieval.
*/
if (cxt->ver_major < 2) {
while ((type = GETCHAR()) != SX_STORED) {
I32 len;
switch (type) {
case SX_CLASS:
GETMARK(len); /* Length coded on a single char */
break;
case SX_LG_CLASS: /* Length coded on a regular integer */
RLEN(len);
break;
case EOF:
default:
return (SV *) 0; /* Failed */
}
KBUFCHK((STRLEN)len); /* Grow buffer as necessary */
if (len)
READ(kbuf, len);
kbuf[len] = '\0'; /* Mark string end */
BLESS(sv, kbuf);
}
}
TRACEME(("ok (retrieved 0x%"UVxf", refcnt=%d, %s)", PTR2UV(sv),
SvREFCNT(sv) - 1, sv_reftype(sv, FALSE)));
return sv; /* Ok */
}
/*
* do_retrieve
*
* Retrieve data held in file and return the root object.
* Common routine for pretrieve and mretrieve.
*/
static SV *do_retrieve(
pTHX_
PerlIO *f,
SV *in,
int optype)
{
dSTCXT;
SV *sv;
int is_tainted; /* Is input source tainted? */
int pre_06_fmt = 0; /* True with pre Storable 0.6 formats */
TRACEME(("do_retrieve (optype = 0x%x)", optype));
optype |= ST_RETRIEVE;
/*
* Sanity assertions for retrieve dispatch tables.
*/
ASSERT(sizeof(sv_old_retrieve) == sizeof(sv_retrieve),
("old and new retrieve dispatch table have same size"));
ASSERT(sv_old_retrieve[SX_ERROR] == retrieve_other,
("SX_ERROR entry correctly initialized in old dispatch table"));
ASSERT(sv_retrieve[SX_ERROR] == retrieve_other,
("SX_ERROR entry correctly initialized in new dispatch table"));
/*
* Workaround for CROAK leak: if they enter with a "dirty" context,
* free up memory for them now.
*/
if (cxt->s_dirty)
clean_context(aTHX_ cxt);
/*
* Now that STORABLE_xxx hooks exist, it is possible that they try to
* re-enter retrieve() via the hooks.
*/
if (cxt->entry)
cxt = allocate_context(aTHX_ cxt);
cxt->entry++;
ASSERT(cxt->entry == 1, ("starting new recursion"));
ASSERT(!cxt->s_dirty, ("clean context"));
/*
* Prepare context.
*
* Data is loaded into the memory buffer when f is NULL, unless `in' is
* also NULL, in which case we're expecting the data to already lie
* in the buffer (dclone case).
*/
KBUFINIT(); /* Allocate hash key reading pool once */
if (!f && in) {
#ifdef SvUTF8_on
if (SvUTF8(in)) {
STRLEN length;
const char *orig = SvPV(in, length);
char *asbytes;
/* This is quite deliberate. I want the UTF8 routines
to encounter the '\0' which perl adds at the end
of all scalars, so that any new string also has
this.
*/
STRLEN klen_tmp = length + 1;
bool is_utf8 = TRUE;
/* Just casting the &klen to (STRLEN) won't work
well if STRLEN and I32 are of different widths.
--jhi */
asbytes = (char*)bytes_from_utf8((U8*)orig,
&klen_tmp,
&is_utf8);
if (is_utf8) {
CROAK(("Frozen string corrupt - contains characters outside 0-255"));
}
if (asbytes != orig) {
/* String has been converted.
There is no need to keep any reference to
the old string. */
in = sv_newmortal();
/* We donate the SV the malloc()ed string
bytes_from_utf8 returned us. */
SvUPGRADE(in, SVt_PV);
SvPOK_on(in);
SvPV_set(in, asbytes);
SvLEN_set(in, klen_tmp);
SvCUR_set(in, klen_tmp - 1);
}
}
#endif
MBUF_SAVE_AND_LOAD(in);
}
/*
* Magic number verifications.
*
* This needs to be done before calling init_retrieve_context()
* since the format indication in the file are necessary to conduct
* some of the initializations.
*/
cxt->fio = f; /* Where I/O are performed */
if (!magic_check(aTHX_ cxt))
CROAK(("Magic number checking on storable %s failed",
cxt->fio ? "file" : "string"));
TRACEME(("data stored in %s format",
cxt->netorder ? "net order" : "native"));
/*
* Check whether input source is tainted, so that we don't wrongly
* taint perfectly good values...
*
* We assume file input is always tainted. If both `f' and `in' are
* NULL, then we come from dclone, and tainted is already filled in
* the context. That's a kludge, but the whole dclone() thing is
* already quite a kludge anyway! -- RAM, 15/09/2000.
*/
is_tainted = f ? 1 : (in ? SvTAINTED(in) : cxt->s_tainted);
TRACEME(("input source is %s", is_tainted ? "tainted" : "trusted"));
init_retrieve_context(aTHX_ cxt, optype, is_tainted);
ASSERT(is_retrieving(aTHX), ("within retrieve operation"));
sv = retrieve(aTHX_ cxt, 0); /* Recursively retrieve object, get root SV */
/*
* Final cleanup.
*/
if (!f && in)
MBUF_RESTORE();
pre_06_fmt = cxt->hseen != NULL; /* Before we clean context */
/*
* The "root" context is never freed.
*/
clean_retrieve_context(aTHX_ cxt);
if (cxt->prev) /* This context was stacked */
free_context(aTHX_ cxt); /* It was not the "root" context */
/*
* Prepare returned value.
*/
if (!sv) {
TRACEME(("retrieve ERROR"));
#if (PATCHLEVEL <= 4)
/* perl 5.00405 seems to screw up at this point with an
'attempt to modify a read only value' error reported in the
eval { $self = pretrieve(*FILE) } in _retrieve.
I can't see what the cause of this error is, but I suspect a
bug in 5.004, as it seems to be capable of issuing spurious
errors or core dumping with matches on $@. I'm not going to
spend time on what could be a fruitless search for the cause,
so here's a bodge. If you're running 5.004 and don't like
this inefficiency, either upgrade to a newer perl, or you are
welcome to find the problem and send in a patch.
*/
return newSV(0);
#else
return &PL_sv_undef; /* Something went wrong, return undef */
#endif
}
TRACEME(("retrieve got %s(0x%"UVxf")",
sv_reftype(sv, FALSE), PTR2UV(sv)));
/*
* Backward compatibility with Storable-0.5@9 (which we know we
* are retrieving if hseen is non-null): don't create an extra RV
* for objects since we special-cased it at store time.
*
* Build a reference to the SV returned by pretrieve even if it is
* already one and not a scalar, for consistency reasons.
*/
if (pre_06_fmt) { /* Was not handling overloading by then */
SV *rv;
TRACEME(("fixing for old formats -- pre 0.6"));
if (sv_type(aTHX_ sv) == svis_REF && (rv = SvRV(sv)) && SvOBJECT(rv)) {
TRACEME(("ended do_retrieve() with an object -- pre 0.6"));
return sv;
}
}
/*
* If reference is overloaded, restore behaviour.
*
* NB: minor glitch here: normally, overloaded refs are stored specially
* so that we can croak when behaviour cannot be re-installed, and also
* avoid testing for overloading magic at each reference retrieval.
*
* Unfortunately, the root reference is implicitely stored, so we must
* check for possible overloading now. Furthermore, if we don't restore
* overloading, we cannot croak as if the original ref was, because we
* have no way to determine whether it was an overloaded ref or not in
* the first place.
*
* It's a pity that overloading magic is attached to the rv, and not to
* the underlying sv as blessing is.
*/
if (SvOBJECT(sv)) {
HV *stash = (HV *) SvSTASH(sv);
SV *rv = newRV_noinc(sv);
if (stash && Gv_AMG(stash)) {
SvAMAGIC_on(rv);
TRACEME(("restored overloading on root reference"));
}
TRACEME(("ended do_retrieve() with an object"));
return rv;
}
TRACEME(("regular do_retrieve() end"));
return newRV_noinc(sv);
}
/*
* pretrieve
*
* Retrieve data held in file and return the root object, undef on error.
*/
SV *pretrieve(pTHX_ PerlIO *f)
{
TRACEME(("pretrieve"));
return do_retrieve(aTHX_ f, Nullsv, 0);
}
/*
* mretrieve
*
* Retrieve data held in scalar and return the root object, undef on error.
*/
SV *mretrieve(pTHX_ SV *sv)
{
TRACEME(("mretrieve"));
return do_retrieve(aTHX_ (PerlIO*) 0, sv, 0);
}
/***
*** Deep cloning
***/
/*
* dclone
*
* Deep clone: returns a fresh copy of the original referenced SV tree.
*
* This is achieved by storing the object in memory and restoring from
* there. Not that efficient, but it should be faster than doing it from
* pure perl anyway.
*/
SV *dclone(pTHX_ SV *sv)
{
dSTCXT;
int size;
stcxt_t *real_context;
SV *out;
TRACEME(("dclone"));
/*
* Workaround for CROAK leak: if they enter with a "dirty" context,
* free up memory for them now.
*/
if (cxt->s_dirty)
clean_context(aTHX_ cxt);
/*
* do_store() optimizes for dclone by not freeing its context, should
* we need to allocate one because we're deep cloning from a hook.
*/
if (!do_store(aTHX_ (PerlIO*) 0, sv, ST_CLONE, FALSE, (SV**) 0))
return &PL_sv_undef; /* Error during store */
/*
* Because of the above optimization, we have to refresh the context,
* since a new one could have been allocated and stacked by do_store().
*/
{ dSTCXT; real_context = cxt; } /* Sub-block needed for macro */
cxt = real_context; /* And we need this temporary... */
/*
* Now, `cxt' may refer to a new context.
*/
ASSERT(!cxt->s_dirty, ("clean context"));
ASSERT(!cxt->entry, ("entry will not cause new context allocation"));
size = MBUF_SIZE();
TRACEME(("dclone stored %d bytes", size));
MBUF_INIT(size);
/*
* Since we're passing do_retrieve() both a NULL file and sv, we need
* to pre-compute the taintedness of the input by setting cxt->tainted
* to whatever state our own input string was. -- RAM, 15/09/2000
*
* do_retrieve() will free non-root context.
*/
cxt->s_tainted = SvTAINTED(sv);
out = do_retrieve(aTHX_ (PerlIO*) 0, Nullsv, ST_CLONE);
TRACEME(("dclone returns 0x%"UVxf, PTR2UV(out)));
return out;
}
/***
*** Glue with perl.
***/
/*
* The Perl IO GV object distinguishes between input and output for sockets
* but not for plain files. To allow Storable to transparently work on
* plain files and sockets transparently, we have to ask xsubpp to fetch the
* right object for us. Hence the OutputStream and InputStream declarations.
*
* Before perl 5.004_05, those entries in the standard typemap are not
* defined in perl include files, so we do that here.
*/
#ifndef OutputStream
#define OutputStream PerlIO *
#define InputStream PerlIO *
#endif /* !OutputStream */
MODULE = Storable PACKAGE = Storable::Cxt
void
DESTROY(self)
SV *self
PREINIT:
stcxt_t *cxt = (stcxt_t *)SvPVX(SvRV(self));
PPCODE:
if (kbuf)
Safefree(kbuf);
if (!cxt->membuf_ro && mbase)
Safefree(mbase);
if (cxt->membuf_ro && (cxt->msaved).arena)
Safefree((cxt->msaved).arena);
MODULE = Storable PACKAGE = Storable
PROTOTYPES: ENABLE
BOOT:
init_perinterp(aTHX);
gv_fetchpv("Storable::drop_utf8", GV_ADDMULTI, SVt_PV);
#ifdef DEBUGME
/* Only disable the used only once warning if we are in debugging mode. */
gv_fetchpv("Storable::DEBUGME", GV_ADDMULTI, SVt_PV);
#endif
#ifdef USE_56_INTERWORK_KLUDGE
gv_fetchpv("Storable::interwork_56_64bit", GV_ADDMULTI, SVt_PV);
#endif
void
init_perinterp()
CODE:
init_perinterp(aTHX);
int
pstore(f,obj)
OutputStream f
SV * obj
CODE:
RETVAL = pstore(aTHX_ f, obj);
OUTPUT:
RETVAL
int
net_pstore(f,obj)
OutputStream f
SV * obj
CODE:
RETVAL = net_pstore(aTHX_ f, obj);
OUTPUT:
RETVAL
SV *
mstore(obj)
SV * obj
CODE:
RETVAL = mstore(aTHX_ obj);
OUTPUT:
RETVAL
SV *
net_mstore(obj)
SV * obj
CODE:
RETVAL = net_mstore(aTHX_ obj);
OUTPUT:
RETVAL
SV *
pretrieve(f)
InputStream f
CODE:
RETVAL = pretrieve(aTHX_ f);
OUTPUT:
RETVAL
SV *
mretrieve(sv)
SV * sv
CODE:
RETVAL = mretrieve(aTHX_ sv);
OUTPUT:
RETVAL
SV *
dclone(sv)
SV * sv
CODE:
RETVAL = dclone(aTHX_ sv);
OUTPUT:
RETVAL
int
last_op_in_netorder()
CODE:
RETVAL = last_op_in_netorder(aTHX);
OUTPUT:
RETVAL
int
is_storing()
CODE:
RETVAL = is_storing(aTHX);
OUTPUT:
RETVAL
int
is_retrieving()
CODE:
RETVAL = is_retrieving(aTHX);
OUTPUT:
RETVAL
|