bsd/sys/kern_memorystatus.h

   1 /*
   2  * Copyright (c) 2006 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         @header kern_memorystatus.h
  30         This header defines a kernel event subclass for the OSMemoryNotification API
  31  */
  32
  33 #ifndef SYS_KERN_MEMORYSTATUS_H
  34 #define SYS_KERN_MEMORYSTATUS_H
  35
  36 #ifndef MACH_KERNEL_PRIVATE
  37
  38 #include <stdint.h>
  39 #include <sys/time.h>
  40 #include <sys/proc.h>
  41
  42 /*
  43  * Define Memory Status event subclass.
  44  * Subclass of KEV_SYSTEM_CLASS
  45  */
  46
  47 /*!
  48         @defined KEV_MEMORYSTATUS_SUBCLASS
  49         @discussion The kernel event subclass for memory status events.
  50 */
  51 #define KEV_MEMORYSTATUS_SUBCLASS        3
  52
  53 enum {
  54         kMemoryStatusLevelNote = 1,
  55         kMemoryStatusSnapshotNote = 2
  56 };
  57
  58 enum {
  59         kMemoryStatusLevelAny = -1,
  60         kMemoryStatusLevelNormal = 0,
  61         kMemoryStatusLevelWarning = 1,
  62         kMemoryStatusLevelUrgent = 2,
  63         kMemoryStatusLevelCritical = 3
  64 };
  65
  66 typedef struct jetsam_priority_entry {
  67         pid_t pid;
  68         uint32_t flags;
  69         int32_t hiwat_pages;
  70         int32_t hiwat_reserved1;
  71         int32_t hiwat_reserved2;
  72         int32_t hiwat_reserved3;
  73 } jetsam_priority_entry_t;
  74
  75 /*
  76 ** maximum killable processes to keep track of
  77 */
  78 #define kMaxPriorityEntries 64
  79
  80 typedef struct jetsam_snapshot_entry {
  81         pid_t pid;
  82         char name[MAXCOMLEN+1];
  83         uint32_t pages;
  84         uint32_t flags;
  85         uint8_t uuid[16];
  86 } jetsam_snapshot_entry_t;
  87
  88 /*
  89 ** how many processes to snapshot
  90 */
  91 #define kMaxSnapshotEntries 128
  92
  93 typedef struct jetsam_kernel_stats {
  94         uint32_t free_pages;
  95         uint32_t active_pages;
  96         uint32_t inactive_pages;
  97         uint32_t purgeable_pages;
  98         uint32_t wired_pages;
  99 } jetsam_kernel_stats_t;
 100
 101 /*
 102 ** This is a variable-length struct.
 103 ** Allocate a buffer of the size returned by the sysctl, cast to a jetsam_snapshot_t *
 104 */
 105
 106 typedef struct jetsam_snapshot {
 107         jetsam_kernel_stats_t stats;
 108         size_t entry_count;
 109         jetsam_snapshot_entry_t entries[1];
 110 } jetsam_snapshot_t;
 111
 112 enum {
 113         kJetsamFlagsFrontmost =         (1 << 0),
 114         kJetsamFlagsKilled =            (1 << 1),
 115         kJetsamFlagsKilledHiwat =       (1 << 2)
 116 };
 117 #endif /* !MACH_KERNEL_PRIVATE */
 118
 119 #ifdef KERNEL
 120 extern void kern_memorystatus_init(void) __attribute__((section("__TEXT, initcode")));
 121 extern int jetsam_kill_top_proc(void);
 122
 123 extern int kern_memorystatus_wakeup;
 124 extern int kern_memorystatus_level;
 125
 126 #endif /* KERNEL */
 127 #endif /* SYS_KERN_MEMORYSTATUS_H */