[apple/xnu.git] / osfmk / vm / vm_protos.h

/*
 * Copyright (c) 2004-2007 Apple Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */

#ifdef	XNU_KERNEL_PRIVATE

#ifndef _VM_VM_PROTOS_H_
#define _VM_VM_PROTOS_H_

#include <mach/mach_types.h>
#include <kern/kern_types.h>

#ifdef __cplusplus
extern "C" {
#endif

/*
 * This file contains various type definitions and routine prototypes
 * that are needed to avoid compilation warnings for VM code (in osfmk,
 * default_pager and bsd).
 * Most of these should eventually go into more appropriate header files.
 *
 * Include it after all other header files since it doesn't include any
 * type definitions and it works around some conflicts with other header
 * files.
 */

/*
 * iokit
 */
extern kern_return_t device_data_action(
	uintptr_t               device_handle, 
	ipc_port_t              device_pager,
	vm_prot_t               protection, 
	vm_object_offset_t      offset, 
	vm_size_t               size);

extern kern_return_t device_close(
	uintptr_t     device_handle);

extern boolean_t vm_swap_files_pinned(void);

/*
 * osfmk
 */
#ifndef _IPC_IPC_PORT_H_
extern mach_port_name_t ipc_port_copyout_send(
	ipc_port_t	sright,
	ipc_space_t	space);
extern task_t port_name_to_task(
	mach_port_name_t name);
#endif /* _IPC_IPC_PORT_H_ */

extern ipc_space_t  get_task_ipcspace(
	task_t t);

#if CONFIG_MEMORYSTATUS
extern int max_task_footprint_mb;	/* Per-task limit on physical memory consumption in megabytes */
#endif /* CONFIG_MEMORYSTATUS */

/* Some loose-ends VM stuff */

extern vm_map_t		kalloc_map;
extern vm_size_t	msg_ool_size_small;
extern vm_map_t		zone_map;

extern void consider_machine_adjust(void);
extern vm_map_offset_t get_map_min(vm_map_t);
extern vm_map_offset_t get_map_max(vm_map_t);
extern vm_map_size_t get_vmmap_size(vm_map_t);
#if CONFIG_COREDUMP
extern int get_vmmap_entries(vm_map_t);
#endif
extern int get_map_nentries(vm_map_t);

extern vm_map_offset_t vm_map_page_mask(vm_map_t);

#if CONFIG_COREDUMP
extern boolean_t coredumpok(vm_map_t map, vm_offset_t va);
#endif

/*
 * VM routines that used to be published to
 * user space, and are now restricted to the kernel.
 *
 * They should eventually go away entirely -
 * to be replaced with standard vm_map() and
 * vm_deallocate() calls.
 */

extern kern_return_t vm_upl_map
(
	vm_map_t target_task,
	upl_t upl,
	vm_address_t *address
);

extern kern_return_t vm_upl_unmap
(
	vm_map_t target_task,
	upl_t upl
);

extern kern_return_t vm_region_object_create
(
	vm_map_t target_task,
	vm_size_t size,
	ipc_port_t *object_handle
);

extern mach_vm_offset_t mach_get_vm_start(vm_map_t);
extern mach_vm_offset_t mach_get_vm_end(vm_map_t);

#if CONFIG_CODE_DECRYPTION
#define VM_MAP_DEBUG_APPLE_PROTECT	MACH_ASSERT
#if VM_MAP_DEBUG_APPLE_PROTECT
extern int vm_map_debug_apple_protect;
#endif /* VM_MAP_DEBUG_APPLE_PROTECT */
struct pager_crypt_info;
extern kern_return_t vm_map_apple_protected(
	vm_map_t		map,
	vm_map_offset_t		start,
	vm_map_offset_t		end,
	vm_object_offset_t	crypto_backing_offset,
	struct pager_crypt_info *crypt_info);
extern void apple_protect_pager_bootstrap(void);
extern memory_object_t apple_protect_pager_setup(
	vm_object_t		backing_object,
	vm_object_offset_t	backing_offset,
	vm_object_offset_t	crypto_backing_offset,
	struct pager_crypt_info *crypt_info,
	vm_object_offset_t	crypto_start,
	vm_object_offset_t	crypto_end);
#endif	/* CONFIG_CODE_DECRYPTION */

struct vnode;
extern void swapfile_pager_bootstrap(void);
extern memory_object_t swapfile_pager_setup(struct vnode *vp);
extern memory_object_control_t swapfile_pager_control(memory_object_t mem_obj);

#if __arm64__ || ((__ARM_ARCH_7K__ >= 2) && defined(PLATFORM_WatchOS))
#define SIXTEENK_PAGE_SIZE	0x4000
#define SIXTEENK_PAGE_MASK	0x3FFF
#define SIXTEENK_PAGE_SHIFT	14
#endif /* __arm64__ || ((__ARM_ARCH_7K__ >= 2) && defined(PLATFORM_WatchOS)) */


/*
 * bsd
 */
struct vnode;
extern void *upl_get_internal_page_list(
	upl_t upl);

extern void vnode_setswapmount(struct vnode *);
extern int64_t vnode_getswappin_avail(struct vnode *);

typedef int pager_return_t;
extern pager_return_t	vnode_pagein(
	struct vnode *, upl_t,
	upl_offset_t, vm_object_offset_t,
	upl_size_t, int, int *);
extern pager_return_t	vnode_pageout(
	struct vnode *, upl_t,
	upl_offset_t, vm_object_offset_t,
	upl_size_t, int, int *);
extern uint32_t vnode_trim (struct vnode *, int64_t offset, unsigned long len);
extern memory_object_t vnode_pager_setup(
	struct vnode *, memory_object_t);
extern vm_object_offset_t vnode_pager_get_filesize(
	struct vnode *);
extern uint32_t vnode_pager_isinuse(
	struct vnode *);
extern boolean_t vnode_pager_isSSD(
	struct vnode *);
extern void vnode_pager_throttle(
	void);
extern uint32_t vnode_pager_return_throttle_io_limit(
	struct vnode *,
	uint32_t     *);
extern kern_return_t vnode_pager_get_name(
	struct vnode	*vp,
	char		*pathname,
	vm_size_t	pathname_len,
	char		*filename,
	vm_size_t	filename_len,
	boolean_t	*truncated_path_p);
struct timespec;
extern kern_return_t vnode_pager_get_mtime(
	struct vnode	*vp,
	struct timespec	*mtime,
	struct timespec	*cs_mtime);
extern kern_return_t vnode_pager_get_cs_blobs(
	struct vnode	*vp,
	void		**blobs);

#if CONFIG_IOSCHED
void vnode_pager_issue_reprioritize_io(
	struct vnode 	*devvp, 
	uint64_t 	blkno, 
	uint32_t 	len,
	int 		priority);
#endif

#if CHECK_CS_VALIDATION_BITMAP	
/* used by the vnode_pager_cs_validation_bitmap routine*/
#define CS_BITMAP_SET	1
#define CS_BITMAP_CLEAR	2
#define CS_BITMAP_CHECK	3

#endif /* CHECK_CS_VALIDATION_BITMAP */

extern void vnode_pager_bootstrap(void);
extern kern_return_t
vnode_pager_data_unlock(
	memory_object_t		mem_obj,
	memory_object_offset_t	offset,
	memory_object_size_t		size,
	vm_prot_t		desired_access);
extern kern_return_t vnode_pager_init(
	memory_object_t, 
	memory_object_control_t, 
	memory_object_cluster_size_t);
extern kern_return_t vnode_pager_get_object_size(
	memory_object_t,
	memory_object_offset_t *);

#if CONFIG_IOSCHED
extern kern_return_t vnode_pager_get_object_devvp(
        memory_object_t,
        uintptr_t *);
#endif

extern kern_return_t vnode_pager_get_isinuse(
	memory_object_t,
	uint32_t *);
extern kern_return_t vnode_pager_get_isSSD(
	memory_object_t,
	boolean_t *);
extern kern_return_t vnode_pager_get_throttle_io_limit(
	memory_object_t,
	uint32_t *);
extern kern_return_t vnode_pager_get_object_name(
	memory_object_t	mem_obj,
	char		*pathname,
	vm_size_t	pathname_len,
	char		*filename,
	vm_size_t	filename_len,
	boolean_t	*truncated_path_p);
extern kern_return_t vnode_pager_get_object_mtime(
	memory_object_t	mem_obj,
	struct timespec *mtime,
	struct timespec	*cs_mtime);

#if CHECK_CS_VALIDATION_BITMAP	
extern kern_return_t vnode_pager_cs_check_validation_bitmap( 
	memory_object_t	mem_obj, 
	memory_object_offset_t	offset,
	int		optype);
#endif /*CHECK_CS_VALIDATION_BITMAP*/

extern	kern_return_t ubc_cs_check_validation_bitmap (
	struct vnode *vp, 
	memory_object_offset_t offset,
	int optype);

extern kern_return_t vnode_pager_data_request( 
	memory_object_t, 
	memory_object_offset_t,
	memory_object_cluster_size_t,
	vm_prot_t,
	memory_object_fault_info_t);
extern kern_return_t vnode_pager_data_return(
	memory_object_t,
	memory_object_offset_t,
	memory_object_cluster_size_t,
	memory_object_offset_t *,
	int *,
	boolean_t,
	boolean_t,
	int);
extern kern_return_t vnode_pager_data_initialize(
	memory_object_t,
	memory_object_offset_t,
	memory_object_cluster_size_t);
extern void vnode_pager_reference(
	memory_object_t		mem_obj);
extern kern_return_t vnode_pager_synchronize(
	memory_object_t		mem_obj,
	memory_object_offset_t	offset,
	memory_object_size_t		length,
	vm_sync_t		sync_flags);
extern kern_return_t vnode_pager_map(
	memory_object_t		mem_obj,
	vm_prot_t		prot);
extern kern_return_t vnode_pager_last_unmap(
	memory_object_t		mem_obj);
extern void vnode_pager_deallocate(
	memory_object_t);
extern kern_return_t vnode_pager_terminate(
	memory_object_t);
extern void vnode_pager_vrele(
	struct vnode *vp);
extern void vnode_pager_release_from_cache(
	int	*);
extern struct vnode *vnode_pager_lookup_vnode(
	memory_object_t);

extern int  ubc_map(
	struct vnode *vp,
	int flags);
extern void ubc_unmap(
	struct vnode *vp);

struct vm_map_entry;
extern struct vm_object *find_vnode_object(struct vm_map_entry *entry);

extern void   device_pager_reference(memory_object_t);
extern void   device_pager_deallocate(memory_object_t);
extern kern_return_t   device_pager_init(memory_object_t,
					 memory_object_control_t,
					 memory_object_cluster_size_t);
extern	kern_return_t device_pager_terminate(memory_object_t);
extern	kern_return_t   device_pager_data_request(memory_object_t, 
						  memory_object_offset_t,
						  memory_object_cluster_size_t,
						  vm_prot_t,
						  memory_object_fault_info_t);
extern kern_return_t device_pager_data_return(memory_object_t,
					      memory_object_offset_t,
					      memory_object_cluster_size_t,
					      memory_object_offset_t *,
					      int *,
					      boolean_t,
					      boolean_t,
					      int);
extern kern_return_t device_pager_data_initialize(memory_object_t,
						  memory_object_offset_t,
						  memory_object_cluster_size_t);
extern kern_return_t device_pager_data_unlock(memory_object_t,
					      memory_object_offset_t,
					      memory_object_size_t,
					      vm_prot_t);
extern kern_return_t device_pager_synchronize(memory_object_t,
					      memory_object_offset_t,
					      memory_object_size_t,
					      vm_sync_t);
extern kern_return_t device_pager_map(memory_object_t, vm_prot_t);
extern kern_return_t device_pager_last_unmap(memory_object_t);
extern kern_return_t device_pager_populate_object(
	memory_object_t		device,
	memory_object_offset_t	offset,
	ppnum_t			page_num,
	vm_size_t		size);
extern memory_object_t device_pager_setup(
	memory_object_t,
	uintptr_t,
	vm_size_t,
	int);
extern void device_pager_bootstrap(void);
extern boolean_t is_device_pager_ops(const struct memory_object_pager_ops *pager_ops);

extern kern_return_t pager_map_to_phys_contiguous(
	memory_object_control_t	object,
	memory_object_offset_t	offset,
	addr64_t		base_vaddr,
	vm_size_t		size);

extern kern_return_t memory_object_create_named(
	memory_object_t	pager,
	memory_object_offset_t	size,
	memory_object_control_t		*control);

struct macx_triggers_args;
extern int mach_macx_triggers(
	struct macx_triggers_args	*args);

extern int macx_swapinfo(
	memory_object_size_t	*total_p,
	memory_object_size_t	*avail_p,
	vm_size_t		*pagesize_p,
	boolean_t		*encrypted_p);

extern void log_stack_execution_failure(addr64_t vaddr, vm_prot_t prot);
extern void log_unnest_badness(
	vm_map_t map,
	vm_map_offset_t start_unnest,
	vm_map_offset_t end_unnest,
	boolean_t is_nested_map,
	vm_map_offset_t lowest_unnestable_addr);

struct proc;
extern int cs_allow_invalid(struct proc *p);
extern int cs_invalid_page(addr64_t vaddr, boolean_t *cs_killed);

#define CS_VALIDATE_TAINTED	0x00000001
#define CS_VALIDATE_NX		0x00000002
extern boolean_t cs_validate_range(struct vnode *vp,
				   memory_object_t pager,
				   memory_object_offset_t offset,
				   const void *data,
				   vm_size_t size,
				   unsigned *result);

extern kern_return_t mach_memory_entry_purgable_control(
	ipc_port_t	entry_port,
	vm_purgable_t	control,
	int		*state);

extern kern_return_t mach_memory_entry_get_page_counts(
	ipc_port_t	entry_port,
	unsigned int	*resident_page_count,
	unsigned int	*dirty_page_count);

extern kern_return_t mach_memory_entry_page_op(
	ipc_port_t		entry_port,
	vm_object_offset_t	offset,
	int			ops,
	ppnum_t			*phys_entry,
	int			*flags);

extern kern_return_t mach_memory_entry_range_op(
	ipc_port_t		entry_port,
	vm_object_offset_t	offset_beg,
	vm_object_offset_t	offset_end,
	int                     ops,
	int                     *range);

extern void mach_memory_entry_port_release(ipc_port_t port);
extern void mach_destroy_memory_entry(ipc_port_t port);
extern kern_return_t mach_memory_entry_allocate(
	struct vm_named_entry **user_entry_p,
	ipc_port_t *user_handle_p);

extern void vm_paging_map_init(void);

extern int macx_backing_store_compaction(int flags);
extern unsigned int mach_vm_ctl_page_free_wanted(void);

extern int no_paging_space_action(void);

#define VM_TOGGLE_CLEAR		0
#define VM_TOGGLE_SET		1
#define VM_TOGGLE_GETVALUE	999
int vm_toggle_entry_reuse(int, int*);

#define	SWAP_WRITE		0x00000000	/* Write buffer (pseudo flag). */
#define	SWAP_READ		0x00000001	/* Read buffer. */
#define	SWAP_ASYNC		0x00000002	/* Start I/O, do not wait. */

extern void vm_compressor_pager_init(void);
extern kern_return_t compressor_memory_object_create(
	memory_object_size_t,
	memory_object_t *);

extern boolean_t vm_compressor_low_on_space(void);
extern int	 vm_swap_low_on_space(void);

#if CONFIG_JETSAM
extern int proc_get_memstat_priority(struct proc*, boolean_t);
#endif /* CONFIG_JETSAM */

/* the object purger. purges the next eligible object from memory. */
/* returns TRUE if an object was purged, otherwise FALSE. */
boolean_t vm_purgeable_object_purge_one_unlocked(int force_purge_below_group);
void vm_purgeable_disown(task_t task);

struct trim_list {
	uint64_t	tl_offset;
	uint64_t	tl_length;
	struct trim_list *tl_next;
};

u_int32_t vnode_trim_list(struct vnode *vp, struct trim_list *tl, boolean_t route_only);

#define MAX_SWAPFILENAME_LEN	1024
#define SWAPFILENAME_INDEX_LEN	2	/* Doesn't include the terminating NULL character */

extern char	swapfilename[MAX_SWAPFILENAME_LEN + 1];

struct vm_counters {
	unsigned int	do_collapse_compressor;
	unsigned int	do_collapse_compressor_pages;
	unsigned int	do_collapse_terminate;
	unsigned int	do_collapse_terminate_failure;
	unsigned int	should_cow_but_wired;
	unsigned int	create_upl_extra_cow;
	unsigned int	create_upl_extra_cow_pages;
	unsigned int	create_upl_lookup_failure_write;
	unsigned int	create_upl_lookup_failure_copy;
};
extern struct vm_counters vm_counters;

#if CONFIG_SECLUDED_MEMORY
struct vm_page_secluded_data {
	int	eligible_for_secluded;
	int	grab_success_free;
	int	grab_success_other;
	int	grab_failure_locked;
	int	grab_failure_state;
	int	grab_failure_dirty;
	int	grab_for_iokit;
	int	grab_for_iokit_success;
};
extern struct vm_page_secluded_data vm_page_secluded;

extern int num_tasks_can_use_secluded_mem;

/* boot-args */
extern int secluded_for_apps;
extern int secluded_for_iokit;
extern int secluded_for_filecache;
#if 11
extern int secluded_for_fbdp;
#endif

/*
 * "secluded_aging_policy" controls the aging of secluded pages:
 *
 * SECLUDED_AGING_FIFO
 * When a page eligible for the secluded queue is activated or
 * deactivated, it is inserted in the secluded queue.
 * When it get pushed out of the secluded queue, it gets freed.
 *
 * SECLUDED_AGING_ALONG_ACTIVE
 * When a page eligible for the secluded queue is activated, it is
 * inserted in the secluded queue.
 * When it gets pushed out of the secluded queue, its "referenced" bit
 * is reset and it is inserted in the inactive queue.
 *
 * SECLUDED_AGING_AFTER_INACTIVE
 * A page eligible for the secluded queue first makes its way through the
 * active and inactive queues.
 * When it is pushed out of the inactive queue without being re-activated,
 * it is inserted in the secluded queue instead of being reclaimed.
 * When it is pushed out of the secluded queue, it is either freed if it
 * hasn't been re-referenced, or re-activated if it has been re-referenced.
 *
 * SECLUDED_AGING_BEFORE_ACTIVE
 * A page eligible for the secluded queue will first make its way through
 * the secluded queue.  When it gets pushed out of the secluded queue (by
 * new secluded pages), it goes back to the normal aging path, through the
 * active queue and then the inactive queue.
 */
extern int secluded_aging_policy;
#define SECLUDED_AGING_FIFO		0
#define SECLUDED_AGING_ALONG_ACTIVE	1
#define SECLUDED_AGING_AFTER_INACTIVE	2
#define SECLUDED_AGING_BEFORE_ACTIVE	3

extern void 		memory_object_mark_eligible_for_secluded(
	memory_object_control_t		control,
	boolean_t			eligible_for_secluded);

#endif /* CONFIG_SECLUDED_MEMORY */

#ifdef __cplusplus
}
#endif

