1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
|
/*
* %CopyrightBegin%
*
* Copyright Ericsson AB 2018-2018. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* %CopyrightEnd%
*
* ----------------------------------------------------------------------
* Purpose : The NIF (C) part of the socket interface
* ----------------------------------------------------------------------
*
*/
/* #include <stdio.h> */
/* #include <stdlib.h> */
/* #include <stdarg.h> */
/* #include <string.h> */
/* #include <unistd.h> */
/* #include <errno.h> */
/* #include <netdb.h> */
/* #include <sys/types.h> */
/* #include <sys/wait.h> */
/* #include <sys/socket.h> */
/* #include <netinet/in.h> */
/* #include <arpa/inet.h> */
/* #include <sys/time.h> */
/* #include <fcntl.h> */
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
/* If we HAVE_SCTP_H and Solaris, we need to define the following in
* order to get SCTP working:
*/
#if (defined(HAVE_SCTP_H) && defined(__sun) && defined(__SVR4))
#define SOLARIS10 1
/* WARNING: This is not quite correct, it may also be Solaris 11! */
#define _XPG4_2
#define __EXTENSIONS__
#endif
#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <ctype.h>
#include <sys/types.h>
#include <errno.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_UIO_H
#include <sys/uio.h>
#endif
#ifdef HAVE_NET_IF_DL_H
#include <net/if_dl.h>
#endif
#ifdef HAVE_IFADDRS_H
#include <ifaddrs.h>
#endif
#ifdef HAVE_NETPACKET_PACKET_H
#include <netpacket/packet.h>
#endif
#ifdef HAVE_SYS_UN_H
#include <sys/un.h>
#endif
/* SENDFILE STUFF HERE IF WE NEED IT... */
#if defined(__APPLE__) && defined(__MACH__) && !defined(__DARWIN__)
#define __DARWIN__ 1
#endif
#ifdef __WIN32__
#define STRNCASECMP strncasecmp
#define INCL_WINSOCK_API_TYPEDEFS 1
#ifndef WINDOWS_H_INCLUDES_WINSOCK2_H
#include <winsock2.h>
#endif
#include <windows.h>
#include <Ws2tcpip.h> /* NEED VC 6.0 or higher */
/* Visual studio 2008+: NTDDI_VERSION needs to be set for iphlpapi.h
* to define the right structures. It needs to be set to WINXP (or LONGHORN)
* for IPV6 to work and it's set lower by default, so we need to change it.
*/
#ifdef HAVE_SDKDDKVER_H
# include <sdkddkver.h>
# ifdef NTDDI_VERSION
# undef NTDDI_VERSION
# endif
# define NTDDI_VERSION NTDDI_WINXP
#endif
#include <iphlpapi.h>
#undef WANT_NONBLOCKING
#include "sys.h"
#else /* !__WIN32__ */
#include <sys/time.h>
#ifdef NETDB_H_NEEDS_IN_H
#include <netinet/in.h>
#endif
#include <netdb.h>
#include <sys/socket.h>
#include <netinet/in.h>
#ifdef DEF_INADDR_LOOPBACK_IN_RPC_TYPES_H
#include <rpc/types.h>
#endif
#include <netinet/tcp.h>
#include <arpa/inet.h>
#include <sys/param.h>
#ifdef HAVE_ARPA_NAMESER_H
#include <arpa/nameser.h>
#endif
#ifdef HAVE_SYS_SOCKIO_H
#include <sys/sockio.h>
#endif
#ifdef HAVE_SYS_IOCTL_H
#include <sys/ioctl.h>
#endif
#include <net/if.h>
#ifdef HAVE_SCHED_H
#include <sched.h>
#endif
#ifdef HAVE_SETNS_H
#include <setns.h>
#endif
#define HAVE_UDP
#ifndef WANT_NONBLOCKING
#define WANT_NONBLOCKING
#endif
#include "sys.h"
#endif
#include <erl_nif.h>
/* All platforms fail on malloc errors. */
#define FATAL_MALLOC
/* *** Boolean *type* stuff... *** */
typedef unsigned int BOOLEAN_T;
#define TRUE 1
#define FALSE 0
#define BOOL2STR(__B__) ((__B__) ? "true" : "false")
#define BOOL2ATOM(__B__) ((__B__) ? atom_true : atom_false)
/* Two byte integer decoding */
#define get_int16(s) ((((unsigned char*) (s))[0] << 8) | \
(((unsigned char*) (s))[1]))
#define SASSERT(e) \
((void) ((e) ? 1 : (xabort(#e, __func__, __FILE__, __LINE__), 0)))
/* Debug stuff... */
#define SOCKET_NIF_DEBUG_DEFAULT TRUE
#define SOCKET_DEBUG_DEFAULT TRUE
/* Used in debug printouts */
#ifdef __WIN32__
#define LLU "%I64u"
#else
#define LLU "%llu"
#endif
typedef unsigned long long llu_t;
/* Socket stuff */
#define INVALID_SOCKET -1
#define INVALID_EVENT -1
#define SOCKET_ERROR -1
#define SOCKET int
#define HANDLE long int
/* ==============================================================================
* The IS_SOCKET_ERROR macro below is used for portability reasons.
* While POSIX specifies that errors from socket-related system calls
* should be indicated with a -1 return value, some users have experienced
* non-Windows OS kernels that return negative values other than -1.
* While one can argue that such kernels are technically broken, comparing
* against values less than 0 covers their out-of-spec return values without
* imposing incorrect semantics on systems that manage to correctly return -1
* for errors, thus increasing Erlang's portability.
*/
#ifdef __WIN32__
#define IS_SOCKET_ERROR(val) ((val) == SOCKET_ERROR)
#else
#define IS_SOCKET_ERROR(val) ((val) < 0)
#endif
/* *** Misc macros and defines *** */
/* *** Socket state defs *** */
#define SOCKET_FLAG_OPEN 0x0001
#define SOCKET_FLAG_ACTIVE 0x0004
#define SOCKET_FLAG_LISTEN 0x0008
#define SOCKET_FLAG_CON 0x0010
#define SOCKET_FLAG_ACC 0x0020
#define SOCKET_FLAG_BUSY 0x0040
#define SOCKET_FLAG_CLOSE 0x0080
#define SOCKET_STATE_CLOSED (0)
#define SOCKET_STATE_OPEN (SOCKET_FLAG_OPEN)
#define SOCKET_STATE_CONNECTED (SOCKET_STATE_OPEN | SOCKET_FLAG_ACTIVE)
#define SOCKET_STATE_LISTENING (SOCKET_STATE_OPEN | SOCKET_FLAG_LISTEN)
#define SOCKET_STATE_CONNECTING (SOCKET_STATE_OPEN | SOCKET_FLAG_CON)
#define SOCKET_STATE_ACCEPTING (SOCKET_STATE_LISTENING | SOCKET_FLAG_ACC)
#define SOCKET_STATE_CLOSING (SOCKET_FLAG_CLOSE)
#define IS_OPEN(d) \
(((d)->state & SOCKET_FLAG_OPEN) == SOCKET_FLAG_OPEN)
#define IS_CONNECTED(d) \
(((d)->state & SOCKET_STATE_CONNECTED) == SOCKET_STATE_CONNECTED)
#define IS_CONNECTING(d) \
(((d)->state & SOCKET_FLAG_CON) == SOCKET_FLAG_CON)
#define IS_BUSY(d) \
(((d)->state & SOCKET_FLAG_BUSY) == SOCKET_FLAG_BUSY)
#define SOCKET_SEND_FLAG_CONFIRM 0
#define SOCKET_SEND_FLAG_DONTROUTE 1
#define SOCKET_SEND_FLAG_EOR 2
#define SOCKET_SEND_FLAG_MORE 3
#define SOCKET_SEND_FLAG_NOSIGNAL 4
#define SOCKET_SEND_FLAG_OOB 5
#define SOCKET_SEND_FLAG_LOW SOCKET_SEND_FLAG_CONFIRM
#define SOCKET_SEND_FLAG_HIGH SOCKET_SEND_FLAG_OOB
#define SOCKET_RECV_FLAG_CMSG_CLOEXEC 0
#define SOCKET_RECV_FLAG_ERRQUEUE 1
#define SOCKET_RECV_FLAG_OOB 2
#define SOCKET_RECV_FLAG_PEEK 3
#define SOCKET_RECV_FLAG_TRUNC 4
#define SOCKET_RECV_FLAG_LOW SOCKET_RECV_FLAG_CMSG_CLOEXEC
#define SOCKET_RECV_FLAG_HIGH SOCKET_RECV_FLAG_TRUNC
#define SOCKET_RECV_BUFFER_SIZE_DEFAULT 2048
typedef union {
struct {
unsigned int open:1;
// 0 = not conn, 1 = connecting, 2 = connected
unsigned int connect:2;
// unsigned int connecting:1;
// unsigned int connected:1;
// 0 = not listen, 1 = listening, 2 = accepting
unsigned int listen:2;
// unsigned int listening:1;
// unsigned int accepting:1;
/* Room for more... */
} flags;
unsigned int field; // Make it easy to reset all flags...
} SocketState;
/*
#define IS_OPEN(d) ((d)->state.flags.open)
#define IS_CONNECTED(d) ((d)->state.flags.connect == SOCKET_STATE_CONNECTED)
#define IS_CONNECTING(d) ((d)->state.flags.connect == SOCKET_STATE_CONNECTING)
*/
/*----------------------------------------------------------------------------
* Interface constants.
*
* This section must be "identical" to the corresponding socket.hrl
*/
/* domain */
#define SOCKET_DOMAIN_LOCAL 1
#define SOCKET_DOMAIN_INET 2
#define SOCKET_DOMAIN_INET6 3
/* type */
#define SOCKET_TYPE_STREAM 1
#define SOCKET_TYPE_DGRAM 2
#define SOCKET_TYPE_RAW 3
// #define SOCKET_TYPE_RDM 4
#define SOCKET_TYPE_SEQPACKET 5
/* protocol */
#define SOCKET_PROTOCOL_IP 1
#define SOCKET_PROTOCOL_TCP 2
#define SOCKET_PROTOCOL_UDP 3
#define SOCKET_PROTOCOL_SCTP 4
/* =================================================================== *
* *
* Various enif macros *
* *
* =================================================================== */
#define MALLOC(SZ) enif_alloc((SZ))
#define FREE(P) enif_free((P))
#define MKA(E,S) enif_make_atom((E), (S))
#define MKBIN(E,B) enif_make_binary((E), (B))
#define MKI(E,I) enif_make_int((E), (I))
#define MKREF(E) enif_make_ref((E))
#define MKS(E,S) enif_make_string((E), (S), ERL_NIF_LATIN1)
#define MKSL(E,S,L) enif_make_string_len((E), (S), (L), ERL_NIF_LATIN1)
#define MKSBIN(E,B,ST,SZ) enif_make_sub_binary((E), (B), (ST), (SZ))
#define MKT2(E,E1,E2) enif_make_tuple2((E), (E1), (E2))
#define MKT3(E,E1,E2,E3) enif_make_tuple3((E), (E1), (E2), (E3))
#define MKT4(E,E1,E2,E3,E4) enif_make_tuple4((E), (E1), (E2), (E3), (E4))
#define MKT8(E,E1,E2,E3,E4,E5,E6,E7,E8) \
enif_make_tuple8((E), (E1), (E2), (E3), (E4), (E5), (E6), (E7), (E8))
#define MCREATE(N) enif_mutex_create((N))
#define MDESTROY(M) enif_mutex_destroy((M))
#define MLOCK(M) enif_mutex_lock((M))
#define MUNLOCK(M) enif_mutex_unlock((M))
#define MONP(E,D,P,M) enif_monitor_process((E), (D), (P), (M))
#define DEMONP(E,D,M) enif_demonitor_process((E), (D), (M))
#define SELECT(E,FD,M,O,P,R) \
if (enif_select((E), (FD), (M), (O), (P), (R)) < 0) \
return enif_make_badarg((E));
#define IS_ATOM(E, TE) enif_is_atom((E), (TE))
#define IS_BIN(E, TE) enif_is_binary((E), (TE))
#define IS_NUM(E, TE) enif_is_number((E), (TE))
#define IS_TUPLE(E, TE) enif_is_tuple((E), (TE))
#define GET_ATOM_LEN(E, TE, LP) \
enif_get_atom_length((E), (TE), (LP), ERL_NIF_LATIN1)
#define GET_ATOM(E, TE, BP, MAX) \
enif_get_atom((E), (TE), (BP), (MAX), ERL_NIF_LATIN1)
#define GET_BIN(E, TE, BP) enif_inspect_iolist_as_binary((E), (TE), (BP))
#define GET_INT(E, TE, IP) enif_get_int((E), (TE), (IP))
#define GET_UINT(E, TE, IP) enif_get_uint((E), (TE), (IP))
#define GET_TUPLE(E, TE, TSZ, TA) enif_get_tuple((E), (TE), (TSZ), (TA))
#define ALLOC_BIN(SZ, BP) enif_alloc_binary((SZ), (BP))
/* =================================================================== *
* *
* Basic socket operations *
* *
* =================================================================== */
#ifdef __WIN32__
/* *** Windows macros *** */
#define sock_accept(s, addr, len) \
make_noninheritable_handle(accept((s), (addr), (len)))
#define sock_bind(s, addr, len) bind((s), (addr), (len))
#define sock_close(s) closesocket((s))
#define sock_close_event(e) WSACloseEvent(e)
#define sock_connect(s, addr, len) connect((s), (addr), (len))
#define sock_create_event(s) WSACreateEvent()
#define sock_errno() WSAGetLastError()
#define sock_getopt(s,t,n,v,l) getsockopt((s),(t),(n),(v),(l))
#define sock_htons(x) htons((x))
#define sock_htonl(x) htonl((x))
#define sock_listen(s, b) listen((s), (b))
#define sock_name(s, addr, len) getsockname((s), (addr), (len))
#define sock_ntohs(x) ntohs((x))
#define sock_open(domain, type, proto) \
make_noninheritable_handle(socket((domain), (type), (proto)))
#define sock_recv(s,buf,len,flag) recv((s),(buf),(len),(flag))
#define sock_recvfrom(s,buf,blen,flag,addr,alen) \
recvfrom((s),(buf),(blen),(flag),(addr),(alen))
#define sock_send(s,buf,len,flag) send((s),(buf),(len),(flag))
#define sock_sendto(s,buf,blen,flag,addr,alen) \
sendto((s),(buf),(blen),(flag),(addr),(alen))
#define SET_BLOCKING(s) ioctlsocket(s, FIONBIO, &zero_value)
#define SET_NONBLOCKING(s) ioctlsocket(s, FIONBIO, &one_value)
static unsigned long zero_value = 0;
static unsigned long one_value = 1;
#else /* !__WIN32__ */
#ifdef HAS_ACCEPT4
// We have to figure out what the flags are...
#define sock_accept(s, addr, len) accept4((s), (addr), (len), (SOCK_CLOEXEC))
#else
#define sock_accept(s, addr, len) accept((s), (addr), (len))
#endif
#define sock_bind(s, addr, len) bind((s), (addr), (len))
#define sock_close(s) close((s))
#define sock_close_event(e) /* do nothing */
#define sock_connect(s, addr, len) connect((s), (addr), (len))
#define sock_create_event(s) (s) /* return file descriptor */
#define sock_errno() errno
#define sock_getopt(s,t,n,v,l) getsockopt((s),(t),(n),(v),(l))
#define sock_htons(x) htons((x))
#define sock_htonl(x) htonl((x))
#define sock_listen(s, b) listen((s), (b))
#define sock_name(s, addr, len) getsockname((s), (addr), (len))
#define sock_ntohs(x) ntohs((x))
#define sock_open(domain, type, proto) socket((domain), (type), (proto))
#define sock_recv(s,buf,len,flag) recv((s),(buf),(len),(flag))
#define sock_recvfrom(s,buf,blen,flag,addr,alen) \
recvfrom((s),(buf),(blen),(flag),(addr),(alen))
#define sock_send(s,buf,len,flag) send((s), (buf), (len), (flag))
#define sock_sendto(s,buf,blen,flag,addr,alen) \
sendto((s),(buf),(blen),(flag),(addr),(alen))
#endif /* !__WIN32__ */
#ifdef HAVE_SOCKLEN_T
# define SOCKLEN_T socklen_t
#else
# define SOCKLEN_T size_t
#endif
/* The general purpose sockaddr */
typedef union {
struct sockaddr sa;
struct sockaddr_in sai;
#ifdef HAVE_IN6
struct sockaddr_in6 sai6;
#endif
#ifdef HAVE_SYS_UN_H
struct sockaddr_un sal;
#endif
} SocketAddress;
#define which_address_port(sap) \
((((sap)->sai.sin_family == AF_INET) || \
((sap)->sai.sin_family == AF_INET6)) ? \
((sap)->sai.sin_port) : -1)
typedef struct {
ErlNifPid pid; // PID of the requesting process
ErlNifMonitor mon; // Monitor to the requesting process
ERL_NIF_TERM ref; // The (unique) reference (ID) of the request
} SocketRequestor;
typedef struct socket_request_queue_element {
struct socket_request_queue_element* nextP;
SocketRequestor data;
} SocketRequestQueueElement;
typedef struct {
SocketRequestQueueElement* first;
SocketRequestQueueElement* last;
} SocketRequestQueue;
typedef struct {
/* +++ The actual socket +++ */
SOCKET sock;
HANDLE event;
/* +++ Stuff "about" the socket +++ */
int domain;
int type;
int protocol;
unsigned int state;
SocketAddress remote;
/* +++ Controller (owner) process +++ */
ErlNifPid ctrlPid;
ErlNifMonitor ctrlMon;
/* +++ Write stuff +++ */
ErlNifMutex* writeMtx;
SocketRequestor currentWriter;
SocketRequestor* currentWriterP; // NULL or points to currentWriter
SocketRequestQueue writersQ;
BOOLEAN_T isWritable;
uint32_t writePkgCnt;
uint32_t writeByteCnt;
uint32_t writeTries;
uint32_t writeWaits;
uint32_t writeFails;
/* +++ Read stuff +++ */
ErlNifMutex* readMtx;
SocketRequestor currentReader;
SocketRequestor* currentReaderP; // NULL or points to currentReader
SocketRequestQueue readersQ;
BOOLEAN_T isReadable;
ErlNifBinary rbuffer; // DO WE NEED THIS
uint32_t readCapacity; // DO WE NEED THIS
uint32_t readPkgCnt;
uint32_t readByteCnt;
uint32_t readTries;
uint32_t readWaits;
/* +++ Accept stuff +++ */
ErlNifMutex* accMtx;
SocketRequestor currentAcceptor;
SocketRequestor* currentAcceptorP; // NULL or points to currentReader
SocketRequestQueue acceptorsQ;
/* +++ Config & Misc stuff +++ */
size_t rBufSz; // Read buffer size (when data length = 0 is specified)
BOOLEAN_T iow; // Inform On Wrap
BOOLEAN_T dbg;
/* +++ Close stuff +++ */
ErlNifMutex* closeMtx;
ErlNifPid closerPid;
ErlNifMonitor closerMon;
ERL_NIF_TERM closeRef;
BOOLEAN_T closeLocal;
} SocketDescriptor;
/* Global stuff (do we really need to "collect"
* these things?)
*/
typedef struct {
/* These are for debugging, testing and the like */
ERL_NIF_TERM version;
ERL_NIF_TERM buildDate;
BOOLEAN_T dbg;
} SocketData;
/* ----------------------------------------------------------------------
* F o r w a r d s
* ----------------------------------------------------------------------
*/
/* THIS IS JUST TEMPORARY */
extern char* erl_errno_id(int error);
static ERL_NIF_TERM nif_is_loaded(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_info(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
/*
This is a *global* debug function (enable or disable for all
operations and all sockets.
static ERL_NIF_TERM nif_debug(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
*/
static ERL_NIF_TERM nif_open(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_bind(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_connect(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_listen(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_accept(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_send(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_sendto(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_recv(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_recvfrom(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_close(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_setsockopt(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_getsockopt(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_finalize_connection(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_finalize_close(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nif_cancel(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[]);
static ERL_NIF_TERM nopen(ErlNifEnv* env,
int domain,
int type,
int protocol,
char* netns);
static ERL_NIF_TERM nbind(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM addr);
static ERL_NIF_TERM nconnect(ErlNifEnv* env,
SocketDescriptor* descP,
const ERL_NIF_TERM* addr,
int port);
static ERL_NIF_TERM nlisten(ErlNifEnv* env,
SocketDescriptor* descP,
int backlog);
static ERL_NIF_TERM naccept_listening(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM ref);
static ERL_NIF_TERM naccept_accepting(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM ref);
static ERL_NIF_TERM naccept(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM ref);
static ERL_NIF_TERM nsend(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM sendRef,
ErlNifBinary* dataP,
int flags);
static ERL_NIF_TERM nsendto(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM sendRef,
ErlNifBinary* dataP,
int flags,
SocketAddress* toAddrP,
unsigned int toAddrLen);
static ERL_NIF_TERM nrecv(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM recvRef,
int len,
int flags);
static ERL_NIF_TERM nrecvfrom(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM recvRef,
uint16_t bufSz,
int flags);
static ERL_NIF_TERM nclose(ErlNifEnv* env,
SocketDescriptor* descP);
static ERL_NIF_TERM send_check_result(ErlNifEnv* env,
SocketDescriptor* descP,
ssize_t written,
ssize_t dataSize,
ERL_NIF_TERM sendRef);
static ERL_NIF_TERM recv_check_result(ErlNifEnv* env,
SocketDescriptor* descP,
int read,
int toRead,
ErlNifBinary* bufP,
ERL_NIF_TERM recvRef);
static ERL_NIF_TERM recvfrom_check_result(ErlNifEnv* env,
SocketDescriptor* descP,
int read,
ErlNifBinary* bufP,
SocketAddress* fromAddrP,
unsigned int fromAddrLen,
ERL_NIF_TERM recvRef);
static ERL_NIF_TERM nfinalize_connection(ErlNifEnv* env,
SocketDescriptor* descP);
static ERL_NIF_TERM nfinalize_close(ErlNifEnv* env,
SocketDescriptor* descP);
static char* decode_laddress(ErlNifEnv* env,
int domain,
ERL_NIF_TERM localAddr,
SocketAddress* localP,
unsigned int* addrLenP);
static char* decode_laddress_binary(ErlNifEnv* env,
int domain,
ERL_NIF_TERM localAddr,
SocketAddress* localP,
unsigned int* addrLenP);
static char* decode_laddress_tuple(ErlNifEnv* env,
int domain,
ERL_NIF_TERM laddr,
SocketAddress* localP,
unsigned int* addrLenP);
static char* decode_address_tuple(ErlNifEnv* env,
int domain,
const ERL_NIF_TERM* addrt,
int port,
SocketAddress* localP,
unsigned int* addrLenP);
static char* decode_address_atom(ErlNifEnv* env,
int domain,
char* addr,
int addrLen,
int port,
SocketAddress* localP,
unsigned int* addrLenP);
static char* decode_send_addr(ErlNifEnv* env,
int domain,
ERL_NIF_TERM addr,
int port,
SocketAddress** toAddrP,
unsigned int* addrLenP);
static char* decode_send_addr_tuple(ErlNifEnv* env,
int domain,
ERL_NIF_TERM addr,
int port,
SocketAddress* toAddrP,
unsigned int* addrLenP);
static void encode_address(ErlNifEnv* env,
SocketAddress* fromAddrP,
unsigned int fromAddrLen,
ERL_NIF_TERM* fromDomainT,
ERL_NIF_TERM* fromSourceT);
static void inform_waiting_procs(ErlNifEnv* env,
SocketDescriptor* descP,
SocketRequestQueue* q,
BOOLEAN_T free,
ERL_NIF_TERM reason);
static BOOLEAN_T verify_is_connected(SocketDescriptor* descP, int* err);
static SocketDescriptor* alloc_descriptor(SOCKET sock, HANDLE event);
static int compare_pids(ErlNifEnv* env,
const ErlNifPid* pid1,
const ErlNifPid* pid2);
static BOOLEAN_T edomain2domain(int edomain, int* domain);
static BOOLEAN_T etype2type(int etype, int* type);
static BOOLEAN_T eproto2proto(int eproto, int* proto);
static BOOLEAN_T esendflags2sendflags(unsigned int esendflags, int* sendflags);
static BOOLEAN_T erecvflags2recvflags(unsigned int erecvflags, int* recvflags);
#ifdef HAVE_SETNS
static BOOLEAN_T emap2netns(ErlNifEnv* env, ERL_NIF_TERM map, char** netns);
static BOOLEAN_T change_network_namespace(char* netns, int* cns, int* err);
static BOOLEAN_T restore_network_namespace(int ns, SOCKET sock, int* err);
#endif
static BOOLEAN_T cnt_inc(uint32_t* cnt, uint32_t inc);
#if defined(HAVE_SYS_UN_H) || defined(SO_BINDTODEVICE)
static size_t my_strnlen(const char *s, size_t maxlen);
#endif
static void socket_dtor(ErlNifEnv* env, void* obj);
static void socket_stop(ErlNifEnv* env,
void* obj,
int fd,
int is_direct_call);
static void socket_down(ErlNifEnv* env,
void* obj,
const ErlNifPid* pid,
const ErlNifMonitor* mon);
static ERL_NIF_TERM make_ok2(ErlNifEnv* env, ERL_NIF_TERM val);
static ERL_NIF_TERM make_ok3(ErlNifEnv* env, ERL_NIF_TERM val1, ERL_NIF_TERM val2);
static ERL_NIF_TERM make_error(ErlNifEnv* env, ERL_NIF_TERM reason);
static ERL_NIF_TERM make_error1(ErlNifEnv* env, char* reason);
static ERL_NIF_TERM make_error2(ErlNifEnv* env, int err);
static char* send_msg_error_closed(ErlNifEnv* env,
ErlNifPid* pid);
static char* send_msg_error(ErlNifEnv* env,
ERL_NIF_TERM reason,
ErlNifPid* pid);
static char* send_msg_nif_abort(ErlNifEnv* env,
ERL_NIF_TERM ref,
ERL_NIF_TERM reason,
ErlNifPid* pid);
static char* send_msg(ErlNifEnv* env,
ERL_NIF_TERM msg,
ErlNifPid* pid);
static void xabort(const char* expr,
const char* func,
const char* file,
int line);
static BOOLEAN_T extract_item_on_load(ErlNifEnv* env,
ERL_NIF_TERM map,
ERL_NIF_TERM key,
ERL_NIF_TERM* val);
static BOOLEAN_T extract_debug_on_load(ErlNifEnv* env,
ERL_NIF_TERM map,
BOOLEAN_T def);
static int on_load(ErlNifEnv* env, void** priv_data, ERL_NIF_TERM load_info);
#if HAVE_IN6
# if ! defined(HAVE_IN6ADDR_ANY) || ! HAVE_IN6ADDR_ANY
# if HAVE_DECL_IN6ADDR_ANY_INIT
static const struct in6_addr in6addr_any = { { IN6ADDR_ANY_INIT } };
# else
static const struct in6_addr in6addr_any =
{ { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0 } } };
# endif /* HAVE_IN6ADDR_ANY_INIT */
# endif /* ! HAVE_DECL_IN6ADDR_ANY */
# if ! defined(HAVE_IN6ADDR_LOOPBACK) || ! HAVE_IN6ADDR_LOOPBACK
# if HAVE_DECL_IN6ADDR_LOOPBACK_INIT
static const struct in6_addr in6addr_loopback =
{ { IN6ADDR_LOOPBACK_INIT } };
# else
static const struct in6_addr in6addr_loopback =
{ { { 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,1 } } };
# endif /* HAVE_IN6ADDR_LOOPBACk_INIT */
# endif /* ! HAVE_DECL_IN6ADDR_LOOPBACK */
#endif /* HAVE_IN6 */
/* *** String constants *** */
static char str_close[] = "close";
static char str_closed[] = "closed";
static char str_closing[] = "closing";
static char str_error[] = "error";
static char str_false[] = "false";
static char str_nif_abort[] = "nif_abort";
static char str_ok[] = "ok";
static char str_select[] = "select";
static char str_timeout[] = "timeout";
static char str_true[] = "true";
static char str_undefined[] = "undefined";
/* (special) error string constants */
static char str_eagain[] = "eagain";
static char str_eafnosupport[] = "eafnosupport";
static char str_einval[] = "einval";
static char str_eisconn[] = "eisconn";
static char str_enotclosing[] = "enotclosing";
static char str_enotconn[] = "enotconn";
static char str_exalloc[] = "exalloc";
static char str_exbadstate[] = "exbadstate";
static char str_exbusy[] = "exbusy";
static char str_exmon[] = "exmonitor"; // failed monitor
static char str_exself[] = "exself"; // failed self
static char str_exsend[] = "exsend"; // failed send
/* *** Atoms *** */
static ERL_NIF_TERM atom_close;
static ERL_NIF_TERM atom_closed;
static ERL_NIF_TERM atom_closing;
static ERL_NIF_TERM atom_error;
static ERL_NIF_TERM atom_false;
static ERL_NIF_TERM atom_nif_abort;
static ERL_NIF_TERM atom_ok;
static ERL_NIF_TERM atom_select;
static ERL_NIF_TERM atom_timeout;
static ERL_NIF_TERM atom_true;
static ERL_NIF_TERM atom_undefined;
static ERL_NIF_TERM atom_eagain;
static ERL_NIF_TERM atom_eafnosupport;
static ERL_NIF_TERM atom_einval;
static ERL_NIF_TERM atom_eisconn;
static ERL_NIF_TERM atom_enotclosing;
static ERL_NIF_TERM atom_enotconn;
static ERL_NIF_TERM atom_exalloc;
static ERL_NIF_TERM atom_exbadstate;
static ERL_NIF_TERM atom_exbusy;
static ERL_NIF_TERM atom_exmon;
static ERL_NIF_TERM atom_exself;
static ERL_NIF_TERM atom_exsend;
/* *** Sockets *** */
static ErlNifResourceType* sockets;
static ErlNifResourceTypeInit socketInit = {
socket_dtor,
socket_stop,
(ErlNifResourceDown*) socket_down
};
// Initiated when the nif is loaded
static SocketData socketData;
/* ----------------------------------------------------------------------
* N I F F u n c t i o n s
* ----------------------------------------------------------------------
*
* Utility and admin functions:
* ----------------------------
* nif_is_loaded/0
* nif_info/0
* (nif_debug/1)
*
* The "proper" socket functions:
* ------------------------------
* nif_open(Domain, Type, Protocol, Extra)
* nif_bind(Sock, LocalAddr)
* nif_connect(Sock, Addr, Port)
* nif_listen(Sock, Backlog)
* nif_accept(LSock, Ref)
* nif_send(Sock, SendRef, Data, Flags)
* nif_sendto(Sock, SendRef, Data, Flags, DstAddr, DstPort)
* nif_recv(Sock, RecvRef, Length, Flags)
* nif_recvfrom(Sock, Flags)
* nif_close(Sock)
*
* And some functions to manipulate and retrieve socket options:
* -------------------------------------------------------------
* nif_setsockopt/3
* nif_getsockopt/2
*
* And some socket admin functions:
* -------------------------------------------------------------
* nif_cancel(Sock, Ref)
*/
/* ----------------------------------------------------------------------
* nif_is_loaded
*
* Description:
* This functions only purpose is to return the atom 'true'.
* This will happen *if* the (socket) nif library is loaded.
* If its not, the erlang (nif_is_loaded) will instead return
* 'false'.
*/
static
ERL_NIF_TERM nif_is_loaded(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
if (argc != 0)
return enif_make_badarg(env);
return atom_true;
}
/* ----------------------------------------------------------------------
* nif_info
*
* Description:
* This is currently just a placeholder...
*/
static
ERL_NIF_TERM nif_info(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
ERL_NIF_TERM info = enif_make_new_map(env);
return info;
}
/* ----------------------------------------------------------------------
* nif_open
*
* Description:
* Create an endpoint for communication.
*
* Arguments:
* Domain
* Type
* Protocol
* Extra - A map with obscure options.
* Currently the only allowed option is netns (network namespace).
* This is *only* allowed on linux!
*/
static
ERL_NIF_TERM nif_open(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
int edomain, etype, eproto;
int domain, type, proto;
char* netns;
ERL_NIF_TERM emap;
/* Extract arguments and perform preliminary validation */
if ((argc != 4) ||
!enif_get_int(env, argv[0], &edomain) ||
!enif_get_int(env, argv[1], &etype) ||
!enif_get_int(env, argv[2], &eproto) ||
!enif_is_map(env, argv[3])) {
return enif_make_badarg(env);
}
emap = argv[3];
if (!edomain2domain(edomain, &domain))
return enif_make_badarg(env);
if (!etype2type(etype, &type))
return enif_make_badarg(env);
if (!eproto2proto(eproto, &proto))
return enif_make_badarg(env);
#ifdef HAVE_SETNS
/* We *currently* only support one extra option: netns */
if (!emap2netns(env, emap, &netns))
return enif_make_badarg(env);
#else
netns = NULL;
#endif
return nopen(env, domain, type, proto, netns);
}
/* nopen - create an endpoint for communication
*
* Assumes the input has been validated.
*/
static
ERL_NIF_TERM nopen(ErlNifEnv* env,
int domain, int type, int protocol,
char* netns)
{
SocketDescriptor* descP;
ERL_NIF_TERM res;
int save_errno = 0;
SOCKET sock;
HANDLE event;
#ifdef HAVE_SETNS
int current_ns;
#endif
#ifdef HAVE_SETNS
if (!change_network_namespace(netns, ¤t_ns, &save_errno))
return make_error2(env, save_errno);
#endif
if ((sock = sock_open(domain, type, protocol)) == INVALID_SOCKET)
return make_error2(env, sock_errno());
#ifdef HAVE_SETNS
if (!restore_network_namespace(current_ns, sock, &save_errno))
return make_error2(env, save_errno);
if (netns != NULL)
FREE(netns);
#endif
if ((event = sock_create_event(sock)) == INVALID_EVENT) {
save_errno = sock_errno();
while ((sock_close(sock) == INVALID_SOCKET) && (sock_errno() == EINTR));
return make_error2(env, save_errno);
}
SET_NONBLOCKING(sock);
/* Create and initiate the socket "descriptor" */
if ((descP = alloc_descriptor(sock, event)) == NULL) {
sock_close(sock);
// Not sure if this is really the proper error, but...
return enif_make_badarg(env);
}
descP->state = SOCKET_STATE_OPEN;
descP->domain = domain;
descP->type = type;
descP->protocol = protocol;
res = enif_make_resource(env, descP);
enif_release_resource(descP); // We should really store a reference ...
/* Keep track of the creator
* This should not be a problem but just in case
* the *open* function is used with the wrong kind
* of environment...
*/
if (enif_self(env, &descP->ctrlPid) == NULL)
return make_error(env, atom_exself);
if (MONP(env, descP,
&descP->ctrlPid,
&descP->ctrlMon) > 0)
return make_error(env, atom_exmon);
#ifdef __WIN32__
/* What is the point of this?
* And how do we handle it?
* Since the select message will be delivered to the controlling
* process, which has no idea what to do with this...
*
* TODO!
*/
SELECT(env,
event,
(ERL_NIF_SELECT_READ),
descP, NULL, atom_undefined);
#endif
return make_ok2(env, res);
}
#ifdef HAVE_SETNS
/* We should really have another API, so that we can return errno... */
/* *** change network namespace ***
* Retreive the current namespace and set the new.
* Return result and previous namespace if successfull.
*/
static
BOOLEAN_T change_network_namespace(char* netns, int* cns, int* err)
{
int save_errno;
int current_ns = 0;
int new_ns = 0;
if (netns != NULL) {
current_ns = open("/proc/self/ns/net", O_RDONLY);
if (current_ns == INVALID_SOCKET) {
*cns = current_ns;
*err = sock_errno();
return FALSE;
}
new_ns = open(netns, O_RDONLY);
if (new_ns == INVALID_SOCKET) {
save_errno = sock_errno();
while (close(current_ns) == INVALID_SOCKET &&
sock_errno() == EINTR);
*cns = -1;
*err = save_errno;
return FALSE;
}
if (setns(new_ns, CLONE_NEWNET) != 0) {
save_errno = sock_errno();
while ((close(new_ns) == INVALID_SOCKET) &&
(sock_errno() == EINTR));
while ((close(current_ns) == INVALID_SOCKET) &&
(sock_errno() == EINTR));
*cns = -1;
*err = save_errno;
return FALSE;
} else {
while ((close(new_ns) == INVALID_SOCKET) &&
(sock_errno() == EINTR));
*cns = current_ns;
*err = 0;
return TRUE;
}
} else {
*cns = INVALID_SOCKET;
*err = 0;
return TRUE;
}
}
/* *** restore network namespace ***
* Restore the previous namespace (see above).
*/
static
BOOLEAN_T restore_network_namespace(int ns, SOCKET sock, int* err)
{
int save_errno;
if (ns != INVALID_SOCKET) {
if (setns(ns, CLONE_NEWNET) != 0) {
/* XXX Failed to restore network namespace.
* What to do? Tidy up and return an error...
* Note that the thread now might still be in the namespace.
* Can this even happen? Should the emulator be aborted?
*/
if (sock != INVALID_SOCKET)
save_errno = sock_errno();
while (close(sock) == INVALID_SOCKET &&
sock_errno() == EINTR);
sock = INVALID_SOCKET;
while (close(ns) == INVALID_SOCKET &&
sock_errno() == EINTR);
*err = save_errno;
return FALSE;
} else {
while (close(ns) == INVALID_SOCKET &&
sock_errno() == EINTR);
*err = 0;
return TRUE;
}
}
*err = 0;
return TRUE;
}
#endif
/* ----------------------------------------------------------------------
* nif_bind
*
* Description:
* Bind a name to a socket.
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* LocalAddr - Local address is either:
* - a binary - when the socket domain = local
* - a tuple of size 2 with
* - first element is the address
* - second element is the port number
* The address can be in the form of either:
* - A tuple of size 4 or 8 (depending on domain)
* - The atom 'any'
* - The atom 'loopback'
*/
static
ERL_NIF_TERM nif_bind(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
/* Extract arguments and perform preliminary validation */
if ((argc != 2) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP)) {
return enif_make_badarg(env);
}
/* Basic arg validation:
* - if binary domain must be local (unix)
* - if tuple domain must be either inet or inet6
*/
if (IS_BIN(env, argv[1]) && (descP->domain != AF_UNIX)) {
return enif_make_badarg(env);
} else if (IS_TUPLE(env, argv[1]) &&
(descP->domain != AF_INET) &&
(descP->domain != AF_INET6)) {
return enif_make_badarg(env);
}
/* Make sure we are ready
* Not sure how this would even happen, but...
*/
/* WHY NOT !IS_OPEN(...) */
if (descP->state != SOCKET_STATE_OPEN)
return make_error(env, atom_exbadstate);
return nbind(env, descP, argv[1]);
}
static
ERL_NIF_TERM nbind(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM addr)
{
SocketAddress local;
unsigned int addrLen;
char* err;
int port;
if ((err = decode_laddress(env, descP->domain, addr, &local, &addrLen)) != NULL)
return make_error1(env, err);
if (IS_SOCKET_ERROR(sock_bind(descP->sock,
(struct sockaddr*) &local, addrLen))) {
return make_error2(env, sock_errno());
}
port = which_address_port(&local);
if (port == 0) {
SOCKLEN_T len = sizeof(local);
sys_memzero((char *) &local, len);
sock_name(descP->sock, &local.sa, &len);
port = which_address_port(&local);
} else if (port == -1) {
port = 0;
}
return make_ok2(env, enif_make_int(env, port));
}
/* Decode the (local) address. The format of the address should
* either be an binary (domain = local) or a two tuple (first
* part the actual address tuple and the second part the port
* number) if the domain is either INET or INET6.
*/
static
char* decode_laddress(ErlNifEnv* env,
int domain,
ERL_NIF_TERM localAddr,
SocketAddress* localP,
unsigned int* addrLenP)
{
if (IS_BIN(env, localAddr)) {
return decode_laddress_binary(env, domain, localAddr, localP, addrLenP);
} else if (IS_TUPLE(env, localAddr)) {
return decode_laddress_tuple(env, domain, localAddr, localP, addrLenP);
} else {
return str_einval;
}
}
/* Only for domain = local (unix)
* The erlang interface module ensures that the size of the
* binary is > 0, so we need not do that here.
*/
static
char* decode_laddress_binary(ErlNifEnv* env,
int domain,
ERL_NIF_TERM localAddr,
SocketAddress* localP,
unsigned int* addrLenP)
{
unsigned int addrLen;
#ifdef HAVE_SYS_UN_H
ErlNifBinary bin;
if (domain != AF_UNIX)
return str_einval;
if (!GET_BIN(env, localAddr, &bin))
return str_einval;
if ((bin.size +
#ifdef __linux__
/* Make sure the address gets zero terminated
* except when the first byte is \0 because then it is
* sort of zero terminated although the zero termination
* comes before the address...
* This fix handles Linux's nonportable
* abstract socket address extension.
*/
(bin.data[0] == '\0' ? 0 : 1)
#else
1
#endif
) > sizeof(localP->sal.sun_path))
return str_einval;
sys_memzero((char*)localP, sizeof(struct sockaddr_un));
localP->sal.sun_family = domain;
sys_memcpy(localP->sal.sun_path, bin.data, bin.size);
addrLen = offsetof(struct sockaddr_un, sun_path) + bin.size;
#ifndef NO_SA_LEN
localP->u.sal.sun_len = addrLen;
#endif
*addrLenP = addrLen;
return NULL;
#else // HAVE_SYS_UN_H
return str_eafnosupport;
#endif
}
/* Only for domain = INET and INET6
* The (local) address here is a two tuple:
* {Addr, Port}
* where
* Addr:
* - a tuple of size 4 (INET) or size 8 (INET6)
* - the atoms 'any' or 'loopback'
* Port:
* - the port number (int)
*
*/
static
char* decode_laddress_tuple(ErlNifEnv* env,
int domain,
ERL_NIF_TERM laddr,
SocketAddress* localP,
unsigned int* addrLenP)
{
const ERL_NIF_TERM* laddrt;
int laddrtSz;
int port;
/* First, get the tuple and verify its size (2) */
if (!GET_TUPLE(env, laddr, &laddrtSz, &laddrt))
return str_einval;
if (laddrtSz != 2)
return str_einval;
/* So far so good. The first element is either a tuple or an atom */
if (IS_TUPLE(env, laddrt[0]) &&
IS_NUM(env, laddrt[1])) {
/* We handle two different tuples:
* - size 4 (INET)
* - size 8 (INET6)
*/
const ERL_NIF_TERM* addrt;
int addrtSz;
if (!GET_TUPLE(env, laddrt[0], &addrtSz, &addrt))
return str_einval; // PLACEHOLDER
if (!GET_INT(env, laddrt[1], &port))
return str_einval; // PLACEHOLDER
switch (domain) {
case AF_INET:
if (addrtSz != 4)
return str_einval;
break;
#if defined(HAVE_IN6) && defined(AF_INET6)
case AF_INET6:
if (addrtSz != 8)
return str_einval;
break;
#endif
default:
return str_eafnosupport;
break;
}
return decode_address_tuple(env,
domain, addrt, port,
localP, addrLenP);
} else if (IS_ATOM(env, laddrt[0]) &&
IS_NUM(env, laddrt[1])) {
/* There are only two atoms we handle:
* - any
* - loopback
*/
unsigned int len;
char a[16]; // Just in case...
if (!(GET_ATOM_LEN(env, laddrt[0], &len) &&
(len > 0) &&
(len <= (sizeof("loopback")))))
return str_einval;
if (!GET_ATOM(env, laddrt[0], a, sizeof(a)))
return str_einval;
return decode_address_atom(env,
domain, a, len, port,
localP, addrLenP);
} else {
return str_einval;
}
}
/* ----------------------------------------------------------------------
* nif_connect
*
* Description:
* Initiate a connection on a socket
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* Addr - Address of "remote" host.
* A tuple of size 4 or 8 (depending on domain)
* Port - Port number of "remote" host.
*/
static
ERL_NIF_TERM nif_connect(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
int addrSz;
const ERL_NIF_TERM* addr;
int port;
/* Extract arguments and perform preliminary validation */
if ((argc != 3) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP) ||
!GET_TUPLE(env, argv[1], &addrSz, &addr) ||
!GET_INT(env, argv[2], &port)) {
return enif_make_badarg(env);
}
switch (descP->domain) {
case AF_INET:
if (addrSz != 4)
return make_error(env, atom_einval);
break;
#if defined(HAVE_IN6) && defined(AF_INET6)
case AF_INET6:
if (addrSz != 8)
return make_error(env, atom_einval);
break;
#endif
default:
return make_error(env, atom_eafnosupport);
break;
} // switch (descP->domain)
return nconnect(env, descP, addr, port);
}
static
ERL_NIF_TERM nconnect(ErlNifEnv* env,
SocketDescriptor* descP,
const ERL_NIF_TERM* addr,
int port)
{
unsigned int addrLen;
int code;
char* xerr;
/* Verify that we are where in the proper state */
if (!IS_OPEN(descP))
return make_error(env, atom_exbadstate);
if (IS_CONNECTED(descP))
return make_error(env, atom_eisconn);
if (IS_CONNECTING(descP))
return make_error(env, atom_einval);
if ((xerr = decode_address_tuple(env,
descP->domain, addr, port,
&descP->remote, &addrLen)) != NULL)
return make_error1(env, xerr);
code = sock_connect(descP->sock,
(struct sockaddr*) &descP->remote, addrLen);
if (IS_SOCKET_ERROR(code) &&
((sock_errno() == ERRNO_BLOCK) || /* Winsock2 */
(sock_errno() == EINPROGRESS))) { /* Unix & OSE!! */
ERL_NIF_TERM ref = MKREF(env);
descP->state = SOCKET_STATE_CONNECTING;
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_WRITE),
descP, NULL, ref);
return make_ok2(env, ref);
} else if (code == 0) { /* ok we are connected */
descP->state = SOCKET_STATE_CONNECTED;
/* Do we need to do somthing for "active" mode?
* Is there even such a thing *here*?
*/
return atom_ok;
} else {
return make_error2(env, sock_errno());
}
}
/* ----------------------------------------------------------------------
* nif_finalize_connection
*
* Description:
* Make socket ready for input and output.
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
*/
static
ERL_NIF_TERM nif_finalize_connection(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
/* Extract arguments and perform preliminary validation */
if ((argc != 1) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP)) {
return enif_make_badarg(env);
}
return nfinalize_connection(env, descP);
}
/* *** nfinalize_connection ***
* Perform the final check to verify a connection.
*/
static
ERL_NIF_TERM nfinalize_connection(ErlNifEnv* env,
SocketDescriptor* descP)
{
int error;
if (descP->state != SOCKET_STATE_CONNECTING)
return make_error(env, atom_enotconn);
if (!verify_is_connected(descP, &error)) {
descP->state = SOCKET_STATE_OPEN; /* restore state */
return make_error2(env, error);
}
descP->state = SOCKET_STATE_CONNECTED;
return atom_ok;
}
/* *** verify_is_connected ***
* Check if a connection has been established.
*/
static
BOOLEAN_T verify_is_connected(SocketDescriptor* descP, int* err)
{
/*
* *** This is strange ***
*
* This *should* work on Windows NT too, but doesn't.
* An bug in Winsock 2.0 for Windows NT?
*
* See "Unix Netwok Programming", W.R.Stevens, p 412 for a
* discussion about Unix portability and non blocking connect.
*/
#ifndef SO_ERROR
int sz, code;
sz = sizeof(descP->remote);
sys_memzero((char *) &descP->remote, sz);
code = sock_peer(desc->sock,
(struct sockaddr*) &descP->remote, &sz);
if (IS_SOCKET_ERROR(code)) {
*err = sock_errno();
return FALSE;
}
#else
int error = 0; /* Has to be initiated, we check it */
unsigned int sz = sizeof(error); /* even if we get -1 */
int code = sock_getopt(descP->sock,
SOL_SOCKET, SO_ERROR,
(void *)&error, &sz);
if ((code < 0) || error) {
*err = error;
return FALSE;
}
#endif /* SO_ERROR */
*err = 0;
return TRUE;
}
/* ----------------------------------------------------------------------
* nif_listen
*
* Description:
* Listen for connections on a socket.
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* Backlog - The maximum length to which the queue of pending
* connections for socket may grow.
*/
static
ERL_NIF_TERM nif_listen(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
int backlog;
/* Extract arguments and perform preliminary validation */
if ((argc != 2) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP) ||
!GET_INT(env, argv[1], &backlog)) {
return enif_make_badarg(env);
}
return nlisten(env, descP, backlog);
}
static
ERL_NIF_TERM nlisten(ErlNifEnv* env,
SocketDescriptor* descP,
int backlog)
{
if (descP->state == SOCKET_STATE_CLOSED)
return make_error(env, atom_exbadstate);
if (!IS_OPEN(descP))
return make_error(env, atom_exbadstate);
if (IS_SOCKET_ERROR(sock_listen(descP->sock, backlog)))
return make_error2(env, sock_errno());
descP->state = SOCKET_STATE_LISTENING;
return atom_ok;
}
/* ----------------------------------------------------------------------
* nif_accept
*
* Description:
* Accept a connection on a socket.
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* Request ref - Unique "id" of this request
* (used for the select, if none is in queue).
*/
static
ERL_NIF_TERM nif_accept(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
ERL_NIF_TERM ref;
/* Extract arguments and perform preliminary validation */
if ((argc != 2) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP)) {
return enif_make_badarg(env);
}
ref = argv[1];
return naccept(env, descP, ref);
}
static
ERL_NIF_TERM naccept(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM ref)
{
ERL_NIF_TERM res;
switch (descP->state) {
case SOCKET_STATE_LISTENING:
MLOCK(descP->accMtx);
res = naccept_listening(env, descP, ref);
MUNLOCK(descP->accMtx);
break;
case SOCKET_STATE_ACCEPTING:
MLOCK(descP->accMtx);
res = naccept_accepting(env, descP, ref);
MUNLOCK(descP->accMtx);
break;
default:
res = make_error(env, atom_einval);
break;
}
return res;
}
/* *** naccept_listening ***
* We have no active acceptor and no acceptors in queue.
*/
static
ERL_NIF_TERM naccept_listening(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM ref)
{
SocketAddress remote;
unsigned int n;
SOCKET accSock;
HANDLE accEvent;
int save_errno;
ErlNifPid caller;
if (enif_self(env, &caller) == NULL)
return make_error(env, atom_exself);
n = sizeof(remote);
sys_memzero((char *) &remote, n);
accSock = sock_accept(descP->sock, (struct sockaddr*) &remote, &n);
if (accSock == INVALID_SOCKET) {
save_errno = sock_errno();
if (save_errno == ERRNO_BLOCK) {
/* *** Try again later *** */
descP->currentAcceptor.pid = caller;
if (MONP(env, descP,
&descP->currentAcceptor.pid,
&descP->currentAcceptor.mon) > 0)
return make_error(env, atom_exmon);
descP->currentAcceptor.ref = ref;
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_READ),
descP, NULL, ref);
/* Shall we really change state?
* The ready event is sent directly to the calling
* process, which simply calls this function again.
* Basically, state accepting means that we have
* an "outstanding" accept.
* Shall we store the pid of the calling process?
* And if someone else calls accept, return with ebusy?
* Can any process call accept or just the controlling
* process?
* We also need a monitor it case the calling process is
* called before we are done!
*
* Change state (to accepting) and store pid of the acceptor
* (current process). Only accept calls from the acceptor
* process (ebusy) and once we have a successful accept,
* change state back to listening. If cancel is called instead
* (only accepted from the acceptor process), we reset
* state to listening and also resets the pid to "null"
* (is there such a value?).
* Need a mutex to secure that we don't test and change the
* pid at the same time.
*/
descP->state = SOCKET_STATE_ACCEPTING;
return make_error(env, atom_eagain);
} else {
return make_error2(env, save_errno);
}
} else {
SocketDescriptor* accDescP;
ERL_NIF_TERM accRef;
/*
* We got one
*/
if ((accEvent = sock_create_event(accSock)) == INVALID_EVENT) {
save_errno = sock_errno();
while ((sock_close(accSock) == INVALID_SOCKET) &&
(sock_errno() == EINTR));
return make_error2(env, save_errno);
}
if ((accDescP = alloc_descriptor(accSock, accEvent)) == NULL) {
sock_close(accSock);
return enif_make_badarg(env);
}
accDescP->domain = descP->domain;
accDescP->type = descP->type;
accDescP->protocol = descP->protocol;
accRef = enif_make_resource(env, accDescP);
enif_release_resource(accDescP); // We should really store a reference ...
accDescP->ctrlPid = caller;
if (MONP(env, accDescP,
&accDescP->ctrlPid,
&accDescP->ctrlMon) > 0) {
sock_close(accSock);
return make_error(env, atom_exmon);
}
accDescP->remote = remote;
SET_NONBLOCKING(accDescP->sock);
#ifdef __WIN32__
/* See 'What is the point of this?' above */
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_READ),
descP, NULL, atom_undefined);
#endif
accDescP->state = SOCKET_STATE_CONNECTED;
return make_ok2(env, accRef);
}
}
/* *** naccept_accepting ***
* We have an active acceptor and possibly acceptors waiting in queue.
* At the moment the queue is *not* implemented.
*/
static
ERL_NIF_TERM naccept_accepting(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM ref)
{
SocketAddress remote;
unsigned int n;
SOCKET accSock;
HANDLE accEvent;
ErlNifPid caller;
int save_errno;
if (enif_self(env, &caller) == NULL)
return make_error(env, atom_exself);
if (compare_pids(env, &descP->currentAcceptor.pid, &caller) != 0) {
/* This will have to do until we implement the queue.
* When we have the queue, we should simply push this request,
* and instead return with eagain (the caller will then wait
* for the select message).
*/
return make_error(env, atom_exbusy);
}
n = sizeof(descP->remote);
sys_memzero((char *) &remote, n);
accSock = sock_accept(descP->sock, (struct sockaddr*) &remote, &n);
if (accSock == INVALID_SOCKET) {
save_errno = sock_errno();
if (save_errno == ERRNO_BLOCK) {
/*
* Just try again, no real error, just a ghost trigger from poll,
*/
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_READ),
descP, NULL, ref);
return make_error(env, atom_eagain);
} else {
return make_error2(env, save_errno);
}
} else {
SocketDescriptor* accDescP;
ERL_NIF_TERM accRef;
/*
* We got one
*/
if ((accEvent = sock_create_event(accSock)) == INVALID_EVENT) {
save_errno = sock_errno();
while ((sock_close(accSock) == INVALID_SOCKET) &&
(sock_errno() == EINTR));
return make_error2(env, save_errno);
}
if ((accDescP = alloc_descriptor(accSock, accEvent)) == NULL) {
sock_close(accSock);
return enif_make_badarg(env);
}
accDescP->domain = descP->domain;
accDescP->type = descP->type;
accDescP->protocol = descP->protocol;
accRef = enif_make_resource(env, accDescP);
enif_release_resource(accDescP); // We should really store a reference ...
accDescP->ctrlPid = caller;
if (MONP(env, accDescP,
&accDescP->ctrlPid,
&accDescP->ctrlMon) > 0) {
sock_close(accSock);
return make_error(env, atom_exmon);
}
accDescP->remote = remote;
SET_NONBLOCKING(accDescP->sock);
#ifdef __WIN32__
/* See 'What is the point of this?' above */
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_READ),
descP, NULL, atom_undefined);
#endif
accDescP->state = SOCKET_STATE_CONNECTED;
/* Here we should have the test if we have something in the queue.
* And if so, pop it and copy the (waiting) acceptor, and then
* make a new select with that info).
*/
descP->state = SOCKET_STATE_LISTENING;
return make_ok2(env, accRef);
}
}
/* ----------------------------------------------------------------------
* nif_send
*
* Description:
* Send a message on a socket
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* SendRef - A unique id for this (send) request.
* Data - The data to send in the form of a IOVec.
* Flags - Send flags.
*/
static
ERL_NIF_TERM nif_send(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
ERL_NIF_TERM sendRef;
ErlNifBinary data;
unsigned int eflags;
int flags;
ERL_NIF_TERM res;
/* Extract arguments and perform preliminary validation */
if ((argc != 4) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP) ||
!GET_BIN(env, argv[2], &data) ||
!GET_UINT(env, argv[3], &eflags)) {
return enif_make_badarg(env);
}
sendRef = argv[1];
if (!IS_CONNECTED(descP))
return make_error(env, atom_enotconn);
if (!esendflags2sendflags(eflags, &flags))
return enif_make_badarg(env);
MLOCK(descP->writeMtx);
/* We need to handle the case when another process tries
* to write at the same time.
* If the current write could not write its entire package
* this time (resulting in an select). The write of the
* other process must be made to wait until current
* is done!
* Basically, we need a write queue!
*
* A 'writing' field (boolean), which is set if we did
* not manage to write the entire message and reset every
* time we do.
*/
res = nsend(env, descP, sendRef, &data, flags);
MUNLOCK(descP->writeMtx);
return res;
}
/* What do we do when another process tries to write
* when the current writer has a select already waiting?
* Queue it? And what about simultaneous read and write?
* Queue up all operations towards the socket?
*
* We (may) need a currentOp field and an ops queue field.
*/
static
ERL_NIF_TERM nsend(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM sendRef,
ErlNifBinary* dataP,
int flags)
{
ssize_t written;
if (!descP->isWritable)
return enif_make_badarg(env);
/* We ignore the wrap for the moment.
* Maybe we should issue a wrap-message to controlling process...
*/
cnt_inc(&descP->writeTries, 1);
written = sock_send(descP->sock, dataP->data, dataP->size, flags);
return send_check_result(env, descP, written, dataP->size, sendRef);
}
/* ----------------------------------------------------------------------
* nif_sendto
*
* Description:
* Send a message on a socket
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* SendRef - A unique id for this (send) request.
* Data - The data to send in the form of a IOVec.
* Flags - Send flags.
* DestAddr - Destination address.
* DestPort - Destination Port.
*/
static
ERL_NIF_TERM nif_sendto(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
ERL_NIF_TERM sendRef;
ErlNifBinary data;
unsigned int eflags;
int flags;
ERL_NIF_TERM addr;
int port;
SocketAddress remoteAddr;
SocketAddress* remoteAddrP = &remoteAddr;
unsigned int remoteAddrLen;
char* xerr;
// ERL_NIF_TERM res;
/* Extract arguments and perform preliminary validation */
if ((argc != 6) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP) ||
!GET_BIN(env, argv[2], &data) ||
!GET_UINT(env, argv[3], &eflags) ||
!GET_INT(env, argv[5], &port)) {
return enif_make_badarg(env);
}
sendRef = argv[1];
addr = argv[4];
/* THIS TEST IS NOT CORRECT!!! */
if (!IS_OPEN(descP))
return make_error(env, atom_einval);
if (!esendflags2sendflags(eflags, &flags))
return enif_make_badarg(env);
if ((xerr = decode_send_addr(env, descP->domain,
addr, port,
&remoteAddrP,
&remoteAddrLen)) != NULL)
return make_error1(env, xerr);
return nsendto(env, descP, sendRef, &data, flags, remoteAddrP, remoteAddrLen);
}
static
ERL_NIF_TERM nsendto(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM sendRef,
ErlNifBinary* dataP,
int flags,
SocketAddress* toAddrP,
unsigned int toAddrLen)
{
ssize_t written;
if (!descP->isWritable)
return enif_make_badarg(env);
/* We ignore the wrap for the moment.
* Maybe we should issue a wrap-message to controlling process...
*/
cnt_inc(&descP->writeTries, 1);
if (toAddrP != NULL) {
written = sock_sendto(descP->sock,
dataP->data, dataP->size, flags,
&toAddrP->sa, toAddrLen);
} else {
written = sock_sendto(descP->sock,
dataP->data, dataP->size, flags,
NULL, 0);
}
return send_check_result(env, descP, written, dataP->size, sendRef);
}
/* ----------------------------------------------------------------------
* nif_writev / nif_sendv
*
* Description:
* Send a message (vector) on a socket
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* SendRef - A unique id for this (send) request.
* Data - A vector of binaries
* Flags - Send flags.
*/
#ifdef FOBAR
static
ERL_NIF_TERM nwritev(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM sendRef,
ERL_NIF_TERM data)
{
ERL_NIF_TERM tail;
ErlNifIOVec vec;
ErlNifIOVec* iovec = &vec;
SysIOVec* sysiovec;
int save_errno;
int iovcnt, n;
if (!enif_inspect_iovec(env, MAX_VSZ, data, &tail, &iovec))
return enif_make_badarg(env);
if (enif_ioq_size(descP->outQ) > 0) {
/* If the I/O queue contains data we enqueue the iovec
* and then peek the data to write out of the queue.
*/
if (!enif_ioq_enqv(q, iovec, 0))
return -3;
sysiovec = enif_ioq_peek(descP->outQ, &iovcnt);
} else {
/* If the I/O queue is empty we skip the trip through it. */
iovcnt = iovec->iovcnt;
sysiovec = iovec->iov;
}
/* Attempt to write the data */
n = writev(fd, sysiovec, iovcnt);
saved_errno = errno;
if (enif_ioq_size(descP->outQ) == 0) {
/* If the I/O queue was initially empty we enqueue any
remaining data into the queue for writing later. */
if (n >= 0 && !enif_ioq_enqv(descP->outQ, iovec, n))
return -3;
} else {
/* Dequeue any data that was written from the queue. */
if (n > 0 && !enif_ioq_deq(descP->outQ, n, NULL))
return -4;
}
/* return n, which is either number of bytes written or -1 if
some error happened */
errno = saved_errno;
return n;
}
#endif
/* ----------------------------------------------------------------------
* nif_recv
*
* Description:
* Receive a message on a socket.
* Normally used only on a connected socket!
* If we are trying to read > 0 bytes, then that is what we do.
* But if we have specified 0 bytes, then we want to read
* whatever is in the buffers (everything it got).
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* RecvRef - A unique id for this (send) request.
* Length - The number of bytes to receive.
* Flags - Receive flags.
*/
static
ERL_NIF_TERM nif_recv(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
ERL_NIF_TERM recvRef;
int len;
unsigned int eflags;
int flags;
ERL_NIF_TERM res;
if ((argc != 4) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP) ||
!GET_INT(env, argv[2], &len) ||
!GET_UINT(env, argv[3], &eflags)) {
return enif_make_badarg(env);
}
recvRef = argv[1];
if (!IS_CONNECTED(descP))
return make_error(env, atom_enotconn);
if (!erecvflags2recvflags(eflags, &flags))
return enif_make_badarg(env);
MLOCK(descP->readMtx);
/* We need to handle the case when another process tries
* to receive at the same time.
* If the current recv could not read its entire package
* this time (resulting in an select). The read of the
* other process must be made to wait until current
* is done!
* Basically, we need a read queue!
*
* A 'reading' field (boolean), which is set if we did
* not manage to read the entire message and reset every
* time we do.
*/
res = nrecv(env, descP, recvRef, len, flags);
MUNLOCK(descP->readMtx);
return res;
}
/* The (read) buffer handling *must* be optimized!
* But for now we make it easy for ourselves by
* allocating a binary (of the specified or default
* size) and then throwing it away...
*/
static
ERL_NIF_TERM nrecv(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM recvRef,
int len,
int flags)
{
ssize_t read;
ErlNifBinary buf;
if (!descP->isReadable)
return enif_make_badarg(env);
/* Allocate a buffer:
* Either as much as we want to read or (if zero (0)) use the "default"
* size (what has been configured).
*/
if (!ALLOC_BIN((len ? len : descP->rBufSz), &buf))
return make_error(env, atom_exalloc);
/* We ignore the wrap for the moment.
* Maybe we should issue a wrap-message to controlling process...
*/
cnt_inc(&descP->readTries, 1);
read = sock_recv(descP->sock, buf.data, buf.size, flags);
return recv_check_result(env, descP,
read, len,
&buf,
recvRef);
}
/* ----------------------------------------------------------------------
* nif_recvfrom
*
* Description:
* Receive a message on a socket.
* Normally used only on a (un-) connected socket!
* If a buffer size = 0 is specified, then the we will use the default
* buffer size for this socket (whatever has been configured).
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
* RecvRef - A unique id for this (send) request.
* BufSz - Size of the buffer into which we put the received message.
* Flags - Receive flags.
*/
static
ERL_NIF_TERM nif_recvfrom(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
ERL_NIF_TERM recvRef;
unsigned int bufSz;
unsigned int eflags;
int flags;
ERL_NIF_TERM res;
if ((argc != 4) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP) ||
!GET_UINT(env, argv[2], &bufSz) ||
!GET_UINT(env, argv[3], &eflags)) {
return enif_make_badarg(env);
}
recvRef = argv[1];
/* if (IS_OPEN(descP)) */
/* return make_error(env, atom_enotconn); */
if (!erecvflags2recvflags(eflags, &flags))
return enif_make_badarg(env);
MLOCK(descP->readMtx);
/* <KOLLA>
* We need to handle the case when another process tries
* to receive at the same time.
* If the current recv could not read its entire package
* this time (resulting in an select). The read of the
* other process must be made to wait until current
* is done!
* Basically, we need a read queue!
*
* A 'reading' field (boolean), which is set if we did
* not manage to read the entire message and reset every
* time we do.
* </KOLLA>
*/
res = nrecvfrom(env, descP, recvRef, bufSz, flags);
MUNLOCK(descP->readMtx);
return res;
}
/* The (read) buffer handling *must* be optimized!
* But for now we make it easy for ourselves by
* allocating a binary (of the specified or default
* size) and then throwing it away...
*/
static
ERL_NIF_TERM nrecvfrom(ErlNifEnv* env,
SocketDescriptor* descP,
ERL_NIF_TERM recvRef,
uint16_t bufSz,
int flags)
{
SocketAddress fromAddr;
unsigned int addrLen;
ssize_t read;
ErlNifBinary buf;
if (!descP->isReadable)
return enif_make_badarg(env);
/* Allocate a buffer:
* Either as much as we want to read or (if zero (0)) use the "default"
* size (what has been configured).
*/
if (!ALLOC_BIN((bufSz ? bufSz : descP->rBufSz), &buf))
return make_error(env, atom_exalloc);
/* We ignore the wrap for the moment.
* Maybe we should issue a wrap-message to controlling process...
*/
cnt_inc(&descP->readTries, 1);
addrLen = sizeof(fromAddr);
sys_memzero((char*) &fromAddr, addrLen);
read = sock_recvfrom(descP->sock, buf.data, buf.size, flags,
&fromAddr.sa, &addrLen);
return recvfrom_check_result(env, descP,
read,
&buf,
&fromAddr, addrLen,
recvRef);
}
/* ----------------------------------------------------------------------
* nif_close
*
* Description:
* Close a (socket) file descriptor.
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
*/
static
ERL_NIF_TERM nif_close(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
if ((argc != 1) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP)) {
return enif_make_badarg(env);
}
return nclose(env, descP);
}
static
ERL_NIF_TERM nclose(ErlNifEnv* env,
SocketDescriptor* descP)
{
ERL_NIF_TERM reply, reason;
BOOLEAN_T doClose;
int selectRes;
MLOCK(descP->closeMtx);
if (descP->state == SOCKET_STATE_CLOSED) {
reason = atom_closed;
doClose = FALSE;
} else if (descP->state == SOCKET_STATE_CLOSING) {
reason = atom_closing;
doClose = FALSE;
} else {
/* Store the PID of the caller,
* since we need to inform it when we
* (that is, the stop callback function)
* completes.
*/
if (enif_self(env, &descP->closerPid) == NULL) {
MUNLOCK(descP->closeMtx);
return make_error(env, atom_exself);
}
/* Monitor the caller, since we should complete this operation even if
* the caller dies (for whatever reason).
*/
if (MONP(env, descP,
&descP->closerPid,
&descP->closerMon) > 0) {
MUNLOCK(descP->closeMtx);
return make_error(env, atom_exmon);
}
descP->closeLocal = TRUE;
descP->state = SOCKET_STATE_CLOSING;
doClose = TRUE;
}
MUNLOCK(descP->closeMtx);
if (doClose) {
descP->closeRef = MKREF(env);
selectRes = enif_select(env, descP->sock, (ERL_NIF_SELECT_STOP),
descP, NULL, descP->closeRef);
if (selectRes & ERL_NIF_SELECT_STOP_CALLED) {
/* Prep done - inform the caller it can finalize (close) directly */
reply = atom_ok;
} else if (selectRes & ERL_NIF_SELECT_STOP_SCHEDULED) {
/* The stop callback function has been *scheduled* which means that we
* have to wait for it to complete. */
reply = make_ok2(env, descP->closeRef);
} else {
/* <KOLLA>
*
* WE SHOULD REALLY HAVE A WAY TO CLOBBER THE SOCKET,
* SO WE DON'T LET STUFF LEAK.
* NOW, BECAUSE WE FAILED TO SELECT, WE CANNOT FINISH
* THE CLOSE, WHAT TO DO? ABORT?
*
* </KOLLA>
*/
reason = MKT2(env, atom_select, MKI(env, selectRes));
reply = make_error(env, reason);
}
} else {
reply = make_error(env, reason);
}
return reply;
}
/* ----------------------------------------------------------------------
* nif_finalize_close
*
* Description:
* Perform the actual socket close!
* Note that this function is executed in a dirfty scheduler.
*
* Arguments:
* Socket (ref) - Points to the socket descriptor.
*/
static
ERL_NIF_TERM nif_finalize_close(ErlNifEnv* env,
int argc,
const ERL_NIF_TERM argv[])
{
SocketDescriptor* descP;
/* Extract arguments and perform preliminary validation */
if ((argc != 1) ||
!enif_get_resource(env, argv[0], sockets, (void**) &descP)) {
return enif_make_badarg(env);
}
return nfinalize_close(env, descP);
}
/* *** nfinalize_close ***
* Perform the final step in the socket close.
*/
static
ERL_NIF_TERM nfinalize_close(ErlNifEnv* env,
SocketDescriptor* descP)
{
ERL_NIF_TERM reply;
if (descP->state == SOCKET_STATE_CLOSED)
return atom_ok;
if (descP->state != SOCKET_STATE_CLOSING)
return make_error(env, atom_enotclosing);
/* This nif is executed in a dirty scheduler just so that
* it can "hang" (whith minumum effect on the VM) while the
* kernel writes our buffers. IF we have set the linger option
* for this ({true, integer() > 0}). For this to work we must
* be blocking...
*/
SET_BLOCKING(descP->sock);
if (sock_close(descP->sock) != 0) {
int save_errno = sock_errno();
if (save_errno != ERRNO_BLOCK) {
/* Not all data in the buffers where sent,
* make sure the caller gets this.
*/
reply = make_error(env, atom_timeout);
} else {
reply = make_error2(env, save_errno);
}
} else {
reply = atom_ok;
}
sock_close_event(descP->event);
descP->sock = INVALID_SOCKET;
descP->event = INVALID_EVENT;
descP->state = SOCKET_STATE_CLOSED;
return reply;
}
/* ----------------------------------------------------------------------
* U t i l i t y F u n c t i o n s
* ----------------------------------------------------------------------
*/
static
ERL_NIF_TERM send_check_result(ErlNifEnv* env,
SocketDescriptor* descP,
ssize_t written,
ssize_t dataSize,
ERL_NIF_TERM sendRef)
{
if (written == dataSize) {
cnt_inc(&descP->writePkgCnt, 1);
cnt_inc(&descP->writeByteCnt, written);
return atom_ok;
} else if (written < 0) {
/* Ouch, check what kind of failure */
int save_errno = sock_errno();
if ((save_errno != EAGAIN) &&
(save_errno != EINTR)) {
cnt_inc(&descP->writeFails, 1);
return make_error2(env, save_errno);
} else {
/* Ok, try again later */
/* <KOLLA>
* SHOULD RESULT IN {error, eagain}!!!!
* </KOLLA>
*/
written = 0;
}
}
/* We failed to write the *entire* packet (anything less then size
* of the packet, which is 0 <= written < sizeof packet),
* so schedule the rest for later.
*/
cnt_inc(&descP->writeWaits, 1);
SELECT(env, descP->sock, (ERL_NIF_SELECT_WRITE),
descP, NULL, sendRef);
return make_ok2(env, enif_make_int(env, written));
}
static
ERL_NIF_TERM recv_check_result(ErlNifEnv* env,
SocketDescriptor* descP,
int read,
int toRead,
ErlNifBinary* bufP,
ERL_NIF_TERM recvRef)
{
ERL_NIF_TERM data;
/* There is a special case: If the provided 'to read' value is
* zero (0). That means that we reads as much as we can, using
* the default read buffer size.
*/
if (bufP->size == read) {
/* +++ We filled the buffer +++ */
if (toRead == 0) {
/* +++ Give us everything you have got => needs to continue +++ */
/* How do we do this?
* Either:
* 1) Send up each chunk of data for each of the read
* and let the erlang code assemble it: {ok, false, Bin}
* (when complete it should return {ok, true, Bin}).
* We need to read atleast one more time to be sure if its
* done...
* 2) Or put it in a buffer here, and then let the erlang code
* know that it should call again (special return value)
* (continuous binary realloc "here").
*
* => We choose alt 1 for now.
*/
data = MKBIN(env, bufP);
return make_ok3(env, atom_false, data);
} else {
/* +++ We got exactly as much as we requested +++ */
/* <KOLLA>
* WE NEED TO INFORM ANY WAITING READERS
* </KOLLA>
*/
data = MKBIN(env, bufP);
return make_ok3(env, atom_true, data);
}
} else if (read < 0) {
/* +++ Error handling +++ */
int save_errno = sock_errno();
if (save_errno == ECONNRESET) {
/* +++ Oups - closed +++ */
/* <KOLLA>
*
* IF THE CURRENT PROCESS IS *NOT* THE CONTROLLING
* PROCESS, WE NEED TO INFORM IT!!!
*
* ALL WAITING PROCESSES MUST ALSO GET THE ERROR!!
* HANDLED BY THE STOP (CALLBACK) FUNCTION?
*
* SINCE THIS IS A REMOTE CLOSE, WE DON'T NEED TO WAIT
* FOR OUTPUT TO BE WRITTEN (NO ONE WILL READ), JUST
* ABORT THE SOCKET REGARDLESS OF LINGER???
*
* </KOLLA>
*/
descP->closeLocal = FALSE;
descP->state = SOCKET_STATE_CLOSING;
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_STOP),
descP, NULL, recvRef);
return make_error(env, atom_closed);
} else if ((save_errno == ERRNO_BLOCK) ||
(save_errno == EAGAIN)) {
return make_error(env, atom_eagain);
} else {
return make_error2(env, save_errno);
}
} else {
/* +++ We did not fill the buffer +++ */
if (toRead == 0) {
/* +++ We got a chunk of data but +++
* +++ since we did not fill the +++
* +++ buffer, we must split it +++
* +++ into a sub-binary. +++
*/
data = MKBIN(env, bufP);
data = MKSBIN(env, data, 0, read);
return make_ok3(env, atom_true, data);
} else {
/* +++ We got only a part of what was expected +++
* +++ => receive more later. +++ */
return make_ok3(env, atom_false, MKBIN(env, bufP));
}
}
}
/* The recvfrom function delivers one (1) message. If our buffer
* is to small, the message will be truncated. So, regardless
* if we filled the buffer or not, we have got what we are going
* to get regarding this message.
*/
static
ERL_NIF_TERM recvfrom_check_result(ErlNifEnv* env,
SocketDescriptor* descP,
int read,
ErlNifBinary* bufP,
SocketAddress* fromAddrP,
unsigned int fromAddrLen,
ERL_NIF_TERM recvRef)
{
ERL_NIF_TERM data;
/* There is a special case: If the provided 'to read' value is
* zero (0). That means that we reads as much as we can, using
* the default read buffer size.
*/
if (read < 0) {
/* +++ Error handling +++ */
int save_errno = sock_errno();
if (save_errno == ECONNRESET) {
/* +++ Oups - closed +++ */
/* <KOLLA>
* IF THE CURRENT PROCESS IS *NOT* THE CONTROLLING
* PROCESS, WE NEED TO INFORM IT!!!
*
* ALL WAITING PROCESSES MUST ALSO GET THE ERROR!!
*
* </KOLLA>
*/
descP->closeLocal = FALSE;
descP->state = SOCKET_STATE_CLOSING;
SELECT(env,
descP->sock,
(ERL_NIF_SELECT_STOP),
descP, NULL, recvRef);
return make_error(env, atom_closed);
} else if ((save_errno == ERRNO_BLOCK) ||
(save_errno == EAGAIN)) {
return make_error(env, atom_eagain);
} else {
return make_error2(env, save_errno);
}
} else {
/* +++ We sucessfully got a message - time to encode the address +++ */
ERL_NIF_TERM fromDomainT, fromSourceT;
encode_address(env,
fromAddrP, fromAddrLen,
&fromDomainT, &fromSourceT);
if (read == bufP->size) {
data = MKBIN(env, bufP);
} else {
/* +++ We got a chunk of data but +++
* +++ since we did not fill the +++
* +++ buffer, we must split it +++
* +++ into a sub-binary. +++
*/
data = MKBIN(env, bufP);
data = MKSBIN(env, data, 0, read);
}
return make_ok2(env, MKT3(env, fromDomainT, fromSourceT, data));
}
}
/* *** decode_send_addr ***
*
* The rather odd thing about the 'toAddrP' (the **) is
* because we need to be able to return a NULL pointer,
* in the case of the dest address is the atom 'null'.
* Its possible to call the sendto function with the
* args NULL (address) and 0 (port number).
*
* This function whouls really have a char* return value
* type!!
*/
static
char* decode_send_addr(ErlNifEnv* env,
int domain,
ERL_NIF_TERM addr,
int port,
SocketAddress** toAddrP,
unsigned int* toAddrLenP)
{
if (IS_ATOM(env, addr)) {
unsigned int len;
char a[16]; // Just in case...
/* The only acceptable value is the atom 'null' */
if (!(GET_ATOM_LEN(env, addr, &len) &&
(len > 0) &&
(len <= (sizeof("null")))))
return str_einval;
if (!GET_ATOM(env, addr, a, sizeof(a)))
return str_einval;
*toAddrP = NULL;
if (strncmp(a, "null", len) == 0)
return NULL;
else
return str_einval;
} else if (IS_TUPLE(env, addr)) {
/* We now know that the we have a proper address. */
return decode_send_addr_tuple(env, domain, addr, port,
*toAddrP, toAddrLenP);
} else {
return str_einval;
}
}
static
char* decode_send_addr_tuple(ErlNifEnv* env,
int domain,
ERL_NIF_TERM addr,
int port,
SocketAddress* toAddrP,
unsigned int* toAddrLenP)
{
/* We handle two different tuples:
* - size 4 (INET)
* - size 8 (INET6)
*/
const ERL_NIF_TERM* addrt;
int addrtSz;
if (!GET_TUPLE(env, addr, &addrtSz, &addrt))
return str_einval; // PLACEHOLDER
switch (domain) {
case AF_INET:
if (addrtSz != 4)
return str_einval;
break;
#if defined(HAVE_IN6) && defined(AF_INET6)
case AF_INET6:
if (addrtSz != 8)
return str_einval;
break;
#endif
default:
return str_eafnosupport;
break;
}
return decode_address_tuple(env, domain,
addrt, port,
toAddrP, toAddrLenP);
}
/* Decode the 4- or 8-element address tuple
* and initiate the socket address structure.
*/
static
char* decode_address_tuple(ErlNifEnv* env,
int domain,
const ERL_NIF_TERM* addrt,
int port,
SocketAddress* addrP,
unsigned int* addrLenP)
{
/* We now *know* that the size of the tuple is correct,
* so we don't need to check anything here, just unpack.
*/
switch (domain) {
case AF_INET:
{
int a, v;
char laddr[4];
sys_memzero((char*)addrP, sizeof(struct sockaddr_in));
#ifndef NO_SA_LEN
addrP->sai.sin_len = sizeof(struct sockaddr_in);
#endif
addrP->sai.sin_family = domain;
addrP->sai.sin_port = sock_htons(port);
for (a = 0; a < 4; a++) {
if (!GET_INT(env, addrt[a], &v))
return str_einval;
laddr[a] = v;
}
sys_memcpy(&addrP->sai.sin_addr, &laddr, sizeof(laddr));
*addrLenP = sizeof(struct sockaddr_in);
return NULL;
}
break;
#if defined(HAVE_IN6) && defined(AF_INET6)
case AF_INET6:
{
int a, v;
char laddr[16];
sys_memzero((char*)addrP, sizeof(struct sockaddr_in6));
#ifndef NO_SA_LEN
addrP->sai6.sin6_len = sizeof(struct sockaddr_in6);
#endif
addrP->sai6.sin6_family = domain;
addrP->sai6.sin6_port = sock_htons(port);
addrP->sai6.sin6_flowinfo = 0;
/* The address tuple is of size 8
* and each element is a two byte integer
*/
for (a = 0; a < 8; a++) {
if (!GET_INT(env, addrt[a], &v))
return str_einval;
laddr[a*2 ] = ((v >> 8) & 0xFF);
laddr[a*2+1] = (v & 0xFF);
}
sys_memcpy(&addrP->sai6.sin6_addr, &laddr, sizeof(laddr));
*addrLenP = sizeof(struct sockaddr_in6);
return NULL;
}
break;
#endif
} /* switch (domain) */
return str_eafnosupport;
}
/* Encode the 4- or 8-element address tuple from the socket address structure.
*
* This function is called when we have received a message. So, if we for some
* reason fail to decode the address or parts of it, it makes more sense to
* return with "undefined" for the values rather then fail completely (and not
* deliver the received message).
*
* Returns two things (assuming the encode works):
*
* Domain: inet | inet6 | local
* Source: {Address, Port} | string()
*
*/
static
void encode_address(ErlNifEnv* env,
SocketAddress* addrP,
unsigned int addrLen,
ERL_NIF_TERM* domainT,
ERL_NIF_TERM* sourceT)
{
short port;
switch (addrP->sa.sa_family) {
/* +++ inet (IPv4) +++ */
case AF_INET:
if (addrLen >= sizeof(struct sockaddr_in)) {
ERL_NIF_TERM addrT, portT;
unsigned int i;
ERL_NIF_TERM at4[4];
char* a4 = (char*) &addrP->sai.sin_addr;
port = sock_ntohs(addrP->sai.sin_port);
for (i = 0; i < 4; i++) {
at4[i] = MKI(env, a4[i]);
}
*domainT = MKA(env, "inet"); // Shall we encode these? See decode
addrT = MKT4(env, at4[0], at4[1], at4[2], at4[3]);
portT = MKI(env, port);
*sourceT = MKT2(env, addrT, portT);
} else {
*domainT = atom_undefined;
*sourceT = atom_undefined;
}
break;
/* +++ inet6 (IPv6) +++ */
#if defined(HAVE_IN6) && defined(AF_INET6)
case AF_INET6:
if (addrLen >= sizeof(struct sockaddr_in6)) {
ERL_NIF_TERM addrT, portT;
unsigned int i;
ERL_NIF_TERM at6[8];
char* a16 = (char*) &addrP->sai6.sin6_addr;
port = sock_ntohs(addrP->sai6.sin6_port);
/* The address tuple is of size 8
* and each element is a two byte integer
*/
for (i = 0; i < 8; i++) {
// at6[i] = MKI(env, get_int16(a16[i*2]));
at6[i] = MKI(env, get_int16(a16 + i*2));
}
*domainT = MKA(env, "inet6"); // Shall we encode these? See decode
addrT = MKT8(env,
at6[0], at6[1], at6[2], at6[3],
at6[4], at6[5], at6[6], at6[7]);
portT = MKI(env, port);
*sourceT = MKT2(env, addrT, portT);
} else {
*domainT = atom_undefined;
*sourceT = atom_undefined;
}
break;
#endif
/* +++ local (Unix Domain Sockets) +++ */
#ifdef HAVE_SYS_UN_H
case AF_UNIX:
{
size_t n, m;
*domainT = MKA(env, "local");
if (addrLen < offsetof(struct sockaddr_un, sun_path)) {
*sourceT = atom_undefined;
} else {
n = addrLen - offsetof(struct sockaddr_un, sun_path);
if (255 < n) {
*sourceT = atom_undefined;
} else {
m = my_strnlen(addrP->sal.sun_path, n);
#ifdef __linux__
/* Assume that the address is a zero terminated string,
* except when the first byte is \0 i.e the string length is 0,
* then use the reported length instead.
* This fix handles Linux's nonportable
* abstract socket address extension.
*/
if (m == 0) {
m = n;
}
#endif
*sourceT = MKSL(env, addrP->sal.sun_path, m);
}
}
}
break;
#endif
default:
*domainT = atom_undefined;
*sourceT = atom_undefined;
break;
} /* switch (addrP->sa.sa_family) */
}
/* Decode the address when its an atom.
* Currently we only accept two atoms: 'any' and 'loopback'
*/
static
char* decode_address_atom(ErlNifEnv* env,
int domain,
char* addr,
int addrLen,
int port,
SocketAddress* addrP,
unsigned int* addrLenP)
{
BOOLEAN_T any;
if (strncmp(addr, "any", addrLen) == 0) {
any = TRUE;
} if (strncmp(addr, "loopback", addrLen) == 0) {
any = FALSE;
} else {
return str_einval;
}
/* If we get this far, we *know* its either 'any' or 'loopback' */
switch (domain) {
case AF_INET:
{
struct in_addr addr;
if (any) {
addr.s_addr = sock_htonl(INADDR_ANY);
} else {
addr.s_addr = sock_htonl(INADDR_LOOPBACK);
}
sys_memzero((char*) addrP, sizeof(struct sockaddr_in));
#ifndef NO_SA_LEN
addrP->sai.sin_len = sizeof(struct sockaddr_in6);
#endif
addrP->sai.sin_family = domain;
addrP->sai.sin_port = sock_htons(port);
addrP->sai.sin_addr.s_addr = addr.s_addr;
*addrLenP = sizeof(struct sockaddr_in);
}
break;
#if defined(HAVE_IN6) && defined(AF_INET6)
case AF_INET6:
{
const struct in6_addr* paddr;
if (any) {
paddr = &in6addr_any;
} else {
paddr = &in6addr_loopback;
}
sys_memzero((char*)addrP, sizeof(struct sockaddr_in6));
#ifndef NO_SA_LEN
addrP->sai6.sin6_len = sizeof(struct sockaddr_in6);
#endif
addrP->sai6.sin6_family = domain;
addrP->sai6.sin6_port = sock_htons(port);
addrP->sai6.sin6_flowinfo = 0;
addrP->sai6.sin6_addr = *paddr;
*addrLenP = sizeof(struct sockaddr_in6);
}
break;
#endif
default:
return str_einval;
break;
}
return NULL;
}
/* *** alloc_descriptor ***
* Allocate and perform basic initialization of a socket descriptor.
*
*/
static
SocketDescriptor* alloc_descriptor(SOCKET sock, HANDLE event)
{
SocketDescriptor* descP;
if ((descP = enif_alloc_resource(sockets, sizeof(SocketDescriptor))) != NULL) {
char buf[64]; /* Buffer used for building the mutex name */
sprintf(buf, "socket[w,%d]", sock);
descP->writeMtx = MCREATE(buf);
descP->currentWriterP = NULL; // currentWriter not used
descP->writersQ.first = NULL;
descP->writersQ.last = NULL;
descP->isWritable = TRUE;
descP->writePkgCnt = 0;
descP->writeByteCnt = 0;
descP->writeTries = 0;
descP->writeWaits = 0;
descP->writeFails = 0;
sprintf(buf, "socket[r,%d]", sock);
descP->readMtx = MCREATE(buf);
descP->currentReaderP = NULL; // currentReader not used
descP->readersQ.first = NULL;
descP->readersQ.last = NULL;
descP->isReadable = TRUE;
descP->readPkgCnt = 0;
descP->readByteCnt = 0;
descP->readTries = 0;
descP->readWaits = 0;
sprintf(buf, "socket[acc,%d]", sock);
descP->accMtx = MCREATE(buf);
descP->currentAcceptorP = NULL; // currentAcceptor not used
descP->acceptorsQ.first = NULL;
descP->acceptorsQ.last = NULL;
sprintf(buf, "socket[close,%d]", sock);
descP->closeMtx = MCREATE(buf);
descP->rBufSz = SOCKET_RECV_BUFFER_SIZE_DEFAULT;
descP->iow = FALSE;
descP->dbg = SOCKET_DEBUG_DEFAULT;
descP->sock = sock;
descP->event = event;
}
return descP;
}
/* compare_pids - Test if two pids are equal
*
*/
static
int compare_pids(ErlNifEnv* env,
const ErlNifPid* pid1,
const ErlNifPid* pid2)
{
ERL_NIF_TERM p1 = enif_make_pid(env, pid1);
ERL_NIF_TERM p2 = enif_make_pid(env, pid2);
return enif_is_identical(p1, p2);
}
/* edomain2domain - convert internal (erlang) domain to (proper) domain
*
* Note that only a subset is supported.
*/
static
BOOLEAN_T edomain2domain(int edomain, int* domain)
{
switch (edomain) {
case SOCKET_DOMAIN_INET:
*domain = AF_INET;
break;
#if defined(HAVE_IN6) && defined(AF_INET6)
case SOCKET_DOMAIN_INET6:
*domain = AF_INET6;
break;
#endif
#ifdef HAVE_SYS_UN_H
case SOCKET_DOMAIN_LOCAL:
*domain = AF_UNIX;
break;
#endif
default:
return FALSE;
}
return TRUE;
}
/* etype2type - convert internal (erlang) type to (proper) type
*
* Note that only a subset is supported.
*/
static
BOOLEAN_T etype2type(int etype, int* type)
{
switch (etype) {
case SOCKET_TYPE_STREAM:
*type = SOCK_STREAM;
break;
case SOCKET_TYPE_DGRAM:
*type = SOCK_DGRAM;
break;
case SOCKET_TYPE_RAW:
*type = SOCK_RAW;
break;
case SOCKET_TYPE_SEQPACKET:
*type = SOCK_SEQPACKET;
break;
default:
return FALSE;
}
return TRUE;
}
/* eproto2proto - convert internal (erlang) protocol to (proper) protocol
*
* Note that only a subset is supported.
*/
static
BOOLEAN_T eproto2proto(int eproto, int* proto)
{
switch (eproto) {
case SOCKET_PROTOCOL_IP:
*proto = IPPROTO_IP;
break;
case SOCKET_PROTOCOL_TCP:
*proto = IPPROTO_TCP;
break;
case SOCKET_PROTOCOL_UDP:
*proto = IPPROTO_UDP;
break;
case SOCKET_PROTOCOL_SCTP:
*proto = IPPROTO_SCTP;
break;
default:
return FALSE;
}
return TRUE;
}
#ifdef HAVE_SETNS
/* emap2netns - extract the netns field from the extra map
*
* Note that currently we only support one extra option, the netns.
*/
static
BOOLEAN_T emap2netns(ErlNifEnv* env, ERL_NIF_TERM map, char** netns)
{
size_t sz;
ERL_NIF_TERM key;
ERL_NIF_TERM value;
unsigned int len;
char* buf;
int written;
/* Note that its acceptable that the extra map is empty */
if (!enif_get_map_size(env, map, &sz) ||
(sz != 1)) {
*netns = NULL;
return TRUE;
}
/* The currently only supported extra option is: netns */
key = enif_make_atom(env, "netns");
if (!enif_get_map_value(env, map, key, &value)) {
*netns = NULL; // Just in case...
return FALSE;
}
/* So far so good. The value should be a string, check. */
if (!enif_is_list(env, value)) {
*netns = NULL; // Just in case...
return FALSE;
}
if (!enif_get_list_length(env, value, &len)) {
*netns = NULL; // Just in case...
return FALSE;
}
if ((buf = MALLOC(len+1)) == NULL) {
*netns = NULL; // Just in case...
return FALSE;
}
written = enif_get_string(env, value, buf, len+1, ERL_NIF_LATIN1);
if (written == (len+1)) {
*netns = buf;
return TRUE;
} else {
*netns = NULL; // Just in case...
return FALSE;
}
}
#endif
/* esendflags2sendflags - convert internal (erlang) send flags to (proper)
* send flags.
*/
static
BOOLEAN_T esendflags2sendflags(unsigned int esendflags, int* sendflags)
{
unsigned int ef;
int tmp = 0;
for (ef = SOCKET_SEND_FLAG_LOW; ef <= SOCKET_SEND_FLAG_HIGH; ef++) {
switch (ef) {
case SOCKET_SEND_FLAG_CONFIRM:
tmp |= MSG_CONFIRM;
break;
case SOCKET_SEND_FLAG_DONTROUTE:
tmp |= MSG_DONTROUTE;
break;
case SOCKET_SEND_FLAG_EOR:
tmp |= MSG_EOR;
break;
case SOCKET_SEND_FLAG_MORE:
tmp |= MSG_MORE;
break;
case SOCKET_SEND_FLAG_NOSIGNAL:
tmp |= MSG_NOSIGNAL;
break;
case SOCKET_SEND_FLAG_OOB:
tmp |= MSG_OOB;
break;
default:
return FALSE;
}
}
*sendflags = tmp;
return TRUE;
}
/* erecvflags2recvflags - convert internal (erlang) send flags to (proper)
* send flags.
*/
static
BOOLEAN_T erecvflags2recvflags(unsigned int erecvflags, int* recvflags)
{
unsigned int ef;
int tmp = 0;
for (ef = SOCKET_RECV_FLAG_LOW; ef <= SOCKET_RECV_FLAG_HIGH; ef++) {
switch (ef) {
case SOCKET_RECV_FLAG_CMSG_CLOEXEC:
tmp |= MSG_CMSG_CLOEXEC;
break;
case SOCKET_RECV_FLAG_ERRQUEUE:
tmp |= MSG_ERRQUEUE;
break;
case SOCKET_RECV_FLAG_OOB:
tmp |= MSG_OOB;
break;
case SOCKET_RECV_FLAG_PEEK:
tmp |= MSG_PEEK;
break;
case SOCKET_RECV_FLAG_TRUNC:
tmp |= MSG_TRUNC;
break;
default:
return FALSE;
}
}
*recvflags = tmp;
return TRUE;
}
#if defined(HAVE_SYS_UN_H) || defined(SO_BINDTODEVICE)
/* strnlen doesn't exist everywhere */
static
size_t my_strnlen(const char *s, size_t maxlen)
{
size_t i = 0;
while (i < maxlen && s[i] != '\0')
i++;
return i;
}
#endif
/* Create an ok two (2) tuple in the form: {ok, Any}.
* The second element (Any) is already in the form of an
* ERL_NIF_TERM so all we have to do is create the tuple.
*/
static
ERL_NIF_TERM make_ok2(ErlNifEnv* env, ERL_NIF_TERM any)
{
return MKT2(env, atom_ok, any);
}
/* Create an ok three (3) tuple in the form: {ok, Val1, Val2}.
* The second (Val1) and third (Val2) elements are already in
* the form of an ERL_NIF_TERM so all we have to do is create
* the tuple.
*/
static
ERL_NIF_TERM make_ok3(ErlNifEnv* env, ERL_NIF_TERM val1, ERL_NIF_TERM val2)
{
return MKT3(env, atom_ok, val1, val2);
}
/* Create an error two (2) tuple in the form: {error, Reason}.
* The second element (Reason) is already in the form of an
* ERL_NIF_TERM so all we have to do is create the tuple.
*/
static
ERL_NIF_TERM make_error(ErlNifEnv* env, ERL_NIF_TERM reason)
{
return MKT2(env, atom_error, reason);
}
/* Create an error two (2) tuple in the form: {error, Reason}.
* The second element, Reason, is a string to be converted into
* an atom.
*/
static
ERL_NIF_TERM make_error1(ErlNifEnv* env, char* reason)
{
return make_error(env, MKA(env, reason));
}
/* Create an error two (2) tuple in the form: {error, Reason}.
* The second element, Reason, is the errno value in its
* basic form (integer) which will (eventually) be converted
* into an atom.
*/
static
ERL_NIF_TERM make_error2(ErlNifEnv* env, int err)
{
return make_error1(env, erl_errno_id(err));
}
/* Send an error closed message to the specified process:
*
* This message is for processes that are waiting in the
* erlang API functions for a select message.
*/
static
char* send_msg_error_closed(ErlNifEnv* env,
ErlNifPid* pid)
{
return send_msg_error(env, atom_closed, pid);
}
/* Send an error message to the specified process:
* A message in the form:
*
* {error, Reason}
*
* This message is for processes that are waiting in the
* erlang API functions for a select message.
*/
static
char* send_msg_error(ErlNifEnv* env,
ERL_NIF_TERM reason,
ErlNifPid* pid)
{
ERL_NIF_TERM msg = enif_make_tuple2(env, atom_error, reason);
return send_msg(env, msg, pid);
}
/* Send an (nif-) abort message to the specified process:
* A message in the form:
*
* {nif_abort, Ref, Reason}
*
* This message is for processes that are waiting in the
* erlang API functions for a select message.
*/
static
char* send_msg_nif_abort(ErlNifEnv* env,
ERL_NIF_TERM ref,
ERL_NIF_TERM reason,
ErlNifPid* pid)
{
ERL_NIF_TERM msg = MKT3(env, atom_nif_abort, ref, reason);
return send_msg(env, msg, pid);
}
/* Send a message to the specified process.
*/
static
char* send_msg(ErlNifEnv* env,
ERL_NIF_TERM msg,
ErlNifPid* pid)
{
if (!enif_send(env, pid, NULL, msg))
return str_exsend;
else
return NULL;
}
static
void xabort(const char* expr,
const char* func,
const char* file,
int line)
{
fflush(stdout);
fprintf(stderr, "%s:%d:%s() Assertion failed: %s\n",
file, line, func, expr);
fflush(stderr);
abort();
}
/* ----------------------------------------------------------------------
* C o u n t e r F u n c t i o n s
* ----------------------------------------------------------------------
*/
static
BOOLEAN_T cnt_inc(uint32_t* cnt, uint32_t inc)
{
BOOLEAN_T wrap;
uint32_t max = 0xFFFFFFFF;
uint32_t current = *cnt;
if ((max - inc) >= current) {
*cnt += inc;
wrap = FALSE;
} else {
*cnt = inc - (max - current) - 1;
wrap = TRUE;
}
return (wrap);
}
/* ----------------------------------------------------------------------
* C a l l b a c k F u n c t i o n s
* ----------------------------------------------------------------------
*/
/* =========================================================================
* socket_dtor - Callback function for resource destructor
*
*/
static
void socket_dtor(ErlNifEnv* env, void* obj)
{
SocketDescriptor* descP = (SocketDescriptor*) obj;
MDESTROY(descP->writeMtx);
MDESTROY(descP->readMtx);
MDESTROY(descP->accMtx);
MDESTROY(descP->closeMtx);
}
/* =========================================================================
* socket_stop - Callback function for resource stop
*
* When the socket is stopped, we need to inform:
*
* * the controlling process
* * the current writer and any waiting writers
* * the current reader and any waiting readers
* * the current acceptor and any waiting acceptor
*
* Also, make sure no process gets the message twice
* (in case it is, for instance, both controlling process
* and a writer).
*
* <KOLLA>
* We do not handle linger-issues yet! So anything in the out
* buffers will be left for the OS to solve...
* Do we need a special "close"-thread? Dirty scheduler?
* </KOLLA>
*/
static
void socket_stop(ErlNifEnv* env, void* obj, int fd, int is_direct_call)
{
SocketDescriptor* descP = (SocketDescriptor*) obj;
MLOCK(descP->writeMtx);
MLOCK(descP->readMtx);
MLOCK(descP->accMtx);
MLOCK(descP->closeMtx);
descP->state = SOCKET_STATE_CLOSING; // Just in case...???
descP->isReadable = FALSE;
descP->isWritable = FALSE;
/* We should check that we actually have a monitor.
* This *should* be done with a "NULL" monitor value,
* which there currently is none...
*/
DEMONP(env, descP, &descP->ctrlMon);
if (descP->currentWriterP != NULL) {
/* We have a (current) writer and *may* therefor also have
* writers waiting.
*/
SASSERT( (NULL == send_msg_nif_abort(env,
descP->currentWriter.ref,
atom_closed,
&descP->currentWriter.pid)) );
/* And also deal with the waiting writers (in the same way) */
inform_waiting_procs(env, descP, &descP->writersQ, TRUE, atom_closed);
}
if (descP->currentReaderP != NULL) {
/* We have a (current) reader and *may* therefor also have
* readers waiting.
*/
SASSERT( (NULL == send_msg_nif_abort(env,
descP->currentReader.ref,
atom_closed,
&descP->currentReader.pid)) );
/* And also deal with the waiting readers (in the same way) */
inform_waiting_procs(env, descP, &descP->readersQ, TRUE, atom_closed);
}
if (descP->currentAcceptorP != NULL) {
/* We have a (current) acceptor and *may* therefor also have
* acceptors waiting.
*/
SASSERT( (NULL == send_msg_nif_abort(env,
descP->currentAcceptor.ref,
atom_closed,
&descP->currentAcceptor.pid)) );
/* And also deal with the waiting acceptors (in the same way) */
inform_waiting_procs(env, descP, &descP->acceptorsQ, TRUE, atom_closed);
}
if (descP->sock != INVALID_SOCKET) {
/*
* <KOLLA>
*
* WE NEED TO CHECK IF THIS OPERATION IS TRIGGERED
* LOCALLY (VIA A CALL TO CLOSE) OR REMOTELLY
* (VIA I.E. ECONSRESET).
*
* </KOLLA>
*/
if (descP->closeLocal) {
/* +++ send close message to the waiting process +++
*
* {close, CloseRef}
*
*/
send_msg(env, MKT2(env, atom_close, descP->closeRef), &descP->closerPid);
DEMONP(env, descP, &descP->closerMon);
} else {
/*
* <KOLLA>
*
* ABORT?
*
* </KOLLA>
*/
}
}
MUNLOCK(descP->closeMtx);
MUNLOCK(descP->accMtx);
MUNLOCK(descP->readMtx);
MUNLOCK(descP->writeMtx);
}
/* This function traverse the queue and sends the specified
* nif_abort message with the specified reason to each member,
* and if the 'free' argument is TRUE, the queue will be emptied.
*/
static
void inform_waiting_procs(ErlNifEnv* env,
SocketDescriptor* descP,
SocketRequestQueue* q,
BOOLEAN_T free,
ERL_NIF_TERM reason)
{
SocketRequestQueueElement* currentP = q->first;
SocketRequestQueueElement* nextP;
while (currentP != NULL) {
/* <KOLLA>
*
* Should we inform anyone if we fail to demonitor?
* NOT SURE WHAT THAT WOULD REPRESENT AND IT IS NOT
* IMPORTANT IN *THIS* CASE, BUT ITS A FUNDAMENTAL OP...
*
* </KOLLA>
*/
SASSERT( (NULL == send_msg_nif_abort(env,
currentP->data.ref,
reason,
¤tP->data.pid)) );
DEMONP(env, descP, ¤tP->data.mon);
nextP = currentP->nextP;
if (free) FREE(currentP);
currentP = nextP;
}
if (free) {
q->first = NULL;
q->last = NULL;
}
}
/* =========================================================================
* socket_down - Callback function for resource down (monitored processes)
*
*/
static
void socket_down(ErlNifEnv* env,
void* obj,
const ErlNifPid* pid,
const ErlNifMonitor* mon)
{
}
/* ----------------------------------------------------------------------
* L o a d / u n l o a d / u p g r a d e F u n c t i o n s
* ----------------------------------------------------------------------
*/
static
ErlNifFunc socket_funcs[] =
{
// Some utility functions
{"nif_is_loaded", 0, nif_is_loaded, 0},
{"nif_info", 0, nif_info, 0},
// {"nif_debug", 1, nif_debug_, 0},
// The proper "socket" interface
{"nif_open", 4, nif_open, 0},
{"nif_bind", 3, nif_bind, 0},
{"nif_connect", 3, nif_connect, 0},
{"nif_listen", 2, nif_listen, 0},
{"nif_accept", 2, nif_accept, 0},
{"nif_send", 4, nif_send, 0},
{"nif_sendto", 6, nif_sendto, 0},
{"nif_recv", 4, nif_recv, 0},
{"nif_recvfrom", 2, nif_recvfrom, 0},
{"nif_close", 1, nif_close, 0},
{"nif_setsockopt", 3, nif_setsockopt, 0},
{"nif_getsockopt", 2, nif_getsockopt, 0},
/* "Extra" functions to "complete" the socket interface.
* For instance, the function nif_finalize_connection
* is called after the connect *select* has "completed".
*/
{"nif_finalize_connection", 1, nif_finalize_connection, 0},
{"nif_cancel", 2, nif_cancel, 0},
{"nif_finalize_close", 1, nif_finalize_close, ERL_NIF_DIRTY_JOB_IO_BOUND}
};
static
BOOLEAN_T extract_item_on_load(ErlNifEnv* env,
ERL_NIF_TERM map,
ERL_NIF_TERM key,
ERL_NIF_TERM* val)
{
if (!enif_is_map(env, map))
return FALSE;
if (!enif_get_map_value(env, map, key, val))
return FALSE;
return TRUE;
}
static
BOOLEAN_T extract_debug_on_load(ErlNifEnv* env, ERL_NIF_TERM map, BOOLEAN_T def)
{
ERL_NIF_TERM dbgKey = enif_make_atom(env, "debug");
ERL_NIF_TERM dbgVal;
unsigned int len;
char d[16]; // Just in case...
/* Extra the value of the debug property */
if (!extract_item_on_load(env, map, dbgKey, &dbgVal))
return def;
/* Verify that the value is actually an atom */
if (!enif_is_atom(env, dbgVal))
return def;
/* Verify that the value is of acceptable length */
if (!(GET_ATOM_LEN(env, dbgVal, &len) &&
(len > 0) &&
(len <= sizeof("false"))))
return def;
/* And finally try to extract the value */
if (!GET_ATOM(env, dbgVal, d, sizeof(d)))
return def;
if (strncmp(d, "true", len) == 0)
return TRUE;
else
return FALSE;
}
/* =======================================================================
* load_info - A map of misc info (e.g global debug)
*/
static
int on_load(ErlNifEnv* env, void** priv_data, ERL_NIF_TERM load_info)
{
socketData.dbg = extract_debug_on_load(env, load_info,
SOCKET_NIF_DEBUG_DEFAULT);
/* Misc atoms */
// atom_active = MKA(env, str_active);
// atom_active_n = MKA(env, str_active_n);
// atom_active_once = MKA(env, str_active_once);
// atom_binary = MKA(env, str_binary);
// atom_buildDate = MKA(env, str_buildDate);
atom_close = MKA(env, str_close);
atom_closed = MKA(env, str_closed);
atom_closing = MKA(env, str_closing);
atom_error = MKA(env, str_error);
atom_false = MKA(env, str_false);
// atom_list = MKA(env, str_list);
// atom_mode = MKA(env, str_mode);
atom_nif_abort = MKA(env, str_nif_abort);
atom_ok = MKA(env, str_ok);
// atom_once = MKA(env, str_once);
// atom_passive = MKA(env, str_passive);
// atom_receiver = MKA(env, str_receiver);
atom_select = MKA(env, str_select);
// atom_tcp_closed = MKA(env, str_tcp_closed);
atom_timeout = MKA(env, str_timeout);
atom_true = MKA(env, str_true);
atom_undefined = MKA(env, str_undefined);
// atom_version = MKA(env, str_version);
/* Error codes */
atom_eagain = MKA(env, str_eagain);
atom_eafnosupport = MKA(env, str_eafnosupport);
atom_einval = MKA(env, str_einval);
atom_eisconn = MKA(env, str_eisconn);
atom_enotclosing = MKA(env, str_enotclosing);
atom_enotconn = MKA(env, str_enotconn);
atom_exalloc = MKA(env, str_exalloc);
atom_exbadstate = MKA(env, str_exbadstate);
atom_exbusy = MKA(env, str_exbusy);
// atom_exnotopen = MKA(env, str_exnotopen);
atom_exmon = MKA(env, str_exmon);
atom_exself = MKA(env, str_exself);
atom_exsend = MKA(env, str_exsend);
// For storing "global" things...
// socketData.env = enif_alloc_env(); // We should really check
// socketData.version = MKA(env, ERTS_VERSION);
// socketData.buildDate = MKA(env, ERTS_BUILD_DATE);
sockets = enif_open_resource_type_x(env,
"sockets",
&socketInit,
ERL_NIF_RT_CREATE,
NULL);
return !sockets;
}
ERL_NIF_INIT(socket, socket_funcs, on_load, NULL, NULL, NULL)
|