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
|
/*
* BSD LICENSE
*
* Copyright (c) 2018-2019 Broadcom. All Rights Reserved.
* The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/*
* NVMe_FC transport functions.
*/
#include "spdk/env.h"
#include "spdk/assert.h"
#include "spdk/nvmf_transport.h"
#include "spdk/string.h"
#include "spdk/trace.h"
#include "spdk/util.h"
#include "spdk/likely.h"
#include "spdk/endian.h"
#include "spdk/log.h"
#include "spdk/thread.h"
#include "spdk_internal/log.h"
#include "nvmf_fc.h"
#include "fc_lld.h"
#ifndef DEV_VERIFY
#define DEV_VERIFY assert
#endif
#ifndef ASSERT_SPDK_FC_MASTER_THREAD
#define ASSERT_SPDK_FC_MASTER_THREAD() \
DEV_VERIFY(spdk_get_thread() == nvmf_fc_get_master_thread());
#endif
/*
* PRLI service parameters
*/
enum spdk_nvmf_fc_service_parameters {
SPDK_NVMF_FC_FIRST_BURST_SUPPORTED = 0x0001,
SPDK_NVMF_FC_DISCOVERY_SERVICE = 0x0008,
SPDK_NVMF_FC_TARGET_FUNCTION = 0x0010,
SPDK_NVMF_FC_INITIATOR_FUNCTION = 0x0020,
SPDK_NVMF_FC_CONFIRMED_COMPLETION_SUPPORTED = 0x0080,
};
static char *fc_req_state_strs[] = {
"SPDK_NVMF_FC_REQ_INIT",
"SPDK_NVMF_FC_REQ_READ_BDEV",
"SPDK_NVMF_FC_REQ_READ_XFER",
"SPDK_NVMF_FC_REQ_READ_RSP",
"SPDK_NVMF_FC_REQ_WRITE_BUFFS",
"SPDK_NVMF_FC_REQ_WRITE_XFER",
"SPDK_NVMF_FC_REQ_WRITE_BDEV",
"SPDK_NVMF_FC_REQ_WRITE_RSP",
"SPDK_NVMF_FC_REQ_NONE_BDEV",
"SPDK_NVMF_FC_REQ_NONE_RSP",
"SPDK_NVMF_FC_REQ_SUCCESS",
"SPDK_NVMF_FC_REQ_FAILED",
"SPDK_NVMF_FC_REQ_ABORTED",
"SPDK_NVMF_FC_REQ_BDEV_ABORTED",
"SPDK_NVMF_FC_REQ_PENDING"
};
#define OBJECT_NVMF_FC_IO 0xA0
#define TRACE_GROUP_NVMF_FC 0x8
#define TRACE_FC_REQ_INIT SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x01)
#define TRACE_FC_REQ_READ_BDEV SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x02)
#define TRACE_FC_REQ_READ_XFER SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x03)
#define TRACE_FC_REQ_READ_RSP SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x04)
#define TRACE_FC_REQ_WRITE_BUFFS SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x05)
#define TRACE_FC_REQ_WRITE_XFER SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x06)
#define TRACE_FC_REQ_WRITE_BDEV SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x07)
#define TRACE_FC_REQ_WRITE_RSP SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x08)
#define TRACE_FC_REQ_NONE_BDEV SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x09)
#define TRACE_FC_REQ_NONE_RSP SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x0A)
#define TRACE_FC_REQ_SUCCESS SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x0B)
#define TRACE_FC_REQ_FAILED SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x0C)
#define TRACE_FC_REQ_ABORTED SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x0D)
#define TRACE_FC_REQ_BDEV_ABORTED SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x0E)
#define TRACE_FC_REQ_PENDING SPDK_TPOINT_ID(TRACE_GROUP_NVMF_FC, 0x0F)
SPDK_TRACE_REGISTER_FN(nvmf_fc_trace, "nvmf_fc", TRACE_GROUP_NVMF_FC)
{
spdk_trace_register_object(OBJECT_NVMF_FC_IO, 'r');
spdk_trace_register_description("FC_REQ_NEW",
TRACE_FC_REQ_INIT,
OWNER_NONE, OBJECT_NVMF_FC_IO, 1, 1, "");
spdk_trace_register_description("FC_REQ_READ_SUBMIT_TO_BDEV",
TRACE_FC_REQ_READ_BDEV,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_READ_XFER_DATA",
TRACE_FC_REQ_READ_XFER,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_READ_RSP",
TRACE_FC_REQ_READ_RSP,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_WRITE_NEED_BUFFER",
TRACE_FC_REQ_WRITE_BUFFS,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_WRITE_XFER_DATA",
TRACE_FC_REQ_WRITE_XFER,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_WRITE_SUBMIT_TO_BDEV",
TRACE_FC_REQ_WRITE_BDEV,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_WRITE_RSP",
TRACE_FC_REQ_WRITE_RSP,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_NONE_SUBMIT_TO_BDEV",
TRACE_FC_REQ_NONE_BDEV,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_NONE_RSP",
TRACE_FC_REQ_NONE_RSP,
OWNER_NONE, OBJECT_NVMF_FC_IO, 0, 1, "");
spdk_trace_register_description("FC_REQ_SUCCESS",
TRACE_FC_REQ_SUCCESS,
OWNER_NONE, OBJECT_NONE, 0, 0, "");
spdk_trace_register_description("FC_REQ_FAILED",
TRACE_FC_REQ_FAILED,
OWNER_NONE, OBJECT_NONE, 0, 0, "");
spdk_trace_register_description("FC_REQ_ABORTED",
TRACE_FC_REQ_ABORTED,
OWNER_NONE, OBJECT_NONE, 0, 1, "");
spdk_trace_register_description("FC_REQ_ABORTED_SUBMIT_TO_BDEV",
TRACE_FC_REQ_BDEV_ABORTED,
OWNER_NONE, OBJECT_NONE, 0, 1, "");
spdk_trace_register_description("FC_REQ_PENDING",
TRACE_FC_REQ_PENDING,
OWNER_NONE, OBJECT_NONE, 0, 1, "");
}
/**
* The structure used by all fc adm functions
*/
struct spdk_nvmf_fc_adm_api_data {
void *api_args;
spdk_nvmf_fc_callback cb_func;
};
/**
* The callback structure for nport-delete
*/
struct spdk_nvmf_fc_adm_nport_del_cb_data {
struct spdk_nvmf_fc_nport *nport;
uint8_t port_handle;
spdk_nvmf_fc_callback fc_cb_func;
void *fc_cb_ctx;
};
/**
* The callback structure for it-delete
*/
struct spdk_nvmf_fc_adm_i_t_del_cb_data {
struct spdk_nvmf_fc_nport *nport;
struct spdk_nvmf_fc_remote_port_info *rport;
uint8_t port_handle;
spdk_nvmf_fc_callback fc_cb_func;
void *fc_cb_ctx;
};
typedef void (*spdk_nvmf_fc_adm_i_t_delete_assoc_cb_fn)(void *arg, uint32_t err);
/**
* The callback structure for the it-delete-assoc callback
*/
struct spdk_nvmf_fc_adm_i_t_del_assoc_cb_data {
struct spdk_nvmf_fc_nport *nport;
struct spdk_nvmf_fc_remote_port_info *rport;
uint8_t port_handle;
spdk_nvmf_fc_adm_i_t_delete_assoc_cb_fn cb_func;
void *cb_ctx;
};
/*
* Call back function pointer for HW port quiesce.
*/
typedef void (*spdk_nvmf_fc_adm_hw_port_quiesce_cb_fn)(void *ctx, int err);
/**
* Context structure for quiescing a hardware port
*/
struct spdk_nvmf_fc_adm_hw_port_quiesce_ctx {
int quiesce_count;
void *ctx;
spdk_nvmf_fc_adm_hw_port_quiesce_cb_fn cb_func;
};
/**
* Context structure used to reset a hardware port
*/
struct spdk_nvmf_fc_adm_hw_port_reset_ctx {
void *reset_args;
spdk_nvmf_fc_callback reset_cb_func;
};
/**
* The callback structure for HW port link break event
*/
struct spdk_nvmf_fc_adm_port_link_break_cb_data {
struct spdk_nvmf_hw_port_link_break_args *args;
struct spdk_nvmf_fc_nport_delete_args nport_del_args;
spdk_nvmf_fc_callback cb_func;
};
struct spdk_nvmf_fc_transport {
struct spdk_nvmf_transport transport;
pthread_mutex_t lock;
};
static struct spdk_nvmf_fc_transport *g_nvmf_ftransport;
static TAILQ_HEAD(, spdk_nvmf_fc_port) g_spdk_nvmf_fc_port_list =
TAILQ_HEAD_INITIALIZER(g_spdk_nvmf_fc_port_list);
static struct spdk_thread *g_nvmf_fc_master_thread = NULL;
static uint32_t g_nvmf_fgroup_count = 0;
static TAILQ_HEAD(, spdk_nvmf_fc_poll_group) g_nvmf_fgroups =
TAILQ_HEAD_INITIALIZER(g_nvmf_fgroups);
struct spdk_thread *
nvmf_fc_get_master_thread(void)
{
return g_nvmf_fc_master_thread;
}
static inline void
nvmf_fc_record_req_trace_point(struct spdk_nvmf_fc_request *fc_req,
enum spdk_nvmf_fc_request_state state)
{
uint16_t tpoint_id = SPDK_TRACE_MAX_TPOINT_ID;
switch (state) {
case SPDK_NVMF_FC_REQ_INIT:
/* Start IO tracing */
tpoint_id = TRACE_FC_REQ_INIT;
break;
case SPDK_NVMF_FC_REQ_READ_BDEV:
tpoint_id = TRACE_FC_REQ_READ_BDEV;
break;
case SPDK_NVMF_FC_REQ_READ_XFER:
tpoint_id = TRACE_FC_REQ_READ_XFER;
break;
case SPDK_NVMF_FC_REQ_READ_RSP:
tpoint_id = TRACE_FC_REQ_READ_RSP;
break;
case SPDK_NVMF_FC_REQ_WRITE_BUFFS:
tpoint_id = TRACE_FC_REQ_WRITE_BUFFS;
break;
case SPDK_NVMF_FC_REQ_WRITE_XFER:
tpoint_id = TRACE_FC_REQ_WRITE_XFER;
break;
case SPDK_NVMF_FC_REQ_WRITE_BDEV:
tpoint_id = TRACE_FC_REQ_WRITE_BDEV;
break;
case SPDK_NVMF_FC_REQ_WRITE_RSP:
tpoint_id = TRACE_FC_REQ_WRITE_RSP;
break;
case SPDK_NVMF_FC_REQ_NONE_BDEV:
tpoint_id = TRACE_FC_REQ_NONE_BDEV;
break;
case SPDK_NVMF_FC_REQ_NONE_RSP:
tpoint_id = TRACE_FC_REQ_NONE_RSP;
break;
case SPDK_NVMF_FC_REQ_SUCCESS:
tpoint_id = TRACE_FC_REQ_SUCCESS;
break;
case SPDK_NVMF_FC_REQ_FAILED:
tpoint_id = TRACE_FC_REQ_FAILED;
break;
case SPDK_NVMF_FC_REQ_ABORTED:
tpoint_id = TRACE_FC_REQ_ABORTED;
break;
case SPDK_NVMF_FC_REQ_BDEV_ABORTED:
tpoint_id = TRACE_FC_REQ_ABORTED;
break;
case SPDK_NVMF_FC_REQ_PENDING:
tpoint_id = TRACE_FC_REQ_PENDING;
break;
default:
assert(0);
break;
}
if (tpoint_id != SPDK_TRACE_MAX_TPOINT_ID) {
spdk_trace_record(tpoint_id, fc_req->poller_lcore, 0,
(uint64_t)(&fc_req->req), 0);
}
}
static void
nvmf_fc_handle_connection_failure(void *arg)
{
struct spdk_nvmf_fc_conn *fc_conn = arg;
struct spdk_nvmf_fc_ls_add_conn_api_data *api_data = NULL;
if (!fc_conn->create_opd) {
return;
}
api_data = &fc_conn->create_opd->u.add_conn;
nvmf_fc_ls_add_conn_failure(api_data->assoc, api_data->ls_rqst,
api_data->args.fc_conn, api_data->aq_conn);
}
static void
nvmf_fc_handle_assoc_deletion(void *arg)
{
struct spdk_nvmf_fc_conn *fc_conn = arg;
nvmf_fc_delete_association(fc_conn->fc_assoc->tgtport,
fc_conn->fc_assoc->assoc_id, false, true, NULL, NULL);
}
static int
nvmf_fc_create_req_mempool(struct spdk_nvmf_fc_hwqp *hwqp)
{
uint32_t i;
struct spdk_nvmf_fc_request *fc_req;
TAILQ_INIT(&hwqp->free_reqs);
TAILQ_INIT(&hwqp->in_use_reqs);
hwqp->fc_reqs_buf = calloc(hwqp->rq_size, sizeof(struct spdk_nvmf_fc_request));
if (hwqp->fc_reqs_buf == NULL) {
SPDK_ERRLOG("create fc request pool failed\n");
return -ENOMEM;
}
for (i = 0; i < hwqp->rq_size; i++) {
fc_req = hwqp->fc_reqs_buf + i;
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_INIT);
TAILQ_INSERT_TAIL(&hwqp->free_reqs, fc_req, link);
}
return 0;
}
static inline struct spdk_nvmf_fc_request *
nvmf_fc_hwqp_alloc_fc_request(struct spdk_nvmf_fc_hwqp *hwqp)
{
struct spdk_nvmf_fc_request *fc_req;
if (TAILQ_EMPTY(&hwqp->free_reqs)) {
SPDK_ERRLOG("Alloc request buffer failed\n");
return NULL;
}
fc_req = TAILQ_FIRST(&hwqp->free_reqs);
TAILQ_REMOVE(&hwqp->free_reqs, fc_req, link);
memset(fc_req, 0, sizeof(struct spdk_nvmf_fc_request));
TAILQ_INSERT_TAIL(&hwqp->in_use_reqs, fc_req, link);
TAILQ_INIT(&fc_req->abort_cbs);
return fc_req;
}
static inline void
nvmf_fc_hwqp_free_fc_request(struct spdk_nvmf_fc_hwqp *hwqp, struct spdk_nvmf_fc_request *fc_req)
{
if (fc_req->state != SPDK_NVMF_FC_REQ_SUCCESS) {
/* Log an error for debug purpose. */
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_FAILED);
}
/* set the magic to mark req as no longer valid. */
fc_req->magic = 0xDEADBEEF;
TAILQ_REMOVE(&hwqp->in_use_reqs, fc_req, link);
TAILQ_INSERT_HEAD(&hwqp->free_reqs, fc_req, link);
}
static inline bool
nvmf_fc_req_in_get_buff(struct spdk_nvmf_fc_request *fc_req)
{
switch (fc_req->state) {
case SPDK_NVMF_FC_REQ_WRITE_BUFFS:
return true;
default:
return false;
}
}
void
nvmf_fc_init_poller_queues(struct spdk_nvmf_fc_hwqp *hwqp)
{
nvmf_fc_init_rqpair_buffers(hwqp);
}
struct spdk_nvmf_fc_conn *
nvmf_fc_hwqp_find_fc_conn(struct spdk_nvmf_fc_hwqp *hwqp, uint64_t conn_id)
{
struct spdk_nvmf_fc_conn *fc_conn;
TAILQ_FOREACH(fc_conn, &hwqp->connection_list, link) {
if (fc_conn->conn_id == conn_id) {
return fc_conn;
}
}
return NULL;
}
void
nvmf_fc_hwqp_reinit_poller_queues(struct spdk_nvmf_fc_hwqp *hwqp, void *queues_curr)
{
struct spdk_nvmf_fc_abts_ctx *ctx;
struct spdk_nvmf_fc_poller_api_queue_sync_args *args = NULL, *tmp = NULL;
/* Clean up any pending sync callbacks */
TAILQ_FOREACH_SAFE(args, &hwqp->sync_cbs, link, tmp) {
TAILQ_REMOVE(&hwqp->sync_cbs, args, link);
ctx = args->cb_info.cb_data;
if (ctx) {
if (++ctx->hwqps_responded == ctx->num_hwqps) {
free(ctx->sync_poller_args);
free(ctx->abts_poller_args);
free(ctx);
}
}
}
nvmf_fc_reinit_q(hwqp->queues, queues_curr);
}
void
nvmf_fc_init_hwqp(struct spdk_nvmf_fc_port *fc_port, struct spdk_nvmf_fc_hwqp *hwqp)
{
hwqp->fc_port = fc_port;
/* clear counters */
memset(&hwqp->counters, 0, sizeof(struct spdk_nvmf_fc_errors));
nvmf_fc_init_poller_queues(hwqp);
if (&fc_port->ls_queue != hwqp) {
nvmf_fc_create_req_mempool(hwqp);
}
nvmf_fc_init_q(hwqp);
TAILQ_INIT(&hwqp->connection_list);
TAILQ_INIT(&hwqp->sync_cbs);
TAILQ_INIT(&hwqp->ls_pending_queue);
}
static struct spdk_nvmf_fc_poll_group *
nvmf_fc_get_idlest_poll_group(void)
{
uint32_t max_count = UINT32_MAX;
struct spdk_nvmf_fc_poll_group *fgroup;
struct spdk_nvmf_fc_poll_group *ret_fgroup = NULL;
/* find poll group with least number of hwqp's assigned to it */
TAILQ_FOREACH(fgroup, &g_nvmf_fgroups, link) {
if (fgroup->hwqp_count < max_count) {
ret_fgroup = fgroup;
max_count = fgroup->hwqp_count;
}
}
return ret_fgroup;
}
void
nvmf_fc_poll_group_add_hwqp(struct spdk_nvmf_fc_hwqp *hwqp)
{
struct spdk_nvmf_fc_poll_group *fgroup = NULL;
assert(hwqp);
if (hwqp == NULL) {
SPDK_ERRLOG("Error: hwqp is NULL\n");
return;
}
assert(g_nvmf_fgroup_count);
fgroup = nvmf_fc_get_idlest_poll_group();
if (!fgroup) {
SPDK_ERRLOG("Could not assign poll group for hwqp (%d)\n", hwqp->hwqp_id);
return;
}
hwqp->thread = fgroup->group.group->thread;
hwqp->fgroup = fgroup;
fgroup->hwqp_count++;
nvmf_fc_poller_api_func(hwqp, SPDK_NVMF_FC_POLLER_API_ADD_HWQP, NULL);
}
void
nvmf_fc_poll_group_remove_hwqp(struct spdk_nvmf_fc_hwqp *hwqp)
{
assert(hwqp);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"Remove hwqp from poller: for port: %d, hwqp: %d\n",
hwqp->fc_port->port_hdl, hwqp->hwqp_id);
if (!hwqp->fgroup) {
SPDK_ERRLOG("HWQP (%d) not assigned to poll group\n", hwqp->hwqp_id);
} else {
hwqp->fgroup->hwqp_count--;
nvmf_fc_poller_api_func(hwqp, SPDK_NVMF_FC_POLLER_API_REMOVE_HWQP, NULL);
}
}
/*
* Note: This needs to be used only on master poller.
*/
static uint64_t
nvmf_fc_get_abts_unique_id(void)
{
static uint32_t u_id = 0;
return (uint64_t)(++u_id);
}
static void
nvmf_fc_queue_synced_cb(void *cb_data, enum spdk_nvmf_fc_poller_api_ret ret)
{
struct spdk_nvmf_fc_abts_ctx *ctx = cb_data;
struct spdk_nvmf_fc_poller_api_abts_recvd_args *args, *poller_arg;
ctx->hwqps_responded++;
if (ctx->hwqps_responded < ctx->num_hwqps) {
/* Wait for all pollers to complete. */
return;
}
/* Free the queue sync poller args. */
free(ctx->sync_poller_args);
/* Mark as queue synced */
ctx->queue_synced = true;
/* Reset the ctx values */
ctx->hwqps_responded = 0;
ctx->handled = false;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"QueueSync(0x%lx) completed for nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
ctx->u_id, ctx->nport->nport_hdl, ctx->rpi, ctx->oxid, ctx->rxid);
/* Resend ABTS to pollers */
args = ctx->abts_poller_args;
for (int i = 0; i < ctx->num_hwqps; i++) {
poller_arg = args + i;
nvmf_fc_poller_api_func(poller_arg->hwqp,
SPDK_NVMF_FC_POLLER_API_ABTS_RECEIVED,
poller_arg);
}
}
static int
nvmf_fc_handle_abts_notfound(struct spdk_nvmf_fc_abts_ctx *ctx)
{
struct spdk_nvmf_fc_poller_api_queue_sync_args *args, *poller_arg;
struct spdk_nvmf_fc_poller_api_abts_recvd_args *abts_args, *abts_poller_arg;
/* check if FC driver supports queue sync */
if (!nvmf_fc_q_sync_available()) {
return -EPERM;
}
assert(ctx);
if (!ctx) {
SPDK_ERRLOG("NULL ctx pointer");
return -EINVAL;
}
/* Reset the ctx values */
ctx->hwqps_responded = 0;
args = calloc(ctx->num_hwqps,
sizeof(struct spdk_nvmf_fc_poller_api_queue_sync_args));
if (!args) {
SPDK_ERRLOG("QueueSync(0x%lx) failed for nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
ctx->u_id, ctx->nport->nport_hdl, ctx->rpi, ctx->oxid, ctx->rxid);
return -ENOMEM;
}
ctx->sync_poller_args = args;
abts_args = ctx->abts_poller_args;
for (int i = 0; i < ctx->num_hwqps; i++) {
abts_poller_arg = abts_args + i;
poller_arg = args + i;
poller_arg->u_id = ctx->u_id;
poller_arg->hwqp = abts_poller_arg->hwqp;
poller_arg->cb_info.cb_func = nvmf_fc_queue_synced_cb;
poller_arg->cb_info.cb_data = ctx;
poller_arg->cb_info.cb_thread = spdk_get_thread();
/* Send a Queue sync message to interested pollers */
nvmf_fc_poller_api_func(poller_arg->hwqp,
SPDK_NVMF_FC_POLLER_API_QUEUE_SYNC,
poller_arg);
}
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"QueueSync(0x%lx) Sent for nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
ctx->u_id, ctx->nport->nport_hdl, ctx->rpi, ctx->oxid, ctx->rxid);
/* Post Marker to queue to track aborted request */
nvmf_fc_issue_q_sync(ctx->ls_hwqp, ctx->u_id, ctx->fcp_rq_id);
return 0;
}
static void
nvmf_fc_abts_handled_cb(void *cb_data, enum spdk_nvmf_fc_poller_api_ret ret)
{
struct spdk_nvmf_fc_abts_ctx *ctx = cb_data;
struct spdk_nvmf_fc_nport *nport = NULL;
if (ret != SPDK_NVMF_FC_POLLER_API_OXID_NOT_FOUND) {
ctx->handled = true;
}
ctx->hwqps_responded++;
if (ctx->hwqps_responded < ctx->num_hwqps) {
/* Wait for all pollers to complete. */
return;
}
nport = nvmf_fc_nport_find(ctx->port_hdl, ctx->nport_hdl);
if (ctx->nport != nport) {
/* Nport can be deleted while this abort is being
* processed by the pollers.
*/
SPDK_NOTICELOG("nport_%d deleted while processing ABTS frame, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
ctx->nport_hdl, ctx->rpi, ctx->oxid, ctx->rxid);
} else {
if (!ctx->handled) {
/* Try syncing the queues and try one more time */
if (!ctx->queue_synced && (nvmf_fc_handle_abts_notfound(ctx) == 0)) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"QueueSync(0x%lx) for nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
ctx->u_id, ctx->nport->nport_hdl, ctx->rpi, ctx->oxid, ctx->rxid);
return;
} else {
/* Send Reject */
nvmf_fc_xmt_bls_rsp(&ctx->nport->fc_port->ls_queue,
ctx->oxid, ctx->rxid, ctx->rpi, true,
FCNVME_BLS_REJECT_EXP_INVALID_OXID, NULL, NULL);
}
} else {
/* Send Accept */
nvmf_fc_xmt_bls_rsp(&ctx->nport->fc_port->ls_queue,
ctx->oxid, ctx->rxid, ctx->rpi, false,
0, NULL, NULL);
}
}
SPDK_NOTICELOG("BLS_%s sent for ABTS frame nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
(ctx->handled) ? "ACC" : "REJ", ctx->nport->nport_hdl, ctx->rpi, ctx->oxid, ctx->rxid);
free(ctx->abts_poller_args);
free(ctx);
}
void
nvmf_fc_handle_abts_frame(struct spdk_nvmf_fc_nport *nport, uint16_t rpi,
uint16_t oxid, uint16_t rxid)
{
struct spdk_nvmf_fc_abts_ctx *ctx = NULL;
struct spdk_nvmf_fc_poller_api_abts_recvd_args *args = NULL, *poller_arg;
struct spdk_nvmf_fc_association *assoc = NULL;
struct spdk_nvmf_fc_conn *conn = NULL;
uint32_t hwqp_cnt = 0;
bool skip_hwqp_cnt;
struct spdk_nvmf_fc_hwqp **hwqps = NULL;
uint32_t i;
SPDK_NOTICELOG("Handle ABTS frame for nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
nport->nport_hdl, rpi, oxid, rxid);
/* Allocate memory to track hwqp's with at least 1 active connection. */
hwqps = calloc(nport->fc_port->num_io_queues, sizeof(struct spdk_nvmf_fc_hwqp *));
if (hwqps == NULL) {
SPDK_ERRLOG("Unable to allocate temp. hwqp array for abts processing!\n");
goto bls_rej;
}
TAILQ_FOREACH(assoc, &nport->fc_associations, link) {
TAILQ_FOREACH(conn, &assoc->fc_conns, assoc_link) {
if (conn->rpi != rpi) {
continue;
}
skip_hwqp_cnt = false;
for (i = 0; i < hwqp_cnt; i++) {
if (hwqps[i] == conn->hwqp) {
/* Skip. This is already present */
skip_hwqp_cnt = true;
break;
}
}
if (!skip_hwqp_cnt) {
assert(hwqp_cnt < nport->fc_port->num_io_queues);
hwqps[hwqp_cnt] = conn->hwqp;
hwqp_cnt++;
}
}
}
if (!hwqp_cnt) {
goto bls_rej;
}
args = calloc(hwqp_cnt,
sizeof(struct spdk_nvmf_fc_poller_api_abts_recvd_args));
if (!args) {
goto bls_rej;
}
ctx = calloc(1, sizeof(struct spdk_nvmf_fc_abts_ctx));
if (!ctx) {
goto bls_rej;
}
ctx->rpi = rpi;
ctx->oxid = oxid;
ctx->rxid = rxid;
ctx->nport = nport;
ctx->nport_hdl = nport->nport_hdl;
ctx->port_hdl = nport->fc_port->port_hdl;
ctx->num_hwqps = hwqp_cnt;
ctx->ls_hwqp = &nport->fc_port->ls_queue;
ctx->fcp_rq_id = nport->fc_port->fcp_rq_id;
ctx->abts_poller_args = args;
/* Get a unique context for this ABTS */
ctx->u_id = nvmf_fc_get_abts_unique_id();
for (i = 0; i < hwqp_cnt; i++) {
poller_arg = args + i;
poller_arg->hwqp = hwqps[i];
poller_arg->cb_info.cb_func = nvmf_fc_abts_handled_cb;
poller_arg->cb_info.cb_data = ctx;
poller_arg->cb_info.cb_thread = spdk_get_thread();
poller_arg->ctx = ctx;
nvmf_fc_poller_api_func(poller_arg->hwqp,
SPDK_NVMF_FC_POLLER_API_ABTS_RECEIVED,
poller_arg);
}
free(hwqps);
return;
bls_rej:
free(args);
free(hwqps);
/* Send Reject */
nvmf_fc_xmt_bls_rsp(&nport->fc_port->ls_queue, oxid, rxid, rpi,
true, FCNVME_BLS_REJECT_EXP_NOINFO, NULL, NULL);
SPDK_NOTICELOG("BLS_RJT for ABTS frame for nport: %d, rpi: 0x%x, oxid: 0x%x, rxid: 0x%x\n",
nport->nport_hdl, rpi, oxid, rxid);
return;
}
/*** Accessor functions for the FC structures - BEGIN */
/*
* Returns true if the port is in offline state.
*/
bool
nvmf_fc_port_is_offline(struct spdk_nvmf_fc_port *fc_port)
{
if (fc_port && (fc_port->hw_port_status == SPDK_FC_PORT_OFFLINE)) {
return true;
}
return false;
}
/*
* Returns true if the port is in online state.
*/
bool
nvmf_fc_port_is_online(struct spdk_nvmf_fc_port *fc_port)
{
if (fc_port && (fc_port->hw_port_status == SPDK_FC_PORT_ONLINE)) {
return true;
}
return false;
}
int
nvmf_fc_port_set_online(struct spdk_nvmf_fc_port *fc_port)
{
if (fc_port && (fc_port->hw_port_status != SPDK_FC_PORT_ONLINE)) {
fc_port->hw_port_status = SPDK_FC_PORT_ONLINE;
return 0;
}
return -EPERM;
}
int
nvmf_fc_port_set_offline(struct spdk_nvmf_fc_port *fc_port)
{
if (fc_port && (fc_port->hw_port_status != SPDK_FC_PORT_OFFLINE)) {
fc_port->hw_port_status = SPDK_FC_PORT_OFFLINE;
return 0;
}
return -EPERM;
}
int
nvmf_fc_hwqp_set_online(struct spdk_nvmf_fc_hwqp *hwqp)
{
if (hwqp && (hwqp->state != SPDK_FC_HWQP_ONLINE)) {
hwqp->state = SPDK_FC_HWQP_ONLINE;
/* reset some queue counters */
hwqp->num_conns = 0;
return nvmf_fc_set_q_online_state(hwqp, true);
}
return -EPERM;
}
int
nvmf_fc_hwqp_set_offline(struct spdk_nvmf_fc_hwqp *hwqp)
{
if (hwqp && (hwqp->state != SPDK_FC_HWQP_OFFLINE)) {
hwqp->state = SPDK_FC_HWQP_OFFLINE;
return nvmf_fc_set_q_online_state(hwqp, false);
}
return -EPERM;
}
void
nvmf_fc_port_add(struct spdk_nvmf_fc_port *fc_port)
{
TAILQ_INSERT_TAIL(&g_spdk_nvmf_fc_port_list, fc_port, link);
}
struct spdk_nvmf_fc_port *
nvmf_fc_port_lookup(uint8_t port_hdl)
{
struct spdk_nvmf_fc_port *fc_port = NULL;
TAILQ_FOREACH(fc_port, &g_spdk_nvmf_fc_port_list, link) {
if (fc_port->port_hdl == port_hdl) {
return fc_port;
}
}
return NULL;
}
static void
nvmf_fc_port_cleanup(void)
{
struct spdk_nvmf_fc_port *fc_port, *tmp;
struct spdk_nvmf_fc_hwqp *hwqp;
uint32_t i;
TAILQ_FOREACH_SAFE(fc_port, &g_spdk_nvmf_fc_port_list, link, tmp) {
TAILQ_REMOVE(&g_spdk_nvmf_fc_port_list, fc_port, link);
for (i = 0; i < fc_port->num_io_queues; i++) {
hwqp = &fc_port->io_queues[i];
if (hwqp->fc_reqs_buf) {
free(hwqp->fc_reqs_buf);
}
}
free(fc_port);
}
}
uint32_t
nvmf_fc_get_prli_service_params(void)
{
return (SPDK_NVMF_FC_DISCOVERY_SERVICE | SPDK_NVMF_FC_TARGET_FUNCTION);
}
int
nvmf_fc_port_add_nport(struct spdk_nvmf_fc_port *fc_port,
struct spdk_nvmf_fc_nport *nport)
{
if (fc_port) {
TAILQ_INSERT_TAIL(&fc_port->nport_list, nport, link);
fc_port->num_nports++;
return 0;
}
return -EINVAL;
}
int
nvmf_fc_port_remove_nport(struct spdk_nvmf_fc_port *fc_port,
struct spdk_nvmf_fc_nport *nport)
{
if (fc_port && nport) {
TAILQ_REMOVE(&fc_port->nport_list, nport, link);
fc_port->num_nports--;
return 0;
}
return -EINVAL;
}
static struct spdk_nvmf_fc_nport *
nvmf_fc_nport_hdl_lookup(struct spdk_nvmf_fc_port *fc_port, uint16_t nport_hdl)
{
struct spdk_nvmf_fc_nport *fc_nport = NULL;
TAILQ_FOREACH(fc_nport, &fc_port->nport_list, link) {
if (fc_nport->nport_hdl == nport_hdl) {
return fc_nport;
}
}
return NULL;
}
struct spdk_nvmf_fc_nport *
nvmf_fc_nport_find(uint8_t port_hdl, uint16_t nport_hdl)
{
struct spdk_nvmf_fc_port *fc_port = NULL;
fc_port = nvmf_fc_port_lookup(port_hdl);
if (fc_port) {
return nvmf_fc_nport_hdl_lookup(fc_port, nport_hdl);
}
return NULL;
}
static inline int
nvmf_fc_hwqp_find_nport_and_rport(struct spdk_nvmf_fc_hwqp *hwqp,
uint32_t d_id, struct spdk_nvmf_fc_nport **nport,
uint32_t s_id, struct spdk_nvmf_fc_remote_port_info **rport)
{
struct spdk_nvmf_fc_nport *n_port;
struct spdk_nvmf_fc_remote_port_info *r_port;
assert(hwqp);
if (hwqp == NULL) {
SPDK_ERRLOG("Error: hwqp is NULL\n");
return -EINVAL;
}
assert(nport);
if (nport == NULL) {
SPDK_ERRLOG("Error: nport is NULL\n");
return -EINVAL;
}
assert(rport);
if (rport == NULL) {
SPDK_ERRLOG("Error: rport is NULL\n");
return -EINVAL;
}
TAILQ_FOREACH(n_port, &hwqp->fc_port->nport_list, link) {
if (n_port->d_id == d_id) {
TAILQ_FOREACH(r_port, &n_port->rem_port_list, link) {
if (r_port->s_id == s_id) {
*nport = n_port;
*rport = r_port;
return 0;
}
}
break;
}
}
return -ENOENT;
}
/* Returns true if the Nport is empty of all rem_ports */
bool
nvmf_fc_nport_has_no_rport(struct spdk_nvmf_fc_nport *nport)
{
if (nport && TAILQ_EMPTY(&nport->rem_port_list)) {
assert(nport->rport_count == 0);
return true;
} else {
return false;
}
}
int
nvmf_fc_nport_set_state(struct spdk_nvmf_fc_nport *nport,
enum spdk_nvmf_fc_object_state state)
{
if (nport) {
nport->nport_state = state;
return 0;
} else {
return -EINVAL;
}
}
bool
nvmf_fc_nport_add_rem_port(struct spdk_nvmf_fc_nport *nport,
struct spdk_nvmf_fc_remote_port_info *rem_port)
{
if (nport && rem_port) {
TAILQ_INSERT_TAIL(&nport->rem_port_list, rem_port, link);
nport->rport_count++;
return 0;
} else {
return -EINVAL;
}
}
bool
nvmf_fc_nport_remove_rem_port(struct spdk_nvmf_fc_nport *nport,
struct spdk_nvmf_fc_remote_port_info *rem_port)
{
if (nport && rem_port) {
TAILQ_REMOVE(&nport->rem_port_list, rem_port, link);
nport->rport_count--;
return 0;
} else {
return -EINVAL;
}
}
int
nvmf_fc_rport_set_state(struct spdk_nvmf_fc_remote_port_info *rport,
enum spdk_nvmf_fc_object_state state)
{
if (rport) {
rport->rport_state = state;
return 0;
} else {
return -EINVAL;
}
}
int
nvmf_fc_assoc_set_state(struct spdk_nvmf_fc_association *assoc,
enum spdk_nvmf_fc_object_state state)
{
if (assoc) {
assoc->assoc_state = state;
return 0;
} else {
return -EINVAL;
}
}
static struct spdk_nvmf_fc_association *
nvmf_ctrlr_get_fc_assoc(struct spdk_nvmf_ctrlr *ctrlr)
{
struct spdk_nvmf_qpair *qpair = ctrlr->admin_qpair;
struct spdk_nvmf_fc_conn *fc_conn;
if (!qpair) {
SPDK_ERRLOG("Controller %d has no associations\n", ctrlr->cntlid);
return NULL;
}
fc_conn = SPDK_CONTAINEROF(qpair, struct spdk_nvmf_fc_conn, qpair);
return fc_conn->fc_assoc;
}
bool
nvmf_ctrlr_is_on_nport(uint8_t port_hdl, uint16_t nport_hdl,
struct spdk_nvmf_ctrlr *ctrlr)
{
struct spdk_nvmf_fc_nport *fc_nport = NULL;
struct spdk_nvmf_fc_association *assoc = NULL;
if (!ctrlr) {
return false;
}
fc_nport = nvmf_fc_nport_find(port_hdl, nport_hdl);
if (!fc_nport) {
return false;
}
assoc = nvmf_ctrlr_get_fc_assoc(ctrlr);
if (assoc && assoc->tgtport == fc_nport) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"Controller: %d corresponding to association: %p(%lu:%d) is on port: %d nport: %d\n",
ctrlr->cntlid, assoc, assoc->assoc_id, assoc->assoc_state, port_hdl,
nport_hdl);
return true;
}
return false;
}
static inline bool
nvmf_fc_req_in_bdev(struct spdk_nvmf_fc_request *fc_req)
{
switch (fc_req->state) {
case SPDK_NVMF_FC_REQ_READ_BDEV:
case SPDK_NVMF_FC_REQ_WRITE_BDEV:
case SPDK_NVMF_FC_REQ_NONE_BDEV:
return true;
default:
return false;
}
}
static inline bool
nvmf_fc_req_in_pending(struct spdk_nvmf_fc_request *fc_req)
{
struct spdk_nvmf_request *tmp = NULL;
STAILQ_FOREACH(tmp, &fc_req->hwqp->fgroup->group.pending_buf_queue, buf_link) {
if (tmp == &fc_req->req) {
return true;
}
}
return false;
}
static void
nvmf_fc_req_bdev_abort(void *arg1)
{
struct spdk_nvmf_fc_request *fc_req = arg1;
struct spdk_nvmf_ctrlr *ctrlr = fc_req->req.qpair->ctrlr;
int i;
/* Initial release - we don't have to abort Admin Queue or
* Fabric commands. The AQ commands supported at this time are
* Get-Log-Page,
* Identify
* Set Features
* Get Features
* AER -> Special case and handled differently.
* Every one of the above Admin commands (except AER) run
* to completion and so an Abort of such commands doesn't
* make sense.
*/
/* The Fabric commands supported are
* Property Set
* Property Get
* Connect -> Special case (async. handling). Not sure how to
* handle at this point. Let it run to completion.
*/
for (i = 0; i < NVMF_MAX_ASYNC_EVENTS; i++) {
if (ctrlr->aer_req[i] == &fc_req->req) {
SPDK_NOTICELOG("Abort AER request\n");
nvmf_qpair_free_aer(fc_req->req.qpair);
}
}
}
void
nvmf_fc_request_abort_complete(void *arg1)
{
struct spdk_nvmf_fc_request *fc_req =
(struct spdk_nvmf_fc_request *)arg1;
struct spdk_nvmf_fc_caller_ctx *ctx = NULL, *tmp = NULL;
/* Request abort completed. Notify all the callbacks */
TAILQ_FOREACH_SAFE(ctx, &fc_req->abort_cbs, link, tmp) {
/* Notify */
ctx->cb(fc_req->hwqp, 0, ctx->cb_args);
/* Remove */
TAILQ_REMOVE(&fc_req->abort_cbs, ctx, link);
/* free */
free(ctx);
}
SPDK_NOTICELOG("FC Request(%p) in state :%s aborted\n", fc_req,
fc_req_state_strs[fc_req->state]);
_nvmf_fc_request_free(fc_req);
}
void
nvmf_fc_request_abort(struct spdk_nvmf_fc_request *fc_req, bool send_abts,
spdk_nvmf_fc_caller_cb cb, void *cb_args)
{
struct spdk_nvmf_fc_caller_ctx *ctx = NULL;
bool kill_req = false;
/* Add the cb to list */
if (cb) {
ctx = calloc(1, sizeof(struct spdk_nvmf_fc_caller_ctx));
if (!ctx) {
SPDK_ERRLOG("ctx alloc failed.\n");
return;
}
ctx->cb = cb;
ctx->cb_args = cb_args;
TAILQ_INSERT_TAIL(&fc_req->abort_cbs, ctx, link);
}
if (!fc_req->is_aborted) {
/* Increment aborted command counter */
fc_req->hwqp->counters.num_aborted++;
}
/* If port is dead, skip abort wqe */
kill_req = nvmf_fc_is_port_dead(fc_req->hwqp);
if (kill_req && nvmf_fc_req_in_xfer(fc_req)) {
fc_req->is_aborted = true;
goto complete;
}
/* Check if the request is already marked for deletion */
if (fc_req->is_aborted) {
return;
}
/* Mark request as aborted */
fc_req->is_aborted = true;
/* If xchg is allocated, then save if we need to send abts or not. */
if (fc_req->xchg) {
fc_req->xchg->send_abts = send_abts;
fc_req->xchg->aborted = true;
}
if (fc_req->state == SPDK_NVMF_FC_REQ_BDEV_ABORTED) {
/* Aborted by backend */
goto complete;
} else if (nvmf_fc_req_in_bdev(fc_req)) {
/* Notify bdev */
spdk_thread_send_msg(fc_req->hwqp->thread,
nvmf_fc_req_bdev_abort, (void *)fc_req);
} else if (nvmf_fc_req_in_xfer(fc_req)) {
/* Notify HBA to abort this exchange */
nvmf_fc_issue_abort(fc_req->hwqp, fc_req->xchg, NULL, NULL);
} else if (nvmf_fc_req_in_get_buff(fc_req)) {
/* Will be completed by request_complete callback. */
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "Abort req when getting buffers.\n");
} else if (nvmf_fc_req_in_pending(fc_req)) {
/* Remove from pending */
STAILQ_REMOVE(&fc_req->hwqp->fgroup->group.pending_buf_queue, &fc_req->req,
spdk_nvmf_request, buf_link);
goto complete;
} else {
/* Should never happen */
SPDK_ERRLOG("Request in invalid state\n");
goto complete;
}
return;
complete:
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_ABORTED);
nvmf_fc_poller_api_func(fc_req->hwqp, SPDK_NVMF_FC_POLLER_API_REQ_ABORT_COMPLETE,
(void *)fc_req);
}
static int
nvmf_fc_request_alloc_buffers(struct spdk_nvmf_fc_request *fc_req)
{
uint32_t length = fc_req->req.length;
struct spdk_nvmf_fc_poll_group *fgroup = fc_req->hwqp->fgroup;
struct spdk_nvmf_transport_poll_group *group = &fgroup->group;
struct spdk_nvmf_transport *transport = group->transport;
if (spdk_nvmf_request_get_buffers(&fc_req->req, group, transport, length)) {
return -ENOMEM;
}
return 0;
}
static int
nvmf_fc_request_execute(struct spdk_nvmf_fc_request *fc_req)
{
/* Allocate an XCHG if we dont use send frame for this command. */
if (!nvmf_fc_use_send_frame(&fc_req->req)) {
fc_req->xchg = nvmf_fc_get_xri(fc_req->hwqp);
if (!fc_req->xchg) {
fc_req->hwqp->counters.no_xchg++;
printf("NO XCHGs!\n");
goto pending;
}
}
if (fc_req->req.length) {
if (nvmf_fc_request_alloc_buffers(fc_req) < 0) {
fc_req->hwqp->counters.buf_alloc_err++;
goto pending;
}
fc_req->req.data = fc_req->req.iov[0].iov_base;
}
if (fc_req->req.xfer == SPDK_NVME_DATA_HOST_TO_CONTROLLER) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "WRITE CMD.\n");
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_WRITE_XFER);
if (nvmf_fc_recv_data(fc_req)) {
/* Dropped return success to caller */
fc_req->hwqp->counters.unexpected_err++;
_nvmf_fc_request_free(fc_req);
}
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "READ/NONE CMD\n");
if (fc_req->req.xfer == SPDK_NVME_DATA_CONTROLLER_TO_HOST) {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_READ_BDEV);
} else {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_NONE_BDEV);
}
spdk_nvmf_request_exec(&fc_req->req);
}
return 0;
pending:
if (fc_req->xchg) {
nvmf_fc_put_xchg(fc_req->hwqp, fc_req->xchg);
fc_req->xchg = NULL;
}
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_PENDING);
return -EAGAIN;
}
static int
nvmf_fc_hwqp_handle_request(struct spdk_nvmf_fc_hwqp *hwqp, struct spdk_nvmf_fc_frame_hdr *frame,
uint32_t buf_idx, struct spdk_nvmf_fc_buffer_desc *buffer, uint32_t plen)
{
uint16_t cmnd_len;
uint64_t rqst_conn_id;
struct spdk_nvmf_fc_request *fc_req = NULL;
struct spdk_nvmf_fc_cmnd_iu *cmd_iu = NULL;
struct spdk_nvmf_fc_conn *fc_conn = NULL;
enum spdk_nvme_data_transfer xfer;
cmd_iu = buffer->virt;
cmnd_len = cmd_iu->cmnd_iu_len;
cmnd_len = from_be16(&cmnd_len);
/* check for a valid cmnd_iu format */
if ((cmd_iu->fc_id != FCNVME_CMND_IU_FC_ID) ||
(cmd_iu->scsi_id != FCNVME_CMND_IU_SCSI_ID) ||
(cmnd_len != sizeof(struct spdk_nvmf_fc_cmnd_iu) / 4)) {
SPDK_ERRLOG("IU CMD error\n");
hwqp->counters.nvme_cmd_iu_err++;
return -ENXIO;
}
xfer = spdk_nvme_opc_get_data_transfer(cmd_iu->flags);
if (xfer == SPDK_NVME_DATA_BIDIRECTIONAL) {
SPDK_ERRLOG("IU CMD xfer error\n");
hwqp->counters.nvme_cmd_xfer_err++;
return -EPERM;
}
rqst_conn_id = from_be64(&cmd_iu->conn_id);
/* Check if conn id is valid */
fc_conn = nvmf_fc_hwqp_find_fc_conn(hwqp, rqst_conn_id);
if (!fc_conn) {
SPDK_ERRLOG("IU CMD conn(%ld) invalid\n", rqst_conn_id);
hwqp->counters.invalid_conn_err++;
return -ENODEV;
}
/* If association/connection is being deleted - return */
if (fc_conn->fc_assoc->assoc_state != SPDK_NVMF_FC_OBJECT_CREATED) {
SPDK_ERRLOG("Association state not valid\n");
return -EACCES;
}
if (fc_conn->qpair.state == SPDK_NVMF_QPAIR_ERROR) {
return -EACCES;
}
/* Make sure xfer len is according to mdts */
if (from_be32(&cmd_iu->data_len) >
hwqp->fgroup->group.transport->opts.max_io_size) {
SPDK_ERRLOG("IO length requested is greater than MDTS\n");
return -EINVAL;
}
/* allocate a request buffer */
fc_req = nvmf_fc_hwqp_alloc_fc_request(hwqp);
if (fc_req == NULL) {
/* Should not happen. Since fc_reqs == RQ buffers */
return -ENOMEM;
}
fc_req->req.length = from_be32(&cmd_iu->data_len);
fc_req->req.qpair = &fc_conn->qpair;
fc_req->req.cmd = (union nvmf_h2c_msg *)&cmd_iu->cmd;
fc_req->req.rsp = (union nvmf_c2h_msg *)&fc_req->ersp.rsp;
fc_req->oxid = frame->ox_id;
fc_req->oxid = from_be16(&fc_req->oxid);
fc_req->rpi = fc_conn->rpi;
fc_req->buf_index = buf_idx;
fc_req->poller_lcore = hwqp->lcore_id;
fc_req->poller_thread = hwqp->thread;
fc_req->hwqp = hwqp;
fc_req->fc_conn = fc_conn;
fc_req->req.xfer = xfer;
fc_req->s_id = (uint32_t)frame->s_id;
fc_req->d_id = (uint32_t)frame->d_id;
fc_req->s_id = from_be32(&fc_req->s_id) >> 8;
fc_req->d_id = from_be32(&fc_req->d_id) >> 8;
nvmf_fc_record_req_trace_point(fc_req, SPDK_NVMF_FC_REQ_INIT);
if (nvmf_fc_request_execute(fc_req)) {
STAILQ_INSERT_TAIL(&hwqp->fgroup->group.pending_buf_queue, &fc_req->req, buf_link);
}
return 0;
}
/*
* These functions are called from the FC LLD
*/
void
_nvmf_fc_request_free(struct spdk_nvmf_fc_request *fc_req)
{
struct spdk_nvmf_fc_hwqp *hwqp = fc_req->hwqp;
struct spdk_nvmf_fc_poll_group *fgroup = hwqp->fgroup;
struct spdk_nvmf_transport_poll_group *group = &fgroup->group;
struct spdk_nvmf_transport *transport = group->transport;
if (!fc_req) {
return;
}
if (fc_req->xchg) {
nvmf_fc_put_xchg(hwqp, fc_req->xchg);
fc_req->xchg = NULL;
}
/* Release IO buffers */
if (fc_req->req.data_from_pool) {
spdk_nvmf_request_free_buffers(&fc_req->req, group, transport);
}
fc_req->req.data = NULL;
fc_req->req.iovcnt = 0;
/* Release Q buffer */
nvmf_fc_rqpair_buffer_release(hwqp, fc_req->buf_index);
/* Free Fc request */
nvmf_fc_hwqp_free_fc_request(hwqp, fc_req);
}
void
nvmf_fc_request_set_state(struct spdk_nvmf_fc_request *fc_req,
enum spdk_nvmf_fc_request_state state)
{
assert(fc_req->magic != 0xDEADBEEF);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"FC Request(%p):\n\tState Old:%s New:%s\n", fc_req,
nvmf_fc_request_get_state_str(fc_req->state),
nvmf_fc_request_get_state_str(state));
nvmf_fc_record_req_trace_point(fc_req, state);
fc_req->state = state;
}
char *
nvmf_fc_request_get_state_str(int state)
{
static char *unk_str = "unknown";
return (state >= 0 && state < (int)(sizeof(fc_req_state_strs) / sizeof(char *)) ?
fc_req_state_strs[state] : unk_str);
}
int
nvmf_fc_hwqp_process_frame(struct spdk_nvmf_fc_hwqp *hwqp,
uint32_t buff_idx,
struct spdk_nvmf_fc_frame_hdr *frame,
struct spdk_nvmf_fc_buffer_desc *buffer,
uint32_t plen)
{
int rc = 0;
uint32_t s_id, d_id;
struct spdk_nvmf_fc_nport *nport = NULL;
struct spdk_nvmf_fc_remote_port_info *rport = NULL;
s_id = (uint32_t)frame->s_id;
d_id = (uint32_t)frame->d_id;
s_id = from_be32(&s_id) >> 8;
d_id = from_be32(&d_id) >> 8;
/* Note: In tracelog below, we directly do endian conversion on rx_id and.
* ox_id Since these are fields, we can't pass address to from_be16().
* Since ox_id and rx_id are only needed for tracelog, assigning to local
* vars. and doing conversion is a waste of time in non-debug builds. */
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC,
"Process NVME frame s_id:0x%x d_id:0x%x oxid:0x%x rxid:0x%x.\n",
s_id, d_id,
((frame->ox_id << 8) & 0xff00) | ((frame->ox_id >> 8) & 0xff),
((frame->rx_id << 8) & 0xff00) | ((frame->rx_id >> 8) & 0xff));
rc = nvmf_fc_hwqp_find_nport_and_rport(hwqp, d_id, &nport, s_id, &rport);
if (rc) {
if (nport == NULL) {
SPDK_ERRLOG("Nport not found. Dropping\n");
/* increment invalid nport counter */
hwqp->counters.nport_invalid++;
} else if (rport == NULL) {
SPDK_ERRLOG("Rport not found. Dropping\n");
/* increment invalid rport counter */
hwqp->counters.rport_invalid++;
}
return rc;
}
if (nport->nport_state != SPDK_NVMF_FC_OBJECT_CREATED ||
rport->rport_state != SPDK_NVMF_FC_OBJECT_CREATED) {
SPDK_ERRLOG("%s state not created. Dropping\n",
nport->nport_state != SPDK_NVMF_FC_OBJECT_CREATED ?
"Nport" : "Rport");
return -EACCES;
}
if ((frame->r_ctl == FCNVME_R_CTL_LS_REQUEST) &&
(frame->type == FCNVME_TYPE_NVMF_DATA)) {
struct spdk_nvmf_fc_rq_buf_ls_request *req_buf = buffer->virt;
struct spdk_nvmf_fc_ls_rqst *ls_rqst;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "Process LS NVME frame\n");
/* Use the RQ buffer for holding LS request. */
ls_rqst = (struct spdk_nvmf_fc_ls_rqst *)&req_buf->ls_rqst;
/* Fill in the LS request structure */
ls_rqst->rqstbuf.virt = (void *)&req_buf->rqst;
ls_rqst->rqstbuf.phys = buffer->phys +
offsetof(struct spdk_nvmf_fc_rq_buf_ls_request, rqst);
ls_rqst->rqstbuf.buf_index = buff_idx;
ls_rqst->rqst_len = plen;
ls_rqst->rspbuf.virt = (void *)&req_buf->resp;
ls_rqst->rspbuf.phys = buffer->phys +
offsetof(struct spdk_nvmf_fc_rq_buf_ls_request, resp);
ls_rqst->rsp_len = FCNVME_MAX_LS_RSP_SIZE;
ls_rqst->private_data = (void *)hwqp;
ls_rqst->rpi = rport->rpi;
ls_rqst->oxid = (uint16_t)frame->ox_id;
ls_rqst->oxid = from_be16(&ls_rqst->oxid);
ls_rqst->s_id = s_id;
ls_rqst->d_id = d_id;
ls_rqst->nport = nport;
ls_rqst->rport = rport;
ls_rqst->nvmf_tgt = g_nvmf_ftransport->transport.tgt;
ls_rqst->xchg = nvmf_fc_get_xri(hwqp);
if (ls_rqst->xchg) {
/* Handover the request to LS module */
nvmf_fc_handle_ls_rqst(ls_rqst);
} else {
/* No XCHG available. Add to pending list. */
hwqp->counters.no_xchg++;
TAILQ_INSERT_TAIL(&hwqp->ls_pending_queue, ls_rqst, ls_pending_link);
}
} else if ((frame->r_ctl == FCNVME_R_CTL_CMD_REQ) &&
(frame->type == FCNVME_TYPE_FC_EXCHANGE)) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "Process IO NVME frame\n");
rc = nvmf_fc_hwqp_handle_request(hwqp, frame, buff_idx, buffer, plen);
} else {
SPDK_ERRLOG("Unknown frame received. Dropping\n");
hwqp->counters.unknown_frame++;
rc = -EINVAL;
}
return rc;
}
void
nvmf_fc_hwqp_process_pending_reqs(struct spdk_nvmf_fc_hwqp *hwqp)
{
struct spdk_nvmf_request *req = NULL, *tmp;
struct spdk_nvmf_fc_request *fc_req;
int budget = 64;
if (!hwqp->fgroup) {
/* LS queue is tied to acceptor_poll group and LS pending requests
* are stagged and processed using hwqp->ls_pending_queue.
*/
return;
}
STAILQ_FOREACH_SAFE(req, &hwqp->fgroup->group.pending_buf_queue, buf_link, tmp) {
fc_req = SPDK_CONTAINEROF(req, struct spdk_nvmf_fc_request, req);
if (!nvmf_fc_request_execute(fc_req)) {
/* Succesfuly posted, Delete from pending. */
STAILQ_REMOVE_HEAD(&hwqp->fgroup->group.pending_buf_queue, buf_link);
}
if (budget) {
budget--;
} else {
return;
}
}
}
void
nvmf_fc_hwqp_process_pending_ls_rqsts(struct spdk_nvmf_fc_hwqp *hwqp)
{
struct spdk_nvmf_fc_ls_rqst *ls_rqst = NULL, *tmp;
struct spdk_nvmf_fc_nport *nport = NULL;
struct spdk_nvmf_fc_remote_port_info *rport = NULL;
TAILQ_FOREACH_SAFE(ls_rqst, &hwqp->ls_pending_queue, ls_pending_link, tmp) {
/* lookup nport and rport again - make sure they are still valid */
int rc = nvmf_fc_hwqp_find_nport_and_rport(hwqp, ls_rqst->d_id, &nport, ls_rqst->s_id, &rport);
if (rc) {
if (nport == NULL) {
SPDK_ERRLOG("Nport not found. Dropping\n");
/* increment invalid nport counter */
hwqp->counters.nport_invalid++;
} else if (rport == NULL) {
SPDK_ERRLOG("Rport not found. Dropping\n");
/* increment invalid rport counter */
hwqp->counters.rport_invalid++;
}
TAILQ_REMOVE(&hwqp->ls_pending_queue, ls_rqst, ls_pending_link);
/* Return buffer to chip */
nvmf_fc_rqpair_buffer_release(hwqp, ls_rqst->rqstbuf.buf_index);
continue;
}
if (nport->nport_state != SPDK_NVMF_FC_OBJECT_CREATED ||
rport->rport_state != SPDK_NVMF_FC_OBJECT_CREATED) {
SPDK_ERRLOG("%s state not created. Dropping\n",
nport->nport_state != SPDK_NVMF_FC_OBJECT_CREATED ?
"Nport" : "Rport");
TAILQ_REMOVE(&hwqp->ls_pending_queue, ls_rqst, ls_pending_link);
/* Return buffer to chip */
nvmf_fc_rqpair_buffer_release(hwqp, ls_rqst->rqstbuf.buf_index);
continue;
}
ls_rqst->xchg = nvmf_fc_get_xri(hwqp);
if (ls_rqst->xchg) {
/* Got an XCHG */
TAILQ_REMOVE(&hwqp->ls_pending_queue, ls_rqst, ls_pending_link);
/* Handover the request to LS module */
nvmf_fc_handle_ls_rqst(ls_rqst);
} else {
/* No more XCHGs. Stop processing. */
hwqp->counters.no_xchg++;
return;
}
}
}
int
nvmf_fc_handle_rsp(struct spdk_nvmf_fc_request *fc_req)
{
int rc = 0;
struct spdk_nvmf_request *req = &fc_req->req;
struct spdk_nvmf_qpair *qpair = req->qpair;
struct spdk_nvmf_fc_conn *fc_conn = nvmf_fc_get_conn(qpair);
struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
uint16_t ersp_len = 0;
/* set sq head value in resp */
rsp->sqhd = nvmf_fc_advance_conn_sqhead(qpair);
/* Increment connection responses */
fc_conn->rsp_count++;
if (nvmf_fc_send_ersp_required(fc_req, fc_conn->rsp_count,
fc_req->transfered_len)) {
/* Fill ERSP Len */
to_be16(&ersp_len, (sizeof(struct spdk_nvmf_fc_ersp_iu) /
sizeof(uint32_t)));
fc_req->ersp.ersp_len = ersp_len;
/* Fill RSN */
to_be32(&fc_req->ersp.response_seq_no, fc_conn->rsn);
fc_conn->rsn++;
/* Fill transfer length */
to_be32(&fc_req->ersp.transferred_data_len, fc_req->transfered_len);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "Posting ERSP.\n");
rc = nvmf_fc_xmt_rsp(fc_req, (uint8_t *)&fc_req->ersp,
sizeof(struct spdk_nvmf_fc_ersp_iu));
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC, "Posting RSP.\n");
rc = nvmf_fc_xmt_rsp(fc_req, NULL, 0);
}
return rc;
}
bool
nvmf_fc_send_ersp_required(struct spdk_nvmf_fc_request *fc_req,
uint32_t rsp_cnt, uint32_t xfer_len)
{
struct spdk_nvmf_request *req = &fc_req->req;
struct spdk_nvmf_qpair *qpair = req->qpair;
struct spdk_nvmf_fc_conn *fc_conn = nvmf_fc_get_conn(qpair);
struct spdk_nvme_cmd *cmd = &req->cmd->nvme_cmd;
struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
uint16_t status = *((uint16_t *)&rsp->status);
/*
* Check if we need to send ERSP
* 1) For every N responses where N == ersp_ratio
* 2) Fabric commands.
* 3) Completion status failed or Completion dw0 or dw1 valid.
* 4) SQ == 90% full.
* 5) Transfer length not equal to CMD IU length
*/
if (!(rsp_cnt % fc_conn->esrp_ratio) ||
(cmd->opc == SPDK_NVME_OPC_FABRIC) ||
(status & 0xFFFE) || rsp->cdw0 || rsp->rsvd1 ||
(req->length != xfer_len)) {
return true;
}
return false;
}
static int
nvmf_fc_request_complete(struct spdk_nvmf_request *req)
{
int rc = 0;
struct spdk_nvmf_fc_request *fc_req = nvmf_fc_get_fc_req(req);
struct spdk_nvme_cpl *rsp = &req->rsp->nvme_cpl;
if (fc_req->is_aborted) {
/* Defer this to make sure we dont call io cleanup in same context. */
nvmf_fc_poller_api_func(fc_req->hwqp, SPDK_NVMF_FC_POLLER_API_REQ_ABORT_COMPLETE,
(void *)fc_req);
} else if (rsp->status.sc == SPDK_NVME_SC_SUCCESS &&
req->xfer == SPDK_NVME_DATA_CONTROLLER_TO_HOST) {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_READ_XFER);
rc = nvmf_fc_send_data(fc_req);
} else {
if (req->xfer == SPDK_NVME_DATA_HOST_TO_CONTROLLER) {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_WRITE_RSP);
} else if (req->xfer == SPDK_NVME_DATA_CONTROLLER_TO_HOST) {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_READ_RSP);
} else {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_NONE_RSP);
}
rc = nvmf_fc_handle_rsp(fc_req);
}
if (rc) {
SPDK_ERRLOG("Error in request complete.\n");
_nvmf_fc_request_free(fc_req);
}
return 0;
}
struct spdk_nvmf_tgt *
nvmf_fc_get_tgt(void)
{
if (g_nvmf_ftransport) {
return g_nvmf_ftransport->transport.tgt;
}
return NULL;
}
/*
* FC Transport Public API begins here
*/
#define SPDK_NVMF_FC_DEFAULT_MAX_QUEUE_DEPTH 128
#define SPDK_NVMF_FC_DEFAULT_AQ_DEPTH 32
#define SPDK_NVMF_FC_DEFAULT_MAX_QPAIRS_PER_CTRLR 5
#define SPDK_NVMF_FC_DEFAULT_IN_CAPSULE_DATA_SIZE 0
#define SPDK_NVMF_FC_DEFAULT_MAX_IO_SIZE 65536
#define SPDK_NVMF_FC_DEFAULT_IO_UNIT_SIZE 4096
#define SPDK_NVMF_FC_DEFAULT_NUM_SHARED_BUFFERS 8192
#define SPDK_NVMF_FC_DEFAULT_MAX_SGE (SPDK_NVMF_FC_DEFAULT_MAX_IO_SIZE / \
SPDK_NVMF_FC_DEFAULT_IO_UNIT_SIZE)
static void
nvmf_fc_opts_init(struct spdk_nvmf_transport_opts *opts)
{
opts->max_queue_depth = SPDK_NVMF_FC_DEFAULT_MAX_QUEUE_DEPTH;
opts->max_qpairs_per_ctrlr = SPDK_NVMF_FC_DEFAULT_MAX_QPAIRS_PER_CTRLR;
opts->in_capsule_data_size = SPDK_NVMF_FC_DEFAULT_IN_CAPSULE_DATA_SIZE;
opts->max_io_size = SPDK_NVMF_FC_DEFAULT_MAX_IO_SIZE;
opts->io_unit_size = SPDK_NVMF_FC_DEFAULT_IO_UNIT_SIZE;
opts->max_aq_depth = SPDK_NVMF_FC_DEFAULT_AQ_DEPTH;
opts->num_shared_buffers = SPDK_NVMF_FC_DEFAULT_NUM_SHARED_BUFFERS;
}
static struct spdk_nvmf_transport *
nvmf_fc_create(struct spdk_nvmf_transport_opts *opts)
{
uint32_t sge_count;
SPDK_INFOLOG(SPDK_LOG_NVMF_FC, "*** FC Transport Init ***\n"
" Transport opts: max_ioq_depth=%d, max_io_size=%d,\n"
" max_io_qpairs_per_ctrlr=%d, io_unit_size=%d,\n"
" max_aq_depth=%d\n",
opts->max_queue_depth,
opts->max_io_size,
opts->max_qpairs_per_ctrlr - 1,
opts->io_unit_size,
opts->max_aq_depth);
if (g_nvmf_ftransport) {
SPDK_ERRLOG("Duplicate NVMF-FC transport create request!\n");
return NULL;
}
if (spdk_env_get_last_core() < 1) {
SPDK_ERRLOG("Not enough cores/threads (%d) to run NVMF-FC transport!\n",
spdk_env_get_last_core() + 1);
return NULL;
}
sge_count = opts->max_io_size / opts->io_unit_size;
if (sge_count > SPDK_NVMF_FC_DEFAULT_MAX_SGE) {
SPDK_ERRLOG("Unsupported IO Unit size specified, %d bytes\n", opts->io_unit_size);
return NULL;
}
g_nvmf_fc_master_thread = spdk_get_thread();
g_nvmf_fgroup_count = 0;
g_nvmf_ftransport = calloc(1, sizeof(*g_nvmf_ftransport));
if (!g_nvmf_ftransport) {
SPDK_ERRLOG("Failed to allocate NVMF-FC transport\n");
return NULL;
}
if (pthread_mutex_init(&g_nvmf_ftransport->lock, NULL)) {
SPDK_ERRLOG("pthread_mutex_init() failed\n");
free(g_nvmf_ftransport);
g_nvmf_ftransport = NULL;
return NULL;
}
/* initialize the low level FC driver */
nvmf_fc_lld_init();
return &g_nvmf_ftransport->transport;
}
static int
nvmf_fc_destroy(struct spdk_nvmf_transport *transport)
{
if (transport) {
struct spdk_nvmf_fc_transport *ftransport;
struct spdk_nvmf_fc_poll_group *fgroup, *pg_tmp;
ftransport = SPDK_CONTAINEROF(transport, struct spdk_nvmf_fc_transport, transport);
free(ftransport);
/* clean up any FC poll groups still around */
TAILQ_FOREACH_SAFE(fgroup, &g_nvmf_fgroups, link, pg_tmp) {
TAILQ_REMOVE(&g_nvmf_fgroups, fgroup, link);
free(fgroup);
}
g_nvmf_fgroup_count = 0;
/* low level FC driver clean up */
nvmf_fc_lld_fini();
nvmf_fc_port_cleanup();
}
return 0;
}
static int
nvmf_fc_listen(struct spdk_nvmf_transport *transport,
const struct spdk_nvme_transport_id *trid)
{
return 0;
}
static void
nvmf_fc_stop_listen(struct spdk_nvmf_transport *transport,
const struct spdk_nvme_transport_id *_trid)
{
}
static uint32_t
nvmf_fc_accept(struct spdk_nvmf_transport *transport)
{
struct spdk_nvmf_fc_port *fc_port = NULL;
uint32_t count = 0;
static bool start_lld = false;
if (spdk_unlikely(!start_lld)) {
start_lld = true;
nvmf_fc_lld_start();
}
/* poll the LS queue on each port */
TAILQ_FOREACH(fc_port, &g_spdk_nvmf_fc_port_list, link) {
if (fc_port->hw_port_status == SPDK_FC_PORT_ONLINE) {
count += nvmf_fc_process_queue(&fc_port->ls_queue);
}
}
return count;
}
static void
nvmf_fc_discover(struct spdk_nvmf_transport *transport,
struct spdk_nvme_transport_id *trid,
struct spdk_nvmf_discovery_log_page_entry *entry)
{
entry->trtype = (enum spdk_nvme_transport_type) SPDK_NVMF_TRTYPE_FC;
entry->adrfam = trid->adrfam;
entry->treq.secure_channel = SPDK_NVMF_TREQ_SECURE_CHANNEL_NOT_SPECIFIED;
spdk_strcpy_pad(entry->trsvcid, trid->trsvcid, sizeof(entry->trsvcid), ' ');
spdk_strcpy_pad(entry->traddr, trid->traddr, sizeof(entry->traddr), ' ');
}
static struct spdk_nvmf_transport_poll_group *
nvmf_fc_poll_group_create(struct spdk_nvmf_transport *transport)
{
struct spdk_nvmf_fc_poll_group *fgroup;
struct spdk_nvmf_fc_transport *ftransport =
SPDK_CONTAINEROF(transport, struct spdk_nvmf_fc_transport, transport);
fgroup = calloc(1, sizeof(struct spdk_nvmf_fc_poll_group));
if (!fgroup) {
SPDK_ERRLOG("Unable to alloc FC poll group\n");
return NULL;
}
TAILQ_INIT(&fgroup->hwqp_list);
pthread_mutex_lock(&ftransport->lock);
TAILQ_INSERT_TAIL(&g_nvmf_fgroups, fgroup, link);
g_nvmf_fgroup_count++;
pthread_mutex_unlock(&ftransport->lock);
return &fgroup->group;
}
static void
nvmf_fc_poll_group_destroy(struct spdk_nvmf_transport_poll_group *group)
{
struct spdk_nvmf_fc_poll_group *fgroup;
struct spdk_nvmf_fc_transport *ftransport =
SPDK_CONTAINEROF(group->transport, struct spdk_nvmf_fc_transport, transport);
fgroup = SPDK_CONTAINEROF(group, struct spdk_nvmf_fc_poll_group, group);
pthread_mutex_lock(&ftransport->lock);
TAILQ_REMOVE(&g_nvmf_fgroups, fgroup, link);
g_nvmf_fgroup_count--;
pthread_mutex_unlock(&ftransport->lock);
free(fgroup);
}
static int
nvmf_fc_poll_group_add(struct spdk_nvmf_transport_poll_group *group,
struct spdk_nvmf_qpair *qpair)
{
struct spdk_nvmf_fc_poll_group *fgroup;
struct spdk_nvmf_fc_conn *fc_conn;
struct spdk_nvmf_fc_hwqp *hwqp = NULL;
struct spdk_nvmf_fc_ls_add_conn_api_data *api_data = NULL;
bool hwqp_found = false;
fgroup = SPDK_CONTAINEROF(group, struct spdk_nvmf_fc_poll_group, group);
fc_conn = SPDK_CONTAINEROF(qpair, struct spdk_nvmf_fc_conn, qpair);
TAILQ_FOREACH(hwqp, &fgroup->hwqp_list, link) {
if (fc_conn->fc_assoc->tgtport->fc_port == hwqp->fc_port) {
hwqp_found = true;
break;
}
}
if (!hwqp_found) {
SPDK_ERRLOG("No valid hwqp found for new QP.\n");
goto err;
}
if (!nvmf_fc_assign_conn_to_hwqp(hwqp,
&fc_conn->conn_id,
fc_conn->max_queue_depth)) {
SPDK_ERRLOG("Failed to get a connection id for new QP.\n");
goto err;
}
fc_conn->hwqp = hwqp;
/* If this is for ADMIN connection, then update assoc ID. */
if (fc_conn->qpair.qid == 0) {
fc_conn->fc_assoc->assoc_id = fc_conn->conn_id;
}
api_data = &fc_conn->create_opd->u.add_conn;
nvmf_fc_poller_api_func(hwqp, SPDK_NVMF_FC_POLLER_API_ADD_CONNECTION, &api_data->args);
return 0;
err:
return -1;
}
static int
nvmf_fc_poll_group_poll(struct spdk_nvmf_transport_poll_group *group)
{
uint32_t count = 0;
struct spdk_nvmf_fc_poll_group *fgroup;
struct spdk_nvmf_fc_hwqp *hwqp;
fgroup = SPDK_CONTAINEROF(group, struct spdk_nvmf_fc_poll_group, group);
TAILQ_FOREACH(hwqp, &fgroup->hwqp_list, link) {
if (hwqp->state == SPDK_FC_HWQP_ONLINE) {
count += nvmf_fc_process_queue(hwqp);
}
}
return (int) count;
}
static int
nvmf_fc_request_free(struct spdk_nvmf_request *req)
{
struct spdk_nvmf_fc_request *fc_req = nvmf_fc_get_fc_req(req);
if (!fc_req->is_aborted) {
nvmf_fc_request_set_state(fc_req, SPDK_NVMF_FC_REQ_BDEV_ABORTED);
nvmf_fc_request_abort(fc_req, true, NULL, NULL);
} else {
nvmf_fc_request_abort_complete(fc_req);
}
return 0;
}
static void
nvmf_fc_close_qpair(struct spdk_nvmf_qpair *qpair)
{
struct spdk_nvmf_fc_conn *fc_conn;
fc_conn = SPDK_CONTAINEROF(qpair, struct spdk_nvmf_fc_conn, qpair);
if (fc_conn->conn_id == NVMF_FC_INVALID_CONN_ID) {
/* QP creation failure in FC tranport. Cleanup. */
spdk_thread_send_msg(nvmf_fc_get_master_thread(),
nvmf_fc_handle_connection_failure, fc_conn);
} else if (fc_conn->fc_assoc->assoc_id == fc_conn->conn_id &&
fc_conn->fc_assoc->assoc_state != SPDK_NVMF_FC_OBJECT_TO_BE_DELETED) {
/* Admin connection */
spdk_thread_send_msg(nvmf_fc_get_master_thread(),
nvmf_fc_handle_assoc_deletion, fc_conn);
}
}
static int
nvmf_fc_qpair_get_peer_trid(struct spdk_nvmf_qpair *qpair,
struct spdk_nvme_transport_id *trid)
{
struct spdk_nvmf_fc_conn *fc_conn;
fc_conn = SPDK_CONTAINEROF(qpair, struct spdk_nvmf_fc_conn, qpair);
memcpy(trid, &fc_conn->trid, sizeof(struct spdk_nvme_transport_id));
return 0;
}
static int
nvmf_fc_qpair_get_local_trid(struct spdk_nvmf_qpair *qpair,
struct spdk_nvme_transport_id *trid)
{
struct spdk_nvmf_fc_conn *fc_conn;
fc_conn = SPDK_CONTAINEROF(qpair, struct spdk_nvmf_fc_conn, qpair);
memcpy(trid, &fc_conn->trid, sizeof(struct spdk_nvme_transport_id));
return 0;
}
static int
nvmf_fc_qpair_get_listen_trid(struct spdk_nvmf_qpair *qpair,
struct spdk_nvme_transport_id *trid)
{
struct spdk_nvmf_fc_conn *fc_conn;
fc_conn = SPDK_CONTAINEROF(qpair, struct spdk_nvmf_fc_conn, qpair);
memcpy(trid, &fc_conn->trid, sizeof(struct spdk_nvme_transport_id));
return 0;
}
static void
nvmf_fc_qpair_abort_request(struct spdk_nvmf_qpair *qpair,
struct spdk_nvmf_request *req)
{
spdk_nvmf_request_complete(req);
}
const struct spdk_nvmf_transport_ops spdk_nvmf_transport_fc = {
.name = "FC",
.type = (enum spdk_nvme_transport_type) SPDK_NVMF_TRTYPE_FC,
.opts_init = nvmf_fc_opts_init,
.create = nvmf_fc_create,
.destroy = nvmf_fc_destroy,
.listen = nvmf_fc_listen,
.stop_listen = nvmf_fc_stop_listen,
.accept = nvmf_fc_accept,
.listener_discover = nvmf_fc_discover,
.poll_group_create = nvmf_fc_poll_group_create,
.poll_group_destroy = nvmf_fc_poll_group_destroy,
.poll_group_add = nvmf_fc_poll_group_add,
.poll_group_poll = nvmf_fc_poll_group_poll,
.req_complete = nvmf_fc_request_complete,
.req_free = nvmf_fc_request_free,
.qpair_fini = nvmf_fc_close_qpair,
.qpair_get_peer_trid = nvmf_fc_qpair_get_peer_trid,
.qpair_get_local_trid = nvmf_fc_qpair_get_local_trid,
.qpair_get_listen_trid = nvmf_fc_qpair_get_listen_trid,
.qpair_abort_request = nvmf_fc_qpair_abort_request,
};
/*
* Re-initialize the FC-Port after an offline event.
* Only the queue information needs to be populated. XCHG, lcore and other hwqp information remains
* unchanged after the first initialization.
*
*/
static int
nvmf_fc_adm_hw_port_reinit_validate(struct spdk_nvmf_fc_port *fc_port,
struct spdk_nvmf_fc_hw_port_init_args *args)
{
uint32_t i;
/* Verify that the port was previously in offline or quiesced state */
if (nvmf_fc_port_is_online(fc_port)) {
SPDK_ERRLOG("SPDK FC port %d already initialized and online.\n", args->port_handle);
return -EINVAL;
}
/* Reinit information in new LS queue from previous queue */
nvmf_fc_hwqp_reinit_poller_queues(&fc_port->ls_queue, args->ls_queue);
fc_port->fcp_rq_id = args->fcp_rq_id;
/* Initialize the LS queue */
fc_port->ls_queue.queues = args->ls_queue;
nvmf_fc_init_poller_queues(fc_port->ls_queue.queues);
for (i = 0; i < fc_port->num_io_queues; i++) {
/* Reinit information in new IO queue from previous queue */
nvmf_fc_hwqp_reinit_poller_queues(&fc_port->io_queues[i],
args->io_queues[i]);
fc_port->io_queues[i].queues = args->io_queues[i];
/* Initialize the IO queues */
nvmf_fc_init_poller_queues(fc_port->io_queues[i].queues);
}
fc_port->hw_port_status = SPDK_FC_PORT_OFFLINE;
/* Validate the port information */
DEV_VERIFY(TAILQ_EMPTY(&fc_port->nport_list));
DEV_VERIFY(fc_port->num_nports == 0);
if (!TAILQ_EMPTY(&fc_port->nport_list) || (fc_port->num_nports != 0)) {
return -EINVAL;
}
return 0;
}
/* Initializes the data for the creation of a FC-Port object in the SPDK
* library. The spdk_nvmf_fc_port is a well defined structure that is part of
* the API to the library. The contents added to this well defined structure
* is private to each vendors implementation.
*/
static int
nvmf_fc_adm_hw_port_data_init(struct spdk_nvmf_fc_port *fc_port,
struct spdk_nvmf_fc_hw_port_init_args *args)
{
/* Used a high number for the LS HWQP so that it does not clash with the
* IO HWQP's and immediately shows a LS queue during tracing.
*/
uint32_t i;
fc_port->port_hdl = args->port_handle;
fc_port->hw_port_status = SPDK_FC_PORT_OFFLINE;
fc_port->fcp_rq_id = args->fcp_rq_id;
fc_port->num_io_queues = args->io_queue_cnt;
/*
* Set port context from init args. Used for FCP port stats.
*/
fc_port->port_ctx = args->port_ctx;
/*
* Initialize the LS queue wherever needed.
*/
fc_port->ls_queue.queues = args->ls_queue;
fc_port->ls_queue.thread = nvmf_fc_get_master_thread();
fc_port->ls_queue.hwqp_id = SPDK_MAX_NUM_OF_FC_PORTS * fc_port->num_io_queues;
/*
* Initialize the LS queue.
*/
nvmf_fc_init_hwqp(fc_port, &fc_port->ls_queue);
/*
* Initialize the IO queues.
*/
for (i = 0; i < args->io_queue_cnt; i++) {
struct spdk_nvmf_fc_hwqp *hwqp = &fc_port->io_queues[i];
hwqp->hwqp_id = i;
hwqp->queues = args->io_queues[i];
hwqp->rq_size = args->io_queue_size;
nvmf_fc_init_hwqp(fc_port, hwqp);
}
/*
* Initialize the LS processing for port
*/
nvmf_fc_ls_init(fc_port);
/*
* Initialize the list of nport on this HW port.
*/
TAILQ_INIT(&fc_port->nport_list);
fc_port->num_nports = 0;
return 0;
}
static void
nvmf_fc_adm_port_hwqp_offline_del_poller(struct spdk_nvmf_fc_port *fc_port)
{
struct spdk_nvmf_fc_hwqp *hwqp = NULL;
int i = 0;
hwqp = &fc_port->ls_queue;
(void)nvmf_fc_hwqp_set_offline(hwqp);
/* Remove poller for all the io queues. */
for (i = 0; i < (int)fc_port->num_io_queues; i++) {
hwqp = &fc_port->io_queues[i];
(void)nvmf_fc_hwqp_set_offline(hwqp);
nvmf_fc_poll_group_remove_hwqp(hwqp);
}
}
/*
* Callback function for HW port link break operation.
*
* Notice that this callback is being triggered when spdk_fc_nport_delete()
* completes, if that spdk_fc_nport_delete() called is issued by
* nvmf_fc_adm_evnt_hw_port_link_break().
*
* Since nvmf_fc_adm_evnt_hw_port_link_break() can invoke spdk_fc_nport_delete() multiple
* times (one per nport in the HW port's nport_list), a single call to
* nvmf_fc_adm_evnt_hw_port_link_break() can result in multiple calls to this callback function.
*
* As a result, this function only invokes a callback to the caller of
* nvmf_fc_adm_evnt_hw_port_link_break() only when the HW port's nport_list is empty.
*/
static void
nvmf_fc_adm_hw_port_link_break_cb(uint8_t port_handle,
enum spdk_fc_event event_type, void *cb_args, int spdk_err)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_port_link_break_cb_data *offline_cb_args = cb_args;
struct spdk_nvmf_hw_port_link_break_args *offline_args = NULL;
spdk_nvmf_fc_callback cb_func = NULL;
int err = 0;
struct spdk_nvmf_fc_port *fc_port = NULL;
int num_nports = 0;
char log_str[256];
if (0 != spdk_err) {
DEV_VERIFY(!"port link break cb: spdk_err not success.");
SPDK_ERRLOG("port link break cb: spdk_err:%d.\n", spdk_err);
goto out;
}
if (!offline_cb_args) {
DEV_VERIFY(!"port link break cb: port_offline_args is NULL.");
err = -EINVAL;
goto out;
}
offline_args = offline_cb_args->args;
if (!offline_args) {
DEV_VERIFY(!"port link break cb: offline_args is NULL.");
err = -EINVAL;
goto out;
}
if (port_handle != offline_args->port_handle) {
DEV_VERIFY(!"port link break cb: port_handle mismatch.");
err = -EINVAL;
goto out;
}
cb_func = offline_cb_args->cb_func;
if (!cb_func) {
DEV_VERIFY(!"port link break cb: cb_func is NULL.");
err = -EINVAL;
goto out;
}
fc_port = nvmf_fc_port_lookup(port_handle);
if (!fc_port) {
DEV_VERIFY(!"port link break cb: fc_port is NULL.");
SPDK_ERRLOG("port link break cb: Unable to find port:%d\n",
offline_args->port_handle);
err = -EINVAL;
goto out;
}
num_nports = fc_port->num_nports;
if (!TAILQ_EMPTY(&fc_port->nport_list)) {
/*
* Don't call the callback unless all nports have been deleted.
*/
goto out;
}
if (num_nports != 0) {
DEV_VERIFY(!"port link break cb: num_nports in non-zero.");
SPDK_ERRLOG("port link break cb: # of ports should be 0. Instead, num_nports:%d\n",
num_nports);
err = -EINVAL;
}
/*
* Mark the hwqps as offline and unregister the pollers.
*/
(void)nvmf_fc_adm_port_hwqp_offline_del_poller(fc_port);
/*
* Since there are no more nports, execute the callback(s).
*/
(void)cb_func(port_handle, SPDK_FC_LINK_BREAK,
(void *)offline_args->cb_ctx, spdk_err);
out:
free(offline_cb_args);
snprintf(log_str, sizeof(log_str),
"port link break cb: port:%d evt_type:%d num_nports:%d err:%d spdk_err:%d.\n",
port_handle, event_type, num_nports, err, spdk_err);
if (err != 0) {
SPDK_ERRLOG("%s", log_str);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
}
return;
}
/*
* FC port must have all its nports deleted before transitioning to offline state.
*/
static void
nvmf_fc_adm_hw_port_offline_nport_delete(struct spdk_nvmf_fc_port *fc_port)
{
struct spdk_nvmf_fc_nport *nport = NULL;
/* All nports must have been deleted at this point for this fc port */
DEV_VERIFY(fc_port && TAILQ_EMPTY(&fc_port->nport_list));
DEV_VERIFY(fc_port->num_nports == 0);
/* Mark the nport states to be zombie, if they exist */
if (fc_port && !TAILQ_EMPTY(&fc_port->nport_list)) {
TAILQ_FOREACH(nport, &fc_port->nport_list, link) {
(void)nvmf_fc_nport_set_state(nport, SPDK_NVMF_FC_OBJECT_ZOMBIE);
}
}
}
static void
nvmf_fc_adm_i_t_delete_cb(void *args, uint32_t err)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_i_t_del_cb_data *cb_data = args;
struct spdk_nvmf_fc_nport *nport = cb_data->nport;
struct spdk_nvmf_fc_remote_port_info *rport = cb_data->rport;
spdk_nvmf_fc_callback cb_func = cb_data->fc_cb_func;
int spdk_err = 0;
uint8_t port_handle = cb_data->port_handle;
uint32_t s_id = rport->s_id;
uint32_t rpi = rport->rpi;
uint32_t assoc_count = rport->assoc_count;
uint32_t nport_hdl = nport->nport_hdl;
uint32_t d_id = nport->d_id;
char log_str[256];
/*
* Assert on any delete failure.
*/
if (0 != err) {
DEV_VERIFY(!"Error in IT Delete callback.");
goto out;
}
if (cb_func != NULL) {
(void)cb_func(port_handle, SPDK_FC_IT_DELETE, cb_data->fc_cb_ctx, spdk_err);
}
out:
free(cb_data);
snprintf(log_str, sizeof(log_str),
"IT delete assoc_cb on nport %d done, port_handle:%d s_id:%d d_id:%d rpi:%d rport_assoc_count:%d rc = %d.\n",
nport_hdl, port_handle, s_id, d_id, rpi, assoc_count, err);
if (err != 0) {
SPDK_ERRLOG("%s", log_str);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
}
}
static void
nvmf_fc_adm_i_t_delete_assoc_cb(void *args, uint32_t err)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_i_t_del_assoc_cb_data *cb_data = args;
struct spdk_nvmf_fc_nport *nport = cb_data->nport;
struct spdk_nvmf_fc_remote_port_info *rport = cb_data->rport;
spdk_nvmf_fc_adm_i_t_delete_assoc_cb_fn cb_func = cb_data->cb_func;
uint32_t s_id = rport->s_id;
uint32_t rpi = rport->rpi;
uint32_t assoc_count = rport->assoc_count;
uint32_t nport_hdl = nport->nport_hdl;
uint32_t d_id = nport->d_id;
char log_str[256];
/*
* Assert on any association delete failure. We continue to delete other
* associations in promoted builds.
*/
if (0 != err) {
DEV_VERIFY(!"Nport's association delete callback returned error");
if (nport->assoc_count > 0) {
nport->assoc_count--;
}
if (rport->assoc_count > 0) {
rport->assoc_count--;
}
}
/*
* If this is the last association being deleted for the ITN,
* execute the callback(s).
*/
if (0 == rport->assoc_count) {
/* Remove the rport from the remote port list. */
if (nvmf_fc_nport_remove_rem_port(nport, rport) != 0) {
SPDK_ERRLOG("Error while removing rport from list.\n");
DEV_VERIFY(!"Error while removing rport from list.");
}
if (cb_func != NULL) {
/*
* Callback function is provided by the caller
* of nvmf_fc_adm_i_t_delete_assoc().
*/
(void)cb_func(cb_data->cb_ctx, 0);
}
free(rport);
free(args);
}
snprintf(log_str, sizeof(log_str),
"IT delete assoc_cb on nport %d done, s_id:%d d_id:%d rpi:%d rport_assoc_count:%d err = %d.\n",
nport_hdl, s_id, d_id, rpi, assoc_count, err);
if (err != 0) {
SPDK_ERRLOG("%s", log_str);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
}
}
/**
* Process a IT delete.
*/
static void
nvmf_fc_adm_i_t_delete_assoc(struct spdk_nvmf_fc_nport *nport,
struct spdk_nvmf_fc_remote_port_info *rport,
spdk_nvmf_fc_adm_i_t_delete_assoc_cb_fn cb_func,
void *cb_ctx)
{
int err = 0;
struct spdk_nvmf_fc_association *assoc = NULL;
int assoc_err = 0;
uint32_t num_assoc = 0;
uint32_t num_assoc_del_scheduled = 0;
struct spdk_nvmf_fc_adm_i_t_del_assoc_cb_data *cb_data = NULL;
uint8_t port_hdl = nport->port_hdl;
uint32_t s_id = rport->s_id;
uint32_t rpi = rport->rpi;
uint32_t assoc_count = rport->assoc_count;
char log_str[256];
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "IT delete associations on nport:%d begin.\n",
nport->nport_hdl);
/*
* Allocate memory for callback data.
* This memory will be freed by the callback function.
*/
cb_data = calloc(1, sizeof(struct spdk_nvmf_fc_adm_i_t_del_assoc_cb_data));
if (NULL == cb_data) {
SPDK_ERRLOG("Failed to allocate memory for cb_data on nport:%d.\n", nport->nport_hdl);
err = -ENOMEM;
goto out;
}
cb_data->nport = nport;
cb_data->rport = rport;
cb_data->port_handle = port_hdl;
cb_data->cb_func = cb_func;
cb_data->cb_ctx = cb_ctx;
/*
* Delete all associations, if any, related with this ITN/remote_port.
*/
TAILQ_FOREACH(assoc, &nport->fc_associations, link) {
num_assoc++;
if (assoc->s_id == s_id) {
assoc_err = nvmf_fc_delete_association(nport,
assoc->assoc_id,
false /* send abts */, false,
nvmf_fc_adm_i_t_delete_assoc_cb, cb_data);
if (0 != assoc_err) {
/*
* Mark this association as zombie.
*/
err = -EINVAL;
DEV_VERIFY(!"Error while deleting association");
(void)nvmf_fc_assoc_set_state(assoc, SPDK_NVMF_FC_OBJECT_ZOMBIE);
} else {
num_assoc_del_scheduled++;
}
}
}
out:
if ((cb_data) && (num_assoc_del_scheduled == 0)) {
/*
* Since there are no association_delete calls
* successfully scheduled, the association_delete
* callback function will never be called.
* In this case, call the callback function now.
*/
nvmf_fc_adm_i_t_delete_assoc_cb(cb_data, 0);
}
snprintf(log_str, sizeof(log_str),
"IT delete associations on nport:%d end. "
"s_id:%d rpi:%d assoc_count:%d assoc:%d assoc_del_scheduled:%d rc:%d.\n",
nport->nport_hdl, s_id, rpi, assoc_count, num_assoc, num_assoc_del_scheduled, err);
if (err == 0) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
} else {
SPDK_ERRLOG("%s", log_str);
}
}
static void
nvmf_fc_adm_queue_quiesce_cb(void *cb_data, enum spdk_nvmf_fc_poller_api_ret ret)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_poller_api_quiesce_queue_args *quiesce_api_data = NULL;
struct spdk_nvmf_fc_adm_hw_port_quiesce_ctx *port_quiesce_ctx = NULL;
struct spdk_nvmf_fc_hwqp *hwqp = NULL;
struct spdk_nvmf_fc_port *fc_port = NULL;
int err = 0;
quiesce_api_data = (struct spdk_nvmf_fc_poller_api_quiesce_queue_args *)cb_data;
hwqp = quiesce_api_data->hwqp;
fc_port = hwqp->fc_port;
port_quiesce_ctx = (struct spdk_nvmf_fc_adm_hw_port_quiesce_ctx *)quiesce_api_data->ctx;
spdk_nvmf_fc_adm_hw_port_quiesce_cb_fn cb_func = port_quiesce_ctx->cb_func;
/*
* Decrement the callback/quiesced queue count.
*/
port_quiesce_ctx->quiesce_count--;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "Queue%d Quiesced\n", quiesce_api_data->hwqp->hwqp_id);
free(quiesce_api_data);
/*
* Wait for call backs i.e. max_ioq_queues + LS QUEUE.
*/
if (port_quiesce_ctx->quiesce_count > 0) {
return;
}
if (fc_port->hw_port_status == SPDK_FC_PORT_QUIESCED) {
SPDK_ERRLOG("Port %d already in quiesced state.\n", fc_port->port_hdl);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d quiesced.\n", fc_port->port_hdl);
fc_port->hw_port_status = SPDK_FC_PORT_QUIESCED;
}
if (cb_func) {
/*
* Callback function for the called of quiesce.
*/
cb_func(port_quiesce_ctx->ctx, err);
}
/*
* Free the context structure.
*/
free(port_quiesce_ctx);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d quiesce done, rc = %d.\n", fc_port->port_hdl,
err);
}
static int
nvmf_fc_adm_hw_queue_quiesce(struct spdk_nvmf_fc_hwqp *fc_hwqp, void *ctx,
spdk_nvmf_fc_poller_api_cb cb_func)
{
struct spdk_nvmf_fc_poller_api_quiesce_queue_args *args;
enum spdk_nvmf_fc_poller_api_ret rc = SPDK_NVMF_FC_POLLER_API_SUCCESS;
int err = 0;
args = calloc(1, sizeof(struct spdk_nvmf_fc_poller_api_quiesce_queue_args));
if (args == NULL) {
err = -ENOMEM;
SPDK_ERRLOG("Failed to allocate memory for poller quiesce args, hwqp:%d\n", fc_hwqp->hwqp_id);
goto done;
}
args->hwqp = fc_hwqp;
args->ctx = ctx;
args->cb_info.cb_func = cb_func;
args->cb_info.cb_data = args;
args->cb_info.cb_thread = spdk_get_thread();
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "Quiesce queue %d\n", fc_hwqp->hwqp_id);
rc = nvmf_fc_poller_api_func(fc_hwqp, SPDK_NVMF_FC_POLLER_API_QUIESCE_QUEUE, args);
if (rc) {
free(args);
err = -EINVAL;
}
done:
return err;
}
/*
* Hw port Quiesce
*/
static int
nvmf_fc_adm_hw_port_quiesce(struct spdk_nvmf_fc_port *fc_port, void *ctx,
spdk_nvmf_fc_adm_hw_port_quiesce_cb_fn cb_func)
{
struct spdk_nvmf_fc_adm_hw_port_quiesce_ctx *port_quiesce_ctx = NULL;
uint32_t i = 0;
int err = 0;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port:%d is being quiesced.\n", fc_port->port_hdl);
/*
* If the port is in an OFFLINE state, set the state to QUIESCED
* and execute the callback.
*/
if (fc_port->hw_port_status == SPDK_FC_PORT_OFFLINE) {
fc_port->hw_port_status = SPDK_FC_PORT_QUIESCED;
}
if (fc_port->hw_port_status == SPDK_FC_PORT_QUIESCED) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "Port %d already in quiesced state.\n",
fc_port->port_hdl);
/*
* Execute the callback function directly.
*/
cb_func(ctx, err);
goto out;
}
port_quiesce_ctx = calloc(1, sizeof(struct spdk_nvmf_fc_adm_hw_port_quiesce_ctx));
if (port_quiesce_ctx == NULL) {
err = -ENOMEM;
SPDK_ERRLOG("Failed to allocate memory for LS queue quiesce ctx, port:%d\n",
fc_port->port_hdl);
goto out;
}
port_quiesce_ctx->quiesce_count = 0;
port_quiesce_ctx->ctx = ctx;
port_quiesce_ctx->cb_func = cb_func;
/*
* Quiesce the LS queue.
*/
err = nvmf_fc_adm_hw_queue_quiesce(&fc_port->ls_queue, port_quiesce_ctx,
nvmf_fc_adm_queue_quiesce_cb);
if (err != 0) {
SPDK_ERRLOG("Failed to quiesce the LS queue.\n");
goto out;
}
port_quiesce_ctx->quiesce_count++;
/*
* Quiesce the IO queues.
*/
for (i = 0; i < fc_port->num_io_queues; i++) {
err = nvmf_fc_adm_hw_queue_quiesce(&fc_port->io_queues[i],
port_quiesce_ctx,
nvmf_fc_adm_queue_quiesce_cb);
if (err != 0) {
DEV_VERIFY(0);
SPDK_ERRLOG("Failed to quiesce the IO queue:%d.\n", fc_port->io_queues[i].hwqp_id);
}
port_quiesce_ctx->quiesce_count++;
}
out:
if (port_quiesce_ctx && err != 0) {
free(port_quiesce_ctx);
}
return err;
}
/*
* Initialize and add a HW port entry to the global
* HW port list.
*/
static void
nvmf_fc_adm_evnt_hw_port_init(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_port *fc_port = NULL;
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_hw_port_init_args *args = (struct spdk_nvmf_fc_hw_port_init_args *)
api_data->api_args;
int err = 0;
if (args->io_queue_cnt > spdk_env_get_core_count()) {
SPDK_ERRLOG("IO queues count greater than cores for %d.\n", args->port_handle);
err = EINVAL;
goto abort_port_init;
}
/*
* 1. Check for duplicate initialization.
*/
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (fc_port != NULL) {
/* Port already exists, check if it has to be re-initialized */
err = nvmf_fc_adm_hw_port_reinit_validate(fc_port, args);
if (err) {
/*
* In case of an error we do not want to free the fc_port
* so we set that pointer to NULL.
*/
fc_port = NULL;
}
goto abort_port_init;
}
/*
* 2. Get the memory to instantiate a fc port.
*/
fc_port = calloc(1, sizeof(struct spdk_nvmf_fc_port) +
(args->io_queue_cnt * sizeof(struct spdk_nvmf_fc_hwqp)));
if (fc_port == NULL) {
SPDK_ERRLOG("Failed to allocate memory for fc_port %d.\n", args->port_handle);
err = -ENOMEM;
goto abort_port_init;
}
/* assign the io_queues array */
fc_port->io_queues = (struct spdk_nvmf_fc_hwqp *)((uint8_t *)fc_port + sizeof(
struct spdk_nvmf_fc_port));
/*
* 3. Initialize the contents for the FC-port
*/
err = nvmf_fc_adm_hw_port_data_init(fc_port, args);
if (err != 0) {
SPDK_ERRLOG("Data initialization failed for fc_port %d.\n", args->port_handle);
DEV_VERIFY(!"Data initialization failed for fc_port");
goto abort_port_init;
}
/*
* 4. Add this port to the global fc port list in the library.
*/
nvmf_fc_port_add(fc_port);
abort_port_init:
if (err && fc_port) {
free(fc_port);
}
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_HW_PORT_INIT, args->cb_ctx, err);
}
free(arg);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d initialize done, rc = %d.\n",
args->port_handle, err);
}
/*
* Online a HW port.
*/
static void
nvmf_fc_adm_evnt_hw_port_online(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_port *fc_port = NULL;
struct spdk_nvmf_fc_hwqp *hwqp = NULL;
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_hw_port_online_args *args = (struct spdk_nvmf_fc_hw_port_online_args *)
api_data->api_args;
int i = 0;
int err = 0;
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (fc_port) {
/* Set the port state to online */
err = nvmf_fc_port_set_online(fc_port);
if (err != 0) {
SPDK_ERRLOG("Hw port %d online failed. err = %d\n", fc_port->port_hdl, err);
DEV_VERIFY(!"Hw port online failed");
goto out;
}
hwqp = &fc_port->ls_queue;
hwqp->context = NULL;
(void)nvmf_fc_hwqp_set_online(hwqp);
/* Cycle through all the io queues and setup a hwqp poller for each. */
for (i = 0; i < (int)fc_port->num_io_queues; i++) {
hwqp = &fc_port->io_queues[i];
hwqp->context = NULL;
(void)nvmf_fc_hwqp_set_online(hwqp);
nvmf_fc_poll_group_add_hwqp(hwqp);
}
} else {
SPDK_ERRLOG("Unable to find the SPDK FC port %d\n", args->port_handle);
err = -EINVAL;
}
out:
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_HW_PORT_ONLINE, args->cb_ctx, err);
}
free(arg);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d online done, rc = %d.\n", args->port_handle,
err);
}
/*
* Offline a HW port.
*/
static void
nvmf_fc_adm_evnt_hw_port_offline(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_port *fc_port = NULL;
struct spdk_nvmf_fc_hwqp *hwqp = NULL;
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_hw_port_offline_args *args = (struct spdk_nvmf_fc_hw_port_offline_args *)
api_data->api_args;
int i = 0;
int err = 0;
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (fc_port) {
/* Set the port state to offline, if it is not already. */
err = nvmf_fc_port_set_offline(fc_port);
if (err != 0) {
SPDK_ERRLOG("Hw port %d already offline. err = %d\n", fc_port->port_hdl, err);
err = 0;
goto out;
}
hwqp = &fc_port->ls_queue;
(void)nvmf_fc_hwqp_set_offline(hwqp);
/* Remove poller for all the io queues. */
for (i = 0; i < (int)fc_port->num_io_queues; i++) {
hwqp = &fc_port->io_queues[i];
(void)nvmf_fc_hwqp_set_offline(hwqp);
nvmf_fc_poll_group_remove_hwqp(hwqp);
}
/*
* Delete all the nports. Ideally, the nports should have been purged
* before the offline event, in which case, only a validation is required.
*/
nvmf_fc_adm_hw_port_offline_nport_delete(fc_port);
} else {
SPDK_ERRLOG("Unable to find the SPDK FC port %d\n", args->port_handle);
err = -EINVAL;
}
out:
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_HW_PORT_OFFLINE, args->cb_ctx, err);
}
free(arg);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d offline done, rc = %d.\n", args->port_handle,
err);
}
struct nvmf_fc_add_rem_listener_ctx {
struct spdk_nvmf_subsystem *subsystem;
bool add_listener;
struct spdk_nvme_transport_id trid;
};
static void
nvmf_fc_adm_subsystem_resume_cb(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct nvmf_fc_add_rem_listener_ctx *ctx = (struct nvmf_fc_add_rem_listener_ctx *)cb_arg;
free(ctx);
}
static void
nvmf_fc_adm_listen_done(void *cb_arg, int status)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct nvmf_fc_add_rem_listener_ctx *ctx = cb_arg;
if (spdk_nvmf_subsystem_resume(ctx->subsystem, nvmf_fc_adm_subsystem_resume_cb, ctx)) {
SPDK_ERRLOG("Failed to resume subsystem: %s\n", ctx->subsystem->subnqn);
free(ctx);
}
}
static void
nvmf_fc_adm_subsystem_paused_cb(struct spdk_nvmf_subsystem *subsystem, void *cb_arg, int status)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct nvmf_fc_add_rem_listener_ctx *ctx = (struct nvmf_fc_add_rem_listener_ctx *)cb_arg;
if (ctx->add_listener) {
spdk_nvmf_subsystem_add_listener(subsystem, &ctx->trid, nvmf_fc_adm_listen_done, ctx);
} else {
spdk_nvmf_subsystem_remove_listener(subsystem, &ctx->trid);
nvmf_fc_adm_listen_done(ctx, 0);
}
}
static int
nvmf_fc_adm_add_rem_nport_listener(struct spdk_nvmf_fc_nport *nport, bool add)
{
struct spdk_nvmf_tgt *tgt = nvmf_fc_get_tgt();
struct spdk_nvmf_subsystem *subsystem;
if (!tgt) {
SPDK_ERRLOG("No nvmf target defined\n");
return -EINVAL;
}
subsystem = spdk_nvmf_subsystem_get_first(tgt);
while (subsystem) {
struct nvmf_fc_add_rem_listener_ctx *ctx;
if (spdk_nvmf_subsytem_any_listener_allowed(subsystem) == true) {
ctx = calloc(1, sizeof(struct nvmf_fc_add_rem_listener_ctx));
if (ctx) {
ctx->add_listener = add;
ctx->subsystem = subsystem;
nvmf_fc_create_trid(&ctx->trid,
nport->fc_nodename.u.wwn,
nport->fc_portname.u.wwn);
if (spdk_nvmf_tgt_listen(subsystem->tgt, &ctx->trid)) {
SPDK_ERRLOG("Failed to add transport address %s to tgt listeners\n",
ctx->trid.traddr);
free(ctx);
} else if (spdk_nvmf_subsystem_pause(subsystem,
nvmf_fc_adm_subsystem_paused_cb,
ctx)) {
SPDK_ERRLOG("Failed to pause subsystem: %s\n",
subsystem->subnqn);
free(ctx);
}
}
}
subsystem = spdk_nvmf_subsystem_get_next(subsystem);
}
return 0;
}
/*
* Create a Nport.
*/
static void
nvmf_fc_adm_evnt_nport_create(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_nport_create_args *args = (struct spdk_nvmf_fc_nport_create_args *)
api_data->api_args;
struct spdk_nvmf_fc_nport *nport = NULL;
struct spdk_nvmf_fc_port *fc_port = NULL;
int err = 0;
/*
* Get the physical port.
*/
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (fc_port == NULL) {
err = -EINVAL;
goto out;
}
/*
* Check for duplicate initialization.
*/
nport = nvmf_fc_nport_find(args->port_handle, args->nport_handle);
if (nport != NULL) {
SPDK_ERRLOG("Duplicate SPDK FC nport %d exists for FC port:%d.\n", args->nport_handle,
args->port_handle);
err = -EINVAL;
goto out;
}
/*
* Get the memory to instantiate a fc nport.
*/
nport = calloc(1, sizeof(struct spdk_nvmf_fc_nport));
if (nport == NULL) {
SPDK_ERRLOG("Failed to allocate memory for nport %d.\n",
args->nport_handle);
err = -ENOMEM;
goto out;
}
/*
* Initialize the contents for the nport
*/
nport->nport_hdl = args->nport_handle;
nport->port_hdl = args->port_handle;
nport->nport_state = SPDK_NVMF_FC_OBJECT_CREATED;
nport->fc_nodename = args->fc_nodename;
nport->fc_portname = args->fc_portname;
nport->d_id = args->d_id;
nport->fc_port = nvmf_fc_port_lookup(args->port_handle);
(void)nvmf_fc_nport_set_state(nport, SPDK_NVMF_FC_OBJECT_CREATED);
TAILQ_INIT(&nport->rem_port_list);
nport->rport_count = 0;
TAILQ_INIT(&nport->fc_associations);
nport->assoc_count = 0;
/*
* Populate the nport address (as listening address) to the nvmf subsystems.
*/
err = nvmf_fc_adm_add_rem_nport_listener(nport, true);
(void)nvmf_fc_port_add_nport(fc_port, nport);
out:
if (err && nport) {
free(nport);
}
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_NPORT_CREATE, args->cb_ctx, err);
}
free(arg);
}
static void
nvmf_fc_adm_delete_nport_cb(uint8_t port_handle, enum spdk_fc_event event_type,
void *cb_args, int spdk_err)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_nport_del_cb_data *cb_data = cb_args;
struct spdk_nvmf_fc_nport *nport = cb_data->nport;
spdk_nvmf_fc_callback cb_func = cb_data->fc_cb_func;
int err = 0;
uint16_t nport_hdl = 0;
char log_str[256];
/*
* Assert on any delete failure.
*/
if (nport == NULL) {
SPDK_ERRLOG("Nport delete callback returned null nport");
DEV_VERIFY(!"nport is null.");
goto out;
}
nport_hdl = nport->nport_hdl;
if (0 != spdk_err) {
SPDK_ERRLOG("Nport delete callback returned error. FC Port: "
"%d, Nport: %d\n",
nport->port_hdl, nport->nport_hdl);
DEV_VERIFY(!"nport delete callback error.");
}
/*
* Free the nport if this is the last rport being deleted and
* execute the callback(s).
*/
if (nvmf_fc_nport_has_no_rport(nport)) {
if (0 != nport->assoc_count) {
SPDK_ERRLOG("association count != 0\n");
DEV_VERIFY(!"association count != 0");
}
err = nvmf_fc_port_remove_nport(nport->fc_port, nport);
if (0 != err) {
SPDK_ERRLOG("Nport delete callback: Failed to remove "
"nport from nport list. FC Port:%d Nport:%d\n",
nport->port_hdl, nport->nport_hdl);
}
/* Free the nport */
free(nport);
if (cb_func != NULL) {
(void)cb_func(cb_data->port_handle, SPDK_FC_NPORT_DELETE, cb_data->fc_cb_ctx, spdk_err);
}
free(cb_data);
}
out:
snprintf(log_str, sizeof(log_str),
"port:%d nport:%d delete cb exit, evt_type:%d rc:%d.\n",
port_handle, nport_hdl, event_type, spdk_err);
if (err != 0) {
SPDK_ERRLOG("%s", log_str);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
}
}
/*
* Delete Nport.
*/
static void
nvmf_fc_adm_evnt_nport_delete(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_nport_delete_args *args = (struct spdk_nvmf_fc_nport_delete_args *)
api_data->api_args;
struct spdk_nvmf_fc_nport *nport = NULL;
struct spdk_nvmf_fc_adm_nport_del_cb_data *cb_data = NULL;
struct spdk_nvmf_fc_remote_port_info *rport_iter = NULL;
int err = 0;
uint32_t rport_cnt = 0;
int rc = 0;
/*
* Make sure that the nport exists.
*/
nport = nvmf_fc_nport_find(args->port_handle, args->nport_handle);
if (nport == NULL) {
SPDK_ERRLOG("Unable to find the SPDK FC nport %d for FC Port: %d.\n", args->nport_handle,
args->port_handle);
err = -EINVAL;
goto out;
}
/*
* Allocate memory for callback data.
*/
cb_data = calloc(1, sizeof(struct spdk_nvmf_fc_adm_nport_del_cb_data));
if (NULL == cb_data) {
SPDK_ERRLOG("Failed to allocate memory for cb_data %d.\n", args->nport_handle);
err = -ENOMEM;
goto out;
}
cb_data->nport = nport;
cb_data->port_handle = args->port_handle;
cb_data->fc_cb_func = api_data->cb_func;
cb_data->fc_cb_ctx = args->cb_ctx;
/*
* Begin nport tear down
*/
if (nport->nport_state == SPDK_NVMF_FC_OBJECT_CREATED) {
(void)nvmf_fc_nport_set_state(nport, SPDK_NVMF_FC_OBJECT_TO_BE_DELETED);
} else if (nport->nport_state == SPDK_NVMF_FC_OBJECT_TO_BE_DELETED) {
/*
* Deletion of this nport already in progress. Register callback
* and return.
*/
/* TODO: Register callback in callback vector. For now, set the error and return. */
err = -ENODEV;
goto out;
} else {
/* nport partially created/deleted */
DEV_VERIFY(nport->nport_state == SPDK_NVMF_FC_OBJECT_ZOMBIE);
DEV_VERIFY(0 != "Nport in zombie state");
err = -ENODEV;
goto out;
}
/*
* Remove this nport from listening addresses across subsystems
*/
rc = nvmf_fc_adm_add_rem_nport_listener(nport, false);
if (0 != rc) {
err = nvmf_fc_nport_set_state(nport, SPDK_NVMF_FC_OBJECT_ZOMBIE);
SPDK_ERRLOG("Unable to remove the listen addr in the subsystems for nport %d.\n",
nport->nport_hdl);
goto out;
}
/*
* Delete all the remote ports (if any) for the nport
*/
/* TODO - Need to do this with a "first" and a "next" accessor function
* for completeness. Look at app-subsystem as examples.
*/
if (nvmf_fc_nport_has_no_rport(nport)) {
/* No rports to delete. Complete the nport deletion. */
nvmf_fc_adm_delete_nport_cb(nport->port_hdl, SPDK_FC_NPORT_DELETE, cb_data, 0);
goto out;
}
TAILQ_FOREACH(rport_iter, &nport->rem_port_list, link) {
struct spdk_nvmf_fc_hw_i_t_delete_args *it_del_args = calloc(
1, sizeof(struct spdk_nvmf_fc_hw_i_t_delete_args));
if (it_del_args == NULL) {
err = -ENOMEM;
SPDK_ERRLOG("SPDK_FC_IT_DELETE no mem to delete rport with rpi:%d s_id:%d.\n",
rport_iter->rpi, rport_iter->s_id);
DEV_VERIFY(!"SPDK_FC_IT_DELETE failed, cannot allocate memory");
goto out;
}
rport_cnt++;
it_del_args->port_handle = nport->port_hdl;
it_del_args->nport_handle = nport->nport_hdl;
it_del_args->cb_ctx = (void *)cb_data;
it_del_args->rpi = rport_iter->rpi;
it_del_args->s_id = rport_iter->s_id;
nvmf_fc_master_enqueue_event(SPDK_FC_IT_DELETE, (void *)it_del_args,
nvmf_fc_adm_delete_nport_cb);
}
out:
/* On failure, execute the callback function now */
if ((err != 0) || (rc != 0)) {
SPDK_ERRLOG("NPort %d delete failed, error:%d, fc port:%d, "
"rport_cnt:%d rc:%d.\n",
args->nport_handle, err, args->port_handle,
rport_cnt, rc);
if (cb_data) {
free(cb_data);
}
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_NPORT_DELETE, args->cb_ctx, err);
}
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API,
"NPort %d delete done succesfully, fc port:%d. "
"rport_cnt:%d\n",
args->nport_handle, args->port_handle, rport_cnt);
}
free(arg);
}
/*
* Process an PRLI/IT add.
*/
static void
nvmf_fc_adm_evnt_i_t_add(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_hw_i_t_add_args *args = (struct spdk_nvmf_fc_hw_i_t_add_args *)
api_data->api_args;
struct spdk_nvmf_fc_nport *nport = NULL;
struct spdk_nvmf_fc_remote_port_info *rport_iter = NULL;
struct spdk_nvmf_fc_remote_port_info *rport = NULL;
int err = 0;
/*
* Make sure the nport port exists.
*/
nport = nvmf_fc_nport_find(args->port_handle, args->nport_handle);
if (nport == NULL) {
SPDK_ERRLOG("Unable to find the SPDK FC nport %d\n", args->nport_handle);
err = -EINVAL;
goto out;
}
/*
* Check for duplicate i_t_add.
*/
TAILQ_FOREACH(rport_iter, &nport->rem_port_list, link) {
if ((rport_iter->s_id == args->s_id) && (rport_iter->rpi == args->rpi)) {
SPDK_ERRLOG("Duplicate rport found for FC nport %d: sid:%d rpi:%d\n",
args->nport_handle, rport_iter->s_id, rport_iter->rpi);
err = -EEXIST;
goto out;
}
}
/*
* Get the memory to instantiate the remote port
*/
rport = calloc(1, sizeof(struct spdk_nvmf_fc_remote_port_info));
if (rport == NULL) {
SPDK_ERRLOG("Memory allocation for rem port failed.\n");
err = -ENOMEM;
goto out;
}
/*
* Initialize the contents for the rport
*/
(void)nvmf_fc_rport_set_state(rport, SPDK_NVMF_FC_OBJECT_CREATED);
rport->s_id = args->s_id;
rport->rpi = args->rpi;
rport->fc_nodename = args->fc_nodename;
rport->fc_portname = args->fc_portname;
/*
* Add remote port to nport
*/
if (nvmf_fc_nport_add_rem_port(nport, rport) != 0) {
DEV_VERIFY(!"Error while adding rport to list");
};
/*
* TODO: Do we validate the initiators service parameters?
*/
/*
* Get the targets service parameters from the library
* to return back to the driver.
*/
args->target_prli_info = nvmf_fc_get_prli_service_params();
out:
if (api_data->cb_func != NULL) {
/*
* Passing pointer to the args struct as the first argument.
* The cb_func should handle this appropriately.
*/
(void)api_data->cb_func(args->port_handle, SPDK_FC_IT_ADD, args->cb_ctx, err);
}
free(arg);
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API,
"IT add on nport %d done, rc = %d.\n",
args->nport_handle, err);
}
/**
* Process a IT delete.
*/
static void
nvmf_fc_adm_evnt_i_t_delete(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_hw_i_t_delete_args *args = (struct spdk_nvmf_fc_hw_i_t_delete_args *)
api_data->api_args;
int rc = 0;
struct spdk_nvmf_fc_nport *nport = NULL;
struct spdk_nvmf_fc_adm_i_t_del_cb_data *cb_data = NULL;
struct spdk_nvmf_fc_remote_port_info *rport_iter = NULL;
struct spdk_nvmf_fc_remote_port_info *rport = NULL;
uint32_t num_rport = 0;
char log_str[256];
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "IT delete on nport:%d begin.\n", args->nport_handle);
/*
* Make sure the nport port exists. If it does not, error out.
*/
nport = nvmf_fc_nport_find(args->port_handle, args->nport_handle);
if (nport == NULL) {
SPDK_ERRLOG("Unable to find the SPDK FC nport:%d\n", args->nport_handle);
rc = -EINVAL;
goto out;
}
/*
* Find this ITN / rport (remote port).
*/
TAILQ_FOREACH(rport_iter, &nport->rem_port_list, link) {
num_rport++;
if ((rport_iter->s_id == args->s_id) &&
(rport_iter->rpi == args->rpi) &&
(rport_iter->rport_state == SPDK_NVMF_FC_OBJECT_CREATED)) {
rport = rport_iter;
break;
}
}
/*
* We should find either zero or exactly one rport.
*
* If we find zero rports, that means that a previous request has
* removed the rport by the time we reached here. In this case,
* simply return out.
*/
if (rport == NULL) {
rc = -ENODEV;
goto out;
}
/*
* We have found exactly one rport. Allocate memory for callback data.
*/
cb_data = calloc(1, sizeof(struct spdk_nvmf_fc_adm_i_t_del_cb_data));
if (NULL == cb_data) {
SPDK_ERRLOG("Failed to allocate memory for cb_data for nport:%d.\n", args->nport_handle);
rc = -ENOMEM;
goto out;
}
cb_data->nport = nport;
cb_data->rport = rport;
cb_data->port_handle = args->port_handle;
cb_data->fc_cb_func = api_data->cb_func;
cb_data->fc_cb_ctx = args->cb_ctx;
/*
* Validate rport object state.
*/
if (rport->rport_state == SPDK_NVMF_FC_OBJECT_CREATED) {
(void)nvmf_fc_rport_set_state(rport, SPDK_NVMF_FC_OBJECT_TO_BE_DELETED);
} else if (rport->rport_state == SPDK_NVMF_FC_OBJECT_TO_BE_DELETED) {
/*
* Deletion of this rport already in progress. Register callback
* and return.
*/
/* TODO: Register callback in callback vector. For now, set the error and return. */
rc = -ENODEV;
goto out;
} else {
/* rport partially created/deleted */
DEV_VERIFY(rport->rport_state == SPDK_NVMF_FC_OBJECT_ZOMBIE);
DEV_VERIFY(!"Invalid rport_state");
rc = -ENODEV;
goto out;
}
/*
* We have successfully found a rport to delete. Call
* nvmf_fc_i_t_delete_assoc(), which will perform further
* IT-delete processing as well as free the cb_data.
*/
nvmf_fc_adm_i_t_delete_assoc(nport, rport, nvmf_fc_adm_i_t_delete_cb,
(void *)cb_data);
out:
if (rc != 0) {
/*
* We have entered here because either we encountered an
* error, or we did not find a rport to delete.
* As a result, we will not call the function
* nvmf_fc_i_t_delete_assoc() for further IT-delete
* processing. Therefore, execute the callback function now.
*/
if (cb_data) {
free(cb_data);
}
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_IT_DELETE, args->cb_ctx, rc);
}
}
snprintf(log_str, sizeof(log_str),
"IT delete on nport:%d end. num_rport:%d rc = %d.\n",
args->nport_handle, num_rport, rc);
if (rc != 0) {
SPDK_ERRLOG("%s", log_str);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
}
free(arg);
}
/*
* Process ABTS received
*/
static void
nvmf_fc_adm_evnt_abts_recv(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_abts_args *args = (struct spdk_nvmf_fc_abts_args *)api_data->api_args;
struct spdk_nvmf_fc_nport *nport = NULL;
int err = 0;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "FC ABTS received. RPI:%d, oxid:%d, rxid:%d\n", args->rpi,
args->oxid, args->rxid);
/*
* 1. Make sure the nport port exists.
*/
nport = nvmf_fc_nport_find(args->port_handle, args->nport_handle);
if (nport == NULL) {
SPDK_ERRLOG("Unable to find the SPDK FC nport %d\n", args->nport_handle);
err = -EINVAL;
goto out;
}
/*
* 2. If the nport is in the process of being deleted, drop the ABTS.
*/
if (nport->nport_state == SPDK_NVMF_FC_OBJECT_TO_BE_DELETED) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API,
"FC ABTS dropped because the nport is being deleted; RPI:%d, oxid:%d, rxid:%d\n",
args->rpi, args->oxid, args->rxid);
err = 0;
goto out;
}
/*
* 3. Pass the received ABTS-LS to the library for handling.
*/
nvmf_fc_handle_abts_frame(nport, args->rpi, args->oxid, args->rxid);
out:
if (api_data->cb_func != NULL) {
/*
* Passing pointer to the args struct as the first argument.
* The cb_func should handle this appropriately.
*/
(void)api_data->cb_func(args->port_handle, SPDK_FC_ABTS_RECV, args, err);
} else {
/* No callback set, free the args */
free(args);
}
free(arg);
}
/*
* Callback function for hw port quiesce.
*/
static void
nvmf_fc_adm_hw_port_quiesce_reset_cb(void *ctx, int err)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_hw_port_reset_ctx *reset_ctx =
(struct spdk_nvmf_fc_adm_hw_port_reset_ctx *)ctx;
struct spdk_nvmf_fc_hw_port_reset_args *args = reset_ctx->reset_args;
spdk_nvmf_fc_callback cb_func = reset_ctx->reset_cb_func;
struct spdk_nvmf_fc_queue_dump_info dump_info;
struct spdk_nvmf_fc_port *fc_port = NULL;
char *dump_buf = NULL;
uint32_t dump_buf_size = SPDK_FC_HW_DUMP_BUF_SIZE;
/*
* Free the callback context struct.
*/
free(ctx);
if (err != 0) {
SPDK_ERRLOG("Port %d quiesce operation failed.\n", args->port_handle);
goto out;
}
if (args->dump_queues == false) {
/*
* Queues need not be dumped.
*/
goto out;
}
SPDK_ERRLOG("Dumping queues for HW port %d\n", args->port_handle);
/*
* Get the fc port.
*/
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (fc_port == NULL) {
SPDK_ERRLOG("Unable to find the SPDK FC port %d\n", args->port_handle);
err = -EINVAL;
goto out;
}
/*
* Allocate memory for the dump buffer.
* This memory will be freed by FCT.
*/
dump_buf = (char *)calloc(1, dump_buf_size);
if (dump_buf == NULL) {
err = -ENOMEM;
SPDK_ERRLOG("Memory allocation for dump buffer failed, SPDK FC port %d\n", args->port_handle);
goto out;
}
*args->dump_buf = (uint32_t *)dump_buf;
dump_info.buffer = dump_buf;
dump_info.offset = 0;
/*
* Add the dump reason to the top of the buffer.
*/
nvmf_fc_dump_buf_print(&dump_info, "%s\n", args->reason);
/*
* Dump the hwqp.
*/
nvmf_fc_dump_all_queues(&fc_port->ls_queue, fc_port->io_queues,
fc_port->num_io_queues, &dump_info);
out:
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d reset done, queues_dumped = %d, rc = %d.\n",
args->port_handle, args->dump_queues, err);
if (cb_func != NULL) {
(void)cb_func(args->port_handle, SPDK_FC_HW_PORT_RESET, args->cb_ctx, err);
}
}
/*
* HW port reset
*/
static void
nvmf_fc_adm_evnt_hw_port_reset(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_fc_hw_port_reset_args *args = (struct spdk_nvmf_fc_hw_port_reset_args *)
api_data->api_args;
struct spdk_nvmf_fc_port *fc_port = NULL;
struct spdk_nvmf_fc_adm_hw_port_reset_ctx *ctx = NULL;
int err = 0;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d dump\n", args->port_handle);
/*
* Make sure the physical port exists.
*/
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (fc_port == NULL) {
SPDK_ERRLOG("Unable to find the SPDK FC port %d\n", args->port_handle);
err = -EINVAL;
goto out;
}
/*
* Save the reset event args and the callback in a context struct.
*/
ctx = calloc(1, sizeof(struct spdk_nvmf_fc_adm_hw_port_reset_ctx));
if (ctx == NULL) {
err = -ENOMEM;
SPDK_ERRLOG("Memory allocation for reset ctx failed, SPDK FC port %d\n", args->port_handle);
goto fail;
}
ctx->reset_args = arg;
ctx->reset_cb_func = api_data->cb_func;
/*
* Quiesce the hw port.
*/
err = nvmf_fc_adm_hw_port_quiesce(fc_port, ctx, nvmf_fc_adm_hw_port_quiesce_reset_cb);
if (err != 0) {
goto fail;
}
/*
* Once the ports are successfully quiesced the reset processing
* will continue in the callback function: spdk_fc_port_quiesce_reset_cb
*/
return;
fail:
free(ctx);
out:
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "HW port %d dump done, rc = %d.\n", args->port_handle,
err);
if (api_data->cb_func != NULL) {
(void)api_data->cb_func(args->port_handle, SPDK_FC_HW_PORT_RESET, args->cb_ctx, err);
}
free(arg);
}
/*
* Process a link break event on a HW port.
*/
static void
nvmf_fc_adm_evnt_hw_port_link_break(void *arg)
{
ASSERT_SPDK_FC_MASTER_THREAD();
struct spdk_nvmf_fc_adm_api_data *api_data = (struct spdk_nvmf_fc_adm_api_data *)arg;
struct spdk_nvmf_hw_port_link_break_args *args = (struct spdk_nvmf_hw_port_link_break_args *)
api_data->api_args;
struct spdk_nvmf_fc_port *fc_port = NULL;
int err = 0;
struct spdk_nvmf_fc_adm_port_link_break_cb_data *cb_data = NULL;
struct spdk_nvmf_fc_nport *nport = NULL;
uint32_t nport_deletes_sent = 0;
uint32_t nport_deletes_skipped = 0;
struct spdk_nvmf_fc_nport_delete_args *nport_del_args = NULL;
char log_str[256];
/*
* Get the fc port using the port handle.
*/
fc_port = nvmf_fc_port_lookup(args->port_handle);
if (!fc_port) {
SPDK_ERRLOG("port link break: Unable to find the SPDK FC port %d\n",
args->port_handle);
err = -EINVAL;
goto out;
}
/*
* Set the port state to offline, if it is not already.
*/
err = nvmf_fc_port_set_offline(fc_port);
if (err != 0) {
SPDK_ERRLOG("port link break: HW port %d already offline. rc = %d\n",
fc_port->port_hdl, err);
err = 0;
goto out;
}
/*
* Delete all the nports, if any.
*/
if (!TAILQ_EMPTY(&fc_port->nport_list)) {
TAILQ_FOREACH(nport, &fc_port->nport_list, link) {
/* Skipped the nports that are not in CREATED state */
if (nport->nport_state != SPDK_NVMF_FC_OBJECT_CREATED) {
nport_deletes_skipped++;
continue;
}
/* Allocate memory for callback data. */
cb_data = calloc(1, sizeof(struct spdk_nvmf_fc_adm_port_link_break_cb_data));
if (NULL == cb_data) {
SPDK_ERRLOG("port link break: Failed to allocate memory for cb_data %d.\n",
args->port_handle);
err = -ENOMEM;
goto out;
}
cb_data->args = args;
cb_data->cb_func = api_data->cb_func;
nport_del_args = &cb_data->nport_del_args;
nport_del_args->port_handle = args->port_handle;
nport_del_args->nport_handle = nport->nport_hdl;
nport_del_args->cb_ctx = cb_data;
nvmf_fc_master_enqueue_event(SPDK_FC_NPORT_DELETE,
(void *)nport_del_args,
nvmf_fc_adm_hw_port_link_break_cb);
nport_deletes_sent++;
}
}
if (nport_deletes_sent == 0 && err == 0) {
/*
* Mark the hwqps as offline and unregister the pollers.
*/
(void)nvmf_fc_adm_port_hwqp_offline_del_poller(fc_port);
}
out:
snprintf(log_str, sizeof(log_str),
"port link break done: port:%d nport_deletes_sent:%d nport_deletes_skipped:%d rc:%d.\n",
args->port_handle, nport_deletes_sent, nport_deletes_skipped, err);
if (err != 0) {
SPDK_ERRLOG("%s", log_str);
} else {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "%s", log_str);
}
if ((api_data->cb_func != NULL) && (nport_deletes_sent == 0)) {
/*
* No nport_deletes are sent, which would have eventually
* called the port_link_break callback. Therefore, call the
* port_link_break callback here.
*/
(void)api_data->cb_func(args->port_handle, SPDK_FC_LINK_BREAK, args->cb_ctx, err);
}
free(arg);
}
static inline void
nvmf_fc_adm_run_on_master_thread(spdk_msg_fn fn, void *args)
{
if (nvmf_fc_get_master_thread()) {
spdk_thread_send_msg(nvmf_fc_get_master_thread(), fn, args);
}
}
/*
* Queue up an event in the SPDK masters event queue.
* Used by the FC driver to notify the SPDK master of FC related events.
*/
int
nvmf_fc_master_enqueue_event(enum spdk_fc_event event_type, void *args,
spdk_nvmf_fc_callback cb_func)
{
int err = 0;
struct spdk_nvmf_fc_adm_api_data *api_data = NULL;
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "Enqueue event %d.\n", event_type);
if (event_type >= SPDK_FC_EVENT_MAX) {
SPDK_ERRLOG("Invalid spdk_fc_event_t %d.\n", event_type);
err = -EINVAL;
goto done;
}
if (args == NULL) {
SPDK_ERRLOG("Null args for event %d.\n", event_type);
err = -EINVAL;
goto done;
}
api_data = calloc(1, sizeof(*api_data));
if (api_data == NULL) {
SPDK_ERRLOG("Failed to alloc api data for event %d.\n", event_type);
err = -ENOMEM;
goto done;
}
api_data->api_args = args;
api_data->cb_func = cb_func;
switch (event_type) {
case SPDK_FC_HW_PORT_INIT:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_hw_port_init,
(void *)api_data);
break;
case SPDK_FC_HW_PORT_ONLINE:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_hw_port_online,
(void *)api_data);
break;
case SPDK_FC_HW_PORT_OFFLINE:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_hw_port_offline,
(void *)api_data);
break;
case SPDK_FC_NPORT_CREATE:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_nport_create,
(void *)api_data);
break;
case SPDK_FC_NPORT_DELETE:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_nport_delete,
(void *)api_data);
break;
case SPDK_FC_IT_ADD:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_i_t_add,
(void *)api_data);
break;
case SPDK_FC_IT_DELETE:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_i_t_delete,
(void *)api_data);
break;
case SPDK_FC_ABTS_RECV:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_abts_recv,
(void *)api_data);
break;
case SPDK_FC_LINK_BREAK:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_hw_port_link_break,
(void *)api_data);
break;
case SPDK_FC_HW_PORT_RESET:
nvmf_fc_adm_run_on_master_thread(nvmf_fc_adm_evnt_hw_port_reset,
(void *)api_data);
break;
case SPDK_FC_UNRECOVERABLE_ERR:
default:
SPDK_ERRLOG("Invalid spdk_fc_event_t: %d\n", event_type);
err = -EINVAL;
break;
}
done:
if (err == 0) {
SPDK_DEBUGLOG(SPDK_LOG_NVMF_FC_ADM_API, "Enqueue event %d done successfully\n", event_type);
} else {
SPDK_ERRLOG("Enqueue event %d failed, err = %d\n", event_type, err);
if (api_data) {
free(api_data);
}
}
return err;
}
SPDK_NVMF_TRANSPORT_REGISTER(fc, &spdk_nvmf_transport_fc);
SPDK_LOG_REGISTER_COMPONENT("nvmf_fc_adm_api", SPDK_LOG_NVMF_FC_ADM_API);
SPDK_LOG_REGISTER_COMPONENT("nvmf_fc", SPDK_LOG_NVMF_FC)
|