osfmk/mach/vm_purgable.h

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