[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/machine.h>
#include <mach/memory_object_types.h>
#include <sys/ucred.h>

#ifdef KERNEL_PRIVATE
#include <sys/imgact.h>
#endif // KERNEL_PRIVATE

/* defns for ubc_msync() 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);

#ifdef KERNEL_PRIVATE

enum {
	UBC_SETSIZE_NO_FS_REENTRY = 1
};
typedef uint32_t ubc_setsize_opts_t;

errno_t ubc_setsize_ex(vnode_t vp, off_t nsize, ubc_setsize_opts_t opts);

#endif // KERNEL_PRIVATE

kauth_cred_t ubc_getcred(struct vnode *);
struct thread;
int	ubc_setthreadcred(struct vnode *, struct proc *, struct thread *);

errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
int	ubc_pages_resident(vnode_t);
int	ubc_page_op(vnode_t, off_t, int, ppnum_t *, int *);
int	ubc_range_op(vnode_t, off_t, off_t, int, int *);

#ifdef KERNEL_PRIVATE
/* This API continues to exist only until <rdar://4714366> is resolved */
int	ubc_setcred(struct vnode *, struct proc *) __deprecated;
/* code signing */
struct cs_blob;
struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);

/* apis to handle generation count for cs blob */
void cs_blob_reset_cache(void);
int ubc_cs_blob_revalidate(vnode_t, struct cs_blob *, struct image_params *, int);
int ubc_cs_generation_check(vnode_t);

int cs_entitlements_blob_get(proc_t, void **, size_t *);
int cs_blob_get(proc_t, void **, size_t *);
const char *cs_identity_get(proc_t);

#endif

/* cluster IO routines */
void    cluster_update_state(vnode_t, vm_object_offset_t, vm_object_offset_t, boolean_t);

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, upl_offset_t, off_t, int, off_t, int);
int	cluster_pageout_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);

