1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622
//! 原子类型
//!
//! 原子类型提供线程之间的原始共享内存通信,并且是其他并发类型的构建块。
//!
//! Rust atomics 目前遵循与 [C++20 atomics][cpp] 相同的规则,特别是 `atomic_ref`。
//! 基本上,为 Rust 原子类型之一创建一个共享引用对应于在 C++ 中创建一个 `atomic_ref`; `atomic_ref` 是在视频生命周期结束时共享的。
//! (一个 Rust 原子类型,它是独占的或在一个惰性引用之后*不*对应于 C++ 中的 "atomic object",因为它可以通过非原子操作访问。)
//!
//! 该模块定义了一些原始类型的原子版本,包括 [`AtomicBool`],[`AtomicIsize`],[`AtomicUsize`],[`AtomicI8`],[`AtomicU16`] 等。
//! 原子类型表示可正确使用的操作,这些操作可在线程之间同步更新。
//!
//! 每种方法都使用一个 [`Ordering`] 来表示该操作的内存屏障的强度。这些顺序与 [C++20 原子排序][1] 相同。有关更多信息,请参见 [nomicon][2]。
//!
//! [cpp]: https://en.cppreference.com/w/cpp/atomic
//! [1]: https://en.cppreference.com/w/cpp/atomic/memory_order
//! [2]: ../../../nomicon/atomics.html
//!
//! 原子变量可以安全地在线程之间共享 (它们实现 [`Sync`]),但是它们本身并不提供共享机制并遵循 Rust 的 [线程模型](../../../std/thread/index.html#the-threading-model)。
//!
//! 共享原子变量的最常见方法是将其放入 [`Arc`][arc] (原子引用计数的共享指针)。
//!
//! [arc]: ../../../std/sync/struct.Arc.html
//!
//! 原子类型可以存储在静态变量中,可以使用常量初始化程序 (如 [`AtomicBool::new`]) 进行初始化。原子静态常用于懒惰的初始化。
//!
//! # Portability
//!
//! 如果可用,则保证该模块中的所有原子类型均为 [无锁][lock-free]。这意味着他们没有在内部获得一个整体互斥锁。不能保证原子类型和操作无需等待。
//! 这意味着可以使用比较和交换循环来实现类似 `fetch_or` 的操作。
//!
//! 原子操作可以在指令层用更大的原子来实现。例如,某些平台使用 4 字节原子指令来实现 `AtomicI8`。
//! 请注意,此仿真不应影响代码的正确性,这只是需要注意的事情。
//!
//! 此模块中的原子类型可能并非在所有平台上都可用。但是,这里的原子类型都是广泛可用的,并且通常可以依赖现有原子类型。一些值得注意的例外是:
//!
//! * 具有 32 位指针的 PowerPC 和 MIPS 平台没有 `AtomicU64` 或 `AtomicI64` 类型。
//! * 不支持 Linux 的 `armv5te` 等 ARM 平台只提供 `load` 和 `store` 操作,不支持 Compare 和 Swap (CAS) 操作,如 `swap`、`fetch_add` 等。
//! 此外,在 Linux 上,这些 CAS 操作是通过 [操作系统支持][operating system support] 实现的,这可能会降低性能。
//! * 带有 `thumbv6m` 的 ARM 目标仅提供 `load` 和 `store` 操作,不支持 (CAS) 比较和交换操作,如 `swap`、`fetch_add` 等。
//!
//! [operating system support]: https://www.kernel.org/doc/Documentation/arm/kernel_user_helpers.txt
//!
//! 请注意,可能会添加 future 平台,这些平台也不支持某些原子操作。最大程度地讲,可移植代码将要注意所使用的原子类型。
//! `AtomicUsize` 和 `AtomicIsize` 通常是最便携的,但即便如此,它们也并非随处可用。
//! 作为参考,`std` 库需要 `AtomicBool`s 和 pointer-sized atomics,尽管 `core` 不需要。
//!
//! `#[cfg(target_has_atomic)]` 属性可用于根据目标支持的位宽进行有条件的编译。
//! 它是为每个支持的大小设置的键值选项,其值 "8"、"16"、"32"、"64"、"128" 和 "ptr" 用于指针大小的原子。
//!
//! [lock-free]: https://en.wikipedia.org/wiki/Non-blocking_algorithm
//!
//! # Examples
//!
//! 一个简单的自旋锁:
//!
//! ```
//! use std::sync::Arc;
//! use std::sync::atomic::{AtomicUsize, Ordering};
//! use std::{hint, thread};
//!
//! fn main() {
//! let spinlock = Arc::new(AtomicUsize::new(1));
//!
//! let spinlock_clone = Arc::clone(&spinlock);
//! let thread = thread::spawn(move|| {
//! spinlock_clone.store(0, Ordering::SeqCst);
//! });
//!
//! // 等待另一个线程释放锁
//! while spinlock.load(Ordering::SeqCst) != 0 {
//! hint::spin_loop();
//! }
//!
//! if let Err(panic) = thread.join() {
//! println!("Thread had an error: {panic:?}");
//! }
//! }
//! ```
//!
//! 保持活动线程的数量:
//!
//! ```
//! use std::sync::atomic::{AtomicUsize, Ordering};
//!
//! static GLOBAL_THREAD_COUNT: AtomicUsize = AtomicUsize::new(0);
//!
//! let old_thread_count = GLOBAL_THREAD_COUNT.fetch_add(1, Ordering::SeqCst);
//! println!("live threads: {}", old_thread_count + 1);
//! ```
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
#![stable(feature = "rust1", since = "1.0.0")]
#![cfg_attr(not(target_has_atomic_load_store = "8"), allow(dead_code))]
#![cfg_attr(not(target_has_atomic_load_store = "8"), allow(unused_imports))]
#![rustc_diagnostic_item = "atomic_mod"]
use self::Ordering::*;
use crate::cell::UnsafeCell;
use crate::fmt;
use crate::intrinsics;
use crate::hint::spin_loop;
/// 可以在线程之间安全共享的布尔类型。
///
/// 此类型与 [`bool`] 具有相同的内存表示形式。
///
/// **Note**: 此类型仅在支持 `u8` 的原子加载和存储的平台上可用。
///
#[cfg(target_has_atomic_load_store = "8")]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_diagnostic_item = "AtomicBool"]
#[repr(C, align(1))]
pub struct AtomicBool {
v: UnsafeCell<u8>,
}
#[cfg(target_has_atomic_load_store = "8")]
#[stable(feature = "rust1", since = "1.0.0")]
impl Default for AtomicBool {
/// 创建一个初始化为 `false` 的 `AtomicBool`。
#[inline]
fn default() -> Self {
Self::new(false)
}
}
// Send 是为 AtomicBool 隐式实现的。
#[cfg(target_has_atomic_load_store = "8")]
#[stable(feature = "rust1", since = "1.0.0")]
unsafe impl Sync for AtomicBool {}
/// 可以在线程之间安全共享的裸指针类型。
///
/// 此类型与 `*mut T` 具有相同的内存表示形式。
///
/// **Note**: 此类型仅在支持原子加载和指针存储的平台上可用。
/// 它的大小取决于目标指针的大小。
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(not(test), rustc_diagnostic_item = "AtomicPtr")]
#[cfg_attr(target_pointer_width = "16", repr(C, align(2)))]
#[cfg_attr(target_pointer_width = "32", repr(C, align(4)))]
#[cfg_attr(target_pointer_width = "64", repr(C, align(8)))]
pub struct AtomicPtr<T> {
p: UnsafeCell<*mut T>,
}
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "rust1", since = "1.0.0")]
impl<T> Default for AtomicPtr<T> {
/// 创建一个空 `AtomicPtr<T>`。
fn default() -> AtomicPtr<T> {
AtomicPtr::new(crate::ptr::null_mut())
}
}
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "rust1", since = "1.0.0")]
unsafe impl<T> Send for AtomicPtr<T> {}
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "rust1", since = "1.0.0")]
unsafe impl<T> Sync for AtomicPtr<T> {}
/// 原子内存排序
///
/// 内存排序指定了原子操作同步内存的方式。
/// 在最弱的 [`Ordering::Relaxed`] 中,仅同步操作直接触摸的内存。
/// 另一方面,[`Ordering::SeqCst`] 操作的存储 - 加载对同步了其他内存,同时还保留了所有线程中此类操作的总顺序。
///
///
/// Rust 的内存排序和 [C++ 20 相同](https://en.cppreference.com/w/cpp/atomic/memory_order)。
///
/// 有关更多信息,请参见 [nomicon]。
///
/// [nomicon]: ../../../nomicon/atomics.html
///
///
#[stable(feature = "rust1", since = "1.0.0")]
#[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
#[non_exhaustive]
#[rustc_diagnostic_item = "Ordering"]
pub enum Ordering {
/// 没有排序约束,只有原子操作。
///
/// 对应于 C++ 20 中的 [`memory_order_relaxed`]。
///
/// [`memory_order_relaxed`]: https://en.cppreference.com/w/cpp/atomic/memory_order#Relaxed_ordering
#[stable(feature = "rust1", since = "1.0.0")]
Relaxed,
/// 当与存储耦合时,所有先前的操作都将在使用 [`Acquire`] (或更高级) 排序加载此值之前进行排序。
///
/// 特别是,所有以前的写入操作对执行此值 [`Acquire`] (或更强) 的所有线程均可见。
///
/// 请注意,对组合加载和存储的操作使用此顺序将导致 [`Relaxed`] 加载操作!
///
/// 此排序仅适用于可以执行存储的操作。
///
/// 对应于 C++ 20 中的 [`memory_order_release`]。
///
/// [`memory_order_release`]: https://en.cppreference.com/w/cpp/atomic/memory_order#Release-Acquire_ordering
///
///
#[stable(feature = "rust1", since = "1.0.0")]
Release,
/// 与加载耦合时,如果加载的值是由具有 [`Release`] (或更高级) 排序的存储操作写入的,则所有后续操作在该存储之后都将被排序。
/// 特别是,所有后续加载将看到在存储之前写入的数据。
///
/// 请注意,对组合加载和存储的操作使用此顺序将导致 [`Relaxed`] 存储操作!
///
/// 此排序仅适用于可以执行加载的操作。
///
/// 对应于 C++ 20 中的 [`memory_order_acquire`]。
///
/// [`memory_order_acquire`]: https://en.cppreference.com/w/cpp/atomic/memory_order#Release-Acquire_ordering
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
Acquire,
/// 同时具有 [`Acquire`] 和 [`Release`] 的效果:
/// 对于负载,它使用 [`Acquire`] 排序。对于商店,它使用 [`Release`] 排序。
///
/// 请注意,在 `compare_and_swap` 的情况下,该操作可能最终不执行任何存储而因此仅具有 [`Acquire`] 排序。
///
/// 但是,`AcqRel` 将永远不会执行 [`Relaxed`] 访问。
///
/// 此排序仅适用于将加载和存储结合在一起的操作。
///
/// 对应于 C++ 20 中的 [`memory_order_acq_rel`]。
///
/// [`memory_order_acq_rel`]: https://en.cppreference.com/w/cpp/atomic/memory_order#Release-Acquire_ordering
#[stable(feature = "rust1", since = "1.0.0")]
AcqRel,
/// 像 [`Acquire`]/[`Release`]/[`AcqRel`] (分别用于加载,存储和随存储加载操作) 一样,另外保证所有线程都可以按相同的顺序看到所有顺序一致的操作。
///
///
/// 对应于 C++ 20 中的 [`memory_order_seq_cst`]。
///
/// [`memory_order_seq_cst`]: https://en.cppreference.com/w/cpp/atomic/memory_order#Sequentially-consistent_ordering
///
#[stable(feature = "rust1", since = "1.0.0")]
SeqCst,
}
/// [`AtomicBool`] 初始化为 `false`。
#[cfg(target_has_atomic_load_store = "8")]
#[stable(feature = "rust1", since = "1.0.0")]
#[deprecated(
since = "1.34.0",
note = "the `new` function is now preferred",
suggestion = "AtomicBool::new(false)"
)]
pub const ATOMIC_BOOL_INIT: AtomicBool = AtomicBool::new(false);
#[cfg(target_has_atomic_load_store = "8")]
impl AtomicBool {
/// 创建一个新的 `AtomicBool`。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::AtomicBool;
///
/// let atomic_true = AtomicBool::new(true);
/// let atomic_false = AtomicBool::new(false);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_const_stable(feature = "const_atomic_new", since = "1.24.0")]
#[must_use]
pub const fn new(v: bool) -> AtomicBool {
AtomicBool { v: UnsafeCell::new(v as u8) }
}
/// 从指针创建一个新的 `AtomicBool`。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_ptr, pointer_is_aligned)]
/// use std::sync::atomic::{self, AtomicBool};
/// use std::mem::align_of;
///
/// // 获取指向分配值的指针
/// let ptr: *mut bool = Box::into_raw(Box::new(false));
///
/// assert!(ptr.is_aligned_to(align_of::<AtomicBool>()));
///
/// {
/// // 创建分配值的原子视图
/// let atomic = unsafe { AtomicBool::from_ptr(ptr) };
///
/// // 使用 `atomic` 进行原子操作,可能与其他线程共享
/// atomic.store(true, atomic::Ordering::Relaxed);
/// }
///
/// // 可以非原子地访问 `ptr` 后面的值,因为对原子的引用在上面的块中结束了它的生命周期
/////
/// assert_eq!(unsafe { *ptr }, true);
///
/// // 释放值
/// unsafe { drop(Box::from_raw(ptr)) }
/// ```
///
/// # Safety
///
/// * `ptr` 必须与 `align_of::<AtomicBool>()` 对齐 (请注意,在某些平台上,它可能比 `align_of::<bool>()` 大)。
/// * 对于整个生命周 `'a` 的读取和写入,`ptr` 必须是 [valid]。
/// * 整个生命周 `'a` 都不能通过非原子操作访问到 `ptr` 后面的值。
///
/// [valid]: crate::ptr#safety
#[unstable(feature = "atomic_from_ptr", issue = "108652")]
#[rustc_const_unstable(feature = "atomic_from_ptr", issue = "108652")]
pub const unsafe fn from_ptr<'a>(ptr: *mut bool) -> &'a AtomicBool {
// SAFETY: 调用者保证
unsafe { &*ptr.cast() }
}
/// 返回底层 [`bool`] 的可变引用。
///
/// 这是安全的,因为可变引用保证没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let mut some_bool = AtomicBool::new(true);
/// assert_eq!(*some_bool.get_mut(), true);
/// *some_bool.get_mut() = false;
/// assert_eq!(some_bool.load(Ordering::SeqCst), false);
/// ```
#[inline]
#[stable(feature = "atomic_access", since = "1.15.0")]
pub fn get_mut(&mut self) -> &mut bool {
// SAFETY: 可变引用保证唯一的所有权。
unsafe { &mut *(self.v.get() as *mut bool) }
}
/// 获得对 `&mut bool` 的原子访问。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut)]
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let mut some_bool = true;
/// let a = AtomicBool::from_mut(&mut some_bool);
/// a.store(false, Ordering::Relaxed);
/// assert_eq!(some_bool, false);
/// ```
#[inline]
#[cfg(target_has_atomic_equal_alignment = "8")]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn from_mut(v: &mut bool) -> &mut Self {
// SAFETY: 可变引用保证唯一的所有权,并且 `bool` 和 `Self` 的对齐是 1.
//
unsafe { &mut *(v as *mut bool as *mut Self) }
}
/// 获得对 `&mut [AtomicBool]` 切片的非原子访问。
///
/// 这是安全的,因为可变引用保证没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, inline_const)]
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let mut some_bools = [const { AtomicBool::new(false) }; 10];
///
/// let view: &mut [bool] = AtomicBool::get_mut_slice(&mut some_bools);
/// assert_eq!(view, [false; 10]);
/// view[..5].copy_from_slice(&[true; 5]);
///
/// std::thread::scope(|s| {
/// for t in &some_bools[..5] {
/// s.spawn(move || assert_eq!(t.load(Ordering::Relaxed), true));
/// }
///
/// for f in &some_bools[5..] {
/// s.spawn(move || assert_eq!(f.load(Ordering::Relaxed), false));
/// }
/// });
/// ```
#[inline]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn get_mut_slice(this: &mut [Self]) -> &mut [bool] {
// SAFETY: 可变引用保证唯一的所有权。
unsafe { &mut *(this as *mut [Self] as *mut [bool]) }
}
/// 获得对 `&mut [bool]` 切片的原子访问。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut)]
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let mut some_bools = [false; 10];
/// let a = &*AtomicBool::from_mut_slice(&mut some_bools);
/// std::thread::scope(|s| {
/// for i in 0..a.len() {
/// s.spawn(move || a[i].store(true, Ordering::Relaxed));
/// }
/// });
/// assert_eq!(some_bools, [true; 10]);
/// ```
#[inline]
#[cfg(target_has_atomic_equal_alignment = "8")]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn from_mut_slice(v: &mut [bool]) -> &mut [Self] {
// SAFETY: 可变引用保证唯一的所有权,并且 `bool` 和 `Self` 的对齐是 1.
//
unsafe { &mut *(v as *mut [bool] as *mut [Self]) }
}
/// 消耗原子并返回包含的值。
///
/// 这是安全的,因为按值传递 `self` 可以确保没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// use std::sync::atomic::AtomicBool;
///
/// let some_bool = AtomicBool::new(true);
/// assert_eq!(some_bool.into_inner(), true);
/// ```
#[inline]
#[stable(feature = "atomic_access", since = "1.15.0")]
#[rustc_const_unstable(feature = "const_cell_into_inner", issue = "78729")]
pub const fn into_inner(self) -> bool {
self.v.into_inner() != 0
}
/// 从 bool 加载一个值。
///
/// `load` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 可能的值为 [`SeqCst`],[`Acquire`] 和 [`Relaxed`]。
///
/// # Panics
///
/// 如果 `order` 是 [`Release`] 或 [`AcqRel`],就会出现 panics。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let some_bool = AtomicBool::new(true);
///
/// assert_eq!(some_bool.load(Ordering::Relaxed), true);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn load(&self, order: Ordering) -> bool {
// SAFETY: 原子内部函数可以防止任何数据竞争,并且传入的裸指针是有效的,因为我们是从引用中获得的。
//
unsafe { atomic_load(self.v.get(), order) != 0 }
}
/// 将值存储到 bool 中。
///
/// `store` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 可能的值为 [`SeqCst`],[`Release`] 和 [`Relaxed`]。
///
/// # Panics
///
/// 如果 `order` 是 [`Acquire`] 或 [`AcqRel`],就会出现 panics。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let some_bool = AtomicBool::new(true);
///
/// some_bool.store(false, Ordering::Relaxed);
/// assert_eq!(some_bool.load(Ordering::Relaxed), false);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn store(&self, val: bool, order: Ordering) {
// SAFETY: 原子内部函数可以防止任何数据竞争,并且传入的裸指针是有效的,因为我们是从引用中获得的。
//
unsafe {
atomic_store(self.v.get(), val as u8, order);
}
}
/// 将值存储到 bool 中,返回前一个值。
///
/// `swap` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let some_bool = AtomicBool::new(true);
///
/// assert_eq!(some_bool.swap(false, Ordering::Relaxed), true);
/// assert_eq!(some_bool.load(Ordering::Relaxed), false);
/// ```
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn swap(&self, val: bool, order: Ordering) -> bool {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_swap(self.v.get(), val as u8, order) != 0 }
}
/// 如果当前值与 `current` 值相同,则将值存储到 [`bool`] 中。
///
/// 返回值始终是前一个值。如果等于 `current`,则该值已更新。
///
/// `compare_and_swap` 还带有一个 [`Ordering`] 参数,它描述了此操作的内存顺序。
/// 请注意,即使使用 [`AcqRel`],该操作也可能失败,因此仅执行 `Acquire` 加载,但没有 `Release` 语义。
/// 如果发生此操作,则使用 [`Acquire`] 使其成为该操作 [`Relaxed`] 的存储部分,而使用 [`Release`] 使该操作成为存储部分 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # 迁移到 `compare_exchange` 和 `compare_exchange_weak`
///
/// `compare_and_swap` 等效于 `compare_exchange`,具有以下内存排序映射:
///
/// Original | Success | Failure
/// -------- | ------- | -------
/// Relaxed | Relaxed | Relaxed Acquire | Acquire | Acquire Release | Release | Relaxed AcqRel | AcqRel | Acquire SeqCst | SeqCst | SeqCst
///
/// 即使比较成功,`compare_exchange_weak` 也允许虚假失败,这允许编译器在循环中使用比较和交换时生成更好的汇编代码。
///
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let some_bool = AtomicBool::new(true);
///
/// assert_eq!(some_bool.compare_and_swap(true, false, Ordering::Relaxed), true);
/// assert_eq!(some_bool.load(Ordering::Relaxed), false);
///
/// assert_eq!(some_bool.compare_and_swap(true, true, Ordering::Relaxed), false);
/// assert_eq!(some_bool.load(Ordering::Relaxed), false);
/// ```
///
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[deprecated(
since = "1.50.0",
note = "Use `compare_exchange` or `compare_exchange_weak` instead"
)]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_and_swap(&self, current: bool, new: bool, order: Ordering) -> bool {
match self.compare_exchange(current, new, order, strongest_failure_ordering(order)) {
Ok(x) => x,
Err(x) => x,
}
}
/// 如果当前值与 `current` 值相同,则将值存储到 [`bool`] 中。
///
/// 返回值是指示是否写入了新值并包含先前值的结果。
/// 成功后,此值保证等于 `current`。
///
/// `compare_exchange` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// `success` 描述了在与 `current` 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。
/// `failure` 描述了比较失败时发生的加载操作所需的排序。
/// 使用 [`Acquire`] 作为成功排序,使存储成为操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使装载成功 [`Relaxed`]。
///
/// 故障顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let some_bool = AtomicBool::new(true);
///
/// assert_eq!(some_bool.compare_exchange(true,
/// false,
/// Ordering::Acquire,
/// Ordering::Relaxed),
/// Ok(true));
/// assert_eq!(some_bool.load(Ordering::Relaxed), false);
///
/// assert_eq!(some_bool.compare_exchange(true, true,
/// Ordering::SeqCst,
/// Ordering::Acquire),
/// Err(false));
/// assert_eq!(some_bool.load(Ordering::Relaxed), false);
/// ```
///
///
#[inline]
#[stable(feature = "extended_compare_and_swap", since = "1.10.0")]
#[doc(alias = "compare_and_swap")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_exchange(
&self,
current: bool,
new: bool,
success: Ordering,
failure: Ordering,
) -> Result<bool, bool> {
// SAFETY: 原子内部函数可以防止数据竞争。
match unsafe {
atomic_compare_exchange(self.v.get(), current as u8, new as u8, success, failure)
} {
Ok(x) => Ok(x != 0),
Err(x) => Err(x != 0),
}
}
/// 如果当前值与 `current` 值相同,则将值存储到 [`bool`] 中。
///
/// 与 [`AtomicBool::compare_exchange`] 不同,即使比较成功,也允许该函数错误地失败,这可能导致某些平台上的代码效率更高。
///
/// 返回值是指示是否写入了新值并包含先前值的结果。
///
/// `compare_exchange_weak` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// `success` 描述了在与 `current` 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。
/// `failure` 描述了比较失败时发生的加载操作所需的排序。
/// 使用 [`Acquire`] 作为成功排序,使存储成为操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使装载成功 [`Relaxed`]。
/// 故障顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let val = AtomicBool::new(false);
///
/// let new = true;
/// let mut old = val.load(Ordering::Relaxed);
/// loop {
/// match val.compare_exchange_weak(old, new, Ordering::SeqCst, Ordering::Relaxed) {
/// Ok(_) => break,
/// Err(x) => old = x,
/// }
/// }
/// ```
///
///
///
///
#[inline]
#[stable(feature = "extended_compare_and_swap", since = "1.10.0")]
#[doc(alias = "compare_and_swap")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_exchange_weak(
&self,
current: bool,
new: bool,
success: Ordering,
failure: Ordering,
) -> Result<bool, bool> {
// SAFETY: 原子内部函数可以防止数据竞争。
match unsafe {
atomic_compare_exchange_weak(self.v.get(), current as u8, new as u8, success, failure)
} {
Ok(x) => Ok(x != 0),
Err(x) => Err(x != 0),
}
}
/// 具有布尔值的逻辑 "and"。
///
/// 对当前值和参数 `val` 执行逻辑 "and" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_and` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_and(false, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_and(true, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
///
/// let foo = AtomicBool::new(false);
/// assert_eq!(foo.fetch_and(false, Ordering::SeqCst), false);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_and(&self, val: bool, order: Ordering) -> bool {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_and(self.v.get(), val as u8, order) != 0 }
}
/// 具有布尔值的逻辑 "nand"。
///
/// 对当前值和参数 `val` 执行逻辑 "nand" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_nand` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_nand(false, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_nand(true, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst) as usize, 0);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
///
/// let foo = AtomicBool::new(false);
/// assert_eq!(foo.fetch_nand(false, Ordering::SeqCst), false);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_nand(&self, val: bool, order: Ordering) -> bool {
// 我们在这里不能使用 atomic_nand,因为它可能导致 bool 的值无效。
// 发生这种情况的原因是,原子操作内部使用 8 位整数完成,这将设置高 7 位。
//
// 因此,我们只使用 fetch_xor 或 swap 即可。
if val {
// !(x & true) == !x 我们必须反转 bool。
//
self.fetch_xor(true, order)
} else {
// !(x & false) == true 我们必须将 bool 设置为 true。
//
self.swap(true, order)
}
}
/// 具有布尔值的逻辑 "or"。
///
/// 对当前值和参数 `val` 执行逻辑 "or" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_or` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_or(false, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_or(true, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
///
/// let foo = AtomicBool::new(false);
/// assert_eq!(foo.fetch_or(false, Ordering::SeqCst), false);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_or(&self, val: bool, order: Ordering) -> bool {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_or(self.v.get(), val as u8, order) != 0 }
}
/// 具有布尔值的逻辑 "xor"。
///
/// 对当前值和参数 `val` 执行逻辑 "xor" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_xor` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_xor(false, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_xor(true, Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
///
/// let foo = AtomicBool::new(false);
/// assert_eq!(foo.fetch_xor(false, Ordering::SeqCst), false);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_xor(&self, val: bool, order: Ordering) -> bool {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_xor(self.v.get(), val as u8, order) != 0 }
}
/// 具有布尔值的逻辑 "not"。
///
/// 对当前值执行逻辑 "not" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_not` 接受一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// #![feature(atomic_bool_fetch_not)]
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let foo = AtomicBool::new(true);
/// assert_eq!(foo.fetch_not(Ordering::SeqCst), true);
/// assert_eq!(foo.load(Ordering::SeqCst), false);
///
/// let foo = AtomicBool::new(false);
/// assert_eq!(foo.fetch_not(Ordering::SeqCst), false);
/// assert_eq!(foo.load(Ordering::SeqCst), true);
/// ```
///
///
///
#[inline]
#[unstable(feature = "atomic_bool_fetch_not", issue = "98485")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_not(&self, order: Ordering) -> bool {
self.fetch_xor(true, order)
}
/// 返回指向底层 [`bool`] 的可变指针。
///
/// 在结果整数上进行非原子读取和写入可以是数据竞争。
/// 此方法对 FFI 最为有用,在 FFI 中,函数签名可以使用 `*mut bool` 而不是 `&AtomicBool`。
///
/// 从共享引用返回 `*mut` 指针到此原子是安全的,因为原子类型可与内部可变性一起使用。
/// 原子的所有修改都通过共享的 quot 更改值,并且只要它们使用原子操作就可以安全地进行更改。
/// 对返回的裸指针的任何使用都需要一个 `unsafe` 块,并且仍然必须遵守相同的限制:对其进行的操作必须是原子的。
///
///
/// # Examples
///
/// ```ignore (extern-declaration)
/// # fn main() {
/// use std::sync::atomic::AtomicBool;
///
/// extern "C" {
/// fn my_atomic_op(arg: *mut bool);
/// }
///
/// let mut atomic = AtomicBool::new(true);
/// unsafe {
/// my_atomic_op(atomic.as_ptr());
/// }
/// # }
/// ```
///
///
#[inline]
#[stable(feature = "atomic_as_ptr", since = "1.70.0")]
#[rustc_const_stable(feature = "atomic_as_ptr", since = "1.70.0")]
pub const fn as_ptr(&self) -> *mut bool {
self.v.get().cast()
}
/// 获取该值,并对其应用一个函数,该函数返回一个可选的新值。如果函数返回 `Some(_)`,则返回 `Ok(previous_value)` 的 `Result`,否则返回 `Err(previous_value)`。
///
/// Note: 如果与此同时从其他线程更改了值,则只要函数返回 `Some(_)`,这可能会多次调用该函数,但是该函数仅对存储的值应用一次。
///
///
/// `fetch_update` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// 第一个描述了操作最终成功时所需的顺序,第二个描述了负载所需的顺序。
/// 这些分别对应于 [`AtomicBool::compare_exchange`] 的成功和失败顺序。
///
/// 使用 [`Acquire`] 作为成功排序,使存储成为该操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使最终成功加载 [`Relaxed`]。
/// (failed) 加载顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持 `u8` 上原子操作的平台上可用。
///
/// # Considerations
///
/// 这种方法并不神奇; 它不是由硬件提供的。
/// 它是根据 [`AtomicBool::compare_exchange_weak`] 实现的,并且具有相同的缺点。
/// 特别是,这种方法不会绕过 [ABA Problem]。
///
/// [ABA Problem]: https://en.wikipedia.org/wiki/ABA_problem
///
/// # Examples
///
/// ```rust
/// use std::sync::atomic::{AtomicBool, Ordering};
///
/// let x = AtomicBool::new(false);
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(false));
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(!x)), Ok(false));
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(!x)), Ok(true));
/// assert_eq!(x.load(Ordering::SeqCst), false);
/// ```
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "atomic_fetch_update", since = "1.53.0")]
#[cfg(target_has_atomic = "8")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_update<F>(
&self,
set_order: Ordering,
fetch_order: Ordering,
mut f: F,
) -> Result<bool, bool>
where
F: FnMut(bool) -> Option<bool>,
{
let mut prev = self.load(fetch_order);
while let Some(next) = f(prev) {
match self.compare_exchange_weak(prev, next, set_order, fetch_order) {
x @ Ok(_) => return x,
Err(next_prev) => prev = next_prev,
}
}
Err(prev)
}
}
#[cfg(target_has_atomic_load_store = "ptr")]
impl<T> AtomicPtr<T> {
/// 创建一个新的 `AtomicPtr`。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::AtomicPtr;
///
/// let ptr = &mut 5;
/// let atomic_ptr = AtomicPtr::new(ptr);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_const_stable(feature = "const_atomic_new", since = "1.24.0")]
pub const fn new(p: *mut T) -> AtomicPtr<T> {
AtomicPtr { p: UnsafeCell::new(p) }
}
/// 从指针创建一个新的 `AtomicPtr`。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_ptr, pointer_is_aligned)]
/// use std::sync::atomic::{self, AtomicPtr};
/// use std::mem::align_of;
///
/// // 获取指向分配值的指针
/// let ptr: *mut *mut u8 = Box::into_raw(Box::new(std::ptr::null_mut()));
///
/// assert!(ptr.is_aligned_to(align_of::<AtomicPtr<u8>>()));
///
/// {
/// // 创建分配值的原子视图
/// let atomic = unsafe { AtomicPtr::from_ptr(ptr) };
///
/// // 使用 `atomic` 进行原子操作,可能与其他线程共享
/// atomic.store(std::ptr::NonNull::dangling().as_ptr(), atomic::Ordering::Relaxed);
/// }
///
/// // 可以非原子地访问 `ptr` 后面的值,因为对原子的引用在上面的块中结束了它的生命周期
/////
/// assert!(!unsafe { *ptr }.is_null());
///
/// // 释放值
/// unsafe { drop(Box::from_raw(ptr)) }
/// ```
///
/// # Safety
///
/// * `ptr` 必须与 `align_of::<AtomicPtr<T>>()` 对齐 (请注意,在某些平台上,它可能比 `align_of::<*mut T>()` 大)。
/// * 对于整个生命周 `'a` 的读取和写入,`ptr` 必须是 [valid]。
/// * 整个生命周 `'a` 都不能通过非原子操作访问到 `ptr` 后面的值。
///
/// [valid]: crate::ptr#safety
#[unstable(feature = "atomic_from_ptr", issue = "108652")]
#[rustc_const_unstable(feature = "atomic_from_ptr", issue = "108652")]
pub const unsafe fn from_ptr<'a>(ptr: *mut *mut T) -> &'a AtomicPtr<T> {
// SAFETY: 调用者保证
unsafe { &*ptr.cast() }
}
/// 返回底层指针的可变引用。
///
/// 这是安全的,因为可变引用保证没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let mut data = 10;
/// let mut atomic_ptr = AtomicPtr::new(&mut data);
/// let mut other_data = 5;
/// *atomic_ptr.get_mut() = &mut other_data;
/// assert_eq!(unsafe { *atomic_ptr.load(Ordering::SeqCst) }, 5);
/// ```
#[inline]
#[stable(feature = "atomic_access", since = "1.15.0")]
pub fn get_mut(&mut self) -> &mut *mut T {
self.p.get_mut()
}
/// 获得对指针的原子访问。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut)]
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let mut data = 123;
/// let mut some_ptr = &mut data as *mut i32;
/// let a = AtomicPtr::from_mut(&mut some_ptr);
/// let mut other_data = 456;
/// a.store(&mut other_data, Ordering::Relaxed);
/// assert_eq!(unsafe { *some_ptr }, 456);
/// ```
#[inline]
#[cfg(target_has_atomic_equal_alignment = "ptr")]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn from_mut(v: &mut *mut T) -> &mut Self {
use crate::mem::align_of;
let [] = [(); align_of::<AtomicPtr<()>>() - align_of::<*mut ()>()];
// SAFETY:
// - 可变引用保证唯一的所有权。
// - 如上所述,在 rust 支持的所有平台上,`*mut T` 和 `Self` 的对齐方式均相同。
//
unsafe { &mut *(v as *mut *mut T as *mut Self) }
}
/// 获得对 `&mut [AtomicPtr]` 切片的非原子访问。
///
/// 这是安全的,因为可变引用保证没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, inline_const)]
/// use std::ptr::null_mut;
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let mut some_ptrs = [const { AtomicPtr::new(null_mut::<String>()) }; 10];
///
/// let view: &mut [*mut String] = AtomicPtr::get_mut_slice(&mut some_ptrs);
/// assert_eq!(view, [null_mut::<String>(); 10]);
/// view
/// .iter_mut()
/// .enumerate()
/// .for_each(|(i, ptr)| *ptr = Box::into_raw(Box::new(format!("iteration#{i}"))));
///
/// std::thread::scope(|s| {
/// for ptr in &some_ptrs {
/// s.spawn(move || {
/// let ptr = ptr.load(Ordering::Relaxed);
/// assert!(!ptr.is_null());
///
/// let name = unsafe { Box::from_raw(ptr) };
/// println!("Hello, {name}!");
/// });
/// }
/// });
/// ```
#[inline]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn get_mut_slice(this: &mut [Self]) -> &mut [*mut T] {
// SAFETY: 可变引用保证唯一的所有权。
unsafe { &mut *(this as *mut [Self] as *mut [*mut T]) }
}
/// 获得对指针切片的原子访问。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut)]
/// use std::ptr::null_mut;
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let mut some_ptrs = [null_mut::<String>(); 10];
/// let a = &*AtomicPtr::from_mut_slice(&mut some_ptrs);
/// std::thread::scope(|s| {
/// for i in 0..a.len() {
/// s.spawn(move || {
/// let name = Box::new(format!("thread{i}"));
/// a[i].store(Box::into_raw(name), Ordering::Relaxed);
/// });
/// }
/// });
/// for p in some_ptrs {
/// assert!(!p.is_null());
/// let name = unsafe { Box::from_raw(p) };
/// println!("Hello, {name}!");
/// }
/// ```
#[inline]
#[cfg(target_has_atomic_equal_alignment = "ptr")]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn from_mut_slice(v: &mut [*mut T]) -> &mut [Self] {
// SAFETY:
// - 可变引用保证唯一的所有权。
// - 如上所述,在 rust 支持的所有平台上,`*mut T` 和 `Self` 的对齐方式均相同。
//
unsafe { &mut *(v as *mut [*mut T] as *mut [Self]) }
}
/// 消耗原子并返回包含的值。
///
/// 这是安全的,因为按值传递 `self` 可以确保没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// use std::sync::atomic::AtomicPtr;
///
/// let mut data = 5;
/// let atomic_ptr = AtomicPtr::new(&mut data);
/// assert_eq!(unsafe { *atomic_ptr.into_inner() }, 5);
/// ```
#[inline]
#[stable(feature = "atomic_access", since = "1.15.0")]
#[rustc_const_unstable(feature = "const_cell_into_inner", issue = "78729")]
pub const fn into_inner(self) -> *mut T {
self.p.into_inner()
}
/// 从指针加载一个值。
///
/// `load` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 可能的值为 [`SeqCst`],[`Acquire`] 和 [`Relaxed`]。
///
/// # Panics
///
/// 如果 `order` 是 [`Release`] 或 [`AcqRel`],就会出现 panics。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let ptr = &mut 5;
/// let some_ptr = AtomicPtr::new(ptr);
///
/// let value = some_ptr.load(Ordering::Relaxed);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn load(&self, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_load(self.p.get(), order) }
}
/// 将值存储到指针中。
///
/// `store` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 可能的值为 [`SeqCst`],[`Release`] 和 [`Relaxed`]。
///
/// # Panics
///
/// 如果 `order` 是 [`Acquire`] 或 [`AcqRel`],就会出现 panics。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let ptr = &mut 5;
/// let some_ptr = AtomicPtr::new(ptr);
///
/// let other_ptr = &mut 10;
///
/// some_ptr.store(other_ptr, Ordering::Relaxed);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn store(&self, ptr: *mut T, order: Ordering) {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe {
atomic_store(self.p.get(), ptr, order);
}
}
/// 将一个值存储到指针中,返回前一个值。
///
/// `swap` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note:** 此方法仅在支持对指针进行原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let ptr = &mut 5;
/// let some_ptr = AtomicPtr::new(ptr);
///
/// let other_ptr = &mut 10;
///
/// let value = some_ptr.swap(other_ptr, Ordering::Relaxed);
/// ```
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg(target_has_atomic = "ptr")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn swap(&self, ptr: *mut T, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_swap(self.p.get(), ptr, order) }
}
/// 如果当前值与 `current` 值相同,则将一个值存储到指针中。
///
/// 返回值始终是前一个值。如果等于 `current`,则该值已更新。
///
/// `compare_and_swap` 还带有一个 [`Ordering`] 参数,它描述了此操作的内存顺序。
/// 请注意,即使使用 [`AcqRel`],该操作也可能失败,因此仅执行 `Acquire` 加载,但没有 `Release` 语义。
/// 如果发生此操作,则使用 [`Acquire`] 使其成为该操作 [`Relaxed`] 的存储部分,而使用 [`Release`] 使该操作成为存储部分 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持对指针进行原子操作的平台上可用。
///
/// # 迁移到 `compare_exchange` 和 `compare_exchange_weak`
///
/// `compare_and_swap` 等效于 `compare_exchange`,具有以下内存排序映射:
///
/// Original | Success | Failure
/// -------- | ------- | -------
/// Relaxed | Relaxed | Relaxed Acquire | Acquire | Acquire Release | Release | Relaxed AcqRel | AcqRel | Acquire SeqCst | SeqCst | SeqCst
///
/// 即使比较成功,`compare_exchange_weak` 也允许虚假失败,这允许编译器在循环中使用比较和交换时生成更好的汇编代码。
///
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let ptr = &mut 5;
/// let some_ptr = AtomicPtr::new(ptr);
///
/// let other_ptr = &mut 10;
///
/// let value = some_ptr.compare_and_swap(ptr, other_ptr, Ordering::Relaxed);
/// ```
///
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[deprecated(
since = "1.50.0",
note = "Use `compare_exchange` or `compare_exchange_weak` instead"
)]
#[cfg(target_has_atomic = "ptr")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_and_swap(&self, current: *mut T, new: *mut T, order: Ordering) -> *mut T {
match self.compare_exchange(current, new, order, strongest_failure_ordering(order)) {
Ok(x) => x,
Err(x) => x,
}
}
/// 如果当前值与 `current` 值相同,则将一个值存储到指针中。
///
/// 返回值是指示是否写入了新值并包含先前值的结果。
/// 成功后,此值保证等于 `current`。
///
/// `compare_exchange` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// `success` 描述了在与 `current` 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。
/// `failure` 描述了比较失败时发生的加载操作所需的排序。
/// 使用 [`Acquire`] 作为成功排序,使存储成为操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使装载成功 [`Relaxed`]。
///
/// 故障顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持对指针进行原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let ptr = &mut 5;
/// let some_ptr = AtomicPtr::new(ptr);
///
/// let other_ptr = &mut 10;
///
/// let value = some_ptr.compare_exchange(ptr, other_ptr,
/// Ordering::SeqCst, Ordering::Relaxed);
/// ```
///
///
#[inline]
#[stable(feature = "extended_compare_and_swap", since = "1.10.0")]
#[cfg(target_has_atomic = "ptr")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_exchange(
&self,
current: *mut T,
new: *mut T,
success: Ordering,
failure: Ordering,
) -> Result<*mut T, *mut T> {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_compare_exchange(self.p.get(), current, new, success, failure) }
}
/// 如果当前值与 `current` 值相同,则将一个值存储到指针中。
///
/// 与 [`AtomicPtr::compare_exchange`] 不同,即使比较成功,也允许该函数错误地失败,这可能导致某些平台上的代码效率更高。
///
/// 返回值是指示是否写入了新值并包含先前值的结果。
///
/// `compare_exchange_weak` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// `success` 描述了在与 `current` 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。
/// `failure` 描述了比较失败时发生的加载操作所需的排序。
/// 使用 [`Acquire`] 作为成功排序,使存储成为操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使装载成功 [`Relaxed`]。
/// 故障顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持对指针进行原子操作的平台上可用。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let some_ptr = AtomicPtr::new(&mut 5);
///
/// let new = &mut 10;
/// let mut old = some_ptr.load(Ordering::Relaxed);
/// loop {
/// match some_ptr.compare_exchange_weak(old, new, Ordering::SeqCst, Ordering::Relaxed) {
/// Ok(_) => break,
/// Err(x) => old = x,
/// }
/// }
/// ```
///
///
///
///
#[inline]
#[stable(feature = "extended_compare_and_swap", since = "1.10.0")]
#[cfg(target_has_atomic = "ptr")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_exchange_weak(
&self,
current: *mut T,
new: *mut T,
success: Ordering,
failure: Ordering,
) -> Result<*mut T, *mut T> {
// SAFETY: 这个内部函数是不安全的,因为它在裸指针上操作,但是我们可以肯定该指针是有效的 (我们只是从引用中获得了 `UnsafeCell` 来获取它),而原子操作本身允许我们安全地对 `UnsafeCell` 的内容进行可变。
//
//
//
unsafe { atomic_compare_exchange_weak(self.p.get(), current, new, success, failure) }
}
/// 获取该值,并对其应用一个函数,该函数返回一个可选的新值。如果函数返回 `Some(_)`,则返回 `Ok(previous_value)` 的 `Result`,否则返回 `Err(previous_value)`。
///
/// Note: 如果与此同时从其他线程更改了值,则只要函数返回 `Some(_)`,这可能会多次调用该函数,但是该函数仅对存储的值应用一次。
///
///
/// `fetch_update` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// 第一个描述了操作最终成功时所需的顺序,第二个描述了负载所需的顺序。
/// 这些分别对应于 [`AtomicPtr::compare_exchange`] 的成功和失败顺序。
///
/// 使用 [`Acquire`] 作为成功排序,使存储成为该操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使最终成功加载 [`Relaxed`]。
/// (failed) 加载顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note:** 此方法仅在支持对指针进行原子操作的平台上可用。
///
/// # Considerations
///
/// 这种方法并不神奇; 它不是由硬件提供的。
/// 它是根据 [`AtomicPtr::compare_exchange_weak`] 实现的,并且具有相同的缺点。
/// 特别是,这种方法不会绕过 [ABA Problem]。
///
/// [ABA Problem]: https://en.wikipedia.org/wiki/ABA_problem
///
/// # Examples
///
/// ```rust
/// use std::sync::atomic::{AtomicPtr, Ordering};
///
/// let ptr: *mut _ = &mut 5;
/// let some_ptr = AtomicPtr::new(ptr);
///
/// let new: *mut _ = &mut 10;
/// assert_eq!(some_ptr.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(ptr));
/// let result = some_ptr.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| {
/// if x == ptr {
/// Some(new)
/// } else {
/// None
/// }
/// });
/// assert_eq!(result, Ok(ptr));
/// assert_eq!(some_ptr.load(Ordering::SeqCst), new);
/// ```
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "atomic_fetch_update", since = "1.53.0")]
#[cfg(target_has_atomic = "ptr")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_update<F>(
&self,
set_order: Ordering,
fetch_order: Ordering,
mut f: F,
) -> Result<*mut T, *mut T>
where
F: FnMut(*mut T) -> Option<*mut T>,
{
let mut prev = self.load(fetch_order);
while let Some(next) = f(prev) {
match self.compare_exchange_weak(prev, next, set_order, fetch_order) {
x @ Ok(_) => return x,
Err(next_prev) => prev = next_prev,
}
}
Err(prev)
}
/// 通过添加 `val` (以 `T` 为单位) 偏移指针的地址,返回前一个指针。
///
/// 这相当于使用 [`wrapping_add`] 原子地执行 `ptr = ptr.wrapping_add(val);` 的等价物。
///
/// 该方法以 `T` 为单位进行操作,这意味着它不能用于将指针偏移不是 `size_of::<T>()` 的倍数的量。
/// 这有时会带来不便,因为您可能希望使用故意未对齐的指针。
/// 在这种情况下,您可以改用 [`fetch_byte_add`](Self::fetch_byte_add) 方法。
///
/// `fetch_ptr_add` 接受一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// [`wrapping_add`]: pointer::wrapping_add
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr, strict_provenance)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let atom = AtomicPtr::<i64>::new(core::ptr::null_mut());
/// assert_eq!(atom.fetch_ptr_add(1, Ordering::Relaxed).addr(), 0);
/// // Note: `size_of::<i64>()` 的单位。
/// assert_eq!(atom.load(Ordering::Relaxed).addr(), 8);
/// ```
///
///
///
///
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_ptr_add(&self, val: usize, order: Ordering) -> *mut T {
self.fetch_byte_add(val.wrapping_mul(core::mem::size_of::<T>()), order)
}
/// 通过减去 `val` (以 `T` 为单位) 偏移指针的地址,返回前一个指针。
///
/// 这相当于使用 [`wrapping_sub`] 原子地执行 `ptr = ptr.wrapping_sub(val);` 的等价物。
///
/// 该方法以 `T` 为单位进行操作,这意味着它不能用于将指针偏移不是 `size_of::<T>()` 的倍数的量。
/// 这有时会带来不便,因为您可能希望使用故意未对齐的指针。
/// 在这种情况下,您可以改用 [`fetch_byte_sub`](Self::fetch_byte_sub) 方法。
///
/// `fetch_ptr_sub` 接受一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// [`wrapping_sub`]: pointer::wrapping_sub
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let array = [1i32, 2i32];
/// let atom = AtomicPtr::new(array.as_ptr().wrapping_add(1) as *mut _);
///
/// assert!(core::ptr::eq(
/// atom.fetch_ptr_sub(1, Ordering::Relaxed),
/// &array[1],
/// ));
/// assert!(core::ptr::eq(atom.load(Ordering::Relaxed), &array[0]));
/// ```
///
///
///
///
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_ptr_sub(&self, val: usize, order: Ordering) -> *mut T {
self.fetch_byte_sub(val.wrapping_mul(core::mem::size_of::<T>()), order)
}
/// 通过添加 `val` *bytes* 来偏移指针的地址,返回前一个指针。
///
/// 这相当于使用 [`wrapping_byte_add`] 原子地执行 `ptr = ptr.wrapping_byte_add(val)`。
///
/// `fetch_byte_add` 接受一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// [`wrapping_byte_add`]: pointer::wrapping_byte_add
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr, strict_provenance)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let atom = AtomicPtr::<i64>::new(core::ptr::null_mut());
/// assert_eq!(atom.fetch_byte_add(1, Ordering::Relaxed).addr(), 0);
/// // Note: 以字节为单位,而不是 `size_of::<i64>()`。
/// assert_eq!(atom.load(Ordering::Relaxed).addr(), 1);
/// ```
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_byte_add(&self, val: usize, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_add(self.p.get(), core::ptr::invalid_mut(val), order).cast() }
}
/// 通过减去 `val` *bytes* 来偏移指针的地址,返回前一个指针。
///
/// 这相当于使用 [`wrapping_byte_sub`] 原子地执行 `ptr = ptr.wrapping_byte_sub(val)`。
///
/// `fetch_byte_sub` 接受一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// [`wrapping_byte_sub`]: pointer::wrapping_byte_sub
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr, strict_provenance)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let atom = AtomicPtr::<i64>::new(core::ptr::invalid_mut(1));
/// assert_eq!(atom.fetch_byte_sub(1, Ordering::Relaxed).addr(), 1);
/// assert_eq!(atom.load(Ordering::Relaxed).addr(), 0);
/// ```
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_byte_sub(&self, val: usize, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_sub(self.p.get(), core::ptr::invalid_mut(val), order).cast() }
}
/// 对当前指针的地址和参数 `val` 执行按位 "or" 操作,并存储具有当前指针出处的指针和结果地址。
///
///
/// 这相当于使用 [`map_addr`] 原子地执行 `ptr = ptr.map_addr(|a| a | val)`。这可用于标记指针方案以原子地设置标记位。
///
/// **警告**: 此操作返回之前的值。要在不丢失出处的情况下计算存储值,您可以使用 [`map_addr`]。
/// 例如: `a.fetch_or(val).map_addr(|a| a | val)`。
///
/// `fetch_or` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,有关详细信息,请参见 [module documentation for `ptr`][crate::ptr]。
///
/// [`map_addr`]: pointer::map_addr
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr, strict_provenance)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let pointer = &mut 3i64 as *mut i64;
///
/// let atom = AtomicPtr::<i64>::new(pointer);
/// // 标记指针的底部位。
/// assert_eq!(atom.fetch_or(1, Ordering::Relaxed).addr() & 1, 0);
/// // 提取并取消标记。
/// let tagged = atom.load(Ordering::Relaxed);
/// assert_eq!(tagged.addr() & 1, 1);
/// assert_eq!(tagged.map_addr(|p| p & !1), pointer);
/// ```
///
///
///
///
///
///
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_or(&self, val: usize, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_or(self.p.get(), core::ptr::invalid_mut(val), order).cast() }
}
/// 对当前指针的地址和参数 `val` 执行按位 "and" 操作,并存储具有当前指针出处的指针和结果地址。
///
///
/// 这相当于使用 [`map_addr`] 原子地执行 `ptr = ptr.map_addr(|a| a & val)`。这可以用于标记指针方案中,以原子方式取消设置标记位。
///
/// **警告**: 此操作返回之前的值。要在不丢失出处的情况下计算存储值,您可以使用 [`map_addr`]。
/// 例如: `a.fetch_and(val).map_addr(|a| a & val)`。
///
/// `fetch_and` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,有关详细信息,请参见 [module documentation for `ptr`][crate::ptr]。
///
/// [`map_addr`]: pointer::map_addr
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr, strict_provenance)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let pointer = &mut 3i64 as *mut i64;
/// // 标记的指针
/// let atom = AtomicPtr::<i64>::new(pointer.map_addr(|a| a | 1));
/// assert_eq!(atom.fetch_or(1, Ordering::Relaxed).addr() & 1, 1);
/// // 取消标记,并提取先前标记的指针。
/// let untagged = atom.fetch_and(!1, Ordering::Relaxed)
/// .map_addr(|a| a & !1);
/// assert_eq!(untagged, pointer);
/// ```
///
///
///
///
///
///
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_and(&self, val: usize, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_and(self.p.get(), core::ptr::invalid_mut(val), order).cast() }
}
/// 对当前指针的地址和参数 `val` 执行按位 "xor" 操作,并存储具有当前指针出处的指针和结果地址。
///
///
/// 这相当于使用 [`map_addr`] 原子地执行 `ptr = ptr.map_addr(|a| a ^ val)`。这可以用于标记指针方案以原子地切换标记位。
///
/// **警告**: 此操作返回之前的值。要在不丢失出处的情况下计算存储值,您可以使用 [`map_addr`]。
/// 例如: `a.fetch_xor(val).map_addr(|a| a ^ val)`。
///
/// `fetch_xor` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持 [`AtomicPtr`] 上的原子操作的平台上可用。
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,有关详细信息,请参见 [module documentation for `ptr`][crate::ptr]。
///
/// [`map_addr`]: pointer::map_addr
///
/// # Examples
///
/// ```
/// #![feature(strict_provenance_atomic_ptr, strict_provenance)]
/// use core::sync::atomic::{AtomicPtr, Ordering};
///
/// let pointer = &mut 3i64 as *mut i64;
/// let atom = AtomicPtr::<i64>::new(pointer);
///
/// // 切换指针上的标记位。
/// atom.fetch_xor(1, Ordering::Relaxed);
/// assert_eq!(atom.load(Ordering::Relaxed).addr() & 1, 1);
/// ```
///
///
///
///
///
///
///
///
///
#[inline]
#[cfg(target_has_atomic = "ptr")]
#[unstable(feature = "strict_provenance_atomic_ptr", issue = "99108")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_xor(&self, val: usize, order: Ordering) -> *mut T {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_xor(self.p.get(), core::ptr::invalid_mut(val), order).cast() }
}
/// 返回指向底层指针的可变指针。
///
/// 在结果整数上进行非原子读取和写入可以是数据竞争。
/// 此方法主要用于 FFI,其中函数签名可能使用 `*mut *mut T` 而不是 `&AtomicPtr<T>`。
///
/// 从共享引用返回 `*mut` 指针到此原子是安全的,因为原子类型可与内部可变性一起使用。
/// 原子的所有修改都通过共享的 quot 更改值,并且只要它们使用原子操作就可以安全地进行更改。
/// 对返回的裸指针的任何使用都需要一个 `unsafe` 块,并且仍然必须遵守相同的限制:对其进行的操作必须是原子的。
///
///
/// # Examples
///
/// ```ignore (extern-declaration)
/// use std::sync::atomic::AtomicPtr;
///
/// extern "C" {
/// fn my_atomic_op(arg: *mut *mut u32);
/// }
///
/// let mut value = 17;
/// let atomic = AtomicPtr::new(&mut value);
///
/// // SAFETY: 只要 `my_atomic_op` 是原子的就安全。
/// unsafe {
/// my_atomic_op(atomic.as_ptr());
/// }
/// ```
///
///
#[inline]
#[stable(feature = "atomic_as_ptr", since = "1.70.0")]
#[rustc_const_stable(feature = "atomic_as_ptr", since = "1.70.0")]
pub const fn as_ptr(&self) -> *mut *mut T {
self.p.get()
}
}
#[cfg(target_has_atomic_load_store = "8")]
#[stable(feature = "atomic_bool_from", since = "1.24.0")]
impl From<bool> for AtomicBool {
/// 将 `bool` 转换为 `AtomicBool`。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::AtomicBool;
/// let atomic_bool = AtomicBool::from(true);
/// assert_eq!(format!("{atomic_bool:?}"), "true")
/// ```
#[inline]
fn from(b: bool) -> Self {
Self::new(b)
}
}
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "atomic_from", since = "1.23.0")]
impl<T> From<*mut T> for AtomicPtr<T> {
/// 将 `*mut T` 转换为 `AtomicPtr<T>`。
#[inline]
fn from(p: *mut T) -> Self {
Self::new(p)
}
}
#[allow(unused_macros)] // 该宏最终在某些体系结构上未使用。
macro_rules! if_not_8_bit {
(u8, $($tt:tt)*) => { "" };
(i8, $($tt:tt)*) => { "" };
($_:ident, $($tt:tt)*) => { $($tt)* };
}
#[cfg(target_has_atomic_load_store)]
macro_rules! atomic_int {
($cfg_cas:meta,
$cfg_align:meta,
$stable:meta,
$stable_cxchg:meta,
$stable_debug:meta,
$stable_access:meta,
$stable_from:meta,
$stable_nand:meta,
$const_stable:meta,
$stable_init_const:meta,
$diagnostic_item:meta,
$s_int_type:literal,
$extra_feature:expr,
$min_fn:ident, $max_fn:ident,
$align:expr,
$atomic_new:expr,
$int_type:ident $atomic_type:ident $atomic_init:ident) => {
/// 可以在线程之间安全共享的整数类型。
///
/// 此类型与基本整数类型 [` 具有相同的内存表示形式
///
#[doc = $s_int_type]
/// `].
/// 有关原子类型和非原子类型之间的区别以及有关此类型的可移植性的更多信息,请参见 [模块级文档][module-level documentation]。
///
///
/// **Note:** 此类型仅在支持原子负载和 [` 的存储的平台上可用
///
#[doc = $s_int_type]
/// `].
///
/// [module-level documentation]: crate::sync::atomic
#[$stable]
#[$diagnostic_item]
#[repr(C, align($align))]
pub struct $atomic_type {
v: UnsafeCell<$int_type>,
}
/// 初始化为 `0` 的原子整数。
#[$stable_init_const]
#[deprecated(
since = "1.34.0",
note = "the `new` function is now preferred",
suggestion = $atomic_new,
)]
pub const $atomic_init: $atomic_type = $atomic_type::new(0);
#[$stable]
impl Default for $atomic_type {
#[inline]
fn default() -> Self {
Self::new(Default::default())
}
}
#[$stable_from]
impl From<$int_type> for $atomic_type {
#[doc = concat!("Converts an `", stringify!($int_type), "` into an `", stringify!($atomic_type), "`.")]
#[inline]
fn from(v: $int_type) -> Self { Self::new(v) }
}
#[$stable_debug]
impl fmt::Debug for $atomic_type {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&self.load(Ordering::Relaxed), f)
}
}
// 发送是隐式实现的。
#[$stable]
unsafe impl Sync for $atomic_type {}
impl $atomic_type {
/// 创建一个新的原子整数。
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::", stringify!($atomic_type), ";")]
///
#[doc = concat!("let atomic_forty_two = ", stringify!($atomic_type), "::new(42);")]
/// ```
#[inline]
#[$stable]
#[$const_stable]
#[must_use]
pub const fn new(v: $int_type) -> Self {
Self {v: UnsafeCell::new(v)}
}
/// 从指针创建一个新的引用到原子整数。
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_ptr, pointer_is_aligned)]
#[doc = concat!($extra_feature, "use std::sync::atomic::{self, ", stringify!($atomic_type), "};")]
/// use std::mem::align_of;
///
/// // 获取指向分配值的指针
#[doc = concat!("let ptr: *mut ", stringify!($int_type), " = Box::into_raw(Box::new(0));")]
///
#[doc = concat!("assert!(ptr.is_aligned_to(align_of::<", stringify!($atomic_type), ">()));")]
///
/// {
/// // 创建分配值的原子视图
// SAFETY: 这是一个文档注释,整洁,它不会伤害您 (也由 `ptr` 的构造和上面的断言保证)
#[doc = concat!(" let atomic = unsafe {", stringify!($atomic_type), "::from_ptr(ptr) };")]
///
/// // 使用 `atomic` 进行原子操作,可能与其他线程共享
/// atomic.store(1, atomic::Ordering::Relaxed);
/// }
///
/// // 可以非原子地访问 `ptr` 后面的值,因为对原子的引用在上面的块中结束了它的生命周期
/////
/// assert_eq!(unsafe { *ptr }, 1);
///
/// // 释放值
/// unsafe { drop(Box::from_raw(ptr)) }
/// ```
///
/// # Safety
///
/// * `ptr` 必须与 `align_of::<AtomicBool>()` 对齐 (请注意,在某些平台上,它可能比 `align_of::<bool>()` 大)。
#[doc = concat!(" * `ptr` must be aligned to `align_of::<", stringify!($atomic_type), ">()` (note that on some platforms this can be bigger than `align_of::<", stringify!($int_type), ">()`).")]
/// * 对于整个生命周 `'a` 的读取和写入,`ptr` 必须是 [valid]。
/// * 整个生命周 `'a` 都不能通过非原子操作访问到 `ptr` 后面的值。
///
/// [valid]: crate::ptr#safety
#[unstable(feature = "atomic_from_ptr", issue = "108652")]
#[rustc_const_unstable(feature = "atomic_from_ptr", issue = "108652")]
pub const unsafe fn from_ptr<'a>(ptr: *mut $int_type) -> &'a $atomic_type {
// SAFETY: 调用者保证
unsafe { &*ptr.cast() }
}
/// 返回底层整数的可变引用。
///
/// 这是安全的,因为可变引用保证没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let mut some_var = ", stringify!($atomic_type), "::new(10);")]
/// assert_eq!(*some_var.get_mut(), 10);
/// *some_var.get_mut() = 5;
/// assert_eq!(some_var.load(Ordering::SeqCst), 5);
/// ```
#[inline]
#[$stable_access]
pub fn get_mut(&mut self) -> &mut $int_type {
self.v.get_mut()
}
#[doc = concat!("Get atomic access to a `&mut ", stringify!($int_type), "`.")]
///
#[doc = if_not_8_bit! {
$int_type,
concat!(
"**Note:** This function is only available on targets where `",
stringify!($int_type), "` has an alignment of ", $align, " bytes."
)
}]
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut)]
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
/// let mut some_int = 123;
#[doc = concat!("let a = ", stringify!($atomic_type), "::from_mut(&mut some_int);")]
/// a.store(100, Ordering::Relaxed);
/// assert_eq!(some_int, 100);
/// ```
///
#[inline]
#[$cfg_align]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn from_mut(v: &mut $int_type) -> &mut Self {
use crate::mem::align_of;
let [] = [(); align_of::<Self>() - align_of::<$int_type>()];
// SAFETY:
// - 可变引用保证唯一的所有权。
// - `$int_type` 和 `Self` 的对齐方式相同,如 $cfg_align 所承诺并已在上面进行了验证。
//
unsafe { &mut *(v as *mut $int_type as *mut Self) }
}
#[doc = concat!("Get non-atomic access to a `&mut [", stringify!($atomic_type), "]` slice")]
/// 这是安全的,因为可变引用保证没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut, inline_const)]
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let mut some_ints = [const { ", stringify!($atomic_type), "::new(0) }; 10];")]
///
#[doc = concat!("let view: &mut [", stringify!($int_type), "] = ", stringify!($atomic_type), "::get_mut_slice(&mut some_ints);")]
/// assert_eq!(view, [0; 10]);
/// view
/// .iter_mut()
/// .enumerate()
/// .for_each(|(idx, int)| *int = idx as _);
///
/// std::thread::scope(|s| {
/// some_ints
/// .iter()
/// .enumerate()
/// .for_each(|(idx, int)| {
/// s.spawn(move || assert_eq!(int.load(Ordering::Relaxed), idx as _));
/// })
/// });
/// ```
///
#[inline]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn get_mut_slice(this: &mut [Self]) -> &mut [$int_type] {
// SAFETY: 可变引用保证唯一的所有权。
unsafe { &mut *(this as *mut [Self] as *mut [$int_type]) }
}
#[doc = concat!("Get atomic access to a `&mut [", stringify!($int_type), "]` slice.")]
///
/// # Examples
///
/// ```
/// #![feature(atomic_from_mut)]
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
/// let mut some_ints = [0; 10];
#[doc = concat!("let a = &*", stringify!($atomic_type), "::from_mut_slice(&mut some_ints);")]
/// std::thread::scope(|s| {
/// for i in 0..a.len() {
/// s.spawn(move || a[i].store(i as _, Ordering::Relaxed));
/// }
/// });
/// for (i, n) in some_ints.into_iter().enumerate() {
/// assert_eq!(i, n as usize);
/// }
/// ```
#[inline]
#[$cfg_align]
#[unstable(feature = "atomic_from_mut", issue = "76314")]
pub fn from_mut_slice(v: &mut [$int_type]) -> &mut [Self] {
use crate::mem::align_of;
let [] = [(); align_of::<Self>() - align_of::<$int_type>()];
// SAFETY:
// - 可变引用保证唯一的所有权。
// - `$int_type` 和 `Self` 的对齐方式相同,如 $cfg_align 所承诺并已在上面进行了验证。
//
unsafe { &mut *(v as *mut [$int_type] as *mut [Self]) }
}
/// 消耗原子并返回包含的值。
///
/// 这是安全的,因为按值传递 `self` 可以确保没有其他线程同时访问原子数据。
///
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::", stringify!($atomic_type), ";")]
///
#[doc = concat!("let some_var = ", stringify!($atomic_type), "::new(5);")]
/// assert_eq!(some_var.into_inner(), 5);
/// ```
#[inline]
#[$stable_access]
#[rustc_const_unstable(feature = "const_cell_into_inner", issue = "78729")]
pub const fn into_inner(self) -> $int_type {
self.v.into_inner()
}
/// 从原子整数加载值。
///
/// `load` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 可能的值为 [`SeqCst`],[`Acquire`] 和 [`Relaxed`]。
///
/// # Panics
///
/// 如果 `order` 是 [`Release`] 或 [`AcqRel`],就会出现 panics。
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let some_var = ", stringify!($atomic_type), "::new(5);")]
///
/// assert_eq!(some_var.load(Ordering::Relaxed), 5);
/// ```
#[inline]
#[$stable]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn load(&self, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_load(self.v.get(), order) }
}
/// 将值存储到原子整数中。
///
/// `store` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。
/// 可能的值为 [`SeqCst`],[`Release`] 和 [`Relaxed`]。
///
/// # Panics
///
/// 如果 `order` 是 [`Acquire`] 或 [`AcqRel`],就会出现 panics。
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let some_var = ", stringify!($atomic_type), "::new(5);")]
///
/// some_var.store(10, Ordering::Relaxed);
/// assert_eq!(some_var.load(Ordering::Relaxed), 10);
/// ```
#[inline]
#[$stable]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn store(&self, val: $int_type, order: Ordering) {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_store(self.v.get(), val, order); }
}
/// 将值存储到原子整数中,返回前一个值。
///
/// `swap` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let some_var = ", stringify!($atomic_type), "::new(5);")]
///
/// assert_eq!(some_var.swap(10, Ordering::Relaxed), 5);
/// ```
#[inline]
#[$stable]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn swap(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_swap(self.v.get(), val, order) }
}
/// 如果当前值与 `current` 值相同,则将值存储到原子整数中。
///
/// 返回值始终是前一个值。如果等于 `current`,则该值已更新。
///
/// `compare_and_swap` 还带有一个 [`Ordering`] 参数,它描述了此操作的内存顺序。
/// 请注意,即使使用 [`AcqRel`],该操作也可能失败,因此仅执行 `Acquire` 加载,但没有 `Release` 语义。
///
/// 如果发生此操作,则使用 [`Acquire`] 使其成为该操作 [`Relaxed`] 的存储部分,而使用 [`Release`] 使该操作成为存储部分 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
/// # 迁移到 `compare_exchange` 和 `compare_exchange_weak`
///
/// `compare_and_swap` 等效于 `compare_exchange`,具有以下内存排序映射:
///
/// Original | Success | Failure
/// -------- | ------- | -------
/// Relaxed | Relaxed | Relaxed Acquire | Acquire | Acquire Release | Release | Relaxed AcqRel | AcqRel | Acquire SeqCst | SeqCst | SeqCst
///
/// 即使比较成功,`compare_exchange_weak` 也允许虚假失败,这允许编译器在循环中使用比较和交换时生成更好的汇编代码。
///
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let some_var = ", stringify!($atomic_type), "::new(5);")]
///
/// assert_eq!(some_var.compare_and_swap(5, 10, Ordering::Relaxed), 5);
/// assert_eq!(some_var.load(Ordering::Relaxed), 10);
///
/// assert_eq!(some_var.compare_and_swap(6, 12, Ordering::Relaxed), 10);
/// assert_eq!(some_var.load(Ordering::Relaxed), 10);
/// ```
///
///
///
///
///
///
///
#[inline]
#[$stable]
#[deprecated(
since = "1.50.0",
note = "Use `compare_exchange` or `compare_exchange_weak` instead")
]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_and_swap(&self,
current: $int_type,
new: $int_type,
order: Ordering) -> $int_type {
match self.compare_exchange(current,
new,
order,
strongest_failure_ordering(order)) {
Ok(x) => x,
Err(x) => x,
}
}
/// 如果当前值与 `current` 值相同,则将值存储到原子整数中。
///
/// 返回值是指示是否写入了新值并包含先前值的结果。
/// 成功后,此值保证等于 `current`。
///
/// `compare_exchange` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// `success` 描述了在与 `current` 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。
/// `failure` 描述了比较失败时发生的加载操作所需的排序。
/// 使用 [`Acquire`] 作为成功排序,使存储成为操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使装载成功 [`Relaxed`]。
///
/// 故障顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let some_var = ", stringify!($atomic_type), "::new(5);")]
///
/// assert_eq!(some_var.compare_exchange(5, 10,
/// Ordering::Acquire,
/// Ordering::Relaxed),
/// Ok(5));
/// assert_eq!(some_var.load(Ordering::Relaxed), 10);
///
/// assert_eq!(some_var.compare_exchange(6, 12,
/// Ordering::SeqCst,
/// Ordering::Acquire),
/// Err(10));
/// assert_eq!(some_var.load(Ordering::Relaxed), 10);
/// ```
#[inline]
#[$stable_cxchg]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_exchange(&self,
current: $int_type,
new: $int_type,
success: Ordering,
failure: Ordering) -> Result<$int_type, $int_type> {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_compare_exchange(self.v.get(), current, new, success, failure) }
}
/// 如果当前值与 `current` 值相同,则将值存储到原子整数中。
///
///
#[doc = concat!("Unlike [`", stringify!($atomic_type), "::compare_exchange`],")]
/// 即使比较成功,此函数也可能会虚假地失败,这可能导致某些平台上的代码效率更高。
/// 返回值是指示是否写入了新值并包含先前值的结果。
///
/// `compare_exchange_weak` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// `success` 描述了在与 `current` 的比较成功时发生的读取 - 修改 - 写入操作所需的顺序。
/// `failure` 描述了比较失败时发生的加载操作所需的排序。
/// 使用 [`Acquire`] 作为成功排序,使存储成为操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使装载成功 [`Relaxed`]。
///
/// 故障顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let val = ", stringify!($atomic_type), "::new(4);")]
///
/// let mut old = val.load(Ordering::Relaxed);
/// loop {
/// let new = old * 2;
/// match val.compare_exchange_weak(old, new, Ordering::SeqCst, Ordering::Relaxed) {
/// Ok(_) => break,
/// Err(x) => old = x,
/// }
/// }
/// ```
#[inline]
#[$stable_cxchg]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compare_exchange_weak(&self,
current: $int_type,
new: $int_type,
success: Ordering,
failure: Ordering) -> Result<$int_type, $int_type> {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe {
atomic_compare_exchange_weak(self.v.get(), current, new, success, failure)
}
}
/// 加到当前值,返回前一个值。
///
/// 此操作在溢出时回绕。
///
/// `fetch_add` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(0);")]
/// assert_eq!(foo.fetch_add(10, Ordering::SeqCst), 0);
/// assert_eq!(foo.load(Ordering::SeqCst), 10);
/// ```
#[inline]
#[$stable]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_add(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_add(self.v.get(), val, order) }
}
/// 从当前值中减去,返回前一个值。
///
/// 此操作在溢出时回绕。
///
/// `fetch_sub` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(20);")]
/// assert_eq!(foo.fetch_sub(10, Ordering::SeqCst), 20);
/// assert_eq!(foo.load(Ordering::SeqCst), 10);
/// ```
#[inline]
#[$stable]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_sub(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_sub(self.v.get(), val, order) }
}
/// "and" 按位与当前值。
///
/// 对当前值和参数 `val` 执行按位 "and" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_and` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(0b101101);")]
/// assert_eq!(foo.fetch_and(0b110011, Ordering::SeqCst), 0b101101);
/// assert_eq!(foo.load(Ordering::SeqCst), 0b100001);
/// ```
#[inline]
#[$stable]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_and(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_and(self.v.get(), val, order) }
}
/// "nand" 按位与当前值。
///
/// 对当前值和参数 `val` 执行按位 "nand" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_nand` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(0x13);")]
/// assert_eq!(foo.fetch_nand(0x31, Ordering::SeqCst), 0x13);
/// assert_eq!(foo.load(Ordering::SeqCst), !(0x13 & 0x31));
/// ```
#[inline]
#[$stable_nand]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_nand(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_nand(self.v.get(), val, order) }
}
/// "or" 按位与当前值。
///
/// 对当前值和参数 `val` 执行按位 "or" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_or` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(0b101101);")]
/// assert_eq!(foo.fetch_or(0b110011, Ordering::SeqCst), 0b101101);
/// assert_eq!(foo.load(Ordering::SeqCst), 0b111111);
/// ```
#[inline]
#[$stable]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_or(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_or(self.v.get(), val, order) }
}
/// "xor" 按位与当前值。
///
/// 对当前值和参数 `val` 执行按位 "xor" 运算,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_xor` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(0b101101);")]
/// assert_eq!(foo.fetch_xor(0b110011, Ordering::SeqCst), 0b101101);
/// assert_eq!(foo.load(Ordering::SeqCst), 0b011110);
/// ```
#[inline]
#[$stable]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_xor(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { atomic_xor(self.v.get(), val, order) }
}
/// 获取该值,并对其应用一个函数,该函数返回一个可选的新值。如果函数返回 `Some(_)`,则返回 `Ok(previous_value)` 的 `Result`,否则返回 `Err(previous_value)`。
///
/// Note: 如果与此同时从其他线程更改了值,则只要函数返回 `Some(_)`,这可能会多次调用该函数,但是该函数仅对存储的值应用一次。
///
///
/// `fetch_update` 需要两个 [`Ordering`] 参数来描述这个操作的内存顺序。
/// 第一个描述了操作最终成功时所需的顺序,第二个描述了负载所需的顺序。这些对应于成功和失败的顺序
///
///
///
///
#[doc = concat!("[`", stringify!($atomic_type), "::compare_exchange`]")]
/// respectively.
///
/// 使用 [`Acquire`] 作为成功排序,使存储成为该操作 [`Relaxed`] 的一部分,而使用 [`Release`],则使最终成功加载 [`Relaxed`]。
/// (failed) 加载顺序只能是 [`SeqCst`]、[`Acquire`] 或 [`Relaxed`]。
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Considerations
///
/// 这种方法并不神奇; 它不是由硬件提供的。
/// 它是按照以下方式实现的
#[doc = concat!("[`", stringify!($atomic_type), "::compare_exchange_weak`],")]
/// 并遭受同样的缺点。
/// 特别是,这种方法不会绕过 [ABA Problem]。
///
/// [ABA Problem]: https://en.wikipedia.org/wiki/ABA_problem
///
/// # Examples
///
/// ```rust
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let x = ", stringify!($atomic_type), "::new(7);")]
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |_| None), Err(7));
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(7));
/// assert_eq!(x.fetch_update(Ordering::SeqCst, Ordering::SeqCst, |x| Some(x + 1)), Ok(8));
/// assert_eq!(x.load(Ordering::SeqCst), 9);
/// ```
#[inline]
#[stable(feature = "no_more_cas", since = "1.45.0")]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_update<F>(&self,
set_order: Ordering,
fetch_order: Ordering,
mut f: F) -> Result<$int_type, $int_type>
where F: FnMut($int_type) -> Option<$int_type> {
let mut prev = self.load(fetch_order);
while let Some(next) = f(prev) {
match self.compare_exchange_weak(prev, next, set_order, fetch_order) {
x @ Ok(_) => return x,
Err(next_prev) => prev = next_prev
}
}
Err(prev)
}
/// 当前值的最大值。
///
/// 查找当前值和参数 `val` 的最大值,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_max` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(23);")]
/// assert_eq!(foo.fetch_max(42, Ordering::SeqCst), 23);
/// assert_eq!(foo.load(Ordering::SeqCst), 42);
/// ```
///
/// 如果要一步获得最大值,可以使用以下方法:
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(23);")]
/// let bar = 42;
/// let max_foo = foo.fetch_max(bar, Ordering::SeqCst).max(bar);
/// assert!(max_foo == 42);
/// ```
#[inline]
#[stable(feature = "atomic_min_max", since = "1.45.0")]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_max(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { $max_fn(self.v.get(), val, order) }
}
/// 当前值的最小值。
///
/// 查找当前值和参数 `val` 的最小值,并将新值设置为结果。
///
/// 返回前一个值。
///
/// `fetch_min` 需要一个 [`Ordering`] 参数,它描述了这个操作的内存顺序。所有排序模式都是可能的。
/// 请注意,使用 [`Acquire`] 会使该操作成为存储部分 [`Relaxed`],而使用 [`Release`] 会使装入部分成为 [`Relaxed`]。
///
///
/// **Note**: 此方法仅在支持原子操作的平台上可用
///
///
#[doc = concat!("[`", $s_int_type, "`].")]
///
/// # Examples
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(23);")]
/// assert_eq!(foo.fetch_min(42, Ordering::Relaxed), 23);
/// assert_eq!(foo.load(Ordering::Relaxed), 23);
/// assert_eq!(foo.fetch_min(22, Ordering::Relaxed), 23);
/// assert_eq!(foo.load(Ordering::Relaxed), 22);
/// ```
///
/// 如果要一步获得最小值,则可以使用以下方法:
///
/// ```
#[doc = concat!($extra_feature, "use std::sync::atomic::{", stringify!($atomic_type), ", Ordering};")]
///
#[doc = concat!("let foo = ", stringify!($atomic_type), "::new(23);")]
/// let bar = 12;
/// let min_foo = foo.fetch_min(bar, Ordering::SeqCst).min(bar);
/// assert_eq!(min_foo, 12);
/// ```
#[inline]
#[stable(feature = "atomic_min_max", since = "1.45.0")]
#[$cfg_cas]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fetch_min(&self, val: $int_type, order: Ordering) -> $int_type {
// SAFETY: 原子内部函数可以防止数据竞争。
unsafe { $min_fn(self.v.get(), val, order) }
}
/// 返回指向底层整数的可变指针。
///
/// 在结果整数上进行非原子读取和写入可以是数据竞争。
/// 此方法对于 FFI 最为有用,在 FFI 中可能使用函数签名
#[doc = concat!("`*mut ", stringify!($int_type), "` instead of `&", stringify!($atomic_type), "`.")]
/// 从共享引用返回 `*mut` 指针到此原子是安全的,因为原子类型可与内部可变性一起使用。
/// 原子的所有修改都通过共享的 quot 更改值,并且只要它们使用原子操作就可以安全地进行更改。
/// 对返回的裸指针的任何使用都需要一个 `unsafe` 块,并且仍然必须遵守相同的限制:对其进行的操作必须是原子的。
///
///
/// # Examples
///
/// ```ignore (extern-declaration)
/// # fn main() {
#[doc = concat!($extra_feature, "use std::sync::atomic::", stringify!($atomic_type), ";")]
///
/// extern "C" {
#[doc = concat!(" fn my_atomic_op(arg: *mut ", stringify!($int_type), ");")]
/// }
///
#[doc = concat!("let atomic = ", stringify!($atomic_type), "::new(1);")]
///
/// // SAFETY: 只要 `my_atomic_op` 是原子的就安全。
/// unsafe {
/// my_atomic_op(atomic.as_ptr());
/// }
/// # }
/// ```
///
///
#[inline]
#[stable(feature = "atomic_as_ptr", since = "1.70.0")]
#[rustc_const_stable(feature = "atomic_as_ptr", since = "1.70.0")]
pub const fn as_ptr(&self) -> *mut $int_type {
self.v.get()
}
}
}
}
#[cfg(target_has_atomic_load_store = "8")]
atomic_int! {
cfg(target_has_atomic = "8"),
cfg(target_has_atomic_equal_alignment = "8"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicI8"),
"i8",
"",
atomic_min, atomic_max,
1,
"AtomicI8::new(0)",
i8 AtomicI8 ATOMIC_I8_INIT
}
#[cfg(target_has_atomic_load_store = "8")]
atomic_int! {
cfg(target_has_atomic = "8"),
cfg(target_has_atomic_equal_alignment = "8"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicU8"),
"u8",
"",
atomic_umin, atomic_umax,
1,
"AtomicU8::new(0)",
u8 AtomicU8 ATOMIC_U8_INIT
}
#[cfg(target_has_atomic_load_store = "16")]
atomic_int! {
cfg(target_has_atomic = "16"),
cfg(target_has_atomic_equal_alignment = "16"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicI16"),
"i16",
"",
atomic_min, atomic_max,
2,
"AtomicI16::new(0)",
i16 AtomicI16 ATOMIC_I16_INIT
}
#[cfg(target_has_atomic_load_store = "16")]
atomic_int! {
cfg(target_has_atomic = "16"),
cfg(target_has_atomic_equal_alignment = "16"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicU16"),
"u16",
"",
atomic_umin, atomic_umax,
2,
"AtomicU16::new(0)",
u16 AtomicU16 ATOMIC_U16_INIT
}
#[cfg(target_has_atomic_load_store = "32")]
atomic_int! {
cfg(target_has_atomic = "32"),
cfg(target_has_atomic_equal_alignment = "32"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicI32"),
"i32",
"",
atomic_min, atomic_max,
4,
"AtomicI32::new(0)",
i32 AtomicI32 ATOMIC_I32_INIT
}
#[cfg(target_has_atomic_load_store = "32")]
atomic_int! {
cfg(target_has_atomic = "32"),
cfg(target_has_atomic_equal_alignment = "32"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicU32"),
"u32",
"",
atomic_umin, atomic_umax,
4,
"AtomicU32::new(0)",
u32 AtomicU32 ATOMIC_U32_INIT
}
#[cfg(target_has_atomic_load_store = "64")]
atomic_int! {
cfg(target_has_atomic = "64"),
cfg(target_has_atomic_equal_alignment = "64"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicI64"),
"i64",
"",
atomic_min, atomic_max,
8,
"AtomicI64::new(0)",
i64 AtomicI64 ATOMIC_I64_INIT
}
#[cfg(target_has_atomic_load_store = "64")]
atomic_int! {
cfg(target_has_atomic = "64"),
cfg(target_has_atomic_equal_alignment = "64"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
stable(feature = "integer_atomics_stable", since = "1.34.0"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicU64"),
"u64",
"",
atomic_umin, atomic_umax,
8,
"AtomicU64::new(0)",
u64 AtomicU64 ATOMIC_U64_INIT
}
#[cfg(target_has_atomic_load_store = "128")]
atomic_int! {
cfg(target_has_atomic = "128"),
cfg(target_has_atomic_equal_alignment = "128"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicI128"),
"i128",
"#![feature(integer_atomics)]\n\n",
atomic_min, atomic_max,
16,
"AtomicI128::new(0)",
i128 AtomicI128 ATOMIC_I128_INIT
}
#[cfg(target_has_atomic_load_store = "128")]
atomic_int! {
cfg(target_has_atomic = "128"),
cfg(target_has_atomic_equal_alignment = "128"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
unstable(feature = "integer_atomics", issue = "99069"),
rustc_const_stable(feature = "const_integer_atomics", since = "1.34.0"),
unstable(feature = "integer_atomics", issue = "99069"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicU128"),
"u128",
"#![feature(integer_atomics)]\n\n",
atomic_umin, atomic_umax,
16,
"AtomicU128::new(0)",
u128 AtomicU128 ATOMIC_U128_INIT
}
macro_rules! atomic_int_ptr_sized {
( $($target_pointer_width:literal $align:literal)* ) => { $(
#[cfg(target_has_atomic_load_store = "ptr")]
#[cfg(target_pointer_width = $target_pointer_width)]
atomic_int! {
cfg(target_has_atomic = "ptr"),
cfg(target_has_atomic_equal_alignment = "ptr"),
stable(feature = "rust1", since = "1.0.0"),
stable(feature = "extended_compare_and_swap", since = "1.10.0"),
stable(feature = "atomic_debug", since = "1.3.0"),
stable(feature = "atomic_access", since = "1.15.0"),
stable(feature = "atomic_from", since = "1.23.0"),
stable(feature = "atomic_nand", since = "1.27.0"),
rustc_const_stable(feature = "const_ptr_sized_atomics", since = "1.24.0"),
stable(feature = "rust1", since = "1.0.0"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicIsize"),
"isize",
"",
atomic_min, atomic_max,
$align,
"AtomicIsize::new(0)",
isize AtomicIsize ATOMIC_ISIZE_INIT
}
#[cfg(target_has_atomic_load_store = "ptr")]
#[cfg(target_pointer_width = $target_pointer_width)]
atomic_int! {
cfg(target_has_atomic = "ptr"),
cfg(target_has_atomic_equal_alignment = "ptr"),
stable(feature = "rust1", since = "1.0.0"),
stable(feature = "extended_compare_and_swap", since = "1.10.0"),
stable(feature = "atomic_debug", since = "1.3.0"),
stable(feature = "atomic_access", since = "1.15.0"),
stable(feature = "atomic_from", since = "1.23.0"),
stable(feature = "atomic_nand", since = "1.27.0"),
rustc_const_stable(feature = "const_ptr_sized_atomics", since = "1.24.0"),
stable(feature = "rust1", since = "1.0.0"),
cfg_attr(not(test), rustc_diagnostic_item = "AtomicUsize"),
"usize",
"",
atomic_umin, atomic_umax,
$align,
"AtomicUsize::new(0)",
usize AtomicUsize ATOMIC_USIZE_INIT
}
)* };
}
atomic_int_ptr_sized! {
"16" 2
"32" 4
"64" 8
}
#[inline]
#[cfg(target_has_atomic)]
fn strongest_failure_ordering(order: Ordering) -> Ordering {
match order {
Release => Relaxed,
Relaxed => Relaxed,
SeqCst => SeqCst,
Acquire => Acquire,
AcqRel => Acquire,
}
}
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_store<T: Copy>(dst: *mut T, val: T, order: Ordering) {
// SAFETY: 调用者必须遵守 `atomic_store` 的安全保证。
unsafe {
match order {
Relaxed => intrinsics::atomic_store_relaxed(dst, val),
Release => intrinsics::atomic_store_release(dst, val),
SeqCst => intrinsics::atomic_store_seqcst(dst, val),
Acquire => panic!("there is no such thing as an acquire store"),
AcqRel => panic!("there is no such thing as an acquire-release store"),
}
}
}
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_load<T: Copy>(dst: *const T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_load` 的安全保证。
unsafe {
match order {
Relaxed => intrinsics::atomic_load_relaxed(dst),
Acquire => intrinsics::atomic_load_acquire(dst),
SeqCst => intrinsics::atomic_load_seqcst(dst),
Release => panic!("there is no such thing as a release load"),
AcqRel => panic!("there is no such thing as an acquire-release load"),
}
}
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_swap<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_swap` 的安全保证。
unsafe {
match order {
Relaxed => intrinsics::atomic_xchg_relaxed(dst, val),
Acquire => intrinsics::atomic_xchg_acquire(dst, val),
Release => intrinsics::atomic_xchg_release(dst, val),
AcqRel => intrinsics::atomic_xchg_acqrel(dst, val),
SeqCst => intrinsics::atomic_xchg_seqcst(dst, val),
}
}
}
/// 返回前一个值 (如 __sync_fetch_and_add)。
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_add<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_add` 的安全保证。
unsafe {
match order {
Relaxed => intrinsics::atomic_xadd_relaxed(dst, val),
Acquire => intrinsics::atomic_xadd_acquire(dst, val),
Release => intrinsics::atomic_xadd_release(dst, val),
AcqRel => intrinsics::atomic_xadd_acqrel(dst, val),
SeqCst => intrinsics::atomic_xadd_seqcst(dst, val),
}
}
}
/// 返回前一个值 (如 __sync_fetch_and_sub)。
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_sub<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_sub` 的安全保证。
unsafe {
match order {
Relaxed => intrinsics::atomic_xsub_relaxed(dst, val),
Acquire => intrinsics::atomic_xsub_acquire(dst, val),
Release => intrinsics::atomic_xsub_release(dst, val),
AcqRel => intrinsics::atomic_xsub_acqrel(dst, val),
SeqCst => intrinsics::atomic_xsub_seqcst(dst, val),
}
}
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_compare_exchange<T: Copy>(
dst: *mut T,
old: T,
new: T,
success: Ordering,
failure: Ordering,
) -> Result<T, T> {
// SAFETY: 调用者必须遵守 `atomic_compare_exchange` 的安全保证。
let (val, ok) = unsafe {
match (success, failure) {
(Relaxed, Relaxed) => intrinsics::atomic_cxchg_relaxed_relaxed(dst, old, new),
(Relaxed, Acquire) => intrinsics::atomic_cxchg_relaxed_acquire(dst, old, new),
(Relaxed, SeqCst) => intrinsics::atomic_cxchg_relaxed_seqcst(dst, old, new),
(Acquire, Relaxed) => intrinsics::atomic_cxchg_acquire_relaxed(dst, old, new),
(Acquire, Acquire) => intrinsics::atomic_cxchg_acquire_acquire(dst, old, new),
(Acquire, SeqCst) => intrinsics::atomic_cxchg_acquire_seqcst(dst, old, new),
(Release, Relaxed) => intrinsics::atomic_cxchg_release_relaxed(dst, old, new),
(Release, Acquire) => intrinsics::atomic_cxchg_release_acquire(dst, old, new),
(Release, SeqCst) => intrinsics::atomic_cxchg_release_seqcst(dst, old, new),
(AcqRel, Relaxed) => intrinsics::atomic_cxchg_acqrel_relaxed(dst, old, new),
(AcqRel, Acquire) => intrinsics::atomic_cxchg_acqrel_acquire(dst, old, new),
(AcqRel, SeqCst) => intrinsics::atomic_cxchg_acqrel_seqcst(dst, old, new),
(SeqCst, Relaxed) => intrinsics::atomic_cxchg_seqcst_relaxed(dst, old, new),
(SeqCst, Acquire) => intrinsics::atomic_cxchg_seqcst_acquire(dst, old, new),
(SeqCst, SeqCst) => intrinsics::atomic_cxchg_seqcst_seqcst(dst, old, new),
(_, AcqRel) => panic!("there is no such thing as an acquire-release failure ordering"),
(_, Release) => panic!("there is no such thing as a release failure ordering"),
}
};
if ok { Ok(val) } else { Err(val) }
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_compare_exchange_weak<T: Copy>(
dst: *mut T,
old: T,
new: T,
success: Ordering,
failure: Ordering,
) -> Result<T, T> {
// SAFETY: 调用者必须遵守 `atomic_compare_exchange_weak` 的安全保证。
let (val, ok) = unsafe {
match (success, failure) {
(Relaxed, Relaxed) => intrinsics::atomic_cxchgweak_relaxed_relaxed(dst, old, new),
(Relaxed, Acquire) => intrinsics::atomic_cxchgweak_relaxed_acquire(dst, old, new),
(Relaxed, SeqCst) => intrinsics::atomic_cxchgweak_relaxed_seqcst(dst, old, new),
(Acquire, Relaxed) => intrinsics::atomic_cxchgweak_acquire_relaxed(dst, old, new),
(Acquire, Acquire) => intrinsics::atomic_cxchgweak_acquire_acquire(dst, old, new),
(Acquire, SeqCst) => intrinsics::atomic_cxchgweak_acquire_seqcst(dst, old, new),
(Release, Relaxed) => intrinsics::atomic_cxchgweak_release_relaxed(dst, old, new),
(Release, Acquire) => intrinsics::atomic_cxchgweak_release_acquire(dst, old, new),
(Release, SeqCst) => intrinsics::atomic_cxchgweak_release_seqcst(dst, old, new),
(AcqRel, Relaxed) => intrinsics::atomic_cxchgweak_acqrel_relaxed(dst, old, new),
(AcqRel, Acquire) => intrinsics::atomic_cxchgweak_acqrel_acquire(dst, old, new),
(AcqRel, SeqCst) => intrinsics::atomic_cxchgweak_acqrel_seqcst(dst, old, new),
(SeqCst, Relaxed) => intrinsics::atomic_cxchgweak_seqcst_relaxed(dst, old, new),
(SeqCst, Acquire) => intrinsics::atomic_cxchgweak_seqcst_acquire(dst, old, new),
(SeqCst, SeqCst) => intrinsics::atomic_cxchgweak_seqcst_seqcst(dst, old, new),
(_, AcqRel) => panic!("there is no such thing as an acquire-release failure ordering"),
(_, Release) => panic!("there is no such thing as a release failure ordering"),
}
};
if ok { Ok(val) } else { Err(val) }
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_and<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_and` 的安全保证
unsafe {
match order {
Relaxed => intrinsics::atomic_and_relaxed(dst, val),
Acquire => intrinsics::atomic_and_acquire(dst, val),
Release => intrinsics::atomic_and_release(dst, val),
AcqRel => intrinsics::atomic_and_acqrel(dst, val),
SeqCst => intrinsics::atomic_and_seqcst(dst, val),
}
}
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_nand<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_nand` 的安全保证
unsafe {
match order {
Relaxed => intrinsics::atomic_nand_relaxed(dst, val),
Acquire => intrinsics::atomic_nand_acquire(dst, val),
Release => intrinsics::atomic_nand_release(dst, val),
AcqRel => intrinsics::atomic_nand_acqrel(dst, val),
SeqCst => intrinsics::atomic_nand_seqcst(dst, val),
}
}
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_or<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_or` 的安全保证
unsafe {
match order {
SeqCst => intrinsics::atomic_or_seqcst(dst, val),
Acquire => intrinsics::atomic_or_acquire(dst, val),
Release => intrinsics::atomic_or_release(dst, val),
AcqRel => intrinsics::atomic_or_acqrel(dst, val),
Relaxed => intrinsics::atomic_or_relaxed(dst, val),
}
}
}
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_xor<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_xor` 的安全保证
unsafe {
match order {
SeqCst => intrinsics::atomic_xor_seqcst(dst, val),
Acquire => intrinsics::atomic_xor_acquire(dst, val),
Release => intrinsics::atomic_xor_release(dst, val),
AcqRel => intrinsics::atomic_xor_acqrel(dst, val),
Relaxed => intrinsics::atomic_xor_relaxed(dst, val),
}
}
}
/// 返回最大值 (有符号比较)
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_max<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_max` 的安全保证
unsafe {
match order {
Relaxed => intrinsics::atomic_max_relaxed(dst, val),
Acquire => intrinsics::atomic_max_acquire(dst, val),
Release => intrinsics::atomic_max_release(dst, val),
AcqRel => intrinsics::atomic_max_acqrel(dst, val),
SeqCst => intrinsics::atomic_max_seqcst(dst, val),
}
}
}
/// 返回最小值 (带符号的比较)
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_min<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_min` 的安全保证
unsafe {
match order {
Relaxed => intrinsics::atomic_min_relaxed(dst, val),
Acquire => intrinsics::atomic_min_acquire(dst, val),
Release => intrinsics::atomic_min_release(dst, val),
AcqRel => intrinsics::atomic_min_acqrel(dst, val),
SeqCst => intrinsics::atomic_min_seqcst(dst, val),
}
}
}
/// 返回最大值 (无符号比较)
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_umax<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_umax` 的安全保证
unsafe {
match order {
Relaxed => intrinsics::atomic_umax_relaxed(dst, val),
Acquire => intrinsics::atomic_umax_acquire(dst, val),
Release => intrinsics::atomic_umax_release(dst, val),
AcqRel => intrinsics::atomic_umax_acqrel(dst, val),
SeqCst => intrinsics::atomic_umax_seqcst(dst, val),
}
}
}
/// 返回最小值 (无符号比较)
#[inline]
#[cfg(target_has_atomic)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
unsafe fn atomic_umin<T: Copy>(dst: *mut T, val: T, order: Ordering) -> T {
// SAFETY: 调用者必须遵守 `atomic_umin` 的安全保证
unsafe {
match order {
Relaxed => intrinsics::atomic_umin_relaxed(dst, val),
Acquire => intrinsics::atomic_umin_acquire(dst, val),
Release => intrinsics::atomic_umin_release(dst, val),
AcqRel => intrinsics::atomic_umin_acqrel(dst, val),
SeqCst => intrinsics::atomic_umin_seqcst(dst, val),
}
}
}
/// 原子栅栏。
///
/// 根据指定的顺序,栅栏可防止编译器和 CPU 对其周围的某些类型的内存操作重新排序。
/// 这会在它与其他线程中的原子操作或栅栏之间创建同步关系。
///
/// 具有 (至少) [`Release`] 排序语义的栅栏 `A` 与具有 (至少) [`Acquire`] 语义的栅栏 `B` 同步,当且仅当存在操作 X 和 Y 时,这两个操作都在某个原子对象 `M` 上操作,使得 A 在 X 之前排序,Y 在 B 之前排序,并且 Y 观察到 M 的变化
/// 这提供了 A 和 B 之间的依存关系。
///
/// ```text
/// Thread 1 Thread 2
///
/// fence(Release); A --------------
/// x.store(3, Relaxed); X --------- |
/// | |
/// | |
/// -------------> Y if x.load(Relaxed) == 3 {
/// |-------> B fence(Acquire);
/// ...
/// }
/// ```
///
/// 具有 [`Release`] 或 [`Acquire`] 语义的原子操作也可以与栅栏同步。
///
/// 除了具有 [`Acquire`] 和 [`Release`] 语义外,具有 [`SeqCst`] 顺序的栅栏还参与其他 [`SeqCst`] 操作和/或栅栏的全局程序顺序。
///
/// 接受 [`Acquire`],[`Release`],[`AcqRel`] 和 [`SeqCst`] 排序。
///
/// # Panics
///
/// 如果 `order` 为 [`Relaxed`],就会出现 panics。
///
/// # Examples
///
/// ```
/// use std::sync::atomic::AtomicBool;
/// use std::sync::atomic::fence;
/// use std::sync::atomic::Ordering;
///
/// // 基于自旋锁的互斥原语。
/// pub struct Mutex {
/// flag: AtomicBool,
/// }
///
/// impl Mutex {
/// pub fn new() -> Mutex {
/// Mutex {
/// flag: AtomicBool::new(false),
/// }
/// }
///
/// pub fn lock(&self) {
/// // 等待直到旧值为 `false`。
/// while self
/// .flag
/// .compare_exchange_weak(false, true, Ordering::Relaxed, Ordering::Relaxed)
/// .is_err()
/// {}
/// // 此栅栏与 `unlock` 中的存储同步。
/// fence(Ordering::Acquire);
/// }
///
/// pub fn unlock(&self) {
/// self.flag.store(false, Ordering::Release);
/// }
/// }
/// ```
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_diagnostic_item = "fence"]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn fence(order: Ordering) {
// SAFETY: 使用原子栅栏是安全的。
unsafe {
match order {
Acquire => intrinsics::atomic_fence_acquire(),
Release => intrinsics::atomic_fence_release(),
AcqRel => intrinsics::atomic_fence_acqrel(),
SeqCst => intrinsics::atomic_fence_seqcst(),
Relaxed => panic!("there is no such thing as a relaxed fence"),
}
}
}
/// 编译器内存栅栏。
///
/// `compiler_fence` 不发出任何机器代码,但限制了允许编译器重新排序的内存种类。具体来说,根据给定的 [`Ordering`] 语义,可能不允许编译器将调用之前或之后的读取或写入移动到 `compiler_fence` 的另一侧。请注意,它确实不会阻止 *硬件* 进行此类重新排序。
///
/// 在单线程执行上下文中这不是问题,但是当其他线程可以同时修改内存时,则需要更强大的同步原语,例如 [`fence`]。
///
/// 通过不同的排序语义防止的重新排序是:
///
/// - 对于 [`SeqCst`],不允许在这一点上对读取和写入进行重新排序。
/// - 对于 [`Release`],不能将先前的读取和写入移至后续的写入之后。
/// - 如果使用 [`Acquire`],则后续的读取和写入操作不能移至先前的读取操作之前。
/// - 对于 [`AcqRel`],将同时执行以上两个规则。
///
/// `compiler_fence` 通常仅用于防止线程与自身发生冲突时有用。也就是说,如果给定线程正在执行一段代码,然后被中断,并开始在其他位置执行代码 (虽然仍在同一线程中,并且从概念上讲仍在同一内核上)。在传统程序中,只有在注册信号处理程序时才会发生这种情况。
/// 在更多灵活的代码中,当处理中断,以抢占方式实现绿色线程等时,也会出现这种情况。
/// 鼓励好奇的读者阅读 Linux 内核对 [内存屏障][memory barriers] 的讨论。
///
/// # Panics
///
/// 如果 `order` 为 [`Relaxed`],就会出现 panics。
///
/// # Examples
///
/// 如果没有 `compiler_fence`,则尽管所有内容都在单个线程中发生,但不能保证以下代码中的 `assert_eq!` 成功。
/// 要了解原因,请记住编译器可以自由地将存储交换为 `IMPORTANT_VARIABLE` 和 `IS_READY`,因为它们都是 `Ordering::Relaxed`。如果是这样,并且在更新 `IS_READY` 之后立即调用信号处理程序,则信号处理程序将看到 `IS_READY=1`,但是看到 `IMPORTANT_VARIABLE=0`。
/// 使用 `compiler_fence` 可以解决这种情况。
///
/// ```
/// use std::sync::atomic::{AtomicBool, AtomicUsize};
/// use std::sync::atomic::Ordering;
/// use std::sync::atomic::compiler_fence;
///
/// static IMPORTANT_VARIABLE: AtomicUsize = AtomicUsize::new(0);
/// static IS_READY: AtomicBool = AtomicBool::new(false);
///
/// fn main() {
/// IMPORTANT_VARIABLE.store(42, Ordering::Relaxed);
/// // 防止将较早的写入移至此点之外
/// compiler_fence(Ordering::Release);
/// IS_READY.store(true, Ordering::Relaxed);
/// }
///
/// fn signal_handler() {
/// if IS_READY.load(Ordering::Relaxed) {
/// assert_eq!(IMPORTANT_VARIABLE.load(Ordering::Relaxed), 42);
/// }
/// }
/// ```
///
/// [memory barriers]: https://www.kernel.org/doc/Documentation/memory-barriers.txt
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "compiler_fences", since = "1.21.0")]
#[rustc_diagnostic_item = "compiler_fence"]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub fn compiler_fence(order: Ordering) {
// SAFETY: 使用原子栅栏是安全的。
unsafe {
match order {
Acquire => intrinsics::atomic_singlethreadfence_acquire(),
Release => intrinsics::atomic_singlethreadfence_release(),
AcqRel => intrinsics::atomic_singlethreadfence_acqrel(),
SeqCst => intrinsics::atomic_singlethreadfence_seqcst(),
Relaxed => panic!("there is no such thing as a relaxed compiler fence"),
}
}
}
#[cfg(target_has_atomic_load_store = "8")]
#[stable(feature = "atomic_debug", since = "1.3.0")]
impl fmt::Debug for AtomicBool {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&self.load(Ordering::Relaxed), f)
}
}
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "atomic_debug", since = "1.3.0")]
impl<T> fmt::Debug for AtomicPtr<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&self.load(Ordering::Relaxed), f)
}
}
#[cfg(target_has_atomic_load_store = "ptr")]
#[stable(feature = "atomic_pointer", since = "1.24.0")]
impl<T> fmt::Pointer for AtomicPtr<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Pointer::fmt(&self.load(Ordering::SeqCst), f)
}
}
/// 向处理器发出信号,通知它处于忙于等待的自旋循环 (自旋锁) 中。
///
/// 不推荐使用此函数,而推荐使用 [`hint::spin_loop`]。
///
/// [`hint::spin_loop`]: crate::hint::spin_loop
#[inline]
#[stable(feature = "spin_loop_hint", since = "1.24.0")]
#[deprecated(since = "1.51.0", note = "use hint::spin_loop instead")]
pub fn spin_loop_hint() {
spin_loop()
}