blob: 311f46795d26fd4461f61cabf4fdd9d4ecea8cb7 [file] [log] [blame]
Pierre-Clément Tosia0934c12022-11-25 20:54:11 +00001// Copyright 2022, The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15//! High-level FDT functions.
16
Jiyong Parkc5d2ef22023-04-11 01:23:46 +090017use crate::bootargs::BootArgsIterator;
Jaewan Kim52477ae2023-11-21 21:20:52 +090018use crate::device_assignment::{DeviceAssignmentInfo, VmDtbo};
Jiyong Park00ceff32023-03-13 05:43:23 +000019use crate::helpers::GUEST_PAGE_SIZE;
Jiyong Parkc5d2ef22023-04-11 01:23:46 +090020use crate::Box;
Jiyong Park00ceff32023-03-13 05:43:23 +000021use crate::RebootReason;
Seungjae Yoo013f4c42024-01-02 13:04:19 +090022use alloc::collections::BTreeMap;
Jiyong Parke9d87e82023-03-21 19:28:40 +090023use alloc::ffi::CString;
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +000024use alloc::format;
Jiyong Parkc23426b2023-04-10 17:32:27 +090025use alloc::vec::Vec;
Jiyong Park0ee65392023-03-27 20:52:45 +090026use core::cmp::max;
27use core::cmp::min;
Pierre-Clément Tosia0934c12022-11-25 20:54:11 +000028use core::ffi::CStr;
Alice Wangabc7d632023-06-14 09:10:14 +000029use core::fmt;
Jiyong Park9c63cd12023-03-21 17:53:07 +090030use core::mem::size_of;
Pierre-Clément Tosia0934c12022-11-25 20:54:11 +000031use core::ops::Range;
Pierre-Clément Tosi1bf532b2023-11-13 11:06:20 +000032use cstr::cstr;
Jiyong Park00ceff32023-03-13 05:43:23 +000033use fdtpci::PciMemoryFlags;
34use fdtpci::PciRangeType;
35use libfdt::AddressRange;
36use libfdt::CellIterator;
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +000037use libfdt::Fdt;
38use libfdt::FdtError;
David Dai9bdb10c2024-02-01 22:42:54 -080039use libfdt::FdtNode;
Alice Wang56ec45b2023-06-15 08:30:32 +000040use libfdt::FdtNodeMut;
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +000041use libfdt::Phandle;
Jiyong Park83316122023-03-21 09:39:39 +090042use log::debug;
Jiyong Park00ceff32023-03-13 05:43:23 +000043use log::error;
Jiyong Parkc23426b2023-04-10 17:32:27 +090044use log::info;
Pierre-Clément Tosia50167b2023-05-02 13:19:29 +000045use log::warn;
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +000046use static_assertions::const_assert;
Jiyong Park00ceff32023-03-13 05:43:23 +000047use tinyvec::ArrayVec;
Alice Wanga3971062023-06-13 11:48:53 +000048use vmbase::fdt::SwiotlbInfo;
Alice Wang63f4c9e2023-06-12 09:36:43 +000049use vmbase::layout::{crosvm::MEM_START, MAX_VIRT_ADDR};
Alice Wangeacb7382023-06-05 12:53:54 +000050use vmbase::memory::SIZE_4KB;
51use vmbase::util::flatten;
Alice Wang4be4dd02023-06-07 07:50:40 +000052use vmbase::util::RangeExt as _;
Pierre-Clément Tosi0edc4d62024-02-05 14:13:53 +000053use zerocopy::AsBytes as _;
Pierre-Clément Tosia0934c12022-11-25 20:54:11 +000054
Alice Wangabc7d632023-06-14 09:10:14 +000055/// An enumeration of errors that can occur during the FDT validation.
56#[derive(Clone, Debug)]
57pub enum FdtValidationError {
58 /// Invalid CPU count.
59 InvalidCpuCount(usize),
David Dai9bdb10c2024-02-01 22:42:54 -080060 /// Invalid VCpufreq Range.
61 InvalidVcpufreq(u64, u64),
Alice Wangabc7d632023-06-14 09:10:14 +000062}
63
64impl fmt::Display for FdtValidationError {
65 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
66 match self {
67 Self::InvalidCpuCount(num_cpus) => write!(f, "Invalid CPU count: {num_cpus}"),
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +000068 Self::InvalidVcpufreq(addr, size) => {
69 write!(f, "Invalid vcpufreq region: ({addr:#x}, {size:#x})")
70 }
Alice Wangabc7d632023-06-14 09:10:14 +000071 }
72 }
73}
74
Jiyong Park6a8789a2023-03-21 14:50:59 +090075/// Extract from /config the address range containing the pre-loaded kernel. Absence of /config is
76/// not an error.
77fn read_kernel_range_from(fdt: &Fdt) -> libfdt::Result<Option<Range<usize>>> {
Jiyong Parkb87f3302023-03-21 10:03:11 +090078 let addr = cstr!("kernel-address");
79 let size = cstr!("kernel-size");
Pierre-Clément Tosic3811b82022-11-29 11:24:16 +000080
Jiyong Parkb87f3302023-03-21 10:03:11 +090081 if let Some(config) = fdt.node(cstr!("/config"))? {
Pierre-Clément Tosic3811b82022-11-29 11:24:16 +000082 if let (Some(addr), Some(size)) = (config.getprop_u32(addr)?, config.getprop_u32(size)?) {
83 let addr = addr as usize;
84 let size = size as usize;
85
86 return Ok(Some(addr..(addr + size)));
87 }
88 }
89
90 Ok(None)
91}
92
Jiyong Park6a8789a2023-03-21 14:50:59 +090093/// Extract from /chosen the address range containing the pre-loaded ramdisk. Absence is not an
94/// error as there can be initrd-less VM.
95fn read_initrd_range_from(fdt: &Fdt) -> libfdt::Result<Option<Range<usize>>> {
Jiyong Parkb87f3302023-03-21 10:03:11 +090096 let start = cstr!("linux,initrd-start");
97 let end = cstr!("linux,initrd-end");
Pierre-Clément Tosia0934c12022-11-25 20:54:11 +000098
99 if let Some(chosen) = fdt.chosen()? {
100 if let (Some(start), Some(end)) = (chosen.getprop_u32(start)?, chosen.getprop_u32(end)?) {
101 return Ok(Some((start as usize)..(end as usize)));
102 }
103 }
104
105 Ok(None)
106}
Pierre-Clément Tosidb74cb12022-12-08 13:56:25 +0000107
Jiyong Park9c63cd12023-03-21 17:53:07 +0900108fn patch_initrd_range(fdt: &mut Fdt, initrd_range: &Range<usize>) -> libfdt::Result<()> {
109 let start = u32::try_from(initrd_range.start).unwrap();
110 let end = u32::try_from(initrd_range.end).unwrap();
111
112 let mut node = fdt.chosen_mut()?.ok_or(FdtError::NotFound)?;
113 node.setprop(cstr!("linux,initrd-start"), &start.to_be_bytes())?;
114 node.setprop(cstr!("linux,initrd-end"), &end.to_be_bytes())?;
115 Ok(())
116}
117
Jiyong Parke9d87e82023-03-21 19:28:40 +0900118fn read_bootargs_from(fdt: &Fdt) -> libfdt::Result<Option<CString>> {
119 if let Some(chosen) = fdt.chosen()? {
120 if let Some(bootargs) = chosen.getprop_str(cstr!("bootargs"))? {
121 // We need to copy the string to heap because the original fdt will be invalidated
122 // by the templated DT
123 let copy = CString::new(bootargs.to_bytes()).map_err(|_| FdtError::BadValue)?;
124 return Ok(Some(copy));
125 }
126 }
127 Ok(None)
128}
129
130fn patch_bootargs(fdt: &mut Fdt, bootargs: &CStr) -> libfdt::Result<()> {
131 let mut node = fdt.chosen_mut()?.ok_or(FdtError::NotFound)?;
Jiyong Parkc5d2ef22023-04-11 01:23:46 +0900132 // This function is called before the verification is done. So, we just copy the bootargs to
133 // the new FDT unmodified. This will be filtered again in the modify_for_next_stage function
134 // if the VM is not debuggable.
Jiyong Parke9d87e82023-03-21 19:28:40 +0900135 node.setprop(cstr!("bootargs"), bootargs.to_bytes_with_nul())
136}
137
Alice Wang0d527472023-06-13 14:55:38 +0000138/// Reads and validates the memory range in the DT.
139///
140/// Only one memory range is expected with the crosvm setup for now.
141fn read_and_validate_memory_range(fdt: &Fdt) -> Result<Range<usize>, RebootReason> {
142 let mut memory = fdt.memory().map_err(|e| {
143 error!("Failed to read memory range from DT: {e}");
144 RebootReason::InvalidFdt
145 })?;
146 let range = memory.next().ok_or_else(|| {
147 error!("The /memory node in the DT contains no range.");
148 RebootReason::InvalidFdt
149 })?;
150 if memory.next().is_some() {
151 warn!(
152 "The /memory node in the DT contains more than one memory range, \
153 while only one is expected."
154 );
155 }
Jiyong Park6a8789a2023-03-21 14:50:59 +0900156 let base = range.start;
Alice Wange243d462023-06-06 15:18:12 +0000157 if base != MEM_START {
158 error!("Memory base address {:#x} is not {:#x}", base, MEM_START);
Jiyong Park00ceff32023-03-13 05:43:23 +0000159 return Err(RebootReason::InvalidFdt);
160 }
161
Jiyong Park6a8789a2023-03-21 14:50:59 +0900162 let size = range.len();
Jiyong Park00ceff32023-03-13 05:43:23 +0000163 if size % GUEST_PAGE_SIZE != 0 {
164 error!("Memory size {:#x} is not a multiple of page size {:#x}", size, GUEST_PAGE_SIZE);
165 return Err(RebootReason::InvalidFdt);
166 }
Jiyong Park00ceff32023-03-13 05:43:23 +0000167
Jiyong Park6a8789a2023-03-21 14:50:59 +0900168 if size == 0 {
169 error!("Memory size is 0");
170 return Err(RebootReason::InvalidFdt);
171 }
Alice Wang0d527472023-06-13 14:55:38 +0000172 Ok(range)
Jiyong Park00ceff32023-03-13 05:43:23 +0000173}
174
Jiyong Park9c63cd12023-03-21 17:53:07 +0900175fn patch_memory_range(fdt: &mut Fdt, memory_range: &Range<usize>) -> libfdt::Result<()> {
Pierre-Clément Tosi0edc4d62024-02-05 14:13:53 +0000176 let addr = u64::try_from(MEM_START).unwrap();
177 let size = u64::try_from(memory_range.len()).unwrap();
Jiyong Park0ee65392023-03-27 20:52:45 +0900178 fdt.node_mut(cstr!("/memory"))?
179 .ok_or(FdtError::NotFound)?
Pierre-Clément Tosi0edc4d62024-02-05 14:13:53 +0000180 .setprop_inplace(cstr!("reg"), [addr.to_be(), size.to_be()].as_bytes())
Jiyong Park9c63cd12023-03-21 17:53:07 +0900181}
182
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000183#[derive(Debug, Default)]
David Dai9bdb10c2024-02-01 22:42:54 -0800184struct CpuInfo {
185 opptable_info: Option<ArrayVec<[u64; CpuInfo::MAX_OPPTABLES]>>,
David Dai50168a32024-02-14 17:00:48 -0800186 cpu_capacity: Option<u32>,
David Dai9bdb10c2024-02-01 22:42:54 -0800187}
188
189impl CpuInfo {
David Dai622c05d2024-02-14 14:03:26 -0800190 const MAX_OPPTABLES: usize = 20;
David Dai9bdb10c2024-02-01 22:42:54 -0800191}
192
193fn read_opp_info_from(
194 opp_node: FdtNode,
195) -> libfdt::Result<ArrayVec<[u64; CpuInfo::MAX_OPPTABLES]>> {
196 let mut table = ArrayVec::new();
197 for subnode in opp_node.subnodes()? {
198 let prop = subnode.getprop_u64(cstr!("opp-hz"))?.ok_or(FdtError::NotFound)?;
199 table.push(prop);
200 }
201
202 Ok(table)
203}
Jiyong Park6a8789a2023-03-21 14:50:59 +0900204
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000205#[derive(Debug, Default)]
206struct ClusterTopology {
207 // TODO: Support multi-level clusters & threads.
208 cores: [Option<usize>; ClusterTopology::MAX_CORES_PER_CLUSTER],
209}
210
211impl ClusterTopology {
212 const MAX_CORES_PER_CLUSTER: usize = 6;
213}
214
215#[derive(Debug, Default)]
216struct CpuTopology {
217 // TODO: Support sockets.
218 clusters: [Option<ClusterTopology>; CpuTopology::MAX_CLUSTERS],
219}
220
221impl CpuTopology {
222 const MAX_CLUSTERS: usize = 3;
223}
224
225fn read_cpu_map_from(fdt: &Fdt) -> libfdt::Result<Option<BTreeMap<Phandle, (usize, usize)>>> {
226 let Some(cpu_map) = fdt.node(cstr!("/cpus/cpu-map"))? else {
227 return Ok(None);
228 };
229
230 let mut topology = BTreeMap::new();
231 for n in 0..CpuTopology::MAX_CLUSTERS {
232 let name = CString::new(format!("cluster{n}")).unwrap();
233 let Some(cluster) = cpu_map.subnode(&name)? else {
234 break;
235 };
236 for m in 0..ClusterTopology::MAX_CORES_PER_CLUSTER {
David Dai8f476cb2024-02-15 21:57:01 -0800237 let name = CString::new(format!("core{m}")).unwrap();
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000238 let Some(core) = cluster.subnode(&name)? else {
239 break;
240 };
241 let cpu = core.getprop_u32(cstr!("cpu"))?.ok_or(FdtError::NotFound)?;
242 let prev = topology.insert(cpu.try_into()?, (n, m));
243 if prev.is_some() {
244 return Err(FdtError::BadValue);
245 }
246 }
247 }
248
249 Ok(Some(topology))
250}
251
252fn read_cpu_info_from(
253 fdt: &Fdt,
254) -> libfdt::Result<(ArrayVec<[CpuInfo; DeviceTreeInfo::MAX_CPUS]>, Option<CpuTopology>)> {
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000255 let mut cpus = ArrayVec::new();
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000256
257 let cpu_map = read_cpu_map_from(fdt)?;
258 let mut topology: CpuTopology = Default::default();
259
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000260 let mut cpu_nodes = fdt.compatible_nodes(cstr!("arm,arm-v8"))?;
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000261 for (idx, cpu) in cpu_nodes.by_ref().take(cpus.capacity()).enumerate() {
David Dai50168a32024-02-14 17:00:48 -0800262 let cpu_capacity = cpu.getprop_u32(cstr!("capacity-dmips-mhz"))?;
David Dai9bdb10c2024-02-01 22:42:54 -0800263 let opp_phandle = cpu.getprop_u32(cstr!("operating-points-v2"))?;
264 let opptable_info = if let Some(phandle) = opp_phandle {
265 let phandle = phandle.try_into()?;
266 let node = fdt.node_with_phandle(phandle)?.ok_or(FdtError::NotFound)?;
267 Some(read_opp_info_from(node)?)
268 } else {
269 None
270 };
David Dai50168a32024-02-14 17:00:48 -0800271 let info = CpuInfo { opptable_info, cpu_capacity };
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000272 cpus.push(info);
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000273
274 if let Some(ref cpu_map) = cpu_map {
275 let phandle = cpu.get_phandle()?.ok_or(FdtError::NotFound)?;
David Dai8f476cb2024-02-15 21:57:01 -0800276 let (cluster, core_idx) = cpu_map.get(&phandle).ok_or(FdtError::BadValue)?;
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000277 let cluster = topology.clusters[*cluster].get_or_insert(Default::default());
David Dai8f476cb2024-02-15 21:57:01 -0800278 if cluster.cores[*core_idx].is_some() {
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000279 return Err(FdtError::BadValue);
280 }
David Dai8f476cb2024-02-15 21:57:01 -0800281 cluster.cores[*core_idx] = Some(idx);
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000282 }
Jiyong Park6a8789a2023-03-21 14:50:59 +0900283 }
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000284
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000285 if cpu_nodes.next().is_some() {
286 warn!("DT has more than {} CPU nodes: discarding extra nodes.", cpus.capacity());
287 }
288
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000289 Ok((cpus, cpu_map.map(|_| topology)))
Jiyong Park9c63cd12023-03-21 17:53:07 +0900290}
291
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000292fn validate_cpu_info(cpus: &[CpuInfo]) -> Result<(), FdtValidationError> {
293 if cpus.is_empty() {
294 return Err(FdtValidationError::InvalidCpuCount(0));
295 }
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000296 Ok(())
297}
298
David Dai9bdb10c2024-02-01 22:42:54 -0800299fn read_vcpufreq_info(fdt: &Fdt) -> libfdt::Result<Option<VcpufreqInfo>> {
Pierre-Clément Tosic37c72e2024-02-14 12:18:12 +0000300 let mut nodes = fdt.compatible_nodes(cstr!("virtual,android-v-only-cpufreq"))?;
301 let Some(node) = nodes.next() else {
302 return Ok(None);
David Dai9bdb10c2024-02-01 22:42:54 -0800303 };
304
Pierre-Clément Tosic37c72e2024-02-14 12:18:12 +0000305 if nodes.next().is_some() {
306 warn!("DT has more than 1 cpufreq node: discarding extra nodes.");
307 }
308
309 let mut regs = node.reg()?.ok_or(FdtError::NotFound)?;
310 let reg = regs.next().ok_or(FdtError::NotFound)?;
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +0000311 let size = reg.size.ok_or(FdtError::NotFound)?;
Pierre-Clément Tosic37c72e2024-02-14 12:18:12 +0000312
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +0000313 Ok(Some(VcpufreqInfo { addr: reg.addr, size }))
David Dai9bdb10c2024-02-01 22:42:54 -0800314}
315
316fn validate_vcpufreq_info(
317 vcpufreq_info: &VcpufreqInfo,
318 cpus: &[CpuInfo],
319) -> Result<(), FdtValidationError> {
320 const VCPUFREQ_BASE_ADDR: u64 = 0x1040000;
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +0000321 const VCPUFREQ_SIZE_PER_CPU: u64 = 0x8;
David Dai9bdb10c2024-02-01 22:42:54 -0800322
323 let base = vcpufreq_info.addr;
324 let size = vcpufreq_info.size;
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +0000325 let expected_size = VCPUFREQ_SIZE_PER_CPU * cpus.len() as u64;
326
327 if (base, size) != (VCPUFREQ_BASE_ADDR, expected_size) {
David Dai9bdb10c2024-02-01 22:42:54 -0800328 return Err(FdtValidationError::InvalidVcpufreq(base, size));
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +0000329 }
David Dai9bdb10c2024-02-01 22:42:54 -0800330
331 Ok(())
332}
333
334fn patch_opptable(
335 node: FdtNodeMut,
David Dai622c05d2024-02-14 14:03:26 -0800336 opptable: Option<ArrayVec<[u64; CpuInfo::MAX_OPPTABLES]>>,
David Dai9bdb10c2024-02-01 22:42:54 -0800337) -> libfdt::Result<()> {
338 let oppcompat = cstr!("operating-points-v2");
339 let next = node.next_compatible(oppcompat)?.ok_or(FdtError::NoSpace)?;
Pierre-Clément Tosic37c72e2024-02-14 12:18:12 +0000340
341 let Some(opptable) = opptable else {
342 return next.nop();
343 };
344
David Dai9bdb10c2024-02-01 22:42:54 -0800345 let mut next_subnode = next.first_subnode()?;
346
347 for entry in opptable {
348 let mut subnode = next_subnode.ok_or(FdtError::NoSpace)?;
349 subnode.setprop_inplace(cstr!("opp-hz"), &entry.to_be_bytes())?;
350 next_subnode = subnode.next_subnode()?;
351 }
352
353 while let Some(current) = next_subnode {
354 next_subnode = current.delete_and_next_subnode()?;
355 }
Pierre-Clément Tosi8ba89802024-02-14 12:26:01 +0000356
David Dai9bdb10c2024-02-01 22:42:54 -0800357 Ok(())
358}
359
360// TODO(ptosi): Rework FdtNodeMut and replace this function.
361fn get_nth_compatible<'a>(
362 fdt: &'a mut Fdt,
363 n: usize,
364 compat: &CStr,
365) -> libfdt::Result<Option<FdtNodeMut<'a>>> {
366 let mut node = fdt.root_mut()?.next_compatible(compat)?;
367 for _ in 0..n {
368 node = node.ok_or(FdtError::NoSpace)?.next_compatible(compat)?;
369 }
370 Ok(node)
371}
372
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000373fn patch_cpus(
374 fdt: &mut Fdt,
375 cpus: &[CpuInfo],
376 topology: &Option<CpuTopology>,
377) -> libfdt::Result<()> {
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000378 const COMPAT: &CStr = cstr!("arm,arm-v8");
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000379 let mut cpu_phandles = Vec::new();
David Dai9bdb10c2024-02-01 22:42:54 -0800380 for (idx, cpu) in cpus.iter().enumerate() {
David Dai50168a32024-02-14 17:00:48 -0800381 let mut cur = get_nth_compatible(fdt, idx, COMPAT)?.ok_or(FdtError::NoSpace)?;
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000382 let phandle = cur.as_node().get_phandle()?.unwrap();
383 cpu_phandles.push(phandle);
David Dai50168a32024-02-14 17:00:48 -0800384 if let Some(cpu_capacity) = cpu.cpu_capacity {
385 cur.setprop_inplace(cstr!("capacity-dmips-mhz"), &cpu_capacity.to_be_bytes())?;
386 }
Pierre-Clément Tosic37c72e2024-02-14 12:18:12 +0000387 patch_opptable(cur, cpu.opptable_info)?;
Jiyong Park9c63cd12023-03-21 17:53:07 +0900388 }
David Dai9bdb10c2024-02-01 22:42:54 -0800389 let mut next = get_nth_compatible(fdt, cpus.len(), COMPAT)?;
Jiyong Park9c63cd12023-03-21 17:53:07 +0900390 while let Some(current) = next {
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000391 next = current.delete_and_next_compatible(COMPAT)?;
Jiyong Park9c63cd12023-03-21 17:53:07 +0900392 }
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000393
394 if let Some(topology) = topology {
395 for (n, cluster) in topology.clusters.iter().enumerate() {
396 let path = CString::new(format!("/cpus/cpu-map/cluster{n}")).unwrap();
397 let cluster_node = fdt.node_mut(&path)?.unwrap();
398 if let Some(cluster) = cluster {
399 let mut iter = cluster_node.first_subnode()?;
400 for core in cluster.cores {
401 let mut core_node = iter.unwrap();
402 iter = if let Some(core_idx) = core {
403 let phandle = *cpu_phandles.get(core_idx).unwrap();
404 let value = u32::from(phandle).to_be_bytes();
405 core_node.setprop_inplace(cstr!("cpu"), &value)?;
406 core_node.next_subnode()?
407 } else {
408 core_node.delete_and_next_subnode()?
409 };
410 }
411 assert!(iter.is_none());
412 } else {
413 cluster_node.nop()?;
414 }
415 }
416 } else {
417 fdt.node_mut(cstr!("/cpus/cpu-map"))?.unwrap().nop()?;
418 }
419
Jiyong Park6a8789a2023-03-21 14:50:59 +0900420 Ok(())
Jiyong Park00ceff32023-03-13 05:43:23 +0000421}
422
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900423/// Read candidate properties' names from DT which could be overlaid
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900424fn parse_vm_ref_dt(fdt: &Fdt) -> libfdt::Result<BTreeMap<CString, Vec<u8>>> {
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900425 let mut property_map = BTreeMap::new();
Seungjae Yooed67fd52023-11-29 18:54:36 +0900426 if let Some(avf_node) = fdt.node(cstr!("/avf"))? {
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900427 for property in avf_node.properties()? {
428 let name = property.name()?;
429 let value = property.value()?;
430 property_map.insert(
431 CString::new(name.to_bytes()).map_err(|_| FdtError::BadValue)?,
432 value.to_vec(),
433 );
Seungjae Yooed67fd52023-11-29 18:54:36 +0900434 }
435 }
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900436 Ok(property_map)
Seungjae Yooed67fd52023-11-29 18:54:36 +0900437}
438
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900439/// Overlay VM reference DT into VM DT based on the props_info. Property is overlaid in vm_dt only
440/// when it exists both in vm_ref_dt and props_info. If the values mismatch, it returns error.
441fn validate_vm_ref_dt(
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900442 vm_dt: &mut Fdt,
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900443 vm_ref_dt: &Fdt,
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900444 props_info: &BTreeMap<CString, Vec<u8>>,
Seungjae Yoo192e99c2023-12-15 16:42:39 +0900445) -> libfdt::Result<()> {
Pierre-Clément Tosia3c4ec32024-02-15 20:05:15 +0000446 let root_vm_dt = vm_dt.root_mut()?;
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900447 let mut avf_vm_dt = root_vm_dt.add_subnode(cstr!("avf"))?;
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900448 // TODO(b/318431677): Validate nodes beyond /avf.
449 let avf_node = vm_ref_dt.node(cstr!("/avf"))?.ok_or(FdtError::NotFound)?;
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900450 for (name, value) in props_info.iter() {
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900451 if let Some(ref_value) = avf_node.getprop(name)? {
452 if value != ref_value {
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900453 error!(
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900454 "Property mismatches while applying overlay VM reference DT. \
455 Name:{:?}, Value from host as hex:{:x?}, Value from VM reference DT as hex:{:x?}",
456 name, value, ref_value
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900457 );
458 return Err(FdtError::BadValue);
459 }
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900460 avf_vm_dt.setprop(name, ref_value)?;
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900461 }
462 }
Seungjae Yooed67fd52023-11-29 18:54:36 +0900463 Ok(())
464}
465
Jiyong Park00ceff32023-03-13 05:43:23 +0000466#[derive(Debug)]
Jiyong Park00ceff32023-03-13 05:43:23 +0000467struct PciInfo {
Jiyong Park6a8789a2023-03-21 14:50:59 +0900468 ranges: [PciAddrRange; 2],
469 irq_masks: ArrayVec<[PciIrqMask; PciInfo::MAX_IRQS]>,
470 irq_maps: ArrayVec<[PciIrqMap; PciInfo::MAX_IRQS]>,
Jiyong Park00ceff32023-03-13 05:43:23 +0000471}
472
Jiyong Park6a8789a2023-03-21 14:50:59 +0900473impl PciInfo {
474 const IRQ_MASK_CELLS: usize = 4;
475 const IRQ_MAP_CELLS: usize = 10;
Nikita Ioffe85d80262023-07-12 17:34:07 +0100476 const MAX_IRQS: usize = 10;
Jiyong Park00ceff32023-03-13 05:43:23 +0000477}
478
Jiyong Park6a8789a2023-03-21 14:50:59 +0900479type PciAddrRange = AddressRange<(u32, u64), u64, u64>;
480type PciIrqMask = [u32; PciInfo::IRQ_MASK_CELLS];
481type PciIrqMap = [u32; PciInfo::IRQ_MAP_CELLS];
Jiyong Park00ceff32023-03-13 05:43:23 +0000482
483/// Iterator that takes N cells as a chunk
484struct CellChunkIterator<'a, const N: usize> {
485 cells: CellIterator<'a>,
486}
487
488impl<'a, const N: usize> CellChunkIterator<'a, N> {
489 fn new(cells: CellIterator<'a>) -> Self {
490 Self { cells }
491 }
492}
493
494impl<'a, const N: usize> Iterator for CellChunkIterator<'a, N> {
495 type Item = [u32; N];
496 fn next(&mut self) -> Option<Self::Item> {
497 let mut ret: Self::Item = [0; N];
498 for i in ret.iter_mut() {
499 *i = self.cells.next()?;
500 }
501 Some(ret)
502 }
503}
504
Jiyong Park6a8789a2023-03-21 14:50:59 +0900505/// Read pci host controller ranges, irq maps, and irq map masks from DT
506fn read_pci_info_from(fdt: &Fdt) -> libfdt::Result<PciInfo> {
507 let node =
508 fdt.compatible_nodes(cstr!("pci-host-cam-generic"))?.next().ok_or(FdtError::NotFound)?;
509
510 let mut ranges = node.ranges::<(u32, u64), u64, u64>()?.ok_or(FdtError::NotFound)?;
511 let range0 = ranges.next().ok_or(FdtError::NotFound)?;
512 let range1 = ranges.next().ok_or(FdtError::NotFound)?;
513
514 let irq_masks = node.getprop_cells(cstr!("interrupt-map-mask"))?.ok_or(FdtError::NotFound)?;
Pierre-Clément Tosiaa0f6552023-07-12 14:49:35 +0000515 let mut chunks = CellChunkIterator::<{ PciInfo::IRQ_MASK_CELLS }>::new(irq_masks);
516 let irq_masks = (&mut chunks).take(PciInfo::MAX_IRQS).collect();
517
518 if chunks.next().is_some() {
519 warn!("Input DT has more than {} PCI entries!", PciInfo::MAX_IRQS);
520 return Err(FdtError::NoSpace);
521 }
Jiyong Park6a8789a2023-03-21 14:50:59 +0900522
523 let irq_maps = node.getprop_cells(cstr!("interrupt-map"))?.ok_or(FdtError::NotFound)?;
Pierre-Clément Tosiaa0f6552023-07-12 14:49:35 +0000524 let mut chunks = CellChunkIterator::<{ PciInfo::IRQ_MAP_CELLS }>::new(irq_maps);
525 let irq_maps = (&mut chunks).take(PciInfo::MAX_IRQS).collect();
526
527 if chunks.next().is_some() {
528 warn!("Input DT has more than {} PCI entries!", PciInfo::MAX_IRQS);
529 return Err(FdtError::NoSpace);
530 }
Jiyong Park6a8789a2023-03-21 14:50:59 +0900531
532 Ok(PciInfo { ranges: [range0, range1], irq_masks, irq_maps })
533}
534
Jiyong Park0ee65392023-03-27 20:52:45 +0900535fn validate_pci_info(pci_info: &PciInfo, memory_range: &Range<usize>) -> Result<(), RebootReason> {
Jiyong Park6a8789a2023-03-21 14:50:59 +0900536 for range in pci_info.ranges.iter() {
Jiyong Park0ee65392023-03-27 20:52:45 +0900537 validate_pci_addr_range(range, memory_range)?;
Jiyong Park6a8789a2023-03-21 14:50:59 +0900538 }
539 for irq_mask in pci_info.irq_masks.iter() {
540 validate_pci_irq_mask(irq_mask)?;
541 }
542 for (idx, irq_map) in pci_info.irq_maps.iter().enumerate() {
543 validate_pci_irq_map(irq_map, idx)?;
544 }
545 Ok(())
546}
547
Jiyong Park0ee65392023-03-27 20:52:45 +0900548fn validate_pci_addr_range(
549 range: &PciAddrRange,
550 memory_range: &Range<usize>,
551) -> Result<(), RebootReason> {
Jiyong Park6a8789a2023-03-21 14:50:59 +0900552 let mem_flags = PciMemoryFlags(range.addr.0);
553 let range_type = mem_flags.range_type();
554 let prefetchable = mem_flags.prefetchable();
555 let bus_addr = range.addr.1;
556 let cpu_addr = range.parent_addr;
557 let size = range.size;
558
559 if range_type != PciRangeType::Memory64 {
560 error!("Invalid range type {:?} for bus address {:#x} in PCI node", range_type, bus_addr);
561 return Err(RebootReason::InvalidFdt);
562 }
563 if prefetchable {
564 error!("PCI bus address {:#x} in PCI node is prefetchable", bus_addr);
565 return Err(RebootReason::InvalidFdt);
566 }
567 // Enforce ID bus-to-cpu mappings, as used by crosvm.
568 if bus_addr != cpu_addr {
569 error!("PCI bus address: {:#x} is different from CPU address: {:#x}", bus_addr, cpu_addr);
570 return Err(RebootReason::InvalidFdt);
571 }
572
Jiyong Park0ee65392023-03-27 20:52:45 +0900573 let Some(bus_end) = bus_addr.checked_add(size) else {
574 error!("PCI address range size {:#x} overflows", size);
575 return Err(RebootReason::InvalidFdt);
576 };
Alice Wang63f4c9e2023-06-12 09:36:43 +0000577 if bus_end > MAX_VIRT_ADDR.try_into().unwrap() {
Jiyong Park0ee65392023-03-27 20:52:45 +0900578 error!("PCI address end {:#x} is outside of translatable range", bus_end);
579 return Err(RebootReason::InvalidFdt);
580 }
581
582 let memory_start = memory_range.start.try_into().unwrap();
583 let memory_end = memory_range.end.try_into().unwrap();
584
585 if max(bus_addr, memory_start) < min(bus_end, memory_end) {
586 error!(
587 "PCI address range {:#x}-{:#x} overlaps with main memory range {:#x}-{:#x}",
588 bus_addr, bus_end, memory_start, memory_end
589 );
Jiyong Park6a8789a2023-03-21 14:50:59 +0900590 return Err(RebootReason::InvalidFdt);
591 }
592
593 Ok(())
594}
595
596fn validate_pci_irq_mask(irq_mask: &PciIrqMask) -> Result<(), RebootReason> {
Jiyong Park00ceff32023-03-13 05:43:23 +0000597 const IRQ_MASK_ADDR_HI: u32 = 0xf800;
598 const IRQ_MASK_ADDR_ME: u32 = 0x0;
599 const IRQ_MASK_ADDR_LO: u32 = 0x0;
600 const IRQ_MASK_ANY_IRQ: u32 = 0x7;
Jiyong Park6a8789a2023-03-21 14:50:59 +0900601 const EXPECTED: PciIrqMask =
Jiyong Park00ceff32023-03-13 05:43:23 +0000602 [IRQ_MASK_ADDR_HI, IRQ_MASK_ADDR_ME, IRQ_MASK_ADDR_LO, IRQ_MASK_ANY_IRQ];
Jiyong Park6a8789a2023-03-21 14:50:59 +0900603 if *irq_mask != EXPECTED {
604 error!("Invalid PCI irq mask {:#?}", irq_mask);
605 return Err(RebootReason::InvalidFdt);
Jiyong Park00ceff32023-03-13 05:43:23 +0000606 }
Jiyong Park6a8789a2023-03-21 14:50:59 +0900607 Ok(())
Jiyong Park00ceff32023-03-13 05:43:23 +0000608}
609
Jiyong Park6a8789a2023-03-21 14:50:59 +0900610fn validate_pci_irq_map(irq_map: &PciIrqMap, idx: usize) -> Result<(), RebootReason> {
Jiyong Park00ceff32023-03-13 05:43:23 +0000611 const PCI_DEVICE_IDX: usize = 11;
612 const PCI_IRQ_ADDR_ME: u32 = 0;
613 const PCI_IRQ_ADDR_LO: u32 = 0;
614 const PCI_IRQ_INTC: u32 = 1;
615 const AARCH64_IRQ_BASE: u32 = 4; // from external/crosvm/aarch64/src/lib.rs
616 const GIC_SPI: u32 = 0;
617 const IRQ_TYPE_LEVEL_HIGH: u32 = 4;
618
Jiyong Park6a8789a2023-03-21 14:50:59 +0900619 let pci_addr = (irq_map[0], irq_map[1], irq_map[2]);
620 let pci_irq_number = irq_map[3];
621 let _controller_phandle = irq_map[4]; // skipped.
622 let gic_addr = (irq_map[5], irq_map[6]); // address-cells is <2> for GIC
623 // interrupt-cells is <3> for GIC
624 let gic_peripheral_interrupt_type = irq_map[7];
625 let gic_irq_number = irq_map[8];
626 let gic_irq_type = irq_map[9];
Jiyong Park00ceff32023-03-13 05:43:23 +0000627
Jiyong Park6a8789a2023-03-21 14:50:59 +0900628 let phys_hi: u32 = (0x1 << PCI_DEVICE_IDX) * (idx + 1) as u32;
629 let expected_pci_addr = (phys_hi, PCI_IRQ_ADDR_ME, PCI_IRQ_ADDR_LO);
Jiyong Park00ceff32023-03-13 05:43:23 +0000630
Jiyong Park6a8789a2023-03-21 14:50:59 +0900631 if pci_addr != expected_pci_addr {
632 error!("PCI device address {:#x} {:#x} {:#x} in interrupt-map is different from expected address \
633 {:#x} {:#x} {:#x}",
634 pci_addr.0, pci_addr.1, pci_addr.2, expected_pci_addr.0, expected_pci_addr.1, expected_pci_addr.2);
635 return Err(RebootReason::InvalidFdt);
636 }
Jiyong Park00ceff32023-03-13 05:43:23 +0000637
Jiyong Park6a8789a2023-03-21 14:50:59 +0900638 if pci_irq_number != PCI_IRQ_INTC {
639 error!(
640 "PCI INT# {:#x} in interrupt-map is different from expected value {:#x}",
641 pci_irq_number, PCI_IRQ_INTC
642 );
643 return Err(RebootReason::InvalidFdt);
644 }
Jiyong Park00ceff32023-03-13 05:43:23 +0000645
Jiyong Park6a8789a2023-03-21 14:50:59 +0900646 if gic_addr != (0, 0) {
647 error!(
648 "GIC address {:#x} {:#x} in interrupt-map is different from expected address \
649 {:#x} {:#x}",
650 gic_addr.0, gic_addr.1, 0, 0
651 );
652 return Err(RebootReason::InvalidFdt);
653 }
654
655 if gic_peripheral_interrupt_type != GIC_SPI {
656 error!("GIC peripheral interrupt type {:#x} in interrupt-map is different from expected value \
657 {:#x}", gic_peripheral_interrupt_type, GIC_SPI);
658 return Err(RebootReason::InvalidFdt);
659 }
660
661 let irq_nr: u32 = AARCH64_IRQ_BASE + (idx as u32);
662 if gic_irq_number != irq_nr {
663 error!(
664 "GIC irq number {:#x} in interrupt-map is unexpected. Expected {:#x}",
665 gic_irq_number, irq_nr
666 );
667 return Err(RebootReason::InvalidFdt);
668 }
669
670 if gic_irq_type != IRQ_TYPE_LEVEL_HIGH {
671 error!(
672 "IRQ type in {:#x} is invalid. Must be LEVEL_HIGH {:#x}",
673 gic_irq_type, IRQ_TYPE_LEVEL_HIGH
674 );
675 return Err(RebootReason::InvalidFdt);
Jiyong Park00ceff32023-03-13 05:43:23 +0000676 }
677 Ok(())
678}
679
Jiyong Park9c63cd12023-03-21 17:53:07 +0900680fn patch_pci_info(fdt: &mut Fdt, pci_info: &PciInfo) -> libfdt::Result<()> {
681 let mut node = fdt
682 .root_mut()?
683 .next_compatible(cstr!("pci-host-cam-generic"))?
684 .ok_or(FdtError::NotFound)?;
685
686 let irq_masks_size = pci_info.irq_masks.len() * size_of::<PciIrqMask>();
687 node.trimprop(cstr!("interrupt-map-mask"), irq_masks_size)?;
688
689 let irq_maps_size = pci_info.irq_maps.len() * size_of::<PciIrqMap>();
690 node.trimprop(cstr!("interrupt-map"), irq_maps_size)?;
691
692 node.setprop_inplace(
693 cstr!("ranges"),
694 flatten(&[pci_info.ranges[0].to_cells(), pci_info.ranges[1].to_cells()]),
695 )
696}
697
Jiyong Park00ceff32023-03-13 05:43:23 +0000698#[derive(Default, Debug)]
Jiyong Park6a8789a2023-03-21 14:50:59 +0900699struct SerialInfo {
700 addrs: ArrayVec<[u64; Self::MAX_SERIALS]>,
Jiyong Park00ceff32023-03-13 05:43:23 +0000701}
702
703impl SerialInfo {
Jiyong Park6a8789a2023-03-21 14:50:59 +0900704 const MAX_SERIALS: usize = 4;
Jiyong Park00ceff32023-03-13 05:43:23 +0000705}
706
Jiyong Park6a8789a2023-03-21 14:50:59 +0900707fn read_serial_info_from(fdt: &Fdt) -> libfdt::Result<SerialInfo> {
Pierre-Clément Tosibe893612024-02-05 14:23:44 +0000708 let mut addrs = ArrayVec::new();
709
710 let mut serial_nodes = fdt.compatible_nodes(cstr!("ns16550a"))?;
711 for node in serial_nodes.by_ref().take(addrs.capacity()) {
Alice Wang6ff2d0c2023-09-19 15:28:43 +0000712 let reg = node.first_reg()?;
Jiyong Park6a8789a2023-03-21 14:50:59 +0900713 addrs.push(reg.addr);
Jiyong Park00ceff32023-03-13 05:43:23 +0000714 }
Pierre-Clément Tosibe893612024-02-05 14:23:44 +0000715 if serial_nodes.next().is_some() {
716 warn!("DT has more than {} UART nodes: discarding extra nodes.", addrs.capacity());
717 }
718
Jiyong Park6a8789a2023-03-21 14:50:59 +0900719 Ok(SerialInfo { addrs })
Jiyong Park00ceff32023-03-13 05:43:23 +0000720}
721
Jiyong Park9c63cd12023-03-21 17:53:07 +0900722/// Patch the DT by deleting the ns16550a compatible nodes whose address are unknown
723fn patch_serial_info(fdt: &mut Fdt, serial_info: &SerialInfo) -> libfdt::Result<()> {
724 let name = cstr!("ns16550a");
725 let mut next = fdt.root_mut()?.next_compatible(name);
726 while let Some(current) = next? {
Pierre-Clément Tosic01fd0d2024-01-25 22:26:22 +0000727 let reg =
728 current.as_node().reg()?.ok_or(FdtError::NotFound)?.next().ok_or(FdtError::NotFound)?;
Jiyong Park9c63cd12023-03-21 17:53:07 +0900729 next = if !serial_info.addrs.contains(&reg.addr) {
730 current.delete_and_next_compatible(name)
731 } else {
732 current.next_compatible(name)
733 }
734 }
735 Ok(())
736}
737
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700738fn validate_swiotlb_info(
739 swiotlb_info: &SwiotlbInfo,
740 memory: &Range<usize>,
741) -> Result<(), RebootReason> {
Jiyong Park6a8789a2023-03-21 14:50:59 +0900742 let size = swiotlb_info.size;
743 let align = swiotlb_info.align;
Jiyong Park00ceff32023-03-13 05:43:23 +0000744
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700745 if size == 0 || (size % GUEST_PAGE_SIZE) != 0 {
Jiyong Park00ceff32023-03-13 05:43:23 +0000746 error!("Invalid swiotlb size {:#x}", size);
747 return Err(RebootReason::InvalidFdt);
748 }
749
Pierre-Clément Tosibe3a97b2023-05-19 14:56:23 +0000750 if let Some(align) = align.filter(|&a| a % GUEST_PAGE_SIZE != 0) {
Jiyong Park00ceff32023-03-13 05:43:23 +0000751 error!("Invalid swiotlb alignment {:#x}", align);
752 return Err(RebootReason::InvalidFdt);
753 }
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700754
Alice Wang9cfbfd62023-06-14 11:19:03 +0000755 if let Some(addr) = swiotlb_info.addr {
756 if addr.checked_add(size).is_none() {
757 error!("Invalid swiotlb range: addr:{addr:#x} size:{size:#x}");
758 return Err(RebootReason::InvalidFdt);
759 }
760 }
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700761 if let Some(range) = swiotlb_info.fixed_range() {
762 if !range.is_within(memory) {
763 error!("swiotlb range {range:#x?} not part of memory range {memory:#x?}");
764 return Err(RebootReason::InvalidFdt);
765 }
766 }
767
Jiyong Park6a8789a2023-03-21 14:50:59 +0900768 Ok(())
Jiyong Park00ceff32023-03-13 05:43:23 +0000769}
770
Jiyong Park9c63cd12023-03-21 17:53:07 +0900771fn patch_swiotlb_info(fdt: &mut Fdt, swiotlb_info: &SwiotlbInfo) -> libfdt::Result<()> {
772 let mut node =
773 fdt.root_mut()?.next_compatible(cstr!("restricted-dma-pool"))?.ok_or(FdtError::NotFound)?;
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700774
775 if let Some(range) = swiotlb_info.fixed_range() {
Pierre-Clément Tosic27c4272023-05-19 15:46:26 +0000776 node.setprop_addrrange_inplace(
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700777 cstr!("reg"),
778 range.start.try_into().unwrap(),
779 range.len().try_into().unwrap(),
780 )?;
Pierre-Clément Tosibe3a97b2023-05-19 14:56:23 +0000781 node.nop_property(cstr!("size"))?;
782 node.nop_property(cstr!("alignment"))?;
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700783 } else {
Pierre-Clément Tosic27c4272023-05-19 15:46:26 +0000784 node.nop_property(cstr!("reg"))?;
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700785 node.setprop_inplace(cstr!("size"), &swiotlb_info.size.to_be_bytes())?;
Pierre-Clément Tosibe3a97b2023-05-19 14:56:23 +0000786 node.setprop_inplace(cstr!("alignment"), &swiotlb_info.align.unwrap().to_be_bytes())?;
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -0700787 }
788
Jiyong Park9c63cd12023-03-21 17:53:07 +0900789 Ok(())
790}
791
792fn patch_gic(fdt: &mut Fdt, num_cpus: usize) -> libfdt::Result<()> {
793 let node = fdt.compatible_nodes(cstr!("arm,gic-v3"))?.next().ok_or(FdtError::NotFound)?;
794 let mut ranges = node.reg()?.ok_or(FdtError::NotFound)?;
795 let range0 = ranges.next().ok_or(FdtError::NotFound)?;
796 let mut range1 = ranges.next().ok_or(FdtError::NotFound)?;
797
798 let addr = range0.addr;
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000799 // `read_cpu_info_from()` guarantees that we have at most MAX_CPUS.
800 const_assert!(DeviceTreeInfo::gic_patched_size(DeviceTreeInfo::MAX_CPUS).is_some());
Alice Wangabc7d632023-06-14 09:10:14 +0000801 let size = u64::try_from(DeviceTreeInfo::gic_patched_size(num_cpus).unwrap()).unwrap();
Jiyong Park9c63cd12023-03-21 17:53:07 +0900802
803 // range1 is just below range0
804 range1.addr = addr - size;
805 range1.size = Some(size);
806
Pierre-Clément Tosieea2a982024-02-05 15:10:59 +0000807 let (addr0, size0) = range0.to_cells();
808 let (addr1, size1) = range1.to_cells();
809 let value = [addr0, size0.unwrap(), addr1, size1.unwrap()];
Jiyong Park9c63cd12023-03-21 17:53:07 +0900810
811 let mut node =
812 fdt.root_mut()?.next_compatible(cstr!("arm,gic-v3"))?.ok_or(FdtError::NotFound)?;
813 node.setprop_inplace(cstr!("reg"), flatten(&value))
814}
815
816fn patch_timer(fdt: &mut Fdt, num_cpus: usize) -> libfdt::Result<()> {
817 const NUM_INTERRUPTS: usize = 4;
818 const CELLS_PER_INTERRUPT: usize = 3;
819 let node = fdt.compatible_nodes(cstr!("arm,armv8-timer"))?.next().ok_or(FdtError::NotFound)?;
820 let interrupts = node.getprop_cells(cstr!("interrupts"))?.ok_or(FdtError::NotFound)?;
821 let mut value: ArrayVec<[u32; NUM_INTERRUPTS * CELLS_PER_INTERRUPT]> =
822 interrupts.take(NUM_INTERRUPTS * CELLS_PER_INTERRUPT).collect();
823
824 let num_cpus: u32 = num_cpus.try_into().unwrap();
825 let cpu_mask: u32 = (((0x1 << num_cpus) - 1) & 0xff) << 8;
826 for v in value.iter_mut().skip(2).step_by(CELLS_PER_INTERRUPT) {
827 *v |= cpu_mask;
828 }
829 for v in value.iter_mut() {
830 *v = v.to_be();
831 }
832
Pierre-Clément Tosi0edc4d62024-02-05 14:13:53 +0000833 let value = value.into_inner();
Jiyong Park9c63cd12023-03-21 17:53:07 +0900834
835 let mut node =
836 fdt.root_mut()?.next_compatible(cstr!("arm,armv8-timer"))?.ok_or(FdtError::NotFound)?;
Pierre-Clément Tosi0edc4d62024-02-05 14:13:53 +0000837 node.setprop_inplace(cstr!("interrupts"), value.as_bytes())
Jiyong Park9c63cd12023-03-21 17:53:07 +0900838}
839
Jiyong Park00ceff32023-03-13 05:43:23 +0000840#[derive(Debug)]
David Dai9bdb10c2024-02-01 22:42:54 -0800841struct VcpufreqInfo {
842 addr: u64,
843 size: u64,
844}
845
846fn patch_vcpufreq(fdt: &mut Fdt, vcpufreq_info: &Option<VcpufreqInfo>) -> libfdt::Result<()> {
847 let mut node = fdt.node_mut(cstr!("/cpufreq"))?.unwrap();
848 if let Some(info) = vcpufreq_info {
849 node.setprop_addrrange_inplace(cstr!("reg"), info.addr, info.size)
850 } else {
851 node.nop()
852 }
853}
854
855#[derive(Debug)]
Jiyong Park6a8789a2023-03-21 14:50:59 +0900856pub struct DeviceTreeInfo {
857 pub kernel_range: Option<Range<usize>>,
858 pub initrd_range: Option<Range<usize>>,
859 pub memory_range: Range<usize>,
Jiyong Parke9d87e82023-03-21 19:28:40 +0900860 bootargs: Option<CString>,
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000861 cpus: ArrayVec<[CpuInfo; DeviceTreeInfo::MAX_CPUS]>,
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000862 cpu_topology: Option<CpuTopology>,
Jiyong Park00ceff32023-03-13 05:43:23 +0000863 pci_info: PciInfo,
864 serial_info: SerialInfo,
Srivatsa Vaddagiri37713ec2023-04-20 04:04:08 -0700865 pub swiotlb_info: SwiotlbInfo,
Jaewan Kimc6e023b2023-10-12 15:11:05 +0900866 device_assignment: Option<DeviceAssignmentInfo>,
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900867 vm_ref_dt_props_info: BTreeMap<CString, Vec<u8>>,
David Dai9bdb10c2024-02-01 22:42:54 -0800868 vcpufreq_info: Option<VcpufreqInfo>,
Jiyong Park00ceff32023-03-13 05:43:23 +0000869}
870
871impl DeviceTreeInfo {
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000872 const MAX_CPUS: usize = 16;
873
874 const fn gic_patched_size(num_cpus: usize) -> Option<usize> {
Alice Wangabc7d632023-06-14 09:10:14 +0000875 const GIC_REDIST_SIZE_PER_CPU: usize = 32 * SIZE_4KB;
876
877 GIC_REDIST_SIZE_PER_CPU.checked_mul(num_cpus)
878 }
Jiyong Park00ceff32023-03-13 05:43:23 +0000879}
880
Jaewan Kimc6e023b2023-10-12 15:11:05 +0900881pub fn sanitize_device_tree(
882 fdt: &mut [u8],
883 vm_dtbo: Option<&mut [u8]>,
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900884 vm_ref_dt: Option<&[u8]>,
Jaewan Kimc6e023b2023-10-12 15:11:05 +0900885) -> Result<DeviceTreeInfo, RebootReason> {
886 let fdt = Fdt::from_mut_slice(fdt).map_err(|e| {
887 error!("Failed to load FDT: {e}");
888 RebootReason::InvalidFdt
889 })?;
890
891 let vm_dtbo = match vm_dtbo {
892 Some(vm_dtbo) => Some(VmDtbo::from_mut_slice(vm_dtbo).map_err(|e| {
893 error!("Failed to load VM DTBO: {e}");
894 RebootReason::InvalidFdt
895 })?),
896 None => None,
897 };
898
899 let info = parse_device_tree(fdt, vm_dtbo.as_deref())?;
Jiyong Park83316122023-03-21 09:39:39 +0900900
Pierre-Clément Tosice0b36d2024-01-26 10:50:05 +0000901 // SAFETY: We trust that the template (hardcoded in our RO data) is a valid DT.
902 let fdt_template = unsafe { Fdt::unchecked_from_slice(pvmfw_fdt_template::RAW) };
903 fdt.clone_from(fdt_template).map_err(|e| {
Jiyong Parke9d87e82023-03-21 19:28:40 +0900904 error!("Failed to instantiate FDT from the template DT: {e}");
905 RebootReason::InvalidFdt
906 })?;
907
Jaewan Kim9220e852023-12-01 10:58:40 +0900908 fdt.unpack().map_err(|e| {
909 error!("Failed to unpack DT for patching: {e}");
910 RebootReason::InvalidFdt
911 })?;
912
Jaewan Kimc6e023b2023-10-12 15:11:05 +0900913 if let Some(device_assignment_info) = &info.device_assignment {
914 let vm_dtbo = vm_dtbo.unwrap();
915 device_assignment_info.filter(vm_dtbo).map_err(|e| {
916 error!("Failed to filter VM DTBO: {e}");
917 RebootReason::InvalidFdt
918 })?;
919 // SAFETY: Damaged VM DTBO isn't used in this API after this unsafe block.
920 // VM DTBO can't be reused in any way as Fdt nor VmDtbo outside of this API because
921 // it can only be instantiated after validation.
922 unsafe {
923 fdt.apply_overlay(vm_dtbo.as_mut()).map_err(|e| {
924 error!("Failed to apply filtered VM DTBO: {e}");
925 RebootReason::InvalidFdt
926 })?;
927 }
928 }
929
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900930 if let Some(vm_ref_dt) = vm_ref_dt {
931 let vm_ref_dt = Fdt::from_slice(vm_ref_dt).map_err(|e| {
932 error!("Failed to load VM reference DT: {e}");
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900933 RebootReason::InvalidFdt
934 })?;
935
Seungjae Yoof0af81d2024-01-17 13:48:36 +0900936 validate_vm_ref_dt(fdt, vm_ref_dt, &info.vm_ref_dt_props_info).map_err(|e| {
937 error!("Failed to apply VM reference DT: {e}");
Seungjae Yoo013f4c42024-01-02 13:04:19 +0900938 RebootReason::InvalidFdt
939 })?;
940 }
941
Jiyong Park9c63cd12023-03-21 17:53:07 +0900942 patch_device_tree(fdt, &info)?;
Jaewan Kimc6e023b2023-10-12 15:11:05 +0900943
Jaewan Kim19b984f2023-12-04 15:16:50 +0900944 // TODO(b/317201360): Ensure no overlapping in <reg> among devices
945
Jaewan Kim9220e852023-12-01 10:58:40 +0900946 fdt.pack().map_err(|e| {
947 error!("Failed to unpack DT after patching: {e}");
948 RebootReason::InvalidFdt
949 })?;
950
Jiyong Park6a8789a2023-03-21 14:50:59 +0900951 Ok(info)
Jiyong Park83316122023-03-21 09:39:39 +0900952}
953
Jaewan Kimc6e023b2023-10-12 15:11:05 +0900954fn parse_device_tree(fdt: &Fdt, vm_dtbo: Option<&VmDtbo>) -> Result<DeviceTreeInfo, RebootReason> {
Jiyong Park6a8789a2023-03-21 14:50:59 +0900955 let kernel_range = read_kernel_range_from(fdt).map_err(|e| {
956 error!("Failed to read kernel range from DT: {e}");
957 RebootReason::InvalidFdt
958 })?;
959
960 let initrd_range = read_initrd_range_from(fdt).map_err(|e| {
961 error!("Failed to read initrd range from DT: {e}");
962 RebootReason::InvalidFdt
963 })?;
964
Alice Wang0d527472023-06-13 14:55:38 +0000965 let memory_range = read_and_validate_memory_range(fdt)?;
Jiyong Park6a8789a2023-03-21 14:50:59 +0900966
Jiyong Parke9d87e82023-03-21 19:28:40 +0900967 let bootargs = read_bootargs_from(fdt).map_err(|e| {
968 error!("Failed to read bootargs from DT: {e}");
969 RebootReason::InvalidFdt
970 })?;
971
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +0000972 let (cpus, cpu_topology) = read_cpu_info_from(fdt).map_err(|e| {
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000973 error!("Failed to read CPU info from DT: {e}");
Jiyong Park6a8789a2023-03-21 14:50:59 +0900974 RebootReason::InvalidFdt
975 })?;
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +0000976 validate_cpu_info(&cpus).map_err(|e| {
977 error!("Failed to validate CPU info from DT: {e}");
Alice Wangabc7d632023-06-14 09:10:14 +0000978 RebootReason::InvalidFdt
979 })?;
Jiyong Park6a8789a2023-03-21 14:50:59 +0900980
David Dai9bdb10c2024-02-01 22:42:54 -0800981 let vcpufreq_info = read_vcpufreq_info(fdt).map_err(|e| {
982 error!("Failed to read vcpufreq info from DT: {e}");
983 RebootReason::InvalidFdt
984 })?;
985 if let Some(ref info) = vcpufreq_info {
986 validate_vcpufreq_info(info, &cpus).map_err(|e| {
987 error!("Failed to validate vcpufreq info from DT: {e}");
988 RebootReason::InvalidFdt
989 })?;
990 }
991
Jiyong Park6a8789a2023-03-21 14:50:59 +0900992 let pci_info = read_pci_info_from(fdt).map_err(|e| {
993 error!("Failed to read pci info from DT: {e}");
994 RebootReason::InvalidFdt
995 })?;
Jiyong Park0ee65392023-03-27 20:52:45 +0900996 validate_pci_info(&pci_info, &memory_range)?;
Jiyong Park6a8789a2023-03-21 14:50:59 +0900997
998 let serial_info = read_serial_info_from(fdt).map_err(|e| {
999 error!("Failed to read serial info from DT: {e}");
1000 RebootReason::InvalidFdt
1001 })?;
1002
Alice Wang9cfbfd62023-06-14 11:19:03 +00001003 let swiotlb_info = SwiotlbInfo::new_from_fdt(fdt).map_err(|e| {
Jiyong Park6a8789a2023-03-21 14:50:59 +09001004 error!("Failed to read swiotlb info from DT: {e}");
1005 RebootReason::InvalidFdt
1006 })?;
Srivatsa Vaddagiri2df297f2023-04-12 03:11:05 -07001007 validate_swiotlb_info(&swiotlb_info, &memory_range)?;
Jiyong Park6a8789a2023-03-21 14:50:59 +09001008
Jaewan Kimc6e023b2023-10-12 15:11:05 +09001009 let device_assignment = match vm_dtbo {
Jaewan Kim52477ae2023-11-21 21:20:52 +09001010 Some(vm_dtbo) => {
1011 if let Some(hypervisor) = hyp::get_device_assigner() {
1012 DeviceAssignmentInfo::parse(fdt, vm_dtbo, hypervisor).map_err(|e| {
1013 error!("Failed to parse device assignment from DT and VM DTBO: {e}");
1014 RebootReason::InvalidFdt
1015 })?
1016 } else {
1017 warn!(
1018 "Device assignment is ignored because device assigning hypervisor is missing"
1019 );
1020 None
1021 }
1022 }
Jaewan Kimc6e023b2023-10-12 15:11:05 +09001023 None => None,
1024 };
1025
Seungjae Yoof0af81d2024-01-17 13:48:36 +09001026 let vm_ref_dt_props_info = parse_vm_ref_dt(fdt).map_err(|e| {
Seungjae Yoo013f4c42024-01-02 13:04:19 +09001027 error!("Failed to read names of properties under /avf from DT: {e}");
1028 RebootReason::InvalidFdt
1029 })?;
Seungjae Yooed67fd52023-11-29 18:54:36 +09001030
Jiyong Park00ceff32023-03-13 05:43:23 +00001031 Ok(DeviceTreeInfo {
Jiyong Park6a8789a2023-03-21 14:50:59 +09001032 kernel_range,
1033 initrd_range,
1034 memory_range,
Jiyong Parke9d87e82023-03-21 19:28:40 +09001035 bootargs,
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +00001036 cpus,
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +00001037 cpu_topology,
Jiyong Park6a8789a2023-03-21 14:50:59 +09001038 pci_info,
1039 serial_info,
1040 swiotlb_info,
Jaewan Kimc6e023b2023-10-12 15:11:05 +09001041 device_assignment,
Seungjae Yoof0af81d2024-01-17 13:48:36 +09001042 vm_ref_dt_props_info,
David Dai9bdb10c2024-02-01 22:42:54 -08001043 vcpufreq_info,
Jiyong Park00ceff32023-03-13 05:43:23 +00001044 })
1045}
1046
Jiyong Park9c63cd12023-03-21 17:53:07 +09001047fn patch_device_tree(fdt: &mut Fdt, info: &DeviceTreeInfo) -> Result<(), RebootReason> {
1048 if let Some(initrd_range) = &info.initrd_range {
1049 patch_initrd_range(fdt, initrd_range).map_err(|e| {
1050 error!("Failed to patch initrd range to DT: {e}");
1051 RebootReason::InvalidFdt
1052 })?;
1053 }
1054 patch_memory_range(fdt, &info.memory_range).map_err(|e| {
1055 error!("Failed to patch memory range to DT: {e}");
1056 RebootReason::InvalidFdt
1057 })?;
Jiyong Parke9d87e82023-03-21 19:28:40 +09001058 if let Some(bootargs) = &info.bootargs {
1059 patch_bootargs(fdt, bootargs.as_c_str()).map_err(|e| {
1060 error!("Failed to patch bootargs to DT: {e}");
1061 RebootReason::InvalidFdt
1062 })?;
1063 }
Pierre-Clément Tosia0823f12024-02-15 16:41:05 +00001064 patch_cpus(fdt, &info.cpus, &info.cpu_topology).map_err(|e| {
Jiyong Park9c63cd12023-03-21 17:53:07 +09001065 error!("Failed to patch cpus to DT: {e}");
1066 RebootReason::InvalidFdt
1067 })?;
David Dai9bdb10c2024-02-01 22:42:54 -08001068 patch_vcpufreq(fdt, &info.vcpufreq_info).map_err(|e| {
1069 error!("Failed to patch vcpufreq info to DT: {e}");
1070 RebootReason::InvalidFdt
1071 })?;
Jiyong Park9c63cd12023-03-21 17:53:07 +09001072 patch_pci_info(fdt, &info.pci_info).map_err(|e| {
1073 error!("Failed to patch pci info to DT: {e}");
1074 RebootReason::InvalidFdt
1075 })?;
1076 patch_serial_info(fdt, &info.serial_info).map_err(|e| {
1077 error!("Failed to patch serial info to DT: {e}");
1078 RebootReason::InvalidFdt
1079 })?;
1080 patch_swiotlb_info(fdt, &info.swiotlb_info).map_err(|e| {
1081 error!("Failed to patch swiotlb info to DT: {e}");
1082 RebootReason::InvalidFdt
1083 })?;
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +00001084 patch_gic(fdt, info.cpus.len()).map_err(|e| {
Jiyong Park9c63cd12023-03-21 17:53:07 +09001085 error!("Failed to patch gic info to DT: {e}");
1086 RebootReason::InvalidFdt
1087 })?;
Pierre-Clément Tosi689e4732024-02-05 14:39:51 +00001088 patch_timer(fdt, info.cpus.len()).map_err(|e| {
Jiyong Park9c63cd12023-03-21 17:53:07 +09001089 error!("Failed to patch timer info to DT: {e}");
1090 RebootReason::InvalidFdt
1091 })?;
Jaewan Kimc6e023b2023-10-12 15:11:05 +09001092 if let Some(device_assignment) = &info.device_assignment {
1093 // Note: We patch values after VM DTBO is overlaid because patch may require more space
1094 // then VM DTBO's underlying slice is allocated.
1095 device_assignment.patch(fdt).map_err(|e| {
1096 error!("Failed to patch device assignment info to DT: {e}");
1097 RebootReason::InvalidFdt
1098 })?;
1099 }
Jiyong Parke9d87e82023-03-21 19:28:40 +09001100
Jiyong Park9c63cd12023-03-21 17:53:07 +09001101 Ok(())
1102}
1103
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001104/// Modifies the input DT according to the fields of the configuration.
1105pub fn modify_for_next_stage(
1106 fdt: &mut Fdt,
1107 bcc: &[u8],
1108 new_instance: bool,
1109 strict_boot: bool,
Alan Stokes65618332023-12-15 14:09:25 +00001110 debug_policy: Option<&[u8]>,
Jiyong Parkc5d2ef22023-04-11 01:23:46 +09001111 debuggable: bool,
Pierre-Clément Tosi80251972023-07-12 12:51:12 +00001112 kaslr_seed: u64,
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001113) -> libfdt::Result<()> {
Pierre-Clément Tosieb887ac2023-05-02 13:33:37 +00001114 if let Some(debug_policy) = debug_policy {
1115 let backup = Vec::from(fdt.as_slice());
1116 fdt.unpack()?;
1117 let backup_fdt = Fdt::from_slice(backup.as_slice()).unwrap();
1118 if apply_debug_policy(fdt, backup_fdt, debug_policy)? {
1119 info!("Debug policy applied.");
1120 } else {
1121 // apply_debug_policy restored fdt to backup_fdt so unpack it again.
1122 fdt.unpack()?;
1123 }
1124 } else {
1125 info!("No debug policy found.");
1126 fdt.unpack()?;
1127 }
Pierre-Clément Tosidb74cb12022-12-08 13:56:25 +00001128
Jiyong Parke9d87e82023-03-21 19:28:40 +09001129 patch_dice_node(fdt, bcc.as_ptr() as usize, bcc.len())?;
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001130
Alice Wang56ec45b2023-06-15 08:30:32 +00001131 if let Some(mut chosen) = fdt.chosen_mut()? {
1132 empty_or_delete_prop(&mut chosen, cstr!("avf,strict-boot"), strict_boot)?;
1133 empty_or_delete_prop(&mut chosen, cstr!("avf,new-instance"), new_instance)?;
Pierre-Clément Tosi80251972023-07-12 12:51:12 +00001134 chosen.setprop_inplace(cstr!("kaslr-seed"), &kaslr_seed.to_be_bytes())?;
Alice Wang56ec45b2023-06-15 08:30:32 +00001135 };
Jiyong Park32f37ef2023-05-17 16:15:58 +09001136 if !debuggable {
Jiyong Parkc5d2ef22023-04-11 01:23:46 +09001137 if let Some(bootargs) = read_bootargs_from(fdt)? {
1138 filter_out_dangerous_bootargs(fdt, &bootargs)?;
1139 }
1140 }
1141
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001142 fdt.pack()?;
1143
1144 Ok(())
1145}
1146
Jiyong Parke9d87e82023-03-21 19:28:40 +09001147/// Patch the "google,open-dice"-compatible reserved-memory node to point to the bcc range
1148fn patch_dice_node(fdt: &mut Fdt, addr: usize, size: usize) -> libfdt::Result<()> {
Pierre-Clément Tosidb74cb12022-12-08 13:56:25 +00001149 // We reject DTs with missing reserved-memory node as validation should have checked that the
1150 // "swiotlb" subnode (compatible = "restricted-dma-pool") was present.
Jiyong Parke9d87e82023-03-21 19:28:40 +09001151 let node = fdt.node_mut(cstr!("/reserved-memory"))?.ok_or(libfdt::FdtError::NotFound)?;
Pierre-Clément Tosidb74cb12022-12-08 13:56:25 +00001152
Jiyong Parke9d87e82023-03-21 19:28:40 +09001153 let mut node = node.next_compatible(cstr!("google,open-dice"))?.ok_or(FdtError::NotFound)?;
Pierre-Clément Tosidb74cb12022-12-08 13:56:25 +00001154
Jiyong Parke9d87e82023-03-21 19:28:40 +09001155 let addr: u64 = addr.try_into().unwrap();
1156 let size: u64 = size.try_into().unwrap();
1157 node.setprop_inplace(cstr!("reg"), flatten(&[addr.to_be_bytes(), size.to_be_bytes()]))
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001158}
1159
Alice Wang56ec45b2023-06-15 08:30:32 +00001160fn empty_or_delete_prop(
1161 fdt_node: &mut FdtNodeMut,
1162 prop_name: &CStr,
1163 keep_prop: bool,
1164) -> libfdt::Result<()> {
1165 if keep_prop {
1166 fdt_node.setprop_empty(prop_name)
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001167 } else {
Alice Wang56ec45b2023-06-15 08:30:32 +00001168 fdt_node
1169 .delprop(prop_name)
1170 .or_else(|e| if e == FdtError::NotFound { Ok(()) } else { Err(e) })
Pierre-Clément Tosi4ba79662023-02-13 11:22:41 +00001171 }
Pierre-Clément Tosidb74cb12022-12-08 13:56:25 +00001172}
Jiyong Parkc23426b2023-04-10 17:32:27 +09001173
Pierre-Clément Tosia50167b2023-05-02 13:19:29 +00001174/// Apply the debug policy overlay to the guest DT.
1175///
1176/// Returns Ok(true) on success, Ok(false) on recovered failure and Err(_) on corruption of the DT.
Pierre-Clément Tosieb887ac2023-05-02 13:33:37 +00001177fn apply_debug_policy(
1178 fdt: &mut Fdt,
1179 backup_fdt: &Fdt,
1180 debug_policy: &[u8],
1181) -> libfdt::Result<bool> {
Pierre-Clément Tosia50167b2023-05-02 13:19:29 +00001182 let mut debug_policy = Vec::from(debug_policy);
1183 let overlay = match Fdt::from_mut_slice(debug_policy.as_mut_slice()) {
Jiyong Parkc23426b2023-04-10 17:32:27 +09001184 Ok(overlay) => overlay,
1185 Err(e) => {
Pierre-Clément Tosia50167b2023-05-02 13:19:29 +00001186 warn!("Corrupted debug policy found: {e}. Not applying.");
1187 return Ok(false);
Jiyong Parkc23426b2023-04-10 17:32:27 +09001188 }
1189 };
Jiyong Parkc23426b2023-04-10 17:32:27 +09001190
Andrew Walbran20bb4e42023-07-07 13:55:55 +01001191 // SAFETY: on failure, the corrupted DT is restored using the backup.
Jiyong Parkc23426b2023-04-10 17:32:27 +09001192 if let Err(e) = unsafe { fdt.apply_overlay(overlay) } {
Pierre-Clément Tosia50167b2023-05-02 13:19:29 +00001193 warn!("Failed to apply debug policy: {e}. Recovering...");
Pierre-Clément Tosice0b36d2024-01-26 10:50:05 +00001194 fdt.clone_from(backup_fdt)?;
Jiyong Parkc23426b2023-04-10 17:32:27 +09001195 // A successful restoration is considered success because an invalid debug policy
1196 // shouldn't DOS the pvmfw
Pierre-Clément Tosia50167b2023-05-02 13:19:29 +00001197 Ok(false)
1198 } else {
1199 Ok(true)
Jiyong Parkc23426b2023-04-10 17:32:27 +09001200 }
Jiyong Parkc23426b2023-04-10 17:32:27 +09001201}
Jiyong Parkc5d2ef22023-04-11 01:23:46 +09001202
Pierre-Clément Tosi1fbc2e92023-05-02 17:28:17 +00001203fn has_common_debug_policy(fdt: &Fdt, debug_feature_name: &CStr) -> libfdt::Result<bool> {
Jiyong Parkc5d2ef22023-04-11 01:23:46 +09001204 if let Some(node) = fdt.node(cstr!("/avf/guest/common"))? {
1205 if let Some(value) = node.getprop_u32(debug_feature_name)? {
1206 return Ok(value == 1);
1207 }
1208 }
1209 Ok(false) // if the policy doesn't exist or not 1, don't enable the debug feature
1210}
1211
1212fn filter_out_dangerous_bootargs(fdt: &mut Fdt, bootargs: &CStr) -> libfdt::Result<()> {
Pierre-Clément Tosi1fbc2e92023-05-02 17:28:17 +00001213 let has_crashkernel = has_common_debug_policy(fdt, cstr!("ramdump"))?;
1214 let has_console = has_common_debug_policy(fdt, cstr!("log"))?;
Jiyong Parkc5d2ef22023-04-11 01:23:46 +09001215
1216 let accepted: &[(&str, Box<dyn Fn(Option<&str>) -> bool>)] = &[
1217 ("panic", Box::new(|v| if let Some(v) = v { v == "=-1" } else { false })),
1218 ("crashkernel", Box::new(|_| has_crashkernel)),
1219 ("console", Box::new(|_| has_console)),
1220 ];
1221
1222 // parse and filter out unwanted
1223 let mut filtered = Vec::new();
1224 for arg in BootArgsIterator::new(bootargs).map_err(|e| {
1225 info!("Invalid bootarg: {e}");
1226 FdtError::BadValue
1227 })? {
1228 match accepted.iter().find(|&t| t.0 == arg.name()) {
1229 Some((_, pred)) if pred(arg.value()) => filtered.push(arg),
1230 _ => debug!("Rejected bootarg {}", arg.as_ref()),
1231 }
1232 }
1233
1234 // flatten into a new C-string
1235 let mut new_bootargs = Vec::new();
1236 for (i, arg) in filtered.iter().enumerate() {
1237 if i != 0 {
1238 new_bootargs.push(b' '); // separator
1239 }
1240 new_bootargs.extend_from_slice(arg.as_ref().as_bytes());
1241 }
1242 new_bootargs.push(b'\0');
1243
1244 let mut node = fdt.chosen_mut()?.ok_or(FdtError::NotFound)?;
1245 node.setprop(cstr!("bootargs"), new_bootargs.as_slice())
1246}