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

/*
 * Copyright (c) 2000-2013 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@
 */

#include <kern/kern_types.h>
#include <kern/locks.h>
#include <kern/kalloc.h>
#include <vm/vm_kern.h>
#include <mach/kern_return.h>
#include <kern/queue.h>
#include <vm/vm_pageout.h>
#include <vm/vm_protos.h>
#include <vm/vm_compressor.h>
#include <libkern/crypto/aes.h>
#include <kern/host_statistics.h>


#define SANITY_CHECK_SWAP_ROUTINES	0

#if SANITY_CHECK_SWAP_ROUTINES

#define MIN_SWAP_FILE_SIZE		(4 * 1024)

#define MAX_SWAP_FILE_SIZE		(4 * 1024)

#define	COMPRESSED_SWAP_CHUNK_SIZE	(4 * 1024)

#define VM_SWAPFILE_HIWATER_SEGS	(MIN_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)

#define SWAPFILE_RECLAIM_THRESHOLD_SEGS	(MIN_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)

#else /* SANITY_CHECK_SWAP_ROUTINES */


#define MIN_SWAP_FILE_SIZE		(256 * 1024 * 1024)

#define MAX_SWAP_FILE_SIZE		(1 * 1024 * 1024 * 1024)


#define	COMPRESSED_SWAP_CHUNK_SIZE	(C_SEG_BUFSIZE)

#define VM_SWAPFILE_HIWATER_SEGS	(MIN_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)

#define SWAPFILE_RECLAIM_THRESHOLD_SEGS	((15 * (MAX_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)) / 10)

#endif /* SANITY_CHECK_SWAP_ROUTINES */

#define SWAP_FILE_NAME		"/var/vm/swapfile"
#define SWAPFILENAME_LEN	(int)(strlen(SWAP_FILE_NAME))
#define SWAPFILENAME_INDEX_LEN	2	/* Doesn't include the terminating NULL character */

#define SWAP_SLOT_MASK		0x1FFFFFFFF
#define SWAP_DEVICE_SHIFT	33

extern int		vm_num_swap_files;
extern boolean_t	vm_swap_up;

struct swapfile;
lck_grp_attr_t	vm_swap_data_lock_grp_attr;
lck_grp_t	vm_swap_data_lock_grp;
lck_attr_t	vm_swap_data_lock_attr;
lck_mtx_ext_t	vm_swap_data_lock_ext;
lck_mtx_t	vm_swap_data_lock;

void vm_swap_init(void);
boolean_t vm_swap_create_file(void);
kern_return_t vm_swap_put(vm_offset_t, uint64_t*, uint64_t, c_segment_t);
void vm_swap_flush(void);
void vm_swap_reclaim(void);
void vm_swap_encrypt(c_segment_t);
uint64_t vm_swap_get_total_space(void);
uint64_t vm_swap_get_used_space(void);
uint64_t vm_swap_get_free_space(void);

struct vnode;
extern void vm_swapfile_open(const char *path, struct vnode **vp);
extern void vm_swapfile_close(uint64_t path, struct vnode *vp);
extern int vm_swapfile_preallocate(struct vnode *vp, uint64_t *size);
extern uint64_t vm_swapfile_get_blksize(struct vnode *vp);
extern uint64_t vm_swapfile_get_transfer_size(struct vnode *vp);
extern int vm_swapfile_io(struct vnode *vp, uint64_t offset, uint64_t start, int npages, int flags);
Commit	Line	Data
39236c6e A	1	/*
	2	* Copyright (c) 2000-2013 Apple Inc. All rights reserved.
	3	*
	4	* @APPLE_OSREFERENCE_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. 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.
	14	*
	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
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	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.
	25	*
	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
	27	*/
	28
	29	#include <kern/kern_types.h>
	30	#include <kern/locks.h>
	31	#include <kern/kalloc.h>
	32	#include <vm/vm_kern.h>
	33	#include <mach/kern_return.h>
	34	#include <kern/queue.h>
	35	#include <vm/vm_pageout.h>
	36	#include <vm/vm_protos.h>
	37	#include <vm/vm_compressor.h>
	38	#include <libkern/crypto/aes.h>
	39	#include <kern/host_statistics.h>
	40
	41
	42	#define SANITY_CHECK_SWAP_ROUTINES 0
	43
	44	#if SANITY_CHECK_SWAP_ROUTINES
	45
	46	#define MIN_SWAP_FILE_SIZE (4 * 1024)
	47
	48	#define MAX_SWAP_FILE_SIZE (4 * 1024)
	49
	50	#define COMPRESSED_SWAP_CHUNK_SIZE (4 * 1024)
	51
	52	#define VM_SWAPFILE_HIWATER_SEGS (MIN_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)
	53
	54	#define SWAPFILE_RECLAIM_THRESHOLD_SEGS (MIN_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)
	55
	56	#else /* SANITY_CHECK_SWAP_ROUTINES */
	57
	58
	59	#define MIN_SWAP_FILE_SIZE (256 * 1024 * 1024)
	60
	61	#define MAX_SWAP_FILE_SIZE (1 * 1024 * 1024 * 1024)
	62
	63
	64	#define COMPRESSED_SWAP_CHUNK_SIZE (C_SEG_BUFSIZE)
65
66	#define VM_SWAPFILE_HIWATER_SEGS (MIN_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)
67
68	#define SWAPFILE_RECLAIM_THRESHOLD_SEGS ((15 * (MAX_SWAP_FILE_SIZE / COMPRESSED_SWAP_CHUNK_SIZE)) / 10)
69
70	#endif /* SANITY_CHECK_SWAP_ROUTINES */
71
72	#define SWAP_FILE_NAME "/var/vm/swapfile"
73	#define SWAPFILENAME_LEN (int)(strlen(SWAP_FILE_NAME))
74	#define SWAPFILENAME_INDEX_LEN 2 /* Doesn't include the terminating NULL character */
75
76	#define SWAP_SLOT_MASK 0x1FFFFFFFF
77	#define SWAP_DEVICE_SHIFT 33
78
79	extern int vm_num_swap_files;
80	extern boolean_t vm_swap_up;
81
82	struct swapfile;
83	lck_grp_attr_t vm_swap_data_lock_grp_attr;
84	lck_grp_t vm_swap_data_lock_grp;
85	lck_attr_t vm_swap_data_lock_attr;
86	lck_mtx_ext_t vm_swap_data_lock_ext;
87	lck_mtx_t vm_swap_data_lock;
88
89	void vm_swap_init(void);
90	boolean_t vm_swap_create_file(void);
91	kern_return_t vm_swap_put(vm_offset_t, uint64_t*, uint64_t, c_segment_t);
92	void vm_swap_flush(void);
93	void vm_swap_reclaim(void);
94	void vm_swap_encrypt(c_segment_t);
95	uint64_t vm_swap_get_total_space(void);
96	uint64_t vm_swap_get_used_space(void);
97	uint64_t vm_swap_get_free_space(void);
98
99	struct vnode;
100	extern void vm_swapfile_open(const char path, struct vnode *vp);
101	extern void vm_swapfile_close(uint64_t path, struct vnode *vp);
102	extern int vm_swapfile_preallocate(struct vnode vp, uint64_t size);
103	extern uint64_t vm_swapfile_get_blksize(struct vnode *vp);
104	extern uint64_t vm_swapfile_get_transfer_size(struct vnode *vp);
105	extern int vm_swapfile_io(struct vnode *vp, uint64_t offset, uint64_t start, int npages, int flags);
106
107