hyperlight-guest-bin 0.17.0

This crate provides the opinionated bits of the guest library, such as the panic handler, the entry point, the guest logger, the exception handling logic, and third-party code used by our C-API needed to build a native hyperlight-guest binary.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

// SPDX-License-Identifier: Apache-2.0
// Copyright 2026 The Hyperlight Authors.

use core::arch::global_asm;
use core::mem::{offset_of, size_of};

use super::types::*;

const _: () = assert!(2 * size_of::<u64>() == 0x10);
const _: () = assert!(2 * size_of::<u128>() == 0x20);

// sp should already have been lowered to make room for the context
// save structure
//
// x30 should have been saved already
global_asm!("
.global context_save\n
context_save:\n
    stp  x0,  x1, [sp, #{x_off}+0x00]\n
    stp  x2,  x3, [sp, #{x_off}+0x10]\n
    stp  x4,  x5, [sp, #{x_off}+0x20]\n
    stp  x6,  x7, [sp, #{x_off}+0x30]\n
    stp  x8,  x9, [sp, #{x_off}+0x40]\n
    stp x10, x11, [sp, #{x_off}+0x50]\n
    stp x12, x13, [sp, #{x_off}+0x60]\n
    stp x14, x15, [sp, #{x_off}+0x70]\n
    stp x16, x17, [sp, #{x_off}+0x80]\n
    stp x18, x19, [sp, #{x_off}+0x90]\n
    stp x20, x21, [sp, #{x_off}+0xa0]\n
    stp x22, x23, [sp, #{x_off}+0xb0]\n
    stp x24, x25, [sp, #{x_off}+0xc0]\n
    stp x26, x27, [sp, #{x_off}+0xd0]\n
    stp x28, x29, [sp, #{x_off}+0xe0]\n
    mrs x0, fpcr\n
    mrs x1, fpsr\n
    stp x0, x1, [sp, #{fpcr_off}]\n
    stp  q0,  q1, [sp, #{q_off}+0x000]\n
    stp  q2,  q3, [sp, #{q_off}+0x020]\n
    stp  q4,  q5, [sp, #{q_off}+0x040]\n
    stp  q6,  q7, [sp, #{q_off}+0x060]\n
    stp  q8,  q9, [sp, #{q_off}+0x080]\n
    stp q10, q11, [sp, #{q_off}+0x0a0]\n
    stp q12, q13, [sp, #{q_off}+0x0c0]\n
    stp q14, q15, [sp, #{q_off}+0x0e0]\n
    stp q16, q17, [sp, #{q_off}+0x100]\n
    stp q18, q19, [sp, #{q_off}+0x120]\n
    stp q20, q21, [sp, #{q_off}+0x140]\n
    stp q22, q23, [sp, #{q_off}+0x160]\n
    stp q24, q25, [sp, #{q_off}+0x180]\n
    stp q26, q27, [sp, #{q_off}+0x1a0]\n
    stp q28, q29, [sp, #{q_off}+0x1c0]\n
    stp q30, q31, [sp, #{q_off}+0x1e0]\n
    ret
",
    x_off = const offset_of!(ExceptionContext, x),
    fpcr_off = const offset_of!(ExceptionContext, fpcr),
    q_off = const offset_of!(ExceptionContext, q),
);

global_asm!("
.global context_restore\n
context_restore:\n
    ldp x0, x1, [sp, #{fpcr_off}]\n
    msr fpcr, x0\n
    msr fpsr, x1\n
    ldp  x0,  x1, [sp, #{x_off}+0x00]\n
    ldp  x2,  x3, [sp, #{x_off}+0x10]\n
    ldp  x4,  x5, [sp, #{x_off}+0x20]\n
    ldp  x6,  x7, [sp, #{x_off}+0x30]\n
    ldp  x8,  x9, [sp, #{x_off}+0x40]\n
    ldp x10, x11, [sp, #{x_off}+0x50]\n
    ldp x12, x13, [sp, #{x_off}+0x60]\n
    ldp x14, x15, [sp, #{x_off}+0x70]\n
    ldp x16, x17, [sp, #{x_off}+0x80]\n
    ldp x18, x19, [sp, #{x_off}+0x90]\n
    ldp x20, x21, [sp, #{x_off}+0xa0]\n
    ldp x22, x23, [sp, #{x_off}+0xb0]\n
    ldp x24, x25, [sp, #{x_off}+0xc0]\n
    ldp x26, x27, [sp, #{x_off}+0xd0]\n
    ldp x28, x29, [sp, #{x_off}+0xe0]\n
    ldr x30,      [sp, #{x_off}+0xf0]\n
    ldp  q0,  q1, [sp, #{q_off}+0x000]\n
    ldp  q2,  q3, [sp, #{q_off}+0x020]\n
    ldp  q4,  q5, [sp, #{q_off}+0x040]\n
    ldp  q6,  q7, [sp, #{q_off}+0x060]\n
    ldp  q8,  q9, [sp, #{q_off}+0x080]\n
    ldp q10, q11, [sp, #{q_off}+0x0a0]\n
    ldp q12, q13, [sp, #{q_off}+0x0c0]\n
    ldp q14, q15, [sp, #{q_off}+0x0e0]\n
    ldp q16, q17, [sp, #{q_off}+0x100]\n
    ldp q18, q19, [sp, #{q_off}+0x120]\n
    ldp q20, q21, [sp, #{q_off}+0x140]\n
    ldp q22, q23, [sp, #{q_off}+0x160]\n
    ldp q24, q25, [sp, #{q_off}+0x180]\n
    ldp q26, q27, [sp, #{q_off}+0x1a0]\n
    ldp q28, q29, [sp, #{q_off}+0x1c0]\n
    ldp q30, q31, [sp, #{q_off}+0x1e0]\n
    add sp, sp, #{ctx_size}\n
    eret\n
",
    ctx_size = const size_of::<ExceptionContext>(),
    x_off = const offset_of!(ExceptionContext, x),
    fpcr_off = const offset_of!(ExceptionContext, fpcr),
    q_off = const offset_of!(ExceptionContext, q),
);

macro_rules! vbar_entry {
    ($et:literal, $ef:literal) => {
        concat!(
            "
            sub sp, sp, #{ctx_size}\n
            str x30, [sp, #{x30_off}]\n
            bl context_save\n
            mov x0, {ExceptionType_",
            $et,
            "}\n
            mov x1, {ExceptionFrom_",
            $ef,
            "}\n
            mov x2, sp\n
            bl {handler}\n
            b context_restore\n
            .balign 0x80\n
        "
        )
    };
}

global_asm!("
.balign 0x800\n
.global vbar\n
vbar:\n",
    vbar_entry!("Synchronous", "CurrentSP0"),
    vbar_entry!("IRQ", "CurrentSP0"),
    vbar_entry!("FIQ", "CurrentSP0"),
    vbar_entry!("SError", "CurrentSP0"),
    vbar_entry!("Synchronous", "CurrentSPx"),
    vbar_entry!("IRQ", "CurrentSPx"),
    vbar_entry!("FIQ", "CurrentSPx"),
    vbar_entry!("SError", "CurrentSPx"),
    vbar_entry!("Synchronous", "LowerAArch64"),
    vbar_entry!("IRQ", "LowerAArch64"),
    vbar_entry!("FIQ", "LowerAArch64"),
    vbar_entry!("SError", "LowerAArch64"),
    vbar_entry!("Synchronous", "LowerAArch32"),
    vbar_entry!("IRQ", "LowerAArch32"),
    vbar_entry!("FIQ", "LowerAArch32"),
    vbar_entry!("SError", "LowerAArch32"),
    ctx_size = const size_of::<ExceptionContext>(),
    x30_off = const offset_of!(ExceptionContext, x) + 15 * 0x010,
    handler = sym super::handle::handle_exception,
    ExceptionType_Synchronous = const ExceptionType::Synchronous as u64,
    ExceptionType_IRQ = const ExceptionType::Irq as u64,
    ExceptionType_FIQ = const ExceptionType::Fiq as u64,
    ExceptionType_SError = const ExceptionType::SError as u64,
    ExceptionFrom_CurrentSP0 = const ExceptionFrom::CurrentSP0 as u64,
    ExceptionFrom_CurrentSPx = const ExceptionFrom::CurrentSPx as u64,
    ExceptionFrom_LowerAArch64 = const ExceptionFrom::LowerAArch64 as u64,
    ExceptionFrom_LowerAArch32 = const ExceptionFrom::LowerAArch32 as u64,
);