xref: /xnu-12377.61.12/bsd/sys/imageboot.h (revision 4d495c6e23c53686cf65f45067f79024cf5dcee8)
1*4d495c6eSApple OSS Distributions /*
2*4d495c6eSApple OSS Distributions  * Copyright (c) 2006-2021 Apple Inc. All rights reserved.
3*4d495c6eSApple OSS Distributions  *
4*4d495c6eSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*4d495c6eSApple OSS Distributions  *
6*4d495c6eSApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*4d495c6eSApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*4d495c6eSApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*4d495c6eSApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*4d495c6eSApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*4d495c6eSApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*4d495c6eSApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*4d495c6eSApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*4d495c6eSApple OSS Distributions  *
15*4d495c6eSApple OSS Distributions  * Please obtain a copy of the License at
16*4d495c6eSApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*4d495c6eSApple OSS Distributions  *
18*4d495c6eSApple OSS Distributions  * The Original Code and all software distributed under the License are
19*4d495c6eSApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*4d495c6eSApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*4d495c6eSApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*4d495c6eSApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*4d495c6eSApple OSS Distributions  * Please see the License for the specific language governing rights and
24*4d495c6eSApple OSS Distributions  * limitations under the License.
25*4d495c6eSApple OSS Distributions  *
26*4d495c6eSApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*4d495c6eSApple OSS Distributions  */
28*4d495c6eSApple OSS Distributions #ifndef _IMAGEBOOT_H_
29*4d495c6eSApple OSS Distributions #define _IMAGEBOOT_H_
30*4d495c6eSApple OSS Distributions 
31*4d495c6eSApple OSS Distributions struct vnode;
32*4d495c6eSApple OSS Distributions 
33*4d495c6eSApple OSS Distributions typedef enum imageboot_type {
34*4d495c6eSApple OSS Distributions 	IMAGEBOOT_NONE,
35*4d495c6eSApple OSS Distributions 	IMAGEBOOT_DMG,
36*4d495c6eSApple OSS Distributions 	IMAGEBOOT_LOCKER,
37*4d495c6eSApple OSS Distributions } imageboot_type_t;
38*4d495c6eSApple OSS Distributions 
39*4d495c6eSApple OSS Distributions imageboot_type_t        imageboot_needed(void);
40*4d495c6eSApple OSS Distributions bool    imageboot_desired(void);
41*4d495c6eSApple OSS Distributions void    imageboot_setup(imageboot_type_t type);
42*4d495c6eSApple OSS Distributions int     imageboot_format_is_valid(const char *root_path);
43*4d495c6eSApple OSS Distributions int     imageboot_mount_image(const char *root_path, int height, imageboot_type_t type);
44*4d495c6eSApple OSS Distributions int     imageboot_pivot_image(const char *image_path, imageboot_type_t type, const char *mount_path,
45*4d495c6eSApple OSS Distributions     const char *outgoing_root_path, const bool rooted_dmg, const bool skip_signature_check);
46*4d495c6eSApple OSS Distributions int     imageboot_read_file_pageable(const char *path, void **bufp, size_t *bufszp, bool no_softlimit); /* use kmem_free(kernel_map, ...) */
47*4d495c6eSApple OSS Distributions int     imageboot_read_file(const char *path, void **bufp, size_t *bufszp, off_t *fsizep);
48*4d495c6eSApple OSS Distributions int     imageboot_read_file_from_offset(const char *path, off_t offset, void **bufp, size_t *bufszp);
49*4d495c6eSApple OSS Distributions 
50*4d495c6eSApple OSS Distributions struct vnode *
51*4d495c6eSApple OSS Distributions imgboot_get_image_file(const char *path, off_t *fsize, int *errp);
52*4d495c6eSApple OSS Distributions 
53*4d495c6eSApple OSS Distributions #define IMAGEBOOT_CONTAINER_ARG         "container-dmg"
54*4d495c6eSApple OSS Distributions #define IMAGEBOOT_ROOT_ARG              "root-dmg"
55*4d495c6eSApple OSS Distributions #define IMAGEBOOT_AUTHROOT_ARG          "auth-root-dmg"
56*4d495c6eSApple OSS Distributions 
57*4d495c6eSApple OSS Distributions //IMAGEBOOT images are capped at 2.5GB
58*4d495c6eSApple OSS Distributions #define IMAGEBOOT_MAX_FILESIZE          (2684354560ULL)
59*4d495c6eSApple OSS Distributions //limit certain kalloc calls to 2GB
60*4d495c6eSApple OSS Distributions #define IMAGEBOOT_MAX_KALLOCSIZE        (2147483648ULL)
61*4d495c6eSApple OSS Distributions 
62*4d495c6eSApple OSS Distributions #endif
63