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 | #include <stdio.h> #include <signal.h> #include <sys/proc.h> #include <sys/sysctl.h> #include <sys/kern_memorystatus.h> #include <sys/kern_memorystatus_freeze.h> #include <time.h> #include <mach-o/dyld.h> #include <mach/mach_vm.h> #include <mach/vm_page_size.h> /* Needed for vm_region info */ #include <mach/shared_region.h> #include <mach/mach.h> #ifdef T_NAMESPACE #undef T_NAMESPACE #endif #include <darwintest.h> #include <darwintest_utils.h> #include "memorystatus_assertion_helpers.h" T_GLOBAL_META( T_META_NAMESPACE("xnu.vm"), T_META_CHECK_LEAKS(false) ); #define MEM_SIZE_MB 10 #define NUM_ITERATIONS 5 #define FREEZE_PAGES_MAX 256 #define CREATE_LIST(X) \ X(SUCCESS) \ X(TOO_FEW_ARGUMENTS) \ X(SYSCTL_VM_PAGESIZE_FAILED) \ X(VM_PAGESIZE_IS_ZERO) \ X(DISPATCH_SOURCE_CREATE_FAILED) \ X(INITIAL_SIGNAL_TO_PARENT_FAILED) \ X(SIGNAL_TO_PARENT_FAILED) \ X(MEMORYSTATUS_CONTROL_FAILED) \ X(IS_FREEZABLE_NOT_AS_EXPECTED) \ X(MEMSTAT_PRIORITY_CHANGE_FAILED) \ X(INVALID_ALLOCATE_PAGES_ARGUMENTS) \ X(FROZEN_BIT_SET) \ X(FROZEN_BIT_NOT_SET) \ X(MEMORYSTATUS_CONTROL_ERROR) \ X(EXIT_CODE_MAX) \ #define EXIT_CODES_ENUM(VAR) VAR, enum exit_codes_num { CREATE_LIST(EXIT_CODES_ENUM) }; #define EXIT_CODES_STRING(VAR) #VAR, static const char *exit_codes_str[] = { CREATE_LIST(EXIT_CODES_STRING) }; static int get_vmpage_size() { int vmpage_size; size_t size = sizeof(vmpage_size); int ret = sysctlbyname("vm.pagesize", &vmpage_size, &size, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "failed to query vm.pagesize"); T_QUIET; T_ASSERT_GT(vmpage_size, 0, "vm.pagesize is not > 0"); return vmpage_size; } static pid_t child_pid = -1; static int freeze_count = 0; void move_to_idle_band(pid_t); void run_freezer_test(int); void freeze_helper_process(void); /* Gets and optionally sets the freeze pages max threshold */ int sysctl_freeze_pages_max(int* new_value); /* NB: in_shared_region and get_rprvt are pulled from the memorystatus unit test. * We're moving away from those unit tests, so they're copied here. */ /* Cribbed from 'top'... */ static int in_shared_region(mach_vm_address_t addr, cpu_type_t type) { mach_vm_address_t base = 0, size = 0; switch (type) { case CPU_TYPE_ARM: base = SHARED_REGION_BASE_ARM; size = SHARED_REGION_SIZE_ARM; break; case CPU_TYPE_ARM64: base = SHARED_REGION_BASE_ARM64; size = SHARED_REGION_SIZE_ARM64; break; case CPU_TYPE_X86_64: base = SHARED_REGION_BASE_X86_64; size = SHARED_REGION_SIZE_X86_64; break; case CPU_TYPE_I386: base = SHARED_REGION_BASE_I386; size = SHARED_REGION_SIZE_I386; break; case CPU_TYPE_POWERPC: base = SHARED_REGION_BASE_PPC; size = SHARED_REGION_SIZE_PPC; break; case CPU_TYPE_POWERPC64: base = SHARED_REGION_BASE_PPC64; size = SHARED_REGION_SIZE_PPC64; break; default: { int t = type; fprintf(stderr, "unknown CPU type: 0x%x\n", t); abort(); } } return addr >= base && addr < (base + size); } /* Get the resident private memory of the given pid */ static unsigned long long get_rprvt(pid_t pid) { mach_port_name_t task; kern_return_t kr; mach_vm_size_t rprvt = 0; mach_vm_size_t empty = 0; mach_vm_size_t fw_private = 0; mach_vm_size_t pagesize = vm_kernel_page_size; // The vm_region page info is reported // in terms of vm_kernel_page_size. mach_vm_size_t regs = 0; mach_vm_address_t addr; mach_vm_size_t size; int split = 0; kr = task_for_pid(mach_task_self(), pid, &task); T_QUIET; T_ASSERT_TRUE(kr == KERN_SUCCESS, "Unable to get task_for_pid of child"); for (addr = 0;; addr += size) { vm_region_top_info_data_t info; mach_msg_type_number_t count = VM_REGION_TOP_INFO_COUNT; mach_port_t object_name; kr = mach_vm_region(task, &addr, &size, VM_REGION_TOP_INFO, (vm_region_info_t)&info, &count, &object_name); if (kr != KERN_SUCCESS) { break; } #if defined (__arm64__) if (in_shared_region(addr, CPU_TYPE_ARM64)) { #else if (in_shared_region(addr, CPU_TYPE_ARM)) { #endif // Private Shared fw_private += info.private_pages_resident * pagesize; /* * Check if this process has the globally shared * text and data regions mapped in. If so, set * split to TRUE and avoid checking * again. */ if (split == FALSE && info.share_mode == SM_EMPTY) { vm_region_basic_info_data_64_t b_info; mach_vm_address_t b_addr = addr; mach_vm_size_t b_size = size; count = VM_REGION_BASIC_INFO_COUNT_64; kr = mach_vm_region(task, &b_addr, &b_size, VM_REGION_BASIC_INFO_64, (vm_region_info_t)&b_info, &count, &object_name); if (kr != KERN_SUCCESS) { break; } if (b_info.reserved) { split = TRUE; } } /* * Short circuit the loop if this isn't a shared * private region, since that's the only region * type we care about within the current address * range. */ if (info.share_mode != SM_PRIVATE) { continue; } } regs++; /* * Update counters according to the region type. */ if (info.share_mode == SM_COW && info.ref_count == 1) { // Treat single reference SM_COW as SM_PRIVATE info.share_mode = SM_PRIVATE; } switch (info.share_mode) { case SM_LARGE_PAGE: // Treat SM_LARGE_PAGE the same as SM_PRIVATE // since they are not shareable and are wired. case SM_PRIVATE: rprvt += info.private_pages_resident * pagesize; rprvt += info.shared_pages_resident * pagesize; break; case SM_EMPTY: empty += size; break; case SM_COW: case SM_SHARED: if (pid == 0) { // Treat kernel_task specially if (info.share_mode == SM_COW) { rprvt += info.private_pages_resident * pagesize; } break; } if (info.share_mode == SM_COW) { rprvt += info.private_pages_resident * pagesize; } break; default: assert(0); break; } } return rprvt; } void move_to_idle_band(pid_t pid) { memorystatus_priority_properties_t props; /* * Freezing a process also moves it to an elevated jetsam band in order to protect it from idle exits. * So we move the child process to the idle band to mirror the typical 'idle app being frozen' scenario. */ props.priority = JETSAM_PRIORITY_IDLE; props.user_data = 0; /* * This requires us to run as root (in the absence of entitlement). * Hence the T_META_ASROOT(true) in the T_HELPER_DECL. */ if (memorystatus_control(MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES, pid, 0, &props, sizeof(props))) { exit(MEMSTAT_PRIORITY_CHANGE_FAILED); } } void freeze_helper_process(void) { size_t length; int ret, freeze_enabled, errno_freeze_sysctl; uint64_t resident_memory_before, resident_memory_after, vmpage_size; vmpage_size = (uint64_t) get_vmpage_size(); resident_memory_before = get_rprvt(child_pid) / vmpage_size; T_LOG("Freezing child pid %d", child_pid); ret = sysctlbyname("kern.memorystatus_freeze", NULL, NULL, &child_pid, sizeof(child_pid)); errno_freeze_sysctl = errno; sleep(1); /* * The child process toggles its freezable state on each iteration. * So a failure for every alternate freeze is expected. */ if (freeze_count % 2) { length = sizeof(freeze_enabled); T_QUIET; T_ASSERT_POSIX_SUCCESS(sysctlbyname("vm.freeze_enabled", &freeze_enabled, &length, NULL, 0), "failed to query vm.freeze_enabled"); if (freeze_enabled) { errno = errno_freeze_sysctl; T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "sysctl kern.memorystatus_freeze failed"); } else { /* If freezer is disabled, skip the test. This can happen due to disk space shortage. */ T_LOG("Freeze has been disabled. Terminating early."); T_END; } resident_memory_after = get_rprvt(child_pid) / vmpage_size; uint64_t freeze_pages_max = (uint64_t) sysctl_freeze_pages_max(NULL); T_QUIET; T_ASSERT_LT(resident_memory_after, resident_memory_before, "Freeze didn't reduce resident memory set"); if (resident_memory_before > freeze_pages_max) { T_QUIET; T_ASSERT_LE(resident_memory_before - resident_memory_after, freeze_pages_max, "Freeze pages froze more than the threshold."); } ret = sysctlbyname("kern.memorystatus_thaw", NULL, NULL, &child_pid, sizeof(child_pid)); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "sysctl kern.memorystatus_thaw failed"); } else { T_QUIET; T_ASSERT_TRUE(ret != KERN_SUCCESS, "Freeze should have failed"); T_LOG("Freeze failed as expected"); } freeze_count++; T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGUSR1), "failed to send SIGUSR1 to child process"); } static void skip_if_freezer_is_disabled() { int freeze_enabled; size_t length = sizeof(freeze_enabled); T_QUIET; T_ASSERT_POSIX_SUCCESS(sysctlbyname("vm.freeze_enabled", &freeze_enabled, &length, NULL, 0), "failed to query vm.freeze_enabled"); if (!freeze_enabled) { /* If freezer is disabled, skip the test. This can happen due to disk space shortage. */ T_SKIP("Freeze has been disabled. Skipping test."); } } void run_freezer_test(int num_pages) { int ret; char sz_str[50]; char **launch_tool_args; char testpath[PATH_MAX]; uint32_t testpath_buf_size; dispatch_source_t ds_freeze, ds_proc; skip_if_freezer_is_disabled(); signal(SIGUSR1, SIG_IGN); ds_freeze = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, dispatch_get_main_queue()); T_QUIET; T_ASSERT_NOTNULL(ds_freeze, "dispatch_source_create (ds_freeze)"); dispatch_source_set_event_handler(ds_freeze, ^{ if (freeze_count < NUM_ITERATIONS) { freeze_helper_process(); } else { kill(child_pid, SIGKILL); dispatch_source_cancel(ds_freeze); } }); dispatch_activate(ds_freeze); testpath_buf_size = sizeof(testpath); ret = _NSGetExecutablePath(testpath, &testpath_buf_size); T_QUIET; T_ASSERT_POSIX_ZERO(ret, "_NSGetExecutablePath"); T_LOG("Executable path: %s", testpath); sprintf(sz_str, "%d", num_pages); launch_tool_args = (char *[]){ testpath, "-n", "allocate_pages", "--", sz_str, NULL }; /* Spawn the child process. Suspend after launch until the exit proc handler has been set up. */ ret = dt_launch_tool(&child_pid, launch_tool_args, true, NULL, NULL); if (ret != 0) { T_LOG("dt_launch tool returned %d with error code %d", ret, errno); } T_QUIET; T_ASSERT_POSIX_SUCCESS(child_pid, "dt_launch_tool"); ds_proc = dispatch_source_create(DISPATCH_SOURCE_TYPE_PROC, (uintptr_t)child_pid, DISPATCH_PROC_EXIT, dispatch_get_main_queue()); T_QUIET; T_ASSERT_NOTNULL(ds_proc, "dispatch_source_create (ds_proc)"); dispatch_source_set_event_handler(ds_proc, ^{ int status = 0, code = 0; pid_t rc = waitpid(child_pid, &status, 0); T_QUIET; T_ASSERT_EQ(rc, child_pid, "waitpid"); code = WEXITSTATUS(status); if (code == 0) { T_END; } else if (code > 0 && code < EXIT_CODE_MAX) { T_ASSERT_FAIL("Child exited with %s", exit_codes_str[code]); } else { T_ASSERT_FAIL("Child exited with unknown exit code %d", code); } }); dispatch_activate(ds_proc); T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGCONT), "failed to send SIGCONT to child process"); dispatch_main(); } static void allocate_pages(int num_pages) { int i, j, vmpgsize; char val; __block int num_iter = 0; __block char **buf; dispatch_source_t ds_signal; vmpgsize = get_vmpage_size(); if (num_pages < 1) { printf("Invalid number of pages to allocate: %d\n", num_pages); exit(INVALID_ALLOCATE_PAGES_ARGUMENTS); } buf = (char**)malloc(sizeof(char*) * (size_t)num_pages); /* Gives us the compression ratio we see in the typical case (~2.7) */ for (j = 0; j < num_pages; j++) { buf[j] = (char*)malloc((size_t)vmpgsize * sizeof(char)); val = 0; for (i = 0; i < vmpgsize; i += 16) { memset(&buf[j][i], val, 16); if (i < 3400 * (vmpgsize / 4096)) { val++; } } } dispatch_after(dispatch_time(DISPATCH_TIME_NOW, NSEC_PER_SEC), dispatch_get_main_queue(), ^{ /* Signal to the parent that we're done allocating and it's ok to freeze us */ printf("[%d] Sending initial signal to parent to begin freezing\n", getpid()); if (kill(getppid(), SIGUSR1) != 0) { exit(INITIAL_SIGNAL_TO_PARENT_FAILED); } }); signal(SIGUSR1, SIG_IGN); ds_signal = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, dispatch_get_main_queue()); if (ds_signal == NULL) { exit(DISPATCH_SOURCE_CREATE_FAILED); } dispatch_source_set_event_handler(ds_signal, ^{ int current_state, new_state; volatile int tmp; /* Make sure all the pages are accessed before trying to freeze again */ for (int x = 0; x < num_pages; x++) { tmp = buf[x][0]; } current_state = memorystatus_control(MEMORYSTATUS_CMD_GET_PROCESS_IS_FREEZABLE, getpid(), 0, NULL, 0); /* Sysprocs start off as unfreezable. Verify that first. */ if (num_iter == 0 && current_state != 0) { exit(IS_FREEZABLE_NOT_AS_EXPECTED); } /* Toggle freezable state */ new_state = (current_state) ? 0: 1; printf("[%d] Changing state from %s to %s\n", getpid(), (current_state) ? "freezable": "unfreezable", (new_state) ? "freezable": "unfreezable"); if (memorystatus_control(MEMORYSTATUS_CMD_SET_PROCESS_IS_FREEZABLE, getpid(), (uint32_t)new_state, NULL, 0) != KERN_SUCCESS) { exit(MEMORYSTATUS_CONTROL_FAILED); } /* Verify that the state has been set correctly */ current_state = memorystatus_control(MEMORYSTATUS_CMD_GET_PROCESS_IS_FREEZABLE, getpid(), 0, NULL, 0); if (new_state != current_state) { exit(IS_FREEZABLE_NOT_AS_EXPECTED); } num_iter++; if (kill(getppid(), SIGUSR1) != 0) { exit(SIGNAL_TO_PARENT_FAILED); } }); dispatch_activate(ds_signal); move_to_idle_band(getpid()); dispatch_main(); } T_HELPER_DECL(allocate_pages, "allocates pages to freeze", T_META_ASROOT(true)) { if (argc < 1) { exit(TOO_FEW_ARGUMENTS); } int num_pages = atoi(argv[0]); allocate_pages(num_pages); } T_DECL(freeze, "VM freezer test", T_META_ASROOT(true)) { run_freezer_test( (MEM_SIZE_MB << 20) / get_vmpage_size()); } static int old_freeze_pages_max = 0; static void reset_freeze_pages_max() { if (old_freeze_pages_max != 0) { sysctl_freeze_pages_max(&old_freeze_pages_max); } } int sysctl_freeze_pages_max(int* new_value) { static int set_end_handler = false; int freeze_pages_max, ret; size_t size = sizeof(freeze_pages_max); ret = sysctlbyname("kern.memorystatus_freeze_pages_max", &freeze_pages_max, &size, new_value, size); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "Unable to query kern.memorystatus_freeze_pages_max"); if (!set_end_handler) { // Save the original value and instruct darwintest to restore it after the test completes old_freeze_pages_max = freeze_pages_max; T_ATEND(reset_freeze_pages_max); set_end_handler = true; } return old_freeze_pages_max; } T_DECL(freeze_over_max_threshold, "Max Freeze Threshold is Enforced", T_META_ASROOT(true)) { int freeze_pages_max = FREEZE_PAGES_MAX; sysctl_freeze_pages_max(&freeze_pages_max); run_freezer_test(FREEZE_PAGES_MAX * 2); } T_HELPER_DECL(frozen_background, "Frozen background process", T_META_ASROOT(true)) { kern_return_t kern_ret; /* Set the process to freezable */ kern_ret = memorystatus_control(MEMORYSTATUS_CMD_SET_PROCESS_IS_FREEZABLE, getpid(), 1, NULL, 0); T_QUIET; T_ASSERT_EQ(kern_ret, KERN_SUCCESS, "set process is freezable"); /* Signal to our parent that we can be frozen */ if (kill(getppid(), SIGUSR1) != 0) { T_LOG("Unable to signal to parent process!"); exit(1); } while (1) { ; } } /* Launches the frozen_background helper as a managed process. */ static pid_t launch_background_helper(const char* variant) { pid_t pid; char **launch_tool_args; char testpath[PATH_MAX]; char *variant_cpy = strdup(variant); uint32_t testpath_buf_size; int ret; testpath_buf_size = sizeof(testpath); ret = _NSGetExecutablePath(testpath, &testpath_buf_size); printf("Launching %s\n", testpath); launch_tool_args = (char *[]){ testpath, "-n", variant_cpy, NULL }; ret = dt_launch_tool(&pid, launch_tool_args, false, NULL, NULL); if (ret != 0) { T_LOG("dt_launch tool returned %d with error code %d", ret, errno); } T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "dt_launch_tool"); /* Set the process's managed bit, so that the kernel treats this process like an app instead of a sysproc. */ ret = memorystatus_control(MEMORYSTATUS_CMD_SET_PROCESS_IS_MANAGED, pid, 1, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "memorystatus_control"); free(variant_cpy); return pid; } static void freeze_process(pid_t pid) { int ret, freeze_enabled, errno_freeze_sysctl; size_t length; T_LOG("Freezing pid %d", pid); ret = sysctlbyname("kern.memorystatus_freeze", NULL, NULL, &pid, sizeof(pid)); errno_freeze_sysctl = errno; length = sizeof(freeze_enabled); T_QUIET; T_ASSERT_POSIX_SUCCESS(sysctlbyname("vm.freeze_enabled", &freeze_enabled, &length, NULL, 0), "failed to query vm.freeze_enabled"); if (freeze_enabled) { errno = errno_freeze_sysctl; T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "sysctl kern.memorystatus_freeze failed"); } else { /* If freezer is disabled, skip the test. This can happen due to disk space shortage. */ T_LOG("Freeze has been disabled. Terminating early."); T_END; } } static void memorystatus_assertion_test_demote_frozen() { /* * Test that if we assert a priority on a process, freeze it, and then demote all frozen processes, it does not get demoted below the asserted priority. * Then remove thee assertion, and ensure it gets demoted properly. */ /* these values will remain fixed during testing */ int active_limit_mb = 15; /* arbitrary */ int inactive_limit_mb = 7; /* arbitrary */ __block int demote_value = 1; /* Launch the child process, and elevate its priority */ int requestedpriority; dispatch_source_t ds_signal, ds_exit; requestedpriority = JETSAM_PRIORITY_UI_SUPPORT; /* Wait for the child process to tell us that it's ready, and then freeze it */ signal(SIGUSR1, SIG_IGN); ds_signal = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, dispatch_get_main_queue()); T_QUIET; T_ASSERT_NOTNULL(ds_signal, "dispatch_source_create"); dispatch_source_set_event_handler(ds_signal, ^{ int sysctl_ret; /* Freeze the process, trigger agressive demotion, and check that it hasn't been demoted. */ freeze_process(child_pid); /* Agressive demotion */ sysctl_ret = sysctlbyname("kern.memorystatus_demote_frozen_processes", NULL, NULL, &demote_value, sizeof(demote_value)); T_QUIET; T_ASSERT_POSIX_SUCCESS(sysctl_ret, "sysctl kern.memorystatus_demote_frozen_processes succeeded"); /* Check */ (void)check_properties(child_pid, requestedpriority, inactive_limit_mb, 0x0, ASSERTION_STATE_IS_SET, "Priority was set"); T_LOG("Relinquishing our assertion."); /* Relinquish our assertion, and check that it gets demoted. */ relinquish_assertion_priority(child_pid, 0x0); (void)check_properties(child_pid, JETSAM_PRIORITY_AGING_BAND2, inactive_limit_mb, 0x0, ASSERTION_STATE_IS_RELINQUISHED, "Assertion was reqlinquished."); /* Kill the child */ T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGKILL), "Killed child process"); T_END; }); /* Launch the child process and set the initial properties on it. */ child_pid = launch_background_helper("frozen_background"); set_memlimits(child_pid, active_limit_mb, inactive_limit_mb, false, false); set_assertion_priority(child_pid, requestedpriority, 0x0); (void)check_properties(child_pid, requestedpriority, inactive_limit_mb, 0x0, ASSERTION_STATE_IS_SET, "Priority was set"); /* Listen for exit. */ ds_exit = dispatch_source_create(DISPATCH_SOURCE_TYPE_PROC, (uintptr_t)child_pid, DISPATCH_PROC_EXIT, dispatch_get_main_queue()); dispatch_source_set_event_handler(ds_exit, ^{ int status = 0, code = 0; pid_t rc = waitpid(child_pid, &status, 0); T_QUIET; T_ASSERT_EQ(rc, child_pid, "waitpid"); code = WEXITSTATUS(status); T_QUIET; T_ASSERT_EQ(code, 0, "Child exited cleanly"); T_END; }); dispatch_activate(ds_exit); dispatch_activate(ds_signal); dispatch_main(); } T_DECL(assertion_test_demote_frozen, "demoted frozen process goes to asserted priority.", T_META_ASROOT(true)) { memorystatus_assertion_test_demote_frozen(); } T_DECL(budget_replenishment, "budget replenishes properly") { size_t length; int ret; static unsigned int kTestIntervalSecs = 60 * 60 * 32; // 32 Hours unsigned int memorystatus_freeze_daily_mb_max, memorystatus_freeze_daily_pages_max; static unsigned int kFixedPointFactor = 100; static unsigned int kNumSecondsInDay = 60 * 60 * 24; unsigned int new_budget, expected_new_budget_pages; size_t new_budget_ln; unsigned int page_size = (unsigned int) get_vmpage_size(); /* * Calculate a new budget as if the previous interval expired kTestIntervalSecs * ago and we used up its entire budget. */ length = sizeof(kTestIntervalSecs); new_budget_ln = sizeof(new_budget); ret = sysctlbyname("vm.memorystatus_freeze_calculate_new_budget", &new_budget, &new_budget_ln, &kTestIntervalSecs, length); T_ASSERT_POSIX_SUCCESS(ret, "vm.memorystatus_freeze_calculate_new_budget"); // Grab the daily budget. length = sizeof(memorystatus_freeze_daily_mb_max); ret = sysctlbyname("kern.memorystatus_freeze_daily_mb_max", &memorystatus_freeze_daily_mb_max, &length, NULL, 0); T_ASSERT_POSIX_SUCCESS(ret, "kern.memorystatus_freeze_daily_mb_max"); memorystatus_freeze_daily_pages_max = memorystatus_freeze_daily_mb_max * 1024UL * 1024UL / page_size; T_LOG("memorystatus_freeze_daily_mb_max %u", memorystatus_freeze_daily_mb_max); T_LOG("memorystatus_freeze_daily_pages_max %u", memorystatus_freeze_daily_pages_max); T_LOG("page_size %u", page_size); /* * We're kTestIntervalSecs past a new interval. Which means we are owed kNumSecondsInDay * seconds of budget. */ expected_new_budget_pages = memorystatus_freeze_daily_pages_max; T_LOG("expected_new_budget_pages before %u", expected_new_budget_pages); T_ASSERT_EQ(kTestIntervalSecs, 60 * 60 * 32, "kTestIntervalSecs did not change"); expected_new_budget_pages += ((kTestIntervalSecs * kFixedPointFactor) / (kNumSecondsInDay) * memorystatus_freeze_daily_pages_max) / kFixedPointFactor; T_LOG("expected_new_budget_pages after %u", expected_new_budget_pages); T_LOG("memorystatus_freeze_daily_pages_max after %u", memorystatus_freeze_daily_pages_max); T_QUIET; T_ASSERT_EQ(new_budget, expected_new_budget_pages, "Calculate new budget behaves correctly."); } static bool is_proc_in_frozen_list(pid_t pid, char* name, size_t name_len) { int bytes_written; bool found = false; global_frozen_procs_t *frozen_procs = malloc(sizeof(global_frozen_procs_t)); T_QUIET; T_ASSERT_NOTNULL(frozen_procs, "malloc"); bytes_written = memorystatus_control(MEMORYSTATUS_CMD_FREEZER_CONTROL, 0, FREEZER_CONTROL_GET_PROCS, frozen_procs, sizeof(global_frozen_procs_t)); T_QUIET; T_ASSERT_LE((size_t) bytes_written, sizeof(global_frozen_procs_t), "Didn't overflow buffer"); T_QUIET; T_ASSERT_GT(bytes_written, 0, "Wrote someting"); for (size_t i = 0; i < frozen_procs->gfp_num_frozen; i++) { if (frozen_procs->gfp_procs[i].fp_pid == pid) { found = true; strlcpy(name, frozen_procs->gfp_procs[i].fp_name, name_len); } } return found; } static void unset_testing_pid(void) { int ret; ret = memorystatus_control(MEMORYSTATUS_CMD_SET_TESTING_PID, 0, MEMORYSTATUS_FLAGS_UNSET_TESTING_PID, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, 0, "Drop ownership of jetsam snapshot"); } static void set_testing_pid(void) { int ret; ret = memorystatus_control(MEMORYSTATUS_CMD_SET_TESTING_PID, 0, MEMORYSTATUS_FLAGS_SET_TESTING_PID, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "Take ownership of jetsam snapshot"); T_ATEND(unset_testing_pid); } /* * Retrieve a jetsam snapshot. * * return: * pointer to snapshot. * * Caller is responsible for freeing snapshot. */ static memorystatus_jetsam_snapshot_t * get_jetsam_snapshot(uint32_t flags, bool empty_allowed) { memorystatus_jetsam_snapshot_t * snapshot = NULL; int ret; uint32_t size; ret = memorystatus_control(MEMORYSTATUS_CMD_GET_JETSAM_SNAPSHOT, 0, flags, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, 0, "Get jetsam snapshot size"); size = (uint32_t) ret; if (size == 0 && empty_allowed) { return snapshot; } snapshot = (memorystatus_jetsam_snapshot_t*)malloc(size); T_QUIET; T_ASSERT_NOTNULL(snapshot, "Allocate snapshot of size %d", size); ret = memorystatus_control(MEMORYSTATUS_CMD_GET_JETSAM_SNAPSHOT, 0, flags, snapshot, size); T_QUIET; T_ASSERT_GT(size, 0, "Get jetsam snapshot"); if (((size - sizeof(memorystatus_jetsam_snapshot_t)) / sizeof(memorystatus_jetsam_snapshot_entry_t)) != snapshot->entry_count) { T_FAIL("Malformed snapshot: %d! Expected %ld + %zd x %ld = %ld\n", size, sizeof(memorystatus_jetsam_snapshot_t), snapshot->entry_count, sizeof(memorystatus_jetsam_snapshot_entry_t), sizeof(memorystatus_jetsam_snapshot_t) + (snapshot->entry_count * sizeof(memorystatus_jetsam_snapshot_entry_t))); if (snapshot) { free(snapshot); } } return snapshot; } /* * Look for the given pid in the snapshot. * * return: * pointer to pid's entry or NULL if pid is not found. * * Caller has ownership of snapshot before and after call. */ static memorystatus_jetsam_snapshot_entry_t * get_jetsam_snapshot_entry(memorystatus_jetsam_snapshot_t *snapshot, pid_t pid) { T_QUIET; T_ASSERT_NOTNULL(snapshot, "Got snapshot"); for (size_t i = 0; i < snapshot->entry_count; i++) { memorystatus_jetsam_snapshot_entry_t *curr = &(snapshot->entries[i]); if (curr->pid == pid) { return curr; } } return NULL; } static dispatch_source_t run_block_after_signal(int sig, dispatch_block_t block) { dispatch_source_t ds_signal; signal(sig, SIG_IGN); ds_signal = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, (uintptr_t) sig, 0, dispatch_get_main_queue()); T_QUIET; T_ASSERT_NOTNULL(ds_signal, "dispatch_source_create"); dispatch_source_set_event_handler(ds_signal, block); return ds_signal; } /* * Launches the child & runs the given block after the child signals. * If exit_with_child is true, the test will exit when the child exits. */ static void test_after_background_helper_launches(bool exit_with_child, const char* variant, dispatch_block_t test_block) { dispatch_source_t ds_signal, ds_exit; ds_signal = run_block_after_signal(SIGUSR1, test_block); /* Launch the child process. */ child_pid = launch_background_helper(variant); /* Listen for exit. */ if (exit_with_child) { ds_exit = dispatch_source_create(DISPATCH_SOURCE_TYPE_PROC, (uintptr_t)child_pid, DISPATCH_PROC_EXIT, dispatch_get_main_queue()); dispatch_source_set_event_handler(ds_exit, ^{ int status = 0, code = 0; pid_t rc = waitpid(child_pid, &status, 0); T_QUIET; T_ASSERT_EQ(rc, child_pid, "waitpid"); code = WEXITSTATUS(status); if (code != 0) { T_LOG("Child exited with error: %s", exit_codes_str[code]); } T_QUIET; T_ASSERT_EQ(code, 0, "Child exited cleanly"); T_END; }); dispatch_activate(ds_exit); } dispatch_activate(ds_signal); } T_DECL(get_frozen_procs, "List processes in the freezer") { skip_if_freezer_is_disabled(); test_after_background_helper_launches(true, "frozen_background", ^{ proc_name_t name; /* Place the child in the idle band so that it gets elevated like a typical app. */ move_to_idle_band(child_pid); /* Freeze the process, and check that it's in the list of frozen processes. */ freeze_process(child_pid); /* Check */ T_QUIET; T_ASSERT_TRUE(is_proc_in_frozen_list(child_pid, name, sizeof(name)), "Found proc in frozen list"); T_QUIET; T_EXPECT_EQ_STR(name, "memorystatus_freeze_test", "Proc has correct name"); /* Kill the child */ T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGKILL), "Killed child process"); T_END; }); dispatch_main(); } T_DECL(frozen_to_swap_accounting, "jetsam snapshot has frozen_to_swap accounting") { static const size_t kSnapshotSleepDelay = 5; static const size_t kFreezeToDiskMaxDelay = 60; skip_if_freezer_is_disabled(); test_after_background_helper_launches(true, "frozen_background", ^{ memorystatus_jetsam_snapshot_t *snapshot = NULL; memorystatus_jetsam_snapshot_entry_t *child_entry = NULL; /* Place the child in the idle band so that it gets elevated like a typical app. */ move_to_idle_band(child_pid); freeze_process(child_pid); /* * Wait until the child's pages get paged out to disk. * If we don't see any pages get sent to disk before kFreezeToDiskMaxDelay seconds, * something is either wrong with the compactor or the accounting. */ for (size_t i = 0; i < kFreezeToDiskMaxDelay / kSnapshotSleepDelay; i++) { snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND, false); child_entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_QUIET; T_ASSERT_NOTNULL(child_entry, "Found child in snapshot"); if (child_entry->jse_frozen_to_swap_pages > 0) { break; } free(snapshot); sleep(kSnapshotSleepDelay); } T_QUIET; T_ASSERT_GT(child_entry->jse_frozen_to_swap_pages, 0ULL, "child has some pages in swap"); free(snapshot); /* Kill the child */ T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGKILL), "Killed child process"); T_END; }); dispatch_main(); } T_DECL(freezer_snapshot, "App kills are recorded in the freezer snapshot") { /* Take ownership of the snapshot to ensure we don't race with another process trying to consume them. */ set_testing_pid(); test_after_background_helper_launches(false, "frozen_background", ^{ int ret; memorystatus_jetsam_snapshot_t *snapshot = NULL; memorystatus_jetsam_snapshot_entry_t *child_entry = NULL; ret = memorystatus_control(MEMORYSTATUS_CMD_TEST_JETSAM, child_pid, 0, 0, 0); T_ASSERT_POSIX_SUCCESS(ret, "jetsam'd the child"); snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_FREEZER, false); T_ASSERT_NOTNULL(snapshot, "Got freezer snapshot"); child_entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_QUIET; T_ASSERT_NOTNULL(child_entry, "Child is in freezer snapshot"); T_QUIET; T_ASSERT_EQ(child_entry->killed, (unsigned long long) JETSAM_REASON_GENERIC, "Child entry was killed"); free(snapshot); T_END; }); dispatch_main(); } T_DECL(freezer_snapshot_consume, "Freezer snapshot is consumed on read") { /* Take ownership of the snapshot to ensure we don't race with another process trying to consume them. */ set_testing_pid(); test_after_background_helper_launches(false, "frozen_background", ^{ int ret; memorystatus_jetsam_snapshot_t *snapshot = NULL; memorystatus_jetsam_snapshot_entry_t *child_entry = NULL; ret = memorystatus_control(MEMORYSTATUS_CMD_TEST_JETSAM, child_pid, 0, 0, 0); T_ASSERT_POSIX_SUCCESS(ret, "jetsam'd the child"); snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_FREEZER, false); T_ASSERT_NOTNULL(snapshot, "Got first freezer snapshot"); child_entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_QUIET; T_ASSERT_NOTNULL(child_entry, "Child is in first freezer snapshot"); snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_FREEZER, true); if (snapshot != NULL) { child_entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_QUIET; T_ASSERT_NULL(child_entry, "Child is not in second freezer snapshot"); } free(snapshot); T_END; }); dispatch_main(); } T_DECL(freezer_snapshot_frozen_state, "Frozen state is recorded in freezer snapshot") { skip_if_freezer_is_disabled(); /* Take ownership of the snapshot to ensure we don't race with another process trying to consume them. */ set_testing_pid(); test_after_background_helper_launches(false, "frozen_background", ^{ int ret; memorystatus_jetsam_snapshot_t *snapshot = NULL; memorystatus_jetsam_snapshot_entry_t *child_entry = NULL; move_to_idle_band(child_pid); freeze_process(child_pid); ret = memorystatus_control(MEMORYSTATUS_CMD_TEST_JETSAM, child_pid, 0, 0, 0); T_ASSERT_POSIX_SUCCESS(ret, "jetsam'd the child"); snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_FREEZER, false); T_ASSERT_NOTNULL(snapshot, "Got freezer snapshot"); child_entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_QUIET; T_ASSERT_NOTNULL(child_entry, "Child is in freezer snapshot"); T_QUIET; T_ASSERT_TRUE(child_entry->state & kMemorystatusFrozen, "Child entry's frozen bit is set"); free(snapshot); T_END; }); dispatch_main(); } T_DECL(freezer_snapshot_thaw_state, "Thaw count is recorded in freezer snapshot") { skip_if_freezer_is_disabled(); /* Take ownership of the snapshot to ensure we don't race with another process trying to consume them. */ set_testing_pid(); test_after_background_helper_launches(false, "frozen_background", ^{ int ret; memorystatus_jetsam_snapshot_t *snapshot = NULL; memorystatus_jetsam_snapshot_entry_t *child_entry = NULL; move_to_idle_band(child_pid); ret = pid_suspend(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); freeze_process(child_pid); ret = pid_resume(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child resumed after freeze"); ret = memorystatus_control(MEMORYSTATUS_CMD_TEST_JETSAM, child_pid, 0, 0, 0); T_ASSERT_POSIX_SUCCESS(ret, "jetsam'd the child"); snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_FREEZER, false); T_ASSERT_NOTNULL(snapshot, "Got freezer snapshot"); child_entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_QUIET; T_ASSERT_NOTNULL(child_entry, "Child is in freezer snapshot"); T_QUIET; T_ASSERT_TRUE(child_entry->state & kMemorystatusFrozen, "Child entry's frozen bit is still set after thaw"); T_QUIET; T_ASSERT_TRUE(child_entry->state & kMemorystatusWasThawed, "Child entry was thawed"); T_QUIET; T_ASSERT_EQ(child_entry->jse_thaw_count, 1ULL, "Child entry's thaw count was incremented"); free(snapshot); T_END; }); } T_HELPER_DECL(check_frozen, "Check frozen state", T_META_ASROOT(true)) { int kern_ret; dispatch_source_t ds_signal; __block int is_frozen; /* Set the process to freezable */ kern_ret = memorystatus_control(MEMORYSTATUS_CMD_SET_PROCESS_IS_FREEZABLE, getpid(), 1, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(kern_ret, "set process is freezable"); /* We should not be frozen yet. */ is_frozen = memorystatus_control(MEMORYSTATUS_CMD_GET_PROCESS_IS_FROZEN, getpid(), 0, NULL, 0); if (is_frozen == -1) { T_LOG("memorystatus_control error: %s", strerror(errno)); exit(MEMORYSTATUS_CONTROL_ERROR); } if (is_frozen) { exit(FROZEN_BIT_SET); } ds_signal = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, dispatch_get_main_queue()); if (ds_signal == NULL) { exit(DISPATCH_SOURCE_CREATE_FAILED); } dispatch_source_set_event_handler(ds_signal, ^{ /* We should now be frozen. */ is_frozen = memorystatus_control(MEMORYSTATUS_CMD_GET_PROCESS_IS_FROZEN, getpid(), 0, NULL, 0); if (is_frozen == -1) { T_LOG("memorystatus_control error: %s", strerror(errno)); exit(MEMORYSTATUS_CONTROL_ERROR); } if (!is_frozen) { exit(FROZEN_BIT_NOT_SET); } exit(SUCCESS); }); dispatch_activate(ds_signal); sig_t sig_ret = signal(SIGUSR1, SIG_IGN); T_QUIET; T_WITH_ERRNO; T_ASSERT_NE(sig_ret, SIG_ERR, "signal(SIGUSR1, SIG_IGN)"); /* Signal to our parent that we can be frozen */ if (kill(getppid(), SIGUSR1) != 0) { T_LOG("Unable to signal to parent process!"); exit(SIGNAL_TO_PARENT_FAILED); } dispatch_main(); } T_DECL(memorystatus_get_process_is_frozen, "MEMORYSTATUS_CMD_GET_PROCESS_IS_FROZEN returns correct state") { skip_if_freezer_is_disabled(); test_after_background_helper_launches(true, "check_frozen", ^{ int ret; /* Freeze the child, resume it, and signal it to check its state */ move_to_idle_band(child_pid); ret = pid_suspend(child_pid); T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); freeze_process(child_pid); ret = pid_resume(child_pid); T_ASSERT_POSIX_SUCCESS(ret, "child resumed after freeze"); kill(child_pid, SIGUSR1); /* The child will checks its own frozen state & exit. */ }); dispatch_main(); } static unsigned int freeze_pages_min_old; static int throttle_enabled_old; static void cleanup_memorystatus_freeze_top_process() { sysctlbyname("kern.memorystatus_freeze_pages_min", NULL, NULL, &freeze_pages_min_old, sizeof(freeze_pages_min_old)); sysctlbyname("kern.memorystatus_freeze_throttle_enabled", NULL, NULL, &throttle_enabled_old, sizeof(throttle_enabled_old)); } #define P_MEMSTAT_FROZEN 0x00000002 T_DECL(memorystatus_freeze_top_process, "memorystatus_freeze_top_process chooses the correct process", T_META_ASROOT(true), T_META_REQUIRES_SYSCTL_EQ("kern.development", 1), T_META_REQUIRES_SYSCTL_EQ("vm.freeze_enabled", 1)) { int32_t memorystatus_freeze_band = 0; size_t memorystatus_freeze_band_size = sizeof(memorystatus_freeze_band); size_t freeze_pages_min_size = sizeof(freeze_pages_min_old); unsigned int freeze_pages_min_new = 0; size_t throttle_enabled_old_size = sizeof(throttle_enabled_old); int throttle_enabled_new = 1; __block errno_t ret; __block int maxproc; size_t maxproc_size = sizeof(maxproc); ret = sysctlbyname("kern.maxproc", &maxproc, &maxproc_size, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "kern.maxproc"); sysctlbyname("kern.memorystatus_freeze_jetsam_band", &memorystatus_freeze_band, &memorystatus_freeze_band_size, NULL, 0); /* Set min pages to 0 and disable the budget to ensure we can always freeze the child. */ ret = sysctlbyname("kern.memorystatus_freeze_pages_min", &freeze_pages_min_old, &freeze_pages_min_size, &freeze_pages_min_new, sizeof(freeze_pages_min_new)); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "set kern.memorystatus_freeze_pages_min"); ret = sysctlbyname("kern.memorystatus_freeze_throttle_enabled", &throttle_enabled_old, &throttle_enabled_old_size, &throttle_enabled_new, sizeof(throttle_enabled_new)); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "set kern.memorystatus_freeze_throttle_enabled"); T_ATEND(cleanup_memorystatus_freeze_top_process); /* Take ownership of the freezer probabilities for the duration of the test so that we don't race with dasd. */ set_testing_pid(); test_after_background_helper_launches(true, "frozen_background", ^{ int32_t child_band = JETSAM_PRIORITY_DEFAULT; /* Place the child in the idle band so that it gets elevated like a typical app. */ move_to_idle_band(child_pid); ret = pid_suspend(child_pid); T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); size_t buffer_len = sizeof(memorystatus_properties_entry_v1_t) * (size_t) maxproc; memorystatus_properties_entry_v1_t *properties_list = malloc(buffer_len); T_QUIET; T_ASSERT_NOTNULL(properties_list, "malloc properties array"); size_t properties_list_len = 0; /* The child needs to age down into the idle band before it's eligible to be frozen. */ T_LOG("Waiting for child to age into the idle band."); while (child_band != JETSAM_PRIORITY_IDLE) { memset(properties_list, 0, buffer_len); properties_list_len = 0; memorystatus_jetsam_snapshot_t *snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND, false); bool found = false; for (size_t i = 0; i < snapshot->entry_count; i++) { memorystatus_jetsam_snapshot_entry_t *snapshot_entry = &snapshot->entries[i]; if (snapshot_entry->priority <= memorystatus_freeze_band && !snapshot_entry->killed) { pid_t pid = snapshot_entry->pid; memorystatus_properties_entry_v1_t *property_entry = &properties_list[properties_list_len++]; property_entry->version = 1; property_entry->pid = pid; if (pid == child_pid) { found = true; property_entry->use_probability = 1; child_band = snapshot_entry->priority; } else { property_entry->use_probability = 0; } strncpy(property_entry->proc_name, snapshot_entry->name, MAXCOMLEN); property_entry->proc_name[MAXCOMLEN] = '\0'; } } T_QUIET; T_ASSERT_TRUE(found, "Child is in on demand snapshot"); free(snapshot); } ret = memorystatus_control(MEMORYSTATUS_CMD_GRP_SET_PROPERTIES, 0, MEMORYSTATUS_FLAGS_GRP_SET_PROBABILITY, properties_list, sizeof(memorystatus_properties_entry_v1_t) * properties_list_len); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "MEMORYSTATUS_FLAGS_GRP_SET_PROBABILITY"); free(properties_list); int val = 1; ret = sysctlbyname("vm.memorystatus_freeze_top_process", NULL, NULL, &val, sizeof(val)); T_ASSERT_POSIX_SUCCESS(ret, "freeze_top_process"); /* Verify that the process was frozen. */ memorystatus_jetsam_snapshot_t *snapshot = get_jetsam_snapshot(MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND, false); memorystatus_jetsam_snapshot_entry_t *entry = get_jetsam_snapshot_entry(snapshot, child_pid); T_ASSERT_NOTNULL(entry, "child is in snapshot"); if (!(entry->state & P_MEMSTAT_FROZEN)) { T_LOG("Not frozen. Skip reason: %d", entry->jse_freeze_skip_reason); } T_ASSERT_TRUE(entry->state & P_MEMSTAT_FROZEN, "child is frozen"); free(snapshot); ret = pid_resume(child_pid); T_ASSERT_POSIX_SUCCESS(ret, "child resumed after freeze"); /* Kill the child */ T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGKILL), "Killed child process"); T_END; }); dispatch_main(); } static int memorystatus_freezer_thaw_percentage(void) { int val; size_t size = sizeof(val); int ret = sysctlbyname("kern.memorystatus_freezer_thaw_percentage", &val, &size, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "failed to query kern.memorystatus_freezer_thaw_percentage"); return val; } static void reset_interval(void) { uint32_t freeze_daily_budget_mb = 0; size_t size = sizeof(freeze_daily_budget_mb); int ret; uint64_t new_budget; ret = sysctlbyname("kern.memorystatus_freeze_daily_mb_max", &freeze_daily_budget_mb, &size, NULL, 0); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "failed to query kern.memorystatus_freeze_daily_mb_max"); new_budget = (freeze_daily_budget_mb * (1UL << 20) / vm_page_size); ret = sysctlbyname("kern.memorystatus_freeze_budget_pages_remaining", NULL, NULL, &new_budget, sizeof(new_budget)); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "failed to set kern.memorystatus_freeze_budget_pages_remaining"); } static pid_t second_child; static void cleanup_memorystatus_freezer_thaw_percentage(void) { kill(second_child, SIGKILL); } T_DECL(memorystatus_freezer_thaw_percentage, "memorystatus_freezer_thaw_percentage updates correctly", T_META_ASROOT(true), T_META_REQUIRES_SYSCTL_EQ("kern.development", 1), T_META_REQUIRES_SYSCTL_EQ("vm.freeze_enabled", 1)) { __block dispatch_source_t first_signal_block; /* Take ownership of the freezer probabilities for the duration of the test so that nothing new gets frozen by dasd. */ set_testing_pid(); reset_interval(); /* Spawn one child that will remain frozen throughout the whole test & another that will be thawed. */ first_signal_block = run_block_after_signal(SIGUSR1, ^{ move_to_idle_band(second_child); __block int ret = pid_suspend(second_child); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); freeze_process(second_child); T_QUIET; T_ASSERT_EQ(memorystatus_freezer_thaw_percentage(), 0, "thaw percentage is still 0 after freeze"); dispatch_source_cancel(first_signal_block); test_after_background_helper_launches(true, "frozen_background", ^{ reset_interval(); T_QUIET; T_ASSERT_EQ(memorystatus_freezer_thaw_percentage(), 0, "new interval starts with a thaw percentage of 0"); move_to_idle_band(child_pid); ret = pid_suspend(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); freeze_process(child_pid); ret = pid_resume(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child resumed after freeze"); int percentage_after_thaw = memorystatus_freezer_thaw_percentage(); T_QUIET; T_ASSERT_GT(percentage_after_thaw, 0, "thaw percentage is higher after thaw"); ret = pid_suspend(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); freeze_process(child_pid); ret = pid_resume(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child resumed after freeze"); T_QUIET; T_ASSERT_EQ(memorystatus_freezer_thaw_percentage(), percentage_after_thaw, "thaw percentage is unchanged after second thaw"); ret = pid_suspend(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child suspended"); freeze_process(child_pid); reset_interval(); T_QUIET; T_ASSERT_EQ(memorystatus_freezer_thaw_percentage(), 0, "new interval starts with a 0 thaw percentage"); ret = pid_resume(child_pid); T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "child resumed after freeze"); T_QUIET; T_ASSERT_GT(memorystatus_freezer_thaw_percentage(), 0, "thaw percentage goes back up in new interval"); T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(child_pid, SIGKILL), "failed to kill child"); T_END; }); }); second_child = launch_background_helper("frozen_background"); T_ATEND(cleanup_memorystatus_freezer_thaw_percentage); dispatch_activate(first_signal_block); dispatch_main(); } |