int	cluster_pagein(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
int	cluster_pagein_ext(vnode_t, upl_t, upl_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_push_err(vnode_t, int, int (*)(buf_t, void *), void *, int *);

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

void	cluster_zero(upl_t, upl_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);

typedef struct cl_direct_read_lock cl_direct_read_lock_t;
cl_direct_read_lock_t *cluster_lock_direct_read(vnode_t vp, lck_rw_type_t exclusive);
void cluster_unlock_direct_read(cl_direct_read_lock_t *lck);

/* UPL routines */
#ifndef XNU_KERNEL_PRIVATE
int	ubc_create_upl(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int);
#endif /* XNU_KERNEL_PRIVATE */
int	ubc_upl_map(upl_t, vm_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);
void	ubc_upl_range_needed(upl_t, int, int);

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

int	is_file_clean(vnode_t, off_t);

errno_t mach_to_bsd_errno(kern_return_t mach_err);

#ifdef KERNEL_PRIVATE

int	ubc_create_upl_external(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int);
#ifdef	XNU_KERNEL_PRIVATE
int	ubc_create_upl_kernel(vnode_t, off_t, int, upl_t *, upl_page_info_t **, int, vm_tag_t);
#endif  /* XNU_KERNEL_PRIVATE */

__attribute__((pure)) boolean_t ubc_is_mapped(const struct vnode *, boolean_t *writable);
__attribute__((pure)) boolean_t ubc_is_mapped_writable(const struct vnode *);

uint32_t cluster_max_io_size(mount_t, int);

#endif

__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>
d9a64523	40	#include <mach/machine.h>
1c79356b	41	#include <mach/memory_object_types.h>
39236c6e	42	#include <sys/ucred.h>
1c79356b	43
39037602 A	44	#ifdef KERNEL_PRIVATE
	45	#include <sys/imgact.h>
	46	#endif // KERNEL_PRIVATE
	47
fe8ab488	48	/* defns for ubc_msync() and ubc_msync */
1c79356b	49
91447636 A	50	#define UBC_PUSHDIRTY 0x01 /* clean any dirty pages in the specified range to the backing store */
	51	#define UBC_PUSHALL 0x02 /* push both dirty and precious pages to the backing store */
	52	#define UBC_INVALIDATE 0x04 /* invalidate pages in the specified range... may be used with UBC_PUSHDIRTY/ALL */
	53	#define UBC_SYNC 0x08 /* wait for I/Os generated by UBC_PUSHDIRTY to complete */
1c79356b A	54
1c79356b A	55	__BEGIN_DECLS
0b4e3aa0	56
91447636 A	57	off_t ubc_blktooff(struct vnode *, daddr64_t);
	58	daddr64_t ubc_offtoblk(struct vnode *, off_t);
	59	off_t ubc_getsize(struct vnode *);
	60	int ubc_setsize(struct vnode *, off_t);
0b4e3aa0	61
fe8ab488 A	62	#ifdef KERNEL_PRIVATE
	63
	64	enum {
	65	UBC_SETSIZE_NO_FS_REENTRY = 1
	66	};
	67	typedef uint32_t ubc_setsize_opts_t;
	68
	69	errno_t ubc_setsize_ex(vnode_t vp, off_t nsize, ubc_setsize_opts_t opts);
	70
	71	#endif // KERNEL_PRIVATE
	72
2d21ac55	73	kauth_cred_t ubc_getcred(struct vnode *);
13fec989 A	74	struct thread;
13fec989 A	75	int ubc_setthreadcred(struct vnode , struct proc , struct thread *);
1c79356b	76
91447636 A	77	errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
91447636 A	78	int ubc_pages_resident(vnode_t);
b0d623f7 A	79	int ubc_page_op(vnode_t, off_t, int, ppnum_t , int );
b0d623f7 A	80	int ubc_range_op(vnode_t, off_t, off_t, int, int *);
1c79356b	81
b0d623f7 A	82	#ifdef KERNEL_PRIVATE
	83	/* This API continues to exist only until <rdar://4714366> is resolved */
	84	int ubc_setcred(struct vnode , struct proc ) __deprecated;
2d21ac55 A	85	/* code signing */
2d21ac55 A	86	struct cs_blob;
2d21ac55	87	struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);
fe8ab488 A	88
	89	/* apis to handle generation count for cs blob */
	90	void cs_blob_reset_cache(void);
39037602	91	int ubc_cs_blob_revalidate(vnode_t, struct cs_blob , struct image_params , int);
fe8ab488 A	92	int ubc_cs_generation_check(vnode_t);
fe8ab488 A	93
39236c6e A	94	int cs_entitlements_blob_get(proc_t, void *, size_t );
	95	int cs_blob_get(proc_t, void *, size_t );
	96	const char *cs_identity_get(proc_t);
3e170ce0	97
b0d623f7	98	#endif
1c79356b	99
91447636	100	/* cluster IO routines */
d9a64523 A	101	void cluster_update_state(vnode_t, vm_object_offset_t, vm_object_offset_t, boolean_t);
d9a64523 A	102
91447636	103	int advisory_read(vnode_t, off_t, off_t, int);
2d21ac55	104	int advisory_read_ext(vnode_t, off_t, off_t, int, int ()(buf_t, void ), void *, int);
1c79356b	105
91447636	106	int cluster_read(vnode_t, struct uio *, off_t, int);
2d21ac55 A	107	int cluster_read_ext(vnode_t, struct uio , off_t, int, int ()(buf_t, void ), void );
2d21ac55 A	108
91447636	109	int cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
2d21ac55 A	110	int cluster_write_ext(vnode_t, struct uio , off_t, off_t, off_t, off_t, int, int ()(buf_t, void ), void );
2d21ac55 A	111
b0d623f7 A	112	int cluster_pageout(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
b0d623f7 A	113	int cluster_pageout_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int ()(buf_t, void ), void *);
2d21ac55	114
b0d623f7 A	115	int cluster_pagein(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int);
b0d623f7 A	116	int cluster_pagein_ext(vnode_t, upl_t, upl_offset_t, off_t, int, off_t, int, int ()(buf_t, void ), void *);
2d21ac55	117
91447636	118	int cluster_push(vnode_t, int);
2d21ac55	119	int cluster_push_ext(vnode_t, int, int ()(buf_t, void ), void *);
813fb2f6	120	int cluster_push_err(vnode_t, int, int ()(buf_t, void ), void , int );
2d21ac55 A	121
	122	int cluster_bp(buf_t);
	123	int cluster_bp_ext(buf_t, int ()(buf_t, void ), void *);
	124
b0d623f7	125	void cluster_zero(upl_t, upl_offset_t, int, buf_t);
2d21ac55 A	126
	127	int cluster_copy_upl_data(uio_t, upl_t, int, int *);
	128	int cluster_copy_ubc_data(vnode_t, uio_t, int *, int);
1c79356b	129
3e170ce0 A	130	typedef struct cl_direct_read_lock cl_direct_read_lock_t;
	131	cl_direct_read_lock_t *cluster_lock_direct_read(vnode_t vp, lck_rw_type_t exclusive);
	132	void cluster_unlock_direct_read(cl_direct_read_lock_t *lck);
1c79356b	133
91447636	134	/* UPL routines */
5ba3f43e	135	#ifndef XNU_KERNEL_PRIVATE
b0d623f7	136	int ubc_create_upl(vnode_t, off_t, int, upl_t , upl_page_info_t *, int);
5ba3f43e	137	#endif /* XNU_KERNEL_PRIVATE */
b0d623f7	138	int ubc_upl_map(upl_t, vm_offset_t *);
91447636 A	139	int ubc_upl_unmap(upl_t);
	140	int ubc_upl_commit(upl_t);
	141	int ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
	142	int ubc_upl_abort(upl_t, int);
	143	int ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);
316670eb	144	void ubc_upl_range_needed(upl_t, int, int);
1c79356b	145
91447636	146	upl_page_info_t *ubc_upl_pageinfo(upl_t);
2d21ac55	147	upl_size_t ubc_upl_maxbufsize(void);
1c79356b	148
b0d623f7 A	149	int is_file_clean(vnode_t, off_t);
b0d623f7 A	150
3e170ce0 A	151	errno_t mach_to_bsd_errno(kern_return_t mach_err);
3e170ce0 A	152
39037602 A	153	#ifdef KERNEL_PRIVATE
39037602 A	154
5ba3f43e A	155	int ubc_create_upl_external(vnode_t, off_t, int, upl_t , upl_page_info_t *, int);
	156	#ifdef XNU_KERNEL_PRIVATE
	157	int ubc_create_upl_kernel(vnode_t, off_t, int, upl_t , upl_page_info_t *, int, vm_tag_t);
	158	#endif /* XNU_KERNEL_PRIVATE */
	159
39037602 A	160	__attribute__((pure)) boolean_t ubc_is_mapped(const struct vnode , boolean_t writable);
	161	__attribute__((pure)) boolean_t ubc_is_mapped_writable(const struct vnode *);
	162
	163	uint32_t cluster_max_io_size(mount_t, int);
	164
	165	#endif
	166
91447636	167	__END_DECLS
9bccf70c	168
1c79356b A	169	#endif /* _SYS_UBC_H_ */
1c79356b A	170