tests/quiesce_counter.c

   1 /*
   2  * Copyright (c) 2018 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28
  29 /*
  30  * Test to validate that _COMM_PAGE_CPU_QUIESCENT_COUNTER ticks at least once per second
  31  *
  32  * <rdar://problem/42433973>
  33  */
  34
  35 #include <System/machine/cpu_capabilities.h>
  36
  37 #include <darwintest.h>
  38
  39 #include <stdio.h>
  40 #include <stdint.h>
  41 #include <unistd.h>
  42 #include <sys/sysctl.h>
  43
  44 T_GLOBAL_META(T_META_RUN_CONCURRENTLY(true));
  45
  46 #ifndef _COMM_PAGE_CPU_QUIESCENT_COUNTER
  47
  48 T_DECL(test_quiescent_counter, "Validate that _COMM_PAGE_CPU_QUIESCENT_COUNTER increments",
  49     T_META_CHECK_LEAKS(false))
  50 {
  51         T_SKIP("_COMM_PAGE_CPU_QUIESCENT_COUNTER doesn't exist on this system");
  52 }
  53
  54 #else /* _COMM_PAGE_CPU_QUIESCENT_COUNTER */
  55
  56 T_DECL(test_quiescent_counter, "Validate that _COMM_PAGE_CPU_QUIESCENT_COUNTER increments",
  57     T_META_CHECK_LEAKS(false))
  58 {
  59         int rv;
  60
  61         uint32_t cpu_checkin_min_interval = 0; /* set by sysctl hw.ncpu */
  62
  63         size_t value_size = sizeof(cpu_checkin_min_interval);
  64         rv = sysctlbyname("kern.cpu_checkin_interval", &cpu_checkin_min_interval, &value_size, NULL, 0);
  65         T_ASSERT_POSIX_SUCCESS(rv, "sysctlbyname(kern.cpu_checkin_interval)");
  66
  67         T_LOG("kern.cpu_checkin_interval is %d", cpu_checkin_min_interval);
  68
  69         T_ASSERT_GT(cpu_checkin_min_interval, 0, "kern.cpu_checkin_interval should be > 0");
  70
  71         uint64_t* commpage_addr = (uint64_t *)(uintptr_t)_COMM_PAGE_CPU_QUIESCENT_COUNTER;
  72
  73         T_LOG("address of _COMM_PAGE_CPU_QUIESCENT_COUNTER is %p", (void*) commpage_addr);
  74
  75         uint64_t counter = *commpage_addr;
  76         uint64_t last_counter = counter;
  77         T_LOG("first value of _COMM_PAGE_CPU_QUIESCENT_COUNTER is %llu", counter);
  78
  79         for (int i = 0; i < 10; i++) {
  80                 sleep(1);
  81
  82                 last_counter = counter;
  83                 counter = *commpage_addr;
  84
  85                 T_LOG("value of _COMM_PAGE_CPU_QUIESCENT_COUNTER is %llu", counter);
  86
  87                 T_ASSERT_GT(counter, last_counter, "_COMM_PAGE_CPU_QUIESCENT_COUNTER must monotonically increase at least once per second");
  88         }
  89 }
  90
  91 #endif /* _COMM_PAGE_CPU_QUIESCENT_COUNTER */