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

/*
 * Copyright (c) 1999-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@
 */
/* 
 *	Header file for Unified Buffer Cache.
 *
 */ 

#ifndef	_SYS_UBC_H_
#define	_SYS_UBC_H_

#include <sys/appleapiopts.h>
#include <sys/cdefs.h>
#include <sys/kernel_types.h>
#include <kern/locks.h>
#include <mach/memory_object_types.h>


/* defns for ubc_sync_range() and ubc_msync */

#define	UBC_PUSHDIRTY	0x01	/* clean any dirty pages in the specified range to the backing store */
#define	UBC_PUSHALL	0x02	/* push both dirty and precious pages to the backing store */
#define	UBC_INVALIDATE	0x04	/* invalidate pages in the specified range... may be used with UBC_PUSHDIRTY/ALL */
#define	UBC_SYNC	0x08	/* wait for I/Os generated by UBC_PUSHDIRTY to complete */

__BEGIN_DECLS

off_t		ubc_blktooff(struct vnode *, daddr64_t);
daddr64_t	ubc_offtoblk(struct vnode *, off_t);
off_t	ubc_getsize(struct vnode *);
int	ubc_setsize(struct vnode *, off_t);

kauth_cred_t ubc_getcred(struct vnode *);
#ifdef __APPLE_API_OBSOLETE
/* This API continues to exist only until <rdar://4714366> is resolved */
int	ubc_setcred(struct vnode *, struct proc *) __deprecated;
#endif
struct thread;
int	ubc_setthreadcred(struct vnode *, struct proc *, struct thread *);

int     ubc_sync_range(vnode_t, off_t, off_t, int);
errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
int	ubc_pages_resident(vnode_t);

/* code signing */
struct cs_blob;
struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);

/* cluster IO routines */
int	advisory_read(vnode_t, off_t, off_t, int);
int	advisory_read_ext(vnode_t, off_t, off_t, int, int (*)(buf_t, void *), void *, int);

int	cluster_read(vnode_t, struct uio *, off_t, int);
int	cluster_read_ext(vnode_t, struct uio *, off_t, int, int (*)(buf_t, void *), void *);

int	cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
int	cluster_write_ext(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int, int (*)(buf_t, void *), void *);

