osfmk/mach/vm_purgable.h

   1 /*
   2  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23
  24 /*
  25  *      Virtual memory map purgable object definitions.
  26  *
  27  */
  28
  29 #ifndef _MACH_VM_PURGABLE_H_
  30 #define _MACH_VM_PURGABLE_H_
  31
  32 /*
  33  *      Types defined:
  34  *
  35  *      vm_purgable_t   purgable object control codes.
  36  */
  37
  38 typedef int     vm_purgable_t;
  39
  40 /*
  41  *      Enumeration of valid values for vm_purgable_t.
  42  */
  43 #define VM_PURGABLE_SET_STATE   ((vm_purgable_t) 0)     /* set state of purgable object */
  44 #define VM_PURGABLE_GET_STATE   ((vm_purgable_t) 1)     /* get state of purgable object */
  45
  46 /*
  47  * Valid states of a purgable object.
  48  */
  49 #define VM_PURGABLE_STATE_MIN   0                       /* minimum purgable object state value */
  50 #define VM_PURGABLE_STATE_MAX   2                       /* maximum purgable object state value */
  51
  52 #define VM_PURGABLE_NONVOLATILE 0                       /* purgable object is non-volatile */
  53 #define VM_PURGABLE_VOLATILE    1                       /* purgable object is volatile */
  54 #define VM_PURGABLE_EMPTY       2                       /* purgable object is volatile and empty */
  55
  56 #endif  /* _MACH_VM_PURGABLE_H_ */