[apple/xnu.git] / bsd / sys / ubc_internal.h

/*
 * Copyright (c) 1999-2008 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@
 */
/* 
 *	File:	ubc.h
 *	Author:	Umesh Vaishampayan [umeshv@apple.com]
 *		05-Aug-1999	umeshv	Created.
 *
 *	Header file for Unified Buffer Cache.
 *
 */ 

#ifndef	_SYS_UBC_INTERNAL_H_
#define	_SYS_UBC_INTERNAL_H_

#include <sys/appleapiopts.h>
#include <sys/types.h>
#include <sys/kernel_types.h>
#include <sys/ucred.h>
#include <sys/vnode.h>
#include <sys/ubc.h>
#include <sys/mman.h>

#include <sys/cdefs.h>

#include <kern/locks.h>
#include <mach/memory_object_types.h>

#include <libkern/crypto/sha1.h>


#define UBC_INFO_NULL	((struct ubc_info *) 0)


extern struct zone	*ubc_info_zone;

/* 
 * Maximum number of vfs clusters per vnode
 */
#define MAX_CLUSTERS	CONFIG_MAX_CLUSTERS

#define SPARSE_PUSH_LIMIT 4	/* limit on number of concurrent sparse pushes outside of the cl_lockw */
                                /* once we reach this limit, we'll hold the lock */

struct cl_extent {
	daddr64_t	b_addr;
	daddr64_t	e_addr;
};

struct cl_wextent {
	daddr64_t	b_addr;
	daddr64_t	e_addr;
        int		io_flags;
};

struct cl_readahead {
	lck_mtx_t	cl_lockr;
	daddr64_t	cl_lastr;			/* last block read by client */
	daddr64_t	cl_maxra;			/* last block prefetched by the read ahead */
	int		cl_ralen;			/* length of last prefetch */
};

struct cl_writebehind {
	lck_mtx_t	cl_lockw;
        void	*	cl_scmap;			/* pointer to sparse cluster map */
	off_t		cl_last_write;			/* offset of the end of the last write */
	off_t		cl_seq_written;			/* sequentially written bytes */
	int		cl_sparse_pushes;		/* number of pushes outside of the cl_lockw in progress */
	int		cl_sparse_wait;			/* synchronous push is in progress */
	int		cl_number;			/* number of packed write behind clusters currently valid */
	struct cl_wextent cl_clusters[MAX_CLUSTERS];	/* packed write behind clusters */
};


struct cs_blob {
	struct cs_blob	*csb_next;
	cpu_type_t	csb_cpu_type;
	unsigned int	csb_flags;
	off_t		csb_base_offset;	/* Offset of Mach-O binary in fat binary */
	off_t		csb_blob_offset;	/* offset of blob itself, from csb_base_offset */
	off_t		csb_start_offset;	/* Blob coverage area start, from csb_base_offset */
	off_t		csb_end_offset;		/* Blob coverage area end, from csb_base_offset */
	ipc_port_t	csb_mem_handle;
	vm_size_t	csb_mem_size;
	vm_offset_t	csb_mem_offset;
	vm_address_t	csb_mem_kaddr;
	unsigned char	csb_sha1[SHA1_RESULTLEN];
	unsigned int	csb_sigpup;
};

/*
 *	The following data structure keeps the information to associate
 *	a vnode to the correspondig VM objects.
 */
struct ubc_info {
	memory_object_t		ui_pager;	/* pager */
	memory_object_control_t	ui_control;	/* VM control for the pager */
	uint32_t		ui_flags;	/* flags */
	vnode_t 		ui_vnode;	/* vnode for this ubc_info */
	kauth_cred_t	 	ui_ucred;	/* holds credentials for NFS paging */
	off_t			ui_size;	/* file size for the vnode */

        struct	cl_readahead   *cl_rahead;	/* cluster read ahead context */
        struct	cl_writebehind *cl_wbehind;	/* cluster write behind context */

	struct timespec		cs_mtime;	/* modify time of file when
						   first cs_blob was loaded */
	struct	cs_blob		*cs_blobs; 	/* for CODE SIGNING */
#if CHECK_CS_VALIDATION_BITMAP
	void			*cs_valid_bitmap;     /* right now: used only for signed files on the read-only root volume */
	uint64_t		cs_valid_bitmap_size; /* Save original bitmap size in case the file size changes.
						       * In the future, we may want to reconsider changing the
						       * underlying bitmap to reflect the new file size changes.
						       */
#endif /* CHECK_CS_VALIDATION_BITMAP */
};

