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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use crate::granule::GRANULE_SIZE;
use crate::granule::{set_granule, GranuleState};
use crate::mm::translation::PageTable;
use crate::realm::mm::address::GuestPhysAddr;
use crate::realm::mm::page_table::pte::attribute;
use crate::realm::mm::page_table::pte::{permission, shareable};
use crate::realm::mm::stage2_tte::{desc_type, invalid_hipas, invalid_ripas};
use crate::realm::mm::stage2_tte::{RttPage, INVALID_UNPROTECTED, S2TTE};
use crate::rmi::error::Error;
use crate::rmi::realm::Rd;
use crate::rmi::rtt::RTT_PAGE_LEVEL;
use crate::rmi::rtt::S2TTE_STRIDE;
use crate::rmi::rtt_entry_state;
use crate::{get_granule, get_granule_if};
use armv9a::bits_in_reg;

pub fn create(rd: &Rd, rtt_addr: usize, ipa: usize, level: usize) -> Result<(), Error> {
    let mut rtt_granule = get_granule_if!(rtt_addr, GranuleState::Delegated)?;
    let s2tt = rtt_granule.content_mut::<RttPage>();

    let (parent_s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level - 1, Error::RmiErrorInput)?;

    if last_level != level - 1 {
        return Err(Error::RmiErrorRtt(last_level));
    }

    let s2tt_len = s2tt.len();
    if parent_s2tte.is_unassigned() {
        if parent_s2tte.is_invalid_ripas() {
            panic!("invalid ripas");
        }
        let ripas = parent_s2tte.get_ripas();
        let mut new_s2tte = bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::UNASSIGNED);
        if ripas == invalid_ripas::EMPTY {
            new_s2tte |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::EMPTY);
        } else if ripas == invalid_ripas::RAM {
            new_s2tte |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::RAM);
        } else {
            panic!("Unexpected ripas:{}", ripas);
        }

        for i in 0..s2tt_len {
            if let Some(elem) = s2tt.get_mut(i) {
                *elem = new_s2tte;
            }
        }
    } else if parent_s2tte.is_destroyed() {
        let new_s2tte = bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::DESTROYED);
        for i in 0..s2tt_len {
            if let Some(elem) = s2tt.get_mut(i) {
                *elem = new_s2tte;
            }
        }
    } else if parent_s2tte.is_assigned() {
        let mut pa: usize = parent_s2tte
            .address(level - 1)
            .ok_or(Error::RmiErrorRtt(0))?
            .into(); //XXX: check this again
        let map_size = match level {
            3 => GRANULE_SIZE, // 4096
            2 => GRANULE_SIZE << S2TTE_STRIDE,
            1 => GRANULE_SIZE << (S2TTE_STRIDE * 2),
            0 => GRANULE_SIZE << (S2TTE_STRIDE * 3),
            _ => unreachable!(),
        };
        let mut flags = bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::ASSIGNED);
        flags |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::EMPTY);
        let mut new_s2tte = pa as u64 | flags;
        for i in 0..s2tt_len {
            if let Some(elem) = s2tt.get_mut(i) {
                *elem = new_s2tte;
            }
            pa += map_size;
            new_s2tte = pa as u64 | flags;
        }
    } else if parent_s2tte.is_valid(level - 1, false) {
        unimplemented!();
    } else if parent_s2tte.is_valid(level - 1, true) {
        unimplemented!();
    } else if parent_s2tte.is_table(level - 1) {
        return Err(Error::RmiErrorRtt(level - 1));
    } else {
        panic!("Unexpected s2tte value:{:X}", parent_s2tte.get());
    }

    set_granule(&mut rtt_granule, GranuleState::RTT)?;

    let parent_s2tte = rtt_addr as u64 | bits_in_reg(S2TTE::DESC_TYPE, desc_type::L012_TABLE);
    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level - 1, parent_s2tte)?;

    // The below is added to avoid a fault regarding the RTT entry
    PageTable::get_ref().map(rtt_addr, true);

    Ok(())
}

pub fn destroy(rd: &Rd, rtt_addr: usize, ipa: usize, level: usize) -> Result<(), Error> {
    let (parent_s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level - 1, Error::RmiErrorRtt(0))?;

    if last_level != level - 1 {
        return Err(Error::RmiErrorRtt(last_level));
    }

    if !parent_s2tte.is_table(level - 1) {
        return Err(Error::RmiErrorRtt(level - 1));
    }

    let pa_table = parent_s2tte
        .address(RTT_PAGE_LEVEL)
        .ok_or(Error::RmiErrorInput)?
        .try_into()
        .or(Err(Error::RmiErrorInput))?;
    if rtt_addr != pa_table {
        return Err(Error::RmiErrorInput);
    }

    let mut g_rtt = get_granule_if!(rtt_addr, GranuleState::RTT)?;

    let parent_s2tte = if rd.addr_in_par(ipa) {
        bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::DESTROYED)
    } else {
        INVALID_UNPROTECTED
    };

    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level - 1, parent_s2tte)?;

    set_granule(&mut g_rtt, GranuleState::Delegated)?;
    Ok(())
}

