1/*
2 * Copyright (c) 2006-2021 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#ifndef _IMAGEBOOT_H_
29#define _IMAGEBOOT_H_
30
31struct vnode;
32
33typedef enum imageboot_type {
34 IMAGEBOOT_NONE,
35 IMAGEBOOT_DMG,
36 IMAGEBOOT_LOCKER,
37} imageboot_type_t;
38
39imageboot_type_t imageboot_needed(void);
40bool imageboot_desired(void);
41void imageboot_setup(imageboot_type_t type);
42int imageboot_format_is_valid(const char *root_path);
43int imageboot_mount_image(const char *root_path, int height, imageboot_type_t type);
44int imageboot_pivot_image(const char *image_path, imageboot_type_t type, const char *mount_path,
45 const char *outgoing_root_path, const bool rooted_dmg, const bool skip_signature_check);
46int imageboot_read_file_pageable(const char *path, void **bufp, size_t *bufszp); /* use kmem_free(kernel_map, ...) */
47int imageboot_read_file(const char *path, void **bufp, size_t *bufszp, off_t *fsizep);
48int imageboot_read_file_from_offset(const char *path, off_t offset, void **bufp, size_t *bufszp);
49
50struct vnode *
51imgboot_get_image_file(const char *path, off_t *fsize, int *errp);
52
53#define IMAGEBOOT_CONTAINER_ARG "container-dmg"
54#define IMAGEBOOT_ROOT_ARG "root-dmg"
55#define IMAGEBOOT_AUTHROOT_ARG "auth-root-dmg"
56
57//IMAGEBOOT images are capped at 2.5GB
58#define IMAGEBOOT_MAX_FILESIZE (2684354560ULL)
59//limit certain kalloc calls to 2GB
60#define IMAGEBOOT_MAX_KALLOCSIZE (2147483648ULL)
61
62#endif
63