/* Defines for ui_flags */
#define	UI_NONE		0x00000000	/* none */
#define	UI_HASPAGER	0x00000001	/* has a pager associated */
#define	UI_INITED	0x00000002	/* newly initialized vnode */
#define UI_HASOBJREF	0x00000004	/* hold a reference on object */
#define UI_WASMAPPED	0x00000008	/* vnode was mapped */
#define	UI_ISMAPPED	0x00000010	/* vnode is currently mapped */
#define UI_MAPBUSY	0x00000020	/* vnode is being mapped or unmapped */
#define UI_MAPWAITING	0x00000040	/* someone waiting for UI_MAPBUSY */
#define UI_MAPPEDWRITE	0x00000080	/* it's mapped with PROT_WRITE */

/*
 * exported primitives for loadable file systems.
 */

__BEGIN_DECLS
__private_extern__ void ubc_init(void);
__private_extern__ int	ubc_umount(mount_t mp);
__private_extern__ void	ubc_unmountall(void);
__private_extern__ memory_object_t ubc_getpager(vnode_t);
__private_extern__ void	ubc_destroy_named(vnode_t);

/* internal only */
__private_extern__ void	cluster_release(struct ubc_info *);
__private_extern__ uint32_t cluster_max_io_size(mount_t, int);
__private_extern__ uint32_t cluster_throttle_io_limit(vnode_t, uint32_t *);


/* Flags for ubc_getobject() */
#define UBC_FLAGS_NONE		0x0000
#define UBC_HOLDOBJECT		0x0001
#define UBC_FOR_PAGEOUT         0x0002

memory_object_control_t ubc_getobject(vnode_t, int);
boolean_t	ubc_strict_uncached_IO(vnode_t);

int	ubc_info_init(vnode_t);
int	ubc_info_init_withsize(vnode_t, off_t);
void	ubc_info_deallocate(struct ubc_info *);

int	ubc_isinuse(vnode_t, int);
int	ubc_isinuse_locked(vnode_t, int, int);

int	ubc_getcdhash(vnode_t, off_t, unsigned char *);

#ifdef XNU_KERNEL_PRIVATE
int UBCINFOEXISTS(vnode_t);
#endif /* XNU_KERNEL_PRIVATE */

/* code signing */
struct cs_blob;
int	ubc_cs_blob_add(vnode_t, cpu_type_t, off_t, vm_address_t, off_t, vm_size_t);
int	ubc_cs_sigpup_add(vnode_t, vm_address_t, vm_size_t);
struct cs_blob *ubc_get_cs_blobs(vnode_t);
void	ubc_get_cs_mtime(vnode_t, struct timespec *);
int	ubc_cs_getcdhash(vnode_t, off_t, unsigned char *);
kern_return_t ubc_cs_blob_allocate(vm_offset_t *, vm_size_t *);
void ubc_cs_blob_deallocate(vm_offset_t, vm_size_t);

kern_return_t	ubc_cs_validation_bitmap_allocate( vnode_t );
void		ubc_cs_validation_bitmap_deallocate( vnode_t );
__END_DECLS


#endif	/* _SYS_UBC_INTERNAL_H_ */
Commit	Line	Data
91447636	1	/*
b0d623f7	2	* Copyright (c) 1999-2008 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	* File: ubc.h
	30	* Author: Umesh Vaishampayan [umeshv@apple.com]
	31	* 05-Aug-1999 umeshv Created.
	32	*
	33	* Header file for Unified Buffer Cache.
	34	*
	35	*/
	36
	37	#ifndef _SYS_UBC_INTERNAL_H_
	38	#define _SYS_UBC_INTERNAL_H_
	39
	40	#include <sys/appleapiopts.h>
	41	#include <sys/types.h>
	42	#include <sys/kernel_types.h>
	43	#include <sys/ucred.h>
	44	#include <sys/vnode.h>
	45	#include <sys/ubc.h>
	46	#include <sys/mman.h>
	47
	48	#include <sys/cdefs.h>
	49
	50	#include <kern/locks.h>
	51	#include <mach/memory_object_types.h>
	52