pub fn init_ripas(rd: &Rd, ipa: usize, level: usize) -> Result<(), Error> {
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level));
    }

    if s2tte.is_table(level) || !s2tte.is_unassigned() {
        return Err(Error::RmiErrorRtt(level));
    }

    let mut new_s2tte = s2tte.get();
    new_s2tte |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::RAM);

    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;

    Ok(())
}

pub fn get_ripas(rd: &Rd, ipa: usize, level: usize) -> Result<u64, Error> {
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level));
    }

    if s2tte.is_destroyed() {
        error!("The s2tte is destroyed: {:x}", s2tte.get());
        return Err(Error::RmiErrorRtt(last_level));
    }
    Ok(s2tte.get_ripas())
}

pub fn read_entry(rd: &Rd, ipa: usize, level: usize) -> Result<[usize; 4], Error> {
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    let r1 = last_level;
    let (mut r2, mut r3, mut r4) = (0, 0, 0);

    if s2tte.is_unassigned() {
        let ripas = s2tte.get_masked_value(S2TTE::INVALID_RIPAS);
        r2 = rtt_entry_state::RMI_UNASSIGNED;
        r4 = ripas as usize;
    } else if s2tte.is_destroyed() {
        r2 = rtt_entry_state::RMI_DESTROYED;
    } else if s2tte.is_assigned() {
        r2 = rtt_entry_state::RMI_ASSIGNED;
        r3 = s2tte
            .address(last_level)
            .ok_or(Error::RmiErrorRtt(0))?
            .into(); //XXX: check this again
        r4 = invalid_ripas::EMPTY as usize;
    } else if s2tte.is_valid(last_level, false) {
        r2 = rtt_entry_state::RMI_ASSIGNED;
        r3 = s2tte
            .address(last_level)
            .ok_or(Error::RmiErrorRtt(0))?
            .into(); //XXX: check this again
        r4 = invalid_ripas::RAM as usize;
    } else if s2tte.is_valid(last_level, true) {
        r2 = rtt_entry_state::RMI_VALID_NS;
        let addr_mask = match level {
            1 => S2TTE::ADDR_L1_PAGE,
            2 => S2TTE::ADDR_L2_PAGE,
            3 => S2TTE::ADDR_L3_PAGE,
            _ => {
                return Err(Error::RmiErrorRtt(0)); //XXX: check this again
            }
        };
        let mask = addr_mask | S2TTE::MEMATTR | S2TTE::AP | S2TTE::SH;
        r3 = (s2tte.get() & mask) as usize;
    } else if s2tte.is_table(last_level) {
        r2 = rtt_entry_state::RMI_TABLE;
        r3 = s2tte
            .address(RTT_PAGE_LEVEL)
            .ok_or(Error::RmiErrorRtt(0))?
            .into(); //XXX: check this again
    } else {
        error!("Unexpected S2TTE value retrieved!");
    }
    Ok([r1, r2, r3, r4])
}

pub fn map_unprotected(rd: &Rd, ipa: usize, level: usize, host_s2tte: usize) -> Result<(), Error> {
    if rd.addr_in_par(ipa) {
        return Err(Error::RmiErrorInput);
    }

    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level));
    }

    if !s2tte.is_unassigned() {
        return Err(Error::RmiErrorRtt(level));
    }

    let mut new_s2tte = host_s2tte as u64;
    if level == RTT_PAGE_LEVEL {
        new_s2tte |= bits_in_reg(S2TTE::NS, 1)
            | bits_in_reg(S2TTE::XN, 1)
            | bits_in_reg(S2TTE::AF, 1)
            | bits_in_reg(S2TTE::DESC_TYPE, desc_type::L3_PAGE);
    } else {
        new_s2tte |= bits_in_reg(S2TTE::NS, 1)
            | bits_in_reg(S2TTE::XN, 1)
            | bits_in_reg(S2TTE::AF, 1)
            | bits_in_reg(S2TTE::DESC_TYPE, desc_type::L012_BLOCK);
    }

    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;

    Ok(())
}

pub fn unmap_unprotected(rd: &Rd, ipa: usize, level: usize) -> Result<(), Error> {
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level));
    }

    if !s2tte.is_valid(level, true) {
        return Err(Error::RmiErrorRtt(level));
    }

    let new_s2tte: u64 = INVALID_UNPROTECTED;

    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;

    //TODO: add page/block invalidation

    Ok(())
}

