Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 | /* * Copyright (c) 2003-2019 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in * compliance with the License. The rights granted to you under the License * may not be used to create, or enable the creation or redistribution of, * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ #ifndef _KERN_LOCKS_H_ #define _KERN_LOCKS_H_ #include <sys/cdefs.h> #include <sys/appleapiopts.h> #include <mach/boolean.h> #include <machine/locks.h> #include <kern/assert.h> #include <kern/kern_types.h> #include <kern/lock_attr.h> #include <kern/lock_group.h> #include <kern/lock_mtx.h> #include <kern/lock_rw.h> #include <kern/lock_types.h> #ifdef KERNEL_PRIVATE #include <kern/ticket_lock.h> #endif #ifdef XNU_KERNEL_PRIVATE #include <kern/startup.h> #include <kern/percpu.h> #endif /* XNU_KERNEL_PRIVATE */ __BEGIN_DECLS #define decl_lck_spin_data(class, name) class lck_spin_t name extern lck_spin_t *lck_spin_alloc_init( lck_grp_t *grp, lck_attr_t *attr); extern void lck_spin_init( lck_spin_t *lck, lck_grp_t *grp, lck_attr_t *attr); extern void lck_spin_lock( lck_spin_t *lck); extern void lck_spin_lock_grp( lck_spin_t *lck, lck_grp_t *grp); extern void lck_spin_unlock( lck_spin_t *lck); extern void lck_spin_destroy( lck_spin_t *lck, lck_grp_t *grp); extern void lck_spin_free( lck_spin_t *lck, lck_grp_t *grp); extern wait_result_t lck_spin_sleep( lck_spin_t *lck, lck_sleep_action_t lck_sleep_action, event_t event, wait_interrupt_t interruptible); extern wait_result_t lck_spin_sleep_grp( lck_spin_t *lck, lck_sleep_action_t lck_sleep_action, event_t event, wait_interrupt_t interruptible, lck_grp_t *grp); extern wait_result_t lck_spin_sleep_deadline( lck_spin_t *lck, lck_sleep_action_t lck_sleep_action, event_t event, wait_interrupt_t interruptible, uint64_t deadline); #ifdef KERNEL_PRIVATE extern void lck_spin_lock_nopreempt( lck_spin_t *lck); extern void lck_spin_lock_nopreempt_grp( lck_spin_t *lck, lck_grp_t *grp); extern void lck_spin_unlock_nopreempt( lck_spin_t *lck); extern boolean_t lck_spin_try_lock_grp( lck_spin_t *lck, lck_grp_t *grp); extern boolean_t lck_spin_try_lock( lck_spin_t *lck); extern boolean_t lck_spin_try_lock_nopreempt( lck_spin_t *lck); extern boolean_t lck_spin_try_lock_nopreempt_grp( lck_spin_t *lck, lck_grp_t *grp); /* NOT SAFE: To be used only by kernel debugger to avoid deadlock. */ extern boolean_t kdp_lck_spin_is_acquired( lck_spin_t *lck); /* * Name: lck_spin_sleep_with_inheritor * * Description: * deschedule the current thread and wait on the waitq associated with event * to be woken up. * * While waiting, the sched priority of the waiting thread will contribute to * the push of the event that will be directed to the inheritor specified. * * An interruptible mode and deadline can be specified to return earlier from * the wait. * * Args: * Arg1: lck_spin_t lock used to protect the sleep. * The lock will be dropped while sleeping and reaquired before * returning according to the sleep action specified. * Arg2: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_UNLOCK. * Arg3: event to wait on. * Arg4: thread to propagate the event push to. * Arg5: interruptible flag for wait. * Arg6: deadline for wait. * * Conditions: * Lock must be held. * * Returns with the lock held according to the sleep action specified. * Lock will be dropped while waiting. * * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the event or a wakeup for the event is called. * * Returns: result of the wait. */ extern wait_result_t lck_spin_sleep_with_inheritor( lck_spin_t *lock, lck_sleep_action_t lck_sleep_action, event_t event, thread_t inheritor, wait_interrupt_t interruptible, uint64_t deadline); #if MACH_KERNEL_PRIVATE /* * Name: hw_lck_ticket_sleep_with_inheritor * * Description: * deschedule the current thread and wait on the waitq associated with event * to be woken up. * * While waiting, the sched priority of the waiting thread will contribute to * the push of the event that will be directed to the inheritor specified. * * An interruptible mode and deadline can be specified to return earlier from * the wait. * * Args: * Arg1: hw_lck_ticket_t lock used to protect the sleep. * The lock will be dropped while sleeping and reaquired before * returning according to the sleep action specified. * Arg2: lck_grp_t associated with the lock. * Arg3: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_UNLOCK. * Arg3: event to wait on. * Arg5: thread to propagate the event push to. * Arg6: interruptible flag for wait. * Arg7: deadline for wait. * * Conditions: * Lock must be held. * * Returns with the lock held according to the sleep action specified. * * Lock will be dropped while waiting. * * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the event or a wakeup for the event is called. * * Returns: result of the wait. */ extern wait_result_t hw_lck_ticket_sleep_with_inheritor( hw_lck_ticket_t *lock, lck_grp_t *grp, lck_sleep_action_t lck_sleep_action, event_t event, thread_t inheritor, wait_interrupt_t interruptible, uint64_t deadline); #endif /* * Name: lck_ticket_sleep_with_inheritor * * Description: * deschedule the current thread and wait on the waitq associated with event * to be woken up. * * While waiting, the sched priority of the waiting thread will contribute to * the push of the event that will be directed to the inheritor specified. * * An interruptible mode and deadline can be specified to return earlier from * the wait. * * Args: * Arg1: lck_ticket_t lock used to protect the sleep. * The lock will be dropped while sleeping and reaquired before * returning according to the sleep action specified. * Arg2: lck_grp_t associated with the lock. * Arg3: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_UNLOCK. * Arg3: event to wait on. * Arg5: thread to propagate the event push to. * Arg6: interruptible flag for wait. * Arg7: deadline for wait. * * Conditions: * Lock must be held. * * Returns with the lock held according to the sleep action specified. * * Lock will be dropped while waiting. * * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the event or a wakeup for the event is called. * * Returns: result of the wait. */ extern wait_result_t lck_ticket_sleep_with_inheritor( lck_ticket_t *lock, lck_grp_t *grp, lck_sleep_action_t lck_sleep_action, event_t event, thread_t inheritor, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: lck_mtx_sleep_with_inheritor * * Description: * deschedule the current thread and wait on the waitq associated with event * to be woken up. * * While waiting, the sched priority of the waiting thread will contribute to * the push of the event that will be directed to the inheritor specified. * * An interruptible mode and deadline can be specified to return earlier from * the wait. * * Args: * Arg1: lck_mtx_t lock used to protect the sleep. * The lock will be dropped while sleeping and reaquired before * returning according to the sleep action specified. * Arg2: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_UNLOCK, LCK_SLEEP_SPIN, LCK_SLEEP_SPIN_ALWAYS. * Arg3: event to wait on. * Arg4: thread to propagate the event push to. * Arg5: interruptible flag for wait. * Arg6: deadline for wait. * * Conditions: * Lock must be held. * * Returns with the lock held according to the sleep action specified. * * Lock will be dropped while waiting. * * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the event or a wakeup for the event is called. * * Returns: result of the wait. */ extern wait_result_t lck_mtx_sleep_with_inheritor( lck_mtx_t *lock, lck_sleep_action_t lck_sleep_action, event_t event, thread_t inheritor, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: lck_rw_sleep_with_inheritor * * Description: * deschedule the current thread and wait on the waitq associated with event * to be woken up. * * While waiting, the sched priority of the waiting thread will contribute to * the push of the event that will be directed to the inheritor specified. * * An interruptible mode and deadline can be specified to return earlier from * the wait. * * Args: * Arg1: lck_rw_t lock used to protect the sleep. * The lock will be dropped while sleeping and reaquired before * returning according to the sleep action specified. * Arg2: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_SHARED, LCK_SLEEP_EXCLUSIVE. * Arg3: event to wait on. * Arg4: thread to propagate the event push to. * Arg5: interruptible flag for wait. * Arg6: deadline for wait. * * Conditions: * Lock must be held. * * Returns with the lock held according to the sleep action specified. * * Lock will be dropped while waiting. * * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the event or a wakeup for the event is called. * * Returns: result of the wait. */ extern wait_result_t lck_rw_sleep_with_inheritor( lck_rw_t *lock, lck_sleep_action_t lck_sleep_action, event_t event, thread_t inheritor, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: wakeup_one_with_inheritor * * Description: * Wake up one waiter for event if any. * * The thread woken up will be the one with the higher sched priority waiting * on event. * * The push for the event will be transferred from the last inheritor to the * woken up thread. * * Args: * Arg1: event to wake from. * Arg2: wait result to pass to the woken up thread. * Arg3: pointer for storing the thread wokenup. * * Returns: KERN_NOT_WAITING if no threads were waiting, KERN_SUCCESS otherwise. * * Conditions: * The new woken up inheritor cannot return to user space or exit until * another inheritor is specified for the event or a new wakeup for the event * is performed. * * A reference for the woken thread is acquired. * * NOTE: this cannot be called from interrupt context. */ extern kern_return_t wakeup_one_with_inheritor( event_t event, wait_result_t result, lck_wake_action_t action, thread_t *thread_wokenup); extern kern_return_t wakeup_thread_with_inheritor( event_t event, wait_result_t result, lck_wake_action_t action, thread_t thread_towake); /* * Name: wakeup_all_with_inheritor * * Description: wake up all waiters waiting for event. The old inheritor will lose the push. * * Args: * Arg1: event to wake from. * Arg2: wait result to pass to the woken up threads. * * Returns: KERN_NOT_WAITING if no threads were waiting, KERN_SUCCESS otherwise. * * Conditions: NOTE: this cannot be called from interrupt context. */ extern kern_return_t wakeup_all_with_inheritor( event_t event, wait_result_t result); /* * Name: change_sleep_inheritor * * Description: * Redirect the push of the waiting threads of event to the new inheritor specified. * * Args: * Arg1: event to redirect the push. * Arg2: new inheritor for event. * * Returns: KERN_NOT_WAITING if no threads were waiting, KERN_SUCCESS otherwise. * * Conditions: * In case of success, the new inheritor cannot return to user space or exit * until another inheritor is specified for the event or a wakeup for the * event is called. * * NOTE: this cannot be called from interrupt context. */ extern kern_return_t change_sleep_inheritor( event_t event, thread_t inheritor); #if XNU_KERNEL_PRIVATE /* * Bits layout of cond_swi_var32/cond_swi_var64. * First SWI_COND_OWNER_BITS are reserved for the owner * the remaining can be used by the caller */ #define SWI_COND_OWNER_BITS 20 #define SWI_COND_CALLER_BITS (32 - SWI_COND_OWNER_BITS) typedef struct cond_swi_var32 { union { uint32_t cond32_data; struct { uint32_t cond32_owner: SWI_COND_OWNER_BITS, cond32_caller_bits: SWI_COND_CALLER_BITS; }; }; } cond_swi_var32_s; typedef struct cond_swi_var64 { union { uint64_t cond64_data; struct { uint32_t cond64_owner: SWI_COND_OWNER_BITS, cond64_caller_bits: SWI_COND_CALLER_BITS; uint32_t cond64_caller_extra; }; }; } cond_swi_var64_s; typedef struct cond_swi_var *cond_swi_var_t; /* * Name: cond_sleep_with_inheritor32 * * Description: Conditionally sleeps with inheritor, with condition variable of 32bits. * Allows a thread to conditionally sleep while indicating which thread should * inherit the priority push associated with the condition. * The condition should be expressed through a cond_swi_var32_s pointer. * The condition needs to be populated by the caller with the ctid of the * thread that should inherit the push. The remaining bits of the condition * can be used by the caller to implement its own synchronization logic. * A copy of the condition value observed by the caller when it decided to call * this function should be provided to prevent races with matching wakeups. * This function will atomically check the value stored in the condition against * the expected/observed one provided. If the check doesn't pass the thread will not * sleep and the function will return. * The ctid provided in the condition will be used only after a successful * check. * * Args: * Arg1: cond_swi_var32_s pointer that stores the condition to check. * Arg2: cond_swi_var32_s observed value to check for conditionally sleep. * Arg3: interruptible flag for wait. * Arg4: deadline for wait. * * Conditions: * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the cond or a wakeup for the cond is called. * * Returns: result of the wait. */ extern wait_result_t cond_sleep_with_inheritor32( cond_swi_var_t cond, cond_swi_var32_s expected_cond, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: cond_sleep_with_inheritor64 * * Description: Conditionally sleeps with inheritor, with condition variable of 64bits. * Allows a thread to conditionally sleep while indicating which thread should * inherit the priority push associated with the condition. * The condition should be expressed through a cond_swi_var64_s pointer. * The condition needs to be populated by the caller with the ctid of the * thread that should inherit the push. The remaining bits of the condition * can be used by the caller to implement its own synchronization logic. * A copy of the condition value observed by the caller when it decided to call * this function should be provided to prevent races with matching wakeups. * This function will atomically check the value stored in the condition against * the expected/observed one provided. If the check doesn't pass the thread will not * sleep and the function will return. * The ctid provided in the condition will be used only after a successful * check. * * Args: * Arg1: cond_swi_var64_s pointer that stores the condition to check. * Arg2: cond_swi_var64_s observed value to check for conditionally sleep. * Arg3: interruptible flag for wait. * Arg4: deadline for wait. * * Conditions: * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the cond or a wakeup for the cond is called. * * Returns: result of the wait. */ extern wait_result_t cond_sleep_with_inheritor64( cond_swi_var_t cond, cond_swi_var64_s expected_cond, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: cond_sleep_with_inheritor64_mask * * Description: Conditionally sleeps with inheritor, with condition variable of 64bits. * Allows a thread to conditionally sleep while indicating which thread should * inherit the priority push associated with the condition. * The condition should be expressed through a cond_swi_var64_s pointer. * The condition needs to be populated by the caller with the ctid of the * thread that should inherit the push. The remaining bits of the condition * can be used by the caller to implement its own synchronization logic. * A copy of the condition value observed by the caller when it decided to call * this function should be provided to prevent races with matching wakeups. * This function will atomically check the value stored in the condition against * the expected/observed one provided only for the bits that are set in the mask. * If the check doesn't pass the thread will not sleep and the function will return. * The ctid provided in the condition will be used only after a successful * check. * * Args: * Arg1: cond_swi_var64_s pointer that stores the condition to check. * Arg2: cond_swi_var64_s observed value to check for conditionally sleep. * Arg3: mask to apply to the condition to check. * Arg4: interruptible flag for wait. * Arg5: deadline for wait. * * Conditions: * The inheritor specified cannot return to user space or exit until another * inheritor is specified for the cond or a wakeup for the cond is called. * * Returns: result of the wait. */ extern wait_result_t cond_sleep_with_inheritor64_mask( cond_swi_var_t cond, cond_swi_var64_s expected_cond, uint64_t check_mask, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: cond_wakeup_one_with_inheritor * * Description: Wake up one waiter waiting on the condition (if any). * The thread woken up will be the one with the higher sched priority waiting on the condition. * The push for the condition will be transferred from the last inheritor to the woken up thread. * * Args: * Arg1: condition to wake from. * Arg2: wait result to pass to the woken up thread. * Arg3: pointer for storing the thread wokenup. * * Returns: KERN_NOT_WAITING if no threads were waiting, KERN_SUCCESS otherwise. * * Conditions: * The new woken up inheritor cannot return to user space or exit until * another inheritor is specified for the event or a new wakeup for the event * is performed. * * A reference for the woken thread is acquired. * * NOTE: this cannot be called from interrupt context. */ extern kern_return_t cond_wakeup_one_with_inheritor( cond_swi_var_t cond, wait_result_t result, lck_wake_action_t action, thread_t *thread_wokenup); /* * Name: cond_wakeup_all_with_inheritor * * Description: Wake up all waiters waiting on the same condition. The old inheritor will lose the push. * * Args: * Arg1: condition to wake from. * Arg2: wait result to pass to the woken up threads. * * Returns: KERN_NOT_WAITING if no threads were waiting, KERN_SUCCESS otherwise. * * Conditions: NOTE: this cannot be called from interrupt context. */ extern kern_return_t cond_wakeup_all_with_inheritor( cond_swi_var_t cond, wait_result_t result); /* * gate structure */ typedef struct gate { uintptr_t gt_data; // thread holder, interlock bit and waiter bit struct turnstile *gt_turnstile; // turnstile, protected by the interlock bit union { struct { uint32_t gt_refs:16, // refs using the gate, protected by interlock bit gt_alloc:1, // gate was allocated with gate_alloc_init gt_type:2, // type bits for validity gt_flags_pad:13; // unused }; uint32_t gt_flags; }; } gate_t; #else /* XNU_KERNEL_PRIVATE */ typedef struct gate { uintptr_t opaque1; uintptr_t opaque2; uint32_t opaque3; } gate_t; #endif /* XNU_KERNEL_PRIVATE */ /* * Possible gate_wait_result_t values. */ __options_decl(gate_wait_result_t, unsigned int, { GATE_HANDOFF = 0x00, /* gate was handedoff to current thread */ GATE_OPENED = 0x01, /* gate was opened */ GATE_TIMED_OUT = 0x02, /* wait timedout */ GATE_INTERRUPTED = 0x03, /* wait was interrupted */ }); /* * Gate flags used by gate_assert */ __options_decl(gate_assert_flags_t, unsigned int, { GATE_ASSERT_CLOSED = 0x00, /* asserts the gate is currently closed */ GATE_ASSERT_OPEN = 0x01, /* asserts the gate is currently open */ GATE_ASSERT_HELD = 0x02, /* asserts the gate is closed and held by current_thread() */ }); /* * Gate flags used by gate_handoff */ __options_decl(gate_handoff_flags_t, unsigned int, { GATE_HANDOFF_DEFAULT = 0x00, /* a waiter must exist to handoff the gate */ GATE_HANDOFF_OPEN_IF_NO_WAITERS = 0x1, /* behave like a gate_open() if there are no waiters */ }); /* * Name: decl_lck_rw_gate_data * * Description: declares a gate variable with specified storage class. * The gate itself will be stored in this variable and it is the caller's responsibility * to ensure that this variable's memory is going to be accessible by all threads that will use * the gate. * Every gate function will require a pointer to this variable as parameter. The same pointer should * be used in every thread. * * The variable needs to be initialized once with lck_rw_gate_init() and destroyed once with * lck_rw_gate_destroy() when not needed anymore. * * The gate will be used in conjunction with a lck_rw_t. * * Args: * Arg1: storage class. * Arg2: variable name. */ #define decl_lck_rw_gate_data(class, name) class gate_t name /* * Name: lck_rw_gate_init * * Description: initializes a variable declared with decl_lck_rw_gate_data. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. */ extern void lck_rw_gate_init(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_destroy * * Description: destroys a variable previously initialized * with lck_rw_gate_init(). * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. */ extern void lck_rw_gate_destroy(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_alloc_init * * Description: allocates and initializes a gate_t. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * * Returns: * gate_t allocated. */ extern gate_t* lck_rw_gate_alloc_init(lck_rw_t *lock); /* * Name: lck_rw_gate_free * * Description: destroys and tries to free a gate previously allocated * with lck_rw_gate_alloc_init(). * The gate free might be delegated to the last thread returning * from the gate_wait(). * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate obtained with lck_rw_gate_alloc_init(). */ extern void lck_rw_gate_free(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_try_close * * Description: Tries to close the gate. * In case of success the current thread will be set as * the holder of the gate. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * * Returns: * KERN_SUCCESS in case the gate was successfully closed. The current thread * is the new holder of the gate. * * A matching lck_rw_gate_open() or lck_rw_gate_handoff() needs to be called * later on to wake up possible waiters on the gate before returning to * userspace. * * If the intent is to conditionally probe the gate before waiting, the lock * must not be dropped between the calls to lck_rw_gate_try_close() and * lck_rw_gate_wait(). * * KERN_FAILURE in case the gate was already closed. * Will panic if the current thread was already the holder of the gate. * * lck_rw_gate_wait() should be called instead if the intent is to * unconditionally wait on this gate. * * The calls to lck_rw_gate_try_close() and lck_rw_gate_wait() should * be done without dropping the lock that is protecting the gate in between. */ extern kern_return_t lck_rw_gate_try_close(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_close * * Description: Closes the gate. The current thread will be set as * the holder of the gate. Will panic if the gate is already closed. * A matching lck_rw_gate_open() or lck_rw_gate_handoff() needs to be called later on * to wake up possible waiters on the gate before returning to userspace. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * The gate must be open. * */ extern void lck_rw_gate_close(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_open * * Description: Opens the gate and wakes up possible waiters. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * The current thread must be the holder of the gate. * */ extern void lck_rw_gate_open(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_handoff * * Description: Tries to transfer the ownership of the gate. The waiter with highest sched * priority will be selected as the new holder of the gate, and woken up, * with the gate remaining in the closed state throughout. * If no waiters are present, the gate will be kept closed and KERN_NOT_WAITING * will be returned. * GATE_HANDOFF_OPEN_IF_NO_WAITERS flag can be used to specify if the gate should be opened in * case no waiters were found. * * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * Arg3: flags - GATE_HANDOFF_DEFAULT or GATE_HANDOFF_OPEN_IF_NO_WAITERS * * Conditions: Lock must be held. Returns with the lock held. * The current thread must be the holder of the gate. * * Returns: * KERN_SUCCESS in case one of the waiters became the new holder. * KERN_NOT_WAITING in case there were no waiters. * */ extern kern_return_t lck_rw_gate_handoff(lck_rw_t *lock, gate_t *gate, gate_handoff_flags_t flags); /* * Name: lck_rw_gate_steal * * Description: Set the current ownership of the gate. It sets the current thread as the * new holder of the gate. * A matching lck_rw_gate_open() or lck_rw_gate_handoff() needs to be called later on * to wake up possible waiters on the gate before returning to userspace. * NOTE: the previous holder should not call lck_rw_gate_open() or lck_rw_gate_handoff() * anymore. * * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * The gate must be closed and the current thread must not already be the holder. * */ extern void lck_rw_gate_steal(lck_rw_t *lock, gate_t *gate); /* * Name: lck_rw_gate_wait * * Description: Waits for the current thread to become the holder of the gate or for the * gate to become open. An interruptible mode and deadline can be specified * to return earlier from the wait. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * Arg3: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_SHARED, LCK_SLEEP_EXCLUSIVE, LCK_SLEEP_UNLOCK. * Arg3: interruptible flag for wait. * Arg4: deadline * * Conditions: Lock must be held. Returns with the lock held according to the sleep action specified. * Lock will be dropped while waiting. * The gate must be closed. * * Returns: Reason why the thread was woken up. * GATE_HANDOFF - the current thread was handed off the ownership of the gate. * A matching lck_rw_gate_open() or lck_rw_gate_handoff() needs to be called later on. * to wake up possible waiters on the gate before returning to userspace. * GATE_OPENED - the gate was opened by the holder. * GATE_TIMED_OUT - the thread was woken up by a timeout. * GATE_INTERRUPTED - the thread was interrupted while sleeping. */ extern gate_wait_result_t lck_rw_gate_wait( lck_rw_t *lock, gate_t *gate, lck_sleep_action_t lck_sleep_action, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: lck_rw_gate_assert * * Description: asserts that the gate is in the specified state. * * Args: * Arg1: lck_rw_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_rw_gate_data. * Arg3: flags to specified assert type. * GATE_ASSERT_CLOSED - the gate is currently closed * GATE_ASSERT_OPEN - the gate is currently opened * GATE_ASSERT_HELD - the gate is currently closed and the current thread is the holder */ extern void lck_rw_gate_assert(lck_rw_t *lock, gate_t *gate, gate_assert_flags_t flags); /* * Name: decl_lck_mtx_gate_data * * Description: declares a gate variable with specified storage class. * The gate itself will be stored in this variable and it is the caller's responsibility * to ensure that this variable's memory is going to be accessible by all threads that will use * the gate. * Every gate function will require a pointer to this variable as parameter. The same pointer should * be used in every thread. * * The variable needs to be initialized once with lck_mtx_gate_init() and destroyed once with * lck_mtx_gate_destroy() when not needed anymore. * * The gate will be used in conjunction with a lck_mtx_t. * * Args: * Arg1: storage class. * Arg2: variable name. */ #define decl_lck_mtx_gate_data(class, name) class gate_t name /* * Name: lck_mtx_gate_init * * Description: initializes a variable declared with decl_lck_mtx_gate_data. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. */ extern void lck_mtx_gate_init(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_destroy * * Description: destroys a variable previously initialized * with lck_mtx_gate_init(). * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. */ extern void lck_mtx_gate_destroy(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_alloc_init * * Description: allocates and initializes a gate_t. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * * Returns: * gate_t allocated. */ extern gate_t* lck_mtx_gate_alloc_init(lck_mtx_t *lock); /* * Name: lck_mtx_gate_free * * Description: destroys and tries to free a gate previously allocated * with lck_mtx_gate_alloc_init(). * The gate free might be delegated to the last thread returning * from the gate_wait(). * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate obtained with lck_mtx_gate_alloc_init(). */ extern void lck_mtx_gate_free(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_try_close * * Description: Tries to close the gate. * In case of success the current thread will be set as * the holder of the gate. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * * Returns: * KERN_SUCCESS in case the gate was successfully closed. The current thread * is the new holder of the gate. * * A matching lck_mtx_gate_open() or lck_mtx_gate_handoff() needs to be called * later on to wake up possible waiters on the gate before returning to * userspace. * * If the intent is to conditionally probe the gate before waiting, the lock * must not be dropped between the calls to lck_mtx_gate_try_close() and * lck_mtx_gate_wait(). * * KERN_FAILURE in case the gate was already closed. Will panic if the current * thread was already the holder of the gate. * * lck_mtx_gate_wait() should be called instead if the intent is to * unconditionally wait on this gate. * * The calls to lck_mtx_gate_try_close() and lck_mtx_gate_wait() should * be done without dropping the lock that is protecting the gate in between. */ extern kern_return_t lck_mtx_gate_try_close(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_close * * Description: Closes the gate. The current thread will be set as * the holder of the gate. Will panic if the gate is already closed. * A matching lck_mtx_gate_open() or lck_mtx_gate_handoff() needs to be called later on * to wake up possible waiters on the gate before returning to userspace. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * The gate must be open. * */ extern void lck_mtx_gate_close(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_open * * Description: Opens of the gate and wakes up possible waiters. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * The current thread must be the holder of the gate. * */ extern void lck_mtx_gate_open(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_handoff * * Description: Tries to transfer the ownership of the gate. The waiter with highest sched * priority will be selected as the new holder of the gate, and woken up, * with the gate remaining in the closed state throughout. * If no waiters are present, the gate will be kept closed and KERN_NOT_WAITING * will be returned. * GATE_HANDOFF_OPEN_IF_NO_WAITERS flag can be used to specify if the gate should be opened in * case no waiters were found. * * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * Arg3: flags - GATE_HANDOFF_DEFAULT or GATE_HANDOFF_OPEN_IF_NO_WAITERS * * Conditions: Lock must be held. Returns with the lock held. * The current thread must be the holder of the gate. * * Returns: * KERN_SUCCESS in case one of the waiters became the new holder. * KERN_NOT_WAITING in case there were no waiters. * */ extern kern_return_t lck_mtx_gate_handoff(lck_mtx_t *lock, gate_t *gate, gate_handoff_flags_t flags); /* * Name: lck_mtx_gate_steal * * Description: Steals the ownership of the gate. It sets the current thread as the * new holder of the gate. * A matching lck_mtx_gate_open() or lck_mtx_gate_handoff() needs to be called later on * to wake up possible waiters on the gate before returning to userspace. * NOTE: the previous holder should not call lck_mtx_gate_open() or lck_mtx_gate_handoff() * anymore. * * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * * Conditions: Lock must be held. Returns with the lock held. * The gate must be closed and the current thread must not already be the holder. * */ extern void lck_mtx_gate_steal(lck_mtx_t *lock, gate_t *gate); /* * Name: lck_mtx_gate_wait * * Description: Waits for the current thread to become the holder of the gate or for the * gate to become open. An interruptible mode and deadline can be specified * to return earlier from the wait. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * Arg3: sleep action. LCK_SLEEP_DEFAULT, LCK_SLEEP_UNLOCK, LCK_SLEEP_SPIN, LCK_SLEEP_SPIN_ALWAYS. * Arg3: interruptible flag for wait. * Arg4: deadline * * Conditions: Lock must be held. Returns with the lock held according to the sleep action specified. * Lock will be dropped while waiting. * The gate must be closed. * * Returns: Reason why the thread was woken up. * GATE_HANDOFF - the current thread was handed off the ownership of the gate. * A matching lck_mtx_gate_open() or lck_mtx_gate_handoff() needs to be called later on * to wake up possible waiters on the gate before returning to userspace. * GATE_OPENED - the gate was opened by the holder. * GATE_TIMED_OUT - the thread was woken up by a timeout. * GATE_INTERRUPTED - the thread was interrupted while sleeping. */ extern gate_wait_result_t lck_mtx_gate_wait( lck_mtx_t *lock, gate_t *gate, lck_sleep_action_t lck_sleep_action, wait_interrupt_t interruptible, uint64_t deadline); /* * Name: lck_mtx_gate_assert * * Description: asserts that the gate is in the specified state. * * Args: * Arg1: lck_mtx_t lock used to protect the gate. * Arg2: pointer to the gate data declared with decl_lck_mtx_gate_data. * Arg3: flags to specified assert type. * GATE_ASSERT_CLOSED - the gate is currently closed * GATE_ASSERT_OPEN - the gate is currently opened * GATE_ASSERT_HELD - the gate is currently closed and the current thread is the holder */ extern void lck_mtx_gate_assert(lck_mtx_t *lock, gate_t *gate, gate_assert_flags_t flags); extern void lck_spin_assert( const lck_spin_t *lck, unsigned int type); #if CONFIG_PV_TICKET __startup_func extern void lck_init_pv(void); #endif #endif /* KERNEL_PRIVATE */ #if MACH_ASSERT #define LCK_SPIN_ASSERT(lck, type) MACH_ASSERT_DO(lck_spin_assert(lck, type)) #else /* !MACH_ASSERT */ #define LCK_SPIN_ASSERT(lck, type) #endif /* !MACH_ASSERT */ #if DEBUG #define LCK_SPIN_ASSERT_DEBUG(lck, type) lck_spin_assert((lck),(type)) #else /* DEBUG */ #define LCK_SPIN_ASSERT_DEBUG(lck, type) #endif /* DEBUG */ #define LCK_ASSERT_OWNED 1 #define LCK_ASSERT_NOTOWNED 2 #ifdef MACH_KERNEL_PRIVATE typedef struct lck_spinlock_to_info { void *lock; #if DEBUG || DEVELOPMENT uintptr_t owner_thread_orig; #endif /* DEBUG || DEVELOPMENT */ uintptr_t owner_thread_cur; int owner_cpu; uint32_t extra; } *lck_spinlock_to_info_t; extern volatile lck_spinlock_to_info_t lck_spinlock_timeout_in_progress; PERCPU_DECL(struct lck_spinlock_to_info, lck_spinlock_to_info); typedef struct lck_tktlock_pv_info { void *ltpi_lck; uint8_t ltpi_wt; } *lck_tktlock_pv_info_t; PERCPU_DECL(struct lck_tktlock_pv_info, lck_tktlock_pv_info); extern void lck_spinlock_timeout_set_orig_owner( uintptr_t owner); extern void lck_spinlock_timeout_set_orig_ctid( uint32_t ctid); extern lck_spinlock_to_info_t lck_spinlock_timeout_hit( void *lck, uintptr_t owner); #endif /* MACH_KERNEL_PRIVATE */ #if XNU_KERNEL_PRIVATE uintptr_t unslide_for_kdebug(const void* object) __pure2; struct lck_attr_startup_spec { lck_attr_t *lck_attr; uint32_t lck_attr_set_flags; uint32_t lck_attr_clear_flags; }; struct lck_spin_startup_spec { lck_spin_t *lck; lck_grp_t *lck_grp; lck_attr_t *lck_attr; }; struct lck_ticket_startup_spec { lck_ticket_t *lck; lck_grp_t *lck_grp; }; extern void lck_attr_startup_init( struct lck_attr_startup_spec *spec); extern void lck_spin_startup_init( struct lck_spin_startup_spec *spec); extern void lck_ticket_startup_init( struct lck_ticket_startup_spec *spec); /* * Auto-initializing locks declarations * ------------------------------------ * * Unless you need to configure your locks in very specific ways, * there is no point creating explicit lock attributes. For most * static locks, these declaration macros can be used: * * - LCK_SPIN_DECLARE for spinlocks, * - LCK_MTX_DECLARE for mutexes, * * For cases when some particular attributes need to be used, * these come in *_ATTR variants that take a variable declared with * LCK_ATTR_DECLARE as an argument. */ #define LCK_ATTR_DECLARE(var, set_flags, clear_flags) \ SECURITY_READ_ONLY_LATE(lck_attr_t) var; \ static __startup_data struct lck_attr_startup_spec \ __startup_lck_attr_spec_ ## var = { &var, set_flags, clear_flags }; \ STARTUP_ARG(LOCKS, STARTUP_RANK_SECOND, lck_attr_startup_init, \ &__startup_lck_attr_spec_ ## var) #define LCK_SPIN_DECLARE_ATTR(var, grp, attr) \ lck_spin_t var; \ static __startup_data struct lck_spin_startup_spec \ __startup_lck_spin_spec_ ## var = { &var, grp, attr }; \ STARTUP_ARG(LOCKS, STARTUP_RANK_FOURTH, lck_spin_startup_init, \ &__startup_lck_spin_spec_ ## var) #define LCK_SPIN_DECLARE(var, grp) \ LCK_SPIN_DECLARE_ATTR(var, grp, LCK_ATTR_NULL) #define LCK_TICKET_DECLARE(var, grp) \ lck_ticket_t var; \ static __startup_data struct lck_ticket_startup_spec \ __startup_lck_ticket_spec_ ## var = { &var, grp }; \ STARTUP_ARG(LOCKS, STARTUP_RANK_FOURTH, lck_ticket_startup_init, \ &__startup_lck_ticket_spec_ ## var) #endif /* XNU_KERNEL_PRIVATE */ __END_DECLS #endif /* _KERN_LOCKS_H_ */ |