]> git.saurik.com Git - apple/xnu.git/blame_incremental - bsd/sys/ubc.h
xnu-1228.9.59.tar.gz
[apple/xnu.git] / bsd / sys / ubc.h
... / ...
CommitLineData
1/*
2 * Copyright (c) 1999-2007 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 * Header file for Unified Buffer Cache.
30 *
31 */
32
33#ifndef _SYS_UBC_H_
34#define _SYS_UBC_H_
35
36#include <sys/appleapiopts.h>
37#include <sys/cdefs.h>
38#include <sys/kernel_types.h>
39#include <kern/locks.h>
40#include <mach/memory_object_types.h>
41
42
43/* defns for ubc_sync_range() and ubc_msync */
44
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 */
49
50__BEGIN_DECLS
51
52off_t ubc_blktooff(struct vnode *, daddr64_t);
53daddr64_t ubc_offtoblk(struct vnode *, off_t);
54off_t ubc_getsize(struct vnode *);
55int ubc_setsize(struct vnode *, off_t);
56
57kauth_cred_t ubc_getcred(struct vnode *);
58#ifdef __APPLE_API_OBSOLETE
59/* This API continues to exist only until <rdar://4714366> is resolved */
60int ubc_setcred(struct vnode *, struct proc *) __deprecated;
61#endif
62struct thread;
63int ubc_setthreadcred(struct vnode *, struct proc *, struct thread *);
64
65int ubc_sync_range(vnode_t, off_t, off_t, int);
66errno_t ubc_msync(vnode_t, off_t, off_t, off_t *, int);
67int ubc_pages_resident(vnode_t);
68
69/* code signing */
70struct cs_blob;
71struct cs_blob *ubc_cs_blob_get(vnode_t, cpu_type_t, off_t);
72
73/* cluster IO routines */
74int advisory_read(vnode_t, off_t, off_t, int);
75int advisory_read_ext(vnode_t, off_t, off_t, int, int (*)(buf_t, void *), void *, int);
76
77int cluster_read(vnode_t, struct uio *, off_t, int);
78int cluster_read_ext(vnode_t, struct uio *, off_t, int, int (*)(buf_t, void *), void *);
79
80int cluster_write(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int);
81int cluster_write_ext(vnode_t, struct uio *, off_t, off_t, off_t, off_t, int, int (*)(buf_t, void *), void *);
82
83int cluster_pageout(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
84int cluster_pageout_ext(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);
85
86int cluster_pagein(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int);
87int cluster_pagein_ext(vnode_t, upl_t, vm_offset_t, off_t, int, off_t, int, int (*)(buf_t, void *), void *);
88
89int cluster_push(vnode_t, int);
90int cluster_push_ext(vnode_t, int, int (*)(buf_t, void *), void *);
91
92int cluster_bp(buf_t);
93int cluster_bp_ext(buf_t, int (*)(buf_t, void *), void *);
94
95void cluster_zero(upl_t, vm_offset_t, int, buf_t);
96
97int cluster_copy_upl_data(uio_t, upl_t, int, int *);
98int cluster_copy_ubc_data(vnode_t, uio_t, int *, int);
99
100
101/* UPL routines */
102int ubc_create_upl(vnode_t, off_t, long, upl_t *, upl_page_info_t **, int);
103int ubc_upl_map(upl_t, upl_offset_t *);
104int ubc_upl_unmap(upl_t);
105int ubc_upl_commit(upl_t);
106int ubc_upl_commit_range(upl_t, upl_offset_t, upl_size_t, int);
107int ubc_upl_abort(upl_t, int);
108int ubc_upl_abort_range(upl_t, upl_offset_t, upl_size_t, int);
109
110upl_page_info_t *ubc_upl_pageinfo(upl_t);
111upl_size_t ubc_upl_maxbufsize(void);
112
113__END_DECLS
114
115#endif /* _SYS_UBC_H_ */
116