pub fn make_shared(rd: &Rd, ipa: usize, level: usize) -> Result<(), Error> {
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level)); //XXX: check this again
    }

    // Reference (tf-rmm)      : smc_rtt_set_ripas() in runtime/rmi/rtt.c
    //           (realm-linux) : __set_memory_encrypted() in arch/arm64/mm/pageattr.c
    //           (nw-linux)    : set_ipa_state() and kvm_realm_unmap_range() in arch/arm64/kvm/rme.c
    //           (rmm-spec)    : Figure D2.1 Realm shared memory protocol flow
    if s2tte.is_valid(level, false) {
        // the case for ipa's range 0x8840_0000 - in realm-linux booting
        let pa: usize = s2tte.address(level).ok_or(Error::RmiErrorRtt(0))?.into(); //XXX: check this again
        let mut flags = 0;
        flags |= bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::ASSIGNED);
        flags |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::EMPTY);
        let new_s2tte = pa as u64 | flags;

        rd.s2_table()
            .lock()
            .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;
    } else if s2tte.is_unassigned() || s2tte.is_assigned() {
        let pa: usize = s2tte.address(level).ok_or(Error::RmiErrorRtt(0))?.into(); //XXX: check this again
        let flags = bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::EMPTY);
        let new_s2tte = pa as u64 | flags;

        rd.s2_table()
            .lock()
            .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;
    }

    Ok(())
}

pub fn make_exclusive(rd: &Rd, ipa: usize, level: usize) -> Result<(), Error> {
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level)); //XXX: check this again
    }

    if s2tte.is_valid(level, false) {
        // This condition is added with no-op for handling the `else` case
    } else if s2tte.is_unassigned() || s2tte.is_assigned() {
        let flags = bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::RAM);
        let new_s2tte = s2tte.get() | flags;

        rd.s2_table()
            .lock()
            .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;
    } else {
        return Err(Error::RmiErrorRtt(level)); //XXX: check this again
    }

    Ok(())
}

pub fn data_create(rd: &Rd, ipa: usize, target_pa: usize) -> Result<(), Error> {
    let level = RTT_PAGE_LEVEL;
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if level != last_level {
        return Err(Error::RmiErrorRtt(last_level));
    }

    if !s2tte.is_unassigned() {
        return Err(Error::RmiErrorRtt(RTT_PAGE_LEVEL));
    }

    let mut new_s2tte = target_pa as u64;
    if s2tte.is_invalid_ripas() {
        panic!("invalid ripas");
    }
    let ripas = s2tte.get_ripas();
    if ripas == invalid_ripas::EMPTY {
        new_s2tte |= bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::ASSIGNED);
        new_s2tte |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::EMPTY);
    } else if ripas == invalid_ripas::RAM {
        // S2TTE_PAGE  : S2TTE_ATTRS | S2TTE_L3_PAGE
        new_s2tte |= bits_in_reg(S2TTE::DESC_TYPE, desc_type::L3_PAGE);
        // S2TTE_ATTRS : S2TTE_MEMATTR_FWB_NORMAL_WB | S2TTE_AP_RW | S2TTE_SH_IS | S2TTE_AF
        new_s2tte |= bits_in_reg(S2TTE::MEMATTR, attribute::NORMAL_FWB);
        new_s2tte |= bits_in_reg(S2TTE::AP, permission::RW);
        new_s2tte |= bits_in_reg(S2TTE::SH, shareable::INNER);
        new_s2tte |= bits_in_reg(S2TTE::AF, 1);
    } else {
        panic!("Unexpected ripas: {}", ripas);
    }

    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;

    Ok(())
}

pub fn data_destroy(rd: &Rd, ipa: usize) -> Result<usize, Error> {
    let level = RTT_PAGE_LEVEL;
    let (s2tte, last_level) = S2TTE::get_s2tte(rd, ipa, level, Error::RmiErrorRtt(0))?;

    if last_level != level {
        return Err(Error::RmiErrorRtt(last_level));
    }

    let valid = s2tte.is_valid(last_level, false);
    if !valid && !s2tte.is_assigned() {
        return Err(Error::RmiErrorRtt(RTT_PAGE_LEVEL));
    }

    let pa = s2tte
        .address(last_level)
        .ok_or(Error::RmiErrorRtt(0))?
        .into(); //XXX: check this again

    let mut flags = 0;
    if valid {
        flags |= bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::DESTROYED);
    } else {
        flags |= bits_in_reg(S2TTE::INVALID_HIPAS, invalid_hipas::UNASSIGNED);
        flags |= bits_in_reg(S2TTE::INVALID_RIPAS, invalid_ripas::EMPTY);
    }
    let new_s2tte = flags;
    rd.s2_table()
        .lock()
        .ipa_to_pte_set(GuestPhysAddr::from(ipa), level, new_s2tte)?;

    Ok(pa)
}