installer/
lib.rs

Help
1// Copyright 2022 The Fuchsia Authors. All rights reserved.
2// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
5//! # Installer library
6//!
7//! The installer library exposes functionality to install Fuchsia to a disk by copying images from
8//! one block device to another. The primary use case is an installer USB, which contains the images
9//! to write to persistent storage.
10
11pub mod partition;
12
13use anyhow::{anyhow, Context, Error};
14use fidl::endpoints::{Proxy, ServerEnd};
15use fidl_fuchsia_hardware_power_statecontrol::{AdminMarker, RebootOptions, RebootReason2};
16use fidl_fuchsia_paver::{
17    BootManagerMarker, Configuration, DynamicDataSinkProxy, PaverMarker, PaverProxy,
18};
19use fidl_fuchsia_sysinfo::SysInfoMarker;
20use fuchsia_component::client;
21
22use partition::Partition;
23use recovery_util_block::BlockDevice;
24use std::sync::Mutex;
25
26#[derive(Clone, Copy, Debug, PartialEq)]
27pub enum BootloaderType {
28    Efi,
29    Coreboot,
30}
31
32#[derive(Clone, Debug, PartialEq)]
33pub struct InstallationPaths {
34    pub install_source: Option<BlockDevice>,
35    pub install_target: Option<BlockDevice>,
36    pub bootloader_type: Option<BootloaderType>,
37    pub install_destinations: Vec<BlockDevice>,
38    pub available_disks: Vec<BlockDevice>,
39}
40
41impl InstallationPaths {
42    pub fn new() -> InstallationPaths {
43        InstallationPaths {
44            install_source: None,
45            install_target: None,
46            bootloader_type: None,
47            install_destinations: Vec::new(),
48            available_disks: Vec::new(),
49        }
50    }
51}
52
53pub async fn find_install_source(
54    block_devices: &Vec<BlockDevice>,
55    bootloader: BootloaderType,
56) -> Result<&BlockDevice, Error> {
57    let mut candidate = Err(anyhow!("Could not find the installer disk. Is it plugged in?"));
58    for device in block_devices.iter().filter(|d| d.is_disk()) {
59        // get_partitions returns an empty vector if it doesn't find any partitions
60        // with the workstation-installer GUID on the disk.
61        let partitions = Partition::get_partitions(device, block_devices, bootloader).await?;
62        if !partitions.is_empty() {
63            if candidate.is_err() {
64                candidate = Ok(device);
65            } else {
66                return Err(anyhow!(
67                    "Please check you only have one installation disk plugged in!"
68                ));
69            }
70        }
71    }
72    candidate
73}
74
75fn paver_connect() -> Result<(PaverProxy, DynamicDataSinkProxy), Error> {
76    let (data_sink_chan, data_remote) = zx::Channel::create();
77    let paver: PaverProxy =
78        client::connect_to_protocol::<PaverMarker>().context("Could not connect to paver")?;
79    paver.find_partition_table_manager(ServerEnd::from(data_remote))?;
80
81    let data_sink =
82        DynamicDataSinkProxy::from_channel(fidl::AsyncChannel::from_channel(data_sink_chan));
83    Ok((paver, data_sink))
84}
85
86pub async fn get_bootloader_type() -> Result<BootloaderType, Error> {
87    let proxy = fuchsia_component::client::connect_to_protocol::<SysInfoMarker>()
88        .context("Could not connect to 'fuchsia.sysinfo.SysInfo' service")?;
89    let (status, bootloader) =
90        proxy.get_bootloader_vendor().await.context("Getting bootloader vendor")?;
91    if let Some(bootloader) = bootloader {
92        log::info!("Bootloader vendor = {}", bootloader);
93        if bootloader == "coreboot" {
94            Ok(BootloaderType::Coreboot)
95        } else {
96            // The installer only supports coreboot and EFI,
97            // and EFI BIOS vendor depends on the manufacturer,
98            // so we assume that non-coreboot bootloader vendors
99            // mean EFI.
100            Ok(BootloaderType::Efi)
101        }
102    } else {
103        Err(Error::new(zx::Status::from_raw(status)))
104    }
105}
106
107/// Restart the machine.
108pub async fn restart() {
109    let proxy = fuchsia_component::client::connect_to_protocol::<AdminMarker>()
110        .expect("Could not connect to 'fuchsia.hardware.power.statecontrol.Admin' service");
111
112    proxy
113        .perform_reboot(&RebootOptions {
114            reasons: Some(vec![RebootReason2::UserRequest]),
115            ..Default::default()
116        })
117        .await
118        .expect("Failed to reboot")
119        .expect("Failed to reboot");
120}
121
122/// Set the active boot configuration for the newly-installed system. We always boot from the "A"
123/// slot to start with.
124async fn set_active_configuration(paver: &PaverProxy) -> Result<(), Error> {
125    let (boot_manager, server) = fidl::endpoints::create_proxy::<BootManagerMarker>();
126
127    paver.find_boot_manager(server).context("Could not find boot manager")?;
128
129    zx::Status::ok(
130        boot_manager
131            .set_configuration_active(Configuration::A)
132            .await
133            .context("Sending set configuration active")?,
134    )
135    .context("Setting active configuration")?;
136
137    zx::Status::ok(boot_manager.flush().await.context("Sending boot manager flush")?)
138        .context("Flushing active configuration")
139}
140
141pub async fn do_install<F>(
142    installation_paths: InstallationPaths,
143    progress_callback: &F,
144) -> Result<(), Error>
145where
146    F: Send + Sync + Fn(String),
147{
148    if installation_paths.install_target.is_some() {
149        log::warn!("Ignoring install target; this will be removed in the future.");
150    }
151    let install_source =
152        installation_paths.install_source.ok_or_else(|| anyhow!("No installation source?"))?;
153    let bootloader_type = installation_paths.bootloader_type.unwrap();
154
155    let (paver, data_sink) = paver_connect().context("Could not contact paver")?;
156
157    log::info!("Initializing Fuchsia partition tables...");
158    progress_callback(String::from("Initializing Fuchsia partition tables..."));
159    data_sink.initialize_partition_tables().await?;
160
161    log::info!("Getting source partitions");
162    progress_callback(String::from("Getting source partitions"));
163    let to_install = Partition::get_partitions(
164        &install_source,
165        &installation_paths.available_disks,
166        bootloader_type,
167    )
168    .await
169    .context("Getting source partitions")?;
170
171    let num_partitions = to_install.len();
172    let mut current_partition = 1;
173    for part in to_install {
174        progress_callback(String::from(format!(
175            "paving partition {} of {}",
176            current_partition, num_partitions
177        )));
178
179        let prev_percent = Mutex::new(0 as i64);
180
181        let pave_progress_callback = |data_read, data_total| {
182            if data_total == 0 {
183                return;
184            }
185            let cur_percent: i64 =
186                unsafe { (((data_read as f64) / (data_total as f64)) * 100.0).to_int_unchecked() };
187            let mut prev = prev_percent.lock().unwrap();
188            if cur_percent == *prev {
189                return;
190            }
191            *prev = cur_percent;
192
193            progress_callback(String::from(format!(
194                "paving partition {} of {}: {}%",
195                current_partition, num_partitions, cur_percent
196            )));
197        };
198
199        log::info!("Paving partition: {:?}", part);
200        part.pave(&data_sink, &pave_progress_callback).await?;
201        if part.is_ab() {
202            log::info!("Paving partition: {:?} [-B]", part);
203            part.pave_b(&data_sink).await?
204        }
205
206        current_partition += 1;
207    }
208
209    progress_callback(String::from("Flushing Partitions"));
210    zx::Status::ok(data_sink.flush().await.context("Sending flush")?)
211        .context("Flushing partitions")?;
212
213    progress_callback(String::from("Setting active configuration for the new system"));
214    set_active_configuration(&paver)
215        .await
216        .context("Setting active configuration for the new system")?;
217
218    Ok(())
219}
installer/lib.rs

installer/
lib.rs
