#include <sys/proc.h>
#include <sys/param.h>
-#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
+#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
+#define JETSAM_PRIORITY_BACKGROUND_OPPORTUNISTIC 2
+#define JETSAM_PRIORITY_BACKGROUND 3
+#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,
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;
+ uint32_t state;
} memorystatus_priority_entry_t;
-/*
-** how many processes to snapshot
-*/
-#define kMaxSnapshotEntries 128
-
typedef struct memorystatus_kernel_stats {
uint32_t free_pages;
uint32_t active_pages;
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;
} memorystatus_kernel_stats_t;
/*
*/
typedef struct jetsam_snapshot_entry {
- pid_t pid;
- char name[MAXCOMLEN+1];
- int32_t priority;
+ pid_t pid;
+ char name[MAXCOMLEN+1];
+ int32_t priority;
uint32_t pages;
- uint32_t flags;
- uint8_t uuid[16];
+ uint32_t max_pages;
+ uint32_t state;
+ uint32_t killed;
+ uint64_t user_data;
+ uint8_t uuid[16];
+ uint32_t fds;
+ uint32_t max_pages_lifetime;
+ uint32_t purgeable_pages;
+ struct timeval cpu_time;
} memorystatus_jetsam_snapshot_entry_t;
typedef struct jetsam_snapshot {
uint64_t notification_time;
memorystatus_kernel_stats_t stats;
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 */
+/* TODO - deprecate; see <rdar://problem/12969599> */
+#define kMaxSnapshotEntries 192
-#ifdef XNU_KERNEL_PRIVATE
+/* State */
+#define kMemorystatusSuspended 0x01
+#define kMemorystatusFrozen 0x02
+#define kMemorystatusWasThawed 0x04
+#define kMemorystatusTracked 0x08
+#define kMemorystatusSupportsIdleExit 0x10
+#define kMemorystatusDirty 0x20
-/* General tunables */
-
-#define DELTA_PERCENT 5
-#define CRITICAL_PERCENT 5
-#define HIGHWATER_PERCENT 10
-#define PRESSURE_PERCENT 15
-#define FREEZE_PERCENT 50
-
-#define POLICY_MORE_FREE_OFFSET_PERCENT 5
-#define POLICY_DIAGNOSTIC_OFFSET_PERCENT 5
-
-#define IDLE_EXIT_TIME_SECS 10
+/* Cause */
+enum {
+ kMemorystatusKilled = 1,
+ kMemorystatusKilledHiwat,
+ kMemorystatusKilledVnodes,
+ kMemorystatusKilledVMPageShortage,
+ kMemorystatusKilledVMThrashing,
+ kMemorystatusKilledFCThrashing,
+ kMemorystatusKilledPerProcessLimit,
+ kMemorystatusKilledDiagnostic,
+ kMemorystatusKilledIdleExit
+};
+/* Temporary, to prevent the need for a linked submission of ReportCrash */
+/* Remove when <rdar://problem/13210532> has been integrated */
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)
+ kMemorystatusKilledVM = kMemorystatusKilledVMPageShortage
};
-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;
-#endif
-#if CONFIG_FREEZE
- uint32_t resident_pages;
+/* 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
- uint64_t clean_time;
-} memorystatus_node;
-extern int memorystatus_wakeup;
-extern unsigned int memorystatus_running;
+/* 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. */
+/* 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;
+
+#define MEMORYSTATUS_CMD_SET_JETSAM_PANIC_BITS 1002
+
+/* Select priority band sort order */
+#define JETSAM_SORT_NOSORT 0
+#define JETSAM_SORT_DEFAULT 1
+
+#endif /* PRIVATE */
+
+/*
+ * 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.
+ *
+ * Snapshots are inherently racey between request
+ * for buffer size and actual data compilation.
+*/
+
+/* Flags */
+#define MEMORYSTATUS_SNAPSHOT_ON_DEMAND 0x1 /* A populated snapshot buffer is returned on demand */
+#define MEMORYSTATUS_SNAPSHOT_AT_BOOT 0x2 /* Returns a snapshot with memstats collected at boot */
-extern unsigned int memorystatus_available_pages;
-extern unsigned int memorystatus_available_pages_critical;
-extern unsigned int memorystatus_level;
-extern unsigned int memorystatus_delta;
+
+/*
+ * 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
+ *
+ * P_MEMSTAT_MEMLIMIT_BACKGROUND is translated in posix_spawn as
+ * the fatal system_wide task limit when active
+ * non-fatal inactive limit based on limit provided.
+ * This is necessary for backward compatibility until the
+ * the flag can be considered obsolete.
+ *
+ * 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
+#define P_MEMSTAT_FROZEN 0x00000002
+#define P_MEMSTAT_NORECLAIM 0x00000004
+#define P_MEMSTAT_ERROR 0x00000008
+#define P_MEMSTAT_LOCKED 0x00000010
+#define P_MEMSTAT_TERMINATED 0x00000020
+#define P_MEMSTAT_NOTFIED 0x00000040
+#define P_MEMSTAT_PRIORITYUPDATED 0x00000080
+#define P_MEMSTAT_FOREGROUND 0x00000100
+#define P_MEMSTAT_DIAG_SUSPENDED 0x00000200
+#define P_MEMSTAT_PRIOR_THAW 0x00000400
+#define P_MEMSTAT_MEMLIMIT_BACKGROUND 0x00000800 /* Task has a memory limit for when it's in the background. Used for a process' "high water mark".*/
+#define P_MEMSTAT_INTERNAL 0x00001000
+#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_ACTIVE_EXC_TRIGGERED 0x00008000 /* if set, supresses high-water-mark EXC_RESOURCE, allows one hit per active limit */
+#define P_MEMSTAT_MEMLIMIT_INACTIVE_FATAL 0x00010000 /* if set, exceeding limit is fatal when the process is inactive */
+#define P_MEMSTAT_MEMLIMIT_INACTIVE_EXC_TRIGGERED 0x00020000 /* if set, supresses high-water-mark EXC_RESOURCE, allows one hit per inactive limit */
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 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, boolean_t memlimit_background);
+
+extern int memorystatus_remove(proc_t p, boolean_t locked);
+
+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 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 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_suspend(int pid);
-extern void memorystatus_on_resume(int pid);
-extern void memorystatus_on_inactivity(int pid);
+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_JETSAM
-typedef enum memorystatus_policy_t {
+int memorystatus_get_pressure_status_kdp(void);
+
+typedef enum memorystatus_policy {
kPolicyDefault = 0x0,
kPolicyMoreFree = 0x1,
kPolicyDiagnoseAll = 0x2,
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_VM_thrashing(boolean_t async);
+boolean_t memorystatus_kill_on_FC_thrashing(boolean_t async);
+boolean_t memorystatus_kill_on_vnode_limit(void);
-extern void memorystatus_update(unsigned int pages_avail);
+void memorystatus_on_ledger_footprint_exceeded(int warning, const int max_footprint_mb);
+void proc_memstat_terminated(proc_t p, boolean_t set);
+void jetsam_on_ledger_cpulimit_exceeded(void);
-#if VM_PRESSURE_EVENTS
+void memorystatus_pages_update(unsigned int pages_avail);
-#define MEMORYSTATUS_SUSPENDED_THRESHOLD 4
+#else /* CONFIG_JETSAM */
-extern int memorystatus_request_vm_pressure_candidate(void);
-extern void memorystatus_send_pressure_note(int pid);
+boolean_t memorystatus_idle_exit_from_VM(void);
-#endif /* VM_PRESSURE_EVENTS */
-
-#endif /* CONFIG_JETSAM */
+#endif /* !CONFIG_JETSAM */
#ifdef CONFIG_FREEZE
#define FREEZE_SUSPENDED_THRESHOLD_LOW 2
#define FREEZE_SUSPENDED_THRESHOLD_DEFAULT 4
-#define FREEZE_DAILY_MB_MAX 1024
-#define FREEZE_DAILY_PAGEOUTS_MAX (FREEZE_DAILY_MB_MAX * (1024 * 1024 / PAGE_SIZE))
+#define FREEZE_DAILY_MB_MAX_DEFAULT 1024
typedef struct throttle_interval_t {
uint32_t mins;
extern int memorystatus_freeze_wakeup;
extern void memorystatus_freeze_init(void) __attribute__((section("__TEXT, initcode")));
-
+extern int memorystatus_freeze_process_sync(proc_t p);
#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 */
projects / apple / xnu.git / blobdiff