1 /* 2 * Copyright (c) 2023 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 #pragma once 30 31 #if CONFIG_EXCLAVES 32 33 #if __has_include(<Tightbeam/tightbeam.h>) 34 35 #include <stdint.h> 36 37 #include <Tightbeam/tightbeam.h> 38 #include <Tightbeam/tightbeam_private.h> 39 40 #include "kern/exclaves.tightbeam.h" 41 42 #include "exclaves_resource.h" 43 44 __BEGIN_DECLS 45 46 /* Legacy upcall handlers */ 47 48 extern tb_error_t 49 exclaves_storage_upcall_legacy_root(const uint8_t exclaveid[_Nonnull 32], 50 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_root__result_s)); 51 52 extern tb_error_t 53 exclaves_storage_upcall_legacy_open(const enum xnuupcalls_fstag_s fstag, 54 const uint64_t rootid, const uint8_t name[_Nonnull 256], 55 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_open__result_s)); 56 57 extern tb_error_t 58 exclaves_storage_upcall_legacy_close(const enum xnuupcalls_fstag_s fstag, 59 const uint64_t fileid, 60 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_close__result_s)); 61 62 extern tb_error_t 63 exclaves_storage_upcall_legacy_create(const enum xnuupcalls_fstag_s fstag, 64 const uint64_t rootid, const uint8_t name[_Nonnull 256], 65 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_create__result_s)); 66 67 extern tb_error_t 68 exclaves_storage_upcall_legacy_read(const enum xnuupcalls_fstag_s fstag, 69 const uint64_t fileid, const struct xnuupcalls_iodesc_s * _Nonnull descriptor, 70 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_read__result_s)); 71 72 extern tb_error_t 73 exclaves_storage_upcall_legacy_write(const enum xnuupcalls_fstag_s fstag, 74 const uint64_t fileid, const struct xnuupcalls_iodesc_s * _Nonnull descriptor, 75 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_write__result_s)); 76 77 extern tb_error_t 78 exclaves_storage_upcall_legacy_remove(const enum xnuupcalls_fstag_s fstag, 79 const uint64_t rootid, const uint8_t name[_Nonnull 256], 80 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_remove__result_s)); 81 82 extern tb_error_t 83 exclaves_storage_upcall_legacy_sync(const enum xnuupcalls_fstag_s fstag, 84 const enum xnuupcalls_syncop_s op, 85 const uint64_t fileid, 86 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_sync__result_s)); 87 88 extern tb_error_t 89 exclaves_storage_upcall_legacy_readdir(const enum xnuupcalls_fstag_s fstag, 90 const uint64_t fileid, const uint64_t buf, 91 const uint32_t length, 92 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_readdir__result_s)); 93 94 extern tb_error_t 95 exclaves_storage_upcall_legacy_getsize(const enum xnuupcalls_fstag_s fstag, 96 const uint64_t fileid, 97 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_getsize__result_s)); 98 99 extern tb_error_t 100 exclaves_storage_upcall_legacy_sealstate(const enum xnuupcalls_fstag_s fstag, 101 tb_error_t (^_Nonnull completion)(xnuupcalls_xnuupcalls_sealstate__result_s)); 102 103 /* Upcall handlers */ 104 105 extern tb_error_t 106 exclaves_storage_upcall_root(const uint8_t exclaveid[_Nonnull 32], 107 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_root__result_s)); 108 109 extern tb_error_t 110 exclaves_storage_upcall_rootex(const uint32_t fstag, 111 const uint8_t exclaveid[_Nonnull 32], 112 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_rootex__result_s)); 113 114 extern tb_error_t 115 exclaves_storage_upcall_open(const uint32_t fstag, 116 const uint64_t rootid, const uint8_t name[_Nonnull 256], 117 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_open__result_s)); 118 119 extern tb_error_t 120 exclaves_storage_upcall_close(const uint32_t fstag, 121 const uint64_t fileid, 122 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_close__result_s)); 123 124 extern tb_error_t 125 exclaves_storage_upcall_create(const uint32_t fstag, 126 const uint64_t rootid, const uint8_t name[_Nonnull 256], 127 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_create__result_s)); 128 129 extern tb_error_t 130 exclaves_storage_upcall_read(const uint32_t fstag, 131 const uint64_t fileid, const struct xnuupcallsv2_iodesc_s * _Nonnull descriptor, 132 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_read__result_s)); 133 134 extern tb_error_t 135 exclaves_storage_upcall_write(const uint32_t fstag, 136 const uint64_t fileid, const struct xnuupcallsv2_iodesc_s * _Nonnull descriptor, 137 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_write__result_s)); 138 139 extern tb_error_t 140 exclaves_storage_upcall_remove(const uint32_t fstag, 141 const uint64_t rootid, const uint8_t name[_Nonnull 256], 142 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_remove__result_s)); 143 144 extern tb_error_t 145 exclaves_storage_upcall_sync(const uint32_t fstag, 146 const xnuupcallsv2_syncop_s * _Nonnull op, 147 const uint64_t fileid, 148 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_sync__result_s)); 149 150 extern tb_error_t 151 exclaves_storage_upcall_readdir(const uint32_t fstag, 152 const uint64_t fileid, const uint64_t buf, 153 const uint32_t length, 154 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_readdir__result_s)); 155 156 extern tb_error_t 157 exclaves_storage_upcall_getsize(const uint32_t fstag, 158 const uint64_t fileid, 159 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_getsize__result_s)); 160 161 extern tb_error_t 162 exclaves_storage_upcall_sealstate(const uint32_t fstag, 163 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_sealstate__result_s)); 164 165 extern tb_error_t 166 exclaves_storage_upcall_queryvolumegroup(const uint8_t vguuid[_Nonnull 37], 167 tb_error_t (^_Nonnull completion)(xnuupcallsv2_storageupcallsprivate_queryvolumegroup__result_s)); 168 169 __END_DECLS 170 171 #endif /* __has_include(<Tightbeam/tightbeam.h>) */ 172 173 #endif /* CONFIG_EXCLAVES */ 174