2d21ac55 A	53	#include <libkern/crypto/sha1.h>
2d21ac55 A	54
91447636 A	55
	56	#define UBC_INFO_NULL ((struct ubc_info *) 0)
	57
	58
	59	extern struct zone *ubc_info_zone;
	60
b7266188 A	61	/*
	62	* Maximum number of vfs clusters per vnode
	63	*/
	64	#define MAX_CLUSTERS CONFIG_MAX_CLUSTERS
91447636	65
b0d623f7 A	66	#define SPARSE_PUSH_LIMIT 4 /* limit on number of concurrent sparse pushes outside of the cl_lockw */
b0d623f7 A	67	/* once we reach this limit, we'll hold the lock */
91447636 A	68
	69	struct cl_extent {
	70	daddr64_t b_addr;
	71	daddr64_t e_addr;
	72	};
	73
	74	struct cl_wextent {
	75	daddr64_t b_addr;
	76	daddr64_t e_addr;
2d21ac55	77	int io_flags;
91447636 A	78	};
	79
	80	struct cl_readahead {
	81	lck_mtx_t cl_lockr;
	82	daddr64_t cl_lastr; /* last block read by client */
	83	daddr64_t cl_maxra; /* last block prefetched by the read ahead */
	84	int cl_ralen; /* length of last prefetch */
	85	};
	86
	87	struct cl_writebehind {
	88	lck_mtx_t cl_lockw;
91447636	89	void * cl_scmap; /* pointer to sparse cluster map */
6d2010ae A	90	off_t cl_last_write; /* offset of the end of the last write */
6d2010ae A	91	off_t cl_seq_written; /* sequentially written bytes */
b0d623f7 A	92	int cl_sparse_pushes; /* number of pushes outside of the cl_lockw in progress */
b0d623f7 A	93	int cl_sparse_wait; /* synchronous push is in progress */
91447636 A	94	int cl_number; /* number of packed write behind clusters currently valid */
	95	struct cl_wextent cl_clusters[MAX_CLUSTERS]; /* packed write behind clusters */
	96	};
	97
	98
2d21ac55 A	99	struct cs_blob {
	100	struct cs_blob *csb_next;
	101	cpu_type_t csb_cpu_type;
	102	unsigned int csb_flags;
b0d623f7	103	off_t csb_base_offset; /* Offset of Mach-O binary in fat binary */
39236c6e	104	off_t csb_blob_offset; /* offset of blob itself, from csb_base_offset */
b0d623f7 A	105	off_t csb_start_offset; /* Blob coverage area start, from csb_base_offset */
b0d623f7 A	106	off_t csb_end_offset; /* Blob coverage area end, from csb_base_offset */
2d21ac55 A	107	ipc_port_t csb_mem_handle;
	108	vm_size_t csb_mem_size;
	109	vm_offset_t csb_mem_offset;
	110	vm_address_t csb_mem_kaddr;
	111	unsigned char csb_sha1[SHA1_RESULTLEN];
39236c6e	112	unsigned int csb_sigpup;
2d21ac55 A	113	};
2d21ac55 A	114
91447636 A	115	/*
	116	* The following data structure keeps the information to associate
	117	* a vnode to the correspondig VM objects.
	118	*/
	119	struct ubc_info {
2d21ac55 A	120	memory_object_t ui_pager; /* pager */
2d21ac55 A	121	memory_object_control_t ui_control; /* VM control for the pager */
b0d623f7	122	uint32_t ui_flags; /* flags */
2d21ac55 A	123	vnode_t ui_vnode; /* vnode for this ubc_info */
	124	kauth_cred_t ui_ucred; /* holds credentials for NFS paging */
	125	off_t ui_size; /* file size for the vnode */
	126
	127	struct cl_readahead cl_rahead; / cluster read ahead context */
	128	struct cl_writebehind cl_wbehind; / cluster write behind context */
	129
15129b1c A	130	struct timespec cs_mtime; /* modify time of file when
15129b1c A	131	first cs_blob was loaded */
2d21ac55	132	struct cs_blob cs_blobs; / for CODE SIGNING */
6d2010ae A	133	#if CHECK_CS_VALIDATION_BITMAP
	134	void cs_valid_bitmap; / right now: used only for signed files on the read-only root volume */
	135	uint64_t cs_valid_bitmap_size; /* Save original bitmap size in case the file size changes.
	136	* In the future, we may want to reconsider changing the
	137	* underlying bitmap to reflect the new file size changes.
	138	*/
	139	#endif /* CHECK_CS_VALIDATION_BITMAP */
91447636 A	140	};
	141
	142	/* Defines for ui_flags */