int	cluster_pageout(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
int	cluster_pageout_ext(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);

int	cluster_pagein(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
int	cluster_pagein_ext(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);

int	cluster_push(vnode_t, int);
int	cluster_push_ext(vnode_t, int, int (*)(buf_t, void *), void *);

int	cluster_bp(buf_t);
int	cluster_bp_ext(buf_t, int (*)(buf_t, void *), void *);

void	cluster_zero(upl_t, vm_offset_t, int, buf_t);

int	cluster_copy_upl_data(uio_t, upl_t, int, int *);
int	cluster_copy_ubc_data(vnode_t, uio_t, int *, int);


/* UPL routines */
int	ubc_create_upl(vnode_t, off_t, long, upl_t *, upl_page_info_t **, int);
int	ubc_upl_map(upl_t, upl_offset_t *);
int	ubc_upl_unmap(upl_t);
int	ubc_upl_commit(upl_t);
int	ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
int	ubc_upl_abort(upl_t, int);
int	ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);

upl_page_info_t *ubc_upl_pageinfo(upl_t);
upl_size_t ubc_upl_maxbufsize(void);

__END_DECLS

#endif	/* _SYS_UBC_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 1999-2007 Apple Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	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@
1c79356b A	27	*/
1c79356b A	28	/*
1c79356b A	29	* Header file for Unified Buffer Cache.
	30	*
	31	*/
	32
	33	#ifndef _SYS_UBC_H_
	34	#define _SYS_UBC_H_
	35
9bccf70c	36	#include <sys/appleapiopts.h>
1c79356b	37	#include <sys/cdefs.h>
91447636 A	38	#include <sys/kernel_types.h>
91447636 A	39	#include <kern/locks.h>
1c79356b A	40	#include <mach/memory_object_types.h>
1c79356b A	41
1c79356b	42
91447636	43	/* defns for ubc_sync_range() and ubc_msync */
1c79356b	44
91447636 A	45	#define UBC_PUSHDIRTY 0x01 /* clean any dirty pages in the specified range to the backing store */
	46	#define UBC_PUSHALL 0x02 /* push both dirty and precious pages to the backing store */
	47	#define UBC_INVALIDATE 0x04 /* invalidate pages in the specified range... may be used with UBC_PUSHDIRTY/ALL */
	48	#define UBC_SYNC 0x08 /* wait for I/Os generated by UBC_PUSHDIRTY to complete */
1c79356b A	49
1c79356b A	50	__BEGIN_DECLS
0b4e3aa0	51
91447636 A	52	off_t ubc_blktooff(struct vnode *, daddr64_t);
	53	daddr64_t ubc_offtoblk(struct vnode *, off_t);
	54	off_t ubc_getsize(struct vnode *);
	55	int ubc_setsize(struct vnode *, off_t);
0b4e3aa0	56
2d21ac55 A	57	kauth_cred_t ubc_getcred(struct vnode *);
	58	#ifdef __APPLE_API_OBSOLETE
	59	/* This API continues to exist only until <rdar://4714366> is resolved */
	60	int ubc_setcred(struct vnode , struct proc ) __deprecated;
	61	#endif
13fec989 A	62	struct thread;
13fec989 A	63	int ubc_setthreadcred(struct vnode , struct proc , struct thread *);
1c79356b	64
91447636 A	65	int ubc_sync_range(vnode_t, off_t, off_t, int);
	66	errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
	67	int ubc_pages_resident(vnode_t);
1c79356b	68
2d21ac55 A	69	/* code signing */
2d21ac55 A	70	struct cs_blob;
2d21ac55	71	struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);
1c79356b	72
91447636 A	73	/* cluster IO routines */
91447636 A	74	int advisory_read(vnode_t, off_t, off_t, int);
2d21ac55	75	int advisory_read_ext(vnode_t, off_t, off_t, int, int ()(buf_t, void ), void *, int);
1c79356b	76
91447636	77	int cluster_read(vnode_t, struct uio *, off_t, int);
2d21ac55 A	78	int cluster_read_ext(vnode_t, struct uio , off_t, int, int ()(buf_t, void ), void );
2d21ac55 A	79
91447636	80	int cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
2d21ac55 A	81	int cluster_write_ext(vnode_t, struct uio , off_t, off_t, off_t, off_t, int, int ()(buf_t, void ), void );
2d21ac55 A	82
91447636	83	int cluster_pageout(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
2d21ac55 A	84	int cluster_pageout_ext(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int, int ()(buf_t, void ), void *);
2d21ac55 A	85
91447636	86	int cluster_pagein(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
2d21ac55 A	87	int cluster_pagein_ext(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int, int ()(buf_t, void ), void *);
2d21ac55 A	88
91447636	89	int cluster_push(vnode_t, int);
2d21ac55 A	90	int cluster_push_ext(vnode_t, int, int ()(buf_t, void ), void *);
	91
	92	int cluster_bp(buf_t);
	93	int cluster_bp_ext(buf_t, int ()(buf_t, void ), void *);
	94
	95	void cluster_zero(upl_t, vm_offset_t, int, buf_t);
	96
	97	int cluster_copy_upl_data(uio_t, upl_t, int, int *);
	98	int cluster_copy_ubc_data(vnode_t, uio_t, int *, int);
1c79356b	99
1c79356b	100
91447636 A	101	/* UPL routines */
	102	int ubc_create_upl(vnode_t, off_t, long, upl_t , upl_page_info_t *, int);
	103	int ubc_upl_map(upl_t, upl_offset_t *);
	104	int ubc_upl_unmap(upl_t);
	105	int ubc_upl_commit(upl_t);
	106	int ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
	107	int ubc_upl_abort(upl_t, int);
	108	int ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);
1c79356b	109
91447636	110	upl_page_info_t *ubc_upl_pageinfo(upl_t);
2d21ac55	111	upl_size_t ubc_upl_maxbufsize(void);
1c79356b	112
91447636	113	__END_DECLS
9bccf70c	114
1c79356b A	115	#endif /* _SYS_UBC_H_ */
1c79356b A	116