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
|
/*
Copyright (c) 2008-2009, Patrick Galbraith & Antony Curtis
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Neither the name of Patrick Galbraith nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
FederatedX Pluggable Storage Engine
ha_federatedx.cc - FederatedX Pluggable Storage Engine
Patrick Galbraith, 2008
This is a handler which uses a foreign database as the data file, as
opposed to a handler like MyISAM, which uses .MYD files locally.
How this handler works
----------------------------------
Normal database files are local and as such: You create a table called
'users', a file such as 'users.MYD' is created. A handler reads, inserts,
deletes, updates data in this file. The data is stored in particular format,
so to read, that data has to be parsed into fields, to write, fields have to
be stored in this format to write to this data file.
With FederatedX storage engine, there will be no local files
for each table's data (such as .MYD). A foreign database will store
the data that would normally be in this file. This will necessitate
the use of MySQL client API to read, delete, update, insert this
data. The data will have to be retrieve via an SQL call "SELECT *
FROM users". Then, to read this data, it will have to be retrieved
via mysql_fetch_row one row at a time, then converted from the
column in this select into the format that the handler expects.
The create table will simply create the .frm file, and within the
"CREATE TABLE" SQL, there SHALL be any of the following :
connection=scheme://username:password@hostname:port/database/tablename
connection=scheme://username@hostname/database/tablename
connection=scheme://username:password@hostname/database/tablename
connection=scheme://username:password@hostname/database/tablename
- OR -
As of 5.1 federatedx now allows you to use a non-url
format, taking advantage of mysql.servers:
connection="connection_one"
connection="connection_one/table_foo"
An example would be:
connection=mysql://username:password@hostname:port/database/tablename
or, if we had:
create server 'server_one' foreign data wrapper 'mysql' options
(HOST '127.0.0.1',
DATABASE 'db1',
USER 'root',
PASSWORD '',
PORT 3306,
SOCKET '',
OWNER 'root');
CREATE TABLE federatedx.t1 (
`id` int(20) NOT NULL,
`name` varchar(64) NOT NULL default ''
)
ENGINE="FEDERATEDX" DEFAULT CHARSET=latin1
CONNECTION='server_one';
So, this will have been the equivalent of
CONNECTION="mysql://root@127.0.0.1:3306/db1/t1"
Then, we can also change the server to point to a new schema:
ALTER SERVER 'server_one' options(DATABASE 'db2');
All subsequent calls will now be against db2.t1! Guess what? You don't
have to perform an alter table!
This connecton="connection string" is necessary for the handler to be
able to connect to the foreign server, either by URL, or by server
name.
The basic flow is this:
SQL calls issues locally ->
mysql handler API (data in handler format) ->
mysql client API (data converted to SQL calls) ->
foreign database -> mysql client API ->
convert result sets (if any) to handler format ->
handler API -> results or rows affected to local
What this handler does and doesn't support
------------------------------------------
* Tables MUST be created on the foreign server prior to any action on those
tables via the handler, first version. IMPORTANT: IF you MUST use the
federatedx storage engine type on the REMOTE end, MAKE SURE [ :) ] That
the table you connect to IS NOT a table pointing BACK to your ORIGNAL
table! You know and have heard the screaching of audio feedback? You
know putting two mirror in front of each other how the reflection
continues for eternity? Well, need I say more?!
* There will not be support for transactions.
* There is no way for the handler to know if the foreign database or table
has changed. The reason for this is that this database has to work like a
data file that would never be written to by anything other than the
database. The integrity of the data in the local table could be breached
if there was any change to the foreign database.
* Support for SELECT, INSERT, UPDATE , DELETE, indexes.
* No ALTER TABLE, DROP TABLE or any other Data Definition Language calls.
* Prepared statements will not be used in the first implementation, it
remains to to be seen whether the limited subset of the client API for the
server supports this.
* This uses SELECT, INSERT, UPDATE, DELETE and not HANDLER for its
implementation.
* This will not work with the query cache.
Method calls
A two column table, with one record:
(SELECT)
"SELECT * FROM foo"
ha_federatedx::info
ha_federatedx::scan_time:
ha_federatedx::rnd_init: share->select_query SELECT * FROM foo
ha_federatedx::extra
<for every row of data retrieved>
ha_federatedx::rnd_next
ha_federatedx::convert_row_to_internal_format
ha_federatedx::rnd_next
</for every row of data retrieved>
ha_federatedx::rnd_end
ha_federatedx::extra
ha_federatedx::reset
(INSERT)
"INSERT INTO foo (id, ts) VALUES (2, now());"
ha_federatedx::write_row
ha_federatedx::reset
(UPDATE)
"UPDATE foo SET ts = now() WHERE id = 1;"
ha_federatedx::index_init
ha_federatedx::index_read
ha_federatedx::index_read_idx
ha_federatedx::rnd_next
ha_federatedx::convert_row_to_internal_format
ha_federatedx::update_row
ha_federatedx::extra
ha_federatedx::extra
ha_federatedx::extra
ha_federatedx::external_lock
ha_federatedx::reset
How do I use this handler?
--------------------------
<insert text about plugin storage engine>
Next, to use this handler, it's very simple. You must
have two databases running, either both on the same host, or
on different hosts.
One the server that will be connecting to the foreign
host (client), you create your table as such:
CREATE TABLE test_table (
id int(20) NOT NULL auto_increment,
name varchar(32) NOT NULL default '',
other int(20) NOT NULL default '0',
PRIMARY KEY (id),
KEY name (name),
KEY other_key (other))
ENGINE="FEDERATEDX"
DEFAULT CHARSET=latin1
CONNECTION='mysql://root@127.0.0.1:9306/federatedx/test_federatedx';
Notice the "COMMENT" and "ENGINE" field? This is where you
respectively set the engine type, "FEDERATEDX" and foreign
host information, this being the database your 'client' database
will connect to and use as the "data file". Obviously, the foreign
database is running on port 9306, so you want to start up your other
database so that it is indeed on port 9306, and your federatedx
database on a port other than that. In my setup, I use port 5554
for federatedx, and port 5555 for the foreign database.
Then, on the foreign database:
CREATE TABLE test_table (
id int(20) NOT NULL auto_increment,
name varchar(32) NOT NULL default '',
other int(20) NOT NULL default '0',
PRIMARY KEY (id),
KEY name (name),
KEY other_key (other))
ENGINE="<NAME>" <-- whatever you want, or not specify
DEFAULT CHARSET=latin1 ;
This table is exactly the same (and must be exactly the same),
except that it is not using the federatedx handler and does
not need the URL.
How to see the handler in action
--------------------------------
When developing this handler, I compiled the federatedx database with
debugging:
./configure --with-federatedx-storage-engine
--prefix=/home/mysql/mysql-build/federatedx/ --with-debug
Once compiled, I did a 'make install' (not for the purpose of installing
the binary, but to install all the files the binary expects to see in the
diretory I specified in the build with --prefix,
"/home/mysql/mysql-build/federatedx".
Then, I started the foreign server:
/usr/local/mysql/bin/mysqld_safe
--user=mysql --log=/tmp/mysqld.5555.log -P 5555
Then, I went back to the directory containing the newly compiled mysqld,
<builddir>/sql/, started up gdb:
gdb ./mysqld
Then, withn the (gdb) prompt:
(gdb) run --gdb --port=5554 --socket=/tmp/mysqld.5554 --skip-innodb --debug-dbug
Next, I open several windows for each:
1. Tail the debug trace: tail -f /tmp/mysqld.trace|grep ha_fed
2. Tail the SQL calls to the foreign database: tail -f /tmp/mysqld.5555.log
3. A window with a client open to the federatedx server on port 5554
4. A window with a client open to the federatedx server on port 5555
I would create a table on the client to the foreign server on port
5555, and then to the federatedx server on port 5554. At this point,
I would run whatever queries I wanted to on the federatedx server,
just always remembering that whatever changes I wanted to make on
the table, or if I created new tables, that I would have to do that
on the foreign server.
Another thing to look for is 'show variables' to show you that you have
support for federatedx handler support:
show variables like '%federat%'
and:
show storage engines;
Both should display the federatedx storage handler.
Testing
-------
Testing for FederatedX as a pluggable storage engine for
now is a manual process that I intend to build a test
suite that works for all pluggable storage engines.
How to test
1. cp fed.dat /tmp
(make sure you have access to "test". Use a user that has
super privileges for now)
2. mysql -f -u root test < federated.test > federated.myresult 2>&1
3. diff federated.result federated.myresult (there _should_ be no differences)
*/
#ifdef USE_PRAGMA_IMPLEMENTATION
#pragma implementation // gcc: Class implementation
#endif
#define MYSQL_SERVER 1
#include <my_global.h>
#include <mysql/plugin.h>
#include "ha_federatedx.h"
#include "sql_servers.h"
#include "sql_analyse.h" // append_escaped()
#include "sql_show.h" // append_identifier()
#ifdef I_AM_PARANOID
#define MIN_PORT 1023
#else
#define MIN_PORT 0
#endif
/* Variables for federatedx share methods */
static HASH federatedx_open_tables; // To track open tables
static HASH federatedx_open_servers; // To track open servers
mysql_mutex_t federatedx_mutex; // To init the hash
const char ident_quote_char= '`'; // Character for quoting
// identifiers
const char value_quote_char= '\''; // Character for quoting
// literals
static const int bulk_padding= 64; // bytes "overhead" in packet
/* Variables used when chopping off trailing characters */
static const uint sizeof_trailing_comma= sizeof(", ") - 1;
static const uint sizeof_trailing_and= sizeof(" AND ") - 1;
static const uint sizeof_trailing_where= sizeof(" WHERE ") - 1;
/* Static declaration for handerton */
static handler *federatedx_create_handler(handlerton *hton,
TABLE_SHARE *table,
MEM_ROOT *mem_root);
/* FederatedX storage engine handlerton */
static handler *federatedx_create_handler(handlerton *hton,
TABLE_SHARE *table,
MEM_ROOT *mem_root)
{
return new (mem_root) ha_federatedx(hton, table);
}
/* Function we use in the creation of our hash to get key */
static uchar *
federatedx_share_get_key(FEDERATEDX_SHARE *share, size_t *length,
my_bool not_used __attribute__ ((unused)))
{
*length= share->share_key_length;
return (uchar*) share->share_key;
}
static uchar *
federatedx_server_get_key(FEDERATEDX_SERVER *server, size_t *length,
my_bool not_used __attribute__ ((unused)))
{
*length= server->key_length;
return server->key;
}
#ifdef HAVE_PSI_INTERFACE
static PSI_mutex_key fe_key_mutex_federatedx, fe_key_mutex_FEDERATEDX_SERVER_mutex;
static PSI_mutex_info all_federated_mutexes[]=
{
{ &fe_key_mutex_federatedx, "federatedx", PSI_FLAG_GLOBAL},
{ &fe_key_mutex_FEDERATEDX_SERVER_mutex, "FEDERATED_SERVER::mutex", 0}
};
static void init_federated_psi_keys(void)
{
const char* category= "federated";
int count;
if (PSI_server == NULL)
return;
count= array_elements(all_federated_mutexes);
PSI_server->register_mutex(category, all_federated_mutexes, count);
}
#else
#define init_federated_psi_keys() /* no-op */
#endif /* HAVE_PSI_INTERFACE */
/*
Initialize the federatedx handler.
SYNOPSIS
federatedx_db_init()
p Handlerton
RETURN
FALSE OK
TRUE Error
*/
int federatedx_db_init(void *p)
{
DBUG_ENTER("federatedx_db_init");
init_federated_psi_keys();
handlerton *federatedx_hton= (handlerton *)p;
federatedx_hton->state= SHOW_OPTION_YES;
/* Needed to work with old .frm files */
federatedx_hton->db_type= DB_TYPE_FEDERATED_DB;
federatedx_hton->savepoint_offset= sizeof(ulong);
federatedx_hton->close_connection= ha_federatedx::disconnect;
federatedx_hton->savepoint_set= ha_federatedx::savepoint_set;
federatedx_hton->savepoint_rollback= ha_federatedx::savepoint_rollback;
federatedx_hton->savepoint_release= ha_federatedx::savepoint_release;
federatedx_hton->commit= ha_federatedx::commit;
federatedx_hton->rollback= ha_federatedx::rollback;
federatedx_hton->discover_table_structure= ha_federatedx::discover_assisted;
federatedx_hton->create= federatedx_create_handler;
federatedx_hton->flags= HTON_ALTER_NOT_SUPPORTED;
if (mysql_mutex_init(fe_key_mutex_federatedx,
&federatedx_mutex, MY_MUTEX_INIT_FAST))
goto error;
if (!my_hash_init(&federatedx_open_tables, &my_charset_bin, 32, 0, 0,
(my_hash_get_key) federatedx_share_get_key, 0, 0) &&
!my_hash_init(&federatedx_open_servers, &my_charset_bin, 32, 0, 0,
(my_hash_get_key) federatedx_server_get_key, 0, 0))
{
DBUG_RETURN(FALSE);
}
mysql_mutex_destroy(&federatedx_mutex);
error:
DBUG_RETURN(TRUE);
}
/*
Release the federatedx handler.
SYNOPSIS
federatedx_db_end()
RETURN
FALSE OK
*/
int federatedx_done(void *p)
{
my_hash_free(&federatedx_open_tables);
my_hash_free(&federatedx_open_servers);
mysql_mutex_destroy(&federatedx_mutex);
return 0;
}
/**
@brief Append identifiers to the string.
@param[in,out] string The target string.
@param[in] name Identifier name
@param[in] length Length of identifier name in bytes
@param[in] quote_char Quote char to use for quoting identifier.
@return Operation Status
@retval FALSE OK
@retval TRUE There was an error appending to the string.
@note This function is based upon the append_identifier() function
in sql_show.cc except that quoting always occurs.
*/
bool append_ident(String *string, const char *name, uint length,
const char quote_char)
{
bool result;
uint clen;
const char *name_end;
DBUG_ENTER("append_ident");
if (quote_char)
{
string->reserve(length * 2 + 2);
if ((result= string->append("e_char, 1, system_charset_info)))
goto err;
for (name_end= name+length; name < name_end; name+= clen)
{
uchar c= *(uchar *) name;
clen= my_charlen_fix(system_charset_info, name, name_end);
if (clen == 1 && c == (uchar) quote_char &&
(result= string->append("e_char, 1, system_charset_info)))
goto err;
if ((result= string->append(name, clen, string->charset())))
goto err;
}
result= string->append("e_char, 1, system_charset_info);
}
else
result= string->append(name, length, system_charset_info);
err:
DBUG_RETURN(result);
}
static int parse_url_error(FEDERATEDX_SHARE *share, TABLE_SHARE *table_s,
int error_num)
{
char buf[FEDERATEDX_QUERY_BUFFER_SIZE];
int buf_len;
DBUG_ENTER("ha_federatedx parse_url_error");
buf_len= MY_MIN(table_s->connect_string.length,
FEDERATEDX_QUERY_BUFFER_SIZE-1);
strmake(buf, table_s->connect_string.str, buf_len);
my_error(error_num, MYF(0), buf, 14);
DBUG_RETURN(error_num);
}
/*
retrieve server object which contains server meta-data
from the system table given a server's name, set share
connection parameter members
*/
int get_connection(MEM_ROOT *mem_root, FEDERATEDX_SHARE *share)
{
int error_num= ER_FOREIGN_SERVER_DOESNT_EXIST;
FOREIGN_SERVER *server, server_buffer;
DBUG_ENTER("ha_federatedx::get_connection");
/*
get_server_by_name() clones the server if exists and allocates
copies of strings in the supplied mem_root
*/
if (!(server=
get_server_by_name(mem_root, share->connection_string, &server_buffer)))
{
DBUG_PRINT("info", ("get_server_by_name returned > 0 error condition!"));
/* need to come up with error handling */
error_num=1;
goto error;
}
DBUG_PRINT("info", ("get_server_by_name returned server at %p",
server));
/*
Most of these should never be empty strings, error handling will
need to be implemented. Also, is this the best way to set the share
members? Is there some allocation needed? In running this code, it works
except there are errors in the trace file of the share being overrun
at the address of the share.
*/
share->server_name_length= server->server_name_length;
share->server_name= const_cast<char*>(server->server_name);
share->username= const_cast<char*>(server->username);
share->password= const_cast<char*>(server->password);
share->database= const_cast<char*>(server->db);
share->port= server->port > MIN_PORT && server->port < 65536 ?
(ushort) server->port : MYSQL_PORT;
share->hostname= const_cast<char*>(server->host);
if (!(share->socket= const_cast<char*>(server->socket)) &&
!strcmp(share->hostname, my_localhost))
share->socket= (char *) MYSQL_UNIX_ADDR;
share->scheme= const_cast<char*>(server->scheme);
DBUG_PRINT("info", ("share->username: %s", share->username));
DBUG_PRINT("info", ("share->password: %s", share->password));
DBUG_PRINT("info", ("share->hostname: %s", share->hostname));
DBUG_PRINT("info", ("share->database: %s", share->database));
DBUG_PRINT("info", ("share->port: %d", share->port));
DBUG_PRINT("info", ("share->socket: %s", share->socket));
DBUG_RETURN(0);
error:
my_printf_error(error_num, "server name: '%s' doesn't exist!",
MYF(0), share->connection_string);
DBUG_RETURN(error_num);
}
/*
Parse connection info from table->s->connect_string
SYNOPSIS
parse_url()
mem_root MEM_ROOT pointer for memory allocation
share pointer to FEDERATEDX share
table pointer to current TABLE class
table_create_flag determines what error to throw
DESCRIPTION
Populates the share with information about the connection
to the foreign database that will serve as the data source.
This string must be specified (currently) in the "CONNECTION" field,
listed in the CREATE TABLE statement.
This string MUST be in the format of any of these:
CONNECTION="scheme://username:password@hostname:port/database/table"
CONNECTION="scheme://username@hostname/database/table"
CONNECTION="scheme://username@hostname:port/database/table"
CONNECTION="scheme://username:password@hostname/database/table"
_OR_
CONNECTION="connection name"
An Example:
CREATE TABLE t1 (id int(32))
ENGINE="FEDERATEDX"
CONNECTION="mysql://joe:joespass@192.168.1.111:9308/federatedx/testtable";
CREATE TABLE t2 (
id int(4) NOT NULL auto_increment,
name varchar(32) NOT NULL,
PRIMARY KEY(id)
) ENGINE="FEDERATEDX" CONNECTION="my_conn";
***IMPORTANT***
Currently, the FederatedX Storage Engine only supports connecting to another
Database ("scheme" of "mysql"). Connections using JDBC as well as
other connectors are in the planning stage.
'password' and 'port' are both optional.
RETURN VALUE
0 success
error_num particular error code
*/
static int parse_url(MEM_ROOT *mem_root, FEDERATEDX_SHARE *share,
TABLE_SHARE *table_s, uint table_create_flag)
{
uint error_num= (table_create_flag ?
ER_FOREIGN_DATA_STRING_INVALID_CANT_CREATE :
ER_FOREIGN_DATA_STRING_INVALID);
DBUG_ENTER("ha_federatedx::parse_url");
share->port= 0;
share->socket= 0;
DBUG_PRINT("info", ("share at %p", share));
DBUG_PRINT("info", ("Length: %u", (uint) table_s->connect_string.length));
DBUG_PRINT("info", ("String: '%.*s'", (int) table_s->connect_string.length,
table_s->connect_string.str));
share->connection_string= strmake_root(mem_root, table_s->connect_string.str,
table_s->connect_string.length);
DBUG_PRINT("info",("parse_url alloced share->connection_string %p",
share->connection_string));
DBUG_PRINT("info",("share->connection_string: %s",share->connection_string));
/*
No :// or @ in connection string. Must be a straight connection name of
either "servername" or "servername/tablename"
*/
if ((!strstr(share->connection_string, "://") &&
(!strchr(share->connection_string, '@'))))
{
DBUG_PRINT("info",
("share->connection_string: %s internal format "
"share->connection_string: %p",
share->connection_string,
share->connection_string));
/* ok, so we do a little parsing, but not completely! */
share->parsed= FALSE;
/*
If there is a single '/' in the connection string, this means the user is
specifying a table name
*/
if ((share->table_name= strchr(share->connection_string, '/')))
{
*share->table_name++= '\0';
share->table_name_length= strlen(share->table_name);
DBUG_PRINT("info",
("internal format, parsed table_name "
"share->connection_string: %s share->table_name: %s",
share->connection_string, share->table_name));
/*
there better not be any more '/'s !
*/
if (strchr(share->table_name, '/'))
goto error;
}
/*
Otherwise, straight server name, use tablename of federatedx table
as remote table name
*/
else
{
/*
Connection specifies everything but, resort to
expecting remote and foreign table names to match
*/
share->table_name= strmake_root(mem_root, table_s->table_name.str,
(share->table_name_length=
table_s->table_name.length));
DBUG_PRINT("info",
("internal format, default table_name "
"share->connection_string: %s share->table_name: %s",
share->connection_string, share->table_name));
}
if ((error_num= get_connection(mem_root, share)))
goto error;
}
else
{
share->parsed= TRUE;
// Add a null for later termination of table name
share->connection_string[table_s->connect_string.length]= 0;
share->scheme= share->connection_string;
DBUG_PRINT("info",("parse_url alloced share->scheme: %p",
share->scheme));
/*
Remove addition of null terminator and store length
for each string in share
*/
if (!(share->username= strstr(share->scheme, "://")))
goto error;
share->scheme[share->username - share->scheme]= '\0';
if (!federatedx_io::handles_scheme(share->scheme))
goto error;
share->username+= 3;
if (!(share->hostname= strchr(share->username, '@')))
goto error;
*share->hostname++= '\0'; // End username
if ((share->password= strchr(share->username, ':')))
{
*share->password++= '\0'; // End username
/* make sure there isn't an extra / or @ */
if ((strchr(share->password, '/') || strchr(share->hostname, '@')))
goto error;
/*
Found that if the string is:
user:@hostname:port/db/table
Then password is a null string, so set to NULL
*/
if (share->password[0] == '\0')
share->password= NULL;
}
/* make sure there isn't an extra / or @ */
if ((strchr(share->username, '/')) || (strchr(share->hostname, '@')))
goto error;
if (!(share->database= strchr(share->hostname, '/')))
goto error;
*share->database++= '\0';
if ((share->sport= strchr(share->hostname, ':')))
{
*share->sport++= '\0';
if (share->sport[0] == '\0')
share->sport= NULL;
else
share->port= atoi(share->sport);
}
if (!(share->table_name= strchr(share->database, '/')))
goto error;
*share->table_name++= '\0';
share->table_name_length= strlen(share->table_name);
/* make sure there's not an extra / */
if ((strchr(share->table_name, '/')))
goto error;
if (share->hostname[0] == '\0')
share->hostname= NULL;
}
if (!share->port)
{
if (!share->hostname || strcmp(share->hostname, my_localhost) == 0)
share->socket= (char *) MYSQL_UNIX_ADDR;
else
share->port= MYSQL_PORT;
}
DBUG_PRINT("info",
("scheme: %s username: %s password: %s hostname: %s "
"port: %d db: %s tablename: %s",
share->scheme, share->username, share->password,
share->hostname, share->port, share->database,
share->table_name));
DBUG_RETURN(0);
error:
DBUG_RETURN(parse_url_error(share, table_s, error_num));
}
/*****************************************************************************
** FEDERATEDX tables
*****************************************************************************/
ha_federatedx::ha_federatedx(handlerton *hton,
TABLE_SHARE *table_arg)
:handler(hton, table_arg),
txn(0), io(0), stored_result(0)
{
bzero(&bulk_insert, sizeof(bulk_insert));
}
/*
Convert MySQL result set row to handler internal format
SYNOPSIS
convert_row_to_internal_format()
record Byte pointer to record
row MySQL result set row from fetchrow()
result Result set to use
DESCRIPTION
This method simply iterates through a row returned via fetchrow with
values from a successful SELECT , and then stores each column's value
in the field object via the field object pointer (pointing to the table's
array of field object pointers). This is how the handler needs the data
to be stored to then return results back to the user
RETURN VALUE
0 After fields have had field values stored from record
*/
uint ha_federatedx::convert_row_to_internal_format(uchar *record,
FEDERATEDX_IO_ROW *row,
FEDERATEDX_IO_RESULT *result)
{
ulong *lengths;
Field **field;
int column= 0;
my_bitmap_map *old_map= dbug_tmp_use_all_columns(table, table->write_set);
DBUG_ENTER("ha_federatedx::convert_row_to_internal_format");
lengths= io->fetch_lengths(result);
for (field= table->field; *field; field++, column++)
{
/*
index variable to move us through the row at the
same iterative step as the field
*/
my_ptrdiff_t old_ptr;
old_ptr= (my_ptrdiff_t) (record - table->record[0]);
(*field)->move_field_offset(old_ptr);
if (io->is_column_null(row, column))
(*field)->set_null();
else
{
if (bitmap_is_set(table->read_set, (*field)->field_index))
{
(*field)->set_notnull();
(*field)->store(io->get_column_data(row, column), lengths[column], &my_charset_bin);
}
}
(*field)->move_field_offset(-old_ptr);
}
dbug_tmp_restore_column_map(table->write_set, old_map);
DBUG_RETURN(0);
}
static bool emit_key_part_name(String *to, KEY_PART_INFO *part)
{
DBUG_ENTER("emit_key_part_name");
if (append_ident(to, part->field->field_name.str,
part->field->field_name.length, ident_quote_char))
DBUG_RETURN(1); // Out of memory
DBUG_RETURN(0);
}
static bool emit_key_part_element(String *to, KEY_PART_INFO *part,
bool needs_quotes, bool is_like,
const uchar *ptr, uint len)
{
Field *field= part->field;
DBUG_ENTER("emit_key_part_element");
if (needs_quotes && to->append(STRING_WITH_LEN("'")))
DBUG_RETURN(1);
if (part->type == HA_KEYTYPE_BIT)
{
char buff[STRING_BUFFER_USUAL_SIZE], *buf= buff;
*buf++= '0';
*buf++= 'x';
buf= octet2hex(buf, (char*) ptr, len);
if (to->append((char*) buff, (uint)(buf - buff)))
DBUG_RETURN(1);
}
else if (part->key_part_flag & HA_BLOB_PART)
{
String blob;
uint blob_length= uint2korr(ptr);
blob.set_quick((char*) ptr+HA_KEY_BLOB_LENGTH,
blob_length, &my_charset_bin);
if (to->append_for_single_quote(&blob))
DBUG_RETURN(1);
}
else if (part->key_part_flag & HA_VAR_LENGTH_PART)
{
String varchar;
uint var_length= uint2korr(ptr);
varchar.set_quick((char*) ptr+HA_KEY_BLOB_LENGTH,
var_length, &my_charset_bin);
if (to->append_for_single_quote(&varchar))
DBUG_RETURN(1);
}
else
{
char strbuff[MAX_FIELD_WIDTH];
String str(strbuff, sizeof(strbuff), part->field->charset()), *res;
res= field->val_str(&str, ptr);
if (field->result_type() == STRING_RESULT)
{
if (to->append_for_single_quote(res))
DBUG_RETURN(1);
}
else if (to->append(res->ptr(), res->length()))
DBUG_RETURN(1);
}
if (is_like && to->append(STRING_WITH_LEN("%")))
DBUG_RETURN(1);
if (needs_quotes && to->append(STRING_WITH_LEN("'")))
DBUG_RETURN(1);
DBUG_RETURN(0);
}
/*
Create a WHERE clause based off of values in keys
Note: This code was inspired by key_copy from key.cc
SYNOPSIS
create_where_from_key ()
to String object to store WHERE clause
key_info KEY struct pointer
key byte pointer containing key
key_length length of key
range_type 0 - no range, 1 - min range, 2 - max range
(see enum range_operation)
DESCRIPTION
Using iteration through all the keys via a KEY_PART_INFO pointer,
This method 'extracts' the value of each key in the byte pointer
*key, and for each key found, constructs an appropriate WHERE clause
RETURN VALUE
0 After all keys have been accounted for to create the WHERE clause
1 No keys found
Range flags Table per Timour:
-----------------
- start_key:
* ">" -> HA_READ_AFTER_KEY
* ">=" -> HA_READ_KEY_OR_NEXT
* "=" -> HA_READ_KEY_EXACT
- end_key:
* "<" -> HA_READ_BEFORE_KEY
* "<=" -> HA_READ_AFTER_KEY
records_in_range:
-----------------
- start_key:
* ">" -> HA_READ_AFTER_KEY
* ">=" -> HA_READ_KEY_EXACT
* "=" -> HA_READ_KEY_EXACT
- end_key:
* "<" -> HA_READ_BEFORE_KEY
* "<=" -> HA_READ_AFTER_KEY
* "=" -> HA_READ_AFTER_KEY
0 HA_READ_KEY_EXACT, Find first record else error
1 HA_READ_KEY_OR_NEXT, Record or next record
2 HA_READ_KEY_OR_PREV, Record or previous
3 HA_READ_AFTER_KEY, Find next rec. after key-record
4 HA_READ_BEFORE_KEY, Find next rec. before key-record
5 HA_READ_PREFIX, Key which as same prefix
6 HA_READ_PREFIX_LAST, Last key with the same prefix
7 HA_READ_PREFIX_LAST_OR_PREV, Last or prev key with the same prefix
Flags that I've found:
id, primary key, varchar
id = 'ccccc'
records_in_range: start_key 0 end_key 3
read_range_first: start_key 0 end_key NULL
id > 'ccccc'
records_in_range: start_key 3 end_key NULL
read_range_first: start_key 3 end_key NULL
id < 'ccccc'
records_in_range: start_key NULL end_key 4
read_range_first: start_key NULL end_key 4
id <= 'ccccc'
records_in_range: start_key NULL end_key 3
read_range_first: start_key NULL end_key 3
id >= 'ccccc'
records_in_range: start_key 0 end_key NULL
read_range_first: start_key 1 end_key NULL
id like 'cc%cc'
records_in_range: start_key 0 end_key 3
read_range_first: start_key 1 end_key 3
id > 'aaaaa' and id < 'ccccc'
records_in_range: start_key 3 end_key 4
read_range_first: start_key 3 end_key 4
id >= 'aaaaa' and id < 'ccccc';
records_in_range: start_key 0 end_key 4
read_range_first: start_key 1 end_key 4
id >= 'aaaaa' and id <= 'ccccc';
records_in_range: start_key 0 end_key 3
read_range_first: start_key 1 end_key 3
id > 'aaaaa' and id <= 'ccccc';
records_in_range: start_key 3 end_key 3
read_range_first: start_key 3 end_key 3
numeric keys:
id = 4
index_read_idx: start_key 0 end_key NULL
id > 4
records_in_range: start_key 3 end_key NULL
read_range_first: start_key 3 end_key NULL
id >= 4
records_in_range: start_key 0 end_key NULL
read_range_first: start_key 1 end_key NULL
id < 4
records_in_range: start_key NULL end_key 4
read_range_first: start_key NULL end_key 4
id <= 4
records_in_range: start_key NULL end_key 3
read_range_first: start_key NULL end_key 3
id like 4
full table scan, select * from
id > 2 and id < 8
records_in_range: start_key 3 end_key 4
read_range_first: start_key 3 end_key 4
id >= 2 and id < 8
records_in_range: start_key 0 end_key 4
read_range_first: start_key 1 end_key 4
id >= 2 and id <= 8
records_in_range: start_key 0 end_key 3
read_range_first: start_key 1 end_key 3
id > 2 and id <= 8
records_in_range: start_key 3 end_key 3
read_range_first: start_key 3 end_key 3
multi keys (id int, name varchar, other varchar)
id = 1;
records_in_range: start_key 0 end_key 3
read_range_first: start_key 0 end_key NULL
id > 4;
id > 2 and name = '333'; remote: id > 2
id > 2 and name > '333'; remote: id > 2
id > 2 and name > '333' and other < 'ddd'; remote: id > 2 no results
id > 2 and name >= '333' and other < 'ddd'; remote: id > 2 1 result
id >= 4 and name = 'eric was here' and other > 'eeee';
records_in_range: start_key 3 end_key NULL
read_range_first: start_key 3 end_key NULL
id >= 4;
id >= 2 and name = '333' and other < 'ddd';
remote: `id` >= 2 AND `name` >= '333';
records_in_range: start_key 0 end_key NULL
read_range_first: start_key 1 end_key NULL
id < 4;
id < 3 and name = '222' and other <= 'ccc'; remote: id < 3
records_in_range: start_key NULL end_key 4
read_range_first: start_key NULL end_key 4
id <= 4;
records_in_range: start_key NULL end_key 3
read_range_first: start_key NULL end_key 3
id like 4;
full table scan
id > 2 and id < 4;
records_in_range: start_key 3 end_key 4
read_range_first: start_key 3 end_key 4
id >= 2 and id < 4;
records_in_range: start_key 0 end_key 4
read_range_first: start_key 1 end_key 4
id >= 2 and id <= 4;
records_in_range: start_key 0 end_key 3
read_range_first: start_key 1 end_key 3
id > 2 and id <= 4;
id = 6 and name = 'eric was here' and other > 'eeee';
remote: (`id` > 6 AND `name` > 'eric was here' AND `other` > 'eeee')
AND (`id` <= 6) AND ( AND `name` <= 'eric was here')
no results
records_in_range: start_key 3 end_key 3
read_range_first: start_key 3 end_key 3
Summary:
* If the start key flag is 0 the max key flag shouldn't even be set,
and if it is, the query produced would be invalid.
* Multipart keys, even if containing some or all numeric columns,
are treated the same as non-numeric keys
If the query is " = " (quotes or not):
- records in range start key flag HA_READ_KEY_EXACT,
end key flag HA_READ_AFTER_KEY (incorrect)
- any other: start key flag HA_READ_KEY_OR_NEXT,
end key flag HA_READ_AFTER_KEY (correct)
* 'like' queries (of key)
- Numeric, full table scan
- Non-numeric
records_in_range: start_key 0 end_key 3
other : start_key 1 end_key 3
* If the key flag is HA_READ_AFTER_KEY:
if start_key, append >
if end_key, append <=
* If create_where_key was called by records_in_range:
- if the key is numeric:
start key flag is 0 when end key is NULL, end key flag is 3 or 4
- if create_where_key was called by any other function:
start key flag is 1 when end key is NULL, end key flag is 3 or 4
- if the key is non-numeric, or multipart
When the query is an exact match, the start key flag is 0,
end key flag is 3 for what should be a no-range condition where
you should have 0 and max key NULL, which it is if called by
read_range_first
Conclusion:
1. Need logic to determin if a key is min or max when the flag is
HA_READ_AFTER_KEY, and handle appending correct operator accordingly
2. Need a boolean flag to pass to create_where_from_key, used in the
switch statement. Add 1 to the flag if:
- start key flag is HA_READ_KEY_EXACT and the end key is NULL
*/
bool ha_federatedx::create_where_from_key(String *to,
KEY *key_info,
const key_range *start_key,
const key_range *end_key,
bool from_records_in_range,
bool eq_range)
{
bool both_not_null=
(start_key != NULL && end_key != NULL) ? TRUE : FALSE;
const uchar *ptr;
uint remainder, length;
char tmpbuff[FEDERATEDX_QUERY_BUFFER_SIZE];
String tmp(tmpbuff, sizeof(tmpbuff), system_charset_info);
const key_range *ranges[2]= { start_key, end_key };
my_bitmap_map *old_map;
DBUG_ENTER("ha_federatedx::create_where_from_key");
tmp.length(0);
if (start_key == NULL && end_key == NULL)
DBUG_RETURN(1);
old_map= dbug_tmp_use_all_columns(table, table->write_set);
for (uint i= 0; i <= 1; i++)
{
bool needs_quotes;
KEY_PART_INFO *key_part;
if (ranges[i] == NULL)
continue;
if (both_not_null)
{
if (i > 0)
tmp.append(STRING_WITH_LEN(") AND ("));
else
tmp.append(STRING_WITH_LEN(" ("));
}
for (key_part= key_info->key_part,
remainder= key_info->user_defined_key_parts,
length= ranges[i]->length,
ptr= ranges[i]->key; ;
remainder--,
key_part++)
{
Field *field= key_part->field;
uint store_length= key_part->store_length;
uint part_length= MY_MIN(store_length, length);
needs_quotes= field->str_needs_quotes();
DBUG_DUMP("key, start of loop", ptr, length);
if (key_part->null_bit)
{
if (*ptr++)
{
/*
We got "IS [NOT] NULL" condition against nullable column. We
distinguish between "IS NOT NULL" and "IS NULL" by flag. For
"IS NULL", flag is set to HA_READ_KEY_EXACT.
*/
if (emit_key_part_name(&tmp, key_part) ||
tmp.append(ranges[i]->flag == HA_READ_KEY_EXACT ?
" IS NULL " : " IS NOT NULL "))
goto err;
/*
We need to adjust pointer and length to be prepared for next
key part. As well as check if this was last key part.
*/
goto prepare_for_next_key_part;
}
}
if (tmp.append(STRING_WITH_LEN(" (")))
goto err;
switch (ranges[i]->flag) {
case HA_READ_KEY_EXACT:
DBUG_PRINT("info", ("federatedx HA_READ_KEY_EXACT %d", i));
if (store_length >= length ||
!needs_quotes ||
key_part->type == HA_KEYTYPE_BIT ||
field->result_type() != STRING_RESULT)
{
if (emit_key_part_name(&tmp, key_part))
goto err;
if (from_records_in_range)
{
if (tmp.append(STRING_WITH_LEN(" >= ")))
goto err;
}
else
{
if (tmp.append(STRING_WITH_LEN(" = ")))
goto err;
}
if (emit_key_part_element(&tmp, key_part, needs_quotes, 0, ptr,
part_length))
goto err;
}
else
{
/* LIKE */
if (emit_key_part_name(&tmp, key_part) ||
tmp.append(STRING_WITH_LEN(" LIKE ")) ||
emit_key_part_element(&tmp, key_part, needs_quotes, 1, ptr,
part_length))
goto err;
}
break;
case HA_READ_AFTER_KEY:
if (eq_range)
{
if (tmp.append("1=1")) // Dummy
goto err;
break;
}
DBUG_PRINT("info", ("federatedx HA_READ_AFTER_KEY %d", i));
if (store_length >= length || i > 0) /* end key */
{
if (emit_key_part_name(&tmp, key_part))
goto err;
if (i > 0) /* end key */
{
if (tmp.append(STRING_WITH_LEN(" <= ")))
goto err;
}
else /* start key */
{
if (tmp.append(STRING_WITH_LEN(" > ")))
goto err;
}
if (emit_key_part_element(&tmp, key_part, needs_quotes, 0, ptr,
part_length))
{
goto err;
}
break;
}
/* fall through */
case HA_READ_KEY_OR_NEXT:
DBUG_PRINT("info", ("federatedx HA_READ_KEY_OR_NEXT %d", i));
if (emit_key_part_name(&tmp, key_part) ||
tmp.append(STRING_WITH_LEN(" >= ")) ||
emit_key_part_element(&tmp, key_part, needs_quotes, 0, ptr,
part_length))
goto err;
break;
case HA_READ_BEFORE_KEY:
DBUG_PRINT("info", ("federatedx HA_READ_BEFORE_KEY %d", i));
if (store_length >= length)
{
if (emit_key_part_name(&tmp, key_part) ||
tmp.append(STRING_WITH_LEN(" < ")) ||
emit_key_part_element(&tmp, key_part, needs_quotes, 0, ptr,
part_length))
goto err;
break;
}
/* fall through */
case HA_READ_KEY_OR_PREV:
DBUG_PRINT("info", ("federatedx HA_READ_KEY_OR_PREV %d", i));
if (emit_key_part_name(&tmp, key_part) ||
tmp.append(STRING_WITH_LEN(" <= ")) ||
emit_key_part_element(&tmp, key_part, needs_quotes, 0, ptr,
part_length))
goto err;
break;
default:
DBUG_PRINT("info",("cannot handle flag %d", ranges[i]->flag));
goto err;
}
if (tmp.append(STRING_WITH_LEN(") ")))
goto err;
prepare_for_next_key_part:
if (store_length >= length)
break;
DBUG_PRINT("info", ("remainder %d", remainder));
DBUG_ASSERT(remainder > 1);
length-= store_length;
/*
For nullable columns, null-byte is already skipped before, that is
ptr was incremented by 1. Since store_length still counts null-byte,
we need to subtract 1 from store_length.
*/
ptr+= store_length - MY_TEST(key_part->null_bit);
if (tmp.append(STRING_WITH_LEN(" AND ")))
goto err;
DBUG_PRINT("info",
("create_where_from_key WHERE clause: %s",
tmp.c_ptr_quick()));
}
}
dbug_tmp_restore_column_map(table->write_set, old_map);
if (both_not_null)
if (tmp.append(STRING_WITH_LEN(") ")))
DBUG_RETURN(1);
if (to->append(STRING_WITH_LEN(" WHERE ")))
DBUG_RETURN(1);
if (to->append(tmp))
DBUG_RETURN(1);
DBUG_RETURN(0);
err:
dbug_tmp_restore_column_map(table->write_set, old_map);
DBUG_RETURN(1);
}
static void fill_server(MEM_ROOT *mem_root, FEDERATEDX_SERVER *server,
FEDERATEDX_SHARE *share, CHARSET_INFO *table_charset)
{
char buffer[STRING_BUFFER_USUAL_SIZE];
String key(buffer, sizeof(buffer), &my_charset_bin);
String scheme(share->scheme, &my_charset_latin1);
String hostname(share->hostname, &my_charset_latin1);
String database(share->database, system_charset_info);
String username(share->username, system_charset_info);
String socket(share->socket ? share->socket : "", files_charset_info);
String password(share->password ? share->password : "", &my_charset_bin);
DBUG_ENTER("fill_server");
/* Do some case conversions */
scheme.reserve(scheme.length());
scheme.length(my_casedn_str(&my_charset_latin1, scheme.c_ptr_safe()));
hostname.reserve(hostname.length());
hostname.length(my_casedn_str(&my_charset_latin1, hostname.c_ptr_safe()));
if (lower_case_table_names)
{
database.reserve(database.length());
database.length(my_casedn_str(system_charset_info, database.c_ptr_safe()));
}
#ifndef __WIN__
/*
TODO: there is no unix sockets under windows so the engine should be
revised about using sockets in such environment.
*/
if (lower_case_file_system && socket.length())
{
socket.reserve(socket.length());
socket.length(my_casedn_str(files_charset_info, socket.c_ptr_safe()));
}
#endif
/* start with all bytes zeroed */
bzero(server, sizeof(*server));
key.length(0);
key.reserve(scheme.length() + hostname.length() + database.length() +
socket.length() + username.length() + password.length() +
sizeof(int) + 8);
key.append(scheme);
key.q_append('\0');
server->hostname= (const char *) (intptr) key.length();
key.append(hostname);
key.q_append('\0');
server->database= (const char *) (intptr) key.length();
key.append(database);
key.q_append('\0');
key.q_append((uint32) share->port);
server->socket= (const char *) (intptr) key.length();
key.append(socket);
key.q_append('\0');
server->username= (const char *) (intptr) key.length();
key.append(username);
key.q_append('\0');
server->password= (const char *) (intptr) key.length();
key.append(password);
key.c_ptr_safe(); // Ensure we have end \0
server->key_length= key.length();
/* Copy and add end \0 */
server->key= (uchar *) strmake_root(mem_root, key.ptr(), key.length());
/* pointer magic */
server->scheme+= (intptr) server->key;
server->hostname+= (intptr) server->key;
server->database+= (intptr) server->key;
server->username+= (intptr) server->key;
server->password+= (intptr) server->key;
server->socket+= (intptr) server->key;
server->port= share->port;
if (!share->socket)
server->socket= NULL;
if (!share->password)
server->password= NULL;
if (table_charset)
server->csname= strdup_root(mem_root, table_charset->csname);
DBUG_VOID_RETURN;
}
static FEDERATEDX_SERVER *get_server(FEDERATEDX_SHARE *share, TABLE *table)
{
FEDERATEDX_SERVER *server= NULL, tmp_server;
MEM_ROOT mem_root;
char buffer[STRING_BUFFER_USUAL_SIZE];
String key(buffer, sizeof(buffer), &my_charset_bin);
String scheme(share->scheme, &my_charset_latin1);
String hostname(share->hostname, &my_charset_latin1);
String database(share->database, system_charset_info);
String username(share->username, system_charset_info);
String socket(share->socket ? share->socket : "", files_charset_info);
String password(share->password ? share->password : "", &my_charset_bin);
DBUG_ENTER("ha_federated.cc::get_server");
mysql_mutex_assert_owner(&federatedx_mutex);
init_alloc_root(&mem_root, "federated", 4096, 4096, MYF(0));
fill_server(&mem_root, &tmp_server, share, table ? table->s->table_charset : 0);
if (!(server= (FEDERATEDX_SERVER *) my_hash_search(&federatedx_open_servers,
tmp_server.key,
tmp_server.key_length)))
{
if (!table || !tmp_server.csname)
goto error;
if (!(server= (FEDERATEDX_SERVER *) memdup_root(&mem_root,
(char *) &tmp_server,
sizeof(*server))))
goto error;
server->mem_root= mem_root;
if (my_hash_insert(&federatedx_open_servers, (uchar*) server))
goto error;
mysql_mutex_init(fe_key_mutex_FEDERATEDX_SERVER_mutex,
&server->mutex, MY_MUTEX_INIT_FAST);
}
else
free_root(&mem_root, MYF(0)); /* prevents memory leak */
server->use_count++;
DBUG_RETURN(server);
error:
free_root(&mem_root, MYF(0));
DBUG_RETURN(NULL);
}
/*
Example of simple lock controls. The "share" it creates is structure we will
pass to each federatedx handler. Do you have to have one of these? Well, you
have pieces that are used for locking, and they are needed to function.
*/
static FEDERATEDX_SHARE *get_share(const char *table_name, TABLE *table)
{
char query_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
Field **field;
String query(query_buffer, sizeof(query_buffer), &my_charset_bin);
FEDERATEDX_SHARE *share= NULL, tmp_share;
MEM_ROOT mem_root;
DBUG_ENTER("ha_federatedx.cc::get_share");
/*
In order to use this string, we must first zero it's length,
or it will contain garbage
*/
query.length(0);
bzero(&tmp_share, sizeof(tmp_share));
init_alloc_root(&mem_root, "federated", 256, 0, MYF(0));
mysql_mutex_lock(&federatedx_mutex);
tmp_share.share_key= table_name;
tmp_share.share_key_length= strlen(table_name);
if (parse_url(&mem_root, &tmp_share, table->s, 0))
goto error;
/* TODO: change tmp_share.scheme to LEX_STRING object */
if (!(share= (FEDERATEDX_SHARE *) my_hash_search(&federatedx_open_tables,
(uchar*) tmp_share.share_key,
tmp_share.
share_key_length)))
{
query.set_charset(system_charset_info);
query.append(STRING_WITH_LEN("SELECT "));
for (field= table->field; *field; field++)
{
append_ident(&query, (*field)->field_name.str,
(*field)->field_name.length, ident_quote_char);
query.append(STRING_WITH_LEN(", "));
}
/* chops off trailing comma */
query.length(query.length() - sizeof_trailing_comma);
query.append(STRING_WITH_LEN(" FROM "));
append_ident(&query, tmp_share.table_name,
tmp_share.table_name_length, ident_quote_char);
if (!(share= (FEDERATEDX_SHARE *) memdup_root(&mem_root, (char*)&tmp_share, sizeof(*share))) ||
!(share->share_key= (char*) memdup_root(&mem_root, tmp_share.share_key, tmp_share.share_key_length+1)) ||
!(share->select_query= (char*) strmake_root(&mem_root, query.ptr(), query.length())))
goto error;
share->mem_root= mem_root;
DBUG_PRINT("info",
("share->select_query %s", share->select_query));
if (!(share->s= get_server(share, table)))
goto error;
if (my_hash_insert(&federatedx_open_tables, (uchar*) share))
goto error;
thr_lock_init(&share->lock);
}
else
free_root(&mem_root, MYF(0)); /* prevents memory leak */
share->use_count++;
mysql_mutex_unlock(&federatedx_mutex);
DBUG_RETURN(share);
error:
mysql_mutex_unlock(&federatedx_mutex);
free_root(&mem_root, MYF(0));
DBUG_RETURN(NULL);
}
static federatedx_txn zero_txn;
static int free_server(federatedx_txn *txn, FEDERATEDX_SERVER *server)
{
bool destroy;
DBUG_ENTER("free_server");
mysql_mutex_lock(&federatedx_mutex);
if ((destroy= !--server->use_count))
my_hash_delete(&federatedx_open_servers, (uchar*) server);
mysql_mutex_unlock(&federatedx_mutex);
if (destroy)
{
MEM_ROOT mem_root;
if (!txn)
txn= &zero_txn;
txn->close(server);
DBUG_ASSERT(server->io_count == 0);
mysql_mutex_destroy(&server->mutex);
mem_root= server->mem_root;
free_root(&mem_root, MYF(0));
}
DBUG_RETURN(0);
}
/*
Free lock controls. We call this whenever we close a table.
If the table had the last reference to the share then we
free memory associated with it.
*/
static void free_share(federatedx_txn *txn, FEDERATEDX_SHARE *share)
{
bool destroy;
DBUG_ENTER("free_share");
mysql_mutex_lock(&federatedx_mutex);
if ((destroy= !--share->use_count))
my_hash_delete(&federatedx_open_tables, (uchar*) share);
mysql_mutex_unlock(&federatedx_mutex);
if (destroy)
{
MEM_ROOT mem_root;
FEDERATEDX_SERVER *server= share->s;
thr_lock_delete(&share->lock);
mem_root= share->mem_root;
free_root(&mem_root, MYF(0));
free_server(txn, server);
}
DBUG_VOID_RETURN;
}
ha_rows ha_federatedx::records_in_range(uint inx, key_range *start_key,
key_range *end_key)
{
/*
We really want indexes to be used as often as possible, therefore
we just need to hard-code the return value to a very low number to
force the issue
*/
DBUG_ENTER("ha_federatedx::records_in_range");
DBUG_RETURN(FEDERATEDX_RECORDS_IN_RANGE);
}
federatedx_txn *ha_federatedx::get_txn(THD *thd, bool no_create)
{
federatedx_txn **txnp= (federatedx_txn **) ha_data(thd);
if (!*txnp && !no_create)
*txnp= new federatedx_txn();
return *txnp;
}
int ha_federatedx::disconnect(handlerton *hton, MYSQL_THD thd)
{
federatedx_txn *txn= (federatedx_txn *) thd_get_ha_data(thd, hton);
delete txn;
*((federatedx_txn **) thd_ha_data(thd, hton))= 0;
return 0;
}
/*
Used for opening tables. The name will be the name of the file.
A table is opened when it needs to be opened. For instance
when a request comes in for a select on the table (tables are not
open and closed for each request, they are cached).
Called from handler.cc by handler::ha_open(). The server opens
all tables by calling ha_open() which then calls the handler
specific open().
*/
int ha_federatedx::open(const char *name, int mode, uint test_if_locked)
{
int error;
THD *thd= ha_thd();
DBUG_ENTER("ha_federatedx::open");
if (!(share= get_share(name, table)))
DBUG_RETURN(1);
thr_lock_data_init(&share->lock, &lock, NULL);
DBUG_ASSERT(io == NULL);
txn= get_txn(thd);
if ((error= txn->acquire(share, thd, TRUE, &io)))
{
free_share(txn, share);
DBUG_RETURN(error);
}
ref_length= io->get_ref_length();
txn->release(&io);
DBUG_PRINT("info", ("ref_length: %u", ref_length));
my_init_dynamic_array(&results, sizeof(FEDERATEDX_IO_RESULT*), 4, 4, MYF(0));
reset();
DBUG_RETURN(0);
}
class Net_error_handler : public Internal_error_handler
{
public:
Net_error_handler() {}
public:
bool handle_condition(THD *thd, uint sql_errno, const char* sqlstate,
Sql_condition::enum_warning_level *level,
const char* msg, Sql_condition ** cond_hdl)
{
return sql_errno >= ER_ABORTING_CONNECTION &&
sql_errno <= ER_NET_WRITE_INTERRUPTED;
}
};
/*
Closes a table. We call the free_share() function to free any resources
that we have allocated in the "shared" structure.
Called from sql_base.cc, sql_select.cc, and table.cc.
In sql_select.cc it is only used to close up temporary tables or during
the process where a temporary table is converted over to being a
myisam table.
For sql_base.cc look at close_data_tables().
*/
int ha_federatedx::close(void)
{
int retval= 0;
THD *thd= ha_thd();
DBUG_ENTER("ha_federatedx::close");
/* free the result set */
reset();
delete_dynamic(&results);
/* Disconnect from mysql */
if (!thd || !(txn= get_txn(thd, true)))
txn= &zero_txn;
txn->release(&io);
DBUG_ASSERT(io == NULL);
Net_error_handler err_handler;
if (thd)
thd->push_internal_handler(&err_handler);
free_share(txn, share);
if (thd)
thd->pop_internal_handler();
DBUG_RETURN(retval);
}
/*
Checks if a field in a record is SQL NULL.
SYNOPSIS
field_in_record_is_null()
table TABLE pointer, MySQL table object
field Field pointer, MySQL field object
record char pointer, contains record
DESCRIPTION
This method uses the record format information in table to track
the null bit in record.
RETURN VALUE
1 if NULL
0 otherwise
*/
static inline uint field_in_record_is_null(TABLE *table, Field *field,
char *record)
{
int null_offset;
DBUG_ENTER("ha_federatedx::field_in_record_is_null");
if (!field->null_ptr)
DBUG_RETURN(0);
null_offset= (uint) ((char*)field->null_ptr - (char*)table->record[0]);
if (record[null_offset] & field->null_bit)
DBUG_RETURN(1);
DBUG_RETURN(0);
}
/**
@brief Construct the INSERT statement.
@details This method will construct the INSERT statement and appends it to
the supplied query string buffer.
@return
@retval FALSE No error
@retval TRUE Failure
*/
bool ha_federatedx::append_stmt_insert(String *query)
{
char insert_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
Field **field;
uint tmp_length;
bool added_field= FALSE;
/* The main insert query string */
String insert_string(insert_buffer, sizeof(insert_buffer), &my_charset_bin);
DBUG_ENTER("ha_federatedx::append_stmt_insert");
insert_string.length(0);
if (replace_duplicates)
insert_string.append(STRING_WITH_LEN("REPLACE INTO "));
else if (ignore_duplicates && !insert_dup_update)
insert_string.append(STRING_WITH_LEN("INSERT IGNORE INTO "));
else
insert_string.append(STRING_WITH_LEN("INSERT INTO "));
append_ident(&insert_string, share->table_name, share->table_name_length,
ident_quote_char);
tmp_length= insert_string.length();
insert_string.append(STRING_WITH_LEN(" ("));
/*
loop through the field pointer array, add any fields to both the values
list and the fields list that match the current query id
*/
for (field= table->field; *field; field++)
{
if (bitmap_is_set(table->write_set, (*field)->field_index))
{
/* append the field name */
append_ident(&insert_string, (*field)->field_name.str,
(*field)->field_name.length, ident_quote_char);
/* append commas between both fields and fieldnames */
/*
unfortunately, we can't use the logic if *(fields + 1) to
make the following appends conditional as we don't know if the
next field is in the write set
*/
insert_string.append(STRING_WITH_LEN(", "));
added_field= TRUE;
}
}
if (added_field)
{
/* Remove trailing comma. */
insert_string.length(insert_string.length() - sizeof_trailing_comma);
insert_string.append(STRING_WITH_LEN(") "));
}
else
{
/* If there were no fields, we don't want to add a closing paren. */
insert_string.length(tmp_length);
}
insert_string.append(STRING_WITH_LEN(" VALUES "));
DBUG_RETURN(query->append(insert_string));
}
/*
write_row() inserts a row. No extra() hint is given currently if a bulk load
is happeneding. buf() is a byte array of data. You can use the field
information to extract the data from the native byte array type.
Example of this would be:
for (Field **field=table->field ; *field ; field++)
{
...
}
Called from item_sum.cc, item_sum.cc, sql_acl.cc, sql_insert.cc,
sql_insert.cc, sql_select.cc, sql_table.cc, sql_udf.cc, and sql_update.cc.
*/
int ha_federatedx::write_row(uchar *buf)
{
char values_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
char insert_field_value_buffer[STRING_BUFFER_USUAL_SIZE];
Field **field;
uint tmp_length;
int error= 0;
bool use_bulk_insert;
bool auto_increment_update_required= (table->next_number_field != NULL);
/* The string containing the values to be added to the insert */
String values_string(values_buffer, sizeof(values_buffer), &my_charset_bin);
/* The actual value of the field, to be added to the values_string */
String insert_field_value_string(insert_field_value_buffer,
sizeof(insert_field_value_buffer),
&my_charset_bin);
my_bitmap_map *old_map= dbug_tmp_use_all_columns(table, table->read_set);
DBUG_ENTER("ha_federatedx::write_row");
values_string.length(0);
insert_field_value_string.length(0);
/*
start both our field and field values strings
We must disable multi-row insert for "INSERT...ON DUPLICATE KEY UPDATE"
Ignore duplicates is always true when insert_dup_update is true.
When replace_duplicates == TRUE, we can safely enable multi-row insert.
When performing multi-row insert, we only collect the columns values for
the row. The start of the statement is only created when the first
row is copied in to the bulk_insert string.
*/
if (!(use_bulk_insert= bulk_insert.str &&
(!insert_dup_update || replace_duplicates)))
append_stmt_insert(&values_string);
values_string.append(STRING_WITH_LEN(" ("));
tmp_length= values_string.length();
/*
loop through the field pointer array, add any fields to both the values
list and the fields list that is part of the write set
*/
for (field= table->field; *field; field++)
{
if (bitmap_is_set(table->write_set, (*field)->field_index))
{
if ((*field)->is_null())
values_string.append(STRING_WITH_LEN(" NULL "));
else
{
bool needs_quote= (*field)->str_needs_quotes();
(*field)->val_str(&insert_field_value_string);
if (needs_quote)
values_string.append(value_quote_char);
insert_field_value_string.print(&values_string);
if (needs_quote)
values_string.append(value_quote_char);
insert_field_value_string.length(0);
}
/* append commas between both fields and fieldnames */
/*
unfortunately, we can't use the logic if *(fields + 1) to
make the following appends conditional as we don't know if the
next field is in the write set
*/
values_string.append(STRING_WITH_LEN(", "));
}
}
dbug_tmp_restore_column_map(table->read_set, old_map);
/*
if there were no fields, we don't want to add a closing paren
AND, we don't want to chop off the last char '('
insert will be "INSERT INTO t1 VALUES ();"
*/
if (values_string.length() > tmp_length)
{
/* chops off trailing comma */
values_string.length(values_string.length() - sizeof_trailing_comma);
}
/* we always want to append this, even if there aren't any fields */
values_string.append(STRING_WITH_LEN(") "));
if ((error= txn->acquire(share, ha_thd(), FALSE, &io)))
DBUG_RETURN(error);
if (use_bulk_insert)
{
/*
Send the current bulk insert out if appending the current row would
cause the statement to overflow the packet size, otherwise set
auto_increment_update_required to FALSE as no query was executed.
*/
if (bulk_insert.length + values_string.length() + bulk_padding >
io->max_query_size() && bulk_insert.length)
{
error= io->query(bulk_insert.str, bulk_insert.length);
bulk_insert.length= 0;
}
else
auto_increment_update_required= FALSE;
if (bulk_insert.length == 0)
{
char insert_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
String insert_string(insert_buffer, sizeof(insert_buffer),
&my_charset_bin);
insert_string.length(0);
append_stmt_insert(&insert_string);
dynstr_append_mem(&bulk_insert, insert_string.ptr(),
insert_string.length());
}
else
dynstr_append_mem(&bulk_insert, ",", 1);
dynstr_append_mem(&bulk_insert, values_string.ptr(),
values_string.length());
}
else
{
error= io->query(values_string.ptr(), values_string.length());
}
if (error)
{
DBUG_RETURN(stash_remote_error());
}
/*
If the table we've just written a record to contains an auto_increment
field, then store the last_insert_id() value from the foreign server
*/
if (auto_increment_update_required)
{
update_auto_increment();
/* mysql_insert() uses this for protocol return value */
table->next_number_field->store(stats.auto_increment_value, 1);
}
DBUG_RETURN(0);
}
/**
@brief Prepares the storage engine for bulk inserts.
@param[in] rows estimated number of rows in bulk insert
or 0 if unknown.
@details Initializes memory structures required for bulk insert.
*/
void ha_federatedx::start_bulk_insert(ha_rows rows, uint flags)
{
uint page_size;
DBUG_ENTER("ha_federatedx::start_bulk_insert");
dynstr_free(&bulk_insert);
/**
We don't bother with bulk-insert semantics when the estimated rows == 1
The rows value will be 0 if the server does not know how many rows
would be inserted. This can occur when performing INSERT...SELECT
*/
if (rows == 1)
DBUG_VOID_RETURN;
/*
Make sure we have an open connection so that we know the
maximum packet size.
*/
if (txn->acquire(share, ha_thd(), FALSE, &io))
DBUG_VOID_RETURN;
page_size= (uint) my_getpagesize();
if (init_dynamic_string(&bulk_insert, NULL, page_size, page_size))
DBUG_VOID_RETURN;
bulk_insert.length= 0;
DBUG_VOID_RETURN;
}
/**
@brief End bulk insert.
@details This method will send any remaining rows to the remote server.
Finally, it will deinitialize the bulk insert data structure.
@return Operation status
@retval 0 No error
@retval != 0 Error occurred at remote server. Also sets my_errno.
*/
int ha_federatedx::end_bulk_insert()
{
int error= 0;
DBUG_ENTER("ha_federatedx::end_bulk_insert");
if (bulk_insert.str && bulk_insert.length && !table_will_be_deleted)
{
if ((error= txn->acquire(share, ha_thd(), FALSE, &io)))
DBUG_RETURN(error);
if (io->query(bulk_insert.str, bulk_insert.length))
error= stash_remote_error();
else
if (table->next_number_field)
update_auto_increment();
}
dynstr_free(&bulk_insert);
DBUG_RETURN(my_errno= error);
}
/*
ha_federatedx::update_auto_increment
This method ensures that last_insert_id() works properly. What it simply does
is calls last_insert_id() on the foreign database immediately after insert
(if the table has an auto_increment field) and sets the insert id via
thd->insert_id(ID)).
*/
void ha_federatedx::update_auto_increment(void)
{
THD *thd= ha_thd();
DBUG_ENTER("ha_federatedx::update_auto_increment");
ha_federatedx::info(HA_STATUS_AUTO);
thd->first_successful_insert_id_in_cur_stmt=
stats.auto_increment_value;
DBUG_PRINT("info",("last_insert_id: %ld", (long) stats.auto_increment_value));
DBUG_VOID_RETURN;
}
int ha_federatedx::optimize(THD* thd, HA_CHECK_OPT* check_opt)
{
int error= 0;
char query_buffer[STRING_BUFFER_USUAL_SIZE];
String query(query_buffer, sizeof(query_buffer), &my_charset_bin);
DBUG_ENTER("ha_federatedx::optimize");
query.length(0);
query.set_charset(system_charset_info);
query.append(STRING_WITH_LEN("OPTIMIZE TABLE "));
append_ident(&query, share->table_name, share->table_name_length,
ident_quote_char);
DBUG_ASSERT(txn == get_txn(thd));
if ((error= txn->acquire(share, thd, FALSE, &io)))
DBUG_RETURN(error);
if (io->query(query.ptr(), query.length()))
error= stash_remote_error();
DBUG_RETURN(error);
}
int ha_federatedx::repair(THD* thd, HA_CHECK_OPT* check_opt)
{
int error= 0;
char query_buffer[STRING_BUFFER_USUAL_SIZE];
String query(query_buffer, sizeof(query_buffer), &my_charset_bin);
DBUG_ENTER("ha_federatedx::repair");
query.length(0);
query.set_charset(system_charset_info);
query.append(STRING_WITH_LEN("REPAIR TABLE "));
append_ident(&query, share->table_name, share->table_name_length,
ident_quote_char);
if (check_opt->flags & T_QUICK)
query.append(STRING_WITH_LEN(" QUICK"));
if (check_opt->flags & T_EXTEND)
query.append(STRING_WITH_LEN(" EXTENDED"));
if (check_opt->sql_flags & TT_USEFRM)
query.append(STRING_WITH_LEN(" USE_FRM"));
DBUG_ASSERT(txn == get_txn(thd));
if ((error= txn->acquire(share, thd, FALSE, &io)))
DBUG_RETURN(error);
if (io->query(query.ptr(), query.length()))
error= stash_remote_error();
DBUG_RETURN(error);
}
/*
Yes, update_row() does what you expect, it updates a row. old_data will have
the previous row record in it, while new_data will have the newest data in
it.
Keep in mind that the server can do updates based on ordering if an ORDER BY
clause was used. Consecutive ordering is not guaranteed.
Currently new_data will not have an updated auto_increament record, or
and updated timestamp field. You can do these for federatedx by doing these:
if (table->timestamp_on_update_now)
update_timestamp(new_row+table->timestamp_on_update_now-1);
if (table->next_number_field && record == table->record[0])
update_auto_increment();
Called from sql_select.cc, sql_acl.cc, sql_update.cc, and sql_insert.cc.
*/
int ha_federatedx::update_row(const uchar *old_data, const uchar *new_data)
{
/*
This used to control how the query was built. If there was a
primary key, the query would be built such that there was a where
clause with only that column as the condition. This is flawed,
because if we have a multi-part primary key, it would only use the
first part! We don't need to do this anyway, because
read_range_first will retrieve the correct record, which is what
is used to build the WHERE clause. We can however use this to
append a LIMIT to the end if there is NOT a primary key. Why do
this? Because we only are updating one record, and LIMIT enforces
this.
*/
bool has_a_primary_key= MY_TEST(table->s->primary_key != MAX_KEY);
/*
buffers for following strings
*/
char field_value_buffer[STRING_BUFFER_USUAL_SIZE];
char update_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
char where_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
/* Work area for field values */
String field_value(field_value_buffer, sizeof(field_value_buffer),
&my_charset_bin);
/* stores the update query */
String update_string(update_buffer,
sizeof(update_buffer),
&my_charset_bin);
/* stores the WHERE clause */
String where_string(where_buffer,
sizeof(where_buffer),
&my_charset_bin);
uchar *record= table->record[0];
int error;
DBUG_ENTER("ha_federatedx::update_row");
/*
set string lengths to 0 to avoid misc chars in string
*/
field_value.length(0);
update_string.length(0);
where_string.length(0);
if (ignore_duplicates)
update_string.append(STRING_WITH_LEN("UPDATE IGNORE "));
else
update_string.append(STRING_WITH_LEN("UPDATE "));
append_ident(&update_string, share->table_name,
share->table_name_length, ident_quote_char);
update_string.append(STRING_WITH_LEN(" SET "));
/*
In this loop, we want to match column names to values being inserted
(while building INSERT statement).
Iterate through table->field (new data) and share->old_field (old_data)
using the same index to create an SQL UPDATE statement. New data is
used to create SET field=value and old data is used to create WHERE
field=oldvalue
*/
for (Field **field= table->field; *field; field++)
{
if (bitmap_is_set(table->write_set, (*field)->field_index))
{
append_ident(&update_string, (*field)->field_name.str,
(*field)->field_name.length,
ident_quote_char);
update_string.append(STRING_WITH_LEN(" = "));
if ((*field)->is_null())
update_string.append(STRING_WITH_LEN(" NULL "));
else
{
/* otherwise = */
my_bitmap_map *old_map= tmp_use_all_columns(table, table->read_set);
bool needs_quote= (*field)->str_needs_quotes();
(*field)->val_str(&field_value);
if (needs_quote)
update_string.append(value_quote_char);
field_value.print(&update_string);
if (needs_quote)
update_string.append(value_quote_char);
field_value.length(0);
tmp_restore_column_map(table->read_set, old_map);
}
update_string.append(STRING_WITH_LEN(", "));
}
if (bitmap_is_set(table->read_set, (*field)->field_index))
{
append_ident(&where_string, (*field)->field_name.str,
(*field)->field_name.length,
ident_quote_char);
if (field_in_record_is_null(table, *field, (char*) old_data))
where_string.append(STRING_WITH_LEN(" IS NULL "));
else
{
bool needs_quote= (*field)->str_needs_quotes();
where_string.append(STRING_WITH_LEN(" = "));
(*field)->val_str(&field_value,
(old_data + (*field)->offset(record)));
if (needs_quote)
where_string.append(value_quote_char);
field_value.print(&where_string);
if (needs_quote)
where_string.append(value_quote_char);
field_value.length(0);
}
where_string.append(STRING_WITH_LEN(" AND "));
}
}
/* Remove last ', '. This works as there must be at least on updated field */
update_string.length(update_string.length() - sizeof_trailing_comma);
if (where_string.length())
{
/* chop off trailing AND */
where_string.length(where_string.length() - sizeof_trailing_and);
update_string.append(STRING_WITH_LEN(" WHERE "));
update_string.append(where_string);
}
/*
If this table has not a primary key, then we could possibly
update multiple rows. We want to make sure to only update one!
*/
if (!has_a_primary_key)
update_string.append(STRING_WITH_LEN(" LIMIT 1"));
if ((error= txn->acquire(share, ha_thd(), FALSE, &io)))
DBUG_RETURN(error);
if (io->query(update_string.ptr(), update_string.length()))
{
DBUG_RETURN(stash_remote_error());
}
DBUG_RETURN(0);
}
/*
This will delete a row. 'buf' will contain a copy of the row to be =deleted.
The server will call this right after the current row has been called (from
either a previous rnd_next() or index call).
If you keep a pointer to the last row or can access a primary key it will
make doing the deletion quite a bit easier.
Keep in mind that the server does no guarentee consecutive deletions.
ORDER BY clauses can be used.
Called in sql_acl.cc and sql_udf.cc to manage internal table information.
Called in sql_delete.cc, sql_insert.cc, and sql_select.cc. In sql_select
it is used for removing duplicates while in insert it is used for REPLACE
calls.
*/
int ha_federatedx::delete_row(const uchar *buf)
{
char delete_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
char data_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
String delete_string(delete_buffer, sizeof(delete_buffer), &my_charset_bin);
String data_string(data_buffer, sizeof(data_buffer), &my_charset_bin);
uint found= 0;
int error;
DBUG_ENTER("ha_federatedx::delete_row");
delete_string.length(0);
delete_string.append(STRING_WITH_LEN("DELETE FROM "));
append_ident(&delete_string, share->table_name,
share->table_name_length, ident_quote_char);
delete_string.append(STRING_WITH_LEN(" WHERE "));
for (Field **field= table->field; *field; field++)
{
Field *cur_field= *field;
found++;
if (bitmap_is_set(table->read_set, cur_field->field_index))
{
append_ident(&delete_string, (*field)->field_name.str,
(*field)->field_name.length, ident_quote_char);
data_string.length(0);
if (cur_field->is_null())
{
delete_string.append(STRING_WITH_LEN(" IS NULL "));
}
else
{
bool needs_quote= cur_field->str_needs_quotes();
delete_string.append(STRING_WITH_LEN(" = "));
cur_field->val_str(&data_string);
if (needs_quote)
delete_string.append(value_quote_char);
data_string.print(&delete_string);
if (needs_quote)
delete_string.append(value_quote_char);
}
delete_string.append(STRING_WITH_LEN(" AND "));
}
}
// Remove trailing AND
delete_string.length(delete_string.length() - sizeof_trailing_and);
if (!found)
delete_string.length(delete_string.length() - sizeof_trailing_where);
delete_string.append(STRING_WITH_LEN(" LIMIT 1"));
DBUG_PRINT("info",
("Delete sql: %s", delete_string.c_ptr_quick()));
if ((error= txn->acquire(share, ha_thd(), FALSE, &io)))
DBUG_RETURN(error);
if (io->query(delete_string.ptr(), delete_string.length()))
{
DBUG_RETURN(stash_remote_error());
}
stats.deleted+= (ha_rows) io->affected_rows();
stats.records-= (ha_rows) io->affected_rows();
DBUG_PRINT("info",
("rows deleted %ld rows deleted for all time %ld",
(long) io->affected_rows(), (long) stats.deleted));
DBUG_RETURN(0);
}
/*
Positions an index cursor to the index specified in the handle. Fetches the
row if available. If the key value is null, begin at the first key of the
index. This method, which is called in the case of an SQL statement having
a WHERE clause on a non-primary key index, simply calls index_read_idx.
*/
int ha_federatedx::index_read(uchar *buf, const uchar *key,
uint key_len, ha_rkey_function find_flag)
{
DBUG_ENTER("ha_federatedx::index_read");
if (stored_result)
(void) free_result();
DBUG_RETURN(index_read_idx_with_result_set(buf, active_index, key,
key_len, find_flag,
&stored_result));
}
/*
Positions an index cursor to the index specified in key. Fetches the
row if any. This is only used to read whole keys.
This method is called via index_read in the case of a WHERE clause using
a primary key index OR is called DIRECTLY when the WHERE clause
uses a PRIMARY KEY index.
NOTES
This uses an internal result set that is deleted before function
returns. We need to be able to be callable from ha_rnd_pos()
*/
int ha_federatedx::index_read_idx(uchar *buf, uint index, const uchar *key,
uint key_len, enum ha_rkey_function find_flag)
{
int retval;
FEDERATEDX_IO_RESULT *io_result= 0;
DBUG_ENTER("ha_federatedx::index_read_idx");
if ((retval= index_read_idx_with_result_set(buf, index, key,
key_len, find_flag,
&io_result)))
DBUG_RETURN(retval);
/* io is correct, as index_read_idx_with_result_set was ok */
io->free_result(io_result);
DBUG_RETURN(retval);
}
/*
Create result set for rows matching query and return first row
RESULT
0 ok In this case *result will contain the result set
# error In this case *result will contain 0
*/
int ha_federatedx::index_read_idx_with_result_set(uchar *buf, uint index,
const uchar *key,
uint key_len,
ha_rkey_function find_flag,
FEDERATEDX_IO_RESULT **result)
{
int retval;
char error_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
char index_value[STRING_BUFFER_USUAL_SIZE];
char sql_query_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
String index_string(index_value,
sizeof(index_value),
&my_charset_bin);
String sql_query(sql_query_buffer,
sizeof(sql_query_buffer),
&my_charset_bin);
key_range range;
DBUG_ENTER("ha_federatedx::index_read_idx_with_result_set");
*result= 0; // In case of errors
index_string.length(0);
sql_query.length(0);
sql_query.append(share->select_query);
range.key= key;
range.length= key_len;
range.flag= find_flag;
create_where_from_key(&index_string,
&table->key_info[index],
&range,
NULL, 0, 0);
sql_query.append(index_string);
if ((retval= txn->acquire(share, ha_thd(), TRUE, &io)))
DBUG_RETURN(retval);
if (io->query(sql_query.ptr(), sql_query.length()))
{
sprintf(error_buffer, "error: %d '%s'",
io->error_code(), io->error_str());
retval= ER_QUERY_ON_FOREIGN_DATA_SOURCE;
goto error;
}
if (!(*result= io->store_result()))
{
retval= HA_ERR_END_OF_FILE;
goto error;
}
if (!(retval= read_next(buf, *result)))
DBUG_RETURN(retval);
insert_dynamic(&results, (uchar*) result);
*result= 0;
DBUG_RETURN(retval);
error:
my_error(retval, MYF(0), error_buffer);
DBUG_RETURN(retval);
}
/*
This method is used exlusevely by filesort() to check if we
can create sorting buffers of necessary size.
If the handler returns more records that it declares
here server can just crash on filesort().
We cannot guarantee that's not going to happen with
the FEDERATEDX engine, as we have records==0 always if the
client is a VIEW, and for the table the number of
records can inpredictably change during execution.
So we return maximum possible value here.
*/
ha_rows ha_federatedx::estimate_rows_upper_bound()
{
return HA_POS_ERROR;
}
/* Initialized at each key walk (called multiple times unlike rnd_init()) */
int ha_federatedx::index_init(uint keynr, bool sorted)
{
DBUG_ENTER("ha_federatedx::index_init");
DBUG_PRINT("info", ("table: '%s' key: %u", table->s->table_name.str, keynr));
active_index= keynr;
DBUG_RETURN(0);
}
/*
Read first range
*/
int ha_federatedx::read_range_first(const key_range *start_key,
const key_range *end_key,
bool eq_range_arg, bool sorted)
{
char sql_query_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
int retval;
String sql_query(sql_query_buffer,
sizeof(sql_query_buffer),
&my_charset_bin);
DBUG_ENTER("ha_federatedx::read_range_first");
DBUG_ASSERT(!(start_key == NULL && end_key == NULL));
sql_query.length(0);
sql_query.append(share->select_query);
create_where_from_key(&sql_query,
&table->key_info[active_index],
start_key, end_key, 0, eq_range_arg);
if ((retval= txn->acquire(share, ha_thd(), TRUE, &io)))
DBUG_RETURN(retval);
if (stored_result)
(void) free_result();
if (io->query(sql_query.ptr(), sql_query.length()))
{
retval= ER_QUERY_ON_FOREIGN_DATA_SOURCE;
goto error;
}
sql_query.length(0);
if (!(stored_result= io->store_result()))
{
retval= HA_ERR_END_OF_FILE;
goto error;
}
retval= read_next(table->record[0], stored_result);
DBUG_RETURN(retval);
error:
DBUG_RETURN(retval);
}
int ha_federatedx::read_range_next()
{
int retval;
DBUG_ENTER("ha_federatedx::read_range_next");
retval= rnd_next(table->record[0]);
DBUG_RETURN(retval);
}
/* Used to read forward through the index. */
int ha_federatedx::index_next(uchar *buf)
{
DBUG_ENTER("ha_federatedx::index_next");
int retval=read_next(buf, stored_result);
DBUG_RETURN(retval);
}
/*
rnd_init() is called when the system wants the storage engine to do a table
scan.
This is the method that gets data for the SELECT calls.
See the federatedx in the introduction at the top of this file to see when
rnd_init() is called.
Called from filesort.cc, records.cc, sql_handler.cc, sql_select.cc,
sql_table.cc, and sql_update.cc.
*/
int ha_federatedx::rnd_init(bool scan)
{
DBUG_ENTER("ha_federatedx::rnd_init");
/*
The use of the 'scan' flag is incredibly important for this handler
to work properly, especially with updates containing WHERE clauses
using indexed columns.
When the initial query contains a WHERE clause of the query using an
indexed column, it's index_read_idx that selects the exact record from
the foreign database.
When there is NO index in the query, either due to not having a WHERE
clause, or the WHERE clause is using columns that are not indexed, a
'full table scan' done by rnd_init, which in this situation simply means
a 'select * from ...' on the foreign table.
In other words, this 'scan' flag gives us the means to ensure that if
there is an index involved in the query, we want index_read_idx to
retrieve the exact record (scan flag is 0), and do not want rnd_init
to do a 'full table scan' and wipe out that result set.
Prior to using this flag, the problem was most apparent with updates.
An initial query like 'UPDATE tablename SET anything = whatever WHERE
indexedcol = someval', index_read_idx would get called, using a query
constructed with a WHERE clause built from the values of index ('indexcol'
in this case, having a value of 'someval'). mysql_store_result would
then get called (this would be the result set we want to use).
After this rnd_init (from sql_update.cc) would be called, it would then
unecessarily call "select * from table" on the foreign table, then call
mysql_store_result, which would wipe out the correct previous result set
from the previous call of index_read_idx's that had the result set
containing the correct record, hence update the wrong row!
*/
if (scan)
{
int error;
if ((error= txn->acquire(share, ha_thd(), TRUE, &io)))
DBUG_RETURN(error);
if (stored_result)
(void) free_result();
if (io->query(share->select_query,
strlen(share->select_query)))
goto error;
stored_result= io->store_result();
if (!stored_result)
goto error;
}
DBUG_RETURN(0);
error:
DBUG_RETURN(stash_remote_error());
}
int ha_federatedx::rnd_end()
{
DBUG_ENTER("ha_federatedx::rnd_end");
DBUG_RETURN(index_end());
}
int ha_federatedx::free_result()
{
int error;
DBUG_ENTER("ha_federatedx::free_result");
DBUG_ASSERT(stored_result);
for (uint i= 0; i < results.elements; ++i)
{
FEDERATEDX_IO_RESULT *result= 0;
get_dynamic(&results, (uchar*) &result, i);
if (result == stored_result)
goto end;
}
if (position_called)
{
insert_dynamic(&results, (uchar*) &stored_result);
}
else
{
federatedx_io *tmp_io= 0, **iop;
if (!*(iop= &io) && (error= txn->acquire(share, ha_thd(), TRUE, (iop= &tmp_io))))
{
DBUG_ASSERT(0); // Fail when testing
insert_dynamic(&results, (uchar*) &stored_result);
goto end;
}
(*iop)->free_result(stored_result);
txn->release(&tmp_io);
}
end:
stored_result= 0;
position_called= FALSE;
DBUG_RETURN(0);
}
int ha_federatedx::index_end(void)
{
int error= 0;
DBUG_ENTER("ha_federatedx::index_end");
if (stored_result)
error= free_result();
active_index= MAX_KEY;
DBUG_RETURN(error);
}
/*
This is called for each row of the table scan. When you run out of records
you should return HA_ERR_END_OF_FILE. Fill buff up with the row information.
The Field structure for the table is the key to getting data into buf
in a manner that will allow the server to understand it.
Called from filesort.cc, records.cc, sql_handler.cc, sql_select.cc,
sql_table.cc, and sql_update.cc.
*/
int ha_federatedx::rnd_next(uchar *buf)
{
DBUG_ENTER("ha_federatedx::rnd_next");
if (stored_result == 0)
{
/*
Return value of rnd_init is not always checked (see records.cc),
so we can get here _even_ if there is _no_ pre-fetched result-set!
TODO: fix it. We can delete this in 5.1 when rnd_init() is checked.
*/
DBUG_RETURN(1);
}
int retval=read_next(buf, stored_result);
DBUG_RETURN(retval);
}
/*
ha_federatedx::read_next
reads from a result set and converts to mysql internal
format
SYNOPSIS
field_in_record_is_null()
buf byte pointer to record
result mysql result set
DESCRIPTION
This method is a wrapper method that reads one record from a result
set and converts it to the internal table format
RETURN VALUE
1 error
0 no error
*/
int ha_federatedx::read_next(uchar *buf, FEDERATEDX_IO_RESULT *result)
{
int retval;
FEDERATEDX_IO_ROW *row;
DBUG_ENTER("ha_federatedx::read_next");
if ((retval= txn->acquire(share, ha_thd(), TRUE, &io)))
DBUG_RETURN(retval);
/* Fetch a row, insert it back in a row format. */
if (!(row= io->fetch_row(result)))
DBUG_RETURN(HA_ERR_END_OF_FILE);
if (!(retval= convert_row_to_internal_format(buf, row, result)))
table->status= 0;
DBUG_RETURN(retval);
}
/**
@brief Store a reference to current row.
@details During a query execution we may have different result sets (RS),
e.g. for different ranges. All the RS's used are stored in
memory and placed in @c results dynamic array. At the end of
execution all stored RS's are freed at once in the
@c ha_federated::reset().
So, in case of federated, a reference to current row is a
stored result address and current data cursor position.
As we keep all RS in memory during a query execution,
we can get any record using the reference any time until
@c ha_federated::reset() is called.
TODO: we don't have to store all RS's rows but only those
we call @c ha_federated::position() for, so we can free memory
where we store other rows in the @c ha_federated::index_end().
@param[in] record record data (unused)
*/
void ha_federatedx::position(const uchar *record __attribute__ ((unused)))
{
DBUG_ENTER("ha_federatedx::position");
if (!stored_result)
{
bzero(ref, ref_length);
DBUG_VOID_RETURN;
}
if (txn->acquire(share, ha_thd(), TRUE, &io))
DBUG_VOID_RETURN;
io->mark_position(stored_result, ref);
position_called= TRUE;
DBUG_VOID_RETURN;
}
/*
This is like rnd_next, but you are given a position to use to determine the
row. The position will be of the type that you stored in ref.
This method is required for an ORDER BY
Called from filesort.cc records.cc sql_insert.cc sql_select.cc sql_update.cc.
*/
int ha_federatedx::rnd_pos(uchar *buf, uchar *pos)
{
int retval;
FEDERATEDX_IO_RESULT *result= stored_result;
DBUG_ENTER("ha_federatedx::rnd_pos");
/* We have to move this to 'ref' to get things aligned */
bmove(ref, pos, ref_length);
if ((retval= txn->acquire(share, ha_thd(), TRUE, &io)))
goto error;
if ((retval= io->seek_position(&result, ref)))
goto error;
retval= read_next(buf, result);
DBUG_RETURN(retval);
error:
DBUG_RETURN(retval);
}
/*
::info() is used to return information to the optimizer.
Currently this table handler doesn't implement most of the fields
really needed. SHOW also makes use of this data
Another note, you will probably want to have the following in your
code:
if (records < 2)
records = 2;
The reason is that the server will optimize for cases of only a single
record. If in a table scan you don't know the number of records
it will probably be better to set records to two so you can return
as many records as you need.
Along with records a few more variables you may wish to set are:
records
deleted
data_file_length
index_file_length
delete_length
check_time
Take a look at the public variables in handler.h for more information.
Called in:
filesort.cc
ha_heap.cc
item_sum.cc
opt_sum.cc
sql_delete.cc
sql_delete.cc
sql_derived.cc
sql_select.cc
sql_select.cc
sql_select.cc
sql_select.cc
sql_select.cc
sql_show.cc
sql_show.cc
sql_show.cc
sql_show.cc
sql_table.cc
sql_union.cc
sql_update.cc
*/
int ha_federatedx::info(uint flag)
{
uint error_code;
THD *thd= ha_thd();
federatedx_txn *tmp_txn;
federatedx_io *tmp_io= 0, **iop= 0;
DBUG_ENTER("ha_federatedx::info");
error_code= ER_QUERY_ON_FOREIGN_DATA_SOURCE;
// external_lock may not have been called so txn may not be set
tmp_txn= get_txn(thd);
/* we want not to show table status if not needed to do so */
if (flag & (HA_STATUS_VARIABLE | HA_STATUS_CONST | HA_STATUS_AUTO))
{
if (!*(iop= &io) && (error_code= tmp_txn->acquire(share, thd, TRUE, (iop= &tmp_io))))
goto fail;
}
if (flag & (HA_STATUS_VARIABLE | HA_STATUS_CONST))
{
/*
size of IO operations (This is based on a good guess, no high science
involved)
*/
if (flag & HA_STATUS_CONST)
stats.block_size= 4096;
if ((*iop)->table_metadata(&stats, share->table_name,
share->table_name_length, flag))
goto error;
}
if (flag & HA_STATUS_AUTO)
stats.auto_increment_value= (*iop)->last_insert_id();
/*
If ::info created it's own transaction, close it. This happens in case
of show table status;
*/
tmp_txn->release(&tmp_io);
DBUG_RETURN(0);
error:
if (iop && *iop)
{
my_printf_error((*iop)->error_code(), "Received error: %d : %s", MYF(0),
(*iop)->error_code(), (*iop)->error_str());
}
else if (remote_error_number != -1 /* error already reported */)
{
error_code= remote_error_number;
my_error(error_code, MYF(0), ER_THD(thd, error_code));
}
fail:
tmp_txn->release(&tmp_io);
DBUG_RETURN(error_code);
}
/**
@brief Handles extra signals from MySQL server
@param[in] operation Hint for storage engine
@return Operation Status
@retval 0 OK
*/
int ha_federatedx::extra(ha_extra_function operation)
{
DBUG_ENTER("ha_federatedx::extra");
switch (operation) {
case HA_EXTRA_IGNORE_DUP_KEY:
ignore_duplicates= TRUE;
break;
case HA_EXTRA_NO_IGNORE_DUP_KEY:
insert_dup_update= FALSE;
ignore_duplicates= FALSE;
break;
case HA_EXTRA_WRITE_CAN_REPLACE:
replace_duplicates= TRUE;
break;
case HA_EXTRA_WRITE_CANNOT_REPLACE:
/*
We use this flag to ensure that we do not create an "INSERT IGNORE"
statement when inserting new rows into the remote table.
*/
replace_duplicates= FALSE;
break;
case HA_EXTRA_INSERT_WITH_UPDATE:
insert_dup_update= TRUE;
break;
case HA_EXTRA_PREPARE_FOR_DROP:
table_will_be_deleted = TRUE;
break;
default:
/* do nothing */
DBUG_PRINT("info",("unhandled operation: %d", (uint) operation));
}
DBUG_RETURN(0);
}
/**
@brief Reset state of file to after 'open'.
@detail This function is called after every statement for all tables
used by that statement.
@return Operation status
@retval 0 OK
*/
int ha_federatedx::reset(void)
{
THD *thd= ha_thd();
int error = 0;
insert_dup_update= FALSE;
ignore_duplicates= FALSE;
replace_duplicates= FALSE;
position_called= FALSE;
if (stored_result)
insert_dynamic(&results, (uchar*) &stored_result);
stored_result= 0;
if (results.elements)
{
federatedx_txn *tmp_txn;
federatedx_io *tmp_io= 0, **iop;
// external_lock may not have been called so txn may not be set
tmp_txn= get_txn(thd);
if (!*(iop= &io) && (error= tmp_txn->acquire(share, thd, TRUE, (iop= &tmp_io))))
{
DBUG_ASSERT(0); // Fail when testing
return error;
}
for (uint i= 0; i < results.elements; ++i)
{
FEDERATEDX_IO_RESULT *result= 0;
get_dynamic(&results, (uchar*) &result, i);
(*iop)->free_result(result);
}
tmp_txn->release(&tmp_io);
reset_dynamic(&results);
}
return error;
}
/*
Used to delete all rows in a table. Both for cases of truncate and
for cases where the optimizer realizes that all rows will be
removed as a result of a SQL statement.
Called from item_sum.cc by Item_func_group_concat::clear(),
Item_sum_count_distinct::clear(), and Item_func_group_concat::clear().
Called from sql_delete.cc by mysql_delete().
Called from sql_select.cc by JOIN::reinit().
Called from sql_union.cc by st_select_lex_unit::exec().
*/
int ha_federatedx::delete_all_rows()
{
THD *thd= ha_thd();
char query_buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
String query(query_buffer, sizeof(query_buffer), &my_charset_bin);
int error;
DBUG_ENTER("ha_federatedx::delete_all_rows");
query.length(0);
query.set_charset(system_charset_info);
query.append(STRING_WITH_LEN("TRUNCATE "));
append_ident(&query, share->table_name, share->table_name_length,
ident_quote_char);
/* no need for savepoint in autocommit mode */
if (!(thd->variables.option_bits & (OPTION_NOT_AUTOCOMMIT | OPTION_BEGIN)))
txn->stmt_autocommit();
/*
TRUNCATE won't return anything in mysql_affected_rows
*/
if ((error= txn->acquire(share, thd, FALSE, &io)))
DBUG_RETURN(error);
if (io->query(query.ptr(), query.length()))
{
DBUG_RETURN(stash_remote_error());
}
stats.deleted+= stats.records;
stats.records= 0;
DBUG_RETURN(0);
}
/*
The idea with handler::store_lock() is the following:
The statement decided which locks we should need for the table
for updates/deletes/inserts we get WRITE locks, for SELECT... we get
read locks.
Before adding the lock into the table lock handler (see thr_lock.c)
mysqld calls store lock with the requested locks. Store lock can now
modify a write lock to a read lock (or some other lock), ignore the
lock (if we don't want to use MySQL table locks at all) or add locks
for many tables (like we do when we are using a MERGE handler).
Berkeley DB for federatedx changes all WRITE locks to TL_WRITE_ALLOW_WRITE
(which signals that we are doing WRITES, but we are still allowing other
reader's and writer's.
When releasing locks, store_lock() are also called. In this case one
usually doesn't have to do anything.
In some exceptional cases MySQL may send a request for a TL_IGNORE;
This means that we are requesting the same lock as last time and this
should also be ignored. (This may happen when someone does a flush
table when we have opened a part of the tables, in which case mysqld
closes and reopens the tables and tries to get the same locks at last
time). In the future we will probably try to remove this.
Called from lock.cc by get_lock_data().
*/
THR_LOCK_DATA **ha_federatedx::store_lock(THD *thd,
THR_LOCK_DATA **to,
enum thr_lock_type lock_type)
{
DBUG_ENTER("ha_federatedx::store_lock");
if (lock_type != TL_IGNORE && lock.type == TL_UNLOCK)
{
/*
Here is where we get into the guts of a row level lock.
If TL_UNLOCK is set
If we are not doing a LOCK TABLE or DISCARD/IMPORT
TABLESPACE, then allow multiple writers
*/
if ((lock_type >= TL_WRITE_CONCURRENT_INSERT &&
lock_type <= TL_WRITE) && !thd->in_lock_tables)
lock_type= TL_WRITE_ALLOW_WRITE;
/*
In queries of type INSERT INTO t1 SELECT ... FROM t2 ...
MySQL would use the lock TL_READ_NO_INSERT on t2, and that
would conflict with TL_WRITE_ALLOW_WRITE, blocking all inserts
to t2. Convert the lock to a normal read lock to allow
concurrent inserts to t2.
*/
if (lock_type == TL_READ_NO_INSERT && !thd->in_lock_tables)
lock_type= TL_READ;
lock.type= lock_type;
}
*to++= &lock;
DBUG_RETURN(to);
}
static int test_connection(MYSQL_THD thd, federatedx_io *io,
FEDERATEDX_SHARE *share)
{
char buffer[FEDERATEDX_QUERY_BUFFER_SIZE];
String str(buffer, sizeof(buffer), &my_charset_bin);
FEDERATEDX_IO_RESULT *resultset= NULL;
int retval;
str.length(0);
str.append(STRING_WITH_LEN("SELECT * FROM "));
append_identifier(thd, &str, share->table_name,
share->table_name_length);
str.append(STRING_WITH_LEN(" WHERE 1=0"));
if ((retval= io->query(str.ptr(), str.length())))
{
sprintf(buffer, "database: '%s' username: '%s' hostname: '%s'",
share->database, share->username, share->hostname);
DBUG_PRINT("info", ("error-code: %d", io->error_code()));
my_error(ER_CANT_CREATE_FEDERATED_TABLE, MYF(0), buffer);
}
else
resultset= io->store_result();
io->free_result(resultset);
return retval;
}
/*
create() does nothing, since we have no local setup of our own.
FUTURE: We should potentially connect to the foreign database and
*/
int ha_federatedx::create(const char *name, TABLE *table_arg,
HA_CREATE_INFO *create_info)
{
int retval;
THD *thd= ha_thd();
FEDERATEDX_SHARE tmp_share; // Only a temporary share, to test the url
federatedx_txn *tmp_txn;
federatedx_io *tmp_io= NULL;
DBUG_ENTER("ha_federatedx::create");
if ((retval= parse_url(thd->mem_root, &tmp_share, table_arg->s, 1)))
goto error;
/* loopback socket connections hang due to LOCK_open mutex */
if ((!tmp_share.hostname || !strcmp(tmp_share.hostname,my_localhost)) &&
!tmp_share.port)
goto error;
/*
If possible, we try to use an existing network connection to
the remote server. To ensure that no new FEDERATEDX_SERVER
instance is created, we pass NULL in get_server() TABLE arg.
*/
mysql_mutex_lock(&federatedx_mutex);
tmp_share.s= get_server(&tmp_share, NULL);
mysql_mutex_unlock(&federatedx_mutex);
if (tmp_share.s)
{
tmp_txn= get_txn(thd);
if (!(retval= tmp_txn->acquire(&tmp_share, thd, TRUE, &tmp_io)))
{
retval= test_connection(thd, tmp_io, &tmp_share);
tmp_txn->release(&tmp_io);
}
free_server(tmp_txn, tmp_share.s);
}
else
{
FEDERATEDX_SERVER server;
fill_server(thd->mem_root, &server, &tmp_share, create_info->table_charset);
#ifndef DBUG_OFF
mysql_mutex_init(fe_key_mutex_FEDERATEDX_SERVER_mutex,
&server.mutex, MY_MUTEX_INIT_FAST);
mysql_mutex_lock(&server.mutex);
#endif
tmp_io= federatedx_io::construct(thd->mem_root, &server);
retval= test_connection(thd, tmp_io, &tmp_share);
#ifndef DBUG_OFF
mysql_mutex_unlock(&server.mutex);
mysql_mutex_destroy(&server.mutex);
#endif
delete tmp_io;
}
error:
DBUG_RETURN(retval);
}
int ha_federatedx::stash_remote_error()
{
DBUG_ENTER("ha_federatedx::stash_remote_error()");
if (!io)
DBUG_RETURN(remote_error_number);
remote_error_number= io->error_code();
strmake_buf(remote_error_buf, io->error_str());
if (remote_error_number == ER_DUP_ENTRY ||
remote_error_number == ER_DUP_KEY)
DBUG_RETURN(HA_ERR_FOUND_DUPP_KEY);
DBUG_RETURN(HA_FEDERATEDX_ERROR_WITH_REMOTE_SYSTEM);
}
bool ha_federatedx::get_error_message(int error, String* buf)
{
DBUG_ENTER("ha_federatedx::get_error_message");
DBUG_PRINT("enter", ("error: %d", error));
if (error == HA_FEDERATEDX_ERROR_WITH_REMOTE_SYSTEM)
{
buf->append(STRING_WITH_LEN("Error on remote system: "));
buf->qs_append(remote_error_number);
buf->append(STRING_WITH_LEN(": "));
buf->append(remote_error_buf);
/* Ensure string ends with \0 */
(void) buf->c_ptr_safe();
remote_error_number= 0;
remote_error_buf[0]= '\0';
}
DBUG_PRINT("exit", ("message: %s", buf->c_ptr_safe()));
DBUG_RETURN(FALSE);
}
int ha_federatedx::start_stmt(MYSQL_THD thd, thr_lock_type lock_type)
{
DBUG_ENTER("ha_federatedx::start_stmt");
DBUG_ASSERT(txn == get_txn(thd));
if (!txn->in_transaction())
{
txn->stmt_begin();
trans_register_ha(thd, FALSE, ht);
}
DBUG_RETURN(0);
}
int ha_federatedx::external_lock(MYSQL_THD thd, int lock_type)
{
int error= 0;
DBUG_ENTER("ha_federatedx::external_lock");
if (lock_type == F_UNLCK)
txn->release(&io);
else
{
table_will_be_deleted = FALSE;
txn= get_txn(thd);
if (!(error= txn->acquire(share, ha_thd(), lock_type == F_RDLCK, &io)) &&
(lock_type == F_WRLCK || !io->is_autocommit()))
{
if (!thd_test_options(thd, (OPTION_NOT_AUTOCOMMIT | OPTION_BEGIN)))
{
txn->stmt_begin();
trans_register_ha(thd, FALSE, ht);
}
else
{
txn->txn_begin();
trans_register_ha(thd, TRUE, ht);
}
}
}
DBUG_RETURN(error);
}
int ha_federatedx::savepoint_set(handlerton *hton, MYSQL_THD thd, void *sv)
{
int error= 0;
federatedx_txn *txn= (federatedx_txn *) thd_get_ha_data(thd, hton);
DBUG_ENTER("ha_federatedx::savepoint_set");
if (txn && txn->has_connections())
{
if (txn->txn_begin())
trans_register_ha(thd, TRUE, hton);
txn->sp_acquire((ulong *) sv);
DBUG_ASSERT(1 < *(ulong *) sv);
}
DBUG_RETURN(error);
}
int ha_federatedx::savepoint_rollback(handlerton *hton, MYSQL_THD thd, void *sv)
{
int error= 0;
federatedx_txn *txn= (federatedx_txn *) thd_get_ha_data(thd, hton);
DBUG_ENTER("ha_federatedx::savepoint_rollback");
if (txn)
error= txn->sp_rollback((ulong *) sv);
DBUG_RETURN(error);
}
int ha_federatedx::savepoint_release(handlerton *hton, MYSQL_THD thd, void *sv)
{
int error= 0;
federatedx_txn *txn= (federatedx_txn *) thd_get_ha_data(thd, hton);
DBUG_ENTER("ha_federatedx::savepoint_release");
if (txn)
error= txn->sp_release((ulong *) sv);
DBUG_RETURN(error);
}
int ha_federatedx::commit(handlerton *hton, MYSQL_THD thd, bool all)
{
int return_val;
federatedx_txn *txn= (federatedx_txn *) thd_get_ha_data(thd, hton);
DBUG_ENTER("ha_federatedx::commit");
if (all)
return_val= txn->txn_commit();
else
return_val= txn->stmt_commit();
DBUG_PRINT("info", ("error val: %d", return_val));
DBUG_RETURN(return_val);
}
int ha_federatedx::rollback(handlerton *hton, MYSQL_THD thd, bool all)
{
int return_val;
federatedx_txn *txn= (federatedx_txn *) thd_get_ha_data(thd, hton);
DBUG_ENTER("ha_federatedx::rollback");
if (all)
return_val= txn->txn_rollback();
else
return_val= txn->stmt_rollback();
DBUG_PRINT("info", ("error val: %d", return_val));
DBUG_RETURN(return_val);
}
/*
Federated supports assisted discovery, like
CREATE TABLE t1 CONNECTION="mysql://joe:pass@192.168.1.111/federated/t1";
but not a fully automatic discovery where a table magically appear
on any use (like, on SELECT * from t1).
*/
int ha_federatedx::discover_assisted(handlerton *hton, THD* thd,
TABLE_SHARE *table_s, HA_CREATE_INFO *info)
{
int error= HA_ERR_NO_CONNECTION;
FEDERATEDX_SHARE tmp_share;
CHARSET_INFO *cs= system_charset_info;
MYSQL mysql;
char buf[1024];
String query(buf, sizeof(buf), cs);
MYSQL_RES *res;
MYSQL_ROW rdata;
ulong *rlen;
my_bool my_true= 1;
if (parse_url(thd->mem_root, &tmp_share, table_s, 1))
return HA_WRONG_CREATE_OPTION;
mysql_init(&mysql);
mysql_options(&mysql, MYSQL_SET_CHARSET_NAME, cs->csname);
mysql_options(&mysql, MYSQL_OPT_USE_THREAD_SPECIFIC_MEMORY,
(char*) &my_true);
if (!mysql_real_connect(&mysql, tmp_share.hostname, tmp_share.username,
tmp_share.password, tmp_share.database,
tmp_share.port, tmp_share.socket, 0))
goto err1;
if (mysql_real_query(&mysql, STRING_WITH_LEN("SET SQL_MODE=NO_TABLE_OPTIONS")))
goto err1;
query.copy(STRING_WITH_LEN("SHOW CREATE TABLE "), cs);
append_ident(&query, tmp_share.table_name,
tmp_share.table_name_length, ident_quote_char);
if (mysql_real_query(&mysql, query.ptr(), query.length()))
goto err1;
if (!((res= mysql_store_result(&mysql))))
goto err1;
if (!(rdata= mysql_fetch_row(res)) || !((rlen= mysql_fetch_lengths(res))))
goto err2;
query.copy(rdata[1], rlen[1], cs);
query.append(STRING_WITH_LEN(" CONNECTION='"), cs);
query.append_for_single_quote(table_s->connect_string.str,
table_s->connect_string.length);
query.append('\'');
error= table_s->init_from_sql_statement_string(thd, true,
query.ptr(), query.length());
err2:
mysql_free_result(res);
err1:
if (error)
my_error(ER_CONNECT_TO_FOREIGN_DATA_SOURCE, MYF(0), mysql_error(&mysql));
mysql_close(&mysql);
return error;
}
struct st_mysql_storage_engine federatedx_storage_engine=
{ MYSQL_HANDLERTON_INTERFACE_VERSION };
maria_declare_plugin(federatedx)
{
MYSQL_STORAGE_ENGINE_PLUGIN,
&federatedx_storage_engine,
"FEDERATED",
"Patrick Galbraith",
"FederatedX pluggable storage engine",
PLUGIN_LICENSE_GPL,
federatedx_db_init, /* Plugin Init */
federatedx_done, /* Plugin Deinit */
0x0201 /* 2.1 */,
NULL, /* status variables */
NULL, /* system variables */
"2.1", /* string version */
MariaDB_PLUGIN_MATURITY_STABLE /* maturity */
}
maria_declare_plugin_end;
|