2d21ac55 A	143	#define UI_NONE 0x00000000 /* none */
	144	#define UI_HASPAGER 0x00000001 /* has a pager associated */
	145	#define UI_INITED 0x00000002 /* newly initialized vnode */
	146	#define UI_HASOBJREF 0x00000004 /* hold a reference on object */
	147	#define UI_WASMAPPED 0x00000008 /* vnode was mapped */
	148	#define UI_ISMAPPED 0x00000010 /* vnode is currently mapped */
	149	#define UI_MAPBUSY 0x00000020 /* vnode is being mapped or unmapped */
	150	#define UI_MAPWAITING 0x00000040 /* someone waiting for UI_MAPBUSY */
22ba694c	151	#define UI_MAPPEDWRITE 0x00000080 /* it's mapped with PROT_WRITE */
91447636 A	152
	153	/*
	154	* exported primitives for loadable file systems.
	155	*/
	156
	157	__BEGIN_DECLS
39236c6e	158	__private_extern__ void ubc_init(void);
2d21ac55	159	__private_extern__ int ubc_umount(mount_t mp);
91447636	160	__private_extern__ void ubc_unmountall(void);
2d21ac55	161	__private_extern__ memory_object_t ubc_getpager(vnode_t);
2d21ac55	162	__private_extern__ void ubc_destroy_named(vnode_t);
91447636 A	163
	164	/* internal only */
	165	__private_extern__ void cluster_release(struct ubc_info *);
cf7d32b8	166	__private_extern__ uint32_t cluster_max_io_size(mount_t, int);
39236c6e	167	__private_extern__ uint32_t cluster_throttle_io_limit(vnode_t, uint32_t *);
b0d623f7	168
91447636 A	169
	170	/* Flags for ubc_getobject() */
	171	#define UBC_FLAGS_NONE 0x0000
	172	#define UBC_HOLDOBJECT 0x0001
	173	#define UBC_FOR_PAGEOUT 0x0002
	174
2d21ac55	175	memory_object_control_t ubc_getobject(vnode_t, int);
6d2010ae	176	boolean_t ubc_strict_uncached_IO(vnode_t);
91447636	177
2d21ac55 A	178	int ubc_info_init(vnode_t);
	179	int ubc_info_init_withsize(vnode_t, off_t);
	180	void ubc_info_deallocate(struct ubc_info *);
91447636	181
2d21ac55 A	182	int ubc_isinuse(vnode_t, int);
2d21ac55 A	183	int ubc_isinuse_locked(vnode_t, int, int);
91447636	184
2d21ac55	185	int ubc_getcdhash(vnode_t, off_t, unsigned char *);
91447636	186
b0d623f7	187	#ifdef XNU_KERNEL_PRIVATE
91447636	188	int UBCINFOEXISTS(vnode_t);
b0d623f7	189	#endif /* XNU_KERNEL_PRIVATE */
91447636	190
593a1d5f A	191	/* code signing */
593a1d5f A	192	struct cs_blob;
39236c6e A	193	int ubc_cs_blob_add(vnode_t, cpu_type_t, off_t, vm_address_t, off_t, vm_size_t);
39236c6e A	194	int ubc_cs_sigpup_add(vnode_t, vm_address_t, vm_size_t);
593a1d5f	195	struct cs_blob *ubc_get_cs_blobs(vnode_t);
15129b1c	196	void ubc_get_cs_mtime(vnode_t, struct timespec *);
593a1d5f A	197	int ubc_cs_getcdhash(vnode_t, off_t, unsigned char *);
	198	kern_return_t ubc_cs_blob_allocate(vm_offset_t , vm_size_t );
	199	void ubc_cs_blob_deallocate(vm_offset_t, vm_size_t);
	200
6d2010ae A	201	kern_return_t ubc_cs_validation_bitmap_allocate( vnode_t );
6d2010ae A	202	void ubc_cs_validation_bitmap_deallocate( vnode_t );
91447636 A	203	__END_DECLS
	204
	205
	206	#endif /* _SYS_UBC_INTERNAL_H_ */
	207