osfmk/vm/memory_object.h

   1 /*
   2  * Copyright (c) 2000 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  * @OSF_COPYRIGHT@
  24  */
  25 /*
  26  * Mach Operating System
  27  * Copyright (c) 1991 Carnegie Mellon University
  28  * All Rights Reserved.
  29  *
  30  * Permission to use, copy, modify and distribute this software and its
  31  * documentation is hereby granted, provided that both the copyright
  32  * notice and this permission notice appear in all copies of the
  33  * software, derivative works or modified versions, and any portions
  34  * thereof, and that both notices appear in supporting documentation.
  35  *
  36  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS
  37  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
  38  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
  39  *
  40  * Carnegie Mellon requests users of this software to return to
  41  *
  42  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
  43  *  School of Computer Science
  44  *  Carnegie Mellon University
  45  *  Pittsburgh PA 15213-3890
  46  *
  47  * any improvements or extensions that they make and grant Carnegie the
  48  * rights to redistribute these changes.
  49  */
  50 /*
  51  */
  52
  53 #ifndef _VM_MEMORY_OBJECT_H_
  54 #define _VM_MEMORY_OBJECT_H_
  55
  56 #include <mach_pagemap.h>
  57
  58 #include <mach/boolean.h>
  59 #include <ipc/ipc_types.h>
  60
  61 extern kern_return_t    memory_object_set_attributes_common(
  62                                 vm_object_t     object,
  63                                 boolean_t       may_cache,
  64                                 memory_object_copy_strategy_t copy_strategy,
  65                                 boolean_t       temporary,
  66                                 vm_size_t       cluster_size,
  67                                 boolean_t       silent_overwrite,
  68                                 boolean_t       advisory_pageout);
  69
  70 extern boolean_t        memory_object_sync (
  71                                 vm_object_t             object,
  72                                 vm_object_offset_t      offset,
  73                                 vm_object_size_t        size,
  74                                 boolean_t               should_flush,
  75                                 boolean_t               should_return);
  76
  77 extern ipc_port_t       memory_manager_default_reference(
  78                                         vm_size_t       *cluster_size);
  79
  80 extern boolean_t        memory_manager_default_port(ipc_port_t port);
  81
  82 extern kern_return_t    memory_manager_default_check(void);
  83
  84 extern void             memory_manager_default_init(void);
  85
  86
  87 extern kern_return_t    memory_object_free_from_cache(
  88                                 host_t          host,
  89                                 int             pager_id,
  90                                 int             *count);
  91
  92 extern kern_return_t    memory_object_remove_cached_object(
  93                                 ipc_port_t      port);
  94
  95 extern void             memory_object_deactivate_pages(
  96                                 vm_object_t             object,
  97                                 vm_object_offset_t      offset,
  98                                 vm_object_size_t        size,
  99                                 boolean_t               kill_page);
 100
 101 #endif  /* _VM_MEMORY_OBJECT_H_ */