src/storage/fuchsia-fatfs/src/util.rs

// Copyright 2020 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 {
    chrono::{offset::TimeZone, Local},
    fatfs::{DateTime, FatfsError},
    fuchsia_zircon::Status,
    std::io::{self, ErrorKind},
};

/// Returns the equivalent of the given DOS time as ns past the unix epoch.
pub fn dos_to_unix_time(dos_time: DateTime) -> u64 {
    let datetime = chrono::DateTime::<Local>::from(dos_time);
    datetime.timestamp_nanos() as u64
}

/// Returns the given unix timestamp in ns as a FAT-compatible DateTime.
pub fn unix_to_dos_time(timestamp: u64) -> DateTime {
    DateTime::from(Local.timestamp_nanos(timestamp as i64))
}

pub fn fatfs_error_to_status(error: io::Error) -> Status {
    match error.kind() {
        ErrorKind::AddrInUse => Status::ADDRESS_IN_USE,
        ErrorKind::AddrNotAvailable => Status::UNAVAILABLE,
        ErrorKind::AlreadyExists => Status::ALREADY_EXISTS,
        ErrorKind::BrokenPipe => Status::PEER_CLOSED,
        ErrorKind::ConnectionAborted => Status::CONNECTION_ABORTED,
        ErrorKind::ConnectionRefused => Status::CONNECTION_REFUSED,
        ErrorKind::ConnectionReset => Status::CONNECTION_RESET,
        ErrorKind::Interrupted => Status::INTERRUPTED_RETRY,
        ErrorKind::InvalidData => Status::IO_INVALID,
        ErrorKind::InvalidInput => Status::INVALID_ARGS,
        ErrorKind::NotConnected => Status::NOT_CONNECTED,
        ErrorKind::NotFound => Status::NOT_FOUND,
        ErrorKind::PermissionDenied => Status::ACCESS_DENIED,
        ErrorKind::TimedOut => Status::TIMED_OUT,
        ErrorKind::UnexpectedEof => Status::BUFFER_TOO_SMALL,
        ErrorKind::WouldBlock => Status::BAD_STATE,
        ErrorKind::WriteZero => Status::NO_SPACE,
        ErrorKind::Other => {
            error
                .into_inner()
                .and_then(|b| b.downcast::<FatfsError>().ok())
                .map(|b| {
                    match *b {
                        // errors caused in boot_sector.rs
                        FatfsError::UnknownVersion => Status::NOT_SUPPORTED,
                        FatfsError::InvalidBootSectorSig => Status::NOT_SUPPORTED,
                        FatfsError::VolumeTooSmall => Status::NO_SPACE,
                        // errors caused in dir.rs:
                        FatfsError::IsDirectory => Status::NOT_FILE,
                        FatfsError::NotDirectory => Status::NOT_DIR,
                        FatfsError::DirectoryNotEmpty => Status::NOT_EMPTY,
                        FatfsError::FileNameTooLong => Status::BAD_PATH,
                        FatfsError::FileNameEmpty => Status::BAD_PATH,
                        FatfsError::FileNameBadCharacter => Status::BAD_PATH,
                        // errors caused in fs.rs
                        FatfsError::TooManySectors => Status::OUT_OF_RANGE,
                        // errors caused in table.rs
                        FatfsError::NoSpace => Status::NO_SPACE,
                        // Other errors (which come from boot_sector.rs and fs.rs) indicate
                        // that the filesystem is corrupted or invalid in some way.
                        // We don't enumerate them here, because there's a lot of them.
                        _ => Status::INVALID_ARGS,
                    }
                })
                .unwrap_or(Status::IO)
        }
        _ => Status::IO,
    }
}

#[cfg(test)]
mod tests {
    use {
        super::*,
        fatfs::{Date, Time},
    };

    fn dos_datetime(
        year: u16,
        month: u16,
        day: u16,
        hour: u16,
        min: u16,
        sec: u16,
        millis: u16,
    ) -> DateTime {
        DateTime { date: Date { year, month, day }, time: Time { hour, min, sec, millis } }
    }

    const NS_PER_MS: u64 = 1_000_000;

    fn ms_to_ns(ts: u64) -> u64 {
        ts * NS_PER_MS
    }

    #[fuchsia::test]
    fn test_dos_to_unix_time() {
        let earliest_time = dos_datetime(1980, 1, 1, 0, 0, 0, 0);
        assert_eq!(dos_to_unix_time(earliest_time), ms_to_ns(315532800000));

        let latest_time = dos_datetime(2107, 12, 31, 23, 59, 59, 999);
        assert_eq!(dos_to_unix_time(latest_time), ms_to_ns(4354819199999));

        let time = dos_datetime(2038, 1, 19, 3, 14, 7, 0);
        assert_eq!(dos_to_unix_time(time), ms_to_ns(2147483647000));
    }

    #[fuchsia::test]
    fn test_unix_to_dos_time() {
        let earliest_time = dos_datetime(1980, 1, 1, 0, 0, 0, 0);
        assert_eq!(earliest_time, unix_to_dos_time(ms_to_ns(315532800000)));

        let latest_time = dos_datetime(2107, 12, 31, 23, 59, 59, 999);
        assert_eq!(latest_time, unix_to_dos_time(ms_to_ns(4354819199999)));

        let time = dos_datetime(2038, 1, 19, 3, 14, 7, 0);
        assert_eq!(time, unix_to_dos_time(ms_to_ns(2147483647000)));
    }
}