#endif	/* _VM_VM_PROTOS_H_ */

#endif	/* XNU_KERNEL_PRIVATE */
Commit	Line	Data
91447636	1	/*
2d21ac55	2	* Copyright (c) 2004-2007 Apple Inc. All rights reserved.
91447636	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
91447636	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
91447636 A	27	*/
	28
	29	#ifdef XNU_KERNEL_PRIVATE
	30
	31	#ifndef _VM_VM_PROTOS_H_
	32	#define _VM_VM_PROTOS_H_
	33
	34	#include <mach/mach_types.h>
	35	#include <kern/kern_types.h>
	36
39037602 A	37	#ifdef __cplusplus
	38	extern "C" {
	39	#endif
	40
91447636 A	41	/*
	42	* This file contains various type definitions and routine prototypes
	43	* that are needed to avoid compilation warnings for VM code (in osfmk,
	44	* default_pager and bsd).
	45	* Most of these should eventually go into more appropriate header files.
	46	*
	47	* Include it after all other header files since it doesn't include any
	48	* type definitions and it works around some conflicts with other header
	49	* files.
	50	*/
	51
	52	/*
	53	* iokit
	54	*/
	55	extern kern_return_t device_data_action(
b0d623f7	56	uintptr_t device_handle,
91447636 A	57	ipc_port_t device_pager,
	58	vm_prot_t protection,
	59	vm_object_offset_t offset,
	60	vm_size_t size);
	61
	62	extern kern_return_t device_close(
b0d623f7	63	uintptr_t device_handle);
91447636	64
39037602	65	extern boolean_t vm_swap_files_pinned(void);
91447636 A	66
	67	/*
	68	* osfmk
	69	*/
91447636 A	70	#ifndef _IPC_IPC_PORT_H_
	71	extern mach_port_name_t ipc_port_copyout_send(
	72	ipc_port_t sright,
	73	ipc_space_t space);
	74	extern task_t port_name_to_task(
	75	mach_port_name_t name);
	76	#endif /* _IPC_IPC_PORT_H_ */
	77
	78	extern ipc_space_t get_task_ipcspace(
	79	task_t t);
	80
39037602	81	#if CONFIG_MEMORYSTATUS
3e170ce0	82	extern int max_task_footprint_mb; /* Per-task limit on physical memory consumption in megabytes */
39037602	83	#endif /* CONFIG_MEMORYSTATUS */
3e170ce0	84
91447636 A	85	/* Some loose-ends VM stuff */
	86
	87	extern vm_map_t kalloc_map;
	88	extern vm_size_t msg_ool_size_small;
	89	extern vm_map_t zone_map;
	90
	91	extern void consider_machine_adjust(void);
91447636 A	92	extern vm_map_offset_t get_map_min(vm_map_t);
	93	extern vm_map_offset_t get_map_max(vm_map_t);
	94	extern vm_map_size_t get_vmmap_size(vm_map_t);
39037602	95	#if CONFIG_COREDUMP
91447636	96	extern int get_vmmap_entries(vm_map_t);
39037602 A	97	#endif
39037602 A	98	extern int get_map_nentries(vm_map_t);
91447636	99
3e170ce0	100	extern vm_map_offset_t vm_map_page_mask(vm_map_t);
39236c6e	101
39037602	102	#if CONFIG_COREDUMP
91447636	103	extern boolean_t coredumpok(vm_map_t map, vm_offset_t va);
39037602	104	#endif
91447636 A	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
593a1d5f	138	#if CONFIG_CODE_DECRYPTION
3e170ce0	139	#define VM_MAP_DEBUG_APPLE_PROTECT MACH_ASSERT
39037602 A	140	#if VM_MAP_DEBUG_APPLE_PROTECT
	141	extern int vm_map_debug_apple_protect;
	142	#endif /* VM_MAP_DEBUG_APPLE_PROTECT */
593a1d5f	143	struct pager_crypt_info;
0c530ab8	144	extern kern_return_t vm_map_apple_protected(
3e170ce0 A	145	vm_map_t map,
	146	vm_map_offset_t start,
	147	vm_map_offset_t end,
	148	vm_object_offset_t crypto_backing_offset,
	149	struct pager_crypt_info *crypt_info);
0c530ab8	150	extern void apple_protect_pager_bootstrap(void);
3e170ce0 A	151	extern memory_object_t apple_protect_pager_setup(
	152	vm_object_t backing_object,
	153	vm_object_offset_t backing_offset,
	154	vm_object_offset_t crypto_backing_offset,
	155	struct pager_crypt_info *crypt_info,
	156	vm_object_offset_t crypto_start,
	157	vm_object_offset_t crypto_end);
593a1d5f	158	#endif /* CONFIG_CODE_DECRYPTION */
0c530ab8	159
b0d623f7 A	160	struct vnode;
	161	extern void swapfile_pager_bootstrap(void);
	162	extern memory_object_t swapfile_pager_setup(struct vnode *vp);
	163	extern memory_object_control_t swapfile_pager_control(memory_object_t mem_obj);
	164
3e170ce0 A	165	#if __arm64__ \|\| ((__ARM_ARCH_7K__ >= 2) && defined(PLATFORM_WatchOS))
	166	#define SIXTEENK_PAGE_SIZE 0x4000
	167	#define SIXTEENK_PAGE_MASK 0x3FFF
	168	#define SIXTEENK_PAGE_SHIFT 14
	169	#endif /* __arm64__ \|\| ((__ARM_ARCH_7K__ >= 2) && defined(PLATFORM_WatchOS)) */
	170
91447636 A	171
	172	/*
	173	* bsd
	174	*/
	175	struct vnode;
91447636 A	176	extern void *upl_get_internal_page_list(
91447636 A	177	upl_t upl);
b0d623f7	178
fe8ab488	179	extern void vnode_setswapmount(struct vnode *);
3e170ce0	180	extern int64_t vnode_getswappin_avail(struct vnode *);
fe8ab488	181
91447636 A	182	typedef int pager_return_t;
	183	extern pager_return_t vnode_pagein(
	184	struct vnode *, upl_t,
b0d623f7 A	185	upl_offset_t, vm_object_offset_t,
b0d623f7 A	186	upl_size_t, int, int *);
91447636 A	187	extern pager_return_t vnode_pageout(
91447636 A	188	struct vnode *, upl_t,
b0d623f7 A	189	upl_offset_t, vm_object_offset_t,
b0d623f7 A	190	upl_size_t, int, int *);
6d2010ae	191	extern uint32_t vnode_trim (struct vnode *, int64_t offset, unsigned long len);
91447636 A	192	extern memory_object_t vnode_pager_setup(
	193	struct vnode *, memory_object_t);
	194	extern vm_object_offset_t vnode_pager_get_filesize(
	195	struct vnode *);
b0d623f7 A	196	extern uint32_t vnode_pager_isinuse(
b0d623f7 A	197	struct vnode *);
6d2010ae A	198	extern boolean_t vnode_pager_isSSD(
	199	struct vnode *);
	200	extern void vnode_pager_throttle(
	201	void);
39236c6e	202	extern uint32_t vnode_pager_return_throttle_io_limit(
b0d623f7	203	struct vnode *,
39236c6e	204	uint32_t *);
15129b1c	205	extern kern_return_t vnode_pager_get_name(
0c530ab8 A	206	struct vnode *vp,
0c530ab8 A	207	char *pathname,
15129b1c A	208	vm_size_t pathname_len,
	209	char *filename,
	210	vm_size_t filename_len,
	211	boolean_t *truncated_path_p);
	212	struct timespec;
	213	extern kern_return_t vnode_pager_get_mtime(
0c530ab8	214	struct vnode *vp,
15129b1c A	215	struct timespec *mtime,
15129b1c A	216	struct timespec *cs_mtime);
2d21ac55 A	217	extern kern_return_t vnode_pager_get_cs_blobs(
	218	struct vnode *vp,
	219	void **blobs);
6d2010ae	220
fe8ab488 A	221	#if CONFIG_IOSCHED
	222	void vnode_pager_issue_reprioritize_io(
	223	struct vnode *devvp,
	224	uint64_t blkno,
	225	uint32_t len,
	226	int priority);
	227	#endif
	228
6d2010ae A	229	#if CHECK_CS_VALIDATION_BITMAP
	230	/* used by the vnode_pager_cs_validation_bitmap routine*/
	231	#define CS_BITMAP_SET 1
	232	#define CS_BITMAP_CLEAR 2
	233	#define CS_BITMAP_CHECK 3
	234
	235	#endif /* CHECK_CS_VALIDATION_BITMAP */
b0d623f7	236
39236c6e	237	extern void vnode_pager_bootstrap(void);
91447636 A	238	extern kern_return_t
	239	vnode_pager_data_unlock(
	240	memory_object_t mem_obj,
	241	memory_object_offset_t offset,
b0d623f7	242	memory_object_size_t size,
91447636 A	243	vm_prot_t desired_access);
	244	extern kern_return_t vnode_pager_init(
	245	memory_object_t,
	246	memory_object_control_t,
b0d623f7	247	memory_object_cluster_size_t);
91447636 A	248	extern kern_return_t vnode_pager_get_object_size(
	249	memory_object_t,
	250	memory_object_offset_t *);
fe8ab488 A	251
	252	#if CONFIG_IOSCHED
	253	extern kern_return_t vnode_pager_get_object_devvp(
	254	memory_object_t,
	255	uintptr_t *);
	256	#endif
	257
b0d623f7 A	258	extern kern_return_t vnode_pager_get_isinuse(
	259	memory_object_t,
	260	uint32_t *);
6d2010ae A	261	extern kern_return_t vnode_pager_get_isSSD(
	262	memory_object_t,
	263	boolean_t *);
39236c6e	264	extern kern_return_t vnode_pager_get_throttle_io_limit(
b0d623f7	265	memory_object_t,
39236c6e	266	uint32_t *);
15129b1c	267	extern kern_return_t vnode_pager_get_object_name(
0c530ab8 A	268	memory_object_t mem_obj,
0c530ab8 A	269	char *pathname,
15129b1c A	270	vm_size_t pathname_len,
	271	char *filename,
	272	vm_size_t filename_len,
	273	boolean_t *truncated_path_p);
	274	extern kern_return_t vnode_pager_get_object_mtime(
0c530ab8	275	memory_object_t mem_obj,
15129b1c A	276	struct timespec *mtime,
15129b1c A	277	struct timespec *cs_mtime);
6d2010ae A	278
	279	#if CHECK_CS_VALIDATION_BITMAP
	280	extern kern_return_t vnode_pager_cs_check_validation_bitmap(
	281	memory_object_t mem_obj,
	282	memory_object_offset_t offset,
	283	int optype);
	284	#endif /CHECK_CS_VALIDATION_BITMAP/
	285
	286	extern kern_return_t ubc_cs_check_validation_bitmap (
	287	struct vnode *vp,
	288	memory_object_offset_t offset,
	289	int optype);
	290
91447636 A	291	extern kern_return_t vnode_pager_data_request(
91447636 A	292	memory_object_t,
2d21ac55	293	memory_object_offset_t,
b0d623f7	294	memory_object_cluster_size_t,
2d21ac55 A	295	vm_prot_t,
2d21ac55 A	296	memory_object_fault_info_t);
91447636 A	297	extern kern_return_t vnode_pager_data_return(
	298	memory_object_t,
	299	memory_object_offset_t,
b0d623f7	300	memory_object_cluster_size_t,
91447636 A	301	memory_object_offset_t *,
	302	int *,
	303	boolean_t,
	304	boolean_t,
	305	int);
	306	extern kern_return_t vnode_pager_data_initialize(
	307	memory_object_t,
	308	memory_object_offset_t,
b0d623f7	309	memory_object_cluster_size_t);
91447636 A	310	extern void vnode_pager_reference(
	311	memory_object_t mem_obj);
	312	extern kern_return_t vnode_pager_synchronize(
	313	memory_object_t mem_obj,
	314	memory_object_offset_t offset,
b0d623f7	315	memory_object_size_t length,
91447636	316	vm_sync_t sync_flags);
593a1d5f A	317	extern kern_return_t vnode_pager_map(
	318	memory_object_t mem_obj,
	319	vm_prot_t prot);
	320	extern kern_return_t vnode_pager_last_unmap(
91447636 A	321	memory_object_t mem_obj);
	322	extern void vnode_pager_deallocate(
	323	memory_object_t);
	324	extern kern_return_t vnode_pager_terminate(
	325	memory_object_t);
	326	extern void vnode_pager_vrele(
	327	struct vnode *vp);
	328	extern void vnode_pager_release_from_cache(
	329	int *);
39037602 A	330	extern struct vnode *vnode_pager_lookup_vnode(
	331	memory_object_t);
	332
593a1d5f A	333	extern int ubc_map(
	334	struct vnode *vp,
	335	int flags);
91447636 A	336	extern void ubc_unmap(
	337	struct vnode *vp);
	338
b0d623f7 A	339	struct vm_map_entry;
	340	extern struct vm_object find_vnode_object(struct vm_map_entry entry);
	341
91447636 A	342	extern void device_pager_reference(memory_object_t);
	343	extern void device_pager_deallocate(memory_object_t);
	344	extern kern_return_t device_pager_init(memory_object_t,
	345	memory_object_control_t,
b0d623f7	346	memory_object_cluster_size_t);
91447636 A	347	extern kern_return_t device_pager_terminate(memory_object_t);
	348	extern kern_return_t device_pager_data_request(memory_object_t,
	349	memory_object_offset_t,
b0d623f7	350	memory_object_cluster_size_t,
2d21ac55 A	351	vm_prot_t,
2d21ac55 A	352	memory_object_fault_info_t);
91447636 A	353	extern kern_return_t device_pager_data_return(memory_object_t,
91447636 A	354	memory_object_offset_t,
b0d623f7	355	memory_object_cluster_size_t,
0c530ab8 A	356	memory_object_offset_t *,
0c530ab8 A	357	int *,
91447636 A	358	boolean_t,
	359	boolean_t,
	360	int);
	361	extern kern_return_t device_pager_data_initialize(memory_object_t,
	362	memory_object_offset_t,
b0d623f7	363	memory_object_cluster_size_t);
91447636 A	364	extern kern_return_t device_pager_data_unlock(memory_object_t,
91447636 A	365	memory_object_offset_t,
b0d623f7	366	memory_object_size_t,
91447636 A	367	vm_prot_t);
	368	extern kern_return_t device_pager_synchronize(memory_object_t,
	369	memory_object_offset_t,
b0d623f7	370	memory_object_size_t,
91447636	371	vm_sync_t);
593a1d5f A	372	extern kern_return_t device_pager_map(memory_object_t, vm_prot_t);
593a1d5f A	373	extern kern_return_t device_pager_last_unmap(memory_object_t);
91447636 A	374	extern kern_return_t device_pager_populate_object(
	375	memory_object_t device,
	376	memory_object_offset_t offset,
	377	ppnum_t page_num,
	378	vm_size_t size);
	379	extern memory_object_t device_pager_setup(
	380	memory_object_t,
b0d623f7	381	uintptr_t,
91447636 A	382	vm_size_t,
91447636 A	383	int);
39236c6e	384	extern void device_pager_bootstrap(void);
39037602	385	extern boolean_t is_device_pager_ops(const struct memory_object_pager_ops *pager_ops);
39236c6e A	386
	387	extern kern_return_t pager_map_to_phys_contiguous(
	388	memory_object_control_t object,
	389	memory_object_offset_t offset,
	390	addr64_t base_vaddr,
	391	vm_size_t size);
91447636 A	392
	393	extern kern_return_t memory_object_create_named(
	394	memory_object_t pager,
	395	memory_object_offset_t size,
	396	memory_object_control_t *control);
	397
b0d623f7 A	398	struct macx_triggers_args;
	399	extern int mach_macx_triggers(
	400	struct macx_triggers_args *args);
91447636 A	401
	402	extern int macx_swapinfo(
	403	memory_object_size_t *total_p,
	404	memory_object_size_t *avail_p,
	405	vm_size_t *pagesize_p,
	406	boolean_t *encrypted_p);
	407
2d21ac55	408	extern void log_stack_execution_failure(addr64_t vaddr, vm_prot_t prot);
39037602 A	409	extern void log_unnest_badness(
	410	vm_map_t map,
	411	vm_map_offset_t start_unnest,
	412	vm_map_offset_t end_unnest,
	413	boolean_t is_nested_map,
	414	vm_map_offset_t lowest_unnestable_addr);
b0d623f7	415
39236c6e	416	struct proc;
b0d623f7	417	extern int cs_allow_invalid(struct proc *p);
39037602	418	extern int cs_invalid_page(addr64_t vaddr, boolean_t *cs_killed);
c18c124e A	419
	420	#define CS_VALIDATE_TAINTED 0x00000001
	421	#define CS_VALIDATE_NX 0x00000002
39037602 A	422	extern boolean_t cs_validate_range(struct vnode *vp,
	423	memory_object_t pager,
	424	memory_object_offset_t offset,
	425	const void *data,
	426	vm_size_t size,
	427	unsigned *result);
2d21ac55 A	428
	429	extern kern_return_t mach_memory_entry_purgable_control(
	430	ipc_port_t entry_port,
	431	vm_purgable_t control,
	432	int *state);
	433
39236c6e A	434	extern kern_return_t mach_memory_entry_get_page_counts(
	435	ipc_port_t entry_port,
	436	unsigned int *resident_page_count,
	437	unsigned int *dirty_page_count);
	438
2d21ac55 A	439	extern kern_return_t mach_memory_entry_page_op(
	440	ipc_port_t entry_port,
	441	vm_object_offset_t offset,
	442	int ops,
	443	ppnum_t *phys_entry,
	444	int *flags);
	445
	446	extern kern_return_t mach_memory_entry_range_op(
	447	ipc_port_t entry_port,
	448	vm_object_offset_t offset_beg,
	449	vm_object_offset_t offset_end,
	450	int ops,
	451	int *range);
	452
	453	extern void mach_memory_entry_port_release(ipc_port_t port);
	454	extern void mach_destroy_memory_entry(ipc_port_t port);
	455	extern kern_return_t mach_memory_entry_allocate(
	456	struct vm_named_entry **user_entry_p,
	457	ipc_port_t *user_handle_p);
	458
	459	extern void vm_paging_map_init(void);
0c530ab8	460
b0d623f7 A	461	extern int macx_backing_store_compaction(int flags);
	462	extern unsigned int mach_vm_ctl_page_free_wanted(void);
	463
fe8ab488	464	extern int no_paging_space_action(void);
6d2010ae A	465
	466	#define VM_TOGGLE_CLEAR 0
	467	#define VM_TOGGLE_SET 1
	468	#define VM_TOGGLE_GETVALUE 999
	469	int vm_toggle_entry_reuse(int, int*);
39236c6e A	470
	471	#define SWAP_WRITE 0x00000000 /* Write buffer (pseudo flag). */
	472	#define SWAP_READ 0x00000001 /* Read buffer. */
	473	#define SWAP_ASYNC 0x00000002 /* Start I/O, do not wait. */
	474
	475	extern void vm_compressor_pager_init(void);
	476	extern kern_return_t compressor_memory_object_create(
22ba694c	477	memory_object_size_t,
39236c6e A	478	memory_object_t *);
39236c6e A	479
3e170ce0 A	480	extern boolean_t vm_compressor_low_on_space(void);
	481	extern int vm_swap_low_on_space(void);
	482
fe8ab488 A	483	#if CONFIG_JETSAM
	484	extern int proc_get_memstat_priority(struct proc*, boolean_t);
	485	#endif /* CONFIG_JETSAM */
	486
39236c6e A	487	/* the object purger. purges the next eligible object from memory. */
	488	/* returns TRUE if an object was purged, otherwise FALSE. */
	489	boolean_t vm_purgeable_object_purge_one_unlocked(int force_purge_below_group);
fe8ab488	490	void vm_purgeable_disown(task_t task);
39236c6e A	491
	492	struct trim_list {
	493	uint64_t tl_offset;
	494	uint64_t tl_length;
	495	struct trim_list *tl_next;
	496	};
	497
fe8ab488 A	498	u_int32_t vnode_trim_list(struct vnode vp, struct trim_list tl, boolean_t route_only);
	499
	500	#define MAX_SWAPFILENAME_LEN 1024
	501	#define SWAPFILENAME_INDEX_LEN 2 /* Doesn't include the terminating NULL character */
	502
	503	extern char swapfilename[MAX_SWAPFILENAME_LEN + 1];
	504
	505	struct vm_counters {
	506	unsigned int do_collapse_compressor;
	507	unsigned int do_collapse_compressor_pages;
	508	unsigned int do_collapse_terminate;
	509	unsigned int do_collapse_terminate_failure;
	510	unsigned int should_cow_but_wired;
	511	unsigned int create_upl_extra_cow;
	512	unsigned int create_upl_extra_cow_pages;
	513	unsigned int create_upl_lookup_failure_write;
	514	unsigned int create_upl_lookup_failure_copy;
	515	};
	516	extern struct vm_counters vm_counters;
39236c6e	517
39037602 A	518	#if CONFIG_SECLUDED_MEMORY
	519	struct vm_page_secluded_data {
	520	int eligible_for_secluded;
	521	int grab_success_free;
	522	int grab_success_other;
	523	int grab_failure_locked;
	524	int grab_failure_state;
	525	int grab_failure_dirty;
	526	int grab_for_iokit;
	527	int grab_for_iokit_success;
	528	};
	529	extern struct vm_page_secluded_data vm_page_secluded;
	530
	531	extern int num_tasks_can_use_secluded_mem;
	532
	533	/* boot-args */
	534	extern int secluded_for_apps;
	535	extern int secluded_for_iokit;
	536	extern int secluded_for_filecache;
	537	#if 11
	538	extern int secluded_for_fbdp;
	539	#endif
	540
	541	/*
	542	* "secluded_aging_policy" controls the aging of secluded pages:
	543	*
	544	* SECLUDED_AGING_FIFO
	545	* When a page eligible for the secluded queue is activated or
	546	* deactivated, it is inserted in the secluded queue.
	547	* When it get pushed out of the secluded queue, it gets freed.
	548	*
	549	* SECLUDED_AGING_ALONG_ACTIVE
	550	* When a page eligible for the secluded queue is activated, it is
	551	* inserted in the secluded queue.
	552	* When it gets pushed out of the secluded queue, its "referenced" bit
	553	* is reset and it is inserted in the inactive queue.
	554	*
	555	* SECLUDED_AGING_AFTER_INACTIVE
	556	* A page eligible for the secluded queue first makes its way through the
	557	* active and inactive queues.
	558	* When it is pushed out of the inactive queue without being re-activated,
	559	* it is inserted in the secluded queue instead of being reclaimed.
	560	* When it is pushed out of the secluded queue, it is either freed if it
	561	* hasn't been re-referenced, or re-activated if it has been re-referenced.
	562	*
	563	* SECLUDED_AGING_BEFORE_ACTIVE
	564	* A page eligible for the secluded queue will first make its way through
	565	* the secluded queue. When it gets pushed out of the secluded queue (by
	566	* new secluded pages), it goes back to the normal aging path, through the
	567	* active queue and then the inactive queue.
	568	*/
	569	extern int secluded_aging_policy;
	570	#define SECLUDED_AGING_FIFO 0
	571	#define SECLUDED_AGING_ALONG_ACTIVE 1
	572	#define SECLUDED_AGING_AFTER_INACTIVE 2
	573	#define SECLUDED_AGING_BEFORE_ACTIVE 3
	574
	575	extern void memory_object_mark_eligible_for_secluded(
	576	memory_object_control_t control,
	577	boolean_t eligible_for_secluded);
	578
	579	#endif /* CONFIG_SECLUDED_MEMORY */
	580
	581	#ifdef __cplusplus
582	}
583	#endif
584
91447636 A	585	#endif /* _VM_VM_PROTOS_H_ */
	586
	587	#endif /* XNU_KERNEL_PRIVATE */