X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/316670eb35587141e969394ae8537d66b9211e80..b226f5e54a60dc81db17b1260381d7dbfea3cdf1:/bsd/sys/kern_memorystatus.h diff --git a/bsd/sys/kern_memorystatus.h b/bsd/sys/kern_memorystatus.h index 66fabee01..c3f5cec27 100644 --- a/bsd/sys/kern_memorystatus.h +++ b/bsd/sys/kern_memorystatus.h @@ -1,5 +1,5 @@ /* - * Copyright (c) 2006 Apple Computer, Inc. All rights reserved. + * Copyright (c) 2006-2018 Apple Computer, Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ * @@ -33,36 +33,45 @@ #include #include #include - -#define DEFAULT_JETSAM_PRIORITY -100 - -enum { - kMemorystatusFlagsFrontmost = (1 << 0), - kMemorystatusFlagsKilled = (1 << 1), - kMemorystatusFlagsKilledHiwat = (1 << 2), - kMemorystatusFlagsFrozen = (1 << 3), - kMemorystatusFlagsKilledVnodes = (1 << 4), - kMemorystatusFlagsKilledSwap = (1 << 5), - kMemorystatusFlagsThawed = (1 << 6), - kMemorystatusFlagsKilledVM = (1 << 7), - kMemorystatusFlagsSuspForDiagnosis = (1 << 8), - kMemorystatusFlagsActive = (1 << 9), - kMemorystatusFlagsSupportsIdleExit = (1 << 10), - kMemorystatusFlagsDirty = (1 << 11) -}; - -#if TARGET_OS_EMBEDDED || CONFIG_EMBEDDED - -/* - * Define Memory Status event subclass. - * Subclass of KEV_SYSTEM_CLASS - */ - -/*! - @defined KEV_MEMORYSTATUS_SUBCLASS - @discussion The kernel event subclass for memory status events. -*/ -#define KEV_MEMORYSTATUS_SUBCLASS 3 +#include + +#define MEMORYSTATUS_ENTITLEMENT "com.apple.private.memorystatus" + +#define JETSAM_PRIORITY_REVISION 2 + +#define JETSAM_PRIORITY_IDLE_HEAD -2 +/* The value -1 is an alias to JETSAM_PRIORITY_DEFAULT */ +#define JETSAM_PRIORITY_IDLE 0 +#define JETSAM_PRIORITY_IDLE_DEFERRED 1 /* Keeping this around till all xnu_quick_tests can be moved away from it.*/ +#define JETSAM_PRIORITY_AGING_BAND1 JETSAM_PRIORITY_IDLE_DEFERRED +#define JETSAM_PRIORITY_BACKGROUND_OPPORTUNISTIC 2 +#define JETSAM_PRIORITY_AGING_BAND2 JETSAM_PRIORITY_BACKGROUND_OPPORTUNISTIC +#define JETSAM_PRIORITY_BACKGROUND 3 +#define JETSAM_PRIORITY_ELEVATED_INACTIVE JETSAM_PRIORITY_BACKGROUND +#define JETSAM_PRIORITY_MAIL 4 +#define JETSAM_PRIORITY_PHONE 5 +#define JETSAM_PRIORITY_UI_SUPPORT 8 +#define JETSAM_PRIORITY_FOREGROUND_SUPPORT 9 +#define JETSAM_PRIORITY_FOREGROUND 10 +#define JETSAM_PRIORITY_AUDIO_AND_ACCESSORY 12 +#define JETSAM_PRIORITY_CONDUCTOR 13 +#define JETSAM_PRIORITY_HOME 16 +#define JETSAM_PRIORITY_EXECUTIVE 17 +#define JETSAM_PRIORITY_IMPORTANT 18 +#define JETSAM_PRIORITY_CRITICAL 19 + +#define JETSAM_PRIORITY_MAX 21 + +/* TODO - tune. This should probably be lower priority */ +#define JETSAM_PRIORITY_DEFAULT 18 +#define JETSAM_PRIORITY_TELEPHONY 19 + +/* Compatibility */ +#define DEFAULT_JETSAM_PRIORITY 18 + +#define DEFERRED_IDLE_EXIT_TIME_SECS 10 + +#define KEV_MEMORYSTATUS_SUBCLASS 3 enum { kMemorystatusLevelNote = 1, @@ -81,18 +90,37 @@ enum { typedef struct memorystatus_priority_entry { pid_t pid; - uint32_t flags; - int32_t hiwat_pages; int32_t priority; - int32_t reserved; - int32_t reserved2; + uint64_t user_data; + int32_t limit; /* MB */ + uint32_t state; } memorystatus_priority_entry_t; /* -** how many processes to snapshot -*/ -#define kMaxSnapshotEntries 128 + * This should be the structure to specify different properties + * for processes (group or single) from user-space. Unfortunately, + * we can't move to it completely because the priority_entry structure + * above has been in use for a while now. We'll have to deprecate it. + * + * To support new fields/properties, we will add a new structure with a + * new version and a new size. + */ +#define MEMORYSTATUS_MPE_VERSION_1 1 + +#define MEMORYSTATUS_MPE_VERSION_1_SIZE sizeof(struct memorystatus_properties_entry_v1) +typedef struct memorystatus_properties_entry_v1 { + int version; + pid_t pid; + int32_t priority; + int use_probability; + uint64_t user_data; + int32_t limit; /* MB */ + uint32_t state; + char proc_name[MAXCOMLEN+1]; + char __pad1[3]; +} memorystatus_properties_entry_v1_t; + typedef struct memorystatus_kernel_stats { uint32_t free_pages; uint32_t active_pages; @@ -100,6 +128,17 @@ typedef struct memorystatus_kernel_stats { uint32_t throttled_pages; uint32_t purgeable_pages; uint32_t wired_pages; + uint32_t speculative_pages; + uint32_t filebacked_pages; + uint32_t anonymous_pages; + uint32_t compressor_pages; + uint64_t compressions; + uint64_t decompressions; + uint64_t total_uncompressed_pages_in_compressor; + uint64_t zone_map_size; + uint64_t zone_map_capacity; + uint64_t largest_zone_size; + char largest_zone_name[MACH_ZONE_NAME_MAX_LEN]; } memorystatus_kernel_stats_t; /* @@ -108,109 +147,329 @@ typedef struct memorystatus_kernel_stats { */ typedef struct jetsam_snapshot_entry { - pid_t pid; - char name[MAXCOMLEN+1]; - int32_t priority; - uint32_t pages; - uint32_t flags; - uint8_t uuid[16]; + pid_t pid; + char name[(2*MAXCOMLEN)+1]; + int32_t priority; + uint32_t state; + uint32_t fds; + uint8_t uuid[16]; + uint64_t user_data; + uint64_t killed; + uint64_t pages; + uint64_t max_pages_lifetime; + uint64_t purgeable_pages; + uint64_t jse_internal_pages; + uint64_t jse_internal_compressed_pages; + uint64_t jse_purgeable_nonvolatile_pages; + uint64_t jse_purgeable_nonvolatile_compressed_pages; + uint64_t jse_alternate_accounting_pages; + uint64_t jse_alternate_accounting_compressed_pages; + uint64_t jse_iokit_mapped_pages; + uint64_t jse_page_table_pages; + uint64_t jse_memory_region_count; + uint64_t jse_gencount; /* memorystatus_thread generation counter */ + uint64_t jse_starttime; /* absolute time when process starts */ + uint64_t jse_killtime; /* absolute time when jetsam chooses to kill a process */ + uint64_t jse_idle_delta; /* time spent in idle band */ + uint64_t jse_coalition_jetsam_id; /* we only expose coalition id for COALITION_TYPE_JETSAM */ + struct timeval64 cpu_time; + uint64_t jse_thaw_count; } memorystatus_jetsam_snapshot_entry_t; typedef struct jetsam_snapshot { - uint64_t snapshot_time; - uint64_t notification_time; - memorystatus_kernel_stats_t stats; + uint64_t snapshot_time; /* absolute time snapshot was initialized */ + uint64_t notification_time; /* absolute time snapshot was consumed */ + uint64_t js_gencount; /* memorystatus_thread generation counter */ + memorystatus_kernel_stats_t stats; /* system stat when snapshot is initialized */ size_t entry_count; - memorystatus_jetsam_snapshot_entry_t entries[1]; + memorystatus_jetsam_snapshot_entry_t entries[]; } memorystatus_jetsam_snapshot_t; -typedef memorystatus_priority_entry_t jetsam_priority_entry_t; -typedef memorystatus_jetsam_snapshot_t jetsam_snapshot_t; -typedef memorystatus_jetsam_snapshot_entry_t jetsam_snapshot_entry_t; - -#define kMemoryStatusLevelNote kMemorystatusLevelNote -#define kMemoryStatusSnapshotNote kMemorystatusSnapshotNote -#define kMemoryStatusFreezeNote kMemorystatusFreezeNote -#define kMemoryStatusPressureNote kMemorystatusPressureNote - typedef struct memorystatus_freeze_entry { int32_t pid; uint32_t flags; uint32_t pages; } memorystatus_freeze_entry_t; -#endif /* TARGET_OS_EMBEDDED */ - -#ifdef XNU_KERNEL_PRIVATE - -/* General tunables */ +/* TODO - deprecate; see */ +#define kMaxSnapshotEntries 192 -#define DELTA_PERCENT 5 -#define CRITICAL_PERCENT 5 -#define HIGHWATER_PERCENT 10 -#define PRESSURE_PERCENT 15 -#define FREEZE_PERCENT 50 +/* State */ +#define kMemorystatusSuspended 0x01 +#define kMemorystatusFrozen 0x02 +#define kMemorystatusWasThawed 0x04 +#define kMemorystatusTracked 0x08 +#define kMemorystatusSupportsIdleExit 0x10 +#define kMemorystatusDirty 0x20 -#define POLICY_MORE_FREE_OFFSET_PERCENT 5 -#define POLICY_DIAGNOSTIC_OFFSET_PERCENT 5 +/* + * Jetsam exit reason definitions - related to memorystatus + * + * When adding new exit reasons also update: + * JETSAM_REASON_MEMORYSTATUS_MAX + * kMemorystatusKilled... Cause enum + * memorystatus_kill_cause_name[] + */ +#define JETSAM_REASON_INVALID 0 +#define JETSAM_REASON_GENERIC 1 +#define JETSAM_REASON_MEMORY_HIGHWATER 2 +#define JETSAM_REASON_VNODE 3 +#define JETSAM_REASON_MEMORY_VMPAGESHORTAGE 4 +#define JETSAM_REASON_MEMORY_PROCTHRASHING 5 +#define JETSAM_REASON_MEMORY_FCTHRASHING 6 +#define JETSAM_REASON_MEMORY_PERPROCESSLIMIT 7 +#define JETSAM_REASON_MEMORY_DISK_SPACE_SHORTAGE 8 +#define JETSAM_REASON_MEMORY_IDLE_EXIT 9 +#define JETSAM_REASON_ZONE_MAP_EXHAUSTION 10 +#define JETSAM_REASON_MEMORY_VMCOMPRESSOR_THRASHING 11 +#define JETSAM_REASON_MEMORY_VMCOMPRESSOR_SPACE_SHORTAGE 12 + +#define JETSAM_REASON_MEMORYSTATUS_MAX JETSAM_REASON_MEMORY_VMCOMPRESSOR_SPACE_SHORTAGE -#define IDLE_EXIT_TIME_SECS 10 +/* + * Jetsam exit reason definitions - not related to memorystatus + */ +#define JETSAM_REASON_CPULIMIT 100 +/* Cause */ enum { - kProcessSuspended = (1 << 0), - kProcessFrozen = (1 << 1), - kProcessNoReclaimWorth = (1 << 2), - kProcessIgnored = (1 << 3), - kProcessLocked = (1 << 4), - kProcessKilled = (1 << 5), - kProcessNotifiedForPressure = (1 << 6), - kProcessPriorityUpdated = (1 << 7), - kProcessActive = (1 << 8), - kProcessForeground = (1 << 9), - kProcessSuspendedForDiag = (1 << 10), - kProcessSupportsIdleExit = (1 << 11), - kProcessDirty = (1 << 12), - kProcessIgnoreIdleExit = (1 << 13) + kMemorystatusInvalid = JETSAM_REASON_INVALID, + kMemorystatusKilled = JETSAM_REASON_GENERIC, + kMemorystatusKilledHiwat = JETSAM_REASON_MEMORY_HIGHWATER, + kMemorystatusKilledVnodes = JETSAM_REASON_VNODE, + kMemorystatusKilledVMPageShortage = JETSAM_REASON_MEMORY_VMPAGESHORTAGE, + kMemorystatusKilledProcThrashing = JETSAM_REASON_MEMORY_PROCTHRASHING, + kMemorystatusKilledFCThrashing = JETSAM_REASON_MEMORY_FCTHRASHING, + kMemorystatusKilledPerProcessLimit = JETSAM_REASON_MEMORY_PERPROCESSLIMIT, + kMemorystatusKilledDiskSpaceShortage = JETSAM_REASON_MEMORY_DISK_SPACE_SHORTAGE, + kMemorystatusKilledIdleExit = JETSAM_REASON_MEMORY_IDLE_EXIT, + kMemorystatusKilledZoneMapExhaustion = JETSAM_REASON_ZONE_MAP_EXHAUSTION, + kMemorystatusKilledVMCompressorThrashing = JETSAM_REASON_MEMORY_VMCOMPRESSOR_THRASHING, + kMemorystatusKilledVMCompressorSpaceShortage = JETSAM_REASON_MEMORY_VMCOMPRESSOR_SPACE_SHORTAGE, }; -typedef struct memorystatus_node { - TAILQ_ENTRY(memorystatus_node) link; - pid_t pid; - int32_t priority; - uint32_t state; -#if CONFIG_JETSAM - int32_t hiwat_pages; +/* For backwards compatibility */ +#define kMemorystatusKilledDiagnostic kMemorystatusKilledDiskSpaceShortage +#define kMemorystatusKilledVMThrashing kMemorystatusKilledVMCompressorThrashing +#define JETSAM_REASON_MEMORY_VMTHRASHING JETSAM_REASON_MEMORY_VMCOMPRESSOR_THRASHING + +/* Memorystatus control */ +#define MEMORYSTATUS_BUFFERSIZE_MAX 65536 + +#ifndef KERNEL +int memorystatus_get_level(user_addr_t level); +int memorystatus_control(uint32_t command, int32_t pid, uint32_t flags, void *buffer, size_t buffersize); #endif + +/* Commands */ +#define MEMORYSTATUS_CMD_GET_PRIORITY_LIST 1 +#define MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES 2 +#define MEMORYSTATUS_CMD_GET_JETSAM_SNAPSHOT 3 +#define MEMORYSTATUS_CMD_GET_PRESSURE_STATUS 4 +#define MEMORYSTATUS_CMD_SET_JETSAM_HIGH_WATER_MARK 5 /* Set active memory limit = inactive memory limit, both non-fatal */ +#define MEMORYSTATUS_CMD_SET_JETSAM_TASK_LIMIT 6 /* Set active memory limit = inactive memory limit, both fatal */ +#define MEMORYSTATUS_CMD_SET_MEMLIMIT_PROPERTIES 7 /* Set memory limits plus attributes independently */ +#define MEMORYSTATUS_CMD_GET_MEMLIMIT_PROPERTIES 8 /* Get memory limits plus attributes */ +#define MEMORYSTATUS_CMD_PRIVILEGED_LISTENER_ENABLE 9 /* Set the task's status as a privileged listener w.r.t memory notifications */ +#define MEMORYSTATUS_CMD_PRIVILEGED_LISTENER_DISABLE 10 /* Reset the task's status as a privileged listener w.r.t memory notifications */ +#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. */ +#define MEMORYSTATUS_CMD_AGGRESSIVE_JETSAM_LENIENT_MODE_DISABLE 12 /* Disable the 'lenient' mode for aggressive jetsam. */ +#define MEMORYSTATUS_CMD_GET_MEMLIMIT_EXCESS 13 /* Compute how much a process's phys_footprint exceeds inactive memory limit */ +#define MEMORYSTATUS_CMD_ELEVATED_INACTIVEJETSAMPRIORITY_ENABLE 14 /* Set the inactive jetsam band for a process to JETSAM_PRIORITY_ELEVATED_INACTIVE */ +#define MEMORYSTATUS_CMD_ELEVATED_INACTIVEJETSAMPRIORITY_DISABLE 15 /* Reset the inactive jetsam band for a process to the default band (0)*/ +#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 */ +#define MEMORYSTATUS_CMD_GET_PROCESS_IS_MANAGED 17 /* Return the 'managed' status of a process */ +#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., + if they would prefer being jetsam'ed in the idle band to being frozen in an elevated band. */ +#define MEMORYSTATUS_CMD_GET_PROCESS_IS_FREEZABLE 19 /* Return the freezable state of a process. */ + #if CONFIG_FREEZE - uint32_t resident_pages; -#endif - uint64_t clean_time; -} memorystatus_node; +#if DEVELOPMENT || DEBUG +#define MEMORYSTATUS_CMD_FREEZER_CONTROL 20 +#endif /* DEVELOPMENT || DEBUG */ +#endif /* CONFIG_FREEZE */ + +/* Commands that act on a group of processes */ +#define MEMORYSTATUS_CMD_GRP_SET_PROPERTIES 100 + +#if PRIVATE +/* Test commands */ + +/* Trigger forced jetsam */ +#define MEMORYSTATUS_CMD_TEST_JETSAM 1000 +#define MEMORYSTATUS_CMD_TEST_JETSAM_SORT 1001 + +/* Panic on jetsam options */ +typedef struct memorystatus_jetsam_panic_options { + uint32_t data; + uint32_t mask; +} memorystatus_jetsam_panic_options_t; -extern int memorystatus_wakeup; -extern unsigned int memorystatus_running; +#define MEMORYSTATUS_CMD_SET_JETSAM_PANIC_BITS 1002 -extern unsigned int memorystatus_available_pages; -extern unsigned int memorystatus_available_pages_critical; -extern unsigned int memorystatus_level; -extern unsigned int memorystatus_delta; +/* Select priority band sort order */ +#define JETSAM_SORT_NOSORT 0 +#define JETSAM_SORT_DEFAULT 1 + +#endif /* PRIVATE */ + +/* memorystatus_control() flags */ + +#define MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND 0x1 /* A populated snapshot buffer is returned on demand */ +#define MEMORYSTATUS_FLAGS_SNAPSHOT_AT_BOOT 0x2 /* Returns a snapshot with memstats collected at boot */ +#define MEMORYSTATUS_FLAGS_SNAPSHOT_COPY 0x4 /* Returns the previously populated snapshot created by the system */ +#define MEMORYSTATUS_FLAGS_GRP_SET_PRIORITY 0x8 /* Set jetsam priorities for a group of pids */ +#define MEMORYSTATUS_FLAGS_GRP_SET_PROBABILITY 0x10 /* Set probability of use for a group of processes */ + +/* + * For use with memorystatus_control: + * MEMORYSTATUS_CMD_GET_JETSAM_SNAPSHOT + * + * A jetsam snapshot is initialized when a non-idle + * jetsam event occurs. The data is held in the + * buffer until it is reaped. This is the default + * behavior. + * + * Flags change the default behavior: + * Demand mode - this is an on_demand snapshot, + * meaning data is populated upon request. + * + * Boot mode - this is a snapshot of + * memstats collected before loading the + * init program. Once collected, these + * stats do not change. In this mode, + * the snapshot entry_count is always 0. + * + * Copy mode - this returns the previous snapshot + * collected by the system. The current snaphshot + * might be only half populated. + * + * Snapshots are inherently racey between request + * for buffer size and actual data compilation. +*/ + +/* These definitions are required for backwards compatibility */ +#define MEMORYSTATUS_SNAPSHOT_ON_DEMAND MEMORYSTATUS_FLAGS_SNAPSHOT_ON_DEMAND +#define MEMORYSTATUS_SNAPSHOT_AT_BOOT MEMORYSTATUS_FLAGS_SNAPSHOT_AT_BOOT +#define MEMORYSTATUS_SNAPSHOT_COPY MEMORYSTATUS_FLAGS_SNAPSHOT_COPY + +/* + * For use with memorystatus_control: + * MEMORYSTATUS_CMD_SET_PRIORITY_PROPERTIES + */ +typedef struct memorystatus_priority_properties { + int32_t priority; + uint64_t user_data; +} memorystatus_priority_properties_t; + +/* + * For use with memorystatus_control: + * MEMORYSTATUS_CMD_SET_MEMLIMIT_PROPERTIES + * MEMORYSTATUS_CMD_GET_MEMLIMIT_PROPERTIES + */ +typedef struct memorystatus_memlimit_properties { + int32_t memlimit_active; /* jetsam memory limit (in MB) when process is active */ + uint32_t memlimit_active_attr; + int32_t memlimit_inactive; /* jetsam memory limit (in MB) when process is inactive */ + uint32_t memlimit_inactive_attr; +} memorystatus_memlimit_properties_t; + +#define MEMORYSTATUS_MEMLIMIT_ATTR_FATAL 0x1 /* if set, exceeding the memlimit is fatal */ + +#ifdef XNU_KERNEL_PRIVATE + +/* + * A process will be killed immediately if it crosses a memory limit marked as fatal. + * Fatal limit types are the + * - default system-wide task limit + * - per-task custom memory limit + * + * A process with a non-fatal memory limit can exceed that limit, but becomes an early + * candidate for jetsam when the device is under memory pressure. + * Non-fatal limit types are the + * - high-water-mark limit + * + * Processes that opt into dirty tracking are evaluated + * based on clean vs dirty state. + * dirty ==> active + * clean ==> inactive + * + * Processes that do not opt into dirty tracking are + * evalulated based on priority level. + * Foreground or above ==> active + * Below Foreground ==> inactive + */ + +/* + * p_memstat_state flag holds + * - in kernel process state and memlimit state + */ + +#define P_MEMSTAT_SUSPENDED 0x00000001 /* Process is suspended and likely in the IDLE band */ +#define P_MEMSTAT_FROZEN 0x00000002 /* Process has some state on disk. It should be suspended */ +#define P_MEMSTAT_FREEZE_DISABLED 0x00000004 /* Process isn't freeze-eligible and will not be frozen */ +#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 */ +#define P_MEMSTAT_LOCKED 0x00000010 /* Process is being actively worked on behind the proc_list_lock */ +#define P_MEMSTAT_TERMINATED 0x00000020 /* Process is exiting */ +#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 */ +#define P_MEMSTAT_PRIORITYUPDATED 0x00000080 /* Process had its jetsam priority updated */ +#define P_MEMSTAT_FOREGROUND 0x00000100 /* Process is in the FG jetsam band...unused??? */ +#define P_MEMSTAT_DIAG_SUSPENDED 0x00000200 /* ...unused??? */ +#define P_MEMSTAT_REFREEZE_ELIGIBLE 0x00000400 /* Process was once thawed i.e. its state was brought back from disk. It is now refreeze eligible.*/ +#define P_MEMSTAT_MANAGED 0x00000800 /* Process is managed by assertiond i.e. is either application or extension */ +#define P_MEMSTAT_INTERNAL 0x00001000 /* Process is a system-critical-not-be-jetsammed process i.e. launchd */ +#define P_MEMSTAT_FATAL_MEMLIMIT 0x00002000 /* current fatal state of the process's memlimit */ +#define P_MEMSTAT_MEMLIMIT_ACTIVE_FATAL 0x00004000 /* if set, exceeding limit is fatal when the process is active */ +#define P_MEMSTAT_MEMLIMIT_INACTIVE_FATAL 0x00008000 /* if set, exceeding limit is fatal when the process is inactive */ +#define P_MEMSTAT_USE_ELEVATED_INACTIVE_BAND 0x00010000 /* if set, the process will go into this band & stay there when in the background instead + of the aging bands and/or the IDLE band. */ extern void memorystatus_init(void) __attribute__((section("__TEXT, initcode"))); -extern kern_return_t memorystatus_list_add(int pid, int priority, int high_water_mark); -extern kern_return_t memorystatus_list_change(boolean_t effective, int pid, int priority, int state_flags, int high_water_mark); -extern kern_return_t memorystatus_list_remove(int pid); +extern void memorystatus_init_at_boot_snapshot(void); -extern kern_return_t memorystatus_on_track_dirty(int pid, boolean_t track); -extern kern_return_t memorystatus_on_dirty(int pid, boolean_t dirty); +extern int memorystatus_add(proc_t p, boolean_t locked); +extern int memorystatus_update(proc_t p, int priority, uint64_t user_data, boolean_t effective, + boolean_t update_memlimit, int32_t memlimit_active, boolean_t memlimit_active_is_fatal, + int32_t memlimit_inactive, boolean_t memlimit_inactive_is_fatal); -extern void memorystatus_on_suspend(int pid); -extern void memorystatus_on_resume(int pid); -extern void memorystatus_on_inactivity(int pid); +extern int memorystatus_remove(proc_t p, boolean_t locked); + +int memorystatus_update_inactive_jetsam_priority_band(pid_t pid, uint32_t opflags, int priority, boolean_t effective_now); + + +extern int memorystatus_dirty_track(proc_t p, uint32_t pcontrol); +extern int memorystatus_dirty_set(proc_t p, boolean_t self, uint32_t pcontrol); +extern int memorystatus_dirty_get(proc_t p); +extern int memorystatus_dirty_clear(proc_t p, uint32_t pcontrol); + +extern int memorystatus_on_terminate(proc_t p); + +extern void memorystatus_on_suspend(proc_t p); +extern void memorystatus_on_resume(proc_t p); +extern void memorystatus_on_inactivity(proc_t p); + +extern void memorystatus_on_pageout_scan_end(void); + +/* Memorystatus kevent */ + +void memorystatus_kevent_init(lck_grp_t *grp, lck_attr_t *attr); + +int memorystatus_knote_register(struct knote *kn); +void memorystatus_knote_unregister(struct knote *kn); + +#if CONFIG_MEMORYSTATUS +void memorystatus_log_exception(const int max_footprint_mb, boolean_t memlimit_is_active, boolean_t memlimit_is_fatal); +void memorystatus_on_ledger_footprint_exceeded(int warning, boolean_t memlimit_is_active, boolean_t memlimit_is_fatal); +void proc_memstat_terminated(proc_t p, boolean_t set); +void memorystatus_proc_flags_unsafe(void * v, boolean_t *is_dirty, boolean_t *is_dirty_tracked, boolean_t *allow_idle_exit); +#endif /* CONFIG_MEMORYSTATUS */ + +int memorystatus_get_pressure_status_kdp(void); #if CONFIG_JETSAM -typedef enum memorystatus_policy_t { +typedef enum memorystatus_policy { kPolicyDefault = 0x0, kPolicyMoreFree = 0x1, kPolicyDiagnoseAll = 0x2, @@ -218,35 +477,38 @@ typedef enum memorystatus_policy_t { kPolicyDiagnoseActive = (kPolicyDiagnoseAll | kPolicyDiagnoseFirst), } memorystatus_policy_t; -extern int memorystatus_jetsam_wakeup; -extern unsigned int memorystatus_jetsam_running; - -extern int memorystatus_kill_top_proc(boolean_t any, uint32_t reason); -extern int memorystatus_kill_top_proc_from_VM(void); +boolean_t memorystatus_kill_on_VM_page_shortage(boolean_t async); +boolean_t memorystatus_kill_on_FC_thrashing(boolean_t async); +boolean_t memorystatus_kill_on_VM_compressor_thrashing(boolean_t async); +boolean_t memorystatus_kill_on_vnode_limit(void); -extern void memorystatus_update(unsigned int pages_avail); +void jetsam_on_ledger_cpulimit_exceeded(void); +void memorystatus_fast_jetsam_override(boolean_t enable_override); -#if VM_PRESSURE_EVENTS - -#define MEMORYSTATUS_SUSPENDED_THRESHOLD 4 +#endif /* CONFIG_JETSAM */ -extern int memorystatus_request_vm_pressure_candidate(void); -extern void memorystatus_send_pressure_note(int pid); +boolean_t memorystatus_kill_on_zone_map_exhaustion(pid_t pid); +boolean_t memorystatus_kill_on_VM_compressor_space_shortage(boolean_t async); +void memorystatus_pages_update(unsigned int pages_avail); -#endif /* VM_PRESSURE_EVENTS */ +boolean_t memorystatus_idle_exit_from_VM(void); -#endif /* CONFIG_JETSAM */ #ifdef CONFIG_FREEZE -#define FREEZE_PAGES_MIN ( 1 * 1024 * 1024 / PAGE_SIZE) -#define FREEZE_PAGES_MAX (16 * 1024 * 1024 / PAGE_SIZE) +#define FREEZE_PAGES_MIN ( 8 * 1024 * 1024 / PAGE_SIZE) +#define FREEZE_PAGES_MAX (32 * 1024 * 1024 / PAGE_SIZE) -#define FREEZE_SUSPENDED_THRESHOLD_LOW 2 #define FREEZE_SUSPENDED_THRESHOLD_DEFAULT 4 +#define FREEZE_PROCESSES_MAX 20 + +#define FREEZE_DAILY_MB_MAX_DEFAULT 1024 +#define FREEZE_DEGRADATION_BUDGET_THRESHOLD 25 //degraded perf. when the daily budget left falls below this threshold percentage -#define FREEZE_DAILY_MB_MAX 1024 -#define FREEZE_DAILY_PAGEOUTS_MAX (FREEZE_DAILY_MB_MAX * (1024 * 1024 / PAGE_SIZE)) +#define MAX_FROZEN_SHARED_MB_PERCENT 10 /* max shared MB calculated as percent of system task limit. */ +#define MAX_FROZEN_PROCESS_DEMOTIONS 2 /* max demotions of frozen processes into IDLE band done daily. */ +#define MIN_THAW_DEMOTION_THRESHOLD 5 /* min # of thaws required for a process to be safe from demotion. */ +#define MIN_THAW_REFREEZE_THRESHOLD 3 /* min # of global thaws needed for us to consider refreezing these processes. */ typedef struct throttle_interval_t { uint32_t mins; @@ -254,16 +516,34 @@ typedef struct throttle_interval_t { uint32_t pageouts; uint32_t max_pageouts; mach_timespec_t ts; - boolean_t throttle; } throttle_interval_t; extern boolean_t memorystatus_freeze_enabled; extern int memorystatus_freeze_wakeup; extern void memorystatus_freeze_init(void) __attribute__((section("__TEXT, initcode"))); +extern int memorystatus_freeze_process_sync(proc_t p); + +#if DEVELOPMENT || DEBUG +#define FREEZER_CONTROL_GET_STATUS (1) +#endif /* DEVELOPMENT || DEBUG */ #endif /* CONFIG_FREEZE */ +#if VM_PRESSURE_EVENTS + +extern kern_return_t memorystatus_update_vm_pressure(boolean_t); + +#if CONFIG_MEMORYSTATUS +/* Flags */ +extern int memorystatus_low_mem_privileged_listener(uint32_t op_flags); +extern int memorystatus_send_pressure_note(int pid); +extern boolean_t memorystatus_is_foreground_locked(proc_t p); +extern boolean_t memorystatus_bg_pressure_eligible(proc_t p); +#endif /* CONFIG_MEMORYSTATUS */ + +#endif /* VM_PRESSURE_EVENTS */ + #endif /* XNU_KERNEL_PRIVATE */ #endif /* SYS_MEMORYSTATUS_H */