1 /* 2 * Copyright (c) 2006-2018 Apple Computer, 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 #ifndef SYS_MEMORYSTATUS_H 30 #define SYS_MEMORYSTATUS_H 31 32 #include <sys/time.h> 33 #include <mach_debug/zone_info.h> 34 #include <sys/proc.h> 35 #include <sys/reason.h> 36 37 #define MEMORYSTATUS_ENTITLEMENT "com.apple.private.memorystatus" 38 39 #define JETSAM_PRIORITY_REVISION 2 40 41 #define JETSAM_PRIORITY_IDLE_HEAD -2 42 /* The value -1 is an alias to JETSAM_PRIORITY_DEFAULT */ 43 #define JETSAM_PRIORITY_IDLE 0 44 #define JETSAM_PRIORITY_ENTITLED_MAX 9 /* Entitled processes may use bands 1-9 for experimentation */ 45 #define JETSAM_PRIORITY_IDLE_DEFERRED 10 /* Keeping this around till all xnu_quick_tests can be moved away from it.*/ 46 #define JETSAM_PRIORITY_AGING_BAND1 JETSAM_PRIORITY_IDLE_DEFERRED 47 #define JETSAM_PRIORITY_BACKGROUND_OPPORTUNISTIC 20 48 #define JETSAM_PRIORITY_AGING_BAND2 JETSAM_PRIORITY_BACKGROUND_OPPORTUNISTIC 49 #define JETSAM_PRIORITY_BACKGROUND 30 50 /* 51 * NB: This band is no longer used by mail, but IS used by many active 52 * processes doing background work. 53 */ 54 #define JETSAM_PRIORITY_MAIL 40 55 #define JETSAM_PRIORITY_ELEVATED_INACTIVE JETSAM_PRIORITY_MAIL 56 #define JETSAM_PRIORITY_PHONE 50 57 #define JETSAM_PRIORITY_FREEZER 75 58 #define JETSAM_PRIORITY_UI_SUPPORT 80 59 #define JETSAM_PRIORITY_FOREGROUND_SUPPORT 90 60 #define JETSAM_PRIORITY_FOREGROUND 100 61 #define JETSAM_PRIORITY_AUDIO_AND_ACCESSORY 120 62 #define JETSAM_PRIORITY_CONDUCTOR 130 63 #define JETSAM_PRIORITY_DRIVER_APPLE 150 64 #define JETSAM_PRIORITY_HOME 160 65 #define JETSAM_PRIORITY_EXECUTIVE 170 66 #define JETSAM_PRIORITY_IMPORTANT 180 67 #define JETSAM_PRIORITY_CRITICAL 190 68 69 #define JETSAM_PRIORITY_MAX 210 70 71 /* TODO - tune. This should probably be lower priority */ 72 #define JETSAM_PRIORITY_DEFAULT 180 73 #define JETSAM_PRIORITY_TELEPHONY 190 74 75 /* Compatibility */ 76 #define DEFAULT_JETSAM_PRIORITY 180 77 78 /* 79 * The deferral time used by default for apps and daemons in all aging 80 * policies except kJetsamAgingPolicySysProcsReclaimedFirst is 81 * DEFERRED_IDLE_EXIT_TIME_SECS. 82 * 83 * For kJetsamAgingPolicySysProcsReclaimedFirst, 84 * 85 * Daemons: The actual idle deferred time for the daemon is based on 86 * the relaunch behavior of the daemon. The relaunch behavior determines 87 * the scaling factor applied to DEFERRED_IDLE_EXIT_TIME_SECS. See 88 * kJetsamSysProcsIdleDelayTime* ratios defined in kern_memorystatus.c 89 * 90 * Apps: The apps are aged for DEFERRED_IDLE_EXIT_TIME_SECS factored 91 * by kJetsamAppsIdleDelayTimeRatio. 92 */ 93 #define DEFERRED_IDLE_EXIT_TIME_SECS 10 94 95 #define KEV_MEMORYSTATUS_SUBCLASS 3 96 97 enum { 98 kMemorystatusLevelNote = 1, 99 kMemorystatusSnapshotNote = 2, 100 kMemorystatusFreezeNote = 3, 101 kMemorystatusPressureNote = 4 102 }; 103 104 enum { 105 kMemorystatusLevelAny = -1, 106 kMemorystatusLevelNormal = 0, 107 kMemorystatusLevelWarning = 1, 108 kMemorystatusLevelUrgent = 2, 109 kMemorystatusLevelCritical = 3 110 }; 111 112 typedef struct memorystatus_priority_entry { 113 pid_t pid; 114 int32_t priority; 115 uint64_t user_data; 116 int32_t limit; /* MB */ 117 uint32_t state; 118 } memorystatus_priority_entry_t; 119 120 /* 121 * This should be the structure to specify different properties 122 * for processes (group or single) from user-space. Unfortunately, 123 * we can't move to it completely because the priority_entry structure 124 * above has been in use for a while now. We'll have to deprecate it. 125 * 126 * To support new fields/properties, we will add a new structure with a 127 * new version and a new size. 128 */ 129 #define MEMORYSTATUS_MPE_VERSION_1 1 130 131 #define MEMORYSTATUS_MPE_VERSION_1_SIZE sizeof(struct memorystatus_properties_entry_v1) 132 133 typedef struct memorystatus_properties_entry_v1 { 134 int version; 135 pid_t pid; 136 int32_t priority; 137 int use_probability; 138 uint64_t user_data; 139 int32_t limit; /* MB */ 140 uint32_t state; 141 char proc_name[MAXCOMLEN + 1]; 142 char __pad1[3]; 143 } memorystatus_properties_entry_v1_t; 144 145 /* 146 * Represents a freeze or demotion candidate. 147 */ 148 typedef struct memorystatus_properties_freeze_entry_v1 { 149 int version; 150 pid_t pid; 151 uint32_t priority; 152 char proc_name[(2 * MAXCOMLEN) + 1]; 153 char __pad1[3]; 154 } memorystatus_properties_freeze_entry_v1; 155 156 typedef struct memorystatus_kernel_stats { 157 uint32_t free_pages; 158 uint32_t active_pages; 159 uint32_t inactive_pages; 160 uint32_t throttled_pages; 161 uint32_t purgeable_pages; 162 uint32_t wired_pages; 163 uint32_t speculative_pages; 164 uint32_t filebacked_pages; 165 uint32_t anonymous_pages; 166 uint32_t compressor_pages; 167 uint64_t compressions; 168 uint64_t decompressions; 169 uint64_t total_uncompressed_pages_in_compressor; 170 uint64_t zone_map_size; 171 uint64_t zone_map_capacity; 172 uint64_t largest_zone_size; 173 char largest_zone_name[MACH_ZONE_NAME_MAX_LEN]; 174 } memorystatus_kernel_stats_t; 175 176 typedef enum memorystatus_freeze_skip_reason { 177 kMemorystatusFreezeSkipReasonNone = 0, 178 kMemorystatusFreezeSkipReasonExcessSharedMemory = 1, 179 kMemorystatusFreezeSkipReasonLowPrivateSharedRatio = 2, 180 kMemorystatusFreezeSkipReasonNoCompressorSpace = 3, 181 kMemorystatusFreezeSkipReasonNoSwapSpace = 4, 182 kMemorystatusFreezeSkipReasonBelowMinPages = 5, 183 kMemorystatusFreezeSkipReasonLowProbOfUse = 6, 184 kMemorystatusFreezeSkipReasonOther = 7, 185 kMemorystatusFreezeSkipReasonOutOfBudget = 8, 186 kMemorystatusFreezeSkipReasonOutOfSlots = 9, 187 kMemorystatusFreezeSkipReasonDisabled = 10, 188 kMemorystatusFreezeSkipReasonElevated = 11, 189 _kMemorystatusFreezeSkipReasonMax 190 } memorystatus_freeze_skip_reason_t; 191 /* 192 ** This is a variable-length struct. 193 ** Allocate a buffer of the size returned by the sysctl, cast to a memorystatus_snapshot_t * 194 */ 195 196 typedef struct jetsam_snapshot_entry { 197 pid_t pid; 198 char name[(2 * MAXCOMLEN) + 1]; 199 int32_t priority; 200 uint32_t state; 201 uint32_t fds; 202 memorystatus_freeze_skip_reason_t jse_freeze_skip_reason; /* why wasn't this process frozen? */ 203 uint8_t uuid[16]; 204 uint64_t user_data; 205 uint64_t killed; 206 uint64_t pages; 207 uint64_t max_pages_lifetime; 208 uint64_t purgeable_pages; 209 uint64_t jse_internal_pages; 210 uint64_t jse_internal_compressed_pages; 211 uint64_t jse_purgeable_nonvolatile_pages; 212 uint64_t jse_purgeable_nonvolatile_compressed_pages; 213 uint64_t jse_alternate_accounting_pages; 214 uint64_t jse_alternate_accounting_compressed_pages; 215 uint64_t jse_iokit_mapped_pages; 216 uint64_t jse_page_table_pages; 217 uint64_t jse_memory_region_count; 218 uint64_t jse_gencount; /* memorystatus_thread generation counter */ 219 uint64_t jse_starttime; /* absolute time when process starts */ 220 uint64_t jse_killtime; /* absolute time when jetsam chooses to kill a process */ 221 uint64_t jse_idle_delta; /* time spent in idle band */ 222 uint64_t jse_coalition_jetsam_id; /* we only expose coalition id for COALITION_TYPE_JETSAM */ 223 struct timeval64 cpu_time; 224 uint64_t jse_thaw_count; 225 uint64_t jse_frozen_to_swap_pages; 226 } memorystatus_jetsam_snapshot_entry_t; 227 228 typedef struct jetsam_snapshot { 229 uint64_t snapshot_time; /* absolute time snapshot was initialized */ 230 uint64_t notification_time; /* absolute time snapshot was consumed */ 231 uint64_t js_gencount; /* memorystatus_thread generation counter */ 232 memorystatus_kernel_stats_t stats; /* system stat when snapshot is initialized */ 233 size_t entry_count; 234 memorystatus_jetsam_snapshot_entry_t entries[]; 235 } memorystatus_jetsam_snapshot_t; 236 237 /* TODO - deprecate; see <rdar://problem/12969599> */ 238 #define kMaxSnapshotEntries 192 239 240 /* 241 * default jetsam snapshot support 242 */ 243 extern memorystatus_jetsam_snapshot_t *memorystatus_jetsam_snapshot; 244 extern memorystatus_jetsam_snapshot_t *memorystatus_jetsam_snapshot_copy; 245 #if CONFIG_FREEZE 246 extern memorystatus_jetsam_snapshot_t *memorystatus_jetsam_snapshot_freezer; 247 extern unsigned int memorystatus_jetsam_snapshot_freezer_max; 248 extern unsigned int memorystatus_jetsam_snapshot_freezer_size; 249 #endif /* CONFIG_FREEZE */ 250 extern unsigned int memorystatus_jetsam_snapshot_count; 251 extern unsigned int memorystatus_jetsam_snapshot_copy_count; 252 extern unsigned int memorystatus_jetsam_snapshot_max; 253 extern unsigned int memorystatus_jetsam_snapshot_size; 254 extern uint64_t memorystatus_jetsam_snapshot_last_timestamp; 255 extern uint64_t memorystatus_jetsam_snapshot_timeout; 256 #define memorystatus_jetsam_snapshot_list memorystatus_jetsam_snapshot->entries 257 #define JETSAM_SNAPSHOT_TIMEOUT_SECS 30 258 259 /* General memorystatus stuff */ 260 261 extern uint64_t memorystatus_sysprocs_idle_delay_time; 262 extern uint64_t memorystatus_apps_idle_delay_time; 263 264 /* State */ 265 #define kMemorystatusSuspended 0x01 266 #define kMemorystatusFrozen 0x02 267 #define kMemorystatusWasThawed 0x04 268 #define kMemorystatusTracked 0x08 269 #define kMemorystatusSupportsIdleExit 0x10 270 #define kMemorystatusDirty 0x20 271 #define kMemorystatusAssertion 0x40 272 273 /* 274 * Jetsam exit reason definitions - related to memorystatus 275 * 276 * When adding new exit reasons also update: 277 * JETSAM_REASON_MEMORYSTATUS_MAX 278 * kMemorystatusKilled... Cause enum 279 * memorystatus_kill_cause_name[] 280 */ 281 #define JETSAM_REASON_INVALID 0 282 #define JETSAM_REASON_GENERIC 1 283 #define JETSAM_REASON_MEMORY_HIGHWATER 2 284 #define JETSAM_REASON_VNODE 3 285 #define JETSAM_REASON_MEMORY_VMPAGESHORTAGE 4 286 #define JETSAM_REASON_MEMORY_PROCTHRASHING 5 287 #define JETSAM_REASON_MEMORY_FCTHRASHING 6 288 #define JETSAM_REASON_MEMORY_PERPROCESSLIMIT 7 289 #define JETSAM_REASON_MEMORY_DISK_SPACE_SHORTAGE 8 290 #define JETSAM_REASON_MEMORY_IDLE_EXIT 9 291 #define JETSAM_REASON_ZONE_MAP_EXHAUSTION 10 292 #define JETSAM_REASON_MEMORY_VMCOMPRESSOR_THRASHING 11 293 #define JETSAM_REASON_MEMORY_VMCOMPRESSOR_SPACE_SHORTAGE 12 294 #define JETSAM_REASON_LOWSWAP 13 295 #define JETSAM_REASON_MEMORY_SUSTAINED_PRESSURE 14 296 #define JETSAM_REASON_MEMORYSTATUS_MAX JETSAM_REASON_MEMORY_SUSTAINED_PRESSURE 297 298 /* 299 * Jetsam exit reason definitions - not related to memorystatus 300 */ 301 #define JETSAM_REASON_CPULIMIT 100 302 303 /* Cause */ 304 enum { 305 kMemorystatusInvalid = JETSAM_REASON_INVALID, 306 kMemorystatusKilled = JETSAM_REASON_GENERIC, 307 kMemorystatusKilledHiwat = JETSAM_REASON_MEMORY_HIGHWATER, 308 kMemorystatusKilledVnodes = JETSAM_REASON_VNODE, 309 kMemorystatusKilledVMPageShortage = JETSAM_REASON_MEMORY_VMPAGESHORTAGE, 310 kMemorystatusKilledProcThrashing = JETSAM_REASON_MEMORY_PROCTHRASHING, 311 kMemorystatusKilledFCThrashing = JETSAM_REASON_MEMORY_FCTHRASHING, 312 kMemorystatusKilledPerProcessLimit = JETSAM_REASON_MEMORY_PERPROCESSLIMIT, 313 kMemorystatusKilledDiskSpaceShortage = JETSAM_REASON_MEMORY_DISK_SPACE_SHORTAGE, 314 kMemorystatusKilledIdleExit = JETSAM_REASON_MEMORY_IDLE_EXIT, 315 kMemorystatusKilledZoneMapExhaustion = JETSAM_REASON_ZONE_MAP_EXHAUSTION, 316 kMemorystatusKilledVMCompressorThrashing = JETSAM_REASON_MEMORY_VMCOMPRESSOR_THRASHING, 317 kMemorystatusKilledVMCompressorSpaceShortage = JETSAM_REASON_MEMORY_VMCOMPRESSOR_SPACE_SHORTAGE, 318 kMemorystatusKilledLowSwap = JETSAM_REASON_LOWSWAP, 319 kMemorystatusKilledSustainedPressure = JETSAM_REASON_MEMORY_SUSTAINED_PRESSURE 320 }; 321 322 /* 323 * For backwards compatibility 324 * Keeping these around for external users (e.g. ReportCrash, Ariadne). 325 * TODO: Remove once they stop using these. 326 */ 327 #define kMemorystatusKilledDiagnostic kMemorystatusKilledDiskSpaceShortage 328 #define kMemorystatusKilledVMThrashing kMemorystatusKilledVMCompressorThrashing 329 #define JETSAM_REASON_MEMORY_VMTHRASHING JETSAM_REASON_MEMORY_VMCOMPRESSOR_THRASHING 330 331 /* Memorystatus control */ 332 #define MEMORYSTATUS_BUFFERSIZE_MAX 65536 333 334 #ifndef KERNEL 335 __BEGIN_DECLS 336 int memorystatus_get_level(user_addr_t level); 337 int memorystatus_control(uint32_t command, int32_t pid, uint32_t flags, void *buffer, size_t buffersize); 338 __END_DECLS 339 #endif 340 341 /* Commands */ 342 #define MEMORYSTATUS_CMD_GET_PRIORITY_LIST 1 343 #define MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES 2 344 #define MEMORYSTATUS_CMD_GET_JETSAM_SNAPSHOT 3 345 #define MEMORYSTATUS_CMD_GET_PRESSURE_STATUS 4 346 #define MEMORYSTATUS_CMD_SET_JETSAM_HIGH_WATER_MARK 5 /* Set active memory limit = inactive memory limit, both non-fatal */ 347 #define MEMORYSTATUS_CMD_SET_JETSAM_TASK_LIMIT 6 /* Set active memory limit = inactive memory limit, both fatal */ 348 #define MEMORYSTATUS_CMD_SET_MEMLIMIT_PROPERTIES 7 /* Set memory limits plus attributes independently */ 349 #define MEMORYSTATUS_CMD_GET_MEMLIMIT_PROPERTIES 8 /* Get memory limits plus attributes */ 350 #define MEMORYSTATUS_CMD_PRIVILEGED_LISTENER_ENABLE 9 /* Set the task's status as a privileged listener w.r.t memory notifications */ 351 #define MEMORYSTATUS_CMD_PRIVILEGED_LISTENER_DISABLE 10 /* Reset the task's status as a privileged listener w.r.t memory notifications */ 352 #define MEMORYSTATUS_CMD_AGGRESSIVE_JETSAM_LENIENT_MODE_ENABLE 11 /* Enable the 'lenient' mode for aggressive jetsam. See comments in kern_memorystatus.c near the top. */ 353 #define MEMORYSTATUS_CMD_AGGRESSIVE_JETSAM_LENIENT_MODE_DISABLE 12 /* Disable the 'lenient' mode for aggressive jetsam. */ 354 #define MEMORYSTATUS_CMD_GET_MEMLIMIT_EXCESS 13 /* Compute how much a process's phys_footprint exceeds inactive memory limit */ 355 #define MEMORYSTATUS_CMD_ELEVATED_INACTIVEJETSAMPRIORITY_ENABLE 14 /* Set the inactive jetsam band for a process to JETSAM_PRIORITY_ELEVATED_INACTIVE */ 356 #define MEMORYSTATUS_CMD_ELEVATED_INACTIVEJETSAMPRIORITY_DISABLE 15 /* Reset the inactive jetsam band for a process to the default band (0)*/ 357 #define MEMORYSTATUS_CMD_SET_PROCESS_IS_MANAGED 16 /* (Re-)Set state on a process that marks it as (un-)managed by a system entity e.g. assertiond */ 358 #define MEMORYSTATUS_CMD_GET_PROCESS_IS_MANAGED 17 /* Return the 'managed' status of a process */ 359 #define MEMORYSTATUS_CMD_SET_PROCESS_IS_FREEZABLE 18 /* Is the process eligible for freezing? Apps and extensions can pass in FALSE to opt out of freezing, i.e., 360 * if they would prefer being jetsam'ed in the idle band to being frozen in an elevated band. */ 361 #define MEMORYSTATUS_CMD_GET_PROCESS_IS_FREEZABLE 19 /* Return the freezable state of a process. */ 362 363 #define MEMORYSTATUS_CMD_FREEZER_CONTROL 20 364 365 #define MEMORYSTATUS_CMD_GET_AGGRESSIVE_JETSAM_LENIENT_MODE 21 /* Query if the lenient mode for aggressive jetsam is enabled. */ 366 367 #define MEMORYSTATUS_CMD_INCREASE_JETSAM_TASK_LIMIT 22 /* Used by DYLD to increase the jetsam active and inactive limits, when using roots */ 368 369 #if PRIVATE 370 #define MEMORYSTATUS_CMD_SET_TESTING_PID 23 /* Used by unit tests in the development kernel only. */ 371 #endif /* PRIVATE */ 372 373 #define MEMORYSTATUS_CMD_GET_PROCESS_IS_FROZEN 24 /* Check if the process is frozen. */ 374 375 #define MEMORYSTATUS_CMD_MARK_PROCESS_COALITION_SWAPPABLE 25 /* Set the coalition led by this process as swappable. This is a one-way transition. Swappable coalitions can never be made non-swappable. */ 376 #define MEMORYSTATUS_CMD_GET_PROCESS_COALITION_IS_SWAPPABLE 26 /* Get the swappable status for this process' coalition. */ 377 378 #define MEMORYSTATUS_CMD_CONVERT_MEMLIMIT_MB 28 /* Given a memlimit value (which may be 0 or -1), convert it to an actual limit in megabytes. */ 379 380 /* Commands that act on a group of processes */ 381 #define MEMORYSTATUS_CMD_GRP_SET_PROPERTIES 100 382 383 #if PRIVATE 384 /* Test commands */ 385 386 /* Trigger forced jetsam */ 387 #define MEMORYSTATUS_CMD_TEST_JETSAM 1000 388 #define MEMORYSTATUS_CMD_TEST_JETSAM_SORT 1001 389 390 /* Select priority band sort order */ 391 #define JETSAM_SORT_NOSORT 0 392 #define JETSAM_SORT_DEFAULT 1 393 394 #endif /* PRIVATE */ 395 396 /* memorystatus_control() flags */ 397 398 #define MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND 0x1 /* A populated snapshot buffer is returned on demand */ 399 #define MEMORYSTATUS_FLAGS_SNAPSHOT_AT_BOOT 0x2 /* Returns a snapshot with memstats collected at boot */ 400 #define MEMORYSTATUS_FLAGS_SNAPSHOT_COPY 0x4 /* No longer supported. Used to return the previously populated snapshot created by the system */ 401 #define MEMORYSTATUS_FLAGS_GRP_SET_PRIORITY 0x8 /* Set jetsam priorities for a group of pids */ 402 #define MEMORYSTATUS_FLAGS_GRP_SET_PROBABILITY 0x10 /* Set probability of use for a group of processes */ 403 404 #if PRIVATE 405 #define MEMORYSTATUS_FLAGS_SET_TESTING_PID 0x20 /* Only used by xnu unit tests. */ 406 #define MEMORYSTATUS_FLAGS_UNSET_TESTING_PID 0x40 /* Only used by xnu unit tests. */ 407 #endif /* PRIVATE */ 408 409 #define MEMORYSTATUS_FLAGS_SNAPSHOT_FREEZER 0x80 /* A snapshot buffer containing app kills since last consumption */ 410 411 #define MEMORYSTATUS_FLAGS_GRP_SET_FREEZE_PRIORITY 0x100 /* Set a new ordered list of freeze candidates */ 412 #define MEMORYSTATUS_FLAGS_GRP_SET_DEMOTE_PRIORITY 0x200 /* Set a new ordered list of demote candidates */ 413 /* 414 * For use with memorystatus_control: 415 * MEMORYSTATUS_CMD_GET_JETSAM_SNAPSHOT 416 * 417 * A jetsam snapshot is initialized when a non-idle 418 * jetsam event occurs. The data is held in the 419 * buffer until it is reaped. This is the default 420 * behavior. 421 * 422 * Flags change the default behavior: 423 * Demand mode - this is an on_demand snapshot, 424 * meaning data is populated upon request. 425 * 426 * Boot mode - this is a snapshot of 427 * memstats collected before loading the 428 * init program. Once collected, these 429 * stats do not change. In this mode, 430 * the snapshot entry_count is always 0. 431 * 432 * Copy mode - this returns the previous snapshot 433 * collected by the system. The current snaphshot 434 * might be only half populated. 435 * 436 * Snapshots are inherently racey between request 437 * for buffer size and actual data compilation. 438 */ 439 440 /* These definitions are required for backwards compatibility */ 441 #define MEMORYSTATUS_SNAPSHOT_ON_DEMAND MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND 442 #define MEMORYSTATUS_SNAPSHOT_AT_BOOT MEMORYSTATUS_FLAGS_SNAPSHOT_AT_BOOT 443 #define MEMORYSTATUS_SNAPSHOT_COPY MEMORYSTATUS_FLAGS_SNAPSHOT_COPY 444 445 /* 446 * For use with memorystatus_control: 447 * MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES 448 */ 449 typedef struct memorystatus_priority_properties { 450 int32_t priority; 451 uint64_t user_data; 452 } memorystatus_priority_properties_t; 453 454 /* 455 * Inform the kernel that setting the priority property is driven by assertions. 456 */ 457 #define MEMORYSTATUS_SET_PRIORITY_ASSERTION 0x1 458 459 /* 460 * For use with memorystatus_control: 461 * MEMORYSTATUS_CMD_SET_MEMLIMIT_PROPERTIES 462 * MEMORYSTATUS_CMD_GET_MEMLIMIT_PROPERTIES 463 */ 464 typedef struct memorystatus_memlimit_properties { 465 int32_t memlimit_active; /* jetsam memory limit (in MB) when process is active */ 466 uint32_t memlimit_active_attr; 467 int32_t memlimit_inactive; /* jetsam memory limit (in MB) when process is inactive */ 468 uint32_t memlimit_inactive_attr; 469 } memorystatus_memlimit_properties_t; 470 471 typedef struct memorystatus_memlimit_properties2 { 472 memorystatus_memlimit_properties_t v1; 473 uint32_t memlimit_increase; /* jetsam memory limit increase (in MB) for active and inactive states */ 474 uint32_t memlimit_increase_bytes; /* bytes used to determine the jetsam memory limit increase, for active and inactive states */ 475 } memorystatus_memlimit_properties2_t; 476 477 #define MEMORYSTATUS_MEMLIMIT_ATTR_FATAL 0x1 /* if set, exceeding the memlimit is fatal */ 478 479 #ifdef XNU_KERNEL_PRIVATE 480 481 /* 482 * A process will be killed immediately if it crosses a memory limit marked as fatal. 483 * Fatal limit types are the 484 * - default system-wide task limit 485 * - per-task custom memory limit 486 * 487 * A process with a non-fatal memory limit can exceed that limit, but becomes an early 488 * candidate for jetsam when the device is under memory pressure. 489 * Non-fatal limit types are the 490 * - high-water-mark limit 491 * 492 * Processes that opt into dirty tracking are evaluated 493 * based on clean vs dirty state. 494 * dirty ==> active 495 * clean ==> inactive 496 * 497 * Processes that do not opt into dirty tracking are 498 * evalulated based on priority level. 499 * Foreground or above ==> active 500 * Below Foreground ==> inactive 501 */ 502 503 /* 504 * p_memstat_state flag holds 505 * - in kernel process state and memlimit state 506 */ 507 508 #define P_MEMSTAT_SUSPENDED 0x00000001 /* Process is suspended and likely in the IDLE band */ 509 #define P_MEMSTAT_FROZEN 0x00000002 /* Process has some state on disk. It should be suspended */ 510 #define P_MEMSTAT_FREEZE_DISABLED 0x00000004 /* Process isn't freeze-eligible and will not be frozen */ 511 #define P_MEMSTAT_ERROR 0x00000008 /* Process couldn't be jetsammed for some reason. Transient state so jetsam can skip it next time it sees it */ 512 #define P_MEMSTAT_LOCKED 0x00000010 /* Process is being actively worked on behind the proc_list_lock */ 513 #define P_MEMSTAT_TERMINATED 0x00000020 /* Process is exiting */ 514 #define P_MEMSTAT_FREEZE_IGNORE 0x00000040 /* Process was evaluated by freezer and will be ignored till the next time it goes active and does something */ 515 #define P_MEMSTAT_PRIORITYUPDATED 0x00000080 /* Process had its jetsam priority updated */ 516 #define P_MEMSTAT_FOREGROUND 0x00000100 /* Process is in the FG jetsam band...unused??? */ 517 #define P_MEMSTAT_REFREEZE_ELIGIBLE 0x00000400 /* Process was once thawed i.e. its state was brought back from disk. It is now refreeze eligible.*/ 518 #define P_MEMSTAT_MANAGED 0x00000800 /* Process is managed by RunningBoard i.e. is either application or extension */ 519 #define P_MEMSTAT_INTERNAL 0x00001000 /* Process is a system-critical-not-be-jetsammed process i.e. launchd */ 520 #define P_MEMSTAT_FATAL_MEMLIMIT 0x00002000 /* current fatal state of the process's memlimit */ 521 #define P_MEMSTAT_MEMLIMIT_ACTIVE_FATAL 0x00004000 /* if set, exceeding limit is fatal when the process is active */ 522 #define P_MEMSTAT_MEMLIMIT_INACTIVE_FATAL 0x00008000 /* if set, exceeding limit is fatal when the process is inactive */ 523 #define P_MEMSTAT_USE_ELEVATED_INACTIVE_BAND 0x00010000 /* if set, the process will go into this band & stay there when in the background instead 524 * of the aging bands and/or the IDLE band. */ 525 #define P_MEMSTAT_PRIORITY_ASSERTION 0x00020000 /* jetsam priority is being driven by an assertion */ 526 #define P_MEMSTAT_FREEZE_CONSIDERED 0x00040000 /* This process has been considered for the freezer. */ 527 #define P_MEMSTAT_SKIP 0x00080000 /* Process is temporarily ineligible for memory pressure kills. Used only on development & debug kernels to make corpses of buggy processes */ 528 #define P_MEMSTAT_FROZEN_XPC_SERVICE 0x00100000 /* Process is an XPC service. Only used for freezer telemetry. */ 529 #define P_MEMSTAT_FROZEN_FOCAL_THAW 0x00200000 /* Process has been thawed while focal in the current freezer interval. Only used for freezer telemetry. */ 530 531 /* 532 * p_memstat_relaunch_flags holds 533 * - relaunch behavior when jetsammed 534 */ 535 #define P_MEMSTAT_RELAUNCH_UNKNOWN 0x0 536 #define P_MEMSTAT_RELAUNCH_LOW 0x1 537 #define P_MEMSTAT_RELAUNCH_MED 0x2 538 #define P_MEMSTAT_RELAUNCH_HIGH 0x4 539 540 /* 541 * Checking the p_memstat_state almost always requires the proc_list_lock 542 * because the jetsam thread could be on the other core changing the state. 543 * 544 * App -- almost always managed by a system process. Always have dirty tracking OFF. Can include extensions too. 545 * System Processes -- not managed by anybody. Always have dirty tracking ON. Can include extensions (here) too. 546 */ 547 #define isApp(p) ((p->p_memstat_state & P_MEMSTAT_MANAGED) || ! (p->p_memstat_dirty & P_DIRTY_TRACK)) 548 #define isSysProc(p) ( ! (p->p_memstat_state & P_MEMSTAT_MANAGED) || (p->p_memstat_dirty & P_DIRTY_TRACK)) 549 550 #define MEMSTAT_BUCKET_COUNT (JETSAM_PRIORITY_MAX + 1) 551 552 typedef struct memstat_bucket { 553 TAILQ_HEAD(, proc) list; 554 int count; 555 int relaunch_high_count; 556 } memstat_bucket_t; 557 558 extern memstat_bucket_t memstat_bucket[MEMSTAT_BUCKET_COUNT]; 559 560 /* 561 * Table that expresses the probability of a process 562 * being used in the next hour. 563 */ 564 typedef struct memorystatus_internal_probabilities { 565 char proc_name[MAXCOMLEN + 1]; 566 int use_probability; 567 } memorystatus_internal_probabilities_t; 568 569 extern memorystatus_internal_probabilities_t *memorystatus_global_probabilities_table; 570 extern size_t memorystatus_global_probabilities_size; 571 572 extern void memorystatus_init(void); 573 574 extern void memorystatus_init_at_boot_snapshot(void); 575 576 extern int memorystatus_add(proc_t p, boolean_t locked); 577 extern int memorystatus_update(proc_t p, int priority, uint64_t user_data, boolean_t is_assertion, boolean_t effective, 578 boolean_t update_memlimit, int32_t memlimit_active, boolean_t memlimit_active_is_fatal, 579 int32_t memlimit_inactive, boolean_t memlimit_inactive_is_fatal); 580 581 /* Remove this process from jetsam bands for killing or freezing. 582 * The proc_list_lock is held by the caller. 583 * @param p: The process to remove. 584 * @return: 0 if successful. EAGAIN if the process can't be removed right now (because it's being frozen) or ESRCH. 585 */ 586 extern int memorystatus_remove(proc_t p); 587 588 int memorystatus_update_inactive_jetsam_priority_band(pid_t pid, uint32_t opflags, int priority, boolean_t effective_now); 589 int memorystatus_relaunch_flags_update(proc_t p, int relaunch_flags); 590 591 extern int memorystatus_dirty_track(proc_t p, uint32_t pcontrol); 592 extern int memorystatus_dirty_set(proc_t p, boolean_t self, uint32_t pcontrol); 593 extern int memorystatus_dirty_get(proc_t p, boolean_t locked); 594 extern int memorystatus_dirty_clear(proc_t p, uint32_t pcontrol); 595 596 extern int memorystatus_on_terminate(proc_t p); 597 598 extern void memorystatus_on_suspend(proc_t p); 599 extern void memorystatus_on_resume(proc_t p); 600 extern void memorystatus_on_inactivity(proc_t p); 601 602 extern void memorystatus_on_pageout_scan_end(void); 603 604 /* Memorystatus kevent */ 605 606 void memorystatus_kevent_init(lck_grp_t *grp, lck_attr_t *attr); 607 608 int memorystatus_knote_register(struct knote *kn); 609 void memorystatus_knote_unregister(struct knote *kn); 610 611 #if CONFIG_MEMORYSTATUS 612 void memorystatus_log_exception(const int max_footprint_mb, boolean_t memlimit_is_active, boolean_t memlimit_is_fatal); 613 void memorystatus_on_ledger_footprint_exceeded(int warning, boolean_t memlimit_is_active, boolean_t memlimit_is_fatal); 614 void proc_memstat_skip(proc_t p, boolean_t set); 615 void memorystatus_proc_flags_unsafe(void * v, boolean_t *is_dirty, boolean_t *is_dirty_tracked, boolean_t *allow_idle_exit); 616 617 #if __arm64__ 618 void memorystatus_act_on_legacy_footprint_entitlement(proc_t p, boolean_t footprint_increase); 619 void memorystatus_act_on_ios13extended_footprint_entitlement(proc_t p); 620 void memorystatus_act_on_entitled_task_limit(proc_t p); 621 #endif /* __arm64__ */ 622 623 #endif /* CONFIG_MEMORYSTATUS */ 624 625 int memorystatus_get_pressure_status_kdp(void); 626 int memorystatus_get_proccnt_upto_priority(int32_t max_bucket_index); 627 628 #if CONFIG_JETSAM 629 630 typedef enum memorystatus_policy { 631 kPolicyDefault = 0x0, 632 kPolicyMoreFree = 0x1, 633 } memorystatus_policy_t; 634 extern unsigned int memorystatus_swap_all_apps; 635 636 /* 637 * Synchronous memorystatus kill calls. 638 */ 639 640 boolean_t memorystatus_kill_on_VM_page_shortage(void); 641 boolean_t memorystatus_kill_on_vnode_limit(void); 642 boolean_t memorystatus_kill_on_sustained_pressure(void); 643 644 /* 645 * Wake up the memorystatus thread so it can do async kills. 646 * The memorystatus thread will keep killing until the system is 647 * considered healthy. 648 */ 649 void memorystatus_thread_wake(void); 650 651 /* 652 * Attempt to kill the specified pid with the given reason. 653 * Consumes a reference on the jetsam_reason. 654 */ 655 boolean_t memorystatus_kill_with_jetsam_reason_sync(pid_t pid, os_reason_t jetsam_reason); 656 657 void jetsam_on_ledger_cpulimit_exceeded(void); 658 void memorystatus_fast_jetsam_override(boolean_t enable_override); 659 /* 660 * Disable memorystatus_swap_all_apps. 661 * Used by vm_pageout at boot if the swap volume is too small to support app swap. 662 * Returns true iff app swap is now disabled. 663 * On development or debug kernels, app swap can be enabled via a boot-arg and in 664 * that case can not be disabled. 665 */ 666 bool memorystatus_disable_swap(void); 667 668 #endif /* CONFIG_JETSAM */ 669 670 /* These are very verbose printfs(), enable with 671 * MEMORYSTATUS_DEBUG_LOG 672 */ 673 #if MEMORYSTATUS_DEBUG_LOG 674 #define MEMORYSTATUS_DEBUG(cond, format, ...) \ 675 do { \ 676 if (cond) { printf(format, ##__VA_ARGS__); } \ 677 } while(0) 678 #else 679 #define MEMORYSTATUS_DEBUG(cond, format, ...) 680 #endif 681 682 boolean_t memorystatus_kill_on_zone_map_exhaustion(pid_t pid); 683 boolean_t memorystatus_kill_on_VM_compressor_space_shortage(boolean_t async); 684 void memorystatus_pages_update(unsigned int pages_avail); 685 boolean_t memorystatus_idle_exit_from_VM(void); 686 proc_t memorystatus_get_first_proc_locked(unsigned int *bucket_index, boolean_t search); 687 proc_t memorystatus_get_next_proc_locked(unsigned int *bucket_index, proc_t p, boolean_t search); 688 void memorystatus_get_task_page_counts(task_t task, uint32_t *footprint, uint32_t *max_footprint_lifetime, uint32_t *purgeable_pages); 689 void memorystatus_invalidate_idle_demotion_locked(proc_t p, boolean_t clean_state); 690 void memorystatus_update_priority_locked(proc_t p, int priority, boolean_t head_insert, boolean_t skip_demotion_check); 691 692 bool memorystatus_task_has_increased_memory_limit_entitlement(task_t task); 693 bool memorystatus_task_has_legacy_footprint_entitlement(task_t task); 694 bool memorystatus_task_has_ios13extended_footprint_limit(task_t task); 695 696 #if VM_PRESSURE_EVENTS 697 698 extern kern_return_t memorystatus_update_vm_pressure(boolean_t); 699 700 #if CONFIG_MEMORYSTATUS 701 /* Flags */ 702 extern int memorystatus_low_mem_privileged_listener(uint32_t op_flags); 703 extern int memorystatus_send_pressure_note(int pid); 704 extern boolean_t memorystatus_is_foreground_locked(proc_t p); 705 extern boolean_t memorystatus_bg_pressure_eligible(proc_t p); 706 #endif /* CONFIG_MEMORYSTATUS */ 707 708 #endif /* VM_PRESSURE_EVENTS */ 709 710 #endif /* XNU_KERNEL_PRIVATE */ 711 712 #endif /* SYS_MEMORYSTATUS_H */ 713