Loading...
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 | /* * Copyright (c) 2003-2024 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ /* * This file contains support for the POSIX 1003.1B AIO/LIO facility. */ #include <sys/systm.h> #include <sys/fcntl.h> #include <sys/file_internal.h> #include <sys/filedesc.h> #include <sys/guarded.h> #include <sys/kdebug.h> #include <sys/kernel.h> #include <sys/vnode_internal.h> #include <sys/kauth.h> #include <sys/mount_internal.h> #include <sys/param.h> #include <sys/proc_internal.h> #include <sys/sysctl.h> #include <sys/unistd.h> #include <sys/user.h> #include <sys/aio_kern.h> #include <sys/sysproto.h> #include <machine/limits.h> #include <mach/mach_types.h> #include <kern/kern_types.h> #include <kern/waitq.h> #include <kern/zalloc.h> #include <kern/task.h> #include <kern/sched_prim.h> #include <kern/ast.h> #include <vm/vm_map_xnu.h> #include <os/refcnt.h> #include <kern/thread.h> #include <kern/policy_internal.h> #include <pthread/workqueue_internal.h> #if 0 #undef KERNEL_DEBUG #define KERNEL_DEBUG KERNEL_DEBUG_CONSTANT #endif #define AIO_work_queued 1 #define AIO_worker_wake 2 #define AIO_completion_sig 3 #define AIO_completion_kevent 4 #define AIO_completion_cleanup_wait 5 #define AIO_completion_cleanup_wake 6 #define AIO_completion_suspend_wake 7 #define AIO_cancel 10 #define AIO_cancel_async_workq 11 #define AIO_cancel_sync_workq 12 #define AIO_cancel_activeq 13 #define AIO_cancel_doneq 14 #define AIO_fsync 20 #define AIO_fsync_delay 21 #define AIO_read 30 #define AIO_write 40 #define AIO_listio 50 #define AIO_error 60 #define AIO_error_val 61 #define AIO_error_activeq 62 #define AIO_error_workq 63 #define AIO_return 70 #define AIO_return_val 71 #define AIO_return_activeq 72 #define AIO_return_workq 73 #define AIO_exec 80 #define AIO_exit 90 #define AIO_exit_sleep 91 #define AIO_close 100 #define AIO_close_sleep 101 #define AIO_suspend 110 #define AIO_suspend_sleep 111 #define AIO_worker_thread 120 #define AIO_register_kevent 130 #define AIO_WQ_process_entry 140 #define AIO_WQ_aio_thread_create 141 #define AIO_WQ_aio_thread_terminate 142 #define AIO_WQ_aio_death_call 143 #define AIO_WQ_aio_thread_park 144 #define AIO_WQ_aio_select_req 145 #define AIO_WQ_aio_thread_create_failed 146 #define AIO_WQ_aio_thread_wakeup 147 static TUNABLE(uint32_t, bootarg_aio_new_workq, "aio_new_workq", 1); __options_decl(aio_entry_flags_t, uint32_t, { AIO_READ = 0x00000001, /* a read */ AIO_WRITE = 0x00000002, /* a write */ AIO_FSYNC = 0x00000004, /* aio_fsync with op = O_SYNC */ AIO_DSYNC = 0x00000008, /* aio_fsync with op = O_DSYNC (not supported yet) */ AIO_LIO = 0x00000010, /* lio_listio generated IO */ AIO_LIO_WAIT = 0x00000020, /* lio_listio is waiting on the leader */ AIO_COMPLETED = 0x00000100, /* request has completed */ AIO_CANCELLED = 0x00000200, /* request has been cancelled */ AIO_KEVENT_REGISTERED = 0x00000400, /* kevent has been registered */ /* * These flags mean that this entry is blocking either: * - close (AIO_CLOSE_WAIT) * - exit or exec (AIO_EXIT_WAIT) * * These flags are mutually exclusive, and the AIO_EXIT_WAIT variant * will also neuter notifications in do_aio_completion_and_unlock(). */ AIO_CLOSE_WAIT = 0x00004000, AIO_EXIT_WAIT = 0x00008000, }); /*! @struct aio_workq_entry * * @discussion * This represents a piece of aio/lio work. * * The ownership rules go as follows: * * - the "proc" owns one refcount on the entry (from creation), while it is * enqueued on the aio_activeq and then the aio_doneq. * * either aio_return() (user read the status) or _aio_exit() (the process * died) will dequeue the entry and consume this ref. * * - the async workqueue owns one refcount once the work is submitted, * which is consumed in do_aio_completion_and_unlock(). * * This ref protects the entry for the the end of * do_aio_completion_and_unlock() (when signal delivery happens). * * - lio_listio() for batches picks one of the entries to be the "leader" * of the batch. Each work item will have a refcount on its leader * so that the accounting of the batch completion can be done on the leader * (to be able to decrement lio_pending). * * This ref is consumed in do_aio_completion_and_unlock() as well. * * - lastly, in lio_listio() when the LIO_WAIT behavior is requested, * an extra ref is taken in this syscall as it needs to keep accessing * the leader "lio_pending" field until it hits 0. */ struct aio_workq_entry { /* queue lock */ TAILQ_ENTRY(aio_workq_entry) aio_workq_link; /* Proc lock */ TAILQ_ENTRY(aio_workq_entry) aio_proc_link; /* p_aio_activeq or p_aio_doneq */ user_ssize_t returnval; /* return value from read / write request */ errno_t errorval; /* error value from read / write request */ os_refcnt_t aio_refcount; aio_entry_flags_t flags; int lio_pending; /* pending I/Os in lio group, only on leader */ struct aio_workq_entry *lio_leader; /* pointer to the lio leader, can be self */ /* Initialized and never changed, safe to access */ struct proc *procp; /* user proc that queued this request */ user_addr_t uaiocbp; /* pointer passed in from user land */ struct user_aiocb aiocb; /* copy of aiocb from user land */ struct vfs_context context; /* context which enqueued the request */ /* Initialized, and possibly freed by aio_work_thread() or at free if cancelled */ vm_map_t aio_map; /* user land map we have a reference to */ }; /* * aio requests queue up on the aio_async_workq or lio_sync_workq (for * lio_listio LIO_WAIT). Requests then move to the per process aio_activeq * (proc.aio_activeq) when one of our worker threads start the IO. * And finally, requests move to the per process aio_doneq (proc.aio_doneq) * when the IO request completes. The request remains on aio_doneq until * user process calls aio_return or the process exits, either way that is our * trigger to release aio resources. */ typedef struct aio_workq { TAILQ_HEAD(, aio_workq_entry) aioq_entries; lck_spin_t aioq_lock; struct waitq aioq_waitq; } *aio_workq_t; #define AIO_NUM_WORK_QUEUES 1 struct aio_anchor_cb { os_atomic(int) aio_total_count; /* total extant entries */ /* Hash table of queues here */ int aio_num_workqs; struct aio_workq aio_async_workqs[AIO_NUM_WORK_QUEUES]; }; typedef struct aio_anchor_cb aio_anchor_cb; /* New per process workqueue */ #define WORKQUEUE_AIO_MAXTHREADS 16 TAILQ_HEAD(workq_aio_uthread_head, uthread); typedef struct workq_aio_s { thread_call_t wa_death_call; struct workq_aio_uthread_head wa_thrunlist; struct workq_aio_uthread_head wa_thidlelist; TAILQ_HEAD(, aio_workq_entry) wa_aioq_entries; proc_t wa_proc; workq_state_flags_t _Atomic wa_flags; uint16_t wa_nthreads; uint16_t wa_thidlecount; uint16_t wa_thdying_count; } workq_aio_s, *workq_aio_t; struct aio_workq_usec_var { uint32_t usecs; uint64_t abstime; }; static int aio_workq_sysctl_handle_usecs SYSCTL_HANDLER_ARGS; #define AIO_WORKQ_SYSCTL_USECS(var, init) \ static struct aio_workq_usec_var var = { .usecs = (init) }; \ SYSCTL_OID(_kern, OID_AUTO, var##_usecs, \ CTLTYPE_INT | CTLFLAG_RW | CTLFLAG_LOCKED, &(var), 0, \ aio_workq_sysctl_handle_usecs, "I", "") AIO_WORKQ_SYSCTL_USECS(aio_wq_reduce_pool_window, WQ_REDUCE_POOL_WINDOW_USECS); #define WQ_AIO_TRACE(x, wq, a, b, c, d) \ ({ KERNEL_DEBUG_CONSTANT(BSDDBG_CODE(DBG_BSD_AIO, (x)),\ proc_getpid((wq)->wa_proc), (a), (b), (c), (d)); }) #define WQ_AIO_TRACE_WQ(x, wq) \ ({ KERNEL_DEBUG_CONSTANT(BSDDBG_CODE(DBG_BSD_AIO, (x)),\ proc_getpid((wq)->wa_proc),\ (uintptr_t)thread_tid(current_thread()),\ (wq)->wa_nthreads, (wq)->wa_thidlecount, (wq)->wa_thdying_count); }) /* * Notes on aio sleep / wake channels. * We currently pick a couple fields within the proc structure that will allow * us sleep channels that currently do not collide with any other kernel routines. * At this time, for binary compatibility reasons, we cannot create new proc fields. */ #define AIO_SUSPEND_SLEEP_CHAN p_aio_activeq #define AIO_CLEANUP_SLEEP_CHAN p_aio_total_count #define ASSERT_AIO_FROM_PROC(aiop, theproc) \ if ((aiop)->procp != (theproc)) { \ panic("AIO on a proc list that does not belong to that proc."); \ } extern kern_return_t thread_terminate(thread_t); /* * LOCAL PROTOTYPES */ static void aio_proc_lock(proc_t procp); static void aio_proc_lock_spin(proc_t procp); static void aio_proc_unlock(proc_t procp); static lck_mtx_t *aio_proc_mutex(proc_t procp); static bool aio_has_active_requests_for_process(proc_t procp); static bool aio_proc_has_active_requests_for_file(proc_t procp, int fd); static boolean_t is_already_queued(proc_t procp, user_addr_t aiocbp); static aio_workq_t aio_entry_workq(aio_workq_entry *entryp); static void aio_workq_remove_entry_locked(aio_workq_t queue, aio_workq_entry *entryp); static void aio_workq_add_entry_locked(aio_workq_t queue, aio_workq_entry *entryp); static void aio_entry_ref(aio_workq_entry *entryp); static void aio_entry_unref(aio_workq_entry *entryp); static bool aio_entry_try_workq_remove(proc_t p, aio_workq_entry *entryp); static boolean_t aio_delay_fsync_request(aio_workq_entry *entryp); static void aio_free_request(aio_workq_entry *entryp); static void aio_workq_init(aio_workq_t wq); static void aio_workq_lock_spin(aio_workq_t wq); static void aio_workq_unlock(aio_workq_t wq); static lck_spin_t *aio_workq_lock(aio_workq_t wq); static void aio_work_thread(void *arg, wait_result_t wr); static aio_workq_entry *aio_get_some_work(void); static int aio_queue_async_request(proc_t procp, user_addr_t aiocbp, aio_entry_flags_t); static int aio_validate(proc_t, aio_workq_entry *entryp); static int do_aio_cancel_locked(proc_t p, int fd, user_addr_t aiocbp, aio_entry_flags_t); static void do_aio_completion_and_unlock(proc_t p, aio_workq_entry *entryp, aio_entry_flags_t reason); static int do_aio_fsync(aio_workq_entry *entryp); static int do_aio_read(aio_workq_entry *entryp); static int do_aio_write(aio_workq_entry *entryp); static void do_munge_aiocb_user32_to_user(struct user32_aiocb *my_aiocbp, struct user_aiocb *the_user_aiocbp); static void do_munge_aiocb_user64_to_user(struct user64_aiocb *my_aiocbp, struct user_aiocb *the_user_aiocbp); static int aio_create_queue_entry(proc_t procp, user_addr_t aiocbp, aio_entry_flags_t, aio_workq_entry **); static int aio_copy_in_list(proc_t, user_addr_t, user_addr_t *, int); static void workq_aio_prepare(struct proc *p); static bool workq_aio_entry_add_locked(struct proc *p, aio_workq_entry *entryp); static void workq_aio_wakeup_thread(proc_t p); static void workq_aio_wakeup_thread_and_unlock(proc_t p); static int workq_aio_process_entry(aio_workq_entry *entryp); static bool workq_aio_entry_remove_locked(struct proc *p, aio_workq_entry *entryp); static void workq_aio_kill_old_threads_call(void *param0, void *param1 __unused); static void workq_aio_unpark_continue(void *parameter __unused, wait_result_t wr); static void workq_aio_mark_exiting(proc_t p); static void workq_aio_exit(proc_t p); #define ASSERT_AIO_PROC_LOCK_OWNED(p) LCK_MTX_ASSERT(aio_proc_mutex(p), LCK_MTX_ASSERT_OWNED) #define ASSERT_AIO_WORKQ_LOCK_OWNED(q) LCK_SPIN_ASSERT(aio_workq_lock(q), LCK_ASSERT_OWNED) /* * EXTERNAL PROTOTYPES */ /* in ...bsd/kern/sys_generic.c */ extern int dofileread(vfs_context_t ctx, struct fileproc *fp, user_addr_t bufp, user_size_t nbyte, off_t offset, int flags, user_ssize_t *retval); extern int dofilewrite(vfs_context_t ctx, struct fileproc *fp, user_addr_t bufp, user_size_t nbyte, off_t offset, int flags, user_ssize_t *retval); /* * aio external global variables. */ extern int aio_max_requests; /* AIO_MAX - configurable */ extern int aio_max_requests_per_process; /* AIO_PROCESS_MAX - configurable */ extern int aio_worker_threads; /* AIO_THREAD_COUNT - configurable */ /* * aio static variables. */ static aio_anchor_cb aio_anchor = { .aio_num_workqs = AIO_NUM_WORK_QUEUES, }; os_refgrp_decl(static, aio_refgrp, "aio", NULL); static LCK_GRP_DECLARE(aio_proc_lock_grp, "aio_proc"); static LCK_GRP_DECLARE(aio_queue_lock_grp, "aio_queue"); static LCK_MTX_DECLARE(aio_proc_mtx, &aio_proc_lock_grp); static struct klist aio_klist; static LCK_GRP_DECLARE(aio_klist_lck_grp, "aio_klist"); static LCK_MTX_DECLARE(aio_klist_lock, &aio_klist_lck_grp); static KALLOC_TYPE_DEFINE(aio_workq_zonep, aio_workq_entry, KT_DEFAULT); /* Hash */ static aio_workq_t aio_entry_workq(__unused aio_workq_entry *entryp) { return &aio_anchor.aio_async_workqs[0]; } static void aio_workq_init(aio_workq_t wq) { TAILQ_INIT(&wq->aioq_entries); lck_spin_init(&wq->aioq_lock, &aio_queue_lock_grp, LCK_ATTR_NULL); waitq_init(&wq->aioq_waitq, WQT_QUEUE, SYNC_POLICY_FIFO); } /* * Can be passed a queue which is locked spin. */ static void aio_workq_remove_entry_locked(aio_workq_t queue, aio_workq_entry *entryp) { ASSERT_AIO_WORKQ_LOCK_OWNED(queue); if (entryp->aio_workq_link.tqe_prev == NULL) { panic("Trying to remove an entry from a work queue, but it is not on a queue"); } TAILQ_REMOVE(&queue->aioq_entries, entryp, aio_workq_link); entryp->aio_workq_link.tqe_prev = NULL; /* Not on a workq */ } static void aio_workq_add_entry_locked(aio_workq_t queue, aio_workq_entry *entryp) { ASSERT_AIO_WORKQ_LOCK_OWNED(queue); if (bootarg_aio_new_workq) { panic("old workq implementation selected with bootarg set"); } TAILQ_INSERT_TAIL(&queue->aioq_entries, entryp, aio_workq_link); } static void aio_proc_lock(proc_t procp) { lck_mtx_lock(aio_proc_mutex(procp)); } static void aio_proc_lock_spin(proc_t procp) { lck_mtx_lock_spin(aio_proc_mutex(procp)); } static bool aio_has_any_work(void) { return os_atomic_load(&aio_anchor.aio_total_count, relaxed) != 0; } static bool aio_try_proc_insert_active_locked(proc_t procp, aio_workq_entry *entryp) { int old, new; ASSERT_AIO_PROC_LOCK_OWNED(procp); if (procp->p_aio_total_count >= aio_max_requests_per_process) { return false; } if (is_already_queued(procp, entryp->uaiocbp)) { return false; } os_atomic_rmw_loop(&aio_anchor.aio_total_count, old, new, relaxed, { if (old >= aio_max_requests) { os_atomic_rmw_loop_give_up(return false); } new = old + 1; }); TAILQ_INSERT_TAIL(&procp->p_aio_activeq, entryp, aio_proc_link); procp->p_aio_total_count++; return true; } static void aio_proc_move_done_locked(proc_t procp, aio_workq_entry *entryp) { TAILQ_REMOVE(&procp->p_aio_activeq, entryp, aio_proc_link); TAILQ_INSERT_TAIL(&procp->p_aio_doneq, entryp, aio_proc_link); } static void aio_proc_remove_done_locked(proc_t procp, aio_workq_entry *entryp) { TAILQ_REMOVE(&procp->p_aio_doneq, entryp, aio_proc_link); entryp->aio_proc_link.tqe_prev = NULL; if (os_atomic_dec_orig(&aio_anchor.aio_total_count, relaxed) <= 0) { panic("Negative total AIO count!"); } if (procp->p_aio_total_count-- <= 0) { panic("proc %p: p_aio_total_count accounting mismatch", procp); } } static void aio_proc_unlock(proc_t procp) { lck_mtx_unlock(aio_proc_mutex(procp)); } static lck_mtx_t* aio_proc_mutex(proc_t procp) { return &procp->p_mlock; } static void aio_entry_ref(aio_workq_entry *entryp) { os_ref_retain(&entryp->aio_refcount); } static void aio_entry_unref(aio_workq_entry *entryp) { if (os_ref_release(&entryp->aio_refcount) == 0) { aio_free_request(entryp); } } static bool aio_entry_try_workq_remove(proc_t p, aio_workq_entry *entryp) { /* Can only be cancelled if it's still on a work queue */ if (entryp->aio_workq_link.tqe_prev != NULL) { aio_workq_t queue; if (bootarg_aio_new_workq) { return workq_aio_entry_remove_locked(p, entryp); } /* Will have to check again under the lock */ queue = aio_entry_workq(entryp); aio_workq_lock_spin(queue); if (entryp->aio_workq_link.tqe_prev != NULL) { aio_workq_remove_entry_locked(queue, entryp); aio_workq_unlock(queue); return true; } else { aio_workq_unlock(queue); } } return false; } static void aio_workq_lock_spin(aio_workq_t wq) { lck_spin_lock(aio_workq_lock(wq)); } static void aio_workq_unlock(aio_workq_t wq) { lck_spin_unlock(aio_workq_lock(wq)); } static lck_spin_t* aio_workq_lock(aio_workq_t wq) { return &wq->aioq_lock; } /* * aio_cancel - attempt to cancel one or more async IO requests currently * outstanding against file descriptor uap->fd. If uap->aiocbp is not * NULL then only one specific IO is cancelled (if possible). If uap->aiocbp * is NULL then all outstanding async IO request for the given file * descriptor are cancelled (if possible). */ int aio_cancel(proc_t p, struct aio_cancel_args *uap, int *retval) { struct user_aiocb my_aiocb; int result; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_cancel) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->fd, uap->aiocbp, 0, 0); if (uap->fd) { vnode_t vp = NULLVP; const char *vname = NULL; result = vnode_getfromfd(vfs_context_current(), uap->fd, &vp); if (result != 0) { result = EBADF; goto ExitRoutine; } vname = vnode_getname(vp); /* * The aio_cancel() system call will always return AIO_NOTCANCELED for * file descriptor associated with raw disk device. */ if (vnode_ischr(vp) && vname && !strncmp(vname, "rdisk", 5)) { result = 0; *retval = AIO_NOTCANCELED; } if (vname) { vnode_putname(vname); } vnode_put(vp); if (result == 0 && *retval == AIO_NOTCANCELED) { goto ExitRoutine; } } /* quick check to see if there are any async IO requests queued up */ if (!aio_has_any_work()) { result = 0; *retval = AIO_ALLDONE; goto ExitRoutine; } *retval = -1; if (uap->aiocbp != USER_ADDR_NULL) { if (proc_is64bit(p)) { struct user64_aiocb aiocb64; result = copyin(uap->aiocbp, &aiocb64, sizeof(aiocb64)); if (result == 0) { do_munge_aiocb_user64_to_user(&aiocb64, &my_aiocb); } } else { struct user32_aiocb aiocb32; result = copyin(uap->aiocbp, &aiocb32, sizeof(aiocb32)); if (result == 0) { do_munge_aiocb_user32_to_user(&aiocb32, &my_aiocb); } } if (result != 0) { result = EAGAIN; goto ExitRoutine; } /* NOTE - POSIX standard says a mismatch between the file */ /* descriptor passed in and the file descriptor embedded in */ /* the aiocb causes unspecified results. We return EBADF in */ /* that situation. */ if (uap->fd != my_aiocb.aio_fildes) { result = EBADF; goto ExitRoutine; } } aio_proc_lock(p); result = do_aio_cancel_locked(p, uap->fd, uap->aiocbp, 0); ASSERT_AIO_PROC_LOCK_OWNED(p); aio_proc_unlock(p); if (result != -1) { *retval = result; result = 0; goto ExitRoutine; } result = EBADF; ExitRoutine: KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_cancel) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->fd, uap->aiocbp, result, 0); return result; } /* * _aio_close - internal function used to clean up async IO requests for * a file descriptor that is closing. * THIS MAY BLOCK. */ __private_extern__ void _aio_close(proc_t p, int fd) { int error; /* quick check to see if there are any async IO requests queued up */ if (!aio_has_any_work()) { return; } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_close) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), fd, 0, 0, 0); /* cancel all async IO requests on our todo queues for this file descriptor */ aio_proc_lock(p); error = do_aio_cancel_locked(p, fd, USER_ADDR_NULL, AIO_CLOSE_WAIT); ASSERT_AIO_PROC_LOCK_OWNED(p); if (error == AIO_NOTCANCELED) { /* * AIO_NOTCANCELED is returned when we find an aio request for this process * and file descriptor on the active async IO queue. Active requests cannot * be cancelled so we must wait for them to complete. We will get a special * wake up call on our channel used to sleep for ALL active requests to * complete. This sleep channel (proc.AIO_CLEANUP_SLEEP_CHAN) is only used * when we must wait for all active aio requests. */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_close_sleep) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), fd, 0, 0, 0); while (aio_proc_has_active_requests_for_file(p, fd)) { msleep(&p->AIO_CLEANUP_SLEEP_CHAN, aio_proc_mutex(p), PRIBIO, "aio_close", 0); } } aio_proc_unlock(p); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_close) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), fd, 0, 0, 0); } /* * aio_error - return the error status associated with the async IO * request referred to by uap->aiocbp. The error status is the errno * value that would be set by the corresponding IO request (read, wrtie, * fdatasync, or sync). */ int aio_error(proc_t p, struct aio_error_args *uap, int *retval) { aio_workq_entry *entryp; int error; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_error) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->aiocbp, 0, 0, 0); /* see if there are any aios to check */ if (!aio_has_any_work()) { return EINVAL; } aio_proc_lock(p); /* look for a match on our queue of async IO requests that have completed */ TAILQ_FOREACH(entryp, &p->p_aio_doneq, aio_proc_link) { if (entryp->uaiocbp == uap->aiocbp) { ASSERT_AIO_FROM_PROC(entryp, p); *retval = entryp->errorval; error = 0; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_error_val) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), uap->aiocbp, *retval, 0, 0); goto ExitRoutine; } } /* look for a match on our queue of active async IO requests */ TAILQ_FOREACH(entryp, &p->p_aio_activeq, aio_proc_link) { if (entryp->uaiocbp == uap->aiocbp) { ASSERT_AIO_FROM_PROC(entryp, p); *retval = EINPROGRESS; error = 0; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_error_activeq) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), uap->aiocbp, *retval, 0, 0); goto ExitRoutine; } } error = EINVAL; ExitRoutine: KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_error) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->aiocbp, error, 0, 0); aio_proc_unlock(p); return error; } /* * aio_fsync - asynchronously force all IO operations associated * with the file indicated by the file descriptor (uap->aiocbp->aio_fildes) and * queued at the time of the call to the synchronized completion state. * NOTE - we do not support op O_DSYNC at this point since we do not support the * fdatasync() call. */ int aio_fsync(proc_t p, struct aio_fsync_args *uap, int *retval) { aio_entry_flags_t fsync_kind; int error; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_fsync) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->aiocbp, uap->op, 0, 0); *retval = 0; /* 0 := O_SYNC for binary backward compatibility with Panther */ if (uap->op == O_SYNC || uap->op == 0) { fsync_kind = AIO_FSYNC; } else if (uap->op == O_DSYNC) { fsync_kind = AIO_DSYNC; } else { *retval = -1; error = EINVAL; goto ExitRoutine; } error = aio_queue_async_request(p, uap->aiocbp, fsync_kind); if (error != 0) { *retval = -1; } ExitRoutine: KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_fsync) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->aiocbp, error, 0, 0); return error; } /* aio_read - asynchronously read uap->aiocbp->aio_nbytes bytes from the * file descriptor (uap->aiocbp->aio_fildes) into the buffer * (uap->aiocbp->aio_buf). */ int aio_read(proc_t p, struct aio_read_args *uap, int *retval) { int error; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_read) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->aiocbp, 0, 0, 0); *retval = 0; error = aio_queue_async_request(p, uap->aiocbp, AIO_READ); if (error != 0) { *retval = -1; } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_read) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->aiocbp, error, 0, 0); return error; } /* * aio_return - return the return status associated with the async IO * request referred to by uap->aiocbp. The return status is the value * that would be returned by corresponding IO request (read, write, * fdatasync, or sync). This is where we release kernel resources * held for async IO call associated with the given aiocb pointer. */ int aio_return(proc_t p, struct aio_return_args *uap, user_ssize_t *retval) { aio_workq_entry *entryp; int error = EINVAL; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_return) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->aiocbp, 0, 0, 0); /* See if there are any entries to check */ if (!aio_has_any_work()) { goto ExitRoutine; } aio_proc_lock(p); *retval = 0; /* look for a match on our queue of async IO requests that have completed */ TAILQ_FOREACH(entryp, &p->p_aio_doneq, aio_proc_link) { ASSERT_AIO_FROM_PROC(entryp, p); /* * With kevent notification, the completion will be done when the event * is processed. */ if ((entryp->uaiocbp == uap->aiocbp) && (entryp->aiocb.aio_sigevent.sigev_notify != SIGEV_KEVENT)) { /* Done and valid for aio_return(), pull it off the list */ aio_proc_remove_done_locked(p, entryp); *retval = entryp->returnval; error = (entryp->returnval == -1) ? entryp->errorval : 0; aio_proc_unlock(p); aio_entry_unref(entryp); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_return_val) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), uap->aiocbp, *retval, 0, 0); goto ExitRoutine; } } /* look for a match on our queue of active async IO requests */ TAILQ_FOREACH(entryp, &p->p_aio_activeq, aio_proc_link) { ASSERT_AIO_FROM_PROC(entryp, p); if (entryp->uaiocbp == uap->aiocbp) { error = EINPROGRESS; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_return_activeq) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), uap->aiocbp, *retval, 0, 0); break; } } aio_proc_unlock(p); ExitRoutine: KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_return) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->aiocbp, error, 0, 0); return error; } /* * _aio_exec - internal function used to clean up async IO requests for * a process that is going away due to exec(). We cancel any async IOs * we can and wait for those already active. We also disable signaling * for cancelled or active aio requests that complete. * This routine MAY block! */ __private_extern__ void _aio_exec(proc_t p) { KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_exec) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), 0, 0, 0, 0); _aio_exit(p); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_exec) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), 0, 0, 0, 0); } /* * _aio_exit - internal function used to clean up async IO requests for * a process that is terminating (via exit() or exec()). We cancel any async IOs * we can and wait for those already active. We also disable signaling * for cancelled or active aio requests that complete. This routine MAY block! */ __private_extern__ void _aio_exit(proc_t p) { TAILQ_HEAD(, aio_workq_entry) tofree = TAILQ_HEAD_INITIALIZER(tofree); aio_workq_entry *entryp, *tmp; int error; /* quick check to see if there are any async IO requests queued up */ if (!aio_has_any_work()) { workq_aio_mark_exiting(p); workq_aio_exit(p); return; } workq_aio_mark_exiting(p); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_exit) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), 0, 0, 0, 0); aio_proc_lock(p); /* * cancel async IO requests on the todo work queue and wait for those * already active to complete. */ error = do_aio_cancel_locked(p, -1, USER_ADDR_NULL, AIO_EXIT_WAIT); ASSERT_AIO_PROC_LOCK_OWNED(p); if (error == AIO_NOTCANCELED) { /* * AIO_NOTCANCELED is returned when we find an aio request for this process * on the active async IO queue. Active requests cannot be cancelled so we * must wait for them to complete. We will get a special wake up call on * our channel used to sleep for ALL active requests to complete. This sleep * channel (proc.AIO_CLEANUP_SLEEP_CHAN) is only used when we must wait for all * active aio requests. */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_exit_sleep) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), 0, 0, 0, 0); while (aio_has_active_requests_for_process(p)) { msleep(&p->AIO_CLEANUP_SLEEP_CHAN, aio_proc_mutex(p), PRIBIO, "aio_exit", 0); } } assert(!aio_has_active_requests_for_process(p)); /* release all aio resources used by this process */ TAILQ_FOREACH_SAFE(entryp, &p->p_aio_doneq, aio_proc_link, tmp) { ASSERT_AIO_FROM_PROC(entryp, p); aio_proc_remove_done_locked(p, entryp); TAILQ_INSERT_TAIL(&tofree, entryp, aio_proc_link); } aio_proc_unlock(p); workq_aio_exit(p); /* free all the entries outside of the aio_proc_lock() */ TAILQ_FOREACH_SAFE(entryp, &tofree, aio_proc_link, tmp) { entryp->aio_proc_link.tqe_prev = NULL; aio_entry_unref(entryp); } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_exit) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), 0, 0, 0, 0); } static bool should_cancel(aio_workq_entry *entryp, int fd, user_addr_t aiocbp, aio_entry_flags_t reason) { if (reason & AIO_EXIT_WAIT) { /* caller is _aio_exit() */ return true; } if (fd != entryp->aiocb.aio_fildes) { /* not the file we're looking for */ return false; } /* * aio_cancel() or _aio_close() cancel * everything for a given fd when aiocbp is NULL */ return aiocbp == USER_ADDR_NULL || entryp->uaiocbp == aiocbp; } /* * do_aio_cancel_locked - cancel async IO requests (if possible). We get called by * aio_cancel, close, and at exit. * There are three modes of operation: 1) cancel all async IOs for a process - * fd is 0 and aiocbp is NULL 2) cancel all async IOs for file descriptor - fd * is > 0 and aiocbp is NULL 3) cancel one async IO associated with the given * aiocbp. * Returns -1 if no matches were found, AIO_CANCELED when we cancelled all * target async IO requests, AIO_NOTCANCELED if we could not cancel all * target async IO requests, and AIO_ALLDONE if all target async IO requests * were already complete. * WARNING - do not deference aiocbp in this routine, it may point to user * land data that has not been copied in (when called from aio_cancel()) * * Called with proc locked, and returns the same way. */ static int do_aio_cancel_locked(proc_t p, int fd, user_addr_t aiocbp, aio_entry_flags_t reason) { bool multiple_matches = (aiocbp == USER_ADDR_NULL); aio_workq_entry *entryp, *tmp; int result; ASSERT_AIO_PROC_LOCK_OWNED(p); /* look for a match on our queue of async todo work. */ again: result = -1; TAILQ_FOREACH_SAFE(entryp, &p->p_aio_activeq, aio_proc_link, tmp) { ASSERT_AIO_FROM_PROC(entryp, p); if (!should_cancel(entryp, fd, aiocbp, reason)) { continue; } if (reason) { /* mark the entry as blocking close or exit/exec */ entryp->flags |= reason; if ((entryp->flags & AIO_EXIT_WAIT) && (entryp->flags & AIO_CLOSE_WAIT)) { panic("Close and exit flags set at the same time"); } } /* Can only be cancelled if it's still on a work queue */ if (aio_entry_try_workq_remove(p, entryp)) { entryp->errorval = ECANCELED; entryp->returnval = -1; /* Now it's officially cancelled. Do the completion */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_cancel_async_workq) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), fd, 0, 0); do_aio_completion_and_unlock(p, entryp, AIO_CANCELLED); aio_proc_lock(p); if (multiple_matches) { /* * Restart from the head of the proc active queue since it * may have been changed while we were away doing completion * processing. * * Note that if we found an uncancellable AIO before, we will * either find it again or discover that it's been completed, * so resetting the result will not cause us to return success * despite outstanding AIOs. */ goto again; } return AIO_CANCELED; } /* * It's been taken off the active queue already, i.e. is in flight. * All we can do is ask for notification. */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_cancel_activeq) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), fd, 0, 0); result = AIO_NOTCANCELED; if (!multiple_matches) { return result; } } /* * if we didn't find any matches on the todo or active queues then look for a * match on our queue of async IO requests that have completed and if found * return AIO_ALLDONE result. * * Proc AIO lock is still held. */ if (result == -1) { TAILQ_FOREACH(entryp, &p->p_aio_doneq, aio_proc_link) { ASSERT_AIO_FROM_PROC(entryp, p); if (should_cancel(entryp, fd, aiocbp, reason)) { KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_cancel_doneq) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), fd, 0, 0); result = AIO_ALLDONE; if (!multiple_matches) { return result; } } } } return result; } /* * aio_suspend - suspend the calling thread until at least one of the async * IO operations referenced by uap->aiocblist has completed, until a signal * interrupts the function, or uap->timeoutp time interval (optional) has * passed. * Returns 0 if one or more async IOs have completed else -1 and errno is * set appropriately - EAGAIN if timeout elapses or EINTR if an interrupt * woke us up. */ int aio_suspend(proc_t p, struct aio_suspend_args *uap, int *retval) { __pthread_testcancel(1); return aio_suspend_nocancel(p, (struct aio_suspend_nocancel_args *)uap, retval); } int aio_suspend_nocancel(proc_t p, struct aio_suspend_nocancel_args *uap, int *retval) { int error; int i; uint64_t abstime; struct user_timespec ts; aio_workq_entry *entryp; user_addr_t *aiocbpp; size_t aiocbpp_size; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_suspend) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->nent, 0, 0, 0); *retval = -1; abstime = 0; aiocbpp = NULL; if (!aio_has_any_work()) { error = EINVAL; goto ExitThisRoutine; } if (uap->nent < 1 || uap->nent > aio_max_requests_per_process || os_mul_overflow(sizeof(user_addr_t), uap->nent, &aiocbpp_size)) { error = EINVAL; goto ExitThisRoutine; } if (uap->timeoutp != USER_ADDR_NULL) { if (proc_is64bit(p)) { struct user64_timespec temp; error = copyin(uap->timeoutp, &temp, sizeof(temp)); if (error == 0) { ts.tv_sec = (user_time_t)temp.tv_sec; ts.tv_nsec = (user_long_t)temp.tv_nsec; } } else { struct user32_timespec temp; error = copyin(uap->timeoutp, &temp, sizeof(temp)); if (error == 0) { ts.tv_sec = temp.tv_sec; ts.tv_nsec = temp.tv_nsec; } } if (error != 0) { error = EAGAIN; goto ExitThisRoutine; } if (ts.tv_sec < 0 || ts.tv_nsec < 0 || ts.tv_nsec >= 1000000000) { error = EINVAL; goto ExitThisRoutine; } nanoseconds_to_absolutetime((uint64_t)ts.tv_sec * NSEC_PER_SEC + ts.tv_nsec, &abstime); clock_absolutetime_interval_to_deadline(abstime, &abstime); } aiocbpp = (user_addr_t *)kalloc_data(aiocbpp_size, Z_WAITOK); if (aiocbpp == NULL || aio_copy_in_list(p, uap->aiocblist, aiocbpp, uap->nent)) { error = EAGAIN; goto ExitThisRoutine; } /* check list of aio requests to see if any have completed */ check_for_our_aiocbp: aio_proc_lock_spin(p); for (i = 0; i < uap->nent; i++) { user_addr_t aiocbp; /* NULL elements are legal so check for 'em */ aiocbp = *(aiocbpp + i); if (aiocbp == USER_ADDR_NULL) { continue; } /* return immediately if any aio request in the list is done */ TAILQ_FOREACH(entryp, &p->p_aio_doneq, aio_proc_link) { ASSERT_AIO_FROM_PROC(entryp, p); if (entryp->uaiocbp == aiocbp) { aio_proc_unlock(p); *retval = 0; error = 0; goto ExitThisRoutine; } } } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_suspend_sleep) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), uap->nent, 0, 0, 0); /* * wait for an async IO to complete or a signal fires or timeout expires. * we return EAGAIN (35) for timeout expiration and EINTR (4) when a signal * interrupts us. If an async IO completes before a signal fires or our * timeout expires, we get a wakeup call from aio_work_thread(). */ error = msleep1(&p->AIO_SUSPEND_SLEEP_CHAN, aio_proc_mutex(p), PCATCH | PWAIT | PDROP, "aio_suspend", abstime); if (error == 0) { /* * got our wakeup call from aio_work_thread(). * Since we can get a wakeup on this channel from another thread in the * same process we head back up to make sure this is for the correct aiocbp. * If it is the correct aiocbp we will return from where we do the check * (see entryp->uaiocbp == aiocbp after check_for_our_aiocbp label) * else we will fall out and just sleep again. */ goto check_for_our_aiocbp; } else if (error == EWOULDBLOCK) { /* our timeout expired */ error = EAGAIN; } else { /* we were interrupted */ error = EINTR; } ExitThisRoutine: if (aiocbpp != NULL) { kfree_data(aiocbpp, aiocbpp_size); } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_suspend) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->nent, error, 0, 0); return error; } /* aio_write - asynchronously write uap->aiocbp->aio_nbytes bytes to the * file descriptor (uap->aiocbp->aio_fildes) from the buffer * (uap->aiocbp->aio_buf). */ int aio_write(proc_t p, struct aio_write_args *uap, int *retval __unused) { int error; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_write) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->aiocbp, 0, 0, 0); error = aio_queue_async_request(p, uap->aiocbp, AIO_WRITE); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_write) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), uap->aiocbp, error, 0, 0); return error; } static int aio_copy_in_list(proc_t procp, user_addr_t aiocblist, user_addr_t *aiocbpp, int nent) { int result; /* copyin our aiocb pointers from list */ result = copyin(aiocblist, aiocbpp, proc_is64bit(procp) ? (nent * sizeof(user64_addr_t)) : (nent * sizeof(user32_addr_t))); if (result) { return result; } /* * We depend on a list of user_addr_t's so we need to * munge and expand when these pointers came from a * 32-bit process */ if (!proc_is64bit(procp)) { /* copy from last to first to deal with overlap */ user32_addr_t *my_ptrp = ((user32_addr_t *)aiocbpp) + (nent - 1); user_addr_t *my_addrp = aiocbpp + (nent - 1); for (int i = 0; i < nent; i++, my_ptrp--, my_addrp--) { *my_addrp = (user_addr_t) (*my_ptrp); } } return 0; } static int aio_copy_in_sigev(proc_t procp, user_addr_t sigp, struct user_sigevent *sigev) { int result = 0; if (sigp == USER_ADDR_NULL) { goto out; } /* * We need to munge aio_sigevent since it contains pointers. * Since we do not know if sigev_value is an int or a ptr we do * NOT cast the ptr to a user_addr_t. This means if we send * this info back to user space we need to remember sigev_value * was not expanded for the 32-bit case. * * Notes: This does NOT affect us since we don't support * sigev_value yet in the aio context. */ if (proc_is64bit(procp)) { #if __LP64__ struct user64_sigevent sigevent64; result = copyin(sigp, &sigevent64, sizeof(sigevent64)); if (result == 0) { sigev->sigev_notify = sigevent64.sigev_notify; sigev->sigev_signo = sigevent64.sigev_signo; sigev->sigev_value.size_equivalent.sival_int = sigevent64.sigev_value.size_equivalent.sival_int; sigev->sigev_notify_function = sigevent64.sigev_notify_function; sigev->sigev_notify_attributes = sigevent64.sigev_notify_attributes; } #else panic("64bit process on 32bit kernel is not supported"); #endif } else { struct user32_sigevent sigevent32; result = copyin(sigp, &sigevent32, sizeof(sigevent32)); if (result == 0) { sigev->sigev_notify = sigevent32.sigev_notify; sigev->sigev_signo = sigevent32.sigev_signo; sigev->sigev_value.size_equivalent.sival_int = sigevent32.sigev_value.sival_int; sigev->sigev_notify_function = CAST_USER_ADDR_T(sigevent32.sigev_notify_function); sigev->sigev_notify_attributes = CAST_USER_ADDR_T(sigevent32.sigev_notify_attributes); } } if (result != 0) { result = EAGAIN; } out: return result; } /* * validate user_sigevent. at this point we only support * sigev_notify equal to SIGEV_SIGNAL or SIGEV_NONE. this means * sigev_value, sigev_notify_function, and sigev_notify_attributes * are ignored, since SIGEV_THREAD is unsupported. This is consistent * with no [RTS] (RalTime Signal) option group support. */ static int aio_sigev_validate(const struct user_sigevent *sigev) { switch (sigev->sigev_notify) { case SIGEV_SIGNAL: { int signum; /* make sure we have a valid signal number */ signum = sigev->sigev_signo; if (signum <= 0 || signum >= NSIG || signum == SIGKILL || signum == SIGSTOP) { return EINVAL; } } break; case SIGEV_NONE: break; case SIGEV_KEVENT: /* * The sigev_signo should contain the descriptor of the kqueue. * Validate that it contains some sane value. */ if (sigev->sigev_signo <= 0 || sigev->sigev_signo > maxfilesperproc) { return EINVAL; } break; case SIGEV_THREAD: /* Unsupported [RTS] */ default: return EINVAL; } return 0; } /* * aio_try_enqueue_work_locked * * Queue up the entry on the aio asynchronous work queue in priority order * based on the relative priority of the request. We calculate the relative * priority using the nice value of the caller and the value * * Parameters: procp Process queueing the I/O * entryp The work queue entry being queued * leader The work leader if any * * Returns: Whether the enqueue was successful * * Notes: This function is used for both lio_listio and aio * * XXX: At some point, we may have to consider thread priority * rather than process priority, but we don't maintain the * adjusted priority for threads the POSIX way. * * Called with proc locked. */ static bool aio_try_enqueue_work_locked(proc_t procp, aio_workq_entry *entryp, aio_workq_entry *leader) { ASSERT_AIO_PROC_LOCK_OWNED(procp); /* Onto proc queue */ if (!aio_try_proc_insert_active_locked(procp, entryp)) { return false; } if (leader) { aio_entry_ref(leader); /* consumed in do_aio_completion_and_unlock */ leader->lio_pending++; entryp->lio_leader = leader; } /* And work queue */ aio_entry_ref(entryp); /* consumed in do_aio_completion_and_unlock */ if (bootarg_aio_new_workq) { if (!workq_aio_entry_add_locked(procp, entryp)) { (void)os_ref_release(&entryp->aio_refcount); return false; } } else { aio_workq_t queue = aio_entry_workq(entryp); aio_workq_lock_spin(queue); aio_workq_add_entry_locked(queue, entryp); waitq_wakeup64_one(&queue->aioq_waitq, CAST_EVENT64_T(queue), THREAD_AWAKENED, WAITQ_WAKEUP_DEFAULT); aio_workq_unlock(queue); } KERNEL_DEBUG_CONSTANT(BSDDBG_CODE(DBG_BSD_AIO, AIO_work_queued) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(procp), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->flags, entryp->aiocb.aio_fildes, 0); KERNEL_DEBUG_CONSTANT(BSDDBG_CODE(DBG_BSD_AIO, AIO_work_queued) | DBG_FUNC_END, entryp->aiocb.aio_offset, 0, entryp->aiocb.aio_nbytes, 0, 0); return true; } /* * EV_FLAG0/1 are filter specific flags. * Repurpose EV_FLAG0 to indicate the kevent is registered from kernel. */ #define EV_KERNEL EV_FLAG0 /* Internal function to register/unregister a AIO kevent. */ static int aio_register_kevent_internal(proc_t procp, aio_workq_entry *entryp, struct user_sigevent *sigp, uintptr_t ident, int16_t filter, uint16_t flags) { struct kevent_qos_s kev; struct fileproc *fp = NULL; kqueue_t kqu; int kqfd = sigp->sigev_signo; int error; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_register_kevent) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(procp), VM_KERNEL_ADDRPERM(entryp), VM_KERNEL_ADDRPERM(entryp->uaiocbp), kqfd, 0); error = fp_get_ftype(procp, kqfd, DTYPE_KQUEUE, EBADF, &fp); if (error) { goto exit; } kqu.kq = (struct kqueue *)fp_get_data(fp); memset(&kev, 0, sizeof(kev)); kev.ident = ident; kev.filter = filter; kev.flags = flags; kev.udata = sigp->sigev_value.sival_ptr; kev.data = (intptr_t)entryp; error = kevent_register(kqu.kq, &kev, NULL); assert((error & FILTER_REGISTER_WAIT) == 0); if (kev.flags & EV_ERROR) { error = (int)kev.data; } exit: if (fp) { fp_drop(procp, kqfd, fp, 0); } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_register_kevent) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(procp), VM_KERNEL_ADDRPERM(entryp), error, 0, 0); return error; } static int aio_register_kevent(proc_t procp, aio_workq_entry *entryp, struct user_sigevent *sigp, uintptr_t ident, int16_t filter) { /* * Set the EV_FLAG0 to indicate the event is registered from the kernel. * This flag is later checked in filt_aioattach() to determine if the * kevent is registered from kernel or user-space. */ uint16_t flags = EV_ADD | EV_ENABLE | EV_CLEAR | EV_ONESHOT | EV_KERNEL; int error; error = aio_register_kevent_internal(procp, entryp, sigp, ident, filter, flags); if (!error) { entryp->flags |= AIO_KEVENT_REGISTERED; } return error; } static int aio_unregister_kevent(proc_t procp, aio_workq_entry *entryp, struct user_sigevent *sigp, uintptr_t ident, int16_t filter) { /* * Set the EV_KERNEL to indicate the event is unregistered from the kernel. */ uint16_t flags = EV_DELETE | EV_KERNEL; int error; error = aio_register_kevent_internal(procp, entryp, sigp, ident, filter, flags); if (!error) { entryp->flags &= ~AIO_KEVENT_REGISTERED; } return error; } /* * lio_listio - initiate a list of IO requests. We process the list of * aiocbs either synchronously (mode == LIO_WAIT) or asynchronously * (mode == LIO_NOWAIT). * * The caller gets error and return status for each aiocb in the list * via aio_error and aio_return. We must keep completed requests until * released by the aio_return call. */ int lio_listio(proc_t p, struct lio_listio_args *uap, int *retval __unused) { aio_workq_entry *entries[AIO_LISTIO_MAX] = { }; user_addr_t aiocbpp[AIO_LISTIO_MAX]; struct user_sigevent aiosigev = { }; int result = 0; int lio_count = 0; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_listio) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), uap->nent, uap->mode, 0, 0); if (!(uap->mode == LIO_NOWAIT || uap->mode == LIO_WAIT)) { result = EINVAL; goto ExitRoutine; } if (uap->nent < 1 || uap->nent > AIO_LISTIO_MAX) { result = EINVAL; goto ExitRoutine; } /* * Use sigevent passed in to lio_listio for each of our calls, but * only do completion notification after the last request completes. */ if (uap->sigp != USER_ADDR_NULL) { result = aio_copy_in_sigev(p, uap->sigp, &aiosigev); if (result) { goto ExitRoutine; } result = aio_sigev_validate(&aiosigev); if (result) { goto ExitRoutine; } } if (aio_copy_in_list(p, uap->aiocblist, aiocbpp, uap->nent)) { result = EAGAIN; goto ExitRoutine; } /* * allocate/parse all entries */ for (int i = 0; i < uap->nent; i++) { aio_workq_entry *entryp; /* NULL elements are legal so check for 'em */ if (aiocbpp[i] == USER_ADDR_NULL) { continue; } result = aio_create_queue_entry(p, aiocbpp[i], AIO_LIO, &entryp); if (result) { goto ExitRoutine; } /* * This refcount is cleaned up on exit if the entry * isn't submitted */ entries[lio_count++] = entryp; if (uap->mode == LIO_WAIT) { continue; } if (entryp->aiocb.aio_sigevent.sigev_notify != SIGEV_KEVENT) { /* Set signal hander, if any */ entryp->aiocb.aio_sigevent = aiosigev; } else { /* * For SIGEV_KEVENT, every AIO in the list would get its own kevent * notification upon completion as opposed to SIGEV_SIGNAL which a * single notification is deliverd when all AIOs have completed. */ result = aio_register_kevent(p, entryp, &entryp->aiocb.aio_sigevent, (uintptr_t)entryp->uaiocbp, EVFILT_AIO); if (result) { goto ExitRoutine; } } } if (lio_count == 0) { /* There's nothing to submit */ goto ExitRoutine; } /* * Past this point we're commited and will not bail out * * - keep a reference on the leader for LIO_WAIT * - perform the submissions and optionally wait */ aio_workq_entry *leader = entries[0]; if (uap->mode == LIO_WAIT) { aio_entry_ref(leader); /* consumed below */ } aio_proc_lock(p); for (int i = 0; i < lio_count; i++) { if (aio_try_enqueue_work_locked(p, entries[i], leader)) { workq_aio_wakeup_thread(p); /* this may drop and reacquire the proc lock */ entries[i] = NULL; /* the entry was submitted */ } else { result = EAGAIN; } } if (uap->mode == LIO_WAIT && result == 0) { leader->flags |= AIO_LIO_WAIT; while (leader->lio_pending) { /* If we were interrupted, fail out (even if all finished) */ if (msleep(leader, aio_proc_mutex(p), PCATCH | PRIBIO | PSPIN, "lio_listio", 0) != 0) { result = EINTR; break; } } leader->flags &= ~AIO_LIO_WAIT; } aio_proc_unlock(p); if (uap->mode == LIO_WAIT) { aio_entry_unref(leader); } ExitRoutine: /* Consume unsubmitted entries */ for (int i = 0; i < lio_count; i++) { aio_workq_entry *entryp = entries[i]; if (entryp) { if (entryp->flags & AIO_KEVENT_REGISTERED) { (void)aio_unregister_kevent(p, entryp, &entryp->aiocb.aio_sigevent, (uintptr_t)entryp->uaiocbp, EVFILT_AIO); } aio_entry_unref(entryp); } } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_listio) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), result, 0, 0, 0); return result; } /* * aio worker thread. this is where all the real work gets done. * we get a wake up call on sleep channel &aio_anchor.aio_async_workq * after new work is queued up. */ __attribute__((noreturn)) static void aio_work_thread(void *arg __unused, wait_result_t wr __unused) { aio_workq_entry *entryp; int error; vm_map_switch_context_t switch_ctx; struct uthread *uthreadp = NULL; proc_t p = NULL; for (;;) { /* * returns with the entry ref'ed. * sleeps until work is available. */ entryp = aio_get_some_work(); p = entryp->procp; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_worker_thread) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->flags, 0, 0); /* * Assume the target's address space identity for the duration * of the IO. Note: don't need to have the entryp locked, * because the proc and map don't change until it's freed. */ uthreadp = (struct uthread *) current_uthread(); assert(get_task_map(proc_task(current_proc())) != entryp->aio_map); assert(uthreadp->uu_aio_task == NULL); /* * workq entries at this stage cause _aio_exec() and _aio_exit() to * block until we hit `do_aio_completion_and_unlock()` below, * which means that it is safe to dereference p->task without * holding a lock or taking references. */ uthreadp->uu_aio_task = proc_task(p); switch_ctx = vm_map_switch_to(entryp->aio_map); if ((entryp->flags & AIO_READ) != 0) { error = do_aio_read(entryp); } else if ((entryp->flags & AIO_WRITE) != 0) { error = do_aio_write(entryp); } else if ((entryp->flags & (AIO_FSYNC | AIO_DSYNC)) != 0) { error = do_aio_fsync(entryp); } else { error = EINVAL; } /* Restore old map */ vm_map_switch_back(switch_ctx); uthreadp->uu_aio_task = NULL; /* liberate unused map */ vm_map_deallocate(entryp->aio_map); entryp->aio_map = VM_MAP_NULL; KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_worker_thread) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->errorval, entryp->returnval, 0); /* we're done with the IO request so pop it off the active queue and */ /* push it on the done queue */ aio_proc_lock(p); entryp->errorval = error; do_aio_completion_and_unlock(p, entryp, AIO_COMPLETED); } } /* * aio_get_some_work - get the next async IO request that is ready to be executed. * aio_fsync complicates matters a bit since we cannot do the fsync until all async * IO requests at the time the aio_fsync call came in have completed. * NOTE - AIO_LOCK must be held by caller */ static aio_workq_entry * aio_get_some_work(void) { aio_workq_entry *entryp = NULL; aio_workq_t queue = NULL; /* Just one queue for the moment. In the future there will be many. */ queue = &aio_anchor.aio_async_workqs[0]; aio_workq_lock_spin(queue); /* * Hold the queue lock. * * pop some work off the work queue and add to our active queue * Always start with the queue lock held. */ while ((entryp = TAILQ_FIRST(&queue->aioq_entries))) { /* * Pull of of work queue. Once it's off, it can't be cancelled, * so we can take our ref once we drop the queue lock. */ aio_workq_remove_entry_locked(queue, entryp); aio_workq_unlock(queue); /* * Check if it's an fsync that must be delayed. No need to lock the entry; * that flag would have been set at initialization. */ if ((entryp->flags & AIO_FSYNC) != 0) { /* * Check for unfinished operations on the same file * in this proc's queue. */ aio_proc_lock_spin(entryp->procp); if (aio_delay_fsync_request(entryp)) { /* It needs to be delayed. Put it back on the end of the work queue */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_fsync_delay) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(entryp->procp), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); aio_proc_unlock(entryp->procp); aio_workq_lock_spin(queue); aio_workq_add_entry_locked(queue, entryp); continue; } aio_proc_unlock(entryp->procp); } return entryp; } /* We will wake up when someone enqueues something */ waitq_assert_wait64(&queue->aioq_waitq, CAST_EVENT64_T(queue), THREAD_UNINT, 0); aio_workq_unlock(queue); thread_block(aio_work_thread); __builtin_unreachable(); } /* * aio_delay_fsync_request - look to see if this aio_fsync request should be delayed. * A big, simple hammer: only send it off if it's the most recently filed IO which has * not been completed. */ static boolean_t aio_delay_fsync_request(aio_workq_entry *entryp) { if (proc_in_teardown(entryp->procp)) { /* * we can't delay FSYNCS when in teardown as it will confuse _aio_exit, * if it was dequeued, then we must now commit to it */ return FALSE; } if (entryp == TAILQ_FIRST(&entryp->procp->p_aio_activeq)) { return FALSE; } return TRUE; } int aio_create_queue_entry(proc_t procp, user_addr_t aiocbp, aio_entry_flags_t flags, aio_workq_entry **entrypp) { int error; aio_workq_entry *entryp; entryp = zalloc_flags(aio_workq_zonep, Z_WAITOK | Z_ZERO); entryp->procp = procp; entryp->uaiocbp = aiocbp; entryp->flags = flags; /* consumed in aio_return or _aio_exit */ os_ref_init(&entryp->aio_refcount, &aio_refgrp); if (proc_is64bit(procp)) { struct user64_aiocb aiocb64; if ((error = copyin(aiocbp, &aiocb64, sizeof(aiocb64))) != 0) { goto error_exit; } do_munge_aiocb_user64_to_user(&aiocb64, &entryp->aiocb); } else { struct user32_aiocb aiocb32; if ((error = copyin(aiocbp, &aiocb32, sizeof(aiocb32))) != 0) { goto error_exit; } do_munge_aiocb_user32_to_user(&aiocb32, &entryp->aiocb); } /* do some more validation on the aiocb and embedded file descriptor */ if ((error = aio_validate(procp, entryp)) != 0) { goto error_exit; } /* get a reference on the current_thread, which is passed in vfs_context. */ entryp->context = *vfs_context_current(); thread_reference(entryp->context.vc_thread); kauth_cred_ref(entryp->context.vc_ucred); if (bootarg_aio_new_workq) { entryp->aio_map = VM_MAP_NULL; workq_aio_prepare(procp); } else { /* get a reference to the user land map in order to keep it around */ entryp->aio_map = get_task_map(proc_task(procp)); vm_map_reference(entryp->aio_map); } *entrypp = entryp; return 0; error_exit: zfree(aio_workq_zonep, entryp); return error; } /* * aio_queue_async_request - queue up an async IO request on our work queue then * wake up one of our worker threads to do the actual work. We get a reference * to our caller's user land map in order to keep it around while we are * processing the request. */ static int aio_queue_async_request(proc_t procp, user_addr_t aiocbp, aio_entry_flags_t flags) { aio_workq_entry *entryp; int result; result = aio_create_queue_entry(procp, aiocbp, flags, &entryp); if (result) { goto error_noalloc; } aio_proc_lock(procp); if (entryp->aiocb.aio_sigevent.sigev_notify == SIGEV_KEVENT) { result = aio_register_kevent(procp, entryp, &entryp->aiocb.aio_sigevent, (uintptr_t)entryp->uaiocbp, EVFILT_AIO); if (result) { goto error_exit; } } if (!aio_try_enqueue_work_locked(procp, entryp, NULL)) { (void)aio_unregister_kevent(procp, entryp, &entryp->aiocb.aio_sigevent, (uintptr_t)entryp->uaiocbp, EVFILT_AIO); result = EAGAIN; goto error_exit; } workq_aio_wakeup_thread_and_unlock(procp); return 0; error_exit: /* * This entry has not been queued up so no worries about * unlocked state and aio_map */ aio_proc_unlock(procp); aio_free_request(entryp); error_noalloc: return result; } /* * aio_free_request - remove our reference on the user land map and * free the work queue entry resources. The entry is off all lists * and has zero refcount, so no one can have a pointer to it. */ static void aio_free_request(aio_workq_entry *entryp) { if (entryp->aio_proc_link.tqe_prev || entryp->aio_workq_link.tqe_prev) { panic("aio_workq_entry %p being freed while still enqueued", entryp); } /* remove our reference to the user land map. */ if (VM_MAP_NULL != entryp->aio_map) { vm_map_deallocate(entryp->aio_map); } /* remove our reference to thread which enqueued the request */ if (entryp->context.vc_thread) { thread_deallocate(entryp->context.vc_thread); } kauth_cred_unref(&entryp->context.vc_ucred); zfree(aio_workq_zonep, entryp); } /* * aio_validate * * validate the aiocb passed in by one of the aio syscalls. */ static int aio_validate(proc_t p, aio_workq_entry *entryp) { struct fileproc *fp; int flag; int result; result = 0; if ((entryp->flags & AIO_LIO) != 0) { if (entryp->aiocb.aio_lio_opcode == LIO_READ) { entryp->flags |= AIO_READ; } else if (entryp->aiocb.aio_lio_opcode == LIO_WRITE) { entryp->flags |= AIO_WRITE; } else if (entryp->aiocb.aio_lio_opcode == LIO_NOP) { return 0; } else { return EINVAL; } } flag = FREAD; if ((entryp->flags & (AIO_WRITE | AIO_FSYNC | AIO_DSYNC)) != 0) { flag = FWRITE; } if ((entryp->flags & (AIO_READ | AIO_WRITE)) != 0) { if (entryp->aiocb.aio_nbytes > INT_MAX || entryp->aiocb.aio_buf == USER_ADDR_NULL || entryp->aiocb.aio_offset < 0) { return EINVAL; } } result = aio_sigev_validate(&entryp->aiocb.aio_sigevent); if (result) { return result; } /* validate the file descriptor and that the file was opened * for the appropriate read / write access. */ proc_fdlock(p); fp = fp_get_noref_locked(p, entryp->aiocb.aio_fildes); if (fp == NULL) { result = EBADF; } else if ((fp->fp_glob->fg_flag & flag) == 0) { /* we don't have read or write access */ result = EBADF; } else if ((entryp->flags & AIO_WRITE) && fp_isguarded(fp, GUARD_WRITE)) { /* Check for write guard on write operations */ result = fp_guard_exception(p, entryp->aiocb.aio_fildes, fp, kGUARD_EXC_WRITE); } else if (FILEGLOB_DTYPE(fp->fp_glob) != DTYPE_VNODE) { /* this is not a file */ result = ESPIPE; } else { fp->fp_flags |= FP_AIOISSUED; } proc_fdunlock(p); return result; } /* * do_aio_completion_and_unlock. Handle async IO completion. */ static void do_aio_completion_and_unlock(proc_t p, aio_workq_entry *entryp, aio_entry_flags_t reason) { aio_workq_entry *leader = entryp->lio_leader; int lio_pending = 0; bool do_signal, do_kevent; ASSERT_AIO_PROC_LOCK_OWNED(p); aio_proc_move_done_locked(p, entryp); entryp->flags |= reason; if (leader) { lio_pending = --leader->lio_pending; if (lio_pending < 0) { panic("lio_pending accounting mistake"); } if (lio_pending == 0 && (leader->flags & AIO_LIO_WAIT)) { wakeup(leader); } entryp->lio_leader = NULL; /* no dangling pointers please */ } /* * need to handle case where a process is trying to exit, exec, or * close and is currently waiting for active aio requests to complete. * If AIO_CLEANUP_WAIT is set then we need to look to see if there are any * other requests in the active queue for this process. If there are * none then wakeup using the AIO_CLEANUP_SLEEP_CHAN tsleep channel. * If there are some still active then do nothing - we only want to * wakeup when all active aio requests for the process are complete. */ do_signal = do_kevent = false; if (__improbable(entryp->flags & AIO_EXIT_WAIT)) { KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_cleanup_wait) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); if (!aio_has_active_requests_for_process(p)) { /* * no active aio requests for this process, continue exiting. In this * case, there should be no one else waiting on the proc in AIO... */ wakeup_one((caddr_t)&p->AIO_CLEANUP_SLEEP_CHAN); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_cleanup_wake) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); } } else if (entryp->aiocb.aio_sigevent.sigev_notify == SIGEV_SIGNAL) { /* * If this was the last request in the group, or not part of * a group, and that a signal is desired, send one. */ do_signal = (lio_pending == 0); } else if (entryp->aiocb.aio_sigevent.sigev_notify == SIGEV_KEVENT) { /* * For SIGEV_KEVENT, every AIO (even it is part of a group) would get * a kevent notification. */ do_kevent = true; } if (__improbable(entryp->flags & AIO_CLOSE_WAIT)) { KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_cleanup_wait) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); if (!aio_proc_has_active_requests_for_file(p, entryp->aiocb.aio_fildes)) { /* Can't wakeup_one(); multiple closes might be in progress. */ wakeup(&p->AIO_CLEANUP_SLEEP_CHAN); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_cleanup_wake) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); } } aio_proc_unlock(p); if (do_signal) { KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_sig) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->aiocb.aio_sigevent.sigev_signo, 0, 0); psignal(p, entryp->aiocb.aio_sigevent.sigev_signo); } else if (do_kevent) { KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_kevent) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->aiocb.aio_sigevent.sigev_signo, 0, 0); /* We only support one event type for either completed/cancelled AIO. */ lck_mtx_lock(&aio_klist_lock); KNOTE(&aio_klist, 1); lck_mtx_unlock(&aio_klist_lock); } /* * A thread in aio_suspend() wants to known about completed IOs. If it checked * the done list before we moved our AIO there, then it already asserted its wait, * and we can wake it up without holding the lock. If it checked the list after * we did our move, then it already has seen the AIO that we moved. Herego, we * can do our wakeup without holding the lock. */ wakeup(&p->AIO_SUSPEND_SLEEP_CHAN); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_completion_suspend_wake) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); aio_entry_unref(entryp); /* see aio_try_enqueue_work_locked */ if (leader) { aio_entry_unref(leader); /* see lio_listio */ } } /* * do_aio_read */ static int do_aio_read(aio_workq_entry *entryp) { struct proc *p = entryp->procp; struct fileproc *fp; int error; if ((error = fp_lookup(p, entryp->aiocb.aio_fildes, &fp, 0))) { return error; } if (fp->fp_glob->fg_flag & FREAD) { error = dofileread(&entryp->context, fp, entryp->aiocb.aio_buf, entryp->aiocb.aio_nbytes, entryp->aiocb.aio_offset, FOF_OFFSET, &entryp->returnval); } else { error = EBADF; } fp_drop(p, entryp->aiocb.aio_fildes, fp, 0); return error; } /* * do_aio_write */ static int do_aio_write(aio_workq_entry *entryp) { struct proc *p = entryp->procp; struct fileproc *fp; int error; if ((error = fp_lookup(p, entryp->aiocb.aio_fildes, &fp, 0))) { return error; } if (fp->fp_glob->fg_flag & FWRITE) { int flags = 0; if ((fp->fp_glob->fg_flag & O_APPEND) == 0) { flags |= FOF_OFFSET; } /* NB: tell dofilewrite the offset, and to use the proc cred */ error = dofilewrite(&entryp->context, fp, entryp->aiocb.aio_buf, entryp->aiocb.aio_nbytes, entryp->aiocb.aio_offset, flags, &entryp->returnval); } else { error = EBADF; } fp_drop(p, entryp->aiocb.aio_fildes, fp, 0); return error; } /* * aio_has_active_requests_for_process - return whether the process has active * requests pending. */ static bool aio_has_active_requests_for_process(proc_t procp) { return !TAILQ_EMPTY(&procp->p_aio_activeq); } /* * Called with the proc locked. */ static bool aio_proc_has_active_requests_for_file(proc_t procp, int fd) { aio_workq_entry *entryp; TAILQ_FOREACH(entryp, &procp->p_aio_activeq, aio_proc_link) { if (entryp->aiocb.aio_fildes == fd) { return true; } } return false; } /* * do_aio_fsync */ static int do_aio_fsync(aio_workq_entry *entryp) { struct proc *p = entryp->procp; struct vnode *vp; struct fileproc *fp; int sync_flag; int error; /* * We are never called unless either AIO_FSYNC or AIO_DSYNC are set. * * If AIO_DSYNC is set, we can tell the lower layers that it is OK * to mark for update the metadata not strictly necessary for data * retrieval, rather than forcing it to disk. * * If AIO_FSYNC is set, we have to also wait for metadata not really * necessary to data retrival are committed to stable storage (e.g. * atime, mtime, ctime, etc.). * * Metadata necessary for data retrieval ust be committed to stable * storage in either case (file length, etc.). */ if (entryp->flags & AIO_FSYNC) { sync_flag = MNT_WAIT; } else { sync_flag = MNT_DWAIT; } error = fp_get_ftype(p, entryp->aiocb.aio_fildes, DTYPE_VNODE, ENOTSUP, &fp); if (error != 0) { entryp->returnval = -1; return error; } vp = fp_get_data(fp); if ((error = vnode_getwithref(vp)) == 0) { error = VNOP_FSYNC(vp, sync_flag, &entryp->context); (void)vnode_put(vp); } else { entryp->returnval = -1; } fp_drop(p, entryp->aiocb.aio_fildes, fp, 0); return error; } /* * is_already_queued - runs through our queues to see if the given * aiocbp / process is there. Returns TRUE if there is a match * on any of our aio queues. * * Called with proc aio lock held (can be held spin) */ static boolean_t is_already_queued(proc_t procp, user_addr_t aiocbp) { aio_workq_entry *entryp; boolean_t result; result = FALSE; /* look for matches on our queue of async IO requests that have completed */ TAILQ_FOREACH(entryp, &procp->p_aio_doneq, aio_proc_link) { if (aiocbp == entryp->uaiocbp) { result = TRUE; goto ExitThisRoutine; } } /* look for matches on our queue of active async IO requests */ TAILQ_FOREACH(entryp, &procp->p_aio_activeq, aio_proc_link) { if (aiocbp == entryp->uaiocbp) { result = TRUE; goto ExitThisRoutine; } } ExitThisRoutine: return result; } /* * aio initialization */ __private_extern__ void aio_init(void) { for (int i = 0; i < AIO_NUM_WORK_QUEUES; i++) { aio_workq_init(&aio_anchor.aio_async_workqs[i]); } if (bootarg_aio_new_workq) { printf("New aio workqueue implementation selected\n"); } else { _aio_create_worker_threads(aio_worker_threads); } klist_init(&aio_klist); clock_interval_to_absolutetime_interval(aio_wq_reduce_pool_window.usecs, NSEC_PER_USEC, &aio_wq_reduce_pool_window.abstime); } /* * aio worker threads created here. */ __private_extern__ void _aio_create_worker_threads(int num) { int i; /* create some worker threads to handle the async IO requests */ for (i = 0; i < num; i++) { thread_t myThread; if (KERN_SUCCESS != kernel_thread_start(aio_work_thread, NULL, &myThread)) { printf("%s - failed to create a work thread \n", __FUNCTION__); } else { thread_deallocate(myThread); } } } /* * Return the current activation utask */ task_t get_aiotask(void) { return current_uthread()->uu_aio_task; } /* * In the case of an aiocb from a * 32-bit process we need to expand some longs and pointers to the correct * sizes in order to let downstream code always work on the same type of * aiocb (in our case that is a user_aiocb) */ static void do_munge_aiocb_user32_to_user(struct user32_aiocb *my_aiocbp, struct user_aiocb *the_user_aiocbp) { the_user_aiocbp->aio_fildes = my_aiocbp->aio_fildes; the_user_aiocbp->aio_offset = my_aiocbp->aio_offset; the_user_aiocbp->aio_buf = CAST_USER_ADDR_T(my_aiocbp->aio_buf); the_user_aiocbp->aio_nbytes = my_aiocbp->aio_nbytes; the_user_aiocbp->aio_reqprio = my_aiocbp->aio_reqprio; the_user_aiocbp->aio_lio_opcode = my_aiocbp->aio_lio_opcode; /* special case here. since we do not know if sigev_value is an */ /* int or a ptr we do NOT cast the ptr to a user_addr_t. This */ /* means if we send this info back to user space we need to remember */ /* sigev_value was not expanded for the 32-bit case. */ /* NOTE - this does NOT affect us since we don't support sigev_value */ /* yet in the aio context. */ //LP64 the_user_aiocbp->aio_sigevent.sigev_notify = my_aiocbp->aio_sigevent.sigev_notify; the_user_aiocbp->aio_sigevent.sigev_signo = my_aiocbp->aio_sigevent.sigev_signo; the_user_aiocbp->aio_sigevent.sigev_value.sival_ptr = my_aiocbp->aio_sigevent.sigev_value.sival_ptr; the_user_aiocbp->aio_sigevent.sigev_notify_function = CAST_USER_ADDR_T(my_aiocbp->aio_sigevent.sigev_notify_function); the_user_aiocbp->aio_sigevent.sigev_notify_attributes = CAST_USER_ADDR_T(my_aiocbp->aio_sigevent.sigev_notify_attributes); } /* Similar for 64-bit user process, so that we don't need to satisfy * the alignment constraints of the original user64_aiocb */ #if !__LP64__ __dead2 #endif static void do_munge_aiocb_user64_to_user(struct user64_aiocb *my_aiocbp, struct user_aiocb *the_user_aiocbp) { #if __LP64__ the_user_aiocbp->aio_fildes = my_aiocbp->aio_fildes; the_user_aiocbp->aio_offset = my_aiocbp->aio_offset; the_user_aiocbp->aio_buf = my_aiocbp->aio_buf; the_user_aiocbp->aio_nbytes = my_aiocbp->aio_nbytes; the_user_aiocbp->aio_reqprio = my_aiocbp->aio_reqprio; the_user_aiocbp->aio_lio_opcode = my_aiocbp->aio_lio_opcode; the_user_aiocbp->aio_sigevent.sigev_notify = my_aiocbp->aio_sigevent.sigev_notify; the_user_aiocbp->aio_sigevent.sigev_signo = my_aiocbp->aio_sigevent.sigev_signo; the_user_aiocbp->aio_sigevent.sigev_value.sival_ptr = my_aiocbp->aio_sigevent.sigev_value.sival_ptr; the_user_aiocbp->aio_sigevent.sigev_notify_function = my_aiocbp->aio_sigevent.sigev_notify_function; the_user_aiocbp->aio_sigevent.sigev_notify_attributes = my_aiocbp->aio_sigevent.sigev_notify_attributes; #else #pragma unused(my_aiocbp, the_user_aiocbp) panic("64bit process on 32bit kernel is not supported"); #endif } static int filt_aioattach(struct knote *kn, struct kevent_qos_s *kev) { aio_workq_entry *entryp = (aio_workq_entry *)kev->data; /* Don't allow kevent registration from the user-space. */ if ((kev->flags & EV_KERNEL) == 0) { knote_set_error(kn, EPERM); return 0; } kev->flags &= ~EV_KERNEL; /* Clear the 'kn_fflags' state afte the knote has been processed. */ kn->kn_flags |= EV_CLEAR; /* Associate the knote with the AIO work. */ knote_kn_hook_set_raw(kn, (void *)entryp); aio_entry_ref(entryp); lck_mtx_lock(&aio_klist_lock); KNOTE_ATTACH(&aio_klist, kn); lck_mtx_unlock(&aio_klist_lock); return 0; } static void filt_aiodetach(struct knote *kn) { aio_workq_entry *entryp = knote_kn_hook_get_raw(kn); lck_mtx_lock(&aio_klist_lock); KNOTE_DETACH(&aio_klist, kn); lck_mtx_unlock(&aio_klist_lock); if (entryp) { aio_entry_unref(entryp); } } /* * The 'f_event' is called with 'aio_klist_lock' held when KNOTE() was called * in do_aio_completion_and_unlock(). */ static int filt_aioevent(struct knote *kn, long hint) { aio_workq_entry *entryp; int activate = 0; /* * The 'f_event' and 'f_process' can run concurrently so it is possible * the aio_workq_entry has been detached from the knote when the * filt_aioprocess() was called earlier. In this case, we will skip * activating the event. */ entryp = knote_kn_hook_get_raw(kn); if (__improbable(entryp == NULL)) { goto out; } /* We can only activate the filter if the AIO work has completed. */ if (entryp->flags & AIO_COMPLETED) { kn->kn_fflags |= hint; activate = FILTER_ACTIVE; } out: return activate; } static int filt_aiotouch(struct knote *kn __unused, struct kevent_qos_s *kev) { /* We treat any kevent update from the kernel or user-space as an error. */ kev->flags |= EV_ERROR; kev->data = ENOTSUP; return 0; } static int filt_aioprocess(struct knote *kn, struct kevent_qos_s *kev) { aio_workq_entry *entryp; proc_t p; int res = 0; entryp = knote_kn_hook_get_raw(kn); assert(entryp); p = entryp->procp; if (kn->kn_fflags) { /* Propagate the error status and return value back to the user. */ kn->kn_ext[0] = entryp->errorval; kn->kn_ext[1] = entryp->returnval; knote_fill_kevent(kn, kev, 0); aio_proc_lock(p); aio_proc_remove_done_locked(p, entryp); aio_proc_unlock(p); aio_entry_unref(entryp); res = FILTER_ACTIVE; } return res; } SECURITY_READ_ONLY_EARLY(struct filterops) aio_filtops = { .f_isfd = 0, .f_attach = filt_aioattach, .f_detach = filt_aiodetach, .f_event = filt_aioevent, .f_touch = filt_aiotouch, .f_process = filt_aioprocess, }; #pragma mark per process aio workqueue /* * The per process workq threads call this function to handle the aio request. The threads * belong to the same process so we don't need to change the vm maps as we would for kernel * threads. */ static int workq_aio_process_entry(aio_workq_entry *entryp) { proc_t p = entryp->procp; int error; assert(current_proc() == p && current_thread() != vfs_context_thread(&entryp->context)); KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_WQ_process_entry) | DBG_FUNC_START, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->flags, 0, 0); if ((entryp->flags & AIO_READ) != 0) { error = do_aio_read(entryp); } else if ((entryp->flags & AIO_WRITE) != 0) { error = do_aio_write(entryp); } else if ((entryp->flags & (AIO_FSYNC | AIO_DSYNC)) != 0) { if ((entryp->flags & AIO_FSYNC) != 0) { /* * Check for unfinished operations on the same file * in this proc's queue. */ aio_proc_lock_spin(p); if (aio_delay_fsync_request(entryp)) { /* It needs to be delayed. Put it back on the end of the work queue */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_fsync_delay) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), 0, 0, 0); /* The references on this entry havn't been consumed */ if (!workq_aio_entry_add_locked(p, entryp)) { entryp->errorval = ECANCELED; entryp->returnval = -1; /* Now it's officially cancelled. Do the completion */ KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_cancel_async_workq) | DBG_FUNC_NONE, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->aiocb.aio_fildes, 0, 0); do_aio_completion_and_unlock(p, entryp, AIO_CANCELLED); } else { workq_aio_wakeup_thread_and_unlock(p); } return 0; } aio_proc_unlock(entryp->procp); } error = do_aio_fsync(entryp); } else { error = EINVAL; } KERNEL_DEBUG(BSDDBG_CODE(DBG_BSD_AIO, AIO_WQ_process_entry) | DBG_FUNC_END, VM_KERNEL_ADDRPERM(p), VM_KERNEL_ADDRPERM(entryp->uaiocbp), entryp->errorval, entryp->returnval, 0); /* we're done with the IO request so pop it off the active queue and */ /* push it on the done queue */ aio_proc_lock(p); entryp->errorval = error; do_aio_completion_and_unlock(p, entryp, AIO_COMPLETED); return 0; } /* * The functions below implement a workqueue for aio which is taken from the * workqueue implementation for libdispatch/pthreads. They are stripped down versions * of the corresponding functions for libdispatch/pthreads. */ static int aio_workq_sysctl_handle_usecs SYSCTL_HANDLER_ARGS { #pragma unused(arg2) struct aio_workq_usec_var *v = arg1; int error = sysctl_handle_int(oidp, &v->usecs, 0, req); if (error || !req->newptr) { return error; } clock_interval_to_absolutetime_interval(v->usecs, NSEC_PER_USEC, &v->abstime); return 0; } #pragma mark wq_flags #define AIO_WQ_DEAD 0x1000 static inline uint32_t _wa_flags(workq_aio_t wq_aio) { return os_atomic_load(&wq_aio->wa_flags, relaxed); } static inline bool _wq_exiting(workq_aio_t wq_aio) { return _wa_flags(wq_aio) & WQ_EXITING; } static inline bool _wq_dead(workq_aio_t wq_aio) { return _wa_flags(wq_aio) & AIO_WQ_DEAD; } #define AIO_WQPTR_IS_INITING_VALUE ((workq_aio_t)~(uintptr_t)0) static workq_aio_t proc_get_aio_wqptr_fast(struct proc *p) { return os_atomic_load(&p->p_aio_wqptr, relaxed); } static workq_aio_t proc_get_aio_wqptr(struct proc *p) { workq_aio_t wq_aio = proc_get_aio_wqptr_fast(p); return wq_aio == AIO_WQPTR_IS_INITING_VALUE ? NULL : wq_aio; } static void proc_set_aio_wqptr(struct proc *p, workq_aio_t wq_aio) { wq_aio = os_atomic_xchg(&p->p_aio_wqptr, wq_aio, release); if (wq_aio == AIO_WQPTR_IS_INITING_VALUE) { proc_lock(p); thread_wakeup(&p->p_aio_wqptr); proc_unlock(p); } } static bool proc_init_aio_wqptr_or_wait(struct proc *p) { workq_aio_t wq_aio; proc_lock(p); wq_aio = os_atomic_load(&p->p_aio_wqptr, relaxed); if (wq_aio == NULL) { os_atomic_store(&p->p_aio_wqptr, AIO_WQPTR_IS_INITING_VALUE, relaxed); proc_unlock(p); return true; } if (wq_aio == AIO_WQPTR_IS_INITING_VALUE) { assert_wait(&p->p_aio_wqptr, THREAD_UNINT); proc_unlock(p); thread_block(THREAD_CONTINUE_NULL); } else { proc_unlock(p); } return false; } static inline event_t workq_aio_parked_wait_event(struct uthread *uth) { return (event_t)&uth->uu_workq_stackaddr; } static inline void workq_aio_thread_wakeup(struct uthread *uth) { thread_wakeup_thread(workq_aio_parked_wait_event(uth), get_machthread(uth)); } /* * Routine: workq_aio_mark_exiting * * Function: Mark the work queue such that new threads will not be added to the * work queue after we return. * * Conditions: Called against the current process. */ static void workq_aio_mark_exiting(proc_t p) { workq_aio_t wq_aio = proc_get_aio_wqptr(p); uint32_t wq_flags; if (!wq_aio) { return; } wq_flags = os_atomic_or_orig(&wq_aio->wa_flags, WQ_EXITING, relaxed); if (__improbable(wq_flags & WQ_EXITING)) { panic("workq_aio_mark_exiting_locked called twice"); } /* * Opportunistically try to cancel thread calls that are likely in flight. * workq_aio_exit() will do the proper cleanup. */ if (wq_flags & WQ_DEATH_CALL_SCHEDULED) { thread_call_cancel(wq_aio->wa_death_call); } } static void workq_aio_exit(proc_t p) { workq_aio_t wq_aio; wq_aio = os_atomic_xchg(&p->p_aio_wqptr, NULL, release); if (!wq_aio) { return; } /* * Thread calls are always scheduled by the proc itself or under the * workqueue spinlock if WQ_EXITING is not yet set. * * Either way, when this runs, the proc has no threads left beside * the one running this very code, so we know no thread call can be * dispatched anymore. */ thread_call_cancel_wait(wq_aio->wa_death_call); thread_call_free(wq_aio->wa_death_call); /* * Clean up workqueue data structures for threads that exited and * didn't get a chance to clean up after themselves. * * idle/new threads should have been interrupted and died on their own */ assert(TAILQ_EMPTY(&wq_aio->wa_aioq_entries)); assert(TAILQ_EMPTY(&wq_aio->wa_thrunlist)); if (wq_aio->wa_nthreads) { os_atomic_or(&wq_aio->wa_flags, AIO_WQ_DEAD, relaxed); aio_proc_lock_spin(p); if (wq_aio->wa_nthreads) { struct uthread *uth; TAILQ_FOREACH(uth, &wq_aio->wa_thidlelist, uu_workq_entry) { if (uth->uu_workq_flags & UT_WORKQ_DYING) { workq_aio_thread_wakeup(uth); continue; } wq_aio->wa_thdying_count++; uth->uu_workq_flags |= UT_WORKQ_DYING; workq_aio_thread_wakeup(uth); } while (wq_aio->wa_nthreads) { msleep(&wq_aio->wa_nthreads, aio_proc_mutex(p), PRIBIO | PSPIN, "aio_workq_exit", 0); } } aio_proc_unlock(p); } assertf(TAILQ_EMPTY(&wq_aio->wa_thidlelist), "wa_thidlecount = %d, wa_thdying_count = %d", wq_aio->wa_thidlecount, wq_aio->wa_thdying_count); assertf(wq_aio->wa_thidlecount == 0, "wa_thidlecount = %d, wa_thdying_count = %d", wq_aio->wa_thidlecount, wq_aio->wa_thdying_count); assertf(wq_aio->wa_thdying_count == 0, "wa_thdying_count = %d", wq_aio->wa_thdying_count); kfree_type(workq_aio_s, wq_aio); } static int workq_aio_open(struct proc *p) { workq_aio_t wq_aio; int error = 0; if (proc_get_aio_wqptr(p) == NULL) { if (proc_init_aio_wqptr_or_wait(p) == FALSE) { assert(proc_get_aio_wqptr(p) != NULL); goto out; } wq_aio = kalloc_type(workq_aio_s, Z_WAITOK | Z_ZERO | Z_NOFAIL); wq_aio->wa_proc = p; TAILQ_INIT(&wq_aio->wa_thidlelist); TAILQ_INIT(&wq_aio->wa_thrunlist); TAILQ_INIT(&wq_aio->wa_aioq_entries); wq_aio->wa_death_call = thread_call_allocate_with_options( workq_aio_kill_old_threads_call, wq_aio, THREAD_CALL_PRIORITY_USER, THREAD_CALL_OPTIONS_ONCE); proc_set_aio_wqptr(p, wq_aio); } out: return error; } #pragma mark aio workqueue idle thread accounting static inline struct uthread * workq_oldest_killable_idle_aio_thread(workq_aio_t wq_aio) { return TAILQ_LAST(&wq_aio->wa_thidlelist, workq_aio_uthread_head); } static inline uint64_t workq_kill_delay_for_idle_aio_thread() { return aio_wq_reduce_pool_window.abstime; } static inline bool workq_should_kill_idle_aio_thread(struct uthread *uth, uint64_t now) { uint64_t delay = workq_kill_delay_for_idle_aio_thread(); return now - uth->uu_save.uus_workq_park_data.idle_stamp > delay; } static void workq_aio_death_call_schedule(workq_aio_t wq_aio, uint64_t deadline) { uint32_t wa_flags = os_atomic_load(&wq_aio->wa_flags, relaxed); if (wa_flags & (WQ_EXITING | WQ_DEATH_CALL_SCHEDULED)) { return; } os_atomic_or(&wq_aio->wa_flags, WQ_DEATH_CALL_SCHEDULED, relaxed); /* * <rdar://problem/13139182> Due to how long term timers work, the leeway * can't be too short, so use 500ms which is long enough that we will not * wake up the CPU for killing threads, but short enough that it doesn't * fall into long-term timer list shenanigans. */ thread_call_enter_delayed_with_leeway(wq_aio->wa_death_call, NULL, deadline, aio_wq_reduce_pool_window.abstime / 10, THREAD_CALL_DELAY_LEEWAY | THREAD_CALL_DELAY_USER_BACKGROUND); } /* * `decrement` is set to the number of threads that are no longer dying: * - because they have been resuscitated just in time (workq_pop_idle_thread) * - or have been killed (workq_thread_terminate). */ static void workq_aio_death_policy_evaluate(workq_aio_t wq_aio, uint16_t decrement) { struct uthread *uth; assert(wq_aio->wa_thdying_count >= decrement); #if 0 if (decrement) { printf("VV_DEBUG_AIO : %s:%d : pid = %d, ctid = %d, after decrement thdying_count = %d\n", __FUNCTION__, __LINE__, proc_pid(current_proc()), thread_get_ctid(thr), wq_aio->wa_thdying_count - decrement); } #endif if ((wq_aio->wa_thdying_count -= decrement) > 0) { return; } if (wq_aio->wa_thidlecount <= 1) { return; } if (((uth = workq_oldest_killable_idle_aio_thread(wq_aio)) == NULL)) { return; } uint64_t now = mach_absolute_time(); uint64_t delay = workq_kill_delay_for_idle_aio_thread(); if (now - uth->uu_save.uus_workq_park_data.idle_stamp > delay) { if (!(uth->uu_workq_flags & UT_WORKQ_DYING)) { wq_aio->wa_thdying_count++; uth->uu_workq_flags |= UT_WORKQ_DYING; } workq_aio_thread_wakeup(uth); return; } workq_aio_death_call_schedule(wq_aio, uth->uu_save.uus_workq_park_data.idle_stamp + delay); } static void workq_aio_kill_old_threads_call(void *param0, void *param1 __unused) { workq_aio_t wq_aio = param0; aio_proc_lock_spin(wq_aio->wa_proc); WQ_AIO_TRACE_WQ(AIO_WQ_aio_death_call | DBG_FUNC_START, wq_aio); os_atomic_andnot(&wq_aio->wa_flags, WQ_DEATH_CALL_SCHEDULED, relaxed); workq_aio_death_policy_evaluate(wq_aio, 0); WQ_AIO_TRACE_WQ(AIO_WQ_aio_death_call | DBG_FUNC_END, wq_aio); aio_proc_unlock(wq_aio->wa_proc);; } #define WORKQ_UNPARK_FOR_DEATH_WAS_IDLE 0x1 #define WQ_SETUP_NONE 0 __attribute__((noreturn, noinline)) static void workq_aio_unpark_for_death_and_unlock(proc_t p, workq_aio_t wq_aio, struct uthread *uth, uint32_t death_flags, __unused uint32_t setup_flags) { if (death_flags & WORKQ_UNPARK_FOR_DEATH_WAS_IDLE) { wq_aio->wa_thidlecount--; TAILQ_REMOVE(&wq_aio->wa_thidlelist, uth, uu_workq_entry); } if (uth->uu_workq_flags & UT_WORKQ_DYING) { wq_aio->wa_thdying_count--; } assert(wq_aio->wa_nthreads > 0); wq_aio->wa_nthreads--; WQ_AIO_TRACE_WQ(AIO_WQ_aio_thread_terminate | DBG_FUNC_NONE, wq_aio); if (_wq_dead(wq_aio) && (wq_aio->wa_nthreads == 0)) { wakeup(&wq_aio->wa_nthreads); } aio_proc_unlock(p); thread_t th = get_machthread(uth); assert(th == current_thread()); thread_deallocate(th); thread_terminate(th); thread_exception_return(); __builtin_unreachable(); } static void workq_push_idle_aio_thread(proc_t p, workq_aio_t wq_aio, struct uthread *uth, uint32_t setup_flags) { uint64_t now = mach_absolute_time(); uth->uu_workq_flags &= ~(UT_WORKQ_RUNNING); TAILQ_REMOVE(&wq_aio->wa_thrunlist, uth, uu_workq_entry); uth->uu_save.uus_workq_park_data.idle_stamp = now; struct uthread *oldest = workq_oldest_killable_idle_aio_thread(wq_aio); uint16_t cur_idle = wq_aio->wa_thidlecount; if (_wq_exiting(wq_aio) || (wq_aio->wa_thdying_count == 0 && oldest && workq_should_kill_idle_aio_thread(oldest, now))) { /* * Immediately kill threads if we have too may of them. * * And swap "place" with the oldest one we'd have woken up. * This is a relatively desperate situation where we really * need to kill threads quickly and it's best to kill * the one that's currently on core than context switching. */ if (oldest) { oldest->uu_save.uus_workq_park_data.idle_stamp = now; TAILQ_REMOVE(&wq_aio->wa_thidlelist, oldest, uu_workq_entry); TAILQ_INSERT_HEAD(&wq_aio->wa_thidlelist, oldest, uu_workq_entry); } if (!(uth->uu_workq_flags & UT_WORKQ_DYING)) { wq_aio->wa_thdying_count++; uth->uu_workq_flags |= UT_WORKQ_DYING; } workq_aio_unpark_for_death_and_unlock(p, wq_aio, uth, 0, setup_flags); __builtin_unreachable(); } struct uthread *tail = TAILQ_LAST(&wq_aio->wa_thidlelist, workq_aio_uthread_head); cur_idle += 1; wq_aio->wa_thidlecount = cur_idle; uth->uu_save.uus_workq_park_data.has_stack = false; TAILQ_INSERT_HEAD(&wq_aio->wa_thidlelist, uth, uu_workq_entry); if (!tail) { uint64_t delay = workq_kill_delay_for_idle_aio_thread(); workq_aio_death_call_schedule(wq_aio, now + delay); } } /* * We have no work to do, park ourselves on the idle list. * * Consumes the workqueue lock and does not return. */ __attribute__((noreturn, noinline)) static void workq_aio_park_and_unlock(proc_t p, workq_aio_t wq_aio, struct uthread *uth, uint32_t setup_flags) { assert(uth == current_uthread()); assert(uth->uu_kqr_bound == NULL); workq_push_idle_aio_thread(p, wq_aio, uth, setup_flags); // may not return if (uth->uu_workq_flags & UT_WORKQ_DYING) { workq_aio_unpark_for_death_and_unlock(p, wq_aio, uth, WORKQ_UNPARK_FOR_DEATH_WAS_IDLE, setup_flags); __builtin_unreachable(); } WQ_AIO_TRACE_WQ(AIO_WQ_aio_thread_park | DBG_FUNC_NONE, wq_aio); thread_set_pending_block_hint(get_machthread(uth), kThreadWaitParkedWorkQueue); /* XXX this should probably be THREAD_UNINT */ assert_wait(workq_aio_parked_wait_event(uth), THREAD_INTERRUPTIBLE); aio_proc_unlock(p); thread_block(workq_aio_unpark_continue); __builtin_unreachable(); } #define WORKQ_POLICY_INIT(qos) \ (struct uu_workq_policy){ .qos_req = (qos), .qos_bucket = (qos) } /* * This function is always called with the workq lock. */ static void workq_aio_thread_reset_pri(struct uthread *uth, thread_t src_th) { thread_t th = get_machthread(uth); thread_qos_t qos = (thread_qos_t)proc_get_effective_thread_policy(src_th, TASK_POLICY_QOS); int priority = 31; int policy = POLICY_TIMESHARE; uth->uu_workq_pri = WORKQ_POLICY_INIT(qos); thread_set_workq_pri(th, qos, priority, policy); } static inline void workq_aio_thread_set_type(struct uthread *uth, uint16_t flags) { uth->uu_workq_flags &= ~(UT_WORKQ_OVERCOMMIT | UT_WORKQ_COOPERATIVE); uth->uu_workq_flags |= flags; } __attribute__((noreturn, noinline)) static void workq_aio_unpark_select_req_or_park_and_unlock(proc_t p, workq_aio_t wq_aio, struct uthread *uth, uint32_t setup_flags) { aio_workq_entry *entryp; thread_t last_thread = NULL; WQ_AIO_TRACE_WQ(AIO_WQ_aio_select_req | DBG_FUNC_START, wq_aio); thread_freeze_base_pri(get_machthread(uth)); workq_aio_thread_set_type(uth, 0); while ((entryp = TAILQ_FIRST(&wq_aio->wa_aioq_entries))) { if (__improbable(_wq_exiting(wq_aio))) { break; } TAILQ_REMOVE(&wq_aio->wa_aioq_entries, entryp, aio_workq_link); entryp->aio_workq_link.tqe_prev = NULL; /* Not on a workq */ aio_proc_unlock(p); thread_t thr = vfs_context_thread(&entryp->context); if (last_thread != thr) { workq_aio_thread_reset_pri(uth, thr); last_thread = thr; } /* this frees references to workq entry */ workq_aio_process_entry(entryp); ast_check_async_thread(); aio_proc_lock_spin(p); } WQ_AIO_TRACE_WQ(AIO_WQ_aio_select_req | DBG_FUNC_END, wq_aio); thread_unfreeze_base_pri(get_machthread(uth)); workq_aio_park_and_unlock(p, wq_aio, uth, setup_flags); } /* * parked idle thread wakes up */ __attribute__((noreturn, noinline)) static void workq_aio_unpark_continue(void *parameter __unused, wait_result_t wr) { thread_t th = current_thread(); struct uthread *uth = get_bsdthread_info(th); proc_t p = current_proc(); workq_aio_t wq_aio = proc_get_aio_wqptr_fast(p); aio_proc_lock_spin(p); if (__probable(uth->uu_workq_flags & UT_WORKQ_RUNNING)) { workq_aio_unpark_select_req_or_park_and_unlock(p, wq_aio, uth, WQ_SETUP_NONE); __builtin_unreachable(); } if (__probable(wr == THREAD_AWAKENED)) { /* * We were set running, but for the purposes of dying. */ assert(uth->uu_workq_flags & UT_WORKQ_DYING); assert((uth->uu_workq_flags & UT_WORKQ_NEW) == 0); } else { /* * workaround for <rdar://problem/38647347>, * in case we do hit userspace, make sure calling * workq_thread_terminate() does the right thing here, * and if we never call it, that workq_exit() will too because it sees * this thread on the runlist. */ assert(wr == THREAD_INTERRUPTED); if (!(uth->uu_workq_flags & UT_WORKQ_DYING)) { wq_aio->wa_thdying_count++; uth->uu_workq_flags |= UT_WORKQ_DYING; } } workq_aio_unpark_for_death_and_unlock(p, wq_aio, uth, WORKQ_UNPARK_FOR_DEATH_WAS_IDLE, WQ_SETUP_NONE); __builtin_unreachable(); } /* * Called by thread_create_workq_aio_waiting() during thread initialization, before * assert_wait, before the thread has been started. */ event_t aio_workq_thread_init_and_wq_lock(task_t task, thread_t th) { struct uthread *uth = get_bsdthread_info(th); uth->uu_workq_flags = UT_WORKQ_NEW; uth->uu_workq_pri = WORKQ_POLICY_INIT(THREAD_QOS_LEGACY); uth->uu_workq_thport = MACH_PORT_NULL; uth->uu_workq_stackaddr = 0; uth->uu_workq_pthread_kill_allowed = 0; thread_set_tag(th, THREAD_TAG_AIO_WORKQUEUE); thread_reset_workq_qos(th, THREAD_QOS_LEGACY); aio_proc_lock(get_bsdtask_info(task)); return workq_aio_parked_wait_event(uth); } /** * Try to add a new workqueue thread for aio. * * - called with workq lock held * - dropped and retaken around thread creation * - return with workq lock held * - aio threads do not call into pthread functions to setup or destroy stacks. */ static kern_return_t workq_aio_add_new_thread(proc_t p, workq_aio_t wq_aio) { kern_return_t kret; thread_t th; wq_aio->wa_nthreads++; aio_proc_unlock(p); kret = thread_create_aio_workq_waiting(proc_task(p), workq_aio_unpark_continue, &th); if (kret != KERN_SUCCESS) { WQ_AIO_TRACE(AIO_WQ_aio_thread_create_failed | DBG_FUNC_NONE, wq_aio, kret, 0, 0, 0); goto out; } /* * thread_create_aio_workq_waiting() will return with the wq lock held * on success, because it calls workq_thread_init_and_wq_lock(). */ struct uthread *uth = get_bsdthread_info(th); TAILQ_INSERT_TAIL(&wq_aio->wa_thidlelist, uth, uu_workq_entry); wq_aio->wa_thidlecount++; uth->uu_workq_flags &= ~UT_WORKQ_NEW; WQ_AIO_TRACE_WQ(AIO_WQ_aio_thread_create | DBG_FUNC_NONE, wq_aio); return kret; out: aio_proc_lock(p); /* * Do not redrive here if we went under wq_max_threads again, * it is the responsibility of the callers of this function * to do so when it fails. */ wq_aio->wa_nthreads--; return kret; } static void workq_aio_wakeup_thread_internal(proc_t p, bool unlock) { workq_aio_t wq_aio = proc_get_aio_wqptr(p); bool needs_wakeup = false; struct uthread *uth = NULL; if (!wq_aio) { goto out; } uth = TAILQ_FIRST(&wq_aio->wa_thidlelist); while (!uth && (wq_aio->wa_nthreads < WORKQUEUE_AIO_MAXTHREADS) && !(thread_get_tag(current_thread()) & THREAD_TAG_AIO_WORKQUEUE)) { if (workq_aio_add_new_thread(p, wq_aio) != KERN_SUCCESS) { break; } uth = TAILQ_FIRST(&wq_aio->wa_thidlelist); } if (!uth) { goto out; } TAILQ_REMOVE(&wq_aio->wa_thidlelist, uth, uu_workq_entry); wq_aio->wa_thidlecount--; TAILQ_INSERT_TAIL(&wq_aio->wa_thrunlist, uth, uu_workq_entry); assert((uth->uu_workq_flags & UT_WORKQ_RUNNING) == 0); uth->uu_workq_flags |= UT_WORKQ_RUNNING; WQ_AIO_TRACE_WQ(AIO_WQ_aio_thread_wakeup | DBG_FUNC_NONE, wq_aio); if (__improbable(uth->uu_workq_flags & UT_WORKQ_DYING)) { uth->uu_workq_flags ^= UT_WORKQ_DYING; workq_aio_death_policy_evaluate(wq_aio, 1); needs_wakeup = false; } else { needs_wakeup = true; } out: if (unlock) { aio_proc_unlock(p); } if (uth && needs_wakeup) { workq_aio_thread_wakeup(uth); } } static void workq_aio_wakeup_thread_and_unlock(proc_t p) { return workq_aio_wakeup_thread_internal(p, true); } static void workq_aio_wakeup_thread(proc_t p) { return workq_aio_wakeup_thread_internal(p, false); } void workq_aio_prepare(struct proc *p) { workq_aio_t wq_aio = proc_get_aio_wqptr(p); if (__improbable(!wq_aio && !proc_in_teardown(p))) { workq_aio_open(p); } } bool workq_aio_entry_add_locked(struct proc *p, aio_workq_entry *entryp) { workq_aio_t wq_aio = proc_get_aio_wqptr(p); bool ret = false; ASSERT_AIO_PROC_LOCK_OWNED(p); if (!proc_in_teardown(p) && wq_aio && !_wq_exiting(wq_aio)) { TAILQ_INSERT_TAIL(&wq_aio->wa_aioq_entries, entryp, aio_workq_link); ret = true; } return ret; } bool workq_aio_entry_remove_locked(struct proc *p, aio_workq_entry *entryp) { workq_aio_t wq_aio = proc_get_aio_wqptr(p); ASSERT_AIO_PROC_LOCK_OWNED(p); if (entryp->aio_workq_link.tqe_prev == NULL) { panic("Trying to remove an entry from a work queue, but it is not on a queue"); } TAILQ_REMOVE(&wq_aio->wa_aioq_entries, entryp, aio_workq_link); entryp->aio_workq_link.tqe_prev = NULL; /* Not on a workq */ return true; } |