1 /*
2 * Copyright (c) 2000-2021 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 * Telemetry from the VM is usually colected at a daily cadence.
31 * All of those events are in this file along with a single thread
32 * call for reporting them.
33 *
34 * NB: The freezer subsystem has its own telemetry based on its budget interval
35 * so it's not included here.
36 */
37
38 #include <libkern/coreanalytics/coreanalytics.h>
39 #include "vm_compressor_backing_store.h"
40 #include <vm/vm_page.h>
41 #include <kern/thread_call.h>
42
43 void vm_analytics_tick(void *arg0, void *arg1);
44
45 #define ANALYTICS_PERIOD_HOURS (24ULL)
46
47 static thread_call_t vm_analytics_thread_call;
48
49 CA_EVENT(vm_swapusage,
50 CA_INT, max_alloced,
51 CA_INT, max_used,
52 CA_INT, trial_deployment_id,
53 CA_STATIC_STRING(CA_UUID_LEN), trial_treatment_id,
54 CA_STATIC_STRING(CA_UUID_LEN), trial_experiment_id);
55
56 CA_EVENT(mlock_failures,
57 CA_INT, over_global_limit,
58 CA_INT, over_user_limit,
59 CA_INT, trial_deployment_id,
60 CA_STATIC_STRING(CA_UUID_LEN), trial_treatment_id,
61 CA_STATIC_STRING(CA_UUID_LEN), trial_experiment_id);
62
63 /*
64 * NB: It's a good practice to include these trial
65 * identifiers in all of our events so that we can
66 * measure the impact of any A/B tests on these metrics.
67 */
68 extern uuid_string_t trial_treatment_id;
69 extern uuid_string_t trial_experiment_id;
70 extern int trial_deployment_id;
71
72 static void
add_trial_uuids(char * treatment_id,char * experiment_id)73 add_trial_uuids(char *treatment_id, char *experiment_id)
74 {
75 strlcpy(treatment_id, trial_treatment_id, CA_UUID_LEN);
76 strlcpy(experiment_id, trial_experiment_id, CA_UUID_LEN);
77 }
78
79 static void
report_vm_swapusage()80 report_vm_swapusage()
81 {
82 uint64_t max_alloced, max_used;
83 ca_event_t event = CA_EVENT_ALLOCATE(vm_swapusage);
84 CA_EVENT_TYPE(vm_swapusage) * e = event->data;
85
86 vm_swap_reset_max_segs_tracking(&max_alloced, &max_used);
87 e->max_alloced = max_alloced;
88 e->max_used = max_used;
89 add_trial_uuids(e->trial_treatment_id, e->trial_experiment_id);
90 e->trial_deployment_id = trial_deployment_id;
91 CA_EVENT_SEND(event);
92 }
93
94 static void
report_mlock_failures()95 report_mlock_failures()
96 {
97 ca_event_t event = CA_EVENT_ALLOCATE(mlock_failures);
98 CA_EVENT_TYPE(mlock_failures) * e = event->data;
99
100 e->over_global_limit = os_atomic_load_wide(&vm_add_wire_count_over_global_limit, relaxed);
101 e->over_user_limit = os_atomic_load_wide(&vm_add_wire_count_over_user_limit, relaxed);
102
103 os_atomic_store_wide(&vm_add_wire_count_over_global_limit, 0, relaxed);
104 os_atomic_store_wide(&vm_add_wire_count_over_user_limit, 0, relaxed);
105
106 add_trial_uuids(e->trial_treatment_id, e->trial_experiment_id);
107 e->trial_deployment_id = trial_deployment_id;
108 CA_EVENT_SEND(event);
109 }
110
111 static void
schedule_analytics_thread_call()112 schedule_analytics_thread_call()
113 {
114 static const uint64_t analytics_period_ns = ANALYTICS_PERIOD_HOURS * 60 * 60 * NSEC_PER_SEC;
115 uint64_t analytics_period_absolutetime;
116 nanoseconds_to_absolutetime(analytics_period_ns, &analytics_period_absolutetime);
117
118 thread_call_enter_delayed(vm_analytics_thread_call, analytics_period_absolutetime + mach_absolute_time());
119 }
120
121 /*
122 * This is the main entry point for reporting periodic analytics.
123 * It's called once every ANALYTICS_PERIOD_HOURS hours.
124 */
125 void
vm_analytics_tick(void * arg0,void * arg1)126 vm_analytics_tick(void *arg0, void *arg1)
127 {
128 #pragma unused(arg0, arg1)
129 report_vm_swapusage();
130 report_mlock_failures();
131 schedule_analytics_thread_call();
132 }
133
134 static void
vm_analytics_init()135 vm_analytics_init()
136 {
137 vm_analytics_thread_call = thread_call_allocate_with_options(vm_analytics_tick, NULL, THREAD_CALL_PRIORITY_KERNEL, THREAD_CALL_OPTIONS_ONCE);
138 schedule_analytics_thread_call();
139 }
140
141 STARTUP(THREAD_CALL, STARTUP_RANK_MIDDLE, vm_analytics_init);
142