osfmk/mach/vm_purgable.h

   1 /*
   2  * Copyright (c) 2003 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 /*
  30  *      Virtual memory map purgable object definitions.
  31  *
  32  */
  33
  34 #ifndef _MACH_VM_PURGABLE_H_
  35 #define _MACH_VM_PURGABLE_H_
  36
  37 /*
  38  *      Types defined:
  39  *
  40  *      vm_purgable_t   purgable object control codes.
  41  */
  42
  43 typedef int     vm_purgable_t;
  44
  45 /*
  46  *      Enumeration of valid values for vm_purgable_t.
  47  */
  48 #define VM_PURGABLE_SET_STATE   ((vm_purgable_t) 0)     /* set state of purgable object */
  49 #define VM_PURGABLE_GET_STATE   ((vm_purgable_t) 1)     /* get state of purgable object */
  50
  51 /*
  52  * Valid states of a purgable object.
  53  */
  54 #define VM_PURGABLE_STATE_MIN   0                       /* minimum purgable object state value */
  55 #define VM_PURGABLE_STATE_MAX   2                       /* maximum purgable object state value */
  56
  57 #define VM_PURGABLE_NONVOLATILE 0                       /* purgable object is non-volatile */
  58 #define VM_PURGABLE_VOLATILE    1                       /* purgable object is volatile */
  59 #define VM_PURGABLE_EMPTY       2                       /* purgable object is volatile and empty */
  60
  61 #endif  /* _MACH_VM_PURGABLE_H_ */