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

// Copyright 2021 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

use {fuchsia_zircon::Status, std::ffi::CString, thiserror::Error};

/// The error type used by the `format` and `fsck` filesystem commands.
#[derive(Clone, Debug, Error)]
pub enum CommandError {
    /// A FIDL error occurred.
    #[error(transparent)]
    Fidl(#[from] fidl::Error),
    /// There was a problem launching the filesystem process.
    #[error("failed to launch filesystem process: {0}")]
    LaunchProcess(#[from] LaunchProcessError),
    /// An error occurred waiting for the `ZX_PROCESS_TERMINATED` signal on the filesystem process.
    #[error("failed to wait on ZX_PROCESS_TERMINATED signal: {0}")]
    ProcessTerminatedSignal(#[source] Status),
    /// Failed to get the return code of the terminated filesystem process.
    #[error("failed to get return code of process: {0}")]
    GetProcessReturnCode(#[source] Status),
    /// The filesystem process exited with a non-zero return code.
    #[error("process exited with non-zero return code: {0}")]
    ProcessNonZeroReturnCode(i64),
}

/// The error type representing a failure to launch the filesystem process.
#[derive(Clone, Debug, Error)]
#[error(
    "failed to spawn process. launched with {:?}, status: {}, message: {}",
    .args,
    .status,
    .message
)]
pub struct LaunchProcessError {
    pub(super) args: Vec<CString>,
    pub(super) status: Status,
    pub(super) message: String,
}

/// The error type used by the shutdown operation of a serving filesystem.
#[derive(Debug, Error)]
pub enum ShutdownError {
    /// An error occurred connecting to the Admin service.
    #[error(transparent)]
    ConnectToAdminService(#[from] anyhow::Error),
    /// A FIDL error occurred.
    #[error(transparent)]
    Fidl(#[from] fidl::Error),
    /// An error occurred waiting for the `ZX_PROCESS_TERMINATED` signal on the filesystem process.
    #[error("failed to wait on ZX_PROCESS_TERMINATED signal: {0}")]
    ProcessTerminatedSignal(#[source] Status),
    /// Failed to get the return code of the terminated filesystem process.
    #[error("failed to get return code of process: {0}")]
    GetProcessReturnCode(#[source] Status),
}

/// The error type used by the query operation of a serving filesystem.
#[derive(Clone, Debug, Error)]
pub enum QueryError {
    /// A FIDL error occurred.
    #[error(transparent)]
    Fidl(#[from] fidl::Error),
    /// A request for filesystem info using the Directory protocol failed.
    #[error("failed to query filesystem with Directory: {0}")]
    DirectoryQuery(#[source] Status),
    /// The filesystem info returned by the Directory protocol was empty.
    #[error("empty filesystem info result")]
    DirectoryEmptyResult,
}

/// The error type used by the kill operation of a serving filesystem.
#[derive(Clone, Copy, Debug, Error)]
pub enum KillError {
    /// A call to `zx_task_kill` failed. The process could not be terminated.
    #[error("zx_task_kill returned: {0}")]
    TaskKill(#[source] Status),
    /// An error occurred waiting for the `ZX_PROCESS_TERMINATED` signal on the filesystem process.
    #[error("failed to wait on ZX_PROCESS_TERMINATED signal: {0}")]
    ProcessTerminatedSignal(#[source] Status),
}