xnu-6153.11.26.tar.gz

[apple/xnu.git] / bsd / sys / kern_memorystatus_freeze.h

diff --git a/bsd/sys/kern_memorystatus_freeze.h b/bsd/sys/kern_memorystatus_freeze.h
new file mode 100644 (file)
index 0000000..6c5a8b6
--- /dev/null
+++ b/bsd/sys/kern_memorystatus_freeze.h
@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2006-2018 Apple Computer, Inc. All rights reserved.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
+ *
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
+ *
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ *
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
+ * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
+ *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
+ */
+
+#ifndef SYS_MEMORYSTATUS_FREEZE_H
+#define SYS_MEMORYSTATUS_FREEZE_H
+
+#include <stdint.h>
+#include <sys/time.h>
+#include <sys/proc.h>
+#include <sys/param.h>
+#include <sys/kern_memorystatus.h>
+
+typedef struct memorystatus_freeze_entry {
+       int32_t pid;
+       uint32_t flags;
+       uint32_t pages;
+} memorystatus_freeze_entry_t;
+
+#ifdef XNU_KERNEL_PRIVATE
+
+extern unsigned long freeze_threshold_percentage;
+extern unsigned int memorystatus_frozen_count;
+extern unsigned int memorystatus_frozen_processes_max;
+extern unsigned int memorystatus_frozen_shared_mb;
+extern unsigned int memorystatus_frozen_shared_mb_max;
+extern unsigned int memorystatus_freeze_shared_mb_per_process_max; /* Max. MB allowed per process to be freezer-eligible. */
+extern unsigned int memorystatus_freeze_private_shared_pages_ratio; /* Ratio of private:shared pages for a process to be freezer-eligible. */
+extern unsigned int memorystatus_suspended_count;
+extern unsigned int memorystatus_thaw_count;
+extern unsigned int memorystatus_refreeze_eligible_count; /* # of processes currently thawed i.e. have state on disk & in-memory */
+
+void memorystatus_freeze_init(void);
+extern int  memorystatus_freeze_process_sync(proc_t p);
+
+#ifdef CONFIG_FREEZE
+
+#define FREEZE_PAGES_MIN   ( 8 * 1024 * 1024 / PAGE_SIZE)
+#define FREEZE_PAGES_MAX   (max_task_footprint_mb == 0 ? INT_MAX : (max_task_footprint_mb << (20 - PAGE_SHIFT)))
+
+#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 MAX_FROZEN_SHARED_MB_PERCENT 10
+#define MAX_FROZEN_PROCESS_DEMOTIONS 2
+#define MIN_THAW_DEMOTION_THRESHOLD  5
+#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;
+       uint32_t burst_multiple;
+       uint32_t pageouts;
+       uint32_t max_pageouts;
+       mach_timespec_t ts;
+} throttle_interval_t;
+
+extern boolean_t memorystatus_freeze_enabled;
+extern int memorystatus_freeze_wakeup;
+
+/* Thresholds */
+extern unsigned int memorystatus_freeze_threshold;
+extern unsigned int memorystatus_freeze_pages_min;
+extern unsigned int memorystatus_freeze_pages_max;
+extern unsigned int memorystatus_freeze_suspended_threshold;
+extern unsigned int memorystatus_freeze_daily_mb_max;
+extern uint64_t     memorystatus_freeze_budget_pages_remaining; //remaining # of pages that can be frozen to disk
+extern boolean_t memorystatus_freeze_degradation; //protected by the freezer mutex. Signals we are in a degraded freeze mode.
+
+extern unsigned int memorystatus_max_frozen_demotions_daily;
+extern unsigned int memorystatus_thaw_count_demotion_threshold;
+
+#if DEVELOPMENT || DEBUG
+#define FREEZER_CONTROL_GET_STATUS      (1)
+#endif /* DEVELOPMENT || DEBUG */
+
+extern boolean_t memorystatus_freeze_enabled;
+extern int memorystatus_freeze_wakeup;
+extern int memorystatus_freeze_jetsam_band; /* the jetsam band which will contain P_MEMSTAT_FROZEN processes */
+
+boolean_t memorystatus_freeze_thread_should_run(void);
+int memorystatus_set_process_is_freezable(pid_t pid, boolean_t is_freezable);
+int memorystatus_get_process_is_freezable(pid_t pid, int *is_freezable);
+int memorystatus_freezer_control(int32_t flags, user_addr_t buffer, size_t buffer_size, int32_t *retval);
+
+#endif /* CONFIG_FREEZE */
+
+#endif /* XNU_KERNEL_PRIVATE */
+
+#endif /* SYS_MEMORYSTATUS_FREEZE_H */