1/*
2 * Copyright (c) 1999-2008 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 *	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
53#include <libkern/crypto/sha1.h>
54
55
56#define UBC_INFO_NULL	((struct ubc_info *) 0)
57
58
59extern struct zone	*ubc_info_zone;
60
61/*
62 * Maximum number of vfs clusters per vnode
63 */
64#define MAX_CLUSTERS	CONFIG_MAX_CLUSTERS
65
66#define SPARSE_PUSH_LIMIT 4	/* limit on number of concurrent sparse pushes outside of the cl_lockw */
67                                /* once we reach this limit, we'll hold the lock */
68
69struct cl_extent {
70	daddr64_t	b_addr;
71	daddr64_t	e_addr;
72};
73
74struct cl_wextent {
75	daddr64_t	b_addr;
76	daddr64_t	e_addr;
77        int		io_flags;
78};
79
80struct 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
87struct cl_writebehind {
88	lck_mtx_t	cl_lockw;
89        void	*	cl_scmap;			/* pointer to sparse cluster map */
90	off_t		cl_last_write;			/* offset of the end of the last write */
91	off_t		cl_seq_written;			/* sequentially written bytes */
92	int		cl_sparse_pushes;		/* number of pushes outside of the cl_lockw in progress */
93	int		cl_sparse_wait;			/* synchronous push is in progress */
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
99struct cs_blob {
100	struct cs_blob	*csb_next;
101	cpu_type_t	csb_cpu_type;
102	unsigned int	csb_flags;
103	off_t		csb_base_offset;	/* Offset of Mach-O binary in fat binary */
104	off_t		csb_blob_offset;	/* offset of blob itself, from csb_base_offset */
105	off_t		csb_start_offset;	/* Blob coverage area start, from csb_base_offset */
106	off_t		csb_end_offset;		/* Blob coverage area end, from csb_base_offset */
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];
112	unsigned int	csb_sigpup;
113};
114
115/*
116 *	The following data structure keeps the information to associate
117 *	a vnode to the correspondig VM objects.
118 */
119struct ubc_info {
120	memory_object_t		ui_pager;	/* pager */
121	memory_object_control_t	ui_control;	/* VM control for the pager */
122	uint32_t		ui_flags;	/* flags */
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
130	struct timespec		cs_mtime;	/* modify time of file when
131						   first cs_blob was loaded */
132	struct	cs_blob		*cs_blobs; 	/* for CODE SIGNING */
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 */
140};
141
142/* Defines for ui_flags */
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 */
151#define UI_MAPPEDWRITE	0x00000080	/* it's mapped with PROT_WRITE */
152
153/*
154 * exported primitives for loadable file systems.
155 */
156
157__BEGIN_DECLS
158__private_extern__ void ubc_init(void);
159__private_extern__ int	ubc_umount(mount_t mp);
160__private_extern__ void	ubc_unmountall(void);
161__private_extern__ memory_object_t ubc_getpager(vnode_t);
162__private_extern__ void	ubc_destroy_named(vnode_t);
163
164/* internal only */
165__private_extern__ void	cluster_release(struct ubc_info *);
166__private_extern__ uint32_t cluster_max_io_size(mount_t, int);
167__private_extern__ uint32_t cluster_throttle_io_limit(vnode_t, uint32_t *);
168
169
170/* Flags for ubc_getobject() */
171#define UBC_FLAGS_NONE		0x0000
172#define UBC_HOLDOBJECT		0x0001
173#define UBC_FOR_PAGEOUT         0x0002
174
175memory_object_control_t ubc_getobject(vnode_t, int);
176boolean_t	ubc_strict_uncached_IO(vnode_t);
177
178int	ubc_info_init(vnode_t);
179int	ubc_info_init_withsize(vnode_t, off_t);
180void	ubc_info_deallocate(struct ubc_info *);
181
182int	ubc_isinuse(vnode_t, int);
183int	ubc_isinuse_locked(vnode_t, int, int);
184
185int	ubc_getcdhash(vnode_t, off_t, unsigned char *);
186
187#ifdef XNU_KERNEL_PRIVATE
188int UBCINFOEXISTS(vnode_t);
189#endif /* XNU_KERNEL_PRIVATE */
190
191/* code signing */
192struct cs_blob;
193int	ubc_cs_blob_add(vnode_t, cpu_type_t, off_t, vm_address_t, off_t, vm_size_t);
194int	ubc_cs_sigpup_add(vnode_t, vm_address_t, vm_size_t);
195struct cs_blob *ubc_get_cs_blobs(vnode_t);
196void	ubc_get_cs_mtime(vnode_t, struct timespec *);
197int	ubc_cs_getcdhash(vnode_t, off_t, unsigned char *);
198kern_return_t ubc_cs_blob_allocate(vm_offset_t *, vm_size_t *);
199void ubc_cs_blob_deallocate(vm_offset_t, vm_size_t);
200
201kern_return_t	ubc_cs_validation_bitmap_allocate( vnode_t );
202void		ubc_cs_validation_bitmap_deallocate( vnode_t );
203__END_DECLS
204
205
206#endif	/* _SYS_UBC_INTERNAL_H_ */
207
208