bsd/sys/imageboot.h

   1 /*
   2  * Copyright (c) 2006-2010 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
  31 struct kalloc_heap;
  32 struct vnode;
  33
  34 typedef enum imageboot_type {
  35         IMAGEBOOT_NONE,
  36         IMAGEBOOT_DMG,
  37         IMAGEBOOT_LOCKER,
  38 } imageboot_type_t;
  39
  40 imageboot_type_t        imageboot_needed(void);
  41 bool    imageboot_desired(void);
  42 void    imageboot_setup(imageboot_type_t type);
  43 int     imageboot_format_is_valid(const char *root_path);
  44 int     imageboot_mount_image(const char *root_path, int height, imageboot_type_t type);
  45 int     imageboot_pivot_image(const char *image_path, imageboot_type_t type, const char *mount_path, const char *outgoing_root_path, const bool rooted_dmg);
  46 int     imageboot_read_file(struct kalloc_heap *kheap, const char *path, void **bufp, size_t *bufszp);
  47 int     imageboot_read_file_from_offset(struct kalloc_heap *kheap, const char *path, off_t offset, void **bufp, size_t *bufszp);
  48
  49 struct vnode *
  50 imgboot_get_image_file(const char *path, off_t *fsize, int *errp);
  51
  52 #define IMAGEBOOT_CONTAINER_ARG         "container-dmg"
  53 #define IMAGEBOOT_ROOT_ARG              "root-dmg"
  54 #define IMAGEBOOT_AUTHROOT_ARG          "auth-root-dmg"
  55 #if CONFIG_LOCKERBOOT
  56 #define IMAGEBOOT_LOCKER_ARG "locker"
  57 #define LOCKERFS_NAME "lockerfs"
  58 #endif
  59
  60 #endif