osfmk/vm/vm_protos.h

   1 /*
   2  * Copyright (c) 2004-2006 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_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
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30
  31 #ifdef  XNU_KERNEL_PRIVATE
  32
  33 #ifndef _VM_VM_PROTOS_H_
  34 #define _VM_VM_PROTOS_H_
  35
  36 #include <mach/mach_types.h>
  37 #include <kern/kern_types.h>
  38
  39 /*
  40  * This file contains various type definitions and routine prototypes
  41  * that are needed to avoid compilation warnings for VM code (in osfmk,
  42  * default_pager and bsd).
  43  * Most of these should eventually go into more appropriate header files.
  44  *
  45  * Include it after all other header files since it doesn't include any
  46  * type definitions and it works around some conflicts with other header
  47  * files.
  48  */
  49
  50 /*
  51  * iokit
  52  */
  53 extern kern_return_t device_data_action(
  54         int                     device_handle,
  55         ipc_port_t              device_pager,
  56         vm_prot_t               protection,
  57         vm_object_offset_t      offset,
  58         vm_size_t               size);
  59
  60 extern kern_return_t device_close(
  61         int     device_handle);
  62
  63 /*
  64  * default_pager
  65  */
  66 extern int start_def_pager(
  67         char *bs_device);
  68 extern int default_pager_init_flag;
  69
  70 /*
  71  * osfmk
  72  */
  73 #ifndef _KERN_IPC_TT_H_ /* XXX FBDP */
  74 /* these should be exported cleanly from OSFMK since BSD needs them */
  75 extern ipc_port_t convert_task_to_port(
  76         task_t          task);
  77 extern ipc_port_t convert_task_name_to_port(
  78         task_name_t     task_name);
  79 #endif /* _KERN_IPC_TT_H_ */
  80 #ifndef _IPC_IPC_PORT_H_
  81 extern mach_port_name_t ipc_port_copyout_send(
  82         ipc_port_t      sright,
  83         ipc_space_t     space);
  84 extern task_t port_name_to_task(
  85         mach_port_name_t name);
  86 #endif /* _IPC_IPC_PORT_H_ */
  87
  88 extern ipc_space_t  get_task_ipcspace(
  89         task_t t);
  90
  91 /* Some loose-ends VM stuff */
  92
  93 extern vm_map_t         kalloc_map;
  94 extern vm_size_t        msg_ool_size_small;
  95 extern vm_map_t         zone_map;
  96
  97 extern void consider_machine_adjust(void);
  98 extern pmap_t get_map_pmap(vm_map_t);
  99 extern vm_map_offset_t get_map_min(vm_map_t);
 100 extern vm_map_offset_t get_map_max(vm_map_t);
 101 extern vm_map_size_t get_vmmap_size(vm_map_t);
 102 extern int get_vmmap_entries(vm_map_t);
 103
 104 extern boolean_t coredumpok(vm_map_t map, vm_offset_t va);
 105
 106 /*
 107  * VM routines that used to be published to
 108  * user space, and are now restricted to the kernel.
 109  *
 110  * They should eventually go away entirely -
 111  * to be replaced with standard vm_map() and
 112  * vm_deallocate() calls.
 113  */
 114
 115 extern kern_return_t vm_upl_map
 116 (
 117         vm_map_t target_task,
 118         upl_t upl,
 119         vm_address_t *address
 120 );
 121
 122 extern kern_return_t vm_upl_unmap
 123 (
 124         vm_map_t target_task,
 125         upl_t upl
 126 );
 127
 128 extern kern_return_t vm_region_object_create
 129 (
 130         vm_map_t target_task,
 131         vm_size_t size,
 132         ipc_port_t *object_handle
 133 );
 134
 135 extern mach_vm_offset_t mach_get_vm_start(vm_map_t);
 136 extern mach_vm_offset_t mach_get_vm_end(vm_map_t);
 137
 138 /*
 139  * Legacy routines to get the start and end for a vm_map_t.  They
 140  * return them in the vm_offset_t format.  So, they should only be
 141  * called on maps that are the same size as the kernel map for
 142  * accurate results.
 143  */
 144 extern vm_offset_t get_vm_start(vm_map_t);
 145 extern vm_offset_t get_vm_end(vm_map_t);
 146
 147 /*
 148  * LP64todo - map in the commpage cleanly and remove these.
 149  */
 150 extern void vm_map_commpage64( vm_map_t );
 151 extern void vm_map_remove_commpage( vm_map_t );
 152 #ifdef __i386__
 153 extern void vm_map_commpage32(vm_map_t);
 154 extern kern_return_t vm_map_apple_protected(
 155         vm_map_t        map,
 156         vm_map_offset_t start,
 157         vm_map_offset_t end);
 158 extern void apple_protect_pager_bootstrap(void);
 159 extern memory_object_t apple_protect_pager_setup(vm_object_t backing_object);
 160 extern void apple_protect_pager_map(memory_object_t mem_obj);
 161 #endif  /* __i386__ */
 162
 163
 164 /*
 165  * bsd
 166  */
 167 struct vnode;
 168 extern int is_suser(void);
 169 extern int bsd_read_page_cache_file(
 170         unsigned int    user,
 171         int             *fid,
 172         int             *mod,
 173         char            *app_name,
 174         struct vnode    *app_vp,
 175         vm_offset_t     *buffer,
 176         vm_offset_t     *bufsize);
 177 extern int bsd_write_page_cache_file(
 178         unsigned int    user,
 179         char            *file_name,
 180         caddr_t         buffer,
 181         vm_size_t       size,
 182         int             mod,
 183         int             fid);
 184 extern int prepare_profile_database(
 185         int     user);
 186 extern void vnode_pager_shutdown(void);
 187 extern void *upl_get_internal_page_list(
 188         upl_t upl);
 189 #ifndef _VNODE_PAGER_
 190 typedef int pager_return_t;
 191 extern pager_return_t   vnode_pagein(
 192         struct vnode *, upl_t,
 193         vm_offset_t, vm_object_offset_t,
 194         vm_size_t, int, int *);
 195 extern pager_return_t   vnode_pageout(
 196         struct vnode *, upl_t,
 197         vm_offset_t, vm_object_offset_t,
 198         vm_size_t, int, int *);
 199 extern memory_object_t vnode_pager_setup(
 200         struct vnode *, memory_object_t);
 201 extern vm_object_offset_t vnode_pager_get_filesize(
 202         struct vnode *);
 203 extern kern_return_t vnode_pager_get_pathname(
 204         struct vnode    *vp,
 205         char            *pathname,
 206         vm_size_t       *length_p);
 207 extern kern_return_t vnode_pager_get_filename(
 208         struct vnode    *vp,
 209         char            **filename);
 210
 211 #endif /* _VNODE_PAGER_ */
 212 extern void vnode_pager_bootstrap(void);
 213 extern kern_return_t
 214 vnode_pager_data_unlock(
 215         memory_object_t         mem_obj,
 216         memory_object_offset_t  offset,
 217         vm_size_t               size,
 218         vm_prot_t               desired_access);
 219 extern kern_return_t vnode_pager_init(
 220         memory_object_t,
 221         memory_object_control_t,
 222         vm_size_t);
 223 extern kern_return_t vnode_pager_get_object_size(
 224         memory_object_t,
 225         memory_object_offset_t *);
 226 extern kern_return_t vnode_pager_get_object_pathname(
 227         memory_object_t mem_obj,
 228         char            *pathname,
 229         vm_size_t       *length_p);
 230 extern kern_return_t vnode_pager_get_object_filename(
 231         memory_object_t mem_obj,
 232         char            **filename);
 233 extern kern_return_t vnode_pager_data_request(
 234         memory_object_t,
 235         memory_object_offset_t,
 236         vm_size_t,
 237         vm_prot_t);
 238 extern kern_return_t vnode_pager_data_return(
 239         memory_object_t,
 240         memory_object_offset_t,
 241         vm_size_t,
 242         memory_object_offset_t *,
 243         int *,
 244         boolean_t,
 245         boolean_t,
 246         int);
 247 extern kern_return_t vnode_pager_data_initialize(
 248         memory_object_t,
 249         memory_object_offset_t,
 250         vm_size_t);
 251 extern void vnode_pager_reference(
 252         memory_object_t         mem_obj);
 253 extern kern_return_t vnode_pager_synchronize(
 254         memory_object_t         mem_obj,
 255         memory_object_offset_t  offset,
 256         vm_size_t               length,
 257         vm_sync_t               sync_flags);
 258 extern kern_return_t vnode_pager_unmap(
 259         memory_object_t         mem_obj);
 260 extern void vnode_pager_deallocate(
 261         memory_object_t);
 262 extern kern_return_t vnode_pager_terminate(
 263         memory_object_t);
 264 extern void vnode_pager_vrele(
 265         struct vnode *vp);
 266 extern void vnode_pager_release_from_cache(
 267         int     *);
 268 extern void ubc_unmap(
 269         struct vnode *vp);
 270
 271 extern void   dp_memory_object_reference(memory_object_t);
 272 extern void   dp_memory_object_deallocate(memory_object_t);
 273 #ifndef _memory_object_server_
 274 extern kern_return_t   dp_memory_object_init(memory_object_t,
 275                                              memory_object_control_t,
 276                                              vm_size_t);
 277 extern  kern_return_t dp_memory_object_terminate(memory_object_t);
 278 extern  kern_return_t   dp_memory_object_data_request(memory_object_t,
 279                         memory_object_offset_t, vm_size_t, vm_prot_t);
 280 extern kern_return_t dp_memory_object_data_return(memory_object_t,
 281                                                     memory_object_offset_t,
 282                                                     vm_size_t,
 283                                                     vm_size_t *,
 284                                                     int *,
 285                                                     boolean_t,
 286                                                     boolean_t,
 287                                                     int);
 288 extern kern_return_t dp_memory_object_data_initialize(memory_object_t,
 289                                                       memory_object_offset_t,
 290                                                       vm_size_t);
 291 extern kern_return_t dp_memory_object_data_unlock(memory_object_t,
 292                                                   memory_object_offset_t,
 293                                                   vm_size_t,
 294                                                   vm_prot_t);
 295 extern kern_return_t dp_memory_object_synchronize(memory_object_t,
 296                                                   memory_object_offset_t,
 297                                                   vm_size_t,
 298                                                   vm_sync_t);
 299 extern kern_return_t dp_memory_object_unmap(memory_object_t);
 300 #endif /* _memory_object_server_ */
 301 #ifndef _memory_object_default_server_
 302 extern kern_return_t default_pager_memory_object_create(
 303         memory_object_default_t,
 304         vm_size_t,
 305         memory_object_t *);
 306 #endif /* _memory_object_default_server_ */
 307
 308 extern void   device_pager_reference(memory_object_t);
 309 extern void   device_pager_deallocate(memory_object_t);
 310 extern kern_return_t   device_pager_init(memory_object_t,
 311                                          memory_object_control_t,
 312                                          vm_size_t);
 313 extern  kern_return_t device_pager_terminate(memory_object_t);
 314 extern  kern_return_t   device_pager_data_request(memory_object_t,
 315                                                   memory_object_offset_t,
 316                                                   vm_size_t,
 317                                                   vm_prot_t);
 318 extern kern_return_t device_pager_data_return(memory_object_t,
 319                                               memory_object_offset_t,
 320                                               vm_size_t,
 321                                               memory_object_offset_t *,
 322                                               int *,
 323                                               boolean_t,
 324                                               boolean_t,
 325                                               int);
 326 extern kern_return_t device_pager_data_initialize(memory_object_t,
 327                                                   memory_object_offset_t,
 328                                                   vm_size_t);
 329 extern kern_return_t device_pager_data_unlock(memory_object_t,
 330                                               memory_object_offset_t,
 331                                               vm_size_t,
 332                                               vm_prot_t);
 333 extern kern_return_t device_pager_synchronize(memory_object_t,
 334                                               memory_object_offset_t,
 335                                               vm_size_t,
 336                                               vm_sync_t);
 337 extern kern_return_t device_pager_unmap(memory_object_t);
 338 extern kern_return_t device_pager_populate_object(
 339         memory_object_t         device,
 340         memory_object_offset_t  offset,
 341         ppnum_t                 page_num,
 342         vm_size_t               size);
 343 extern memory_object_t device_pager_setup(
 344         memory_object_t,
 345         int,
 346         vm_size_t,
 347         int);
 348 extern void device_pager_bootstrap(void);
 349
 350 extern kern_return_t memory_object_create_named(
 351         memory_object_t pager,
 352         memory_object_offset_t  size,
 353         memory_object_control_t         *control);
 354
 355
 356 extern int macx_swapinfo(
 357         memory_object_size_t    *total_p,
 358         memory_object_size_t    *avail_p,
 359         vm_size_t               *pagesize_p,
 360         boolean_t               *encrypted_p);
 361
 362 extern void log_nx_failure(addr64_t vaddr, vm_prot_t prot);
 363
 364 #endif  /* _VM_VM_PROTOS_H_ */
 365
 366 #endif  /* XNU_KERNEL_PRIVATE */